This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
39364eb4298f2555bbf2331062030ca3cddee140
[perl5.git] / pod / perlembed.pod
1 =head1 NAME
2
3 perlembed - how to embed perl in your C program
4
5 =head1 DESCRIPTION
6
7 =head2 PREAMBLE
8
9 Do you want to:
10
11 =over 5
12
13 =item B<Use C from Perl?>
14
15 Read L<perlxstut>, L<perlxs>, L<h2xs>, L<perlguts>, and L<perlapi>.
16
17 =item B<Use a Unix program from Perl?>
18
19 Read about back-quotes and about C<system> and C<exec> in L<perlfunc>.
20
21 =item B<Use Perl from Perl?>
22
23 Read about L<perlfunc/do> and L<perlfunc/eval> and L<perlfunc/require> 
24 and L<perlfunc/use>.
25
26 =item B<Use C from C?>
27
28 Rethink your design.
29
30 =item B<Use Perl from C?>
31
32 Read on...
33
34 =back
35
36 =head2 ROADMAP
37
38 =over 5
39
40 =item *
41
42 Compiling your C program
43
44 =item *
45
46 Adding a Perl interpreter to your C program
47
48 =item *
49
50 Calling a Perl subroutine from your C program
51
52 =item *
53
54 Evaluating a Perl statement from your C program
55
56 =item *
57
58 Performing Perl pattern matches and substitutions from your C program
59
60 =item *
61
62 Fiddling with the Perl stack from your C program
63
64 =item *
65
66 Maintaining a persistent interpreter
67
68 =item *
69
70 Maintaining multiple interpreter instances
71
72 =item *
73
74 Using Perl modules, which themselves use C libraries, from your C program
75
76 =item *
77
78 Embedding Perl under Win32
79
80 =back 
81
82 =head2 Compiling your C program
83
84 If you have trouble compiling the scripts in this documentation,
85 you're not alone.  The cardinal rule: COMPILE THE PROGRAMS IN EXACTLY
86 THE SAME WAY THAT YOUR PERL WAS COMPILED.  (Sorry for yelling.)
87
88 Also, every C program that uses Perl must link in the I<perl library>.
89 What's that, you ask?  Perl is itself written in C; the perl library
90 is the collection of compiled C programs that were used to create your
91 perl executable (I</usr/bin/perl> or equivalent).  (Corollary: you
92 can't use Perl from your C program unless Perl has been compiled on
93 your machine, or installed properly--that's why you shouldn't blithely
94 copy Perl executables from machine to machine without also copying the
95 I<lib> directory.)
96
97 When you use Perl from C, your C program will--usually--allocate,
98 "run", and deallocate a I<PerlInterpreter> object, which is defined by
99 the perl library.
100
101 If your copy of Perl is recent enough to contain this documentation
102 (version 5.002 or later), then the perl library (and I<EXTERN.h> and
103 I<perl.h>, which you'll also need) will reside in a directory
104 that looks like this:
105
106     /usr/local/lib/perl5/your_architecture_here/CORE
107
108 or perhaps just
109
110     /usr/local/lib/perl5/CORE
111
112 or maybe something like
113
114     /usr/opt/perl5/CORE
115
116 Execute this statement for a hint about where to find CORE:
117
118     perl -MConfig -e 'print $Config{archlib}'
119
120 Here's how you'd compile the example in the next section,
121 L<Adding a Perl interpreter to your C program>, on my Linux box:
122
123     % gcc -O2 -Dbool=char -DHAS_BOOL -I/usr/local/include
124     -I/usr/local/lib/perl5/i586-linux/5.003/CORE
125     -L/usr/local/lib/perl5/i586-linux/5.003/CORE
126     -o interp interp.c -lperl -lm
127
128 (That's all one line.)  On my DEC Alpha running old 5.003_05, the 
129 incantation is a bit different:
130
131     % cc -O2 -Olimit 2900 -DSTANDARD_C -I/usr/local/include
132     -I/usr/local/lib/perl5/alpha-dec_osf/5.00305/CORE
133     -L/usr/local/lib/perl5/alpha-dec_osf/5.00305/CORE -L/usr/local/lib
134     -D__LANGUAGE_C__ -D_NO_PROTO -o interp interp.c -lperl -lm
135
136 How can you figure out what to add?  Assuming your Perl is post-5.001,
137 execute a C<perl -V> command and pay special attention to the "cc" and
138 "ccflags" information.
139
140 You'll have to choose the appropriate compiler (I<cc>, I<gcc>, et al.) for
141 your machine: C<perl -MConfig -e 'print $Config{cc}'> will tell you what
142 to use.
143
144 You'll also have to choose the appropriate library directory
145 (I</usr/local/lib/...>) for your machine.  If your compiler complains
146 that certain functions are undefined, or that it can't locate
147 I<-lperl>, then you need to change the path following the C<-L>.  If it
148 complains that it can't find I<EXTERN.h> and I<perl.h>, you need to
149 change the path following the C<-I>.
150
151 You may have to add extra libraries as well.  Which ones?
152 Perhaps those printed by
153
154    perl -MConfig -e 'print $Config{libs}'
155
156 Provided your perl binary was properly configured and installed the
157 B<ExtUtils::Embed> module will determine all of this information for
158 you:
159
160    % cc -o interp interp.c `perl -MExtUtils::Embed -e ccopts -e ldopts`
161
162 If the B<ExtUtils::Embed> module isn't part of your Perl distribution,
163 you can retrieve it from
164 http://www.perl.com/perl/CPAN/modules/by-module/ExtUtils/
165 (If this documentation came from your Perl distribution, then you're
166 running 5.004 or better and you already have it.)
167
168 The B<ExtUtils::Embed> kit on CPAN also contains all source code for
169 the examples in this document, tests, additional examples and other
170 information you may find useful.
171
172 =head2 Adding a Perl interpreter to your C program
173
174 In a sense, perl (the C program) is a good example of embedding Perl
175 (the language), so I'll demonstrate embedding with I<miniperlmain.c>,
176 included in the source distribution.  Here's a bastardized, non-portable
177 version of I<miniperlmain.c> containing the essentials of embedding:
178
179     #include <EXTERN.h>               /* from the Perl distribution     */
180     #include <perl.h>                 /* from the Perl distribution     */
181
182     static PerlInterpreter *my_perl;  /***    The Perl interpreter    ***/
183
184     int main(int argc, char **argv, char **env)
185     {
186         PERL_SYS_INIT3(&argc,&argv,&env);
187         my_perl = perl_alloc();
188         perl_construct(my_perl);
189         PL_exit_flags |= PERL_EXIT_DESTRUCT_END;
190         perl_parse(my_perl, NULL, argc, argv, (char **)NULL);
191         perl_run(my_perl);
192         perl_destruct(my_perl);
193         perl_free(my_perl);
194         PERL_SYS_TERM();
195     }
196
197 Notice that we don't use the C<env> pointer.  Normally handed to
198 C<perl_parse> as its final argument, C<env> here is replaced by
199 C<NULL>, which means that the current environment will be used.  The macros
200 PERL_SYS_INIT3() and PERL_SYS_TERM() provide system-specific tune up 
201 of the C runtime environment necessary to run Perl interpreters; since
202 PERL_SYS_INIT3() may change C<env>, it may be more appropriate to provide
203 C<env> as an argument to perl_parse().
204
205 Now compile this program (I'll call it I<interp.c>) into an executable:
206
207     % cc -o interp interp.c `perl -MExtUtils::Embed -e ccopts -e ldopts`
208
209 After a successful compilation, you'll be able to use I<interp> just
210 like perl itself:
211
212     % interp
213     print "Pretty Good Perl \n";
214     print "10890 - 9801 is ", 10890 - 9801;
215     <CTRL-D>
216     Pretty Good Perl
217     10890 - 9801 is 1089
218
219 or
220
221     % interp -e 'printf("%x", 3735928559)'
222     deadbeef
223
224 You can also read and execute Perl statements from a file while in the
225 midst of your C program, by placing the filename in I<argv[1]> before
226 calling I<perl_run>.
227
228 =head2 Calling a Perl subroutine from your C program
229
230 To call individual Perl subroutines, you can use any of the B<call_*>
231 functions documented in L<perlcall>.
232 In this example we'll use C<call_argv>.
233
234 That's shown below, in a program I'll call I<showtime.c>.
235
236     #include <EXTERN.h>
237     #include <perl.h>
238
239     static PerlInterpreter *my_perl;
240
241     int main(int argc, char **argv, char **env)
242     {
243         char *args[] = { NULL };
244         PERL_SYS_INIT3(&argc,&argv,&env);
245         my_perl = perl_alloc();
246         perl_construct(my_perl);
247
248         perl_parse(my_perl, NULL, argc, argv, NULL);
249         PL_exit_flags |= PERL_EXIT_DESTRUCT_END;
250
251         /*** skipping perl_run() ***/
252
253         call_argv("showtime", G_DISCARD | G_NOARGS, args);
254
255         perl_destruct(my_perl);
256         perl_free(my_perl);
257         PERL_SYS_TERM();
258     }
259
260 where I<showtime> is a Perl subroutine that takes no arguments (that's the
261 I<G_NOARGS>) and for which I'll ignore the return value (that's the
262 I<G_DISCARD>).  Those flags, and others, are discussed in L<perlcall>.
263
264 I'll define the I<showtime> subroutine in a file called I<showtime.pl>:
265
266     print "I shan't be printed.";
267
268     sub showtime {
269         print time;
270     }
271
272 Simple enough.  Now compile and run:
273
274     % cc -o showtime showtime.c `perl -MExtUtils::Embed -e ccopts -e ldopts`
275
276     % showtime showtime.pl
277     818284590
278
279 yielding the number of seconds that elapsed between January 1, 1970
280 (the beginning of the Unix epoch), and the moment I began writing this
281 sentence.
282
283 In this particular case we don't have to call I<perl_run>, as we set 
284 the PL_exit_flag PERL_EXIT_DESTRUCT_END which executes END blocks in
285 perl_destruct.
286
287 If you want to pass arguments to the Perl subroutine, you can add
288 strings to the C<NULL>-terminated C<args> list passed to
289 I<call_argv>.  For other data types, or to examine return values,
290 you'll need to manipulate the Perl stack.  That's demonstrated in
291 L<Fiddling with the Perl stack from your C program>.
292
293 =head2 Evaluating a Perl statement from your C program
294
295 Perl provides two API functions to evaluate pieces of Perl code.
296 These are L<perlapi/eval_sv> and L<perlapi/eval_pv>.
297
298 Arguably, these are the only routines you'll ever need to execute
299 snippets of Perl code from within your C program.  Your code can be as
300 long as you wish; it can contain multiple statements; it can employ
301 L<perlfunc/use>, L<perlfunc/require>, and L<perlfunc/do> to
302 include external Perl files.
303
304 I<eval_pv> lets us evaluate individual Perl strings, and then
305 extract variables for coercion into C types.  The following program,
306 I<string.c>, executes three Perl strings, extracting an C<int> from
307 the first, a C<float> from the second, and a C<char *> from the third.
308
309    #include <EXTERN.h>
310    #include <perl.h>
311
312    static PerlInterpreter *my_perl;
313
314    main (int argc, char **argv, char **env)
315    {
316        char *embedding[] = { "", "-e", "0" };
317
318        PERL_SYS_INIT3(&argc,&argv,&env);
319        my_perl = perl_alloc();
320        perl_construct( my_perl );
321
322        perl_parse(my_perl, NULL, 3, embedding, NULL);
323        PL_exit_flags |= PERL_EXIT_DESTRUCT_END;
324        perl_run(my_perl);
325
326        /** Treat $a as an integer **/
327        eval_pv("$a = 3; $a **= 2", TRUE);
328        printf("a = %d\n", SvIV(get_sv("a", 0)));
329
330        /** Treat $a as a float **/
331        eval_pv("$a = 3.14; $a **= 2", TRUE);
332        printf("a = %f\n", SvNV(get_sv("a", 0)));
333
334        /** Treat $a as a string **/
335        eval_pv("$a = 'rekcaH lreP rehtonA tsuJ'; $a = reverse($a);", TRUE);
336        printf("a = %s\n", SvPV_nolen(get_sv("a", 0)));
337
338        perl_destruct(my_perl);
339        perl_free(my_perl);
340        PERL_SYS_TERM();
341    }
342
343 All of those strange functions with I<sv> in their names help convert Perl scalars to C types.  They're described in L<perlguts> and L<perlapi>.
344
345 If you compile and run I<string.c>, you'll see the results of using
346 I<SvIV()> to create an C<int>, I<SvNV()> to create a C<float>, and
347 I<SvPV()> to create a string:
348
349    a = 9
350    a = 9.859600
351    a = Just Another Perl Hacker
352
353 In the example above, we've created a global variable to temporarily
354 store the computed value of our eval'ed expression.  It is also
355 possible and in most cases a better strategy to fetch the return value
356 from I<eval_pv()> instead.  Example:
357
358    ...
359    SV *val = eval_pv("reverse 'rekcaH lreP rehtonA tsuJ'", TRUE);
360    printf("%s\n", SvPV_nolen(val));
361    ...
362
363 This way, we avoid namespace pollution by not creating global
364 variables and we've simplified our code as well.
365
366 =head2 Performing Perl pattern matches and substitutions from your C program
367
368 The I<eval_sv()> function lets us evaluate strings of Perl code, so we can
369 define some functions that use it to "specialize" in matches and
370 substitutions: I<match()>, I<substitute()>, and I<matches()>.
371
372    I32 match(SV *string, char *pattern);
373
374 Given a string and a pattern (e.g., C<m/clasp/> or C</\b\w*\b/>, which
375 in your C program might appear as "/\\b\\w*\\b/"), match()
376 returns 1 if the string matches the pattern and 0 otherwise.
377
378    int substitute(SV **string, char *pattern);
379
380 Given a pointer to an C<SV> and an C<=~> operation (e.g.,
381 C<s/bob/robert/g> or C<tr[A-Z][a-z]>), substitute() modifies the string
382 within the C<SV> as according to the operation, returning the number of substitutions
383 made.
384
385    int matches(SV *string, char *pattern, AV **matches);
386
387 Given an C<SV>, a pattern, and a pointer to an empty C<AV>,
388 matches() evaluates C<$string =~ $pattern> in a list context, and
389 fills in I<matches> with the array elements, returning the number of matches found.
390
391 Here's a sample program, I<match.c>, that uses all three (long lines have
392 been wrapped here):
393
394  #include <EXTERN.h>
395  #include <perl.h>
396
397  static PerlInterpreter *my_perl;
398
399  /** my_eval_sv(code, error_check)
400  ** kinda like eval_sv(), 
401  ** but we pop the return value off the stack 
402  **/
403  SV* my_eval_sv(SV *sv, I32 croak_on_error)
404  {
405      dSP;
406      SV* retval;
407
408
409      PUSHMARK(SP);
410      eval_sv(sv, G_SCALAR);
411
412      SPAGAIN;
413      retval = POPs;
414      PUTBACK;
415
416      if (croak_on_error && SvTRUE(ERRSV))
417         croak(SvPVx_nolen(ERRSV));
418
419      return retval;
420  }
421
422  /** match(string, pattern)
423  **
424  ** Used for matches in a scalar context.
425  **
426  ** Returns 1 if the match was successful; 0 otherwise.
427  **/
428
429  I32 match(SV *string, char *pattern)
430  {
431      SV *command = newSV(0), *retval;
432
433      sv_setpvf(command, "my $string = '%s'; $string =~ %s",
434               SvPV_nolen(string), pattern);
435
436      retval = my_eval_sv(command, TRUE);
437      SvREFCNT_dec(command);
438
439      return SvIV(retval);
440  }
441
442  /** substitute(string, pattern)
443  **
444  ** Used for =~ operations that modify their left-hand side (s/// and tr///)
445  **
446  ** Returns the number of successful matches, and
447  ** modifies the input string if there were any.
448  **/
449
450  I32 substitute(SV **string, char *pattern)
451  {
452      SV *command = newSV(0), *retval;
453
454      sv_setpvf(command, "$string = '%s'; ($string =~ %s)",
455               SvPV_nolen(*string), pattern);
456
457      retval = my_eval_sv(command, TRUE);
458      SvREFCNT_dec(command);
459
460      *string = get_sv("string", 0);
461      return SvIV(retval);
462  }
463
464  /** matches(string, pattern, matches)
465  **
466  ** Used for matches in a list context.
467  **
468  ** Returns the number of matches,
469  ** and fills in **matches with the matching substrings
470  **/
471
472  I32 matches(SV *string, char *pattern, AV **match_list)
473  {
474      SV *command = newSV(0);
475      I32 num_matches;
476
477      sv_setpvf(command, "my $string = '%s'; @array = ($string =~ %s)",
478               SvPV_nolen(string), pattern);
479
480      my_eval_sv(command, TRUE);
481      SvREFCNT_dec(command);
482
483      *match_list = get_av("array", 0);
484      num_matches = av_len(*match_list) + 1; /** assume $[ is 0 **/
485
486      return num_matches;
487  }
488
489  main (int argc, char **argv, char **env)
490  {
491      char *embedding[] = { "", "-e", "0" };
492      AV *match_list;
493      I32 num_matches, i;
494      SV *text;
495
496      PERL_SYS_INIT3(&argc,&argv,&env);
497      my_perl = perl_alloc();
498      perl_construct(my_perl);
499      perl_parse(my_perl, NULL, 3, embedding, NULL);
500      PL_exit_flags |= PERL_EXIT_DESTRUCT_END;
501
502      text = newSV(0);
503      sv_setpv(text, "When he is at a convenience store and the "
504         "bill comes to some amount like 76 cents, Maynard is "
505         "aware that there is something he *should* do, something "
506         "that will enable him to get back a quarter, but he has "
507         "no idea *what*.  He fumbles through his red squeezey "
508         "changepurse and gives the boy three extra pennies with "
509         "his dollar, hoping that he might luck into the correct "
510         "amount.  The boy gives him back two of his own pennies "
511         "and then the big shiny quarter that is his prize. "
512         "-RICHH");
513
514      if (match(text, "m/quarter/")) /** Does text contain 'quarter'? **/
515         printf("match: Text contains the word 'quarter'.\n\n");
516      else
517         printf("match: Text doesn't contain the word 'quarter'.\n\n");
518
519      if (match(text, "m/eighth/")) /** Does text contain 'eighth'? **/
520         printf("match: Text contains the word 'eighth'.\n\n");
521      else
522         printf("match: Text doesn't contain the word 'eighth'.\n\n");
523
524      /** Match all occurrences of /wi../ **/
525      num_matches = matches(text, "m/(wi..)/g", &match_list);
526      printf("matches: m/(wi..)/g found %d matches...\n", num_matches);
527
528      for (i = 0; i < num_matches; i++)
529         printf("match: %s\n", SvPV_nolen(*av_fetch(match_list, i, FALSE)));
530      printf("\n");
531
532      /** Remove all vowels from text **/
533      num_matches = substitute(&text, "s/[aeiou]//gi");
534      if (num_matches) {
535         printf("substitute: s/[aeiou]//gi...%d substitutions made.\n",
536                num_matches);
537         printf("Now text is: %s\n\n", SvPV_nolen(text));
538      }
539
540      /** Attempt a substitution **/
541      if (!substitute(&text, "s/Perl/C/")) {
542         printf("substitute: s/Perl/C...No substitution made.\n\n");
543      }
544
545      SvREFCNT_dec(text);
546      PL_perl_destruct_level = 1;
547      perl_destruct(my_perl);
548      perl_free(my_perl);
549      PERL_SYS_TERM();
550  }
551
552 which produces the output (again, long lines have been wrapped here)
553
554    match: Text contains the word 'quarter'.
555
556    match: Text doesn't contain the word 'eighth'.
557
558    matches: m/(wi..)/g found 2 matches...
559    match: will
560    match: with
561
562    substitute: s/[aeiou]//gi...139 substitutions made.
563    Now text is: Whn h s t  cnvnnc str nd th bll cms t sm mnt lk 76 cnts,
564    Mynrd s wr tht thr s smthng h *shld* d, smthng tht wll nbl hm t gt bck
565    qrtr, bt h hs n d *wht*.  H fmbls thrgh hs rd sqzy chngprs nd gvs th by
566    thr xtr pnns wth hs dllr, hpng tht h mght lck nt th crrct mnt.  Th by gvs
567    hm bck tw f hs wn pnns nd thn th bg shny qrtr tht s hs prz. -RCHH
568
569    substitute: s/Perl/C...No substitution made.
570
571 =head2 Fiddling with the Perl stack from your C program
572
573 When trying to explain stacks, most computer science textbooks mumble
574 something about spring-loaded columns of cafeteria plates: the last
575 thing you pushed on the stack is the first thing you pop off.  That'll
576 do for our purposes: your C program will push some arguments onto "the Perl
577 stack", shut its eyes while some magic happens, and then pop the
578 results--the return value of your Perl subroutine--off the stack.
579
580 First you'll need to know how to convert between C types and Perl
581 types, with newSViv() and sv_setnv() and newAV() and all their
582 friends.  They're described in L<perlguts> and L<perlapi>.
583
584 Then you'll need to know how to manipulate the Perl stack.  That's
585 described in L<perlcall>.
586
587 Once you've understood those, embedding Perl in C is easy.
588
589 Because C has no builtin function for integer exponentiation, let's
590 make Perl's ** operator available to it (this is less useful than it
591 sounds, because Perl implements ** with C's I<pow()> function).  First
592 I'll create a stub exponentiation function in I<power.pl>:
593
594     sub expo {
595         my ($a, $b) = @_;
596         return $a ** $b;
597     }
598
599 Now I'll create a C program, I<power.c>, with a function
600 I<PerlPower()> that contains all the perlguts necessary to push the
601 two arguments into I<expo()> and to pop the return value out.  Take a
602 deep breath...
603
604     #include <EXTERN.h>
605     #include <perl.h>
606
607     static PerlInterpreter *my_perl;
608
609     static void
610     PerlPower(int a, int b)
611     {
612       dSP;                            /* initialize stack pointer      */
613       ENTER;                          /* everything created after here */
614       SAVETMPS;                       /* ...is a temporary variable.   */
615       PUSHMARK(SP);                   /* remember the stack pointer    */
616       XPUSHs(sv_2mortal(newSViv(a))); /* push the base onto the stack  */
617       XPUSHs(sv_2mortal(newSViv(b))); /* push the exponent onto stack  */
618       PUTBACK;                      /* make local stack pointer global */
619       call_pv("expo", G_SCALAR);      /* call the function             */
620       SPAGAIN;                        /* refresh stack pointer         */
621                                     /* pop the return value from stack */
622       printf ("%d to the %dth power is %d.\n", a, b, POPi);
623       PUTBACK;
624       FREETMPS;                       /* free that return value        */
625       LEAVE;                       /* ...and the XPUSHed "mortal" args.*/
626     }
627
628     int main (int argc, char **argv, char **env)
629     {
630       char *my_argv[] = { "", "power.pl" };
631
632       PERL_SYS_INIT3(&argc,&argv,&env);
633       my_perl = perl_alloc();
634       perl_construct( my_perl );
635
636       perl_parse(my_perl, NULL, 2, my_argv, (char **)NULL);
637       PL_exit_flags |= PERL_EXIT_DESTRUCT_END;
638       perl_run(my_perl);
639
640       PerlPower(3, 4);                      /*** Compute 3 ** 4 ***/
641
642       perl_destruct(my_perl);
643       perl_free(my_perl);
644       PERL_SYS_TERM();
645     }
646
647
648
649 Compile and run:
650
651     % cc -o power power.c `perl -MExtUtils::Embed -e ccopts -e ldopts`
652
653     % power
654     3 to the 4th power is 81.
655
656 =head2 Maintaining a persistent interpreter
657
658 When developing interactive and/or potentially long-running
659 applications, it's a good idea to maintain a persistent interpreter
660 rather than allocating and constructing a new interpreter multiple
661 times.  The major reason is speed: since Perl will only be loaded into
662 memory once.
663
664 However, you have to be more cautious with namespace and variable
665 scoping when using a persistent interpreter.  In previous examples
666 we've been using global variables in the default package C<main>.  We
667 knew exactly what code would be run, and assumed we could avoid
668 variable collisions and outrageous symbol table growth.
669
670 Let's say your application is a server that will occasionally run Perl
671 code from some arbitrary file.  Your server has no way of knowing what
672 code it's going to run.  Very dangerous.
673
674 If the file is pulled in by C<perl_parse()>, compiled into a newly
675 constructed interpreter, and subsequently cleaned out with
676 C<perl_destruct()> afterwards, you're shielded from most namespace
677 troubles.
678
679 One way to avoid namespace collisions in this scenario is to translate
680 the filename into a guaranteed-unique package name, and then compile
681 the code into that package using L<perlfunc/eval>.  In the example
682 below, each file will only be compiled once.  Or, the application
683 might choose to clean out the symbol table associated with the file
684 after it's no longer needed.  Using L<perlapi/call_argv>, We'll
685 call the subroutine C<Embed::Persistent::eval_file> which lives in the
686 file C<persistent.pl> and pass the filename and boolean cleanup/cache
687 flag as arguments.
688
689 Note that the process will continue to grow for each file that it
690 uses.  In addition, there might be C<AUTOLOAD>ed subroutines and other
691 conditions that cause Perl's symbol table to grow.  You might want to
692 add some logic that keeps track of the process size, or restarts
693 itself after a certain number of requests, to ensure that memory
694 consumption is minimized.  You'll also want to scope your variables
695 with L<perlfunc/my> whenever possible.
696
697
698  package Embed::Persistent;
699  #persistent.pl
700
701  use strict;
702  our %Cache;
703  use Symbol qw(delete_package);
704
705  sub valid_package_name {
706      my($string) = @_;
707      $string =~ s/([^A-Za-z0-9\/])/sprintf("_%2x",unpack("C",$1))/eg;
708      # second pass only for words starting with a digit
709      $string =~ s|/(\d)|sprintf("/_%2x",unpack("C",$1))|eg;
710
711      # Dress it up as a real package name
712      $string =~ s|/|::|g;
713      return "Embed" . $string;
714  }
715
716  sub eval_file {
717      my($filename, $delete) = @_;
718      my $package = valid_package_name($filename);
719      my $mtime = -M $filename;
720      if(defined $Cache{$package}{mtime}
721         &&
722         $Cache{$package}{mtime} <= $mtime)
723      {
724         # we have compiled this subroutine already,
725         # it has not been updated on disk, nothing left to do
726         print STDERR "already compiled $package->handler\n";
727      }
728      else {
729         local *FH;
730         open FH, $filename or die "open '$filename' $!";
731         local($/) = undef;
732         my $sub = <FH>;
733         close FH;
734
735         #wrap the code into a subroutine inside our unique package
736         my $eval = qq{package $package; sub handler { $sub; }};
737         {
738             # hide our variables within this block
739             my($filename,$mtime,$package,$sub);
740             eval $eval;
741         }
742         die $@ if $@;
743
744         #cache it unless we're cleaning out each time
745         $Cache{$package}{mtime} = $mtime unless $delete;
746      }
747
748      eval {$package->handler;};
749      die $@ if $@;
750
751      delete_package($package) if $delete;
752
753      #take a look if you want
754      #print Devel::Symdump->rnew($package)->as_string, $/;
755  }
756
757  1;
758
759  __END__
760
761  /* persistent.c */
762  #include <EXTERN.h>
763  #include <perl.h>
764
765  /* 1 = clean out filename's symbol table after each request, 0 = don't */
766  #ifndef DO_CLEAN
767  #define DO_CLEAN 0
768  #endif
769
770  #define BUFFER_SIZE 1024
771
772  static PerlInterpreter *my_perl = NULL;
773
774  int
775  main(int argc, char **argv, char **env)
776  {
777      char *embedding[] = { "", "persistent.pl" };
778      char *args[] = { "", DO_CLEAN, NULL };
779      char filename[BUFFER_SIZE];
780      int exitstatus = 0;
781
782      PERL_SYS_INIT3(&argc,&argv,&env);
783      if((my_perl = perl_alloc()) == NULL) {
784         fprintf(stderr, "no memory!");
785         exit(1);
786      }
787      perl_construct(my_perl);
788
789      PL_origalen = 1; /* don't let $0 assignment update the proctitle or embedding[0] */
790      exitstatus = perl_parse(my_perl, NULL, 2, embedding, NULL);
791      PL_exit_flags |= PERL_EXIT_DESTRUCT_END;
792      if(!exitstatus) {
793         exitstatus = perl_run(my_perl);
794
795         while(printf("Enter file name: ") &&
796               fgets(filename, BUFFER_SIZE, stdin)) {
797
798             filename[strlen(filename)-1] = '\0'; /* strip \n */
799             /* call the subroutine, passing it the filename as an argument */
800             args[0] = filename;
801             call_argv("Embed::Persistent::eval_file",
802                            G_DISCARD | G_EVAL, args);
803
804             /* check $@ */
805             if(SvTRUE(ERRSV))
806                 fprintf(stderr, "eval error: %s\n", SvPV_nolen(ERRSV));
807         }
808      }
809
810      PL_perl_destruct_level = 0;
811      perl_destruct(my_perl);
812      perl_free(my_perl);
813      PERL_SYS_TERM();
814      exit(exitstatus);
815  }
816
817 Now compile:
818
819  % cc -o persistent persistent.c `perl -MExtUtils::Embed -e ccopts -e ldopts`
820
821 Here's an example script file:
822
823  #test.pl
824  my $string = "hello";
825  foo($string);
826
827  sub foo {
828      print "foo says: @_\n";
829  }
830
831 Now run:
832
833  % persistent
834  Enter file name: test.pl
835  foo says: hello
836  Enter file name: test.pl
837  already compiled Embed::test_2epl->handler
838  foo says: hello
839  Enter file name: ^C
840
841 =head2 Execution of END blocks
842
843 Traditionally END blocks have been executed at the end of the perl_run.
844 This causes problems for applications that never call perl_run. Since
845 perl 5.7.2 you can specify C<PL_exit_flags |= PERL_EXIT_DESTRUCT_END>
846 to get the new behaviour. This also enables the running of END blocks if
847 the perl_parse fails and C<perl_destruct> will return the exit value.
848
849 =head2 $0 assignments
850
851 When a perl script assigns a value to $0 then the perl runtime will
852 try to make this value show up as the program name reported by "ps" by
853 updating the memory pointed to by the argv passed to perl_parse() and
854 also calling API functions like setproctitle() where available.  This
855 behaviour might not be appropriate when embedding perl and can be
856 disabled by assigning the value C<1> to the variable C<PL_origalen>
857 before perl_parse() is called.
858
859 The F<persistent.c> example above is for instance likely to segfault
860 when $0 is assigned to if the C<PL_origalen = 1;> assignment is
861 removed.  This because perl will try to write to the read only memory
862 of the C<embedding[]> strings.
863
864 =head2 Maintaining multiple interpreter instances
865
866 Some rare applications will need to create more than one interpreter
867 during a session.  Such an application might sporadically decide to
868 release any resources associated with the interpreter.
869
870 The program must take care to ensure that this takes place I<before>
871 the next interpreter is constructed.  By default, when perl is not
872 built with any special options, the global variable
873 C<PL_perl_destruct_level> is set to C<0>, since extra cleaning isn't
874 usually needed when a program only ever creates a single interpreter
875 in its entire lifetime.
876
877 Setting C<PL_perl_destruct_level> to C<1> makes everything squeaky clean:
878
879  while(1) {
880      ...
881      /* reset global variables here with PL_perl_destruct_level = 1 */
882      PL_perl_destruct_level = 1;
883      perl_construct(my_perl);
884      ...
885      /* clean and reset _everything_ during perl_destruct */
886      PL_perl_destruct_level = 1;
887      perl_destruct(my_perl);
888      perl_free(my_perl);
889      ...
890      /* let's go do it again! */
891  }
892
893 When I<perl_destruct()> is called, the interpreter's syntax parse tree
894 and symbol tables are cleaned up, and global variables are reset.  The
895 second assignment to C<PL_perl_destruct_level> is needed because
896 perl_construct resets it to C<0>.
897
898 Now suppose we have more than one interpreter instance running at the
899 same time.  This is feasible, but only if you used the Configure option
900 C<-Dusemultiplicity> or the options C<-Dusethreads -Duseithreads> when
901 building perl.  By default, enabling one of these Configure options
902 sets the per-interpreter global variable C<PL_perl_destruct_level> to
903 C<1>, so that thorough cleaning is automatic and interpreter variables
904 are initialized correctly.  Even if you don't intend to run two or
905 more interpreters at the same time, but to run them sequentially, like
906 in the above example, it is recommended to build perl with the
907 C<-Dusemultiplicity> option otherwise some interpreter variables may
908 not be initialized correctly between consecutive runs and your
909 application may crash.
910
911 See also L<perlxs/Thread-aware system interfaces>.
912
913 Using C<-Dusethreads -Duseithreads> rather than C<-Dusemultiplicity>
914 is more appropriate if you intend to run multiple interpreters
915 concurrently in different threads, because it enables support for
916 linking in the thread libraries of your system with the interpreter.
917
918 Let's give it a try:
919
920
921  #include <EXTERN.h>
922  #include <perl.h>
923
924  /* we're going to embed two interpreters */
925  /* we're going to embed two interpreters */
926
927  #define SAY_HELLO "-e", "print qq(Hi, I'm $^X\n)"
928
929  int main(int argc, char **argv, char **env)
930  {
931      PerlInterpreter *one_perl, *two_perl;
932      char *one_args[] = { "one_perl", SAY_HELLO };
933      char *two_args[] = { "two_perl", SAY_HELLO };
934
935      PERL_SYS_INIT3(&argc,&argv,&env);
936      one_perl = perl_alloc();
937      two_perl = perl_alloc();
938
939      PERL_SET_CONTEXT(one_perl);
940      perl_construct(one_perl);
941      PERL_SET_CONTEXT(two_perl);
942      perl_construct(two_perl);
943
944      PERL_SET_CONTEXT(one_perl);
945      perl_parse(one_perl, NULL, 3, one_args, (char **)NULL);
946      PERL_SET_CONTEXT(two_perl);
947      perl_parse(two_perl, NULL, 3, two_args, (char **)NULL);
948
949      PERL_SET_CONTEXT(one_perl);
950      perl_run(one_perl);
951      PERL_SET_CONTEXT(two_perl);
952      perl_run(two_perl);
953
954      PERL_SET_CONTEXT(one_perl);
955      perl_destruct(one_perl);
956      PERL_SET_CONTEXT(two_perl);
957      perl_destruct(two_perl);
958
959      PERL_SET_CONTEXT(one_perl);
960      perl_free(one_perl);
961      PERL_SET_CONTEXT(two_perl);
962      perl_free(two_perl);
963      PERL_SYS_TERM();
964  }
965
966 Note the calls to PERL_SET_CONTEXT().  These are necessary to initialize
967 the global state that tracks which interpreter is the "current" one on
968 the particular process or thread that may be running it.  It should
969 always be used if you have more than one interpreter and are making
970 perl API calls on both interpreters in an interleaved fashion.
971
972 PERL_SET_CONTEXT(interp) should also be called whenever C<interp> is
973 used by a thread that did not create it (using either perl_alloc(), or
974 the more esoteric perl_clone()).
975
976 Compile as usual:
977
978  % cc -o multiplicity multiplicity.c `perl -MExtUtils::Embed -e ccopts -e ldopts`
979
980 Run it, Run it:
981
982  % multiplicity
983  Hi, I'm one_perl
984  Hi, I'm two_perl
985
986 =head2 Using Perl modules, which themselves use C libraries, from your C program
987
988 If you've played with the examples above and tried to embed a script
989 that I<use()>s a Perl module (such as I<Socket>) which itself uses a C or C++ library,
990 this probably happened:
991
992
993  Can't load module Socket, dynamic loading not available in this perl.
994   (You may need to build a new perl executable which either supports
995   dynamic loading or has the Socket module statically linked into it.)
996
997
998 What's wrong?
999
1000 Your interpreter doesn't know how to communicate with these extensions
1001 on its own.  A little glue will help.  Up until now you've been
1002 calling I<perl_parse()>, handing it NULL for the second argument:
1003
1004  perl_parse(my_perl, NULL, argc, my_argv, NULL);
1005
1006 That's where the glue code can be inserted to create the initial contact between
1007 Perl and linked C/C++ routines.  Let's take a look some pieces of I<perlmain.c>
1008 to see how Perl does this:
1009
1010  static void xs_init (pTHX);
1011
1012  EXTERN_C void boot_DynaLoader (pTHX_ CV* cv);
1013  EXTERN_C void boot_Socket (pTHX_ CV* cv);
1014
1015
1016  EXTERN_C void
1017  xs_init(pTHX)
1018  {
1019         char *file = __FILE__;
1020         /* DynaLoader is a special case */
1021         newXS("DynaLoader::boot_DynaLoader", boot_DynaLoader, file);
1022         newXS("Socket::bootstrap", boot_Socket, file);
1023  }
1024
1025 Simply put: for each extension linked with your Perl executable
1026 (determined during its initial configuration on your
1027 computer or when adding a new extension),
1028 a Perl subroutine is created to incorporate the extension's
1029 routines.  Normally, that subroutine is named
1030 I<Module::bootstrap()> and is invoked when you say I<use Module>.  In
1031 turn, this hooks into an XSUB, I<boot_Module>, which creates a Perl
1032 counterpart for each of the extension's XSUBs.  Don't worry about this
1033 part; leave that to the I<xsubpp> and extension authors.  If your
1034 extension is dynamically loaded, DynaLoader creates I<Module::bootstrap()>
1035 for you on the fly.  In fact, if you have a working DynaLoader then there
1036 is rarely any need to link in any other extensions statically.
1037
1038
1039 Once you have this code, slap it into the second argument of I<perl_parse()>:
1040
1041
1042  perl_parse(my_perl, xs_init, argc, my_argv, NULL);
1043
1044
1045 Then compile:
1046
1047  % cc -o interp interp.c `perl -MExtUtils::Embed -e ccopts -e ldopts`
1048
1049  % interp
1050    use Socket;
1051    use SomeDynamicallyLoadedModule;
1052
1053    print "Now I can use extensions!\n"'
1054
1055 B<ExtUtils::Embed> can also automate writing the I<xs_init> glue code.
1056
1057  % perl -MExtUtils::Embed -e xsinit -- -o perlxsi.c
1058  % cc -c perlxsi.c `perl -MExtUtils::Embed -e ccopts`
1059  % cc -c interp.c  `perl -MExtUtils::Embed -e ccopts`
1060  % cc -o interp perlxsi.o interp.o `perl -MExtUtils::Embed -e ldopts`
1061
1062 Consult L<perlxs>, L<perlguts>, and L<perlapi> for more details.
1063
1064 =head1 Embedding Perl under Win32
1065
1066 In general, all of the source code shown here should work unmodified under
1067 Windows.
1068
1069 However, there are some caveats about the command-line examples shown.
1070 For starters, backticks won't work under the Win32 native command shell.
1071 The ExtUtils::Embed kit on CPAN ships with a script called
1072 B<genmake>, which generates a simple makefile to build a program from
1073 a single C source file.  It can be used like this:
1074
1075  C:\ExtUtils-Embed\eg> perl genmake interp.c
1076  C:\ExtUtils-Embed\eg> nmake
1077  C:\ExtUtils-Embed\eg> interp -e "print qq{I'm embedded in Win32!\n}"
1078
1079 You may wish to use a more robust environment such as the Microsoft
1080 Developer Studio.  In this case, run this to generate perlxsi.c:
1081
1082  perl -MExtUtils::Embed -e xsinit
1083
1084 Create a new project and Insert -> Files into Project: perlxsi.c,
1085 perl.lib, and your own source files, e.g. interp.c.  Typically you'll
1086 find perl.lib in B<C:\perl\lib\CORE>, if not, you should see the
1087 B<CORE> directory relative to C<perl -V:archlib>.  The studio will
1088 also need this path so it knows where to find Perl include files.
1089 This path can be added via the Tools -> Options -> Directories menu.
1090 Finally, select Build -> Build interp.exe and you're ready to go.
1091
1092 =head1 Hiding Perl_
1093
1094 If you completely hide the short forms forms of the Perl public API,
1095 add -DPERL_NO_SHORT_NAMES to the compilation flags.  This means that
1096 for example instead of writing
1097
1098     warn("%d bottles of beer on the wall", bottlecount);
1099
1100 you will have to write the explicit full form
1101
1102     Perl_warn(aTHX_ "%d bottles of beer on the wall", bottlecount);
1103
1104 (See L<perlguts/Background and PERL_IMPLICIT_CONTEXT for the explanation
1105 of the C<aTHX_>.> )  Hiding the short forms is very useful for avoiding
1106 all sorts of nasty (C preprocessor or otherwise) conflicts with other
1107 software packages (Perl defines about 2400 APIs with these short names,
1108 take or leave few hundred, so there certainly is room for conflict.)
1109
1110 =head1 MORAL
1111
1112 You can sometimes I<write faster code> in C, but
1113 you can always I<write code faster> in Perl.  Because you can use
1114 each from the other, combine them as you wish.
1115
1116
1117 =head1 AUTHOR
1118
1119 Jon Orwant <F<orwant@media.mit.edu>> and Doug MacEachern
1120 <F<dougm@covalent.net>>, with small contributions from Tim Bunce, Tom
1121 Christiansen, Guy Decoux, Hallvard Furuseth, Dov Grobgeld, and Ilya
1122 Zakharevich.
1123
1124 Doug MacEachern has an article on embedding in Volume 1, Issue 4 of
1125 The Perl Journal ( http://www.tpj.com/ ).  Doug is also the developer of the
1126 most widely-used Perl embedding: the mod_perl system
1127 (perl.apache.org), which embeds Perl in the Apache web server.
1128 Oracle, Binary Evolution, ActiveState, and Ben Sugars's nsapi_perl
1129 have used this model for Oracle, Netscape and Internet Information
1130 Server Perl plugins.
1131
1132 =head1 COPYRIGHT
1133
1134 Copyright (C) 1995, 1996, 1997, 1998 Doug MacEachern and Jon Orwant.  All
1135 Rights Reserved.
1136
1137 Permission is granted to make and distribute verbatim copies of this
1138 documentation provided the copyright notice and this permission notice are
1139 preserved on all copies.
1140
1141 Permission is granted to copy and distribute modified versions of this
1142 documentation under the conditions for verbatim copying, provided also
1143 that they are marked clearly as modified versions, that the authors'
1144 names and title are unchanged (though subtitles and additional
1145 authors' names may be added), and that the entire resulting derived
1146 work is distributed under the terms of a permission notice identical
1147 to this one.
1148
1149 Permission is granted to copy and distribute translations of this
1150 documentation into another language, under the above conditions for
1151 modified versions.