This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
fix several problems in the MY_CXT example in perlxs.pod
[perl5.git] / dist / ExtUtils-ParseXS / lib / perlxs.pod
1 =head1 NAME
2
3 perlxs - XS language reference manual
4
5 =head1 DESCRIPTION
6
7 =head2 Introduction
8
9 XS is an interface description file format used to create an extension
10 interface between Perl and C code (or a C library) which one wishes
11 to use with Perl.  The XS interface is combined with the library to
12 create a new library which can then be either dynamically loaded
13 or statically linked into perl.  The XS interface description is
14 written in the XS language and is the core component of the Perl
15 extension interface.
16
17 An B<XSUB> forms the basic unit of the XS interface.  After compilation
18 by the B<xsubpp> compiler, each XSUB amounts to a C function definition
19 which will provide the glue between Perl calling conventions and C
20 calling conventions.
21
22 The glue code pulls the arguments from the Perl stack, converts these
23 Perl values to the formats expected by a C function, call this C function,
24 transfers the return values of the C function back to Perl.
25 Return values here may be a conventional C return value or any C
26 function arguments that may serve as output parameters.  These return
27 values may be passed back to Perl either by putting them on the
28 Perl stack, or by modifying the arguments supplied from the Perl side.
29
30 The above is a somewhat simplified view of what really happens.  Since
31 Perl allows more flexible calling conventions than C, XSUBs may do much
32 more in practice, such as checking input parameters for validity,
33 throwing exceptions (or returning undef/empty list) if the return value
34 from the C function indicates failure, calling different C functions
35 based on numbers and types of the arguments, providing an object-oriented
36 interface, etc.
37
38 Of course, one could write such glue code directly in C.  However, this
39 would be a tedious task, especially if one needs to write glue for
40 multiple C functions, and/or one is not familiar enough with the Perl
41 stack discipline and other such arcana.  XS comes to the rescue here:
42 instead of writing this glue C code in long-hand, one can write
43 a more concise short-hand I<description> of what should be done by
44 the glue, and let the XS compiler B<xsubpp> handle the rest.
45
46 The XS language allows one to describe the mapping between how the C
47 routine is used, and how the corresponding Perl routine is used.  It
48 also allows creation of Perl routines which are directly translated to
49 C code and which are not related to a pre-existing C function.  In cases
50 when the C interface coincides with the Perl interface, the XSUB
51 declaration is almost identical to a declaration of a C function (in K&R
52 style).  In such circumstances, there is another tool called C<h2xs>
53 that is able to translate an entire C header file into a corresponding
54 XS file that will provide glue to the functions/macros described in
55 the header file.
56
57 The XS compiler is called B<xsubpp>.  This compiler creates
58 the constructs necessary to let an XSUB manipulate Perl values, and
59 creates the glue necessary to let Perl call the XSUB.  The compiler
60 uses B<typemaps> to determine how to map C function parameters
61 and output values to Perl values and back.  The default typemap
62 (which comes with Perl) handles many common C types.  A supplementary
63 typemap may also be needed to handle any special structures and types
64 for the library being linked. For more information on typemaps,
65 see L<perlxstypemap>.
66
67 A file in XS format starts with a C language section which goes until the
68 first C<MODULE =Z<>> directive.  Other XS directives and XSUB definitions
69 may follow this line.  The "language" used in this part of the file
70 is usually referred to as the XS language.  B<xsubpp> recognizes and
71 skips POD (see L<perlpod>) in both the C and XS language sections, which
72 allows the XS file to contain embedded documentation.
73
74 See L<perlxstut> for a tutorial on the whole extension creation process.
75
76 Note: For some extensions, Dave Beazley's SWIG system may provide a
77 significantly more convenient mechanism for creating the extension
78 glue code.  See L<http://www.swig.org/> for more information.
79
80 =head2 On The Road
81
82 Many of the examples which follow will concentrate on creating an interface
83 between Perl and the ONC+ RPC bind library functions.  The rpcb_gettime()
84 function is used to demonstrate many features of the XS language.  This
85 function has two parameters; the first is an input parameter and the second
86 is an output parameter.  The function also returns a status value.
87
88         bool_t rpcb_gettime(const char *host, time_t *timep);
89
90 From C this function will be called with the following
91 statements.
92
93      #include <rpc/rpc.h>
94      bool_t status;
95      time_t timep;
96      status = rpcb_gettime( "localhost", &timep );
97
98 If an XSUB is created to offer a direct translation between this function
99 and Perl, then this XSUB will be used from Perl with the following code.
100 The $status and $timep variables will contain the output of the function.
101
102      use RPC;
103      $status = rpcb_gettime( "localhost", $timep );
104
105 The following XS file shows an XS subroutine, or XSUB, which
106 demonstrates one possible interface to the rpcb_gettime()
107 function.  This XSUB represents a direct translation between
108 C and Perl and so preserves the interface even from Perl.
109 This XSUB will be invoked from Perl with the usage shown
110 above.  Note that the first three #include statements, for
111 C<EXTERN.h>, C<perl.h>, and C<XSUB.h>, will always be present at the
112 beginning of an XS file.  This approach and others will be
113 expanded later in this document.
114
115      #include "EXTERN.h"
116      #include "perl.h"
117      #include "XSUB.h"
118      #include <rpc/rpc.h>
119
120      MODULE = RPC  PACKAGE = RPC
121
122      bool_t
123      rpcb_gettime(host,timep)
124           char *host
125           time_t &timep
126         OUTPUT:
127           timep
128
129 Any extension to Perl, including those containing XSUBs,
130 should have a Perl module to serve as the bootstrap which
131 pulls the extension into Perl.  This module will export the
132 extension's functions and variables to the Perl program and
133 will cause the extension's XSUBs to be linked into Perl.
134 The following module will be used for most of the examples
135 in this document and should be used from Perl with the C<use>
136 command as shown earlier.  Perl modules are explained in
137 more detail later in this document.
138
139      package RPC;
140
141      require Exporter;
142      require DynaLoader;
143      @ISA = qw(Exporter DynaLoader);
144      @EXPORT = qw( rpcb_gettime );
145
146      bootstrap RPC;
147      1;
148
149 Throughout this document a variety of interfaces to the rpcb_gettime()
150 XSUB will be explored.  The XSUBs will take their parameters in different
151 orders or will take different numbers of parameters.  In each case the
152 XSUB is an abstraction between Perl and the real C rpcb_gettime()
153 function, and the XSUB must always ensure that the real rpcb_gettime()
154 function is called with the correct parameters.  This abstraction will
155 allow the programmer to create a more Perl-like interface to the C
156 function.
157
158 =head2 The Anatomy of an XSUB
159
160 The simplest XSUBs consist of 3 parts: a description of the return
161 value, the name of the XSUB routine and the names of its arguments,
162 and a description of types or formats of the arguments.
163
164 The following XSUB allows a Perl program to access a C library function
165 called sin().  The XSUB will imitate the C function which takes a single
166 argument and returns a single value.
167
168      double
169      sin(x)
170        double x
171
172 Optionally, one can merge the description of types and the list of
173 argument names, rewriting this as
174
175      double
176      sin(double x)
177
178 This makes this XSUB look similar to an ANSI C declaration.  An optional
179 semicolon is allowed after the argument list, as in
180
181      double
182      sin(double x);
183
184 Parameters with C pointer types can have different semantic: C functions
185 with similar declarations
186
187      bool string_looks_as_a_number(char *s);
188      bool make_char_uppercase(char *c);
189
190 are used in absolutely incompatible manner.  Parameters to these functions
191 could be described B<xsubpp> like this:
192
193      char *  s
194      char    &c
195
196 Both these XS declarations correspond to the C<char*> C type, but they have
197 different semantics, see L<"The & Unary Operator">.
198
199 It is convenient to think that the indirection operator
200 C<*> should be considered as a part of the type and the address operator C<&>
201 should be considered part of the variable.  See L<perlxstypemap>
202 for more info about handling qualifiers and unary operators in C types.
203
204 The function name and the return type must be placed on
205 separate lines and should be flush left-adjusted.
206
207   INCORRECT                        CORRECT
208
209   double sin(x)                    double
210     double x                       sin(x)
211                                      double x
212
213 The rest of the function description may be indented or left-adjusted. The
214 following example shows a function with its body left-adjusted.  Most
215 examples in this document will indent the body for better readability.
216
217   CORRECT
218
219   double
220   sin(x)
221   double x
222
223 More complicated XSUBs may contain many other sections.  Each section of
224 an XSUB starts with the corresponding keyword, such as INIT: or CLEANUP:.
225 However, the first two lines of an XSUB always contain the same data:
226 descriptions of the return type and the names of the function and its
227 parameters.  Whatever immediately follows these is considered to be
228 an INPUT: section unless explicitly marked with another keyword.
229 (See L<The INPUT: Keyword>.)
230
231 An XSUB section continues until another section-start keyword is found.
232
233 =head2 The Argument Stack
234
235 The Perl argument stack is used to store the values which are
236 sent as parameters to the XSUB and to store the XSUB's
237 return value(s).  In reality all Perl functions (including non-XSUB
238 ones) keep their values on this stack all the same time, each limited
239 to its own range of positions on the stack.  In this document the
240 first position on that stack which belongs to the active
241 function will be referred to as position 0 for that function.
242
243 XSUBs refer to their stack arguments with the macro B<ST(x)>, where I<x>
244 refers to a position in this XSUB's part of the stack.  Position 0 for that
245 function would be known to the XSUB as ST(0).  The XSUB's incoming
246 parameters and outgoing return values always begin at ST(0).  For many
247 simple cases the B<xsubpp> compiler will generate the code necessary to
248 handle the argument stack by embedding code fragments found in the
249 typemaps.  In more complex cases the programmer must supply the code.
250
251 =head2 The RETVAL Variable
252
253 The RETVAL variable is a special C variable that is declared automatically
254 for you.  The C type of RETVAL matches the return type of the C library
255 function.  The B<xsubpp> compiler will declare this variable in each XSUB
256 with non-C<void> return type.  By default the generated C function
257 will use RETVAL to hold the return value of the C library function being
258 called.  In simple cases the value of RETVAL will be placed in ST(0) of
259 the argument stack where it can be received by Perl as the return value
260 of the XSUB.
261
262 If the XSUB has a return type of C<void> then the compiler will
263 not declare a RETVAL variable for that function.  When using
264 a PPCODE: section no manipulation of the RETVAL variable is required, the
265 section may use direct stack manipulation to place output values on the stack.
266
267 If PPCODE: directive is not used, C<void> return value should be used
268 only for subroutines which do not return a value, I<even if> CODE:
269 directive is used which sets ST(0) explicitly.
270
271 Older versions of this document recommended to use C<void> return
272 value in such cases. It was discovered that this could lead to
273 segfaults in cases when XSUB was I<truly> C<void>. This practice is
274 now deprecated, and may be not supported at some future version. Use
275 the return value C<SV *> in such cases. (Currently C<xsubpp> contains
276 some heuristic code which tries to disambiguate between "truly-void"
277 and "old-practice-declared-as-void" functions. Hence your code is at
278 mercy of this heuristics unless you use C<SV *> as return value.)
279
280 =head2 Returning SVs, AVs and HVs through RETVAL
281
282 When you're using RETVAL to return an C<SV *>, there's some magic
283 going on behind the scenes that should be mentioned. When you're
284 manipulating the argument stack using the ST(x) macro, for example,
285 you usually have to pay special attention to reference counts. (For
286 more about reference counts, see L<perlguts>.) To make your life
287 easier, the typemap file automatically makes C<RETVAL> mortal when
288 you're returning an C<SV *>. Thus, the following two XSUBs are more
289 or less equivalent:
290
291   void
292   alpha()
293       PPCODE:
294           ST(0) = newSVpv("Hello World",0);
295           sv_2mortal(ST(0));
296           XSRETURN(1);
297
298   SV *
299   beta()
300       CODE:
301           RETVAL = newSVpv("Hello World",0);
302       OUTPUT:
303           RETVAL
304
305 This is quite useful as it usually improves readability. While
306 this works fine for an C<SV *>, it's unfortunately not as easy
307 to have C<AV *> or C<HV *> as a return value. You I<should> be
308 able to write:
309
310   AV *
311   array()
312       CODE:
313           RETVAL = newAV();
314           /* do something with RETVAL */
315       OUTPUT:
316           RETVAL
317
318 But due to an unfixable bug (fixing it would break lots of existing
319 CPAN modules) in the typemap file, the reference count of the C<AV *>
320 is not properly decremented. Thus, the above XSUB would leak memory
321 whenever it is being called. The same problem exists for C<HV *>,
322 C<CV *>, and C<SVREF> (which indicates a scalar reference, not
323 a general C<SV *>).
324 In XS code on perls starting with perl 5.16, you can override the
325 typemaps for any of these types with a version that has proper
326 handling of refcounts. In your C<TYPEMAP> section, do
327
328   AV*   T_AVREF_REFCOUNT_FIXED
329
330 to get the repaired variant. For backward compatibility with older
331 versions of perl, you can instead decrement the reference count
332 manually when you're returning one of the aforementioned
333 types using C<sv_2mortal>:
334
335   AV *
336   array()
337       CODE:
338           RETVAL = newAV();
339           sv_2mortal((SV*)RETVAL);
340           /* do something with RETVAL */
341       OUTPUT:
342           RETVAL
343
344 Remember that you don't have to do this for an C<SV *>. The reference
345 documentation for all core typemaps can be found in L<perlxstypemap>.
346
347 =head2 The MODULE Keyword
348
349 The MODULE keyword is used to start the XS code and to specify the package
350 of the functions which are being defined.  All text preceding the first
351 MODULE keyword is considered C code and is passed through to the output with
352 POD stripped, but otherwise untouched.  Every XS module will have a
353 bootstrap function which is used to hook the XSUBs into Perl.  The package
354 name of this bootstrap function will match the value of the last MODULE
355 statement in the XS source files.  The value of MODULE should always remain
356 constant within the same XS file, though this is not required.
357
358 The following example will start the XS code and will place
359 all functions in a package named RPC.
360
361      MODULE = RPC
362
363 =head2 The PACKAGE Keyword
364
365 When functions within an XS source file must be separated into packages
366 the PACKAGE keyword should be used.  This keyword is used with the MODULE
367 keyword and must follow immediately after it when used.
368
369      MODULE = RPC  PACKAGE = RPC
370
371      [ XS code in package RPC ]
372
373      MODULE = RPC  PACKAGE = RPCB
374
375      [ XS code in package RPCB ]
376
377      MODULE = RPC  PACKAGE = RPC
378
379      [ XS code in package RPC ]
380
381 The same package name can be used more than once, allowing for
382 non-contiguous code. This is useful if you have a stronger ordering
383 principle than package names.
384
385 Although this keyword is optional and in some cases provides redundant
386 information it should always be used.  This keyword will ensure that the
387 XSUBs appear in the desired package.
388
389 =head2 The PREFIX Keyword
390
391 The PREFIX keyword designates prefixes which should be
392 removed from the Perl function names.  If the C function is
393 C<rpcb_gettime()> and the PREFIX value is C<rpcb_> then Perl will
394 see this function as C<gettime()>.
395
396 This keyword should follow the PACKAGE keyword when used.
397 If PACKAGE is not used then PREFIX should follow the MODULE
398 keyword.
399
400      MODULE = RPC  PREFIX = rpc_
401
402      MODULE = RPC  PACKAGE = RPCB  PREFIX = rpcb_
403
404 =head2 The OUTPUT: Keyword
405
406 The OUTPUT: keyword indicates that certain function parameters should be
407 updated (new values made visible to Perl) when the XSUB terminates or that
408 certain values should be returned to the calling Perl function.  For
409 simple functions which have no CODE: or PPCODE: section,
410 such as the sin() function above, the RETVAL variable is
411 automatically designated as an output value.  For more complex functions
412 the B<xsubpp> compiler will need help to determine which variables are output
413 variables.
414
415 This keyword will normally be used to complement the CODE:  keyword.
416 The RETVAL variable is not recognized as an output variable when the
417 CODE: keyword is present.  The OUTPUT:  keyword is used in this
418 situation to tell the compiler that RETVAL really is an output
419 variable.
420
421 The OUTPUT: keyword can also be used to indicate that function parameters
422 are output variables.  This may be necessary when a parameter has been
423 modified within the function and the programmer would like the update to
424 be seen by Perl.
425
426      bool_t
427      rpcb_gettime(host,timep)
428           char *host
429           time_t &timep
430         OUTPUT:
431           timep
432
433 The OUTPUT: keyword will also allow an output parameter to
434 be mapped to a matching piece of code rather than to a
435 typemap.
436
437      bool_t
438      rpcb_gettime(host,timep)
439           char *host
440           time_t &timep
441         OUTPUT:
442           timep sv_setnv(ST(1), (double)timep);
443
444 B<xsubpp> emits an automatic C<SvSETMAGIC()> for all parameters in the
445 OUTPUT section of the XSUB, except RETVAL.  This is the usually desired
446 behavior, as it takes care of properly invoking 'set' magic on output
447 parameters (needed for hash or array element parameters that must be
448 created if they didn't exist).  If for some reason, this behavior is
449 not desired, the OUTPUT section may contain a C<SETMAGIC: DISABLE> line
450 to disable it for the remainder of the parameters in the OUTPUT section.
451 Likewise,  C<SETMAGIC: ENABLE> can be used to reenable it for the
452 remainder of the OUTPUT section.  See L<perlguts> for more details
453 about 'set' magic.
454
455 =head2 The NO_OUTPUT Keyword
456
457 The NO_OUTPUT can be placed as the first token of the XSUB.  This keyword
458 indicates that while the C subroutine we provide an interface to has
459 a non-C<void> return type, the return value of this C subroutine should not
460 be returned from the generated Perl subroutine.
461
462 With this keyword present L<The RETVAL Variable> is created, and in the
463 generated call to the subroutine this variable is assigned to, but the value
464 of this variable is not going to be used in the auto-generated code.
465
466 This keyword makes sense only if C<RETVAL> is going to be accessed by the
467 user-supplied code.  It is especially useful to make a function interface
468 more Perl-like, especially when the C return value is just an error condition
469 indicator.  For example,
470
471   NO_OUTPUT int
472   delete_file(char *name)
473     POSTCALL:
474       if (RETVAL != 0)
475           croak("Error %d while deleting file '%s'", RETVAL, name);
476
477 Here the generated XS function returns nothing on success, and will die()
478 with a meaningful error message on error.
479
480 =head2 The CODE: Keyword
481
482 This keyword is used in more complicated XSUBs which require
483 special handling for the C function.  The RETVAL variable is
484 still declared, but it will not be returned unless it is specified
485 in the OUTPUT: section.
486
487 The following XSUB is for a C function which requires special handling of
488 its parameters.  The Perl usage is given first.
489
490      $status = rpcb_gettime( "localhost", $timep );
491
492 The XSUB follows.
493
494      bool_t
495      rpcb_gettime(host,timep)
496           char *host
497           time_t timep
498         CODE:
499                RETVAL = rpcb_gettime( host, &timep );
500         OUTPUT:
501           timep
502           RETVAL
503
504 =head2 The INIT: Keyword
505
506 The INIT: keyword allows initialization to be inserted into the XSUB before
507 the compiler generates the call to the C function.  Unlike the CODE: keyword
508 above, this keyword does not affect the way the compiler handles RETVAL.
509
510     bool_t
511     rpcb_gettime(host,timep)
512           char *host
513           time_t &timep
514         INIT:
515           printf("# Host is %s\n", host );
516         OUTPUT:
517           timep
518
519 Another use for the INIT: section is to check for preconditions before
520 making a call to the C function:
521
522     long long
523     lldiv(a,b)
524         long long a
525         long long b
526       INIT:
527         if (a == 0 && b == 0)
528             XSRETURN_UNDEF;
529         if (b == 0)
530             croak("lldiv: cannot divide by 0");
531
532 =head2 The NO_INIT Keyword
533
534 The NO_INIT keyword is used to indicate that a function
535 parameter is being used only as an output value.  The B<xsubpp>
536 compiler will normally generate code to read the values of
537 all function parameters from the argument stack and assign
538 them to C variables upon entry to the function.  NO_INIT
539 will tell the compiler that some parameters will be used for
540 output rather than for input and that they will be handled
541 before the function terminates.
542
543 The following example shows a variation of the rpcb_gettime() function.
544 This function uses the timep variable only as an output variable and does
545 not care about its initial contents.
546
547      bool_t
548      rpcb_gettime(host,timep)
549           char *host
550           time_t &timep = NO_INIT
551         OUTPUT:
552           timep
553
554 =head2 The TYPEMAP: Keyword
555
556 Starting with Perl 5.16, you can embed typemaps into your XS code
557 instead of or in addition to typemaps in a separate file.  Multiple
558 such embedded typemaps will be processed in order of appearance in
559 the XS code and like local typemap files take precedence over the
560 default typemap, the embedded typemaps may overwrite previous
561 definitions of TYPEMAP, INPUT, and OUTPUT stanzas.  The syntax for
562 embedded typemaps is
563
564       TYPEMAP: <<HERE
565       ... your typemap code here ...
566       HERE
567
568 where the C<TYPEMAP> keyword must appear in the first column of a
569 new line.
570
571 Refer to L<perlxstypemap> for details on writing typemaps.
572
573 =head2 Initializing Function Parameters
574
575 C function parameters are normally initialized with their values from
576 the argument stack (which in turn contains the parameters that were
577 passed to the XSUB from Perl).  The typemaps contain the
578 code segments which are used to translate the Perl values to
579 the C parameters.  The programmer, however, is allowed to
580 override the typemaps and supply alternate (or additional)
581 initialization code.  Initialization code starts with the first
582 C<=>, C<;> or C<+> on a line in the INPUT: section.  The only
583 exception happens if this C<;> terminates the line, then this C<;>
584 is quietly ignored.
585
586 The following code demonstrates how to supply initialization code for
587 function parameters.  The initialization code is eval'ed within double
588 quotes by the compiler before it is added to the output so anything
589 which should be interpreted literally [mainly C<$>, C<@>, or C<\\>]
590 must be protected with backslashes.  The variables C<$var>, C<$arg>,
591 and C<$type> can be used as in typemaps.
592
593      bool_t
594      rpcb_gettime(host,timep)
595           char *host = (char *)SvPV_nolen($arg);
596           time_t &timep = 0;
597         OUTPUT:
598           timep
599
600 This should not be used to supply default values for parameters.  One
601 would normally use this when a function parameter must be processed by
602 another library function before it can be used.  Default parameters are
603 covered in the next section.
604
605 If the initialization begins with C<=>, then it is output in
606 the declaration for the input variable, replacing the initialization
607 supplied by the typemap.  If the initialization
608 begins with C<;> or C<+>, then it is performed after
609 all of the input variables have been declared.  In the C<;>
610 case the initialization normally supplied by the typemap is not performed.
611 For the C<+> case, the declaration for the variable will include the
612 initialization from the typemap.  A global
613 variable, C<%v>, is available for the truly rare case where
614 information from one initialization is needed in another
615 initialization.
616
617 Here's a truly obscure example:
618
619      bool_t
620      rpcb_gettime(host,timep)
621           time_t &timep; /* \$v{timep}=@{[$v{timep}=$arg]} */
622           char *host + SvOK($v{timep}) ? SvPV_nolen($arg) : NULL;
623         OUTPUT:
624           timep
625
626 The construct C<\$v{timep}=@{[$v{timep}=$arg]}> used in the above
627 example has a two-fold purpose: first, when this line is processed by
628 B<xsubpp>, the Perl snippet C<$v{timep}=$arg> is evaluated.  Second,
629 the text of the evaluated snippet is output into the generated C file
630 (inside a C comment)!  During the processing of C<char *host> line,
631 C<$arg> will evaluate to C<ST(0)>, and C<$v{timep}> will evaluate to
632 C<ST(1)>.
633
634 =head2 Default Parameter Values
635
636 Default values for XSUB arguments can be specified by placing an
637 assignment statement in the parameter list.  The default value may
638 be a number, a string or the special string C<NO_INIT>.  Defaults should
639 always be used on the right-most parameters only.
640
641 To allow the XSUB for rpcb_gettime() to have a default host
642 value the parameters to the XSUB could be rearranged.  The
643 XSUB will then call the real rpcb_gettime() function with
644 the parameters in the correct order.  This XSUB can be called
645 from Perl with either of the following statements:
646
647      $status = rpcb_gettime( $timep, $host );
648
649      $status = rpcb_gettime( $timep );
650
651 The XSUB will look like the code  which  follows.   A  CODE:
652 block  is used to call the real rpcb_gettime() function with
653 the parameters in the correct order for that function.
654
655      bool_t
656      rpcb_gettime(timep,host="localhost")
657           char *host
658           time_t timep = NO_INIT
659         CODE:
660                RETVAL = rpcb_gettime( host, &timep );
661         OUTPUT:
662           timep
663           RETVAL
664
665 =head2 The PREINIT: Keyword
666
667 The PREINIT: keyword allows extra variables to be declared immediately
668 before or after the declarations of the parameters from the INPUT: section
669 are emitted.
670
671 If a variable is declared inside a CODE: section it will follow any typemap
672 code that is emitted for the input parameters.  This may result in the
673 declaration ending up after C code, which is C syntax error.  Similar
674 errors may happen with an explicit C<;>-type or C<+>-type initialization of
675 parameters is used (see L<"Initializing Function Parameters">).  Declaring
676 these variables in an INIT: section will not help.
677
678 In such cases, to force an additional variable to be declared together
679 with declarations of other variables, place the declaration into a
680 PREINIT: section.  The PREINIT: keyword may be used one or more times
681 within an XSUB.
682
683 The following examples are equivalent, but if the code is using complex
684 typemaps then the first example is safer.
685
686      bool_t
687      rpcb_gettime(timep)
688           time_t timep = NO_INIT
689         PREINIT:
690           char *host = "localhost";
691         CODE:
692           RETVAL = rpcb_gettime( host, &timep );
693         OUTPUT:
694           timep
695           RETVAL
696
697 For this particular case an INIT: keyword would generate the
698 same C code as the PREINIT: keyword.  Another correct, but error-prone example:
699
700      bool_t
701      rpcb_gettime(timep)
702           time_t timep = NO_INIT
703         CODE:
704           char *host = "localhost";
705           RETVAL = rpcb_gettime( host, &timep );
706         OUTPUT:
707           timep
708           RETVAL
709
710 Another way to declare C<host> is to use a C block in the CODE: section:
711
712      bool_t
713      rpcb_gettime(timep)
714           time_t timep = NO_INIT
715         CODE:
716           {
717             char *host = "localhost";
718             RETVAL = rpcb_gettime( host, &timep );
719           }
720         OUTPUT:
721           timep
722           RETVAL
723
724 The ability to put additional declarations before the typemap entries are
725 processed is very handy in the cases when typemap conversions manipulate
726 some global state:
727
728     MyObject
729     mutate(o)
730         PREINIT:
731             MyState st = global_state;
732         INPUT:
733             MyObject o;
734         CLEANUP:
735             reset_to(global_state, st);
736
737 Here we suppose that conversion to C<MyObject> in the INPUT: section and from
738 MyObject when processing RETVAL will modify a global variable C<global_state>.
739 After these conversions are performed, we restore the old value of
740 C<global_state> (to avoid memory leaks, for example).
741
742 There is another way to trade clarity for compactness: INPUT sections allow
743 declaration of C variables which do not appear in the parameter list of
744 a subroutine.  Thus the above code for mutate() can be rewritten as
745
746     MyObject
747     mutate(o)
748           MyState st = global_state;
749           MyObject o;
750         CLEANUP:
751           reset_to(global_state, st);
752
753 and the code for rpcb_gettime() can be rewritten as
754
755      bool_t
756      rpcb_gettime(timep)
757           time_t timep = NO_INIT
758           char *host = "localhost";
759         C_ARGS:
760           host, &timep
761         OUTPUT:
762           timep
763           RETVAL
764
765 =head2 The SCOPE: Keyword
766
767 The SCOPE: keyword allows scoping to be enabled for a particular XSUB. If
768 enabled, the XSUB will invoke ENTER and LEAVE automatically.
769
770 To support potentially complex type mappings, if a typemap entry used
771 by an XSUB contains a comment like C</*scope*/> then scoping will
772 be automatically enabled for that XSUB.
773
774 To enable scoping:
775
776     SCOPE: ENABLE
777
778 To disable scoping:
779
780     SCOPE: DISABLE
781
782 =head2 The INPUT: Keyword
783
784 The XSUB's parameters are usually evaluated immediately after entering the
785 XSUB.  The INPUT: keyword can be used to force those parameters to be
786 evaluated a little later.  The INPUT: keyword can be used multiple times
787 within an XSUB and can be used to list one or more input variables.  This
788 keyword is used with the PREINIT: keyword.
789
790 The following example shows how the input parameter C<timep> can be
791 evaluated late, after a PREINIT.
792
793     bool_t
794     rpcb_gettime(host,timep)
795           char *host
796         PREINIT:
797           time_t tt;
798         INPUT:
799           time_t timep
800         CODE:
801                RETVAL = rpcb_gettime( host, &tt );
802                timep = tt;
803         OUTPUT:
804           timep
805           RETVAL
806
807 The next example shows each input parameter evaluated late.
808
809     bool_t
810     rpcb_gettime(host,timep)
811         PREINIT:
812           time_t tt;
813         INPUT:
814           char *host
815         PREINIT:
816           char *h;
817         INPUT:
818           time_t timep
819         CODE:
820                h = host;
821                RETVAL = rpcb_gettime( h, &tt );
822                timep = tt;
823         OUTPUT:
824           timep
825           RETVAL
826
827 Since INPUT sections allow declaration of C variables which do not appear
828 in the parameter list of a subroutine, this may be shortened to:
829
830     bool_t
831     rpcb_gettime(host,timep)
832           time_t tt;
833           char *host;
834           char *h = host;
835           time_t timep;
836         CODE:
837           RETVAL = rpcb_gettime( h, &tt );
838           timep = tt;
839         OUTPUT:
840           timep
841           RETVAL
842
843 (We used our knowledge that input conversion for C<char *> is a "simple" one,
844 thus C<host> is initialized on the declaration line, and our assignment
845 C<h = host> is not performed too early.  Otherwise one would need to have the
846 assignment C<h = host> in a CODE: or INIT: section.)
847
848 =head2 The IN/OUTLIST/IN_OUTLIST/OUT/IN_OUT Keywords
849
850 In the list of parameters for an XSUB, one can precede parameter names
851 by the C<IN>/C<OUTLIST>/C<IN_OUTLIST>/C<OUT>/C<IN_OUT> keywords.
852 C<IN> keyword is the default, the other keywords indicate how the Perl
853 interface should differ from the C interface.
854
855 Parameters preceded by C<OUTLIST>/C<IN_OUTLIST>/C<OUT>/C<IN_OUT>
856 keywords are considered to be used by the C subroutine I<via
857 pointers>.  C<OUTLIST>/C<OUT> keywords indicate that the C subroutine
858 does not inspect the memory pointed by this parameter, but will write
859 through this pointer to provide additional return values.
860
861 Parameters preceded by C<OUTLIST> keyword do not appear in the usage
862 signature of the generated Perl function.
863
864 Parameters preceded by C<IN_OUTLIST>/C<IN_OUT>/C<OUT> I<do> appear as
865 parameters to the Perl function.  With the exception of
866 C<OUT>-parameters, these parameters are converted to the corresponding
867 C type, then pointers to these data are given as arguments to the C
868 function.  It is expected that the C function will write through these
869 pointers.
870
871 The return list of the generated Perl function consists of the C return value
872 from the function (unless the XSUB is of C<void> return type or
873 C<The NO_OUTPUT Keyword> was used) followed by all the C<OUTLIST>
874 and C<IN_OUTLIST> parameters (in the order of appearance).  On the
875 return from the XSUB the C<IN_OUT>/C<OUT> Perl parameter will be
876 modified to have the values written by the C function.
877
878 For example, an XSUB
879
880   void
881   day_month(OUTLIST day, IN unix_time, OUTLIST month)
882     int day
883     int unix_time
884     int month
885
886 should be used from Perl as
887
888   my ($day, $month) = day_month(time);
889
890 The C signature of the corresponding function should be
891
892   void day_month(int *day, int unix_time, int *month);
893
894 The C<IN>/C<OUTLIST>/C<IN_OUTLIST>/C<IN_OUT>/C<OUT> keywords can be
895 mixed with ANSI-style declarations, as in
896
897   void
898   day_month(OUTLIST int day, int unix_time, OUTLIST int month)
899
900 (here the optional C<IN> keyword is omitted).
901
902 The C<IN_OUT> parameters are identical with parameters introduced with
903 L<The & Unary Operator> and put into the C<OUTPUT:> section (see
904 L<The OUTPUT: Keyword>).  The C<IN_OUTLIST> parameters are very similar,
905 the only difference being that the value C function writes through the
906 pointer would not modify the Perl parameter, but is put in the output
907 list.
908
909 The C<OUTLIST>/C<OUT> parameter differ from C<IN_OUTLIST>/C<IN_OUT>
910 parameters only by the initial value of the Perl parameter not
911 being read (and not being given to the C function - which gets some
912 garbage instead).  For example, the same C function as above can be
913 interfaced with as
914
915   void day_month(OUT int day, int unix_time, OUT int month);
916
917 or
918
919   void
920   day_month(day, unix_time, month)
921       int &day = NO_INIT
922       int  unix_time
923       int &month = NO_INIT
924     OUTPUT:
925       day
926       month
927
928 However, the generated Perl function is called in very C-ish style:
929
930   my ($day, $month);
931   day_month($day, time, $month);
932
933 =head2 The C<length(NAME)> Keyword
934
935 If one of the input arguments to the C function is the length of a string
936 argument C<NAME>, one can substitute the name of the length-argument by
937 C<length(NAME)> in the XSUB declaration.  This argument must be omitted when
938 the generated Perl function is called.  E.g.,
939
940   void
941   dump_chars(char *s, short l)
942   {
943     short n = 0;
944     while (n < l) {
945         printf("s[%d] = \"\\%#03o\"\n", n, (int)s[n]);
946         n++;
947     }
948   }
949
950   MODULE = x            PACKAGE = x
951
952   void dump_chars(char *s, short length(s))
953
954 should be called as C<dump_chars($string)>.
955
956 This directive is supported with ANSI-type function declarations only.
957
958 =head2 Variable-length Parameter Lists
959
960 XSUBs can have variable-length parameter lists by specifying an ellipsis
961 C<(...)> in the parameter list.  This use of the ellipsis is similar to that
962 found in ANSI C.  The programmer is able to determine the number of
963 arguments passed to the XSUB by examining the C<items> variable which the
964 B<xsubpp> compiler supplies for all XSUBs.  By using this mechanism one can
965 create an XSUB which accepts a list of parameters of unknown length.
966
967 The I<host> parameter for the rpcb_gettime() XSUB can be
968 optional so the ellipsis can be used to indicate that the
969 XSUB will take a variable number of parameters.  Perl should
970 be able to call this XSUB with either of the following statements.
971
972      $status = rpcb_gettime( $timep, $host );
973
974      $status = rpcb_gettime( $timep );
975
976 The XS code, with ellipsis, follows.
977
978      bool_t
979      rpcb_gettime(timep, ...)
980           time_t timep = NO_INIT
981         PREINIT:
982           char *host = "localhost";
983         CODE:
984           if( items > 1 )
985                host = (char *)SvPV_nolen(ST(1));
986           RETVAL = rpcb_gettime( host, &timep );
987         OUTPUT:
988           timep
989           RETVAL
990
991 =head2 The C_ARGS: Keyword
992
993 The C_ARGS: keyword allows creating of XSUBS which have different
994 calling sequence from Perl than from C, without a need to write
995 CODE: or PPCODE: section.  The contents of the C_ARGS: paragraph is
996 put as the argument to the called C function without any change.
997
998 For example, suppose that a C function is declared as
999
1000     symbolic nth_derivative(int n, symbolic function, int flags);
1001
1002 and that the default flags are kept in a global C variable
1003 C<default_flags>.  Suppose that you want to create an interface which
1004 is called as
1005
1006     $second_deriv = $function->nth_derivative(2);
1007
1008 To do this, declare the XSUB as
1009
1010     symbolic
1011     nth_derivative(function, n)
1012         symbolic        function
1013         int             n
1014       C_ARGS:
1015         n, function, default_flags
1016
1017 =head2 The PPCODE: Keyword
1018
1019 The PPCODE: keyword is an alternate form of the CODE: keyword and is used
1020 to tell the B<xsubpp> compiler that the programmer is supplying the code to
1021 control the argument stack for the XSUBs return values.  Occasionally one
1022 will want an XSUB to return a list of values rather than a single value.
1023 In these cases one must use PPCODE: and then explicitly push the list of
1024 values on the stack.  The PPCODE: and CODE:  keywords should not be used
1025 together within the same XSUB.
1026
1027 The actual difference between PPCODE: and CODE: sections is in the
1028 initialization of C<SP> macro (which stands for the I<current> Perl
1029 stack pointer), and in the handling of data on the stack when returning
1030 from an XSUB.  In CODE: sections SP preserves the value which was on
1031 entry to the XSUB: SP is on the function pointer (which follows the
1032 last parameter).  In PPCODE: sections SP is moved backward to the
1033 beginning of the parameter list, which allows C<PUSH*()> macros
1034 to place output values in the place Perl expects them to be when
1035 the XSUB returns back to Perl.
1036
1037 The generated trailer for a CODE: section ensures that the number of return
1038 values Perl will see is either 0 or 1 (depending on the C<void>ness of the
1039 return value of the C function, and heuristics mentioned in
1040 L<"The RETVAL Variable">).  The trailer generated for a PPCODE: section
1041 is based on the number of return values and on the number of times
1042 C<SP> was updated by C<[X]PUSH*()> macros.
1043
1044 Note that macros C<ST(i)>, C<XST_m*()> and C<XSRETURN*()> work equally
1045 well in CODE: sections and PPCODE: sections.
1046
1047 The following XSUB will call the C rpcb_gettime() function
1048 and will return its two output values, timep and status, to
1049 Perl as a single list.
1050
1051      void
1052      rpcb_gettime(host)
1053           char *host
1054         PREINIT:
1055           time_t  timep;
1056           bool_t  status;
1057         PPCODE:
1058           status = rpcb_gettime( host, &timep );
1059           EXTEND(SP, 2);
1060           PUSHs(sv_2mortal(newSViv(status)));
1061           PUSHs(sv_2mortal(newSViv(timep)));
1062
1063 Notice that the programmer must supply the C code necessary
1064 to have the real rpcb_gettime() function called and to have
1065 the return values properly placed on the argument stack.
1066
1067 The C<void> return type for this function tells the B<xsubpp> compiler that
1068 the RETVAL variable is not needed or used and that it should not be created.
1069 In most scenarios the void return type should be used with the PPCODE:
1070 directive.
1071
1072 The EXTEND() macro is used to make room on the argument
1073 stack for 2 return values.  The PPCODE: directive causes the
1074 B<xsubpp> compiler to create a stack pointer available as C<SP>, and it
1075 is this pointer which is being used in the EXTEND() macro.
1076 The values are then pushed onto the stack with the PUSHs()
1077 macro.
1078
1079 Now the rpcb_gettime() function can be used from Perl with
1080 the following statement.
1081
1082      ($status, $timep) = rpcb_gettime("localhost");
1083
1084 When handling output parameters with a PPCODE section, be sure to handle
1085 'set' magic properly.  See L<perlguts> for details about 'set' magic.
1086
1087 =head2 Returning Undef And Empty Lists
1088
1089 Occasionally the programmer will want to return simply
1090 C<undef> or an empty list if a function fails rather than a
1091 separate status value.  The rpcb_gettime() function offers
1092 just this situation.  If the function succeeds we would like
1093 to have it return the time and if it fails we would like to
1094 have undef returned.  In the following Perl code the value
1095 of $timep will either be undef or it will be a valid time.
1096
1097      $timep = rpcb_gettime( "localhost" );
1098
1099 The following XSUB uses the C<SV *> return type as a mnemonic only,
1100 and uses a CODE: block to indicate to the compiler
1101 that the programmer has supplied all the necessary code.  The
1102 sv_newmortal() call will initialize the return value to undef, making that
1103 the default return value.
1104
1105      SV *
1106      rpcb_gettime(host)
1107           char *  host
1108         PREINIT:
1109           time_t  timep;
1110           bool_t x;
1111         CODE:
1112           ST(0) = sv_newmortal();
1113           if( rpcb_gettime( host, &timep ) )
1114                sv_setnv( ST(0), (double)timep);
1115
1116 The next example demonstrates how one would place an explicit undef in the
1117 return value, should the need arise.
1118
1119      SV *
1120      rpcb_gettime(host)
1121           char *  host
1122         PREINIT:
1123           time_t  timep;
1124           bool_t x;
1125         CODE:
1126           if( rpcb_gettime( host, &timep ) ){
1127                ST(0) = sv_newmortal();
1128                sv_setnv( ST(0), (double)timep);
1129           }
1130           else{
1131                ST(0) = &PL_sv_undef;
1132           }
1133
1134 To return an empty list one must use a PPCODE: block and
1135 then not push return values on the stack.
1136
1137      void
1138      rpcb_gettime(host)
1139           char *host
1140         PREINIT:
1141           time_t  timep;
1142         PPCODE:
1143           if( rpcb_gettime( host, &timep ) )
1144                PUSHs(sv_2mortal(newSViv(timep)));
1145           else{
1146               /* Nothing pushed on stack, so an empty
1147                * list is implicitly returned. */
1148           }
1149
1150 Some people may be inclined to include an explicit C<return> in the above
1151 XSUB, rather than letting control fall through to the end.  In those
1152 situations C<XSRETURN_EMPTY> should be used, instead.  This will ensure that
1153 the XSUB stack is properly adjusted.  Consult L<perlapi> for other
1154 C<XSRETURN> macros.
1155
1156 Since C<XSRETURN_*> macros can be used with CODE blocks as well, one can
1157 rewrite this example as:
1158
1159      int
1160      rpcb_gettime(host)
1161           char *host
1162         PREINIT:
1163           time_t  timep;
1164         CODE:
1165           RETVAL = rpcb_gettime( host, &timep );
1166           if (RETVAL == 0)
1167                 XSRETURN_UNDEF;
1168         OUTPUT:
1169           RETVAL
1170
1171 In fact, one can put this check into a POSTCALL: section as well.  Together
1172 with PREINIT: simplifications, this leads to:
1173
1174      int
1175      rpcb_gettime(host)
1176           char *host
1177           time_t  timep;
1178         POSTCALL:
1179           if (RETVAL == 0)
1180                 XSRETURN_UNDEF;
1181
1182 =head2 The REQUIRE: Keyword
1183
1184 The REQUIRE: keyword is used to indicate the minimum version of the
1185 B<xsubpp> compiler needed to compile the XS module.  An XS module which
1186 contains the following statement will compile with only B<xsubpp> version
1187 1.922 or greater:
1188
1189         REQUIRE: 1.922
1190
1191 =head2 The CLEANUP: Keyword
1192
1193 This keyword can be used when an XSUB requires special cleanup procedures
1194 before it terminates.  When the CLEANUP:  keyword is used it must follow
1195 any CODE:, PPCODE:, or OUTPUT: blocks which are present in the XSUB.  The
1196 code specified for the cleanup block will be added as the last statements
1197 in the XSUB.
1198
1199 =head2 The POSTCALL: Keyword
1200
1201 This keyword can be used when an XSUB requires special procedures
1202 executed after the C subroutine call is performed.  When the POSTCALL:
1203 keyword is used it must precede OUTPUT: and CLEANUP: blocks which are
1204 present in the XSUB.
1205
1206 See examples in L<"The NO_OUTPUT Keyword"> and L<"Returning Undef And Empty Lists">.
1207
1208 The POSTCALL: block does not make a lot of sense when the C subroutine
1209 call is supplied by user by providing either CODE: or PPCODE: section.
1210
1211 =head2 The BOOT: Keyword
1212
1213 The BOOT: keyword is used to add code to the extension's bootstrap
1214 function.  The bootstrap function is generated by the B<xsubpp> compiler and
1215 normally holds the statements necessary to register any XSUBs with Perl.
1216 With the BOOT: keyword the programmer can tell the compiler to add extra
1217 statements to the bootstrap function.
1218
1219 This keyword may be used any time after the first MODULE keyword and should
1220 appear on a line by itself.  The first blank line after the keyword will
1221 terminate the code block.
1222
1223      BOOT:
1224      # The following message will be printed when the
1225      # bootstrap function executes.
1226      printf("Hello from the bootstrap!\n");
1227
1228 =head2 The VERSIONCHECK: Keyword
1229
1230 The VERSIONCHECK: keyword corresponds to B<xsubpp>'s C<-versioncheck> and
1231 C<-noversioncheck> options.  This keyword overrides the command line
1232 options.  Version checking is enabled by default.  When version checking is
1233 enabled the XS module will attempt to verify that its version matches the
1234 version of the PM module.
1235
1236 To enable version checking:
1237
1238     VERSIONCHECK: ENABLE
1239
1240 To disable version checking:
1241
1242     VERSIONCHECK: DISABLE
1243
1244 Note that if the version of the PM module is an NV (a floating point
1245 number), it will be stringified with a possible loss of precision
1246 (currently chopping to nine decimal places) so that it may not match
1247 the version of the XS module anymore. Quoting the $VERSION declaration
1248 to make it a string is recommended if long version numbers are used.
1249
1250 =head2 The PROTOTYPES: Keyword
1251
1252 The PROTOTYPES: keyword corresponds to B<xsubpp>'s C<-prototypes> and
1253 C<-noprototypes> options.  This keyword overrides the command line options.
1254 Prototypes are enabled by default.  When prototypes are enabled XSUBs will
1255 be given Perl prototypes.  This keyword may be used multiple times in an XS
1256 module to enable and disable prototypes for different parts of the module.
1257
1258 To enable prototypes:
1259
1260     PROTOTYPES: ENABLE
1261
1262 To disable prototypes:
1263
1264     PROTOTYPES: DISABLE
1265
1266 =head2 The PROTOTYPE: Keyword
1267
1268 This keyword is similar to the PROTOTYPES: keyword above but can be used to
1269 force B<xsubpp> to use a specific prototype for the XSUB.  This keyword
1270 overrides all other prototype options and keywords but affects only the
1271 current XSUB.  Consult L<perlsub/Prototypes> for information about Perl
1272 prototypes.
1273
1274     bool_t
1275     rpcb_gettime(timep, ...)
1276           time_t timep = NO_INIT
1277         PROTOTYPE: $;$
1278         PREINIT:
1279           char *host = "localhost";
1280         CODE:
1281                   if( items > 1 )
1282                        host = (char *)SvPV_nolen(ST(1));
1283                   RETVAL = rpcb_gettime( host, &timep );
1284         OUTPUT:
1285           timep
1286           RETVAL
1287
1288 If the prototypes are enabled, you can disable it locally for a given
1289 XSUB as in the following example:
1290
1291     void
1292     rpcb_gettime_noproto()
1293         PROTOTYPE: DISABLE
1294     ...
1295
1296 =head2 The ALIAS: Keyword
1297
1298 The ALIAS: keyword allows an XSUB to have two or more unique Perl names
1299 and to know which of those names was used when it was invoked.  The Perl
1300 names may be fully-qualified with package names.  Each alias is given an
1301 index.  The compiler will setup a variable called C<ix> which contain the
1302 index of the alias which was used.  When the XSUB is called with its
1303 declared name C<ix> will be 0.
1304
1305 The following example will create aliases C<FOO::gettime()> and
1306 C<BAR::getit()> for this function.
1307
1308     bool_t
1309     rpcb_gettime(host,timep)
1310           char *host
1311           time_t &timep
1312         ALIAS:
1313             FOO::gettime = 1
1314             BAR::getit = 2
1315         INIT:
1316           printf("# ix = %d\n", ix );
1317         OUTPUT:
1318           timep
1319
1320 =head2 The OVERLOAD: Keyword
1321
1322 Instead of writing an overloaded interface using pure Perl, you
1323 can also use the OVERLOAD keyword to define additional Perl names
1324 for your functions (like the ALIAS: keyword above).  However, the
1325 overloaded functions must be defined with three parameters (except
1326 for the nomethod() function which needs four parameters).  If any
1327 function has the OVERLOAD: keyword, several additional lines
1328 will be defined in the c file generated by xsubpp in order to
1329 register with the overload magic.
1330
1331 Since blessed objects are actually stored as RV's, it is useful
1332 to use the typemap features to preprocess parameters and extract
1333 the actual SV stored within the blessed RV.  See the sample for
1334 T_PTROBJ_SPECIAL below.
1335
1336 To use the OVERLOAD: keyword, create an XS function which takes
1337 three input parameters ( or use the c style '...' definition) like
1338 this:
1339
1340     SV *
1341     cmp (lobj, robj, swap)
1342     My_Module_obj    lobj
1343     My_Module_obj    robj
1344     IV               swap
1345     OVERLOAD: cmp <=>
1346     { /* function defined here */}
1347
1348 In this case, the function will overload both of the three way
1349 comparison operators.  For all overload operations using non-alpha
1350 characters, you must type the parameter without quoting, separating
1351 multiple overloads with whitespace.  Note that "" (the stringify
1352 overload) should be entered as \"\" (i.e. escaped).
1353
1354 =head2 The FALLBACK: Keyword
1355
1356 In addition to the OVERLOAD keyword, if you need to control how
1357 Perl autogenerates missing overloaded operators, you can set the
1358 FALLBACK keyword in the module header section, like this:
1359
1360     MODULE = RPC  PACKAGE = RPC
1361
1362     FALLBACK: TRUE
1363     ...
1364
1365 where FALLBACK can take any of the three values TRUE, FALSE, or
1366 UNDEF.  If you do not set any FALLBACK value when using OVERLOAD,
1367 it defaults to UNDEF.  FALLBACK is not used except when one or
1368 more functions using OVERLOAD have been defined.  Please see
1369 L<overload/fallback> for more details.
1370
1371 =head2 The INTERFACE: Keyword
1372
1373 This keyword declares the current XSUB as a keeper of the given
1374 calling signature.  If some text follows this keyword, it is
1375 considered as a list of functions which have this signature, and
1376 should be attached to the current XSUB.
1377
1378 For example, if you have 4 C functions multiply(), divide(), add(),
1379 subtract() all having the signature:
1380
1381     symbolic f(symbolic, symbolic);
1382
1383 you can make them all to use the same XSUB using this:
1384
1385     symbolic
1386     interface_s_ss(arg1, arg2)
1387         symbolic        arg1
1388         symbolic        arg2
1389     INTERFACE:
1390         multiply divide
1391         add subtract
1392
1393 (This is the complete XSUB code for 4 Perl functions!)  Four generated
1394 Perl function share names with corresponding C functions.
1395
1396 The advantage of this approach comparing to ALIAS: keyword is that there
1397 is no need to code a switch statement, each Perl function (which shares
1398 the same XSUB) knows which C function it should call.  Additionally, one
1399 can attach an extra function remainder() at runtime by using
1400
1401     CV *mycv = newXSproto("Symbolic::remainder",
1402                           XS_Symbolic_interface_s_ss, __FILE__, "$$");
1403     XSINTERFACE_FUNC_SET(mycv, remainder);
1404
1405 say, from another XSUB.  (This example supposes that there was no
1406 INTERFACE_MACRO: section, otherwise one needs to use something else instead of
1407 C<XSINTERFACE_FUNC_SET>, see the next section.)
1408
1409 =head2 The INTERFACE_MACRO: Keyword
1410
1411 This keyword allows one to define an INTERFACE using a different way
1412 to extract a function pointer from an XSUB.  The text which follows
1413 this keyword should give the name of macros which would extract/set a
1414 function pointer.  The extractor macro is given return type, C<CV*>,
1415 and C<XSANY.any_dptr> for this C<CV*>.  The setter macro is given cv,
1416 and the function pointer.
1417
1418 The default value is C<XSINTERFACE_FUNC> and C<XSINTERFACE_FUNC_SET>.
1419 An INTERFACE keyword with an empty list of functions can be omitted if
1420 INTERFACE_MACRO keyword is used.
1421
1422 Suppose that in the previous example functions pointers for
1423 multiply(), divide(), add(), subtract() are kept in a global C array
1424 C<fp[]> with offsets being C<multiply_off>, C<divide_off>, C<add_off>,
1425 C<subtract_off>.  Then one can use
1426
1427     #define XSINTERFACE_FUNC_BYOFFSET(ret,cv,f) \
1428         ((XSINTERFACE_CVT_ANON(ret))fp[CvXSUBANY(cv).any_i32])
1429     #define XSINTERFACE_FUNC_BYOFFSET_set(cv,f) \
1430         CvXSUBANY(cv).any_i32 = CAT2( f, _off )
1431
1432 in C section,
1433
1434     symbolic
1435     interface_s_ss(arg1, arg2)
1436         symbolic        arg1
1437         symbolic        arg2
1438       INTERFACE_MACRO:
1439         XSINTERFACE_FUNC_BYOFFSET
1440         XSINTERFACE_FUNC_BYOFFSET_set
1441       INTERFACE:
1442         multiply divide
1443         add subtract
1444
1445 in XSUB section.
1446
1447 =head2 The INCLUDE: Keyword
1448
1449 This keyword can be used to pull other files into the XS module.  The other
1450 files may have XS code.  INCLUDE: can also be used to run a command to
1451 generate the XS code to be pulled into the module.
1452
1453 The file F<Rpcb1.xsh> contains our C<rpcb_gettime()> function:
1454
1455     bool_t
1456     rpcb_gettime(host,timep)
1457           char *host
1458           time_t &timep
1459         OUTPUT:
1460           timep
1461
1462 The XS module can use INCLUDE: to pull that file into it.
1463
1464     INCLUDE: Rpcb1.xsh
1465
1466 If the parameters to the INCLUDE: keyword are followed by a pipe (C<|>) then
1467 the compiler will interpret the parameters as a command. This feature is
1468 mildly deprecated in favour of the C<INCLUDE_COMMAND:> directive, as documented
1469 below.
1470
1471     INCLUDE: cat Rpcb1.xsh |
1472
1473 Do not use this to run perl: C<INCLUDE: perl |> will run the perl that
1474 happens to be the first in your path and not necessarily the same perl that is
1475 used to run C<xsubpp>. See L<"The INCLUDE_COMMAND: Keyword">.
1476
1477 =head2 The INCLUDE_COMMAND: Keyword
1478
1479 Runs the supplied command and includes its output into the current XS
1480 document. C<INCLUDE_COMMAND> assigns special meaning to the C<$^X> token
1481 in that it runs the same perl interpreter that is running C<xsubpp>:
1482
1483     INCLUDE_COMMAND: cat Rpcb1.xsh
1484
1485     INCLUDE_COMMAND: $^X -e ...
1486
1487 =head2 The CASE: Keyword
1488
1489 The CASE: keyword allows an XSUB to have multiple distinct parts with each
1490 part acting as a virtual XSUB.  CASE: is greedy and if it is used then all
1491 other XS keywords must be contained within a CASE:.  This means nothing may
1492 precede the first CASE: in the XSUB and anything following the last CASE: is
1493 included in that case.
1494
1495 A CASE: might switch via a parameter of the XSUB, via the C<ix> ALIAS:
1496 variable (see L<"The ALIAS: Keyword">), or maybe via the C<items> variable
1497 (see L<"Variable-length Parameter Lists">).  The last CASE: becomes the
1498 B<default> case if it is not associated with a conditional.  The following
1499 example shows CASE switched via C<ix> with a function C<rpcb_gettime()>
1500 having an alias C<x_gettime()>.  When the function is called as
1501 C<rpcb_gettime()> its parameters are the usual C<(char *host, time_t *timep)>,
1502 but when the function is called as C<x_gettime()> its parameters are
1503 reversed, C<(time_t *timep, char *host)>.
1504
1505     long
1506     rpcb_gettime(a,b)
1507       CASE: ix == 1
1508         ALIAS:
1509           x_gettime = 1
1510         INPUT:
1511           # 'a' is timep, 'b' is host
1512           char *b
1513           time_t a = NO_INIT
1514         CODE:
1515                RETVAL = rpcb_gettime( b, &a );
1516         OUTPUT:
1517           a
1518           RETVAL
1519       CASE:
1520           # 'a' is host, 'b' is timep
1521           char *a
1522           time_t &b = NO_INIT
1523         OUTPUT:
1524           b
1525           RETVAL
1526
1527 That function can be called with either of the following statements.  Note
1528 the different argument lists.
1529
1530         $status = rpcb_gettime( $host, $timep );
1531
1532         $status = x_gettime( $timep, $host );
1533
1534 =head2 The EXPORT_XSUB_SYMBOLS: Keyword
1535
1536 The EXPORT_XSUB_SYMBOLS: keyword is likely something you will never need.
1537 In perl versions earlier than 5.16.0, this keyword does nothing. Starting
1538 with 5.16, XSUB symbols are no longer exported by default. That is, they
1539 are C<static> functions. If you include
1540
1541   EXPORT_XSUB_SYMBOLS: ENABLE
1542
1543 in your XS code, the XSUBs following this line will not be declared C<static>.
1544 You can later disable this with
1545
1546   EXPORT_XSUB_SYMBOLS: DISABLE
1547
1548 which, again, is the default that you should probably never change.
1549 You cannot use this keyword on versions of perl before 5.16 to make
1550 XSUBs C<static>.
1551
1552 =head2 The & Unary Operator
1553
1554 The C<&> unary operator in the INPUT: section is used to tell B<xsubpp>
1555 that it should convert a Perl value to/from C using the C type to the left
1556 of C<&>, but provide a pointer to this value when the C function is called.
1557
1558 This is useful to avoid a CODE: block for a C function which takes a parameter
1559 by reference.  Typically, the parameter should be not a pointer type (an
1560 C<int> or C<long> but not an C<int*> or C<long*>).
1561
1562 The following XSUB will generate incorrect C code.  The B<xsubpp> compiler will
1563 turn this into code which calls C<rpcb_gettime()> with parameters C<(char
1564 *host, time_t timep)>, but the real C<rpcb_gettime()> wants the C<timep>
1565 parameter to be of type C<time_t*> rather than C<time_t>.
1566
1567     bool_t
1568     rpcb_gettime(host,timep)
1569           char *host
1570           time_t timep
1571         OUTPUT:
1572           timep
1573
1574 That problem is corrected by using the C<&> operator.  The B<xsubpp> compiler
1575 will now turn this into code which calls C<rpcb_gettime()> correctly with
1576 parameters C<(char *host, time_t *timep)>.  It does this by carrying the
1577 C<&> through, so the function call looks like C<rpcb_gettime(host, &timep)>.
1578
1579     bool_t
1580     rpcb_gettime(host,timep)
1581           char *host
1582           time_t &timep
1583         OUTPUT:
1584           timep
1585
1586 =head2 Inserting POD, Comments and C Preprocessor Directives
1587
1588 C preprocessor directives are allowed within BOOT:, PREINIT: INIT:, CODE:,
1589 PPCODE:, POSTCALL:, and CLEANUP: blocks, as well as outside the functions.
1590 Comments are allowed anywhere after the MODULE keyword.  The compiler will
1591 pass the preprocessor directives through untouched and will remove the
1592 commented lines. POD documentation is allowed at any point, both in the
1593 C and XS language sections. POD must be terminated with a C<=cut> command;
1594 C<xsubpp> will exit with an error if it does not. It is very unlikely that
1595 human generated C code will be mistaken for POD, as most indenting styles
1596 result in whitespace in front of any line starting with C<=>. Machine
1597 generated XS files may fall into this trap unless care is taken to
1598 ensure that a space breaks the sequence "\n=".
1599
1600 Comments can be added to XSUBs by placing a C<#> as the first
1601 non-whitespace of a line.  Care should be taken to avoid making the
1602 comment look like a C preprocessor directive, lest it be interpreted as
1603 such.  The simplest way to prevent this is to put whitespace in front of
1604 the C<#>.
1605
1606 If you use preprocessor directives to choose one of two
1607 versions of a function, use
1608
1609     #if ... version1
1610     #else /* ... version2  */
1611     #endif
1612
1613 and not
1614
1615     #if ... version1
1616     #endif
1617     #if ... version2
1618     #endif
1619
1620 because otherwise B<xsubpp> will believe that you made a duplicate
1621 definition of the function.  Also, put a blank line before the
1622 #else/#endif so it will not be seen as part of the function body.
1623
1624 =head2 Using XS With C++
1625
1626 If an XSUB name contains C<::>, it is considered to be a C++ method.
1627 The generated Perl function will assume that
1628 its first argument is an object pointer.  The object pointer
1629 will be stored in a variable called THIS.  The object should
1630 have been created by C++ with the new() function and should
1631 be blessed by Perl with the sv_setref_pv() macro.  The
1632 blessing of the object by Perl can be handled by a typemap.  An example
1633 typemap is shown at the end of this section.
1634
1635 If the return type of the XSUB includes C<static>, the method is considered
1636 to be a static method.  It will call the C++
1637 function using the class::method() syntax.  If the method is not static
1638 the function will be called using the THIS-E<gt>method() syntax.
1639
1640 The next examples will use the following C++ class.
1641
1642      class color {
1643           public:
1644           color();
1645           ~color();
1646           int blue();
1647           void set_blue( int );
1648
1649           private:
1650           int c_blue;
1651      };
1652
1653 The XSUBs for the blue() and set_blue() methods are defined with the class
1654 name but the parameter for the object (THIS, or "self") is implicit and is
1655 not listed.
1656
1657      int
1658      color::blue()
1659
1660      void
1661      color::set_blue( val )
1662           int val
1663
1664 Both Perl functions will expect an object as the first parameter.  In the
1665 generated C++ code the object is called C<THIS>, and the method call will
1666 be performed on this object.  So in the C++ code the blue() and set_blue()
1667 methods will be called as this:
1668
1669      RETVAL = THIS->blue();
1670
1671      THIS->set_blue( val );
1672
1673 You could also write a single get/set method using an optional argument:
1674
1675      int
1676      color::blue( val = NO_INIT )
1677          int val
1678          PROTOTYPE $;$
1679          CODE:
1680              if (items > 1)
1681                  THIS->set_blue( val );
1682              RETVAL = THIS->blue();
1683          OUTPUT:
1684              RETVAL
1685
1686 If the function's name is B<DESTROY> then the C++ C<delete> function will be
1687 called and C<THIS> will be given as its parameter.  The generated C++ code for
1688
1689      void
1690      color::DESTROY()
1691
1692 will look like this:
1693
1694      color *THIS = ...;  // Initialized as in typemap
1695
1696      delete THIS;
1697
1698 If the function's name is B<new> then the C++ C<new> function will be called
1699 to create a dynamic C++ object.  The XSUB will expect the class name, which
1700 will be kept in a variable called C<CLASS>, to be given as the first
1701 argument.
1702
1703      color *
1704      color::new()
1705
1706 The generated C++ code will call C<new>.
1707
1708      RETVAL = new color();
1709
1710 The following is an example of a typemap that could be used for this C++
1711 example.
1712
1713     TYPEMAP
1714     color *  O_OBJECT
1715
1716     OUTPUT
1717     # The Perl object is blessed into 'CLASS', which should be a
1718     # char* having the name of the package for the blessing.
1719     O_OBJECT
1720         sv_setref_pv( $arg, CLASS, (void*)$var );
1721
1722     INPUT
1723     O_OBJECT
1724         if( sv_isobject($arg) && (SvTYPE(SvRV($arg)) == SVt_PVMG) )
1725             $var = ($type)SvIV((SV*)SvRV( $arg ));
1726         else{
1727             warn("${Package}::$func_name() -- " .
1728                 "$var is not a blessed SV reference");
1729             XSRETURN_UNDEF;
1730         }
1731
1732 =head2 Interface Strategy
1733
1734 When designing an interface between Perl and a C library a straight
1735 translation from C to XS (such as created by C<h2xs -x>) is often sufficient.
1736 However, sometimes the interface will look
1737 very C-like and occasionally nonintuitive, especially when the C function
1738 modifies one of its parameters, or returns failure inband (as in "negative
1739 return values mean failure").  In cases where the programmer wishes to
1740 create a more Perl-like interface the following strategy may help to
1741 identify the more critical parts of the interface.
1742
1743 Identify the C functions with input/output or output parameters.  The XSUBs for
1744 these functions may be able to return lists to Perl.
1745
1746 Identify the C functions which use some inband info as an indication
1747 of failure.  They may be
1748 candidates to return undef or an empty list in case of failure.  If the
1749 failure may be detected without a call to the C function, you may want to use
1750 an INIT: section to report the failure.  For failures detectable after the C
1751 function returns one may want to use a POSTCALL: section to process the
1752 failure.  In more complicated cases use CODE: or PPCODE: sections.
1753
1754 If many functions use the same failure indication based on the return value,
1755 you may want to create a special typedef to handle this situation.  Put
1756
1757   typedef int negative_is_failure;
1758
1759 near the beginning of XS file, and create an OUTPUT typemap entry
1760 for C<negative_is_failure> which converts negative values to C<undef>, or
1761 maybe croak()s.  After this the return value of type C<negative_is_failure>
1762 will create more Perl-like interface.
1763
1764 Identify which values are used by only the C and XSUB functions
1765 themselves, say, when a parameter to a function should be a contents of a
1766 global variable.  If Perl does not need to access the contents of the value
1767 then it may not be necessary to provide a translation for that value
1768 from C to Perl.
1769
1770 Identify the pointers in the C function parameter lists and return
1771 values.  Some pointers may be used to implement input/output or
1772 output parameters, they can be handled in XS with the C<&> unary operator,
1773 and, possibly, using the NO_INIT keyword.
1774 Some others will require handling of types like C<int *>, and one needs
1775 to decide what a useful Perl translation will do in such a case.  When
1776 the semantic is clear, it is advisable to put the translation into a typemap
1777 file.
1778
1779 Identify the structures used by the C functions.  In many
1780 cases it may be helpful to use the T_PTROBJ typemap for
1781 these structures so they can be manipulated by Perl as
1782 blessed objects.  (This is handled automatically by C<h2xs -x>.)
1783
1784 If the same C type is used in several different contexts which require
1785 different translations, C<typedef> several new types mapped to this C type,
1786 and create separate F<typemap> entries for these new types.  Use these
1787 types in declarations of return type and parameters to XSUBs.
1788
1789 =head2 Perl Objects And C Structures
1790
1791 When dealing with C structures one should select either
1792 B<T_PTROBJ> or B<T_PTRREF> for the XS type.  Both types are
1793 designed to handle pointers to complex objects.  The
1794 T_PTRREF type will allow the Perl object to be unblessed
1795 while the T_PTROBJ type requires that the object be blessed.
1796 By using T_PTROBJ one can achieve a form of type-checking
1797 because the XSUB will attempt to verify that the Perl object
1798 is of the expected type.
1799
1800 The following XS code shows the getnetconfigent() function which is used
1801 with ONC+ TIRPC.  The getnetconfigent() function will return a pointer to a
1802 C structure and has the C prototype shown below.  The example will
1803 demonstrate how the C pointer will become a Perl reference.  Perl will
1804 consider this reference to be a pointer to a blessed object and will
1805 attempt to call a destructor for the object.  A destructor will be
1806 provided in the XS source to free the memory used by getnetconfigent().
1807 Destructors in XS can be created by specifying an XSUB function whose name
1808 ends with the word B<DESTROY>.  XS destructors can be used to free memory
1809 which may have been malloc'd by another XSUB.
1810
1811      struct netconfig *getnetconfigent(const char *netid);
1812
1813 A C<typedef> will be created for C<struct netconfig>.  The Perl
1814 object will be blessed in a class matching the name of the C
1815 type, with the tag C<Ptr> appended, and the name should not
1816 have embedded spaces if it will be a Perl package name.  The
1817 destructor will be placed in a class corresponding to the
1818 class of the object and the PREFIX keyword will be used to
1819 trim the name to the word DESTROY as Perl will expect.
1820
1821      typedef struct netconfig Netconfig;
1822
1823      MODULE = RPC  PACKAGE = RPC
1824
1825      Netconfig *
1826      getnetconfigent(netid)
1827           char *netid
1828
1829      MODULE = RPC  PACKAGE = NetconfigPtr  PREFIX = rpcb_
1830
1831      void
1832      rpcb_DESTROY(netconf)
1833           Netconfig *netconf
1834         CODE:
1835           printf("Now in NetconfigPtr::DESTROY\n");
1836           free( netconf );
1837
1838 This example requires the following typemap entry.  Consult
1839 L<perlxstypemap> for more information about adding new typemaps
1840 for an extension.
1841
1842      TYPEMAP
1843      Netconfig *  T_PTROBJ
1844
1845 This example will be used with the following Perl statements.
1846
1847      use RPC;
1848      $netconf = getnetconfigent("udp");
1849
1850 When Perl destroys the object referenced by $netconf it will send the
1851 object to the supplied XSUB DESTROY function.  Perl cannot determine, and
1852 does not care, that this object is a C struct and not a Perl object.  In
1853 this sense, there is no difference between the object created by the
1854 getnetconfigent() XSUB and an object created by a normal Perl subroutine.
1855
1856 =head2 Safely Storing Static Data in XS
1857
1858 Starting with Perl 5.8, a macro framework has been defined to allow
1859 static data to be safely stored in XS modules that will be accessed from
1860 a multi-threaded Perl.
1861
1862 Although primarily designed for use with multi-threaded Perl, the macros
1863 have been designed so that they will work with non-threaded Perl as well.
1864
1865 It is therefore strongly recommended that these macros be used by all
1866 XS modules that make use of static data.
1867
1868 The easiest way to get a template set of macros to use is by specifying
1869 the C<-g> (C<--global>) option with h2xs (see L<h2xs>).
1870
1871 Below is an example module that makes use of the macros.
1872
1873     #include "EXTERN.h"
1874     #include "perl.h"
1875     #include "XSUB.h"
1876
1877     /* Global Data */
1878
1879     #define MY_CXT_KEY "BlindMice::_guts" XS_VERSION
1880
1881     typedef struct {
1882         int count;
1883         char name[3][100];
1884     } my_cxt_t;
1885
1886     START_MY_CXT
1887
1888     MODULE = BlindMice           PACKAGE = BlindMice
1889
1890     BOOT:
1891     {
1892         MY_CXT_INIT;
1893         MY_CXT.count = 0;
1894         strcpy(MY_CXT.name[0], "None");
1895         strcpy(MY_CXT.name[1], "None");
1896         strcpy(MY_CXT.name[2], "None");
1897     }
1898
1899     int
1900     newMouse(char * name)
1901         PREINIT:
1902           dMY_CXT;
1903         CODE:
1904           if (MY_CXT.count >= 3) {
1905               warn("Already have 3 blind mice");
1906               RETVAL = 0;
1907           }
1908           else {
1909               RETVAL = ++ MY_CXT.count;
1910               strcpy(MY_CXT.name[MY_CXT.count - 1], name);
1911           }
1912         OUTPUT:
1913           RETVAL
1914
1915     char *
1916     get_mouse_name(index)
1917           int index
1918         PREINIT:
1919           dMY_CXT;
1920         CODE:
1921           if (index > MY_CXT.count)
1922             croak("There are only 3 blind mice.");
1923           else
1924             RETVAL = MY_CXT.name[index - 1];
1925         OUTPUT:
1926           RETVAL
1927
1928     void
1929     CLONE(...)
1930         CODE:
1931           MY_CXT_CLONE;
1932
1933 =head3 MY_CXT REFERENCE
1934
1935 =over 5
1936
1937 =item MY_CXT_KEY
1938
1939 This macro is used to define a unique key to refer to the static data
1940 for an XS module. The suggested naming scheme, as used by h2xs, is to
1941 use a string that consists of the module name, the string "::_guts"
1942 and the module version number.
1943
1944     #define MY_CXT_KEY "MyModule::_guts" XS_VERSION
1945
1946 =item typedef my_cxt_t
1947
1948 This struct typedef I<must> always be called C<my_cxt_t>. The other
1949 C<CXT*> macros assume the existence of the C<my_cxt_t> typedef name.
1950
1951 Declare a typedef named C<my_cxt_t> that is a structure that contains
1952 all the data that needs to be interpreter-local.
1953
1954     typedef struct {
1955         int some_value;
1956     } my_cxt_t;
1957
1958 =item START_MY_CXT
1959
1960 Always place the START_MY_CXT macro directly after the declaration
1961 of C<my_cxt_t>.
1962
1963 =item MY_CXT_INIT
1964
1965 The MY_CXT_INIT macro initializes storage for the C<my_cxt_t> struct.
1966
1967 It I<must> be called exactly once, typically in a BOOT: section. If you
1968 are maintaining multiple interpreters, it should be called once in each
1969 interpreter instance, except for interpreters cloned from existing ones.
1970 (But see L</MY_CXT_CLONE> below.)
1971
1972 =item dMY_CXT
1973
1974 Use the dMY_CXT macro (a declaration) in all the functions that access
1975 MY_CXT.
1976
1977 =item MY_CXT
1978
1979 Use the MY_CXT macro to access members of the C<my_cxt_t> struct. For
1980 example, if C<my_cxt_t> is
1981
1982     typedef struct {
1983         int index;
1984     } my_cxt_t;
1985
1986 then use this to access the C<index> member
1987
1988     dMY_CXT;
1989     MY_CXT.index = 2;
1990
1991 =item aMY_CXT/pMY_CXT
1992
1993 C<dMY_CXT> may be quite expensive to calculate, and to avoid the overhead
1994 of invoking it in each function it is possible to pass the declaration
1995 onto other functions using the C<aMY_CXT>/C<pMY_CXT> macros, eg
1996
1997     void sub1() {
1998         dMY_CXT;
1999         MY_CXT.index = 1;
2000         sub2(aMY_CXT);
2001     }
2002
2003     void sub2(pMY_CXT) {
2004         MY_CXT.index = 2;
2005     }
2006
2007 Analogously to C<pTHX>, there are equivalent forms for when the macro is the
2008 first or last in multiple arguments, where an underscore represents a
2009 comma, i.e.  C<_aMY_CXT>, C<aMY_CXT_>, C<_pMY_CXT> and C<pMY_CXT_>.
2010
2011 =item MY_CXT_CLONE
2012
2013 By default, when a new interpreter is created as a copy of an existing one
2014 (eg via C<< threads->create() >>), both interpreters share the same physical
2015 my_cxt_t structure. Calling C<MY_CXT_CLONE> (typically via the package's
2016 C<CLONE()> function), causes a byte-for-byte copy of the structure to be
2017 taken, and any future dMY_CXT will cause the copy to be accessed instead.
2018
2019 =item MY_CXT_INIT_INTERP(my_perl)
2020
2021 =item dMY_CXT_INTERP(my_perl)
2022
2023 These are versions of the macros which take an explicit interpreter as an
2024 argument.
2025
2026 =back
2027
2028 Note that these macros will only work together within the I<same> source
2029 file; that is, a dMY_CTX in one source file will access a different structure
2030 than a dMY_CTX in another source file.
2031
2032 =head2 Thread-aware system interfaces
2033
2034 Starting from Perl 5.8, in C/C++ level Perl knows how to wrap
2035 system/library interfaces that have thread-aware versions
2036 (e.g. getpwent_r()) into frontend macros (e.g. getpwent()) that
2037 correctly handle the multithreaded interaction with the Perl
2038 interpreter.  This will happen transparently, the only thing
2039 you need to do is to instantiate a Perl interpreter.
2040
2041 This wrapping happens always when compiling Perl core source
2042 (PERL_CORE is defined) or the Perl core extensions (PERL_EXT is
2043 defined).  When compiling XS code outside of Perl core the wrapping
2044 does not take place.  Note, however, that intermixing the _r-forms
2045 (as Perl compiled for multithreaded operation will do) and the _r-less
2046 forms is neither well-defined (inconsistent results, data corruption,
2047 or even crashes become more likely), nor is it very portable.
2048
2049 =head1 EXAMPLES
2050
2051 File C<RPC.xs>: Interface to some ONC+ RPC bind library functions.
2052
2053      #include "EXTERN.h"
2054      #include "perl.h"
2055      #include "XSUB.h"
2056
2057      #include <rpc/rpc.h>
2058
2059      typedef struct netconfig Netconfig;
2060
2061      MODULE = RPC  PACKAGE = RPC
2062
2063      SV *
2064      rpcb_gettime(host="localhost")
2065           char *host
2066         PREINIT:
2067           time_t  timep;
2068         CODE:
2069           ST(0) = sv_newmortal();
2070           if( rpcb_gettime( host, &timep ) )
2071                sv_setnv( ST(0), (double)timep );
2072
2073      Netconfig *
2074      getnetconfigent(netid="udp")
2075           char *netid
2076
2077      MODULE = RPC  PACKAGE = NetconfigPtr  PREFIX = rpcb_
2078
2079      void
2080      rpcb_DESTROY(netconf)
2081           Netconfig *netconf
2082         CODE:
2083           printf("NetconfigPtr::DESTROY\n");
2084           free( netconf );
2085
2086 File C<typemap>: Custom typemap for RPC.xs. (cf. L<perlxstypemap>)
2087
2088      TYPEMAP
2089      Netconfig *  T_PTROBJ
2090
2091 File C<RPC.pm>: Perl module for the RPC extension.
2092
2093      package RPC;
2094
2095      require Exporter;
2096      require DynaLoader;
2097      @ISA = qw(Exporter DynaLoader);
2098      @EXPORT = qw(rpcb_gettime getnetconfigent);
2099
2100      bootstrap RPC;
2101      1;
2102
2103 File C<rpctest.pl>: Perl test program for the RPC extension.
2104
2105      use RPC;
2106
2107      $netconf = getnetconfigent();
2108      $a = rpcb_gettime();
2109      print "time = $a\n";
2110      print "netconf = $netconf\n";
2111
2112      $netconf = getnetconfigent("tcp");
2113      $a = rpcb_gettime("poplar");
2114      print "time = $a\n";
2115      print "netconf = $netconf\n";
2116
2117
2118 =head1 XS VERSION
2119
2120 This document covers features supported by C<ExtUtils::ParseXS>
2121 (also known as C<xsubpp>) 3.13_01.
2122
2123 =head1 AUTHOR
2124
2125 Originally written by Dean Roehrich <F<roehrich@cray.com>>.
2126
2127 Maintained since 1996 by The Perl Porters <F<perlbug@perl.org>>.