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