pod/perlembed.pod

   1 =head1 NAME
   2
   3 perlembed - how to embed perl in your C program
   4
   5 =head1 DESCRIPTION
   6
   7 =head2 PREAMBLE
   8
   9 Do you want to:
  10
  11 =over 5
  12
  13 =item B<Use C from Perl?>
  14
  15 Read L<perlxstut>, L<perlxs>, L<h2xs>, L<perlguts>, and L<perlapi>.
  16
  17 =item B<Use a Unix program from Perl?>
  18
  19 Read about back-quotes and about C<system> and C<exec> in L<perlfunc>.
  20
  21 =item B<Use Perl from Perl?>
  22
  23 Read about L<perlfunc/do> and L<perlfunc/eval> and L<perlfunc/require>
  24 and L<perlfunc/use>.
  25
  26 =item B<Use C from C?>
  27
  28 Rethink your design.
  29
  30 =item B<Use Perl from C?>
  31
  32 Read on...
  33
  34 =back
  35
  36 =head2 ROADMAP
  37
  38 =over 5
  39
  40 =item *
  41
  42 Compiling your C program
  43
  44 =item *
  45
  46 Adding a Perl interpreter to your C program
  47
  48 =item *
  49
  50 Calling a Perl subroutine from your C program
  51
  52 =item *
  53
  54 Evaluating a Perl statement from your C program
  55
  56 =item *
  57
  58 Performing Perl pattern matches and substitutions from your C program
  59
  60 =item *
  61
  62 Fiddling with the Perl stack from your C program
  63
  64 =item *
  65
  66 Maintaining a persistent interpreter
  67
  68 =item *
  69
  70 Maintaining multiple interpreter instances
  71
  72 =item *
  73
  74 Using Perl modules, which themselves use C libraries, from your C program
  75
  76 =item *
  77
  78 Embedding Perl under Win32
  79
  80 =back
  81
  82 =head2 Compiling your C program
  83
  84 If you have trouble compiling the scripts in this documentation,
  85 you're not alone.  The cardinal rule: COMPILE THE PROGRAMS IN EXACTLY
  86 THE SAME WAY THAT YOUR PERL WAS COMPILED.  (Sorry for yelling.)
  87
  88 Also, every C program that uses Perl must link in the I<perl library>.
  89 What's that, you ask?  Perl is itself written in C; the perl library
  90 is the collection of compiled C programs that were used to create your
  91 perl executable (I</usr/bin/perl> or equivalent).  (Corollary: you
  92 can't use Perl from your C program unless Perl has been compiled on
  93 your machine, or installed properly--that's why you shouldn't blithely
  94 copy Perl executables from machine to machine without also copying the
  95 I<lib> directory.)
  96
  97 When you use Perl from C, your C program will--usually--allocate,
  98 "run", and deallocate a I<PerlInterpreter> object, which is defined by
  99 the perl library.
 100
 101 If your copy of Perl is recent enough to contain this documentation
 102 (version 5.002 or later), then the perl library (and I<EXTERN.h> and
 103 I<perl.h>, which you'll also need) will reside in a directory
 104 that looks like this:
 105
 106     /usr/local/lib/perl5/your_architecture_here/CORE
 107
 108 or perhaps just
 109
 110     /usr/local/lib/perl5/CORE
 111
 112 or maybe something like
 113
 114     /usr/opt/perl5/CORE
 115
 116 Execute this statement for a hint about where to find CORE:
 117
 118     perl -MConfig -e 'print $Config{archlib}'
 119
 120 Here's how you'd compile the example in the next section,
 121 L<Adding a Perl interpreter to your C program>, on my Linux box:
 122
 123     % gcc -O2 -Dbool=char -DHAS_BOOL -I/usr/local/include
 124     -I/usr/local/lib/perl5/i586-linux/5.003/CORE
 125     -L/usr/local/lib/perl5/i586-linux/5.003/CORE
 126     -o interp interp.c -lperl -lm
 127
 128 (That's all one line.)  On my DEC Alpha running old 5.003_05, the
 129 incantation is a bit different:
 130
 131     % cc -O2 -Olimit 2900 -DSTANDARD_C -I/usr/local/include
 132     -I/usr/local/lib/perl5/alpha-dec_osf/5.00305/CORE
 133     -L/usr/local/lib/perl5/alpha-dec_osf/5.00305/CORE -L/usr/local/lib
 134     -D__LANGUAGE_C__ -D_NO_PROTO -o interp interp.c -lperl -lm
 135
 136 How can you figure out what to add?  Assuming your Perl is post-5.001,
 137 execute a C<perl -V> command and pay special attention to the "cc" and
 138 "ccflags" information.
 139
 140 You'll have to choose the appropriate compiler (I<cc>, I<gcc>, et al.) for
 141 your machine: C<perl -MConfig -e 'print $Config{cc}'> will tell you what
 142 to use.
 143
 144 You'll also have to choose the appropriate library directory
 145 (I</usr/local/lib/...>) for your machine.  If your compiler complains
 146 that certain functions are undefined, or that it can't locate
 147 I<-lperl>, then you need to change the path following the C<-L>.  If it
 148 complains that it can't find I<EXTERN.h> and I<perl.h>, you need to
 149 change the path following the C<-I>.
 150
 151 You may have to add extra libraries as well.  Which ones?
 152 Perhaps those printed by
 153
 154    perl -MConfig -e 'print $Config{libs}'
 155
 156 Provided your perl binary was properly configured and installed the
 157 B<ExtUtils::Embed> module will determine all of this information for
 158 you:
 159
 160    % cc -o interp interp.c `perl -MExtUtils::Embed -e ccopts -e ldopts`
 161
 162 If the B<ExtUtils::Embed> module isn't part of your Perl distribution,
 163 you can retrieve it from
 164 http://www.perl.com/perl/CPAN/modules/by-module/ExtUtils/
 165 (If this documentation came from your Perl distribution, then you're
 166 running 5.004 or better and you already have it.)
 167
 168 The B<ExtUtils::Embed> kit on CPAN also contains all source code for
 169 the examples in this document, tests, additional examples and other
 170 information you may find useful.
 171
 172 =head2 Adding a Perl interpreter to your C program
 173
 174 In a sense, perl (the C program) is a good example of embedding Perl
 175 (the language), so I'll demonstrate embedding with I<miniperlmain.c>,
 176 included in the source distribution.  Here's a bastardized, 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  static PerlInterpreter *my_perl;
 390
 391  /** my_eval_sv(code, error_check)
 392  ** kinda like eval_sv(),
 393  ** but we pop the return value off the stack
 394  **/
 395  SV* my_eval_sv(SV *sv, I32 croak_on_error)
 396  {
 397      dSP;
 398      SV* retval;
 399      STRLEN n_a;
 400
 401      PUSHMARK(SP);
 402      eval_sv(sv, G_SCALAR);
 403
 404      SPAGAIN;
 405      retval = POPs;
 406      PUTBACK;
 407
 408      if (croak_on_error && SvTRUE(ERRSV))
 409         croak(SvPVx(ERRSV, n_a));
 410
 411      return retval;
 412  }
 413
 414  /** match(string, pattern)
 415  **
 416  ** Used for matches in a scalar context.
 417  **
 418  ** Returns 1 if the match was successful; 0 otherwise.
 419  **/
 420
 421  I32 match(SV *string, char *pattern)
 422  {
 423      SV *command = NEWSV(1099, 0), *retval;
 424      STRLEN n_a;
 425
 426      sv_setpvf(command, "my $string = '%s'; $string =~ %s",
 427               SvPV(string,n_a), pattern);
 428
 429      retval = my_eval_sv(command, TRUE);
 430      SvREFCNT_dec(command);
 431
 432      return SvIV(retval);
 433  }
 434
 435  /** substitute(string, pattern)
 436  **
 437  ** Used for =~ operations that modify their left-hand side (s/// and tr///)
 438  **
 439  ** Returns the number of successful matches, and
 440  ** modifies the input string if there were any.
 441  **/
 442
 443  I32 substitute(SV **string, char *pattern)
 444  {
 445      SV *command = NEWSV(1099, 0), *retval;
 446      STRLEN n_a;
 447
 448      sv_setpvf(command, "$string = '%s'; ($string =~ %s)",
 449               SvPV(*string,n_a), pattern);
 450
 451      retval = my_eval_sv(command, TRUE);
 452      SvREFCNT_dec(command);
 453
 454      *string = get_sv("string", FALSE);
 455      return SvIV(retval);
 456  }
 457
 458  /** matches(string, pattern, matches)
 459  **
 460  ** Used for matches in a list context.
 461  **
 462  ** Returns the number of matches,
 463  ** and fills in **matches with the matching substrings
 464  **/
 465
 466  I32 matches(SV *string, char *pattern, AV **match_list)
 467  {
 468      SV *command = NEWSV(1099, 0);
 469      I32 num_matches;
 470      STRLEN n_a;
 471
 472      sv_setpvf(command, "my $string = '%s'; @array = ($string =~ %s)",
 473               SvPV(string,n_a), pattern);
 474
 475      my_eval_sv(command, TRUE);
 476      SvREFCNT_dec(command);
 477
 478      *match_list = get_av("array", FALSE);
 479      num_matches = av_len(*match_list) + 1; /** assume $[ is 0 **/
 480
 481      return num_matches;
 482  }
 483
 484  main (int argc, char **argv, char **env)
 485  {
 486      char *embedding[] = { "", "-e", "0" };
 487      AV *match_list;
 488      I32 num_matches, i;
 489      SV *text;
 490      STRLEN n_a;
 491
 492      my_perl = perl_alloc();
 493      perl_construct(my_perl);
 494      perl_parse(my_perl, NULL, 3, embedding, NULL);
 495      PL_exit_flags |= PERL_EXIT_DESTRUCT_END;
 496
 497      text = NEWSV(1099,0);
 498      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");
 499
 500      if (match(text, "m/quarter/")) /** Does text contain 'quarter'? **/
 501         printf("match: Text contains the word 'quarter'.\n\n");
 502      else
 503         printf("match: Text doesn't contain the word 'quarter'.\n\n");
 504
 505      if (match(text, "m/eighth/")) /** Does text contain 'eighth'? **/
 506         printf("match: Text contains the word 'eighth'.\n\n");
 507      else
 508         printf("match: Text doesn't contain the word 'eighth'.\n\n");
 509
 510      /** Match all occurrences of /wi../ **/
 511      num_matches = matches(text, "m/(wi..)/g", &match_list);
 512      printf("matches: m/(wi..)/g found %d matches...\n", num_matches);
 513
 514      for (i = 0; i < num_matches; i++)
 515         printf("match: %s\n", SvPV(*av_fetch(match_list, i, FALSE),n_a));
 516      printf("\n");
 517
 518      /** Remove all vowels from text **/
 519      num_matches = substitute(&text, "s/[aeiou]//gi");
 520      if (num_matches) {
 521         printf("substitute: s/[aeiou]//gi...%d substitutions made.\n",
 522                num_matches);
 523         printf("Now text is: %s\n\n", SvPV(text,n_a));
 524      }
 525
 526      /** Attempt a substitution **/
 527      if (!substitute(&text, "s/Perl/C/")) {
 528         printf("substitute: s/Perl/C...No substitution made.\n\n");
 529      }
 530
 531      SvREFCNT_dec(text);
 532      PL_perl_destruct_level = 1;
 533      perl_destruct(my_perl);
 534      perl_free(my_perl);
 535  }
 536
 537 which produces the output (again, long lines have been wrapped here)
 538
 539    match: Text contains the word 'quarter'.
 540
 541    match: Text doesn't contain the word 'eighth'.
 542
 543    matches: m/(wi..)/g found 2 matches...
 544    match: will
 545    match: with
 546
 547    substitute: s/[aeiou]//gi...139 substitutions made.
 548    Now text is: Whn h s t  cnvnnc str nd th bll cms t sm mnt lk 76 cnts,
 549    Mynrd s wr tht thr s smthng h *shld* d, smthng tht wll nbl hm t gt bck
 550    qrtr, bt h hs n d *wht*.  H fmbls thrgh hs rd sqzy chngprs nd gvs th by
 551    thr xtr pnns wth hs dllr, hpng tht h mght lck nt th crrct mnt.  Th by gvs
 552    hm bck tw f hs wn pnns nd thn th bg shny qrtr tht s hs prz. -RCHH
 553
 554    substitute: s/Perl/C...No substitution made.
 555
 556 =head2 Fiddling with the Perl stack from your C program
 557
 558 When trying to explain stacks, most computer science textbooks mumble
 559 something about spring-loaded columns of cafeteria plates: the last
 560 thing you pushed on the stack is the first thing you pop off.  That'll
 561 do for our purposes: your C program will push some arguments onto "the Perl
 562 stack", shut its eyes while some magic happens, and then pop the
 563 results--the return value of your Perl subroutine--off the stack.
 564
 565 First you'll need to know how to convert between C types and Perl
 566 types, with newSViv() and sv_setnv() and newAV() and all their
 567 friends.  They're described in L<perlguts> and L<perlapi>.
 568
 569 Then you'll need to know how to manipulate the Perl stack.  That's
 570 described in L<perlcall>.
 571
 572 Once you've understood those, embedding Perl in C is easy.
 573
 574 Because C has no builtin function for integer exponentiation, let's
 575 make Perl's ** operator available to it (this is less useful than it
 576 sounds, because Perl implements ** with C's I<pow()> function).  First
 577 I'll create a stub exponentiation function in I<power.pl>:
 578
 579     sub expo {
 580         my ($a, $b) = @_;
 581         return $a ** $b;
 582     }
 583
 584 Now I'll create a C program, I<power.c>, with a function
 585 I<PerlPower()> that contains all the perlguts necessary to push the
 586 two arguments into I<expo()> and to pop the return value out.  Take a
 587 deep breath...
 588
 589     #include <EXTERN.h>
 590     #include <perl.h>
 591
 592     static PerlInterpreter *my_perl;
 593
 594     static void
 595     PerlPower(int a, int b)
 596     {
 597       dSP;                            /* initialize stack pointer      */
 598       ENTER;                          /* everything created after here */
 599       SAVETMPS;                       /* ...is a temporary variable.   */
 600       PUSHMARK(SP);                   /* remember the stack pointer    */
 601       XPUSHs(sv_2mortal(newSViv(a))); /* push the base onto the stack  */
 602       XPUSHs(sv_2mortal(newSViv(b))); /* push the exponent onto stack  */
 603       PUTBACK;                      /* make local stack pointer global */
 604       call_pv("expo", G_SCALAR);      /* call the function             */
 605       SPAGAIN;                        /* refresh stack pointer         */
 606                                     /* pop the return value from stack */
 607       printf ("%d to the %dth power is %d.\n", a, b, POPi);
 608       PUTBACK;
 609       FREETMPS;                       /* free that return value        */
 610       LEAVE;                       /* ...and the XPUSHed "mortal" args.*/
 611     }
 612
 613     int main (int argc, char **argv, char **env)
 614     {
 615       char *my_argv[] = { "", "power.pl" };
 616
 617       my_perl = perl_alloc();
 618       perl_construct( my_perl );
 619
 620       perl_parse(my_perl, NULL, 2, my_argv, (char **)NULL);
 621       PL_exit_flags |= PERL_EXIT_DESTRUCT_END;
 622       perl_run(my_perl);
 623
 624       PerlPower(3, 4);                      /*** Compute 3 ** 4 ***/
 625
 626       perl_destruct(my_perl);
 627       perl_free(my_perl);
 628     }
 629
 630
 631
 632 Compile and run:
 633
 634     % cc -o power power.c `perl -MExtUtils::Embed -e ccopts -e ldopts`
 635
 636     % power
 637     3 to the 4th power is 81.
 638
 639 =head2 Maintaining a persistent interpreter
 640
 641 When developing interactive and/or potentially long-running
 642 applications, it's a good idea to maintain a persistent interpreter
 643 rather than allocating and constructing a new interpreter multiple
 644 times.  The major reason is speed: since Perl will only be loaded into
 645 memory once.
 646
 647 However, you have to be more cautious with namespace and variable
 648 scoping when using a persistent interpreter.  In previous examples
 649 we've been using global variables in the default package C<main>.  We
 650 knew exactly what code would be run, and assumed we could avoid
 651 variable collisions and outrageous symbol table growth.
 652
 653 Let's say your application is a server that will occasionally run Perl
 654 code from some arbitrary file.  Your server has no way of knowing what
 655 code it's going to run.  Very dangerous.
 656
 657 If the file is pulled in by C<perl_parse()>, compiled into a newly
 658 constructed interpreter, and subsequently cleaned out with
 659 C<perl_destruct()> afterwards, you're shielded from most namespace
 660 troubles.
 661
 662 One way to avoid namespace collisions in this scenario is to translate
 663 the filename into a guaranteed-unique package name, and then compile
 664 the code into that package using L<perlfunc/eval>.  In the example
 665 below, each file will only be compiled once.  Or, the application
 666 might choose to clean out the symbol table associated with the file
 667 after it's no longer needed.  Using L<perlapi/call_argv>, We'll
 668 call the subroutine C<Embed::Persistent::eval_file> which lives in the
 669 file C<persistent.pl> and pass the filename and boolean cleanup/cache
 670 flag as arguments.
 671
 672 Note that the process will continue to grow for each file that it
 673 uses.  In addition, there might be C<AUTOLOAD>ed subroutines and other
 674 conditions that cause Perl's symbol table to grow.  You might want to
 675 add some logic that keeps track of the process size, or restarts
 676 itself after a certain number of requests, to ensure that memory
 677 consumption is minimized.  You'll also want to scope your variables
 678 with L<perlfunc/my> whenever possible.
 679
 680
 681  package Embed::Persistent;
 682  #persistent.pl
 683
 684  use strict;
 685  our %Cache;
 686  use Symbol qw(delete_package);
 687
 688  sub valid_package_name {
 689      my($string) = @_;
 690      $string =~ s/([^A-Za-z0-9\/])/sprintf("_%2x",unpack("C",$1))/eg;
 691      # second pass only for words starting with a digit
 692      $string =~ s|/(\d)|sprintf("/_%2x",unpack("C",$1))|eg;
 693
 694      # Dress it up as a real package name
 695      $string =~ s|/|::|g;
 696      return "Embed" . $string;
 697  }
 698
 699  sub eval_file {
 700      my($filename, $delete) = @_;
 701      my $package = valid_package_name($filename);
 702      my $mtime = -M $filename;
 703      if(defined $Cache{$package}{mtime}
 704         &&
 705         $Cache{$package}{mtime} <= $mtime)
 706      {
 707         # we have compiled this subroutine already,
 708         # it has not been updated on disk, nothing left to do
 709         print STDERR "already compiled $package->handler\n";
 710      }
 711      else {
 712         local *FH;
 713         open FH, $filename or die "open '$filename' $!";
 714         local($/) = undef;
 715         my $sub = <FH>;
 716         close FH;
 717
 718         #wrap the code into a subroutine inside our unique package
 719         my $eval = qq{package $package; sub handler { $sub; }};
 720         {
 721             # hide our variables within this block
 722             my($filename,$mtime,$package,$sub);
 723             eval $eval;
 724         }
 725         die $@ if $@;
 726
 727         #cache it unless we're cleaning out each time
 728         $Cache{$package}{mtime} = $mtime unless $delete;
 729      }
 730
 731      eval {$package->handler;};
 732      die $@ if $@;
 733
 734      delete_package($package) if $delete;
 735
 736      #take a look if you want
 737      #print Devel::Symdump->rnew($package)->as_string, $/;
 738  }
 739
 740  1;
 741
 742  __END__
 743
 744  /* persistent.c */
 745  #include <EXTERN.h>
 746  #include <perl.h>
 747
 748  /* 1 = clean out filename's symbol table after each request, 0 = don't */
 749  #ifndef DO_CLEAN
 750  #define DO_CLEAN 0
 751  #endif
 752
 753  static PerlInterpreter *my_perl = NULL;
 754
 755  int
 756  main(int argc, char **argv, char **env)
 757  {
 758      char *embedding[] = { "", "persistent.pl" };
 759      char *args[] = { "", DO_CLEAN, NULL };
 760      char filename [1024];
 761      int exitstatus = 0;
 762      STRLEN n_a;
 763
 764      if((my_perl = perl_alloc()) == NULL) {
 765         fprintf(stderr, "no memory!");
 766         exit(1);
 767      }
 768      perl_construct(my_perl);
 769
 770      exitstatus = perl_parse(my_perl, NULL, 2, embedding, NULL);
 771      PL_exit_flags |= PERL_EXIT_DESTRUCT_END;
 772      if(!exitstatus) {
 773         exitstatus = perl_run(my_perl);
 774
 775         while(printf("Enter file name: ") && gets(filename)) {
 776
 777             /* call the subroutine, passing it the filename as an argument */
 778             args[0] = filename;
 779             call_argv("Embed::Persistent::eval_file",
 780                            G_DISCARD | G_EVAL, args);
 781
 782             /* check $@ */
 783             if(SvTRUE(ERRSV))
 784                 fprintf(stderr, "eval error: %s\n", SvPV(ERRSV,n_a));
 785         }
 786      }
 787
 788      PL_perl_destruct_level = 0;
 789      perl_destruct(my_perl);
 790      perl_free(my_perl);
 791      exit(exitstatus);
 792  }
 793
 794 Now compile:
 795
 796  % cc -o persistent persistent.c `perl -MExtUtils::Embed -e ccopts -e ldopts`
 797
 798 Here's an example script file:
 799
 800  #test.pl
 801  my $string = "hello";
 802  foo($string);
 803
 804  sub foo {
 805      print "foo says: @_\n";
 806  }
 807
 808 Now run:
 809
 810  % persistent
 811  Enter file name: test.pl
 812  foo says: hello
 813  Enter file name: test.pl
 814  already compiled Embed::test_2epl->handler
 815  foo says: hello
 816  Enter file name: ^C
 817
 818 =head2 Execution of END blocks
 819
 820 Traditionally END blocks have been executed at the end of the perl_run.
 821 This causes problems for applications that never call perl_run. Since
 822 perl 5.7.2 you can specify C<PL_exit_flags |= PERL_EXIT_DESTRUCT_END>
 823 to get the new behaviour. This also enables the running of END blocks if
 824 the perl_prase fails and C<perl_destruct> will return the exit value.
 825
 826 =head2 Maintaining multiple interpreter instances
 827
 828 Some rare applications will need to create more than one interpreter
 829 during a session.  Such an application might sporadically decide to
 830 release any resources associated with the interpreter.
 831
 832 The program must take care to ensure that this takes place I<before>
 833 the next interpreter is constructed.  By default, when perl is not
 834 built with any special options, the global variable
 835 C<PL_perl_destruct_level> is set to C<0>, since extra cleaning isn't
 836 usually needed when a program only ever creates a single interpreter
 837 in its entire lifetime.
 838
 839 Setting C<PL_perl_destruct_level> to C<1> makes everything squeaky clean:
 840
 841  PL_perl_destruct_level = 1;
 842
 843  while(1) {
 844      ...
 845      /* reset global variables here with PL_perl_destruct_level = 1 */
 846      perl_construct(my_perl);
 847      ...
 848      /* clean and reset _everything_ during perl_destruct */
 849      perl_destruct(my_perl);
 850      perl_free(my_perl);
 851      ...
 852      /* let's go do it again! */
 853  }
 854
 855 When I<perl_destruct()> is called, the interpreter's syntax parse tree
 856 and symbol tables are cleaned up, and global variables are reset.
 857
 858 Now suppose we have more than one interpreter instance running at the
 859 same time.  This is feasible, but only if you used the Configure option
 860 C<-Dusemultiplicity> or the options C<-Dusethreads -Duseithreads> when
 861 building Perl.  By default, enabling one of these Configure options
 862 sets the per-interpreter global variable C<PL_perl_destruct_level> to
 863 C<1>, so that thorough cleaning is automatic.
 864
 865 Using C<-Dusethreads -Duseithreads> rather than C<-Dusemultiplicity>
 866 is more appropriate if you intend to run multiple interpreters
 867 concurrently in different threads, because it enables support for
 868 linking in the thread libraries of your system with the interpreter.
 869
 870 Let's give it a try:
 871
 872
 873  #include <EXTERN.h>
 874  #include <perl.h>
 875
 876  /* we're going to embed two interpreters */
 877  /* we're going to embed two interpreters */
 878
 879  #define SAY_HELLO "-e", "print qq(Hi, I'm $^X\n)"
 880
 881  int main(int argc, char **argv, char **env)
 882  {
 883      PerlInterpreter
 884          *one_perl = perl_alloc(),
 885          *two_perl = perl_alloc();
 886      char *one_args[] = { "one_perl", SAY_HELLO };
 887      char *two_args[] = { "two_perl", SAY_HELLO };
 888
 889      PERL_SET_CONTEXT(one_perl);
 890      perl_construct(one_perl);
 891      PERL_SET_CONTEXT(two_perl);
 892      perl_construct(two_perl);
 893
 894      PERL_SET_CONTEXT(one_perl);
 895      perl_parse(one_perl, NULL, 3, one_args, (char **)NULL);
 896      PERL_SET_CONTEXT(two_perl);
 897      perl_parse(two_perl, NULL, 3, two_args, (char **)NULL);
 898
 899      PERL_SET_CONTEXT(one_perl);
 900      perl_run(one_perl);
 901      PERL_SET_CONTEXT(two_perl);
 902      perl_run(two_perl);
 903
 904      PERL_SET_CONTEXT(one_perl);
 905      perl_destruct(one_perl);
 906      PERL_SET_CONTEXT(two_perl);
 907      perl_destruct(two_perl);
 908
 909      PERL_SET_CONTEXT(one_perl);
 910      perl_free(one_perl);
 911      PERL_SET_CONTEXT(two_perl);
 912      perl_free(two_perl);
 913  }
 914
 915 Note the calls to PERL_SET_CONTEXT().  These are necessary to initialize
 916 the global state that tracks which interpreter is the "current" one on
 917 the particular process or thread that may be running it.  It should
 918 always be used if you have more than one interpreter and are making
 919 perl API calls on both interpreters in an interleaved fashion.
 920
 921 PERL_SET_CONTEXT(interp) should also be called whenever C<interp> is
 922 used by a thread that did not create it (using either perl_alloc(), or
 923 the more esoteric perl_clone()).
 924
 925 Compile as usual:
 926
 927  % cc -o multiplicity multiplicity.c `perl -MExtUtils::Embed -e ccopts -e ldopts`
 928
 929 Run it, Run it:
 930
 931  % multiplicity
 932  Hi, I'm one_perl
 933  Hi, I'm two_perl
 934
 935 =head2 Using Perl modules, which themselves use C libraries, from your C program
 936
 937 If you've played with the examples above and tried to embed a script
 938 that I<use()>s a Perl module (such as I<Socket>) which itself uses a C or C++ library,
 939 this probably happened:
 940
 941
 942  Can't load module Socket, dynamic loading not available in this perl.
 943   (You may need to build a new perl executable which either supports
 944   dynamic loading or has the Socket module statically linked into it.)
 945
 946
 947 What's wrong?
 948
 949 Your interpreter doesn't know how to communicate with these extensions
 950 on its own.  A little glue will help.  Up until now you've been
 951 calling I<perl_parse()>, handing it NULL for the second argument:
 952
 953  perl_parse(my_perl, NULL, argc, my_argv, NULL);
 954
 955 That's where the glue code can be inserted to create the initial contact between
 956 Perl and linked C/C++ routines.  Let's take a look some pieces of I<perlmain.c>
 957 to see how Perl does this:
 958
 959  static void xs_init (pTHX);
 960
 961  EXTERN_C void boot_DynaLoader (pTHX_ CV* cv);
 962  EXTERN_C void boot_Socket (pTHX_ CV* cv);
 963
 964
 965  EXTERN_C void
 966  xs_init(pTHX)
 967  {
 968         char *file = __FILE__;
 969         /* DynaLoader is a special case */
 970         newXS("DynaLoader::boot_DynaLoader", boot_DynaLoader, file);
 971         newXS("Socket::bootstrap", boot_Socket, file);
 972  }
 973
 974 Simply put: for each extension linked with your Perl executable
 975 (determined during its initial configuration on your
 976 computer or when adding a new extension),
 977 a Perl subroutine is created to incorporate the extension's
 978 routines.  Normally, that subroutine is named
 979 I<Module::bootstrap()> and is invoked when you say I<use Module>.  In
 980 turn, this hooks into an XSUB, I<boot_Module>, which creates a Perl
 981 counterpart for each of the extension's XSUBs.  Don't worry about this
 982 part; leave that to the I<xsubpp> and extension authors.  If your
 983 extension is dynamically loaded, DynaLoader creates I<Module::bootstrap()>
 984 for you on the fly.  In fact, if you have a working DynaLoader then there
 985 is rarely any need to link in any other extensions statically.
 986
 987
 988 Once you have this code, slap it into the second argument of I<perl_parse()>:
 989
 990
 991  perl_parse(my_perl, xs_init, argc, my_argv, NULL);
 992
 993
 994 Then compile:
 995
 996  % cc -o interp interp.c `perl -MExtUtils::Embed -e ccopts -e ldopts`
 997
 998  % interp
 999    use Socket;
1000    use SomeDynamicallyLoadedModule;
1001
1002    print "Now I can use extensions!\n"'
1003
1004 B<ExtUtils::Embed> can also automate writing the I<xs_init> glue code.
1005
1006  % perl -MExtUtils::Embed -e xsinit -- -o perlxsi.c
1007  % cc -c perlxsi.c `perl -MExtUtils::Embed -e ccopts`
1008  % cc -c interp.c  `perl -MExtUtils::Embed -e ccopts`
1009  % cc -o interp perlxsi.o interp.o `perl -MExtUtils::Embed -e ldopts`
1010
1011 Consult L<perlxs>, L<perlguts>, and L<perlapi> for more details.
1012
1013 =head1 Embedding Perl under Win32
1014
1015 In general, all of the source code shown here should work unmodified under
1016 Windows.
1017
1018 However, there are some caveats about the command-line examples shown.
1019 For starters, backticks won't work under the Win32 native command shell.
1020 The ExtUtils::Embed kit on CPAN ships with a script called
1021 B<genmake>, which generates a simple makefile to build a program from
1022 a single C source file.  It can be used like this:
1023
1024  C:\ExtUtils-Embed\eg> perl genmake interp.c
1025  C:\ExtUtils-Embed\eg> nmake
1026  C:\ExtUtils-Embed\eg> interp -e "print qq{I'm embedded in Win32!\n}"
1027
1028 You may wish to use a more robust environment such as the Microsoft
1029 Developer Studio.  In this case, run this to generate perlxsi.c:
1030
1031  perl -MExtUtils::Embed -e xsinit
1032
1033 Create a new project and Insert -> Files into Project: perlxsi.c,
1034 perl.lib, and your own source files, e.g. interp.c.  Typically you'll
1035 find perl.lib in B<C:\perl\lib\CORE>, if not, you should see the
1036 B<CORE> directory relative to C<perl -V:archlib>.  The studio will
1037 also need this path so it knows where to find Perl include files.
1038 This path can be added via the Tools -> Options -> Directories menu.
1039 Finally, select Build -> Build interp.exe and you're ready to go.
1040
1041 =head1 MORAL
1042
1043 You can sometimes I<write faster code> in C, but
1044 you can always I<write code faster> in Perl.  Because you can use
1045 each from the other, combine them as you wish.
1046
1047
1048 =head1 AUTHOR
1049
1050 Jon Orwant <F<orwant@tpj.com>> and Doug MacEachern
1051 <F<dougm@osf.org>>, with small contributions from Tim Bunce, Tom
1052 Christiansen, Guy Decoux, Hallvard Furuseth, Dov Grobgeld, and Ilya
1053 Zakharevich.
1054
1055 Doug MacEachern has an article on embedding in Volume 1, Issue 4 of
1056 The Perl Journal ( http://www.tpj.com/ ).  Doug is also the developer of the
1057 most widely-used Perl embedding: the mod_perl system
1058 (perl.apache.org), which embeds Perl in the Apache web server.
1059 Oracle, Binary Evolution, ActiveState, and Ben Sugars's nsapi_perl
1060 have used this model for Oracle, Netscape and Internet Information
1061 Server Perl plugins.
1062
1063 July 22, 1998
1064
1065 =head1 COPYRIGHT
1066
1067 Copyright (C) 1995, 1996, 1997, 1998 Doug MacEachern and Jon Orwant.  All
1068 Rights Reserved.
1069
1070 Permission is granted to make and distribute verbatim copies of this
1071 documentation provided the copyright notice and this permission notice are
1072 preserved on all copies.
1073
1074 Permission is granted to copy and distribute modified versions of this
1075 documentation under the conditions for verbatim copying, provided also
1076 that they are marked clearly as modified versions, that the authors'
1077 names and title are unchanged (though subtitles and additional
1078 authors' names may be added), and that the entire resulting derived
1079 work is distributed under the terms of a permission notice identical
1080 to this one.
1081
1082 Permission is granted to copy and distribute translations of this
1083 documentation into another language, under the above conditions for
1084 modified versions.