3 * Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
12 * "A ship then new they built for him/of mithril and of elven glass" --Bilbo
15 /* This file contains the top-level functions that are used to create, use
16 * and destroy a perl interpreter, plus the functions used by XS code to
17 * call back into perl. Note that it does not contain the actual main()
18 * function of the interpreter; that can be found in perlmain.c
23 * Be proud that perl(1) may proclaim:
24 * Setuid Perl scripts are safer than C programs ...
25 * Do not abandon (deprecate) suidperl. Do not advocate C wrappers.
27 * The flow was: perl starts, notices script is suid, execs suidperl with same
28 * arguments; suidperl opens script, checks many things, sets itself with
29 * right UID, execs perl with similar arguments but with script pre-opened on
30 * /dev/fd/xxx; perl checks script is as should be and does work. This was
31 * insecure: see perlsec(1) for many problems with this approach.
33 * The "correct" flow should be: perl starts, opens script and notices it is
34 * suid, checks many things, execs suidperl with similar arguments but with
35 * script on /dev/fd/xxx; suidperl checks script and /dev/fd/xxx object are
36 * same, checks arguments match #! line, sets itself with right UID, execs
37 * perl with same arguments; perl checks many things and does work.
39 * (Opening the script in perl instead of suidperl, we "lose" scripts that
40 * are readable to the target UID but not to the invoker. Where did
41 * unreadable scripts work anyway?)
43 * For now, suidperl and perl are pretty much the same large and cumbersome
44 * program, so suidperl can check its argument list (see comments elsewhere).
47 * Original bug report:
48 * http://bugs.perl.org/index.html?req=bug_id&bug_id=20010322.218
49 * http://rt.perl.org/rt2/Ticket/Display.html?id=6511
50 * Comments and discussion with Debian:
51 * http://bugs.debian.org/203426
52 * http://bugs.debian.org/220486
53 * Debian Security Advisory DSA 431-1 (does not fully fix problem):
54 * http://www.debian.org/security/2004/dsa-431
56 * http://cve.mitre.org/cgi-bin/cvename.cgi?name=CAN-2003-0618
57 * Previous versions of this patch sent to perl5-porters:
58 * http://www.mail-archive.com/perl5-porters@perl.org/msg71953.html
59 * http://www.mail-archive.com/perl5-porters@perl.org/msg75245.html
60 * http://www.mail-archive.com/perl5-porters@perl.org/msg75563.html
61 * http://www.mail-archive.com/perl5-porters@perl.org/msg75635.html
63 Paul Szabo - psz@maths.usyd.edu.au http://www.maths.usyd.edu.au:8000/u/psz/
64 School of Mathematics and Statistics University of Sydney 2006 Australia
68 * Use truthful, neat, specific error messages.
69 * Cannot always hide the truth; security must not depend on doing so.
73 * Use global(?), thread-local fdscript for easier checks.
74 * (I do not understand how we could possibly get a thread race:
75 * do not all threads go through the same initialization? Or in
76 * fact, are not threads started only after we get the script and
77 * so know what to do? Oh well, make things super-safe...)
81 #define PERL_IN_PERL_C
83 #include "patchlevel.h" /* for local_patches */
87 char *nw_get_sitelib(const char *pl);
90 /* XXX If this causes problems, set i_unistd=undef in the hint file. */
107 #if !defined(STANDARD_C) && !defined(HAS_GETENV_PROTOTYPE) && !defined(PERL_MICRO)
108 char *getenv (char *); /* Usually in <stdlib.h> */
111 static I32 read_e_script(pTHX_ int idx, SV *buf_sv, int maxlen);
119 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
125 #if defined(USE_ITHREADS)
126 # define INIT_TLS_AND_INTERP \
128 if (!PL_curinterp) { \
129 PERL_SET_INTERP(my_perl); \
132 PERL_SET_THX(my_perl); \
134 MUTEX_INIT(&PL_dollarzero_mutex); \
137 PERL_SET_THX(my_perl); \
141 # define INIT_TLS_AND_INTERP \
143 if (!PL_curinterp) { \
144 PERL_SET_INTERP(my_perl); \
146 PERL_SET_THX(my_perl); \
150 #ifdef PERL_IMPLICIT_SYS
152 perl_alloc_using(struct IPerlMem* ipM, struct IPerlMem* ipMS,
153 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
154 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
155 struct IPerlDir* ipD, struct IPerlSock* ipS,
156 struct IPerlProc* ipP)
158 PerlInterpreter *my_perl;
159 /* New() needs interpreter, so call malloc() instead */
160 my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
162 Zero(my_perl, 1, PerlInterpreter);
178 =head1 Embedding Functions
180 =for apidoc perl_alloc
182 Allocates a new Perl interpreter. See L<perlembed>.
190 PerlInterpreter *my_perl;
191 #ifdef USE_5005THREADS
195 /* New() needs interpreter, so call malloc() instead */
196 my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
199 return ZeroD(my_perl, 1, PerlInterpreter);
201 #endif /* PERL_IMPLICIT_SYS */
204 =for apidoc perl_construct
206 Initializes a new Perl interpreter. See L<perlembed>.
212 perl_construct(pTHXx)
216 PL_perl_destruct_level = 1;
218 if (PL_perl_destruct_level > 0)
221 /* Init the real globals (and main thread)? */
223 #ifdef PERL_FLEXIBLE_EXCEPTIONS
224 PL_protect = MEMBER_TO_FPTR(Perl_default_protect); /* for exceptions */
227 PL_curcop = &PL_compiling; /* needed by ckWARN, right away */
229 PL_linestr = NEWSV(65,79);
230 sv_upgrade(PL_linestr,SVt_PVIV);
232 if (!SvREADONLY(&PL_sv_undef)) {
233 /* set read-only and try to insure than we wont see REFCNT==0
236 SvREADONLY_on(&PL_sv_undef);
237 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
239 sv_setpv(&PL_sv_no,PL_No);
240 /* value lookup in void context - happens to have the side effect
241 of caching the numeric forms. */
244 SvREADONLY_on(&PL_sv_no);
245 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
247 sv_setpv(&PL_sv_yes,PL_Yes);
250 SvREADONLY_on(&PL_sv_yes);
251 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
253 SvREADONLY_on(&PL_sv_placeholder);
254 SvREFCNT(&PL_sv_placeholder) = (~(U32)0)/2;
257 PL_sighandlerp = Perl_sighandler;
258 PL_pidstatus = newHV();
261 PL_rs = newSVpvn("\n", 1);
266 PL_lex_state = LEX_NOTPARSING;
272 SET_NUMERIC_STANDARD();
274 #if defined(LOCAL_PATCH_COUNT)
275 PL_localpatches = local_patches; /* For possible -v */
278 #ifdef HAVE_INTERP_INTERN
282 PerlIO_init(aTHX); /* Hook to IO system */
284 PL_fdpid = newAV(); /* for remembering popen pids by fd */
285 PL_modglobal = newHV(); /* pointers to per-interpreter module globals */
286 PL_errors = newSVpvn("",0);
287 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
288 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
289 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
291 PL_regex_padav = newAV();
292 av_push(PL_regex_padav,(SV*)newAV()); /* First entry is an array of empty elements */
293 PL_regex_pad = AvARRAY(PL_regex_padav);
295 #ifdef USE_REENTRANT_API
296 Perl_reentrant_init(aTHX);
299 /* Note that strtab is a rather special HV. Assumptions are made
300 about not iterating on it, and not adding tie magic to it.
301 It is properly deallocated in perl_destruct() */
304 HvSHAREKEYS_off(PL_strtab); /* mandatory */
305 hv_ksplit(PL_strtab, 512);
307 #if defined(__DYNAMIC__) && (defined(NeXT) || defined(__NeXT__))
308 _dyld_lookup_and_bind
309 ("__environ", (unsigned long *) &environ_pointer, NULL);
313 # ifdef USE_ENVIRON_ARRAY
314 PL_origenviron = environ;
318 /* Use sysconf(_SC_CLK_TCK) if available, if not
319 * available or if the sysconf() fails, use the HZ. */
320 #if defined(HAS_SYSCONF) && defined(_SC_CLK_TCK)
321 PL_clocktick = sysconf(_SC_CLK_TCK);
322 if (PL_clocktick <= 0)
326 PL_stashcache = newHV();
328 PL_patchlevel = newSVpv(
329 Perl_form(aTHX_ "%d.%d.%d",
332 (int)PERL_SUBVERSION ), 0
339 =for apidoc nothreadhook
341 Stub that provides thread hook for perl_destruct when there are
348 Perl_nothreadhook(pTHX)
354 =for apidoc perl_destruct
356 Shuts down a Perl interpreter. See L<perlembed>.
364 volatile int destruct_level; /* 0=none, 1=full, 2=full with checks */
366 #ifdef USE_5005THREADS
368 #endif /* USE_5005THREADS */
370 /* wait for all pseudo-forked children to finish */
371 PERL_WAIT_FOR_CHILDREN;
373 destruct_level = PL_perl_destruct_level;
377 if ((s = PerlEnv_getenv("PERL_DESTRUCT_LEVEL"))) {
379 if (destruct_level < i)
386 if(PL_exit_flags & PERL_EXIT_DESTRUCT_END) {
391 if (PL_endav && !PL_minus_c)
392 call_list(PL_scopestack_ix, PL_endav);
398 /* Need to flush since END blocks can produce output */
401 if (CALL_FPTR(PL_threadhook)(aTHX)) {
402 /* Threads hook has vetoed further cleanup */
403 return STATUS_NATIVE_EXPORT;
406 /* We must account for everything. */
408 /* Destroy the main CV and syntax tree */
410 /* ensure comppad/curpad to refer to main's pad */
411 if (CvPADLIST(PL_main_cv)) {
412 PAD_SET_CUR_NOSAVE(CvPADLIST(PL_main_cv), 1);
414 op_free(PL_main_root);
415 PL_main_root = Nullop;
417 PL_curcop = &PL_compiling;
418 PL_main_start = Nullop;
419 SvREFCNT_dec(PL_main_cv);
423 /* Tell PerlIO we are about to tear things apart in case
424 we have layers which are using resources that should
428 PerlIO_destruct(aTHX);
430 if (PL_sv_objcount) {
432 * Try to destruct global references. We do this first so that the
433 * destructors and destructees still exist. Some sv's might remain.
434 * Non-referenced objects are on their own.
440 /* unhook hooks which will soon be, or use, destroyed data */
441 SvREFCNT_dec(PL_warnhook);
442 PL_warnhook = Nullsv;
443 SvREFCNT_dec(PL_diehook);
446 /* call exit list functions */
447 while (PL_exitlistlen-- > 0)
448 PL_exitlist[PL_exitlistlen].fn(aTHX_ PL_exitlist[PL_exitlistlen].ptr);
450 Safefree(PL_exitlist);
455 if (destruct_level == 0){
457 DEBUG_P(debprofdump());
459 #if defined(PERLIO_LAYERS)
460 /* No more IO - including error messages ! */
461 PerlIO_cleanup(aTHX);
464 /* The exit() function will do everything that needs doing. */
465 return STATUS_NATIVE_EXPORT;
468 /* jettison our possibly duplicated environment */
469 /* if PERL_USE_SAFE_PUTENV is defined environ will not have been copied
470 * so we certainly shouldn't free it here
473 #if defined(USE_ENVIRON_ARRAY) && !defined(PERL_USE_SAFE_PUTENV)
474 if (environ != PL_origenviron
476 /* only main thread can free environ[0] contents */
477 && PL_curinterp == aTHX
483 for (i = 0; environ[i]; i++)
484 safesysfree(environ[i]);
486 /* Must use safesysfree() when working with environ. */
487 safesysfree(environ);
489 environ = PL_origenviron;
492 #endif /* !PERL_MICRO */
494 /* reset so print() ends up where we expect */
498 /* the syntax tree is shared between clones
499 * so op_free(PL_main_root) only ReREFCNT_dec's
500 * REGEXPs in the parent interpreter
501 * we need to manually ReREFCNT_dec for the clones
504 I32 i = AvFILLp(PL_regex_padav) + 1;
505 SV **ary = AvARRAY(PL_regex_padav);
509 REGEXP *re = INT2PTR(REGEXP *,SvIVX(resv));
511 if (SvFLAGS(resv) & SVf_BREAK) {
512 /* this is PL_reg_curpm, already freed
513 * flag is set in regexec.c:S_regtry
515 SvFLAGS(resv) &= ~SVf_BREAK;
517 else if(SvREPADTMP(resv)) {
518 SvREPADTMP_off(resv);
525 SvREFCNT_dec(PL_regex_padav);
526 PL_regex_padav = Nullav;
530 SvREFCNT_dec((SV*) PL_stashcache);
531 PL_stashcache = NULL;
533 /* loosen bonds of global variables */
536 (void)PerlIO_close(PL_rsfp);
540 /* Filters for program text */
541 SvREFCNT_dec(PL_rsfp_filters);
542 PL_rsfp_filters = Nullav;
545 PL_preprocess = FALSE;
551 PL_doswitches = FALSE;
552 PL_dowarn = G_WARN_OFF;
553 PL_doextract = FALSE;
554 PL_sawampersand = FALSE; /* must save all match strings */
557 Safefree(PL_inplace);
559 SvREFCNT_dec(PL_patchlevel);
562 SvREFCNT_dec(PL_e_script);
563 PL_e_script = Nullsv;
568 /* magical thingies */
570 SvREFCNT_dec(PL_ofs_sv); /* $, */
573 SvREFCNT_dec(PL_ors_sv); /* $\ */
576 SvREFCNT_dec(PL_rs); /* $/ */
579 PL_multiline = 0; /* $* */
580 Safefree(PL_osname); /* $^O */
583 SvREFCNT_dec(PL_statname);
584 PL_statname = Nullsv;
587 /* defgv, aka *_ should be taken care of elsewhere */
589 /* clean up after study() */
590 SvREFCNT_dec(PL_lastscream);
591 PL_lastscream = Nullsv;
592 Safefree(PL_screamfirst);
594 Safefree(PL_screamnext);
598 Safefree(PL_efloatbuf);
599 PL_efloatbuf = Nullch;
602 /* startup and shutdown function lists */
603 SvREFCNT_dec(PL_beginav);
604 SvREFCNT_dec(PL_beginav_save);
605 SvREFCNT_dec(PL_endav);
606 SvREFCNT_dec(PL_checkav);
607 SvREFCNT_dec(PL_checkav_save);
608 SvREFCNT_dec(PL_initav);
610 PL_beginav_save = Nullav;
613 PL_checkav_save = Nullav;
616 /* shortcuts just get cleared */
622 PL_argvoutgv = Nullgv;
624 PL_stderrgv = Nullgv;
625 PL_last_in_gv = Nullgv;
630 PL_DBsingle = Nullsv;
632 PL_DBsignal = Nullsv;
633 PL_DBassertion = Nullsv;
636 PL_debstash = Nullhv;
638 SvREFCNT_dec(PL_argvout_stack);
639 PL_argvout_stack = Nullav;
641 SvREFCNT_dec(PL_modglobal);
642 PL_modglobal = Nullhv;
643 SvREFCNT_dec(PL_preambleav);
644 PL_preambleav = Nullav;
645 SvREFCNT_dec(PL_subname);
647 SvREFCNT_dec(PL_linestr);
649 SvREFCNT_dec(PL_pidstatus);
650 PL_pidstatus = Nullhv;
651 SvREFCNT_dec(PL_toptarget);
652 PL_toptarget = Nullsv;
653 SvREFCNT_dec(PL_bodytarget);
654 PL_bodytarget = Nullsv;
655 PL_formtarget = Nullsv;
657 /* free locale stuff */
658 #ifdef USE_LOCALE_COLLATE
659 Safefree(PL_collation_name);
660 PL_collation_name = Nullch;
663 #ifdef USE_LOCALE_NUMERIC
664 Safefree(PL_numeric_name);
665 PL_numeric_name = Nullch;
666 SvREFCNT_dec(PL_numeric_radix_sv);
667 PL_numeric_radix_sv = Nullsv;
670 /* clear utf8 character classes */
671 SvREFCNT_dec(PL_utf8_alnum);
672 SvREFCNT_dec(PL_utf8_alnumc);
673 SvREFCNT_dec(PL_utf8_ascii);
674 SvREFCNT_dec(PL_utf8_alpha);
675 SvREFCNT_dec(PL_utf8_space);
676 SvREFCNT_dec(PL_utf8_cntrl);
677 SvREFCNT_dec(PL_utf8_graph);
678 SvREFCNT_dec(PL_utf8_digit);
679 SvREFCNT_dec(PL_utf8_upper);
680 SvREFCNT_dec(PL_utf8_lower);
681 SvREFCNT_dec(PL_utf8_print);
682 SvREFCNT_dec(PL_utf8_punct);
683 SvREFCNT_dec(PL_utf8_xdigit);
684 SvREFCNT_dec(PL_utf8_mark);
685 SvREFCNT_dec(PL_utf8_toupper);
686 SvREFCNT_dec(PL_utf8_totitle);
687 SvREFCNT_dec(PL_utf8_tolower);
688 SvREFCNT_dec(PL_utf8_tofold);
689 SvREFCNT_dec(PL_utf8_idstart);
690 SvREFCNT_dec(PL_utf8_idcont);
691 PL_utf8_alnum = Nullsv;
692 PL_utf8_alnumc = Nullsv;
693 PL_utf8_ascii = Nullsv;
694 PL_utf8_alpha = Nullsv;
695 PL_utf8_space = Nullsv;
696 PL_utf8_cntrl = Nullsv;
697 PL_utf8_graph = Nullsv;
698 PL_utf8_digit = Nullsv;
699 PL_utf8_upper = Nullsv;
700 PL_utf8_lower = Nullsv;
701 PL_utf8_print = Nullsv;
702 PL_utf8_punct = Nullsv;
703 PL_utf8_xdigit = Nullsv;
704 PL_utf8_mark = Nullsv;
705 PL_utf8_toupper = Nullsv;
706 PL_utf8_totitle = Nullsv;
707 PL_utf8_tolower = Nullsv;
708 PL_utf8_tofold = Nullsv;
709 PL_utf8_idstart = Nullsv;
710 PL_utf8_idcont = Nullsv;
712 if (!specialWARN(PL_compiling.cop_warnings))
713 SvREFCNT_dec(PL_compiling.cop_warnings);
714 PL_compiling.cop_warnings = Nullsv;
715 if (!specialCopIO(PL_compiling.cop_io))
716 SvREFCNT_dec(PL_compiling.cop_io);
717 PL_compiling.cop_io = Nullsv;
718 CopFILE_free(&PL_compiling);
719 CopSTASH_free(&PL_compiling);
721 /* Prepare to destruct main symbol table. */
726 SvREFCNT_dec(PL_curstname);
727 PL_curstname = Nullsv;
729 /* clear queued errors */
730 SvREFCNT_dec(PL_errors);
734 if (destruct_level >= 2 && ckWARN_d(WARN_INTERNAL)) {
735 if (PL_scopestack_ix != 0)
736 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
737 "Unbalanced scopes: %ld more ENTERs than LEAVEs\n",
738 (long)PL_scopestack_ix);
739 if (PL_savestack_ix != 0)
740 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
741 "Unbalanced saves: %ld more saves than restores\n",
742 (long)PL_savestack_ix);
743 if (PL_tmps_floor != -1)
744 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced tmps: %ld more allocs than frees\n",
745 (long)PL_tmps_floor + 1);
746 if (cxstack_ix != -1)
747 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced context: %ld more PUSHes than POPs\n",
748 (long)cxstack_ix + 1);
751 /* Now absolutely destruct everything, somehow or other, loops or no. */
752 SvFLAGS(PL_fdpid) |= SVTYPEMASK; /* don't clean out pid table now */
753 SvFLAGS(PL_strtab) |= SVTYPEMASK; /* don't clean out strtab now */
755 /* the 2 is for PL_fdpid and PL_strtab */
756 while (PL_sv_count > 2 && sv_clean_all())
759 SvFLAGS(PL_fdpid) &= ~SVTYPEMASK;
760 SvFLAGS(PL_fdpid) |= SVt_PVAV;
761 SvFLAGS(PL_strtab) &= ~SVTYPEMASK;
762 SvFLAGS(PL_strtab) |= SVt_PVHV;
764 AvREAL_off(PL_fdpid); /* no surviving entries */
765 SvREFCNT_dec(PL_fdpid); /* needed in io_close() */
768 #ifdef HAVE_INTERP_INTERN
772 /* Destruct the global string table. */
774 /* Yell and reset the HeVAL() slots that are still holding refcounts,
775 * so that sv_free() won't fail on them.
783 max = HvMAX(PL_strtab);
784 array = HvARRAY(PL_strtab);
787 if (hent && ckWARN_d(WARN_INTERNAL)) {
788 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
789 "Unbalanced string table refcount: (%d) for \"%s\"",
790 HeVAL(hent) - Nullsv, HeKEY(hent));
791 HeVAL(hent) = Nullsv;
801 SvREFCNT_dec(PL_strtab);
804 /* free the pointer table used for cloning */
805 ptr_table_free(PL_ptr_table);
806 PL_ptr_table = (PTR_TBL_t*)NULL;
809 /* free special SVs */
811 SvREFCNT(&PL_sv_yes) = 0;
812 sv_clear(&PL_sv_yes);
813 SvANY(&PL_sv_yes) = NULL;
814 SvFLAGS(&PL_sv_yes) = 0;
816 SvREFCNT(&PL_sv_no) = 0;
818 SvANY(&PL_sv_no) = NULL;
819 SvFLAGS(&PL_sv_no) = 0;
823 for (i=0; i<=2; i++) {
824 SvREFCNT(PERL_DEBUG_PAD(i)) = 0;
825 sv_clear(PERL_DEBUG_PAD(i));
826 SvANY(PERL_DEBUG_PAD(i)) = NULL;
827 SvFLAGS(PERL_DEBUG_PAD(i)) = 0;
831 if (PL_sv_count != 0 && ckWARN_d(WARN_INTERNAL))
832 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Scalars leaked: %ld\n", (long)PL_sv_count);
834 #ifdef DEBUG_LEAKING_SCALARS
835 if (PL_sv_count != 0) {
840 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
841 svend = &sva[SvREFCNT(sva)];
842 for (sv = sva + 1; sv < svend; ++sv) {
843 if (SvTYPE(sv) != SVTYPEMASK) {
844 PerlIO_printf(Perl_debug_log, "leaked: sv=0x%p"
846 " refcnt=%"UVuf pTHX__FORMAT "\n",
847 sv, sv->sv_flags, sv->sv_refcnt pTHX__VALUE);
856 #if defined(PERLIO_LAYERS)
857 /* No more IO - including error messages ! */
858 PerlIO_cleanup(aTHX);
861 /* sv_undef needs to stay immortal until after PerlIO_cleanup
862 as currently layers use it rather than Nullsv as a marker
863 for no arg - and will try and SvREFCNT_dec it.
865 SvREFCNT(&PL_sv_undef) = 0;
866 SvREADONLY_off(&PL_sv_undef);
868 Safefree(PL_origfilename);
869 PL_origfilename = Nullch;
870 Safefree(PL_reg_start_tmp);
871 PL_reg_start_tmp = (char**)NULL;
872 PL_reg_start_tmpl = 0;
874 Safefree(PL_reg_curpm);
875 Safefree(PL_reg_poscache);
877 Safefree(PL_op_mask);
878 Safefree(PL_psig_ptr);
879 PL_psig_ptr = (SV**)NULL;
880 Safefree(PL_psig_name);
881 PL_psig_name = (SV**)NULL;
882 Safefree(PL_bitcount);
883 PL_bitcount = Nullch;
884 Safefree(PL_psig_pend);
885 PL_psig_pend = (int*)NULL;
886 PL_formfeed = Nullsv;
891 PL_taint_warn = FALSE;
892 PL_hints = 0; /* Reset hints. Should hints be per-interpreter ? */
895 DEBUG_P(debprofdump());
897 #ifdef USE_REENTRANT_API
898 Perl_reentrant_free(aTHX);
903 /* As the absolutely last thing, free the non-arena SV for mess() */
906 /* it could have accumulated taint magic */
907 if (SvTYPE(PL_mess_sv) >= SVt_PVMG) {
910 for (mg = SvMAGIC(PL_mess_sv); mg; mg = moremagic) {
911 moremagic = mg->mg_moremagic;
912 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global
914 Safefree(mg->mg_ptr);
918 /* we know that type >= SVt_PV */
919 SvOOK_off(PL_mess_sv);
920 Safefree(SvPVX(PL_mess_sv));
921 Safefree(SvANY(PL_mess_sv));
922 Safefree(PL_mess_sv);
925 return STATUS_NATIVE_EXPORT;
929 =for apidoc perl_free
931 Releases a Perl interpreter. See L<perlembed>.
939 #if defined(WIN32) || defined(NETWARE)
940 # if defined(PERL_IMPLICIT_SYS)
942 void *host = nw_internal_host;
944 void *host = w32_internal_host;
948 nw_delete_internal_host(host);
950 win32_delete_internal_host(host);
961 Perl_call_atexit(pTHX_ ATEXIT_t fn, void *ptr)
963 Renew(PL_exitlist, PL_exitlistlen+1, PerlExitListEntry);
964 PL_exitlist[PL_exitlistlen].fn = fn;
965 PL_exitlist[PL_exitlistlen].ptr = ptr;
970 =for apidoc perl_parse
972 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
978 perl_parse(pTHXx_ XSINIT_t xsinit, int argc, char **argv, char **env)
983 #ifdef USE_5005THREADS
987 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
990 Perl_croak(aTHX_ "suidperl is no longer needed since the kernel can now execute\n\
991 setuid perl scripts securely.\n");
995 #if defined(USE_HASH_SEED) || defined(USE_HASH_SEED_EXPLICIT)
996 /* [perl #22371] Algorimic Complexity Attack on Perl 5.6.1, 5.8.0
997 * This MUST be done before any hash stores or fetches take place.
998 * If you set PL_rehash_seed (and assumedly also PL_rehash_seed_set)
999 * yourself, it is your responsibility to provide a good random seed!
1000 * You can also define PERL_HASH_SEED in compile time, see hv.h. */
1001 if (!PL_rehash_seed_set)
1002 PL_rehash_seed = get_hash_seed();
1004 char *s = PerlEnv_getenv("PERL_HASH_SEED_DEBUG");
1010 PerlIO_printf(Perl_debug_log, "HASH_SEED = %"UVuf"\n",
1014 #endif /* #if defined(USE_HASH_SEED) || defined(USE_HASH_SEED_EXPLICIT) */
1020 /* Set PL_origalen be the sum of the contiguous argv[]
1021 * elements plus the size of the env in case that it is
1022 * contiguous with the argv[]. This is used in mg.c:Perl_magic_set()
1023 * as the maximum modifiable length of $0. In the worst case
1024 * the area we are able to modify is limited to the size of
1025 * the original argv[0]. (See below for 'contiguous', though.)
1030 ~(UV)(PTRSIZE == 4 ? 3 : PTRSIZE == 8 ? 7 : PTRSIZE == 16 ? 15 : 0);
1031 /* Do the mask check only if the args seem like aligned. */
1033 (mask < ~(UV)0) && ((PTR2UV(argv[0]) & mask) == PTR2UV(argv[0]));
1035 /* See if all the arguments are contiguous in memory. Note
1036 * that 'contiguous' is a loose term because some platforms
1037 * align the argv[] and the envp[]. If the arguments look
1038 * like non-aligned, assume that they are 'strictly' or
1039 * 'traditionally' contiguous. If the arguments look like
1040 * aligned, we just check that they are within aligned
1041 * PTRSIZE bytes. As long as no system has something bizarre
1042 * like the argv[] interleaved with some other data, we are
1043 * fine. (Did I just evoke Murphy's Law?) --jhi */
1044 if (PL_origargv && PL_origargc >= 1 && (s = PL_origargv[0])) {
1046 for (i = 1; i < PL_origargc; i++) {
1047 if ((PL_origargv[i] == s + 1
1049 || PL_origargv[i] == s + 2
1054 (PL_origargv[i] > s &&
1056 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1066 /* Can we grab env area too to be used as the area for $0? */
1067 if (PL_origenviron) {
1068 if ((PL_origenviron[0] == s + 1
1070 || (PL_origenviron[0] == s + 9 && (s += 8))
1075 (PL_origenviron[0] > s &&
1076 PL_origenviron[0] <=
1077 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1081 s = PL_origenviron[0];
1084 my_setenv("NoNe SuCh", Nullch);
1085 /* Force copy of environment. */
1086 for (i = 1; PL_origenviron[i]; i++) {
1087 if (PL_origenviron[i] == s + 1
1090 (PL_origenviron[i] > s &&
1091 PL_origenviron[i] <=
1092 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1095 s = PL_origenviron[i];
1103 PL_origalen = s - PL_origargv[0] + 1;
1108 /* Come here if running an undumped a.out. */
1110 PL_origfilename = savepv(argv[0]);
1111 PL_do_undump = FALSE;
1112 cxstack_ix = -1; /* start label stack again */
1114 init_postdump_symbols(argc,argv,env);
1119 op_free(PL_main_root);
1120 PL_main_root = Nullop;
1122 PL_main_start = Nullop;
1123 SvREFCNT_dec(PL_main_cv);
1124 PL_main_cv = Nullcv;
1127 oldscope = PL_scopestack_ix;
1128 PL_dowarn = G_WARN_OFF;
1130 #ifdef PERL_FLEXIBLE_EXCEPTIONS
1131 CALLPROTECT(aTHX_ pcur_env, &ret, MEMBER_TO_FPTR(S_vparse_body), env, xsinit);
1137 #ifndef PERL_FLEXIBLE_EXCEPTIONS
1138 parse_body(env,xsinit);
1141 call_list(oldscope, PL_checkav);
1148 /* my_exit() was called */
1149 while (PL_scopestack_ix > oldscope)
1152 PL_curstash = PL_defstash;
1154 call_list(oldscope, PL_checkav);
1155 ret = STATUS_NATIVE_EXPORT;
1158 PerlIO_printf(Perl_error_log, "panic: top_env\n");
1166 #ifdef PERL_FLEXIBLE_EXCEPTIONS
1168 S_vparse_body(pTHX_ va_list args)
1170 char **env = va_arg(args, char**);
1171 XSINIT_t xsinit = va_arg(args, XSINIT_t);
1173 return parse_body(env, xsinit);
1178 S_parse_body(pTHX_ char **env, XSINIT_t xsinit)
1180 int argc = PL_origargc;
1181 char **argv = PL_origargv;
1182 char *scriptname = NULL;
1183 VOL bool dosearch = FALSE;
1184 char *validarg = "";
1187 char *cddir = Nullch;
1191 sv_setpvn(PL_linestr,"",0);
1192 sv = newSVpvn("",0); /* first used for -I flags */
1196 for (argc--,argv++; argc > 0; argc--,argv++) {
1197 if (argv[0][0] != '-' || !argv[0][1])
1201 validarg = " PHOOEY ";
1205 * Can we rely on the kernel to start scripts with argv[1] set to
1206 * contain all #! line switches (the whole line)? (argv[0] is set to
1207 * the interpreter name, argv[2] to the script name; argv[3] and
1208 * above may contain other arguments.)
1215 #ifndef PERL_STRICT_CR
1240 if ((s = moreswitches(s)))
1245 CHECK_MALLOC_TOO_LATE_FOR('t');
1246 if( !PL_tainting ) {
1247 PL_taint_warn = TRUE;
1253 CHECK_MALLOC_TOO_LATE_FOR('T');
1255 PL_taint_warn = FALSE;
1260 #ifdef MACOS_TRADITIONAL
1261 /* ignore -e for Dev:Pseudo argument */
1262 if (argv[1] && !strcmp(argv[1], "Dev:Pseudo"))
1267 PL_e_script = newSVpvn("",0);
1268 filter_add(read_e_script, NULL);
1271 sv_catpv(PL_e_script, s);
1273 sv_catpv(PL_e_script, argv[1]);
1277 Perl_croak(aTHX_ "No code specified for -e");
1278 sv_catpv(PL_e_script, "\n");
1281 case 'I': /* -I handled both here and in moreswitches() */
1283 if (!*++s && (s=argv[1]) != Nullch) {
1288 STRLEN len = strlen(s);
1289 p = savepvn(s, len);
1290 incpush(p, TRUE, TRUE, FALSE);
1291 sv_catpvn(sv, "-I", 2);
1292 sv_catpvn(sv, p, len);
1293 sv_catpvn(sv, " ", 1);
1297 Perl_croak(aTHX_ "No directory specified for -I");
1301 PL_preprocess = TRUE;
1311 PL_preambleav = newAV();
1312 av_push(PL_preambleav, newSVpv("use Config qw(myconfig config_vars)",0));
1314 PL_Sv = newSVpv("print myconfig();",0);
1316 sv_catpv(PL_Sv,"print \"\\nCharacteristics of this PERLSHR image: \\n\",");
1318 sv_catpv(PL_Sv,"print \"\\nCharacteristics of this binary (from libperl): \\n\",");
1320 sv_catpv(PL_Sv,"\" Compile-time options:");
1322 sv_catpv(PL_Sv," DEBUGGING");
1324 # ifdef MULTIPLICITY
1325 sv_catpv(PL_Sv," MULTIPLICITY");
1327 # ifdef USE_5005THREADS
1328 sv_catpv(PL_Sv," USE_5005THREADS");
1330 # ifdef USE_ITHREADS
1331 sv_catpv(PL_Sv," USE_ITHREADS");
1333 # ifdef USE_64_BIT_INT
1334 sv_catpv(PL_Sv," USE_64_BIT_INT");
1336 # ifdef USE_64_BIT_ALL
1337 sv_catpv(PL_Sv," USE_64_BIT_ALL");
1339 # ifdef USE_LONG_DOUBLE
1340 sv_catpv(PL_Sv," USE_LONG_DOUBLE");
1342 # ifdef USE_LARGE_FILES
1343 sv_catpv(PL_Sv," USE_LARGE_FILES");
1346 sv_catpv(PL_Sv," USE_SOCKS");
1348 # ifdef PERL_IMPLICIT_CONTEXT
1349 sv_catpv(PL_Sv," PERL_IMPLICIT_CONTEXT");
1351 # ifdef PERL_IMPLICIT_SYS
1352 sv_catpv(PL_Sv," PERL_IMPLICIT_SYS");
1354 sv_catpv(PL_Sv,"\\n\",");
1356 #if defined(LOCAL_PATCH_COUNT)
1357 if (LOCAL_PATCH_COUNT > 0) {
1359 sv_catpv(PL_Sv,"\" Locally applied patches:\\n\",");
1360 for (i = 1; i <= LOCAL_PATCH_COUNT; i++) {
1361 if (PL_localpatches[i])
1362 Perl_sv_catpvf(aTHX_ PL_Sv,"q%c\t%s\n%c,",
1363 0, PL_localpatches[i], 0);
1367 Perl_sv_catpvf(aTHX_ PL_Sv,"\" Built under %s\\n\"",OSNAME);
1370 Perl_sv_catpvf(aTHX_ PL_Sv,",\" Compiled at %s %s\\n\"",__DATE__,__TIME__);
1372 Perl_sv_catpvf(aTHX_ PL_Sv,",\" Compiled on %s\\n\"",__DATE__);
1375 sv_catpv(PL_Sv, "; \
1377 @env = map { \"$_=\\\"$ENV{$_}\\\"\" } sort grep {/^PERL/} keys %ENV; ");
1380 push @env, \"CYGWIN=\\\"$ENV{CYGWIN}\\\"\";");
1383 print \" \\%ENV:\\n @env\\n\" if @env; \
1384 print \" \\@INC:\\n @INC\\n\";");
1387 PL_Sv = newSVpv("config_vars(qw(",0);
1388 sv_catpv(PL_Sv, ++s);
1389 sv_catpv(PL_Sv, "))");
1392 av_push(PL_preambleav, PL_Sv);
1393 scriptname = BIT_BUCKET; /* don't look for script or read stdin */
1396 PL_doextract = TRUE;
1404 if (!*++s || isSPACE(*s)) {
1408 /* catch use of gnu style long options */
1409 if (strEQ(s, "version")) {
1413 if (strEQ(s, "help")) {
1420 Perl_croak(aTHX_ "Unrecognized switch: -%s (-h will show valid options)",s);
1426 #ifndef SECURE_INTERNAL_GETENV
1429 (s = PerlEnv_getenv("PERL5OPT")))
1434 if (*s == '-' && *(s+1) == 'T') {
1435 CHECK_MALLOC_TOO_LATE_FOR('T');
1437 PL_taint_warn = FALSE;
1440 char *popt_copy = Nullch;
1453 if (!strchr("DIMUdmtwA", *s))
1454 Perl_croak(aTHX_ "Illegal switch in PERL5OPT: -%c", *s);
1458 popt_copy = SvPVX(sv_2mortal(newSVpv(popt,0)));
1459 s = popt_copy + (s - popt);
1460 d = popt_copy + (d - popt);
1467 if( !PL_tainting ) {
1468 PL_taint_warn = TRUE;
1478 if (PL_taint_warn && PL_dowarn != G_WARN_ALL_OFF) {
1479 PL_compiling.cop_warnings = newSVpvn(WARN_TAINTstring, WARNsize);
1483 scriptname = argv[0];
1486 scriptname = BIT_BUCKET; /* don't look for script or read stdin */
1488 else if (scriptname == Nullch) {
1490 if ( PerlLIO_isatty(PerlIO_fileno(PerlIO_stdin())) )
1498 open_script(scriptname,dosearch,sv);
1500 validate_suid(validarg, scriptname);
1503 #if defined(SIGCHLD) || defined(SIGCLD)
1506 # define SIGCHLD SIGCLD
1508 Sighandler_t sigstate = rsignal_state(SIGCHLD);
1509 if (sigstate == SIG_IGN) {
1510 if (ckWARN(WARN_SIGNAL))
1511 Perl_warner(aTHX_ packWARN(WARN_SIGNAL),
1512 "Can't ignore signal CHLD, forcing to default");
1513 (void)rsignal(SIGCHLD, (Sighandler_t)SIG_DFL);
1519 #ifdef MACOS_TRADITIONAL
1520 if (PL_doextract || gMacPerl_AlwaysExtract) {
1525 if (cddir && PerlDir_chdir(cddir) < 0)
1526 Perl_croak(aTHX_ "Can't chdir to %s",cddir);
1530 PL_main_cv = PL_compcv = (CV*)NEWSV(1104,0);
1531 sv_upgrade((SV *)PL_compcv, SVt_PVCV);
1532 CvUNIQUE_on(PL_compcv);
1534 CvPADLIST(PL_compcv) = pad_new(0);
1535 #ifdef USE_5005THREADS
1536 CvOWNER(PL_compcv) = 0;
1537 New(666, CvMUTEXP(PL_compcv), 1, perl_mutex);
1538 MUTEX_INIT(CvMUTEXP(PL_compcv));
1539 #endif /* USE_5005THREADS */
1542 boot_core_UNIVERSAL();
1543 boot_core_xsutils();
1546 (*xsinit)(aTHX); /* in case linked C routines want magical variables */
1548 #if defined(VMS) || defined(WIN32) || defined(DJGPP) || defined(__CYGWIN__) || defined(EPOC)
1554 # ifdef HAS_SOCKS5_INIT
1555 socks5_init(argv[0]);
1561 init_predump_symbols();
1562 /* init_postdump_symbols not currently designed to be called */
1563 /* more than once (ENV isn't cleared first, for example) */
1564 /* But running with -u leaves %ENV & @ARGV undefined! XXX */
1566 init_postdump_symbols(argc,argv,env);
1568 /* PL_unicode is turned on by -C or by $ENV{PERL_UNICODE}.
1569 * PL_utf8locale is conditionally turned on by
1570 * locale.c:Perl_init_i18nl10n() if the environment
1571 * look like the user wants to use UTF-8. */
1573 /* Requires init_predump_symbols(). */
1574 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
1579 /* Turn on UTF-8-ness on STDIN, STDOUT, STDERR
1580 * and the default open disciplines. */
1581 if ((PL_unicode & PERL_UNICODE_STDIN_FLAG) &&
1582 PL_stdingv && (io = GvIO(PL_stdingv)) &&
1584 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
1585 if ((PL_unicode & PERL_UNICODE_STDOUT_FLAG) &&
1586 PL_defoutgv && (io = GvIO(PL_defoutgv)) &&
1588 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
1589 if ((PL_unicode & PERL_UNICODE_STDERR_FLAG) &&
1590 PL_stderrgv && (io = GvIO(PL_stderrgv)) &&
1592 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
1593 if ((PL_unicode & PERL_UNICODE_INOUT_FLAG) &&
1594 (sv = GvSV(gv_fetchpv("\017PEN", TRUE, SVt_PV)))) {
1595 U32 in = PL_unicode & PERL_UNICODE_IN_FLAG;
1596 U32 out = PL_unicode & PERL_UNICODE_OUT_FLAG;
1599 sv_setpvn(sv, ":utf8\0:utf8", 11);
1601 sv_setpvn(sv, ":utf8\0", 6);
1604 sv_setpvn(sv, "\0:utf8", 6);
1610 if ((s = PerlEnv_getenv("PERL_SIGNALS"))) {
1611 if (strEQ(s, "unsafe"))
1612 PL_signals |= PERL_SIGNALS_UNSAFE_FLAG;
1613 else if (strEQ(s, "safe"))
1614 PL_signals &= ~PERL_SIGNALS_UNSAFE_FLAG;
1616 Perl_croak(aTHX_ "PERL_SIGNALS illegal: \"%s\"", s);
1621 /* now parse the script */
1623 SETERRNO(0,SS_NORMAL);
1625 #ifdef MACOS_TRADITIONAL
1626 if (gMacPerl_SyntaxError = (yyparse() || PL_error_count)) {
1628 Perl_croak(aTHX_ "%s had compilation errors.\n", MacPerl_MPWFileName(PL_origfilename));
1630 Perl_croak(aTHX_ "Execution of %s aborted due to compilation errors.\n",
1631 MacPerl_MPWFileName(PL_origfilename));
1635 if (yyparse() || PL_error_count) {
1637 Perl_croak(aTHX_ "%s had compilation errors.\n", PL_origfilename);
1639 Perl_croak(aTHX_ "Execution of %s aborted due to compilation errors.\n",
1644 CopLINE_set(PL_curcop, 0);
1645 PL_curstash = PL_defstash;
1646 PL_preprocess = FALSE;
1648 SvREFCNT_dec(PL_e_script);
1649 PL_e_script = Nullsv;
1656 SAVECOPFILE(PL_curcop);
1657 SAVECOPLINE(PL_curcop);
1658 gv_check(PL_defstash);
1665 if ((s=PerlEnv_getenv("PERL_DEBUG_MSTATS")) && atoi(s) >= 2)
1666 dump_mstats("after compilation:");
1675 =for apidoc perl_run
1677 Tells a Perl interpreter to run. See L<perlembed>.
1688 #ifdef USE_5005THREADS
1692 oldscope = PL_scopestack_ix;
1697 #ifdef PERL_FLEXIBLE_EXCEPTIONS
1699 CALLPROTECT(aTHX_ pcur_env, &ret, MEMBER_TO_FPTR(S_vrun_body), oldscope);
1705 cxstack_ix = -1; /* start context stack again */
1707 case 0: /* normal completion */
1708 #ifndef PERL_FLEXIBLE_EXCEPTIONS
1713 case 2: /* my_exit() */
1714 while (PL_scopestack_ix > oldscope)
1717 PL_curstash = PL_defstash;
1718 if (!(PL_exit_flags & PERL_EXIT_DESTRUCT_END) &&
1719 PL_endav && !PL_minus_c)
1720 call_list(oldscope, PL_endav);
1722 if (PerlEnv_getenv("PERL_DEBUG_MSTATS"))
1723 dump_mstats("after execution: ");
1725 ret = STATUS_NATIVE_EXPORT;
1729 POPSTACK_TO(PL_mainstack);
1732 PerlIO_printf(Perl_error_log, "panic: restartop\n");
1742 #ifdef PERL_FLEXIBLE_EXCEPTIONS
1744 S_vrun_body(pTHX_ va_list args)
1746 I32 oldscope = va_arg(args, I32);
1748 return run_body(oldscope);
1754 S_run_body(pTHX_ I32 oldscope)
1756 DEBUG_r(PerlIO_printf(Perl_debug_log, "%s $` $& $' support.\n",
1757 PL_sawampersand ? "Enabling" : "Omitting"));
1759 if (!PL_restartop) {
1760 DEBUG_x(dump_all());
1762 PERL_DEBUG(PerlIO_printf(Perl_debug_log, "\nEXECUTING...\n\n"));
1763 DEBUG_S(PerlIO_printf(Perl_debug_log, "main thread is 0x%"UVxf"\n",
1767 #ifdef MACOS_TRADITIONAL
1768 PerlIO_printf(Perl_error_log, "%s%s syntax OK\n",
1769 (gMacPerl_ErrorFormat ? "# " : ""),
1770 MacPerl_MPWFileName(PL_origfilename));
1772 PerlIO_printf(Perl_error_log, "%s syntax OK\n", PL_origfilename);
1776 if (PERLDB_SINGLE && PL_DBsingle)
1777 sv_setiv(PL_DBsingle, 1);
1779 call_list(oldscope, PL_initav);
1785 PL_op = PL_restartop;
1789 else if (PL_main_start) {
1790 CvDEPTH(PL_main_cv) = 1;
1791 PL_op = PL_main_start;
1801 =head1 SV Manipulation Functions
1803 =for apidoc p||get_sv
1805 Returns the SV of the specified Perl scalar. If C<create> is set and the
1806 Perl variable does not exist then it will be created. If C<create> is not
1807 set and the variable does not exist then NULL is returned.
1813 Perl_get_sv(pTHX_ const char *name, I32 create)
1816 #ifdef USE_5005THREADS
1817 if (name[1] == '\0' && !isALPHA(name[0])) {
1818 PADOFFSET tmp = find_threadsv(name);
1819 if (tmp != NOT_IN_PAD)
1820 return THREADSV(tmp);
1822 #endif /* USE_5005THREADS */
1823 gv = gv_fetchpv(name, create, SVt_PV);
1830 =head1 Array Manipulation Functions
1832 =for apidoc p||get_av
1834 Returns the AV of the specified Perl array. If C<create> is set and the
1835 Perl variable does not exist then it will be created. If C<create> is not
1836 set and the variable does not exist then NULL is returned.
1842 Perl_get_av(pTHX_ const char *name, I32 create)
1844 GV* gv = gv_fetchpv(name, create, SVt_PVAV);
1853 =head1 Hash Manipulation Functions
1855 =for apidoc p||get_hv
1857 Returns the HV of the specified Perl hash. If C<create> is set and the
1858 Perl variable does not exist then it will be created. If C<create> is not
1859 set and the variable does not exist then NULL is returned.
1865 Perl_get_hv(pTHX_ const char *name, I32 create)
1867 GV* gv = gv_fetchpv(name, create, SVt_PVHV);
1876 =head1 CV Manipulation Functions
1878 =for apidoc p||get_cv
1880 Returns the CV of the specified Perl subroutine. If C<create> is set and
1881 the Perl subroutine does not exist then it will be declared (which has the
1882 same effect as saying C<sub name;>). If C<create> is not set and the
1883 subroutine does not exist then NULL is returned.
1889 Perl_get_cv(pTHX_ const char *name, I32 create)
1891 GV* gv = gv_fetchpv(name, create, SVt_PVCV);
1892 /* XXX unsafe for threads if eval_owner isn't held */
1893 /* XXX this is probably not what they think they're getting.
1894 * It has the same effect as "sub name;", i.e. just a forward
1896 if (create && !GvCVu(gv))
1897 return newSUB(start_subparse(FALSE, 0),
1898 newSVOP(OP_CONST, 0, newSVpv(name,0)),
1906 /* Be sure to refetch the stack pointer after calling these routines. */
1910 =head1 Callback Functions
1912 =for apidoc p||call_argv
1914 Performs a callback to the specified Perl sub. See L<perlcall>.
1920 Perl_call_argv(pTHX_ const char *sub_name, I32 flags, register char **argv)
1922 /* See G_* flags in cop.h */
1923 /* null terminated arg list */
1930 XPUSHs(sv_2mortal(newSVpv(*argv,0)));
1935 return call_pv(sub_name, flags);
1939 =for apidoc p||call_pv
1941 Performs a callback to the specified Perl sub. See L<perlcall>.
1947 Perl_call_pv(pTHX_ const char *sub_name, I32 flags)
1948 /* name of the subroutine */
1949 /* See G_* flags in cop.h */
1951 return call_sv((SV*)get_cv(sub_name, TRUE), flags);
1955 =for apidoc p||call_method
1957 Performs a callback to the specified Perl method. The blessed object must
1958 be on the stack. See L<perlcall>.
1964 Perl_call_method(pTHX_ const char *methname, I32 flags)
1965 /* name of the subroutine */
1966 /* See G_* flags in cop.h */
1968 return call_sv(sv_2mortal(newSVpv(methname,0)), flags | G_METHOD);
1971 /* May be called with any of a CV, a GV, or an SV containing the name. */
1973 =for apidoc p||call_sv
1975 Performs a callback to the Perl sub whose name is in the SV. See
1982 Perl_call_sv(pTHX_ SV *sv, I32 flags)
1983 /* See G_* flags in cop.h */
1986 LOGOP myop; /* fake syntax tree node */
1989 volatile I32 retval = 0;
1991 bool oldcatch = CATCH_GET;
1996 if (flags & G_DISCARD) {
2001 Zero(&myop, 1, LOGOP);
2002 myop.op_next = Nullop;
2003 if (!(flags & G_NOARGS))
2004 myop.op_flags |= OPf_STACKED;
2005 myop.op_flags |= ((flags & G_VOID) ? OPf_WANT_VOID :
2006 (flags & G_ARRAY) ? OPf_WANT_LIST :
2011 EXTEND(PL_stack_sp, 1);
2012 *++PL_stack_sp = sv;
2014 oldscope = PL_scopestack_ix;
2016 if (PERLDB_SUB && PL_curstash != PL_debstash
2017 /* Handle first BEGIN of -d. */
2018 && (PL_DBcv || (PL_DBcv = GvCV(PL_DBsub)))
2019 /* Try harder, since this may have been a sighandler, thus
2020 * curstash may be meaningless. */
2021 && (SvTYPE(sv) != SVt_PVCV || CvSTASH((CV*)sv) != PL_debstash)
2022 && !(flags & G_NODEBUG))
2023 PL_op->op_private |= OPpENTERSUB_DB;
2025 if (flags & G_METHOD) {
2026 Zero(&method_op, 1, UNOP);
2027 method_op.op_next = PL_op;
2028 method_op.op_ppaddr = PL_ppaddr[OP_METHOD];
2029 myop.op_ppaddr = PL_ppaddr[OP_ENTERSUB];
2030 PL_op = (OP*)&method_op;
2033 if (!(flags & G_EVAL)) {
2035 call_body((OP*)&myop, FALSE);
2036 retval = PL_stack_sp - (PL_stack_base + oldmark);
2037 CATCH_SET(oldcatch);
2040 myop.op_other = (OP*)&myop;
2042 /* we're trying to emulate pp_entertry() here */
2044 register PERL_CONTEXT *cx;
2045 I32 gimme = GIMME_V;
2050 PUSHBLOCK(cx, (CXt_EVAL|CXp_TRYBLOCK), PL_stack_sp);
2052 PL_eval_root = PL_op; /* Only needed so that goto works right. */
2054 PL_in_eval = EVAL_INEVAL;
2055 if (flags & G_KEEPERR)
2056 PL_in_eval |= EVAL_KEEPERR;
2062 #ifdef PERL_FLEXIBLE_EXCEPTIONS
2064 CALLPROTECT(aTHX_ pcur_env, &ret, MEMBER_TO_FPTR(S_vcall_body),
2071 #ifndef PERL_FLEXIBLE_EXCEPTIONS
2073 call_body((OP*)&myop, FALSE);
2075 retval = PL_stack_sp - (PL_stack_base + oldmark);
2076 if (!(flags & G_KEEPERR))
2083 /* my_exit() was called */
2084 PL_curstash = PL_defstash;
2087 if (PL_statusvalue && !(PL_exit_flags & PERL_EXIT_EXPECTED))
2088 Perl_croak(aTHX_ "Callback called exit");
2093 PL_op = PL_restartop;
2097 PL_stack_sp = PL_stack_base + oldmark;
2098 if (flags & G_ARRAY)
2102 *++PL_stack_sp = &PL_sv_undef;
2107 if (PL_scopestack_ix > oldscope) {
2111 register PERL_CONTEXT *cx;
2122 if (flags & G_DISCARD) {
2123 PL_stack_sp = PL_stack_base + oldmark;
2132 #ifdef PERL_FLEXIBLE_EXCEPTIONS
2134 S_vcall_body(pTHX_ va_list args)
2136 OP *myop = va_arg(args, OP*);
2137 int is_eval = va_arg(args, int);
2139 call_body(myop, is_eval);
2145 S_call_body(pTHX_ OP *myop, int is_eval)
2147 if (PL_op == myop) {
2149 PL_op = Perl_pp_entereval(aTHX); /* this doesn't do a POPMARK */
2151 PL_op = Perl_pp_entersub(aTHX); /* this does */
2157 /* Eval a string. The G_EVAL flag is always assumed. */
2160 =for apidoc p||eval_sv
2162 Tells Perl to C<eval> the string in the SV.
2168 Perl_eval_sv(pTHX_ SV *sv, I32 flags)
2170 /* See G_* flags in cop.h */
2173 UNOP myop; /* fake syntax tree node */
2174 volatile I32 oldmark = SP - PL_stack_base;
2175 volatile I32 retval = 0;
2181 if (flags & G_DISCARD) {
2188 Zero(PL_op, 1, UNOP);
2189 EXTEND(PL_stack_sp, 1);
2190 *++PL_stack_sp = sv;
2191 oldscope = PL_scopestack_ix;
2193 if (!(flags & G_NOARGS))
2194 myop.op_flags = OPf_STACKED;
2195 myop.op_next = Nullop;
2196 myop.op_type = OP_ENTEREVAL;
2197 myop.op_flags |= ((flags & G_VOID) ? OPf_WANT_VOID :
2198 (flags & G_ARRAY) ? OPf_WANT_LIST :
2200 if (flags & G_KEEPERR)
2201 myop.op_flags |= OPf_SPECIAL;
2203 #ifdef PERL_FLEXIBLE_EXCEPTIONS
2205 CALLPROTECT(aTHX_ pcur_env, &ret, MEMBER_TO_FPTR(S_vcall_body),
2208 /* fail now; otherwise we could fail after the JMPENV_PUSH but
2209 * before a PUSHEVAL, which corrupts the stack after a croak */
2210 TAINT_PROPER("eval_sv()");
2216 #ifndef PERL_FLEXIBLE_EXCEPTIONS
2218 call_body((OP*)&myop,TRUE);
2220 retval = PL_stack_sp - (PL_stack_base + oldmark);
2221 if (!(flags & G_KEEPERR))
2228 /* my_exit() was called */
2229 PL_curstash = PL_defstash;
2232 if (PL_statusvalue && !(PL_exit_flags & PERL_EXIT_EXPECTED))
2233 Perl_croak(aTHX_ "Callback called exit");
2238 PL_op = PL_restartop;
2242 PL_stack_sp = PL_stack_base + oldmark;
2243 if (flags & G_ARRAY)
2247 *++PL_stack_sp = &PL_sv_undef;
2253 if (flags & G_DISCARD) {
2254 PL_stack_sp = PL_stack_base + oldmark;
2264 =for apidoc p||eval_pv
2266 Tells Perl to C<eval> the given string and return an SV* result.
2272 Perl_eval_pv(pTHX_ const char *p, I32 croak_on_error)
2275 SV* sv = newSVpv(p, 0);
2277 eval_sv(sv, G_SCALAR);
2284 if (croak_on_error && SvTRUE(ERRSV)) {
2286 Perl_croak(aTHX_ SvPVx(ERRSV, n_a));
2292 /* Require a module. */
2295 =head1 Embedding Functions
2297 =for apidoc p||require_pv
2299 Tells Perl to C<require> the file named by the string argument. It is
2300 analogous to the Perl code C<eval "require '$file'">. It's even
2301 implemented that way; consider using load_module instead.
2306 Perl_require_pv(pTHX_ const char *pv)
2310 PUSHSTACKi(PERLSI_REQUIRE);
2312 sv = sv_newmortal();
2313 sv_setpv(sv, "require '");
2316 eval_sv(sv, G_DISCARD);
2322 Perl_magicname(pTHX_ char *sym, char *name, I32 namlen)
2326 if ((gv = gv_fetchpv(sym,TRUE, SVt_PV)))
2327 sv_magic(GvSV(gv), (SV*)gv, PERL_MAGIC_sv, name, namlen);
2331 S_usage(pTHX_ char *name) /* XXX move this out into a module ? */
2333 /* This message really ought to be max 23 lines.
2334 * Removed -h because the user already knows that option. Others? */
2336 static char *usage_msg[] = {
2337 "-0[octal] specify record separator (\\0, if no argument)",
2338 "-a autosplit mode with -n or -p (splits $_ into @F)",
2339 "-C[number/list] enables the listed Unicode features",
2340 "-c check syntax only (runs BEGIN and CHECK blocks)",
2341 "-d[:debugger] run program under debugger",
2342 "-D[number/list] set debugging flags (argument is a bit mask or alphabets)",
2343 "-e program one line of program (several -e's allowed, omit programfile)",
2344 "-F/pattern/ split() pattern for -a switch (//'s are optional)",
2345 "-i[extension] edit <> files in place (makes backup if extension supplied)",
2346 "-Idirectory specify @INC/#include directory (several -I's allowed)",
2347 "-l[octal] enable line ending processing, specifies line terminator",
2348 "-[mM][-]module execute `use/no module...' before executing program",
2349 "-n assume 'while (<>) { ... }' loop around program",
2350 "-p assume loop like -n but print line also, like sed",
2351 "-P run program through C preprocessor before compilation",
2352 "-s enable rudimentary parsing for switches after programfile",
2353 "-S look for programfile using PATH environment variable",
2354 "-t enable tainting warnings",
2355 "-T enable tainting checks",
2356 "-u dump core after parsing program",
2357 "-U allow unsafe operations",
2358 "-v print version, subversion (includes VERY IMPORTANT perl info)",
2359 "-V[:variable] print configuration summary (or a single Config.pm variable)",
2360 "-w enable many useful warnings (RECOMMENDED)",
2361 "-W enable all warnings",
2362 "-x[directory] strip off text before #!perl line and perhaps cd to directory",
2363 "-X disable all warnings",
2367 char **p = usage_msg;
2369 PerlIO_printf(PerlIO_stdout(),
2370 "\nUsage: %s [switches] [--] [programfile] [arguments]",
2373 PerlIO_printf(PerlIO_stdout(), "\n %s", *p++);
2376 /* convert a string of -D options (or digits) into an int.
2377 * sets *s to point to the char after the options */
2381 Perl_get_debug_opts(pTHX_ char **s, bool givehelp)
2383 static char *usage_msgd[] = {
2384 " Debugging flag values: (see also -d)",
2385 " p Tokenizing and parsing (with v, displays parse stack)",
2386 " s Stack snapshots (with v, displays all stacks)",
2387 " l Context (loop) stack processing",
2388 " t Trace execution",
2389 " o Method and overloading resolution",
2390 " c String/numeric conversions",
2391 " P Print profiling info, preprocessor command for -P, source file input state",
2392 " m Memory allocation",
2393 " f Format processing",
2394 " r Regular expression parsing and execution",
2395 " x Syntax tree dump",
2396 " u Tainting checks",
2397 " H Hash dump -- usurps values()",
2398 " X Scratchpad allocation",
2400 " S Thread synchronization",
2402 " R Include reference counts of dumped variables (eg when using -Ds)",
2403 " J Do not s,t,P-debug (Jump over) opcodes within package DB",
2404 " v Verbose: use in conjunction with other flags",
2406 " A Consistency checks on internal structures",
2407 " q quiet - currently only suppresses the 'EXECUTING' message",
2412 /* if adding extra options, remember to update DEBUG_MASK */
2413 static char debopts[] = "psltocPmfrxu HXDSTRJvCAq";
2415 for (; isALNUM(**s); (*s)++) {
2416 char *d = strchr(debopts,**s);
2418 i |= 1 << (d - debopts);
2419 else if (ckWARN_d(WARN_DEBUGGING))
2420 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
2421 "invalid option -D%c, use -D'' to see choices\n", **s);
2424 else if (isDIGIT(**s)) {
2426 for (; isALNUM(**s); (*s)++) ;
2428 else if (givehelp) {
2429 char **p = usage_msgd;
2430 while (*p) PerlIO_printf(PerlIO_stdout(), "%s\n", *p++);
2433 if ((i & DEBUG_p_FLAG) && ckWARN_d(WARN_DEBUGGING))
2434 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
2435 "-Dp not implemented on this platform\n");
2441 /* This routine handles any switches that can be given during run */
2444 Perl_moreswitches(pTHX_ char *s)
2454 SvREFCNT_dec(PL_rs);
2455 if (s[1] == 'x' && s[2]) {
2459 for (s += 2, e = s; *e; e++);
2461 flags = PERL_SCAN_SILENT_ILLDIGIT;
2462 rschar = (U32)grok_hex(s, &numlen, &flags, NULL);
2463 if (s + numlen < e) {
2464 rschar = 0; /* Grandfather -0xFOO as -0 -xFOO. */
2468 PL_rs = newSVpvn("", 0);
2469 SvGROW(PL_rs, (STRLEN)(UNISKIP(rschar) + 1));
2470 tmps = (U8*)SvPVX(PL_rs);
2471 uvchr_to_utf8(tmps, rschar);
2472 SvCUR_set(PL_rs, UNISKIP(rschar));
2477 rschar = (U32)grok_oct(s, &numlen, &flags, NULL);
2478 if (rschar & ~((U8)~0))
2479 PL_rs = &PL_sv_undef;
2480 else if (!rschar && numlen >= 2)
2481 PL_rs = newSVpvn("", 0);
2483 char ch = (char)rschar;
2484 PL_rs = newSVpvn(&ch, 1);
2487 sv_setsv(get_sv("/", TRUE), PL_rs);
2492 PL_unicode = parse_unicode_opts(&s);
2497 while (*s && !isSPACE(*s)) ++s;
2499 PL_splitstr = savepv(PL_splitstr);
2513 /* -dt indicates to the debugger that threads will be used */
2514 if (*s == 't' && !isALNUM(s[1])) {
2516 my_setenv("PERL5DB_THREADED", "1");
2519 /* The following permits -d:Mod to accepts arguments following an =
2520 in the fashion that -MSome::Mod does. */
2521 if (*s == ':' || *s == '=') {
2524 sv = newSVpv("use Devel::", 0);
2526 /* We now allow -d:Module=Foo,Bar */
2527 while(isALNUM(*s) || *s==':') ++s;
2529 sv_catpv(sv, start);
2531 sv_catpvn(sv, start, s-start);
2532 sv_catpv(sv, " split(/,/,q{");
2537 my_setenv("PERL5DB", SvPV(sv, PL_na));
2540 PL_perldb = PERLDB_ALL;
2549 PL_debug = get_debug_opts(&s, 1) | DEBUG_TOP_FLAG;
2550 #else /* !DEBUGGING */
2551 if (ckWARN_d(WARN_DEBUGGING))
2552 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
2553 "Recompile perl with -DDEBUGGING to use -D switch (did you mean -d ?)\n");
2554 for (s++; isALNUM(*s); s++) ;
2560 usage(PL_origargv[0]);
2564 Safefree(PL_inplace);
2565 #if defined(__CYGWIN__) /* do backup extension automagically */
2566 if (*(s+1) == '\0') {
2567 PL_inplace = savepv(".bak");
2570 #endif /* __CYGWIN__ */
2571 PL_inplace = savepv(s+1);
2573 for (s = PL_inplace; *s && !isSPACE(*s); s++) ;
2576 if (*s == '-') /* Additional switches on #! line. */
2580 case 'I': /* -I handled both here and in parse_body() */
2583 while (*s && isSPACE(*s))
2588 /* ignore trailing spaces (possibly followed by other switches) */
2590 for (e = p; *e && !isSPACE(*e); e++) ;
2594 } while (*p && *p != '-');
2595 e = savepvn(s, e-s);
2596 incpush(e, TRUE, TRUE, FALSE);
2603 Perl_croak(aTHX_ "No directory specified for -I");
2609 SvREFCNT_dec(PL_ors_sv);
2614 PL_ors_sv = newSVpvn("\n",1);
2615 numlen = 3 + (*s == '0');
2616 *SvPVX(PL_ors_sv) = (char)grok_oct(s, &numlen, &flags, NULL);
2620 if (RsPARA(PL_rs)) {
2621 PL_ors_sv = newSVpvn("\n\n",2);
2624 PL_ors_sv = newSVsv(PL_rs);
2631 PL_preambleav = newAV();
2633 SV *sv = newSVpv("use assertions::activate split(/,/,q", 0);
2634 sv_catpvn(sv, "\0", 1); /* Use NUL as q//-delimiter. */
2636 sv_catpvn(sv, "\0)", 2);
2638 av_push(PL_preambleav, sv);
2641 av_push(PL_preambleav, newSVpvn("use assertions::activate",24));
2644 forbid_setid("-M"); /* XXX ? */
2647 forbid_setid("-m"); /* XXX ? */
2652 /* -M-foo == 'no foo' */
2653 if (*s == '-') { use = "no "; ++s; }
2654 sv = newSVpv(use,0);
2656 /* We allow -M'Module qw(Foo Bar)' */
2657 while(isALNUM(*s) || *s==':') ++s;
2659 sv_catpv(sv, start);
2660 if (*(start-1) == 'm') {
2662 Perl_croak(aTHX_ "Can't use '%c' after -mname", *s);
2663 sv_catpv( sv, " ()");
2667 Perl_croak(aTHX_ "Module name required with -%c option",
2669 sv_catpvn(sv, start, s-start);
2670 sv_catpv(sv, " split(/,/,q");
2671 sv_catpvn(sv, "\0)", 1); /* Use NUL as q//-delimiter. */
2673 sv_catpvn(sv, "\0)", 2);
2677 PL_preambleav = newAV();
2678 av_push(PL_preambleav, sv);
2681 Perl_croak(aTHX_ "Missing argument to -%c", *(s-1));
2693 PL_doswitches = TRUE;
2707 #ifdef MACOS_TRADITIONAL
2708 Perl_croak(aTHX_ "Believe me, you don't want to use \"-u\" on a Macintosh");
2710 PL_do_undump = TRUE;
2718 if (!sv_derived_from(PL_patchlevel, "version"))
2719 (void *)upg_version(PL_patchlevel);
2721 PerlIO_printf(PerlIO_stdout(),
2722 Perl_form(aTHX_ "\nThis is perl, v%_ built for %s",
2723 vstringify(PL_patchlevel),
2726 /* Adjust verbose output as in the perl that ships with the DG/UX OS from EMC */
2727 PerlIO_printf(PerlIO_stdout(),
2728 Perl_form(aTHX_ "\nThis is perl, v%_\n",
2729 vstringify(PL_patchlevel)));
2730 PerlIO_printf(PerlIO_stdout(),
2731 Perl_form(aTHX_ " built under %s at %s %s\n",
2732 OSNAME, __DATE__, __TIME__));
2733 PerlIO_printf(PerlIO_stdout(),
2734 Perl_form(aTHX_ " OS Specific Release: %s\n",
2738 #if defined(LOCAL_PATCH_COUNT)
2739 if (LOCAL_PATCH_COUNT > 0)
2740 PerlIO_printf(PerlIO_stdout(),
2741 "\n(with %d registered patch%s, "
2742 "see perl -V for more detail)",
2743 (int)LOCAL_PATCH_COUNT,
2744 (LOCAL_PATCH_COUNT!=1) ? "es" : "");
2747 PerlIO_printf(PerlIO_stdout(),
2748 "\n\nCopyright 1987-2004, Larry Wall\n");
2749 #ifdef MACOS_TRADITIONAL
2750 PerlIO_printf(PerlIO_stdout(),
2751 "\nMac OS port Copyright 1991-2002, Matthias Neeracher;\n"
2752 "maintained by Chris Nandor\n");
2755 PerlIO_printf(PerlIO_stdout(),
2756 "\nMS-DOS port Copyright (c) 1989, 1990, Diomidis Spinellis\n");
2759 PerlIO_printf(PerlIO_stdout(),
2760 "djgpp v2 port (jpl5003c) by Hirofumi Watanabe, 1996\n"
2761 "djgpp v2 port (perl5004+) by Laszlo Molnar, 1997-1999\n");
2764 PerlIO_printf(PerlIO_stdout(),
2765 "\n\nOS/2 port Copyright (c) 1990, 1991, Raymond Chen, Kai Uwe Rommel\n"
2766 "Version 5 port Copyright (c) 1994-2002, Andreas Kaiser, Ilya Zakharevich\n");
2769 PerlIO_printf(PerlIO_stdout(),
2770 "atariST series port, ++jrb bammi@cadence.com\n");
2773 PerlIO_printf(PerlIO_stdout(),
2774 "BeOS port Copyright Tom Spindler, 1997-1999\n");
2777 PerlIO_printf(PerlIO_stdout(),
2778 "MPE/iX port Copyright by Mark Klein and Mark Bixby, 1996-2003\n");
2781 PerlIO_printf(PerlIO_stdout(),
2782 "MVS (OS390) port by Mortice Kern Systems, 1997-1999\n");
2785 PerlIO_printf(PerlIO_stdout(),
2786 "Stratus VOS port by Paul.Green@stratus.com, 1997-2002\n");
2789 PerlIO_printf(PerlIO_stdout(),
2790 "VM/ESA port by Neale Ferguson, 1998-1999\n");
2793 PerlIO_printf(PerlIO_stdout(),
2794 "BS2000 (POSIX) port by Start Amadeus GmbH, 1998-1999\n");
2797 PerlIO_printf(PerlIO_stdout(),
2798 "MiNT port by Guido Flohr, 1997-1999\n");
2801 PerlIO_printf(PerlIO_stdout(),
2802 "EPOC port by Olaf Flebbe, 1999-2002\n");
2805 PerlIO_printf(PerlIO_stdout(),"WINCE port by Rainer Keuchel, 2001-2002\n");
2806 PerlIO_printf(PerlIO_stdout(),"Built on " __DATE__ " " __TIME__ "\n\n");
2809 #ifdef BINARY_BUILD_NOTICE
2810 BINARY_BUILD_NOTICE;
2812 PerlIO_printf(PerlIO_stdout(),
2814 Perl may be copied only under the terms of either the Artistic License or the\n\
2815 GNU General Public License, which may be found in the Perl 5 source kit.\n\n\
2816 Complete documentation for Perl, including FAQ lists, should be found on\n\
2817 this system using `man perl' or `perldoc perl'. If you have access to the\n\
2818 Internet, point your browser at http://www.perl.org/, the Perl Home Page.\n\n");
2821 if (! (PL_dowarn & G_WARN_ALL_MASK))
2822 PL_dowarn |= G_WARN_ON;
2826 PL_dowarn = G_WARN_ALL_ON|G_WARN_ON;
2827 if (!specialWARN(PL_compiling.cop_warnings))
2828 SvREFCNT_dec(PL_compiling.cop_warnings);
2829 PL_compiling.cop_warnings = pWARN_ALL ;
2833 PL_dowarn = G_WARN_ALL_OFF;
2834 if (!specialWARN(PL_compiling.cop_warnings))
2835 SvREFCNT_dec(PL_compiling.cop_warnings);
2836 PL_compiling.cop_warnings = pWARN_NONE ;
2841 if (s[1] == '-') /* Additional switches on #! line. */
2846 #if defined(WIN32) || !defined(PERL_STRICT_CR)
2852 #ifdef ALTERNATE_SHEBANG
2853 case 'S': /* OS/2 needs -S on "extproc" line. */
2861 Perl_croak(aTHX_ "Can't emulate -%.1s on #! line",s);
2866 /* compliments of Tom Christiansen */
2868 /* unexec() can be found in the Gnu emacs distribution */
2869 /* Known to work with -DUNEXEC and using unexelf.c from GNU emacs-20.2 */
2872 Perl_my_unexec(pTHX)
2880 prog = newSVpv(BIN_EXP, 0);
2881 sv_catpv(prog, "/perl");
2882 file = newSVpv(PL_origfilename, 0);
2883 sv_catpv(file, ".perldump");
2885 unexec(SvPVX(file), SvPVX(prog), &etext, sbrk(0), 0);
2886 /* unexec prints msg to stderr in case of failure */
2887 PerlProc_exit(status);
2890 # include <lib$routines.h>
2891 lib$signal(SS$_DEBUG); /* ssdef.h #included from vmsish.h */
2893 ABORT(); /* for use with undump */
2898 /* initialize curinterp */
2904 # define PERLVAR(var,type)
2905 # define PERLVARA(var,n,type)
2906 # if defined(PERL_IMPLICIT_CONTEXT)
2907 # if defined(USE_5005THREADS)
2908 # define PERLVARI(var,type,init) PERL_GET_INTERP->var = init;
2909 # define PERLVARIC(var,type,init) PERL_GET_INTERP->var = init;
2910 # else /* !USE_5005THREADS */
2911 # define PERLVARI(var,type,init) aTHX->var = init;
2912 # define PERLVARIC(var,type,init) aTHX->var = init;
2913 # endif /* USE_5005THREADS */
2915 # define PERLVARI(var,type,init) PERL_GET_INTERP->var = init;
2916 # define PERLVARIC(var,type,init) PERL_GET_INTERP->var = init;
2918 # include "intrpvar.h"
2919 # ifndef USE_5005THREADS
2920 # include "thrdvar.h"
2927 # define PERLVAR(var,type)
2928 # define PERLVARA(var,n,type)
2929 # define PERLVARI(var,type,init) PL_##var = init;
2930 # define PERLVARIC(var,type,init) PL_##var = init;
2931 # include "intrpvar.h"
2932 # ifndef USE_5005THREADS
2933 # include "thrdvar.h"
2944 S_init_main_stash(pTHX)
2948 PL_curstash = PL_defstash = newHV();
2949 PL_curstname = newSVpvn("main",4);
2950 gv = gv_fetchpv("main::",TRUE, SVt_PVHV);
2951 SvREFCNT_dec(GvHV(gv));
2952 GvHV(gv) = (HV*)SvREFCNT_inc(PL_defstash);
2954 HvNAME(PL_defstash) = savepv("main");
2955 PL_incgv = gv_HVadd(gv_AVadd(gv_fetchpv("INC",TRUE, SVt_PVAV)));
2956 GvMULTI_on(PL_incgv);
2957 PL_hintgv = gv_fetchpv("\010",TRUE, SVt_PV); /* ^H */
2958 GvMULTI_on(PL_hintgv);
2959 PL_defgv = gv_fetchpv("_",TRUE, SVt_PVAV);
2960 PL_errgv = gv_HVadd(gv_fetchpv("@", TRUE, SVt_PV));
2961 GvMULTI_on(PL_errgv);
2962 PL_replgv = gv_fetchpv("\022", TRUE, SVt_PV); /* ^R */
2963 GvMULTI_on(PL_replgv);
2964 (void)Perl_form(aTHX_ "%240s",""); /* Preallocate temp - for immediate signals. */
2965 sv_grow(ERRSV, 240); /* Preallocate - for immediate signals. */
2966 sv_setpvn(ERRSV, "", 0);
2967 PL_curstash = PL_defstash;
2968 CopSTASH_set(&PL_compiling, PL_defstash);
2969 PL_debstash = GvHV(gv_fetchpv("DB::", GV_ADDMULTI, SVt_PVHV));
2970 PL_globalstash = GvHV(gv_fetchpv("CORE::GLOBAL::", GV_ADDMULTI, SVt_PVHV));
2971 /* We must init $/ before switches are processed. */
2972 sv_setpvn(get_sv("/", TRUE), "\n", 1);
2975 /* PSz 18 Nov 03 fdscript now global but do not change prototype */
2977 S_open_script(pTHX_ char *scriptname, bool dosearch, SV *sv)
2982 char *cpp_discard_flag;
2990 PL_origfilename = savepv("-e");
2993 /* if find_script() returns, it returns a malloc()-ed value */
2994 PL_origfilename = scriptname = find_script(scriptname, dosearch, NULL, 1);
2996 if (strnEQ(scriptname, "/dev/fd/", 8) && isDIGIT(scriptname[8]) ) {
2997 char *s = scriptname + 8;
2998 PL_fdscript = atoi(s);
3003 * Tell apart "normal" usage of fdscript, e.g.
3004 * with bash on FreeBSD:
3005 * perl <( echo '#!perl -DA'; echo 'print "$0\n"')
3006 * from usage in suidperl.
3007 * Does any "normal" usage leave garbage after the number???
3008 * Is it a mistake to use a similar /dev/fd/ construct for
3013 * Be supersafe and do some sanity-checks.
3014 * Still, can we be sure we got the right thing?
3017 Perl_croak(aTHX_ "Wrong syntax (suid) fd script name \"%s\"\n", s);
3020 Perl_croak(aTHX_ "Missing (suid) fd script name\n");
3022 scriptname = savepv(s + 1);
3023 Safefree(PL_origfilename);
3024 PL_origfilename = scriptname;
3029 CopFILE_free(PL_curcop);
3030 CopFILE_set(PL_curcop, PL_origfilename);
3031 if (strEQ(PL_origfilename,"-"))
3033 if (PL_fdscript >= 0) {
3034 PL_rsfp = PerlIO_fdopen(PL_fdscript,PERL_SCRIPT_MODE);
3035 # if defined(HAS_FCNTL) && defined(F_SETFD)
3037 /* ensure close-on-exec */
3038 fcntl(PerlIO_fileno(PL_rsfp),F_SETFD,1);
3043 Perl_croak(aTHX_ "sperl needs fd script\n"
3044 "You should not call sperl directly; do you need to "
3045 "change a #! line\nfrom sperl to perl?\n");
3048 * Do not open (or do other fancy stuff) while setuid.
3049 * Perl does the open, and hands script to suidperl on a fd;
3050 * suidperl only does some checks, sets up UIDs and re-execs
3051 * perl with that fd as it has always done.
3054 if (PL_suidscript != 1) {
3055 Perl_croak(aTHX_ "suidperl needs (suid) fd script\n");
3058 else if (PL_preprocess) {
3059 char *cpp_cfg = CPPSTDIN;
3060 SV *cpp = newSVpvn("",0);
3061 SV *cmd = NEWSV(0,0);
3063 if (cpp_cfg[0] == 0) /* PERL_MICRO? */
3064 Perl_croak(aTHX_ "Can't run with cpp -P with CPPSTDIN undefined");
3065 if (strEQ(cpp_cfg, "cppstdin"))
3066 Perl_sv_catpvf(aTHX_ cpp, "%s/", BIN_EXP);
3067 sv_catpv(cpp, cpp_cfg);
3070 sv_catpvn(sv, "-I", 2);
3071 sv_catpv(sv,PRIVLIB_EXP);
3074 DEBUG_P(PerlIO_printf(Perl_debug_log,
3075 "PL_preprocess: scriptname=\"%s\", cpp=\"%s\", sv=\"%s\", CPPMINUS=\"%s\"\n",
3076 scriptname, SvPVX (cpp), SvPVX (sv), CPPMINUS));
3078 # if defined(MSDOS) || defined(WIN32) || defined(VMS)
3085 cpp_discard_flag = "";
3087 cpp_discard_flag = "-C";
3091 perl = os2_execname(aTHX);
3093 perl = PL_origargv[0];
3097 /* This strips off Perl comments which might interfere with
3098 the C pre-processor, including #!. #line directives are
3099 deliberately stripped to avoid confusion with Perl's version
3100 of #line. FWP played some golf with it so it will fit
3101 into VMS's 255 character buffer.
3104 code = "(1../^#!.*perl/i)|/^\\s*#(?!\\s*((ifn?|un)def|(el|end)?if|define|include|else|error|pragma)\\b)/||!($|=1)||print";
3106 code = "/^\\s*#(?!\\s*((ifn?|un)def|(el|end)?if|define|include|else|error|pragma)\\b)/||!($|=1)||print";
3108 Perl_sv_setpvf(aTHX_ cmd, "\
3109 %s -ne%s%s%s %s | %"SVf" %s %"SVf" %s",
3110 perl, quote, code, quote, scriptname, cpp,
3111 cpp_discard_flag, sv, CPPMINUS);
3113 PL_doextract = FALSE;
3115 DEBUG_P(PerlIO_printf(Perl_debug_log,
3116 "PL_preprocess: cmd=\"%s\"\n",
3119 PL_rsfp = PerlProc_popen(SvPVX(cmd), "r");
3123 else if (!*scriptname) {
3124 forbid_setid("program input from stdin");
3125 PL_rsfp = PerlIO_stdin();
3128 PL_rsfp = PerlIO_open(scriptname,PERL_SCRIPT_MODE);
3129 # if defined(HAS_FCNTL) && defined(F_SETFD)
3131 /* ensure close-on-exec */
3132 fcntl(PerlIO_fileno(PL_rsfp),F_SETFD,1);
3135 #endif /* IAMSUID */
3137 /* PSz 16 Sep 03 Keep neat error message */
3138 Perl_croak(aTHX_ "Can't open perl script \"%s\": %s\n",
3139 CopFILE(PL_curcop), Strerror(errno));
3144 * I_SYSSTATVFS HAS_FSTATVFS
3146 * I_STATFS HAS_FSTATFS HAS_GETFSSTAT
3147 * I_MNTENT HAS_GETMNTENT HAS_HASMNTOPT
3148 * here so that metaconfig picks them up. */
3152 S_fd_on_nosuid_fs(pTHX_ int fd)
3155 * We used to do this as "plain" user (after swapping UIDs with setreuid);
3156 * but is needed also on machines without setreuid.
3157 * Seems safe enough to run as root.
3159 int check_okay = 0; /* able to do all the required sys/libcalls */
3160 int on_nosuid = 0; /* the fd is on a nosuid fs */
3162 * Need to check noexec also: nosuid might not be set, the average
3163 * sysadmin would say that nosuid is irrelevant once he sets noexec.
3165 int on_noexec = 0; /* the fd is on a noexec fs */
3168 * Preferred order: fstatvfs(), fstatfs(), ustat()+getmnt(), getmntent().
3169 * fstatvfs() is UNIX98.
3170 * fstatfs() is 4.3 BSD.
3171 * ustat()+getmnt() is pre-4.3 BSD.
3172 * getmntent() is O(number-of-mounted-filesystems) and can hang on
3173 * an irrelevant filesystem while trying to reach the right one.
3176 #undef FD_ON_NOSUID_CHECK_OKAY /* found the syscalls to do the check? */
3178 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3179 defined(HAS_FSTATVFS)
3180 # define FD_ON_NOSUID_CHECK_OKAY
3181 struct statvfs stfs;
3183 check_okay = fstatvfs(fd, &stfs) == 0;
3184 on_nosuid = check_okay && (stfs.f_flag & ST_NOSUID);
3186 /* ST_NOEXEC certainly absent on AIX 5.1, and doesn't seem to be documented
3187 on platforms where it is present. */
3188 on_noexec = check_okay && (stfs.f_flag & ST_NOEXEC);
3190 # endif /* fstatvfs */
3192 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3193 defined(PERL_MOUNT_NOSUID) && \
3194 defined(PERL_MOUNT_NOEXEC) && \
3195 defined(HAS_FSTATFS) && \
3196 defined(HAS_STRUCT_STATFS) && \
3197 defined(HAS_STRUCT_STATFS_F_FLAGS)
3198 # define FD_ON_NOSUID_CHECK_OKAY
3201 check_okay = fstatfs(fd, &stfs) == 0;
3202 on_nosuid = check_okay && (stfs.f_flags & PERL_MOUNT_NOSUID);
3203 on_noexec = check_okay && (stfs.f_flags & PERL_MOUNT_NOEXEC);
3204 # endif /* fstatfs */
3206 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3207 defined(PERL_MOUNT_NOSUID) && \
3208 defined(PERL_MOUNT_NOEXEC) && \
3209 defined(HAS_FSTAT) && \
3210 defined(HAS_USTAT) && \
3211 defined(HAS_GETMNT) && \
3212 defined(HAS_STRUCT_FS_DATA) && \
3214 # define FD_ON_NOSUID_CHECK_OKAY
3217 if (fstat(fd, &fdst) == 0) {
3219 if (ustat(fdst.st_dev, &us) == 0) {
3221 /* NOSTAT_ONE here because we're not examining fields which
3222 * vary between that case and STAT_ONE. */
3223 if (getmnt((int*)0, &fsd, (int)0, NOSTAT_ONE, us.f_fname) == 0) {
3224 size_t cmplen = sizeof(us.f_fname);
3225 if (sizeof(fsd.fd_req.path) < cmplen)
3226 cmplen = sizeof(fsd.fd_req.path);
3227 if (strnEQ(fsd.fd_req.path, us.f_fname, cmplen) &&
3228 fdst.st_dev == fsd.fd_req.dev) {
3230 on_nosuid = fsd.fd_req.flags & PERL_MOUNT_NOSUID;
3231 on_noexec = fsd.fd_req.flags & PERL_MOUNT_NOEXEC;
3237 # endif /* fstat+ustat+getmnt */
3239 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3240 defined(HAS_GETMNTENT) && \
3241 defined(HAS_HASMNTOPT) && \
3242 defined(MNTOPT_NOSUID) && \
3243 defined(MNTOPT_NOEXEC)
3244 # define FD_ON_NOSUID_CHECK_OKAY
3245 FILE *mtab = fopen("/etc/mtab", "r");
3246 struct mntent *entry;
3249 if (mtab && (fstat(fd, &stb) == 0)) {
3250 while (entry = getmntent(mtab)) {
3251 if (stat(entry->mnt_dir, &fsb) == 0
3252 && fsb.st_dev == stb.st_dev)
3254 /* found the filesystem */
3256 if (hasmntopt(entry, MNTOPT_NOSUID))
3258 if (hasmntopt(entry, MNTOPT_NOEXEC))
3261 } /* A single fs may well fail its stat(). */
3266 # endif /* getmntent+hasmntopt */
3269 Perl_croak(aTHX_ "Can't check filesystem of script \"%s\" for nosuid/noexec", PL_origfilename);
3271 Perl_croak(aTHX_ "Setuid script \"%s\" on nosuid filesystem", PL_origfilename);
3273 Perl_croak(aTHX_ "Setuid script \"%s\" on noexec filesystem", PL_origfilename);
3274 return ((!check_okay) || on_nosuid || on_noexec);
3276 #endif /* IAMSUID */
3279 S_validate_suid(pTHX_ char *validarg, char *scriptname)
3283 #endif /* IAMSUID */
3285 /* do we need to emulate setuid on scripts? */
3287 /* This code is for those BSD systems that have setuid #! scripts disabled
3288 * in the kernel because of a security problem. Merely defining DOSUID
3289 * in perl will not fix that problem, but if you have disabled setuid
3290 * scripts in the kernel, this will attempt to emulate setuid and setgid
3291 * on scripts that have those now-otherwise-useless bits set. The setuid
3292 * root version must be called suidperl or sperlN.NNN. If regular perl
3293 * discovers that it has opened a setuid script, it calls suidperl with
3294 * the same argv that it had. If suidperl finds that the script it has
3295 * just opened is NOT setuid root, it sets the effective uid back to the
3296 * uid. We don't just make perl setuid root because that loses the
3297 * effective uid we had before invoking perl, if it was different from the
3300 * Description/comments above do not match current workings:
3301 * suidperl must be hardlinked to sperlN.NNN (that is what we exec);
3302 * suidperl called with script open and name changed to /dev/fd/N/X;
3303 * suidperl croaks if script is not setuid;
3304 * making perl setuid would be a huge security risk (and yes, that
3305 * would lose any euid we might have had).
3307 * DOSUID must be defined in both perl and suidperl, and IAMSUID must
3308 * be defined in suidperl only. suidperl must be setuid root. The
3309 * Configure script will set this up for you if you want it.
3315 if (PerlLIO_fstat(PerlIO_fileno(PL_rsfp),&PL_statbuf) < 0) /* normal stat is insecure */
3316 Perl_croak(aTHX_ "Can't stat script \"%s\"",PL_origfilename);
3317 if (PL_statbuf.st_mode & (S_ISUID|S_ISGID)) {
3322 if (PL_fdscript < 0 || PL_suidscript != 1)
3323 Perl_croak(aTHX_ "Need (suid) fdscript in suidperl\n"); /* We already checked this */
3325 * Since the script is opened by perl, not suidperl, some of these
3326 * checks are superfluous. Leaving them in probably does not lower
3330 * Do checks even for systems with no HAS_SETREUID.
3331 * We used to swap, then re-swap UIDs with
3333 if (setreuid(PL_euid,PL_uid) < 0
3334 || PerlProc_getuid() != PL_euid || PerlProc_geteuid() != PL_uid)
3335 Perl_croak(aTHX_ "Can't swap uid and euid");
3338 if (setreuid(PL_uid,PL_euid) < 0
3339 || PerlProc_getuid() != PL_uid || PerlProc_geteuid() != PL_euid)
3340 Perl_croak(aTHX_ "Can't reswap uid and euid");
3344 /* On this access check to make sure the directories are readable,
3345 * there is actually a small window that the user could use to make
3346 * filename point to an accessible directory. So there is a faint
3347 * chance that someone could execute a setuid script down in a
3348 * non-accessible directory. I don't know what to do about that.
3349 * But I don't think it's too important. The manual lies when
3350 * it says access() is useful in setuid programs.
3352 * So, access() is pretty useless... but not harmful... do anyway.
3354 if (PerlLIO_access(CopFILE(PL_curcop),1)) { /*double check*/
3355 Perl_croak(aTHX_ "Can't access() script\n");
3358 /* If we can swap euid and uid, then we can determine access rights
3359 * with a simple stat of the file, and then compare device and
3360 * inode to make sure we did stat() on the same file we opened.
3361 * Then we just have to make sure he or she can execute it.
3364 * As the script is opened by perl, not suidperl, we do not need to
3365 * care much about access rights.
3367 * The 'script changed' check is needed, or we can get lied to
3368 * about $0 with e.g.
3369 * suidperl /dev/fd/4//bin/x 4<setuidscript
3370 * Without HAS_SETREUID, is it safe to stat() as root?
3372 * Are there any operating systems that pass /dev/fd/xxx for setuid
3373 * scripts, as suggested/described in perlsec(1)? Surely they do not
3374 * pass the script name as we do, so the "script changed" test would
3375 * fail for them... but we never get here with
3376 * SETUID_SCRIPTS_ARE_SECURE_NOW defined.
3378 * This is one place where we must "lie" about return status: not
3379 * say if the stat() failed. We are doing this as root, and could
3380 * be tricked into reporting existence or not of files that the
3381 * "plain" user cannot even see.
3385 if (PerlLIO_stat(CopFILE(PL_curcop),&tmpstatbuf) < 0 ||
3386 tmpstatbuf.st_dev != PL_statbuf.st_dev ||
3387 tmpstatbuf.st_ino != PL_statbuf.st_ino) {
3388 Perl_croak(aTHX_ "Setuid script changed\n");
3392 if (!cando(S_IXUSR,FALSE,&PL_statbuf)) /* can real uid exec? */
3393 Perl_croak(aTHX_ "Real UID cannot exec script\n");
3396 * We used to do this check as the "plain" user (after swapping
3397 * UIDs). But the check for nosuid and noexec filesystem is needed,
3398 * and should be done even without HAS_SETREUID. (Maybe those
3399 * operating systems do not have such mount options anyway...)
3400 * Seems safe enough to do as root.
3402 #if !defined(NO_NOSUID_CHECK)
3403 if (fd_on_nosuid_fs(PerlIO_fileno(PL_rsfp))) {
3404 Perl_croak(aTHX_ "Setuid script on nosuid or noexec filesystem\n");
3407 #endif /* IAMSUID */
3409 if (!S_ISREG(PL_statbuf.st_mode)) {
3410 Perl_croak(aTHX_ "Setuid script not plain file\n");
3412 if (PL_statbuf.st_mode & S_IWOTH)
3413 Perl_croak(aTHX_ "Setuid/gid script is writable by world");
3414 PL_doswitches = FALSE; /* -s is insecure in suid */
3415 /* PSz 13 Nov 03 But -s was caught elsewhere ... so unsetting it here is useless(?!) */
3416 CopLINE_inc(PL_curcop);
3417 if (sv_gets(PL_linestr, PL_rsfp, 0) == Nullch ||
3418 strnNE(SvPV(PL_linestr,n_a),"#!",2) ) /* required even on Sys V */
3419 Perl_croak(aTHX_ "No #! line");
3420 s = SvPV(PL_linestr,n_a)+2;
3422 /* Sanity check on line length */
3423 if (strlen(s) < 1 || strlen(s) > 4000)
3424 Perl_croak(aTHX_ "Very long #! line");
3425 /* Allow more than a single space after #! */
3426 while (isSPACE(*s)) s++;
3427 /* Sanity check on buffer end */
3428 while ((*s) && !isSPACE(*s)) s++;
3429 for (s2 = s; (s2 > SvPV(PL_linestr,n_a)+2 &&
3430 (isDIGIT(s2[-1]) || strchr("._-", s2[-1]))); s2--) ;
3431 /* Sanity check on buffer start */
3432 if ( (s2-4 < SvPV(PL_linestr,n_a)+2 || strnNE(s2-4,"perl",4)) &&
3433 (s-9 < SvPV(PL_linestr,n_a)+2 || strnNE(s-9,"perl",4)) )
3434 Perl_croak(aTHX_ "Not a perl script");
3435 while (*s == ' ' || *s == '\t') s++;
3437 * #! arg must be what we saw above. They can invoke it by
3438 * mentioning suidperl explicitly, but they may not add any strange
3439 * arguments beyond what #! says if they do invoke suidperl that way.
3442 * The way validarg was set up, we rely on the kernel to start
3443 * scripts with argv[1] set to contain all #! line switches (the
3447 * Check that we got all the arguments listed in the #! line (not
3448 * just that there are no extraneous arguments). Might not matter
3449 * much, as switches from #! line seem to be acted upon (also), and
3450 * so may be checked and trapped in perl. But, security checks must
3451 * be done in suidperl and not deferred to perl. Note that suidperl
3452 * does not get around to parsing (and checking) the switches on
3453 * the #! line (but execs perl sooner).
3454 * Allow (require) a trailing newline (which may be of two
3455 * characters on some architectures?) (but no other trailing
3458 len = strlen(validarg);
3459 if (strEQ(validarg," PHOOEY ") ||
3460 strnNE(s,validarg,len) || !isSPACE(s[len]) ||
3461 !(strlen(s) == len+1 || (strlen(s) == len+2 && isSPACE(s[len+1]))))
3462 Perl_croak(aTHX_ "Args must match #! line");
3465 if (PL_fdscript < 0 &&
3466 PL_euid != PL_uid && (PL_statbuf.st_mode & S_ISUID) &&
3467 PL_euid == PL_statbuf.st_uid)
3469 Perl_croak(aTHX_ "YOU HAVEN'T DISABLED SET-ID SCRIPTS IN THE KERNEL YET!\n\
3470 FIX YOUR KERNEL, OR PUT A C WRAPPER AROUND THIS SCRIPT!\n");
3471 #endif /* IAMSUID */
3473 if (PL_fdscript < 0 &&
3474 PL_euid) { /* oops, we're not the setuid root perl */
3476 * When root runs a setuid script, we do not go through the same
3477 * steps of execing sperl and then perl with fd scripts, but
3478 * simply set up UIDs within the same perl invocation; so do
3479 * not have the same checks (on options, whatever) that we have
3480 * for plain users. No problem really: would have to be a script
3481 * that does not actually work for plain users; and if root is
3482 * foolish and can be persuaded to run such an unsafe script, he
3483 * might run also non-setuid ones, and deserves what he gets.
3485 * Or, we might drop the PL_euid check above (and rely just on
3486 * PL_fdscript to avoid loops), and do the execs
3492 * Pass fd script to suidperl.
3493 * Exec suidperl, substituting fd script for scriptname.
3494 * Pass script name as "subdir" of fd, which perl will grok;
3495 * in fact will use that to distinguish this from "normal"
3496 * usage, see comments above.
3498 PerlIO_rewind(PL_rsfp);
3499 PerlLIO_lseek(PerlIO_fileno(PL_rsfp),(Off_t)0,0); /* just in case rewind didn't */
3500 /* PSz 27 Feb 04 Sanity checks on scriptname */
3501 if ((!scriptname) || (!*scriptname) ) {
3502 Perl_croak(aTHX_ "No setuid script name\n");
3504 if (*scriptname == '-') {
3505 Perl_croak(aTHX_ "Setuid script name may not begin with dash\n");
3506 /* Or we might confuse it with an option when replacing
3507 * name in argument list, below (though we do pointer, not
3508 * string, comparisons).
3511 for (which = 1; PL_origargv[which] && PL_origargv[which] != scriptname; which++) ;
3512 if (!PL_origargv[which]) {
3513 Perl_croak(aTHX_ "Can't change argv to have fd script\n");
3515 PL_origargv[which] = savepv(Perl_form(aTHX_ "/dev/fd/%d/%s",
3516 PerlIO_fileno(PL_rsfp), PL_origargv[which]));
3517 #if defined(HAS_FCNTL) && defined(F_SETFD)
3518 fcntl(PerlIO_fileno(PL_rsfp),F_SETFD,0); /* ensure no close-on-exec */
3521 PerlProc_execv(Perl_form(aTHX_ "%s/sperl"PERL_FS_VER_FMT, BIN_EXP,
3522 (int)PERL_REVISION, (int)PERL_VERSION,
3523 (int)PERL_SUBVERSION), PL_origargv);
3525 #endif /* IAMSUID */
3526 Perl_croak(aTHX_ "Can't do setuid (cannot exec sperl)\n");
3529 if (PL_statbuf.st_mode & S_ISGID && PL_statbuf.st_gid != PL_egid) {
3531 * This seems back to front: we try HAS_SETEGID first; if not available
3532 * then try HAS_SETREGID; as a last chance we try HAS_SETRESGID. May be OK
3533 * in the sense that we only want to set EGID; but are there any machines
3534 * with either of the latter, but not the former? Same with UID, later.
3537 (void)setegid(PL_statbuf.st_gid);
3540 (void)setregid((Gid_t)-1,PL_statbuf.st_gid);
3542 #ifdef HAS_SETRESGID
3543 (void)setresgid((Gid_t)-1,PL_statbuf.st_gid,(Gid_t)-1);
3545 PerlProc_setgid(PL_statbuf.st_gid);
3549 if (PerlProc_getegid() != PL_statbuf.st_gid)
3550 Perl_croak(aTHX_ "Can't do setegid!\n");
3552 if (PL_statbuf.st_mode & S_ISUID) {
3553 if (PL_statbuf.st_uid != PL_euid)
3555 (void)seteuid(PL_statbuf.st_uid); /* all that for this */
3558 (void)setreuid((Uid_t)-1,PL_statbuf.st_uid);
3560 #ifdef HAS_SETRESUID
3561 (void)setresuid((Uid_t)-1,PL_statbuf.st_uid,(Uid_t)-1);
3563 PerlProc_setuid(PL_statbuf.st_uid);
3567 if (PerlProc_geteuid() != PL_statbuf.st_uid)
3568 Perl_croak(aTHX_ "Can't do seteuid!\n");
3570 else if (PL_uid) { /* oops, mustn't run as root */
3572 (void)seteuid((Uid_t)PL_uid);
3575 (void)setreuid((Uid_t)-1,(Uid_t)PL_uid);
3577 #ifdef HAS_SETRESUID
3578 (void)setresuid((Uid_t)-1,(Uid_t)PL_uid,(Uid_t)-1);
3580 PerlProc_setuid((Uid_t)PL_uid);
3584 if (PerlProc_geteuid() != PL_uid)
3585 Perl_croak(aTHX_ "Can't do seteuid!\n");
3588 if (!cando(S_IXUSR,TRUE,&PL_statbuf))
3589 Perl_croak(aTHX_ "Effective UID cannot exec script\n"); /* they can't do this */
3592 else if (PL_preprocess) /* PSz 13 Nov 03 Caught elsewhere, useless(?!) here */
3593 Perl_croak(aTHX_ "-P not allowed for setuid/setgid script\n");
3594 else if (PL_fdscript < 0 || PL_suidscript != 1)
3595 /* PSz 13 Nov 03 Caught elsewhere, useless(?!) here */
3596 Perl_croak(aTHX_ "(suid) fdscript needed in suidperl\n");
3598 /* PSz 16 Sep 03 Keep neat error message */
3599 Perl_croak(aTHX_ "Script is not setuid/setgid in suidperl\n");
3602 /* We absolutely must clear out any saved ids here, so we */
3603 /* exec the real perl, substituting fd script for scriptname. */
3604 /* (We pass script name as "subdir" of fd, which perl will grok.) */
3606 * It might be thought that using setresgid and/or setresuid (changed to
3607 * set the saved IDs) above might obviate the need to exec, and we could
3608 * go on to "do the perl thing".
3610 * Is there such a thing as "saved GID", and is that set for setuid (but
3611 * not setgid) execution like suidperl? Without exec, it would not be
3612 * cleared for setuid (but not setgid) scripts (or might need a dummy
3615 * We need suidperl to do the exact same argument checking that perl
3616 * does. Thus it cannot be very small; while it could be significantly
3617 * smaller, it is safer (simpler?) to make it essentially the same
3618 * binary as perl (but they are not identical). - Maybe could defer that
3619 * check to the invoked perl, and suidperl be a tiny wrapper instead;
3620 * but prefer to do thorough checks in suidperl itself. Such deferral
3621 * would make suidperl security rely on perl, a design no-no.
3623 * Setuid things should be short and simple, thus easy to understand and
3624 * verify. They should do their "own thing", without influence by
3625 * attackers. It may help if their internal execution flow is fixed,
3626 * regardless of platform: it may be best to exec anyway.
3628 * Suidperl should at least be conceptually simple: a wrapper only,
3629 * never to do any real perl. Maybe we should put
3631 * Perl_croak(aTHX_ "Suidperl should never do real perl\n");
3633 * into the perly bits.
3635 PerlIO_rewind(PL_rsfp);
3636 PerlLIO_lseek(PerlIO_fileno(PL_rsfp),(Off_t)0,0); /* just in case rewind didn't */
3638 * Keep original arguments: suidperl already has fd script.
3640 /* for (which = 1; PL_origargv[which] && PL_origargv[which] != scriptname; which++) ; */
3641 /* if (!PL_origargv[which]) { */
3642 /* errno = EPERM; */
3643 /* Perl_croak(aTHX_ "Permission denied\n"); */
3645 /* PL_origargv[which] = savepv(Perl_form(aTHX_ "/dev/fd/%d/%s", */
3646 /* PerlIO_fileno(PL_rsfp), PL_origargv[which])); */
3647 #if defined(HAS_FCNTL) && defined(F_SETFD)
3648 fcntl(PerlIO_fileno(PL_rsfp),F_SETFD,0); /* ensure no close-on-exec */
3651 PerlProc_execv(Perl_form(aTHX_ "%s/perl"PERL_FS_VER_FMT, BIN_EXP,
3652 (int)PERL_REVISION, (int)PERL_VERSION,
3653 (int)PERL_SUBVERSION), PL_origargv);/* try again */
3655 Perl_croak(aTHX_ "Can't do setuid (suidperl cannot exec perl)\n");
3656 #endif /* IAMSUID */
3658 if (PL_euid != PL_uid || PL_egid != PL_gid) { /* (suidperl doesn't exist, in fact) */
3659 #ifndef SETUID_SCRIPTS_ARE_SECURE_NOW
3660 PerlLIO_fstat(PerlIO_fileno(PL_rsfp),&PL_statbuf); /* may be either wrapped or real suid */
3661 if ((PL_euid != PL_uid && PL_euid == PL_statbuf.st_uid && PL_statbuf.st_mode & S_ISUID)
3663 (PL_egid != PL_gid && PL_egid == PL_statbuf.st_gid && PL_statbuf.st_mode & S_ISGID)
3666 Perl_croak(aTHX_ "YOU HAVEN'T DISABLED SET-ID SCRIPTS IN THE KERNEL YET!\n\
3667 FIX YOUR KERNEL, PUT A C WRAPPER AROUND THIS SCRIPT, OR USE -u AND UNDUMP!\n");
3668 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
3669 /* not set-id, must be wrapped */
3675 S_find_beginning(pTHX)
3677 register char *s, *s2;
3678 #ifdef MACOS_TRADITIONAL
3682 /* skip forward in input to the real script? */
3685 #ifdef MACOS_TRADITIONAL
3686 /* Since the Mac OS does not honor #! arguments for us, we do it ourselves */
3688 while (PL_doextract || gMacPerl_AlwaysExtract) {
3689 if ((s = sv_gets(PL_linestr, PL_rsfp, 0)) == Nullch) {
3690 if (!gMacPerl_AlwaysExtract)
3691 Perl_croak(aTHX_ "No Perl script found in input\n");
3693 if (PL_doextract) /* require explicit override ? */
3694 if (!OverrideExtract(PL_origfilename))
3695 Perl_croak(aTHX_ "User aborted script\n");
3697 PL_doextract = FALSE;
3699 /* Pater peccavi, file does not have #! */
3700 PerlIO_rewind(PL_rsfp);
3705 while (PL_doextract) {
3706 if ((s = sv_gets(PL_linestr, PL_rsfp, 0)) == Nullch)
3707 Perl_croak(aTHX_ "No Perl script found in input\n");
3710 if (*s == '#' && s[1] == '!' && ((s = instr(s,"perl")) || (s = instr(s2,"PERL")))) {
3711 PerlIO_ungetc(PL_rsfp, '\n'); /* to keep line count right */
3712 PL_doextract = FALSE;
3713 while (*s && !(isSPACE (*s) || *s == '#')) s++;
3715 while (*s == ' ' || *s == '\t') s++;
3717 while (isDIGIT(s2[-1]) || strchr("-._", s2[-1])) s2--;
3718 if (strnEQ(s2-4,"perl",4))
3720 while ((s = moreswitches(s)))
3723 #ifdef MACOS_TRADITIONAL
3724 /* We are always searching for the #!perl line in MacPerl,
3725 * so if we find it, still keep the line count correct
3726 * by counting lines we already skipped over
3728 for (; maclines > 0 ; maclines--)
3729 PerlIO_ungetc(PL_rsfp, '\n');
3733 /* gMacPerl_AlwaysExtract is false in MPW tool */
3734 } else if (gMacPerl_AlwaysExtract) {
3745 PL_uid = PerlProc_getuid();
3746 PL_euid = PerlProc_geteuid();
3747 PL_gid = PerlProc_getgid();
3748 PL_egid = PerlProc_getegid();
3750 PL_uid |= PL_gid << 16;
3751 PL_euid |= PL_egid << 16;
3753 /* Should not happen: */
3754 CHECK_MALLOC_TAINT(PL_uid && (PL_euid != PL_uid || PL_egid != PL_gid));
3755 PL_tainting |= (PL_uid && (PL_euid != PL_uid || PL_egid != PL_gid));
3758 * Should go by suidscript, not uid!=euid: why disallow
3759 * system("ls") in scripts run from setuid things?
3760 * Or, is this run before we check arguments and set suidscript?
3761 * What about SETUID_SCRIPTS_ARE_SECURE_NOW: could we use fdscript then?
3762 * (We never have suidscript, can we be sure to have fdscript?)
3763 * Or must then go by UID checks? See comments in forbid_setid also.
3767 /* This is used very early in the lifetime of the program,
3768 * before even the options are parsed, so PL_tainting has
3769 * not been initialized properly. */
3771 Perl_doing_taint(int argc, char *argv[], char *envp[])
3773 #ifndef PERL_IMPLICIT_SYS
3774 /* If we have PERL_IMPLICIT_SYS we can't call getuid() et alia
3775 * before we have an interpreter-- and the whole point of this
3776 * function is to be called at such an early stage. If you are on
3777 * a system with PERL_IMPLICIT_SYS but you do have a concept of
3778 * "tainted because running with altered effective ids', you'll
3779 * have to add your own checks somewhere in here. The two most
3780 * known samples of 'implicitness' are Win32 and NetWare, neither
3781 * of which has much of concept of 'uids'. */
3782 int uid = PerlProc_getuid();
3783 int euid = PerlProc_geteuid();
3784 int gid = PerlProc_getgid();
3785 int egid = PerlProc_getegid();
3791 if (uid && (euid != uid || egid != gid))
3793 #endif /* !PERL_IMPLICIT_SYS */
3794 /* This is a really primitive check; environment gets ignored only
3795 * if -T are the first chars together; otherwise one gets
3796 * "Too late" message. */
3797 if ( argc > 1 && argv[1][0] == '-'
3798 && (argv[1][1] == 't' || argv[1][1] == 'T') )
3804 S_forbid_setid(pTHX_ char *s)
3806 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
3807 if (PL_euid != PL_uid)
3808 Perl_croak(aTHX_ "No %s allowed while running setuid", s);
3809 if (PL_egid != PL_gid)
3810 Perl_croak(aTHX_ "No %s allowed while running setgid", s);
3811 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
3813 * Checks for UID/GID above "wrong": why disallow
3814 * perl -e 'print "Hello\n"'
3815 * from within setuid things?? Simply drop them: replaced by
3816 * fdscript/suidscript and #ifdef IAMSUID checks below.
3818 * This may be too late for command-line switches. Will catch those on
3819 * the #! line, after finding the script name and setting up
3820 * fdscript/suidscript. Note that suidperl does not get around to
3821 * parsing (and checking) the switches on the #! line, but checks that
3822 * the two sets are identical.
3824 * With SETUID_SCRIPTS_ARE_SECURE_NOW, could we use fdscript, also or
3825 * instead, or would that be "too late"? (We never have suidscript, can
3826 * we be sure to have fdscript?)
3828 * Catch things with suidscript (in descendant of suidperl), even with
3829 * right UID/GID. Was already checked in suidperl, with #ifdef IAMSUID,
3830 * below; but I am paranoid.
3832 * Also see comments about root running a setuid script, elsewhere.
3834 if (PL_suidscript >= 0)
3835 Perl_croak(aTHX_ "No %s allowed with (suid) fdscript", s);
3837 /* PSz 11 Nov 03 Catch it in suidperl, always! */
3838 Perl_croak(aTHX_ "No %s allowed in suidperl", s);
3839 #endif /* IAMSUID */
3843 Perl_init_debugger(pTHX)
3845 HV *ostash = PL_curstash;
3847 PL_curstash = PL_debstash;
3848 PL_dbargs = GvAV(gv_AVadd((gv_fetchpv("DB::args", GV_ADDMULTI, SVt_PVAV))));
3849 AvREAL_off(PL_dbargs);
3850 PL_DBgv = gv_fetchpv("DB::DB", GV_ADDMULTI, SVt_PVGV);
3851 PL_DBline = gv_fetchpv("DB::dbline", GV_ADDMULTI, SVt_PVAV);
3852 PL_DBsub = gv_HVadd(gv_fetchpv("DB::sub", GV_ADDMULTI, SVt_PVHV));
3853 sv_upgrade(GvSV(PL_DBsub), SVt_IV); /* IVX accessed if PERLDB_SUB_NN */
3854 PL_DBsingle = GvSV((gv_fetchpv("DB::single", GV_ADDMULTI, SVt_PV)));
3855 sv_setiv(PL_DBsingle, 0);
3856 PL_DBtrace = GvSV((gv_fetchpv("DB::trace", GV_ADDMULTI, SVt_PV)));
3857 sv_setiv(PL_DBtrace, 0);
3858 PL_DBsignal = GvSV((gv_fetchpv("DB::signal", GV_ADDMULTI, SVt_PV)));
3859 sv_setiv(PL_DBsignal, 0);
3860 PL_DBassertion = GvSV((gv_fetchpv("DB::assertion", GV_ADDMULTI, SVt_PV)));
3861 sv_setiv(PL_DBassertion, 0);
3862 PL_curstash = ostash;
3865 #ifndef STRESS_REALLOC
3866 #define REASONABLE(size) (size)
3868 #define REASONABLE(size) (1) /* unreasonable */
3872 Perl_init_stacks(pTHX)
3874 /* start with 128-item stack and 8K cxstack */
3875 PL_curstackinfo = new_stackinfo(REASONABLE(128),
3876 REASONABLE(8192/sizeof(PERL_CONTEXT) - 1));
3877 PL_curstackinfo->si_type = PERLSI_MAIN;
3878 PL_curstack = PL_curstackinfo->si_stack;
3879 PL_mainstack = PL_curstack; /* remember in case we switch stacks */
3881 PL_stack_base = AvARRAY(PL_curstack);
3882 PL_stack_sp = PL_stack_base;
3883 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
3885 New(50,PL_tmps_stack,REASONABLE(128),SV*);
3888 PL_tmps_max = REASONABLE(128);
3890 New(54,PL_markstack,REASONABLE(32),I32);
3891 PL_markstack_ptr = PL_markstack;
3892 PL_markstack_max = PL_markstack + REASONABLE(32);
3896 New(54,PL_scopestack,REASONABLE(32),I32);
3897 PL_scopestack_ix = 0;
3898 PL_scopestack_max = REASONABLE(32);
3900 New(54,PL_savestack,REASONABLE(128),ANY);
3901 PL_savestack_ix = 0;
3902 PL_savestack_max = REASONABLE(128);
3910 while (PL_curstackinfo->si_next)
3911 PL_curstackinfo = PL_curstackinfo->si_next;
3912 while (PL_curstackinfo) {
3913 PERL_SI *p = PL_curstackinfo->si_prev;
3914 /* curstackinfo->si_stack got nuked by sv_free_arenas() */
3915 Safefree(PL_curstackinfo->si_cxstack);
3916 Safefree(PL_curstackinfo);
3917 PL_curstackinfo = p;
3919 Safefree(PL_tmps_stack);
3920 Safefree(PL_markstack);
3921 Safefree(PL_scopestack);
3922 Safefree(PL_savestack);
3931 lex_start(PL_linestr);
3933 PL_subname = newSVpvn("main",4);
3937 S_init_predump_symbols(pTHX)
3942 sv_setpvn(get_sv("\"", TRUE), " ", 1);
3943 PL_stdingv = gv_fetchpv("STDIN",TRUE, SVt_PVIO);
3944 GvMULTI_on(PL_stdingv);
3945 io = GvIOp(PL_stdingv);
3946 IoTYPE(io) = IoTYPE_RDONLY;
3947 IoIFP(io) = PerlIO_stdin();
3948 tmpgv = gv_fetchpv("stdin",TRUE, SVt_PV);
3950 GvIOp(tmpgv) = (IO*)SvREFCNT_inc(io);
3952 tmpgv = gv_fetchpv("STDOUT",TRUE, SVt_PVIO);
3955 IoTYPE(io) = IoTYPE_WRONLY;
3956 IoOFP(io) = IoIFP(io) = PerlIO_stdout();
3958 tmpgv = gv_fetchpv("stdout",TRUE, SVt_PV);
3960 GvIOp(tmpgv) = (IO*)SvREFCNT_inc(io);
3962 PL_stderrgv = gv_fetchpv("STDERR",TRUE, SVt_PVIO);
3963 GvMULTI_on(PL_stderrgv);
3964 io = GvIOp(PL_stderrgv);
3965 IoTYPE(io) = IoTYPE_WRONLY;
3966 IoOFP(io) = IoIFP(io) = PerlIO_stderr();
3967 tmpgv = gv_fetchpv("stderr",TRUE, SVt_PV);
3969 GvIOp(tmpgv) = (IO*)SvREFCNT_inc(io);
3971 PL_statname = NEWSV(66,0); /* last filename we did stat on */
3974 Safefree(PL_osname);
3975 PL_osname = savepv(OSNAME);
3979 Perl_init_argv_symbols(pTHX_ register int argc, register char **argv)
3982 argc--,argv++; /* skip name of script */
3983 if (PL_doswitches) {
3984 for (; argc > 0 && **argv == '-'; argc--,argv++) {
3987 if (argv[0][1] == '-' && !argv[0][2]) {
3991 if ((s = strchr(argv[0], '='))) {
3993 sv_setpv(GvSV(gv_fetchpv(argv[0]+1,TRUE, SVt_PV)),s);
3996 sv_setiv(GvSV(gv_fetchpv(argv[0]+1,TRUE, SVt_PV)),1);
3999 if ((PL_argvgv = gv_fetchpv("ARGV",TRUE, SVt_PVAV))) {
4000 GvMULTI_on(PL_argvgv);
4001 (void)gv_AVadd(PL_argvgv);
4002 av_clear(GvAVn(PL_argvgv));
4003 for (; argc > 0; argc--,argv++) {
4004 SV *sv = newSVpv(argv[0],0);
4005 av_push(GvAVn(PL_argvgv),sv);
4006 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
4007 if (PL_unicode & PERL_UNICODE_ARGV_FLAG)
4010 if (PL_unicode & PERL_UNICODE_WIDESYSCALLS_FLAG) /* Sarathy? */
4011 (void)sv_utf8_decode(sv);
4016 #ifdef HAS_PROCSELFEXE
4017 /* This is a function so that we don't hold on to MAXPATHLEN
4018 bytes of stack longer than necessary
4021 S_procself_val(pTHX_ SV *sv, char *arg0)
4023 char buf[MAXPATHLEN];
4024 int len = readlink(PROCSELFEXE_PATH, buf, sizeof(buf) - 1);
4026 /* On Playstation2 Linux V1.0 (kernel 2.2.1) readlink(/proc/self/exe)
4027 includes a spurious NUL which will cause $^X to fail in system
4028 or backticks (this will prevent extensions from being built and
4029 many tests from working). readlink is not meant to add a NUL.
4030 Normal readlink works fine.
4032 if (len > 0 && buf[len-1] == '\0') {
4036 /* FreeBSD's implementation is acknowledged to be imperfect, sometimes
4037 returning the text "unknown" from the readlink rather than the path
4038 to the executable (or returning an error from the readlink). Any valid
4039 path has a '/' in it somewhere, so use that to validate the result.
4040 See http://www.freebsd.org/cgi/query-pr.cgi?pr=35703
4042 if (len > 0 && memchr(buf, '/', len)) {
4043 sv_setpvn(sv,buf,len);
4049 #endif /* HAS_PROCSELFEXE */
4052 S_init_postdump_symbols(pTHX_ register int argc, register char **argv, register char **env)
4058 PL_toptarget = NEWSV(0,0);
4059 sv_upgrade(PL_toptarget, SVt_PVFM);
4060 sv_setpvn(PL_toptarget, "", 0);
4061 PL_bodytarget = NEWSV(0,0);
4062 sv_upgrade(PL_bodytarget, SVt_PVFM);
4063 sv_setpvn(PL_bodytarget, "", 0);
4064 PL_formtarget = PL_bodytarget;
4068 init_argv_symbols(argc,argv);
4070 if ((tmpgv = gv_fetchpv("0",TRUE, SVt_PV))) {
4071 #ifdef MACOS_TRADITIONAL
4072 /* $0 is not majick on a Mac */
4073 sv_setpv(GvSV(tmpgv),MacPerl_MPWFileName(PL_origfilename));
4075 sv_setpv(GvSV(tmpgv),PL_origfilename);
4076 magicname("0", "0", 1);
4079 if ((tmpgv = gv_fetchpv("\030",TRUE, SVt_PV))) {/* $^X */
4080 #ifdef HAS_PROCSELFEXE
4081 S_procself_val(aTHX_ GvSV(tmpgv), PL_origargv[0]);
4084 sv_setpv(GvSV(tmpgv), os2_execname(aTHX));
4086 sv_setpv(GvSV(tmpgv),PL_origargv[0]);
4090 if ((PL_envgv = gv_fetchpv("ENV",TRUE, SVt_PVHV))) {
4092 GvMULTI_on(PL_envgv);
4093 hv = GvHVn(PL_envgv);
4094 hv_magic(hv, Nullgv, PERL_MAGIC_env);
4096 #ifdef USE_ENVIRON_ARRAY
4097 /* Note that if the supplied env parameter is actually a copy
4098 of the global environ then it may now point to free'd memory
4099 if the environment has been modified since. To avoid this
4100 problem we treat env==NULL as meaning 'use the default'
4105 # ifdef USE_ITHREADS
4106 && PL_curinterp == aTHX
4110 environ[0] = Nullch;
4113 char** origenv = environ;
4114 for (; *env; env++) {
4115 if (!(s = strchr(*env,'=')) || s == *env)
4117 #if defined(MSDOS) && !defined(DJGPP)
4122 sv = newSVpv(s+1, 0);
4123 (void)hv_store(hv, *env, s - *env, sv, 0);
4126 if (origenv != environ) {
4127 /* realloc has shifted us */
4128 env = (env - origenv) + environ;
4133 #endif /* USE_ENVIRON_ARRAY */
4134 #endif /* !PERL_MICRO */
4137 if ((tmpgv = gv_fetchpv("$",TRUE, SVt_PV))) {
4138 SvREADONLY_off(GvSV(tmpgv));
4139 sv_setiv(GvSV(tmpgv), (IV)PerlProc_getpid());
4140 SvREADONLY_on(GvSV(tmpgv));
4142 #ifdef THREADS_HAVE_PIDS
4143 PL_ppid = (IV)getppid();
4146 /* touch @F array to prevent spurious warnings 20020415 MJD */
4148 (void) get_av("main::F", TRUE | GV_ADDMULTI);
4150 /* touch @- and @+ arrays to prevent spurious warnings 20020415 MJD */
4151 (void) get_av("main::-", TRUE | GV_ADDMULTI);
4152 (void) get_av("main::+", TRUE | GV_ADDMULTI);
4156 S_init_perllib(pTHX)
4161 s = PerlEnv_getenv("PERL5LIB");
4163 incpush(s, TRUE, TRUE, TRUE);
4165 incpush(PerlEnv_getenv("PERLLIB"), FALSE, FALSE, TRUE);
4167 /* Treat PERL5?LIB as a possible search list logical name -- the
4168 * "natural" VMS idiom for a Unix path string. We allow each
4169 * element to be a set of |-separated directories for compatibility.
4173 if (my_trnlnm("PERL5LIB",buf,0))
4174 do { incpush(buf,TRUE,TRUE,TRUE); } while (my_trnlnm("PERL5LIB",buf,++idx));
4176 while (my_trnlnm("PERLLIB",buf,idx++)) incpush(buf,FALSE,FALSE,TRUE);
4180 /* Use the ~-expanded versions of APPLLIB (undocumented),
4181 ARCHLIB PRIVLIB SITEARCH SITELIB VENDORARCH and VENDORLIB
4184 incpush(APPLLIB_EXP, TRUE, TRUE, TRUE);
4188 incpush(ARCHLIB_EXP, FALSE, FALSE, TRUE);
4190 #ifdef MACOS_TRADITIONAL
4193 SV * privdir = NEWSV(55, 0);
4194 char * macperl = PerlEnv_getenv("MACPERL");
4199 Perl_sv_setpvf(aTHX_ privdir, "%slib:", macperl);
4200 if (PerlLIO_stat(SvPVX(privdir), &tmpstatbuf) >= 0 && S_ISDIR(tmpstatbuf.st_mode))
4201 incpush(SvPVX(privdir), TRUE, FALSE, TRUE);
4202 Perl_sv_setpvf(aTHX_ privdir, "%ssite_perl:", macperl);
4203 if (PerlLIO_stat(SvPVX(privdir), &tmpstatbuf) >= 0 && S_ISDIR(tmpstatbuf.st_mode))
4204 incpush(SvPVX(privdir), TRUE, FALSE, TRUE);
4206 SvREFCNT_dec(privdir);
4209 incpush(":", FALSE, FALSE, TRUE);
4212 # define PRIVLIB_EXP "/usr/local/lib/perl5:/usr/local/lib/perl"
4215 incpush(PRIVLIB_EXP, TRUE, FALSE, TRUE);
4217 incpush(PRIVLIB_EXP, FALSE, FALSE, TRUE);
4221 /* sitearch is always relative to sitelib on Windows for
4222 * DLL-based path intuition to work correctly */
4223 # if !defined(WIN32)
4224 incpush(SITEARCH_EXP, FALSE, FALSE, TRUE);
4230 /* this picks up sitearch as well */
4231 incpush(SITELIB_EXP, TRUE, FALSE, TRUE);
4233 incpush(SITELIB_EXP, FALSE, FALSE, TRUE);
4237 #ifdef SITELIB_STEM /* Search for version-specific dirs below here */
4238 incpush(SITELIB_STEM, FALSE, TRUE, TRUE);
4241 #ifdef PERL_VENDORARCH_EXP
4242 /* vendorarch is always relative to vendorlib on Windows for
4243 * DLL-based path intuition to work correctly */
4244 # if !defined(WIN32)
4245 incpush(PERL_VENDORARCH_EXP, FALSE, FALSE, TRUE);
4249 #ifdef PERL_VENDORLIB_EXP
4251 incpush(PERL_VENDORLIB_EXP, TRUE, FALSE, TRUE); /* this picks up vendorarch as well */
4253 incpush(PERL_VENDORLIB_EXP, FALSE, FALSE, TRUE);
4257 #ifdef PERL_VENDORLIB_STEM /* Search for version-specific dirs below here */
4258 incpush(PERL_VENDORLIB_STEM, FALSE, TRUE, TRUE);
4261 #ifdef PERL_OTHERLIBDIRS
4262 incpush(PERL_OTHERLIBDIRS, TRUE, TRUE, TRUE);
4266 incpush(".", FALSE, FALSE, TRUE);
4267 #endif /* MACOS_TRADITIONAL */
4270 #if defined(DOSISH) || defined(EPOC)
4271 # define PERLLIB_SEP ';'
4274 # define PERLLIB_SEP '|'
4276 # if defined(MACOS_TRADITIONAL)
4277 # define PERLLIB_SEP ','
4279 # define PERLLIB_SEP ':'
4283 #ifndef PERLLIB_MANGLE
4284 # define PERLLIB_MANGLE(s,n) (s)
4288 S_incpush(pTHX_ char *p, int addsubdirs, int addoldvers, int usesep)
4290 SV *subdir = Nullsv;
4295 if (addsubdirs || addoldvers) {
4296 subdir = sv_newmortal();
4299 /* Break at all separators */
4301 SV *libdir = NEWSV(55,0);
4304 /* skip any consecutive separators */
4306 while ( *p == PERLLIB_SEP ) {
4307 /* Uncomment the next line for PATH semantics */
4308 /* av_push(GvAVn(PL_incgv), newSVpvn(".", 1)); */
4313 if ( usesep && (s = strchr(p, PERLLIB_SEP)) != Nullch ) {
4314 sv_setpvn(libdir, PERLLIB_MANGLE(p, (STRLEN)(s - p)),
4319 sv_setpv(libdir, PERLLIB_MANGLE(p, 0));
4320 p = Nullch; /* break out */
4322 #ifdef MACOS_TRADITIONAL
4323 if (!strchr(SvPVX(libdir), ':')) {
4326 sv_setpv(libdir, MacPerl_CanonDir(SvPVX(libdir), buf, 0));
4328 if (SvPVX(libdir)[SvCUR(libdir)-1] != ':')
4329 sv_catpv(libdir, ":");
4333 * BEFORE pushing libdir onto @INC we may first push version- and
4334 * archname-specific sub-directories.
4336 if (addsubdirs || addoldvers) {
4337 #ifdef PERL_INC_VERSION_LIST
4338 /* Configure terminates PERL_INC_VERSION_LIST with a NULL */
4339 const char *incverlist[] = { PERL_INC_VERSION_LIST };
4340 const char **incver;
4347 if ((unix = tounixspec_ts(SvPV(libdir,len),Nullch)) != Nullch) {
4349 while (unix[len-1] == '/') len--; /* Cosmetic */
4350 sv_usepvn(libdir,unix,len);
4353 PerlIO_printf(Perl_error_log,
4354 "Failed to unixify @INC element \"%s\"\n",
4358 #ifdef MACOS_TRADITIONAL
4359 #define PERL_AV_SUFFIX_FMT ""
4360 #define PERL_ARCH_FMT "%s:"
4361 #define PERL_ARCH_FMT_PATH PERL_FS_VER_FMT PERL_AV_SUFFIX_FMT
4363 #define PERL_AV_SUFFIX_FMT "/"
4364 #define PERL_ARCH_FMT "/%s"
4365 #define PERL_ARCH_FMT_PATH PERL_AV_SUFFIX_FMT PERL_FS_VER_FMT
4367 /* .../version/archname if -d .../version/archname */
4368 Perl_sv_setpvf(aTHX_ subdir, "%"SVf PERL_ARCH_FMT_PATH PERL_ARCH_FMT,
4370 (int)PERL_REVISION, (int)PERL_VERSION,
4371 (int)PERL_SUBVERSION, ARCHNAME);
4372 if (PerlLIO_stat(SvPVX(subdir), &tmpstatbuf) >= 0 &&
4373 S_ISDIR(tmpstatbuf.st_mode))
4374 av_push(GvAVn(PL_incgv), newSVsv(subdir));
4376 /* .../version if -d .../version */
4377 Perl_sv_setpvf(aTHX_ subdir, "%"SVf PERL_ARCH_FMT_PATH, libdir,
4378 (int)PERL_REVISION, (int)PERL_VERSION,
4379 (int)PERL_SUBVERSION);
4380 if (PerlLIO_stat(SvPVX(subdir), &tmpstatbuf) >= 0 &&
4381 S_ISDIR(tmpstatbuf.st_mode))
4382 av_push(GvAVn(PL_incgv), newSVsv(subdir));
4384 /* .../archname if -d .../archname */
4385 Perl_sv_setpvf(aTHX_ subdir, "%"SVf PERL_ARCH_FMT, libdir, ARCHNAME);
4386 if (PerlLIO_stat(SvPVX(subdir), &tmpstatbuf) >= 0 &&
4387 S_ISDIR(tmpstatbuf.st_mode))
4388 av_push(GvAVn(PL_incgv), newSVsv(subdir));
4391 #ifdef PERL_INC_VERSION_LIST
4393 for (incver = incverlist; *incver; incver++) {
4394 /* .../xxx if -d .../xxx */
4395 Perl_sv_setpvf(aTHX_ subdir, "%"SVf PERL_ARCH_FMT, libdir, *incver);
4396 if (PerlLIO_stat(SvPVX(subdir), &tmpstatbuf) >= 0 &&
4397 S_ISDIR(tmpstatbuf.st_mode))
4398 av_push(GvAVn(PL_incgv), newSVsv(subdir));
4404 /* finally push this lib directory on the end of @INC */
4405 av_push(GvAVn(PL_incgv), libdir);
4409 #ifdef USE_5005THREADS
4410 STATIC struct perl_thread *
4411 S_init_main_thread(pTHX)
4413 #if !defined(PERL_IMPLICIT_CONTEXT)
4414 struct perl_thread *thr;
4418 Newz(53, thr, 1, struct perl_thread);
4419 PL_curcop = &PL_compiling;
4420 thr->interp = PERL_GET_INTERP;
4421 thr->cvcache = newHV();
4422 thr->threadsv = newAV();
4423 /* thr->threadsvp is set when find_threadsv is called */
4424 thr->specific = newAV();
4425 thr->flags = THRf_R_JOINABLE;
4426 MUTEX_INIT(&thr->mutex);
4427 /* Handcraft thrsv similarly to mess_sv */
4428 New(53, PL_thrsv, 1, SV);
4429 Newz(53, xpv, 1, XPV);
4430 SvFLAGS(PL_thrsv) = SVt_PV;
4431 SvANY(PL_thrsv) = (void*)xpv;
4432 SvREFCNT(PL_thrsv) = 1 << 30; /* practically infinite */
4433 SvPVX(PL_thrsv) = (char*)thr;
4434 SvCUR_set(PL_thrsv, sizeof(thr));
4435 SvLEN_set(PL_thrsv, sizeof(thr));
4436 *SvEND(PL_thrsv) = '\0'; /* in the trailing_nul field */
4437 thr->oursv = PL_thrsv;
4438 PL_chopset = " \n-";
4441 MUTEX_LOCK(&PL_threads_mutex);
4447 MUTEX_UNLOCK(&PL_threads_mutex);
4449 #ifdef HAVE_THREAD_INTERN
4450 Perl_init_thread_intern(thr);
4453 #ifdef SET_THREAD_SELF
4454 SET_THREAD_SELF(thr);
4456 thr->self = pthread_self();
4457 #endif /* SET_THREAD_SELF */
4461 * These must come after the thread self setting
4462 * because sv_setpvn does SvTAINT and the taint
4463 * fields thread selfness being set.
4465 PL_toptarget = NEWSV(0,0);
4466 sv_upgrade(PL_toptarget, SVt_PVFM);
4467 sv_setpvn(PL_toptarget, "", 0);
4468 PL_bodytarget = NEWSV(0,0);
4469 sv_upgrade(PL_bodytarget, SVt_PVFM);
4470 sv_setpvn(PL_bodytarget, "", 0);
4471 PL_formtarget = PL_bodytarget;
4472 thr->errsv = newSVpvn("", 0);
4473 (void) find_threadsv("@"); /* Ensure $@ is initialised early */
4476 PL_peepp = MEMBER_TO_FPTR(Perl_peep);
4477 PL_regcompp = MEMBER_TO_FPTR(Perl_pregcomp);
4478 PL_regexecp = MEMBER_TO_FPTR(Perl_regexec_flags);
4479 PL_regint_start = MEMBER_TO_FPTR(Perl_re_intuit_start);
4480 PL_regint_string = MEMBER_TO_FPTR(Perl_re_intuit_string);
4481 PL_regfree = MEMBER_TO_FPTR(Perl_pregfree);
4483 PL_reginterp_cnt = 0;
4487 #endif /* USE_5005THREADS */
4490 Perl_call_list(pTHX_ I32 oldscope, AV *paramList)
4493 line_t oldline = CopLINE(PL_curcop);
4499 while (AvFILL(paramList) >= 0) {
4500 cv = (CV*)av_shift(paramList);
4502 if (paramList == PL_beginav) {
4503 /* save PL_beginav for compiler */
4504 if (! PL_beginav_save)
4505 PL_beginav_save = newAV();
4506 av_push(PL_beginav_save, (SV*)cv);
4508 else if (paramList == PL_checkav) {
4509 /* save PL_checkav for compiler */
4510 if (! PL_checkav_save)
4511 PL_checkav_save = newAV();
4512 av_push(PL_checkav_save, (SV*)cv);
4517 #ifdef PERL_FLEXIBLE_EXCEPTIONS
4518 CALLPROTECT(aTHX_ pcur_env, &ret, MEMBER_TO_FPTR(S_vcall_list_body), cv);
4524 #ifndef PERL_FLEXIBLE_EXCEPTIONS
4528 (void)SvPV(atsv, len);
4530 PL_curcop = &PL_compiling;
4531 CopLINE_set(PL_curcop, oldline);
4532 if (paramList == PL_beginav)
4533 sv_catpv(atsv, "BEGIN failed--compilation aborted");
4535 Perl_sv_catpvf(aTHX_ atsv,
4536 "%s failed--call queue aborted",
4537 paramList == PL_checkav ? "CHECK"
4538 : paramList == PL_initav ? "INIT"
4540 while (PL_scopestack_ix > oldscope)
4543 Perl_croak(aTHX_ "%"SVf"", atsv);
4550 /* my_exit() was called */
4551 while (PL_scopestack_ix > oldscope)
4554 PL_curstash = PL_defstash;
4555 PL_curcop = &PL_compiling;
4556 CopLINE_set(PL_curcop, oldline);
4558 if (PL_statusvalue && !(PL_exit_flags & PERL_EXIT_EXPECTED)) {
4559 if (paramList == PL_beginav)
4560 Perl_croak(aTHX_ "BEGIN failed--compilation aborted");
4562 Perl_croak(aTHX_ "%s failed--call queue aborted",
4563 paramList == PL_checkav ? "CHECK"
4564 : paramList == PL_initav ? "INIT"
4571 PL_curcop = &PL_compiling;
4572 CopLINE_set(PL_curcop, oldline);
4575 PerlIO_printf(Perl_error_log, "panic: restartop\n");
4583 #ifdef PERL_FLEXIBLE_EXCEPTIONS
4585 S_vcall_list_body(pTHX_ va_list args)
4587 CV *cv = va_arg(args, CV*);
4588 return call_list_body(cv);
4593 S_call_list_body(pTHX_ CV *cv)
4595 PUSHMARK(PL_stack_sp);
4596 call_sv((SV*)cv, G_EVAL|G_DISCARD);
4601 Perl_my_exit(pTHX_ U32 status)
4603 DEBUG_S(PerlIO_printf(Perl_debug_log, "my_exit: thread %p, status %lu\n",
4604 thr, (unsigned long) status));
4613 STATUS_NATIVE_SET(status);
4620 Perl_my_failure_exit(pTHX)
4623 if (vaxc$errno & 1) {
4624 if (STATUS_NATIVE & 1) /* fortuitiously includes "-1" */
4625 STATUS_NATIVE_SET(44);
4628 if (!vaxc$errno) /* unlikely */
4629 STATUS_NATIVE_SET(44);
4631 STATUS_NATIVE_SET(vaxc$errno);
4636 STATUS_POSIX_SET(errno);
4638 exitstatus = STATUS_POSIX >> 8;
4639 if (exitstatus & 255)
4640 STATUS_POSIX_SET(exitstatus);
4642 STATUS_POSIX_SET(255);
4649 S_my_exit_jump(pTHX)
4651 register PERL_CONTEXT *cx;
4656 SvREFCNT_dec(PL_e_script);
4657 PL_e_script = Nullsv;
4660 POPSTACK_TO(PL_mainstack);
4661 if (cxstack_ix >= 0) {
4664 POPBLOCK(cx,PL_curpm);
4672 read_e_script(pTHX_ int idx, SV *buf_sv, int maxlen)
4675 p = SvPVX(PL_e_script);
4676 nl = strchr(p, '\n');
4677 nl = (nl) ? nl+1 : SvEND(PL_e_script);
4679 filter_del(read_e_script);
4682 sv_catpvn(buf_sv, p, nl-p);
4683 sv_chop(PL_e_script, nl);