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
876 I32 i = AvFILLp(PL_regex_padav) + 1;
877 SV * const * const ary = AvARRAY(PL_regex_padav);
880 SV * const resv = ary[--i];
882 if (SvFLAGS(resv) & SVf_BREAK) {
883 /* this is PL_reg_curpm, already freed
884 * flag is set in regexec.c:S_regtry
886 SvFLAGS(resv) &= ~SVf_BREAK;
887 /* So stop it pointing to what is now a dead reference. */
892 SvREFCNT_dec(PL_regex_padav);
893 PL_regex_padav = NULL;
897 SvREFCNT_dec((SV*) PL_stashcache);
898 PL_stashcache = NULL;
900 /* loosen bonds of global variables */
902 /* XXX can PL_parser still be non-null here? */
903 if(PL_parser && PL_parser->rsfp) {
904 (void)PerlIO_close(PL_parser->rsfp);
905 PL_parser->rsfp = NULL;
909 Safefree(PL_splitstr);
914 PL_preprocess = FALSE;
920 PL_doswitches = FALSE;
921 PL_dowarn = G_WARN_OFF;
922 PL_doextract = FALSE;
923 PL_sawampersand = FALSE; /* must save all match strings */
926 Safefree(PL_inplace);
928 SvREFCNT_dec(PL_patchlevel);
931 SvREFCNT_dec(PL_e_script);
937 /* magical thingies */
939 SvREFCNT_dec(PL_ofs_sv); /* $, */
942 SvREFCNT_dec(PL_ors_sv); /* $\ */
945 SvREFCNT_dec(PL_rs); /* $/ */
948 Safefree(PL_osname); /* $^O */
951 SvREFCNT_dec(PL_statname);
955 /* defgv, aka *_ should be taken care of elsewhere */
957 /* clean up after study() */
958 SvREFCNT_dec(PL_lastscream);
959 PL_lastscream = NULL;
960 Safefree(PL_screamfirst);
962 Safefree(PL_screamnext);
966 Safefree(PL_efloatbuf);
970 /* startup and shutdown function lists */
971 SvREFCNT_dec(PL_beginav);
972 SvREFCNT_dec(PL_beginav_save);
973 SvREFCNT_dec(PL_endav);
974 SvREFCNT_dec(PL_checkav);
975 SvREFCNT_dec(PL_checkav_save);
976 SvREFCNT_dec(PL_unitcheckav);
977 SvREFCNT_dec(PL_unitcheckav_save);
978 SvREFCNT_dec(PL_initav);
980 PL_beginav_save = NULL;
983 PL_checkav_save = NULL;
984 PL_unitcheckav = NULL;
985 PL_unitcheckav_save = NULL;
988 /* shortcuts just get cleared */
997 PL_last_in_gv = NULL;
1009 SvREFCNT_dec(PL_argvout_stack);
1010 PL_argvout_stack = NULL;
1012 SvREFCNT_dec(PL_modglobal);
1013 PL_modglobal = NULL;
1014 SvREFCNT_dec(PL_preambleav);
1015 PL_preambleav = NULL;
1016 SvREFCNT_dec(PL_subname);
1018 #ifdef PERL_USES_PL_PIDSTATUS
1019 SvREFCNT_dec(PL_pidstatus);
1020 PL_pidstatus = NULL;
1022 SvREFCNT_dec(PL_toptarget);
1023 PL_toptarget = NULL;
1024 SvREFCNT_dec(PL_bodytarget);
1025 PL_bodytarget = NULL;
1026 PL_formtarget = NULL;
1028 /* free locale stuff */
1029 #ifdef USE_LOCALE_COLLATE
1030 Safefree(PL_collation_name);
1031 PL_collation_name = NULL;
1034 #ifdef USE_LOCALE_NUMERIC
1035 Safefree(PL_numeric_name);
1036 PL_numeric_name = NULL;
1037 SvREFCNT_dec(PL_numeric_radix_sv);
1038 PL_numeric_radix_sv = NULL;
1041 /* clear utf8 character classes */
1042 SvREFCNT_dec(PL_utf8_alnum);
1043 SvREFCNT_dec(PL_utf8_alnumc);
1044 SvREFCNT_dec(PL_utf8_ascii);
1045 SvREFCNT_dec(PL_utf8_alpha);
1046 SvREFCNT_dec(PL_utf8_space);
1047 SvREFCNT_dec(PL_utf8_cntrl);
1048 SvREFCNT_dec(PL_utf8_graph);
1049 SvREFCNT_dec(PL_utf8_digit);
1050 SvREFCNT_dec(PL_utf8_upper);
1051 SvREFCNT_dec(PL_utf8_lower);
1052 SvREFCNT_dec(PL_utf8_print);
1053 SvREFCNT_dec(PL_utf8_punct);
1054 SvREFCNT_dec(PL_utf8_xdigit);
1055 SvREFCNT_dec(PL_utf8_mark);
1056 SvREFCNT_dec(PL_utf8_toupper);
1057 SvREFCNT_dec(PL_utf8_totitle);
1058 SvREFCNT_dec(PL_utf8_tolower);
1059 SvREFCNT_dec(PL_utf8_tofold);
1060 SvREFCNT_dec(PL_utf8_idstart);
1061 SvREFCNT_dec(PL_utf8_idcont);
1062 PL_utf8_alnum = NULL;
1063 PL_utf8_alnumc = NULL;
1064 PL_utf8_ascii = NULL;
1065 PL_utf8_alpha = NULL;
1066 PL_utf8_space = NULL;
1067 PL_utf8_cntrl = NULL;
1068 PL_utf8_graph = NULL;
1069 PL_utf8_digit = NULL;
1070 PL_utf8_upper = NULL;
1071 PL_utf8_lower = NULL;
1072 PL_utf8_print = NULL;
1073 PL_utf8_punct = NULL;
1074 PL_utf8_xdigit = NULL;
1075 PL_utf8_mark = NULL;
1076 PL_utf8_toupper = NULL;
1077 PL_utf8_totitle = NULL;
1078 PL_utf8_tolower = NULL;
1079 PL_utf8_tofold = NULL;
1080 PL_utf8_idstart = NULL;
1081 PL_utf8_idcont = NULL;
1083 if (!specialWARN(PL_compiling.cop_warnings))
1084 PerlMemShared_free(PL_compiling.cop_warnings);
1085 PL_compiling.cop_warnings = NULL;
1086 Perl_refcounted_he_free(aTHX_ PL_compiling.cop_hints_hash);
1087 PL_compiling.cop_hints_hash = NULL;
1088 CopFILE_free(&PL_compiling);
1089 CopSTASH_free(&PL_compiling);
1091 /* Prepare to destruct main symbol table. */
1096 SvREFCNT_dec(PL_curstname);
1097 PL_curstname = NULL;
1099 /* clear queued errors */
1100 SvREFCNT_dec(PL_errors);
1103 SvREFCNT_dec(PL_isarev);
1106 if (destruct_level >= 2 && ckWARN_d(WARN_INTERNAL)) {
1107 if (PL_scopestack_ix != 0)
1108 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
1109 "Unbalanced scopes: %ld more ENTERs than LEAVEs\n",
1110 (long)PL_scopestack_ix);
1111 if (PL_savestack_ix != 0)
1112 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
1113 "Unbalanced saves: %ld more saves than restores\n",
1114 (long)PL_savestack_ix);
1115 if (PL_tmps_floor != -1)
1116 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced tmps: %ld more allocs than frees\n",
1117 (long)PL_tmps_floor + 1);
1118 if (cxstack_ix != -1)
1119 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced context: %ld more PUSHes than POPs\n",
1120 (long)cxstack_ix + 1);
1123 /* Now absolutely destruct everything, somehow or other, loops or no. */
1124 SvFLAGS(PL_fdpid) |= SVTYPEMASK; /* don't clean out pid table now */
1125 SvFLAGS(PL_strtab) |= SVTYPEMASK; /* don't clean out strtab now */
1127 /* the 2 is for PL_fdpid and PL_strtab */
1128 while (PL_sv_count > 2 && sv_clean_all())
1131 SvFLAGS(PL_fdpid) &= ~SVTYPEMASK;
1132 SvFLAGS(PL_fdpid) |= SVt_PVAV;
1133 SvFLAGS(PL_strtab) &= ~SVTYPEMASK;
1134 SvFLAGS(PL_strtab) |= SVt_PVHV;
1136 AvREAL_off(PL_fdpid); /* no surviving entries */
1137 SvREFCNT_dec(PL_fdpid); /* needed in io_close() */
1140 #ifdef HAVE_INTERP_INTERN
1144 /* Destruct the global string table. */
1146 /* Yell and reset the HeVAL() slots that are still holding refcounts,
1147 * so that sv_free() won't fail on them.
1148 * Now that the global string table is using a single hunk of memory
1149 * for both HE and HEK, we either need to explicitly unshare it the
1150 * correct way, or actually free things here.
1153 const I32 max = HvMAX(PL_strtab);
1154 HE * const * const array = HvARRAY(PL_strtab);
1155 HE *hent = array[0];
1158 if (hent && ckWARN_d(WARN_INTERNAL)) {
1159 HE * const next = HeNEXT(hent);
1160 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
1161 "Unbalanced string table refcount: (%ld) for \"%s\"",
1162 (long)hent->he_valu.hent_refcount, HeKEY(hent));
1169 hent = array[riter];
1174 HvARRAY(PL_strtab) = 0;
1175 HvTOTALKEYS(PL_strtab) = 0;
1176 HvFILL(PL_strtab) = 0;
1178 SvREFCNT_dec(PL_strtab);
1181 /* free the pointer tables used for cloning */
1182 ptr_table_free(PL_ptr_table);
1183 PL_ptr_table = (PTR_TBL_t*)NULL;
1186 /* free special SVs */
1188 SvREFCNT(&PL_sv_yes) = 0;
1189 sv_clear(&PL_sv_yes);
1190 SvANY(&PL_sv_yes) = NULL;
1191 SvFLAGS(&PL_sv_yes) = 0;
1193 SvREFCNT(&PL_sv_no) = 0;
1194 sv_clear(&PL_sv_no);
1195 SvANY(&PL_sv_no) = NULL;
1196 SvFLAGS(&PL_sv_no) = 0;
1200 for (i=0; i<=2; i++) {
1201 SvREFCNT(PERL_DEBUG_PAD(i)) = 0;
1202 sv_clear(PERL_DEBUG_PAD(i));
1203 SvANY(PERL_DEBUG_PAD(i)) = NULL;
1204 SvFLAGS(PERL_DEBUG_PAD(i)) = 0;
1208 if (PL_sv_count != 0 && ckWARN_d(WARN_INTERNAL))
1209 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Scalars leaked: %ld\n", (long)PL_sv_count);
1211 #ifdef DEBUG_LEAKING_SCALARS
1212 if (PL_sv_count != 0) {
1217 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
1218 svend = &sva[SvREFCNT(sva)];
1219 for (sv = sva + 1; sv < svend; ++sv) {
1220 if (SvTYPE(sv) != SVTYPEMASK) {
1221 PerlIO_printf(Perl_debug_log, "leaked: sv=0x%p"
1223 " refcnt=%"UVuf pTHX__FORMAT "\n"
1224 "\tallocated at %s:%d %s %s%s\n",
1225 (void*)sv, (UV)sv->sv_flags, (UV)sv->sv_refcnt
1227 sv->sv_debug_file ? sv->sv_debug_file : "(unknown)",
1229 sv->sv_debug_inpad ? "for" : "by",
1230 sv->sv_debug_optype ?
1231 PL_op_name[sv->sv_debug_optype]: "(none)",
1232 sv->sv_debug_cloned ? " (cloned)" : ""
1234 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1235 Perl_dump_sv_child(aTHX_ sv);
1241 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1245 /* Wait for up to 4 seconds for child to terminate.
1246 This seems to be the least effort way of timing out on reaping
1248 struct timeval waitfor = {4, 0};
1249 int sock = PL_dumper_fd;
1253 FD_SET(sock, &rset);
1254 select(sock + 1, &rset, NULL, NULL, &waitfor);
1255 waitpid(child, &status, WNOHANG);
1260 #ifdef DEBUG_LEAKING_SCALARS_ABORT
1266 #ifdef PERL_DEBUG_READONLY_OPS
1272 #if defined(PERLIO_LAYERS)
1273 /* No more IO - including error messages ! */
1274 PerlIO_cleanup(aTHX);
1277 /* sv_undef needs to stay immortal until after PerlIO_cleanup
1278 as currently layers use it rather than NULL as a marker
1279 for no arg - and will try and SvREFCNT_dec it.
1281 SvREFCNT(&PL_sv_undef) = 0;
1282 SvREADONLY_off(&PL_sv_undef);
1284 Safefree(PL_origfilename);
1285 PL_origfilename = NULL;
1286 Safefree(PL_reg_start_tmp);
1287 PL_reg_start_tmp = (char**)NULL;
1288 PL_reg_start_tmpl = 0;
1289 Safefree(PL_reg_curpm);
1290 Safefree(PL_reg_poscache);
1291 free_tied_hv_pool();
1292 Safefree(PL_op_mask);
1293 Safefree(PL_psig_ptr);
1294 PL_psig_ptr = (SV**)NULL;
1295 Safefree(PL_psig_name);
1296 PL_psig_name = (SV**)NULL;
1297 Safefree(PL_bitcount);
1299 Safefree(PL_psig_pend);
1300 PL_psig_pend = (int*)NULL;
1303 PL_tainting = FALSE;
1304 PL_taint_warn = FALSE;
1305 PL_hints = 0; /* Reset hints. Should hints be per-interpreter ? */
1308 DEBUG_P(debprofdump());
1310 #ifdef USE_REENTRANT_API
1311 Perl_reentrant_free(aTHX);
1316 while (PL_regmatch_slab) {
1317 regmatch_slab *s = PL_regmatch_slab;
1318 PL_regmatch_slab = PL_regmatch_slab->next;
1322 /* As the absolutely last thing, free the non-arena SV for mess() */
1325 /* we know that type == SVt_PVMG */
1327 /* it could have accumulated taint magic */
1330 for (mg = SvMAGIC(PL_mess_sv); mg; mg = moremagic) {
1331 moremagic = mg->mg_moremagic;
1332 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global
1334 Safefree(mg->mg_ptr);
1338 /* we know that type >= SVt_PV */
1339 SvPV_free(PL_mess_sv);
1340 Safefree(SvANY(PL_mess_sv));
1341 Safefree(PL_mess_sv);
1348 =for apidoc perl_free
1350 Releases a Perl interpreter. See L<perlembed>.
1360 if (PL_veto_cleanup)
1363 #ifdef PERL_TRACK_MEMPOOL
1366 * Don't free thread memory if PERL_DESTRUCT_LEVEL is set to a non-zero
1367 * value as we're probably hunting memory leaks then
1369 const char * const s = PerlEnv_getenv("PERL_DESTRUCT_LEVEL");
1370 if (!s || atoi(s) == 0) {
1371 /* Emulate the PerlHost behaviour of free()ing all memory allocated in this
1372 thread at thread exit. */
1373 while(aTHXx->Imemory_debug_header.next != &(aTHXx->Imemory_debug_header))
1374 safesysfree(sTHX + (char *)(aTHXx->Imemory_debug_header.next));
1379 #if defined(WIN32) || defined(NETWARE)
1380 # if defined(PERL_IMPLICIT_SYS)
1383 void *host = nw_internal_host;
1385 void *host = w32_internal_host;
1387 PerlMem_free(aTHXx);
1389 nw_delete_internal_host(host);
1391 win32_delete_internal_host(host);
1395 PerlMem_free(aTHXx);
1398 PerlMem_free(aTHXx);
1402 #if defined(USE_ITHREADS)
1403 /* provide destructors to clean up the thread key when libperl is unloaded */
1404 #ifndef WIN32 /* handled during DLL_PROCESS_DETACH in win32/perllib.c */
1406 #if defined(__hpux) && !(defined(__ux_version) && __ux_version <= 1020) && !defined(__GNUC__)
1407 #pragma fini "perl_fini"
1408 #elif defined(__sun) && !defined(__GNUC__)
1409 #pragma fini (perl_fini)
1413 #if defined(__GNUC__)
1414 __attribute__((destructor))
1419 if (PL_curinterp && !PL_veto_cleanup)
1424 #endif /* THREADS */
1427 Perl_call_atexit(pTHX_ ATEXIT_t fn, void *ptr)
1430 Renew(PL_exitlist, PL_exitlistlen+1, PerlExitListEntry);
1431 PL_exitlist[PL_exitlistlen].fn = fn;
1432 PL_exitlist[PL_exitlistlen].ptr = ptr;
1436 #ifdef HAS_PROCSELFEXE
1437 /* This is a function so that we don't hold on to MAXPATHLEN
1438 bytes of stack longer than necessary
1441 S_procself_val(pTHX_ SV *sv, const char *arg0)
1443 char buf[MAXPATHLEN];
1444 int len = readlink(PROCSELFEXE_PATH, buf, sizeof(buf) - 1);
1446 /* On Playstation2 Linux V1.0 (kernel 2.2.1) readlink(/proc/self/exe)
1447 includes a spurious NUL which will cause $^X to fail in system
1448 or backticks (this will prevent extensions from being built and
1449 many tests from working). readlink is not meant to add a NUL.
1450 Normal readlink works fine.
1452 if (len > 0 && buf[len-1] == '\0') {
1456 /* FreeBSD's implementation is acknowledged to be imperfect, sometimes
1457 returning the text "unknown" from the readlink rather than the path
1458 to the executable (or returning an error from the readlink). Any valid
1459 path has a '/' in it somewhere, so use that to validate the result.
1460 See http://www.freebsd.org/cgi/query-pr.cgi?pr=35703
1462 if (len > 0 && memchr(buf, '/', len)) {
1463 sv_setpvn(sv,buf,len);
1469 #endif /* HAS_PROCSELFEXE */
1472 S_set_caret_X(pTHX) {
1474 GV* tmpgv = gv_fetchpvs("\030", GV_ADD|GV_NOTQUAL, SVt_PV); /* $^X */
1476 #ifdef HAS_PROCSELFEXE
1477 S_procself_val(aTHX_ GvSV(tmpgv), PL_origargv[0]);
1480 sv_setpv(GvSVn(tmpgv), os2_execname(aTHX));
1482 sv_setpv(GvSVn(tmpgv),PL_origargv[0]);
1489 =for apidoc perl_parse
1491 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
1497 perl_parse(pTHXx_ XSINIT_t xsinit, int argc, char **argv, char **env)
1504 PERL_UNUSED_ARG(my_perl);
1506 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
1509 Perl_croak(aTHX_ "suidperl is no longer needed since the kernel can now execute\n\
1510 setuid perl scripts securely.\n");
1511 #endif /* IAMSUID */
1514 #if defined(USE_HASH_SEED) || defined(USE_HASH_SEED_EXPLICIT)
1515 /* [perl #22371] Algorimic Complexity Attack on Perl 5.6.1, 5.8.0
1516 * This MUST be done before any hash stores or fetches take place.
1517 * If you set PL_rehash_seed (and assumedly also PL_rehash_seed_set)
1518 * yourself, it is your responsibility to provide a good random seed!
1519 * You can also define PERL_HASH_SEED in compile time, see hv.h. */
1520 if (!PL_rehash_seed_set)
1521 PL_rehash_seed = get_hash_seed();
1523 const char * const s = PerlEnv_getenv("PERL_HASH_SEED_DEBUG");
1525 if (s && (atoi(s) == 1))
1526 PerlIO_printf(Perl_debug_log, "HASH_SEED = %"UVuf"\n", PL_rehash_seed);
1528 #endif /* #if defined(USE_HASH_SEED) || defined(USE_HASH_SEED_EXPLICIT) */
1533 if (PL_origalen != 0) {
1534 PL_origalen = 1; /* don't use old PL_origalen if perl_parse() is called again */
1537 /* Set PL_origalen be the sum of the contiguous argv[]
1538 * elements plus the size of the env in case that it is
1539 * contiguous with the argv[]. This is used in mg.c:Perl_magic_set()
1540 * as the maximum modifiable length of $0. In the worst case
1541 * the area we are able to modify is limited to the size of
1542 * the original argv[0]. (See below for 'contiguous', though.)
1544 const char *s = NULL;
1547 ~(UV)(PTRSIZE == 4 ? 3 : PTRSIZE == 8 ? 7 : PTRSIZE == 16 ? 15 : 0);
1548 /* Do the mask check only if the args seem like aligned. */
1550 (mask < ~(UV)0) && ((PTR2UV(argv[0]) & mask) == PTR2UV(argv[0]));
1552 /* See if all the arguments are contiguous in memory. Note
1553 * that 'contiguous' is a loose term because some platforms
1554 * align the argv[] and the envp[]. If the arguments look
1555 * like non-aligned, assume that they are 'strictly' or
1556 * 'traditionally' contiguous. If the arguments look like
1557 * aligned, we just check that they are within aligned
1558 * PTRSIZE bytes. As long as no system has something bizarre
1559 * like the argv[] interleaved with some other data, we are
1560 * fine. (Did I just evoke Murphy's Law?) --jhi */
1561 if (PL_origargv && PL_origargc >= 1 && (s = PL_origargv[0])) {
1563 for (i = 1; i < PL_origargc; i++) {
1564 if ((PL_origargv[i] == s + 1
1566 || PL_origargv[i] == s + 2
1571 (PL_origargv[i] > s &&
1573 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1584 #ifndef PERL_USE_SAFE_PUTENV
1585 /* Can we grab env area too to be used as the area for $0? */
1586 if (s && PL_origenviron && !PL_use_safe_putenv) {
1587 if ((PL_origenviron[0] == s + 1)
1590 (PL_origenviron[0] > s &&
1591 PL_origenviron[0] <=
1592 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1595 #ifndef OS2 /* ENVIRON is read by the kernel too. */
1596 s = PL_origenviron[0];
1599 my_setenv("NoNe SuCh", NULL);
1600 /* Force copy of environment. */
1601 for (i = 1; PL_origenviron[i]; i++) {
1602 if (PL_origenviron[i] == s + 1
1605 (PL_origenviron[i] > s &&
1606 PL_origenviron[i] <=
1607 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1610 s = PL_origenviron[i];
1618 #endif /* !defined(PERL_USE_SAFE_PUTENV) */
1620 PL_origalen = s ? s - PL_origargv[0] + 1 : 0;
1625 /* Come here if running an undumped a.out. */
1627 PL_origfilename = savepv(argv[0]);
1628 PL_do_undump = FALSE;
1629 cxstack_ix = -1; /* start label stack again */
1631 assert (!PL_tainted);
1633 S_set_caret_X(aTHX);
1635 init_postdump_symbols(argc,argv,env);
1640 op_free(PL_main_root);
1641 PL_main_root = NULL;
1643 PL_main_start = NULL;
1644 SvREFCNT_dec(PL_main_cv);
1648 oldscope = PL_scopestack_ix;
1649 PL_dowarn = G_WARN_OFF;
1654 parse_body(env,xsinit);
1656 call_list(oldscope, PL_unitcheckav);
1658 call_list(oldscope, PL_checkav);
1665 /* my_exit() was called */
1666 while (PL_scopestack_ix > oldscope)
1669 PL_curstash = PL_defstash;
1671 call_list(oldscope, PL_unitcheckav);
1673 call_list(oldscope, PL_checkav);
1677 PerlIO_printf(Perl_error_log, "panic: top_env\n");
1686 S_parse_body(pTHX_ char **env, XSINIT_t xsinit)
1690 int argc = PL_origargc;
1691 char **argv = PL_origargv;
1692 const char *scriptname = NULL;
1693 VOL bool dosearch = FALSE;
1694 const char *validarg = "";
1697 const char *cddir = NULL;
1698 #ifdef USE_SITECUSTOMIZE
1699 bool minus_f = FALSE;
1701 SV *linestr_sv = newSV_type(SVt_PVIV);
1702 bool add_read_e_script = FALSE;
1704 SvGROW(linestr_sv, 80);
1705 sv_setpvn(linestr_sv,"",0);
1707 sv = newSVpvs(""); /* first used for -I flags */
1713 for (argc--,argv++; argc > 0; argc--,argv++) {
1714 if (argv[0][0] != '-' || !argv[0][1])
1718 validarg = " PHOOEY ";
1722 * Can we rely on the kernel to start scripts with argv[1] set to
1723 * contain all #! line switches (the whole line)? (argv[0] is set to
1724 * the interpreter name, argv[2] to the script name; argv[3] and
1725 * above may contain other arguments.)
1732 #ifndef PERL_STRICT_CR
1756 if ((s = moreswitches(s)))
1761 CHECK_MALLOC_TOO_LATE_FOR('t');
1762 if( !PL_tainting ) {
1763 PL_taint_warn = TRUE;
1769 CHECK_MALLOC_TOO_LATE_FOR('T');
1771 PL_taint_warn = FALSE;
1779 #ifdef MACOS_TRADITIONAL
1780 /* ignore -e for Dev:Pseudo argument */
1781 if (argv[1] && !strcmp(argv[1], "Dev:Pseudo"))
1784 forbid_setid('e', -1);
1786 PL_e_script = newSVpvs("");
1787 add_read_e_script = TRUE;
1790 sv_catpv(PL_e_script, s);
1792 sv_catpv(PL_e_script, argv[1]);
1796 Perl_croak(aTHX_ "No code specified for -%c", c);
1797 sv_catpvs(PL_e_script, "\n");
1801 #ifdef USE_SITECUSTOMIZE
1807 case 'I': /* -I handled both here and in moreswitches() */
1808 forbid_setid('I', -1);
1809 if (!*++s && (s=argv[1]) != NULL) {
1813 STRLEN len = strlen(s);
1814 const char * const p = savepvn(s, len);
1815 incpush(p, TRUE, TRUE, FALSE, FALSE);
1816 sv_catpvs(sv, "-I");
1817 sv_catpvn(sv, p, len);
1822 Perl_croak(aTHX_ "No directory specified for -I");
1825 forbid_setid('P', -1);
1826 PL_preprocess = TRUE;
1831 forbid_setid('S', -1);
1839 Perl_av_create_and_push(aTHX_ &PL_preambleav, newSVpvs("use Config;"));
1841 /* Can't do newSVpvs() as that would involve pre-processor
1842 condititionals inside a macro expansion. */
1843 opts_prog = Perl_newSVpv(aTHX_ "$_ = join ' ', sort qw("
1850 # ifdef PERL_DONT_CREATE_GVSV
1851 " PERL_DONT_CREATE_GVSV"
1853 # ifdef PERL_MALLOC_WRAP
1856 # ifdef PERL_MEM_LOG
1859 # ifdef PERL_MEM_LOG_ENV
1862 # ifdef PERL_MEM_LOG_ENV_FD
1863 " PERL_MEM_LOG_ENV_FD"
1865 # ifdef PERL_MEM_LOG_STDERR
1866 " PERL_MEM_LOG_STDERR"
1868 # ifdef PERL_MEM_LOG_TIMESTAMP
1869 " PERL_MEM_LOG_TIMESTAMP"
1871 # ifdef PERL_USE_SAFE_PUTENV
1872 " PERL_USE_SAFE_PUTENV"
1874 # ifdef USE_SITECUSTOMIZE
1875 " USE_SITECUSTOMIZE"
1879 sv_catpv(opts_prog, PL_bincompat_options);
1880 /* Terminate the qw(, and then wrap at 76 columns. */
1881 sv_catpvs(opts_prog, "); s/(?=.{53})(.{1,53}) /$1\\n /mg;print Config::myconfig(),");
1883 sv_catpvs(opts_prog,"\"\\nCharacteristics of this PERLSHR image: \\n");
1885 sv_catpvs(opts_prog,"\"\\nCharacteristics of this binary (from libperl): \\n");
1888 sv_catpvs(opts_prog," Compile-time options: $_\\n\",");
1890 #if defined(LOCAL_PATCH_COUNT)
1891 if (LOCAL_PATCH_COUNT > 0) {
1893 sv_catpvs(opts_prog,
1894 "\" Locally applied patches:\\n\",");
1895 for (i = 1; i <= LOCAL_PATCH_COUNT; i++) {
1896 if (PL_localpatches[i])
1897 Perl_sv_catpvf(aTHX_ opts_prog,"q%c\t%s\n%c,",
1898 0, PL_localpatches[i], 0);
1902 Perl_sv_catpvf(aTHX_ opts_prog,
1903 "\" Built under %s\\n",OSNAME);
1906 Perl_sv_catpvf(aTHX_ opts_prog,
1907 " Compiled at %s %s\\n\"",__DATE__,
1910 Perl_sv_catpvf(aTHX_ opts_prog," Compiled on %s\\n\"",
1914 sv_catpvs(opts_prog, "; $\"=\"\\n \"; "
1915 "@env = map { \"$_=\\\"$ENV{$_}\\\"\" } "
1916 "sort grep {/^PERL/} keys %ENV; ");
1918 sv_catpvs(opts_prog,
1919 "push @env, \"CYGWIN=\\\"$ENV{CYGWIN}\\\"\";");
1921 sv_catpvs(opts_prog,
1922 "print \" \\%ENV:\\n @env\\n\" if @env;"
1923 "print \" \\@INC:\\n @INC\\n\";");
1927 opts_prog = Perl_newSVpvf(aTHX_
1928 "Config::config_vars(qw%c%s%c)",
1932 av_push(PL_preambleav, opts_prog);
1933 /* don't look for script or read stdin */
1934 scriptname = BIT_BUCKET;
1938 PL_doextract = TRUE;
1946 if (!*++s || isSPACE(*s)) {
1950 /* catch use of gnu style long options */
1951 if (strEQ(s, "version")) {
1955 if (strEQ(s, "help")) {
1962 Perl_croak(aTHX_ "Unrecognized switch: -%s (-h will show valid options)",s);
1973 #ifndef SECURE_INTERNAL_GETENV
1976 (s = PerlEnv_getenv("PERL5OPT")))
1978 const char *popt = s;
1981 if (*s == '-' && *(s+1) == 'T') {
1982 CHECK_MALLOC_TOO_LATE_FOR('T');
1984 PL_taint_warn = FALSE;
1987 char *popt_copy = NULL;
2000 if (!strchr("CDIMUdmtw", *s))
2001 Perl_croak(aTHX_ "Illegal switch in PERL5OPT: -%c", *s);
2005 popt_copy = SvPVX(sv_2mortal(newSVpv(popt,0)));
2006 s = popt_copy + (s - popt);
2007 d = popt_copy + (d - popt);
2014 if( !PL_tainting ) {
2015 PL_taint_warn = TRUE;
2026 #ifdef USE_SITECUSTOMIZE
2028 (void)Perl_av_create_and_unshift_one(aTHX_ &PL_preambleav,
2029 Perl_newSVpvf(aTHX_ "BEGIN { do '%s/sitecustomize.pl' }", SITELIB_EXP));
2034 scriptname = argv[0];
2037 scriptname = BIT_BUCKET; /* don't look for script or read stdin */
2039 else if (scriptname == NULL) {
2041 if ( PerlLIO_isatty(PerlIO_fileno(PerlIO_stdin())) )
2047 /* Set $^X early so that it can be used for relocatable paths in @INC */
2048 assert (!PL_tainted);
2050 S_set_caret_X(aTHX);
2057 = open_script(scriptname, dosearch, sv, &suidscript, &rsfp);
2059 validate_suid(validarg, scriptname, fdscript, suidscript,
2063 # if defined(SIGCHLD) || defined(SIGCLD)
2066 # define SIGCHLD SIGCLD
2068 Sighandler_t sigstate = rsignal_state(SIGCHLD);
2069 if (sigstate == (Sighandler_t) SIG_IGN) {
2070 if (ckWARN(WARN_SIGNAL))
2071 Perl_warner(aTHX_ packWARN(WARN_SIGNAL),
2072 "Can't ignore signal CHLD, forcing to default");
2073 (void)rsignal(SIGCHLD, (Sighandler_t)SIG_DFL);
2080 #ifdef MACOS_TRADITIONAL
2081 || gMacPerl_AlwaysExtract
2085 /* This will croak if suidscript is >= 0, as -x cannot be used with
2087 forbid_setid('x', suidscript);
2088 /* Hence you can't get here if suidscript >= 0 */
2090 find_beginning(linestr_sv, rsfp);
2091 if (cddir && PerlDir_chdir( (char *)cddir ) < 0)
2092 Perl_croak(aTHX_ "Can't chdir to %s",cddir);
2096 PL_main_cv = PL_compcv = (CV*)newSV_type(SVt_PVCV);
2097 CvUNIQUE_on(PL_compcv);
2099 CvPADLIST(PL_compcv) = pad_new(0);
2101 PL_isarev = newHV();
2104 boot_core_UNIVERSAL();
2105 boot_core_xsutils();
2109 (*xsinit)(aTHX); /* in case linked C routines want magical variables */
2111 #if defined(VMS) || defined(WIN32) || defined(DJGPP) || defined(__CYGWIN__) || defined(EPOC) || defined(SYMBIAN)
2117 # ifdef HAS_SOCKS5_INIT
2118 socks5_init(argv[0]);
2124 init_predump_symbols();
2125 /* init_postdump_symbols not currently designed to be called */
2126 /* more than once (ENV isn't cleared first, for example) */
2127 /* But running with -u leaves %ENV & @ARGV undefined! XXX */
2129 init_postdump_symbols(argc,argv,env);
2131 /* PL_unicode is turned on by -C, or by $ENV{PERL_UNICODE},
2132 * or explicitly in some platforms.
2133 * locale.c:Perl_init_i18nl10n() if the environment
2134 * look like the user wants to use UTF-8. */
2135 #if defined(__SYMBIAN32__)
2136 PL_unicode = PERL_UNICODE_STD_FLAG; /* See PERL_SYMBIAN_CONSOLE_UTF8. */
2139 /* Requires init_predump_symbols(). */
2140 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
2145 /* Turn on UTF-8-ness on STDIN, STDOUT, STDERR
2146 * and the default open disciplines. */
2147 if ((PL_unicode & PERL_UNICODE_STDIN_FLAG) &&
2148 PL_stdingv && (io = GvIO(PL_stdingv)) &&
2150 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2151 if ((PL_unicode & PERL_UNICODE_STDOUT_FLAG) &&
2152 PL_defoutgv && (io = GvIO(PL_defoutgv)) &&
2154 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2155 if ((PL_unicode & PERL_UNICODE_STDERR_FLAG) &&
2156 PL_stderrgv && (io = GvIO(PL_stderrgv)) &&
2158 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2159 if ((PL_unicode & PERL_UNICODE_INOUT_FLAG) &&
2160 (sv = GvSV(gv_fetchpvs("\017PEN", GV_ADD|GV_NOTQUAL,
2162 U32 in = PL_unicode & PERL_UNICODE_IN_FLAG;
2163 U32 out = PL_unicode & PERL_UNICODE_OUT_FLAG;
2166 sv_setpvn(sv, ":utf8\0:utf8", 11);
2168 sv_setpvn(sv, ":utf8\0", 6);
2171 sv_setpvn(sv, "\0:utf8", 6);
2179 if ((s = PerlEnv_getenv("PERL_SIGNALS"))) {
2180 if (strEQ(s, "unsafe"))
2181 PL_signals |= PERL_SIGNALS_UNSAFE_FLAG;
2182 else if (strEQ(s, "safe"))
2183 PL_signals &= ~PERL_SIGNALS_UNSAFE_FLAG;
2185 Perl_croak(aTHX_ "PERL_SIGNALS illegal: \"%s\"", s);
2192 if ((s = PerlEnv_getenv("PERL_XMLDUMP"))) {
2196 PL_xmlfp = PerlIO_stdout();
2198 PL_xmlfp = PerlIO_open(s, "w");
2200 Perl_croak(aTHX_ "Can't open %s", s);
2202 my_setenv("PERL_XMLDUMP", NULL); /* hide from subprocs */
2208 if ((s = PerlEnv_getenv("PERL_MADSKILLS"))) {
2209 PL_madskills = atoi(s);
2210 my_setenv("PERL_MADSKILLS", NULL); /* hide from subprocs */
2215 lex_start(linestr_sv, rsfp, TRUE);
2216 PL_subname = newSVpvs("main");
2218 if (add_read_e_script)
2219 filter_add(read_e_script, NULL);
2221 /* now parse the script */
2223 SETERRNO(0,SS_NORMAL);
2224 #ifdef MACOS_TRADITIONAL
2225 if (gMacPerl_SyntaxError = (yyparse() || PL_parser->error_count)) {
2227 Perl_croak(aTHX_ "%s had compilation errors.\n", MacPerl_MPWFileName(PL_origfilename));
2229 Perl_croak(aTHX_ "Execution of %s aborted due to compilation errors.\n",
2230 MacPerl_MPWFileName(PL_origfilename));
2234 if (yyparse() || PL_parser->error_count) {
2236 Perl_croak(aTHX_ "%s had compilation errors.\n", PL_origfilename);
2238 Perl_croak(aTHX_ "Execution of %s aborted due to compilation errors.\n",
2243 CopLINE_set(PL_curcop, 0);
2244 PL_curstash = PL_defstash;
2245 PL_preprocess = FALSE;
2247 SvREFCNT_dec(PL_e_script);
2255 SAVECOPFILE(PL_curcop);
2256 SAVECOPLINE(PL_curcop);
2257 gv_check(PL_defstash);
2266 if ((s=PerlEnv_getenv("PERL_DEBUG_MSTATS")) && atoi(s) >= 2)
2267 dump_mstats("after compilation:");
2277 =for apidoc perl_run
2279 Tells a Perl interpreter to run. See L<perlembed>.
2292 PERL_UNUSED_ARG(my_perl);
2294 oldscope = PL_scopestack_ix;
2302 cxstack_ix = -1; /* start context stack again */
2304 case 0: /* normal completion */
2308 case 2: /* my_exit() */
2309 while (PL_scopestack_ix > oldscope)
2312 PL_curstash = PL_defstash;
2313 if (!(PL_exit_flags & PERL_EXIT_DESTRUCT_END) &&
2314 PL_endav && !PL_minus_c)
2315 call_list(oldscope, PL_endav);
2317 if (PerlEnv_getenv("PERL_DEBUG_MSTATS"))
2318 dump_mstats("after execution: ");
2324 POPSTACK_TO(PL_mainstack);
2327 PerlIO_printf(Perl_error_log, "panic: restartop\n");
2338 S_run_body(pTHX_ I32 oldscope)
2341 DEBUG_r(PerlIO_printf(Perl_debug_log, "%s $` $& $' support.\n",
2342 PL_sawampersand ? "Enabling" : "Omitting"));
2344 if (!PL_restartop) {
2348 exit(0); /* less likely to core dump than my_exit(0) */
2351 DEBUG_x(dump_all());
2354 PERL_DEBUG(PerlIO_printf(Perl_debug_log, "\nEXECUTING...\n\n"));
2356 DEBUG_S(PerlIO_printf(Perl_debug_log, "main thread is 0x%"UVxf"\n",
2360 #ifdef MACOS_TRADITIONAL
2361 PerlIO_printf(Perl_error_log, "%s%s syntax OK\n",
2362 (gMacPerl_ErrorFormat ? "# " : ""),
2363 MacPerl_MPWFileName(PL_origfilename));
2365 PerlIO_printf(Perl_error_log, "%s syntax OK\n", PL_origfilename);
2369 if (PERLDB_SINGLE && PL_DBsingle)
2370 sv_setiv(PL_DBsingle, 1);
2372 call_list(oldscope, PL_initav);
2373 #ifdef PERL_DEBUG_READONLY_OPS
2374 Perl_pending_Slabs_to_ro(aTHX);
2381 PL_op = PL_restartop;
2385 else if (PL_main_start) {
2386 CvDEPTH(PL_main_cv) = 1;
2387 PL_op = PL_main_start;
2395 =head1 SV Manipulation Functions
2397 =for apidoc p||get_sv
2399 Returns the SV of the specified Perl scalar. If C<create> is set and the
2400 Perl variable does not exist then it will be created. If C<create> is not
2401 set and the variable does not exist then NULL is returned.
2407 Perl_get_sv(pTHX_ const char *name, I32 create)
2410 gv = gv_fetchpv(name, create, SVt_PV);
2417 =head1 Array Manipulation Functions
2419 =for apidoc p||get_av
2421 Returns the AV of the specified Perl array. If C<create> is set and the
2422 Perl variable does not exist then it will be created. If C<create> is not
2423 set and the variable does not exist then NULL is returned.
2429 Perl_get_av(pTHX_ const char *name, I32 create)
2431 GV* const gv = gv_fetchpv(name, create, SVt_PVAV);
2440 =head1 Hash Manipulation Functions
2442 =for apidoc p||get_hv
2444 Returns the HV of the specified Perl hash. If C<create> is set and the
2445 Perl variable does not exist then it will be created. If C<create> is not
2446 set and the variable does not exist then NULL is returned.
2452 Perl_get_hv(pTHX_ const char *name, I32 create)
2454 GV* const gv = gv_fetchpv(name, create, SVt_PVHV);
2463 =head1 CV Manipulation Functions
2465 =for apidoc p||get_cvn_flags
2467 Returns the CV of the specified Perl subroutine. C<flags> are passed to
2468 C<gv_fetchpvn_flags>. If C<GV_ADD> is set and the Perl subroutine does not
2469 exist then it will be declared (which has the same effect as saying
2470 C<sub name;>). If C<GV_ADD> is not set and the subroutine does not exist
2471 then NULL is returned.
2473 =for apidoc p||get_cv
2475 Uses C<strlen> to get the length of C<name>, then calls C<get_cvn_flags>.
2481 Perl_get_cvn_flags(pTHX_ const char *name, STRLEN len, I32 flags)
2483 GV* const gv = gv_fetchpvn_flags(name, len, flags, SVt_PVCV);
2484 /* XXX this is probably not what they think they're getting.
2485 * It has the same effect as "sub name;", i.e. just a forward
2487 if ((flags & ~GV_NOADD_MASK) && !GvCVu(gv)) {
2488 SV *const sv = newSVpvn_flags(name, len, flags & SVf_UTF8);
2489 return newSUB(start_subparse(FALSE, 0),
2490 newSVOP(OP_CONST, 0, sv),
2499 Perl_get_cv(pTHX_ const char *name, I32 flags)
2501 return get_cvn_flags(name, strlen(name), flags);
2504 /* Be sure to refetch the stack pointer after calling these routines. */
2508 =head1 Callback Functions
2510 =for apidoc p||call_argv
2512 Performs a callback to the specified Perl sub. See L<perlcall>.
2518 Perl_call_argv(pTHX_ const char *sub_name, I32 flags, register char **argv)
2520 /* See G_* flags in cop.h */
2521 /* null terminated arg list */
2529 mXPUSHs(newSVpv(*argv,0));
2534 return call_pv(sub_name, flags);
2538 =for apidoc p||call_pv
2540 Performs a callback to the specified Perl sub. See L<perlcall>.
2546 Perl_call_pv(pTHX_ const char *sub_name, I32 flags)
2547 /* name of the subroutine */
2548 /* See G_* flags in cop.h */
2550 return call_sv((SV*)get_cv(sub_name, TRUE), flags);
2554 =for apidoc p||call_method
2556 Performs a callback to the specified Perl method. The blessed object must
2557 be on the stack. See L<perlcall>.
2563 Perl_call_method(pTHX_ const char *methname, I32 flags)
2564 /* name of the subroutine */
2565 /* See G_* flags in cop.h */
2567 return call_sv(sv_2mortal(newSVpv(methname,0)), flags | G_METHOD);
2570 /* May be called with any of a CV, a GV, or an SV containing the name. */
2572 =for apidoc p||call_sv
2574 Performs a callback to the Perl sub whose name is in the SV. See
2581 Perl_call_sv(pTHX_ SV *sv, I32 flags)
2582 /* See G_* flags in cop.h */
2585 LOGOP myop; /* fake syntax tree node */
2590 bool oldcatch = CATCH_GET;
2592 OP* const oldop = PL_op;
2595 if (flags & G_DISCARD) {
2600 Zero(&myop, 1, LOGOP);
2601 myop.op_next = NULL;
2602 if (!(flags & G_NOARGS))
2603 myop.op_flags |= OPf_STACKED;
2604 myop.op_flags |= ((flags & G_VOID) ? OPf_WANT_VOID :
2605 (flags & G_ARRAY) ? OPf_WANT_LIST :
2610 EXTEND(PL_stack_sp, 1);
2611 *++PL_stack_sp = sv;
2613 oldscope = PL_scopestack_ix;
2615 if (PERLDB_SUB && PL_curstash != PL_debstash
2616 /* Handle first BEGIN of -d. */
2617 && (PL_DBcv || (PL_DBcv = GvCV(PL_DBsub)))
2618 /* Try harder, since this may have been a sighandler, thus
2619 * curstash may be meaningless. */
2620 && (SvTYPE(sv) != SVt_PVCV || CvSTASH((CV*)sv) != PL_debstash)
2621 && !(flags & G_NODEBUG))
2622 PL_op->op_private |= OPpENTERSUB_DB;
2624 if (flags & G_METHOD) {
2625 Zero(&method_op, 1, UNOP);
2626 method_op.op_next = PL_op;
2627 method_op.op_ppaddr = PL_ppaddr[OP_METHOD];
2628 myop.op_ppaddr = PL_ppaddr[OP_ENTERSUB];
2629 PL_op = (OP*)&method_op;
2632 if (!(flags & G_EVAL)) {
2634 CALL_BODY_SUB((OP*)&myop);
2635 retval = PL_stack_sp - (PL_stack_base + oldmark);
2636 CATCH_SET(oldcatch);
2639 myop.op_other = (OP*)&myop;
2641 create_eval_scope(flags|G_FAKINGEVAL);
2649 CALL_BODY_SUB((OP*)&myop);
2650 retval = PL_stack_sp - (PL_stack_base + oldmark);
2651 if (!(flags & G_KEEPERR))
2652 sv_setpvn(ERRSV,"",0);
2658 /* my_exit() was called */
2659 PL_curstash = PL_defstash;
2662 if (PL_statusvalue && !(PL_exit_flags & PERL_EXIT_EXPECTED))
2663 Perl_croak(aTHX_ "Callback called exit");
2668 PL_op = PL_restartop;
2672 PL_stack_sp = PL_stack_base + oldmark;
2673 if (flags & G_ARRAY)
2677 *++PL_stack_sp = &PL_sv_undef;
2682 if (PL_scopestack_ix > oldscope)
2683 delete_eval_scope();
2687 if (flags & G_DISCARD) {
2688 PL_stack_sp = PL_stack_base + oldmark;
2697 /* Eval a string. The G_EVAL flag is always assumed. */
2700 =for apidoc p||eval_sv
2702 Tells Perl to C<eval> the string in the SV.
2708 Perl_eval_sv(pTHX_ SV *sv, I32 flags)
2710 /* See G_* flags in cop.h */
2714 UNOP myop; /* fake syntax tree node */
2715 VOL I32 oldmark = SP - PL_stack_base;
2718 OP* const oldop = PL_op;
2721 if (flags & G_DISCARD) {
2728 Zero(PL_op, 1, UNOP);
2729 EXTEND(PL_stack_sp, 1);
2730 *++PL_stack_sp = sv;
2732 if (!(flags & G_NOARGS))
2733 myop.op_flags = OPf_STACKED;
2734 myop.op_next = NULL;
2735 myop.op_type = OP_ENTEREVAL;
2736 myop.op_flags |= ((flags & G_VOID) ? OPf_WANT_VOID :
2737 (flags & G_ARRAY) ? OPf_WANT_LIST :
2739 if (flags & G_KEEPERR)
2740 myop.op_flags |= OPf_SPECIAL;
2742 /* fail now; otherwise we could fail after the JMPENV_PUSH but
2743 * before a PUSHEVAL, which corrupts the stack after a croak */
2744 TAINT_PROPER("eval_sv()");
2750 CALL_BODY_EVAL((OP*)&myop);
2751 retval = PL_stack_sp - (PL_stack_base + oldmark);
2752 if (!(flags & G_KEEPERR))
2753 sv_setpvn(ERRSV,"",0);
2759 /* my_exit() was called */
2760 PL_curstash = PL_defstash;
2763 if (PL_statusvalue && !(PL_exit_flags & PERL_EXIT_EXPECTED))
2764 Perl_croak(aTHX_ "Callback called exit");
2769 PL_op = PL_restartop;
2773 PL_stack_sp = PL_stack_base + oldmark;
2774 if (flags & G_ARRAY)
2778 *++PL_stack_sp = &PL_sv_undef;
2784 if (flags & G_DISCARD) {
2785 PL_stack_sp = PL_stack_base + oldmark;
2795 =for apidoc p||eval_pv
2797 Tells Perl to C<eval> the given string and return an SV* result.
2803 Perl_eval_pv(pTHX_ const char *p, I32 croak_on_error)
2807 SV* sv = newSVpv(p, 0);
2809 eval_sv(sv, G_SCALAR);
2816 if (croak_on_error && SvTRUE(ERRSV)) {
2817 Perl_croak(aTHX_ SvPVx_nolen_const(ERRSV));
2823 /* Require a module. */
2826 =head1 Embedding Functions
2828 =for apidoc p||require_pv
2830 Tells Perl to C<require> the file named by the string argument. It is
2831 analogous to the Perl code C<eval "require '$file'">. It's even
2832 implemented that way; consider using load_module instead.
2837 Perl_require_pv(pTHX_ const char *pv)
2842 PUSHSTACKi(PERLSI_REQUIRE);
2844 sv = Perl_newSVpvf(aTHX_ "require q%c%s%c", 0, pv, 0);
2845 eval_sv(sv_2mortal(sv), G_DISCARD);
2851 Perl_magicname(pTHX_ const char *sym, const char *name, I32 namlen)
2853 register GV * const gv = gv_fetchpv(sym, GV_ADD, SVt_PV);
2856 sv_magic(GvSV(gv), (SV*)gv, PERL_MAGIC_sv, name, namlen);
2860 S_usage(pTHX_ const char *name) /* XXX move this out into a module ? */
2862 /* This message really ought to be max 23 lines.
2863 * Removed -h because the user already knows that option. Others? */
2865 static const char * const usage_msg[] = {
2866 "-0[octal] specify record separator (\\0, if no argument)",
2867 "-a autosplit mode with -n or -p (splits $_ into @F)",
2868 "-C[number/list] enables the listed Unicode features",
2869 "-c check syntax only (runs BEGIN and CHECK blocks)",
2870 "-d[:debugger] run program under debugger",
2871 "-D[number/list] set debugging flags (argument is a bit mask or alphabets)",
2872 "-e program one line of program (several -e's allowed, omit programfile)",
2873 "-E program like -e, but enables all optional features",
2874 "-f don't do $sitelib/sitecustomize.pl at startup",
2875 "-F/pattern/ split() pattern for -a switch (//'s are optional)",
2876 "-i[extension] edit <> files in place (makes backup if extension supplied)",
2877 "-Idirectory specify @INC/#include directory (several -I's allowed)",
2878 "-l[octal] enable line ending processing, specifies line terminator",
2879 "-[mM][-]module execute \"use/no module...\" before executing program",
2880 "-n assume \"while (<>) { ... }\" loop around program",
2881 "-p assume loop like -n but print line also, like sed",
2882 "-P run program through C preprocessor before compilation",
2883 "-s enable rudimentary parsing for switches after programfile",
2884 "-S look for programfile using PATH environment variable",
2885 "-t enable tainting warnings",
2886 "-T enable tainting checks",
2887 "-u dump core after parsing program",
2888 "-U allow unsafe operations",
2889 "-v print version, subversion (includes VERY IMPORTANT perl info)",
2890 "-V[:variable] print configuration summary (or a single Config.pm variable)",
2891 "-w enable many useful warnings (RECOMMENDED)",
2892 "-W enable all warnings",
2893 "-x[directory] strip off text before #!perl line and perhaps cd to directory",
2894 "-X disable all warnings",
2898 const char * const *p = usage_msg;
2900 PerlIO_printf(PerlIO_stdout(),
2901 "\nUsage: %s [switches] [--] [programfile] [arguments]",
2904 PerlIO_printf(PerlIO_stdout(), "\n %s", *p++);
2907 /* convert a string of -D options (or digits) into an int.
2908 * sets *s to point to the char after the options */
2912 Perl_get_debug_opts(pTHX_ const char **s, bool givehelp)
2914 static const char * const usage_msgd[] = {
2915 " Debugging flag values: (see also -d)",
2916 " p Tokenizing and parsing (with v, displays parse stack)",
2917 " s Stack snapshots (with v, displays all stacks)",
2918 " l Context (loop) stack processing",
2919 " t Trace execution",
2920 " o Method and overloading resolution",
2921 " c String/numeric conversions",
2922 " P Print profiling info, preprocessor command for -P, source file input state",
2923 " m Memory allocation",
2924 " f Format processing",
2925 " r Regular expression parsing and execution",
2926 " x Syntax tree dump",
2927 " u Tainting checks",
2928 " H Hash dump -- usurps values()",
2929 " X Scratchpad allocation",
2931 " S Thread synchronization",
2933 " R Include reference counts of dumped variables (eg when using -Ds)",
2934 " J Do not s,t,P-debug (Jump over) opcodes within package DB",
2935 " v Verbose: use in conjunction with other flags",
2937 " A Consistency checks on internal structures",
2938 " q quiet - currently only suppresses the 'EXECUTING' message",
2943 /* if adding extra options, remember to update DEBUG_MASK */
2944 static const char debopts[] = "psltocPmfrxuUHXDSTRJvCAq";
2946 for (; isALNUM(**s); (*s)++) {
2947 const char * const d = strchr(debopts,**s);
2949 i |= 1 << (d - debopts);
2950 else if (ckWARN_d(WARN_DEBUGGING))
2951 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
2952 "invalid option -D%c, use -D'' to see choices\n", **s);
2955 else if (isDIGIT(**s)) {
2957 for (; isALNUM(**s); (*s)++) ;
2959 else if (givehelp) {
2960 const char *const *p = usage_msgd;
2961 while (*p) PerlIO_printf(PerlIO_stdout(), "%s\n", *p++);
2964 if ((i & DEBUG_p_FLAG) && ckWARN_d(WARN_DEBUGGING))
2965 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
2966 "-Dp not implemented on this platform\n");
2972 /* This routine handles any switches that can be given during run */
2975 Perl_moreswitches(pTHX_ const char *s)
2986 SvREFCNT_dec(PL_rs);
2987 if (s[1] == 'x' && s[2]) {
2988 const char *e = s+=2;
2994 flags = PERL_SCAN_SILENT_ILLDIGIT;
2995 rschar = (U32)grok_hex(s, &numlen, &flags, NULL);
2996 if (s + numlen < e) {
2997 rschar = 0; /* Grandfather -0xFOO as -0 -xFOO. */
3001 PL_rs = newSVpvs("");
3002 SvGROW(PL_rs, (STRLEN)(UNISKIP(rschar) + 1));
3003 tmps = (U8*)SvPVX(PL_rs);
3004 uvchr_to_utf8(tmps, rschar);
3005 SvCUR_set(PL_rs, UNISKIP(rschar));
3010 rschar = (U32)grok_oct(s, &numlen, &flags, NULL);
3011 if (rschar & ~((U8)~0))
3012 PL_rs = &PL_sv_undef;
3013 else if (!rschar && numlen >= 2)
3014 PL_rs = newSVpvs("");
3016 char ch = (char)rschar;
3017 PL_rs = newSVpvn(&ch, 1);
3020 sv_setsv(get_sv("/", TRUE), PL_rs);
3025 PL_unicode = parse_unicode_opts( (const char **)&s );
3026 if (PL_unicode & PERL_UNICODE_UTF8CACHEASSERT_FLAG)
3032 while (*s && !isSPACE(*s)) ++s;
3033 PL_splitstr = savepvn(PL_splitstr, s - PL_splitstr);
3044 forbid_setid('d', -1);
3047 /* -dt indicates to the debugger that threads will be used */
3048 if (*s == 't' && !isALNUM(s[1])) {
3050 my_setenv("PERL5DB_THREADED", "1");
3053 /* The following permits -d:Mod to accepts arguments following an =
3054 in the fashion that -MSome::Mod does. */
3055 if (*s == ':' || *s == '=') {
3056 const char *start = ++s;
3057 const char *const end = s + strlen(s);
3058 SV * const sv = newSVpvs("use Devel::");
3060 /* We now allow -d:Module=Foo,Bar */
3061 while(isALNUM(*s) || *s==':') ++s;
3063 sv_catpvn(sv, start, end - start);
3065 sv_catpvn(sv, start, s-start);
3066 /* Don't use NUL as q// delimiter here, this string goes in the
3068 Perl_sv_catpvf(aTHX_ sv, " split(/,/,q{%s});", ++s);
3071 my_setenv("PERL5DB", SvPV_nolen_const(sv));
3075 PL_perldb = PERLDB_ALL;
3082 forbid_setid('D', -1);
3084 PL_debug = get_debug_opts( (const char **)&s, 1) | DEBUG_TOP_FLAG;
3085 #else /* !DEBUGGING */
3086 if (ckWARN_d(WARN_DEBUGGING))
3087 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3088 "Recompile perl with -DDEBUGGING to use -D switch (did you mean -d ?)\n");
3089 for (s++; isALNUM(*s); s++) ;
3094 usage(PL_origargv[0]);
3097 Safefree(PL_inplace);
3098 #if defined(__CYGWIN__) /* do backup extension automagically */
3099 if (*(s+1) == '\0') {
3100 PL_inplace = savepvs(".bak");
3103 #endif /* __CYGWIN__ */
3105 const char * const start = ++s;
3106 while (*s && !isSPACE(*s))
3109 PL_inplace = savepvn(start, s - start);
3113 if (*s == '-') /* Additional switches on #! line. */
3117 case 'I': /* -I handled both here and in parse_body() */
3118 forbid_setid('I', -1);
3120 while (*s && isSPACE(*s))
3125 /* ignore trailing spaces (possibly followed by other switches) */
3127 for (e = p; *e && !isSPACE(*e); e++) ;
3131 } while (*p && *p != '-');
3132 e = savepvn(s, e-s);
3133 incpush(e, TRUE, TRUE, FALSE, FALSE);
3140 Perl_croak(aTHX_ "No directory specified for -I");
3146 SvREFCNT_dec(PL_ors_sv);
3152 PL_ors_sv = newSVpvs("\n");
3153 numlen = 3 + (*s == '0');
3154 *SvPVX(PL_ors_sv) = (char)grok_oct(s, &numlen, &flags, NULL);
3158 if (RsPARA(PL_rs)) {
3159 PL_ors_sv = newSVpvs("\n\n");
3162 PL_ors_sv = newSVsv(PL_rs);
3167 forbid_setid('M', -1); /* XXX ? */
3170 forbid_setid('m', -1); /* XXX ? */
3175 const char *use = "use ";
3176 /* -M-foo == 'no foo' */
3177 /* Leading space on " no " is deliberate, to make both
3178 possibilities the same length. */
3179 if (*s == '-') { use = " no "; ++s; }
3180 sv = newSVpvn(use,4);
3182 /* We allow -M'Module qw(Foo Bar)' */
3183 while(isALNUM(*s) || *s==':') ++s;
3184 end = s + strlen(s);
3186 sv_catpvn(sv, start, end - start);
3187 if (*(start-1) == 'm') {
3189 Perl_croak(aTHX_ "Can't use '%c' after -mname", *s);
3190 sv_catpvs( sv, " ()");
3194 Perl_croak(aTHX_ "Module name required with -%c option",
3196 sv_catpvn(sv, start, s-start);
3197 /* Use NUL as q''-delimiter. */
3198 sv_catpvs(sv, " split(/,/,q\0");
3200 sv_catpvn(sv, s, end - s);
3201 sv_catpvs(sv, "\0)");
3204 Perl_av_create_and_push(aTHX_ &PL_preambleav, sv);
3207 Perl_croak(aTHX_ "Missing argument to -%c", *(s-1));
3218 forbid_setid('s', -1);
3219 PL_doswitches = TRUE;
3233 #ifdef MACOS_TRADITIONAL
3234 Perl_croak(aTHX_ "Believe me, you don't want to use \"-u\" on a Macintosh");
3236 PL_do_undump = TRUE;
3244 if (!sv_derived_from(PL_patchlevel, "version"))
3245 upg_version(PL_patchlevel, TRUE);
3247 PerlIO_printf(PerlIO_stdout(),
3248 Perl_form(aTHX_ "\nThis is perl, %"SVf
3249 #ifdef PERL_PATCHNUM
3250 " DEVEL" STRINGIFY(PERL_PATCHNUM)
3253 SVfARG(vstringify(PL_patchlevel)),
3256 /* Adjust verbose output as in the perl that ships with the DG/UX OS from EMC */
3257 PerlIO_printf(PerlIO_stdout(),
3258 Perl_form(aTHX_ "\nThis is perl, %"SVf"\n",
3259 SVfARG(vstringify(PL_patchlevel))));
3260 PerlIO_printf(PerlIO_stdout(),
3261 Perl_form(aTHX_ " built under %s at %s %s\n",
3262 OSNAME, __DATE__, __TIME__));
3263 PerlIO_printf(PerlIO_stdout(),
3264 Perl_form(aTHX_ " OS Specific Release: %s\n",
3268 #if defined(LOCAL_PATCH_COUNT)
3269 if (LOCAL_PATCH_COUNT > 0)
3270 PerlIO_printf(PerlIO_stdout(),
3271 "\n(with %d registered patch%s, "
3272 "see perl -V for more detail)",
3274 (LOCAL_PATCH_COUNT!=1) ? "es" : "");
3277 PerlIO_printf(PerlIO_stdout(),
3278 "\n\nCopyright 1987-2007, Larry Wall\n");
3279 #ifdef MACOS_TRADITIONAL
3280 PerlIO_printf(PerlIO_stdout(),
3281 "\nMac OS port Copyright 1991-2002, Matthias Neeracher;\n"
3282 "maintained by Chris Nandor\n");
3285 PerlIO_printf(PerlIO_stdout(),
3286 "\nMS-DOS port Copyright (c) 1989, 1990, Diomidis Spinellis\n");
3289 PerlIO_printf(PerlIO_stdout(),
3290 "djgpp v2 port (jpl5003c) by Hirofumi Watanabe, 1996\n"
3291 "djgpp v2 port (perl5004+) by Laszlo Molnar, 1997-1999\n");
3294 PerlIO_printf(PerlIO_stdout(),
3295 "\n\nOS/2 port Copyright (c) 1990, 1991, Raymond Chen, Kai Uwe Rommel\n"
3296 "Version 5 port Copyright (c) 1994-2002, Andreas Kaiser, Ilya Zakharevich\n");
3299 PerlIO_printf(PerlIO_stdout(),
3300 "atariST series port, ++jrb bammi@cadence.com\n");
3303 PerlIO_printf(PerlIO_stdout(),
3304 "BeOS port Copyright Tom Spindler, 1997-1999\n");
3307 PerlIO_printf(PerlIO_stdout(),
3308 "MPE/iX port Copyright by Mark Klein and Mark Bixby, 1996-2003\n");
3311 PerlIO_printf(PerlIO_stdout(),
3312 "MVS (OS390) port by Mortice Kern Systems, 1997-1999\n");
3315 PerlIO_printf(PerlIO_stdout(),
3316 "Stratus VOS port by Paul.Green@stratus.com, 1997-2002\n");
3319 PerlIO_printf(PerlIO_stdout(),
3320 "VM/ESA port by Neale Ferguson, 1998-1999\n");
3323 PerlIO_printf(PerlIO_stdout(),
3324 "BS2000 (POSIX) port by Start Amadeus GmbH, 1998-1999\n");
3327 PerlIO_printf(PerlIO_stdout(),
3328 "MiNT port by Guido Flohr, 1997-1999\n");
3331 PerlIO_printf(PerlIO_stdout(),
3332 "EPOC port by Olaf Flebbe, 1999-2002\n");
3335 PerlIO_printf(PerlIO_stdout(),"WINCE port by Rainer Keuchel, 2001-2002\n");
3336 PerlIO_printf(PerlIO_stdout(),"Built on " __DATE__ " " __TIME__ "\n\n");
3339 #ifdef __SYMBIAN32__
3340 PerlIO_printf(PerlIO_stdout(),
3341 "Symbian port by Nokia, 2004-2005\n");
3343 #ifdef BINARY_BUILD_NOTICE
3344 BINARY_BUILD_NOTICE;
3346 PerlIO_printf(PerlIO_stdout(),
3348 Perl may be copied only under the terms of either the Artistic License or the\n\
3349 GNU General Public License, which may be found in the Perl 5 source kit.\n\n\
3350 Complete documentation for Perl, including FAQ lists, should be found on\n\
3351 this system using \"man perl\" or \"perldoc perl\". If you have access to the\n\
3352 Internet, point your browser at http://www.perl.org/, the Perl Home Page.\n\n");
3355 if (! (PL_dowarn & G_WARN_ALL_MASK)) {
3356 PL_dowarn |= G_WARN_ON;
3361 PL_dowarn = G_WARN_ALL_ON|G_WARN_ON;
3362 if (!specialWARN(PL_compiling.cop_warnings))
3363 PerlMemShared_free(PL_compiling.cop_warnings);
3364 PL_compiling.cop_warnings = pWARN_ALL ;
3368 PL_dowarn = G_WARN_ALL_OFF;
3369 if (!specialWARN(PL_compiling.cop_warnings))
3370 PerlMemShared_free(PL_compiling.cop_warnings);
3371 PL_compiling.cop_warnings = pWARN_NONE ;
3376 if (s[1] == '-') /* Additional switches on #! line. */
3381 #if defined(WIN32) || !defined(PERL_STRICT_CR)
3387 #ifdef ALTERNATE_SHEBANG
3388 case 'S': /* OS/2 needs -S on "extproc" line. */
3396 Perl_croak(aTHX_ "Can't emulate -%.1s on #! line",s);
3401 /* compliments of Tom Christiansen */
3403 /* unexec() can be found in the Gnu emacs distribution */
3404 /* Known to work with -DUNEXEC and using unexelf.c from GNU emacs-20.2 */
3407 Perl_my_unexec(pTHX)
3409 PERL_UNUSED_CONTEXT;
3411 SV * prog = newSVpv(BIN_EXP, 0);
3412 SV * file = newSVpv(PL_origfilename, 0);
3416 sv_catpvs(prog, "/perl");
3417 sv_catpvs(file, ".perldump");
3419 unexec(SvPVX(file), SvPVX(prog), &etext, sbrk(0), 0);
3420 /* unexec prints msg to stderr in case of failure */
3421 PerlProc_exit(status);
3424 # include <lib$routines.h>
3425 lib$signal(SS$_DEBUG); /* ssdef.h #included from vmsish.h */
3426 # elif defined(WIN32) || defined(__CYGWIN__)
3427 Perl_croak(aTHX_ "dump is not supported");
3429 ABORT(); /* for use with undump */
3434 /* initialize curinterp */
3440 # define PERLVAR(var,type)
3441 # define PERLVARA(var,n,type)
3442 # if defined(PERL_IMPLICIT_CONTEXT)
3443 # define PERLVARI(var,type,init) aTHX->var = init;
3444 # define PERLVARIC(var,type,init) aTHX->var = init;
3446 # define PERLVARI(var,type,init) PERL_GET_INTERP->var = init;
3447 # define PERLVARIC(var,type,init) PERL_GET_INTERP->var = init;
3449 # include "intrpvar.h"
3455 # define PERLVAR(var,type)
3456 # define PERLVARA(var,n,type)
3457 # define PERLVARI(var,type,init) PL_##var = init;
3458 # define PERLVARIC(var,type,init) PL_##var = init;
3459 # include "intrpvar.h"
3466 /* As these are inside a structure, PERLVARI isn't capable of initialising
3468 PL_reg_oldcurpm = PL_reg_curpm = NULL;
3469 PL_reg_poscache = PL_reg_starttry = NULL;
3473 S_init_main_stash(pTHX)
3478 PL_curstash = PL_defstash = newHV();
3479 /* We know that the string "main" will be in the global shared string
3480 table, so it's a small saving to use it rather than allocate another
3482 PL_curstname = newSVpvs_share("main");
3483 gv = gv_fetchpvs("main::", GV_ADD|GV_NOTQUAL, SVt_PVHV);
3484 /* If we hadn't caused another reference to "main" to be in the shared
3485 string table above, then it would be worth reordering these two,
3486 because otherwise all we do is delete "main" from it as a consequence
3487 of the SvREFCNT_dec, only to add it again with hv_name_set */
3488 SvREFCNT_dec(GvHV(gv));
3489 hv_name_set(PL_defstash, "main", 4, 0);
3490 GvHV(gv) = (HV*)SvREFCNT_inc_simple(PL_defstash);
3492 PL_incgv = gv_HVadd(gv_AVadd(gv_fetchpvs("INC", GV_ADD|GV_NOTQUAL,
3494 SvREFCNT_inc_simple_void(PL_incgv); /* Don't allow it to be freed */
3495 GvMULTI_on(PL_incgv);
3496 PL_hintgv = gv_fetchpvs("\010", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^H */
3497 GvMULTI_on(PL_hintgv);
3498 PL_defgv = gv_fetchpvs("_", GV_ADD|GV_NOTQUAL, SVt_PVAV);
3499 SvREFCNT_inc_simple_void(PL_defgv);
3500 PL_errgv = gv_HVadd(gv_fetchpvs("@", GV_ADD|GV_NOTQUAL, SVt_PV));
3501 SvREFCNT_inc_simple_void(PL_errgv);
3502 GvMULTI_on(PL_errgv);
3503 PL_replgv = gv_fetchpvs("\022", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^R */
3504 GvMULTI_on(PL_replgv);
3505 (void)Perl_form(aTHX_ "%240s",""); /* Preallocate temp - for immediate signals. */
3506 #ifdef PERL_DONT_CREATE_GVSV
3509 sv_grow(ERRSV, 240); /* Preallocate - for immediate signals. */
3510 sv_setpvn(ERRSV, "", 0);
3511 PL_curstash = PL_defstash;
3512 CopSTASH_set(&PL_compiling, PL_defstash);
3513 PL_debstash = GvHV(gv_fetchpvs("DB::", GV_ADDMULTI, SVt_PVHV));
3514 PL_globalstash = GvHV(gv_fetchpvs("CORE::GLOBAL::", GV_ADDMULTI,
3516 /* We must init $/ before switches are processed. */
3517 sv_setpvn(get_sv("/", TRUE), "\n", 1);
3521 S_open_script(pTHX_ const char *scriptname, bool dosearch, SV *sv,
3522 int *suidscript, PerlIO **rsfpp)
3527 const char *cpp_discard_flag;
3536 PL_origfilename = savepvs("-e");
3539 /* if find_script() returns, it returns a malloc()-ed value */
3540 scriptname = PL_origfilename = find_script(scriptname, dosearch, NULL, 1);
3542 if (strnEQ(scriptname, "/dev/fd/", 8) && isDIGIT(scriptname[8]) ) {
3543 const char *s = scriptname + 8;
3549 * Tell apart "normal" usage of fdscript, e.g.
3550 * with bash on FreeBSD:
3551 * perl <( echo '#!perl -DA'; echo 'print "$0\n"')
3552 * from usage in suidperl.
3553 * Does any "normal" usage leave garbage after the number???
3554 * Is it a mistake to use a similar /dev/fd/ construct for
3559 * Be supersafe and do some sanity-checks.
3560 * Still, can we be sure we got the right thing?
3563 Perl_croak(aTHX_ "Wrong syntax (suid) fd script name \"%s\"\n", s);
3566 Perl_croak(aTHX_ "Missing (suid) fd script name\n");
3568 scriptname = savepv(s + 1);
3569 Safefree(PL_origfilename);
3570 PL_origfilename = (char *)scriptname;
3575 CopFILE_free(PL_curcop);
3576 CopFILE_set(PL_curcop, PL_origfilename);
3577 if (*PL_origfilename == '-' && PL_origfilename[1] == '\0')
3578 scriptname = (char *)"";
3579 if (fdscript >= 0) {
3580 *rsfpp = PerlIO_fdopen(fdscript,PERL_SCRIPT_MODE);
3581 # if defined(HAS_FCNTL) && defined(F_SETFD)
3583 /* ensure close-on-exec */
3584 fcntl(PerlIO_fileno(*rsfpp),F_SETFD,1);
3589 Perl_croak(aTHX_ "sperl needs fd script\n"
3590 "You should not call sperl directly; do you need to "
3591 "change a #! line\nfrom sperl to perl?\n");
3594 * Do not open (or do other fancy stuff) while setuid.
3595 * Perl does the open, and hands script to suidperl on a fd;
3596 * suidperl only does some checks, sets up UIDs and re-execs
3597 * perl with that fd as it has always done.
3600 if (*suidscript != 1) {
3601 Perl_croak(aTHX_ "suidperl needs (suid) fd script\n");
3604 else if (PL_preprocess) {
3605 const char * const cpp_cfg = CPPSTDIN;
3606 SV * const cpp = newSVpvs("");
3607 SV * const cmd = newSV(0);
3609 if (cpp_cfg[0] == 0) /* PERL_MICRO? */
3610 Perl_croak(aTHX_ "Can't run with cpp -P with CPPSTDIN undefined");
3611 if (strEQ(cpp_cfg, "cppstdin"))
3612 Perl_sv_catpvf(aTHX_ cpp, "%s/", BIN_EXP);
3613 sv_catpv(cpp, cpp_cfg);
3616 sv_catpvs(sv, "-I");
3617 sv_catpv(sv,PRIVLIB_EXP);
3620 DEBUG_P(PerlIO_printf(Perl_debug_log,
3621 "PL_preprocess: scriptname=\"%s\", cpp=\"%s\", sv=\"%s\", CPPMINUS=\"%s\"\n",
3622 scriptname, SvPVX_const (cpp), SvPVX_const (sv),
3625 # if defined(MSDOS) || defined(WIN32) || defined(VMS)
3632 cpp_discard_flag = "";
3634 cpp_discard_flag = "-C";
3638 perl = os2_execname(aTHX);
3640 perl = PL_origargv[0];
3644 /* This strips off Perl comments which might interfere with
3645 the C pre-processor, including #!. #line directives are
3646 deliberately stripped to avoid confusion with Perl's version
3647 of #line. FWP played some golf with it so it will fit
3648 into VMS's 255 character buffer.
3651 code = "(1../^#!.*perl/i)|/^\\s*#(?!\\s*((ifn?|un)def|(el|end)?if|define|include|else|error|pragma)\\b)/||!($|=1)||print";
3653 code = "/^\\s*#(?!\\s*((ifn?|un)def|(el|end)?if|define|include|else|error|pragma)\\b)/||!($|=1)||print";
3655 Perl_sv_setpvf(aTHX_ cmd, "\
3656 %s -ne%s%s%s %s | %"SVf" %s %"SVf" %s",
3657 perl, quote, code, quote, scriptname, SVfARG(cpp),
3658 cpp_discard_flag, SVfARG(sv), CPPMINUS);
3660 PL_doextract = FALSE;
3662 DEBUG_P(PerlIO_printf(Perl_debug_log,
3663 "PL_preprocess: cmd=\"%s\"\n",
3666 *rsfpp = PerlProc_popen((char *)SvPVX_const(cmd), (char *)"r");
3670 else if (!*scriptname) {
3671 forbid_setid(0, *suidscript);
3672 *rsfpp = PerlIO_stdin();
3675 #ifdef FAKE_BIT_BUCKET
3676 /* This hack allows one not to have /dev/null (or BIT_BUCKET as it
3677 * is called) and still have the "-e" work. (Believe it or not,
3678 * a /dev/null is required for the "-e" to work because source
3679 * filter magic is used to implement it. ) This is *not* a general
3680 * replacement for a /dev/null. What we do here is create a temp
3681 * file (an empty file), open up that as the script, and then
3682 * immediately close and unlink it. Close enough for jazz. */
3683 #define FAKE_BIT_BUCKET_PREFIX "/tmp/perlnull-"
3684 #define FAKE_BIT_BUCKET_SUFFIX "XXXXXXXX"
3685 #define FAKE_BIT_BUCKET_TEMPLATE FAKE_BIT_BUCKET_PREFIX FAKE_BIT_BUCKET_SUFFIX
3686 char tmpname[sizeof(FAKE_BIT_BUCKET_TEMPLATE)] = {
3687 FAKE_BIT_BUCKET_TEMPLATE
3689 const char * const err = "Failed to create a fake bit bucket";
3690 if (strEQ(scriptname, BIT_BUCKET)) {
3691 #ifdef HAS_MKSTEMP /* Hopefully mkstemp() is safe here. */
3692 int tmpfd = mkstemp(tmpname);
3694 scriptname = tmpname;
3697 Perl_croak(aTHX_ err);
3700 scriptname = mktemp(tmpname);
3702 Perl_croak(aTHX_ err);
3707 *rsfpp = PerlIO_open(scriptname,PERL_SCRIPT_MODE);
3708 #ifdef FAKE_BIT_BUCKET
3709 if (memEQ(scriptname, FAKE_BIT_BUCKET_PREFIX,
3710 sizeof(FAKE_BIT_BUCKET_PREFIX) - 1)
3711 && strlen(scriptname) == sizeof(tmpname) - 1) {
3714 scriptname = BIT_BUCKET;
3716 # if defined(HAS_FCNTL) && defined(F_SETFD)
3718 /* ensure close-on-exec */
3719 fcntl(PerlIO_fileno(*rsfpp),F_SETFD,1);
3722 #endif /* IAMSUID */
3724 /* PSz 16 Sep 03 Keep neat error message */
3726 Perl_croak(aTHX_ "Can't open "BIT_BUCKET": %s\n", Strerror(errno));
3728 Perl_croak(aTHX_ "Can't open perl script \"%s\": %s\n",
3729 CopFILE(PL_curcop), Strerror(errno));
3735 * I_SYSSTATVFS HAS_FSTATVFS
3737 * I_STATFS HAS_FSTATFS HAS_GETFSSTAT
3738 * I_MNTENT HAS_GETMNTENT HAS_HASMNTOPT
3739 * here so that metaconfig picks them up. */
3743 S_fd_on_nosuid_fs(pTHX_ int fd)
3746 * We used to do this as "plain" user (after swapping UIDs with setreuid);
3747 * but is needed also on machines without setreuid.
3748 * Seems safe enough to run as root.
3750 int check_okay = 0; /* able to do all the required sys/libcalls */
3751 int on_nosuid = 0; /* the fd is on a nosuid fs */
3753 * Need to check noexec also: nosuid might not be set, the average
3754 * sysadmin would say that nosuid is irrelevant once he sets noexec.
3756 int on_noexec = 0; /* the fd is on a noexec fs */
3759 * Preferred order: fstatvfs(), fstatfs(), ustat()+getmnt(), getmntent().
3760 * fstatvfs() is UNIX98.
3761 * fstatfs() is 4.3 BSD.
3762 * ustat()+getmnt() is pre-4.3 BSD.
3763 * getmntent() is O(number-of-mounted-filesystems) and can hang on
3764 * an irrelevant filesystem while trying to reach the right one.
3767 #undef FD_ON_NOSUID_CHECK_OKAY /* found the syscalls to do the check? */
3769 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3770 defined(HAS_FSTATVFS)
3771 # define FD_ON_NOSUID_CHECK_OKAY
3772 struct statvfs stfs;
3774 check_okay = fstatvfs(fd, &stfs) == 0;
3775 on_nosuid = check_okay && (stfs.f_flag & ST_NOSUID);
3777 /* ST_NOEXEC certainly absent on AIX 5.1, and doesn't seem to be documented
3778 on platforms where it is present. */
3779 on_noexec = check_okay && (stfs.f_flag & ST_NOEXEC);
3781 # endif /* fstatvfs */
3783 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3784 defined(PERL_MOUNT_NOSUID) && \
3785 defined(PERL_MOUNT_NOEXEC) && \
3786 defined(HAS_FSTATFS) && \
3787 defined(HAS_STRUCT_STATFS) && \
3788 defined(HAS_STRUCT_STATFS_F_FLAGS)
3789 # define FD_ON_NOSUID_CHECK_OKAY
3792 check_okay = fstatfs(fd, &stfs) == 0;
3793 on_nosuid = check_okay && (stfs.f_flags & PERL_MOUNT_NOSUID);
3794 on_noexec = check_okay && (stfs.f_flags & PERL_MOUNT_NOEXEC);
3795 # endif /* fstatfs */
3797 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3798 defined(PERL_MOUNT_NOSUID) && \
3799 defined(PERL_MOUNT_NOEXEC) && \
3800 defined(HAS_FSTAT) && \
3801 defined(HAS_USTAT) && \
3802 defined(HAS_GETMNT) && \
3803 defined(HAS_STRUCT_FS_DATA) && \
3805 # define FD_ON_NOSUID_CHECK_OKAY
3808 if (fstat(fd, &fdst) == 0) {
3810 if (ustat(fdst.st_dev, &us) == 0) {
3812 /* NOSTAT_ONE here because we're not examining fields which
3813 * vary between that case and STAT_ONE. */
3814 if (getmnt((int*)0, &fsd, (int)0, NOSTAT_ONE, us.f_fname) == 0) {
3815 size_t cmplen = sizeof(us.f_fname);
3816 if (sizeof(fsd.fd_req.path) < cmplen)
3817 cmplen = sizeof(fsd.fd_req.path);
3818 if (strnEQ(fsd.fd_req.path, us.f_fname, cmplen) &&
3819 fdst.st_dev == fsd.fd_req.dev) {
3821 on_nosuid = fsd.fd_req.flags & PERL_MOUNT_NOSUID;
3822 on_noexec = fsd.fd_req.flags & PERL_MOUNT_NOEXEC;
3827 # endif /* fstat+ustat+getmnt */
3829 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3830 defined(HAS_GETMNTENT) && \
3831 defined(HAS_HASMNTOPT) && \
3832 defined(MNTOPT_NOSUID) && \
3833 defined(MNTOPT_NOEXEC)
3834 # define FD_ON_NOSUID_CHECK_OKAY
3835 FILE *mtab = fopen("/etc/mtab", "r");
3836 struct mntent *entry;
3839 if (mtab && (fstat(fd, &stb) == 0)) {
3840 while (entry = getmntent(mtab)) {
3841 if (stat(entry->mnt_dir, &fsb) == 0
3842 && fsb.st_dev == stb.st_dev)
3844 /* found the filesystem */
3846 if (hasmntopt(entry, MNTOPT_NOSUID))
3848 if (hasmntopt(entry, MNTOPT_NOEXEC))
3851 } /* A single fs may well fail its stat(). */
3856 # endif /* getmntent+hasmntopt */
3859 Perl_croak(aTHX_ "Can't check filesystem of script \"%s\" for nosuid/noexec", PL_origfilename);
3861 Perl_croak(aTHX_ "Setuid script \"%s\" on nosuid filesystem", PL_origfilename);
3863 Perl_croak(aTHX_ "Setuid script \"%s\" on noexec filesystem", PL_origfilename);
3864 return ((!check_okay) || on_nosuid || on_noexec);
3866 #endif /* IAMSUID */
3869 S_validate_suid(pTHX_ const char *validarg, const char *scriptname,
3870 int fdscript, int suidscript, SV *linestr_sv, PerlIO *rsfp)
3875 #endif /* IAMSUID */
3877 /* do we need to emulate setuid on scripts? */
3879 /* This code is for those BSD systems that have setuid #! scripts disabled
3880 * in the kernel because of a security problem. Merely defining DOSUID
3881 * in perl will not fix that problem, but if you have disabled setuid
3882 * scripts in the kernel, this will attempt to emulate setuid and setgid
3883 * on scripts that have those now-otherwise-useless bits set. The setuid
3884 * root version must be called suidperl or sperlN.NNN. If regular perl
3885 * discovers that it has opened a setuid script, it calls suidperl with
3886 * the same argv that it had. If suidperl finds that the script it has
3887 * just opened is NOT setuid root, it sets the effective uid back to the
3888 * uid. We don't just make perl setuid root because that loses the
3889 * effective uid we had before invoking perl, if it was different from the
3892 * Description/comments above do not match current workings:
3893 * suidperl must be hardlinked to sperlN.NNN (that is what we exec);
3894 * suidperl called with script open and name changed to /dev/fd/N/X;
3895 * suidperl croaks if script is not setuid;
3896 * making perl setuid would be a huge security risk (and yes, that
3897 * would lose any euid we might have had).
3899 * DOSUID must be defined in both perl and suidperl, and IAMSUID must
3900 * be defined in suidperl only. suidperl must be setuid root. The
3901 * Configure script will set this up for you if you want it.
3907 if (PerlLIO_fstat(PerlIO_fileno(rsfp),&PL_statbuf) < 0) /* normal stat is insecure */
3908 Perl_croak(aTHX_ "Can't stat script \"%s\"",PL_origfilename);
3909 if (PL_statbuf.st_mode & (S_ISUID|S_ISGID)) {
3911 const char *linestr;
3915 if (fdscript < 0 || suidscript != 1)
3916 Perl_croak(aTHX_ "Need (suid) fdscript in suidperl\n"); /* We already checked this */
3918 * Since the script is opened by perl, not suidperl, some of these
3919 * checks are superfluous. Leaving them in probably does not lower
3923 * Do checks even for systems with no HAS_SETREUID.
3924 * We used to swap, then re-swap UIDs with
3925 # ifdef HAS_SETREUID
3926 if (setreuid(PL_euid,PL_uid) < 0
3927 || PerlProc_getuid() != PL_euid || PerlProc_geteuid() != PL_uid)
3928 Perl_croak(aTHX_ "Can't swap uid and euid");
3930 # ifdef HAS_SETREUID
3931 if (setreuid(PL_uid,PL_euid) < 0
3932 || PerlProc_getuid() != PL_uid || PerlProc_geteuid() != PL_euid)
3933 Perl_croak(aTHX_ "Can't reswap uid and euid");
3937 /* On this access check to make sure the directories are readable,
3938 * there is actually a small window that the user could use to make
3939 * filename point to an accessible directory. So there is a faint
3940 * chance that someone could execute a setuid script down in a
3941 * non-accessible directory. I don't know what to do about that.
3942 * But I don't think it's too important. The manual lies when
3943 * it says access() is useful in setuid programs.
3945 * So, access() is pretty useless... but not harmful... do anyway.
3947 if (PerlLIO_access(CopFILE(PL_curcop),1)) { /*double check*/
3948 Perl_croak(aTHX_ "Can't access() script\n");
3951 /* If we can swap euid and uid, then we can determine access rights
3952 * with a simple stat of the file, and then compare device and
3953 * inode to make sure we did stat() on the same file we opened.
3954 * Then we just have to make sure he or she can execute it.
3957 * As the script is opened by perl, not suidperl, we do not need to
3958 * care much about access rights.
3960 * The 'script changed' check is needed, or we can get lied to
3961 * about $0 with e.g.
3962 * suidperl /dev/fd/4//bin/x 4<setuidscript
3963 * Without HAS_SETREUID, is it safe to stat() as root?
3965 * Are there any operating systems that pass /dev/fd/xxx for setuid
3966 * scripts, as suggested/described in perlsec(1)? Surely they do not
3967 * pass the script name as we do, so the "script changed" test would
3968 * fail for them... but we never get here with
3969 * SETUID_SCRIPTS_ARE_SECURE_NOW defined.
3971 * This is one place where we must "lie" about return status: not
3972 * say if the stat() failed. We are doing this as root, and could
3973 * be tricked into reporting existence or not of files that the
3974 * "plain" user cannot even see.
3978 if (PerlLIO_stat(CopFILE(PL_curcop),&tmpstatbuf) < 0 ||
3979 tmpstatbuf.st_dev != PL_statbuf.st_dev ||
3980 tmpstatbuf.st_ino != PL_statbuf.st_ino) {
3981 Perl_croak(aTHX_ "Setuid script changed\n");
3985 if (!cando(S_IXUSR,FALSE,&PL_statbuf)) /* can real uid exec? */
3986 Perl_croak(aTHX_ "Real UID cannot exec script\n");
3989 * We used to do this check as the "plain" user (after swapping
3990 * UIDs). But the check for nosuid and noexec filesystem is needed,
3991 * and should be done even without HAS_SETREUID. (Maybe those
3992 * operating systems do not have such mount options anyway...)
3993 * Seems safe enough to do as root.
3995 # if !defined(NO_NOSUID_CHECK)
3996 if (fd_on_nosuid_fs(PerlIO_fileno(rsfp))) {
3997 Perl_croak(aTHX_ "Setuid script on nosuid or noexec filesystem\n");
4000 # endif /* IAMSUID */
4002 if (!S_ISREG(PL_statbuf.st_mode)) {
4003 Perl_croak(aTHX_ "Setuid script not plain file\n");
4005 if (PL_statbuf.st_mode & S_IWOTH)
4006 Perl_croak(aTHX_ "Setuid/gid script is writable by world");
4007 PL_doswitches = FALSE; /* -s is insecure in suid */
4008 /* PSz 13 Nov 03 But -s was caught elsewhere ... so unsetting it here is useless(?!) */
4009 CopLINE_inc(PL_curcop);
4010 if (sv_gets(linestr_sv, rsfp, 0) == NULL)
4011 Perl_croak(aTHX_ "No #! line");
4012 linestr = SvPV_nolen_const(linestr_sv);
4013 /* required even on Sys V */
4014 if (!*linestr || !linestr[1] || strnNE(linestr,"#!",2))
4015 Perl_croak(aTHX_ "No #! line");
4019 /* Sanity check on line length */
4020 s_end = s + strlen(s);
4021 if (s_end == s || (s_end - s) > 4000)
4022 Perl_croak(aTHX_ "Very long #! line");
4023 /* Allow more than a single space after #! */
4024 while (isSPACE(*s)) s++;
4025 /* Sanity check on buffer end */
4026 while ((*s) && !isSPACE(*s)) s++;
4027 for (s2 = s; (s2 > linestr &&
4028 (isDIGIT(s2[-1]) || s2[-1] == '.' || s2[-1] == '_'
4029 || s2[-1] == '-')); s2--) ;
4030 /* Sanity check on buffer start */
4031 if ( (s2-4 < linestr || strnNE(s2-4,"perl",4)) &&
4032 (s-9 < linestr || strnNE(s-9,"perl",4)) )
4033 Perl_croak(aTHX_ "Not a perl script");
4034 while (*s == ' ' || *s == '\t') s++;
4036 * #! arg must be what we saw above. They can invoke it by
4037 * mentioning suidperl explicitly, but they may not add any strange
4038 * arguments beyond what #! says if they do invoke suidperl that way.
4041 * The way validarg was set up, we rely on the kernel to start
4042 * scripts with argv[1] set to contain all #! line switches (the
4046 * Check that we got all the arguments listed in the #! line (not
4047 * just that there are no extraneous arguments). Might not matter
4048 * much, as switches from #! line seem to be acted upon (also), and
4049 * so may be checked and trapped in perl. But, security checks must
4050 * be done in suidperl and not deferred to perl. Note that suidperl
4051 * does not get around to parsing (and checking) the switches on
4052 * the #! line (but execs perl sooner).
4053 * Allow (require) a trailing newline (which may be of two
4054 * characters on some architectures?) (but no other trailing
4057 len = strlen(validarg);
4058 if (strEQ(validarg," PHOOEY ") ||
4059 strnNE(s,validarg,len) || !isSPACE(s[len]) ||
4060 !((s_end - s) == len+1
4061 || ((s_end - s) == len+2 && isSPACE(s[len+1]))))
4062 Perl_croak(aTHX_ "Args must match #! line");
4066 PL_euid != PL_uid && (PL_statbuf.st_mode & S_ISUID) &&
4067 PL_euid == PL_statbuf.st_uid)
4069 Perl_croak(aTHX_ "YOU HAVEN'T DISABLED SET-ID SCRIPTS IN THE KERNEL YET!\n\
4070 FIX YOUR KERNEL, OR PUT A C WRAPPER AROUND THIS SCRIPT!\n");
4071 # endif /* IAMSUID */
4074 PL_euid) { /* oops, we're not the setuid root perl */
4076 * When root runs a setuid script, we do not go through the same
4077 * steps of execing sperl and then perl with fd scripts, but
4078 * simply set up UIDs within the same perl invocation; so do
4079 * not have the same checks (on options, whatever) that we have
4080 * for plain users. No problem really: would have to be a script
4081 * that does not actually work for plain users; and if root is
4082 * foolish and can be persuaded to run such an unsafe script, he
4083 * might run also non-setuid ones, and deserves what he gets.
4085 * Or, we might drop the PL_euid check above (and rely just on
4086 * fdscript to avoid loops), and do the execs
4092 * Pass fd script to suidperl.
4093 * Exec suidperl, substituting fd script for scriptname.
4094 * Pass script name as "subdir" of fd, which perl will grok;
4095 * in fact will use that to distinguish this from "normal"
4096 * usage, see comments above.
4098 PerlIO_rewind(rsfp);
4099 PerlLIO_lseek(PerlIO_fileno(rsfp),(Off_t)0,0); /* just in case rewind didn't */
4100 /* PSz 27 Feb 04 Sanity checks on scriptname */
4101 if ((!scriptname) || (!*scriptname) ) {
4102 Perl_croak(aTHX_ "No setuid script name\n");
4104 if (*scriptname == '-') {
4105 Perl_croak(aTHX_ "Setuid script name may not begin with dash\n");
4106 /* Or we might confuse it with an option when replacing
4107 * name in argument list, below (though we do pointer, not
4108 * string, comparisons).
4111 for (which = 1; PL_origargv[which] && PL_origargv[which] != scriptname; which++) ;
4112 if (!PL_origargv[which]) {
4113 Perl_croak(aTHX_ "Can't change argv to have fd script\n");
4115 PL_origargv[which] = savepv(Perl_form(aTHX_ "/dev/fd/%d/%s",
4116 PerlIO_fileno(rsfp), PL_origargv[which]));
4117 # if defined(HAS_FCNTL) && defined(F_SETFD)
4118 fcntl(PerlIO_fileno(rsfp),F_SETFD,0); /* ensure no close-on-exec */
4121 PerlProc_execv(Perl_form(aTHX_ "%s/sperl"PERL_FS_VER_FMT, BIN_EXP,
4122 (int)PERL_REVISION, (int)PERL_VERSION,
4123 (int)PERL_SUBVERSION), PL_origargv);
4125 # endif /* IAMSUID */
4126 Perl_croak(aTHX_ "Can't do setuid (cannot exec sperl)\n");
4129 if (PL_statbuf.st_mode & S_ISGID && PL_statbuf.st_gid != PL_egid) {
4131 * This seems back to front: we try HAS_SETEGID first; if not available
4132 * then try HAS_SETREGID; as a last chance we try HAS_SETRESGID. May be OK
4133 * in the sense that we only want to set EGID; but are there any machines
4134 * with either of the latter, but not the former? Same with UID, later.
4137 (void)setegid(PL_statbuf.st_gid);
4139 # ifdef HAS_SETREGID
4140 (void)setregid((Gid_t)-1,PL_statbuf.st_gid);
4142 # ifdef HAS_SETRESGID
4143 (void)setresgid((Gid_t)-1,PL_statbuf.st_gid,(Gid_t)-1);
4145 PerlProc_setgid(PL_statbuf.st_gid);
4149 if (PerlProc_getegid() != PL_statbuf.st_gid)
4150 Perl_croak(aTHX_ "Can't do setegid!\n");
4152 if (PL_statbuf.st_mode & S_ISUID) {
4153 if (PL_statbuf.st_uid != PL_euid)
4155 (void)seteuid(PL_statbuf.st_uid); /* all that for this */
4157 # ifdef HAS_SETREUID
4158 (void)setreuid((Uid_t)-1,PL_statbuf.st_uid);
4160 # ifdef HAS_SETRESUID
4161 (void)setresuid((Uid_t)-1,PL_statbuf.st_uid,(Uid_t)-1);
4163 PerlProc_setuid(PL_statbuf.st_uid);
4167 if (PerlProc_geteuid() != PL_statbuf.st_uid)
4168 Perl_croak(aTHX_ "Can't do seteuid!\n");
4170 else if (PL_uid) { /* oops, mustn't run as root */
4172 (void)seteuid((Uid_t)PL_uid);
4174 # ifdef HAS_SETREUID
4175 (void)setreuid((Uid_t)-1,(Uid_t)PL_uid);
4177 # ifdef HAS_SETRESUID
4178 (void)setresuid((Uid_t)-1,(Uid_t)PL_uid,(Uid_t)-1);
4180 PerlProc_setuid((Uid_t)PL_uid);
4184 if (PerlProc_geteuid() != PL_uid)
4185 Perl_croak(aTHX_ "Can't do seteuid!\n");
4188 if (!cando(S_IXUSR,TRUE,&PL_statbuf))
4189 Perl_croak(aTHX_ "Effective UID cannot exec script\n"); /* they can't do this */
4192 else if (PL_preprocess) /* PSz 13 Nov 03 Caught elsewhere, useless(?!) here */
4193 Perl_croak(aTHX_ "-P not allowed for setuid/setgid script\n");
4194 else if (fdscript < 0 || suidscript != 1)
4195 /* PSz 13 Nov 03 Caught elsewhere, useless(?!) here */
4196 Perl_croak(aTHX_ "(suid) fdscript needed in suidperl\n");
4198 /* PSz 16 Sep 03 Keep neat error message */
4199 Perl_croak(aTHX_ "Script is not setuid/setgid in suidperl\n");
4202 /* We absolutely must clear out any saved ids here, so we */
4203 /* exec the real perl, substituting fd script for scriptname. */
4204 /* (We pass script name as "subdir" of fd, which perl will grok.) */
4206 * It might be thought that using setresgid and/or setresuid (changed to
4207 * set the saved IDs) above might obviate the need to exec, and we could
4208 * go on to "do the perl thing".
4210 * Is there such a thing as "saved GID", and is that set for setuid (but
4211 * not setgid) execution like suidperl? Without exec, it would not be
4212 * cleared for setuid (but not setgid) scripts (or might need a dummy
4215 * We need suidperl to do the exact same argument checking that perl
4216 * does. Thus it cannot be very small; while it could be significantly
4217 * smaller, it is safer (simpler?) to make it essentially the same
4218 * binary as perl (but they are not identical). - Maybe could defer that
4219 * check to the invoked perl, and suidperl be a tiny wrapper instead;
4220 * but prefer to do thorough checks in suidperl itself. Such deferral
4221 * would make suidperl security rely on perl, a design no-no.
4223 * Setuid things should be short and simple, thus easy to understand and
4224 * verify. They should do their "own thing", without influence by
4225 * attackers. It may help if their internal execution flow is fixed,
4226 * regardless of platform: it may be best to exec anyway.
4228 * Suidperl should at least be conceptually simple: a wrapper only,
4229 * never to do any real perl. Maybe we should put
4231 * Perl_croak(aTHX_ "Suidperl should never do real perl\n");
4233 * into the perly bits.
4235 PerlIO_rewind(rsfp);
4236 PerlLIO_lseek(PerlIO_fileno(rsfp),(Off_t)0,0); /* just in case rewind didn't */
4238 * Keep original arguments: suidperl already has fd script.
4240 /* for (which = 1; PL_origargv[which] && PL_origargv[which] != scriptname; which++) ; */
4241 /* if (!PL_origargv[which]) { */
4242 /* errno = EPERM; */
4243 /* Perl_croak(aTHX_ "Permission denied\n"); */
4245 /* PL_origargv[which] = savepv(Perl_form(aTHX_ "/dev/fd/%d/%s", */
4246 /* PerlIO_fileno(rsfp), PL_origargv[which])); */
4247 # if defined(HAS_FCNTL) && defined(F_SETFD)
4248 fcntl(PerlIO_fileno(rsfp),F_SETFD,0); /* ensure no close-on-exec */
4251 PerlProc_execv(Perl_form(aTHX_ "%s/perl"PERL_FS_VER_FMT, BIN_EXP,
4252 (int)PERL_REVISION, (int)PERL_VERSION,
4253 (int)PERL_SUBVERSION), PL_origargv);/* try again */
4255 Perl_croak(aTHX_ "Can't do setuid (suidperl cannot exec perl)\n");
4256 # endif /* IAMSUID */
4258 PERL_UNUSED_ARG(fdscript);
4259 PERL_UNUSED_ARG(suidscript);
4260 if (PL_euid != PL_uid || PL_egid != PL_gid) { /* (suidperl doesn't exist, in fact) */
4261 # ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
4262 PERL_UNUSED_ARG(rsfp);
4264 PerlLIO_fstat(PerlIO_fileno(rsfp),&PL_statbuf); /* may be either wrapped or real suid */
4265 if ((PL_euid != PL_uid && PL_euid == PL_statbuf.st_uid && PL_statbuf.st_mode & S_ISUID)
4267 (PL_egid != PL_gid && PL_egid == PL_statbuf.st_gid && PL_statbuf.st_mode & S_ISGID)
4270 Perl_croak(aTHX_ "YOU HAVEN'T DISABLED SET-ID SCRIPTS IN THE KERNEL YET!\n\
4271 FIX YOUR KERNEL, PUT A C WRAPPER AROUND THIS SCRIPT, OR USE -u AND UNDUMP!\n");
4272 # endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4273 /* not set-id, must be wrapped */
4276 PERL_UNUSED_ARG(validarg);
4277 PERL_UNUSED_ARG(scriptname);
4278 PERL_UNUSED_ARG(linestr_sv);
4282 S_find_beginning(pTHX_ SV* linestr_sv, PerlIO *rsfp)
4286 register const char *s2;
4287 #ifdef MACOS_TRADITIONAL
4291 /* skip forward in input to the real script? */
4293 #ifdef MACOS_TRADITIONAL
4294 /* Since the Mac OS does not honor #! arguments for us, we do it ourselves */
4296 while (PL_doextract || gMacPerl_AlwaysExtract) {
4297 if ((s = sv_gets(linestr_sv, rsfp, 0)) == NULL) {
4298 if (!gMacPerl_AlwaysExtract)
4299 Perl_croak(aTHX_ "No Perl script found in input\n");
4301 if (PL_doextract) /* require explicit override ? */
4302 if (!OverrideExtract(PL_origfilename))
4303 Perl_croak(aTHX_ "User aborted script\n");
4305 PL_doextract = FALSE;
4307 /* Pater peccavi, file does not have #! */
4308 PerlIO_rewind(rsfp);
4313 while (PL_doextract) {
4314 if ((s = sv_gets(linestr_sv, rsfp, 0)) == NULL)
4315 Perl_croak(aTHX_ "No Perl script found in input\n");
4318 if (*s == '#' && s[1] == '!' && ((s = instr(s,"perl")) || (s = instr(s2,"PERL")))) {
4319 PerlIO_ungetc(rsfp, '\n'); /* to keep line count right */
4320 PL_doextract = FALSE;
4321 while (*s && !(isSPACE (*s) || *s == '#')) s++;
4323 while (*s == ' ' || *s == '\t') s++;
4325 while (isDIGIT(s2[-1]) || s2[-1] == '-' || s2[-1] == '.'
4326 || s2[-1] == '_') s2--;
4327 if (strnEQ(s2-4,"perl",4))
4328 while ((s = moreswitches(s)))
4331 #ifdef MACOS_TRADITIONAL
4332 /* We are always searching for the #!perl line in MacPerl,
4333 * so if we find it, still keep the line count correct
4334 * by counting lines we already skipped over
4336 for (; maclines > 0 ; maclines--)
4337 PerlIO_ungetc(rsfp, '\n');
4341 /* gMacPerl_AlwaysExtract is false in MPW tool */
4342 } else if (gMacPerl_AlwaysExtract) {
4354 PL_uid = PerlProc_getuid();
4355 PL_euid = PerlProc_geteuid();
4356 PL_gid = PerlProc_getgid();
4357 PL_egid = PerlProc_getegid();
4359 PL_uid |= PL_gid << 16;
4360 PL_euid |= PL_egid << 16;
4362 /* Should not happen: */
4363 CHECK_MALLOC_TAINT(PL_uid && (PL_euid != PL_uid || PL_egid != PL_gid));
4364 PL_tainting |= (PL_uid && (PL_euid != PL_uid || PL_egid != PL_gid));
4367 * Should go by suidscript, not uid!=euid: why disallow
4368 * system("ls") in scripts run from setuid things?
4369 * Or, is this run before we check arguments and set suidscript?
4370 * What about SETUID_SCRIPTS_ARE_SECURE_NOW: could we use fdscript then?
4371 * (We never have suidscript, can we be sure to have fdscript?)
4372 * Or must then go by UID checks? See comments in forbid_setid also.
4376 /* This is used very early in the lifetime of the program,
4377 * before even the options are parsed, so PL_tainting has
4378 * not been initialized properly. */
4380 Perl_doing_taint(int argc, char *argv[], char *envp[])
4382 #ifndef PERL_IMPLICIT_SYS
4383 /* If we have PERL_IMPLICIT_SYS we can't call getuid() et alia
4384 * before we have an interpreter-- and the whole point of this
4385 * function is to be called at such an early stage. If you are on
4386 * a system with PERL_IMPLICIT_SYS but you do have a concept of
4387 * "tainted because running with altered effective ids', you'll
4388 * have to add your own checks somewhere in here. The two most
4389 * known samples of 'implicitness' are Win32 and NetWare, neither
4390 * of which has much of concept of 'uids'. */
4391 int uid = PerlProc_getuid();
4392 int euid = PerlProc_geteuid();
4393 int gid = PerlProc_getgid();
4394 int egid = PerlProc_getegid();
4401 if (uid && (euid != uid || egid != gid))
4403 #endif /* !PERL_IMPLICIT_SYS */
4404 /* This is a really primitive check; environment gets ignored only
4405 * if -T are the first chars together; otherwise one gets
4406 * "Too late" message. */
4407 if ( argc > 1 && argv[1][0] == '-'
4408 && (argv[1][1] == 't' || argv[1][1] == 'T') )
4413 /* Passing the flag as a single char rather than a string is a slight space
4414 optimisation. The only message that isn't /^-.$/ is
4415 "program input from stdin", which is substituted in place of '\0', which
4416 could never be a command line flag. */
4418 S_forbid_setid(pTHX_ const char flag, const int suidscript)
4421 char string[3] = "-x";
4422 const char *message = "program input from stdin";
4429 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
4430 if (PL_euid != PL_uid)
4431 Perl_croak(aTHX_ "No %s allowed while running setuid", message);
4432 if (PL_egid != PL_gid)
4433 Perl_croak(aTHX_ "No %s allowed while running setgid", message);
4434 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4436 * Checks for UID/GID above "wrong": why disallow
4437 * perl -e 'print "Hello\n"'
4438 * from within setuid things?? Simply drop them: replaced by
4439 * fdscript/suidscript and #ifdef IAMSUID checks below.
4441 * This may be too late for command-line switches. Will catch those on
4442 * the #! line, after finding the script name and setting up
4443 * fdscript/suidscript. Note that suidperl does not get around to
4444 * parsing (and checking) the switches on the #! line, but checks that
4445 * the two sets are identical.
4447 * With SETUID_SCRIPTS_ARE_SECURE_NOW, could we use fdscript, also or
4448 * instead, or would that be "too late"? (We never have suidscript, can
4449 * we be sure to have fdscript?)
4451 * Catch things with suidscript (in descendant of suidperl), even with
4452 * right UID/GID. Was already checked in suidperl, with #ifdef IAMSUID,
4453 * below; but I am paranoid.
4455 * Also see comments about root running a setuid script, elsewhere.
4457 if (suidscript >= 0)
4458 Perl_croak(aTHX_ "No %s allowed with (suid) fdscript", message);
4460 /* PSz 11 Nov 03 Catch it in suidperl, always! */
4461 Perl_croak(aTHX_ "No %s allowed in suidperl", message);
4462 #endif /* IAMSUID */
4466 Perl_init_debugger(pTHX)
4469 HV * const ostash = PL_curstash;
4471 PL_curstash = PL_debstash;
4472 PL_dbargs = GvAV(gv_AVadd((gv_fetchpvs("DB::args", GV_ADDMULTI,
4474 AvREAL_off(PL_dbargs);
4475 PL_DBgv = gv_fetchpvs("DB::DB", GV_ADDMULTI, SVt_PVGV);
4476 PL_DBline = gv_fetchpvs("DB::dbline", GV_ADDMULTI, SVt_PVAV);
4477 PL_DBsub = gv_HVadd(gv_fetchpvs("DB::sub", GV_ADDMULTI, SVt_PVHV));
4478 PL_DBsingle = GvSV((gv_fetchpvs("DB::single", GV_ADDMULTI, SVt_PV)));
4479 sv_setiv(PL_DBsingle, 0);
4480 PL_DBtrace = GvSV((gv_fetchpvs("DB::trace", GV_ADDMULTI, SVt_PV)));
4481 sv_setiv(PL_DBtrace, 0);
4482 PL_DBsignal = GvSV((gv_fetchpvs("DB::signal", GV_ADDMULTI, SVt_PV)));
4483 sv_setiv(PL_DBsignal, 0);
4484 PL_curstash = ostash;
4487 #ifndef STRESS_REALLOC
4488 #define REASONABLE(size) (size)
4490 #define REASONABLE(size) (1) /* unreasonable */
4494 Perl_init_stacks(pTHX)
4497 /* start with 128-item stack and 8K cxstack */
4498 PL_curstackinfo = new_stackinfo(REASONABLE(128),
4499 REASONABLE(8192/sizeof(PERL_CONTEXT) - 1));
4500 PL_curstackinfo->si_type = PERLSI_MAIN;
4501 PL_curstack = PL_curstackinfo->si_stack;
4502 PL_mainstack = PL_curstack; /* remember in case we switch stacks */
4504 PL_stack_base = AvARRAY(PL_curstack);
4505 PL_stack_sp = PL_stack_base;
4506 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
4508 Newx(PL_tmps_stack,REASONABLE(128),SV*);
4511 PL_tmps_max = REASONABLE(128);
4513 Newx(PL_markstack,REASONABLE(32),I32);
4514 PL_markstack_ptr = PL_markstack;
4515 PL_markstack_max = PL_markstack + REASONABLE(32);
4519 Newx(PL_scopestack,REASONABLE(32),I32);
4520 PL_scopestack_ix = 0;
4521 PL_scopestack_max = REASONABLE(32);
4523 Newx(PL_savestack,REASONABLE(128),ANY);
4524 PL_savestack_ix = 0;
4525 PL_savestack_max = REASONABLE(128);
4534 while (PL_curstackinfo->si_next)
4535 PL_curstackinfo = PL_curstackinfo->si_next;
4536 while (PL_curstackinfo) {
4537 PERL_SI *p = PL_curstackinfo->si_prev;
4538 /* curstackinfo->si_stack got nuked by sv_free_arenas() */
4539 Safefree(PL_curstackinfo->si_cxstack);
4540 Safefree(PL_curstackinfo);
4541 PL_curstackinfo = p;
4543 Safefree(PL_tmps_stack);
4544 Safefree(PL_markstack);
4545 Safefree(PL_scopestack);
4546 Safefree(PL_savestack);
4551 S_init_predump_symbols(pTHX)
4557 sv_setpvn(get_sv("\"", TRUE), " ", 1);
4558 PL_stdingv = gv_fetchpvs("STDIN", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4559 GvMULTI_on(PL_stdingv);
4560 io = GvIOp(PL_stdingv);
4561 IoTYPE(io) = IoTYPE_RDONLY;
4562 IoIFP(io) = PerlIO_stdin();
4563 tmpgv = gv_fetchpvs("stdin", GV_ADD|GV_NOTQUAL, SVt_PV);
4565 GvIOp(tmpgv) = (IO*)SvREFCNT_inc_simple(io);
4567 tmpgv = gv_fetchpvs("STDOUT", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4570 IoTYPE(io) = IoTYPE_WRONLY;
4571 IoOFP(io) = IoIFP(io) = PerlIO_stdout();
4573 tmpgv = gv_fetchpvs("stdout", GV_ADD|GV_NOTQUAL, SVt_PV);
4575 GvIOp(tmpgv) = (IO*)SvREFCNT_inc_simple(io);
4577 PL_stderrgv = gv_fetchpvs("STDERR", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4578 GvMULTI_on(PL_stderrgv);
4579 io = GvIOp(PL_stderrgv);
4580 IoTYPE(io) = IoTYPE_WRONLY;
4581 IoOFP(io) = IoIFP(io) = PerlIO_stderr();
4582 tmpgv = gv_fetchpvs("stderr", GV_ADD|GV_NOTQUAL, SVt_PV);
4584 GvIOp(tmpgv) = (IO*)SvREFCNT_inc_simple(io);
4586 PL_statname = newSV(0); /* last filename we did stat on */
4588 Safefree(PL_osname);
4589 PL_osname = savepv(OSNAME);
4593 Perl_init_argv_symbols(pTHX_ register int argc, register char **argv)
4596 argc--,argv++; /* skip name of script */
4597 if (PL_doswitches) {
4598 for (; argc > 0 && **argv == '-'; argc--,argv++) {
4602 if (argv[0][1] == '-' && !argv[0][2]) {
4606 if ((s = strchr(argv[0], '='))) {
4607 const char *const start_name = argv[0] + 1;
4608 sv_setpv(GvSV(gv_fetchpvn_flags(start_name, s - start_name,
4609 TRUE, SVt_PV)), s + 1);
4612 sv_setiv(GvSV(gv_fetchpv(argv[0]+1, GV_ADD, SVt_PV)),1);
4615 if ((PL_argvgv = gv_fetchpvs("ARGV", GV_ADD|GV_NOTQUAL, SVt_PVAV))) {
4616 GvMULTI_on(PL_argvgv);
4617 (void)gv_AVadd(PL_argvgv);
4618 av_clear(GvAVn(PL_argvgv));
4619 for (; argc > 0; argc--,argv++) {
4620 SV * const sv = newSVpv(argv[0],0);
4621 av_push(GvAVn(PL_argvgv),sv);
4622 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
4623 if (PL_unicode & PERL_UNICODE_ARGV_FLAG)
4626 if (PL_unicode & PERL_UNICODE_WIDESYSCALLS_FLAG) /* Sarathy? */
4627 (void)sv_utf8_decode(sv);
4633 S_init_postdump_symbols(pTHX_ register int argc, register char **argv, register char **env)
4638 PL_toptarget = newSV_type(SVt_PVFM);
4639 sv_setpvn(PL_toptarget, "", 0);
4640 PL_bodytarget = newSV_type(SVt_PVFM);
4641 sv_setpvn(PL_bodytarget, "", 0);
4642 PL_formtarget = PL_bodytarget;
4646 init_argv_symbols(argc,argv);
4648 if ((tmpgv = gv_fetchpvs("0", GV_ADD|GV_NOTQUAL, SVt_PV))) {
4649 #ifdef MACOS_TRADITIONAL
4650 /* $0 is not majick on a Mac */
4651 sv_setpv(GvSV(tmpgv),MacPerl_MPWFileName(PL_origfilename));
4653 sv_setpv(GvSV(tmpgv),PL_origfilename);
4654 magicname("0", "0", 1);
4657 if ((PL_envgv = gv_fetchpvs("ENV", GV_ADD|GV_NOTQUAL, SVt_PVHV))) {
4659 bool env_is_not_environ;
4660 GvMULTI_on(PL_envgv);
4661 hv = GvHVn(PL_envgv);
4662 hv_magic(hv, NULL, PERL_MAGIC_env);
4664 #ifdef USE_ENVIRON_ARRAY
4665 /* Note that if the supplied env parameter is actually a copy
4666 of the global environ then it may now point to free'd memory
4667 if the environment has been modified since. To avoid this
4668 problem we treat env==NULL as meaning 'use the default'
4672 env_is_not_environ = env != environ;
4673 if (env_is_not_environ
4674 # ifdef USE_ITHREADS
4675 && PL_curinterp == aTHX
4684 for (; *env; env++) {
4685 if (!(s = strchr(*env,'=')) || s == *env)
4687 #if defined(MSDOS) && !defined(DJGPP)
4692 sv = newSVpv(s+1, 0);
4693 (void)hv_store(hv, *env, s - *env, sv, 0);
4694 if (env_is_not_environ)
4698 #endif /* USE_ENVIRON_ARRAY */
4699 #endif /* !PERL_MICRO */
4702 if ((tmpgv = gv_fetchpvs("$", GV_ADD|GV_NOTQUAL, SVt_PV))) {
4703 SvREADONLY_off(GvSV(tmpgv));
4704 sv_setiv(GvSV(tmpgv), (IV)PerlProc_getpid());
4705 SvREADONLY_on(GvSV(tmpgv));
4707 #ifdef THREADS_HAVE_PIDS
4708 PL_ppid = (IV)getppid();
4711 /* touch @F array to prevent spurious warnings 20020415 MJD */
4713 (void) get_av("main::F", TRUE | GV_ADDMULTI);
4718 S_init_perllib(pTHX)
4724 s = PerlEnv_getenv("PERL5LIB");
4726 * It isn't possible to delete an environment variable with
4727 * PERL_USE_SAFE_PUTENV set unless unsetenv() is also available, so in that
4728 * case we treat PERL5LIB as undefined if it has a zero-length value.
4730 #if defined(PERL_USE_SAFE_PUTENV) && ! defined(HAS_UNSETENV)
4731 if (s && *s != '\0')
4735 incpush(s, TRUE, TRUE, TRUE, FALSE);
4737 incpush(PerlEnv_getenv("PERLLIB"), FALSE, FALSE, TRUE, FALSE);
4739 /* Treat PERL5?LIB as a possible search list logical name -- the
4740 * "natural" VMS idiom for a Unix path string. We allow each
4741 * element to be a set of |-separated directories for compatibility.
4745 if (my_trnlnm("PERL5LIB",buf,0))
4746 do { incpush(buf,TRUE,TRUE,TRUE,FALSE); } while (my_trnlnm("PERL5LIB",buf,++idx));
4748 while (my_trnlnm("PERLLIB",buf,idx++)) incpush(buf,FALSE,FALSE,TRUE,FALSE);
4752 /* Use the ~-expanded versions of APPLLIB (undocumented),
4753 ARCHLIB PRIVLIB SITEARCH SITELIB VENDORARCH and VENDORLIB
4756 incpush(APPLLIB_EXP, TRUE, TRUE, TRUE, TRUE);
4760 incpush(ARCHLIB_EXP, FALSE, FALSE, TRUE, TRUE);
4762 #ifdef MACOS_TRADITIONAL
4765 SV * privdir = newSV(0);
4766 char * macperl = PerlEnv_getenv("MACPERL");
4771 Perl_sv_setpvf(aTHX_ privdir, "%slib:", macperl);
4772 if (PerlLIO_stat(SvPVX(privdir), &tmpstatbuf) >= 0 && S_ISDIR(tmpstatbuf.st_mode))
4773 incpush(SvPVX(privdir), TRUE, FALSE, TRUE, FALSE);
4774 Perl_sv_setpvf(aTHX_ privdir, "%ssite_perl:", macperl);
4775 if (PerlLIO_stat(SvPVX(privdir), &tmpstatbuf) >= 0 && S_ISDIR(tmpstatbuf.st_mode))
4776 incpush(SvPVX(privdir), TRUE, FALSE, TRUE, FALSE);
4778 SvREFCNT_dec(privdir);
4781 incpush(":", FALSE, FALSE, TRUE, FALSE);
4784 # define PRIVLIB_EXP "/usr/local/lib/perl5:/usr/local/lib/perl"
4787 incpush(PRIVLIB_EXP, TRUE, FALSE, TRUE, TRUE);
4789 incpush(PRIVLIB_EXP, FALSE, FALSE, TRUE, TRUE);
4793 /* sitearch is always relative to sitelib on Windows for
4794 * DLL-based path intuition to work correctly */
4795 # if !defined(WIN32)
4796 incpush(SITEARCH_EXP, FALSE, FALSE, TRUE, TRUE);
4802 /* this picks up sitearch as well */
4803 incpush(SITELIB_EXP, TRUE, FALSE, TRUE, TRUE);
4805 incpush(SITELIB_EXP, FALSE, FALSE, TRUE, TRUE);
4809 #if defined(SITELIB_STEM) && defined(PERL_INC_VERSION_LIST)
4810 /* Search for version-specific dirs below here */
4811 incpush(SITELIB_STEM, FALSE, TRUE, TRUE, TRUE);
4814 #ifdef PERL_VENDORARCH_EXP
4815 /* vendorarch is always relative to vendorlib on Windows for
4816 * DLL-based path intuition to work correctly */
4817 # if !defined(WIN32)
4818 incpush(PERL_VENDORARCH_EXP, FALSE, FALSE, TRUE, TRUE);
4822 #ifdef PERL_VENDORLIB_EXP
4824 incpush(PERL_VENDORLIB_EXP, TRUE, FALSE, TRUE, TRUE); /* this picks up vendorarch as well */
4826 incpush(PERL_VENDORLIB_EXP, FALSE, FALSE, TRUE, TRUE);
4830 #ifdef PERL_VENDORLIB_STEM /* Search for version-specific dirs below here */
4831 incpush(PERL_VENDORLIB_STEM, FALSE, TRUE, TRUE, TRUE);
4834 #ifdef PERL_OTHERLIBDIRS
4835 incpush(PERL_OTHERLIBDIRS, TRUE, TRUE, TRUE, TRUE);
4839 incpush(".", FALSE, FALSE, TRUE, FALSE);
4840 #endif /* MACOS_TRADITIONAL */
4843 #if defined(DOSISH) || defined(EPOC) || defined(__SYMBIAN32__)
4844 # define PERLLIB_SEP ';'
4847 # define PERLLIB_SEP '|'
4849 # if defined(MACOS_TRADITIONAL)
4850 # define PERLLIB_SEP ','
4852 # define PERLLIB_SEP ':'
4856 #ifndef PERLLIB_MANGLE
4857 # define PERLLIB_MANGLE(s,n) (s)
4860 /* Push a directory onto @INC if it exists.
4861 Generate a new SV if we do this, to save needing to copy the SV we push
4864 S_incpush_if_exists(pTHX_ SV *dir)
4868 if (PerlLIO_stat(SvPVX_const(dir), &tmpstatbuf) >= 0 &&
4869 S_ISDIR(tmpstatbuf.st_mode)) {
4870 av_push(GvAVn(PL_incgv), dir);
4877 S_incpush(pTHX_ const char *dir, bool addsubdirs, bool addoldvers, bool usesep,
4882 const char *p = dir;
4887 if (addsubdirs || addoldvers) {
4891 /* Break at all separators */
4893 SV *libdir = newSV(0);
4896 /* skip any consecutive separators */
4898 while ( *p == PERLLIB_SEP ) {
4899 /* Uncomment the next line for PATH semantics */
4900 /* av_push(GvAVn(PL_incgv), newSVpvs(".")); */
4905 if ( usesep && (s = strchr(p, PERLLIB_SEP)) != NULL ) {
4906 sv_setpvn(libdir, PERLLIB_MANGLE(p, (STRLEN)(s - p)),
4911 sv_setpv(libdir, PERLLIB_MANGLE(p, 0));
4912 p = NULL; /* break out */
4914 #ifdef MACOS_TRADITIONAL
4915 if (!strchr(SvPVX(libdir), ':')) {
4918 sv_setpv(libdir, MacPerl_CanonDir(SvPVX(libdir), buf, 0));
4920 if (SvPVX(libdir)[SvCUR(libdir)-1] != ':')
4921 sv_catpvs(libdir, ":");
4924 /* Do the if() outside the #ifdef to avoid warnings about an unused
4927 #ifdef PERL_RELOCATABLE_INC
4929 * Relocatable include entries are marked with a leading .../
4932 * 0: Remove that leading ".../"
4933 * 1: Remove trailing executable name (anything after the last '/')
4934 * from the perl path to give a perl prefix
4936 * While the @INC element starts "../" and the prefix ends with a real
4937 * directory (ie not . or ..) chop that real directory off the prefix
4938 * and the leading "../" from the @INC element. ie a logical "../"
4940 * Finally concatenate the prefix and the remainder of the @INC element
4941 * The intent is that /usr/local/bin/perl and .../../lib/perl5
4942 * generates /usr/local/lib/perl5
4944 const char *libpath = SvPVX(libdir);
4945 STRLEN libpath_len = SvCUR(libdir);
4946 if (libpath_len >= 4 && memEQ (libpath, ".../", 4)) {
4948 SV * const caret_X = get_sv("\030", 0);
4949 /* Going to use the SV just as a scratch buffer holding a C
4955 /* $^X is *the* source of taint if tainting is on, hence
4956 SvPOK() won't be true. */
4958 assert(SvPOKp(caret_X));
4959 prefix_sv = newSVpvn_flags(SvPVX(caret_X), SvCUR(caret_X),
4961 /* Firstly take off the leading .../
4962 If all else fail we'll do the paths relative to the current
4964 sv_chop(libdir, libpath + 4);
4965 /* Don't use SvPV as we're intentionally bypassing taining,
4966 mortal copies that the mg_get of tainting creates, and
4967 corruption that seems to come via the save stack.
4968 I guess that the save stack isn't correctly set up yet. */
4969 libpath = SvPVX(libdir);
4970 libpath_len = SvCUR(libdir);
4972 /* This would work more efficiently with memrchr, but as it's
4973 only a GNU extension we'd need to probe for it and
4974 implement our own. Not hard, but maybe not worth it? */
4976 prefix = SvPVX(prefix_sv);
4977 lastslash = strrchr(prefix, '/');
4979 /* First time in with the *lastslash = '\0' we just wipe off
4980 the trailing /perl from (say) /usr/foo/bin/perl
4984 while ((*lastslash = '\0'), /* Do that, come what may. */
4985 (libpath_len >= 3 && memEQ(libpath, "../", 3)
4986 && (lastslash = strrchr(prefix, '/')))) {
4987 if (lastslash[1] == '\0'
4988 || (lastslash[1] == '.'
4989 && (lastslash[2] == '/' /* ends "/." */
4990 || (lastslash[2] == '/'
4991 && lastslash[3] == '/' /* or "/.." */
4993 /* Prefix ends "/" or "/." or "/..", any of which
4994 are fishy, so don't do any more logical cleanup.
4998 /* Remove leading "../" from path */
5001 /* Next iteration round the loop removes the last
5002 directory name from prefix by writing a '\0' in
5003 the while clause. */
5005 /* prefix has been terminated with a '\0' to the correct
5006 length. libpath points somewhere into the libdir SV.
5007 We need to join the 2 with '/' and drop the result into
5009 tempsv = Perl_newSVpvf(aTHX_ "%s/%s", prefix, libpath);
5010 SvREFCNT_dec(libdir);
5011 /* And this is the new libdir. */
5014 (PL_uid != PL_euid || PL_gid != PL_egid)) {
5015 /* Need to taint reloccated paths if running set ID */
5016 SvTAINTED_on(libdir);
5019 SvREFCNT_dec(prefix_sv);
5024 * BEFORE pushing libdir onto @INC we may first push version- and
5025 * archname-specific sub-directories.
5027 if (addsubdirs || addoldvers) {
5028 #ifdef PERL_INC_VERSION_LIST
5029 /* Configure terminates PERL_INC_VERSION_LIST with a NULL */
5030 const char * const incverlist[] = { PERL_INC_VERSION_LIST };
5031 const char * const *incver;
5037 if ((unix = tounixspec_ts(SvPV(libdir,len),NULL)) != NULL) {
5039 while (unix[len-1] == '/') len--; /* Cosmetic */
5040 sv_usepvn(libdir,unix,len);
5043 PerlIO_printf(Perl_error_log,
5044 "Failed to unixify @INC element \"%s\"\n",
5048 #ifdef MACOS_TRADITIONAL
5049 #define PERL_AV_SUFFIX_FMT ""
5050 #define PERL_ARCH_FMT "%s:"
5051 #define PERL_ARCH_FMT_PATH PERL_FS_VER_FMT PERL_AV_SUFFIX_FMT
5053 #define PERL_AV_SUFFIX_FMT "/"
5054 #define PERL_ARCH_FMT "/%s"
5055 #define PERL_ARCH_FMT_PATH PERL_AV_SUFFIX_FMT PERL_FS_VER_FMT
5057 /* .../version/archname if -d .../version/archname */
5058 Perl_sv_setpvf(aTHX_ subdir, "%"SVf PERL_ARCH_FMT_PATH PERL_ARCH_FMT,
5060 (int)PERL_REVISION, (int)PERL_VERSION,
5061 (int)PERL_SUBVERSION, ARCHNAME);
5062 subdir = S_incpush_if_exists(aTHX_ subdir);
5064 /* .../version if -d .../version */
5065 Perl_sv_setpvf(aTHX_ subdir, "%"SVf PERL_ARCH_FMT_PATH,
5067 (int)PERL_REVISION, (int)PERL_VERSION,
5068 (int)PERL_SUBVERSION);
5069 subdir = S_incpush_if_exists(aTHX_ subdir);
5071 /* .../archname if -d .../archname */
5072 Perl_sv_setpvf(aTHX_ subdir, "%"SVf PERL_ARCH_FMT,
5073 SVfARG(libdir), ARCHNAME);
5074 subdir = S_incpush_if_exists(aTHX_ subdir);
5078 #ifdef PERL_INC_VERSION_LIST
5080 for (incver = incverlist; *incver; incver++) {
5081 /* .../xxx if -d .../xxx */
5082 Perl_sv_setpvf(aTHX_ subdir, "%"SVf PERL_ARCH_FMT,
5083 SVfARG(libdir), *incver);
5084 subdir = S_incpush_if_exists(aTHX_ subdir);
5090 /* finally push this lib directory on the end of @INC */
5091 av_push(GvAVn(PL_incgv), libdir);
5094 assert (SvREFCNT(subdir) == 1);
5095 SvREFCNT_dec(subdir);
5101 Perl_call_list(pTHX_ I32 oldscope, AV *paramList)
5105 volatile const line_t oldline = PL_curcop ? CopLINE(PL_curcop) : 0;
5111 while (av_len(paramList) >= 0) {
5112 cv = (CV*)av_shift(paramList);
5114 if (paramList == PL_beginav) {
5115 /* save PL_beginav for compiler */
5116 Perl_av_create_and_push(aTHX_ &PL_beginav_save, (SV*)cv);
5118 else if (paramList == PL_checkav) {
5119 /* save PL_checkav for compiler */
5120 Perl_av_create_and_push(aTHX_ &PL_checkav_save, (SV*)cv);
5122 else if (paramList == PL_unitcheckav) {
5123 /* save PL_unitcheckav for compiler */
5124 Perl_av_create_and_push(aTHX_ &PL_unitcheckav_save, (SV*)cv);
5135 PL_madskills |= 16384;
5140 PL_madskills &= ~16384;
5143 (void)SvPV_const(atsv, len);
5145 PL_curcop = &PL_compiling;
5146 CopLINE_set(PL_curcop, oldline);
5147 if (paramList == PL_beginav)
5148 sv_catpvs(atsv, "BEGIN failed--compilation aborted");
5150 Perl_sv_catpvf(aTHX_ atsv,
5151 "%s failed--call queue aborted",
5152 paramList == PL_checkav ? "CHECK"
5153 : paramList == PL_initav ? "INIT"
5154 : paramList == PL_unitcheckav ? "UNITCHECK"
5156 while (PL_scopestack_ix > oldscope)
5159 Perl_croak(aTHX_ "%"SVf"", SVfARG(atsv));
5166 /* my_exit() was called */
5167 while (PL_scopestack_ix > oldscope)
5170 PL_curstash = PL_defstash;
5171 PL_curcop = &PL_compiling;
5172 CopLINE_set(PL_curcop, oldline);
5174 if (PL_statusvalue && !(PL_exit_flags & PERL_EXIT_EXPECTED)) {
5175 if (paramList == PL_beginav)
5176 Perl_croak(aTHX_ "BEGIN failed--compilation aborted");
5178 Perl_croak(aTHX_ "%s failed--call queue aborted",
5179 paramList == PL_checkav ? "CHECK"
5180 : paramList == PL_initav ? "INIT"
5181 : paramList == PL_unitcheckav ? "UNITCHECK"
5188 PL_curcop = &PL_compiling;
5189 CopLINE_set(PL_curcop, oldline);
5192 PerlIO_printf(Perl_error_log, "panic: restartop\n");
5201 Perl_my_exit(pTHX_ U32 status)
5204 DEBUG_S(PerlIO_printf(Perl_debug_log, "my_exit: thread %p, status %lu\n",
5205 (void*)thr, (unsigned long) status));
5214 STATUS_EXIT_SET(status);
5221 Perl_my_failure_exit(pTHX)
5225 /* We have been called to fall on our sword. The desired exit code
5226 * should be already set in STATUS_UNIX, but could be shifted over
5227 * by 8 bits. STATUS_UNIX_EXIT_SET will handle the cases where a
5230 * If an error code has not been set, then force the issue.
5232 if (MY_POSIX_EXIT) {
5234 /* In POSIX_EXIT mode follow Perl documentations and use 255 for
5235 * the exit code when there isn't an error.
5238 if (STATUS_UNIX == 0)
5239 STATUS_UNIX_EXIT_SET(255);
5241 STATUS_UNIX_EXIT_SET(STATUS_UNIX);
5243 /* The exit code could have been set by $? or vmsish which
5244 * means that it may not be fatal. So convert
5245 * success/warning codes to fatal.
5247 if ((STATUS_NATIVE & (STS$K_SEVERE|STS$K_ERROR)) == 0)
5248 STATUS_UNIX_EXIT_SET(255);
5252 /* Traditionally Perl on VMS always expects a Fatal Error. */
5253 if (vaxc$errno & 1) {
5255 /* So force success status to failure */
5256 if (STATUS_NATIVE & 1)
5261 STATUS_UNIX = EINTR; /* In case something cares */
5266 STATUS_NATIVE = vaxc$errno; /* Should already be this */
5268 /* Encode the severity code */
5269 severity = STATUS_NATIVE & STS$M_SEVERITY;
5270 STATUS_UNIX = (severity ? severity : 1) << 8;
5272 /* Perl expects this to be a fatal error */
5273 if (severity != STS$K_SEVERE)
5282 STATUS_UNIX_SET(errno);
5284 exitstatus = STATUS_UNIX >> 8;
5285 if (exitstatus & 255)
5286 STATUS_UNIX_SET(exitstatus);
5288 STATUS_UNIX_SET(255);
5295 S_my_exit_jump(pTHX)
5300 SvREFCNT_dec(PL_e_script);
5304 POPSTACK_TO(PL_mainstack);
5312 read_e_script(pTHX_ int idx, SV *buf_sv, int maxlen)
5315 const char * const p = SvPVX_const(PL_e_script);
5316 const char *nl = strchr(p, '\n');
5318 PERL_UNUSED_ARG(idx);
5319 PERL_UNUSED_ARG(maxlen);
5321 nl = (nl) ? nl+1 : SvEND(PL_e_script);
5323 filter_del(read_e_script);
5326 sv_catpvn(buf_sv, p, nl-p);
5327 sv_chop(PL_e_script, nl);
5333 * c-indentation-style: bsd
5335 * indent-tabs-mode: t
5338 * ex: set ts=8 sts=4 sw=4 noet: