This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
a3c854400201bbff289e29fa20a37a3c351af2d6
[perl5.git] / lib / Benchmark.pm
1 package Benchmark;
2
3 =head1 NAME
4
5 Benchmark - benchmark running times of code
6
7 timethis - run a chunk of code several times
8
9 timethese - run several chunks of code several times
10
11 timeit - run a chunk of code and see how long it goes
12
13 =head1 SYNOPSIS
14
15     timethis ($count, "code");
16
17     # Use Perl code in strings...
18     timethese($count, {
19         'Name1' => '...code1...',
20         'Name2' => '...code2...',
21     });
22
23     # ... or use subroutine references.
24     timethese($count, {
25         'Name1' => sub { ...code1... },
26         'Name2' => sub { ...code2... },
27     });
28
29     $t = timeit($count, '...other code...')
30     print "$count loops of other code took:",timestr($t),"\n";
31
32 =head1 DESCRIPTION
33
34 The Benchmark module encapsulates a number of routines to help you
35 figure out how long it takes to execute some code.
36
37 =head2 Methods
38
39 =over 10
40
41 =item new
42
43 Returns the current time.   Example:
44
45     use Benchmark;
46     $t0 = new Benchmark;
47     # ... your code here ...
48     $t1 = new Benchmark;
49     $td = timediff($t1, $t0);
50     print "the code took:",timestr($td),"\n";
51
52 =item debug
53
54 Enables or disable debugging by setting the C<$Benchmark::Debug> flag:
55
56     debug Benchmark 1;
57     $t = timeit(10, ' 5 ** $Global ');
58     debug Benchmark 0;
59
60 =back
61
62 =head2 Standard Exports
63
64 The following routines will be exported into your namespace
65 if you use the Benchmark module:
66
67 =over 10
68
69 =item timeit(COUNT, CODE)
70
71 Arguments: COUNT is the number of times to run the loop, and CODE is
72 the code to run.  CODE may be either a code reference or a string to
73 be eval'd; either way it will be run in the caller's package.
74
75 Returns: a Benchmark object.
76
77 =item timethis ( COUNT, CODE, [ TITLE, [ STYLE ]] )
78
79 Time COUNT iterations of CODE. CODE may be a string to eval or a
80 code reference; either way the CODE will run in the caller's package.
81 Results will be printed to STDOUT as TITLE followed by the times.
82 TITLE defaults to "timethis COUNT" if none is provided. STYLE
83 determines the format of the output, as described for timestr() below.
84
85 =item timethese ( COUNT, CODEHASHREF, [ STYLE ] )
86
87 The CODEHASHREF is a reference to a hash containing names as keys
88 and either a string to eval or a code reference for each value.
89 For each (KEY, VALUE) pair in the CODEHASHREF, this routine will
90 call
91
92         timethis(COUNT, VALUE, KEY, STYLE)
93
94 =item timediff ( T1, T2 )
95
96 Returns the difference between two Benchmark times as a Benchmark
97 object suitable for passing to timestr().
98
99 =item timestr ( TIMEDIFF, [ STYLE, [ FORMAT ]] )
100
101 Returns a string that formats the times in the TIMEDIFF object in
102 the requested STYLE. TIMEDIFF is expected to be a Benchmark object
103 similar to that returned by timediff().
104
105 STYLE can be any of 'all', 'noc', 'nop' or 'auto'. 'all' shows each
106 of the 5 times available ('wallclock' time, user time, system time,
107 user time of children, and system time of children). 'noc' shows all
108 except the two children times. 'nop' shows only wallclock and the
109 two children times. 'auto' (the default) will act as 'all' unless
110 the children times are both zero, in which case it acts as 'noc'.
111
112 FORMAT is the L<printf(3)>-style format specifier (without the
113 leading '%') to use to print the times. It defaults to '5.2f'.
114
115 =back
116
117 =head2 Optional Exports
118
119 The following routines will be exported into your namespace
120 if you specifically ask that they be imported:
121
122 =over 10
123
124 =item clearcache ( COUNT )
125
126 Clear the cached time for COUNT rounds of the null loop.
127
128 =item clearallcache ( )
129
130 Clear all cached times.
131
132 =item disablecache ( )
133
134 Disable caching of timings for the null loop. This will force Benchmark
135 to recalculate these timings for each new piece of code timed.
136
137 =item enablecache ( )
138
139 Enable caching of timings for the null loop. The time taken for COUNT
140 rounds of the null loop will be calculated only once for each
141 different COUNT used.
142
143 =back
144
145 =head1 NOTES
146
147 The data is stored as a list of values from the time and times
148 functions:
149
150       ($real, $user, $system, $children_user, $children_system)
151
152 in seconds for the whole loop (not divided by the number of rounds).
153
154 The timing is done using time(3) and times(3).
155
156 Code is executed in the caller's package.
157
158 The time of the null loop (a loop with the same
159 number of rounds but empty loop body) is subtracted
160 from the time of the real loop.
161
162 The null loop times are cached, the key being the
163 number of rounds. The caching can be controlled using
164 calls like these:
165
166     clearcache($key);
167     clearallcache();
168
169     disablecache();
170     enablecache();
171
172 =head1 INHERITANCE
173
174 Benchmark inherits from no other class, except of course
175 for Exporter.
176
177 =head1 CAVEATS
178
179 The real time timing is done using time(2) and
180 the granularity is therefore only one second.
181
182 Short tests may produce negative figures because perl
183 can appear to take longer to execute the empty loop
184 than a short test; try:
185
186     timethis(100,'1');
187
188 The system time of the null loop might be slightly
189 more than the system time of the loop with the actual
190 code and therefore the difference might end up being E<lt> 0.
191
192 =head1 AUTHORS
193
194 Jarkko Hietaniemi E<lt>F<Jarkko.Hietaniemi@hut.fi>E<gt>,
195 Tim Bunce E<lt>F<Tim.Bunce@ig.co.uk>E<gt>
196
197 =head1 MODIFICATION HISTORY
198
199 September 8th, 1994; by Tim Bunce.
200
201 March 28th, 1997; by Hugo van der Sanden: added support for code
202 references and the already documented 'debug' method; revamped
203 documentation.
204
205 =cut
206
207 use Carp;
208 use Exporter;
209 @ISA=(Exporter);
210 @EXPORT=qw(timeit timethis timethese timediff timestr);
211 @EXPORT_OK=qw(clearcache clearallcache disablecache enablecache);
212
213 &init;
214
215 sub init {
216     $debug = 0;
217     $min_count = 4;
218     $min_cpu   = 0.4;
219     $defaultfmt = '5.2f';
220     $defaultstyle = 'auto';
221     # The cache can cause a slight loss of sys time accuracy. If a
222     # user does many tests (>10) with *very* large counts (>10000)
223     # or works on a very slow machine the cache may be useful.
224     &disablecache;
225     &clearallcache;
226 }
227
228 sub debug { $debug = ($_[1] != 0); }
229
230 sub clearcache    { delete $cache{$_[0]}; }
231 sub clearallcache { %cache = (); }
232 sub enablecache   { $cache = 1; }
233 sub disablecache  { $cache = 0; }
234
235 # --- Functions to process the 'time' data type
236
237 sub new { my @t = (time, times); print "new=@t\n" if $debug; bless \@t; }
238
239 sub cpu_p { my($r,$pu,$ps,$cu,$cs) = @{$_[0]}; $pu+$ps         ; }
240 sub cpu_c { my($r,$pu,$ps,$cu,$cs) = @{$_[0]};         $cu+$cs ; }
241 sub cpu_a { my($r,$pu,$ps,$cu,$cs) = @{$_[0]}; $pu+$ps+$cu+$cs ; }
242 sub real  { my($r,$pu,$ps,$cu,$cs) = @{$_[0]}; $r              ; }
243
244 sub timediff {
245     my($a, $b) = @_;
246     my @r;
247     for ($i=0; $i < @$a; ++$i) {
248         push(@r, $a->[$i] - $b->[$i]);
249     }
250     bless \@r;
251 }
252
253 sub timestr {
254     my($tr, $style, $f) = @_;
255     my @t = @$tr;
256     warn "bad time value" unless @t==5;
257     my($r, $pu, $ps, $cu, $cs) = @t;
258     my($pt, $ct, $t) = ($tr->cpu_p, $tr->cpu_c, $tr->cpu_a);
259     $f = $defaultfmt unless defined $f;
260     # format a time in the required style, other formats may be added here
261     $style = $defaultstyle unless defined $style;
262     $style = ($ct>0) ? 'all' : 'noc' if $style eq 'auto';
263     my $s = "@t $style"; # default for unknown style
264     $s=sprintf("%2d secs (%$f usr %$f sys + %$f cusr %$f csys = %$f cpu)",
265                             @t,$t) if $style eq 'all';
266     $s=sprintf("%2d secs (%$f usr %$f sys = %$f cpu)",
267                             $r,$pu,$ps,$pt) if $style eq 'noc';
268     $s=sprintf("%2d secs (%$f cusr %$f csys = %$f cpu)",
269                             $r,$cu,$cs,$ct) if $style eq 'nop';
270     $s;
271 }
272
273 sub timedebug {
274     my($msg, $t) = @_;
275     print STDERR "$msg",timestr($t),"\n" if $debug;
276 }
277
278 # --- Functions implementing low-level support for timing loops
279
280 sub runloop {
281     my($n, $c) = @_;
282
283     $n+=0; # force numeric now, so garbage won't creep into the eval
284     croak "negative loopcount $n" if $n<0;
285     confess "Usage: runloop(number, [string | coderef])" unless defined $c;
286     my($t0, $t1, $td); # before, after, difference
287
288     # find package of caller so we can execute code there
289     my($curpack) = caller(0);
290     my($i, $pack)= 0;
291     while (($pack) = caller(++$i)) {
292         last if $pack ne $curpack;
293     }
294
295     my $subcode = (ref $c eq 'CODE')
296         ? "sub { package $pack; my(\$_i)=$n; while (\$_i--){&\$c;} }"
297         : "sub { package $pack; my(\$_i)=$n; while (\$_i--){$c;} }";
298     my $subref  = eval $subcode;
299     croak "runloop unable to compile '$c': $@\ncode: $subcode\n" if $@;
300     print STDERR "runloop $n '$subcode'\n" if $debug;
301
302     $t0 = &new;
303     &$subref;
304     $t1 = &new;
305     $td = &timediff($t1, $t0);
306
307     timedebug("runloop:",$td);
308     $td;
309 }
310
311
312 sub timeit {
313     my($n, $code) = @_;
314     my($wn, $wc, $wd);
315
316     printf STDERR "timeit $n $code\n" if $debug;
317
318     if ($cache && exists $cache{$n}) {
319         $wn = $cache{$n};
320     } else {
321         $wn = &runloop($n, '');
322         $cache{$n} = $wn;
323     }
324
325     $wc = &runloop($n, $code);
326
327     $wd = timediff($wc, $wn);
328
329     timedebug("timeit: ",$wc);
330     timedebug("      - ",$wn);
331     timedebug("      = ",$wd);
332
333     $wd;
334 }
335
336 # --- Functions implementing high-level time-then-print utilities
337
338 sub timethis{
339     my($n, $code, $title, $style) = @_;
340     my $t = timeit($n, $code);
341     local $| = 1;
342     $title = "timethis $n" unless defined $title;
343     $style = "" unless defined $style;
344     printf("%10s: ", $title);
345     print timestr($t, $style),"\n";
346
347     # A conservative warning to spot very silly tests.
348     # Don't assume that your benchmark is ok simply because
349     # you don't get this warning!
350     print "            (warning: too few iterations for a reliable count)\n"
351         if     $n < $min_count
352             || ($t->real < 1 && $n < 1000)
353             || $t->cpu_a < $min_cpu;
354     $t;
355 }
356
357 sub timethese{
358     my($n, $alt, $style) = @_;
359     die "usage: timethese(count, { 'Name1'=>'code1', ... }\n"
360                 unless ref $alt eq HASH;
361     my @names = sort keys %$alt;
362     $style = "" unless defined $style;
363     print "Benchmark: timing $n iterations of ",join(', ',@names),"...\n";
364
365     # we could save the results in an array and produce a summary here
366     # sum, min, max, avg etc etc
367     map timethis($n, $alt->{$_}, $_, $style), @names;
368 }
369
370 1;