This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
323d45693586365a4bc6ad8c4a075c3aad150232
[perl5.git] / pod / perlguts.pod
1 =head1 NAME
2
3 perlguts - Introduction to the Perl API
4
5 =head1 DESCRIPTION
6
7 This document attempts to describe how to use the Perl API, as well as
8 containing some info on the basic workings of the Perl core. It is far
9 from complete and probably contains many errors. Please refer any
10 questions or comments to the author below.
11
12 =head1 Variables
13
14 =head2 Datatypes
15
16 Perl has three typedefs that handle Perl's three main data types:
17
18     SV  Scalar Value
19     AV  Array Value
20     HV  Hash Value
21
22 Each typedef has specific routines that manipulate the various data types.
23
24 =head2 What is an "IV"?
25
26 Perl uses a special typedef IV which is a simple signed integer type that is
27 guaranteed to be large enough to hold a pointer (as well as an integer).
28 Additionally, there is the UV, which is simply an unsigned IV.
29
30 Perl also uses two special typedefs, I32 and I16, which will always be at
31 least 32-bits and 16-bits long, respectively. (Again, there are U32 and U16,
32 as well.)
33
34 =head2 Working with SVs
35
36 An SV can be created and loaded with one command.  There are four types of
37 values that can be loaded: an integer value (IV), a double (NV),
38 a string (PV), and another scalar (SV).
39
40 The six routines are:
41
42     SV*  newSViv(IV);
43     SV*  newSVnv(double);
44     SV*  newSVpv(const char*, int);
45     SV*  newSVpvn(const char*, int);
46     SV*  newSVpvf(const char*, ...);
47     SV*  newSVsv(SV*);
48
49 To change the value of an *already-existing* SV, there are seven routines:
50
51     void  sv_setiv(SV*, IV);
52     void  sv_setuv(SV*, UV);
53     void  sv_setnv(SV*, double);
54     void  sv_setpv(SV*, const char*);
55     void  sv_setpvn(SV*, const char*, int)
56     void  sv_setpvf(SV*, const char*, ...);
57     void  sv_setpvfn(SV*, const char*, STRLEN, va_list *, SV **, I32, bool);
58     void  sv_setsv(SV*, SV*);
59
60 Notice that you can choose to specify the length of the string to be
61 assigned by using C<sv_setpvn>, C<newSVpvn>, or C<newSVpv>, or you may
62 allow Perl to calculate the length by using C<sv_setpv> or by specifying
63 0 as the second argument to C<newSVpv>.  Be warned, though, that Perl will
64 determine the string's length by using C<strlen>, which depends on the
65 string terminating with a NUL character.
66
67 The arguments of C<sv_setpvf> are processed like C<sprintf>, and the
68 formatted output becomes the value.
69
70 C<sv_setpvfn> is an analogue of C<vsprintf>, but it allows you to specify
71 either a pointer to a variable argument list or the address and length of
72 an array of SVs.  The last argument points to a boolean; on return, if that
73 boolean is true, then locale-specific information has been used to format
74 the string, and the string's contents are therefore untrustworthy (see
75 L<perlsec>).  This pointer may be NULL if that information is not
76 important.  Note that this function requires you to specify the length of
77 the format.
78
79 STRLEN is an integer type (Size_t, usually defined as size_t in
80 config.h) guaranteed to be large enough to represent the size of
81 any string that perl can handle.
82
83 The C<sv_set*()> functions are not generic enough to operate on values
84 that have "magic".  See L<Magic Virtual Tables> later in this document.
85
86 All SVs that contain strings should be terminated with a NUL character.
87 If it is not NUL-terminated there is a risk of
88 core dumps and corruptions from code which passes the string to C
89 functions or system calls which expect a NUL-terminated string.
90 Perl's own functions typically add a trailing NUL for this reason.
91 Nevertheless, you should be very careful when you pass a string stored
92 in an SV to a C function or system call.
93
94 To access the actual value that an SV points to, you can use the macros:
95
96     SvIV(SV*)
97     SvUV(SV*)
98     SvNV(SV*)
99     SvPV(SV*, STRLEN len)
100     SvPV_nolen(SV*)
101
102 which will automatically coerce the actual scalar type into an IV, UV, double,
103 or string.
104
105 In the C<SvPV> macro, the length of the string returned is placed into the
106 variable C<len> (this is a macro, so you do I<not> use C<&len>).  If you do
107 not care what the length of the data is, use the C<SvPV_nolen> macro.
108 Historically the C<SvPV> macro with the global variable C<PL_na> has been
109 used in this case.  But that can be quite inefficient because C<PL_na> must
110 be accessed in thread-local storage in threaded Perl.  In any case, remember
111 that Perl allows arbitrary strings of data that may both contain NULs and
112 might not be terminated by a NUL.
113
114 Also remember that C doesn't allow you to safely say C<foo(SvPV(s, len),
115 len);>. It might work with your compiler, but it won't work for everyone.
116 Break this sort of statement up into separate assignments:
117
118         SV *s;
119         STRLEN len;
120         char * ptr;
121         ptr = SvPV(s, len);
122         foo(ptr, len);
123
124 If you want to know if the scalar value is TRUE, you can use:
125
126     SvTRUE(SV*)
127
128 Although Perl will automatically grow strings for you, if you need to force
129 Perl to allocate more memory for your SV, you can use the macro
130
131     SvGROW(SV*, STRLEN newlen)
132
133 which will determine if more memory needs to be allocated.  If so, it will
134 call the function C<sv_grow>.  Note that C<SvGROW> can only increase, not
135 decrease, the allocated memory of an SV and that it does not automatically
136 add a byte for the a trailing NUL (perl's own string functions typically do
137 C<SvGROW(sv, len + 1)>).
138
139 If you have an SV and want to know what kind of data Perl thinks is stored
140 in it, you can use the following macros to check the type of SV you have.
141
142     SvIOK(SV*)
143     SvNOK(SV*)
144     SvPOK(SV*)
145
146 You can get and set the current length of the string stored in an SV with
147 the following macros:
148
149     SvCUR(SV*)
150     SvCUR_set(SV*, I32 val)
151
152 You can also get a pointer to the end of the string stored in the SV
153 with the macro:
154
155     SvEND(SV*)
156
157 But note that these last three macros are valid only if C<SvPOK()> is true.
158
159 If you want to append something to the end of string stored in an C<SV*>,
160 you can use the following functions:
161
162     void  sv_catpv(SV*, const char*);
163     void  sv_catpvn(SV*, const char*, STRLEN);
164     void  sv_catpvf(SV*, const char*, ...);
165     void  sv_catpvfn(SV*, const char*, STRLEN, va_list *, SV **, I32, bool);
166     void  sv_catsv(SV*, SV*);
167
168 The first function calculates the length of the string to be appended by
169 using C<strlen>.  In the second, you specify the length of the string
170 yourself.  The third function processes its arguments like C<sprintf> and
171 appends the formatted output.  The fourth function works like C<vsprintf>.
172 You can specify the address and length of an array of SVs instead of the
173 va_list argument. The fifth function extends the string stored in the first
174 SV with the string stored in the second SV.  It also forces the second SV
175 to be interpreted as a string.
176
177 The C<sv_cat*()> functions are not generic enough to operate on values that
178 have "magic".  See L<Magic Virtual Tables> later in this document.
179
180 If you know the name of a scalar variable, you can get a pointer to its SV
181 by using the following:
182
183     SV*  get_sv("package::varname", FALSE);
184
185 This returns NULL if the variable does not exist.
186
187 If you want to know if this variable (or any other SV) is actually C<defined>,
188 you can call:
189
190     SvOK(SV*)
191
192 The scalar C<undef> value is stored in an SV instance called C<PL_sv_undef>.  Its
193 address can be used whenever an C<SV*> is needed.
194
195 There are also the two values C<PL_sv_yes> and C<PL_sv_no>, which contain Boolean
196 TRUE and FALSE values, respectively.  Like C<PL_sv_undef>, their addresses can
197 be used whenever an C<SV*> is needed.
198
199 Do not be fooled into thinking that C<(SV *) 0> is the same as C<&PL_sv_undef>.
200 Take this code:
201
202     SV* sv = (SV*) 0;
203     if (I-am-to-return-a-real-value) {
204             sv = sv_2mortal(newSViv(42));
205     }
206     sv_setsv(ST(0), sv);
207
208 This code tries to return a new SV (which contains the value 42) if it should
209 return a real value, or undef otherwise.  Instead it has returned a NULL
210 pointer which, somewhere down the line, will cause a segmentation violation,
211 bus error, or just weird results.  Change the zero to C<&PL_sv_undef> in the first
212 line and all will be well.
213
214 To free an SV that you've created, call C<SvREFCNT_dec(SV*)>.  Normally this
215 call is not necessary (see L<Reference Counts and Mortality>).
216
217 =head2 Offsets
218
219 Perl provides the function C<sv_chop> to efficiently remove characters
220 from the beginning of a string; you give it an SV and a pointer to
221 somewhere inside the the PV, and it discards everything before the
222 pointer. The efficiency comes by means of a little hack: instead of
223 actually removing the characters, C<sv_chop> sets the flag C<OOK>
224 (offset OK) to signal to other functions that the offset hack is in
225 effect, and it puts the number of bytes chopped off into the IV field
226 of the SV. It then moves the PV pointer (called C<SvPVX>) forward that
227 many bytes, and adjusts C<SvCUR> and C<SvLEN>.
228
229 Hence, at this point, the start of the buffer that we allocated lives
230 at C<SvPVX(sv) - SvIV(sv)> in memory and the PV pointer is pointing
231 into the middle of this allocated storage.
232
233 This is best demonstrated by example:
234
235   % ./perl -Ilib -MDevel::Peek -le '$a="12345"; $a=~s/.//; Dump($a)'
236   SV = PVIV(0x8128450) at 0x81340f0
237     REFCNT = 1
238     FLAGS = (POK,OOK,pPOK)
239     IV = 1  (OFFSET)
240     PV = 0x8135781 ( "1" . ) "2345"\0
241     CUR = 4
242     LEN = 5
243
244 Here the number of bytes chopped off (1) is put into IV, and
245 C<Devel::Peek::Dump> helpfully reminds us that this is an offset. The
246 portion of the string between the "real" and the "fake" beginnings is
247 shown in parentheses, and the values of C<SvCUR> and C<SvLEN> reflect
248 the fake beginning, not the real one.
249
250 Something similar to the offset hack is perfomed on AVs to enable
251 efficient shifting and splicing off the beginning of the array; while
252 C<AvARRAY> points to the first element in the array that is visible from
253 Perl, C<AvALLOC> points to the real start of the C array. These are
254 usually the same, but a C<shift> operation can be carried out by
255 increasing C<AvARRAY> by one and decreasing C<AvFILL> and C<AvLEN>.
256 Again, the location of the real start of the C array only comes into
257 play when freeing the array. See C<av_shift> in F<av.c>.
258
259 =head2 What's Really Stored in an SV?
260
261 Recall that the usual method of determining the type of scalar you have is
262 to use C<Sv*OK> macros.  Because a scalar can be both a number and a string,
263 usually these macros will always return TRUE and calling the C<Sv*V>
264 macros will do the appropriate conversion of string to integer/double or
265 integer/double to string.
266
267 If you I<really> need to know if you have an integer, double, or string
268 pointer in an SV, you can use the following three macros instead:
269
270     SvIOKp(SV*)
271     SvNOKp(SV*)
272     SvPOKp(SV*)
273
274 These will tell you if you truly have an integer, double, or string pointer
275 stored in your SV.  The "p" stands for private.
276
277 The are various ways in which the private and public flags may differ.
278 For example, a tied SV may have a valid underlying value in the IV slot
279 (so SvIOKp is true), but the data should be accessed via the FETCH
280 routine rather than directly, so SvIOK is false. Another is when
281 numeric conversion has occured and precision has been lost: only the
282 private flag is set on 'lossy' values. So when an NV is converted to an
283 IV with loss, SvIOKp, SvNOKp and SvNOK will be set, while SvIOK wont be.
284
285 In general, though, it's best to use the C<Sv*V> macros.
286
287 =head2 Working with AVs
288
289 There are two ways to create and load an AV.  The first method creates an
290 empty AV:
291
292     AV*  newAV();
293
294 The second method both creates the AV and initially populates it with SVs:
295
296     AV*  av_make(I32 num, SV **ptr);
297
298 The second argument points to an array containing C<num> C<SV*>'s.  Once the
299 AV has been created, the SVs can be destroyed, if so desired.
300
301 Once the AV has been created, the following operations are possible on AVs:
302
303     void  av_push(AV*, SV*);
304     SV*   av_pop(AV*);
305     SV*   av_shift(AV*);
306     void  av_unshift(AV*, I32 num);
307
308 These should be familiar operations, with the exception of C<av_unshift>.
309 This routine adds C<num> elements at the front of the array with the C<undef>
310 value.  You must then use C<av_store> (described below) to assign values
311 to these new elements.
312
313 Here are some other functions:
314
315     I32   av_len(AV*);
316     SV**  av_fetch(AV*, I32 key, I32 lval);
317     SV**  av_store(AV*, I32 key, SV* val);
318
319 The C<av_len> function returns the highest index value in array (just
320 like $#array in Perl).  If the array is empty, -1 is returned.  The
321 C<av_fetch> function returns the value at index C<key>, but if C<lval>
322 is non-zero, then C<av_fetch> will store an undef value at that index.
323 The C<av_store> function stores the value C<val> at index C<key>, and does
324 not increment the reference count of C<val>.  Thus the caller is responsible
325 for taking care of that, and if C<av_store> returns NULL, the caller will
326 have to decrement the reference count to avoid a memory leak.  Note that
327 C<av_fetch> and C<av_store> both return C<SV**>'s, not C<SV*>'s as their
328 return value.
329
330     void  av_clear(AV*);
331     void  av_undef(AV*);
332     void  av_extend(AV*, I32 key);
333
334 The C<av_clear> function deletes all the elements in the AV* array, but
335 does not actually delete the array itself.  The C<av_undef> function will
336 delete all the elements in the array plus the array itself.  The
337 C<av_extend> function extends the array so that it contains at least C<key+1>
338 elements.  If C<key+1> is less than the currently allocated length of the array,
339 then nothing is done.
340
341 If you know the name of an array variable, you can get a pointer to its AV
342 by using the following:
343
344     AV*  get_av("package::varname", FALSE);
345
346 This returns NULL if the variable does not exist.
347
348 See L<Understanding the Magic of Tied Hashes and Arrays> for more
349 information on how to use the array access functions on tied arrays.
350
351 =head2 Working with HVs
352
353 To create an HV, you use the following routine:
354
355     HV*  newHV();
356
357 Once the HV has been created, the following operations are possible on HVs:
358
359     SV**  hv_store(HV*, const char* key, U32 klen, SV* val, U32 hash);
360     SV**  hv_fetch(HV*, const char* key, U32 klen, I32 lval);
361
362 The C<klen> parameter is the length of the key being passed in (Note that
363 you cannot pass 0 in as a value of C<klen> to tell Perl to measure the
364 length of the key).  The C<val> argument contains the SV pointer to the
365 scalar being stored, and C<hash> is the precomputed hash value (zero if
366 you want C<hv_store> to calculate it for you).  The C<lval> parameter
367 indicates whether this fetch is actually a part of a store operation, in
368 which case a new undefined value will be added to the HV with the supplied
369 key and C<hv_fetch> will return as if the value had already existed.
370
371 Remember that C<hv_store> and C<hv_fetch> return C<SV**>'s and not just
372 C<SV*>.  To access the scalar value, you must first dereference the return
373 value.  However, you should check to make sure that the return value is
374 not NULL before dereferencing it.
375
376 These two functions check if a hash table entry exists, and deletes it.
377
378     bool  hv_exists(HV*, const char* key, U32 klen);
379     SV*   hv_delete(HV*, const char* key, U32 klen, I32 flags);
380
381 If C<flags> does not include the C<G_DISCARD> flag then C<hv_delete> will
382 create and return a mortal copy of the deleted value.
383
384 And more miscellaneous functions:
385
386     void   hv_clear(HV*);
387     void   hv_undef(HV*);
388
389 Like their AV counterparts, C<hv_clear> deletes all the entries in the hash
390 table but does not actually delete the hash table.  The C<hv_undef> deletes
391 both the entries and the hash table itself.
392
393 Perl keeps the actual data in linked list of structures with a typedef of HE.
394 These contain the actual key and value pointers (plus extra administrative
395 overhead).  The key is a string pointer; the value is an C<SV*>.  However,
396 once you have an C<HE*>, to get the actual key and value, use the routines
397 specified below.
398
399     I32    hv_iterinit(HV*);
400             /* Prepares starting point to traverse hash table */
401     HE*    hv_iternext(HV*);
402             /* Get the next entry, and return a pointer to a
403                structure that has both the key and value */
404     char*  hv_iterkey(HE* entry, I32* retlen);
405             /* Get the key from an HE structure and also return
406                the length of the key string */
407     SV*    hv_iterval(HV*, HE* entry);
408             /* Return a SV pointer to the value of the HE
409                structure */
410     SV*    hv_iternextsv(HV*, char** key, I32* retlen);
411             /* This convenience routine combines hv_iternext,
412                hv_iterkey, and hv_iterval.  The key and retlen
413                arguments are return values for the key and its
414                length.  The value is returned in the SV* argument */
415
416 If you know the name of a hash variable, you can get a pointer to its HV
417 by using the following:
418
419     HV*  get_hv("package::varname", FALSE);
420
421 This returns NULL if the variable does not exist.
422
423 The hash algorithm is defined in the C<PERL_HASH(hash, key, klen)> macro:
424
425     hash = 0;
426     while (klen--)
427         hash = (hash * 33) + *key++;
428     hash = hash + (hash >> 5);                  /* after 5.6 */
429
430 The last step was added in version 5.6 to improve distribution of
431 lower bits in the resulting hash value.
432
433 See L<Understanding the Magic of Tied Hashes and Arrays> for more
434 information on how to use the hash access functions on tied hashes.
435
436 =head2 Hash API Extensions
437
438 Beginning with version 5.004, the following functions are also supported:
439
440     HE*     hv_fetch_ent  (HV* tb, SV* key, I32 lval, U32 hash);
441     HE*     hv_store_ent  (HV* tb, SV* key, SV* val, U32 hash);
442
443     bool    hv_exists_ent (HV* tb, SV* key, U32 hash);
444     SV*     hv_delete_ent (HV* tb, SV* key, I32 flags, U32 hash);
445
446     SV*     hv_iterkeysv  (HE* entry);
447
448 Note that these functions take C<SV*> keys, which simplifies writing
449 of extension code that deals with hash structures.  These functions
450 also allow passing of C<SV*> keys to C<tie> functions without forcing
451 you to stringify the keys (unlike the previous set of functions).
452
453 They also return and accept whole hash entries (C<HE*>), making their
454 use more efficient (since the hash number for a particular string
455 doesn't have to be recomputed every time).  See L<perlapi> for detailed
456 descriptions.
457
458 The following macros must always be used to access the contents of hash
459 entries.  Note that the arguments to these macros must be simple
460 variables, since they may get evaluated more than once.  See
461 L<perlapi> for detailed descriptions of these macros.
462
463     HePV(HE* he, STRLEN len)
464     HeVAL(HE* he)
465     HeHASH(HE* he)
466     HeSVKEY(HE* he)
467     HeSVKEY_force(HE* he)
468     HeSVKEY_set(HE* he, SV* sv)
469
470 These two lower level macros are defined, but must only be used when
471 dealing with keys that are not C<SV*>s:
472
473     HeKEY(HE* he)
474     HeKLEN(HE* he)
475
476 Note that both C<hv_store> and C<hv_store_ent> do not increment the
477 reference count of the stored C<val>, which is the caller's responsibility.
478 If these functions return a NULL value, the caller will usually have to
479 decrement the reference count of C<val> to avoid a memory leak.
480
481 =head2 References
482
483 References are a special type of scalar that point to other data types
484 (including references).
485
486 To create a reference, use either of the following functions:
487
488     SV* newRV_inc((SV*) thing);
489     SV* newRV_noinc((SV*) thing);
490
491 The C<thing> argument can be any of an C<SV*>, C<AV*>, or C<HV*>.  The
492 functions are identical except that C<newRV_inc> increments the reference
493 count of the C<thing>, while C<newRV_noinc> does not.  For historical
494 reasons, C<newRV> is a synonym for C<newRV_inc>.
495
496 Once you have a reference, you can use the following macro to dereference
497 the reference:
498
499     SvRV(SV*)
500
501 then call the appropriate routines, casting the returned C<SV*> to either an
502 C<AV*> or C<HV*>, if required.
503
504 To determine if an SV is a reference, you can use the following macro:
505
506     SvROK(SV*)
507
508 To discover what type of value the reference refers to, use the following
509 macro and then check the return value.
510
511     SvTYPE(SvRV(SV*))
512
513 The most useful types that will be returned are:
514
515     SVt_IV    Scalar
516     SVt_NV    Scalar
517     SVt_PV    Scalar
518     SVt_RV    Scalar
519     SVt_PVAV  Array
520     SVt_PVHV  Hash
521     SVt_PVCV  Code
522     SVt_PVGV  Glob (possible a file handle)
523     SVt_PVMG  Blessed or Magical Scalar
524
525     See the sv.h header file for more details.
526
527 =head2 Blessed References and Class Objects
528
529 References are also used to support object-oriented programming.  In the
530 OO lexicon, an object is simply a reference that has been blessed into a
531 package (or class).  Once blessed, the programmer may now use the reference
532 to access the various methods in the class.
533
534 A reference can be blessed into a package with the following function:
535
536     SV* sv_bless(SV* sv, HV* stash);
537
538 The C<sv> argument must be a reference.  The C<stash> argument specifies
539 which class the reference will belong to.  See
540 L<Stashes and Globs> for information on converting class names into stashes.
541
542 /* Still under construction */
543
544 Upgrades rv to reference if not already one.  Creates new SV for rv to
545 point to.  If C<classname> is non-null, the SV is blessed into the specified
546 class.  SV is returned.
547
548         SV* newSVrv(SV* rv, const char* classname);
549
550 Copies integer, unsigned integer or double into an SV whose reference is C<rv>.  SV is blessed
551 if C<classname> is non-null.
552
553         SV* sv_setref_iv(SV* rv, const char* classname, IV iv);
554         SV* sv_setref_uv(SV* rv, const char* classname, UV uv);
555         SV* sv_setref_nv(SV* rv, const char* classname, NV iv);
556
557 Copies the pointer value (I<the address, not the string!>) into an SV whose
558 reference is rv.  SV is blessed if C<classname> is non-null.
559
560         SV* sv_setref_pv(SV* rv, const char* classname, PV iv);
561
562 Copies string into an SV whose reference is C<rv>.  Set length to 0 to let
563 Perl calculate the string length.  SV is blessed if C<classname> is non-null.
564
565         SV* sv_setref_pvn(SV* rv, const char* classname, PV iv, STRLEN length);
566
567 Tests whether the SV is blessed into the specified class.  It does not
568 check inheritance relationships.
569
570         int  sv_isa(SV* sv, const char* name);
571
572 Tests whether the SV is a reference to a blessed object.
573
574         int  sv_isobject(SV* sv);
575
576 Tests whether the SV is derived from the specified class. SV can be either
577 a reference to a blessed object or a string containing a class name. This
578 is the function implementing the C<UNIVERSAL::isa> functionality.
579
580         bool sv_derived_from(SV* sv, const char* name);
581
582 To check if you've got an object derived from a specific class you have
583 to write:
584
585         if (sv_isobject(sv) && sv_derived_from(sv, class)) { ... }
586
587 =head2 Creating New Variables
588
589 To create a new Perl variable with an undef value which can be accessed from
590 your Perl script, use the following routines, depending on the variable type.
591
592     SV*  get_sv("package::varname", TRUE);
593     AV*  get_av("package::varname", TRUE);
594     HV*  get_hv("package::varname", TRUE);
595
596 Notice the use of TRUE as the second parameter.  The new variable can now
597 be set, using the routines appropriate to the data type.
598
599 There are additional macros whose values may be bitwise OR'ed with the
600 C<TRUE> argument to enable certain extra features.  Those bits are:
601
602     GV_ADDMULTI Marks the variable as multiply defined, thus preventing the
603                 "Name <varname> used only once: possible typo" warning.
604     GV_ADDWARN  Issues the warning "Had to create <varname> unexpectedly" if
605                 the variable did not exist before the function was called.
606
607 If you do not specify a package name, the variable is created in the current
608 package.
609
610 =head2 Reference Counts and Mortality
611
612 Perl uses an reference count-driven garbage collection mechanism. SVs,
613 AVs, or HVs (xV for short in the following) start their life with a
614 reference count of 1.  If the reference count of an xV ever drops to 0,
615 then it will be destroyed and its memory made available for reuse.
616
617 This normally doesn't happen at the Perl level unless a variable is
618 undef'ed or the last variable holding a reference to it is changed or
619 overwritten.  At the internal level, however, reference counts can be
620 manipulated with the following macros:
621
622     int SvREFCNT(SV* sv);
623     SV* SvREFCNT_inc(SV* sv);
624     void SvREFCNT_dec(SV* sv);
625
626 However, there is one other function which manipulates the reference
627 count of its argument.  The C<newRV_inc> function, you will recall,
628 creates a reference to the specified argument.  As a side effect,
629 it increments the argument's reference count.  If this is not what
630 you want, use C<newRV_noinc> instead.
631
632 For example, imagine you want to return a reference from an XSUB function.
633 Inside the XSUB routine, you create an SV which initially has a reference
634 count of one.  Then you call C<newRV_inc>, passing it the just-created SV.
635 This returns the reference as a new SV, but the reference count of the
636 SV you passed to C<newRV_inc> has been incremented to two.  Now you
637 return the reference from the XSUB routine and forget about the SV.
638 But Perl hasn't!  Whenever the returned reference is destroyed, the
639 reference count of the original SV is decreased to one and nothing happens.
640 The SV will hang around without any way to access it until Perl itself
641 terminates.  This is a memory leak.
642
643 The correct procedure, then, is to use C<newRV_noinc> instead of
644 C<newRV_inc>.  Then, if and when the last reference is destroyed,
645 the reference count of the SV will go to zero and it will be destroyed,
646 stopping any memory leak.
647
648 There are some convenience functions available that can help with the
649 destruction of xVs.  These functions introduce the concept of "mortality".
650 An xV that is mortal has had its reference count marked to be decremented,
651 but not actually decremented, until "a short time later".  Generally the
652 term "short time later" means a single Perl statement, such as a call to
653 an XSUB function.  The actual determinant for when mortal xVs have their
654 reference count decremented depends on two macros, SAVETMPS and FREETMPS.
655 See L<perlcall> and L<perlxs> for more details on these macros.
656
657 "Mortalization" then is at its simplest a deferred C<SvREFCNT_dec>.
658 However, if you mortalize a variable twice, the reference count will
659 later be decremented twice.
660
661 "Mortal" SVs are mainly used for SVs that are placed on perl's stack.
662 For example an SV which is created just to pass a number to a called sub
663 is made mortal to have it cleaned up automatically when stack is popped.
664 Similarly results returned by XSUBs (which go in the stack) are often
665 made mortal.
666
667 To create a mortal variable, use the functions:
668
669     SV*  sv_newmortal()
670     SV*  sv_2mortal(SV*)
671     SV*  sv_mortalcopy(SV*)
672
673 The first call creates a mortal SV (with no value), the second converts an existing
674 SV to a mortal SV (and thus defers a call to C<SvREFCNT_dec>), and the
675 third creates a mortal copy of an existing SV.
676 Because C<sv_newmortal> gives the new SV no value,it must normally be given one
677 via C<sv_setpv>, C<sv_setiv> etc. :
678
679     SV *tmp = sv_newmortal();
680     sv_setiv(tmp, an_integer);
681
682 As that is multiple C statements it is quite common so see this idiom instead:
683
684     SV *tmp = sv_2mortal(newSViv(an_integer));
685
686
687 You should be careful about creating mortal variables.  Strange things
688 can happen if you make the same value mortal within multiple contexts,
689 or if you make a variable mortal multiple times. Thinking of "Mortalization"
690 as deferred C<SvREFCNT_dec> should help to minimize such problems.
691 For example if you are passing an SV which you I<know> has high enough REFCNT
692 to survive its use on the stack you need not do any mortalization.
693 If you are not sure then doing an C<SvREFCNT_inc> and C<sv_2mortal>, or
694 making a C<sv_mortalcopy> is safer.
695
696 The mortal routines are not just for SVs -- AVs and HVs can be
697 made mortal by passing their address (type-casted to C<SV*>) to the
698 C<sv_2mortal> or C<sv_mortalcopy> routines.
699
700 =head2 Stashes and Globs
701
702 A "stash" is a hash that contains all of the different objects that
703 are contained within a package.  Each key of the stash is a symbol
704 name (shared by all the different types of objects that have the same
705 name), and each value in the hash table is a GV (Glob Value).  This GV
706 in turn contains references to the various objects of that name,
707 including (but not limited to) the following:
708
709     Scalar Value
710     Array Value
711     Hash Value
712     I/O Handle
713     Format
714     Subroutine
715
716 There is a single stash called "PL_defstash" that holds the items that exist
717 in the "main" package.  To get at the items in other packages, append the
718 string "::" to the package name.  The items in the "Foo" package are in
719 the stash "Foo::" in PL_defstash.  The items in the "Bar::Baz" package are
720 in the stash "Baz::" in "Bar::"'s stash.
721
722 To get the stash pointer for a particular package, use the function:
723
724     HV*  gv_stashpv(const char* name, I32 create)
725     HV*  gv_stashsv(SV*, I32 create)
726
727 The first function takes a literal string, the second uses the string stored
728 in the SV.  Remember that a stash is just a hash table, so you get back an
729 C<HV*>.  The C<create> flag will create a new package if it is set.
730
731 The name that C<gv_stash*v> wants is the name of the package whose symbol table
732 you want.  The default package is called C<main>.  If you have multiply nested
733 packages, pass their names to C<gv_stash*v>, separated by C<::> as in the Perl
734 language itself.
735
736 Alternately, if you have an SV that is a blessed reference, you can find
737 out the stash pointer by using:
738
739     HV*  SvSTASH(SvRV(SV*));
740
741 then use the following to get the package name itself:
742
743     char*  HvNAME(HV* stash);
744
745 If you need to bless or re-bless an object you can use the following
746 function:
747
748     SV*  sv_bless(SV*, HV* stash)
749
750 where the first argument, an C<SV*>, must be a reference, and the second
751 argument is a stash.  The returned C<SV*> can now be used in the same way
752 as any other SV.
753
754 For more information on references and blessings, consult L<perlref>.
755
756 =head2 Double-Typed SVs
757
758 Scalar variables normally contain only one type of value, an integer,
759 double, pointer, or reference.  Perl will automatically convert the
760 actual scalar data from the stored type into the requested type.
761
762 Some scalar variables contain more than one type of scalar data.  For
763 example, the variable C<$!> contains either the numeric value of C<errno>
764 or its string equivalent from either C<strerror> or C<sys_errlist[]>.
765
766 To force multiple data values into an SV, you must do two things: use the
767 C<sv_set*v> routines to add the additional scalar type, then set a flag
768 so that Perl will believe it contains more than one type of data.  The
769 four macros to set the flags are:
770
771         SvIOK_on
772         SvNOK_on
773         SvPOK_on
774         SvROK_on
775
776 The particular macro you must use depends on which C<sv_set*v> routine
777 you called first.  This is because every C<sv_set*v> routine turns on
778 only the bit for the particular type of data being set, and turns off
779 all the rest.
780
781 For example, to create a new Perl variable called "dberror" that contains
782 both the numeric and descriptive string error values, you could use the
783 following code:
784
785     extern int  dberror;
786     extern char *dberror_list;
787
788     SV* sv = get_sv("dberror", TRUE);
789     sv_setiv(sv, (IV) dberror);
790     sv_setpv(sv, dberror_list[dberror]);
791     SvIOK_on(sv);
792
793 If the order of C<sv_setiv> and C<sv_setpv> had been reversed, then the
794 macro C<SvPOK_on> would need to be called instead of C<SvIOK_on>.
795
796 =head2 Magic Variables
797
798 [This section still under construction.  Ignore everything here.  Post no
799 bills.  Everything not permitted is forbidden.]
800
801 Any SV may be magical, that is, it has special features that a normal
802 SV does not have.  These features are stored in the SV structure in a
803 linked list of C<struct magic>'s, typedef'ed to C<MAGIC>.
804
805     struct magic {
806         MAGIC*      mg_moremagic;
807         MGVTBL*     mg_virtual;
808         U16         mg_private;
809         char        mg_type;
810         U8          mg_flags;
811         SV*         mg_obj;
812         char*       mg_ptr;
813         I32         mg_len;
814     };
815
816 Note this is current as of patchlevel 0, and could change at any time.
817
818 =head2 Assigning Magic
819
820 Perl adds magic to an SV using the sv_magic function:
821
822     void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen);
823
824 The C<sv> argument is a pointer to the SV that is to acquire a new magical
825 feature.
826
827 If C<sv> is not already magical, Perl uses the C<SvUPGRADE> macro to
828 convert C<sv> to type C<SVt_PVMG>. Perl then continues by adding new magic
829 to the beginning of the linked list of magical features.  Any prior entry
830 of the same type of magic is deleted.  Note that this can be overridden,
831 and multiple instances of the same type of magic can be associated with an
832 SV.
833
834 The C<name> and C<namlen> arguments are used to associate a string with
835 the magic, typically the name of a variable. C<namlen> is stored in the
836 C<mg_len> field and if C<name> is non-null and C<namlen> >= 0 a malloc'd
837 copy of the name is stored in C<mg_ptr> field.
838
839 The sv_magic function uses C<how> to determine which, if any, predefined
840 "Magic Virtual Table" should be assigned to the C<mg_virtual> field.
841 See the "Magic Virtual Table" section below.  The C<how> argument is also
842 stored in the C<mg_type> field. The value of C<how> should be chosen
843 from the set of macros C<PERL_MAGIC_foo> found perl.h. Note that before
844 these macros were added, Perl internals used to directly use character
845 literals, so you may occasionally come across old code or documentation
846 referrring to 'U' magic rather than C<PERL_MAGIC_uvar> for example.
847
848 The C<obj> argument is stored in the C<mg_obj> field of the C<MAGIC>
849 structure.  If it is not the same as the C<sv> argument, the reference
850 count of the C<obj> object is incremented.  If it is the same, or if
851 the C<how> argument is C<PERL_MAGIC_arylen>, or if it is a NULL pointer,
852 then C<obj> is merely stored, without the reference count being incremented.
853
854 There is also a function to add magic to an C<HV>:
855
856     void hv_magic(HV *hv, GV *gv, int how);
857
858 This simply calls C<sv_magic> and coerces the C<gv> argument into an C<SV>.
859
860 To remove the magic from an SV, call the function sv_unmagic:
861
862     void sv_unmagic(SV *sv, int type);
863
864 The C<type> argument should be equal to the C<how> value when the C<SV>
865 was initially made magical.
866
867 =head2 Magic Virtual Tables
868
869 The C<mg_virtual> field in the C<MAGIC> structure is a pointer to a
870 C<MGVTBL>, which is a structure of function pointers and stands for
871 "Magic Virtual Table" to handle the various operations that might be
872 applied to that variable.
873
874 The C<MGVTBL> has five pointers to the following routine types:
875
876     int  (*svt_get)(SV* sv, MAGIC* mg);
877     int  (*svt_set)(SV* sv, MAGIC* mg);
878     U32  (*svt_len)(SV* sv, MAGIC* mg);
879     int  (*svt_clear)(SV* sv, MAGIC* mg);
880     int  (*svt_free)(SV* sv, MAGIC* mg);
881
882 This MGVTBL structure is set at compile-time in C<perl.h> and there are
883 currently 19 types (or 21 with overloading turned on).  These different
884 structures contain pointers to various routines that perform additional
885 actions depending on which function is being called.
886
887     Function pointer    Action taken
888     ----------------    ------------
889     svt_get             Do something after the value of the SV is retrieved.
890     svt_set             Do something after the SV is assigned a value.
891     svt_len             Report on the SV's length.
892     svt_clear           Clear something the SV represents.
893     svt_free            Free any extra storage associated with the SV.
894
895 For instance, the MGVTBL structure called C<vtbl_sv> (which corresponds
896 to an C<mg_type> of C<PERL_MAGIC_sv>) contains:
897
898     { magic_get, magic_set, magic_len, 0, 0 }
899
900 Thus, when an SV is determined to be magical and of type C<PERL_MAGIC_sv>,
901 if a get operation is being performed, the routine C<magic_get> is
902 called.  All the various routines for the various magical types begin
903 with C<magic_>.  NOTE: the magic routines are not considered part of
904 the Perl API, and may not be exported by the Perl library.
905
906 The current kinds of Magic Virtual Tables are:
907
908     mg_type
909     (old-style char and macro)   MGVTBL         Type of magic
910     --------------------------   ------         ----------------------------
911     \0 PERL_MAGIC_sv             vtbl_sv        Special scalar variable
912     A  PERL_MAGIC_overload       vtbl_amagic    %OVERLOAD hash
913     a  PERL_MAGIC_overload_elem  vtbl_amagicelem %OVERLOAD hash element
914     c  PERL_MAGIC_overload_table (none)         Holds overload table (AMT)
915                                                 on stash
916     B  PERL_MAGIC_bm             vtbl_bm        Boyer-Moore (fast string search)
917     D  PERL_MAGIC_regdata        vtbl_regdata   Regex match position data
918                                                 (@+ and @- vars)
919     d  PERL_MAGIC_regdatum       vtbl_regdatum  Regex match position data
920                                                 element
921     E  PERL_MAGIC_env            vtbl_env       %ENV hash
922     e  PERL_MAGIC_envelem        vtbl_envelem   %ENV hash element
923     f  PERL_MAGIC_fm             vtbl_fm        Formline ('compiled' format)
924     g  PERL_MAGIC_regex_global   vtbl_mglob     m//g target / study()ed string
925     I  PERL_MAGIC_isa            vtbl_isa       @ISA array
926     i  PERL_MAGIC_isaelem        vtbl_isaelem   @ISA array element
927     k  PERL_MAGIC_nkeys          vtbl_nkeys     scalar(keys()) lvalue
928     L  PERL_MAGIC_dbfile         (none)         Debugger %_<filename
929     l  PERL_MAGIC_dbline         vtbl_dbline    Debugger %_<filename element
930     m  PERL_MAGIC_mutex          vtbl_mutex     ???
931     o  PERL_MAGIC_collxfrm       vtbl_collxfrm  Locale collate transformation
932     P  PERL_MAGIC_tied           vtbl_pack      Tied array or hash
933     p  PERL_MAGIC_tiedelem       vtbl_packelem  Tied array or hash element
934     q  PERL_MAGIC_tiedscalar     vtbl_packelem  Tied scalar or handle
935     r  PERL_MAGIC_qr             vtbl_qr        precompiled qr// regex
936     S  PERL_MAGIC_sig            vtbl_sig       %SIG hash
937     s  PERL_MAGIC_sigelem        vtbl_sigelem   %SIG hash element
938     t  PERL_MAGIC_taint          vtbl_taint     Taintedness
939     U  PERL_MAGIC_uvar           vtbl_uvar      Available for use by extensions
940     v  PERL_MAGIC_vec            vtbl_vec       vec() lvalue
941     x  PERL_MAGIC_substr         vtbl_substr    substr() lvalue
942     y  PERL_MAGIC_defelem        vtbl_defelem   Shadow "foreach" iterator
943                                                 variable / smart parameter
944                                                 vivification
945     *  PERL_MAGIC_glob           vtbl_glob      GV (typeglob)
946     #  PERL_MAGIC_arylen         vtbl_arylen    Array length ($#ary)
947     .  PERL_MAGIC_pos            vtbl_pos       pos() lvalue
948     <  PERL_MAGIC_backref        vtbl_backref   ???
949     ~  PERL_MAGIC_ext            (none)         Available for use by extensions
950
951 When an uppercase and lowercase letter both exist in the table, then the
952 uppercase letter is used to represent some kind of composite type (a list
953 or a hash), and the lowercase letter is used to represent an element of
954 that composite type. Some internals code makes use of this case
955 relationship.
956
957 The C<PERL_MAGIC_ext> and C<PERL_MAGIC_uvar> magic types are defined
958 specifically for use by extensions and will not be used by perl itself.
959 Extensions can use C<PERL_MAGIC_ext> magic to 'attach' private information
960 to variables (typically objects).  This is especially useful because
961 there is no way for normal perl code to corrupt this private information
962 (unlike using extra elements of a hash object).
963
964 Similarly, C<PERL_MAGIC_uvar> magic can be used much like tie() to call a
965 C function any time a scalar's value is used or changed.  The C<MAGIC>'s
966 C<mg_ptr> field points to a C<ufuncs> structure:
967
968     struct ufuncs {
969         I32 (*uf_val)(IV, SV*);
970         I32 (*uf_set)(IV, SV*);
971         IV uf_index;
972     };
973
974 When the SV is read from or written to, the C<uf_val> or C<uf_set>
975 function will be called with C<uf_index> as the first arg and a pointer to
976 the SV as the second.  A simple example of how to add C<PERL_MAGIC_uvar>
977 magic is shown below.  Note that the ufuncs structure is copied by
978 sv_magic, so you can safely allocate it on the stack.
979
980     void
981     Umagic(sv)
982         SV *sv;
983     PREINIT:
984         struct ufuncs uf;
985     CODE:
986         uf.uf_val   = &my_get_fn;
987         uf.uf_set   = &my_set_fn;
988         uf.uf_index = 0;
989         sv_magic(sv, 0, PERL_MAGIC_uvar, (char*)&uf, sizeof(uf));
990
991 Note that because multiple extensions may be using C<PERL_MAGIC_ext>
992 or C<PERL_MAGIC_uvar> magic, it is important for extensions to take
993 extra care to avoid conflict.  Typically only using the magic on
994 objects blessed into the same class as the extension is sufficient.
995 For C<PERL_MAGIC_ext> magic, it may also be appropriate to add an I32
996 'signature' at the top of the private data area and check that.
997
998 Also note that the C<sv_set*()> and C<sv_cat*()> functions described
999 earlier do B<not> invoke 'set' magic on their targets.  This must
1000 be done by the user either by calling the C<SvSETMAGIC()> macro after
1001 calling these functions, or by using one of the C<sv_set*_mg()> or
1002 C<sv_cat*_mg()> functions.  Similarly, generic C code must call the
1003 C<SvGETMAGIC()> macro to invoke any 'get' magic if they use an SV
1004 obtained from external sources in functions that don't handle magic.
1005 See L<perlapi> for a description of these functions.
1006 For example, calls to the C<sv_cat*()> functions typically need to be
1007 followed by C<SvSETMAGIC()>, but they don't need a prior C<SvGETMAGIC()>
1008 since their implementation handles 'get' magic.
1009
1010 =head2 Finding Magic
1011
1012     MAGIC* mg_find(SV*, int type); /* Finds the magic pointer of that type */
1013
1014 This routine returns a pointer to the C<MAGIC> structure stored in the SV.
1015 If the SV does not have that magical feature, C<NULL> is returned.  Also,
1016 if the SV is not of type SVt_PVMG, Perl may core dump.
1017
1018     int mg_copy(SV* sv, SV* nsv, const char* key, STRLEN klen);
1019
1020 This routine checks to see what types of magic C<sv> has.  If the mg_type
1021 field is an uppercase letter, then the mg_obj is copied to C<nsv>, but
1022 the mg_type field is changed to be the lowercase letter.
1023
1024 =head2 Understanding the Magic of Tied Hashes and Arrays
1025
1026 Tied hashes and arrays are magical beasts of the C<PERL_MAGIC_tied>
1027 magic type.
1028
1029 WARNING: As of the 5.004 release, proper usage of the array and hash
1030 access functions requires understanding a few caveats.  Some
1031 of these caveats are actually considered bugs in the API, to be fixed
1032 in later releases, and are bracketed with [MAYCHANGE] below. If
1033 you find yourself actually applying such information in this section, be
1034 aware that the behavior may change in the future, umm, without warning.
1035
1036 The perl tie function associates a variable with an object that implements
1037 the various GET, SET etc methods.  To perform the equivalent of the perl
1038 tie function from an XSUB, you must mimic this behaviour.  The code below
1039 carries out the necessary steps - firstly it creates a new hash, and then
1040 creates a second hash which it blesses into the class which will implement
1041 the tie methods. Lastly it ties the two hashes together, and returns a
1042 reference to the new tied hash.  Note that the code below does NOT call the
1043 TIEHASH method in the MyTie class -
1044 see L<Calling Perl Routines from within C Programs> for details on how
1045 to do this.
1046
1047     SV*
1048     mytie()
1049     PREINIT:
1050         HV *hash;
1051         HV *stash;
1052         SV *tie;
1053     CODE:
1054         hash = newHV();
1055         tie = newRV_noinc((SV*)newHV());
1056         stash = gv_stashpv("MyTie", TRUE);
1057         sv_bless(tie, stash);
1058         hv_magic(hash, (GV*)tie, PERL_MAGIC_tied);
1059         RETVAL = newRV_noinc(hash);
1060     OUTPUT:
1061         RETVAL
1062
1063 The C<av_store> function, when given a tied array argument, merely
1064 copies the magic of the array onto the value to be "stored", using
1065 C<mg_copy>.  It may also return NULL, indicating that the value did not
1066 actually need to be stored in the array.  [MAYCHANGE] After a call to
1067 C<av_store> on a tied array, the caller will usually need to call
1068 C<mg_set(val)> to actually invoke the perl level "STORE" method on the
1069 TIEARRAY object.  If C<av_store> did return NULL, a call to
1070 C<SvREFCNT_dec(val)> will also be usually necessary to avoid a memory
1071 leak. [/MAYCHANGE]
1072
1073 The previous paragraph is applicable verbatim to tied hash access using the
1074 C<hv_store> and C<hv_store_ent> functions as well.
1075
1076 C<av_fetch> and the corresponding hash functions C<hv_fetch> and
1077 C<hv_fetch_ent> actually return an undefined mortal value whose magic
1078 has been initialized using C<mg_copy>.  Note the value so returned does not
1079 need to be deallocated, as it is already mortal.  [MAYCHANGE] But you will
1080 need to call C<mg_get()> on the returned value in order to actually invoke
1081 the perl level "FETCH" method on the underlying TIE object.  Similarly,
1082 you may also call C<mg_set()> on the return value after possibly assigning
1083 a suitable value to it using C<sv_setsv>,  which will invoke the "STORE"
1084 method on the TIE object. [/MAYCHANGE]
1085
1086 [MAYCHANGE]
1087 In other words, the array or hash fetch/store functions don't really
1088 fetch and store actual values in the case of tied arrays and hashes.  They
1089 merely call C<mg_copy> to attach magic to the values that were meant to be
1090 "stored" or "fetched".  Later calls to C<mg_get> and C<mg_set> actually
1091 do the job of invoking the TIE methods on the underlying objects.  Thus
1092 the magic mechanism currently implements a kind of lazy access to arrays
1093 and hashes.
1094
1095 Currently (as of perl version 5.004), use of the hash and array access
1096 functions requires the user to be aware of whether they are operating on
1097 "normal" hashes and arrays, or on their tied variants.  The API may be
1098 changed to provide more transparent access to both tied and normal data
1099 types in future versions.
1100 [/MAYCHANGE]
1101
1102 You would do well to understand that the TIEARRAY and TIEHASH interfaces
1103 are mere sugar to invoke some perl method calls while using the uniform hash
1104 and array syntax.  The use of this sugar imposes some overhead (typically
1105 about two to four extra opcodes per FETCH/STORE operation, in addition to
1106 the creation of all the mortal variables required to invoke the methods).
1107 This overhead will be comparatively small if the TIE methods are themselves
1108 substantial, but if they are only a few statements long, the overhead
1109 will not be insignificant.
1110
1111 =head2 Localizing changes
1112
1113 Perl has a very handy construction
1114
1115   {
1116     local $var = 2;
1117     ...
1118   }
1119
1120 This construction is I<approximately> equivalent to
1121
1122   {
1123     my $oldvar = $var;
1124     $var = 2;
1125     ...
1126     $var = $oldvar;
1127   }
1128
1129 The biggest difference is that the first construction would
1130 reinstate the initial value of $var, irrespective of how control exits
1131 the block: C<goto>, C<return>, C<die>/C<eval> etc. It is a little bit
1132 more efficient as well.
1133
1134 There is a way to achieve a similar task from C via Perl API: create a
1135 I<pseudo-block>, and arrange for some changes to be automatically
1136 undone at the end of it, either explicit, or via a non-local exit (via
1137 die()). A I<block>-like construct is created by a pair of
1138 C<ENTER>/C<LEAVE> macros (see L<perlcall/"Returning a Scalar">).
1139 Such a construct may be created specially for some important localized
1140 task, or an existing one (like boundaries of enclosing Perl
1141 subroutine/block, or an existing pair for freeing TMPs) may be
1142 used. (In the second case the overhead of additional localization must
1143 be almost negligible.) Note that any XSUB is automatically enclosed in
1144 an C<ENTER>/C<LEAVE> pair.
1145
1146 Inside such a I<pseudo-block> the following service is available:
1147
1148 =over 4
1149
1150 =item C<SAVEINT(int i)>
1151
1152 =item C<SAVEIV(IV i)>
1153
1154 =item C<SAVEI32(I32 i)>
1155
1156 =item C<SAVELONG(long i)>
1157
1158 These macros arrange things to restore the value of integer variable
1159 C<i> at the end of enclosing I<pseudo-block>.
1160
1161 =item C<SAVESPTR(s)>
1162
1163 =item C<SAVEPPTR(p)>
1164
1165 These macros arrange things to restore the value of pointers C<s> and
1166 C<p>. C<s> must be a pointer of a type which survives conversion to
1167 C<SV*> and back, C<p> should be able to survive conversion to C<char*>
1168 and back.
1169
1170 =item C<SAVEFREESV(SV *sv)>
1171
1172 The refcount of C<sv> would be decremented at the end of
1173 I<pseudo-block>.  This is similar to C<sv_2mortal> in that it is also a
1174 mechanism for doing a delayed C<SvREFCNT_dec>.  However, while C<sv_2mortal>
1175 extends the lifetime of C<sv> until the beginning of the next statement,
1176 C<SAVEFREESV> extends it until the end of the enclosing scope.  These
1177 lifetimes can be wildly different.
1178
1179 Also compare C<SAVEMORTALIZESV>.
1180
1181 =item C<SAVEMORTALIZESV(SV *sv)>
1182
1183 Just like C<SAVEFREESV>, but mortalizes C<sv> at the end of the current
1184 scope instead of decrementing its reference count.  This usually has the
1185 effect of keeping C<sv> alive until the statement that called the currently
1186 live scope has finished executing.
1187
1188 =item C<SAVEFREEOP(OP *op)>
1189
1190 The C<OP *> is op_free()ed at the end of I<pseudo-block>.
1191
1192 =item C<SAVEFREEPV(p)>
1193
1194 The chunk of memory which is pointed to by C<p> is Safefree()ed at the
1195 end of I<pseudo-block>.
1196
1197 =item C<SAVECLEARSV(SV *sv)>
1198
1199 Clears a slot in the current scratchpad which corresponds to C<sv> at
1200 the end of I<pseudo-block>.
1201
1202 =item C<SAVEDELETE(HV *hv, char *key, I32 length)>
1203
1204 The key C<key> of C<hv> is deleted at the end of I<pseudo-block>. The
1205 string pointed to by C<key> is Safefree()ed.  If one has a I<key> in
1206 short-lived storage, the corresponding string may be reallocated like
1207 this:
1208
1209   SAVEDELETE(PL_defstash, savepv(tmpbuf), strlen(tmpbuf));
1210
1211 =item C<SAVEDESTRUCTOR(DESTRUCTORFUNC_NOCONTEXT_t f, void *p)>
1212
1213 At the end of I<pseudo-block> the function C<f> is called with the
1214 only argument C<p>.
1215
1216 =item C<SAVEDESTRUCTOR_X(DESTRUCTORFUNC_t f, void *p)>
1217
1218 At the end of I<pseudo-block> the function C<f> is called with the
1219 implicit context argument (if any), and C<p>.
1220
1221 =item C<SAVESTACK_POS()>
1222
1223 The current offset on the Perl internal stack (cf. C<SP>) is restored
1224 at the end of I<pseudo-block>.
1225
1226 =back
1227
1228 The following API list contains functions, thus one needs to
1229 provide pointers to the modifiable data explicitly (either C pointers,
1230 or Perlish C<GV *>s).  Where the above macros take C<int>, a similar
1231 function takes C<int *>.
1232
1233 =over 4
1234
1235 =item C<SV* save_scalar(GV *gv)>
1236
1237 Equivalent to Perl code C<local $gv>.
1238
1239 =item C<AV* save_ary(GV *gv)>
1240
1241 =item C<HV* save_hash(GV *gv)>
1242
1243 Similar to C<save_scalar>, but localize C<@gv> and C<%gv>.
1244
1245 =item C<void save_item(SV *item)>
1246
1247 Duplicates the current value of C<SV>, on the exit from the current
1248 C<ENTER>/C<LEAVE> I<pseudo-block> will restore the value of C<SV>
1249 using the stored value.
1250
1251 =item C<void save_list(SV **sarg, I32 maxsarg)>
1252
1253 A variant of C<save_item> which takes multiple arguments via an array
1254 C<sarg> of C<SV*> of length C<maxsarg>.
1255
1256 =item C<SV* save_svref(SV **sptr)>
1257
1258 Similar to C<save_scalar>, but will reinstate a C<SV *>.
1259
1260 =item C<void save_aptr(AV **aptr)>
1261
1262 =item C<void save_hptr(HV **hptr)>
1263
1264 Similar to C<save_svref>, but localize C<AV *> and C<HV *>.
1265
1266 =back
1267
1268 The C<Alias> module implements localization of the basic types within the
1269 I<caller's scope>.  People who are interested in how to localize things in
1270 the containing scope should take a look there too.
1271
1272 =head1 Subroutines
1273
1274 =head2 XSUBs and the Argument Stack
1275
1276 The XSUB mechanism is a simple way for Perl programs to access C subroutines.
1277 An XSUB routine will have a stack that contains the arguments from the Perl
1278 program, and a way to map from the Perl data structures to a C equivalent.
1279
1280 The stack arguments are accessible through the C<ST(n)> macro, which returns
1281 the C<n>'th stack argument.  Argument 0 is the first argument passed in the
1282 Perl subroutine call.  These arguments are C<SV*>, and can be used anywhere
1283 an C<SV*> is used.
1284
1285 Most of the time, output from the C routine can be handled through use of
1286 the RETVAL and OUTPUT directives.  However, there are some cases where the
1287 argument stack is not already long enough to handle all the return values.
1288 An example is the POSIX tzname() call, which takes no arguments, but returns
1289 two, the local time zone's standard and summer time abbreviations.
1290
1291 To handle this situation, the PPCODE directive is used and the stack is
1292 extended using the macro:
1293
1294     EXTEND(SP, num);
1295
1296 where C<SP> is the macro that represents the local copy of the stack pointer,
1297 and C<num> is the number of elements the stack should be extended by.
1298
1299 Now that there is room on the stack, values can be pushed on it using C<PUSHs>
1300 macro. The values pushed will often need to be "mortal" (See L</Reference Counts and Mortality>).
1301
1302     PUSHs(sv_2mortal(newSViv(an_integer)))
1303     PUSHs(sv_2mortal(newSVpv("Some String",0)))
1304     PUSHs(sv_2mortal(newSVnv(3.141592)))
1305
1306 And now the Perl program calling C<tzname>, the two values will be assigned
1307 as in:
1308
1309     ($standard_abbrev, $summer_abbrev) = POSIX::tzname;
1310
1311 An alternate (and possibly simpler) method to pushing values on the stack is
1312 to use the macro:
1313
1314     XPUSHs(SV*)
1315
1316 This macro automatically adjust the stack for you, if needed.  Thus, you
1317 do not need to call C<EXTEND> to extend the stack.
1318
1319 Despite their suggestions in earlier versions of this document the macros
1320 C<PUSHi>, C<PUSHn> and C<PUSHp> are I<not> suited to XSUBs which return
1321 multiple results, see L</Putting a C value on Perl stack>.
1322
1323 For more information, consult L<perlxs> and L<perlxstut>.
1324
1325 =head2 Calling Perl Routines from within C Programs
1326
1327 There are four routines that can be used to call a Perl subroutine from
1328 within a C program.  These four are:
1329
1330     I32  call_sv(SV*, I32);
1331     I32  call_pv(const char*, I32);
1332     I32  call_method(const char*, I32);
1333     I32  call_argv(const char*, I32, register char**);
1334
1335 The routine most often used is C<call_sv>.  The C<SV*> argument
1336 contains either the name of the Perl subroutine to be called, or a
1337 reference to the subroutine.  The second argument consists of flags
1338 that control the context in which the subroutine is called, whether
1339 or not the subroutine is being passed arguments, how errors should be
1340 trapped, and how to treat return values.
1341
1342 All four routines return the number of arguments that the subroutine returned
1343 on the Perl stack.
1344
1345 These routines used to be called C<perl_call_sv> etc., before Perl v5.6.0,
1346 but those names are now deprecated; macros of the same name are provided for
1347 compatibility.
1348
1349 When using any of these routines (except C<call_argv>), the programmer
1350 must manipulate the Perl stack.  These include the following macros and
1351 functions:
1352
1353     dSP
1354     SP
1355     PUSHMARK()
1356     PUTBACK
1357     SPAGAIN
1358     ENTER
1359     SAVETMPS
1360     FREETMPS
1361     LEAVE
1362     XPUSH*()
1363     POP*()
1364
1365 For a detailed description of calling conventions from C to Perl,
1366 consult L<perlcall>.
1367
1368 =head2 Memory Allocation
1369
1370 All memory meant to be used with the Perl API functions should be manipulated
1371 using the macros described in this section.  The macros provide the necessary
1372 transparency between differences in the actual malloc implementation that is
1373 used within perl.
1374
1375 It is suggested that you enable the version of malloc that is distributed
1376 with Perl.  It keeps pools of various sizes of unallocated memory in
1377 order to satisfy allocation requests more quickly.  However, on some
1378 platforms, it may cause spurious malloc or free errors.
1379
1380     New(x, pointer, number, type);
1381     Newc(x, pointer, number, type, cast);
1382     Newz(x, pointer, number, type);
1383
1384 These three macros are used to initially allocate memory.
1385
1386 The first argument C<x> was a "magic cookie" that was used to keep track
1387 of who called the macro, to help when debugging memory problems.  However,
1388 the current code makes no use of this feature (most Perl developers now
1389 use run-time memory checkers), so this argument can be any number.
1390
1391 The second argument C<pointer> should be the name of a variable that will
1392 point to the newly allocated memory.
1393
1394 The third and fourth arguments C<number> and C<type> specify how many of
1395 the specified type of data structure should be allocated.  The argument
1396 C<type> is passed to C<sizeof>.  The final argument to C<Newc>, C<cast>,
1397 should be used if the C<pointer> argument is different from the C<type>
1398 argument.
1399
1400 Unlike the C<New> and C<Newc> macros, the C<Newz> macro calls C<memzero>
1401 to zero out all the newly allocated memory.
1402
1403     Renew(pointer, number, type);
1404     Renewc(pointer, number, type, cast);
1405     Safefree(pointer)
1406
1407 These three macros are used to change a memory buffer size or to free a
1408 piece of memory no longer needed.  The arguments to C<Renew> and C<Renewc>
1409 match those of C<New> and C<Newc> with the exception of not needing the
1410 "magic cookie" argument.
1411
1412     Move(source, dest, number, type);
1413     Copy(source, dest, number, type);
1414     Zero(dest, number, type);
1415
1416 These three macros are used to move, copy, or zero out previously allocated
1417 memory.  The C<source> and C<dest> arguments point to the source and
1418 destination starting points.  Perl will move, copy, or zero out C<number>
1419 instances of the size of the C<type> data structure (using the C<sizeof>
1420 function).
1421
1422 =head2 PerlIO
1423
1424 The most recent development releases of Perl has been experimenting with
1425 removing Perl's dependency on the "normal" standard I/O suite and allowing
1426 other stdio implementations to be used.  This involves creating a new
1427 abstraction layer that then calls whichever implementation of stdio Perl
1428 was compiled with.  All XSUBs should now use the functions in the PerlIO
1429 abstraction layer and not make any assumptions about what kind of stdio
1430 is being used.
1431
1432 For a complete description of the PerlIO abstraction, consult L<perlapio>.
1433
1434 =head2 Putting a C value on Perl stack
1435
1436 A lot of opcodes (this is an elementary operation in the internal perl
1437 stack machine) put an SV* on the stack. However, as an optimization
1438 the corresponding SV is (usually) not recreated each time. The opcodes
1439 reuse specially assigned SVs (I<target>s) which are (as a corollary)
1440 not constantly freed/created.
1441
1442 Each of the targets is created only once (but see
1443 L<Scratchpads and recursion> below), and when an opcode needs to put
1444 an integer, a double, or a string on stack, it just sets the
1445 corresponding parts of its I<target> and puts the I<target> on stack.
1446
1447 The macro to put this target on stack is C<PUSHTARG>, and it is
1448 directly used in some opcodes, as well as indirectly in zillions of
1449 others, which use it via C<(X)PUSH[pni]>.
1450
1451 Because the target is reused, you must be careful when pushing multiple
1452 values on the stack. The following code will not do what you think:
1453
1454     XPUSHi(10);
1455     XPUSHi(20);
1456
1457 This translates as "set C<TARG> to 10, push a pointer to C<TARG> onto
1458 the stack; set C<TARG> to 20, push a pointer to C<TARG> onto the stack".
1459 At the end of the operation, the stack does not contain the values 10
1460 and 20, but actually contains two pointers to C<TARG>, which we have set
1461 to 20. If you need to push multiple different values, use C<XPUSHs>,
1462 which bypasses C<TARG>.
1463
1464 On a related note, if you do use C<(X)PUSH[npi]>, then you're going to
1465 need a C<dTARG> in your variable declarations so that the C<*PUSH*>
1466 macros can make use of the local variable C<TARG>.
1467
1468 =head2 Scratchpads
1469
1470 The question remains on when the SVs which are I<target>s for opcodes
1471 are created. The answer is that they are created when the current unit --
1472 a subroutine or a file (for opcodes for statements outside of
1473 subroutines) -- is compiled. During this time a special anonymous Perl
1474 array is created, which is called a scratchpad for the current
1475 unit.
1476
1477 A scratchpad keeps SVs which are lexicals for the current unit and are
1478 targets for opcodes. One can deduce that an SV lives on a scratchpad
1479 by looking on its flags: lexicals have C<SVs_PADMY> set, and
1480 I<target>s have C<SVs_PADTMP> set.
1481
1482 The correspondence between OPs and I<target>s is not 1-to-1. Different
1483 OPs in the compile tree of the unit can use the same target, if this
1484 would not conflict with the expected life of the temporary.
1485
1486 =head2 Scratchpads and recursion
1487
1488 In fact it is not 100% true that a compiled unit contains a pointer to
1489 the scratchpad AV. In fact it contains a pointer to an AV of
1490 (initially) one element, and this element is the scratchpad AV. Why do
1491 we need an extra level of indirection?
1492
1493 The answer is B<recursion>, and maybe (sometime soon) B<threads>. Both
1494 these can create several execution pointers going into the same
1495 subroutine. For the subroutine-child not write over the temporaries
1496 for the subroutine-parent (lifespan of which covers the call to the
1497 child), the parent and the child should have different
1498 scratchpads. (I<And> the lexicals should be separate anyway!)
1499
1500 So each subroutine is born with an array of scratchpads (of length 1).
1501 On each entry to the subroutine it is checked that the current
1502 depth of the recursion is not more than the length of this array, and
1503 if it is, new scratchpad is created and pushed into the array.
1504
1505 The I<target>s on this scratchpad are C<undef>s, but they are already
1506 marked with correct flags.
1507
1508 =head1 Compiled code
1509
1510 =head2 Code tree
1511
1512 Here we describe the internal form your code is converted to by
1513 Perl. Start with a simple example:
1514
1515   $a = $b + $c;
1516
1517 This is converted to a tree similar to this one:
1518
1519              assign-to
1520            /           \
1521           +             $a
1522         /   \
1523       $b     $c
1524
1525 (but slightly more complicated).  This tree reflects the way Perl
1526 parsed your code, but has nothing to do with the execution order.
1527 There is an additional "thread" going through the nodes of the tree
1528 which shows the order of execution of the nodes.  In our simplified
1529 example above it looks like:
1530
1531      $b ---> $c ---> + ---> $a ---> assign-to
1532
1533 But with the actual compile tree for C<$a = $b + $c> it is different:
1534 some nodes I<optimized away>.  As a corollary, though the actual tree
1535 contains more nodes than our simplified example, the execution order
1536 is the same as in our example.
1537
1538 =head2 Examining the tree
1539
1540 If you have your perl compiled for debugging (usually done with C<-D
1541 optimize=-g> on C<Configure> command line), you may examine the
1542 compiled tree by specifying C<-Dx> on the Perl command line.  The
1543 output takes several lines per node, and for C<$b+$c> it looks like
1544 this:
1545
1546     5           TYPE = add  ===> 6
1547                 TARG = 1
1548                 FLAGS = (SCALAR,KIDS)
1549                 {
1550                     TYPE = null  ===> (4)
1551                       (was rv2sv)
1552                     FLAGS = (SCALAR,KIDS)
1553                     {
1554     3                   TYPE = gvsv  ===> 4
1555                         FLAGS = (SCALAR)
1556                         GV = main::b
1557                     }
1558                 }
1559                 {
1560                     TYPE = null  ===> (5)
1561                       (was rv2sv)
1562                     FLAGS = (SCALAR,KIDS)
1563                     {
1564     4                   TYPE = gvsv  ===> 5
1565                         FLAGS = (SCALAR)
1566                         GV = main::c
1567                     }
1568                 }
1569
1570 This tree has 5 nodes (one per C<TYPE> specifier), only 3 of them are
1571 not optimized away (one per number in the left column).  The immediate
1572 children of the given node correspond to C<{}> pairs on the same level
1573 of indentation, thus this listing corresponds to the tree:
1574
1575                    add
1576                  /     \
1577                null    null
1578                 |       |
1579                gvsv    gvsv
1580
1581 The execution order is indicated by C<===E<gt>> marks, thus it is C<3
1582 4 5 6> (node C<6> is not included into above listing), i.e.,
1583 C<gvsv gvsv add whatever>.
1584
1585 Each of these nodes represents an op, a fundamental operation inside the
1586 Perl core. The code which implements each operation can be found in the
1587 F<pp*.c> files; the function which implements the op with type C<gvsv>
1588 is C<pp_gvsv>, and so on. As the tree above shows, different ops have
1589 different numbers of children: C<add> is a binary operator, as one would
1590 expect, and so has two children. To accommodate the various different
1591 numbers of children, there are various types of op data structure, and
1592 they link together in different ways.
1593
1594 The simplest type of op structure is C<OP>: this has no children. Unary
1595 operators, C<UNOP>s, have one child, and this is pointed to by the
1596 C<op_first> field. Binary operators (C<BINOP>s) have not only an
1597 C<op_first> field but also an C<op_last> field. The most complex type of
1598 op is a C<LISTOP>, which has any number of children. In this case, the
1599 first child is pointed to by C<op_first> and the last child by
1600 C<op_last>. The children in between can be found by iteratively
1601 following the C<op_sibling> pointer from the first child to the last.
1602
1603 There are also two other op types: a C<PMOP> holds a regular expression,
1604 and has no children, and a C<LOOP> may or may not have children. If the
1605 C<op_children> field is non-zero, it behaves like a C<LISTOP>. To
1606 complicate matters, if a C<UNOP> is actually a C<null> op after
1607 optimization (see L</Compile pass 2: context propagation>) it will still
1608 have children in accordance with its former type.
1609
1610 =head2 Compile pass 1: check routines
1611
1612 The tree is created by the compiler while I<yacc> code feeds it
1613 the constructions it recognizes. Since I<yacc> works bottom-up, so does
1614 the first pass of perl compilation.
1615
1616 What makes this pass interesting for perl developers is that some
1617 optimization may be performed on this pass.  This is optimization by
1618 so-called "check routines".  The correspondence between node names
1619 and corresponding check routines is described in F<opcode.pl> (do not
1620 forget to run C<make regen_headers> if you modify this file).
1621
1622 A check routine is called when the node is fully constructed except
1623 for the execution-order thread.  Since at this time there are no
1624 back-links to the currently constructed node, one can do most any
1625 operation to the top-level node, including freeing it and/or creating
1626 new nodes above/below it.
1627
1628 The check routine returns the node which should be inserted into the
1629 tree (if the top-level node was not modified, check routine returns
1630 its argument).
1631
1632 By convention, check routines have names C<ck_*>. They are usually
1633 called from C<new*OP> subroutines (or C<convert>) (which in turn are
1634 called from F<perly.y>).
1635
1636 =head2 Compile pass 1a: constant folding
1637
1638 Immediately after the check routine is called the returned node is
1639 checked for being compile-time executable.  If it is (the value is
1640 judged to be constant) it is immediately executed, and a I<constant>
1641 node with the "return value" of the corresponding subtree is
1642 substituted instead.  The subtree is deleted.
1643
1644 If constant folding was not performed, the execution-order thread is
1645 created.
1646
1647 =head2 Compile pass 2: context propagation
1648
1649 When a context for a part of compile tree is known, it is propagated
1650 down through the tree.  At this time the context can have 5 values
1651 (instead of 2 for runtime context): void, boolean, scalar, list, and
1652 lvalue.  In contrast with the pass 1 this pass is processed from top
1653 to bottom: a node's context determines the context for its children.
1654
1655 Additional context-dependent optimizations are performed at this time.
1656 Since at this moment the compile tree contains back-references (via
1657 "thread" pointers), nodes cannot be free()d now.  To allow
1658 optimized-away nodes at this stage, such nodes are null()ified instead
1659 of free()ing (i.e. their type is changed to OP_NULL).
1660
1661 =head2 Compile pass 3: peephole optimization
1662
1663 After the compile tree for a subroutine (or for an C<eval> or a file)
1664 is created, an additional pass over the code is performed. This pass
1665 is neither top-down or bottom-up, but in the execution order (with
1666 additional complications for conditionals).  These optimizations are
1667 done in the subroutine peep().  Optimizations performed at this stage
1668 are subject to the same restrictions as in the pass 2.
1669
1670 =head2 Pluggable runops
1671
1672 The compile tree is executed in a runops function.  There are two runops
1673 functions in F<run.c>.  C<Perl_runops_debug> is used with DEBUGGING and
1674 C<Perl_runops_standard> is used otherwise.  For fine control over the
1675 execution of the compile tree it is possible to provide your own runops
1676 function.
1677
1678 It's probably best to copy one of the existing runops functions and
1679 change it to suit your needs.  Then, in the BOOT section of your XS
1680 file, add the line:
1681
1682   PL_runops = my_runops;
1683
1684 This function should be as efficient as possible to keep your programs
1685 running as fast as possible.
1686
1687 =head1 Examining internal data structures with the C<dump> functions
1688
1689 To aid debugging, the source file F<dump.c> contains a number of
1690 functions which produce formatted output of internal data structures.
1691
1692 The most commonly used of these functions is C<Perl_sv_dump>; it's used
1693 for dumping SVs, AVs, HVs, and CVs. The C<Devel::Peek> module calls
1694 C<sv_dump> to produce debugging output from Perl-space, so users of that
1695 module should already be familiar with its format.
1696
1697 C<Perl_op_dump> can be used to dump an C<OP> structure or any of its
1698 derivatives, and produces output similiar to C<perl -Dx>; in fact,
1699 C<Perl_dump_eval> will dump the main root of the code being evaluated,
1700 exactly like C<-Dx>.
1701
1702 Other useful functions are C<Perl_dump_sub>, which turns a C<GV> into an
1703 op tree, C<Perl_dump_packsubs> which calls C<Perl_dump_sub> on all the
1704 subroutines in a package like so: (Thankfully, these are all xsubs, so
1705 there is no op tree)
1706
1707     (gdb) print Perl_dump_packsubs(PL_defstash)
1708
1709     SUB attributes::bootstrap = (xsub 0x811fedc 0)
1710
1711     SUB UNIVERSAL::can = (xsub 0x811f50c 0)
1712
1713     SUB UNIVERSAL::isa = (xsub 0x811f304 0)
1714
1715     SUB UNIVERSAL::VERSION = (xsub 0x811f7ac 0)
1716
1717     SUB DynaLoader::boot_DynaLoader = (xsub 0x805b188 0)
1718
1719 and C<Perl_dump_all>, which dumps all the subroutines in the stash and
1720 the op tree of the main root.
1721
1722 =head1 How multiple interpreters and concurrency are supported
1723
1724 =head2 Background and PERL_IMPLICIT_CONTEXT
1725
1726 The Perl interpreter can be regarded as a closed box: it has an API
1727 for feeding it code or otherwise making it do things, but it also has
1728 functions for its own use.  This smells a lot like an object, and
1729 there are ways for you to build Perl so that you can have multiple
1730 interpreters, with one interpreter represented either as a C++ object,
1731 a C structure, or inside a thread.  The thread, the C structure, or
1732 the C++ object will contain all the context, the state of that
1733 interpreter.
1734
1735 Three macros control the major Perl build flavors: MULTIPLICITY,
1736 USE_THREADS and PERL_OBJECT.  The MULTIPLICITY build has a C structure
1737 that packages all the interpreter state, there is a similar thread-specific
1738 data structure under USE_THREADS, and the (now deprecated) PERL_OBJECT
1739 build has a C++ class to maintain interpreter state.  In all three cases,
1740 PERL_IMPLICIT_CONTEXT is also normally defined, and enables the
1741 support for passing in a "hidden" first argument that represents all three
1742 data structures.
1743
1744 All this obviously requires a way for the Perl internal functions to be
1745 C++ methods, subroutines taking some kind of structure as the first
1746 argument, or subroutines taking nothing as the first argument.  To
1747 enable these three very different ways of building the interpreter,
1748 the Perl source (as it does in so many other situations) makes heavy
1749 use of macros and subroutine naming conventions.
1750
1751 First problem: deciding which functions will be public API functions and
1752 which will be private.  All functions whose names begin C<S_> are private
1753 (think "S" for "secret" or "static").  All other functions begin with
1754 "Perl_", but just because a function begins with "Perl_" does not mean it is
1755 part of the API. (See L</Internal Functions>.) The easiest way to be B<sure> a
1756 function is part of the API is to find its entry in L<perlapi>.
1757 If it exists in L<perlapi>, it's part of the API.  If it doesn't, and you
1758 think it should be (i.e., you need it for your extension), send mail via
1759 L<perlbug> explaining why you think it should be.
1760
1761 Second problem: there must be a syntax so that the same subroutine
1762 declarations and calls can pass a structure as their first argument,
1763 or pass nothing.  To solve this, the subroutines are named and
1764 declared in a particular way.  Here's a typical start of a static
1765 function used within the Perl guts:
1766
1767   STATIC void
1768   S_incline(pTHX_ char *s)
1769
1770 STATIC becomes "static" in C, and is #define'd to nothing in C++.
1771
1772 A public function (i.e. part of the internal API, but not necessarily
1773 sanctioned for use in extensions) begins like this:
1774
1775   void
1776   Perl_sv_setsv(pTHX_ SV* dsv, SV* ssv)
1777
1778 C<pTHX_> is one of a number of macros (in perl.h) that hide the
1779 details of the interpreter's context.  THX stands for "thread", "this",
1780 or "thingy", as the case may be.  (And no, George Lucas is not involved. :-)
1781 The first character could be 'p' for a B<p>rototype, 'a' for B<a>rgument,
1782 or 'd' for B<d>eclaration, so we have C<pTHX>, C<aTHX> and C<dTHX>, and
1783 their variants.
1784
1785 When Perl is built without options that set PERL_IMPLICIT_CONTEXT, there is no
1786 first argument containing the interpreter's context.  The trailing underscore
1787 in the pTHX_ macro indicates that the macro expansion needs a comma
1788 after the context argument because other arguments follow it.  If
1789 PERL_IMPLICIT_CONTEXT is not defined, pTHX_ will be ignored, and the
1790 subroutine is not prototyped to take the extra argument.  The form of the
1791 macro without the trailing underscore is used when there are no additional
1792 explicit arguments.
1793
1794 When a core function calls another, it must pass the context.  This
1795 is normally hidden via macros.  Consider C<sv_setsv>.  It expands into
1796 something like this:
1797
1798     ifdef PERL_IMPLICIT_CONTEXT
1799       define sv_setsv(a,b)      Perl_sv_setsv(aTHX_ a, b)
1800       /* can't do this for vararg functions, see below */
1801     else
1802       define sv_setsv           Perl_sv_setsv
1803     endif
1804
1805 This works well, and means that XS authors can gleefully write:
1806
1807     sv_setsv(foo, bar);
1808
1809 and still have it work under all the modes Perl could have been
1810 compiled with.
1811
1812 Under PERL_OBJECT in the core, that will translate to either:
1813
1814     CPerlObj::Perl_sv_setsv(foo,bar);  # in CPerlObj functions,
1815                                        # C++ takes care of 'this'
1816   or
1817
1818     pPerl->Perl_sv_setsv(foo,bar);     # in truly static functions,
1819                                        # see objXSUB.h
1820
1821 Under PERL_OBJECT in extensions (aka PERL_CAPI), or under
1822 MULTIPLICITY/USE_THREADS with PERL_IMPLICIT_CONTEXT in both core
1823 and extensions, it will become:
1824
1825     Perl_sv_setsv(aTHX_ foo, bar);     # the canonical Perl "API"
1826                                        # for all build flavors
1827
1828 This doesn't work so cleanly for varargs functions, though, as macros
1829 imply that the number of arguments is known in advance.  Instead we
1830 either need to spell them out fully, passing C<aTHX_> as the first
1831 argument (the Perl core tends to do this with functions like
1832 Perl_warner), or use a context-free version.
1833
1834 The context-free version of Perl_warner is called
1835 Perl_warner_nocontext, and does not take the extra argument.  Instead
1836 it does dTHX; to get the context from thread-local storage.  We
1837 C<#define warner Perl_warner_nocontext> so that extensions get source
1838 compatibility at the expense of performance.  (Passing an arg is
1839 cheaper than grabbing it from thread-local storage.)
1840
1841 You can ignore [pad]THX[xo] when browsing the Perl headers/sources.
1842 Those are strictly for use within the core.  Extensions and embedders
1843 need only be aware of [pad]THX.
1844
1845 =head2 So what happened to dTHR?
1846
1847 C<dTHR> was introduced in perl 5.005 to support the older thread model.
1848 The older thread model now uses the C<THX> mechanism to pass context
1849 pointers around, so C<dTHR> is not useful any more.  Perl 5.6.0 and
1850 later still have it for backward source compatibility, but it is defined
1851 to be a no-op.
1852
1853 =head2 How do I use all this in extensions?
1854
1855 When Perl is built with PERL_IMPLICIT_CONTEXT, extensions that call
1856 any functions in the Perl API will need to pass the initial context
1857 argument somehow.  The kicker is that you will need to write it in
1858 such a way that the extension still compiles when Perl hasn't been
1859 built with PERL_IMPLICIT_CONTEXT enabled.
1860
1861 There are three ways to do this.  First, the easy but inefficient way,
1862 which is also the default, in order to maintain source compatibility
1863 with extensions: whenever XSUB.h is #included, it redefines the aTHX
1864 and aTHX_ macros to call a function that will return the context.
1865 Thus, something like:
1866
1867         sv_setsv(asv, bsv);
1868
1869 in your extension will translate to this when PERL_IMPLICIT_CONTEXT is
1870 in effect:
1871
1872         Perl_sv_setsv(Perl_get_context(), asv, bsv);
1873
1874 or to this otherwise:
1875
1876         Perl_sv_setsv(asv, bsv);
1877
1878 You have to do nothing new in your extension to get this; since
1879 the Perl library provides Perl_get_context(), it will all just
1880 work.
1881
1882 The second, more efficient way is to use the following template for
1883 your Foo.xs:
1884
1885         #define PERL_NO_GET_CONTEXT     /* we want efficiency */
1886         #include "EXTERN.h"
1887         #include "perl.h"
1888         #include "XSUB.h"
1889
1890         static my_private_function(int arg1, int arg2);
1891
1892         static SV *
1893         my_private_function(int arg1, int arg2)
1894         {
1895             dTHX;       /* fetch context */
1896             ... call many Perl API functions ...
1897         }
1898
1899         [... etc ...]
1900
1901         MODULE = Foo            PACKAGE = Foo
1902
1903         /* typical XSUB */
1904
1905         void
1906         my_xsub(arg)
1907                 int arg
1908             CODE:
1909                 my_private_function(arg, 10);
1910
1911 Note that the only two changes from the normal way of writing an
1912 extension is the addition of a C<#define PERL_NO_GET_CONTEXT> before
1913 including the Perl headers, followed by a C<dTHX;> declaration at
1914 the start of every function that will call the Perl API.  (You'll
1915 know which functions need this, because the C compiler will complain
1916 that there's an undeclared identifier in those functions.)  No changes
1917 are needed for the XSUBs themselves, because the XS() macro is
1918 correctly defined to pass in the implicit context if needed.
1919
1920 The third, even more efficient way is to ape how it is done within
1921 the Perl guts:
1922
1923
1924         #define PERL_NO_GET_CONTEXT     /* we want efficiency */
1925         #include "EXTERN.h"
1926         #include "perl.h"
1927         #include "XSUB.h"
1928
1929         /* pTHX_ only needed for functions that call Perl API */
1930         static my_private_function(pTHX_ int arg1, int arg2);
1931
1932         static SV *
1933         my_private_function(pTHX_ int arg1, int arg2)
1934         {
1935             /* dTHX; not needed here, because THX is an argument */
1936             ... call Perl API functions ...
1937         }
1938
1939         [... etc ...]
1940
1941         MODULE = Foo            PACKAGE = Foo
1942
1943         /* typical XSUB */
1944
1945         void
1946         my_xsub(arg)
1947                 int arg
1948             CODE:
1949                 my_private_function(aTHX_ arg, 10);
1950
1951 This implementation never has to fetch the context using a function
1952 call, since it is always passed as an extra argument.  Depending on
1953 your needs for simplicity or efficiency, you may mix the previous
1954 two approaches freely.
1955
1956 Never add a comma after C<pTHX> yourself--always use the form of the
1957 macro with the underscore for functions that take explicit arguments,
1958 or the form without the argument for functions with no explicit arguments.
1959
1960 =head2 Should I do anything special if I call perl from multiple threads?
1961
1962 If you create interpreters in one thread and then proceed to call them in
1963 another, you need to make sure perl's own Thread Local Storage (TLS) slot is
1964 initialized correctly in each of those threads.
1965
1966 The C<perl_alloc> and C<perl_clone> API functions will automatically set
1967 the TLS slot to the interpreter they created, so that there is no need to do
1968 anything special if the interpreter is always accessed in the same thread that
1969 created it, and that thread did not create or call any other interpreters
1970 afterwards.  If that is not the case, you have to set the TLS slot of the
1971 thread before calling any functions in the Perl API on that particular
1972 interpreter.  This is done by calling the C<PERL_SET_CONTEXT> macro in that
1973 thread as the first thing you do:
1974
1975         /* do this before doing anything else with some_perl */
1976         PERL_SET_CONTEXT(some_perl);
1977
1978         ... other Perl API calls on some_perl go here ...
1979
1980 =head2 Future Plans and PERL_IMPLICIT_SYS
1981
1982 Just as PERL_IMPLICIT_CONTEXT provides a way to bundle up everything
1983 that the interpreter knows about itself and pass it around, so too are
1984 there plans to allow the interpreter to bundle up everything it knows
1985 about the environment it's running on.  This is enabled with the
1986 PERL_IMPLICIT_SYS macro.  Currently it only works with PERL_OBJECT
1987 and USE_THREADS on Windows (see inside iperlsys.h).
1988
1989 This allows the ability to provide an extra pointer (called the "host"
1990 environment) for all the system calls.  This makes it possible for
1991 all the system stuff to maintain their own state, broken down into
1992 seven C structures.  These are thin wrappers around the usual system
1993 calls (see win32/perllib.c) for the default perl executable, but for a
1994 more ambitious host (like the one that would do fork() emulation) all
1995 the extra work needed to pretend that different interpreters are
1996 actually different "processes", would be done here.
1997
1998 The Perl engine/interpreter and the host are orthogonal entities.
1999 There could be one or more interpreters in a process, and one or
2000 more "hosts", with free association between them.
2001
2002 =head1 Internal Functions
2003
2004 All of Perl's internal functions which will be exposed to the outside
2005 world are be prefixed by C<Perl_> so that they will not conflict with XS
2006 functions or functions used in a program in which Perl is embedded.
2007 Similarly, all global variables begin with C<PL_>. (By convention,
2008 static functions start with C<S_>)
2009
2010 Inside the Perl core, you can get at the functions either with or
2011 without the C<Perl_> prefix, thanks to a bunch of defines that live in
2012 F<embed.h>. This header file is generated automatically from
2013 F<embed.pl>. F<embed.pl> also creates the prototyping header files for
2014 the internal functions, generates the documentation and a lot of other
2015 bits and pieces. It's important that when you add a new function to the
2016 core or change an existing one, you change the data in the table at the
2017 end of F<embed.pl> as well. Here's a sample entry from that table:
2018
2019     Apd |SV**   |av_fetch   |AV* ar|I32 key|I32 lval
2020
2021 The second column is the return type, the third column the name. Columns
2022 after that are the arguments. The first column is a set of flags:
2023
2024 =over 3
2025
2026 =item A
2027
2028 This function is a part of the public API.
2029
2030 =item p
2031
2032 This function has a C<Perl_> prefix; ie, it is defined as C<Perl_av_fetch>
2033
2034 =item d
2035
2036 This function has documentation using the C<apidoc> feature which we'll
2037 look at in a second.
2038
2039 =back
2040
2041 Other available flags are:
2042
2043 =over 3
2044
2045 =item s
2046
2047 This is a static function and is defined as C<S_whatever>, and usually
2048 called within the sources as C<whatever(...)>.
2049
2050 =item n
2051
2052 This does not use C<aTHX_> and C<pTHX> to pass interpreter context. (See
2053 L<perlguts/Background and PERL_IMPLICIT_CONTEXT>.)
2054
2055 =item r
2056
2057 This function never returns; C<croak>, C<exit> and friends.
2058
2059 =item f
2060
2061 This function takes a variable number of arguments, C<printf> style.
2062 The argument list should end with C<...>, like this:
2063
2064     Afprd   |void   |croak          |const char* pat|...
2065
2066 =item M
2067
2068 This function is part of the experimental development API, and may change
2069 or disappear without notice.
2070
2071 =item o
2072
2073 This function should not have a compatibility macro to define, say,
2074 C<Perl_parse> to C<parse>. It must be called as C<Perl_parse>.
2075
2076 =item j
2077
2078 This function is not a member of C<CPerlObj>. If you don't know
2079 what this means, don't use it.
2080
2081 =item x
2082
2083 This function isn't exported out of the Perl core.
2084
2085 =back
2086
2087 If you edit F<embed.pl>, you will need to run C<make regen_headers> to
2088 force a rebuild of F<embed.h> and other auto-generated files.
2089
2090 =head2 Formatted Printing of IVs, UVs, and NVs
2091
2092 If you are printing IVs, UVs, or NVS instead of the stdio(3) style
2093 formatting codes like C<%d>, C<%ld>, C<%f>, you should use the
2094 following macros for portability
2095
2096         IVdf            IV in decimal
2097         UVuf            UV in decimal
2098         UVof            UV in octal
2099         UVxf            UV in hexadecimal
2100         NVef            NV %e-like
2101         NVff            NV %f-like
2102         NVgf            NV %g-like
2103
2104 These will take care of 64-bit integers and long doubles.
2105 For example:
2106
2107         printf("IV is %"IVdf"\n", iv);
2108
2109 The IVdf will expand to whatever is the correct format for the IVs.
2110
2111 If you are printing addresses of pointers, use UVxf combined
2112 with PTR2UV(), do not use %lx or %p.
2113
2114 =head2 Pointer-To-Integer and Integer-To-Pointer
2115
2116 Because pointer size does not necessarily equal integer size,
2117 use the follow macros to do it right.
2118
2119         PTR2UV(pointer)
2120         PTR2IV(pointer)
2121         PTR2NV(pointer)
2122         INT2PTR(pointertotype, integer)
2123
2124 For example:
2125
2126         IV  iv = ...;
2127         SV *sv = INT2PTR(SV*, iv);
2128
2129 and
2130
2131         AV *av = ...;
2132         UV  uv = PTR2UV(av);
2133
2134 =head2 Source Documentation
2135
2136 There's an effort going on to document the internal functions and
2137 automatically produce reference manuals from them - L<perlapi> is one
2138 such manual which details all the functions which are available to XS
2139 writers. L<perlintern> is the autogenerated manual for the functions
2140 which are not part of the API and are supposedly for internal use only.
2141
2142 Source documentation is created by putting POD comments into the C
2143 source, like this:
2144
2145  /*
2146  =for apidoc sv_setiv
2147
2148  Copies an integer into the given SV.  Does not handle 'set' magic.  See
2149  C<sv_setiv_mg>.
2150
2151  =cut
2152  */
2153
2154 Please try and supply some documentation if you add functions to the
2155 Perl core.
2156
2157 =head1 Unicode Support
2158
2159 Perl 5.6.0 introduced Unicode support. It's important for porters and XS
2160 writers to understand this support and make sure that the code they
2161 write does not corrupt Unicode data.
2162
2163 =head2 What B<is> Unicode, anyway?
2164
2165 In the olden, less enlightened times, we all used to use ASCII. Most of
2166 us did, anyway. The big problem with ASCII is that it's American. Well,
2167 no, that's not actually the problem; the problem is that it's not
2168 particularly useful for people who don't use the Roman alphabet. What
2169 used to happen was that particular languages would stick their own
2170 alphabet in the upper range of the sequence, between 128 and 255. Of
2171 course, we then ended up with plenty of variants that weren't quite
2172 ASCII, and the whole point of it being a standard was lost.
2173
2174 Worse still, if you've got a language like Chinese or
2175 Japanese that has hundreds or thousands of characters, then you really
2176 can't fit them into a mere 256, so they had to forget about ASCII
2177 altogether, and build their own systems using pairs of numbers to refer
2178 to one character.
2179
2180 To fix this, some people formed Unicode, Inc. and
2181 produced a new character set containing all the characters you can
2182 possibly think of and more. There are several ways of representing these
2183 characters, and the one Perl uses is called UTF8. UTF8 uses
2184 a variable number of bytes to represent a character, instead of just
2185 one. You can learn more about Unicode at http://www.unicode.org/
2186
2187 =head2 How can I recognise a UTF8 string?
2188
2189 You can't. This is because UTF8 data is stored in bytes just like
2190 non-UTF8 data. The Unicode character 200, (C<0xC8> for you hex types)
2191 capital E with a grave accent, is represented by the two bytes
2192 C<v196.172>. Unfortunately, the non-Unicode string C<chr(196).chr(172)>
2193 has that byte sequence as well. So you can't tell just by looking - this
2194 is what makes Unicode input an interesting problem.
2195
2196 The API function C<is_utf8_string> can help; it'll tell you if a string
2197 contains only valid UTF8 characters. However, it can't do the work for
2198 you. On a character-by-character basis, C<is_utf8_char> will tell you
2199 whether the current character in a string is valid UTF8.
2200
2201 =head2 How does UTF8 represent Unicode characters?
2202
2203 As mentioned above, UTF8 uses a variable number of bytes to store a
2204 character. Characters with values 1...128 are stored in one byte, just
2205 like good ol' ASCII. Character 129 is stored as C<v194.129>; this
2206 continues up to character 191, which is C<v194.191>. Now we've run out of
2207 bits (191 is binary C<10111111>) so we move on; 192 is C<v195.128>. And
2208 so it goes on, moving to three bytes at character 2048.
2209
2210 Assuming you know you're dealing with a UTF8 string, you can find out
2211 how long the first character in it is with the C<UTF8SKIP> macro:
2212
2213     char *utf = "\305\233\340\240\201";
2214     I32 len;
2215
2216     len = UTF8SKIP(utf); /* len is 2 here */
2217     utf += len;
2218     len = UTF8SKIP(utf); /* len is 3 here */
2219
2220 Another way to skip over characters in a UTF8 string is to use
2221 C<utf8_hop>, which takes a string and a number of characters to skip
2222 over. You're on your own about bounds checking, though, so don't use it
2223 lightly.
2224
2225 All bytes in a multi-byte UTF8 character will have the high bit set, so
2226 you can test if you need to do something special with this character
2227 like this:
2228
2229     UV uv;
2230
2231     if (utf & 0x80)
2232         /* Must treat this as UTF8 */
2233         uv = utf8_to_uv(utf);
2234     else
2235         /* OK to treat this character as a byte */
2236         uv = *utf;
2237
2238 You can also see in that example that we use C<utf8_to_uv> to get the
2239 value of the character; the inverse function C<uv_to_utf8> is available
2240 for putting a UV into UTF8:
2241
2242     if (uv > 0x80)
2243         /* Must treat this as UTF8 */
2244         utf8 = uv_to_utf8(utf8, uv);
2245     else
2246         /* OK to treat this character as a byte */
2247         *utf8++ = uv;
2248
2249 You B<must> convert characters to UVs using the above functions if
2250 you're ever in a situation where you have to match UTF8 and non-UTF8
2251 characters. You may not skip over UTF8 characters in this case. If you
2252 do this, you'll lose the ability to match hi-bit non-UTF8 characters;
2253 for instance, if your UTF8 string contains C<v196.172>, and you skip
2254 that character, you can never match a C<chr(200)> in a non-UTF8 string.
2255 So don't do that!
2256
2257 =head2 How does Perl store UTF8 strings?
2258
2259 Currently, Perl deals with Unicode strings and non-Unicode strings
2260 slightly differently. If a string has been identified as being UTF-8
2261 encoded, Perl will set a flag in the SV, C<SVf_UTF8>. You can check and
2262 manipulate this flag with the following macros:
2263
2264     SvUTF8(sv)
2265     SvUTF8_on(sv)
2266     SvUTF8_off(sv)
2267
2268 This flag has an important effect on Perl's treatment of the string: if
2269 Unicode data is not properly distinguished, regular expressions,
2270 C<length>, C<substr> and other string handling operations will have
2271 undesirable results.
2272
2273 The problem comes when you have, for instance, a string that isn't
2274 flagged is UTF8, and contains a byte sequence that could be UTF8 -
2275 especially when combining non-UTF8 and UTF8 strings.
2276
2277 Never forget that the C<SVf_UTF8> flag is separate to the PV value; you
2278 need be sure you don't accidentally knock it off while you're
2279 manipulating SVs. More specifically, you cannot expect to do this:
2280
2281     SV *sv;
2282     SV *nsv;
2283     STRLEN len;
2284     char *p;
2285
2286     p = SvPV(sv, len);
2287     frobnicate(p);
2288     nsv = newSVpvn(p, len);
2289
2290 The C<char*> string does not tell you the whole story, and you can't
2291 copy or reconstruct an SV just by copying the string value. Check if the
2292 old SV has the UTF8 flag set, and act accordingly:
2293
2294     p = SvPV(sv, len);
2295     frobnicate(p);
2296     nsv = newSVpvn(p, len);
2297     if (SvUTF8(sv))
2298         SvUTF8_on(nsv);
2299
2300 In fact, your C<frobnicate> function should be made aware of whether or
2301 not it's dealing with UTF8 data, so that it can handle the string
2302 appropriately.
2303
2304 =head2 How do I convert a string to UTF8?
2305
2306 If you're mixing UTF8 and non-UTF8 strings, you might find it necessary
2307 to upgrade one of the strings to UTF8. If you've got an SV, the easiest
2308 way to do this is:
2309
2310     sv_utf8_upgrade(sv);
2311
2312 However, you must not do this, for example:
2313
2314     if (!SvUTF8(left))
2315         sv_utf8_upgrade(left);
2316
2317 If you do this in a binary operator, you will actually change one of the
2318 strings that came into the operator, and, while it shouldn't be noticeable
2319 by the end user, it can cause problems.
2320
2321 Instead, C<bytes_to_utf8> will give you a UTF8-encoded B<copy> of its
2322 string argument. This is useful for having the data available for
2323 comparisons and so on, without harming the original SV. There's also
2324 C<utf8_to_bytes> to go the other way, but naturally, this will fail if
2325 the string contains any characters above 255 that can't be represented
2326 in a single byte.
2327
2328 =head2 Is there anything else I need to know?
2329
2330 Not really. Just remember these things:
2331
2332 =over 3
2333
2334 =item *
2335
2336 There's no way to tell if a string is UTF8 or not. You can tell if an SV
2337 is UTF8 by looking at is C<SvUTF8> flag. Don't forget to set the flag if
2338 something should be UTF8. Treat the flag as part of the PV, even though
2339 it's not - if you pass on the PV to somewhere, pass on the flag too.
2340
2341 =item *
2342
2343 If a string is UTF8, B<always> use C<utf8_to_uv> to get at the value,
2344 unless C<!(*s & 0x80)> in which case you can use C<*s>.
2345
2346 =item *
2347
2348 When writing to a UTF8 string, B<always> use C<uv_to_utf8>, unless
2349 C<uv < 0x80> in which case you can use C<*s = uv>.
2350
2351 =item *
2352
2353 Mixing UTF8 and non-UTF8 strings is tricky. Use C<bytes_to_utf8> to get
2354 a new string which is UTF8 encoded. There are tricks you can use to
2355 delay deciding whether you need to use a UTF8 string until you get to a
2356 high character - C<HALF_UPGRADE> is one of those.
2357
2358 =back
2359
2360 =head1 AUTHORS
2361
2362 Until May 1997, this document was maintained by Jeff Okamoto
2363 <okamoto@corp.hp.com>.  It is now maintained as part of Perl itself
2364 by the Perl 5 Porters <perl5-porters@perl.org>.
2365
2366 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
2367 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
2368 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
2369 Stephen McCamant, and Gurusamy Sarathy.
2370
2371 API Listing originally by Dean Roehrich <roehrich@cray.com>.
2372
2373 Modifications to autogenerate the API listing (L<perlapi>) by Benjamin
2374 Stuhl.
2375
2376 =head1 SEE ALSO
2377
2378 perlapi(1), perlintern(1), perlxs(1), perlembed(1)