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