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