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\" \t%s\n\",",PL_localpatches[i]);
1371 Perl_sv_catpvf(aTHX_ PL_Sv,"\" Built under %s\\n\"",OSNAME);
1374 Perl_sv_catpvf(aTHX_ PL_Sv,",\" Compiled at %s %s\\n\"",__DATE__,__TIME__);
1376 Perl_sv_catpvf(aTHX_ PL_Sv,",\" Compiled on %s\\n\"",__DATE__);
1379 sv_catpv(PL_Sv, "; \
1381 @env = map { \"$_=\\\"$ENV{$_}\\\"\" } sort grep {/^PERL/} keys %ENV; ");
1384 push @env, \"CYGWIN=\\\"$ENV{CYGWIN}\\\"\";");
1387 print \" \\%ENV:\\n @env\\n\" if @env; \
1388 print \" \\@INC:\\n @INC\\n\";");
1391 PL_Sv = newSVpv("config_vars(qw(",0);
1392 sv_catpv(PL_Sv, ++s);
1393 sv_catpv(PL_Sv, "))");
1396 av_push(PL_preambleav, PL_Sv);
1397 scriptname = BIT_BUCKET; /* don't look for script or read stdin */
1400 PL_doextract = TRUE;
1408 if (!*++s || isSPACE(*s)) {
1412 /* catch use of gnu style long options */
1413 if (strEQ(s, "version")) {
1417 if (strEQ(s, "help")) {
1424 Perl_croak(aTHX_ "Unrecognized switch: -%s (-h will show valid options)",s);
1430 #ifndef SECURE_INTERNAL_GETENV
1433 (s = PerlEnv_getenv("PERL5OPT")))
1438 if (*s == '-' && *(s+1) == 'T') {
1439 CHECK_MALLOC_TOO_LATE_FOR('T');
1441 PL_taint_warn = FALSE;
1444 char *popt_copy = Nullch;
1457 if (!strchr("DIMUdmtwA", *s))
1458 Perl_croak(aTHX_ "Illegal switch in PERL5OPT: -%c", *s);
1462 popt_copy = SvPVX(sv_2mortal(newSVpv(popt,0)));
1463 s = popt_copy + (s - popt);
1464 d = popt_copy + (d - popt);
1471 if( !PL_tainting ) {
1472 PL_taint_warn = TRUE;
1482 if (PL_taint_warn && PL_dowarn != G_WARN_ALL_OFF) {
1483 PL_compiling.cop_warnings = newSVpvn(WARN_TAINTstring, WARNsize);
1487 scriptname = argv[0];
1490 scriptname = BIT_BUCKET; /* don't look for script or read stdin */
1492 else if (scriptname == Nullch) {
1494 if ( PerlLIO_isatty(PerlIO_fileno(PerlIO_stdin())) )
1502 open_script(scriptname,dosearch,sv);
1504 validate_suid(validarg, scriptname);
1507 #if defined(SIGCHLD) || defined(SIGCLD)
1510 # define SIGCHLD SIGCLD
1512 Sighandler_t sigstate = rsignal_state(SIGCHLD);
1513 if (sigstate == SIG_IGN) {
1514 if (ckWARN(WARN_SIGNAL))
1515 Perl_warner(aTHX_ packWARN(WARN_SIGNAL),
1516 "Can't ignore signal CHLD, forcing to default");
1517 (void)rsignal(SIGCHLD, (Sighandler_t)SIG_DFL);
1523 #ifdef MACOS_TRADITIONAL
1524 if (PL_doextract || gMacPerl_AlwaysExtract) {
1529 if (cddir && PerlDir_chdir(cddir) < 0)
1530 Perl_croak(aTHX_ "Can't chdir to %s",cddir);
1534 PL_main_cv = PL_compcv = (CV*)NEWSV(1104,0);
1535 sv_upgrade((SV *)PL_compcv, SVt_PVCV);
1536 CvUNIQUE_on(PL_compcv);
1538 CvPADLIST(PL_compcv) = pad_new(0);
1539 #ifdef USE_5005THREADS
1540 CvOWNER(PL_compcv) = 0;
1541 New(666, CvMUTEXP(PL_compcv), 1, perl_mutex);
1542 MUTEX_INIT(CvMUTEXP(PL_compcv));
1543 #endif /* USE_5005THREADS */
1546 boot_core_UNIVERSAL();
1547 boot_core_xsutils();
1550 (*xsinit)(aTHX); /* in case linked C routines want magical variables */
1552 #if defined(VMS) || defined(WIN32) || defined(DJGPP) || defined(__CYGWIN__) || defined(EPOC)
1558 # ifdef HAS_SOCKS5_INIT
1559 socks5_init(argv[0]);
1565 init_predump_symbols();
1566 /* init_postdump_symbols not currently designed to be called */
1567 /* more than once (ENV isn't cleared first, for example) */
1568 /* But running with -u leaves %ENV & @ARGV undefined! XXX */
1570 init_postdump_symbols(argc,argv,env);
1572 /* PL_unicode is turned on by -C or by $ENV{PERL_UNICODE}.
1573 * PL_utf8locale is conditionally turned on by
1574 * locale.c:Perl_init_i18nl10n() if the environment
1575 * look like the user wants to use UTF-8. */
1577 /* Requires init_predump_symbols(). */
1578 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
1583 /* Turn on UTF-8-ness on STDIN, STDOUT, STDERR
1584 * and the default open disciplines. */
1585 if ((PL_unicode & PERL_UNICODE_STDIN_FLAG) &&
1586 PL_stdingv && (io = GvIO(PL_stdingv)) &&
1588 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
1589 if ((PL_unicode & PERL_UNICODE_STDOUT_FLAG) &&
1590 PL_defoutgv && (io = GvIO(PL_defoutgv)) &&
1592 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
1593 if ((PL_unicode & PERL_UNICODE_STDERR_FLAG) &&
1594 PL_stderrgv && (io = GvIO(PL_stderrgv)) &&
1596 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
1597 if ((PL_unicode & PERL_UNICODE_INOUT_FLAG) &&
1598 (sv = GvSV(gv_fetchpv("\017PEN", TRUE, SVt_PV)))) {
1599 U32 in = PL_unicode & PERL_UNICODE_IN_FLAG;
1600 U32 out = PL_unicode & PERL_UNICODE_OUT_FLAG;
1603 sv_setpvn(sv, ":utf8\0:utf8", 11);
1605 sv_setpvn(sv, ":utf8\0", 6);
1608 sv_setpvn(sv, "\0:utf8", 6);
1614 if ((s = PerlEnv_getenv("PERL_SIGNALS"))) {
1615 if (strEQ(s, "unsafe"))
1616 PL_signals |= PERL_SIGNALS_UNSAFE_FLAG;
1617 else if (strEQ(s, "safe"))
1618 PL_signals &= ~PERL_SIGNALS_UNSAFE_FLAG;
1620 Perl_croak(aTHX_ "PERL_SIGNALS illegal: \"%s\"", s);
1625 /* now parse the script */
1627 SETERRNO(0,SS_NORMAL);
1629 #ifdef MACOS_TRADITIONAL
1630 if (gMacPerl_SyntaxError = (yyparse() || PL_error_count)) {
1632 Perl_croak(aTHX_ "%s had compilation errors.\n", MacPerl_MPWFileName(PL_origfilename));
1634 Perl_croak(aTHX_ "Execution of %s aborted due to compilation errors.\n",
1635 MacPerl_MPWFileName(PL_origfilename));
1639 if (yyparse() || PL_error_count) {
1641 Perl_croak(aTHX_ "%s had compilation errors.\n", PL_origfilename);
1643 Perl_croak(aTHX_ "Execution of %s aborted due to compilation errors.\n",
1648 CopLINE_set(PL_curcop, 0);
1649 PL_curstash = PL_defstash;
1650 PL_preprocess = FALSE;
1652 SvREFCNT_dec(PL_e_script);
1653 PL_e_script = Nullsv;
1660 SAVECOPFILE(PL_curcop);
1661 SAVECOPLINE(PL_curcop);
1662 gv_check(PL_defstash);
1669 if ((s=PerlEnv_getenv("PERL_DEBUG_MSTATS")) && atoi(s) >= 2)
1670 dump_mstats("after compilation:");
1679 =for apidoc perl_run
1681 Tells a Perl interpreter to run. See L<perlembed>.
1692 #ifdef USE_5005THREADS
1696 oldscope = PL_scopestack_ix;
1701 #ifdef PERL_FLEXIBLE_EXCEPTIONS
1703 CALLPROTECT(aTHX_ pcur_env, &ret, MEMBER_TO_FPTR(S_vrun_body), oldscope);
1709 cxstack_ix = -1; /* start context stack again */
1711 case 0: /* normal completion */
1712 #ifndef PERL_FLEXIBLE_EXCEPTIONS
1717 case 2: /* my_exit() */
1718 while (PL_scopestack_ix > oldscope)
1721 PL_curstash = PL_defstash;
1722 if (!(PL_exit_flags & PERL_EXIT_DESTRUCT_END) &&
1723 PL_endav && !PL_minus_c)
1724 call_list(oldscope, PL_endav);
1726 if (PerlEnv_getenv("PERL_DEBUG_MSTATS"))
1727 dump_mstats("after execution: ");
1729 ret = STATUS_NATIVE_EXPORT;
1733 POPSTACK_TO(PL_mainstack);
1736 PerlIO_printf(Perl_error_log, "panic: restartop\n");
1746 #ifdef PERL_FLEXIBLE_EXCEPTIONS
1748 S_vrun_body(pTHX_ va_list args)
1750 I32 oldscope = va_arg(args, I32);
1752 return run_body(oldscope);
1758 S_run_body(pTHX_ I32 oldscope)
1760 DEBUG_r(PerlIO_printf(Perl_debug_log, "%s $` $& $' support.\n",
1761 PL_sawampersand ? "Enabling" : "Omitting"));
1763 if (!PL_restartop) {
1764 DEBUG_x(dump_all());
1766 PERL_DEBUG(PerlIO_printf(Perl_debug_log, "\nEXECUTING...\n\n"));
1767 DEBUG_S(PerlIO_printf(Perl_debug_log, "main thread is 0x%"UVxf"\n",
1771 #ifdef MACOS_TRADITIONAL
1772 PerlIO_printf(Perl_error_log, "%s%s syntax OK\n",
1773 (gMacPerl_ErrorFormat ? "# " : ""),
1774 MacPerl_MPWFileName(PL_origfilename));
1776 PerlIO_printf(Perl_error_log, "%s syntax OK\n", PL_origfilename);
1780 if (PERLDB_SINGLE && PL_DBsingle)
1781 sv_setiv(PL_DBsingle, 1);
1783 call_list(oldscope, PL_initav);
1789 PL_op = PL_restartop;
1793 else if (PL_main_start) {
1794 CvDEPTH(PL_main_cv) = 1;
1795 PL_op = PL_main_start;
1805 =head1 SV Manipulation Functions
1807 =for apidoc p||get_sv
1809 Returns the SV of the specified Perl scalar. If C<create> is set and the
1810 Perl variable does not exist then it will be created. If C<create> is not
1811 set and the variable does not exist then NULL is returned.
1817 Perl_get_sv(pTHX_ const char *name, I32 create)
1820 #ifdef USE_5005THREADS
1821 if (name[1] == '\0' && !isALPHA(name[0])) {
1822 PADOFFSET tmp = find_threadsv(name);
1823 if (tmp != NOT_IN_PAD)
1824 return THREADSV(tmp);
1826 #endif /* USE_5005THREADS */
1827 gv = gv_fetchpv(name, create, SVt_PV);
1834 =head1 Array Manipulation Functions
1836 =for apidoc p||get_av
1838 Returns the AV of the specified Perl array. If C<create> is set and the
1839 Perl variable does not exist then it will be created. If C<create> is not
1840 set and the variable does not exist then NULL is returned.
1846 Perl_get_av(pTHX_ const char *name, I32 create)
1848 GV* gv = gv_fetchpv(name, create, SVt_PVAV);
1857 =head1 Hash Manipulation Functions
1859 =for apidoc p||get_hv
1861 Returns the HV of the specified Perl hash. If C<create> is set and the
1862 Perl variable does not exist then it will be created. If C<create> is not
1863 set and the variable does not exist then NULL is returned.
1869 Perl_get_hv(pTHX_ const char *name, I32 create)
1871 GV* gv = gv_fetchpv(name, create, SVt_PVHV);
1880 =head1 CV Manipulation Functions
1882 =for apidoc p||get_cv
1884 Returns the CV of the specified Perl subroutine. If C<create> is set and
1885 the Perl subroutine does not exist then it will be declared (which has the
1886 same effect as saying C<sub name;>). If C<create> is not set and the
1887 subroutine does not exist then NULL is returned.
1893 Perl_get_cv(pTHX_ const char *name, I32 create)
1895 GV* gv = gv_fetchpv(name, create, SVt_PVCV);
1896 /* XXX unsafe for threads if eval_owner isn't held */
1897 /* XXX this is probably not what they think they're getting.
1898 * It has the same effect as "sub name;", i.e. just a forward
1900 if (create && !GvCVu(gv))
1901 return newSUB(start_subparse(FALSE, 0),
1902 newSVOP(OP_CONST, 0, newSVpv(name,0)),
1910 /* Be sure to refetch the stack pointer after calling these routines. */
1914 =head1 Callback Functions
1916 =for apidoc p||call_argv
1918 Performs a callback to the specified Perl sub. See L<perlcall>.
1924 Perl_call_argv(pTHX_ const char *sub_name, I32 flags, register char **argv)
1926 /* See G_* flags in cop.h */
1927 /* null terminated arg list */
1934 XPUSHs(sv_2mortal(newSVpv(*argv,0)));
1939 return call_pv(sub_name, flags);
1943 =for apidoc p||call_pv
1945 Performs a callback to the specified Perl sub. See L<perlcall>.
1951 Perl_call_pv(pTHX_ const char *sub_name, I32 flags)
1952 /* name of the subroutine */
1953 /* See G_* flags in cop.h */
1955 return call_sv((SV*)get_cv(sub_name, TRUE), flags);
1959 =for apidoc p||call_method
1961 Performs a callback to the specified Perl method. The blessed object must
1962 be on the stack. See L<perlcall>.
1968 Perl_call_method(pTHX_ const char *methname, I32 flags)
1969 /* name of the subroutine */
1970 /* See G_* flags in cop.h */
1972 return call_sv(sv_2mortal(newSVpv(methname,0)), flags | G_METHOD);
1975 /* May be called with any of a CV, a GV, or an SV containing the name. */
1977 =for apidoc p||call_sv
1979 Performs a callback to the Perl sub whose name is in the SV. See
1986 Perl_call_sv(pTHX_ SV *sv, I32 flags)
1987 /* See G_* flags in cop.h */
1990 LOGOP myop; /* fake syntax tree node */
1993 volatile I32 retval = 0;
1995 bool oldcatch = CATCH_GET;
2000 if (flags & G_DISCARD) {
2005 Zero(&myop, 1, LOGOP);
2006 myop.op_next = Nullop;
2007 if (!(flags & G_NOARGS))
2008 myop.op_flags |= OPf_STACKED;
2009 myop.op_flags |= ((flags & G_VOID) ? OPf_WANT_VOID :
2010 (flags & G_ARRAY) ? OPf_WANT_LIST :
2015 EXTEND(PL_stack_sp, 1);
2016 *++PL_stack_sp = sv;
2018 oldscope = PL_scopestack_ix;
2020 if (PERLDB_SUB && PL_curstash != PL_debstash
2021 /* Handle first BEGIN of -d. */
2022 && (PL_DBcv || (PL_DBcv = GvCV(PL_DBsub)))
2023 /* Try harder, since this may have been a sighandler, thus
2024 * curstash may be meaningless. */
2025 && (SvTYPE(sv) != SVt_PVCV || CvSTASH((CV*)sv) != PL_debstash)
2026 && !(flags & G_NODEBUG))
2027 PL_op->op_private |= OPpENTERSUB_DB;
2029 if (flags & G_METHOD) {
2030 Zero(&method_op, 1, UNOP);
2031 method_op.op_next = PL_op;
2032 method_op.op_ppaddr = PL_ppaddr[OP_METHOD];
2033 myop.op_ppaddr = PL_ppaddr[OP_ENTERSUB];
2034 PL_op = (OP*)&method_op;
2037 if (!(flags & G_EVAL)) {
2039 call_body((OP*)&myop, FALSE);
2040 retval = PL_stack_sp - (PL_stack_base + oldmark);
2041 CATCH_SET(oldcatch);
2044 myop.op_other = (OP*)&myop;
2046 /* we're trying to emulate pp_entertry() here */
2048 register PERL_CONTEXT *cx;
2049 I32 gimme = GIMME_V;
2054 push_return(Nullop);
2055 PUSHBLOCK(cx, (CXt_EVAL|CXp_TRYBLOCK), PL_stack_sp);
2057 PL_eval_root = PL_op; /* Only needed so that goto works right. */
2059 PL_in_eval = EVAL_INEVAL;
2060 if (flags & G_KEEPERR)
2061 PL_in_eval |= EVAL_KEEPERR;
2067 #ifdef PERL_FLEXIBLE_EXCEPTIONS
2069 CALLPROTECT(aTHX_ pcur_env, &ret, MEMBER_TO_FPTR(S_vcall_body),
2076 #ifndef PERL_FLEXIBLE_EXCEPTIONS
2078 call_body((OP*)&myop, FALSE);
2080 retval = PL_stack_sp - (PL_stack_base + oldmark);
2081 if (!(flags & G_KEEPERR))
2088 /* my_exit() was called */
2089 PL_curstash = PL_defstash;
2092 if (PL_statusvalue && !(PL_exit_flags & PERL_EXIT_EXPECTED))
2093 Perl_croak(aTHX_ "Callback called exit");
2098 PL_op = PL_restartop;
2102 PL_stack_sp = PL_stack_base + oldmark;
2103 if (flags & G_ARRAY)
2107 *++PL_stack_sp = &PL_sv_undef;
2112 if (PL_scopestack_ix > oldscope) {
2116 register PERL_CONTEXT *cx;
2128 if (flags & G_DISCARD) {
2129 PL_stack_sp = PL_stack_base + oldmark;
2138 #ifdef PERL_FLEXIBLE_EXCEPTIONS
2140 S_vcall_body(pTHX_ va_list args)
2142 OP *myop = va_arg(args, OP*);
2143 int is_eval = va_arg(args, int);
2145 call_body(myop, is_eval);
2151 S_call_body(pTHX_ OP *myop, int is_eval)
2153 if (PL_op == myop) {
2155 PL_op = Perl_pp_entereval(aTHX); /* this doesn't do a POPMARK */
2157 PL_op = Perl_pp_entersub(aTHX); /* this does */
2163 /* Eval a string. The G_EVAL flag is always assumed. */
2166 =for apidoc p||eval_sv
2168 Tells Perl to C<eval> the string in the SV.
2174 Perl_eval_sv(pTHX_ SV *sv, I32 flags)
2176 /* See G_* flags in cop.h */
2179 UNOP myop; /* fake syntax tree node */
2180 volatile I32 oldmark = SP - PL_stack_base;
2181 volatile I32 retval = 0;
2187 if (flags & G_DISCARD) {
2194 Zero(PL_op, 1, UNOP);
2195 EXTEND(PL_stack_sp, 1);
2196 *++PL_stack_sp = sv;
2197 oldscope = PL_scopestack_ix;
2199 if (!(flags & G_NOARGS))
2200 myop.op_flags = OPf_STACKED;
2201 myop.op_next = Nullop;
2202 myop.op_type = OP_ENTEREVAL;
2203 myop.op_flags |= ((flags & G_VOID) ? OPf_WANT_VOID :
2204 (flags & G_ARRAY) ? OPf_WANT_LIST :
2206 if (flags & G_KEEPERR)
2207 myop.op_flags |= OPf_SPECIAL;
2209 #ifdef PERL_FLEXIBLE_EXCEPTIONS
2211 CALLPROTECT(aTHX_ pcur_env, &ret, MEMBER_TO_FPTR(S_vcall_body),
2218 #ifndef PERL_FLEXIBLE_EXCEPTIONS
2220 call_body((OP*)&myop,TRUE);
2222 retval = PL_stack_sp - (PL_stack_base + oldmark);
2223 if (!(flags & G_KEEPERR))
2230 /* my_exit() was called */
2231 PL_curstash = PL_defstash;
2234 if (PL_statusvalue && !(PL_exit_flags & PERL_EXIT_EXPECTED))
2235 Perl_croak(aTHX_ "Callback called exit");
2240 PL_op = PL_restartop;
2244 PL_stack_sp = PL_stack_base + oldmark;
2245 if (flags & G_ARRAY)
2249 *++PL_stack_sp = &PL_sv_undef;
2255 if (flags & G_DISCARD) {
2256 PL_stack_sp = PL_stack_base + oldmark;
2266 =for apidoc p||eval_pv
2268 Tells Perl to C<eval> the given string and return an SV* result.
2274 Perl_eval_pv(pTHX_ const char *p, I32 croak_on_error)
2277 SV* sv = newSVpv(p, 0);
2279 eval_sv(sv, G_SCALAR);
2286 if (croak_on_error && SvTRUE(ERRSV)) {
2288 Perl_croak(aTHX_ SvPVx(ERRSV, n_a));
2294 /* Require a module. */
2297 =head1 Embedding Functions
2299 =for apidoc p||require_pv
2301 Tells Perl to C<require> the file named by the string argument. It is
2302 analogous to the Perl code C<eval "require '$file'">. It's even
2303 implemented that way; consider using load_module instead.
2308 Perl_require_pv(pTHX_ const char *pv)
2312 PUSHSTACKi(PERLSI_REQUIRE);
2314 sv = sv_newmortal();
2315 sv_setpv(sv, "require '");
2318 eval_sv(sv, G_DISCARD);
2324 Perl_magicname(pTHX_ char *sym, char *name, I32 namlen)
2328 if ((gv = gv_fetchpv(sym,TRUE, SVt_PV)))
2329 sv_magic(GvSV(gv), (SV*)gv, PERL_MAGIC_sv, name, namlen);
2333 S_usage(pTHX_ char *name) /* XXX move this out into a module ? */
2335 /* This message really ought to be max 23 lines.
2336 * Removed -h because the user already knows that option. Others? */
2338 static char *usage_msg[] = {
2339 "-0[octal] specify record separator (\\0, if no argument)",
2340 "-a autosplit mode with -n or -p (splits $_ into @F)",
2341 "-C[number/list] enables the listed Unicode features",
2342 "-c check syntax only (runs BEGIN and CHECK blocks)",
2343 "-d[:debugger] run program under debugger",
2344 "-D[number/list] set debugging flags (argument is a bit mask or alphabets)",
2345 "-e program one line of program (several -e's allowed, omit programfile)",
2346 "-F/pattern/ split() pattern for -a switch (//'s are optional)",
2347 "-i[extension] edit <> files in place (makes backup if extension supplied)",
2348 "-Idirectory specify @INC/#include directory (several -I's allowed)",
2349 "-l[octal] enable line ending processing, specifies line terminator",
2350 "-[mM][-]module execute `use/no module...' before executing program",
2351 "-n assume 'while (<>) { ... }' loop around program",
2352 "-p assume loop like -n but print line also, like sed",
2353 "-P run program through C preprocessor before compilation",
2354 "-s enable rudimentary parsing for switches after programfile",
2355 "-S look for programfile using PATH environment variable",
2356 "-t enable tainting warnings",
2357 "-T enable tainting checks",
2358 "-u dump core after parsing program",
2359 "-U allow unsafe operations",
2360 "-v print version, subversion (includes VERY IMPORTANT perl info)",
2361 "-V[:variable] print configuration summary (or a single Config.pm variable)",
2362 "-w enable many useful warnings (RECOMMENDED)",
2363 "-W enable all warnings",
2364 "-x[directory] strip off text before #!perl line and perhaps cd to directory",
2365 "-X disable all warnings",
2369 char **p = usage_msg;
2371 PerlIO_printf(PerlIO_stdout(),
2372 "\nUsage: %s [switches] [--] [programfile] [arguments]",
2375 PerlIO_printf(PerlIO_stdout(), "\n %s", *p++);
2378 /* convert a string of -D options (or digits) into an int.
2379 * sets *s to point to the char after the options */
2383 Perl_get_debug_opts(pTHX_ char **s)
2387 /* if adding extra options, remember to update DEBUG_MASK */
2388 static char debopts[] = "psltocPmfrxu HXDSTRJvCAq";
2390 for (; isALNUM(**s); (*s)++) {
2391 char *d = strchr(debopts,**s);
2393 i |= 1 << (d - debopts);
2394 else if (ckWARN_d(WARN_DEBUGGING))
2395 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
2396 "invalid option -D%c\n", **s);
2401 for (; isALNUM(**s); (*s)++) ;
2404 if ((i & DEBUG_p_FLAG) && ckWARN_d(WARN_DEBUGGING))
2405 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
2406 "-Dp not implemented on this platform\n");
2412 /* This routine handles any switches that can be given during run */
2415 Perl_moreswitches(pTHX_ char *s)
2425 SvREFCNT_dec(PL_rs);
2426 if (s[1] == 'x' && s[2]) {
2430 for (s += 2, e = s; *e; e++);
2432 flags = PERL_SCAN_SILENT_ILLDIGIT;
2433 rschar = (U32)grok_hex(s, &numlen, &flags, NULL);
2434 if (s + numlen < e) {
2435 rschar = 0; /* Grandfather -0xFOO as -0 -xFOO. */
2439 PL_rs = newSVpvn("", 0);
2440 SvGROW(PL_rs, (STRLEN)(UNISKIP(rschar) + 1));
2441 tmps = (U8*)SvPVX(PL_rs);
2442 uvchr_to_utf8(tmps, rschar);
2443 SvCUR_set(PL_rs, UNISKIP(rschar));
2448 rschar = (U32)grok_oct(s, &numlen, &flags, NULL);
2449 if (rschar & ~((U8)~0))
2450 PL_rs = &PL_sv_undef;
2451 else if (!rschar && numlen >= 2)
2452 PL_rs = newSVpvn("", 0);
2454 char ch = (char)rschar;
2455 PL_rs = newSVpvn(&ch, 1);
2458 sv_setsv(get_sv("/", TRUE), PL_rs);
2463 PL_unicode = parse_unicode_opts(&s);
2468 while (*s && !isSPACE(*s)) ++s;
2470 PL_splitstr = savepv(PL_splitstr);
2483 /* The following permits -d:Mod to accepts arguments following an =
2484 in the fashion that -MSome::Mod does. */
2485 if (*s == ':' || *s == '=') {
2488 sv = newSVpv("use Devel::", 0);
2490 /* We now allow -d:Module=Foo,Bar */
2491 while(isALNUM(*s) || *s==':') ++s;
2493 sv_catpv(sv, start);
2495 sv_catpvn(sv, start, s-start);
2496 sv_catpv(sv, " split(/,/,q{");
2501 my_setenv("PERL5DB", SvPV(sv, PL_na));
2504 PL_perldb = PERLDB_ALL;
2513 PL_debug = get_debug_opts(&s) | DEBUG_TOP_FLAG;
2514 #else /* !DEBUGGING */
2515 if (ckWARN_d(WARN_DEBUGGING))
2516 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
2517 "Recompile perl with -DDEBUGGING to use -D switch\n");
2518 for (s++; isALNUM(*s); s++) ;
2524 usage(PL_origargv[0]);
2528 Safefree(PL_inplace);
2529 #if defined(__CYGWIN__) /* do backup extension automagically */
2530 if (*(s+1) == '\0') {
2531 PL_inplace = savepv(".bak");
2534 #endif /* __CYGWIN__ */
2535 PL_inplace = savepv(s+1);
2537 for (s = PL_inplace; *s && !isSPACE(*s); s++) ;
2540 if (*s == '-') /* Additional switches on #! line. */
2544 case 'I': /* -I handled both here and in parse_body() */
2547 while (*s && isSPACE(*s))
2552 /* ignore trailing spaces (possibly followed by other switches) */
2554 for (e = p; *e && !isSPACE(*e); e++) ;
2558 } while (*p && *p != '-');
2559 e = savepvn(s, e-s);
2560 incpush(e, TRUE, TRUE, FALSE);
2567 Perl_croak(aTHX_ "No directory specified for -I");
2573 SvREFCNT_dec(PL_ors_sv);
2578 PL_ors_sv = newSVpvn("\n",1);
2579 numlen = 3 + (*s == '0');
2580 *SvPVX(PL_ors_sv) = (char)grok_oct(s, &numlen, &flags, NULL);
2584 if (RsPARA(PL_rs)) {
2585 PL_ors_sv = newSVpvn("\n\n",2);
2588 PL_ors_sv = newSVsv(PL_rs);
2595 PL_preambleav = newAV();
2597 SV *sv = newSVpv("use assertions::activate split(/,/,q", 0);
2598 sv_catpvn(sv, "\0", 1); /* Use NUL as q//-delimiter. */
2600 sv_catpvn(sv, "\0)", 2);
2602 av_push(PL_preambleav, sv);
2605 av_push(PL_preambleav, newSVpvn("use assertions::activate",24));
2608 forbid_setid("-M"); /* XXX ? */
2611 forbid_setid("-m"); /* XXX ? */
2616 /* -M-foo == 'no foo' */
2617 if (*s == '-') { use = "no "; ++s; }
2618 sv = newSVpv(use,0);
2620 /* We allow -M'Module qw(Foo Bar)' */
2621 while(isALNUM(*s) || *s==':') ++s;
2623 sv_catpv(sv, start);
2624 if (*(start-1) == 'm') {
2626 Perl_croak(aTHX_ "Can't use '%c' after -mname", *s);
2627 sv_catpv( sv, " ()");
2631 Perl_croak(aTHX_ "Module name required with -%c option",
2633 sv_catpvn(sv, start, s-start);
2634 sv_catpv(sv, " split(/,/,q");
2635 sv_catpvn(sv, "\0)", 1); /* Use NUL as q//-delimiter. */
2637 sv_catpvn(sv, "\0)", 2);
2641 PL_preambleav = newAV();
2642 av_push(PL_preambleav, sv);
2645 Perl_croak(aTHX_ "No space allowed after -%c", *(s-1));
2657 PL_doswitches = TRUE;
2671 #ifdef MACOS_TRADITIONAL
2672 Perl_croak(aTHX_ "Believe me, you don't want to use \"-u\" on a Macintosh");
2674 PL_do_undump = TRUE;
2683 PerlIO_printf(PerlIO_stdout(),
2684 Perl_form(aTHX_ "\nThis is perl, v%"VDf" built for %s",
2685 PL_patchlevel, ARCHNAME));
2687 /* Adjust verbose output as in the perl that ships with the DG/UX OS from EMC */
2688 PerlIO_printf(PerlIO_stdout(),
2689 Perl_form(aTHX_ "\nThis is perl, version %vd\n", PL_patchlevel));
2690 PerlIO_printf(PerlIO_stdout(),
2691 Perl_form(aTHX_ " built under %s at %s %s\n",
2692 OSNAME, __DATE__, __TIME__));
2693 PerlIO_printf(PerlIO_stdout(),
2694 Perl_form(aTHX_ " OS Specific Release: %s\n",
2698 #if defined(LOCAL_PATCH_COUNT)
2699 if (LOCAL_PATCH_COUNT > 0)
2700 PerlIO_printf(PerlIO_stdout(),
2701 "\n(with %d registered patch%s, "
2702 "see perl -V for more detail)",
2703 (int)LOCAL_PATCH_COUNT,
2704 (LOCAL_PATCH_COUNT!=1) ? "es" : "");
2707 PerlIO_printf(PerlIO_stdout(),
2708 "\n\nCopyright 1987-2004, Larry Wall\n");
2709 #ifdef MACOS_TRADITIONAL
2710 PerlIO_printf(PerlIO_stdout(),
2711 "\nMac OS port Copyright 1991-2002, Matthias Neeracher;\n"
2712 "maintained by Chris Nandor\n");
2715 PerlIO_printf(PerlIO_stdout(),
2716 "\nMS-DOS port Copyright (c) 1989, 1990, Diomidis Spinellis\n");
2719 PerlIO_printf(PerlIO_stdout(),
2720 "djgpp v2 port (jpl5003c) by Hirofumi Watanabe, 1996\n"
2721 "djgpp v2 port (perl5004+) by Laszlo Molnar, 1997-1999\n");
2724 PerlIO_printf(PerlIO_stdout(),
2725 "\n\nOS/2 port Copyright (c) 1990, 1991, Raymond Chen, Kai Uwe Rommel\n"
2726 "Version 5 port Copyright (c) 1994-2002, Andreas Kaiser, Ilya Zakharevich\n");
2729 PerlIO_printf(PerlIO_stdout(),
2730 "atariST series port, ++jrb bammi@cadence.com\n");
2733 PerlIO_printf(PerlIO_stdout(),
2734 "BeOS port Copyright Tom Spindler, 1997-1999\n");
2737 PerlIO_printf(PerlIO_stdout(),
2738 "MPE/iX port Copyright by Mark Klein and Mark Bixby, 1996-2003\n");
2741 PerlIO_printf(PerlIO_stdout(),
2742 "MVS (OS390) port by Mortice Kern Systems, 1997-1999\n");
2745 PerlIO_printf(PerlIO_stdout(),
2746 "Stratus VOS port by Paul.Green@stratus.com, 1997-2002\n");
2749 PerlIO_printf(PerlIO_stdout(),
2750 "VM/ESA port by Neale Ferguson, 1998-1999\n");
2753 PerlIO_printf(PerlIO_stdout(),
2754 "BS2000 (POSIX) port by Start Amadeus GmbH, 1998-1999\n");
2757 PerlIO_printf(PerlIO_stdout(),
2758 "MiNT port by Guido Flohr, 1997-1999\n");
2761 PerlIO_printf(PerlIO_stdout(),
2762 "EPOC port by Olaf Flebbe, 1999-2002\n");
2765 PerlIO_printf(PerlIO_stdout(),"WINCE port by Rainer Keuchel, 2001-2002\n");
2766 PerlIO_printf(PerlIO_stdout(),"Built on " __DATE__ " " __TIME__ "\n\n");
2769 #ifdef BINARY_BUILD_NOTICE
2770 BINARY_BUILD_NOTICE;
2772 PerlIO_printf(PerlIO_stdout(),
2774 Perl may be copied only under the terms of either the Artistic License or the\n\
2775 GNU General Public License, which may be found in the Perl 5 source kit.\n\n\
2776 Complete documentation for Perl, including FAQ lists, should be found on\n\
2777 this system using `man perl' or `perldoc perl'. If you have access to the\n\
2778 Internet, point your browser at http://www.perl.com/, the Perl Home Page.\n\n");
2781 if (! (PL_dowarn & G_WARN_ALL_MASK))
2782 PL_dowarn |= G_WARN_ON;
2786 PL_dowarn = G_WARN_ALL_ON|G_WARN_ON;
2787 if (!specialWARN(PL_compiling.cop_warnings))
2788 SvREFCNT_dec(PL_compiling.cop_warnings);
2789 PL_compiling.cop_warnings = pWARN_ALL ;
2793 PL_dowarn = G_WARN_ALL_OFF;
2794 if (!specialWARN(PL_compiling.cop_warnings))
2795 SvREFCNT_dec(PL_compiling.cop_warnings);
2796 PL_compiling.cop_warnings = pWARN_NONE ;
2801 if (s[1] == '-') /* Additional switches on #! line. */
2806 #if defined(WIN32) || !defined(PERL_STRICT_CR)
2812 #ifdef ALTERNATE_SHEBANG
2813 case 'S': /* OS/2 needs -S on "extproc" line. */
2821 Perl_croak(aTHX_ "Can't emulate -%.1s on #! line",s);
2826 /* compliments of Tom Christiansen */
2828 /* unexec() can be found in the Gnu emacs distribution */
2829 /* Known to work with -DUNEXEC and using unexelf.c from GNU emacs-20.2 */
2832 Perl_my_unexec(pTHX)
2840 prog = newSVpv(BIN_EXP, 0);
2841 sv_catpv(prog, "/perl");
2842 file = newSVpv(PL_origfilename, 0);
2843 sv_catpv(file, ".perldump");
2845 unexec(SvPVX(file), SvPVX(prog), &etext, sbrk(0), 0);
2846 /* unexec prints msg to stderr in case of failure */
2847 PerlProc_exit(status);
2850 # include <lib$routines.h>
2851 lib$signal(SS$_DEBUG); /* ssdef.h #included from vmsish.h */
2853 ABORT(); /* for use with undump */
2858 /* initialize curinterp */
2864 # define PERLVAR(var,type)
2865 # define PERLVARA(var,n,type)
2866 # if defined(PERL_IMPLICIT_CONTEXT)
2867 # if defined(USE_5005THREADS)
2868 # define PERLVARI(var,type,init) PERL_GET_INTERP->var = init;
2869 # define PERLVARIC(var,type,init) PERL_GET_INTERP->var = init;
2870 # else /* !USE_5005THREADS */
2871 # define PERLVARI(var,type,init) aTHX->var = init;
2872 # define PERLVARIC(var,type,init) aTHX->var = init;
2873 # endif /* USE_5005THREADS */
2875 # define PERLVARI(var,type,init) PERL_GET_INTERP->var = init;
2876 # define PERLVARIC(var,type,init) PERL_GET_INTERP->var = init;
2878 # include "intrpvar.h"
2879 # ifndef USE_5005THREADS
2880 # include "thrdvar.h"
2887 # define PERLVAR(var,type)
2888 # define PERLVARA(var,n,type)
2889 # define PERLVARI(var,type,init) PL_##var = init;
2890 # define PERLVARIC(var,type,init) PL_##var = init;
2891 # include "intrpvar.h"
2892 # ifndef USE_5005THREADS
2893 # include "thrdvar.h"
2904 S_init_main_stash(pTHX)
2908 PL_curstash = PL_defstash = newHV();
2909 PL_curstname = newSVpvn("main",4);
2910 gv = gv_fetchpv("main::",TRUE, SVt_PVHV);
2911 SvREFCNT_dec(GvHV(gv));
2912 GvHV(gv) = (HV*)SvREFCNT_inc(PL_defstash);
2914 HvNAME(PL_defstash) = savepv("main");
2915 PL_incgv = gv_HVadd(gv_AVadd(gv_fetchpv("INC",TRUE, SVt_PVAV)));
2916 GvMULTI_on(PL_incgv);
2917 PL_hintgv = gv_fetchpv("\010",TRUE, SVt_PV); /* ^H */
2918 GvMULTI_on(PL_hintgv);
2919 PL_defgv = gv_fetchpv("_",TRUE, SVt_PVAV);
2920 PL_errgv = gv_HVadd(gv_fetchpv("@", TRUE, SVt_PV));
2921 GvMULTI_on(PL_errgv);
2922 PL_replgv = gv_fetchpv("\022", TRUE, SVt_PV); /* ^R */
2923 GvMULTI_on(PL_replgv);
2924 (void)Perl_form(aTHX_ "%240s",""); /* Preallocate temp - for immediate signals. */
2925 sv_grow(ERRSV, 240); /* Preallocate - for immediate signals. */
2926 sv_setpvn(ERRSV, "", 0);
2927 PL_curstash = PL_defstash;
2928 CopSTASH_set(&PL_compiling, PL_defstash);
2929 PL_debstash = GvHV(gv_fetchpv("DB::", GV_ADDMULTI, SVt_PVHV));
2930 PL_globalstash = GvHV(gv_fetchpv("CORE::GLOBAL::", GV_ADDMULTI, SVt_PVHV));
2931 /* We must init $/ before switches are processed. */
2932 sv_setpvn(get_sv("/", TRUE), "\n", 1);
2935 /* PSz 18 Nov 03 fdscript now global but do not change prototype */
2937 S_open_script(pTHX_ char *scriptname, bool dosearch, SV *sv)
2942 char *cpp_discard_flag;
2950 PL_origfilename = savepv("-e");
2953 /* if find_script() returns, it returns a malloc()-ed value */
2954 PL_origfilename = scriptname = find_script(scriptname, dosearch, NULL, 1);
2956 if (strnEQ(scriptname, "/dev/fd/", 8) && isDIGIT(scriptname[8]) ) {
2957 char *s = scriptname + 8;
2958 PL_fdscript = atoi(s);
2963 * Tell apart "normal" usage of fdscript, e.g.
2964 * with bash on FreeBSD:
2965 * perl <( echo '#!perl -DA'; echo 'print "$0\n"')
2966 * from usage in suidperl.
2967 * Does any "normal" usage leave garbage after the number???
2968 * Is it a mistake to use a similar /dev/fd/ construct for
2973 * Be supersafe and do some sanity-checks.
2974 * Still, can we be sure we got the right thing?
2977 Perl_croak(aTHX_ "Wrong syntax (suid) fd script name \"%s\"\n", s);
2980 Perl_croak(aTHX_ "Missing (suid) fd script name\n");
2982 scriptname = savepv(s + 1);
2983 Safefree(PL_origfilename);
2984 PL_origfilename = scriptname;
2989 CopFILE_free(PL_curcop);
2990 CopFILE_set(PL_curcop, PL_origfilename);
2991 if (strEQ(PL_origfilename,"-"))
2993 if (PL_fdscript >= 0) {
2994 PL_rsfp = PerlIO_fdopen(PL_fdscript,PERL_SCRIPT_MODE);
2995 # if defined(HAS_FCNTL) && defined(F_SETFD)
2997 /* ensure close-on-exec */
2998 fcntl(PerlIO_fileno(PL_rsfp),F_SETFD,1);
3003 Perl_croak(aTHX_ "suidperl needs fd script\n");
3005 * Do not open (or do other fancy stuff) while setuid.
3006 * Perl does the open, and hands script to suidperl on a fd;
3007 * suidperl only does some checks, sets up UIDs and re-execs
3008 * perl with that fd as it has always done.
3011 if (PL_suidscript != 1) {
3012 Perl_croak(aTHX_ "suidperl needs (suid) fd script\n");
3015 else if (PL_preprocess) {
3016 char *cpp_cfg = CPPSTDIN;
3017 SV *cpp = newSVpvn("",0);
3018 SV *cmd = NEWSV(0,0);
3020 if (cpp_cfg[0] == 0) /* PERL_MICRO? */
3021 Perl_croak(aTHX_ "Can't run with cpp -P with CPPSTDIN undefined");
3022 if (strEQ(cpp_cfg, "cppstdin"))
3023 Perl_sv_catpvf(aTHX_ cpp, "%s/", BIN_EXP);
3024 sv_catpv(cpp, cpp_cfg);
3027 sv_catpvn(sv, "-I", 2);
3028 sv_catpv(sv,PRIVLIB_EXP);
3031 DEBUG_P(PerlIO_printf(Perl_debug_log,
3032 "PL_preprocess: scriptname=\"%s\", cpp=\"%s\", sv=\"%s\", CPPMINUS=\"%s\"\n",
3033 scriptname, SvPVX (cpp), SvPVX (sv), CPPMINUS));
3035 # if defined(MSDOS) || defined(WIN32) || defined(VMS)
3042 cpp_discard_flag = "";
3044 cpp_discard_flag = "-C";
3048 perl = os2_execname(aTHX);
3050 perl = PL_origargv[0];
3054 /* This strips off Perl comments which might interfere with
3055 the C pre-processor, including #!. #line directives are
3056 deliberately stripped to avoid confusion with Perl's version
3057 of #line. FWP played some golf with it so it will fit
3058 into VMS's 255 character buffer.
3061 code = "(1../^#!.*perl/i)|/^\\s*#(?!\\s*((ifn?|un)def|(el|end)?if|define|include|else|error|pragma)\\b)/||!($|=1)||print";
3063 code = "/^\\s*#(?!\\s*((ifn?|un)def|(el|end)?if|define|include|else|error|pragma)\\b)/||!($|=1)||print";
3065 Perl_sv_setpvf(aTHX_ cmd, "\
3066 %s -ne%s%s%s %s | %"SVf" %s %"SVf" %s",
3067 perl, quote, code, quote, scriptname, cpp,
3068 cpp_discard_flag, sv, CPPMINUS);
3070 PL_doextract = FALSE;
3072 DEBUG_P(PerlIO_printf(Perl_debug_log,
3073 "PL_preprocess: cmd=\"%s\"\n",
3076 PL_rsfp = PerlProc_popen(SvPVX(cmd), "r");
3080 else if (!*scriptname) {
3081 forbid_setid("program input from stdin");
3082 PL_rsfp = PerlIO_stdin();
3085 PL_rsfp = PerlIO_open(scriptname,PERL_SCRIPT_MODE);
3086 # if defined(HAS_FCNTL) && defined(F_SETFD)
3088 /* ensure close-on-exec */
3089 fcntl(PerlIO_fileno(PL_rsfp),F_SETFD,1);
3092 #endif /* IAMSUID */
3094 /* PSz 16 Sep 03 Keep neat error message */
3095 Perl_croak(aTHX_ "Can't open perl script \"%s\": %s\n",
3096 CopFILE(PL_curcop), Strerror(errno));
3101 * I_SYSSTATVFS HAS_FSTATVFS
3103 * I_STATFS HAS_FSTATFS HAS_GETFSSTAT
3104 * I_MNTENT HAS_GETMNTENT HAS_HASMNTOPT
3105 * here so that metaconfig picks them up. */
3109 S_fd_on_nosuid_fs(pTHX_ int fd)
3112 * We used to do this as "plain" user (after swapping UIDs with setreuid);
3113 * but is needed also on machines without setreuid.
3114 * Seems safe enough to run as root.
3116 int check_okay = 0; /* able to do all the required sys/libcalls */
3117 int on_nosuid = 0; /* the fd is on a nosuid fs */
3119 * Need to check noexec also: nosuid might not be set, the average
3120 * sysadmin would say that nosuid is irrelevant once he sets noexec.
3122 int on_noexec = 0; /* the fd is on a noexec fs */
3125 * Preferred order: fstatvfs(), fstatfs(), ustat()+getmnt(), getmntent().
3126 * fstatvfs() is UNIX98.
3127 * fstatfs() is 4.3 BSD.
3128 * ustat()+getmnt() is pre-4.3 BSD.
3129 * getmntent() is O(number-of-mounted-filesystems) and can hang on
3130 * an irrelevant filesystem while trying to reach the right one.
3133 #undef FD_ON_NOSUID_CHECK_OKAY /* found the syscalls to do the check? */
3135 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3136 defined(HAS_FSTATVFS)
3137 # define FD_ON_NOSUID_CHECK_OKAY
3138 struct statvfs stfs;
3140 check_okay = fstatvfs(fd, &stfs) == 0;
3141 on_nosuid = check_okay && (stfs.f_flag & ST_NOSUID);
3143 /* ST_NOEXEC certainly absent on AIX 5.1, and doesn't seem to be documented
3144 on platforms where it is present. */
3145 on_noexec = check_okay && (stfs.f_flag & ST_NOEXEC);
3147 # endif /* fstatvfs */
3149 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3150 defined(PERL_MOUNT_NOSUID) && \
3151 defined(PERL_MOUNT_NOEXEC) && \
3152 defined(HAS_FSTATFS) && \
3153 defined(HAS_STRUCT_STATFS) && \
3154 defined(HAS_STRUCT_STATFS_F_FLAGS)
3155 # define FD_ON_NOSUID_CHECK_OKAY
3158 check_okay = fstatfs(fd, &stfs) == 0;
3159 on_nosuid = check_okay && (stfs.f_flags & PERL_MOUNT_NOSUID);
3160 on_noexec = check_okay && (stfs.f_flags & PERL_MOUNT_NOEXEC);
3161 # endif /* fstatfs */
3163 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3164 defined(PERL_MOUNT_NOSUID) && \
3165 defined(PERL_MOUNT_NOEXEC) && \
3166 defined(HAS_FSTAT) && \
3167 defined(HAS_USTAT) && \
3168 defined(HAS_GETMNT) && \
3169 defined(HAS_STRUCT_FS_DATA) && \
3171 # define FD_ON_NOSUID_CHECK_OKAY
3174 if (fstat(fd, &fdst) == 0) {
3176 if (ustat(fdst.st_dev, &us) == 0) {
3178 /* NOSTAT_ONE here because we're not examining fields which
3179 * vary between that case and STAT_ONE. */
3180 if (getmnt((int*)0, &fsd, (int)0, NOSTAT_ONE, us.f_fname) == 0) {
3181 size_t cmplen = sizeof(us.f_fname);
3182 if (sizeof(fsd.fd_req.path) < cmplen)
3183 cmplen = sizeof(fsd.fd_req.path);
3184 if (strnEQ(fsd.fd_req.path, us.f_fname, cmplen) &&
3185 fdst.st_dev == fsd.fd_req.dev) {
3187 on_nosuid = fsd.fd_req.flags & PERL_MOUNT_NOSUID;
3188 on_noexec = fsd.fd_req.flags & PERL_MOUNT_NOEXEC;
3194 # endif /* fstat+ustat+getmnt */
3196 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3197 defined(HAS_GETMNTENT) && \
3198 defined(HAS_HASMNTOPT) && \
3199 defined(MNTOPT_NOSUID) && \
3200 defined(MNTOPT_NOEXEC)
3201 # define FD_ON_NOSUID_CHECK_OKAY
3202 FILE *mtab = fopen("/etc/mtab", "r");
3203 struct mntent *entry;
3206 if (mtab && (fstat(fd, &stb) == 0)) {
3207 while (entry = getmntent(mtab)) {
3208 if (stat(entry->mnt_dir, &fsb) == 0
3209 && fsb.st_dev == stb.st_dev)
3211 /* found the filesystem */
3213 if (hasmntopt(entry, MNTOPT_NOSUID))
3215 if (hasmntopt(entry, MNTOPT_NOEXEC))
3218 } /* A single fs may well fail its stat(). */
3223 # endif /* getmntent+hasmntopt */
3226 Perl_croak(aTHX_ "Can't check filesystem of script \"%s\" for nosuid/noexec", PL_origfilename);
3228 Perl_croak(aTHX_ "Setuid script \"%s\" on nosuid filesystem", PL_origfilename);
3230 Perl_croak(aTHX_ "Setuid script \"%s\" on noexec filesystem", PL_origfilename);
3231 return ((!check_okay) || on_nosuid || on_noexec);
3233 #endif /* IAMSUID */
3236 S_validate_suid(pTHX_ char *validarg, char *scriptname)
3240 #endif /* IAMSUID */
3242 /* do we need to emulate setuid on scripts? */
3244 /* This code is for those BSD systems that have setuid #! scripts disabled
3245 * in the kernel because of a security problem. Merely defining DOSUID
3246 * in perl will not fix that problem, but if you have disabled setuid
3247 * scripts in the kernel, this will attempt to emulate setuid and setgid
3248 * on scripts that have those now-otherwise-useless bits set. The setuid
3249 * root version must be called suidperl or sperlN.NNN. If regular perl
3250 * discovers that it has opened a setuid script, it calls suidperl with
3251 * the same argv that it had. If suidperl finds that the script it has
3252 * just opened is NOT setuid root, it sets the effective uid back to the
3253 * uid. We don't just make perl setuid root because that loses the
3254 * effective uid we had before invoking perl, if it was different from the
3257 * Description/comments above do not match current workings:
3258 * suidperl must be hardlinked to sperlN.NNN (that is what we exec);
3259 * suidperl called with script open and name changed to /dev/fd/N/X;
3260 * suidperl croaks if script is not setuid;
3261 * making perl setuid would be a huge security risk (and yes, that
3262 * would lose any euid we might have had).
3264 * DOSUID must be defined in both perl and suidperl, and IAMSUID must
3265 * be defined in suidperl only. suidperl must be setuid root. The
3266 * Configure script will set this up for you if you want it.
3272 if (PerlLIO_fstat(PerlIO_fileno(PL_rsfp),&PL_statbuf) < 0) /* normal stat is insecure */
3273 Perl_croak(aTHX_ "Can't stat script \"%s\"",PL_origfilename);
3274 if (PL_statbuf.st_mode & (S_ISUID|S_ISGID)) {
3279 if (PL_fdscript < 0 || PL_suidscript != 1)
3280 Perl_croak(aTHX_ "Need (suid) fdscript in suidperl\n"); /* We already checked this */
3282 * Since the script is opened by perl, not suidperl, some of these
3283 * checks are superfluous. Leaving them in probably does not lower
3287 * Do checks even for systems with no HAS_SETREUID.
3288 * We used to swap, then re-swap UIDs with
3290 if (setreuid(PL_euid,PL_uid) < 0
3291 || PerlProc_getuid() != PL_euid || PerlProc_geteuid() != PL_uid)
3292 Perl_croak(aTHX_ "Can't swap uid and euid");
3295 if (setreuid(PL_uid,PL_euid) < 0
3296 || PerlProc_getuid() != PL_uid || PerlProc_geteuid() != PL_euid)
3297 Perl_croak(aTHX_ "Can't reswap uid and euid");
3301 /* On this access check to make sure the directories are readable,
3302 * there is actually a small window that the user could use to make
3303 * filename point to an accessible directory. So there is a faint
3304 * chance that someone could execute a setuid script down in a
3305 * non-accessible directory. I don't know what to do about that.
3306 * But I don't think it's too important. The manual lies when
3307 * it says access() is useful in setuid programs.
3309 * So, access() is pretty useless... but not harmful... do anyway.
3311 if (PerlLIO_access(CopFILE(PL_curcop),1)) { /*double check*/
3312 Perl_croak(aTHX_ "Can't access() script\n");
3315 /* If we can swap euid and uid, then we can determine access rights
3316 * with a simple stat of the file, and then compare device and
3317 * inode to make sure we did stat() on the same file we opened.
3318 * Then we just have to make sure he or she can execute it.
3321 * As the script is opened by perl, not suidperl, we do not need to
3322 * care much about access rights.
3324 * The 'script changed' check is needed, or we can get lied to
3325 * about $0 with e.g.
3326 * suidperl /dev/fd/4//bin/x 4<setuidscript
3327 * Without HAS_SETREUID, is it safe to stat() as root?
3329 * Are there any operating systems that pass /dev/fd/xxx for setuid
3330 * scripts, as suggested/described in perlsec(1)? Surely they do not
3331 * pass the script name as we do, so the "script changed" test would
3332 * fail for them... but we never get here with
3333 * SETUID_SCRIPTS_ARE_SECURE_NOW defined.
3335 * This is one place where we must "lie" about return status: not
3336 * say if the stat() failed. We are doing this as root, and could
3337 * be tricked into reporting existence or not of files that the
3338 * "plain" user cannot even see.
3342 if (PerlLIO_stat(CopFILE(PL_curcop),&tmpstatbuf) < 0 ||
3343 tmpstatbuf.st_dev != PL_statbuf.st_dev ||
3344 tmpstatbuf.st_ino != PL_statbuf.st_ino) {
3345 Perl_croak(aTHX_ "Setuid script changed\n");
3349 if (!cando(S_IXUSR,FALSE,&PL_statbuf)) /* can real uid exec? */
3350 Perl_croak(aTHX_ "Real UID cannot exec script\n");
3353 * We used to do this check as the "plain" user (after swapping
3354 * UIDs). But the check for nosuid and noexec filesystem is needed,
3355 * and should be done even without HAS_SETREUID. (Maybe those
3356 * operating systems do not have such mount options anyway...)
3357 * Seems safe enough to do as root.
3359 #if !defined(NO_NOSUID_CHECK)
3360 if (fd_on_nosuid_fs(PerlIO_fileno(PL_rsfp))) {
3361 Perl_croak(aTHX_ "Setuid script on nosuid or noexec filesystem\n");
3364 #endif /* IAMSUID */
3366 if (!S_ISREG(PL_statbuf.st_mode)) {
3367 Perl_croak(aTHX_ "Setuid script not plain file\n");
3369 if (PL_statbuf.st_mode & S_IWOTH)
3370 Perl_croak(aTHX_ "Setuid/gid script is writable by world");
3371 PL_doswitches = FALSE; /* -s is insecure in suid */
3372 /* PSz 13 Nov 03 But -s was caught elsewhere ... so unsetting it here is useless(?!) */
3373 CopLINE_inc(PL_curcop);
3374 if (sv_gets(PL_linestr, PL_rsfp, 0) == Nullch ||
3375 strnNE(SvPV(PL_linestr,n_a),"#!",2) ) /* required even on Sys V */
3376 Perl_croak(aTHX_ "No #! line");
3377 s = SvPV(PL_linestr,n_a)+2;
3379 /* Sanity check on line length */
3380 if (strlen(s) < 1 || strlen(s) > 4000)
3381 Perl_croak(aTHX_ "Very long #! line");
3382 /* Allow more than a single space after #! */
3383 while (isSPACE(*s)) s++;
3384 /* Sanity check on buffer end */
3385 while ((*s) && !isSPACE(*s)) s++;
3386 for (s2 = s; (s2 > SvPV(PL_linestr,n_a)+2 &&
3387 (isDIGIT(s2[-1]) || strchr("._-", s2[-1]))); s2--) ;
3388 /* Sanity check on buffer start */
3389 if ( (s2-4 < SvPV(PL_linestr,n_a)+2 || strnNE(s2-4,"perl",4)) &&
3390 (s-9 < SvPV(PL_linestr,n_a)+2 || strnNE(s-9,"perl",4)) )
3391 Perl_croak(aTHX_ "Not a perl script");
3392 while (*s == ' ' || *s == '\t') s++;
3394 * #! arg must be what we saw above. They can invoke it by
3395 * mentioning suidperl explicitly, but they may not add any strange
3396 * arguments beyond what #! says if they do invoke suidperl that way.
3399 * The way validarg was set up, we rely on the kernel to start
3400 * scripts with argv[1] set to contain all #! line switches (the
3404 * Check that we got all the arguments listed in the #! line (not
3405 * just that there are no extraneous arguments). Might not matter
3406 * much, as switches from #! line seem to be acted upon (also), and
3407 * so may be checked and trapped in perl. But, security checks must
3408 * be done in suidperl and not deferred to perl. Note that suidperl
3409 * does not get around to parsing (and checking) the switches on
3410 * the #! line (but execs perl sooner).
3411 * Allow (require) a trailing newline (which may be of two
3412 * characters on some architectures?) (but no other trailing
3415 len = strlen(validarg);
3416 if (strEQ(validarg," PHOOEY ") ||
3417 strnNE(s,validarg,len) || !isSPACE(s[len]) ||
3418 !(strlen(s) == len+1 || (strlen(s) == len+2 && isSPACE(s[len+1]))))
3419 Perl_croak(aTHX_ "Args must match #! line");
3422 if (PL_fdscript < 0 &&
3423 PL_euid != PL_uid && (PL_statbuf.st_mode & S_ISUID) &&
3424 PL_euid == PL_statbuf.st_uid)
3426 Perl_croak(aTHX_ "YOU HAVEN'T DISABLED SET-ID SCRIPTS IN THE KERNEL YET!\n\
3427 FIX YOUR KERNEL, OR PUT A C WRAPPER AROUND THIS SCRIPT!\n");
3428 #endif /* IAMSUID */
3430 if (PL_fdscript < 0 &&
3431 PL_euid) { /* oops, we're not the setuid root perl */
3433 * When root runs a setuid script, we do not go through the same
3434 * steps of execing sperl and then perl with fd scripts, but
3435 * simply set up UIDs within the same perl invocation; so do
3436 * not have the same checks (on options, whatever) that we have
3437 * for plain users. No problem really: would have to be a script
3438 * that does not actually work for plain users; and if root is
3439 * foolish and can be persuaded to run such an unsafe script, he
3440 * might run also non-setuid ones, and deserves what he gets.
3442 * Or, we might drop the PL_euid check above (and rely just on
3443 * PL_fdscript to avoid loops), and do the execs
3449 * Pass fd script to suidperl.
3450 * Exec suidperl, substituting fd script for scriptname.
3451 * Pass script name as "subdir" of fd, which perl will grok;
3452 * in fact will use that to distinguish this from "normal"
3453 * usage, see comments above.
3455 PerlIO_rewind(PL_rsfp);
3456 PerlLIO_lseek(PerlIO_fileno(PL_rsfp),(Off_t)0,0); /* just in case rewind didn't */
3457 /* PSz 27 Feb 04 Sanity checks on scriptname */
3458 if ((!scriptname) || (!*scriptname) ) {
3459 Perl_croak(aTHX_ "No setuid script name\n");
3461 if (*scriptname == '-') {
3462 Perl_croak(aTHX_ "Setuid script name may not begin with dash\n");
3463 /* Or we might confuse it with an option when replacing
3464 * name in argument list, below (though we do pointer, not
3465 * string, comparisons).
3468 for (which = 1; PL_origargv[which] && PL_origargv[which] != scriptname; which++) ;
3469 if (!PL_origargv[which]) {
3470 Perl_croak(aTHX_ "Can't change argv to have fd script\n");
3472 PL_origargv[which] = savepv(Perl_form(aTHX_ "/dev/fd/%d/%s",
3473 PerlIO_fileno(PL_rsfp), PL_origargv[which]));
3474 #if defined(HAS_FCNTL) && defined(F_SETFD)
3475 fcntl(PerlIO_fileno(PL_rsfp),F_SETFD,0); /* ensure no close-on-exec */
3478 PerlProc_execv(Perl_form(aTHX_ "%s/sperl"PERL_FS_VER_FMT, BIN_EXP,
3479 (int)PERL_REVISION, (int)PERL_VERSION,
3480 (int)PERL_SUBVERSION), PL_origargv);
3482 #endif /* IAMSUID */
3483 Perl_croak(aTHX_ "Can't do setuid (cannot exec sperl)\n");
3486 if (PL_statbuf.st_mode & S_ISGID && PL_statbuf.st_gid != PL_egid) {
3488 * This seems back to front: we try HAS_SETEGID first; if not available
3489 * then try HAS_SETREGID; as a last chance we try HAS_SETRESGID. May be OK
3490 * in the sense that we only want to set EGID; but are there any machines
3491 * with either of the latter, but not the former? Same with UID, later.
3494 (void)setegid(PL_statbuf.st_gid);
3497 (void)setregid((Gid_t)-1,PL_statbuf.st_gid);
3499 #ifdef HAS_SETRESGID
3500 (void)setresgid((Gid_t)-1,PL_statbuf.st_gid,(Gid_t)-1);
3502 PerlProc_setgid(PL_statbuf.st_gid);
3506 if (PerlProc_getegid() != PL_statbuf.st_gid)
3507 Perl_croak(aTHX_ "Can't do setegid!\n");
3509 if (PL_statbuf.st_mode & S_ISUID) {
3510 if (PL_statbuf.st_uid != PL_euid)
3512 (void)seteuid(PL_statbuf.st_uid); /* all that for this */
3515 (void)setreuid((Uid_t)-1,PL_statbuf.st_uid);
3517 #ifdef HAS_SETRESUID
3518 (void)setresuid((Uid_t)-1,PL_statbuf.st_uid,(Uid_t)-1);
3520 PerlProc_setuid(PL_statbuf.st_uid);
3524 if (PerlProc_geteuid() != PL_statbuf.st_uid)
3525 Perl_croak(aTHX_ "Can't do seteuid!\n");
3527 else if (PL_uid) { /* oops, mustn't run as root */
3529 (void)seteuid((Uid_t)PL_uid);
3532 (void)setreuid((Uid_t)-1,(Uid_t)PL_uid);
3534 #ifdef HAS_SETRESUID
3535 (void)setresuid((Uid_t)-1,(Uid_t)PL_uid,(Uid_t)-1);
3537 PerlProc_setuid((Uid_t)PL_uid);
3541 if (PerlProc_geteuid() != PL_uid)
3542 Perl_croak(aTHX_ "Can't do seteuid!\n");
3545 if (!cando(S_IXUSR,TRUE,&PL_statbuf))
3546 Perl_croak(aTHX_ "Effective UID cannot exec script\n"); /* they can't do this */
3549 else if (PL_preprocess) /* PSz 13 Nov 03 Caught elsewhere, useless(?!) here */
3550 Perl_croak(aTHX_ "-P not allowed for setuid/setgid script\n");
3551 else if (PL_fdscript < 0 || PL_suidscript != 1)
3552 /* PSz 13 Nov 03 Caught elsewhere, useless(?!) here */
3553 Perl_croak(aTHX_ "(suid) fdscript needed in suidperl\n");
3555 /* PSz 16 Sep 03 Keep neat error message */
3556 Perl_croak(aTHX_ "Script is not setuid/setgid in suidperl\n");
3559 /* We absolutely must clear out any saved ids here, so we */
3560 /* exec the real perl, substituting fd script for scriptname. */
3561 /* (We pass script name as "subdir" of fd, which perl will grok.) */
3563 * It might be thought that using setresgid and/or setresuid (changed to
3564 * set the saved IDs) above might obviate the need to exec, and we could
3565 * go on to "do the perl thing".
3567 * Is there such a thing as "saved GID", and is that set for setuid (but
3568 * not setgid) execution like suidperl? Without exec, it would not be
3569 * cleared for setuid (but not setgid) scripts (or might need a dummy
3572 * We need suidperl to do the exact same argument checking that perl
3573 * does. Thus it cannot be very small; while it could be significantly
3574 * smaller, it is safer (simpler?) to make it essentially the same
3575 * binary as perl (but they are not identical). - Maybe could defer that
3576 * check to the invoked perl, and suidperl be a tiny wrapper instead;
3577 * but prefer to do thorough checks in suidperl itself. Such deferral
3578 * would make suidperl security rely on perl, a design no-no.
3580 * Setuid things should be short and simple, thus easy to understand and
3581 * verify. They should do their "own thing", without influence by
3582 * attackers. It may help if their internal execution flow is fixed,
3583 * regardless of platform: it may be best to exec anyway.
3585 * Suidperl should at least be conceptually simple: a wrapper only,
3586 * never to do any real perl. Maybe we should put
3588 * Perl_croak(aTHX_ "Suidperl should never do real perl\n");
3590 * into the perly bits.
3592 PerlIO_rewind(PL_rsfp);
3593 PerlLIO_lseek(PerlIO_fileno(PL_rsfp),(Off_t)0,0); /* just in case rewind didn't */
3595 * Keep original arguments: suidperl already has fd script.
3597 /* for (which = 1; PL_origargv[which] && PL_origargv[which] != scriptname; which++) ; */
3598 /* if (!PL_origargv[which]) { */
3599 /* errno = EPERM; */
3600 /* Perl_croak(aTHX_ "Permission denied\n"); */
3602 /* PL_origargv[which] = savepv(Perl_form(aTHX_ "/dev/fd/%d/%s", */
3603 /* PerlIO_fileno(PL_rsfp), PL_origargv[which])); */
3604 #if defined(HAS_FCNTL) && defined(F_SETFD)
3605 fcntl(PerlIO_fileno(PL_rsfp),F_SETFD,0); /* ensure no close-on-exec */
3608 PerlProc_execv(Perl_form(aTHX_ "%s/perl"PERL_FS_VER_FMT, BIN_EXP,
3609 (int)PERL_REVISION, (int)PERL_VERSION,
3610 (int)PERL_SUBVERSION), PL_origargv);/* try again */
3612 Perl_croak(aTHX_ "Can't do setuid (suidperl cannot exec perl)\n");
3613 #endif /* IAMSUID */
3615 if (PL_euid != PL_uid || PL_egid != PL_gid) { /* (suidperl doesn't exist, in fact) */
3616 #ifndef SETUID_SCRIPTS_ARE_SECURE_NOW
3617 PerlLIO_fstat(PerlIO_fileno(PL_rsfp),&PL_statbuf); /* may be either wrapped or real suid */
3618 if ((PL_euid != PL_uid && PL_euid == PL_statbuf.st_uid && PL_statbuf.st_mode & S_ISUID)
3620 (PL_egid != PL_gid && PL_egid == PL_statbuf.st_gid && PL_statbuf.st_mode & S_ISGID)
3623 Perl_croak(aTHX_ "YOU HAVEN'T DISABLED SET-ID SCRIPTS IN THE KERNEL YET!\n\
3624 FIX YOUR KERNEL, PUT A C WRAPPER AROUND THIS SCRIPT, OR USE -u AND UNDUMP!\n");
3625 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
3626 /* not set-id, must be wrapped */
3632 S_find_beginning(pTHX)
3634 register char *s, *s2;
3635 #ifdef MACOS_TRADITIONAL
3639 /* skip forward in input to the real script? */
3642 #ifdef MACOS_TRADITIONAL
3643 /* Since the Mac OS does not honor #! arguments for us, we do it ourselves */
3645 while (PL_doextract || gMacPerl_AlwaysExtract) {
3646 if ((s = sv_gets(PL_linestr, PL_rsfp, 0)) == Nullch) {
3647 if (!gMacPerl_AlwaysExtract)
3648 Perl_croak(aTHX_ "No Perl script found in input\n");
3650 if (PL_doextract) /* require explicit override ? */
3651 if (!OverrideExtract(PL_origfilename))
3652 Perl_croak(aTHX_ "User aborted script\n");
3654 PL_doextract = FALSE;
3656 /* Pater peccavi, file does not have #! */
3657 PerlIO_rewind(PL_rsfp);
3662 while (PL_doextract) {
3663 if ((s = sv_gets(PL_linestr, PL_rsfp, 0)) == Nullch)
3664 Perl_croak(aTHX_ "No Perl script found in input\n");
3667 if (*s == '#' && s[1] == '!' && ((s = instr(s,"perl")) || (s = instr(s2,"PERL")))) {
3668 PerlIO_ungetc(PL_rsfp, '\n'); /* to keep line count right */
3669 PL_doextract = FALSE;
3670 while (*s && !(isSPACE (*s) || *s == '#')) s++;
3672 while (*s == ' ' || *s == '\t') s++;
3674 while (isDIGIT(s2[-1]) || strchr("-._", s2[-1])) s2--;
3675 if (strnEQ(s2-4,"perl",4))
3677 while ((s = moreswitches(s)))
3680 #ifdef MACOS_TRADITIONAL
3681 /* We are always searching for the #!perl line in MacPerl,
3682 * so if we find it, still keep the line count correct
3683 * by counting lines we already skipped over
3685 for (; maclines > 0 ; maclines--)
3686 PerlIO_ungetc(PL_rsfp, '\n');
3690 /* gMacPerl_AlwaysExtract is false in MPW tool */
3691 } else if (gMacPerl_AlwaysExtract) {
3702 PL_uid = PerlProc_getuid();
3703 PL_euid = PerlProc_geteuid();
3704 PL_gid = PerlProc_getgid();
3705 PL_egid = PerlProc_getegid();
3707 PL_uid |= PL_gid << 16;
3708 PL_euid |= PL_egid << 16;
3710 /* Should not happen: */
3711 CHECK_MALLOC_TAINT(PL_uid && (PL_euid != PL_uid || PL_egid != PL_gid));
3712 PL_tainting |= (PL_uid && (PL_euid != PL_uid || PL_egid != PL_gid));
3715 * Should go by suidscript, not uid!=euid: why disallow
3716 * system("ls") in scripts run from setuid things?
3717 * Or, is this run before we check arguments and set suidscript?
3718 * What about SETUID_SCRIPTS_ARE_SECURE_NOW: could we use fdscript then?
3719 * (We never have suidscript, can we be sure to have fdscript?)
3720 * Or must then go by UID checks? See comments in forbid_setid also.
3724 /* This is used very early in the lifetime of the program,
3725 * before even the options are parsed, so PL_tainting has
3726 * not been initialized properly. */
3728 Perl_doing_taint(int argc, char *argv[], char *envp[])
3730 #ifndef PERL_IMPLICIT_SYS
3731 /* If we have PERL_IMPLICIT_SYS we can't call getuid() et alia
3732 * before we have an interpreter-- and the whole point of this
3733 * function is to be called at such an early stage. If you are on
3734 * a system with PERL_IMPLICIT_SYS but you do have a concept of
3735 * "tainted because running with altered effective ids', you'll
3736 * have to add your own checks somewhere in here. The two most
3737 * known samples of 'implicitness' are Win32 and NetWare, neither
3738 * of which has much of concept of 'uids'. */
3739 int uid = PerlProc_getuid();
3740 int euid = PerlProc_geteuid();
3741 int gid = PerlProc_getgid();
3742 int egid = PerlProc_getegid();
3748 if (uid && (euid != uid || egid != gid))
3750 #endif /* !PERL_IMPLICIT_SYS */
3751 /* This is a really primitive check; environment gets ignored only
3752 * if -T are the first chars together; otherwise one gets
3753 * "Too late" message. */
3754 if ( argc > 1 && argv[1][0] == '-'
3755 && (argv[1][1] == 't' || argv[1][1] == 'T') )
3761 S_forbid_setid(pTHX_ char *s)
3763 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
3764 if (PL_euid != PL_uid)
3765 Perl_croak(aTHX_ "No %s allowed while running setuid", s);
3766 if (PL_egid != PL_gid)
3767 Perl_croak(aTHX_ "No %s allowed while running setgid", s);
3768 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
3770 * Checks for UID/GID above "wrong": why disallow
3771 * perl -e 'print "Hello\n"'
3772 * from within setuid things?? Simply drop them: replaced by
3773 * fdscript/suidscript and #ifdef IAMSUID checks below.
3775 * This may be too late for command-line switches. Will catch those on
3776 * the #! line, after finding the script name and setting up
3777 * fdscript/suidscript. Note that suidperl does not get around to
3778 * parsing (and checking) the switches on the #! line, but checks that
3779 * the two sets are identical.
3781 * With SETUID_SCRIPTS_ARE_SECURE_NOW, could we use fdscript, also or
3782 * instead, or would that be "too late"? (We never have suidscript, can
3783 * we be sure to have fdscript?)
3785 * Catch things with suidscript (in descendant of suidperl), even with
3786 * right UID/GID. Was already checked in suidperl, with #ifdef IAMSUID,
3787 * below; but I am paranoid.
3789 * Also see comments about root running a setuid script, elsewhere.
3791 if (PL_suidscript >= 0)
3792 Perl_croak(aTHX_ "No %s allowed with (suid) fdscript", s);
3794 /* PSz 11 Nov 03 Catch it in suidperl, always! */
3795 Perl_croak(aTHX_ "No %s allowed in suidperl", s);
3796 #endif /* IAMSUID */
3800 Perl_init_debugger(pTHX)
3802 HV *ostash = PL_curstash;
3804 PL_curstash = PL_debstash;
3805 PL_dbargs = GvAV(gv_AVadd((gv_fetchpv("DB::args", GV_ADDMULTI, SVt_PVAV))));
3806 AvREAL_off(PL_dbargs);
3807 PL_DBgv = gv_fetchpv("DB::DB", GV_ADDMULTI, SVt_PVGV);
3808 PL_DBline = gv_fetchpv("DB::dbline", GV_ADDMULTI, SVt_PVAV);
3809 PL_DBsub = gv_HVadd(gv_fetchpv("DB::sub", GV_ADDMULTI, SVt_PVHV));
3810 sv_upgrade(GvSV(PL_DBsub), SVt_IV); /* IVX accessed if PERLDB_SUB_NN */
3811 PL_DBsingle = GvSV((gv_fetchpv("DB::single", GV_ADDMULTI, SVt_PV)));
3812 sv_setiv(PL_DBsingle, 0);
3813 PL_DBtrace = GvSV((gv_fetchpv("DB::trace", GV_ADDMULTI, SVt_PV)));
3814 sv_setiv(PL_DBtrace, 0);
3815 PL_DBsignal = GvSV((gv_fetchpv("DB::signal", GV_ADDMULTI, SVt_PV)));
3816 sv_setiv(PL_DBsignal, 0);
3817 PL_DBassertion = GvSV((gv_fetchpv("DB::assertion", GV_ADDMULTI, SVt_PV)));
3818 sv_setiv(PL_DBassertion, 0);
3819 PL_curstash = ostash;
3822 #ifndef STRESS_REALLOC
3823 #define REASONABLE(size) (size)
3825 #define REASONABLE(size) (1) /* unreasonable */
3829 Perl_init_stacks(pTHX)
3831 /* start with 128-item stack and 8K cxstack */
3832 PL_curstackinfo = new_stackinfo(REASONABLE(128),
3833 REASONABLE(8192/sizeof(PERL_CONTEXT) - 1));
3834 PL_curstackinfo->si_type = PERLSI_MAIN;
3835 PL_curstack = PL_curstackinfo->si_stack;
3836 PL_mainstack = PL_curstack; /* remember in case we switch stacks */
3838 PL_stack_base = AvARRAY(PL_curstack);
3839 PL_stack_sp = PL_stack_base;
3840 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
3842 New(50,PL_tmps_stack,REASONABLE(128),SV*);
3845 PL_tmps_max = REASONABLE(128);
3847 New(54,PL_markstack,REASONABLE(32),I32);
3848 PL_markstack_ptr = PL_markstack;
3849 PL_markstack_max = PL_markstack + REASONABLE(32);
3853 New(54,PL_scopestack,REASONABLE(32),I32);
3854 PL_scopestack_ix = 0;
3855 PL_scopestack_max = REASONABLE(32);
3857 New(54,PL_savestack,REASONABLE(128),ANY);
3858 PL_savestack_ix = 0;
3859 PL_savestack_max = REASONABLE(128);
3861 New(54,PL_retstack,REASONABLE(16),OP*);
3863 PL_retstack_max = REASONABLE(16);
3871 while (PL_curstackinfo->si_next)
3872 PL_curstackinfo = PL_curstackinfo->si_next;
3873 while (PL_curstackinfo) {
3874 PERL_SI *p = PL_curstackinfo->si_prev;
3875 /* curstackinfo->si_stack got nuked by sv_free_arenas() */
3876 Safefree(PL_curstackinfo->si_cxstack);
3877 Safefree(PL_curstackinfo);
3878 PL_curstackinfo = p;
3880 Safefree(PL_tmps_stack);
3881 Safefree(PL_markstack);
3882 Safefree(PL_scopestack);
3883 Safefree(PL_savestack);
3884 Safefree(PL_retstack);
3893 lex_start(PL_linestr);
3895 PL_subname = newSVpvn("main",4);
3899 S_init_predump_symbols(pTHX)
3904 sv_setpvn(get_sv("\"", TRUE), " ", 1);
3905 PL_stdingv = gv_fetchpv("STDIN",TRUE, SVt_PVIO);
3906 GvMULTI_on(PL_stdingv);
3907 io = GvIOp(PL_stdingv);
3908 IoTYPE(io) = IoTYPE_RDONLY;
3909 IoIFP(io) = PerlIO_stdin();
3910 tmpgv = gv_fetchpv("stdin",TRUE, SVt_PV);
3912 GvIOp(tmpgv) = (IO*)SvREFCNT_inc(io);
3914 tmpgv = gv_fetchpv("STDOUT",TRUE, SVt_PVIO);
3917 IoTYPE(io) = IoTYPE_WRONLY;
3918 IoOFP(io) = IoIFP(io) = PerlIO_stdout();
3920 tmpgv = gv_fetchpv("stdout",TRUE, SVt_PV);
3922 GvIOp(tmpgv) = (IO*)SvREFCNT_inc(io);
3924 PL_stderrgv = gv_fetchpv("STDERR",TRUE, SVt_PVIO);
3925 GvMULTI_on(PL_stderrgv);
3926 io = GvIOp(PL_stderrgv);
3927 IoTYPE(io) = IoTYPE_WRONLY;
3928 IoOFP(io) = IoIFP(io) = PerlIO_stderr();
3929 tmpgv = gv_fetchpv("stderr",TRUE, SVt_PV);
3931 GvIOp(tmpgv) = (IO*)SvREFCNT_inc(io);
3933 PL_statname = NEWSV(66,0); /* last filename we did stat on */
3936 Safefree(PL_osname);
3937 PL_osname = savepv(OSNAME);
3941 Perl_init_argv_symbols(pTHX_ register int argc, register char **argv)
3944 argc--,argv++; /* skip name of script */
3945 if (PL_doswitches) {
3946 for (; argc > 0 && **argv == '-'; argc--,argv++) {
3949 if (argv[0][1] == '-' && !argv[0][2]) {
3953 if ((s = strchr(argv[0], '='))) {
3955 sv_setpv(GvSV(gv_fetchpv(argv[0]+1,TRUE, SVt_PV)),s);
3958 sv_setiv(GvSV(gv_fetchpv(argv[0]+1,TRUE, SVt_PV)),1);
3961 if ((PL_argvgv = gv_fetchpv("ARGV",TRUE, SVt_PVAV))) {
3962 GvMULTI_on(PL_argvgv);
3963 (void)gv_AVadd(PL_argvgv);
3964 av_clear(GvAVn(PL_argvgv));
3965 for (; argc > 0; argc--,argv++) {
3966 SV *sv = newSVpv(argv[0],0);
3967 av_push(GvAVn(PL_argvgv),sv);
3968 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
3969 if (PL_unicode & PERL_UNICODE_ARGV_FLAG)
3972 if (PL_unicode & PERL_UNICODE_WIDESYSCALLS_FLAG) /* Sarathy? */
3973 (void)sv_utf8_decode(sv);
3978 #ifdef HAS_PROCSELFEXE
3979 /* This is a function so that we don't hold on to MAXPATHLEN
3980 bytes of stack longer than necessary
3983 S_procself_val(pTHX_ SV *sv, char *arg0)
3985 char buf[MAXPATHLEN];
3986 int len = readlink(PROCSELFEXE_PATH, buf, sizeof(buf) - 1);
3988 /* On Playstation2 Linux V1.0 (kernel 2.2.1) readlink(/proc/self/exe)
3989 includes a spurious NUL which will cause $^X to fail in system
3990 or backticks (this will prevent extensions from being built and
3991 many tests from working). readlink is not meant to add a NUL.
3992 Normal readlink works fine.
3994 if (len > 0 && buf[len-1] == '\0') {
3998 /* FreeBSD's implementation is acknowledged to be imperfect, sometimes
3999 returning the text "unknown" from the readlink rather than the path
4000 to the executable (or returning an error from the readlink). Any valid
4001 path has a '/' in it somewhere, so use that to validate the result.
4002 See http://www.freebsd.org/cgi/query-pr.cgi?pr=35703
4004 if (len > 0 && memchr(buf, '/', len)) {
4005 sv_setpvn(sv,buf,len);
4011 #endif /* HAS_PROCSELFEXE */
4014 S_init_postdump_symbols(pTHX_ register int argc, register char **argv, register char **env)
4020 PL_toptarget = NEWSV(0,0);
4021 sv_upgrade(PL_toptarget, SVt_PVFM);
4022 sv_setpvn(PL_toptarget, "", 0);
4023 PL_bodytarget = NEWSV(0,0);
4024 sv_upgrade(PL_bodytarget, SVt_PVFM);
4025 sv_setpvn(PL_bodytarget, "", 0);
4026 PL_formtarget = PL_bodytarget;
4030 init_argv_symbols(argc,argv);
4032 if ((tmpgv = gv_fetchpv("0",TRUE, SVt_PV))) {
4033 #ifdef MACOS_TRADITIONAL
4034 /* $0 is not majick on a Mac */
4035 sv_setpv(GvSV(tmpgv),MacPerl_MPWFileName(PL_origfilename));
4037 sv_setpv(GvSV(tmpgv),PL_origfilename);
4038 magicname("0", "0", 1);
4041 if ((tmpgv = gv_fetchpv("\030",TRUE, SVt_PV))) {/* $^X */
4042 #ifdef HAS_PROCSELFEXE
4043 S_procself_val(aTHX_ GvSV(tmpgv), PL_origargv[0]);
4046 sv_setpv(GvSV(tmpgv), os2_execname(aTHX));
4048 sv_setpv(GvSV(tmpgv),PL_origargv[0]);
4052 if ((PL_envgv = gv_fetchpv("ENV",TRUE, SVt_PVHV))) {
4054 GvMULTI_on(PL_envgv);
4055 hv = GvHVn(PL_envgv);
4056 hv_magic(hv, Nullgv, PERL_MAGIC_env);
4058 #ifdef USE_ENVIRON_ARRAY
4059 /* Note that if the supplied env parameter is actually a copy
4060 of the global environ then it may now point to free'd memory
4061 if the environment has been modified since. To avoid this
4062 problem we treat env==NULL as meaning 'use the default'
4067 # ifdef USE_ITHREADS
4068 && PL_curinterp == aTHX
4072 environ[0] = Nullch;
4075 for (; *env; env++) {
4076 if (!(s = strchr(*env,'=')))
4078 #if defined(MSDOS) && !defined(DJGPP)
4083 sv = newSVpv(s+1, 0);
4084 (void)hv_store(hv, *env, s - *env, sv, 0);
4088 #endif /* USE_ENVIRON_ARRAY */
4089 #endif /* !PERL_MICRO */
4092 if ((tmpgv = gv_fetchpv("$",TRUE, SVt_PV))) {
4093 SvREADONLY_off(GvSV(tmpgv));
4094 sv_setiv(GvSV(tmpgv), (IV)PerlProc_getpid());
4095 SvREADONLY_on(GvSV(tmpgv));
4097 #ifdef THREADS_HAVE_PIDS
4098 PL_ppid = (IV)getppid();
4101 /* touch @F array to prevent spurious warnings 20020415 MJD */
4103 (void) get_av("main::F", TRUE | GV_ADDMULTI);
4105 /* touch @- and @+ arrays to prevent spurious warnings 20020415 MJD */
4106 (void) get_av("main::-", TRUE | GV_ADDMULTI);
4107 (void) get_av("main::+", TRUE | GV_ADDMULTI);
4111 S_init_perllib(pTHX)
4116 s = PerlEnv_getenv("PERL5LIB");
4118 incpush(s, TRUE, TRUE, TRUE);
4120 incpush(PerlEnv_getenv("PERLLIB"), FALSE, FALSE, TRUE);
4122 /* Treat PERL5?LIB as a possible search list logical name -- the
4123 * "natural" VMS idiom for a Unix path string. We allow each
4124 * element to be a set of |-separated directories for compatibility.
4128 if (my_trnlnm("PERL5LIB",buf,0))
4129 do { incpush(buf,TRUE,TRUE,TRUE); } while (my_trnlnm("PERL5LIB",buf,++idx));
4131 while (my_trnlnm("PERLLIB",buf,idx++)) incpush(buf,FALSE,FALSE,TRUE);
4135 /* Use the ~-expanded versions of APPLLIB (undocumented),
4136 ARCHLIB PRIVLIB SITEARCH SITELIB VENDORARCH and VENDORLIB
4139 incpush(APPLLIB_EXP, TRUE, TRUE, TRUE);
4143 incpush(ARCHLIB_EXP, FALSE, FALSE, TRUE);
4145 #ifdef MACOS_TRADITIONAL
4148 SV * privdir = NEWSV(55, 0);
4149 char * macperl = PerlEnv_getenv("MACPERL");
4154 Perl_sv_setpvf(aTHX_ privdir, "%slib:", macperl);
4155 if (PerlLIO_stat(SvPVX(privdir), &tmpstatbuf) >= 0 && S_ISDIR(tmpstatbuf.st_mode))
4156 incpush(SvPVX(privdir), TRUE, FALSE, TRUE);
4157 Perl_sv_setpvf(aTHX_ privdir, "%ssite_perl:", macperl);
4158 if (PerlLIO_stat(SvPVX(privdir), &tmpstatbuf) >= 0 && S_ISDIR(tmpstatbuf.st_mode))
4159 incpush(SvPVX(privdir), TRUE, FALSE, TRUE);
4161 SvREFCNT_dec(privdir);
4164 incpush(":", FALSE, FALSE, TRUE);
4167 # define PRIVLIB_EXP "/usr/local/lib/perl5:/usr/local/lib/perl"
4170 incpush(PRIVLIB_EXP, TRUE, FALSE, TRUE);
4172 incpush(PRIVLIB_EXP, FALSE, FALSE, TRUE);
4176 /* sitearch is always relative to sitelib on Windows for
4177 * DLL-based path intuition to work correctly */
4178 # if !defined(WIN32)
4179 incpush(SITEARCH_EXP, FALSE, FALSE, TRUE);
4185 /* this picks up sitearch as well */
4186 incpush(SITELIB_EXP, TRUE, FALSE, TRUE);
4188 incpush(SITELIB_EXP, FALSE, FALSE, TRUE);
4192 #ifdef SITELIB_STEM /* Search for version-specific dirs below here */
4193 incpush(SITELIB_STEM, FALSE, TRUE, TRUE);
4196 #ifdef PERL_VENDORARCH_EXP
4197 /* vendorarch is always relative to vendorlib on Windows for
4198 * DLL-based path intuition to work correctly */
4199 # if !defined(WIN32)
4200 incpush(PERL_VENDORARCH_EXP, FALSE, FALSE, TRUE);
4204 #ifdef PERL_VENDORLIB_EXP
4206 incpush(PERL_VENDORLIB_EXP, TRUE, FALSE, TRUE); /* this picks up vendorarch as well */
4208 incpush(PERL_VENDORLIB_EXP, FALSE, FALSE, TRUE);
4212 #ifdef PERL_VENDORLIB_STEM /* Search for version-specific dirs below here */
4213 incpush(PERL_VENDORLIB_STEM, FALSE, TRUE, TRUE);
4216 #ifdef PERL_OTHERLIBDIRS
4217 incpush(PERL_OTHERLIBDIRS, TRUE, TRUE, TRUE);
4221 incpush(".", FALSE, FALSE, TRUE);
4222 #endif /* MACOS_TRADITIONAL */
4225 #if defined(DOSISH) || defined(EPOC)
4226 # define PERLLIB_SEP ';'
4229 # define PERLLIB_SEP '|'
4231 # if defined(MACOS_TRADITIONAL)
4232 # define PERLLIB_SEP ','
4234 # define PERLLIB_SEP ':'
4238 #ifndef PERLLIB_MANGLE
4239 # define PERLLIB_MANGLE(s,n) (s)
4243 S_incpush(pTHX_ char *p, int addsubdirs, int addoldvers, int usesep)
4245 SV *subdir = Nullsv;
4250 if (addsubdirs || addoldvers) {
4251 subdir = sv_newmortal();
4254 /* Break at all separators */
4256 SV *libdir = NEWSV(55,0);
4259 /* skip any consecutive separators */
4261 while ( *p == PERLLIB_SEP ) {
4262 /* Uncomment the next line for PATH semantics */
4263 /* av_push(GvAVn(PL_incgv), newSVpvn(".", 1)); */
4268 if ( usesep && (s = strchr(p, PERLLIB_SEP)) != Nullch ) {
4269 sv_setpvn(libdir, PERLLIB_MANGLE(p, (STRLEN)(s - p)),
4274 sv_setpv(libdir, PERLLIB_MANGLE(p, 0));
4275 p = Nullch; /* break out */
4277 #ifdef MACOS_TRADITIONAL
4278 if (!strchr(SvPVX(libdir), ':')) {
4281 sv_setpv(libdir, MacPerl_CanonDir(SvPVX(libdir), buf, 0));
4283 if (SvPVX(libdir)[SvCUR(libdir)-1] != ':')
4284 sv_catpv(libdir, ":");
4288 * BEFORE pushing libdir onto @INC we may first push version- and
4289 * archname-specific sub-directories.
4291 if (addsubdirs || addoldvers) {
4292 #ifdef PERL_INC_VERSION_LIST
4293 /* Configure terminates PERL_INC_VERSION_LIST with a NULL */
4294 const char *incverlist[] = { PERL_INC_VERSION_LIST };
4295 const char **incver;
4302 if ((unix = tounixspec_ts(SvPV(libdir,len),Nullch)) != Nullch) {
4304 while (unix[len-1] == '/') len--; /* Cosmetic */
4305 sv_usepvn(libdir,unix,len);
4308 PerlIO_printf(Perl_error_log,
4309 "Failed to unixify @INC element \"%s\"\n",
4313 #ifdef MACOS_TRADITIONAL
4314 #define PERL_AV_SUFFIX_FMT ""
4315 #define PERL_ARCH_FMT "%s:"
4316 #define PERL_ARCH_FMT_PATH PERL_FS_VER_FMT PERL_AV_SUFFIX_FMT
4318 #define PERL_AV_SUFFIX_FMT "/"
4319 #define PERL_ARCH_FMT "/%s"
4320 #define PERL_ARCH_FMT_PATH PERL_AV_SUFFIX_FMT PERL_FS_VER_FMT
4322 /* .../version/archname if -d .../version/archname */
4323 Perl_sv_setpvf(aTHX_ subdir, "%"SVf PERL_ARCH_FMT_PATH PERL_ARCH_FMT,
4325 (int)PERL_REVISION, (int)PERL_VERSION,
4326 (int)PERL_SUBVERSION, ARCHNAME);
4327 if (PerlLIO_stat(SvPVX(subdir), &tmpstatbuf) >= 0 &&
4328 S_ISDIR(tmpstatbuf.st_mode))
4329 av_push(GvAVn(PL_incgv), newSVsv(subdir));
4331 /* .../version if -d .../version */
4332 Perl_sv_setpvf(aTHX_ subdir, "%"SVf PERL_ARCH_FMT_PATH, libdir,
4333 (int)PERL_REVISION, (int)PERL_VERSION,
4334 (int)PERL_SUBVERSION);
4335 if (PerlLIO_stat(SvPVX(subdir), &tmpstatbuf) >= 0 &&
4336 S_ISDIR(tmpstatbuf.st_mode))
4337 av_push(GvAVn(PL_incgv), newSVsv(subdir));
4339 /* .../archname if -d .../archname */
4340 Perl_sv_setpvf(aTHX_ subdir, "%"SVf PERL_ARCH_FMT, libdir, ARCHNAME);
4341 if (PerlLIO_stat(SvPVX(subdir), &tmpstatbuf) >= 0 &&
4342 S_ISDIR(tmpstatbuf.st_mode))
4343 av_push(GvAVn(PL_incgv), newSVsv(subdir));
4346 #ifdef PERL_INC_VERSION_LIST
4348 for (incver = incverlist; *incver; incver++) {
4349 /* .../xxx if -d .../xxx */
4350 Perl_sv_setpvf(aTHX_ subdir, "%"SVf PERL_ARCH_FMT, libdir, *incver);
4351 if (PerlLIO_stat(SvPVX(subdir), &tmpstatbuf) >= 0 &&
4352 S_ISDIR(tmpstatbuf.st_mode))
4353 av_push(GvAVn(PL_incgv), newSVsv(subdir));
4359 /* finally push this lib directory on the end of @INC */
4360 av_push(GvAVn(PL_incgv), libdir);
4364 #ifdef USE_5005THREADS
4365 STATIC struct perl_thread *
4366 S_init_main_thread(pTHX)
4368 #if !defined(PERL_IMPLICIT_CONTEXT)
4369 struct perl_thread *thr;
4373 Newz(53, thr, 1, struct perl_thread);
4374 PL_curcop = &PL_compiling;
4375 thr->interp = PERL_GET_INTERP;
4376 thr->cvcache = newHV();
4377 thr->threadsv = newAV();
4378 /* thr->threadsvp is set when find_threadsv is called */
4379 thr->specific = newAV();
4380 thr->flags = THRf_R_JOINABLE;
4381 MUTEX_INIT(&thr->mutex);
4382 /* Handcraft thrsv similarly to mess_sv */
4383 New(53, PL_thrsv, 1, SV);
4384 Newz(53, xpv, 1, XPV);
4385 SvFLAGS(PL_thrsv) = SVt_PV;
4386 SvANY(PL_thrsv) = (void*)xpv;
4387 SvREFCNT(PL_thrsv) = 1 << 30; /* practically infinite */
4388 SvPVX(PL_thrsv) = (char*)thr;
4389 SvCUR_set(PL_thrsv, sizeof(thr));
4390 SvLEN_set(PL_thrsv, sizeof(thr));
4391 *SvEND(PL_thrsv) = '\0'; /* in the trailing_nul field */
4392 thr->oursv = PL_thrsv;
4393 PL_chopset = " \n-";
4396 MUTEX_LOCK(&PL_threads_mutex);
4402 MUTEX_UNLOCK(&PL_threads_mutex);
4404 #ifdef HAVE_THREAD_INTERN
4405 Perl_init_thread_intern(thr);
4408 #ifdef SET_THREAD_SELF
4409 SET_THREAD_SELF(thr);
4411 thr->self = pthread_self();
4412 #endif /* SET_THREAD_SELF */
4416 * These must come after the thread self setting
4417 * because sv_setpvn does SvTAINT and the taint
4418 * fields thread selfness being set.
4420 PL_toptarget = NEWSV(0,0);
4421 sv_upgrade(PL_toptarget, SVt_PVFM);
4422 sv_setpvn(PL_toptarget, "", 0);
4423 PL_bodytarget = NEWSV(0,0);
4424 sv_upgrade(PL_bodytarget, SVt_PVFM);
4425 sv_setpvn(PL_bodytarget, "", 0);
4426 PL_formtarget = PL_bodytarget;
4427 thr->errsv = newSVpvn("", 0);
4428 (void) find_threadsv("@"); /* Ensure $@ is initialised early */
4431 PL_peepp = MEMBER_TO_FPTR(Perl_peep);
4432 PL_regcompp = MEMBER_TO_FPTR(Perl_pregcomp);
4433 PL_regexecp = MEMBER_TO_FPTR(Perl_regexec_flags);
4434 PL_regint_start = MEMBER_TO_FPTR(Perl_re_intuit_start);
4435 PL_regint_string = MEMBER_TO_FPTR(Perl_re_intuit_string);
4436 PL_regfree = MEMBER_TO_FPTR(Perl_pregfree);
4438 PL_reginterp_cnt = 0;
4442 #endif /* USE_5005THREADS */
4445 Perl_call_list(pTHX_ I32 oldscope, AV *paramList)
4448 line_t oldline = CopLINE(PL_curcop);
4454 while (AvFILL(paramList) >= 0) {
4455 cv = (CV*)av_shift(paramList);
4457 if (paramList == PL_beginav) {
4458 /* save PL_beginav for compiler */
4459 if (! PL_beginav_save)
4460 PL_beginav_save = newAV();
4461 av_push(PL_beginav_save, (SV*)cv);
4463 else if (paramList == PL_checkav) {
4464 /* save PL_checkav for compiler */
4465 if (! PL_checkav_save)
4466 PL_checkav_save = newAV();
4467 av_push(PL_checkav_save, (SV*)cv);
4472 #ifdef PERL_FLEXIBLE_EXCEPTIONS
4473 CALLPROTECT(aTHX_ pcur_env, &ret, MEMBER_TO_FPTR(S_vcall_list_body), cv);
4479 #ifndef PERL_FLEXIBLE_EXCEPTIONS
4483 (void)SvPV(atsv, len);
4485 PL_curcop = &PL_compiling;
4486 CopLINE_set(PL_curcop, oldline);
4487 if (paramList == PL_beginav)
4488 sv_catpv(atsv, "BEGIN failed--compilation aborted");
4490 Perl_sv_catpvf(aTHX_ atsv,
4491 "%s failed--call queue aborted",
4492 paramList == PL_checkav ? "CHECK"
4493 : paramList == PL_initav ? "INIT"
4495 while (PL_scopestack_ix > oldscope)
4498 Perl_croak(aTHX_ "%"SVf"", atsv);
4505 /* my_exit() was called */
4506 while (PL_scopestack_ix > oldscope)
4509 PL_curstash = PL_defstash;
4510 PL_curcop = &PL_compiling;
4511 CopLINE_set(PL_curcop, oldline);
4513 if (PL_statusvalue && !(PL_exit_flags & PERL_EXIT_EXPECTED)) {
4514 if (paramList == PL_beginav)
4515 Perl_croak(aTHX_ "BEGIN failed--compilation aborted");
4517 Perl_croak(aTHX_ "%s failed--call queue aborted",
4518 paramList == PL_checkav ? "CHECK"
4519 : paramList == PL_initav ? "INIT"
4526 PL_curcop = &PL_compiling;
4527 CopLINE_set(PL_curcop, oldline);
4530 PerlIO_printf(Perl_error_log, "panic: restartop\n");
4538 #ifdef PERL_FLEXIBLE_EXCEPTIONS
4540 S_vcall_list_body(pTHX_ va_list args)
4542 CV *cv = va_arg(args, CV*);
4543 return call_list_body(cv);
4548 S_call_list_body(pTHX_ CV *cv)
4550 PUSHMARK(PL_stack_sp);
4551 call_sv((SV*)cv, G_EVAL|G_DISCARD);
4556 Perl_my_exit(pTHX_ U32 status)
4558 DEBUG_S(PerlIO_printf(Perl_debug_log, "my_exit: thread %p, status %lu\n",
4559 thr, (unsigned long) status));
4568 STATUS_NATIVE_SET(status);
4575 Perl_my_failure_exit(pTHX)
4578 if (vaxc$errno & 1) {
4579 if (STATUS_NATIVE & 1) /* fortuitiously includes "-1" */
4580 STATUS_NATIVE_SET(44);
4583 if (!vaxc$errno && errno) /* unlikely */
4584 STATUS_NATIVE_SET(44);
4586 STATUS_NATIVE_SET(vaxc$errno);
4591 STATUS_POSIX_SET(errno);
4593 exitstatus = STATUS_POSIX >> 8;
4594 if (exitstatus & 255)
4595 STATUS_POSIX_SET(exitstatus);
4597 STATUS_POSIX_SET(255);
4604 S_my_exit_jump(pTHX)
4606 register PERL_CONTEXT *cx;
4611 SvREFCNT_dec(PL_e_script);
4612 PL_e_script = Nullsv;
4615 POPSTACK_TO(PL_mainstack);
4616 if (cxstack_ix >= 0) {
4619 POPBLOCK(cx,PL_curpm);
4627 read_e_script(pTHX_ int idx, SV *buf_sv, int maxlen)
4630 p = SvPVX(PL_e_script);
4631 nl = strchr(p, '\n');
4632 nl = (nl) ? nl+1 : SvEND(PL_e_script);
4634 filter_del(read_e_script);
4637 sv_catpvn(buf_sv, p, nl-p);
4638 sv_chop(PL_e_script, nl);