3 * Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4 * 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 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
13 * of mithril and of elven-glass
14 * --from Bilbo's song of EƤrendil
16 * [p.236 of _The Lord of the Rings_, II/i: "Many Meetings"]
19 /* This file contains the top-level functions that are used to create, use
20 * and destroy a perl interpreter, plus the functions used by XS code to
21 * call back into perl. Note that it does not contain the actual main()
22 * function of the interpreter; that can be found in perlmain.c
27 * Be proud that perl(1) may proclaim:
28 * Setuid Perl scripts are safer than C programs ...
29 * Do not abandon (deprecate) suidperl. Do not advocate C wrappers.
31 * The flow was: perl starts, notices script is suid, execs suidperl with same
32 * arguments; suidperl opens script, checks many things, sets itself with
33 * right UID, execs perl with similar arguments but with script pre-opened on
34 * /dev/fd/xxx; perl checks script is as should be and does work. This was
35 * insecure: see perlsec(1) for many problems with this approach.
37 * The "correct" flow should be: perl starts, opens script and notices it is
38 * suid, checks many things, execs suidperl with similar arguments but with
39 * script on /dev/fd/xxx; suidperl checks script and /dev/fd/xxx object are
40 * same, checks arguments match #! line, sets itself with right UID, execs
41 * perl with same arguments; perl checks many things and does work.
43 * (Opening the script in perl instead of suidperl, we "lose" scripts that
44 * are readable to the target UID but not to the invoker. Where did
45 * unreadable scripts work anyway?)
47 * For now, suidperl and perl are pretty much the same large and cumbersome
48 * program, so suidperl can check its argument list (see comments elsewhere).
51 * Original bug report:
52 * http://bugs.perl.org/index.html?req=bug_id&bug_id=20010322.218
53 * http://rt.perl.org/rt2/Ticket/Display.html?id=6511
54 * Comments and discussion with Debian:
55 * http://bugs.debian.org/203426
56 * http://bugs.debian.org/220486
57 * Debian Security Advisory DSA 431-1 (does not fully fix problem):
58 * http://www.debian.org/security/2004/dsa-431
60 * http://cve.mitre.org/cgi-bin/cvename.cgi?name=CAN-2003-0618
61 * Previous versions of this patch sent to perl5-porters:
62 * http://www.mail-archive.com/perl5-porters@perl.org/msg71953.html
63 * http://www.mail-archive.com/perl5-porters@perl.org/msg75245.html
64 * http://www.mail-archive.com/perl5-porters@perl.org/msg75563.html
65 * http://www.mail-archive.com/perl5-porters@perl.org/msg75635.html
67 Paul Szabo - psz@maths.usyd.edu.au http://www.maths.usyd.edu.au:8000/u/psz/
68 School of Mathematics and Statistics University of Sydney 2006 Australia
72 * Use truthful, neat, specific error messages.
73 * Cannot always hide the truth; security must not depend on doing so.
77 * Use global(?), thread-local fdscript for easier checks.
78 * (I do not understand how we could possibly get a thread race:
79 * do not all threads go through the same initialization? Or in
80 * fact, are not threads started only after we get the script and
81 * so know what to do? Oh well, make things super-safe...)
85 #define PERL_IN_PERL_C
87 #include "patchlevel.h" /* for local_patches */
91 char *nw_get_sitelib(const char *pl);
94 /* XXX If this causes problems, set i_unistd=undef in the hint file. */
99 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
101 # include <sys/wait.h>
104 # include <sys/uio.h>
109 char control[CMSG_SPACE(sizeof(int))];
126 #if !defined(STANDARD_C) && !defined(HAS_GETENV_PROTOTYPE) && !defined(PERL_MICRO)
127 char *getenv (char *); /* Usually in <stdlib.h> */
130 static I32 read_e_script(pTHX_ int idx, SV *buf_sv, int maxlen);
134 /* Drop scriptname */
135 # define validate_suid(validarg, scriptname, fdscript, suidscript, linestr_sv, rsfp) S_validate_suid(aTHX_ validarg, fdscript, suidscript, linestr_sv, rsfp)
137 /* Drop suidscript */
138 # define validate_suid(validarg, scriptname, fdscript, suidscript, linestr_sv, rsfp) S_validate_suid(aTHX_ validarg, scriptname, fdscript, linestr_sv, rsfp)
141 # ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
142 /* Drop everything. Heck, don't even try to call it */
143 # define validate_suid(validarg, scriptname, fdscript, suidscript, linestr_sv, rsfp) NOOP
145 /* Drop almost everything */
146 # define validate_suid(validarg, scriptname, fdscript, suidscript, linestr_sv, rsfp) S_validate_suid(aTHX_ rsfp)
150 #define CALL_BODY_EVAL(myop) \
151 if (PL_op == (myop)) \
152 PL_op = PL_ppaddr[OP_ENTEREVAL](aTHX); \
156 #define CALL_BODY_SUB(myop) \
157 if (PL_op == (myop)) \
158 PL_op = PL_ppaddr[OP_ENTERSUB](aTHX); \
162 #define CALL_LIST_BODY(cv) \
163 PUSHMARK(PL_stack_sp); \
164 call_sv(MUTABLE_SV((cv)), G_EVAL|G_DISCARD);
167 S_init_tls_and_interp(PerlInterpreter *my_perl)
171 PERL_SET_INTERP(my_perl);
172 #if defined(USE_ITHREADS)
175 PERL_SET_THX(my_perl);
178 MUTEX_INIT(&PL_dollarzero_mutex);
180 #ifdef PERL_IMPLICIT_CONTEXT
181 MUTEX_INIT(&PL_my_ctx_mutex);
184 #if defined(USE_ITHREADS)
187 /* This always happens for non-ithreads */
190 PERL_SET_THX(my_perl);
195 /* these implement the PERL_SYS_INIT, PERL_SYS_INIT3, PERL_SYS_TERM macros */
198 Perl_sys_init(int* argc, char*** argv)
202 PERL_ARGS_ASSERT_SYS_INIT;
204 PERL_UNUSED_ARG(argc); /* may not be used depending on _BODY macro */
205 PERL_UNUSED_ARG(argv);
206 PERL_SYS_INIT_BODY(argc, argv);
210 Perl_sys_init3(int* argc, char*** argv, char*** env)
214 PERL_ARGS_ASSERT_SYS_INIT3;
216 PERL_UNUSED_ARG(argc); /* may not be used depending on _BODY macro */
217 PERL_UNUSED_ARG(argv);
218 PERL_UNUSED_ARG(env);
219 PERL_SYS_INIT3_BODY(argc, argv, env);
226 if (!PL_veto_cleanup) {
227 PERL_SYS_TERM_BODY();
232 #ifdef PERL_IMPLICIT_SYS
234 perl_alloc_using(struct IPerlMem* ipM, struct IPerlMem* ipMS,
235 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
236 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
237 struct IPerlDir* ipD, struct IPerlSock* ipS,
238 struct IPerlProc* ipP)
240 PerlInterpreter *my_perl;
242 PERL_ARGS_ASSERT_PERL_ALLOC_USING;
244 /* Newx() needs interpreter, so call malloc() instead */
245 my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
246 S_init_tls_and_interp(my_perl);
247 Zero(my_perl, 1, PerlInterpreter);
257 INIT_TRACK_MEMPOOL(PL_memory_debug_header, my_perl);
264 =head1 Embedding Functions
266 =for apidoc perl_alloc
268 Allocates a new Perl interpreter. See L<perlembed>.
276 PerlInterpreter *my_perl;
278 /* Newx() needs interpreter, so call malloc() instead */
279 my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
281 S_init_tls_and_interp(my_perl);
282 #ifndef PERL_TRACK_MEMPOOL
283 return (PerlInterpreter *) ZeroD(my_perl, 1, PerlInterpreter);
285 Zero(my_perl, 1, PerlInterpreter);
286 INIT_TRACK_MEMPOOL(PL_memory_debug_header, my_perl);
290 #endif /* PERL_IMPLICIT_SYS */
293 =for apidoc perl_construct
295 Initializes a new Perl interpreter. See L<perlembed>.
301 perl_construct(pTHXx)
305 PERL_ARGS_ASSERT_PERL_CONSTRUCT;
309 PL_perl_destruct_level = 1;
311 PERL_UNUSED_ARG(my_perl);
312 if (PL_perl_destruct_level > 0)
315 PL_curcop = &PL_compiling; /* needed by ckWARN, right away */
317 /* set read-only and try to insure than we wont see REFCNT==0
320 SvREADONLY_on(&PL_sv_undef);
321 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
323 sv_setpv(&PL_sv_no,PL_No);
324 /* value lookup in void context - happens to have the side effect
325 of caching the numeric forms. However, as &PL_sv_no doesn't contain
326 a string that is a valid numer, we have to turn the public flags by
332 SvREADONLY_on(&PL_sv_no);
333 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
335 sv_setpv(&PL_sv_yes,PL_Yes);
338 SvREADONLY_on(&PL_sv_yes);
339 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
341 SvREADONLY_on(&PL_sv_placeholder);
342 SvREFCNT(&PL_sv_placeholder) = (~(U32)0)/2;
344 PL_sighandlerp = (Sighandler_t) Perl_sighandler;
345 #ifdef PERL_USES_PL_PIDSTATUS
346 PL_pidstatus = newHV();
349 PL_rs = newSVpvs("\n");
359 SET_NUMERIC_STANDARD();
361 #if defined(LOCAL_PATCH_COUNT)
362 PL_localpatches = local_patches; /* For possible -v */
365 #ifdef HAVE_INTERP_INTERN
369 PerlIO_init(aTHX); /* Hook to IO system */
371 PL_fdpid = newAV(); /* for remembering popen pids by fd */
372 PL_modglobal = newHV(); /* pointers to per-interpreter module globals */
373 PL_errors = newSVpvs("");
374 sv_setpvs(PERL_DEBUG_PAD(0), ""); /* For regex debugging. */
375 sv_setpvs(PERL_DEBUG_PAD(1), ""); /* ext/re needs these */
376 sv_setpvs(PERL_DEBUG_PAD(2), ""); /* even without DEBUGGING. */
378 /* First entry is a list of empty elements. It needs to be initialised
379 else all hell breaks loose in S_find_uninit_var(). */
380 Perl_av_create_and_push(aTHX_ &PL_regex_padav, newSVpvs(""));
381 PL_regex_pad = AvARRAY(PL_regex_padav);
383 #ifdef USE_REENTRANT_API
384 Perl_reentrant_init(aTHX);
387 /* Note that strtab is a rather special HV. Assumptions are made
388 about not iterating on it, and not adding tie magic to it.
389 It is properly deallocated in perl_destruct() */
392 HvSHAREKEYS_off(PL_strtab); /* mandatory */
393 hv_ksplit(PL_strtab, 512);
395 #if defined(__DYNAMIC__) && (defined(NeXT) || defined(__NeXT__))
396 _dyld_lookup_and_bind
397 ("__environ", (unsigned long *) &environ_pointer, NULL);
401 # ifdef USE_ENVIRON_ARRAY
402 PL_origenviron = environ;
406 /* Use sysconf(_SC_CLK_TCK) if available, if not
407 * available or if the sysconf() fails, use the HZ.
408 * BeOS has those, but returns the wrong value.
409 * The HZ if not originally defined has been by now
410 * been defined as CLK_TCK, if available. */
411 #if defined(HAS_SYSCONF) && defined(_SC_CLK_TCK) && !defined(__BEOS__)
412 PL_clocktick = sysconf(_SC_CLK_TCK);
413 if (PL_clocktick <= 0)
417 PL_stashcache = newHV();
419 PL_patchlevel = Perl_newSVpvf(aTHX_ "v%d.%d.%d", (int)PERL_REVISION,
420 (int)PERL_VERSION, (int)PERL_SUBVERSION);
423 if (!PL_mmap_page_size) {
424 #if defined(HAS_SYSCONF) && (defined(_SC_PAGESIZE) || defined(_SC_MMAP_PAGE_SIZE))
426 SETERRNO(0, SS_NORMAL);
428 PL_mmap_page_size = sysconf(_SC_PAGESIZE);
430 PL_mmap_page_size = sysconf(_SC_MMAP_PAGE_SIZE);
432 if ((long) PL_mmap_page_size < 0) {
434 SV * const error = ERRSV;
435 SvUPGRADE(error, SVt_PV);
436 Perl_croak(aTHX_ "panic: sysconf: %s", SvPV_nolen_const(error));
439 Perl_croak(aTHX_ "panic: sysconf: pagesize unknown");
443 # ifdef HAS_GETPAGESIZE
444 PL_mmap_page_size = getpagesize();
446 # if defined(I_SYS_PARAM) && defined(PAGESIZE)
447 PL_mmap_page_size = PAGESIZE; /* compiletime, bad */
451 if (PL_mmap_page_size <= 0)
452 Perl_croak(aTHX_ "panic: bad pagesize %" IVdf,
453 (IV) PL_mmap_page_size);
455 #endif /* HAS_MMAP */
457 #if defined(HAS_TIMES) && defined(PERL_NEED_TIMESBASE)
458 PL_timesbase.tms_utime = 0;
459 PL_timesbase.tms_stime = 0;
460 PL_timesbase.tms_cutime = 0;
461 PL_timesbase.tms_cstime = 0;
468 =for apidoc nothreadhook
470 Stub that provides thread hook for perl_destruct when there are
477 Perl_nothreadhook(pTHX)
483 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
485 Perl_dump_sv_child(pTHX_ SV *sv)
488 const int sock = PL_dumper_fd;
489 const int debug_fd = PerlIO_fileno(Perl_debug_log);
490 union control_un control;
493 struct cmsghdr *cmptr;
495 unsigned char buffer[256];
497 PERL_ARGS_ASSERT_DUMP_SV_CHILD;
499 if(sock == -1 || debug_fd == -1)
502 PerlIO_flush(Perl_debug_log);
504 /* All these shenanigans are to pass a file descriptor over to our child for
505 it to dump out to. We can't let it hold open the file descriptor when it
506 forks, as the file descriptor it will dump to can turn out to be one end
507 of pipe that some other process will wait on for EOF. (So as it would
508 be open, the wait would be forever.) */
510 msg.msg_control = control.control;
511 msg.msg_controllen = sizeof(control.control);
512 /* We're a connected socket so we don't need a destination */
518 cmptr = CMSG_FIRSTHDR(&msg);
519 cmptr->cmsg_len = CMSG_LEN(sizeof(int));
520 cmptr->cmsg_level = SOL_SOCKET;
521 cmptr->cmsg_type = SCM_RIGHTS;
522 *((int *)CMSG_DATA(cmptr)) = 1;
524 vec[0].iov_base = (void*)&sv;
525 vec[0].iov_len = sizeof(sv);
526 got = sendmsg(sock, &msg, 0);
529 perror("Debug leaking scalars parent sendmsg failed");
532 if(got < sizeof(sv)) {
533 perror("Debug leaking scalars parent short sendmsg");
537 /* Return protocol is
539 unsigned char: length of location string (0 for empty)
540 unsigned char*: string (not terminated)
542 vec[0].iov_base = (void*)&returned_errno;
543 vec[0].iov_len = sizeof(returned_errno);
544 vec[1].iov_base = buffer;
547 got = readv(sock, vec, 2);
550 perror("Debug leaking scalars parent read failed");
551 PerlIO_flush(PerlIO_stderr());
554 if(got < sizeof(returned_errno) + 1) {
555 perror("Debug leaking scalars parent short read");
556 PerlIO_flush(PerlIO_stderr());
561 got = read(sock, buffer + 1, *buffer);
563 perror("Debug leaking scalars parent read 2 failed");
564 PerlIO_flush(PerlIO_stderr());
569 perror("Debug leaking scalars parent short read 2");
570 PerlIO_flush(PerlIO_stderr());
575 if (returned_errno || *buffer) {
576 Perl_warn(aTHX_ "Debug leaking scalars child failed%s%.*s with errno"
577 " %d: %s", (*buffer ? " at " : ""), (int) *buffer, buffer + 1,
578 returned_errno, strerror(returned_errno));
584 =for apidoc perl_destruct
586 Shuts down a Perl interpreter. See L<perlembed>.
595 VOL signed char destruct_level; /* see possible values in intrpvar.h */
597 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
601 PERL_ARGS_ASSERT_PERL_DESTRUCT;
603 PERL_UNUSED_ARG(my_perl);
606 /* wait for all pseudo-forked children to finish */
607 PERL_WAIT_FOR_CHILDREN;
609 destruct_level = PL_perl_destruct_level;
612 const char * const s = PerlEnv_getenv("PERL_DESTRUCT_LEVEL");
614 const int i = atoi(s);
615 if (destruct_level < i)
621 if (PL_exit_flags & PERL_EXIT_DESTRUCT_END) {
627 if (PL_endav && !PL_minus_c)
628 call_list(PL_scopestack_ix, PL_endav);
634 /* Need to flush since END blocks can produce output */
637 if (CALL_FPTR(PL_threadhook)(aTHX)) {
638 /* Threads hook has vetoed further cleanup */
639 PL_veto_cleanup = TRUE;
643 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
644 if (destruct_level != 0) {
645 /* Fork here to create a child. Our child's job is to preserve the
646 state of scalars prior to destruction, so that we can instruct it
647 to dump any scalars that we later find have leaked.
648 There's no subtlety in this code - it assumes POSIX, and it doesn't
652 if(socketpair(AF_UNIX, SOCK_STREAM, 0, fd)) {
653 perror("Debug leaking scalars socketpair failed");
659 perror("Debug leaking scalars fork failed");
663 /* We are the child */
664 const int sock = fd[1];
665 const int debug_fd = PerlIO_fileno(Perl_debug_log);
668 /* Our success message is an integer 0, and a char 0 */
669 static const char success[sizeof(int) + 1] = {0};
673 /* We need to close all other file descriptors otherwise we end up
674 with interesting hangs, where the parent closes its end of a
675 pipe, and sits waiting for (another) child to terminate. Only
676 that child never terminates, because it never gets EOF, because
677 we also have the far end of the pipe open. We even need to
678 close the debugging fd, because sometimes it happens to be one
679 end of a pipe, and a process is waiting on the other end for
680 EOF. Normally it would be closed at some point earlier in
681 destruction, but if we happen to cause the pipe to remain open,
682 EOF never occurs, and we get an infinite hang. Hence all the
683 games to pass in a file descriptor if it's actually needed. */
685 f = sysconf(_SC_OPEN_MAX);
687 where = "sysconf failed";
698 union control_un control;
701 struct cmsghdr *cmptr;
705 msg.msg_control = control.control;
706 msg.msg_controllen = sizeof(control.control);
707 /* We're a connected socket so we don't need a source */
711 msg.msg_iovlen = sizeof(vec)/sizeof(vec[0]);
713 vec[0].iov_base = (void*)⌖
714 vec[0].iov_len = sizeof(target);
716 got = recvmsg(sock, &msg, 0);
721 where = "recv failed";
724 if(got < sizeof(target)) {
725 where = "short recv";
729 if(!(cmptr = CMSG_FIRSTHDR(&msg))) {
733 if(cmptr->cmsg_len != CMSG_LEN(sizeof(int))) {
734 where = "wrong cmsg_len";
737 if(cmptr->cmsg_level != SOL_SOCKET) {
738 where = "wrong cmsg_level";
741 if(cmptr->cmsg_type != SCM_RIGHTS) {
742 where = "wrong cmsg_type";
746 got_fd = *(int*)CMSG_DATA(cmptr);
747 /* For our last little bit of trickery, put the file descriptor
748 back into Perl_debug_log, as if we never actually closed it
750 if(got_fd != debug_fd) {
751 if (dup2(got_fd, debug_fd) == -1) {
758 PerlIO_flush(Perl_debug_log);
760 got = write(sock, &success, sizeof(success));
763 where = "write failed";
766 if(got < sizeof(success)) {
767 where = "short write";
774 int send_errno = errno;
775 unsigned char length = (unsigned char) strlen(where);
776 struct iovec failure[3] = {
777 {(void*)&send_errno, sizeof(send_errno)},
779 {(void*)where, length}
781 int got = writev(sock, failure, 3);
782 /* Bad news travels fast. Faster than data. We'll get a SIGPIPE
783 in the parent if we try to read from the socketpair after the
784 child has exited, even if there was data to read.
785 So sleep a bit to give the parent a fighting chance of
788 _exit((got == -1) ? errno : 0);
792 PL_dumper_fd = fd[0];
797 /* We must account for everything. */
799 /* Destroy the main CV and syntax tree */
800 /* Do this now, because destroying ops can cause new SVs to be generated
801 in Perl_pad_swipe, and when running with -DDEBUG_LEAKING_SCALARS they
802 PL_curcop to point to a valid op from which the filename structure
804 PL_curcop = &PL_compiling;
806 /* ensure comppad/curpad to refer to main's pad */
807 if (CvPADLIST(PL_main_cv)) {
808 PAD_SET_CUR_NOSAVE(CvPADLIST(PL_main_cv), 1);
810 op_free(PL_main_root);
813 PL_main_start = NULL;
814 SvREFCNT_dec(PL_main_cv);
818 /* Tell PerlIO we are about to tear things apart in case
819 we have layers which are using resources that should
823 PerlIO_destruct(aTHX);
825 if (PL_sv_objcount) {
827 * Try to destruct global references. We do this first so that the
828 * destructors and destructees still exist. Some sv's might remain.
829 * Non-referenced objects are on their own.
833 if (PL_defoutgv && !SvREFCNT(PL_defoutgv))
834 PL_defoutgv = NULL; /* may have been freed */
837 /* unhook hooks which will soon be, or use, destroyed data */
838 SvREFCNT_dec(PL_warnhook);
840 SvREFCNT_dec(PL_diehook);
843 /* call exit list functions */
844 while (PL_exitlistlen-- > 0)
845 PL_exitlist[PL_exitlistlen].fn(aTHX_ PL_exitlist[PL_exitlistlen].ptr);
847 Safefree(PL_exitlist);
852 /* jettison our possibly duplicated environment */
853 /* if PERL_USE_SAFE_PUTENV is defined environ will not have been copied
854 * so we certainly shouldn't free it here
857 #if defined(USE_ENVIRON_ARRAY) && !defined(PERL_USE_SAFE_PUTENV)
858 if (environ != PL_origenviron && !PL_use_safe_putenv
860 /* only main thread can free environ[0] contents */
861 && PL_curinterp == aTHX
867 for (i = 0; environ[i]; i++)
868 safesysfree(environ[i]);
870 /* Must use safesysfree() when working with environ. */
871 safesysfree(environ);
873 environ = PL_origenviron;
876 #endif /* !PERL_MICRO */
878 if (destruct_level == 0) {
880 DEBUG_P(debprofdump());
882 #if defined(PERLIO_LAYERS)
883 /* No more IO - including error messages ! */
884 PerlIO_cleanup(aTHX);
887 CopFILE_free(&PL_compiling);
888 CopSTASH_free(&PL_compiling);
890 /* The exit() function will do everything that needs doing. */
894 /* reset so print() ends up where we expect */
898 /* the syntax tree is shared between clones
899 * so op_free(PL_main_root) only ReREFCNT_dec's
900 * REGEXPs in the parent interpreter
901 * we need to manually ReREFCNT_dec for the clones
903 SvREFCNT_dec(PL_regex_padav);
904 PL_regex_padav = NULL;
908 SvREFCNT_dec(MUTABLE_SV(PL_stashcache));
909 PL_stashcache = NULL;
911 /* loosen bonds of global variables */
913 /* XXX can PL_parser still be non-null here? */
914 if(PL_parser && PL_parser->rsfp) {
915 (void)PerlIO_close(PL_parser->rsfp);
916 PL_parser->rsfp = NULL;
920 Safefree(PL_splitstr);
930 PL_doswitches = FALSE;
931 PL_dowarn = G_WARN_OFF;
932 PL_doextract = FALSE;
933 PL_sawampersand = FALSE; /* must save all match strings */
936 Safefree(PL_inplace);
938 SvREFCNT_dec(PL_patchlevel);
941 SvREFCNT_dec(PL_e_script);
947 /* magical thingies */
949 SvREFCNT_dec(PL_ofsgv); /* *, */
952 SvREFCNT_dec(PL_ors_sv); /* $\ */
955 SvREFCNT_dec(PL_rs); /* $/ */
958 Safefree(PL_osname); /* $^O */
961 SvREFCNT_dec(PL_statname);
965 /* defgv, aka *_ should be taken care of elsewhere */
967 /* clean up after study() */
968 SvREFCNT_dec(PL_lastscream);
969 PL_lastscream = NULL;
970 Safefree(PL_screamfirst);
972 Safefree(PL_screamnext);
976 Safefree(PL_efloatbuf);
980 /* startup and shutdown function lists */
981 SvREFCNT_dec(PL_beginav);
982 SvREFCNT_dec(PL_beginav_save);
983 SvREFCNT_dec(PL_endav);
984 SvREFCNT_dec(PL_checkav);
985 SvREFCNT_dec(PL_checkav_save);
986 SvREFCNT_dec(PL_unitcheckav);
987 SvREFCNT_dec(PL_unitcheckav_save);
988 SvREFCNT_dec(PL_initav);
990 PL_beginav_save = NULL;
993 PL_checkav_save = NULL;
994 PL_unitcheckav = NULL;
995 PL_unitcheckav_save = NULL;
998 /* shortcuts just get cleared */
1004 PL_argvoutgv = NULL;
1007 PL_last_in_gv = NULL;
1019 SvREFCNT_dec(PL_argvout_stack);
1020 PL_argvout_stack = NULL;
1022 SvREFCNT_dec(PL_modglobal);
1023 PL_modglobal = NULL;
1024 SvREFCNT_dec(PL_preambleav);
1025 PL_preambleav = NULL;
1026 SvREFCNT_dec(PL_subname);
1028 #ifdef PERL_USES_PL_PIDSTATUS
1029 SvREFCNT_dec(PL_pidstatus);
1030 PL_pidstatus = NULL;
1032 SvREFCNT_dec(PL_toptarget);
1033 PL_toptarget = NULL;
1034 SvREFCNT_dec(PL_bodytarget);
1035 PL_bodytarget = NULL;
1036 PL_formtarget = NULL;
1038 /* free locale stuff */
1039 #ifdef USE_LOCALE_COLLATE
1040 Safefree(PL_collation_name);
1041 PL_collation_name = NULL;
1044 #ifdef USE_LOCALE_NUMERIC
1045 Safefree(PL_numeric_name);
1046 PL_numeric_name = NULL;
1047 SvREFCNT_dec(PL_numeric_radix_sv);
1048 PL_numeric_radix_sv = NULL;
1051 /* clear utf8 character classes */
1052 SvREFCNT_dec(PL_utf8_alnum);
1053 SvREFCNT_dec(PL_utf8_alnumc);
1054 SvREFCNT_dec(PL_utf8_ascii);
1055 SvREFCNT_dec(PL_utf8_alpha);
1056 SvREFCNT_dec(PL_utf8_space);
1057 SvREFCNT_dec(PL_utf8_cntrl);
1058 SvREFCNT_dec(PL_utf8_graph);
1059 SvREFCNT_dec(PL_utf8_digit);
1060 SvREFCNT_dec(PL_utf8_upper);
1061 SvREFCNT_dec(PL_utf8_lower);
1062 SvREFCNT_dec(PL_utf8_print);
1063 SvREFCNT_dec(PL_utf8_punct);
1064 SvREFCNT_dec(PL_utf8_xdigit);
1065 SvREFCNT_dec(PL_utf8_mark);
1066 SvREFCNT_dec(PL_utf8_toupper);
1067 SvREFCNT_dec(PL_utf8_totitle);
1068 SvREFCNT_dec(PL_utf8_tolower);
1069 SvREFCNT_dec(PL_utf8_tofold);
1070 SvREFCNT_dec(PL_utf8_idstart);
1071 SvREFCNT_dec(PL_utf8_idcont);
1072 PL_utf8_alnum = NULL;
1073 PL_utf8_alnumc = NULL;
1074 PL_utf8_ascii = NULL;
1075 PL_utf8_alpha = NULL;
1076 PL_utf8_space = NULL;
1077 PL_utf8_cntrl = NULL;
1078 PL_utf8_graph = NULL;
1079 PL_utf8_digit = NULL;
1080 PL_utf8_upper = NULL;
1081 PL_utf8_lower = NULL;
1082 PL_utf8_print = NULL;
1083 PL_utf8_punct = NULL;
1084 PL_utf8_xdigit = NULL;
1085 PL_utf8_mark = NULL;
1086 PL_utf8_toupper = NULL;
1087 PL_utf8_totitle = NULL;
1088 PL_utf8_tolower = NULL;
1089 PL_utf8_tofold = NULL;
1090 PL_utf8_idstart = NULL;
1091 PL_utf8_idcont = NULL;
1093 if (!specialWARN(PL_compiling.cop_warnings))
1094 PerlMemShared_free(PL_compiling.cop_warnings);
1095 PL_compiling.cop_warnings = NULL;
1096 Perl_refcounted_he_free(aTHX_ PL_compiling.cop_hints_hash);
1097 PL_compiling.cop_hints_hash = NULL;
1098 CopFILE_free(&PL_compiling);
1099 CopSTASH_free(&PL_compiling);
1101 /* Prepare to destruct main symbol table. */
1106 SvREFCNT_dec(PL_curstname);
1107 PL_curstname = NULL;
1109 /* clear queued errors */
1110 SvREFCNT_dec(PL_errors);
1113 SvREFCNT_dec(PL_isarev);
1116 if (destruct_level >= 2 && ckWARN_d(WARN_INTERNAL)) {
1117 if (PL_scopestack_ix != 0)
1118 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
1119 "Unbalanced scopes: %ld more ENTERs than LEAVEs\n",
1120 (long)PL_scopestack_ix);
1121 if (PL_savestack_ix != 0)
1122 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
1123 "Unbalanced saves: %ld more saves than restores\n",
1124 (long)PL_savestack_ix);
1125 if (PL_tmps_floor != -1)
1126 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced tmps: %ld more allocs than frees\n",
1127 (long)PL_tmps_floor + 1);
1128 if (cxstack_ix != -1)
1129 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced context: %ld more PUSHes than POPs\n",
1130 (long)cxstack_ix + 1);
1133 /* Now absolutely destruct everything, somehow or other, loops or no. */
1135 /* the 2 is for PL_fdpid and PL_strtab */
1136 while (sv_clean_all() > 2)
1139 AvREAL_off(PL_fdpid); /* no surviving entries */
1140 SvREFCNT_dec(PL_fdpid); /* needed in io_close() */
1143 #ifdef HAVE_INTERP_INTERN
1147 /* Destruct the global string table. */
1149 /* Yell and reset the HeVAL() slots that are still holding refcounts,
1150 * so that sv_free() won't fail on them.
1151 * Now that the global string table is using a single hunk of memory
1152 * for both HE and HEK, we either need to explicitly unshare it the
1153 * correct way, or actually free things here.
1156 const I32 max = HvMAX(PL_strtab);
1157 HE * const * const array = HvARRAY(PL_strtab);
1158 HE *hent = array[0];
1161 if (hent && ckWARN_d(WARN_INTERNAL)) {
1162 HE * const next = HeNEXT(hent);
1163 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
1164 "Unbalanced string table refcount: (%ld) for \"%s\"",
1165 (long)hent->he_valu.hent_refcount, HeKEY(hent));
1172 hent = array[riter];
1177 HvARRAY(PL_strtab) = 0;
1178 HvTOTALKEYS(PL_strtab) = 0;
1179 HvFILL(PL_strtab) = 0;
1181 SvREFCNT_dec(PL_strtab);
1184 /* free the pointer tables used for cloning */
1185 ptr_table_free(PL_ptr_table);
1186 PL_ptr_table = (PTR_TBL_t*)NULL;
1189 /* free special SVs */
1191 SvREFCNT(&PL_sv_yes) = 0;
1192 sv_clear(&PL_sv_yes);
1193 SvANY(&PL_sv_yes) = NULL;
1194 SvFLAGS(&PL_sv_yes) = 0;
1196 SvREFCNT(&PL_sv_no) = 0;
1197 sv_clear(&PL_sv_no);
1198 SvANY(&PL_sv_no) = NULL;
1199 SvFLAGS(&PL_sv_no) = 0;
1203 for (i=0; i<=2; i++) {
1204 SvREFCNT(PERL_DEBUG_PAD(i)) = 0;
1205 sv_clear(PERL_DEBUG_PAD(i));
1206 SvANY(PERL_DEBUG_PAD(i)) = NULL;
1207 SvFLAGS(PERL_DEBUG_PAD(i)) = 0;
1211 if (PL_sv_count != 0 && ckWARN_d(WARN_INTERNAL))
1212 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Scalars leaked: %ld\n", (long)PL_sv_count);
1214 #ifdef DEBUG_LEAKING_SCALARS
1215 if (PL_sv_count != 0) {
1220 for (sva = PL_sv_arenaroot; sva; sva = MUTABLE_SV(SvANY(sva))) {
1221 svend = &sva[SvREFCNT(sva)];
1222 for (sv = sva + 1; sv < svend; ++sv) {
1223 if (SvTYPE(sv) != SVTYPEMASK) {
1224 PerlIO_printf(Perl_debug_log, "leaked: sv=0x%p"
1226 " refcnt=%"UVuf pTHX__FORMAT "\n"
1227 "\tallocated at %s:%d %s %s%s\n",
1228 (void*)sv, (UV)sv->sv_flags, (UV)sv->sv_refcnt
1230 sv->sv_debug_file ? sv->sv_debug_file : "(unknown)",
1232 sv->sv_debug_inpad ? "for" : "by",
1233 sv->sv_debug_optype ?
1234 PL_op_name[sv->sv_debug_optype]: "(none)",
1235 sv->sv_debug_cloned ? " (cloned)" : ""
1237 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1238 Perl_dump_sv_child(aTHX_ sv);
1244 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1248 /* Wait for up to 4 seconds for child to terminate.
1249 This seems to be the least effort way of timing out on reaping
1251 struct timeval waitfor = {4, 0};
1252 int sock = PL_dumper_fd;
1256 FD_SET(sock, &rset);
1257 select(sock + 1, &rset, NULL, NULL, &waitfor);
1258 waitpid(child, &status, WNOHANG);
1263 #ifdef DEBUG_LEAKING_SCALARS_ABORT
1269 #ifdef PERL_DEBUG_READONLY_OPS
1275 #if defined(PERLIO_LAYERS)
1276 /* No more IO - including error messages ! */
1277 PerlIO_cleanup(aTHX);
1280 /* sv_undef needs to stay immortal until after PerlIO_cleanup
1281 as currently layers use it rather than NULL as a marker
1282 for no arg - and will try and SvREFCNT_dec it.
1284 SvREFCNT(&PL_sv_undef) = 0;
1285 SvREADONLY_off(&PL_sv_undef);
1287 Safefree(PL_origfilename);
1288 PL_origfilename = NULL;
1289 Safefree(PL_reg_start_tmp);
1290 PL_reg_start_tmp = (char**)NULL;
1291 PL_reg_start_tmpl = 0;
1292 Safefree(PL_reg_curpm);
1293 Safefree(PL_reg_poscache);
1294 free_tied_hv_pool();
1295 Safefree(PL_op_mask);
1296 Safefree(PL_psig_ptr);
1297 PL_psig_ptr = (SV**)NULL;
1298 Safefree(PL_psig_name);
1299 PL_psig_name = (SV**)NULL;
1300 Safefree(PL_bitcount);
1302 Safefree(PL_psig_pend);
1303 PL_psig_pend = (int*)NULL;
1306 PL_tainting = FALSE;
1307 PL_taint_warn = FALSE;
1308 PL_hints = 0; /* Reset hints. Should hints be per-interpreter ? */
1311 DEBUG_P(debprofdump());
1313 #ifdef USE_REENTRANT_API
1314 Perl_reentrant_free(aTHX);
1319 while (PL_regmatch_slab) {
1320 regmatch_slab *s = PL_regmatch_slab;
1321 PL_regmatch_slab = PL_regmatch_slab->next;
1325 /* As the absolutely last thing, free the non-arena SV for mess() */
1328 /* we know that type == SVt_PVMG */
1330 /* it could have accumulated taint magic */
1333 for (mg = SvMAGIC(PL_mess_sv); mg; mg = moremagic) {
1334 moremagic = mg->mg_moremagic;
1335 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global
1337 Safefree(mg->mg_ptr);
1341 /* we know that type >= SVt_PV */
1342 SvPV_free(PL_mess_sv);
1343 Safefree(SvANY(PL_mess_sv));
1344 Safefree(PL_mess_sv);
1351 =for apidoc perl_free
1353 Releases a Perl interpreter. See L<perlembed>.
1363 PERL_ARGS_ASSERT_PERL_FREE;
1365 if (PL_veto_cleanup)
1368 #ifdef PERL_TRACK_MEMPOOL
1371 * Don't free thread memory if PERL_DESTRUCT_LEVEL is set to a non-zero
1372 * value as we're probably hunting memory leaks then
1374 const char * const s = PerlEnv_getenv("PERL_DESTRUCT_LEVEL");
1375 if (!s || atoi(s) == 0) {
1376 const U32 old_debug = PL_debug;
1377 /* Emulate the PerlHost behaviour of free()ing all memory allocated in this
1378 thread at thread exit. */
1380 PerlIO_puts(Perl_debug_log, "Disabling memory debugging as we "
1381 "free this thread's memory\n");
1382 PL_debug &= ~ DEBUG_m_FLAG;
1384 while(aTHXx->Imemory_debug_header.next != &(aTHXx->Imemory_debug_header))
1385 safesysfree(sTHX + (char *)(aTHXx->Imemory_debug_header.next));
1386 PL_debug = old_debug;
1391 #if defined(WIN32) || defined(NETWARE)
1392 # if defined(PERL_IMPLICIT_SYS)
1395 void *host = nw_internal_host;
1397 void *host = w32_internal_host;
1399 PerlMem_free(aTHXx);
1401 nw_delete_internal_host(host);
1403 win32_delete_internal_host(host);
1407 PerlMem_free(aTHXx);
1410 PerlMem_free(aTHXx);
1414 #if defined(USE_ITHREADS)
1415 /* provide destructors to clean up the thread key when libperl is unloaded */
1416 #ifndef WIN32 /* handled during DLL_PROCESS_DETACH in win32/perllib.c */
1418 #if defined(__hpux) && !(defined(__ux_version) && __ux_version <= 1020) && !defined(__GNUC__)
1419 #pragma fini "perl_fini"
1420 #elif defined(__sun) && !defined(__GNUC__)
1421 #pragma fini (perl_fini)
1425 #if defined(__GNUC__)
1426 __attribute__((destructor))
1431 if (PL_curinterp && !PL_veto_cleanup)
1436 #endif /* THREADS */
1439 Perl_call_atexit(pTHX_ ATEXIT_t fn, void *ptr)
1442 Renew(PL_exitlist, PL_exitlistlen+1, PerlExitListEntry);
1443 PL_exitlist[PL_exitlistlen].fn = fn;
1444 PL_exitlist[PL_exitlistlen].ptr = ptr;
1448 #ifdef HAS_PROCSELFEXE
1449 /* This is a function so that we don't hold on to MAXPATHLEN
1450 bytes of stack longer than necessary
1453 S_procself_val(pTHX_ SV *sv, const char *arg0)
1455 char buf[MAXPATHLEN];
1456 int len = readlink(PROCSELFEXE_PATH, buf, sizeof(buf) - 1);
1458 /* On Playstation2 Linux V1.0 (kernel 2.2.1) readlink(/proc/self/exe)
1459 includes a spurious NUL which will cause $^X to fail in system
1460 or backticks (this will prevent extensions from being built and
1461 many tests from working). readlink is not meant to add a NUL.
1462 Normal readlink works fine.
1464 if (len > 0 && buf[len-1] == '\0') {
1468 /* FreeBSD's implementation is acknowledged to be imperfect, sometimes
1469 returning the text "unknown" from the readlink rather than the path
1470 to the executable (or returning an error from the readlink). Any valid
1471 path has a '/' in it somewhere, so use that to validate the result.
1472 See http://www.freebsd.org/cgi/query-pr.cgi?pr=35703
1474 if (len > 0 && memchr(buf, '/', len)) {
1475 sv_setpvn(sv,buf,len);
1481 #endif /* HAS_PROCSELFEXE */
1484 S_set_caret_X(pTHX) {
1486 GV* tmpgv = gv_fetchpvs("\030", GV_ADD|GV_NOTQUAL, SVt_PV); /* $^X */
1488 #ifdef HAS_PROCSELFEXE
1489 S_procself_val(aTHX_ GvSV(tmpgv), PL_origargv[0]);
1492 sv_setpv(GvSVn(tmpgv), os2_execname(aTHX));
1494 sv_setpv(GvSVn(tmpgv),PL_origargv[0]);
1501 =for apidoc perl_parse
1503 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
1509 perl_parse(pTHXx_ XSINIT_t xsinit, int argc, char **argv, char **env)
1516 PERL_ARGS_ASSERT_PERL_PARSE;
1517 #ifndef MULTIPLICITY
1518 PERL_UNUSED_ARG(my_perl);
1521 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW_AND_IAMSUID
1522 Perl_croak(aTHX_ "suidperl is no longer needed since the kernel can now "
1523 "execute\nsetuid perl scripts securely.\n");
1526 #if defined(USE_HASH_SEED) || defined(USE_HASH_SEED_EXPLICIT)
1527 /* [perl #22371] Algorimic Complexity Attack on Perl 5.6.1, 5.8.0
1528 * This MUST be done before any hash stores or fetches take place.
1529 * If you set PL_rehash_seed (and assumedly also PL_rehash_seed_set)
1530 * yourself, it is your responsibility to provide a good random seed!
1531 * You can also define PERL_HASH_SEED in compile time, see hv.h. */
1532 if (!PL_rehash_seed_set)
1533 PL_rehash_seed = get_hash_seed();
1535 const char * const s = PerlEnv_getenv("PERL_HASH_SEED_DEBUG");
1537 if (s && (atoi(s) == 1))
1538 PerlIO_printf(Perl_debug_log, "HASH_SEED = %"UVuf"\n", PL_rehash_seed);
1540 #endif /* #if defined(USE_HASH_SEED) || defined(USE_HASH_SEED_EXPLICIT) */
1545 if (PL_origalen != 0) {
1546 PL_origalen = 1; /* don't use old PL_origalen if perl_parse() is called again */
1549 /* Set PL_origalen be the sum of the contiguous argv[]
1550 * elements plus the size of the env in case that it is
1551 * contiguous with the argv[]. This is used in mg.c:Perl_magic_set()
1552 * as the maximum modifiable length of $0. In the worst case
1553 * the area we are able to modify is limited to the size of
1554 * the original argv[0]. (See below for 'contiguous', though.)
1556 const char *s = NULL;
1559 ~(UV)(PTRSIZE == 4 ? 3 : PTRSIZE == 8 ? 7 : PTRSIZE == 16 ? 15 : 0);
1560 /* Do the mask check only if the args seem like aligned. */
1562 (mask < ~(UV)0) && ((PTR2UV(argv[0]) & mask) == PTR2UV(argv[0]));
1564 /* See if all the arguments are contiguous in memory. Note
1565 * that 'contiguous' is a loose term because some platforms
1566 * align the argv[] and the envp[]. If the arguments look
1567 * like non-aligned, assume that they are 'strictly' or
1568 * 'traditionally' contiguous. If the arguments look like
1569 * aligned, we just check that they are within aligned
1570 * PTRSIZE bytes. As long as no system has something bizarre
1571 * like the argv[] interleaved with some other data, we are
1572 * fine. (Did I just evoke Murphy's Law?) --jhi */
1573 if (PL_origargv && PL_origargc >= 1 && (s = PL_origargv[0])) {
1575 for (i = 1; i < PL_origargc; i++) {
1576 if ((PL_origargv[i] == s + 1
1578 || PL_origargv[i] == s + 2
1583 (PL_origargv[i] > s &&
1585 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1596 #ifndef PERL_USE_SAFE_PUTENV
1597 /* Can we grab env area too to be used as the area for $0? */
1598 if (s && PL_origenviron && !PL_use_safe_putenv) {
1599 if ((PL_origenviron[0] == s + 1)
1602 (PL_origenviron[0] > s &&
1603 PL_origenviron[0] <=
1604 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1607 #ifndef OS2 /* ENVIRON is read by the kernel too. */
1608 s = PL_origenviron[0];
1611 my_setenv("NoNe SuCh", NULL);
1612 /* Force copy of environment. */
1613 for (i = 1; PL_origenviron[i]; i++) {
1614 if (PL_origenviron[i] == s + 1
1617 (PL_origenviron[i] > s &&
1618 PL_origenviron[i] <=
1619 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1622 s = PL_origenviron[i];
1630 #endif /* !defined(PERL_USE_SAFE_PUTENV) */
1632 PL_origalen = s ? s - PL_origargv[0] + 1 : 0;
1637 /* Come here if running an undumped a.out. */
1639 PL_origfilename = savepv(argv[0]);
1640 PL_do_undump = FALSE;
1641 cxstack_ix = -1; /* start label stack again */
1643 assert (!PL_tainted);
1645 S_set_caret_X(aTHX);
1647 init_postdump_symbols(argc,argv,env);
1652 op_free(PL_main_root);
1653 PL_main_root = NULL;
1655 PL_main_start = NULL;
1656 SvREFCNT_dec(PL_main_cv);
1660 oldscope = PL_scopestack_ix;
1661 PL_dowarn = G_WARN_OFF;
1666 parse_body(env,xsinit);
1668 call_list(oldscope, PL_unitcheckav);
1670 call_list(oldscope, PL_checkav);
1677 /* my_exit() was called */
1678 while (PL_scopestack_ix > oldscope)
1681 PL_curstash = PL_defstash;
1683 call_list(oldscope, PL_unitcheckav);
1685 call_list(oldscope, PL_checkav);
1689 PerlIO_printf(Perl_error_log, "panic: top_env\n");
1698 S_parse_body(pTHX_ char **env, XSINIT_t xsinit)
1702 int argc = PL_origargc;
1703 char **argv = PL_origargv;
1704 const char *scriptname = NULL;
1705 VOL bool dosearch = FALSE;
1707 const char *validarg = "";
1711 const char *cddir = NULL;
1712 #ifdef USE_SITECUSTOMIZE
1713 bool minus_f = FALSE;
1715 SV *linestr_sv = newSV_type(SVt_PVIV);
1716 bool add_read_e_script = FALSE;
1718 SvGROW(linestr_sv, 80);
1719 sv_setpvs(linestr_sv,"");
1721 sv = newSVpvs(""); /* first used for -I flags */
1727 for (argc--,argv++; argc > 0; argc--,argv++) {
1728 if (argv[0][0] != '-' || !argv[0][1])
1732 validarg = " PHOOEY ";
1736 * Can we rely on the kernel to start scripts with argv[1] set to
1737 * contain all #! line switches (the whole line)? (argv[0] is set to
1738 * the interpreter name, argv[2] to the script name; argv[3] and
1739 * above may contain other arguments.)
1746 #ifndef PERL_STRICT_CR
1770 if ((s = moreswitches(s)))
1775 CHECK_MALLOC_TOO_LATE_FOR('t');
1776 if( !PL_tainting ) {
1777 PL_taint_warn = TRUE;
1783 CHECK_MALLOC_TOO_LATE_FOR('T');
1785 PL_taint_warn = FALSE;
1793 #ifdef MACOS_TRADITIONAL
1794 /* ignore -e for Dev:Pseudo argument */
1795 if (argv[1] && !strcmp(argv[1], "Dev:Pseudo"))
1798 forbid_setid('e', FALSE);
1800 PL_e_script = newSVpvs("");
1801 add_read_e_script = TRUE;
1804 sv_catpv(PL_e_script, s);
1806 sv_catpv(PL_e_script, argv[1]);
1810 Perl_croak(aTHX_ "No code specified for -%c", c);
1811 sv_catpvs(PL_e_script, "\n");
1815 #ifdef USE_SITECUSTOMIZE
1821 case 'I': /* -I handled both here and in moreswitches() */
1822 forbid_setid('I', FALSE);
1823 if (!*++s && (s=argv[1]) != NULL) {
1827 STRLEN len = strlen(s);
1828 const char * const p = savepvn(s, len);
1829 incpush(p, TRUE, TRUE, FALSE, FALSE);
1830 sv_catpvs(sv, "-I");
1831 sv_catpvn(sv, p, len);
1836 Perl_croak(aTHX_ "No directory specified for -I");
1839 forbid_setid('S', FALSE);
1847 Perl_av_create_and_push(aTHX_ &PL_preambleav, newSVpvs("use Config;"));
1849 /* Can't do newSVpvs() as that would involve pre-processor
1850 condititionals inside a macro expansion. */
1851 opts_prog = Perl_newSVpv(aTHX_ "$_ = join ' ', sort qw("
1858 # ifdef PERL_DONT_CREATE_GVSV
1859 " PERL_DONT_CREATE_GVSV"
1861 # ifdef PERL_MALLOC_WRAP
1864 # ifdef PERL_MEM_LOG
1867 # ifdef PERL_MEM_LOG_ENV
1870 # ifdef PERL_MEM_LOG_ENV_FD
1871 " PERL_MEM_LOG_ENV_FD"
1873 # ifdef PERL_MEM_LOG_STDERR
1874 " PERL_MEM_LOG_STDERR"
1876 # ifdef PERL_MEM_LOG_TIMESTAMP
1877 " PERL_MEM_LOG_TIMESTAMP"
1879 # ifdef PERL_USE_SAFE_PUTENV
1880 " PERL_USE_SAFE_PUTENV"
1882 # ifdef USE_SITECUSTOMIZE
1883 " USE_SITECUSTOMIZE"
1885 # ifdef USE_FAST_STDIO
1890 sv_catpv(opts_prog, PL_bincompat_options);
1891 /* Terminate the qw(, and then wrap at 76 columns. */
1892 sv_catpvs(opts_prog, "); s/(?=.{53})(.{1,53}) /$1\\n /mg;print Config::myconfig(),");
1894 sv_catpvs(opts_prog,"\"\\nCharacteristics of this PERLSHR image: \\n");
1896 sv_catpvs(opts_prog,"\"\\nCharacteristics of this binary (from libperl): \\n");
1899 sv_catpvs(opts_prog," Compile-time options: $_\\n\",");
1901 #if defined(LOCAL_PATCH_COUNT)
1902 if (LOCAL_PATCH_COUNT > 0) {
1904 sv_catpvs(opts_prog,
1905 "\" Locally applied patches:\\n\",");
1906 for (i = 1; i <= LOCAL_PATCH_COUNT; i++) {
1907 if (PL_localpatches[i])
1908 Perl_sv_catpvf(aTHX_ opts_prog,"q%c\t%s\n%c,",
1909 0, PL_localpatches[i], 0);
1913 Perl_sv_catpvf(aTHX_ opts_prog,
1914 "\" Built under %s\\n",OSNAME);
1917 sv_catpvs(opts_prog,
1918 " Compiled at " __DATE__ " " __TIME__ "\\n\"");
1920 sv_catpvs(opts_prog, " Compiled on " __DATE__ "\\n\"");
1923 sv_catpvs(opts_prog, "; $\"=\"\\n \"; "
1924 "@env = map { \"$_=\\\"$ENV{$_}\\\"\" } "
1925 "sort grep {/^PERL/} keys %ENV; ");
1927 sv_catpvs(opts_prog,
1928 "push @env, \"CYGWIN=\\\"$ENV{CYGWIN}\\\"\";");
1930 sv_catpvs(opts_prog,
1931 "print \" \\%ENV:\\n @env\\n\" if @env;"
1932 "print \" \\@INC:\\n @INC\\n\";");
1936 opts_prog = Perl_newSVpvf(aTHX_
1937 "Config::config_vars(qw%c%s%c)",
1941 av_push(PL_preambleav, opts_prog);
1942 /* don't look for script or read stdin */
1943 scriptname = BIT_BUCKET;
1947 PL_doextract = TRUE;
1955 if (!*++s || isSPACE(*s)) {
1959 /* catch use of gnu style long options */
1960 if (strEQ(s, "version")) {
1964 if (strEQ(s, "help")) {
1971 Perl_croak(aTHX_ "Unrecognized switch: -%s (-h will show valid options)",s);
1982 #ifndef SECURE_INTERNAL_GETENV
1985 (s = PerlEnv_getenv("PERL5OPT")))
1989 if (*s == '-' && *(s+1) == 'T') {
1990 CHECK_MALLOC_TOO_LATE_FOR('T');
1992 PL_taint_warn = FALSE;
1995 char *popt_copy = NULL;
2008 if (!strchr("CDIMUdmtw", *s))
2009 Perl_croak(aTHX_ "Illegal switch in PERL5OPT: -%c", *s);
2013 popt_copy = SvPVX(sv_2mortal(newSVpv(d,0)));
2014 s = popt_copy + (s - d);
2022 if( !PL_tainting ) {
2023 PL_taint_warn = TRUE;
2034 #ifdef USE_SITECUSTOMIZE
2036 (void)Perl_av_create_and_unshift_one(aTHX_ &PL_preambleav,
2037 Perl_newSVpvf(aTHX_ "BEGIN { do '%s/sitecustomize.pl' }", SITELIB_EXP));
2042 scriptname = argv[0];
2045 scriptname = BIT_BUCKET; /* don't look for script or read stdin */
2047 else if (scriptname == NULL) {
2049 if ( PerlLIO_isatty(PerlIO_fileno(PerlIO_stdin())) )
2055 /* Set $^X early so that it can be used for relocatable paths in @INC */
2056 assert (!PL_tainted);
2058 S_set_caret_X(aTHX);
2063 bool suidscript = FALSE;
2066 const int fdscript =
2068 open_script(scriptname, dosearch, &suidscript, &rsfp);
2070 validate_suid(validarg, scriptname, fdscript, suidscript,
2074 # if defined(SIGCHLD) || defined(SIGCLD)
2077 # define SIGCHLD SIGCLD
2079 Sighandler_t sigstate = rsignal_state(SIGCHLD);
2080 if (sigstate == (Sighandler_t) SIG_IGN) {
2081 if (ckWARN(WARN_SIGNAL))
2082 Perl_warner(aTHX_ packWARN(WARN_SIGNAL),
2083 "Can't ignore signal CHLD, forcing to default");
2084 (void)rsignal(SIGCHLD, (Sighandler_t)SIG_DFL);
2091 #ifdef MACOS_TRADITIONAL
2092 || gMacPerl_AlwaysExtract
2096 /* This will croak if suidscript is true, as -x cannot be used with
2098 forbid_setid('x', suidscript);
2099 /* Hence you can't get here if suidscript is true */
2101 find_beginning(linestr_sv, rsfp);
2102 if (cddir && PerlDir_chdir( (char *)cddir ) < 0)
2103 Perl_croak(aTHX_ "Can't chdir to %s",cddir);
2107 PL_main_cv = PL_compcv = MUTABLE_CV(newSV_type(SVt_PVCV));
2108 CvUNIQUE_on(PL_compcv);
2110 CvPADLIST(PL_compcv) = pad_new(0);
2112 PL_isarev = newHV();
2115 boot_core_UNIVERSAL();
2116 boot_core_xsutils();
2120 (*xsinit)(aTHX); /* in case linked C routines want magical variables */
2122 #if defined(VMS) || defined(WIN32) || defined(DJGPP) || defined(__CYGWIN__) || defined(EPOC) || defined(SYMBIAN)
2128 # ifdef HAS_SOCKS5_INIT
2129 socks5_init(argv[0]);
2135 init_predump_symbols();
2136 /* init_postdump_symbols not currently designed to be called */
2137 /* more than once (ENV isn't cleared first, for example) */
2138 /* But running with -u leaves %ENV & @ARGV undefined! XXX */
2140 init_postdump_symbols(argc,argv,env);
2142 /* PL_unicode is turned on by -C, or by $ENV{PERL_UNICODE},
2143 * or explicitly in some platforms.
2144 * locale.c:Perl_init_i18nl10n() if the environment
2145 * look like the user wants to use UTF-8. */
2146 #if defined(__SYMBIAN32__)
2147 PL_unicode = PERL_UNICODE_STD_FLAG; /* See PERL_SYMBIAN_CONSOLE_UTF8. */
2150 /* Requires init_predump_symbols(). */
2151 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
2156 /* Turn on UTF-8-ness on STDIN, STDOUT, STDERR
2157 * and the default open disciplines. */
2158 if ((PL_unicode & PERL_UNICODE_STDIN_FLAG) &&
2159 PL_stdingv && (io = GvIO(PL_stdingv)) &&
2161 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2162 if ((PL_unicode & PERL_UNICODE_STDOUT_FLAG) &&
2163 PL_defoutgv && (io = GvIO(PL_defoutgv)) &&
2165 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2166 if ((PL_unicode & PERL_UNICODE_STDERR_FLAG) &&
2167 PL_stderrgv && (io = GvIO(PL_stderrgv)) &&
2169 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2170 if ((PL_unicode & PERL_UNICODE_INOUT_FLAG) &&
2171 (sv = GvSV(gv_fetchpvs("\017PEN", GV_ADD|GV_NOTQUAL,
2173 U32 in = PL_unicode & PERL_UNICODE_IN_FLAG;
2174 U32 out = PL_unicode & PERL_UNICODE_OUT_FLAG;
2177 sv_setpvs(sv, ":utf8\0:utf8");
2179 sv_setpvs(sv, ":utf8\0");
2182 sv_setpvs(sv, "\0:utf8");
2190 if ((s = PerlEnv_getenv("PERL_SIGNALS"))) {
2191 if (strEQ(s, "unsafe"))
2192 PL_signals |= PERL_SIGNALS_UNSAFE_FLAG;
2193 else if (strEQ(s, "safe"))
2194 PL_signals &= ~PERL_SIGNALS_UNSAFE_FLAG;
2196 Perl_croak(aTHX_ "PERL_SIGNALS illegal: \"%s\"", s);
2203 if ((s = PerlEnv_getenv("PERL_XMLDUMP"))) {
2207 PL_xmlfp = PerlIO_stdout();
2209 PL_xmlfp = PerlIO_open(s, "w");
2211 Perl_croak(aTHX_ "Can't open %s", s);
2213 my_setenv("PERL_XMLDUMP", NULL); /* hide from subprocs */
2219 if ((s = PerlEnv_getenv("PERL_MADSKILLS"))) {
2220 PL_madskills = atoi(s);
2221 my_setenv("PERL_MADSKILLS", NULL); /* hide from subprocs */
2226 lex_start(linestr_sv, rsfp, TRUE);
2227 PL_subname = newSVpvs("main");
2229 if (add_read_e_script)
2230 filter_add(read_e_script, NULL);
2232 /* now parse the script */
2234 SETERRNO(0,SS_NORMAL);
2235 #ifdef MACOS_TRADITIONAL
2236 if (gMacPerl_SyntaxError = (yyparse() || PL_parser->error_count)) {
2238 Perl_croak(aTHX_ "%s had compilation errors.\n", MacPerl_MPWFileName(PL_origfilename));
2240 Perl_croak(aTHX_ "Execution of %s aborted due to compilation errors.\n",
2241 MacPerl_MPWFileName(PL_origfilename));
2245 if (yyparse() || PL_parser->error_count) {
2247 Perl_croak(aTHX_ "%s had compilation errors.\n", PL_origfilename);
2249 Perl_croak(aTHX_ "Execution of %s aborted due to compilation errors.\n",
2254 CopLINE_set(PL_curcop, 0);
2255 PL_curstash = PL_defstash;
2257 SvREFCNT_dec(PL_e_script);
2265 SAVECOPFILE(PL_curcop);
2266 SAVECOPLINE(PL_curcop);
2267 gv_check(PL_defstash);
2276 if ((s=PerlEnv_getenv("PERL_DEBUG_MSTATS")) && atoi(s) >= 2)
2277 dump_mstats("after compilation:");
2287 =for apidoc perl_run
2289 Tells a Perl interpreter to run. See L<perlembed>.
2302 PERL_ARGS_ASSERT_PERL_RUN;
2303 #ifndef MULTIPLICITY
2304 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");
2351 S_run_body(pTHX_ I32 oldscope)
2354 DEBUG_r(PerlIO_printf(Perl_debug_log, "%s $` $& $' support.\n",
2355 PL_sawampersand ? "Enabling" : "Omitting"));
2357 if (!PL_restartop) {
2361 exit(0); /* less likely to core dump than my_exit(0) */
2364 DEBUG_x(dump_all());
2367 PERL_DEBUG(PerlIO_printf(Perl_debug_log, "\nEXECUTING...\n\n"));
2371 #ifdef MACOS_TRADITIONAL
2372 PerlIO_printf(Perl_error_log, "%s%s syntax OK\n",
2373 (gMacPerl_ErrorFormat ? "# " : ""),
2374 MacPerl_MPWFileName(PL_origfilename));
2376 PerlIO_printf(Perl_error_log, "%s syntax OK\n", PL_origfilename);
2380 if (PERLDB_SINGLE && PL_DBsingle)
2381 sv_setiv(PL_DBsingle, 1);
2383 call_list(oldscope, PL_initav);
2384 #ifdef PERL_DEBUG_READONLY_OPS
2385 Perl_pending_Slabs_to_ro(aTHX);
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)
2422 PERL_ARGS_ASSERT_GET_SV;
2424 gv = gv_fetchpv(name, create, SVt_PV);
2431 =head1 Array Manipulation Functions
2433 =for apidoc p||get_av
2435 Returns the AV of the specified Perl array. If C<create> is set and the
2436 Perl variable does not exist then it will be created. If C<create> is not
2437 set and the variable does not exist then NULL is returned.
2443 Perl_get_av(pTHX_ const char *name, I32 create)
2445 GV* const gv = gv_fetchpv(name, create, SVt_PVAV);
2447 PERL_ARGS_ASSERT_GET_AV;
2457 =head1 Hash Manipulation Functions
2459 =for apidoc p||get_hv
2461 Returns the HV of the specified Perl hash. If C<create> is set and the
2462 Perl variable does not exist then it will be created. If C<create> is not
2463 set and the variable does not exist then NULL is returned.
2469 Perl_get_hv(pTHX_ const char *name, I32 create)
2471 GV* const gv = gv_fetchpv(name, create, SVt_PVHV);
2473 PERL_ARGS_ASSERT_GET_HV;
2483 =head1 CV Manipulation Functions
2485 =for apidoc p||get_cvn_flags
2487 Returns the CV of the specified Perl subroutine. C<flags> are passed to
2488 C<gv_fetchpvn_flags>. If C<GV_ADD> is set and the Perl subroutine does not
2489 exist then it will be declared (which has the same effect as saying
2490 C<sub name;>). If C<GV_ADD> is not set and the subroutine does not exist
2491 then NULL is returned.
2493 =for apidoc p||get_cv
2495 Uses C<strlen> to get the length of C<name>, then calls C<get_cvn_flags>.
2501 Perl_get_cvn_flags(pTHX_ const char *name, STRLEN len, I32 flags)
2503 GV* const gv = gv_fetchpvn_flags(name, len, flags, SVt_PVCV);
2504 /* XXX this is probably not what they think they're getting.
2505 * It has the same effect as "sub name;", i.e. just a forward
2508 PERL_ARGS_ASSERT_GET_CVN_FLAGS;
2510 if ((flags & ~GV_NOADD_MASK) && !GvCVu(gv)) {
2511 SV *const sv = newSVpvn_flags(name, len, flags & SVf_UTF8);
2512 return newSUB(start_subparse(FALSE, 0),
2513 newSVOP(OP_CONST, 0, sv),
2522 Perl_get_cv(pTHX_ const char *name, I32 flags)
2524 PERL_ARGS_ASSERT_GET_CV;
2526 return get_cvn_flags(name, strlen(name), flags);
2529 /* Be sure to refetch the stack pointer after calling these routines. */
2533 =head1 Callback Functions
2535 =for apidoc p||call_argv
2537 Performs a callback to the specified Perl sub. See L<perlcall>.
2543 Perl_call_argv(pTHX_ const char *sub_name, I32 flags, register char **argv)
2545 /* See G_* flags in cop.h */
2546 /* null terminated arg list */
2551 PERL_ARGS_ASSERT_CALL_ARGV;
2556 mXPUSHs(newSVpv(*argv,0));
2561 return call_pv(sub_name, flags);
2565 =for apidoc p||call_pv
2567 Performs a callback to the specified Perl sub. See L<perlcall>.
2573 Perl_call_pv(pTHX_ const char *sub_name, I32 flags)
2574 /* name of the subroutine */
2575 /* See G_* flags in cop.h */
2577 PERL_ARGS_ASSERT_CALL_PV;
2579 return call_sv(MUTABLE_SV(get_cv(sub_name, TRUE)), flags);
2583 =for apidoc p||call_method
2585 Performs a callback to the specified Perl method. The blessed object must
2586 be on the stack. See L<perlcall>.
2592 Perl_call_method(pTHX_ const char *methname, I32 flags)
2593 /* name of the subroutine */
2594 /* See G_* flags in cop.h */
2596 PERL_ARGS_ASSERT_CALL_METHOD;
2598 return call_sv(sv_2mortal(newSVpv(methname,0)), flags | G_METHOD);
2601 /* May be called with any of a CV, a GV, or an SV containing the name. */
2603 =for apidoc p||call_sv
2605 Performs a callback to the Perl sub whose name is in the SV. See
2612 Perl_call_sv(pTHX_ SV *sv, VOL I32 flags)
2613 /* See G_* flags in cop.h */
2616 LOGOP myop; /* fake syntax tree node */
2621 bool oldcatch = CATCH_GET;
2623 OP* const oldop = PL_op;
2626 PERL_ARGS_ASSERT_CALL_SV;
2628 if (flags & G_DISCARD) {
2632 if (!(flags & G_WANT)) {
2633 /* Backwards compatibility - as G_SCALAR was 0, it could be omitted.
2638 Zero(&myop, 1, LOGOP);
2639 myop.op_next = NULL;
2640 if (!(flags & G_NOARGS))
2641 myop.op_flags |= OPf_STACKED;
2642 myop.op_flags |= OP_GIMME_REVERSE(flags);
2646 EXTEND(PL_stack_sp, 1);
2647 *++PL_stack_sp = sv;
2649 oldscope = PL_scopestack_ix;
2651 if (PERLDB_SUB && PL_curstash != PL_debstash
2652 /* Handle first BEGIN of -d. */
2653 && (PL_DBcv || (PL_DBcv = GvCV(PL_DBsub)))
2654 /* Try harder, since this may have been a sighandler, thus
2655 * curstash may be meaningless. */
2656 && (SvTYPE(sv) != SVt_PVCV || CvSTASH((const CV *)sv) != PL_debstash)
2657 && !(flags & G_NODEBUG))
2658 PL_op->op_private |= OPpENTERSUB_DB;
2660 if (flags & G_METHOD) {
2661 Zero(&method_op, 1, UNOP);
2662 method_op.op_next = PL_op;
2663 method_op.op_ppaddr = PL_ppaddr[OP_METHOD];
2664 method_op.op_type = OP_METHOD;
2665 myop.op_ppaddr = PL_ppaddr[OP_ENTERSUB];
2666 myop.op_type = OP_ENTERSUB;
2667 PL_op = (OP*)&method_op;
2670 if (!(flags & G_EVAL)) {
2672 CALL_BODY_SUB((OP*)&myop);
2673 retval = PL_stack_sp - (PL_stack_base + oldmark);
2674 CATCH_SET(oldcatch);
2677 myop.op_other = (OP*)&myop;
2679 create_eval_scope(flags|G_FAKINGEVAL);
2687 CALL_BODY_SUB((OP*)&myop);
2688 retval = PL_stack_sp - (PL_stack_base + oldmark);
2689 if (!(flags & G_KEEPERR)) {
2697 /* my_exit() was called */
2698 PL_curstash = PL_defstash;
2701 if (PL_statusvalue && !(PL_exit_flags & PERL_EXIT_EXPECTED))
2702 Perl_croak(aTHX_ "Callback called exit");
2707 PL_op = PL_restartop;
2711 PL_stack_sp = PL_stack_base + oldmark;
2712 if ((flags & G_WANT) == G_ARRAY)
2716 *++PL_stack_sp = &PL_sv_undef;
2721 if (PL_scopestack_ix > oldscope)
2722 delete_eval_scope();
2726 if (flags & G_DISCARD) {
2727 PL_stack_sp = PL_stack_base + oldmark;
2736 /* Eval a string. The G_EVAL flag is always assumed. */
2739 =for apidoc p||eval_sv
2741 Tells Perl to C<eval> the string in the SV.
2747 Perl_eval_sv(pTHX_ SV *sv, I32 flags)
2749 /* See G_* flags in cop.h */
2753 UNOP myop; /* fake syntax tree node */
2754 VOL I32 oldmark = SP - PL_stack_base;
2757 OP* const oldop = PL_op;
2760 PERL_ARGS_ASSERT_EVAL_SV;
2762 if (flags & G_DISCARD) {
2769 Zero(PL_op, 1, UNOP);
2770 EXTEND(PL_stack_sp, 1);
2771 *++PL_stack_sp = sv;
2773 if (!(flags & G_NOARGS))
2774 myop.op_flags = OPf_STACKED;
2775 myop.op_next = NULL;
2776 myop.op_type = OP_ENTEREVAL;
2777 myop.op_flags |= OP_GIMME_REVERSE(flags);
2778 if (flags & G_KEEPERR)
2779 myop.op_flags |= OPf_SPECIAL;
2781 /* fail now; otherwise we could fail after the JMPENV_PUSH but
2782 * before a PUSHEVAL, which corrupts the stack after a croak */
2783 TAINT_PROPER("eval_sv()");
2789 CALL_BODY_EVAL((OP*)&myop);
2790 retval = PL_stack_sp - (PL_stack_base + oldmark);
2791 if (!(flags & G_KEEPERR)) {
2799 /* my_exit() was called */
2800 PL_curstash = PL_defstash;
2803 if (PL_statusvalue && !(PL_exit_flags & PERL_EXIT_EXPECTED))
2804 Perl_croak(aTHX_ "Callback called exit");
2809 PL_op = PL_restartop;
2813 PL_stack_sp = PL_stack_base + oldmark;
2814 if ((flags & G_WANT) == G_ARRAY)
2818 *++PL_stack_sp = &PL_sv_undef;
2824 if (flags & G_DISCARD) {
2825 PL_stack_sp = PL_stack_base + oldmark;
2835 =for apidoc p||eval_pv
2837 Tells Perl to C<eval> the given string and return an SV* result.
2843 Perl_eval_pv(pTHX_ const char *p, I32 croak_on_error)
2847 SV* sv = newSVpv(p, 0);
2849 PERL_ARGS_ASSERT_EVAL_PV;
2851 eval_sv(sv, G_SCALAR);
2858 if (croak_on_error && SvTRUE(ERRSV)) {
2859 Perl_croak(aTHX_ "%s", SvPVx_nolen_const(ERRSV));
2865 /* Require a module. */
2868 =head1 Embedding Functions
2870 =for apidoc p||require_pv
2872 Tells Perl to C<require> the file named by the string argument. It is
2873 analogous to the Perl code C<eval "require '$file'">. It's even
2874 implemented that way; consider using load_module instead.
2879 Perl_require_pv(pTHX_ const char *pv)
2885 PERL_ARGS_ASSERT_REQUIRE_PV;
2887 PUSHSTACKi(PERLSI_REQUIRE);
2889 sv = Perl_newSVpvf(aTHX_ "require q%c%s%c", 0, pv, 0);
2890 eval_sv(sv_2mortal(sv), G_DISCARD);
2896 S_usage(pTHX_ const char *name) /* XXX move this out into a module ? */
2898 /* This message really ought to be max 23 lines.
2899 * Removed -h because the user already knows that option. Others? */
2901 static const char * const usage_msg[] = {
2902 "-0[octal] specify record separator (\\0, if no argument)",
2903 "-a autosplit mode with -n or -p (splits $_ into @F)",
2904 "-C[number/list] enables the listed Unicode features",
2905 "-c check syntax only (runs BEGIN and CHECK blocks)",
2906 "-d[:debugger] run program under debugger",
2907 "-D[number/list] set debugging flags (argument is a bit mask or alphabets)",
2908 "-e program one line of program (several -e's allowed, omit programfile)",
2909 "-E program like -e, but enables all optional features",
2910 "-f don't do $sitelib/sitecustomize.pl at startup",
2911 "-F/pattern/ split() pattern for -a switch (//'s are optional)",
2912 "-i[extension] edit <> files in place (makes backup if extension supplied)",
2913 "-Idirectory specify @INC/#include directory (several -I's allowed)",
2914 "-l[octal] enable line ending processing, specifies line terminator",
2915 "-[mM][-]module execute \"use/no module...\" before executing program",
2916 "-n assume \"while (<>) { ... }\" loop around program",
2917 "-p assume loop like -n but print line also, like sed",
2918 "-s enable rudimentary parsing for switches after programfile",
2919 "-S look for programfile using PATH environment variable",
2920 "-t enable tainting warnings",
2921 "-T enable tainting checks",
2922 "-u dump core after parsing program",
2923 "-U allow unsafe operations",
2924 "-v print version, subversion (includes VERY IMPORTANT perl info)",
2925 "-V[:variable] print configuration summary (or a single Config.pm variable)",
2926 "-w enable many useful warnings (RECOMMENDED)",
2927 "-W enable all warnings",
2928 "-x[directory] strip off text before #!perl line and perhaps cd to directory",
2929 "-X disable all warnings",
2933 const char * const *p = usage_msg;
2935 PERL_ARGS_ASSERT_USAGE;
2937 PerlIO_printf(PerlIO_stdout(),
2938 "\nUsage: %s [switches] [--] [programfile] [arguments]",
2941 PerlIO_printf(PerlIO_stdout(), "\n %s", *p++);
2944 /* convert a string of -D options (or digits) into an int.
2945 * sets *s to point to the char after the options */
2949 Perl_get_debug_opts(pTHX_ const char **s, bool givehelp)
2951 static const char * const usage_msgd[] = {
2952 " Debugging flag values: (see also -d)",
2953 " p Tokenizing and parsing (with v, displays parse stack)",
2954 " s Stack snapshots (with v, displays all stacks)",
2955 " l Context (loop) stack processing",
2956 " t Trace execution",
2957 " o Method and overloading resolution",
2958 " c String/numeric conversions",
2959 " P Print profiling info, source file input state",
2960 " m Memory and SV allocation",
2961 " f Format processing",
2962 " r Regular expression parsing and execution",
2963 " x Syntax tree dump",
2964 " u Tainting checks",
2965 " H Hash dump -- usurps values()",
2966 " X Scratchpad allocation",
2969 " R Include reference counts of dumped variables (eg when using -Ds)",
2970 " J Do not s,t,P-debug (Jump over) opcodes within package DB",
2971 " v Verbose: use in conjunction with other flags",
2973 " A Consistency checks on internal structures",
2974 " q quiet - currently only suppresses the 'EXECUTING' message",
2979 PERL_ARGS_ASSERT_GET_DEBUG_OPTS;
2982 /* if adding extra options, remember to update DEBUG_MASK */
2983 static const char debopts[] = "psltocPmfrxuUHXDSTRJvCAq";
2985 for (; isALNUM(**s); (*s)++) {
2986 const char * const d = strchr(debopts,**s);
2988 i |= 1 << (d - debopts);
2989 else if (ckWARN_d(WARN_DEBUGGING))
2990 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
2991 "invalid option -D%c, use -D'' to see choices\n", **s);
2994 else if (isDIGIT(**s)) {
2996 for (; isALNUM(**s); (*s)++) ;
2998 else if (givehelp) {
2999 const char *const *p = usage_msgd;
3000 while (*p) PerlIO_printf(PerlIO_stdout(), "%s\n", *p++);
3003 if ((i & DEBUG_p_FLAG) && ckWARN_d(WARN_DEBUGGING))
3004 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3005 "-Dp not implemented on this platform\n");
3011 /* This routine handles any switches that can be given during run */
3014 Perl_moreswitches(pTHX_ const char *s)
3018 const char option = *s; /* used to remember option in -m/-M code */
3020 PERL_ARGS_ASSERT_MORESWITCHES;
3028 SvREFCNT_dec(PL_rs);
3029 if (s[1] == 'x' && s[2]) {
3030 const char *e = s+=2;
3036 flags = PERL_SCAN_SILENT_ILLDIGIT;
3037 rschar = (U32)grok_hex(s, &numlen, &flags, NULL);
3038 if (s + numlen < e) {
3039 rschar = 0; /* Grandfather -0xFOO as -0 -xFOO. */
3043 PL_rs = newSVpvs("");
3044 SvGROW(PL_rs, (STRLEN)(UNISKIP(rschar) + 1));
3045 tmps = (U8*)SvPVX(PL_rs);
3046 uvchr_to_utf8(tmps, rschar);
3047 SvCUR_set(PL_rs, UNISKIP(rschar));
3052 rschar = (U32)grok_oct(s, &numlen, &flags, NULL);
3053 if (rschar & ~((U8)~0))
3054 PL_rs = &PL_sv_undef;
3055 else if (!rschar && numlen >= 2)
3056 PL_rs = newSVpvs("");
3058 char ch = (char)rschar;
3059 PL_rs = newSVpvn(&ch, 1);
3062 sv_setsv(get_sv("/", TRUE), PL_rs);
3067 PL_unicode = parse_unicode_opts( (const char **)&s );
3068 if (PL_unicode & PERL_UNICODE_UTF8CACHEASSERT_FLAG)
3074 while (*s && !isSPACE(*s)) ++s;
3075 PL_splitstr = savepvn(PL_splitstr, s - PL_splitstr);
3086 forbid_setid('d', FALSE);
3089 /* -dt indicates to the debugger that threads will be used */
3090 if (*s == 't' && !isALNUM(s[1])) {
3092 my_setenv("PERL5DB_THREADED", "1");
3095 /* The following permits -d:Mod to accepts arguments following an =
3096 in the fashion that -MSome::Mod does. */
3097 if (*s == ':' || *s == '=') {
3098 const char *start = ++s;
3099 const char *const end = s + strlen(s);
3100 SV * const sv = newSVpvs("use Devel::");
3102 /* We now allow -d:Module=Foo,Bar */
3103 while(isALNUM(*s) || *s==':') ++s;
3105 sv_catpvn(sv, start, end - start);
3107 sv_catpvn(sv, start, s-start);
3108 /* Don't use NUL as q// delimiter here, this string goes in the
3110 Perl_sv_catpvf(aTHX_ sv, " split(/,/,q{%s});", ++s);
3113 my_setenv("PERL5DB", SvPV_nolen_const(sv));
3117 PL_perldb = PERLDB_ALL;
3124 forbid_setid('D', FALSE);
3126 PL_debug = get_debug_opts( (const char **)&s, 1) | DEBUG_TOP_FLAG;
3127 #else /* !DEBUGGING */
3128 if (ckWARN_d(WARN_DEBUGGING))
3129 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3130 "Recompile perl with -DDEBUGGING to use -D switch (did you mean -d ?)\n");
3131 for (s++; isALNUM(*s); s++) ;
3136 usage(PL_origargv[0]);
3139 Safefree(PL_inplace);
3140 #if defined(__CYGWIN__) /* do backup extension automagically */
3141 if (*(s+1) == '\0') {
3142 PL_inplace = savepvs(".bak");
3145 #endif /* __CYGWIN__ */
3147 const char * const start = ++s;
3148 while (*s && !isSPACE(*s))
3151 PL_inplace = savepvn(start, s - start);
3155 if (*s == '-') /* Additional switches on #! line. */
3159 case 'I': /* -I handled both here and in parse_body() */
3160 forbid_setid('I', FALSE);
3162 while (*s && isSPACE(*s))
3167 /* ignore trailing spaces (possibly followed by other switches) */
3169 for (e = p; *e && !isSPACE(*e); e++) ;
3173 } while (*p && *p != '-');
3174 e = savepvn(s, e-s);
3175 incpush(e, TRUE, TRUE, FALSE, FALSE);
3182 Perl_croak(aTHX_ "No directory specified for -I");
3188 SvREFCNT_dec(PL_ors_sv);
3194 PL_ors_sv = newSVpvs("\n");
3195 numlen = 3 + (*s == '0');
3196 *SvPVX(PL_ors_sv) = (char)grok_oct(s, &numlen, &flags, NULL);
3200 if (RsPARA(PL_rs)) {
3201 PL_ors_sv = newSVpvs("\n\n");
3204 PL_ors_sv = newSVsv(PL_rs);
3209 forbid_setid('M', FALSE); /* XXX ? */
3212 forbid_setid('m', FALSE); /* XXX ? */
3217 const char *use = "use ";
3219 /* -M-foo == 'no foo' */
3220 /* Leading space on " no " is deliberate, to make both
3221 possibilities the same length. */
3222 if (*s == '-') { use = " no "; ++s; }
3223 sv = newSVpvn(use,4);
3225 /* We allow -M'Module qw(Foo Bar)' */
3226 while(isALNUM(*s) || *s==':') {
3235 Perl_croak(aTHX_ "Module name required with -%c option",
3238 Perl_croak(aTHX_ "Invalid module name %.*s with -%c option: "
3239 "contains single ':'",
3240 (int)(s - start), start, option);
3241 end = s + strlen(s);
3243 sv_catpvn(sv, start, end - start);
3244 if (option == 'm') {
3246 Perl_croak(aTHX_ "Can't use '%c' after -mname", *s);
3247 sv_catpvs( sv, " ()");
3250 sv_catpvn(sv, start, s-start);
3251 /* Use NUL as q''-delimiter. */
3252 sv_catpvs(sv, " split(/,/,q\0");
3254 sv_catpvn(sv, s, end - s);
3255 sv_catpvs(sv, "\0)");
3258 Perl_av_create_and_push(aTHX_ &PL_preambleav, sv);
3261 Perl_croak(aTHX_ "Missing argument to -%c", option);
3272 forbid_setid('s', FALSE);
3273 PL_doswitches = TRUE;
3287 #ifdef MACOS_TRADITIONAL
3288 Perl_croak(aTHX_ "Believe me, you don't want to use \"-u\" on a Macintosh");
3290 PL_do_undump = TRUE;
3298 if (!sv_derived_from(PL_patchlevel, "version"))
3299 upg_version(PL_patchlevel, TRUE);
3301 PerlIO_printf(PerlIO_stdout(),
3302 "\nThis is perl, %"SVf
3303 #ifdef PERL_PATCHNUM
3304 " DEVEL" STRINGIFY(PERL_PATCHNUM)
3307 SVfARG(vstringify(PL_patchlevel)),
3310 /* Adjust verbose output as in the perl that ships with the DG/UX OS from EMC */
3311 PerlIO_printf(PerlIO_stdout(),
3312 Perl_form(aTHX_ "\nThis is perl, %"SVf"\n",
3313 SVfARG(vstringify(PL_patchlevel))));
3314 PerlIO_printf(PerlIO_stdout(),
3315 Perl_form(aTHX_ " built under %s at %s %s\n",
3316 OSNAME, __DATE__, __TIME__));
3317 PerlIO_printf(PerlIO_stdout(),
3318 Perl_form(aTHX_ " OS Specific Release: %s\n",
3322 #if defined(LOCAL_PATCH_COUNT)
3323 if (LOCAL_PATCH_COUNT > 0)
3324 PerlIO_printf(PerlIO_stdout(),
3325 "\n(with %d registered patch%s, "
3326 "see perl -V for more detail)",
3328 (LOCAL_PATCH_COUNT!=1) ? "es" : "");
3331 PerlIO_printf(PerlIO_stdout(),
3332 "\n\nCopyright 1987-2008, Larry Wall\n");
3333 #ifdef MACOS_TRADITIONAL
3334 PerlIO_printf(PerlIO_stdout(),
3335 "\nMac OS port Copyright 1991-2002, Matthias Neeracher;\n"
3336 "maintained by Chris Nandor\n");
3339 PerlIO_printf(PerlIO_stdout(),
3340 "\nMS-DOS port Copyright (c) 1989, 1990, Diomidis Spinellis\n");
3343 PerlIO_printf(PerlIO_stdout(),
3344 "djgpp v2 port (jpl5003c) by Hirofumi Watanabe, 1996\n"
3345 "djgpp v2 port (perl5004+) by Laszlo Molnar, 1997-1999\n");
3348 PerlIO_printf(PerlIO_stdout(),
3349 "\n\nOS/2 port Copyright (c) 1990, 1991, Raymond Chen, Kai Uwe Rommel\n"
3350 "Version 5 port Copyright (c) 1994-2002, Andreas Kaiser, Ilya Zakharevich\n");
3353 PerlIO_printf(PerlIO_stdout(),
3354 "atariST series port, ++jrb bammi@cadence.com\n");
3357 PerlIO_printf(PerlIO_stdout(),
3358 "BeOS port Copyright Tom Spindler, 1997-1999\n");
3361 PerlIO_printf(PerlIO_stdout(),
3362 "MPE/iX port Copyright by Mark Klein and Mark Bixby, 1996-2003\n");
3365 PerlIO_printf(PerlIO_stdout(),
3366 "MVS (OS390) port by Mortice Kern Systems, 1997-1999\n");
3369 PerlIO_printf(PerlIO_stdout(),
3370 "Stratus VOS port by Paul.Green@stratus.com, 1997-2002\n");
3373 PerlIO_printf(PerlIO_stdout(),
3374 "VM/ESA port by Neale Ferguson, 1998-1999\n");
3377 PerlIO_printf(PerlIO_stdout(),
3378 "BS2000 (POSIX) port by Start Amadeus GmbH, 1998-1999\n");
3381 PerlIO_printf(PerlIO_stdout(),
3382 "MiNT port by Guido Flohr, 1997-1999\n");
3385 PerlIO_printf(PerlIO_stdout(),
3386 "EPOC port by Olaf Flebbe, 1999-2002\n");
3389 PerlIO_printf(PerlIO_stdout(),"WINCE port by Rainer Keuchel, 2001-2002\n");
3390 PerlIO_printf(PerlIO_stdout(),"Built on " __DATE__ " " __TIME__ "\n\n");
3393 #ifdef __SYMBIAN32__
3394 PerlIO_printf(PerlIO_stdout(),
3395 "Symbian port by Nokia, 2004-2005\n");
3397 #ifdef BINARY_BUILD_NOTICE
3398 BINARY_BUILD_NOTICE;
3400 PerlIO_printf(PerlIO_stdout(),
3402 Perl may be copied only under the terms of either the Artistic License or the\n\
3403 GNU General Public License, which may be found in the Perl 5 source kit.\n\n\
3404 Complete documentation for Perl, including FAQ lists, should be found on\n\
3405 this system using \"man perl\" or \"perldoc perl\". If you have access to the\n\
3406 Internet, point your browser at http://www.perl.org/, the Perl Home Page.\n\n");
3409 if (! (PL_dowarn & G_WARN_ALL_MASK)) {
3410 PL_dowarn |= G_WARN_ON;
3415 PL_dowarn = G_WARN_ALL_ON|G_WARN_ON;
3416 if (!specialWARN(PL_compiling.cop_warnings))
3417 PerlMemShared_free(PL_compiling.cop_warnings);
3418 PL_compiling.cop_warnings = pWARN_ALL ;
3422 PL_dowarn = G_WARN_ALL_OFF;
3423 if (!specialWARN(PL_compiling.cop_warnings))
3424 PerlMemShared_free(PL_compiling.cop_warnings);
3425 PL_compiling.cop_warnings = pWARN_NONE ;
3432 if (s[0] == '-') /* Additional switches on #! line. */
3437 #if defined(WIN32) || !defined(PERL_STRICT_CR)
3443 #ifdef ALTERNATE_SHEBANG
3444 case 'S': /* OS/2 needs -S on "extproc" line. */
3448 Perl_croak(aTHX_ "Can't emulate -%.1s on #! line",s);
3453 /* compliments of Tom Christiansen */
3455 /* unexec() can be found in the Gnu emacs distribution */
3456 /* Known to work with -DUNEXEC and using unexelf.c from GNU emacs-20.2 */
3459 Perl_my_unexec(pTHX)
3461 PERL_UNUSED_CONTEXT;
3463 SV * prog = newSVpv(BIN_EXP, 0);
3464 SV * file = newSVpv(PL_origfilename, 0);
3468 sv_catpvs(prog, "/perl");
3469 sv_catpvs(file, ".perldump");
3471 unexec(SvPVX(file), SvPVX(prog), &etext, sbrk(0), 0);
3472 /* unexec prints msg to stderr in case of failure */
3473 PerlProc_exit(status);
3476 # include <lib$routines.h>
3477 lib$signal(SS$_DEBUG); /* ssdef.h #included from vmsish.h */
3478 # elif defined(WIN32) || defined(__CYGWIN__)
3479 Perl_croak(aTHX_ "dump is not supported");
3481 ABORT(); /* for use with undump */
3486 /* initialize curinterp */
3492 # define PERLVAR(var,type)
3493 # define PERLVARA(var,n,type)
3494 # if defined(PERL_IMPLICIT_CONTEXT)
3495 # define PERLVARI(var,type,init) aTHX->var = init;
3496 # define PERLVARIC(var,type,init) aTHX->var = init;
3498 # define PERLVARI(var,type,init) PERL_GET_INTERP->var = init;
3499 # define PERLVARIC(var,type,init) PERL_GET_INTERP->var = init;
3501 # include "intrpvar.h"
3507 # define PERLVAR(var,type)
3508 # define PERLVARA(var,n,type)
3509 # define PERLVARI(var,type,init) PL_##var = init;
3510 # define PERLVARIC(var,type,init) PL_##var = init;
3511 # include "intrpvar.h"
3518 /* As these are inside a structure, PERLVARI isn't capable of initialising
3520 PL_reg_oldcurpm = PL_reg_curpm = NULL;
3521 PL_reg_poscache = PL_reg_starttry = NULL;
3525 S_init_main_stash(pTHX)
3530 PL_curstash = PL_defstash = newHV();
3531 /* We know that the string "main" will be in the global shared string
3532 table, so it's a small saving to use it rather than allocate another
3534 PL_curstname = newSVpvs_share("main");
3535 gv = gv_fetchpvs("main::", GV_ADD|GV_NOTQUAL, SVt_PVHV);
3536 /* If we hadn't caused another reference to "main" to be in the shared
3537 string table above, then it would be worth reordering these two,
3538 because otherwise all we do is delete "main" from it as a consequence
3539 of the SvREFCNT_dec, only to add it again with hv_name_set */
3540 SvREFCNT_dec(GvHV(gv));
3541 hv_name_set(PL_defstash, "main", 4, 0);
3542 GvHV(gv) = MUTABLE_HV(SvREFCNT_inc_simple(PL_defstash));
3544 PL_incgv = gv_HVadd(gv_AVadd(gv_fetchpvs("INC", GV_ADD|GV_NOTQUAL,
3546 SvREFCNT_inc_simple_void(PL_incgv); /* Don't allow it to be freed */
3547 GvMULTI_on(PL_incgv);
3548 PL_hintgv = gv_fetchpvs("\010", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^H */
3549 GvMULTI_on(PL_hintgv);
3550 PL_defgv = gv_fetchpvs("_", GV_ADD|GV_NOTQUAL, SVt_PVAV);
3551 SvREFCNT_inc_simple_void(PL_defgv);
3552 PL_errgv = gv_HVadd(gv_fetchpvs("@", GV_ADD|GV_NOTQUAL, SVt_PV));
3553 SvREFCNT_inc_simple_void(PL_errgv);
3554 GvMULTI_on(PL_errgv);
3555 PL_replgv = gv_fetchpvs("\022", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^R */
3556 GvMULTI_on(PL_replgv);
3557 (void)Perl_form(aTHX_ "%240s",""); /* Preallocate temp - for immediate signals. */
3558 #ifdef PERL_DONT_CREATE_GVSV
3561 sv_grow(ERRSV, 240); /* Preallocate - for immediate signals. */
3563 PL_curstash = PL_defstash;
3564 CopSTASH_set(&PL_compiling, PL_defstash);
3565 PL_debstash = GvHV(gv_fetchpvs("DB::", GV_ADDMULTI, SVt_PVHV));
3566 PL_globalstash = GvHV(gv_fetchpvs("CORE::GLOBAL::", GV_ADDMULTI,
3568 /* We must init $/ before switches are processed. */
3569 sv_setpvs(get_sv("/", TRUE), "\n");
3573 S_open_script(pTHX_ const char *scriptname, bool dosearch,
3574 bool *suidscript, PerlIO **rsfpp)
3579 PERL_ARGS_ASSERT_OPEN_SCRIPT;
3582 PL_origfilename = savepvs("-e");
3585 /* if find_script() returns, it returns a malloc()-ed value */
3586 scriptname = PL_origfilename = find_script(scriptname, dosearch, NULL, 1);
3588 if (strnEQ(scriptname, "/dev/fd/", 8) && isDIGIT(scriptname[8]) ) {
3589 const char *s = scriptname + 8;
3595 * Tell apart "normal" usage of fdscript, e.g.
3596 * with bash on FreeBSD:
3597 * perl <( echo '#!perl -DA'; echo 'print "$0\n"')
3598 * from usage in suidperl.
3599 * Does any "normal" usage leave garbage after the number???
3600 * Is it a mistake to use a similar /dev/fd/ construct for
3605 * Be supersafe and do some sanity-checks.
3606 * Still, can we be sure we got the right thing?
3609 Perl_croak(aTHX_ "Wrong syntax (suid) fd script name \"%s\"\n", s);
3612 Perl_croak(aTHX_ "Missing (suid) fd script name\n");
3614 scriptname = savepv(s + 1);
3615 Safefree(PL_origfilename);
3616 PL_origfilename = (char *)scriptname;
3621 CopFILE_free(PL_curcop);
3622 CopFILE_set(PL_curcop, PL_origfilename);
3623 if (*PL_origfilename == '-' && PL_origfilename[1] == '\0')
3624 scriptname = (char *)"";
3625 if (fdscript >= 0) {
3626 *rsfpp = PerlIO_fdopen(fdscript,PERL_SCRIPT_MODE);
3627 # if defined(HAS_FCNTL) && defined(F_SETFD)
3629 /* ensure close-on-exec */
3630 fcntl(PerlIO_fileno(*rsfpp),F_SETFD,1);
3635 Perl_croak(aTHX_ "sperl needs fd script\n"
3636 "You should not call sperl directly; do you need to "
3637 "change a #! line\nfrom sperl to perl?\n");
3640 * Do not open (or do other fancy stuff) while setuid.
3641 * Perl does the open, and hands script to suidperl on a fd;
3642 * suidperl only does some checks, sets up UIDs and re-execs
3643 * perl with that fd as it has always done.
3647 Perl_croak(aTHX_ "suidperl needs (suid) fd script\n");
3650 else if (!*scriptname) {
3651 forbid_setid(0, *suidscript);
3652 *rsfpp = PerlIO_stdin();
3655 #ifdef FAKE_BIT_BUCKET
3656 /* This hack allows one not to have /dev/null (or BIT_BUCKET as it
3657 * is called) and still have the "-e" work. (Believe it or not,
3658 * a /dev/null is required for the "-e" to work because source
3659 * filter magic is used to implement it. ) This is *not* a general
3660 * replacement for a /dev/null. What we do here is create a temp
3661 * file (an empty file), open up that as the script, and then
3662 * immediately close and unlink it. Close enough for jazz. */
3663 #define FAKE_BIT_BUCKET_PREFIX "/tmp/perlnull-"
3664 #define FAKE_BIT_BUCKET_SUFFIX "XXXXXXXX"
3665 #define FAKE_BIT_BUCKET_TEMPLATE FAKE_BIT_BUCKET_PREFIX FAKE_BIT_BUCKET_SUFFIX
3666 char tmpname[sizeof(FAKE_BIT_BUCKET_TEMPLATE)] = {
3667 FAKE_BIT_BUCKET_TEMPLATE
3669 const char * const err = "Failed to create a fake bit bucket";
3670 if (strEQ(scriptname, BIT_BUCKET)) {
3671 #ifdef HAS_MKSTEMP /* Hopefully mkstemp() is safe here. */
3672 int tmpfd = mkstemp(tmpname);
3674 scriptname = tmpname;
3677 Perl_croak(aTHX_ err);
3680 scriptname = mktemp(tmpname);
3682 Perl_croak(aTHX_ err);
3687 *rsfpp = PerlIO_open(scriptname,PERL_SCRIPT_MODE);
3688 #ifdef FAKE_BIT_BUCKET
3689 if (memEQ(scriptname, FAKE_BIT_BUCKET_PREFIX,
3690 sizeof(FAKE_BIT_BUCKET_PREFIX) - 1)
3691 && strlen(scriptname) == sizeof(tmpname) - 1) {
3694 scriptname = BIT_BUCKET;
3696 # if defined(HAS_FCNTL) && defined(F_SETFD)
3698 /* ensure close-on-exec */
3699 fcntl(PerlIO_fileno(*rsfpp),F_SETFD,1);
3702 #endif /* IAMSUID */
3704 /* PSz 16 Sep 03 Keep neat error message */
3706 Perl_croak(aTHX_ "Can't open "BIT_BUCKET": %s\n", Strerror(errno));
3708 Perl_croak(aTHX_ "Can't open perl script \"%s\": %s\n",
3709 CopFILE(PL_curcop), Strerror(errno));
3715 * I_SYSSTATVFS HAS_FSTATVFS
3717 * I_STATFS HAS_FSTATFS HAS_GETFSSTAT
3718 * I_MNTENT HAS_GETMNTENT HAS_HASMNTOPT
3719 * here so that metaconfig picks them up. */
3723 S_fd_on_nosuid_fs(pTHX_ int fd)
3726 * We used to do this as "plain" user (after swapping UIDs with setreuid);
3727 * but is needed also on machines without setreuid.
3728 * Seems safe enough to run as root.
3730 int check_okay = 0; /* able to do all the required sys/libcalls */
3731 int on_nosuid = 0; /* the fd is on a nosuid fs */
3733 * Need to check noexec also: nosuid might not be set, the average
3734 * sysadmin would say that nosuid is irrelevant once he sets noexec.
3736 int on_noexec = 0; /* the fd is on a noexec fs */
3739 * Preferred order: fstatvfs(), fstatfs(), ustat()+getmnt(), getmntent().
3740 * fstatvfs() is UNIX98.
3741 * fstatfs() is 4.3 BSD.
3742 * ustat()+getmnt() is pre-4.3 BSD.
3743 * getmntent() is O(number-of-mounted-filesystems) and can hang on
3744 * an irrelevant filesystem while trying to reach the right one.
3747 #undef FD_ON_NOSUID_CHECK_OKAY /* found the syscalls to do the check? */
3749 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3750 defined(HAS_FSTATVFS)
3751 # define FD_ON_NOSUID_CHECK_OKAY
3752 struct statvfs stfs;
3754 check_okay = fstatvfs(fd, &stfs) == 0;
3755 on_nosuid = check_okay && (stfs.f_flag & ST_NOSUID);
3757 /* ST_NOEXEC certainly absent on AIX 5.1, and doesn't seem to be documented
3758 on platforms where it is present. */
3759 on_noexec = check_okay && (stfs.f_flag & ST_NOEXEC);
3761 # endif /* fstatvfs */
3763 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3764 defined(PERL_MOUNT_NOSUID) && \
3765 defined(PERL_MOUNT_NOEXEC) && \
3766 defined(HAS_FSTATFS) && \
3767 defined(HAS_STRUCT_STATFS) && \
3768 defined(HAS_STRUCT_STATFS_F_FLAGS)
3769 # define FD_ON_NOSUID_CHECK_OKAY
3772 check_okay = fstatfs(fd, &stfs) == 0;
3773 on_nosuid = check_okay && (stfs.f_flags & PERL_MOUNT_NOSUID);
3774 on_noexec = check_okay && (stfs.f_flags & PERL_MOUNT_NOEXEC);
3775 # endif /* fstatfs */
3777 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3778 defined(PERL_MOUNT_NOSUID) && \
3779 defined(PERL_MOUNT_NOEXEC) && \
3780 defined(HAS_FSTAT) && \
3781 defined(HAS_USTAT) && \
3782 defined(HAS_GETMNT) && \
3783 defined(HAS_STRUCT_FS_DATA) && \
3785 # define FD_ON_NOSUID_CHECK_OKAY
3788 if (fstat(fd, &fdst) == 0) {
3790 if (ustat(fdst.st_dev, &us) == 0) {
3792 /* NOSTAT_ONE here because we're not examining fields which
3793 * vary between that case and STAT_ONE. */
3794 if (getmnt((int*)0, &fsd, (int)0, NOSTAT_ONE, us.f_fname) == 0) {
3795 size_t cmplen = sizeof(us.f_fname);
3796 if (sizeof(fsd.fd_req.path) < cmplen)
3797 cmplen = sizeof(fsd.fd_req.path);
3798 if (strnEQ(fsd.fd_req.path, us.f_fname, cmplen) &&
3799 fdst.st_dev == fsd.fd_req.dev) {
3801 on_nosuid = fsd.fd_req.flags & PERL_MOUNT_NOSUID;
3802 on_noexec = fsd.fd_req.flags & PERL_MOUNT_NOEXEC;
3807 # endif /* fstat+ustat+getmnt */
3809 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3810 defined(HAS_GETMNTENT) && \
3811 defined(HAS_HASMNTOPT) && \
3812 defined(MNTOPT_NOSUID) && \
3813 defined(MNTOPT_NOEXEC)
3814 # define FD_ON_NOSUID_CHECK_OKAY
3815 FILE *mtab = fopen("/etc/mtab", "r");
3816 struct mntent *entry;
3819 if (mtab && (fstat(fd, &stb) == 0)) {
3820 while (entry = getmntent(mtab)) {
3821 if (stat(entry->mnt_dir, &fsb) == 0
3822 && fsb.st_dev == stb.st_dev)
3824 /* found the filesystem */
3826 if (hasmntopt(entry, MNTOPT_NOSUID))
3828 if (hasmntopt(entry, MNTOPT_NOEXEC))
3831 } /* A single fs may well fail its stat(). */
3836 # endif /* getmntent+hasmntopt */
3839 Perl_croak(aTHX_ "Can't check filesystem of script \"%s\" for nosuid/noexec", PL_origfilename);
3841 Perl_croak(aTHX_ "Setuid script \"%s\" on nosuid filesystem", PL_origfilename);
3843 Perl_croak(aTHX_ "Setuid script \"%s\" on noexec filesystem", PL_origfilename);
3844 return ((!check_okay) || on_nosuid || on_noexec);
3846 #endif /* IAMSUID */
3850 S_validate_suid(pTHX_ const char *validarg,
3852 const char *scriptname,
3858 SV *linestr_sv, PerlIO *rsfp)
3863 PERL_ARGS_ASSERT_VALIDATE_SUID;
3865 /* do we need to emulate setuid on scripts? */
3867 /* This code is for those BSD systems that have setuid #! scripts disabled
3868 * in the kernel because of a security problem. Merely defining DOSUID
3869 * in perl will not fix that problem, but if you have disabled setuid
3870 * scripts in the kernel, this will attempt to emulate setuid and setgid
3871 * on scripts that have those now-otherwise-useless bits set. The setuid
3872 * root version must be called suidperl or sperlN.NNN. If regular perl
3873 * discovers that it has opened a setuid script, it calls suidperl with
3874 * the same argv that it had. If suidperl finds that the script it has
3875 * just opened is NOT setuid root, it sets the effective uid back to the
3876 * uid. We don't just make perl setuid root because that loses the
3877 * effective uid we had before invoking perl, if it was different from the
3880 * Description/comments above do not match current workings:
3881 * suidperl must be hardlinked to sperlN.NNN (that is what we exec);
3882 * suidperl called with script open and name changed to /dev/fd/N/X;
3883 * suidperl croaks if script is not setuid;
3884 * making perl setuid would be a huge security risk (and yes, that
3885 * would lose any euid we might have had).
3887 * DOSUID must be defined in both perl and suidperl, and IAMSUID must
3888 * be defined in suidperl only. suidperl must be setuid root. The
3889 * Configure script will set this up for you if you want it.
3892 if (PerlLIO_fstat(PerlIO_fileno(rsfp),&PL_statbuf) < 0) /* normal stat is insecure */
3893 Perl_croak(aTHX_ "Can't stat script \"%s\"",PL_origfilename);
3894 if (PL_statbuf.st_mode & (S_ISUID|S_ISGID)) {
3896 const char *linestr;
3900 if (fdscript < 0 || !suidscript)
3901 Perl_croak(aTHX_ "Need (suid) fdscript in suidperl\n"); /* We already checked this */
3903 * Since the script is opened by perl, not suidperl, some of these
3904 * checks are superfluous. Leaving them in probably does not lower
3908 * Do checks even for systems with no HAS_SETREUID.
3909 * We used to swap, then re-swap UIDs with
3910 # ifdef HAS_SETREUID
3911 if (setreuid(PL_euid,PL_uid) < 0
3912 || PerlProc_getuid() != PL_euid || PerlProc_geteuid() != PL_uid)
3913 Perl_croak(aTHX_ "Can't swap uid and euid");
3915 # ifdef HAS_SETREUID
3916 if (setreuid(PL_uid,PL_euid) < 0
3917 || PerlProc_getuid() != PL_uid || PerlProc_geteuid() != PL_euid)
3918 Perl_croak(aTHX_ "Can't reswap uid and euid");
3922 /* On this access check to make sure the directories are readable,
3923 * there is actually a small window that the user could use to make
3924 * filename point to an accessible directory. So there is a faint
3925 * chance that someone could execute a setuid script down in a
3926 * non-accessible directory. I don't know what to do about that.
3927 * But I don't think it's too important. The manual lies when
3928 * it says access() is useful in setuid programs.
3930 * So, access() is pretty useless... but not harmful... do anyway.
3932 if (PerlLIO_access(CopFILE(PL_curcop),1)) { /*double check*/
3933 Perl_croak(aTHX_ "Can't access() script\n");
3936 /* If we can swap euid and uid, then we can determine access rights
3937 * with a simple stat of the file, and then compare device and
3938 * inode to make sure we did stat() on the same file we opened.
3939 * Then we just have to make sure he or she can execute it.
3942 * As the script is opened by perl, not suidperl, we do not need to
3943 * care much about access rights.
3945 * The 'script changed' check is needed, or we can get lied to
3946 * about $0 with e.g.
3947 * suidperl /dev/fd/4//bin/x 4<setuidscript
3948 * Without HAS_SETREUID, is it safe to stat() as root?
3950 * Are there any operating systems that pass /dev/fd/xxx for setuid
3951 * scripts, as suggested/described in perlsec(1)? Surely they do not
3952 * pass the script name as we do, so the "script changed" test would
3953 * fail for them... but we never get here with
3954 * SETUID_SCRIPTS_ARE_SECURE_NOW defined.
3956 * This is one place where we must "lie" about return status: not
3957 * say if the stat() failed. We are doing this as root, and could
3958 * be tricked into reporting existence or not of files that the
3959 * "plain" user cannot even see.
3963 if (PerlLIO_stat(CopFILE(PL_curcop),&tmpstatbuf) < 0 ||
3964 tmpstatbuf.st_dev != PL_statbuf.st_dev ||
3965 tmpstatbuf.st_ino != PL_statbuf.st_ino) {
3966 Perl_croak(aTHX_ "Setuid script changed\n");
3970 if (!cando(S_IXUSR,FALSE,&PL_statbuf)) /* can real uid exec? */
3971 Perl_croak(aTHX_ "Real UID cannot exec script\n");
3974 * We used to do this check as the "plain" user (after swapping
3975 * UIDs). But the check for nosuid and noexec filesystem is needed,
3976 * and should be done even without HAS_SETREUID. (Maybe those
3977 * operating systems do not have such mount options anyway...)
3978 * Seems safe enough to do as root.
3980 # if !defined(NO_NOSUID_CHECK)
3981 if (fd_on_nosuid_fs(PerlIO_fileno(rsfp))) {
3982 Perl_croak(aTHX_ "Setuid script on nosuid or noexec filesystem\n");
3985 # endif /* IAMSUID */
3987 if (!S_ISREG(PL_statbuf.st_mode)) {
3988 Perl_croak(aTHX_ "Setuid script not plain file\n");
3990 if (PL_statbuf.st_mode & S_IWOTH)
3991 Perl_croak(aTHX_ "Setuid/gid script is writable by world");
3992 PL_doswitches = FALSE; /* -s is insecure in suid */
3993 /* PSz 13 Nov 03 But -s was caught elsewhere ... so unsetting it here is useless(?!) */
3994 CopLINE_inc(PL_curcop);
3995 if (sv_gets(linestr_sv, rsfp, 0) == NULL)
3996 Perl_croak(aTHX_ "No #! line");
3997 linestr = SvPV_nolen_const(linestr_sv);
3998 /* required even on Sys V */
3999 if (!*linestr || !linestr[1] || strnNE(linestr,"#!",2))
4000 Perl_croak(aTHX_ "No #! line");
4004 /* Sanity check on line length */
4005 s_end = s + strlen(s);
4006 if (s_end == s || (s_end - s) > 4000)
4007 Perl_croak(aTHX_ "Very long #! line");
4008 /* Allow more than a single space after #! */
4009 while (isSPACE(*s)) s++;
4010 /* Sanity check on buffer end */
4011 while ((*s) && !isSPACE(*s)) s++;
4012 for (s2 = s; (s2 > linestr &&
4013 (isDIGIT(s2[-1]) || s2[-1] == '.' || s2[-1] == '_'
4014 || s2[-1] == '-')); s2--) ;
4015 /* Sanity check on buffer start */
4016 if ( (s2-4 < linestr || strnNE(s2-4,"perl",4)) &&
4017 (s-9 < linestr || strnNE(s-9,"perl",4)) )
4018 Perl_croak(aTHX_ "Not a perl script");
4019 while (*s == ' ' || *s == '\t') s++;
4021 * #! arg must be what we saw above. They can invoke it by
4022 * mentioning suidperl explicitly, but they may not add any strange
4023 * arguments beyond what #! says if they do invoke suidperl that way.
4026 * The way validarg was set up, we rely on the kernel to start
4027 * scripts with argv[1] set to contain all #! line switches (the
4031 * Check that we got all the arguments listed in the #! line (not
4032 * just that there are no extraneous arguments). Might not matter
4033 * much, as switches from #! line seem to be acted upon (also), and
4034 * so may be checked and trapped in perl. But, security checks must
4035 * be done in suidperl and not deferred to perl. Note that suidperl
4036 * does not get around to parsing (and checking) the switches on
4037 * the #! line (but execs perl sooner).
4038 * Allow (require) a trailing newline (which may be of two
4039 * characters on some architectures?) (but no other trailing
4042 len = strlen(validarg);
4043 if (strEQ(validarg," PHOOEY ") ||
4044 strnNE(s,validarg,len) || !isSPACE(s[len]) ||
4045 !((s_end - s) == len+1
4046 || ((s_end - s) == len+2 && isSPACE(s[len+1]))))
4047 Perl_croak(aTHX_ "Args must match #! line");
4051 PL_euid != PL_uid && (PL_statbuf.st_mode & S_ISUID) &&
4052 PL_euid == PL_statbuf.st_uid)
4054 Perl_croak(aTHX_ "YOU HAVEN'T DISABLED SET-ID SCRIPTS IN THE KERNEL YET!\n\
4055 FIX YOUR KERNEL, OR PUT A C WRAPPER AROUND THIS SCRIPT!\n");
4056 # endif /* IAMSUID */
4059 PL_euid) { /* oops, we're not the setuid root perl */
4061 * When root runs a setuid script, we do not go through the same
4062 * steps of execing sperl and then perl with fd scripts, but
4063 * simply set up UIDs within the same perl invocation; so do
4064 * not have the same checks (on options, whatever) that we have
4065 * for plain users. No problem really: would have to be a script
4066 * that does not actually work for plain users; and if root is
4067 * foolish and can be persuaded to run such an unsafe script, he
4068 * might run also non-setuid ones, and deserves what he gets.
4070 * Or, we might drop the PL_euid check above (and rely just on
4071 * fdscript to avoid loops), and do the execs
4077 * Pass fd script to suidperl.
4078 * Exec suidperl, substituting fd script for scriptname.
4079 * Pass script name as "subdir" of fd, which perl will grok;
4080 * in fact will use that to distinguish this from "normal"
4081 * usage, see comments above.
4083 PerlIO_rewind(rsfp);
4084 PerlLIO_lseek(PerlIO_fileno(rsfp),(Off_t)0,0); /* just in case rewind didn't */
4085 /* PSz 27 Feb 04 Sanity checks on scriptname */
4086 if ((!scriptname) || (!*scriptname) ) {
4087 Perl_croak(aTHX_ "No setuid script name\n");
4089 if (*scriptname == '-') {
4090 Perl_croak(aTHX_ "Setuid script name may not begin with dash\n");
4091 /* Or we might confuse it with an option when replacing
4092 * name in argument list, below (though we do pointer, not
4093 * string, comparisons).
4096 for (which = 1; PL_origargv[which] && PL_origargv[which] != scriptname; which++) ;
4097 if (!PL_origargv[which]) {
4098 Perl_croak(aTHX_ "Can't change argv to have fd script\n");
4100 PL_origargv[which] = savepv(Perl_form(aTHX_ "/dev/fd/%d/%s",
4101 PerlIO_fileno(rsfp), PL_origargv[which]));
4102 # if defined(HAS_FCNTL) && defined(F_SETFD)
4103 fcntl(PerlIO_fileno(rsfp),F_SETFD,0); /* ensure no close-on-exec */
4106 PerlProc_execv(Perl_form(aTHX_ "%s/sperl"PERL_FS_VER_FMT, BIN_EXP,
4107 (int)PERL_REVISION, (int)PERL_VERSION,
4108 (int)PERL_SUBVERSION), PL_origargv);
4110 # endif /* IAMSUID */
4111 Perl_croak(aTHX_ "Can't do setuid (cannot exec sperl)\n");
4114 if (PL_statbuf.st_mode & S_ISGID && PL_statbuf.st_gid != PL_egid) {
4116 * This seems back to front: we try HAS_SETEGID first; if not available
4117 * then try HAS_SETREGID; as a last chance we try HAS_SETRESGID. May be OK
4118 * in the sense that we only want to set EGID; but are there any machines
4119 * with either of the latter, but not the former? Same with UID, later.
4122 (void)setegid(PL_statbuf.st_gid);
4124 # ifdef HAS_SETREGID
4125 (void)setregid((Gid_t)-1,PL_statbuf.st_gid);
4127 # ifdef HAS_SETRESGID
4128 (void)setresgid((Gid_t)-1,PL_statbuf.st_gid,(Gid_t)-1);
4130 PerlProc_setgid(PL_statbuf.st_gid);
4134 if (PerlProc_getegid() != PL_statbuf.st_gid)
4135 Perl_croak(aTHX_ "Can't do setegid!\n");
4137 if (PL_statbuf.st_mode & S_ISUID) {
4138 if (PL_statbuf.st_uid != PL_euid)
4140 (void)seteuid(PL_statbuf.st_uid); /* all that for this */
4142 # ifdef HAS_SETREUID
4143 (void)setreuid((Uid_t)-1,PL_statbuf.st_uid);
4145 # ifdef HAS_SETRESUID
4146 (void)setresuid((Uid_t)-1,PL_statbuf.st_uid,(Uid_t)-1);
4148 PerlProc_setuid(PL_statbuf.st_uid);
4152 if (PerlProc_geteuid() != PL_statbuf.st_uid)
4153 Perl_croak(aTHX_ "Can't do seteuid!\n");
4155 else if (PL_uid) { /* oops, mustn't run as root */
4157 (void)seteuid((Uid_t)PL_uid);
4159 # ifdef HAS_SETREUID
4160 (void)setreuid((Uid_t)-1,(Uid_t)PL_uid);
4162 # ifdef HAS_SETRESUID
4163 (void)setresuid((Uid_t)-1,(Uid_t)PL_uid,(Uid_t)-1);
4165 PerlProc_setuid((Uid_t)PL_uid);
4169 if (PerlProc_geteuid() != PL_uid)
4170 Perl_croak(aTHX_ "Can't do seteuid!\n");
4173 if (!cando(S_IXUSR,TRUE,&PL_statbuf))
4174 Perl_croak(aTHX_ "Effective UID cannot exec script\n"); /* they can't do this */
4177 else if (fdscript < 0 || !suidscript)
4178 /* PSz 13 Nov 03 Caught elsewhere, useless(?!) here */
4179 Perl_croak(aTHX_ "(suid) fdscript needed in suidperl\n");
4181 /* PSz 16 Sep 03 Keep neat error message */
4182 Perl_croak(aTHX_ "Script is not setuid/setgid in suidperl\n");
4185 /* We absolutely must clear out any saved ids here, so we */
4186 /* exec the real perl, substituting fd script for scriptname. */
4187 /* (We pass script name as "subdir" of fd, which perl will grok.) */
4189 * It might be thought that using setresgid and/or setresuid (changed to
4190 * set the saved IDs) above might obviate the need to exec, and we could
4191 * go on to "do the perl thing".
4193 * Is there such a thing as "saved GID", and is that set for setuid (but
4194 * not setgid) execution like suidperl? Without exec, it would not be
4195 * cleared for setuid (but not setgid) scripts (or might need a dummy
4198 * We need suidperl to do the exact same argument checking that perl
4199 * does. Thus it cannot be very small; while it could be significantly
4200 * smaller, it is safer (simpler?) to make it essentially the same
4201 * binary as perl (but they are not identical). - Maybe could defer that
4202 * check to the invoked perl, and suidperl be a tiny wrapper instead;
4203 * but prefer to do thorough checks in suidperl itself. Such deferral
4204 * would make suidperl security rely on perl, a design no-no.
4206 * Setuid things should be short and simple, thus easy to understand and
4207 * verify. They should do their "own thing", without influence by
4208 * attackers. It may help if their internal execution flow is fixed,
4209 * regardless of platform: it may be best to exec anyway.
4211 * Suidperl should at least be conceptually simple: a wrapper only,
4212 * never to do any real perl. Maybe we should put
4214 * Perl_croak(aTHX_ "Suidperl should never do real perl\n");
4216 * into the perly bits.
4218 PerlIO_rewind(rsfp);
4219 PerlLIO_lseek(PerlIO_fileno(rsfp),(Off_t)0,0); /* just in case rewind didn't */
4221 * Keep original arguments: suidperl already has fd script.
4223 # if defined(HAS_FCNTL) && defined(F_SETFD)
4224 fcntl(PerlIO_fileno(rsfp),F_SETFD,0); /* ensure no close-on-exec */
4227 PerlProc_execv(Perl_form(aTHX_ "%s/perl"PERL_FS_VER_FMT, BIN_EXP,
4228 (int)PERL_REVISION, (int)PERL_VERSION,
4229 (int)PERL_SUBVERSION), PL_origargv);/* try again */
4231 Perl_croak(aTHX_ "Can't do setuid (suidperl cannot exec perl)\n");
4232 # endif /* IAMSUID */
4237 # ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
4238 /* Don't even need this function. */
4241 S_validate_suid(pTHX_ PerlIO *rsfp)
4243 PERL_ARGS_ASSERT_VALIDATE_SUID;
4245 if (PL_euid != PL_uid || PL_egid != PL_gid) { /* (suidperl doesn't exist, in fact) */
4246 # ifndef SETUID_SCRIPTS_ARE_SECURE_NOW
4249 PerlLIO_fstat(PerlIO_fileno(rsfp),&PL_statbuf); /* may be either wrapped or real suid */
4250 if ((PL_euid != PL_uid && PL_euid == PL_statbuf.st_uid && PL_statbuf.st_mode & S_ISUID)
4252 (PL_egid != PL_gid && PL_egid == PL_statbuf.st_gid && PL_statbuf.st_mode & S_ISGID)
4255 Perl_croak(aTHX_ "YOU HAVEN'T DISABLED SET-ID SCRIPTS IN THE KERNEL YET!\n\
4256 FIX YOUR KERNEL, PUT A C WRAPPER AROUND THIS SCRIPT, OR USE -u AND UNDUMP!\n");
4257 # endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4258 /* not set-id, must be wrapped */
4261 # endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4265 S_find_beginning(pTHX_ SV* linestr_sv, PerlIO *rsfp)
4269 register const char *s2;
4270 #ifdef MACOS_TRADITIONAL
4274 PERL_ARGS_ASSERT_FIND_BEGINNING;
4276 /* skip forward in input to the real script? */
4278 #ifdef MACOS_TRADITIONAL
4279 /* Since the Mac OS does not honor #! arguments for us, we do it ourselves */
4281 while (PL_doextract || gMacPerl_AlwaysExtract) {
4282 if ((s = sv_gets(linestr_sv, rsfp, 0)) == NULL) {
4283 if (!gMacPerl_AlwaysExtract)
4284 Perl_croak(aTHX_ "No Perl script found in input\n");
4286 if (PL_doextract) /* require explicit override ? */
4287 if (!OverrideExtract(PL_origfilename))
4288 Perl_croak(aTHX_ "User aborted script\n");
4290 PL_doextract = FALSE;
4292 /* Pater peccavi, file does not have #! */
4293 PerlIO_rewind(rsfp);
4298 while (PL_doextract) {
4299 if ((s = sv_gets(linestr_sv, rsfp, 0)) == NULL)
4300 Perl_croak(aTHX_ "No Perl script found in input\n");
4303 if (*s == '#' && s[1] == '!' && ((s = instr(s,"perl")) || (s = instr(s2,"PERL")))) {
4304 PerlIO_ungetc(rsfp, '\n'); /* to keep line count right */
4305 PL_doextract = FALSE;
4306 while (*s && !(isSPACE (*s) || *s == '#')) s++;
4308 while (*s == ' ' || *s == '\t') s++;
4310 while (isDIGIT(s2[-1]) || s2[-1] == '-' || s2[-1] == '.'
4311 || s2[-1] == '_') s2--;
4312 if (strnEQ(s2-4,"perl",4))
4313 while ((s = moreswitches(s)))
4316 #ifdef MACOS_TRADITIONAL
4317 /* We are always searching for the #!perl line in MacPerl,
4318 * so if we find it, still keep the line count correct
4319 * by counting lines we already skipped over
4321 for (; maclines > 0 ; maclines--)
4322 PerlIO_ungetc(rsfp, '\n');
4326 /* gMacPerl_AlwaysExtract is false in MPW tool */
4327 } else if (gMacPerl_AlwaysExtract) {
4339 PL_uid = PerlProc_getuid();
4340 PL_euid = PerlProc_geteuid();
4341 PL_gid = PerlProc_getgid();
4342 PL_egid = PerlProc_getegid();
4344 PL_uid |= PL_gid << 16;
4345 PL_euid |= PL_egid << 16;
4347 /* Should not happen: */
4348 CHECK_MALLOC_TAINT(PL_uid && (PL_euid != PL_uid || PL_egid != PL_gid));
4349 PL_tainting |= (PL_uid && (PL_euid != PL_uid || PL_egid != PL_gid));
4352 * Should go by suidscript, not uid!=euid: why disallow
4353 * system("ls") in scripts run from setuid things?
4354 * Or, is this run before we check arguments and set suidscript?
4355 * What about SETUID_SCRIPTS_ARE_SECURE_NOW: could we use fdscript then?
4356 * (We never have suidscript, can we be sure to have fdscript?)
4357 * Or must then go by UID checks? See comments in forbid_setid also.
4361 /* This is used very early in the lifetime of the program,
4362 * before even the options are parsed, so PL_tainting has
4363 * not been initialized properly. */
4365 Perl_doing_taint(int argc, char *argv[], char *envp[])
4367 #ifndef PERL_IMPLICIT_SYS
4368 /* If we have PERL_IMPLICIT_SYS we can't call getuid() et alia
4369 * before we have an interpreter-- and the whole point of this
4370 * function is to be called at such an early stage. If you are on
4371 * a system with PERL_IMPLICIT_SYS but you do have a concept of
4372 * "tainted because running with altered effective ids', you'll
4373 * have to add your own checks somewhere in here. The two most
4374 * known samples of 'implicitness' are Win32 and NetWare, neither
4375 * of which has much of concept of 'uids'. */
4376 int uid = PerlProc_getuid();
4377 int euid = PerlProc_geteuid();
4378 int gid = PerlProc_getgid();
4379 int egid = PerlProc_getegid();
4386 if (uid && (euid != uid || egid != gid))
4388 #endif /* !PERL_IMPLICIT_SYS */
4389 /* This is a really primitive check; environment gets ignored only
4390 * if -T are the first chars together; otherwise one gets
4391 * "Too late" message. */
4392 if ( argc > 1 && argv[1][0] == '-'
4393 && (argv[1][1] == 't' || argv[1][1] == 'T') )
4398 /* Passing the flag as a single char rather than a string is a slight space
4399 optimisation. The only message that isn't /^-.$/ is
4400 "program input from stdin", which is substituted in place of '\0', which
4401 could never be a command line flag. */
4403 S_forbid_setid(pTHX_ const char flag, const bool suidscript) /* g */
4406 char string[3] = "-x";
4407 const char *message = "program input from stdin";
4414 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
4415 if (PL_euid != PL_uid)
4416 Perl_croak(aTHX_ "No %s allowed while running setuid", message);
4417 if (PL_egid != PL_gid)
4418 Perl_croak(aTHX_ "No %s allowed while running setgid", message);
4419 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4421 * Checks for UID/GID above "wrong": why disallow
4422 * perl -e 'print "Hello\n"'
4423 * from within setuid things?? Simply drop them: replaced by
4424 * fdscript/suidscript and #ifdef IAMSUID checks below.
4426 * This may be too late for command-line switches. Will catch those on
4427 * the #! line, after finding the script name and setting up
4428 * fdscript/suidscript. Note that suidperl does not get around to
4429 * parsing (and checking) the switches on the #! line, but checks that
4430 * the two sets are identical.
4432 * With SETUID_SCRIPTS_ARE_SECURE_NOW, could we use fdscript, also or
4433 * instead, or would that be "too late"? (We never have suidscript, can
4434 * we be sure to have fdscript?)
4436 * Catch things with suidscript (in descendant of suidperl), even with
4437 * right UID/GID. Was already checked in suidperl, with #ifdef IAMSUID,
4438 * below; but I am paranoid.
4440 * Also see comments about root running a setuid script, elsewhere.
4443 Perl_croak(aTHX_ "No %s allowed with (suid) fdscript", message);
4445 /* PSz 11 Nov 03 Catch it in suidperl, always! */
4446 Perl_croak(aTHX_ "No %s allowed in suidperl", message);
4447 #endif /* IAMSUID */
4451 Perl_init_debugger(pTHX)
4454 HV * const ostash = PL_curstash;
4456 PL_curstash = PL_debstash;
4457 PL_dbargs = GvAV(gv_AVadd((gv_fetchpvs("DB::args", GV_ADDMULTI,
4459 AvREAL_off(PL_dbargs);
4460 PL_DBgv = gv_fetchpvs("DB::DB", GV_ADDMULTI, SVt_PVGV);
4461 PL_DBline = gv_fetchpvs("DB::dbline", GV_ADDMULTI, SVt_PVAV);
4462 PL_DBsub = gv_HVadd(gv_fetchpvs("DB::sub", GV_ADDMULTI, SVt_PVHV));
4463 PL_DBsingle = GvSV((gv_fetchpvs("DB::single", GV_ADDMULTI, SVt_PV)));
4464 sv_setiv(PL_DBsingle, 0);
4465 PL_DBtrace = GvSV((gv_fetchpvs("DB::trace", GV_ADDMULTI, SVt_PV)));
4466 sv_setiv(PL_DBtrace, 0);
4467 PL_DBsignal = GvSV((gv_fetchpvs("DB::signal", GV_ADDMULTI, SVt_PV)));
4468 sv_setiv(PL_DBsignal, 0);
4469 PL_curstash = ostash;
4472 #ifndef STRESS_REALLOC
4473 #define REASONABLE(size) (size)
4475 #define REASONABLE(size) (1) /* unreasonable */
4479 Perl_init_stacks(pTHX)
4482 /* start with 128-item stack and 8K cxstack */
4483 PL_curstackinfo = new_stackinfo(REASONABLE(128),
4484 REASONABLE(8192/sizeof(PERL_CONTEXT) - 1));
4485 PL_curstackinfo->si_type = PERLSI_MAIN;
4486 PL_curstack = PL_curstackinfo->si_stack;
4487 PL_mainstack = PL_curstack; /* remember in case we switch stacks */
4489 PL_stack_base = AvARRAY(PL_curstack);
4490 PL_stack_sp = PL_stack_base;
4491 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
4493 Newx(PL_tmps_stack,REASONABLE(128),SV*);
4496 PL_tmps_max = REASONABLE(128);
4498 Newx(PL_markstack,REASONABLE(32),I32);
4499 PL_markstack_ptr = PL_markstack;
4500 PL_markstack_max = PL_markstack + REASONABLE(32);
4504 Newx(PL_scopestack,REASONABLE(32),I32);
4505 PL_scopestack_ix = 0;
4506 PL_scopestack_max = REASONABLE(32);
4508 Newx(PL_savestack,REASONABLE(128),ANY);
4509 PL_savestack_ix = 0;
4510 PL_savestack_max = REASONABLE(128);
4519 while (PL_curstackinfo->si_next)
4520 PL_curstackinfo = PL_curstackinfo->si_next;
4521 while (PL_curstackinfo) {
4522 PERL_SI *p = PL_curstackinfo->si_prev;
4523 /* curstackinfo->si_stack got nuked by sv_free_arenas() */
4524 Safefree(PL_curstackinfo->si_cxstack);
4525 Safefree(PL_curstackinfo);
4526 PL_curstackinfo = p;
4528 Safefree(PL_tmps_stack);
4529 Safefree(PL_markstack);
4530 Safefree(PL_scopestack);
4531 Safefree(PL_savestack);
4536 S_init_predump_symbols(pTHX)
4542 sv_setpvs(get_sv("\"", TRUE), " ");
4543 PL_ofsgv = (GV*)SvREFCNT_inc(gv_fetchpvs(",", GV_ADD|GV_NOTQUAL, SVt_PV));
4545 PL_stdingv = gv_fetchpvs("STDIN", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4546 GvMULTI_on(PL_stdingv);
4547 io = GvIOp(PL_stdingv);
4548 IoTYPE(io) = IoTYPE_RDONLY;
4549 IoIFP(io) = PerlIO_stdin();
4550 tmpgv = gv_fetchpvs("stdin", GV_ADD|GV_NOTQUAL, SVt_PV);
4552 GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4554 tmpgv = gv_fetchpvs("STDOUT", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4557 IoTYPE(io) = IoTYPE_WRONLY;
4558 IoOFP(io) = IoIFP(io) = PerlIO_stdout();
4560 tmpgv = gv_fetchpvs("stdout", GV_ADD|GV_NOTQUAL, SVt_PV);
4562 GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4564 PL_stderrgv = gv_fetchpvs("STDERR", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4565 GvMULTI_on(PL_stderrgv);
4566 io = GvIOp(PL_stderrgv);
4567 IoTYPE(io) = IoTYPE_WRONLY;
4568 IoOFP(io) = IoIFP(io) = PerlIO_stderr();
4569 tmpgv = gv_fetchpvs("stderr", GV_ADD|GV_NOTQUAL, SVt_PV);
4571 GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4573 PL_statname = newSV(0); /* last filename we did stat on */
4575 Safefree(PL_osname);
4576 PL_osname = savepv(OSNAME);
4580 Perl_init_argv_symbols(pTHX_ register int argc, register char **argv)
4584 PERL_ARGS_ASSERT_INIT_ARGV_SYMBOLS;
4586 argc--,argv++; /* skip name of script */
4587 if (PL_doswitches) {
4588 for (; argc > 0 && **argv == '-'; argc--,argv++) {
4592 if (argv[0][1] == '-' && !argv[0][2]) {
4596 if ((s = strchr(argv[0], '='))) {
4597 const char *const start_name = argv[0] + 1;
4598 sv_setpv(GvSV(gv_fetchpvn_flags(start_name, s - start_name,
4599 TRUE, SVt_PV)), s + 1);
4602 sv_setiv(GvSV(gv_fetchpv(argv[0]+1, GV_ADD, SVt_PV)),1);
4605 if ((PL_argvgv = gv_fetchpvs("ARGV", GV_ADD|GV_NOTQUAL, SVt_PVAV))) {
4606 GvMULTI_on(PL_argvgv);
4607 (void)gv_AVadd(PL_argvgv);
4608 av_clear(GvAVn(PL_argvgv));
4609 for (; argc > 0; argc--,argv++) {
4610 SV * const sv = newSVpv(argv[0],0);
4611 av_push(GvAVn(PL_argvgv),sv);
4612 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
4613 if (PL_unicode & PERL_UNICODE_ARGV_FLAG)
4616 if (PL_unicode & PERL_UNICODE_WIDESYSCALLS_FLAG) /* Sarathy? */
4617 (void)sv_utf8_decode(sv);
4623 S_init_postdump_symbols(pTHX_ register int argc, register char **argv, register char **env)
4628 PERL_ARGS_ASSERT_INIT_POSTDUMP_SYMBOLS;
4630 PL_toptarget = newSV_type(SVt_PVFM);
4631 sv_setpvs(PL_toptarget, "");
4632 PL_bodytarget = newSV_type(SVt_PVFM);
4633 sv_setpvs(PL_bodytarget, "");
4634 PL_formtarget = PL_bodytarget;
4638 init_argv_symbols(argc,argv);
4640 if ((tmpgv = gv_fetchpvs("0", GV_ADD|GV_NOTQUAL, SVt_PV))) {
4641 #ifdef MACOS_TRADITIONAL
4642 /* $0 is not majick on a Mac */
4643 sv_setpv(GvSV(tmpgv),MacPerl_MPWFileName(PL_origfilename));
4645 sv_setpv(GvSV(tmpgv),PL_origfilename);
4647 GV * const gv = gv_fetchpv("0", GV_ADD, SVt_PV);
4649 sv_magic(GvSV(gv), MUTABLE_SV(gv), PERL_MAGIC_sv, "0", 1);
4653 if ((PL_envgv = gv_fetchpvs("ENV", GV_ADD|GV_NOTQUAL, SVt_PVHV))) {
4655 bool env_is_not_environ;
4656 GvMULTI_on(PL_envgv);
4657 hv = GvHVn(PL_envgv);
4658 hv_magic(hv, NULL, PERL_MAGIC_env);
4660 #ifdef USE_ENVIRON_ARRAY
4661 /* Note that if the supplied env parameter is actually a copy
4662 of the global environ then it may now point to free'd memory
4663 if the environment has been modified since. To avoid this
4664 problem we treat env==NULL as meaning 'use the default'
4668 env_is_not_environ = env != environ;
4669 if (env_is_not_environ
4670 # ifdef USE_ITHREADS
4671 && PL_curinterp == aTHX
4680 for (; *env; env++) {
4683 if (!(s = strchr(old_var,'=')) || s == old_var)
4686 #if defined(MSDOS) && !defined(DJGPP)
4688 (void)strupr(old_var);
4691 sv = newSVpv(s+1, 0);
4692 (void)hv_store(hv, old_var, s - old_var, sv, 0);
4693 if (env_is_not_environ)
4697 #endif /* USE_ENVIRON_ARRAY */
4698 #endif /* !PERL_MICRO */
4701 if ((tmpgv = gv_fetchpvs("$", GV_ADD|GV_NOTQUAL, SVt_PV))) {
4702 SvREADONLY_off(GvSV(tmpgv));
4703 sv_setiv(GvSV(tmpgv), (IV)PerlProc_getpid());
4704 SvREADONLY_on(GvSV(tmpgv));
4706 #ifdef THREADS_HAVE_PIDS
4707 PL_ppid = (IV)getppid();
4710 /* touch @F array to prevent spurious warnings 20020415 MJD */
4712 (void) get_av("main::F", TRUE | GV_ADDMULTI);
4717 S_init_perllib(pTHX)
4723 s = PerlEnv_getenv("PERL5LIB");
4725 * It isn't possible to delete an environment variable with
4726 * PERL_USE_SAFE_PUTENV set unless unsetenv() is also available, so in that
4727 * case we treat PERL5LIB as undefined if it has a zero-length value.
4729 #if defined(PERL_USE_SAFE_PUTENV) && ! defined(HAS_UNSETENV)
4730 if (s && *s != '\0')
4734 incpush(s, TRUE, TRUE, TRUE, FALSE);
4736 incpush(PerlEnv_getenv("PERLLIB"), FALSE, FALSE, TRUE, FALSE);
4738 /* Treat PERL5?LIB as a possible search list logical name -- the
4739 * "natural" VMS idiom for a Unix path string. We allow each
4740 * element to be a set of |-separated directories for compatibility.
4744 if (my_trnlnm("PERL5LIB",buf,0))
4745 do { incpush(buf,TRUE,TRUE,TRUE,FALSE); } while (my_trnlnm("PERL5LIB",buf,++idx));
4747 while (my_trnlnm("PERLLIB",buf,idx++)) incpush(buf,FALSE,FALSE,TRUE,FALSE);
4751 /* Use the ~-expanded versions of APPLLIB (undocumented),
4752 ARCHLIB PRIVLIB SITEARCH SITELIB VENDORARCH and VENDORLIB
4755 incpush(APPLLIB_EXP, TRUE, TRUE, TRUE, TRUE);
4759 incpush(ARCHLIB_EXP, FALSE, FALSE, TRUE, TRUE);
4761 #ifdef MACOS_TRADITIONAL
4764 SV * privdir = newSV(0);
4765 char * macperl = PerlEnv_getenv("MACPERL");
4770 Perl_sv_setpvf(aTHX_ privdir, "%slib:", macperl);
4771 if (PerlLIO_stat(SvPVX(privdir), &tmpstatbuf) >= 0 && S_ISDIR(tmpstatbuf.st_mode))
4772 incpush(SvPVX(privdir), TRUE, FALSE, TRUE, FALSE);
4773 Perl_sv_setpvf(aTHX_ privdir, "%ssite_perl:", macperl);
4774 if (PerlLIO_stat(SvPVX(privdir), &tmpstatbuf) >= 0 && S_ISDIR(tmpstatbuf.st_mode))
4775 incpush(SvPVX(privdir), TRUE, FALSE, TRUE, FALSE);
4777 SvREFCNT_dec(privdir);
4780 incpush(":", FALSE, FALSE, TRUE, FALSE);
4783 # define PRIVLIB_EXP "/usr/local/lib/perl5:/usr/local/lib/perl"
4786 incpush(PRIVLIB_EXP, TRUE, FALSE, TRUE, TRUE);
4788 incpush(PRIVLIB_EXP, FALSE, FALSE, TRUE, TRUE);
4792 /* sitearch is always relative to sitelib on Windows for
4793 * DLL-based path intuition to work correctly */
4794 # if !defined(WIN32)
4795 incpush(SITEARCH_EXP, FALSE, FALSE, TRUE, TRUE);
4801 /* this picks up sitearch as well */
4802 incpush(SITELIB_EXP, TRUE, FALSE, TRUE, TRUE);
4804 incpush(SITELIB_EXP, FALSE, FALSE, TRUE, TRUE);
4808 #if defined(SITELIB_STEM) && defined(PERL_INC_VERSION_LIST)
4809 /* Search for version-specific dirs below here */
4810 incpush(SITELIB_STEM, FALSE, TRUE, TRUE, TRUE);
4813 #ifdef PERL_VENDORARCH_EXP
4814 /* vendorarch is always relative to vendorlib on Windows for
4815 * DLL-based path intuition to work correctly */
4816 # if !defined(WIN32)
4817 incpush(PERL_VENDORARCH_EXP, FALSE, FALSE, TRUE, TRUE);
4821 #ifdef PERL_VENDORLIB_EXP
4823 incpush(PERL_VENDORLIB_EXP, TRUE, FALSE, TRUE, TRUE); /* this picks up vendorarch as well */
4825 incpush(PERL_VENDORLIB_EXP, FALSE, FALSE, TRUE, TRUE);
4829 #if defined(PERL_VENDORLIB_STEM) && defined(PERL_INC_VERSION_LIST)
4830 /* Search for version-specific dirs below here */
4831 incpush(PERL_VENDORLIB_STEM, FALSE, TRUE, TRUE, TRUE);
4834 #ifdef PERL_OTHERLIBDIRS
4835 incpush(PERL_OTHERLIBDIRS, TRUE, TRUE, TRUE, TRUE);
4839 incpush(".", FALSE, FALSE, TRUE, FALSE);
4840 #endif /* MACOS_TRADITIONAL */
4843 #if defined(DOSISH) || defined(EPOC) || defined(__SYMBIAN32__)
4844 # define PERLLIB_SEP ';'
4847 # define PERLLIB_SEP '|'
4849 # if defined(MACOS_TRADITIONAL)
4850 # define PERLLIB_SEP ','
4852 # define PERLLIB_SEP ':'
4856 #ifndef PERLLIB_MANGLE
4857 # define PERLLIB_MANGLE(s,n) (s)
4860 /* Push a directory onto @INC if it exists.
4861 Generate a new SV if we do this, to save needing to copy the SV we push
4864 S_incpush_if_exists(pTHX_ SV *dir)
4869 PERL_ARGS_ASSERT_INCPUSH_IF_EXISTS;
4871 if (PerlLIO_stat(SvPVX_const(dir), &tmpstatbuf) >= 0 &&
4872 S_ISDIR(tmpstatbuf.st_mode)) {
4873 av_push(GvAVn(PL_incgv), dir);
4880 S_incpush(pTHX_ const char *dir, bool addsubdirs, bool addoldvers, bool usesep,
4885 const char *p = dir;
4890 if (addsubdirs || addoldvers) {
4894 /* Break at all separators */
4896 SV *libdir = newSV(0);
4899 /* skip any consecutive separators */
4901 while ( *p == PERLLIB_SEP ) {
4902 /* Uncomment the next line for PATH semantics */
4903 /* av_push(GvAVn(PL_incgv), newSVpvs(".")); */
4908 if ( usesep && (s = strchr(p, PERLLIB_SEP)) != NULL ) {
4909 sv_setpvn(libdir, PERLLIB_MANGLE(p, (STRLEN)(s - p)),
4914 sv_setpv(libdir, PERLLIB_MANGLE(p, 0));
4915 p = NULL; /* break out */
4917 #ifdef MACOS_TRADITIONAL
4918 if (!strchr(SvPVX(libdir), ':')) {
4921 sv_setpv(libdir, MacPerl_CanonDir(SvPVX(libdir), buf, 0));
4923 if (SvPVX(libdir)[SvCUR(libdir)-1] != ':')
4924 sv_catpvs(libdir, ":");
4927 /* Do the if() outside the #ifdef to avoid warnings about an unused
4930 #ifdef PERL_RELOCATABLE_INC
4932 * Relocatable include entries are marked with a leading .../
4935 * 0: Remove that leading ".../"
4936 * 1: Remove trailing executable name (anything after the last '/')
4937 * from the perl path to give a perl prefix
4939 * While the @INC element starts "../" and the prefix ends with a real
4940 * directory (ie not . or ..) chop that real directory off the prefix
4941 * and the leading "../" from the @INC element. ie a logical "../"
4943 * Finally concatenate the prefix and the remainder of the @INC element
4944 * The intent is that /usr/local/bin/perl and .../../lib/perl5
4945 * generates /usr/local/lib/perl5
4947 const char *libpath = SvPVX(libdir);
4948 STRLEN libpath_len = SvCUR(libdir);
4949 if (libpath_len >= 4 && memEQ (libpath, ".../", 4)) {
4951 SV * const caret_X = get_sv("\030", 0);
4952 /* Going to use the SV just as a scratch buffer holding a C
4958 /* $^X is *the* source of taint if tainting is on, hence
4959 SvPOK() won't be true. */
4961 assert(SvPOKp(caret_X));
4962 prefix_sv = newSVpvn_flags(SvPVX(caret_X), SvCUR(caret_X),
4964 /* Firstly take off the leading .../
4965 If all else fail we'll do the paths relative to the current
4967 sv_chop(libdir, libpath + 4);
4968 /* Don't use SvPV as we're intentionally bypassing taining,
4969 mortal copies that the mg_get of tainting creates, and
4970 corruption that seems to come via the save stack.
4971 I guess that the save stack isn't correctly set up yet. */
4972 libpath = SvPVX(libdir);
4973 libpath_len = SvCUR(libdir);
4975 /* This would work more efficiently with memrchr, but as it's
4976 only a GNU extension we'd need to probe for it and
4977 implement our own. Not hard, but maybe not worth it? */
4979 prefix = SvPVX(prefix_sv);
4980 lastslash = strrchr(prefix, '/');
4982 /* First time in with the *lastslash = '\0' we just wipe off
4983 the trailing /perl from (say) /usr/foo/bin/perl
4987 while ((*lastslash = '\0'), /* Do that, come what may. */
4988 (libpath_len >= 3 && memEQ(libpath, "../", 3)
4989 && (lastslash = strrchr(prefix, '/')))) {
4990 if (lastslash[1] == '\0'
4991 || (lastslash[1] == '.'
4992 && (lastslash[2] == '/' /* ends "/." */
4993 || (lastslash[2] == '/'
4994 && lastslash[3] == '/' /* or "/.." */
4996 /* Prefix ends "/" or "/." or "/..", any of which
4997 are fishy, so don't do any more logical cleanup.
5001 /* Remove leading "../" from path */
5004 /* Next iteration round the loop removes the last
5005 directory name from prefix by writing a '\0' in
5006 the while clause. */
5008 /* prefix has been terminated with a '\0' to the correct
5009 length. libpath points somewhere into the libdir SV.
5010 We need to join the 2 with '/' and drop the result into
5012 tempsv = Perl_newSVpvf(aTHX_ "%s/%s", prefix, libpath);
5013 SvREFCNT_dec(libdir);
5014 /* And this is the new libdir. */
5017 (PL_uid != PL_euid || PL_gid != PL_egid)) {
5018 /* Need to taint reloccated paths if running set ID */
5019 SvTAINTED_on(libdir);
5022 SvREFCNT_dec(prefix_sv);
5027 * BEFORE pushing libdir onto @INC we may first push version- and
5028 * archname-specific sub-directories.
5030 if (addsubdirs || addoldvers) {
5031 #ifdef PERL_INC_VERSION_LIST
5032 /* Configure terminates PERL_INC_VERSION_LIST with a NULL */
5033 const char * const incverlist[] = { PERL_INC_VERSION_LIST };
5034 const char * const *incver;
5040 if ((unix = tounixspec_ts(SvPV(libdir,len),NULL)) != NULL) {
5042 while (unix[len-1] == '/') len--; /* Cosmetic */
5043 sv_usepvn(libdir,unix,len);
5046 PerlIO_printf(Perl_error_log,
5047 "Failed to unixify @INC element \"%s\"\n",
5051 #ifdef MACOS_TRADITIONAL
5052 #define PERL_AV_SUFFIX_FMT ""
5053 #define PERL_ARCH_FMT "%s:"
5054 #define PERL_ARCH_FMT_PATH PERL_FS_VER_FMT PERL_AV_SUFFIX_FMT
5056 #define PERL_AV_SUFFIX_FMT "/"
5057 #define PERL_ARCH_FMT "/%s"
5058 #define PERL_ARCH_FMT_PATH PERL_AV_SUFFIX_FMT PERL_FS_VER_FMT
5060 /* .../version/archname if -d .../version/archname */
5061 Perl_sv_setpvf(aTHX_ subdir, "%"SVf PERL_ARCH_FMT_PATH PERL_ARCH_FMT,
5063 (int)PERL_REVISION, (int)PERL_VERSION,
5064 (int)PERL_SUBVERSION, ARCHNAME);
5065 subdir = S_incpush_if_exists(aTHX_ subdir);
5067 /* .../version if -d .../version */
5068 Perl_sv_setpvf(aTHX_ subdir, "%"SVf PERL_ARCH_FMT_PATH,
5070 (int)PERL_REVISION, (int)PERL_VERSION,
5071 (int)PERL_SUBVERSION);
5072 subdir = S_incpush_if_exists(aTHX_ subdir);
5074 /* .../archname if -d .../archname */
5075 Perl_sv_setpvf(aTHX_ subdir, "%"SVf PERL_ARCH_FMT,
5076 SVfARG(libdir), ARCHNAME);
5077 subdir = S_incpush_if_exists(aTHX_ subdir);
5081 #ifdef PERL_INC_VERSION_LIST
5083 for (incver = incverlist; *incver; incver++) {
5084 /* .../xxx if -d .../xxx */
5085 Perl_sv_setpvf(aTHX_ subdir, "%"SVf PERL_ARCH_FMT,
5086 SVfARG(libdir), *incver);
5087 subdir = S_incpush_if_exists(aTHX_ subdir);
5093 /* finally push this lib directory on the end of @INC */
5094 av_push(GvAVn(PL_incgv), libdir);
5097 assert (SvREFCNT(subdir) == 1);
5098 SvREFCNT_dec(subdir);
5104 Perl_call_list(pTHX_ I32 oldscope, AV *paramList)
5108 volatile const line_t oldline = PL_curcop ? CopLINE(PL_curcop) : 0;
5114 PERL_ARGS_ASSERT_CALL_LIST;
5116 while (av_len(paramList) >= 0) {
5117 cv = MUTABLE_CV(av_shift(paramList));
5119 if (paramList == PL_beginav) {
5120 /* save PL_beginav for compiler */
5121 Perl_av_create_and_push(aTHX_ &PL_beginav_save, MUTABLE_SV(cv));
5123 else if (paramList == PL_checkav) {
5124 /* save PL_checkav for compiler */
5125 Perl_av_create_and_push(aTHX_ &PL_checkav_save, MUTABLE_SV(cv));
5127 else if (paramList == PL_unitcheckav) {
5128 /* save PL_unitcheckav for compiler */
5129 Perl_av_create_and_push(aTHX_ &PL_unitcheckav_save, MUTABLE_SV(cv));
5140 PL_madskills |= 16384;
5145 PL_madskills &= ~16384;
5148 (void)SvPV_const(atsv, len);
5150 PL_curcop = &PL_compiling;
5151 CopLINE_set(PL_curcop, oldline);
5152 if (paramList == PL_beginav)
5153 sv_catpvs(atsv, "BEGIN failed--compilation aborted");
5155 Perl_sv_catpvf(aTHX_ atsv,
5156 "%s failed--call queue aborted",
5157 paramList == PL_checkav ? "CHECK"
5158 : paramList == PL_initav ? "INIT"
5159 : paramList == PL_unitcheckav ? "UNITCHECK"
5161 while (PL_scopestack_ix > oldscope)
5164 Perl_croak(aTHX_ "%"SVf"", SVfARG(atsv));
5171 /* my_exit() was called */
5172 while (PL_scopestack_ix > oldscope)
5175 PL_curstash = PL_defstash;
5176 PL_curcop = &PL_compiling;
5177 CopLINE_set(PL_curcop, oldline);
5179 if (PL_statusvalue && !(PL_exit_flags & PERL_EXIT_EXPECTED)) {
5180 if (paramList == PL_beginav)
5181 Perl_croak(aTHX_ "BEGIN failed--compilation aborted");
5183 Perl_croak(aTHX_ "%s failed--call queue aborted",
5184 paramList == PL_checkav ? "CHECK"
5185 : paramList == PL_initav ? "INIT"
5186 : paramList == PL_unitcheckav ? "UNITCHECK"
5193 PL_curcop = &PL_compiling;
5194 CopLINE_set(PL_curcop, oldline);
5197 PerlIO_printf(Perl_error_log, "panic: restartop\n");
5206 Perl_my_exit(pTHX_ U32 status)
5217 STATUS_EXIT_SET(status);
5224 Perl_my_failure_exit(pTHX)
5228 /* We have been called to fall on our sword. The desired exit code
5229 * should be already set in STATUS_UNIX, but could be shifted over
5230 * by 8 bits. STATUS_UNIX_EXIT_SET will handle the cases where a
5233 * If an error code has not been set, then force the issue.
5235 if (MY_POSIX_EXIT) {
5237 /* In POSIX_EXIT mode follow Perl documentations and use 255 for
5238 * the exit code when there isn't an error.
5241 if (STATUS_UNIX == 0)
5242 STATUS_UNIX_EXIT_SET(255);
5244 STATUS_UNIX_EXIT_SET(STATUS_UNIX);
5246 /* The exit code could have been set by $? or vmsish which
5247 * means that it may not be fatal. So convert
5248 * success/warning codes to fatal.
5250 if ((STATUS_NATIVE & (STS$K_SEVERE|STS$K_ERROR)) == 0)
5251 STATUS_UNIX_EXIT_SET(255);
5255 /* Traditionally Perl on VMS always expects a Fatal Error. */
5256 if (vaxc$errno & 1) {
5258 /* So force success status to failure */
5259 if (STATUS_NATIVE & 1)
5264 STATUS_UNIX = EINTR; /* In case something cares */
5269 STATUS_NATIVE = vaxc$errno; /* Should already be this */
5271 /* Encode the severity code */
5272 severity = STATUS_NATIVE & STS$M_SEVERITY;
5273 STATUS_UNIX = (severity ? severity : 1) << 8;
5275 /* Perl expects this to be a fatal error */
5276 if (severity != STS$K_SEVERE)
5285 STATUS_UNIX_SET(errno);
5287 exitstatus = STATUS_UNIX >> 8;
5288 if (exitstatus & 255)
5289 STATUS_UNIX_SET(exitstatus);
5291 STATUS_UNIX_SET(255);
5298 S_my_exit_jump(pTHX)
5303 SvREFCNT_dec(PL_e_script);
5307 POPSTACK_TO(PL_mainstack);
5315 read_e_script(pTHX_ int idx, SV *buf_sv, int maxlen)
5318 const char * const p = SvPVX_const(PL_e_script);
5319 const char *nl = strchr(p, '\n');
5321 PERL_UNUSED_ARG(idx);
5322 PERL_UNUSED_ARG(maxlen);
5324 nl = (nl) ? nl+1 : SvEND(PL_e_script);
5326 filter_del(read_e_script);
5329 sv_catpvn(buf_sv, p, nl-p);
5330 sv_chop(PL_e_script, nl);
5336 * c-indentation-style: bsd
5338 * indent-tabs-mode: t
5341 * ex: set ts=8 sts=4 sw=4 noet: