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