This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
2772a2fc1c5ff08401ecd0b7b774a85432452ed2
[perl5.git] / pod / perldebguts.pod
1 =head1 NAME
2
3 perldebguts - Guts of Perl debugging 
4
5 =head1 DESCRIPTION
6
7 This is not L<perldebug>, which tells you how to use
8 the debugger.  This manpage describes low-level details concerning
9 the debugger's internals, which range from difficult to impossible
10 to understand for anyone who isn't incredibly intimate with Perl's guts.
11 Caveat lector.
12
13 =head1 Debugger Internals
14
15 Perl has special debugging hooks at compile-time and run-time used
16 to create debugging environments.  These hooks are not to be confused
17 with the I<perl -Dxxx> command described in L<perlrun>, which is
18 usable only if a special Perl is built per the instructions in the
19 F<INSTALL> podpage in the Perl source tree.
20
21 For example, whenever you call Perl's built-in C<caller> function
22 from the package C<DB>, the arguments that the corresponding stack
23 frame was called with are copied to the C<@DB::args> array.  These
24 mechanisms are enabled by calling Perl with the B<-d> switch.
25 Specifically, the following additional features are enabled
26 (cf. L<perlvar/$^P>):
27
28 =over 4
29
30 =item *
31
32 Perl inserts the contents of C<$ENV{PERL5DB}> (or C<BEGIN {require
33 'perl5db.pl'}> if not present) before the first line of your program.
34
35 =item *
36
37 Each array C<@{"_<$filename"}> holds the lines of $filename for a
38 file compiled by Perl.  The same is also true for C<eval>ed strings
39 that contain subroutines, or which are currently being executed.
40 The $filename for C<eval>ed strings looks like C<(eval 34)>.
41
42 Values in this array are magical in numeric context: they compare
43 equal to zero only if the line is not breakable.
44
45 =item *
46
47 Each hash C<%{"_<$filename"}> contains breakpoints and actions keyed
48 by line number.  Individual entries (as opposed to the whole hash)
49 are settable.  Perl only cares about Boolean true here, although
50 the values used by F<perl5db.pl> have the form
51 C<"$break_condition\0$action">.  
52
53 The same holds for evaluated strings that contain subroutines, or
54 which are currently being executed.  The $filename for C<eval>ed strings
55 looks like C<(eval 34)>.
56
57 =item *
58
59 Each scalar C<${"_<$filename"}> contains C<"_<$filename">.  This is
60 also the case for evaluated strings that contain subroutines, or
61 which are currently being executed.  The $filename for C<eval>ed
62 strings looks like C<(eval 34)>.
63
64 =item *
65
66 After each C<require>d file is compiled, but before it is executed,
67 C<DB::postponed(*{"_<$filename"})> is called if the subroutine
68 C<DB::postponed> exists.  Here, the $filename is the expanded name of
69 the C<require>d file, as found in the values of %INC.
70
71 =item *
72
73 After each subroutine C<subname> is compiled, the existence of
74 C<$DB::postponed{subname}> is checked.  If this key exists,
75 C<DB::postponed(subname)> is called if the C<DB::postponed> subroutine
76 also exists.
77
78 =item *
79
80 A hash C<%DB::sub> is maintained, whose keys are subroutine names
81 and whose values have the form C<filename:startline-endline>.
82 C<filename> has the form C<(eval 34)> for subroutines defined inside
83 C<eval>s.
84
85 =item *
86
87 When the execution of your program reaches a point that can hold a
88 breakpoint, the C<DB::DB()> subroutine is called if any of the variables
89 C<$DB::trace>, C<$DB::single>, or C<$DB::signal> is true.  These variables
90 are not C<local>izable.  This feature is disabled when executing
91 inside C<DB::DB()>, including functions called from it 
92 unless C<< $^D & (1<<30) >> is true.
93
94 =item *
95
96 When execution of the program reaches a subroutine call, a call to
97 C<&DB::sub>(I<args>) is made instead, with C<$DB::sub> set to identify
98 the called subroutine.  (This doesn't happen if the calling subroutine
99 was compiled in the C<DB> package.)  C<$DB::sub> normally holds the name
100 of the called subroutine, if it has a name by which it can be looked up.
101 Failing that, C<$DB::sub> will hold a reference to the called subroutine.
102 Either way, the C<&DB::sub> subroutine can use C<$DB::sub> as a reference
103 by which to call the called subroutine, which it will normally want to do.
104
105 X<&DB::lsub>If the call is to an lvalue subroutine, and C<&DB::lsub>
106 is defined C<&DB::lsub>(I<args>) is called instead, otherwise falling
107 back to C<&DB::sub>(I<args>).
108
109 =item *
110
111 When execution of the program uses C<goto> to enter a non-XS subroutine
112 and the 0x80 bit is set in C<$^P>, a call to C<&DB::goto> is made, with
113 C<$DB::sub> set to identify the subroutine being entered.  The call to
114 C<&DB::goto> does not replace the C<goto>; the requested subroutine will
115 still be entered once C<&DB::goto> has returned.  C<$DB::sub> normally
116 holds the name of the subroutine being entered, if it has one.  Failing
117 that, C<$DB::sub> will hold a reference to the subroutine being entered.
118 Unlike when C<&DB::sub> is called, it is not guaranteed that C<$DB::sub>
119 can be used as a reference to operate on the subroutine being entered.
120
121 =back
122
123 Note that if C<&DB::sub> needs external data for it to work, no
124 subroutine call is possible without it. As an example, the standard
125 debugger's C<&DB::sub> depends on the C<$DB::deep> variable
126 (it defines how many levels of recursion deep into the debugger you can go
127 before a mandatory break).  If C<$DB::deep> is not defined, subroutine
128 calls are not possible, even though C<&DB::sub> exists.
129
130 =head2 Writing Your Own Debugger
131
132 =head3 Environment Variables
133
134 The C<PERL5DB> environment variable can be used to define a debugger.
135 For example, the minimal "working" debugger (it actually doesn't do anything)
136 consists of one line:
137
138   sub DB::DB {}
139
140 It can easily be defined like this:
141
142   $ PERL5DB="sub DB::DB {}" perl -d your-script
143
144 Another brief debugger, slightly more useful, can be created
145 with only the line:
146
147   sub DB::DB {print ++$i; scalar <STDIN>}
148
149 This debugger prints a number which increments for each statement
150 encountered and waits for you to hit a newline before continuing
151 to the next statement.
152
153 The following debugger is actually useful:
154
155   {
156     package DB;
157     sub DB  {}
158     sub sub {print ++$i, " $sub\n"; &$sub}
159   }
160
161 It prints the sequence number of each subroutine call and the name of the
162 called subroutine.  Note that C<&DB::sub> is being compiled into the
163 package C<DB> through the use of the C<package> directive.
164
165 When it starts, the debugger reads your rc file (F<./.perldb> or
166 F<~/.perldb> under Unix), which can set important options.
167 (A subroutine (C<&afterinit>) can be defined here as well; it is executed
168 after the debugger completes its own initialization.)
169
170 After the rc file is read, the debugger reads the PERLDB_OPTS
171 environment variable and uses it to set debugger options. The
172 contents of this variable are treated as if they were the argument
173 of an C<o ...> debugger command (q.v. in L<perldebug/"Configurable Options">).
174
175 =head3 Debugger Internal Variables
176
177 In addition to the file and subroutine-related variables mentioned above,
178 the debugger also maintains various magical internal variables.
179
180 =over 4
181
182 =item *
183
184 C<@DB::dbline> is an alias for C<@{"::_<current_file"}>, which
185 holds the lines of the currently-selected file (compiled by Perl), either
186 explicitly chosen with the debugger's C<f> command, or implicitly by flow
187 of execution.
188
189 Values in this array are magical in numeric context: they compare
190 equal to zero only if the line is not breakable.
191
192 =item *
193
194 C<%DB::dbline> is an alias for C<%{"::_<current_file"}>, which
195 contains breakpoints and actions keyed by line number in
196 the currently-selected file, either explicitly chosen with the
197 debugger's C<f> command, or implicitly by flow of execution.
198
199 As previously noted, individual entries (as opposed to the whole hash)
200 are settable.  Perl only cares about Boolean true here, although
201 the values used by F<perl5db.pl> have the form
202 C<"$break_condition\0$action">.
203
204 =back
205
206 =head3 Debugger Customization Functions
207
208 Some functions are provided to simplify customization.
209
210 =over 4
211
212 =item *
213
214 See L<perldebug/"Configurable Options"> for a description of options parsed by
215 C<DB::parse_options(string)>.
216
217 =item *
218
219 C<DB::dump_trace(skip[,count])> skips the specified number of frames
220 and returns a list containing information about the calling frames (all
221 of them, if C<count> is missing).  Each entry is reference to a hash
222 with keys C<context> (either C<.>, C<$>, or C<@>), C<sub> (subroutine
223 name, or info about C<eval>), C<args> (C<undef> or a reference to
224 an array), C<file>, and C<line>.
225
226 =item *
227
228 C<DB::print_trace(FH, skip[, count[, short]])> prints
229 formatted info about caller frames.  The last two functions may be
230 convenient as arguments to C<< < >>, C<< << >> commands.
231
232 =back
233
234 Note that any variables and functions that are not documented in
235 this manpages (or in L<perldebug>) are considered for internal   
236 use only, and as such are subject to change without notice.
237
238 =head1 Frame Listing Output Examples
239
240 The C<frame> option can be used to control the output of frame 
241 information.  For example, contrast this expression trace:
242
243  $ perl -de 42
244  Stack dump during die enabled outside of evals.
245
246  Loading DB routines from perl5db.pl patch level 0.94
247  Emacs support available.
248
249  Enter h or 'h h' for help.
250
251  main::(-e:1):   0
252    DB<1> sub foo { 14 }
253
254    DB<2> sub bar { 3 }
255
256    DB<3> t print foo() * bar()
257  main::((eval 172):3):   print foo() + bar();
258  main::foo((eval 168):2):
259  main::bar((eval 170):2):
260  42
261
262 with this one, once the C<o>ption C<frame=2> has been set:
263
264    DB<4> o f=2
265                 frame = '2'
266    DB<5> t print foo() * bar()
267  3:      foo() * bar()
268  entering main::foo
269   2:     sub foo { 14 };
270  exited main::foo
271  entering main::bar
272   2:     sub bar { 3 };
273  exited main::bar
274  42
275
276 By way of demonstration, we present below a laborious listing
277 resulting from setting your C<PERLDB_OPTS> environment variable to
278 the value C<f=n N>, and running I<perl -d -V> from the command line.
279 Examples using various values of C<n> are shown to give you a feel
280 for the difference between settings.  Long though it may be, this
281 is not a complete listing, but only excerpts.
282
283 =over 4
284
285 =item 1
286
287  entering main::BEGIN
288   entering Config::BEGIN
289    Package lib/Exporter.pm.
290    Package lib/Carp.pm.
291   Package lib/Config.pm.
292   entering Config::TIEHASH
293   entering Exporter::import
294    entering Exporter::export
295  entering Config::myconfig
296   entering Config::FETCH
297   entering Config::FETCH
298   entering Config::FETCH
299   entering Config::FETCH
300
301 =item 2
302
303  entering main::BEGIN
304   entering Config::BEGIN
305    Package lib/Exporter.pm.
306    Package lib/Carp.pm.
307   exited Config::BEGIN
308   Package lib/Config.pm.
309   entering Config::TIEHASH
310   exited Config::TIEHASH
311   entering Exporter::import
312    entering Exporter::export
313    exited Exporter::export
314   exited Exporter::import
315  exited main::BEGIN
316  entering Config::myconfig
317   entering Config::FETCH
318   exited Config::FETCH
319   entering Config::FETCH
320   exited Config::FETCH
321   entering Config::FETCH
322
323 =item 3
324
325  in  $=main::BEGIN() from /dev/null:0
326   in  $=Config::BEGIN() from lib/Config.pm:2
327    Package lib/Exporter.pm.
328    Package lib/Carp.pm.
329   Package lib/Config.pm.
330   in  $=Config::TIEHASH('Config') from lib/Config.pm:644
331   in  $=Exporter::import('Config', 'myconfig', 'config_vars') from /dev/null:0
332    in  $=Exporter::export('Config', 'main', 'myconfig', 'config_vars') from li
333  in  @=Config::myconfig() from /dev/null:0
334   in  $=Config::FETCH(ref(Config), 'package') from lib/Config.pm:574
335   in  $=Config::FETCH(ref(Config), 'baserev') from lib/Config.pm:574
336   in  $=Config::FETCH(ref(Config), 'PERL_VERSION') from lib/Config.pm:574
337   in  $=Config::FETCH(ref(Config), 'PERL_SUBVERSION') from lib/Config.pm:574
338   in  $=Config::FETCH(ref(Config), 'osname') from lib/Config.pm:574
339   in  $=Config::FETCH(ref(Config), 'osvers') from lib/Config.pm:574
340
341 =item 4
342
343  in  $=main::BEGIN() from /dev/null:0
344   in  $=Config::BEGIN() from lib/Config.pm:2
345    Package lib/Exporter.pm.
346    Package lib/Carp.pm.
347   out $=Config::BEGIN() from lib/Config.pm:0
348   Package lib/Config.pm.
349   in  $=Config::TIEHASH('Config') from lib/Config.pm:644
350   out $=Config::TIEHASH('Config') from lib/Config.pm:644
351   in  $=Exporter::import('Config', 'myconfig', 'config_vars') from /dev/null:0
352    in  $=Exporter::export('Config', 'main', 'myconfig', 'config_vars') from lib/
353    out $=Exporter::export('Config', 'main', 'myconfig', 'config_vars') from lib/
354   out $=Exporter::import('Config', 'myconfig', 'config_vars') from /dev/null:0
355  out $=main::BEGIN() from /dev/null:0
356  in  @=Config::myconfig() from /dev/null:0
357   in  $=Config::FETCH(ref(Config), 'package') from lib/Config.pm:574
358   out $=Config::FETCH(ref(Config), 'package') from lib/Config.pm:574
359   in  $=Config::FETCH(ref(Config), 'baserev') from lib/Config.pm:574
360   out $=Config::FETCH(ref(Config), 'baserev') from lib/Config.pm:574
361   in  $=Config::FETCH(ref(Config), 'PERL_VERSION') from lib/Config.pm:574
362   out $=Config::FETCH(ref(Config), 'PERL_VERSION') from lib/Config.pm:574
363   in  $=Config::FETCH(ref(Config), 'PERL_SUBVERSION') from lib/Config.pm:574
364
365 =item 5
366
367  in  $=main::BEGIN() from /dev/null:0
368   in  $=Config::BEGIN() from lib/Config.pm:2
369    Package lib/Exporter.pm.
370    Package lib/Carp.pm.
371   out $=Config::BEGIN() from lib/Config.pm:0
372   Package lib/Config.pm.
373   in  $=Config::TIEHASH('Config') from lib/Config.pm:644
374   out $=Config::TIEHASH('Config') from lib/Config.pm:644
375   in  $=Exporter::import('Config', 'myconfig', 'config_vars') from /dev/null:0
376    in  $=Exporter::export('Config', 'main', 'myconfig', 'config_vars') from lib/E
377    out $=Exporter::export('Config', 'main', 'myconfig', 'config_vars') from lib/E
378   out $=Exporter::import('Config', 'myconfig', 'config_vars') from /dev/null:0
379  out $=main::BEGIN() from /dev/null:0
380  in  @=Config::myconfig() from /dev/null:0
381   in  $=Config::FETCH('Config=HASH(0x1aa444)', 'package') from lib/Config.pm:574
382   out $=Config::FETCH('Config=HASH(0x1aa444)', 'package') from lib/Config.pm:574
383   in  $=Config::FETCH('Config=HASH(0x1aa444)', 'baserev') from lib/Config.pm:574
384   out $=Config::FETCH('Config=HASH(0x1aa444)', 'baserev') from lib/Config.pm:574
385
386 =item 6
387
388  in  $=CODE(0x15eca4)() from /dev/null:0
389   in  $=CODE(0x182528)() from lib/Config.pm:2
390    Package lib/Exporter.pm.
391   out $=CODE(0x182528)() from lib/Config.pm:0
392   scalar context return from CODE(0x182528): undef
393   Package lib/Config.pm.
394   in  $=Config::TIEHASH('Config') from lib/Config.pm:628
395   out $=Config::TIEHASH('Config') from lib/Config.pm:628
396   scalar context return from Config::TIEHASH:   empty hash
397   in  $=Exporter::import('Config', 'myconfig', 'config_vars') from /dev/null:0
398    in  $=Exporter::export('Config', 'main', 'myconfig', 'config_vars') from lib/Exporter.pm:171
399    out $=Exporter::export('Config', 'main', 'myconfig', 'config_vars') from lib/Exporter.pm:171
400    scalar context return from Exporter::export: ''
401   out $=Exporter::import('Config', 'myconfig', 'config_vars') from /dev/null:0
402   scalar context return from Exporter::import: ''
403
404 =back
405
406 In all cases shown above, the line indentation shows the call tree.
407 If bit 2 of C<frame> is set, a line is printed on exit from a
408 subroutine as well.  If bit 4 is set, the arguments are printed
409 along with the caller info.  If bit 8 is set, the arguments are
410 printed even if they are tied or references.  If bit 16 is set, the
411 return value is printed, too.
412
413 When a package is compiled, a line like this
414
415     Package lib/Carp.pm.
416
417 is printed with proper indentation.
418
419 =head1 Debugging Regular Expressions
420
421 There are two ways to enable debugging output for regular expressions.
422
423 If your perl is compiled with C<-DDEBUGGING>, you may use the
424 B<-Dr> flag on the command line, and C<-Drv> for more verbose
425 information.
426
427 Otherwise, one can C<use re 'debug'>, which has effects at both
428 compile time and run time.  Since Perl 5.9.5, this pragma is lexically
429 scoped.
430
431 =head2 Compile-time Output
432
433 The debugging output at compile time looks like this:
434
435   Compiling REx '[bc]d(ef*g)+h[ij]k$'
436   size 45 Got 364 bytes for offset annotations.
437   first at 1
438   rarest char g at 0
439   rarest char d at 0
440      1: ANYOF[bc](12)
441     12: EXACT <d>(14)
442     14: CURLYX[0] {1,32767}(28)
443     16:   OPEN1(18)
444     18:     EXACT <e>(20)
445     20:     STAR(23)
446     21:       EXACT <f>(0)
447     23:     EXACT <g>(25)
448     25:   CLOSE1(27)
449     27:   WHILEM[1/1](0)
450     28: NOTHING(29)
451     29: EXACT <h>(31)
452     31: ANYOF[ij](42)
453     42: EXACT <k>(44)
454     44: EOL(45)
455     45: END(0)
456   anchored 'de' at 1 floating 'gh' at 3..2147483647 (checking floating) 
457         stclass 'ANYOF[bc]' minlen 7 
458   Offsets: [45]
459         1[4] 0[0] 0[0] 0[0] 0[0] 0[0] 0[0] 0[0] 0[0] 0[0] 0[0] 5[1]
460         0[0] 12[1] 0[0] 6[1] 0[0] 7[1] 0[0] 9[1] 8[1] 0[0] 10[1] 0[0]
461         11[1] 0[0] 12[0] 12[0] 13[1] 0[0] 14[4] 0[0] 0[0] 0[0] 0[0]
462         0[0] 0[0] 0[0] 0[0] 0[0] 0[0] 18[1] 0[0] 19[1] 20[0]  
463   Omitting $` $& $' support.
464
465 The first line shows the pre-compiled form of the regex.  The second
466 shows the size of the compiled form (in arbitrary units, usually
467 4-byte words) and the total number of bytes allocated for the
468 offset/length table, usually 4+C<size>*8.  The next line shows the
469 label I<id> of the first node that does a match.
470
471 The 
472
473   anchored 'de' at 1 floating 'gh' at 3..2147483647 (checking floating) 
474         stclass 'ANYOF[bc]' minlen 7 
475
476 line (split into two lines above) contains optimizer
477 information.  In the example shown, the optimizer found that the match 
478 should contain a substring C<de> at offset 1, plus substring C<gh>
479 at some offset between 3 and infinity.  Moreover, when checking for
480 these substrings (to abandon impossible matches quickly), Perl will check
481 for the substring C<gh> before checking for the substring C<de>.  The
482 optimizer may also use the knowledge that the match starts (at the
483 C<first> I<id>) with a character class, and no string 
484 shorter than 7 characters can possibly match.
485
486 The fields of interest which may appear in this line are
487
488 =over 4
489
490 =item C<anchored> I<STRING> C<at> I<POS>
491
492 =item C<floating> I<STRING> C<at> I<POS1..POS2>
493
494 See above.
495
496 =item C<matching floating/anchored>
497
498 Which substring to check first.
499
500 =item C<minlen>
501
502 The minimal length of the match.
503
504 =item C<stclass> I<TYPE>
505
506 Type of first matching node.
507
508 =item C<noscan>
509
510 Don't scan for the found substrings.
511
512 =item C<isall>
513
514 Means that the optimizer information is all that the regular
515 expression contains, and thus one does not need to enter the regex engine at
516 all.
517
518 =item C<GPOS>
519
520 Set if the pattern contains C<\G>.
521
522 =item C<plus> 
523
524 Set if the pattern starts with a repeated char (as in C<x+y>).
525
526 =item C<implicit>
527
528 Set if the pattern starts with C<.*>.
529
530 =item C<with eval> 
531
532 Set if the pattern contain eval-groups, such as C<(?{ code })> and
533 C<(??{ code })>.
534
535 =item C<anchored(TYPE)>
536
537 If the pattern may match only at a handful of places, with C<TYPE>
538 being C<SBOL>, C<MBOL>, or C<GPOS>.  See the table below.
539
540 =back
541
542 If a substring is known to match at end-of-line only, it may be
543 followed by C<$>, as in C<floating 'k'$>.
544
545 The optimizer-specific information is used to avoid entering (a slow) regex
546 engine on strings that will not definitely match.  If the C<isall> flag
547 is set, a call to the regex engine may be avoided even when the optimizer
548 found an appropriate place for the match.
549
550 Above the optimizer section is the list of I<nodes> of the compiled
551 form of the regex.  Each line has format 
552
553 C<   >I<id>: I<TYPE> I<OPTIONAL-INFO> (I<next-id>)
554
555 =head2 Types of Nodes
556
557 Here are the current possible types, with short descriptions:
558
559 =for comment
560 This table is generated by regen/regcomp.pl.  Any changes made here
561 will be lost.
562
563 =for regcomp.pl begin
564
565  # TYPE arg-description [num-args] [longjump-len] DESCRIPTION
566
567  # Exit points
568
569  END              no         End of program.
570  SUCCEED          no         Return from a subroutine, basically.
571
572  # Line Start Anchors:
573  SBOL             no         Match "" at beginning of line: /^/, /\A/
574  MBOL             no         Same, assuming multiline: /^/m
575
576  # Line End Anchors:
577  SEOL             no         Match "" at end of line: /$/
578  MEOL             no         Same, assuming multiline: /$/m
579  EOS              no         Match "" at end of string: /\z/
580
581  # Match Start Anchors:
582  GPOS             no         Matches where last m//g left off.
583
584  # Word Boundary Opcodes:
585  BOUND            no         Like BOUNDA for non-utf8, otherwise match
586                              "" between any Unicode \w\W or \W\w
587  BOUNDL           no         Like BOUND/BOUNDU, but \w and \W are
588                              defined by current locale
589  BOUNDU           no         Match "" at any boundary of a given type
590                              using Unicode rules
591  BOUNDA           no         Match "" at any boundary between \w\W or
592                              \W\w, where \w is [_a-zA-Z0-9]
593  NBOUND           no         Like NBOUNDA for non-utf8, otherwise match
594                              "" between any Unicode \w\w or \W\W
595  NBOUNDL          no         Like NBOUND/NBOUNDU, but \w and \W are
596                              defined by current locale
597  NBOUNDU          no         Match "" at any non-boundary of a given
598                              type using using Unicode rules
599  NBOUNDA          no         Match "" betweeen any \w\w or \W\W, where
600                              \w is [_a-zA-Z0-9]
601
602  # [Special] alternatives:
603  REG_ANY          no         Match any one character (except newline).
604  SANY             no         Match any one character.
605  ANYOF            sv         Match character in (or not in) this class,
606                   charclass  single char match only
607  ANYOFD           sv         Like ANYOF, but /d is in effect
608                   charclass
609  ANYOFL           sv         Like ANYOF, but /l is in effect
610                   charclass
611  ANYOFPOSIXL      sv         Like ANYOFL, but matches [[:posix:]]
612                   charclass_ classes
613                   posixl
614  ANYOFH           sv 1       Like ANYOF, but only has "High" matches,
615                              none in the bitmap
616  ANYOFM           byte 1     Like ANYOF, but matches an invariant byte
617                              as determined by the mask and arg
618  NANYOFM          byte 1     complement of ANYOFM
619
620  # POSIX Character Classes:
621  POSIXD           none       Some [[:class:]] under /d; the FLAGS field
622                              gives which one
623  POSIXL           none       Some [[:class:]] under /l; the FLAGS field
624                              gives which one
625  POSIXU           none       Some [[:class:]] under /u; the FLAGS field
626                              gives which one
627  POSIXA           none       Some [[:class:]] under /a; the FLAGS field
628                              gives which one
629  NPOSIXD          none       complement of POSIXD, [[:^class:]]
630  NPOSIXL          none       complement of POSIXL, [[:^class:]]
631  NPOSIXU          none       complement of POSIXU, [[:^class:]]
632  NPOSIXA          none       complement of POSIXA, [[:^class:]]
633
634  CLUMP            no         Match any extended grapheme cluster
635                              sequence
636
637  # Alternation
638
639  # BRANCH        The set of branches constituting a single choice are
640  #               hooked together with their "next" pointers, since
641  #               precedence prevents anything being concatenated to
642  #               any individual branch.  The "next" pointer of the last
643  #               BRANCH in a choice points to the thing following the
644  #               whole choice.  This is also where the final "next"
645  #               pointer of each individual branch points; each branch
646  #               starts with the operand node of a BRANCH node.
647  #
648  BRANCH           node       Match this alternative, or the next...
649
650  # Literals
651
652  EXACT            str        Match this string (preceded by length).
653  EXACTL           str        Like EXACT, but /l is in effect (used so
654                              locale-related warnings can be checked
655                              for).
656  EXACTF           str        Match this string using /id rules (w/len);
657                              (string not UTF-8, not guaranteed to be
658                              folded).
659  EXACTFL          str        Match this string using /il rules (w/len);
660                              (string not guaranteed to be folded).
661  EXACTFU          str        Match this string using /iu rules (w/len);
662                              (string folded iff in UTF-8; non-UTF8
663                              folded length <= unfolded).
664  EXACTFAA         str        Match this string using /iaa rules (w/len)
665                              (string folded iff in UTF-8; non-UTF8
666                              folded length <= unfolded).
667
668  EXACTFUP         str        Match this string using /iu rules (w/len);
669                              (string not UTF-8, not guaranteed to be
670                              folded; and its Problematic).
671
672  EXACTFLU8        str        Like EXACTFU, but use /il, UTF-8, folded,
673                              and everything in it is above 255.
674  EXACTFAA_NO_TRIE str        Match this string using /iaa rules (w/len)
675                              (string not UTF-8, not guaranteed to be
676                              folded, not currently trie-able).
677
678  EXACT_ONLY8      str        Like EXACT, but only UTF-8 encoded targets
679                              can match
680  EXACTFU_ONLY8    str        Like EXACTFU, but only UTF-8 encoded
681                              targets can match
682
683  EXACTFU_S_EDGE   str        /di rules, but nothing in it precludes /ui,
684                              except begins and/or ends with [Ss];
685                              (string not UTF-8; compile-time only).
686
687  # Do nothing types
688
689  NOTHING          no         Match empty string.
690  # A variant of above which delimits a group, thus stops optimizations
691  TAIL             no         Match empty string. Can jump here from
692                              outside.
693
694  # Loops
695
696  # STAR,PLUS    '?', and complex '*' and '+', are implemented as
697  #               circular BRANCH structures.  Simple cases
698  #               (one character per match) are implemented with STAR
699  #               and PLUS for speed and to minimize recursive plunges.
700  #
701  STAR             node       Match this (simple) thing 0 or more times.
702  PLUS             node       Match this (simple) thing 1 or more times.
703
704  CURLY            sv 2       Match this simple thing {n,m} times.
705  CURLYN           no 2       Capture next-after-this simple thing
706  CURLYM           no 2       Capture this medium-complex thing {n,m}
707                              times.
708  CURLYX           sv 2       Match this complex thing {n,m} times.
709
710  # This terminator creates a loop structure for CURLYX
711  WHILEM           no         Do curly processing and see if rest
712                              matches.
713
714  # Buffer related
715
716  # OPEN,CLOSE,GROUPP     ...are numbered at compile time.
717  OPEN             num 1      Mark this point in input as start of #n.
718  CLOSE            num 1      Close corresponding OPEN of #n.
719  SROPEN           none       Same as OPEN, but for script run
720  SRCLOSE          none       Close preceding SROPEN
721
722  REF              num 1      Match some already matched string
723  REFF             num 1      Match already matched string, folded using
724                              native charset rules for non-utf8
725  REFFL            num 1      Match already matched string, folded in
726                              loc.
727  REFFU            num 1      Match already matched string, folded using
728                              unicode rules for non-utf8
729  REFFA            num 1      Match already matched string, folded using
730                              unicode rules for non-utf8, no mixing
731                              ASCII, non-ASCII
732
733  # Named references.  Code in regcomp.c assumes that these all are after
734  # the numbered references
735  NREF             no-sv 1    Match some already matched string
736  NREFF            no-sv 1    Match already matched string, folded using
737                              native charset rules for non-utf8
738  NREFFL           no-sv 1    Match already matched string, folded in
739                              loc.
740  NREFFU           num 1      Match already matched string, folded using
741                              unicode rules for non-utf8
742  NREFFA           num 1      Match already matched string, folded using
743                              unicode rules for non-utf8, no mixing
744                              ASCII, non-ASCII
745
746  # Support for long RE
747  LONGJMP          off 1 1    Jump far away.
748  BRANCHJ          off 1 1    BRANCH with long offset.
749
750  # Special Case Regops
751  IFMATCH          off 1 1    Succeeds if the following matches.
752  UNLESSM          off 1 1    Fails if the following matches.
753  SUSPEND          off 1 1    "Independent" sub-RE.
754  IFTHEN           off 1 1    Switch, should be preceded by switcher.
755  GROUPP           num 1      Whether the group matched.
756
757  # The heavy worker
758
759  EVAL             evl/flags  Execute some Perl code.
760                   2L
761
762  # Modifiers
763
764  MINMOD           no         Next operator is not greedy.
765  LOGICAL          no         Next opcode should set the flag only.
766
767  # This is not used yet
768  RENUM            off 1 1    Group with independently numbered parens.
769
770  # Trie Related
771
772  # Behave the same as A|LIST|OF|WORDS would. The '..C' variants
773  # have inline charclass data (ascii only), the 'C' store it in the
774  # structure.
775
776  TRIE             trie 1     Match many EXACT(F[ALU]?)? at once.
777                              flags==type
778  TRIEC            trie       Same as TRIE, but with embedded charclass
779                   charclass  data
780
781  AHOCORASICK      trie 1     Aho Corasick stclass. flags==type
782  AHOCORASICKC     trie       Same as AHOCORASICK, but with embedded
783                   charclass  charclass data
784
785  # Regex Subroutines
786  GOSUB            num/ofs 2L recurse to paren arg1 at (signed) ofs arg2
787
788  # Special conditionals
789  NGROUPP          no-sv 1    Whether the group matched.
790  INSUBP           num 1      Whether we are in a specific recurse.
791  DEFINEP          none 1     Never execute directly.
792
793  # Backtracking Verbs
794  ENDLIKE          none       Used only for the type field of verbs
795  OPFAIL           no-sv 1    Same as (?!), but with verb arg
796  ACCEPT           no-sv/num  Accepts the current matched string, with
797                   2L         verbar
798
799  # Verbs With Arguments
800  VERB             no-sv 1    Used only for the type field of verbs
801  PRUNE            no-sv 1    Pattern fails at this startpoint if no-
802                              backtracking through this
803  MARKPOINT        no-sv 1    Push the current location for rollback by
804                              cut.
805  SKIP             no-sv 1    On failure skip forward (to the mark)
806                              before retrying
807  COMMIT           no-sv 1    Pattern fails outright if backtracking
808                              through this
809  CUTGROUP         no-sv 1    On failure go to the next alternation in
810                              the group
811
812  # Control what to keep in $&.
813  KEEPS            no         $& begins here.
814
815  # New charclass like patterns
816  LNBREAK          none       generic newline pattern
817
818  # SPECIAL  REGOPS
819
820  # This is not really a node, but an optimized away piece of a "long"
821  # node.  To simplify debugging output, we mark it as if it were a node
822  OPTIMIZED        off        Placeholder for dump.
823
824  # Special opcode with the property that no opcode in a compiled program
825  # will ever be of this type. Thus it can be used as a flag value that
826  # no other opcode has been seen. END is used similarly, in that an END
827  # node cant be optimized. So END implies "unoptimizable" and PSEUDO
828  # mean "not seen anything to optimize yet".
829  PSEUDO           off        Pseudo opcode for internal use.
830
831 =for regcomp.pl end
832
833 =for unprinted-credits
834 Next section M-J. Dominus (mjd-perl-patch+@plover.com) 20010421
835
836 Following the optimizer information is a dump of the offset/length
837 table, here split across several lines:
838
839   Offsets: [45]
840         1[4] 0[0] 0[0] 0[0] 0[0] 0[0] 0[0] 0[0] 0[0] 0[0] 0[0] 5[1]
841         0[0] 12[1] 0[0] 6[1] 0[0] 7[1] 0[0] 9[1] 8[1] 0[0] 10[1] 0[0]
842         11[1] 0[0] 12[0] 12[0] 13[1] 0[0] 14[4] 0[0] 0[0] 0[0] 0[0]
843         0[0] 0[0] 0[0] 0[0] 0[0] 0[0] 18[1] 0[0] 19[1] 20[0]  
844
845 The first line here indicates that the offset/length table contains 45
846 entries.  Each entry is a pair of integers, denoted by C<offset[length]>.
847 Entries are numbered starting with 1, so entry #1 here is C<1[4]> and
848 entry #12 is C<5[1]>.  C<1[4]> indicates that the node labeled C<1:>
849 (the C<1: ANYOF[bc]>) begins at character position 1 in the
850 pre-compiled form of the regex, and has a length of 4 characters.
851 C<5[1]> in position 12 
852 indicates that the node labeled C<12:>
853 (the C<< 12: EXACT <d> >>) begins at character position 5 in the
854 pre-compiled form of the regex, and has a length of 1 character.
855 C<12[1]> in position 14 
856 indicates that the node labeled C<14:>
857 (the C<< 14: CURLYX[0] {1,32767} >>) begins at character position 12 in the
858 pre-compiled form of the regex, and has a length of 1 character---that
859 is, it corresponds to the C<+> symbol in the precompiled regex.
860
861 C<0[0]> items indicate that there is no corresponding node.
862
863 =head2 Run-time Output
864
865 First of all, when doing a match, one may get no run-time output even
866 if debugging is enabled.  This means that the regex engine was never
867 entered and that all of the job was therefore done by the optimizer.
868
869 If the regex engine was entered, the output may look like this:
870
871   Matching '[bc]d(ef*g)+h[ij]k$' against 'abcdefg__gh__'
872     Setting an EVAL scope, savestack=3
873      2 <ab> <cdefg__gh_>    |  1: ANYOF
874      3 <abc> <defg__gh_>    | 11: EXACT <d>
875      4 <abcd> <efg__gh_>    | 13: CURLYX {1,32767}
876      4 <abcd> <efg__gh_>    | 26:   WHILEM
877                                 0 out of 1..32767  cc=effff31c
878      4 <abcd> <efg__gh_>    | 15:     OPEN1
879      4 <abcd> <efg__gh_>    | 17:     EXACT <e>
880      5 <abcde> <fg__gh_>    | 19:     STAR
881                              EXACT <f> can match 1 times out of 32767...
882     Setting an EVAL scope, savestack=3
883      6 <bcdef> <g__gh__>    | 22:       EXACT <g>
884      7 <bcdefg> <__gh__>    | 24:       CLOSE1
885      7 <bcdefg> <__gh__>    | 26:       WHILEM
886                                     1 out of 1..32767  cc=effff31c
887     Setting an EVAL scope, savestack=12
888      7 <bcdefg> <__gh__>    | 15:         OPEN1
889      7 <bcdefg> <__gh__>    | 17:         EXACT <e>
890        restoring \1 to 4(4)..7
891                                     failed, try continuation...
892      7 <bcdefg> <__gh__>    | 27:         NOTHING
893      7 <bcdefg> <__gh__>    | 28:         EXACT <h>
894                                     failed...
895                                 failed...
896
897 The most significant information in the output is about the particular I<node>
898 of the compiled regex that is currently being tested against the target string.
899 The format of these lines is
900
901 C<    >I<STRING-OFFSET> <I<PRE-STRING>> <I<POST-STRING>>   |I<ID>:  I<TYPE>
902
903 The I<TYPE> info is indented with respect to the backtracking level.
904 Other incidental information appears interspersed within.
905
906 =head1 Debugging Perl Memory Usage
907
908 Perl is a profligate wastrel when it comes to memory use.  There
909 is a saying that to estimate memory usage of Perl, assume a reasonable
910 algorithm for memory allocation, multiply that estimate by 10, and
911 while you still may miss the mark, at least you won't be quite so
912 astonished.  This is not absolutely true, but may provide a good
913 grasp of what happens.
914
915 Assume that an integer cannot take less than 20 bytes of memory, a
916 float cannot take less than 24 bytes, a string cannot take less
917 than 32 bytes (all these examples assume 32-bit architectures, the
918 result are quite a bit worse on 64-bit architectures).  If a variable
919 is accessed in two of three different ways (which require an integer,
920 a float, or a string), the memory footprint may increase yet another
921 20 bytes.  A sloppy malloc(3) implementation can inflate these
922 numbers dramatically.
923
924 On the opposite end of the scale, a declaration like
925
926   sub foo;
927
928 may take up to 500 bytes of memory, depending on which release of Perl
929 you're running.
930
931 Anecdotal estimates of source-to-compiled code bloat suggest an
932 eightfold increase.  This means that the compiled form of reasonable
933 (normally commented, properly indented etc.) code will take
934 about eight times more space in memory than the code took
935 on disk.
936
937 The B<-DL> command-line switch is obsolete since circa Perl 5.6.0
938 (it was available only if Perl was built with C<-DDEBUGGING>).
939 The switch was used to track Perl's memory allocations and possible
940 memory leaks.  These days the use of malloc debugging tools like
941 F<Purify> or F<valgrind> is suggested instead.  See also
942 L<perlhacktips/PERL_MEM_LOG>.
943
944 One way to find out how much memory is being used by Perl data
945 structures is to install the Devel::Size module from CPAN: it gives
946 you the minimum number of bytes required to store a particular data
947 structure.  Please be mindful of the difference between the size()
948 and total_size().
949
950 If Perl has been compiled using Perl's malloc you can analyze Perl
951 memory usage by setting $ENV{PERL_DEBUG_MSTATS}.
952
953 =head2 Using C<$ENV{PERL_DEBUG_MSTATS}>
954
955 If your perl is using Perl's malloc() and was compiled with the
956 necessary switches (this is the default), then it will print memory
957 usage statistics after compiling your code when C<< $ENV{PERL_DEBUG_MSTATS}
958 > 1 >>, and before termination of the program when C<<
959 $ENV{PERL_DEBUG_MSTATS} >= 1 >>.  The report format is similar to
960 the following example:
961
962  $ PERL_DEBUG_MSTATS=2 perl -e "require Carp"
963  Memory allocation statistics after compilation: (buckets 4(4)..8188(8192)
964     14216 free:   130   117    28     7     9   0   2     2   1 0 0
965                 437    61    36     0     5
966     60924 used:   125   137   161    55     7   8   6    16   2 0 1
967                  74   109   304    84    20
968  Total sbrk(): 77824/21:119. Odd ends: pad+heads+chain+tail: 0+636+0+2048.
969  Memory allocation statistics after execution:   (buckets 4(4)..8188(8192)
970     30888 free:   245    78    85    13     6   2   1     3   2 0 1
971                 315   162    39    42    11
972    175816 used:   265   176  1112   111    26  22  11    27   2 1 1
973                 196   178  1066   798    39
974  Total sbrk(): 215040/47:145. Odd ends: pad+heads+chain+tail: 0+2192+0+6144.
975
976 It is possible to ask for such a statistic at arbitrary points in
977 your execution using the mstat() function out of the standard
978 Devel::Peek module.
979
980 Here is some explanation of that format:
981
982 =over 4
983
984 =item C<buckets SMALLEST(APPROX)..GREATEST(APPROX)>
985
986 Perl's malloc() uses bucketed allocations.  Every request is rounded
987 up to the closest bucket size available, and a bucket is taken from
988 the pool of buckets of that size.
989
990 The line above describes the limits of buckets currently in use.
991 Each bucket has two sizes: memory footprint and the maximal size
992 of user data that can fit into this bucket.  Suppose in the above
993 example that the smallest bucket were size 4.  The biggest bucket
994 would have usable size 8188, and the memory footprint would be 8192.
995
996 In a Perl built for debugging, some buckets may have negative usable
997 size.  This means that these buckets cannot (and will not) be used.
998 For larger buckets, the memory footprint may be one page greater
999 than a power of 2.  If so, the corresponding power of two is
1000 printed in the C<APPROX> field above.
1001
1002 =item Free/Used
1003
1004 The 1 or 2 rows of numbers following that correspond to the number
1005 of buckets of each size between C<SMALLEST> and C<GREATEST>.  In
1006 the first row, the sizes (memory footprints) of buckets are powers
1007 of two--or possibly one page greater.  In the second row, if present,
1008 the memory footprints of the buckets are between the memory footprints
1009 of two buckets "above".
1010
1011 For example, suppose under the previous example, the memory footprints
1012 were
1013
1014    free:    8     16    32    64    128  256 512 1024 2048 4096 8192
1015            4     12    24    48    80
1016
1017 With a non-C<DEBUGGING> perl, the buckets starting from C<128> have
1018 a 4-byte overhead, and thus an 8192-long bucket may take up to
1019 8188-byte allocations.
1020
1021 =item C<Total sbrk(): SBRKed/SBRKs:CONTINUOUS>
1022
1023 The first two fields give the total amount of memory perl sbrk(2)ed
1024 (ess-broken? :-) and number of sbrk(2)s used.  The third number is
1025 what perl thinks about continuity of returned chunks.  So long as
1026 this number is positive, malloc() will assume that it is probable
1027 that sbrk(2) will provide continuous memory.
1028
1029 Memory allocated by external libraries is not counted.
1030
1031 =item C<pad: 0>
1032
1033 The amount of sbrk(2)ed memory needed to keep buckets aligned.
1034
1035 =item C<heads: 2192>
1036
1037 Although memory overhead of bigger buckets is kept inside the bucket, for
1038 smaller buckets, it is kept in separate areas.  This field gives the
1039 total size of these areas.
1040
1041 =item C<chain: 0>
1042
1043 malloc() may want to subdivide a bigger bucket into smaller buckets.
1044 If only a part of the deceased bucket is left unsubdivided, the rest
1045 is kept as an element of a linked list.  This field gives the total
1046 size of these chunks.
1047
1048 =item C<tail: 6144>
1049
1050 To minimize the number of sbrk(2)s, malloc() asks for more memory.  This
1051 field gives the size of the yet unused part, which is sbrk(2)ed, but
1052 never touched.
1053
1054 =back
1055
1056 =head1 SEE ALSO
1057
1058 L<perldebug>,
1059 L<perlguts>,
1060 L<perlrun>
1061 L<re>,
1062 and
1063 L<Devel::DProf>.