Avoid using the warnings pragma in proto.t - use may not work yet.
[perl.git] / pod / perlhack.pod
1 =head1 NAME
2
3 perlhack - How to hack at the Perl internals
4
5 =head1 DESCRIPTION
6
7 This document attempts to explain how Perl development takes place,
8 and ends with some suggestions for people wanting to become bona fide
9 porters.
10
11 The perl5-porters mailing list is where the Perl standard distribution
12 is maintained and developed.  The list can get anywhere from 10 to 150
13 messages a day, depending on the heatedness of the debate.  Most days
14 there are two or three patches, extensions, features, or bugs being
15 discussed at a time.
16
17 A searchable archive of the list is at either:
18
19     http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/
20
21 or
22
23     http://archive.develooper.com/perl5-porters@perl.org/
24
25 List subscribers (the porters themselves) come in several flavours.
26 Some are quiet curious lurkers, who rarely pitch in and instead watch
27 the ongoing development to ensure they're forewarned of new changes or
28 features in Perl.  Some are representatives of vendors, who are there
29 to make sure that Perl continues to compile and work on their
30 platforms.  Some patch any reported bug that they know how to fix,
31 some are actively patching their pet area (threads, Win32, the regexp
32 engine), while others seem to do nothing but complain.  In other
33 words, it's your usual mix of technical people.
34
35 Over this group of porters presides Larry Wall.  He has the final word
36 in what does and does not change in the Perl language.  Various
37 releases of Perl are shepherded by a "pumpking", a porter
38 responsible for gathering patches, deciding on a patch-by-patch,
39 feature-by-feature basis what will and will not go into the release.
40 For instance, Gurusamy Sarathy was the pumpking for the 5.6 release of
41 Perl, and Jarkko Hietaniemi was the pumpking for the 5.8 release, and
42 Rafael Garcia-Suarez holds the pumpking crown for the 5.10 release.
43
44 In addition, various people are pumpkings for different things.  For
45 instance, Andy Dougherty and Jarkko Hietaniemi did a grand job as the
46 I<Configure> pumpkin up till the 5.8 release. For the 5.10 release
47 H.Merijn Brand took over.
48
49 Larry sees Perl development along the lines of the US government:
50 there's the Legislature (the porters), the Executive branch (the
51 pumpkings), and the Supreme Court (Larry).  The legislature can
52 discuss and submit patches to the executive branch all they like, but
53 the executive branch is free to veto them.  Rarely, the Supreme Court
54 will side with the executive branch over the legislature, or the
55 legislature over the executive branch.  Mostly, however, the
56 legislature and the executive branch are supposed to get along and
57 work out their differences without impeachment or court cases.
58
59 You might sometimes see reference to Rule 1 and Rule 2.  Larry's power
60 as Supreme Court is expressed in The Rules:
61
62 =over 4
63
64 =item 1
65
66 Larry is always by definition right about how Perl should behave.
67 This means he has final veto power on the core functionality.
68
69 =item 2
70
71 Larry is allowed to change his mind about any matter at a later date,
72 regardless of whether he previously invoked Rule 1.
73
74 =back
75
76 Got that?  Larry is always right, even when he was wrong.  It's rare
77 to see either Rule exercised, but they are often alluded to.
78
79 New features and extensions to the language are contentious, because
80 the criteria used by the pumpkings, Larry, and other porters to decide
81 which features should be implemented and incorporated are not codified
82 in a few small design goals as with some other languages.  Instead,
83 the heuristics are flexible and often difficult to fathom.  Here is
84 one person's list, roughly in decreasing order of importance, of
85 heuristics that new features have to be weighed against:
86
87 =over 4
88
89 =item Does concept match the general goals of Perl?
90
91 These haven't been written anywhere in stone, but one approximation
92 is:
93
94  1. Keep it fast, simple, and useful.
95  2. Keep features/concepts as orthogonal as possible.
96  3. No arbitrary limits (platforms, data sizes, cultures).
97  4. Keep it open and exciting to use/patch/advocate Perl everywhere.
98  5. Either assimilate new technologies, or build bridges to them.
99
100 =item Where is the implementation?
101
102 All the talk in the world is useless without an implementation.  In
103 almost every case, the person or people who argue for a new feature
104 will be expected to be the ones who implement it.  Porters capable
105 of coding new features have their own agendas, and are not available
106 to implement your (possibly good) idea.
107
108 =item Backwards compatibility
109
110 It's a cardinal sin to break existing Perl programs.  New warnings are
111 contentious--some say that a program that emits warnings is not
112 broken, while others say it is.  Adding keywords has the potential to
113 break programs, changing the meaning of existing token sequences or
114 functions might break programs.
115
116 =item Could it be a module instead?
117
118 Perl 5 has extension mechanisms, modules and XS, specifically to avoid
119 the need to keep changing the Perl interpreter.  You can write modules
120 that export functions, you can give those functions prototypes so they
121 can be called like built-in functions, you can even write XS code to
122 mess with the runtime data structures of the Perl interpreter if you
123 want to implement really complicated things.  If it can be done in a
124 module instead of in the core, it's highly unlikely to be added.
125
126 =item Is the feature generic enough?
127
128 Is this something that only the submitter wants added to the language,
129 or would it be broadly useful?  Sometimes, instead of adding a feature
130 with a tight focus, the porters might decide to wait until someone
131 implements the more generalized feature.  For instance, instead of
132 implementing a "delayed evaluation" feature, the porters are waiting
133 for a macro system that would permit delayed evaluation and much more.
134
135 =item Does it potentially introduce new bugs?
136
137 Radical rewrites of large chunks of the Perl interpreter have the
138 potential to introduce new bugs.  The smaller and more localized the
139 change, the better.
140
141 =item Does it preclude other desirable features?
142
143 A patch is likely to be rejected if it closes off future avenues of
144 development.  For instance, a patch that placed a true and final
145 interpretation on prototypes is likely to be rejected because there
146 are still options for the future of prototypes that haven't been
147 addressed.
148
149 =item Is the implementation robust?
150
151 Good patches (tight code, complete, correct) stand more chance of
152 going in.  Sloppy or incorrect patches might be placed on the back
153 burner until the pumpking has time to fix, or might be discarded
154 altogether without further notice.
155
156 =item Is the implementation generic enough to be portable?
157
158 The worst patches make use of a system-specific features.  It's highly
159 unlikely that non-portable additions to the Perl language will be
160 accepted.
161
162 =item Is the implementation tested?
163
164 Patches which change behaviour (fixing bugs or introducing new features)
165 must include regression tests to verify that everything works as expected.
166 Without tests provided by the original author, how can anyone else changing
167 perl in the future be sure that they haven't unwittingly broken the behaviour
168 the patch implements? And without tests, how can the patch's author be
169 confident that his/her hard work put into the patch won't be accidentally
170 thrown away by someone in the future?
171
172 =item Is there enough documentation?
173
174 Patches without documentation are probably ill-thought out or
175 incomplete.  Nothing can be added without documentation, so submitting
176 a patch for the appropriate manpages as well as the source code is
177 always a good idea.
178
179 =item Is there another way to do it?
180
181 Larry said "Although the Perl Slogan is I<There's More Than One Way
182 to Do It>, I hesitate to make 10 ways to do something".  This is a
183 tricky heuristic to navigate, though--one man's essential addition is
184 another man's pointless cruft.
185
186 =item Does it create too much work?
187
188 Work for the pumpking, work for Perl programmers, work for module
189 authors, ...  Perl is supposed to be easy.
190
191 =item Patches speak louder than words
192
193 Working code is always preferred to pie-in-the-sky ideas.  A patch to
194 add a feature stands a much higher chance of making it to the language
195 than does a random feature request, no matter how fervently argued the
196 request might be.  This ties into "Will it be useful?", as the fact
197 that someone took the time to make the patch demonstrates a strong
198 desire for the feature.
199
200 =back
201
202 If you're on the list, you might hear the word "core" bandied
203 around.  It refers to the standard distribution.  "Hacking on the
204 core" means you're changing the C source code to the Perl
205 interpreter.  "A core module" is one that ships with Perl.
206
207 =head2 Keeping in sync
208
209 The source code to the Perl interpreter, in its different versions, is
210 kept in a repository managed by the git revision control system. The
211 pumpkings and a few others have write access to the repository to check in
212 changes.
213
214 How to clone and use the git perl repository is described in L<perlrepository>.
215
216 You can also choose to use rsync to get a copy of the current source tree
217 for the bleadperl branch and all maintenance branches :
218
219     $ rsync -avz rsync://perl5.git.perl.org/APC/perl-current .
220     $ rsync -avz rsync://perl5.git.perl.org/APC/perl-5.10.x .
221     $ rsync -avz rsync://perl5.git.perl.org/APC/perl-5.8.x .
222     $ rsync -avz rsync://perl5.git.perl.org/APC/perl-5.6.x .
223     $ rsync -avz rsync://perl5.git.perl.org/APC/perl-5.005xx .
224
225 (Add the C<--delete> option to remove leftover files)
226
227 You may also want to subscribe to the perl5-changes mailing list to
228 receive a copy of each patch that gets submitted to the maintenance
229 and development "branches" of the perl repository.  See
230 http://lists.perl.org/ for subscription information.
231
232 If you are a member of the perl5-porters mailing list, it is a good
233 thing to keep in touch with the most recent changes. If not only to
234 verify if what you would have posted as a bug report isn't already
235 solved in the most recent available perl development branch, also
236 known as perl-current, bleading edge perl, bleedperl or bleadperl.
237
238 Needless to say, the source code in perl-current is usually in a perpetual
239 state of evolution.  You should expect it to be very buggy.  Do B<not> use
240 it for any purpose other than testing and development.
241
242 =head2 Perlbug administration
243
244 There is a single remote administrative interface for modifying bug status,
245 category, open issues etc. using the B<RT> bugtracker system, maintained
246 by Robert Spier.  Become an administrator, and close any bugs you can get
247 your sticky mitts on:
248
249         http://bugs.perl.org/
250
251 To email the bug system administrators:
252
253         "perlbug-admin" <perlbug-admin@perl.org>
254
255 =head2 Submitting patches
256
257 Always submit patches to I<perl5-porters@perl.org>.  If you're
258 patching a core module and there's an author listed, send the author a
259 copy (see L<Patching a core module>).  This lets other porters review
260 your patch, which catches a surprising number of errors in patches.
261 Please patch against the latest B<development> version. (e.g., even if
262 you're fixing a bug in the 5.8 track, patch against the C<blead> branch in
263 the git repository.)
264
265 If changes are accepted, they are applied to the development branch. Then
266 the maintenance pumpking decides which of those patches is to be
267 backported to the maint branch.  Only patches that survive the heat of the
268 development branch get applied to maintenance versions.
269
270 Your patch should update the documentation and test suite.  See
271 L<Writing a test>.  If you have added or removed files in the distribution,
272 edit the MANIFEST file accordingly, sort the MANIFEST file using
273 C<make manisort>, and include those changes as part of your patch.
274
275 Patching documentation also follows the same order: if accepted, a patch
276 is first applied to B<development>, and if relevant then it's backported
277 to B<maintenance>. (With an exception for some patches that document
278 behaviour that only appears in the maintenance branch, but which has
279 changed in the development version.)
280
281 To report a bug in Perl, use the program I<perlbug> which comes with
282 Perl (if you can't get Perl to work, send mail to the address
283 I<perlbug@perl.org> or I<perlbug@perl.com>).  Reporting bugs through
284 I<perlbug> feeds into the automated bug-tracking system, access to
285 which is provided through the web at http://rt.perl.org/rt3/ .  It
286 often pays to check the archives of the perl5-porters mailing list to
287 see whether the bug you're reporting has been reported before, and if
288 so whether it was considered a bug.  See above for the location of
289 the searchable archives.
290
291 The CPAN testers ( http://testers.cpan.org/ ) are a group of
292 volunteers who test CPAN modules on a variety of platforms.  Perl
293 Smokers ( http://www.nntp.perl.org/group/perl.daily-build and
294 http://www.nntp.perl.org/group/perl.daily-build.reports/ )
295 automatically test Perl source releases on platforms with various
296 configurations.  Both efforts welcome volunteers. In order to get
297 involved in smoke testing of the perl itself visit
298 L<http://search.cpan.org/dist/Test-Smoke>. In order to start smoke
299 testing CPAN modules visit L<http://search.cpan.org/dist/CPANPLUS-YACSmoke/>
300 or L<http://search.cpan.org/dist/minismokebox/> or
301 L<http://search.cpan.org/dist/CPAN-Reporter/>.
302
303 It's a good idea to read and lurk for a while before chipping in.
304 That way you'll get to see the dynamic of the conversations, learn the
305 personalities of the players, and hopefully be better prepared to make
306 a useful contribution when do you speak up.
307
308 If after all this you still think you want to join the perl5-porters
309 mailing list, send mail to I<perl5-porters-subscribe@perl.org>.  To
310 unsubscribe, send mail to I<perl5-porters-unsubscribe@perl.org>.
311
312 To hack on the Perl guts, you'll need to read the following things:
313
314 =over 3
315
316 =item L<perlguts>
317
318 This is of paramount importance, since it's the documentation of what
319 goes where in the Perl source. Read it over a couple of times and it
320 might start to make sense - don't worry if it doesn't yet, because the
321 best way to study it is to read it in conjunction with poking at Perl
322 source, and we'll do that later on.
323
324 Gisle Aas's illustrated perlguts (also known as I<illguts>) is wonderful,
325 although a little out of date with regard to some size details; the
326 various SV structures have since been reworked for smaller memory footprint.
327 The fundamentals are right however, and the pictures are very helpful.
328
329 L<http://www.perl.org/tpc/1998/Perl_Language_and_Modules/Perl%20Illustrated/>
330
331 =item L<perlxstut> and L<perlxs>
332
333 A working knowledge of XSUB programming is incredibly useful for core
334 hacking; XSUBs use techniques drawn from the PP code, the portion of the
335 guts that actually executes a Perl program. It's a lot gentler to learn
336 those techniques from simple examples and explanation than from the core
337 itself.
338
339 =item L<perlapi>
340
341 The documentation for the Perl API explains what some of the internal
342 functions do, as well as the many macros used in the source.
343
344 =item F<Porting/pumpkin.pod>
345
346 This is a collection of words of wisdom for a Perl porter; some of it is
347 only useful to the pumpkin holder, but most of it applies to anyone
348 wanting to go about Perl development.
349
350 =item The perl5-porters FAQ
351
352 This should be available from http://dev.perl.org/perl5/docs/p5p-faq.html .
353 It contains hints on reading perl5-porters, information on how
354 perl5-porters works and how Perl development in general works.
355
356 =back
357
358 =head2 Finding Your Way Around
359
360 Perl maintenance can be split into a number of areas, and certain people
361 (pumpkins) will have responsibility for each area. These areas sometimes
362 correspond to files or directories in the source kit. Among the areas are:
363
364 =over 3
365
366 =item Core modules
367
368 Modules shipped as part of the Perl core live in various subdirectories, where
369 two are dedicated to core-only modules, and two are for the dual-life modules
370 which live on CPAN and may be maintained separately with respect to the Perl
371 core: 
372
373     lib/  is for pure-Perl modules, which exist in the core only.
374
375     ext/  is for XS extensions, and modules with special Makefile.PL requirements, which exist in the core only.
376
377     cpan/ is for dual-life modules, where the CPAN module is canonical (should be patched first).
378
379     dist/ is for dual-life modules, where the blead source is canonical.
380
381 =item Tests
382
383 There are tests for nearly all the modules, built-ins and major bits
384 of functionality.  Test files all have a .t suffix.  Module tests live
385 in the F<lib/> and F<ext/> directories next to the module being
386 tested.  Others live in F<t/>.  See L<Writing a test>
387
388 =item Documentation
389
390 Documentation maintenance includes looking after everything in the
391 F<pod/> directory, (as well as contributing new documentation) and
392 the documentation to the modules in core.
393
394 =item Configure
395
396 The configure process is the way we make Perl portable across the
397 myriad of operating systems it supports. Responsibility for the
398 configure, build and installation process, as well as the overall
399 portability of the core code rests with the configure pumpkin - others
400 help out with individual operating systems.
401
402 The files involved are the operating system directories, (F<win32/>,
403 F<os2/>, F<vms/> and so on) the shell scripts which generate F<config.h>
404 and F<Makefile>, as well as the metaconfig files which generate
405 F<Configure>. (metaconfig isn't included in the core distribution.)
406
407 =item Interpreter
408
409 And of course, there's the core of the Perl interpreter itself. Let's
410 have a look at that in a little more detail.
411
412 =back
413
414 Before we leave looking at the layout, though, don't forget that
415 F<MANIFEST> contains not only the file names in the Perl distribution,
416 but short descriptions of what's in them, too. For an overview of the
417 important files, try this:
418
419     perl -lne 'print if /^[^\/]+\.[ch]\s+/' MANIFEST
420
421 =head2 Elements of the interpreter
422
423 The work of the interpreter has two main stages: compiling the code
424 into the internal representation, or bytecode, and then executing it.
425 L<perlguts/Compiled code> explains exactly how the compilation stage
426 happens.
427
428 Here is a short breakdown of perl's operation:
429
430 =over 3
431
432 =item Startup
433
434 The action begins in F<perlmain.c>. (or F<miniperlmain.c> for miniperl)
435 This is very high-level code, enough to fit on a single screen, and it
436 resembles the code found in L<perlembed>; most of the real action takes
437 place in F<perl.c>
438
439 F<perlmain.c> is generated by L<writemain> from F<miniperlmain.c> at
440 make time, so you should make perl to follow this along.
441
442 First, F<perlmain.c> allocates some memory and constructs a Perl
443 interpreter, along these lines:
444
445     1 PERL_SYS_INIT3(&argc,&argv,&env);
446     2
447     3 if (!PL_do_undump) {
448     4     my_perl = perl_alloc();
449     5     if (!my_perl)
450     6         exit(1);
451     7     perl_construct(my_perl);
452     8     PL_perl_destruct_level = 0;
453     9 }
454
455 Line 1 is a macro, and its definition is dependent on your operating
456 system. Line 3 references C<PL_do_undump>, a global variable - all
457 global variables in Perl start with C<PL_>. This tells you whether the
458 current running program was created with the C<-u> flag to perl and then
459 F<undump>, which means it's going to be false in any sane context.
460
461 Line 4 calls a function in F<perl.c> to allocate memory for a Perl
462 interpreter. It's quite a simple function, and the guts of it looks like
463 this:
464
465     my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
466
467 Here you see an example of Perl's system abstraction, which we'll see
468 later: C<PerlMem_malloc> is either your system's C<malloc>, or Perl's
469 own C<malloc> as defined in F<malloc.c> if you selected that option at
470 configure time.
471
472 Next, in line 7, we construct the interpreter using perl_construct, 
473 also in F<perl.c>; this sets up all the special variables that Perl 
474 needs, the stacks, and so on.
475
476 Now we pass Perl the command line options, and tell it to go:
477
478     exitstatus = perl_parse(my_perl, xs_init, argc, argv, (char **)NULL);
479     if (!exitstatus)
480         perl_run(my_perl);
481
482     exitstatus = perl_destruct(my_perl);
483
484     perl_free(my_perl);
485
486 C<perl_parse> is actually a wrapper around C<S_parse_body>, as defined
487 in F<perl.c>, which processes the command line options, sets up any
488 statically linked XS modules, opens the program and calls C<yyparse> to
489 parse it.
490
491 =item Parsing
492
493 The aim of this stage is to take the Perl source, and turn it into an op
494 tree. We'll see what one of those looks like later. Strictly speaking,
495 there's three things going on here.
496
497 C<yyparse>, the parser, lives in F<perly.c>, although you're better off
498 reading the original YACC input in F<perly.y>. (Yes, Virginia, there
499 B<is> a YACC grammar for Perl!) The job of the parser is to take your
500 code and "understand" it, splitting it into sentences, deciding which
501 operands go with which operators and so on.
502
503 The parser is nobly assisted by the lexer, which chunks up your input
504 into tokens, and decides what type of thing each token is: a variable
505 name, an operator, a bareword, a subroutine, a core function, and so on.
506 The main point of entry to the lexer is C<yylex>, and that and its
507 associated routines can be found in F<toke.c>. Perl isn't much like
508 other computer languages; it's highly context sensitive at times, it can
509 be tricky to work out what sort of token something is, or where a token
510 ends. As such, there's a lot of interplay between the tokeniser and the
511 parser, which can get pretty frightening if you're not used to it.
512
513 As the parser understands a Perl program, it builds up a tree of
514 operations for the interpreter to perform during execution. The routines
515 which construct and link together the various operations are to be found
516 in F<op.c>, and will be examined later.
517
518 =item Optimization
519
520 Now the parsing stage is complete, and the finished tree represents
521 the operations that the Perl interpreter needs to perform to execute our
522 program. Next, Perl does a dry run over the tree looking for
523 optimisations: constant expressions such as C<3 + 4> will be computed
524 now, and the optimizer will also see if any multiple operations can be
525 replaced with a single one. For instance, to fetch the variable C<$foo>,
526 instead of grabbing the glob C<*foo> and looking at the scalar
527 component, the optimizer fiddles the op tree to use a function which
528 directly looks up the scalar in question. The main optimizer is C<peep>
529 in F<op.c>, and many ops have their own optimizing functions.
530
531 =item Running
532
533 Now we're finally ready to go: we have compiled Perl byte code, and all
534 that's left to do is run it. The actual execution is done by the
535 C<runops_standard> function in F<run.c>; more specifically, it's done by
536 these three innocent looking lines:
537
538     while ((PL_op = CALL_FPTR(PL_op->op_ppaddr)(aTHX))) {
539         PERL_ASYNC_CHECK();
540     }
541
542 You may be more comfortable with the Perl version of that:
543
544     PERL_ASYNC_CHECK() while $Perl::op = &{$Perl::op->{function}};
545
546 Well, maybe not. Anyway, each op contains a function pointer, which
547 stipulates the function which will actually carry out the operation.
548 This function will return the next op in the sequence - this allows for
549 things like C<if> which choose the next op dynamically at run time.
550 The C<PERL_ASYNC_CHECK> makes sure that things like signals interrupt
551 execution if required.
552
553 The actual functions called are known as PP code, and they're spread
554 between four files: F<pp_hot.c> contains the "hot" code, which is most
555 often used and highly optimized, F<pp_sys.c> contains all the
556 system-specific functions, F<pp_ctl.c> contains the functions which
557 implement control structures (C<if>, C<while> and the like) and F<pp.c>
558 contains everything else. These are, if you like, the C code for Perl's
559 built-in functions and operators.
560
561 Note that each C<pp_> function is expected to return a pointer to the next
562 op. Calls to perl subs (and eval blocks) are handled within the same
563 runops loop, and do not consume extra space on the C stack. For example,
564 C<pp_entersub> and C<pp_entertry> just push a C<CxSUB> or C<CxEVAL> block
565 struct onto the context stack which contain the address of the op
566 following the sub call or eval. They then return the first op of that sub
567 or eval block, and so execution continues of that sub or block.  Later, a
568 C<pp_leavesub> or C<pp_leavetry> op pops the C<CxSUB> or C<CxEVAL>,
569 retrieves the return op from it, and returns it.
570
571 =item Exception handing
572
573 Perl's exception handing (i.e. C<die> etc.) is built on top of the low-level
574 C<setjmp()>/C<longjmp()> C-library functions. These basically provide a
575 way to capture the current PC and SP registers and later restore them; i.e.
576 a C<longjmp()> continues at the point in code where a previous C<setjmp()>
577 was done, with anything further up on the C stack being lost. This is why
578 code should always save values using C<SAVE_FOO> rather than in auto
579 variables.
580
581 The perl core wraps C<setjmp()> etc in the macros C<JMPENV_PUSH> and
582 C<JMPENV_JUMP>. The basic rule of perl exceptions is that C<exit>, and
583 C<die> (in the absence of C<eval>) perform a C<JMPENV_JUMP(2)>, while
584 C<die> within C<eval> does a C<JMPENV_JUMP(3)>.
585
586 At entry points to perl, such as C<perl_parse()>, C<perl_run()> and
587 C<call_sv(cv, G_EVAL)> each does a C<JMPENV_PUSH>, then enter a runops
588 loop or whatever, and handle possible exception returns. For a 2 return,
589 final cleanup is performed, such as popping stacks and calling C<CHECK> or
590 C<END> blocks. Amongst other things, this is how scope cleanup still
591 occurs during an C<exit>.
592
593 If a C<die> can find a C<CxEVAL> block on the context stack, then the
594 stack is popped to that level and the return op in that block is assigned
595 to C<PL_restartop>; then a C<JMPENV_JUMP(3)> is performed.  This normally
596 passes control back to the guard. In the case of C<perl_run> and
597 C<call_sv>, a non-null C<PL_restartop> triggers re-entry to the runops
598 loop. The is the normal way that C<die> or C<croak> is handled within an
599 C<eval>.
600
601 Sometimes ops are executed within an inner runops loop, such as tie, sort
602 or overload code. In this case, something like
603
604     sub FETCH { eval { die } }
605
606 would cause a longjmp right back to the guard in C<perl_run>, popping both
607 runops loops, which is clearly incorrect. One way to avoid this is for the
608 tie code to do a C<JMPENV_PUSH> before executing C<FETCH> in the inner
609 runops loop, but for efficiency reasons, perl in fact just sets a flag,
610 using C<CATCH_SET(TRUE)>. The C<pp_require>, C<pp_entereval> and
611 C<pp_entertry> ops check this flag, and if true, they call C<docatch>,
612 which does a C<JMPENV_PUSH> and starts a new runops level to execute the
613 code, rather than doing it on the current loop.
614
615 As a further optimisation, on exit from the eval block in the C<FETCH>,
616 execution of the code following the block is still carried on in the inner
617 loop.  When an exception is raised, C<docatch> compares the C<JMPENV>
618 level of the C<CxEVAL> with C<PL_top_env> and if they differ, just
619 re-throws the exception. In this way any inner loops get popped.
620
621 Here's an example.
622
623     1: eval { tie @a, 'A' };
624     2: sub A::TIEARRAY {
625     3:     eval { die };
626     4:     die;
627     5: }
628
629 To run this code, C<perl_run> is called, which does a C<JMPENV_PUSH> then
630 enters a runops loop. This loop executes the eval and tie ops on line 1,
631 with the eval pushing a C<CxEVAL> onto the context stack.
632
633 The C<pp_tie> does a C<CATCH_SET(TRUE)>, then starts a second runops loop
634 to execute the body of C<TIEARRAY>. When it executes the entertry op on
635 line 3, C<CATCH_GET> is true, so C<pp_entertry> calls C<docatch> which
636 does a C<JMPENV_PUSH> and starts a third runops loop, which then executes
637 the die op. At this point the C call stack looks like this:
638
639     Perl_pp_die
640     Perl_runops      # third loop
641     S_docatch_body
642     S_docatch
643     Perl_pp_entertry
644     Perl_runops      # second loop
645     S_call_body
646     Perl_call_sv
647     Perl_pp_tie
648     Perl_runops      # first loop
649     S_run_body
650     perl_run
651     main
652
653 and the context and data stacks, as shown by C<-Dstv>, look like:
654
655     STACK 0: MAIN
656       CX 0: BLOCK  =>
657       CX 1: EVAL   => AV()  PV("A"\0)
658       retop=leave
659     STACK 1: MAGIC
660       CX 0: SUB    =>
661       retop=(null)
662       CX 1: EVAL   => *
663     retop=nextstate
664
665 The die pops the first C<CxEVAL> off the context stack, sets
666 C<PL_restartop> from it, does a C<JMPENV_JUMP(3)>, and control returns to
667 the top C<docatch>. This then starts another third-level runops level,
668 which executes the nextstate, pushmark and die ops on line 4. At the point
669 that the second C<pp_die> is called, the C call stack looks exactly like
670 that above, even though we are no longer within an inner eval; this is
671 because of the optimization mentioned earlier. However, the context stack
672 now looks like this, ie with the top CxEVAL popped:
673
674     STACK 0: MAIN
675       CX 0: BLOCK  =>
676       CX 1: EVAL   => AV()  PV("A"\0)
677       retop=leave
678     STACK 1: MAGIC
679       CX 0: SUB    =>
680       retop=(null)
681
682 The die on line 4 pops the context stack back down to the CxEVAL, leaving
683 it as:
684
685     STACK 0: MAIN
686       CX 0: BLOCK  =>
687
688 As usual, C<PL_restartop> is extracted from the C<CxEVAL>, and a
689 C<JMPENV_JUMP(3)> done, which pops the C stack back to the docatch:
690
691     S_docatch
692     Perl_pp_entertry
693     Perl_runops      # second loop
694     S_call_body
695     Perl_call_sv
696     Perl_pp_tie
697     Perl_runops      # first loop
698     S_run_body
699     perl_run
700     main
701
702 In  this case, because the C<JMPENV> level recorded in the C<CxEVAL>
703 differs from the current one, C<docatch> just does a C<JMPENV_JUMP(3)>
704 and the C stack unwinds to:
705
706     perl_run
707     main
708
709 Because C<PL_restartop> is non-null, C<run_body> starts a new runops loop
710 and execution continues.
711
712 =back
713
714 =head2 Internal Variable Types
715
716 You should by now have had a look at L<perlguts>, which tells you about
717 Perl's internal variable types: SVs, HVs, AVs and the rest. If not, do
718 that now.
719
720 These variables are used not only to represent Perl-space variables, but
721 also any constants in the code, as well as some structures completely
722 internal to Perl. The symbol table, for instance, is an ordinary Perl
723 hash. Your code is represented by an SV as it's read into the parser;
724 any program files you call are opened via ordinary Perl filehandles, and
725 so on.
726
727 The core L<Devel::Peek|Devel::Peek> module lets us examine SVs from a
728 Perl program. Let's see, for instance, how Perl treats the constant
729 C<"hello">.
730
731       % perl -MDevel::Peek -e 'Dump("hello")'
732     1 SV = PV(0xa041450) at 0xa04ecbc
733     2   REFCNT = 1
734     3   FLAGS = (POK,READONLY,pPOK)
735     4   PV = 0xa0484e0 "hello"\0
736     5   CUR = 5
737     6   LEN = 6
738
739 Reading C<Devel::Peek> output takes a bit of practise, so let's go
740 through it line by line.
741
742 Line 1 tells us we're looking at an SV which lives at C<0xa04ecbc> in
743 memory. SVs themselves are very simple structures, but they contain a
744 pointer to a more complex structure. In this case, it's a PV, a
745 structure which holds a string value, at location C<0xa041450>.  Line 2
746 is the reference count; there are no other references to this data, so
747 it's 1.
748
749 Line 3 are the flags for this SV - it's OK to use it as a PV, it's a
750 read-only SV (because it's a constant) and the data is a PV internally.
751 Next we've got the contents of the string, starting at location
752 C<0xa0484e0>.
753
754 Line 5 gives us the current length of the string - note that this does
755 B<not> include the null terminator. Line 6 is not the length of the
756 string, but the length of the currently allocated buffer; as the string
757 grows, Perl automatically extends the available storage via a routine
758 called C<SvGROW>.
759
760 You can get at any of these quantities from C very easily; just add
761 C<Sv> to the name of the field shown in the snippet, and you've got a
762 macro which will return the value: C<SvCUR(sv)> returns the current
763 length of the string, C<SvREFCOUNT(sv)> returns the reference count,
764 C<SvPV(sv, len)> returns the string itself with its length, and so on.
765 More macros to manipulate these properties can be found in L<perlguts>.
766
767 Let's take an example of manipulating a PV, from C<sv_catpvn>, in F<sv.c>
768
769      1  void
770      2  Perl_sv_catpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
771      3  {
772      4      STRLEN tlen;
773      5      char *junk;
774
775      6      junk = SvPV_force(sv, tlen);
776      7      SvGROW(sv, tlen + len + 1);
777      8      if (ptr == junk)
778      9          ptr = SvPVX(sv);
779     10      Move(ptr,SvPVX(sv)+tlen,len,char);
780     11      SvCUR(sv) += len;
781     12      *SvEND(sv) = '\0';
782     13      (void)SvPOK_only_UTF8(sv);          /* validate pointer */
783     14      SvTAINT(sv);
784     15  }
785
786 This is a function which adds a string, C<ptr>, of length C<len> onto
787 the end of the PV stored in C<sv>. The first thing we do in line 6 is
788 make sure that the SV B<has> a valid PV, by calling the C<SvPV_force>
789 macro to force a PV. As a side effect, C<tlen> gets set to the current
790 value of the PV, and the PV itself is returned to C<junk>.
791
792 In line 7, we make sure that the SV will have enough room to accommodate
793 the old string, the new string and the null terminator. If C<LEN> isn't
794 big enough, C<SvGROW> will reallocate space for us.
795
796 Now, if C<junk> is the same as the string we're trying to add, we can
797 grab the string directly from the SV; C<SvPVX> is the address of the PV
798 in the SV.
799
800 Line 10 does the actual catenation: the C<Move> macro moves a chunk of
801 memory around: we move the string C<ptr> to the end of the PV - that's
802 the start of the PV plus its current length. We're moving C<len> bytes
803 of type C<char>. After doing so, we need to tell Perl we've extended the
804 string, by altering C<CUR> to reflect the new length. C<SvEND> is a
805 macro which gives us the end of the string, so that needs to be a
806 C<"\0">.
807
808 Line 13 manipulates the flags; since we've changed the PV, any IV or NV
809 values will no longer be valid: if we have C<$a=10; $a.="6";> we don't
810 want to use the old IV of 10. C<SvPOK_only_utf8> is a special UTF-8-aware
811 version of C<SvPOK_only>, a macro which turns off the IOK and NOK flags
812 and turns on POK. The final C<SvTAINT> is a macro which launders tainted
813 data if taint mode is turned on.
814
815 AVs and HVs are more complicated, but SVs are by far the most common
816 variable type being thrown around. Having seen something of how we
817 manipulate these, let's go on and look at how the op tree is
818 constructed.
819
820 =head2 Op Trees
821
822 First, what is the op tree, anyway? The op tree is the parsed
823 representation of your program, as we saw in our section on parsing, and
824 it's the sequence of operations that Perl goes through to execute your
825 program, as we saw in L</Running>.
826
827 An op is a fundamental operation that Perl can perform: all the built-in
828 functions and operators are ops, and there are a series of ops which
829 deal with concepts the interpreter needs internally - entering and
830 leaving a block, ending a statement, fetching a variable, and so on.
831
832 The op tree is connected in two ways: you can imagine that there are two
833 "routes" through it, two orders in which you can traverse the tree.
834 First, parse order reflects how the parser understood the code, and
835 secondly, execution order tells perl what order to perform the
836 operations in.
837
838 The easiest way to examine the op tree is to stop Perl after it has
839 finished parsing, and get it to dump out the tree. This is exactly what
840 the compiler backends L<B::Terse|B::Terse>, L<B::Concise|B::Concise>
841 and L<B::Debug|B::Debug> do.
842
843 Let's have a look at how Perl sees C<$a = $b + $c>:
844
845      % perl -MO=Terse -e '$a=$b+$c'
846      1  LISTOP (0x8179888) leave
847      2      OP (0x81798b0) enter
848      3      COP (0x8179850) nextstate
849      4      BINOP (0x8179828) sassign
850      5          BINOP (0x8179800) add [1]
851      6              UNOP (0x81796e0) null [15]
852      7                  SVOP (0x80fafe0) gvsv  GV (0x80fa4cc) *b
853      8              UNOP (0x81797e0) null [15]
854      9                  SVOP (0x8179700) gvsv  GV (0x80efeb0) *c
855     10          UNOP (0x816b4f0) null [15]
856     11              SVOP (0x816dcf0) gvsv  GV (0x80fa460) *a
857
858 Let's start in the middle, at line 4. This is a BINOP, a binary
859 operator, which is at location C<0x8179828>. The specific operator in
860 question is C<sassign> - scalar assignment - and you can find the code
861 which implements it in the function C<pp_sassign> in F<pp_hot.c>. As a
862 binary operator, it has two children: the add operator, providing the
863 result of C<$b+$c>, is uppermost on line 5, and the left hand side is on
864 line 10.
865
866 Line 10 is the null op: this does exactly nothing. What is that doing
867 there? If you see the null op, it's a sign that something has been
868 optimized away after parsing. As we mentioned in L</Optimization>,
869 the optimization stage sometimes converts two operations into one, for
870 example when fetching a scalar variable. When this happens, instead of
871 rewriting the op tree and cleaning up the dangling pointers, it's easier
872 just to replace the redundant operation with the null op. Originally,
873 the tree would have looked like this:
874
875     10          SVOP (0x816b4f0) rv2sv [15]
876     11              SVOP (0x816dcf0) gv  GV (0x80fa460) *a
877
878 That is, fetch the C<a> entry from the main symbol table, and then look
879 at the scalar component of it: C<gvsv> (C<pp_gvsv> into F<pp_hot.c>)
880 happens to do both these things.
881
882 The right hand side, starting at line 5 is similar to what we've just
883 seen: we have the C<add> op (C<pp_add> also in F<pp_hot.c>) add together
884 two C<gvsv>s.
885
886 Now, what's this about?
887
888      1  LISTOP (0x8179888) leave
889      2      OP (0x81798b0) enter
890      3      COP (0x8179850) nextstate
891
892 C<enter> and C<leave> are scoping ops, and their job is to perform any
893 housekeeping every time you enter and leave a block: lexical variables
894 are tidied up, unreferenced variables are destroyed, and so on. Every
895 program will have those first three lines: C<leave> is a list, and its
896 children are all the statements in the block. Statements are delimited
897 by C<nextstate>, so a block is a collection of C<nextstate> ops, with
898 the ops to be performed for each statement being the children of
899 C<nextstate>. C<enter> is a single op which functions as a marker.
900
901 That's how Perl parsed the program, from top to bottom:
902
903                         Program
904                            |
905                        Statement
906                            |
907                            =
908                           / \
909                          /   \
910                         $a   +
911                             / \
912                           $b   $c
913
914 However, it's impossible to B<perform> the operations in this order:
915 you have to find the values of C<$b> and C<$c> before you add them
916 together, for instance. So, the other thread that runs through the op
917 tree is the execution order: each op has a field C<op_next> which points
918 to the next op to be run, so following these pointers tells us how perl
919 executes the code. We can traverse the tree in this order using
920 the C<exec> option to C<B::Terse>:
921
922      % perl -MO=Terse,exec -e '$a=$b+$c'
923      1  OP (0x8179928) enter
924      2  COP (0x81798c8) nextstate
925      3  SVOP (0x81796c8) gvsv  GV (0x80fa4d4) *b
926      4  SVOP (0x8179798) gvsv  GV (0x80efeb0) *c
927      5  BINOP (0x8179878) add [1]
928      6  SVOP (0x816dd38) gvsv  GV (0x80fa468) *a
929      7  BINOP (0x81798a0) sassign
930      8  LISTOP (0x8179900) leave
931
932 This probably makes more sense for a human: enter a block, start a
933 statement. Get the values of C<$b> and C<$c>, and add them together.
934 Find C<$a>, and assign one to the other. Then leave.
935
936 The way Perl builds up these op trees in the parsing process can be
937 unravelled by examining F<perly.y>, the YACC grammar. Let's take the
938 piece we need to construct the tree for C<$a = $b + $c>
939
940     1 term    :   term ASSIGNOP term
941     2                { $$ = newASSIGNOP(OPf_STACKED, $1, $2, $3); }
942     3         |   term ADDOP term
943     4                { $$ = newBINOP($2, 0, scalar($1), scalar($3)); }
944
945 If you're not used to reading BNF grammars, this is how it works: You're
946 fed certain things by the tokeniser, which generally end up in upper
947 case. Here, C<ADDOP>, is provided when the tokeniser sees C<+> in your
948 code. C<ASSIGNOP> is provided when C<=> is used for assigning. These are
949 "terminal symbols", because you can't get any simpler than them.
950
951 The grammar, lines one and three of the snippet above, tells you how to
952 build up more complex forms. These complex forms, "non-terminal symbols"
953 are generally placed in lower case. C<term> here is a non-terminal
954 symbol, representing a single expression.
955
956 The grammar gives you the following rule: you can make the thing on the
957 left of the colon if you see all the things on the right in sequence.
958 This is called a "reduction", and the aim of parsing is to completely
959 reduce the input. There are several different ways you can perform a
960 reduction, separated by vertical bars: so, C<term> followed by C<=>
961 followed by C<term> makes a C<term>, and C<term> followed by C<+>
962 followed by C<term> can also make a C<term>.
963
964 So, if you see two terms with an C<=> or C<+>, between them, you can
965 turn them into a single expression. When you do this, you execute the
966 code in the block on the next line: if you see C<=>, you'll do the code
967 in line 2. If you see C<+>, you'll do the code in line 4. It's this code
968 which contributes to the op tree.
969
970             |   term ADDOP term
971             { $$ = newBINOP($2, 0, scalar($1), scalar($3)); }
972
973 What this does is creates a new binary op, and feeds it a number of
974 variables. The variables refer to the tokens: C<$1> is the first token in
975 the input, C<$2> the second, and so on - think regular expression
976 backreferences. C<$$> is the op returned from this reduction. So, we
977 call C<newBINOP> to create a new binary operator. The first parameter to
978 C<newBINOP>, a function in F<op.c>, is the op type. It's an addition
979 operator, so we want the type to be C<ADDOP>. We could specify this
980 directly, but it's right there as the second token in the input, so we
981 use C<$2>. The second parameter is the op's flags: 0 means "nothing
982 special". Then the things to add: the left and right hand side of our
983 expression, in scalar context.
984
985 =head2 Stacks
986
987 When perl executes something like C<addop>, how does it pass on its
988 results to the next op? The answer is, through the use of stacks. Perl
989 has a number of stacks to store things it's currently working on, and
990 we'll look at the three most important ones here.
991
992 =over 3
993
994 =item Argument stack
995
996 Arguments are passed to PP code and returned from PP code using the
997 argument stack, C<ST>. The typical way to handle arguments is to pop
998 them off the stack, deal with them how you wish, and then push the result
999 back onto the stack. This is how, for instance, the cosine operator
1000 works:
1001
1002       NV value;
1003       value = POPn;
1004       value = Perl_cos(value);
1005       XPUSHn(value);
1006
1007 We'll see a more tricky example of this when we consider Perl's macros
1008 below. C<POPn> gives you the NV (floating point value) of the top SV on
1009 the stack: the C<$x> in C<cos($x)>. Then we compute the cosine, and push
1010 the result back as an NV. The C<X> in C<XPUSHn> means that the stack
1011 should be extended if necessary - it can't be necessary here, because we
1012 know there's room for one more item on the stack, since we've just
1013 removed one! The C<XPUSH*> macros at least guarantee safety.
1014
1015 Alternatively, you can fiddle with the stack directly: C<SP> gives you
1016 the first element in your portion of the stack, and C<TOP*> gives you
1017 the top SV/IV/NV/etc. on the stack. So, for instance, to do unary
1018 negation of an integer:
1019
1020      SETi(-TOPi);
1021
1022 Just set the integer value of the top stack entry to its negation.
1023
1024 Argument stack manipulation in the core is exactly the same as it is in
1025 XSUBs - see L<perlxstut>, L<perlxs> and L<perlguts> for a longer
1026 description of the macros used in stack manipulation.
1027
1028 =item Mark stack
1029
1030 I say "your portion of the stack" above because PP code doesn't
1031 necessarily get the whole stack to itself: if your function calls
1032 another function, you'll only want to expose the arguments aimed for the
1033 called function, and not (necessarily) let it get at your own data. The
1034 way we do this is to have a "virtual" bottom-of-stack, exposed to each
1035 function. The mark stack keeps bookmarks to locations in the argument
1036 stack usable by each function. For instance, when dealing with a tied
1037 variable, (internally, something with "P" magic) Perl has to call
1038 methods for accesses to the tied variables. However, we need to separate
1039 the arguments exposed to the method to the argument exposed to the
1040 original function - the store or fetch or whatever it may be. Here's
1041 roughly how the tied C<push> is implemented; see C<av_push> in F<av.c>:
1042
1043      1  PUSHMARK(SP);
1044      2  EXTEND(SP,2);
1045      3  PUSHs(SvTIED_obj((SV*)av, mg));
1046      4  PUSHs(val);
1047      5  PUTBACK;
1048      6  ENTER;
1049      7  call_method("PUSH", G_SCALAR|G_DISCARD);
1050      8  LEAVE;
1051
1052 Let's examine the whole implementation, for practice:
1053
1054      1  PUSHMARK(SP);
1055
1056 Push the current state of the stack pointer onto the mark stack. This is
1057 so that when we've finished adding items to the argument stack, Perl
1058 knows how many things we've added recently.
1059
1060      2  EXTEND(SP,2);
1061      3  PUSHs(SvTIED_obj((SV*)av, mg));
1062      4  PUSHs(val);
1063
1064 We're going to add two more items onto the argument stack: when you have
1065 a tied array, the C<PUSH> subroutine receives the object and the value
1066 to be pushed, and that's exactly what we have here - the tied object,
1067 retrieved with C<SvTIED_obj>, and the value, the SV C<val>.
1068
1069      5  PUTBACK;
1070
1071 Next we tell Perl to update the global stack pointer from our internal
1072 variable: C<dSP> only gave us a local copy, not a reference to the global.
1073
1074      6  ENTER;
1075      7  call_method("PUSH", G_SCALAR|G_DISCARD);
1076      8  LEAVE;
1077
1078 C<ENTER> and C<LEAVE> localise a block of code - they make sure that all
1079 variables are tidied up, everything that has been localised gets
1080 its previous value returned, and so on. Think of them as the C<{> and
1081 C<}> of a Perl block.
1082
1083 To actually do the magic method call, we have to call a subroutine in
1084 Perl space: C<call_method> takes care of that, and it's described in
1085 L<perlcall>. We call the C<PUSH> method in scalar context, and we're
1086 going to discard its return value.  The call_method() function
1087 removes the top element of the mark stack, so there is nothing for
1088 the caller to clean up.
1089
1090 =item Save stack
1091
1092 C doesn't have a concept of local scope, so perl provides one. We've
1093 seen that C<ENTER> and C<LEAVE> are used as scoping braces; the save
1094 stack implements the C equivalent of, for example:
1095
1096     {
1097         local $foo = 42;
1098         ...
1099     }
1100
1101 See L<perlguts/Localising Changes> for how to use the save stack.
1102
1103 =back
1104
1105 =head2 Millions of Macros
1106
1107 One thing you'll notice about the Perl source is that it's full of
1108 macros. Some have called the pervasive use of macros the hardest thing
1109 to understand, others find it adds to clarity. Let's take an example,
1110 the code which implements the addition operator:
1111
1112    1  PP(pp_add)
1113    2  {
1114    3      dSP; dATARGET; tryAMAGICbin(add,opASSIGN);
1115    4      {
1116    5        dPOPTOPnnrl_ul;
1117    6        SETn( left + right );
1118    7        RETURN;
1119    8      }
1120    9  }
1121
1122 Every line here (apart from the braces, of course) contains a macro. The
1123 first line sets up the function declaration as Perl expects for PP code;
1124 line 3 sets up variable declarations for the argument stack and the
1125 target, the return value of the operation. Finally, it tries to see if
1126 the addition operation is overloaded; if so, the appropriate subroutine
1127 is called.
1128
1129 Line 5 is another variable declaration - all variable declarations start
1130 with C<d> - which pops from the top of the argument stack two NVs (hence
1131 C<nn>) and puts them into the variables C<right> and C<left>, hence the
1132 C<rl>. These are the two operands to the addition operator. Next, we
1133 call C<SETn> to set the NV of the return value to the result of adding
1134 the two values. This done, we return - the C<RETURN> macro makes sure
1135 that our return value is properly handled, and we pass the next operator
1136 to run back to the main run loop.
1137
1138 Most of these macros are explained in L<perlapi>, and some of the more
1139 important ones are explained in L<perlxs> as well. Pay special attention
1140 to L<perlguts/Background and PERL_IMPLICIT_CONTEXT> for information on
1141 the C<[pad]THX_?> macros.
1142
1143 =head2 The .i Targets
1144
1145 You can expand the macros in a F<foo.c> file by saying
1146
1147     make foo.i
1148
1149 which will expand the macros using cpp.  Don't be scared by the results.
1150
1151 =head1 SOURCE CODE STATIC ANALYSIS
1152
1153 Various tools exist for analysing C source code B<statically>, as
1154 opposed to B<dynamically>, that is, without executing the code.
1155 It is possible to detect resource leaks, undefined behaviour, type
1156 mismatches, portability problems, code paths that would cause illegal
1157 memory accesses, and other similar problems by just parsing the C code
1158 and looking at the resulting graph, what does it tell about the
1159 execution and data flows.  As a matter of fact, this is exactly
1160 how C compilers know to give warnings about dubious code.
1161
1162 =head2 lint, splint
1163
1164 The good old C code quality inspector, C<lint>, is available in
1165 several platforms, but please be aware that there are several
1166 different implementations of it by different vendors, which means that
1167 the flags are not identical across different platforms.
1168
1169 There is a lint variant called C<splint> (Secure Programming Lint)
1170 available from http://www.splint.org/ that should compile on any
1171 Unix-like platform.
1172
1173 There are C<lint> and <splint> targets in Makefile, but you may have
1174 to diddle with the flags (see above).
1175
1176 =head2 Coverity
1177
1178 Coverity (http://www.coverity.com/) is a product similar to lint and
1179 as a testbed for their product they periodically check several open
1180 source projects, and they give out accounts to open source developers
1181 to the defect databases.
1182
1183 =head2 cpd (cut-and-paste detector)
1184
1185 The cpd tool detects cut-and-paste coding.  If one instance of the
1186 cut-and-pasted code changes, all the other spots should probably be
1187 changed, too.  Therefore such code should probably be turned into a
1188 subroutine or a macro.
1189
1190 cpd (http://pmd.sourceforge.net/cpd.html) is part of the pmd project
1191 (http://pmd.sourceforge.net/).  pmd was originally written for static
1192 analysis of Java code, but later the cpd part of it was extended to
1193 parse also C and C++.
1194
1195 Download the pmd-bin-X.Y.zip () from the SourceForge site, extract the
1196 pmd-X.Y.jar from it, and then run that on source code thusly:
1197
1198   java -cp pmd-X.Y.jar net.sourceforge.pmd.cpd.CPD --minimum-tokens 100 --files /some/where/src --language c > cpd.txt
1199
1200 You may run into memory limits, in which case you should use the -Xmx option:
1201
1202   java -Xmx512M ...
1203
1204 =head2 gcc warnings
1205
1206 Though much can be written about the inconsistency and coverage
1207 problems of gcc warnings (like C<-Wall> not meaning "all the
1208 warnings", or some common portability problems not being covered by
1209 C<-Wall>, or C<-ansi> and C<-pedantic> both being a poorly defined
1210 collection of warnings, and so forth), gcc is still a useful tool in
1211 keeping our coding nose clean.
1212
1213 The C<-Wall> is by default on.
1214
1215 The C<-ansi> (and its sidekick, C<-pedantic>) would be nice to be on
1216 always, but unfortunately they are not safe on all platforms, they can
1217 for example cause fatal conflicts with the system headers (Solaris
1218 being a prime example).  If Configure C<-Dgccansipedantic> is used,
1219 the C<cflags> frontend selects C<-ansi -pedantic> for the platforms
1220 where they are known to be safe.
1221
1222 Starting from Perl 5.9.4 the following extra flags are added:
1223
1224 =over 4
1225
1226 =item *
1227
1228 C<-Wendif-labels>
1229
1230 =item *
1231
1232 C<-Wextra>
1233
1234 =item *
1235
1236 C<-Wdeclaration-after-statement>
1237
1238 =back
1239
1240 The following flags would be nice to have but they would first need
1241 their own Augean stablemaster:
1242
1243 =over 4
1244
1245 =item *
1246
1247 C<-Wpointer-arith>
1248
1249 =item *
1250
1251 C<-Wshadow>
1252
1253 =item *
1254
1255 C<-Wstrict-prototypes>
1256
1257 =back
1258
1259 The C<-Wtraditional> is another example of the annoying tendency of
1260 gcc to bundle a lot of warnings under one switch -- it would be
1261 impossible to deploy in practice because it would complain a lot -- but
1262 it does contain some warnings that would be beneficial to have available
1263 on their own, such as the warning about string constants inside macros
1264 containing the macro arguments: this behaved differently pre-ANSI
1265 than it does in ANSI, and some C compilers are still in transition,
1266 AIX being an example.
1267
1268 =head2 Warnings of other C compilers
1269
1270 Other C compilers (yes, there B<are> other C compilers than gcc) often
1271 have their "strict ANSI" or "strict ANSI with some portability extensions"
1272 modes on, like for example the Sun Workshop has its C<-Xa> mode on
1273 (though implicitly), or the DEC (these days, HP...) has its C<-std1>
1274 mode on.
1275
1276 =head2 DEBUGGING
1277
1278 You can compile a special debugging version of Perl, which allows you
1279 to use the C<-D> option of Perl to tell more about what Perl is doing.
1280 But sometimes there is no alternative than to dive in with a debugger,
1281 either to see the stack trace of a core dump (very useful in a bug
1282 report), or trying to figure out what went wrong before the core dump
1283 happened, or how did we end up having wrong or unexpected results.
1284
1285 =head2 Poking at Perl
1286
1287 To really poke around with Perl, you'll probably want to build Perl for
1288 debugging, like this:
1289
1290     ./Configure -d -D optimize=-g
1291     make
1292
1293 C<-g> is a flag to the C compiler to have it produce debugging
1294 information which will allow us to step through a running program,
1295 and to see in which C function we are at (without the debugging
1296 information we might see only the numerical addresses of the functions,
1297 which is not very helpful).
1298
1299 F<Configure> will also turn on the C<DEBUGGING> compilation symbol which
1300 enables all the internal debugging code in Perl. There are a whole bunch
1301 of things you can debug with this: L<perlrun> lists them all, and the
1302 best way to find out about them is to play about with them. The most
1303 useful options are probably
1304
1305     l  Context (loop) stack processing
1306     t  Trace execution
1307     o  Method and overloading resolution
1308     c  String/numeric conversions
1309
1310 Some of the functionality of the debugging code can be achieved using XS
1311 modules.
1312
1313     -Dr => use re 'debug'
1314     -Dx => use O 'Debug'
1315
1316 =head2 Using a source-level debugger
1317
1318 If the debugging output of C<-D> doesn't help you, it's time to step
1319 through perl's execution with a source-level debugger.
1320
1321 =over 3
1322
1323 =item *
1324
1325 We'll use C<gdb> for our examples here; the principles will apply to
1326 any debugger (many vendors call their debugger C<dbx>), but check the
1327 manual of the one you're using.
1328
1329 =back
1330
1331 To fire up the debugger, type
1332
1333     gdb ./perl
1334
1335 Or if you have a core dump:
1336
1337     gdb ./perl core
1338
1339 You'll want to do that in your Perl source tree so the debugger can read
1340 the source code. You should see the copyright message, followed by the
1341 prompt.
1342
1343     (gdb)
1344
1345 C<help> will get you into the documentation, but here are the most
1346 useful commands:
1347
1348 =over 3
1349
1350 =item run [args]
1351
1352 Run the program with the given arguments.
1353
1354 =item break function_name
1355
1356 =item break source.c:xxx
1357
1358 Tells the debugger that we'll want to pause execution when we reach
1359 either the named function (but see L<perlguts/Internal Functions>!) or the given
1360 line in the named source file.
1361
1362 =item step
1363
1364 Steps through the program a line at a time.
1365
1366 =item next
1367
1368 Steps through the program a line at a time, without descending into
1369 functions.
1370
1371 =item continue
1372
1373 Run until the next breakpoint.
1374
1375 =item finish
1376
1377 Run until the end of the current function, then stop again.
1378
1379 =item 'enter'
1380
1381 Just pressing Enter will do the most recent operation again - it's a
1382 blessing when stepping through miles of source code.
1383
1384 =item print
1385
1386 Execute the given C code and print its results. B<WARNING>: Perl makes
1387 heavy use of macros, and F<gdb> does not necessarily support macros
1388 (see later L</"gdb macro support">).  You'll have to substitute them
1389 yourself, or to invoke cpp on the source code files
1390 (see L</"The .i Targets">)
1391 So, for instance, you can't say
1392
1393     print SvPV_nolen(sv)
1394
1395 but you have to say
1396
1397     print Perl_sv_2pv_nolen(sv)
1398
1399 =back
1400
1401 You may find it helpful to have a "macro dictionary", which you can
1402 produce by saying C<cpp -dM perl.c | sort>. Even then, F<cpp> won't
1403 recursively apply those macros for you.
1404
1405 =head2 gdb macro support
1406
1407 Recent versions of F<gdb> have fairly good macro support, but
1408 in order to use it you'll need to compile perl with macro definitions
1409 included in the debugging information.  Using F<gcc> version 3.1, this
1410 means configuring with C<-Doptimize=-g3>.  Other compilers might use a
1411 different switch (if they support debugging macros at all).
1412
1413 =head2 Dumping Perl Data Structures
1414
1415 One way to get around this macro hell is to use the dumping functions in
1416 F<dump.c>; these work a little like an internal
1417 L<Devel::Peek|Devel::Peek>, but they also cover OPs and other structures
1418 that you can't get at from Perl. Let's take an example. We'll use the
1419 C<$a = $b + $c> we used before, but give it a bit of context:
1420 C<$b = "6XXXX"; $c = 2.3;>. Where's a good place to stop and poke around?
1421
1422 What about C<pp_add>, the function we examined earlier to implement the
1423 C<+> operator:
1424
1425     (gdb) break Perl_pp_add
1426     Breakpoint 1 at 0x46249f: file pp_hot.c, line 309.
1427
1428 Notice we use C<Perl_pp_add> and not C<pp_add> - see L<perlguts/Internal Functions>.
1429 With the breakpoint in place, we can run our program:
1430
1431     (gdb) run -e '$b = "6XXXX"; $c = 2.3; $a = $b + $c'
1432
1433 Lots of junk will go past as gdb reads in the relevant source files and
1434 libraries, and then:
1435
1436     Breakpoint 1, Perl_pp_add () at pp_hot.c:309
1437     309         dSP; dATARGET; tryAMAGICbin(add,opASSIGN);
1438     (gdb) step
1439     311           dPOPTOPnnrl_ul;
1440     (gdb)
1441
1442 We looked at this bit of code before, and we said that C<dPOPTOPnnrl_ul>
1443 arranges for two C<NV>s to be placed into C<left> and C<right> - let's
1444 slightly expand it:
1445
1446     #define dPOPTOPnnrl_ul  NV right = POPn; \
1447                             SV *leftsv = TOPs; \
1448                             NV left = USE_LEFT(leftsv) ? SvNV(leftsv) : 0.0
1449
1450 C<POPn> takes the SV from the top of the stack and obtains its NV either
1451 directly (if C<SvNOK> is set) or by calling the C<sv_2nv> function.
1452 C<TOPs> takes the next SV from the top of the stack - yes, C<POPn> uses
1453 C<TOPs> - but doesn't remove it. We then use C<SvNV> to get the NV from
1454 C<leftsv> in the same way as before - yes, C<POPn> uses C<SvNV>.
1455
1456 Since we don't have an NV for C<$b>, we'll have to use C<sv_2nv> to
1457 convert it. If we step again, we'll find ourselves there:
1458
1459     Perl_sv_2nv (sv=0xa0675d0) at sv.c:1669
1460     1669        if (!sv)
1461     (gdb)
1462
1463 We can now use C<Perl_sv_dump> to investigate the SV:
1464
1465     SV = PV(0xa057cc0) at 0xa0675d0
1466     REFCNT = 1
1467     FLAGS = (POK,pPOK)
1468     PV = 0xa06a510 "6XXXX"\0
1469     CUR = 5
1470     LEN = 6
1471     $1 = void
1472
1473 We know we're going to get C<6> from this, so let's finish the
1474 subroutine:
1475
1476     (gdb) finish
1477     Run till exit from #0  Perl_sv_2nv (sv=0xa0675d0) at sv.c:1671
1478     0x462669 in Perl_pp_add () at pp_hot.c:311
1479     311           dPOPTOPnnrl_ul;
1480
1481 We can also dump out this op: the current op is always stored in
1482 C<PL_op>, and we can dump it with C<Perl_op_dump>. This'll give us
1483 similar output to L<B::Debug|B::Debug>.
1484
1485     {
1486     13  TYPE = add  ===> 14
1487         TARG = 1
1488         FLAGS = (SCALAR,KIDS)
1489         {
1490             TYPE = null  ===> (12)
1491               (was rv2sv)
1492             FLAGS = (SCALAR,KIDS)
1493             {
1494     11          TYPE = gvsv  ===> 12
1495                 FLAGS = (SCALAR)
1496                 GV = main::b
1497             }
1498         }
1499
1500 # finish this later #
1501
1502 =head2 Patching
1503
1504 All right, we've now had a look at how to navigate the Perl sources and
1505 some things you'll need to know when fiddling with them. Let's now get
1506 on and create a simple patch. Here's something Larry suggested: if a
1507 C<U> is the first active format during a C<pack>, (for example,
1508 C<pack "U3C8", @stuff>) then the resulting string should be treated as
1509 UTF-8 encoded.
1510
1511 How do we prepare to fix this up? First we locate the code in question -
1512 the C<pack> happens at runtime, so it's going to be in one of the F<pp>
1513 files. Sure enough, C<pp_pack> is in F<pp.c>. Since we're going to be
1514 altering this file, let's copy it to F<pp.c~>.
1515
1516 [Well, it was in F<pp.c> when this tutorial was written. It has now been
1517 split off with C<pp_unpack> to its own file, F<pp_pack.c>]
1518
1519 Now let's look over C<pp_pack>: we take a pattern into C<pat>, and then
1520 loop over the pattern, taking each format character in turn into
1521 C<datum_type>. Then for each possible format character, we swallow up
1522 the other arguments in the pattern (a field width, an asterisk, and so
1523 on) and convert the next chunk input into the specified format, adding
1524 it onto the output SV C<cat>.
1525
1526 How do we know if the C<U> is the first format in the C<pat>? Well, if
1527 we have a pointer to the start of C<pat> then, if we see a C<U> we can
1528 test whether we're still at the start of the string. So, here's where
1529 C<pat> is set up:
1530
1531     STRLEN fromlen;
1532     register char *pat = SvPVx(*++MARK, fromlen);
1533     register char *patend = pat + fromlen;
1534     register I32 len;
1535     I32 datumtype;
1536     SV *fromstr;
1537
1538 We'll have another string pointer in there:
1539
1540     STRLEN fromlen;
1541     register char *pat = SvPVx(*++MARK, fromlen);
1542     register char *patend = pat + fromlen;
1543  +  char *patcopy;
1544     register I32 len;
1545     I32 datumtype;
1546     SV *fromstr;
1547
1548 And just before we start the loop, we'll set C<patcopy> to be the start
1549 of C<pat>:
1550
1551     items = SP - MARK;
1552     MARK++;
1553     sv_setpvn(cat, "", 0);
1554  +  patcopy = pat;
1555     while (pat < patend) {
1556
1557 Now if we see a C<U> which was at the start of the string, we turn on
1558 the C<UTF8> flag for the output SV, C<cat>:
1559
1560  +  if (datumtype == 'U' && pat==patcopy+1)
1561  +      SvUTF8_on(cat);
1562     if (datumtype == '#') {
1563         while (pat < patend && *pat != '\n')
1564             pat++;
1565
1566 Remember that it has to be C<patcopy+1> because the first character of
1567 the string is the C<U> which has been swallowed into C<datumtype!>
1568
1569 Oops, we forgot one thing: what if there are spaces at the start of the
1570 pattern? C<pack("  U*", @stuff)> will have C<U> as the first active
1571 character, even though it's not the first thing in the pattern. In this
1572 case, we have to advance C<patcopy> along with C<pat> when we see spaces:
1573
1574     if (isSPACE(datumtype))
1575         continue;
1576
1577 needs to become
1578
1579     if (isSPACE(datumtype)) {
1580         patcopy++;
1581         continue;
1582     }
1583
1584 OK. That's the C part done. Now we must do two additional things before
1585 this patch is ready to go: we've changed the behaviour of Perl, and so
1586 we must document that change. We must also provide some more regression
1587 tests to make sure our patch works and doesn't create a bug somewhere
1588 else along the line.
1589
1590 The regression tests for each operator live in F<t/op/>, and so we
1591 make a copy of F<t/op/pack.t> to F<t/op/pack.t~>. Now we can add our
1592 tests to the end. First, we'll test that the C<U> does indeed create
1593 Unicode strings.
1594
1595 t/op/pack.t has a sensible ok() function, but if it didn't we could
1596 use the one from t/test.pl.
1597
1598  require './test.pl';
1599  plan( tests => 159 );
1600
1601 so instead of this:
1602
1603  print 'not ' unless "1.20.300.4000" eq sprintf "%vd", pack("U*",1,20,300,4000);
1604  print "ok $test\n"; $test++;
1605
1606 we can write the more sensible (see L<Test::More> for a full
1607 explanation of is() and other testing functions).
1608
1609  is( "1.20.300.4000", sprintf "%vd", pack("U*",1,20,300,4000),
1610                                        "U* produces Unicode" );
1611
1612 Now we'll test that we got that space-at-the-beginning business right:
1613
1614  is( "1.20.300.4000", sprintf "%vd", pack("  U*",1,20,300,4000),
1615                                        "  with spaces at the beginning" );
1616
1617 And finally we'll test that we don't make Unicode strings if C<U> is B<not>
1618 the first active format:
1619
1620  isnt( v1.20.300.4000, sprintf "%vd", pack("C0U*",1,20,300,4000),
1621                                        "U* not first isn't Unicode" );
1622
1623 Mustn't forget to change the number of tests which appears at the top,
1624 or else the automated tester will get confused.  This will either look
1625 like this:
1626
1627  print "1..156\n";
1628
1629 or this:
1630
1631  plan( tests => 156 );
1632
1633 We now compile up Perl, and run it through the test suite. Our new
1634 tests pass, hooray!
1635
1636 Finally, the documentation. The job is never done until the paperwork is
1637 over, so let's describe the change we've just made. The relevant place
1638 is F<pod/perlfunc.pod>; again, we make a copy, and then we'll insert
1639 this text in the description of C<pack>:
1640
1641  =item *
1642
1643  If the pattern begins with a C<U>, the resulting string will be treated
1644  as UTF-8-encoded Unicode. You can force UTF-8 encoding on in a string
1645  with an initial C<U0>, and the bytes that follow will be interpreted as
1646  Unicode characters. If you don't want this to happen, you can begin your
1647  pattern with C<C0> (or anything else) to force Perl not to UTF-8 encode your
1648  string, and then follow this with a C<U*> somewhere in your pattern.
1649
1650 All done. Now let's create the patch. F<Porting/patching.pod> tells us
1651 that if we're making major changes, we should copy the entire directory
1652 to somewhere safe before we begin fiddling, and then do
1653
1654     diff -ruN old new > patch
1655
1656 However, we know which files we've changed, and we can simply do this:
1657
1658     diff -u pp.c~             pp.c             >  patch
1659     diff -u t/op/pack.t~      t/op/pack.t      >> patch
1660     diff -u pod/perlfunc.pod~ pod/perlfunc.pod >> patch
1661
1662 We end up with a patch looking a little like this:
1663
1664     --- pp.c~       Fri Jun 02 04:34:10 2000
1665     +++ pp.c        Fri Jun 16 11:37:25 2000
1666     @@ -4375,6 +4375,7 @@
1667          register I32 items;
1668          STRLEN fromlen;
1669          register char *pat = SvPVx(*++MARK, fromlen);
1670     +    char *patcopy;
1671          register char *patend = pat + fromlen;
1672          register I32 len;
1673          I32 datumtype;
1674     @@ -4405,6 +4406,7 @@
1675     ...
1676
1677 And finally, we submit it, with our rationale, to perl5-porters. Job
1678 done!
1679
1680 =head2 Patching a core module
1681
1682 This works just like patching anything else, with an extra
1683 consideration.  Many core modules also live on CPAN.  If this is so,
1684 patch the CPAN version instead of the core and send the patch off to
1685 the module maintainer (with a copy to p5p).  This will help the module
1686 maintainer keep the CPAN version in sync with the core version without
1687 constantly scanning p5p.
1688
1689 The list of maintainers of core modules is usefully documented in
1690 F<Porting/Maintainers.pl>.
1691
1692 =head2 Adding a new function to the core
1693
1694 If, as part of a patch to fix a bug, or just because you have an
1695 especially good idea, you decide to add a new function to the core,
1696 discuss your ideas on p5p well before you start work.  It may be that
1697 someone else has already attempted to do what you are considering and
1698 can give lots of good advice or even provide you with bits of code
1699 that they already started (but never finished).
1700
1701 You have to follow all of the advice given above for patching.  It is
1702 extremely important to test any addition thoroughly and add new tests
1703 to explore all boundary conditions that your new function is expected
1704 to handle.  If your new function is used only by one module (e.g. toke),
1705 then it should probably be named S_your_function (for static); on the
1706 other hand, if you expect it to accessible from other functions in
1707 Perl, you should name it Perl_your_function.  See L<perlguts/Internal Functions>
1708 for more details.
1709
1710 The location of any new code is also an important consideration.  Don't
1711 just create a new top level .c file and put your code there; you would
1712 have to make changes to Configure (so the Makefile is created properly),
1713 as well as possibly lots of include files.  This is strictly pumpking
1714 business.
1715
1716 It is better to add your function to one of the existing top level
1717 source code files, but your choice is complicated by the nature of
1718 the Perl distribution.  Only the files that are marked as compiled
1719 static are located in the perl executable.  Everything else is located
1720 in the shared library (or DLL if you are running under WIN32).  So,
1721 for example, if a function was only used by functions located in
1722 toke.c, then your code can go in toke.c.  If, however, you want to call
1723 the function from universal.c, then you should put your code in another
1724 location, for example util.c.
1725
1726 In addition to writing your c-code, you will need to create an
1727 appropriate entry in embed.pl describing your function, then run
1728 'make regen_headers' to create the entries in the numerous header
1729 files that perl needs to compile correctly.  See L<perlguts/Internal Functions>
1730 for information on the various options that you can set in embed.pl.
1731 You will forget to do this a few (or many) times and you will get
1732 warnings during the compilation phase.  Make sure that you mention
1733 this when you post your patch to P5P; the pumpking needs to know this.
1734
1735 When you write your new code, please be conscious of existing code
1736 conventions used in the perl source files.  See L<perlstyle> for
1737 details.  Although most of the guidelines discussed seem to focus on
1738 Perl code, rather than c, they all apply (except when they don't ;).
1739 See also I<Porting/patching.pod> file in the Perl source distribution
1740 for lots of details about both formatting and submitting patches of
1741 your changes.
1742
1743 Lastly, TEST TEST TEST TEST TEST any code before posting to p5p.
1744 Test on as many platforms as you can find.  Test as many perl
1745 Configure options as you can (e.g. MULTIPLICITY).  If you have
1746 profiling or memory tools, see L<EXTERNAL TOOLS FOR DEBUGGING PERL>
1747 below for how to use them to further test your code.  Remember that
1748 most of the people on P5P are doing this on their own time and
1749 don't have the time to debug your code.
1750
1751 =head2 Writing a test
1752
1753 Every module and built-in function has an associated test file (or
1754 should...).  If you add or change functionality, you have to write a
1755 test.  If you fix a bug, you have to write a test so that bug never
1756 comes back.  If you alter the docs, it would be nice to test what the
1757 new documentation says.
1758
1759 In short, if you submit a patch you probably also have to patch the
1760 tests.
1761
1762 For modules, the test file is right next to the module itself.
1763 F<lib/strict.t> tests F<lib/strict.pm>.  This is a recent innovation,
1764 so there are some snags (and it would be wonderful for you to brush
1765 them out), but it basically works that way.  Everything else lives in
1766 F<t/>.
1767
1768 If you add a new test directory under F<t/>, it is imperative that you 
1769 add that directory to F<t/HARNESS> and F<t/TEST>.
1770
1771 =over 3
1772
1773 =item F<t/base/>
1774
1775 Testing of the absolute basic functionality of Perl.  Things like
1776 C<if>, basic file reads and writes, simple regexes, etc.  These are
1777 run first in the test suite and if any of them fail, something is
1778 I<really> broken.
1779
1780 =item F<t/cmd/>
1781
1782 These test the basic control structures, C<if/else>, C<while>,
1783 subroutines, etc.
1784
1785 =item F<t/comp/>
1786
1787 Tests basic issues of how Perl parses and compiles itself.
1788
1789 =item F<t/io/>
1790
1791 Tests for built-in IO functions, including command line arguments.
1792
1793 =item F<t/lib/>
1794
1795 The old home for the module tests, you shouldn't put anything new in
1796 here.  There are still some bits and pieces hanging around in here
1797 that need to be moved.  Perhaps you could move them?  Thanks!
1798
1799 =item F<t/mro/>
1800
1801 Tests for perl's method resolution order implementations
1802 (see L<mro>).
1803
1804 =item F<t/op/>
1805
1806 Tests for perl's built in functions that don't fit into any of the
1807 other directories.
1808
1809 =item F<t/re/>
1810
1811 Tests for regex related functions or behaviour. (These used to live
1812 in t/op).
1813
1814 =item F<t/run/>
1815
1816 Testing features of how perl actually runs, including exit codes and
1817 handling of PERL* environment variables.
1818
1819 =item F<t/uni/>
1820
1821 Tests for the core support of Unicode.
1822
1823 =item F<t/win32/>
1824
1825 Windows-specific tests.
1826
1827 =item F<t/x2p>
1828
1829 A test suite for the s2p converter.
1830
1831 =back
1832
1833 The core uses the same testing style as the rest of Perl, a simple
1834 "ok/not ok" run through Test::Harness, but there are a few special
1835 considerations.
1836
1837 There are three ways to write a test in the core.  Test::More,
1838 t/test.pl and ad hoc C<print $test ? "ok 42\n" : "not ok 42\n">.  The
1839 decision of which to use depends on what part of the test suite you're
1840 working on.  This is a measure to prevent a high-level failure (such
1841 as Config.pm breaking) from causing basic functionality tests to fail.
1842
1843 =over 4
1844
1845 =item t/base t/comp
1846
1847 Since we don't know if require works, or even subroutines, use ad hoc
1848 tests for these two.  Step carefully to avoid using the feature being
1849 tested.
1850
1851 =item t/cmd t/run t/io t/op
1852
1853 Now that basic require() and subroutines are tested, you can use the
1854 t/test.pl library which emulates the important features of Test::More
1855 while using a minimum of core features.
1856
1857 You can also conditionally use certain libraries like Config, but be
1858 sure to skip the test gracefully if it's not there.
1859
1860 =item t/lib ext lib
1861
1862 Now that the core of Perl is tested, Test::More can be used.  You can
1863 also use the full suite of core modules in the tests.
1864
1865 =back
1866
1867 When you say "make test" Perl uses the F<t/TEST> program to run the
1868 test suite (except under Win32 where it uses F<t/harness> instead.)
1869 All tests are run from the F<t/> directory, B<not> the directory
1870 which contains the test.  This causes some problems with the tests
1871 in F<lib/>, so here's some opportunity for some patching.
1872
1873 You must be triply conscious of cross-platform concerns.  This usually
1874 boils down to using File::Spec and avoiding things like C<fork()> and
1875 C<system()> unless absolutely necessary.
1876
1877 =head2 Special Make Test Targets
1878
1879 There are various special make targets that can be used to test Perl
1880 slightly differently than the standard "test" target.  Not all them
1881 are expected to give a 100% success rate.  Many of them have several
1882 aliases, and many of them are not available on certain operating
1883 systems.
1884
1885 =over 4
1886
1887 =item coretest
1888
1889 Run F<perl> on all core tests (F<t/*> and F<lib/[a-z]*> pragma tests).
1890
1891 (Not available on Win32)
1892
1893 =item test.deparse
1894
1895 Run all the tests through B::Deparse.  Not all tests will succeed.
1896
1897 (Not available on Win32)
1898
1899 =item test.taintwarn
1900
1901 Run all tests with the B<-t> command-line switch.  Not all tests
1902 are expected to succeed (until they're specifically fixed, of course).
1903
1904 (Not available on Win32)
1905
1906 =item minitest
1907
1908 Run F<miniperl> on F<t/base>, F<t/comp>, F<t/cmd>, F<t/run>, F<t/io>,
1909 F<t/op>, F<t/uni> and F<t/mro> tests.
1910
1911 =item test.valgrind check.valgrind utest.valgrind ucheck.valgrind
1912
1913 (Only in Linux) Run all the tests using the memory leak + naughty
1914 memory access tool "valgrind".  The log files will be named
1915 F<testname.valgrind>.
1916
1917 =item test.third check.third utest.third ucheck.third
1918
1919 (Only in Tru64)  Run all the tests using the memory leak + naughty
1920 memory access tool "Third Degree".  The log files will be named
1921 F<perl.3log.testname>.
1922
1923 =item test.torture torturetest
1924
1925 Run all the usual tests and some extra tests.  As of Perl 5.8.0 the
1926 only extra tests are Abigail's JAPHs, F<t/japh/abigail.t>.
1927
1928 You can also run the torture test with F<t/harness> by giving
1929 C<-torture> argument to F<t/harness>.
1930
1931 =item utest ucheck test.utf8 check.utf8
1932
1933 Run all the tests with -Mutf8.  Not all tests will succeed.
1934
1935 (Not available on Win32)
1936
1937 =item minitest.utf16 test.utf16
1938
1939 Runs the tests with UTF-16 encoded scripts, encoded with different
1940 versions of this encoding.
1941
1942 C<make utest.utf16> runs the test suite with a combination of C<-utf8> and
1943 C<-utf16> arguments to F<t/TEST>.
1944
1945 (Not available on Win32)
1946
1947 =item test_harness
1948
1949 Run the test suite with the F<t/harness> controlling program, instead of
1950 F<t/TEST>. F<t/harness> is more sophisticated, and uses the
1951 L<Test::Harness> module, thus using this test target supposes that perl
1952 mostly works. The main advantage for our purposes is that it prints a
1953 detailed summary of failed tests at the end. Also, unlike F<t/TEST>, it
1954 doesn't redirect stderr to stdout.
1955
1956 Note that under Win32 F<t/harness> is always used instead of F<t/TEST>, so
1957 there is no special "test_harness" target.
1958
1959 Under Win32's "test" target you may use the TEST_SWITCHES and TEST_FILES
1960 environment variables to control the behaviour of F<t/harness>.  This means
1961 you can say
1962
1963     nmake test TEST_FILES="op/*.t"
1964     nmake test TEST_SWITCHES="-torture" TEST_FILES="op/*.t"
1965
1966 =item Parallel tests
1967
1968 The core distribution can now run its regression tests in parallel on
1969 Unix-like platforms. Instead of running C<make test>, set C<TEST_JOBS> in
1970 your environment to the number of tests to run in parallel, and run
1971 C<make test_harness>. On a Bourne-like shell, this can be done as
1972
1973     TEST_JOBS=3 make test_harness  # Run 3 tests in parallel
1974
1975 An environment variable is used, rather than parallel make itself, because
1976 L<TAP::Harness> needs to be able to schedule individual non-conflicting test
1977 scripts itself, and there is no standard interface to C<make> utilities to
1978 interact with their job schedulers.
1979
1980 Note that currently some test scripts may fail when run in parallel (most
1981 notably C<ext/IO/t/io_dir.t>). If necessary run just the failing scripts
1982 again sequentially and see if the failures go away.
1983 =item test-notty test_notty
1984
1985 Sets PERL_SKIP_TTY_TEST to true before running normal test.
1986
1987 =back
1988
1989 =head2 Running tests by hand
1990
1991 You can run part of the test suite by hand by using one the following
1992 commands from the F<t/> directory :
1993
1994     ./perl -I../lib TEST list-of-.t-files
1995
1996 or
1997
1998     ./perl -I../lib harness list-of-.t-files
1999
2000 (if you don't specify test scripts, the whole test suite will be run.)
2001
2002 =head3 Using t/harness for testing
2003
2004 If you use C<harness> for testing you have several command line options
2005 available to you. The arguments are as follows, and are in the order
2006 that they must appear if used together.
2007
2008     harness -v -torture -re=pattern LIST OF FILES TO TEST
2009     harness -v -torture -re LIST OF PATTERNS TO MATCH
2010
2011 If C<LIST OF FILES TO TEST> is omitted the file list is obtained from
2012 the manifest. The file list may include shell wildcards which will be
2013 expanded out.
2014
2015 =over 4
2016
2017 =item -v
2018
2019 Run the tests under verbose mode so you can see what tests were run,
2020 and debug output.
2021
2022 =item -torture
2023
2024 Run the torture tests as well as the normal set.
2025
2026 =item -re=PATTERN
2027
2028 Filter the file list so that all the test files run match PATTERN.
2029 Note that this form is distinct from the B<-re LIST OF PATTERNS> form below
2030 in that it allows the file list to be provided as well.
2031
2032 =item -re LIST OF PATTERNS
2033
2034 Filter the file list so that all the test files run match
2035 /(LIST|OF|PATTERNS)/. Note that with this form the patterns
2036 are joined by '|' and you cannot supply a list of files, instead
2037 the test files are obtained from the MANIFEST.
2038
2039 =back
2040
2041 You can run an individual test by a command similar to
2042
2043     ./perl -I../lib patho/to/foo.t
2044
2045 except that the harnesses set up some environment variables that may
2046 affect the execution of the test :
2047
2048 =over 4
2049
2050 =item PERL_CORE=1
2051
2052 indicates that we're running this test part of the perl core test suite.
2053 This is useful for modules that have a dual life on CPAN.
2054
2055 =item PERL_DESTRUCT_LEVEL=2
2056
2057 is set to 2 if it isn't set already (see L</PERL_DESTRUCT_LEVEL>)
2058
2059 =item PERL
2060
2061 (used only by F<t/TEST>) if set, overrides the path to the perl executable
2062 that should be used to run the tests (the default being F<./perl>).
2063
2064 =item PERL_SKIP_TTY_TEST
2065
2066 if set, tells to skip the tests that need a terminal. It's actually set
2067 automatically by the Makefile, but can also be forced artificially by
2068 running 'make test_notty'.
2069
2070 =back
2071
2072 =head3 Other environment variables that may influence tests
2073
2074 =over 4
2075
2076 =item PERL_TEST_Net_Ping
2077
2078 Setting this variable runs all the Net::Ping modules tests,
2079 otherwise some tests that interact with the outside world are skipped.
2080 See L<perl58delta>.
2081
2082 =item PERL_TEST_NOVREXX
2083
2084 Setting this variable skips the vrexx.t tests for OS2::REXX.
2085
2086 =item PERL_TEST_NUMCONVERTS
2087
2088 This sets a variable in op/numconvert.t.
2089
2090 =back
2091
2092 See also the documentation for the Test and Test::Harness modules,
2093 for more environment variables that affect testing.
2094
2095 =head2 Common problems when patching Perl source code
2096
2097 Perl source plays by ANSI C89 rules: no C99 (or C++) extensions.  In
2098 some cases we have to take pre-ANSI requirements into consideration.
2099 You don't care about some particular platform having broken Perl?
2100 I hear there is still a strong demand for J2EE programmers.
2101
2102 =head2 Perl environment problems
2103
2104 =over 4
2105
2106 =item *
2107
2108 Not compiling with threading
2109
2110 Compiling with threading (-Duseithreads) completely rewrites
2111 the function prototypes of Perl.  You better try your changes
2112 with that.  Related to this is the difference between "Perl_-less"
2113 and "Perl_-ly" APIs, for example:
2114
2115   Perl_sv_setiv(aTHX_ ...);
2116   sv_setiv(...);
2117
2118 The first one explicitly passes in the context, which is needed for e.g.
2119 threaded builds.  The second one does that implicitly; do not get them
2120 mixed.  If you are not passing in a aTHX_, you will need to do a dTHX
2121 (or a dVAR) as the first thing in the function.
2122
2123 See L<perlguts/"How multiple interpreters and concurrency are supported">
2124 for further discussion about context.
2125
2126 =item *
2127
2128 Not compiling with -DDEBUGGING
2129
2130 The DEBUGGING define exposes more code to the compiler,
2131 therefore more ways for things to go wrong.  You should try it.
2132
2133 =item *
2134
2135 Introducing (non-read-only) globals
2136
2137 Do not introduce any modifiable globals, truly global or file static.
2138 They are bad form and complicate multithreading and other forms of
2139 concurrency.  The right way is to introduce them as new interpreter
2140 variables, see F<intrpvar.h> (at the very end for binary compatibility).
2141
2142 Introducing read-only (const) globals is okay, as long as you verify
2143 with e.g. C<nm libperl.a|egrep -v ' [TURtr] '> (if your C<nm> has
2144 BSD-style output) that the data you added really is read-only.
2145 (If it is, it shouldn't show up in the output of that command.)
2146
2147 If you want to have static strings, make them constant:
2148
2149   static const char etc[] = "...";
2150
2151 If you want to have arrays of constant strings, note carefully
2152 the right combination of C<const>s:
2153
2154     static const char * const yippee[] =
2155         {"hi", "ho", "silver"};
2156
2157 There is a way to completely hide any modifiable globals (they are all
2158 moved to heap), the compilation setting C<-DPERL_GLOBAL_STRUCT_PRIVATE>.
2159 It is not normally used, but can be used for testing, read more
2160 about it in L<perlguts/"Background and PERL_IMPLICIT_CONTEXT">.
2161
2162 =item *
2163
2164 Not exporting your new function
2165
2166 Some platforms (Win32, AIX, VMS, OS/2, to name a few) require any
2167 function that is part of the public API (the shared Perl library)
2168 to be explicitly marked as exported.  See the discussion about
2169 F<embed.pl> in L<perlguts>.
2170
2171 =item *
2172
2173 Exporting your new function
2174
2175 The new shiny result of either genuine new functionality or your
2176 arduous refactoring is now ready and correctly exported.  So what
2177 could possibly go wrong?
2178
2179 Maybe simply that your function did not need to be exported in the
2180 first place.  Perl has a long and not so glorious history of exporting
2181 functions that it should not have.
2182
2183 If the function is used only inside one source code file, make it
2184 static.  See the discussion about F<embed.pl> in L<perlguts>.
2185
2186 If the function is used across several files, but intended only for
2187 Perl's internal use (and this should be the common case), do not
2188 export it to the public API.  See the discussion about F<embed.pl>
2189 in L<perlguts>.
2190
2191 =back
2192
2193 =head2 Portability problems
2194
2195 The following are common causes of compilation and/or execution
2196 failures, not common to Perl as such.  The C FAQ is good bedtime
2197 reading.  Please test your changes with as many C compilers and
2198 platforms as possible -- we will, anyway, and it's nice to save
2199 oneself from public embarrassment.
2200
2201 If using gcc, you can add the C<-std=c89> option which will hopefully
2202 catch most of these unportabilities. (However it might also catch
2203 incompatibilities in your system's header files.)
2204
2205 Use the Configure C<-Dgccansipedantic> flag to enable the gcc
2206 C<-ansi -pedantic> flags which enforce stricter ANSI rules.
2207
2208 If using the C<gcc -Wall> note that not all the possible warnings
2209 (like C<-Wunitialized>) are given unless you also compile with C<-O>.
2210
2211 Note that if using gcc, starting from Perl 5.9.5 the Perl core source
2212 code files (the ones at the top level of the source code distribution,
2213 but not e.g. the extensions under ext/) are automatically compiled
2214 with as many as possible of the C<-std=c89>, C<-ansi>, C<-pedantic>,
2215 and a selection of C<-W> flags (see cflags.SH).
2216
2217 Also study L<perlport> carefully to avoid any bad assumptions
2218 about the operating system, filesystems, and so forth.
2219
2220 You may once in a while try a "make microperl" to see whether we
2221 can still compile Perl with just the bare minimum of interfaces.
2222 (See README.micro.)
2223
2224 Do not assume an operating system indicates a certain compiler.
2225
2226 =over 4
2227
2228 =item *
2229
2230 Casting pointers to integers or casting integers to pointers
2231
2232     void castaway(U8* p)
2233     {
2234       IV i = p;
2235
2236 or
2237
2238     void castaway(U8* p)
2239     {
2240       IV i = (IV)p;
2241
2242 Both are bad, and broken, and unportable.  Use the PTR2IV()
2243 macro that does it right.  (Likewise, there are PTR2UV(), PTR2NV(),
2244 INT2PTR(), and NUM2PTR().)
2245
2246 =item *
2247
2248 Casting between data function pointers and data pointers
2249
2250 Technically speaking casting between function pointers and data
2251 pointers is unportable and undefined, but practically speaking
2252 it seems to work, but you should use the FPTR2DPTR() and DPTR2FPTR()
2253 macros.  Sometimes you can also play games with unions.
2254
2255 =item *
2256
2257 Assuming sizeof(int) == sizeof(long)
2258
2259 There are platforms where longs are 64 bits, and platforms where ints
2260 are 64 bits, and while we are out to shock you, even platforms where
2261 shorts are 64 bits.  This is all legal according to the C standard.
2262 (In other words, "long long" is not a portable way to specify 64 bits,
2263 and "long long" is not even guaranteed to be any wider than "long".)
2264
2265 Instead, use the definitions IV, UV, IVSIZE, I32SIZE, and so forth.
2266 Avoid things like I32 because they are B<not> guaranteed to be
2267 I<exactly> 32 bits, they are I<at least> 32 bits, nor are they
2268 guaranteed to be B<int> or B<long>.  If you really explicitly need
2269 64-bit variables, use I64 and U64, but only if guarded by HAS_QUAD.
2270
2271 =item *
2272
2273 Assuming one can dereference any type of pointer for any type of data
2274
2275   char *p = ...;
2276   long pony = *p;    /* BAD */
2277
2278 Many platforms, quite rightly so, will give you a core dump instead
2279 of a pony if the p happens not be correctly aligned.
2280
2281 =item *
2282
2283 Lvalue casts
2284
2285   (int)*p = ...;    /* BAD */
2286
2287 Simply not portable.  Get your lvalue to be of the right type,
2288 or maybe use temporary variables, or dirty tricks with unions.
2289
2290 =item *
2291
2292 Assume B<anything> about structs (especially the ones you
2293 don't control, like the ones coming from the system headers)
2294
2295 =over 8
2296
2297 =item *
2298
2299 That a certain field exists in a struct
2300
2301 =item *
2302
2303 That no other fields exist besides the ones you know of
2304
2305 =item *
2306
2307 That a field is of certain signedness, sizeof, or type
2308
2309 =item *
2310
2311 That the fields are in a certain order
2312
2313 =over 8
2314
2315 =item *
2316
2317 While C guarantees the ordering specified in the struct definition,
2318 between different platforms the definitions might differ
2319
2320 =back
2321
2322 =item *
2323
2324 That the sizeof(struct) or the alignments are the same everywhere
2325
2326 =over 8
2327
2328 =item *
2329
2330 There might be padding bytes between the fields to align the fields -
2331 the bytes can be anything
2332
2333 =item *
2334
2335 Structs are required to be aligned to the maximum alignment required
2336 by the fields - which for native types is for usually equivalent to
2337 sizeof() of the field
2338
2339 =back
2340
2341 =back
2342
2343 =item *
2344
2345 Assuming the character set is ASCIIish
2346
2347 Perl can compile and run under EBCDIC platforms.  See L<perlebcdic>.
2348 This is transparent for the most part, but because the character sets
2349 differ, you shouldn't use numeric (decimal, octal, nor hex) constants
2350 to refer to characters.  You can safely say 'A', but not 0x41.
2351 You can safely say '\n', but not \012.
2352 If a character doesn't have a trivial input form, you can
2353 create a #define for it in both C<utfebcdic.h> and C<utf8.h>, so that
2354 it resolves to different values depending on the character set being used.
2355 (There are three different EBCDIC character sets defined in C<utfebcdic.h>,
2356 so it might be best to insert the #define three times in that file.)
2357
2358 Also, the range 'A' - 'Z' in ASCII is an unbroken sequence of 26 upper case
2359 alphabetic characters.  That is not true in EBCDIC.  Nor for 'a' to 'z'.
2360 But '0' - '9' is an unbroken range in both systems.  Don't assume anything
2361 about other ranges.
2362
2363 Many of the comments in the existing code ignore the possibility of EBCDIC,
2364 and may be wrong therefore, even if the code works.
2365 This is actually a tribute to the successful transparent insertion of being
2366 able to handle EBCDIC without having to change pre-existing code.
2367
2368 UTF-8 and UTF-EBCDIC are two different encodings used to represent Unicode
2369 code points as sequences of bytes.  Macros 
2370 with the same names (but different definitions)
2371 in C<utf8.h> and C<utfebcdic.h>
2372 are used to allow the calling code to think that there is only one such
2373 encoding.
2374 This is almost always referred to as C<utf8>, but it means the EBCDIC version
2375 as well.  Again, comments in the code may well be wrong even if the code itself
2376 is right.
2377 For example, the concept of C<invariant characters> differs between ASCII and
2378 EBCDIC.
2379 On ASCII platforms, only characters that do not have the high-order
2380 bit set (i.e. whose ordinals are strict ASCII, 0 - 127)
2381 are invariant, and the documentation and comments in the code
2382 may assume that,
2383 often referring to something like, say, C<hibit>.
2384 The situation differs and is not so simple on EBCDIC machines, but as long as
2385 the code itself uses the C<NATIVE_IS_INVARIANT()> macro appropriately, it
2386 works, even if the comments are wrong.
2387
2388 =item *
2389
2390 Assuming the character set is just ASCII
2391
2392 ASCII is a 7 bit encoding, but bytes have 8 bits in them.  The 128 extra
2393 characters have different meanings depending on the locale.  Absent a locale,
2394 currently these extra characters are generally considered to be unassigned,
2395 and this has presented some problems.
2396 This is scheduled to be changed in 5.12 so that these characters will
2397 be considered to be Latin-1 (ISO-8859-1).
2398
2399 =item *
2400
2401 Mixing #define and #ifdef
2402
2403   #define BURGLE(x) ... \
2404   #ifdef BURGLE_OLD_STYLE        /* BAD */
2405   ... do it the old way ... \
2406   #else
2407   ... do it the new way ... \
2408   #endif
2409
2410 You cannot portably "stack" cpp directives.  For example in the above
2411 you need two separate BURGLE() #defines, one for each #ifdef branch.
2412
2413 =item *
2414
2415 Adding non-comment stuff after #endif or #else
2416
2417   #ifdef SNOSH
2418   ...
2419   #else !SNOSH    /* BAD */
2420   ...
2421   #endif SNOSH    /* BAD */
2422
2423 The #endif and #else cannot portably have anything non-comment after
2424 them.  If you want to document what is going (which is a good idea
2425 especially if the branches are long), use (C) comments:
2426
2427   #ifdef SNOSH
2428   ...
2429   #else /* !SNOSH */
2430   ...
2431   #endif /* SNOSH */
2432
2433 The gcc option C<-Wendif-labels> warns about the bad variant
2434 (by default on starting from Perl 5.9.4).
2435
2436 =item *
2437
2438 Having a comma after the last element of an enum list
2439
2440   enum color {
2441     CERULEAN,
2442     CHARTREUSE,
2443     CINNABAR,     /* BAD */
2444   };
2445
2446 is not portable.  Leave out the last comma.
2447
2448 Also note that whether enums are implicitly morphable to ints
2449 varies between compilers, you might need to (int).
2450
2451 =item *
2452
2453 Using //-comments
2454
2455   // This function bamfoodles the zorklator.    /* BAD */
2456
2457 That is C99 or C++.  Perl is C89.  Using the //-comments is silently
2458 allowed by many C compilers but cranking up the ANSI C89 strictness
2459 (which we like to do) causes the compilation to fail.
2460
2461 =item *
2462
2463 Mixing declarations and code
2464
2465   void zorklator()
2466   {
2467     int n = 3;
2468     set_zorkmids(n);    /* BAD */
2469     int q = 4;
2470
2471 That is C99 or C++.  Some C compilers allow that, but you shouldn't.
2472
2473 The gcc option C<-Wdeclaration-after-statements> scans for such problems
2474 (by default on starting from Perl 5.9.4).
2475
2476 =item *
2477
2478 Introducing variables inside for()
2479
2480   for(int i = ...; ...; ...) {    /* BAD */
2481
2482 That is C99 or C++.  While it would indeed be awfully nice to have that
2483 also in C89, to limit the scope of the loop variable, alas, we cannot.
2484
2485 =item *
2486
2487 Mixing signed char pointers with unsigned char pointers
2488
2489   int foo(char *s) { ... }
2490   ...
2491   unsigned char *t = ...; /* Or U8* t = ... */
2492   foo(t);   /* BAD */
2493
2494 While this is legal practice, it is certainly dubious, and downright
2495 fatal in at least one platform: for example VMS cc considers this a
2496 fatal error.  One cause for people often making this mistake is that a
2497 "naked char" and therefore dereferencing a "naked char pointer" have
2498 an undefined signedness: it depends on the compiler and the flags of
2499 the compiler and the underlying platform whether the result is signed
2500 or unsigned.  For this very same reason using a 'char' as an array
2501 index is bad.
2502
2503 =item *
2504
2505 Macros that have string constants and their arguments as substrings of
2506 the string constants
2507
2508   #define FOO(n) printf("number = %d\n", n)    /* BAD */
2509   FOO(10);
2510
2511 Pre-ANSI semantics for that was equivalent to
2512
2513   printf("10umber = %d\10");
2514
2515 which is probably not what you were expecting.  Unfortunately at least
2516 one reasonably common and modern C compiler does "real backward
2517 compatibility" here, in AIX that is what still happens even though the
2518 rest of the AIX compiler is very happily C89.
2519
2520 =item *
2521
2522 Using printf formats for non-basic C types
2523
2524    IV i = ...;
2525    printf("i = %d\n", i);    /* BAD */
2526
2527 While this might by accident work in some platform (where IV happens
2528 to be an C<int>), in general it cannot.  IV might be something larger.
2529 Even worse the situation is with more specific types (defined by Perl's
2530 configuration step in F<config.h>):
2531
2532    Uid_t who = ...;
2533    printf("who = %d\n", who);    /* BAD */
2534
2535 The problem here is that Uid_t might be not only not C<int>-wide
2536 but it might also be unsigned, in which case large uids would be
2537 printed as negative values.
2538
2539 There is no simple solution to this because of printf()'s limited
2540 intelligence, but for many types the right format is available as
2541 with either 'f' or '_f' suffix, for example:
2542
2543    IVdf /* IV in decimal */
2544    UVxf /* UV is hexadecimal */
2545
2546    printf("i = %"IVdf"\n", i); /* The IVdf is a string constant. */
2547
2548    Uid_t_f /* Uid_t in decimal */
2549
2550    printf("who = %"Uid_t_f"\n", who);
2551
2552 Or you can try casting to a "wide enough" type:
2553
2554    printf("i = %"IVdf"\n", (IV)something_very_small_and_signed);
2555
2556 Also remember that the C<%p> format really does require a void pointer:
2557
2558    U8* p = ...;
2559    printf("p = %p\n", (void*)p);
2560
2561 The gcc option C<-Wformat> scans for such problems.
2562
2563 =item *
2564
2565 Blindly using variadic macros
2566
2567 gcc has had them for a while with its own syntax, and C99 brought
2568 them with a standardized syntax.  Don't use the former, and use
2569 the latter only if the HAS_C99_VARIADIC_MACROS is defined.
2570
2571 =item *
2572
2573 Blindly passing va_list
2574
2575 Not all platforms support passing va_list to further varargs (stdarg)
2576 functions.  The right thing to do is to copy the va_list using the
2577 Perl_va_copy() if the NEED_VA_COPY is defined.
2578
2579 =item *
2580
2581 Using gcc statement expressions
2582
2583    val = ({...;...;...});    /* BAD */
2584
2585 While a nice extension, it's not portable.  The Perl code does
2586 admittedly use them if available to gain some extra speed
2587 (essentially as a funky form of inlining), but you shouldn't.
2588
2589 =item *
2590
2591 Binding together several statements in a macro
2592
2593 Use the macros STMT_START and STMT_END.
2594
2595    STMT_START {
2596       ...
2597    } STMT_END
2598
2599 =item *
2600
2601 Testing for operating systems or versions when should be testing for features
2602
2603   #ifdef __FOONIX__    /* BAD */
2604   foo = quux();
2605   #endif
2606
2607 Unless you know with 100% certainty that quux() is only ever available
2608 for the "Foonix" operating system B<and> that is available B<and>
2609 correctly working for B<all> past, present, B<and> future versions of
2610 "Foonix", the above is very wrong.  This is more correct (though still
2611 not perfect, because the below is a compile-time check):
2612
2613   #ifdef HAS_QUUX
2614   foo = quux();
2615   #endif
2616
2617 How does the HAS_QUUX become defined where it needs to be?  Well, if
2618 Foonix happens to be UNIXy enough to be able to run the Configure
2619 script, and Configure has been taught about detecting and testing
2620 quux(), the HAS_QUUX will be correctly defined.  In other platforms,
2621 the corresponding configuration step will hopefully do the same.
2622
2623 In a pinch, if you cannot wait for Configure to be educated,
2624 or if you have a good hunch of where quux() might be available,
2625 you can temporarily try the following:
2626
2627   #if (defined(__FOONIX__) || defined(__BARNIX__))
2628   # define HAS_QUUX
2629   #endif
2630
2631   ...
2632
2633   #ifdef HAS_QUUX
2634   foo = quux();
2635   #endif
2636
2637 But in any case, try to keep the features and operating systems separate.
2638
2639 =back
2640
2641 =head2 Problematic System Interfaces
2642
2643 =over 4
2644
2645 =item *
2646
2647 malloc(0), realloc(0), calloc(0, 0) are non-portable.  To be portable
2648 allocate at least one byte.  (In general you should rarely need to
2649 work at this low level, but instead use the various malloc wrappers.)
2650
2651 =item *
2652
2653 snprintf() - the return type is unportable.  Use my_snprintf() instead.
2654
2655 =back
2656
2657 =head2 Security problems
2658
2659 Last but not least, here are various tips for safer coding.
2660
2661 =over 4
2662
2663 =item *
2664
2665 Do not use gets()
2666
2667 Or we will publicly ridicule you.  Seriously.
2668
2669 =item *
2670
2671 Do not use strcpy() or strcat() or strncpy() or strncat()
2672
2673 Use my_strlcpy() and my_strlcat() instead: they either use the native
2674 implementation, or Perl's own implementation (borrowed from the public
2675 domain implementation of INN).
2676
2677 =item *
2678
2679 Do not use sprintf() or vsprintf()
2680
2681 If you really want just plain byte strings, use my_snprintf()
2682 and my_vsnprintf() instead, which will try to use snprintf() and
2683 vsnprintf() if those safer APIs are available.  If you want something
2684 fancier than a plain byte string, use SVs and Perl_sv_catpvf().
2685
2686 =back
2687
2688 =head1 EXTERNAL TOOLS FOR DEBUGGING PERL
2689
2690 Sometimes it helps to use external tools while debugging and
2691 testing Perl.  This section tries to guide you through using
2692 some common testing and debugging tools with Perl.  This is
2693 meant as a guide to interfacing these tools with Perl, not
2694 as any kind of guide to the use of the tools themselves.
2695
2696 B<NOTE 1>: Running under memory debuggers such as Purify, valgrind, or
2697 Third Degree greatly slows down the execution: seconds become minutes,
2698 minutes become hours.  For example as of Perl 5.8.1, the
2699 ext/Encode/t/Unicode.t takes extraordinarily long to complete under
2700 e.g. Purify, Third Degree, and valgrind.  Under valgrind it takes more
2701 than six hours, even on a snappy computer-- the said test must be
2702 doing something that is quite unfriendly for memory debuggers.  If you
2703 don't feel like waiting, that you can simply kill away the perl
2704 process.
2705
2706 B<NOTE 2>: To minimize the number of memory leak false alarms (see
2707 L</PERL_DESTRUCT_LEVEL> for more information), you have to have
2708 environment variable PERL_DESTRUCT_LEVEL set to 2.  The F<TEST>
2709 and harness scripts do that automatically.  But if you are running
2710 some of the tests manually-- for csh-like shells:
2711
2712     setenv PERL_DESTRUCT_LEVEL 2
2713
2714 and for Bourne-type shells:
2715
2716     PERL_DESTRUCT_LEVEL=2
2717     export PERL_DESTRUCT_LEVEL
2718
2719 or in UNIXy environments you can also use the C<env> command:
2720
2721     env PERL_DESTRUCT_LEVEL=2 valgrind ./perl -Ilib ...
2722
2723 B<NOTE 3>: There are known memory leaks when there are compile-time
2724 errors within eval or require, seeing C<S_doeval> in the call stack
2725 is a good sign of these.  Fixing these leaks is non-trivial,
2726 unfortunately, but they must be fixed eventually.
2727
2728 B<NOTE 4>: L<DynaLoader> will not clean up after itself completely
2729 unless Perl is built with the Configure option
2730 C<-Accflags=-DDL_UNLOAD_ALL_AT_EXIT>.
2731
2732 =head2 Rational Software's Purify
2733
2734 Purify is a commercial tool that is helpful in identifying
2735 memory overruns, wild pointers, memory leaks and other such
2736 badness.  Perl must be compiled in a specific way for
2737 optimal testing with Purify.  Purify is available under
2738 Windows NT, Solaris, HP-UX, SGI, and Siemens Unix.
2739
2740 =head2 Purify on Unix
2741
2742 On Unix, Purify creates a new Perl binary.  To get the most
2743 benefit out of Purify, you should create the perl to Purify
2744 using:
2745
2746     sh Configure -Accflags=-DPURIFY -Doptimize='-g' \
2747      -Uusemymalloc -Dusemultiplicity
2748
2749 where these arguments mean:
2750
2751 =over 4
2752
2753 =item -Accflags=-DPURIFY
2754
2755 Disables Perl's arena memory allocation functions, as well as
2756 forcing use of memory allocation functions derived from the
2757 system malloc.
2758
2759 =item -Doptimize='-g'
2760
2761 Adds debugging information so that you see the exact source
2762 statements where the problem occurs.  Without this flag, all
2763 you will see is the source filename of where the error occurred.
2764
2765 =item -Uusemymalloc
2766
2767 Disable Perl's malloc so that Purify can more closely monitor
2768 allocations and leaks.  Using Perl's malloc will make Purify
2769 report most leaks in the "potential" leaks category.
2770
2771 =item -Dusemultiplicity
2772
2773 Enabling the multiplicity option allows perl to clean up
2774 thoroughly when the interpreter shuts down, which reduces the
2775 number of bogus leak reports from Purify.
2776
2777 =back
2778
2779 Once you've compiled a perl suitable for Purify'ing, then you
2780 can just:
2781
2782     make pureperl
2783
2784 which creates a binary named 'pureperl' that has been Purify'ed.
2785 This binary is used in place of the standard 'perl' binary
2786 when you want to debug Perl memory problems.
2787
2788 As an example, to show any memory leaks produced during the
2789 standard Perl testset you would create and run the Purify'ed
2790 perl as:
2791
2792     make pureperl
2793     cd t
2794     ../pureperl -I../lib harness
2795
2796 which would run Perl on test.pl and report any memory problems.
2797
2798 Purify outputs messages in "Viewer" windows by default.  If
2799 you don't have a windowing environment or if you simply
2800 want the Purify output to unobtrusively go to a log file
2801 instead of to the interactive window, use these following
2802 options to output to the log file "perl.log":
2803
2804     setenv PURIFYOPTIONS "-chain-length=25 -windows=no \
2805      -log-file=perl.log -append-logfile=yes"
2806
2807 If you plan to use the "Viewer" windows, then you only need this option:
2808
2809     setenv PURIFYOPTIONS "-chain-length=25"
2810
2811 In Bourne-type shells:
2812
2813     PURIFYOPTIONS="..."
2814     export PURIFYOPTIONS
2815
2816 or if you have the "env" utility:
2817
2818     env PURIFYOPTIONS="..." ../pureperl ...
2819
2820 =head2 Purify on NT
2821
2822 Purify on Windows NT instruments the Perl binary 'perl.exe'
2823 on the fly.  There are several options in the makefile you
2824 should change to get the most use out of Purify:
2825
2826 =over 4
2827
2828 =item DEFINES
2829
2830 You should add -DPURIFY to the DEFINES line so the DEFINES
2831 line looks something like:
2832
2833     DEFINES = -DWIN32 -D_CONSOLE -DNO_STRICT $(CRYPT_FLAG) -DPURIFY=1
2834
2835 to disable Perl's arena memory allocation functions, as
2836 well as to force use of memory allocation functions derived
2837 from the system malloc.
2838
2839 =item USE_MULTI = define
2840
2841 Enabling the multiplicity option allows perl to clean up
2842 thoroughly when the interpreter shuts down, which reduces the
2843 number of bogus leak reports from Purify.
2844
2845 =item #PERL_MALLOC = define
2846
2847 Disable Perl's malloc so that Purify can more closely monitor
2848 allocations and leaks.  Using Perl's malloc will make Purify
2849 report most leaks in the "potential" leaks category.
2850
2851 =item CFG = Debug
2852
2853 Adds debugging information so that you see the exact source
2854 statements where the problem occurs.  Without this flag, all
2855 you will see is the source filename of where the error occurred.
2856
2857 =back
2858
2859 As an example, to show any memory leaks produced during the
2860 standard Perl testset you would create and run Purify as:
2861
2862     cd win32
2863     make
2864     cd ../t
2865     purify ../perl -I../lib harness
2866
2867 which would instrument Perl in memory, run Perl on test.pl,
2868 then finally report any memory problems.
2869
2870 =head2 valgrind
2871
2872 The excellent valgrind tool can be used to find out both memory leaks
2873 and illegal memory accesses.  As of version 3.3.0, Valgrind only
2874 supports Linux on x86, x86-64 and PowerPC.  The special "test.valgrind" 
2875 target can be used to run the tests under valgrind.  Found errors 
2876 and memory leaks are logged in files named F<testfile.valgrind>.
2877
2878 Valgrind also provides a cachegrind tool, invoked on perl as:
2879
2880     VG_OPTS=--tool=cachegrind make test.valgrind
2881
2882 As system libraries (most notably glibc) are also triggering errors,
2883 valgrind allows to suppress such errors using suppression files. The
2884 default suppression file that comes with valgrind already catches a lot
2885 of them. Some additional suppressions are defined in F<t/perl.supp>.
2886
2887 To get valgrind and for more information see
2888
2889     http://developer.kde.org/~sewardj/
2890
2891 =head2 Compaq's/Digital's/HP's Third Degree
2892
2893 Third Degree is a tool for memory leak detection and memory access checks.
2894 It is one of the many tools in the ATOM toolkit.  The toolkit is only
2895 available on Tru64 (formerly known as Digital UNIX formerly known as
2896 DEC OSF/1).
2897
2898 When building Perl, you must first run Configure with -Doptimize=-g
2899 and -Uusemymalloc flags, after that you can use the make targets
2900 "perl.third" and "test.third".  (What is required is that Perl must be
2901 compiled using the C<-g> flag, you may need to re-Configure.)
2902
2903 The short story is that with "atom" you can instrument the Perl
2904 executable to create a new executable called F<perl.third>.  When the
2905 instrumented executable is run, it creates a log of dubious memory
2906 traffic in file called F<perl.3log>.  See the manual pages of atom and
2907 third for more information.  The most extensive Third Degree
2908 documentation is available in the Compaq "Tru64 UNIX Programmer's
2909 Guide", chapter "Debugging Programs with Third Degree".
2910
2911 The "test.third" leaves a lot of files named F<foo_bar.3log> in the t/
2912 subdirectory.  There is a problem with these files: Third Degree is so
2913 effective that it finds problems also in the system libraries.
2914 Therefore you should used the Porting/thirdclean script to cleanup
2915 the F<*.3log> files.
2916
2917 There are also leaks that for given certain definition of a leak,
2918 aren't.  See L</PERL_DESTRUCT_LEVEL> for more information.
2919
2920 =head2 PERL_DESTRUCT_LEVEL
2921
2922 If you want to run any of the tests yourself manually using e.g.
2923 valgrind, or the pureperl or perl.third executables, please note that
2924 by default perl B<does not> explicitly cleanup all the memory it has
2925 allocated (such as global memory arenas) but instead lets the exit()
2926 of the whole program "take care" of such allocations, also known as
2927 "global destruction of objects".
2928
2929 There is a way to tell perl to do complete cleanup: set the
2930 environment variable PERL_DESTRUCT_LEVEL to a non-zero value.
2931 The t/TEST wrapper does set this to 2, and this is what you
2932 need to do too, if you don't want to see the "global leaks":
2933 For example, for "third-degreed" Perl:
2934
2935         env PERL_DESTRUCT_LEVEL=2 ./perl.third -Ilib t/foo/bar.t
2936
2937 (Note: the mod_perl apache module uses also this environment variable
2938 for its own purposes and extended its semantics. Refer to the mod_perl
2939 documentation for more information. Also, spawned threads do the
2940 equivalent of setting this variable to the value 1.)
2941
2942 If, at the end of a run you get the message I<N scalars leaked>, you can
2943 recompile with C<-DDEBUG_LEAKING_SCALARS>, which will cause the addresses
2944 of all those leaked SVs to be dumped along with details as to where each
2945 SV was originally allocated. This information is also displayed by
2946 Devel::Peek. Note that the extra details recorded with each SV increases
2947 memory usage, so it shouldn't be used in production environments. It also
2948 converts C<new_SV()> from a macro into a real function, so you can use
2949 your favourite debugger to discover where those pesky SVs were allocated.
2950
2951 If you see that you're leaking memory at runtime, but neither valgrind
2952 nor C<-DDEBUG_LEAKING_SCALARS> will find anything, you're probably
2953 leaking SVs that are still reachable and will be properly cleaned up
2954 during destruction of the interpreter. In such cases, using the C<-Dm>
2955 switch can point you to the source of the leak. If the executable was
2956 built with C<-DDEBUG_LEAKING_SCALARS>, C<-Dm> will output SV allocations
2957 in addition to memory allocations. Each SV allocation has a distinct
2958 serial number that will be written on creation and destruction of the SV. 
2959 So if you're executing the leaking code in a loop, you need to look for
2960 SVs that are created, but never destroyed between each cycle. If such an
2961 SV is found, set a conditional breakpoint within C<new_SV()> and make it
2962 break only when C<PL_sv_serial> is equal to the serial number of the
2963 leaking SV. Then you will catch the interpreter in exactly the state
2964 where the leaking SV is allocated, which is sufficient in many cases to
2965 find the source of the leak.
2966
2967 As C<-Dm> is using the PerlIO layer for output, it will by itself
2968 allocate quite a bunch of SVs, which are hidden to avoid recursion.
2969 You can bypass the PerlIO layer if you use the SV logging provided
2970 by C<-DPERL_MEM_LOG> instead.
2971
2972 =head2 PERL_MEM_LOG
2973
2974 If compiled with C<-DPERL_MEM_LOG>, both memory and SV allocations go
2975 through logging functions, which is handy for breakpoint setting.
2976
2977 Unless C<-DPERL_MEM_LOG_NOIMPL> is also compiled, the logging
2978 functions read $ENV{PERL_MEM_LOG} to determine whether to log the
2979 event, and if so how:
2980
2981     $ENV{PERL_MEM_LOG} =~ /m/           Log all memory ops
2982     $ENV{PERL_MEM_LOG} =~ /s/           Log all SV ops
2983     $ENV{PERL_MEM_LOG} =~ /t/           include timestamp in Log
2984     $ENV{PERL_MEM_LOG} =~ /^(\d+)/      write to FD given (default is 2)
2985
2986 Memory logging is somewhat similar to C<-Dm> but is independent of
2987 C<-DDEBUGGING>, and at a higher level; all uses of Newx(), Renew(),
2988 and Safefree() are logged with the caller's source code file and line
2989 number (and C function name, if supported by the C compiler).  In
2990 contrast, C<-Dm> is directly at the point of C<malloc()>.  SV logging
2991 is similar.
2992
2993 Since the logging doesn't use PerlIO, all SV allocations are logged
2994 and no extra SV allocations are introduced by enabling the logging.
2995 If compiled with C<-DDEBUG_LEAKING_SCALARS>, the serial number for
2996 each SV allocation is also logged.
2997
2998 =head2 Profiling
2999
3000 Depending on your platform there are various of profiling Perl.
3001
3002 There are two commonly used techniques of profiling executables:
3003 I<statistical time-sampling> and I<basic-block counting>.
3004
3005 The first method takes periodically samples of the CPU program
3006 counter, and since the program counter can be correlated with the code
3007 generated for functions, we get a statistical view of in which
3008 functions the program is spending its time.  The caveats are that very
3009 small/fast functions have lower probability of showing up in the
3010 profile, and that periodically interrupting the program (this is
3011 usually done rather frequently, in the scale of milliseconds) imposes
3012 an additional overhead that may skew the results.  The first problem
3013 can be alleviated by running the code for longer (in general this is a
3014 good idea for profiling), the second problem is usually kept in guard
3015 by the profiling tools themselves.
3016
3017 The second method divides up the generated code into I<basic blocks>.
3018 Basic blocks are sections of code that are entered only in the
3019 beginning and exited only at the end.  For example, a conditional jump
3020 starts a basic block.  Basic block profiling usually works by
3021 I<instrumenting> the code by adding I<enter basic block #nnnn>
3022 book-keeping code to the generated code.  During the execution of the
3023 code the basic block counters are then updated appropriately.  The
3024 caveat is that the added extra code can skew the results: again, the
3025 profiling tools usually try to factor their own effects out of the
3026 results.
3027
3028 =head2 Gprof Profiling
3029
3030 gprof is a profiling tool available in many UNIX platforms,
3031 it uses F<statistical time-sampling>.
3032
3033 You can build a profiled version of perl called "perl.gprof" by
3034 invoking the make target "perl.gprof"  (What is required is that Perl
3035 must be compiled using the C<-pg> flag, you may need to re-Configure).
3036 Running the profiled version of Perl will create an output file called
3037 F<gmon.out> is created which contains the profiling data collected
3038 during the execution.
3039
3040 The gprof tool can then display the collected data in various ways.
3041 Usually gprof understands the following options:
3042
3043 =over 4
3044
3045 =item -a
3046
3047 Suppress statically defined functions from the profile.
3048
3049 =item -b
3050
3051 Suppress the verbose descriptions in the profile.
3052
3053 =item -e routine
3054
3055 Exclude the given routine and its descendants from the profile.
3056
3057 =item -f routine
3058
3059 Display only the given routine and its descendants in the profile.
3060
3061 =item -s
3062
3063 Generate a summary file called F<gmon.sum> which then may be given
3064 to subsequent gprof runs to accumulate data over several runs.
3065
3066 =item -z
3067
3068 Display routines that have zero usage.
3069
3070 =back
3071
3072 For more detailed explanation of the available commands and output
3073 formats, see your own local documentation of gprof.
3074
3075 quick hint:
3076
3077     $ sh Configure -des -Dusedevel -Doptimize='-pg' && make perl.gprof
3078     $ ./perl.gprof someprog # creates gmon.out in current directory
3079     $ gprof ./perl.gprof > out
3080     $ view out
3081
3082 =head2 GCC gcov Profiling
3083
3084 Starting from GCC 3.0 I<basic block profiling> is officially available
3085 for the GNU CC.
3086
3087 You can build a profiled version of perl called F<perl.gcov> by
3088 invoking the make target "perl.gcov" (what is required that Perl must
3089 be compiled using gcc with the flags C<-fprofile-arcs
3090 -ftest-coverage>, you may need to re-Configure).
3091
3092 Running the profiled version of Perl will cause profile output to be
3093 generated.  For each source file an accompanying ".da" file will be
3094 created.
3095
3096 To display the results you use the "gcov" utility (which should
3097 be installed if you have gcc 3.0 or newer installed).  F<gcov> is
3098 run on source code files, like this
3099
3100     gcov sv.c
3101
3102 which will cause F<sv.c.gcov> to be created.  The F<.gcov> files
3103 contain the source code annotated with relative frequencies of
3104 execution indicated by "#" markers.
3105
3106 Useful options of F<gcov> include C<-b> which will summarise the
3107 basic block, branch, and function call coverage, and C<-c> which
3108 instead of relative frequencies will use the actual counts.  For
3109 more information on the use of F<gcov> and basic block profiling
3110 with gcc, see the latest GNU CC manual, as of GCC 3.0 see
3111
3112     http://gcc.gnu.org/onlinedocs/gcc-3.0/gcc.html
3113
3114 and its section titled "8. gcov: a Test Coverage Program"
3115
3116     http://gcc.gnu.org/onlinedocs/gcc-3.0/gcc_8.html#SEC132
3117
3118 quick hint:
3119
3120     $ sh Configure -des  -Doptimize='-g' -Accflags='-fprofile-arcs -ftest-coverage' \
3121         -Aldflags='-fprofile-arcs -ftest-coverage' && make perl.gcov
3122     $ rm -f regexec.c.gcov regexec.gcda
3123     $ ./perl.gcov
3124     $ gcov regexec.c
3125     $ view regexec.c.gcov
3126
3127 =head2 Pixie Profiling
3128
3129 Pixie is a profiling tool available on IRIX and Tru64 (aka Digital
3130 UNIX aka DEC OSF/1) platforms.  Pixie does its profiling using
3131 I<basic-block counting>.
3132
3133 You can build a profiled version of perl called F<perl.pixie> by
3134 invoking the make target "perl.pixie" (what is required is that Perl
3135 must be compiled using the C<-g> flag, you may need to re-Configure).
3136
3137 In Tru64 a file called F<perl.Addrs> will also be silently created,
3138 this file contains the addresses of the basic blocks.  Running the
3139 profiled version of Perl will create a new file called "perl.Counts"
3140 which contains the counts for the basic block for that particular
3141 program execution.
3142
3143 To display the results you use the F<prof> utility.  The exact
3144 incantation depends on your operating system, "prof perl.Counts" in
3145 IRIX, and "prof -pixie -all -L. perl" in Tru64.
3146
3147 In IRIX the following prof options are available:
3148
3149 =over 4
3150
3151 =item -h
3152
3153 Reports the most heavily used lines in descending order of use.
3154 Useful for finding the hotspot lines.
3155
3156 =item -l
3157
3158 Groups lines by procedure, with procedures sorted in descending order of use.
3159 Within a procedure, lines are listed in source order.
3160 Useful for finding the hotspots of procedures.
3161
3162 =back
3163
3164 In Tru64 the following options are available:
3165
3166 =over 4
3167
3168 =item -p[rocedures]
3169
3170 Procedures sorted in descending order by the number of cycles executed
3171 in each procedure.  Useful for finding the hotspot procedures.
3172 (This is the default option.)
3173
3174 =item -h[eavy]
3175
3176 Lines sorted in descending order by the number of cycles executed in
3177 each line.  Useful for finding the hotspot lines.
3178
3179 =item -i[nvocations]
3180
3181 The called procedures are sorted in descending order by number of calls
3182 made to the procedures.  Useful for finding the most used procedures.
3183
3184 =item -l[ines]
3185
3186 Grouped by procedure, sorted by cycles executed per procedure.
3187 Useful for finding the hotspots of procedures.
3188
3189 =item -testcoverage
3190
3191 The compiler emitted code for these lines, but the code was unexecuted.
3192
3193 =item -z[ero]
3194
3195 Unexecuted procedures.
3196
3197 =back
3198
3199 For further information, see your system's manual pages for pixie and prof.
3200
3201 =head2 Miscellaneous tricks
3202
3203 =over 4
3204
3205 =item *
3206
3207 Those debugging perl with the DDD frontend over gdb may find the
3208 following useful:
3209
3210 You can extend the data conversion shortcuts menu, so for example you
3211 can display an SV's IV value with one click, without doing any typing.
3212 To do that simply edit ~/.ddd/init file and add after:
3213
3214   ! Display shortcuts.
3215   Ddd*gdbDisplayShortcuts: \
3216   /t ()   // Convert to Bin\n\
3217   /d ()   // Convert to Dec\n\
3218   /x ()   // Convert to Hex\n\
3219   /o ()   // Convert to Oct(\n\
3220
3221 the following two lines:
3222
3223   ((XPV*) (())->sv_any )->xpv_pv  // 2pvx\n\
3224   ((XPVIV*) (())->sv_any )->xiv_iv // 2ivx
3225
3226 so now you can do ivx and pvx lookups or you can plug there the
3227 sv_peek "conversion":
3228
3229   Perl_sv_peek(my_perl, (SV*)()) // sv_peek
3230
3231 (The my_perl is for threaded builds.)
3232 Just remember that every line, but the last one, should end with \n\
3233
3234 Alternatively edit the init file interactively via:
3235 3rd mouse button -> New Display -> Edit Menu
3236
3237 Note: you can define up to 20 conversion shortcuts in the gdb
3238 section.
3239
3240 =item *
3241
3242 If you see in a debugger a memory area mysteriously full of 0xABABABAB
3243 or 0xEFEFEFEF, you may be seeing the effect of the Poison() macros,
3244 see L<perlclib>.
3245
3246 =item *
3247
3248 Under ithreads the optree is read only. If you want to enforce this, to check
3249 for write accesses from buggy code, compile with C<-DPL_OP_SLAB_ALLOC> to
3250 enable the OP slab allocator and C<-DPERL_DEBUG_READONLY_OPS> to enable code
3251 that allocates op memory via C<mmap>, and sets it read-only at run time.
3252 Any write access to an op results in a C<SIGBUS> and abort.
3253
3254 This code is intended for development only, and may not be portable even to
3255 all Unix variants. Also, it is an 80% solution, in that it isn't able to make
3256 all ops read only. Specifically it
3257
3258 =over
3259
3260 =item 1
3261
3262 Only sets read-only on all slabs of ops at C<CHECK> time, hence ops allocated
3263 later via C<require> or C<eval> will be re-write
3264
3265 =item 2
3266
3267 Turns an entire slab of ops read-write if the refcount of any op in the slab
3268 needs to be decreased.
3269
3270 =item 3
3271
3272 Turns an entire slab of ops read-write if any op from the slab is freed.
3273
3274 =back
3275
3276 It's not possible to turn the slabs to read-only after an action requiring
3277 read-write access, as either can happen during op tree building time, so
3278 there may still be legitimate write access.
3279
3280 However, as an 80% solution it is still effective, as currently it catches
3281 a write access during the generation of F<Config.pm>, which means that we
3282 can't yet build F<perl> with this enabled.
3283
3284 =back
3285
3286
3287 =head1 CONCLUSION
3288
3289 We've had a brief look around the Perl source, how to maintain quality
3290 of the source code, an overview of the stages F<perl> goes through
3291 when it's running your code, how to use debuggers to poke at the Perl
3292 guts, and finally how to analyse the execution of Perl. We took a very
3293 simple problem and demonstrated how to solve it fully - with
3294 documentation, regression tests, and finally a patch for submission to
3295 p5p.  Finally, we talked about how to use external tools to debug and
3296 test Perl.
3297
3298 I'd now suggest you read over those references again, and then, as soon
3299 as possible, get your hands dirty. The best way to learn is by doing,
3300 so:
3301
3302 =over 3
3303
3304 =item *
3305
3306 Subscribe to perl5-porters, follow the patches and try and understand
3307 them; don't be afraid to ask if there's a portion you're not clear on -
3308 who knows, you may unearth a bug in the patch...
3309
3310 =item *
3311
3312 Keep up to date with the bleeding edge Perl distributions and get
3313 familiar with the changes. Try and get an idea of what areas people are
3314 working on and the changes they're making.
3315
3316 =item *
3317
3318 Do read the README associated with your operating system, e.g. README.aix
3319 on the IBM AIX OS. Don't hesitate to supply patches to that README if
3320 you find anything missing or changed over a new OS release.
3321
3322 =item *
3323
3324 Find an area of Perl that seems interesting to you, and see if you can
3325 work out how it works. Scan through the source, and step over it in the
3326 debugger. Play, poke, investigate, fiddle! You'll probably get to
3327 understand not just your chosen area but a much wider range of F<perl>'s
3328 activity as well, and probably sooner than you'd think.
3329
3330 =back
3331
3332 =over 3
3333
3334 =item I<The Road goes ever on and on, down from the door where it began.>
3335
3336 =back
3337
3338 If you can do these things, you've started on the long road to Perl porting.
3339 Thanks for wanting to help make Perl better - and happy hacking!
3340
3341 =head2 Metaphoric Quotations
3342
3343 If you recognized the quote about the Road above, you're in luck.
3344
3345 Most software projects begin each file with a literal description of each
3346 file's purpose.  Perl instead begins each with a literary allusion to that
3347 file's purpose.
3348
3349 Like chapters in many books, all top-level Perl source files (along with a
3350 few others here and there) begin with an epigramic inscription that alludes,
3351 indirectly and metaphorically, to the material you're about to read.
3352
3353 Quotations are taken from writings of J.R.R Tolkien pertaining to his
3354 Legendarium, almost always from I<The Lord of the Rings>.  Chapters and
3355 page numbers are given using the following editions:
3356
3357 =over 4
3358
3359 =item * 
3360
3361 I<The Hobbit>, by J.R.R. Tolkien.  The hardcover, 70th-anniversary
3362 edition of 2007 was used, published in the UK by Harper Collins Publishers
3363 and in the US by the Houghton Mifflin Company.
3364
3365 =item *
3366
3367 I<The Lord of the Rings>, by J.R.R. Tolkien.  The hardcover,
3368 50th-anniversary edition of 2004 was used, published in the UK by Harper
3369 Collins Publishers and in the US by the Houghton Mifflin Company.
3370
3371 =item *
3372
3373 I<The Lays of Beleriand>, by J.R.R. Tolkien and published posthumously by his
3374 son and literary executor, C.J.R. Tolkien, being the 3rd of the 12 volumes
3375 in Christopher's mammoth I<History of Middle Earth>.  Page numbers derive
3376 from the hardcover edition, first published in 1983 by George Allen &
3377 Unwin; no page numbers changed for the special 3-volume omnibus edition of
3378 2002 or the various trade-paper editions, all again now by Harper Collins
3379 or Houghton Mifflin.
3380
3381 =back
3382
3383 Other JRRT books fair game for quotes would thus include I<The Adventures of
3384 Tom Bombadil>, I<The Silmarillion>, I<Unfinished Tales>, and I<The Tale of
3385 the Children of Hurin>, all but the first posthumously assembled by CJRT.
3386 But I<The Lord of the Rings> itself is perfectly fine and probably best to
3387 quote from, provided you can find a suitable quote there.
3388
3389 So if you were to supply a new, complete, top-level source file to add to
3390 Perl, you should conform to this peculiar practice by yourself selecting an
3391 appropriate quotation from Tolkien, retaining the original spelling and
3392 punctuation and using the same format the rest of the quotes are in.
3393 Indirect and oblique is just fine; remember, it's a metaphor, so being meta
3394 is, after all, what it's for.
3395
3396 =head1 AUTHOR
3397
3398 This document was written by Nathan Torkington, and is maintained by
3399 the perl5-porters mailing list.
3400
3401 =head1 SEE ALSO
3402
3403 L<perlrepository>