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