1EXERCISE-SUT(1) Generated Python Manual EXERCISE-SUT(1)
2
6 exercise-sut
7
9 exercise-sut [-h] [-q] [-d] [--version] [--force-color] {start,report}
10 ...
11
13 exercise-sut - Run a test tool or benchmark to collect testdata.
14
17 -h Show this help message and exit.
18 -q Be quiet.
21 -d Print debugging information.
24 --version
27 Print version and exit.
28 --force-color
31 Force coloring of the text output.
32
35 exercise-sut start
36 Start collecting testdata.
37 exercise-sut report
39 Generate reports.
40
43 usage: exercise-sut start [-h] [-q] [-d] [-H HOSTNAME] [-U USERNAME]
44 [-K PRIVKEY] [-T TIMEOUT] [--datapoints DATAPOINTS] [--reportid-prefix
45 REPORTID_PREFIX] [--reportid-suffix REPORTID_SUFFIX] [--cpunums
46 CPUNUMS] [--cstates CSTATES]
47 [--pcstates PCSTATES] [--only-one-cstate]
48 [--cstates-always-enable CSTATES_ALWAYS_ENABLE] [--turbo TURBO]
49 [--freqs FREQS] [--uncore-freqs UNCORE_FREQS] [--governor GOVERNOR]
50 [--aspm ASPM]
51 [--c1-demotion C1_DEMOTION] [--c1-undemotion
52 C1_UNDEMOTION] [--c1e-autopromote C1E_AUTOPROMOTE] [--cstate-prewake
53 CSTATE_PREWAKE] [--epp EPP] [--epp-hw EPP_HW] [--epb EPB] [--epb-hw
54 EPB_HW] [--state-reset]
55 [--deploy] [--devids DEVIDS] [--command COM‐
56 MAND] [--stop-on-failure] [--only-measured-cpu] [--toolpath TOOLPATH]
57 [--toolopts TOOLOPTS] [--outdir OUTDIR] [--dry-run] [--list-monikers]
58 Run a test tool or benchmark to collect testdata. Unknown options are
60 passed as-is to the tool.
61
64 -h Show this help message and exit.
65 -q Be quiet.
68 -d Print debugging information.
71 -H HOSTNAME, --host HOSTNAME
74 Name of the host to run the command on.
75 -U USERNAME, --username USERNAME
78 Name of the user to use for logging into the remote host over
79 SSH. The default user name is 'root'.
80 -K PRIVKEY, --priv-key PRIVKEY
83 Path to the private SSH key that should be used for logging into
84 the remote host. By default the key is automatically found from
85 standard paths like '~/.ssh'.
86 -T TIMEOUT, --timeout TIMEOUT
89 SSH connect timeout in seconds, default is 8.
90 --datapoints DATAPOINTS, -c DATAPOINTS
93 Applicable only to 'wult' and 'ndl' tools. Number of datapoints
94 to collect per measurement. Default is 100000.
95 --reportid-prefix REPORTID_PREFIX
98 String to prepend to the report ID (nothing, by default).
99 --reportid-suffix REPORTID_SUFFIX
102 String to append to the report ID (nothing, by default).
103 --cpunums CPUNUMS
106 Applicable only to the 'wult' and 'ndl' tools. Comma-separated
107 list of CPU numbers to measure with. No CPU number is passed by
108 default.
109 --cstates CSTATES
112 Comma-separated list of requestable C-states to measure with.
113 Default is all C-states.
114 --pcstates PCSTATES
117 Comma-separated list of package C-states to measure with. De‐
118 fault is "don't care".
119 --only-one-cstate
122 By default C-states deeper than measured C-state are disabled
123 and other C-states are enabled. This option will disable all
124 C-states, excluding the measured C-state.
125 --cstates-always-enable CSTATES_ALWAYS_ENABLE
128 Comma-separated list of always enabled C-states. Default is
129 'None'.
130 --turbo TURBO
133 Comma-separated list of turbo configurations to measure with.
134 The default is "on". Supported values are "on" and "off".
135 --freqs FREQS
138 Comma-separated list of frequencies to be measured with. For
139 more information, see '--min-freq' and '--max-freq' options of
140 the 'pepc pstates config' command.
141 --uncore-freqs UNCORE_FREQS
144 Comma-separated list of package uncore frequencies to measure
145 with. For more information, see '--min-uncore-freq' and
146 '--max-uncore-freq' options of the 'pepc pstates config' com‐
147 mand.
148 --governor GOVERNOR
151 Name of the CPU frequency governor to measure with.
152 --aspm ASPM
155 Comma-separated list of PCIe ASPM configurations to measure
156 with. The default is "don't care". Supported values are "on" and
157 "off".
158 --c1-demotion C1_DEMOTION
161 Comma-separated list of C1 demotion configurations to measure
162 with. Default is "off". Supported values are "on" and "off".
163 --c1-undemotion C1_UNDEMOTION
166 Comma-separated list of C1 undemotion configurations to measure
167 with. Default is "off". Supported values are "on" and "off".
168 --c1e-autopromote C1E_AUTOPROMOTE
171 Comma-separated list of C1E autopromote configurations to mea‐
172 sure with. Default is "off". Supported values are "on" and
173 "off".
174 --cstate-prewake CSTATE_PREWAKE
177 Comma-separated list of C-state prewake configurations to mea‐
178 sure with. Default is "off". Supported values are "on" and
179 "off".
180 --epp EPP
183 Comma-separated list of EPP configurations to measure with. De‐
184 fault is "balance_performance". See 'pepc pstates config --epp'
185 for more information .
186 --epp-hw EPP_HW
189 Comma-separated list of EPP configurations to measure with. De‐
190 fault is "don't care". See 'pepc pstates config --epp-hw' for
191 more information.
192 --epb EPB
195 Comma-separated list of EPB configurations to measure with. De‐
196 fault is "balance-performance". See 'pepc pstates config --epb'
197 for more information .
198 --epb-hw EPB_HW
201 Comma-separated list of EPB configurations to measure with. De‐
202 fault is "don't care". See 'pepc pstates config --epb-hw' for
203 more information.
204 --state-reset
207 Set SUT settings to default values before starting measurements.
208 The default values are: online all CPUs, enable all C-states,
209 disable C1 demotion, disable C1 undemotion, disable C1E autopro‐
210 motion, disable C-state prewake, enable turbo, unlock CPU fre‐
211 quency, unlock uncore frequency, set EPP policy to 'balance_per‐
212 formance', set EPB policy to 'balance-performance'.
213 --deploy
216 Applicable only to 'wult' and 'ndl' tools. Run the 'deploy' com‐
217 mand before starting the measurements.
218 --devids DEVIDS
221 Applicable only to 'wult' and 'ndl' tools. Comma-separated list
222 of device IDs to run the tools with.
223 --command COMMAND
226 Applicable only to 'stats-collect' tool. The command to that
227 'stats-collect' should run.
228 --stop-on-failure
231 Stop if any of the steps fail, instead of continuing (default).
232 --only-measured-cpu
235 Change settings, for example CPU frequency and C-state limits,
236 only for the measured CPU. By default settings are applied to
237 all CPUs.
238 --toolpath TOOLPATH
241 Path to the tool to run. Default is 'wult'.
242 --toolopts TOOLOPTS
245 Additional options to use for running the tool. The string
246 "__reportid__" will be replaced with generated report ID.
247 --outdir OUTDIR, -o OUTDIR
250 Path to directory to store the results at. Default is <tool‐
251 name-date-time>.
252 --dry-run
255 Do not run any commands, only print them.
256 --list-monikers
259 A moniker is an abbreviation for a setting. The 'exercise-sut'
260 uses monikers to create directory names and report IDs for col‐
261 lected results. Use this option to list monikers assosiated with
262 each settings, if any, and exit.
263
266 usage: exercise-sut report [-h] [-q] [-d] [--diffs DIFFS] [--include
267 INCLUDE] [--exclude EXCLUDE] [--jobs JOBS] [--toolpath TOOLPATH]
268 [--toolopts TOOLOPTS] [--outdir OUTDIR] [--stop-on-failure] [--dry-run]
269 [--list-monikers]
270 [respaths ...]
271 Generate reports from collected data. Unknown options are passed as-is
273 to the report tool.
274 respaths
277 One or multiple paths to be searched for test results.
278
281 -h Show this help message and exit.
282 -q Be quiet.
285 -d Print debugging information.
288 --diffs DIFFS
291 Collected data is stored in directories, and each directory name
292 is constructed from multiple monikers separated by dashes, e.g.
293 'hrt-c6-uf_max-autoc1e_off'. This option can be used to create
294 diff reports by including multiple results in one report.
295 Comma-separated list of monikers to select results to include in
296 the diff report. This option can be used multiple times. If this
297 option is not provided, reports with single result are gener‐
298 ated.
299 --include INCLUDE
302 Comma-separated list of monikers that must be found from the re‐
303 sult path name.
304 --exclude EXCLUDE
307 Comma-separated list of monikers that must not be found from the
308 result path name.
309 --jobs JOBS, -j JOBS
312 Number of threads to use for generating reports with.
313 --toolpath TOOLPATH
316 By default, name of the report tool is resolved from the re‐
317 sults. This option can be used to override the tool.
318 --toolopts TOOLOPTS
321 Additional options to use for running the tool. The string
322 "__reportid__" will be replaced with generated report ID.
323 --outdir OUTDIR, -o OUTDIR
326 Path to directory to store the results at. Default is <tool‐
327 name-date-time>.
328 --stop-on-failure
331 Stop if any of the steps fail, instead of continuing (default).
332 --dry-run
335 Do not run any commands, only print them.
336 --list-monikers
339 A moniker is an abbreviation for a setting. The 'exercise-sut'
340 uses monikers to create directory names and report IDs for col‐
341 lected results. Use this option to list monikers assosiated with
342 each settings, if any, and exit.
343
346 Artem Bityutskiy
347 dedekind1@gmail.com
348
351 The latest version of wult may be downloaded from
352 ⟨https://github.com/intel/wult⟩
353wult 2023-08-18 EXERCISE-SUT(1)