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