aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBryan Ward <bcw@cs.unc.edu>2013-04-17 16:32:31 -0400
committerBryan Ward <bcw@cs.unc.edu>2013-04-17 16:32:31 -0400
commitb1860fce856c1d579008bc30cbf3513a860c3e69 (patch)
tree988ac594ad230aa65591c57ba358390a1f6269e5
parent625e0f2d3fd50f079c7eb84825992b70421bd78e (diff)
which -> that
-rw-r--r--README.md26
1 files changed, 13 insertions, 13 deletions
diff --git a/README.md b/README.md
index 6200277..b074aa5 100644
--- a/README.md
+++ b/README.md
@@ -45,7 +45,7 @@ gen_exps.py --> [exps/*] --> run_exps.py --> [run-data/*] --.
453. Parse binary data in `run-data/` using `parse_exps.py`, generating csv files in `parse-data/`. 453. Parse binary data in `run-data/` using `parse_exps.py`, generating csv files in `parse-data/`.
464. Plot `parse-data` using `plot_exps.py`, generating pdfs in `plot-data/`. 464. Plot `parse-data` using `plot_exps.py`, generating pdfs in `plot-data/`.
47 47
48Each of these scripts will be described. The `run_exps.py` script is first because `gen_exps.py` creates schedule files which depend on `run_exps.py`. 48Each of these scripts will be described. The `run_exps.py` script is first because `gen_exps.py` creates schedule files that depend on `run_exps.py`.
49 49
50 50
51## run_exps.py 51## run_exps.py
@@ -74,7 +74,7 @@ OUT_DIR/[SCHED_(FILE|DIR)/]
74 74
75*Defaults*: `SCHED_FILE = sched.py`, `PARAM_FILE = params.py`, `DURATION = 30`, `OUT_DIR = run-data/` 75*Defaults*: `SCHED_FILE = sched.py`, `PARAM_FILE = params.py`, `DURATION = 30`, `OUT_DIR = run-data/`
76 76
77This script reads *schedule files* (described below) and executes real-time task systems, recording all overhead, logging, and trace data which is enabled in the system (unless a specific set of tracers is specified in the parameter file, see below). For example, if trace logging is enabled, rt-kernelshark is found in the path, but feather-trace is disabled (the devices are not present), only trace logs and rt-kernelshark logs will be recorded. 77This script reads *schedule files* (described below) and executes real-time task systems, recording all overhead, logging, and trace data that is enabled in the system (unless a specific set of tracers is specified in the parameter file, see below). For example, if trace logging is enabled, rt-kernelshark is found in the path, but feather-trace is disabled (the devices are not present), only trace logs and rt-kernelshark logs will be recorded.
78 78
79When `run_exps.py` is running a schedule file, temporary data is saved in a `tmp` directory in the same directory as the schedule file. When execution completes, this data is moved into a directory under the `run_exps.py` output directory (default: `run-data/`, can be changed with the `-o` option). When multiple schedules are run, each schedule's data is saved in a unique directory under the output directory. 79When `run_exps.py` is running a schedule file, temporary data is saved in a `tmp` directory in the same directory as the schedule file. When execution completes, this data is moved into a directory under the `run_exps.py` output directory (default: `run-data/`, can be changed with the `-o` option). When multiple schedules are run, each schedule's data is saved in a unique directory under the output directory.
80 80
@@ -192,7 +192,7 @@ $ cat post-out.txt
192Experiment ends! 192Experiment ends!
193``` 193```
194 194
195Finally, you can specify system properties in `params.py` which the environment must match for the experiment to run. These are useful if you have a large batch of experiments which must be run under different kernels or kernel configurations. The first property is a regular expression for the name of the kernel: 195Finally, you can specify system properties in `params.py`, which the environment must match for the experiment to run. These are useful if you have a large batch of experiments that must be run under different kernels or kernel configurations. The first property is a regular expression for the name of the kernel:
196 196
197```bash 197```bash
198$ uname -r 198$ uname -r
@@ -219,7 +219,7 @@ The second property is kernel configuration options. These assume the configurat
219} 219}
220``` 220```
221 221
222The third property is required tracers. The `tracers` property lets the user specify only those tracers they want to run with an experiment, as opposed to starting every available tracer (the default). If any of these specified tracers cannot be enabled, e.g. the kernel was not compiled with feather-trace support, the experiment will not run. The following example gives an experiment which will not run unless all four tracers are enabled: 222The third property is required tracers. The `tracers` property lets the user specify only those tracers they want to run with an experiment, as opposed to starting every available tracer (the default). If any of these specified tracers cannot be enabled, e.g. the kernel was not compiled with feather-trace support, the experiment will not run. The following example gives an experiment that will not run unless all four tracers are enabled:
223```python 223```python
224{'tracers':['kernelshark', 'log', 'sched', 'overhead']} 224{'tracers':['kernelshark', 'log', 'sched', 'overhead']}
225``` 225```
@@ -227,15 +227,15 @@ The third property is required tracers. The `tracers` property lets the user spe
227## gen_exps.py 227## gen_exps.py
228*Usage*: `gen_exps.py [options] [files...] [generators...] [param=val[,val]...]` 228*Usage*: `gen_exps.py [options] [files...] [generators...] [param=val[,val]...]`
229 229
230*Output*: `OUT_DIR/EXP_DIRS` which each contain `sched.py` and `params.py` 230*Output*: `OUT_DIR/EXP_DIRS` that each contain `sched.py` and `params.py`
231 231
232*Defaults*: `generators = G-EDF P-EDF C-EDF`, `OUT_DIR = exps/` 232*Defaults*: `generators = G-EDF P-EDF C-EDF`, `OUT_DIR = exps/`
233 233
234This script uses *generators*, one for each LITMUS scheduler supported, which each have different properties which can be varied to generate different types of schedules. Each of these properties has a default value which can be modified on the command line for quick and easy experiment generation. 234This script uses *generators*, one for each LITMUS scheduler supported, which each have different properties that can be varied to generate different types of schedules. Each of these properties has a default value that can be modified on the command line for quick and easy experiment generation.
235 235
236This script as written should be used to create debugging task sets, but not for creating task sets for experiments shown in papers. That is because the safety features of `run_exps.py` described above (`uname`, `config-options`) are not used here. If you are creating experiments for a paper, you should create your own generator which outputs values for the `config-options` required for your plugin so that you cannot ruin your experiments at run time. Trust me, you will. 236This script as written should be used to create debugging task sets, but not for creating task sets for experiments shown in papers. That is because the safety features of `run_exps.py` described above (`uname`, `config-options`) are not used here. If you are creating experiments for a paper, you should create your own generator that outputs values for the `config-options` required for your plugin so that you cannot ruin your experiments at run time. Trust me, you will.
237 237
238The `-l` option lists the supported generators which can be specified: 238The `-l` option lists the supported generators that can be specified:
239 239
240```bash 240```bash
241$ gen_exps.py -l 241$ gen_exps.py -l
@@ -287,7 +287,7 @@ sched=PSN-EDF_num-tasks=24/ sched=PSN-EDF_num-tasks=26/
287sched=PSN-EDF_num-tasks=28/ sched=PSN-EDF_num-tasks=30/ 287sched=PSN-EDF_num-tasks=28/ sched=PSN-EDF_num-tasks=30/
288``` 288```
289 289
290The generator will create a different directory for each possible configuration of the parameters. Each parameter which is varied is included in the name of the schedule directory. For example, to vary the number of CPUs but not the number of tasks: 290The generator will create a different directory for each possible configuration of the parameters. Each parameter that is varied is included in the name of the schedule directory. For example, to vary the number of CPUs but not the number of tasks:
291 291
292```bash 292```bash
293$ gen_exps.py -f tasks=24 cpus=3,6 P-EDF 293$ gen_exps.py -f tasks=24 cpus=3,6 P-EDF
@@ -319,9 +319,9 @@ where the `data_dirx` contain feather-trace and sched-trace data, e.g. `ft.bin`,
319 319
320*Output*: print out all parsed data or `OUT_FILE` where `OUT_FILE` is a python map of the data or `OUT_DIR/[FIELD]*/[PARAM]/[TYPE]/[TYPE]/[LINE].csv`, depending on input. 320*Output*: print out all parsed data or `OUT_FILE` where `OUT_FILE` is a python map of the data or `OUT_DIR/[FIELD]*/[PARAM]/[TYPE]/[TYPE]/[LINE].csv`, depending on input.
321 321
322The goal is to create csv files which record how varying `PARAM` changes the value of `FIELD`. Only `PARAM`s which vary are considered. 322The goal is to create csv files that record how varying `PARAM` changes the value of `FIELD`. Only `PARAM`s that vary are considered.
323 323
324`FIELD` is a parsed value, e.g. 'RELEASE' overhead or 'miss-ratio'. `PARAM` is a parameter which we are going to vary, e.g. 'tasks'. A single `LINE` is created for every configuration of parameters other than `PARAM`. 324`FIELD` is a parsed value, e.g. 'RELEASE' overhead or 'miss-ratio'. `PARAM` is a parameter that we are going to vary, e.g. 'tasks'. A single `LINE` is created for every configuration of parameters other than `PARAM`.
325 325
326`TYPE` is the statistic of the measurement, i.e. Max, Min, Avg, or Var[iance]. The two types are used to differentiate between measurements across tasks in a single taskset, and measurements across all tasksets. E.g. `miss-ratio/*/Max/Avg` is the maximum of all the average miss ratios for each task set, while `miss-ratio/*/Avg/Max` is the average of the maximum miss ratios for each task set. 326`TYPE` is the statistic of the measurement, i.e. Max, Min, Avg, or Var[iance]. The two types are used to differentiate between measurements across tasks in a single taskset, and measurements across all tasksets. E.g. `miss-ratio/*/Max/Avg` is the maximum of all the average miss ratios for each task set, while `miss-ratio/*/Avg/Max` is the average of the maximum miss ratios for each task set.
327 327
@@ -389,7 +389,7 @@ line.csv
389 389
390The second command will also have run faster than the first. This is because `parse_exps.py` will save the data it parses in `tmp/` directories before it attempts to sort it into csvs. Parsing takes far longer than sorting, so this saves a lot of time. The `-f` flag can be used to re-parse files and overwrite this saved data. 390The second command will also have run faster than the first. This is because `parse_exps.py` will save the data it parses in `tmp/` directories before it attempts to sort it into csvs. Parsing takes far longer than sorting, so this saves a lot of time. The `-f` flag can be used to re-parse files and overwrite this saved data.
391 391
392All output from the *feather-trace-tools* programs used to parse data is stored in the `tmp/` directories created in the input directories. If the *sched_trace* repo is found in the users `PATH`, `st_show` will be used to create a human-readable version of the sched-trace data which will also be stored there. 392All output from the *feather-trace-tools* programs used to parse data is stored in the `tmp/` directories created in the input directories. If the *sched_trace* repo is found in the users `PATH`, `st_show` will be used to create a human-readable version of the sched-trace data that will also be stored there.
393 393
394## plot_exps.py 394## plot_exps.py
395*Usage*: `plot_exps.py [OPTIONS] [CSV_DIR]...` 395*Usage*: `plot_exps.py [OPTIONS] [CSV_DIR]...`
@@ -472,4 +472,4 @@ However, when a single directory of directories is given, the script assumes the
472[rt-kernelshark]: https://github.com/LITMUS-RT/rt-kernelshark 472[rt-kernelshark]: https://github.com/LITMUS-RT/rt-kernelshark
473[feather-trace-tools]: https://github.com/LITMUS-RT/feather-trace-tools 473[feather-trace-tools]: https://github.com/LITMUS-RT/feather-trace-tools
474[rtunc]: http://www.cs.unc.edu/~anderson/real-time/ 474[rtunc]: http://www.cs.unc.edu/~anderson/real-time/
475[matplotlib]: http://matplotlib.org/ \ No newline at end of file 475[matplotlib]: http://matplotlib.org/