This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Add a test.taintwarn makefile target,
[perl5.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 is the pumpking for the 5.8 release, and
42 Hugo van der Sanden will be the pumpking for the 5.10 release.
43
44 In addition, various people are pumpkings for different things.  For
45 instance, Andy Dougherty and Jarkko Hietaniemi share the I<Configure>
46 pumpkin.
47
48 Larry sees Perl development along the lines of the US government:
49 there's the Legislature (the porters), the Executive branch (the
50 pumpkings), and the Supreme Court (Larry).  The legislature can
51 discuss and submit patches to the executive branch all they like, but
52 the executive branch is free to veto them.  Rarely, the Supreme Court
53 will side with the executive branch over the legislature, or the
54 legislature over the executive branch.  Mostly, however, the
55 legislature and the executive branch are supposed to get along and
56 work out their differences without impeachment or court cases.
57
58 You might sometimes see reference to Rule 1 and Rule 2.  Larry's power
59 as Supreme Court is expressed in The Rules:
60
61 =over 4
62
63 =item 1
64
65 Larry is always by definition right about how Perl should behave.
66 This means he has final veto power on the core functionality.
67
68 =item 2
69
70 Larry is allowed to change his mind about any matter at a later date,
71 regardless of whether he previously invoked Rule 1.
72
73 =back
74
75 Got that?  Larry is always right, even when he was wrong.  It's rare
76 to see either Rule exercised, but they are often alluded to.
77
78 New features and extensions to the language are contentious, because
79 the criteria used by the pumpkings, Larry, and other porters to decide
80 which features should be implemented and incorporated are not codified
81 in a few small design goals as with some other languages.  Instead,
82 the heuristics are flexible and often difficult to fathom.  Here is
83 one person's list, roughly in decreasing order of importance, of
84 heuristics that new features have to be weighed against:
85
86 =over 4
87
88 =item Does concept match the general goals of Perl?
89
90 These haven't been written anywhere in stone, but one approximation
91 is:
92
93  1. Keep it fast, simple, and useful.
94  2. Keep features/concepts as orthogonal as possible.
95  3. No arbitrary limits (platforms, data sizes, cultures).
96  4. Keep it open and exciting to use/patch/advocate Perl everywhere.
97  5. Either assimilate new technologies, or build bridges to them.
98
99 =item Where is the implementation?
100
101 All the talk in the world is useless without an implementation.  In
102 almost every case, the person or people who argue for a new feature
103 will be expected to be the ones who implement it.  Porters capable
104 of coding new features have their own agendas, and are not available
105 to implement your (possibly good) idea.
106
107 =item Backwards compatibility
108
109 It's a cardinal sin to break existing Perl programs.  New warnings are
110 contentious--some say that a program that emits warnings is not
111 broken, while others say it is.  Adding keywords has the potential to
112 break programs, changing the meaning of existing token sequences or
113 functions might break programs.
114
115 =item Could it be a module instead?
116
117 Perl 5 has extension mechanisms, modules and XS, specifically to avoid
118 the need to keep changing the Perl interpreter.  You can write modules
119 that export functions, you can give those functions prototypes so they
120 can be called like built-in functions, you can even write XS code to
121 mess with the runtime data structures of the Perl interpreter if you
122 want to implement really complicated things.  If it can be done in a
123 module instead of in the core, it's highly unlikely to be added.
124
125 =item Is the feature generic enough?
126
127 Is this something that only the submitter wants added to the language,
128 or would it be broadly useful?  Sometimes, instead of adding a feature
129 with a tight focus, the porters might decide to wait until someone
130 implements the more generalized feature.  For instance, instead of
131 implementing a ``delayed evaluation'' feature, the porters are waiting
132 for a macro system that would permit delayed evaluation and much more.
133
134 =item Does it potentially introduce new bugs?
135
136 Radical rewrites of large chunks of the Perl interpreter have the
137 potential to introduce new bugs.  The smaller and more localized the
138 change, the better.
139
140 =item Does it preclude other desirable features?
141
142 A patch is likely to be rejected if it closes off future avenues of
143 development.  For instance, a patch that placed a true and final
144 interpretation on prototypes is likely to be rejected because there
145 are still options for the future of prototypes that haven't been
146 addressed.
147
148 =item Is the implementation robust?
149
150 Good patches (tight code, complete, correct) stand more chance of
151 going in.  Sloppy or incorrect patches might be placed on the back
152 burner until the pumpking has time to fix, or might be discarded
153 altogether without further notice.
154
155 =item Is the implementation generic enough to be portable?
156
157 The worst patches make use of a system-specific features.  It's highly
158 unlikely that nonportable additions to the Perl language will be
159 accepted.
160
161 =item Is the implementation tested?
162
163 Patches which change behaviour (fixing bugs or introducing new features)
164 must include regression tests to verify that everything works as expected.
165 Without tests provided by the original author, how can anyone else changing
166 perl in the future be sure that they haven't unwittingly broken the behaviour
167 the patch implements? And without tests, how can the patch's author be
168 confident that his/her hard work put into the patch won't be accidentally
169 thrown away by someone in the future?
170
171 =item Is there enough documentation?
172
173 Patches without documentation are probably ill-thought out or
174 incomplete.  Nothing can be added without documentation, so submitting
175 a patch for the appropriate manpages as well as the source code is
176 always a good idea.
177
178 =item Is there another way to do it?
179
180 Larry said ``Although the Perl Slogan is I<There's More Than One Way
181 to Do It>, I hesitate to make 10 ways to do something''.  This is a
182 tricky heuristic to navigate, though--one man's essential addition is
183 another man's pointless cruft.
184
185 =item Does it create too much work?
186
187 Work for the pumpking, work for Perl programmers, work for module
188 authors, ...  Perl is supposed to be easy.
189
190 =item Patches speak louder than words
191
192 Working code is always preferred to pie-in-the-sky ideas.  A patch to
193 add a feature stands a much higher chance of making it to the language
194 than does a random feature request, no matter how fervently argued the
195 request might be.  This ties into ``Will it be useful?'', as the fact
196 that someone took the time to make the patch demonstrates a strong
197 desire for the feature.
198
199 =back
200
201 If you're on the list, you might hear the word ``core'' bandied
202 around.  It refers to the standard distribution.  ``Hacking on the
203 core'' means you're changing the C source code to the Perl
204 interpreter.  ``A core module'' is one that ships with Perl.
205
206 =head2 Keeping in sync
207
208 The source code to the Perl interpreter, in its different versions, is
209 kept in a repository managed by a revision control system ( which is
210 currently the Perforce program, see http://perforce.com/ ).  The
211 pumpkings and a few others have access to the repository to check in
212 changes.  Periodically the pumpking for the development version of Perl
213 will release a new version, so the rest of the porters can see what's
214 changed.  The current state of the main trunk of repository, and patches
215 that describe the individual changes that have happened since the last
216 public release are available at this location:
217
218     http://public.activestate.com/gsar/APC/
219     ftp://ftp.linux.activestate.com/pub/staff/gsar/APC/
220
221 If you're looking for a particular change, or a change that affected
222 a particular set of files, you may find the B<Perl Repository Browser>
223 useful:
224
225     http://public.activestate.com/cgi-bin/perlbrowse
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 Keeping in sync with the most recent branch can be done in several ways,
243 but the most convenient and reliable way is using B<rsync>, available at
244 ftp://rsync.samba.org/pub/rsync/ .  (You can also get the most recent
245 branch by FTP.)
246
247 If you choose to keep in sync using rsync, there are two approaches
248 to doing so:
249
250 =over 4
251
252 =item rsync'ing the source tree
253
254 Presuming you are in the directory where your perl source resides
255 and you have rsync installed and available, you can `upgrade' to
256 the bleadperl using:
257
258  # rsync -avz rsync://ftp.linux.activestate.com/perl-current/ .
259
260 This takes care of updating every single item in the source tree to
261 the latest applied patch level, creating files that are new (to your
262 distribution) and setting date/time stamps of existing files to
263 reflect the bleadperl status.
264
265 Note that this will not delete any files that were in '.' before
266 the rsync. Once you are sure that the rsync is running correctly,
267 run it with the --delete and the --dry-run options like this:
268
269  # rsync -avz --delete --dry-run rsync://ftp.linux.activestate.com/perl-current/ .
270
271 This will I<simulate> an rsync run that also deletes files not
272 present in the bleadperl master copy. Observe the results from
273 this run closely. If you are sure that the actual run would delete
274 no files precious to you, you could remove the '--dry-run' option.
275
276 You can than check what patch was the latest that was applied by
277 looking in the file B<.patch>, which will show the number of the
278 latest patch.
279
280 If you have more than one machine to keep in sync, and not all of
281 them have access to the WAN (so you are not able to rsync all the
282 source trees to the real source), there are some ways to get around
283 this problem.
284
285 =over 4
286
287 =item Using rsync over the LAN
288
289 Set up a local rsync server which makes the rsynced source tree
290 available to the LAN and sync the other machines against this
291 directory.
292
293 From http://rsync.samba.org/README.html :
294
295    "Rsync uses rsh or ssh for communication. It does not need to be
296     setuid and requires no special privileges for installation.  It
297     does not require an inetd entry or a daemon.  You must, however,
298     have a working rsh or ssh system.  Using ssh is recommended for
299     its security features."
300
301 =item Using pushing over the NFS
302
303 Having the other systems mounted over the NFS, you can take an
304 active pushing approach by checking the just updated tree against
305 the other not-yet synced trees. An example would be
306
307   #!/usr/bin/perl -w
308
309   use strict;
310   use File::Copy;
311
312   my %MF = map {
313       m/(\S+)/;
314       $1 => [ (stat $1)[2, 7, 9] ];     # mode, size, mtime
315       } `cat MANIFEST`;
316
317   my %remote = map { $_ => "/$_/pro/3gl/CPAN/perl-5.7.1" } qw(host1 host2);
318
319   foreach my $host (keys %remote) {
320       unless (-d $remote{$host}) {
321           print STDERR "Cannot Xsync for host $host\n";
322           next;
323           }
324       foreach my $file (keys %MF) {
325           my $rfile = "$remote{$host}/$file";
326           my ($mode, $size, $mtime) = (stat $rfile)[2, 7, 9];
327           defined $size or ($mode, $size, $mtime) = (0, 0, 0);
328           $size == $MF{$file}[1] && $mtime == $MF{$file}[2] and next;
329           printf "%4s %-34s %8d %9d  %8d %9d\n",
330               $host, $file, $MF{$file}[1], $MF{$file}[2], $size, $mtime;
331           unlink $rfile;
332           copy ($file, $rfile);
333           utime time, $MF{$file}[2], $rfile;
334           chmod $MF{$file}[0], $rfile;
335           }
336       }
337
338 though this is not perfect. It could be improved with checking
339 file checksums before updating. Not all NFS systems support
340 reliable utime support (when used over the NFS).
341
342 =back
343
344 =item rsync'ing the patches
345
346 The source tree is maintained by the pumpking who applies patches to
347 the files in the tree. These patches are either created by the
348 pumpking himself using C<diff -c> after updating the file manually or
349 by applying patches sent in by posters on the perl5-porters list.
350 These patches are also saved and rsync'able, so you can apply them
351 yourself to the source files.
352
353 Presuming you are in a directory where your patches reside, you can
354 get them in sync with
355
356  # rsync -avz rsync://ftp.linux.activestate.com/perl-current-diffs/ .
357
358 This makes sure the latest available patch is downloaded to your
359 patch directory.
360
361 It's then up to you to apply these patches, using something like
362
363  # last=`ls -t *.gz | sed q`
364  # rsync -avz rsync://ftp.linux.activestate.com/perl-current-diffs/ .
365  # find . -name '*.gz' -newer $last -exec gzcat {} \; >blead.patch
366  # cd ../perl-current
367  # patch -p1 -N <../perl-current-diffs/blead.patch
368
369 or, since this is only a hint towards how it works, use CPAN-patchaperl
370 from Andreas K├Ânig to have better control over the patching process.
371
372 =back
373
374 =head2 Why rsync the source tree
375
376 =over 4
377
378 =item It's easier to rsync the source tree
379
380 Since you don't have to apply the patches yourself, you are sure all
381 files in the source tree are in the right state.
382
383 =item It's more reliable
384
385 While both the rsync-able source and patch areas are automatically
386 updated every few minutes, keep in mind that applying patches may
387 sometimes mean careful hand-holding, especially if your version of
388 the C<patch> program does not understand how to deal with new files,
389 files with 8-bit characters, or files without trailing newlines.
390
391 =back
392
393 =head2 Why rsync the patches
394
395 =over 4
396
397 =item It's easier to rsync the patches
398
399 If you have more than one machine that you want to keep in track with
400 bleadperl, it's easier to rsync the patches only once and then apply
401 them to all the source trees on the different machines.
402
403 In case you try to keep in pace on 5 different machines, for which
404 only one of them has access to the WAN, rsync'ing all the source
405 trees should than be done 5 times over the NFS. Having
406 rsync'ed the patches only once, I can apply them to all the source
407 trees automatically. Need you say more ;-)
408
409 =item It's a good reference
410
411 If you do not only like to have the most recent development branch,
412 but also like to B<fix> bugs, or extend features, you want to dive
413 into the sources. If you are a seasoned perl core diver, you don't
414 need no manuals, tips, roadmaps, perlguts.pod or other aids to find
415 your way around. But if you are a starter, the patches may help you
416 in finding where you should start and how to change the bits that
417 bug you.
418
419 The file B<Changes> is updated on occasions the pumpking sees as his
420 own little sync points. On those occasions, he releases a tar-ball of
421 the current source tree (i.e. perl@7582.tar.gz), which will be an
422 excellent point to start with when choosing to use the 'rsync the
423 patches' scheme. Starting with perl@7582, which means a set of source
424 files on which the latest applied patch is number 7582, you apply all
425 succeeding patches available from then on (7583, 7584, ...).
426
427 You can use the patches later as a kind of search archive.
428
429 =over 4
430
431 =item Finding a start point
432
433 If you want to fix/change the behaviour of function/feature Foo, just
434 scan the patches for patches that mention Foo either in the subject,
435 the comments, or the body of the fix. A good chance the patch shows
436 you the files that are affected by that patch which are very likely
437 to be the starting point of your journey into the guts of perl.
438
439 =item Finding how to fix a bug
440
441 If you've found I<where> the function/feature Foo misbehaves, but you
442 don't know how to fix it (but you do know the change you want to
443 make), you can, again, peruse the patches for similar changes and
444 look how others apply the fix.
445
446 =item Finding the source of misbehaviour
447
448 When you keep in sync with bleadperl, the pumpking would love to
449 I<see> that the community efforts really work. So after each of his
450 sync points, you are to 'make test' to check if everything is still
451 in working order. If it is, you do 'make ok', which will send an OK
452 report to perlbug@perl.org. (If you do not have access to a mailer
453 from the system you just finished successfully 'make test', you can
454 do 'make okfile', which creates the file C<perl.ok>, which you can
455 than take to your favourite mailer and mail yourself).
456
457 But of course, as always, things will not always lead to a success
458 path, and one or more test do not pass the 'make test'. Before
459 sending in a bug report (using 'make nok' or 'make nokfile'), check
460 the mailing list if someone else has reported the bug already and if
461 so, confirm it by replying to that message. If not, you might want to
462 trace the source of that misbehaviour B<before> sending in the bug,
463 which will help all the other porters in finding the solution.
464
465 Here the saved patches come in very handy. You can check the list of
466 patches to see which patch changed what file and what change caused
467 the misbehaviour. If you note that in the bug report, it saves the
468 one trying to solve it, looking for that point.
469
470 =back
471
472 If searching the patches is too bothersome, you might consider using
473 perl's bugtron to find more information about discussions and
474 ramblings on posted bugs.
475
476 If you want to get the best of both worlds, rsync both the source
477 tree for convenience, reliability and ease and rsync the patches
478 for reference.
479
480 =back
481
482
483 =head2 Perlbug administration
484
485 There is a single remote administrative interface for modifying bug status, 
486 category, open issues etc. using the B<RT> I<bugtracker> system, maintained
487 by I<Robert Spier>.  Become an administrator, and close any bugs you can get 
488 your sticky mitts on:
489
490         http://rt.perl.org
491
492 The bugtracker mechanism for B<perl5> bugs in particular is at:
493
494         http://bugs6.perl.org/perlbug
495
496 To email the bug system administrators:
497
498         "perlbug-admin" <perlbug-admin@perl.org>
499
500
501 =head2 Submitting patches
502
503 Always submit patches to I<perl5-porters@perl.org>.  If you're
504 patching a core module and there's an author listed, send the author a
505 copy (see L<Patching a core module>).  This lets other porters review
506 your patch, which catches a surprising number of errors in patches.
507 Either use the diff program (available in source code form from
508 ftp://ftp.gnu.org/pub/gnu/ , or use Johan Vromans' I<makepatch>
509 (available from I<CPAN/authors/id/JV/>).  Unified diffs are preferred,
510 but context diffs are accepted.  Do not send RCS-style diffs or diffs
511 without context lines.  More information is given in the
512 I<Porting/patching.pod> file in the Perl source distribution.  Please
513 patch against the latest B<development> version (e.g., if you're
514 fixing a bug in the 5.005 track, patch against the latest 5.005_5x
515 version).  Only patches that survive the heat of the development
516 branch get applied to maintenance versions.
517
518 Your patch should update the documentation and test suite.  See
519 L<Writing a test>.
520
521 To report a bug in Perl, use the program I<perlbug> which comes with
522 Perl (if you can't get Perl to work, send mail to the address
523 I<perlbug@perl.org> or I<perlbug@perl.com>).  Reporting bugs through
524 I<perlbug> feeds into the automated bug-tracking system, access to
525 which is provided through the web at http://bugs.perl.org/ .  It
526 often pays to check the archives of the perl5-porters mailing list to
527 see whether the bug you're reporting has been reported before, and if
528 so whether it was considered a bug.  See above for the location of
529 the searchable archives.
530
531 The CPAN testers ( http://testers.cpan.org/ ) are a group of
532 volunteers who test CPAN modules on a variety of platforms.  Perl
533 Smokers ( http://archives.develooper.com/daily-build@perl.org/ )
534 automatically tests Perl source releases on platforms with various
535 configurations.  Both efforts welcome volunteers.
536
537 It's a good idea to read and lurk for a while before chipping in.
538 That way you'll get to see the dynamic of the conversations, learn the
539 personalities of the players, and hopefully be better prepared to make
540 a useful contribution when do you speak up.
541
542 If after all this you still think you want to join the perl5-porters
543 mailing list, send mail to I<perl5-porters-subscribe@perl.org>.  To
544 unsubscribe, send mail to I<perl5-porters-unsubscribe@perl.org>.
545
546 To hack on the Perl guts, you'll need to read the following things:
547
548 =over 3
549
550 =item L<perlguts>
551
552 This is of paramount importance, since it's the documentation of what
553 goes where in the Perl source. Read it over a couple of times and it
554 might start to make sense - don't worry if it doesn't yet, because the
555 best way to study it is to read it in conjunction with poking at Perl
556 source, and we'll do that later on.
557
558 You might also want to look at Gisle Aas's illustrated perlguts -
559 there's no guarantee that this will be absolutely up-to-date with the
560 latest documentation in the Perl core, but the fundamentals will be
561 right. ( http://gisle.aas.no/perl/illguts/ )
562
563 =item L<perlxstut> and L<perlxs>
564
565 A working knowledge of XSUB programming is incredibly useful for core
566 hacking; XSUBs use techniques drawn from the PP code, the portion of the
567 guts that actually executes a Perl program. It's a lot gentler to learn
568 those techniques from simple examples and explanation than from the core
569 itself.
570
571 =item L<perlapi>
572
573 The documentation for the Perl API explains what some of the internal
574 functions do, as well as the many macros used in the source.
575
576 =item F<Porting/pumpkin.pod>
577
578 This is a collection of words of wisdom for a Perl porter; some of it is
579 only useful to the pumpkin holder, but most of it applies to anyone
580 wanting to go about Perl development.
581
582 =item The perl5-porters FAQ
583
584 This should be available from http://simon-cozens.org/writings/p5p-faq ;
585 alternatively, you can get the FAQ emailed to you by sending mail to
586 C<perl5-porters-faq@perl.org>. It contains hints on reading perl5-porters,
587 information on how perl5-porters works and how Perl development in general
588 works.
589
590 =back
591
592 =head2 Finding Your Way Around
593
594 Perl maintenance can be split into a number of areas, and certain people
595 (pumpkins) will have responsibility for each area. These areas sometimes
596 correspond to files or directories in the source kit. Among the areas are:
597
598 =over 3
599
600 =item Core modules
601
602 Modules shipped as part of the Perl core live in the F<lib/> and F<ext/>
603 subdirectories: F<lib/> is for the pure-Perl modules, and F<ext/>
604 contains the core XS modules.
605
606 =item Tests
607
608 There are tests for nearly all the modules, built-ins and major bits
609 of functionality.  Test files all have a .t suffix.  Module tests live
610 in the F<lib/> and F<ext/> directories next to the module being
611 tested.  Others live in F<t/>.  See L<Writing a test>
612
613 =item Documentation
614
615 Documentation maintenance includes looking after everything in the
616 F<pod/> directory, (as well as contributing new documentation) and
617 the documentation to the modules in core.
618
619 =item Configure
620
621 The configure process is the way we make Perl portable across the
622 myriad of operating systems it supports. Responsibility for the
623 configure, build and installation process, as well as the overall
624 portability of the core code rests with the configure pumpkin - others
625 help out with individual operating systems.
626
627 The files involved are the operating system directories, (F<win32/>,
628 F<os2/>, F<vms/> and so on) the shell scripts which generate F<config.h>
629 and F<Makefile>, as well as the metaconfig files which generate
630 F<Configure>. (metaconfig isn't included in the core distribution.)
631
632 =item Interpreter
633
634 And of course, there's the core of the Perl interpreter itself. Let's
635 have a look at that in a little more detail.
636
637 =back
638
639 Before we leave looking at the layout, though, don't forget that
640 F<MANIFEST> contains not only the file names in the Perl distribution,
641 but short descriptions of what's in them, too. For an overview of the
642 important files, try this:
643
644     perl -lne 'print if /^[^\/]+\.[ch]\s+/' MANIFEST
645
646 =head2 Elements of the interpreter
647
648 The work of the interpreter has two main stages: compiling the code
649 into the internal representation, or bytecode, and then executing it.
650 L<perlguts/Compiled code> explains exactly how the compilation stage
651 happens.
652
653 Here is a short breakdown of perl's operation:
654
655 =over 3
656
657 =item Startup
658
659 The action begins in F<perlmain.c>. (or F<miniperlmain.c> for miniperl)
660 This is very high-level code, enough to fit on a single screen, and it
661 resembles the code found in L<perlembed>; most of the real action takes
662 place in F<perl.c>
663
664 First, F<perlmain.c> allocates some memory and constructs a Perl
665 interpreter:
666
667     1 PERL_SYS_INIT3(&argc,&argv,&env);
668     2
669     3 if (!PL_do_undump) {
670     4     my_perl = perl_alloc();
671     5     if (!my_perl)
672     6         exit(1);
673     7     perl_construct(my_perl);
674     8     PL_perl_destruct_level = 0;
675     9 }
676
677 Line 1 is a macro, and its definition is dependent on your operating
678 system. Line 3 references C<PL_do_undump>, a global variable - all
679 global variables in Perl start with C<PL_>. This tells you whether the
680 current running program was created with the C<-u> flag to perl and then
681 F<undump>, which means it's going to be false in any sane context.
682
683 Line 4 calls a function in F<perl.c> to allocate memory for a Perl
684 interpreter. It's quite a simple function, and the guts of it looks like
685 this:
686
687     my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
688
689 Here you see an example of Perl's system abstraction, which we'll see
690 later: C<PerlMem_malloc> is either your system's C<malloc>, or Perl's
691 own C<malloc> as defined in F<malloc.c> if you selected that option at
692 configure time.
693
694 Next, in line 7, we construct the interpreter; this sets up all the
695 special variables that Perl needs, the stacks, and so on.
696
697 Now we pass Perl the command line options, and tell it to go:
698
699     exitstatus = perl_parse(my_perl, xs_init, argc, argv, (char **)NULL);
700     if (!exitstatus) {
701         exitstatus = perl_run(my_perl);
702     }
703
704
705 C<perl_parse> is actually a wrapper around C<S_parse_body>, as defined
706 in F<perl.c>, which processes the command line options, sets up any
707 statically linked XS modules, opens the program and calls C<yyparse> to
708 parse it.
709
710 =item Parsing
711
712 The aim of this stage is to take the Perl source, and turn it into an op
713 tree. We'll see what one of those looks like later. Strictly speaking,
714 there's three things going on here.
715
716 C<yyparse>, the parser, lives in F<perly.c>, although you're better off
717 reading the original YACC input in F<perly.y>. (Yes, Virginia, there
718 B<is> a YACC grammar for Perl!) The job of the parser is to take your
719 code and `understand' it, splitting it into sentences, deciding which
720 operands go with which operators and so on.
721
722 The parser is nobly assisted by the lexer, which chunks up your input
723 into tokens, and decides what type of thing each token is: a variable
724 name, an operator, a bareword, a subroutine, a core function, and so on.
725 The main point of entry to the lexer is C<yylex>, and that and its
726 associated routines can be found in F<toke.c>. Perl isn't much like
727 other computer languages; it's highly context sensitive at times, it can
728 be tricky to work out what sort of token something is, or where a token
729 ends. As such, there's a lot of interplay between the tokeniser and the
730 parser, which can get pretty frightening if you're not used to it.
731
732 As the parser understands a Perl program, it builds up a tree of
733 operations for the interpreter to perform during execution. The routines
734 which construct and link together the various operations are to be found
735 in F<op.c>, and will be examined later.
736
737 =item Optimization
738
739 Now the parsing stage is complete, and the finished tree represents
740 the operations that the Perl interpreter needs to perform to execute our
741 program. Next, Perl does a dry run over the tree looking for
742 optimisations: constant expressions such as C<3 + 4> will be computed
743 now, and the optimizer will also see if any multiple operations can be
744 replaced with a single one. For instance, to fetch the variable C<$foo>,
745 instead of grabbing the glob C<*foo> and looking at the scalar
746 component, the optimizer fiddles the op tree to use a function which
747 directly looks up the scalar in question. The main optimizer is C<peep>
748 in F<op.c>, and many ops have their own optimizing functions.
749
750 =item Running
751
752 Now we're finally ready to go: we have compiled Perl byte code, and all
753 that's left to do is run it. The actual execution is done by the
754 C<runops_standard> function in F<run.c>; more specifically, it's done by
755 these three innocent looking lines:
756
757     while ((PL_op = CALL_FPTR(PL_op->op_ppaddr)(aTHX))) {
758         PERL_ASYNC_CHECK();
759     }
760
761 You may be more comfortable with the Perl version of that:
762
763     PERL_ASYNC_CHECK() while $Perl::op = &{$Perl::op->{function}};
764
765 Well, maybe not. Anyway, each op contains a function pointer, which
766 stipulates the function which will actually carry out the operation.
767 This function will return the next op in the sequence - this allows for
768 things like C<if> which choose the next op dynamically at run time.
769 The C<PERL_ASYNC_CHECK> makes sure that things like signals interrupt
770 execution if required.
771
772 The actual functions called are known as PP code, and they're spread
773 between four files: F<pp_hot.c> contains the `hot' code, which is most
774 often used and highly optimized, F<pp_sys.c> contains all the
775 system-specific functions, F<pp_ctl.c> contains the functions which
776 implement control structures (C<if>, C<while> and the like) and F<pp.c>
777 contains everything else. These are, if you like, the C code for Perl's
778 built-in functions and operators.
779
780 =back
781
782 =head2 Internal Variable Types
783
784 You should by now have had a look at L<perlguts>, which tells you about
785 Perl's internal variable types: SVs, HVs, AVs and the rest. If not, do
786 that now.
787
788 These variables are used not only to represent Perl-space variables, but
789 also any constants in the code, as well as some structures completely
790 internal to Perl. The symbol table, for instance, is an ordinary Perl
791 hash. Your code is represented by an SV as it's read into the parser;
792 any program files you call are opened via ordinary Perl filehandles, and
793 so on.
794
795 The core L<Devel::Peek|Devel::Peek> module lets us examine SVs from a
796 Perl program. Let's see, for instance, how Perl treats the constant
797 C<"hello">.
798
799       % perl -MDevel::Peek -e 'Dump("hello")'
800     1 SV = PV(0xa041450) at 0xa04ecbc
801     2   REFCNT = 1
802     3   FLAGS = (POK,READONLY,pPOK)
803     4   PV = 0xa0484e0 "hello"\0
804     5   CUR = 5
805     6   LEN = 6
806
807 Reading C<Devel::Peek> output takes a bit of practise, so let's go
808 through it line by line.
809
810 Line 1 tells us we're looking at an SV which lives at C<0xa04ecbc> in
811 memory. SVs themselves are very simple structures, but they contain a
812 pointer to a more complex structure. In this case, it's a PV, a
813 structure which holds a string value, at location C<0xa041450>.  Line 2
814 is the reference count; there are no other references to this data, so
815 it's 1.
816
817 Line 3 are the flags for this SV - it's OK to use it as a PV, it's a
818 read-only SV (because it's a constant) and the data is a PV internally.
819 Next we've got the contents of the string, starting at location
820 C<0xa0484e0>.
821
822 Line 5 gives us the current length of the string - note that this does
823 B<not> include the null terminator. Line 6 is not the length of the
824 string, but the length of the currently allocated buffer; as the string
825 grows, Perl automatically extends the available storage via a routine
826 called C<SvGROW>.
827
828 You can get at any of these quantities from C very easily; just add
829 C<Sv> to the name of the field shown in the snippet, and you've got a
830 macro which will return the value: C<SvCUR(sv)> returns the current
831 length of the string, C<SvREFCOUNT(sv)> returns the reference count,
832 C<SvPV(sv, len)> returns the string itself with its length, and so on.
833 More macros to manipulate these properties can be found in L<perlguts>.
834
835 Let's take an example of manipulating a PV, from C<sv_catpvn>, in F<sv.c>
836
837      1  void
838      2  Perl_sv_catpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
839      3  {
840      4      STRLEN tlen;
841      5      char *junk;
842
843      6      junk = SvPV_force(sv, tlen);
844      7      SvGROW(sv, tlen + len + 1);
845      8      if (ptr == junk)
846      9          ptr = SvPVX(sv);
847     10      Move(ptr,SvPVX(sv)+tlen,len,char);
848     11      SvCUR(sv) += len;
849     12      *SvEND(sv) = '\0';
850     13      (void)SvPOK_only_UTF8(sv);          /* validate pointer */
851     14      SvTAINT(sv);
852     15  }
853
854 This is a function which adds a string, C<ptr>, of length C<len> onto
855 the end of the PV stored in C<sv>. The first thing we do in line 6 is
856 make sure that the SV B<has> a valid PV, by calling the C<SvPV_force>
857 macro to force a PV. As a side effect, C<tlen> gets set to the current
858 value of the PV, and the PV itself is returned to C<junk>.
859
860 In line 7, we make sure that the SV will have enough room to accommodate
861 the old string, the new string and the null terminator. If C<LEN> isn't
862 big enough, C<SvGROW> will reallocate space for us.
863
864 Now, if C<junk> is the same as the string we're trying to add, we can
865 grab the string directly from the SV; C<SvPVX> is the address of the PV
866 in the SV.
867
868 Line 10 does the actual catenation: the C<Move> macro moves a chunk of
869 memory around: we move the string C<ptr> to the end of the PV - that's
870 the start of the PV plus its current length. We're moving C<len> bytes
871 of type C<char>. After doing so, we need to tell Perl we've extended the
872 string, by altering C<CUR> to reflect the new length. C<SvEND> is a
873 macro which gives us the end of the string, so that needs to be a
874 C<"\0">.
875
876 Line 13 manipulates the flags; since we've changed the PV, any IV or NV
877 values will no longer be valid: if we have C<$a=10; $a.="6";> we don't
878 want to use the old IV of 10. C<SvPOK_only_utf8> is a special UTF-8-aware
879 version of C<SvPOK_only>, a macro which turns off the IOK and NOK flags
880 and turns on POK. The final C<SvTAINT> is a macro which launders tainted
881 data if taint mode is turned on.
882
883 AVs and HVs are more complicated, but SVs are by far the most common
884 variable type being thrown around. Having seen something of how we
885 manipulate these, let's go on and look at how the op tree is
886 constructed.
887
888 =head2 Op Trees
889
890 First, what is the op tree, anyway? The op tree is the parsed
891 representation of your program, as we saw in our section on parsing, and
892 it's the sequence of operations that Perl goes through to execute your
893 program, as we saw in L</Running>.
894
895 An op is a fundamental operation that Perl can perform: all the built-in
896 functions and operators are ops, and there are a series of ops which
897 deal with concepts the interpreter needs internally - entering and
898 leaving a block, ending a statement, fetching a variable, and so on.
899
900 The op tree is connected in two ways: you can imagine that there are two
901 "routes" through it, two orders in which you can traverse the tree.
902 First, parse order reflects how the parser understood the code, and
903 secondly, execution order tells perl what order to perform the
904 operations in.
905
906 The easiest way to examine the op tree is to stop Perl after it has
907 finished parsing, and get it to dump out the tree. This is exactly what
908 the compiler backends L<B::Terse|B::Terse>, L<B::Concise|B::Concise>
909 and L<B::Debug|B::Debug> do.
910
911 Let's have a look at how Perl sees C<$a = $b + $c>:
912
913      % perl -MO=Terse -e '$a=$b+$c'
914      1  LISTOP (0x8179888) leave
915      2      OP (0x81798b0) enter
916      3      COP (0x8179850) nextstate
917      4      BINOP (0x8179828) sassign
918      5          BINOP (0x8179800) add [1]
919      6              UNOP (0x81796e0) null [15]
920      7                  SVOP (0x80fafe0) gvsv  GV (0x80fa4cc) *b
921      8              UNOP (0x81797e0) null [15]
922      9                  SVOP (0x8179700) gvsv  GV (0x80efeb0) *c
923     10          UNOP (0x816b4f0) null [15]
924     11              SVOP (0x816dcf0) gvsv  GV (0x80fa460) *a
925
926 Let's start in the middle, at line 4. This is a BINOP, a binary
927 operator, which is at location C<0x8179828>. The specific operator in
928 question is C<sassign> - scalar assignment - and you can find the code
929 which implements it in the function C<pp_sassign> in F<pp_hot.c>. As a
930 binary operator, it has two children: the add operator, providing the
931 result of C<$b+$c>, is uppermost on line 5, and the left hand side is on
932 line 10.
933
934 Line 10 is the null op: this does exactly nothing. What is that doing
935 there? If you see the null op, it's a sign that something has been
936 optimized away after parsing. As we mentioned in L</Optimization>,
937 the optimization stage sometimes converts two operations into one, for
938 example when fetching a scalar variable. When this happens, instead of
939 rewriting the op tree and cleaning up the dangling pointers, it's easier
940 just to replace the redundant operation with the null op. Originally,
941 the tree would have looked like this:
942
943     10          SVOP (0x816b4f0) rv2sv [15]
944     11              SVOP (0x816dcf0) gv  GV (0x80fa460) *a
945
946 That is, fetch the C<a> entry from the main symbol table, and then look
947 at the scalar component of it: C<gvsv> (C<pp_gvsv> into F<pp_hot.c>)
948 happens to do both these things.
949
950 The right hand side, starting at line 5 is similar to what we've just
951 seen: we have the C<add> op (C<pp_add> also in F<pp_hot.c>) add together
952 two C<gvsv>s.
953
954 Now, what's this about?
955
956      1  LISTOP (0x8179888) leave
957      2      OP (0x81798b0) enter
958      3      COP (0x8179850) nextstate
959
960 C<enter> and C<leave> are scoping ops, and their job is to perform any
961 housekeeping every time you enter and leave a block: lexical variables
962 are tidied up, unreferenced variables are destroyed, and so on. Every
963 program will have those first three lines: C<leave> is a list, and its
964 children are all the statements in the block. Statements are delimited
965 by C<nextstate>, so a block is a collection of C<nextstate> ops, with
966 the ops to be performed for each statement being the children of
967 C<nextstate>. C<enter> is a single op which functions as a marker.
968
969 That's how Perl parsed the program, from top to bottom:
970
971                         Program
972                            |
973                        Statement
974                            |
975                            =
976                           / \
977                          /   \
978                         $a   +
979                             / \
980                           $b   $c
981
982 However, it's impossible to B<perform> the operations in this order:
983 you have to find the values of C<$b> and C<$c> before you add them
984 together, for instance. So, the other thread that runs through the op
985 tree is the execution order: each op has a field C<op_next> which points
986 to the next op to be run, so following these pointers tells us how perl
987 executes the code. We can traverse the tree in this order using
988 the C<exec> option to C<B::Terse>:
989
990      % perl -MO=Terse,exec -e '$a=$b+$c'
991      1  OP (0x8179928) enter
992      2  COP (0x81798c8) nextstate
993      3  SVOP (0x81796c8) gvsv  GV (0x80fa4d4) *b
994      4  SVOP (0x8179798) gvsv  GV (0x80efeb0) *c
995      5  BINOP (0x8179878) add [1]
996      6  SVOP (0x816dd38) gvsv  GV (0x80fa468) *a
997      7  BINOP (0x81798a0) sassign
998      8  LISTOP (0x8179900) leave
999
1000 This probably makes more sense for a human: enter a block, start a
1001 statement. Get the values of C<$b> and C<$c>, and add them together.
1002 Find C<$a>, and assign one to the other. Then leave.
1003
1004 The way Perl builds up these op trees in the parsing process can be
1005 unravelled by examining F<perly.y>, the YACC grammar. Let's take the
1006 piece we need to construct the tree for C<$a = $b + $c>
1007
1008     1 term    :   term ASSIGNOP term
1009     2                { $$ = newASSIGNOP(OPf_STACKED, $1, $2, $3); }
1010     3         |   term ADDOP term
1011     4                { $$ = newBINOP($2, 0, scalar($1), scalar($3)); }
1012
1013 If you're not used to reading BNF grammars, this is how it works: You're
1014 fed certain things by the tokeniser, which generally end up in upper
1015 case. Here, C<ADDOP>, is provided when the tokeniser sees C<+> in your
1016 code. C<ASSIGNOP> is provided when C<=> is used for assigning. These are
1017 `terminal symbols', because you can't get any simpler than them.
1018
1019 The grammar, lines one and three of the snippet above, tells you how to
1020 build up more complex forms. These complex forms, `non-terminal symbols'
1021 are generally placed in lower case. C<term> here is a non-terminal
1022 symbol, representing a single expression.
1023
1024 The grammar gives you the following rule: you can make the thing on the
1025 left of the colon if you see all the things on the right in sequence.
1026 This is called a "reduction", and the aim of parsing is to completely
1027 reduce the input. There are several different ways you can perform a
1028 reduction, separated by vertical bars: so, C<term> followed by C<=>
1029 followed by C<term> makes a C<term>, and C<term> followed by C<+>
1030 followed by C<term> can also make a C<term>.
1031
1032 So, if you see two terms with an C<=> or C<+>, between them, you can
1033 turn them into a single expression. When you do this, you execute the
1034 code in the block on the next line: if you see C<=>, you'll do the code
1035 in line 2. If you see C<+>, you'll do the code in line 4. It's this code
1036 which contributes to the op tree.
1037
1038             |   term ADDOP term
1039             { $$ = newBINOP($2, 0, scalar($1), scalar($3)); }
1040
1041 What this does is creates a new binary op, and feeds it a number of
1042 variables. The variables refer to the tokens: C<$1> is the first token in
1043 the input, C<$2> the second, and so on - think regular expression
1044 backreferences. C<$$> is the op returned from this reduction. So, we
1045 call C<newBINOP> to create a new binary operator. The first parameter to
1046 C<newBINOP>, a function in F<op.c>, is the op type. It's an addition
1047 operator, so we want the type to be C<ADDOP>. We could specify this
1048 directly, but it's right there as the second token in the input, so we
1049 use C<$2>. The second parameter is the op's flags: 0 means `nothing
1050 special'. Then the things to add: the left and right hand side of our
1051 expression, in scalar context.
1052
1053 =head2 Stacks
1054
1055 When perl executes something like C<addop>, how does it pass on its
1056 results to the next op? The answer is, through the use of stacks. Perl
1057 has a number of stacks to store things it's currently working on, and
1058 we'll look at the three most important ones here.
1059
1060 =over 3
1061
1062 =item Argument stack
1063
1064 Arguments are passed to PP code and returned from PP code using the
1065 argument stack, C<ST>. The typical way to handle arguments is to pop
1066 them off the stack, deal with them how you wish, and then push the result
1067 back onto the stack. This is how, for instance, the cosine operator
1068 works:
1069
1070       NV value;
1071       value = POPn;
1072       value = Perl_cos(value);
1073       XPUSHn(value);
1074
1075 We'll see a more tricky example of this when we consider Perl's macros
1076 below. C<POPn> gives you the NV (floating point value) of the top SV on
1077 the stack: the C<$x> in C<cos($x)>. Then we compute the cosine, and push
1078 the result back as an NV. The C<X> in C<XPUSHn> means that the stack
1079 should be extended if necessary - it can't be necessary here, because we
1080 know there's room for one more item on the stack, since we've just
1081 removed one! The C<XPUSH*> macros at least guarantee safety.
1082
1083 Alternatively, you can fiddle with the stack directly: C<SP> gives you
1084 the first element in your portion of the stack, and C<TOP*> gives you
1085 the top SV/IV/NV/etc. on the stack. So, for instance, to do unary
1086 negation of an integer:
1087
1088      SETi(-TOPi);
1089
1090 Just set the integer value of the top stack entry to its negation.
1091
1092 Argument stack manipulation in the core is exactly the same as it is in
1093 XSUBs - see L<perlxstut>, L<perlxs> and L<perlguts> for a longer
1094 description of the macros used in stack manipulation.
1095
1096 =item Mark stack
1097
1098 I say `your portion of the stack' above because PP code doesn't
1099 necessarily get the whole stack to itself: if your function calls
1100 another function, you'll only want to expose the arguments aimed for the
1101 called function, and not (necessarily) let it get at your own data. The
1102 way we do this is to have a `virtual' bottom-of-stack, exposed to each
1103 function. The mark stack keeps bookmarks to locations in the argument
1104 stack usable by each function. For instance, when dealing with a tied
1105 variable, (internally, something with `P' magic) Perl has to call
1106 methods for accesses to the tied variables. However, we need to separate
1107 the arguments exposed to the method to the argument exposed to the
1108 original function - the store or fetch or whatever it may be. Here's how
1109 the tied C<push> is implemented; see C<av_push> in F<av.c>:
1110
1111      1  PUSHMARK(SP);
1112      2  EXTEND(SP,2);
1113      3  PUSHs(SvTIED_obj((SV*)av, mg));
1114      4  PUSHs(val);
1115      5  PUTBACK;
1116      6  ENTER;
1117      7  call_method("PUSH", G_SCALAR|G_DISCARD);
1118      8  LEAVE;
1119      9  POPSTACK;
1120
1121 The lines which concern the mark stack are the first, fifth and last
1122 lines: they save away, restore and remove the current position of the
1123 argument stack. 
1124
1125 Let's examine the whole implementation, for practice:
1126
1127      1  PUSHMARK(SP);
1128
1129 Push the current state of the stack pointer onto the mark stack. This is
1130 so that when we've finished adding items to the argument stack, Perl
1131 knows how many things we've added recently.
1132
1133      2  EXTEND(SP,2);
1134      3  PUSHs(SvTIED_obj((SV*)av, mg));
1135      4  PUSHs(val);
1136
1137 We're going to add two more items onto the argument stack: when you have
1138 a tied array, the C<PUSH> subroutine receives the object and the value
1139 to be pushed, and that's exactly what we have here - the tied object,
1140 retrieved with C<SvTIED_obj>, and the value, the SV C<val>.
1141
1142      5  PUTBACK;
1143
1144 Next we tell Perl to make the change to the global stack pointer: C<dSP>
1145 only gave us a local copy, not a reference to the global.
1146
1147      6  ENTER;
1148      7  call_method("PUSH", G_SCALAR|G_DISCARD);
1149      8  LEAVE;
1150
1151 C<ENTER> and C<LEAVE> localise a block of code - they make sure that all
1152 variables are tidied up, everything that has been localised gets
1153 its previous value returned, and so on. Think of them as the C<{> and
1154 C<}> of a Perl block.
1155
1156 To actually do the magic method call, we have to call a subroutine in
1157 Perl space: C<call_method> takes care of that, and it's described in
1158 L<perlcall>. We call the C<PUSH> method in scalar context, and we're
1159 going to discard its return value.
1160
1161      9  POPSTACK;
1162
1163 Finally, we remove the value we placed on the mark stack, since we
1164 don't need it any more.
1165
1166 =item Save stack
1167
1168 C doesn't have a concept of local scope, so perl provides one. We've
1169 seen that C<ENTER> and C<LEAVE> are used as scoping braces; the save
1170 stack implements the C equivalent of, for example:
1171
1172     {
1173         local $foo = 42;
1174         ...
1175     }
1176
1177 See L<perlguts/Localising Changes> for how to use the save stack.
1178
1179 =back
1180
1181 =head2 Millions of Macros
1182
1183 One thing you'll notice about the Perl source is that it's full of
1184 macros. Some have called the pervasive use of macros the hardest thing
1185 to understand, others find it adds to clarity. Let's take an example,
1186 the code which implements the addition operator:
1187
1188    1  PP(pp_add)
1189    2  {
1190    3      dSP; dATARGET; tryAMAGICbin(add,opASSIGN);
1191    4      {
1192    5        dPOPTOPnnrl_ul;
1193    6        SETn( left + right );
1194    7        RETURN;
1195    8      }
1196    9  }
1197
1198 Every line here (apart from the braces, of course) contains a macro. The
1199 first line sets up the function declaration as Perl expects for PP code;
1200 line 3 sets up variable declarations for the argument stack and the
1201 target, the return value of the operation. Finally, it tries to see if
1202 the addition operation is overloaded; if so, the appropriate subroutine
1203 is called.
1204
1205 Line 5 is another variable declaration - all variable declarations start
1206 with C<d> - which pops from the top of the argument stack two NVs (hence
1207 C<nn>) and puts them into the variables C<right> and C<left>, hence the
1208 C<rl>. These are the two operands to the addition operator. Next, we
1209 call C<SETn> to set the NV of the return value to the result of adding
1210 the two values. This done, we return - the C<RETURN> macro makes sure
1211 that our return value is properly handled, and we pass the next operator
1212 to run back to the main run loop.
1213
1214 Most of these macros are explained in L<perlapi>, and some of the more
1215 important ones are explained in L<perlxs> as well. Pay special attention
1216 to L<perlguts/Background and PERL_IMPLICIT_CONTEXT> for information on
1217 the C<[pad]THX_?> macros.
1218
1219 =head2 The .i Targets
1220
1221 You can expand the macros in a F<foo.c> file by saying
1222
1223     make foo.i
1224
1225 which will expand the macros using cpp.  Don't be scared by the results.
1226
1227 =head2 Poking at Perl
1228
1229 To really poke around with Perl, you'll probably want to build Perl for
1230 debugging, like this:
1231
1232     ./Configure -d -D optimize=-g
1233     make
1234
1235 C<-g> is a flag to the C compiler to have it produce debugging
1236 information which will allow us to step through a running program.
1237 F<Configure> will also turn on the C<DEBUGGING> compilation symbol which
1238 enables all the internal debugging code in Perl. There are a whole bunch
1239 of things you can debug with this: L<perlrun> lists them all, and the
1240 best way to find out about them is to play about with them. The most
1241 useful options are probably
1242
1243     l  Context (loop) stack processing
1244     t  Trace execution
1245     o  Method and overloading resolution
1246     c  String/numeric conversions
1247
1248 Some of the functionality of the debugging code can be achieved using XS
1249 modules.
1250
1251     -Dr => use re 'debug'
1252     -Dx => use O 'Debug'
1253
1254 =head2 Using a source-level debugger
1255
1256 If the debugging output of C<-D> doesn't help you, it's time to step
1257 through perl's execution with a source-level debugger.
1258
1259 =over 3
1260
1261 =item *
1262
1263 We'll use C<gdb> for our examples here; the principles will apply to any
1264 debugger, but check the manual of the one you're using.
1265
1266 =back
1267
1268 To fire up the debugger, type
1269
1270     gdb ./perl
1271
1272 You'll want to do that in your Perl source tree so the debugger can read
1273 the source code. You should see the copyright message, followed by the
1274 prompt.
1275
1276     (gdb)
1277
1278 C<help> will get you into the documentation, but here are the most
1279 useful commands:
1280
1281 =over 3
1282
1283 =item run [args]
1284
1285 Run the program with the given arguments.
1286
1287 =item break function_name
1288
1289 =item break source.c:xxx
1290
1291 Tells the debugger that we'll want to pause execution when we reach
1292 either the named function (but see L<perlguts/Internal Functions>!) or the given
1293 line in the named source file.
1294
1295 =item step
1296
1297 Steps through the program a line at a time.
1298
1299 =item next
1300
1301 Steps through the program a line at a time, without descending into
1302 functions.
1303
1304 =item continue
1305
1306 Run until the next breakpoint.
1307
1308 =item finish
1309
1310 Run until the end of the current function, then stop again.
1311
1312 =item 'enter'
1313
1314 Just pressing Enter will do the most recent operation again - it's a
1315 blessing when stepping through miles of source code.
1316
1317 =item print
1318
1319 Execute the given C code and print its results. B<WARNING>: Perl makes
1320 heavy use of macros, and F<gdb> does not necessarily support macros
1321 (see later L</"gdb macro support">).  You'll have to substitute them
1322 yourself, or to invoke cpp on the source code files
1323 (see L</"The .i Targets">)
1324 So, for instance, you can't say
1325
1326     print SvPV_nolen(sv)
1327
1328 but you have to say
1329
1330     print Perl_sv_2pv_nolen(sv)
1331
1332 =back
1333
1334 You may find it helpful to have a "macro dictionary", which you can
1335 produce by saying C<cpp -dM perl.c | sort>. Even then, F<cpp> won't
1336 recursively apply those macros for you. 
1337
1338 =head2 gdb macro support
1339
1340 Recent versions of F<gdb> have fairly good macro support, but
1341 in order to use it you'll need to compile perl with macro definitions
1342 included in the debugging information.  Using F<gcc> version 3.1, this
1343 means configuring with C<-Doptimize=-g3>.  Other compilers might use a
1344 different switch (if they support debugging macros at all).
1345
1346 =head2 Dumping Perl Data Structures
1347
1348 One way to get around this macro hell is to use the dumping functions in
1349 F<dump.c>; these work a little like an internal
1350 L<Devel::Peek|Devel::Peek>, but they also cover OPs and other structures
1351 that you can't get at from Perl. Let's take an example. We'll use the
1352 C<$a = $b + $c> we used before, but give it a bit of context: 
1353 C<$b = "6XXXX"; $c = 2.3;>. Where's a good place to stop and poke around?
1354
1355 What about C<pp_add>, the function we examined earlier to implement the
1356 C<+> operator:
1357
1358     (gdb) break Perl_pp_add
1359     Breakpoint 1 at 0x46249f: file pp_hot.c, line 309.
1360
1361 Notice we use C<Perl_pp_add> and not C<pp_add> - see L<perlguts/Internal Functions>.
1362 With the breakpoint in place, we can run our program:
1363
1364     (gdb) run -e '$b = "6XXXX"; $c = 2.3; $a = $b + $c'
1365
1366 Lots of junk will go past as gdb reads in the relevant source files and
1367 libraries, and then:
1368
1369     Breakpoint 1, Perl_pp_add () at pp_hot.c:309
1370     309         dSP; dATARGET; tryAMAGICbin(add,opASSIGN);
1371     (gdb) step
1372     311           dPOPTOPnnrl_ul;
1373     (gdb)
1374
1375 We looked at this bit of code before, and we said that C<dPOPTOPnnrl_ul>
1376 arranges for two C<NV>s to be placed into C<left> and C<right> - let's
1377 slightly expand it:
1378
1379     #define dPOPTOPnnrl_ul  NV right = POPn; \
1380                             SV *leftsv = TOPs; \
1381                             NV left = USE_LEFT(leftsv) ? SvNV(leftsv) : 0.0
1382
1383 C<POPn> takes the SV from the top of the stack and obtains its NV either
1384 directly (if C<SvNOK> is set) or by calling the C<sv_2nv> function.
1385 C<TOPs> takes the next SV from the top of the stack - yes, C<POPn> uses
1386 C<TOPs> - but doesn't remove it. We then use C<SvNV> to get the NV from
1387 C<leftsv> in the same way as before - yes, C<POPn> uses C<SvNV>. 
1388
1389 Since we don't have an NV for C<$b>, we'll have to use C<sv_2nv> to
1390 convert it. If we step again, we'll find ourselves there:
1391
1392     Perl_sv_2nv (sv=0xa0675d0) at sv.c:1669
1393     1669        if (!sv)
1394     (gdb)
1395
1396 We can now use C<Perl_sv_dump> to investigate the SV:
1397
1398     SV = PV(0xa057cc0) at 0xa0675d0
1399     REFCNT = 1
1400     FLAGS = (POK,pPOK)
1401     PV = 0xa06a510 "6XXXX"\0
1402     CUR = 5
1403     LEN = 6
1404     $1 = void
1405
1406 We know we're going to get C<6> from this, so let's finish the
1407 subroutine:
1408
1409     (gdb) finish
1410     Run till exit from #0  Perl_sv_2nv (sv=0xa0675d0) at sv.c:1671
1411     0x462669 in Perl_pp_add () at pp_hot.c:311
1412     311           dPOPTOPnnrl_ul;
1413
1414 We can also dump out this op: the current op is always stored in
1415 C<PL_op>, and we can dump it with C<Perl_op_dump>. This'll give us
1416 similar output to L<B::Debug|B::Debug>.
1417
1418     {
1419     13  TYPE = add  ===> 14
1420         TARG = 1
1421         FLAGS = (SCALAR,KIDS)
1422         {
1423             TYPE = null  ===> (12)
1424               (was rv2sv)
1425             FLAGS = (SCALAR,KIDS)
1426             {
1427     11          TYPE = gvsv  ===> 12
1428                 FLAGS = (SCALAR)
1429                 GV = main::b
1430             }
1431         }
1432
1433 # finish this later #
1434
1435 =head2 Patching
1436
1437 All right, we've now had a look at how to navigate the Perl sources and
1438 some things you'll need to know when fiddling with them. Let's now get
1439 on and create a simple patch. Here's something Larry suggested: if a
1440 C<U> is the first active format during a C<pack>, (for example, 
1441 C<pack "U3C8", @stuff>) then the resulting string should be treated as
1442 UTF-8 encoded.
1443
1444 How do we prepare to fix this up? First we locate the code in question -
1445 the C<pack> happens at runtime, so it's going to be in one of the F<pp>
1446 files. Sure enough, C<pp_pack> is in F<pp.c>. Since we're going to be
1447 altering this file, let's copy it to F<pp.c~>.
1448
1449 [Well, it was in F<pp.c> when this tutorial was written. It has now been
1450 split off with C<pp_unpack> to its own file, F<pp_pack.c>]
1451
1452 Now let's look over C<pp_pack>: we take a pattern into C<pat>, and then
1453 loop over the pattern, taking each format character in turn into
1454 C<datum_type>. Then for each possible format character, we swallow up
1455 the other arguments in the pattern (a field width, an asterisk, and so
1456 on) and convert the next chunk input into the specified format, adding
1457 it onto the output SV C<cat>.
1458
1459 How do we know if the C<U> is the first format in the C<pat>? Well, if
1460 we have a pointer to the start of C<pat> then, if we see a C<U> we can
1461 test whether we're still at the start of the string. So, here's where
1462 C<pat> is set up:
1463
1464     STRLEN fromlen;
1465     register char *pat = SvPVx(*++MARK, fromlen);
1466     register char *patend = pat + fromlen;
1467     register I32 len;
1468     I32 datumtype;
1469     SV *fromstr;
1470
1471 We'll have another string pointer in there:
1472
1473     STRLEN fromlen;
1474     register char *pat = SvPVx(*++MARK, fromlen);
1475     register char *patend = pat + fromlen;
1476  +  char *patcopy;
1477     register I32 len;
1478     I32 datumtype;
1479     SV *fromstr;
1480
1481 And just before we start the loop, we'll set C<patcopy> to be the start
1482 of C<pat>:
1483
1484     items = SP - MARK;
1485     MARK++;
1486     sv_setpvn(cat, "", 0);
1487  +  patcopy = pat;
1488     while (pat < patend) {
1489
1490 Now if we see a C<U> which was at the start of the string, we turn on
1491 the C<UTF8> flag for the output SV, C<cat>:
1492
1493  +  if (datumtype == 'U' && pat==patcopy+1)
1494  +      SvUTF8_on(cat);
1495     if (datumtype == '#') {
1496         while (pat < patend && *pat != '\n')
1497             pat++;
1498
1499 Remember that it has to be C<patcopy+1> because the first character of
1500 the string is the C<U> which has been swallowed into C<datumtype!>
1501
1502 Oops, we forgot one thing: what if there are spaces at the start of the
1503 pattern? C<pack("  U*", @stuff)> will have C<U> as the first active
1504 character, even though it's not the first thing in the pattern. In this
1505 case, we have to advance C<patcopy> along with C<pat> when we see spaces:
1506
1507     if (isSPACE(datumtype))
1508         continue;
1509
1510 needs to become
1511
1512     if (isSPACE(datumtype)) {
1513         patcopy++;
1514         continue;
1515     }
1516
1517 OK. That's the C part done. Now we must do two additional things before
1518 this patch is ready to go: we've changed the behaviour of Perl, and so
1519 we must document that change. We must also provide some more regression
1520 tests to make sure our patch works and doesn't create a bug somewhere
1521 else along the line.
1522
1523 The regression tests for each operator live in F<t/op/>, and so we
1524 make a copy of F<t/op/pack.t> to F<t/op/pack.t~>. Now we can add our
1525 tests to the end. First, we'll test that the C<U> does indeed create
1526 Unicode strings.  
1527
1528 t/op/pack.t has a sensible ok() function, but if it didn't we could
1529 use the one from t/test.pl.
1530
1531  require './test.pl';
1532  plan( tests => 159 );
1533
1534 so instead of this:
1535
1536  print 'not ' unless "1.20.300.4000" eq sprintf "%vd", pack("U*",1,20,300,4000);
1537  print "ok $test\n"; $test++;
1538
1539 we can write the more sensible (see L<Test::More> for a full
1540 explanation of is() and other testing functions).
1541
1542  is( "1.20.300.4000", sprintf "%vd", pack("U*",1,20,300,4000), 
1543                                        "U* produces unicode" );
1544
1545 Now we'll test that we got that space-at-the-beginning business right:
1546
1547  is( "1.20.300.4000", sprintf "%vd", pack("  U*",1,20,300,4000),
1548                                        "  with spaces at the beginning" );
1549
1550 And finally we'll test that we don't make Unicode strings if C<U> is B<not>
1551 the first active format:
1552
1553  isnt( v1.20.300.4000, sprintf "%vd", pack("C0U*",1,20,300,4000),
1554                                        "U* not first isn't unicode" );
1555
1556 Mustn't forget to change the number of tests which appears at the top,
1557 or else the automated tester will get confused.  This will either look
1558 like this:
1559
1560  print "1..156\n";
1561
1562 or this:
1563
1564  plan( tests => 156 );
1565
1566 We now compile up Perl, and run it through the test suite. Our new
1567 tests pass, hooray!
1568
1569 Finally, the documentation. The job is never done until the paperwork is
1570 over, so let's describe the change we've just made. The relevant place
1571 is F<pod/perlfunc.pod>; again, we make a copy, and then we'll insert
1572 this text in the description of C<pack>:
1573
1574  =item *
1575
1576  If the pattern begins with a C<U>, the resulting string will be treated
1577  as UTF-8-encoded Unicode. You can force UTF-8 encoding on in a string
1578  with an initial C<U0>, and the bytes that follow will be interpreted as
1579  Unicode characters. If you don't want this to happen, you can begin your
1580  pattern with C<C0> (or anything else) to force Perl not to UTF-8 encode your
1581  string, and then follow this with a C<U*> somewhere in your pattern.
1582
1583 All done. Now let's create the patch. F<Porting/patching.pod> tells us
1584 that if we're making major changes, we should copy the entire directory
1585 to somewhere safe before we begin fiddling, and then do
1586
1587     diff -ruN old new > patch
1588
1589 However, we know which files we've changed, and we can simply do this:
1590
1591     diff -u pp.c~             pp.c             >  patch
1592     diff -u t/op/pack.t~      t/op/pack.t      >> patch
1593     diff -u pod/perlfunc.pod~ pod/perlfunc.pod >> patch
1594
1595 We end up with a patch looking a little like this:
1596
1597     --- pp.c~       Fri Jun 02 04:34:10 2000
1598     +++ pp.c        Fri Jun 16 11:37:25 2000
1599     @@ -4375,6 +4375,7 @@
1600          register I32 items;
1601          STRLEN fromlen;
1602          register char *pat = SvPVx(*++MARK, fromlen);
1603     +    char *patcopy;
1604          register char *patend = pat + fromlen;
1605          register I32 len;
1606          I32 datumtype;
1607     @@ -4405,6 +4406,7 @@
1608     ...
1609
1610 And finally, we submit it, with our rationale, to perl5-porters. Job
1611 done!
1612
1613 =head2 Patching a core module
1614
1615 This works just like patching anything else, with an extra
1616 consideration.  Many core modules also live on CPAN.  If this is so,
1617 patch the CPAN version instead of the core and send the patch off to
1618 the module maintainer (with a copy to p5p).  This will help the module
1619 maintainer keep the CPAN version in sync with the core version without
1620 constantly scanning p5p.
1621
1622 =head2 Adding a new function to the core
1623
1624 If, as part of a patch to fix a bug, or just because you have an
1625 especially good idea, you decide to add a new function to the core,
1626 discuss your ideas on p5p well before you start work.  It may be that
1627 someone else has already attempted to do what you are considering and
1628 can give lots of good advice or even provide you with bits of code
1629 that they already started (but never finished).
1630
1631 You have to follow all of the advice given above for patching.  It is
1632 extremely important to test any addition thoroughly and add new tests
1633 to explore all boundary conditions that your new function is expected
1634 to handle.  If your new function is used only by one module (e.g. toke),
1635 then it should probably be named S_your_function (for static); on the
1636 other hand, if you expect it to accessible from other functions in
1637 Perl, you should name it Perl_your_function.  See L<perlguts/Internal Functions>
1638 for more details.
1639
1640 The location of any new code is also an important consideration.  Don't
1641 just create a new top level .c file and put your code there; you would
1642 have to make changes to Configure (so the Makefile is created properly),
1643 as well as possibly lots of include files.  This is strictly pumpking
1644 business.
1645
1646 It is better to add your function to one of the existing top level
1647 source code files, but your choice is complicated by the nature of
1648 the Perl distribution.  Only the files that are marked as compiled
1649 static are located in the perl executable.  Everything else is located
1650 in the shared library (or DLL if you are running under WIN32).  So,
1651 for example, if a function was only used by functions located in
1652 toke.c, then your code can go in toke.c.  If, however, you want to call
1653 the function from universal.c, then you should put your code in another
1654 location, for example util.c.
1655
1656 In addition to writing your c-code, you will need to create an
1657 appropriate entry in embed.pl describing your function, then run
1658 'make regen_headers' to create the entries in the numerous header
1659 files that perl needs to compile correctly.  See L<perlguts/Internal Functions>
1660 for information on the various options that you can set in embed.pl.
1661 You will forget to do this a few (or many) times and you will get
1662 warnings during the compilation phase.  Make sure that you mention
1663 this when you post your patch to P5P; the pumpking needs to know this.
1664
1665 When you write your new code, please be conscious of existing code
1666 conventions used in the perl source files.  See L<perlstyle> for
1667 details.  Although most of the guidelines discussed seem to focus on
1668 Perl code, rather than c, they all apply (except when they don't ;).
1669 See also I<Porting/patching.pod> file in the Perl source distribution
1670 for lots of details about both formatting and submitting patches of
1671 your changes.
1672
1673 Lastly, TEST TEST TEST TEST TEST any code before posting to p5p.
1674 Test on as many platforms as you can find.  Test as many perl
1675 Configure options as you can (e.g. MULTIPLICITY).  If you have
1676 profiling or memory tools, see L<EXTERNAL TOOLS FOR DEBUGGING PERL>
1677 below for how to use them to further test your code.  Remember that
1678 most of the people on P5P are doing this on their own time and
1679 don't have the time to debug your code.
1680
1681 =head2 Writing a test
1682
1683 Every module and built-in function has an associated test file (or
1684 should...).  If you add or change functionality, you have to write a
1685 test.  If you fix a bug, you have to write a test so that bug never
1686 comes back.  If you alter the docs, it would be nice to test what the
1687 new documentation says.
1688
1689 In short, if you submit a patch you probably also have to patch the
1690 tests.
1691
1692 For modules, the test file is right next to the module itself.
1693 F<lib/strict.t> tests F<lib/strict.pm>.  This is a recent innovation,
1694 so there are some snags (and it would be wonderful for you to brush
1695 them out), but it basically works that way.  Everything else lives in
1696 F<t/>.
1697
1698 =over 3
1699
1700 =item F<t/base/>
1701
1702 Testing of the absolute basic functionality of Perl.  Things like
1703 C<if>, basic file reads and writes, simple regexes, etc.  These are
1704 run first in the test suite and if any of them fail, something is
1705 I<really> broken.
1706
1707 =item F<t/cmd/>
1708
1709 These test the basic control structures, C<if/else>, C<while>,
1710 subroutines, etc.
1711
1712 =item F<t/comp/>
1713
1714 Tests basic issues of how Perl parses and compiles itself.
1715
1716 =item F<t/io/>
1717
1718 Tests for built-in IO functions, including command line arguments.
1719
1720 =item F<t/lib/>
1721
1722 The old home for the module tests, you shouldn't put anything new in
1723 here.  There are still some bits and pieces hanging around in here
1724 that need to be moved.  Perhaps you could move them?  Thanks!
1725
1726 =item F<t/op/>
1727
1728 Tests for perl's built in functions that don't fit into any of the
1729 other directories.
1730
1731 =item F<t/pod/>
1732
1733 Tests for POD directives.  There are still some tests for the Pod
1734 modules hanging around in here that need to be moved out into F<lib/>.
1735
1736 =item F<t/run/>
1737
1738 Testing features of how perl actually runs, including exit codes and
1739 handling of PERL* environment variables.
1740
1741 =item F<t/uni/>
1742
1743 Tests for the core support of Unicode.
1744
1745 =item F<t/win32/>
1746
1747 Windows-specific tests.
1748
1749 =item F<t/x2p>
1750
1751 A test suite for the s2p converter.
1752
1753 =back
1754
1755 The core uses the same testing style as the rest of Perl, a simple
1756 "ok/not ok" run through Test::Harness, but there are a few special
1757 considerations.
1758
1759 There are three ways to write a test in the core.  Test::More,
1760 t/test.pl and ad hoc C<print $test ? "ok 42\n" : "not ok 42\n">.  The
1761 decision of which to use depends on what part of the test suite you're
1762 working on.  This is a measure to prevent a high-level failure (such
1763 as Config.pm breaking) from causing basic functionality tests to fail.
1764
1765 =over 4 
1766
1767 =item t/base t/comp
1768
1769 Since we don't know if require works, or even subroutines, use ad hoc
1770 tests for these two.  Step carefully to avoid using the feature being
1771 tested.
1772
1773 =item t/cmd t/run t/io t/op
1774
1775 Now that basic require() and subroutines are tested, you can use the
1776 t/test.pl library which emulates the important features of Test::More
1777 while using a minimum of core features.
1778
1779 You can also conditionally use certain libraries like Config, but be
1780 sure to skip the test gracefully if it's not there.
1781
1782 =item t/lib ext lib
1783
1784 Now that the core of Perl is tested, Test::More can be used.  You can
1785 also use the full suite of core modules in the tests.
1786
1787 =back
1788
1789 When you say "make test" Perl uses the F<t/TEST> program to run the
1790 test suite.  All tests are run from the F<t/> directory, B<not> the
1791 directory which contains the test.  This causes some problems with the
1792 tests in F<lib/>, so here's some opportunity for some patching.
1793
1794 You must be triply conscious of cross-platform concerns.  This usually
1795 boils down to using File::Spec and avoiding things like C<fork()> and
1796 C<system()> unless absolutely necessary.
1797
1798 =head2 Special Make Test Targets
1799
1800 There are various special make targets that can be used to test Perl
1801 slightly differently than the standard "test" target.  Not all them
1802 are expected to give a 100% success rate.  Many of them have several
1803 aliases.
1804
1805 =over 4
1806
1807 =item coretest
1808
1809 Run F<perl> on all core tests (F<t/*> and F<lib/[a-z]*> pragma tests).
1810
1811 =item test.deparse
1812
1813 Run all the tests through B::Deparse.  Not all tests will succeed.
1814
1815 =item test.taintwarn
1816
1817 Run all tests with the B<-t> command-line switch.  Not all tests
1818 are expected to succeed (until they're specifically fixed, of course).
1819
1820 =item minitest
1821
1822 Run F<miniperl> on F<t/base>, F<t/comp>, F<t/cmd>, F<t/run>, F<t/io>,
1823 F<t/op>, and F<t/uni> tests.
1824
1825 =item test.valgrind check.valgrind utest.valgrind ucheck.valgrind
1826
1827 (Only in Linux) Run all the tests using the memory leak + naughty
1828 memory access tool "valgrind".  The log files will be named
1829 F<testname.valgrind>.
1830
1831 =item test.third check.third utest.third ucheck.third
1832
1833 (Only in Tru64)  Run all the tests using the memory leak + naughty
1834 memory access tool "Third Degree".  The log files will be named
1835 F<perl3.log.testname>.
1836
1837 =item test.torture torturetest
1838
1839 Run all the usual tests and some extra tests.  As of Perl 5.8.0 the
1840 only extra tests are Abigail's JAPHs, F<t/japh/abigail.t>.
1841
1842 You can also run the torture test with F<t/harness> by giving
1843 C<-torture> argument to F<t/harness>.
1844
1845 =item utest ucheck test.utf8 check.utf8
1846
1847 Run all the tests with -Mutf8.  Not all tests will succeed.
1848
1849 =item test_harness
1850
1851 Run the test suite with the F<t/harness> controlling program, instead of
1852 F<t/TEST>. F<t/harness> is more sophisticated, and uses the
1853 L<Test::Harness> module, thus using this test target supposes that perl
1854 mostly works. The main advantage for our purposes is that it prints a
1855 detailed summary of failed tests at the end. Also, unlike F<t/TEST>, it
1856 doesn't redirect stderr to stdout.
1857
1858 =back
1859
1860 =head2 Running tests by hand
1861
1862 You can run part of the test suite by hand by using one the following
1863 commands from the F<t/> directory :
1864
1865     ./perl -I../lib TEST list-of-.t-files
1866
1867 or
1868
1869     ./perl -I../lib harness list-of-.t-files
1870
1871 (if you don't specify test scripts, the whole test suite will be run.)
1872
1873 You can run an individual test by a command similar to
1874
1875     ./perl -I../lib patho/to/foo.t
1876
1877 except that the harnesses set up some environment variables that may
1878 affect the execution of the test :
1879
1880 =over 4 
1881
1882 =item PERL_CORE=1
1883
1884 indicates that we're running this test part of the perl core test suite.
1885 This is useful for modules that have a dual life on CPAN.
1886
1887 =item PERL_DESTRUCT_LEVEL=2
1888
1889 is set to 2 if it isn't set already (see L</PERL_DESTRUCT_LEVEL>)
1890
1891 =item PERL
1892
1893 (used only by F<t/TEST>) if set, overrides the path to the perl executable
1894 that should be used to run the tests (the default being F<./perl>).
1895
1896 =item PERL_SKIP_TTY_TEST
1897
1898 if set, tells to skip the tests that need a terminal. It's actually set
1899 automatically by the Makefile, but can also be forced artificially by
1900 running 'make test_notty'.
1901
1902 =back
1903
1904 =head1 EXTERNAL TOOLS FOR DEBUGGING PERL
1905
1906 Sometimes it helps to use external tools while debugging and
1907 testing Perl.  This section tries to guide you through using
1908 some common testing and debugging tools with Perl.  This is
1909 meant as a guide to interfacing these tools with Perl, not
1910 as any kind of guide to the use of the tools themselves.
1911
1912 B<NOTE 1>: Running under memory debuggers such as Purify, valgrind, or
1913 Third Degree greatly slows down the execution: seconds become minutes,
1914 minutes become hours.  For example as of Perl 5.8.1, the
1915 ext/Encode/t/Unicode.t takes extraordinarily long to complete under
1916 e.g. Purify, Third Degree, and valgrind.  Under valgrind it takes more
1917 than six hours, even on a snappy computer-- the said test must be
1918 doing something that is quite unfriendly for memory debuggers.  If you
1919 don't feel like waiting, that you can simply kill away the perl
1920 process.
1921
1922 B<NOTE 2>: To minimize the number of memory leak false alarms (see
1923 L</PERL_DESTRUCT_LEVEL> for more information), you have to have
1924 environment variable PERL_DESTRUCT_LEVEL set to 2.  The F<TEST>
1925 and harness scripts do that automatically.  But if you are running
1926 some of the tests manually-- for csh-like shells:
1927
1928     setenv PERL_DESTRUCT_LEVEL 2
1929
1930 and for Bourne-type shells:
1931
1932     PERL_DESTRUCT_LEVEL=2
1933     export PERL_DESTRUCT_LEVEL
1934
1935 or in UNIXy environments you can also use the C<env> command:
1936
1937     env PERL_DESTRUCT_LEVEL=2 valgrind ./perl -Ilib ...
1938
1939 B<NOTE 3>: There are known memory leaks when there are compile-time
1940 errors within eval or require, seeing C<S_doeval> in the call stack
1941 is a good sign of these.  Fixing these leaks is non-trivial,
1942 unfortunately, but they must be fixed eventually.
1943
1944 =head2 Rational Software's Purify
1945
1946 Purify is a commercial tool that is helpful in identifying
1947 memory overruns, wild pointers, memory leaks and other such
1948 badness.  Perl must be compiled in a specific way for
1949 optimal testing with Purify.  Purify is available under
1950 Windows NT, Solaris, HP-UX, SGI, and Siemens Unix.
1951
1952 =head2 Purify on Unix
1953
1954 On Unix, Purify creates a new Perl binary.  To get the most
1955 benefit out of Purify, you should create the perl to Purify
1956 using:
1957
1958     sh Configure -Accflags=-DPURIFY -Doptimize='-g' \
1959      -Uusemymalloc -Dusemultiplicity
1960
1961 where these arguments mean:
1962
1963 =over 4
1964
1965 =item -Accflags=-DPURIFY
1966
1967 Disables Perl's arena memory allocation functions, as well as
1968 forcing use of memory allocation functions derived from the
1969 system malloc.
1970
1971 =item -Doptimize='-g'
1972
1973 Adds debugging information so that you see the exact source
1974 statements where the problem occurs.  Without this flag, all
1975 you will see is the source filename of where the error occurred.
1976
1977 =item -Uusemymalloc
1978
1979 Disable Perl's malloc so that Purify can more closely monitor
1980 allocations and leaks.  Using Perl's malloc will make Purify
1981 report most leaks in the "potential" leaks category.
1982
1983 =item -Dusemultiplicity
1984
1985 Enabling the multiplicity option allows perl to clean up
1986 thoroughly when the interpreter shuts down, which reduces the
1987 number of bogus leak reports from Purify.
1988
1989 =back
1990
1991 Once you've compiled a perl suitable for Purify'ing, then you
1992 can just:
1993
1994     make pureperl   
1995
1996 which creates a binary named 'pureperl' that has been Purify'ed.
1997 This binary is used in place of the standard 'perl' binary
1998 when you want to debug Perl memory problems.
1999
2000 As an example, to show any memory leaks produced during the
2001 standard Perl testset you would create and run the Purify'ed
2002 perl as:
2003
2004     make pureperl
2005     cd t
2006     ../pureperl -I../lib harness 
2007
2008 which would run Perl on test.pl and report any memory problems.
2009
2010 Purify outputs messages in "Viewer" windows by default.  If
2011 you don't have a windowing environment or if you simply
2012 want the Purify output to unobtrusively go to a log file
2013 instead of to the interactive window, use these following
2014 options to output to the log file "perl.log":
2015
2016     setenv PURIFYOPTIONS "-chain-length=25 -windows=no \
2017      -log-file=perl.log -append-logfile=yes"
2018
2019 If you plan to use the "Viewer" windows, then you only need this option:
2020
2021     setenv PURIFYOPTIONS "-chain-length=25"
2022
2023 In Bourne-type shells:
2024
2025     PURIFYOPTIONS="..."
2026     export PURIFYOPTIONS
2027
2028 or if you have the "env" utility:
2029
2030     env PURIFYOPTIONS="..." ../pureperl ...
2031
2032 =head2 Purify on NT
2033
2034 Purify on Windows NT instruments the Perl binary 'perl.exe'
2035 on the fly.  There are several options in the makefile you
2036 should change to get the most use out of Purify:
2037
2038 =over 4
2039
2040 =item DEFINES
2041
2042 You should add -DPURIFY to the DEFINES line so the DEFINES
2043 line looks something like:
2044
2045     DEFINES = -DWIN32 -D_CONSOLE -DNO_STRICT $(CRYPT_FLAG) -DPURIFY=1 
2046
2047 to disable Perl's arena memory allocation functions, as
2048 well as to force use of memory allocation functions derived
2049 from the system malloc.
2050
2051 =item USE_MULTI = define
2052
2053 Enabling the multiplicity option allows perl to clean up
2054 thoroughly when the interpreter shuts down, which reduces the
2055 number of bogus leak reports from Purify.
2056
2057 =item #PERL_MALLOC = define
2058
2059 Disable Perl's malloc so that Purify can more closely monitor
2060 allocations and leaks.  Using Perl's malloc will make Purify
2061 report most leaks in the "potential" leaks category.
2062
2063 =item CFG = Debug
2064
2065 Adds debugging information so that you see the exact source
2066 statements where the problem occurs.  Without this flag, all
2067 you will see is the source filename of where the error occurred.
2068
2069 =back
2070
2071 As an example, to show any memory leaks produced during the
2072 standard Perl testset you would create and run Purify as:
2073
2074     cd win32
2075     make
2076     cd ../t
2077     purify ../perl -I../lib harness 
2078
2079 which would instrument Perl in memory, run Perl on test.pl,
2080 then finally report any memory problems.
2081
2082 =head2 valgrind
2083
2084 The excellent valgrind tool can be used to find out both memory leaks
2085 and illegal memory accesses.  As of August 2003 it unfortunately works
2086 only on x86 (ELF) Linux.  The special "test.valgrind" target can be used
2087 to run the tests under valgrind.  Found errors and memory leaks are
2088 logged in files named F<test.valgrind>.
2089
2090 As system libraries (most notably glibc) are also triggering errors,
2091 valgrind allows to suppress such errors using suppression files. The
2092 default suppression file that comes with valgrind already catches a lot
2093 of them. Some additional suppressions are defined in F<t/perl.supp>.
2094
2095 To get valgrind and for more information see
2096
2097     http://developer.kde.org/~sewardj/
2098
2099 =head2 Compaq's/Digital's/HP's Third Degree
2100
2101 Third Degree is a tool for memory leak detection and memory access checks.
2102 It is one of the many tools in the ATOM toolkit.  The toolkit is only
2103 available on Tru64 (formerly known as Digital UNIX formerly known as
2104 DEC OSF/1).
2105
2106 When building Perl, you must first run Configure with -Doptimize=-g
2107 and -Uusemymalloc flags, after that you can use the make targets
2108 "perl.third" and "test.third".  (What is required is that Perl must be
2109 compiled using the C<-g> flag, you may need to re-Configure.)
2110
2111 The short story is that with "atom" you can instrument the Perl
2112 executable to create a new executable called F<perl.third>.  When the
2113 instrumented executable is run, it creates a log of dubious memory
2114 traffic in file called F<perl.3log>.  See the manual pages of atom and
2115 third for more information.  The most extensive Third Degree
2116 documentation is available in the Compaq "Tru64 UNIX Programmer's
2117 Guide", chapter "Debugging Programs with Third Degree".
2118
2119 The "test.third" leaves a lot of files named F<foo_bar.3log> in the t/
2120 subdirectory.  There is a problem with these files: Third Degree is so
2121 effective that it finds problems also in the system libraries.
2122 Therefore you should used the Porting/thirdclean script to cleanup
2123 the F<*.3log> files.
2124
2125 There are also leaks that for given certain definition of a leak,
2126 aren't.  See L</PERL_DESTRUCT_LEVEL> for more information.
2127
2128 =head2 PERL_DESTRUCT_LEVEL
2129
2130 If you want to run any of the tests yourself manually using e.g.
2131 valgrind, or the pureperl or perl.third executables, please note that
2132 by default perl B<does not> explicitly cleanup all the memory it has
2133 allocated (such as global memory arenas) but instead lets the exit()
2134 of the whole program "take care" of such allocations, also known as
2135 "global destruction of objects".
2136
2137 There is a way to tell perl to do complete cleanup: set the
2138 environment variable PERL_DESTRUCT_LEVEL to a non-zero value.
2139 The t/TEST wrapper does set this to 2, and this is what you
2140 need to do too, if you don't want to see the "global leaks":
2141 For example, for "third-degreed" Perl:
2142
2143         env PERL_DESTRUCT_LEVEL=2 ./perl.third -Ilib t/foo/bar.t
2144
2145 (Note: the mod_perl apache module uses also this environment variable
2146 for its own purposes and extended its semantics. Refer to the mod_perl
2147 documentation for more information. Also, spawned threads do the
2148 equivalent of setting this variable to the value 1.)
2149
2150 If, at the end of a run you get the message I<N scalars leaked>, you can
2151 recompile with C<-DDEBUG_LEAKING_SCALARS>, which will cause
2152 the addresses of all those leaked SVs to be dumped; it also converts
2153 C<new_SV()> from a macro into a real function, so you can use your
2154 favourite debugger to discover where those pesky SVs were allocated.
2155
2156 =head2 Profiling
2157
2158 Depending on your platform there are various of profiling Perl.
2159
2160 There are two commonly used techniques of profiling executables:
2161 I<statistical time-sampling> and I<basic-block counting>.
2162
2163 The first method takes periodically samples of the CPU program
2164 counter, and since the program counter can be correlated with the code
2165 generated for functions, we get a statistical view of in which
2166 functions the program is spending its time.  The caveats are that very
2167 small/fast functions have lower probability of showing up in the
2168 profile, and that periodically interrupting the program (this is
2169 usually done rather frequently, in the scale of milliseconds) imposes
2170 an additional overhead that may skew the results.  The first problem
2171 can be alleviated by running the code for longer (in general this is a
2172 good idea for profiling), the second problem is usually kept in guard
2173 by the profiling tools themselves.
2174
2175 The second method divides up the generated code into I<basic blocks>.
2176 Basic blocks are sections of code that are entered only in the
2177 beginning and exited only at the end.  For example, a conditional jump
2178 starts a basic block.  Basic block profiling usually works by
2179 I<instrumenting> the code by adding I<enter basic block #nnnn>
2180 book-keeping code to the generated code.  During the execution of the
2181 code the basic block counters are then updated appropriately.  The
2182 caveat is that the added extra code can skew the results: again, the
2183 profiling tools usually try to factor their own effects out of the
2184 results.
2185
2186 =head2 Gprof Profiling
2187
2188 gprof is a profiling tool available in many UNIX platforms,
2189 it uses F<statistical time-sampling>.
2190
2191 You can build a profiled version of perl called "perl.gprof" by
2192 invoking the make target "perl.gprof"  (What is required is that Perl
2193 must be compiled using the C<-pg> flag, you may need to re-Configure).
2194 Running the profiled version of Perl will create an output file called
2195 F<gmon.out> is created which contains the profiling data collected
2196 during the execution.
2197
2198 The gprof tool can then display the collected data in various ways.
2199 Usually gprof understands the following options:
2200
2201 =over 4
2202
2203 =item -a
2204
2205 Suppress statically defined functions from the profile.
2206
2207 =item -b
2208
2209 Suppress the verbose descriptions in the profile.
2210
2211 =item -e routine
2212
2213 Exclude the given routine and its descendants from the profile.
2214
2215 =item -f routine
2216
2217 Display only the given routine and its descendants in the profile.
2218
2219 =item -s
2220
2221 Generate a summary file called F<gmon.sum> which then may be given
2222 to subsequent gprof runs to accumulate data over several runs.
2223
2224 =item -z
2225
2226 Display routines that have zero usage.
2227
2228 =back
2229
2230 For more detailed explanation of the available commands and output
2231 formats, see your own local documentation of gprof.
2232
2233 =head2 GCC gcov Profiling
2234
2235 Starting from GCC 3.0 I<basic block profiling> is officially available
2236 for the GNU CC.
2237
2238 You can build a profiled version of perl called F<perl.gcov> by
2239 invoking the make target "perl.gcov" (what is required that Perl must
2240 be compiled using gcc with the flags C<-fprofile-arcs
2241 -ftest-coverage>, you may need to re-Configure).
2242
2243 Running the profiled version of Perl will cause profile output to be
2244 generated.  For each source file an accompanying ".da" file will be
2245 created.
2246
2247 To display the results you use the "gcov" utility (which should
2248 be installed if you have gcc 3.0 or newer installed).  F<gcov> is
2249 run on source code files, like this
2250
2251     gcov sv.c
2252
2253 which will cause F<sv.c.gcov> to be created.  The F<.gcov> files
2254 contain the source code annotated with relative frequencies of
2255 execution indicated by "#" markers.
2256
2257 Useful options of F<gcov> include C<-b> which will summarise the
2258 basic block, branch, and function call coverage, and C<-c> which
2259 instead of relative frequencies will use the actual counts.  For
2260 more information on the use of F<gcov> and basic block profiling
2261 with gcc, see the latest GNU CC manual, as of GCC 3.0 see
2262
2263     http://gcc.gnu.org/onlinedocs/gcc-3.0/gcc.html
2264
2265 and its section titled "8. gcov: a Test Coverage Program"
2266
2267     http://gcc.gnu.org/onlinedocs/gcc-3.0/gcc_8.html#SEC132
2268
2269 =head2 Pixie Profiling
2270
2271 Pixie is a profiling tool available on IRIX and Tru64 (aka Digital
2272 UNIX aka DEC OSF/1) platforms.  Pixie does its profiling using
2273 I<basic-block counting>.
2274
2275 You can build a profiled version of perl called F<perl.pixie> by
2276 invoking the make target "perl.pixie" (what is required is that Perl
2277 must be compiled using the C<-g> flag, you may need to re-Configure).
2278
2279 In Tru64 a file called F<perl.Addrs> will also be silently created,
2280 this file contains the addresses of the basic blocks.  Running the
2281 profiled version of Perl will create a new file called "perl.Counts"
2282 which contains the counts for the basic block for that particular
2283 program execution.
2284
2285 To display the results you use the F<prof> utility.  The exact
2286 incantation depends on your operating system, "prof perl.Counts" in
2287 IRIX, and "prof -pixie -all -L. perl" in Tru64.
2288
2289 In IRIX the following prof options are available:
2290
2291 =over 4
2292
2293 =item -h
2294
2295 Reports the most heavily used lines in descending order of use.
2296 Useful for finding the hotspot lines.
2297
2298 =item -l
2299
2300 Groups lines by procedure, with procedures sorted in descending order of use.
2301 Within a procedure, lines are listed in source order.
2302 Useful for finding the hotspots of procedures.
2303
2304 =back
2305
2306 In Tru64 the following options are available:
2307
2308 =over 4
2309
2310 =item -p[rocedures]
2311
2312 Procedures sorted in descending order by the number of cycles executed
2313 in each procedure.  Useful for finding the hotspot procedures.
2314 (This is the default option.)
2315
2316 =item -h[eavy]
2317
2318 Lines sorted in descending order by the number of cycles executed in
2319 each line.  Useful for finding the hotspot lines.
2320
2321 =item -i[nvocations]
2322
2323 The called procedures are sorted in descending order by number of calls
2324 made to the procedures.  Useful for finding the most used procedures.
2325
2326 =item -l[ines]
2327
2328 Grouped by procedure, sorted by cycles executed per procedure.
2329 Useful for finding the hotspots of procedures.
2330
2331 =item -testcoverage
2332
2333 The compiler emitted code for these lines, but the code was unexecuted.
2334
2335 =item -z[ero]
2336
2337 Unexecuted procedures.
2338
2339 =back
2340
2341 For further information, see your system's manual pages for pixie and prof.
2342
2343 =head2 Miscellaneous tricks
2344
2345 =over 4
2346
2347 =item *
2348
2349 Those debugging perl with the DDD frontend over gdb may find the
2350 following useful:
2351
2352 You can extend the data conversion shortcuts menu, so for example you
2353 can display an SV's IV value with one click, without doing any typing.
2354 To do that simply edit ~/.ddd/init file and add after:
2355
2356   ! Display shortcuts.
2357   Ddd*gdbDisplayShortcuts: \
2358   /t ()   // Convert to Bin\n\
2359   /d ()   // Convert to Dec\n\
2360   /x ()   // Convert to Hex\n\
2361   /o ()   // Convert to Oct(\n\
2362
2363 the following two lines:
2364
2365   ((XPV*) (())->sv_any )->xpv_pv  // 2pvx\n\
2366   ((XPVIV*) (())->sv_any )->xiv_iv // 2ivx
2367
2368 so now you can do ivx and pvx lookups or you can plug there the
2369 sv_peek "conversion":
2370
2371   Perl_sv_peek(my_perl, (SV*)()) // sv_peek
2372
2373 (The my_perl is for threaded builds.)
2374 Just remember that every line, but the last one, should end with \n\
2375
2376 Alternatively edit the init file interactively via:
2377 3rd mouse button -> New Display -> Edit Menu
2378
2379 Note: you can define up to 20 conversion shortcuts in the gdb
2380 section.
2381
2382 =item *
2383
2384 If you see in a debugger a memory area mysteriously full of 0xabababab,
2385 you may be seeing the effect of the Poison() macro, see L<perlclib>.
2386
2387 =back
2388
2389 =head2 CONCLUSION
2390
2391 We've had a brief look around the Perl source, an overview of the stages
2392 F<perl> goes through when it's running your code, and how to use a
2393 debugger to poke at the Perl guts. We took a very simple problem and
2394 demonstrated how to solve it fully - with documentation, regression
2395 tests, and finally a patch for submission to p5p.  Finally, we talked
2396 about how to use external tools to debug and test Perl.
2397
2398 I'd now suggest you read over those references again, and then, as soon
2399 as possible, get your hands dirty. The best way to learn is by doing,
2400 so: 
2401
2402 =over 3
2403
2404 =item *
2405
2406 Subscribe to perl5-porters, follow the patches and try and understand
2407 them; don't be afraid to ask if there's a portion you're not clear on -
2408 who knows, you may unearth a bug in the patch...
2409
2410 =item *
2411
2412 Keep up to date with the bleeding edge Perl distributions and get
2413 familiar with the changes. Try and get an idea of what areas people are
2414 working on and the changes they're making.
2415
2416 =item *
2417
2418 Do read the README associated with your operating system, e.g. README.aix
2419 on the IBM AIX OS. Don't hesitate to supply patches to that README if
2420 you find anything missing or changed over a new OS release.
2421
2422 =item *
2423
2424 Find an area of Perl that seems interesting to you, and see if you can
2425 work out how it works. Scan through the source, and step over it in the
2426 debugger. Play, poke, investigate, fiddle! You'll probably get to
2427 understand not just your chosen area but a much wider range of F<perl>'s
2428 activity as well, and probably sooner than you'd think.
2429
2430 =back
2431
2432 =over 3
2433
2434 =item I<The Road goes ever on and on, down from the door where it began.>
2435
2436 =back
2437
2438 If you can do these things, you've started on the long road to Perl porting. 
2439 Thanks for wanting to help make Perl better - and happy hacking!
2440
2441 =head1 AUTHOR
2442
2443 This document was written by Nathan Torkington, and is maintained by
2444 the perl5-porters mailing list.
2445