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