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