3 * Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007 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);
174 #if defined(USE_ITHREADS)
177 /* This always happens for non-ithreads */
180 PERL_SET_THX(my_perl);
184 #ifdef PERL_IMPLICIT_SYS
186 perl_alloc_using(struct IPerlMem* ipM, struct IPerlMem* ipMS,
187 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
188 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
189 struct IPerlDir* ipD, struct IPerlSock* ipS,
190 struct IPerlProc* ipP)
192 PerlInterpreter *my_perl;
193 /* Newx() needs interpreter, so call malloc() instead */
194 my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
195 S_init_tls_and_interp(my_perl);
196 Zero(my_perl, 1, PerlInterpreter);
206 INIT_TRACK_MEMPOOL(PL_memory_debug_header, my_perl);
213 =head1 Embedding Functions
215 =for apidoc perl_alloc
217 Allocates a new Perl interpreter. See L<perlembed>.
225 PerlInterpreter *my_perl;
227 /* Newx() needs interpreter, so call malloc() instead */
228 my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
230 S_init_tls_and_interp(my_perl);
231 #ifndef PERL_TRACK_MEMPOOL
232 return (PerlInterpreter *) ZeroD(my_perl, 1, PerlInterpreter);
234 Zero(my_perl, 1, PerlInterpreter);
235 INIT_TRACK_MEMPOOL(PL_memory_debug_header, my_perl);
239 #endif /* PERL_IMPLICIT_SYS */
242 =for apidoc perl_construct
244 Initializes a new Perl interpreter. See L<perlembed>.
250 perl_construct(pTHXx)
253 PERL_UNUSED_ARG(my_perl);
256 PL_perl_destruct_level = 1;
258 if (PL_perl_destruct_level > 0)
261 PL_curcop = &PL_compiling; /* needed by ckWARN, right away */
263 /* set read-only and try to insure than we wont see REFCNT==0
266 SvREADONLY_on(&PL_sv_undef);
267 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
269 sv_setpv(&PL_sv_no,PL_No);
270 /* value lookup in void context - happens to have the side effect
271 of caching the numeric forms. */
274 SvREADONLY_on(&PL_sv_no);
275 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
277 sv_setpv(&PL_sv_yes,PL_Yes);
280 SvREADONLY_on(&PL_sv_yes);
281 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
283 SvREADONLY_on(&PL_sv_placeholder);
284 SvREFCNT(&PL_sv_placeholder) = (~(U32)0)/2;
286 PL_sighandlerp = (Sighandler_t) Perl_sighandler;
287 #ifdef PERL_USES_PL_PIDSTATUS
288 PL_pidstatus = newHV();
291 PL_rs = newSVpvs("\n");
301 SET_NUMERIC_STANDARD();
303 #if defined(LOCAL_PATCH_COUNT)
304 PL_localpatches = local_patches; /* For possible -v */
307 #ifdef HAVE_INTERP_INTERN
311 PerlIO_init(aTHX); /* Hook to IO system */
313 PL_fdpid = newAV(); /* for remembering popen pids by fd */
314 PL_modglobal = newHV(); /* pointers to per-interpreter module globals */
315 PL_errors = newSVpvs("");
316 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
317 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
318 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
320 /* First entry is an array of empty elements */
321 Perl_av_create_and_push(aTHX_ &PL_regex_padav,(SV*)newAV());
322 PL_regex_pad = AvARRAY(PL_regex_padav);
324 #ifdef USE_REENTRANT_API
325 Perl_reentrant_init(aTHX);
328 /* Note that strtab is a rather special HV. Assumptions are made
329 about not iterating on it, and not adding tie magic to it.
330 It is properly deallocated in perl_destruct() */
333 HvSHAREKEYS_off(PL_strtab); /* mandatory */
334 hv_ksplit(PL_strtab, 512);
336 #if defined(__DYNAMIC__) && (defined(NeXT) || defined(__NeXT__))
337 _dyld_lookup_and_bind
338 ("__environ", (unsigned long *) &environ_pointer, NULL);
342 # ifdef USE_ENVIRON_ARRAY
343 PL_origenviron = environ;
347 /* Use sysconf(_SC_CLK_TCK) if available, if not
348 * available or if the sysconf() fails, use the HZ.
349 * BeOS has those, but returns the wrong value.
350 * The HZ if not originally defined has been by now
351 * been defined as CLK_TCK, if available. */
352 #if defined(HAS_SYSCONF) && defined(_SC_CLK_TCK) && !defined(__BEOS__)
353 PL_clocktick = sysconf(_SC_CLK_TCK);
354 if (PL_clocktick <= 0)
358 PL_stashcache = newHV();
360 PL_patchlevel = Perl_newSVpvf(aTHX_ "v%d.%d.%d", (int)PERL_REVISION,
361 (int)PERL_VERSION, (int)PERL_SUBVERSION);
364 if (!PL_mmap_page_size) {
365 #if defined(HAS_SYSCONF) && (defined(_SC_PAGESIZE) || defined(_SC_MMAP_PAGE_SIZE))
367 SETERRNO(0, SS_NORMAL);
369 PL_mmap_page_size = sysconf(_SC_PAGESIZE);
371 PL_mmap_page_size = sysconf(_SC_MMAP_PAGE_SIZE);
373 if ((long) PL_mmap_page_size < 0) {
375 SV * const error = ERRSV;
376 SvUPGRADE(error, SVt_PV);
377 Perl_croak(aTHX_ "panic: sysconf: %s", SvPV_nolen_const(error));
380 Perl_croak(aTHX_ "panic: sysconf: pagesize unknown");
384 # ifdef HAS_GETPAGESIZE
385 PL_mmap_page_size = getpagesize();
387 # if defined(I_SYS_PARAM) && defined(PAGESIZE)
388 PL_mmap_page_size = PAGESIZE; /* compiletime, bad */
392 if (PL_mmap_page_size <= 0)
393 Perl_croak(aTHX_ "panic: bad pagesize %" IVdf,
394 (IV) PL_mmap_page_size);
396 #endif /* HAS_MMAP */
398 #if defined(HAS_TIMES) && defined(PERL_NEED_TIMESBASE)
399 PL_timesbase.tms_utime = 0;
400 PL_timesbase.tms_stime = 0;
401 PL_timesbase.tms_cutime = 0;
402 PL_timesbase.tms_cstime = 0;
409 =for apidoc nothreadhook
411 Stub that provides thread hook for perl_destruct when there are
418 Perl_nothreadhook(pTHX)
424 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
426 Perl_dump_sv_child(pTHX_ SV *sv)
429 const int sock = PL_dumper_fd;
430 const int debug_fd = PerlIO_fileno(Perl_debug_log);
431 union control_un control;
434 struct cmsghdr *cmptr;
436 unsigned char buffer[256];
438 if(sock == -1 || debug_fd == -1)
441 PerlIO_flush(Perl_debug_log);
443 /* All these shenanigans are to pass a file descriptor over to our child for
444 it to dump out to. We can't let it hold open the file descriptor when it
445 forks, as the file descriptor it will dump to can turn out to be one end
446 of pipe that some other process will wait on for EOF. (So as it would
447 be open, the wait would be forever.) */
449 msg.msg_control = control.control;
450 msg.msg_controllen = sizeof(control.control);
451 /* We're a connected socket so we don't need a destination */
457 cmptr = CMSG_FIRSTHDR(&msg);
458 cmptr->cmsg_len = CMSG_LEN(sizeof(int));
459 cmptr->cmsg_level = SOL_SOCKET;
460 cmptr->cmsg_type = SCM_RIGHTS;
461 *((int *)CMSG_DATA(cmptr)) = 1;
463 vec[0].iov_base = (void*)&sv;
464 vec[0].iov_len = sizeof(sv);
465 got = sendmsg(sock, &msg, 0);
468 perror("Debug leaking scalars parent sendmsg failed");
471 if(got < sizeof(sv)) {
472 perror("Debug leaking scalars parent short sendmsg");
476 /* Return protocol is
478 unsigned char: length of location string (0 for empty)
479 unsigned char*: string (not terminated)
481 vec[0].iov_base = (void*)&returned_errno;
482 vec[0].iov_len = sizeof(returned_errno);
483 vec[1].iov_base = buffer;
486 got = readv(sock, vec, 2);
489 perror("Debug leaking scalars parent read failed");
490 PerlIO_flush(PerlIO_stderr());
493 if(got < sizeof(returned_errno) + 1) {
494 perror("Debug leaking scalars parent short read");
495 PerlIO_flush(PerlIO_stderr());
500 got = read(sock, buffer + 1, *buffer);
502 perror("Debug leaking scalars parent read 2 failed");
503 PerlIO_flush(PerlIO_stderr());
508 perror("Debug leaking scalars parent short read 2");
509 PerlIO_flush(PerlIO_stderr());
514 if (returned_errno || *buffer) {
515 Perl_warn(aTHX_ "Debug leaking scalars child failed%s%.*s with errno"
516 " %d: %s", (*buffer ? " at " : ""), (int) *buffer, buffer + 1,
517 returned_errno, strerror(returned_errno));
523 =for apidoc perl_destruct
525 Shuts down a Perl interpreter. See L<perlembed>.
534 VOL int destruct_level; /* 0=none, 1=full, 2=full with checks */
536 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
540 PERL_UNUSED_ARG(my_perl);
542 /* wait for all pseudo-forked children to finish */
543 PERL_WAIT_FOR_CHILDREN;
545 destruct_level = PL_perl_destruct_level;
548 const char * const s = PerlEnv_getenv("PERL_DESTRUCT_LEVEL");
550 const int i = atoi(s);
551 if (destruct_level < i)
557 if (PL_exit_flags & PERL_EXIT_DESTRUCT_END) {
563 if (PL_endav && !PL_minus_c)
564 call_list(PL_scopestack_ix, PL_endav);
570 /* Need to flush since END blocks can produce output */
573 if (CALL_FPTR(PL_threadhook)(aTHX)) {
574 /* Threads hook has vetoed further cleanup */
575 PL_veto_cleanup = TRUE;
579 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
580 if (destruct_level != 0) {
581 /* Fork here to create a child. Our child's job is to preserve the
582 state of scalars prior to destruction, so that we can instruct it
583 to dump any scalars that we later find have leaked.
584 There's no subtlety in this code - it assumes POSIX, and it doesn't
588 if(socketpair(AF_UNIX, SOCK_STREAM, 0, fd)) {
589 perror("Debug leaking scalars socketpair failed");
595 perror("Debug leaking scalars fork failed");
599 /* We are the child */
600 const int sock = fd[1];
601 const int debug_fd = PerlIO_fileno(Perl_debug_log);
604 /* Our success message is an integer 0, and a char 0 */
605 static const char success[sizeof(int) + 1];
609 /* We need to close all other file descriptors otherwise we end up
610 with interesting hangs, where the parent closes its end of a
611 pipe, and sits waiting for (another) child to terminate. Only
612 that child never terminates, because it never gets EOF, because
613 we also have the far end of the pipe open. We even need to
614 close the debugging fd, because sometimes it happens to be one
615 end of a pipe, and a process is waiting on the other end for
616 EOF. Normally it would be closed at some point earlier in
617 destruction, but if we happen to cause the pipe to remain open,
618 EOF never occurs, and we get an infinite hang. Hence all the
619 games to pass in a file descriptor if it's actually needed. */
621 f = sysconf(_SC_OPEN_MAX);
623 where = "sysconf failed";
634 union control_un control;
637 struct cmsghdr *cmptr;
641 msg.msg_control = control.control;
642 msg.msg_controllen = sizeof(control.control);
643 /* We're a connected socket so we don't need a source */
647 msg.msg_iovlen = sizeof(vec)/sizeof(vec[0]);
649 vec[0].iov_base = (void*)⌖
650 vec[0].iov_len = sizeof(target);
652 got = recvmsg(sock, &msg, 0);
657 where = "recv failed";
660 if(got < sizeof(target)) {
661 where = "short recv";
665 if(!(cmptr = CMSG_FIRSTHDR(&msg))) {
669 if(cmptr->cmsg_len != CMSG_LEN(sizeof(int))) {
670 where = "wrong cmsg_len";
673 if(cmptr->cmsg_level != SOL_SOCKET) {
674 where = "wrong cmsg_level";
677 if(cmptr->cmsg_type != SCM_RIGHTS) {
678 where = "wrong cmsg_type";
682 got_fd = *(int*)CMSG_DATA(cmptr);
683 /* For our last little bit of trickery, put the file descriptor
684 back into Perl_debug_log, as if we never actually closed it
686 if(got_fd != debug_fd) {
687 if (dup2(got_fd, debug_fd) == -1) {
694 PerlIO_flush(Perl_debug_log);
696 got = write(sock, &success, sizeof(success));
699 where = "write failed";
702 if(got < sizeof(success)) {
703 where = "short write";
710 int send_errno = errno;
711 unsigned char length = (unsigned char) strlen(where);
712 struct iovec failure[3] = {
713 {(void*)&send_errno, sizeof(send_errno)},
715 {(void*)where, length}
717 int got = writev(sock, failure, 3);
718 /* Bad news travels fast. Faster than data. We'll get a SIGPIPE
719 in the parent if we try to read from the socketpair after the
720 child has exited, even if there was data to read.
721 So sleep a bit to give the parent a fighting chance of
724 _exit((got == -1) ? errno : 0);
728 PL_dumper_fd = fd[0];
733 /* We must account for everything. */
735 /* Destroy the main CV and syntax tree */
736 /* Do this now, because destroying ops can cause new SVs to be generated
737 in Perl_pad_swipe, and when running with -DDEBUG_LEAKING_SCALARS they
738 PL_curcop to point to a valid op from which the filename structure
740 PL_curcop = &PL_compiling;
742 /* ensure comppad/curpad to refer to main's pad */
743 if (CvPADLIST(PL_main_cv)) {
744 PAD_SET_CUR_NOSAVE(CvPADLIST(PL_main_cv), 1);
746 op_free(PL_main_root);
749 PL_main_start = NULL;
750 SvREFCNT_dec(PL_main_cv);
754 /* Tell PerlIO we are about to tear things apart in case
755 we have layers which are using resources that should
759 PerlIO_destruct(aTHX);
761 if (PL_sv_objcount) {
763 * Try to destruct global references. We do this first so that the
764 * destructors and destructees still exist. Some sv's might remain.
765 * Non-referenced objects are on their own.
769 if (PL_defoutgv && !SvREFCNT(PL_defoutgv))
770 PL_defoutgv = NULL; /* may have been freed */
773 /* unhook hooks which will soon be, or use, destroyed data */
774 SvREFCNT_dec(PL_warnhook);
776 SvREFCNT_dec(PL_diehook);
779 /* call exit list functions */
780 while (PL_exitlistlen-- > 0)
781 PL_exitlist[PL_exitlistlen].fn(aTHX_ PL_exitlist[PL_exitlistlen].ptr);
783 Safefree(PL_exitlist);
788 /* jettison our possibly duplicated environment */
789 /* if PERL_USE_SAFE_PUTENV is defined environ will not have been copied
790 * so we certainly shouldn't free it here
793 #if defined(USE_ENVIRON_ARRAY) && !defined(PERL_USE_SAFE_PUTENV)
794 if (environ != PL_origenviron && !PL_use_safe_putenv
796 /* only main thread can free environ[0] contents */
797 && PL_curinterp == aTHX
803 for (i = 0; environ[i]; i++)
804 safesysfree(environ[i]);
806 /* Must use safesysfree() when working with environ. */
807 safesysfree(environ);
809 environ = PL_origenviron;
812 #endif /* !PERL_MICRO */
814 if (destruct_level == 0) {
816 DEBUG_P(debprofdump());
818 #if defined(PERLIO_LAYERS)
819 /* No more IO - including error messages ! */
820 PerlIO_cleanup(aTHX);
823 CopFILE_free(&PL_compiling);
824 CopSTASH_free(&PL_compiling);
826 /* The exit() function will do everything that needs doing. */
830 /* reset so print() ends up where we expect */
834 /* the syntax tree is shared between clones
835 * so op_free(PL_main_root) only ReREFCNT_dec's
836 * REGEXPs in the parent interpreter
837 * we need to manually ReREFCNT_dec for the clones
840 I32 i = AvFILLp(PL_regex_padav) + 1;
841 SV * const * const ary = AvARRAY(PL_regex_padav);
844 SV * const resv = ary[--i];
846 if (SvFLAGS(resv) & SVf_BREAK) {
847 /* this is PL_reg_curpm, already freed
848 * flag is set in regexec.c:S_regtry
850 SvFLAGS(resv) &= ~SVf_BREAK;
852 else if(SvREPADTMP(resv)) {
853 SvREPADTMP_off(resv);
855 else if(SvIOKp(resv)) {
856 REGEXP *re = INT2PTR(REGEXP *,SvIVX(resv));
861 SvREFCNT_dec(PL_regex_padav);
862 PL_regex_padav = NULL;
866 SvREFCNT_dec((SV*) PL_stashcache);
867 PL_stashcache = NULL;
869 /* loosen bonds of global variables */
871 /* XXX can PL_parser still be non-null here? */
872 if(PL_parser && PL_parser->rsfp) {
873 (void)PerlIO_close(PL_parser->rsfp);
874 PL_parser->rsfp = NULL;
878 Safefree(PL_splitstr);
883 PL_preprocess = FALSE;
889 PL_doswitches = FALSE;
890 PL_dowarn = G_WARN_OFF;
891 PL_doextract = FALSE;
892 PL_sawampersand = FALSE; /* must save all match strings */
895 Safefree(PL_inplace);
897 SvREFCNT_dec(PL_patchlevel);
900 SvREFCNT_dec(PL_e_script);
906 /* magical thingies */
908 SvREFCNT_dec(PL_ofs_sv); /* $, */
911 SvREFCNT_dec(PL_ors_sv); /* $\ */
914 SvREFCNT_dec(PL_rs); /* $/ */
917 Safefree(PL_osname); /* $^O */
920 SvREFCNT_dec(PL_statname);
924 /* defgv, aka *_ should be taken care of elsewhere */
926 /* clean up after study() */
927 SvREFCNT_dec(PL_lastscream);
928 PL_lastscream = NULL;
929 Safefree(PL_screamfirst);
931 Safefree(PL_screamnext);
935 Safefree(PL_efloatbuf);
939 /* startup and shutdown function lists */
940 SvREFCNT_dec(PL_beginav);
941 SvREFCNT_dec(PL_beginav_save);
942 SvREFCNT_dec(PL_endav);
943 SvREFCNT_dec(PL_checkav);
944 SvREFCNT_dec(PL_checkav_save);
945 SvREFCNT_dec(PL_unitcheckav);
946 SvREFCNT_dec(PL_unitcheckav_save);
947 SvREFCNT_dec(PL_initav);
949 PL_beginav_save = NULL;
952 PL_checkav_save = NULL;
953 PL_unitcheckav = NULL;
954 PL_unitcheckav_save = NULL;
957 /* shortcuts just get cleared */
966 PL_last_in_gv = NULL;
978 SvREFCNT_dec(PL_argvout_stack);
979 PL_argvout_stack = NULL;
981 SvREFCNT_dec(PL_modglobal);
983 SvREFCNT_dec(PL_preambleav);
984 PL_preambleav = NULL;
985 SvREFCNT_dec(PL_subname);
987 #ifdef PERL_USES_PL_PIDSTATUS
988 SvREFCNT_dec(PL_pidstatus);
991 SvREFCNT_dec(PL_toptarget);
993 SvREFCNT_dec(PL_bodytarget);
994 PL_bodytarget = NULL;
995 PL_formtarget = NULL;
997 /* free locale stuff */
998 #ifdef USE_LOCALE_COLLATE
999 Safefree(PL_collation_name);
1000 PL_collation_name = NULL;
1003 #ifdef USE_LOCALE_NUMERIC
1004 Safefree(PL_numeric_name);
1005 PL_numeric_name = NULL;
1006 SvREFCNT_dec(PL_numeric_radix_sv);
1007 PL_numeric_radix_sv = NULL;
1010 /* clear utf8 character classes */
1011 SvREFCNT_dec(PL_utf8_alnum);
1012 SvREFCNT_dec(PL_utf8_alnumc);
1013 SvREFCNT_dec(PL_utf8_ascii);
1014 SvREFCNT_dec(PL_utf8_alpha);
1015 SvREFCNT_dec(PL_utf8_space);
1016 SvREFCNT_dec(PL_utf8_cntrl);
1017 SvREFCNT_dec(PL_utf8_graph);
1018 SvREFCNT_dec(PL_utf8_digit);
1019 SvREFCNT_dec(PL_utf8_upper);
1020 SvREFCNT_dec(PL_utf8_lower);
1021 SvREFCNT_dec(PL_utf8_print);
1022 SvREFCNT_dec(PL_utf8_punct);
1023 SvREFCNT_dec(PL_utf8_xdigit);
1024 SvREFCNT_dec(PL_utf8_mark);
1025 SvREFCNT_dec(PL_utf8_toupper);
1026 SvREFCNT_dec(PL_utf8_totitle);
1027 SvREFCNT_dec(PL_utf8_tolower);
1028 SvREFCNT_dec(PL_utf8_tofold);
1029 SvREFCNT_dec(PL_utf8_idstart);
1030 SvREFCNT_dec(PL_utf8_idcont);
1031 PL_utf8_alnum = NULL;
1032 PL_utf8_alnumc = NULL;
1033 PL_utf8_ascii = NULL;
1034 PL_utf8_alpha = NULL;
1035 PL_utf8_space = NULL;
1036 PL_utf8_cntrl = NULL;
1037 PL_utf8_graph = NULL;
1038 PL_utf8_digit = NULL;
1039 PL_utf8_upper = NULL;
1040 PL_utf8_lower = NULL;
1041 PL_utf8_print = NULL;
1042 PL_utf8_punct = NULL;
1043 PL_utf8_xdigit = NULL;
1044 PL_utf8_mark = NULL;
1045 PL_utf8_toupper = NULL;
1046 PL_utf8_totitle = NULL;
1047 PL_utf8_tolower = NULL;
1048 PL_utf8_tofold = NULL;
1049 PL_utf8_idstart = NULL;
1050 PL_utf8_idcont = NULL;
1052 if (!specialWARN(PL_compiling.cop_warnings))
1053 PerlMemShared_free(PL_compiling.cop_warnings);
1054 PL_compiling.cop_warnings = NULL;
1055 Perl_refcounted_he_free(aTHX_ PL_compiling.cop_hints_hash);
1056 PL_compiling.cop_hints_hash = NULL;
1057 CopFILE_free(&PL_compiling);
1058 CopSTASH_free(&PL_compiling);
1060 /* Prepare to destruct main symbol table. */
1065 SvREFCNT_dec(PL_curstname);
1066 PL_curstname = NULL;
1068 /* clear queued errors */
1069 SvREFCNT_dec(PL_errors);
1072 SvREFCNT_dec(PL_isarev);
1075 if (destruct_level >= 2 && ckWARN_d(WARN_INTERNAL)) {
1076 if (PL_scopestack_ix != 0)
1077 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
1078 "Unbalanced scopes: %ld more ENTERs than LEAVEs\n",
1079 (long)PL_scopestack_ix);
1080 if (PL_savestack_ix != 0)
1081 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
1082 "Unbalanced saves: %ld more saves than restores\n",
1083 (long)PL_savestack_ix);
1084 if (PL_tmps_floor != -1)
1085 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced tmps: %ld more allocs than frees\n",
1086 (long)PL_tmps_floor + 1);
1087 if (cxstack_ix != -1)
1088 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced context: %ld more PUSHes than POPs\n",
1089 (long)cxstack_ix + 1);
1092 /* Now absolutely destruct everything, somehow or other, loops or no. */
1093 SvFLAGS(PL_fdpid) |= SVTYPEMASK; /* don't clean out pid table now */
1094 SvFLAGS(PL_strtab) |= SVTYPEMASK; /* don't clean out strtab now */
1096 /* the 2 is for PL_fdpid and PL_strtab */
1097 while (PL_sv_count > 2 && sv_clean_all())
1100 SvFLAGS(PL_fdpid) &= ~SVTYPEMASK;
1101 SvFLAGS(PL_fdpid) |= SVt_PVAV;
1102 SvFLAGS(PL_strtab) &= ~SVTYPEMASK;
1103 SvFLAGS(PL_strtab) |= SVt_PVHV;
1105 AvREAL_off(PL_fdpid); /* no surviving entries */
1106 SvREFCNT_dec(PL_fdpid); /* needed in io_close() */
1109 #ifdef HAVE_INTERP_INTERN
1113 /* Destruct the global string table. */
1115 /* Yell and reset the HeVAL() slots that are still holding refcounts,
1116 * so that sv_free() won't fail on them.
1117 * Now that the global string table is using a single hunk of memory
1118 * for both HE and HEK, we either need to explicitly unshare it the
1119 * correct way, or actually free things here.
1122 const I32 max = HvMAX(PL_strtab);
1123 HE * const * const array = HvARRAY(PL_strtab);
1124 HE *hent = array[0];
1127 if (hent && ckWARN_d(WARN_INTERNAL)) {
1128 HE * const next = HeNEXT(hent);
1129 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
1130 "Unbalanced string table refcount: (%ld) for \"%s\"",
1131 (long)hent->he_valu.hent_refcount, HeKEY(hent));
1138 hent = array[riter];
1143 HvARRAY(PL_strtab) = 0;
1144 HvTOTALKEYS(PL_strtab) = 0;
1145 HvFILL(PL_strtab) = 0;
1147 SvREFCNT_dec(PL_strtab);
1150 /* free the pointer tables used for cloning */
1151 ptr_table_free(PL_ptr_table);
1152 PL_ptr_table = (PTR_TBL_t*)NULL;
1155 /* free special SVs */
1157 SvREFCNT(&PL_sv_yes) = 0;
1158 sv_clear(&PL_sv_yes);
1159 SvANY(&PL_sv_yes) = NULL;
1160 SvFLAGS(&PL_sv_yes) = 0;
1162 SvREFCNT(&PL_sv_no) = 0;
1163 sv_clear(&PL_sv_no);
1164 SvANY(&PL_sv_no) = NULL;
1165 SvFLAGS(&PL_sv_no) = 0;
1169 for (i=0; i<=2; i++) {
1170 SvREFCNT(PERL_DEBUG_PAD(i)) = 0;
1171 sv_clear(PERL_DEBUG_PAD(i));
1172 SvANY(PERL_DEBUG_PAD(i)) = NULL;
1173 SvFLAGS(PERL_DEBUG_PAD(i)) = 0;
1177 if (PL_sv_count != 0 && ckWARN_d(WARN_INTERNAL))
1178 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Scalars leaked: %ld\n", (long)PL_sv_count);
1180 #ifdef DEBUG_LEAKING_SCALARS
1181 if (PL_sv_count != 0) {
1186 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
1187 svend = &sva[SvREFCNT(sva)];
1188 for (sv = sva + 1; sv < svend; ++sv) {
1189 if (SvTYPE(sv) != SVTYPEMASK) {
1190 PerlIO_printf(Perl_debug_log, "leaked: sv=0x%p"
1192 " refcnt=%"UVuf pTHX__FORMAT "\n"
1193 "\tallocated at %s:%d %s %s%s\n",
1194 (void*)sv, sv->sv_flags, sv->sv_refcnt pTHX__VALUE,
1195 sv->sv_debug_file ? sv->sv_debug_file : "(unknown)",
1197 sv->sv_debug_inpad ? "for" : "by",
1198 sv->sv_debug_optype ?
1199 PL_op_name[sv->sv_debug_optype]: "(none)",
1200 sv->sv_debug_cloned ? " (cloned)" : ""
1202 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1203 Perl_dump_sv_child(aTHX_ sv);
1209 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1213 /* Wait for up to 4 seconds for child to terminate.
1214 This seems to be the least effort way of timing out on reaping
1216 struct timeval waitfor = {4, 0};
1217 int sock = PL_dumper_fd;
1221 FD_SET(sock, &rset);
1222 select(sock + 1, &rset, NULL, NULL, &waitfor);
1223 waitpid(child, &status, WNOHANG);
1230 #ifdef PERL_DEBUG_READONLY_OPS
1236 #if defined(PERLIO_LAYERS)
1237 /* No more IO - including error messages ! */
1238 PerlIO_cleanup(aTHX);
1241 /* sv_undef needs to stay immortal until after PerlIO_cleanup
1242 as currently layers use it rather than NULL as a marker
1243 for no arg - and will try and SvREFCNT_dec it.
1245 SvREFCNT(&PL_sv_undef) = 0;
1246 SvREADONLY_off(&PL_sv_undef);
1248 Safefree(PL_origfilename);
1249 PL_origfilename = NULL;
1250 Safefree(PL_reg_start_tmp);
1251 PL_reg_start_tmp = (char**)NULL;
1252 PL_reg_start_tmpl = 0;
1253 Safefree(PL_reg_curpm);
1254 Safefree(PL_reg_poscache);
1255 free_tied_hv_pool();
1256 Safefree(PL_op_mask);
1257 Safefree(PL_psig_ptr);
1258 PL_psig_ptr = (SV**)NULL;
1259 Safefree(PL_psig_name);
1260 PL_psig_name = (SV**)NULL;
1261 Safefree(PL_bitcount);
1263 Safefree(PL_psig_pend);
1264 PL_psig_pend = (int*)NULL;
1267 PL_tainting = FALSE;
1268 PL_taint_warn = FALSE;
1269 PL_hints = 0; /* Reset hints. Should hints be per-interpreter ? */
1272 DEBUG_P(debprofdump());
1274 #ifdef USE_REENTRANT_API
1275 Perl_reentrant_free(aTHX);
1280 while (PL_regmatch_slab) {
1281 regmatch_slab *s = PL_regmatch_slab;
1282 PL_regmatch_slab = PL_regmatch_slab->next;
1286 /* As the absolutely last thing, free the non-arena SV for mess() */
1289 /* we know that type == SVt_PVMG */
1291 /* it could have accumulated taint magic */
1294 for (mg = SvMAGIC(PL_mess_sv); mg; mg = moremagic) {
1295 moremagic = mg->mg_moremagic;
1296 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global
1298 Safefree(mg->mg_ptr);
1302 /* we know that type >= SVt_PV */
1303 SvPV_free(PL_mess_sv);
1304 Safefree(SvANY(PL_mess_sv));
1305 Safefree(PL_mess_sv);
1312 =for apidoc perl_free
1314 Releases a Perl interpreter. See L<perlembed>.
1324 if (PL_veto_cleanup)
1327 #ifdef PERL_TRACK_MEMPOOL
1330 * Don't free thread memory if PERL_DESTRUCT_LEVEL is set to a non-zero
1331 * value as we're probably hunting memory leaks then
1333 const char * const s = PerlEnv_getenv("PERL_DESTRUCT_LEVEL");
1334 if (!s || atoi(s) == 0) {
1335 /* Emulate the PerlHost behaviour of free()ing all memory allocated in this
1336 thread at thread exit. */
1337 while(aTHXx->Imemory_debug_header.next != &(aTHXx->Imemory_debug_header))
1338 safesysfree(sTHX + (char *)(aTHXx->Imemory_debug_header.next));
1343 #if defined(WIN32) || defined(NETWARE)
1344 # if defined(PERL_IMPLICIT_SYS)
1347 void *host = nw_internal_host;
1349 void *host = w32_internal_host;
1351 PerlMem_free(aTHXx);
1353 nw_delete_internal_host(host);
1355 win32_delete_internal_host(host);
1359 PerlMem_free(aTHXx);
1362 PerlMem_free(aTHXx);
1366 #if defined(USE_ITHREADS)
1367 /* provide destructors to clean up the thread key when libperl is unloaded */
1368 #ifndef WIN32 /* handled during DLL_PROCESS_DETACH in win32/perllib.c */
1370 #if defined(__hpux) && !(defined(__ux_version) && __ux_version <= 1020) && !defined(__GNUC__)
1371 #pragma fini "perl_fini"
1372 #elif defined(__sun) && !defined(__GNUC__)
1373 #pragma fini (perl_fini)
1377 #if defined(__GNUC__)
1378 __attribute__((destructor))
1383 if (PL_curinterp && !PL_veto_cleanup)
1388 #endif /* THREADS */
1391 Perl_call_atexit(pTHX_ ATEXIT_t fn, void *ptr)
1394 Renew(PL_exitlist, PL_exitlistlen+1, PerlExitListEntry);
1395 PL_exitlist[PL_exitlistlen].fn = fn;
1396 PL_exitlist[PL_exitlistlen].ptr = ptr;
1400 #ifdef HAS_PROCSELFEXE
1401 /* This is a function so that we don't hold on to MAXPATHLEN
1402 bytes of stack longer than necessary
1405 S_procself_val(pTHX_ SV *sv, const char *arg0)
1407 char buf[MAXPATHLEN];
1408 int len = readlink(PROCSELFEXE_PATH, buf, sizeof(buf) - 1);
1410 /* On Playstation2 Linux V1.0 (kernel 2.2.1) readlink(/proc/self/exe)
1411 includes a spurious NUL which will cause $^X to fail in system
1412 or backticks (this will prevent extensions from being built and
1413 many tests from working). readlink is not meant to add a NUL.
1414 Normal readlink works fine.
1416 if (len > 0 && buf[len-1] == '\0') {
1420 /* FreeBSD's implementation is acknowledged to be imperfect, sometimes
1421 returning the text "unknown" from the readlink rather than the path
1422 to the executable (or returning an error from the readlink). Any valid
1423 path has a '/' in it somewhere, so use that to validate the result.
1424 See http://www.freebsd.org/cgi/query-pr.cgi?pr=35703
1426 if (len > 0 && memchr(buf, '/', len)) {
1427 sv_setpvn(sv,buf,len);
1433 #endif /* HAS_PROCSELFEXE */
1436 S_set_caret_X(pTHX) {
1438 GV* tmpgv = gv_fetchpvs("\030", GV_ADD|GV_NOTQUAL, SVt_PV); /* $^X */
1440 #ifdef HAS_PROCSELFEXE
1441 S_procself_val(aTHX_ GvSV(tmpgv), PL_origargv[0]);
1444 sv_setpv(GvSVn(tmpgv), os2_execname(aTHX));
1446 sv_setpv(GvSVn(tmpgv),PL_origargv[0]);
1453 =for apidoc perl_parse
1455 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
1461 perl_parse(pTHXx_ XSINIT_t xsinit, int argc, char **argv, char **env)
1468 PERL_UNUSED_ARG(my_perl);
1470 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
1473 Perl_croak(aTHX_ "suidperl is no longer needed since the kernel can now execute\n\
1474 setuid perl scripts securely.\n");
1475 #endif /* IAMSUID */
1478 #if defined(USE_HASH_SEED) || defined(USE_HASH_SEED_EXPLICIT)
1479 /* [perl #22371] Algorimic Complexity Attack on Perl 5.6.1, 5.8.0
1480 * This MUST be done before any hash stores or fetches take place.
1481 * If you set PL_rehash_seed (and assumedly also PL_rehash_seed_set)
1482 * yourself, it is your responsibility to provide a good random seed!
1483 * You can also define PERL_HASH_SEED in compile time, see hv.h. */
1484 if (!PL_rehash_seed_set)
1485 PL_rehash_seed = get_hash_seed();
1487 const char * const s = PerlEnv_getenv("PERL_HASH_SEED_DEBUG");
1489 if (s && (atoi(s) == 1))
1490 PerlIO_printf(Perl_debug_log, "HASH_SEED = %"UVuf"\n", PL_rehash_seed);
1492 #endif /* #if defined(USE_HASH_SEED) || defined(USE_HASH_SEED_EXPLICIT) */
1497 if (PL_origalen != 0) {
1498 PL_origalen = 1; /* don't use old PL_origalen if perl_parse() is called again */
1501 /* Set PL_origalen be the sum of the contiguous argv[]
1502 * elements plus the size of the env in case that it is
1503 * contiguous with the argv[]. This is used in mg.c:Perl_magic_set()
1504 * as the maximum modifiable length of $0. In the worst case
1505 * the area we are able to modify is limited to the size of
1506 * the original argv[0]. (See below for 'contiguous', though.)
1508 const char *s = NULL;
1511 ~(UV)(PTRSIZE == 4 ? 3 : PTRSIZE == 8 ? 7 : PTRSIZE == 16 ? 15 : 0);
1512 /* Do the mask check only if the args seem like aligned. */
1514 (mask < ~(UV)0) && ((PTR2UV(argv[0]) & mask) == PTR2UV(argv[0]));
1516 /* See if all the arguments are contiguous in memory. Note
1517 * that 'contiguous' is a loose term because some platforms
1518 * align the argv[] and the envp[]. If the arguments look
1519 * like non-aligned, assume that they are 'strictly' or
1520 * 'traditionally' contiguous. If the arguments look like
1521 * aligned, we just check that they are within aligned
1522 * PTRSIZE bytes. As long as no system has something bizarre
1523 * like the argv[] interleaved with some other data, we are
1524 * fine. (Did I just evoke Murphy's Law?) --jhi */
1525 if (PL_origargv && PL_origargc >= 1 && (s = PL_origargv[0])) {
1527 for (i = 1; i < PL_origargc; i++) {
1528 if ((PL_origargv[i] == s + 1
1530 || PL_origargv[i] == s + 2
1535 (PL_origargv[i] > s &&
1537 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1548 #ifndef PERL_USE_SAFE_PUTENV
1549 /* Can we grab env area too to be used as the area for $0? */
1550 if (s && PL_origenviron && !PL_use_safe_putenv) {
1551 if ((PL_origenviron[0] == s + 1)
1554 (PL_origenviron[0] > s &&
1555 PL_origenviron[0] <=
1556 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1559 #ifndef OS2 /* ENVIRON is read by the kernel too. */
1560 s = PL_origenviron[0];
1563 my_setenv("NoNe SuCh", NULL);
1564 /* Force copy of environment. */
1565 for (i = 1; PL_origenviron[i]; i++) {
1566 if (PL_origenviron[i] == s + 1
1569 (PL_origenviron[i] > s &&
1570 PL_origenviron[i] <=
1571 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1574 s = PL_origenviron[i];
1582 #endif /* !defined(PERL_USE_SAFE_PUTENV) */
1584 PL_origalen = s ? s - PL_origargv[0] + 1 : 0;
1589 /* Come here if running an undumped a.out. */
1591 PL_origfilename = savepv(argv[0]);
1592 PL_do_undump = FALSE;
1593 cxstack_ix = -1; /* start label stack again */
1595 assert (!PL_tainted);
1597 S_set_caret_X(aTHX);
1599 init_postdump_symbols(argc,argv,env);
1604 op_free(PL_main_root);
1605 PL_main_root = NULL;
1607 PL_main_start = NULL;
1608 SvREFCNT_dec(PL_main_cv);
1612 oldscope = PL_scopestack_ix;
1613 PL_dowarn = G_WARN_OFF;
1618 parse_body(env,xsinit);
1620 call_list(oldscope, PL_unitcheckav);
1622 call_list(oldscope, PL_checkav);
1629 /* my_exit() was called */
1630 while (PL_scopestack_ix > oldscope)
1633 PL_curstash = PL_defstash;
1635 call_list(oldscope, PL_unitcheckav);
1637 call_list(oldscope, PL_checkav);
1641 PerlIO_printf(Perl_error_log, "panic: top_env\n");
1650 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;
1665 SV *linestr_sv = newSV_type(SVt_PVIV);
1666 bool add_read_e_script = FALSE;
1668 SvGROW(linestr_sv, 80);
1669 sv_setpvn(linestr_sv,"",0);
1671 sv = newSVpvs(""); /* first used for -I flags */
1675 for (argc--,argv++; argc > 0; argc--,argv++) {
1676 if (argv[0][0] != '-' || !argv[0][1])
1680 validarg = " PHOOEY ";
1684 * Can we rely on the kernel to start scripts with argv[1] set to
1685 * contain all #! line switches (the whole line)? (argv[0] is set to
1686 * the interpreter name, argv[2] to the script name; argv[3] and
1687 * above may contain other arguments.)
1694 #ifndef PERL_STRICT_CR
1718 if ((s = moreswitches(s)))
1723 CHECK_MALLOC_TOO_LATE_FOR('t');
1724 if( !PL_tainting ) {
1725 PL_taint_warn = TRUE;
1731 CHECK_MALLOC_TOO_LATE_FOR('T');
1733 PL_taint_warn = FALSE;
1741 #ifdef MACOS_TRADITIONAL
1742 /* ignore -e for Dev:Pseudo argument */
1743 if (argv[1] && !strcmp(argv[1], "Dev:Pseudo"))
1746 forbid_setid('e', -1);
1748 PL_e_script = newSVpvs("");
1749 add_read_e_script = TRUE;
1752 sv_catpv(PL_e_script, s);
1754 sv_catpv(PL_e_script, argv[1]);
1758 Perl_croak(aTHX_ "No code specified for -%c", c);
1759 sv_catpvs(PL_e_script, "\n");
1763 #ifdef USE_SITECUSTOMIZE
1769 case 'I': /* -I handled both here and in moreswitches() */
1770 forbid_setid('I', -1);
1771 if (!*++s && (s=argv[1]) != NULL) {
1775 STRLEN len = strlen(s);
1776 const char * const p = savepvn(s, len);
1777 incpush(p, TRUE, TRUE, FALSE, FALSE);
1778 sv_catpvs(sv, "-I");
1779 sv_catpvn(sv, p, len);
1784 Perl_croak(aTHX_ "No directory specified for -I");
1787 forbid_setid('P', -1);
1788 PL_preprocess = TRUE;
1792 forbid_setid('S', -1);
1800 Perl_av_create_and_push(aTHX_ &PL_preambleav, 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_DEBUG_READONLY_OPS
1835 " PERL_DEBUG_READONLY_OPS"
1837 # ifdef PERL_DONT_CREATE_GVSV
1838 " PERL_DONT_CREATE_GVSV"
1840 # ifdef PERL_GLOBAL_STRUCT
1841 " PERL_GLOBAL_STRUCT"
1843 # ifdef PERL_IMPLICIT_CONTEXT
1844 " PERL_IMPLICIT_CONTEXT"
1846 # ifdef PERL_IMPLICIT_SYS
1847 " PERL_IMPLICIT_SYS"
1852 # ifdef PERL_MALLOC_WRAP
1855 # ifdef PERL_MEM_LOG
1858 # ifdef PERL_MEM_LOG_ENV
1861 # ifdef PERL_MEM_LOG_ENV_FD
1862 " PERL_MEM_LOG_ENV_FD"
1864 # ifdef PERL_MEM_LOG_STDERR
1865 " PERL_MEM_LOG_STDERR"
1867 # ifdef PERL_MEM_LOG_TIMESTAMP
1868 " PERL_MEM_LOG_TIMESTAMP"
1870 # ifdef PERL_NEED_APPCTX
1873 # ifdef PERL_NEED_TIMESBASE
1874 " PERL_NEED_TIMESBASE"
1876 # ifdef PERL_OLD_COPY_ON_WRITE
1877 " PERL_OLD_COPY_ON_WRITE"
1882 # ifdef PERL_TRACK_MEMPOOL
1883 " PERL_TRACK_MEMPOOL"
1885 # ifdef PERL_USE_SAFE_PUTENV
1886 " PERL_USE_SAFE_PUTENV"
1888 # ifdef PERL_USES_PL_PIDSTATUS
1889 " PERL_USES_PL_PIDSTATUS"
1891 # ifdef PL_OP_SLAB_ALLOC
1894 # ifdef THREADS_HAVE_PIDS
1895 " THREADS_HAVE_PIDS"
1897 # ifdef USE_64_BIT_ALL
1900 # ifdef USE_64_BIT_INT
1903 # ifdef USE_ITHREADS
1906 # ifdef USE_LARGE_FILES
1909 # ifdef USE_LONG_DOUBLE
1915 # ifdef USE_REENTRANT_API
1916 " USE_REENTRANT_API"
1921 # ifdef USE_SITECUSTOMIZE
1922 " USE_SITECUSTOMIZE"
1929 while (SvCUR(opts_prog) > opts+76) {
1930 /* find last space after "options: " and before col 76
1934 char * const pv = SvPV_nolen(opts_prog);
1935 const char c = pv[opts+76];
1937 space = strrchr(pv+opts+26, ' ');
1939 if (!space) break; /* "Can't happen" */
1941 /* break the line before that space */
1944 Perl_sv_insert(aTHX_ opts_prog, opts, 0,
1945 STR_WITH_LEN("\\n "));
1948 sv_catpvs(opts_prog,"\\n\",");
1950 #if defined(LOCAL_PATCH_COUNT)
1951 if (LOCAL_PATCH_COUNT > 0) {
1953 sv_catpvs(opts_prog,
1954 "\" Locally applied patches:\\n\",");
1955 for (i = 1; i <= LOCAL_PATCH_COUNT; i++) {
1956 if (PL_localpatches[i])
1957 Perl_sv_catpvf(aTHX_ opts_prog,"q%c\t%s\n%c,",
1958 0, PL_localpatches[i], 0);
1962 Perl_sv_catpvf(aTHX_ opts_prog,
1963 "\" Built under %s\\n\"",OSNAME);
1966 Perl_sv_catpvf(aTHX_ opts_prog,
1967 ",\" Compiled at %s %s\\n\"",__DATE__,
1970 Perl_sv_catpvf(aTHX_ opts_prog,",\" Compiled on %s\\n\"",
1974 sv_catpvs(opts_prog, "; $\"=\"\\n \"; "
1975 "@env = map { \"$_=\\\"$ENV{$_}\\\"\" } "
1976 "sort grep {/^PERL/} keys %ENV; ");
1978 sv_catpvs(opts_prog,
1979 "push @env, \"CYGWIN=\\\"$ENV{CYGWIN}\\\"\";");
1981 sv_catpvs(opts_prog,
1982 "print \" \\%ENV:\\n @env\\n\" if @env;"
1983 "print \" \\@INC:\\n @INC\\n\";");
1987 opts_prog = Perl_newSVpvf(aTHX_
1988 "Config::config_vars(qw%c%s%c)",
1992 av_push(PL_preambleav, opts_prog);
1993 /* don't look for script or read stdin */
1994 scriptname = BIT_BUCKET;
1998 PL_doextract = TRUE;
2006 if (!*++s || isSPACE(*s)) {
2010 /* catch use of gnu style long options */
2011 if (strEQ(s, "version")) {
2015 if (strEQ(s, "help")) {
2022 Perl_croak(aTHX_ "Unrecognized switch: -%s (-h will show valid options)",s);
2028 #ifndef SECURE_INTERNAL_GETENV
2031 (s = PerlEnv_getenv("PERL5OPT")))
2033 const char *popt = s;
2036 if (*s == '-' && *(s+1) == 'T') {
2037 CHECK_MALLOC_TOO_LATE_FOR('T');
2039 PL_taint_warn = FALSE;
2042 char *popt_copy = NULL;
2055 if (!strchr("CDIMUdmtwA", *s))
2056 Perl_croak(aTHX_ "Illegal switch in PERL5OPT: -%c", *s);
2060 popt_copy = SvPVX(sv_2mortal(newSVpv(popt,0)));
2061 s = popt_copy + (s - popt);
2062 d = popt_copy + (d - popt);
2069 if( !PL_tainting ) {
2070 PL_taint_warn = TRUE;
2080 #ifdef USE_SITECUSTOMIZE
2082 (void)Perl_av_create_and_unshift_one(aTHX_ &PL_preambleav,
2083 Perl_newSVpvf(aTHX_ "BEGIN { do '%s/sitecustomize.pl' }", SITELIB_EXP));
2088 scriptname = argv[0];
2091 scriptname = BIT_BUCKET; /* don't look for script or read stdin */
2093 else if (scriptname == NULL) {
2095 if ( PerlLIO_isatty(PerlIO_fileno(PerlIO_stdin())) )
2101 /* Set $^X early so that it can be used for relocatable paths in @INC */
2102 assert (!PL_tainted);
2104 S_set_caret_X(aTHX);
2111 = open_script(scriptname, dosearch, sv, &suidscript, &rsfp);
2113 validate_suid(validarg, scriptname, fdscript, suidscript,
2117 # if defined(SIGCHLD) || defined(SIGCLD)
2120 # define SIGCHLD SIGCLD
2122 Sighandler_t sigstate = rsignal_state(SIGCHLD);
2123 if (sigstate == (Sighandler_t) SIG_IGN) {
2124 if (ckWARN(WARN_SIGNAL))
2125 Perl_warner(aTHX_ packWARN(WARN_SIGNAL),
2126 "Can't ignore signal CHLD, forcing to default");
2127 (void)rsignal(SIGCHLD, (Sighandler_t)SIG_DFL);
2134 #ifdef MACOS_TRADITIONAL
2135 || gMacPerl_AlwaysExtract
2139 /* This will croak if suidscript is >= 0, as -x cannot be used with
2141 forbid_setid('x', suidscript);
2142 /* Hence you can't get here if suidscript >= 0 */
2144 find_beginning(linestr_sv, rsfp);
2145 if (cddir && PerlDir_chdir( (char *)cddir ) < 0)
2146 Perl_croak(aTHX_ "Can't chdir to %s",cddir);
2150 PL_main_cv = PL_compcv = (CV*)newSV_type(SVt_PVCV);
2151 CvUNIQUE_on(PL_compcv);
2153 CvPADLIST(PL_compcv) = pad_new(0);
2155 PL_isarev = newHV();
2158 boot_core_UNIVERSAL();
2159 boot_core_xsutils();
2163 (*xsinit)(aTHX); /* in case linked C routines want magical variables */
2165 #if defined(VMS) || defined(WIN32) || defined(DJGPP) || defined(__CYGWIN__) || defined(EPOC) || defined(SYMBIAN)
2171 # ifdef HAS_SOCKS5_INIT
2172 socks5_init(argv[0]);
2178 init_predump_symbols();
2179 /* init_postdump_symbols not currently designed to be called */
2180 /* more than once (ENV isn't cleared first, for example) */
2181 /* But running with -u leaves %ENV & @ARGV undefined! XXX */
2183 init_postdump_symbols(argc,argv,env);
2185 /* PL_unicode is turned on by -C, or by $ENV{PERL_UNICODE},
2186 * or explicitly in some platforms.
2187 * locale.c:Perl_init_i18nl10n() if the environment
2188 * look like the user wants to use UTF-8. */
2189 #if defined(__SYMBIAN32__)
2190 PL_unicode = PERL_UNICODE_STD_FLAG; /* See PERL_SYMBIAN_CONSOLE_UTF8. */
2193 /* Requires init_predump_symbols(). */
2194 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
2199 /* Turn on UTF-8-ness on STDIN, STDOUT, STDERR
2200 * and the default open disciplines. */
2201 if ((PL_unicode & PERL_UNICODE_STDIN_FLAG) &&
2202 PL_stdingv && (io = GvIO(PL_stdingv)) &&
2204 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2205 if ((PL_unicode & PERL_UNICODE_STDOUT_FLAG) &&
2206 PL_defoutgv && (io = GvIO(PL_defoutgv)) &&
2208 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2209 if ((PL_unicode & PERL_UNICODE_STDERR_FLAG) &&
2210 PL_stderrgv && (io = GvIO(PL_stderrgv)) &&
2212 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2213 if ((PL_unicode & PERL_UNICODE_INOUT_FLAG) &&
2214 (sv = GvSV(gv_fetchpvs("\017PEN", GV_ADD|GV_NOTQUAL,
2216 U32 in = PL_unicode & PERL_UNICODE_IN_FLAG;
2217 U32 out = PL_unicode & PERL_UNICODE_OUT_FLAG;
2220 sv_setpvn(sv, ":utf8\0:utf8", 11);
2222 sv_setpvn(sv, ":utf8\0", 6);
2225 sv_setpvn(sv, "\0:utf8", 6);
2231 if ((s = PerlEnv_getenv("PERL_SIGNALS"))) {
2232 if (strEQ(s, "unsafe"))
2233 PL_signals |= PERL_SIGNALS_UNSAFE_FLAG;
2234 else if (strEQ(s, "safe"))
2235 PL_signals &= ~PERL_SIGNALS_UNSAFE_FLAG;
2237 Perl_croak(aTHX_ "PERL_SIGNALS illegal: \"%s\"", s);
2241 if ((s = PerlEnv_getenv("PERL_XMLDUMP"))) {
2245 PL_xmlfp = PerlIO_stdout();
2247 PL_xmlfp = PerlIO_open(s, "w");
2249 Perl_croak(aTHX_ "Can't open %s", s);
2251 my_setenv("PERL_XMLDUMP", Nullch); /* hide from subprocs */
2253 if ((s = PerlEnv_getenv("PERL_MADSKILLS"))) {
2254 PL_madskills = atoi(s);
2255 my_setenv("PERL_MADSKILLS", Nullch); /* hide from subprocs */
2259 lex_start(linestr_sv, rsfp, TRUE);
2260 PL_subname = newSVpvs("main");
2262 if (add_read_e_script)
2263 filter_add(read_e_script, NULL);
2265 /* now parse the script */
2267 SETERRNO(0,SS_NORMAL);
2268 #ifdef MACOS_TRADITIONAL
2269 if (gMacPerl_SyntaxError = (yyparse() || PL_parser->error_count)) {
2271 Perl_croak(aTHX_ "%s had compilation errors.\n", MacPerl_MPWFileName(PL_origfilename));
2273 Perl_croak(aTHX_ "Execution of %s aborted due to compilation errors.\n",
2274 MacPerl_MPWFileName(PL_origfilename));
2278 if (yyparse() || PL_parser->error_count) {
2280 Perl_croak(aTHX_ "%s had compilation errors.\n", PL_origfilename);
2282 Perl_croak(aTHX_ "Execution of %s aborted due to compilation errors.\n",
2287 CopLINE_set(PL_curcop, 0);
2288 PL_curstash = PL_defstash;
2289 PL_preprocess = FALSE;
2291 SvREFCNT_dec(PL_e_script);
2299 SAVECOPFILE(PL_curcop);
2300 SAVECOPLINE(PL_curcop);
2301 gv_check(PL_defstash);
2308 if ((s=PerlEnv_getenv("PERL_DEBUG_MSTATS")) && atoi(s) >= 2)
2309 dump_mstats("after compilation:");
2318 =for apidoc perl_run
2320 Tells a Perl interpreter to run. See L<perlembed>.
2333 PERL_UNUSED_ARG(my_perl);
2335 oldscope = PL_scopestack_ix;
2343 cxstack_ix = -1; /* start context stack again */
2345 case 0: /* normal completion */
2349 case 2: /* my_exit() */
2350 while (PL_scopestack_ix > oldscope)
2353 PL_curstash = PL_defstash;
2354 if (!(PL_exit_flags & PERL_EXIT_DESTRUCT_END) &&
2355 PL_endav && !PL_minus_c)
2356 call_list(oldscope, PL_endav);
2358 if (PerlEnv_getenv("PERL_DEBUG_MSTATS"))
2359 dump_mstats("after execution: ");
2365 POPSTACK_TO(PL_mainstack);
2368 PerlIO_printf(Perl_error_log, "panic: restartop\n");
2379 S_run_body(pTHX_ I32 oldscope)
2382 DEBUG_r(PerlIO_printf(Perl_debug_log, "%s $` $& $' support.\n",
2383 PL_sawampersand ? "Enabling" : "Omitting"));
2385 if (!PL_restartop) {
2389 exit(0); /* less likely to core dump than my_exit(0) */
2392 DEBUG_x(dump_all());
2395 PERL_DEBUG(PerlIO_printf(Perl_debug_log, "\nEXECUTING...\n\n"));
2397 DEBUG_S(PerlIO_printf(Perl_debug_log, "main thread is 0x%"UVxf"\n",
2401 #ifdef MACOS_TRADITIONAL
2402 PerlIO_printf(Perl_error_log, "%s%s syntax OK\n",
2403 (gMacPerl_ErrorFormat ? "# " : ""),
2404 MacPerl_MPWFileName(PL_origfilename));
2406 PerlIO_printf(Perl_error_log, "%s syntax OK\n", PL_origfilename);
2410 if (PERLDB_SINGLE && PL_DBsingle)
2411 sv_setiv(PL_DBsingle, 1);
2413 call_list(oldscope, PL_initav);
2414 #ifdef PERL_DEBUG_READONLY_OPS
2415 Perl_pending_Slabs_to_ro(aTHX);
2422 PL_op = PL_restartop;
2426 else if (PL_main_start) {
2427 CvDEPTH(PL_main_cv) = 1;
2428 PL_op = PL_main_start;
2436 =head1 SV Manipulation Functions
2438 =for apidoc p||get_sv
2440 Returns the SV of the specified Perl scalar. 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_sv(pTHX_ const char *name, I32 create)
2451 gv = gv_fetchpv(name, create, SVt_PV);
2458 =head1 Array Manipulation Functions
2460 =for apidoc p||get_av
2462 Returns the AV of the specified Perl array. If C<create> is set and the
2463 Perl variable does not exist then it will be created. If C<create> is not
2464 set and the variable does not exist then NULL is returned.
2470 Perl_get_av(pTHX_ const char *name, I32 create)
2472 GV* const gv = gv_fetchpv(name, create, SVt_PVAV);
2481 =head1 Hash Manipulation Functions
2483 =for apidoc p||get_hv
2485 Returns the HV of the specified Perl hash. If C<create> is set and the
2486 Perl variable does not exist then it will be created. If C<create> is not
2487 set and the variable does not exist then NULL is returned.
2493 Perl_get_hv(pTHX_ const char *name, I32 create)
2495 GV* const gv = gv_fetchpv(name, create, SVt_PVHV);
2504 =head1 CV Manipulation Functions
2506 =for apidoc p||get_cvn_flags
2508 Returns the CV of the specified Perl subroutine. C<flags> are passed to
2509 C<gv_fetchpvn_flags>. If C<GV_ADD> is set and the Perl subroutine does not
2510 exist then it will be declared (which has the same effect as saying
2511 C<sub name;>). If C<GV_ADD> is not set and the subroutine does not exist
2512 then NULL is returned.
2514 =for apidoc p||get_cv
2516 Uses C<strlen> to get the length of C<name>, then calls C<get_cvn_flags>.
2522 Perl_get_cvn_flags(pTHX_ const char *name, STRLEN len, I32 flags)
2524 GV* const gv = gv_fetchpvn_flags(name, len, flags, SVt_PVCV);
2525 /* XXX this is probably not what they think they're getting.
2526 * It has the same effect as "sub name;", i.e. just a forward
2528 if ((flags & ~GV_NOADD_MASK) && !GvCVu(gv)) {
2529 SV *const sv = newSVpvn(name,len);
2530 SvFLAGS(sv) |= flags & SVf_UTF8;
2531 return newSUB(start_subparse(FALSE, 0),
2532 newSVOP(OP_CONST, 0, sv),
2541 Perl_get_cv(pTHX_ const char *name, I32 flags)
2543 return get_cvn_flags(name, strlen(name), flags);
2546 /* Be sure to refetch the stack pointer after calling these routines. */
2550 =head1 Callback Functions
2552 =for apidoc p||call_argv
2554 Performs a callback to the specified Perl sub. See L<perlcall>.
2560 Perl_call_argv(pTHX_ const char *sub_name, I32 flags, register char **argv)
2562 /* See G_* flags in cop.h */
2563 /* null terminated arg list */
2571 XPUSHs(sv_2mortal(newSVpv(*argv,0)));
2576 return call_pv(sub_name, flags);
2580 =for apidoc p||call_pv
2582 Performs a callback to the specified Perl sub. See L<perlcall>.
2588 Perl_call_pv(pTHX_ const char *sub_name, I32 flags)
2589 /* name of the subroutine */
2590 /* See G_* flags in cop.h */
2592 return call_sv((SV*)get_cv(sub_name, TRUE), flags);
2596 =for apidoc p||call_method
2598 Performs a callback to the specified Perl method. The blessed object must
2599 be on the stack. See L<perlcall>.
2605 Perl_call_method(pTHX_ const char *methname, I32 flags)
2606 /* name of the subroutine */
2607 /* See G_* flags in cop.h */
2609 return call_sv(sv_2mortal(newSVpv(methname,0)), flags | G_METHOD);
2612 /* May be called with any of a CV, a GV, or an SV containing the name. */
2614 =for apidoc p||call_sv
2616 Performs a callback to the Perl sub whose name is in the SV. See
2623 Perl_call_sv(pTHX_ SV *sv, I32 flags)
2624 /* See G_* flags in cop.h */
2627 LOGOP myop; /* fake syntax tree node */
2632 bool oldcatch = CATCH_GET;
2634 OP* const oldop = PL_op;
2637 if (flags & G_DISCARD) {
2642 Zero(&myop, 1, LOGOP);
2643 myop.op_next = NULL;
2644 if (!(flags & G_NOARGS))
2645 myop.op_flags |= OPf_STACKED;
2646 myop.op_flags |= ((flags & G_VOID) ? OPf_WANT_VOID :
2647 (flags & G_ARRAY) ? OPf_WANT_LIST :
2652 EXTEND(PL_stack_sp, 1);
2653 *++PL_stack_sp = sv;
2655 oldscope = PL_scopestack_ix;
2657 if (PERLDB_SUB && PL_curstash != PL_debstash
2658 /* Handle first BEGIN of -d. */
2659 && (PL_DBcv || (PL_DBcv = GvCV(PL_DBsub)))
2660 /* Try harder, since this may have been a sighandler, thus
2661 * curstash may be meaningless. */
2662 && (SvTYPE(sv) != SVt_PVCV || CvSTASH((CV*)sv) != PL_debstash)
2663 && !(flags & G_NODEBUG))
2664 PL_op->op_private |= OPpENTERSUB_DB;
2666 if (flags & G_METHOD) {
2667 Zero(&method_op, 1, UNOP);
2668 method_op.op_next = PL_op;
2669 method_op.op_ppaddr = PL_ppaddr[OP_METHOD];
2670 myop.op_ppaddr = PL_ppaddr[OP_ENTERSUB];
2671 PL_op = (OP*)&method_op;
2674 if (!(flags & G_EVAL)) {
2676 CALL_BODY_SUB((OP*)&myop);
2677 retval = PL_stack_sp - (PL_stack_base + oldmark);
2678 CATCH_SET(oldcatch);
2681 myop.op_other = (OP*)&myop;
2683 create_eval_scope(flags|G_FAKINGEVAL);
2691 CALL_BODY_SUB((OP*)&myop);
2692 retval = PL_stack_sp - (PL_stack_base + oldmark);
2693 if (!(flags & G_KEEPERR))
2694 sv_setpvn(ERRSV,"",0);
2700 /* my_exit() was called */
2701 PL_curstash = PL_defstash;
2704 if (PL_statusvalue && !(PL_exit_flags & PERL_EXIT_EXPECTED))
2705 Perl_croak(aTHX_ "Callback called exit");
2710 PL_op = PL_restartop;
2714 PL_stack_sp = PL_stack_base + oldmark;
2715 if (flags & G_ARRAY)
2719 *++PL_stack_sp = &PL_sv_undef;
2724 if (PL_scopestack_ix > oldscope)
2725 delete_eval_scope();
2729 if (flags & G_DISCARD) {
2730 PL_stack_sp = PL_stack_base + oldmark;
2739 /* Eval a string. The G_EVAL flag is always assumed. */
2742 =for apidoc p||eval_sv
2744 Tells Perl to C<eval> the string in the SV.
2750 Perl_eval_sv(pTHX_ SV *sv, I32 flags)
2752 /* See G_* flags in cop.h */
2756 UNOP myop; /* fake syntax tree node */
2757 VOL I32 oldmark = SP - PL_stack_base;
2760 OP* const oldop = PL_op;
2763 if (flags & G_DISCARD) {
2770 Zero(PL_op, 1, UNOP);
2771 EXTEND(PL_stack_sp, 1);
2772 *++PL_stack_sp = sv;
2774 if (!(flags & G_NOARGS))
2775 myop.op_flags = OPf_STACKED;
2776 myop.op_next = NULL;
2777 myop.op_type = OP_ENTEREVAL;
2778 myop.op_flags |= ((flags & G_VOID) ? OPf_WANT_VOID :
2779 (flags & G_ARRAY) ? OPf_WANT_LIST :
2781 if (flags & G_KEEPERR)
2782 myop.op_flags |= OPf_SPECIAL;
2784 /* fail now; otherwise we could fail after the JMPENV_PUSH but
2785 * before a PUSHEVAL, which corrupts the stack after a croak */
2786 TAINT_PROPER("eval_sv()");
2792 CALL_BODY_EVAL((OP*)&myop);
2793 retval = PL_stack_sp - (PL_stack_base + oldmark);
2794 if (!(flags & G_KEEPERR))
2795 sv_setpvn(ERRSV,"",0);
2801 /* my_exit() was called */
2802 PL_curstash = PL_defstash;
2805 if (PL_statusvalue && !(PL_exit_flags & PERL_EXIT_EXPECTED))
2806 Perl_croak(aTHX_ "Callback called exit");
2811 PL_op = PL_restartop;
2815 PL_stack_sp = PL_stack_base + oldmark;
2816 if (flags & G_ARRAY)
2820 *++PL_stack_sp = &PL_sv_undef;
2826 if (flags & G_DISCARD) {
2827 PL_stack_sp = PL_stack_base + oldmark;
2837 =for apidoc p||eval_pv
2839 Tells Perl to C<eval> the given string and return an SV* result.
2845 Perl_eval_pv(pTHX_ const char *p, I32 croak_on_error)
2849 SV* sv = newSVpv(p, 0);
2851 eval_sv(sv, G_SCALAR);
2858 if (croak_on_error && SvTRUE(ERRSV)) {
2859 Perl_croak(aTHX_ SvPVx_nolen_const(ERRSV));
2865 /* Require a module. */
2868 =head1 Embedding Functions
2870 =for apidoc p||require_pv
2872 Tells Perl to C<require> the file named by the string argument. It is
2873 analogous to the Perl code C<eval "require '$file'">. It's even
2874 implemented that way; consider using load_module instead.
2879 Perl_require_pv(pTHX_ const char *pv)
2884 PUSHSTACKi(PERLSI_REQUIRE);
2886 sv = Perl_newSVpvf(aTHX_ "require q%c%s%c", 0, pv, 0);
2887 eval_sv(sv_2mortal(sv), G_DISCARD);
2893 Perl_magicname(pTHX_ const char *sym, const char *name, I32 namlen)
2895 register GV * const gv = gv_fetchpv(sym, GV_ADD, SVt_PV);
2898 sv_magic(GvSV(gv), (SV*)gv, PERL_MAGIC_sv, name, namlen);
2902 S_usage(pTHX_ const char *name) /* XXX move this out into a module ? */
2904 /* This message really ought to be max 23 lines.
2905 * Removed -h because the user already knows that option. Others? */
2907 static const char * const usage_msg[] = {
2908 "-0[octal] specify record separator (\\0, if no argument)",
2909 "-a autosplit mode with -n or -p (splits $_ into @F)",
2910 "-C[number/list] enables the listed Unicode features",
2911 "-c check syntax only (runs BEGIN and CHECK blocks)",
2912 "-d[:debugger] run program under debugger",
2913 "-D[number/list] set debugging flags (argument is a bit mask or alphabets)",
2914 "-e program one line of program (several -e's allowed, omit programfile)",
2915 "-E program like -e, but enables all optional features",
2916 "-f don't do $sitelib/sitecustomize.pl at startup",
2917 "-F/pattern/ split() pattern for -a switch (//'s are optional)",
2918 "-i[extension] edit <> files in place (makes backup if extension supplied)",
2919 "-Idirectory specify @INC/#include directory (several -I's allowed)",
2920 "-l[octal] enable line ending processing, specifies line terminator",
2921 "-[mM][-]module execute \"use/no module...\" before executing program",
2922 "-n assume \"while (<>) { ... }\" loop around program",
2923 "-p assume loop like -n but print line also, like sed",
2924 "-P run program through C preprocessor before compilation",
2925 "-s enable rudimentary parsing for switches after programfile",
2926 "-S look for programfile using PATH environment variable",
2927 "-t enable tainting warnings",
2928 "-T enable tainting checks",
2929 "-u dump core after parsing program",
2930 "-U allow unsafe operations",
2931 "-v print version, subversion (includes VERY IMPORTANT perl info)",
2932 "-V[:variable] print configuration summary (or a single Config.pm variable)",
2933 "-w enable many useful warnings (RECOMMENDED)",
2934 "-W enable all warnings",
2935 "-x[directory] strip off text before #!perl line and perhaps cd to directory",
2936 "-X disable all warnings",
2940 const char * const *p = usage_msg;
2942 PerlIO_printf(PerlIO_stdout(),
2943 "\nUsage: %s [switches] [--] [programfile] [arguments]",
2946 PerlIO_printf(PerlIO_stdout(), "\n %s", *p++);
2949 /* convert a string of -D options (or digits) into an int.
2950 * sets *s to point to the char after the options */
2954 Perl_get_debug_opts(pTHX_ const char **s, bool givehelp)
2956 static const char * const usage_msgd[] = {
2957 " Debugging flag values: (see also -d)",
2958 " p Tokenizing and parsing (with v, displays parse stack)",
2959 " s Stack snapshots (with v, displays all stacks)",
2960 " l Context (loop) stack processing",
2961 " t Trace execution",
2962 " o Method and overloading resolution",
2963 " c String/numeric conversions",
2964 " P Print profiling info, preprocessor command for -P, source file input state",
2965 " m Memory allocation",
2966 " f Format processing",
2967 " r Regular expression parsing and execution",
2968 " x Syntax tree dump",
2969 " u Tainting checks",
2970 " H Hash dump -- usurps values()",
2971 " X Scratchpad allocation",
2973 " S Thread synchronization",
2975 " R Include reference counts of dumped variables (eg when using -Ds)",
2976 " J Do not s,t,P-debug (Jump over) opcodes within package DB",
2977 " v Verbose: use in conjunction with other flags",
2979 " A Consistency checks on internal structures",
2980 " q quiet - currently only suppresses the 'EXECUTING' message",
2985 /* if adding extra options, remember to update DEBUG_MASK */
2986 static const char debopts[] = "psltocPmfrxuUHXDSTRJvCAq";
2988 for (; isALNUM(**s); (*s)++) {
2989 const char * const d = strchr(debopts,**s);
2991 i |= 1 << (d - debopts);
2992 else if (ckWARN_d(WARN_DEBUGGING))
2993 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
2994 "invalid option -D%c, use -D'' to see choices\n", **s);
2997 else if (isDIGIT(**s)) {
2999 for (; isALNUM(**s); (*s)++) ;
3001 else if (givehelp) {
3002 const char *const *p = usage_msgd;
3003 while (*p) PerlIO_printf(PerlIO_stdout(), "%s\n", *p++);
3006 if ((i & DEBUG_p_FLAG) && ckWARN_d(WARN_DEBUGGING))
3007 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3008 "-Dp not implemented on this platform\n");
3014 /* This routine handles any switches that can be given during run */
3017 Perl_moreswitches(pTHX_ char *s)
3028 SvREFCNT_dec(PL_rs);
3029 if (s[1] == 'x' && s[2]) {
3030 const char *e = s+=2;
3036 flags = PERL_SCAN_SILENT_ILLDIGIT;
3037 rschar = (U32)grok_hex(s, &numlen, &flags, NULL);
3038 if (s + numlen < e) {
3039 rschar = 0; /* Grandfather -0xFOO as -0 -xFOO. */
3043 PL_rs = newSVpvs("");
3044 SvGROW(PL_rs, (STRLEN)(UNISKIP(rschar) + 1));
3045 tmps = (U8*)SvPVX(PL_rs);
3046 uvchr_to_utf8(tmps, rschar);
3047 SvCUR_set(PL_rs, UNISKIP(rschar));
3052 rschar = (U32)grok_oct(s, &numlen, &flags, NULL);
3053 if (rschar & ~((U8)~0))
3054 PL_rs = &PL_sv_undef;
3055 else if (!rschar && numlen >= 2)
3056 PL_rs = newSVpvs("");
3058 char ch = (char)rschar;
3059 PL_rs = newSVpvn(&ch, 1);
3062 sv_setsv(get_sv("/", TRUE), PL_rs);
3067 PL_unicode = parse_unicode_opts( (const char **)&s );
3068 if (PL_unicode & PERL_UNICODE_UTF8CACHEASSERT_FLAG)
3074 while (*s && !isSPACE(*s)) ++s;
3075 PL_splitstr = savepvn(PL_splitstr, s - PL_splitstr);
3086 forbid_setid('d', -1);
3089 /* -dt indicates to the debugger that threads will be used */
3090 if (*s == 't' && !isALNUM(s[1])) {
3092 my_setenv("PERL5DB_THREADED", "1");
3095 /* The following permits -d:Mod to accepts arguments following an =
3096 in the fashion that -MSome::Mod does. */
3097 if (*s == ':' || *s == '=') {
3099 SV * const sv = newSVpvs("use Devel::");
3101 /* We now allow -d:Module=Foo,Bar */
3102 while(isALNUM(*s) || *s==':') ++s;
3104 sv_catpv(sv, start);
3106 sv_catpvn(sv, start, s-start);
3107 /* Don't use NUL as q// delimiter here, this string goes in the
3109 Perl_sv_catpvf(aTHX_ sv, " split(/,/,q{%s});", ++s);
3112 my_setenv("PERL5DB", SvPV_nolen_const(sv));
3115 PL_perldb = PERLDB_ALL;
3122 forbid_setid('D', -1);
3124 PL_debug = get_debug_opts( (const char **)&s, 1) | DEBUG_TOP_FLAG;
3125 #else /* !DEBUGGING */
3126 if (ckWARN_d(WARN_DEBUGGING))
3127 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3128 "Recompile perl with -DDEBUGGING to use -D switch (did you mean -d ?)\n");
3129 for (s++; isALNUM(*s); s++) ;
3134 usage(PL_origargv[0]);
3137 Safefree(PL_inplace);
3138 #if defined(__CYGWIN__) /* do backup extension automagically */
3139 if (*(s+1) == '\0') {
3140 PL_inplace = savepvs(".bak");
3143 #endif /* __CYGWIN__ */
3145 const char * const start = ++s;
3146 while (*s && !isSPACE(*s))
3149 PL_inplace = savepvn(start, s - start);
3153 if (*s == '-') /* Additional switches on #! line. */
3157 case 'I': /* -I handled both here and in parse_body() */
3158 forbid_setid('I', -1);
3160 while (*s && isSPACE(*s))
3165 /* ignore trailing spaces (possibly followed by other switches) */
3167 for (e = p; *e && !isSPACE(*e); e++) ;
3171 } while (*p && *p != '-');
3172 e = savepvn(s, e-s);
3173 incpush(e, TRUE, TRUE, FALSE, FALSE);
3180 Perl_croak(aTHX_ "No directory specified for -I");
3186 SvREFCNT_dec(PL_ors_sv);
3192 PL_ors_sv = newSVpvs("\n");
3193 numlen = 3 + (*s == '0');
3194 *SvPVX(PL_ors_sv) = (char)grok_oct(s, &numlen, &flags, NULL);
3198 if (RsPARA(PL_rs)) {
3199 PL_ors_sv = newSVpvs("\n\n");
3202 PL_ors_sv = newSVsv(PL_rs);
3207 forbid_setid('M', -1); /* XXX ? */
3210 forbid_setid('m', -1); /* XXX ? */
3214 const char *use = "use ";
3215 /* -M-foo == 'no foo' */
3216 /* Leading space on " no " is deliberate, to make both
3217 possibilities the same length. */
3218 if (*s == '-') { use = " no "; ++s; }
3219 sv = newSVpvn(use,4);
3221 /* We allow -M'Module qw(Foo Bar)' */
3222 while(isALNUM(*s) || *s==':') ++s;
3224 sv_catpv(sv, start);
3225 if (*(start-1) == 'm') {
3227 Perl_croak(aTHX_ "Can't use '%c' after -mname", *s);
3228 sv_catpvs( sv, " ()");
3232 Perl_croak(aTHX_ "Module name required with -%c option",
3234 sv_catpvn(sv, start, s-start);
3235 sv_catpvs(sv, " split(/,/,q");
3236 sv_catpvs(sv, "\0"); /* Use NUL as q//-delimiter. */
3238 sv_catpvs(sv, "\0)");
3241 Perl_av_create_and_push(aTHX_ &PL_preambleav, sv);
3244 Perl_croak(aTHX_ "Missing argument to -%c", *(s-1));
3255 forbid_setid('s', -1);
3256 PL_doswitches = TRUE;
3270 #ifdef MACOS_TRADITIONAL
3271 Perl_croak(aTHX_ "Believe me, you don't want to use \"-u\" on a Macintosh");
3273 PL_do_undump = TRUE;
3281 if (!sv_derived_from(PL_patchlevel, "version"))
3282 upg_version(PL_patchlevel, TRUE);
3284 PerlIO_printf(PerlIO_stdout(),
3285 Perl_form(aTHX_ "\nThis is perl, %"SVf
3286 #ifdef PERL_PATCHNUM
3287 " DEVEL" STRINGIFY(PERL_PATCHNUM)
3290 SVfARG(vstringify(PL_patchlevel)),
3293 /* Adjust verbose output as in the perl that ships with the DG/UX OS from EMC */
3294 PerlIO_printf(PerlIO_stdout(),
3295 Perl_form(aTHX_ "\nThis is perl, %"SVf"\n",
3296 SVfARG(vstringify(PL_patchlevel))));
3297 PerlIO_printf(PerlIO_stdout(),
3298 Perl_form(aTHX_ " built under %s at %s %s\n",
3299 OSNAME, __DATE__, __TIME__));
3300 PerlIO_printf(PerlIO_stdout(),
3301 Perl_form(aTHX_ " OS Specific Release: %s\n",
3305 #if defined(LOCAL_PATCH_COUNT)
3306 if (LOCAL_PATCH_COUNT > 0)
3307 PerlIO_printf(PerlIO_stdout(),
3308 "\n(with %d registered patch%s, "
3309 "see perl -V for more detail)",
3311 (LOCAL_PATCH_COUNT!=1) ? "es" : "");
3314 PerlIO_printf(PerlIO_stdout(),
3315 "\n\nCopyright 1987-2007, Larry Wall\n");
3316 #ifdef MACOS_TRADITIONAL
3317 PerlIO_printf(PerlIO_stdout(),
3318 "\nMac OS port Copyright 1991-2002, Matthias Neeracher;\n"
3319 "maintained by Chris Nandor\n");
3322 PerlIO_printf(PerlIO_stdout(),
3323 "\nMS-DOS port Copyright (c) 1989, 1990, Diomidis Spinellis\n");
3326 PerlIO_printf(PerlIO_stdout(),
3327 "djgpp v2 port (jpl5003c) by Hirofumi Watanabe, 1996\n"
3328 "djgpp v2 port (perl5004+) by Laszlo Molnar, 1997-1999\n");
3331 PerlIO_printf(PerlIO_stdout(),
3332 "\n\nOS/2 port Copyright (c) 1990, 1991, Raymond Chen, Kai Uwe Rommel\n"
3333 "Version 5 port Copyright (c) 1994-2002, Andreas Kaiser, Ilya Zakharevich\n");
3336 PerlIO_printf(PerlIO_stdout(),
3337 "atariST series port, ++jrb bammi@cadence.com\n");
3340 PerlIO_printf(PerlIO_stdout(),
3341 "BeOS port Copyright Tom Spindler, 1997-1999\n");
3344 PerlIO_printf(PerlIO_stdout(),
3345 "MPE/iX port Copyright by Mark Klein and Mark Bixby, 1996-2003\n");
3348 PerlIO_printf(PerlIO_stdout(),
3349 "MVS (OS390) port by Mortice Kern Systems, 1997-1999\n");
3352 PerlIO_printf(PerlIO_stdout(),
3353 "Stratus VOS port by Paul.Green@stratus.com, 1997-2002\n");
3356 PerlIO_printf(PerlIO_stdout(),
3357 "VM/ESA port by Neale Ferguson, 1998-1999\n");
3360 PerlIO_printf(PerlIO_stdout(),
3361 "BS2000 (POSIX) port by Start Amadeus GmbH, 1998-1999\n");
3364 PerlIO_printf(PerlIO_stdout(),
3365 "MiNT port by Guido Flohr, 1997-1999\n");
3368 PerlIO_printf(PerlIO_stdout(),
3369 "EPOC port by Olaf Flebbe, 1999-2002\n");
3372 PerlIO_printf(PerlIO_stdout(),"WINCE port by Rainer Keuchel, 2001-2002\n");
3373 PerlIO_printf(PerlIO_stdout(),"Built on " __DATE__ " " __TIME__ "\n\n");
3376 #ifdef __SYMBIAN32__
3377 PerlIO_printf(PerlIO_stdout(),
3378 "Symbian port by Nokia, 2004-2005\n");
3380 #ifdef BINARY_BUILD_NOTICE
3381 BINARY_BUILD_NOTICE;
3383 PerlIO_printf(PerlIO_stdout(),
3385 Perl may be copied only under the terms of either the Artistic License or the\n\
3386 GNU General Public License, which may be found in the Perl 5 source kit.\n\n\
3387 Complete documentation for Perl, including FAQ lists, should be found on\n\
3388 this system using \"man perl\" or \"perldoc perl\". If you have access to the\n\
3389 Internet, point your browser at http://www.perl.org/, the Perl Home Page.\n\n");
3392 if (! (PL_dowarn & G_WARN_ALL_MASK)) {
3393 PL_dowarn |= G_WARN_ON;
3398 PL_dowarn = G_WARN_ALL_ON|G_WARN_ON;
3399 if (!specialWARN(PL_compiling.cop_warnings))
3400 PerlMemShared_free(PL_compiling.cop_warnings);
3401 PL_compiling.cop_warnings = pWARN_ALL ;
3405 PL_dowarn = G_WARN_ALL_OFF;
3406 if (!specialWARN(PL_compiling.cop_warnings))
3407 PerlMemShared_free(PL_compiling.cop_warnings);
3408 PL_compiling.cop_warnings = pWARN_NONE ;
3413 if (s[1] == '-') /* Additional switches on #! line. */
3418 #if defined(WIN32) || !defined(PERL_STRICT_CR)
3424 #ifdef ALTERNATE_SHEBANG
3425 case 'S': /* OS/2 needs -S on "extproc" line. */
3433 Perl_croak(aTHX_ "Can't emulate -%.1s on #! line",s);
3438 /* compliments of Tom Christiansen */
3440 /* unexec() can be found in the Gnu emacs distribution */
3441 /* Known to work with -DUNEXEC and using unexelf.c from GNU emacs-20.2 */
3444 Perl_my_unexec(pTHX)
3446 PERL_UNUSED_CONTEXT;
3448 SV * prog = newSVpv(BIN_EXP, 0);
3449 SV * file = newSVpv(PL_origfilename, 0);
3453 sv_catpvs(prog, "/perl");
3454 sv_catpvs(file, ".perldump");
3456 unexec(SvPVX(file), SvPVX(prog), &etext, sbrk(0), 0);
3457 /* unexec prints msg to stderr in case of failure */
3458 PerlProc_exit(status);
3461 # include <lib$routines.h>
3462 lib$signal(SS$_DEBUG); /* ssdef.h #included from vmsish.h */
3463 # elif defined(WIN32) || defined(__CYGWIN__)
3464 Perl_croak(aTHX_ "dump is not supported");
3466 ABORT(); /* for use with undump */
3471 /* initialize curinterp */
3477 # define PERLVAR(var,type)
3478 # define PERLVARA(var,n,type)
3479 # if defined(PERL_IMPLICIT_CONTEXT)
3480 # define PERLVARI(var,type,init) aTHX->var = init;
3481 # define PERLVARIC(var,type,init) aTHX->var = init;
3483 # define PERLVARI(var,type,init) PERL_GET_INTERP->var = init;
3484 # define PERLVARIC(var,type,init) PERL_GET_INTERP->var = init;
3486 # include "intrpvar.h"
3492 # define PERLVAR(var,type)
3493 # define PERLVARA(var,n,type)
3494 # define PERLVARI(var,type,init) PL_##var = init;
3495 # define PERLVARIC(var,type,init) PL_##var = init;
3496 # include "intrpvar.h"
3503 /* As these are inside a structure, PERLVARI isn't capable of initialising
3505 PL_reg_oldcurpm = PL_reg_curpm = NULL;
3506 PL_reg_poscache = PL_reg_starttry = NULL;
3510 S_init_main_stash(pTHX)
3515 PL_curstash = PL_defstash = newHV();
3516 /* We know that the string "main" will be in the global shared string
3517 table, so it's a small saving to use it rather than allocate another
3519 PL_curstname = newSVpvs_share("main");
3520 gv = gv_fetchpvs("main::", GV_ADD|GV_NOTQUAL, SVt_PVHV);
3521 /* If we hadn't caused another reference to "main" to be in the shared
3522 string table above, then it would be worth reordering these two,
3523 because otherwise all we do is delete "main" from it as a consequence
3524 of the SvREFCNT_dec, only to add it again with hv_name_set */
3525 SvREFCNT_dec(GvHV(gv));
3526 hv_name_set(PL_defstash, "main", 4, 0);
3527 GvHV(gv) = (HV*)SvREFCNT_inc_simple(PL_defstash);
3529 PL_incgv = gv_HVadd(gv_AVadd(gv_fetchpvs("INC", GV_ADD|GV_NOTQUAL,
3531 SvREFCNT_inc_simple_void(PL_incgv); /* Don't allow it to be freed */
3532 GvMULTI_on(PL_incgv);
3533 PL_hintgv = gv_fetchpvs("\010", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^H */
3534 GvMULTI_on(PL_hintgv);
3535 PL_defgv = gv_fetchpvs("_", GV_ADD|GV_NOTQUAL, SVt_PVAV);
3536 SvREFCNT_inc_simple_void(PL_defgv);
3537 PL_errgv = gv_HVadd(gv_fetchpvs("@", GV_ADD|GV_NOTQUAL, SVt_PV));
3538 SvREFCNT_inc_simple_void(PL_errgv);
3539 GvMULTI_on(PL_errgv);
3540 PL_replgv = gv_fetchpvs("\022", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^R */
3541 GvMULTI_on(PL_replgv);
3542 (void)Perl_form(aTHX_ "%240s",""); /* Preallocate temp - for immediate signals. */
3543 #ifdef PERL_DONT_CREATE_GVSV
3546 sv_grow(ERRSV, 240); /* Preallocate - for immediate signals. */
3547 sv_setpvn(ERRSV, "", 0);
3548 PL_curstash = PL_defstash;
3549 CopSTASH_set(&PL_compiling, PL_defstash);
3550 PL_debstash = GvHV(gv_fetchpvs("DB::", GV_ADDMULTI, SVt_PVHV));
3551 PL_globalstash = GvHV(gv_fetchpvs("CORE::GLOBAL::", GV_ADDMULTI,
3553 /* We must init $/ before switches are processed. */
3554 sv_setpvn(get_sv("/", TRUE), "\n", 1);
3558 S_open_script(pTHX_ const char *scriptname, bool dosearch, SV *sv,
3559 int *suidscript, PerlIO **rsfpp)
3564 const char *cpp_discard_flag;
3573 PL_origfilename = savepvs("-e");
3576 /* if find_script() returns, it returns a malloc()-ed value */
3577 scriptname = PL_origfilename = find_script(scriptname, dosearch, NULL, 1);
3579 if (strnEQ(scriptname, "/dev/fd/", 8) && isDIGIT(scriptname[8]) ) {
3580 const char *s = scriptname + 8;
3586 * Tell apart "normal" usage of fdscript, e.g.
3587 * with bash on FreeBSD:
3588 * perl <( echo '#!perl -DA'; echo 'print "$0\n"')
3589 * from usage in suidperl.
3590 * Does any "normal" usage leave garbage after the number???
3591 * Is it a mistake to use a similar /dev/fd/ construct for
3596 * Be supersafe and do some sanity-checks.
3597 * Still, can we be sure we got the right thing?
3600 Perl_croak(aTHX_ "Wrong syntax (suid) fd script name \"%s\"\n", s);
3603 Perl_croak(aTHX_ "Missing (suid) fd script name\n");
3605 scriptname = savepv(s + 1);
3606 Safefree(PL_origfilename);
3607 PL_origfilename = (char *)scriptname;
3612 CopFILE_free(PL_curcop);
3613 CopFILE_set(PL_curcop, PL_origfilename);
3614 if (*PL_origfilename == '-' && PL_origfilename[1] == '\0')
3615 scriptname = (char *)"";
3616 if (fdscript >= 0) {
3617 *rsfpp = PerlIO_fdopen(fdscript,PERL_SCRIPT_MODE);
3618 # if defined(HAS_FCNTL) && defined(F_SETFD)
3620 /* ensure close-on-exec */
3621 fcntl(PerlIO_fileno(*rsfpp),F_SETFD,1);
3626 Perl_croak(aTHX_ "sperl needs fd script\n"
3627 "You should not call sperl directly; do you need to "
3628 "change a #! line\nfrom sperl to perl?\n");
3631 * Do not open (or do other fancy stuff) while setuid.
3632 * Perl does the open, and hands script to suidperl on a fd;
3633 * suidperl only does some checks, sets up UIDs and re-execs
3634 * perl with that fd as it has always done.
3637 if (*suidscript != 1) {
3638 Perl_croak(aTHX_ "suidperl needs (suid) fd script\n");
3641 else if (PL_preprocess) {
3642 const char * const cpp_cfg = CPPSTDIN;
3643 SV * const cpp = newSVpvs("");
3644 SV * const cmd = newSV(0);
3646 if (cpp_cfg[0] == 0) /* PERL_MICRO? */
3647 Perl_croak(aTHX_ "Can't run with cpp -P with CPPSTDIN undefined");
3648 if (strEQ(cpp_cfg, "cppstdin"))
3649 Perl_sv_catpvf(aTHX_ cpp, "%s/", BIN_EXP);
3650 sv_catpv(cpp, cpp_cfg);
3653 sv_catpvs(sv, "-I");
3654 sv_catpv(sv,PRIVLIB_EXP);
3657 DEBUG_P(PerlIO_printf(Perl_debug_log,
3658 "PL_preprocess: scriptname=\"%s\", cpp=\"%s\", sv=\"%s\", CPPMINUS=\"%s\"\n",
3659 scriptname, SvPVX_const (cpp), SvPVX_const (sv),
3662 # if defined(MSDOS) || defined(WIN32) || defined(VMS)
3669 cpp_discard_flag = "";
3671 cpp_discard_flag = "-C";
3675 perl = os2_execname(aTHX);
3677 perl = PL_origargv[0];
3681 /* This strips off Perl comments which might interfere with
3682 the C pre-processor, including #!. #line directives are
3683 deliberately stripped to avoid confusion with Perl's version
3684 of #line. FWP played some golf with it so it will fit
3685 into VMS's 255 character buffer.
3688 code = "(1../^#!.*perl/i)|/^\\s*#(?!\\s*((ifn?|un)def|(el|end)?if|define|include|else|error|pragma)\\b)/||!($|=1)||print";
3690 code = "/^\\s*#(?!\\s*((ifn?|un)def|(el|end)?if|define|include|else|error|pragma)\\b)/||!($|=1)||print";
3692 Perl_sv_setpvf(aTHX_ cmd, "\
3693 %s -ne%s%s%s %s | %"SVf" %s %"SVf" %s",
3694 perl, quote, code, quote, scriptname, SVfARG(cpp),
3695 cpp_discard_flag, SVfARG(sv), CPPMINUS);
3697 PL_doextract = FALSE;
3699 DEBUG_P(PerlIO_printf(Perl_debug_log,
3700 "PL_preprocess: cmd=\"%s\"\n",
3703 *rsfpp = PerlProc_popen((char *)SvPVX_const(cmd), (char *)"r");
3707 else if (!*scriptname) {
3708 forbid_setid(0, *suidscript);
3709 *rsfpp = PerlIO_stdin();
3712 #ifdef FAKE_BIT_BUCKET
3713 /* This hack allows one not to have /dev/null (or BIT_BUCKET as it
3714 * is called) and still have the "-e" work. (Believe it or not,
3715 * a /dev/null is required for the "-e" to work because source
3716 * filter magic is used to implement it. ) This is *not* a general
3717 * replacement for a /dev/null. What we do here is create a temp
3718 * file (an empty file), open up that as the script, and then
3719 * immediately close and unlink it. Close enough for jazz. */
3720 #define FAKE_BIT_BUCKET_PREFIX "/tmp/perlnull-"
3721 #define FAKE_BIT_BUCKET_SUFFIX "XXXXXXXX"
3722 #define FAKE_BIT_BUCKET_TEMPLATE FAKE_BIT_BUCKET_PREFIX FAKE_BIT_BUCKET_SUFFIX
3723 char tmpname[sizeof(FAKE_BIT_BUCKET_TEMPLATE)] = {
3724 FAKE_BIT_BUCKET_TEMPLATE
3726 const char * const err = "Failed to create a fake bit bucket";
3727 if (strEQ(scriptname, BIT_BUCKET)) {
3728 #ifdef HAS_MKSTEMP /* Hopefully mkstemp() is safe here. */
3729 int tmpfd = mkstemp(tmpname);
3731 scriptname = tmpname;
3734 Perl_croak(aTHX_ err);
3737 scriptname = mktemp(tmpname);
3739 Perl_croak(aTHX_ err);
3744 *rsfpp = PerlIO_open(scriptname,PERL_SCRIPT_MODE);
3745 #ifdef FAKE_BIT_BUCKET
3746 if (memEQ(scriptname, FAKE_BIT_BUCKET_PREFIX,
3747 sizeof(FAKE_BIT_BUCKET_PREFIX) - 1)
3748 && strlen(scriptname) == sizeof(tmpname) - 1) {
3751 scriptname = BIT_BUCKET;
3753 # if defined(HAS_FCNTL) && defined(F_SETFD)
3755 /* ensure close-on-exec */
3756 fcntl(PerlIO_fileno(*rsfpp),F_SETFD,1);
3759 #endif /* IAMSUID */
3761 /* PSz 16 Sep 03 Keep neat error message */
3763 Perl_croak(aTHX_ "Can't open "BIT_BUCKET": %s\n", Strerror(errno));
3765 Perl_croak(aTHX_ "Can't open perl script \"%s\": %s\n",
3766 CopFILE(PL_curcop), Strerror(errno));
3772 * I_SYSSTATVFS HAS_FSTATVFS
3774 * I_STATFS HAS_FSTATFS HAS_GETFSSTAT
3775 * I_MNTENT HAS_GETMNTENT HAS_HASMNTOPT
3776 * here so that metaconfig picks them up. */
3780 S_fd_on_nosuid_fs(pTHX_ int fd)
3783 * We used to do this as "plain" user (after swapping UIDs with setreuid);
3784 * but is needed also on machines without setreuid.
3785 * Seems safe enough to run as root.
3787 int check_okay = 0; /* able to do all the required sys/libcalls */
3788 int on_nosuid = 0; /* the fd is on a nosuid fs */
3790 * Need to check noexec also: nosuid might not be set, the average
3791 * sysadmin would say that nosuid is irrelevant once he sets noexec.
3793 int on_noexec = 0; /* the fd is on a noexec fs */
3796 * Preferred order: fstatvfs(), fstatfs(), ustat()+getmnt(), getmntent().
3797 * fstatvfs() is UNIX98.
3798 * fstatfs() is 4.3 BSD.
3799 * ustat()+getmnt() is pre-4.3 BSD.
3800 * getmntent() is O(number-of-mounted-filesystems) and can hang on
3801 * an irrelevant filesystem while trying to reach the right one.
3804 #undef FD_ON_NOSUID_CHECK_OKAY /* found the syscalls to do the check? */
3806 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3807 defined(HAS_FSTATVFS)
3808 # define FD_ON_NOSUID_CHECK_OKAY
3809 struct statvfs stfs;
3811 check_okay = fstatvfs(fd, &stfs) == 0;
3812 on_nosuid = check_okay && (stfs.f_flag & ST_NOSUID);
3814 /* ST_NOEXEC certainly absent on AIX 5.1, and doesn't seem to be documented
3815 on platforms where it is present. */
3816 on_noexec = check_okay && (stfs.f_flag & ST_NOEXEC);
3818 # endif /* fstatvfs */
3820 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3821 defined(PERL_MOUNT_NOSUID) && \
3822 defined(PERL_MOUNT_NOEXEC) && \
3823 defined(HAS_FSTATFS) && \
3824 defined(HAS_STRUCT_STATFS) && \
3825 defined(HAS_STRUCT_STATFS_F_FLAGS)
3826 # define FD_ON_NOSUID_CHECK_OKAY
3829 check_okay = fstatfs(fd, &stfs) == 0;
3830 on_nosuid = check_okay && (stfs.f_flags & PERL_MOUNT_NOSUID);
3831 on_noexec = check_okay && (stfs.f_flags & PERL_MOUNT_NOEXEC);
3832 # endif /* fstatfs */
3834 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3835 defined(PERL_MOUNT_NOSUID) && \
3836 defined(PERL_MOUNT_NOEXEC) && \
3837 defined(HAS_FSTAT) && \
3838 defined(HAS_USTAT) && \
3839 defined(HAS_GETMNT) && \
3840 defined(HAS_STRUCT_FS_DATA) && \
3842 # define FD_ON_NOSUID_CHECK_OKAY
3845 if (fstat(fd, &fdst) == 0) {
3847 if (ustat(fdst.st_dev, &us) == 0) {
3849 /* NOSTAT_ONE here because we're not examining fields which
3850 * vary between that case and STAT_ONE. */
3851 if (getmnt((int*)0, &fsd, (int)0, NOSTAT_ONE, us.f_fname) == 0) {
3852 size_t cmplen = sizeof(us.f_fname);
3853 if (sizeof(fsd.fd_req.path) < cmplen)
3854 cmplen = sizeof(fsd.fd_req.path);
3855 if (strnEQ(fsd.fd_req.path, us.f_fname, cmplen) &&
3856 fdst.st_dev == fsd.fd_req.dev) {
3858 on_nosuid = fsd.fd_req.flags & PERL_MOUNT_NOSUID;
3859 on_noexec = fsd.fd_req.flags & PERL_MOUNT_NOEXEC;
3864 # endif /* fstat+ustat+getmnt */
3866 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3867 defined(HAS_GETMNTENT) && \
3868 defined(HAS_HASMNTOPT) && \
3869 defined(MNTOPT_NOSUID) && \
3870 defined(MNTOPT_NOEXEC)
3871 # define FD_ON_NOSUID_CHECK_OKAY
3872 FILE *mtab = fopen("/etc/mtab", "r");
3873 struct mntent *entry;
3876 if (mtab && (fstat(fd, &stb) == 0)) {
3877 while (entry = getmntent(mtab)) {
3878 if (stat(entry->mnt_dir, &fsb) == 0
3879 && fsb.st_dev == stb.st_dev)
3881 /* found the filesystem */
3883 if (hasmntopt(entry, MNTOPT_NOSUID))
3885 if (hasmntopt(entry, MNTOPT_NOEXEC))
3888 } /* A single fs may well fail its stat(). */
3893 # endif /* getmntent+hasmntopt */
3896 Perl_croak(aTHX_ "Can't check filesystem of script \"%s\" for nosuid/noexec", PL_origfilename);
3898 Perl_croak(aTHX_ "Setuid script \"%s\" on nosuid filesystem", PL_origfilename);
3900 Perl_croak(aTHX_ "Setuid script \"%s\" on noexec filesystem", PL_origfilename);
3901 return ((!check_okay) || on_nosuid || on_noexec);
3903 #endif /* IAMSUID */
3906 S_validate_suid(pTHX_ const char *validarg, const char *scriptname,
3907 int fdscript, int suidscript, SV *linestr_sv, PerlIO *rsfp)
3912 #endif /* IAMSUID */
3914 /* do we need to emulate setuid on scripts? */
3916 /* This code is for those BSD systems that have setuid #! scripts disabled
3917 * in the kernel because of a security problem. Merely defining DOSUID
3918 * in perl will not fix that problem, but if you have disabled setuid
3919 * scripts in the kernel, this will attempt to emulate setuid and setgid
3920 * on scripts that have those now-otherwise-useless bits set. The setuid
3921 * root version must be called suidperl or sperlN.NNN. If regular perl
3922 * discovers that it has opened a setuid script, it calls suidperl with
3923 * the same argv that it had. If suidperl finds that the script it has
3924 * just opened is NOT setuid root, it sets the effective uid back to the
3925 * uid. We don't just make perl setuid root because that loses the
3926 * effective uid we had before invoking perl, if it was different from the
3929 * Description/comments above do not match current workings:
3930 * suidperl must be hardlinked to sperlN.NNN (that is what we exec);
3931 * suidperl called with script open and name changed to /dev/fd/N/X;
3932 * suidperl croaks if script is not setuid;
3933 * making perl setuid would be a huge security risk (and yes, that
3934 * would lose any euid we might have had).
3936 * DOSUID must be defined in both perl and suidperl, and IAMSUID must
3937 * be defined in suidperl only. suidperl must be setuid root. The
3938 * Configure script will set this up for you if you want it.
3944 if (PerlLIO_fstat(PerlIO_fileno(rsfp),&PL_statbuf) < 0) /* normal stat is insecure */
3945 Perl_croak(aTHX_ "Can't stat script \"%s\"",PL_origfilename);
3946 if (PL_statbuf.st_mode & (S_ISUID|S_ISGID)) {
3948 const char *linestr;
3952 if (fdscript < 0 || suidscript != 1)
3953 Perl_croak(aTHX_ "Need (suid) fdscript in suidperl\n"); /* We already checked this */
3955 * Since the script is opened by perl, not suidperl, some of these
3956 * checks are superfluous. Leaving them in probably does not lower
3960 * Do checks even for systems with no HAS_SETREUID.
3961 * We used to swap, then re-swap UIDs with
3963 if (setreuid(PL_euid,PL_uid) < 0
3964 || PerlProc_getuid() != PL_euid || PerlProc_geteuid() != PL_uid)
3965 Perl_croak(aTHX_ "Can't swap uid and euid");
3968 if (setreuid(PL_uid,PL_euid) < 0
3969 || PerlProc_getuid() != PL_uid || PerlProc_geteuid() != PL_euid)
3970 Perl_croak(aTHX_ "Can't reswap uid and euid");
3974 /* On this access check to make sure the directories are readable,
3975 * there is actually a small window that the user could use to make
3976 * filename point to an accessible directory. So there is a faint
3977 * chance that someone could execute a setuid script down in a
3978 * non-accessible directory. I don't know what to do about that.
3979 * But I don't think it's too important. The manual lies when
3980 * it says access() is useful in setuid programs.
3982 * So, access() is pretty useless... but not harmful... do anyway.
3984 if (PerlLIO_access(CopFILE(PL_curcop),1)) { /*double check*/
3985 Perl_croak(aTHX_ "Can't access() script\n");
3988 /* If we can swap euid and uid, then we can determine access rights
3989 * with a simple stat of the file, and then compare device and
3990 * inode to make sure we did stat() on the same file we opened.
3991 * Then we just have to make sure he or she can execute it.
3994 * As the script is opened by perl, not suidperl, we do not need to
3995 * care much about access rights.
3997 * The 'script changed' check is needed, or we can get lied to
3998 * about $0 with e.g.
3999 * suidperl /dev/fd/4//bin/x 4<setuidscript
4000 * Without HAS_SETREUID, is it safe to stat() as root?
4002 * Are there any operating systems that pass /dev/fd/xxx for setuid
4003 * scripts, as suggested/described in perlsec(1)? Surely they do not
4004 * pass the script name as we do, so the "script changed" test would
4005 * fail for them... but we never get here with
4006 * SETUID_SCRIPTS_ARE_SECURE_NOW defined.
4008 * This is one place where we must "lie" about return status: not
4009 * say if the stat() failed. We are doing this as root, and could
4010 * be tricked into reporting existence or not of files that the
4011 * "plain" user cannot even see.
4015 if (PerlLIO_stat(CopFILE(PL_curcop),&tmpstatbuf) < 0 ||
4016 tmpstatbuf.st_dev != PL_statbuf.st_dev ||
4017 tmpstatbuf.st_ino != PL_statbuf.st_ino) {
4018 Perl_croak(aTHX_ "Setuid script changed\n");
4022 if (!cando(S_IXUSR,FALSE,&PL_statbuf)) /* can real uid exec? */
4023 Perl_croak(aTHX_ "Real UID cannot exec script\n");
4026 * We used to do this check as the "plain" user (after swapping
4027 * UIDs). But the check for nosuid and noexec filesystem is needed,
4028 * and should be done even without HAS_SETREUID. (Maybe those
4029 * operating systems do not have such mount options anyway...)
4030 * Seems safe enough to do as root.
4032 #if !defined(NO_NOSUID_CHECK)
4033 if (fd_on_nosuid_fs(PerlIO_fileno(rsfp))) {
4034 Perl_croak(aTHX_ "Setuid script on nosuid or noexec filesystem\n");
4037 #endif /* IAMSUID */
4039 if (!S_ISREG(PL_statbuf.st_mode)) {
4040 Perl_croak(aTHX_ "Setuid script not plain file\n");
4042 if (PL_statbuf.st_mode & S_IWOTH)
4043 Perl_croak(aTHX_ "Setuid/gid script is writable by world");
4044 PL_doswitches = FALSE; /* -s is insecure in suid */
4045 /* PSz 13 Nov 03 But -s was caught elsewhere ... so unsetting it here is useless(?!) */
4046 CopLINE_inc(PL_curcop);
4047 if (sv_gets(linestr_sv, rsfp, 0) == NULL)
4048 Perl_croak(aTHX_ "No #! line");
4049 linestr = SvPV_nolen_const(linestr_sv);
4050 /* required even on Sys V */
4051 if (!*linestr || !linestr[1] || strnNE(linestr,"#!",2))
4052 Perl_croak(aTHX_ "No #! line");
4056 /* Sanity check on line length */
4057 s_end = s + strlen(s);
4058 if (s_end == s || (s_end - s) > 4000)
4059 Perl_croak(aTHX_ "Very long #! line");
4060 /* Allow more than a single space after #! */
4061 while (isSPACE(*s)) s++;
4062 /* Sanity check on buffer end */
4063 while ((*s) && !isSPACE(*s)) s++;
4064 for (s2 = s; (s2 > linestr &&
4065 (isDIGIT(s2[-1]) || s2[-1] == '.' || s2[-1] == '_'
4066 || s2[-1] == '-')); s2--) ;
4067 /* Sanity check on buffer start */
4068 if ( (s2-4 < linestr || strnNE(s2-4,"perl",4)) &&
4069 (s-9 < linestr || strnNE(s-9,"perl",4)) )
4070 Perl_croak(aTHX_ "Not a perl script");
4071 while (*s == ' ' || *s == '\t') s++;
4073 * #! arg must be what we saw above. They can invoke it by
4074 * mentioning suidperl explicitly, but they may not add any strange
4075 * arguments beyond what #! says if they do invoke suidperl that way.
4078 * The way validarg was set up, we rely on the kernel to start
4079 * scripts with argv[1] set to contain all #! line switches (the
4083 * Check that we got all the arguments listed in the #! line (not
4084 * just that there are no extraneous arguments). Might not matter
4085 * much, as switches from #! line seem to be acted upon (also), and
4086 * so may be checked and trapped in perl. But, security checks must
4087 * be done in suidperl and not deferred to perl. Note that suidperl
4088 * does not get around to parsing (and checking) the switches on
4089 * the #! line (but execs perl sooner).
4090 * Allow (require) a trailing newline (which may be of two
4091 * characters on some architectures?) (but no other trailing
4094 len = strlen(validarg);
4095 if (strEQ(validarg," PHOOEY ") ||
4096 strnNE(s,validarg,len) || !isSPACE(s[len]) ||
4097 !((s_end - s) == len+1
4098 || ((s_end - s) == len+2 && isSPACE(s[len+1]))))
4099 Perl_croak(aTHX_ "Args must match #! line");
4103 PL_euid != PL_uid && (PL_statbuf.st_mode & S_ISUID) &&
4104 PL_euid == PL_statbuf.st_uid)
4106 Perl_croak(aTHX_ "YOU HAVEN'T DISABLED SET-ID SCRIPTS IN THE KERNEL YET!\n\
4107 FIX YOUR KERNEL, OR PUT A C WRAPPER AROUND THIS SCRIPT!\n");
4108 #endif /* IAMSUID */
4111 PL_euid) { /* oops, we're not the setuid root perl */
4113 * When root runs a setuid script, we do not go through the same
4114 * steps of execing sperl and then perl with fd scripts, but
4115 * simply set up UIDs within the same perl invocation; so do
4116 * not have the same checks (on options, whatever) that we have
4117 * for plain users. No problem really: would have to be a script
4118 * that does not actually work for plain users; and if root is
4119 * foolish and can be persuaded to run such an unsafe script, he
4120 * might run also non-setuid ones, and deserves what he gets.
4122 * Or, we might drop the PL_euid check above (and rely just on
4123 * fdscript to avoid loops), and do the execs
4129 * Pass fd script to suidperl.
4130 * Exec suidperl, substituting fd script for scriptname.
4131 * Pass script name as "subdir" of fd, which perl will grok;
4132 * in fact will use that to distinguish this from "normal"
4133 * usage, see comments above.
4135 PerlIO_rewind(rsfp);
4136 PerlLIO_lseek(PerlIO_fileno(rsfp),(Off_t)0,0); /* just in case rewind didn't */
4137 /* PSz 27 Feb 04 Sanity checks on scriptname */
4138 if ((!scriptname) || (!*scriptname) ) {
4139 Perl_croak(aTHX_ "No setuid script name\n");
4141 if (*scriptname == '-') {
4142 Perl_croak(aTHX_ "Setuid script name may not begin with dash\n");
4143 /* Or we might confuse it with an option when replacing
4144 * name in argument list, below (though we do pointer, not
4145 * string, comparisons).
4148 for (which = 1; PL_origargv[which] && PL_origargv[which] != scriptname; which++) ;
4149 if (!PL_origargv[which]) {
4150 Perl_croak(aTHX_ "Can't change argv to have fd script\n");
4152 PL_origargv[which] = savepv(Perl_form(aTHX_ "/dev/fd/%d/%s",
4153 PerlIO_fileno(rsfp), PL_origargv[which]));
4154 #if defined(HAS_FCNTL) && defined(F_SETFD)
4155 fcntl(PerlIO_fileno(rsfp),F_SETFD,0); /* ensure no close-on-exec */
4158 PerlProc_execv(Perl_form(aTHX_ "%s/sperl"PERL_FS_VER_FMT, BIN_EXP,
4159 (int)PERL_REVISION, (int)PERL_VERSION,
4160 (int)PERL_SUBVERSION), PL_origargv);
4162 #endif /* IAMSUID */
4163 Perl_croak(aTHX_ "Can't do setuid (cannot exec sperl)\n");
4166 if (PL_statbuf.st_mode & S_ISGID && PL_statbuf.st_gid != PL_egid) {
4168 * This seems back to front: we try HAS_SETEGID first; if not available
4169 * then try HAS_SETREGID; as a last chance we try HAS_SETRESGID. May be OK
4170 * in the sense that we only want to set EGID; but are there any machines
4171 * with either of the latter, but not the former? Same with UID, later.
4174 (void)setegid(PL_statbuf.st_gid);
4177 (void)setregid((Gid_t)-1,PL_statbuf.st_gid);
4179 #ifdef HAS_SETRESGID
4180 (void)setresgid((Gid_t)-1,PL_statbuf.st_gid,(Gid_t)-1);
4182 PerlProc_setgid(PL_statbuf.st_gid);
4186 if (PerlProc_getegid() != PL_statbuf.st_gid)
4187 Perl_croak(aTHX_ "Can't do setegid!\n");
4189 if (PL_statbuf.st_mode & S_ISUID) {
4190 if (PL_statbuf.st_uid != PL_euid)
4192 (void)seteuid(PL_statbuf.st_uid); /* all that for this */
4195 (void)setreuid((Uid_t)-1,PL_statbuf.st_uid);
4197 #ifdef HAS_SETRESUID
4198 (void)setresuid((Uid_t)-1,PL_statbuf.st_uid,(Uid_t)-1);
4200 PerlProc_setuid(PL_statbuf.st_uid);
4204 if (PerlProc_geteuid() != PL_statbuf.st_uid)
4205 Perl_croak(aTHX_ "Can't do seteuid!\n");
4207 else if (PL_uid) { /* oops, mustn't run as root */
4209 (void)seteuid((Uid_t)PL_uid);
4212 (void)setreuid((Uid_t)-1,(Uid_t)PL_uid);
4214 #ifdef HAS_SETRESUID
4215 (void)setresuid((Uid_t)-1,(Uid_t)PL_uid,(Uid_t)-1);
4217 PerlProc_setuid((Uid_t)PL_uid);
4221 if (PerlProc_geteuid() != PL_uid)
4222 Perl_croak(aTHX_ "Can't do seteuid!\n");
4225 if (!cando(S_IXUSR,TRUE,&PL_statbuf))
4226 Perl_croak(aTHX_ "Effective UID cannot exec script\n"); /* they can't do this */
4229 else if (PL_preprocess) /* PSz 13 Nov 03 Caught elsewhere, useless(?!) here */
4230 Perl_croak(aTHX_ "-P not allowed for setuid/setgid script\n");
4231 else if (fdscript < 0 || suidscript != 1)
4232 /* PSz 13 Nov 03 Caught elsewhere, useless(?!) here */
4233 Perl_croak(aTHX_ "(suid) fdscript needed in suidperl\n");
4235 /* PSz 16 Sep 03 Keep neat error message */
4236 Perl_croak(aTHX_ "Script is not setuid/setgid in suidperl\n");
4239 /* We absolutely must clear out any saved ids here, so we */
4240 /* exec the real perl, substituting fd script for scriptname. */
4241 /* (We pass script name as "subdir" of fd, which perl will grok.) */
4243 * It might be thought that using setresgid and/or setresuid (changed to
4244 * set the saved IDs) above might obviate the need to exec, and we could
4245 * go on to "do the perl thing".
4247 * Is there such a thing as "saved GID", and is that set for setuid (but
4248 * not setgid) execution like suidperl? Without exec, it would not be
4249 * cleared for setuid (but not setgid) scripts (or might need a dummy
4252 * We need suidperl to do the exact same argument checking that perl
4253 * does. Thus it cannot be very small; while it could be significantly
4254 * smaller, it is safer (simpler?) to make it essentially the same
4255 * binary as perl (but they are not identical). - Maybe could defer that
4256 * check to the invoked perl, and suidperl be a tiny wrapper instead;
4257 * but prefer to do thorough checks in suidperl itself. Such deferral
4258 * would make suidperl security rely on perl, a design no-no.
4260 * Setuid things should be short and simple, thus easy to understand and
4261 * verify. They should do their "own thing", without influence by
4262 * attackers. It may help if their internal execution flow is fixed,
4263 * regardless of platform: it may be best to exec anyway.
4265 * Suidperl should at least be conceptually simple: a wrapper only,
4266 * never to do any real perl. Maybe we should put
4268 * Perl_croak(aTHX_ "Suidperl should never do real perl\n");
4270 * into the perly bits.
4272 PerlIO_rewind(rsfp);
4273 PerlLIO_lseek(PerlIO_fileno(rsfp),(Off_t)0,0); /* just in case rewind didn't */
4275 * Keep original arguments: suidperl already has fd script.
4277 /* for (which = 1; PL_origargv[which] && PL_origargv[which] != scriptname; which++) ; */
4278 /* if (!PL_origargv[which]) { */
4279 /* errno = EPERM; */
4280 /* Perl_croak(aTHX_ "Permission denied\n"); */
4282 /* PL_origargv[which] = savepv(Perl_form(aTHX_ "/dev/fd/%d/%s", */
4283 /* PerlIO_fileno(rsfp), PL_origargv[which])); */
4284 #if defined(HAS_FCNTL) && defined(F_SETFD)
4285 fcntl(PerlIO_fileno(rsfp),F_SETFD,0); /* ensure no close-on-exec */
4288 PerlProc_execv(Perl_form(aTHX_ "%s/perl"PERL_FS_VER_FMT, BIN_EXP,
4289 (int)PERL_REVISION, (int)PERL_VERSION,
4290 (int)PERL_SUBVERSION), PL_origargv);/* try again */
4292 Perl_croak(aTHX_ "Can't do setuid (suidperl cannot exec perl)\n");
4293 #endif /* IAMSUID */
4295 PERL_UNUSED_ARG(fdscript);
4296 PERL_UNUSED_ARG(suidscript);
4297 if (PL_euid != PL_uid || PL_egid != PL_gid) { /* (suidperl doesn't exist, in fact) */
4298 #ifndef SETUID_SCRIPTS_ARE_SECURE_NOW
4299 PerlLIO_fstat(PerlIO_fileno(rsfp),&PL_statbuf); /* may be either wrapped or real suid */
4300 if ((PL_euid != PL_uid && PL_euid == PL_statbuf.st_uid && PL_statbuf.st_mode & S_ISUID)
4302 (PL_egid != PL_gid && PL_egid == PL_statbuf.st_gid && PL_statbuf.st_mode & S_ISGID)
4305 Perl_croak(aTHX_ "YOU HAVEN'T DISABLED SET-ID SCRIPTS IN THE KERNEL YET!\n\
4306 FIX YOUR KERNEL, PUT A C WRAPPER AROUND THIS SCRIPT, OR USE -u AND UNDUMP!\n");
4307 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4308 /* not set-id, must be wrapped */
4311 PERL_UNUSED_ARG(validarg);
4312 PERL_UNUSED_ARG(scriptname);
4313 PERL_UNUSED_ARG(linestr_sv);
4317 S_find_beginning(pTHX_ SV* linestr_sv, PerlIO *rsfp)
4321 register const char *s2;
4322 #ifdef MACOS_TRADITIONAL
4326 /* skip forward in input to the real script? */
4328 #ifdef MACOS_TRADITIONAL
4329 /* Since the Mac OS does not honor #! arguments for us, we do it ourselves */
4331 while (PL_doextract || gMacPerl_AlwaysExtract) {
4332 if ((s = sv_gets(linestr_sv, rsfp, 0)) == NULL) {
4333 if (!gMacPerl_AlwaysExtract)
4334 Perl_croak(aTHX_ "No Perl script found in input\n");
4336 if (PL_doextract) /* require explicit override ? */
4337 if (!OverrideExtract(PL_origfilename))
4338 Perl_croak(aTHX_ "User aborted script\n");
4340 PL_doextract = FALSE;
4342 /* Pater peccavi, file does not have #! */
4343 PerlIO_rewind(rsfp);
4348 while (PL_doextract) {
4349 if ((s = sv_gets(linestr_sv, rsfp, 0)) == NULL)
4350 Perl_croak(aTHX_ "No Perl script found in input\n");
4353 if (*s == '#' && s[1] == '!' && ((s = instr(s,"perl")) || (s = instr(s2,"PERL")))) {
4354 PerlIO_ungetc(rsfp, '\n'); /* to keep line count right */
4355 PL_doextract = FALSE;
4356 while (*s && !(isSPACE (*s) || *s == '#')) s++;
4358 while (*s == ' ' || *s == '\t') s++;
4360 while (isDIGIT(s2[-1]) || s2[-1] == '-' || s2[-1] == '.'
4361 || s2[-1] == '_') s2--;
4362 if (strnEQ(s2-4,"perl",4))
4363 while ((s = moreswitches(s)))
4366 #ifdef MACOS_TRADITIONAL
4367 /* We are always searching for the #!perl line in MacPerl,
4368 * so if we find it, still keep the line count correct
4369 * by counting lines we already skipped over
4371 for (; maclines > 0 ; maclines--)
4372 PerlIO_ungetc(rsfp, '\n');
4376 /* gMacPerl_AlwaysExtract is false in MPW tool */
4377 } else if (gMacPerl_AlwaysExtract) {
4389 PL_uid = PerlProc_getuid();
4390 PL_euid = PerlProc_geteuid();
4391 PL_gid = PerlProc_getgid();
4392 PL_egid = PerlProc_getegid();
4394 PL_uid |= PL_gid << 16;
4395 PL_euid |= PL_egid << 16;
4397 /* Should not happen: */
4398 CHECK_MALLOC_TAINT(PL_uid && (PL_euid != PL_uid || PL_egid != PL_gid));
4399 PL_tainting |= (PL_uid && (PL_euid != PL_uid || PL_egid != PL_gid));
4402 * Should go by suidscript, not uid!=euid: why disallow
4403 * system("ls") in scripts run from setuid things?
4404 * Or, is this run before we check arguments and set suidscript?
4405 * What about SETUID_SCRIPTS_ARE_SECURE_NOW: could we use fdscript then?
4406 * (We never have suidscript, can we be sure to have fdscript?)
4407 * Or must then go by UID checks? See comments in forbid_setid also.
4411 /* This is used very early in the lifetime of the program,
4412 * before even the options are parsed, so PL_tainting has
4413 * not been initialized properly. */
4415 Perl_doing_taint(int argc, char *argv[], char *envp[])
4417 #ifndef PERL_IMPLICIT_SYS
4418 /* If we have PERL_IMPLICIT_SYS we can't call getuid() et alia
4419 * before we have an interpreter-- and the whole point of this
4420 * function is to be called at such an early stage. If you are on
4421 * a system with PERL_IMPLICIT_SYS but you do have a concept of
4422 * "tainted because running with altered effective ids', you'll
4423 * have to add your own checks somewhere in here. The two most
4424 * known samples of 'implicitness' are Win32 and NetWare, neither
4425 * of which has much of concept of 'uids'. */
4426 int uid = PerlProc_getuid();
4427 int euid = PerlProc_geteuid();
4428 int gid = PerlProc_getgid();
4429 int egid = PerlProc_getegid();
4436 if (uid && (euid != uid || egid != gid))
4438 #endif /* !PERL_IMPLICIT_SYS */
4439 /* This is a really primitive check; environment gets ignored only
4440 * if -T are the first chars together; otherwise one gets
4441 * "Too late" message. */
4442 if ( argc > 1 && argv[1][0] == '-'
4443 && (argv[1][1] == 't' || argv[1][1] == 'T') )
4448 /* Passing the flag as a single char rather than a string is a slight space
4449 optimisation. The only message that isn't /^-.$/ is
4450 "program input from stdin", which is substituted in place of '\0', which
4451 could never be a command line flag. */
4453 S_forbid_setid(pTHX_ const char flag, const int suidscript)
4456 char string[3] = "-x";
4457 const char *message = "program input from stdin";
4464 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
4465 if (PL_euid != PL_uid)
4466 Perl_croak(aTHX_ "No %s allowed while running setuid", message);
4467 if (PL_egid != PL_gid)
4468 Perl_croak(aTHX_ "No %s allowed while running setgid", message);
4469 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4471 * Checks for UID/GID above "wrong": why disallow
4472 * perl -e 'print "Hello\n"'
4473 * from within setuid things?? Simply drop them: replaced by
4474 * fdscript/suidscript and #ifdef IAMSUID checks below.
4476 * This may be too late for command-line switches. Will catch those on
4477 * the #! line, after finding the script name and setting up
4478 * fdscript/suidscript. Note that suidperl does not get around to
4479 * parsing (and checking) the switches on the #! line, but checks that
4480 * the two sets are identical.
4482 * With SETUID_SCRIPTS_ARE_SECURE_NOW, could we use fdscript, also or
4483 * instead, or would that be "too late"? (We never have suidscript, can
4484 * we be sure to have fdscript?)
4486 * Catch things with suidscript (in descendant of suidperl), even with
4487 * right UID/GID. Was already checked in suidperl, with #ifdef IAMSUID,
4488 * below; but I am paranoid.
4490 * Also see comments about root running a setuid script, elsewhere.
4492 if (suidscript >= 0)
4493 Perl_croak(aTHX_ "No %s allowed with (suid) fdscript", message);
4495 /* PSz 11 Nov 03 Catch it in suidperl, always! */
4496 Perl_croak(aTHX_ "No %s allowed in suidperl", message);
4497 #endif /* IAMSUID */
4501 Perl_init_debugger(pTHX)
4504 HV * const ostash = PL_curstash;
4506 PL_curstash = PL_debstash;
4507 PL_dbargs = GvAV(gv_AVadd((gv_fetchpvs("DB::args", GV_ADDMULTI,
4509 AvREAL_off(PL_dbargs);
4510 PL_DBgv = gv_fetchpvs("DB::DB", GV_ADDMULTI, SVt_PVGV);
4511 PL_DBline = gv_fetchpvs("DB::dbline", GV_ADDMULTI, SVt_PVAV);
4512 PL_DBsub = gv_HVadd(gv_fetchpvs("DB::sub", GV_ADDMULTI, SVt_PVHV));
4513 PL_DBsingle = GvSV((gv_fetchpvs("DB::single", GV_ADDMULTI, SVt_PV)));
4514 sv_setiv(PL_DBsingle, 0);
4515 PL_DBtrace = GvSV((gv_fetchpvs("DB::trace", GV_ADDMULTI, SVt_PV)));
4516 sv_setiv(PL_DBtrace, 0);
4517 PL_DBsignal = GvSV((gv_fetchpvs("DB::signal", GV_ADDMULTI, SVt_PV)));
4518 sv_setiv(PL_DBsignal, 0);
4519 PL_curstash = ostash;
4522 #ifndef STRESS_REALLOC
4523 #define REASONABLE(size) (size)
4525 #define REASONABLE(size) (1) /* unreasonable */
4529 Perl_init_stacks(pTHX)
4532 /* start with 128-item stack and 8K cxstack */
4533 PL_curstackinfo = new_stackinfo(REASONABLE(128),
4534 REASONABLE(8192/sizeof(PERL_CONTEXT) - 1));
4535 PL_curstackinfo->si_type = PERLSI_MAIN;
4536 PL_curstack = PL_curstackinfo->si_stack;
4537 PL_mainstack = PL_curstack; /* remember in case we switch stacks */
4539 PL_stack_base = AvARRAY(PL_curstack);
4540 PL_stack_sp = PL_stack_base;
4541 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
4543 Newx(PL_tmps_stack,REASONABLE(128),SV*);
4546 PL_tmps_max = REASONABLE(128);
4548 Newx(PL_markstack,REASONABLE(32),I32);
4549 PL_markstack_ptr = PL_markstack;
4550 PL_markstack_max = PL_markstack + REASONABLE(32);
4554 Newx(PL_scopestack,REASONABLE(32),I32);
4555 PL_scopestack_ix = 0;
4556 PL_scopestack_max = REASONABLE(32);
4558 Newx(PL_savestack,REASONABLE(128),ANY);
4559 PL_savestack_ix = 0;
4560 PL_savestack_max = REASONABLE(128);
4569 while (PL_curstackinfo->si_next)
4570 PL_curstackinfo = PL_curstackinfo->si_next;
4571 while (PL_curstackinfo) {
4572 PERL_SI *p = PL_curstackinfo->si_prev;
4573 /* curstackinfo->si_stack got nuked by sv_free_arenas() */
4574 Safefree(PL_curstackinfo->si_cxstack);
4575 Safefree(PL_curstackinfo);
4576 PL_curstackinfo = p;
4578 Safefree(PL_tmps_stack);
4579 Safefree(PL_markstack);
4580 Safefree(PL_scopestack);
4581 Safefree(PL_savestack);
4586 S_init_predump_symbols(pTHX)
4592 sv_setpvn(get_sv("\"", TRUE), " ", 1);
4593 PL_stdingv = gv_fetchpvs("STDIN", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4594 GvMULTI_on(PL_stdingv);
4595 io = GvIOp(PL_stdingv);
4596 IoTYPE(io) = IoTYPE_RDONLY;
4597 IoIFP(io) = PerlIO_stdin();
4598 tmpgv = gv_fetchpvs("stdin", GV_ADD|GV_NOTQUAL, SVt_PV);
4600 GvIOp(tmpgv) = (IO*)SvREFCNT_inc_simple(io);
4602 tmpgv = gv_fetchpvs("STDOUT", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4605 IoTYPE(io) = IoTYPE_WRONLY;
4606 IoOFP(io) = IoIFP(io) = PerlIO_stdout();
4608 tmpgv = gv_fetchpvs("stdout", GV_ADD|GV_NOTQUAL, SVt_PV);
4610 GvIOp(tmpgv) = (IO*)SvREFCNT_inc_simple(io);
4612 PL_stderrgv = gv_fetchpvs("STDERR", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4613 GvMULTI_on(PL_stderrgv);
4614 io = GvIOp(PL_stderrgv);
4615 IoTYPE(io) = IoTYPE_WRONLY;
4616 IoOFP(io) = IoIFP(io) = PerlIO_stderr();
4617 tmpgv = gv_fetchpvs("stderr", GV_ADD|GV_NOTQUAL, SVt_PV);
4619 GvIOp(tmpgv) = (IO*)SvREFCNT_inc_simple(io);
4621 PL_statname = newSV(0); /* last filename we did stat on */
4623 Safefree(PL_osname);
4624 PL_osname = savepv(OSNAME);
4628 Perl_init_argv_symbols(pTHX_ register int argc, register char **argv)
4631 argc--,argv++; /* skip name of script */
4632 if (PL_doswitches) {
4633 for (; argc > 0 && **argv == '-'; argc--,argv++) {
4637 if (argv[0][1] == '-' && !argv[0][2]) {
4641 if ((s = strchr(argv[0], '='))) {
4642 const char *const start_name = argv[0] + 1;
4643 sv_setpv(GvSV(gv_fetchpvn_flags(start_name, s - start_name,
4644 TRUE, SVt_PV)), s + 1);
4647 sv_setiv(GvSV(gv_fetchpv(argv[0]+1, GV_ADD, SVt_PV)),1);
4650 if ((PL_argvgv = gv_fetchpvs("ARGV", GV_ADD|GV_NOTQUAL, SVt_PVAV))) {
4651 GvMULTI_on(PL_argvgv);
4652 (void)gv_AVadd(PL_argvgv);
4653 av_clear(GvAVn(PL_argvgv));
4654 for (; argc > 0; argc--,argv++) {
4655 SV * const sv = newSVpv(argv[0],0);
4656 av_push(GvAVn(PL_argvgv),sv);
4657 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
4658 if (PL_unicode & PERL_UNICODE_ARGV_FLAG)
4661 if (PL_unicode & PERL_UNICODE_WIDESYSCALLS_FLAG) /* Sarathy? */
4662 (void)sv_utf8_decode(sv);
4668 S_init_postdump_symbols(pTHX_ register int argc, register char **argv, register char **env)
4673 PL_toptarget = newSV_type(SVt_PVFM);
4674 sv_setpvn(PL_toptarget, "", 0);
4675 PL_bodytarget = newSV_type(SVt_PVFM);
4676 sv_setpvn(PL_bodytarget, "", 0);
4677 PL_formtarget = PL_bodytarget;
4681 init_argv_symbols(argc,argv);
4683 if ((tmpgv = gv_fetchpvs("0", GV_ADD|GV_NOTQUAL, SVt_PV))) {
4684 #ifdef MACOS_TRADITIONAL
4685 /* $0 is not majick on a Mac */
4686 sv_setpv(GvSV(tmpgv),MacPerl_MPWFileName(PL_origfilename));
4688 sv_setpv(GvSV(tmpgv),PL_origfilename);
4689 magicname("0", "0", 1);
4692 if ((PL_envgv = gv_fetchpvs("ENV", GV_ADD|GV_NOTQUAL, SVt_PVHV))) {
4694 bool env_is_not_environ;
4695 GvMULTI_on(PL_envgv);
4696 hv = GvHVn(PL_envgv);
4697 hv_magic(hv, NULL, PERL_MAGIC_env);
4699 #ifdef USE_ENVIRON_ARRAY
4700 /* Note that if the supplied env parameter is actually a copy
4701 of the global environ then it may now point to free'd memory
4702 if the environment has been modified since. To avoid this
4703 problem we treat env==NULL as meaning 'use the default'
4707 env_is_not_environ = env != environ;
4708 if (env_is_not_environ
4709 # ifdef USE_ITHREADS
4710 && PL_curinterp == aTHX
4719 for (; *env; env++) {
4720 if (!(s = strchr(*env,'=')) || s == *env)
4722 #if defined(MSDOS) && !defined(DJGPP)
4727 sv = newSVpv(s+1, 0);
4728 (void)hv_store(hv, *env, s - *env, sv, 0);
4729 if (env_is_not_environ)
4733 #endif /* USE_ENVIRON_ARRAY */
4734 #endif /* !PERL_MICRO */
4737 if ((tmpgv = gv_fetchpvs("$", GV_ADD|GV_NOTQUAL, SVt_PV))) {
4738 SvREADONLY_off(GvSV(tmpgv));
4739 sv_setiv(GvSV(tmpgv), (IV)PerlProc_getpid());
4740 SvREADONLY_on(GvSV(tmpgv));
4742 #ifdef THREADS_HAVE_PIDS
4743 PL_ppid = (IV)getppid();
4746 /* touch @F array to prevent spurious warnings 20020415 MJD */
4748 (void) get_av("main::F", TRUE | GV_ADDMULTI);
4753 S_init_perllib(pTHX)
4759 s = PerlEnv_getenv("PERL5LIB");
4761 * It isn't possible to delete an environment variable with
4762 * PERL_USE_SAFE_PUTENV set unless unsetenv() is also available, so in that
4763 * case we treat PERL5LIB as undefined if it has a zero-length value.
4765 #if defined(PERL_USE_SAFE_PUTENV) && ! defined(HAS_UNSETENV)
4766 if (s && *s != '\0')
4770 incpush(s, TRUE, TRUE, TRUE, FALSE);
4772 incpush(PerlEnv_getenv("PERLLIB"), FALSE, FALSE, TRUE, FALSE);
4774 /* Treat PERL5?LIB as a possible search list logical name -- the
4775 * "natural" VMS idiom for a Unix path string. We allow each
4776 * element to be a set of |-separated directories for compatibility.
4780 if (my_trnlnm("PERL5LIB",buf,0))
4781 do { incpush(buf,TRUE,TRUE,TRUE,FALSE); } while (my_trnlnm("PERL5LIB",buf,++idx));
4783 while (my_trnlnm("PERLLIB",buf,idx++)) incpush(buf,FALSE,FALSE,TRUE,FALSE);
4787 /* Use the ~-expanded versions of APPLLIB (undocumented),
4788 ARCHLIB PRIVLIB SITEARCH SITELIB VENDORARCH and VENDORLIB
4791 incpush(APPLLIB_EXP, TRUE, TRUE, TRUE, TRUE);
4795 incpush(ARCHLIB_EXP, FALSE, FALSE, TRUE, TRUE);
4797 #ifdef MACOS_TRADITIONAL
4800 SV * privdir = newSV(0);
4801 char * macperl = PerlEnv_getenv("MACPERL");
4806 Perl_sv_setpvf(aTHX_ privdir, "%slib:", macperl);
4807 if (PerlLIO_stat(SvPVX(privdir), &tmpstatbuf) >= 0 && S_ISDIR(tmpstatbuf.st_mode))
4808 incpush(SvPVX(privdir), TRUE, FALSE, TRUE, FALSE);
4809 Perl_sv_setpvf(aTHX_ privdir, "%ssite_perl:", macperl);
4810 if (PerlLIO_stat(SvPVX(privdir), &tmpstatbuf) >= 0 && S_ISDIR(tmpstatbuf.st_mode))
4811 incpush(SvPVX(privdir), TRUE, FALSE, TRUE, FALSE);
4813 SvREFCNT_dec(privdir);
4816 incpush(":", FALSE, FALSE, TRUE, FALSE);
4819 # define PRIVLIB_EXP "/usr/local/lib/perl5:/usr/local/lib/perl"
4822 incpush(PRIVLIB_EXP, TRUE, FALSE, TRUE, TRUE);
4824 incpush(PRIVLIB_EXP, FALSE, FALSE, TRUE, TRUE);
4828 /* sitearch is always relative to sitelib on Windows for
4829 * DLL-based path intuition to work correctly */
4830 # if !defined(WIN32)
4831 incpush(SITEARCH_EXP, FALSE, FALSE, TRUE, TRUE);
4837 /* this picks up sitearch as well */
4838 incpush(SITELIB_EXP, TRUE, FALSE, TRUE, TRUE);
4840 incpush(SITELIB_EXP, FALSE, FALSE, TRUE, TRUE);
4844 #if defined(SITELIB_STEM) && defined(PERL_INC_VERSION_LIST)
4845 /* Search for version-specific dirs below here */
4846 incpush(SITELIB_STEM, FALSE, TRUE, TRUE, TRUE);
4849 #ifdef PERL_VENDORARCH_EXP
4850 /* vendorarch is always relative to vendorlib on Windows for
4851 * DLL-based path intuition to work correctly */
4852 # if !defined(WIN32)
4853 incpush(PERL_VENDORARCH_EXP, FALSE, FALSE, TRUE, TRUE);
4857 #ifdef PERL_VENDORLIB_EXP
4859 incpush(PERL_VENDORLIB_EXP, TRUE, FALSE, TRUE, TRUE); /* this picks up vendorarch as well */
4861 incpush(PERL_VENDORLIB_EXP, FALSE, FALSE, TRUE, TRUE);
4865 #ifdef PERL_VENDORLIB_STEM /* Search for version-specific dirs below here */
4866 incpush(PERL_VENDORLIB_STEM, FALSE, TRUE, TRUE, TRUE);
4869 #ifdef PERL_OTHERLIBDIRS
4870 incpush(PERL_OTHERLIBDIRS, TRUE, TRUE, TRUE, TRUE);
4874 incpush(".", FALSE, FALSE, TRUE, FALSE);
4875 #endif /* MACOS_TRADITIONAL */
4878 #if defined(DOSISH) || defined(EPOC) || defined(__SYMBIAN32__)
4879 # define PERLLIB_SEP ';'
4882 # define PERLLIB_SEP '|'
4884 # if defined(MACOS_TRADITIONAL)
4885 # define PERLLIB_SEP ','
4887 # define PERLLIB_SEP ':'
4891 #ifndef PERLLIB_MANGLE
4892 # define PERLLIB_MANGLE(s,n) (s)
4895 /* Push a directory onto @INC if it exists.
4896 Generate a new SV if we do this, to save needing to copy the SV we push
4899 S_incpush_if_exists(pTHX_ SV *dir)
4903 if (PerlLIO_stat(SvPVX_const(dir), &tmpstatbuf) >= 0 &&
4904 S_ISDIR(tmpstatbuf.st_mode)) {
4905 av_push(GvAVn(PL_incgv), dir);
4912 S_incpush(pTHX_ const char *dir, bool addsubdirs, bool addoldvers, bool usesep,
4917 const char *p = dir;
4922 if (addsubdirs || addoldvers) {
4926 /* Break at all separators */
4928 SV *libdir = newSV(0);
4931 /* skip any consecutive separators */
4933 while ( *p == PERLLIB_SEP ) {
4934 /* Uncomment the next line for PATH semantics */
4935 /* av_push(GvAVn(PL_incgv), newSVpvs(".")); */
4940 if ( usesep && (s = strchr(p, PERLLIB_SEP)) != NULL ) {
4941 sv_setpvn(libdir, PERLLIB_MANGLE(p, (STRLEN)(s - p)),
4946 sv_setpv(libdir, PERLLIB_MANGLE(p, 0));
4947 p = NULL; /* break out */
4949 #ifdef MACOS_TRADITIONAL
4950 if (!strchr(SvPVX(libdir), ':')) {
4953 sv_setpv(libdir, MacPerl_CanonDir(SvPVX(libdir), buf, 0));
4955 if (SvPVX(libdir)[SvCUR(libdir)-1] != ':')
4956 sv_catpvs(libdir, ":");
4959 /* Do the if() outside the #ifdef to avoid warnings about an unused
4962 #ifdef PERL_RELOCATABLE_INC
4964 * Relocatable include entries are marked with a leading .../
4967 * 0: Remove that leading ".../"
4968 * 1: Remove trailing executable name (anything after the last '/')
4969 * from the perl path to give a perl prefix
4971 * While the @INC element starts "../" and the prefix ends with a real
4972 * directory (ie not . or ..) chop that real directory off the prefix
4973 * and the leading "../" from the @INC element. ie a logical "../"
4975 * Finally concatenate the prefix and the remainder of the @INC element
4976 * The intent is that /usr/local/bin/perl and .../../lib/perl5
4977 * generates /usr/local/lib/perl5
4979 const char *libpath = SvPVX(libdir);
4980 STRLEN libpath_len = SvCUR(libdir);
4981 if (libpath_len >= 4 && memEQ (libpath, ".../", 4)) {
4983 SV * const caret_X = get_sv("\030", 0);
4984 /* Going to use the SV just as a scratch buffer holding a C
4990 /* $^X is *the* source of taint if tainting is on, hence
4991 SvPOK() won't be true. */
4993 assert(SvPOKp(caret_X));
4994 prefix_sv = newSVpvn(SvPVX(caret_X), SvCUR(caret_X));
4995 /* Firstly take off the leading .../
4996 If all else fail we'll do the paths relative to the current
4998 sv_chop(libdir, libpath + 4);
4999 /* Don't use SvPV as we're intentionally bypassing taining,
5000 mortal copies that the mg_get of tainting creates, and
5001 corruption that seems to come via the save stack.
5002 I guess that the save stack isn't correctly set up yet. */
5003 libpath = SvPVX(libdir);
5004 libpath_len = SvCUR(libdir);
5006 /* This would work more efficiently with memrchr, but as it's
5007 only a GNU extension we'd need to probe for it and
5008 implement our own. Not hard, but maybe not worth it? */
5010 prefix = SvPVX(prefix_sv);
5011 lastslash = strrchr(prefix, '/');
5013 /* First time in with the *lastslash = '\0' we just wipe off
5014 the trailing /perl from (say) /usr/foo/bin/perl
5018 while ((*lastslash = '\0'), /* Do that, come what may. */
5019 (libpath_len >= 3 && memEQ(libpath, "../", 3)
5020 && (lastslash = strrchr(prefix, '/')))) {
5021 if (lastslash[1] == '\0'
5022 || (lastslash[1] == '.'
5023 && (lastslash[2] == '/' /* ends "/." */
5024 || (lastslash[2] == '/'
5025 && lastslash[3] == '/' /* or "/.." */
5027 /* Prefix ends "/" or "/." or "/..", any of which
5028 are fishy, so don't do any more logical cleanup.
5032 /* Remove leading "../" from path */
5035 /* Next iteration round the loop removes the last
5036 directory name from prefix by writing a '\0' in
5037 the while clause. */
5039 /* prefix has been terminated with a '\0' to the correct
5040 length. libpath points somewhere into the libdir SV.
5041 We need to join the 2 with '/' and drop the result into
5043 tempsv = Perl_newSVpvf(aTHX_ "%s/%s", prefix, libpath);
5044 SvREFCNT_dec(libdir);
5045 /* And this is the new libdir. */
5048 (PL_uid != PL_euid || PL_gid != PL_egid)) {
5049 /* Need to taint reloccated paths if running set ID */
5050 SvTAINTED_on(libdir);
5053 SvREFCNT_dec(prefix_sv);
5058 * BEFORE pushing libdir onto @INC we may first push version- and
5059 * archname-specific sub-directories.
5061 if (addsubdirs || addoldvers) {
5062 #ifdef PERL_INC_VERSION_LIST
5063 /* Configure terminates PERL_INC_VERSION_LIST with a NULL */
5064 const char * const incverlist[] = { PERL_INC_VERSION_LIST };
5065 const char * const *incver;
5071 if ((unix = tounixspec_ts(SvPV(libdir,len),NULL)) != NULL) {
5073 while (unix[len-1] == '/') len--; /* Cosmetic */
5074 sv_usepvn(libdir,unix,len);
5077 PerlIO_printf(Perl_error_log,
5078 "Failed to unixify @INC element \"%s\"\n",
5082 #ifdef MACOS_TRADITIONAL
5083 #define PERL_AV_SUFFIX_FMT ""
5084 #define PERL_ARCH_FMT "%s:"
5085 #define PERL_ARCH_FMT_PATH PERL_FS_VER_FMT PERL_AV_SUFFIX_FMT
5087 #define PERL_AV_SUFFIX_FMT "/"
5088 #define PERL_ARCH_FMT "/%s"
5089 #define PERL_ARCH_FMT_PATH PERL_AV_SUFFIX_FMT PERL_FS_VER_FMT
5091 /* .../version/archname if -d .../version/archname */
5092 Perl_sv_setpvf(aTHX_ subdir, "%"SVf PERL_ARCH_FMT_PATH PERL_ARCH_FMT,
5094 (int)PERL_REVISION, (int)PERL_VERSION,
5095 (int)PERL_SUBVERSION, ARCHNAME);
5096 subdir = S_incpush_if_exists(aTHX_ subdir);
5098 /* .../version if -d .../version */
5099 Perl_sv_setpvf(aTHX_ subdir, "%"SVf PERL_ARCH_FMT_PATH,
5101 (int)PERL_REVISION, (int)PERL_VERSION,
5102 (int)PERL_SUBVERSION);
5103 subdir = S_incpush_if_exists(aTHX_ subdir);
5105 /* .../archname if -d .../archname */
5106 Perl_sv_setpvf(aTHX_ subdir, "%"SVf PERL_ARCH_FMT,
5107 SVfARG(libdir), ARCHNAME);
5108 subdir = S_incpush_if_exists(aTHX_ subdir);
5112 #ifdef PERL_INC_VERSION_LIST
5114 for (incver = incverlist; *incver; incver++) {
5115 /* .../xxx if -d .../xxx */
5116 Perl_sv_setpvf(aTHX_ subdir, "%"SVf PERL_ARCH_FMT,
5117 SVfARG(libdir), *incver);
5118 subdir = S_incpush_if_exists(aTHX_ subdir);
5124 /* finally push this lib directory on the end of @INC */
5125 av_push(GvAVn(PL_incgv), libdir);
5128 assert (SvREFCNT(subdir) == 1);
5129 SvREFCNT_dec(subdir);
5135 Perl_call_list(pTHX_ I32 oldscope, AV *paramList)
5139 volatile const line_t oldline = PL_curcop ? CopLINE(PL_curcop) : 0;
5145 while (av_len(paramList) >= 0) {
5146 cv = (CV*)av_shift(paramList);
5148 if (paramList == PL_beginav) {
5149 /* save PL_beginav for compiler */
5150 Perl_av_create_and_push(aTHX_ &PL_beginav_save, (SV*)cv);
5152 else if (paramList == PL_checkav) {
5153 /* save PL_checkav for compiler */
5154 Perl_av_create_and_push(aTHX_ &PL_checkav_save, (SV*)cv);
5156 else if (paramList == PL_unitcheckav) {
5157 /* save PL_unitcheckav for compiler */
5158 Perl_av_create_and_push(aTHX_ &PL_unitcheckav_save, (SV*)cv);
5169 PL_madskills |= 16384;
5174 PL_madskills &= ~16384;
5177 (void)SvPV_const(atsv, len);
5179 PL_curcop = &PL_compiling;
5180 CopLINE_set(PL_curcop, oldline);
5181 if (paramList == PL_beginav)
5182 sv_catpvs(atsv, "BEGIN failed--compilation aborted");
5184 Perl_sv_catpvf(aTHX_ atsv,
5185 "%s failed--call queue aborted",
5186 paramList == PL_checkav ? "CHECK"
5187 : paramList == PL_initav ? "INIT"
5188 : paramList == PL_unitcheckav ? "UNITCHECK"
5190 while (PL_scopestack_ix > oldscope)
5193 Perl_croak(aTHX_ "%"SVf"", SVfARG(atsv));
5200 /* my_exit() was called */
5201 while (PL_scopestack_ix > oldscope)
5204 PL_curstash = PL_defstash;
5205 PL_curcop = &PL_compiling;
5206 CopLINE_set(PL_curcop, oldline);
5208 if (PL_statusvalue && !(PL_exit_flags & PERL_EXIT_EXPECTED)) {
5209 if (paramList == PL_beginav)
5210 Perl_croak(aTHX_ "BEGIN failed--compilation aborted");
5212 Perl_croak(aTHX_ "%s failed--call queue aborted",
5213 paramList == PL_checkav ? "CHECK"
5214 : paramList == PL_initav ? "INIT"
5215 : paramList == PL_unitcheckav ? "UNITCHECK"
5222 PL_curcop = &PL_compiling;
5223 CopLINE_set(PL_curcop, oldline);
5226 PerlIO_printf(Perl_error_log, "panic: restartop\n");
5235 Perl_my_exit(pTHX_ U32 status)
5238 DEBUG_S(PerlIO_printf(Perl_debug_log, "my_exit: thread %p, status %lu\n",
5239 (void*)thr, (unsigned long) status));
5248 STATUS_EXIT_SET(status);
5255 Perl_my_failure_exit(pTHX)
5259 /* We have been called to fall on our sword. The desired exit code
5260 * should be already set in STATUS_UNIX, but could be shifted over
5261 * by 8 bits. STATUS_UNIX_EXIT_SET will handle the cases where a
5264 * If an error code has not been set, then force the issue.
5266 if (MY_POSIX_EXIT) {
5268 /* In POSIX_EXIT mode follow Perl documentations and use 255 for
5269 * the exit code when there isn't an error.
5272 if (STATUS_UNIX == 0)
5273 STATUS_UNIX_EXIT_SET(255);
5275 STATUS_UNIX_EXIT_SET(STATUS_UNIX);
5277 /* The exit code could have been set by $? or vmsish which
5278 * means that it may not be fatal. So convert
5279 * success/warning codes to fatal.
5281 if ((STATUS_NATIVE & (STS$K_SEVERE|STS$K_ERROR)) == 0)
5282 STATUS_UNIX_EXIT_SET(255);
5286 /* Traditionally Perl on VMS always expects a Fatal Error. */
5287 if (vaxc$errno & 1) {
5289 /* So force success status to failure */
5290 if (STATUS_NATIVE & 1)
5295 STATUS_UNIX = EINTR; /* In case something cares */
5300 STATUS_NATIVE = vaxc$errno; /* Should already be this */
5302 /* Encode the severity code */
5303 severity = STATUS_NATIVE & STS$M_SEVERITY;
5304 STATUS_UNIX = (severity ? severity : 1) << 8;
5306 /* Perl expects this to be a fatal error */
5307 if (severity != STS$K_SEVERE)
5316 STATUS_UNIX_SET(errno);
5318 exitstatus = STATUS_UNIX >> 8;
5319 if (exitstatus & 255)
5320 STATUS_UNIX_SET(exitstatus);
5322 STATUS_UNIX_SET(255);
5329 S_my_exit_jump(pTHX)
5334 SvREFCNT_dec(PL_e_script);
5338 POPSTACK_TO(PL_mainstack);
5346 read_e_script(pTHX_ int idx, SV *buf_sv, int maxlen)
5349 const char * const p = SvPVX_const(PL_e_script);
5350 const char *nl = strchr(p, '\n');
5352 PERL_UNUSED_ARG(idx);
5353 PERL_UNUSED_ARG(maxlen);
5355 nl = (nl) ? nl+1 : SvEND(PL_e_script);
5357 filter_del(read_e_script);
5360 sv_catpvn(buf_sv, p, nl-p);
5361 sv_chop(PL_e_script, nl);
5367 * c-indentation-style: bsd
5369 * indent-tabs-mode: t
5372 * ex: set ts=8 sts=4 sw=4 noet: