3 * Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006, by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
12 * "A ship then new they built for him/of mithril and of elven glass" --Bilbo
15 /* This file contains the top-level functions that are used to create, use
16 * and destroy a perl interpreter, plus the functions used by XS code to
17 * call back into perl. Note that it does not contain the actual main()
18 * function of the interpreter; that can be found in perlmain.c
23 * Be proud that perl(1) may proclaim:
24 * Setuid Perl scripts are safer than C programs ...
25 * Do not abandon (deprecate) suidperl. Do not advocate C wrappers.
27 * The flow was: perl starts, notices script is suid, execs suidperl with same
28 * arguments; suidperl opens script, checks many things, sets itself with
29 * right UID, execs perl with similar arguments but with script pre-opened on
30 * /dev/fd/xxx; perl checks script is as should be and does work. This was
31 * insecure: see perlsec(1) for many problems with this approach.
33 * The "correct" flow should be: perl starts, opens script and notices it is
34 * suid, checks many things, execs suidperl with similar arguments but with
35 * script on /dev/fd/xxx; suidperl checks script and /dev/fd/xxx object are
36 * same, checks arguments match #! line, sets itself with right UID, execs
37 * perl with same arguments; perl checks many things and does work.
39 * (Opening the script in perl instead of suidperl, we "lose" scripts that
40 * are readable to the target UID but not to the invoker. Where did
41 * unreadable scripts work anyway?)
43 * For now, suidperl and perl are pretty much the same large and cumbersome
44 * program, so suidperl can check its argument list (see comments elsewhere).
47 * Original bug report:
48 * http://bugs.perl.org/index.html?req=bug_id&bug_id=20010322.218
49 * http://rt.perl.org/rt2/Ticket/Display.html?id=6511
50 * Comments and discussion with Debian:
51 * http://bugs.debian.org/203426
52 * http://bugs.debian.org/220486
53 * Debian Security Advisory DSA 431-1 (does not fully fix problem):
54 * http://www.debian.org/security/2004/dsa-431
56 * http://cve.mitre.org/cgi-bin/cvename.cgi?name=CAN-2003-0618
57 * Previous versions of this patch sent to perl5-porters:
58 * http://www.mail-archive.com/perl5-porters@perl.org/msg71953.html
59 * http://www.mail-archive.com/perl5-porters@perl.org/msg75245.html
60 * http://www.mail-archive.com/perl5-porters@perl.org/msg75563.html
61 * http://www.mail-archive.com/perl5-porters@perl.org/msg75635.html
63 Paul Szabo - psz@maths.usyd.edu.au http://www.maths.usyd.edu.au:8000/u/psz/
64 School of Mathematics and Statistics University of Sydney 2006 Australia
68 * Use truthful, neat, specific error messages.
69 * Cannot always hide the truth; security must not depend on doing so.
73 * Use global(?), thread-local fdscript for easier checks.
74 * (I do not understand how we could possibly get a thread race:
75 * do not all threads go through the same initialization? Or in
76 * fact, are not threads started only after we get the script and
77 * so know what to do? Oh well, make things super-safe...)
81 #define PERL_IN_PERL_C
83 #include "patchlevel.h" /* for local_patches */
87 char *nw_get_sitelib(const char *pl);
90 /* XXX If this causes problems, set i_unistd=undef in the hint file. */
95 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
97 # include <sys/wait.h>
100 # include <sys/uio.h>
105 char control[CMSG_SPACE(sizeof(int))];
122 #if !defined(STANDARD_C) && !defined(HAS_GETENV_PROTOTYPE) && !defined(PERL_MICRO)
123 char *getenv (char *); /* Usually in <stdlib.h> */
126 static I32 read_e_script(pTHX_ int idx, SV *buf_sv, int maxlen);
134 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
140 #define CALL_BODY_EVAL(myop) \
141 if (PL_op == (myop)) \
142 PL_op = Perl_pp_entereval(aTHX); \
146 #define CALL_BODY_SUB(myop) \
147 if (PL_op == (myop)) \
148 PL_op = Perl_pp_entersub(aTHX); \
152 #define CALL_LIST_BODY(cv) \
153 PUSHMARK(PL_stack_sp); \
154 call_sv((SV*)(cv), G_EVAL|G_DISCARD);
157 S_init_tls_and_interp(PerlInterpreter *my_perl)
161 PERL_SET_INTERP(my_perl);
162 #if defined(USE_ITHREADS)
165 PERL_SET_THX(my_perl);
168 MUTEX_INIT(&PL_dollarzero_mutex);
170 #ifdef PERL_IMPLICIT_CONTEXT
171 MUTEX_INIT(&PL_my_ctx_mutex);
175 PERL_SET_THX(my_perl);
179 #ifdef PERL_IMPLICIT_SYS
181 perl_alloc_using(struct IPerlMem* ipM, struct IPerlMem* ipMS,
182 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
183 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
184 struct IPerlDir* ipD, struct IPerlSock* ipS,
185 struct IPerlProc* ipP)
187 PerlInterpreter *my_perl;
188 /* Newx() needs interpreter, so call malloc() instead */
189 my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
190 S_init_tls_and_interp(my_perl);
191 Zero(my_perl, 1, PerlInterpreter);
201 INIT_TRACK_MEMPOOL(PL_memory_debug_header, my_perl);
208 =head1 Embedding Functions
210 =for apidoc perl_alloc
212 Allocates a new Perl interpreter. See L<perlembed>.
220 PerlInterpreter *my_perl;
222 /* Newx() needs interpreter, so call malloc() instead */
223 my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
225 S_init_tls_and_interp(my_perl);
226 #ifndef PERL_TRACK_MEMPOOL
227 return (PerlInterpreter *) ZeroD(my_perl, 1, PerlInterpreter);
229 Zero(my_perl, 1, PerlInterpreter);
230 INIT_TRACK_MEMPOOL(PL_memory_debug_header, my_perl);
234 #endif /* PERL_IMPLICIT_SYS */
237 =for apidoc perl_construct
239 Initializes a new Perl interpreter. See L<perlembed>.
245 perl_construct(pTHXx)
248 PERL_UNUSED_ARG(my_perl);
251 PL_perl_destruct_level = 1;
253 if (PL_perl_destruct_level > 0)
256 /* Init the real globals (and main thread)? */
258 PL_curcop = &PL_compiling; /* needed by ckWARN, right away */
260 PL_linestr = newSV(79);
261 sv_upgrade(PL_linestr,SVt_PVIV);
263 if (!SvREADONLY(&PL_sv_undef)) {
264 /* set read-only and try to insure than we wont see REFCNT==0
267 SvREADONLY_on(&PL_sv_undef);
268 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
270 sv_setpv(&PL_sv_no,PL_No);
271 /* value lookup in void context - happens to have the side effect
272 of caching the numeric forms. */
275 SvREADONLY_on(&PL_sv_no);
276 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
278 sv_setpv(&PL_sv_yes,PL_Yes);
281 SvREADONLY_on(&PL_sv_yes);
282 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
284 SvREADONLY_on(&PL_sv_placeholder);
285 SvREFCNT(&PL_sv_placeholder) = (~(U32)0)/2;
288 PL_sighandlerp = (Sighandler_t) Perl_sighandler;
289 #ifdef PERL_USES_PL_PIDSTATUS
290 PL_pidstatus = newHV();
294 PL_rs = newSVpvs("\n");
299 PL_lex_state = LEX_NOTPARSING;
305 SET_NUMERIC_STANDARD();
307 #if defined(LOCAL_PATCH_COUNT)
308 PL_localpatches = local_patches; /* For possible -v */
311 #ifdef HAVE_INTERP_INTERN
315 PerlIO_init(aTHX); /* Hook to IO system */
317 PL_fdpid = newAV(); /* for remembering popen pids by fd */
318 PL_modglobal = newHV(); /* pointers to per-interpreter module globals */
319 PL_errors = newSVpvs("");
320 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
321 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
322 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
324 PL_regex_padav = newAV();
325 av_push(PL_regex_padav,(SV*)newAV()); /* First entry is an array of empty elements */
326 PL_regex_pad = AvARRAY(PL_regex_padav);
328 #ifdef USE_REENTRANT_API
329 Perl_reentrant_init(aTHX);
332 /* Note that strtab is a rather special HV. Assumptions are made
333 about not iterating on it, and not adding tie magic to it.
334 It is properly deallocated in perl_destruct() */
337 HvSHAREKEYS_off(PL_strtab); /* mandatory */
338 hv_ksplit(PL_strtab, 512);
340 #if defined(__DYNAMIC__) && (defined(NeXT) || defined(__NeXT__))
341 _dyld_lookup_and_bind
342 ("__environ", (unsigned long *) &environ_pointer, NULL);
346 # ifdef USE_ENVIRON_ARRAY
347 PL_origenviron = environ;
351 /* Use sysconf(_SC_CLK_TCK) if available, if not
352 * available or if the sysconf() fails, use the HZ.
353 * BeOS has those, but returns the wrong value.
354 * The HZ if not originally defined has been by now
355 * been defined as CLK_TCK, if available. */
356 #if defined(HAS_SYSCONF) && defined(_SC_CLK_TCK) && !defined(__BEOS__)
357 PL_clocktick = sysconf(_SC_CLK_TCK);
358 if (PL_clocktick <= 0)
362 PL_stashcache = newHV();
364 PL_patchlevel = Perl_newSVpvf(aTHX_ "%d.%d.%d", (int)PERL_REVISION,
365 (int)PERL_VERSION, (int)PERL_SUBVERSION);
368 if (!PL_mmap_page_size) {
369 #if defined(HAS_SYSCONF) && (defined(_SC_PAGESIZE) || defined(_SC_MMAP_PAGE_SIZE))
371 SETERRNO(0, SS_NORMAL);
373 PL_mmap_page_size = sysconf(_SC_PAGESIZE);
375 PL_mmap_page_size = sysconf(_SC_MMAP_PAGE_SIZE);
377 if ((long) PL_mmap_page_size < 0) {
379 SV * const error = ERRSV;
380 SvUPGRADE(error, SVt_PV);
381 Perl_croak(aTHX_ "panic: sysconf: %s", SvPV_nolen_const(error));
384 Perl_croak(aTHX_ "panic: sysconf: pagesize unknown");
388 # ifdef HAS_GETPAGESIZE
389 PL_mmap_page_size = getpagesize();
391 # if defined(I_SYS_PARAM) && defined(PAGESIZE)
392 PL_mmap_page_size = PAGESIZE; /* compiletime, bad */
396 if (PL_mmap_page_size <= 0)
397 Perl_croak(aTHX_ "panic: bad pagesize %" IVdf,
398 (IV) PL_mmap_page_size);
400 #endif /* HAS_MMAP */
402 #if defined(HAS_TIMES) && defined(PERL_NEED_TIMESBASE)
403 PL_timesbase.tms_utime = 0;
404 PL_timesbase.tms_stime = 0;
405 PL_timesbase.tms_cutime = 0;
406 PL_timesbase.tms_cstime = 0;
417 =for apidoc nothreadhook
419 Stub that provides thread hook for perl_destruct when there are
426 Perl_nothreadhook(pTHX)
432 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
434 Perl_dump_sv_child(pTHX_ SV *sv)
437 const int sock = PL_dumper_fd;
438 const int debug_fd = PerlIO_fileno(Perl_debug_log);
439 union control_un control;
442 struct cmsghdr *cmptr;
444 unsigned char buffer[256];
446 if(sock == -1 || debug_fd == -1)
449 PerlIO_flush(Perl_debug_log);
451 /* All these shenanigans are to pass a file descriptor over to our child for
452 it to dump out to. We can't let it hold open the file descriptor when it
453 forks, as the file descriptor it will dump to can turn out to be one end
454 of pipe that some other process will wait on for EOF. (So as it would
455 be open, the wait would be forever.) */
457 msg.msg_control = control.control;
458 msg.msg_controllen = sizeof(control.control);
459 /* We're a connected socket so we don't need a destination */
465 cmptr = CMSG_FIRSTHDR(&msg);
466 cmptr->cmsg_len = CMSG_LEN(sizeof(int));
467 cmptr->cmsg_level = SOL_SOCKET;
468 cmptr->cmsg_type = SCM_RIGHTS;
469 *((int *)CMSG_DATA(cmptr)) = 1;
471 vec[0].iov_base = (void*)&sv;
472 vec[0].iov_len = sizeof(sv);
473 got = sendmsg(sock, &msg, 0);
476 perror("Debug leaking scalars parent sendmsg failed");
479 if(got < sizeof(sv)) {
480 perror("Debug leaking scalars parent short sendmsg");
484 /* Return protocol is
486 unsigned char: length of location string (0 for empty)
487 unsigned char*: string (not terminated)
489 vec[0].iov_base = (void*)&returned_errno;
490 vec[0].iov_len = sizeof(returned_errno);
491 vec[1].iov_base = buffer;
494 got = readv(sock, vec, 2);
497 perror("Debug leaking scalars parent read failed");
498 PerlIO_flush(PerlIO_stderr());
501 if(got < sizeof(returned_errno) + 1) {
502 perror("Debug leaking scalars parent short read");
503 PerlIO_flush(PerlIO_stderr());
508 got = read(sock, buffer + 1, *buffer);
510 perror("Debug leaking scalars parent read 2 failed");
511 PerlIO_flush(PerlIO_stderr());
516 perror("Debug leaking scalars parent short read 2");
517 PerlIO_flush(PerlIO_stderr());
522 if (returned_errno || *buffer) {
523 Perl_warn(aTHX_ "Debug leaking scalars child failed%s%.*s with errno"
524 " %d: %s", (*buffer ? " at " : ""), (int) *buffer, buffer + 1,
525 returned_errno, strerror(returned_errno));
531 =for apidoc perl_destruct
533 Shuts down a Perl interpreter. See L<perlembed>.
542 VOL int destruct_level; /* 0=none, 1=full, 2=full with checks */
544 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
548 PERL_UNUSED_ARG(my_perl);
550 /* wait for all pseudo-forked children to finish */
551 PERL_WAIT_FOR_CHILDREN;
553 destruct_level = PL_perl_destruct_level;
556 const char * const s = PerlEnv_getenv("PERL_DESTRUCT_LEVEL");
558 const int i = atoi(s);
559 if (destruct_level < i)
565 if (PL_exit_flags & PERL_EXIT_DESTRUCT_END) {
571 if (PL_endav && !PL_minus_c)
572 call_list(PL_scopestack_ix, PL_endav);
578 /* Need to flush since END blocks can produce output */
581 if (CALL_FPTR(PL_threadhook)(aTHX)) {
582 /* Threads hook has vetoed further cleanup */
586 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
587 if (destruct_level != 0) {
588 /* Fork here to create a child. Our child's job is to preserve the
589 state of scalars prior to destruction, so that we can instruct it
590 to dump any scalars that we later find have leaked.
591 There's no subtlety in this code - it assumes POSIX, and it doesn't
595 if(socketpair(AF_UNIX, SOCK_STREAM, 0, fd)) {
596 perror("Debug leaking scalars socketpair failed");
602 perror("Debug leaking scalars fork failed");
606 /* We are the child */
607 const int sock = fd[1];
608 const int debug_fd = PerlIO_fileno(Perl_debug_log);
611 /* Our success message is an integer 0, and a char 0 */
612 static const char success[sizeof(int) + 1];
616 /* We need to close all other file descriptors otherwise we end up
617 with interesting hangs, where the parent closes its end of a
618 pipe, and sits waiting for (another) child to terminate. Only
619 that child never terminates, because it never gets EOF, because
620 we also have the far end of the pipe open. We even need to
621 close the debugging fd, because sometimes it happens to be one
622 end of a pipe, and a process is waiting on the other end for
623 EOF. Normally it would be closed at some point earlier in
624 destruction, but if we happen to cause the pipe to remain open,
625 EOF never occurs, and we get an infinite hang. Hence all the
626 games to pass in a file descriptor if it's actually needed. */
628 f = sysconf(_SC_OPEN_MAX);
630 where = "sysconf failed";
641 union control_un control;
644 struct cmsghdr *cmptr;
648 msg.msg_control = control.control;
649 msg.msg_controllen = sizeof(control.control);
650 /* We're a connected socket so we don't need a source */
654 msg.msg_iovlen = sizeof(vec)/sizeof(vec[0]);
656 vec[0].iov_base = (void*)⌖
657 vec[0].iov_len = sizeof(target);
659 got = recvmsg(sock, &msg, 0);
664 where = "recv failed";
667 if(got < sizeof(target)) {
668 where = "short recv";
672 if(!(cmptr = CMSG_FIRSTHDR(&msg))) {
676 if(cmptr->cmsg_len != CMSG_LEN(sizeof(int))) {
677 where = "wrong cmsg_len";
680 if(cmptr->cmsg_level != SOL_SOCKET) {
681 where = "wrong cmsg_level";
684 if(cmptr->cmsg_type != SCM_RIGHTS) {
685 where = "wrong cmsg_type";
689 got_fd = *(int*)CMSG_DATA(cmptr);
690 /* For our last little bit of trickery, put the file descriptor
691 back into Perl_debug_log, as if we never actually closed it
693 if(got_fd != debug_fd) {
694 if (dup2(got_fd, debug_fd) == -1) {
701 PerlIO_flush(Perl_debug_log);
703 got = write(sock, &success, sizeof(success));
706 where = "write failed";
709 if(got < sizeof(success)) {
710 where = "short write";
717 int send_errno = errno;
718 unsigned char length = (unsigned char) strlen(where);
719 struct iovec failure[3] = {
720 {(void*)&send_errno, sizeof(send_errno)},
722 {(void*)where, length}
724 int got = writev(sock, failure, 3);
725 /* Bad news travels fast. Faster than data. We'll get a SIGPIPE
726 in the parent if we try to read from the socketpair after the
727 child has exited, even if there was data to read.
728 So sleep a bit to give the parent a fighting chance of
731 _exit((got == -1) ? errno : 0);
735 PL_dumper_fd = fd[0];
740 /* We must account for everything. */
742 /* Destroy the main CV and syntax tree */
743 /* Do this now, because destroying ops can cause new SVs to be generated
744 in Perl_pad_swipe, and when running with -DDEBUG_LEAKING_SCALARS they
745 PL_curcop to point to a valid op from which the filename structure
747 PL_curcop = &PL_compiling;
749 /* ensure comppad/curpad to refer to main's pad */
750 if (CvPADLIST(PL_main_cv)) {
751 PAD_SET_CUR_NOSAVE(CvPADLIST(PL_main_cv), 1);
753 op_free(PL_main_root);
756 PL_main_start = NULL;
757 SvREFCNT_dec(PL_main_cv);
761 /* Tell PerlIO we are about to tear things apart in case
762 we have layers which are using resources that should
766 PerlIO_destruct(aTHX);
768 if (PL_sv_objcount) {
770 * Try to destruct global references. We do this first so that the
771 * destructors and destructees still exist. Some sv's might remain.
772 * Non-referenced objects are on their own.
776 if (PL_defoutgv && !SvREFCNT(PL_defoutgv))
777 PL_defoutgv = NULL; /* may have been freed */
780 /* unhook hooks which will soon be, or use, destroyed data */
781 SvREFCNT_dec(PL_warnhook);
783 SvREFCNT_dec(PL_diehook);
786 /* call exit list functions */
787 while (PL_exitlistlen-- > 0)
788 PL_exitlist[PL_exitlistlen].fn(aTHX_ PL_exitlist[PL_exitlistlen].ptr);
790 Safefree(PL_exitlist);
795 /* jettison our possibly duplicated environment */
796 /* if PERL_USE_SAFE_PUTENV is defined environ will not have been copied
797 * so we certainly shouldn't free it here
800 #if defined(USE_ENVIRON_ARRAY) && !defined(PERL_USE_SAFE_PUTENV)
801 if (environ != PL_origenviron && !PL_use_safe_putenv
803 /* only main thread can free environ[0] contents */
804 && PL_curinterp == aTHX
810 for (i = 0; environ[i]; i++)
811 safesysfree(environ[i]);
813 /* Must use safesysfree() when working with environ. */
814 safesysfree(environ);
816 environ = PL_origenviron;
819 #endif /* !PERL_MICRO */
821 if (destruct_level == 0) {
823 DEBUG_P(debprofdump());
825 #if defined(PERLIO_LAYERS)
826 /* No more IO - including error messages ! */
827 PerlIO_cleanup(aTHX);
830 CopFILE_free(&PL_compiling);
831 CopSTASH_free(&PL_compiling);
833 /* The exit() function will do everything that needs doing. */
837 /* reset so print() ends up where we expect */
841 /* the syntax tree is shared between clones
842 * so op_free(PL_main_root) only ReREFCNT_dec's
843 * REGEXPs in the parent interpreter
844 * we need to manually ReREFCNT_dec for the clones
847 I32 i = AvFILLp(PL_regex_padav) + 1;
848 SV * const * const ary = AvARRAY(PL_regex_padav);
851 SV * const resv = ary[--i];
853 if (SvFLAGS(resv) & SVf_BREAK) {
854 /* this is PL_reg_curpm, already freed
855 * flag is set in regexec.c:S_regtry
857 SvFLAGS(resv) &= ~SVf_BREAK;
859 else if(SvREPADTMP(resv)) {
860 SvREPADTMP_off(resv);
862 else if(SvIOKp(resv)) {
863 REGEXP *re = INT2PTR(REGEXP *,SvIVX(resv));
868 SvREFCNT_dec(PL_regex_padav);
869 PL_regex_padav = NULL;
873 SvREFCNT_dec((SV*) PL_stashcache);
874 PL_stashcache = NULL;
876 /* loosen bonds of global variables */
879 (void)PerlIO_close(PL_rsfp);
883 /* Filters for program text */
884 SvREFCNT_dec(PL_rsfp_filters);
885 PL_rsfp_filters = NULL;
888 Safefree(PL_splitstr);
893 PL_preprocess = FALSE;
899 PL_doswitches = FALSE;
900 PL_dowarn = G_WARN_OFF;
901 PL_doextract = FALSE;
902 PL_sawampersand = FALSE; /* must save all match strings */
905 Safefree(PL_inplace);
907 SvREFCNT_dec(PL_patchlevel);
910 SvREFCNT_dec(PL_e_script);
916 /* magical thingies */
918 SvREFCNT_dec(PL_ofs_sv); /* $, */
921 SvREFCNT_dec(PL_ors_sv); /* $\ */
924 SvREFCNT_dec(PL_rs); /* $/ */
927 Safefree(PL_osname); /* $^O */
930 SvREFCNT_dec(PL_statname);
934 /* defgv, aka *_ should be taken care of elsewhere */
936 /* clean up after study() */
937 SvREFCNT_dec(PL_lastscream);
938 PL_lastscream = NULL;
939 Safefree(PL_screamfirst);
941 Safefree(PL_screamnext);
945 Safefree(PL_efloatbuf);
949 /* startup and shutdown function lists */
950 SvREFCNT_dec(PL_beginav);
951 SvREFCNT_dec(PL_beginav_save);
952 SvREFCNT_dec(PL_endav);
953 SvREFCNT_dec(PL_checkav);
954 SvREFCNT_dec(PL_checkav_save);
955 SvREFCNT_dec(PL_unitcheckav);
956 SvREFCNT_dec(PL_unitcheckav_save);
957 SvREFCNT_dec(PL_initav);
959 PL_beginav_save = NULL;
962 PL_checkav_save = NULL;
963 PL_unitcheckav = NULL;
964 PL_unitcheckav_save = NULL;
967 /* shortcuts just get cleared */
976 PL_last_in_gv = NULL;
984 PL_DBassertion = NULL;
989 SvREFCNT_dec(PL_argvout_stack);
990 PL_argvout_stack = NULL;
992 SvREFCNT_dec(PL_modglobal);
994 SvREFCNT_dec(PL_preambleav);
995 PL_preambleav = NULL;
996 SvREFCNT_dec(PL_subname);
998 SvREFCNT_dec(PL_linestr);
1000 #ifdef PERL_USES_PL_PIDSTATUS
1001 SvREFCNT_dec(PL_pidstatus);
1002 PL_pidstatus = NULL;
1004 SvREFCNT_dec(PL_toptarget);
1005 PL_toptarget = NULL;
1006 SvREFCNT_dec(PL_bodytarget);
1007 PL_bodytarget = NULL;
1008 PL_formtarget = NULL;
1010 /* free locale stuff */
1011 #ifdef USE_LOCALE_COLLATE
1012 Safefree(PL_collation_name);
1013 PL_collation_name = NULL;
1016 #ifdef USE_LOCALE_NUMERIC
1017 Safefree(PL_numeric_name);
1018 PL_numeric_name = NULL;
1019 SvREFCNT_dec(PL_numeric_radix_sv);
1020 PL_numeric_radix_sv = NULL;
1023 /* clear utf8 character classes */
1024 SvREFCNT_dec(PL_utf8_alnum);
1025 SvREFCNT_dec(PL_utf8_alnumc);
1026 SvREFCNT_dec(PL_utf8_ascii);
1027 SvREFCNT_dec(PL_utf8_alpha);
1028 SvREFCNT_dec(PL_utf8_space);
1029 SvREFCNT_dec(PL_utf8_cntrl);
1030 SvREFCNT_dec(PL_utf8_graph);
1031 SvREFCNT_dec(PL_utf8_digit);
1032 SvREFCNT_dec(PL_utf8_upper);
1033 SvREFCNT_dec(PL_utf8_lower);
1034 SvREFCNT_dec(PL_utf8_print);
1035 SvREFCNT_dec(PL_utf8_punct);
1036 SvREFCNT_dec(PL_utf8_xdigit);
1037 SvREFCNT_dec(PL_utf8_mark);
1038 SvREFCNT_dec(PL_utf8_toupper);
1039 SvREFCNT_dec(PL_utf8_totitle);
1040 SvREFCNT_dec(PL_utf8_tolower);
1041 SvREFCNT_dec(PL_utf8_tofold);
1042 SvREFCNT_dec(PL_utf8_idstart);
1043 SvREFCNT_dec(PL_utf8_idcont);
1044 PL_utf8_alnum = NULL;
1045 PL_utf8_alnumc = NULL;
1046 PL_utf8_ascii = NULL;
1047 PL_utf8_alpha = NULL;
1048 PL_utf8_space = NULL;
1049 PL_utf8_cntrl = NULL;
1050 PL_utf8_graph = NULL;
1051 PL_utf8_digit = NULL;
1052 PL_utf8_upper = NULL;
1053 PL_utf8_lower = NULL;
1054 PL_utf8_print = NULL;
1055 PL_utf8_punct = NULL;
1056 PL_utf8_xdigit = NULL;
1057 PL_utf8_mark = NULL;
1058 PL_utf8_toupper = NULL;
1059 PL_utf8_totitle = NULL;
1060 PL_utf8_tolower = NULL;
1061 PL_utf8_tofold = NULL;
1062 PL_utf8_idstart = NULL;
1063 PL_utf8_idcont = NULL;
1065 if (!specialWARN(PL_compiling.cop_warnings))
1066 PerlMemShared_free(PL_compiling.cop_warnings);
1067 PL_compiling.cop_warnings = NULL;
1068 Perl_refcounted_he_free(aTHX_ PL_compiling.cop_hints_hash);
1069 PL_compiling.cop_hints_hash = NULL;
1070 CopFILE_free(&PL_compiling);
1071 CopSTASH_free(&PL_compiling);
1073 /* Prepare to destruct main symbol table. */
1078 SvREFCNT_dec(PL_curstname);
1079 PL_curstname = NULL;
1081 /* clear queued errors */
1082 SvREFCNT_dec(PL_errors);
1086 if (destruct_level >= 2 && ckWARN_d(WARN_INTERNAL)) {
1087 if (PL_scopestack_ix != 0)
1088 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
1089 "Unbalanced scopes: %ld more ENTERs than LEAVEs\n",
1090 (long)PL_scopestack_ix);
1091 if (PL_savestack_ix != 0)
1092 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
1093 "Unbalanced saves: %ld more saves than restores\n",
1094 (long)PL_savestack_ix);
1095 if (PL_tmps_floor != -1)
1096 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced tmps: %ld more allocs than frees\n",
1097 (long)PL_tmps_floor + 1);
1098 if (cxstack_ix != -1)
1099 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced context: %ld more PUSHes than POPs\n",
1100 (long)cxstack_ix + 1);
1103 /* Now absolutely destruct everything, somehow or other, loops or no. */
1104 SvFLAGS(PL_fdpid) |= SVTYPEMASK; /* don't clean out pid table now */
1105 SvFLAGS(PL_strtab) |= SVTYPEMASK; /* don't clean out strtab now */
1107 /* the 2 is for PL_fdpid and PL_strtab */
1108 while (PL_sv_count > 2 && sv_clean_all())
1111 SvFLAGS(PL_fdpid) &= ~SVTYPEMASK;
1112 SvFLAGS(PL_fdpid) |= SVt_PVAV;
1113 SvFLAGS(PL_strtab) &= ~SVTYPEMASK;
1114 SvFLAGS(PL_strtab) |= SVt_PVHV;
1116 AvREAL_off(PL_fdpid); /* no surviving entries */
1117 SvREFCNT_dec(PL_fdpid); /* needed in io_close() */
1120 #ifdef HAVE_INTERP_INTERN
1124 /* Destruct the global string table. */
1126 /* Yell and reset the HeVAL() slots that are still holding refcounts,
1127 * so that sv_free() won't fail on them.
1128 * Now that the global string table is using a single hunk of memory
1129 * for both HE and HEK, we either need to explicitly unshare it the
1130 * correct way, or actually free things here.
1133 const I32 max = HvMAX(PL_strtab);
1134 HE * const * const array = HvARRAY(PL_strtab);
1135 HE *hent = array[0];
1138 if (hent && ckWARN_d(WARN_INTERNAL)) {
1139 HE * const next = HeNEXT(hent);
1140 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
1141 "Unbalanced string table refcount: (%ld) for \"%s\"",
1142 (long)hent->he_valu.hent_refcount, HeKEY(hent));
1149 hent = array[riter];
1154 HvARRAY(PL_strtab) = 0;
1155 HvTOTALKEYS(PL_strtab) = 0;
1156 HvFILL(PL_strtab) = 0;
1158 SvREFCNT_dec(PL_strtab);
1161 /* free the pointer tables used for cloning */
1162 ptr_table_free(PL_ptr_table);
1163 PL_ptr_table = (PTR_TBL_t*)NULL;
1166 /* free special SVs */
1168 SvREFCNT(&PL_sv_yes) = 0;
1169 sv_clear(&PL_sv_yes);
1170 SvANY(&PL_sv_yes) = NULL;
1171 SvFLAGS(&PL_sv_yes) = 0;
1173 SvREFCNT(&PL_sv_no) = 0;
1174 sv_clear(&PL_sv_no);
1175 SvANY(&PL_sv_no) = NULL;
1176 SvFLAGS(&PL_sv_no) = 0;
1180 for (i=0; i<=2; i++) {
1181 SvREFCNT(PERL_DEBUG_PAD(i)) = 0;
1182 sv_clear(PERL_DEBUG_PAD(i));
1183 SvANY(PERL_DEBUG_PAD(i)) = NULL;
1184 SvFLAGS(PERL_DEBUG_PAD(i)) = 0;
1188 if (PL_sv_count != 0 && ckWARN_d(WARN_INTERNAL))
1189 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Scalars leaked: %ld\n", (long)PL_sv_count);
1191 #ifdef DEBUG_LEAKING_SCALARS
1192 if (PL_sv_count != 0) {
1197 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
1198 svend = &sva[SvREFCNT(sva)];
1199 for (sv = sva + 1; sv < svend; ++sv) {
1200 if (SvTYPE(sv) != SVTYPEMASK) {
1201 PerlIO_printf(Perl_debug_log, "leaked: sv=0x%p"
1203 " refcnt=%"UVuf pTHX__FORMAT "\n"
1204 "\tallocated at %s:%d %s %s%s\n",
1205 sv, sv->sv_flags, sv->sv_refcnt pTHX__VALUE,
1206 sv->sv_debug_file ? sv->sv_debug_file : "(unknown)",
1208 sv->sv_debug_inpad ? "for" : "by",
1209 sv->sv_debug_optype ?
1210 PL_op_name[sv->sv_debug_optype]: "(none)",
1211 sv->sv_debug_cloned ? " (cloned)" : ""
1213 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1214 Perl_dump_sv_child(aTHX_ sv);
1220 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1224 /* Wait for up to 4 seconds for child to terminate.
1225 This seems to be the least effort way of timing out on reaping
1227 struct timeval waitfor = {4, 0};
1228 int sock = PL_dumper_fd;
1232 FD_SET(sock, &rset);
1233 select(sock + 1, &rset, NULL, NULL, &waitfor);
1234 waitpid(child, &status, WNOHANG);
1242 #if defined(PERLIO_LAYERS)
1243 /* No more IO - including error messages ! */
1244 PerlIO_cleanup(aTHX);
1247 /* sv_undef needs to stay immortal until after PerlIO_cleanup
1248 as currently layers use it rather than NULL as a marker
1249 for no arg - and will try and SvREFCNT_dec it.
1251 SvREFCNT(&PL_sv_undef) = 0;
1252 SvREADONLY_off(&PL_sv_undef);
1254 Safefree(PL_origfilename);
1255 PL_origfilename = NULL;
1256 Safefree(PL_reg_start_tmp);
1257 PL_reg_start_tmp = (char**)NULL;
1258 PL_reg_start_tmpl = 0;
1259 Safefree(PL_reg_curpm);
1260 Safefree(PL_reg_poscache);
1261 free_tied_hv_pool();
1262 Safefree(PL_op_mask);
1263 Safefree(PL_psig_ptr);
1264 PL_psig_ptr = (SV**)NULL;
1265 Safefree(PL_psig_name);
1266 PL_psig_name = (SV**)NULL;
1267 Safefree(PL_bitcount);
1269 Safefree(PL_psig_pend);
1270 PL_psig_pend = (int*)NULL;
1273 PL_tainting = FALSE;
1274 PL_taint_warn = FALSE;
1275 PL_hints = 0; /* Reset hints. Should hints be per-interpreter ? */
1278 DEBUG_P(debprofdump());
1280 #ifdef USE_REENTRANT_API
1281 Perl_reentrant_free(aTHX);
1286 while (PL_regmatch_slab) {
1287 regmatch_slab *s = PL_regmatch_slab;
1288 PL_regmatch_slab = PL_regmatch_slab->next;
1292 /* As the absolutely last thing, free the non-arena SV for mess() */
1295 /* we know that type == SVt_PVMG */
1297 /* it could have accumulated taint magic */
1300 for (mg = SvMAGIC(PL_mess_sv); mg; mg = moremagic) {
1301 moremagic = mg->mg_moremagic;
1302 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global
1304 Safefree(mg->mg_ptr);
1308 /* we know that type >= SVt_PV */
1309 SvPV_free(PL_mess_sv);
1310 Safefree(SvANY(PL_mess_sv));
1311 Safefree(PL_mess_sv);
1318 =for apidoc perl_free
1320 Releases a Perl interpreter. See L<perlembed>.
1328 #ifdef PERL_TRACK_MEMPOOL
1331 * Don't free thread memory if PERL_DESTRUCT_LEVEL is set to a non-zero
1332 * value as we're probably hunting memory leaks then
1334 const char * const s = PerlEnv_getenv("PERL_DESTRUCT_LEVEL");
1335 if (!s || atoi(s) == 0) {
1336 /* Emulate the PerlHost behaviour of free()ing all memory allocated in this
1337 thread at thread exit. */
1338 while(aTHXx->Imemory_debug_header.next != &(aTHXx->Imemory_debug_header))
1339 safesysfree(sTHX + (char *)(aTHXx->Imemory_debug_header.next));
1344 #if defined(WIN32) || defined(NETWARE)
1345 # if defined(PERL_IMPLICIT_SYS)
1348 void *host = nw_internal_host;
1350 void *host = w32_internal_host;
1352 PerlMem_free(aTHXx);
1354 nw_delete_internal_host(host);
1356 win32_delete_internal_host(host);
1360 PerlMem_free(aTHXx);
1363 PerlMem_free(aTHXx);
1367 #if defined(USE_ITHREADS)
1368 /* provide destructors to clean up the thread key when libperl is unloaded */
1369 #ifndef WIN32 /* handled during DLL_PROCESS_DETACH in win32/perllib.c */
1371 #if defined(__hpux) && !(defined(__ux_version) && __ux_version <= 1020) && !defined(__GNUC__)
1372 #pragma fini "perl_fini"
1373 #elif defined(__sun) && !defined(__GNUC__)
1374 #pragma fini (perl_fini)
1378 #if defined(__GNUC__)
1379 __attribute__((destructor))
1389 #endif /* THREADS */
1392 Perl_call_atexit(pTHX_ ATEXIT_t fn, void *ptr)
1395 Renew(PL_exitlist, PL_exitlistlen+1, PerlExitListEntry);
1396 PL_exitlist[PL_exitlistlen].fn = fn;
1397 PL_exitlist[PL_exitlistlen].ptr = ptr;
1401 #ifdef HAS_PROCSELFEXE
1402 /* This is a function so that we don't hold on to MAXPATHLEN
1403 bytes of stack longer than necessary
1406 S_procself_val(pTHX_ SV *sv, const char *arg0)
1408 char buf[MAXPATHLEN];
1409 int len = readlink(PROCSELFEXE_PATH, buf, sizeof(buf) - 1);
1411 /* On Playstation2 Linux V1.0 (kernel 2.2.1) readlink(/proc/self/exe)
1412 includes a spurious NUL which will cause $^X to fail in system
1413 or backticks (this will prevent extensions from being built and
1414 many tests from working). readlink is not meant to add a NUL.
1415 Normal readlink works fine.
1417 if (len > 0 && buf[len-1] == '\0') {
1421 /* FreeBSD's implementation is acknowledged to be imperfect, sometimes
1422 returning the text "unknown" from the readlink rather than the path
1423 to the executable (or returning an error from the readlink). Any valid
1424 path has a '/' in it somewhere, so use that to validate the result.
1425 See http://www.freebsd.org/cgi/query-pr.cgi?pr=35703
1427 if (len > 0 && memchr(buf, '/', len)) {
1428 sv_setpvn(sv,buf,len);
1434 #endif /* HAS_PROCSELFEXE */
1437 S_set_caret_X(pTHX) {
1439 GV* tmpgv = gv_fetchpvs("\030", GV_ADD|GV_NOTQUAL, SVt_PV); /* $^X */
1441 #ifdef HAS_PROCSELFEXE
1442 S_procself_val(aTHX_ GvSV(tmpgv), PL_origargv[0]);
1445 sv_setpv(GvSVn(tmpgv), os2_execname(aTHX));
1447 sv_setpv(GvSVn(tmpgv),PL_origargv[0]);
1454 =for apidoc perl_parse
1456 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
1462 perl_parse(pTHXx_ XSINIT_t xsinit, int argc, char **argv, char **env)
1469 PERL_UNUSED_ARG(my_perl);
1471 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
1474 Perl_croak(aTHX_ "suidperl is no longer needed since the kernel can now execute\n\
1475 setuid perl scripts securely.\n");
1476 #endif /* IAMSUID */
1479 #if defined(USE_HASH_SEED) || defined(USE_HASH_SEED_EXPLICIT)
1480 /* [perl #22371] Algorimic Complexity Attack on Perl 5.6.1, 5.8.0
1481 * This MUST be done before any hash stores or fetches take place.
1482 * If you set PL_rehash_seed (and assumedly also PL_rehash_seed_set)
1483 * yourself, it is your responsibility to provide a good random seed!
1484 * You can also define PERL_HASH_SEED in compile time, see hv.h. */
1485 if (!PL_rehash_seed_set)
1486 PL_rehash_seed = get_hash_seed();
1488 const char * const s = PerlEnv_getenv("PERL_HASH_SEED_DEBUG");
1490 if (s && (atoi(s) == 1))
1491 PerlIO_printf(Perl_debug_log, "HASH_SEED = %"UVuf"\n", PL_rehash_seed);
1493 #endif /* #if defined(USE_HASH_SEED) || defined(USE_HASH_SEED_EXPLICIT) */
1498 if (PL_origalen != 0) {
1499 PL_origalen = 1; /* don't use old PL_origalen if perl_parse() is called again */
1502 /* Set PL_origalen be the sum of the contiguous argv[]
1503 * elements plus the size of the env in case that it is
1504 * contiguous with the argv[]. This is used in mg.c:Perl_magic_set()
1505 * as the maximum modifiable length of $0. In the worst case
1506 * the area we are able to modify is limited to the size of
1507 * the original argv[0]. (See below for 'contiguous', though.)
1509 const char *s = NULL;
1512 ~(UV)(PTRSIZE == 4 ? 3 : PTRSIZE == 8 ? 7 : PTRSIZE == 16 ? 15 : 0);
1513 /* Do the mask check only if the args seem like aligned. */
1515 (mask < ~(UV)0) && ((PTR2UV(argv[0]) & mask) == PTR2UV(argv[0]));
1517 /* See if all the arguments are contiguous in memory. Note
1518 * that 'contiguous' is a loose term because some platforms
1519 * align the argv[] and the envp[]. If the arguments look
1520 * like non-aligned, assume that they are 'strictly' or
1521 * 'traditionally' contiguous. If the arguments look like
1522 * aligned, we just check that they are within aligned
1523 * PTRSIZE bytes. As long as no system has something bizarre
1524 * like the argv[] interleaved with some other data, we are
1525 * fine. (Did I just evoke Murphy's Law?) --jhi */
1526 if (PL_origargv && PL_origargc >= 1 && (s = PL_origargv[0])) {
1528 for (i = 1; i < PL_origargc; i++) {
1529 if ((PL_origargv[i] == s + 1
1531 || PL_origargv[i] == s + 2
1536 (PL_origargv[i] > s &&
1538 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1548 /* Can we grab env area too to be used as the area for $0? */
1549 if (s && PL_origenviron) {
1550 if ((PL_origenviron[0] == s + 1
1552 || (PL_origenviron[0] == s + 9 && (s += 8))
1557 (PL_origenviron[0] > s &&
1558 PL_origenviron[0] <=
1559 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1563 s = PL_origenviron[0];
1566 my_setenv("NoNe SuCh", NULL);
1567 /* Force copy of environment. */
1568 for (i = 1; PL_origenviron[i]; i++) {
1569 if (PL_origenviron[i] == s + 1
1572 (PL_origenviron[i] > s &&
1573 PL_origenviron[i] <=
1574 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1577 s = PL_origenviron[i];
1585 PL_origalen = s ? s - PL_origargv[0] + 1 : 0;
1590 /* Come here if running an undumped a.out. */
1592 PL_origfilename = savepv(argv[0]);
1593 PL_do_undump = FALSE;
1594 cxstack_ix = -1; /* start label stack again */
1596 assert (!PL_tainted);
1598 S_set_caret_X(aTHX);
1600 init_postdump_symbols(argc,argv,env);
1605 op_free(PL_main_root);
1606 PL_main_root = NULL;
1608 PL_main_start = NULL;
1609 SvREFCNT_dec(PL_main_cv);
1613 oldscope = PL_scopestack_ix;
1614 PL_dowarn = G_WARN_OFF;
1619 parse_body(env,xsinit);
1621 call_list(oldscope, PL_unitcheckav);
1623 call_list(oldscope, PL_checkav);
1630 /* my_exit() was called */
1631 while (PL_scopestack_ix > oldscope)
1634 PL_curstash = PL_defstash;
1636 call_list(oldscope, PL_unitcheckav);
1638 call_list(oldscope, PL_checkav);
1642 PerlIO_printf(Perl_error_log, "panic: top_env\n");
1651 S_parse_body(pTHX_ char **env, XSINIT_t xsinit)
1654 int argc = PL_origargc;
1655 char **argv = PL_origargv;
1656 const char *scriptname = NULL;
1657 VOL bool dosearch = FALSE;
1658 const char *validarg = "";
1660 register char *s, c;
1661 const char *cddir = NULL;
1662 #ifdef USE_SITECUSTOMIZE
1663 bool minus_f = FALSE;
1666 sv_setpvn(PL_linestr,"",0);
1667 sv = newSVpvs(""); /* first used for -I flags */
1671 for (argc--,argv++; argc > 0; argc--,argv++) {
1672 if (argv[0][0] != '-' || !argv[0][1])
1676 validarg = " PHOOEY ";
1680 * Can we rely on the kernel to start scripts with argv[1] set to
1681 * contain all #! line switches (the whole line)? (argv[0] is set to
1682 * the interpreter name, argv[2] to the script name; argv[3] and
1683 * above may contain other arguments.)
1690 #ifndef PERL_STRICT_CR
1715 if ((s = moreswitches(s)))
1720 CHECK_MALLOC_TOO_LATE_FOR('t');
1721 if( !PL_tainting ) {
1722 PL_taint_warn = TRUE;
1728 CHECK_MALLOC_TOO_LATE_FOR('T');
1730 PL_taint_warn = FALSE;
1738 #ifdef MACOS_TRADITIONAL
1739 /* ignore -e for Dev:Pseudo argument */
1740 if (argv[1] && !strcmp(argv[1], "Dev:Pseudo"))
1743 forbid_setid('e', -1);
1745 PL_e_script = newSVpvs("");
1746 filter_add(read_e_script, NULL);
1749 sv_catpv(PL_e_script, s);
1751 sv_catpv(PL_e_script, argv[1]);
1755 Perl_croak(aTHX_ "No code specified for -%c", c);
1756 sv_catpvs(PL_e_script, "\n");
1760 #ifdef USE_SITECUSTOMIZE
1766 case 'I': /* -I handled both here and in moreswitches() */
1767 forbid_setid('I', -1);
1768 if (!*++s && (s=argv[1]) != NULL) {
1772 STRLEN len = strlen(s);
1773 const char * const p = savepvn(s, len);
1774 incpush(p, TRUE, TRUE, FALSE, FALSE);
1775 sv_catpvs(sv, "-I");
1776 sv_catpvn(sv, p, len);
1781 Perl_croak(aTHX_ "No directory specified for -I");
1784 forbid_setid('P', -1);
1785 PL_preprocess = TRUE;
1789 forbid_setid('S', -1);
1798 PL_preambleav = newAV();
1799 av_push(PL_preambleav,
1800 newSVpvs("use Config;"));
1804 opts_prog = newSVpvs("print Config::myconfig(),");
1806 sv_catpvs(opts_prog,"\"\\nCharacteristics of this PERLSHR image: \\n\",");
1808 sv_catpvs(opts_prog,"\"\\nCharacteristics of this binary (from libperl): \\n\",");
1810 opts = SvCUR(opts_prog);
1812 Perl_sv_catpv(aTHX_ opts_prog,"\" Compile-time options:"
1816 # ifdef DEBUG_LEAKING_SCALARS
1817 " DEBUG_LEAKING_SCALARS"
1819 # ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1820 " DEBUG_LEAKING_SCALARS_FORK_DUMP"
1822 # ifdef FAKE_THREADS
1825 # ifdef MULTIPLICITY
1834 # ifdef PERL_DONT_CREATE_GVSV
1835 " PERL_DONT_CREATE_GVSV"
1837 # ifdef PERL_GLOBAL_STRUCT
1838 " PERL_GLOBAL_STRUCT"
1840 # ifdef PERL_IMPLICIT_CONTEXT
1841 " PERL_IMPLICIT_CONTEXT"
1843 # ifdef PERL_IMPLICIT_SYS
1844 " PERL_IMPLICIT_SYS"
1849 # ifdef PERL_MALLOC_WRAP
1852 # ifdef PERL_NEED_APPCTX
1855 # ifdef PERL_NEED_TIMESBASE
1856 " PERL_NEED_TIMESBASE"
1858 # ifdef PERL_OLD_COPY_ON_WRITE
1859 " PERL_OLD_COPY_ON_WRITE"
1861 # ifdef PERL_TRACK_MEMPOOL
1862 " PERL_TRACK_MEMPOOL"
1864 # ifdef PERL_USE_SAFE_PUTENV
1865 " PERL_USE_SAFE_PUTENV"
1867 #ifdef PERL_USES_PL_PIDSTATUS
1868 " PERL_USES_PL_PIDSTATUS"
1870 # ifdef PL_OP_SLAB_ALLOC
1873 # ifdef THREADS_HAVE_PIDS
1874 " THREADS_HAVE_PIDS"
1876 # ifdef USE_64_BIT_ALL
1879 # ifdef USE_64_BIT_INT
1882 # ifdef USE_ITHREADS
1885 # ifdef USE_LARGE_FILES
1888 # ifdef USE_LONG_DOUBLE
1894 # ifdef USE_REENTRANT_API
1895 " USE_REENTRANT_API"
1900 # ifdef USE_SITECUSTOMIZE
1901 " USE_SITECUSTOMIZE"
1908 while (SvCUR(opts_prog) > opts+76) {
1909 /* find last space after "options: " and before col 76
1913 char * const pv = SvPV_nolen(opts_prog);
1914 const char c = pv[opts+76];
1916 space = strrchr(pv+opts+26, ' ');
1918 if (!space) break; /* "Can't happen" */
1920 /* break the line before that space */
1923 Perl_sv_insert(aTHX_ opts_prog, opts, 0,
1924 STR_WITH_LEN("\\n "));
1927 sv_catpvs(opts_prog,"\\n\",");
1929 #if defined(LOCAL_PATCH_COUNT)
1930 if (LOCAL_PATCH_COUNT > 0) {
1932 sv_catpvs(opts_prog,
1933 "\" Locally applied patches:\\n\",");
1934 for (i = 1; i <= LOCAL_PATCH_COUNT; i++) {
1935 if (PL_localpatches[i])
1936 Perl_sv_catpvf(aTHX_ opts_prog,"q%c\t%s\n%c,",
1937 0, PL_localpatches[i], 0);
1941 Perl_sv_catpvf(aTHX_ opts_prog,
1942 "\" Built under %s\\n\"",OSNAME);
1945 Perl_sv_catpvf(aTHX_ opts_prog,
1946 ",\" Compiled at %s %s\\n\"",__DATE__,
1949 Perl_sv_catpvf(aTHX_ opts_prog,",\" Compiled on %s\\n\"",
1953 sv_catpvs(opts_prog, "; $\"=\"\\n \"; "
1954 "@env = map { \"$_=\\\"$ENV{$_}\\\"\" } "
1955 "sort grep {/^PERL/} keys %ENV; ");
1957 sv_catpvs(opts_prog,
1958 "push @env, \"CYGWIN=\\\"$ENV{CYGWIN}\\\"\";");
1960 sv_catpvs(opts_prog,
1961 "print \" \\%ENV:\\n @env\\n\" if @env;"
1962 "print \" \\@INC:\\n @INC\\n\";");
1966 opts_prog = Perl_newSVpvf(aTHX_
1967 "Config::config_vars(qw%c%s%c)",
1971 av_push(PL_preambleav, opts_prog);
1972 /* don't look for script or read stdin */
1973 scriptname = BIT_BUCKET;
1977 PL_doextract = TRUE;
1985 if (!*++s || isSPACE(*s)) {
1989 /* catch use of gnu style long options */
1990 if (strEQ(s, "version")) {
1994 if (strEQ(s, "help")) {
2001 Perl_croak(aTHX_ "Unrecognized switch: -%s (-h will show valid options)",s);
2007 #ifndef SECURE_INTERNAL_GETENV
2010 (s = PerlEnv_getenv("PERL5OPT")))
2012 const char *popt = s;
2015 if (*s == '-' && *(s+1) == 'T') {
2016 CHECK_MALLOC_TOO_LATE_FOR('T');
2018 PL_taint_warn = FALSE;
2021 char *popt_copy = NULL;
2034 if (!strchr("CDIMUdmtwA", *s))
2035 Perl_croak(aTHX_ "Illegal switch in PERL5OPT: -%c", *s);
2039 popt_copy = SvPVX(sv_2mortal(newSVpv(popt,0)));
2040 s = popt_copy + (s - popt);
2041 d = popt_copy + (d - popt);
2048 if( !PL_tainting ) {
2049 PL_taint_warn = TRUE;
2059 #ifdef USE_SITECUSTOMIZE
2062 PL_preambleav = newAV();
2063 av_unshift(PL_preambleav, 1);
2064 (void)av_store(PL_preambleav, 0, Perl_newSVpvf(aTHX_ "BEGIN { do '%s/sitecustomize.pl' }", SITELIB_EXP));
2068 if (PL_taint_warn && PL_dowarn != G_WARN_ALL_OFF) {
2069 PL_compiling.cop_warnings
2070 = Perl_new_warnings_bitfield(aTHX_ NULL, WARN_TAINTstring, WARNsize);
2074 scriptname = argv[0];
2077 scriptname = BIT_BUCKET; /* don't look for script or read stdin */
2079 else if (scriptname == NULL) {
2081 if ( PerlLIO_isatty(PerlIO_fileno(PerlIO_stdin())) )
2087 /* Set $^X early so that it can be used for relocatable paths in @INC */
2088 assert (!PL_tainted);
2090 S_set_caret_X(aTHX);
2097 = open_script(scriptname, dosearch, sv, &suidscript);
2099 validate_suid(validarg, scriptname, fdscript, suidscript);
2102 # if defined(SIGCHLD) || defined(SIGCLD)
2105 # define SIGCHLD SIGCLD
2107 Sighandler_t sigstate = rsignal_state(SIGCHLD);
2108 if (sigstate == (Sighandler_t) SIG_IGN) {
2109 if (ckWARN(WARN_SIGNAL))
2110 Perl_warner(aTHX_ packWARN(WARN_SIGNAL),
2111 "Can't ignore signal CHLD, forcing to default");
2112 (void)rsignal(SIGCHLD, (Sighandler_t)SIG_DFL);
2119 #ifdef MACOS_TRADITIONAL
2120 || gMacPerl_AlwaysExtract
2124 /* This will croak if suidscript is >= 0, as -x cannot be used with
2126 forbid_setid('x', suidscript);
2127 /* Hence you can't get here if suidscript >= 0 */
2130 if (cddir && PerlDir_chdir( (char *)cddir ) < 0)
2131 Perl_croak(aTHX_ "Can't chdir to %s",cddir);
2135 PL_main_cv = PL_compcv = (CV*)newSV(0);
2136 sv_upgrade((SV *)PL_compcv, SVt_PVCV);
2137 CvUNIQUE_on(PL_compcv);
2139 CvPADLIST(PL_compcv) = pad_new(0);
2142 boot_core_UNIVERSAL();
2143 boot_core_xsutils();
2146 (*xsinit)(aTHX); /* in case linked C routines want magical variables */
2148 #if defined(VMS) || defined(WIN32) || defined(DJGPP) || defined(__CYGWIN__) || defined(EPOC) || defined(SYMBIAN)
2154 # ifdef HAS_SOCKS5_INIT
2155 socks5_init(argv[0]);
2161 init_predump_symbols();
2162 /* init_postdump_symbols not currently designed to be called */
2163 /* more than once (ENV isn't cleared first, for example) */
2164 /* But running with -u leaves %ENV & @ARGV undefined! XXX */
2166 init_postdump_symbols(argc,argv,env);
2168 /* PL_unicode is turned on by -C, or by $ENV{PERL_UNICODE},
2169 * or explicitly in some platforms.
2170 * locale.c:Perl_init_i18nl10n() if the environment
2171 * look like the user wants to use UTF-8. */
2172 #if defined(__SYMBIAN32__)
2173 PL_unicode = PERL_UNICODE_STD_FLAG; /* See PERL_SYMBIAN_CONSOLE_UTF8. */
2176 /* Requires init_predump_symbols(). */
2177 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
2182 /* Turn on UTF-8-ness on STDIN, STDOUT, STDERR
2183 * and the default open disciplines. */
2184 if ((PL_unicode & PERL_UNICODE_STDIN_FLAG) &&
2185 PL_stdingv && (io = GvIO(PL_stdingv)) &&
2187 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2188 if ((PL_unicode & PERL_UNICODE_STDOUT_FLAG) &&
2189 PL_defoutgv && (io = GvIO(PL_defoutgv)) &&
2191 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2192 if ((PL_unicode & PERL_UNICODE_STDERR_FLAG) &&
2193 PL_stderrgv && (io = GvIO(PL_stderrgv)) &&
2195 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2196 if ((PL_unicode & PERL_UNICODE_INOUT_FLAG) &&
2197 (sv = GvSV(gv_fetchpvs("\017PEN", GV_ADD|GV_NOTQUAL,
2199 U32 in = PL_unicode & PERL_UNICODE_IN_FLAG;
2200 U32 out = PL_unicode & PERL_UNICODE_OUT_FLAG;
2203 sv_setpvn(sv, ":utf8\0:utf8", 11);
2205 sv_setpvn(sv, ":utf8\0", 6);
2208 sv_setpvn(sv, "\0:utf8", 6);
2214 if ((s = PerlEnv_getenv("PERL_SIGNALS"))) {
2215 if (strEQ(s, "unsafe"))
2216 PL_signals |= PERL_SIGNALS_UNSAFE_FLAG;
2217 else if (strEQ(s, "safe"))
2218 PL_signals &= ~PERL_SIGNALS_UNSAFE_FLAG;
2220 Perl_croak(aTHX_ "PERL_SIGNALS illegal: \"%s\"", s);
2224 if ((s = PerlEnv_getenv("PERL_XMLDUMP"))) {
2228 PL_xmlfp = PerlIO_stdout();
2230 PL_xmlfp = PerlIO_open(s, "w");
2232 Perl_croak(aTHX_ "Can't open %s", s);
2234 my_setenv("PERL_XMLDUMP", Nullch); /* hide from subprocs */
2236 if ((s = PerlEnv_getenv("PERL_MADSKILLS"))) {
2237 PL_madskills = atoi(s);
2238 my_setenv("PERL_MADSKILLS", Nullch); /* hide from subprocs */
2244 /* now parse the script */
2246 SETERRNO(0,SS_NORMAL);
2248 #ifdef MACOS_TRADITIONAL
2249 if (gMacPerl_SyntaxError = (yyparse() || PL_error_count)) {
2251 Perl_croak(aTHX_ "%s had compilation errors.\n", MacPerl_MPWFileName(PL_origfilename));
2253 Perl_croak(aTHX_ "Execution of %s aborted due to compilation errors.\n",
2254 MacPerl_MPWFileName(PL_origfilename));
2258 if (yyparse() || PL_error_count) {
2260 Perl_croak(aTHX_ "%s had compilation errors.\n", PL_origfilename);
2262 Perl_croak(aTHX_ "Execution of %s aborted due to compilation errors.\n",
2267 CopLINE_set(PL_curcop, 0);
2268 PL_curstash = PL_defstash;
2269 PL_preprocess = FALSE;
2271 SvREFCNT_dec(PL_e_script);
2279 SAVECOPFILE(PL_curcop);
2280 SAVECOPLINE(PL_curcop);
2281 gv_check(PL_defstash);
2288 if ((s=PerlEnv_getenv("PERL_DEBUG_MSTATS")) && atoi(s) >= 2)
2289 dump_mstats("after compilation:");
2298 =for apidoc perl_run
2300 Tells a Perl interpreter to run. See L<perlembed>.
2313 PERL_UNUSED_ARG(my_perl);
2315 oldscope = PL_scopestack_ix;
2323 cxstack_ix = -1; /* start context stack again */
2325 case 0: /* normal completion */
2329 case 2: /* my_exit() */
2330 while (PL_scopestack_ix > oldscope)
2333 PL_curstash = PL_defstash;
2334 if (!(PL_exit_flags & PERL_EXIT_DESTRUCT_END) &&
2335 PL_endav && !PL_minus_c)
2336 call_list(oldscope, PL_endav);
2338 if (PerlEnv_getenv("PERL_DEBUG_MSTATS"))
2339 dump_mstats("after execution: ");
2345 POPSTACK_TO(PL_mainstack);
2348 PerlIO_printf(Perl_error_log, "panic: restartop\n");
2360 S_run_body(pTHX_ I32 oldscope)
2363 DEBUG_r(PerlIO_printf(Perl_debug_log, "%s $` $& $' support.\n",
2364 PL_sawampersand ? "Enabling" : "Omitting"));
2366 if (!PL_restartop) {
2370 exit(0); /* less likely to core dump than my_exit(0) */
2373 DEBUG_x(dump_all());
2376 PERL_DEBUG(PerlIO_printf(Perl_debug_log, "\nEXECUTING...\n\n"));
2378 DEBUG_S(PerlIO_printf(Perl_debug_log, "main thread is 0x%"UVxf"\n",
2382 #ifdef MACOS_TRADITIONAL
2383 PerlIO_printf(Perl_error_log, "%s%s syntax OK\n",
2384 (gMacPerl_ErrorFormat ? "# " : ""),
2385 MacPerl_MPWFileName(PL_origfilename));
2387 PerlIO_printf(Perl_error_log, "%s syntax OK\n", PL_origfilename);
2391 if (PERLDB_SINGLE && PL_DBsingle)
2392 sv_setiv(PL_DBsingle, 1);
2394 call_list(oldscope, PL_initav);
2400 PL_op = PL_restartop;
2404 else if (PL_main_start) {
2405 CvDEPTH(PL_main_cv) = 1;
2406 PL_op = PL_main_start;
2414 =head1 SV Manipulation Functions
2416 =for apidoc p||get_sv
2418 Returns the SV of the specified Perl scalar. If C<create> is set and the
2419 Perl variable does not exist then it will be created. If C<create> is not
2420 set and the variable does not exist then NULL is returned.
2426 Perl_get_sv(pTHX_ const char *name, I32 create)
2429 gv = gv_fetchpv(name, create, SVt_PV);
2436 =head1 Array Manipulation Functions
2438 =for apidoc p||get_av
2440 Returns the AV of the specified Perl array. If C<create> is set and the
2441 Perl variable does not exist then it will be created. If C<create> is not
2442 set and the variable does not exist then NULL is returned.
2448 Perl_get_av(pTHX_ const char *name, I32 create)
2450 GV* const gv = gv_fetchpv(name, create, SVt_PVAV);
2459 =head1 Hash Manipulation Functions
2461 =for apidoc p||get_hv
2463 Returns the HV of the specified Perl hash. If C<create> is set and the
2464 Perl variable does not exist then it will be created. If C<create> is not
2465 set and the variable does not exist then NULL is returned.
2471 Perl_get_hv(pTHX_ const char *name, I32 create)
2473 GV* const gv = gv_fetchpv(name, create, SVt_PVHV);
2482 =head1 CV Manipulation Functions
2484 =for apidoc p||get_cv
2486 Returns the CV of the specified Perl subroutine. If C<create> is set and
2487 the Perl subroutine does not exist then it will be declared (which has the
2488 same effect as saying C<sub name;>). If C<create> is not set and the
2489 subroutine does not exist then NULL is returned.
2495 Perl_get_cv(pTHX_ const char *name, I32 create)
2497 GV* const gv = gv_fetchpv(name, create, SVt_PVCV);
2498 /* XXX unsafe for threads if eval_owner isn't held */
2499 /* XXX this is probably not what they think they're getting.
2500 * It has the same effect as "sub name;", i.e. just a forward
2502 if (create && !GvCVu(gv))
2503 return newSUB(start_subparse(FALSE, 0),
2504 newSVOP(OP_CONST, 0, newSVpv(name,0)),
2511 /* Be sure to refetch the stack pointer after calling these routines. */
2515 =head1 Callback Functions
2517 =for apidoc p||call_argv
2519 Performs a callback to the specified Perl sub. See L<perlcall>.
2525 Perl_call_argv(pTHX_ const char *sub_name, I32 flags, register char **argv)
2527 /* See G_* flags in cop.h */
2528 /* null terminated arg list */
2536 XPUSHs(sv_2mortal(newSVpv(*argv,0)));
2541 return call_pv(sub_name, flags);
2545 =for apidoc p||call_pv
2547 Performs a callback to the specified Perl sub. See L<perlcall>.
2553 Perl_call_pv(pTHX_ const char *sub_name, I32 flags)
2554 /* name of the subroutine */
2555 /* See G_* flags in cop.h */
2557 return call_sv((SV*)get_cv(sub_name, TRUE), flags);
2561 =for apidoc p||call_method
2563 Performs a callback to the specified Perl method. The blessed object must
2564 be on the stack. See L<perlcall>.
2570 Perl_call_method(pTHX_ const char *methname, I32 flags)
2571 /* name of the subroutine */
2572 /* See G_* flags in cop.h */
2574 return call_sv(sv_2mortal(newSVpv(methname,0)), flags | G_METHOD);
2577 /* May be called with any of a CV, a GV, or an SV containing the name. */
2579 =for apidoc p||call_sv
2581 Performs a callback to the Perl sub whose name is in the SV. See
2588 Perl_call_sv(pTHX_ SV *sv, I32 flags)
2589 /* See G_* flags in cop.h */
2592 LOGOP myop; /* fake syntax tree node */
2597 bool oldcatch = CATCH_GET;
2599 OP* const oldop = PL_op;
2602 if (flags & G_DISCARD) {
2607 Zero(&myop, 1, LOGOP);
2608 myop.op_next = NULL;
2609 if (!(flags & G_NOARGS))
2610 myop.op_flags |= OPf_STACKED;
2611 myop.op_flags |= ((flags & G_VOID) ? OPf_WANT_VOID :
2612 (flags & G_ARRAY) ? OPf_WANT_LIST :
2617 EXTEND(PL_stack_sp, 1);
2618 *++PL_stack_sp = sv;
2620 oldscope = PL_scopestack_ix;
2622 if (PERLDB_SUB && PL_curstash != PL_debstash
2623 /* Handle first BEGIN of -d. */
2624 && (PL_DBcv || (PL_DBcv = GvCV(PL_DBsub)))
2625 /* Try harder, since this may have been a sighandler, thus
2626 * curstash may be meaningless. */
2627 && (SvTYPE(sv) != SVt_PVCV || CvSTASH((CV*)sv) != PL_debstash)
2628 && !(flags & G_NODEBUG))
2629 PL_op->op_private |= OPpENTERSUB_DB;
2631 if (flags & G_METHOD) {
2632 Zero(&method_op, 1, UNOP);
2633 method_op.op_next = PL_op;
2634 method_op.op_ppaddr = PL_ppaddr[OP_METHOD];
2635 myop.op_ppaddr = PL_ppaddr[OP_ENTERSUB];
2636 PL_op = (OP*)&method_op;
2639 if (!(flags & G_EVAL)) {
2641 CALL_BODY_SUB((OP*)&myop);
2642 retval = PL_stack_sp - (PL_stack_base + oldmark);
2643 CATCH_SET(oldcatch);
2646 myop.op_other = (OP*)&myop;
2648 create_eval_scope(flags|G_FAKINGEVAL);
2656 CALL_BODY_SUB((OP*)&myop);
2657 retval = PL_stack_sp - (PL_stack_base + oldmark);
2658 if (!(flags & G_KEEPERR))
2659 sv_setpvn(ERRSV,"",0);
2665 /* my_exit() was called */
2666 PL_curstash = PL_defstash;
2669 if (PL_statusvalue && !(PL_exit_flags & PERL_EXIT_EXPECTED))
2670 Perl_croak(aTHX_ "Callback called exit");
2675 PL_op = PL_restartop;
2679 PL_stack_sp = PL_stack_base + oldmark;
2680 if (flags & G_ARRAY)
2684 *++PL_stack_sp = &PL_sv_undef;
2689 if (PL_scopestack_ix > oldscope)
2690 delete_eval_scope();
2694 if (flags & G_DISCARD) {
2695 PL_stack_sp = PL_stack_base + oldmark;
2704 /* Eval a string. The G_EVAL flag is always assumed. */
2707 =for apidoc p||eval_sv
2709 Tells Perl to C<eval> the string in the SV.
2715 Perl_eval_sv(pTHX_ SV *sv, I32 flags)
2717 /* See G_* flags in cop.h */
2721 UNOP myop; /* fake syntax tree node */
2722 VOL I32 oldmark = SP - PL_stack_base;
2725 OP* const oldop = PL_op;
2728 if (flags & G_DISCARD) {
2735 Zero(PL_op, 1, UNOP);
2736 EXTEND(PL_stack_sp, 1);
2737 *++PL_stack_sp = sv;
2739 if (!(flags & G_NOARGS))
2740 myop.op_flags = OPf_STACKED;
2741 myop.op_next = NULL;
2742 myop.op_type = OP_ENTEREVAL;
2743 myop.op_flags |= ((flags & G_VOID) ? OPf_WANT_VOID :
2744 (flags & G_ARRAY) ? OPf_WANT_LIST :
2746 if (flags & G_KEEPERR)
2747 myop.op_flags |= OPf_SPECIAL;
2749 /* fail now; otherwise we could fail after the JMPENV_PUSH but
2750 * before a PUSHEVAL, which corrupts the stack after a croak */
2751 TAINT_PROPER("eval_sv()");
2757 CALL_BODY_EVAL((OP*)&myop);
2758 retval = PL_stack_sp - (PL_stack_base + oldmark);
2759 if (!(flags & G_KEEPERR))
2760 sv_setpvn(ERRSV,"",0);
2766 /* my_exit() was called */
2767 PL_curstash = PL_defstash;
2770 if (PL_statusvalue && !(PL_exit_flags & PERL_EXIT_EXPECTED))
2771 Perl_croak(aTHX_ "Callback called exit");
2776 PL_op = PL_restartop;
2780 PL_stack_sp = PL_stack_base + oldmark;
2781 if (flags & G_ARRAY)
2785 *++PL_stack_sp = &PL_sv_undef;
2791 if (flags & G_DISCARD) {
2792 PL_stack_sp = PL_stack_base + oldmark;
2802 =for apidoc p||eval_pv
2804 Tells Perl to C<eval> the given string and return an SV* result.
2810 Perl_eval_pv(pTHX_ const char *p, I32 croak_on_error)
2814 SV* sv = newSVpv(p, 0);
2816 eval_sv(sv, G_SCALAR);
2823 if (croak_on_error && SvTRUE(ERRSV)) {
2824 Perl_croak(aTHX_ SvPVx_nolen_const(ERRSV));
2830 /* Require a module. */
2833 =head1 Embedding Functions
2835 =for apidoc p||require_pv
2837 Tells Perl to C<require> the file named by the string argument. It is
2838 analogous to the Perl code C<eval "require '$file'">. It's even
2839 implemented that way; consider using load_module instead.
2844 Perl_require_pv(pTHX_ const char *pv)
2849 PUSHSTACKi(PERLSI_REQUIRE);
2851 sv = Perl_newSVpvf(aTHX_ "require q%c%s%c", 0, pv, 0);
2852 eval_sv(sv_2mortal(sv), G_DISCARD);
2858 Perl_magicname(pTHX_ const char *sym, const char *name, I32 namlen)
2860 register GV * const gv = gv_fetchpv(sym, GV_ADD, SVt_PV);
2863 sv_magic(GvSV(gv), (SV*)gv, PERL_MAGIC_sv, name, namlen);
2867 S_usage(pTHX_ const char *name) /* XXX move this out into a module ? */
2869 /* This message really ought to be max 23 lines.
2870 * Removed -h because the user already knows that option. Others? */
2872 static const char * const usage_msg[] = {
2873 "-0[octal] specify record separator (\\0, if no argument)",
2874 "-A[mod][=pattern] activate all/given assertions",
2875 "-a autosplit mode with -n or -p (splits $_ into @F)",
2876 "-C[number/list] enables the listed Unicode features",
2877 "-c check syntax only (runs BEGIN and CHECK blocks)",
2878 "-d[:debugger] run program under debugger",
2879 "-D[number/list] set debugging flags (argument is a bit mask or alphabets)",
2880 "-e program one line of program (several -e's allowed, omit programfile)",
2881 "-E program like -e, but enables all optional features",
2882 "-f don't do $sitelib/sitecustomize.pl at startup",
2883 "-F/pattern/ split() pattern for -a switch (//'s are optional)",
2884 "-i[extension] edit <> files in place (makes backup if extension supplied)",
2885 "-Idirectory specify @INC/#include directory (several -I's allowed)",
2886 "-l[octal] enable line ending processing, specifies line terminator",
2887 "-[mM][-]module execute \"use/no module...\" before executing program",
2888 "-n assume \"while (<>) { ... }\" loop around program",
2889 "-p assume loop like -n but print line also, like sed",
2890 "-P run program through C preprocessor before compilation",
2891 "-s enable rudimentary parsing for switches after programfile",
2892 "-S look for programfile using PATH environment variable",
2893 "-t enable tainting warnings",
2894 "-T enable tainting checks",
2895 "-u dump core after parsing program",
2896 "-U allow unsafe operations",
2897 "-v print version, subversion (includes VERY IMPORTANT perl info)",
2898 "-V[:variable] print configuration summary (or a single Config.pm variable)",
2899 "-w enable many useful warnings (RECOMMENDED)",
2900 "-W enable all warnings",
2901 "-x[directory] strip off text before #!perl line and perhaps cd to directory",
2902 "-X disable all warnings",
2906 const char * const *p = usage_msg;
2908 PerlIO_printf(PerlIO_stdout(),
2909 "\nUsage: %s [switches] [--] [programfile] [arguments]",
2912 PerlIO_printf(PerlIO_stdout(), "\n %s", *p++);
2915 /* convert a string of -D options (or digits) into an int.
2916 * sets *s to point to the char after the options */
2920 Perl_get_debug_opts(pTHX_ const char **s, bool givehelp)
2922 static const char * const usage_msgd[] = {
2923 " Debugging flag values: (see also -d)",
2924 " p Tokenizing and parsing (with v, displays parse stack)",
2925 " s Stack snapshots (with v, displays all stacks)",
2926 " l Context (loop) stack processing",
2927 " t Trace execution",
2928 " o Method and overloading resolution",
2929 " c String/numeric conversions",
2930 " P Print profiling info, preprocessor command for -P, source file input state",
2931 " m Memory allocation",
2932 " f Format processing",
2933 " r Regular expression parsing and execution",
2934 " x Syntax tree dump",
2935 " u Tainting checks",
2936 " H Hash dump -- usurps values()",
2937 " X Scratchpad allocation",
2939 " S Thread synchronization",
2941 " R Include reference counts of dumped variables (eg when using -Ds)",
2942 " J Do not s,t,P-debug (Jump over) opcodes within package DB",
2943 " v Verbose: use in conjunction with other flags",
2945 " A Consistency checks on internal structures",
2946 " q quiet - currently only suppresses the 'EXECUTING' message",
2951 /* if adding extra options, remember to update DEBUG_MASK */
2952 static const char debopts[] = "psltocPmfrxuUHXDSTRJvCAq";
2954 for (; isALNUM(**s); (*s)++) {
2955 const char * const d = strchr(debopts,**s);
2957 i |= 1 << (d - debopts);
2958 else if (ckWARN_d(WARN_DEBUGGING))
2959 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
2960 "invalid option -D%c, use -D'' to see choices\n", **s);
2963 else if (isDIGIT(**s)) {
2965 for (; isALNUM(**s); (*s)++) ;
2967 else if (givehelp) {
2968 const char *const *p = usage_msgd;
2969 while (*p) PerlIO_printf(PerlIO_stdout(), "%s\n", *p++);
2972 if ((i & DEBUG_p_FLAG) && ckWARN_d(WARN_DEBUGGING))
2973 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
2974 "-Dp not implemented on this platform\n");
2980 /* This routine handles any switches that can be given during run */
2983 Perl_moreswitches(pTHX_ char *s)
2994 SvREFCNT_dec(PL_rs);
2995 if (s[1] == 'x' && s[2]) {
2996 const char *e = s+=2;
3002 flags = PERL_SCAN_SILENT_ILLDIGIT;
3003 rschar = (U32)grok_hex(s, &numlen, &flags, NULL);
3004 if (s + numlen < e) {
3005 rschar = 0; /* Grandfather -0xFOO as -0 -xFOO. */
3009 PL_rs = newSVpvs("");
3010 SvGROW(PL_rs, (STRLEN)(UNISKIP(rschar) + 1));
3011 tmps = (U8*)SvPVX(PL_rs);
3012 uvchr_to_utf8(tmps, rschar);
3013 SvCUR_set(PL_rs, UNISKIP(rschar));
3018 rschar = (U32)grok_oct(s, &numlen, &flags, NULL);
3019 if (rschar & ~((U8)~0))
3020 PL_rs = &PL_sv_undef;
3021 else if (!rschar && numlen >= 2)
3022 PL_rs = newSVpvs("");
3024 char ch = (char)rschar;
3025 PL_rs = newSVpvn(&ch, 1);
3028 sv_setsv(get_sv("/", TRUE), PL_rs);
3033 PL_unicode = parse_unicode_opts( (const char **)&s );
3034 if (PL_unicode & PERL_UNICODE_UTF8CACHEASSERT_FLAG)
3040 while (*s && !isSPACE(*s)) ++s;
3041 PL_splitstr = savepvn(PL_splitstr, s - PL_splitstr);
3052 forbid_setid('d', -1);
3055 /* -dt indicates to the debugger that threads will be used */
3056 if (*s == 't' && !isALNUM(s[1])) {
3058 my_setenv("PERL5DB_THREADED", "1");
3061 /* The following permits -d:Mod to accepts arguments following an =
3062 in the fashion that -MSome::Mod does. */
3063 if (*s == ':' || *s == '=') {
3065 SV * const sv = newSVpvs("use Devel::");
3067 /* We now allow -d:Module=Foo,Bar */
3068 while(isALNUM(*s) || *s==':') ++s;
3070 sv_catpv(sv, start);
3072 sv_catpvn(sv, start, s-start);
3073 /* Don't use NUL as q// delimiter here, this string goes in the
3075 Perl_sv_catpvf(aTHX_ sv, " split(/,/,q{%s});", ++s);
3078 my_setenv("PERL5DB", SvPV_nolen_const(sv));
3081 PL_perldb = PERLDB_ALL;
3088 forbid_setid('D', -1);
3090 PL_debug = get_debug_opts( (const char **)&s, 1) | DEBUG_TOP_FLAG;
3091 #else /* !DEBUGGING */
3092 if (ckWARN_d(WARN_DEBUGGING))
3093 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3094 "Recompile perl with -DDEBUGGING to use -D switch (did you mean -d ?)\n");
3095 for (s++; isALNUM(*s); s++) ;
3100 usage(PL_origargv[0]);
3103 Safefree(PL_inplace);
3104 #if defined(__CYGWIN__) /* do backup extension automagically */
3105 if (*(s+1) == '\0') {
3106 PL_inplace = savepvs(".bak");
3109 #endif /* __CYGWIN__ */
3111 const char * const start = ++s;
3112 while (*s && !isSPACE(*s))
3115 PL_inplace = savepvn(start, s - start);
3119 if (*s == '-') /* Additional switches on #! line. */
3123 case 'I': /* -I handled both here and in parse_body() */
3124 forbid_setid('I', -1);
3126 while (*s && isSPACE(*s))
3131 /* ignore trailing spaces (possibly followed by other switches) */
3133 for (e = p; *e && !isSPACE(*e); e++) ;
3137 } while (*p && *p != '-');
3138 e = savepvn(s, e-s);
3139 incpush(e, TRUE, TRUE, FALSE, FALSE);
3146 Perl_croak(aTHX_ "No directory specified for -I");
3152 SvREFCNT_dec(PL_ors_sv);
3158 PL_ors_sv = newSVpvs("\n");
3159 numlen = 3 + (*s == '0');
3160 *SvPVX(PL_ors_sv) = (char)grok_oct(s, &numlen, &flags, NULL);
3164 if (RsPARA(PL_rs)) {
3165 PL_ors_sv = newSVpvs("\n\n");
3168 PL_ors_sv = newSVsv(PL_rs);
3173 forbid_setid('A', -1);
3175 PL_preambleav = newAV();
3178 char * const start = s;
3179 SV * const sv = newSVpvs("use assertions::activate");
3180 while(isALNUM(*s) || *s == ':') ++s;
3182 sv_catpvs(sv, "::");
3183 sv_catpvn(sv, start, s-start);
3186 Perl_sv_catpvf(aTHX_ sv, " split(/,/,q%c%s%c)", 0, ++s, 0);
3189 else if (*s != '\0') {
3190 Perl_croak(aTHX_ "Can't use '%c' after -A%.*s", *s, (int)(s-start), start);
3192 av_push(PL_preambleav, sv);
3196 forbid_setid('M', -1); /* XXX ? */
3199 forbid_setid('m', -1); /* XXX ? */
3203 const char *use = "use ";
3204 /* -M-foo == 'no foo' */
3205 /* Leading space on " no " is deliberate, to make both
3206 possibilities the same length. */
3207 if (*s == '-') { use = " no "; ++s; }
3208 sv = newSVpvn(use,4);
3210 /* We allow -M'Module qw(Foo Bar)' */
3211 while(isALNUM(*s) || *s==':') ++s;
3213 sv_catpv(sv, start);
3214 if (*(start-1) == 'm') {
3216 Perl_croak(aTHX_ "Can't use '%c' after -mname", *s);
3217 sv_catpvs( sv, " ()");
3221 Perl_croak(aTHX_ "Module name required with -%c option",
3223 sv_catpvn(sv, start, s-start);
3224 sv_catpvs(sv, " split(/,/,q");
3225 sv_catpvs(sv, "\0"); /* Use NUL as q//-delimiter. */
3227 sv_catpvs(sv, "\0)");
3231 PL_preambleav = newAV();
3232 av_push(PL_preambleav, sv);
3235 Perl_croak(aTHX_ "Missing argument to -%c", *(s-1));
3246 forbid_setid('s', -1);
3247 PL_doswitches = TRUE;
3261 #ifdef MACOS_TRADITIONAL
3262 Perl_croak(aTHX_ "Believe me, you don't want to use \"-u\" on a Macintosh");
3264 PL_do_undump = TRUE;
3272 if (!sv_derived_from(PL_patchlevel, "version"))
3273 upg_version(PL_patchlevel);
3275 PerlIO_printf(PerlIO_stdout(),
3276 Perl_form(aTHX_ "\nThis is perl, %"SVf
3277 #ifdef PERL_PATCHNUM
3278 " DEVEL" STRINGIFY(PERL_PATCHNUM)
3281 (void*)vstringify(PL_patchlevel),
3284 /* Adjust verbose output as in the perl that ships with the DG/UX OS from EMC */
3285 PerlIO_printf(PerlIO_stdout(),
3286 Perl_form(aTHX_ "\nThis is perl, %"SVf"\n",
3287 vstringify(PL_patchlevel)));
3288 PerlIO_printf(PerlIO_stdout(),
3289 Perl_form(aTHX_ " built under %s at %s %s\n",
3290 OSNAME, __DATE__, __TIME__));
3291 PerlIO_printf(PerlIO_stdout(),
3292 Perl_form(aTHX_ " OS Specific Release: %s\n",
3296 #if defined(LOCAL_PATCH_COUNT)
3297 if (LOCAL_PATCH_COUNT > 0)
3298 PerlIO_printf(PerlIO_stdout(),
3299 "\n(with %d registered patch%s, "
3300 "see perl -V for more detail)",
3302 (LOCAL_PATCH_COUNT!=1) ? "es" : "");
3305 PerlIO_printf(PerlIO_stdout(),
3306 "\n\nCopyright 1987-2006, Larry Wall\n");
3307 #ifdef MACOS_TRADITIONAL
3308 PerlIO_printf(PerlIO_stdout(),
3309 "\nMac OS port Copyright 1991-2002, Matthias Neeracher;\n"
3310 "maintained by Chris Nandor\n");
3313 PerlIO_printf(PerlIO_stdout(),
3314 "\nMS-DOS port Copyright (c) 1989, 1990, Diomidis Spinellis\n");
3317 PerlIO_printf(PerlIO_stdout(),
3318 "djgpp v2 port (jpl5003c) by Hirofumi Watanabe, 1996\n"
3319 "djgpp v2 port (perl5004+) by Laszlo Molnar, 1997-1999\n");
3322 PerlIO_printf(PerlIO_stdout(),
3323 "\n\nOS/2 port Copyright (c) 1990, 1991, Raymond Chen, Kai Uwe Rommel\n"
3324 "Version 5 port Copyright (c) 1994-2002, Andreas Kaiser, Ilya Zakharevich\n");
3327 PerlIO_printf(PerlIO_stdout(),
3328 "atariST series port, ++jrb bammi@cadence.com\n");
3331 PerlIO_printf(PerlIO_stdout(),
3332 "BeOS port Copyright Tom Spindler, 1997-1999\n");
3335 PerlIO_printf(PerlIO_stdout(),
3336 "MPE/iX port Copyright by Mark Klein and Mark Bixby, 1996-2003\n");
3339 PerlIO_printf(PerlIO_stdout(),
3340 "MVS (OS390) port by Mortice Kern Systems, 1997-1999\n");
3343 PerlIO_printf(PerlIO_stdout(),
3344 "Stratus VOS port by Paul.Green@stratus.com, 1997-2002\n");
3347 PerlIO_printf(PerlIO_stdout(),
3348 "VM/ESA port by Neale Ferguson, 1998-1999\n");
3351 PerlIO_printf(PerlIO_stdout(),
3352 "BS2000 (POSIX) port by Start Amadeus GmbH, 1998-1999\n");
3355 PerlIO_printf(PerlIO_stdout(),
3356 "MiNT port by Guido Flohr, 1997-1999\n");
3359 PerlIO_printf(PerlIO_stdout(),
3360 "EPOC port by Olaf Flebbe, 1999-2002\n");
3363 PerlIO_printf(PerlIO_stdout(),"WINCE port by Rainer Keuchel, 2001-2002\n");
3364 PerlIO_printf(PerlIO_stdout(),"Built on " __DATE__ " " __TIME__ "\n\n");
3367 #ifdef __SYMBIAN32__
3368 PerlIO_printf(PerlIO_stdout(),
3369 "Symbian port by Nokia, 2004-2005\n");
3371 #ifdef BINARY_BUILD_NOTICE
3372 BINARY_BUILD_NOTICE;
3374 PerlIO_printf(PerlIO_stdout(),
3376 Perl may be copied only under the terms of either the Artistic License or the\n\
3377 GNU General Public License, which may be found in the Perl 5 source kit.\n\n\
3378 Complete documentation for Perl, including FAQ lists, should be found on\n\
3379 this system using \"man perl\" or \"perldoc perl\". If you have access to the\n\
3380 Internet, point your browser at http://www.perl.org/, the Perl Home Page.\n\n");
3383 if (! (PL_dowarn & G_WARN_ALL_MASK))
3384 PL_dowarn |= G_WARN_ON;
3388 PL_dowarn = G_WARN_ALL_ON|G_WARN_ON;
3389 if (!specialWARN(PL_compiling.cop_warnings))
3390 PerlMemShared_free(PL_compiling.cop_warnings);
3391 PL_compiling.cop_warnings = pWARN_ALL ;
3395 PL_dowarn = G_WARN_ALL_OFF;
3396 if (!specialWARN(PL_compiling.cop_warnings))
3397 PerlMemShared_free(PL_compiling.cop_warnings);
3398 PL_compiling.cop_warnings = pWARN_NONE ;
3403 if (s[1] == '-') /* Additional switches on #! line. */
3408 #if defined(WIN32) || !defined(PERL_STRICT_CR)
3414 #ifdef ALTERNATE_SHEBANG
3415 case 'S': /* OS/2 needs -S on "extproc" line. */
3423 Perl_croak(aTHX_ "Can't emulate -%.1s on #! line",s);
3428 /* compliments of Tom Christiansen */
3430 /* unexec() can be found in the Gnu emacs distribution */
3431 /* Known to work with -DUNEXEC and using unexelf.c from GNU emacs-20.2 */
3434 Perl_my_unexec(pTHX)
3436 PERL_UNUSED_CONTEXT;
3438 SV * prog = newSVpv(BIN_EXP, 0);
3439 SV * file = newSVpv(PL_origfilename, 0);
3443 sv_catpvs(prog, "/perl");
3444 sv_catpvs(file, ".perldump");
3446 unexec(SvPVX(file), SvPVX(prog), &etext, sbrk(0), 0);
3447 /* unexec prints msg to stderr in case of failure */
3448 PerlProc_exit(status);
3451 # include <lib$routines.h>
3452 lib$signal(SS$_DEBUG); /* ssdef.h #included from vmsish.h */
3453 # elif defined(WIN32) || defined(__CYGWIN__)
3454 Perl_croak(aTHX_ "dump is not supported");
3456 ABORT(); /* for use with undump */
3461 /* initialize curinterp */
3467 # define PERLVAR(var,type)
3468 # define PERLVARA(var,n,type)
3469 # if defined(PERL_IMPLICIT_CONTEXT)
3470 # define PERLVARI(var,type,init) aTHX->var = init;
3471 # define PERLVARIC(var,type,init) aTHX->var = init;
3473 # define PERLVARI(var,type,init) PERL_GET_INTERP->var = init;
3474 # define PERLVARIC(var,type,init) PERL_GET_INTERP->var = init;
3476 # include "intrpvar.h"
3477 # include "thrdvar.h"
3483 # define PERLVAR(var,type)
3484 # define PERLVARA(var,n,type)
3485 # define PERLVARI(var,type,init) PL_##var = init;
3486 # define PERLVARIC(var,type,init) PL_##var = init;
3487 # include "intrpvar.h"
3488 # include "thrdvar.h"
3495 /* As these are inside a structure, PERLVARI isn't capable of initialising
3497 PL_reg_oldcurpm = PL_reg_curpm = NULL;
3498 PL_reg_poscache = PL_reg_starttry = NULL;
3502 S_init_main_stash(pTHX)
3507 PL_curstash = PL_defstash = newHV();
3508 /* We know that the string "main" will be in the global shared string
3509 table, so it's a small saving to use it rather than allocate another
3511 PL_curstname = newSVpvs_share("main");
3512 gv = gv_fetchpvs("main::", GV_ADD|GV_NOTQUAL, SVt_PVHV);
3513 /* If we hadn't caused another reference to "main" to be in the shared
3514 string table above, then it would be worth reordering these two,
3515 because otherwise all we do is delete "main" from it as a consequence
3516 of the SvREFCNT_dec, only to add it again with hv_name_set */
3517 SvREFCNT_dec(GvHV(gv));
3518 hv_name_set(PL_defstash, "main", 4, 0);
3519 GvHV(gv) = (HV*)SvREFCNT_inc_simple(PL_defstash);
3521 PL_incgv = gv_HVadd(gv_AVadd(gv_fetchpvs("INC", GV_ADD|GV_NOTQUAL,
3523 SvREFCNT_inc_simple(PL_incgv); /* Don't allow it to be freed */
3524 GvMULTI_on(PL_incgv);
3525 PL_hintgv = gv_fetchpvs("\010", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^H */
3526 GvMULTI_on(PL_hintgv);
3527 PL_defgv = gv_fetchpvs("_", GV_ADD|GV_NOTQUAL, SVt_PVAV);
3528 SvREFCNT_inc_simple(PL_defgv);
3529 PL_errgv = gv_HVadd(gv_fetchpvs("@", GV_ADD|GV_NOTQUAL, SVt_PV));
3530 SvREFCNT_inc_simple(PL_errgv);
3531 GvMULTI_on(PL_errgv);
3532 PL_replgv = gv_fetchpvs("\022", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^R */
3533 GvMULTI_on(PL_replgv);
3534 (void)Perl_form(aTHX_ "%240s",""); /* Preallocate temp - for immediate signals. */
3535 #ifdef PERL_DONT_CREATE_GVSV
3538 sv_grow(ERRSV, 240); /* Preallocate - for immediate signals. */
3539 sv_setpvn(ERRSV, "", 0);
3540 PL_curstash = PL_defstash;
3541 CopSTASH_set(&PL_compiling, PL_defstash);
3542 PL_debstash = GvHV(gv_fetchpvs("DB::", GV_ADDMULTI, SVt_PVHV));
3543 PL_globalstash = GvHV(gv_fetchpvs("CORE::GLOBAL::", GV_ADDMULTI,
3545 /* We must init $/ before switches are processed. */
3546 sv_setpvn(get_sv("/", TRUE), "\n", 1);
3550 S_open_script(pTHX_ const char *scriptname, bool dosearch, SV *sv,
3556 const char *cpp_discard_flag;
3565 PL_origfilename = savepvs("-e");
3568 /* if find_script() returns, it returns a malloc()-ed value */
3569 scriptname = PL_origfilename = find_script(scriptname, dosearch, NULL, 1);
3571 if (strnEQ(scriptname, "/dev/fd/", 8) && isDIGIT(scriptname[8]) ) {
3572 const char *s = scriptname + 8;
3578 * Tell apart "normal" usage of fdscript, e.g.
3579 * with bash on FreeBSD:
3580 * perl <( echo '#!perl -DA'; echo 'print "$0\n"')
3581 * from usage in suidperl.
3582 * Does any "normal" usage leave garbage after the number???
3583 * Is it a mistake to use a similar /dev/fd/ construct for
3588 * Be supersafe and do some sanity-checks.
3589 * Still, can we be sure we got the right thing?
3592 Perl_croak(aTHX_ "Wrong syntax (suid) fd script name \"%s\"\n", s);
3595 Perl_croak(aTHX_ "Missing (suid) fd script name\n");
3597 scriptname = savepv(s + 1);
3598 Safefree(PL_origfilename);
3599 PL_origfilename = (char *)scriptname;
3604 CopFILE_free(PL_curcop);
3605 CopFILE_set(PL_curcop, PL_origfilename);
3606 if (*PL_origfilename == '-' && PL_origfilename[1] == '\0')
3607 scriptname = (char *)"";
3608 if (fdscript >= 0) {
3609 PL_rsfp = PerlIO_fdopen(fdscript,PERL_SCRIPT_MODE);
3610 # if defined(HAS_FCNTL) && defined(F_SETFD)
3612 /* ensure close-on-exec */
3613 fcntl(PerlIO_fileno(PL_rsfp),F_SETFD,1);
3618 Perl_croak(aTHX_ "sperl needs fd script\n"
3619 "You should not call sperl directly; do you need to "
3620 "change a #! line\nfrom sperl to perl?\n");
3623 * Do not open (or do other fancy stuff) while setuid.
3624 * Perl does the open, and hands script to suidperl on a fd;
3625 * suidperl only does some checks, sets up UIDs and re-execs
3626 * perl with that fd as it has always done.
3629 if (*suidscript != 1) {
3630 Perl_croak(aTHX_ "suidperl needs (suid) fd script\n");
3633 else if (PL_preprocess) {
3634 const char * const cpp_cfg = CPPSTDIN;
3635 SV * const cpp = newSVpvs("");
3636 SV * const cmd = newSV(0);
3638 if (cpp_cfg[0] == 0) /* PERL_MICRO? */
3639 Perl_croak(aTHX_ "Can't run with cpp -P with CPPSTDIN undefined");
3640 if (strEQ(cpp_cfg, "cppstdin"))
3641 Perl_sv_catpvf(aTHX_ cpp, "%s/", BIN_EXP);
3642 sv_catpv(cpp, cpp_cfg);
3645 sv_catpvs(sv, "-I");
3646 sv_catpv(sv,PRIVLIB_EXP);
3649 DEBUG_P(PerlIO_printf(Perl_debug_log,
3650 "PL_preprocess: scriptname=\"%s\", cpp=\"%s\", sv=\"%s\", CPPMINUS=\"%s\"\n",
3651 scriptname, SvPVX_const (cpp), SvPVX_const (sv),
3654 # if defined(MSDOS) || defined(WIN32) || defined(VMS)
3661 cpp_discard_flag = "";
3663 cpp_discard_flag = "-C";
3667 perl = os2_execname(aTHX);
3669 perl = PL_origargv[0];
3673 /* This strips off Perl comments which might interfere with
3674 the C pre-processor, including #!. #line directives are
3675 deliberately stripped to avoid confusion with Perl's version
3676 of #line. FWP played some golf with it so it will fit
3677 into VMS's 255 character buffer.
3680 code = "(1../^#!.*perl/i)|/^\\s*#(?!\\s*((ifn?|un)def|(el|end)?if|define|include|else|error|pragma)\\b)/||!($|=1)||print";
3682 code = "/^\\s*#(?!\\s*((ifn?|un)def|(el|end)?if|define|include|else|error|pragma)\\b)/||!($|=1)||print";
3684 Perl_sv_setpvf(aTHX_ cmd, "\
3685 %s -ne%s%s%s %s | %"SVf" %s %"SVf" %s",
3686 perl, quote, code, quote, scriptname, (void*)cpp,
3687 cpp_discard_flag, (void*)sv, CPPMINUS);
3689 PL_doextract = FALSE;
3691 DEBUG_P(PerlIO_printf(Perl_debug_log,
3692 "PL_preprocess: cmd=\"%s\"\n",
3695 PL_rsfp = PerlProc_popen((char *)SvPVX_const(cmd), (char *)"r");
3699 else if (!*scriptname) {
3700 forbid_setid(0, *suidscript);
3701 PL_rsfp = PerlIO_stdin();
3704 PL_rsfp = PerlIO_open(scriptname,PERL_SCRIPT_MODE);
3705 # if defined(HAS_FCNTL) && defined(F_SETFD)
3707 /* ensure close-on-exec */
3708 fcntl(PerlIO_fileno(PL_rsfp),F_SETFD,1);
3711 #endif /* IAMSUID */
3713 /* PSz 16 Sep 03 Keep neat error message */
3715 Perl_croak(aTHX_ "Can't open "BIT_BUCKET": %s\n", Strerror(errno));
3717 Perl_croak(aTHX_ "Can't open perl script \"%s\": %s\n",
3718 CopFILE(PL_curcop), Strerror(errno));
3724 * I_SYSSTATVFS HAS_FSTATVFS
3726 * I_STATFS HAS_FSTATFS HAS_GETFSSTAT
3727 * I_MNTENT HAS_GETMNTENT HAS_HASMNTOPT
3728 * here so that metaconfig picks them up. */
3732 S_fd_on_nosuid_fs(pTHX_ int fd)
3735 * We used to do this as "plain" user (after swapping UIDs with setreuid);
3736 * but is needed also on machines without setreuid.
3737 * Seems safe enough to run as root.
3739 int check_okay = 0; /* able to do all the required sys/libcalls */
3740 int on_nosuid = 0; /* the fd is on a nosuid fs */
3742 * Need to check noexec also: nosuid might not be set, the average
3743 * sysadmin would say that nosuid is irrelevant once he sets noexec.
3745 int on_noexec = 0; /* the fd is on a noexec fs */
3748 * Preferred order: fstatvfs(), fstatfs(), ustat()+getmnt(), getmntent().
3749 * fstatvfs() is UNIX98.
3750 * fstatfs() is 4.3 BSD.
3751 * ustat()+getmnt() is pre-4.3 BSD.
3752 * getmntent() is O(number-of-mounted-filesystems) and can hang on
3753 * an irrelevant filesystem while trying to reach the right one.
3756 #undef FD_ON_NOSUID_CHECK_OKAY /* found the syscalls to do the check? */
3758 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3759 defined(HAS_FSTATVFS)
3760 # define FD_ON_NOSUID_CHECK_OKAY
3761 struct statvfs stfs;
3763 check_okay = fstatvfs(fd, &stfs) == 0;
3764 on_nosuid = check_okay && (stfs.f_flag & ST_NOSUID);
3766 /* ST_NOEXEC certainly absent on AIX 5.1, and doesn't seem to be documented
3767 on platforms where it is present. */
3768 on_noexec = check_okay && (stfs.f_flag & ST_NOEXEC);
3770 # endif /* fstatvfs */
3772 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3773 defined(PERL_MOUNT_NOSUID) && \
3774 defined(PERL_MOUNT_NOEXEC) && \
3775 defined(HAS_FSTATFS) && \
3776 defined(HAS_STRUCT_STATFS) && \
3777 defined(HAS_STRUCT_STATFS_F_FLAGS)
3778 # define FD_ON_NOSUID_CHECK_OKAY
3781 check_okay = fstatfs(fd, &stfs) == 0;
3782 on_nosuid = check_okay && (stfs.f_flags & PERL_MOUNT_NOSUID);
3783 on_noexec = check_okay && (stfs.f_flags & PERL_MOUNT_NOEXEC);
3784 # endif /* fstatfs */
3786 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3787 defined(PERL_MOUNT_NOSUID) && \
3788 defined(PERL_MOUNT_NOEXEC) && \
3789 defined(HAS_FSTAT) && \
3790 defined(HAS_USTAT) && \
3791 defined(HAS_GETMNT) && \
3792 defined(HAS_STRUCT_FS_DATA) && \
3794 # define FD_ON_NOSUID_CHECK_OKAY
3797 if (fstat(fd, &fdst) == 0) {
3799 if (ustat(fdst.st_dev, &us) == 0) {
3801 /* NOSTAT_ONE here because we're not examining fields which
3802 * vary between that case and STAT_ONE. */
3803 if (getmnt((int*)0, &fsd, (int)0, NOSTAT_ONE, us.f_fname) == 0) {
3804 size_t cmplen = sizeof(us.f_fname);
3805 if (sizeof(fsd.fd_req.path) < cmplen)
3806 cmplen = sizeof(fsd.fd_req.path);
3807 if (strnEQ(fsd.fd_req.path, us.f_fname, cmplen) &&
3808 fdst.st_dev == fsd.fd_req.dev) {
3810 on_nosuid = fsd.fd_req.flags & PERL_MOUNT_NOSUID;
3811 on_noexec = fsd.fd_req.flags & PERL_MOUNT_NOEXEC;
3816 # endif /* fstat+ustat+getmnt */
3818 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3819 defined(HAS_GETMNTENT) && \
3820 defined(HAS_HASMNTOPT) && \
3821 defined(MNTOPT_NOSUID) && \
3822 defined(MNTOPT_NOEXEC)
3823 # define FD_ON_NOSUID_CHECK_OKAY
3824 FILE *mtab = fopen("/etc/mtab", "r");
3825 struct mntent *entry;
3828 if (mtab && (fstat(fd, &stb) == 0)) {
3829 while (entry = getmntent(mtab)) {
3830 if (stat(entry->mnt_dir, &fsb) == 0
3831 && fsb.st_dev == stb.st_dev)
3833 /* found the filesystem */
3835 if (hasmntopt(entry, MNTOPT_NOSUID))
3837 if (hasmntopt(entry, MNTOPT_NOEXEC))
3840 } /* A single fs may well fail its stat(). */
3845 # endif /* getmntent+hasmntopt */
3848 Perl_croak(aTHX_ "Can't check filesystem of script \"%s\" for nosuid/noexec", PL_origfilename);
3850 Perl_croak(aTHX_ "Setuid script \"%s\" on nosuid filesystem", PL_origfilename);
3852 Perl_croak(aTHX_ "Setuid script \"%s\" on noexec filesystem", PL_origfilename);
3853 return ((!check_okay) || on_nosuid || on_noexec);
3855 #endif /* IAMSUID */
3858 S_validate_suid(pTHX_ const char *validarg, const char *scriptname,
3859 int fdscript, int suidscript)
3864 #endif /* IAMSUID */
3866 /* do we need to emulate setuid on scripts? */
3868 /* This code is for those BSD systems that have setuid #! scripts disabled
3869 * in the kernel because of a security problem. Merely defining DOSUID
3870 * in perl will not fix that problem, but if you have disabled setuid
3871 * scripts in the kernel, this will attempt to emulate setuid and setgid
3872 * on scripts that have those now-otherwise-useless bits set. The setuid
3873 * root version must be called suidperl or sperlN.NNN. If regular perl
3874 * discovers that it has opened a setuid script, it calls suidperl with
3875 * the same argv that it had. If suidperl finds that the script it has
3876 * just opened is NOT setuid root, it sets the effective uid back to the
3877 * uid. We don't just make perl setuid root because that loses the
3878 * effective uid we had before invoking perl, if it was different from the
3881 * Description/comments above do not match current workings:
3882 * suidperl must be hardlinked to sperlN.NNN (that is what we exec);
3883 * suidperl called with script open and name changed to /dev/fd/N/X;
3884 * suidperl croaks if script is not setuid;
3885 * making perl setuid would be a huge security risk (and yes, that
3886 * would lose any euid we might have had).
3888 * DOSUID must be defined in both perl and suidperl, and IAMSUID must
3889 * be defined in suidperl only. suidperl must be setuid root. The
3890 * Configure script will set this up for you if you want it.
3896 if (PerlLIO_fstat(PerlIO_fileno(PL_rsfp),&PL_statbuf) < 0) /* normal stat is insecure */
3897 Perl_croak(aTHX_ "Can't stat script \"%s\"",PL_origfilename);
3898 if (PL_statbuf.st_mode & (S_ISUID|S_ISGID)) {
3900 const char *linestr;
3904 if (fdscript < 0 || suidscript != 1)
3905 Perl_croak(aTHX_ "Need (suid) fdscript in suidperl\n"); /* We already checked this */
3907 * Since the script is opened by perl, not suidperl, some of these
3908 * checks are superfluous. Leaving them in probably does not lower
3912 * Do checks even for systems with no HAS_SETREUID.
3913 * We used to swap, then re-swap UIDs with
3915 if (setreuid(PL_euid,PL_uid) < 0
3916 || PerlProc_getuid() != PL_euid || PerlProc_geteuid() != PL_uid)
3917 Perl_croak(aTHX_ "Can't swap uid and euid");
3920 if (setreuid(PL_uid,PL_euid) < 0
3921 || PerlProc_getuid() != PL_uid || PerlProc_geteuid() != PL_euid)
3922 Perl_croak(aTHX_ "Can't reswap uid and euid");
3926 /* On this access check to make sure the directories are readable,
3927 * there is actually a small window that the user could use to make
3928 * filename point to an accessible directory. So there is a faint
3929 * chance that someone could execute a setuid script down in a
3930 * non-accessible directory. I don't know what to do about that.
3931 * But I don't think it's too important. The manual lies when
3932 * it says access() is useful in setuid programs.
3934 * So, access() is pretty useless... but not harmful... do anyway.
3936 if (PerlLIO_access(CopFILE(PL_curcop),1)) { /*double check*/
3937 Perl_croak(aTHX_ "Can't access() script\n");
3940 /* If we can swap euid and uid, then we can determine access rights
3941 * with a simple stat of the file, and then compare device and
3942 * inode to make sure we did stat() on the same file we opened.
3943 * Then we just have to make sure he or she can execute it.
3946 * As the script is opened by perl, not suidperl, we do not need to
3947 * care much about access rights.
3949 * The 'script changed' check is needed, or we can get lied to
3950 * about $0 with e.g.
3951 * suidperl /dev/fd/4//bin/x 4<setuidscript
3952 * Without HAS_SETREUID, is it safe to stat() as root?
3954 * Are there any operating systems that pass /dev/fd/xxx for setuid
3955 * scripts, as suggested/described in perlsec(1)? Surely they do not
3956 * pass the script name as we do, so the "script changed" test would
3957 * fail for them... but we never get here with
3958 * SETUID_SCRIPTS_ARE_SECURE_NOW defined.
3960 * This is one place where we must "lie" about return status: not
3961 * say if the stat() failed. We are doing this as root, and could
3962 * be tricked into reporting existence or not of files that the
3963 * "plain" user cannot even see.
3967 if (PerlLIO_stat(CopFILE(PL_curcop),&tmpstatbuf) < 0 ||
3968 tmpstatbuf.st_dev != PL_statbuf.st_dev ||
3969 tmpstatbuf.st_ino != PL_statbuf.st_ino) {
3970 Perl_croak(aTHX_ "Setuid script changed\n");
3974 if (!cando(S_IXUSR,FALSE,&PL_statbuf)) /* can real uid exec? */
3975 Perl_croak(aTHX_ "Real UID cannot exec script\n");
3978 * We used to do this check as the "plain" user (after swapping
3979 * UIDs). But the check for nosuid and noexec filesystem is needed,
3980 * and should be done even without HAS_SETREUID. (Maybe those
3981 * operating systems do not have such mount options anyway...)
3982 * Seems safe enough to do as root.
3984 #if !defined(NO_NOSUID_CHECK)
3985 if (fd_on_nosuid_fs(PerlIO_fileno(PL_rsfp))) {
3986 Perl_croak(aTHX_ "Setuid script on nosuid or noexec filesystem\n");
3989 #endif /* IAMSUID */
3991 if (!S_ISREG(PL_statbuf.st_mode)) {
3992 Perl_croak(aTHX_ "Setuid script not plain file\n");
3994 if (PL_statbuf.st_mode & S_IWOTH)
3995 Perl_croak(aTHX_ "Setuid/gid script is writable by world");
3996 PL_doswitches = FALSE; /* -s is insecure in suid */
3997 /* PSz 13 Nov 03 But -s was caught elsewhere ... so unsetting it here is useless(?!) */
3998 CopLINE_inc(PL_curcop);
3999 if (sv_gets(PL_linestr, PL_rsfp, 0) == NULL)
4000 Perl_croak(aTHX_ "No #! line");
4001 linestr = SvPV_nolen_const(PL_linestr);
4002 /* required even on Sys V */
4003 if (!*linestr || !linestr[1] || strnNE(linestr,"#!",2))
4004 Perl_croak(aTHX_ "No #! line");
4008 /* Sanity check on line length */
4009 s_end = s + strlen(s);
4010 if (s_end == s || (s_end - s) > 4000)
4011 Perl_croak(aTHX_ "Very long #! line");
4012 /* Allow more than a single space after #! */
4013 while (isSPACE(*s)) s++;
4014 /* Sanity check on buffer end */
4015 while ((*s) && !isSPACE(*s)) s++;
4016 for (s2 = s; (s2 > linestr &&
4017 (isDIGIT(s2[-1]) || s2[-1] == '.' || s2[-1] == '_'
4018 || s2[-1] == '-')); s2--) ;
4019 /* Sanity check on buffer start */
4020 if ( (s2-4 < linestr || strnNE(s2-4,"perl",4)) &&
4021 (s-9 < linestr || strnNE(s-9,"perl",4)) )
4022 Perl_croak(aTHX_ "Not a perl script");
4023 while (*s == ' ' || *s == '\t') s++;
4025 * #! arg must be what we saw above. They can invoke it by
4026 * mentioning suidperl explicitly, but they may not add any strange
4027 * arguments beyond what #! says if they do invoke suidperl that way.
4030 * The way validarg was set up, we rely on the kernel to start
4031 * scripts with argv[1] set to contain all #! line switches (the
4035 * Check that we got all the arguments listed in the #! line (not
4036 * just that there are no extraneous arguments). Might not matter
4037 * much, as switches from #! line seem to be acted upon (also), and
4038 * so may be checked and trapped in perl. But, security checks must
4039 * be done in suidperl and not deferred to perl. Note that suidperl
4040 * does not get around to parsing (and checking) the switches on
4041 * the #! line (but execs perl sooner).
4042 * Allow (require) a trailing newline (which may be of two
4043 * characters on some architectures?) (but no other trailing
4046 len = strlen(validarg);
4047 if (strEQ(validarg," PHOOEY ") ||
4048 strnNE(s,validarg,len) || !isSPACE(s[len]) ||
4049 !((s_end - s) == len+1
4050 || ((s_end - s) == len+2 && isSPACE(s[len+1]))))
4051 Perl_croak(aTHX_ "Args must match #! line");
4055 PL_euid != PL_uid && (PL_statbuf.st_mode & S_ISUID) &&
4056 PL_euid == PL_statbuf.st_uid)
4058 Perl_croak(aTHX_ "YOU HAVEN'T DISABLED SET-ID SCRIPTS IN THE KERNEL YET!\n\
4059 FIX YOUR KERNEL, OR PUT A C WRAPPER AROUND THIS SCRIPT!\n");
4060 #endif /* IAMSUID */
4063 PL_euid) { /* oops, we're not the setuid root perl */
4065 * When root runs a setuid script, we do not go through the same
4066 * steps of execing sperl and then perl with fd scripts, but
4067 * simply set up UIDs within the same perl invocation; so do
4068 * not have the same checks (on options, whatever) that we have
4069 * for plain users. No problem really: would have to be a script
4070 * that does not actually work for plain users; and if root is
4071 * foolish and can be persuaded to run such an unsafe script, he
4072 * might run also non-setuid ones, and deserves what he gets.
4074 * Or, we might drop the PL_euid check above (and rely just on
4075 * fdscript to avoid loops), and do the execs
4081 * Pass fd script to suidperl.
4082 * Exec suidperl, substituting fd script for scriptname.
4083 * Pass script name as "subdir" of fd, which perl will grok;
4084 * in fact will use that to distinguish this from "normal"
4085 * usage, see comments above.
4087 PerlIO_rewind(PL_rsfp);
4088 PerlLIO_lseek(PerlIO_fileno(PL_rsfp),(Off_t)0,0); /* just in case rewind didn't */
4089 /* PSz 27 Feb 04 Sanity checks on scriptname */
4090 if ((!scriptname) || (!*scriptname) ) {
4091 Perl_croak(aTHX_ "No setuid script name\n");
4093 if (*scriptname == '-') {
4094 Perl_croak(aTHX_ "Setuid script name may not begin with dash\n");
4095 /* Or we might confuse it with an option when replacing
4096 * name in argument list, below (though we do pointer, not
4097 * string, comparisons).
4100 for (which = 1; PL_origargv[which] && PL_origargv[which] != scriptname; which++) ;
4101 if (!PL_origargv[which]) {
4102 Perl_croak(aTHX_ "Can't change argv to have fd script\n");
4104 PL_origargv[which] = savepv(Perl_form(aTHX_ "/dev/fd/%d/%s",
4105 PerlIO_fileno(PL_rsfp), PL_origargv[which]));
4106 #if defined(HAS_FCNTL) && defined(F_SETFD)
4107 fcntl(PerlIO_fileno(PL_rsfp),F_SETFD,0); /* ensure no close-on-exec */
4110 PerlProc_execv(Perl_form(aTHX_ "%s/sperl"PERL_FS_VER_FMT, BIN_EXP,
4111 (int)PERL_REVISION, (int)PERL_VERSION,
4112 (int)PERL_SUBVERSION), PL_origargv);
4114 #endif /* IAMSUID */
4115 Perl_croak(aTHX_ "Can't do setuid (cannot exec sperl)\n");
4118 if (PL_statbuf.st_mode & S_ISGID && PL_statbuf.st_gid != PL_egid) {
4120 * This seems back to front: we try HAS_SETEGID first; if not available
4121 * then try HAS_SETREGID; as a last chance we try HAS_SETRESGID. May be OK
4122 * in the sense that we only want to set EGID; but are there any machines
4123 * with either of the latter, but not the former? Same with UID, later.
4126 (void)setegid(PL_statbuf.st_gid);
4129 (void)setregid((Gid_t)-1,PL_statbuf.st_gid);
4131 #ifdef HAS_SETRESGID
4132 (void)setresgid((Gid_t)-1,PL_statbuf.st_gid,(Gid_t)-1);
4134 PerlProc_setgid(PL_statbuf.st_gid);
4138 if (PerlProc_getegid() != PL_statbuf.st_gid)
4139 Perl_croak(aTHX_ "Can't do setegid!\n");
4141 if (PL_statbuf.st_mode & S_ISUID) {
4142 if (PL_statbuf.st_uid != PL_euid)
4144 (void)seteuid(PL_statbuf.st_uid); /* all that for this */
4147 (void)setreuid((Uid_t)-1,PL_statbuf.st_uid);
4149 #ifdef HAS_SETRESUID
4150 (void)setresuid((Uid_t)-1,PL_statbuf.st_uid,(Uid_t)-1);
4152 PerlProc_setuid(PL_statbuf.st_uid);
4156 if (PerlProc_geteuid() != PL_statbuf.st_uid)
4157 Perl_croak(aTHX_ "Can't do seteuid!\n");
4159 else if (PL_uid) { /* oops, mustn't run as root */
4161 (void)seteuid((Uid_t)PL_uid);
4164 (void)setreuid((Uid_t)-1,(Uid_t)PL_uid);
4166 #ifdef HAS_SETRESUID
4167 (void)setresuid((Uid_t)-1,(Uid_t)PL_uid,(Uid_t)-1);
4169 PerlProc_setuid((Uid_t)PL_uid);
4173 if (PerlProc_geteuid() != PL_uid)
4174 Perl_croak(aTHX_ "Can't do seteuid!\n");
4177 if (!cando(S_IXUSR,TRUE,&PL_statbuf))
4178 Perl_croak(aTHX_ "Effective UID cannot exec script\n"); /* they can't do this */
4181 else if (PL_preprocess) /* PSz 13 Nov 03 Caught elsewhere, useless(?!) here */
4182 Perl_croak(aTHX_ "-P not allowed for setuid/setgid script\n");
4183 else if (fdscript < 0 || suidscript != 1)
4184 /* PSz 13 Nov 03 Caught elsewhere, useless(?!) here */
4185 Perl_croak(aTHX_ "(suid) fdscript needed in suidperl\n");
4187 /* PSz 16 Sep 03 Keep neat error message */
4188 Perl_croak(aTHX_ "Script is not setuid/setgid in suidperl\n");
4191 /* We absolutely must clear out any saved ids here, so we */
4192 /* exec the real perl, substituting fd script for scriptname. */
4193 /* (We pass script name as "subdir" of fd, which perl will grok.) */
4195 * It might be thought that using setresgid and/or setresuid (changed to
4196 * set the saved IDs) above might obviate the need to exec, and we could
4197 * go on to "do the perl thing".
4199 * Is there such a thing as "saved GID", and is that set for setuid (but
4200 * not setgid) execution like suidperl? Without exec, it would not be
4201 * cleared for setuid (but not setgid) scripts (or might need a dummy
4204 * We need suidperl to do the exact same argument checking that perl
4205 * does. Thus it cannot be very small; while it could be significantly
4206 * smaller, it is safer (simpler?) to make it essentially the same
4207 * binary as perl (but they are not identical). - Maybe could defer that
4208 * check to the invoked perl, and suidperl be a tiny wrapper instead;
4209 * but prefer to do thorough checks in suidperl itself. Such deferral
4210 * would make suidperl security rely on perl, a design no-no.
4212 * Setuid things should be short and simple, thus easy to understand and
4213 * verify. They should do their "own thing", without influence by
4214 * attackers. It may help if their internal execution flow is fixed,
4215 * regardless of platform: it may be best to exec anyway.
4217 * Suidperl should at least be conceptually simple: a wrapper only,
4218 * never to do any real perl. Maybe we should put
4220 * Perl_croak(aTHX_ "Suidperl should never do real perl\n");
4222 * into the perly bits.
4224 PerlIO_rewind(PL_rsfp);
4225 PerlLIO_lseek(PerlIO_fileno(PL_rsfp),(Off_t)0,0); /* just in case rewind didn't */
4227 * Keep original arguments: suidperl already has fd script.
4229 /* for (which = 1; PL_origargv[which] && PL_origargv[which] != scriptname; which++) ; */
4230 /* if (!PL_origargv[which]) { */
4231 /* errno = EPERM; */
4232 /* Perl_croak(aTHX_ "Permission denied\n"); */
4234 /* PL_origargv[which] = savepv(Perl_form(aTHX_ "/dev/fd/%d/%s", */
4235 /* PerlIO_fileno(PL_rsfp), PL_origargv[which])); */
4236 #if defined(HAS_FCNTL) && defined(F_SETFD)
4237 fcntl(PerlIO_fileno(PL_rsfp),F_SETFD,0); /* ensure no close-on-exec */
4240 PerlProc_execv(Perl_form(aTHX_ "%s/perl"PERL_FS_VER_FMT, BIN_EXP,
4241 (int)PERL_REVISION, (int)PERL_VERSION,
4242 (int)PERL_SUBVERSION), PL_origargv);/* try again */
4244 Perl_croak(aTHX_ "Can't do setuid (suidperl cannot exec perl)\n");
4245 #endif /* IAMSUID */
4247 PERL_UNUSED_ARG(fdscript);
4248 PERL_UNUSED_ARG(suidscript);
4249 if (PL_euid != PL_uid || PL_egid != PL_gid) { /* (suidperl doesn't exist, in fact) */
4250 #ifndef SETUID_SCRIPTS_ARE_SECURE_NOW
4251 PerlLIO_fstat(PerlIO_fileno(PL_rsfp),&PL_statbuf); /* may be either wrapped or real suid */
4252 if ((PL_euid != PL_uid && PL_euid == PL_statbuf.st_uid && PL_statbuf.st_mode & S_ISUID)
4254 (PL_egid != PL_gid && PL_egid == PL_statbuf.st_gid && PL_statbuf.st_mode & S_ISGID)
4257 Perl_croak(aTHX_ "YOU HAVEN'T DISABLED SET-ID SCRIPTS IN THE KERNEL YET!\n\
4258 FIX YOUR KERNEL, PUT A C WRAPPER AROUND THIS SCRIPT, OR USE -u AND UNDUMP!\n");
4259 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4260 /* not set-id, must be wrapped */
4263 PERL_UNUSED_ARG(validarg);
4264 PERL_UNUSED_ARG(scriptname);
4268 S_find_beginning(pTHX)
4272 register const char *s2;
4273 #ifdef MACOS_TRADITIONAL
4277 /* skip forward in input to the real script? */
4279 #ifdef MACOS_TRADITIONAL
4280 /* Since the Mac OS does not honor #! arguments for us, we do it ourselves */
4282 while (PL_doextract || gMacPerl_AlwaysExtract) {
4283 if ((s = sv_gets(PL_linestr, PL_rsfp, 0)) == NULL) {
4284 if (!gMacPerl_AlwaysExtract)
4285 Perl_croak(aTHX_ "No Perl script found in input\n");
4287 if (PL_doextract) /* require explicit override ? */
4288 if (!OverrideExtract(PL_origfilename))
4289 Perl_croak(aTHX_ "User aborted script\n");
4291 PL_doextract = FALSE;
4293 /* Pater peccavi, file does not have #! */
4294 PerlIO_rewind(PL_rsfp);
4299 while (PL_doextract) {
4300 if ((s = sv_gets(PL_linestr, PL_rsfp, 0)) == NULL)
4301 Perl_croak(aTHX_ "No Perl script found in input\n");
4304 if (*s == '#' && s[1] == '!' && ((s = instr(s,"perl")) || (s = instr(s2,"PERL")))) {
4305 PerlIO_ungetc(PL_rsfp, '\n'); /* to keep line count right */
4306 PL_doextract = FALSE;
4307 while (*s && !(isSPACE (*s) || *s == '#')) s++;
4309 while (*s == ' ' || *s == '\t') s++;
4311 while (isDIGIT(s2[-1]) || s2[-1] == '-' || s2[-1] == '.'
4312 || s2[-1] == '_') s2--;
4313 if (strnEQ(s2-4,"perl",4))
4314 while ((s = moreswitches(s)))
4317 #ifdef MACOS_TRADITIONAL
4318 /* We are always searching for the #!perl line in MacPerl,
4319 * so if we find it, still keep the line count correct
4320 * by counting lines we already skipped over
4322 for (; maclines > 0 ; maclines--)
4323 PerlIO_ungetc(PL_rsfp, '\n');
4327 /* gMacPerl_AlwaysExtract is false in MPW tool */
4328 } else if (gMacPerl_AlwaysExtract) {
4340 PL_uid = PerlProc_getuid();
4341 PL_euid = PerlProc_geteuid();
4342 PL_gid = PerlProc_getgid();
4343 PL_egid = PerlProc_getegid();
4345 PL_uid |= PL_gid << 16;
4346 PL_euid |= PL_egid << 16;
4348 /* Should not happen: */
4349 CHECK_MALLOC_TAINT(PL_uid && (PL_euid != PL_uid || PL_egid != PL_gid));
4350 PL_tainting |= (PL_uid && (PL_euid != PL_uid || PL_egid != PL_gid));
4353 * Should go by suidscript, not uid!=euid: why disallow
4354 * system("ls") in scripts run from setuid things?
4355 * Or, is this run before we check arguments and set suidscript?
4356 * What about SETUID_SCRIPTS_ARE_SECURE_NOW: could we use fdscript then?
4357 * (We never have suidscript, can we be sure to have fdscript?)
4358 * Or must then go by UID checks? See comments in forbid_setid also.
4362 /* This is used very early in the lifetime of the program,
4363 * before even the options are parsed, so PL_tainting has
4364 * not been initialized properly. */
4366 Perl_doing_taint(int argc, char *argv[], char *envp[])
4368 #ifndef PERL_IMPLICIT_SYS
4369 /* If we have PERL_IMPLICIT_SYS we can't call getuid() et alia
4370 * before we have an interpreter-- and the whole point of this
4371 * function is to be called at such an early stage. If you are on
4372 * a system with PERL_IMPLICIT_SYS but you do have a concept of
4373 * "tainted because running with altered effective ids', you'll
4374 * have to add your own checks somewhere in here. The two most
4375 * known samples of 'implicitness' are Win32 and NetWare, neither
4376 * of which has much of concept of 'uids'. */
4377 int uid = PerlProc_getuid();
4378 int euid = PerlProc_geteuid();
4379 int gid = PerlProc_getgid();
4380 int egid = PerlProc_getegid();
4387 if (uid && (euid != uid || egid != gid))
4389 #endif /* !PERL_IMPLICIT_SYS */
4390 /* This is a really primitive check; environment gets ignored only
4391 * if -T are the first chars together; otherwise one gets
4392 * "Too late" message. */
4393 if ( argc > 1 && argv[1][0] == '-'
4394 && (argv[1][1] == 't' || argv[1][1] == 'T') )
4399 /* Passing the flag as a single char rather than a string is a slight space
4400 optimisation. The only message that isn't /^-.$/ is
4401 "program input from stdin", which is substituted in place of '\0', which
4402 could never be a command line flag. */
4404 S_forbid_setid(pTHX_ const char flag, const int suidscript)
4407 char string[3] = "-x";
4408 const char *message = "program input from stdin";
4415 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
4416 if (PL_euid != PL_uid)
4417 Perl_croak(aTHX_ "No %s allowed while running setuid", message);
4418 if (PL_egid != PL_gid)
4419 Perl_croak(aTHX_ "No %s allowed while running setgid", message);
4420 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4422 * Checks for UID/GID above "wrong": why disallow
4423 * perl -e 'print "Hello\n"'
4424 * from within setuid things?? Simply drop them: replaced by
4425 * fdscript/suidscript and #ifdef IAMSUID checks below.
4427 * This may be too late for command-line switches. Will catch those on
4428 * the #! line, after finding the script name and setting up
4429 * fdscript/suidscript. Note that suidperl does not get around to
4430 * parsing (and checking) the switches on the #! line, but checks that
4431 * the two sets are identical.
4433 * With SETUID_SCRIPTS_ARE_SECURE_NOW, could we use fdscript, also or
4434 * instead, or would that be "too late"? (We never have suidscript, can
4435 * we be sure to have fdscript?)
4437 * Catch things with suidscript (in descendant of suidperl), even with
4438 * right UID/GID. Was already checked in suidperl, with #ifdef IAMSUID,
4439 * below; but I am paranoid.
4441 * Also see comments about root running a setuid script, elsewhere.
4443 if (suidscript >= 0)
4444 Perl_croak(aTHX_ "No %s allowed with (suid) fdscript", message);
4446 /* PSz 11 Nov 03 Catch it in suidperl, always! */
4447 Perl_croak(aTHX_ "No %s allowed in suidperl", message);
4448 #endif /* IAMSUID */
4452 Perl_init_debugger(pTHX)
4455 HV * const ostash = PL_curstash;
4457 PL_curstash = PL_debstash;
4458 PL_dbargs = GvAV(gv_AVadd((gv_fetchpvs("DB::args", GV_ADDMULTI,
4460 AvREAL_off(PL_dbargs);
4461 PL_DBgv = gv_fetchpvs("DB::DB", GV_ADDMULTI, SVt_PVGV);
4462 PL_DBline = gv_fetchpvs("DB::dbline", GV_ADDMULTI, SVt_PVAV);
4463 PL_DBsub = gv_HVadd(gv_fetchpvs("DB::sub", GV_ADDMULTI, SVt_PVHV));
4464 PL_DBsingle = GvSV((gv_fetchpvs("DB::single", GV_ADDMULTI, SVt_PV)));
4465 sv_setiv(PL_DBsingle, 0);
4466 PL_DBtrace = GvSV((gv_fetchpvs("DB::trace", GV_ADDMULTI, SVt_PV)));
4467 sv_setiv(PL_DBtrace, 0);
4468 PL_DBsignal = GvSV((gv_fetchpvs("DB::signal", GV_ADDMULTI, SVt_PV)));
4469 sv_setiv(PL_DBsignal, 0);
4470 PL_DBassertion = GvSV((gv_fetchpvs("DB::assertion", GV_ADDMULTI, SVt_PV)));
4471 sv_setiv(PL_DBassertion, 0);
4472 PL_curstash = ostash;
4475 #ifndef STRESS_REALLOC
4476 #define REASONABLE(size) (size)
4478 #define REASONABLE(size) (1) /* unreasonable */
4482 Perl_init_stacks(pTHX)
4485 /* start with 128-item stack and 8K cxstack */
4486 PL_curstackinfo = new_stackinfo(REASONABLE(128),
4487 REASONABLE(8192/sizeof(PERL_CONTEXT) - 1));
4488 PL_curstackinfo->si_type = PERLSI_MAIN;
4489 PL_curstack = PL_curstackinfo->si_stack;
4490 PL_mainstack = PL_curstack; /* remember in case we switch stacks */
4492 PL_stack_base = AvARRAY(PL_curstack);
4493 PL_stack_sp = PL_stack_base;
4494 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
4496 Newx(PL_tmps_stack,REASONABLE(128),SV*);
4499 PL_tmps_max = REASONABLE(128);
4501 Newx(PL_markstack,REASONABLE(32),I32);
4502 PL_markstack_ptr = PL_markstack;
4503 PL_markstack_max = PL_markstack + REASONABLE(32);
4507 Newx(PL_scopestack,REASONABLE(32),I32);
4508 PL_scopestack_ix = 0;
4509 PL_scopestack_max = REASONABLE(32);
4511 Newx(PL_savestack,REASONABLE(128),ANY);
4512 PL_savestack_ix = 0;
4513 PL_savestack_max = REASONABLE(128);
4522 while (PL_curstackinfo->si_next)
4523 PL_curstackinfo = PL_curstackinfo->si_next;
4524 while (PL_curstackinfo) {
4525 PERL_SI *p = PL_curstackinfo->si_prev;
4526 /* curstackinfo->si_stack got nuked by sv_free_arenas() */
4527 Safefree(PL_curstackinfo->si_cxstack);
4528 Safefree(PL_curstackinfo);
4529 PL_curstackinfo = p;
4531 Safefree(PL_tmps_stack);
4532 Safefree(PL_markstack);
4533 Safefree(PL_scopestack);
4534 Safefree(PL_savestack);
4544 lex_start(PL_linestr);
4546 PL_subname = newSVpvs("main");
4550 S_init_predump_symbols(pTHX)
4556 sv_setpvn(get_sv("\"", TRUE), " ", 1);
4557 PL_stdingv = gv_fetchpvs("STDIN", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4558 GvMULTI_on(PL_stdingv);
4559 io = GvIOp(PL_stdingv);
4560 IoTYPE(io) = IoTYPE_RDONLY;
4561 IoIFP(io) = PerlIO_stdin();
4562 tmpgv = gv_fetchpvs("stdin", GV_ADD|GV_NOTQUAL, SVt_PV);
4564 GvIOp(tmpgv) = (IO*)SvREFCNT_inc_simple(io);
4566 tmpgv = gv_fetchpvs("STDOUT", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4569 IoTYPE(io) = IoTYPE_WRONLY;
4570 IoOFP(io) = IoIFP(io) = PerlIO_stdout();
4572 tmpgv = gv_fetchpvs("stdout", GV_ADD|GV_NOTQUAL, SVt_PV);
4574 GvIOp(tmpgv) = (IO*)SvREFCNT_inc_simple(io);
4576 PL_stderrgv = gv_fetchpvs("STDERR", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4577 GvMULTI_on(PL_stderrgv);
4578 io = GvIOp(PL_stderrgv);
4579 IoTYPE(io) = IoTYPE_WRONLY;
4580 IoOFP(io) = IoIFP(io) = PerlIO_stderr();
4581 tmpgv = gv_fetchpvs("stderr", GV_ADD|GV_NOTQUAL, SVt_PV);
4583 GvIOp(tmpgv) = (IO*)SvREFCNT_inc_simple(io);
4585 PL_statname = newSV(0); /* last filename we did stat on */
4587 Safefree(PL_osname);
4588 PL_osname = savepv(OSNAME);
4592 Perl_init_argv_symbols(pTHX_ register int argc, register char **argv)
4595 argc--,argv++; /* skip name of script */
4596 if (PL_doswitches) {
4597 for (; argc > 0 && **argv == '-'; argc--,argv++) {
4601 if (argv[0][1] == '-' && !argv[0][2]) {
4605 if ((s = strchr(argv[0], '='))) {
4606 const char *const start_name = argv[0] + 1;
4607 sv_setpv(GvSV(gv_fetchpvn_flags(start_name, s - start_name,
4608 TRUE, SVt_PV)), s + 1);
4611 sv_setiv(GvSV(gv_fetchpv(argv[0]+1, GV_ADD, SVt_PV)),1);
4614 if ((PL_argvgv = gv_fetchpvs("ARGV", GV_ADD|GV_NOTQUAL, SVt_PVAV))) {
4615 GvMULTI_on(PL_argvgv);
4616 (void)gv_AVadd(PL_argvgv);
4617 av_clear(GvAVn(PL_argvgv));
4618 for (; argc > 0; argc--,argv++) {
4619 SV * const sv = newSVpv(argv[0],0);
4620 av_push(GvAVn(PL_argvgv),sv);
4621 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
4622 if (PL_unicode & PERL_UNICODE_ARGV_FLAG)
4625 if (PL_unicode & PERL_UNICODE_WIDESYSCALLS_FLAG) /* Sarathy? */
4626 (void)sv_utf8_decode(sv);
4632 S_init_postdump_symbols(pTHX_ register int argc, register char **argv, register char **env)
4637 PL_toptarget = newSV(0);
4638 sv_upgrade(PL_toptarget, SVt_PVFM);
4639 sv_setpvn(PL_toptarget, "", 0);
4640 PL_bodytarget = newSV(0);
4641 sv_upgrade(PL_bodytarget, SVt_PVFM);
4642 sv_setpvn(PL_bodytarget, "", 0);
4643 PL_formtarget = PL_bodytarget;
4647 init_argv_symbols(argc,argv);
4649 if ((tmpgv = gv_fetchpvs("0", GV_ADD|GV_NOTQUAL, SVt_PV))) {
4650 #ifdef MACOS_TRADITIONAL
4651 /* $0 is not majick on a Mac */
4652 sv_setpv(GvSV(tmpgv),MacPerl_MPWFileName(PL_origfilename));
4654 sv_setpv(GvSV(tmpgv),PL_origfilename);
4655 magicname("0", "0", 1);
4658 if ((PL_envgv = gv_fetchpvs("ENV", GV_ADD|GV_NOTQUAL, SVt_PVHV))) {
4660 GvMULTI_on(PL_envgv);
4661 hv = GvHVn(PL_envgv);
4662 hv_magic(hv, NULL, PERL_MAGIC_env);
4664 #ifdef USE_ENVIRON_ARRAY
4665 /* Note that if the supplied env parameter is actually a copy
4666 of the global environ then it may now point to free'd memory
4667 if the environment has been modified since. To avoid this
4668 problem we treat env==NULL as meaning 'use the default'
4673 # ifdef USE_ITHREADS
4674 && PL_curinterp == aTHX
4681 char** origenv = environ;
4684 for (; *env; env++) {
4685 if (!(s = strchr(*env,'=')) || s == *env)
4687 #if defined(MSDOS) && !defined(DJGPP)
4692 sv = newSVpv(s+1, 0);
4693 (void)hv_store(hv, *env, s - *env, sv, 0);
4696 if (origenv != environ) {
4697 /* realloc has shifted us */
4698 env = (env - origenv) + environ;
4703 #endif /* USE_ENVIRON_ARRAY */
4704 #endif /* !PERL_MICRO */
4707 if ((tmpgv = gv_fetchpvs("$", GV_ADD|GV_NOTQUAL, SVt_PV))) {
4708 SvREADONLY_off(GvSV(tmpgv));
4709 sv_setiv(GvSV(tmpgv), (IV)PerlProc_getpid());
4710 SvREADONLY_on(GvSV(tmpgv));
4712 #ifdef THREADS_HAVE_PIDS
4713 PL_ppid = (IV)getppid();
4716 /* touch @F array to prevent spurious warnings 20020415 MJD */
4718 (void) get_av("main::F", TRUE | GV_ADDMULTI);
4720 /* touch @- and @+ arrays to prevent spurious warnings 20020415 MJD */
4721 (void) get_av("main::-", TRUE | GV_ADDMULTI);
4722 (void) get_av("main::+", TRUE | GV_ADDMULTI);
4726 S_init_perllib(pTHX)
4732 s = PerlEnv_getenv("PERL5LIB");
4734 * It isn't possible to delete an environment variable with
4735 * PERL_USE_SAFE_PUTENV set unless unsetenv() is also available, so in that
4736 * case we treat PERL5LIB as undefined if it has a zero-length value.
4738 #if defined(PERL_USE_SAFE_PUTENV) && ! defined(HAS_UNSETENV)
4739 if (s && *s != '\0')
4743 incpush(s, TRUE, TRUE, TRUE, FALSE);
4745 incpush(PerlEnv_getenv("PERLLIB"), FALSE, FALSE, TRUE, FALSE);
4747 /* Treat PERL5?LIB as a possible search list logical name -- the
4748 * "natural" VMS idiom for a Unix path string. We allow each
4749 * element to be a set of |-separated directories for compatibility.
4753 if (my_trnlnm("PERL5LIB",buf,0))
4754 do { incpush(buf,TRUE,TRUE,TRUE,FALSE); } while (my_trnlnm("PERL5LIB",buf,++idx));
4756 while (my_trnlnm("PERLLIB",buf,idx++)) incpush(buf,FALSE,FALSE,TRUE,FALSE);
4760 /* Use the ~-expanded versions of APPLLIB (undocumented),
4761 ARCHLIB PRIVLIB SITEARCH SITELIB VENDORARCH and VENDORLIB