Commit | Line | Data |
---|---|---|
0e74ff8e JH |
1 | #!./perl -w |
2 | ||
3 | BEGIN { | |
4 | chdir 't' if -d 't'; | |
53aa2791 | 5 | @INC = ('../lib'); |
0e74ff8e JH |
6 | } |
7 | ||
8 | use warnings; | |
9 | use strict; | |
cc01160e | 10 | our ($foo, $bar, $baz, $ballast); |
70cbce25 | 11 | use Test::More; |
0e74ff8e JH |
12 | |
13 | use Benchmark qw(:all); | |
14 | ||
8a753380 | 15 | my $DELTA = 0.4; |
0e74ff8e JH |
16 | |
17 | # Some timing ballast | |
18 | sub fib { | |
19 | my $n = shift; | |
20 | return $n if $n < 2; | |
21 | fib($n-1) + fib($n-2); | |
22 | } | |
23 | $ballast = 15; | |
24 | ||
53aa2791 | 25 | my $All_Pattern = |
0e74ff8e | 26 | qr/(\d+) +wallclock secs? +\( *(-?\d+\.\d\d) +usr +(-?\d+\.\d\d) +sys +\+ +(-?\d+\.\d\d) +cusr +(-?\d+\.\d\d) +csys += +(-?\d+\.\d\d) +CPU\)/; |
53aa2791 | 27 | my $Noc_Pattern = |
0e74ff8e | 28 | qr/(\d+) +wallclock secs? +\( *(-?\d+\.\d\d) +usr +\+ +(-?\d+\.\d\d) +sys += +(-?\d+\.\d\d) +CPU\)/; |
53aa2791 | 29 | my $Nop_Pattern = |
0e74ff8e | 30 | qr/(\d+) +wallclock secs? +\( *(-?\d+\.\d\d) +cusr +\+ +(-?\d+\.\d\d) +csys += +\d+\.\d\d +CPU\)/; |
98dc9551 | 31 | # Please don't trust the matching parentheses to be useful in this :-) |
53aa2791 | 32 | my $Default_Pattern = qr/$All_Pattern|$Noc_Pattern/; |
0e74ff8e | 33 | |
8a753380 DM |
34 | # see if the ratio of two integer values is within (1+$delta) |
35 | ||
36 | sub cmp_delta { | |
37 | my ($min, $max, $delta) = @_; | |
38 | ($min, $max) = ($max, $min) if $max < $min; | |
39 | return 0 if $min < 1; # avoid / 0 | |
40 | return $max/$min <= (1+$delta); | |
41 | } | |
42 | ||
f86e19f1 YO |
43 | sub splatter { |
44 | my ($message) = @_; | |
45 | my $splatter = <<~'EOF_SPLATTER'; | |
46 | Please file a ticket to report this. Our bug tracker can be found at | |
47 | ||
48 | https://github.com/Perl/perl5/issues | |
49 | ||
50 | Make sure you include the full output of perl -V, also uname -a, | |
51 | and the version details for the C compiler you are using are | |
52 | very helpful. | |
53 | ||
54 | Please also try compiling and running the C program that can | |
55 | be found at | |
56 | ||
57 | https://github.com/Perl/perl5/issues/20839#issuecomment-1439286875 | |
58 | ||
59 | and provide the results (or compile errors) as part of your | |
60 | bug report. | |
61 | ||
62 | EOF_SPLATTER | |
63 | ||
64 | if ( $message =~ s/\.\.\.//) { | |
65 | $splatter =~ s/Please/please/; | |
66 | } | |
67 | die $message, $splatter; | |
68 | } | |
69 | ||
70 | { | |
71 | # Benchmark may end up "looping forever" if time() or times() are | |
72 | # broken such that they do not return different values over time. | |
73 | # The following crude test is intended to ensure that we can rely | |
74 | # on them and be confident that we won't infinite loop in the | |
75 | # following tests. | |
76 | # | |
77 | # You can simulate a broken time or times() function by setting | |
78 | # the appropriate env var to a true value: | |
79 | # | |
80 | # time() -> SIMULATE_BROKEN_TIME_FUNCTION | |
81 | # times() -> SIMULATE_BROKEN_TIMES_FUNCTION | |
82 | # | |
83 | # If you have a very fast box you may need to set the FAST_CPU env | |
84 | # var to a number larger than 1 to require these tests to perform | |
85 | # more iterations to see the time actually tick over. (You could | |
86 | # also set it to a value between 0 and 1 to speed this up, but I | |
87 | # don't see why you would...) | |
88 | # | |
89 | # See https://github.com/Perl/perl5/issues/20839 for the ticket | |
90 | # that motivated this test. - Yves | |
91 | ||
92 | my @times0; | |
93 | for ( 1 .. 3 ) { | |
94 | my $end_time = time + 1; | |
95 | my $count = 0; | |
96 | my $scale = $ENV{FAST_CPU} || 1; | |
97 | my $count_threshold = 20_000; | |
98 | while ( $ENV{SIMULATE_BROKEN_TIME_FUNCTION} || time < $end_time ) { | |
99 | my $x = 0.0; | |
100 | for ( 1 .. 10_000 ) { | |
101 | $x += sqrt(time); | |
102 | } | |
103 | if (++$count > $count_threshold * $scale) { | |
104 | last; | |
105 | } | |
106 | } | |
107 | cmp_ok($count,"<",$count_threshold * $scale, | |
108 | "expecting \$count < ($count_threshold * $scale)") | |
109 | or splatter(<<~'EOF_SPLATTER'); | |
110 | Either this system is extremely fast, or the time() function | |
111 | is broken. | |
112 | ||
113 | If you think this system is extremely fast you may scale up the | |
114 | number of iterations allowed by this test by setting FAST_CPU=N | |
115 | in the environment. Higher N will allow more ops-per-second | |
116 | before we decide time() is broken. | |
117 | ||
118 | If setting a higher FAST_CPU value does not fix this problem then ... | |
119 | EOF_SPLATTER | |
120 | push @times0, $ENV{SIMULATE_BROKEN_TIMES_FUNCTION} ? 0 : (times)[0]; | |
121 | } | |
122 | isnt("@times0", "0 0 0", "Make sure times() does not always return 0.") | |
123 | or splatter("It appears you have a broken a times() function.\n\n"); | |
124 | } | |
125 | ||
0e74ff8e JH |
126 | my $t0 = new Benchmark; |
127 | isa_ok ($t0, 'Benchmark', "Ensure we can create a benchmark object"); | |
128 | ||
129 | # We use the benchmark object once we've done some work: | |
130 | ||
131 | isa_ok(timeit(5, sub {++$foo}), 'Benchmark', "timeit CODEREF"); | |
132 | is ($foo, 5, "benchmarked code was run 5 times"); | |
133 | ||
134 | isa_ok(timeit(5, '++$bar'), 'Benchmark', "timeit eval"); | |
135 | is ($bar, 5, "benchmarked code was run 5 times"); | |
136 | ||
f265d4df AS |
137 | # is coderef called with spurious arguments? |
138 | timeit( 1, sub { $foo = @_ }); | |
139 | is ($foo, 0, "benchmarked code called without arguments"); | |
140 | ||
141 | ||
1ebabb47 | 142 | print "# Burning CPU to benchmark things; will take time...\n"; |
0e74ff8e JH |
143 | |
144 | # We need to do something fairly slow in the coderef. | |
145 | # Same coderef. Same place in memory. | |
146 | my $coderef = sub {$baz += fib($ballast)}; | |
147 | ||
148 | # The default is three. | |
149 | $baz = 0; | |
150 | my $threesecs = countit(0, $coderef); | |
151 | isa_ok($threesecs, 'Benchmark', "countit 0, CODEREF"); | |
152 | isnt ($baz, 0, "benchmarked code was run"); | |
153 | my $in_threesecs = $threesecs->iters; | |
d684718b | 154 | print "# in_threesecs=$in_threesecs iterations\n"; |
534c402b | 155 | cmp_ok($in_threesecs, '>', 0, "iters returned positive iterations"); |
0d66b88d DM |
156 | my $cpu3 = $threesecs->[1]; # user |
157 | my $sys3 = $threesecs->[2]; # sys | |
158 | cmp_ok($cpu3+$sys3, '>=', 3.0, "3s cpu3 is at least 3s"); | |
bb6c6e4b DM |
159 | my $in_threesecs_adj = $in_threesecs; |
160 | $in_threesecs_adj *= (3/$cpu3); # adjust because may not have run for exactly 3s | |
161 | print "# in_threesecs_adj=$in_threesecs_adj adjusted iterations\n"; | |
0e74ff8e | 162 | |
58747404 | 163 | my $estimate = int (100 * $in_threesecs_adj / 3) / 100; |
0e74ff8e JH |
164 | print "# from the 3 second run estimate $estimate iterations in 1 second...\n"; |
165 | $baz = 0; | |
166 | my $onesec = countit(1, $coderef); | |
167 | isa_ok($onesec, 'Benchmark', "countit 1, CODEREF"); | |
168 | isnt ($baz, 0, "benchmarked code was run"); | |
169 | my $in_onesec = $onesec->iters; | |
d684718b | 170 | print "# in_onesec=$in_onesec iterations\n"; |
534c402b | 171 | cmp_ok($in_onesec, '>', 0, "iters returned positive iterations"); |
0d66b88d DM |
172 | my $cpu1 = $onesec->[1]; # user |
173 | my $sys1 = $onesec->[2]; # sys | |
174 | cmp_ok($cpu1+$sys1, '>=', 1.0, "is cpu1 is at least 1s"); | |
bb6c6e4b DM |
175 | my $in_onesec_adj = $in_onesec; |
176 | $in_onesec_adj *= (1/$cpu1); # adjust because may not have run for exactly 1s | |
177 | print "# in_onesec_adj=$in_onesec_adj adjusted iterations\n"; | |
0e74ff8e | 178 | |
0e74ff8e JH |
179 | |
180 | # I found that the eval'ed version was 3 times faster than the coderef. | |
181 | # (now it has a different ballast value) | |
182 | $baz = 0; | |
183 | my $again = countit(1, '$baz += fib($ballast)'); | |
184 | isa_ok($onesec, 'Benchmark', "countit 1, eval"); | |
185 | isnt ($baz, 0, "benchmarked code was run"); | |
186 | my $in_again = $again->iters; | |
187 | print "# $in_again iterations\n"; | |
534c402b | 188 | cmp_ok($in_again, '>', 0, "iters returned positive iterations"); |
0e74ff8e JH |
189 | |
190 | ||
191 | my $t1 = new Benchmark; | |
192 | isa_ok ($t1, 'Benchmark', "Create another benchmark object now we're finished"); | |
193 | ||
194 | my $diff = timediff ($t1, $t0); | |
195 | isa_ok ($diff, 'Benchmark', "Get the time difference"); | |
196 | isa_ok (timesum ($t0, $t1), 'Benchmark', "check timesum"); | |
197 | ||
198 | my $default = timestr ($diff); | |
199 | isnt ($default, '', 'timestr ($diff)'); | |
200 | my $auto = timestr ($diff, 'auto'); | |
201 | is ($auto, $default, 'timestr ($diff, "auto") matches timestr ($diff)'); | |
202 | ||
203 | { | |
204 | my $all = timestr ($diff, 'all'); | |
53aa2791 | 205 | like ($all, $All_Pattern, 'timestr ($diff, "all")'); |
0e74ff8e JH |
206 | print "# $all\n"; |
207 | ||
53aa2791 | 208 | my ($wallclock, $usr, $sys, $cusr, $csys, $cpu) = $all =~ $All_Pattern; |
0e74ff8e | 209 | |
98dc9551 | 210 | is (timestr ($diff, 'none'), '', "none suppresses output"); |
0e74ff8e JH |
211 | |
212 | my $noc = timestr ($diff, 'noc'); | |
bd9f0ebf | 213 | like ($noc, qr/$wallclock +wallclock secs? +\( *$usr +usr +\+ +$sys +sys += +\d+\.\d\d +CPU\)/, 'timestr ($diff, "noc")'); |
0e74ff8e JH |
214 | |
215 | my $nop = timestr ($diff, 'nop'); | |
216 | like ($nop, qr/$wallclock +wallclock secs? +\( *$cusr +cusr +\+ +$csys +csys += +\d+\.\d\d +CPU\)/, 'timestr ($diff, "nop")'); | |
217 | ||
218 | if ($auto eq $noc) { | |
219 | pass ('"auto" is "noc"'); | |
220 | } else { | |
221 | is ($auto, $all, '"auto" isn\'t "noc", so should be eq to "all"'); | |
222 | } | |
223 | ||
b135e935 | 224 | like (timestr ($diff, 'all', 'E'), |
0e74ff8e JH |
225 | qr/(\d+) +wallclock secs? +\( *\d\.\d+E[-+]?\d\d\d? +usr +\d\.\d+E[-+]?\d\d\d? +sys +\+ +\d\.\d+E[-+]?\d\d\d? +cusr +\d\.\d+E[-+]?\d\d\d? +csys += +\d\.\d+E[-+]?\d\d\d? +CPU\)/, 'timestr ($diff, "all", "E") [sprintf format of "E"]'); |
226 | } | |
227 | ||
228 | my $out = tie *OUT, 'TieOut'; | |
229 | ||
8dddc156 | 230 | my $iterations = 100; |
0e74ff8e JH |
231 | |
232 | $foo = 0; | |
233 | select(OUT); | |
234 | my $got = timethis($iterations, sub {++$foo}); | |
235 | select(STDOUT); | |
236 | isa_ok($got, 'Benchmark', "timethis CODEREF"); | |
237 | is ($foo, $iterations, "benchmarked code was run $iterations times"); | |
238 | ||
239 | $got = $out->read(); | |
240 | like ($got, qr/^timethis $iterations/, 'default title'); | |
53aa2791 | 241 | like ($got, $Default_Pattern, 'default format is all or noc'); |
0e74ff8e JH |
242 | |
243 | $bar = 0; | |
244 | select(OUT); | |
245 | $got = timethis($iterations, '++$bar'); | |
246 | select(STDOUT); | |
247 | isa_ok($got, 'Benchmark', "timethis eval"); | |
248 | is ($bar, $iterations, "benchmarked code was run $iterations times"); | |
249 | ||
250 | $got = $out->read(); | |
251 | like ($got, qr/^timethis $iterations/, 'default title'); | |
53aa2791 | 252 | like ($got, $Default_Pattern, 'default format is all or noc'); |
0e74ff8e JH |
253 | |
254 | my $title = 'lies, damn lies and benchmarks'; | |
255 | $foo = 0; | |
256 | select(OUT); | |
257 | $got = timethis($iterations, sub {++$foo}, $title); | |
258 | select(STDOUT); | |
259 | isa_ok($got, 'Benchmark', "timethis with title"); | |
260 | is ($foo, $iterations, "benchmarked code was run $iterations times"); | |
261 | ||
262 | $got = $out->read(); | |
263 | like ($got, qr/^$title:/, 'specify title'); | |
53aa2791 | 264 | like ($got, $Default_Pattern, 'default format is all or noc'); |
0e74ff8e JH |
265 | |
266 | # default is auto, which is all or noc. nop can never match the default | |
267 | $foo = 0; | |
268 | select(OUT); | |
269 | $got = timethis($iterations, sub {++$foo}, $title, 'nop'); | |
270 | select(STDOUT); | |
271 | isa_ok($got, 'Benchmark', "timethis with format"); | |
272 | is ($foo, $iterations, "benchmarked code was run $iterations times"); | |
273 | ||
274 | $got = $out->read(); | |
275 | like ($got, qr/^$title:/, 'specify title'); | |
53aa2791 | 276 | like ($got, $Nop_Pattern, 'specify format as nop'); |
0e74ff8e JH |
277 | |
278 | { | |
279 | $foo = 0; | |
280 | select(OUT); | |
281 | my $start = time; | |
282 | $got = timethis(-2, sub {$foo+= fib($ballast)}, $title, 'none'); | |
283 | my $end = time; | |
284 | select(STDOUT); | |
285 | isa_ok($got, 'Benchmark', | |
286 | "timethis, at least 2 seconds with format 'none'"); | |
534c402b DM |
287 | cmp_ok($foo, '>', 0, "benchmarked code was run"); |
288 | cmp_ok($end - $start, '>', 1, "benchmarked code ran for over 1 second"); | |
0e74ff8e JH |
289 | |
290 | $got = $out->read(); | |
291 | # Remove any warnings about having too few iterations. | |
292 | $got =~ s/\(warning:[^\)]+\)//gs; | |
293 | $got =~ s/^[ \t\n]+//s; # Remove all the whitespace from the beginning | |
294 | ||
295 | is ($got, '', "format 'none' should suppress output"); | |
296 | } | |
297 | ||
298 | $foo = $bar = $baz = 0; | |
299 | select(OUT); | |
300 | $got = timethese($iterations, { Foo => sub {++$foo}, Bar => '++$bar', | |
301 | Baz => sub {++$baz} }); | |
302 | select(STDOUT); | |
303 | is(ref ($got), 'HASH', "timethese should return a hashref"); | |
304 | isa_ok($got->{Foo}, 'Benchmark', "Foo value"); | |
305 | isa_ok($got->{Bar}, 'Benchmark', "Bar value"); | |
306 | isa_ok($got->{Baz}, 'Benchmark', "Baz value"); | |
b135e935 | 307 | is_deeply([sort keys %$got], [sort qw(Foo Bar Baz)], 'should be exactly three objects'); |
0e74ff8e JH |
308 | is ($foo, $iterations, "Foo code was run $iterations times"); |
309 | is ($bar, $iterations, "Bar code was run $iterations times"); | |
310 | is ($baz, $iterations, "Baz code was run $iterations times"); | |
311 | ||
312 | $got = $out->read(); | |
313 | # Remove any warnings about having too few iterations. | |
314 | $got =~ s/\(warning:[^\)]+\)//gs; | |
315 | ||
316 | like ($got, qr/timing $iterations iterations of\s+Bar\W+Baz\W+Foo\W*?\.\.\./s, | |
317 | 'check title'); | |
318 | # Remove the title | |
319 | $got =~ s/.*\.\.\.//s; | |
320 | like ($got, qr/\bBar\b.*\bBaz\b.*\bFoo\b/s, 'check output is in sorted order'); | |
53aa2791 MS |
321 | like ($got, $Default_Pattern, 'should find default format somewhere'); |
322 | ||
323 | ||
324 | { # ensure 'use strict' does not leak from Benchmark.pm into benchmarked code | |
325 | no strict; | |
326 | select OUT; | |
327 | ||
328 | eval { | |
b135e935 | 329 | timethese( 1, |
53aa2791 MS |
330 | { undeclared_var => q{ $i++; $i-- }, |
331 | symbolic_ref => q{ $bar = 42; | |
332 | $foo = 'bar'; | |
333 | $q = ${$foo} }, | |
334 | }, | |
335 | 'none' | |
336 | ); | |
337 | ||
338 | }; | |
339 | is( $@, '', q{no strict leakage in name => 'code'} ); | |
340 | ||
341 | eval { | |
342 | timethese( 1, | |
343 | { undeclared_var => sub { $i++; $i-- }, | |
344 | symbolic_ref => sub { $bar = 42; | |
345 | $foo = 'bar'; | |
346 | return ${$foo} }, | |
347 | }, | |
348 | 'none' | |
349 | ); | |
350 | }; | |
351 | is( $@, '', q{no strict leakage in name => sub { code }} ); | |
352 | ||
353 | # clear out buffer | |
354 | $out->read; | |
355 | } | |
356 | ||
0e74ff8e JH |
357 | |
358 | my $code_to_test = { Foo => sub {$foo+=fib($ballast-2)}, | |
359 | Bar => sub {$bar+=fib($ballast)}}; | |
360 | # Keep these for later. | |
361 | my $results; | |
362 | { | |
363 | $foo = $bar = 0; | |
364 | select(OUT); | |
365 | my $start = times; | |
366 | $results = timethese(-0.1, $code_to_test, 'none'); | |
367 | my $end = times; | |
368 | select(STDOUT); | |
369 | ||
370 | is(ref ($results), 'HASH', "timethese should return a hashref"); | |
371 | isa_ok($results->{Foo}, 'Benchmark', "Foo value"); | |
372 | isa_ok($results->{Bar}, 'Benchmark', "Bar value"); | |
b135e935 | 373 | is_deeply([sort keys %$results], [sort qw(Foo Bar)], 'should be exactly two objects'); |
534c402b DM |
374 | cmp_ok($foo, '>', 0, "Foo code was run"); |
375 | cmp_ok($bar, '>', 0, "Bar code was run"); | |
0e74ff8e | 376 | |
534c402b | 377 | cmp_ok($end-$start, '>', 0.1, "benchmarked code ran for over 0.1 seconds"); |
0e74ff8e JH |
378 | |
379 | $got = $out->read(); | |
380 | # Remove any warnings about having too few iterations. | |
381 | $got =~ s/\(warning:[^\)]+\)//gs; | |
382 | is ($got =~ tr/ \t\n//c, 0, "format 'none' should suppress output"); | |
383 | } | |
384 | my $graph_dissassembly = | |
385 | qr!^[ \t]+(\S+)[ \t]+(\w+)[ \t]+(\w+)[ \t]* # Title line | |
386 | \n[ \t]*(\w+)[ \t]+([0-9.]+(?:/s)?)[ \t]+(-+)[ \t]+(-?\d+%)[ \t]* | |
387 | \n[ \t]*(\w+)[ \t]+([0-9.]+(?:/s)?)[ \t]+(-?\d+%)[ \t]+(-+)[ \t]*$!xm; | |
388 | ||
389 | sub check_graph_consistency { | |
390 | my ( $ratetext, $slowc, $fastc, | |
391 | $slowr, $slowratet, $slowslow, $slowfastt, | |
392 | $fastr, $fastratet, $fastslowt, $fastfast) | |
393 | = @_; | |
ca55f232 | 394 | note("calling check_graph_consistency from line " . (caller(1))[2]); |
23c50b23 NC |
395 | my $all_passed = 1; |
396 | $all_passed | |
397 | &= is ($slowc, $slowr, "left col tag should be top row tag"); | |
398 | $all_passed | |
399 | &= is ($fastc, $fastr, "right col tag should be bottom row tag"); | |
400 | $all_passed &= | |
401 | like ($slowslow, qr/^-+/, "should be dash for comparing slow with slow"); | |
402 | $all_passed | |
403 | &= is ($slowslow, $fastfast, "slow v slow should be same as fast v fast"); | |
0e74ff8e JH |
404 | my $slowrate = $slowratet; |
405 | my $fastrate = $fastratet; | |
406 | my ($slow_is_rate, $fast_is_rate); | |
407 | unless ($slow_is_rate = $slowrate =~ s!/s!!) { | |
408 | # Slow is expressed as iters per second. | |
409 | $slowrate = 1/$slowrate if $slowrate; | |
410 | } | |
411 | unless ($fast_is_rate = $fastrate =~ s!/s!!) { | |
412 | # Fast is expressed as iters per second. | |
413 | $fastrate = 1/$fastrate if $fastrate; | |
414 | } | |
415 | if ($ratetext =~ /rate/i) { | |
23c50b23 NC |
416 | $all_passed |
417 | &= ok ($slow_is_rate, "slow should be expressed as a rate"); | |
418 | $all_passed | |
419 | &= ok ($fast_is_rate, "fast should be expressed as a rate"); | |
0e74ff8e | 420 | } else { |
23c50b23 NC |
421 | $all_passed &= |
422 | ok (!$slow_is_rate, "slow should be expressed as a iters per second"); | |
423 | $all_passed &= | |
424 | ok (!$fast_is_rate, "fast should be expressed as a iters per second"); | |
0e74ff8e JH |
425 | } |
426 | ||
427 | (my $slowfast = $slowfastt) =~ s!%!!; | |
428 | (my $fastslow = $fastslowt) =~ s!%!!; | |
429 | if ($slowrate < $fastrate) { | |
430 | pass ("slow rate is less than fast rate"); | |
07e88136 JH |
431 | unless (ok ($slowfast <= 0 && $slowfast >= -100, |
432 | "slowfast should be less than or equal to zero, and >= -100")) { | |
534c402b | 433 | diag("slowfast=$slowfast"); |
23c50b23 NC |
434 | $all_passed = 0; |
435 | } | |
534c402b | 436 | unless (cmp_ok($fastslow, '>', 0, "fastslow should be > 0")) { |
23c50b23 NC |
437 | $all_passed = 0; |
438 | } | |
0e74ff8e | 439 | } else { |
23c50b23 NC |
440 | $all_passed |
441 | &= is ($slowrate, $fastrate, | |
442 | "slow rate isn't less than fast rate, so should be the same"); | |
620b59a5 JH |
443 | # In OpenBSD the $slowfast is sometimes a really, really, really |
444 | # small number less than zero, and this gets stringified as -0. | |
23c50b23 | 445 | $all_passed |
620b59a5 | 446 | &= like ($slowfast, qr/^-?0$/, "slowfast should be zero"); |
23c50b23 | 447 | $all_passed |
620b59a5 | 448 | &= like ($fastslow, qr/^-?0$/, "fastslow should be zero"); |
0e74ff8e | 449 | } |
23c50b23 | 450 | return $all_passed; |
0e74ff8e JH |
451 | } |
452 | ||
453 | sub check_graph_vs_output { | |
454 | my ($chart, $got) = @_; | |
455 | my ( $ratetext, $slowc, $fastc, | |
456 | $slowr, $slowratet, $slowslow, $slowfastt, | |
457 | $fastr, $fastratet, $fastslowt, $fastfast) | |
458 | = $got =~ $graph_dissassembly; | |
23c50b23 NC |
459 | my $all_passed |
460 | = check_graph_consistency ( $ratetext, $slowc, $fastc, | |
461 | $slowr, $slowratet, $slowslow, $slowfastt, | |
462 | $fastr, $fastratet, $fastslowt, $fastfast); | |
463 | $all_passed | |
464 | &= is_deeply ($chart, [['', $ratetext, $slowc, $fastc], | |
465 | [$slowr, $slowratet, $slowslow, $slowfastt], | |
466 | [$fastr, $fastratet, $fastslowt, $fastfast]], | |
467 | "check the chart layout matches the formatted output"); | |
468 | unless ($all_passed) { | |
534c402b | 469 | diag("Something went wrong there. I got this chart:\n$got"); |
23c50b23 | 470 | } |
0e74ff8e JH |
471 | } |
472 | ||
473 | sub check_graph { | |
474 | my ($title, $row1, $row2) = @_; | |
475 | is (scalar @$title, 4, "Four entries in title row"); | |
476 | is (scalar @$row1, 4, "Four entries in first row"); | |
477 | is (scalar @$row2, 4, "Four entries in second row"); | |
478 | is (shift @$title, '', "First entry of output graph should be ''"); | |
479 | check_graph_consistency (@$title, @$row1, @$row2); | |
480 | } | |
481 | ||
482 | { | |
483 | select(OUT); | |
484 | my $start = times; | |
f8682296 | 485 | my $chart = cmpthese( -0.1, { a => "\$i = sqrt(\$i++) * sqrt(\$i) for 1..10", |
59000498 DM |
486 | b => "\$i = sqrt(\$i++)", |
487 | }, "auto" ) ; | |
0e74ff8e JH |
488 | my $end = times; |
489 | select(STDOUT); | |
534c402b DM |
490 | cmp_ok($end - $start, '>', 0.05, |
491 | "benchmarked code ran for over 0.05 seconds"); | |
0e74ff8e JH |
492 | |
493 | $got = $out->read(); | |
494 | # Remove any warnings about having too few iterations. | |
495 | $got =~ s/\(warning:[^\)]+\)//gs; | |
496 | ||
497 | like ($got, qr/running\W+a\W+b.*?for at least 0\.1 CPU second/s, | |
498 | 'check title'); | |
499 | # Remove the title | |
500 | $got =~ s/.*\.\.\.//s; | |
53aa2791 | 501 | like ($got, $Default_Pattern, 'should find default format somewhere'); |
0e74ff8e JH |
502 | like ($got, $graph_dissassembly, "Should find the output graph somewhere"); |
503 | check_graph_vs_output ($chart, $got); | |
504 | } | |
505 | ||
8962dfd6 A |
506 | # Not giving auto should suppress timethese results. |
507 | { | |
508 | select(OUT); | |
509 | my $start = times; | |
f8682296 | 510 | my $chart = cmpthese( -0.1, { a => "\$i = sqrt(\$i++) * sqrt(\$i) for 1..10", |
59000498 | 511 | b => "\$i = sqrt(\$i++)" }); |
8962dfd6 A |
512 | my $end = times; |
513 | select(STDOUT); | |
534c402b DM |
514 | cmp_ok($end - $start, '>', 0.05, |
515 | "benchmarked code ran for over 0.05 seconds"); | |
8962dfd6 A |
516 | |
517 | $got = $out->read(); | |
518 | # Remove any warnings about having too few iterations. | |
519 | $got =~ s/\(warning:[^\)]+\)//gs; | |
520 | ||
521 | unlike ($got, qr/running\W+a\W+b.*?for at least 0\.1 CPU second/s, | |
522 | 'should not have title'); | |
523 | # Remove the title | |
524 | $got =~ s/.*\.\.\.//s; | |
53aa2791 | 525 | unlike ($got, $Default_Pattern, 'should not find default format somewhere'); |
8962dfd6 A |
526 | like ($got, $graph_dissassembly, "Should find the output graph somewhere"); |
527 | check_graph_vs_output ($chart, $got); | |
528 | } | |
529 | ||
0e74ff8e JH |
530 | { |
531 | $foo = $bar = 0; | |
532 | select(OUT); | |
8dddc156 | 533 | my $chart = cmpthese($iterations, $code_to_test, 'nop' ) ; |
0e74ff8e | 534 | select(STDOUT); |
534c402b DM |
535 | cmp_ok($foo, '>', 0, "Foo code was run"); |
536 | cmp_ok($bar, '>', 0, "Bar code was run"); | |
0e74ff8e JH |
537 | |
538 | $got = $out->read(); | |
539 | # Remove any warnings about having too few iterations. | |
540 | $got =~ s/\(warning:[^\)]+\)//gs; | |
8dddc156 | 541 | like ($got, qr/timing $iterations iterations of\s+Bar\W+Foo\W*?\.\.\./s, |
0e74ff8e JH |
542 | 'check title'); |
543 | # Remove the title | |
544 | $got =~ s/.*\.\.\.//s; | |
53aa2791 | 545 | like ($got, $Nop_Pattern, 'specify format as nop'); |
0e74ff8e JH |
546 | like ($got, $graph_dissassembly, "Should find the output graph somewhere"); |
547 | check_graph_vs_output ($chart, $got); | |
548 | } | |
549 | ||
550 | { | |
551 | $foo = $bar = 0; | |
552 | select(OUT); | |
8dddc156 | 553 | my $chart = cmpthese($iterations, $code_to_test, 'none' ) ; |
0e74ff8e | 554 | select(STDOUT); |
534c402b DM |
555 | cmp_ok($foo, '>', 0, "Foo code was run"); |
556 | cmp_ok($bar, '>', 0, "Bar code was run"); | |
0e74ff8e JH |
557 | |
558 | $got = $out->read(); | |
559 | # Remove any warnings about having too few iterations. | |
560 | $got =~ s/\(warning:[^\)]+\)//gs; | |
561 | $got =~ s/^[ \t\n]+//s; # Remove all the whitespace from the beginning | |
562 | is ($got, '', "format 'none' should suppress output"); | |
563 | is (ref $chart, 'ARRAY', "output should be an array ref"); | |
564 | # Some of these will go bang if the preceding test fails. There will be | |
565 | # a big clue as to why, from the previous test's diagnostic | |
566 | is (ref $chart->[0], 'ARRAY', "output should be an array of arrays"); | |
567 | check_graph (@$chart); | |
568 | } | |
569 | ||
8dddc156 DM |
570 | # this is a repeat of the above test, but with the timing and charting |
571 | # steps split. | |
572 | ||
0e74ff8e JH |
573 | { |
574 | $foo = $bar = 0; | |
575 | select(OUT); | |
8dddc156 | 576 | my $res = timethese($iterations, $code_to_test, 'none' ) ; |
27a1613c DM |
577 | my $chart = cmpthese($res, 'none' ) ; |
578 | select(STDOUT); | |
534c402b DM |
579 | cmp_ok($foo, '>', 0, "Foo code was run"); |
580 | cmp_ok($bar, '>', 0, "Bar code was run"); | |
27a1613c DM |
581 | |
582 | $got = $out->read(); | |
583 | # Remove any warnings about having too few iterations. | |
584 | $got =~ s/\(warning:[^\)]+\)//gs; | |
585 | $got =~ s/^[ \t\n]+//s; # Remove all the whitespace from the beginning | |
586 | is ($got, '', "format 'none' should suppress output"); | |
587 | is (ref $chart, 'ARRAY', "output should be an array ref"); | |
588 | # Some of these will go bang if the preceding test fails. There will be | |
589 | # a big clue as to why, from the previous test's diagnostic | |
590 | is (ref $chart->[0], 'ARRAY', "output should be an array of arrays"); | |
591 | use Data::Dumper; | |
592 | check_graph(@$chart) | |
593 | or diag(Data::Dumper->Dump([$res, $chart], ['$res', '$chart'])); | |
594 | } | |
595 | ||
596 | { | |
597 | $foo = $bar = 0; | |
598 | select(OUT); | |
0e74ff8e JH |
599 | my $chart = cmpthese( $results ) ; |
600 | select(STDOUT); | |
601 | is ($foo, 0, "Foo code was not run"); | |
602 | is ($bar, 0, "Bar code was not run"); | |
603 | ||
604 | $got = $out->read(); | |
534c402b | 605 | unlike($got, qr/\.\.\./s, 'check that there is no title'); |
0e74ff8e JH |
606 | like ($got, $graph_dissassembly, "Should find the output graph somewhere"); |
607 | check_graph_vs_output ($chart, $got); | |
608 | } | |
609 | ||
610 | { | |
611 | $foo = $bar = 0; | |
612 | select(OUT); | |
613 | my $chart = cmpthese( $results, 'none' ) ; | |
614 | select(STDOUT); | |
615 | is ($foo, 0, "Foo code was not run"); | |
616 | is ($bar, 0, "Bar code was not run"); | |
617 | ||
618 | $got = $out->read(); | |
619 | is ($got, '', "'none' should suppress all output"); | |
620 | is (ref $chart, 'ARRAY', "output should be an array ref"); | |
621 | # Some of these will go bang if the preceding test fails. There will be | |
622 | # a big clue as to why, from the previous test's diagnostic | |
623 | is (ref $chart->[0], 'ARRAY', "output should be an array of arrays"); | |
624 | check_graph (@$chart); | |
625 | } | |
626 | ||
627 | ###}my $out = tie *OUT, 'TieOut'; my ($got); ### | |
628 | ||
629 | my $debug = tie *STDERR, 'TieOut'; | |
630 | ||
631 | $bar = 0; | |
632 | isa_ok(timeit(5, '++$bar'), 'Benchmark', "timeit eval"); | |
633 | is ($bar, 5, "benchmarked code was run 5 times"); | |
634 | is ($debug->read(), '', "There was no debug output"); | |
635 | ||
636 | Benchmark->debug(1); | |
637 | ||
638 | $bar = 0; | |
639 | select(OUT); | |
640 | $got = timeit(5, '++$bar'); | |
641 | select(STDOUT); | |
642 | isa_ok($got, 'Benchmark', "timeit eval"); | |
643 | is ($bar, 5, "benchmarked code was run 5 times"); | |
644 | is ($out->read(), '', "There was no STDOUT output with debug enabled"); | |
645 | isnt ($debug->read(), '', "There was STDERR debug output with debug enabled"); | |
646 | ||
647 | Benchmark->debug(0); | |
648 | ||
649 | $bar = 0; | |
650 | isa_ok(timeit(5, '++$bar'), 'Benchmark', "timeit eval"); | |
651 | is ($bar, 5, "benchmarked code was run 5 times"); | |
652 | is ($debug->read(), '', "There was no debug output debug disabled"); | |
653 | ||
654 | undef $debug; | |
655 | untie *STDERR; | |
656 | ||
657 | # To check the cache we are poking where we don't belong, inside the namespace. | |
98dc9551 | 658 | # The way benchmark is written we can't actually check whether the cache is |
0e74ff8e JH |
659 | # being used, merely what's become cached. |
660 | ||
661 | clearallcache(); | |
53aa2791 | 662 | my @before_keys = keys %Benchmark::Cache; |
0e74ff8e JH |
663 | $bar = 0; |
664 | isa_ok(timeit(5, '++$bar'), 'Benchmark', "timeit eval"); | |
665 | is ($bar, 5, "benchmarked code was run 5 times"); | |
53aa2791 | 666 | my @after5_keys = keys %Benchmark::Cache; |
0e74ff8e JH |
667 | $bar = 0; |
668 | isa_ok(timeit(10, '++$bar'), 'Benchmark', "timeit eval"); | |
669 | is ($bar, 10, "benchmarked code was run 10 times"); | |
b135e935 | 670 | cmp_ok (scalar keys %Benchmark::Cache, '>', scalar @after5_keys, "10 differs from 5"); |
0e74ff8e JH |
671 | |
672 | clearcache(10); | |
673 | # Hash key order will be the same if there are the same keys. | |
53aa2791 | 674 | is_deeply ([keys %Benchmark::Cache], \@after5_keys, |
0e74ff8e JH |
675 | "cleared 10, only cached results for 5 should remain"); |
676 | ||
677 | clearallcache(); | |
53aa2791 | 678 | is_deeply ([keys %Benchmark::Cache], \@before_keys, |
0e74ff8e JH |
679 | "back to square 1 when we clear the cache again?"); |
680 | ||
681 | ||
53aa2791 MS |
682 | { # Check usage error messages |
683 | my %usage = %Benchmark::_Usage; | |
684 | delete $usage{runloop}; # not public, not worrying about it just now | |
685 | ||
686 | my @takes_no_args = qw(clearallcache disablecache enablecache); | |
687 | ||
688 | my %cmpthese = ('forgot {}' => 'cmpthese( 42, foo => sub { 1 } )', | |
689 | 'not result' => 'cmpthese(42)', | |
690 | 'array ref' => 'cmpthese( 42, [ foo => sub { 1 } ] )', | |
691 | ); | |
692 | while( my($name, $code) = each %cmpthese ) { | |
693 | eval $code; | |
694 | is( $@, $usage{cmpthese}, "cmpthese usage: $name" ); | |
695 | } | |
696 | ||
697 | my %timethese = ('forgot {}' => 'timethese( 42, foo => sub { 1 } )', | |
698 | 'no code' => 'timethese(42)', | |
699 | 'array ref' => 'timethese( 42, [ foo => sub { 1 } ] )', | |
700 | ); | |
701 | ||
702 | while( my($name, $code) = each %timethese ) { | |
703 | eval $code; | |
704 | is( $@, $usage{timethese}, "timethese usage: $name" ); | |
705 | } | |
706 | ||
707 | ||
708 | while( my($func, $usage) = each %usage ) { | |
709 | next if grep $func eq $_, @takes_no_args; | |
710 | eval "$func()"; | |
711 | is( $@, $usage, "$func usage: no args" ); | |
712 | } | |
713 | ||
714 | foreach my $func (@takes_no_args) { | |
715 | eval "$func(42)"; | |
f695f0e6 | 716 | is( $@, $usage{$func}, "$func usage: with args" ); |
53aa2791 MS |
717 | } |
718 | } | |
719 | ||
70cbce25 | 720 | done_testing(); |
53aa2791 | 721 | |
0e74ff8e JH |
722 | package TieOut; |
723 | ||
724 | sub TIEHANDLE { | |
725 | my $class = shift; | |
726 | bless(\( my $ref = ''), $class); | |
727 | } | |
728 | ||
729 | sub PRINT { | |
730 | my $self = shift; | |
731 | $$self .= join('', @_); | |
732 | } | |
733 | ||
734 | sub PRINTF { | |
735 | my $self = shift; | |
736 | $$self .= sprintf shift, @_; | |
737 | } | |
738 | ||
739 | sub read { | |
740 | my $self = shift; | |
741 | return substr($$self, 0, length($$self), ''); | |
742 | } |