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