perldelta for previous commit (threads upgrade)
[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 =back
578
579 =head2 Problematic System Interfaces
580
581 =over 4
582
583 =item *
584
585 malloc(0), realloc(0), calloc(0, 0) are non-portable.  To be portable
586 allocate at least one byte.  (In general you should rarely need to work
587 at this low level, but instead use the various malloc wrappers.)
588
589 =item *
590
591 snprintf() - the return type is unportable.  Use my_snprintf() instead.
592
593 =back
594
595 =head2 Security problems
596
597 Last but not least, here are various tips for safer coding.
598 See also L<perlclib> for libc/stdio replacements one should use.
599
600 =over 4
601
602 =item *
603
604 Do not use gets()
605
606 Or we will publicly ridicule you.  Seriously.
607
608 =item *
609
610 Do not use tmpfile()
611
612 Use mkstemp() instead.
613
614 =item *
615
616 Do not use strcpy() or strcat() or strncpy() or strncat()
617
618 Use my_strlcpy() and my_strlcat() instead: they either use the native
619 implementation, or Perl's own implementation (borrowed from the public
620 domain implementation of INN).
621
622 =item *
623
624 Do not use sprintf() or vsprintf()
625
626 If you really want just plain byte strings, use my_snprintf() and
627 my_vsnprintf() instead, which will try to use snprintf() and
628 vsnprintf() if those safer APIs are available.  If you want something
629 fancier than a plain byte string, use
630 L<C<Perl_form>()|perlapi/form> or SVs and
631 L<C<Perl_sv_catpvf()>|perlapi/sv_catpvf>.
632
633 Note that glibc C<printf()>, C<sprintf()>, etc. are buggy before glibc
634 version 2.17.  They won't allow a C<%.s> format with a precision to
635 create a string that isn't valid UTF-8 if the current underlying locale
636 of the program is UTF-8.  What happens is that the C<%s> and its operand are
637 simply skipped without any notice.
638 L<https://sourceware.org/bugzilla/show_bug.cgi?id=6530>.
639
640 =item *
641
642 Do not use atoi()
643
644 Use grok_atou() instead.  atoi() has ill-defined behavior on overflows,
645 and cannot be used for incremental parsing.  It is also affected by locale,
646 which is bad.
647
648 =item *
649
650 Do not use strtol() or strtoul()
651
652 Use grok_atou() instead.  strtol() or strtoul() (or their IV/UV-friendly
653 macro disguises, Strtol() and Strtoul(), or Atol() and Atoul() are
654 affected by locale, which is bad.
655
656 =back
657
658 =head1 DEBUGGING
659
660 You can compile a special debugging version of Perl, which allows you
661 to use the C<-D> option of Perl to tell more about what Perl is doing.
662 But sometimes there is no alternative than to dive in with a debugger,
663 either to see the stack trace of a core dump (very useful in a bug
664 report), or trying to figure out what went wrong before the core dump
665 happened, or how did we end up having wrong or unexpected results.
666
667 =head2 Poking at Perl
668
669 To really poke around with Perl, you'll probably want to build Perl for
670 debugging, like this:
671
672     ./Configure -d -D optimize=-g
673     make
674
675 C<-g> is a flag to the C compiler to have it produce debugging
676 information which will allow us to step through a running program, and
677 to see in which C function we are at (without the debugging information
678 we might see only the numerical addresses of the functions, which is
679 not very helpful).
680
681 F<Configure> will also turn on the C<DEBUGGING> compilation symbol
682 which enables all the internal debugging code in Perl.  There are a
683 whole bunch of things you can debug with this: L<perlrun> lists them
684 all, and the best way to find out about them is to play about with
685 them.  The most useful options are probably
686
687     l  Context (loop) stack processing
688     t  Trace execution
689     o  Method and overloading resolution
690     c  String/numeric conversions
691
692 Some of the functionality of the debugging code can be achieved using
693 XS modules.
694
695     -Dr => use re 'debug'
696     -Dx => use O 'Debug'
697
698 =head2 Using a source-level debugger
699
700 If the debugging output of C<-D> doesn't help you, it's time to step
701 through perl's execution with a source-level debugger.
702
703 =over 3
704
705 =item *
706
707 We'll use C<gdb> for our examples here; the principles will apply to
708 any debugger (many vendors call their debugger C<dbx>), but check the
709 manual of the one you're using.
710
711 =back
712
713 To fire up the debugger, type
714
715     gdb ./perl
716
717 Or if you have a core dump:
718
719     gdb ./perl core
720
721 You'll want to do that in your Perl source tree so the debugger can
722 read the source code.  You should see the copyright message, followed by
723 the prompt.
724
725     (gdb)
726
727 C<help> will get you into the documentation, but here are the most
728 useful commands:
729
730 =over 3
731
732 =item * run [args]
733
734 Run the program with the given arguments.
735
736 =item * break function_name
737
738 =item * break source.c:xxx
739
740 Tells the debugger that we'll want to pause execution when we reach
741 either the named function (but see L<perlguts/Internal Functions>!) or
742 the given line in the named source file.
743
744 =item * step
745
746 Steps through the program a line at a time.
747
748 =item * next
749
750 Steps through the program a line at a time, without descending into
751 functions.
752
753 =item * continue
754
755 Run until the next breakpoint.
756
757 =item * finish
758
759 Run until the end of the current function, then stop again.
760
761 =item * 'enter'
762
763 Just pressing Enter will do the most recent operation again - it's a
764 blessing when stepping through miles of source code.
765
766 =item * ptype
767
768 Prints the C definition of the argument given.
769
770   (gdb) ptype PL_op
771   type = struct op {
772       OP *op_next;
773       OP *op_sibling;
774       OP *(*op_ppaddr)(void);
775       PADOFFSET op_targ;
776       unsigned int op_type : 9;
777       unsigned int op_opt : 1;
778       unsigned int op_slabbed : 1;
779       unsigned int op_savefree : 1;
780       unsigned int op_static : 1;
781       unsigned int op_folded : 1;
782       unsigned int op_spare : 2;
783       U8 op_flags;
784       U8 op_private;
785   } *
786
787 =item * print
788
789 Execute the given C code and print its results.  B<WARNING>: Perl makes
790 heavy use of macros, and F<gdb> does not necessarily support macros
791 (see later L</"gdb macro support">).  You'll have to substitute them
792 yourself, or to invoke cpp on the source code files (see L</"The .i
793 Targets">) So, for instance, you can't say
794
795     print SvPV_nolen(sv)
796
797 but you have to say
798
799     print Perl_sv_2pv_nolen(sv)
800
801 =back
802
803 You may find it helpful to have a "macro dictionary", which you can
804 produce by saying C<cpp -dM perl.c | sort>.  Even then, F<cpp> won't
805 recursively apply those macros for you.
806
807 =head2 gdb macro support
808
809 Recent versions of F<gdb> have fairly good macro support, but in order
810 to use it you'll need to compile perl with macro definitions included
811 in the debugging information.  Using F<gcc> version 3.1, this means
812 configuring with C<-Doptimize=-g3>.  Other compilers might use a
813 different switch (if they support debugging macros at all).
814
815 =head2 Dumping Perl Data Structures
816
817 One way to get around this macro hell is to use the dumping functions
818 in F<dump.c>; these work a little like an internal
819 L<Devel::Peek|Devel::Peek>, but they also cover OPs and other
820 structures that you can't get at from Perl.  Let's take an example.
821 We'll use the C<$a = $b + $c> we used before, but give it a bit of
822 context: C<$b = "6XXXX"; $c = 2.3;>.  Where's a good place to stop and
823 poke around?
824
825 What about C<pp_add>, the function we examined earlier to implement the
826 C<+> operator:
827
828     (gdb) break Perl_pp_add
829     Breakpoint 1 at 0x46249f: file pp_hot.c, line 309.
830
831 Notice we use C<Perl_pp_add> and not C<pp_add> - see
832 L<perlguts/Internal Functions>.  With the breakpoint in place, we can
833 run our program:
834
835     (gdb) run -e '$b = "6XXXX"; $c = 2.3; $a = $b + $c'
836
837 Lots of junk will go past as gdb reads in the relevant source files and
838 libraries, and then:
839
840     Breakpoint 1, Perl_pp_add () at pp_hot.c:309
841     309         dSP; dATARGET; tryAMAGICbin(add,opASSIGN);
842     (gdb) step
843     311           dPOPTOPnnrl_ul;
844     (gdb)
845
846 We looked at this bit of code before, and we said that
847 C<dPOPTOPnnrl_ul> arranges for two C<NV>s to be placed into C<left> and
848 C<right> - let's slightly expand it:
849
850  #define dPOPTOPnnrl_ul  NV right = POPn; \
851                          SV *leftsv = TOPs; \
852                          NV left = USE_LEFT(leftsv) ? SvNV(leftsv) : 0.0
853
854 C<POPn> takes the SV from the top of the stack and obtains its NV
855 either directly (if C<SvNOK> is set) or by calling the C<sv_2nv>
856 function.  C<TOPs> takes the next SV from the top of the stack - yes,
857 C<POPn> uses C<TOPs> - but doesn't remove it.  We then use C<SvNV> to
858 get the NV from C<leftsv> in the same way as before - yes, C<POPn> uses
859 C<SvNV>.
860
861 Since we don't have an NV for C<$b>, we'll have to use C<sv_2nv> to
862 convert it.  If we step again, we'll find ourselves there:
863
864     (gdb) step
865     Perl_sv_2nv (sv=0xa0675d0) at sv.c:1669
866     1669        if (!sv)
867     (gdb)
868
869 We can now use C<Perl_sv_dump> to investigate the SV:
870
871     (gdb) print Perl_sv_dump(sv)
872     SV = PV(0xa057cc0) at 0xa0675d0
873     REFCNT = 1
874     FLAGS = (POK,pPOK)
875     PV = 0xa06a510 "6XXXX"\0
876     CUR = 5
877     LEN = 6
878     $1 = void
879
880 We know we're going to get C<6> from this, so let's finish the
881 subroutine:
882
883     (gdb) finish
884     Run till exit from #0  Perl_sv_2nv (sv=0xa0675d0) at sv.c:1671
885     0x462669 in Perl_pp_add () at pp_hot.c:311
886     311           dPOPTOPnnrl_ul;
887
888 We can also dump out this op: the current op is always stored in
889 C<PL_op>, and we can dump it with C<Perl_op_dump>.  This'll give us
890 similar output to L<B::Debug|B::Debug>.
891
892     (gdb) print Perl_op_dump(PL_op)
893     {
894     13  TYPE = add  ===> 14
895         TARG = 1
896         FLAGS = (SCALAR,KIDS)
897         {
898             TYPE = null  ===> (12)
899               (was rv2sv)
900             FLAGS = (SCALAR,KIDS)
901             {
902     11          TYPE = gvsv  ===> 12
903                 FLAGS = (SCALAR)
904                 GV = main::b
905             }
906         }
907
908 # finish this later #
909
910 =head2 Using gdb to look at specific parts of a program
911
912 With the example above, you knew to look for C<Perl_pp_add>, but what if 
913 there were multiple calls to it all over the place, or you didn't know what 
914 the op was you were looking for?
915
916 One way to do this is to inject a rare call somewhere near what you're looking 
917 for.  For example, you could add C<study> before your method:
918
919     study;
920
921 And in gdb do:
922
923     (gdb) break Perl_pp_study
924
925 And then step until you hit what you're
926 looking for.  This works well in a loop 
927 if you want to only break at certain iterations:
928
929     for my $c (1..100) {
930         study if $c == 50;
931     }
932
933 =head2 Using gdb to look at what the parser/lexer are doing
934
935 If you want to see what perl is doing when parsing/lexing your code, you can 
936 use C<BEGIN {}>:
937
938     print "Before\n";
939     BEGIN { study; }
940     print "After\n";
941
942 And in gdb:
943
944     (gdb) break Perl_pp_study
945
946 If you want to see what the parser/lexer is doing inside of C<if> blocks and
947 the like you need to be a little trickier:
948
949     if ($a && $b && do { BEGIN { study } 1 } && $c) { ... } 
950
951 =head1 SOURCE CODE STATIC ANALYSIS
952
953 Various tools exist for analysing C source code B<statically>, as
954 opposed to B<dynamically>, that is, without executing the code.  It is
955 possible to detect resource leaks, undefined behaviour, type
956 mismatches, portability problems, code paths that would cause illegal
957 memory accesses, and other similar problems by just parsing the C code
958 and looking at the resulting graph, what does it tell about the
959 execution and data flows.  As a matter of fact, this is exactly how C
960 compilers know to give warnings about dubious code.
961
962 =head2 lint, splint
963
964 The good old C code quality inspector, C<lint>, is available in several
965 platforms, but please be aware that there are several different
966 implementations of it by different vendors, which means that the flags
967 are not identical across different platforms.
968
969 There is a lint variant called C<splint> (Secure Programming Lint)
970 available from http://www.splint.org/ that should compile on any
971 Unix-like platform.
972
973 There are C<lint> and <splint> targets in Makefile, but you may have to
974 diddle with the flags (see above).
975
976 =head2 Coverity
977
978 Coverity (http://www.coverity.com/) is a product similar to lint and as
979 a testbed for their product they periodically check several open source
980 projects, and they give out accounts to open source developers to the
981 defect databases.
982
983 =head2 cpd (cut-and-paste detector)
984
985 The cpd tool detects cut-and-paste coding.  If one instance of the
986 cut-and-pasted code changes, all the other spots should probably be
987 changed, too.  Therefore such code should probably be turned into a
988 subroutine or a macro.
989
990 cpd (http://pmd.sourceforge.net/cpd.html) is part of the pmd project
991 (http://pmd.sourceforge.net/).  pmd was originally written for static
992 analysis of Java code, but later the cpd part of it was extended to
993 parse also C and C++.
994
995 Download the pmd-bin-X.Y.zip () from the SourceForge site, extract the
996 pmd-X.Y.jar from it, and then run that on source code thusly:
997
998   java -cp pmd-X.Y.jar net.sourceforge.pmd.cpd.CPD \
999    --minimum-tokens 100 --files /some/where/src --language c > cpd.txt
1000
1001 You may run into memory limits, in which case you should use the -Xmx
1002 option:
1003
1004   java -Xmx512M ...
1005
1006 =head2 gcc warnings
1007
1008 Though much can be written about the inconsistency and coverage
1009 problems of gcc warnings (like C<-Wall> not meaning "all the warnings",
1010 or some common portability problems not being covered by C<-Wall>, or
1011 C<-ansi> and C<-pedantic> both being a poorly defined collection of
1012 warnings, and so forth), gcc is still a useful tool in keeping our
1013 coding nose clean.
1014
1015 The C<-Wall> is by default on.
1016
1017 The C<-ansi> (and its sidekick, C<-pedantic>) would be nice to be on
1018 always, but unfortunately they are not safe on all platforms, they can
1019 for example cause fatal conflicts with the system headers (Solaris
1020 being a prime example).  If Configure C<-Dgccansipedantic> is used, the
1021 C<cflags> frontend selects C<-ansi -pedantic> for the platforms where
1022 they are known to be safe.
1023
1024 Starting from Perl 5.9.4 the following extra flags are added:
1025
1026 =over 4
1027
1028 =item *
1029
1030 C<-Wendif-labels>
1031
1032 =item *
1033
1034 C<-Wextra>
1035
1036 =item *
1037
1038 C<-Wdeclaration-after-statement>
1039
1040 =back
1041
1042 The following flags would be nice to have but they would first need
1043 their own Augean stablemaster:
1044
1045 =over 4
1046
1047 =item *
1048
1049 C<-Wpointer-arith>
1050
1051 =item *
1052
1053 C<-Wshadow>
1054
1055 =item *
1056
1057 C<-Wstrict-prototypes>
1058
1059 =back
1060
1061 The C<-Wtraditional> is another example of the annoying tendency of gcc
1062 to bundle a lot of warnings under one switch (it would be impossible to
1063 deploy in practice because it would complain a lot) but it does contain
1064 some warnings that would be beneficial to have available on their own,
1065 such as the warning about string constants inside macros containing the
1066 macro arguments: this behaved differently pre-ANSI than it does in
1067 ANSI, and some C compilers are still in transition, AIX being an
1068 example.
1069
1070 =head2 Warnings of other C compilers
1071
1072 Other C compilers (yes, there B<are> other C compilers than gcc) often
1073 have their "strict ANSI" or "strict ANSI with some portability
1074 extensions" modes on, like for example the Sun Workshop has its C<-Xa>
1075 mode on (though implicitly), or the DEC (these days, HP...) has its
1076 C<-std1> mode on.
1077
1078 =head1 MEMORY DEBUGGERS
1079
1080 B<NOTE 1>: Running under older memory debuggers such as Purify,
1081 valgrind or Third Degree greatly slows down the execution: seconds
1082 become minutes, minutes become hours.  For example as of Perl 5.8.1, the
1083 ext/Encode/t/Unicode.t takes extraordinarily long to complete under
1084 e.g. Purify, Third Degree, and valgrind.  Under valgrind it takes more
1085 than six hours, even on a snappy computer.  The said test must be doing
1086 something that is quite unfriendly for memory debuggers.  If you don't
1087 feel like waiting, that you can simply kill away the perl process.
1088 Roughly valgrind slows down execution by factor 10, AddressSanitizer by
1089 factor 2.
1090
1091 B<NOTE 2>: To minimize the number of memory leak false alarms (see
1092 L</PERL_DESTRUCT_LEVEL> for more information), you have to set the
1093 environment variable PERL_DESTRUCT_LEVEL to 2.  For example, like this:
1094
1095     env PERL_DESTRUCT_LEVEL=2 valgrind ./perl -Ilib ...
1096
1097 B<NOTE 3>: There are known memory leaks when there are compile-time
1098 errors within eval or require, seeing C<S_doeval> in the call stack is
1099 a good sign of these.  Fixing these leaks is non-trivial, unfortunately,
1100 but they must be fixed eventually.
1101
1102 B<NOTE 4>: L<DynaLoader> will not clean up after itself completely
1103 unless Perl is built with the Configure option
1104 C<-Accflags=-DDL_UNLOAD_ALL_AT_EXIT>.
1105
1106 =head2 valgrind
1107
1108 The valgrind tool can be used to find out both memory leaks and illegal
1109 heap memory accesses.  As of version 3.3.0, Valgrind only supports Linux
1110 on x86, x86-64 and PowerPC and Darwin (OS X) on x86 and x86-64).  The
1111 special "test.valgrind" target can be used to run the tests under
1112 valgrind.  Found errors and memory leaks are logged in files named
1113 F<testfile.valgrind> and by default output is displayed inline.
1114
1115 Example usage:
1116
1117     make test.valgrind
1118
1119 Since valgrind adds significant overhead, tests will take much longer to
1120 run.  The valgrind tests support being run in parallel to help with this:
1121
1122     TEST_JOBS=9 make test.valgrind
1123
1124 Note that the above two invocations will be very verbose as reachable
1125 memory and leak-checking is enabled by default.  If you want to just see
1126 pure errors, try:
1127     
1128     VG_OPTS='-q --leak-check=no --show-reachable=no' TEST_JOBS=9 \
1129         make test.valgrind
1130
1131 Valgrind also provides a cachegrind tool, invoked on perl as:
1132
1133     VG_OPTS=--tool=cachegrind make test.valgrind
1134
1135 As system libraries (most notably glibc) are also triggering errors,
1136 valgrind allows to suppress such errors using suppression files.  The
1137 default suppression file that comes with valgrind already catches a lot
1138 of them.  Some additional suppressions are defined in F<t/perl.supp>.
1139
1140 To get valgrind and for more information see
1141
1142     http://valgrind.org/
1143
1144 =head2 AddressSanitizer
1145
1146 AddressSanitizer is a clang and gcc extension, included in clang since
1147 v3.1 and gcc since v4.8.  It checks illegal heap pointers, global
1148 pointers, stack pointers and use after free errors, and is fast enough
1149 that you can easily compile your debugging or optimized perl with it.
1150 It does not check memory leaks though.  AddressSanitizer is available
1151 for Linux, Mac OS X and soon on Windows.
1152
1153 To build perl with AddressSanitizer, your Configure invocation should
1154 look like:
1155
1156     sh Configure -des -Dcc=clang \
1157        -Accflags=-faddress-sanitizer -Aldflags=-faddress-sanitizer \
1158        -Alddlflags=-shared\ -faddress-sanitizer
1159
1160 where these arguments mean:
1161
1162 =over 4
1163
1164 =item * -Dcc=clang
1165
1166 This should be replaced by the full path to your clang executable if it
1167 is not in your path.
1168
1169 =item * -Accflags=-faddress-sanitizer
1170
1171 Compile perl and extensions sources with AddressSanitizer.
1172
1173 =item * -Aldflags=-faddress-sanitizer
1174
1175 Link the perl executable with AddressSanitizer.
1176
1177 =item * -Alddlflags=-shared\ -faddress-sanitizer
1178
1179 Link dynamic extensions with AddressSanitizer.  You must manually
1180 specify C<-shared> because using C<-Alddlflags=-shared> will prevent
1181 Configure from setting a default value for C<lddlflags>, which usually
1182 contains C<-shared> (at least on Linux).
1183
1184 =back
1185
1186 See also
1187 L<http://code.google.com/p/address-sanitizer/wiki/AddressSanitizer>.
1188
1189
1190 =head1 PROFILING
1191
1192 Depending on your platform there are various ways of profiling Perl.
1193
1194 There are two commonly used techniques of profiling executables:
1195 I<statistical time-sampling> and I<basic-block counting>.
1196
1197 The first method takes periodically samples of the CPU program counter,
1198 and since the program counter can be correlated with the code generated
1199 for functions, we get a statistical view of in which functions the
1200 program is spending its time.  The caveats are that very small/fast
1201 functions have lower probability of showing up in the profile, and that
1202 periodically interrupting the program (this is usually done rather
1203 frequently, in the scale of milliseconds) imposes an additional
1204 overhead that may skew the results.  The first problem can be alleviated
1205 by running the code for longer (in general this is a good idea for
1206 profiling), the second problem is usually kept in guard by the
1207 profiling tools themselves.
1208
1209 The second method divides up the generated code into I<basic blocks>.
1210 Basic blocks are sections of code that are entered only in the
1211 beginning and exited only at the end.  For example, a conditional jump
1212 starts a basic block.  Basic block profiling usually works by
1213 I<instrumenting> the code by adding I<enter basic block #nnnn>
1214 book-keeping code to the generated code.  During the execution of the
1215 code the basic block counters are then updated appropriately.  The
1216 caveat is that the added extra code can skew the results: again, the
1217 profiling tools usually try to factor their own effects out of the
1218 results.
1219
1220 =head2 Gprof Profiling
1221
1222 I<gprof> is a profiling tool available in many Unix platforms which
1223 uses I<statistical time-sampling>.  You can build a profiled version of
1224 F<perl> by compiling using gcc with the flag C<-pg>.  Either edit
1225 F<config.sh> or re-run F<Configure>.  Running the profiled version of
1226 Perl will create an output file called F<gmon.out> which contains the
1227 profiling data collected during the execution.
1228
1229 quick hint:
1230
1231     $ sh Configure -des -Dusedevel -Accflags='-pg' \
1232         -Aldflags='-pg' -Alddlflags='-pg -shared' \
1233         && make perl
1234     $ ./perl ... # creates gmon.out in current directory
1235     $ gprof ./perl > out
1236     $ less out
1237
1238 (you probably need to add C<-shared> to the <-Alddlflags> line until RT
1239 #118199 is resolved)
1240
1241 The F<gprof> tool can then display the collected data in various ways.
1242 Usually F<gprof> understands the following options:
1243
1244 =over 4
1245
1246 =item * -a
1247
1248 Suppress statically defined functions from the profile.
1249
1250 =item * -b
1251
1252 Suppress the verbose descriptions in the profile.
1253
1254 =item * -e routine
1255
1256 Exclude the given routine and its descendants from the profile.
1257
1258 =item * -f routine
1259
1260 Display only the given routine and its descendants in the profile.
1261
1262 =item * -s
1263
1264 Generate a summary file called F<gmon.sum> which then may be given to
1265 subsequent gprof runs to accumulate data over several runs.
1266
1267 =item * -z
1268
1269 Display routines that have zero usage.
1270
1271 =back
1272
1273 For more detailed explanation of the available commands and output
1274 formats, see your own local documentation of F<gprof>.
1275
1276 =head2 GCC gcov Profiling
1277
1278 I<basic block profiling> is officially available in gcc 3.0 and later.
1279 You can build a profiled version of F<perl> by compiling using gcc with
1280 the flags C<-fprofile-arcs -ftest-coverage>.  Either edit F<config.sh>
1281 or re-run F<Configure>.
1282
1283 quick hint:
1284
1285     $ sh Configure -des -Dusedevel -Doptimize='-g' \
1286         -Accflags='-fprofile-arcs -ftest-coverage' \
1287         -Aldflags='-fprofile-arcs -ftest-coverage' \
1288         -Alddlflags='-fprofile-arcs -ftest-coverage -shared' \
1289         && make perl
1290     $ rm -f regexec.c.gcov regexec.gcda
1291     $ ./perl ...
1292     $ gcov regexec.c
1293     $ less regexec.c.gcov
1294
1295 (you probably need to add C<-shared> to the <-Alddlflags> line until RT
1296 #118199 is resolved)
1297
1298 Running the profiled version of Perl will cause profile output to be
1299 generated.  For each source file an accompanying F<.gcda> file will be
1300 created.
1301
1302 To display the results you use the I<gcov> utility (which should be
1303 installed if you have gcc 3.0 or newer installed).  F<gcov> is run on
1304 source code files, like this
1305
1306     gcov sv.c
1307
1308 which will cause F<sv.c.gcov> to be created.  The F<.gcov> files contain
1309 the source code annotated with relative frequencies of execution
1310 indicated by "#" markers.  If you want to generate F<.gcov> files for
1311 all profiled object files, you can run something like this:
1312
1313     for file in `find . -name \*.gcno`
1314     do sh -c "cd `dirname $file` && gcov `basename $file .gcno`"
1315     done
1316
1317 Useful options of F<gcov> include C<-b> which will summarise the basic
1318 block, branch, and function call coverage, and C<-c> which instead of
1319 relative frequencies will use the actual counts.  For more information
1320 on the use of F<gcov> and basic block profiling with gcc, see the
1321 latest GNU CC manual.  As of gcc 4.8, this is at
1322 L<http://gcc.gnu.org/onlinedocs/gcc/Gcov-Intro.html#Gcov-Intro>
1323
1324 =head1 MISCELLANEOUS TRICKS
1325
1326 =head2 PERL_DESTRUCT_LEVEL
1327
1328 If you want to run any of the tests yourself manually using e.g.
1329 valgrind, please note that by default perl B<does not> explicitly
1330 cleanup all the memory it has allocated (such as global memory arenas)
1331 but instead lets the exit() of the whole program "take care" of such
1332 allocations, also known as "global destruction of objects".
1333
1334 There is a way to tell perl to do complete cleanup: set the environment
1335 variable PERL_DESTRUCT_LEVEL to a non-zero value.  The t/TEST wrapper
1336 does set this to 2, and this is what you need to do too, if you don't
1337 want to see the "global leaks": For example, for running under valgrind
1338
1339         env PERL_DESTRUCT_LEVEL=2 valgrind ./perl -Ilib t/foo/bar.t
1340
1341 (Note: the mod_perl apache module uses also this environment variable
1342 for its own purposes and extended its semantics.  Refer to the mod_perl
1343 documentation for more information.  Also, spawned threads do the
1344 equivalent of setting this variable to the value 1.)
1345
1346 If, at the end of a run you get the message I<N scalars leaked>, you
1347 can recompile with C<-DDEBUG_LEAKING_SCALARS>, which will cause the
1348 addresses of all those leaked SVs to be dumped along with details as to
1349 where each SV was originally allocated.  This information is also
1350 displayed by Devel::Peek.  Note that the extra details recorded with
1351 each SV increases memory usage, so it shouldn't be used in production
1352 environments.  It also converts C<new_SV()> from a macro into a real
1353 function, so you can use your favourite debugger to discover where
1354 those pesky SVs were allocated.
1355
1356 If you see that you're leaking memory at runtime, but neither valgrind
1357 nor C<-DDEBUG_LEAKING_SCALARS> will find anything, you're probably
1358 leaking SVs that are still reachable and will be properly cleaned up
1359 during destruction of the interpreter.  In such cases, using the C<-Dm>
1360 switch can point you to the source of the leak.  If the executable was
1361 built with C<-DDEBUG_LEAKING_SCALARS>, C<-Dm> will output SV
1362 allocations in addition to memory allocations.  Each SV allocation has a
1363 distinct serial number that will be written on creation and destruction
1364 of the SV.  So if you're executing the leaking code in a loop, you need
1365 to look for SVs that are created, but never destroyed between each
1366 cycle.  If such an SV is found, set a conditional breakpoint within
1367 C<new_SV()> and make it break only when C<PL_sv_serial> is equal to the
1368 serial number of the leaking SV.  Then you will catch the interpreter in
1369 exactly the state where the leaking SV is allocated, which is
1370 sufficient in many cases to find the source of the leak.
1371
1372 As C<-Dm> is using the PerlIO layer for output, it will by itself
1373 allocate quite a bunch of SVs, which are hidden to avoid recursion.  You
1374 can bypass the PerlIO layer if you use the SV logging provided by
1375 C<-DPERL_MEM_LOG> instead.
1376
1377 =head2 PERL_MEM_LOG
1378
1379 If compiled with C<-DPERL_MEM_LOG>, both memory and SV allocations go
1380 through logging functions, which is handy for breakpoint setting.
1381
1382 Unless C<-DPERL_MEM_LOG_NOIMPL> is also compiled, the logging functions
1383 read $ENV{PERL_MEM_LOG} to determine whether to log the event, and if
1384 so how:
1385
1386     $ENV{PERL_MEM_LOG} =~ /m/           Log all memory ops
1387     $ENV{PERL_MEM_LOG} =~ /s/           Log all SV ops
1388     $ENV{PERL_MEM_LOG} =~ /t/           include timestamp in Log
1389     $ENV{PERL_MEM_LOG} =~ /^(\d+)/      write to FD given (default is 2)
1390
1391 Memory logging is somewhat similar to C<-Dm> but is independent of
1392 C<-DDEBUGGING>, and at a higher level; all uses of Newx(), Renew(), and
1393 Safefree() are logged with the caller's source code file and line
1394 number (and C function name, if supported by the C compiler).  In
1395 contrast, C<-Dm> is directly at the point of C<malloc()>.  SV logging is
1396 similar.
1397
1398 Since the logging doesn't use PerlIO, all SV allocations are logged and
1399 no extra SV allocations are introduced by enabling the logging.  If
1400 compiled with C<-DDEBUG_LEAKING_SCALARS>, the serial number for each SV
1401 allocation is also logged.
1402
1403 =head2 DDD over gdb
1404
1405 Those debugging perl with the DDD frontend over gdb may find the
1406 following useful:
1407
1408 You can extend the data conversion shortcuts menu, so for example you
1409 can display an SV's IV value with one click, without doing any typing.
1410 To do that simply edit ~/.ddd/init file and add after:
1411
1412   ! Display shortcuts.
1413   Ddd*gdbDisplayShortcuts: \
1414   /t ()   // Convert to Bin\n\
1415   /d ()   // Convert to Dec\n\
1416   /x ()   // Convert to Hex\n\
1417   /o ()   // Convert to Oct(\n\
1418
1419 the following two lines:
1420
1421   ((XPV*) (())->sv_any )->xpv_pv  // 2pvx\n\
1422   ((XPVIV*) (())->sv_any )->xiv_iv // 2ivx
1423
1424 so now you can do ivx and pvx lookups or you can plug there the sv_peek
1425 "conversion":
1426
1427   Perl_sv_peek(my_perl, (SV*)()) // sv_peek
1428
1429 (The my_perl is for threaded builds.)  Just remember that every line,
1430 but the last one, should end with \n\
1431
1432 Alternatively edit the init file interactively via: 3rd mouse button ->
1433 New Display -> Edit Menu
1434
1435 Note: you can define up to 20 conversion shortcuts in the gdb section.
1436
1437 =head2 C backtrace
1438
1439 On some platforms Perl supports retrieving the C level backtrace
1440 (similar to what symbolic debuggers like gdb do).
1441
1442 The backtrace returns the stack trace of the C call frames,
1443 with the symbol names (function names), the object names (like "perl"),
1444 and if it can, also the source code locations (file:line).
1445
1446 The supported platforms are Linux, and OS X (some *BSD might
1447 work at least partly, but they have not yet been tested).
1448
1449 This feature hasn't been tested with multiple threads, but it will
1450 only show the backtrace of the thread doing the backtracing.
1451
1452 The feature needs to be enabled with C<Configure -Dusecbacktrace>.
1453
1454 The C<-Dusecbacktrace> also enables keeping the debug information when
1455 compiling/linking (often: C<-g>).  Many compilers/linkers do support
1456 having both optimization and keeping the debug information.  The debug
1457 information is needed for the symbol names and the source locations.
1458
1459 Static functions might not be visible for the backtrace.
1460
1461 Source code locations, even if available, can often be missing or
1462 misleading if the compiler has e.g. inlined code.  Optimizer can
1463 make matching the source code and the object code quite challenging.
1464
1465 =over 4
1466
1467 =item Linux
1468
1469 You B<must> have the BFD (-lbfd) library installed, otherwise C<perl> will
1470 fail to link.  The BFD is usually distributed as part of the GNU binutils.
1471
1472 Summary: C<Configure ... -Dusecbacktrace>
1473 and you need C<-lbfd>.
1474
1475 =item OS X
1476
1477 The source code locations are supported B<only> if you have
1478 the Developer Tools installed.  (BFD is B<not> needed.)
1479
1480 Summary: C<Configure ... -Dusecbacktrace>
1481 and installing the Developer Tools would be good.
1482
1483 =back
1484
1485 Optionally, for trying out the feature, you may want to enable
1486 automatic dumping of the backtrace just before a warning or croak (die)
1487 message is emitted, by adding C<-Accflags=-DUSE_C_BACKTRACE_ON_ERROR>
1488 for Configure.
1489
1490 Unless the above additional feature is enabled, nothing about the
1491 backtrace functionality is visible, except for the Perl/XS level.
1492
1493 Furthermore, even if you have enabled this feature to be compiled,
1494 you need to enable it in runtime with an environment variable:
1495 C<PERL_C_BACKTRACE_ON_ERROR=10>.  It must be an integer higher
1496 than zero, telling the desired frame count.
1497
1498 Retrieving the backtrace from Perl level (using for example an XS
1499 extension) would be much less exciting than one would hope: normally
1500 you would see C<runops>, C<entersub>, and not much else.  This API is
1501 intended to be called B<from within> the Perl implementation, not from
1502 Perl level execution.
1503
1504 The C API for the backtrace is as follows:
1505
1506 =over 4
1507
1508 =item get_c_backtrace
1509
1510 =item free_c_backtrace
1511
1512 =item get_c_backtrace_dump
1513
1514 =item dump_c_backtrace
1515
1516 =back
1517
1518 =head2 Poison
1519
1520 If you see in a debugger a memory area mysteriously full of 0xABABABAB
1521 or 0xEFEFEFEF, you may be seeing the effect of the Poison() macros, see
1522 L<perlclib>.
1523
1524 =head2 Read-only optrees
1525
1526 Under ithreads the optree is read only.  If you want to enforce this, to
1527 check for write accesses from buggy code, compile with
1528 C<-Accflags=-DPERL_DEBUG_READONLY_OPS>
1529 to enable code that allocates op memory
1530 via C<mmap>, and sets it read-only when it is attached to a subroutine.
1531 Any write access to an op results in a C<SIGBUS> and abort.
1532
1533 This code is intended for development only, and may not be portable
1534 even to all Unix variants.  Also, it is an 80% solution, in that it
1535 isn't able to make all ops read only.  Specifically it does not apply to
1536 op slabs belonging to C<BEGIN> blocks.
1537
1538 However, as an 80% solution it is still effective, as it has caught
1539 bugs in the past.
1540
1541 =head2 When is a bool not a bool?
1542
1543 On pre-C99 compilers, C<bool> is defined as equivalent to C<char>.
1544 Consequently assignment of any larger type to a C<bool> is unsafe and may
1545 be truncated.  The C<cBOOL> macro exists to cast it correctly.
1546
1547 On those platforms and compilers where C<bool> really is a boolean (C++,
1548 C99), it is easy to forget the cast.  You can force C<bool> to be a C<char>
1549 by compiling with C<-Accflags=-DPERL_BOOL_AS_CHAR>.  You may also wish to
1550 run C<Configure> with something like
1551
1552     -Accflags='-Wconversion -Wno-sign-conversion -Wno-shorten-64-to-32'
1553
1554 or your compiler's equivalent to make it easier to spot any unsafe truncations
1555 that show up.
1556
1557 =head2 The .i Targets
1558
1559 You can expand the macros in a F<foo.c> file by saying
1560
1561     make foo.i
1562
1563 which will expand the macros using cpp.  Don't be scared by the
1564 results.
1565
1566 =head1 AUTHOR
1567
1568 This document was originally written by Nathan Torkington, and is
1569 maintained by the perl5-porters mailing list.