3 * Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007 by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
12 * "A ship then new they built for him/of mithril and of elven glass" --Bilbo
15 /* This file contains the top-level functions that are used to create, use
16 * and destroy a perl interpreter, plus the functions used by XS code to
17 * call back into perl. Note that it does not contain the actual main()
18 * function of the interpreter; that can be found in perlmain.c
23 * Be proud that perl(1) may proclaim:
24 * Setuid Perl scripts are safer than C programs ...
25 * Do not abandon (deprecate) suidperl. Do not advocate C wrappers.
27 * The flow was: perl starts, notices script is suid, execs suidperl with same
28 * arguments; suidperl opens script, checks many things, sets itself with
29 * right UID, execs perl with similar arguments but with script pre-opened on
30 * /dev/fd/xxx; perl checks script is as should be and does work. This was
31 * insecure: see perlsec(1) for many problems with this approach.
33 * The "correct" flow should be: perl starts, opens script and notices it is
34 * suid, checks many things, execs suidperl with similar arguments but with
35 * script on /dev/fd/xxx; suidperl checks script and /dev/fd/xxx object are
36 * same, checks arguments match #! line, sets itself with right UID, execs
37 * perl with same arguments; perl checks many things and does work.
39 * (Opening the script in perl instead of suidperl, we "lose" scripts that
40 * are readable to the target UID but not to the invoker. Where did
41 * unreadable scripts work anyway?)
43 * For now, suidperl and perl are pretty much the same large and cumbersome
44 * program, so suidperl can check its argument list (see comments elsewhere).
47 * Original bug report:
48 * http://bugs.perl.org/index.html?req=bug_id&bug_id=20010322.218
49 * http://rt.perl.org/rt2/Ticket/Display.html?id=6511
50 * Comments and discussion with Debian:
51 * http://bugs.debian.org/203426
52 * http://bugs.debian.org/220486
53 * Debian Security Advisory DSA 431-1 (does not fully fix problem):
54 * http://www.debian.org/security/2004/dsa-431
56 * http://cve.mitre.org/cgi-bin/cvename.cgi?name=CAN-2003-0618
57 * Previous versions of this patch sent to perl5-porters:
58 * http://www.mail-archive.com/perl5-porters@perl.org/msg71953.html
59 * http://www.mail-archive.com/perl5-porters@perl.org/msg75245.html
60 * http://www.mail-archive.com/perl5-porters@perl.org/msg75563.html
61 * http://www.mail-archive.com/perl5-porters@perl.org/msg75635.html
63 Paul Szabo - psz@maths.usyd.edu.au http://www.maths.usyd.edu.au:8000/u/psz/
64 School of Mathematics and Statistics University of Sydney 2006 Australia
68 * Use truthful, neat, specific error messages.
69 * Cannot always hide the truth; security must not depend on doing so.
73 * Use global(?), thread-local fdscript for easier checks.
74 * (I do not understand how we could possibly get a thread race:
75 * do not all threads go through the same initialization? Or in
76 * fact, are not threads started only after we get the script and
77 * so know what to do? Oh well, make things super-safe...)
81 #define PERL_IN_PERL_C
83 #include "patchlevel.h" /* for local_patches */
87 char *nw_get_sitelib(const char *pl);
90 /* XXX If this causes problems, set i_unistd=undef in the hint file. */
95 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
97 # include <sys/wait.h>
100 # include <sys/uio.h>
105 char control[CMSG_SPACE(sizeof(int))];
122 #if !defined(STANDARD_C) && !defined(HAS_GETENV_PROTOTYPE) && !defined(PERL_MICRO)
123 char *getenv (char *); /* Usually in <stdlib.h> */
126 static I32 read_e_script(pTHX_ int idx, SV *buf_sv, int maxlen);
134 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
140 #define CALL_BODY_EVAL(myop) \
141 if (PL_op == (myop)) \
142 PL_op = Perl_pp_entereval(aTHX); \
146 #define CALL_BODY_SUB(myop) \
147 if (PL_op == (myop)) \
148 PL_op = Perl_pp_entersub(aTHX); \
152 #define CALL_LIST_BODY(cv) \
153 PUSHMARK(PL_stack_sp); \
154 call_sv((SV*)(cv), G_EVAL|G_DISCARD);
157 S_init_tls_and_interp(PerlInterpreter *my_perl)
161 PERL_SET_INTERP(my_perl);
162 #if defined(USE_ITHREADS)
165 PERL_SET_THX(my_perl);
168 MUTEX_INIT(&PL_dollarzero_mutex);
170 #ifdef PERL_IMPLICIT_CONTEXT
171 MUTEX_INIT(&PL_my_ctx_mutex);
174 #if defined(USE_ITHREADS)
177 /* This always happens for non-ithreads */
180 PERL_SET_THX(my_perl);
185 /* these implement the PERL_SYS_INIT, PERL_SYS_INIT3, PERL_SYS_TERM macros */
188 Perl_sys_init(int* argc, char*** argv)
191 PERL_UNUSED_ARG(argc); /* may not be used depending on _BODY macro */
192 PERL_UNUSED_ARG(argv);
193 PERL_SYS_INIT_BODY(argc, argv);
197 Perl_sys_init3(int* argc, char*** argv, char*** env)
200 PERL_UNUSED_ARG(argc); /* may not be used depending on _BODY macro */
201 PERL_UNUSED_ARG(argv);
202 PERL_UNUSED_ARG(env);
203 PERL_SYS_INIT3_BODY(argc, argv, env);
210 if (!PL_veto_cleanup) {
211 PERL_SYS_TERM_BODY();
216 #ifdef PERL_IMPLICIT_SYS
218 perl_alloc_using(struct IPerlMem* ipM, struct IPerlMem* ipMS,
219 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
220 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
221 struct IPerlDir* ipD, struct IPerlSock* ipS,
222 struct IPerlProc* ipP)
224 PerlInterpreter *my_perl;
225 /* Newx() needs interpreter, so call malloc() instead */
226 my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
227 S_init_tls_and_interp(my_perl);
228 Zero(my_perl, 1, PerlInterpreter);
238 INIT_TRACK_MEMPOOL(PL_memory_debug_header, my_perl);
245 =head1 Embedding Functions
247 =for apidoc perl_alloc
249 Allocates a new Perl interpreter. See L<perlembed>.
257 PerlInterpreter *my_perl;
259 /* Newx() needs interpreter, so call malloc() instead */
260 my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
262 S_init_tls_and_interp(my_perl);
263 #ifndef PERL_TRACK_MEMPOOL
264 return (PerlInterpreter *) ZeroD(my_perl, 1, PerlInterpreter);
266 Zero(my_perl, 1, PerlInterpreter);
267 INIT_TRACK_MEMPOOL(PL_memory_debug_header, my_perl);
271 #endif /* PERL_IMPLICIT_SYS */
274 =for apidoc perl_construct
276 Initializes a new Perl interpreter. See L<perlembed>.
282 perl_construct(pTHXx)
285 PERL_UNUSED_ARG(my_perl);
288 PL_perl_destruct_level = 1;
290 if (PL_perl_destruct_level > 0)
293 PL_curcop = &PL_compiling; /* needed by ckWARN, right away */
295 /* set read-only and try to insure than we wont see REFCNT==0
298 SvREADONLY_on(&PL_sv_undef);
299 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
301 sv_setpv(&PL_sv_no,PL_No);
302 /* value lookup in void context - happens to have the side effect
303 of caching the numeric forms. However, as &PL_sv_no doesn't contain
304 a string that is a valid numer, we have to turn the public flags by
310 SvREADONLY_on(&PL_sv_no);
311 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
313 sv_setpv(&PL_sv_yes,PL_Yes);
316 SvREADONLY_on(&PL_sv_yes);
317 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
319 SvREADONLY_on(&PL_sv_placeholder);
320 SvREFCNT(&PL_sv_placeholder) = (~(U32)0)/2;
322 PL_sighandlerp = (Sighandler_t) Perl_sighandler;
323 #ifdef PERL_USES_PL_PIDSTATUS
324 PL_pidstatus = newHV();
327 PL_rs = newSVpvs("\n");
337 SET_NUMERIC_STANDARD();
339 #if defined(LOCAL_PATCH_COUNT)
340 PL_localpatches = local_patches; /* For possible -v */
343 #ifdef HAVE_INTERP_INTERN
347 PerlIO_init(aTHX); /* Hook to IO system */
349 PL_fdpid = newAV(); /* for remembering popen pids by fd */
350 PL_modglobal = newHV(); /* pointers to per-interpreter module globals */
351 PL_errors = newSVpvs("");
352 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
353 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
354 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
356 /* First entry is an array of empty elements */
357 Perl_av_create_and_push(aTHX_ &PL_regex_padav,(SV*)newAV());
358 PL_regex_pad = AvARRAY(PL_regex_padav);
360 #ifdef USE_REENTRANT_API
361 Perl_reentrant_init(aTHX);
364 /* Note that strtab is a rather special HV. Assumptions are made
365 about not iterating on it, and not adding tie magic to it.
366 It is properly deallocated in perl_destruct() */
369 HvSHAREKEYS_off(PL_strtab); /* mandatory */
370 hv_ksplit(PL_strtab, 512);
372 #if defined(__DYNAMIC__) && (defined(NeXT) || defined(__NeXT__))
373 _dyld_lookup_and_bind
374 ("__environ", (unsigned long *) &environ_pointer, NULL);
378 # ifdef USE_ENVIRON_ARRAY
379 PL_origenviron = environ;
383 /* Use sysconf(_SC_CLK_TCK) if available, if not
384 * available or if the sysconf() fails, use the HZ.
385 * BeOS has those, but returns the wrong value.
386 * The HZ if not originally defined has been by now
387 * been defined as CLK_TCK, if available. */
388 #if defined(HAS_SYSCONF) && defined(_SC_CLK_TCK) && !defined(__BEOS__)
389 PL_clocktick = sysconf(_SC_CLK_TCK);
390 if (PL_clocktick <= 0)
394 PL_stashcache = newHV();
396 PL_patchlevel = Perl_newSVpvf(aTHX_ "v%d.%d.%d", (int)PERL_REVISION,
397 (int)PERL_VERSION, (int)PERL_SUBVERSION);
400 if (!PL_mmap_page_size) {
401 #if defined(HAS_SYSCONF) && (defined(_SC_PAGESIZE) || defined(_SC_MMAP_PAGE_SIZE))
403 SETERRNO(0, SS_NORMAL);
405 PL_mmap_page_size = sysconf(_SC_PAGESIZE);
407 PL_mmap_page_size = sysconf(_SC_MMAP_PAGE_SIZE);
409 if ((long) PL_mmap_page_size < 0) {
411 SV * const error = ERRSV;
412 SvUPGRADE(error, SVt_PV);
413 Perl_croak(aTHX_ "panic: sysconf: %s", SvPV_nolen_const(error));
416 Perl_croak(aTHX_ "panic: sysconf: pagesize unknown");
420 # ifdef HAS_GETPAGESIZE
421 PL_mmap_page_size = getpagesize();
423 # if defined(I_SYS_PARAM) && defined(PAGESIZE)
424 PL_mmap_page_size = PAGESIZE; /* compiletime, bad */
428 if (PL_mmap_page_size <= 0)
429 Perl_croak(aTHX_ "panic: bad pagesize %" IVdf,
430 (IV) PL_mmap_page_size);
432 #endif /* HAS_MMAP */
434 #if defined(HAS_TIMES) && defined(PERL_NEED_TIMESBASE)
435 PL_timesbase.tms_utime = 0;
436 PL_timesbase.tms_stime = 0;
437 PL_timesbase.tms_cutime = 0;
438 PL_timesbase.tms_cstime = 0;
445 =for apidoc nothreadhook
447 Stub that provides thread hook for perl_destruct when there are
454 Perl_nothreadhook(pTHX)
460 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
462 Perl_dump_sv_child(pTHX_ SV *sv)
465 const int sock = PL_dumper_fd;
466 const int debug_fd = PerlIO_fileno(Perl_debug_log);
467 union control_un control;
470 struct cmsghdr *cmptr;
472 unsigned char buffer[256];
474 if(sock == -1 || debug_fd == -1)
477 PerlIO_flush(Perl_debug_log);
479 /* All these shenanigans are to pass a file descriptor over to our child for
480 it to dump out to. We can't let it hold open the file descriptor when it
481 forks, as the file descriptor it will dump to can turn out to be one end
482 of pipe that some other process will wait on for EOF. (So as it would
483 be open, the wait would be forever.) */
485 msg.msg_control = control.control;
486 msg.msg_controllen = sizeof(control.control);
487 /* We're a connected socket so we don't need a destination */
493 cmptr = CMSG_FIRSTHDR(&msg);
494 cmptr->cmsg_len = CMSG_LEN(sizeof(int));
495 cmptr->cmsg_level = SOL_SOCKET;
496 cmptr->cmsg_type = SCM_RIGHTS;
497 *((int *)CMSG_DATA(cmptr)) = 1;
499 vec[0].iov_base = (void*)&sv;
500 vec[0].iov_len = sizeof(sv);
501 got = sendmsg(sock, &msg, 0);
504 perror("Debug leaking scalars parent sendmsg failed");
507 if(got < sizeof(sv)) {
508 perror("Debug leaking scalars parent short sendmsg");
512 /* Return protocol is
514 unsigned char: length of location string (0 for empty)
515 unsigned char*: string (not terminated)
517 vec[0].iov_base = (void*)&returned_errno;
518 vec[0].iov_len = sizeof(returned_errno);
519 vec[1].iov_base = buffer;
522 got = readv(sock, vec, 2);
525 perror("Debug leaking scalars parent read failed");
526 PerlIO_flush(PerlIO_stderr());
529 if(got < sizeof(returned_errno) + 1) {
530 perror("Debug leaking scalars parent short read");
531 PerlIO_flush(PerlIO_stderr());
536 got = read(sock, buffer + 1, *buffer);
538 perror("Debug leaking scalars parent read 2 failed");
539 PerlIO_flush(PerlIO_stderr());
544 perror("Debug leaking scalars parent short read 2");
545 PerlIO_flush(PerlIO_stderr());
550 if (returned_errno || *buffer) {
551 Perl_warn(aTHX_ "Debug leaking scalars child failed%s%.*s with errno"
552 " %d: %s", (*buffer ? " at " : ""), (int) *buffer, buffer + 1,
553 returned_errno, strerror(returned_errno));
559 =for apidoc perl_destruct
561 Shuts down a Perl interpreter. See L<perlembed>.
570 VOL signed char destruct_level; /* see possible values in intrpvar.h */
572 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
576 PERL_UNUSED_ARG(my_perl);
578 /* wait for all pseudo-forked children to finish */
579 PERL_WAIT_FOR_CHILDREN;
581 destruct_level = PL_perl_destruct_level;
584 const char * const s = PerlEnv_getenv("PERL_DESTRUCT_LEVEL");
586 const int i = atoi(s);
587 if (destruct_level < i)
593 if (PL_exit_flags & PERL_EXIT_DESTRUCT_END) {
599 if (PL_endav && !PL_minus_c)
600 call_list(PL_scopestack_ix, PL_endav);
606 /* Need to flush since END blocks can produce output */
609 if (CALL_FPTR(PL_threadhook)(aTHX)) {
610 /* Threads hook has vetoed further cleanup */
611 PL_veto_cleanup = TRUE;
615 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
616 if (destruct_level != 0) {
617 /* Fork here to create a child. Our child's job is to preserve the
618 state of scalars prior to destruction, so that we can instruct it
619 to dump any scalars that we later find have leaked.
620 There's no subtlety in this code - it assumes POSIX, and it doesn't
624 if(socketpair(AF_UNIX, SOCK_STREAM, 0, fd)) {
625 perror("Debug leaking scalars socketpair failed");
631 perror("Debug leaking scalars fork failed");
635 /* We are the child */
636 const int sock = fd[1];
637 const int debug_fd = PerlIO_fileno(Perl_debug_log);
640 /* Our success message is an integer 0, and a char 0 */
641 static const char success[sizeof(int) + 1];
645 /* We need to close all other file descriptors otherwise we end up
646 with interesting hangs, where the parent closes its end of a
647 pipe, and sits waiting for (another) child to terminate. Only
648 that child never terminates, because it never gets EOF, because
649 we also have the far end of the pipe open. We even need to
650 close the debugging fd, because sometimes it happens to be one
651 end of a pipe, and a process is waiting on the other end for
652 EOF. Normally it would be closed at some point earlier in
653 destruction, but if we happen to cause the pipe to remain open,
654 EOF never occurs, and we get an infinite hang. Hence all the
655 games to pass in a file descriptor if it's actually needed. */
657 f = sysconf(_SC_OPEN_MAX);
659 where = "sysconf failed";
670 union control_un control;
673 struct cmsghdr *cmptr;
677 msg.msg_control = control.control;
678 msg.msg_controllen = sizeof(control.control);
679 /* We're a connected socket so we don't need a source */
683 msg.msg_iovlen = sizeof(vec)/sizeof(vec[0]);
685 vec[0].iov_base = (void*)⌖
686 vec[0].iov_len = sizeof(target);
688 got = recvmsg(sock, &msg, 0);
693 where = "recv failed";
696 if(got < sizeof(target)) {
697 where = "short recv";
701 if(!(cmptr = CMSG_FIRSTHDR(&msg))) {
705 if(cmptr->cmsg_len != CMSG_LEN(sizeof(int))) {
706 where = "wrong cmsg_len";
709 if(cmptr->cmsg_level != SOL_SOCKET) {
710 where = "wrong cmsg_level";
713 if(cmptr->cmsg_type != SCM_RIGHTS) {
714 where = "wrong cmsg_type";
718 got_fd = *(int*)CMSG_DATA(cmptr);
719 /* For our last little bit of trickery, put the file descriptor
720 back into Perl_debug_log, as if we never actually closed it
722 if(got_fd != debug_fd) {
723 if (dup2(got_fd, debug_fd) == -1) {
730 PerlIO_flush(Perl_debug_log);
732 got = write(sock, &success, sizeof(success));
735 where = "write failed";
738 if(got < sizeof(success)) {
739 where = "short write";
746 int send_errno = errno;
747 unsigned char length = (unsigned char) strlen(where);
748 struct iovec failure[3] = {
749 {(void*)&send_errno, sizeof(send_errno)},
751 {(void*)where, length}
753 int got = writev(sock, failure, 3);
754 /* Bad news travels fast. Faster than data. We'll get a SIGPIPE
755 in the parent if we try to read from the socketpair after the
756 child has exited, even if there was data to read.
757 So sleep a bit to give the parent a fighting chance of
760 _exit((got == -1) ? errno : 0);
764 PL_dumper_fd = fd[0];
769 /* We must account for everything. */
771 /* Destroy the main CV and syntax tree */
772 /* Do this now, because destroying ops can cause new SVs to be generated
773 in Perl_pad_swipe, and when running with -DDEBUG_LEAKING_SCALARS they
774 PL_curcop to point to a valid op from which the filename structure
776 PL_curcop = &PL_compiling;
778 /* ensure comppad/curpad to refer to main's pad */
779 if (CvPADLIST(PL_main_cv)) {
780 PAD_SET_CUR_NOSAVE(CvPADLIST(PL_main_cv), 1);
782 op_free(PL_main_root);
785 PL_main_start = NULL;
786 SvREFCNT_dec(PL_main_cv);
790 /* Tell PerlIO we are about to tear things apart in case
791 we have layers which are using resources that should
795 PerlIO_destruct(aTHX);
797 if (PL_sv_objcount) {
799 * Try to destruct global references. We do this first so that the
800 * destructors and destructees still exist. Some sv's might remain.
801 * Non-referenced objects are on their own.
805 if (PL_defoutgv && !SvREFCNT(PL_defoutgv))
806 PL_defoutgv = NULL; /* may have been freed */
809 /* unhook hooks which will soon be, or use, destroyed data */
810 SvREFCNT_dec(PL_warnhook);
812 SvREFCNT_dec(PL_diehook);
815 /* call exit list functions */
816 while (PL_exitlistlen-- > 0)
817 PL_exitlist[PL_exitlistlen].fn(aTHX_ PL_exitlist[PL_exitlistlen].ptr);
819 Safefree(PL_exitlist);
824 /* jettison our possibly duplicated environment */
825 /* if PERL_USE_SAFE_PUTENV is defined environ will not have been copied
826 * so we certainly shouldn't free it here
829 #if defined(USE_ENVIRON_ARRAY) && !defined(PERL_USE_SAFE_PUTENV)
830 if (environ != PL_origenviron && !PL_use_safe_putenv
832 /* only main thread can free environ[0] contents */
833 && PL_curinterp == aTHX
839 for (i = 0; environ[i]; i++)
840 safesysfree(environ[i]);
842 /* Must use safesysfree() when working with environ. */
843 safesysfree(environ);
845 environ = PL_origenviron;
848 #endif /* !PERL_MICRO */
850 if (destruct_level == 0) {
852 DEBUG_P(debprofdump());
854 #if defined(PERLIO_LAYERS)
855 /* No more IO - including error messages ! */
856 PerlIO_cleanup(aTHX);
859 CopFILE_free(&PL_compiling);
860 CopSTASH_free(&PL_compiling);
862 /* The exit() function will do everything that needs doing. */
866 /* reset so print() ends up where we expect */
870 /* the syntax tree is shared between clones
871 * so op_free(PL_main_root) only ReREFCNT_dec's
872 * REGEXPs in the parent interpreter
873 * we need to manually ReREFCNT_dec for the clones
875 SvREFCNT_dec(PL_regex_padav);
876 PL_regex_padav = NULL;
880 SvREFCNT_dec((SV*) PL_stashcache);
881 PL_stashcache = NULL;
883 /* loosen bonds of global variables */
885 /* XXX can PL_parser still be non-null here? */
886 if(PL_parser && PL_parser->rsfp) {
887 (void)PerlIO_close(PL_parser->rsfp);
888 PL_parser->rsfp = NULL;
892 Safefree(PL_splitstr);
897 PL_preprocess = FALSE;
903 PL_doswitches = FALSE;
904 PL_dowarn = G_WARN_OFF;
905 PL_doextract = FALSE;
906 PL_sawampersand = FALSE; /* must save all match strings */
909 Safefree(PL_inplace);
911 SvREFCNT_dec(PL_patchlevel);
914 SvREFCNT_dec(PL_e_script);
920 /* magical thingies */
922 SvREFCNT_dec(PL_ofs_sv); /* $, */
925 SvREFCNT_dec(PL_ors_sv); /* $\ */
928 SvREFCNT_dec(PL_rs); /* $/ */
931 Safefree(PL_osname); /* $^O */
934 SvREFCNT_dec(PL_statname);
938 /* defgv, aka *_ should be taken care of elsewhere */
940 /* clean up after study() */
941 SvREFCNT_dec(PL_lastscream);
942 PL_lastscream = NULL;
943 Safefree(PL_screamfirst);
945 Safefree(PL_screamnext);
949 Safefree(PL_efloatbuf);
953 /* startup and shutdown function lists */
954 SvREFCNT_dec(PL_beginav);
955 SvREFCNT_dec(PL_beginav_save);
956 SvREFCNT_dec(PL_endav);
957 SvREFCNT_dec(PL_checkav);
958 SvREFCNT_dec(PL_checkav_save);
959 SvREFCNT_dec(PL_unitcheckav);
960 SvREFCNT_dec(PL_unitcheckav_save);
961 SvREFCNT_dec(PL_initav);
963 PL_beginav_save = NULL;
966 PL_checkav_save = NULL;
967 PL_unitcheckav = NULL;
968 PL_unitcheckav_save = NULL;
971 /* shortcuts just get cleared */
980 PL_last_in_gv = NULL;
992 SvREFCNT_dec(PL_argvout_stack);
993 PL_argvout_stack = NULL;
995 SvREFCNT_dec(PL_modglobal);
997 SvREFCNT_dec(PL_preambleav);
998 PL_preambleav = NULL;
999 SvREFCNT_dec(PL_subname);
1001 #ifdef PERL_USES_PL_PIDSTATUS
1002 SvREFCNT_dec(PL_pidstatus);
1003 PL_pidstatus = NULL;
1005 SvREFCNT_dec(PL_toptarget);
1006 PL_toptarget = NULL;
1007 SvREFCNT_dec(PL_bodytarget);
1008 PL_bodytarget = NULL;
1009 PL_formtarget = NULL;
1011 /* free locale stuff */
1012 #ifdef USE_LOCALE_COLLATE
1013 Safefree(PL_collation_name);
1014 PL_collation_name = NULL;
1017 #ifdef USE_LOCALE_NUMERIC
1018 Safefree(PL_numeric_name);
1019 PL_numeric_name = NULL;
1020 SvREFCNT_dec(PL_numeric_radix_sv);
1021 PL_numeric_radix_sv = NULL;
1024 /* clear utf8 character classes */
1025 SvREFCNT_dec(PL_utf8_alnum);
1026 SvREFCNT_dec(PL_utf8_alnumc);
1027 SvREFCNT_dec(PL_utf8_ascii);
1028 SvREFCNT_dec(PL_utf8_alpha);
1029 SvREFCNT_dec(PL_utf8_space);
1030 SvREFCNT_dec(PL_utf8_cntrl);
1031 SvREFCNT_dec(PL_utf8_graph);
1032 SvREFCNT_dec(PL_utf8_digit);
1033 SvREFCNT_dec(PL_utf8_upper);
1034 SvREFCNT_dec(PL_utf8_lower);
1035 SvREFCNT_dec(PL_utf8_print);
1036 SvREFCNT_dec(PL_utf8_punct);
1037 SvREFCNT_dec(PL_utf8_xdigit);
1038 SvREFCNT_dec(PL_utf8_mark);
1039 SvREFCNT_dec(PL_utf8_toupper);
1040 SvREFCNT_dec(PL_utf8_totitle);
1041 SvREFCNT_dec(PL_utf8_tolower);
1042 SvREFCNT_dec(PL_utf8_tofold);
1043 SvREFCNT_dec(PL_utf8_idstart);
1044 SvREFCNT_dec(PL_utf8_idcont);
1045 PL_utf8_alnum = NULL;
1046 PL_utf8_alnumc = NULL;
1047 PL_utf8_ascii = NULL;
1048 PL_utf8_alpha = NULL;
1049 PL_utf8_space = NULL;
1050 PL_utf8_cntrl = NULL;
1051 PL_utf8_graph = NULL;
1052 PL_utf8_digit = NULL;
1053 PL_utf8_upper = NULL;
1054 PL_utf8_lower = NULL;
1055 PL_utf8_print = NULL;
1056 PL_utf8_punct = NULL;
1057 PL_utf8_xdigit = NULL;
1058 PL_utf8_mark = NULL;
1059 PL_utf8_toupper = NULL;
1060 PL_utf8_totitle = NULL;
1061 PL_utf8_tolower = NULL;
1062 PL_utf8_tofold = NULL;
1063 PL_utf8_idstart = NULL;
1064 PL_utf8_idcont = NULL;
1066 if (!specialWARN(PL_compiling.cop_warnings))
1067 PerlMemShared_free(PL_compiling.cop_warnings);
1068 PL_compiling.cop_warnings = NULL;
1069 Perl_refcounted_he_free(aTHX_ PL_compiling.cop_hints_hash);
1070 PL_compiling.cop_hints_hash = NULL;
1071 CopFILE_free(&PL_compiling);
1072 CopSTASH_free(&PL_compiling);
1074 /* Prepare to destruct main symbol table. */
1079 SvREFCNT_dec(PL_curstname);
1080 PL_curstname = NULL;
1082 /* clear queued errors */
1083 SvREFCNT_dec(PL_errors);
1086 SvREFCNT_dec(PL_isarev);
1089 if (destruct_level >= 2 && ckWARN_d(WARN_INTERNAL)) {
1090 if (PL_scopestack_ix != 0)
1091 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
1092 "Unbalanced scopes: %ld more ENTERs than LEAVEs\n",
1093 (long)PL_scopestack_ix);
1094 if (PL_savestack_ix != 0)
1095 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
1096 "Unbalanced saves: %ld more saves than restores\n",
1097 (long)PL_savestack_ix);
1098 if (PL_tmps_floor != -1)
1099 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced tmps: %ld more allocs than frees\n",
1100 (long)PL_tmps_floor + 1);
1101 if (cxstack_ix != -1)
1102 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced context: %ld more PUSHes than POPs\n",
1103 (long)cxstack_ix + 1);
1106 /* Now absolutely destruct everything, somehow or other, loops or no. */
1107 SvFLAGS(PL_fdpid) |= SVTYPEMASK; /* don't clean out pid table now */
1108 SvFLAGS(PL_strtab) |= SVTYPEMASK; /* don't clean out strtab now */
1110 /* the 2 is for PL_fdpid and PL_strtab */
1111 while (PL_sv_count > 2 && sv_clean_all())
1114 SvFLAGS(PL_fdpid) &= ~SVTYPEMASK;
1115 SvFLAGS(PL_fdpid) |= SVt_PVAV;
1116 SvFLAGS(PL_strtab) &= ~SVTYPEMASK;
1117 SvFLAGS(PL_strtab) |= SVt_PVHV;
1119 AvREAL_off(PL_fdpid); /* no surviving entries */
1120 SvREFCNT_dec(PL_fdpid); /* needed in io_close() */
1123 #ifdef HAVE_INTERP_INTERN
1127 /* Destruct the global string table. */
1129 /* Yell and reset the HeVAL() slots that are still holding refcounts,
1130 * so that sv_free() won't fail on them.
1131 * Now that the global string table is using a single hunk of memory
1132 * for both HE and HEK, we either need to explicitly unshare it the
1133 * correct way, or actually free things here.
1136 const I32 max = HvMAX(PL_strtab);
1137 HE * const * const array = HvARRAY(PL_strtab);
1138 HE *hent = array[0];
1141 if (hent && ckWARN_d(WARN_INTERNAL)) {
1142 HE * const next = HeNEXT(hent);
1143 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
1144 "Unbalanced string table refcount: (%ld) for \"%s\"",
1145 (long)hent->he_valu.hent_refcount, HeKEY(hent));
1152 hent = array[riter];
1157 HvARRAY(PL_strtab) = 0;
1158 HvTOTALKEYS(PL_strtab) = 0;
1159 HvFILL(PL_strtab) = 0;
1161 SvREFCNT_dec(PL_strtab);
1164 /* free the pointer tables used for cloning */
1165 ptr_table_free(PL_ptr_table);
1166 PL_ptr_table = (PTR_TBL_t*)NULL;
1169 /* free special SVs */
1171 SvREFCNT(&PL_sv_yes) = 0;
1172 sv_clear(&PL_sv_yes);
1173 SvANY(&PL_sv_yes) = NULL;
1174 SvFLAGS(&PL_sv_yes) = 0;
1176 SvREFCNT(&PL_sv_no) = 0;
1177 sv_clear(&PL_sv_no);
1178 SvANY(&PL_sv_no) = NULL;
1179 SvFLAGS(&PL_sv_no) = 0;
1183 for (i=0; i<=2; i++) {
1184 SvREFCNT(PERL_DEBUG_PAD(i)) = 0;
1185 sv_clear(PERL_DEBUG_PAD(i));
1186 SvANY(PERL_DEBUG_PAD(i)) = NULL;
1187 SvFLAGS(PERL_DEBUG_PAD(i)) = 0;
1191 if (PL_sv_count != 0 && ckWARN_d(WARN_INTERNAL))
1192 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Scalars leaked: %ld\n", (long)PL_sv_count);
1194 #ifdef DEBUG_LEAKING_SCALARS
1195 if (PL_sv_count != 0) {
1200 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
1201 svend = &sva[SvREFCNT(sva)];
1202 for (sv = sva + 1; sv < svend; ++sv) {
1203 if (SvTYPE(sv) != SVTYPEMASK) {
1204 PerlIO_printf(Perl_debug_log, "leaked: sv=0x%p"
1206 " refcnt=%"UVuf pTHX__FORMAT "\n"
1207 "\tallocated at %s:%d %s %s%s\n",
1208 (void*)sv, (UV)sv->sv_flags, (UV)sv->sv_refcnt
1210 sv->sv_debug_file ? sv->sv_debug_file : "(unknown)",
1212 sv->sv_debug_inpad ? "for" : "by",
1213 sv->sv_debug_optype ?
1214 PL_op_name[sv->sv_debug_optype]: "(none)",
1215 sv->sv_debug_cloned ? " (cloned)" : ""
1217 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1218 Perl_dump_sv_child(aTHX_ sv);
1224 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1228 /* Wait for up to 4 seconds for child to terminate.
1229 This seems to be the least effort way of timing out on reaping
1231 struct timeval waitfor = {4, 0};
1232 int sock = PL_dumper_fd;
1236 FD_SET(sock, &rset);
1237 select(sock + 1, &rset, NULL, NULL, &waitfor);
1238 waitpid(child, &status, WNOHANG);
1243 #ifdef DEBUG_LEAKING_SCALARS_ABORT
1249 #ifdef PERL_DEBUG_READONLY_OPS
1255 #if defined(PERLIO_LAYERS)
1256 /* No more IO - including error messages ! */
1257 PerlIO_cleanup(aTHX);
1260 /* sv_undef needs to stay immortal until after PerlIO_cleanup
1261 as currently layers use it rather than NULL as a marker
1262 for no arg - and will try and SvREFCNT_dec it.
1264 SvREFCNT(&PL_sv_undef) = 0;
1265 SvREADONLY_off(&PL_sv_undef);
1267 Safefree(PL_origfilename);
1268 PL_origfilename = NULL;
1269 Safefree(PL_reg_start_tmp);
1270 PL_reg_start_tmp = (char**)NULL;
1271 PL_reg_start_tmpl = 0;
1272 Safefree(PL_reg_curpm);
1273 Safefree(PL_reg_poscache);
1274 free_tied_hv_pool();
1275 Safefree(PL_op_mask);
1276 Safefree(PL_psig_ptr);
1277 PL_psig_ptr = (SV**)NULL;
1278 Safefree(PL_psig_name);
1279 PL_psig_name = (SV**)NULL;
1280 Safefree(PL_bitcount);
1282 Safefree(PL_psig_pend);
1283 PL_psig_pend = (int*)NULL;
1286 PL_tainting = FALSE;
1287 PL_taint_warn = FALSE;
1288 PL_hints = 0; /* Reset hints. Should hints be per-interpreter ? */
1291 DEBUG_P(debprofdump());
1293 #ifdef USE_REENTRANT_API
1294 Perl_reentrant_free(aTHX);
1299 while (PL_regmatch_slab) {
1300 regmatch_slab *s = PL_regmatch_slab;
1301 PL_regmatch_slab = PL_regmatch_slab->next;
1305 /* As the absolutely last thing, free the non-arena SV for mess() */
1308 /* we know that type == SVt_PVMG */
1310 /* it could have accumulated taint magic */
1313 for (mg = SvMAGIC(PL_mess_sv); mg; mg = moremagic) {
1314 moremagic = mg->mg_moremagic;
1315 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global
1317 Safefree(mg->mg_ptr);
1321 /* we know that type >= SVt_PV */
1322 SvPV_free(PL_mess_sv);
1323 Safefree(SvANY(PL_mess_sv));
1324 Safefree(PL_mess_sv);
1331 =for apidoc perl_free
1333 Releases a Perl interpreter. See L<perlembed>.
1343 if (PL_veto_cleanup)
1346 #ifdef PERL_TRACK_MEMPOOL
1349 * Don't free thread memory if PERL_DESTRUCT_LEVEL is set to a non-zero
1350 * value as we're probably hunting memory leaks then
1352 const char * const s = PerlEnv_getenv("PERL_DESTRUCT_LEVEL");
1353 if (!s || atoi(s) == 0) {
1354 /* Emulate the PerlHost behaviour of free()ing all memory allocated in this
1355 thread at thread exit. */
1356 while(aTHXx->Imemory_debug_header.next != &(aTHXx->Imemory_debug_header))
1357 safesysfree(sTHX + (char *)(aTHXx->Imemory_debug_header.next));
1362 #if defined(WIN32) || defined(NETWARE)
1363 # if defined(PERL_IMPLICIT_SYS)
1366 void *host = nw_internal_host;
1368 void *host = w32_internal_host;
1370 PerlMem_free(aTHXx);
1372 nw_delete_internal_host(host);
1374 win32_delete_internal_host(host);
1378 PerlMem_free(aTHXx);
1381 PerlMem_free(aTHXx);
1385 #if defined(USE_ITHREADS)
1386 /* provide destructors to clean up the thread key when libperl is unloaded */
1387 #ifndef WIN32 /* handled during DLL_PROCESS_DETACH in win32/perllib.c */
1389 #if defined(__hpux) && !(defined(__ux_version) && __ux_version <= 1020) && !defined(__GNUC__)
1390 #pragma fini "perl_fini"
1391 #elif defined(__sun) && !defined(__GNUC__)
1392 #pragma fini (perl_fini)
1396 #if defined(__GNUC__)
1397 __attribute__((destructor))
1402 if (PL_curinterp && !PL_veto_cleanup)
1407 #endif /* THREADS */
1410 Perl_call_atexit(pTHX_ ATEXIT_t fn, void *ptr)
1413 Renew(PL_exitlist, PL_exitlistlen+1, PerlExitListEntry);
1414 PL_exitlist[PL_exitlistlen].fn = fn;
1415 PL_exitlist[PL_exitlistlen].ptr = ptr;
1419 #ifdef HAS_PROCSELFEXE
1420 /* This is a function so that we don't hold on to MAXPATHLEN
1421 bytes of stack longer than necessary
1424 S_procself_val(pTHX_ SV *sv, const char *arg0)
1426 char buf[MAXPATHLEN];
1427 int len = readlink(PROCSELFEXE_PATH, buf, sizeof(buf) - 1);
1429 /* On Playstation2 Linux V1.0 (kernel 2.2.1) readlink(/proc/self/exe)
1430 includes a spurious NUL which will cause $^X to fail in system
1431 or backticks (this will prevent extensions from being built and
1432 many tests from working). readlink is not meant to add a NUL.
1433 Normal readlink works fine.
1435 if (len > 0 && buf[len-1] == '\0') {
1439 /* FreeBSD's implementation is acknowledged to be imperfect, sometimes
1440 returning the text "unknown" from the readlink rather than the path
1441 to the executable (or returning an error from the readlink). Any valid
1442 path has a '/' in it somewhere, so use that to validate the result.
1443 See http://www.freebsd.org/cgi/query-pr.cgi?pr=35703
1445 if (len > 0 && memchr(buf, '/', len)) {
1446 sv_setpvn(sv,buf,len);
1452 #endif /* HAS_PROCSELFEXE */
1455 S_set_caret_X(pTHX) {
1457 GV* tmpgv = gv_fetchpvs("\030", GV_ADD|GV_NOTQUAL, SVt_PV); /* $^X */
1459 #ifdef HAS_PROCSELFEXE
1460 S_procself_val(aTHX_ GvSV(tmpgv), PL_origargv[0]);
1463 sv_setpv(GvSVn(tmpgv), os2_execname(aTHX));
1465 sv_setpv(GvSVn(tmpgv),PL_origargv[0]);
1472 =for apidoc perl_parse
1474 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
1480 perl_parse(pTHXx_ XSINIT_t xsinit, int argc, char **argv, char **env)
1487 PERL_UNUSED_ARG(my_perl);
1489 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
1492 Perl_croak(aTHX_ "suidperl is no longer needed since the kernel can now execute\n\
1493 setuid perl scripts securely.\n");
1494 #endif /* IAMSUID */
1497 #if defined(USE_HASH_SEED) || defined(USE_HASH_SEED_EXPLICIT)
1498 /* [perl #22371] Algorimic Complexity Attack on Perl 5.6.1, 5.8.0
1499 * This MUST be done before any hash stores or fetches take place.
1500 * If you set PL_rehash_seed (and assumedly also PL_rehash_seed_set)
1501 * yourself, it is your responsibility to provide a good random seed!
1502 * You can also define PERL_HASH_SEED in compile time, see hv.h. */
1503 if (!PL_rehash_seed_set)
1504 PL_rehash_seed = get_hash_seed();
1506 const char * const s = PerlEnv_getenv("PERL_HASH_SEED_DEBUG");
1508 if (s && (atoi(s) == 1))
1509 PerlIO_printf(Perl_debug_log, "HASH_SEED = %"UVuf"\n", PL_rehash_seed);
1511 #endif /* #if defined(USE_HASH_SEED) || defined(USE_HASH_SEED_EXPLICIT) */
1516 if (PL_origalen != 0) {
1517 PL_origalen = 1; /* don't use old PL_origalen if perl_parse() is called again */
1520 /* Set PL_origalen be the sum of the contiguous argv[]
1521 * elements plus the size of the env in case that it is
1522 * contiguous with the argv[]. This is used in mg.c:Perl_magic_set()
1523 * as the maximum modifiable length of $0. In the worst case
1524 * the area we are able to modify is limited to the size of
1525 * the original argv[0]. (See below for 'contiguous', though.)
1527 const char *s = NULL;
1530 ~(UV)(PTRSIZE == 4 ? 3 : PTRSIZE == 8 ? 7 : PTRSIZE == 16 ? 15 : 0);
1531 /* Do the mask check only if the args seem like aligned. */
1533 (mask < ~(UV)0) && ((PTR2UV(argv[0]) & mask) == PTR2UV(argv[0]));
1535 /* See if all the arguments are contiguous in memory. Note
1536 * that 'contiguous' is a loose term because some platforms
1537 * align the argv[] and the envp[]. If the arguments look
1538 * like non-aligned, assume that they are 'strictly' or
1539 * 'traditionally' contiguous. If the arguments look like
1540 * aligned, we just check that they are within aligned
1541 * PTRSIZE bytes. As long as no system has something bizarre
1542 * like the argv[] interleaved with some other data, we are
1543 * fine. (Did I just evoke Murphy's Law?) --jhi */
1544 if (PL_origargv && PL_origargc >= 1 && (s = PL_origargv[0])) {
1546 for (i = 1; i < PL_origargc; i++) {
1547 if ((PL_origargv[i] == s + 1
1549 || PL_origargv[i] == s + 2
1554 (PL_origargv[i] > s &&
1556 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1567 #ifndef PERL_USE_SAFE_PUTENV
1568 /* Can we grab env area too to be used as the area for $0? */
1569 if (s && PL_origenviron && !PL_use_safe_putenv) {
1570 if ((PL_origenviron[0] == s + 1)
1573 (PL_origenviron[0] > s &&
1574 PL_origenviron[0] <=
1575 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1578 #ifndef OS2 /* ENVIRON is read by the kernel too. */
1579 s = PL_origenviron[0];
1582 my_setenv("NoNe SuCh", NULL);
1583 /* Force copy of environment. */
1584 for (i = 1; PL_origenviron[i]; i++) {
1585 if (PL_origenviron[i] == s + 1
1588 (PL_origenviron[i] > s &&
1589 PL_origenviron[i] <=
1590 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1593 s = PL_origenviron[i];
1601 #endif /* !defined(PERL_USE_SAFE_PUTENV) */
1603 PL_origalen = s ? s - PL_origargv[0] + 1 : 0;
1608 /* Come here if running an undumped a.out. */
1610 PL_origfilename = savepv(argv[0]);
1611 PL_do_undump = FALSE;
1612 cxstack_ix = -1; /* start label stack again */
1614 assert (!PL_tainted);
1616 S_set_caret_X(aTHX);
1618 init_postdump_symbols(argc,argv,env);
1623 op_free(PL_main_root);
1624 PL_main_root = NULL;
1626 PL_main_start = NULL;
1627 SvREFCNT_dec(PL_main_cv);
1631 oldscope = PL_scopestack_ix;
1632 PL_dowarn = G_WARN_OFF;
1637 parse_body(env,xsinit);
1639 call_list(oldscope, PL_unitcheckav);
1641 call_list(oldscope, PL_checkav);
1648 /* my_exit() was called */
1649 while (PL_scopestack_ix > oldscope)
1652 PL_curstash = PL_defstash;
1654 call_list(oldscope, PL_unitcheckav);
1656 call_list(oldscope, PL_checkav);
1660 PerlIO_printf(Perl_error_log, "panic: top_env\n");
1669 S_parse_body(pTHX_ char **env, XSINIT_t xsinit)
1673 int argc = PL_origargc;
1674 char **argv = PL_origargv;
1675 const char *scriptname = NULL;
1676 VOL bool dosearch = FALSE;
1677 const char *validarg = "";
1680 const char *cddir = NULL;
1681 #ifdef USE_SITECUSTOMIZE
1682 bool minus_f = FALSE;
1684 SV *linestr_sv = newSV_type(SVt_PVIV);
1685 bool add_read_e_script = FALSE;
1687 SvGROW(linestr_sv, 80);
1688 sv_setpvn(linestr_sv,"",0);
1690 sv = newSVpvs(""); /* first used for -I flags */
1696 for (argc--,argv++; argc > 0; argc--,argv++) {
1697 if (argv[0][0] != '-' || !argv[0][1])
1701 validarg = " PHOOEY ";
1705 * Can we rely on the kernel to start scripts with argv[1] set to
1706 * contain all #! line switches (the whole line)? (argv[0] is set to
1707 * the interpreter name, argv[2] to the script name; argv[3] and
1708 * above may contain other arguments.)
1715 #ifndef PERL_STRICT_CR
1739 if ((s = moreswitches(s)))
1744 CHECK_MALLOC_TOO_LATE_FOR('t');
1745 if( !PL_tainting ) {
1746 PL_taint_warn = TRUE;
1752 CHECK_MALLOC_TOO_LATE_FOR('T');
1754 PL_taint_warn = FALSE;
1762 #ifdef MACOS_TRADITIONAL
1763 /* ignore -e for Dev:Pseudo argument */
1764 if (argv[1] && !strcmp(argv[1], "Dev:Pseudo"))
1767 forbid_setid('e', -1);
1769 PL_e_script = newSVpvs("");
1770 add_read_e_script = TRUE;
1773 sv_catpv(PL_e_script, s);
1775 sv_catpv(PL_e_script, argv[1]);
1779 Perl_croak(aTHX_ "No code specified for -%c", c);
1780 sv_catpvs(PL_e_script, "\n");
1784 #ifdef USE_SITECUSTOMIZE
1790 case 'I': /* -I handled both here and in moreswitches() */
1791 forbid_setid('I', -1);
1792 if (!*++s && (s=argv[1]) != NULL) {
1796 STRLEN len = strlen(s);
1797 const char * const p = savepvn(s, len);
1798 incpush(p, TRUE, TRUE, FALSE, FALSE);
1799 sv_catpvs(sv, "-I");
1800 sv_catpvn(sv, p, len);
1805 Perl_croak(aTHX_ "No directory specified for -I");
1808 forbid_setid('P', -1);
1809 PL_preprocess = TRUE;
1814 forbid_setid('S', -1);
1822 Perl_av_create_and_push(aTHX_ &PL_preambleav, newSVpvs("use Config;"));
1824 /* Can't do newSVpvs() as that would involve pre-processor
1825 condititionals inside a macro expansion. */
1826 opts_prog = Perl_newSVpv(aTHX_ "$_ = join ' ', sort qw("
1833 # ifdef PERL_DONT_CREATE_GVSV
1834 " PERL_DONT_CREATE_GVSV"
1836 # ifdef PERL_MALLOC_WRAP
1839 # ifdef PERL_MEM_LOG
1842 # ifdef PERL_MEM_LOG_ENV
1845 # ifdef PERL_MEM_LOG_ENV_FD
1846 " PERL_MEM_LOG_ENV_FD"
1848 # ifdef PERL_MEM_LOG_STDERR
1849 " PERL_MEM_LOG_STDERR"
1851 # ifdef PERL_MEM_LOG_TIMESTAMP
1852 " PERL_MEM_LOG_TIMESTAMP"
1854 # ifdef PERL_USE_SAFE_PUTENV
1855 " PERL_USE_SAFE_PUTENV"
1857 # ifdef USE_SITECUSTOMIZE
1858 " USE_SITECUSTOMIZE"
1862 sv_catpv(opts_prog, PL_bincompat_options);
1863 /* Terminate the qw(, and then wrap at 76 columns. */
1864 sv_catpvs(opts_prog, "); s/(?=.{53})(.{1,53}) /$1\\n /mg;print Config::myconfig(),");
1866 sv_catpvs(opts_prog,"\"\\nCharacteristics of this PERLSHR image: \\n");
1868 sv_catpvs(opts_prog,"\"\\nCharacteristics of this binary (from libperl): \\n");
1871 sv_catpvs(opts_prog," Compile-time options: $_\\n\",");
1873 #if defined(LOCAL_PATCH_COUNT)
1874 if (LOCAL_PATCH_COUNT > 0) {
1876 sv_catpvs(opts_prog,
1877 "\" Locally applied patches:\\n\",");
1878 for (i = 1; i <= LOCAL_PATCH_COUNT; i++) {
1879 if (PL_localpatches[i])
1880 Perl_sv_catpvf(aTHX_ opts_prog,"q%c\t%s\n%c,",
1881 0, PL_localpatches[i], 0);
1885 Perl_sv_catpvf(aTHX_ opts_prog,
1886 "\" Built under %s\\n",OSNAME);
1889 Perl_sv_catpvf(aTHX_ opts_prog,
1890 " Compiled at %s %s\\n\"",__DATE__,
1893 Perl_sv_catpvf(aTHX_ opts_prog," Compiled on %s\\n\"",
1897 sv_catpvs(opts_prog, "; $\"=\"\\n \"; "
1898 "@env = map { \"$_=\\\"$ENV{$_}\\\"\" } "
1899 "sort grep {/^PERL/} keys %ENV; ");
1901 sv_catpvs(opts_prog,
1902 "push @env, \"CYGWIN=\\\"$ENV{CYGWIN}\\\"\";");
1904 sv_catpvs(opts_prog,
1905 "print \" \\%ENV:\\n @env\\n\" if @env;"
1906 "print \" \\@INC:\\n @INC\\n\";");
1910 opts_prog = Perl_newSVpvf(aTHX_
1911 "Config::config_vars(qw%c%s%c)",
1915 av_push(PL_preambleav, opts_prog);
1916 /* don't look for script or read stdin */
1917 scriptname = BIT_BUCKET;
1921 PL_doextract = TRUE;
1929 if (!*++s || isSPACE(*s)) {
1933 /* catch use of gnu style long options */
1934 if (strEQ(s, "version")) {
1938 if (strEQ(s, "help")) {
1945 Perl_croak(aTHX_ "Unrecognized switch: -%s (-h will show valid options)",s);
1956 #ifndef SECURE_INTERNAL_GETENV
1959 (s = PerlEnv_getenv("PERL5OPT")))
1961 const char *popt = s;
1964 if (*s == '-' && *(s+1) == 'T') {
1965 CHECK_MALLOC_TOO_LATE_FOR('T');
1967 PL_taint_warn = FALSE;
1970 char *popt_copy = NULL;
1983 if (!strchr("CDIMUdmtw", *s))
1984 Perl_croak(aTHX_ "Illegal switch in PERL5OPT: -%c", *s);
1988 popt_copy = SvPVX(sv_2mortal(newSVpv(popt,0)));
1989 s = popt_copy + (s - popt);
1990 d = popt_copy + (d - popt);
1997 if( !PL_tainting ) {
1998 PL_taint_warn = TRUE;
2009 #ifdef USE_SITECUSTOMIZE
2011 (void)Perl_av_create_and_unshift_one(aTHX_ &PL_preambleav,
2012 Perl_newSVpvf(aTHX_ "BEGIN { do '%s/sitecustomize.pl' }", SITELIB_EXP));
2017 scriptname = argv[0];
2020 scriptname = BIT_BUCKET; /* don't look for script or read stdin */
2022 else if (scriptname == NULL) {
2024 if ( PerlLIO_isatty(PerlIO_fileno(PerlIO_stdin())) )
2030 /* Set $^X early so that it can be used for relocatable paths in @INC */
2031 assert (!PL_tainted);
2033 S_set_caret_X(aTHX);
2040 = open_script(scriptname, dosearch, sv, &suidscript, &rsfp);
2042 validate_suid(validarg, scriptname, fdscript, suidscript,
2046 # if defined(SIGCHLD) || defined(SIGCLD)
2049 # define SIGCHLD SIGCLD
2051 Sighandler_t sigstate = rsignal_state(SIGCHLD);
2052 if (sigstate == (Sighandler_t) SIG_IGN) {
2053 if (ckWARN(WARN_SIGNAL))
2054 Perl_warner(aTHX_ packWARN(WARN_SIGNAL),
2055 "Can't ignore signal CHLD, forcing to default");
2056 (void)rsignal(SIGCHLD, (Sighandler_t)SIG_DFL);
2063 #ifdef MACOS_TRADITIONAL
2064 || gMacPerl_AlwaysExtract
2068 /* This will croak if suidscript is >= 0, as -x cannot be used with
2070 forbid_setid('x', suidscript);
2071 /* Hence you can't get here if suidscript >= 0 */
2073 find_beginning(linestr_sv, rsfp);
2074 if (cddir && PerlDir_chdir( (char *)cddir ) < 0)
2075 Perl_croak(aTHX_ "Can't chdir to %s",cddir);
2079 PL_main_cv = PL_compcv = (CV*)newSV_type(SVt_PVCV);
2080 CvUNIQUE_on(PL_compcv);
2082 CvPADLIST(PL_compcv) = pad_new(0);
2084 PL_isarev = newHV();
2087 boot_core_UNIVERSAL();
2088 boot_core_xsutils();
2092 (*xsinit)(aTHX); /* in case linked C routines want magical variables */
2094 #if defined(VMS) || defined(WIN32) || defined(DJGPP) || defined(__CYGWIN__) || defined(EPOC) || defined(SYMBIAN)
2100 # ifdef HAS_SOCKS5_INIT
2101 socks5_init(argv[0]);
2107 init_predump_symbols();
2108 /* init_postdump_symbols not currently designed to be called */
2109 /* more than once (ENV isn't cleared first, for example) */
2110 /* But running with -u leaves %ENV & @ARGV undefined! XXX */
2112 init_postdump_symbols(argc,argv,env);
2114 /* PL_unicode is turned on by -C, or by $ENV{PERL_UNICODE},
2115 * or explicitly in some platforms.
2116 * locale.c:Perl_init_i18nl10n() if the environment
2117 * look like the user wants to use UTF-8. */
2118 #if defined(__SYMBIAN32__)
2119 PL_unicode = PERL_UNICODE_STD_FLAG; /* See PERL_SYMBIAN_CONSOLE_UTF8. */
2122 /* Requires init_predump_symbols(). */
2123 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
2128 /* Turn on UTF-8-ness on STDIN, STDOUT, STDERR
2129 * and the default open disciplines. */
2130 if ((PL_unicode & PERL_UNICODE_STDIN_FLAG) &&
2131 PL_stdingv && (io = GvIO(PL_stdingv)) &&
2133 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2134 if ((PL_unicode & PERL_UNICODE_STDOUT_FLAG) &&
2135 PL_defoutgv && (io = GvIO(PL_defoutgv)) &&
2137 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2138 if ((PL_unicode & PERL_UNICODE_STDERR_FLAG) &&
2139 PL_stderrgv && (io = GvIO(PL_stderrgv)) &&
2141 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2142 if ((PL_unicode & PERL_UNICODE_INOUT_FLAG) &&
2143 (sv = GvSV(gv_fetchpvs("\017PEN", GV_ADD|GV_NOTQUAL,
2145 U32 in = PL_unicode & PERL_UNICODE_IN_FLAG;
2146 U32 out = PL_unicode & PERL_UNICODE_OUT_FLAG;
2149 sv_setpvn(sv, ":utf8\0:utf8", 11);
2151 sv_setpvn(sv, ":utf8\0", 6);
2154 sv_setpvn(sv, "\0:utf8", 6);
2162 if ((s = PerlEnv_getenv("PERL_SIGNALS"))) {
2163 if (strEQ(s, "unsafe"))
2164 PL_signals |= PERL_SIGNALS_UNSAFE_FLAG;
2165 else if (strEQ(s, "safe"))
2166 PL_signals &= ~PERL_SIGNALS_UNSAFE_FLAG;
2168 Perl_croak(aTHX_ "PERL_SIGNALS illegal: \"%s\"", s);
2175 if ((s = PerlEnv_getenv("PERL_XMLDUMP"))) {
2179 PL_xmlfp = PerlIO_stdout();
2181 PL_xmlfp = PerlIO_open(s, "w");
2183 Perl_croak(aTHX_ "Can't open %s", s);
2185 my_setenv("PERL_XMLDUMP", NULL); /* hide from subprocs */
2191 if ((s = PerlEnv_getenv("PERL_MADSKILLS"))) {
2192 PL_madskills = atoi(s);
2193 my_setenv("PERL_MADSKILLS", NULL); /* hide from subprocs */
2198 lex_start(linestr_sv, rsfp, TRUE);
2199 PL_subname = newSVpvs("main");
2201 if (add_read_e_script)
2202 filter_add(read_e_script, NULL);
2204 /* now parse the script */
2206 SETERRNO(0,SS_NORMAL);
2207 #ifdef MACOS_TRADITIONAL
2208 if (gMacPerl_SyntaxError = (yyparse() || PL_parser->error_count)) {
2210 Perl_croak(aTHX_ "%s had compilation errors.\n", MacPerl_MPWFileName(PL_origfilename));
2212 Perl_croak(aTHX_ "Execution of %s aborted due to compilation errors.\n",
2213 MacPerl_MPWFileName(PL_origfilename));
2217 if (yyparse() || PL_parser->error_count) {
2219 Perl_croak(aTHX_ "%s had compilation errors.\n", PL_origfilename);
2221 Perl_croak(aTHX_ "Execution of %s aborted due to compilation errors.\n",
2226 CopLINE_set(PL_curcop, 0);
2227 PL_curstash = PL_defstash;
2228 PL_preprocess = FALSE;
2230 SvREFCNT_dec(PL_e_script);
2238 SAVECOPFILE(PL_curcop);
2239 SAVECOPLINE(PL_curcop);
2240 gv_check(PL_defstash);
2249 if ((s=PerlEnv_getenv("PERL_DEBUG_MSTATS")) && atoi(s) >= 2)
2250 dump_mstats("after compilation:");
2260 =for apidoc perl_run
2262 Tells a Perl interpreter to run. See L<perlembed>.
2275 PERL_UNUSED_ARG(my_perl);
2277 oldscope = PL_scopestack_ix;
2285 cxstack_ix = -1; /* start context stack again */
2287 case 0: /* normal completion */
2291 case 2: /* my_exit() */
2292 while (PL_scopestack_ix > oldscope)
2295 PL_curstash = PL_defstash;
2296 if (!(PL_exit_flags & PERL_EXIT_DESTRUCT_END) &&
2297 PL_endav && !PL_minus_c)
2298 call_list(oldscope, PL_endav);
2300 if (PerlEnv_getenv("PERL_DEBUG_MSTATS"))
2301 dump_mstats("after execution: ");
2307 POPSTACK_TO(PL_mainstack);
2310 PerlIO_printf(Perl_error_log, "panic: restartop\n");
2321 S_run_body(pTHX_ I32 oldscope)
2324 DEBUG_r(PerlIO_printf(Perl_debug_log, "%s $` $& $' support.\n",
2325 PL_sawampersand ? "Enabling" : "Omitting"));
2327 if (!PL_restartop) {
2331 exit(0); /* less likely to core dump than my_exit(0) */
2334 DEBUG_x(dump_all());
2337 PERL_DEBUG(PerlIO_printf(Perl_debug_log, "\nEXECUTING...\n\n"));
2339 DEBUG_S(PerlIO_printf(Perl_debug_log, "main thread is 0x%"UVxf"\n",
2343 #ifdef MACOS_TRADITIONAL
2344 PerlIO_printf(Perl_error_log, "%s%s syntax OK\n",
2345 (gMacPerl_ErrorFormat ? "# " : ""),
2346 MacPerl_MPWFileName(PL_origfilename));
2348 PerlIO_printf(Perl_error_log, "%s syntax OK\n", PL_origfilename);
2352 if (PERLDB_SINGLE && PL_DBsingle)
2353 sv_setiv(PL_DBsingle, 1);
2355 call_list(oldscope, PL_initav);
2356 #ifdef PERL_DEBUG_READONLY_OPS
2357 Perl_pending_Slabs_to_ro(aTHX);
2364 PL_op = PL_restartop;
2368 else if (PL_main_start) {
2369 CvDEPTH(PL_main_cv) = 1;
2370 PL_op = PL_main_start;
2378 =head1 SV Manipulation Functions
2380 =for apidoc p||get_sv
2382 Returns the SV of the specified Perl scalar. If C<create> is set and the
2383 Perl variable does not exist then it will be created. If C<create> is not
2384 set and the variable does not exist then NULL is returned.
2390 Perl_get_sv(pTHX_ const char *name, I32 create)
2393 gv = gv_fetchpv(name, create, SVt_PV);
2400 =head1 Array Manipulation Functions
2402 =for apidoc p||get_av
2404 Returns the AV of the specified Perl array. If C<create> is set and the
2405 Perl variable does not exist then it will be created. If C<create> is not
2406 set and the variable does not exist then NULL is returned.
2412 Perl_get_av(pTHX_ const char *name, I32 create)
2414 GV* const gv = gv_fetchpv(name, create, SVt_PVAV);
2423 =head1 Hash Manipulation Functions
2425 =for apidoc p||get_hv
2427 Returns the HV of the specified Perl hash. If C<create> is set and the
2428 Perl variable does not exist then it will be created. If C<create> is not
2429 set and the variable does not exist then NULL is returned.
2435 Perl_get_hv(pTHX_ const char *name, I32 create)
2437 GV* const gv = gv_fetchpv(name, create, SVt_PVHV);
2446 =head1 CV Manipulation Functions
2448 =for apidoc p||get_cvn_flags
2450 Returns the CV of the specified Perl subroutine. C<flags> are passed to
2451 C<gv_fetchpvn_flags>. If C<GV_ADD> is set and the Perl subroutine does not
2452 exist then it will be declared (which has the same effect as saying
2453 C<sub name;>). If C<GV_ADD> is not set and the subroutine does not exist
2454 then NULL is returned.
2456 =for apidoc p||get_cv
2458 Uses C<strlen> to get the length of C<name>, then calls C<get_cvn_flags>.
2464 Perl_get_cvn_flags(pTHX_ const char *name, STRLEN len, I32 flags)
2466 GV* const gv = gv_fetchpvn_flags(name, len, flags, SVt_PVCV);
2467 /* XXX this is probably not what they think they're getting.
2468 * It has the same effect as "sub name;", i.e. just a forward
2470 if ((flags & ~GV_NOADD_MASK) && !GvCVu(gv)) {
2471 SV *const sv = newSVpvn_flags(name, len, flags & SVf_UTF8);
2472 return newSUB(start_subparse(FALSE, 0),
2473 newSVOP(OP_CONST, 0, sv),
2482 Perl_get_cv(pTHX_ const char *name, I32 flags)
2484 return get_cvn_flags(name, strlen(name), flags);
2487 /* Be sure to refetch the stack pointer after calling these routines. */
2491 =head1 Callback Functions
2493 =for apidoc p||call_argv
2495 Performs a callback to the specified Perl sub. See L<perlcall>.
2501 Perl_call_argv(pTHX_ const char *sub_name, I32 flags, register char **argv)
2503 /* See G_* flags in cop.h */
2504 /* null terminated arg list */
2512 mXPUSHs(newSVpv(*argv,0));
2517 return call_pv(sub_name, flags);
2521 =for apidoc p||call_pv
2523 Performs a callback to the specified Perl sub. See L<perlcall>.
2529 Perl_call_pv(pTHX_ const char *sub_name, I32 flags)
2530 /* name of the subroutine */
2531 /* See G_* flags in cop.h */
2533 return call_sv((SV*)get_cv(sub_name, TRUE), flags);
2537 =for apidoc p||call_method
2539 Performs a callback to the specified Perl method. The blessed object must
2540 be on the stack. See L<perlcall>.
2546 Perl_call_method(pTHX_ const char *methname, I32 flags)
2547 /* name of the subroutine */
2548 /* See G_* flags in cop.h */
2550 return call_sv(sv_2mortal(newSVpv(methname,0)), flags | G_METHOD);
2553 /* May be called with any of a CV, a GV, or an SV containing the name. */
2555 =for apidoc p||call_sv
2557 Performs a callback to the Perl sub whose name is in the SV. See
2564 Perl_call_sv(pTHX_ SV *sv, I32 flags)
2565 /* See G_* flags in cop.h */
2568 LOGOP myop; /* fake syntax tree node */
2573 bool oldcatch = CATCH_GET;
2575 OP* const oldop = PL_op;
2578 if (flags & G_DISCARD) {
2583 Zero(&myop, 1, LOGOP);
2584 myop.op_next = NULL;
2585 if (!(flags & G_NOARGS))
2586 myop.op_flags |= OPf_STACKED;
2587 myop.op_flags |= ((flags & G_VOID) ? OPf_WANT_VOID :
2588 (flags & G_ARRAY) ? OPf_WANT_LIST :
2593 EXTEND(PL_stack_sp, 1);
2594 *++PL_stack_sp = sv;
2596 oldscope = PL_scopestack_ix;
2598 if (PERLDB_SUB && PL_curstash != PL_debstash
2599 /* Handle first BEGIN of -d. */
2600 && (PL_DBcv || (PL_DBcv = GvCV(PL_DBsub)))
2601 /* Try harder, since this may have been a sighandler, thus
2602 * curstash may be meaningless. */
2603 && (SvTYPE(sv) != SVt_PVCV || CvSTASH((CV*)sv) != PL_debstash)
2604 && !(flags & G_NODEBUG))
2605 PL_op->op_private |= OPpENTERSUB_DB;
2607 if (flags & G_METHOD) {
2608 Zero(&method_op, 1, UNOP);
2609 method_op.op_next = PL_op;
2610 method_op.op_ppaddr = PL_ppaddr[OP_METHOD];
2611 myop.op_ppaddr = PL_ppaddr[OP_ENTERSUB];
2612 PL_op = (OP*)&method_op;
2615 if (!(flags & G_EVAL)) {
2617 CALL_BODY_SUB((OP*)&myop);
2618 retval = PL_stack_sp - (PL_stack_base + oldmark);
2619 CATCH_SET(oldcatch);
2622 myop.op_other = (OP*)&myop;
2624 create_eval_scope(flags|G_FAKINGEVAL);
2632 CALL_BODY_SUB((OP*)&myop);
2633 retval = PL_stack_sp - (PL_stack_base + oldmark);
2634 if (!(flags & G_KEEPERR))
2635 sv_setpvn(ERRSV,"",0);
2641 /* my_exit() was called */
2642 PL_curstash = PL_defstash;
2645 if (PL_statusvalue && !(PL_exit_flags & PERL_EXIT_EXPECTED))
2646 Perl_croak(aTHX_ "Callback called exit");
2651 PL_op = PL_restartop;
2655 PL_stack_sp = PL_stack_base + oldmark;
2656 if (flags & G_ARRAY)
2660 *++PL_stack_sp = &PL_sv_undef;
2665 if (PL_scopestack_ix > oldscope)
2666 delete_eval_scope();
2670 if (flags & G_DISCARD) {
2671 PL_stack_sp = PL_stack_base + oldmark;
2680 /* Eval a string. The G_EVAL flag is always assumed. */
2683 =for apidoc p||eval_sv
2685 Tells Perl to C<eval> the string in the SV.
2691 Perl_eval_sv(pTHX_ SV *sv, I32 flags)
2693 /* See G_* flags in cop.h */
2697 UNOP myop; /* fake syntax tree node */
2698 VOL I32 oldmark = SP - PL_stack_base;
2701 OP* const oldop = PL_op;
2704 if (flags & G_DISCARD) {
2711 Zero(PL_op, 1, UNOP);
2712 EXTEND(PL_stack_sp, 1);
2713 *++PL_stack_sp = sv;
2715 if (!(flags & G_NOARGS))
2716 myop.op_flags = OPf_STACKED;
2717 myop.op_next = NULL;
2718 myop.op_type = OP_ENTEREVAL;
2719 myop.op_flags |= ((flags & G_VOID) ? OPf_WANT_VOID :
2720 (flags & G_ARRAY) ? OPf_WANT_LIST :
2722 if (flags & G_KEEPERR)
2723 myop.op_flags |= OPf_SPECIAL;
2725 /* fail now; otherwise we could fail after the JMPENV_PUSH but
2726 * before a PUSHEVAL, which corrupts the stack after a croak */
2727 TAINT_PROPER("eval_sv()");
2733 CALL_BODY_EVAL((OP*)&myop);
2734 retval = PL_stack_sp - (PL_stack_base + oldmark);
2735 if (!(flags & G_KEEPERR))
2736 sv_setpvn(ERRSV,"",0);
2742 /* my_exit() was called */
2743 PL_curstash = PL_defstash;
2746 if (PL_statusvalue && !(PL_exit_flags & PERL_EXIT_EXPECTED))
2747 Perl_croak(aTHX_ "Callback called exit");
2752 PL_op = PL_restartop;
2756 PL_stack_sp = PL_stack_base + oldmark;
2757 if (flags & G_ARRAY)
2761 *++PL_stack_sp = &PL_sv_undef;
2767 if (flags & G_DISCARD) {
2768 PL_stack_sp = PL_stack_base + oldmark;
2778 =for apidoc p||eval_pv
2780 Tells Perl to C<eval> the given string and return an SV* result.
2786 Perl_eval_pv(pTHX_ const char *p, I32 croak_on_error)
2790 SV* sv = newSVpv(p, 0);
2792 eval_sv(sv, G_SCALAR);
2799 if (croak_on_error && SvTRUE(ERRSV)) {
2800 Perl_croak(aTHX_ SvPVx_nolen_const(ERRSV));
2806 /* Require a module. */
2809 =head1 Embedding Functions
2811 =for apidoc p||require_pv
2813 Tells Perl to C<require> the file named by the string argument. It is
2814 analogous to the Perl code C<eval "require '$file'">. It's even
2815 implemented that way; consider using load_module instead.
2820 Perl_require_pv(pTHX_ const char *pv)
2825 PUSHSTACKi(PERLSI_REQUIRE);
2827 sv = Perl_newSVpvf(aTHX_ "require q%c%s%c", 0, pv, 0);
2828 eval_sv(sv_2mortal(sv), G_DISCARD);
2834 Perl_magicname(pTHX_ const char *sym, const char *name, I32 namlen)
2836 register GV * const gv = gv_fetchpv(sym, GV_ADD, SVt_PV);
2839 sv_magic(GvSV(gv), (SV*)gv, PERL_MAGIC_sv, name, namlen);
2843 S_usage(pTHX_ const char *name) /* XXX move this out into a module ? */
2845 /* This message really ought to be max 23 lines.
2846 * Removed -h because the user already knows that option. Others? */
2848 static const char * const usage_msg[] = {
2849 "-0[octal] specify record separator (\\0, if no argument)",
2850 "-a autosplit mode with -n or -p (splits $_ into @F)",
2851 "-C[number/list] enables the listed Unicode features",
2852 "-c check syntax only (runs BEGIN and CHECK blocks)",
2853 "-d[:debugger] run program under debugger",
2854 "-D[number/list] set debugging flags (argument is a bit mask or alphabets)",
2855 "-e program one line of program (several -e's allowed, omit programfile)",
2856 "-E program like -e, but enables all optional features",
2857 "-f don't do $sitelib/sitecustomize.pl at startup",
2858 "-F/pattern/ split() pattern for -a switch (//'s are optional)",
2859 "-i[extension] edit <> files in place (makes backup if extension supplied)",
2860 "-Idirectory specify @INC/#include directory (several -I's allowed)",
2861 "-l[octal] enable line ending processing, specifies line terminator",
2862 "-[mM][-]module execute \"use/no module...\" before executing program",
2863 "-n assume \"while (<>) { ... }\" loop around program",
2864 "-p assume loop like -n but print line also, like sed",
2865 "-P run program through C preprocessor before compilation",
2866 "-s enable rudimentary parsing for switches after programfile",
2867 "-S look for programfile using PATH environment variable",
2868 "-t enable tainting warnings",
2869 "-T enable tainting checks",
2870 "-u dump core after parsing program",
2871 "-U allow unsafe operations",
2872 "-v print version, subversion (includes VERY IMPORTANT perl info)",
2873 "-V[:variable] print configuration summary (or a single Config.pm variable)",
2874 "-w enable many useful warnings (RECOMMENDED)",
2875 "-W enable all warnings",
2876 "-x[directory] strip off text before #!perl line and perhaps cd to directory",
2877 "-X disable all warnings",
2881 const char * const *p = usage_msg;
2883 PerlIO_printf(PerlIO_stdout(),
2884 "\nUsage: %s [switches] [--] [programfile] [arguments]",
2887 PerlIO_printf(PerlIO_stdout(), "\n %s", *p++);
2890 /* convert a string of -D options (or digits) into an int.
2891 * sets *s to point to the char after the options */
2895 Perl_get_debug_opts(pTHX_ const char **s, bool givehelp)
2897 static const char * const usage_msgd[] = {
2898 " Debugging flag values: (see also -d)",
2899 " p Tokenizing and parsing (with v, displays parse stack)",
2900 " s Stack snapshots (with v, displays all stacks)",
2901 " l Context (loop) stack processing",
2902 " t Trace execution",
2903 " o Method and overloading resolution",
2904 " c String/numeric conversions",
2905 " P Print profiling info, preprocessor command for -P, source file input state",
2906 " m Memory allocation",
2907 " f Format processing",
2908 " r Regular expression parsing and execution",
2909 " x Syntax tree dump",
2910 " u Tainting checks",
2911 " H Hash dump -- usurps values()",
2912 " X Scratchpad allocation",
2914 " S Thread synchronization",
2916 " R Include reference counts of dumped variables (eg when using -Ds)",
2917 " J Do not s,t,P-debug (Jump over) opcodes within package DB",
2918 " v Verbose: use in conjunction with other flags",
2920 " A Consistency checks on internal structures",
2921 " q quiet - currently only suppresses the 'EXECUTING' message",
2926 /* if adding extra options, remember to update DEBUG_MASK */
2927 static const char debopts[] = "psltocPmfrxuUHXDSTRJvCAq";
2929 for (; isALNUM(**s); (*s)++) {
2930 const char * const d = strchr(debopts,**s);
2932 i |= 1 << (d - debopts);
2933 else if (ckWARN_d(WARN_DEBUGGING))
2934 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
2935 "invalid option -D%c, use -D'' to see choices\n", **s);
2938 else if (isDIGIT(**s)) {
2940 for (; isALNUM(**s); (*s)++) ;
2942 else if (givehelp) {
2943 const char *const *p = usage_msgd;
2944 while (*p) PerlIO_printf(PerlIO_stdout(), "%s\n", *p++);
2947 if ((i & DEBUG_p_FLAG) && ckWARN_d(WARN_DEBUGGING))
2948 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
2949 "-Dp not implemented on this platform\n");
2955 /* This routine handles any switches that can be given during run */
2958 Perl_moreswitches(pTHX_ const char *s)
2969 SvREFCNT_dec(PL_rs);
2970 if (s[1] == 'x' && s[2]) {
2971 const char *e = s+=2;
2977 flags = PERL_SCAN_SILENT_ILLDIGIT;
2978 rschar = (U32)grok_hex(s, &numlen, &flags, NULL);
2979 if (s + numlen < e) {
2980 rschar = 0; /* Grandfather -0xFOO as -0 -xFOO. */
2984 PL_rs = newSVpvs("");
2985 SvGROW(PL_rs, (STRLEN)(UNISKIP(rschar) + 1));
2986 tmps = (U8*)SvPVX(PL_rs);
2987 uvchr_to_utf8(tmps, rschar);
2988 SvCUR_set(PL_rs, UNISKIP(rschar));
2993 rschar = (U32)grok_oct(s, &numlen, &flags, NULL);
2994 if (rschar & ~((U8)~0))
2995 PL_rs = &PL_sv_undef;
2996 else if (!rschar && numlen >= 2)
2997 PL_rs = newSVpvs("");
2999 char ch = (char)rschar;
3000 PL_rs = newSVpvn(&ch, 1);
3003 sv_setsv(get_sv("/", TRUE), PL_rs);
3008 PL_unicode = parse_unicode_opts( (const char **)&s );
3009 if (PL_unicode & PERL_UNICODE_UTF8CACHEASSERT_FLAG)
3015 while (*s && !isSPACE(*s)) ++s;
3016 PL_splitstr = savepvn(PL_splitstr, s - PL_splitstr);
3027 forbid_setid('d', -1);
3030 /* -dt indicates to the debugger that threads will be used */
3031 if (*s == 't' && !isALNUM(s[1])) {
3033 my_setenv("PERL5DB_THREADED", "1");
3036 /* The following permits -d:Mod to accepts arguments following an =
3037 in the fashion that -MSome::Mod does. */
3038 if (*s == ':' || *s == '=') {
3039 const char *start = ++s;
3040 const char *const end = s + strlen(s);
3041 SV * const sv = newSVpvs("use Devel::");
3043 /* We now allow -d:Module=Foo,Bar */
3044 while(isALNUM(*s) || *s==':') ++s;
3046 sv_catpvn(sv, start, end - start);
3048 sv_catpvn(sv, start, s-start);
3049 /* Don't use NUL as q// delimiter here, this string goes in the
3051 Perl_sv_catpvf(aTHX_ sv, " split(/,/,q{%s});", ++s);
3054 my_setenv("PERL5DB", SvPV_nolen_const(sv));
3058 PL_perldb = PERLDB_ALL;
3065 forbid_setid('D', -1);
3067 PL_debug = get_debug_opts( (const char **)&s, 1) | DEBUG_TOP_FLAG;
3068 #else /* !DEBUGGING */
3069 if (ckWARN_d(WARN_DEBUGGING))
3070 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3071 "Recompile perl with -DDEBUGGING to use -D switch (did you mean -d ?)\n");
3072 for (s++; isALNUM(*s); s++) ;
3077 usage(PL_origargv[0]);
3080 Safefree(PL_inplace);
3081 #if defined(__CYGWIN__) /* do backup extension automagically */
3082 if (*(s+1) == '\0') {
3083 PL_inplace = savepvs(".bak");
3086 #endif /* __CYGWIN__ */
3088 const char * const start = ++s;
3089 while (*s && !isSPACE(*s))
3092 PL_inplace = savepvn(start, s - start);
3096 if (*s == '-') /* Additional switches on #! line. */
3100 case 'I': /* -I handled both here and in parse_body() */
3101 forbid_setid('I', -1);
3103 while (*s && isSPACE(*s))
3108 /* ignore trailing spaces (possibly followed by other switches) */
3110 for (e = p; *e && !isSPACE(*e); e++) ;
3114 } while (*p && *p != '-');
3115 e = savepvn(s, e-s);
3116 incpush(e, TRUE, TRUE, FALSE, FALSE);
3123 Perl_croak(aTHX_ "No directory specified for -I");
3129 SvREFCNT_dec(PL_ors_sv);
3135 PL_ors_sv = newSVpvs("\n");
3136 numlen = 3 + (*s == '0');
3137 *SvPVX(PL_ors_sv) = (char)grok_oct(s, &numlen, &flags, NULL);
3141 if (RsPARA(PL_rs)) {
3142 PL_ors_sv = newSVpvs("\n\n");
3145 PL_ors_sv = newSVsv(PL_rs);
3150 forbid_setid('M', -1); /* XXX ? */
3153 forbid_setid('m', -1); /* XXX ? */
3158 const char *use = "use ";
3159 /* -M-foo == 'no foo' */
3160 /* Leading space on " no " is deliberate, to make both
3161 possibilities the same length. */
3162 if (*s == '-') { use = " no "; ++s; }
3163 sv = newSVpvn(use,4);
3165 /* We allow -M'Module qw(Foo Bar)' */
3166 while(isALNUM(*s) || *s==':') ++s;
3167 end = s + strlen(s);
3169 sv_catpvn(sv, start, end - start);
3170 if (*(start-1) == 'm') {
3172 Perl_croak(aTHX_ "Can't use '%c' after -mname", *s);
3173 sv_catpvs( sv, " ()");
3177 Perl_croak(aTHX_ "Module name required with -%c option",
3179 sv_catpvn(sv, start, s-start);
3180 /* Use NUL as q''-delimiter. */
3181 sv_catpvs(sv, " split(/,/,q\0");
3183 sv_catpvn(sv, s, end - s);
3184 sv_catpvs(sv, "\0)");
3187 Perl_av_create_and_push(aTHX_ &PL_preambleav, sv);
3190 Perl_croak(aTHX_ "Missing argument to -%c", *(s-1));
3201 forbid_setid('s', -1);
3202 PL_doswitches = TRUE;
3216 #ifdef MACOS_TRADITIONAL
3217 Perl_croak(aTHX_ "Believe me, you don't want to use \"-u\" on a Macintosh");
3219 PL_do_undump = TRUE;
3227 if (!sv_derived_from(PL_patchlevel, "version"))
3228 upg_version(PL_patchlevel, TRUE);
3230 PerlIO_printf(PerlIO_stdout(),
3231 Perl_form(aTHX_ "\nThis is perl, %"SVf
3232 #ifdef PERL_PATCHNUM
3233 " DEVEL" STRINGIFY(PERL_PATCHNUM)
3236 SVfARG(vstringify(PL_patchlevel)),
3239 /* Adjust verbose output as in the perl that ships with the DG/UX OS from EMC */
3240 PerlIO_printf(PerlIO_stdout(),
3241 Perl_form(aTHX_ "\nThis is perl, %"SVf"\n",
3242 SVfARG(vstringify(PL_patchlevel))));
3243 PerlIO_printf(PerlIO_stdout(),
3244 Perl_form(aTHX_ " built under %s at %s %s\n",
3245 OSNAME, __DATE__, __TIME__));
3246 PerlIO_printf(PerlIO_stdout(),
3247 Perl_form(aTHX_ " OS Specific Release: %s\n",
3251 #if defined(LOCAL_PATCH_COUNT)
3252 if (LOCAL_PATCH_COUNT > 0)
3253 PerlIO_printf(PerlIO_stdout(),
3254 "\n(with %d registered patch%s, "
3255 "see perl -V for more detail)",
3257 (LOCAL_PATCH_COUNT!=1) ? "es" : "");
3260 PerlIO_printf(PerlIO_stdout(),
3261 "\n\nCopyright 1987-2007, Larry Wall\n");
3262 #ifdef MACOS_TRADITIONAL
3263 PerlIO_printf(PerlIO_stdout(),
3264 "\nMac OS port Copyright 1991-2002, Matthias Neeracher;\n"
3265 "maintained by Chris Nandor\n");
3268 PerlIO_printf(PerlIO_stdout(),
3269 "\nMS-DOS port Copyright (c) 1989, 1990, Diomidis Spinellis\n");
3272 PerlIO_printf(PerlIO_stdout(),
3273 "djgpp v2 port (jpl5003c) by Hirofumi Watanabe, 1996\n"
3274 "djgpp v2 port (perl5004+) by Laszlo Molnar, 1997-1999\n");
3277 PerlIO_printf(PerlIO_stdout(),
3278 "\n\nOS/2 port Copyright (c) 1990, 1991, Raymond Chen, Kai Uwe Rommel\n"
3279 "Version 5 port Copyright (c) 1994-2002, Andreas Kaiser, Ilya Zakharevich\n");
3282 PerlIO_printf(PerlIO_stdout(),
3283 "atariST series port, ++jrb bammi@cadence.com\n");
3286 PerlIO_printf(PerlIO_stdout(),
3287 "BeOS port Copyright Tom Spindler, 1997-1999\n");
3290 PerlIO_printf(PerlIO_stdout(),
3291 "MPE/iX port Copyright by Mark Klein and Mark Bixby, 1996-2003\n");
3294 PerlIO_printf(PerlIO_stdout(),
3295 "MVS (OS390) port by Mortice Kern Systems, 1997-1999\n");
3298 PerlIO_printf(PerlIO_stdout(),
3299 "Stratus VOS port by Paul.Green@stratus.com, 1997-2002\n");
3302 PerlIO_printf(PerlIO_stdout(),
3303 "VM/ESA port by Neale Ferguson, 1998-1999\n");
3306 PerlIO_printf(PerlIO_stdout(),
3307 "BS2000 (POSIX) port by Start Amadeus GmbH, 1998-1999\n");
3310 PerlIO_printf(PerlIO_stdout(),
3311 "MiNT port by Guido Flohr, 1997-1999\n");
3314 PerlIO_printf(PerlIO_stdout(),
3315 "EPOC port by Olaf Flebbe, 1999-2002\n");
3318 PerlIO_printf(PerlIO_stdout(),"WINCE port by Rainer Keuchel, 2001-2002\n");
3319 PerlIO_printf(PerlIO_stdout(),"Built on " __DATE__ " " __TIME__ "\n\n");
3322 #ifdef __SYMBIAN32__
3323 PerlIO_printf(PerlIO_stdout(),
3324 "Symbian port by Nokia, 2004-2005\n");
3326 #ifdef BINARY_BUILD_NOTICE
3327 BINARY_BUILD_NOTICE;
3329 PerlIO_printf(PerlIO_stdout(),
3331 Perl may be copied only under the terms of either the Artistic License or the\n\
3332 GNU General Public License, which may be found in the Perl 5 source kit.\n\n\
3333 Complete documentation for Perl, including FAQ lists, should be found on\n\
3334 this system using \"man perl\" or \"perldoc perl\". If you have access to the\n\
3335 Internet, point your browser at http://www.perl.org/, the Perl Home Page.\n\n");
3338 if (! (PL_dowarn & G_WARN_ALL_MASK)) {
3339 PL_dowarn |= G_WARN_ON;
3344 PL_dowarn = G_WARN_ALL_ON|G_WARN_ON;
3345 if (!specialWARN(PL_compiling.cop_warnings))
3346 PerlMemShared_free(PL_compiling.cop_warnings);
3347 PL_compiling.cop_warnings = pWARN_ALL ;
3351 PL_dowarn = G_WARN_ALL_OFF;
3352 if (!specialWARN(PL_compiling.cop_warnings))
3353 PerlMemShared_free(PL_compiling.cop_warnings);
3354 PL_compiling.cop_warnings = pWARN_NONE ;
3359 if (s[1] == '-') /* Additional switches on #! line. */
3364 #if defined(WIN32) || !defined(PERL_STRICT_CR)
3370 #ifdef ALTERNATE_SHEBANG
3371 case 'S': /* OS/2 needs -S on "extproc" line. */
3379 Perl_croak(aTHX_ "Can't emulate -%.1s on #! line",s);
3384 /* compliments of Tom Christiansen */
3386 /* unexec() can be found in the Gnu emacs distribution */
3387 /* Known to work with -DUNEXEC and using unexelf.c from GNU emacs-20.2 */
3390 Perl_my_unexec(pTHX)
3392 PERL_UNUSED_CONTEXT;
3394 SV * prog = newSVpv(BIN_EXP, 0);
3395 SV * file = newSVpv(PL_origfilename, 0);
3399 sv_catpvs(prog, "/perl");
3400 sv_catpvs(file, ".perldump");
3402 unexec(SvPVX(file), SvPVX(prog), &etext, sbrk(0), 0);
3403 /* unexec prints msg to stderr in case of failure */
3404 PerlProc_exit(status);
3407 # include <lib$routines.h>
3408 lib$signal(SS$_DEBUG); /* ssdef.h #included from vmsish.h */
3409 # elif defined(WIN32) || defined(__CYGWIN__)
3410 Perl_croak(aTHX_ "dump is not supported");
3412 ABORT(); /* for use with undump */
3417 /* initialize curinterp */
3423 # define PERLVAR(var,type)
3424 # define PERLVARA(var,n,type)
3425 # if defined(PERL_IMPLICIT_CONTEXT)
3426 # define PERLVARI(var,type,init) aTHX->var = init;
3427 # define PERLVARIC(var,type,init) aTHX->var = init;
3429 # define PERLVARI(var,type,init) PERL_GET_INTERP->var = init;
3430 # define PERLVARIC(var,type,init) PERL_GET_INTERP->var = init;
3432 # include "intrpvar.h"
3438 # define PERLVAR(var,type)
3439 # define PERLVARA(var,n,type)
3440 # define PERLVARI(var,type,init) PL_##var = init;
3441 # define PERLVARIC(var,type,init) PL_##var = init;
3442 # include "intrpvar.h"
3449 /* As these are inside a structure, PERLVARI isn't capable of initialising
3451 PL_reg_oldcurpm = PL_reg_curpm = NULL;
3452 PL_reg_poscache = PL_reg_starttry = NULL;
3456 S_init_main_stash(pTHX)
3461 PL_curstash = PL_defstash = newHV();
3462 /* We know that the string "main" will be in the global shared string
3463 table, so it's a small saving to use it rather than allocate another
3465 PL_curstname = newSVpvs_share("main");
3466 gv = gv_fetchpvs("main::", GV_ADD|GV_NOTQUAL, SVt_PVHV);
3467 /* If we hadn't caused another reference to "main" to be in the shared
3468 string table above, then it would be worth reordering these two,
3469 because otherwise all we do is delete "main" from it as a consequence
3470 of the SvREFCNT_dec, only to add it again with hv_name_set */
3471 SvREFCNT_dec(GvHV(gv));
3472 hv_name_set(PL_defstash, "main", 4, 0);
3473 GvHV(gv) = (HV*)SvREFCNT_inc_simple(PL_defstash);
3475 PL_incgv = gv_HVadd(gv_AVadd(gv_fetchpvs("INC", GV_ADD|GV_NOTQUAL,
3477 SvREFCNT_inc_simple_void(PL_incgv); /* Don't allow it to be freed */
3478 GvMULTI_on(PL_incgv);
3479 PL_hintgv = gv_fetchpvs("\010", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^H */
3480 GvMULTI_on(PL_hintgv);
3481 PL_defgv = gv_fetchpvs("_", GV_ADD|GV_NOTQUAL, SVt_PVAV);
3482 SvREFCNT_inc_simple_void(PL_defgv);
3483 PL_errgv = gv_HVadd(gv_fetchpvs("@", GV_ADD|GV_NOTQUAL, SVt_PV));
3484 SvREFCNT_inc_simple_void(PL_errgv);
3485 GvMULTI_on(PL_errgv);
3486 PL_replgv = gv_fetchpvs("\022", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^R */
3487 GvMULTI_on(PL_replgv);
3488 (void)Perl_form(aTHX_ "%240s",""); /* Preallocate temp - for immediate signals. */
3489 #ifdef PERL_DONT_CREATE_GVSV
3492 sv_grow(ERRSV, 240); /* Preallocate - for immediate signals. */
3493 sv_setpvn(ERRSV, "", 0);
3494 PL_curstash = PL_defstash;
3495 CopSTASH_set(&PL_compiling, PL_defstash);
3496 PL_debstash = GvHV(gv_fetchpvs("DB::", GV_ADDMULTI, SVt_PVHV));
3497 PL_globalstash = GvHV(gv_fetchpvs("CORE::GLOBAL::", GV_ADDMULTI,
3499 /* We must init $/ before switches are processed. */
3500 sv_setpvn(get_sv("/", TRUE), "\n", 1);
3504 S_open_script(pTHX_ const char *scriptname, bool dosearch, SV *sv,
3505 int *suidscript, PerlIO **rsfpp)
3510 const char *cpp_discard_flag;
3519 PL_origfilename = savepvs("-e");
3522 /* if find_script() returns, it returns a malloc()-ed value */
3523 scriptname = PL_origfilename = find_script(scriptname, dosearch, NULL, 1);
3525 if (strnEQ(scriptname, "/dev/fd/", 8) && isDIGIT(scriptname[8]) ) {
3526 const char *s = scriptname + 8;
3532 * Tell apart "normal" usage of fdscript, e.g.
3533 * with bash on FreeBSD:
3534 * perl <( echo '#!perl -DA'; echo 'print "$0\n"')
3535 * from usage in suidperl.
3536 * Does any "normal" usage leave garbage after the number???
3537 * Is it a mistake to use a similar /dev/fd/ construct for
3542 * Be supersafe and do some sanity-checks.
3543 * Still, can we be sure we got the right thing?
3546 Perl_croak(aTHX_ "Wrong syntax (suid) fd script name \"%s\"\n", s);
3549 Perl_croak(aTHX_ "Missing (suid) fd script name\n");
3551 scriptname = savepv(s + 1);
3552 Safefree(PL_origfilename);
3553 PL_origfilename = (char *)scriptname;
3558 CopFILE_free(PL_curcop);
3559 CopFILE_set(PL_curcop, PL_origfilename);
3560 if (*PL_origfilename == '-' && PL_origfilename[1] == '\0')
3561 scriptname = (char *)"";
3562 if (fdscript >= 0) {
3563 *rsfpp = PerlIO_fdopen(fdscript,PERL_SCRIPT_MODE);
3564 # if defined(HAS_FCNTL) && defined(F_SETFD)
3566 /* ensure close-on-exec */
3567 fcntl(PerlIO_fileno(*rsfpp),F_SETFD,1);
3572 Perl_croak(aTHX_ "sperl needs fd script\n"
3573 "You should not call sperl directly; do you need to "
3574 "change a #! line\nfrom sperl to perl?\n");
3577 * Do not open (or do other fancy stuff) while setuid.
3578 * Perl does the open, and hands script to suidperl on a fd;
3579 * suidperl only does some checks, sets up UIDs and re-execs
3580 * perl with that fd as it has always done.
3583 if (*suidscript != 1) {
3584 Perl_croak(aTHX_ "suidperl needs (suid) fd script\n");
3587 else if (PL_preprocess) {
3588 const char * const cpp_cfg = CPPSTDIN;
3589 SV * const cpp = newSVpvs("");
3590 SV * const cmd = newSV(0);
3592 if (cpp_cfg[0] == 0) /* PERL_MICRO? */
3593 Perl_croak(aTHX_ "Can't run with cpp -P with CPPSTDIN undefined");
3594 if (strEQ(cpp_cfg, "cppstdin"))
3595 Perl_sv_catpvf(aTHX_ cpp, "%s/", BIN_EXP);
3596 sv_catpv(cpp, cpp_cfg);
3599 sv_catpvs(sv, "-I");
3600 sv_catpv(sv,PRIVLIB_EXP);
3603 DEBUG_P(PerlIO_printf(Perl_debug_log,
3604 "PL_preprocess: scriptname=\"%s\", cpp=\"%s\", sv=\"%s\", CPPMINUS=\"%s\"\n",
3605 scriptname, SvPVX_const (cpp), SvPVX_const (sv),
3608 # if defined(MSDOS) || defined(WIN32) || defined(VMS)
3615 cpp_discard_flag = "";
3617 cpp_discard_flag = "-C";
3621 perl = os2_execname(aTHX);
3623 perl = PL_origargv[0];
3627 /* This strips off Perl comments which might interfere with
3628 the C pre-processor, including #!. #line directives are
3629 deliberately stripped to avoid confusion with Perl's version
3630 of #line. FWP played some golf with it so it will fit
3631 into VMS's 255 character buffer.
3634 code = "(1../^#!.*perl/i)|/^\\s*#(?!\\s*((ifn?|un)def|(el|end)?if|define|include|else|error|pragma)\\b)/||!($|=1)||print";
3636 code = "/^\\s*#(?!\\s*((ifn?|un)def|(el|end)?if|define|include|else|error|pragma)\\b)/||!($|=1)||print";
3638 Perl_sv_setpvf(aTHX_ cmd, "\
3639 %s -ne%s%s%s %s | %"SVf" %s %"SVf" %s",
3640 perl, quote, code, quote, scriptname, SVfARG(cpp),
3641 cpp_discard_flag, SVfARG(sv), CPPMINUS);
3643 PL_doextract = FALSE;
3645 DEBUG_P(PerlIO_printf(Perl_debug_log,
3646 "PL_preprocess: cmd=\"%s\"\n",
3649 *rsfpp = PerlProc_popen((char *)SvPVX_const(cmd), (char *)"r");
3653 else if (!*scriptname) {
3654 forbid_setid(0, *suidscript);
3655 *rsfpp = PerlIO_stdin();
3658 #ifdef FAKE_BIT_BUCKET
3659 /* This hack allows one not to have /dev/null (or BIT_BUCKET as it
3660 * is called) and still have the "-e" work. (Believe it or not,
3661 * a /dev/null is required for the "-e" to work because source
3662 * filter magic is used to implement it. ) This is *not* a general
3663 * replacement for a /dev/null. What we do here is create a temp
3664 * file (an empty file), open up that as the script, and then
3665 * immediately close and unlink it. Close enough for jazz. */
3666 #define FAKE_BIT_BUCKET_PREFIX "/tmp/perlnull-"
3667 #define FAKE_BIT_BUCKET_SUFFIX "XXXXXXXX"
3668 #define FAKE_BIT_BUCKET_TEMPLATE FAKE_BIT_BUCKET_PREFIX FAKE_BIT_BUCKET_SUFFIX
3669 char tmpname[sizeof(FAKE_BIT_BUCKET_TEMPLATE)] = {
3670 FAKE_BIT_BUCKET_TEMPLATE
3672 const char * const err = "Failed to create a fake bit bucket";
3673 if (strEQ(scriptname, BIT_BUCKET)) {
3674 #ifdef HAS_MKSTEMP /* Hopefully mkstemp() is safe here. */
3675 int tmpfd = mkstemp(tmpname);
3677 scriptname = tmpname;
3680 Perl_croak(aTHX_ err);
3683 scriptname = mktemp(tmpname);
3685 Perl_croak(aTHX_ err);
3690 *rsfpp = PerlIO_open(scriptname,PERL_SCRIPT_MODE);
3691 #ifdef FAKE_BIT_BUCKET
3692 if (memEQ(scriptname, FAKE_BIT_BUCKET_PREFIX,
3693 sizeof(FAKE_BIT_BUCKET_PREFIX) - 1)
3694 && strlen(scriptname) == sizeof(tmpname) - 1) {
3697 scriptname = BIT_BUCKET;
3699 # if defined(HAS_FCNTL) && defined(F_SETFD)
3701 /* ensure close-on-exec */
3702 fcntl(PerlIO_fileno(*rsfpp),F_SETFD,1);
3705 #endif /* IAMSUID */
3707 /* PSz 16 Sep 03 Keep neat error message */
3709 Perl_croak(aTHX_ "Can't open "BIT_BUCKET": %s\n", Strerror(errno));
3711 Perl_croak(aTHX_ "Can't open perl script \"%s\": %s\n",
3712 CopFILE(PL_curcop), Strerror(errno));
3718 * I_SYSSTATVFS HAS_FSTATVFS
3720 * I_STATFS HAS_FSTATFS HAS_GETFSSTAT
3721 * I_MNTENT HAS_GETMNTENT HAS_HASMNTOPT
3722 * here so that metaconfig picks them up. */
3726 S_fd_on_nosuid_fs(pTHX_ int fd)
3729 * We used to do this as "plain" user (after swapping UIDs with setreuid);
3730 * but is needed also on machines without setreuid.
3731 * Seems safe enough to run as root.
3733 int check_okay = 0; /* able to do all the required sys/libcalls */
3734 int on_nosuid = 0; /* the fd is on a nosuid fs */
3736 * Need to check noexec also: nosuid might not be set, the average
3737 * sysadmin would say that nosuid is irrelevant once he sets noexec.
3739 int on_noexec = 0; /* the fd is on a noexec fs */
3742 * Preferred order: fstatvfs(), fstatfs(), ustat()+getmnt(), getmntent().
3743 * fstatvfs() is UNIX98.
3744 * fstatfs() is 4.3 BSD.
3745 * ustat()+getmnt() is pre-4.3 BSD.
3746 * getmntent() is O(number-of-mounted-filesystems) and can hang on
3747 * an irrelevant filesystem while trying to reach the right one.
3750 #undef FD_ON_NOSUID_CHECK_OKAY /* found the syscalls to do the check? */
3752 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3753 defined(HAS_FSTATVFS)
3754 # define FD_ON_NOSUID_CHECK_OKAY
3755 struct statvfs stfs;
3757 check_okay = fstatvfs(fd, &stfs) == 0;
3758 on_nosuid = check_okay && (stfs.f_flag & ST_NOSUID);
3760 /* ST_NOEXEC certainly absent on AIX 5.1, and doesn't seem to be documented
3761 on platforms where it is present. */
3762 on_noexec = check_okay && (stfs.f_flag & ST_NOEXEC);
3764 # endif /* fstatvfs */
3766 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3767 defined(PERL_MOUNT_NOSUID) && \
3768 defined(PERL_MOUNT_NOEXEC) && \
3769 defined(HAS_FSTATFS) && \
3770 defined(HAS_STRUCT_STATFS) && \
3771 defined(HAS_STRUCT_STATFS_F_FLAGS)
3772 # define FD_ON_NOSUID_CHECK_OKAY
3775 check_okay = fstatfs(fd, &stfs) == 0;
3776 on_nosuid = check_okay && (stfs.f_flags & PERL_MOUNT_NOSUID);
3777 on_noexec = check_okay && (stfs.f_flags & PERL_MOUNT_NOEXEC);
3778 # endif /* fstatfs */
3780 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3781 defined(PERL_MOUNT_NOSUID) && \
3782 defined(PERL_MOUNT_NOEXEC) && \
3783 defined(HAS_FSTAT) && \
3784 defined(HAS_USTAT) && \
3785 defined(HAS_GETMNT) && \
3786 defined(HAS_STRUCT_FS_DATA) && \
3788 # define FD_ON_NOSUID_CHECK_OKAY
3791 if (fstat(fd, &fdst) == 0) {
3793 if (ustat(fdst.st_dev, &us) == 0) {
3795 /* NOSTAT_ONE here because we're not examining fields which
3796 * vary between that case and STAT_ONE. */
3797 if (getmnt((int*)0, &fsd, (int)0, NOSTAT_ONE, us.f_fname) == 0) {
3798 size_t cmplen = sizeof(us.f_fname);
3799 if (sizeof(fsd.fd_req.path) < cmplen)
3800 cmplen = sizeof(fsd.fd_req.path);
3801 if (strnEQ(fsd.fd_req.path, us.f_fname, cmplen) &&
3802 fdst.st_dev == fsd.fd_req.dev) {
3804 on_nosuid = fsd.fd_req.flags & PERL_MOUNT_NOSUID;
3805 on_noexec = fsd.fd_req.flags & PERL_MOUNT_NOEXEC;
3810 # endif /* fstat+ustat+getmnt */
3812 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3813 defined(HAS_GETMNTENT) && \
3814 defined(HAS_HASMNTOPT) && \
3815 defined(MNTOPT_NOSUID) && \
3816 defined(MNTOPT_NOEXEC)
3817 # define FD_ON_NOSUID_CHECK_OKAY
3818 FILE *mtab = fopen("/etc/mtab", "r");
3819 struct mntent *entry;
3822 if (mtab && (fstat(fd, &stb) == 0)) {
3823 while (entry = getmntent(mtab)) {
3824 if (stat(entry->mnt_dir, &fsb) == 0
3825 && fsb.st_dev == stb.st_dev)
3827 /* found the filesystem */
3829 if (hasmntopt(entry, MNTOPT_NOSUID))
3831 if (hasmntopt(entry, MNTOPT_NOEXEC))
3834 } /* A single fs may well fail its stat(). */
3839 # endif /* getmntent+hasmntopt */
3842 Perl_croak(aTHX_ "Can't check filesystem of script \"%s\" for nosuid/noexec", PL_origfilename);
3844 Perl_croak(aTHX_ "Setuid script \"%s\" on nosuid filesystem", PL_origfilename);
3846 Perl_croak(aTHX_ "Setuid script \"%s\" on noexec filesystem", PL_origfilename);
3847 return ((!check_okay) || on_nosuid || on_noexec);
3849 #endif /* IAMSUID */
3852 S_validate_suid(pTHX_ const char *validarg, const char *scriptname,
3853 int fdscript, int suidscript, SV *linestr_sv, PerlIO *rsfp)
3858 #endif /* IAMSUID */
3860 /* do we need to emulate setuid on scripts? */
3862 /* This code is for those BSD systems that have setuid #! scripts disabled
3863 * in the kernel because of a security problem. Merely defining DOSUID
3864 * in perl will not fix that problem, but if you have disabled setuid
3865 * scripts in the kernel, this will attempt to emulate setuid and setgid
3866 * on scripts that have those now-otherwise-useless bits set. The setuid
3867 * root version must be called suidperl or sperlN.NNN. If regular perl
3868 * discovers that it has opened a setuid script, it calls suidperl with
3869 * the same argv that it had. If suidperl finds that the script it has
3870 * just opened is NOT setuid root, it sets the effective uid back to the
3871 * uid. We don't just make perl setuid root because that loses the
3872 * effective uid we had before invoking perl, if it was different from the
3875 * Description/comments above do not match current workings:
3876 * suidperl must be hardlinked to sperlN.NNN (that is what we exec);
3877 * suidperl called with script open and name changed to /dev/fd/N/X;
3878 * suidperl croaks if script is not setuid;
3879 * making perl setuid would be a huge security risk (and yes, that
3880 * would lose any euid we might have had).
3882 * DOSUID must be defined in both perl and suidperl, and IAMSUID must
3883 * be defined in suidperl only. suidperl must be setuid root. The
3884 * Configure script will set this up for you if you want it.
3890 if (PerlLIO_fstat(PerlIO_fileno(rsfp),&PL_statbuf) < 0) /* normal stat is insecure */
3891 Perl_croak(aTHX_ "Can't stat script \"%s\"",PL_origfilename);
3892 if (PL_statbuf.st_mode & (S_ISUID|S_ISGID)) {
3894 const char *linestr;
3898 if (fdscript < 0 || suidscript != 1)
3899 Perl_croak(aTHX_ "Need (suid) fdscript in suidperl\n"); /* We already checked this */
3901 * Since the script is opened by perl, not suidperl, some of these
3902 * checks are superfluous. Leaving them in probably does not lower
3906 * Do checks even for systems with no HAS_SETREUID.
3907 * We used to swap, then re-swap UIDs with
3908 # ifdef HAS_SETREUID
3909 if (setreuid(PL_euid,PL_uid) < 0
3910 || PerlProc_getuid() != PL_euid || PerlProc_geteuid() != PL_uid)
3911 Perl_croak(aTHX_ "Can't swap uid and euid");
3913 # ifdef HAS_SETREUID
3914 if (setreuid(PL_uid,PL_euid) < 0
3915 || PerlProc_getuid() != PL_uid || PerlProc_geteuid() != PL_euid)
3916 Perl_croak(aTHX_ "Can't reswap uid and euid");
3920 /* On this access check to make sure the directories are readable,
3921 * there is actually a small window that the user could use to make
3922 * filename point to an accessible directory. So there is a faint
3923 * chance that someone could execute a setuid script down in a
3924 * non-accessible directory. I don't know what to do about that.
3925 * But I don't think it's too important. The manual lies when
3926 * it says access() is useful in setuid programs.
3928 * So, access() is pretty useless... but not harmful... do anyway.
3930 if (PerlLIO_access(CopFILE(PL_curcop),1)) { /*double check*/
3931 Perl_croak(aTHX_ "Can't access() script\n");
3934 /* If we can swap euid and uid, then we can determine access rights
3935 * with a simple stat of the file, and then compare device and
3936 * inode to make sure we did stat() on the same file we opened.
3937 * Then we just have to make sure he or she can execute it.
3940 * As the script is opened by perl, not suidperl, we do not need to
3941 * care much about access rights.
3943 * The 'script changed' check is needed, or we can get lied to
3944 * about $0 with e.g.
3945 * suidperl /dev/fd/4//bin/x 4<setuidscript
3946 * Without HAS_SETREUID, is it safe to stat() as root?
3948 * Are there any operating systems that pass /dev/fd/xxx for setuid
3949 * scripts, as suggested/described in perlsec(1)? Surely they do not
3950 * pass the script name as we do, so the "script changed" test would
3951 * fail for them... but we never get here with
3952 * SETUID_SCRIPTS_ARE_SECURE_NOW defined.
3954 * This is one place where we must "lie" about return status: not
3955 * say if the stat() failed. We are doing this as root, and could
3956 * be tricked into reporting existence or not of files that the
3957 * "plain" user cannot even see.
3961 if (PerlLIO_stat(CopFILE(PL_curcop),&tmpstatbuf) < 0 ||
3962 tmpstatbuf.st_dev != PL_statbuf.st_dev ||
3963 tmpstatbuf.st_ino != PL_statbuf.st_ino) {
3964 Perl_croak(aTHX_ "Setuid script changed\n");
3968 if (!cando(S_IXUSR,FALSE,&PL_statbuf)) /* can real uid exec? */
3969 Perl_croak(aTHX_ "Real UID cannot exec script\n");
3972 * We used to do this check as the "plain" user (after swapping
3973 * UIDs). But the check for nosuid and noexec filesystem is needed,
3974 * and should be done even without HAS_SETREUID. (Maybe those
3975 * operating systems do not have such mount options anyway...)
3976 * Seems safe enough to do as root.
3978 # if !defined(NO_NOSUID_CHECK)
3979 if (fd_on_nosuid_fs(PerlIO_fileno(rsfp))) {
3980 Perl_croak(aTHX_ "Setuid script on nosuid or noexec filesystem\n");
3983 # endif /* IAMSUID */
3985 if (!S_ISREG(PL_statbuf.st_mode)) {
3986 Perl_croak(aTHX_ "Setuid script not plain file\n");
3988 if (PL_statbuf.st_mode & S_IWOTH)
3989 Perl_croak(aTHX_ "Setuid/gid script is writable by world");
3990 PL_doswitches = FALSE; /* -s is insecure in suid */
3991 /* PSz 13 Nov 03 But -s was caught elsewhere ... so unsetting it here is useless(?!) */
3992 CopLINE_inc(PL_curcop);
3993 if (sv_gets(linestr_sv, rsfp, 0) == NULL)
3994 Perl_croak(aTHX_ "No #! line");
3995 linestr = SvPV_nolen_const(linestr_sv);
3996 /* required even on Sys V */
3997 if (!*linestr || !linestr[1] || strnNE(linestr,"#!",2))
3998 Perl_croak(aTHX_ "No #! line");
4002 /* Sanity check on line length */
4003 s_end = s + strlen(s);
4004 if (s_end == s || (s_end - s) > 4000)
4005 Perl_croak(aTHX_ "Very long #! line");
4006 /* Allow more than a single space after #! */
4007 while (isSPACE(*s)) s++;
4008 /* Sanity check on buffer end */
4009 while ((*s) && !isSPACE(*s)) s++;
4010 for (s2 = s; (s2 > linestr &&
4011 (isDIGIT(s2[-1]) || s2[-1] == '.' || s2[-1] == '_'
4012 || s2[-1] == '-')); s2--) ;
4013 /* Sanity check on buffer start */
4014 if ( (s2-4 < linestr || strnNE(s2-4,"perl",4)) &&
4015 (s-9 < linestr || strnNE(s-9,"perl",4)) )
4016 Perl_croak(aTHX_ "Not a perl script");
4017 while (*s == ' ' || *s == '\t') s++;
4019 * #! arg must be what we saw above. They can invoke it by
4020 * mentioning suidperl explicitly, but they may not add any strange
4021 * arguments beyond what #! says if they do invoke suidperl that way.
4024 * The way validarg was set up, we rely on the kernel to start
4025 * scripts with argv[1] set to contain all #! line switches (the
4029 * Check that we got all the arguments listed in the #! line (not
4030 * just that there are no extraneous arguments). Might not matter
4031 * much, as switches from #! line seem to be acted upon (also), and
4032 * so may be checked and trapped in perl. But, security checks must
4033 * be done in suidperl and not deferred to perl. Note that suidperl
4034 * does not get around to parsing (and checking) the switches on
4035 * the #! line (but execs perl sooner).
4036 * Allow (require) a trailing newline (which may be of two
4037 * characters on some architectures?) (but no other trailing
4040 len = strlen(validarg);
4041 if (strEQ(validarg," PHOOEY ") ||
4042 strnNE(s,validarg,len) || !isSPACE(s[len]) ||
4043 !((s_end - s) == len+1
4044 || ((s_end - s) == len+2 && isSPACE(s[len+1]))))
4045 Perl_croak(aTHX_ "Args must match #! line");
4049 PL_euid != PL_uid && (PL_statbuf.st_mode & S_ISUID) &&
4050 PL_euid == PL_statbuf.st_uid)
4052 Perl_croak(aTHX_ "YOU HAVEN'T DISABLED SET-ID SCRIPTS IN THE KERNEL YET!\n\
4053 FIX YOUR KERNEL, OR PUT A C WRAPPER AROUND THIS SCRIPT!\n");
4054 # endif /* IAMSUID */
4057 PL_euid) { /* oops, we're not the setuid root perl */
4059 * When root runs a setuid script, we do not go through the same
4060 * steps of execing sperl and then perl with fd scripts, but
4061 * simply set up UIDs within the same perl invocation; so do
4062 * not have the same checks (on options, whatever) that we have
4063 * for plain users. No problem really: would have to be a script
4064 * that does not actually work for plain users; and if root is
4065 * foolish and can be persuaded to run such an unsafe script, he
4066 * might run also non-setuid ones, and deserves what he gets.
4068 * Or, we might drop the PL_euid check above (and rely just on
4069 * fdscript to avoid loops), and do the execs
4075 * Pass fd script to suidperl.
4076 * Exec suidperl, substituting fd script for scriptname.
4077 * Pass script name as "subdir" of fd, which perl will grok;
4078 * in fact will use that to distinguish this from "normal"
4079 * usage, see comments above.
4081 PerlIO_rewind(rsfp);
4082 PerlLIO_lseek(PerlIO_fileno(rsfp),(Off_t)0,0); /* just in case rewind didn't */
4083 /* PSz 27 Feb 04 Sanity checks on scriptname */
4084 if ((!scriptname) || (!*scriptname) ) {
4085 Perl_croak(aTHX_ "No setuid script name\n");
4087 if (*scriptname == '-') {
4088 Perl_croak(aTHX_ "Setuid script name may not begin with dash\n");
4089 /* Or we might confuse it with an option when replacing
4090 * name in argument list, below (though we do pointer, not
4091 * string, comparisons).
4094 for (which = 1; PL_origargv[which] && PL_origargv[which] != scriptname; which++) ;
4095 if (!PL_origargv[which]) {
4096 Perl_croak(aTHX_ "Can't change argv to have fd script\n");
4098 PL_origargv[which] = savepv(Perl_form(aTHX_ "/dev/fd/%d/%s",
4099 PerlIO_fileno(rsfp), PL_origargv[which]));
4100 # if defined(HAS_FCNTL) && defined(F_SETFD)
4101 fcntl(PerlIO_fileno(rsfp),F_SETFD,0); /* ensure no close-on-exec */
4104 PerlProc_execv(Perl_form(aTHX_ "%s/sperl"PERL_FS_VER_FMT, BIN_EXP,
4105 (int)PERL_REVISION, (int)PERL_VERSION,
4106 (int)PERL_SUBVERSION), PL_origargv);
4108 # endif /* IAMSUID */
4109 Perl_croak(aTHX_ "Can't do setuid (cannot exec sperl)\n");
4112 if (PL_statbuf.st_mode & S_ISGID && PL_statbuf.st_gid != PL_egid) {
4114 * This seems back to front: we try HAS_SETEGID first; if not available
4115 * then try HAS_SETREGID; as a last chance we try HAS_SETRESGID. May be OK
4116 * in the sense that we only want to set EGID; but are there any machines
4117 * with either of the latter, but not the former? Same with UID, later.
4120 (void)setegid(PL_statbuf.st_gid);
4122 # ifdef HAS_SETREGID
4123 (void)setregid((Gid_t)-1,PL_statbuf.st_gid);
4125 # ifdef HAS_SETRESGID
4126 (void)setresgid((Gid_t)-1,PL_statbuf.st_gid,(Gid_t)-1);
4128 PerlProc_setgid(PL_statbuf.st_gid);
4132 if (PerlProc_getegid() != PL_statbuf.st_gid)
4133 Perl_croak(aTHX_ "Can't do setegid!\n");
4135 if (PL_statbuf.st_mode & S_ISUID) {
4136 if (PL_statbuf.st_uid != PL_euid)
4138 (void)seteuid(PL_statbuf.st_uid); /* all that for this */
4140 # ifdef HAS_SETREUID
4141 (void)setreuid((Uid_t)-1,PL_statbuf.st_uid);
4143 # ifdef HAS_SETRESUID
4144 (void)setresuid((Uid_t)-1,PL_statbuf.st_uid,(Uid_t)-1);
4146 PerlProc_setuid(PL_statbuf.st_uid);
4150 if (PerlProc_geteuid() != PL_statbuf.st_uid)
4151 Perl_croak(aTHX_ "Can't do seteuid!\n");
4153 else if (PL_uid) { /* oops, mustn't run as root */
4155 (void)seteuid((Uid_t)PL_uid);
4157 # ifdef HAS_SETREUID
4158 (void)setreuid((Uid_t)-1,(Uid_t)PL_uid);
4160 # ifdef HAS_SETRESUID
4161 (void)setresuid((Uid_t)-1,(Uid_t)PL_uid,(Uid_t)-1);
4163 PerlProc_setuid((Uid_t)PL_uid);
4167 if (PerlProc_geteuid() != PL_uid)
4168 Perl_croak(aTHX_ "Can't do seteuid!\n");
4171 if (!cando(S_IXUSR,TRUE,&PL_statbuf))
4172 Perl_croak(aTHX_ "Effective UID cannot exec script\n"); /* they can't do this */
4175 else if (PL_preprocess) /* PSz 13 Nov 03 Caught elsewhere, useless(?!) here */
4176 Perl_croak(aTHX_ "-P not allowed for setuid/setgid script\n");
4177 else if (fdscript < 0 || suidscript != 1)
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 /* for (which = 1; PL_origargv[which] && PL_origargv[which] != scriptname; which++) ; */
4224 /* if (!PL_origargv[which]) { */
4225 /* errno = EPERM; */
4226 /* Perl_croak(aTHX_ "Permission denied\n"); */
4228 /* PL_origargv[which] = savepv(Perl_form(aTHX_ "/dev/fd/%d/%s", */
4229 /* PerlIO_fileno(rsfp), PL_origargv[which])); */
4230 # if defined(HAS_FCNTL) && defined(F_SETFD)
4231 fcntl(PerlIO_fileno(rsfp),F_SETFD,0); /* ensure no close-on-exec */
4234 PerlProc_execv(Perl_form(aTHX_ "%s/perl"PERL_FS_VER_FMT, BIN_EXP,
4235 (int)PERL_REVISION, (int)PERL_VERSION,
4236 (int)PERL_SUBVERSION), PL_origargv);/* try again */
4238 Perl_croak(aTHX_ "Can't do setuid (suidperl cannot exec perl)\n");
4239 # endif /* IAMSUID */
4241 PERL_UNUSED_ARG(fdscript);
4242 PERL_UNUSED_ARG(suidscript);
4243 if (PL_euid != PL_uid || PL_egid != PL_gid) { /* (suidperl doesn't exist, in fact) */
4244 # ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
4245 PERL_UNUSED_ARG(rsfp);
4247 PerlLIO_fstat(PerlIO_fileno(rsfp),&PL_statbuf); /* may be either wrapped or real suid */
4248 if ((PL_euid != PL_uid && PL_euid == PL_statbuf.st_uid && PL_statbuf.st_mode & S_ISUID)
4250 (PL_egid != PL_gid && PL_egid == PL_statbuf.st_gid && PL_statbuf.st_mode & S_ISGID)
4253 Perl_croak(aTHX_ "YOU HAVEN'T DISABLED SET-ID SCRIPTS IN THE KERNEL YET!\n\
4254 FIX YOUR KERNEL, PUT A C WRAPPER AROUND THIS SCRIPT, OR USE -u AND UNDUMP!\n");
4255 # endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4256 /* not set-id, must be wrapped */
4259 PERL_UNUSED_ARG(validarg);
4260 PERL_UNUSED_ARG(scriptname);
4261 PERL_UNUSED_ARG(linestr_sv);
4265 S_find_beginning(pTHX_ SV* linestr_sv, PerlIO *rsfp)
4269 register const char *s2;
4270 #ifdef MACOS_TRADITIONAL
4274 /* skip forward in input to the real script? */
4276 #ifdef MACOS_TRADITIONAL
4277 /* Since the Mac OS does not honor #! arguments for us, we do it ourselves */
4279 while (PL_doextract || gMacPerl_AlwaysExtract) {
4280 if ((s = sv_gets(linestr_sv, rsfp, 0)) == NULL) {
4281 if (!gMacPerl_AlwaysExtract)
4282 Perl_croak(aTHX_ "No Perl script found in input\n");
4284 if (PL_doextract) /* require explicit override ? */
4285 if (!OverrideExtract(PL_origfilename))
4286 Perl_croak(aTHX_ "User aborted script\n");
4288 PL_doextract = FALSE;
4290 /* Pater peccavi, file does not have #! */
4291 PerlIO_rewind(rsfp);
4296 while (PL_doextract) {
4297 if ((s = sv_gets(linestr_sv, rsfp, 0)) == NULL)
4298 Perl_croak(aTHX_ "No Perl script found in input\n");
4301 if (*s == '#' && s[1] == '!' && ((s = instr(s,"perl")) || (s = instr(s2,"PERL")))) {
4302 PerlIO_ungetc(rsfp, '\n'); /* to keep line count right */
4303 PL_doextract = FALSE;
4304 while (*s && !(isSPACE (*s) || *s == '#')) s++;
4306 while (*s == ' ' || *s == '\t') s++;
4308 while (isDIGIT(s2[-1]) || s2[-1] == '-' || s2[-1] == '.'
4309 || s2[-1] == '_') s2--;
4310 if (strnEQ(s2-4,"perl",4))
4311 while ((s = moreswitches(s)))
4314 #ifdef MACOS_TRADITIONAL
4315 /* We are always searching for the #!perl line in MacPerl,
4316 * so if we find it, still keep the line count correct
4317 * by counting lines we already skipped over
4319 for (; maclines > 0 ; maclines--)
4320 PerlIO_ungetc(rsfp, '\n');
4324 /* gMacPerl_AlwaysExtract is false in MPW tool */
4325 } else if (gMacPerl_AlwaysExtract) {
4337 PL_uid = PerlProc_getuid();
4338 PL_euid = PerlProc_geteuid();
4339 PL_gid = PerlProc_getgid();
4340 PL_egid = PerlProc_getegid();
4342 PL_uid |= PL_gid << 16;
4343 PL_euid |= PL_egid << 16;
4345 /* Should not happen: */
4346 CHECK_MALLOC_TAINT(PL_uid && (PL_euid != PL_uid || PL_egid != PL_gid));
4347 PL_tainting |= (PL_uid && (PL_euid != PL_uid || PL_egid != PL_gid));
4350 * Should go by suidscript, not uid!=euid: why disallow
4351 * system("ls") in scripts run from setuid things?
4352 * Or, is this run before we check arguments and set suidscript?
4353 * What about SETUID_SCRIPTS_ARE_SECURE_NOW: could we use fdscript then?
4354 * (We never have suidscript, can we be sure to have fdscript?)
4355 * Or must then go by UID checks? See comments in forbid_setid also.
4359 /* This is used very early in the lifetime of the program,
4360 * before even the options are parsed, so PL_tainting has
4361 * not been initialized properly. */
4363 Perl_doing_taint(int argc, char *argv[], char *envp[])
4365 #ifndef PERL_IMPLICIT_SYS
4366 /* If we have PERL_IMPLICIT_SYS we can't call getuid() et alia
4367 * before we have an interpreter-- and the whole point of this
4368 * function is to be called at such an early stage. If you are on
4369 * a system with PERL_IMPLICIT_SYS but you do have a concept of
4370 * "tainted because running with altered effective ids', you'll
4371 * have to add your own checks somewhere in here. The two most
4372 * known samples of 'implicitness' are Win32 and NetWare, neither
4373 * of which has much of concept of 'uids'. */
4374 int uid = PerlProc_getuid();
4375 int euid = PerlProc_geteuid();
4376 int gid = PerlProc_getgid();
4377 int egid = PerlProc_getegid();
4384 if (uid && (euid != uid || egid != gid))
4386 #endif /* !PERL_IMPLICIT_SYS */
4387 /* This is a really primitive check; environment gets ignored only
4388 * if -T are the first chars together; otherwise one gets
4389 * "Too late" message. */
4390 if ( argc > 1 && argv[1][0] == '-'
4391 && (argv[1][1] == 't' || argv[1][1] == 'T') )
4396 /* Passing the flag as a single char rather than a string is a slight space
4397 optimisation. The only message that isn't /^-.$/ is
4398 "program input from stdin", which is substituted in place of '\0', which
4399 could never be a command line flag. */
4401 S_forbid_setid(pTHX_ const char flag, const int suidscript)
4404 char string[3] = "-x";
4405 const char *message = "program input from stdin";
4412 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
4413 if (PL_euid != PL_uid)
4414 Perl_croak(aTHX_ "No %s allowed while running setuid", message);
4415 if (PL_egid != PL_gid)
4416 Perl_croak(aTHX_ "No %s allowed while running setgid", message);
4417 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4419 * Checks for UID/GID above "wrong": why disallow
4420 * perl -e 'print "Hello\n"'
4421 * from within setuid things?? Simply drop them: replaced by
4422 * fdscript/suidscript and #ifdef IAMSUID checks below.
4424 * This may be too late for command-line switches. Will catch those on
4425 * the #! line, after finding the script name and setting up
4426 * fdscript/suidscript. Note that suidperl does not get around to
4427 * parsing (and checking) the switches on the #! line, but checks that
4428 * the two sets are identical.
4430 * With SETUID_SCRIPTS_ARE_SECURE_NOW, could we use fdscript, also or
4431 * instead, or would that be "too late"? (We never have suidscript, can
4432 * we be sure to have fdscript?)
4434 * Catch things with suidscript (in descendant of suidperl), even with
4435 * right UID/GID. Was already checked in suidperl, with #ifdef IAMSUID,
4436 * below; but I am paranoid.
4438 * Also see comments about root running a setuid script, elsewhere.
4440 if (suidscript >= 0)
4441 Perl_croak(aTHX_ "No %s allowed with (suid) fdscript", message);
4443 /* PSz 11 Nov 03 Catch it in suidperl, always! */
4444 Perl_croak(aTHX_ "No %s allowed in suidperl", message);
4445 #endif /* IAMSUID */
4449 Perl_init_debugger(pTHX)
4452 HV * const ostash = PL_curstash;
4454 PL_curstash = PL_debstash;
4455 PL_dbargs = GvAV(gv_AVadd((gv_fetchpvs("DB::args", GV_ADDMULTI,
4457 AvREAL_off(PL_dbargs);
4458 PL_DBgv = gv_fetchpvs("DB::DB", GV_ADDMULTI, SVt_PVGV);
4459 PL_DBline = gv_fetchpvs("DB::dbline", GV_ADDMULTI, SVt_PVAV);
4460 PL_DBsub = gv_HVadd(gv_fetchpvs("DB::sub", GV_ADDMULTI, SVt_PVHV));
4461 PL_DBsingle = GvSV((gv_fetchpvs("DB::single", GV_ADDMULTI, SVt_PV)));
4462 sv_setiv(PL_DBsingle, 0);
4463 PL_DBtrace = GvSV((gv_fetchpvs("DB::trace", GV_ADDMULTI, SVt_PV)));
4464 sv_setiv(PL_DBtrace, 0);
4465 PL_DBsignal = GvSV((gv_fetchpvs("DB::signal", GV_ADDMULTI, SVt_PV)));
4466 sv_setiv(PL_DBsignal, 0);
4467 PL_curstash = ostash;
4470 #ifndef STRESS_REALLOC
4471 #define REASONABLE(size) (size)
4473 #define REASONABLE(size) (1) /* unreasonable */
4477 Perl_init_stacks(pTHX)
4480 /* start with 128-item stack and 8K cxstack */
4481 PL_curstackinfo = new_stackinfo(REASONABLE(128),
4482 REASONABLE(8192/sizeof(PERL_CONTEXT) - 1));
4483 PL_curstackinfo->si_type = PERLSI_MAIN;
4484 PL_curstack = PL_curstackinfo->si_stack;
4485 PL_mainstack = PL_curstack; /* remember in case we switch stacks */
4487 PL_stack_base = AvARRAY(PL_curstack);
4488 PL_stack_sp = PL_stack_base;
4489 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
4491 Newx(PL_tmps_stack,REASONABLE(128),SV*);
4494 PL_tmps_max = REASONABLE(128);
4496 Newx(PL_markstack,REASONABLE(32),I32);
4497 PL_markstack_ptr = PL_markstack;
4498 PL_markstack_max = PL_markstack + REASONABLE(32);
4502 Newx(PL_scopestack,REASONABLE(32),I32);
4503 PL_scopestack_ix = 0;
4504 PL_scopestack_max = REASONABLE(32);
4506 Newx(PL_savestack,REASONABLE(128),ANY);
4507 PL_savestack_ix = 0;
4508 PL_savestack_max = REASONABLE(128);
4517 while (PL_curstackinfo->si_next)
4518 PL_curstackinfo = PL_curstackinfo->si_next;
4519 while (PL_curstackinfo) {
4520 PERL_SI *p = PL_curstackinfo->si_prev;
4521 /* curstackinfo->si_stack got nuked by sv_free_arenas() */
4522 Safefree(PL_curstackinfo->si_cxstack);
4523 Safefree(PL_curstackinfo);
4524 PL_curstackinfo = p;
4526 Safefree(PL_tmps_stack);
4527 Safefree(PL_markstack);
4528 Safefree(PL_scopestack);
4529 Safefree(PL_savestack);
4534 S_init_predump_symbols(pTHX)
4540 sv_setpvn(get_sv("\"", TRUE), " ", 1);
4541 PL_stdingv = gv_fetchpvs("STDIN", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4542 GvMULTI_on(PL_stdingv);
4543 io = GvIOp(PL_stdingv);
4544 IoTYPE(io) = IoTYPE_RDONLY;
4545 IoIFP(io) = PerlIO_stdin();
4546 tmpgv = gv_fetchpvs("stdin", GV_ADD|GV_NOTQUAL, SVt_PV);
4548 GvIOp(tmpgv) = (IO*)SvREFCNT_inc_simple(io);
4550 tmpgv = gv_fetchpvs("STDOUT", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4553 IoTYPE(io) = IoTYPE_WRONLY;
4554 IoOFP(io) = IoIFP(io) = PerlIO_stdout();
4556 tmpgv = gv_fetchpvs("stdout", GV_ADD|GV_NOTQUAL, SVt_PV);
4558 GvIOp(tmpgv) = (IO*)SvREFCNT_inc_simple(io);
4560 PL_stderrgv = gv_fetchpvs("STDERR", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4561 GvMULTI_on(PL_stderrgv);
4562 io = GvIOp(PL_stderrgv);
4563 IoTYPE(io) = IoTYPE_WRONLY;
4564 IoOFP(io) = IoIFP(io) = PerlIO_stderr();
4565 tmpgv = gv_fetchpvs("stderr", GV_ADD|GV_NOTQUAL, SVt_PV);
4567 GvIOp(tmpgv) = (IO*)SvREFCNT_inc_simple(io);
4569 PL_statname = newSV(0); /* last filename we did stat on */
4571 Safefree(PL_osname);
4572 PL_osname = savepv(OSNAME);
4576 Perl_init_argv_symbols(pTHX_ register int argc, register char **argv)
4579 argc--,argv++; /* skip name of script */
4580 if (PL_doswitches) {
4581 for (; argc > 0 && **argv == '-'; argc--,argv++) {
4585 if (argv[0][1] == '-' && !argv[0][2]) {
4589 if ((s = strchr(argv[0], '='))) {
4590 const char *const start_name = argv[0] + 1;
4591 sv_setpv(GvSV(gv_fetchpvn_flags(start_name, s - start_name,
4592 TRUE, SVt_PV)), s + 1);
4595 sv_setiv(GvSV(gv_fetchpv(argv[0]+1, GV_ADD, SVt_PV)),1);
4598 if ((PL_argvgv = gv_fetchpvs("ARGV", GV_ADD|GV_NOTQUAL, SVt_PVAV))) {
4599 GvMULTI_on(PL_argvgv);
4600 (void)gv_AVadd(PL_argvgv);
4601 av_clear(GvAVn(PL_argvgv));
4602 for (; argc > 0; argc--,argv++) {
4603 SV * const sv = newSVpv(argv[0],0);
4604 av_push(GvAVn(PL_argvgv),sv);
4605 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
4606 if (PL_unicode & PERL_UNICODE_ARGV_FLAG)
4609 if (PL_unicode & PERL_UNICODE_WIDESYSCALLS_FLAG) /* Sarathy? */
4610 (void)sv_utf8_decode(sv);
4616 S_init_postdump_symbols(pTHX_ register int argc, register char **argv, register char **env)
4621 PL_toptarget = newSV_type(SVt_PVFM);
4622 sv_setpvn(PL_toptarget, "", 0);
4623 PL_bodytarget = newSV_type(SVt_PVFM);
4624 sv_setpvn(PL_bodytarget, "", 0);
4625 PL_formtarget = PL_bodytarget;
4629 init_argv_symbols(argc,argv);
4631 if ((tmpgv = gv_fetchpvs("0", GV_ADD|GV_NOTQUAL, SVt_PV))) {
4632 #ifdef MACOS_TRADITIONAL
4633 /* $0 is not majick on a Mac */
4634 sv_setpv(GvSV(tmpgv),MacPerl_MPWFileName(PL_origfilename));
4636 sv_setpv(GvSV(tmpgv),PL_origfilename);
4637 magicname("0", "0", 1);
4640 if ((PL_envgv = gv_fetchpvs("ENV", GV_ADD|GV_NOTQUAL, SVt_PVHV))) {
4642 bool env_is_not_environ;
4643 GvMULTI_on(PL_envgv);
4644 hv = GvHVn(PL_envgv);
4645 hv_magic(hv, NULL, PERL_MAGIC_env);
4647 #ifdef USE_ENVIRON_ARRAY
4648 /* Note that if the supplied env parameter is actually a copy
4649 of the global environ then it may now point to free'd memory
4650 if the environment has been modified since. To avoid this
4651 problem we treat env==NULL as meaning 'use the default'
4655 env_is_not_environ = env != environ;
4656 if (env_is_not_environ
4657 # ifdef USE_ITHREADS
4658 && PL_curinterp == aTHX
4667 for (; *env; env++) {
4668 if (!(s = strchr(*env,'=')) || s == *env)
4670 #if defined(MSDOS) && !defined(DJGPP)
4675 sv = newSVpv(s+1, 0);
4676 (void)hv_store(hv, *env, s - *env, sv, 0);
4677 if (env_is_not_environ)
4681 #endif /* USE_ENVIRON_ARRAY */
4682 #endif /* !PERL_MICRO */
4685 if ((tmpgv = gv_fetchpvs("$", GV_ADD|GV_NOTQUAL, SVt_PV))) {
4686 SvREADONLY_off(GvSV(tmpgv));
4687 sv_setiv(GvSV(tmpgv), (IV)PerlProc_getpid());
4688 SvREADONLY_on(GvSV(tmpgv));
4690 #ifdef THREADS_HAVE_PIDS
4691 PL_ppid = (IV)getppid();
4694 /* touch @F array to prevent spurious warnings 20020415 MJD */
4696 (void) get_av("main::F", TRUE | GV_ADDMULTI);
4701 S_init_perllib(pTHX)
4707 s = PerlEnv_getenv("PERL5LIB");
4709 * It isn't possible to delete an environment variable with
4710 * PERL_USE_SAFE_PUTENV set unless unsetenv() is also available, so in that
4711 * case we treat PERL5LIB as undefined if it has a zero-length value.
4713 #if defined(PERL_USE_SAFE_PUTENV) && ! defined(HAS_UNSETENV)
4714 if (s && *s != '\0')
4718 incpush(s, TRUE, TRUE, TRUE, FALSE);
4720 incpush(PerlEnv_getenv("PERLLIB"), FALSE, FALSE, TRUE, FALSE);
4722 /* Treat PERL5?LIB as a possible search list logical name -- the
4723 * "natural" VMS idiom for a Unix path string. We allow each
4724 * element to be a set of |-separated directories for compatibility.
4728 if (my_trnlnm("PERL5LIB",buf,0))
4729 do { incpush(buf,TRUE,TRUE,TRUE,FALSE); } while (my_trnlnm("PERL5LIB",buf,++idx));
4731 while (my_trnlnm("PERLLIB",buf,idx++)) incpush(buf,FALSE,FALSE,TRUE,FALSE);
4735 /* Use the ~-expanded versions of APPLLIB (undocumented),
4736 ARCHLIB PRIVLIB SITEARCH SITELIB VENDORARCH and VENDORLIB
4739 incpush(APPLLIB_EXP, TRUE, TRUE, TRUE, TRUE);
4743 incpush(ARCHLIB_EXP, FALSE, FALSE, TRUE, TRUE);
4745 #ifdef MACOS_TRADITIONAL
4748 SV * privdir = newSV(0);
4749 char * macperl = PerlEnv_getenv("MACPERL");
4754 Perl_sv_setpvf(aTHX_ privdir, "%slib:", macperl);
4755 if (PerlLIO_stat(SvPVX(privdir), &tmpstatbuf) >= 0 && S_ISDIR(tmpstatbuf.st_mode))
4756 incpush(SvPVX(privdir), TRUE, FALSE, TRUE, FALSE);
4757 Perl_sv_setpvf(aTHX_ privdir, "%ssite_perl:", macperl);
4758 if (PerlLIO_stat(SvPVX(privdir), &tmpstatbuf) >= 0 && S_ISDIR(tmpstatbuf.st_mode))
4759 incpush(SvPVX(privdir), TRUE, FALSE, TRUE, FALSE);
4761 SvREFCNT_dec(privdir);
4764 incpush(":", FALSE, FALSE, TRUE, FALSE);
4767 # define PRIVLIB_EXP "/usr/local/lib/perl5:/usr/local/lib/perl"
4770 incpush(PRIVLIB_EXP, TRUE, FALSE, TRUE, TRUE);
4772 incpush(PRIVLIB_EXP, FALSE, FALSE, TRUE, TRUE);
4776 /* sitearch is always relative to sitelib on Windows for
4777 * DLL-based path intuition to work correctly */
4778 # if !defined(WIN32)
4779 incpush(SITEARCH_EXP, FALSE, FALSE, TRUE, TRUE);
4785 /* this picks up sitearch as well */
4786 incpush(SITELIB_EXP, TRUE, FALSE, TRUE, TRUE);
4788 incpush(SITELIB_EXP, FALSE, FALSE, TRUE, TRUE);
4792 #if defined(SITELIB_STEM) && defined(PERL_INC_VERSION_LIST)
4793 /* Search for version-specific dirs below here */
4794 incpush(SITELIB_STEM, FALSE, TRUE, TRUE, TRUE);
4797 #ifdef PERL_VENDORARCH_EXP
4798 /* vendorarch is always relative to vendorlib on Windows for
4799 * DLL-based path intuition to work correctly */
4800 # if !defined(WIN32)
4801 incpush(PERL_VENDORARCH_EXP, FALSE, FALSE, TRUE, TRUE);
4805 #ifdef PERL_VENDORLIB_EXP
4807 incpush(PERL_VENDORLIB_EXP, TRUE, FALSE, TRUE, TRUE); /* this picks up vendorarch as well */
4809 incpush(PERL_VENDORLIB_EXP, FALSE, FALSE, TRUE, TRUE);
4813 #ifdef PERL_VENDORLIB_STEM /* Search for version-specific dirs below here */
4814 incpush(PERL_VENDORLIB_STEM, FALSE, TRUE, TRUE, TRUE);
4817 #ifdef PERL_OTHERLIBDIRS
4818 incpush(PERL_OTHERLIBDIRS, TRUE, TRUE, TRUE, TRUE);
4822 incpush(".", FALSE, FALSE, TRUE, FALSE);
4823 #endif /* MACOS_TRADITIONAL */
4826 #if defined(DOSISH) || defined(EPOC) || defined(__SYMBIAN32__)
4827 # define PERLLIB_SEP ';'
4830 # define PERLLIB_SEP '|'
4832 # if defined(MACOS_TRADITIONAL)
4833 # define PERLLIB_SEP ','
4835 # define PERLLIB_SEP ':'
4839 #ifndef PERLLIB_MANGLE
4840 # define PERLLIB_MANGLE(s,n) (s)
4843 /* Push a directory onto @INC if it exists.
4844 Generate a new SV if we do this, to save needing to copy the SV we push
4847 S_incpush_if_exists(pTHX_ SV *dir)
4851 if (PerlLIO_stat(SvPVX_const(dir), &tmpstatbuf) >= 0 &&
4852 S_ISDIR(tmpstatbuf.st_mode)) {
4853 av_push(GvAVn(PL_incgv), dir);
4860 S_incpush(pTHX_ const char *dir, bool addsubdirs, bool addoldvers, bool usesep,
4865 const char *p = dir;
4870 if (addsubdirs || addoldvers) {
4874 /* Break at all separators */
4876 SV *libdir = newSV(0);
4879 /* skip any consecutive separators */
4881 while ( *p == PERLLIB_SEP ) {
4882 /* Uncomment the next line for PATH semantics */
4883 /* av_push(GvAVn(PL_incgv), newSVpvs(".")); */
4888 if ( usesep && (s = strchr(p, PERLLIB_SEP)) != NULL ) {
4889 sv_setpvn(libdir, PERLLIB_MANGLE(p, (STRLEN)(s - p)),
4894 sv_setpv(libdir, PERLLIB_MANGLE(p, 0));
4895 p = NULL; /* break out */
4897 #ifdef MACOS_TRADITIONAL
4898 if (!strchr(SvPVX(libdir), ':')) {
4901 sv_setpv(libdir, MacPerl_CanonDir(SvPVX(libdir), buf, 0));
4903 if (SvPVX(libdir)[SvCUR(libdir)-1] != ':')
4904 sv_catpvs(libdir, ":");
4907 /* Do the if() outside the #ifdef to avoid warnings about an unused
4910 #ifdef PERL_RELOCATABLE_INC
4912 * Relocatable include entries are marked with a leading .../
4915 * 0: Remove that leading ".../"
4916 * 1: Remove trailing executable name (anything after the last '/')
4917 * from the perl path to give a perl prefix
4919 * While the @INC element starts "../" and the prefix ends with a real
4920 * directory (ie not . or ..) chop that real directory off the prefix
4921 * and the leading "../" from the @INC element. ie a logical "../"
4923 * Finally concatenate the prefix and the remainder of the @INC element
4924 * The intent is that /usr/local/bin/perl and .../../lib/perl5
4925 * generates /usr/local/lib/perl5
4927 const char *libpath = SvPVX(libdir);
4928 STRLEN libpath_len = SvCUR(libdir);
4929 if (libpath_len >= 4 && memEQ (libpath, ".../", 4)) {
4931 SV * const caret_X = get_sv("\030", 0);
4932 /* Going to use the SV just as a scratch buffer holding a C
4938 /* $^X is *the* source of taint if tainting is on, hence
4939 SvPOK() won't be true. */
4941 assert(SvPOKp(caret_X));
4942 prefix_sv = newSVpvn_flags(SvPVX(caret_X), SvCUR(caret_X),
4944 /* Firstly take off the leading .../
4945 If all else fail we'll do the paths relative to the current
4947 sv_chop(libdir, libpath + 4);
4948 /* Don't use SvPV as we're intentionally bypassing taining,
4949 mortal copies that the mg_get of tainting creates, and
4950 corruption that seems to come via the save stack.
4951 I guess that the save stack isn't correctly set up yet. */
4952 libpath = SvPVX(libdir);
4953 libpath_len = SvCUR(libdir);
4955 /* This would work more efficiently with memrchr, but as it's
4956 only a GNU extension we'd need to probe for it and
4957 implement our own. Not hard, but maybe not worth it? */
4959 prefix = SvPVX(prefix_sv);
4960 lastslash = strrchr(prefix, '/');
4962 /* First time in with the *lastslash = '\0' we just wipe off
4963 the trailing /perl from (say) /usr/foo/bin/perl
4967 while ((*lastslash = '\0'), /* Do that, come what may. */
4968 (libpath_len >= 3 && memEQ(libpath, "../", 3)
4969 && (lastslash = strrchr(prefix, '/')))) {
4970 if (lastslash[1] == '\0'
4971 || (lastslash[1] == '.'
4972 && (lastslash[2] == '/' /* ends "/." */
4973 || (lastslash[2] == '/'
4974 && lastslash[3] == '/' /* or "/.." */
4976 /* Prefix ends "/" or "/." or "/..", any of which
4977 are fishy, so don't do any more logical cleanup.
4981 /* Remove leading "../" from path */
4984 /* Next iteration round the loop removes the last
4985 directory name from prefix by writing a '\0' in
4986 the while clause. */
4988 /* prefix has been terminated with a '\0' to the correct
4989 length. libpath points somewhere into the libdir SV.
4990 We need to join the 2 with '/' and drop the result into
4992 tempsv = Perl_newSVpvf(aTHX_ "%s/%s", prefix, libpath);
4993 SvREFCNT_dec(libdir);
4994 /* And this is the new libdir. */
4997 (PL_uid != PL_euid || PL_gid != PL_egid)) {
4998 /* Need to taint reloccated paths if running set ID */
4999 SvTAINTED_on(libdir);
5002 SvREFCNT_dec(prefix_sv);
5007 * BEFORE pushing libdir onto @INC we may first push version- and
5008 * archname-specific sub-directories.
5010 if (addsubdirs || addoldvers) {
5011 #ifdef PERL_INC_VERSION_LIST
5012 /* Configure terminates PERL_INC_VERSION_LIST with a NULL */
5013 const char * const incverlist[] = { PERL_INC_VERSION_LIST };
5014 const char * const *incver;
5020 if ((unix = tounixspec_ts(SvPV(libdir,len),NULL)) != NULL) {
5022 while (unix[len-1] == '/') len--; /* Cosmetic */
5023 sv_usepvn(libdir,unix,len);
5026 PerlIO_printf(Perl_error_log,
5027 "Failed to unixify @INC element \"%s\"\n",
5031 #ifdef MACOS_TRADITIONAL
5032 #define PERL_AV_SUFFIX_FMT ""
5033 #define PERL_ARCH_FMT "%s:"
5034 #define PERL_ARCH_FMT_PATH PERL_FS_VER_FMT PERL_AV_SUFFIX_FMT
5036 #define PERL_AV_SUFFIX_FMT "/"
5037 #define PERL_ARCH_FMT "/%s"
5038 #define PERL_ARCH_FMT_PATH PERL_AV_SUFFIX_FMT PERL_FS_VER_FMT
5040 /* .../version/archname if -d .../version/archname */
5041 Perl_sv_setpvf(aTHX_ subdir, "%"SVf PERL_ARCH_FMT_PATH PERL_ARCH_FMT,
5043 (int)PERL_REVISION, (int)PERL_VERSION,
5044 (int)PERL_SUBVERSION, ARCHNAME);
5045 subdir = S_incpush_if_exists(aTHX_ subdir);
5047 /* .../version if -d .../version */
5048 Perl_sv_setpvf(aTHX_ subdir, "%"SVf PERL_ARCH_FMT_PATH,
5050 (int)PERL_REVISION, (int)PERL_VERSION,
5051 (int)PERL_SUBVERSION);
5052 subdir = S_incpush_if_exists(aTHX_ subdir);
5054 /* .../archname if -d .../archname */
5055 Perl_sv_setpvf(aTHX_ subdir, "%"SVf PERL_ARCH_FMT,
5056 SVfARG(libdir), ARCHNAME);
5057 subdir = S_incpush_if_exists(aTHX_ subdir);
5061 #ifdef PERL_INC_VERSION_LIST
5063 for (incver = incverlist; *incver; incver++) {
5064 /* .../xxx if -d .../xxx */
5065 Perl_sv_setpvf(aTHX_ subdir, "%"SVf PERL_ARCH_FMT,
5066 SVfARG(libdir), *incver);
5067 subdir = S_incpush_if_exists(aTHX_ subdir);
5073 /* finally push this lib directory on the end of @INC */
5074 av_push(GvAVn(PL_incgv), libdir);
5077 assert (SvREFCNT(subdir) == 1);
5078 SvREFCNT_dec(subdir);
5084 Perl_call_list(pTHX_ I32 oldscope, AV *paramList)
5088 volatile const line_t oldline = PL_curcop ? CopLINE(PL_curcop) : 0;
5094 while (av_len(paramList) >= 0) {
5095 cv = (CV*)av_shift(paramList);
5097 if (paramList == PL_beginav) {
5098 /* save PL_beginav for compiler */
5099 Perl_av_create_and_push(aTHX_ &PL_beginav_save, (SV*)cv);
5101 else if (paramList == PL_checkav) {
5102 /* save PL_checkav for compiler */
5103 Perl_av_create_and_push(aTHX_ &PL_checkav_save, (SV*)cv);
5105 else if (paramList == PL_unitcheckav) {
5106 /* save PL_unitcheckav for compiler */
5107 Perl_av_create_and_push(aTHX_ &PL_unitcheckav_save, (SV*)cv);
5118 PL_madskills |= 16384;
5123 PL_madskills &= ~16384;
5126 (void)SvPV_const(atsv, len);
5128 PL_curcop = &PL_compiling;
5129 CopLINE_set(PL_curcop, oldline);
5130 if (paramList == PL_beginav)
5131 sv_catpvs(atsv, "BEGIN failed--compilation aborted");
5133 Perl_sv_catpvf(aTHX_ atsv,
5134 "%s failed--call queue aborted",
5135 paramList == PL_checkav ? "CHECK"
5136 : paramList == PL_initav ? "INIT"
5137 : paramList == PL_unitcheckav ? "UNITCHECK"
5139 while (PL_scopestack_ix > oldscope)
5142 Perl_croak(aTHX_ "%"SVf"", SVfARG(atsv));
5149 /* my_exit() was called */
5150 while (PL_scopestack_ix > oldscope)
5153 PL_curstash = PL_defstash;
5154 PL_curcop = &PL_compiling;
5155 CopLINE_set(PL_curcop, oldline);
5157 if (PL_statusvalue && !(PL_exit_flags & PERL_EXIT_EXPECTED)) {
5158 if (paramList == PL_beginav)
5159 Perl_croak(aTHX_ "BEGIN failed--compilation aborted");
5161 Perl_croak(aTHX_ "%s failed--call queue aborted",
5162 paramList == PL_checkav ? "CHECK"
5163 : paramList == PL_initav ? "INIT"
5164 : paramList == PL_unitcheckav ? "UNITCHECK"
5171 PL_curcop = &PL_compiling;
5172 CopLINE_set(PL_curcop, oldline);
5175 PerlIO_printf(Perl_error_log, "panic: restartop\n");
5184 Perl_my_exit(pTHX_ U32 status)
5187 DEBUG_S(PerlIO_printf(Perl_debug_log, "my_exit: thread %p, status %lu\n",
5188 (void*)thr, (unsigned long) status));
5197 STATUS_EXIT_SET(status);
5204 Perl_my_failure_exit(pTHX)
5208 /* We have been called to fall on our sword. The desired exit code
5209 * should be already set in STATUS_UNIX, but could be shifted over
5210 * by 8 bits. STATUS_UNIX_EXIT_SET will handle the cases where a
5213 * If an error code has not been set, then force the issue.
5215 if (MY_POSIX_EXIT) {
5217 /* In POSIX_EXIT mode follow Perl documentations and use 255 for
5218 * the exit code when there isn't an error.
5221 if (STATUS_UNIX == 0)
5222 STATUS_UNIX_EXIT_SET(255);
5224 STATUS_UNIX_EXIT_SET(STATUS_UNIX);
5226 /* The exit code could have been set by $? or vmsish which
5227 * means that it may not be fatal. So convert
5228 * success/warning codes to fatal.
5230 if ((STATUS_NATIVE & (STS$K_SEVERE|STS$K_ERROR)) == 0)
5231 STATUS_UNIX_EXIT_SET(255);
5235 /* Traditionally Perl on VMS always expects a Fatal Error. */
5236 if (vaxc$errno & 1) {
5238 /* So force success status to failure */
5239 if (STATUS_NATIVE & 1)
5244 STATUS_UNIX = EINTR; /* In case something cares */
5249 STATUS_NATIVE = vaxc$errno; /* Should already be this */
5251 /* Encode the severity code */
5252 severity = STATUS_NATIVE & STS$M_SEVERITY;
5253 STATUS_UNIX = (severity ? severity : 1) << 8;
5255 /* Perl expects this to be a fatal error */
5256 if (severity != STS$K_SEVERE)
5265 STATUS_UNIX_SET(errno);
5267 exitstatus = STATUS_UNIX >> 8;
5268 if (exitstatus & 255)
5269 STATUS_UNIX_SET(exitstatus);
5271 STATUS_UNIX_SET(255);
5278 S_my_exit_jump(pTHX)
5283 SvREFCNT_dec(PL_e_script);
5287 POPSTACK_TO(PL_mainstack);
5295 read_e_script(pTHX_ int idx, SV *buf_sv, int maxlen)
5298 const char * const p = SvPVX_const(PL_e_script);
5299 const char *nl = strchr(p, '\n');
5301 PERL_UNUSED_ARG(idx);
5302 PERL_UNUSED_ARG(maxlen);
5304 nl = (nl) ? nl+1 : SvEND(PL_e_script);
5306 filter_del(read_e_script);
5309 sv_catpvn(buf_sv, p, nl-p);
5310 sv_chop(PL_e_script, nl);
5316 * c-indentation-style: bsd
5318 * indent-tabs-mode: t
5321 * ex: set ts=8 sts=4 sw=4 noet: