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