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
17 * Be proud that perl(1) may proclaim:
18 * Setuid Perl scripts are safer than C programs ...
19 * Do not abandon (deprecate) suidperl. Do not advocate C wrappers.
21 * The flow was: perl starts, notices script is suid, execs suidperl with same
22 * arguments; suidperl opens script, checks many things, sets itself with
23 * right UID, execs perl with similar arguments but with script pre-opened on
24 * /dev/fd/xxx; perl checks script is as should be and does work. This was
25 * insecure: see perlsec(1) for many problems with this approach.
27 * The "correct" flow should be: perl starts, opens script and notices it is
28 * suid, checks many things, execs suidperl with similar arguments but with
29 * script on /dev/fd/xxx; suidperl checks script and /dev/fd/xxx object are
30 * same, checks arguments match #! line, sets itself with right UID, execs
31 * perl with same arguments; perl checks many things and does work.
33 * (Opening the script in perl instead of suidperl, we "lose" scripts that
34 * are readable to the target UID but not to the invoker. Where did
35 * unreadable scripts work anyway?)
37 * For now, suidperl and perl are pretty much the same large and cumbersome
38 * program, so suidperl can check its argument list (see comments elsewhere).
41 * Original bug report:
42 * http://bugs.perl.org/index.html?req=bug_id&bug_id=20010322.218
43 * http://rt.perl.org/rt2/Ticket/Display.html?id=6511
44 * Comments and discussion with Debian:
45 * http://bugs.debian.org/203426
46 * http://bugs.debian.org/220486
47 * Debian Security Advisory DSA 431-1 (does not fully fix problem):
48 * http://www.debian.org/security/2004/dsa-431
50 * http://cve.mitre.org/cgi-bin/cvename.cgi?name=CAN-2003-0618
51 * Previous versions of this patch sent to perl5-porters:
52 * http://www.mail-archive.com/perl5-porters@perl.org/msg71953.html
53 * http://www.mail-archive.com/perl5-porters@perl.org/msg75245.html
54 * http://www.mail-archive.com/perl5-porters@perl.org/msg75563.html
55 * http://www.mail-archive.com/perl5-porters@perl.org/msg75635.html
57 Paul Szabo - psz@maths.usyd.edu.au http://www.maths.usyd.edu.au:8000/u/psz/
58 School of Mathematics and Statistics University of Sydney 2006 Australia
62 * Use truthful, neat, specific error messages.
63 * Cannot always hide the truth; security must not depend on doing so.
67 * Use global(?), thread-local fdscript for easier checks.
68 * (I do not understand how we could possibly get a thread race:
69 * do not all threads go through the same initialization? Or in
70 * fact, are not threads started only after we get the script and
71 * so know what to do? Oh well, make things super-safe...)
75 #define PERL_IN_PERL_C
77 #include "patchlevel.h" /* for local_patches */
81 char *nw_get_sitelib(const char *pl);
84 /* XXX If this causes problems, set i_unistd=undef in the hint file. */
101 #if !defined(STANDARD_C) && !defined(HAS_GETENV_PROTOTYPE) && !defined(PERL_MICRO)
102 char *getenv (char *); /* Usually in <stdlib.h> */
105 static I32 read_e_script(pTHX_ int idx, SV *buf_sv, int maxlen);
113 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
119 #if defined(USE_ITHREADS)
120 # define INIT_TLS_AND_INTERP \
122 if (!PL_curinterp) { \
123 PERL_SET_INTERP(my_perl); \
126 PERL_SET_THX(my_perl); \
128 MUTEX_INIT(&PL_dollarzero_mutex); \
131 PERL_SET_THX(my_perl); \
135 # define INIT_TLS_AND_INTERP \
137 if (!PL_curinterp) { \
138 PERL_SET_INTERP(my_perl); \
140 PERL_SET_THX(my_perl); \
144 #ifdef PERL_IMPLICIT_SYS
146 perl_alloc_using(struct IPerlMem* ipM, struct IPerlMem* ipMS,
147 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
148 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
149 struct IPerlDir* ipD, struct IPerlSock* ipS,
150 struct IPerlProc* ipP)
152 PerlInterpreter *my_perl;
153 /* New() needs interpreter, so call malloc() instead */
154 my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
156 Zero(my_perl, 1, PerlInterpreter);
172 =head1 Embedding Functions
174 =for apidoc perl_alloc
176 Allocates a new Perl interpreter. See L<perlembed>.
184 PerlInterpreter *my_perl;
185 #ifdef USE_5005THREADS
189 /* New() needs interpreter, so call malloc() instead */
190 my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
193 Zero(my_perl, 1, PerlInterpreter);
196 #endif /* PERL_IMPLICIT_SYS */
199 =for apidoc perl_construct
201 Initializes a new Perl interpreter. See L<perlembed>.
207 perl_construct(pTHXx)
211 PL_perl_destruct_level = 1;
213 if (PL_perl_destruct_level > 0)
216 /* Init the real globals (and main thread)? */
218 #ifdef PERL_FLEXIBLE_EXCEPTIONS
219 PL_protect = MEMBER_TO_FPTR(Perl_default_protect); /* for exceptions */
222 PL_curcop = &PL_compiling; /* needed by ckWARN, right away */
224 PL_linestr = NEWSV(65,79);
225 sv_upgrade(PL_linestr,SVt_PVIV);
227 if (!SvREADONLY(&PL_sv_undef)) {
228 /* set read-only and try to insure than we wont see REFCNT==0
231 SvREADONLY_on(&PL_sv_undef);
232 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
234 sv_setpv(&PL_sv_no,PL_No);
236 SvREADONLY_on(&PL_sv_no);
237 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
239 sv_setpv(&PL_sv_yes,PL_Yes);
241 SvREADONLY_on(&PL_sv_yes);
242 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
244 SvREADONLY_on(&PL_sv_placeholder);
245 SvREFCNT(&PL_sv_placeholder) = (~(U32)0)/2;
248 PL_sighandlerp = Perl_sighandler;
249 PL_pidstatus = newHV();
252 PL_rs = newSVpvn("\n", 1);
257 PL_lex_state = LEX_NOTPARSING;
263 SET_NUMERIC_STANDARD();
267 PL_patchlevel = NEWSV(0,4);
268 (void)SvUPGRADE(PL_patchlevel, SVt_PVNV);
269 if (PERL_REVISION > 127 || PERL_VERSION > 127 || PERL_SUBVERSION > 127)
270 SvGROW(PL_patchlevel, UTF8_MAXLEN*3+1);
271 s = (U8*)SvPVX(PL_patchlevel);
272 /* Build version strings using "native" characters */
273 s = uvchr_to_utf8(s, (UV)PERL_REVISION);
274 s = uvchr_to_utf8(s, (UV)PERL_VERSION);
275 s = uvchr_to_utf8(s, (UV)PERL_SUBVERSION);
277 SvCUR_set(PL_patchlevel, s - (U8*)SvPVX(PL_patchlevel));
278 SvPOK_on(PL_patchlevel);
279 SvNVX(PL_patchlevel) = (NV)PERL_REVISION +
280 ((NV)PERL_VERSION / (NV)1000) +
281 ((NV)PERL_SUBVERSION / (NV)1000000);
282 SvNOK_on(PL_patchlevel); /* dual valued */
283 SvUTF8_on(PL_patchlevel);
284 SvREADONLY_on(PL_patchlevel);
287 #if defined(LOCAL_PATCH_COUNT)
288 PL_localpatches = local_patches; /* For possible -v */
291 #ifdef HAVE_INTERP_INTERN
295 PerlIO_init(aTHX); /* Hook to IO system */
297 PL_fdpid = newAV(); /* for remembering popen pids by fd */
298 PL_modglobal = newHV(); /* pointers to per-interpreter module globals */
299 PL_errors = newSVpvn("",0);
300 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
301 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
302 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
304 PL_regex_padav = newAV();
305 av_push(PL_regex_padav,(SV*)newAV()); /* First entry is an array of empty elements */
306 PL_regex_pad = AvARRAY(PL_regex_padav);
308 #ifdef USE_REENTRANT_API
309 Perl_reentrant_init(aTHX);
312 /* Note that strtab is a rather special HV. Assumptions are made
313 about not iterating on it, and not adding tie magic to it.
314 It is properly deallocated in perl_destruct() */
317 HvSHAREKEYS_off(PL_strtab); /* mandatory */
318 hv_ksplit(PL_strtab, 512);
320 #if defined(__DYNAMIC__) && (defined(NeXT) || defined(__NeXT__))
321 _dyld_lookup_and_bind
322 ("__environ", (unsigned long *) &environ_pointer, NULL);
326 # ifdef USE_ENVIRON_ARRAY
327 PL_origenviron = environ;
331 /* Use sysconf(_SC_CLK_TCK) if available, if not
332 * available or if the sysconf() fails, use the HZ. */
333 #if defined(HAS_SYSCONF) && defined(_SC_CLK_TCK)
334 PL_clocktick = sysconf(_SC_CLK_TCK);
335 if (PL_clocktick <= 0)
339 PL_stashcache = newHV();
345 =for apidoc nothreadhook
347 Stub that provides thread hook for perl_destruct when there are
354 Perl_nothreadhook(pTHX)
360 =for apidoc perl_destruct
362 Shuts down a Perl interpreter. See L<perlembed>.
370 volatile int destruct_level; /* 0=none, 1=full, 2=full with checks */
372 #ifdef USE_5005THREADS
374 #endif /* USE_5005THREADS */
376 /* wait for all pseudo-forked children to finish */
377 PERL_WAIT_FOR_CHILDREN;
379 destruct_level = PL_perl_destruct_level;
383 if ((s = PerlEnv_getenv("PERL_DESTRUCT_LEVEL"))) {
385 if (destruct_level < i)
392 if(PL_exit_flags & PERL_EXIT_DESTRUCT_END) {
397 if (PL_endav && !PL_minus_c)
398 call_list(PL_scopestack_ix, PL_endav);
404 /* Need to flush since END blocks can produce output */
407 if (CALL_FPTR(PL_threadhook)(aTHX)) {
408 /* Threads hook has vetoed further cleanup */
409 return STATUS_NATIVE_EXPORT;
412 /* We must account for everything. */
414 /* Destroy the main CV and syntax tree */
416 /* ensure comppad/curpad to refer to main's pad */
417 if (CvPADLIST(PL_main_cv)) {
418 PAD_SET_CUR_NOSAVE(CvPADLIST(PL_main_cv), 1);
420 op_free(PL_main_root);
421 PL_main_root = Nullop;
423 PL_curcop = &PL_compiling;
424 PL_main_start = Nullop;
425 SvREFCNT_dec(PL_main_cv);
429 /* Tell PerlIO we are about to tear things apart in case
430 we have layers which are using resources that should
434 PerlIO_destruct(aTHX);
436 if (PL_sv_objcount) {
438 * Try to destruct global references. We do this first so that the
439 * destructors and destructees still exist. Some sv's might remain.
440 * Non-referenced objects are on their own.
446 /* unhook hooks which will soon be, or use, destroyed data */
447 SvREFCNT_dec(PL_warnhook);
448 PL_warnhook = Nullsv;
449 SvREFCNT_dec(PL_diehook);
452 /* call exit list functions */
453 while (PL_exitlistlen-- > 0)
454 PL_exitlist[PL_exitlistlen].fn(aTHX_ PL_exitlist[PL_exitlistlen].ptr);
456 Safefree(PL_exitlist);
461 if (destruct_level == 0){
463 DEBUG_P(debprofdump());
465 #if defined(PERLIO_LAYERS)
466 /* No more IO - including error messages ! */
467 PerlIO_cleanup(aTHX);
470 /* The exit() function will do everything that needs doing. */
471 return STATUS_NATIVE_EXPORT;
474 /* jettison our possibly duplicated environment */
475 /* if PERL_USE_SAFE_PUTENV is defined environ will not have been copied
476 * so we certainly shouldn't free it here
479 #if defined(USE_ENVIRON_ARRAY) && !defined(PERL_USE_SAFE_PUTENV)
480 if (environ != PL_origenviron
482 /* only main thread can free environ[0] contents */
483 && PL_curinterp == aTHX
489 for (i = 0; environ[i]; i++)
490 safesysfree(environ[i]);
492 /* Must use safesysfree() when working with environ. */
493 safesysfree(environ);
495 environ = PL_origenviron;
498 #endif /* !PERL_MICRO */
501 /* the syntax tree is shared between clones
502 * so op_free(PL_main_root) only ReREFCNT_dec's
503 * REGEXPs in the parent interpreter
504 * we need to manually ReREFCNT_dec for the clones
507 I32 i = AvFILLp(PL_regex_padav) + 1;
508 SV **ary = AvARRAY(PL_regex_padav);
512 REGEXP *re = INT2PTR(REGEXP *,SvIVX(resv));
514 if (SvFLAGS(resv) & SVf_BREAK) {
515 /* this is PL_reg_curpm, already freed
516 * flag is set in regexec.c:S_regtry
518 SvFLAGS(resv) &= ~SVf_BREAK;
520 else if(SvREPADTMP(resv)) {
521 SvREPADTMP_off(resv);
528 SvREFCNT_dec(PL_regex_padav);
529 PL_regex_padav = Nullav;
533 SvREFCNT_dec((SV*) PL_stashcache);
534 PL_stashcache = NULL;
536 /* loosen bonds of global variables */
539 (void)PerlIO_close(PL_rsfp);
543 /* Filters for program text */
544 SvREFCNT_dec(PL_rsfp_filters);
545 PL_rsfp_filters = Nullav;
548 PL_preprocess = FALSE;
554 PL_doswitches = FALSE;
555 PL_dowarn = G_WARN_OFF;
556 PL_doextract = FALSE;
557 PL_sawampersand = FALSE; /* must save all match strings */
560 Safefree(PL_inplace);
562 SvREFCNT_dec(PL_patchlevel);
565 SvREFCNT_dec(PL_e_script);
566 PL_e_script = Nullsv;
571 /* magical thingies */
573 SvREFCNT_dec(PL_ofs_sv); /* $, */
576 SvREFCNT_dec(PL_ors_sv); /* $\ */
579 SvREFCNT_dec(PL_rs); /* $/ */
582 PL_multiline = 0; /* $* */
583 Safefree(PL_osname); /* $^O */
586 SvREFCNT_dec(PL_statname);
587 PL_statname = Nullsv;
590 /* defgv, aka *_ should be taken care of elsewhere */
592 /* clean up after study() */
593 SvREFCNT_dec(PL_lastscream);
594 PL_lastscream = Nullsv;
595 Safefree(PL_screamfirst);
597 Safefree(PL_screamnext);
601 Safefree(PL_efloatbuf);
602 PL_efloatbuf = Nullch;
605 /* startup and shutdown function lists */
606 SvREFCNT_dec(PL_beginav);
607 SvREFCNT_dec(PL_beginav_save);
608 SvREFCNT_dec(PL_endav);
609 SvREFCNT_dec(PL_checkav);
610 SvREFCNT_dec(PL_checkav_save);
611 SvREFCNT_dec(PL_initav);
613 PL_beginav_save = Nullav;
616 PL_checkav_save = Nullav;
619 /* shortcuts just get cleared */
625 PL_argvoutgv = Nullgv;
627 PL_stderrgv = Nullgv;
628 PL_last_in_gv = Nullgv;
633 PL_DBsingle = Nullsv;
635 PL_DBsignal = Nullsv;
636 PL_DBassertion = Nullsv;
639 PL_debstash = Nullhv;
641 /* reset so print() ends up where we expect */
644 SvREFCNT_dec(PL_argvout_stack);
645 PL_argvout_stack = Nullav;
647 SvREFCNT_dec(PL_modglobal);
648 PL_modglobal = Nullhv;
649 SvREFCNT_dec(PL_preambleav);
650 PL_preambleav = Nullav;
651 SvREFCNT_dec(PL_subname);
653 SvREFCNT_dec(PL_linestr);
655 SvREFCNT_dec(PL_pidstatus);
656 PL_pidstatus = Nullhv;
657 SvREFCNT_dec(PL_toptarget);
658 PL_toptarget = Nullsv;
659 SvREFCNT_dec(PL_bodytarget);
660 PL_bodytarget = Nullsv;
661 PL_formtarget = Nullsv;
663 /* free locale stuff */
664 #ifdef USE_LOCALE_COLLATE
665 Safefree(PL_collation_name);
666 PL_collation_name = Nullch;
669 #ifdef USE_LOCALE_NUMERIC
670 Safefree(PL_numeric_name);
671 PL_numeric_name = Nullch;
672 SvREFCNT_dec(PL_numeric_radix_sv);
673 PL_numeric_radix_sv = Nullsv;
676 /* clear utf8 character classes */
677 SvREFCNT_dec(PL_utf8_alnum);
678 SvREFCNT_dec(PL_utf8_alnumc);
679 SvREFCNT_dec(PL_utf8_ascii);
680 SvREFCNT_dec(PL_utf8_alpha);
681 SvREFCNT_dec(PL_utf8_space);
682 SvREFCNT_dec(PL_utf8_cntrl);
683 SvREFCNT_dec(PL_utf8_graph);
684 SvREFCNT_dec(PL_utf8_digit);
685 SvREFCNT_dec(PL_utf8_upper);
686 SvREFCNT_dec(PL_utf8_lower);
687 SvREFCNT_dec(PL_utf8_print);
688 SvREFCNT_dec(PL_utf8_punct);
689 SvREFCNT_dec(PL_utf8_xdigit);
690 SvREFCNT_dec(PL_utf8_mark);
691 SvREFCNT_dec(PL_utf8_toupper);
692 SvREFCNT_dec(PL_utf8_totitle);
693 SvREFCNT_dec(PL_utf8_tolower);
694 SvREFCNT_dec(PL_utf8_tofold);
695 SvREFCNT_dec(PL_utf8_idstart);
696 SvREFCNT_dec(PL_utf8_idcont);
697 PL_utf8_alnum = Nullsv;
698 PL_utf8_alnumc = Nullsv;
699 PL_utf8_ascii = Nullsv;
700 PL_utf8_alpha = Nullsv;
701 PL_utf8_space = Nullsv;
702 PL_utf8_cntrl = Nullsv;
703 PL_utf8_graph = Nullsv;
704 PL_utf8_digit = Nullsv;
705 PL_utf8_upper = Nullsv;
706 PL_utf8_lower = Nullsv;
707 PL_utf8_print = Nullsv;
708 PL_utf8_punct = Nullsv;
709 PL_utf8_xdigit = Nullsv;
710 PL_utf8_mark = Nullsv;
711 PL_utf8_toupper = Nullsv;
712 PL_utf8_totitle = Nullsv;
713 PL_utf8_tolower = Nullsv;
714 PL_utf8_tofold = Nullsv;
715 PL_utf8_idstart = Nullsv;
716 PL_utf8_idcont = Nullsv;
718 if (!specialWARN(PL_compiling.cop_warnings))
719 SvREFCNT_dec(PL_compiling.cop_warnings);
720 PL_compiling.cop_warnings = Nullsv;
721 if (!specialCopIO(PL_compiling.cop_io))
722 SvREFCNT_dec(PL_compiling.cop_io);
723 PL_compiling.cop_io = Nullsv;
724 CopFILE_free(&PL_compiling);
725 CopSTASH_free(&PL_compiling);
727 /* Prepare to destruct main symbol table. */
732 SvREFCNT_dec(PL_curstname);
733 PL_curstname = Nullsv;
735 /* clear queued errors */
736 SvREFCNT_dec(PL_errors);
740 if (destruct_level >= 2 && ckWARN_d(WARN_INTERNAL)) {
741 if (PL_scopestack_ix != 0)
742 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
743 "Unbalanced scopes: %ld more ENTERs than LEAVEs\n",
744 (long)PL_scopestack_ix);
745 if (PL_savestack_ix != 0)
746 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
747 "Unbalanced saves: %ld more saves than restores\n",
748 (long)PL_savestack_ix);
749 if (PL_tmps_floor != -1)
750 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced tmps: %ld more allocs than frees\n",
751 (long)PL_tmps_floor + 1);
752 if (cxstack_ix != -1)
753 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced context: %ld more PUSHes than POPs\n",
754 (long)cxstack_ix + 1);
757 /* Now absolutely destruct everything, somehow or other, loops or no. */
758 SvFLAGS(PL_fdpid) |= SVTYPEMASK; /* don't clean out pid table now */
759 SvFLAGS(PL_strtab) |= SVTYPEMASK; /* don't clean out strtab now */
761 /* the 2 is for PL_fdpid and PL_strtab */
762 while (PL_sv_count > 2 && sv_clean_all())
765 SvFLAGS(PL_fdpid) &= ~SVTYPEMASK;
766 SvFLAGS(PL_fdpid) |= SVt_PVAV;
767 SvFLAGS(PL_strtab) &= ~SVTYPEMASK;
768 SvFLAGS(PL_strtab) |= SVt_PVHV;
770 AvREAL_off(PL_fdpid); /* no surviving entries */
771 SvREFCNT_dec(PL_fdpid); /* needed in io_close() */
774 #ifdef HAVE_INTERP_INTERN
778 /* Destruct the global string table. */
780 /* Yell and reset the HeVAL() slots that are still holding refcounts,
781 * so that sv_free() won't fail on them.
789 max = HvMAX(PL_strtab);
790 array = HvARRAY(PL_strtab);
793 if (hent && ckWARN_d(WARN_INTERNAL)) {
794 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
795 "Unbalanced string table refcount: (%d) for \"%s\"",
796 HeVAL(hent) - Nullsv, HeKEY(hent));
797 HeVAL(hent) = Nullsv;
807 SvREFCNT_dec(PL_strtab);
810 /* free the pointer table used for cloning */
811 ptr_table_free(PL_ptr_table);
812 PL_ptr_table = (PTR_TBL_t*)NULL;
815 /* free special SVs */
817 SvREFCNT(&PL_sv_yes) = 0;
818 sv_clear(&PL_sv_yes);
819 SvANY(&PL_sv_yes) = NULL;
820 SvFLAGS(&PL_sv_yes) = 0;
822 SvREFCNT(&PL_sv_no) = 0;
824 SvANY(&PL_sv_no) = NULL;
825 SvFLAGS(&PL_sv_no) = 0;
829 for (i=0; i<=2; i++) {
830 SvREFCNT(PERL_DEBUG_PAD(i)) = 0;
831 sv_clear(PERL_DEBUG_PAD(i));
832 SvANY(PERL_DEBUG_PAD(i)) = NULL;
833 SvFLAGS(PERL_DEBUG_PAD(i)) = 0;
837 if (PL_sv_count != 0 && ckWARN_d(WARN_INTERNAL))
838 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Scalars leaked: %ld\n", (long)PL_sv_count);
840 #ifdef DEBUG_LEAKING_SCALARS
841 if (PL_sv_count != 0) {
846 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
847 svend = &sva[SvREFCNT(sva)];
848 for (sv = sva + 1; sv < svend; ++sv) {
849 if (SvTYPE(sv) != SVTYPEMASK) {
850 PerlIO_printf(Perl_debug_log, "leaked: 0x%p"
861 #if defined(PERLIO_LAYERS)
862 /* No more IO - including error messages ! */
863 PerlIO_cleanup(aTHX);
866 /* sv_undef needs to stay immortal until after PerlIO_cleanup
867 as currently layers use it rather than Nullsv as a marker
868 for no arg - and will try and SvREFCNT_dec it.
870 SvREFCNT(&PL_sv_undef) = 0;
871 SvREADONLY_off(&PL_sv_undef);
873 Safefree(PL_origfilename);
874 PL_origfilename = Nullch;
875 Safefree(PL_reg_start_tmp);
876 PL_reg_start_tmp = (char**)NULL;
877 PL_reg_start_tmpl = 0;
879 Safefree(PL_reg_curpm);
880 Safefree(PL_reg_poscache);
882 Safefree(PL_op_mask);
883 Safefree(PL_psig_ptr);
884 PL_psig_ptr = (SV**)NULL;
885 Safefree(PL_psig_name);
886 PL_psig_name = (SV**)NULL;
887 Safefree(PL_bitcount);
888 PL_bitcount = Nullch;
889 Safefree(PL_psig_pend);
890 PL_psig_pend = (int*)NULL;
891 PL_formfeed = Nullsv;
896 PL_taint_warn = FALSE;
897 PL_hints = 0; /* Reset hints. Should hints be per-interpreter ? */
900 DEBUG_P(debprofdump());
902 #ifdef USE_REENTRANT_API
903 Perl_reentrant_free(aTHX);
908 /* As the absolutely last thing, free the non-arena SV for mess() */
911 /* it could have accumulated taint magic */
912 if (SvTYPE(PL_mess_sv) >= SVt_PVMG) {
915 for (mg = SvMAGIC(PL_mess_sv); mg; mg = moremagic) {
916 moremagic = mg->mg_moremagic;
917 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global
919 Safefree(mg->mg_ptr);
923 /* we know that type >= SVt_PV */
924 (void)SvOOK_off(PL_mess_sv);
925 Safefree(SvPVX(PL_mess_sv));
926 Safefree(SvANY(PL_mess_sv));
927 Safefree(PL_mess_sv);
930 return STATUS_NATIVE_EXPORT;
934 =for apidoc perl_free
936 Releases a Perl interpreter. See L<perlembed>.
944 #if defined(WIN32) || defined(NETWARE)
945 # if defined(PERL_IMPLICIT_SYS)
947 void *host = nw_internal_host;
949 void *host = w32_internal_host;
953 nw_delete_internal_host(host);
955 win32_delete_internal_host(host);
966 Perl_call_atexit(pTHX_ ATEXIT_t fn, void *ptr)
968 Renew(PL_exitlist, PL_exitlistlen+1, PerlExitListEntry);
969 PL_exitlist[PL_exitlistlen].fn = fn;
970 PL_exitlist[PL_exitlistlen].ptr = ptr;
975 =for apidoc perl_parse
977 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
983 perl_parse(pTHXx_ XSINIT_t xsinit, int argc, char **argv, char **env)
988 #ifdef USE_5005THREADS
992 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
995 Perl_croak(aTHX_ "suidperl is no longer needed since the kernel can now execute\n\
996 setuid perl scripts securely.\n");
1000 #if defined(USE_HASH_SEED) || defined(USE_HASH_SEED_EXPLICIT)
1001 /* [perl #22371] Algorimic Complexity Attack on Perl 5.6.1, 5.8.0
1002 * This MUST be done before any hash stores or fetches take place.
1003 * If you set PL_rehash_seed (and assumedly also PL_rehash_seed_set)
1004 * yourself, it is your responsibility to provide a good random seed!
1005 * You can also define PERL_HASH_SEED in compile time, see hv.h. */
1006 if (!PL_rehash_seed_set)
1007 PL_rehash_seed = get_hash_seed();
1009 char *s = PerlEnv_getenv("PERL_HASH_SEED_DEBUG");
1015 PerlIO_printf(Perl_debug_log, "HASH_SEED = %"UVuf"\n",
1019 #endif /* #if defined(USE_HASH_SEED) || defined(USE_HASH_SEED_EXPLICIT) */
1025 /* Set PL_origalen be the sum of the contiguous argv[]
1026 * elements plus the size of the env in case that it is
1027 * contiguous with the argv[]. This is used in mg.c:Perl_magic_set()
1028 * as the maximum modifiable length of $0. In the worst case
1029 * the area we are able to modify is limited to the size of
1030 * the original argv[0]. (See below for 'contiguous', though.)
1035 ~(UV)(PTRSIZE == 4 ? 3 : PTRSIZE == 8 ? 7 : PTRSIZE == 16 ? 15 : 0);
1036 /* Do the mask check only if the args seem like aligned. */
1038 (mask < ~(UV)0) && ((PTR2UV(argv[0]) & mask) == PTR2UV(argv[0]));
1040 /* See if all the arguments are contiguous in memory. Note
1041 * that 'contiguous' is a loose term because some platforms
1042 * align the argv[] and the envp[]. If the arguments look
1043 * like non-aligned, assume that they are 'strictly' or
1044 * 'traditionally' contiguous. If the arguments look like
1045 * aligned, we just check that they are within aligned
1046 * PTRSIZE bytes. As long as no system has something bizarre
1047 * like the argv[] interleaved with some other data, we are
1048 * fine. (Did I just evoke Murphy's Law?) --jhi */
1049 if (PL_origargv && PL_origargc >= 1 && (s = PL_origargv[0])) {
1051 for (i = 1; i < PL_origargc; i++) {
1052 if ((PL_origargv[i] == s + 1
1054 || PL_origargv[i] == s + 2
1059 (PL_origargv[i] > s &&
1061 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1071 /* Can we grab env area too to be used as the area for $0? */
1072 if (PL_origenviron) {
1073 if ((PL_origenviron[0] == s + 1
1075 || (PL_origenviron[0] == s + 9 && (s += 8))
1080 (PL_origenviron[0] > s &&
1081 PL_origenviron[0] <=
1082 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1086 s = PL_origenviron[0];
1089 my_setenv("NoNe SuCh", Nullch);
1090 /* Force copy of environment. */
1091 for (i = 1; PL_origenviron[i]; i++) {
1092 if (PL_origenviron[i] == s + 1
1095 (PL_origenviron[i] > s &&
1096 PL_origenviron[i] <=
1097 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1100 s = PL_origenviron[i];
1108 PL_origalen = s - PL_origargv[0] + 1;
1113 /* Come here if running an undumped a.out. */
1115 PL_origfilename = savepv(argv[0]);
1116 PL_do_undump = FALSE;
1117 cxstack_ix = -1; /* start label stack again */
1119 init_postdump_symbols(argc,argv,env);
1124 op_free(PL_main_root);
1125 PL_main_root = Nullop;
1127 PL_main_start = Nullop;
1128 SvREFCNT_dec(PL_main_cv);
1129 PL_main_cv = Nullcv;
1132 oldscope = PL_scopestack_ix;
1133 PL_dowarn = G_WARN_OFF;
1135 #ifdef PERL_FLEXIBLE_EXCEPTIONS
1136 CALLPROTECT(aTHX_ pcur_env, &ret, MEMBER_TO_FPTR(S_vparse_body), env, xsinit);
1142 #ifndef PERL_FLEXIBLE_EXCEPTIONS
1143 parse_body(env,xsinit);
1146 call_list(oldscope, PL_checkav);
1153 /* my_exit() was called */
1154 while (PL_scopestack_ix > oldscope)
1157 PL_curstash = PL_defstash;
1159 call_list(oldscope, PL_checkav);
1160 ret = STATUS_NATIVE_EXPORT;
1163 PerlIO_printf(Perl_error_log, "panic: top_env\n");
1171 #ifdef PERL_FLEXIBLE_EXCEPTIONS
1173 S_vparse_body(pTHX_ va_list args)
1175 char **env = va_arg(args, char**);
1176 XSINIT_t xsinit = va_arg(args, XSINIT_t);
1178 return parse_body(env, xsinit);
1183 S_parse_body(pTHX_ char **env, XSINIT_t xsinit)
1185 int argc = PL_origargc;
1186 char **argv = PL_origargv;
1187 char *scriptname = NULL;
1188 VOL bool dosearch = FALSE;
1189 char *validarg = "";
1192 char *cddir = Nullch;
1196 sv_setpvn(PL_linestr,"",0);
1197 sv = newSVpvn("",0); /* first used for -I flags */
1201 for (argc--,argv++; argc > 0; argc--,argv++) {
1202 if (argv[0][0] != '-' || !argv[0][1])
1206 validarg = " PHOOEY ";
1210 * Can we rely on the kernel to start scripts with argv[1] set to
1211 * contain all #! line switches (the whole line)? (argv[0] is set to
1212 * the interpreter name, argv[2] to the script name; argv[3] and
1213 * above may contain other arguments.)
1220 #ifndef PERL_STRICT_CR
1245 if ((s = moreswitches(s)))
1250 CHECK_MALLOC_TOO_LATE_FOR('t');
1251 if( !PL_tainting ) {
1252 PL_taint_warn = TRUE;
1258 CHECK_MALLOC_TOO_LATE_FOR('T');
1260 PL_taint_warn = FALSE;
1265 #ifdef MACOS_TRADITIONAL
1266 /* ignore -e for Dev:Pseudo argument */
1267 if (argv[1] && !strcmp(argv[1], "Dev:Pseudo"))
1272 PL_e_script = newSVpvn("",0);
1273 filter_add(read_e_script, NULL);
1276 sv_catpv(PL_e_script, s);
1278 sv_catpv(PL_e_script, argv[1]);
1282 Perl_croak(aTHX_ "No code specified for -e");
1283 sv_catpv(PL_e_script, "\n");
1286 case 'I': /* -I handled both here and in moreswitches() */
1288 if (!*++s && (s=argv[1]) != Nullch) {
1293 STRLEN len = strlen(s);
1294 p = savepvn(s, len);
1295 incpush(p, TRUE, TRUE, FALSE);
1296 sv_catpvn(sv, "-I", 2);
1297 sv_catpvn(sv, p, len);
1298 sv_catpvn(sv, " ", 1);
1302 Perl_croak(aTHX_ "No directory specified for -I");
1306 PL_preprocess = TRUE;
1316 PL_preambleav = newAV();
1317 av_push(PL_preambleav, newSVpv("use Config qw(myconfig config_vars)",0));
1319 PL_Sv = newSVpv("print myconfig();",0);
1321 sv_catpv(PL_Sv,"print \"\\nCharacteristics of this PERLSHR image: \\n\",");
1323 sv_catpv(PL_Sv,"print \"\\nCharacteristics of this binary (from libperl): \\n\",");
1325 sv_catpv(PL_Sv,"\" Compile-time options:");
1327 sv_catpv(PL_Sv," DEBUGGING");
1329 # ifdef MULTIPLICITY
1330 sv_catpv(PL_Sv," MULTIPLICITY");
1332 # ifdef USE_5005THREADS
1333 sv_catpv(PL_Sv," USE_5005THREADS");
1335 # ifdef USE_ITHREADS
1336 sv_catpv(PL_Sv," USE_ITHREADS");
1338 # ifdef USE_64_BIT_INT
1339 sv_catpv(PL_Sv," USE_64_BIT_INT");
1341 # ifdef USE_64_BIT_ALL
1342 sv_catpv(PL_Sv," USE_64_BIT_ALL");
1344 # ifdef USE_LONG_DOUBLE
1345 sv_catpv(PL_Sv," USE_LONG_DOUBLE");
1347 # ifdef USE_LARGE_FILES
1348 sv_catpv(PL_Sv," USE_LARGE_FILES");
1351 sv_catpv(PL_Sv," USE_SOCKS");
1353 # ifdef PERL_IMPLICIT_CONTEXT
1354 sv_catpv(PL_Sv," PERL_IMPLICIT_CONTEXT");
1356 # ifdef PERL_IMPLICIT_SYS
1357 sv_catpv(PL_Sv," PERL_IMPLICIT_SYS");
1359 sv_catpv(PL_Sv,"\\n\",");
1361 #if defined(LOCAL_PATCH_COUNT)
1362 if (LOCAL_PATCH_COUNT > 0) {
1364 sv_catpv(PL_Sv,"\" Locally applied patches:\\n\",");
1365 for (i = 1; i <= LOCAL_PATCH_COUNT; i++) {
1366 if (PL_localpatches[i])
1367 Perl_sv_catpvf(aTHX_ PL_Sv,"q%c\t%s\n%c,",
1368 0, PL_localpatches[i], 0);
1372 Perl_sv_catpvf(aTHX_ PL_Sv,"\" Built under %s\\n\"",OSNAME);
1375 Perl_sv_catpvf(aTHX_ PL_Sv,",\" Compiled at %s %s\\n\"",__DATE__,__TIME__);
1377 Perl_sv_catpvf(aTHX_ PL_Sv,",\" Compiled on %s\\n\"",__DATE__);
1380 sv_catpv(PL_Sv, "; \
1382 @env = map { \"$_=\\\"$ENV{$_}\\\"\" } sort grep {/^PERL/} keys %ENV; ");
1385 push @env, \"CYGWIN=\\\"$ENV{CYGWIN}\\\"\";");
1388 print \" \\%ENV:\\n @env\\n\" if @env; \
1389 print \" \\@INC:\\n @INC\\n\";");
1392 PL_Sv = newSVpv("config_vars(qw(",0);
1393 sv_catpv(PL_Sv, ++s);
1394 sv_catpv(PL_Sv, "))");
1397 av_push(PL_preambleav, PL_Sv);
1398 scriptname = BIT_BUCKET; /* don't look for script or read stdin */
1401 PL_doextract = TRUE;
1409 if (!*++s || isSPACE(*s)) {
1413 /* catch use of gnu style long options */
1414 if (strEQ(s, "version")) {
1418 if (strEQ(s, "help")) {
1425 Perl_croak(aTHX_ "Unrecognized switch: -%s (-h will show valid options)",s);
1431 #ifndef SECURE_INTERNAL_GETENV
1434 (s = PerlEnv_getenv("PERL5OPT")))
1439 if (*s == '-' && *(s+1) == 'T') {
1440 CHECK_MALLOC_TOO_LATE_FOR('T');
1442 PL_taint_warn = FALSE;
1445 char *popt_copy = Nullch;
1458 if (!strchr("DIMUdmtwA", *s))
1459 Perl_croak(aTHX_ "Illegal switch in PERL5OPT: -%c", *s);
1463 popt_copy = SvPVX(sv_2mortal(newSVpv(popt,0)));
1464 s = popt_copy + (s - popt);
1465 d = popt_copy + (d - popt);
1472 if( !PL_tainting ) {
1473 PL_taint_warn = TRUE;
1483 if (PL_taint_warn && PL_dowarn != G_WARN_ALL_OFF) {
1484 PL_compiling.cop_warnings = newSVpvn(WARN_TAINTstring, WARNsize);
1488 scriptname = argv[0];
1491 scriptname = BIT_BUCKET; /* don't look for script or read stdin */
1493 else if (scriptname == Nullch) {
1495 if ( PerlLIO_isatty(PerlIO_fileno(PerlIO_stdin())) )
1503 open_script(scriptname,dosearch,sv);
1505 validate_suid(validarg, scriptname);
1508 #if defined(SIGCHLD) || defined(SIGCLD)
1511 # define SIGCHLD SIGCLD
1513 Sighandler_t sigstate = rsignal_state(SIGCHLD);
1514 if (sigstate == SIG_IGN) {
1515 if (ckWARN(WARN_SIGNAL))
1516 Perl_warner(aTHX_ packWARN(WARN_SIGNAL),
1517 "Can't ignore signal CHLD, forcing to default");
1518 (void)rsignal(SIGCHLD, (Sighandler_t)SIG_DFL);
1524 #ifdef MACOS_TRADITIONAL
1525 if (PL_doextract || gMacPerl_AlwaysExtract) {
1530 if (cddir && PerlDir_chdir(cddir) < 0)
1531 Perl_croak(aTHX_ "Can't chdir to %s",cddir);
1535 PL_main_cv = PL_compcv = (CV*)NEWSV(1104,0);
1536 sv_upgrade((SV *)PL_compcv, SVt_PVCV);
1537 CvUNIQUE_on(PL_compcv);
1539 CvPADLIST(PL_compcv) = pad_new(0);
1540 #ifdef USE_5005THREADS
1541 CvOWNER(PL_compcv) = 0;
1542 New(666, CvMUTEXP(PL_compcv), 1, perl_mutex);
1543 MUTEX_INIT(CvMUTEXP(PL_compcv));
1544 #endif /* USE_5005THREADS */
1547 boot_core_UNIVERSAL();
1548 boot_core_xsutils();
1551 (*xsinit)(aTHX); /* in case linked C routines want magical variables */
1553 #if defined(VMS) || defined(WIN32) || defined(DJGPP) || defined(__CYGWIN__) || defined(EPOC)
1559 # ifdef HAS_SOCKS5_INIT
1560 socks5_init(argv[0]);
1566 init_predump_symbols();
1567 /* init_postdump_symbols not currently designed to be called */
1568 /* more than once (ENV isn't cleared first, for example) */
1569 /* But running with -u leaves %ENV & @ARGV undefined! XXX */
1571 init_postdump_symbols(argc,argv,env);
1573 /* PL_unicode is turned on by -C or by $ENV{PERL_UNICODE}.
1574 * PL_utf8locale is conditionally turned on by
1575 * locale.c:Perl_init_i18nl10n() if the environment
1576 * look like the user wants to use UTF-8. */
1578 /* Requires init_predump_symbols(). */
1579 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
1584 /* Turn on UTF-8-ness on STDIN, STDOUT, STDERR
1585 * and the default open disciplines. */
1586 if ((PL_unicode & PERL_UNICODE_STDIN_FLAG) &&
1587 PL_stdingv && (io = GvIO(PL_stdingv)) &&
1589 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
1590 if ((PL_unicode & PERL_UNICODE_STDOUT_FLAG) &&
1591 PL_defoutgv && (io = GvIO(PL_defoutgv)) &&
1593 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
1594 if ((PL_unicode & PERL_UNICODE_STDERR_FLAG) &&
1595 PL_stderrgv && (io = GvIO(PL_stderrgv)) &&
1597 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
1598 if ((PL_unicode & PERL_UNICODE_INOUT_FLAG) &&
1599 (sv = GvSV(gv_fetchpv("\017PEN", TRUE, SVt_PV)))) {
1600 U32 in = PL_unicode & PERL_UNICODE_IN_FLAG;
1601 U32 out = PL_unicode & PERL_UNICODE_OUT_FLAG;
1604 sv_setpvn(sv, ":utf8\0:utf8", 11);
1606 sv_setpvn(sv, ":utf8\0", 6);
1609 sv_setpvn(sv, "\0:utf8", 6);
1615 if ((s = PerlEnv_getenv("PERL_SIGNALS"))) {
1616 if (strEQ(s, "unsafe"))
1617 PL_signals |= PERL_SIGNALS_UNSAFE_FLAG;
1618 else if (strEQ(s, "safe"))
1619 PL_signals &= ~PERL_SIGNALS_UNSAFE_FLAG;
1621 Perl_croak(aTHX_ "PERL_SIGNALS illegal: \"%s\"", s);
1626 /* now parse the script */
1628 SETERRNO(0,SS_NORMAL);
1630 #ifdef MACOS_TRADITIONAL
1631 if (gMacPerl_SyntaxError = (yyparse() || PL_error_count)) {
1633 Perl_croak(aTHX_ "%s had compilation errors.\n", MacPerl_MPWFileName(PL_origfilename));
1635 Perl_croak(aTHX_ "Execution of %s aborted due to compilation errors.\n",
1636 MacPerl_MPWFileName(PL_origfilename));
1640 if (yyparse() || PL_error_count) {
1642 Perl_croak(aTHX_ "%s had compilation errors.\n", PL_origfilename);
1644 Perl_croak(aTHX_ "Execution of %s aborted due to compilation errors.\n",
1649 CopLINE_set(PL_curcop, 0);
1650 PL_curstash = PL_defstash;
1651 PL_preprocess = FALSE;
1653 SvREFCNT_dec(PL_e_script);
1654 PL_e_script = Nullsv;
1661 SAVECOPFILE(PL_curcop);
1662 SAVECOPLINE(PL_curcop);
1663 gv_check(PL_defstash);
1670 if ((s=PerlEnv_getenv("PERL_DEBUG_MSTATS")) && atoi(s) >= 2)
1671 dump_mstats("after compilation:");
1680 =for apidoc perl_run
1682 Tells a Perl interpreter to run. See L<perlembed>.
1693 #ifdef USE_5005THREADS
1697 oldscope = PL_scopestack_ix;
1702 #ifdef PERL_FLEXIBLE_EXCEPTIONS
1704 CALLPROTECT(aTHX_ pcur_env, &ret, MEMBER_TO_FPTR(S_vrun_body), oldscope);
1710 cxstack_ix = -1; /* start context stack again */
1712 case 0: /* normal completion */
1713 #ifndef PERL_FLEXIBLE_EXCEPTIONS
1718 case 2: /* my_exit() */
1719 while (PL_scopestack_ix > oldscope)
1722 PL_curstash = PL_defstash;
1723 if (!(PL_exit_flags & PERL_EXIT_DESTRUCT_END) &&
1724 PL_endav && !PL_minus_c)
1725 call_list(oldscope, PL_endav);
1727 if (PerlEnv_getenv("PERL_DEBUG_MSTATS"))
1728 dump_mstats("after execution: ");
1730 ret = STATUS_NATIVE_EXPORT;
1734 POPSTACK_TO(PL_mainstack);
1737 PerlIO_printf(Perl_error_log, "panic: restartop\n");
1747 #ifdef PERL_FLEXIBLE_EXCEPTIONS
1749 S_vrun_body(pTHX_ va_list args)
1751 I32 oldscope = va_arg(args, I32);
1753 return run_body(oldscope);
1759 S_run_body(pTHX_ I32 oldscope)
1761 DEBUG_r(PerlIO_printf(Perl_debug_log, "%s $` $& $' support.\n",
1762 PL_sawampersand ? "Enabling" : "Omitting"));
1764 if (!PL_restartop) {
1765 DEBUG_x(dump_all());
1767 PERL_DEBUG(PerlIO_printf(Perl_debug_log, "\nEXECUTING...\n\n"));
1768 DEBUG_S(PerlIO_printf(Perl_debug_log, "main thread is 0x%"UVxf"\n",
1772 #ifdef MACOS_TRADITIONAL
1773 PerlIO_printf(Perl_error_log, "%s%s syntax OK\n",
1774 (gMacPerl_ErrorFormat ? "# " : ""),
1775 MacPerl_MPWFileName(PL_origfilename));
1777 PerlIO_printf(Perl_error_log, "%s syntax OK\n", PL_origfilename);
1781 if (PERLDB_SINGLE && PL_DBsingle)
1782 sv_setiv(PL_DBsingle, 1);
1784 call_list(oldscope, PL_initav);
1790 PL_op = PL_restartop;
1794 else if (PL_main_start) {
1795 CvDEPTH(PL_main_cv) = 1;
1796 PL_op = PL_main_start;
1806 =head1 SV Manipulation Functions
1808 =for apidoc p||get_sv
1810 Returns the SV of the specified Perl scalar. If C<create> is set and the
1811 Perl variable does not exist then it will be created. If C<create> is not
1812 set and the variable does not exist then NULL is returned.
1818 Perl_get_sv(pTHX_ const char *name, I32 create)
1821 #ifdef USE_5005THREADS
1822 if (name[1] == '\0' && !isALPHA(name[0])) {
1823 PADOFFSET tmp = find_threadsv(name);
1824 if (tmp != NOT_IN_PAD)
1825 return THREADSV(tmp);
1827 #endif /* USE_5005THREADS */
1828 gv = gv_fetchpv(name, create, SVt_PV);
1835 =head1 Array Manipulation Functions
1837 =for apidoc p||get_av
1839 Returns the AV of the specified Perl array. If C<create> is set and the
1840 Perl variable does not exist then it will be created. If C<create> is not
1841 set and the variable does not exist then NULL is returned.
1847 Perl_get_av(pTHX_ const char *name, I32 create)
1849 GV* gv = gv_fetchpv(name, create, SVt_PVAV);
1858 =head1 Hash Manipulation Functions
1860 =for apidoc p||get_hv
1862 Returns the HV of the specified Perl hash. If C<create> is set and the
1863 Perl variable does not exist then it will be created. If C<create> is not
1864 set and the variable does not exist then NULL is returned.
1870 Perl_get_hv(pTHX_ const char *name, I32 create)
1872 GV* gv = gv_fetchpv(name, create, SVt_PVHV);
1881 =head1 CV Manipulation Functions
1883 =for apidoc p||get_cv
1885 Returns the CV of the specified Perl subroutine. If C<create> is set and
1886 the Perl subroutine does not exist then it will be declared (which has the
1887 same effect as saying C<sub name;>). If C<create> is not set and the
1888 subroutine does not exist then NULL is returned.
1894 Perl_get_cv(pTHX_ const char *name, I32 create)
1896 GV* gv = gv_fetchpv(name, create, SVt_PVCV);
1897 /* XXX unsafe for threads if eval_owner isn't held */
1898 /* XXX this is probably not what they think they're getting.
1899 * It has the same effect as "sub name;", i.e. just a forward
1901 if (create && !GvCVu(gv))
1902 return newSUB(start_subparse(FALSE, 0),
1903 newSVOP(OP_CONST, 0, newSVpv(name,0)),
1911 /* Be sure to refetch the stack pointer after calling these routines. */
1915 =head1 Callback Functions
1917 =for apidoc p||call_argv
1919 Performs a callback to the specified Perl sub. See L<perlcall>.
1925 Perl_call_argv(pTHX_ const char *sub_name, I32 flags, register char **argv)
1927 /* See G_* flags in cop.h */
1928 /* null terminated arg list */
1935 XPUSHs(sv_2mortal(newSVpv(*argv,0)));
1940 return call_pv(sub_name, flags);
1944 =for apidoc p||call_pv
1946 Performs a callback to the specified Perl sub. See L<perlcall>.
1952 Perl_call_pv(pTHX_ const char *sub_name, I32 flags)
1953 /* name of the subroutine */
1954 /* See G_* flags in cop.h */
1956 return call_sv((SV*)get_cv(sub_name, TRUE), flags);
1960 =for apidoc p||call_method
1962 Performs a callback to the specified Perl method. The blessed object must
1963 be on the stack. See L<perlcall>.
1969 Perl_call_method(pTHX_ const char *methname, I32 flags)
1970 /* name of the subroutine */
1971 /* See G_* flags in cop.h */
1973 return call_sv(sv_2mortal(newSVpv(methname,0)), flags | G_METHOD);
1976 /* May be called with any of a CV, a GV, or an SV containing the name. */
1978 =for apidoc p||call_sv
1980 Performs a callback to the Perl sub whose name is in the SV. See
1987 Perl_call_sv(pTHX_ SV *sv, I32 flags)
1988 /* See G_* flags in cop.h */
1991 LOGOP myop; /* fake syntax tree node */
1994 volatile I32 retval = 0;
1996 bool oldcatch = CATCH_GET;
2001 if (flags & G_DISCARD) {
2006 Zero(&myop, 1, LOGOP);
2007 myop.op_next = Nullop;
2008 if (!(flags & G_NOARGS))
2009 myop.op_flags |= OPf_STACKED;
2010 myop.op_flags |= ((flags & G_VOID) ? OPf_WANT_VOID :
2011 (flags & G_ARRAY) ? OPf_WANT_LIST :
2016 EXTEND(PL_stack_sp, 1);
2017 *++PL_stack_sp = sv;
2019 oldscope = PL_scopestack_ix;
2021 if (PERLDB_SUB && PL_curstash != PL_debstash
2022 /* Handle first BEGIN of -d. */
2023 && (PL_DBcv || (PL_DBcv = GvCV(PL_DBsub)))
2024 /* Try harder, since this may have been a sighandler, thus
2025 * curstash may be meaningless. */
2026 && (SvTYPE(sv) != SVt_PVCV || CvSTASH((CV*)sv) != PL_debstash)
2027 && !(flags & G_NODEBUG))
2028 PL_op->op_private |= OPpENTERSUB_DB;
2030 if (flags & G_METHOD) {
2031 Zero(&method_op, 1, UNOP);
2032 method_op.op_next = PL_op;
2033 method_op.op_ppaddr = PL_ppaddr[OP_METHOD];
2034 myop.op_ppaddr = PL_ppaddr[OP_ENTERSUB];
2035 PL_op = (OP*)&method_op;
2038 if (!(flags & G_EVAL)) {
2040 call_body((OP*)&myop, FALSE);
2041 retval = PL_stack_sp - (PL_stack_base + oldmark);
2042 CATCH_SET(oldcatch);
2045 myop.op_other = (OP*)&myop;
2047 /* we're trying to emulate pp_entertry() here */
2049 register PERL_CONTEXT *cx;
2050 I32 gimme = GIMME_V;
2055 push_return(Nullop);
2056 PUSHBLOCK(cx, (CXt_EVAL|CXp_TRYBLOCK), PL_stack_sp);
2058 PL_eval_root = PL_op; /* Only needed so that goto works right. */
2060 PL_in_eval = EVAL_INEVAL;
2061 if (flags & G_KEEPERR)
2062 PL_in_eval |= EVAL_KEEPERR;
2068 #ifdef PERL_FLEXIBLE_EXCEPTIONS
2070 CALLPROTECT(aTHX_ pcur_env, &ret, MEMBER_TO_FPTR(S_vcall_body),
2077 #ifndef PERL_FLEXIBLE_EXCEPTIONS
2079 call_body((OP*)&myop, FALSE);
2081 retval = PL_stack_sp - (PL_stack_base + oldmark);
2082 if (!(flags & G_KEEPERR))
2089 /* my_exit() was called */
2090 PL_curstash = PL_defstash;
2093 if (PL_statusvalue && !(PL_exit_flags & PERL_EXIT_EXPECTED))
2094 Perl_croak(aTHX_ "Callback called exit");
2099 PL_op = PL_restartop;
2103 PL_stack_sp = PL_stack_base + oldmark;
2104 if (flags & G_ARRAY)
2108 *++PL_stack_sp = &PL_sv_undef;
2113 if (PL_scopestack_ix > oldscope) {
2117 register PERL_CONTEXT *cx;
2129 if (flags & G_DISCARD) {
2130 PL_stack_sp = PL_stack_base + oldmark;
2139 #ifdef PERL_FLEXIBLE_EXCEPTIONS
2141 S_vcall_body(pTHX_ va_list args)
2143 OP *myop = va_arg(args, OP*);
2144 int is_eval = va_arg(args, int);
2146 call_body(myop, is_eval);
2152 S_call_body(pTHX_ OP *myop, int is_eval)
2154 if (PL_op == myop) {
2156 PL_op = Perl_pp_entereval(aTHX); /* this doesn't do a POPMARK */
2158 PL_op = Perl_pp_entersub(aTHX); /* this does */
2164 /* Eval a string. The G_EVAL flag is always assumed. */
2167 =for apidoc p||eval_sv
2169 Tells Perl to C<eval> the string in the SV.
2175 Perl_eval_sv(pTHX_ SV *sv, I32 flags)
2177 /* See G_* flags in cop.h */
2180 UNOP myop; /* fake syntax tree node */
2181 volatile I32 oldmark = SP - PL_stack_base;
2182 volatile I32 retval = 0;
2188 if (flags & G_DISCARD) {
2195 Zero(PL_op, 1, UNOP);
2196 EXTEND(PL_stack_sp, 1);
2197 *++PL_stack_sp = sv;
2198 oldscope = PL_scopestack_ix;
2200 if (!(flags & G_NOARGS))
2201 myop.op_flags = OPf_STACKED;
2202 myop.op_next = Nullop;
2203 myop.op_type = OP_ENTEREVAL;
2204 myop.op_flags |= ((flags & G_VOID) ? OPf_WANT_VOID :
2205 (flags & G_ARRAY) ? OPf_WANT_LIST :
2207 if (flags & G_KEEPERR)
2208 myop.op_flags |= OPf_SPECIAL;
2210 #ifdef PERL_FLEXIBLE_EXCEPTIONS
2212 CALLPROTECT(aTHX_ pcur_env, &ret, MEMBER_TO_FPTR(S_vcall_body),
2219 #ifndef PERL_FLEXIBLE_EXCEPTIONS
2221 call_body((OP*)&myop,TRUE);
2223 retval = PL_stack_sp - (PL_stack_base + oldmark);
2224 if (!(flags & G_KEEPERR))
2231 /* my_exit() was called */
2232 PL_curstash = PL_defstash;
2235 if (PL_statusvalue && !(PL_exit_flags & PERL_EXIT_EXPECTED))
2236 Perl_croak(aTHX_ "Callback called exit");
2241 PL_op = PL_restartop;
2245 PL_stack_sp = PL_stack_base + oldmark;
2246 if (flags & G_ARRAY)
2250 *++PL_stack_sp = &PL_sv_undef;
2256 if (flags & G_DISCARD) {
2257 PL_stack_sp = PL_stack_base + oldmark;
2267 =for apidoc p||eval_pv
2269 Tells Perl to C<eval> the given string and return an SV* result.
2275 Perl_eval_pv(pTHX_ const char *p, I32 croak_on_error)
2278 SV* sv = newSVpv(p, 0);
2280 eval_sv(sv, G_SCALAR);
2287 if (croak_on_error && SvTRUE(ERRSV)) {
2289 Perl_croak(aTHX_ SvPVx(ERRSV, n_a));
2295 /* Require a module. */
2298 =head1 Embedding Functions
2300 =for apidoc p||require_pv
2302 Tells Perl to C<require> the file named by the string argument. It is
2303 analogous to the Perl code C<eval "require '$file'">. It's even
2304 implemented that way; consider using load_module instead.
2309 Perl_require_pv(pTHX_ const char *pv)
2313 PUSHSTACKi(PERLSI_REQUIRE);
2315 sv = sv_newmortal();
2316 sv_setpv(sv, "require '");
2319 eval_sv(sv, G_DISCARD);
2325 Perl_magicname(pTHX_ char *sym, char *name, I32 namlen)
2329 if ((gv = gv_fetchpv(sym,TRUE, SVt_PV)))
2330 sv_magic(GvSV(gv), (SV*)gv, PERL_MAGIC_sv, name, namlen);
2334 S_usage(pTHX_ char *name) /* XXX move this out into a module ? */
2336 /* This message really ought to be max 23 lines.
2337 * Removed -h because the user already knows that option. Others? */
2339 static char *usage_msg[] = {
2340 "-0[octal] specify record separator (\\0, if no argument)",
2341 "-a autosplit mode with -n or -p (splits $_ into @F)",
2342 "-C[number/list] enables the listed Unicode features",
2343 "-c check syntax only (runs BEGIN and CHECK blocks)",
2344 "-d[:debugger] run program under debugger",
2345 "-D[number/list] set debugging flags (argument is a bit mask or alphabets)",
2346 "-e program one line of program (several -e's allowed, omit programfile)",
2347 "-F/pattern/ split() pattern for -a switch (//'s are optional)",
2348 "-i[extension] edit <> files in place (makes backup if extension supplied)",
2349 "-Idirectory specify @INC/#include directory (several -I's allowed)",
2350 "-l[octal] enable line ending processing, specifies line terminator",
2351 "-[mM][-]module execute `use/no module...' before executing program",
2352 "-n assume 'while (<>) { ... }' loop around program",
2353 "-p assume loop like -n but print line also, like sed",
2354 "-P run program through C preprocessor before compilation",
2355 "-s enable rudimentary parsing for switches after programfile",
2356 "-S look for programfile using PATH environment variable",
2357 "-t enable tainting warnings",
2358 "-T enable tainting checks",
2359 "-u dump core after parsing program",
2360 "-U allow unsafe operations",
2361 "-v print version, subversion (includes VERY IMPORTANT perl info)",
2362 "-V[:variable] print configuration summary (or a single Config.pm variable)",
2363 "-w enable many useful warnings (RECOMMENDED)",
2364 "-W enable all warnings",
2365 "-x[directory] strip off text before #!perl line and perhaps cd to directory",
2366 "-X disable all warnings",
2370 char **p = usage_msg;
2372 PerlIO_printf(PerlIO_stdout(),
2373 "\nUsage: %s [switches] [--] [programfile] [arguments]",
2376 PerlIO_printf(PerlIO_stdout(), "\n %s", *p++);
2379 /* convert a string of -D options (or digits) into an int.
2380 * sets *s to point to the char after the options */
2384 Perl_get_debug_opts(pTHX_ char **s)
2386 static char *usage_msgd[] = {
2387 " Debugging flag values: (see also -d)",
2388 " p Tokenizing and parsing (with v, displays parse stack)",
2389 " s Stack snapshots. with v, displays all stacks",
2390 " l Context (loop) stack processing",
2391 " t Trace execution",
2392 " o Method and overloading resolution",
2393 " c String/numeric conversions",
2394 " P Print profiling info, preprocessor command for -P, source file input state",
2395 " m Memory allocation",
2396 " f Format processing",
2397 " r Regular expression parsing and execution",
2398 " x Syntax tree dump",
2399 " u Tainting checks (Obsolete, previously used for LEAKTEST)",
2400 " H Hash dump -- usurps values()",
2401 " X Scratchpad allocation",
2403 " S Thread synchronization",
2405 " R Include reference counts of dumped variables (eg when using -Ds)",
2406 " J Do not s,t,P-debug (Jump over) opcodes within package DB",
2407 " v Verbose: use in conjunction with other flags",
2409 " A Consistency checks on internal structures",
2410 " q quiet - currently only suppressed the 'EXECUTING' message",
2415 /* if adding extra options, remember to update DEBUG_MASK */
2416 static char debopts[] = "psltocPmfrxu HXDSTRJvCAq";
2418 for (; isALNUM(**s); (*s)++) {
2419 char *d = strchr(debopts,**s);
2421 i |= 1 << (d - debopts);
2422 else if (ckWARN_d(WARN_DEBUGGING))
2423 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
2424 "invalid option -D%c, use -D'' to see choices\n", **s);
2427 else if (isDIGIT(**s)) {
2429 for (; isALNUM(**s); (*s)++) ;
2432 char **p = usage_msgd;
2433 while (*p) PerlIO_printf(PerlIO_stdout(), "%s\n", *p++);
2436 if ((i & DEBUG_p_FLAG) && ckWARN_d(WARN_DEBUGGING))
2437 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
2438 "-Dp not implemented on this platform\n");
2444 /* This routine handles any switches that can be given during run */
2447 Perl_moreswitches(pTHX_ char *s)
2457 SvREFCNT_dec(PL_rs);
2458 if (s[1] == 'x' && s[2]) {
2462 for (s += 2, e = s; *e; e++);
2464 flags = PERL_SCAN_SILENT_ILLDIGIT;
2465 rschar = (U32)grok_hex(s, &numlen, &flags, NULL);
2466 if (s + numlen < e) {
2467 rschar = 0; /* Grandfather -0xFOO as -0 -xFOO. */
2471 PL_rs = newSVpvn("", 0);
2472 SvGROW(PL_rs, (STRLEN)(UNISKIP(rschar) + 1));
2473 tmps = (U8*)SvPVX(PL_rs);
2474 uvchr_to_utf8(tmps, rschar);
2475 SvCUR_set(PL_rs, UNISKIP(rschar));
2480 rschar = (U32)grok_oct(s, &numlen, &flags, NULL);
2481 if (rschar & ~((U8)~0))
2482 PL_rs = &PL_sv_undef;
2483 else if (!rschar && numlen >= 2)
2484 PL_rs = newSVpvn("", 0);
2486 char ch = (char)rschar;
2487 PL_rs = newSVpvn(&ch, 1);
2490 sv_setsv(get_sv("/", TRUE), PL_rs);
2495 PL_unicode = parse_unicode_opts(&s);
2500 while (*s && !isSPACE(*s)) ++s;
2502 PL_splitstr = savepv(PL_splitstr);
2515 /* The following permits -d:Mod to accepts arguments following an =
2516 in the fashion that -MSome::Mod does. */
2517 if (*s == ':' || *s == '=') {
2520 sv = newSVpv("use Devel::", 0);
2522 /* We now allow -d:Module=Foo,Bar */
2523 while(isALNUM(*s) || *s==':') ++s;
2525 sv_catpv(sv, start);
2527 sv_catpvn(sv, start, s-start);
2528 sv_catpv(sv, " split(/,/,q{");
2533 my_setenv("PERL5DB", SvPV(sv, PL_na));
2536 PL_perldb = PERLDB_ALL;
2545 PL_debug = get_debug_opts(&s) | DEBUG_TOP_FLAG;
2546 #else /* !DEBUGGING */
2547 if (ckWARN_d(WARN_DEBUGGING))
2548 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
2549 "Recompile perl with -DDEBUGGING to use -D switch (did you mean -d ?)\n");
2550 for (s++; isALNUM(*s); s++) ;
2556 usage(PL_origargv[0]);
2560 Safefree(PL_inplace);
2561 #if defined(__CYGWIN__) /* do backup extension automagically */
2562 if (*(s+1) == '\0') {
2563 PL_inplace = savepv(".bak");
2566 #endif /* __CYGWIN__ */
2567 PL_inplace = savepv(s+1);
2569 for (s = PL_inplace; *s && !isSPACE(*s); s++) ;
2572 if (*s == '-') /* Additional switches on #! line. */
2576 case 'I': /* -I handled both here and in parse_body() */
2579 while (*s && isSPACE(*s))
2584 /* ignore trailing spaces (possibly followed by other switches) */
2586 for (e = p; *e && !isSPACE(*e); e++) ;
2590 } while (*p && *p != '-');
2591 e = savepvn(s, e-s);
2592 incpush(e, TRUE, TRUE, FALSE);
2599 Perl_croak(aTHX_ "No directory specified for -I");
2605 SvREFCNT_dec(PL_ors_sv);
2610 PL_ors_sv = newSVpvn("\n",1);
2611 numlen = 3 + (*s == '0');
2612 *SvPVX(PL_ors_sv) = (char)grok_oct(s, &numlen, &flags, NULL);
2616 if (RsPARA(PL_rs)) {
2617 PL_ors_sv = newSVpvn("\n\n",2);
2620 PL_ors_sv = newSVsv(PL_rs);
2627 PL_preambleav = newAV();
2629 SV *sv = newSVpv("use assertions::activate split(/,/,q", 0);
2630 sv_catpvn(sv, "\0", 1); /* Use NUL as q//-delimiter. */
2632 sv_catpvn(sv, "\0)", 2);
2634 av_push(PL_preambleav, sv);
2637 av_push(PL_preambleav, newSVpvn("use assertions::activate",24));
2640 forbid_setid("-M"); /* XXX ? */
2643 forbid_setid("-m"); /* XXX ? */
2648 /* -M-foo == 'no foo' */
2649 if (*s == '-') { use = "no "; ++s; }
2650 sv = newSVpv(use,0);
2652 /* We allow -M'Module qw(Foo Bar)' */
2653 while(isALNUM(*s) || *s==':') ++s;
2655 sv_catpv(sv, start);
2656 if (*(start-1) == 'm') {
2658 Perl_croak(aTHX_ "Can't use '%c' after -mname", *s);
2659 sv_catpv( sv, " ()");
2663 Perl_croak(aTHX_ "Module name required with -%c option",
2665 sv_catpvn(sv, start, s-start);
2666 sv_catpv(sv, " split(/,/,q");
2667 sv_catpvn(sv, "\0)", 1); /* Use NUL as q//-delimiter. */
2669 sv_catpvn(sv, "\0)", 2);
2673 PL_preambleav = newAV();
2674 av_push(PL_preambleav, sv);
2677 Perl_croak(aTHX_ "No space allowed after -%c", *(s-1));
2689 PL_doswitches = TRUE;
2703 #ifdef MACOS_TRADITIONAL
2704 Perl_croak(aTHX_ "Believe me, you don't want to use \"-u\" on a Macintosh");
2706 PL_do_undump = TRUE;
2715 PerlIO_printf(PerlIO_stdout(),
2716 Perl_form(aTHX_ "\nThis is perl, v%"VDf" built for %s",
2717 PL_patchlevel, ARCHNAME));
2719 /* Adjust verbose output as in the perl that ships with the DG/UX OS from EMC */
2720 PerlIO_printf(PerlIO_stdout(),
2721 Perl_form(aTHX_ "\nThis is perl, version %vd\n", PL_patchlevel));
2722 PerlIO_printf(PerlIO_stdout(),
2723 Perl_form(aTHX_ " built under %s at %s %s\n",
2724 OSNAME, __DATE__, __TIME__));
2725 PerlIO_printf(PerlIO_stdout(),
2726 Perl_form(aTHX_ " OS Specific Release: %s\n",
2730 #if defined(LOCAL_PATCH_COUNT)
2731 if (LOCAL_PATCH_COUNT > 0)
2732 PerlIO_printf(PerlIO_stdout(),
2733 "\n(with %d registered patch%s, "
2734 "see perl -V for more detail)",
2735 (int)LOCAL_PATCH_COUNT,
2736 (LOCAL_PATCH_COUNT!=1) ? "es" : "");
2739 PerlIO_printf(PerlIO_stdout(),
2740 "\n\nCopyright 1987-2004, Larry Wall\n");
2741 #ifdef MACOS_TRADITIONAL
2742 PerlIO_printf(PerlIO_stdout(),
2743 "\nMac OS port Copyright 1991-2002, Matthias Neeracher;\n"
2744 "maintained by Chris Nandor\n");
2747 PerlIO_printf(PerlIO_stdout(),
2748 "\nMS-DOS port Copyright (c) 1989, 1990, Diomidis Spinellis\n");
2751 PerlIO_printf(PerlIO_stdout(),
2752 "djgpp v2 port (jpl5003c) by Hirofumi Watanabe, 1996\n"
2753 "djgpp v2 port (perl5004+) by Laszlo Molnar, 1997-1999\n");
2756 PerlIO_printf(PerlIO_stdout(),
2757 "\n\nOS/2 port Copyright (c) 1990, 1991, Raymond Chen, Kai Uwe Rommel\n"
2758 "Version 5 port Copyright (c) 1994-2002, Andreas Kaiser, Ilya Zakharevich\n");
2761 PerlIO_printf(PerlIO_stdout(),
2762 "atariST series port, ++jrb bammi@cadence.com\n");
2765 PerlIO_printf(PerlIO_stdout(),
2766 "BeOS port Copyright Tom Spindler, 1997-1999\n");
2769 PerlIO_printf(PerlIO_stdout(),
2770 "MPE/iX port Copyright by Mark Klein and Mark Bixby, 1996-2003\n");
2773 PerlIO_printf(PerlIO_stdout(),
2774 "MVS (OS390) port by Mortice Kern Systems, 1997-1999\n");
2777 PerlIO_printf(PerlIO_stdout(),
2778 "Stratus VOS port by Paul.Green@stratus.com, 1997-2002\n");
2781 PerlIO_printf(PerlIO_stdout(),
2782 "VM/ESA port by Neale Ferguson, 1998-1999\n");
2785 PerlIO_printf(PerlIO_stdout(),
2786 "BS2000 (POSIX) port by Start Amadeus GmbH, 1998-1999\n");
2789 PerlIO_printf(PerlIO_stdout(),
2790 "MiNT port by Guido Flohr, 1997-1999\n");
2793 PerlIO_printf(PerlIO_stdout(),
2794 "EPOC port by Olaf Flebbe, 1999-2002\n");
2797 PerlIO_printf(PerlIO_stdout(),"WINCE port by Rainer Keuchel, 2001-2002\n");
2798 PerlIO_printf(PerlIO_stdout(),"Built on " __DATE__ " " __TIME__ "\n\n");
2801 #ifdef BINARY_BUILD_NOTICE
2802 BINARY_BUILD_NOTICE;
2804 PerlIO_printf(PerlIO_stdout(),
2806 Perl may be copied only under the terms of either the Artistic License or the\n\
2807 GNU General Public License, which may be found in the Perl 5 source kit.\n\n\
2808 Complete documentation for Perl, including FAQ lists, should be found on\n\
2809 this system using `man perl' or `perldoc perl'. If you have access to the\n\
2810 Internet, point your browser at http://www.perl.com/, the Perl Home Page.\n\n");
2813 if (! (PL_dowarn & G_WARN_ALL_MASK))
2814 PL_dowarn |= G_WARN_ON;
2818 PL_dowarn = G_WARN_ALL_ON|G_WARN_ON;
2819 if (!specialWARN(PL_compiling.cop_warnings))
2820 SvREFCNT_dec(PL_compiling.cop_warnings);
2821 PL_compiling.cop_warnings = pWARN_ALL ;
2825 PL_dowarn = G_WARN_ALL_OFF;
2826 if (!specialWARN(PL_compiling.cop_warnings))
2827 SvREFCNT_dec(PL_compiling.cop_warnings);
2828 PL_compiling.cop_warnings = pWARN_NONE ;
2833 if (s[1] == '-') /* Additional switches on #! line. */
2838 #if defined(WIN32) || !defined(PERL_STRICT_CR)
2844 #ifdef ALTERNATE_SHEBANG
2845 case 'S': /* OS/2 needs -S on "extproc" line. */
2853 Perl_croak(aTHX_ "Can't emulate -%.1s on #! line",s);
2858 /* compliments of Tom Christiansen */
2860 /* unexec() can be found in the Gnu emacs distribution */
2861 /* Known to work with -DUNEXEC and using unexelf.c from GNU emacs-20.2 */
2864 Perl_my_unexec(pTHX)
2872 prog = newSVpv(BIN_EXP, 0);
2873 sv_catpv(prog, "/perl");
2874 file = newSVpv(PL_origfilename, 0);
2875 sv_catpv(file, ".perldump");
2877 unexec(SvPVX(file), SvPVX(prog), &etext, sbrk(0), 0);
2878 /* unexec prints msg to stderr in case of failure */
2879 PerlProc_exit(status);
2882 # include <lib$routines.h>
2883 lib$signal(SS$_DEBUG); /* ssdef.h #included from vmsish.h */
2885 ABORT(); /* for use with undump */
2890 /* initialize curinterp */
2896 # define PERLVAR(var,type)
2897 # define PERLVARA(var,n,type)
2898 # if defined(PERL_IMPLICIT_CONTEXT)
2899 # if defined(USE_5005THREADS)
2900 # define PERLVARI(var,type,init) PERL_GET_INTERP->var = init;
2901 # define PERLVARIC(var,type,init) PERL_GET_INTERP->var = init;
2902 # else /* !USE_5005THREADS */
2903 # define PERLVARI(var,type,init) aTHX->var = init;
2904 # define PERLVARIC(var,type,init) aTHX->var = init;
2905 # endif /* USE_5005THREADS */
2907 # define PERLVARI(var,type,init) PERL_GET_INTERP->var = init;
2908 # define PERLVARIC(var,type,init) PERL_GET_INTERP->var = init;
2910 # include "intrpvar.h"
2911 # ifndef USE_5005THREADS
2912 # include "thrdvar.h"
2919 # define PERLVAR(var,type)
2920 # define PERLVARA(var,n,type)
2921 # define PERLVARI(var,type,init) PL_##var = init;
2922 # define PERLVARIC(var,type,init) PL_##var = init;
2923 # include "intrpvar.h"
2924 # ifndef USE_5005THREADS
2925 # include "thrdvar.h"
2936 S_init_main_stash(pTHX)
2940 PL_curstash = PL_defstash = newHV();
2941 PL_curstname = newSVpvn("main",4);
2942 gv = gv_fetchpv("main::",TRUE, SVt_PVHV);
2943 SvREFCNT_dec(GvHV(gv));
2944 GvHV(gv) = (HV*)SvREFCNT_inc(PL_defstash);
2946 HvNAME(PL_defstash) = savepv("main");
2947 PL_incgv = gv_HVadd(gv_AVadd(gv_fetchpv("INC",TRUE, SVt_PVAV)));
2948 GvMULTI_on(PL_incgv);
2949 PL_hintgv = gv_fetchpv("\010",TRUE, SVt_PV); /* ^H */
2950 GvMULTI_on(PL_hintgv);
2951 PL_defgv = gv_fetchpv("_",TRUE, SVt_PVAV);
2952 PL_errgv = gv_HVadd(gv_fetchpv("@", TRUE, SVt_PV));
2953 GvMULTI_on(PL_errgv);
2954 PL_replgv = gv_fetchpv("\022", TRUE, SVt_PV); /* ^R */
2955 GvMULTI_on(PL_replgv);
2956 (void)Perl_form(aTHX_ "%240s",""); /* Preallocate temp - for immediate signals. */
2957 sv_grow(ERRSV, 240); /* Preallocate - for immediate signals. */
2958 sv_setpvn(ERRSV, "", 0);
2959 PL_curstash = PL_defstash;
2960 CopSTASH_set(&PL_compiling, PL_defstash);
2961 PL_debstash = GvHV(gv_fetchpv("DB::", GV_ADDMULTI, SVt_PVHV));
2962 PL_globalstash = GvHV(gv_fetchpv("CORE::GLOBAL::", GV_ADDMULTI, SVt_PVHV));
2963 /* We must init $/ before switches are processed. */
2964 sv_setpvn(get_sv("/", TRUE), "\n", 1);
2967 /* PSz 18 Nov 03 fdscript now global but do not change prototype */
2969 S_open_script(pTHX_ char *scriptname, bool dosearch, SV *sv)
2974 char *cpp_discard_flag;
2982 PL_origfilename = savepv("-e");
2985 /* if find_script() returns, it returns a malloc()-ed value */
2986 PL_origfilename = scriptname = find_script(scriptname, dosearch, NULL, 1);
2988 if (strnEQ(scriptname, "/dev/fd/", 8) && isDIGIT(scriptname[8]) ) {
2989 char *s = scriptname + 8;
2990 PL_fdscript = atoi(s);
2995 * Tell apart "normal" usage of fdscript, e.g.
2996 * with bash on FreeBSD:
2997 * perl <( echo '#!perl -DA'; echo 'print "$0\n"')
2998 * from usage in suidperl.
2999 * Does any "normal" usage leave garbage after the number???
3000 * Is it a mistake to use a similar /dev/fd/ construct for
3005 * Be supersafe and do some sanity-checks.
3006 * Still, can we be sure we got the right thing?
3009 Perl_croak(aTHX_ "Wrong syntax (suid) fd script name \"%s\"\n", s);
3012 Perl_croak(aTHX_ "Missing (suid) fd script name\n");
3014 scriptname = savepv(s + 1);
3015 Safefree(PL_origfilename);
3016 PL_origfilename = scriptname;
3021 CopFILE_free(PL_curcop);
3022 CopFILE_set(PL_curcop, PL_origfilename);
3023 if (strEQ(PL_origfilename,"-"))
3025 if (PL_fdscript >= 0) {
3026 PL_rsfp = PerlIO_fdopen(PL_fdscript,PERL_SCRIPT_MODE);
3027 # if defined(HAS_FCNTL) && defined(F_SETFD)
3029 /* ensure close-on-exec */
3030 fcntl(PerlIO_fileno(PL_rsfp),F_SETFD,1);
3035 Perl_croak(aTHX_ "sperl needs fd script\n"
3036 "You should not call sperl directly; do you need to "
3037 "change a #! line\nfrom sperl to perl?\n");
3040 * Do not open (or do other fancy stuff) while setuid.
3041 * Perl does the open, and hands script to suidperl on a fd;
3042 * suidperl only does some checks, sets up UIDs and re-execs
3043 * perl with that fd as it has always done.
3046 if (PL_suidscript != 1) {
3047 Perl_croak(aTHX_ "suidperl needs (suid) fd script\n");
3050 else if (PL_preprocess) {
3051 char *cpp_cfg = CPPSTDIN;
3052 SV *cpp = newSVpvn("",0);
3053 SV *cmd = NEWSV(0,0);
3055 if (cpp_cfg[0] == 0) /* PERL_MICRO? */
3056 Perl_croak(aTHX_ "Can't run with cpp -P with CPPSTDIN undefined");
3057 if (strEQ(cpp_cfg, "cppstdin"))
3058 Perl_sv_catpvf(aTHX_ cpp, "%s/", BIN_EXP);
3059 sv_catpv(cpp, cpp_cfg);
3062 sv_catpvn(sv, "-I", 2);
3063 sv_catpv(sv,PRIVLIB_EXP);
3066 DEBUG_P(PerlIO_printf(Perl_debug_log,
3067 "PL_preprocess: scriptname=\"%s\", cpp=\"%s\", sv=\"%s\", CPPMINUS=\"%s\"\n",
3068 scriptname, SvPVX (cpp), SvPVX (sv), CPPMINUS));
3070 # if defined(MSDOS) || defined(WIN32) || defined(VMS)
3077 cpp_discard_flag = "";
3079 cpp_discard_flag = "-C";
3083 perl = os2_execname(aTHX);
3085 perl = PL_origargv[0];
3089 /* This strips off Perl comments which might interfere with
3090 the C pre-processor, including #!. #line directives are
3091 deliberately stripped to avoid confusion with Perl's version
3092 of #line. FWP played some golf with it so it will fit
3093 into VMS's 255 character buffer.
3096 code = "(1../^#!.*perl/i)|/^\\s*#(?!\\s*((ifn?|un)def|(el|end)?if|define|include|else|error|pragma)\\b)/||!($|=1)||print";
3098 code = "/^\\s*#(?!\\s*((ifn?|un)def|(el|end)?if|define|include|else|error|pragma)\\b)/||!($|=1)||print";
3100 Perl_sv_setpvf(aTHX_ cmd, "\
3101 %s -ne%s%s%s %s | %"SVf" %s %"SVf" %s",
3102 perl, quote, code, quote, scriptname, cpp,
3103 cpp_discard_flag, sv, CPPMINUS);
3105 PL_doextract = FALSE;
3107 DEBUG_P(PerlIO_printf(Perl_debug_log,
3108 "PL_preprocess: cmd=\"%s\"\n",
3111 PL_rsfp = PerlProc_popen(SvPVX(cmd), "r");
3115 else if (!*scriptname) {
3116 forbid_setid("program input from stdin");
3117 PL_rsfp = PerlIO_stdin();
3120 PL_rsfp = PerlIO_open(scriptname,PERL_SCRIPT_MODE);
3121 # if defined(HAS_FCNTL) && defined(F_SETFD)
3123 /* ensure close-on-exec */
3124 fcntl(PerlIO_fileno(PL_rsfp),F_SETFD,1);
3127 #endif /* IAMSUID */
3129 /* PSz 16 Sep 03 Keep neat error message */
3130 Perl_croak(aTHX_ "Can't open perl script \"%s\": %s%s\n",
3131 CopFILE(PL_curcop), Strerror(errno),
3132 ".\nUse -S to search $PATH for it.");
3137 * I_SYSSTATVFS HAS_FSTATVFS
3139 * I_STATFS HAS_FSTATFS HAS_GETFSSTAT
3140 * I_MNTENT HAS_GETMNTENT HAS_HASMNTOPT
3141 * here so that metaconfig picks them up. */
3145 S_fd_on_nosuid_fs(pTHX_ int fd)
3148 * We used to do this as "plain" user (after swapping UIDs with setreuid);
3149 * but is needed also on machines without setreuid.
3150 * Seems safe enough to run as root.
3152 int check_okay = 0; /* able to do all the required sys/libcalls */
3153 int on_nosuid = 0; /* the fd is on a nosuid fs */
3155 * Need to check noexec also: nosuid might not be set, the average
3156 * sysadmin would say that nosuid is irrelevant once he sets noexec.
3158 int on_noexec = 0; /* the fd is on a noexec fs */
3161 * Preferred order: fstatvfs(), fstatfs(), ustat()+getmnt(), getmntent().
3162 * fstatvfs() is UNIX98.
3163 * fstatfs() is 4.3 BSD.
3164 * ustat()+getmnt() is pre-4.3 BSD.
3165 * getmntent() is O(number-of-mounted-filesystems) and can hang on
3166 * an irrelevant filesystem while trying to reach the right one.
3169 #undef FD_ON_NOSUID_CHECK_OKAY /* found the syscalls to do the check? */
3171 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3172 defined(HAS_FSTATVFS)
3173 # define FD_ON_NOSUID_CHECK_OKAY
3174 struct statvfs stfs;
3176 check_okay = fstatvfs(fd, &stfs) == 0;
3177 on_nosuid = check_okay && (stfs.f_flag & ST_NOSUID);
3179 /* ST_NOEXEC certainly absent on AIX 5.1, and doesn't seem to be documented
3180 on platforms where it is present. */
3181 on_noexec = check_okay && (stfs.f_flag & ST_NOEXEC);
3183 # endif /* fstatvfs */
3185 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3186 defined(PERL_MOUNT_NOSUID) && \
3187 defined(PERL_MOUNT_NOEXEC) && \
3188 defined(HAS_FSTATFS) && \
3189 defined(HAS_STRUCT_STATFS) && \
3190 defined(HAS_STRUCT_STATFS_F_FLAGS)
3191 # define FD_ON_NOSUID_CHECK_OKAY
3194 check_okay = fstatfs(fd, &stfs) == 0;
3195 on_nosuid = check_okay && (stfs.f_flags & PERL_MOUNT_NOSUID);
3196 on_noexec = check_okay && (stfs.f_flags & PERL_MOUNT_NOEXEC);
3197 # endif /* fstatfs */
3199 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3200 defined(PERL_MOUNT_NOSUID) && \
3201 defined(PERL_MOUNT_NOEXEC) && \
3202 defined(HAS_FSTAT) && \
3203 defined(HAS_USTAT) && \
3204 defined(HAS_GETMNT) && \
3205 defined(HAS_STRUCT_FS_DATA) && \
3207 # define FD_ON_NOSUID_CHECK_OKAY
3210 if (fstat(fd, &fdst) == 0) {
3212 if (ustat(fdst.st_dev, &us) == 0) {
3214 /* NOSTAT_ONE here because we're not examining fields which
3215 * vary between that case and STAT_ONE. */
3216 if (getmnt((int*)0, &fsd, (int)0, NOSTAT_ONE, us.f_fname) == 0) {
3217 size_t cmplen = sizeof(us.f_fname);
3218 if (sizeof(fsd.fd_req.path) < cmplen)
3219 cmplen = sizeof(fsd.fd_req.path);
3220 if (strnEQ(fsd.fd_req.path, us.f_fname, cmplen) &&
3221 fdst.st_dev == fsd.fd_req.dev) {
3223 on_nosuid = fsd.fd_req.flags & PERL_MOUNT_NOSUID;
3224 on_noexec = fsd.fd_req.flags & PERL_MOUNT_NOEXEC;
3230 # endif /* fstat+ustat+getmnt */
3232 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3233 defined(HAS_GETMNTENT) && \
3234 defined(HAS_HASMNTOPT) && \
3235 defined(MNTOPT_NOSUID) && \
3236 defined(MNTOPT_NOEXEC)
3237 # define FD_ON_NOSUID_CHECK_OKAY
3238 FILE *mtab = fopen("/etc/mtab", "r");
3239 struct mntent *entry;
3242 if (mtab && (fstat(fd, &stb) == 0)) {
3243 while (entry = getmntent(mtab)) {
3244 if (stat(entry->mnt_dir, &fsb) == 0
3245 && fsb.st_dev == stb.st_dev)
3247 /* found the filesystem */
3249 if (hasmntopt(entry, MNTOPT_NOSUID))
3251 if (hasmntopt(entry, MNTOPT_NOEXEC))
3254 } /* A single fs may well fail its stat(). */
3259 # endif /* getmntent+hasmntopt */
3262 Perl_croak(aTHX_ "Can't check filesystem of script \"%s\" for nosuid/noexec", PL_origfilename);
3264 Perl_croak(aTHX_ "Setuid script \"%s\" on nosuid filesystem", PL_origfilename);
3266 Perl_croak(aTHX_ "Setuid script \"%s\" on noexec filesystem", PL_origfilename);
3267 return ((!check_okay) || on_nosuid || on_noexec);
3269 #endif /* IAMSUID */
3272 S_validate_suid(pTHX_ char *validarg, char *scriptname)
3276 #endif /* IAMSUID */
3278 /* do we need to emulate setuid on scripts? */
3280 /* This code is for those BSD systems that have setuid #! scripts disabled
3281 * in the kernel because of a security problem. Merely defining DOSUID
3282 * in perl will not fix that problem, but if you have disabled setuid
3283 * scripts in the kernel, this will attempt to emulate setuid and setgid
3284 * on scripts that have those now-otherwise-useless bits set. The setuid
3285 * root version must be called suidperl or sperlN.NNN. If regular perl
3286 * discovers that it has opened a setuid script, it calls suidperl with
3287 * the same argv that it had. If suidperl finds that the script it has
3288 * just opened is NOT setuid root, it sets the effective uid back to the
3289 * uid. We don't just make perl setuid root because that loses the
3290 * effective uid we had before invoking perl, if it was different from the
3293 * Description/comments above do not match current workings:
3294 * suidperl must be hardlinked to sperlN.NNN (that is what we exec);
3295 * suidperl called with script open and name changed to /dev/fd/N/X;
3296 * suidperl croaks if script is not setuid;
3297 * making perl setuid would be a huge security risk (and yes, that
3298 * would lose any euid we might have had).
3300 * DOSUID must be defined in both perl and suidperl, and IAMSUID must
3301 * be defined in suidperl only. suidperl must be setuid root. The
3302 * Configure script will set this up for you if you want it.
3308 if (PerlLIO_fstat(PerlIO_fileno(PL_rsfp),&PL_statbuf) < 0) /* normal stat is insecure */
3309 Perl_croak(aTHX_ "Can't stat script \"%s\"",PL_origfilename);
3310 if (PL_statbuf.st_mode & (S_ISUID|S_ISGID)) {
3315 if (PL_fdscript < 0 || PL_suidscript != 1)
3316 Perl_croak(aTHX_ "Need (suid) fdscript in suidperl\n"); /* We already checked this */
3318 * Since the script is opened by perl, not suidperl, some of these
3319 * checks are superfluous. Leaving them in probably does not lower
3323 * Do checks even for systems with no HAS_SETREUID.
3324 * We used to swap, then re-swap UIDs with
3326 if (setreuid(PL_euid,PL_uid) < 0
3327 || PerlProc_getuid() != PL_euid || PerlProc_geteuid() != PL_uid)
3328 Perl_croak(aTHX_ "Can't swap uid and euid");
3331 if (setreuid(PL_uid,PL_euid) < 0
3332 || PerlProc_getuid() != PL_uid || PerlProc_geteuid() != PL_euid)
3333 Perl_croak(aTHX_ "Can't reswap uid and euid");
3337 /* On this access check to make sure the directories are readable,
3338 * there is actually a small window that the user could use to make
3339 * filename point to an accessible directory. So there is a faint
3340 * chance that someone could execute a setuid script down in a
3341 * non-accessible directory. I don't know what to do about that.
3342 * But I don't think it's too important. The manual lies when
3343 * it says access() is useful in setuid programs.
3345 * So, access() is pretty useless... but not harmful... do anyway.
3347 if (PerlLIO_access(CopFILE(PL_curcop),1)) { /*double check*/
3348 Perl_croak(aTHX_ "Can't access() script\n");
3351 /* If we can swap euid and uid, then we can determine access rights
3352 * with a simple stat of the file, and then compare device and
3353 * inode to make sure we did stat() on the same file we opened.
3354 * Then we just have to make sure he or she can execute it.
3357 * As the script is opened by perl, not suidperl, we do not need to
3358 * care much about access rights.
3360 * The 'script changed' check is needed, or we can get lied to
3361 * about $0 with e.g.
3362 * suidperl /dev/fd/4//bin/x 4<setuidscript
3363 * Without HAS_SETREUID, is it safe to stat() as root?
3365 * Are there any operating systems that pass /dev/fd/xxx for setuid
3366 * scripts, as suggested/described in perlsec(1)? Surely they do not
3367 * pass the script name as we do, so the "script changed" test would
3368 * fail for them... but we never get here with
3369 * SETUID_SCRIPTS_ARE_SECURE_NOW defined.
3371 * This is one place where we must "lie" about return status: not
3372 * say if the stat() failed. We are doing this as root, and could
3373 * be tricked into reporting existence or not of files that the
3374 * "plain" user cannot even see.
3378 if (PerlLIO_stat(CopFILE(PL_curcop),&tmpstatbuf) < 0 ||
3379 tmpstatbuf.st_dev != PL_statbuf.st_dev ||
3380 tmpstatbuf.st_ino != PL_statbuf.st_ino) {
3381 Perl_croak(aTHX_ "Setuid script changed\n");
3385 if (!cando(S_IXUSR,FALSE,&PL_statbuf)) /* can real uid exec? */
3386 Perl_croak(aTHX_ "Real UID cannot exec script\n");
3389 * We used to do this check as the "plain" user (after swapping
3390 * UIDs). But the check for nosuid and noexec filesystem is needed,
3391 * and should be done even without HAS_SETREUID. (Maybe those
3392 * operating systems do not have such mount options anyway...)
3393 * Seems safe enough to do as root.
3395 #if !defined(NO_NOSUID_CHECK)
3396 if (fd_on_nosuid_fs(PerlIO_fileno(PL_rsfp))) {
3397 Perl_croak(aTHX_ "Setuid script on nosuid or noexec filesystem\n");
3400 #endif /* IAMSUID */
3402 if (!S_ISREG(PL_statbuf.st_mode)) {
3403 Perl_croak(aTHX_ "Setuid script not plain file\n");
3405 if (PL_statbuf.st_mode & S_IWOTH)
3406 Perl_croak(aTHX_ "Setuid/gid script is writable by world");
3407 PL_doswitches = FALSE; /* -s is insecure in suid */
3408 /* PSz 13 Nov 03 But -s was caught elsewhere ... so unsetting it here is useless(?!) */
3409 CopLINE_inc(PL_curcop);
3410 if (sv_gets(PL_linestr, PL_rsfp, 0) == Nullch ||
3411 strnNE(SvPV(PL_linestr,n_a),"#!",2) ) /* required even on Sys V */
3412 Perl_croak(aTHX_ "No #! line");
3413 s = SvPV(PL_linestr,n_a)+2;
3415 /* Sanity check on line length */
3416 if (strlen(s) < 1 || strlen(s) > 4000)
3417 Perl_croak(aTHX_ "Very long #! line");
3418 /* Allow more than a single space after #! */
3419 while (isSPACE(*s)) s++;
3420 /* Sanity check on buffer end */
3421 while ((*s) && !isSPACE(*s)) s++;
3422 for (s2 = s; (s2 > SvPV(PL_linestr,n_a)+2 &&
3423 (isDIGIT(s2[-1]) || strchr("._-", s2[-1]))); s2--) ;
3424 /* Sanity check on buffer start */
3425 if ( (s2-4 < SvPV(PL_linestr,n_a)+2 || strnNE(s2-4,"perl",4)) &&
3426 (s-9 < SvPV(PL_linestr,n_a)+2 || strnNE(s-9,"perl",4)) )
3427 Perl_croak(aTHX_ "Not a perl script");
3428 while (*s == ' ' || *s == '\t') s++;
3430 * #! arg must be what we saw above. They can invoke it by
3431 * mentioning suidperl explicitly, but they may not add any strange
3432 * arguments beyond what #! says if they do invoke suidperl that way.
3435 * The way validarg was set up, we rely on the kernel to start
3436 * scripts with argv[1] set to contain all #! line switches (the
3440 * Check that we got all the arguments listed in the #! line (not
3441 * just that there are no extraneous arguments). Might not matter
3442 * much, as switches from #! line seem to be acted upon (also), and
3443 * so may be checked and trapped in perl. But, security checks must
3444 * be done in suidperl and not deferred to perl. Note that suidperl
3445 * does not get around to parsing (and checking) the switches on
3446 * the #! line (but execs perl sooner).
3447 * Allow (require) a trailing newline (which may be of two
3448 * characters on some architectures?) (but no other trailing
3451 len = strlen(validarg);
3452 if (strEQ(validarg," PHOOEY ") ||
3453 strnNE(s,validarg,len) || !isSPACE(s[len]) ||
3454 !(strlen(s) == len+1 || (strlen(s) == len+2 && isSPACE(s[len+1]))))
3455 Perl_croak(aTHX_ "Args must match #! line");
3458 if (PL_fdscript < 0 &&
3459 PL_euid != PL_uid && (PL_statbuf.st_mode & S_ISUID) &&
3460 PL_euid == PL_statbuf.st_uid)
3462 Perl_croak(aTHX_ "YOU HAVEN'T DISABLED SET-ID SCRIPTS IN THE KERNEL YET!\n\
3463 FIX YOUR KERNEL, OR PUT A C WRAPPER AROUND THIS SCRIPT!\n");
3464 #endif /* IAMSUID */
3466 if (PL_fdscript < 0 &&
3467 PL_euid) { /* oops, we're not the setuid root perl */
3469 * When root runs a setuid script, we do not go through the same
3470 * steps of execing sperl and then perl with fd scripts, but
3471 * simply set up UIDs within the same perl invocation; so do
3472 * not have the same checks (on options, whatever) that we have
3473 * for plain users. No problem really: would have to be a script
3474 * that does not actually work for plain users; and if root is
3475 * foolish and can be persuaded to run such an unsafe script, he
3476 * might run also non-setuid ones, and deserves what he gets.
3478 * Or, we might drop the PL_euid check above (and rely just on
3479 * PL_fdscript to avoid loops), and do the execs
3485 * Pass fd script to suidperl.
3486 * Exec suidperl, substituting fd script for scriptname.
3487 * Pass script name as "subdir" of fd, which perl will grok;
3488 * in fact will use that to distinguish this from "normal"
3489 * usage, see comments above.
3491 PerlIO_rewind(PL_rsfp);
3492 PerlLIO_lseek(PerlIO_fileno(PL_rsfp),(Off_t)0,0); /* just in case rewind didn't */
3493 /* PSz 27 Feb 04 Sanity checks on scriptname */
3494 if ((!scriptname) || (!*scriptname) ) {
3495 Perl_croak(aTHX_ "No setuid script name\n");
3497 if (*scriptname == '-') {
3498 Perl_croak(aTHX_ "Setuid script name may not begin with dash\n");
3499 /* Or we might confuse it with an option when replacing
3500 * name in argument list, below (though we do pointer, not
3501 * string, comparisons).
3504 for (which = 1; PL_origargv[which] && PL_origargv[which] != scriptname; which++) ;
3505 if (!PL_origargv[which]) {
3506 Perl_croak(aTHX_ "Can't change argv to have fd script\n");
3508 PL_origargv[which] = savepv(Perl_form(aTHX_ "/dev/fd/%d/%s",
3509 PerlIO_fileno(PL_rsfp), PL_origargv[which]));
3510 #if defined(HAS_FCNTL) && defined(F_SETFD)
3511 fcntl(PerlIO_fileno(PL_rsfp),F_SETFD,0); /* ensure no close-on-exec */
3514 PerlProc_execv(Perl_form(aTHX_ "%s/sperl"PERL_FS_VER_FMT, BIN_EXP,
3515 (int)PERL_REVISION, (int)PERL_VERSION,
3516 (int)PERL_SUBVERSION), PL_origargv);
3518 #endif /* IAMSUID */
3519 Perl_croak(aTHX_ "Can't do setuid (cannot exec sperl)\n");
3522 if (PL_statbuf.st_mode & S_ISGID && PL_statbuf.st_gid != PL_egid) {
3524 * This seems back to front: we try HAS_SETEGID first; if not available
3525 * then try HAS_SETREGID; as a last chance we try HAS_SETRESGID. May be OK
3526 * in the sense that we only want to set EGID; but are there any machines
3527 * with either of the latter, but not the former? Same with UID, later.
3530 (void)setegid(PL_statbuf.st_gid);
3533 (void)setregid((Gid_t)-1,PL_statbuf.st_gid);
3535 #ifdef HAS_SETRESGID
3536 (void)setresgid((Gid_t)-1,PL_statbuf.st_gid,(Gid_t)-1);
3538 PerlProc_setgid(PL_statbuf.st_gid);
3542 if (PerlProc_getegid() != PL_statbuf.st_gid)
3543 Perl_croak(aTHX_ "Can't do setegid!\n");
3545 if (PL_statbuf.st_mode & S_ISUID) {
3546 if (PL_statbuf.st_uid != PL_euid)
3548 (void)seteuid(PL_statbuf.st_uid); /* all that for this */
3551 (void)setreuid((Uid_t)-1,PL_statbuf.st_uid);
3553 #ifdef HAS_SETRESUID
3554 (void)setresuid((Uid_t)-1,PL_statbuf.st_uid,(Uid_t)-1);
3556 PerlProc_setuid(PL_statbuf.st_uid);
3560 if (PerlProc_geteuid() != PL_statbuf.st_uid)
3561 Perl_croak(aTHX_ "Can't do seteuid!\n");
3563 else if (PL_uid) { /* oops, mustn't run as root */
3565 (void)seteuid((Uid_t)PL_uid);
3568 (void)setreuid((Uid_t)-1,(Uid_t)PL_uid);
3570 #ifdef HAS_SETRESUID
3571 (void)setresuid((Uid_t)-1,(Uid_t)PL_uid,(Uid_t)-1);
3573 PerlProc_setuid((Uid_t)PL_uid);
3577 if (PerlProc_geteuid() != PL_uid)
3578 Perl_croak(aTHX_ "Can't do seteuid!\n");
3581 if (!cando(S_IXUSR,TRUE,&PL_statbuf))
3582 Perl_croak(aTHX_ "Effective UID cannot exec script\n"); /* they can't do this */
3585 else if (PL_preprocess) /* PSz 13 Nov 03 Caught elsewhere, useless(?!) here */
3586 Perl_croak(aTHX_ "-P not allowed for setuid/setgid script\n");
3587 else if (PL_fdscript < 0 || PL_suidscript != 1)
3588 /* PSz 13 Nov 03 Caught elsewhere, useless(?!) here */
3589 Perl_croak(aTHX_ "(suid) fdscript needed in suidperl\n");
3591 /* PSz 16 Sep 03 Keep neat error message */
3592 Perl_croak(aTHX_ "Script is not setuid/setgid in suidperl\n");
3595 /* We absolutely must clear out any saved ids here, so we */
3596 /* exec the real perl, substituting fd script for scriptname. */
3597 /* (We pass script name as "subdir" of fd, which perl will grok.) */
3599 * It might be thought that using setresgid and/or setresuid (changed to
3600 * set the saved IDs) above might obviate the need to exec, and we could
3601 * go on to "do the perl thing".
3603 * Is there such a thing as "saved GID", and is that set for setuid (but
3604 * not setgid) execution like suidperl? Without exec, it would not be
3605 * cleared for setuid (but not setgid) scripts (or might need a dummy
3608 * We need suidperl to do the exact same argument checking that perl
3609 * does. Thus it cannot be very small; while it could be significantly
3610 * smaller, it is safer (simpler?) to make it essentially the same
3611 * binary as perl (but they are not identical). - Maybe could defer that
3612 * check to the invoked perl, and suidperl be a tiny wrapper instead;
3613 * but prefer to do thorough checks in suidperl itself. Such deferral
3614 * would make suidperl security rely on perl, a design no-no.
3616 * Setuid things should be short and simple, thus easy to understand and
3617 * verify. They should do their "own thing", without influence by
3618 * attackers. It may help if their internal execution flow is fixed,
3619 * regardless of platform: it may be best to exec anyway.
3621 * Suidperl should at least be conceptually simple: a wrapper only,
3622 * never to do any real perl. Maybe we should put
3624 * Perl_croak(aTHX_ "Suidperl should never do real perl\n");
3626 * into the perly bits.
3628 PerlIO_rewind(PL_rsfp);
3629 PerlLIO_lseek(PerlIO_fileno(PL_rsfp),(Off_t)0,0); /* just in case rewind didn't */
3631 * Keep original arguments: suidperl already has fd script.
3633 /* for (which = 1; PL_origargv[which] && PL_origargv[which] != scriptname; which++) ; */
3634 /* if (!PL_origargv[which]) { */
3635 /* errno = EPERM; */
3636 /* Perl_croak(aTHX_ "Permission denied\n"); */
3638 /* PL_origargv[which] = savepv(Perl_form(aTHX_ "/dev/fd/%d/%s", */
3639 /* PerlIO_fileno(PL_rsfp), PL_origargv[which])); */
3640 #if defined(HAS_FCNTL) && defined(F_SETFD)
3641 fcntl(PerlIO_fileno(PL_rsfp),F_SETFD,0); /* ensure no close-on-exec */
3644 PerlProc_execv(Perl_form(aTHX_ "%s/perl"PERL_FS_VER_FMT, BIN_EXP,
3645 (int)PERL_REVISION, (int)PERL_VERSION,
3646 (int)PERL_SUBVERSION), PL_origargv);/* try again */
3648 Perl_croak(aTHX_ "Can't do setuid (suidperl cannot exec perl)\n");
3649 #endif /* IAMSUID */
3651 if (PL_euid != PL_uid || PL_egid != PL_gid) { /* (suidperl doesn't exist, in fact) */
3652 #ifndef SETUID_SCRIPTS_ARE_SECURE_NOW
3653 PerlLIO_fstat(PerlIO_fileno(PL_rsfp),&PL_statbuf); /* may be either wrapped or real suid */
3654 if ((PL_euid != PL_uid && PL_euid == PL_statbuf.st_uid && PL_statbuf.st_mode & S_ISUID)
3656 (PL_egid != PL_gid && PL_egid == PL_statbuf.st_gid && PL_statbuf.st_mode & S_ISGID)
3659 Perl_croak(aTHX_ "YOU HAVEN'T DISABLED SET-ID SCRIPTS IN THE KERNEL YET!\n\
3660 FIX YOUR KERNEL, PUT A C WRAPPER AROUND THIS SCRIPT, OR USE -u AND UNDUMP!\n");
3661 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
3662 /* not set-id, must be wrapped */
3668 S_find_beginning(pTHX)
3670 register char *s, *s2;
3671 #ifdef MACOS_TRADITIONAL
3675 /* skip forward in input to the real script? */
3678 #ifdef MACOS_TRADITIONAL
3679 /* Since the Mac OS does not honor #! arguments for us, we do it ourselves */
3681 while (PL_doextract || gMacPerl_AlwaysExtract) {
3682 if ((s = sv_gets(PL_linestr, PL_rsfp, 0)) == Nullch) {
3683 if (!gMacPerl_AlwaysExtract)
3684 Perl_croak(aTHX_ "No Perl script found in input\n");
3686 if (PL_doextract) /* require explicit override ? */
3687 if (!OverrideExtract(PL_origfilename))
3688 Perl_croak(aTHX_ "User aborted script\n");
3690 PL_doextract = FALSE;
3692 /* Pater peccavi, file does not have #! */
3693 PerlIO_rewind(PL_rsfp);
3698 while (PL_doextract) {
3699 if ((s = sv_gets(PL_linestr, PL_rsfp, 0)) == Nullch)
3700 Perl_croak(aTHX_ "No Perl script found in input\n");
3703 if (*s == '#' && s[1] == '!' && ((s = instr(s,"perl")) || (s = instr(s2,"PERL")))) {
3704 PerlIO_ungetc(PL_rsfp, '\n'); /* to keep line count right */
3705 PL_doextract = FALSE;
3706 while (*s && !(isSPACE (*s) || *s == '#')) s++;
3708 while (*s == ' ' || *s == '\t') s++;
3710 while (isDIGIT(s2[-1]) || strchr("-._", s2[-1])) s2--;
3711 if (strnEQ(s2-4,"perl",4))
3713 while ((s = moreswitches(s)))
3716 #ifdef MACOS_TRADITIONAL
3717 /* We are always searching for the #!perl line in MacPerl,
3718 * so if we find it, still keep the line count correct
3719 * by counting lines we already skipped over
3721 for (; maclines > 0 ; maclines--)
3722 PerlIO_ungetc(PL_rsfp, '\n');
3726 /* gMacPerl_AlwaysExtract is false in MPW tool */
3727 } else if (gMacPerl_AlwaysExtract) {
3738 PL_uid = PerlProc_getuid();
3739 PL_euid = PerlProc_geteuid();
3740 PL_gid = PerlProc_getgid();
3741 PL_egid = PerlProc_getegid();
3743 PL_uid |= PL_gid << 16;
3744 PL_euid |= PL_egid << 16;
3746 /* Should not happen: */
3747 CHECK_MALLOC_TAINT(PL_uid && (PL_euid != PL_uid || PL_egid != PL_gid));
3748 PL_tainting |= (PL_uid && (PL_euid != PL_uid || PL_egid != PL_gid));
3751 * Should go by suidscript, not uid!=euid: why disallow
3752 * system("ls") in scripts run from setuid things?
3753 * Or, is this run before we check arguments and set suidscript?
3754 * What about SETUID_SCRIPTS_ARE_SECURE_NOW: could we use fdscript then?
3755 * (We never have suidscript, can we be sure to have fdscript?)
3756 * Or must then go by UID checks? See comments in forbid_setid also.
3760 /* This is used very early in the lifetime of the program,
3761 * before even the options are parsed, so PL_tainting has
3762 * not been initialized properly. */
3764 Perl_doing_taint(int argc, char *argv[], char *envp[])
3766 #ifndef PERL_IMPLICIT_SYS
3767 /* If we have PERL_IMPLICIT_SYS we can't call getuid() et alia
3768 * before we have an interpreter-- and the whole point of this
3769 * function is to be called at such an early stage. If you are on
3770 * a system with PERL_IMPLICIT_SYS but you do have a concept of
3771 * "tainted because running with altered effective ids', you'll
3772 * have to add your own checks somewhere in here. The two most
3773 * known samples of 'implicitness' are Win32 and NetWare, neither
3774 * of which has much of concept of 'uids'. */
3775 int uid = PerlProc_getuid();
3776 int euid = PerlProc_geteuid();
3777 int gid = PerlProc_getgid();
3778 int egid = PerlProc_getegid();
3784 if (uid && (euid != uid || egid != gid))
3786 #endif /* !PERL_IMPLICIT_SYS */
3787 /* This is a really primitive check; environment gets ignored only
3788 * if -T are the first chars together; otherwise one gets
3789 * "Too late" message. */
3790 if ( argc > 1 && argv[1][0] == '-'
3791 && (argv[1][1] == 't' || argv[1][1] == 'T') )
3797 S_forbid_setid(pTHX_ char *s)
3799 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
3800 if (PL_euid != PL_uid)
3801 Perl_croak(aTHX_ "No %s allowed while running setuid", s);
3802 if (PL_egid != PL_gid)
3803 Perl_croak(aTHX_ "No %s allowed while running setgid", s);
3804 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
3806 * Checks for UID/GID above "wrong": why disallow
3807 * perl -e 'print "Hello\n"'
3808 * from within setuid things?? Simply drop them: replaced by
3809 * fdscript/suidscript and #ifdef IAMSUID checks below.
3811 * This may be too late for command-line switches. Will catch those on
3812 * the #! line, after finding the script name and setting up
3813 * fdscript/suidscript. Note that suidperl does not get around to
3814 * parsing (and checking) the switches on the #! line, but checks that
3815 * the two sets are identical.
3817 * With SETUID_SCRIPTS_ARE_SECURE_NOW, could we use fdscript, also or
3818 * instead, or would that be "too late"? (We never have suidscript, can
3819 * we be sure to have fdscript?)
3821 * Catch things with suidscript (in descendant of suidperl), even with
3822 * right UID/GID. Was already checked in suidperl, with #ifdef IAMSUID,
3823 * below; but I am paranoid.
3825 * Also see comments about root running a setuid script, elsewhere.
3827 if (PL_suidscript >= 0)
3828 Perl_croak(aTHX_ "No %s allowed with (suid) fdscript", s);
3830 /* PSz 11 Nov 03 Catch it in suidperl, always! */
3831 Perl_croak(aTHX_ "No %s allowed in suidperl", s);
3832 #endif /* IAMSUID */
3836 Perl_init_debugger(pTHX)
3838 HV *ostash = PL_curstash;
3840 PL_curstash = PL_debstash;
3841 PL_dbargs = GvAV(gv_AVadd((gv_fetchpv("DB::args", GV_ADDMULTI, SVt_PVAV))));
3842 AvREAL_off(PL_dbargs);
3843 PL_DBgv = gv_fetchpv("DB::DB", GV_ADDMULTI, SVt_PVGV);
3844 PL_DBline = gv_fetchpv("DB::dbline", GV_ADDMULTI, SVt_PVAV);
3845 PL_DBsub = gv_HVadd(gv_fetchpv("DB::sub", GV_ADDMULTI, SVt_PVHV));
3846 sv_upgrade(GvSV(PL_DBsub), SVt_IV); /* IVX accessed if PERLDB_SUB_NN */
3847 PL_DBsingle = GvSV((gv_fetchpv("DB::single", GV_ADDMULTI, SVt_PV)));
3848 sv_setiv(PL_DBsingle, 0);
3849 PL_DBtrace = GvSV((gv_fetchpv("DB::trace", GV_ADDMULTI, SVt_PV)));
3850 sv_setiv(PL_DBtrace, 0);
3851 PL_DBsignal = GvSV((gv_fetchpv("DB::signal", GV_ADDMULTI, SVt_PV)));
3852 sv_setiv(PL_DBsignal, 0);
3853 PL_DBassertion = GvSV((gv_fetchpv("DB::assertion", GV_ADDMULTI, SVt_PV)));
3854 sv_setiv(PL_DBassertion, 0);
3855 PL_curstash = ostash;
3858 #ifndef STRESS_REALLOC
3859 #define REASONABLE(size) (size)
3861 #define REASONABLE(size) (1) /* unreasonable */
3865 Perl_init_stacks(pTHX)
3867 /* start with 128-item stack and 8K cxstack */
3868 PL_curstackinfo = new_stackinfo(REASONABLE(128),
3869 REASONABLE(8192/sizeof(PERL_CONTEXT) - 1));
3870 PL_curstackinfo->si_type = PERLSI_MAIN;
3871 PL_curstack = PL_curstackinfo->si_stack;
3872 PL_mainstack = PL_curstack; /* remember in case we switch stacks */
3874 PL_stack_base = AvARRAY(PL_curstack);
3875 PL_stack_sp = PL_stack_base;
3876 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
3878 New(50,PL_tmps_stack,REASONABLE(128),SV*);
3881 PL_tmps_max = REASONABLE(128);
3883 New(54,PL_markstack,REASONABLE(32),I32);
3884 PL_markstack_ptr = PL_markstack;
3885 PL_markstack_max = PL_markstack + REASONABLE(32);
3889 New(54,PL_scopestack,REASONABLE(32),I32);
3890 PL_scopestack_ix = 0;
3891 PL_scopestack_max = REASONABLE(32);
3893 New(54,PL_savestack,REASONABLE(128),ANY);
3894 PL_savestack_ix = 0;
3895 PL_savestack_max = REASONABLE(128);
3897 New(54,PL_retstack,REASONABLE(16),OP*);
3899 PL_retstack_max = REASONABLE(16);
3907 while (PL_curstackinfo->si_next)
3908 PL_curstackinfo = PL_curstackinfo->si_next;
3909 while (PL_curstackinfo) {
3910 PERL_SI *p = PL_curstackinfo->si_prev;
3911 /* curstackinfo->si_stack got nuked by sv_free_arenas() */
3912 Safefree(PL_curstackinfo->si_cxstack);
3913 Safefree(PL_curstackinfo);
3914 PL_curstackinfo = p;
3916 Safefree(PL_tmps_stack);
3917 Safefree(PL_markstack);
3918 Safefree(PL_scopestack);
3919 Safefree(PL_savestack);
3920 Safefree(PL_retstack);
3929 lex_start(PL_linestr);
3931 PL_subname = newSVpvn("main",4);
3935 S_init_predump_symbols(pTHX)
3940 sv_setpvn(get_sv("\"", TRUE), " ", 1);
3941 PL_stdingv = gv_fetchpv("STDIN",TRUE, SVt_PVIO);
3942 GvMULTI_on(PL_stdingv);
3943 io = GvIOp(PL_stdingv);
3944 IoTYPE(io) = IoTYPE_RDONLY;
3945 IoIFP(io) = PerlIO_stdin();
3946 tmpgv = gv_fetchpv("stdin",TRUE, SVt_PV);
3948 GvIOp(tmpgv) = (IO*)SvREFCNT_inc(io);
3950 tmpgv = gv_fetchpv("STDOUT",TRUE, SVt_PVIO);
3953 IoTYPE(io) = IoTYPE_WRONLY;
3954 IoOFP(io) = IoIFP(io) = PerlIO_stdout();
3956 tmpgv = gv_fetchpv("stdout",TRUE, SVt_PV);
3958 GvIOp(tmpgv) = (IO*)SvREFCNT_inc(io);
3960 PL_stderrgv = gv_fetchpv("STDERR",TRUE, SVt_PVIO);
3961 GvMULTI_on(PL_stderrgv);
3962 io = GvIOp(PL_stderrgv);
3963 IoTYPE(io) = IoTYPE_WRONLY;
3964 IoOFP(io) = IoIFP(io) = PerlIO_stderr();
3965 tmpgv = gv_fetchpv("stderr",TRUE, SVt_PV);
3967 GvIOp(tmpgv) = (IO*)SvREFCNT_inc(io);
3969 PL_statname = NEWSV(66,0); /* last filename we did stat on */
3972 Safefree(PL_osname);
3973 PL_osname = savepv(OSNAME);
3977 Perl_init_argv_symbols(pTHX_ register int argc, register char **argv)
3980 argc--,argv++; /* skip name of script */
3981 if (PL_doswitches) {
3982 for (; argc > 0 && **argv == '-'; argc--,argv++) {
3985 if (argv[0][1] == '-' && !argv[0][2]) {
3989 if ((s = strchr(argv[0], '='))) {
3991 sv_setpv(GvSV(gv_fetchpv(argv[0]+1,TRUE, SVt_PV)),s);
3994 sv_setiv(GvSV(gv_fetchpv(argv[0]+1,TRUE, SVt_PV)),1);
3997 if ((PL_argvgv = gv_fetchpv("ARGV",TRUE, SVt_PVAV))) {
3998 GvMULTI_on(PL_argvgv);
3999 (void)gv_AVadd(PL_argvgv);
4000 av_clear(GvAVn(PL_argvgv));
4001 for (; argc > 0; argc--,argv++) {
4002 SV *sv = newSVpv(argv[0],0);
4003 av_push(GvAVn(PL_argvgv),sv);
4004 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
4005 if (PL_unicode & PERL_UNICODE_ARGV_FLAG)
4008 if (PL_unicode & PERL_UNICODE_WIDESYSCALLS_FLAG) /* Sarathy? */
4009 (void)sv_utf8_decode(sv);
4014 #ifdef HAS_PROCSELFEXE
4015 /* This is a function so that we don't hold on to MAXPATHLEN
4016 bytes of stack longer than necessary
4019 S_procself_val(pTHX_ SV *sv, char *arg0)
4021 char buf[MAXPATHLEN];
4022 int len = readlink(PROCSELFEXE_PATH, buf, sizeof(buf) - 1);
4024 /* On Playstation2 Linux V1.0 (kernel 2.2.1) readlink(/proc/self/exe)
4025 includes a spurious NUL which will cause $^X to fail in system
4026 or backticks (this will prevent extensions from being built and
4027 many tests from working). readlink is not meant to add a NUL.
4028 Normal readlink works fine.
4030 if (len > 0 && buf[len-1] == '\0') {
4034 /* FreeBSD's implementation is acknowledged to be imperfect, sometimes
4035 returning the text "unknown" from the readlink rather than the path
4036 to the executable (or returning an error from the readlink). Any valid
4037 path has a '/' in it somewhere, so use that to validate the result.
4038 See http://www.freebsd.org/cgi/query-pr.cgi?pr=35703
4040 if (len > 0 && memchr(buf, '/', len)) {
4041 sv_setpvn(sv,buf,len);
4047 #endif /* HAS_PROCSELFEXE */
4050 S_init_postdump_symbols(pTHX_ register int argc, register char **argv, register char **env)
4056 PL_toptarget = NEWSV(0,0);
4057 sv_upgrade(PL_toptarget, SVt_PVFM);
4058 sv_setpvn(PL_toptarget, "", 0);
4059 PL_bodytarget = NEWSV(0,0);
4060 sv_upgrade(PL_bodytarget, SVt_PVFM);
4061 sv_setpvn(PL_bodytarget, "", 0);
4062 PL_formtarget = PL_bodytarget;
4066 init_argv_symbols(argc,argv);
4068 if ((tmpgv = gv_fetchpv("0",TRUE, SVt_PV))) {
4069 #ifdef MACOS_TRADITIONAL
4070 /* $0 is not majick on a Mac */
4071 sv_setpv(GvSV(tmpgv),MacPerl_MPWFileName(PL_origfilename));
4073 sv_setpv(GvSV(tmpgv),PL_origfilename);
4074 magicname("0", "0", 1);
4077 if ((tmpgv = gv_fetchpv("\030",TRUE, SVt_PV))) {/* $^X */
4078 #ifdef HAS_PROCSELFEXE
4079 S_procself_val(aTHX_ GvSV(tmpgv), PL_origargv[0]);
4082 sv_setpv(GvSV(tmpgv), os2_execname(aTHX));
4084 sv_setpv(GvSV(tmpgv),PL_origargv[0]);
4088 if ((PL_envgv = gv_fetchpv("ENV",TRUE, SVt_PVHV))) {
4090 GvMULTI_on(PL_envgv);
4091 hv = GvHVn(PL_envgv);
4092 hv_magic(hv, Nullgv, PERL_MAGIC_env);
4094 #ifdef USE_ENVIRON_ARRAY
4095 /* Note that if the supplied env parameter is actually a copy
4096 of the global environ then it may now point to free'd memory
4097 if the environment has been modified since. To avoid this
4098 problem we treat env==NULL as meaning 'use the default'
4103 # ifdef USE_ITHREADS
4104 && PL_curinterp == aTHX
4108 environ[0] = Nullch;
4111 for (; *env; env++) {
4112 if (!(s = strchr(*env,'=')))
4114 #if defined(MSDOS) && !defined(DJGPP)
4119 sv = newSVpv(s+1, 0);
4120 (void)hv_store(hv, *env, s - *env, sv, 0);
4124 #endif /* USE_ENVIRON_ARRAY */
4125 #endif /* !PERL_MICRO */
4128 if ((tmpgv = gv_fetchpv("$",TRUE, SVt_PV))) {
4129 SvREADONLY_off(GvSV(tmpgv));
4130 sv_setiv(GvSV(tmpgv), (IV)PerlProc_getpid());
4131 SvREADONLY_on(GvSV(tmpgv));
4133 #ifdef THREADS_HAVE_PIDS
4134 PL_ppid = (IV)getppid();
4137 /* touch @F array to prevent spurious warnings 20020415 MJD */
4139 (void) get_av("main::F", TRUE | GV_ADDMULTI);
4141 /* touch @- and @+ arrays to prevent spurious warnings 20020415 MJD */
4142 (void) get_av("main::-", TRUE | GV_ADDMULTI);
4143 (void) get_av("main::+", TRUE | GV_ADDMULTI);
4147 S_init_perllib(pTHX)
4152 s = PerlEnv_getenv("PERL5LIB");
4154 incpush(s, TRUE, TRUE, TRUE);
4156 incpush(PerlEnv_getenv("PERLLIB"), FALSE, FALSE, TRUE);
4158 /* Treat PERL5?LIB as a possible search list logical name -- the
4159 * "natural" VMS idiom for a Unix path string. We allow each
4160 * element to be a set of |-separated directories for compatibility.
4164 if (my_trnlnm("PERL5LIB",buf,0))
4165 do { incpush(buf,TRUE,TRUE,TRUE); } while (my_trnlnm("PERL5LIB",buf,++idx));
4167 while (my_trnlnm("PERLLIB",buf,idx++)) incpush(buf,FALSE,FALSE,TRUE);
4171 /* Use the ~-expanded versions of APPLLIB (undocumented),
4172 ARCHLIB PRIVLIB SITEARCH SITELIB VENDORARCH and VENDORLIB
4175 incpush(APPLLIB_EXP, TRUE, TRUE, TRUE);
4179 incpush(ARCHLIB_EXP, FALSE, FALSE, TRUE);
4181 #ifdef MACOS_TRADITIONAL
4184 SV * privdir = NEWSV(55, 0);
4185 char * macperl = PerlEnv_getenv("MACPERL");
4190 Perl_sv_setpvf(aTHX_ privdir, "%slib:", macperl);
4191 if (PerlLIO_stat(SvPVX(privdir), &tmpstatbuf) >= 0 && S_ISDIR(tmpstatbuf.st_mode))
4192 incpush(SvPVX(privdir), TRUE, FALSE, TRUE);
4193 Perl_sv_setpvf(aTHX_ privdir, "%ssite_perl:", macperl);
4194 if (PerlLIO_stat(SvPVX(privdir), &tmpstatbuf) >= 0 && S_ISDIR(tmpstatbuf.st_mode))
4195 incpush(SvPVX(privdir), TRUE, FALSE, TRUE);
4197 SvREFCNT_dec(privdir);
4200 incpush(":", FALSE, FALSE, TRUE);
4203 # define PRIVLIB_EXP "/usr/local/lib/perl5:/usr/local/lib/perl"
4206 incpush(PRIVLIB_EXP, TRUE, FALSE, TRUE);
4208 incpush(PRIVLIB_EXP, FALSE, FALSE, TRUE);
4212 /* sitearch is always relative to sitelib on Windows for
4213 * DLL-based path intuition to work correctly */
4214 # if !defined(WIN32)
4215 incpush(SITEARCH_EXP, FALSE, FALSE, TRUE);
4221 /* this picks up sitearch as well */
4222 incpush(SITELIB_EXP, TRUE, FALSE, TRUE);
4224 incpush(SITELIB_EXP, FALSE, FALSE, TRUE);
4228 #ifdef SITELIB_STEM /* Search for version-specific dirs below here */
4229 incpush(SITELIB_STEM, FALSE, TRUE, TRUE);
4232 #ifdef PERL_VENDORARCH_EXP
4233 /* vendorarch is always relative to vendorlib on Windows for
4234 * DLL-based path intuition to work correctly */
4235 # if !defined(WIN32)
4236 incpush(PERL_VENDORARCH_EXP, FALSE, FALSE, TRUE);
4240 #ifdef PERL_VENDORLIB_EXP
4242 incpush(PERL_VENDORLIB_EXP, TRUE, FALSE, TRUE); /* this picks up vendorarch as well */
4244 incpush(PERL_VENDORLIB_EXP, FALSE, FALSE, TRUE);
4248 #ifdef PERL_VENDORLIB_STEM /* Search for version-specific dirs below here */
4249 incpush(PERL_VENDORLIB_STEM, FALSE, TRUE, TRUE);
4252 #ifdef PERL_OTHERLIBDIRS
4253 incpush(PERL_OTHERLIBDIRS, TRUE, TRUE, TRUE);
4257 incpush(".", FALSE, FALSE, TRUE);
4258 #endif /* MACOS_TRADITIONAL */
4261 #if defined(DOSISH) || defined(EPOC)
4262 # define PERLLIB_SEP ';'
4265 # define PERLLIB_SEP '|'
4267 # if defined(MACOS_TRADITIONAL)
4268 # define PERLLIB_SEP ','
4270 # define PERLLIB_SEP ':'
4274 #ifndef PERLLIB_MANGLE
4275 # define PERLLIB_MANGLE(s,n) (s)
4279 S_incpush(pTHX_ char *p, int addsubdirs, int addoldvers, int usesep)
4281 SV *subdir = Nullsv;
4286 if (addsubdirs || addoldvers) {
4287 subdir = sv_newmortal();
4290 /* Break at all separators */
4292 SV *libdir = NEWSV(55,0);
4295 /* skip any consecutive separators */
4297 while ( *p == PERLLIB_SEP ) {
4298 /* Uncomment the next line for PATH semantics */
4299 /* av_push(GvAVn(PL_incgv), newSVpvn(".", 1)); */
4304 if ( usesep && (s = strchr(p, PERLLIB_SEP)) != Nullch ) {
4305 sv_setpvn(libdir, PERLLIB_MANGLE(p, (STRLEN)(s - p)),
4310 sv_setpv(libdir, PERLLIB_MANGLE(p, 0));
4311 p = Nullch; /* break out */
4313 #ifdef MACOS_TRADITIONAL
4314 if (!strchr(SvPVX(libdir), ':')) {
4317 sv_setpv(libdir, MacPerl_CanonDir(SvPVX(libdir), buf, 0));
4319 if (SvPVX(libdir)[SvCUR(libdir)-1] != ':')
4320 sv_catpv(libdir, ":");
4324 * BEFORE pushing libdir onto @INC we may first push version- and
4325 * archname-specific sub-directories.
4327 if (addsubdirs || addoldvers) {
4328 #ifdef PERL_INC_VERSION_LIST
4329 /* Configure terminates PERL_INC_VERSION_LIST with a NULL */
4330 const char *incverlist[] = { PERL_INC_VERSION_LIST };
4331 const char **incver;
4338 if ((unix = tounixspec_ts(SvPV(libdir,len),Nullch)) != Nullch) {
4340 while (unix[len-1] == '/') len--; /* Cosmetic */
4341 sv_usepvn(libdir,unix,len);
4344 PerlIO_printf(Perl_error_log,
4345 "Failed to unixify @INC element \"%s\"\n",
4349 #ifdef MACOS_TRADITIONAL
4350 #define PERL_AV_SUFFIX_FMT ""
4351 #define PERL_ARCH_FMT "%s:"
4352 #define PERL_ARCH_FMT_PATH PERL_FS_VER_FMT PERL_AV_SUFFIX_FMT
4354 #define PERL_AV_SUFFIX_FMT "/"
4355 #define PERL_ARCH_FMT "/%s"
4356 #define PERL_ARCH_FMT_PATH PERL_AV_SUFFIX_FMT PERL_FS_VER_FMT
4358 /* .../version/archname if -d .../version/archname */
4359 Perl_sv_setpvf(aTHX_ subdir, "%"SVf PERL_ARCH_FMT_PATH PERL_ARCH_FMT,
4361 (int)PERL_REVISION, (int)PERL_VERSION,
4362 (int)PERL_SUBVERSION, ARCHNAME);
4363 if (PerlLIO_stat(SvPVX(subdir), &tmpstatbuf) >= 0 &&
4364 S_ISDIR(tmpstatbuf.st_mode))
4365 av_push(GvAVn(PL_incgv), newSVsv(subdir));
4367 /* .../version if -d .../version */
4368 Perl_sv_setpvf(aTHX_ subdir, "%"SVf PERL_ARCH_FMT_PATH, libdir,
4369 (int)PERL_REVISION, (int)PERL_VERSION,
4370 (int)PERL_SUBVERSION);
4371 if (PerlLIO_stat(SvPVX(subdir), &tmpstatbuf) >= 0 &&
4372 S_ISDIR(tmpstatbuf.st_mode))
4373 av_push(GvAVn(PL_incgv), newSVsv(subdir));
4375 /* .../archname if -d .../archname */
4376 Perl_sv_setpvf(aTHX_ subdir, "%"SVf PERL_ARCH_FMT, libdir, ARCHNAME);
4377 if (PerlLIO_stat(SvPVX(subdir), &tmpstatbuf) >= 0 &&
4378 S_ISDIR(tmpstatbuf.st_mode))
4379 av_push(GvAVn(PL_incgv), newSVsv(subdir));
4382 #ifdef PERL_INC_VERSION_LIST
4384 for (incver = incverlist; *incver; incver++) {
4385 /* .../xxx if -d .../xxx */
4386 Perl_sv_setpvf(aTHX_ subdir, "%"SVf PERL_ARCH_FMT, libdir, *incver);
4387 if (PerlLIO_stat(SvPVX(subdir), &tmpstatbuf) >= 0 &&
4388 S_ISDIR(tmpstatbuf.st_mode))
4389 av_push(GvAVn(PL_incgv), newSVsv(subdir));
4395 /* finally push this lib directory on the end of @INC */
4396 av_push(GvAVn(PL_incgv), libdir);
4400 #ifdef USE_5005THREADS
4401 STATIC struct perl_thread *
4402 S_init_main_thread(pTHX)
4404 #if !defined(PERL_IMPLICIT_CONTEXT)
4405 struct perl_thread *thr;
4409 Newz(53, thr, 1, struct perl_thread);
4410 PL_curcop = &PL_compiling;
4411 thr->interp = PERL_GET_INTERP;
4412 thr->cvcache = newHV();
4413 thr->threadsv = newAV();
4414 /* thr->threadsvp is set when find_threadsv is called */
4415 thr->specific = newAV();
4416 thr->flags = THRf_R_JOINABLE;
4417 MUTEX_INIT(&thr->mutex);
4418 /* Handcraft thrsv similarly to mess_sv */
4419 New(53, PL_thrsv, 1, SV);
4420 Newz(53, xpv, 1, XPV);
4421 SvFLAGS(PL_thrsv) = SVt_PV;
4422 SvANY(PL_thrsv) = (void*)xpv;
4423 SvREFCNT(PL_thrsv) = 1 << 30; /* practically infinite */
4424 SvPVX(PL_thrsv) = (char*)thr;
4425 SvCUR_set(PL_thrsv, sizeof(thr));
4426 SvLEN_set(PL_thrsv, sizeof(thr));
4427 *SvEND(PL_thrsv) = '\0'; /* in the trailing_nul field */
4428 thr->oursv = PL_thrsv;
4429 PL_chopset = " \n-";
4432 MUTEX_LOCK(&PL_threads_mutex);
4438 MUTEX_UNLOCK(&PL_threads_mutex);
4440 #ifdef HAVE_THREAD_INTERN
4441 Perl_init_thread_intern(thr);
4444 #ifdef SET_THREAD_SELF
4445 SET_THREAD_SELF(thr);
4447 thr->self = pthread_self();
4448 #endif /* SET_THREAD_SELF */
4452 * These must come after the thread self setting
4453 * because sv_setpvn does SvTAINT and the taint
4454 * fields thread selfness being set.
4456 PL_toptarget = NEWSV(0,0);
4457 sv_upgrade(PL_toptarget, SVt_PVFM);
4458 sv_setpvn(PL_toptarget, "", 0);
4459 PL_bodytarget = NEWSV(0,0);
4460 sv_upgrade(PL_bodytarget, SVt_PVFM);
4461 sv_setpvn(PL_bodytarget, "", 0);
4462 PL_formtarget = PL_bodytarget;
4463 thr->errsv = newSVpvn("", 0);
4464 (void) find_threadsv("@"); /* Ensure $@ is initialised early */
4467 PL_peepp = MEMBER_TO_FPTR(Perl_peep);
4468 PL_regcompp = MEMBER_TO_FPTR(Perl_pregcomp);
4469 PL_regexecp = MEMBER_TO_FPTR(Perl_regexec_flags);
4470 PL_regint_start = MEMBER_TO_FPTR(Perl_re_intuit_start);
4471 PL_regint_string = MEMBER_TO_FPTR(Perl_re_intuit_string);
4472 PL_regfree = MEMBER_TO_FPTR(Perl_pregfree);
4474 PL_reginterp_cnt = 0;
4478 #endif /* USE_5005THREADS */
4481 Perl_call_list(pTHX_ I32 oldscope, AV *paramList)
4484 line_t oldline = CopLINE(PL_curcop);
4490 while (AvFILL(paramList) >= 0) {
4491 cv = (CV*)av_shift(paramList);
4493 if (paramList == PL_beginav) {
4494 /* save PL_beginav for compiler */
4495 if (! PL_beginav_save)
4496 PL_beginav_save = newAV();
4497 av_push(PL_beginav_save, (SV*)cv);
4499 else if (paramList == PL_checkav) {
4500 /* save PL_checkav for compiler */
4501 if (! PL_checkav_save)
4502 PL_checkav_save = newAV();
4503 av_push(PL_checkav_save, (SV*)cv);
4508 #ifdef PERL_FLEXIBLE_EXCEPTIONS
4509 CALLPROTECT(aTHX_ pcur_env, &ret, MEMBER_TO_FPTR(S_vcall_list_body), cv);
4515 #ifndef PERL_FLEXIBLE_EXCEPTIONS
4519 (void)SvPV(atsv, len);
4521 PL_curcop = &PL_compiling;
4522 CopLINE_set(PL_curcop, oldline);
4523 if (paramList == PL_beginav)
4524 sv_catpv(atsv, "BEGIN failed--compilation aborted");
4526 Perl_sv_catpvf(aTHX_ atsv,
4527 "%s failed--call queue aborted",
4528 paramList == PL_checkav ? "CHECK"
4529 : paramList == PL_initav ? "INIT"
4531 while (PL_scopestack_ix > oldscope)
4534 Perl_croak(aTHX_ "%"SVf"", atsv);
4541 /* my_exit() was called */
4542 while (PL_scopestack_ix > oldscope)
4545 PL_curstash = PL_defstash;
4546 PL_curcop = &PL_compiling;
4547 CopLINE_set(PL_curcop, oldline);
4549 if (PL_statusvalue && !(PL_exit_flags & PERL_EXIT_EXPECTED)) {
4550 if (paramList == PL_beginav)
4551 Perl_croak(aTHX_ "BEGIN failed--compilation aborted");
4553 Perl_croak(aTHX_ "%s failed--call queue aborted",
4554 paramList == PL_checkav ? "CHECK"
4555 : paramList == PL_initav ? "INIT"
4562 PL_curcop = &PL_compiling;
4563 CopLINE_set(PL_curcop, oldline);
4566 PerlIO_printf(Perl_error_log, "panic: restartop\n");
4574 #ifdef PERL_FLEXIBLE_EXCEPTIONS
4576 S_vcall_list_body(pTHX_ va_list args)
4578 CV *cv = va_arg(args, CV*);
4579 return call_list_body(cv);
4584 S_call_list_body(pTHX_ CV *cv)
4586 PUSHMARK(PL_stack_sp);
4587 call_sv((SV*)cv, G_EVAL|G_DISCARD);
4592 Perl_my_exit(pTHX_ U32 status)
4594 DEBUG_S(PerlIO_printf(Perl_debug_log, "my_exit: thread %p, status %lu\n",
4595 thr, (unsigned long) status));
4604 STATUS_NATIVE_SET(status);
4611 Perl_my_failure_exit(pTHX)
4614 if (vaxc$errno & 1) {
4615 if (STATUS_NATIVE & 1) /* fortuitiously includes "-1" */
4616 STATUS_NATIVE_SET(44);
4619 if (!vaxc$errno) /* unlikely */
4620 STATUS_NATIVE_SET(44);
4622 STATUS_NATIVE_SET(vaxc$errno);
4627 STATUS_POSIX_SET(errno);
4629 exitstatus = STATUS_POSIX >> 8;
4630 if (exitstatus & 255)
4631 STATUS_POSIX_SET(exitstatus);
4633 STATUS_POSIX_SET(255);
4640 S_my_exit_jump(pTHX)
4642 register PERL_CONTEXT *cx;
4647 SvREFCNT_dec(PL_e_script);
4648 PL_e_script = Nullsv;
4651 POPSTACK_TO(PL_mainstack);
4652 if (cxstack_ix >= 0) {
4655 POPBLOCK(cx,PL_curpm);
4663 read_e_script(pTHX_ int idx, SV *buf_sv, int maxlen)
4666 p = SvPVX(PL_e_script);
4667 nl = strchr(p, '\n');
4668 nl = (nl) ? nl+1 : SvEND(PL_e_script);
4670 filter_del(read_e_script);
4673 sv_catpvn(buf_sv, p, nl-p);
4674 sv_chop(PL_e_script, nl);