3 perldebtut - Perl debugging tutorial
7 A (very) lightweight introduction in the use of the perl debugger, and a
8 pointer to existing, deeper sources of information on the subject of debugging
11 There's an extraordinary number of people out there who don't appear to know
12 anything about using the perl debugger, though they use the language every
19 First of all, there's a few things you can do to make your life a lot more
20 straightforward when it comes to debugging perl programs, without using the
21 debugger at all. To demonstrate, here's a simple script with a problem:
25 $var1 = 'Hello World'; # always wanted to do that :-)
31 While this compiles and runs happily, it probably won't do what's expected,
32 namely it doesn't print "Hello World\n" at all; It will on the other hand do
33 exactly what it was told to do, computers being a bit that way inclined. That
34 is, it will print out a newline character, and you'll get what looks like a
35 blank line. It looks like there's 2 variables when (because of the typo)
42 To catch this kind of problem, we can force each variable to be declared
43 before use by pulling in the strict module, by putting 'use strict;' after the
44 first line of the script.
46 Now when you run it, perl complains about the 3 undeclared variables and we
47 get four error messages because one variable is referenced twice:
49 Global symbol "$var1" requires explicit package name at ./t1 line 4.
50 Global symbol "$var2" requires explicit package name at ./t1 line 5.
51 Global symbol "$varl" requires explicit package name at ./t1 line 5.
52 Global symbol "$var2" requires explicit package name at ./t1 line 7.
53 Execution of ./hello aborted due to compilation errors.
55 Luvverly! and to fix this we declare all variables explicitly and now our
56 script looks like this:
61 my $var1 = 'Hello World';
68 We then do (always a good idea) a syntax check before we try to run it again:
73 And now when we run it, we get "\n" still, but at least we know why. Just
74 getting this script to compile has exposed the '$varl' (with the letter 'l)
75 variable, and simply changing $varl to $var1 solves the problem.
78 =head1 Looking at data and -w and v
80 Ok, but how about when you want to really see your data, what's in that
81 dynamic variable, just before using it?
89 'tom' => qw(and jerry),
90 'welcome' => q(Hello World),
93 my @data = keys %data;
95 print "$data{$key}\n";
98 Looks OK, after it's been through the syntax check (perl -c scriptname), we
99 run it and all we get is a blank line again! Hmmmm.
101 One common debugging approach here, would be to liberally sprinkle a few print
102 statements, to add a check just before we print out our data, and another just
105 print "All OK\n" if grep($key, keys %data);
106 print "$data{$key}\n";
107 print "done: '$data{$key}'\n";
116 After much staring at the same piece of code and not seeing the wood for the
117 trees for some time, we get a cup of coffee and try another approach. That
118 is, we bring in the cavalry by giving perl the 'B<-d>' switch on the command
122 Default die handler restored.
124 Loading DB routines from perl5db.pl version 1.07
125 Editor support available.
127 Enter h or `h h' for help, or `man perldebug' for more help.
129 main::(./data:4): my $key = 'welcome';
131 Now, what we've done here is to launch the built-in perl debugger on our
132 script. It's stopped at the first line of executable code and is waiting for
135 Before we go any further, you'll want to know how to quit the debugger: use
136 just the letter 'B<q>', not the words 'quit' or 'exit':
141 That's it, you're back on home turf again.
146 Fire the debugger up again on your script and we'll look at the help menu.
147 There's a couple of ways of calling help: a simple 'B<h>' will get the summary
148 help list, 'B<|h>' (pipe-h) will pipe the help through your pager (which is
149 (probably 'more' or 'less'), and finally, 'B<h h>' (h-space-h) will give you
150 the entire help screen. Here is the summary page:
153 List/search source lines: Control script execution:
154 l [ln|sub] List source code T Stack trace
155 - or . List previous/current line s [expr] Single step [in expr]
156 v [line] View around line n [expr] Next, steps over subs
157 f filename View source in file <CR/Enter> Repeat last n or s
158 /pattern/ ?patt? Search forw/backw r Return from subroutine
159 M Show module versions c [ln|sub] Continue until position
160 Debugger controls: L List break/watch/actions
161 o [...] Set debugger options t [expr] Toggle trace [trace expr]
162 <[<]|{[{]|>[>] [cmd] Do pre/post-prompt b [ln|event|sub] [cnd] Set breakpoint
163 ! [N|pat] Redo a previous command B ln|* Delete a/all breakpoints
164 H [-num] Display last num commands a [ln] cmd Do cmd before line
165 = [a val] Define/list an alias A ln|* Delete a/all actions
166 h [db_cmd] Get help on command w expr Add a watch expression
167 h h Complete help page W expr|* Delete a/all watch expressions
168 |[|]db_cmd Send output to pager ![!] syscmd Run cmd in a subprocess
169 q or ^D Quit R Attempt a restart
170 Data Examination: expr Execute perl code, also see: s,n,t expr
171 x|m expr Evals expr in list context, dumps the result or lists methods.
172 p expr Print expression (uses script's current package).
173 S [[!]pat] List subroutine names [not] matching pattern
174 V [Pk [Vars]] List Variables in Package. Vars can be ~pattern or !pattern.
175 X [Vars] Same as "V current_package [Vars]".
176 For more help, type h cmd_letter, or run man perldebug for all docs.
178 More confusing options than you can shake a big stick at! It's not as bad as
179 it looks and it's very useful to know more about all of it, and fun too!
181 There's a couple of useful ones to know about straight away. You wouldn't
182 think we're using any libraries at all at the moment, but 'B<M>' will show
183 which modules are currently loaded, and their version number, while 'B<m>'
184 will show the methods, and 'B<S>' shows all subroutines (by pattern) as
185 shown below. 'B<V>' and 'B<X>' show variables in the program by package
186 scope and can be constrained by pattern.
194 Using 'X' and cousins requires you not to use the type identifiers ($@%), just
198 FileHandle(stderr) => fileno(2)
200 Remember we're in our tiny program with a problem, we should have a look at
201 where we are, and what our data looks like. First of all let's view some code
202 at our present position (the first line of code in this case), via 'B<v>':
208 4==> my $key = 'welcome';
210 6 'this' => qw(that),
211 7 'tom' => qw(and jerry),
212 8 'welcome' => q(Hello World),
213 9 'zip' => q(welcome),
216 At line number 4 is a helpful pointer, that tells you where you are now. To
217 see more code, type 'v' again:
220 8 'welcome' => q(Hello World),
221 9 'zip' => q(welcome),
223 11: my @data = keys %data;
224 12: print "All OK\n" if grep($key, keys %data);
225 13: print "$data{$key}\n";
226 14: print "done: '$data{$key}'\n";
229 And if you wanted to list line 5 again, type 'l 5', (note the space):
234 In this case, there's not much to see, but of course normally there's pages of
235 stuff to wade through, and 'l' can be very useful. To reset your view to the
236 line we're about to execute, type a lone period '.':
239 main::(./data_a:4): my $key = 'welcome';
241 The line shown is the one that is about to be executed B<next>, it hasn't
242 happened yet. So while we can print a variable with the letter 'B<p>', at
243 this point all we'd get is an empty (undefined) value back. What we need to
244 do is to step through the next executable statement with an 'B<s>':
247 main::(./data_a:5): my %data = (
248 main::(./data_a:6): 'this' => qw(that),
249 main::(./data_a:7): 'tom' => qw(and jerry),
250 main::(./data_a:8): 'welcome' => q(Hello World),
251 main::(./data_a:9): 'zip' => q(welcome),
252 main::(./data_a:10): );
254 Now we can have a look at that first ($key) variable:
259 line 13 is where the action is, so let's continue down to there via the letter
260 'B<c>', which by the way, inserts a 'one-time-only' breakpoint at the given
265 main::(./data_a:13): print "$data{$key}\n";
267 We've gone past our check (where 'All OK' was printed) and have stopped just
268 before the meat of our task. We could try to print out a couple of variables
269 to see what is happening:
273 Not much in there, lets have a look at our hash:
276 Hello Worldziptomandwelcomejerrywelcomethisthat
279 Hello Worldtomwelcomejerrythis
281 Well, this isn't very easy to read, and using the helpful manual (B<h h>), the
282 'B<x>' command looks promising:
296 That's not much help, a couple of welcomes in there, but no indication of
297 which are keys, and which are values, it's just a listed array dump and, in
298 this case, not particularly helpful. The trick here, is to use a B<reference>
299 to the data structure:
303 'Hello World' => 'zip'
309 The reference is truly dumped and we can finally see what we're dealing with.
310 Our quoting was perfectly valid but wrong for our purposes, with 'and jerry'
311 being treated as 2 separate words rather than a phrase, thus throwing the
312 evenly paired hash structure out of alignment.
314 The 'B<-w>' switch would have told us about this, had we used it at the start,
315 and saved us a lot of trouble:
318 Odd number of elements in hash assignment at ./data line 5.
320 We fix our quoting: 'tom' => q(and jerry), and run it again, this time we get
327 While we're here, take a closer look at the 'B<x>' command, it's really useful
328 and will merrily dump out nested references, complete objects, partial objects
329 - just about whatever you throw at it:
331 Let's make a quick object and x-plode it, first we'll start the debugger:
332 it wants some form of input from STDIN, so we give it something non-commital,
336 Default die handler restored.
338 Loading DB routines from perl5db.pl version 1.07
339 Editor support available.
341 Enter h or `h h' for help, or `man perldebug' for more help.
345 Now build an on-the-fly object over a couple of lines (note the backslash):
347 DB<1> $obj = bless({'unique_id'=>'123', 'attr'=> \
348 cont: {'col' => 'black', 'things' => [qw(this that etc)]}}, 'MY_class')
350 And let's have a look at it:
353 0 MY_class=HASH(0x828ad98)
354 'attr' => HASH(0x828ad68)
356 'things' => ARRAY(0x828abb8)
363 Useful, huh? You can eval nearly anything in there, and experiment with bits
364 of code or regexes until the cows come home:
366 DB<3> @data = qw(this that the other atheism leather theory scythe)
368 DB<4> p 'saw -> '.($cnt += map { print "\t:\t$_\n" } grep(/the/, sort @data))
377 If you want to see the command History, type an 'B<H>':
380 4: p 'saw -> '.($cnt += map { print "\t:\t$_\n" } grep(/the/, sort @data))
381 3: @data = qw(this that the other atheism leather theory scythe)
383 1: $obj = bless({'unique_id'=>'123', 'attr'=>
384 {'col' => 'black', 'things' => [qw(this that etc)]}}, 'MY_class')
387 And if you want to repeat any previous command, use the exclamation: 'B<!>':
390 p 'saw -> '.($cnt += map { print "$_\n" } grep(/the/, sort @data))
399 For more on references see L<perlref> and L<perlreftut>
402 =head1 Stepping through code
404 Here's a simple program which converts between Celsius and Fahrenheit, it too
410 my $arg = $ARGV[0] || '-c20';
412 if ($arg =~ /^\-(c|f)((\-|\+)*\d+(\.\d+)*)$/) {
413 my ($deg, $num) = ($1, $2);
414 my ($in, $out) = ($num, $num);
422 $out = sprintf('%0.2f', $out);
423 $out =~ s/^((\-|\+)*\d+)\.0+$/$1/;
426 print "Usage: $0 -[c|f] num\n";
432 my $c = 5 * $f - 32 / 9;
438 my $f = 9 * $c / 5 + 32;
443 For some reason, the Fahrenheit to Celsius conversion fails to return the
444 expected output. This is what it does:
452 Not very consistent! We'll set a breakpoint in the code manually and run it
453 under the debugger to see what's going on. A breakpoint is a flag, to which
454 the debugger will run without interruption, when it reaches the breakpoint, it
455 will stop execution and offer a prompt for further interaction. In normal
456 use, these debugger commands are completely ignored, and they are safe - if a
457 little messy, to leave in production code.
459 my ($in, $out) = ($num, $num);
460 $DB::single=2; # insert at line 9!
464 > perl -d temp -f33.3
465 Default die handler restored.
467 Loading DB routines from perl5db.pl version 1.07
468 Editor support available.
470 Enter h or `h h' for help, or `man perldebug' for more help.
472 main::(temp:4): my $arg = $ARGV[0] || '-c100';
474 We'll simply continue down to our pre-set breakpoint with a 'B<c>':
477 main::(temp:10): if ($deg eq 'c') {
479 Followed by a view command to see where we are:
482 7: my ($deg, $num) = ($1, $2);
483 8: my ($in, $out) = ($num, $num);
485 10==> if ($deg eq 'c') {
487 12: $out = &c2f($num);
490 15: $out = &f2c($num);
493 And a print to show what values we're currently using:
498 We can put another break point on any line beginning with a colon, we'll use
499 line 17 as that's just as we come out of the subroutine, and we'd like to
500 pause there later on:
504 There's no feedback from this, but you can see what breakpoints are set by
505 using the list 'L' command:
509 17: print "$out $deg\n";
512 Note that to delete a breakpoint you use 'd' or 'D'.
514 Now we'll continue down into our subroutine, this time rather than by line
515 number, we'll use the subroutine name, followed by the now familiar 'v':
518 main::f2c(temp:30): my $f = shift;
525 28: my $c = 5 * $f - 32 / 9;
533 Note that if there was a subroutine call between us and line 29, and we wanted
534 to B<single-step> through it, we could use the 'B<s>' command, and to step
535 over it we would use 'B<n>' which would execute the sub, but not descend into
536 it for inspection. In this case though, we simply continue down to line 29:
539 main::f2c(temp:29): return $c;
541 And have a look at the return value:
546 This is not the right answer at all, but the sum looks correct. I wonder if
547 it's anything to do with operator precedence? We'll try a couple of other
548 possibilities with our sum:
550 DB<6> p (5 * $f - 32 / 9)
553 DB<7> p 5 * $f - (32 / 9)
556 DB<8> p (5 * $f) - 32 / 9
559 DB<9> p 5 * ($f - 32) / 9
562 :-) that's more like it! Ok, now we can set our return variable and we'll
563 return out of the sub with an 'r':
565 DB<10> $c = 5 * ($f - 32) / 9
568 scalar context return from main::f2c: 0.722222222222221
570 Looks good, let's just continue off the end of the script:
574 Debugged program terminated. Use q to quit or R to restart,
575 use O inhibit_exit to avoid stopping after program termination,
576 h q, h R or h O to get additional info.
578 A quick fix to the offending line (insert the missing parentheses) in the
579 actual program and we're finished.
582 =head1 Placeholder for a, w, t, T
584 Actions, watch variables, stack traces etc.: on the TODO list.
595 =head1 REGULAR EXPRESSIONS
597 Ever wanted to know what a regex looked like? You'll need perl compiled with
598 the DEBUGGING flag for this one:
600 > perl -Dr -e '/^pe(a)*rl$/i'
601 Compiling REx `^pe(a)*rl$'
607 4: CURLYN[1] {0,32767}(14)
615 floating `'$ at 4..2147483647 (checking floating) stclass `EXACTF <pe>'
616 anchored(BOL) minlen 4
617 Omitting $` $& $' support.
621 Freeing REx: `^pe(a)*rl$'
623 Did you really want to know? :-)
624 For more gory details on getting regular expressions to work, have a look at
625 L<perlre>, L<perlretut>, and to decode the mysterious labels (BOL and CURLYN,
626 etc. above), see L<perldebguts>.
631 To get all the output from your error log, and not miss any messages via
632 helpful operating system buffering, insert a line like this, at the start of
637 To watch the tail of a dynamically growing logfile, (from the command line):
641 Wrapping all die calls in a handler routine can be useful to see how, and from
642 where, they're being called, L<perlvar> has more information:
644 BEGIN { $SIG{__DIE__} = sub { require Carp; Carp::confess(@_) } }
646 Various useful techniques for the redirection of STDOUT and STDERR filehandles
647 are explained in L<perlopentut> and L<perlfaq8>.
652 Just a quick hint here for all those CGI programmers who can't figure out how
653 on earth to get past that 'waiting for input' prompt, when running their CGI
654 script from the command-line, try something like this:
656 > perl -d my_cgi.pl -nodebug
658 Of course L<CGI> and L<perlfaq9> will tell you more.
663 The command line interface is tightly integrated with an B<emacs> extension
664 and there's a B<vi> interface too.
666 You don't have to do this all on the command line, though, there are a few GUI
667 options out there. The nice thing about these is you can wave a mouse over a
668 variable and a dump of its data will appear in an appropriate window, or in a
669 popup balloon, no more tiresome typing of 'x $varname' :-)
671 In particular have a hunt around for the following:
673 B<ptkdb> perlTK based wrapper for the built-in debugger
675 B<ddd> data display debugger
677 B<PerlDevKit> and B<PerlBuilder> are NT specific
679 NB. (more info on these and others would be appreciated).
684 We've seen how to encourage good coding practices with B<use strict> and
685 B<-w>. We can run the perl debugger B<perl -d scriptname> to inspect your
686 data from within the perl debugger with the B<p> and B<x> commands. You can
687 walk through your code, set breakpoints with B<b> and step through that code
688 with B<s> or B<n>, continue with B<c> and return from a sub with B<r>. Fairly
689 intuitive stuff when you get down to it.
691 There is of course lots more to find out about, this has just scratched the
692 surface. The best way to learn more is to use perldoc to find out more about
693 the language, to read the on-line help (L<perldebug> is probably the next
694 place to go), and of course, experiment.
708 Richard Foley <richard@rfi.net> Copyright (c) 2000
713 Various people have made helpful suggestions and contributions, in particular:
715 Ronald J Kimball <rjk@linguist.dartmouth.edu>
717 Hugo van der Sanden <hv@crypt0.demon.co.uk>
719 Peter Scott <Peter@PSDT.com>