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