Commit | Line | Data |
---|---|---|
9e7973fa DM |
1 | #!/usr/bin/perl |
2 | # | |
3 | # A tool for analysing the performance of the code snippets found in | |
4 | # t/perf/benchmarks or similar | |
5 | ||
6 | ||
7 | =head1 NAME | |
8 | ||
9 | bench.pl - Compare the performance of perl code snippets across multiple | |
10 | perls. | |
11 | ||
12 | =head1 SYNOPSIS | |
13 | ||
4a1358c2 FC |
14 | # Basic: run the tests in t/perf/benchmarks against two or |
15 | # more perls | |
9e7973fa | 16 | |
99b1e78b | 17 | bench.pl [options] perlA[=labelA] perlB[=labelB] ... |
32dfbb33 | 18 | |
5db17e29 | 19 | # run the tests against the same perl twice, with varying options |
32dfbb33 | 20 | |
88f3a7c3 | 21 | bench.pl [options] perlA=bigint --args='-Mbigint' perlA=plain |
9e7973fa | 22 | |
5db17e29 DM |
23 | # Run bench on blead, saving results to file; then modify the blead |
24 | # binary, and benchmark again, comparing against the saved results | |
4044748b | 25 | |
88f3a7c3 | 26 | bench.pl [options] --write=blead.time ./perl=blead |
5db17e29 | 27 | # ... hack hack hack, updating ./perl ... |
88f3a7c3 | 28 | bench.pl --read=blead.time ./perl=hacked |
4044748b | 29 | |
68de41bc | 30 | # You can also combine --read with --write and new benchmark runs |
5db17e29 | 31 | |
c3bb902a | 32 | bench.pl --read=blead.time --write=last.time -- ./perl=hacked |
4044748b | 33 | |
9e7973fa DM |
34 | =head1 DESCRIPTION |
35 | ||
36 | By default, F<bench.pl> will run code snippets found in | |
37 | F<t/perf/benchmarks> (or similar) under cachegrind, in order to calculate | |
38 | how many instruction reads, data writes, branches, cache misses, etc. that | |
5db17e29 DM |
39 | one execution of the snippet uses. Usually it will run them against two or |
40 | more perl executables and show how much each test has gotten better or | |
41 | worse. | |
9e7973fa DM |
42 | |
43 | It is modelled on the F<perlbench> tool, but since it measures instruction | |
44 | reads etc., rather than timings, it is much more precise and reproducible. | |
e34630bf | 45 | It is also considerably faster, and is capable of running tests in |
9e7973fa DM |
46 | parallel (with C<-j>). Rather than displaying a single relative |
47 | percentage per test/perl combination, it displays values for 13 different | |
48 | measurements, such as instruction reads, conditional branch misses etc. | |
49 | ||
50 | There are options to write the raw data to a file, and to read it back. | |
51 | This means that you can view the same run data in different views with | |
4044748b YO |
52 | different selection and sort options. You can also use this mechanism |
53 | to save the results of timing one perl, and then read it back while timing | |
5db17e29 DM |
54 | a modification, so that you don't have rerun the same tests on the same |
55 | perl over and over, or have two perl executables built at the same time. | |
9e7973fa DM |
56 | |
57 | The optional C<=label> after each perl executable is used in the display | |
4044748b | 58 | output. If you are doing a two step benchmark then you should provide |
99b1e78b DM |
59 | a label for at least the "base" perl. If a label isn't specified, it |
60 | defaults to the name of the perl executable. Labels must be unique across | |
61 | all current executables, plus any previous ones obtained via --read. | |
62 | ||
63 | In its most general form, the specification of a perl executable is: | |
64 | ||
88f3a7c3 DM |
65 | path/perl=+mylabel --args='-foo -bar' --args='-baz' \ |
66 | --env='A=a' --env='B=b' | |
99b1e78b DM |
67 | |
68 | This defines how to run the executable F<path/perl>. It has a label, | |
69 | which due to the C<+>, is appended to the binary name to give a label of | |
70 | C<path/perl=+mylabel> (without the C<+>, the label would be just | |
71 | C<mylabel>). | |
72 | ||
73 | It can be optionally followed by one or more C<--args> or C<--env> | |
74 | switches, which specify extra command line arguments or environment | |
75 | variables to use when invoking that executable. Each C<--env> switch | |
88f3a7c3 DM |
76 | should be of the form C<--env=VARIABLE=value>. Any C<--arg> values are |
77 | concatenated to the eventual command line, along with the global | |
78 | C<--perlargs> value if any. The above would cause a system() call looking | |
79 | something like: | |
99b1e78b | 80 | |
88f3a7c3 DM |
81 | PERL_HASH_SEED=0 A=a B=b valgrind --tool=cachegrind \ |
82 | path/perl -foo -bar -baz .... | |
9e7973fa DM |
83 | |
84 | =head1 OPTIONS | |
85 | ||
5db17e29 DM |
86 | =head2 General options |
87 | ||
9e7973fa DM |
88 | =over 4 |
89 | ||
90 | =item * | |
91 | ||
92 | --action=I<foo> | |
93 | ||
94 | What action to perform. The default is I<grind>, which runs the benchmarks | |
95 | using I<cachegrind> as the back end. The only other action at the moment is | |
96 | I<selftest>, which runs some basic sanity checks and produces TAP output. | |
97 | ||
98 | =item * | |
99 | ||
5db17e29 | 100 | --debug |
9e7973fa | 101 | |
aa46525d | 102 | Enable debugging output. |
9e7973fa DM |
103 | |
104 | =item * | |
105 | ||
5db17e29 | 106 | ---help |
9e7973fa | 107 | |
5db17e29 | 108 | Display basic usage information. |
9e7973fa DM |
109 | |
110 | =item * | |
111 | ||
aa46525d | 112 | -v |
5db17e29 | 113 | --verbose |
9e7973fa | 114 | |
5db17e29 | 115 | Display progress information. |
9e7973fa | 116 | |
5db17e29 | 117 | =back |
9e7973fa | 118 | |
5db17e29 DM |
119 | =head2 Test selection options |
120 | ||
121 | =over 4 | |
9e7973fa DM |
122 | |
123 | =item * | |
124 | ||
5db17e29 | 125 | --tests=I<FOO> |
df3d7b3a | 126 | |
68de41bc | 127 | Specify a subset of tests to run (or in the case of C<--read>, to read). |
5db17e29 DM |
128 | It may be either a comma-separated list of test names, or a regular |
129 | expression. For example | |
df3d7b3a | 130 | |
5db17e29 DM |
131 | --tests=expr::assign::scalar_lex,expr::assign::2list_lex |
132 | --tests=/^expr::/ | |
df3d7b3a | 133 | |
9e7973fa | 134 | |
5db17e29 DM |
135 | =back |
136 | ||
137 | =head2 Input options | |
138 | ||
139 | =over 4 | |
140 | ||
9e7973fa DM |
141 | |
142 | =item * | |
143 | ||
5db17e29 DM |
144 | -r I<file> |
145 | --read=I<file> | |
9e7973fa | 146 | |
5db17e29 | 147 | Read in saved data from a previous C<--write> run from the specified file. |
68de41bc DM |
148 | If C<--tests> is present too, then only tests matching those conditions |
149 | are read from the file. | |
150 | ||
151 | C<--read> may be specified multiple times, in which case the results | |
152 | across all files are aggregated. The list of test names from each file | |
153 | (after filtering by C<--tests>) must be identical across all files. | |
154 | ||
4533e88f DM |
155 | This list of tests is used instead of that obtained from the normal |
156 | benchmark file (or C<--benchfile>) for any benchmarks that are run. | |
9e7973fa | 157 | |
88f3a7c3 DM |
158 | The perl labels must be unique across all read in test results. |
159 | ||
5db17e29 | 160 | Requires C<JSON::PP> to be available. |
9e7973fa | 161 | |
5db17e29 DM |
162 | =back |
163 | ||
164 | =head2 Benchmarking options | |
165 | ||
166 | Benchmarks will be run for all perls specified on the command line. | |
167 | These options can be used to modify the benchmarking behavior: | |
168 | ||
169 | =over 4 | |
170 | ||
171 | =item * | |
172 | ||
1e072f25 DM |
173 | --autolabel |
174 | ||
175 | Generate a unique label for every executable which doesn't have an | |
176 | explicit C<=label>. Works by stripping out common prefixes and suffixes | |
177 | from the executable names, then for any non-unique names, appending | |
88f3a7c3 DM |
178 | C<-0>, C<-1>, etc. text directly surrounding the unique part which look |
179 | like version numbers (i.e. which match C</[0-9\.]+/>) aren't stripped. | |
1e072f25 DM |
180 | For example, |
181 | ||
182 | perl-5.20.0-threaded perl-5.22.0-threaded perl-5.24.0-threaded | |
183 | ||
184 | stripped to unique parts would be: | |
185 | ||
186 | 20 22 24 | |
187 | ||
188 | but is actually only stripped down to: | |
189 | ||
190 | 5.20.0 5.22.0 5.24.0 | |
191 | ||
0a1b8eb0 DM |
192 | If the final results are plain integers, they are prefixed with "p" |
193 | to avoid looking like column numbers to switches like C<--norm=2>. | |
194 | ||
1e072f25 DM |
195 | |
196 | =item * | |
197 | ||
5db17e29 DM |
198 | --benchfile=I<foo> |
199 | ||
200 | The path of the file which contains the benchmarks (F<t/perf/benchmarks> | |
201 | by default). | |
9e7973fa DM |
202 | |
203 | =item * | |
204 | ||
205 | --grindargs=I<foo> | |
206 | ||
8a094fee JC |
207 | Optional command-line arguments to pass to all cachegrind invocations. |
208 | ||
9e7973fa DM |
209 | =item * |
210 | ||
211 | -j I<N> | |
212 | --jobs=I<N> | |
213 | ||
214 | Run I<N> jobs in parallel (default 1). This determines how many cachegrind | |
88f3a7c3 | 215 | process will run at a time, and should generally be set to the number |
9e7973fa DM |
216 | of CPUs available. |
217 | ||
218 | =item * | |
219 | ||
5db17e29 | 220 | --perlargs=I<foo> |
9e7973fa | 221 | |
99b1e78b | 222 | Optional command-line arguments to pass to every perl executable. This |
88f3a7c3 | 223 | may optionaly be combined with C<--args> switches following individual |
99b1e78b DM |
224 | perls. For example: |
225 | ||
226 | bench.pl --perlargs='-Ilib -It/lib' .... \ | |
227 | perlA --args='-Mstrict' \ | |
228 | perlB --args='-Mwarnings' | |
229 | ||
230 | would cause the invocations | |
231 | ||
232 | perlA -Ilib -It/lib -Mstrict | |
233 | perlB -Ilib -It/lib -Mwarnings | |
5db17e29 DM |
234 | |
235 | =back | |
236 | ||
237 | =head2 Output options | |
238 | ||
88f3a7c3 | 239 | Any results accumulated via --read or by running benchmarks can be output |
5db17e29 DM |
240 | in any or all of these three ways: |
241 | ||
242 | =over 4 | |
9e7973fa DM |
243 | |
244 | =item * | |
245 | ||
5db17e29 DM |
246 | -w I<file> |
247 | --write=I<file> | |
9e7973fa | 248 | |
5db17e29 DM |
249 | Save the raw data to the specified file. It can be read back later with |
250 | C<--read>. If combined with C<--read> then the output file will be | |
251 | the merge of the file read and any additional perls added on the command | |
252 | line. | |
253 | ||
254 | Requires C<JSON::PP> to be available. | |
9e7973fa DM |
255 | |
256 | =item * | |
257 | ||
5db17e29 | 258 | --bisect=I<field,minval,maxval> |
9e7973fa | 259 | |
88f3a7c3 DM |
260 | Exit with a zero status if the named field is in the specified range; |
261 | exit with 1 otherwise. It will complain if more than one test or perl has | |
262 | been specified. It is intended to be called as part of a bisect run, to | |
263 | determine when something changed. For example, | |
5db17e29 DM |
264 | |
265 | bench.pl -j 8 --tests=foo --bisect=Ir,100,105 --perlargs=-Ilib \ | |
266 | ./miniperl | |
267 | ||
268 | might be called from bisect to find when the number of instruction reads | |
269 | for test I<foo> falls outside the range 100..105. | |
9e7973fa DM |
270 | |
271 | =item * | |
272 | ||
5db17e29 | 273 | --show |
9e7973fa | 274 | |
5db17e29 DM |
275 | Display the results to stdout in human-readable form. This is enabled by |
276 | default, except with --write and --bisect. The following sub-options alter | |
277 | how --show behaves. | |
9e7973fa | 278 | |
5db17e29 | 279 | =over 4 |
9e7973fa DM |
280 | |
281 | =item * | |
282 | ||
5db17e29 | 283 | --average |
9e7973fa | 284 | |
5db17e29 DM |
285 | Only display the overall average, rather than the results for each |
286 | individual test. | |
9e7973fa | 287 | |
5db17e29 DM |
288 | =item * |
289 | ||
88f3a7c3 | 290 | --compact=I<perl> |
5db17e29 DM |
291 | |
292 | Display the results for a single perl executable in a compact form. | |
293 | Which perl to display is specified in the same manner as C<--norm>. | |
9e7973fa DM |
294 | |
295 | =item * | |
296 | ||
5db17e29 | 297 | --fields=I<a,b,c> |
9e7973fa | 298 | |
5db17e29 | 299 | Display only the specified fields; for example, |
9e7973fa | 300 | |
5db17e29 DM |
301 | --fields=Ir,Ir_m,Ir_mm |
302 | ||
303 | If only one field is selected, the output is in more compact form. | |
9e7973fa DM |
304 | |
305 | =item * | |
306 | ||
5db17e29 | 307 | --norm=I<foo> |
9e7973fa | 308 | |
5db17e29 | 309 | Specify which perl column in the output to treat as the 100% norm. |
a6d04d4a DM |
310 | It may be: |
311 | ||
312 | =over | |
313 | ||
314 | * a column number (0..N-1), | |
315 | ||
316 | * a negative column number (-1..-N) which counts from the right (so -1 is | |
317 | the right-most column), | |
318 | ||
319 | * or a perl executable name, | |
320 | ||
321 | * or a perl executable label. | |
322 | ||
323 | =back | |
324 | ||
5db17e29 | 325 | It defaults to the leftmost column. |
9e7973fa DM |
326 | |
327 | =item * | |
328 | ||
5db17e29 | 329 | --raw |
9e7973fa | 330 | |
5db17e29 DM |
331 | Display raw data counts rather than percentages in the outputs. This |
332 | allows you to see the exact number of intruction reads, branch misses etc. | |
333 | for each test/perl combination. It also causes the C<AVERAGE> display | |
334 | per field to be calculated based on the average of each tests's count | |
335 | rather than average of each percentage. This means that tests with very | |
336 | high counts will dominate. | |
9e7973fa | 337 | |
5db17e29 DM |
338 | =item * |
339 | ||
340 | --sort=I<field:perl> | |
341 | ||
342 | Order the tests in the output based on the value of I<field> in the | |
343 | column I<perl>. The I<perl> value is as per C<--norm>. For example | |
344 | ||
345 | bench.pl --sort=Dw:perl-5.20.0 \ | |
346 | perl-5.16.0 perl-5.18.0 perl-5.20.0 | |
347 | ||
348 | =back | |
9e7973fa DM |
349 | |
350 | =back | |
351 | ||
352 | =cut | |
353 | ||
354 | ||
355 | ||
356 | use 5.010000; | |
357 | use warnings; | |
358 | use strict; | |
d54523c4 | 359 | use Getopt::Long qw(:config no_auto_abbrev require_order); |
9e7973fa DM |
360 | use IPC::Open2 (); |
361 | use IO::Select; | |
c2d21e7a | 362 | use IO::File; |
9e7973fa DM |
363 | use POSIX ":sys_wait_h"; |
364 | ||
365 | # The version of the file format used to save data. We refuse to process | |
366 | # the file if the integer component differs. | |
367 | ||
368 | my $FORMAT_VERSION = 1.0; | |
369 | ||
370 | # The fields we know about | |
371 | ||
372 | my %VALID_FIELDS = map { $_ => 1 } | |
373 | qw(Ir Ir_m1 Ir_mm Dr Dr_m1 Dr_mm Dw Dw_m1 Dw_mm COND COND_m IND IND_m); | |
374 | ||
375 | sub usage { | |
376 | die <<EOF; | |
5db17e29 DM |
377 | Usage: $0 [options] -- perl[=label] ... |
378 | ||
379 | General options: | |
380 | ||
381 | --action=foo What action to perform [default: grind]: | |
382 | grind run the code under cachegrind | |
383 | selftest perform a selftest; produce TAP output | |
9e7973fa | 384 | --debug Enable verbose debugging output. |
9e7973fa | 385 | --help Display this help. |
aa46525d | 386 | -v|--verbose Display progress information. |
5db17e29 DM |
387 | |
388 | ||
389 | Selection: | |
390 | ||
391 | --tests=FOO Select only the specified tests for reading, benchmarking | |
392 | and display. FOO may be either a list of tests or | |
393 | a pattern: 'foo,bar,baz' or '/regex/'; | |
394 | [default: all tests]. | |
395 | ||
396 | Input: | |
397 | ||
398 | -r|--read=file Read in previously saved data from the specified file. | |
399 | May be repeated, and be used together with new | |
400 | benchmarking to create combined results. | |
401 | ||
402 | Benchmarking: | |
403 | Benchmarks will be run for any perl specified on the command line. | |
404 | These options can be used to modify the benchmarking behavior: | |
405 | ||
1e072f25 | 406 | --autolabel generate labels for any executables without one |
5db17e29 DM |
407 | --benchfile=foo File containing the benchmarks. |
408 | [default: t/perf/benchmarks]. | |
409 | --grindargs=foo Optional command-line args to pass to cachegrind. | |
9e7973fa | 410 | -j|--jobs=N Run N jobs in parallel [default 1]. |
9e7973fa | 411 | --perlargs=foo Optional command-line args to pass to each perl to run. |
5db17e29 DM |
412 | |
413 | Output: | |
414 | Any results accumulated via --read or running benchmarks can be output | |
415 | in any or all of these three ways: | |
416 | ||
417 | -w|--write=file Save the raw data to the specified file (may be read | |
418 | back later with --read). | |
419 | ||
420 | --bisect=f,min,max Exit with a zero status if the named field f is in | |
421 | the specified min..max range; exit 1 otherwise. | |
422 | Produces no other output. Only legal if a single | |
423 | benchmark test has been specified. | |
424 | ||
425 | --show Display the results to stdout in human-readable form. | |
426 | This is enabled by default, except with --write and | |
427 | --bisect. The following sub-options alter how | |
428 | --show behaves. | |
429 | ||
430 | --average Only display average, not individual test results. | |
431 | --compact=perl Display the results of a single perl in compact form. | |
432 | Which perl specified like --norm | |
433 | --fields=a,b,c Display only the specified fields (e.g. Ir,Ir_m,Ir_mm). | |
434 | --norm=perl Which perl column to treat as 100%; may be a column | |
435 | number (0..N-1) or a perl executable name or label; | |
436 | [default: 0]. | |
437 | --raw Display raw data counts rather than percentages. | |
438 | --sort=field:perl Sort the tests based on the value of 'field' in the | |
9e7973fa | 439 | column 'perl'. The perl value is as per --norm. |
9e7973fa | 440 | |
9e7973fa DM |
441 | |
442 | The command line ends with one or more specified perl executables, | |
443 | which will be searched for in the current \$PATH. Each binary name may | |
444 | have an optional =LABEL appended, which will be used rather than the | |
99b1e78b DM |
445 | executable name in output. The labels must be unique across all current |
446 | executables and previous runs obtained via --read. Each executable may | |
447 | optionally be succeeded by --args= and --env= to specify per-executable | |
448 | arguments and environmenbt variables: | |
9e7973fa | 449 | |
99b1e78b DM |
450 | perl-5.24.0=strict --args='-Mwarnings -Mstrict' --env='FOO=foo' \ |
451 | perl-5.24.0=plain | |
9e7973fa DM |
452 | EOF |
453 | } | |
454 | ||
455 | my %OPTS = ( | |
456 | action => 'grind', | |
457 | average => 0, | |
4533e88f | 458 | benchfile => undef, |
9e7973fa | 459 | bisect => undef, |
df3d7b3a | 460 | compact => undef, |
9e7973fa DM |
461 | debug => 0, |
462 | grindargs => '', | |
463 | fields => undef, | |
464 | jobs => 1, | |
465 | norm => 0, | |
466 | perlargs => '', | |
467 | raw => 0, | |
468 | read => undef, | |
5db17e29 | 469 | show => undef, |
9e7973fa DM |
470 | sort => undef, |
471 | tests => undef, | |
472 | verbose => 0, | |
473 | write => undef, | |
474 | ); | |
475 | ||
476 | ||
477 | # process command-line args and call top-level action | |
478 | ||
479 | { | |
480 | GetOptions( | |
481 | 'action=s' => \$OPTS{action}, | |
482 | 'average' => \$OPTS{average}, | |
1e072f25 | 483 | 'autolabel' => \$OPTS{autolabel}, |
9e7973fa DM |
484 | 'benchfile=s' => \$OPTS{benchfile}, |
485 | 'bisect=s' => \$OPTS{bisect}, | |
df3d7b3a | 486 | 'compact=s' => \$OPTS{compact}, |
9e7973fa DM |
487 | 'debug' => \$OPTS{debug}, |
488 | 'grindargs=s' => \$OPTS{grindargs}, | |
f9fa26a6 | 489 | 'help|h' => \$OPTS{help}, |
9e7973fa DM |
490 | 'fields=s' => \$OPTS{fields}, |
491 | 'jobs|j=i' => \$OPTS{jobs}, | |
492 | 'norm=s' => \$OPTS{norm}, | |
493 | 'perlargs=s' => \$OPTS{perlargs}, | |
494 | 'raw' => \$OPTS{raw}, | |
ee172d48 | 495 | 'read|r=s@' => \$OPTS{read}, |
5db17e29 | 496 | 'show' => \$OPTS{show}, |
9e7973fa DM |
497 | 'sort=s' => \$OPTS{sort}, |
498 | 'tests=s' => \$OPTS{tests}, | |
aa46525d | 499 | 'v|verbose' => \$OPTS{verbose}, |
9e7973fa | 500 | 'write|w=s' => \$OPTS{write}, |
f9fa26a6 | 501 | ) or die "Use the -h option for usage information.\n"; |
9e7973fa DM |
502 | |
503 | usage if $OPTS{help}; | |
504 | ||
505 | ||
9e7973fa DM |
506 | if (defined $OPTS{read} or defined $OPTS{write}) { |
507 | # fail early if it's not present | |
508 | require JSON::PP; | |
509 | } | |
510 | ||
511 | if (defined $OPTS{fields}) { | |
512 | my @f = split /,/, $OPTS{fields}; | |
513 | for (@f) { | |
514 | die "Error: --fields: unknown field '$_'\n" | |
515 | unless $VALID_FIELDS{$_}; | |
516 | } | |
517 | my %f = map { $_ => 1 } @f; | |
518 | $OPTS{fields} = \%f; | |
519 | } | |
520 | ||
521 | my %valid_actions = qw(grind 1 selftest 1); | |
522 | unless ($valid_actions{$OPTS{action}}) { | |
523 | die "Error: unrecognised action '$OPTS{action}'\n" | |
524 | . "must be one of: " . join(', ', sort keys %valid_actions)."\n"; | |
525 | } | |
526 | ||
527 | if (defined $OPTS{sort}) { | |
528 | my @s = split /:/, $OPTS{sort}; | |
529 | if (@s != 2) { | |
530 | die "Error: --sort argument should be of the form field:perl: " | |
531 | . "'$OPTS{sort}'\n"; | |
532 | } | |
533 | my ($field, $perl) = @s; | |
5ad96e9e | 534 | die "Error: --sort: unknown field '$field'\n" |
9e7973fa DM |
535 | unless $VALID_FIELDS{$field}; |
536 | # the 'perl' value will be validated later, after we have processed | |
537 | # the perls | |
538 | $OPTS{'sort-field'} = $field; | |
539 | $OPTS{'sort-perl'} = $perl; | |
540 | } | |
541 | ||
5db17e29 DM |
542 | # show is the default output action |
543 | $OPTS{show} = 1 unless $OPTS{write} || $OPTS{bisect}; | |
9e7973fa DM |
544 | |
545 | if ($OPTS{action} eq 'grind') { | |
546 | do_grind(\@ARGV); | |
547 | } | |
548 | elsif ($OPTS{action} eq 'selftest') { | |
5db17e29 DM |
549 | if (@ARGV) { |
550 | die "Error: no perl executables may be specified with selftest\n" | |
551 | } | |
9e7973fa DM |
552 | do_selftest(); |
553 | } | |
554 | } | |
555 | exit 0; | |
556 | ||
557 | ||
558 | # Given a hash ref keyed by test names, filter it by deleting unwanted | |
559 | # tests, based on $OPTS{tests}. | |
560 | ||
561 | sub filter_tests { | |
562 | my ($tests) = @_; | |
563 | ||
564 | my $opt = $OPTS{tests}; | |
565 | return unless defined $opt; | |
566 | ||
567 | my @tests; | |
568 | ||
569 | if ($opt =~ m{^/}) { | |
570 | $opt =~ s{^/(.+)/$}{$1} | |
571 | or die "Error: --tests regex must be of the form /.../\n"; | |
572 | for (keys %$tests) { | |
573 | delete $tests->{$_} unless /$opt/; | |
574 | } | |
575 | } | |
576 | else { | |
577 | my %t; | |
578 | for (split /,/, $opt) { | |
9e7973fa | 579 | $t{$_} = 1; |
e89a8e10 DM |
580 | next if exists $tests->{$_}; |
581 | ||
582 | my $e = "Error: no such test found: '$_'\n"; | |
583 | if ($OPTS{verbose}) { | |
584 | $e .= "Valid test names are:\n"; | |
585 | $e .= " $_\n" for sort keys %$tests; | |
586 | } | |
587 | else { | |
588 | $e .= "Re-run with --verbose for a list of valid tests.\n"; | |
589 | } | |
590 | die $e; | |
9e7973fa DM |
591 | } |
592 | for (keys %$tests) { | |
593 | delete $tests->{$_} unless exists $t{$_}; | |
594 | } | |
595 | } | |
4044748b | 596 | die "Error: no tests to run\n" unless %$tests; |
9e7973fa DM |
597 | } |
598 | ||
599 | ||
600 | # Read in the test file, and filter out any tests excluded by $OPTS{tests} | |
957d8930 DM |
601 | # return a hash ref { testname => { test }, ... } |
602 | # and an array ref of the original test names order, | |
9e7973fa DM |
603 | |
604 | sub read_tests_file { | |
605 | my ($file) = @_; | |
606 | ||
ea572010 DM |
607 | my $ta; |
608 | { | |
609 | local @INC = ('.'); | |
610 | $ta = do $file; | |
611 | } | |
9e7973fa | 612 | unless ($ta) { |
1137c9fa DM |
613 | die "Error: can't load '$file': code didn't return a true value\n" |
614 | if defined $ta; | |
615 | die "Error: can't parse '$file':\n$@\n" if $@; | |
9e7973fa DM |
616 | die "Error: can't read '$file': $!\n"; |
617 | } | |
618 | ||
1836b255 DM |
619 | # validate and process each test |
620 | ||
621 | { | |
a9b10838 | 622 | my %valid = map { $_ => 1 } qw(desc setup code pre post compile); |
1836b255 DM |
623 | my @tests = @$ta; |
624 | if (!@tests || @tests % 2 != 0) { | |
625 | die "Error: '$file' does not contain evenly paired test names and hashes\n"; | |
626 | } | |
627 | while (@tests) { | |
628 | my $name = shift @tests; | |
629 | my $hash = shift @tests; | |
630 | ||
631 | unless ($name =~ /^[a-zA-Z]\w*(::\w+)*$/) { | |
632 | die "Error: '$file': invalid test name: '$name'\n"; | |
633 | } | |
634 | ||
635 | for (sort keys %$hash) { | |
636 | die "Error: '$file': invalid key '$_' for test '$name'\n" | |
637 | unless exists $valid{$_}; | |
638 | } | |
b0ecc2e1 DM |
639 | |
640 | # make description default to the code | |
641 | $hash->{desc} = $hash->{code} unless exists $hash->{desc}; | |
1836b255 DM |
642 | } |
643 | } | |
644 | ||
957d8930 DM |
645 | my @orig_order; |
646 | for (my $i=0; $i < @$ta; $i += 2) { | |
647 | push @orig_order, $ta->[$i]; | |
648 | } | |
649 | ||
9e7973fa DM |
650 | my $t = { @$ta }; |
651 | filter_tests($t); | |
957d8930 | 652 | return $t, \@orig_order; |
9e7973fa DM |
653 | } |
654 | ||
655 | ||
5db17e29 DM |
656 | # Process the perl name/label/column argument of options like --norm and |
657 | # --sort. Return the index of the matching perl. | |
9e7973fa DM |
658 | |
659 | sub select_a_perl { | |
660 | my ($perl, $perls, $who) = @_; | |
a6d04d4a DM |
661 | $perls ||= []; |
662 | my $n = @$perls; | |
663 | ||
664 | if ($perl =~ /^-([0-9]+)$/) { | |
665 | my $p = $1; | |
666 | die "Error: $who value $perl outside range -1..-$n\n" | |
667 | if $p < 1 || $p > $n; | |
668 | return $n - $p; | |
669 | } | |
670 | ||
671 | if ($perl =~ /^[0-9]+$/) { | |
9e7973fa | 672 | die "Error: $who value $perl outside range 0.." . $#$perls . "\n" |
a6d04d4a | 673 | unless $perl < $n; |
9e7973fa DM |
674 | return $perl; |
675 | } | |
676 | else { | |
677 | my @perl = grep $perls->[$_][0] eq $perl | |
678 | || $perls->[$_][1] eq $perl, | |
679 | 0..$#$perls; | |
78d44f6b DM |
680 | unless (@perl) { |
681 | my $valid = ''; | |
682 | for (@$perls) { | |
683 | $valid .= " $_->[1]"; | |
684 | $valid .= " $_->[0]" if $_->[0] ne $_->[1]; | |
685 | $valid .= "\n"; | |
686 | } | |
687 | die "Error: $who: unrecognised perl '$perl'\n" | |
688 | . "Valid perl names are:\n$valid"; | |
689 | } | |
9e7973fa DM |
690 | die "Error: $who: ambiguous perl '$perl'\n" |
691 | if @perl > 1; | |
692 | return $perl[0]; | |
693 | } | |
694 | } | |
695 | ||
696 | ||
99b1e78b DM |
697 | # Validate the list of perl executables on the command line. |
698 | # The general form is | |
699 | # | |
700 | # a_perl_exe[=label] [ --args='perl args'] [ --env='FOO=foo' ] | |
701 | # | |
702 | # Return a list of [ exe, label, {env}, 'args' ] tuples | |
703 | ||
704 | sub process_executables_list { | |
705 | my ($read_perls, @cmd_line_args) = @_; | |
9e7973fa | 706 | |
99b1e78b | 707 | my @results; # returned, each item is [ perlexe, label, {env}, 'args' ] |
81cb9d79 DM |
708 | my %seen_from_reads = map { $_->[1] => 1 } @$read_perls; |
709 | my %seen; | |
1e072f25 | 710 | my @labels; |
d54523c4 | 711 | |
99b1e78b DM |
712 | while (@cmd_line_args) { |
713 | my $item = shift @cmd_line_args; | |
714 | ||
715 | if ($item =~ /^--(.*)$/) { | |
716 | my ($switch, $val) = split /=/, $1, 2; | |
717 | die "Error: unrecognised executable switch '--$switch'\n" | |
718 | unless $switch =~ /^(args|env)$/; | |
719 | ||
720 | die "Error: --$switch without a preceding executable name\n" | |
721 | unless @results; | |
d54523c4 | 722 | |
99b1e78b DM |
723 | unless (defined $val) { |
724 | $val = shift @cmd_line_args; | |
725 | die "Error: --$switch is missing value\n" | |
726 | unless defined $val; | |
727 | } | |
728 | ||
729 | if ($switch eq 'args') { | |
730 | $results[-1][3] .= " $val"; | |
731 | } | |
732 | else { | |
733 | # --env | |
734 | $val =~ /^(\w+)=(.*)$/ | |
735 | or die "Error: --env is missing =value\n"; | |
736 | $results[-1][2]{$1} = $2; | |
737 | } | |
738 | ||
739 | next; | |
740 | } | |
741 | ||
742 | # whatever is left must be the name of an executable | |
743 | ||
744 | my ($perl, $label) = split /=/, $item, 2; | |
1e072f25 DM |
745 | push @labels, $label; |
746 | unless ($OPTS{autolabel}) { | |
747 | $label //= $perl; | |
748 | $label = $perl.$label if $label =~ /^\+/; | |
749 | } | |
81cb9d79 DM |
750 | |
751 | die "Error: duplicate label '$label': " | |
752 | . "each executable must have a unique label\n" | |
1e072f25 | 753 | if defined $label && $seen{$label}++; |
81cb9d79 DM |
754 | |
755 | die "Error: duplicate label '$label': " | |
756 | . "seen both in --read file and on command line\n" | |
1e072f25 | 757 | if defined $label && $seen_from_reads{$label}; |
955a736c | 758 | |
9e7973fa | 759 | my $r = qx($perl -e 'print qq(ok\n)' 2>&1); |
99b1e78b DM |
760 | die "Error: unable to execute '$perl': $r\n" if $r ne "ok\n"; |
761 | ||
762 | push @results, [ $perl, $label, { }, '' ]; | |
9e7973fa | 763 | } |
99b1e78b DM |
764 | |
765 | # make args '' by default | |
766 | for (@results) { | |
767 | push @$_, '' unless @$_ > 3; | |
768 | } | |
769 | ||
1e072f25 DM |
770 | if ($OPTS{autolabel}) { |
771 | ||
772 | # create a list of [ 'perl-path', $i ] pairs for all | |
773 | # $results[$i] which don't have a label | |
774 | my @labels; | |
775 | for (0..$#results) { | |
776 | push @labels, [ $results[$_][0], $_ ] | |
777 | unless defined $results[$_][1]; | |
778 | } | |
779 | ||
780 | if (@labels) { | |
781 | # strip off common prefixes | |
782 | my $pre = ''; | |
783 | STRIP_PREFIX: | |
784 | while (length $labels[0][0]) { | |
785 | my $c = substr($labels[0][0], 0, 1); | |
786 | for my $i (1..$#labels) { | |
787 | last STRIP_PREFIX if substr($labels[$i][0], 0, 1) ne $c; | |
788 | } | |
789 | substr($labels[$_][0], 0, 1) = '' for 0..$#labels; | |
790 | $pre .= $c; | |
791 | } | |
792 | # add back any final "version-ish" prefix | |
793 | $pre =~ s/^.*?([0-9\.]*)$/$1/; | |
794 | substr($labels[$_][0], 0, 0) = $pre for 0..$#labels; | |
795 | ||
796 | # strip off common suffixes | |
797 | my $post = ''; | |
798 | STRIP_SUFFFIX: | |
799 | while (length $labels[0][0]) { | |
800 | my $c = substr($labels[0][0], -1, 1); | |
801 | for my $i (1..$#labels) { | |
802 | last STRIP_SUFFFIX if substr($labels[$i][0], -1, 1) ne $c; | |
803 | } | |
804 | chop $labels[$_][0] for 0..$#labels; | |
805 | $post = "$c$post"; | |
806 | } | |
807 | # add back any initial "version-ish" suffix | |
808 | $post =~ s/^([0-9\.]*).*$/$1/; | |
809 | $labels[$_][0] .= $post for 0..$#labels; | |
810 | ||
0a1b8eb0 DM |
811 | # avoid degenerate empty string for single executable name |
812 | $labels[0][0] = '0' if @labels == 1 && !length $labels[0][0]; | |
813 | ||
814 | # if the auto-generated labels are plain integers, prefix | |
815 | # them with 'p' (for perl) to distinguish them from column | |
816 | # indices (otherwise e.g. --norm=2 is ambiguous) | |
817 | ||
818 | if ($labels[0][0] =~ /^\d*$/) { | |
819 | $labels[$_][0] = "p$labels[$_][0]" for 0..$#labels; | |
820 | } | |
821 | ||
1e072f25 DM |
822 | # now de-duplicate labels |
823 | ||
824 | my (%seen, %index); | |
825 | $seen{$read_perls->[$_][1]}++ for 0..$#$read_perls; | |
826 | $seen{$labels[$_][0]}++ for 0..$#labels; | |
827 | ||
828 | for my $i (0..$#labels) { | |
829 | my $label = $labels[$i][0]; | |
830 | next unless $seen{$label} > 1; | |
831 | my $d = length($label) ? '-' : ''; | |
832 | my $n = $index{$label} // 0; | |
833 | $n++ while exists $seen{"$label$d$n"}; | |
834 | $labels[$i][0] .= "$d$n"; | |
835 | $index{$label} = $n + 1; | |
836 | } | |
837 | ||
838 | # finally, store them | |
839 | $results[$_->[1]][1]= $_->[0] for @labels; | |
840 | } | |
841 | } | |
842 | ||
843 | ||
99b1e78b | 844 | return @results; |
9e7973fa DM |
845 | } |
846 | ||
847 | ||
8fbd1c2c | 848 | |
485eb009 DM |
849 | # Return a string containing a perl program which runs the benchmark code |
850 | # $ARGV[0] times. If $body is true, include the main body (setup) in | |
851 | # the loop; otherwise create an empty loop with just pre and post. | |
852 | # Note that an empty body is handled with '1;' so that a completely empty | |
853 | # loop has a single nextstate rather than a stub op, so more closely | |
854 | # matches the active loop; e.g.: | |
855 | # {1;} => nextstate; unstack | |
856 | # {$x=1;} => nextstate; const; gvsv; sassign; unstack | |
857 | # Note also that each statement is prefixed with a label; this avoids | |
a9b10838 DM |
858 | # adjacent nextstate ops being optimised away. |
859 | # | |
860 | # A final 1; statement is added so that the code is always in void | |
861 | # context. | |
862 | # | |
863 | # It the compile flag is set for a test, the body of the loop is wrapped in | |
864 | # eval 'sub { .... }' to measure compile time rather than execution time | |
9e7973fa DM |
865 | |
866 | sub make_perl_prog { | |
485eb009 | 867 | my ($name, $test, $body) = @_; |
a9b10838 DM |
868 | my ($desc, $setup, $code, $pre, $post, $compile) = |
869 | @$test{qw(desc setup code pre post compile)}; | |
485eb009 | 870 | |
ed7dc8b7 | 871 | $setup //= ''; |
485eb009 DM |
872 | $pre = defined $pre ? "_PRE_: $pre; " : ""; |
873 | $post = defined $post ? "_POST_: $post; " : ""; | |
874 | $code = $body ? $code : "1"; | |
875 | $code = "_CODE_: $code; "; | |
a9b10838 DM |
876 | my $full = "$pre$code$post _CXT_: 1; "; |
877 | $full = "eval q{sub { $full }};" if $compile; | |
878 | ||
9e7973fa DM |
879 | return <<EOF; |
880 | # $desc | |
485eb009 | 881 | package $name; |
9e7973fa DM |
882 | BEGIN { srand(0) } |
883 | $setup; | |
884 | for my \$__loop__ (1..\$ARGV[0]) { | |
a9b10838 | 885 | $full |
9e7973fa DM |
886 | } |
887 | EOF | |
888 | } | |
889 | ||
890 | ||
891 | # Parse the output from cachegrind. Return a hash ref. | |
892 | # See do_selftest() for examples of the output format. | |
893 | ||
894 | sub parse_cachegrind { | |
895 | my ($output, $id, $perl) = @_; | |
896 | ||
897 | my %res; | |
898 | ||
899 | my @lines = split /\n/, $output; | |
900 | for (@lines) { | |
901 | unless (s/(==\d+==)|(--\d+--) //) { | |
902 | die "Error: while executing $id:\n" | |
903 | . "unexpected code or cachegrind output:\n$_\n"; | |
904 | } | |
905 | if (/I refs:\s+([\d,]+)/) { | |
906 | $res{Ir} = $1; | |
907 | } | |
908 | elsif (/I1 misses:\s+([\d,]+)/) { | |
909 | $res{Ir_m1} = $1; | |
910 | } | |
911 | elsif (/LLi misses:\s+([\d,]+)/) { | |
912 | $res{Ir_mm} = $1; | |
913 | } | |
914 | elsif (/D refs:\s+.*?([\d,]+) rd .*?([\d,]+) wr/) { | |
915 | @res{qw(Dr Dw)} = ($1,$2); | |
916 | } | |
917 | elsif (/D1 misses:\s+.*?([\d,]+) rd .*?([\d,]+) wr/) { | |
918 | @res{qw(Dr_m1 Dw_m1)} = ($1,$2); | |
919 | } | |
920 | elsif (/LLd misses:\s+.*?([\d,]+) rd .*?([\d,]+) wr/) { | |
921 | @res{qw(Dr_mm Dw_mm)} = ($1,$2); | |
922 | } | |
923 | elsif (/Branches:\s+.*?([\d,]+) cond .*?([\d,]+) ind/) { | |
924 | @res{qw(COND IND)} = ($1,$2); | |
925 | } | |
926 | elsif (/Mispredicts:\s+.*?([\d,]+) cond .*?([\d,]+) ind/) { | |
927 | @res{qw(COND_m IND_m)} = ($1,$2); | |
928 | } | |
929 | } | |
930 | ||
931 | for my $field (keys %VALID_FIELDS) { | |
932 | die "Error: can't parse '$field' field from cachegrind output:\n$output" | |
933 | unless exists $res{$field}; | |
934 | $res{$field} =~ s/,//g; | |
935 | } | |
936 | ||
937 | return \%res; | |
938 | } | |
939 | ||
940 | ||
941 | # Handle the 'grind' action | |
942 | ||
943 | sub do_grind { | |
7570f185 | 944 | my ($cmd_line_args) = @_; # the residue of @ARGV after option processing |
9e7973fa | 945 | |
5db17e29 | 946 | my ($loop_counts, $perls, $results, $tests, $order, @run_perls); |
9e7973fa | 947 | my ($bisect_field, $bisect_min, $bisect_max); |
81cb9d79 | 948 | my ($done_read, $processed, $averages, %seen_labels); |
9e7973fa DM |
949 | |
950 | if (defined $OPTS{bisect}) { | |
951 | ($bisect_field, $bisect_min, $bisect_max) = split /,/, $OPTS{bisect}, 3; | |
952 | die "Error: --bisect option must be of form 'field,integer,integer'\n" | |
953 | unless | |
954 | defined $bisect_max | |
955 | and $bisect_min =~ /^[0-9]+$/ | |
956 | and $bisect_max =~ /^[0-9]+$/; | |
957 | ||
958 | die "Error: unrecognised field '$bisect_field' in --bisect option\n" | |
959 | unless $VALID_FIELDS{$bisect_field}; | |
960 | ||
961 | die "Error: --bisect min ($bisect_min) must be <= max ($bisect_max)\n" | |
962 | if $bisect_min > $bisect_max; | |
963 | } | |
964 | ||
5db17e29 DM |
965 | # Read in previous benchmark results |
966 | ||
ee172d48 YO |
967 | foreach my $file (@{$OPTS{read}}) { |
968 | open my $in, '<:encoding(UTF-8)', $file | |
1137c9fa | 969 | or die "Error: can't open '$file' for reading: $!\n"; |
9e7973fa DM |
970 | my $data = do { local $/; <$in> }; |
971 | close $in; | |
972 | ||
973 | my $hash = JSON::PP::decode_json($data); | |
974 | if (int($FORMAT_VERSION) < int($hash->{version})) { | |
975 | die "Error: unsupported version $hash->{version} in file" | |
1137c9fa | 976 | . " '$file' (too new)\n"; |
9e7973fa | 977 | } |
ee172d48 | 978 | my ($read_loop_counts, $read_perls, $read_results, $read_tests, $read_order) = |
957d8930 | 979 | @$hash{qw(loop_counts perls results tests order)}; |
68de41bc DM |
980 | |
981 | # check file contents for consistency | |
982 | my $k_o = join ';', sort @$read_order; | |
983 | my $k_r = join ';', sort keys %$read_results; | |
984 | my $k_t = join ';', sort keys %$read_tests; | |
985 | die "File '$file' contains no results\n" unless length $k_r; | |
986 | die "File '$file' contains differing test and results names\n" | |
987 | unless $k_r eq $k_t; | |
988 | die "File '$file' contains differing test and sort order names\n" | |
989 | unless $k_o eq $k_t; | |
990 | ||
991 | # delete tests not matching --tests= criteria, if any | |
ee172d48 YO |
992 | filter_tests($read_results); |
993 | filter_tests($read_tests); | |
68de41bc | 994 | |
81cb9d79 DM |
995 | for my $perl (@$read_perls) { |
996 | my $label = $perl->[1]; | |
997 | die "Error: duplicate label '$label': seen in file '$file'\n" | |
998 | if exists $seen_labels{$label}; | |
999 | $seen_labels{$label}++; | |
1000 | } | |
1001 | ||
f850a012 | 1002 | if (!$done_read) { |
ee172d48 YO |
1003 | ($loop_counts, $perls, $results, $tests, $order) = |
1004 | ($read_loop_counts, $read_perls, $read_results, $read_tests, $read_order); | |
f850a012 | 1005 | $done_read = 1; |
68de41bc DM |
1006 | } |
1007 | else { | |
1008 | # merge results across multiple files | |
1009 | ||
1010 | if ( join(';', sort keys %$tests) | |
1011 | ne join(';', sort keys %$read_tests)) | |
ee172d48 | 1012 | { |
68de41bc DM |
1013 | my $err = "Can't merge multiple read files: " |
1014 | . "they contain differing test sets.\n"; | |
1015 | if ($OPTS{verbose}) { | |
1016 | $err .= "Previous tests:\n"; | |
1017 | $err .= " $_\n" for sort keys %$tests; | |
1018 | $err .= "tests from '$file':\n"; | |
1019 | $err .= " $_\n" for sort keys %$read_tests; | |
1020 | } | |
1021 | else { | |
1022 | $err .= "Re-run with --verbose to see the differences.\n"; | |
1023 | } | |
1024 | die $err; | |
1025 | } | |
1026 | ||
1027 | if ("@$read_loop_counts" ne "@$loop_counts") { | |
1028 | die "Can't merge multiple read files: differing loop counts:\n" | |
1029 | . " (previous=(@$loop_counts), " | |
1030 | . "'$file'=(@$read_loop_counts))\n"; | |
ee172d48 YO |
1031 | } |
1032 | ||
9daf692f DM |
1033 | push @$perls, @{$read_perls}; |
1034 | foreach my $test (keys %{$read_results}) { | |
1035 | foreach my $label (keys %{$read_results->{$test}}) { | |
1036 | $results->{$test}{$label}= $read_results->{$test}{$label}; | |
ee172d48 YO |
1037 | } |
1038 | } | |
957d8930 | 1039 | } |
9e7973fa | 1040 | } |
4533e88f DM |
1041 | die "Error: --benchfile cannot be used when --read is present\n" |
1042 | if $done_read && defined $OPTS{benchfile}; | |
9e7973fa | 1043 | |
5db17e29 DM |
1044 | # Gather list of perls to benchmark: |
1045 | ||
7570f185 | 1046 | if (@$cmd_line_args) { |
f850a012 | 1047 | unless ($done_read) { |
4044748b YO |
1048 | # How many times to execute the loop for the two trials. The lower |
1049 | # value is intended to do the loop enough times that branch | |
1050 | # prediction has taken hold; the higher loop allows us to see the | |
1051 | # branch misses after that | |
1052 | $loop_counts = [10, 20]; | |
8fbd1c2c | 1053 | |
4533e88f DM |
1054 | ($tests, $order) = |
1055 | read_tests_file($OPTS{benchfile} // 't/perf/benchmarks'); | |
4044748b | 1056 | } |
8fbd1c2c | 1057 | |
7570f185 | 1058 | @run_perls = process_executables_list($perls, @$cmd_line_args); |
4044748b | 1059 | push @$perls, @run_perls; |
9e7973fa DM |
1060 | } |
1061 | ||
244df321 DM |
1062 | # strip @$order to just the actual tests present |
1063 | $order = [ grep exists $tests->{$_}, @$order ]; | |
1064 | ||
5db17e29 DM |
1065 | # Now we know what perls and tests we have, do extra option processing |
1066 | # and checking (done before grinding, so time isn't wasted if we die). | |
1067 | ||
5825b6d4 YO |
1068 | if (!$perls or !@$perls) { |
1069 | die "Error: nothing to do: no perls to run, no data to read.\n"; | |
1070 | } | |
5db17e29 DM |
1071 | if (@$perls < 2 and $OPTS{show} and !$OPTS{raw}) { |
1072 | die "Error: need at least 2 perls for comparison.\n" | |
1073 | } | |
1074 | ||
1075 | if ($OPTS{bisect}) { | |
1076 | die "Error: exactly one perl executable must be specified for bisect\n" | |
1077 | unless @$perls == 1; | |
1078 | die "Error: only a single test may be specified with --bisect\n" | |
1079 | unless keys %$tests == 1; | |
1080 | } | |
8fbd1c2c DM |
1081 | |
1082 | $OPTS{norm} = select_a_perl($OPTS{norm}, $perls, "--norm"); | |
5db17e29 | 1083 | |
8fbd1c2c DM |
1084 | if (defined $OPTS{'sort-perl'}) { |
1085 | $OPTS{'sort-perl'} = | |
1086 | select_a_perl($OPTS{'sort-perl'}, $perls, "--sort"); | |
1087 | } | |
1088 | ||
df3d7b3a DM |
1089 | if (defined $OPTS{'compact'}) { |
1090 | $OPTS{'compact'} = | |
1091 | select_a_perl($OPTS{'compact'}, $perls, "--compact"); | |
1092 | } | |
5db17e29 DM |
1093 | |
1094 | ||
1095 | # Run the benchmarks; accumulate with any previously read # results. | |
1096 | ||
1097 | if (@run_perls) { | |
1098 | $results = grind_run($tests, $order, \@run_perls, $loop_counts, $results); | |
1099 | } | |
1100 | ||
1101 | ||
1102 | # Handle the 3 forms of output | |
1103 | ||
9e7973fa DM |
1104 | if (defined $OPTS{write}) { |
1105 | my $json = JSON::PP::encode_json({ | |
1106 | version => $FORMAT_VERSION, | |
1107 | loop_counts => $loop_counts, | |
1108 | perls => $perls, | |
1109 | results => $results, | |
1110 | tests => $tests, | |
957d8930 | 1111 | order => $order, |
9e7973fa DM |
1112 | }); |
1113 | ||
1114 | open my $out, '>:encoding(UTF-8)', $OPTS{write} | |
5825b6d4 | 1115 | or die "Error: can't open '$OPTS{write}' for writing: $!\n"; |
9e7973fa DM |
1116 | print $out $json or die "Error: writing to file '$OPTS{write}': $!\n"; |
1117 | close $out or die "Error: closing file '$OPTS{write}': $!\n"; | |
1118 | } | |
5db17e29 DM |
1119 | |
1120 | if ($OPTS{show} or $OPTS{bisect}) { | |
1121 | # numerically process the raw data | |
1122 | ($processed, $averages) = | |
9e7973fa | 1123 | grind_process($results, $perls, $loop_counts); |
5db17e29 | 1124 | } |
9e7973fa | 1125 | |
5db17e29 DM |
1126 | if ($OPTS{show}) { |
1127 | if (defined $OPTS{compact}) { | |
df3d7b3a DM |
1128 | grind_print_compact($processed, $averages, $OPTS{compact}, |
1129 | $perls, $tests, $order); | |
1130 | } | |
9e7973fa | 1131 | else { |
957d8930 | 1132 | grind_print($processed, $averages, $perls, $tests, $order); |
9e7973fa DM |
1133 | } |
1134 | } | |
5db17e29 DM |
1135 | |
1136 | if ($OPTS{bisect}) { | |
1137c9fa | 1137 | # these panics shouldn't happen if the bisect checks above are sound |
5db17e29 DM |
1138 | my @r = values %$results; |
1139 | die "Panic: expected exactly one test result in bisect\n" | |
1140 | if @r != 1; | |
1141 | @r = values %{$r[0]}; | |
1142 | die "Panic: expected exactly one perl result in bisect\n" | |
1143 | if @r != 1; | |
1144 | my $c = $r[0]{$bisect_field}; | |
1145 | die "Panic: no result in bisect for field '$bisect_field'\n" | |
1146 | unless defined $c; | |
1147 | ||
a387d7f0 DM |
1148 | print "Bisect: $bisect_field had the value $c\n"; |
1149 | ||
5db17e29 DM |
1150 | exit 0 if $bisect_min <= $c and $c <= $bisect_max; |
1151 | exit 1; | |
1152 | } | |
9e7973fa DM |
1153 | } |
1154 | ||
1155 | ||
1156 | # Run cachegrind for every test/perl combo. | |
1157 | # It may run several processes in parallel when -j is specified. | |
1158 | # Return a hash ref suitable for input to grind_process() | |
1159 | ||
1160 | sub grind_run { | |
4044748b | 1161 | my ($tests, $order, $perls, $counts, $results) = @_; |
9e7973fa DM |
1162 | |
1163 | # Build a list of all the jobs to run | |
1164 | ||
1165 | my @jobs; | |
1166 | ||
957d8930 | 1167 | for my $test (grep $tests->{$_}, @$order) { |
9e7973fa DM |
1168 | |
1169 | # Create two test progs: one with an empty loop and one with code. | |
9e7973fa | 1170 | my @prog = ( |
485eb009 DM |
1171 | make_perl_prog($test, $tests->{$test}, 0), |
1172 | make_perl_prog($test, $tests->{$test}, 1), | |
9e7973fa DM |
1173 | ); |
1174 | ||
1175 | for my $p (@$perls) { | |
99b1e78b | 1176 | my ($perl, $label, $env, $args) = @$p; |
9e7973fa DM |
1177 | |
1178 | # Run both the empty loop and the active loop | |
1179 | # $counts->[0] and $counts->[1] times. | |
1180 | ||
1181 | for my $i (0,1) { | |
1182 | for my $j (0,1) { | |
60858fe8 JC |
1183 | my $envstr = ''; |
1184 | if (ref $env) { | |
1185 | $envstr .= "$_=$env->{$_} " for sort keys %$env; | |
1186 | } | |
1187 | my $cmd = "PERL_HASH_SEED=0 $envstr" | |
9e7973fa DM |
1188 | . "valgrind --tool=cachegrind --branch-sim=yes " |
1189 | . "--cachegrind-out-file=/dev/null " | |
1190 | . "$OPTS{grindargs} " | |
99b1e78b | 1191 | . "$perl $OPTS{perlargs} $args - $counts->[$j] 2>&1"; |
9e7973fa | 1192 | # for debugging and error messages |
c385646f | 1193 | my $id = "$test/$label " |
9e7973fa DM |
1194 | . ($i ? "active" : "empty") . "/" |
1195 | . ($j ? "long" : "short") . " loop"; | |
1196 | ||
1197 | push @jobs, { | |
1198 | test => $test, | |
1199 | perl => $perl, | |
1200 | plabel => $label, | |
1201 | cmd => $cmd, | |
1202 | prog => $prog[$i], | |
1203 | active => $i, | |
1204 | loopix => $j, | |
1205 | id => $id, | |
1206 | }; | |
1207 | } | |
1208 | } | |
1209 | } | |
1210 | } | |
1211 | ||
1212 | # Execute each cachegrind and store the results in %results. | |
1213 | ||
1214 | local $SIG{PIPE} = 'IGNORE'; | |
1215 | ||
1216 | my $max_jobs = $OPTS{jobs}; | |
1217 | my $running = 0; # count of executing jobs | |
1218 | my %pids; # map pids to jobs | |
1219 | my %fds; # map fds to jobs | |
9e7973fa DM |
1220 | my $select = IO::Select->new(); |
1221 | ||
4ba2dce5 PE |
1222 | my $njobs = scalar @jobs; |
1223 | my $donejobs = 0; | |
1224 | ||
9e7973fa DM |
1225 | while (@jobs or $running) { |
1226 | ||
1227 | if ($OPTS{debug}) { | |
1228 | printf "Main loop: pending=%d running=%d\n", | |
1229 | scalar(@jobs), $running; | |
1230 | } | |
1231 | ||
1232 | # Start new jobs | |
1233 | ||
1234 | while (@jobs && $running < $max_jobs) { | |
1235 | my $job = shift @jobs; | |
1236 | my ($id, $cmd) =@$job{qw(id cmd)}; | |
1237 | ||
1238 | my ($in, $out, $pid); | |
4ba2dce5 PE |
1239 | $donejobs++; |
1240 | warn sprintf "Starting %s (%d of %d, %.2f%%)\n", | |
1241 | $id, $donejobs, $njobs, 100 * $donejobs / $njobs if $OPTS{verbose}; | |
9e7973fa DM |
1242 | eval { $pid = IPC::Open2::open2($out, $in, $cmd); 1; } |
1243 | or die "Error: while starting cachegrind subprocess" | |
1244 | ." for $id:\n$@"; | |
1245 | $running++; | |
1246 | $pids{$pid} = $job; | |
1247 | $fds{"$out"} = $job; | |
1248 | $job->{out_fd} = $out; | |
1249 | $job->{output} = ''; | |
1250 | $job->{pid} = $pid; | |
1251 | ||
1252 | $out->blocking(0); | |
1253 | $select->add($out); | |
1254 | ||
1255 | if ($OPTS{debug}) { | |
1256 | print "Started pid $pid for $id\n"; | |
1257 | } | |
1258 | ||
1259 | # Note: | |
1260 | # In principle we should write to $in in the main select loop, | |
1261 | # since it may block. In reality, | |
1262 | # a) the code we write to the perl process's stdin is likely | |
1263 | # to be less than the OS's pipe buffer size; | |
1264 | # b) by the time the perl process has read in all its stdin, | |
1265 | # the only output it should have generated is a few lines | |
1266 | # of cachegrind output preamble. | |
1267 | # If these assumptions change, then perform the following print | |
1268 | # in the select loop instead. | |
1269 | ||
1270 | print $in $job->{prog}; | |
1271 | close $in; | |
1272 | } | |
1273 | ||
1274 | # Get output of running jobs | |
1275 | ||
1276 | if ($OPTS{debug}) { | |
1277 | printf "Select: waiting on (%s)\n", | |
1278 | join ', ', sort { $a <=> $b } map $fds{$_}{pid}, | |
1279 | $select->handles; | |
1280 | } | |
1281 | ||
1282 | my @ready = $select->can_read; | |
1283 | ||
1284 | if ($OPTS{debug}) { | |
1285 | printf "Select: pids (%s) ready\n", | |
1286 | join ', ', sort { $a <=> $b } map $fds{$_}{pid}, @ready; | |
1287 | } | |
1288 | ||
1289 | unless (@ready) { | |
1290 | die "Panic: select returned no file handles\n"; | |
1291 | } | |
1292 | ||
1293 | for my $fd (@ready) { | |
1294 | my $j = $fds{"$fd"}; | |
1295 | my $r = sysread $fd, $j->{output}, 8192, length($j->{output}); | |
1296 | unless (defined $r) { | |
1297 | die "Panic: Read from process running $j->{id} gave:\n$!"; | |
1298 | } | |
1299 | next if $r; | |
1300 | ||
1301 | # EOF | |
1302 | ||
1303 | if ($OPTS{debug}) { | |
1304 | print "Got eof for pid $fds{$fd}{pid} ($j->{id})\n"; | |
1305 | } | |
1306 | ||
1307 | $select->remove($j->{out_fd}); | |
1308 | close($j->{out_fd}) | |
1309 | or die "Panic: closing output fh on $j->{id} gave:\n$!\n"; | |
1310 | $running--; | |
1311 | delete $fds{"$j->{out_fd}"}; | |
1312 | my $output = $j->{output}; | |
1313 | ||
1314 | if ($OPTS{debug}) { | |
1315 | my $p = $j->{prog}; | |
1316 | $p =~ s/^/ : /mg; | |
1317 | my $o = $output; | |
1318 | $o =~ s/^/ : /mg; | |
1319 | ||
1320 | print "\n$j->{id}/\nCommand: $j->{cmd}\n" | |
1321 | . "Input:\n$p" | |
1322 | . "Output\n$o"; | |
1323 | } | |
1324 | ||
4044748b | 1325 | $results->{$j->{test}}{$j->{plabel}}[$j->{active}][$j->{loopix}] |
9e7973fa DM |
1326 | = parse_cachegrind($output, $j->{id}, $j->{perl}); |
1327 | } | |
1328 | ||
1329 | # Reap finished jobs | |
1330 | ||
1331 | while (1) { | |
1332 | my $kid = waitpid(-1, WNOHANG); | |
1333 | my $ret = $?; | |
1334 | last if $kid <= 0; | |
1335 | ||
1336 | unless (exists $pids{$kid}) { | |
1337 | die "Panic: reaped unexpected child $kid"; | |
1338 | } | |
1339 | my $j = $pids{$kid}; | |
1340 | if ($ret) { | |
1341 | die sprintf("Error: $j->{id} gave return status 0x%04x\n", $ret) | |
1342 | . "with the following output\n:$j->{output}\n"; | |
1343 | } | |
1344 | delete $pids{$kid}; | |
1345 | } | |
1346 | } | |
1347 | ||
4044748b | 1348 | return $results; |
9e7973fa DM |
1349 | } |
1350 | ||
1351 | ||
1352 | ||
1353 | ||
1354 | # grind_process(): process the data that has been extracted from | |
1355 | # cachgegrind's output. | |
1356 | # | |
8b6302e0 | 1357 | # $res is of the form ->{benchmark_name}{perl_label}[active][count]{field_name}, |
9e7973fa DM |
1358 | # where active is 0 or 1 indicating an empty or active loop, |
1359 | # count is 0 or 1 indicating a short or long loop. E.g. | |
1360 | # | |
1361 | # $res->{'expr::assign::scalar_lex'}{perl-5.21.1}[0][10]{Dw_mm} | |
1362 | # | |
1363 | # The $res data structure is modified in-place by this sub. | |
1364 | # | |
1365 | # $perls is [ [ perl-exe, perl-label], .... ]. | |
1366 | # | |
1367 | # $counts is [ N, M ] indicating the counts for the short and long loops. | |
1368 | # | |
1369 | # | |
1370 | # return \%output, \%averages, where | |
1371 | # | |
8b6302e0 DM |
1372 | # $output{benchmark_name}{perl_label}{field_name} = N |
1373 | # $averages{perl_label}{field_name} = M | |
9e7973fa DM |
1374 | # |
1375 | # where N is the raw count ($OPTS{raw}), or count_perl0/count_perlI otherwise; | |
1376 | # M is the average raw count over all tests ($OPTS{raw}), or | |
1377 | # 1/(sum(count_perlI/count_perl0)/num_tests) otherwise. | |
1378 | ||
1379 | sub grind_process { | |
1380 | my ($res, $perls, $counts) = @_; | |
1381 | ||
1382 | # Process the four results for each test/perf combo: | |
1383 | # Convert | |
8b6302e0 | 1384 | # $res->{benchmark_name}{perl_label}[active][count]{field_name} = n |
9e7973fa | 1385 | # to |
8b6302e0 | 1386 | # $res->{benchmark_name}{perl_label}{field_name} = averaged_n |
9e7973fa DM |
1387 | # |
1388 | # $r[0][1] - $r[0][0] is the time to do ($counts->[1]-$counts->[0]) | |
1389 | # empty loops, eliminating startup time | |
1390 | # $r[1][1] - $r[1][0] is the time to do ($counts->[1]-$counts->[0]) | |
1391 | # active loops, eliminating startup time | |
1392 | # (the two startup times may be different because different code | |
1393 | # is being compiled); the difference of the two results above | |
1394 | # divided by the count difference is the time to execute the | |
1395 | # active code once, eliminating both startup and loop overhead. | |
1396 | ||
1397 | for my $tests (values %$res) { | |
1398 | for my $r (values %$tests) { | |
1399 | my $r2; | |
1400 | for (keys %{$r->[0][0]}) { | |
1401 | my $n = ( ($r->[1][1]{$_} - $r->[1][0]{$_}) | |
1402 | - ($r->[0][1]{$_} - $r->[0][0]{$_}) | |
1403 | ) / ($counts->[1] - $counts->[0]); | |
1404 | $r2->{$_} = $n; | |
1405 | } | |
1406 | $r = $r2; | |
1407 | } | |
1408 | } | |
1409 | ||
1410 | my %totals; | |
1411 | my %counts; | |
1412 | my %data; | |
1413 | ||
1a961f9f | 1414 | my $perl_norm = $perls->[$OPTS{norm}][1]; # the label of the reference perl |
9e7973fa DM |
1415 | |
1416 | for my $test_name (keys %$res) { | |
1417 | my $res1 = $res->{$test_name}; | |
1418 | my $res2_norm = $res1->{$perl_norm}; | |
1419 | for my $perl (keys %$res1) { | |
1420 | my $res2 = $res1->{$perl}; | |
1421 | for my $field (keys %$res2) { | |
1422 | my ($p, $q) = ($res2_norm->{$field}, $res2->{$field}); | |
1423 | ||
1424 | if ($OPTS{raw}) { | |
1425 | # Avoid annoying '-0.0' displays. Ideally this number | |
1426 | # should never be negative, but fluctuations in | |
1427 | # startup etc can theoretically make this happen | |
1428 | $q = 0 if ($q <= 0 && $q > -0.1); | |
1429 | $totals{$perl}{$field} += $q; | |
1430 | $counts{$perl}{$field}++; | |
1431 | $data{$test_name}{$perl}{$field} = $q; | |
1432 | next; | |
1433 | } | |
1434 | ||
1435 | # $p and $q are notionally integer counts, but | |
1436 | # due to variations in startup etc, it's possible for a | |
1437 | # count which is supposedly zero to be calculated as a | |
1438 | # small positive or negative value. | |
1439 | # In this case, set it to zero. Further below we | |
1440 | # special-case zeros to avoid division by zero errors etc. | |
1441 | ||
1442 | $p = 0.0 if $p < 0.01; | |
1443 | $q = 0.0 if $q < 0.01; | |
1444 | ||
1445 | if ($p == 0.0 && $q == 0.0) { | |
1446 | # Both perls gave a count of zero, so no change: | |
1447 | # treat as 100% | |
1448 | $totals{$perl}{$field} += 1; | |
1449 | $counts{$perl}{$field}++; | |
1450 | $data{$test_name}{$perl}{$field} = 1; | |
1451 | } | |
1452 | elsif ($p == 0.0 || $q == 0.0) { | |
1453 | # If either count is zero, there were too few events | |
1454 | # to give a meaningful ratio (and we will end up with | |
1455 | # division by zero if we try). Mark the result undef, | |
1456 | # indicating that it shouldn't be displayed; and skip | |
1457 | # adding to the average | |
1458 | $data{$test_name}{$perl}{$field} = undef; | |
1459 | } | |
1460 | else { | |
1461 | # For averages, we record q/p rather than p/q. | |
1462 | # Consider a test where perl_norm took 1000 cycles | |
1463 | # and perlN took 800 cycles. For the individual | |
1464 | # results we display p/q, or 1.25; i.e. a quarter | |
1465 | # quicker. For the averages, we instead sum all | |
1466 | # the 0.8's, which gives the total cycles required to | |
1467 | # execute all tests, with all tests given equal | |
1468 | # weight. Later we reciprocate the final result, | |
1469 | # i.e. 1/(sum(qi/pi)/n) | |
1470 | ||
1471 | $totals{$perl}{$field} += $q/$p; | |
1472 | $counts{$perl}{$field}++; | |
1473 | $data{$test_name}{$perl}{$field} = $p/$q; | |
1474 | } | |
1475 | } | |
1476 | } | |
1477 | } | |
1478 | ||
1479 | # Calculate averages based on %totals and %counts accumulated earlier. | |
1480 | ||
1481 | my %averages; | |
1482 | for my $perl (keys %totals) { | |
1483 | my $t = $totals{$perl}; | |
1484 | for my $field (keys %$t) { | |
1485 | $averages{$perl}{$field} = $OPTS{raw} | |
1486 | ? $t->{$field} / $counts{$perl}{$field} | |
1487 | # reciprocal - see comments above | |
1488 | : $counts{$perl}{$field} / $t->{$field}; | |
1489 | } | |
1490 | } | |
1491 | ||
1492 | return \%data, \%averages; | |
1493 | } | |
1494 | ||
1495 | ||
9e7973fa | 1496 | |
df3d7b3a | 1497 | # print a standard blurb at the start of the grind display |
9e7973fa | 1498 | |
df3d7b3a DM |
1499 | sub grind_blurb { |
1500 | my ($perls) = @_; | |
9e7973fa DM |
1501 | |
1502 | print <<EOF; | |
1503 | Key: | |
1504 | Ir Instruction read | |
1505 | Dr Data read | |
1506 | Dw Data write | |
1507 | COND conditional branches | |
1508 | IND indirect branches | |
1509 | _m branch predict miss | |
1510 | _m1 level 1 cache miss | |
1511 | _mm last cache (e.g. L3) miss | |
1512 | - indeterminate percentage (e.g. 1/0) | |
1513 | ||
1514 | EOF | |
1515 | ||
1516 | if ($OPTS{raw}) { | |
1517 | print "The numbers represent raw counts per loop iteration.\n"; | |
1518 | } | |
1519 | else { | |
1520 | print <<EOF; | |
1521 | The numbers represent relative counts per loop iteration, compared to | |
df3d7b3a | 1522 | $perls->[$OPTS{norm}][1] at 100.0%. |
9e7973fa DM |
1523 | Higher is better: for example, using half as many instructions gives 200%, |
1524 | while using twice as many gives 50%. | |
1525 | EOF | |
1526 | } | |
df3d7b3a DM |
1527 | } |
1528 | ||
1529 | ||
1530 | # return a sorted list of the test names, plus 'AVERAGE' | |
9e7973fa | 1531 | |
df3d7b3a DM |
1532 | sub sorted_test_names { |
1533 | my ($results, $order, $perls) = @_; | |
9e7973fa | 1534 | |
df3d7b3a | 1535 | my @names; |
9e7973fa DM |
1536 | unless ($OPTS{average}) { |
1537 | if (defined $OPTS{'sort-field'}) { | |
1538 | my ($field, $perlix) = @OPTS{'sort-field', 'sort-perl'}; | |
beb8db25 | 1539 | my $perl = $perls->[$perlix][1]; |
df3d7b3a | 1540 | @names = sort |
9e7973fa DM |
1541 | { |
1542 | $results->{$a}{$perl}{$field} | |
1543 | <=> $results->{$b}{$perl}{$field} | |
1544 | } | |
1545 | keys %$results; | |
1546 | } | |
1547 | else { | |
df3d7b3a | 1548 | @names = grep $results->{$_}, @$order; |
9e7973fa DM |
1549 | } |
1550 | } | |
1551 | ||
1552 | # No point in displaying average for only one test. | |
df3d7b3a DM |
1553 | push @names, 'AVERAGE' unless @names == 1; |
1554 | @names; | |
1555 | } | |
1556 | ||
1557 | ||
8f25a3c4 DM |
1558 | # format one cell data item |
1559 | ||
1560 | sub grind_format_cell { | |
1561 | my ($val, $width) = @_; | |
31952d39 | 1562 | my $s; |
8f25a3c4 | 1563 | if (!defined $val) { |
31952d39 | 1564 | return sprintf "%*s", $width, '-'; |
8f25a3c4 | 1565 | } |
8924d398 DM |
1566 | elsif (abs($val) >= 1_000_000) { |
1567 | # avoid displaying very large numbers (which might be the | |
1568 | # result of e.g. 1 / 0.000001) | |
1569 | return sprintf "%*s", $width, 'Inf'; | |
1570 | } | |
8f25a3c4 | 1571 | elsif ($OPTS{raw}) { |
31952d39 | 1572 | return sprintf "%*.1f", $width, $val; |
8f25a3c4 DM |
1573 | } |
1574 | else { | |
31952d39 | 1575 | return sprintf "%*.2f", $width, $val * 100; |
8f25a3c4 DM |
1576 | } |
1577 | } | |
1578 | ||
df3d7b3a DM |
1579 | # grind_print(): display the tabulated results of all the cachegrinds. |
1580 | # | |
1581 | # Arguments are of the form: | |
8b6302e0 DM |
1582 | # $results->{benchmark_name}{perl_label}{field_name} = N |
1583 | # $averages->{perl_label}{field_name} = M | |
df3d7b3a DM |
1584 | # $perls = [ [ perl-exe, perl-label ], ... ] |
1585 | # $tests->{test_name}{desc => ..., ...} | |
31952d39 | 1586 | # $order = [ 'foo::bar1', ... ] # order to display tests |
df3d7b3a DM |
1587 | |
1588 | sub grind_print { | |
1589 | my ($results, $averages, $perls, $tests, $order) = @_; | |
1590 | ||
1591 | my @perl_names = map $_->[0], @$perls; | |
1a961f9f | 1592 | my @perl_labels = map $_->[1], @$perls; |
df3d7b3a DM |
1593 | my %perl_labels; |
1594 | $perl_labels{$_->[0]} = $_->[1] for @$perls; | |
1595 | ||
df3d7b3a DM |
1596 | # Print standard header. |
1597 | grind_blurb($perls); | |
1598 | ||
1599 | my @test_names = sorted_test_names($results, $order, $perls); | |
9e7973fa | 1600 | |
31952d39 DM |
1601 | my @fields = qw(Ir Dr Dw COND IND |
1602 | COND_m IND_m | |
1603 | Ir_m1 Dr_m1 Dw_m1 | |
1604 | Ir_mm Dr_mm Dw_mm | |
1605 | ); | |
1606 | ||
1607 | if ($OPTS{fields}) { | |
1608 | @fields = grep exists $OPTS{fields}{$_}, @fields; | |
1609 | } | |
1610 | ||
9e7973fa DM |
1611 | # If only a single field is to be displayed, use a more compact |
1612 | # format with only a single line of output per test. | |
1613 | ||
31952d39 | 1614 | my $one_field = @fields == 1; |
9e7973fa | 1615 | |
31952d39 DM |
1616 | # The width of column 0: this is either field names, or for |
1617 | # $one_field, test names | |
9e7973fa | 1618 | |
31952d39 DM |
1619 | my $width0 = 0; |
1620 | for ($one_field ? @test_names : @fields) { | |
1621 | $width0 = length if length > $width0; | |
1622 | } | |
9e7973fa | 1623 | |
31952d39 | 1624 | # Calculate the widths of the data columns |
9e7973fa | 1625 | |
31952d39 | 1626 | my @widths = map length, @perl_labels; |
9e7973fa | 1627 | |
31952d39 DM |
1628 | for my $test (@test_names) { |
1629 | my $res = ($test eq 'AVERAGE') ? $averages : $results->{$test}; | |
1630 | for my $field (@fields) { | |
1631 | for my $i (0..$#widths) { | |
1632 | my $l = length grind_format_cell( | |
1633 | $res->{$perl_labels[$i]}{$field}, 1); | |
1634 | $widths[$i] = $l if $l > $widths[$i]; | |
9e7973fa | 1635 | } |
9e7973fa DM |
1636 | } |
1637 | } | |
1638 | ||
31952d39 | 1639 | # Print the results for each test |
9e7973fa | 1640 | |
31952d39 DM |
1641 | for my $test (0..$#test_names) { |
1642 | my $test_name = $test_names[$test]; | |
9e7973fa | 1643 | my $doing_ave = ($test_name eq 'AVERAGE'); |
31952d39 DM |
1644 | my $res = $doing_ave ? $averages : $results->{$test_name}; |
1645 | ||
1646 | # print per-test header | |
9e7973fa | 1647 | |
31952d39 DM |
1648 | if ($one_field) { |
1649 | print "\nResults for field $fields[0]\n\n" if $test == 0; | |
1650 | } | |
1651 | else { | |
9e7973fa DM |
1652 | print "\n$test_name"; |
1653 | print "\n$tests->{$test_name}{desc}" unless $doing_ave; | |
1654 | print "\n\n"; | |
31952d39 | 1655 | } |
9e7973fa | 1656 | |
31952d39 DM |
1657 | # Print the perl executable names header. |
1658 | ||
1659 | if (!$one_field || $test == 0) { | |
9e7973fa | 1660 | for my $i (0,1) { |
31952d39 | 1661 | print " " x $width0; |
9e7973fa DM |
1662 | for (0..$#widths) { |
1663 | printf " %*s", $widths[$_], | |
31952d39 | 1664 | $i ? ('-' x$widths[$_]) : $perl_labels[$_]; |
9e7973fa DM |
1665 | } |
1666 | print "\n"; | |
1667 | } | |
1668 | } | |
1669 | ||
31952d39 DM |
1670 | my $field_suffix = ''; |
1671 | ||
1672 | # print a line of data | |
9e7973fa | 1673 | |
31952d39 | 1674 | for my $field (@fields) { |
91cde97c | 1675 | if ($one_field) { |
31952d39 | 1676 | printf "%-*s", $width0, $test_name; |
91cde97c DM |
1677 | } |
1678 | else { | |
31952d39 DM |
1679 | # If there are enough fields, print a blank line |
1680 | # between groups of fields that have the same suffix | |
1681 | if (@fields > 4) { | |
1682 | my $s = ''; | |
1683 | $s = $1 if $field =~ /(_\w+)$/; | |
1684 | print "\n" if $s ne $field_suffix; | |
1685 | $field_suffix = $s; | |
1686 | } | |
1687 | printf "%*s", $width0, $field; | |
91cde97c | 1688 | } |
9e7973fa DM |
1689 | |
1690 | for my $i (0..$#widths) { | |
31952d39 DM |
1691 | print " ", grind_format_cell($res->{$perl_labels[$i]}{$field}, |
1692 | $widths[$i]); | |
9e7973fa DM |
1693 | } |
1694 | print "\n"; | |
1695 | } | |
1696 | } | |
1697 | } | |
1698 | ||
1699 | ||
df3d7b3a DM |
1700 | |
1701 | # grind_print_compact(): like grind_print(), but display a single perl | |
1702 | # in a compact form. Has an additional arg, $which_perl, which specifies | |
1703 | # which perl to display. | |
1704 | # | |
1705 | # Arguments are of the form: | |
8b6302e0 DM |
1706 | # $results->{benchmark_name}{perl_label}{field_name} = N |
1707 | # $averages->{perl_label}{field_name} = M | |
df3d7b3a DM |
1708 | # $perls = [ [ perl-exe, perl-label ], ... ] |
1709 | # $tests->{test_name}{desc => ..., ...} | |
31952d39 | 1710 | # $order = [ 'foo::bar1', ... ] # order to display tests |
df3d7b3a DM |
1711 | |
1712 | sub grind_print_compact { | |
1713 | my ($results, $averages, $which_perl, $perls, $tests, $order) = @_; | |
1714 | ||
df3d7b3a DM |
1715 | # Print standard header. |
1716 | grind_blurb($perls); | |
1717 | ||
1718 | print "\nResults for $perls->[$which_perl][1]\n\n"; | |
1719 | ||
1720 | my @test_names = sorted_test_names($results, $order, $perls); | |
1721 | ||
1722 | # Dump the results for each test. | |
1723 | ||
1724 | my @fields = qw( Ir Dr Dw | |
1725 | COND IND | |
1726 | COND_m IND_m | |
1727 | Ir_m1 Dr_m1 Dw_m1 | |
1728 | Ir_mm Dr_mm Dw_mm | |
1729 | ); | |
1730 | if ($OPTS{fields}) { | |
1731 | @fields = grep exists $OPTS{fields}{$_}, @fields; | |
1732 | } | |
1733 | ||
a3815e44 | 1734 | # calculate the max width of the test names |
df3d7b3a | 1735 | |
d00aa1f4 DM |
1736 | my $name_width = 0; |
1737 | for (@test_names) { | |
1738 | $name_width = length if length > $name_width; | |
1739 | } | |
1740 | ||
31952d39 DM |
1741 | # Calculate the widths of the data columns |
1742 | ||
1743 | my @widths = map length, @fields; | |
1744 | ||
1745 | for my $test (@test_names) { | |
1746 | my $res = ($test eq 'AVERAGE') ? $averages : $results->{$test}; | |
1747 | $res = $res->{$perls->[$which_perl][1]}; | |
1748 | for my $i (0..$#fields) { | |
1749 | my $l = length grind_format_cell($res->{$fields[$i]}, 1); | |
1750 | $widths[$i] = $l if $l > $widths[$i]; | |
1751 | } | |
1752 | } | |
1753 | ||
1754 | # Print header | |
1755 | ||
1756 | printf " %*s", $widths[$_], $fields[$_] for 0..$#fields; | |
1757 | print "\n"; | |
1758 | printf " %*s", $_, ('-' x $_) for @widths; | |
1759 | print "\n"; | |
1760 | ||
1761 | # Print the results for each test | |
1762 | ||
df3d7b3a DM |
1763 | for my $test_name (@test_names) { |
1764 | my $doing_ave = ($test_name eq 'AVERAGE'); | |
1765 | my $res = $doing_ave ? $averages : $results->{$test_name}; | |
beb8db25 | 1766 | $res = $res->{$perls->[$which_perl][1]}; |
d00aa1f4 DM |
1767 | my $desc = $doing_ave |
1768 | ? $test_name | |
1769 | : sprintf "%-*s %s", $name_width, $test_name, | |
1770 | $tests->{$test_name}{desc}; | |
df3d7b3a | 1771 | |
31952d39 DM |
1772 | for my $i (0..$#fields) { |
1773 | print " ", grind_format_cell($res->{$fields[$i]}, $widths[$i]); | |
1774 | } | |
d00aa1f4 | 1775 | print " $desc\n"; |
df3d7b3a DM |
1776 | } |
1777 | } | |
1778 | ||
1779 | ||
9e7973fa DM |
1780 | # do_selftest(): check that we can parse known cachegrind() |
1781 | # output formats. If the output of cachegrind changes, add a *new* | |
1782 | # test here; keep the old tests to make sure we continue to parse | |
1783 | # old cachegrinds | |
1784 | ||
1785 | sub do_selftest { | |
1786 | ||
1787 | my @tests = ( | |
1788 | 'standard', | |
1789 | <<'EOF', | |
1790 | ==32350== Cachegrind, a cache and branch-prediction profiler | |
1791 | ==32350== Copyright (C) 2002-2013, and GNU GPL'd, by Nicholas Nethercote et al. | |
1792 | ==32350== Using Valgrind-3.9.0 and LibVEX; rerun with -h for copyright info | |
1793 | ==32350== Command: perl5211o /tmp/uiS2gjdqe5 1 | |
1794 | ==32350== | |
1795 | --32350-- warning: L3 cache found, using its data for the LL simulation. | |
1796 | ==32350== | |
1797 | ==32350== I refs: 1,124,055 | |
1798 | ==32350== I1 misses: 5,573 | |
1799 | ==32350== LLi misses: 3,338 | |
1800 | ==32350== I1 miss rate: 0.49% | |
1801 | ==32350== LLi miss rate: 0.29% | |
1802 | ==32350== | |
1803 | ==32350== D refs: 404,275 (259,191 rd + 145,084 wr) | |
1804 | ==32350== D1 misses: 9,608 ( 6,098 rd + 3,510 wr) | |
1805 | ==32350== LLd misses: 5,794 ( 2,781 rd + 3,013 wr) | |
1806 | ==32350== D1 miss rate: 2.3% ( 2.3% + 2.4% ) | |
1807 | ==32350== LLd miss rate: 1.4% ( 1.0% + 2.0% ) | |
1808 | ==32350== | |
1809 | ==32350== LL refs: 15,181 ( 11,671 rd + 3,510 wr) | |
1810 | ==32350== LL misses: 9,132 ( 6,119 rd + 3,013 wr) | |
1811 | ==32350== LL miss rate: 0.5% ( 0.4% + 2.0% ) | |
1812 | ==32350== | |
1813 | ==32350== Branches: 202,372 (197,050 cond + 5,322 ind) | |
1814 | ==32350== Mispredicts: 19,153 ( 17,742 cond + 1,411 ind) | |
1815 | ==32350== Mispred rate: 9.4% ( 9.0% + 26.5% ) | |
1816 | EOF | |
1817 | { | |
1818 | COND => 197050, | |
1819 | COND_m => 17742, | |
1820 | Dr => 259191, | |
1821 | Dr_m1 => 6098, | |
1822 | Dr_mm => 2781, | |
1823 | Dw => 145084, | |
1824 | Dw_m1 => 3510, | |
1825 | Dw_mm => 3013, | |
1826 | IND => 5322, | |
1827 | IND_m => 1411, | |
1828 | Ir => 1124055, | |
1829 | Ir_m1 => 5573, | |
1830 | Ir_mm => 3338, | |
1831 | }, | |
1832 | ); | |
1833 | ||
5051ccfe DM |
1834 | for ('./t', '.') { |
1835 | my $t = "$_/test.pl"; | |
1836 | next unless -f $t; | |
1837 | require $t; | |
9e7973fa DM |
1838 | } |
1839 | plan(@tests / 3 * keys %VALID_FIELDS); | |
1840 | ||
1841 | while (@tests) { | |
1842 | my $desc = shift @tests; | |
1843 | my $output = shift @tests; | |
1844 | my $expected = shift @tests; | |
1845 | my $p = parse_cachegrind($output); | |
1846 | for (sort keys %VALID_FIELDS) { | |
1847 | is($p->{$_}, $expected->{$_}, "$desc, $_"); | |
1848 | } | |
1849 | } | |
1850 | } |