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