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);
175 PERL_SET_THX(my_perl);
179 #ifdef PERL_IMPLICIT_SYS
181 perl_alloc_using(struct IPerlMem* ipM, struct IPerlMem* ipMS,
182 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
183 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
184 struct IPerlDir* ipD, struct IPerlSock* ipS,
185 struct IPerlProc* ipP)
187 PerlInterpreter *my_perl;
188 /* Newx() needs interpreter, so call malloc() instead */
189 my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
190 S_init_tls_and_interp(my_perl);
191 Zero(my_perl, 1, PerlInterpreter);
201 INIT_TRACK_MEMPOOL(PL_memory_debug_header, my_perl);
208 =head1 Embedding Functions
210 =for apidoc perl_alloc
212 Allocates a new Perl interpreter. See L<perlembed>.
220 PerlInterpreter *my_perl;
222 /* Newx() needs interpreter, so call malloc() instead */
223 my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
225 S_init_tls_and_interp(my_perl);
226 #ifndef PERL_TRACK_MEMPOOL
227 return (PerlInterpreter *) ZeroD(my_perl, 1, PerlInterpreter);
229 Zero(my_perl, 1, PerlInterpreter);
230 INIT_TRACK_MEMPOOL(PL_memory_debug_header, my_perl);
234 #endif /* PERL_IMPLICIT_SYS */
237 =for apidoc perl_construct
239 Initializes a new Perl interpreter. See L<perlembed>.
245 perl_construct(pTHXx)
248 PERL_UNUSED_ARG(my_perl);
251 PL_perl_destruct_level = 1;
253 if (PL_perl_destruct_level > 0)
256 /* Init the real globals (and main thread)? */
258 PL_curcop = &PL_compiling; /* needed by ckWARN, right away */
260 PL_linestr = newSV(79);
261 sv_upgrade(PL_linestr,SVt_PVIV);
263 if (!SvREADONLY(&PL_sv_undef)) {
264 /* set read-only and try to insure than we wont see REFCNT==0
267 SvREADONLY_on(&PL_sv_undef);
268 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
270 sv_setpv(&PL_sv_no,PL_No);
271 /* value lookup in void context - happens to have the side effect
272 of caching the numeric forms. */
275 SvREADONLY_on(&PL_sv_no);
276 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
278 sv_setpv(&PL_sv_yes,PL_Yes);
281 SvREADONLY_on(&PL_sv_yes);
282 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
284 SvREADONLY_on(&PL_sv_placeholder);
285 SvREFCNT(&PL_sv_placeholder) = (~(U32)0)/2;
288 PL_sighandlerp = (Sighandler_t) Perl_sighandler;
289 #ifdef PERL_USES_PL_PIDSTATUS
290 PL_pidstatus = newHV();
294 PL_rs = newSVpvs("\n");
299 PL_lex_state = LEX_NOTPARSING;
305 SET_NUMERIC_STANDARD();
307 #if defined(LOCAL_PATCH_COUNT)
308 PL_localpatches = local_patches; /* For possible -v */
311 #ifdef HAVE_INTERP_INTERN
315 PerlIO_init(aTHX); /* Hook to IO system */
317 PL_fdpid = newAV(); /* for remembering popen pids by fd */
318 PL_modglobal = newHV(); /* pointers to per-interpreter module globals */
319 PL_errors = newSVpvs("");
320 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
321 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
322 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
324 /* First entry is an array of empty elements */
325 Perl_av_create_and_push(aTHX_ &PL_regex_padav,(SV*)newAV());
326 PL_regex_pad = AvARRAY(PL_regex_padav);
328 #ifdef USE_REENTRANT_API
329 Perl_reentrant_init(aTHX);
332 /* Note that strtab is a rather special HV. Assumptions are made
333 about not iterating on it, and not adding tie magic to it.
334 It is properly deallocated in perl_destruct() */
337 HvSHAREKEYS_off(PL_strtab); /* mandatory */
338 hv_ksplit(PL_strtab, 512);
340 #if defined(__DYNAMIC__) && (defined(NeXT) || defined(__NeXT__))
341 _dyld_lookup_and_bind
342 ("__environ", (unsigned long *) &environ_pointer, NULL);
346 # ifdef USE_ENVIRON_ARRAY
347 PL_origenviron = environ;
351 /* Use sysconf(_SC_CLK_TCK) if available, if not
352 * available or if the sysconf() fails, use the HZ.
353 * BeOS has those, but returns the wrong value.
354 * The HZ if not originally defined has been by now
355 * been defined as CLK_TCK, if available. */
356 #if defined(HAS_SYSCONF) && defined(_SC_CLK_TCK) && !defined(__BEOS__)
357 PL_clocktick = sysconf(_SC_CLK_TCK);
358 if (PL_clocktick <= 0)
362 PL_stashcache = newHV();
364 PL_patchlevel = Perl_newSVpvf(aTHX_ "%d.%d.%d", (int)PERL_REVISION,
365 (int)PERL_VERSION, (int)PERL_SUBVERSION);
368 if (!PL_mmap_page_size) {
369 #if defined(HAS_SYSCONF) && (defined(_SC_PAGESIZE) || defined(_SC_MMAP_PAGE_SIZE))
371 SETERRNO(0, SS_NORMAL);
373 PL_mmap_page_size = sysconf(_SC_PAGESIZE);
375 PL_mmap_page_size = sysconf(_SC_MMAP_PAGE_SIZE);
377 if ((long) PL_mmap_page_size < 0) {
379 SV * const error = ERRSV;
380 SvUPGRADE(error, SVt_PV);
381 Perl_croak(aTHX_ "panic: sysconf: %s", SvPV_nolen_const(error));
384 Perl_croak(aTHX_ "panic: sysconf: pagesize unknown");
388 # ifdef HAS_GETPAGESIZE
389 PL_mmap_page_size = getpagesize();
391 # if defined(I_SYS_PARAM) && defined(PAGESIZE)
392 PL_mmap_page_size = PAGESIZE; /* compiletime, bad */
396 if (PL_mmap_page_size <= 0)
397 Perl_croak(aTHX_ "panic: bad pagesize %" IVdf,
398 (IV) PL_mmap_page_size);
400 #endif /* HAS_MMAP */
402 #if defined(HAS_TIMES) && defined(PERL_NEED_TIMESBASE)
403 PL_timesbase.tms_utime = 0;
404 PL_timesbase.tms_stime = 0;
405 PL_timesbase.tms_cutime = 0;
406 PL_timesbase.tms_cstime = 0;
417 =for apidoc nothreadhook
419 Stub that provides thread hook for perl_destruct when there are
426 Perl_nothreadhook(pTHX)
432 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
434 Perl_dump_sv_child(pTHX_ SV *sv)
437 const int sock = PL_dumper_fd;
438 const int debug_fd = PerlIO_fileno(Perl_debug_log);
439 union control_un control;
442 struct cmsghdr *cmptr;
444 unsigned char buffer[256];
446 if(sock == -1 || debug_fd == -1)
449 PerlIO_flush(Perl_debug_log);
451 /* All these shenanigans are to pass a file descriptor over to our child for
452 it to dump out to. We can't let it hold open the file descriptor when it
453 forks, as the file descriptor it will dump to can turn out to be one end
454 of pipe that some other process will wait on for EOF. (So as it would
455 be open, the wait would be forever.) */
457 msg.msg_control = control.control;
458 msg.msg_controllen = sizeof(control.control);
459 /* We're a connected socket so we don't need a destination */
465 cmptr = CMSG_FIRSTHDR(&msg);
466 cmptr->cmsg_len = CMSG_LEN(sizeof(int));
467 cmptr->cmsg_level = SOL_SOCKET;
468 cmptr->cmsg_type = SCM_RIGHTS;
469 *((int *)CMSG_DATA(cmptr)) = 1;
471 vec[0].iov_base = (void*)&sv;
472 vec[0].iov_len = sizeof(sv);
473 got = sendmsg(sock, &msg, 0);
476 perror("Debug leaking scalars parent sendmsg failed");
479 if(got < sizeof(sv)) {
480 perror("Debug leaking scalars parent short sendmsg");
484 /* Return protocol is
486 unsigned char: length of location string (0 for empty)
487 unsigned char*: string (not terminated)
489 vec[0].iov_base = (void*)&returned_errno;
490 vec[0].iov_len = sizeof(returned_errno);
491 vec[1].iov_base = buffer;
494 got = readv(sock, vec, 2);
497 perror("Debug leaking scalars parent read failed");
498 PerlIO_flush(PerlIO_stderr());
501 if(got < sizeof(returned_errno) + 1) {
502 perror("Debug leaking scalars parent short read");
503 PerlIO_flush(PerlIO_stderr());
508 got = read(sock, buffer + 1, *buffer);
510 perror("Debug leaking scalars parent read 2 failed");
511 PerlIO_flush(PerlIO_stderr());
516 perror("Debug leaking scalars parent short read 2");
517 PerlIO_flush(PerlIO_stderr());
522 if (returned_errno || *buffer) {
523 Perl_warn(aTHX_ "Debug leaking scalars child failed%s%.*s with errno"
524 " %d: %s", (*buffer ? " at " : ""), (int) *buffer, buffer + 1,
525 returned_errno, strerror(returned_errno));
531 =for apidoc perl_destruct
533 Shuts down a Perl interpreter. See L<perlembed>.
542 VOL int destruct_level; /* 0=none, 1=full, 2=full with checks */
544 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
548 PERL_UNUSED_ARG(my_perl);
550 /* wait for all pseudo-forked children to finish */
551 PERL_WAIT_FOR_CHILDREN;
553 destruct_level = PL_perl_destruct_level;
556 const char * const s = PerlEnv_getenv("PERL_DESTRUCT_LEVEL");
558 const int i = atoi(s);
559 if (destruct_level < i)
565 if (PL_exit_flags & PERL_EXIT_DESTRUCT_END) {
571 if (PL_endav && !PL_minus_c)
572 call_list(PL_scopestack_ix, PL_endav);
578 /* Need to flush since END blocks can produce output */
581 if (CALL_FPTR(PL_threadhook)(aTHX)) {
582 /* Threads hook has vetoed further cleanup */
583 PL_veto_cleanup = TRUE;
587 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
588 if (destruct_level != 0) {
589 /* Fork here to create a child. Our child's job is to preserve the
590 state of scalars prior to destruction, so that we can instruct it
591 to dump any scalars that we later find have leaked.
592 There's no subtlety in this code - it assumes POSIX, and it doesn't
596 if(socketpair(AF_UNIX, SOCK_STREAM, 0, fd)) {
597 perror("Debug leaking scalars socketpair failed");
603 perror("Debug leaking scalars fork failed");
607 /* We are the child */
608 const int sock = fd[1];
609 const int debug_fd = PerlIO_fileno(Perl_debug_log);
612 /* Our success message is an integer 0, and a char 0 */
613 static const char success[sizeof(int) + 1];
617 /* We need to close all other file descriptors otherwise we end up
618 with interesting hangs, where the parent closes its end of a
619 pipe, and sits waiting for (another) child to terminate. Only
620 that child never terminates, because it never gets EOF, because
621 we also have the far end of the pipe open. We even need to
622 close the debugging fd, because sometimes it happens to be one
623 end of a pipe, and a process is waiting on the other end for
624 EOF. Normally it would be closed at some point earlier in
625 destruction, but if we happen to cause the pipe to remain open,
626 EOF never occurs, and we get an infinite hang. Hence all the
627 games to pass in a file descriptor if it's actually needed. */
629 f = sysconf(_SC_OPEN_MAX);
631 where = "sysconf failed";
642 union control_un control;
645 struct cmsghdr *cmptr;
649 msg.msg_control = control.control;
650 msg.msg_controllen = sizeof(control.control);
651 /* We're a connected socket so we don't need a source */
655 msg.msg_iovlen = sizeof(vec)/sizeof(vec[0]);
657 vec[0].iov_base = (void*)⌖
658 vec[0].iov_len = sizeof(target);
660 got = recvmsg(sock, &msg, 0);
665 where = "recv failed";
668 if(got < sizeof(target)) {
669 where = "short recv";
673 if(!(cmptr = CMSG_FIRSTHDR(&msg))) {
677 if(cmptr->cmsg_len != CMSG_LEN(sizeof(int))) {
678 where = "wrong cmsg_len";
681 if(cmptr->cmsg_level != SOL_SOCKET) {
682 where = "wrong cmsg_level";
685 if(cmptr->cmsg_type != SCM_RIGHTS) {
686 where = "wrong cmsg_type";
690 got_fd = *(int*)CMSG_DATA(cmptr);
691 /* For our last little bit of trickery, put the file descriptor
692 back into Perl_debug_log, as if we never actually closed it
694 if(got_fd != debug_fd) {
695 if (dup2(got_fd, debug_fd) == -1) {
702 PerlIO_flush(Perl_debug_log);
704 got = write(sock, &success, sizeof(success));
707 where = "write failed";
710 if(got < sizeof(success)) {
711 where = "short write";
718 int send_errno = errno;
719 unsigned char length = (unsigned char) strlen(where);
720 struct iovec failure[3] = {
721 {(void*)&send_errno, sizeof(send_errno)},
723 {(void*)where, length}
725 int got = writev(sock, failure, 3);
726 /* Bad news travels fast. Faster than data. We'll get a SIGPIPE
727 in the parent if we try to read from the socketpair after the
728 child has exited, even if there was data to read.
729 So sleep a bit to give the parent a fighting chance of
732 _exit((got == -1) ? errno : 0);
736 PL_dumper_fd = fd[0];
741 /* We must account for everything. */
743 /* Destroy the main CV and syntax tree */
744 /* Do this now, because destroying ops can cause new SVs to be generated
745 in Perl_pad_swipe, and when running with -DDEBUG_LEAKING_SCALARS they
746 PL_curcop to point to a valid op from which the filename structure
748 PL_curcop = &PL_compiling;
750 /* ensure comppad/curpad to refer to main's pad */
751 if (CvPADLIST(PL_main_cv)) {
752 PAD_SET_CUR_NOSAVE(CvPADLIST(PL_main_cv), 1);
754 op_free(PL_main_root);
757 PL_main_start = NULL;
758 SvREFCNT_dec(PL_main_cv);
762 /* Tell PerlIO we are about to tear things apart in case
763 we have layers which are using resources that should
767 PerlIO_destruct(aTHX);
769 if (PL_sv_objcount) {
771 * Try to destruct global references. We do this first so that the
772 * destructors and destructees still exist. Some sv's might remain.
773 * Non-referenced objects are on their own.
777 if (PL_defoutgv && !SvREFCNT(PL_defoutgv))
778 PL_defoutgv = NULL; /* may have been freed */
781 /* unhook hooks which will soon be, or use, destroyed data */
782 SvREFCNT_dec(PL_warnhook);
784 SvREFCNT_dec(PL_diehook);
787 /* call exit list functions */
788 while (PL_exitlistlen-- > 0)
789 PL_exitlist[PL_exitlistlen].fn(aTHX_ PL_exitlist[PL_exitlistlen].ptr);
791 Safefree(PL_exitlist);
796 /* jettison our possibly duplicated environment */
797 /* if PERL_USE_SAFE_PUTENV is defined environ will not have been copied
798 * so we certainly shouldn't free it here
801 #if defined(USE_ENVIRON_ARRAY) && !defined(PERL_USE_SAFE_PUTENV)
802 if (environ != PL_origenviron && !PL_use_safe_putenv
804 /* only main thread can free environ[0] contents */
805 && PL_curinterp == aTHX
811 for (i = 0; environ[i]; i++)
812 safesysfree(environ[i]);
814 /* Must use safesysfree() when working with environ. */
815 safesysfree(environ);
817 environ = PL_origenviron;
820 #endif /* !PERL_MICRO */
822 if (destruct_level == 0) {
824 DEBUG_P(debprofdump());
826 #if defined(PERLIO_LAYERS)
827 /* No more IO - including error messages ! */
828 PerlIO_cleanup(aTHX);
831 CopFILE_free(&PL_compiling);
832 CopSTASH_free(&PL_compiling);
834 /* The exit() function will do everything that needs doing. */
838 /* reset so print() ends up where we expect */
842 /* the syntax tree is shared between clones
843 * so op_free(PL_main_root) only ReREFCNT_dec's
844 * REGEXPs in the parent interpreter
845 * we need to manually ReREFCNT_dec for the clones
848 I32 i = AvFILLp(PL_regex_padav) + 1;
849 SV * const * const ary = AvARRAY(PL_regex_padav);
852 SV * const resv = ary[--i];
854 if (SvFLAGS(resv) & SVf_BREAK) {
855 /* this is PL_reg_curpm, already freed
856 * flag is set in regexec.c:S_regtry
858 SvFLAGS(resv) &= ~SVf_BREAK;
860 else if(SvREPADTMP(resv)) {
861 SvREPADTMP_off(resv);
863 else if(SvIOKp(resv)) {
864 REGEXP *re = INT2PTR(REGEXP *,SvIVX(resv));
869 SvREFCNT_dec(PL_regex_padav);
870 PL_regex_padav = NULL;
874 SvREFCNT_dec((SV*) PL_stashcache);
875 PL_stashcache = NULL;
877 /* loosen bonds of global variables */
880 (void)PerlIO_close(PL_rsfp);
884 /* Filters for program text */
885 SvREFCNT_dec(PL_rsfp_filters);
886 PL_rsfp_filters = NULL;
889 Safefree(PL_splitstr);
894 PL_preprocess = FALSE;
900 PL_doswitches = FALSE;
901 PL_dowarn = G_WARN_OFF;
902 PL_doextract = FALSE;
903 PL_sawampersand = FALSE; /* must save all match strings */
906 Safefree(PL_inplace);
908 SvREFCNT_dec(PL_patchlevel);
911 SvREFCNT_dec(PL_e_script);
917 /* magical thingies */
919 SvREFCNT_dec(PL_ofs_sv); /* $, */
922 SvREFCNT_dec(PL_ors_sv); /* $\ */
925 SvREFCNT_dec(PL_rs); /* $/ */
928 Safefree(PL_osname); /* $^O */
931 SvREFCNT_dec(PL_statname);
935 /* defgv, aka *_ should be taken care of elsewhere */
937 /* clean up after study() */
938 SvREFCNT_dec(PL_lastscream);
939 PL_lastscream = NULL;
940 Safefree(PL_screamfirst);
942 Safefree(PL_screamnext);
946 Safefree(PL_efloatbuf);
950 /* startup and shutdown function lists */
951 SvREFCNT_dec(PL_beginav);
952 SvREFCNT_dec(PL_beginav_save);
953 SvREFCNT_dec(PL_endav);
954 SvREFCNT_dec(PL_checkav);
955 SvREFCNT_dec(PL_checkav_save);
956 SvREFCNT_dec(PL_unitcheckav);
957 SvREFCNT_dec(PL_unitcheckav_save);
958 SvREFCNT_dec(PL_initav);
960 PL_beginav_save = NULL;
963 PL_checkav_save = NULL;
964 PL_unitcheckav = NULL;
965 PL_unitcheckav_save = NULL;
968 /* shortcuts just get cleared */
977 PL_last_in_gv = NULL;
985 PL_DBassertion = NULL;
990 SvREFCNT_dec(PL_argvout_stack);
991 PL_argvout_stack = NULL;
993 SvREFCNT_dec(PL_modglobal);
995 SvREFCNT_dec(PL_preambleav);
996 PL_preambleav = NULL;
997 SvREFCNT_dec(PL_subname);
999 SvREFCNT_dec(PL_linestr);
1001 #ifdef PERL_USES_PL_PIDSTATUS
1002 SvREFCNT_dec(PL_pidstatus);
1003 PL_pidstatus = NULL;
1005 SvREFCNT_dec(PL_toptarget);
1006 PL_toptarget = NULL;
1007 SvREFCNT_dec(PL_bodytarget);
1008 PL_bodytarget = NULL;
1009 PL_formtarget = NULL;
1011 /* free locale stuff */
1012 #ifdef USE_LOCALE_COLLATE
1013 Safefree(PL_collation_name);
1014 PL_collation_name = NULL;
1017 #ifdef USE_LOCALE_NUMERIC
1018 Safefree(PL_numeric_name);
1019 PL_numeric_name = NULL;
1020 SvREFCNT_dec(PL_numeric_radix_sv);
1021 PL_numeric_radix_sv = NULL;
1024 /* clear utf8 character classes */
1025 SvREFCNT_dec(PL_utf8_alnum);
1026 SvREFCNT_dec(PL_utf8_alnumc);
1027 SvREFCNT_dec(PL_utf8_ascii);
1028 SvREFCNT_dec(PL_utf8_alpha);
1029 SvREFCNT_dec(PL_utf8_space);
1030 SvREFCNT_dec(PL_utf8_cntrl);
1031 SvREFCNT_dec(PL_utf8_graph);
1032 SvREFCNT_dec(PL_utf8_digit);
1033 SvREFCNT_dec(PL_utf8_upper);
1034 SvREFCNT_dec(PL_utf8_lower);
1035 SvREFCNT_dec(PL_utf8_print);
1036 SvREFCNT_dec(PL_utf8_punct);
1037 SvREFCNT_dec(PL_utf8_xdigit);
1038 SvREFCNT_dec(PL_utf8_mark);
1039 SvREFCNT_dec(PL_utf8_toupper);
1040 SvREFCNT_dec(PL_utf8_totitle);
1041 SvREFCNT_dec(PL_utf8_tolower);
1042 SvREFCNT_dec(PL_utf8_tofold);
1043 SvREFCNT_dec(PL_utf8_idstart);
1044 SvREFCNT_dec(PL_utf8_idcont);
1045 PL_utf8_alnum = NULL;
1046 PL_utf8_alnumc = NULL;
1047 PL_utf8_ascii = NULL;
1048 PL_utf8_alpha = NULL;
1049 PL_utf8_space = NULL;
1050 PL_utf8_cntrl = NULL;
1051 PL_utf8_graph = NULL;
1052 PL_utf8_digit = NULL;
1053 PL_utf8_upper = NULL;
1054 PL_utf8_lower = NULL;
1055 PL_utf8_print = NULL;
1056 PL_utf8_punct = NULL;
1057 PL_utf8_xdigit = NULL;
1058 PL_utf8_mark = NULL;
1059 PL_utf8_toupper = NULL;
1060 PL_utf8_totitle = NULL;
1061 PL_utf8_tolower = NULL;
1062 PL_utf8_tofold = NULL;
1063 PL_utf8_idstart = NULL;
1064 PL_utf8_idcont = NULL;
1066 if (!specialWARN(PL_compiling.cop_warnings))
1067 PerlMemShared_free(PL_compiling.cop_warnings);
1068 PL_compiling.cop_warnings = NULL;
1069 Perl_refcounted_he_free(aTHX_ PL_compiling.cop_hints_hash);
1070 PL_compiling.cop_hints_hash = NULL;
1071 CopFILE_free(&PL_compiling);
1072 CopSTASH_free(&PL_compiling);
1074 /* Prepare to destruct main symbol table. */
1079 SvREFCNT_dec(PL_curstname);
1080 PL_curstname = NULL;
1082 /* clear queued errors */
1083 SvREFCNT_dec(PL_errors);
1087 if (destruct_level >= 2 && ckWARN_d(WARN_INTERNAL)) {
1088 if (PL_scopestack_ix != 0)
1089 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
1090 "Unbalanced scopes: %ld more ENTERs than LEAVEs\n",
1091 (long)PL_scopestack_ix);
1092 if (PL_savestack_ix != 0)
1093 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
1094 "Unbalanced saves: %ld more saves than restores\n",
1095 (long)PL_savestack_ix);
1096 if (PL_tmps_floor != -1)
1097 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced tmps: %ld more allocs than frees\n",
1098 (long)PL_tmps_floor + 1);
1099 if (cxstack_ix != -1)
1100 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced context: %ld more PUSHes than POPs\n",
1101 (long)cxstack_ix + 1);
1104 /* Now absolutely destruct everything, somehow or other, loops or no. */
1105 SvFLAGS(PL_fdpid) |= SVTYPEMASK; /* don't clean out pid table now */
1106 SvFLAGS(PL_strtab) |= SVTYPEMASK; /* don't clean out strtab now */
1108 /* the 2 is for PL_fdpid and PL_strtab */
1109 while (PL_sv_count > 2 && sv_clean_all())
1112 SvFLAGS(PL_fdpid) &= ~SVTYPEMASK;
1113 SvFLAGS(PL_fdpid) |= SVt_PVAV;
1114 SvFLAGS(PL_strtab) &= ~SVTYPEMASK;
1115 SvFLAGS(PL_strtab) |= SVt_PVHV;
1117 AvREAL_off(PL_fdpid); /* no surviving entries */
1118 SvREFCNT_dec(PL_fdpid); /* needed in io_close() */
1121 #ifdef HAVE_INTERP_INTERN
1125 /* Destruct the global string table. */
1127 /* Yell and reset the HeVAL() slots that are still holding refcounts,
1128 * so that sv_free() won't fail on them.
1129 * Now that the global string table is using a single hunk of memory
1130 * for both HE and HEK, we either need to explicitly unshare it the
1131 * correct way, or actually free things here.
1134 const I32 max = HvMAX(PL_strtab);
1135 HE * const * const array = HvARRAY(PL_strtab);
1136 HE *hent = array[0];
1139 if (hent && ckWARN_d(WARN_INTERNAL)) {
1140 HE * const next = HeNEXT(hent);
1141 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
1142 "Unbalanced string table refcount: (%ld) for \"%s\"",
1143 (long)hent->he_valu.hent_refcount, HeKEY(hent));
1150 hent = array[riter];
1155 HvARRAY(PL_strtab) = 0;
1156 HvTOTALKEYS(PL_strtab) = 0;
1157 HvFILL(PL_strtab) = 0;
1159 SvREFCNT_dec(PL_strtab);
1162 /* free the pointer tables used for cloning */
1163 ptr_table_free(PL_ptr_table);
1164 PL_ptr_table = (PTR_TBL_t*)NULL;
1167 /* free special SVs */
1169 SvREFCNT(&PL_sv_yes) = 0;
1170 sv_clear(&PL_sv_yes);
1171 SvANY(&PL_sv_yes) = NULL;
1172 SvFLAGS(&PL_sv_yes) = 0;
1174 SvREFCNT(&PL_sv_no) = 0;
1175 sv_clear(&PL_sv_no);
1176 SvANY(&PL_sv_no) = NULL;
1177 SvFLAGS(&PL_sv_no) = 0;
1181 for (i=0; i<=2; i++) {
1182 SvREFCNT(PERL_DEBUG_PAD(i)) = 0;
1183 sv_clear(PERL_DEBUG_PAD(i));
1184 SvANY(PERL_DEBUG_PAD(i)) = NULL;
1185 SvFLAGS(PERL_DEBUG_PAD(i)) = 0;
1189 if (PL_sv_count != 0 && ckWARN_d(WARN_INTERNAL))
1190 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Scalars leaked: %ld\n", (long)PL_sv_count);
1192 #ifdef DEBUG_LEAKING_SCALARS
1193 if (PL_sv_count != 0) {
1198 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
1199 svend = &sva[SvREFCNT(sva)];
1200 for (sv = sva + 1; sv < svend; ++sv) {
1201 if (SvTYPE(sv) != SVTYPEMASK) {
1202 PerlIO_printf(Perl_debug_log, "leaked: sv=0x%p"
1204 " refcnt=%"UVuf pTHX__FORMAT "\n"
1205 "\tallocated at %s:%d %s %s%s\n",
1206 (void*)sv, sv->sv_flags, sv->sv_refcnt pTHX__VALUE,
1207 sv->sv_debug_file ? sv->sv_debug_file : "(unknown)",
1209 sv->sv_debug_inpad ? "for" : "by",
1210 sv->sv_debug_optype ?
1211 PL_op_name[sv->sv_debug_optype]: "(none)",
1212 sv->sv_debug_cloned ? " (cloned)" : ""
1214 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1215 Perl_dump_sv_child(aTHX_ sv);
1221 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1225 /* Wait for up to 4 seconds for child to terminate.
1226 This seems to be the least effort way of timing out on reaping
1228 struct timeval waitfor = {4, 0};
1229 int sock = PL_dumper_fd;
1233 FD_SET(sock, &rset);
1234 select(sock + 1, &rset, NULL, NULL, &waitfor);
1235 waitpid(child, &status, WNOHANG);
1243 #if defined(PERLIO_LAYERS)
1244 /* No more IO - including error messages ! */
1245 PerlIO_cleanup(aTHX);
1248 /* sv_undef needs to stay immortal until after PerlIO_cleanup
1249 as currently layers use it rather than NULL as a marker
1250 for no arg - and will try and SvREFCNT_dec it.
1252 SvREFCNT(&PL_sv_undef) = 0;
1253 SvREADONLY_off(&PL_sv_undef);
1255 Safefree(PL_origfilename);
1256 PL_origfilename = NULL;
1257 Safefree(PL_reg_start_tmp);
1258 PL_reg_start_tmp = (char**)NULL;
1259 PL_reg_start_tmpl = 0;
1260 Safefree(PL_reg_curpm);
1261 Safefree(PL_reg_poscache);
1262 free_tied_hv_pool();
1263 Safefree(PL_op_mask);
1264 Safefree(PL_psig_ptr);
1265 PL_psig_ptr = (SV**)NULL;
1266 Safefree(PL_psig_name);
1267 PL_psig_name = (SV**)NULL;
1268 Safefree(PL_bitcount);
1270 Safefree(PL_psig_pend);
1271 PL_psig_pend = (int*)NULL;
1274 PL_tainting = FALSE;
1275 PL_taint_warn = FALSE;
1276 PL_hints = 0; /* Reset hints. Should hints be per-interpreter ? */
1279 DEBUG_P(debprofdump());
1281 #ifdef USE_REENTRANT_API
1282 Perl_reentrant_free(aTHX);
1287 while (PL_regmatch_slab) {
1288 regmatch_slab *s = PL_regmatch_slab;
1289 PL_regmatch_slab = PL_regmatch_slab->next;
1293 /* As the absolutely last thing, free the non-arena SV for mess() */
1296 /* we know that type == SVt_PVMG */
1298 /* it could have accumulated taint magic */
1301 for (mg = SvMAGIC(PL_mess_sv); mg; mg = moremagic) {
1302 moremagic = mg->mg_moremagic;
1303 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global
1305 Safefree(mg->mg_ptr);
1309 /* we know that type >= SVt_PV */
1310 SvPV_free(PL_mess_sv);
1311 Safefree(SvANY(PL_mess_sv));
1312 Safefree(PL_mess_sv);
1319 =for apidoc perl_free
1321 Releases a Perl interpreter. See L<perlembed>.
1331 if (PL_veto_cleanup)
1334 #ifdef PERL_TRACK_MEMPOOL
1337 * Don't free thread memory if PERL_DESTRUCT_LEVEL is set to a non-zero
1338 * value as we're probably hunting memory leaks then
1340 const char * const s = PerlEnv_getenv("PERL_DESTRUCT_LEVEL");
1341 if (!s || atoi(s) == 0) {
1342 /* Emulate the PerlHost behaviour of free()ing all memory allocated in this
1343 thread at thread exit. */
1344 while(aTHXx->Imemory_debug_header.next != &(aTHXx->Imemory_debug_header))
1345 safesysfree(sTHX + (char *)(aTHXx->Imemory_debug_header.next));
1350 #if defined(WIN32) || defined(NETWARE)
1351 # if defined(PERL_IMPLICIT_SYS)
1354 void *host = nw_internal_host;
1356 void *host = w32_internal_host;
1358 PerlMem_free(aTHXx);
1360 nw_delete_internal_host(host);
1362 win32_delete_internal_host(host);
1366 PerlMem_free(aTHXx);
1369 PerlMem_free(aTHXx);
1373 #if defined(USE_ITHREADS)
1374 /* provide destructors to clean up the thread key when libperl is unloaded */
1375 #ifndef WIN32 /* handled during DLL_PROCESS_DETACH in win32/perllib.c */
1377 #if defined(__hpux) && !(defined(__ux_version) && __ux_version <= 1020) && !defined(__GNUC__)
1378 #pragma fini "perl_fini"
1379 #elif defined(__sun) && !defined(__GNUC__)
1380 #pragma fini (perl_fini)
1384 #if defined(__GNUC__)
1385 __attribute__((destructor))
1390 if (PL_curinterp && !PL_veto_cleanup)
1395 #endif /* THREADS */
1398 Perl_call_atexit(pTHX_ ATEXIT_t fn, void *ptr)
1401 Renew(PL_exitlist, PL_exitlistlen+1, PerlExitListEntry);
1402 PL_exitlist[PL_exitlistlen].fn = fn;
1403 PL_exitlist[PL_exitlistlen].ptr = ptr;
1407 #ifdef HAS_PROCSELFEXE
1408 /* This is a function so that we don't hold on to MAXPATHLEN
1409 bytes of stack longer than necessary
1412 S_procself_val(pTHX_ SV *sv, const char *arg0)
1414 char buf[MAXPATHLEN];
1415 int len = readlink(PROCSELFEXE_PATH, buf, sizeof(buf) - 1);
1417 /* On Playstation2 Linux V1.0 (kernel 2.2.1) readlink(/proc/self/exe)
1418 includes a spurious NUL which will cause $^X to fail in system
1419 or backticks (this will prevent extensions from being built and
1420 many tests from working). readlink is not meant to add a NUL.
1421 Normal readlink works fine.
1423 if (len > 0 && buf[len-1] == '\0') {
1427 /* FreeBSD's implementation is acknowledged to be imperfect, sometimes
1428 returning the text "unknown" from the readlink rather than the path
1429 to the executable (or returning an error from the readlink). Any valid
1430 path has a '/' in it somewhere, so use that to validate the result.
1431 See http://www.freebsd.org/cgi/query-pr.cgi?pr=35703
1433 if (len > 0 && memchr(buf, '/', len)) {
1434 sv_setpvn(sv,buf,len);
1440 #endif /* HAS_PROCSELFEXE */
1443 S_set_caret_X(pTHX) {
1445 GV* tmpgv = gv_fetchpvs("\030", GV_ADD|GV_NOTQUAL, SVt_PV); /* $^X */
1447 #ifdef HAS_PROCSELFEXE
1448 S_procself_val(aTHX_ GvSV(tmpgv), PL_origargv[0]);
1451 sv_setpv(GvSVn(tmpgv), os2_execname(aTHX));
1453 sv_setpv(GvSVn(tmpgv),PL_origargv[0]);
1460 =for apidoc perl_parse
1462 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
1468 perl_parse(pTHXx_ XSINIT_t xsinit, int argc, char **argv, char **env)
1475 PERL_UNUSED_ARG(my_perl);
1477 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
1480 Perl_croak(aTHX_ "suidperl is no longer needed since the kernel can now execute\n\
1481 setuid perl scripts securely.\n");
1482 #endif /* IAMSUID */
1485 #if defined(USE_HASH_SEED) || defined(USE_HASH_SEED_EXPLICIT)
1486 /* [perl #22371] Algorimic Complexity Attack on Perl 5.6.1, 5.8.0
1487 * This MUST be done before any hash stores or fetches take place.
1488 * If you set PL_rehash_seed (and assumedly also PL_rehash_seed_set)
1489 * yourself, it is your responsibility to provide a good random seed!
1490 * You can also define PERL_HASH_SEED in compile time, see hv.h. */
1491 if (!PL_rehash_seed_set)
1492 PL_rehash_seed = get_hash_seed();
1494 const char * const s = PerlEnv_getenv("PERL_HASH_SEED_DEBUG");
1496 if (s && (atoi(s) == 1))
1497 PerlIO_printf(Perl_debug_log, "HASH_SEED = %"UVuf"\n", PL_rehash_seed);
1499 #endif /* #if defined(USE_HASH_SEED) || defined(USE_HASH_SEED_EXPLICIT) */
1504 if (PL_origalen != 0) {
1505 PL_origalen = 1; /* don't use old PL_origalen if perl_parse() is called again */
1508 /* Set PL_origalen be the sum of the contiguous argv[]
1509 * elements plus the size of the env in case that it is
1510 * contiguous with the argv[]. This is used in mg.c:Perl_magic_set()
1511 * as the maximum modifiable length of $0. In the worst case
1512 * the area we are able to modify is limited to the size of
1513 * the original argv[0]. (See below for 'contiguous', though.)
1515 const char *s = NULL;
1518 ~(UV)(PTRSIZE == 4 ? 3 : PTRSIZE == 8 ? 7 : PTRSIZE == 16 ? 15 : 0);
1519 /* Do the mask check only if the args seem like aligned. */
1521 (mask < ~(UV)0) && ((PTR2UV(argv[0]) & mask) == PTR2UV(argv[0]));
1523 /* See if all the arguments are contiguous in memory. Note
1524 * that 'contiguous' is a loose term because some platforms
1525 * align the argv[] and the envp[]. If the arguments look
1526 * like non-aligned, assume that they are 'strictly' or
1527 * 'traditionally' contiguous. If the arguments look like
1528 * aligned, we just check that they are within aligned
1529 * PTRSIZE bytes. As long as no system has something bizarre
1530 * like the argv[] interleaved with some other data, we are
1531 * fine. (Did I just evoke Murphy's Law?) --jhi */
1532 if (PL_origargv && PL_origargc >= 1 && (s = PL_origargv[0])) {
1534 for (i = 1; i < PL_origargc; i++) {
1535 if ((PL_origargv[i] == s + 1
1537 || PL_origargv[i] == s + 2
1542 (PL_origargv[i] > s &&
1544 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1554 /* Can we grab env area too to be used as the area for $0? */
1555 if (s && PL_origenviron) {
1556 if ((PL_origenviron[0] == s + 1)
1559 (PL_origenviron[0] > s &&
1560 PL_origenviron[0] <=
1561 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1564 #ifndef OS2 /* ENVIRON is read by the kernel too. */
1565 s = PL_origenviron[0];
1568 my_setenv("NoNe SuCh", NULL);
1569 /* Force copy of environment. */
1570 for (i = 1; PL_origenviron[i]; i++) {
1571 if (PL_origenviron[i] == s + 1
1574 (PL_origenviron[i] > s &&
1575 PL_origenviron[i] <=
1576 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1579 s = PL_origenviron[i];
1587 PL_origalen = s ? s - PL_origargv[0] + 1 : 0;
1592 /* Come here if running an undumped a.out. */
1594 PL_origfilename = savepv(argv[0]);
1595 PL_do_undump = FALSE;
1596 cxstack_ix = -1; /* start label stack again */
1598 assert (!PL_tainted);
1600 S_set_caret_X(aTHX);
1602 init_postdump_symbols(argc,argv,env);
1607 op_free(PL_main_root);
1608 PL_main_root = NULL;
1610 PL_main_start = NULL;
1611 SvREFCNT_dec(PL_main_cv);
1615 oldscope = PL_scopestack_ix;
1616 PL_dowarn = G_WARN_OFF;
1621 parse_body(env,xsinit);
1623 call_list(oldscope, PL_unitcheckav);
1625 call_list(oldscope, PL_checkav);
1632 /* my_exit() was called */
1633 while (PL_scopestack_ix > oldscope)
1636 PL_curstash = PL_defstash;
1638 call_list(oldscope, PL_unitcheckav);
1640 call_list(oldscope, PL_checkav);
1644 PerlIO_printf(Perl_error_log, "panic: top_env\n");
1653 S_parse_body(pTHX_ char **env, XSINIT_t xsinit)
1656 int argc = PL_origargc;
1657 char **argv = PL_origargv;
1658 const char *scriptname = NULL;
1659 VOL bool dosearch = FALSE;
1660 const char *validarg = "";
1662 register char *s, c;
1663 const char *cddir = NULL;
1664 #ifdef USE_SITECUSTOMIZE
1665 bool minus_f = FALSE;
1668 sv_setpvn(PL_linestr,"",0);
1669 sv = newSVpvs(""); /* first used for -I flags */
1673 for (argc--,argv++; argc > 0; argc--,argv++) {
1674 if (argv[0][0] != '-' || !argv[0][1])
1678 validarg = " PHOOEY ";
1682 * Can we rely on the kernel to start scripts with argv[1] set to
1683 * contain all #! line switches (the whole line)? (argv[0] is set to
1684 * the interpreter name, argv[2] to the script name; argv[3] and
1685 * above may contain other arguments.)
1692 #ifndef PERL_STRICT_CR
1717 if ((s = moreswitches(s)))
1722 CHECK_MALLOC_TOO_LATE_FOR('t');
1723 if( !PL_tainting ) {
1724 PL_taint_warn = TRUE;
1730 CHECK_MALLOC_TOO_LATE_FOR('T');
1732 PL_taint_warn = FALSE;
1740 #ifdef MACOS_TRADITIONAL
1741 /* ignore -e for Dev:Pseudo argument */
1742 if (argv[1] && !strcmp(argv[1], "Dev:Pseudo"))
1745 forbid_setid('e', -1);
1747 PL_e_script = newSVpvs("");
1748 filter_add(read_e_script, NULL);
1751 sv_catpv(PL_e_script, s);
1753 sv_catpv(PL_e_script, argv[1]);
1757 Perl_croak(aTHX_ "No code specified for -%c", c);
1758 sv_catpvs(PL_e_script, "\n");
1762 #ifdef USE_SITECUSTOMIZE
1768 case 'I': /* -I handled both here and in moreswitches() */
1769 forbid_setid('I', -1);
1770 if (!*++s && (s=argv[1]) != NULL) {
1774 STRLEN len = strlen(s);
1775 const char * const p = savepvn(s, len);
1776 incpush(p, TRUE, TRUE, FALSE, FALSE);
1777 sv_catpvs(sv, "-I");
1778 sv_catpvn(sv, p, len);
1783 Perl_croak(aTHX_ "No directory specified for -I");
1786 forbid_setid('P', -1);
1787 PL_preprocess = TRUE;
1791 forbid_setid('S', -1);
1799 Perl_av_create_and_push(aTHX_ &PL_preambleav, newSVpvs("use Config;"));
1803 opts_prog = newSVpvs("print Config::myconfig(),");
1805 sv_catpvs(opts_prog,"\"\\nCharacteristics of this PERLSHR image: \\n\",");
1807 sv_catpvs(opts_prog,"\"\\nCharacteristics of this binary (from libperl): \\n\",");
1809 opts = SvCUR(opts_prog);
1811 Perl_sv_catpv(aTHX_ opts_prog,"\" Compile-time options:"
1815 # ifdef DEBUG_LEAKING_SCALARS
1816 " DEBUG_LEAKING_SCALARS"
1818 # ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1819 " DEBUG_LEAKING_SCALARS_FORK_DUMP"
1821 # ifdef FAKE_THREADS
1824 # ifdef MULTIPLICITY
1833 # ifdef PERL_DONT_CREATE_GVSV
1834 " PERL_DONT_CREATE_GVSV"
1836 # ifdef PERL_GLOBAL_STRUCT
1837 " PERL_GLOBAL_STRUCT"
1839 # ifdef PERL_IMPLICIT_CONTEXT
1840 " PERL_IMPLICIT_CONTEXT"
1842 # ifdef PERL_IMPLICIT_SYS
1843 " PERL_IMPLICIT_SYS"
1848 # ifdef PERL_MALLOC_WRAP
1851 # ifdef PERL_NEED_APPCTX
1854 # ifdef PERL_NEED_TIMESBASE
1855 " PERL_NEED_TIMESBASE"
1857 # ifdef PERL_OLD_COPY_ON_WRITE
1858 " PERL_OLD_COPY_ON_WRITE"
1860 # ifdef PERL_TRACK_MEMPOOL
1861 " PERL_TRACK_MEMPOOL"
1863 # ifdef PERL_USE_SAFE_PUTENV
1864 " PERL_USE_SAFE_PUTENV"
1866 #ifdef PERL_USES_PL_PIDSTATUS
1867 " PERL_USES_PL_PIDSTATUS"
1869 # ifdef PL_OP_SLAB_ALLOC
1872 # ifdef THREADS_HAVE_PIDS
1873 " THREADS_HAVE_PIDS"
1875 # ifdef USE_64_BIT_ALL
1878 # ifdef USE_64_BIT_INT
1881 # ifdef USE_ITHREADS
1884 # ifdef USE_LARGE_FILES
1887 # ifdef USE_LONG_DOUBLE
1893 # ifdef USE_REENTRANT_API
1894 " USE_REENTRANT_API"
1899 # ifdef USE_SITECUSTOMIZE
1900 " USE_SITECUSTOMIZE"
1907 while (SvCUR(opts_prog) > opts+76) {
1908 /* find last space after "options: " and before col 76
1912 char * const pv = SvPV_nolen(opts_prog);
1913 const char c = pv[opts+76];
1915 space = strrchr(pv+opts+26, ' ');
1917 if (!space) break; /* "Can't happen" */
1919 /* break the line before that space */
1922 Perl_sv_insert(aTHX_ opts_prog, opts, 0,
1923 STR_WITH_LEN("\\n "));
1926 sv_catpvs(opts_prog,"\\n\",");
1928 #if defined(LOCAL_PATCH_COUNT)
1929 if (LOCAL_PATCH_COUNT > 0) {
1931 sv_catpvs(opts_prog,
1932 "\" Locally applied patches:\\n\",");
1933 for (i = 1; i <= LOCAL_PATCH_COUNT; i++) {
1934 if (PL_localpatches[i])
1935 Perl_sv_catpvf(aTHX_ opts_prog,"q%c\t%s\n%c,",
1936 0, PL_localpatches[i], 0);
1940 Perl_sv_catpvf(aTHX_ opts_prog,
1941 "\" Built under %s\\n\"",OSNAME);
1944 Perl_sv_catpvf(aTHX_ opts_prog,
1945 ",\" Compiled at %s %s\\n\"",__DATE__,
1948 Perl_sv_catpvf(aTHX_ opts_prog,",\" Compiled on %s\\n\"",
1952 sv_catpvs(opts_prog, "; $\"=\"\\n \"; "
1953 "@env = map { \"$_=\\\"$ENV{$_}\\\"\" } "
1954 "sort grep {/^PERL/} keys %ENV; ");
1956 sv_catpvs(opts_prog,
1957 "push @env, \"CYGWIN=\\\"$ENV{CYGWIN}\\\"\";");
1959 sv_catpvs(opts_prog,
1960 "print \" \\%ENV:\\n @env\\n\" if @env;"
1961 "print \" \\@INC:\\n @INC\\n\";");
1965 opts_prog = Perl_newSVpvf(aTHX_
1966 "Config::config_vars(qw%c%s%c)",
1970 av_push(PL_preambleav, opts_prog);
1971 /* don't look for script or read stdin */
1972 scriptname = BIT_BUCKET;
1976 PL_doextract = TRUE;
1984 if (!*++s || isSPACE(*s)) {
1988 /* catch use of gnu style long options */
1989 if (strEQ(s, "version")) {
1993 if (strEQ(s, "help")) {
2000 Perl_croak(aTHX_ "Unrecognized switch: -%s (-h will show valid options)",s);
2006 #ifndef SECURE_INTERNAL_GETENV
2009 (s = PerlEnv_getenv("PERL5OPT")))
2011 const char *popt = s;
2014 if (*s == '-' && *(s+1) == 'T') {
2015 CHECK_MALLOC_TOO_LATE_FOR('T');
2017 PL_taint_warn = FALSE;
2020 char *popt_copy = NULL;
2033 if (!strchr("CDIMUdmtwA", *s))
2034 Perl_croak(aTHX_ "Illegal switch in PERL5OPT: -%c", *s);
2038 popt_copy = SvPVX(sv_2mortal(newSVpv(popt,0)));
2039 s = popt_copy + (s - popt);
2040 d = popt_copy + (d - popt);
2047 if( !PL_tainting ) {
2048 PL_taint_warn = TRUE;
2058 #ifdef USE_SITECUSTOMIZE
2060 (void)Perl_av_create_and_unshift_one(aTHX_ &PL_preambleav,
2061 Perl_newSVpvf(aTHX_ "BEGIN { do '%s/sitecustomize.pl' }", SITELIB_EXP));
2066 scriptname = argv[0];
2069 scriptname = BIT_BUCKET; /* don't look for script or read stdin */
2071 else if (scriptname == NULL) {
2073 if ( PerlLIO_isatty(PerlIO_fileno(PerlIO_stdin())) )
2079 /* Set $^X early so that it can be used for relocatable paths in @INC */
2080 assert (!PL_tainted);
2082 S_set_caret_X(aTHX);
2089 = open_script(scriptname, dosearch, sv, &suidscript);
2091 validate_suid(validarg, scriptname, fdscript, suidscript);
2094 # if defined(SIGCHLD) || defined(SIGCLD)
2097 # define SIGCHLD SIGCLD
2099 Sighandler_t sigstate = rsignal_state(SIGCHLD);
2100 if (sigstate == (Sighandler_t) SIG_IGN) {
2101 if (ckWARN(WARN_SIGNAL))
2102 Perl_warner(aTHX_ packWARN(WARN_SIGNAL),
2103 "Can't ignore signal CHLD, forcing to default");
2104 (void)rsignal(SIGCHLD, (Sighandler_t)SIG_DFL);
2111 #ifdef MACOS_TRADITIONAL
2112 || gMacPerl_AlwaysExtract
2116 /* This will croak if suidscript is >= 0, as -x cannot be used with
2118 forbid_setid('x', suidscript);
2119 /* Hence you can't get here if suidscript >= 0 */
2122 if (cddir && PerlDir_chdir( (char *)cddir ) < 0)
2123 Perl_croak(aTHX_ "Can't chdir to %s",cddir);
2127 PL_main_cv = PL_compcv = (CV*)newSV(0);
2128 sv_upgrade((SV *)PL_compcv, SVt_PVCV);
2129 CvUNIQUE_on(PL_compcv);
2131 CvPADLIST(PL_compcv) = pad_new(0);
2134 boot_core_UNIVERSAL();
2135 boot_core_xsutils();
2138 (*xsinit)(aTHX); /* in case linked C routines want magical variables */
2140 #if defined(VMS) || defined(WIN32) || defined(DJGPP) || defined(__CYGWIN__) || defined(EPOC) || defined(SYMBIAN)
2146 # ifdef HAS_SOCKS5_INIT
2147 socks5_init(argv[0]);
2153 init_predump_symbols();
2154 /* init_postdump_symbols not currently designed to be called */
2155 /* more than once (ENV isn't cleared first, for example) */
2156 /* But running with -u leaves %ENV & @ARGV undefined! XXX */
2158 init_postdump_symbols(argc,argv,env);
2160 /* PL_unicode is turned on by -C, or by $ENV{PERL_UNICODE},
2161 * or explicitly in some platforms.
2162 * locale.c:Perl_init_i18nl10n() if the environment
2163 * look like the user wants to use UTF-8. */
2164 #if defined(__SYMBIAN32__)
2165 PL_unicode = PERL_UNICODE_STD_FLAG; /* See PERL_SYMBIAN_CONSOLE_UTF8. */
2168 /* Requires init_predump_symbols(). */
2169 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
2174 /* Turn on UTF-8-ness on STDIN, STDOUT, STDERR
2175 * and the default open disciplines. */
2176 if ((PL_unicode & PERL_UNICODE_STDIN_FLAG) &&
2177 PL_stdingv && (io = GvIO(PL_stdingv)) &&
2179 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2180 if ((PL_unicode & PERL_UNICODE_STDOUT_FLAG) &&
2181 PL_defoutgv && (io = GvIO(PL_defoutgv)) &&
2183 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2184 if ((PL_unicode & PERL_UNICODE_STDERR_FLAG) &&
2185 PL_stderrgv && (io = GvIO(PL_stderrgv)) &&
2187 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2188 if ((PL_unicode & PERL_UNICODE_INOUT_FLAG) &&
2189 (sv = GvSV(gv_fetchpvs("\017PEN", GV_ADD|GV_NOTQUAL,
2191 U32 in = PL_unicode & PERL_UNICODE_IN_FLAG;
2192 U32 out = PL_unicode & PERL_UNICODE_OUT_FLAG;
2195 sv_setpvn(sv, ":utf8\0:utf8", 11);
2197 sv_setpvn(sv, ":utf8\0", 6);
2200 sv_setpvn(sv, "\0:utf8", 6);
2206 if ((s = PerlEnv_getenv("PERL_SIGNALS"))) {
2207 if (strEQ(s, "unsafe"))
2208 PL_signals |= PERL_SIGNALS_UNSAFE_FLAG;
2209 else if (strEQ(s, "safe"))
2210 PL_signals &= ~PERL_SIGNALS_UNSAFE_FLAG;
2212 Perl_croak(aTHX_ "PERL_SIGNALS illegal: \"%s\"", s);
2216 if ((s = PerlEnv_getenv("PERL_XMLDUMP"))) {
2220 PL_xmlfp = PerlIO_stdout();
2222 PL_xmlfp = PerlIO_open(s, "w");
2224 Perl_croak(aTHX_ "Can't open %s", s);
2226 my_setenv("PERL_XMLDUMP", Nullch); /* hide from subprocs */
2228 if ((s = PerlEnv_getenv("PERL_MADSKILLS"))) {
2229 PL_madskills = atoi(s);
2230 my_setenv("PERL_MADSKILLS", Nullch); /* hide from subprocs */
2236 /* now parse the script */
2238 SETERRNO(0,SS_NORMAL);
2240 #ifdef MACOS_TRADITIONAL
2241 if (gMacPerl_SyntaxError = (yyparse() || PL_error_count)) {
2243 Perl_croak(aTHX_ "%s had compilation errors.\n", MacPerl_MPWFileName(PL_origfilename));
2245 Perl_croak(aTHX_ "Execution of %s aborted due to compilation errors.\n",
2246 MacPerl_MPWFileName(PL_origfilename));
2250 if (yyparse() || PL_error_count) {
2252 Perl_croak(aTHX_ "%s had compilation errors.\n", PL_origfilename);
2254 Perl_croak(aTHX_ "Execution of %s aborted due to compilation errors.\n",
2259 CopLINE_set(PL_curcop, 0);
2260 PL_curstash = PL_defstash;
2261 PL_preprocess = FALSE;
2263 SvREFCNT_dec(PL_e_script);
2271 SAVECOPFILE(PL_curcop);
2272 SAVECOPLINE(PL_curcop);
2273 gv_check(PL_defstash);
2280 if ((s=PerlEnv_getenv("PERL_DEBUG_MSTATS")) && atoi(s) >= 2)
2281 dump_mstats("after compilation:");
2290 =for apidoc perl_run
2292 Tells a Perl interpreter to run. See L<perlembed>.
2305 PERL_UNUSED_ARG(my_perl);
2307 oldscope = PL_scopestack_ix;
2315 cxstack_ix = -1; /* start context stack again */
2317 case 0: /* normal completion */
2321 case 2: /* my_exit() */
2322 while (PL_scopestack_ix > oldscope)
2325 PL_curstash = PL_defstash;
2326 if (!(PL_exit_flags & PERL_EXIT_DESTRUCT_END) &&
2327 PL_endav && !PL_minus_c)
2328 call_list(oldscope, PL_endav);
2330 if (PerlEnv_getenv("PERL_DEBUG_MSTATS"))
2331 dump_mstats("after execution: ");
2337 POPSTACK_TO(PL_mainstack);
2340 PerlIO_printf(Perl_error_log, "panic: restartop\n");
2352 S_run_body(pTHX_ I32 oldscope)
2355 DEBUG_r(PerlIO_printf(Perl_debug_log, "%s $` $& $' support.\n",
2356 PL_sawampersand ? "Enabling" : "Omitting"));
2358 if (!PL_restartop) {
2362 exit(0); /* less likely to core dump than my_exit(0) */
2365 DEBUG_x(dump_all());
2368 PERL_DEBUG(PerlIO_printf(Perl_debug_log, "\nEXECUTING...\n\n"));
2370 DEBUG_S(PerlIO_printf(Perl_debug_log, "main thread is 0x%"UVxf"\n",
2374 #ifdef MACOS_TRADITIONAL
2375 PerlIO_printf(Perl_error_log, "%s%s syntax OK\n",
2376 (gMacPerl_ErrorFormat ? "# " : ""),
2377 MacPerl_MPWFileName(PL_origfilename));
2379 PerlIO_printf(Perl_error_log, "%s syntax OK\n", PL_origfilename);
2383 if (PERLDB_SINGLE && PL_DBsingle)
2384 sv_setiv(PL_DBsingle, 1);
2386 call_list(oldscope, PL_initav);
2392 PL_op = PL_restartop;
2396 else if (PL_main_start) {
2397 CvDEPTH(PL_main_cv) = 1;
2398 PL_op = PL_main_start;
2406 =head1 SV Manipulation Functions
2408 =for apidoc p||get_sv
2410 Returns the SV of the specified Perl scalar. If C<create> is set and the
2411 Perl variable does not exist then it will be created. If C<create> is not
2412 set and the variable does not exist then NULL is returned.
2418 Perl_get_sv(pTHX_ const char *name, I32 create)
2421 gv = gv_fetchpv(name, create, SVt_PV);
2428 =head1 Array Manipulation Functions
2430 =for apidoc p||get_av
2432 Returns the AV of the specified Perl array. If C<create> is set and the
2433 Perl variable does not exist then it will be created. If C<create> is not
2434 set and the variable does not exist then NULL is returned.
2440 Perl_get_av(pTHX_ const char *name, I32 create)
2442 GV* const gv = gv_fetchpv(name, create, SVt_PVAV);
2451 =head1 Hash Manipulation Functions
2453 =for apidoc p||get_hv
2455 Returns the HV of the specified Perl hash. If C<create> is set and the
2456 Perl variable does not exist then it will be created. If C<create> is not
2457 set and the variable does not exist then NULL is returned.
2463 Perl_get_hv(pTHX_ const char *name, I32 create)
2465 GV* const gv = gv_fetchpv(name, create, SVt_PVHV);
2474 =head1 CV Manipulation Functions
2476 =for apidoc p||get_cvn_flags
2478 Returns the CV of the specified Perl subroutine. C<flags> are passed to
2479 C<gv_fetchpvn_flags>. If C<GV_ADD> is set and the Perl subroutine does not
2480 exist then it will be declared (which has the same effect as saying
2481 C<sub name;>). If C<GV_ADD> is not set and the subroutine does not exist
2482 then NULL is returned.
2484 =for apidoc p||get_cv
2486 Uses C<strlen> to get the length of C<name>, then calls C<get_cvn_flags>.
2492 Perl_get_cvn_flags(pTHX_ const char *name, STRLEN len, I32 flags)
2494 GV* const gv = gv_fetchpvn_flags(name, len, flags, SVt_PVCV);
2495 /* XXX this is probably not what they think they're getting.
2496 * It has the same effect as "sub name;", i.e. just a forward
2498 if ((flags & ~GV_NOADD_MASK) && !GvCVu(gv)) {
2499 SV *const sv = newSVpvn(name,len);
2500 SvFLAGS(sv) |= flags & SVf_UTF8;
2501 return newSUB(start_subparse(FALSE, 0),
2502 newSVOP(OP_CONST, 0, sv),
2511 Perl_get_cv(pTHX_ const char *name, I32 flags)
2513 return get_cvn_flags(name, strlen(name), flags);
2516 /* Be sure to refetch the stack pointer after calling these routines. */
2520 =head1 Callback Functions
2522 =for apidoc p||call_argv
2524 Performs a callback to the specified Perl sub. See L<perlcall>.
2530 Perl_call_argv(pTHX_ const char *sub_name, I32 flags, register char **argv)
2532 /* See G_* flags in cop.h */
2533 /* null terminated arg list */
2541 XPUSHs(sv_2mortal(newSVpv(*argv,0)));
2546 return call_pv(sub_name, flags);
2550 =for apidoc p||call_pv
2552 Performs a callback to the specified Perl sub. See L<perlcall>.
2558 Perl_call_pv(pTHX_ const char *sub_name, I32 flags)
2559 /* name of the subroutine */
2560 /* See G_* flags in cop.h */
2562 return call_sv((SV*)get_cv(sub_name, TRUE), flags);
2566 =for apidoc p||call_method
2568 Performs a callback to the specified Perl method. The blessed object must
2569 be on the stack. See L<perlcall>.
2575 Perl_call_method(pTHX_ const char *methname, I32 flags)
2576 /* name of the subroutine */
2577 /* See G_* flags in cop.h */
2579 return call_sv(sv_2mortal(newSVpv(methname,0)), flags | G_METHOD);
2582 /* May be called with any of a CV, a GV, or an SV containing the name. */
2584 =for apidoc p||call_sv
2586 Performs a callback to the Perl sub whose name is in the SV. See
2593 Perl_call_sv(pTHX_ SV *sv, I32 flags)
2594 /* See G_* flags in cop.h */
2597 LOGOP myop; /* fake syntax tree node */
2602 bool oldcatch = CATCH_GET;
2604 OP* const oldop = PL_op;
2607 if (flags & G_DISCARD) {
2612 Zero(&myop, 1, LOGOP);
2613 myop.op_next = NULL;
2614 if (!(flags & G_NOARGS))
2615 myop.op_flags |= OPf_STACKED;
2616 myop.op_flags |= ((flags & G_VOID) ? OPf_WANT_VOID :
2617 (flags & G_ARRAY) ? OPf_WANT_LIST :
2622 EXTEND(PL_stack_sp, 1);
2623 *++PL_stack_sp = sv;
2625 oldscope = PL_scopestack_ix;
2627 if (PERLDB_SUB && PL_curstash != PL_debstash
2628 /* Handle first BEGIN of -d. */
2629 && (PL_DBcv || (PL_DBcv = GvCV(PL_DBsub)))
2630 /* Try harder, since this may have been a sighandler, thus
2631 * curstash may be meaningless. */
2632 && (SvTYPE(sv) != SVt_PVCV || CvSTASH((CV*)sv) != PL_debstash)
2633 && !(flags & G_NODEBUG))
2634 PL_op->op_private |= OPpENTERSUB_DB;
2636 if (flags & G_METHOD) {
2637 Zero(&method_op, 1, UNOP);
2638 method_op.op_next = PL_op;
2639 method_op.op_ppaddr = PL_ppaddr[OP_METHOD];
2640 myop.op_ppaddr = PL_ppaddr[OP_ENTERSUB];
2641 PL_op = (OP*)&method_op;
2644 if (!(flags & G_EVAL)) {
2646 CALL_BODY_SUB((OP*)&myop);
2647 retval = PL_stack_sp - (PL_stack_base + oldmark);
2648 CATCH_SET(oldcatch);
2651 myop.op_other = (OP*)&myop;
2653 create_eval_scope(flags|G_FAKINGEVAL);
2661 CALL_BODY_SUB((OP*)&myop);
2662 retval = PL_stack_sp - (PL_stack_base + oldmark);
2663 if (!(flags & G_KEEPERR))
2664 sv_setpvn(ERRSV,"",0);
2670 /* my_exit() was called */
2671 PL_curstash = PL_defstash;
2674 if (PL_statusvalue && !(PL_exit_flags & PERL_EXIT_EXPECTED))
2675 Perl_croak(aTHX_ "Callback called exit");
2680 PL_op = PL_restartop;
2684 PL_stack_sp = PL_stack_base + oldmark;
2685 if (flags & G_ARRAY)
2689 *++PL_stack_sp = &PL_sv_undef;
2694 if (PL_scopestack_ix > oldscope)
2695 delete_eval_scope();
2699 if (flags & G_DISCARD) {
2700 PL_stack_sp = PL_stack_base + oldmark;
2709 /* Eval a string. The G_EVAL flag is always assumed. */
2712 =for apidoc p||eval_sv
2714 Tells Perl to C<eval> the string in the SV.
2720 Perl_eval_sv(pTHX_ SV *sv, I32 flags)
2722 /* See G_* flags in cop.h */
2726 UNOP myop; /* fake syntax tree node */
2727 VOL I32 oldmark = SP - PL_stack_base;
2730 OP* const oldop = PL_op;
2733 if (flags & G_DISCARD) {
2740 Zero(PL_op, 1, UNOP);
2741 EXTEND(PL_stack_sp, 1);
2742 *++PL_stack_sp = sv;
2744 if (!(flags & G_NOARGS))
2745 myop.op_flags = OPf_STACKED;
2746 myop.op_next = NULL;
2747 myop.op_type = OP_ENTEREVAL;
2748 myop.op_flags |= ((flags & G_VOID) ? OPf_WANT_VOID :
2749 (flags & G_ARRAY) ? OPf_WANT_LIST :
2751 if (flags & G_KEEPERR)
2752 myop.op_flags |= OPf_SPECIAL;
2754 /* fail now; otherwise we could fail after the JMPENV_PUSH but
2755 * before a PUSHEVAL, which corrupts the stack after a croak */
2756 TAINT_PROPER("eval_sv()");
2762 CALL_BODY_EVAL((OP*)&myop);
2763 retval = PL_stack_sp - (PL_stack_base + oldmark);
2764 if (!(flags & G_KEEPERR))
2765 sv_setpvn(ERRSV,"",0);
2771 /* my_exit() was called */
2772 PL_curstash = PL_defstash;
2775 if (PL_statusvalue && !(PL_exit_flags & PERL_EXIT_EXPECTED))
2776 Perl_croak(aTHX_ "Callback called exit");
2781 PL_op = PL_restartop;
2785 PL_stack_sp = PL_stack_base + oldmark;
2786 if (flags & G_ARRAY)
2790 *++PL_stack_sp = &PL_sv_undef;
2796 if (flags & G_DISCARD) {
2797 PL_stack_sp = PL_stack_base + oldmark;
2807 =for apidoc p||eval_pv
2809 Tells Perl to C<eval> the given string and return an SV* result.
2815 Perl_eval_pv(pTHX_ const char *p, I32 croak_on_error)
2819 SV* sv = newSVpv(p, 0);
2821 eval_sv(sv, G_SCALAR);
2828 if (croak_on_error && SvTRUE(ERRSV)) {
2829 Perl_croak(aTHX_ SvPVx_nolen_const(ERRSV));
2835 /* Require a module. */
2838 =head1 Embedding Functions
2840 =for apidoc p||require_pv
2842 Tells Perl to C<require> the file named by the string argument. It is
2843 analogous to the Perl code C<eval "require '$file'">. It's even
2844 implemented that way; consider using load_module instead.
2849 Perl_require_pv(pTHX_ const char *pv)
2854 PUSHSTACKi(PERLSI_REQUIRE);
2856 sv = Perl_newSVpvf(aTHX_ "require q%c%s%c", 0, pv, 0);
2857 eval_sv(sv_2mortal(sv), G_DISCARD);
2863 Perl_magicname(pTHX_ const char *sym, const char *name, I32 namlen)
2865 register GV * const gv = gv_fetchpv(sym, GV_ADD, SVt_PV);
2868 sv_magic(GvSV(gv), (SV*)gv, PERL_MAGIC_sv, name, namlen);
2872 S_usage(pTHX_ const char *name) /* XXX move this out into a module ? */
2874 /* This message really ought to be max 23 lines.
2875 * Removed -h because the user already knows that option. Others? */
2877 static const char * const usage_msg[] = {
2878 "-0[octal] specify record separator (\\0, if no argument)",
2879 "-A[mod][=pattern] activate all/given assertions",
2880 "-a autosplit mode with -n or -p (splits $_ into @F)",
2881 "-C[number/list] enables the listed Unicode features",
2882 "-c check syntax only (runs BEGIN and CHECK blocks)",
2883 "-d[:debugger] run program under debugger",
2884 "-D[number/list] set debugging flags (argument is a bit mask or alphabets)",
2885 "-e program one line of program (several -e's allowed, omit programfile)",
2886 "-E program like -e, but enables all optional features",
2887 "-f don't do $sitelib/sitecustomize.pl at startup",
2888 "-F/pattern/ split() pattern for -a switch (//'s are optional)",
2889 "-i[extension] edit <> files in place (makes backup if extension supplied)",
2890 "-Idirectory specify @INC/#include directory (several -I's allowed)",
2891 "-l[octal] enable line ending processing, specifies line terminator",
2892 "-[mM][-]module execute \"use/no module...\" before executing program",
2893 "-n assume \"while (<>) { ... }\" loop around program",
2894 "-p assume loop like -n but print line also, like sed",
2895 "-P run program through C preprocessor before compilation",
2896 "-s enable rudimentary parsing for switches after programfile",
2897 "-S look for programfile using PATH environment variable",
2898 "-t enable tainting warnings",
2899 "-T enable tainting checks",
2900 "-u dump core after parsing program",
2901 "-U allow unsafe operations",
2902 "-v print version, subversion (includes VERY IMPORTANT perl info)",
2903 "-V[:variable] print configuration summary (or a single Config.pm variable)",
2904 "-w enable many useful warnings (RECOMMENDED)",
2905 "-W enable all warnings",
2906 "-x[directory] strip off text before #!perl line and perhaps cd to directory",
2907 "-X disable all warnings",
2911 const char * const *p = usage_msg;
2913 PerlIO_printf(PerlIO_stdout(),
2914 "\nUsage: %s [switches] [--] [programfile] [arguments]",
2917 PerlIO_printf(PerlIO_stdout(), "\n %s", *p++);
2920 /* convert a string of -D options (or digits) into an int.
2921 * sets *s to point to the char after the options */
2925 Perl_get_debug_opts(pTHX_ const char **s, bool givehelp)
2927 static const char * const usage_msgd[] = {
2928 " Debugging flag values: (see also -d)",
2929 " p Tokenizing and parsing (with v, displays parse stack)",
2930 " s Stack snapshots (with v, displays all stacks)",
2931 " l Context (loop) stack processing",
2932 " t Trace execution",
2933 " o Method and overloading resolution",
2934 " c String/numeric conversions",
2935 " P Print profiling info, preprocessor command for -P, source file input state",
2936 " m Memory allocation",
2937 " f Format processing",
2938 " r Regular expression parsing and execution",
2939 " x Syntax tree dump",
2940 " u Tainting checks",
2941 " H Hash dump -- usurps values()",
2942 " X Scratchpad allocation",
2944 " S Thread synchronization",
2946 " R Include reference counts of dumped variables (eg when using -Ds)",
2947 " J Do not s,t,P-debug (Jump over) opcodes within package DB",
2948 " v Verbose: use in conjunction with other flags",
2950 " A Consistency checks on internal structures",
2951 " q quiet - currently only suppresses the 'EXECUTING' message",
2956 /* if adding extra options, remember to update DEBUG_MASK */
2957 static const char debopts[] = "psltocPmfrxuUHXDSTRJvCAq";
2959 for (; isALNUM(**s); (*s)++) {
2960 const char * const d = strchr(debopts,**s);
2962 i |= 1 << (d - debopts);
2963 else if (ckWARN_d(WARN_DEBUGGING))
2964 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
2965 "invalid option -D%c, use -D'' to see choices\n", **s);
2968 else if (isDIGIT(**s)) {
2970 for (; isALNUM(**s); (*s)++) ;
2972 else if (givehelp) {
2973 const char *const *p = usage_msgd;
2974 while (*p) PerlIO_printf(PerlIO_stdout(), "%s\n", *p++);
2977 if ((i & DEBUG_p_FLAG) && ckWARN_d(WARN_DEBUGGING))
2978 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
2979 "-Dp not implemented on this platform\n");
2985 /* This routine handles any switches that can be given during run */
2988 Perl_moreswitches(pTHX_ char *s)
2999 SvREFCNT_dec(PL_rs);
3000 if (s[1] == 'x' && s[2]) {
3001 const char *e = s+=2;
3007 flags = PERL_SCAN_SILENT_ILLDIGIT;
3008 rschar = (U32)grok_hex(s, &numlen, &flags, NULL);
3009 if (s + numlen < e) {
3010 rschar = 0; /* Grandfather -0xFOO as -0 -xFOO. */
3014 PL_rs = newSVpvs("");
3015 SvGROW(PL_rs, (STRLEN)(UNISKIP(rschar) + 1));
3016 tmps = (U8*)SvPVX(PL_rs);
3017 uvchr_to_utf8(tmps, rschar);
3018 SvCUR_set(PL_rs, UNISKIP(rschar));
3023 rschar = (U32)grok_oct(s, &numlen, &flags, NULL);
3024 if (rschar & ~((U8)~0))
3025 PL_rs = &PL_sv_undef;
3026 else if (!rschar && numlen >= 2)
3027 PL_rs = newSVpvs("");
3029 char ch = (char)rschar;
3030 PL_rs = newSVpvn(&ch, 1);
3033 sv_setsv(get_sv("/", TRUE), PL_rs);
3038 PL_unicode = parse_unicode_opts( (const char **)&s );
3039 if (PL_unicode & PERL_UNICODE_UTF8CACHEASSERT_FLAG)
3045 while (*s && !isSPACE(*s)) ++s;
3046 PL_splitstr = savepvn(PL_splitstr, s - PL_splitstr);
3057 forbid_setid('d', -1);
3060 /* -dt indicates to the debugger that threads will be used */
3061 if (*s == 't' && !isALNUM(s[1])) {
3063 my_setenv("PERL5DB_THREADED", "1");
3066 /* The following permits -d:Mod to accepts arguments following an =
3067 in the fashion that -MSome::Mod does. */
3068 if (*s == ':' || *s == '=') {
3070 SV * const sv = newSVpvs("use Devel::");
3072 /* We now allow -d:Module=Foo,Bar */
3073 while(isALNUM(*s) || *s==':') ++s;
3075 sv_catpv(sv, start);
3077 sv_catpvn(sv, start, s-start);
3078 /* Don't use NUL as q// delimiter here, this string goes in the
3080 Perl_sv_catpvf(aTHX_ sv, " split(/,/,q{%s});", ++s);
3083 my_setenv("PERL5DB", SvPV_nolen_const(sv));
3086 PL_perldb = PERLDB_ALL;
3093 forbid_setid('D', -1);
3095 PL_debug = get_debug_opts( (const char **)&s, 1) | DEBUG_TOP_FLAG;
3096 #else /* !DEBUGGING */
3097 if (ckWARN_d(WARN_DEBUGGING))
3098 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3099 "Recompile perl with -DDEBUGGING to use -D switch (did you mean -d ?)\n");
3100 for (s++; isALNUM(*s); s++) ;
3105 usage(PL_origargv[0]);
3108 Safefree(PL_inplace);
3109 #if defined(__CYGWIN__) /* do backup extension automagically */
3110 if (*(s+1) == '\0') {
3111 PL_inplace = savepvs(".bak");
3114 #endif /* __CYGWIN__ */
3116 const char * const start = ++s;
3117 while (*s && !isSPACE(*s))
3120 PL_inplace = savepvn(start, s - start);
3124 if (*s == '-') /* Additional switches on #! line. */
3128 case 'I': /* -I handled both here and in parse_body() */
3129 forbid_setid('I', -1);
3131 while (*s && isSPACE(*s))
3136 /* ignore trailing spaces (possibly followed by other switches) */
3138 for (e = p; *e && !isSPACE(*e); e++) ;
3142 } while (*p && *p != '-');
3143 e = savepvn(s, e-s);
3144 incpush(e, TRUE, TRUE, FALSE, FALSE);
3151 Perl_croak(aTHX_ "No directory specified for -I");
3157 SvREFCNT_dec(PL_ors_sv);
3163 PL_ors_sv = newSVpvs("\n");
3164 numlen = 3 + (*s == '0');
3165 *SvPVX(PL_ors_sv) = (char)grok_oct(s, &numlen, &flags, NULL);
3169 if (RsPARA(PL_rs)) {
3170 PL_ors_sv = newSVpvs("\n\n");
3173 PL_ors_sv = newSVsv(PL_rs);
3178 forbid_setid('A', -1);
3181 char * const start = s;
3182 SV * const sv = newSVpvs("use assertions::activate");
3183 while(isALNUM(*s) || *s == ':') ++s;
3185 sv_catpvs(sv, "::");
3186 sv_catpvn(sv, start, s-start);
3189 Perl_sv_catpvf(aTHX_ sv, " split(/,/,q%c%s%c)", 0, ++s, 0);
3192 else if (*s != '\0') {
3193 Perl_croak(aTHX_ "Can't use '%c' after -A%.*s", *s, (int)(s-start), start);
3195 Perl_av_create_and_push(aTHX_ &PL_preambleav, sv);
3199 forbid_setid('M', -1); /* XXX ? */
3202 forbid_setid('m', -1); /* XXX ? */
3206 const char *use = "use ";
3207 /* -M-foo == 'no foo' */
3208 /* Leading space on " no " is deliberate, to make both
3209 possibilities the same length. */
3210 if (*s == '-') { use = " no "; ++s; }
3211 sv = newSVpvn(use,4);
3213 /* We allow -M'Module qw(Foo Bar)' */
3214 while(isALNUM(*s) || *s==':') ++s;
3216 sv_catpv(sv, start);
3217 if (*(start-1) == 'm') {
3219 Perl_croak(aTHX_ "Can't use '%c' after -mname", *s);
3220 sv_catpvs( sv, " ()");
3224 Perl_croak(aTHX_ "Module name required with -%c option",
3226 sv_catpvn(sv, start, s-start);
3227 sv_catpvs(sv, " split(/,/,q");
3228 sv_catpvs(sv, "\0"); /* Use NUL as q//-delimiter. */
3230 sv_catpvs(sv, "\0)");
3233 Perl_av_create_and_push(aTHX_ &PL_preambleav, sv);
3236 Perl_croak(aTHX_ "Missing argument to -%c", *(s-1));
3247 forbid_setid('s', -1);
3248 PL_doswitches = TRUE;
3262 #ifdef MACOS_TRADITIONAL
3263 Perl_croak(aTHX_ "Believe me, you don't want to use \"-u\" on a Macintosh");
3265 PL_do_undump = TRUE;
3273 if (!sv_derived_from(PL_patchlevel, "version"))
3274 upg_version(PL_patchlevel);
3276 PerlIO_printf(PerlIO_stdout(),
3277 Perl_form(aTHX_ "\nThis is perl, %"SVf
3278 #ifdef PERL_PATCHNUM
3279 " DEVEL" STRINGIFY(PERL_PATCHNUM)
3282 SVfARG(vstringify(PL_patchlevel)),
3285 /* Adjust verbose output as in the perl that ships with the DG/UX OS from EMC */
3286 PerlIO_printf(PerlIO_stdout(),
3287 Perl_form(aTHX_ "\nThis is perl, %"SVf"\n",
3288 SVfARG(vstringify(PL_patchlevel))));
3289 PerlIO_printf(PerlIO_stdout(),
3290 Perl_form(aTHX_ " built under %s at %s %s\n",
3291 OSNAME, __DATE__, __TIME__));
3292 PerlIO_printf(PerlIO_stdout(),
3293 Perl_form(aTHX_ " OS Specific Release: %s\n",
3297 #if defined(LOCAL_PATCH_COUNT)
3298 if (LOCAL_PATCH_COUNT > 0)
3299 PerlIO_printf(PerlIO_stdout(),
3300 "\n(with %d registered patch%s, "
3301 "see perl -V for more detail)",
3303 (LOCAL_PATCH_COUNT!=1) ? "es" : "");
3306 PerlIO_printf(PerlIO_stdout(),
3307 "\n\nCopyright 1987-2007, Larry Wall\n");
3308 #ifdef MACOS_TRADITIONAL
3309 PerlIO_printf(PerlIO_stdout(),
3310 "\nMac OS port Copyright 1991-2002, Matthias Neeracher;\n"
3311 "maintained by Chris Nandor\n");
3314 PerlIO_printf(PerlIO_stdout(),
3315 "\nMS-DOS port Copyright (c) 1989, 1990, Diomidis Spinellis\n");
3318 PerlIO_printf(PerlIO_stdout(),
3319 "djgpp v2 port (jpl5003c) by Hirofumi Watanabe, 1996\n"
3320 "djgpp v2 port (perl5004+) by Laszlo Molnar, 1997-1999\n");
3323 PerlIO_printf(PerlIO_stdout(),
3324 "\n\nOS/2 port Copyright (c) 1990, 1991, Raymond Chen, Kai Uwe Rommel\n"
3325 "Version 5 port Copyright (c) 1994-2002, Andreas Kaiser, Ilya Zakharevich\n");
3328 PerlIO_printf(PerlIO_stdout(),
3329 "atariST series port, ++jrb bammi@cadence.com\n");
3332 PerlIO_printf(PerlIO_stdout(),
3333 "BeOS port Copyright Tom Spindler, 1997-1999\n");
3336 PerlIO_printf(PerlIO_stdout(),
3337 "MPE/iX port Copyright by Mark Klein and Mark Bixby, 1996-2003\n");
3340 PerlIO_printf(PerlIO_stdout(),
3341 "MVS (OS390) port by Mortice Kern Systems, 1997-1999\n");
3344 PerlIO_printf(PerlIO_stdout(),
3345 "Stratus VOS port by Paul.Green@stratus.com, 1997-2002\n");
3348 PerlIO_printf(PerlIO_stdout(),
3349 "VM/ESA port by Neale Ferguson, 1998-1999\n");
3352 PerlIO_printf(PerlIO_stdout(),
3353 "BS2000 (POSIX) port by Start Amadeus GmbH, 1998-1999\n");
3356 PerlIO_printf(PerlIO_stdout(),
3357 "MiNT port by Guido Flohr, 1997-1999\n");
3360 PerlIO_printf(PerlIO_stdout(),
3361 "EPOC port by Olaf Flebbe, 1999-2002\n");
3364 PerlIO_printf(PerlIO_stdout(),"WINCE port by Rainer Keuchel, 2001-2002\n");
3365 PerlIO_printf(PerlIO_stdout(),"Built on " __DATE__ " " __TIME__ "\n\n");
3368 #ifdef __SYMBIAN32__
3369 PerlIO_printf(PerlIO_stdout(),
3370 "Symbian port by Nokia, 2004-2005\n");
3372 #ifdef BINARY_BUILD_NOTICE
3373 BINARY_BUILD_NOTICE;
3375 PerlIO_printf(PerlIO_stdout(),
3377 Perl may be copied only under the terms of either the Artistic License or the\n\
3378 GNU General Public License, which may be found in the Perl 5 source kit.\n\n\
3379 Complete documentation for Perl, including FAQ lists, should be found on\n\
3380 this system using \"man perl\" or \"perldoc perl\". If you have access to the\n\
3381 Internet, point your browser at http://www.perl.org/, the Perl Home Page.\n\n");
3384 if (! (PL_dowarn & G_WARN_ALL_MASK)) {
3385 PL_dowarn |= G_WARN_ON;
3390 PL_dowarn = G_WARN_ALL_ON|G_WARN_ON;
3391 if (!specialWARN(PL_compiling.cop_warnings))
3392 PerlMemShared_free(PL_compiling.cop_warnings);
3393 PL_compiling.cop_warnings = pWARN_ALL ;
3397 PL_dowarn = G_WARN_ALL_OFF;
3398 if (!specialWARN(PL_compiling.cop_warnings))
3399 PerlMemShared_free(PL_compiling.cop_warnings);
3400 PL_compiling.cop_warnings = pWARN_NONE ;
3405 if (s[1] == '-') /* Additional switches on #! line. */
3410 #if defined(WIN32) || !defined(PERL_STRICT_CR)
3416 #ifdef ALTERNATE_SHEBANG
3417 case 'S': /* OS/2 needs -S on "extproc" line. */
3425 Perl_croak(aTHX_ "Can't emulate -%.1s on #! line",s);
3430 /* compliments of Tom Christiansen */
3432 /* unexec() can be found in the Gnu emacs distribution */
3433 /* Known to work with -DUNEXEC and using unexelf.c from GNU emacs-20.2 */
3436 Perl_my_unexec(pTHX)
3438 PERL_UNUSED_CONTEXT;
3440 SV * prog = newSVpv(BIN_EXP, 0);
3441 SV * file = newSVpv(PL_origfilename, 0);
3445 sv_catpvs(prog, "/perl");
3446 sv_catpvs(file, ".perldump");
3448 unexec(SvPVX(file), SvPVX(prog), &etext, sbrk(0), 0);
3449 /* unexec prints msg to stderr in case of failure */
3450 PerlProc_exit(status);
3453 # include <lib$routines.h>
3454 lib$signal(SS$_DEBUG); /* ssdef.h #included from vmsish.h */
3455 # elif defined(WIN32) || defined(__CYGWIN__)
3456 Perl_croak(aTHX_ "dump is not supported");
3458 ABORT(); /* for use with undump */
3463 /* initialize curinterp */
3469 # define PERLVAR(var,type)
3470 # define PERLVARA(var,n,type)
3471 # if defined(PERL_IMPLICIT_CONTEXT)
3472 # define PERLVARI(var,type,init) aTHX->var = init;
3473 # define PERLVARIC(var,type,init) aTHX->var = init;
3475 # define PERLVARI(var,type,init) PERL_GET_INTERP->var = init;
3476 # define PERLVARIC(var,type,init) PERL_GET_INTERP->var = init;
3478 # include "intrpvar.h"
3479 # include "thrdvar.h"
3485 # define PERLVAR(var,type)
3486 # define PERLVARA(var,n,type)
3487 # define PERLVARI(var,type,init) PL_##var = init;
3488 # define PERLVARIC(var,type,init) PL_##var = init;
3489 # include "intrpvar.h"
3490 # include "thrdvar.h"
3497 /* As these are inside a structure, PERLVARI isn't capable of initialising
3499 PL_reg_oldcurpm = PL_reg_curpm = NULL;
3500 PL_reg_poscache = PL_reg_starttry = NULL;
3504 S_init_main_stash(pTHX)
3509 PL_curstash = PL_defstash = newHV();
3510 /* We know that the string "main" will be in the global shared string
3511 table, so it's a small saving to use it rather than allocate another
3513 PL_curstname = newSVpvs_share("main");
3514 gv = gv_fetchpvs("main::", GV_ADD|GV_NOTQUAL, SVt_PVHV);
3515 /* If we hadn't caused another reference to "main" to be in the shared
3516 string table above, then it would be worth reordering these two,
3517 because otherwise all we do is delete "main" from it as a consequence
3518 of the SvREFCNT_dec, only to add it again with hv_name_set */
3519 SvREFCNT_dec(GvHV(gv));
3520 hv_name_set(PL_defstash, "main", 4, 0);
3521 GvHV(gv) = (HV*)SvREFCNT_inc_simple(PL_defstash);
3523 PL_incgv = gv_HVadd(gv_AVadd(gv_fetchpvs("INC", GV_ADD|GV_NOTQUAL,
3525 SvREFCNT_inc_simple(PL_incgv); /* Don't allow it to be freed */
3526 GvMULTI_on(PL_incgv);
3527 PL_hintgv = gv_fetchpvs("\010", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^H */
3528 GvMULTI_on(PL_hintgv);
3529 PL_defgv = gv_fetchpvs("_", GV_ADD|GV_NOTQUAL, SVt_PVAV);
3530 SvREFCNT_inc_simple(PL_defgv);
3531 PL_errgv = gv_HVadd(gv_fetchpvs("@", GV_ADD|GV_NOTQUAL, SVt_PV));
3532 SvREFCNT_inc_simple(PL_errgv);
3533 GvMULTI_on(PL_errgv);
3534 PL_replgv = gv_fetchpvs("\022", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^R */
3535 GvMULTI_on(PL_replgv);
3536 (void)Perl_form(aTHX_ "%240s",""); /* Preallocate temp - for immediate signals. */
3537 #ifdef PERL_DONT_CREATE_GVSV
3540 sv_grow(ERRSV, 240); /* Preallocate - for immediate signals. */
3541 sv_setpvn(ERRSV, "", 0);
3542 PL_curstash = PL_defstash;
3543 CopSTASH_set(&PL_compiling, PL_defstash);
3544 PL_debstash = GvHV(gv_fetchpvs("DB::", GV_ADDMULTI, SVt_PVHV));
3545 PL_globalstash = GvHV(gv_fetchpvs("CORE::GLOBAL::", GV_ADDMULTI,
3547 /* We must init $/ before switches are processed. */
3548 sv_setpvn(get_sv("/", TRUE), "\n", 1);
3552 S_open_script(pTHX_ const char *scriptname, bool dosearch, SV *sv,
3558 const char *cpp_discard_flag;
3567 PL_origfilename = savepvs("-e");
3570 /* if find_script() returns, it returns a malloc()-ed value */
3571 scriptname = PL_origfilename = find_script(scriptname, dosearch, NULL, 1);
3573 if (strnEQ(scriptname, "/dev/fd/", 8) && isDIGIT(scriptname[8]) ) {
3574 const char *s = scriptname + 8;
3580 * Tell apart "normal" usage of fdscript, e.g.
3581 * with bash on FreeBSD:
3582 * perl <( echo '#!perl -DA'; echo 'print "$0\n"')
3583 * from usage in suidperl.
3584 * Does any "normal" usage leave garbage after the number???
3585 * Is it a mistake to use a similar /dev/fd/ construct for
3590 * Be supersafe and do some sanity-checks.
3591 * Still, can we be sure we got the right thing?
3594 Perl_croak(aTHX_ "Wrong syntax (suid) fd script name \"%s\"\n", s);
3597 Perl_croak(aTHX_ "Missing (suid) fd script name\n");
3599 scriptname = savepv(s + 1);
3600 Safefree(PL_origfilename);
3601 PL_origfilename = (char *)scriptname;
3606 CopFILE_free(PL_curcop);
3607 CopFILE_set(PL_curcop, PL_origfilename);
3608 if (*PL_origfilename == '-' && PL_origfilename[1] == '\0')
3609 scriptname = (char *)"";
3610 if (fdscript >= 0) {
3611 PL_rsfp = PerlIO_fdopen(fdscript,PERL_SCRIPT_MODE);
3612 # if defined(HAS_FCNTL) && defined(F_SETFD)
3614 /* ensure close-on-exec */
3615 fcntl(PerlIO_fileno(PL_rsfp),F_SETFD,1);
3620 Perl_croak(aTHX_ "sperl needs fd script\n"
3621 "You should not call sperl directly; do you need to "
3622 "change a #! line\nfrom sperl to perl?\n");
3625 * Do not open (or do other fancy stuff) while setuid.
3626 * Perl does the open, and hands script to suidperl on a fd;
3627 * suidperl only does some checks, sets up UIDs and re-execs
3628 * perl with that fd as it has always done.
3631 if (*suidscript != 1) {
3632 Perl_croak(aTHX_ "suidperl needs (suid) fd script\n");
3635 else if (PL_preprocess) {
3636 const char * const cpp_cfg = CPPSTDIN;
3637 SV * const cpp = newSVpvs("");
3638 SV * const cmd = newSV(0);
3640 if (cpp_cfg[0] == 0) /* PERL_MICRO? */
3641 Perl_croak(aTHX_ "Can't run with cpp -P with CPPSTDIN undefined");
3642 if (strEQ(cpp_cfg, "cppstdin"))
3643 Perl_sv_catpvf(aTHX_ cpp, "%s/", BIN_EXP);
3644 sv_catpv(cpp, cpp_cfg);
3647 sv_catpvs(sv, "-I");
3648 sv_catpv(sv,PRIVLIB_EXP);
3651 DEBUG_P(PerlIO_printf(Perl_debug_log,
3652 "PL_preprocess: scriptname=\"%s\", cpp=\"%s\", sv=\"%s\", CPPMINUS=\"%s\"\n",
3653 scriptname, SvPVX_const (cpp), SvPVX_const (sv),
3656 # if defined(MSDOS) || defined(WIN32) || defined(VMS)
3663 cpp_discard_flag = "";
3665 cpp_discard_flag = "-C";
3669 perl = os2_execname(aTHX);
3671 perl = PL_origargv[0];
3675 /* This strips off Perl comments which might interfere with
3676 the C pre-processor, including #!. #line directives are
3677 deliberately stripped to avoid confusion with Perl's version
3678 of #line. FWP played some golf with it so it will fit
3679 into VMS's 255 character buffer.
3682 code = "(1../^#!.*perl/i)|/^\\s*#(?!\\s*((ifn?|un)def|(el|end)?if|define|include|else|error|pragma)\\b)/||!($|=1)||print";
3684 code = "/^\\s*#(?!\\s*((ifn?|un)def|(el|end)?if|define|include|else|error|pragma)\\b)/||!($|=1)||print";
3686 Perl_sv_setpvf(aTHX_ cmd, "\
3687 %s -ne%s%s%s %s | %"SVf" %s %"SVf" %s",
3688 perl, quote, code, quote, scriptname, SVfARG(cpp),
3689 cpp_discard_flag, SVfARG(sv), CPPMINUS);
3691 PL_doextract = FALSE;
3693 DEBUG_P(PerlIO_printf(Perl_debug_log,
3694 "PL_preprocess: cmd=\"%s\"\n",
3697 PL_rsfp = PerlProc_popen((char *)SvPVX_const(cmd), (char *)"r");
3701 else if (!*scriptname) {
3702 forbid_setid(0, *suidscript);
3703 PL_rsfp = PerlIO_stdin();
3706 PL_rsfp = PerlIO_open(scriptname,PERL_SCRIPT_MODE);
3707 # if defined(HAS_FCNTL) && defined(F_SETFD)
3709 /* ensure close-on-exec */
3710 fcntl(PerlIO_fileno(PL_rsfp),F_SETFD,1);
3713 #endif /* IAMSUID */
3715 /* PSz 16 Sep 03 Keep neat error message */
3717 Perl_croak(aTHX_ "Can't open "BIT_BUCKET": %s\n", Strerror(errno));
3719 Perl_croak(aTHX_ "Can't open perl script \"%s\": %s\n",
3720 CopFILE(PL_curcop), Strerror(errno));
3726 * I_SYSSTATVFS HAS_FSTATVFS
3728 * I_STATFS HAS_FSTATFS HAS_GETFSSTAT
3729 * I_MNTENT HAS_GETMNTENT HAS_HASMNTOPT
3730 * here so that metaconfig picks them up. */
3734 S_fd_on_nosuid_fs(pTHX_ int fd)
3737 * We used to do this as "plain" user (after swapping UIDs with setreuid);
3738 * but is needed also on machines without setreuid.
3739 * Seems safe enough to run as root.
3741 int check_okay = 0; /* able to do all the required sys/libcalls */
3742 int on_nosuid = 0; /* the fd is on a nosuid fs */
3744 * Need to check noexec also: nosuid might not be set, the average
3745 * sysadmin would say that nosuid is irrelevant once he sets noexec.
3747 int on_noexec = 0; /* the fd is on a noexec fs */
3750 * Preferred order: fstatvfs(), fstatfs(), ustat()+getmnt(), getmntent().
3751 * fstatvfs() is UNIX98.
3752 * fstatfs() is 4.3 BSD.
3753 * ustat()+getmnt() is pre-4.3 BSD.
3754 * getmntent() is O(number-of-mounted-filesystems) and can hang on
3755 * an irrelevant filesystem while trying to reach the right one.
3758 #undef FD_ON_NOSUID_CHECK_OKAY /* found the syscalls to do the check? */
3760 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3761 defined(HAS_FSTATVFS)
3762 # define FD_ON_NOSUID_CHECK_OKAY
3763 struct statvfs stfs;
3765 check_okay = fstatvfs(fd, &stfs) == 0;
3766 on_nosuid = check_okay && (stfs.f_flag & ST_NOSUID);
3768 /* ST_NOEXEC certainly absent on AIX 5.1, and doesn't seem to be documented
3769 on platforms where it is present. */
3770 on_noexec = check_okay && (stfs.f_flag & ST_NOEXEC);
3772 # endif /* fstatvfs */
3774 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3775 defined(PERL_MOUNT_NOSUID) && \
3776 defined(PERL_MOUNT_NOEXEC) && \
3777 defined(HAS_FSTATFS) && \
3778 defined(HAS_STRUCT_STATFS) && \
3779 defined(HAS_STRUCT_STATFS_F_FLAGS)
3780 # define FD_ON_NOSUID_CHECK_OKAY
3783 check_okay = fstatfs(fd, &stfs) == 0;
3784 on_nosuid = check_okay && (stfs.f_flags & PERL_MOUNT_NOSUID);
3785 on_noexec = check_okay && (stfs.f_flags & PERL_MOUNT_NOEXEC);
3786 # endif /* fstatfs */
3788 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3789 defined(PERL_MOUNT_NOSUID) && \
3790 defined(PERL_MOUNT_NOEXEC) && \
3791 defined(HAS_FSTAT) && \
3792 defined(HAS_USTAT) && \
3793 defined(HAS_GETMNT) && \
3794 defined(HAS_STRUCT_FS_DATA) && \
3796 # define FD_ON_NOSUID_CHECK_OKAY
3799 if (fstat(fd, &fdst) == 0) {
3801 if (ustat(fdst.st_dev, &us) == 0) {
3803 /* NOSTAT_ONE here because we're not examining fields which
3804 * vary between that case and STAT_ONE. */
3805 if (getmnt((int*)0, &fsd, (int)0, NOSTAT_ONE, us.f_fname) == 0) {
3806 size_t cmplen = sizeof(us.f_fname);
3807 if (sizeof(fsd.fd_req.path) < cmplen)
3808 cmplen = sizeof(fsd.fd_req.path);
3809 if (strnEQ(fsd.fd_req.path, us.f_fname, cmplen) &&
3810 fdst.st_dev == fsd.fd_req.dev) {
3812 on_nosuid = fsd.fd_req.flags & PERL_MOUNT_NOSUID;
3813 on_noexec = fsd.fd_req.flags & PERL_MOUNT_NOEXEC;
3818 # endif /* fstat+ustat+getmnt */
3820 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3821 defined(HAS_GETMNTENT) && \
3822 defined(HAS_HASMNTOPT) && \
3823 defined(MNTOPT_NOSUID) && \
3824 defined(MNTOPT_NOEXEC)
3825 # define FD_ON_NOSUID_CHECK_OKAY
3826 FILE *mtab = fopen("/etc/mtab", "r");
3827 struct mntent *entry;
3830 if (mtab && (fstat(fd, &stb) == 0)) {
3831 while (entry = getmntent(mtab)) {
3832 if (stat(entry->mnt_dir, &fsb) == 0
3833 && fsb.st_dev == stb.st_dev)
3835 /* found the filesystem */
3837 if (hasmntopt(entry, MNTOPT_NOSUID))
3839 if (hasmntopt(entry, MNTOPT_NOEXEC))
3842 } /* A single fs may well fail its stat(). */
3847 # endif /* getmntent+hasmntopt */
3850 Perl_croak(aTHX_ "Can't check filesystem of script \"%s\" for nosuid/noexec", PL_origfilename);
3852 Perl_croak(aTHX_ "Setuid script \"%s\" on nosuid filesystem", PL_origfilename);
3854 Perl_croak(aTHX_ "Setuid script \"%s\" on noexec filesystem", PL_origfilename);
3855 return ((!check_okay) || on_nosuid || on_noexec);
3857 #endif /* IAMSUID */
3860 S_validate_suid(pTHX_ const char *validarg, const char *scriptname,
3861 int fdscript, int suidscript)
3866 #endif /* IAMSUID */
3868 /* do we need to emulate setuid on scripts? */
3870 /* This code is for those BSD systems that have setuid #! scripts disabled
3871 * in the kernel because of a security problem. Merely defining DOSUID
3872 * in perl will not fix that problem, but if you have disabled setuid
3873 * scripts in the kernel, this will attempt to emulate setuid and setgid
3874 * on scripts that have those now-otherwise-useless bits set. The setuid
3875 * root version must be called suidperl or sperlN.NNN. If regular perl
3876 * discovers that it has opened a setuid script, it calls suidperl with
3877 * the same argv that it had. If suidperl finds that the script it has
3878 * just opened is NOT setuid root, it sets the effective uid back to the
3879 * uid. We don't just make perl setuid root because that loses the
3880 * effective uid we had before invoking perl, if it was different from the
3883 * Description/comments above do not match current workings:
3884 * suidperl must be hardlinked to sperlN.NNN (that is what we exec);
3885 * suidperl called with script open and name changed to /dev/fd/N/X;
3886 * suidperl croaks if script is not setuid;
3887 * making perl setuid would be a huge security risk (and yes, that
3888 * would lose any euid we might have had).
3890 * DOSUID must be defined in both perl and suidperl, and IAMSUID must
3891 * be defined in suidperl only. suidperl must be setuid root. The
3892 * Configure script will set this up for you if you want it.
3898 if (PerlLIO_fstat(PerlIO_fileno(PL_rsfp),&PL_statbuf) < 0) /* normal stat is insecure */
3899 Perl_croak(aTHX_ "Can't stat script \"%s\"",PL_origfilename);
3900 if (PL_statbuf.st_mode & (S_ISUID|S_ISGID)) {
3902 const char *linestr;
3906 if (fdscript < 0 || suidscript != 1)
3907 Perl_croak(aTHX_ "Need (suid) fdscript in suidperl\n"); /* We already checked this */
3909 * Since the script is opened by perl, not suidperl, some of these
3910 * checks are superfluous. Leaving them in probably does not lower
3914 * Do checks even for systems with no HAS_SETREUID.
3915 * We used to swap, then re-swap UIDs with
3917 if (setreuid(PL_euid,PL_uid) < 0
3918 || PerlProc_getuid() != PL_euid || PerlProc_geteuid() != PL_uid)
3919 Perl_croak(aTHX_ "Can't swap uid and euid");
3922 if (setreuid(PL_uid,PL_euid) < 0
3923 || PerlProc_getuid() != PL_uid || PerlProc_geteuid() != PL_euid)
3924 Perl_croak(aTHX_ "Can't reswap uid and euid");
3928 /* On this access check to make sure the directories are readable,
3929 * there is actually a small window that the user could use to make
3930 * filename point to an accessible directory. So there is a faint
3931 * chance that someone could execute a setuid script down in a
3932 * non-accessible directory. I don't know what to do about that.
3933 * But I don't think it's too important. The manual lies when
3934 * it says access() is useful in setuid programs.
3936 * So, access() is pretty useless... but not harmful... do anyway.
3938 if (PerlLIO_access(CopFILE(PL_curcop),1)) { /*double check*/
3939 Perl_croak(aTHX_ "Can't access() script\n");
3942 /* If we can swap euid and uid, then we can determine access rights
3943 * with a simple stat of the file, and then compare device and
3944 * inode to make sure we did stat() on the same file we opened.
3945 * Then we just have to make sure he or she can execute it.
3948 * As the script is opened by perl, not suidperl, we do not need to
3949 * care much about access rights.
3951 * The 'script changed' check is needed, or we can get lied to
3952 * about $0 with e.g.
3953 * suidperl /dev/fd/4//bin/x 4<setuidscript
3954 * Without HAS_SETREUID, is it safe to stat() as root?
3956 * Are there any operating systems that pass /dev/fd/xxx for setuid
3957 * scripts, as suggested/described in perlsec(1)? Surely they do not
3958 * pass the script name as we do, so the "script changed" test would
3959 * fail for them... but we never get here with
3960 * SETUID_SCRIPTS_ARE_SECURE_NOW defined.
3962 * This is one place where we must "lie" about return status: not
3963 * say if the stat() failed. We are doing this as root, and could
3964 * be tricked into reporting existence or not of files that the
3965 * "plain" user cannot even see.
3969 if (PerlLIO_stat(CopFILE(PL_curcop),&tmpstatbuf) < 0 ||
3970 tmpstatbuf.st_dev != PL_statbuf.st_dev ||
3971 tmpstatbuf.st_ino != PL_statbuf.st_ino) {
3972 Perl_croak(aTHX_ "Setuid script changed\n");
3976 if (!cando(S_IXUSR,FALSE,&PL_statbuf)) /* can real uid exec? */
3977 Perl_croak(aTHX_ "Real UID cannot exec script\n");
3980 * We used to do this check as the "plain" user (after swapping
3981 * UIDs). But the check for nosuid and noexec filesystem is needed,
3982 * and should be done even without HAS_SETREUID. (Maybe those
3983 * operating systems do not have such mount options anyway...)
3984 * Seems safe enough to do as root.
3986 #if !defined(NO_NOSUID_CHECK)
3987 if (fd_on_nosuid_fs(PerlIO_fileno(PL_rsfp))) {
3988 Perl_croak(aTHX_ "Setuid script on nosuid or noexec filesystem\n");
3991 #endif /* IAMSUID */
3993 if (!S_ISREG(PL_statbuf.st_mode)) {
3994 Perl_croak(aTHX_ "Setuid script not plain file\n");
3996 if (PL_statbuf.st_mode & S_IWOTH)
3997 Perl_croak(aTHX_ "Setuid/gid script is writable by world");
3998 PL_doswitches = FALSE; /* -s is insecure in suid */
3999 /* PSz 13 Nov 03 But -s was caught elsewhere ... so unsetting it here is useless(?!) */
4000 CopLINE_inc(PL_curcop);
4001 if (sv_gets(PL_linestr, PL_rsfp, 0) == NULL)
4002 Perl_croak(aTHX_ "No #! line");
4003 linestr = SvPV_nolen_const(PL_linestr);
4004 /* required even on Sys V */
4005 if (!*linestr || !linestr[1] || strnNE(linestr,"#!",2))
4006 Perl_croak(aTHX_ "No #! line");
4010 /* Sanity check on line length */
4011 s_end = s + strlen(s);
4012 if (s_end == s || (s_end - s) > 4000)
4013 Perl_croak(aTHX_ "Very long #! line");
4014 /* Allow more than a single space after #! */
4015 while (isSPACE(*s)) s++;
4016 /* Sanity check on buffer end */
4017 while ((*s) && !isSPACE(*s)) s++;
4018 for (s2 = s; (s2 > linestr &&
4019 (isDIGIT(s2[-1]) || s2[-1] == '.' || s2[-1] == '_'
4020 || s2[-1] == '-')); s2--) ;
4021 /* Sanity check on buffer start */
4022 if ( (s2-4 < linestr || strnNE(s2-4,"perl",4)) &&
4023 (s-9 < linestr || strnNE(s-9,"perl",4)) )
4024 Perl_croak(aTHX_ "Not a perl script");
4025 while (*s == ' ' || *s == '\t') s++;
4027 * #! arg must be what we saw above. They can invoke it by
4028 * mentioning suidperl explicitly, but they may not add any strange
4029 * arguments beyond what #! says if they do invoke suidperl that way.
4032 * The way validarg was set up, we rely on the kernel to start
4033 * scripts with argv[1] set to contain all #! line switches (the
4037 * Check that we got all the arguments listed in the #! line (not
4038 * just that there are no extraneous arguments). Might not matter
4039 * much, as switches from #! line seem to be acted upon (also), and
4040 * so may be checked and trapped in perl. But, security checks must
4041 * be done in suidperl and not deferred to perl. Note that suidperl
4042 * does not get around to parsing (and checking) the switches on
4043 * the #! line (but execs perl sooner).
4044 * Allow (require) a trailing newline (which may be of two
4045 * characters on some architectures?) (but no other trailing
4048 len = strlen(validarg);
4049 if (strEQ(validarg," PHOOEY ") ||
4050 strnNE(s,validarg,len) || !isSPACE(s[len]) ||
4051 !((s_end - s) == len+1
4052 || ((s_end - s) == len+2 && isSPACE(s[len+1]))))
4053 Perl_croak(aTHX_ "Args must match #! line");
4057 PL_euid != PL_uid && (PL_statbuf.st_mode & S_ISUID) &&
4058 PL_euid == PL_statbuf.st_uid)
4060 Perl_croak(aTHX_ "YOU HAVEN'T DISABLED SET-ID SCRIPTS IN THE KERNEL YET!\n\
4061 FIX YOUR KERNEL, OR PUT A C WRAPPER AROUND THIS SCRIPT!\n");
4062 #endif /* IAMSUID */
4065 PL_euid) { /* oops, we're not the setuid root perl */
4067 * When root runs a setuid script, we do not go through the same
4068 * steps of execing sperl and then perl with fd scripts, but
4069 * simply set up UIDs within the same perl invocation; so do
4070 * not have the same checks (on options, whatever) that we have
4071 * for plain users. No problem really: would have to be a script
4072 * that does not actually work for plain users; and if root is
4073 * foolish and can be persuaded to run such an unsafe script, he
4074 * might run also non-setuid ones, and deserves what he gets.
4076 * Or, we might drop the PL_euid check above (and rely just on
4077 * fdscript to avoid loops), and do the execs
4083 * Pass fd script to suidperl.
4084 * Exec suidperl, substituting fd script for scriptname.
4085 * Pass script name as "subdir" of fd, which perl will grok;
4086 * in fact will use that to distinguish this from "normal"
4087 * usage, see comments above.
4089 PerlIO_rewind(PL_rsfp);
4090 PerlLIO_lseek(PerlIO_fileno(PL_rsfp),(Off_t)0,0); /* just in case rewind didn't */
4091 /* PSz 27 Feb 04 Sanity checks on scriptname */
4092 if ((!scriptname) || (!*scriptname) ) {
4093 Perl_croak(aTHX_ "No setuid script name\n");
4095 if (*scriptname == '-') {
4096 Perl_croak(aTHX_ "Setuid script name may not begin with dash\n");
4097 /* Or we might confuse it with an option when replacing
4098 * name in argument list, below (though we do pointer, not
4099 * string, comparisons).
4102 for (which = 1; PL_origargv[which] && PL_origargv[which] != scriptname; which++) ;
4103 if (!PL_origargv[which]) {
4104 Perl_croak(aTHX_ "Can't change argv to have fd script\n");
4106 PL_origargv[which] = savepv(Perl_form(aTHX_ "/dev/fd/%d/%s",
4107 PerlIO_fileno(PL_rsfp), PL_origargv[which]));
4108 #if defined(HAS_FCNTL) && defined(F_SETFD)
4109 fcntl(PerlIO_fileno(PL_rsfp),F_SETFD,0); /* ensure no close-on-exec */
4112 PerlProc_execv(Perl_form(aTHX_ "%s/sperl"PERL_FS_VER_FMT, BIN_EXP,
4113 (int)PERL_REVISION, (int)PERL_VERSION,
4114 (int)PERL_SUBVERSION), PL_origargv);
4116 #endif /* IAMSUID */
4117 Perl_croak(aTHX_ "Can't do setuid (cannot exec sperl)\n");
4120 if (PL_statbuf.st_mode & S_ISGID && PL_statbuf.st_gid != PL_egid) {
4122 * This seems back to front: we try HAS_SETEGID first; if not available
4123 * then try HAS_SETREGID; as a last chance we try HAS_SETRESGID. May be OK
4124 * in the sense that we only want to set EGID; but are there any machines
4125 * with either of the latter, but not the former? Same with UID, later.
4128 (void)setegid(PL_statbuf.st_gid);
4131 (void)setregid((Gid_t)-1,PL_statbuf.st_gid);
4133 #ifdef HAS_SETRESGID
4134 (void)setresgid((Gid_t)-1,PL_statbuf.st_gid,(Gid_t)-1);
4136 PerlProc_setgid(PL_statbuf.st_gid);
4140 if (PerlProc_getegid() != PL_statbuf.st_gid)
4141 Perl_croak(aTHX_ "Can't do setegid!\n");
4143 if (PL_statbuf.st_mode & S_ISUID) {
4144 if (PL_statbuf.st_uid != PL_euid)
4146 (void)seteuid(PL_statbuf.st_uid); /* all that for this */
4149 (void)setreuid((Uid_t)-1,PL_statbuf.st_uid);
4151 #ifdef HAS_SETRESUID
4152 (void)setresuid((Uid_t)-1,PL_statbuf.st_uid,(Uid_t)-1);
4154 PerlProc_setuid(PL_statbuf.st_uid);
4158 if (PerlProc_geteuid() != PL_statbuf.st_uid)
4159 Perl_croak(aTHX_ "Can't do seteuid!\n");
4161 else if (PL_uid) { /* oops, mustn't run as root */
4163 (void)seteuid((Uid_t)PL_uid);
4166 (void)setreuid((Uid_t)-1,(Uid_t)PL_uid);
4168 #ifdef HAS_SETRESUID
4169 (void)setresuid((Uid_t)-1,(Uid_t)PL_uid,(Uid_t)-1);
4171 PerlProc_setuid((Uid_t)PL_uid);
4175 if (PerlProc_geteuid() != PL_uid)
4176 Perl_croak(aTHX_ "Can't do seteuid!\n");
4179 if (!cando(S_IXUSR,TRUE,&PL_statbuf))
4180 Perl_croak(aTHX_ "Effective UID cannot exec script\n"); /* they can't do this */
4183 else if (PL_preprocess) /* PSz 13 Nov 03 Caught elsewhere, useless(?!) here */
4184 Perl_croak(aTHX_ "-P not allowed for setuid/setgid script\n");
4185 else if (fdscript < 0 || suidscript != 1)
4186 /* PSz 13 Nov 03 Caught elsewhere, useless(?!) here */
4187 Perl_croak(aTHX_ "(suid) fdscript needed in suidperl\n");
4189 /* PSz 16 Sep 03 Keep neat error message */
4190 Perl_croak(aTHX_ "Script is not setuid/setgid in suidperl\n");
4193 /* We absolutely must clear out any saved ids here, so we */
4194 /* exec the real perl, substituting fd script for scriptname. */
4195 /* (We pass script name as "subdir" of fd, which perl will grok.) */
4197 * It might be thought that using setresgid and/or setresuid (changed to
4198 * set the saved IDs) above might obviate the need to exec, and we could
4199 * go on to "do the perl thing".
4201 * Is there such a thing as "saved GID", and is that set for setuid (but
4202 * not setgid) execution like suidperl? Without exec, it would not be
4203 * cleared for setuid (but not setgid) scripts (or might need a dummy
4206 * We need suidperl to do the exact same argument checking that perl
4207 * does. Thus it cannot be very small; while it could be significantly
4208 * smaller, it is safer (simpler?) to make it essentially the same
4209 * binary as perl (but they are not identical). - Maybe could defer that
4210 * check to the invoked perl, and suidperl be a tiny wrapper instead;
4211 * but prefer to do thorough checks in suidperl itself. Such deferral
4212 * would make suidperl security rely on perl, a design no-no.
4214 * Setuid things should be short and simple, thus easy to understand and
4215 * verify. They should do their "own thing", without influence by
4216 * attackers. It may help if their internal execution flow is fixed,
4217 * regardless of platform: it may be best to exec anyway.
4219 * Suidperl should at least be conceptually simple: a wrapper only,
4220 * never to do any real perl. Maybe we should put
4222 * Perl_croak(aTHX_ "Suidperl should never do real perl\n");
4224 * into the perly bits.
4226 PerlIO_rewind(PL_rsfp);
4227 PerlLIO_lseek(PerlIO_fileno(PL_rsfp),(Off_t)0,0); /* just in case rewind didn't */
4229 * Keep original arguments: suidperl already has fd script.
4231 /* for (which = 1; PL_origargv[which] && PL_origargv[which] != scriptname; which++) ; */
4232 /* if (!PL_origargv[which]) { */
4233 /* errno = EPERM; */
4234 /* Perl_croak(aTHX_ "Permission denied\n"); */
4236 /* PL_origargv[which] = savepv(Perl_form(aTHX_ "/dev/fd/%d/%s", */
4237 /* PerlIO_fileno(PL_rsfp), PL_origargv[which])); */
4238 #if defined(HAS_FCNTL) && defined(F_SETFD)
4239 fcntl(PerlIO_fileno(PL_rsfp),F_SETFD,0); /* ensure no close-on-exec */
4242 PerlProc_execv(Perl_form(aTHX_ "%s/perl"PERL_FS_VER_FMT, BIN_EXP,
4243 (int)PERL_REVISION, (int)PERL_VERSION,
4244 (int)PERL_SUBVERSION), PL_origargv);/* try again */
4246 Perl_croak(aTHX_ "Can't do setuid (suidperl cannot exec perl)\n");
4247 #endif /* IAMSUID */
4249 PERL_UNUSED_ARG(fdscript);
4250 PERL_UNUSED_ARG(suidscript);
4251 if (PL_euid != PL_uid || PL_egid != PL_gid) { /* (suidperl doesn't exist, in fact) */
4252 #ifndef SETUID_SCRIPTS_ARE_SECURE_NOW
4253 PerlLIO_fstat(PerlIO_fileno(PL_rsfp),&PL_statbuf); /* may be either wrapped or real suid */
4254 if ((PL_euid != PL_uid && PL_euid == PL_statbuf.st_uid && PL_statbuf.st_mode & S_ISUID)
4256 (PL_egid != PL_gid && PL_egid == PL_statbuf.st_gid && PL_statbuf.st_mode & S_ISGID)
4259 Perl_croak(aTHX_ "YOU HAVEN'T DISABLED SET-ID SCRIPTS IN THE KERNEL YET!\n\
4260 FIX YOUR KERNEL, PUT A C WRAPPER AROUND THIS SCRIPT, OR USE -u AND UNDUMP!\n");
4261 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4262 /* not set-id, must be wrapped */
4265 PERL_UNUSED_ARG(validarg);
4266 PERL_UNUSED_ARG(scriptname);
4270 S_find_beginning(pTHX)
4274 register const char *s2;
4275 #ifdef MACOS_TRADITIONAL
4279 /* skip forward in input to the real script? */
4281 #ifdef MACOS_TRADITIONAL
4282 /* Since the Mac OS does not honor #! arguments for us, we do it ourselves */
4284 while (PL_doextract || gMacPerl_AlwaysExtract) {
4285 if ((s = sv_gets(PL_linestr, PL_rsfp, 0)) == NULL) {
4286 if (!gMacPerl_AlwaysExtract)
4287 Perl_croak(aTHX_ "No Perl script found in input\n");
4289 if (PL_doextract) /* require explicit override ? */
4290 if (!OverrideExtract(PL_origfilename))
4291 Perl_croak(aTHX_ "User aborted script\n");
4293 PL_doextract = FALSE;
4295 /* Pater peccavi, file does not have #! */
4296 PerlIO_rewind(PL_rsfp);
4301 while (PL_doextract) {
4302 if ((s = sv_gets(PL_linestr, PL_rsfp, 0)) == NULL)
4303 Perl_croak(aTHX_ "No Perl script found in input\n");
4306 if (*s == '#' && s[1] == '!' && ((s = instr(s,"perl")) || (s = instr(s2,"PERL")))) {
4307 PerlIO_ungetc(PL_rsfp, '\n'); /* to keep line count right */
4308 PL_doextract = FALSE;
4309 while (*s && !(isSPACE (*s) || *s == '#')) s++;
4311 while (*s == ' ' || *s == '\t') s++;
4313 while (isDIGIT(s2[-1]) || s2[-1] == '-' || s2[-1] == '.'
4314 || s2[-1] == '_') s2--;
4315 if (strnEQ(s2-4,"perl",4))
4316 while ((s = moreswitches(s)))
4319 #ifdef MACOS_TRADITIONAL
4320 /* We are always searching for the #!perl line in MacPerl,
4321 * so if we find it, still keep the line count correct
4322 * by counting lines we already skipped over
4324 for (; maclines > 0 ; maclines--)
4325 PerlIO_ungetc(PL_rsfp, '\n');
4329 /* gMacPerl_AlwaysExtract is false in MPW tool */
4330 } else if (gMacPerl_AlwaysExtract) {
4342 PL_uid = PerlProc_getuid();
4343 PL_euid = PerlProc_geteuid();
4344 PL_gid = PerlProc_getgid();
4345 PL_egid = PerlProc_getegid();
4347 PL_uid |= PL_gid << 16;
4348 PL_euid |= PL_egid << 16;
4350 /* Should not happen: */
4351 CHECK_MALLOC_TAINT(PL_uid && (PL_euid != PL_uid || PL_egid != PL_gid));
4352 PL_tainting |= (PL_uid && (PL_euid != PL_uid || PL_egid != PL_gid));
4355 * Should go by suidscript, not uid!=euid: why disallow
4356 * system("ls") in scripts run from setuid things?
4357 * Or, is this run before we check arguments and set suidscript?
4358 * What about SETUID_SCRIPTS_ARE_SECURE_NOW: could we use fdscript then?
4359 * (We never have suidscript, can we be sure to have fdscript?)
4360 * Or must then go by UID checks? See comments in forbid_setid also.
4364 /* This is used very early in the lifetime of the program,
4365 * before even the options are parsed, so PL_tainting has
4366 * not been initialized properly. */
4368 Perl_doing_taint(int argc, char *argv[], char *envp[])
4370 #ifndef PERL_IMPLICIT_SYS
4371 /* If we have PERL_IMPLICIT_SYS we can't call getuid() et alia
4372 * before we have an interpreter-- and the whole point of this
4373 * function is to be called at such an early stage. If you are on
4374 * a system with PERL_IMPLICIT_SYS but you do have a concept of
4375 * "tainted because running with altered effective ids', you'll
4376 * have to add your own checks somewhere in here. The two most
4377 * known samples of 'implicitness' are Win32 and NetWare, neither
4378 * of which has much of concept of 'uids'. */
4379 int uid = PerlProc_getuid();
4380 int euid = PerlProc_geteuid();
4381 int gid = PerlProc_getgid();
4382 int egid = PerlProc_getegid();
4389 if (uid && (euid != uid || egid != gid))
4391 #endif /* !PERL_IMPLICIT_SYS */
4392 /* This is a really primitive check; environment gets ignored only
4393 * if -T are the first chars together; otherwise one gets
4394 * "Too late" message. */
4395 if ( argc > 1 && argv[1][0] == '-'
4396 && (argv[1][1] == 't' || argv[1][1] == 'T') )
4401 /* Passing the flag as a single char rather than a string is a slight space
4402 optimisation. The only message that isn't /^-.$/ is
4403 "program input from stdin", which is substituted in place of '\0', which
4404 could never be a command line flag. */
4406 S_forbid_setid(pTHX_ const char flag, const int suidscript)
4409 char string[3] = "-x";
4410 const char *message = "program input from stdin";
4417 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
4418 if (PL_euid != PL_uid)
4419 Perl_croak(aTHX_ "No %s allowed while running setuid", message);
4420 if (PL_egid != PL_gid)
4421 Perl_croak(aTHX_ "No %s allowed while running setgid", message);
4422 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4424 * Checks for UID/GID above "wrong": why disallow
4425 * perl -e 'print "Hello\n"'
4426 * from within setuid things?? Simply drop them: replaced by
4427 * fdscript/suidscript and #ifdef IAMSUID checks below.
4429 * This may be too late for command-line switches. Will catch those on
4430 * the #! line, after finding the script name and setting up
4431 * fdscript/suidscript. Note that suidperl does not get around to
4432 * parsing (and checking) the switches on the #! line, but checks that
4433 * the two sets are identical.
4435 * With SETUID_SCRIPTS_ARE_SECURE_NOW, could we use fdscript, also or
4436 * instead, or would that be "too late"? (We never have suidscript, can
4437 * we be sure to have fdscript?)
4439 * Catch things with suidscript (in descendant of suidperl), even with
4440 * right UID/GID. Was already checked in suidperl, with #ifdef IAMSUID,
4441 * below; but I am paranoid.
4443 * Also see comments about root running a setuid script, elsewhere.
4445 if (suidscript >= 0)
4446 Perl_croak(aTHX_ "No %s allowed with (suid) fdscript", message);
4448 /* PSz 11 Nov 03 Catch it in suidperl, always! */
4449 Perl_croak(aTHX_ "No %s allowed in suidperl", message);
4450 #endif /* IAMSUID */
4454 Perl_init_debugger(pTHX)
4457 HV * const ostash = PL_curstash;
4459 PL_curstash = PL_debstash;
4460 PL_dbargs = GvAV(gv_AVadd((gv_fetchpvs("DB::args", GV_ADDMULTI,
4462 AvREAL_off(PL_dbargs);
4463 PL_DBgv = gv_fetchpvs("DB::DB", GV_ADDMULTI, SVt_PVGV);
4464 PL_DBline = gv_fetchpvs("DB::dbline", GV_ADDMULTI, SVt_PVAV);
4465 PL_DBsub = gv_HVadd(gv_fetchpvs("DB::sub", GV_ADDMULTI, SVt_PVHV));
4466 PL_DBsingle = GvSV((gv_fetchpvs("DB::single", GV_ADDMULTI, SVt_PV)));
4467 sv_setiv(PL_DBsingle, 0);
4468 PL_DBtrace = GvSV((gv_fetchpvs("DB::trace", GV_ADDMULTI, SVt_PV)));
4469 sv_setiv(PL_DBtrace, 0);
4470 PL_DBsignal = GvSV((gv_fetchpvs("DB::signal", GV_ADDMULTI, SVt_PV)));
4471 sv_setiv(PL_DBsignal, 0);
4472 PL_DBassertion = GvSV((gv_fetchpvs("DB::assertion", GV_ADDMULTI, SVt_PV)));
4473 sv_setiv(PL_DBassertion, 0);
4474 PL_curstash = ostash;
4477 #ifndef STRESS_REALLOC
4478 #define REASONABLE(size) (size)
4480 #define REASONABLE(size) (1) /* unreasonable */
4484 Perl_init_stacks(pTHX)
4487 /* start with 128-item stack and 8K cxstack */
4488 PL_curstackinfo = new_stackinfo(REASONABLE(128),
4489 REASONABLE(8192/sizeof(PERL_CONTEXT) - 1));
4490 PL_curstackinfo->si_type = PERLSI_MAIN;
4491 PL_curstack = PL_curstackinfo->si_stack;
4492 PL_mainstack = PL_curstack; /* remember in case we switch stacks */
4494 PL_stack_base = AvARRAY(PL_curstack);
4495 PL_stack_sp = PL_stack_base;
4496 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
4498 Newx(PL_tmps_stack,REASONABLE(128),SV*);
4501 PL_tmps_max = REASONABLE(128);
4503 Newx(PL_markstack,REASONABLE(32),I32);
4504 PL_markstack_ptr = PL_markstack;
4505 PL_markstack_max = PL_markstack + REASONABLE(32);
4509 Newx(PL_scopestack,REASONABLE(32),I32);
4510 PL_scopestack_ix = 0;
4511 PL_scopestack_max = REASONABLE(32);
4513 Newx(PL_savestack,REASONABLE(128),ANY);
4514 PL_savestack_ix = 0;
4515 PL_savestack_max = REASONABLE(128);
4524 while (PL_curstackinfo->si_next)
4525 PL_curstackinfo = PL_curstackinfo->si_next;
4526 while (PL_curstackinfo) {
4527 PERL_SI *p = PL_curstackinfo->si_prev;
4528 /* curstackinfo->si_stack got nuked by sv_free_arenas() */
4529 Safefree(PL_curstackinfo->si_cxstack);
4530 Safefree(PL_curstackinfo);
4531 PL_curstackinfo = p;
4533 Safefree(PL_tmps_stack);
4534 Safefree(PL_markstack);
4535 Safefree(PL_scopestack);
4536 Safefree(PL_savestack);
4546 lex_start(PL_linestr);
4548 PL_subname = newSVpvs("main");
4552 S_init_predump_symbols(pTHX)
4558 sv_setpvn(get_sv("\"", TRUE), " ", 1);
4559 PL_stdingv = gv_fetchpvs("STDIN", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4560 GvMULTI_on(PL_stdingv);
4561 io = GvIOp(PL_stdingv);
4562 IoTYPE(io) = IoTYPE_RDONLY;
4563 IoIFP(io) = PerlIO_stdin();
4564 tmpgv = gv_fetchpvs("stdin", GV_ADD|GV_NOTQUAL, SVt_PV);
4566 GvIOp(tmpgv) = (IO*)SvREFCNT_inc_simple(io);
4568 tmpgv = gv_fetchpvs("STDOUT", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4571 IoTYPE(io) = IoTYPE_WRONLY;
4572 IoOFP(io) = IoIFP(io) = PerlIO_stdout();
4574 tmpgv = gv_fetchpvs("stdout", GV_ADD|GV_NOTQUAL, SVt_PV);
4576 GvIOp(tmpgv) = (IO*)SvREFCNT_inc_simple(io);
4578 PL_stderrgv = gv_fetchpvs("STDERR", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4579 GvMULTI_on(PL_stderrgv);
4580 io = GvIOp(PL_stderrgv);
4581 IoTYPE(io) = IoTYPE_WRONLY;
4582 IoOFP(io) = IoIFP(io) = PerlIO_stderr();
4583 tmpgv = gv_fetchpvs("stderr", GV_ADD|GV_NOTQUAL, SVt_PV);
4585 GvIOp(tmpgv) = (IO*)SvREFCNT_inc_simple(io);
4587 PL_statname = newSV(0); /* last filename we did stat on */
4589 Safefree(PL_osname);
4590 PL_osname = savepv(OSNAME);
4594 Perl_init_argv_symbols(pTHX_ register int argc, register char **argv)
4597 argc--,argv++; /* skip name of script */
4598 if (PL_doswitches) {
4599 for (; argc > 0 && **argv == '-'; argc--,argv++) {
4603 if (argv[0][1] == '-' && !argv[0][2]) {
4607 if ((s = strchr(argv[0], '='))) {
4608 const char *const start_name = argv[0] + 1;
4609 sv_setpv(GvSV(gv_fetchpvn_flags(start_name, s - start_name,
4610 TRUE, SVt_PV)), s + 1);
4613 sv_setiv(GvSV(gv_fetchpv(argv[0]+1, GV_ADD, SVt_PV)),1);
4616 if ((PL_argvgv = gv_fetchpvs("ARGV", GV_ADD|GV_NOTQUAL, SVt_PVAV))) {
4617 GvMULTI_on(PL_argvgv);
4618 (void)gv_AVadd(PL_argvgv);
4619 av_clear(GvAVn(PL_argvgv));
4620 for (; argc > 0; argc--,argv++) {
4621 SV * const sv = newSVpv(argv[0],0);
4622 av_push(GvAVn(PL_argvgv),sv);
4623 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
4624 if (PL_unicode & PERL_UNICODE_ARGV_FLAG)
4627 if (PL_unicode & PERL_UNICODE_WIDESYSCALLS_FLAG) /* Sarathy? */
4628 (void)sv_utf8_decode(sv);
4634 S_init_postdump_symbols(pTHX_ register int argc, register char **argv, register char **env)
4639 PL_toptarget = newSV(0);
4640 sv_upgrade(PL_toptarget, SVt_PVFM);
4641 sv_setpvn(PL_toptarget, "", 0);
4642 PL_bodytarget = newSV(0);
4643 sv_upgrade(PL_bodytarget, SVt_PVFM);
4644 sv_setpvn(PL_bodytarget, "", 0);
4645 PL_formtarget = PL_bodytarget;
4649 init_argv_symbols(argc,argv);
4651 if ((tmpgv = gv_fetchpvs("0", GV_ADD|GV_NOTQUAL, SVt_PV))) {
4652 #ifdef MACOS_TRADITIONAL
4653 /* $0 is not majick on a Mac */
4654 sv_setpv(GvSV(tmpgv),MacPerl_MPWFileName(PL_origfilename));
4656 sv_setpv(GvSV(tmpgv),PL_origfilename);
4657 magicname("0", "0", 1);
4660 if ((PL_envgv = gv_fetchpvs("ENV", GV_ADD|GV_NOTQUAL, SVt_PVHV))) {
4662 bool env_is_not_environ;
4663 GvMULTI_on(PL_envgv);
4664 hv = GvHVn(PL_envgv);
4665 hv_magic(hv, NULL, PERL_MAGIC_env);
4667 #ifdef USE_ENVIRON_ARRAY
4668 /* Note that if the supplied env parameter is actually a copy
4669 of the global environ then it may now point to free'd memory
4670 if the environment has been modified since. To avoid this
4671 problem we treat env==NULL as meaning 'use the default'
4675 env_is_not_environ = env != environ;
4676 if (env_is_not_environ
4677 # ifdef USE_ITHREADS
4678 && PL_curinterp == aTHX
4685 char** origenv = environ;
4688 for (; *env; env++) {
4689 if (!(s = strchr(*env,'=')) || s == *env)
4691 #if defined(MSDOS) && !defined(DJGPP)
4696 sv = newSVpv(s+1, 0);
4697 (void)hv_store(hv, *env, s - *env, sv, 0);
4698 if (env_is_not_environ)
4700 if (origenv != environ) {
4701 /* realloc has shifted us */
4702 env = (env - origenv) + environ;
4707 #endif /* USE_ENVIRON_ARRAY */
4708 #endif /* !PERL_MICRO */
4711 if ((tmpgv = gv_fetchpvs("$", GV_ADD|GV_NOTQUAL, SVt_PV))) {
4712 SvREADONLY_off(GvSV(tmpgv));
4713 sv_setiv(GvSV(tmpgv), (IV)PerlProc_getpid());
4714 SvREADONLY_on(GvSV(tmpgv));
4716 #ifdef THREADS_HAVE_PIDS
4717 PL_ppid = (IV)getppid();
4720 /* touch @F array to prevent spurious warnings 20020415 MJD */
4722 (void) get_av("main::F", TRUE | GV_ADDMULTI);
4724 /* touch @- and @+ arrays to prevent spurious warnings 20020415 MJD */
4725 (void) get_av("main::-", TRUE | GV_ADDMULTI);
4726 (void) get_av("main::+", TRUE | GV_ADDMULTI);
4730 S_init_perllib(pTHX)
4736 s = PerlEnv_getenv("PERL5LIB");
4738 * It isn't possible to delete an environment variable with
4739 * PERL_USE_SAFE_PUTENV set unless unsetenv() is also available, so in that
4740 * case we treat PERL5LIB as undefined if it has a zero-length value.
4742 #if defined(PERL_USE_SAFE_PUTENV) && ! defined(HAS_UNSETENV)
4743 if (s && *s != '\0')
4747 incpush(s, TRUE, TRUE, TRUE, FALSE);
4749 incpush(PerlEnv_getenv("PERLLIB"), FALSE, FALSE, TRUE, FALSE);
4751 /* Treat PERL5?LIB as a possible search list logical name -- the
4752 * "natural" VMS idiom for a Unix path string. We allow each
4753 * element to be a set of |-separated directories for compatibility.
4757 if (my_trnlnm("PERL5LIB",buf,0))
4758 do { incpush(buf,TRUE,TRUE,TRUE,FALSE); } while (my_trnlnm("PERL5LIB",buf,++idx));
4760 while (my_trnlnm("PERLLIB",buf,idx++)) incpush(buf,FALSE,FALSE,TRUE,FALSE);
4764 /* Use the ~-expanded versions of APPLLIB (undocumented),
4765 ARCHLIB PRIVLIB SITEARCH SITELIB VENDORARCH and VENDORLIB
4768 incpush(APPLLIB_EXP, TRUE, TRUE, TRUE, TRUE);
4772 incpush(ARCHLIB_EXP, FALSE, FALSE, TRUE, TRUE);
4774 #ifdef MACOS_TRADITIONAL
4777 SV * privdir = newSV(0);
4778 char * macperl = PerlEnv_getenv("MACPERL");
4783 Perl_sv_setpvf(aTHX_ privdir, "%slib:", macperl);
4784 if (PerlLIO_stat(SvPVX(privdir), &tmpstatbuf) >= 0 && S_ISDIR(tmpstatbuf.st_mode))
4785 incpush(SvPVX(privdir), TRUE, FALSE, TRUE, FALSE);
4786 Perl_sv_setpvf(aTHX_ privdir, "%ssite_perl:", macperl);
4787 if (PerlLIO_stat(SvPVX(privdir), &tmpstatbuf) >= 0 && S_ISDIR(tmpstatbuf.st_mode))
4788 incpush(SvPVX(privdir), TRUE, FALSE, TRUE, FALSE);
4790 SvREFCNT_dec(privdir);
4793 incpush(":", FALSE, FALSE, TRUE, FALSE);
4796 # define PRIVLIB_EXP "/usr/local/lib/perl5:/usr/local/lib/perl"
4799 incpush(PRIVLIB_EXP, TRUE, FALSE, TRUE, TRUE);
4801 incpush(PRIVLIB_EXP, FALSE, FALSE, TRUE, TRUE);
4805 /* sitearch is always relative to sitelib on Windows for
4806 * DLL-based path intuition to work correctly */
4807 # if !defined(WIN32)
4808 incpush(SITEARCH_EXP, FALSE, FALSE, TRUE, TRUE);
4814 /* this picks up sitearch as well */
4815 incpush(SITELIB_EXP, TRUE, FALSE, TRUE, TRUE);
4817 incpush(SITELIB_EXP, FALSE, FALSE, TRUE, TRUE);
4821 #if defined(SITELIB_STEM) && defined(PERL_INC_VERSION_LIST)
4822 /* Search for version-specific dirs below here */
4823 incpush(SITELIB_STEM, FALSE, TRUE, TRUE, TRUE);
4826 #ifdef PERL_VENDORARCH_EXP
4827 /* vendorarch is always relative to vendorlib on Windows for
4828 * DLL-based path intuition to work correctly */
4829 # if !defined(WIN32)
4830 incpush(PERL_VENDORARCH_EXP, FALSE, FALSE, TRUE, TRUE);
4834 #ifdef PERL_VENDORLIB_EXP
4836 incpush(PERL_VENDORLIB_EXP, TRUE, FALSE, TRUE, TRUE); /* this picks up vendorarch as well */
4838 incpush(PERL_VENDORLIB_EXP, FALSE, FALSE, TRUE, TRUE);
4842 #ifdef PERL_VENDORLIB_STEM /* Search for version-specific dirs below here */
4843 incpush(PERL_VENDORLIB_STEM, FALSE, TRUE, TRUE, TRUE);
4846 #ifdef PERL_OTHERLIBDIRS
4847 incpush(PERL_OTHERLIBDIRS, TRUE, TRUE, TRUE, TRUE);
4851 incpush(".", FALSE, FALSE, TRUE, FALSE);
4852 #endif /* MACOS_TRADITIONAL */
4855 #if defined(DOSISH) || defined(EPOC) || defined(__SYMBIAN32__)
4856 # define PERLLIB_SEP ';'
4859 # define PERLLIB_SEP '|'
4861 # if defined(MACOS_TRADITIONAL)
4862 # define PERLLIB_SEP ','
4864 # define PERLLIB_SEP ':'
4868 #ifndef PERLLIB_MANGLE
4869 # define PERLLIB_MANGLE(s,n) (s)
4872 /* Push a directory onto @INC if it exists.
4873 Generate a new SV if we do this, to save needing to copy the SV we push
4876 S_incpush_if_exists(pTHX_ SV *dir)
4880 if (PerlLIO_stat(SvPVX_const(dir), &tmpstatbuf) >= 0 &&
4881 S_ISDIR(tmpstatbuf.st_mode)) {
4882 av_push(GvAVn(PL_incgv), dir);
4889 S_incpush(pTHX_ const char *dir, bool addsubdirs, bool addoldvers, bool usesep,
4894 const char *p = dir;
4899 if (addsubdirs || addoldvers) {
4903 /* Break at all separators */
4905 SV *libdir = newSV(0);
4908 /* skip any consecutive separators */
4910 while ( *p == PERLLIB_SEP ) {
4911 /* Uncomment the next line for PATH semantics */
4912 /* av_push(GvAVn(PL_incgv), newSVpvs(".")); */
4917 if ( usesep && (s = strchr(p, PERLLIB_SEP)) != NULL ) {
4918 sv_setpvn(libdir, PERLLIB_MANGLE(p, (STRLEN)(s - p)),
4923 sv_setpv(libdir, PERLLIB_MANGLE(p, 0));
4924 p = NULL; /* break out */
4926 #ifdef MACOS_TRADITIONAL
4927 if (!strchr(SvPVX(libdir), ':')) {
4930 sv_setpv(libdir, MacPerl_CanonDir(SvPVX(libdir), buf, 0));
4932 if (SvPVX(libdir)[SvCUR(libdir)-1] != ':')
4933 sv_catpvs(libdir, ":");
4936 /* Do the if() outside the #ifdef to avoid warnings about an unused
4939 #ifdef PERL_RELOCATABLE_INC
4941 * Relocatable include entries are marked with a leading .../
4944 * 0: Remove that leading ".../"
4945 * 1: Remove trailing executable name (anything after the last '/')
4946 * from the perl path to give a perl prefix
4948 * While the @INC element starts "../" and the prefix ends with a real
4949 * directory (ie not . or ..) chop that real directory off the prefix
4950 * and the leading "../" from the @INC element. ie a logical "../"
4952 * Finally concatenate the prefix and the remainder of the @INC element
4953 * The intent is that /usr/local/bin/perl and .../../lib/perl5
4954 * generates /usr/local/lib/perl5
4956 const char *libpath = SvPVX(libdir);
4957 STRLEN libpath_len = SvCUR(libdir);
4958 if (libpath_len >= 4 && memEQ (libpath, ".../", 4)) {
4960 SV * const caret_X = get_sv("\030", 0);
4961 /* Going to use the SV just as a scratch buffer holding a C
4967 /* $^X is *the* source of taint if tainting is on, hence
4968 SvPOK() won't be true. */
4970 assert(SvPOKp(caret_X));
4971 prefix_sv = newSVpvn(SvPVX(caret_X), SvCUR(caret_X));
4972 /* Firstly take off the leading .../
4973 If all else fail we'll do the paths relative to the current
4975 sv_chop(libdir, libpath + 4);
4976 /* Don't use SvPV as we're intentionally bypassing taining,
4977 mortal copies that the mg_get of tainting creates, and
4978 corruption that seems to come via the save stack.
4979 I guess that the save stack isn't correctly set up yet. */
4980 libpath = SvPVX(libdir);
4981 libpath_len = SvCUR(libdir);
4983 /* This would work more efficiently with memrchr, but as it's
4984 only a GNU extension we'd need to probe for it and
4985 implement our own. Not hard, but maybe not worth it? */
4987 prefix = SvPVX(prefix_sv);
4988 lastslash = strrchr(prefix, '/');
4990 /* First time in with the *lastslash = '\0' we just wipe off
4991 the trailing /perl from (say) /usr/foo/bin/perl
4995 while ((*lastslash = '\0'), /* Do that, come what may. */
4996 (libpath_len >= 3 && memEQ(libpath, "../", 3)
4997 && (lastslash = strrchr(prefix, '/')))) {
4998 if (lastslash[1] == '\0'
4999 || (lastslash[1] == '.'
5000 && (lastslash[2] == '/' /* ends "/." */
5001 || (lastslash[2] == '/'
5002 && lastslash[3] == '/' /* or "/.." */
5004 /* Prefix ends "/" or "/." or "/..", any of which
5005 are fishy, so don't do any more logical cleanup.
5009 /* Remove leading "../" from path */
5012 /* Next iteration round the loop removes the last
5013 directory name from prefix by writing a '\0' in
5014 the while clause. */
5016 /* prefix has been terminated with a '\0' to the correct
5017 length. libpath points somewhere into the libdir SV.
5018 We need to join the 2 with '/' and drop the result into
5020 tempsv = Perl_newSVpvf(aTHX_ "%s/%s", prefix, libpath);
5021 SvREFCNT_dec(libdir);
5022 /* And this is the new libdir. */
5025 (PL_uid != PL_euid || PL_gid != PL_egid)) {
5026 /* Need to taint reloccated paths if running set ID */
5027 SvTAINTED_on(libdir);
5030 SvREFCNT_dec(prefix_sv);
5035 * BEFORE pushing libdir onto @INC we may first push version- and
5036 * archname-specific sub-directories.
5038 if (addsubdirs || addoldvers) {
5039 #ifdef PERL_INC_VERSION_LIST
5040 /* Configure terminates PERL_INC_VERSION_LIST with a NULL */
5041 const char * const incverlist[] = { PERL_INC_VERSION_LIST };
5042 const char * const *incver;
5048 if ((unix = tounixspec_ts(SvPV(libdir,len),NULL)) != NULL) {
5050 while (unix[len-1] == '/') len--; /* Cosmetic */
5051 sv_usepvn(libdir,unix,len);
5054 PerlIO_printf(Perl_error_log,
5055 "Failed to unixify @INC element \"%s\"\n",
5059 #ifdef MACOS_TRADITIONAL
5060 #define PERL_AV_SUFFIX_FMT ""
5061 #define PERL_ARCH_FMT "%s:"
5062 #define PERL_ARCH_FMT_PATH PERL_FS_VER_FMT PERL_AV_SUFFIX_FMT
5064 #define PERL_AV_SUFFIX_FMT "/"
5065 #define PERL_ARCH_FMT "/%s"
5066 #define PERL_ARCH_FMT_PATH PERL_AV_SUFFIX_FMT PERL_FS_VER_FMT
5068 /* .../version/archname if -d .../version/archname */
5069 Perl_sv_setpvf(aTHX_ subdir, "%"SVf PERL_ARCH_FMT_PATH PERL_ARCH_FMT,
5071 (int)PERL_REVISION, (int)PERL_VERSION,
5072 (int)PERL_SUBVERSION, ARCHNAME);
5073 subdir = S_incpush_if_exists(aTHX_ subdir);
5075 /* .../version if -d .../version */
5076 Perl_sv_setpvf(aTHX_ subdir, "%"SVf PERL_ARCH_FMT_PATH,
5078 (int)PERL_REVISION, (int)PERL_VERSION,
5079 (int)PERL_SUBVERSION);
5080 subdir = S_incpush_if_exists(aTHX_ subdir);
5082 /* .../archname if -d .../archname */
5083 Perl_sv_setpvf(aTHX_ subdir, "%"SVf PERL_ARCH_FMT,
5084 SVfARG(libdir), ARCHNAME);
5085 subdir = S_incpush_if_exists(aTHX_ subdir);
5089 #ifdef PERL_INC_VERSION_LIST
5091 for (incver = incverlist; *incver; incver++) {
5092 /* .../xxx if -d .../xxx */
5093 Perl_sv_setpvf(aTHX_ subdir, "%"SVf PERL_ARCH_FMT,
5094 SVfARG(libdir), *incver);
5095 subdir = S_incpush_if_exists(aTHX_ subdir);
5101 /* finally push this lib directory on the end of @INC */
5102 av_push(GvAVn(PL_incgv), libdir);
5105 assert (SvREFCNT(subdir) == 1);
5106 SvREFCNT_dec(subdir);
5112 Perl_call_list(pTHX_ I32 oldscope, AV *paramList)
5116 const line_t oldline = CopLINE(PL_curcop);
5122 while (av_len(paramList) >= 0) {
5123 cv = (CV*)av_shift(paramList);
5125 if (paramList == PL_beginav) {
5126 /* save PL_beginav for compiler */
5127 Perl_av_create_and_push(aTHX_ &PL_beginav_save, (SV*)cv);
5129 else if (paramList == PL_checkav) {
5130 /* save PL_checkav for compiler */
5131 Perl_av_create_and_push(aTHX_ &PL_checkav_save, (SV*)cv);
5133 else if (paramList == PL_unitcheckav) {
5134 /* save PL_unitcheckav for compiler */
5135 Perl_av_create_and_push(aTHX_ &PL_unitcheckav_save, (SV*)cv);
5146 PL_madskills |= 16384;
5151 PL_madskills &= ~16384;
5154 (void)SvPV_const(atsv, len);
5155 if (PL_madskills && PL_minus_c && paramList == PL_beginav)
5156 break; /* not really trying to run, so just wing it */
5158 PL_curcop = &PL_compiling;
5159 CopLINE_set(PL_curcop, oldline);
5160 if (paramList == PL_beginav)
5161 sv_catpvs(atsv, "BEGIN failed--compilation aborted");
5163 Perl_sv_catpvf(aTHX_ atsv,
5164 "%s failed--call queue aborted",
5165 paramList == PL_checkav ? "CHECK"
5166 : paramList == PL_initav ? "INIT"
5167 : paramList == PL_unitcheckav ? "UNITCHECK"
5169 while (PL_scopestack_ix > oldscope)
5172 Perl_croak(aTHX_ "%"SVf"", SVfARG(atsv));
5179 /* my_exit() was called */
5180 while (PL_scopestack_ix > oldscope)
5183 PL_curstash = PL_defstash;
5184 PL_curcop = &PL_compiling;
5185 CopLINE_set(PL_curcop, oldline);
5187 if (PL_madskills && PL_minus_c && paramList == PL_beginav)
5188 return; /* not really trying to run, so just wing it */
5189 if (PL_statusvalue && !(PL_exit_flags & PERL_EXIT_EXPECTED)) {
5190 if (paramList == PL_beginav)
5191 Perl_croak(aTHX_ "BEGIN failed--compilation aborted");
5193 Perl_croak(aTHX_ "%s failed--call queue aborted",
5194 paramList == PL_checkav ? "CHECK"
5195 : paramList == PL_initav ? "INIT"
5196 : paramList == PL_unitcheckav ? "UNITCHECK"
5203 PL_curcop = &PL_compiling;
5204 CopLINE_set(PL_curcop, oldline);
5207 PerlIO_printf(Perl_error_log, "panic: restartop\n");
5216 Perl_my_exit(pTHX_ U32 status)
5219 DEBUG_S(PerlIO_printf(Perl_debug_log, "my_exit: thread %p, status %lu\n",
5220 (void*)thr, (unsigned long) status));
5229 STATUS_EXIT_SET(status);
5236 Perl_my_failure_exit(pTHX)
5240 /* We have been called to fall on our sword. The desired exit code
5241 * should be already set in STATUS_UNIX, but could be shifted over
5242 * by 8 bits. STATUS_UNIX_EXIT_SET will handle the cases where a
5245 * If an error code has not been set, then force the issue.
5247 if (MY_POSIX_EXIT) {
5249 /* In POSIX_EXIT mode follow Perl documentations and use 255 for
5250 * the exit code when there isn't an error.
5253 if (STATUS_UNIX == 0)
5254 STATUS_UNIX_EXIT_SET(255);
5256 STATUS_UNIX_EXIT_SET(STATUS_UNIX);
5258 /* The exit code could have been set by $? or vmsish which
5259 * means that it may not be fatal. So convert
5260 * success/warning codes to fatal.
5262 if ((STATUS_NATIVE & (STS$K_SEVERE|STS$K_ERROR)) == 0)
5263 STATUS_UNIX_EXIT_SET(255);
5267 /* Traditionally Perl on VMS always expects a Fatal Error. */
5268 if (vaxc$errno & 1) {
5270 /* So force success status to failure */
5271 if (STATUS_NATIVE & 1)
5276 STATUS_UNIX = EINTR; /* In case something cares */
5281 STATUS_NATIVE = vaxc$errno; /* Should already be this */
5283 /* Encode the severity code */
5284 severity = STATUS_NATIVE & STS$M_SEVERITY;
5285 STATUS_UNIX = (severity ? severity : 1) << 8;
5287 /* Perl expects this to be a fatal error */
5288 if (severity != STS$K_SEVERE)
5297 STATUS_UNIX_SET(errno);
5299 exitstatus = STATUS_UNIX >> 8;
5300 if (exitstatus & 255)
5301 STATUS_UNIX_SET(exitstatus);
5303 STATUS_UNIX_SET(255);
5310 S_my_exit_jump(pTHX)
5315 SvREFCNT_dec(PL_e_script);
5319 POPSTACK_TO(PL_mainstack);
5327 read_e_script(pTHX_ int idx, SV *buf_sv, int maxlen)
5330 const char * const p = SvPVX_const(PL_e_script);
5331 const char *nl = strchr(p, '\n');
5333 PERL_UNUSED_ARG(idx);
5334 PERL_UNUSED_ARG(maxlen);
5336 nl = (nl) ? nl+1 : SvEND(PL_e_script);
5338 filter_del(read_e_script);
5341 sv_catpvn(buf_sv, p, nl-p);
5342 sv_chop(PL_e_script, nl);
5348 * c-indentation-style: bsd
5350 * indent-tabs-mode: t
5353 * ex: set ts=8 sts=4 sw=4 noet: