Muldersoft/TimedExec
Muldersoft/TimedExec
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity

Updated README file.

Browse Source
This commit is contained in:
LoRd_MuldeR 2014-11-07 19:41:44 +01:00
parent aa3be5e316
commit 6c900e2133
2 changed files with 81 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

77
README.md
View File

@ -1,27 +1,88 @@
TimedExec TimedExec
========= =========
**TimedExec** is a small utility for *benchmarking* command-line programs. It will execute the specified command and measure the time it takes for that command to complete. In order to obtain more accurate results, all measurements are done via *high-resolution* performance timers. Also, in order to filter out environmental noise, each test will be repeated *multiple* times. The number of test runs can be configured as needed. TimedExec will then compute the *average* execution time, as well as the *fastest* and *slowest* execution time. Furthermore, the *standard deviation* of all runs will be computed. Last but not least, an optional number of "warm-up" runs will be executed *before* the first test run. **TimedExec** is a small utility for *benchmarking* command-line programs. It will *execute* the specified program with the specified command-line arguments and then *measure* the time that it takes for the program execution to complete. In order to obtain *accurate* results, all measurements are implemented via *high-resolution* performance timers. And, since program execution times unavoidably are subject to variations (due to environmental noise), each test will be repeated *multiple* times. The number of metering passes can be configured as desired. TimedExec will then compute the *mean* execution time of all passes. It will also record the *fastest* and *slowest* execution time. Furthermore, TimedExec computes the *standard error* as well as the *confidence interval* from the benchmarking results. This is the *range* which contains the program's actual (mean) execution time, *with very high probability*. Last but not least, an optional number of "warm-up" passes can be performed *prior to* the first metering pass. The warm-up passes prevent caching effects from interfering with the execution times. Note that all benchmarking results will be saved to a log file.
Command-line Usage Usage Instructions
------------------ ------------------
### Command-line Syntax ###
TimedExec uses a very simple command-line syntax. Just type "TimedExec", followed by the program that you want to benchmark, followed by the desired arguments.
*Note:* Some parameters that influence the behaviour of TimedExec can be set via environment variables.
``` ```
=========================================================================== ===============================================================================
Timed Exec - Benchmarking Utility Timed Exec - Benchmarking Utility, Version 1.03 [Nov 7 2014]
Copyright (c) 2014 LoRd_MuldeR <mulder2@gmx.de>. Some rights reserved. Copyright (c) 2014 LoRd_MuldeR <mulder2@gmx.de>. Some rights reserved.
This program is free software: you can redistribute it and/or modify This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License <http://www.gnu.org/>. it under the terms of the GNU General Public License <http://www.gnu.org/>.
Note that this program is distributed with ABSOLUTELY NO WARRANTY. Note that this program is distributed with ABSOLUTELY NO WARRANTY.
=========================================================================== ===============================================================================
Usage: Usage:
TimedExec.exe <Program.exe> [Arguments] TimedExec.exe <Program.exe> [Arguments]
Influential environment variables: Influential environment variables:
TIMED_EXEC_LOGFILE - Log File (default: "TimedExec.log") TIMED_EXEC_PASSES - Number of execution passes (default: 10)
TIMED_EXEC_LOOPS - Number of execution loops (default: 5) TIMED_EXEC_WARMUP_PASSES - Number of warm-up passes (default: 3)
TIMED_WARMUP_LOOPS - Number of warm-up loops (default: 1) TIMED_EXEC_LOGFILE - Log-File Name (default: "TimedExec.log")
TIMED_EXEC_NO_CHECKS - Set this to *disable* exit code checks
``` ```
### Usage Example ###
In the following example we use *TimedExec* to benchmark the program **ping.exe** with the arguments **-n 12 www.google.com**:
```
TimedExec.exe C:\Windows\System32\ping.exe -n 12 www.google.com
```
The resulting output, after all ten passes have been completed, may look like this:
```
===============================================================================
TEST COMPLETED SUCCESSFULLY AFTER 10 METERING PASSES
-------------------------------------------------------------------------------
Mean Execution Time : 13.838 seconds
90% Confidence Interval : +/- 1.001 ( 7.235%) = [12.836, 14.839] seconds
95% Confidence Interval : +/- 1.193 ( 8.621%) = [12.645, 15.031] seconds
99% Confidence Interval : +/- 1.568 (11.330%) = [12.270, 15.405] seconds
Standard Deviation : 1.826 seconds
Standard Error : 0.609 seconds
Fastest / Slowest Pass : 11.118 / 15.075 seconds
===============================================================================
```
License
-------
TimedExec is released under the terms of the [GNU General Public License](http://www.gnu.org/licenses/gpl-2.0.html), version 2.
```
Timed Exec - Command-Line Benchmarking Utility
Copyright (c) 2014 LoRd_MuldeR <mulder2@gmx.de>. Some rights reserved.
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
http://www.gnu.org/licenses/gpl-2.0.txt
```
<br>
**e.o.f.**

12
img/Style.inc Normal file
View File

@ -0,0 +1,12 @@
<style type="text/css">
<!--
body { font-family: "Times New Roman", Times, serif; color: #000000; background-color: #FFFFFF; }
tt, pre, code { font-family: Courier New, Courier, mono; background-color: #EDF3F7; padding: 1px; }
h2 { margin-top: 2.0em; }
h3, h4 { margin-top: 1.75em; }
a { color: #0000BB; text-decoration: none; }
a:visited { color: #0000BB; text-decoration: none; }
a:active { color: #0000FF; text-decoration: none; }
a:hover { color: #0000FF; text-decoration: underline; }
-->
</style>