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