10 use vars qw($foo $bar $baz $ballast);
11 use Test::More tests => 195;
13 use Benchmark qw(:all);
21 fib($n-1) + fib($n-2);
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\)/;
28 qr/(\d+) +wallclock secs? +\( *(-?\d+\.\d\d) +usr +\+ +(-?\d+\.\d\d) +sys += +(-?\d+\.\d\d) +CPU\)/;
30 qr/(\d+) +wallclock secs? +\( *(-?\d+\.\d\d) +cusr +\+ +(-?\d+\.\d\d) +csys += +\d+\.\d\d +CPU\)/;
31 # Please don't trust the matching parentheses to be useful in this :-)
32 my $Default_Pattern = qr/$All_Pattern|$Noc_Pattern/;
34 # see if the ratio of two integer values is within (1+$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);
43 my $t0 = new Benchmark;
44 isa_ok ($t0, 'Benchmark', "Ensure we can create a benchmark object");
46 # We use the benchmark object once we've done some work:
48 isa_ok(timeit(5, sub {++$foo}), 'Benchmark', "timeit CODEREF");
49 is ($foo, 5, "benchmarked code was run 5 times");
51 isa_ok(timeit(5, '++$bar'), 'Benchmark', "timeit eval");
52 is ($bar, 5, "benchmarked code was run 5 times");
54 # is coderef called with spurious arguments?
55 timeit( 1, sub { $foo = @_ });
56 is ($foo, 0, "benchmarked code called without arguments");
59 print "# Burning CPU to benchmark things; will take time...\n";
61 # We need to do something fairly slow in the coderef.
62 # Same coderef. Same place in memory.
63 my $coderef = sub {$baz += fib($ballast)};
65 # The default is three.
67 my $threesecs = countit(0, $coderef);
68 isa_ok($threesecs, 'Benchmark', "countit 0, CODEREF");
69 isnt ($baz, 0, "benchmarked code was run");
70 my $in_threesecs = $threesecs->iters;
71 print "# in_threesecs=$in_threesecs iterations\n";
72 ok ($in_threesecs > 0, "iters returned positive iterations");
73 my $cpu3 = $threesecs->[1]; # user
74 my $sys3 = $threesecs->[2]; # sys
75 cmp_ok($cpu3+$sys3, '>=', 3.0, "3s cpu3 is at least 3s");
76 my $in_threesecs_adj = $in_threesecs;
77 $in_threesecs_adj *= (3/$cpu3); # adjust because may not have run for exactly 3s
78 print "# in_threesecs_adj=$in_threesecs_adj adjusted iterations\n";
80 my $estimate = int (100 * $in_threesecs_adj / 3) / 100;
81 print "# from the 3 second run estimate $estimate iterations in 1 second...\n";
83 my $onesec = countit(1, $coderef);
84 isa_ok($onesec, 'Benchmark', "countit 1, CODEREF");
85 isnt ($baz, 0, "benchmarked code was run");
86 my $in_onesec = $onesec->iters;
87 print "# in_onesec=$in_onesec iterations\n";
88 ok ($in_onesec > 0, "iters returned positive iterations");
89 my $cpu1 = $onesec->[1]; # user
90 my $sys1 = $onesec->[2]; # sys
91 cmp_ok($cpu1+$sys1, '>=', 1.0, "is cpu1 is at least 1s");
92 my $in_onesec_adj = $in_onesec;
93 $in_onesec_adj *= (1/$cpu1); # adjust because may not have run for exactly 1s
94 print "# in_onesec_adj=$in_onesec_adj adjusted iterations\n";
97 # I found that the eval'ed version was 3 times faster than the coderef.
98 # (now it has a different ballast value)
100 my $again = countit(1, '$baz += fib($ballast)');
101 isa_ok($onesec, 'Benchmark', "countit 1, eval");
102 isnt ($baz, 0, "benchmarked code was run");
103 my $in_again = $again->iters;
104 print "# $in_again iterations\n";
105 ok ($in_again > 0, "iters returned positive iterations");
108 my $t1 = new Benchmark;
109 isa_ok ($t1, 'Benchmark', "Create another benchmark object now we're finished");
111 my $diff = timediff ($t1, $t0);
112 isa_ok ($diff, 'Benchmark', "Get the time difference");
113 isa_ok (timesum ($t0, $t1), 'Benchmark', "check timesum");
115 my $default = timestr ($diff);
116 isnt ($default, '', 'timestr ($diff)');
117 my $auto = timestr ($diff, 'auto');
118 is ($auto, $default, 'timestr ($diff, "auto") matches timestr ($diff)');
121 my $all = timestr ($diff, 'all');
122 like ($all, $All_Pattern, 'timestr ($diff, "all")');
125 my ($wallclock, $usr, $sys, $cusr, $csys, $cpu) = $all =~ $All_Pattern;
127 is (timestr ($diff, 'none'), '', "none suppresses output");
129 my $noc = timestr ($diff, 'noc');
130 like ($noc, qr/$wallclock +wallclock secs? +\( *$usr +usr +\+ +$sys +sys += +\d+\.\d\d +CPU\)/, 'timestr ($diff, "noc")');
132 my $nop = timestr ($diff, 'nop');
133 like ($nop, qr/$wallclock +wallclock secs? +\( *$cusr +cusr +\+ +$csys +csys += +\d+\.\d\d +CPU\)/, 'timestr ($diff, "nop")');
136 pass ('"auto" is "noc"');
138 is ($auto, $all, '"auto" isn\'t "noc", so should be eq to "all"');
141 like (timestr ($diff, 'all', 'E'),
142 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"]');
145 my $out = tie *OUT, 'TieOut';
151 my $got = timethis($iterations, sub {++$foo});
153 isa_ok($got, 'Benchmark', "timethis CODEREF");
154 is ($foo, $iterations, "benchmarked code was run $iterations times");
157 like ($got, qr/^timethis $iterations/, 'default title');
158 like ($got, $Default_Pattern, 'default format is all or noc');
162 $got = timethis($iterations, '++$bar');
164 isa_ok($got, 'Benchmark', "timethis eval");
165 is ($bar, $iterations, "benchmarked code was run $iterations times");
168 like ($got, qr/^timethis $iterations/, 'default title');
169 like ($got, $Default_Pattern, 'default format is all or noc');
171 my $title = 'lies, damn lies and benchmarks';
174 $got = timethis($iterations, sub {++$foo}, $title);
176 isa_ok($got, 'Benchmark', "timethis with title");
177 is ($foo, $iterations, "benchmarked code was run $iterations times");
180 like ($got, qr/^$title:/, 'specify title');
181 like ($got, $Default_Pattern, 'default format is all or noc');
183 # default is auto, which is all or noc. nop can never match the default
186 $got = timethis($iterations, sub {++$foo}, $title, 'nop');
188 isa_ok($got, 'Benchmark', "timethis with format");
189 is ($foo, $iterations, "benchmarked code was run $iterations times");
192 like ($got, qr/^$title:/, 'specify title');
193 like ($got, $Nop_Pattern, 'specify format as nop');
199 $got = timethis(-2, sub {$foo+= fib($ballast)}, $title, 'none');
202 isa_ok($got, 'Benchmark',
203 "timethis, at least 2 seconds with format 'none'");
204 ok ($foo > 0, "benchmarked code was run");
205 ok ($end - $start > 1, "benchmarked code ran for over 1 second");
208 # Remove any warnings about having too few iterations.
209 $got =~ s/\(warning:[^\)]+\)//gs;
210 $got =~ s/^[ \t\n]+//s; # Remove all the whitespace from the beginning
212 is ($got, '', "format 'none' should suppress output");
215 $foo = $bar = $baz = 0;
217 $got = timethese($iterations, { Foo => sub {++$foo}, Bar => '++$bar',
218 Baz => sub {++$baz} });
220 is(ref ($got), 'HASH', "timethese should return a hashref");
221 isa_ok($got->{Foo}, 'Benchmark', "Foo value");
222 isa_ok($got->{Bar}, 'Benchmark', "Bar value");
223 isa_ok($got->{Baz}, 'Benchmark', "Baz value");
224 eq_set([keys %$got], [qw(Foo Bar Baz)], 'should be exactly three objects');
225 is ($foo, $iterations, "Foo code was run $iterations times");
226 is ($bar, $iterations, "Bar code was run $iterations times");
227 is ($baz, $iterations, "Baz code was run $iterations times");
230 # Remove any warnings about having too few iterations.
231 $got =~ s/\(warning:[^\)]+\)//gs;
233 like ($got, qr/timing $iterations iterations of\s+Bar\W+Baz\W+Foo\W*?\.\.\./s,
236 $got =~ s/.*\.\.\.//s;
237 like ($got, qr/\bBar\b.*\bBaz\b.*\bFoo\b/s, 'check output is in sorted order');
238 like ($got, $Default_Pattern, 'should find default format somewhere');
241 { # ensure 'use strict' does not leak from Benchmark.pm into benchmarked code
247 { undeclared_var => q{ $i++; $i-- },
248 symbolic_ref => q{ $bar = 42;
256 is( $@, '', q{no strict leakage in name => 'code'} );
260 { undeclared_var => sub { $i++; $i-- },
261 symbolic_ref => sub { $bar = 42;
268 is( $@, '', q{no strict leakage in name => sub { code }} );
275 my $code_to_test = { Foo => sub {$foo+=fib($ballast-2)},
276 Bar => sub {$bar+=fib($ballast)}};
277 # Keep these for later.
283 $results = timethese(-0.1, $code_to_test, 'none');
287 is(ref ($results), 'HASH', "timethese should return a hashref");
288 isa_ok($results->{Foo}, 'Benchmark', "Foo value");
289 isa_ok($results->{Bar}, 'Benchmark', "Bar value");
290 eq_set([keys %$results], [qw(Foo Bar)], 'should be exactly two objects');
291 ok ($foo > 0, "Foo code was run");
292 ok ($bar > 0, "Bar code was run");
294 ok (($end - $start) > 0.1, "benchmarked code ran for over 0.1 seconds");
297 # Remove any warnings about having too few iterations.
298 $got =~ s/\(warning:[^\)]+\)//gs;
299 is ($got =~ tr/ \t\n//c, 0, "format 'none' should suppress output");
301 my $graph_dissassembly =
302 qr!^[ \t]+(\S+)[ \t]+(\w+)[ \t]+(\w+)[ \t]* # Title line
303 \n[ \t]*(\w+)[ \t]+([0-9.]+(?:/s)?)[ \t]+(-+)[ \t]+(-?\d+%)[ \t]*
304 \n[ \t]*(\w+)[ \t]+([0-9.]+(?:/s)?)[ \t]+(-?\d+%)[ \t]+(-+)[ \t]*$!xm;
306 sub check_graph_consistency {
307 my ( $ratetext, $slowc, $fastc,
308 $slowr, $slowratet, $slowslow, $slowfastt,
309 $fastr, $fastratet, $fastslowt, $fastfast)
311 note("calling check_graph_consistency from line " . (caller(1))[2]);
314 &= is ($slowc, $slowr, "left col tag should be top row tag");
316 &= is ($fastc, $fastr, "right col tag should be bottom row tag");
318 like ($slowslow, qr/^-+/, "should be dash for comparing slow with slow");
320 &= is ($slowslow, $fastfast, "slow v slow should be same as fast v fast");
321 my $slowrate = $slowratet;
322 my $fastrate = $fastratet;
323 my ($slow_is_rate, $fast_is_rate);
324 unless ($slow_is_rate = $slowrate =~ s!/s!!) {
325 # Slow is expressed as iters per second.
326 $slowrate = 1/$slowrate if $slowrate;
328 unless ($fast_is_rate = $fastrate =~ s!/s!!) {
329 # Fast is expressed as iters per second.
330 $fastrate = 1/$fastrate if $fastrate;
332 if ($ratetext =~ /rate/i) {
334 &= ok ($slow_is_rate, "slow should be expressed as a rate");
336 &= ok ($fast_is_rate, "fast should be expressed as a rate");
339 ok (!$slow_is_rate, "slow should be expressed as a iters per second");
341 ok (!$fast_is_rate, "fast should be expressed as a iters per second");
344 (my $slowfast = $slowfastt) =~ s!%!!;
345 (my $fastslow = $fastslowt) =~ s!%!!;
346 if ($slowrate < $fastrate) {
347 pass ("slow rate is less than fast rate");
348 unless (ok ($slowfast <= 0 && $slowfast >= -100,
349 "slowfast should be less than or equal to zero, and >= -100")) {
350 print STDERR "# slowfast $slowfast\n";
353 unless (ok ($fastslow > 0, "fastslow should be > 0")) {
354 print STDERR "# fastslow $fastslow\n";
359 &= is ($slowrate, $fastrate,
360 "slow rate isn't less than fast rate, so should be the same");
361 # In OpenBSD the $slowfast is sometimes a really, really, really
362 # small number less than zero, and this gets stringified as -0.
364 &= like ($slowfast, qr/^-?0$/, "slowfast should be zero");
366 &= like ($fastslow, qr/^-?0$/, "fastslow should be zero");
371 sub check_graph_vs_output {
372 my ($chart, $got) = @_;
373 my ( $ratetext, $slowc, $fastc,
374 $slowr, $slowratet, $slowslow, $slowfastt,
375 $fastr, $fastratet, $fastslowt, $fastfast)
376 = $got =~ $graph_dissassembly;
378 = check_graph_consistency ( $ratetext, $slowc, $fastc,
379 $slowr, $slowratet, $slowslow, $slowfastt,
380 $fastr, $fastratet, $fastslowt, $fastfast);
382 &= is_deeply ($chart, [['', $ratetext, $slowc, $fastc],
383 [$slowr, $slowratet, $slowslow, $slowfastt],
384 [$fastr, $fastratet, $fastslowt, $fastfast]],
385 "check the chart layout matches the formatted output");
386 unless ($all_passed) {
387 print STDERR "# Something went wrong there. I got this chart:\n";
388 print STDERR "# $_\n" foreach split /\n/, $got;
393 my ($title, $row1, $row2) = @_;
394 is (scalar @$title, 4, "Four entries in title row");
395 is (scalar @$row1, 4, "Four entries in first row");
396 is (scalar @$row2, 4, "Four entries in second row");
397 is (shift @$title, '', "First entry of output graph should be ''");
398 check_graph_consistency (@$title, @$row1, @$row2);
404 my $chart = cmpthese( -0.1, { a => "\$i = sqrt(\$i++) * sqrt(\$i)",
405 b => "\$i = sqrt(\$i++)",
409 ok (($end - $start) > 0.05, "benchmarked code ran for over 0.05 seconds");
412 # Remove any warnings about having too few iterations.
413 $got =~ s/\(warning:[^\)]+\)//gs;
415 like ($got, qr/running\W+a\W+b.*?for at least 0\.1 CPU second/s,
418 $got =~ s/.*\.\.\.//s;
419 like ($got, $Default_Pattern, 'should find default format somewhere');
420 like ($got, $graph_dissassembly, "Should find the output graph somewhere");
421 check_graph_vs_output ($chart, $got);
424 # Not giving auto should suppress timethese results.
428 my $chart = cmpthese( -0.1, { a => "\$i = sqrt(\$i++) * sqrt(\$i)",
429 b => "\$i = sqrt(\$i++)" });
432 ok (($end - $start) > 0.05, "benchmarked code ran for over 0.05 seconds");
435 # Remove any warnings about having too few iterations.
436 $got =~ s/\(warning:[^\)]+\)//gs;
438 unlike ($got, qr/running\W+a\W+b.*?for at least 0\.1 CPU second/s,
439 'should not have title');
441 $got =~ s/.*\.\.\.//s;
442 unlike ($got, $Default_Pattern, 'should not find default format somewhere');
443 like ($got, $graph_dissassembly, "Should find the output graph somewhere");
444 check_graph_vs_output ($chart, $got);
450 my $chart = cmpthese( 10, $code_to_test, 'nop' ) ;
452 ok ($foo > 0, "Foo code was run");
453 ok ($bar > 0, "Bar code was run");
456 # Remove any warnings about having too few iterations.
457 $got =~ s/\(warning:[^\)]+\)//gs;
458 like ($got, qr/timing 10 iterations of\s+Bar\W+Foo\W*?\.\.\./s,
461 $got =~ s/.*\.\.\.//s;
462 like ($got, $Nop_Pattern, 'specify format as nop');
463 like ($got, $graph_dissassembly, "Should find the output graph somewhere");
464 check_graph_vs_output ($chart, $got);
470 my $chart = cmpthese( 10, $code_to_test, 'none' ) ;
472 ok ($foo > 0, "Foo code was run");
473 ok ($bar > 0, "Bar code was run");
476 # Remove any warnings about having too few iterations.
477 $got =~ s/\(warning:[^\)]+\)//gs;
478 $got =~ s/^[ \t\n]+//s; # Remove all the whitespace from the beginning
479 is ($got, '', "format 'none' should suppress output");
480 is (ref $chart, 'ARRAY', "output should be an array ref");
481 # Some of these will go bang if the preceding test fails. There will be
482 # a big clue as to why, from the previous test's diagnostic
483 is (ref $chart->[0], 'ARRAY', "output should be an array of arrays");
484 check_graph (@$chart);
490 my $chart = cmpthese( $results ) ;
492 is ($foo, 0, "Foo code was not run");
493 is ($bar, 0, "Bar code was not run");
496 ok ($got !~ /\.\.\./s, 'check that there is no title');
497 like ($got, $graph_dissassembly, "Should find the output graph somewhere");
498 check_graph_vs_output ($chart, $got);
504 my $chart = cmpthese( $results, 'none' ) ;
506 is ($foo, 0, "Foo code was not run");
507 is ($bar, 0, "Bar code was not run");
510 is ($got, '', "'none' should suppress all output");
511 is (ref $chart, 'ARRAY', "output should be an array ref");
512 # Some of these will go bang if the preceding test fails. There will be
513 # a big clue as to why, from the previous test's diagnostic
514 is (ref $chart->[0], 'ARRAY', "output should be an array of arrays");
515 check_graph (@$chart);
518 ###}my $out = tie *OUT, 'TieOut'; my ($got); ###
520 my $debug = tie *STDERR, 'TieOut';
523 isa_ok(timeit(5, '++$bar'), 'Benchmark', "timeit eval");
524 is ($bar, 5, "benchmarked code was run 5 times");
525 is ($debug->read(), '', "There was no debug output");
531 $got = timeit(5, '++$bar');
533 isa_ok($got, 'Benchmark', "timeit eval");
534 is ($bar, 5, "benchmarked code was run 5 times");
535 is ($out->read(), '', "There was no STDOUT output with debug enabled");
536 isnt ($debug->read(), '', "There was STDERR debug output with debug enabled");
541 isa_ok(timeit(5, '++$bar'), 'Benchmark', "timeit eval");
542 is ($bar, 5, "benchmarked code was run 5 times");
543 is ($debug->read(), '', "There was no debug output debug disabled");
548 # To check the cache we are poking where we don't belong, inside the namespace.
549 # The way benchmark is written we can't actually check whether the cache is
550 # being used, merely what's become cached.
553 my @before_keys = keys %Benchmark::Cache;
555 isa_ok(timeit(5, '++$bar'), 'Benchmark', "timeit eval");
556 is ($bar, 5, "benchmarked code was run 5 times");
557 my @after5_keys = keys %Benchmark::Cache;
559 isa_ok(timeit(10, '++$bar'), 'Benchmark', "timeit eval");
560 is ($bar, 10, "benchmarked code was run 10 times");
561 ok (!eq_array ([keys %Benchmark::Cache], \@after5_keys), "10 differs from 5");
564 # Hash key order will be the same if there are the same keys.
565 is_deeply ([keys %Benchmark::Cache], \@after5_keys,
566 "cleared 10, only cached results for 5 should remain");
569 is_deeply ([keys %Benchmark::Cache], \@before_keys,
570 "back to square 1 when we clear the cache again?");
573 { # Check usage error messages
574 my %usage = %Benchmark::_Usage;
575 delete $usage{runloop}; # not public, not worrying about it just now
577 my @takes_no_args = qw(clearallcache disablecache enablecache);
579 my %cmpthese = ('forgot {}' => 'cmpthese( 42, foo => sub { 1 } )',
580 'not result' => 'cmpthese(42)',
581 'array ref' => 'cmpthese( 42, [ foo => sub { 1 } ] )',
583 while( my($name, $code) = each %cmpthese ) {
585 is( $@, $usage{cmpthese}, "cmpthese usage: $name" );
588 my %timethese = ('forgot {}' => 'timethese( 42, foo => sub { 1 } )',
589 'no code' => 'timethese(42)',
590 'array ref' => 'timethese( 42, [ foo => sub { 1 } ] )',
593 while( my($name, $code) = each %timethese ) {
595 is( $@, $usage{timethese}, "timethese usage: $name" );
599 while( my($func, $usage) = each %usage ) {
600 next if grep $func eq $_, @takes_no_args;
602 is( $@, $usage, "$func usage: no args" );
605 foreach my $func (@takes_no_args) {
607 is( $@, $usage{$func}, "$func usage: with args" );
616 bless(\( my $ref = ''), $class);
621 $$self .= join('', @_);
626 $$self .= sprintf shift, @_;
631 return substr($$self, 0, length($$self), '');