This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
[perl #126443] make sure PL_oldbufptr is preserved in scan_heredoc()
[perl5.git] / pod / perlperf.pod
CommitLineData
da096611
RGS
1=head1 NAME
2
3perlperf - Perl Performance and Optimization Techniques
4
5=head1 DESCRIPTION
6
7This is an introduction to the use of performance and optimization techniques
e4866e2e 8which can be used with particular reference to perl programs. While many perl
da096611
RGS
9developers have come from other languages, and can use their prior knowledge
10where appropriate, there are many other people who might benefit from a few
11perl specific pointers. If you want the condensed version, perhaps the best
12advice comes from the renowned Japanese Samurai, Miyamoto Musashi, who said:
13
f185f654 14 "Do Not Engage in Useless Activity"
da096611
RGS
15
16in 1645.
17
18=head1 OVERVIEW
19
20Perhaps the most common mistake programmers make is to attempt to optimize
21their code before a program actually does anything useful - this is a bad idea.
22There's no point in having an extremely fast program that doesn't work. The
23first job is to get a program to I<correctly> do something B<useful>, (not to
24mention ensuring the test suite is fully functional), and only then to consider
25optimizing it. Having decided to optimize existing working code, there are
26several simple but essential steps to consider which are intrinsic to any
27optimization process.
28
29=head2 ONE STEP SIDEWAYS
30
31Firstly, you need to establish a baseline time for the existing code, which
32timing needs to be reliable and repeatable. You'll probably want to use the
c9dab4e9 33C<Benchmark> or C<Devel::NYTProf> modules, or something similar, for this step,
e1020413 34or perhaps the Unix system C<time> utility, whichever is appropriate. See the
da096611
RGS
35base of this document for a longer list of benchmarking and profiling modules,
36and recommended further reading.
37
38=head2 ONE STEP FORWARD
39
40Next, having examined the program for I<hot spots>, (places where the code
41seems to run slowly), change the code with the intention of making it run
42faster. Using version control software, like C<subversion>, will ensure no
43changes are irreversible. It's too easy to fiddle here and fiddle there -
44don't change too much at any one time or you might not discover which piece of
45code B<really> was the slow bit.
46
47=head2 ANOTHER STEP SIDEWAYS
48
49It's not enough to say: "that will make it run faster", you have to check it.
50Rerun the code under control of the benchmarking or profiling modules, from the
51first step above, and check that the new code executed the B<same task> in
52I<less time>. Save your work and repeat...
53
54=head1 GENERAL GUIDELINES
55
56The critical thing when considering performance is to remember there is no such
57thing as a C<Golden Bullet>, which is why there are no rules, only guidelines.
58
59It is clear that inline code is going to be faster than subroutine or method
60calls, because there is less overhead, but this approach has the disadvantage
61of being less maintainable and comes at the cost of greater memory usage -
62there is no such thing as a free lunch. If you are searching for an element in
63a list, it can be more efficient to store the data in a hash structure, and
64then simply look to see whether the key is defined, rather than to loop through
65the entire array using grep() for instance. substr() may be (a lot) faster
66than grep() but not as flexible, so you have another trade-off to access. Your
67code may contain a line which takes 0.01 of a second to execute which if you
68call it 1,000 times, quite likely in a program parsing even medium sized files
69for instance, you already have a 10 second delay, in just one single code
70location, and if you call that line 100,000 times, your entire program will
71slow down to an unbearable crawl.
72
73Using a subroutine as part of your sort is a powerful way to get exactly what
74you want, but will usually be slower than the built-in I<alphabetic> C<cmp> and
75I<numeric> C<E<lt>=E<gt>> sort operators. It is possible to make multiple
76passes over your data, building indices to make the upcoming sort more
77efficient, and to use what is known as the C<OM> (Orcish Maneuver) to cache the
78sort keys in advance. The cache lookup, while a good idea, can itself be a
79source of slowdown by enforcing a double pass over the data - once to setup the
80cache, and once to sort the data. Using C<pack()> to extract the required sort
81key into a consistent string can be an efficient way to build a single string
82to compare, instead of using multiple sort keys, which makes it possible to use
83the standard, written in C<c> and fast, perl C<sort()> function on the output,
84and is the basis of the C<GRT> (Guttman Rossler Transform). Some string
b1fc79bc 85combinations can slow the C<GRT> down, by just being too plain complex for its
da096611
RGS
86own good.
87
88For applications using database backends, the standard C<DBIx> namespace has
89tries to help with keeping things nippy, not least because it tries to I<not>
90query the database until the latest possible moment, but always read the docs
91which come with your choice of libraries. Among the many issues facing
92developers dealing with databases should remain aware of is to always use
93C<SQL> placeholders and to consider pre-fetching data sets when this might
94prove advantageous. Splitting up a large file by assigning multiple processes
95to parsing a single file, using say C<POE>, C<threads> or C<fork> can also be a
96useful way of optimizing your usage of the available C<CPU> resources, though
97this technique is fraught with concurrency issues and demands high attention to
98detail.
99
100Every case has a specific application and one or more exceptions, and there is
101no replacement for running a few tests and finding out which method works best
102for your particular environment, this is why writing optimal code is not an
103exact science, and why we love using Perl so much - TMTOWTDI.
104
105=head1 BENCHMARKS
106
107Here are a few examples to demonstrate usage of Perl's benchmarking tools.
108
109=head2 Assigning and Dereferencing Variables.
110
111I'm sure most of us have seen code which looks like, (or worse than), this:
112
f185f654
KW
113 if ( $obj->{_ref}->{_myscore} >= $obj->{_ref}->{_yourscore} ) {
114 ...
da096611
RGS
115
116This sort of code can be a real eyesore to read, as well as being very
117sensitive to typos, and it's much clearer to dereference the variable
118explicitly. We're side-stepping the issue of working with object-oriented
119programming techniques to encapsulate variable access via methods, only
120accessible through an object. Here we're just discussing the technical
121implementation of choice, and whether this has an effect on performance. We
122can see whether this dereferencing operation, has any overhead by putting
123comparative code in a file and running a C<Benchmark> test.
124
125# dereference
126
f185f654 127 #!/usr/bin/perl
da096611 128
f185f654
KW
129 use strict;
130 use warnings;
da096611 131
f185f654 132 use Benchmark;
da096611 133
f185f654
KW
134 my $ref = {
135 'ref' => {
136 _myscore => '100 + 1',
137 _yourscore => '102 - 1',
138 },
139 };
da096611 140
f185f654
KW
141 timethese(1000000, {
142 'direct' => sub {
143 my $x = $ref->{ref}->{_myscore} . $ref->{ref}->{_yourscore} ;
144 },
145 'dereference' => sub {
146 my $ref = $ref->{ref};
147 my $myscore = $ref->{_myscore};
148 my $yourscore = $ref->{_yourscore};
149 my $x = $myscore . $yourscore;
150 },
151 });
da096611
RGS
152
153It's essential to run any timing measurements a sufficient number of times so
154the numbers settle on a numerical average, otherwise each run will naturally
155fluctuate due to variations in the environment, to reduce the effect of
156contention for C<CPU> resources and network bandwidth for instance. Running
157the above code for one million iterations, we can take a look at the report
158output by the C<Benchmark> module, to see which approach is the most effective.
159
f185f654 160 $> perl dereference
da096611 161
f185f654
KW
162 Benchmark: timing 1000000 iterations of dereference, direct...
163 dereference: 2 wallclock secs ( 1.59 usr + 0.00 sys = 1.59 CPU) @ 628930.82/s (n=1000000)
164 direct: 1 wallclock secs ( 1.20 usr + 0.00 sys = 1.20 CPU) @ 833333.33/s (n=1000000)
da096611
RGS
165
166The difference is clear to see and the dereferencing approach is slower. While
167it managed to execute an average of 628,930 times a second during our test, the
168direct approach managed to run an additional 204,403 times, unfortunately.
169Unfortunately, because there are many examples of code written using the
170multiple layer direct variable access, and it's usually horrible. It is,
e1020413 171however, minusculy faster. The question remains whether the minute gain is
da096611
RGS
172actually worth the eyestrain, or the loss of maintainability.
173
174=head2 Search and replace or tr
175
176If we have a string which needs to be modified, while a regex will almost
177always be much more flexible, C<tr>, an oft underused tool, can still be a
178useful. One scenario might be replace all vowels with another character. The
179regex solution might look like this:
180
f185f654 181 $str =~ s/[aeiou]/x/g
da096611
RGS
182
183The C<tr> alternative might look like this:
184
f185f654 185 $str =~ tr/aeiou/xxxxx/
da096611
RGS
186
187We can put that into a test file which we can run to check which approach is
188the fastest, using a global C<$STR> variable to assign to the C<my $str>
189variable so as to avoid perl trying to optimize any of the work away by
190noticing it's assigned only the once.
191
192# regex-transliterate
193
f185f654 194 #!/usr/bin/perl
da096611 195
f185f654
KW
196 use strict;
197 use warnings;
da096611 198
f185f654 199 use Benchmark;
da096611 200
f185f654 201 my $STR = "$$-this and that";
da096611 202
f185f654
KW
203 timethese( 1000000, {
204 'sr' => sub { my $str = $STR; $str =~ s/[aeiou]/x/g; return $str; },
205 'tr' => sub { my $str = $STR; $str =~ tr/aeiou/xxxxx/; return $str; },
206 });
da096611
RGS
207
208Running the code gives us our results:
209
f185f654 210 $> perl regex-transliterate
da096611 211
f185f654
KW
212 Benchmark: timing 1000000 iterations of sr, tr...
213 sr: 2 wallclock secs ( 1.19 usr + 0.00 sys = 1.19 CPU) @ 840336.13/s (n=1000000)
214 tr: 0 wallclock secs ( 0.49 usr + 0.00 sys = 0.49 CPU) @ 2040816.33/s (n=1000000)
da096611
RGS
215
216The C<tr> version is a clear winner. One solution is flexible, the other is
e1020413 217fast - and it's appropriately the programmer's choice which to use.
da096611
RGS
218
219Check the C<Benchmark> docs for further useful techniques.
220
221=head1 PROFILING TOOLS
222
223A slightly larger piece of code will provide something on which a profiler can
224produce more extensive reporting statistics. This example uses the simplistic
225C<wordmatch> program which parses a given input file and spews out a short
226report on the contents.
227
228# wordmatch
229
f185f654
KW
230 #!/usr/bin/perl
231
232 use strict;
233 use warnings;
234
235 =head1 NAME
236
237 filewords - word analysis of input file
238
239 =head1 SYNOPSIS
240
241 filewords -f inputfilename [-d]
da096611 242
f185f654 243 =head1 DESCRIPTION
da096611 244
f185f654
KW
245 This program parses the given filename, specified with C<-f>, and
246 displays a simple analysis of the words found therein. Use the C<-d>
247 switch to enable debugging messages.
da096611 248
f185f654 249 =cut
da096611 250
f185f654
KW
251 use FileHandle;
252 use Getopt::Long;
da096611 253
f185f654
KW
254 my $debug = 0;
255 my $file = '';
da096611 256
f185f654
KW
257 my $result = GetOptions (
258 'debug' => \$debug,
259 'file=s' => \$file,
260 );
261 die("invalid args") unless $result;
da096611 262
f185f654
KW
263 unless ( -f $file ) {
264 die("Usage: $0 -f filename [-d]");
265 }
266 my $FH = FileHandle->new("< $file")
267 or die("unable to open file($file): $!");
da096611 268
f185f654
KW
269 my $i_LINES = 0;
270 my $i_WORDS = 0;
271 my %count = ();
da096611 272
f185f654
KW
273 my @lines = <$FH>;
274 foreach my $line ( @lines ) {
275 $i_LINES++;
276 $line =~ s/\n//;
277 my @words = split(/ +/, $line);
278 my $i_words = scalar(@words);
279 $i_WORDS = $i_WORDS + $i_words;
280 debug("line: $i_LINES supplying $i_words words: @words");
281 my $i_word = 0;
282 foreach my $word ( @words ) {
283 $i_word++;
284 $count{$i_LINES}{spec} += matches($i_word, $word, '[^a-zA-Z0-9]');
285 $count{$i_LINES}{only} += matches($i_word, $word, '^[^a-zA-Z0-9]+$');
286 $count{$i_LINES}{cons} += matches($i_word, $word, '^[(?i:bcdfghjklmnpqrstvwxyz)]+$');
287 $count{$i_LINES}{vows} += matches($i_word, $word, '^[(?i:aeiou)]+$');
288 $count{$i_LINES}{caps} += matches($i_word, $word, '^[(A-Z)]+$');
289 }
290 }
da096611 291
f185f654 292 print report( %count );
da096611 293
f185f654
KW
294 sub matches {
295 my $i_wd = shift;
296 my $word = shift;
297 my $regex = shift;
298 my $has = 0;
da096611 299
f185f654
KW
300 if ( $word =~ /($regex)/ ) {
301 $has++ if $1;
302 }
da096611 303
f185f654 304 debug("word: $i_wd ".($has ? 'matches' : 'does not match')." chars: /$regex/");
da096611 305
f185f654
KW
306 return $has;
307 }
da096611 308
f185f654
KW
309 sub report {
310 my %report = @_;
311 my %rep;
da096611 312
f185f654
KW
313 foreach my $line ( keys %report ) {
314 foreach my $key ( keys %{ $report{$line} } ) {
315 $rep{$key} += $report{$line}{$key};
316 }
317 }
da096611 318
f185f654
KW
319 my $report = qq|
320 $0 report for $file:
321 lines in file: $i_LINES
322 words in file: $i_WORDS
323 words with special (non-word) characters: $i_spec
324 words with only special (non-word) characters: $i_only
325 words with only consonants: $i_cons
326 words with only capital letters: $i_caps
327 words with only vowels: $i_vows
328 |;
da096611 329
f185f654
KW
330 return $report;
331 }
332
333 sub debug {
334 my $message = shift;
335
336 if ( $debug ) {
337 print STDERR "DBG: $message\n";
338 }
339 }
340
341 exit 0;
da096611
RGS
342
343=head2 Devel::DProf
344
345This venerable module has been the de-facto standard for Perl code profiling
346for more than a decade, but has been replaced by a number of other modules
347which have brought us back to the 21st century. Although you're recommended to
348evaluate your tool from the several mentioned here and from the CPAN list at
349the base of this document, (and currently L<Devel::NYTProf> seems to be the
350weapon of choice - see below), we'll take a quick look at the output from
351L<Devel::DProf> first, to set a baseline for Perl profiling tools. Run the
352above program under the control of C<Devel::DProf> by using the C<-d> switch on
353the command-line.
354
f185f654 355 $> perl -d:DProf wordmatch -f perl5db.pl
da096611 356
f185f654 357 <...multiple lines snipped...>
da096611 358
f185f654
KW
359 wordmatch report for perl5db.pl:
360 lines in file: 9428
361 words in file: 50243
362 words with special (non-word) characters: 20480
363 words with only special (non-word) characters: 7790
364 words with only consonants: 4801
365 words with only capital letters: 1316
366 words with only vowels: 1701
da096611
RGS
367
368C<Devel::DProf> produces a special file, called F<tmon.out> by default, and
369this file is read by the C<dprofpp> program, which is already installed as part
370of the C<Devel::DProf> distribution. If you call C<dprofpp> with no options,
371it will read the F<tmon.out> file in the current directory and produce a human
372readable statistics report of the run of your program. Note that this may take
373a little time.
374
f185f654
KW
375 $> dprofpp
376
377 Total Elapsed Time = 2.951677 Seconds
378 User+System Time = 2.871677 Seconds
379 Exclusive Times
380 %Time ExclSec CumulS #Calls sec/call Csec/c Name
381 102. 2.945 3.003 251215 0.0000 0.0000 main::matches
382 2.40 0.069 0.069 260643 0.0000 0.0000 main::debug
383 1.74 0.050 0.050 1 0.0500 0.0500 main::report
384 1.04 0.030 0.049 4 0.0075 0.0123 main::BEGIN
385 0.35 0.010 0.010 3 0.0033 0.0033 Exporter::as_heavy
386 0.35 0.010 0.010 7 0.0014 0.0014 IO::File::BEGIN
387 0.00 - -0.000 1 - - Getopt::Long::FindOption
388 0.00 - -0.000 1 - - Symbol::BEGIN
389 0.00 - -0.000 1 - - Fcntl::BEGIN
390 0.00 - -0.000 1 - - Fcntl::bootstrap
391 0.00 - -0.000 1 - - warnings::BEGIN
392 0.00 - -0.000 1 - - IO::bootstrap
393 0.00 - -0.000 1 - - Getopt::Long::ConfigDefaults
394 0.00 - -0.000 1 - - Getopt::Long::Configure
395 0.00 - -0.000 1 - - Symbol::gensym
da096611
RGS
396
397C<dprofpp> will produce some quite detailed reporting on the activity of the
398C<wordmatch> program. The wallclock, user and system, times are at the top of
399the analysis, and after this are the main columns defining which define the
400report. Check the C<dprofpp> docs for details of the many options it supports.
401
402See also C<Apache::DProf> which hooks C<Devel::DProf> into C<mod_perl>.
403
404=head2 Devel::Profiler
405
406Let's take a look at the same program using a different profiler:
407C<Devel::Profiler>, a drop-in Perl-only replacement for C<Devel::DProf>. The
408usage is very slightly different in that instead of using the special C<-d:>
409flag, you pull C<Devel::Profiler> in directly as a module using C<-M>.
410
f185f654 411 $> perl -MDevel::Profiler wordmatch -f perl5db.pl
da096611 412
f185f654 413 <...multiple lines snipped...>
da096611 414
f185f654
KW
415 wordmatch report for perl5db.pl:
416 lines in file: 9428
417 words in file: 50243
418 words with special (non-word) characters: 20480
419 words with only special (non-word) characters: 7790
420 words with only consonants: 4801
421 words with only capital letters: 1316
422 words with only vowels: 1701
da096611
RGS
423
424
425C<Devel::Profiler> generates a tmon.out file which is compatible with the
426C<dprofpp> program, thus saving the construction of a dedicated statistics
427reader program. C<dprofpp> usage is therefore identical to the above example.
428
f185f654
KW
429 $> dprofpp
430
431 Total Elapsed Time = 20.984 Seconds
432 User+System Time = 19.981 Seconds
433 Exclusive Times
434 %Time ExclSec CumulS #Calls sec/call Csec/c Name
435 49.0 9.792 14.509 251215 0.0000 0.0001 main::matches
436 24.4 4.887 4.887 260643 0.0000 0.0000 main::debug
437 0.25 0.049 0.049 1 0.0490 0.0490 main::report
438 0.00 0.000 0.000 1 0.0000 0.0000 Getopt::Long::GetOptions
439 0.00 0.000 0.000 2 0.0000 0.0000 Getopt::Long::ParseOptionSpec
440 0.00 0.000 0.000 1 0.0000 0.0000 Getopt::Long::FindOption
441 0.00 0.000 0.000 1 0.0000 0.0000 IO::File::new
442 0.00 0.000 0.000 1 0.0000 0.0000 IO::Handle::new
443 0.00 0.000 0.000 1 0.0000 0.0000 Symbol::gensym
444 0.00 0.000 0.000 1 0.0000 0.0000 IO::File::open
da096611
RGS
445
446Interestingly we get slightly different results, which is mostly because the
447algorithm which generates the report is different, even though the output file
448format was allegedly identical. The elapsed, user and system times are clearly
e1020413 449showing the time it took for C<Devel::Profiler> to execute its own run, but
da096611
RGS
450the column listings feel more accurate somehow than the ones we had earlier
451from C<Devel::DProf>. The 102% figure has disappeared, for example. This is
452where we have to use the tools at our disposal, and recognise their pros and
453cons, before using them. Interestingly, the numbers of calls for each
454subroutine are identical in the two reports, it's the percentages which differ.
455As the author of C<Devel::Proviler> writes:
456
f185f654
KW
457 ...running HTML::Template's test suite under Devel::DProf shows
458 output() taking NO time but Devel::Profiler shows around 10% of the
459 time is in output(). I don't know which to trust but my gut tells me
460 something is wrong with Devel::DProf. HTML::Template::output() is a
461 big routine that's called for every test. Either way, something needs
462 fixing.
da096611
RGS
463
464YMMV.
465
466See also C<Devel::Apache::Profiler> which hooks C<Devel::Profiler> into C<mod_perl>.
467
468=head2 Devel::SmallProf
469
470The C<Devel::SmallProf> profiler examines the runtime of your Perl program and
471produces a line-by-line listing to show how many times each line was called,
472and how long each line took to execute. It is called by supplying the familiar
473C<-d> flag to Perl at runtime.
474
f185f654 475 $> perl -d:SmallProf wordmatch -f perl5db.pl
da096611 476
f185f654 477 <...multiple lines snipped...>
da096611 478
f185f654
KW
479 wordmatch report for perl5db.pl:
480 lines in file: 9428
481 words in file: 50243
482 words with special (non-word) characters: 20480
483 words with only special (non-word) characters: 7790
484 words with only consonants: 4801
485 words with only capital letters: 1316
486 words with only vowels: 1701
da096611
RGS
487
488C<Devel::SmallProf> writes it's output into a file called F<smallprof.out>, by
489default. The format of the file looks like this:
490
f185f654 491 <num> <time> <ctime> <line>:<text>
da096611
RGS
492
493When the program has terminated, the output may be examined and sorted using
494any standard text filtering utilities. Something like the following may be
495sufficient:
496
f185f654
KW
497 $> cat smallprof.out | grep \d*: | sort -k3 | tac | head -n20
498
499 251215 1.65674 7.68000 75: if ( $word =~ /($regex)/ ) {
500 251215 0.03264 4.40000 79: debug("word: $i_wd ".($has ? 'matches' :
501 251215 0.02693 4.10000 81: return $has;
502 260643 0.02841 4.07000 128: if ( $debug ) {
503 260643 0.02601 4.04000 126: my $message = shift;
504 251215 0.02641 3.91000 73: my $has = 0;
505 251215 0.03311 3.71000 70: my $i_wd = shift;
506 251215 0.02699 3.69000 72: my $regex = shift;
507 251215 0.02766 3.68000 71: my $word = shift;
508 50243 0.59726 1.00000 59: $count{$i_LINES}{cons} =
509 50243 0.48175 0.92000 61: $count{$i_LINES}{spec} =
510 50243 0.00644 0.89000 56: my $i_cons = matches($i_word, $word,
511 50243 0.48837 0.88000 63: $count{$i_LINES}{caps} =
512 50243 0.00516 0.88000 58: my $i_caps = matches($i_word, $word, '^[(A-
513 50243 0.00631 0.81000 54: my $i_spec = matches($i_word, $word, '[^a-
514 50243 0.00496 0.80000 57: my $i_vows = matches($i_word, $word,
515 50243 0.00688 0.80000 53: $i_word++;
516 50243 0.48469 0.79000 62: $count{$i_LINES}{only} =
517 50243 0.48928 0.77000 60: $count{$i_LINES}{vows} =
518 50243 0.00683 0.75000 55: my $i_only = matches($i_word, $word, '^[^a-
da096611
RGS
519
520You can immediately see a slightly different focus to the subroutine profiling
521modules, and we start to see exactly which line of code is taking the most
522time. That regex line is looking a bit suspicious, for example. Remember that
523these tools are supposed to be used together, there is no single best way to
524profile your code, you need to use the best tools for the job.
525
526See also C<Apache::SmallProf> which hooks C<Devel::SmallProf> into C<mod_perl>.
527
528=head2 Devel::FastProf
529
530C<Devel::FastProf> is another Perl line profiler. This was written with a view
531to getting a faster line profiler, than is possible with for example
532C<Devel::SmallProf>, because it's written in C<C>. To use C<Devel::FastProf>,
533supply the C<-d> argument to Perl:
534
f185f654 535 $> perl -d:FastProf wordmatch -f perl5db.pl
da096611 536
f185f654 537 <...multiple lines snipped...>
da096611 538
f185f654
KW
539 wordmatch report for perl5db.pl:
540 lines in file: 9428
541 words in file: 50243
542 words with special (non-word) characters: 20480
543 words with only special (non-word) characters: 7790
544 words with only consonants: 4801
545 words with only capital letters: 1316
546 words with only vowels: 1701
da096611
RGS
547
548C<Devel::FastProf> writes statistics to the file F<fastprof.out> in the current
549directory. The output file, which can be specified, can be interpreted by using
550the C<fprofpp> command-line program.
551
f185f654 552 $> fprofpp | head -n20
da096611 553
f185f654
KW
554 # fprofpp output format is:
555 # filename:line time count: source
556 wordmatch:75 3.93338 251215: if ( $word =~ /($regex)/ ) {
557 wordmatch:79 1.77774 251215: debug("word: $i_wd ".($has ? 'matches' : 'does not match')." chars: /$regex/");
558 wordmatch:81 1.47604 251215: return $has;
559 wordmatch:126 1.43441 260643: my $message = shift;
560 wordmatch:128 1.42156 260643: if ( $debug ) {
561 wordmatch:70 1.36824 251215: my $i_wd = shift;
562 wordmatch:71 1.36739 251215: my $word = shift;
563 wordmatch:72 1.35939 251215: my $regex = shift;
da096611
RGS
564
565Straightaway we can see that the number of times each line has been called is
566identical to the C<Devel::SmallProf> output, and the sequence is only very
567slightly different based on the ordering of the amount of time each line took
568to execute, C<if ( $debug ) { > and C<my $message = shift;>, for example. The
569differences in the actual times recorded might be in the algorithm used
570internally, or it could be due to system resource limitations or contention.
571
96090e4f 572See also the L<DBIx::Profile> which will profile database queries running
da096611
RGS
573under the C<DBIx::*> namespace.
574
575=head2 Devel::NYTProf
576
577C<Devel::NYTProf> is the B<next generation> of Perl code profiler, fixing many
578shortcomings in other tools and implementing many cool features. First of all it
579can be used as either a I<line> profiler, a I<block> or a I<subroutine>
580profiler, all at once. It can also use sub-microsecond (100ns) resolution on
581systems which provide C<clock_gettime()>. It can be started and stopped even
582by the program being profiled. It's a one-line entry to profile C<mod_perl>
583applications. It's written in C<c> and is probably the fastest profiler
584available for Perl. The list of coolness just goes on. Enough of that, let's
585see how to it works - just use the familiar C<-d> switch to plug it in and run
586the code.
587
f185f654 588 $> perl -d:NYTProf wordmatch -f perl5db.pl
da096611 589
f185f654
KW
590 wordmatch report for perl5db.pl:
591 lines in file: 9427
592 words in file: 50243
593 words with special (non-word) characters: 20480
594 words with only special (non-word) characters: 7790
595 words with only consonants: 4801
596 words with only capital letters: 1316
597 words with only vowels: 1701
da096611
RGS
598
599C<NYTProf> will generate a report database into the file F<nytprof.out> by
600default. Human readable reports can be generated from here by using the
601supplied C<nytprofhtml> (HTML output) and C<nytprofcsv> (CSV output) programs.
1cecf2c0 602We've used the Unix system C<html2text> utility to convert the
da096611
RGS
603F<nytprof/index.html> file for convenience here.
604
f185f654
KW
605 $> html2text nytprof/index.html
606
607 Performance Profile Index
608 For wordmatch
609 Run on Fri Sep 26 13:46:39 2008
610 Reported on Fri Sep 26 13:47:23 2008
611
612 Top 15 Subroutines -- ordered by exclusive time
613 |Calls |P |F |Inclusive|Exclusive|Subroutine |
614 | | | |Time |Time | |
615 |251215|5 |1 |13.09263 |10.47692 |main:: |matches |
616 |260642|2 |1 |2.71199 |2.71199 |main:: |debug |
617 |1 |1 |1 |0.21404 |0.21404 |main:: |report |
618 |2 |2 |2 |0.00511 |0.00511 |XSLoader:: |load (xsub) |
619 |14 |14|7 |0.00304 |0.00298 |Exporter:: |import |
620 |3 |1 |1 |0.00265 |0.00254 |Exporter:: |as_heavy |
621 |10 |10|4 |0.00140 |0.00140 |vars:: |import |
622 |13 |13|1 |0.00129 |0.00109 |constant:: |import |
623 |1 |1 |1 |0.00360 |0.00096 |FileHandle:: |import |
624 |3 |3 |3 |0.00086 |0.00074 |warnings::register::|import |
625 |9 |3 |1 |0.00036 |0.00036 |strict:: |bits |
626 |13 |13|13|0.00032 |0.00029 |strict:: |import |
627 |2 |2 |2 |0.00020 |0.00020 |warnings:: |import |
628 |2 |1 |1 |0.00020 |0.00020 |Getopt::Long:: |ParseOptionSpec|
629 |7 |7 |6 |0.00043 |0.00020 |strict:: |unimport |
630
631 For more information see the full list of 189 subroutines.
da096611
RGS
632
633The first part of the report already shows the critical information regarding
634which subroutines are using the most time. The next gives some statistics
635about the source files profiled.
636
f185f654
KW
637 Source Code Files -- ordered by exclusive time then name
638 |Stmts |Exclusive|Avg. |Reports |Source File |
639 | |Time | | | |
640 |2699761|15.66654 |6e-06 |line . block . sub|wordmatch |
641 |35 |0.02187 |0.00062|line . block . sub|IO/Handle.pm |
642 |274 |0.01525 |0.00006|line . block . sub|Getopt/Long.pm |
643 |20 |0.00585 |0.00029|line . block . sub|Fcntl.pm |
644 |128 |0.00340 |0.00003|line . block . sub|Exporter/Heavy.pm |
645 |42 |0.00332 |0.00008|line . block . sub|IO/File.pm |
646 |261 |0.00308 |0.00001|line . block . sub|Exporter.pm |
647 |323 |0.00248 |8e-06 |line . block . sub|constant.pm |
648 |12 |0.00246 |0.00021|line . block . sub|File/Spec/Unix.pm |
649 |191 |0.00240 |0.00001|line . block . sub|vars.pm |
650 |77 |0.00201 |0.00003|line . block . sub|FileHandle.pm |
651 |12 |0.00198 |0.00016|line . block . sub|Carp.pm |
652 |14 |0.00175 |0.00013|line . block . sub|Symbol.pm |
653 |15 |0.00130 |0.00009|line . block . sub|IO.pm |
654 |22 |0.00120 |0.00005|line . block . sub|IO/Seekable.pm |
655 |198 |0.00085 |4e-06 |line . block . sub|warnings/register.pm|
656 |114 |0.00080 |7e-06 |line . block . sub|strict.pm |
657 |47 |0.00068 |0.00001|line . block . sub|warnings.pm |
658 |27 |0.00054 |0.00002|line . block . sub|overload.pm |
659 |9 |0.00047 |0.00005|line . block . sub|SelectSaver.pm |
660 |13 |0.00045 |0.00003|line . block . sub|File/Spec.pm |
661 |2701595|15.73869 | |Total |
662 |128647 |0.74946 | |Average |
663 | |0.00201 |0.00003|Median |
664 | |0.00121 |0.00003|Deviation |
665
666 Report produced by the NYTProf 2.03 Perl profiler, developed by Tim Bunce and
667 Adam Kaplan.
da096611
RGS
668
669At this point, if you're using the I<html> report, you can click through the
670various links to bore down into each subroutine and each line of code. Because
671we're using the text reporting here, and there's a whole directory full of
672reports built for each source file, we'll just display a part of the
673corresponding F<wordmatch-line.html> file, sufficient to give an idea of the
674sort of output you can expect from this cool tool.
675
f185f654
KW
676 $> html2text nytprof/wordmatch-line.html
677
678 Performance Profile -- -block view-.-line view-.-sub view-
679 For wordmatch
680 Run on Fri Sep 26 13:46:39 2008
681 Reported on Fri Sep 26 13:47:22 2008
682
683 File wordmatch
684
685 Subroutines -- ordered by exclusive time
686 |Calls |P|F|Inclusive|Exclusive|Subroutine |
687 | | | |Time |Time | |
688 |251215|5|1|13.09263 |10.47692 |main::|matches|
689 |260642|2|1|2.71199 |2.71199 |main::|debug |
690 |1 |1|1|0.21404 |0.21404 |main::|report |
691 |0 |0|0|0 |0 |main::|BEGIN |
692
693
694 |Line|Stmts.|Exclusive|Avg. |Code |
695 | | |Time | | |
696 |1 | | | |#!/usr/bin/perl |
697 |2 | | | | |
698 | | | | |use strict; |
699 |3 |3 |0.00086 |0.00029|# spent 0.00003s making 1 calls to strict:: |
700 | | | | |import |
701 | | | | |use warnings; |
702 |4 |3 |0.01563 |0.00521|# spent 0.00012s making 1 calls to warnings:: |
703 | | | | |import |
704 |5 | | | | |
705 |6 | | | |=head1 NAME |
706 |7 | | | | |
707 |8 | | | |filewords - word analysis of input file |
708 <...snip...>
709 |62 |1 |0.00445 |0.00445|print report( %count ); |
710 | | | | |# spent 0.21404s making 1 calls to main::report|
711 |63 | | | | |
712 | | | | |# spent 23.56955s (10.47692+2.61571) within |
713 | | | | |main::matches which was called 251215 times, |
714 | | | | |avg 0.00005s/call: # 50243 times |
715 | | | | |(2.12134+0.51939s) at line 57 of wordmatch, avg|
716 | | | | |0.00005s/call # 50243 times (2.17735+0.54550s) |
717 |64 | | | |at line 56 of wordmatch, avg 0.00005s/call # |
718 | | | | |50243 times (2.10992+0.51797s) at line 58 of |
719 | | | | |wordmatch, avg 0.00005s/call # 50243 times |
720 | | | | |(2.12696+0.51598s) at line 55 of wordmatch, avg|
721 | | | | |0.00005s/call # 50243 times (1.94134+0.51687s) |
722 | | | | |at line 54 of wordmatch, avg 0.00005s/call |
723 | | | | |sub matches { |
724 <...snip...>
725 |102 | | | | |
726 | | | | |# spent 2.71199s within main::debug which was |
727 | | | | |called 260642 times, avg 0.00001s/call: # |
728 | | | | |251215 times (2.61571+0s) by main::matches at |
729 |103 | | | |line 74 of wordmatch, avg 0.00001s/call # 9427 |
730 | | | | |times (0.09628+0s) at line 50 of wordmatch, avg|
731 | | | | |0.00001s/call |
732 | | | | |sub debug { |
733 |104 |260642|0.58496 |2e-06 |my $message = shift; |
734 |105 | | | | |
735 |106 |260642|1.09917 |4e-06 |if ( $debug ) { |
736 |107 | | | |print STDERR "DBG: $message\n"; |
737 |108 | | | |} |
738 |109 | | | |} |
739 |110 | | | | |
740 |111 |1 |0.01501 |0.01501|exit 0; |
741 |112 | | | | |
da096611
RGS
742
743Oodles of very useful information in there - this seems to be the way forward.
744
745See also C<Devel::NYTProf::Apache> which hooks C<Devel::NYTProf> into C<mod_perl>.
746
747=head1 SORTING
748
749Perl modules are not the only tools a performance analyst has at their
750disposal, system tools like C<time> should not be overlooked as the next
751example shows, where we take a quick look at sorting. Many books, theses and
752articles, have been written about efficient sorting algorithms, and this is not
753the place to repeat such work, there's several good sorting modules which
754deserve taking a look at too: C<Sort::Maker>, C<Sort::Key> spring to mind.
755However, it's still possible to make some observations on certain Perl specific
756interpretations on issues relating to sorting data sets and give an example or
757two with regard to how sorting large data volumes can effect performance.
758Firstly, an often overlooked point when sorting large amounts of data, one can
759attempt to reduce the data set to be dealt with and in many cases C<grep()> can
760be quite useful as a simple filter:
761
f185f654 762 @data = sort grep { /$filter/ } @incoming
da096611
RGS
763
764A command such as this can vastly reduce the volume of material to actually
765sort through in the first place, and should not be too lightly disregarded
e1020413 766purely on the basis of its simplicity. The C<KISS> principle is too often
da096611
RGS
767overlooked - the next example uses the simple system C<time> utility to
768demonstrate. Let's take a look at an actual example of sorting the contents of
769a large file, an apache logfile would do. This one has over a quarter of a
770million lines, is 50M in size, and a snippet of it looks like this:
771
772# logfile
773
f185f654
KW
774 188.209-65-87.adsl-dyn.isp.belgacom.be - - [08/Feb/2007:12:57:16 +0000] "GET /favicon.ico HTTP/1.1" 404 209 "-" "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1)"
775 188.209-65-87.adsl-dyn.isp.belgacom.be - - [08/Feb/2007:12:57:16 +0000] "GET /favicon.ico HTTP/1.1" 404 209 "-" "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1)"
776 151.56.71.198 - - [08/Feb/2007:12:57:41 +0000] "GET /suse-on-vaio.html HTTP/1.1" 200 2858 "http://www.linux-on-laptops.com/sony.html" "Mozilla/5.0 (Windows; U; Windows NT 5.2; en-US; rv:1.8.1.1) Gecko/20061204 Firefox/2.0.0.1"
777 151.56.71.198 - - [08/Feb/2007:12:57:42 +0000] "GET /data/css HTTP/1.1" 404 206 "http://www.rfi.net/suse-on-vaio.html" "Mozilla/5.0 (Windows; U; Windows NT 5.2; en-US; rv:1.8.1.1) Gecko/20061204 Firefox/2.0.0.1"
778 151.56.71.198 - - [08/Feb/2007:12:57:43 +0000] "GET /favicon.ico HTTP/1.1" 404 209 "-" "Mozilla/5.0 (Windows; U; Windows NT 5.2; en-US; rv:1.8.1.1) Gecko/20061204 Firefox/2.0.0.1"
779 217.113.68.60 - - [08/Feb/2007:13:02:15 +0000] "GET / HTTP/1.1" 304 - "-" "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1)"
780 217.113.68.60 - - [08/Feb/2007:13:02:16 +0000] "GET /data/css HTTP/1.1" 404 206 "http://www.rfi.net/" "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1)"
781 debora.to.isac.cnr.it - - [08/Feb/2007:13:03:58 +0000] "GET /suse-on-vaio.html HTTP/1.1" 200 2858 "http://www.linux-on-laptops.com/sony.html" "Mozilla/5.0 (compatible; Konqueror/3.4; Linux) KHTML/3.4.0 (like Gecko)"
782 debora.to.isac.cnr.it - - [08/Feb/2007:13:03:58 +0000] "GET /data/css HTTP/1.1" 404 206 "http://www.rfi.net/suse-on-vaio.html" "Mozilla/5.0 (compatible; Konqueror/3.4; Linux) KHTML/3.4.0 (like Gecko)"
783 debora.to.isac.cnr.it - - [08/Feb/2007:13:03:58 +0000] "GET /favicon.ico HTTP/1.1" 404 209 "-" "Mozilla/5.0 (compatible; Konqueror/3.4; Linux) KHTML/3.4.0 (like Gecko)"
784 195.24.196.99 - - [08/Feb/2007:13:26:48 +0000] "GET / HTTP/1.0" 200 3309 "-" "Mozilla/5.0 (Windows; U; Windows NT 5.1; fr; rv:1.8.0.9) Gecko/20061206 Firefox/1.5.0.9"
785 195.24.196.99 - - [08/Feb/2007:13:26:58 +0000] "GET /data/css HTTP/1.0" 404 206 "http://www.rfi.net/" "Mozilla/5.0 (Windows; U; Windows NT 5.1; fr; rv:1.8.0.9) Gecko/20061206 Firefox/1.5.0.9"
786 195.24.196.99 - - [08/Feb/2007:13:26:59 +0000] "GET /favicon.ico HTTP/1.0" 404 209 "-" "Mozilla/5.0 (Windows; U; Windows NT 5.1; fr; rv:1.8.0.9) Gecko/20061206 Firefox/1.5.0.9"
787 crawl1.cosmixcorp.com - - [08/Feb/2007:13:27:57 +0000] "GET /robots.txt HTTP/1.0" 200 179 "-" "voyager/1.0"
788 crawl1.cosmixcorp.com - - [08/Feb/2007:13:28:25 +0000] "GET /links.html HTTP/1.0" 200 3413 "-" "voyager/1.0"
789 fhm226.internetdsl.tpnet.pl - - [08/Feb/2007:13:37:32 +0000] "GET /suse-on-vaio.html HTTP/1.1" 200 2858 "http://www.linux-on-laptops.com/sony.html" "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1)"
790 fhm226.internetdsl.tpnet.pl - - [08/Feb/2007:13:37:34 +0000] "GET /data/css HTTP/1.1" 404 206 "http://www.rfi.net/suse-on-vaio.html" "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1)"
791 80.247.140.134 - - [08/Feb/2007:13:57:35 +0000] "GET / HTTP/1.1" 200 3309 "-" "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; .NET CLR 1.1.4322)"
792 80.247.140.134 - - [08/Feb/2007:13:57:37 +0000] "GET /data/css HTTP/1.1" 404 206 "http://www.rfi.net" "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; .NET CLR 1.1.4322)"
793 pop.compuscan.co.za - - [08/Feb/2007:14:10:43 +0000] "GET / HTTP/1.1" 200 3309 "-" "www.clamav.net"
794 livebot-207-46-98-57.search.live.com - - [08/Feb/2007:14:12:04 +0000] "GET /robots.txt HTTP/1.0" 200 179 "-" "msnbot/1.0 (+http://search.msn.com/msnbot.htm)"
795 livebot-207-46-98-57.search.live.com - - [08/Feb/2007:14:12:04 +0000] "GET /html/oracle.html HTTP/1.0" 404 214 "-" "msnbot/1.0 (+http://search.msn.com/msnbot.htm)"
796 dslb-088-064-005-154.pools.arcor-ip.net - - [08/Feb/2007:14:12:15 +0000] "GET / HTTP/1.1" 200 3309 "-" "www.clamav.net"
797 196.201.92.41 - - [08/Feb/2007:14:15:01 +0000] "GET / HTTP/1.1" 200 3309 "-" "MOT-L7/08.B7.DCR MIB/2.2.1 Profile/MIDP-2.0 Configuration/CLDC-1.1"
da096611
RGS
798
799The specific task here is to sort the 286,525 lines of this file by Response
800Code, Query, Browser, Referring Url, and lastly Date. One solution might be to
801use the following code, which iterates over the files given on the
802command-line.
803
804# sort-apache-log
805
f185f654
KW
806 #!/usr/bin/perl -n
807
808 use strict;
809 use warnings;
810
811 my @data;
812
813 LINE:
814 while ( <> ) {
815 my $line = $_;
816 if (
817 $line =~ m/^(
818 ([\w\.\-]+) # client
819 \s*-\s*-\s*\[
820 ([^]]+) # date
821 \]\s*"\w+\s*
822 (\S+) # query
823 [^"]+"\s*
824 (\d+) # status
825 \s+\S+\s+"[^"]*"\s+"
826 ([^"]*) # browser
827 "
828 .*
829 )$/x
830 ) {
831 my @chunks = split(/ +/, $line);
832 my $ip = $1;
833 my $date = $2;
834 my $query = $3;
835 my $status = $4;
836 my $browser = $5;
837
838 push(@data, [$ip, $date, $query, $status, $browser, $line]);
839 }
840 }
841
842 my @sorted = sort {
843 $a->[3] cmp $b->[3]
844 ||
845 $a->[2] cmp $b->[2]
846 ||
847 $a->[0] cmp $b->[0]
848 ||
849 $a->[1] cmp $b->[1]
850 ||
851 $a->[4] cmp $b->[4]
852 } @data;
853
854 foreach my $data ( @sorted ) {
855 print $data->[5];
856 }
857
858 exit 0;
da096611
RGS
859
860When running this program, redirect C<STDOUT> so it is possible to check the
861output is correct from following test runs and use the system C<time> utility
862to check the overall runtime.
863
f185f654 864 $> time ./sort-apache-log logfile > out-sort
da096611 865
f185f654
KW
866 real 0m17.371s
867 user 0m15.757s
868 sys 0m0.592s
da096611
RGS
869
870The program took just over 17 wallclock seconds to run. Note the different
871values C<time> outputs, it's important to always use the same one, and to not
872confuse what each one means.
873
874=over 4
875
876=item Elapsed Real Time
877
878The overall, or wallclock, time between when C<time> was called, and when it
879terminates. The elapsed time includes both user and system times, and time
880spent waiting for other users and processes on the system. Inevitably, this is
881the most approximate of the measurements given.
882
883=item User CPU Time
884
885The user time is the amount of time the entire process spent on behalf of the
886user on this system executing this program.
887
888=item System CPU Time
889
890The system time is the amount of time the kernel itself spent executing
891routines, or system calls, on behalf of this process user.
892
893=back
894
895Running this same process as a C<Schwarzian Transform> it is possible to
896eliminate the input and output arrays for storing all the data, and work on the
897input directly as it arrives too. Otherwise, the code looks fairly similar:
898
899# sort-apache-log-schwarzian
900
f185f654
KW
901 #!/usr/bin/perl -n
902
903 use strict;
904 use warnings;
905
906 print
907
908 map $_->[0] =>
909
910 sort {
911 $a->[4] cmp $b->[4]
912 ||
913 $a->[3] cmp $b->[3]
914 ||
915 $a->[1] cmp $b->[1]
916 ||
917 $a->[2] cmp $b->[2]
918 ||
919 $a->[5] cmp $b->[5]
920 }
921 map [ $_, m/^(
922 ([\w\.\-]+) # client
923 \s*-\s*-\s*\[
924 ([^]]+) # date
925 \]\s*"\w+\s*
926 (\S+) # query
927 [^"]+"\s*
928 (\d+) # status
929 \s+\S+\s+"[^"]*"\s+"
930 ([^"]*) # browser
931 "
932 .*
933 )$/xo ]
934
935 => <>;
936
937 exit 0;
da096611
RGS
938
939Run the new code against the same logfile, as above, to check the new time.
940
f185f654 941 $> time ./sort-apache-log-schwarzian logfile > out-schwarz
da096611 942
f185f654
KW
943 real 0m9.664s
944 user 0m8.873s
945 sys 0m0.704s
da096611
RGS
946
947The time has been cut in half, which is a respectable speed improvement by any
948standard. Naturally, it is important to check the output is consistent with
e1020413 949the first program run, this is where the Unix system C<cksum> utility comes in.
da096611 950
f185f654
KW
951 $> cksum out-sort out-schwarz
952 3044173777 52029194 out-sort
953 3044173777 52029194 out-schwarz
da096611
RGS
954
955BTW. Beware too of pressure from managers who see you speed a program up by 50%
956of the runtime once, only to get a request one month later to do the same again
b1fc79bc 957(true story) - you'll just have to point out you're only human, even if you are a
da096611
RGS
958Perl programmer, and you'll see what you can do...
959
960=head1 LOGGING
961
962An essential part of any good development process is appropriate error handling
963with appropriately informative messages, however there exists a school of
964thought which suggests that log files should be I<chatty>, as if the chain of
965unbroken output somehow ensures the survival of the program. If speed is in
966any way an issue, this approach is wrong.
967
968A common sight is code which looks something like this:
969
f185f654 970 logger->debug( "A logging message via process-id: $$ INC: " . Dumper(\%INC) )
da096611
RGS
971
972The problem is that this code will always be parsed and executed, even when the
973debug level set in the logging configuration file is zero. Once the debug()
974subroutine has been entered, and the internal C<$debug> variable confirmed to
975be zero, for example, the message which has been sent in will be discarded and
b1fc79bc 976the program will continue. In the example given though, the C<\%INC> hash will
da096611
RGS
977already have been dumped, and the message string constructed, all of which work
978could be bypassed by a debug variable at the statement level, like this:
979
f185f654 980 logger->debug( "A logging message via process-id: $$ INC: " . Dumper(\%INC) ) if $DEBUG;
da096611
RGS
981
982This effect can be demonstrated by setting up a test script with both forms,
983including a C<debug()> subroutine to emulate typical C<logger()> functionality.
984
985# ifdebug
986
f185f654 987 #!/usr/bin/perl
da096611 988
f185f654
KW
989 use strict;
990 use warnings;
da096611 991
f185f654
KW
992 use Benchmark;
993 use Data::Dumper;
994 my $DEBUG = 0;
da096611 995
f185f654
KW
996 sub debug {
997 my $msg = shift;
da096611 998
f185f654
KW
999 if ( $DEBUG ) {
1000 print "DEBUG: $msg\n";
1001 }
1002 };
da096611 1003
f185f654
KW
1004 timethese(100000, {
1005 'debug' => sub {
1006 debug( "A $0 logging message via process-id: $$" . Dumper(\%INC) )
1007 },
1008 'ifdebug' => sub {
1009 debug( "A $0 logging message via process-id: $$" . Dumper(\%INC) ) if $DEBUG
1010 },
1011 });
da096611
RGS
1012
1013Let's see what C<Benchmark> makes of this:
1014
f185f654
KW
1015 $> perl ifdebug
1016 Benchmark: timing 100000 iterations of constant, sub...
1017 ifdebug: 0 wallclock secs ( 0.01 usr + 0.00 sys = 0.01 CPU) @ 10000000.00/s (n=100000)
1018 (warning: too few iterations for a reliable count)
1019 debug: 14 wallclock secs (13.18 usr + 0.04 sys = 13.22 CPU) @ 7564.30/s (n=100000)
da096611
RGS
1020
1021In the one case the code, which does exactly the same thing as far as
1022outputting any debugging information is concerned, in other words nothing,
1023takes 14 seconds, and in the other case the code takes one hundredth of a
1024second. Looks fairly definitive. Use a C<$DEBUG> variable BEFORE you call the
1025subroutine, rather than relying on the smart functionality inside it.
1026
1027=head2 Logging if DEBUG (constant)
1028
1029It's possible to take the previous idea a little further, by using a compile
1030time C<DEBUG> constant.
1031
1032# ifdebug-constant
1033
f185f654
KW
1034 #!/usr/bin/perl
1035
1036 use strict;
1037 use warnings;
1038
1039 use Benchmark;
1040 use Data::Dumper;
1041 use constant
1042 DEBUG => 0
1043 ;
1044
1045 sub debug {
1046 if ( DEBUG ) {
1047 my $msg = shift;
1048 print "DEBUG: $msg\n";
1049 }
1050 };
1051
1052 timethese(100000, {
1053 'debug' => sub {
1054 debug( "A $0 logging message via process-id: $$" . Dumper(\%INC) )
1055 },
1056 'constant' => sub {
1057 debug( "A $0 logging message via process-id: $$" . Dumper(\%INC) ) if DEBUG
1058 },
1059 });
da096611
RGS
1060
1061Running this program produces the following output:
1062
f185f654
KW
1063 $> perl ifdebug-constant
1064 Benchmark: timing 100000 iterations of constant, sub...
1065 constant: 0 wallclock secs (-0.00 usr + 0.00 sys = -0.00 CPU) @ -7205759403792793600000.00/s (n=100000)
1066 (warning: too few iterations for a reliable count)
1067 sub: 14 wallclock secs (13.09 usr + 0.00 sys = 13.09 CPU) @ 7639.42/s (n=100000)
da096611
RGS
1068
1069The C<DEBUG> constant wipes the floor with even the C<$debug> variable,
1070clocking in at minus zero seconds, and generates a "warning: too few iterations
1071for a reliable count" message into the bargain. To see what is really going
1072on, and why we had too few iterations when we thought we asked for 100000, we
1073can use the very useful C<B::Deparse> to inspect the new code:
1074
f185f654
KW
1075 $> perl -MO=Deparse ifdebug-constant
1076
1077 use Benchmark;
1078 use Data::Dumper;
1079 use constant ('DEBUG', 0);
1080 sub debug {
1081 use warnings;
1082 use strict 'refs';
1083 0;
1084 }
1085 use warnings;
1086 use strict 'refs';
1087 timethese(100000, {'sub', sub {
1088 debug "A $0 logging message via process-id: $$" . Dumper(\%INC);
1089 }
1090 , 'constant', sub {
1091 0;
1092 }
1093 });
1094 ifdebug-constant syntax OK
da096611
RGS
1095
1096The output shows the constant() subroutine we're testing being replaced with
1097the value of the C<DEBUG> constant: zero. The line to be tested has been
1098completely optimized away, and you can't get much more efficient than that.
1099
1100=head1 POSTSCRIPT
1101
1102This document has provided several way to go about identifying hot-spots, and
1103checking whether any modifications have improved the runtime of the code.
1104
1105As a final thought, remember that it's not (at the time of writing) possible to
1106produce a useful program which will run in zero or negative time and this basic
1107principle can be written as: I<useful programs are slow> by their very
1108definition. It is of course possible to write a nearly instantaneous program,
1109but it's not going to do very much, here's a very efficient one:
1110
f185f654 1111 $> perl -e 0
da096611
RGS
1112
1113Optimizing that any further is a job for C<p5p>.
1114
1115=head1 SEE ALSO
1116
1117Further reading can be found using the modules and links below.
1118
1119=head2 PERLDOCS
1120
ea8b8ad2 1121For example: C<perldoc -f sort>.
da096611 1122
ea8b8ad2
VP
1123L<perlfaq4>.
1124
1125L<perlfork>, L<perlfunc>, L<perlretut>, L<perlthrtut>.
1126
1127L<threads>.
da096611
RGS
1128
1129=head2 MAN PAGES
1130
ea8b8ad2 1131C<time>.
da096611
RGS
1132
1133=head2 MODULES
1134
1135It's not possible to individually showcase all the performance related code for
1136Perl here, naturally, but here's a short list of modules from the CPAN which
1137deserve further attention.
1138
f185f654
KW
1139 Apache::DProf
1140 Apache::SmallProf
1141 Benchmark
1142 DBIx::Profile
1143 Devel::AutoProfiler
1144 Devel::DProf
1145 Devel::DProfLB
1146 Devel::FastProf
1147 Devel::GraphVizProf
1148 Devel::NYTProf
1149 Devel::NYTProf::Apache
1150 Devel::Profiler
1151 Devel::Profile
1152 Devel::Profit
1153 Devel::SmallProf
1154 Devel::WxProf
1155 POE::Devel::Profiler
1156 Sort::Key
1157 Sort::Maker
da096611
RGS
1158
1159=head2 URLS
1160
1161Very useful online reference material:
1162
f185f654 1163 http://www.ccl4.org/~nick/P/Fast_Enough/
da096611 1164
f185f654 1165 http://www-128.ibm.com/developerworks/library/l-optperl.html
da096611 1166
f185f654 1167 http://perlbuzz.com/2007/11/bind-output-variables-in-dbi-for-speed-and-safety.html
da096611 1168
f185f654 1169 http://en.wikipedia.org/wiki/Performance_analysis
da096611 1170
f185f654 1171 http://apache.perl.org/docs/1.0/guide/performance.html
da096611 1172
f185f654 1173 http://perlgolf.sourceforge.net/
da096611 1174
f185f654 1175 http://www.sysarch.com/Perl/sort_paper.html
da096611 1176
da096611
RGS
1177=head1 AUTHOR
1178
1179Richard Foley <richard.foley@rfi.net> Copyright (c) 2008
1180
1181=cut