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