Perl_save_re_context(): re-indent after last commit
[perl.git] / pod / perlhacktips.pod
1
2 =encoding utf8
3
4 =for comment
5 Consistent formatting of this file is achieved with:
6   perl ./Porting/podtidy pod/perlhacktips.pod
7
8 =head1 NAME
9
10 perlhacktips - Tips for Perl core C code hacking
11
12 =head1 DESCRIPTION
13
14 This document will help you learn the best way to go about hacking on
15 the Perl core C code.  It covers common problems, debugging, profiling,
16 and more.
17
18 If you haven't read L<perlhack> and L<perlhacktut> yet, you might want
19 to do that first.
20
21 =head1 COMMON PROBLEMS
22
23 Perl source plays by ANSI C89 rules: no C99 (or C++) extensions.  In
24 some cases we have to take pre-ANSI requirements into consideration.
25 You don't care about some particular platform having broken Perl? I
26 hear there is still a strong demand for J2EE programmers.
27
28 =head2 Perl environment problems
29
30 =over 4
31
32 =item *
33
34 Not compiling with threading
35
36 Compiling with threading (-Duseithreads) completely rewrites the
37 function prototypes of Perl.  You better try your changes with that.
38 Related to this is the difference between "Perl_-less" and "Perl_-ly"
39 APIs, for example:
40
41   Perl_sv_setiv(aTHX_ ...);
42   sv_setiv(...);
43
44 The first one explicitly passes in the context, which is needed for
45 e.g. threaded builds.  The second one does that implicitly; do not get
46 them mixed.  If you are not passing in a aTHX_, you will need to do a
47 dTHX (or a dVAR) as the first thing in the function.
48
49 See L<perlguts/"How multiple interpreters and concurrency are
50 supported"> for further discussion about context.
51
52 =item *
53
54 Not compiling with -DDEBUGGING
55
56 The DEBUGGING define exposes more code to the compiler, therefore more
57 ways for things to go wrong.  You should try it.
58
59 =item *
60
61 Introducing (non-read-only) globals
62
63 Do not introduce any modifiable globals, truly global or file static.
64 They are bad form and complicate multithreading and other forms of
65 concurrency.  The right way is to introduce them as new interpreter
66 variables, see F<intrpvar.h> (at the very end for binary
67 compatibility).
68
69 Introducing read-only (const) globals is okay, as long as you verify
70 with e.g. C<nm libperl.a|egrep -v ' [TURtr] '> (if your C<nm> has
71 BSD-style output) that the data you added really is read-only.  (If it
72 is, it shouldn't show up in the output of that command.)
73
74 If you want to have static strings, make them constant:
75
76   static const char etc[] = "...";
77
78 If you want to have arrays of constant strings, note carefully the
79 right combination of C<const>s:
80
81     static const char * const yippee[] =
82         {"hi", "ho", "silver"};
83
84 There is a way to completely hide any modifiable globals (they are all
85 moved to heap), the compilation setting
86 C<-DPERL_GLOBAL_STRUCT_PRIVATE>.  It is not normally used, but can be
87 used for testing, read more about it in L<perlguts/"Background and
88 PERL_IMPLICIT_CONTEXT">.
89
90 =item *
91
92 Not exporting your new function
93
94 Some platforms (Win32, AIX, VMS, OS/2, to name a few) require any
95 function that is part of the public API (the shared Perl library) to be
96 explicitly marked as exported.  See the discussion about F<embed.pl> in
97 L<perlguts>.
98
99 =item *
100
101 Exporting your new function
102
103 The new shiny result of either genuine new functionality or your
104 arduous refactoring is now ready and correctly exported.  So what could
105 possibly go wrong?
106
107 Maybe simply that your function did not need to be exported in the
108 first place.  Perl has a long and not so glorious history of exporting
109 functions that it should not have.
110
111 If the function is used only inside one source code file, make it
112 static.  See the discussion about F<embed.pl> in L<perlguts>.
113
114 If the function is used across several files, but intended only for
115 Perl's internal use (and this should be the common case), do not export
116 it to the public API.  See the discussion about F<embed.pl> in
117 L<perlguts>.
118
119 =back
120
121 =head2 Portability problems
122
123 The following are common causes of compilation and/or execution
124 failures, not common to Perl as such.  The C FAQ is good bedtime
125 reading.  Please test your changes with as many C compilers and
126 platforms as possible; we will, anyway, and it's nice to save oneself
127 from public embarrassment.
128
129 If using gcc, you can add the C<-std=c89> option which will hopefully
130 catch most of these unportabilities.  (However it might also catch
131 incompatibilities in your system's header files.)
132
133 Use the Configure C<-Dgccansipedantic> flag to enable the gcc C<-ansi
134 -pedantic> flags which enforce stricter ANSI rules.
135
136 If using the C<gcc -Wall> note that not all the possible warnings (like
137 C<-Wunitialized>) are given unless you also compile with C<-O>.
138
139 Note that if using gcc, starting from Perl 5.9.5 the Perl core source
140 code files (the ones at the top level of the source code distribution,
141 but not e.g. the extensions under ext/) are automatically compiled with
142 as many as possible of the C<-std=c89>, C<-ansi>, C<-pedantic>, and a
143 selection of C<-W> flags (see cflags.SH).
144
145 Also study L<perlport> carefully to avoid any bad assumptions about the
146 operating system, filesystems, character set, and so forth.
147
148 You may once in a while try a "make microperl" to see whether we can
149 still compile Perl with just the bare minimum of interfaces.  (See
150 README.micro.)
151
152 Do not assume an operating system indicates a certain compiler.
153
154 =over 4
155
156 =item *
157
158 Casting pointers to integers or casting integers to pointers
159
160     void castaway(U8* p)
161     {
162       IV i = p;
163
164 or
165
166     void castaway(U8* p)
167     {
168       IV i = (IV)p;
169
170 Both are bad, and broken, and unportable.  Use the PTR2IV() macro that
171 does it right.  (Likewise, there are PTR2UV(), PTR2NV(), INT2PTR(), and
172 NUM2PTR().)
173
174 =item *
175
176 Casting between function pointers and data pointers
177
178 Technically speaking casting between function pointers and data
179 pointers is unportable and undefined, but practically speaking it seems
180 to work, but you should use the FPTR2DPTR() and DPTR2FPTR() macros.
181 Sometimes you can also play games with unions.
182
183 =item *
184
185 Assuming sizeof(int) == sizeof(long)
186
187 There are platforms where longs are 64 bits, and platforms where ints
188 are 64 bits, and while we are out to shock you, even platforms where
189 shorts are 64 bits.  This is all legal according to the C standard.  (In
190 other words, "long long" is not a portable way to specify 64 bits, and
191 "long long" is not even guaranteed to be any wider than "long".)
192
193 Instead, use the definitions IV, UV, IVSIZE, I32SIZE, and so forth.
194 Avoid things like I32 because they are B<not> guaranteed to be
195 I<exactly> 32 bits, they are I<at least> 32 bits, nor are they
196 guaranteed to be B<int> or B<long>.  If you really explicitly need
197 64-bit variables, use I64 and U64, but only if guarded by HAS_QUAD.
198
199 =item *
200
201 Assuming one can dereference any type of pointer for any type of data
202
203   char *p = ...;
204   long pony = *p;    /* BAD */
205
206 Many platforms, quite rightly so, will give you a core dump instead of
207 a pony if the p happens not to be correctly aligned.
208
209 =item *
210
211 Lvalue casts
212
213   (int)*p = ...;    /* BAD */
214
215 Simply not portable.  Get your lvalue to be of the right type, or maybe
216 use temporary variables, or dirty tricks with unions.
217
218 =item *
219
220 Assume B<anything> about structs (especially the ones you don't
221 control, like the ones coming from the system headers)
222
223 =over 8
224
225 =item *
226
227 That a certain field exists in a struct
228
229 =item *
230
231 That no other fields exist besides the ones you know of
232
233 =item *
234
235 That a field is of certain signedness, sizeof, or type
236
237 =item *
238
239 That the fields are in a certain order
240
241 =over 8
242
243 =item *
244
245 While C guarantees the ordering specified in the struct definition,
246 between different platforms the definitions might differ
247
248 =back
249
250 =item *
251
252 That the sizeof(struct) or the alignments are the same everywhere
253
254 =over 8
255
256 =item *
257
258 There might be padding bytes between the fields to align the fields -
259 the bytes can be anything
260
261 =item *
262
263 Structs are required to be aligned to the maximum alignment required by
264 the fields - which for native types is for usually equivalent to
265 sizeof() of the field
266
267 =back
268
269 =back
270
271 =item *
272
273 Assuming the character set is ASCIIish
274
275 Perl can compile and run under EBCDIC platforms.  See L<perlebcdic>.
276 This is transparent for the most part, but because the character sets
277 differ, you shouldn't use numeric (decimal, octal, nor hex) constants
278 to refer to characters.  You can safely say C<'A'>, but not C<0x41>.
279 You can safely say C<'\n'>, but not C<\012>.  However, you can use
280 macros defined in F<utf8.h> to specify any code point portably.
281 C<LATIN1_TO_NATIVE(0xDF)> is going to be the code point that means
282 LATIN SMALL LETTER SHARP S on whatever platform you are running on (on
283 ASCII platforms it compiles without adding any extra code, so there is
284 zero performance hit on those).  The acceptable inputs to
285 C<LATIN1_TO_NATIVE> are from C<0x00> through C<0xFF>.  If your input
286 isn't guaranteed to be in that range, use C<UNICODE_TO_NATIVE> instead.
287 C<NATIVE_TO_LATIN1> and C<NATIVE_TO_UNICODE> translate the opposite
288 direction.
289
290 If you need the string representation of a character that doesn't have a
291 mnemonic name in C, you should add it to the list in
292 F<regen/unicode_constants.pl>, and have Perl create C<#define>s for you,
293 based on the current platform.
294
295 Note that the C<isI<FOO>> and C<toI<FOO>> macros in F<handy.h> work
296 properly on native code points and strings.
297
298 Also, the range 'A' - 'Z' in ASCII is an unbroken sequence of 26 upper
299 case alphabetic characters.  That is not true in EBCDIC.  Nor for 'a' to
300 'z'.  But '0' - '9' is an unbroken range in both systems.  Don't assume
301 anything about other ranges.
302
303 Many of the comments in the existing code ignore the possibility of
304 EBCDIC, and may be wrong therefore, even if the code works.  This is
305 actually a tribute to the successful transparent insertion of being
306 able to handle EBCDIC without having to change pre-existing code.
307
308 UTF-8 and UTF-EBCDIC are two different encodings used to represent
309 Unicode code points as sequences of bytes.  Macros  with the same names
310 (but different definitions) in F<utf8.h> and F<utfebcdic.h> are used to
311 allow the calling code to think that there is only one such encoding.
312 This is almost always referred to as C<utf8>, but it means the EBCDIC
313 version as well.  Again, comments in the code may well be wrong even if
314 the code itself is right.  For example, the concept of UTF-8 C<invariant
315 characters> differs between ASCII and EBCDIC.  On ASCII platforms, only
316 characters that do not have the high-order bit set (i.e.  whose ordinals
317 are strict ASCII, 0 - 127) are invariant, and the documentation and
318 comments in the code may assume that, often referring to something
319 like, say, C<hibit>.  The situation differs and is not so simple on
320 EBCDIC machines, but as long as the code itself uses the
321 C<NATIVE_IS_INVARIANT()> macro appropriately, it works, even if the
322 comments are wrong.
323
324 =item *
325
326 Assuming the character set is just ASCII
327
328 ASCII is a 7 bit encoding, but bytes have 8 bits in them.  The 128 extra
329 characters have different meanings depending on the locale.  Absent a
330 locale, currently these extra characters are generally considered to be
331 unassigned, and this has presented some problems.  This has being
332 changed starting in 5.12 so that these characters can be considered to
333 be Latin-1 (ISO-8859-1).
334
335 =item *
336
337 Mixing #define and #ifdef
338
339   #define BURGLE(x) ... \
340   #ifdef BURGLE_OLD_STYLE        /* BAD */
341   ... do it the old way ... \
342   #else
343   ... do it the new way ... \
344   #endif
345
346 You cannot portably "stack" cpp directives.  For example in the above
347 you need two separate BURGLE() #defines, one for each #ifdef branch.
348
349 =item *
350
351 Adding non-comment stuff after #endif or #else
352
353   #ifdef SNOSH
354   ...
355   #else !SNOSH    /* BAD */
356   ...
357   #endif SNOSH    /* BAD */
358
359 The #endif and #else cannot portably have anything non-comment after
360 them.  If you want to document what is going (which is a good idea
361 especially if the branches are long), use (C) comments:
362
363   #ifdef SNOSH
364   ...
365   #else /* !SNOSH */
366   ...
367   #endif /* SNOSH */
368
369 The gcc option C<-Wendif-labels> warns about the bad variant (by
370 default on starting from Perl 5.9.4).
371
372 =item *
373
374 Having a comma after the last element of an enum list
375
376   enum color {
377     CERULEAN,
378     CHARTREUSE,
379     CINNABAR,     /* BAD */
380   };
381
382 is not portable.  Leave out the last comma.
383
384 Also note that whether enums are implicitly morphable to ints varies
385 between compilers, you might need to (int).
386
387 =item *
388
389 Using //-comments
390
391   // This function bamfoodles the zorklator.   /* BAD */
392
393 That is C99 or C++.  Perl is C89.  Using the //-comments is silently
394 allowed by many C compilers but cranking up the ANSI C89 strictness
395 (which we like to do) causes the compilation to fail.
396
397 =item *
398
399 Mixing declarations and code
400
401   void zorklator()
402   {
403     int n = 3;
404     set_zorkmids(n);    /* BAD */
405     int q = 4;
406
407 That is C99 or C++.  Some C compilers allow that, but you shouldn't.
408
409 The gcc option C<-Wdeclaration-after-statements> scans for such
410 problems (by default on starting from Perl 5.9.4).
411
412 =item *
413
414 Introducing variables inside for()
415
416   for(int i = ...; ...; ...) {    /* BAD */
417
418 That is C99 or C++.  While it would indeed be awfully nice to have that
419 also in C89, to limit the scope of the loop variable, alas, we cannot.
420
421 =item *
422
423 Mixing signed char pointers with unsigned char pointers
424
425   int foo(char *s) { ... }
426   ...
427   unsigned char *t = ...; /* Or U8* t = ... */
428   foo(t);   /* BAD */
429
430 While this is legal practice, it is certainly dubious, and downright
431 fatal in at least one platform: for example VMS cc considers this a
432 fatal error.  One cause for people often making this mistake is that a
433 "naked char" and therefore dereferencing a "naked char pointer" have an
434 undefined signedness: it depends on the compiler and the flags of the
435 compiler and the underlying platform whether the result is signed or
436 unsigned.  For this very same reason using a 'char' as an array index is
437 bad.
438
439 =item *
440
441 Macros that have string constants and their arguments as substrings of
442 the string constants
443
444   #define FOO(n) printf("number = %d\n", n)    /* BAD */
445   FOO(10);
446
447 Pre-ANSI semantics for that was equivalent to
448
449   printf("10umber = %d\10");
450
451 which is probably not what you were expecting.  Unfortunately at least
452 one reasonably common and modern C compiler does "real backward
453 compatibility" here, in AIX that is what still happens even though the
454 rest of the AIX compiler is very happily C89.
455
456 =item *
457
458 Using printf formats for non-basic C types
459
460    IV i = ...;
461    printf("i = %d\n", i);    /* BAD */
462
463 While this might by accident work in some platform (where IV happens to
464 be an C<int>), in general it cannot.  IV might be something larger.  Even
465 worse the situation is with more specific types (defined by Perl's
466 configuration step in F<config.h>):
467
468    Uid_t who = ...;
469    printf("who = %d\n", who);    /* BAD */
470
471 The problem here is that Uid_t might be not only not C<int>-wide but it
472 might also be unsigned, in which case large uids would be printed as
473 negative values.
474
475 There is no simple solution to this because of printf()'s limited
476 intelligence, but for many types the right format is available as with
477 either 'f' or '_f' suffix, for example:
478
479    IVdf /* IV in decimal */
480    UVxf /* UV is hexadecimal */
481
482    printf("i = %"IVdf"\n", i); /* The IVdf is a string constant. */
483
484    Uid_t_f /* Uid_t in decimal */
485
486    printf("who = %"Uid_t_f"\n", who);
487
488 Or you can try casting to a "wide enough" type:
489
490    printf("i = %"IVdf"\n", (IV)something_very_small_and_signed);
491
492 Also remember that the C<%p> format really does require a void pointer:
493
494    U8* p = ...;
495    printf("p = %p\n", (void*)p);
496
497 The gcc option C<-Wformat> scans for such problems.
498
499 =item *
500
501 Blindly using variadic macros
502
503 gcc has had them for a while with its own syntax, and C99 brought them
504 with a standardized syntax.  Don't use the former, and use the latter
505 only if the HAS_C99_VARIADIC_MACROS is defined.
506
507 =item *
508
509 Blindly passing va_list
510
511 Not all platforms support passing va_list to further varargs (stdarg)
512 functions.  The right thing to do is to copy the va_list using the
513 Perl_va_copy() if the NEED_VA_COPY is defined.
514
515 =item *
516
517 Using gcc statement expressions
518
519    val = ({...;...;...});    /* BAD */
520
521 While a nice extension, it's not portable.  The Perl code does
522 admittedly use them if available to gain some extra speed (essentially
523 as a funky form of inlining), but you shouldn't.
524
525 =item *
526
527 Binding together several statements in a macro
528
529 Use the macros STMT_START and STMT_END.
530
531    STMT_START {
532       ...
533    } STMT_END
534
535 =item *
536
537 Testing for operating systems or versions when should be testing for
538 features
539
540   #ifdef __FOONIX__    /* BAD */
541   foo = quux();
542   #endif
543
544 Unless you know with 100% certainty that quux() is only ever available
545 for the "Foonix" operating system B<and> that is available B<and>
546 correctly working for B<all> past, present, B<and> future versions of
547 "Foonix", the above is very wrong.  This is more correct (though still
548 not perfect, because the below is a compile-time check):
549
550   #ifdef HAS_QUUX
551   foo = quux();
552   #endif
553
554 How does the HAS_QUUX become defined where it needs to be?  Well, if
555 Foonix happens to be Unixy enough to be able to run the Configure
556 script, and Configure has been taught about detecting and testing
557 quux(), the HAS_QUUX will be correctly defined.  In other platforms, the
558 corresponding configuration step will hopefully do the same.
559
560 In a pinch, if you cannot wait for Configure to be educated, or if you
561 have a good hunch of where quux() might be available, you can
562 temporarily try the following:
563
564   #if (defined(__FOONIX__) || defined(__BARNIX__))
565   # define HAS_QUUX
566   #endif
567
568   ...
569
570   #ifdef HAS_QUUX
571   foo = quux();
572   #endif
573
574 But in any case, try to keep the features and operating systems
575 separate.
576
577 =item *
578
579 Assuming the contents of static memory pointed to by the return values
580 of Perl wrappers for C library functions doesn't change.  Many C library
581 functions return pointers to static storage that can be overwritten by
582 subsequent calls to the same or related functions.  Perl has
583 light-weight wrappers for some of these functions, and which don't make
584 copies of the static memory.  A good example is the interface to the
585 environment variables that are in effect for the program.  Perl has
586 C<PerlEnv_getenv> to get values from the environment.  But the return is
587 a pointer to static memory in the C library.  If you are using the value
588 to immediately test for something, that's fine, but if you save the
589 value and expect it to be unchanged by later processing, you would be
590 wrong, but perhaps you wouldn't know it because different C library
591 implementations behave differently, and the one on the platform you're
592 testing on might work for your situation.  But on some platforms, a
593 subsequent call to C<PerlEnv_getenv> or related function WILL overwrite
594 the memory that your first call points to.  This has led to some
595 hard-to-debug problems.  Do a L<perlapi/savepv> to make a copy, thus
596 avoiding these problems.  You will have to free the copy when you're
597 done to avoid memory leaks.  If you don't have control over when it gets
598 freed, you'll need to make the copy in a mortal scalar, like so:
599
600  if ((s = PerlEnv_getenv("foo") == NULL) {
601     ... /* handle NULL case */
602  }
603  else {
604      s = SvPVX(sv_2mortal(newSVpv(s, 0)));
605  }
606
607 The above example works only if C<"s"> is C<NUL>-terminated; otherwise
608 you have to pass its length to C<newSVpv>.
609
610 =back
611
612 =head2 Problematic System Interfaces
613
614 =over 4
615
616 =item *
617
618 malloc(0), realloc(0), calloc(0, 0) are non-portable.  To be portable
619 allocate at least one byte.  (In general you should rarely need to work
620 at this low level, but instead use the various malloc wrappers.)
621
622 =item *
623
624 snprintf() - the return type is unportable.  Use my_snprintf() instead.
625
626 =back
627
628 =head2 Security problems
629
630 Last but not least, here are various tips for safer coding.
631 See also L<perlclib> for libc/stdio replacements one should use.
632
633 =over 4
634
635 =item *
636
637 Do not use gets()
638
639 Or we will publicly ridicule you.  Seriously.
640
641 =item *
642
643 Do not use tmpfile()
644
645 Use mkstemp() instead.
646
647 =item *
648
649 Do not use strcpy() or strcat() or strncpy() or strncat()
650
651 Use my_strlcpy() and my_strlcat() instead: they either use the native
652 implementation, or Perl's own implementation (borrowed from the public
653 domain implementation of INN).
654
655 =item *
656
657 Do not use sprintf() or vsprintf()
658
659 If you really want just plain byte strings, use my_snprintf() and
660 my_vsnprintf() instead, which will try to use snprintf() and
661 vsnprintf() if those safer APIs are available.  If you want something
662 fancier than a plain byte string, use
663 L<C<Perl_form>()|perlapi/form> or SVs and
664 L<C<Perl_sv_catpvf()>|perlapi/sv_catpvf>.
665
666 Note that glibc C<printf()>, C<sprintf()>, etc. are buggy before glibc
667 version 2.17.  They won't allow a C<%.s> format with a precision to
668 create a string that isn't valid UTF-8 if the current underlying locale
669 of the program is UTF-8.  What happens is that the C<%s> and its operand are
670 simply skipped without any notice.
671 L<https://sourceware.org/bugzilla/show_bug.cgi?id=6530>.
672
673 =item *
674
675 Do not use atoi()
676
677 Use grok_atoUV() instead.  atoi() has ill-defined behavior on overflows,
678 and cannot be used for incremental parsing.  It is also affected by locale,
679 which is bad.
680
681 =item *
682
683 Do not use strtol() or strtoul()
684
685 Use grok_atoUV() instead.  strtol() or strtoul() (or their IV/UV-friendly
686 macro disguises, Strtol() and Strtoul(), or Atol() and Atoul() are
687 affected by locale, which is bad.
688
689 =back
690
691 =head1 DEBUGGING
692
693 You can compile a special debugging version of Perl, which allows you
694 to use the C<-D> option of Perl to tell more about what Perl is doing.
695 But sometimes there is no alternative than to dive in with a debugger,
696 either to see the stack trace of a core dump (very useful in a bug
697 report), or trying to figure out what went wrong before the core dump
698 happened, or how did we end up having wrong or unexpected results.
699
700 =head2 Poking at Perl
701
702 To really poke around with Perl, you'll probably want to build Perl for
703 debugging, like this:
704
705     ./Configure -d -D optimize=-g
706     make
707
708 C<-g> is a flag to the C compiler to have it produce debugging
709 information which will allow us to step through a running program, and
710 to see in which C function we are at (without the debugging information
711 we might see only the numerical addresses of the functions, which is
712 not very helpful).
713
714 F<Configure> will also turn on the C<DEBUGGING> compilation symbol
715 which enables all the internal debugging code in Perl.  There are a
716 whole bunch of things you can debug with this: L<perlrun> lists them
717 all, and the best way to find out about them is to play about with
718 them.  The most useful options are probably
719
720     l  Context (loop) stack processing
721     t  Trace execution
722     o  Method and overloading resolution
723     c  String/numeric conversions
724
725 Some of the functionality of the debugging code can be achieved using
726 XS modules.
727
728     -Dr => use re 'debug'
729     -Dx => use O 'Debug'
730
731 =head2 Using a source-level debugger
732
733 If the debugging output of C<-D> doesn't help you, it's time to step
734 through perl's execution with a source-level debugger.
735
736 =over 3
737
738 =item *
739
740 We'll use C<gdb> for our examples here; the principles will apply to
741 any debugger (many vendors call their debugger C<dbx>), but check the
742 manual of the one you're using.
743
744 =back
745
746 To fire up the debugger, type
747
748     gdb ./perl
749
750 Or if you have a core dump:
751
752     gdb ./perl core
753
754 You'll want to do that in your Perl source tree so the debugger can
755 read the source code.  You should see the copyright message, followed by
756 the prompt.
757
758     (gdb)
759
760 C<help> will get you into the documentation, but here are the most
761 useful commands:
762
763 =over 3
764
765 =item * run [args]
766
767 Run the program with the given arguments.
768
769 =item * break function_name
770
771 =item * break source.c:xxx
772
773 Tells the debugger that we'll want to pause execution when we reach
774 either the named function (but see L<perlguts/Internal Functions>!) or
775 the given line in the named source file.
776
777 =item * step
778
779 Steps through the program a line at a time.
780
781 =item * next
782
783 Steps through the program a line at a time, without descending into
784 functions.
785
786 =item * continue
787
788 Run until the next breakpoint.
789
790 =item * finish
791
792 Run until the end of the current function, then stop again.
793
794 =item * 'enter'
795
796 Just pressing Enter will do the most recent operation again - it's a
797 blessing when stepping through miles of source code.
798
799 =item * ptype
800
801 Prints the C definition of the argument given.
802
803   (gdb) ptype PL_op
804   type = struct op {
805       OP *op_next;
806       OP *op_sibling;
807       OP *(*op_ppaddr)(void);
808       PADOFFSET op_targ;
809       unsigned int op_type : 9;
810       unsigned int op_opt : 1;
811       unsigned int op_slabbed : 1;
812       unsigned int op_savefree : 1;
813       unsigned int op_static : 1;
814       unsigned int op_folded : 1;
815       unsigned int op_spare : 2;
816       U8 op_flags;
817       U8 op_private;
818   } *
819
820 =item * print
821
822 Execute the given C code and print its results.  B<WARNING>: Perl makes
823 heavy use of macros, and F<gdb> does not necessarily support macros
824 (see later L</"gdb macro support">).  You'll have to substitute them
825 yourself, or to invoke cpp on the source code files (see L</"The .i
826 Targets">) So, for instance, you can't say
827
828     print SvPV_nolen(sv)
829
830 but you have to say
831
832     print Perl_sv_2pv_nolen(sv)
833
834 =back
835
836 You may find it helpful to have a "macro dictionary", which you can
837 produce by saying C<cpp -dM perl.c | sort>.  Even then, F<cpp> won't
838 recursively apply those macros for you.
839
840 =head2 gdb macro support
841
842 Recent versions of F<gdb> have fairly good macro support, but in order
843 to use it you'll need to compile perl with macro definitions included
844 in the debugging information.  Using F<gcc> version 3.1, this means
845 configuring with C<-Doptimize=-g3>.  Other compilers might use a
846 different switch (if they support debugging macros at all).
847
848 =head2 Dumping Perl Data Structures
849
850 One way to get around this macro hell is to use the dumping functions
851 in F<dump.c>; these work a little like an internal
852 L<Devel::Peek|Devel::Peek>, but they also cover OPs and other
853 structures that you can't get at from Perl.  Let's take an example.
854 We'll use the C<$a = $b + $c> we used before, but give it a bit of
855 context: C<$b = "6XXXX"; $c = 2.3;>.  Where's a good place to stop and
856 poke around?
857
858 What about C<pp_add>, the function we examined earlier to implement the
859 C<+> operator:
860
861     (gdb) break Perl_pp_add
862     Breakpoint 1 at 0x46249f: file pp_hot.c, line 309.
863
864 Notice we use C<Perl_pp_add> and not C<pp_add> - see
865 L<perlguts/Internal Functions>.  With the breakpoint in place, we can
866 run our program:
867
868     (gdb) run -e '$b = "6XXXX"; $c = 2.3; $a = $b + $c'
869
870 Lots of junk will go past as gdb reads in the relevant source files and
871 libraries, and then:
872
873     Breakpoint 1, Perl_pp_add () at pp_hot.c:309
874     309         dSP; dATARGET; tryAMAGICbin(add,opASSIGN);
875     (gdb) step
876     311           dPOPTOPnnrl_ul;
877     (gdb)
878
879 We looked at this bit of code before, and we said that
880 C<dPOPTOPnnrl_ul> arranges for two C<NV>s to be placed into C<left> and
881 C<right> - let's slightly expand it:
882
883  #define dPOPTOPnnrl_ul  NV right = POPn; \
884                          SV *leftsv = TOPs; \
885                          NV left = USE_LEFT(leftsv) ? SvNV(leftsv) : 0.0
886
887 C<POPn> takes the SV from the top of the stack and obtains its NV
888 either directly (if C<SvNOK> is set) or by calling the C<sv_2nv>
889 function.  C<TOPs> takes the next SV from the top of the stack - yes,
890 C<POPn> uses C<TOPs> - but doesn't remove it.  We then use C<SvNV> to
891 get the NV from C<leftsv> in the same way as before - yes, C<POPn> uses
892 C<SvNV>.
893
894 Since we don't have an NV for C<$b>, we'll have to use C<sv_2nv> to
895 convert it.  If we step again, we'll find ourselves there:
896
897     (gdb) step
898     Perl_sv_2nv (sv=0xa0675d0) at sv.c:1669
899     1669        if (!sv)
900     (gdb)
901
902 We can now use C<Perl_sv_dump> to investigate the SV:
903
904     (gdb) print Perl_sv_dump(sv)
905     SV = PV(0xa057cc0) at 0xa0675d0
906     REFCNT = 1
907     FLAGS = (POK,pPOK)
908     PV = 0xa06a510 "6XXXX"\0
909     CUR = 5
910     LEN = 6
911     $1 = void
912
913 We know we're going to get C<6> from this, so let's finish the
914 subroutine:
915
916     (gdb) finish
917     Run till exit from #0  Perl_sv_2nv (sv=0xa0675d0) at sv.c:1671
918     0x462669 in Perl_pp_add () at pp_hot.c:311
919     311           dPOPTOPnnrl_ul;
920
921 We can also dump out this op: the current op is always stored in
922 C<PL_op>, and we can dump it with C<Perl_op_dump>.  This'll give us
923 similar output to L<B::Debug|B::Debug>.
924
925     (gdb) print Perl_op_dump(PL_op)
926     {
927     13  TYPE = add  ===> 14
928         TARG = 1
929         FLAGS = (SCALAR,KIDS)
930         {
931             TYPE = null  ===> (12)
932               (was rv2sv)
933             FLAGS = (SCALAR,KIDS)
934             {
935     11          TYPE = gvsv  ===> 12
936                 FLAGS = (SCALAR)
937                 GV = main::b
938             }
939         }
940
941 # finish this later #
942
943 =head2 Using gdb to look at specific parts of a program
944
945 With the example above, you knew to look for C<Perl_pp_add>, but what if 
946 there were multiple calls to it all over the place, or you didn't know what 
947 the op was you were looking for?
948
949 One way to do this is to inject a rare call somewhere near what you're looking 
950 for.  For example, you could add C<study> before your method:
951
952     study;
953
954 And in gdb do:
955
956     (gdb) break Perl_pp_study
957
958 And then step until you hit what you're
959 looking for.  This works well in a loop 
960 if you want to only break at certain iterations:
961
962     for my $c (1..100) {
963         study if $c == 50;
964     }
965
966 =head2 Using gdb to look at what the parser/lexer are doing
967
968 If you want to see what perl is doing when parsing/lexing your code, you can 
969 use C<BEGIN {}>:
970
971     print "Before\n";
972     BEGIN { study; }
973     print "After\n";
974
975 And in gdb:
976
977     (gdb) break Perl_pp_study
978
979 If you want to see what the parser/lexer is doing inside of C<if> blocks and
980 the like you need to be a little trickier:
981
982     if ($a && $b && do { BEGIN { study } 1 } && $c) { ... } 
983
984 =head1 SOURCE CODE STATIC ANALYSIS
985
986 Various tools exist for analysing C source code B<statically>, as
987 opposed to B<dynamically>, that is, without executing the code.  It is
988 possible to detect resource leaks, undefined behaviour, type
989 mismatches, portability problems, code paths that would cause illegal
990 memory accesses, and other similar problems by just parsing the C code
991 and looking at the resulting graph, what does it tell about the
992 execution and data flows.  As a matter of fact, this is exactly how C
993 compilers know to give warnings about dubious code.
994
995 =head2 lint, splint
996
997 The good old C code quality inspector, C<lint>, is available in several
998 platforms, but please be aware that there are several different
999 implementations of it by different vendors, which means that the flags
1000 are not identical across different platforms.
1001
1002 There is a lint variant called C<splint> (Secure Programming Lint)
1003 available from http://www.splint.org/ that should compile on any
1004 Unix-like platform.
1005
1006 There are C<lint> and <splint> targets in Makefile, but you may have to
1007 diddle with the flags (see above).
1008
1009 =head2 Coverity
1010
1011 Coverity (http://www.coverity.com/) is a product similar to lint and as
1012 a testbed for their product they periodically check several open source
1013 projects, and they give out accounts to open source developers to the
1014 defect databases.
1015
1016 =head2 cpd (cut-and-paste detector)
1017
1018 The cpd tool detects cut-and-paste coding.  If one instance of the
1019 cut-and-pasted code changes, all the other spots should probably be
1020 changed, too.  Therefore such code should probably be turned into a
1021 subroutine or a macro.
1022
1023 cpd (http://pmd.sourceforge.net/cpd.html) is part of the pmd project
1024 (http://pmd.sourceforge.net/).  pmd was originally written for static
1025 analysis of Java code, but later the cpd part of it was extended to
1026 parse also C and C++.
1027
1028 Download the pmd-bin-X.Y.zip () from the SourceForge site, extract the
1029 pmd-X.Y.jar from it, and then run that on source code thusly:
1030
1031   java -cp pmd-X.Y.jar net.sourceforge.pmd.cpd.CPD \
1032    --minimum-tokens 100 --files /some/where/src --language c > cpd.txt
1033
1034 You may run into memory limits, in which case you should use the -Xmx
1035 option:
1036
1037   java -Xmx512M ...
1038
1039 =head2 gcc warnings
1040
1041 Though much can be written about the inconsistency and coverage
1042 problems of gcc warnings (like C<-Wall> not meaning "all the warnings",
1043 or some common portability problems not being covered by C<-Wall>, or
1044 C<-ansi> and C<-pedantic> both being a poorly defined collection of
1045 warnings, and so forth), gcc is still a useful tool in keeping our
1046 coding nose clean.
1047
1048 The C<-Wall> is by default on.
1049
1050 The C<-ansi> (and its sidekick, C<-pedantic>) would be nice to be on
1051 always, but unfortunately they are not safe on all platforms, they can
1052 for example cause fatal conflicts with the system headers (Solaris
1053 being a prime example).  If Configure C<-Dgccansipedantic> is used, the
1054 C<cflags> frontend selects C<-ansi -pedantic> for the platforms where
1055 they are known to be safe.
1056
1057 Starting from Perl 5.9.4 the following extra flags are added:
1058
1059 =over 4
1060
1061 =item *
1062
1063 C<-Wendif-labels>
1064
1065 =item *
1066
1067 C<-Wextra>
1068
1069 =item *
1070
1071 C<-Wdeclaration-after-statement>
1072
1073 =back
1074
1075 The following flags would be nice to have but they would first need
1076 their own Augean stablemaster:
1077
1078 =over 4
1079
1080 =item *
1081
1082 C<-Wpointer-arith>
1083
1084 =item *
1085
1086 C<-Wshadow>
1087
1088 =item *
1089
1090 C<-Wstrict-prototypes>
1091
1092 =back
1093
1094 The C<-Wtraditional> is another example of the annoying tendency of gcc
1095 to bundle a lot of warnings under one switch (it would be impossible to
1096 deploy in practice because it would complain a lot) but it does contain
1097 some warnings that would be beneficial to have available on their own,
1098 such as the warning about string constants inside macros containing the
1099 macro arguments: this behaved differently pre-ANSI than it does in
1100 ANSI, and some C compilers are still in transition, AIX being an
1101 example.
1102
1103 =head2 Warnings of other C compilers
1104
1105 Other C compilers (yes, there B<are> other C compilers than gcc) often
1106 have their "strict ANSI" or "strict ANSI with some portability
1107 extensions" modes on, like for example the Sun Workshop has its C<-Xa>
1108 mode on (though implicitly), or the DEC (these days, HP...) has its
1109 C<-std1> mode on.
1110
1111 =head1 MEMORY DEBUGGERS
1112
1113 B<NOTE 1>: Running under older memory debuggers such as Purify,
1114 valgrind or Third Degree greatly slows down the execution: seconds
1115 become minutes, minutes become hours.  For example as of Perl 5.8.1, the
1116 ext/Encode/t/Unicode.t takes extraordinarily long to complete under
1117 e.g. Purify, Third Degree, and valgrind.  Under valgrind it takes more
1118 than six hours, even on a snappy computer.  The said test must be doing
1119 something that is quite unfriendly for memory debuggers.  If you don't
1120 feel like waiting, that you can simply kill away the perl process.
1121 Roughly valgrind slows down execution by factor 10, AddressSanitizer by
1122 factor 2.
1123
1124 B<NOTE 2>: To minimize the number of memory leak false alarms (see
1125 L</PERL_DESTRUCT_LEVEL> for more information), you have to set the
1126 environment variable PERL_DESTRUCT_LEVEL to 2.  For example, like this:
1127
1128     env PERL_DESTRUCT_LEVEL=2 valgrind ./perl -Ilib ...
1129
1130 B<NOTE 3>: There are known memory leaks when there are compile-time
1131 errors within eval or require, seeing C<S_doeval> in the call stack is
1132 a good sign of these.  Fixing these leaks is non-trivial, unfortunately,
1133 but they must be fixed eventually.
1134
1135 B<NOTE 4>: L<DynaLoader> will not clean up after itself completely
1136 unless Perl is built with the Configure option
1137 C<-Accflags=-DDL_UNLOAD_ALL_AT_EXIT>.
1138
1139 =head2 valgrind
1140
1141 The valgrind tool can be used to find out both memory leaks and illegal
1142 heap memory accesses.  As of version 3.3.0, Valgrind only supports Linux
1143 on x86, x86-64 and PowerPC and Darwin (OS X) on x86 and x86-64).  The
1144 special "test.valgrind" target can be used to run the tests under
1145 valgrind.  Found errors and memory leaks are logged in files named
1146 F<testfile.valgrind> and by default output is displayed inline.
1147
1148 Example usage:
1149
1150     make test.valgrind
1151
1152 Since valgrind adds significant overhead, tests will take much longer to
1153 run.  The valgrind tests support being run in parallel to help with this:
1154
1155     TEST_JOBS=9 make test.valgrind
1156
1157 Note that the above two invocations will be very verbose as reachable
1158 memory and leak-checking is enabled by default.  If you want to just see
1159 pure errors, try:
1160     
1161     VG_OPTS='-q --leak-check=no --show-reachable=no' TEST_JOBS=9 \
1162         make test.valgrind
1163
1164 Valgrind also provides a cachegrind tool, invoked on perl as:
1165
1166     VG_OPTS=--tool=cachegrind make test.valgrind
1167
1168 As system libraries (most notably glibc) are also triggering errors,
1169 valgrind allows to suppress such errors using suppression files.  The
1170 default suppression file that comes with valgrind already catches a lot
1171 of them.  Some additional suppressions are defined in F<t/perl.supp>.
1172
1173 To get valgrind and for more information see
1174
1175     http://valgrind.org/
1176
1177 =head2 AddressSanitizer
1178
1179 AddressSanitizer is a clang and gcc extension, included in clang since
1180 v3.1 and gcc since v4.8.  It checks illegal heap pointers, global
1181 pointers, stack pointers and use after free errors, and is fast enough
1182 that you can easily compile your debugging or optimized perl with it.
1183 It does not check memory leaks though.  AddressSanitizer is available
1184 for Linux, Mac OS X and soon on Windows.
1185
1186 To build perl with AddressSanitizer, your Configure invocation should
1187 look like:
1188
1189     sh Configure -des -Dcc=clang \
1190        -Accflags=-faddress-sanitizer -Aldflags=-faddress-sanitizer \
1191        -Alddlflags=-shared\ -faddress-sanitizer
1192
1193 where these arguments mean:
1194
1195 =over 4
1196
1197 =item * -Dcc=clang
1198
1199 This should be replaced by the full path to your clang executable if it
1200 is not in your path.
1201
1202 =item * -Accflags=-faddress-sanitizer
1203
1204 Compile perl and extensions sources with AddressSanitizer.
1205
1206 =item * -Aldflags=-faddress-sanitizer
1207
1208 Link the perl executable with AddressSanitizer.
1209
1210 =item * -Alddlflags=-shared\ -faddress-sanitizer
1211
1212 Link dynamic extensions with AddressSanitizer.  You must manually
1213 specify C<-shared> because using C<-Alddlflags=-shared> will prevent
1214 Configure from setting a default value for C<lddlflags>, which usually
1215 contains C<-shared> (at least on Linux).
1216
1217 =back
1218
1219 See also
1220 L<http://code.google.com/p/address-sanitizer/wiki/AddressSanitizer>.
1221
1222
1223 =head1 PROFILING
1224
1225 Depending on your platform there are various ways of profiling Perl.
1226
1227 There are two commonly used techniques of profiling executables:
1228 I<statistical time-sampling> and I<basic-block counting>.
1229
1230 The first method takes periodically samples of the CPU program counter,
1231 and since the program counter can be correlated with the code generated
1232 for functions, we get a statistical view of in which functions the
1233 program is spending its time.  The caveats are that very small/fast
1234 functions have lower probability of showing up in the profile, and that
1235 periodically interrupting the program (this is usually done rather
1236 frequently, in the scale of milliseconds) imposes an additional
1237 overhead that may skew the results.  The first problem can be alleviated
1238 by running the code for longer (in general this is a good idea for
1239 profiling), the second problem is usually kept in guard by the
1240 profiling tools themselves.
1241
1242 The second method divides up the generated code into I<basic blocks>.
1243 Basic blocks are sections of code that are entered only in the
1244 beginning and exited only at the end.  For example, a conditional jump
1245 starts a basic block.  Basic block profiling usually works by
1246 I<instrumenting> the code by adding I<enter basic block #nnnn>
1247 book-keeping code to the generated code.  During the execution of the
1248 code the basic block counters are then updated appropriately.  The
1249 caveat is that the added extra code can skew the results: again, the
1250 profiling tools usually try to factor their own effects out of the
1251 results.
1252
1253 =head2 Gprof Profiling
1254
1255 I<gprof> is a profiling tool available in many Unix platforms which
1256 uses I<statistical time-sampling>.  You can build a profiled version of
1257 F<perl> by compiling using gcc with the flag C<-pg>.  Either edit
1258 F<config.sh> or re-run F<Configure>.  Running the profiled version of
1259 Perl will create an output file called F<gmon.out> which contains the
1260 profiling data collected during the execution.
1261
1262 quick hint:
1263
1264     $ sh Configure -des -Dusedevel -Accflags='-pg' \
1265         -Aldflags='-pg' -Alddlflags='-pg -shared' \
1266         && make perl
1267     $ ./perl ... # creates gmon.out in current directory
1268     $ gprof ./perl > out
1269     $ less out
1270
1271 (you probably need to add C<-shared> to the <-Alddlflags> line until RT
1272 #118199 is resolved)
1273
1274 The F<gprof> tool can then display the collected data in various ways.
1275 Usually F<gprof> understands the following options:
1276
1277 =over 4
1278
1279 =item * -a
1280
1281 Suppress statically defined functions from the profile.
1282
1283 =item * -b
1284
1285 Suppress the verbose descriptions in the profile.
1286
1287 =item * -e routine
1288
1289 Exclude the given routine and its descendants from the profile.
1290
1291 =item * -f routine
1292
1293 Display only the given routine and its descendants in the profile.
1294
1295 =item * -s
1296
1297 Generate a summary file called F<gmon.sum> which then may be given to
1298 subsequent gprof runs to accumulate data over several runs.
1299
1300 =item * -z
1301
1302 Display routines that have zero usage.
1303
1304 =back
1305
1306 For more detailed explanation of the available commands and output
1307 formats, see your own local documentation of F<gprof>.
1308
1309 =head2 GCC gcov Profiling
1310
1311 I<basic block profiling> is officially available in gcc 3.0 and later.
1312 You can build a profiled version of F<perl> by compiling using gcc with
1313 the flags C<-fprofile-arcs -ftest-coverage>.  Either edit F<config.sh>
1314 or re-run F<Configure>.
1315
1316 quick hint:
1317
1318     $ sh Configure -des -Dusedevel -Doptimize='-g' \
1319         -Accflags='-fprofile-arcs -ftest-coverage' \
1320         -Aldflags='-fprofile-arcs -ftest-coverage' \
1321         -Alddlflags='-fprofile-arcs -ftest-coverage -shared' \
1322         && make perl
1323     $ rm -f regexec.c.gcov regexec.gcda
1324     $ ./perl ...
1325     $ gcov regexec.c
1326     $ less regexec.c.gcov
1327
1328 (you probably need to add C<-shared> to the <-Alddlflags> line until RT
1329 #118199 is resolved)
1330
1331 Running the profiled version of Perl will cause profile output to be
1332 generated.  For each source file an accompanying F<.gcda> file will be
1333 created.
1334
1335 To display the results you use the I<gcov> utility (which should be
1336 installed if you have gcc 3.0 or newer installed).  F<gcov> is run on
1337 source code files, like this
1338
1339     gcov sv.c
1340
1341 which will cause F<sv.c.gcov> to be created.  The F<.gcov> files contain
1342 the source code annotated with relative frequencies of execution
1343 indicated by "#" markers.  If you want to generate F<.gcov> files for
1344 all profiled object files, you can run something like this:
1345
1346     for file in `find . -name \*.gcno`
1347     do sh -c "cd `dirname $file` && gcov `basename $file .gcno`"
1348     done
1349
1350 Useful options of F<gcov> include C<-b> which will summarise the basic
1351 block, branch, and function call coverage, and C<-c> which instead of
1352 relative frequencies will use the actual counts.  For more information
1353 on the use of F<gcov> and basic block profiling with gcc, see the
1354 latest GNU CC manual.  As of gcc 4.8, this is at
1355 L<http://gcc.gnu.org/onlinedocs/gcc/Gcov-Intro.html#Gcov-Intro>
1356
1357 =head1 MISCELLANEOUS TRICKS
1358
1359 =head2 PERL_DESTRUCT_LEVEL
1360
1361 If you want to run any of the tests yourself manually using e.g.
1362 valgrind, please note that by default perl B<does not> explicitly
1363 cleanup all the memory it has allocated (such as global memory arenas)
1364 but instead lets the exit() of the whole program "take care" of such
1365 allocations, also known as "global destruction of objects".
1366
1367 There is a way to tell perl to do complete cleanup: set the environment
1368 variable PERL_DESTRUCT_LEVEL to a non-zero value.  The t/TEST wrapper
1369 does set this to 2, and this is what you need to do too, if you don't
1370 want to see the "global leaks": For example, for running under valgrind
1371
1372         env PERL_DESTRUCT_LEVEL=2 valgrind ./perl -Ilib t/foo/bar.t
1373
1374 (Note: the mod_perl apache module uses also this environment variable
1375 for its own purposes and extended its semantics.  Refer to the mod_perl
1376 documentation for more information.  Also, spawned threads do the
1377 equivalent of setting this variable to the value 1.)
1378
1379 If, at the end of a run you get the message I<N scalars leaked>, you
1380 can recompile with C<-DDEBUG_LEAKING_SCALARS>, which will cause the
1381 addresses of all those leaked SVs to be dumped along with details as to
1382 where each SV was originally allocated.  This information is also
1383 displayed by Devel::Peek.  Note that the extra details recorded with
1384 each SV increases memory usage, so it shouldn't be used in production
1385 environments.  It also converts C<new_SV()> from a macro into a real
1386 function, so you can use your favourite debugger to discover where
1387 those pesky SVs were allocated.
1388
1389 If you see that you're leaking memory at runtime, but neither valgrind
1390 nor C<-DDEBUG_LEAKING_SCALARS> will find anything, you're probably
1391 leaking SVs that are still reachable and will be properly cleaned up
1392 during destruction of the interpreter.  In such cases, using the C<-Dm>
1393 switch can point you to the source of the leak.  If the executable was
1394 built with C<-DDEBUG_LEAKING_SCALARS>, C<-Dm> will output SV
1395 allocations in addition to memory allocations.  Each SV allocation has a
1396 distinct serial number that will be written on creation and destruction
1397 of the SV.  So if you're executing the leaking code in a loop, you need
1398 to look for SVs that are created, but never destroyed between each
1399 cycle.  If such an SV is found, set a conditional breakpoint within
1400 C<new_SV()> and make it break only when C<PL_sv_serial> is equal to the
1401 serial number of the leaking SV.  Then you will catch the interpreter in
1402 exactly the state where the leaking SV is allocated, which is
1403 sufficient in many cases to find the source of the leak.
1404
1405 As C<-Dm> is using the PerlIO layer for output, it will by itself
1406 allocate quite a bunch of SVs, which are hidden to avoid recursion.  You
1407 can bypass the PerlIO layer if you use the SV logging provided by
1408 C<-DPERL_MEM_LOG> instead.
1409
1410 =head2 PERL_MEM_LOG
1411
1412 If compiled with C<-DPERL_MEM_LOG>, both memory and SV allocations go
1413 through logging functions, which is handy for breakpoint setting.
1414
1415 Unless C<-DPERL_MEM_LOG_NOIMPL> is also compiled, the logging functions
1416 read $ENV{PERL_MEM_LOG} to determine whether to log the event, and if
1417 so how:
1418
1419     $ENV{PERL_MEM_LOG} =~ /m/           Log all memory ops
1420     $ENV{PERL_MEM_LOG} =~ /s/           Log all SV ops
1421     $ENV{PERL_MEM_LOG} =~ /t/           include timestamp in Log
1422     $ENV{PERL_MEM_LOG} =~ /^(\d+)/      write to FD given (default is 2)
1423
1424 Memory logging is somewhat similar to C<-Dm> but is independent of
1425 C<-DDEBUGGING>, and at a higher level; all uses of Newx(), Renew(), and
1426 Safefree() are logged with the caller's source code file and line
1427 number (and C function name, if supported by the C compiler).  In
1428 contrast, C<-Dm> is directly at the point of C<malloc()>.  SV logging is
1429 similar.
1430
1431 Since the logging doesn't use PerlIO, all SV allocations are logged and
1432 no extra SV allocations are introduced by enabling the logging.  If
1433 compiled with C<-DDEBUG_LEAKING_SCALARS>, the serial number for each SV
1434 allocation is also logged.
1435
1436 =head2 DDD over gdb
1437
1438 Those debugging perl with the DDD frontend over gdb may find the
1439 following useful:
1440
1441 You can extend the data conversion shortcuts menu, so for example you
1442 can display an SV's IV value with one click, without doing any typing.
1443 To do that simply edit ~/.ddd/init file and add after:
1444
1445   ! Display shortcuts.
1446   Ddd*gdbDisplayShortcuts: \
1447   /t ()   // Convert to Bin\n\
1448   /d ()   // Convert to Dec\n\
1449   /x ()   // Convert to Hex\n\
1450   /o ()   // Convert to Oct(\n\
1451
1452 the following two lines:
1453
1454   ((XPV*) (())->sv_any )->xpv_pv  // 2pvx\n\
1455   ((XPVIV*) (())->sv_any )->xiv_iv // 2ivx
1456
1457 so now you can do ivx and pvx lookups or you can plug there the sv_peek
1458 "conversion":
1459
1460   Perl_sv_peek(my_perl, (SV*)()) // sv_peek
1461
1462 (The my_perl is for threaded builds.)  Just remember that every line,
1463 but the last one, should end with \n\
1464
1465 Alternatively edit the init file interactively via: 3rd mouse button ->
1466 New Display -> Edit Menu
1467
1468 Note: you can define up to 20 conversion shortcuts in the gdb section.
1469
1470 =head2 C backtrace
1471
1472 On some platforms Perl supports retrieving the C level backtrace
1473 (similar to what symbolic debuggers like gdb do).
1474
1475 The backtrace returns the stack trace of the C call frames,
1476 with the symbol names (function names), the object names (like "perl"),
1477 and if it can, also the source code locations (file:line).
1478
1479 The supported platforms are Linux, and OS X (some *BSD might
1480 work at least partly, but they have not yet been tested).
1481
1482 This feature hasn't been tested with multiple threads, but it will
1483 only show the backtrace of the thread doing the backtracing.
1484
1485 The feature needs to be enabled with C<Configure -Dusecbacktrace>.
1486
1487 The C<-Dusecbacktrace> also enables keeping the debug information when
1488 compiling/linking (often: C<-g>).  Many compilers/linkers do support
1489 having both optimization and keeping the debug information.  The debug
1490 information is needed for the symbol names and the source locations.
1491
1492 Static functions might not be visible for the backtrace.
1493
1494 Source code locations, even if available, can often be missing or
1495 misleading if the compiler has e.g. inlined code.  Optimizer can
1496 make matching the source code and the object code quite challenging.
1497
1498 =over 4
1499
1500 =item Linux
1501
1502 You B<must> have the BFD (-lbfd) library installed, otherwise C<perl> will
1503 fail to link.  The BFD is usually distributed as part of the GNU binutils.
1504
1505 Summary: C<Configure ... -Dusecbacktrace>
1506 and you need C<-lbfd>.
1507
1508 =item OS X
1509
1510 The source code locations are supported B<only> if you have
1511 the Developer Tools installed.  (BFD is B<not> needed.)
1512
1513 Summary: C<Configure ... -Dusecbacktrace>
1514 and installing the Developer Tools would be good.
1515
1516 =back
1517
1518 Optionally, for trying out the feature, you may want to enable
1519 automatic dumping of the backtrace just before a warning or croak (die)
1520 message is emitted, by adding C<-Accflags=-DUSE_C_BACKTRACE_ON_ERROR>
1521 for Configure.
1522
1523 Unless the above additional feature is enabled, nothing about the
1524 backtrace functionality is visible, except for the Perl/XS level.
1525
1526 Furthermore, even if you have enabled this feature to be compiled,
1527 you need to enable it in runtime with an environment variable:
1528 C<PERL_C_BACKTRACE_ON_ERROR=10>.  It must be an integer higher
1529 than zero, telling the desired frame count.
1530
1531 Retrieving the backtrace from Perl level (using for example an XS
1532 extension) would be much less exciting than one would hope: normally
1533 you would see C<runops>, C<entersub>, and not much else.  This API is
1534 intended to be called B<from within> the Perl implementation, not from
1535 Perl level execution.
1536
1537 The C API for the backtrace is as follows:
1538
1539 =over 4
1540
1541 =item get_c_backtrace
1542
1543 =item free_c_backtrace
1544
1545 =item get_c_backtrace_dump
1546
1547 =item dump_c_backtrace
1548
1549 =back
1550
1551 =head2 Poison
1552
1553 If you see in a debugger a memory area mysteriously full of 0xABABABAB
1554 or 0xEFEFEFEF, you may be seeing the effect of the Poison() macros, see
1555 L<perlclib>.
1556
1557 =head2 Read-only optrees
1558
1559 Under ithreads the optree is read only.  If you want to enforce this, to
1560 check for write accesses from buggy code, compile with
1561 C<-Accflags=-DPERL_DEBUG_READONLY_OPS>
1562 to enable code that allocates op memory
1563 via C<mmap>, and sets it read-only when it is attached to a subroutine.
1564 Any write access to an op results in a C<SIGBUS> and abort.
1565
1566 This code is intended for development only, and may not be portable
1567 even to all Unix variants.  Also, it is an 80% solution, in that it
1568 isn't able to make all ops read only.  Specifically it does not apply to
1569 op slabs belonging to C<BEGIN> blocks.
1570
1571 However, as an 80% solution it is still effective, as it has caught
1572 bugs in the past.
1573
1574 =head2 When is a bool not a bool?
1575
1576 On pre-C99 compilers, C<bool> is defined as equivalent to C<char>.
1577 Consequently assignment of any larger type to a C<bool> is unsafe and may
1578 be truncated.  The C<cBOOL> macro exists to cast it correctly.
1579
1580 On those platforms and compilers where C<bool> really is a boolean (C++,
1581 C99), it is easy to forget the cast.  You can force C<bool> to be a C<char>
1582 by compiling with C<-Accflags=-DPERL_BOOL_AS_CHAR>.  You may also wish to
1583 run C<Configure> with something like
1584
1585     -Accflags='-Wconversion -Wno-sign-conversion -Wno-shorten-64-to-32'
1586
1587 or your compiler's equivalent to make it easier to spot any unsafe truncations
1588 that show up.
1589
1590 =head2 The .i Targets
1591
1592 You can expand the macros in a F<foo.c> file by saying
1593
1594     make foo.i
1595
1596 which will expand the macros using cpp.  Don't be scared by the
1597 results.
1598
1599 =head1 AUTHOR
1600
1601 This document was originally written by Nathan Torkington, and is
1602 maintained by the perl5-porters mailing list.