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