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