3 * Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, 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
141 /* This reference ensure that the mathoms are linked with perl */
142 void Perl_mathoms_ref() {
143 extern void Perl_mathoms();
149 S_init_tls_and_interp(PerlInterpreter *my_perl)
153 PERL_SET_INTERP(my_perl);
154 #if defined(USE_ITHREADS)
157 PERL_SET_THX(my_perl);
159 MUTEX_INIT(&PL_dollarzero_mutex);
163 PERL_SET_THX(my_perl);
167 #ifdef PERL_IMPLICIT_SYS
169 perl_alloc_using(struct IPerlMem* ipM, struct IPerlMem* ipMS,
170 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
171 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
172 struct IPerlDir* ipD, struct IPerlSock* ipS,
173 struct IPerlProc* ipP)
175 PerlInterpreter *my_perl;
176 /* Newx() needs interpreter, so call malloc() instead */
177 my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
178 S_init_tls_and_interp(my_perl);
179 Zero(my_perl, 1, PerlInterpreter);
195 =head1 Embedding Functions
197 =for apidoc perl_alloc
199 Allocates a new Perl interpreter. See L<perlembed>.
207 PerlInterpreter *my_perl;
209 /* Newx() needs interpreter, so call malloc() instead */
210 my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
212 S_init_tls_and_interp(my_perl);
213 return (PerlInterpreter *) ZeroD(my_perl, 1, PerlInterpreter);
215 #endif /* PERL_IMPLICIT_SYS */
218 =for apidoc perl_construct
220 Initializes a new Perl interpreter. See L<perlembed>.
226 perl_construct(pTHXx)
229 PERL_UNUSED_ARG(my_perl);
232 PL_perl_destruct_level = 1;
234 if (PL_perl_destruct_level > 0)
237 /* Init the real globals (and main thread)? */
239 PL_curcop = &PL_compiling; /* needed by ckWARN, right away */
241 PL_linestr = NEWSV(65,79);
242 sv_upgrade(PL_linestr,SVt_PVIV);
244 if (!SvREADONLY(&PL_sv_undef)) {
245 /* set read-only and try to insure than we wont see REFCNT==0
248 SvREADONLY_on(&PL_sv_undef);
249 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
251 sv_setpv(&PL_sv_no,PL_No);
252 /* value lookup in void context - happens to have the side effect
253 of caching the numeric forms. */
256 SvREADONLY_on(&PL_sv_no);
257 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
259 sv_setpv(&PL_sv_yes,PL_Yes);
262 SvREADONLY_on(&PL_sv_yes);
263 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
265 SvREADONLY_on(&PL_sv_placeholder);
266 SvREFCNT(&PL_sv_placeholder) = (~(U32)0)/2;
269 PL_sighandlerp = (Sighandler_t) Perl_sighandler;
270 #ifdef PERL_USES_PL_PIDSTATUS
271 PL_pidstatus = newHV();
275 PL_rs = newSVpvn("\n", 1);
280 PL_lex_state = LEX_NOTPARSING;
286 SET_NUMERIC_STANDARD();
288 #if defined(LOCAL_PATCH_COUNT)
289 PL_localpatches = local_patches; /* For possible -v */
292 #ifdef HAVE_INTERP_INTERN
296 PerlIO_init(aTHX); /* Hook to IO system */
298 PL_fdpid = newAV(); /* for remembering popen pids by fd */
299 PL_modglobal = newHV(); /* pointers to per-interpreter module globals */
300 PL_errors = newSVpvn("",0);
301 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
302 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
303 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
305 PL_regex_padav = newAV();
306 av_push(PL_regex_padav,(SV*)newAV()); /* First entry is an array of empty elements */
307 PL_regex_pad = AvARRAY(PL_regex_padav);
309 #ifdef USE_REENTRANT_API
310 Perl_reentrant_init(aTHX);
313 /* Note that strtab is a rather special HV. Assumptions are made
314 about not iterating on it, and not adding tie magic to it.
315 It is properly deallocated in perl_destruct() */
318 HvSHAREKEYS_off(PL_strtab); /* mandatory */
319 hv_ksplit(PL_strtab, 512);
321 #if defined(__DYNAMIC__) && (defined(NeXT) || defined(__NeXT__))
322 _dyld_lookup_and_bind
323 ("__environ", (unsigned long *) &environ_pointer, NULL);
327 # ifdef USE_ENVIRON_ARRAY
328 PL_origenviron = environ;
332 /* Use sysconf(_SC_CLK_TCK) if available, if not
333 * available or if the sysconf() fails, use the HZ.
334 * BeOS has those, but returns the wrong value.
335 * The HZ if not originally defined has been by now
336 * been defined as CLK_TCK, if available. */
337 #if defined(HAS_SYSCONF) && defined(_SC_CLK_TCK) && !defined(__BEOS__)
338 PL_clocktick = sysconf(_SC_CLK_TCK);
339 if (PL_clocktick <= 0)
343 PL_stashcache = newHV();
345 PL_patchlevel = Perl_newSVpvf(aTHX_ "%d.%d.%d", (int)PERL_REVISION,
346 (int)PERL_VERSION, (int)PERL_SUBVERSION);
349 if (!PL_mmap_page_size) {
350 #if defined(HAS_SYSCONF) && (defined(_SC_PAGESIZE) || defined(_SC_MMAP_PAGE_SIZE))
352 SETERRNO(0, SS_NORMAL);
354 PL_mmap_page_size = sysconf(_SC_PAGESIZE);
356 PL_mmap_page_size = sysconf(_SC_MMAP_PAGE_SIZE);
358 if ((long) PL_mmap_page_size < 0) {
360 SV * const error = ERRSV;
361 (void) SvUPGRADE(error, SVt_PV);
362 Perl_croak(aTHX_ "panic: sysconf: %s", SvPV_nolen_const(error));
365 Perl_croak(aTHX_ "panic: sysconf: pagesize unknown");
369 # ifdef HAS_GETPAGESIZE
370 PL_mmap_page_size = getpagesize();
372 # if defined(I_SYS_PARAM) && defined(PAGESIZE)
373 PL_mmap_page_size = PAGESIZE; /* compiletime, bad */
377 if (PL_mmap_page_size <= 0)
378 Perl_croak(aTHX_ "panic: bad pagesize %" IVdf,
379 (IV) PL_mmap_page_size);
381 #endif /* HAS_MMAP */
383 #if defined(HAS_TIMES) && defined(PERL_NEED_TIMESBASE)
384 PL_timesbase.tms_utime = 0;
385 PL_timesbase.tms_stime = 0;
386 PL_timesbase.tms_cutime = 0;
387 PL_timesbase.tms_cstime = 0;
394 =for apidoc nothreadhook
396 Stub that provides thread hook for perl_destruct when there are
403 Perl_nothreadhook(pTHX)
408 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
410 Perl_dump_sv_child(pTHX_ SV *sv)
413 const int sock = PL_dumper_fd;
414 const int debug_fd = PerlIO_fileno(Perl_debug_log);
415 union control_un control;
418 struct cmsghdr *cmptr;
420 unsigned char buffer[256];
422 if(sock == -1 || debug_fd == -1)
425 PerlIO_flush(Perl_debug_log);
427 /* All these shenanigans are to pass a file descriptor over to our child for
428 it to dump out to. We can't let it hold open the file descriptor when it
429 forks, as the file descriptor it will dump to can turn out to be one end
430 of pipe that some other process will wait on for EOF. (So as it would
431 be open, the wait would be forever. */
433 msg.msg_control = control.control;
434 msg.msg_controllen = sizeof(control.control);
435 /* We're a connected socket so we don't need a destination */
441 cmptr = CMSG_FIRSTHDR(&msg);
442 cmptr->cmsg_len = CMSG_LEN(sizeof(int));
443 cmptr->cmsg_level = SOL_SOCKET;
444 cmptr->cmsg_type = SCM_RIGHTS;
445 *((int *)CMSG_DATA(cmptr)) = 1;
447 vec[0].iov_base = (void*)&sv;
448 vec[0].iov_len = sizeof(sv);
449 got = sendmsg(sock, &msg, 0);
452 perror("Debug leaking scalars parent sendmsg failed");
455 if(got < sizeof(sv)) {
456 perror("Debug leaking scalars parent short sendmsg");
460 /* Return protocol is
462 unsigned char: length of location string (0 for empty)
463 unsigned char*: string (not terminated)
465 vec[0].iov_base = (void*)&returned_errno;
466 vec[0].iov_len = sizeof(returned_errno);
467 vec[1].iov_base = buffer;
470 got = readv(sock, vec, 2);
473 perror("Debug leaking scalars parent read failed");
474 PerlIO_flush(PerlIO_stderr());
477 if(got < sizeof(returned_errno) + 1) {
478 perror("Debug leaking scalars parent short read");
479 PerlIO_flush(PerlIO_stderr());
484 got = read(sock, buffer + 1, *buffer);
486 perror("Debug leaking scalars parent read 2 failed");
487 PerlIO_flush(PerlIO_stderr());
492 perror("Debug leaking scalars parent short read 2");
493 PerlIO_flush(PerlIO_stderr());
498 if (returned_errno || *buffer) {
499 Perl_warn(aTHX_ "Debug leaking scalars child failed%s%.*s with errno"
500 " %d: %s", (*buffer ? " at " : ""), (int) *buffer, buffer + 1,
501 returned_errno, strerror(returned_errno));
507 =for apidoc perl_destruct
509 Shuts down a Perl interpreter. See L<perlembed>.
518 volatile int destruct_level; /* 0=none, 1=full, 2=full with checks */
520 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
524 PERL_UNUSED_ARG(my_perl);
526 /* wait for all pseudo-forked children to finish */
527 PERL_WAIT_FOR_CHILDREN;
529 destruct_level = PL_perl_destruct_level;
532 const char * const s = PerlEnv_getenv("PERL_DESTRUCT_LEVEL");
534 const int i = atoi(s);
535 if (destruct_level < i)
541 if (PL_exit_flags & PERL_EXIT_DESTRUCT_END) {
547 if (PL_endav && !PL_minus_c)
548 call_list(PL_scopestack_ix, PL_endav);
554 /* Need to flush since END blocks can produce output */
557 if (CALL_FPTR(PL_threadhook)(aTHX)) {
558 /* Threads hook has vetoed further cleanup */
562 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
563 if (destruct_level != 0) {
564 /* Fork here to create a child. Our child's job is to preserve the
565 state of scalars prior to destruction, so that we can instruct it
566 to dump any scalars that we later find have leaked.
567 There's no subtlety in this code - it assumes POSIX, and it doesn't
571 if(socketpair(AF_UNIX, SOCK_STREAM, 0, fd)) {
572 perror("Debug leaking scalars socketpair failed");
578 perror("Debug leaking scalars fork failed");
582 /* We are the child */
583 const int sock = fd[1];
584 const int debug_fd = PerlIO_fileno(Perl_debug_log);
587 /* Our success message is an integer 0, and a char 0 */
588 static const char success[sizeof(int) + 1];
592 /* We need to close all other file descriptors otherwise we end up
593 with interesting hangs, where the parent closes its end of a
594 pipe, and sits waiting for (another) child to terminate. Only
595 that child never terminates, because it never gets EOF, because
596 we also have the far end of the pipe open. We even need to
597 close the debugging fd, because sometimes it happens to be one
598 end of a pipe, and a process is waiting on the other end for
599 EOF. Normally it would be closed at some point earlier in
600 destruction, but if we happen to cause the pipe to remain open,
601 EOF never occurs, and we get an infinite hang. Hence all the
602 games to pass in a file descriptor if it's actually needed. */
604 f = sysconf(_SC_OPEN_MAX);
606 where = "sysconf failed";
617 union control_un control;
620 struct cmsghdr *cmptr;
624 msg.msg_control = control.control;
625 msg.msg_controllen = sizeof(control.control);
626 /* We're a connected socket so we don't need a source */
630 msg.msg_iovlen = sizeof(vec)/sizeof(vec[0]);
632 vec[0].iov_base = (void*)⌖
633 vec[0].iov_len = sizeof(target);
635 got = recvmsg(sock, &msg, 0);
640 where = "recv failed";
643 if(got < sizeof(target)) {
644 where = "short recv";
648 if(!(cmptr = CMSG_FIRSTHDR(&msg))) {
652 if(cmptr->cmsg_len != CMSG_LEN(sizeof(int))) {
653 where = "wrong cmsg_len";
656 if(cmptr->cmsg_level != SOL_SOCKET) {
657 where = "wrong cmsg_level";
660 if(cmptr->cmsg_type != SCM_RIGHTS) {
661 where = "wrong cmsg_type";
665 got_fd = *(int*)CMSG_DATA(cmptr);
666 /* For our last little bit of trickery, put the file descriptor
667 back into Perl_debug_log, as if we never actually closed it
669 if(got_fd != debug_fd) {
670 if (dup2(got_fd, debug_fd) == -1) {
677 PerlIO_flush(Perl_debug_log);
679 got = write(sock, &success, sizeof(success));
682 where = "write failed";
685 if(got < sizeof(success)) {
686 where = "short write";
693 int send_errno = errno;
694 unsigned char length = (unsigned char) strlen(where);
695 struct iovec failure[3] = {
696 {(void*)&send_errno, sizeof(send_errno)},
698 {(void*)where, length}
700 int got = writev(sock, failure, 3);
701 /* Bad news travels fast. Faster than data. We'll get a SIGPIPE
702 in the parent if we try to read from the socketpair after the
703 child has exited, even if there was data to read.
704 So sleep a bit to give the parent a fighting chance of
707 _exit((got == -1) ? errno : 0);
711 PL_dumper_fd = fd[0];
716 /* We must account for everything. */
718 /* Destroy the main CV and syntax tree */
719 /* Do this now, because destroying ops can cause new SVs to be generated
720 in Perl_pad_swipe, and when running with -DDEBUG_LEAKING_SCALARS they
721 PL_curcop to point to a valid op from which the filename structure
723 PL_curcop = &PL_compiling;
725 /* ensure comppad/curpad to refer to main's pad */
726 if (CvPADLIST(PL_main_cv)) {
727 PAD_SET_CUR_NOSAVE(CvPADLIST(PL_main_cv), 1);
729 op_free(PL_main_root);
730 PL_main_root = Nullop;
732 PL_main_start = Nullop;
733 SvREFCNT_dec(PL_main_cv);
737 /* Tell PerlIO we are about to tear things apart in case
738 we have layers which are using resources that should
742 PerlIO_destruct(aTHX);
744 if (PL_sv_objcount) {
746 * Try to destruct global references. We do this first so that the
747 * destructors and destructees still exist. Some sv's might remain.
748 * Non-referenced objects are on their own.
752 if (PL_defoutgv && !SvREFCNT(PL_defoutgv))
753 PL_defoutgv = Nullgv; /* may have been freed */
756 /* unhook hooks which will soon be, or use, destroyed data */
757 SvREFCNT_dec(PL_warnhook);
758 PL_warnhook = Nullsv;
759 SvREFCNT_dec(PL_diehook);
762 /* call exit list functions */
763 while (PL_exitlistlen-- > 0)
764 PL_exitlist[PL_exitlistlen].fn(aTHX_ PL_exitlist[PL_exitlistlen].ptr);
766 Safefree(PL_exitlist);
771 if (destruct_level == 0){
773 DEBUG_P(debprofdump());
775 #if defined(PERLIO_LAYERS)
776 /* No more IO - including error messages ! */
777 PerlIO_cleanup(aTHX);
780 /* The exit() function will do everything that needs doing. */
784 /* jettison our possibly duplicated environment */
785 /* if PERL_USE_SAFE_PUTENV is defined environ will not have been copied
786 * so we certainly shouldn't free it here
789 #if defined(USE_ENVIRON_ARRAY) && !defined(PERL_USE_SAFE_PUTENV)
790 if (environ != PL_origenviron && !PL_use_safe_putenv
792 /* only main thread can free environ[0] contents */
793 && PL_curinterp == aTHX
799 for (i = 0; environ[i]; i++)
800 safesysfree(environ[i]);
802 /* Must use safesysfree() when working with environ. */
803 safesysfree(environ);
805 environ = PL_origenviron;
808 #endif /* !PERL_MICRO */
810 /* reset so print() ends up where we expect */
814 /* the syntax tree is shared between clones
815 * so op_free(PL_main_root) only ReREFCNT_dec's
816 * REGEXPs in the parent interpreter
817 * we need to manually ReREFCNT_dec for the clones
820 I32 i = AvFILLp(PL_regex_padav) + 1;
821 SV * const * const ary = AvARRAY(PL_regex_padav);
824 SV * const resv = ary[--i];
826 if (SvFLAGS(resv) & SVf_BREAK) {
827 /* this is PL_reg_curpm, already freed
828 * flag is set in regexec.c:S_regtry
830 SvFLAGS(resv) &= ~SVf_BREAK;
832 else if(SvREPADTMP(resv)) {
833 SvREPADTMP_off(resv);
835 else if(SvIOKp(resv)) {
836 REGEXP *re = INT2PTR(REGEXP *,SvIVX(resv));
841 SvREFCNT_dec(PL_regex_padav);
842 PL_regex_padav = Nullav;
846 SvREFCNT_dec((SV*) PL_stashcache);
847 PL_stashcache = NULL;
849 /* loosen bonds of global variables */
852 (void)PerlIO_close(PL_rsfp);
856 /* Filters for program text */
857 SvREFCNT_dec(PL_rsfp_filters);
858 PL_rsfp_filters = Nullav;
861 PL_preprocess = FALSE;
867 PL_doswitches = FALSE;
868 PL_dowarn = G_WARN_OFF;
869 PL_doextract = FALSE;
870 PL_sawampersand = FALSE; /* must save all match strings */
873 Safefree(PL_inplace);
875 SvREFCNT_dec(PL_patchlevel);
878 SvREFCNT_dec(PL_e_script);
879 PL_e_script = Nullsv;
884 /* magical thingies */
886 SvREFCNT_dec(PL_ofs_sv); /* $, */
889 SvREFCNT_dec(PL_ors_sv); /* $\ */
892 SvREFCNT_dec(PL_rs); /* $/ */
895 PL_multiline = 0; /* $* */
896 Safefree(PL_osname); /* $^O */
899 SvREFCNT_dec(PL_statname);
900 PL_statname = Nullsv;
903 /* defgv, aka *_ should be taken care of elsewhere */
905 /* clean up after study() */
906 SvREFCNT_dec(PL_lastscream);
907 PL_lastscream = Nullsv;
908 Safefree(PL_screamfirst);
910 Safefree(PL_screamnext);
914 Safefree(PL_efloatbuf);
915 PL_efloatbuf = Nullch;
918 /* startup and shutdown function lists */
919 SvREFCNT_dec(PL_beginav);
920 SvREFCNT_dec(PL_beginav_save);
921 SvREFCNT_dec(PL_endav);
922 SvREFCNT_dec(PL_checkav);
923 SvREFCNT_dec(PL_checkav_save);
924 SvREFCNT_dec(PL_initav);
926 PL_beginav_save = Nullav;
929 PL_checkav_save = Nullav;
932 /* shortcuts just get cleared */
938 PL_argvoutgv = Nullgv;
940 PL_stderrgv = Nullgv;
941 PL_last_in_gv = Nullgv;
946 PL_DBsingle = Nullsv;
948 PL_DBsignal = Nullsv;
949 PL_DBassertion = Nullsv;
952 PL_debstash = Nullhv;
954 SvREFCNT_dec(PL_argvout_stack);
955 PL_argvout_stack = Nullav;
957 SvREFCNT_dec(PL_modglobal);
958 PL_modglobal = Nullhv;
959 SvREFCNT_dec(PL_preambleav);
960 PL_preambleav = Nullav;
961 SvREFCNT_dec(PL_subname);
963 SvREFCNT_dec(PL_linestr);
965 #ifdef PERL_USES_PL_PIDSTATUS
966 SvREFCNT_dec(PL_pidstatus);
967 PL_pidstatus = Nullhv;
969 SvREFCNT_dec(PL_toptarget);
970 PL_toptarget = Nullsv;
971 SvREFCNT_dec(PL_bodytarget);
972 PL_bodytarget = Nullsv;
973 PL_formtarget = Nullsv;
975 /* free locale stuff */
976 #ifdef USE_LOCALE_COLLATE
977 Safefree(PL_collation_name);
978 PL_collation_name = Nullch;
981 #ifdef USE_LOCALE_NUMERIC
982 Safefree(PL_numeric_name);
983 PL_numeric_name = Nullch;
984 SvREFCNT_dec(PL_numeric_radix_sv);
985 PL_numeric_radix_sv = Nullsv;
988 /* clear utf8 character classes */
989 SvREFCNT_dec(PL_utf8_alnum);
990 SvREFCNT_dec(PL_utf8_alnumc);
991 SvREFCNT_dec(PL_utf8_ascii);
992 SvREFCNT_dec(PL_utf8_alpha);
993 SvREFCNT_dec(PL_utf8_space);
994 SvREFCNT_dec(PL_utf8_cntrl);
995 SvREFCNT_dec(PL_utf8_graph);
996 SvREFCNT_dec(PL_utf8_digit);
997 SvREFCNT_dec(PL_utf8_upper);
998 SvREFCNT_dec(PL_utf8_lower);
999 SvREFCNT_dec(PL_utf8_print);
1000 SvREFCNT_dec(PL_utf8_punct);
1001 SvREFCNT_dec(PL_utf8_xdigit);
1002 SvREFCNT_dec(PL_utf8_mark);
1003 SvREFCNT_dec(PL_utf8_toupper);
1004 SvREFCNT_dec(PL_utf8_totitle);
1005 SvREFCNT_dec(PL_utf8_tolower);
1006 SvREFCNT_dec(PL_utf8_tofold);
1007 SvREFCNT_dec(PL_utf8_idstart);
1008 SvREFCNT_dec(PL_utf8_idcont);
1009 PL_utf8_alnum = Nullsv;
1010 PL_utf8_alnumc = Nullsv;
1011 PL_utf8_ascii = Nullsv;
1012 PL_utf8_alpha = Nullsv;
1013 PL_utf8_space = Nullsv;
1014 PL_utf8_cntrl = Nullsv;
1015 PL_utf8_graph = Nullsv;
1016 PL_utf8_digit = Nullsv;
1017 PL_utf8_upper = Nullsv;
1018 PL_utf8_lower = Nullsv;
1019 PL_utf8_print = Nullsv;
1020 PL_utf8_punct = Nullsv;
1021 PL_utf8_xdigit = Nullsv;
1022 PL_utf8_mark = Nullsv;
1023 PL_utf8_toupper = Nullsv;
1024 PL_utf8_totitle = Nullsv;
1025 PL_utf8_tolower = Nullsv;
1026 PL_utf8_tofold = Nullsv;
1027 PL_utf8_idstart = Nullsv;
1028 PL_utf8_idcont = Nullsv;
1030 if (!specialWARN(PL_compiling.cop_warnings))
1031 SvREFCNT_dec(PL_compiling.cop_warnings);
1032 PL_compiling.cop_warnings = Nullsv;
1033 if (!specialCopIO(PL_compiling.cop_io))
1034 SvREFCNT_dec(PL_compiling.cop_io);
1035 PL_compiling.cop_io = Nullsv;
1036 CopFILE_free(&PL_compiling);
1037 CopSTASH_free(&PL_compiling);
1039 /* Prepare to destruct main symbol table. */
1044 SvREFCNT_dec(PL_curstname);
1045 PL_curstname = Nullsv;
1047 /* clear queued errors */
1048 SvREFCNT_dec(PL_errors);
1052 if (destruct_level >= 2 && ckWARN_d(WARN_INTERNAL)) {
1053 if (PL_scopestack_ix != 0)
1054 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
1055 "Unbalanced scopes: %ld more ENTERs than LEAVEs\n",
1056 (long)PL_scopestack_ix);
1057 if (PL_savestack_ix != 0)
1058 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
1059 "Unbalanced saves: %ld more saves than restores\n",
1060 (long)PL_savestack_ix);
1061 if (PL_tmps_floor != -1)
1062 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced tmps: %ld more allocs than frees\n",
1063 (long)PL_tmps_floor + 1);
1064 if (cxstack_ix != -1)
1065 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced context: %ld more PUSHes than POPs\n",
1066 (long)cxstack_ix + 1);
1069 /* Now absolutely destruct everything, somehow or other, loops or no. */
1070 SvFLAGS(PL_fdpid) |= SVTYPEMASK; /* don't clean out pid table now */
1071 SvFLAGS(PL_strtab) |= SVTYPEMASK; /* don't clean out strtab now */
1073 /* the 2 is for PL_fdpid and PL_strtab */
1074 while (PL_sv_count > 2 && sv_clean_all())
1077 SvFLAGS(PL_fdpid) &= ~SVTYPEMASK;
1078 SvFLAGS(PL_fdpid) |= SVt_PVAV;
1079 SvFLAGS(PL_strtab) &= ~SVTYPEMASK;
1080 SvFLAGS(PL_strtab) |= SVt_PVHV;
1082 AvREAL_off(PL_fdpid); /* no surviving entries */
1083 SvREFCNT_dec(PL_fdpid); /* needed in io_close() */
1086 #ifdef HAVE_INTERP_INTERN
1090 /* Destruct the global string table. */
1092 /* Yell and reset the HeVAL() slots that are still holding refcounts,
1093 * so that sv_free() won't fail on them.
1094 * Now that the global string table is using a single hunk of memory
1095 * for both HE and HEK, we either need to explicitly unshare it the
1096 * correct way, or actually free things here.
1099 const I32 max = HvMAX(PL_strtab);
1100 HE * const * const array = HvARRAY(PL_strtab);
1101 HE *hent = array[0];
1104 if (hent && ckWARN_d(WARN_INTERNAL)) {
1105 HE * const next = HeNEXT(hent);
1106 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
1107 "Unbalanced string table refcount: (%ld) for \"%s\"",
1108 (long)(HeVAL(hent) - Nullsv), HeKEY(hent));
1115 hent = array[riter];
1120 HvARRAY(PL_strtab) = 0;
1121 HvTOTALKEYS(PL_strtab) = 0;
1122 HvFILL(PL_strtab) = 0;
1124 SvREFCNT_dec(PL_strtab);
1127 /* free the pointer tables used for cloning */
1128 ptr_table_free(PL_ptr_table);
1129 PL_ptr_table = (PTR_TBL_t*)NULL;
1132 /* free special SVs */
1134 SvREFCNT(&PL_sv_yes) = 0;
1135 sv_clear(&PL_sv_yes);
1136 SvANY(&PL_sv_yes) = NULL;
1137 SvFLAGS(&PL_sv_yes) = 0;
1139 SvREFCNT(&PL_sv_no) = 0;
1140 sv_clear(&PL_sv_no);
1141 SvANY(&PL_sv_no) = NULL;
1142 SvFLAGS(&PL_sv_no) = 0;
1146 for (i=0; i<=2; i++) {
1147 SvREFCNT(PERL_DEBUG_PAD(i)) = 0;
1148 sv_clear(PERL_DEBUG_PAD(i));
1149 SvANY(PERL_DEBUG_PAD(i)) = NULL;
1150 SvFLAGS(PERL_DEBUG_PAD(i)) = 0;
1154 if (PL_sv_count != 0 && ckWARN_d(WARN_INTERNAL))
1155 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Scalars leaked: %ld\n", (long)PL_sv_count);
1157 #ifdef DEBUG_LEAKING_SCALARS
1158 if (PL_sv_count != 0) {
1163 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
1164 svend = &sva[SvREFCNT(sva)];
1165 for (sv = sva + 1; sv < svend; ++sv) {
1166 if (SvTYPE(sv) != SVTYPEMASK) {
1167 PerlIO_printf(Perl_debug_log, "leaked: sv=0x%p"
1169 " refcnt=%"UVuf pTHX__FORMAT "\n"
1170 "\tallocated at %s:%d %s %s%s\n",
1171 sv, sv->sv_flags, sv->sv_refcnt pTHX__VALUE,
1172 sv->sv_debug_file ? sv->sv_debug_file : "(unknown)",
1174 sv->sv_debug_inpad ? "for" : "by",
1175 sv->sv_debug_optype ?
1176 PL_op_name[sv->sv_debug_optype]: "(none)",
1177 sv->sv_debug_cloned ? " (cloned)" : ""
1179 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1180 Perl_dump_sv_child(aTHX_ sv);
1186 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1190 /* Wait for up to 4 seconds for child to terminate.
1191 This seems to be the least effort way of timing out on reaping
1193 struct timeval waitfor = {4, 0};
1194 int sock = PL_dumper_fd;
1198 FD_SET(sock, &rset);
1199 select(sock + 1, &rset, NULL, NULL, &waitfor);
1200 waitpid(child, &status, WNOHANG);
1208 #if defined(PERLIO_LAYERS)
1209 /* No more IO - including error messages ! */
1210 PerlIO_cleanup(aTHX);
1213 /* sv_undef needs to stay immortal until after PerlIO_cleanup
1214 as currently layers use it rather than Nullsv as a marker
1215 for no arg - and will try and SvREFCNT_dec it.
1217 SvREFCNT(&PL_sv_undef) = 0;
1218 SvREADONLY_off(&PL_sv_undef);
1220 Safefree(PL_origfilename);
1221 PL_origfilename = Nullch;
1222 Safefree(PL_reg_start_tmp);
1223 PL_reg_start_tmp = (char**)NULL;
1224 PL_reg_start_tmpl = 0;
1225 Safefree(PL_reg_curpm);
1226 Safefree(PL_reg_poscache);
1227 free_tied_hv_pool();
1228 Safefree(PL_op_mask);
1229 Safefree(PL_psig_ptr);
1230 PL_psig_ptr = (SV**)NULL;
1231 Safefree(PL_psig_name);
1232 PL_psig_name = (SV**)NULL;
1233 Safefree(PL_bitcount);
1234 PL_bitcount = Nullch;
1235 Safefree(PL_psig_pend);
1236 PL_psig_pend = (int*)NULL;
1237 PL_formfeed = Nullsv;
1239 PL_tainting = FALSE;
1240 PL_taint_warn = FALSE;
1241 PL_hints = 0; /* Reset hints. Should hints be per-interpreter ? */
1244 DEBUG_P(debprofdump());
1246 #ifdef USE_REENTRANT_API
1247 Perl_reentrant_free(aTHX);
1252 /* As the absolutely last thing, free the non-arena SV for mess() */
1255 /* we know that type == SVt_PVMG */
1257 /* it could have accumulated taint magic */
1260 for (mg = SvMAGIC(PL_mess_sv); mg; mg = moremagic) {
1261 moremagic = mg->mg_moremagic;
1262 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global
1264 Safefree(mg->mg_ptr);
1268 /* we know that type >= SVt_PV */
1269 SvPV_free(PL_mess_sv);
1270 Safefree(SvANY(PL_mess_sv));
1271 Safefree(PL_mess_sv);
1272 PL_mess_sv = Nullsv;
1278 =for apidoc perl_free
1280 Releases a Perl interpreter. See L<perlembed>.
1288 #if defined(WIN32) || defined(NETWARE)
1289 # if defined(PERL_IMPLICIT_SYS)
1291 void *host = nw_internal_host;
1293 void *host = w32_internal_host;
1295 PerlMem_free(aTHXx);
1297 nw_delete_internal_host(host);
1299 win32_delete_internal_host(host);
1302 PerlMem_free(aTHXx);
1305 PerlMem_free(aTHXx);
1309 #if defined(USE_5005THREADS) || defined(USE_ITHREADS)
1310 /* provide destructors to clean up the thread key when libperl is unloaded */
1311 #ifndef WIN32 /* handled during DLL_PROCESS_DETACH in win32/perllib.c */
1313 #if defined(__hpux) && __ux_version > 1020 && !defined(__GNUC__)
1314 #pragma fini "perl_fini"
1318 #if defined(__GNUC__)
1319 __attribute__((destructor))
1329 #endif /* THREADS */
1332 Perl_call_atexit(pTHX_ ATEXIT_t fn, void *ptr)
1334 Renew(PL_exitlist, PL_exitlistlen+1, PerlExitListEntry);
1335 PL_exitlist[PL_exitlistlen].fn = fn;
1336 PL_exitlist[PL_exitlistlen].ptr = ptr;
1340 #ifdef HAS_PROCSELFEXE
1341 /* This is a function so that we don't hold on to MAXPATHLEN
1342 bytes of stack longer than necessary
1345 S_procself_val(pTHX_ SV *sv, const char *arg0)
1347 char buf[MAXPATHLEN];
1348 int len = readlink(PROCSELFEXE_PATH, buf, sizeof(buf) - 1);
1350 /* On Playstation2 Linux V1.0 (kernel 2.2.1) readlink(/proc/self/exe)
1351 includes a spurious NUL which will cause $^X to fail in system
1352 or backticks (this will prevent extensions from being built and
1353 many tests from working). readlink is not meant to add a NUL.
1354 Normal readlink works fine.
1356 if (len > 0 && buf[len-1] == '\0') {
1360 /* FreeBSD's implementation is acknowledged to be imperfect, sometimes
1361 returning the text "unknown" from the readlink rather than the path
1362 to the executable (or returning an error from the readlink). Any valid
1363 path has a '/' in it somewhere, so use that to validate the result.
1364 See http://www.freebsd.org/cgi/query-pr.cgi?pr=35703
1366 if (len > 0 && memchr(buf, '/', len)) {
1367 sv_setpvn(sv,buf,len);
1373 #endif /* HAS_PROCSELFEXE */
1376 S_set_caret_X(pTHX) {
1377 GV* tmpgv = gv_fetchpv("\030",TRUE, SVt_PV); /* $^X */
1379 #ifdef HAS_PROCSELFEXE
1380 S_procself_val(aTHX_ GvSV(tmpgv), PL_origargv[0]);
1383 sv_setpv(GvSVn(tmpgv), os2_execname(aTHX));
1385 sv_setpv(GvSVn(tmpgv),PL_origargv[0]);
1392 =for apidoc perl_parse
1394 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
1400 perl_parse(pTHXx_ XSINIT_t xsinit, int argc, char **argv, char **env)
1407 PERL_UNUSED_VAR(my_perl);
1409 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
1412 Perl_croak(aTHX_ "suidperl is no longer needed since the kernel can now execute\n\
1413 setuid perl scripts securely.\n");
1414 #endif /* IAMSUID */
1417 #if defined(USE_HASH_SEED) || defined(USE_HASH_SEED_EXPLICIT)
1418 /* [perl #22371] Algorimic Complexity Attack on Perl 5.6.1, 5.8.0
1419 * This MUST be done before any hash stores or fetches take place.
1420 * If you set PL_rehash_seed (and assumedly also PL_rehash_seed_set)
1421 * yourself, it is your responsibility to provide a good random seed!
1422 * You can also define PERL_HASH_SEED in compile time, see hv.h. */
1423 if (!PL_rehash_seed_set)
1424 PL_rehash_seed = get_hash_seed();
1426 const char * const s = PerlEnv_getenv("PERL_HASH_SEED_DEBUG");
1428 if (s && (atoi(s) == 1))
1429 PerlIO_printf(Perl_debug_log, "HASH_SEED = %"UVuf"\n", PL_rehash_seed);
1431 #endif /* #if defined(USE_HASH_SEED) || defined(USE_HASH_SEED_EXPLICIT) */
1437 /* Set PL_origalen be the sum of the contiguous argv[]
1438 * elements plus the size of the env in case that it is
1439 * contiguous with the argv[]. This is used in mg.c:Perl_magic_set()
1440 * as the maximum modifiable length of $0. In the worst case
1441 * the area we are able to modify is limited to the size of
1442 * the original argv[0]. (See below for 'contiguous', though.)
1444 const char *s = NULL;
1447 ~(UV)(PTRSIZE == 4 ? 3 : PTRSIZE == 8 ? 7 : PTRSIZE == 16 ? 15 : 0);
1448 /* Do the mask check only if the args seem like aligned. */
1450 (mask < ~(UV)0) && ((PTR2UV(argv[0]) & mask) == PTR2UV(argv[0]));
1452 /* See if all the arguments are contiguous in memory. Note
1453 * that 'contiguous' is a loose term because some platforms
1454 * align the argv[] and the envp[]. If the arguments look
1455 * like non-aligned, assume that they are 'strictly' or
1456 * 'traditionally' contiguous. If the arguments look like
1457 * aligned, we just check that they are within aligned
1458 * PTRSIZE bytes. As long as no system has something bizarre
1459 * like the argv[] interleaved with some other data, we are
1460 * fine. (Did I just evoke Murphy's Law?) --jhi */
1461 if (PL_origargv && PL_origargc >= 1 && (s = PL_origargv[0])) {
1463 for (i = 1; i < PL_origargc; i++) {
1464 if ((PL_origargv[i] == s + 1
1466 || PL_origargv[i] == s + 2
1471 (PL_origargv[i] > s &&
1473 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1483 /* Can we grab env area too to be used as the area for $0? */
1484 if (PL_origenviron) {
1485 if ((PL_origenviron[0] == s + 1
1487 || (PL_origenviron[0] == s + 9 && (s += 8))
1492 (PL_origenviron[0] > s &&
1493 PL_origenviron[0] <=
1494 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1498 s = PL_origenviron[0];
1501 my_setenv("NoNe SuCh", Nullch);
1502 /* Force copy of environment. */
1503 for (i = 1; PL_origenviron[i]; i++) {
1504 if (PL_origenviron[i] == s + 1
1507 (PL_origenviron[i] > s &&
1508 PL_origenviron[i] <=
1509 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1512 s = PL_origenviron[i];
1520 PL_origalen = s - PL_origargv[0] + 1;
1525 /* Come here if running an undumped a.out. */
1527 PL_origfilename = savepv(argv[0]);
1528 PL_do_undump = FALSE;
1529 cxstack_ix = -1; /* start label stack again */
1531 assert (!PL_tainted);
1533 S_set_caret_X(aTHX);
1535 init_postdump_symbols(argc,argv,env);
1540 op_free(PL_main_root);
1541 PL_main_root = Nullop;
1543 PL_main_start = Nullop;
1544 SvREFCNT_dec(PL_main_cv);
1545 PL_main_cv = Nullcv;
1548 oldscope = PL_scopestack_ix;
1549 PL_dowarn = G_WARN_OFF;
1554 parse_body(env,xsinit);
1556 call_list(oldscope, PL_checkav);
1563 /* my_exit() was called */
1564 while (PL_scopestack_ix > oldscope)
1567 PL_curstash = PL_defstash;
1569 call_list(oldscope, PL_checkav);
1573 PerlIO_printf(Perl_error_log, "panic: top_env\n");
1582 S_parse_body(pTHX_ char **env, XSINIT_t xsinit)
1585 int argc = PL_origargc;
1586 char **argv = PL_origargv;
1587 const char *scriptname = NULL;
1588 VOL bool dosearch = FALSE;
1589 const char *validarg = "";
1592 const char *cddir = Nullch;
1593 #ifdef USE_SITECUSTOMIZE
1594 bool minus_f = FALSE;
1599 sv_setpvn(PL_linestr,"",0);
1600 sv = newSVpvn("",0); /* first used for -I flags */
1604 for (argc--,argv++; argc > 0; argc--,argv++) {
1605 if (argv[0][0] != '-' || !argv[0][1])
1609 validarg = " PHOOEY ";
1613 * Can we rely on the kernel to start scripts with argv[1] set to
1614 * contain all #! line switches (the whole line)? (argv[0] is set to
1615 * the interpreter name, argv[2] to the script name; argv[3] and
1616 * above may contain other arguments.)
1623 #ifndef PERL_STRICT_CR
1648 if ((s = moreswitches(s)))
1653 CHECK_MALLOC_TOO_LATE_FOR('t');
1654 if( !PL_tainting ) {
1655 PL_taint_warn = TRUE;
1661 CHECK_MALLOC_TOO_LATE_FOR('T');
1663 PL_taint_warn = FALSE;
1668 #ifdef MACOS_TRADITIONAL
1669 /* ignore -e for Dev:Pseudo argument */
1670 if (argv[1] && !strcmp(argv[1], "Dev:Pseudo"))
1675 PL_e_script = newSVpvn("",0);
1676 filter_add(read_e_script, NULL);
1679 sv_catpv(PL_e_script, s);
1681 sv_catpv(PL_e_script, argv[1]);
1685 Perl_croak(aTHX_ "No code specified for -e");
1686 sv_catpv(PL_e_script, "\n");
1690 #ifdef USE_SITECUSTOMIZE
1696 case 'I': /* -I handled both here and in moreswitches() */
1698 if (!*++s && (s=argv[1]) != Nullch) {
1702 STRLEN len = strlen(s);
1703 const char * const p = savepvn(s, len);
1704 incpush(p, TRUE, TRUE, FALSE, FALSE);
1705 sv_catpvn(sv, "-I", 2);
1706 sv_catpvn(sv, p, len);
1707 sv_catpvn(sv, " ", 1);
1711 Perl_croak(aTHX_ "No directory specified for -I");
1715 PL_preprocess = TRUE;
1728 PL_preambleav = newAV();
1729 av_push(PL_preambleav,
1730 newSVpv("use Config;",0));
1734 opts_prog = newSVpv("print Config::myconfig(),",0);
1736 sv_catpv(opts_prog,"\"\\nCharacteristics of this PERLSHR image: \\n\",");
1738 sv_catpv(opts_prog,"\"\\nCharacteristics of this binary (from libperl): \\n\",");
1740 opts = SvCUR(opts_prog);
1742 Perl_sv_catpv(aTHX_ opts_prog,"\" Compile-time options:"
1746 # ifdef DEBUG_LEAKING_SCALARS
1747 " DEBUG_LEAKING_SCALARS"
1749 # ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1750 " DEBUG_LEAKING_SCALARS_FORK_DUMP"
1752 # ifdef FAKE_THREADS
1755 # ifdef MULTIPLICITY
1761 # ifdef PERL_DONT_CREATE_GVSV
1762 " PERL_DONT_CREATE_GVSV"
1764 # ifdef PERL_GLOBAL_STRUCT
1765 " PERL_GLOBAL_STRUCT"
1767 # ifdef PERL_IMPLICIT_CONTEXT
1768 " PERL_IMPLICIT_CONTEXT"
1770 # ifdef PERL_IMPLICIT_SYS
1771 " PERL_IMPLICIT_SYS"
1773 # ifdef PERL_MALLOC_WRAP
1776 # ifdef PERL_NEED_APPCTX
1779 # ifdef PERL_NEED_TIMESBASE
1780 " PERL_NEED_TIMESBASE"
1782 # ifdef PERL_OLD_COPY_ON_WRITE
1783 " PERL_OLD_COPY_ON_WRITE"
1785 # ifdef PERL_USE_SAFE_PUTENV
1786 " PERL_USE_SAFE_PUTENV"
1788 #ifdef PERL_USES_PL_PIDSTATUS
1789 " PERL_USES_PL_PIDSTATUS"
1791 # ifdef PL_OP_SLAB_ALLOC
1794 # ifdef SPRINTF_RETURNS_STRLEN
1795 " SPRINTF_RETURNS_STRLEN"
1797 # ifdef THREADS_HAVE_PIDS
1798 " THREADS_HAVE_PIDS"
1800 # ifdef USE_5005THREADS
1803 # ifdef USE_64_BIT_ALL
1806 # ifdef USE_64_BIT_INT
1809 # ifdef USE_ITHREADS
1812 # ifdef USE_LARGE_FILES
1815 # ifdef USE_LONG_DOUBLE
1821 # ifdef USE_REENTRANT_API
1822 " USE_REENTRANT_API"
1827 # ifdef USE_SITECUSTOMIZE
1828 " USE_SITECUSTOMIZE"
1835 while (SvCUR(opts_prog) > opts+76) {
1836 /* find last space after "options: " and before col 76
1840 char * const pv = SvPV_nolen(opts_prog);
1841 const char c = pv[opts+76];
1843 space = strrchr(pv+opts+26, ' ');
1845 if (!space) break; /* "Can't happen" */
1847 /* break the line before that space */
1850 sv_insert(opts_prog, opts, 0,
1854 sv_catpv(opts_prog,"\\n\",");
1856 #if defined(LOCAL_PATCH_COUNT)
1857 if (LOCAL_PATCH_COUNT > 0) {
1860 "\" Locally applied patches:\\n\",");
1861 for (i = 1; i <= LOCAL_PATCH_COUNT; i++) {
1862 if (PL_localpatches[i])
1863 Perl_sv_catpvf(aTHX_ opts_prog,"q%c\t%s\n%c,",
1864 0, PL_localpatches[i], 0);
1868 Perl_sv_catpvf(aTHX_ opts_prog,
1869 "\" Built under %s\\n\"",OSNAME);
1872 Perl_sv_catpvf(aTHX_ opts_prog,
1873 ",\" Compiled at %s %s\\n\"",__DATE__,
1876 Perl_sv_catpvf(aTHX_ opts_prog,",\" Compiled on %s\\n\"",
1880 sv_catpv(opts_prog, "; $\"=\"\\n \"; "
1881 "@env = map { \"$_=\\\"$ENV{$_}\\\"\" } "
1882 "sort grep {/^PERL/} keys %ENV; ");
1885 "push @env, \"CYGWIN=\\\"$ENV{CYGWIN}\\\"\";");
1888 "print \" \\%ENV:\\n @env\\n\" if @env;"
1889 "print \" \\@INC:\\n @INC\\n\";");
1893 opts_prog = Perl_newSVpvf(aTHX_
1894 "Config::config_vars(qw%c%s%c)",
1898 av_push(PL_preambleav, opts_prog);
1899 /* don't look for script or read stdin */
1900 scriptname = BIT_BUCKET;
1904 PL_doextract = TRUE;
1912 if (!*++s || isSPACE(*s)) {
1916 /* catch use of gnu style long options */
1917 if (strEQ(s, "version")) {
1921 if (strEQ(s, "help")) {
1928 Perl_croak(aTHX_ "Unrecognized switch: -%s (-h will show valid options)",s);
1934 #ifndef SECURE_INTERNAL_GETENV
1937 (s = PerlEnv_getenv("PERL5OPT")))
1939 const char *popt = s;
1942 if (*s == '-' && *(s+1) == 'T') {
1943 CHECK_MALLOC_TOO_LATE_FOR('T');
1945 PL_taint_warn = FALSE;
1948 char *popt_copy = Nullch;
1961 if (!strchr("CDIMUdmtwA", *s))
1962 Perl_croak(aTHX_ "Illegal switch in PERL5OPT: -%c", *s);
1966 popt_copy = SvPVX(sv_2mortal(newSVpv(popt,0)));
1967 s = popt_copy + (s - popt);
1968 d = popt_copy + (d - popt);
1975 if( !PL_tainting ) {
1976 PL_taint_warn = TRUE;
1986 #ifdef USE_SITECUSTOMIZE
1989 PL_preambleav = newAV();
1990 av_unshift(PL_preambleav, 1);
1991 (void)av_store(PL_preambleav, 0, Perl_newSVpvf(aTHX_ "BEGIN { do '%s/sitecustomize.pl' }", SITELIB_EXP));
1995 if (PL_taint_warn && PL_dowarn != G_WARN_ALL_OFF) {
1996 PL_compiling.cop_warnings = newSVpvn(WARN_TAINTstring, WARNsize);
2000 scriptname = argv[0];
2003 scriptname = BIT_BUCKET; /* don't look for script or read stdin */
2005 else if (scriptname == Nullch) {
2007 if ( PerlLIO_isatty(PerlIO_fileno(PerlIO_stdin())) )
2013 /* Set $^X early so that it can be used for relocatable paths in @INC */
2014 assert (!PL_tainted);
2016 S_set_caret_X(aTHX);
2020 open_script(scriptname,dosearch,sv);
2022 validate_suid(validarg, scriptname);
2025 #if defined(SIGCHLD) || defined(SIGCLD)
2028 # define SIGCHLD SIGCLD
2030 Sighandler_t sigstate = rsignal_state(SIGCHLD);
2031 if (sigstate == (Sighandler_t) SIG_IGN) {
2032 if (ckWARN(WARN_SIGNAL))
2033 Perl_warner(aTHX_ packWARN(WARN_SIGNAL),
2034 "Can't ignore signal CHLD, forcing to default");
2035 (void)rsignal(SIGCHLD, (Sighandler_t)SIG_DFL);
2041 #ifdef MACOS_TRADITIONAL
2042 if (PL_doextract || gMacPerl_AlwaysExtract) {
2047 if (cddir && PerlDir_chdir( (char *)cddir ) < 0)
2048 Perl_croak(aTHX_ "Can't chdir to %s",cddir);
2052 PL_main_cv = PL_compcv = (CV*)NEWSV(1104,0);
2053 sv_upgrade((SV *)PL_compcv, SVt_PVCV);
2054 CvUNIQUE_on(PL_compcv);
2056 CvPADLIST(PL_compcv) = pad_new(0);
2057 #ifdef USE_5005THREADS
2058 CvOWNER(PL_compcv) = 0;
2059 Newx(CvMUTEXP(PL_compcv), 1, perl_mutex);
2060 MUTEX_INIT(CvMUTEXP(PL_compcv));
2061 #endif /* USE_5005THREADS */
2064 boot_core_UNIVERSAL();
2065 boot_core_xsutils();
2068 (*xsinit)(aTHX); /* in case linked C routines want magical variables */
2070 #if defined(VMS) || defined(WIN32) || defined(DJGPP) || defined(__CYGWIN__) || defined(EPOC) || defined(SYMBIAN)
2076 # ifdef HAS_SOCKS5_INIT
2077 socks5_init(argv[0]);
2083 init_predump_symbols();
2084 /* init_postdump_symbols not currently designed to be called */
2085 /* more than once (ENV isn't cleared first, for example) */
2086 /* But running with -u leaves %ENV & @ARGV undefined! XXX */
2088 init_postdump_symbols(argc,argv,env);
2090 /* PL_unicode is turned on by -C, or by $ENV{PERL_UNICODE},
2091 * or explicitly in some platforms.
2092 * locale.c:Perl_init_i18nl10n() if the environment
2093 * look like the user wants to use UTF-8. */
2094 #if defined(__SYMBIAN32__)
2095 PL_unicode = PERL_UNICODE_STD_FLAG; /* See PERL_SYMBIAN_CONSOLE_UTF8. */
2098 /* Requires init_predump_symbols(). */
2099 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
2104 /* Turn on UTF-8-ness on STDIN, STDOUT, STDERR
2105 * and the default open disciplines. */
2106 if ((PL_unicode & PERL_UNICODE_STDIN_FLAG) &&
2107 PL_stdingv && (io = GvIO(PL_stdingv)) &&
2109 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2110 if ((PL_unicode & PERL_UNICODE_STDOUT_FLAG) &&
2111 PL_defoutgv && (io = GvIO(PL_defoutgv)) &&
2113 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2114 if ((PL_unicode & PERL_UNICODE_STDERR_FLAG) &&
2115 PL_stderrgv && (io = GvIO(PL_stderrgv)) &&
2117 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2118 if ((PL_unicode & PERL_UNICODE_INOUT_FLAG) &&
2119 (sv = GvSV(gv_fetchpv("\017PEN", TRUE, SVt_PV)))) {
2120 U32 in = PL_unicode & PERL_UNICODE_IN_FLAG;
2121 U32 out = PL_unicode & PERL_UNICODE_OUT_FLAG;
2124 sv_setpvn(sv, ":utf8\0:utf8", 11);
2126 sv_setpvn(sv, ":utf8\0", 6);
2129 sv_setpvn(sv, "\0:utf8", 6);
2135 if ((s = PerlEnv_getenv("PERL_SIGNALS"))) {
2136 if (strEQ(s, "unsafe"))
2137 PL_signals |= PERL_SIGNALS_UNSAFE_FLAG;
2138 else if (strEQ(s, "safe"))
2139 PL_signals &= ~PERL_SIGNALS_UNSAFE_FLAG;
2141 Perl_croak(aTHX_ "PERL_SIGNALS illegal: \"%s\"", s);
2146 /* now parse the script */
2148 SETERRNO(0,SS_NORMAL);
2150 #ifdef MACOS_TRADITIONAL
2151 if (gMacPerl_SyntaxError = (yyparse() || PL_error_count)) {
2153 Perl_croak(aTHX_ "%s had compilation errors.\n", MacPerl_MPWFileName(PL_origfilename));
2155 Perl_croak(aTHX_ "Execution of %s aborted due to compilation errors.\n",
2156 MacPerl_MPWFileName(PL_origfilename));
2160 if (yyparse() || PL_error_count) {
2162 Perl_croak(aTHX_ "%s had compilation errors.\n", PL_origfilename);
2164 Perl_croak(aTHX_ "Execution of %s aborted due to compilation errors.\n",
2169 CopLINE_set(PL_curcop, 0);
2170 PL_curstash = PL_defstash;
2171 PL_preprocess = FALSE;
2173 SvREFCNT_dec(PL_e_script);
2174 PL_e_script = Nullsv;
2181 SAVECOPFILE(PL_curcop);
2182 SAVECOPLINE(PL_curcop);
2183 gv_check(PL_defstash);
2190 if ((s=PerlEnv_getenv("PERL_DEBUG_MSTATS")) && atoi(s) >= 2)
2191 dump_mstats("after compilation:");
2200 =for apidoc perl_run
2202 Tells a Perl interpreter to run. See L<perlembed>.
2214 PERL_UNUSED_ARG(my_perl);
2216 oldscope = PL_scopestack_ix;
2224 cxstack_ix = -1; /* start context stack again */
2226 case 0: /* normal completion */
2230 case 2: /* my_exit() */
2231 while (PL_scopestack_ix > oldscope)
2234 PL_curstash = PL_defstash;
2235 if (!(PL_exit_flags & PERL_EXIT_DESTRUCT_END) &&
2236 PL_endav && !PL_minus_c)
2237 call_list(oldscope, PL_endav);
2239 if (PerlEnv_getenv("PERL_DEBUG_MSTATS"))
2240 dump_mstats("after execution: ");
2246 POPSTACK_TO(PL_mainstack);
2249 PerlIO_printf(Perl_error_log, "panic: restartop\n");
2261 S_run_body(pTHX_ I32 oldscope)
2263 DEBUG_r(PerlIO_printf(Perl_debug_log, "%s $` $& $' support.\n",
2264 PL_sawampersand ? "Enabling" : "Omitting"));
2266 if (!PL_restartop) {
2267 DEBUG_x(dump_all());
2270 PERL_DEBUG(PerlIO_printf(Perl_debug_log, "\nEXECUTING...\n\n"));
2272 DEBUG_S(PerlIO_printf(Perl_debug_log, "main thread is 0x%"UVxf"\n",
2276 #ifdef MACOS_TRADITIONAL
2277 PerlIO_printf(Perl_error_log, "%s%s syntax OK\n",
2278 (gMacPerl_ErrorFormat ? "# " : ""),
2279 MacPerl_MPWFileName(PL_origfilename));
2281 PerlIO_printf(Perl_error_log, "%s syntax OK\n", PL_origfilename);
2285 if (PERLDB_SINGLE && PL_DBsingle)
2286 sv_setiv(PL_DBsingle, 1);
2288 call_list(oldscope, PL_initav);
2294 PL_op = PL_restartop;
2298 else if (PL_main_start) {
2299 CvDEPTH(PL_main_cv) = 1;
2300 PL_op = PL_main_start;
2308 =head1 SV Manipulation Functions
2310 =for apidoc p||get_sv
2312 Returns the SV of the specified Perl scalar. If C<create> is set and the
2313 Perl variable does not exist then it will be created. If C<create> is not
2314 set and the variable does not exist then NULL is returned.
2320 Perl_get_sv(pTHX_ const char *name, I32 create)
2323 #ifdef USE_5005THREADS
2324 if (name[1] == '\0' && !isALPHA(name[0])) {
2325 PADOFFSET tmp = find_threadsv(name);
2326 if (tmp != NOT_IN_PAD)
2327 return THREADSV(tmp);
2329 #endif /* USE_5005THREADS */
2330 gv = gv_fetchpv(name, create, SVt_PV);
2337 =head1 Array Manipulation Functions
2339 =for apidoc p||get_av
2341 Returns the AV of the specified Perl array. If C<create> is set and the
2342 Perl variable does not exist then it will be created. If C<create> is not
2343 set and the variable does not exist then NULL is returned.
2349 Perl_get_av(pTHX_ const char *name, I32 create)
2351 GV* const gv = gv_fetchpv(name, create, SVt_PVAV);
2360 =head1 Hash Manipulation Functions
2362 =for apidoc p||get_hv
2364 Returns the HV of the specified Perl hash. If C<create> is set and the
2365 Perl variable does not exist then it will be created. If C<create> is not
2366 set and the variable does not exist then NULL is returned.
2372 Perl_get_hv(pTHX_ const char *name, I32 create)
2374 GV* const gv = gv_fetchpv(name, create, SVt_PVHV);
2383 =head1 CV Manipulation Functions
2385 =for apidoc p||get_cv
2387 Returns the CV of the specified Perl subroutine. If C<create> is set and
2388 the Perl subroutine does not exist then it will be declared (which has the
2389 same effect as saying C<sub name;>). If C<create> is not set and the
2390 subroutine does not exist then NULL is returned.
2396 Perl_get_cv(pTHX_ const char *name, I32 create)
2398 GV* const gv = gv_fetchpv(name, create, SVt_PVCV);
2399 /* XXX unsafe for threads if eval_owner isn't held */
2400 /* XXX this is probably not what they think they're getting.
2401 * It has the same effect as "sub name;", i.e. just a forward
2403 if (create && !GvCVu(gv))
2404 return newSUB(start_subparse(FALSE, 0),
2405 newSVOP(OP_CONST, 0, newSVpv(name,0)),
2413 /* Be sure to refetch the stack pointer after calling these routines. */
2417 =head1 Callback Functions
2419 =for apidoc p||call_argv
2421 Performs a callback to the specified Perl sub. See L<perlcall>.
2427 Perl_call_argv(pTHX_ const char *sub_name, I32 flags, register char **argv)
2429 /* See G_* flags in cop.h */
2430 /* null terminated arg list */
2437 XPUSHs(sv_2mortal(newSVpv(*argv,0)));
2442 return call_pv(sub_name, flags);
2446 =for apidoc p||call_pv
2448 Performs a callback to the specified Perl sub. See L<perlcall>.
2454 Perl_call_pv(pTHX_ const char *sub_name, I32 flags)
2455 /* name of the subroutine */
2456 /* See G_* flags in cop.h */
2458 return call_sv((SV*)get_cv(sub_name, TRUE), flags);
2462 =for apidoc p||call_method
2464 Performs a callback to the specified Perl method. The blessed object must
2465 be on the stack. See L<perlcall>.
2471 Perl_call_method(pTHX_ const char *methname, I32 flags)
2472 /* name of the subroutine */
2473 /* See G_* flags in cop.h */
2475 return call_sv(sv_2mortal(newSVpv(methname,0)), flags | G_METHOD);
2478 /* May be called with any of a CV, a GV, or an SV containing the name. */
2480 =for apidoc p||call_sv
2482 Performs a callback to the Perl sub whose name is in the SV. See
2489 Perl_call_sv(pTHX_ SV *sv, I32 flags)
2490 /* See G_* flags in cop.h */
2493 LOGOP myop; /* fake syntax tree node */
2496 volatile I32 retval = 0;
2498 bool oldcatch = CATCH_GET;
2500 OP* const oldop = PL_op;
2503 if (flags & G_DISCARD) {
2508 Zero(&myop, 1, LOGOP);
2509 myop.op_next = Nullop;
2510 if (!(flags & G_NOARGS))
2511 myop.op_flags |= OPf_STACKED;
2512 myop.op_flags |= ((flags & G_VOID) ? OPf_WANT_VOID :
2513 (flags & G_ARRAY) ? OPf_WANT_LIST :
2518 EXTEND(PL_stack_sp, 1);
2519 *++PL_stack_sp = sv;
2521 oldscope = PL_scopestack_ix;
2523 if (PERLDB_SUB && PL_curstash != PL_debstash
2524 /* Handle first BEGIN of -d. */
2525 && (PL_DBcv || (PL_DBcv = GvCV(PL_DBsub)))
2526 /* Try harder, since this may have been a sighandler, thus
2527 * curstash may be meaningless. */
2528 && (SvTYPE(sv) != SVt_PVCV || CvSTASH((CV*)sv) != PL_debstash)
2529 && !(flags & G_NODEBUG))
2530 PL_op->op_private |= OPpENTERSUB_DB;
2532 if (flags & G_METHOD) {
2533 Zero(&method_op, 1, UNOP);
2534 method_op.op_next = PL_op;
2535 method_op.op_ppaddr = PL_ppaddr[OP_METHOD];
2536 myop.op_ppaddr = PL_ppaddr[OP_ENTERSUB];
2537 PL_op = (OP*)&method_op;
2540 if (!(flags & G_EVAL)) {
2542 call_body((OP*)&myop, FALSE);
2543 retval = PL_stack_sp - (PL_stack_base + oldmark);
2544 CATCH_SET(oldcatch);
2547 myop.op_other = (OP*)&myop;
2549 /* we're trying to emulate pp_entertry() here */
2551 register PERL_CONTEXT *cx;
2552 const I32 gimme = GIMME_V;
2557 PUSHBLOCK(cx, (CXt_EVAL|CXp_TRYBLOCK), PL_stack_sp);
2559 PL_eval_root = PL_op; /* Only needed so that goto works right. */
2561 PL_in_eval = EVAL_INEVAL;
2562 if (flags & G_KEEPERR)
2563 PL_in_eval |= EVAL_KEEPERR;
2565 sv_setpvn(ERRSV,"",0);
2573 call_body((OP*)&myop, FALSE);
2574 retval = PL_stack_sp - (PL_stack_base + oldmark);
2575 if (!(flags & G_KEEPERR))
2576 sv_setpvn(ERRSV,"",0);
2582 /* my_exit() was called */
2583 PL_curstash = PL_defstash;
2586 if (PL_statusvalue && !(PL_exit_flags & PERL_EXIT_EXPECTED))
2587 Perl_croak(aTHX_ "Callback called exit");
2592 PL_op = PL_restartop;
2596 PL_stack_sp = PL_stack_base + oldmark;
2597 if (flags & G_ARRAY)
2601 *++PL_stack_sp = &PL_sv_undef;
2606 if (PL_scopestack_ix > oldscope) {
2610 register PERL_CONTEXT *cx;
2617 PERL_UNUSED_VAR(newsp);
2618 PERL_UNUSED_VAR(gimme);
2619 PERL_UNUSED_VAR(optype);
2624 if (flags & G_DISCARD) {
2625 PL_stack_sp = PL_stack_base + oldmark;
2635 S_call_body(pTHX_ const OP *myop, bool is_eval)
2637 if (PL_op == myop) {
2639 PL_op = Perl_pp_entereval(aTHX); /* this doesn't do a POPMARK */
2641 PL_op = Perl_pp_entersub(aTHX); /* this does */
2647 /* Eval a string. The G_EVAL flag is always assumed. */
2650 =for apidoc p||eval_sv
2652 Tells Perl to C<eval> the string in the SV.
2658 Perl_eval_sv(pTHX_ SV *sv, I32 flags)
2660 /* See G_* flags in cop.h */
2663 UNOP myop; /* fake syntax tree node */
2664 volatile I32 oldmark = SP - PL_stack_base;
2665 volatile I32 retval = 0;
2667 OP* const oldop = PL_op;
2670 if (flags & G_DISCARD) {
2677 Zero(PL_op, 1, UNOP);
2678 EXTEND(PL_stack_sp, 1);
2679 *++PL_stack_sp = sv;
2681 if (!(flags & G_NOARGS))
2682 myop.op_flags = OPf_STACKED;
2683 myop.op_next = Nullop;
2684 myop.op_type = OP_ENTEREVAL;
2685 myop.op_flags |= ((flags & G_VOID) ? OPf_WANT_VOID :
2686 (flags & G_ARRAY) ? OPf_WANT_LIST :
2688 if (flags & G_KEEPERR)
2689 myop.op_flags |= OPf_SPECIAL;
2691 /* fail now; otherwise we could fail after the JMPENV_PUSH but
2692 * before a PUSHEVAL, which corrupts the stack after a croak */
2693 TAINT_PROPER("eval_sv()");
2699 call_body((OP*)&myop,TRUE);
2700 retval = PL_stack_sp - (PL_stack_base + oldmark);
2701 if (!(flags & G_KEEPERR))
2702 sv_setpvn(ERRSV,"",0);
2708 /* my_exit() was called */
2709 PL_curstash = PL_defstash;
2712 if (PL_statusvalue && !(PL_exit_flags & PERL_EXIT_EXPECTED))
2713 Perl_croak(aTHX_ "Callback called exit");
2718 PL_op = PL_restartop;
2722 PL_stack_sp = PL_stack_base + oldmark;
2723 if (flags & G_ARRAY)
2727 *++PL_stack_sp = &PL_sv_undef;
2733 if (flags & G_DISCARD) {
2734 PL_stack_sp = PL_stack_base + oldmark;
2744 =for apidoc p||eval_pv
2746 Tells Perl to C<eval> the given string and return an SV* result.
2752 Perl_eval_pv(pTHX_ const char *p, I32 croak_on_error)
2755 SV* sv = newSVpv(p, 0);
2757 eval_sv(sv, G_SCALAR);
2764 if (croak_on_error && SvTRUE(ERRSV)) {
2765 Perl_croak(aTHX_ SvPVx_nolen_const(ERRSV));
2771 /* Require a module. */
2774 =head1 Embedding Functions
2776 =for apidoc p||require_pv
2778 Tells Perl to C<require> the file named by the string argument. It is
2779 analogous to the Perl code C<eval "require '$file'">. It's even
2780 implemented that way; consider using load_module instead.
2785 Perl_require_pv(pTHX_ const char *pv)
2789 PUSHSTACKi(PERLSI_REQUIRE);
2791 sv = Perl_newSVpvf(aTHX_ "require q%c%s%c", 0, pv, 0);
2792 eval_sv(sv_2mortal(sv), G_DISCARD);
2798 Perl_magicname(pTHX_ const char *sym, const char *name, I32 namlen)
2800 register GV * const gv = gv_fetchpv(sym,TRUE, SVt_PV);
2803 sv_magic(GvSV(gv), (SV*)gv, PERL_MAGIC_sv, name, namlen);
2807 S_usage(pTHX_ const char *name) /* XXX move this out into a module ? */
2809 /* This message really ought to be max 23 lines.
2810 * Removed -h because the user already knows that option. Others? */
2812 static const char * const usage_msg[] = {
2813 "-0[octal] specify record separator (\\0, if no argument)",
2814 "-A[mod][=pattern] activate all/given assertions",
2815 "-a autosplit mode with -n or -p (splits $_ into @F)",
2816 "-C[number/list] enables the listed Unicode features",
2817 "-c check syntax only (runs BEGIN and CHECK blocks)",
2818 "-d[:debugger] run program under debugger",
2819 "-D[number/list] set debugging flags (argument is a bit mask or alphabets)",
2820 "-e program one line of program (several -e's allowed, omit programfile)",
2821 "-f don't do $sitelib/sitecustomize.pl at startup",
2822 "-F/pattern/ split() pattern for -a switch (//'s are optional)",
2823 "-i[extension] edit <> files in place (makes backup if extension supplied)",
2824 "-Idirectory specify @INC/#include directory (several -I's allowed)",
2825 "-l[octal] enable line ending processing, specifies line terminator",
2826 "-[mM][-]module execute \"use/no module...\" before executing program",
2827 "-n assume \"while (<>) { ... }\" loop around program",
2828 "-p assume loop like -n but print line also, like sed",
2829 "-P run program through C preprocessor before compilation",
2830 "-s enable rudimentary parsing for switches after programfile",
2831 "-S look for programfile using PATH environment variable",
2832 "-t enable tainting warnings",
2833 "-T enable tainting checks",
2834 "-u dump core after parsing program",
2835 "-U allow unsafe operations",
2836 "-v print version, subversion (includes VERY IMPORTANT perl info)",
2837 "-V[:variable] print configuration summary (or a single Config.pm variable)",
2838 "-w enable many useful warnings (RECOMMENDED)",
2839 "-W enable all warnings",
2840 "-x[directory] strip off text before #!perl line and perhaps cd to directory",
2841 "-X disable all warnings",
2845 const char * const *p = usage_msg;
2847 PerlIO_printf(PerlIO_stdout(),
2848 "\nUsage: %s [switches] [--] [programfile] [arguments]",
2851 PerlIO_printf(PerlIO_stdout(), "\n %s", *p++);
2854 /* convert a string of -D options (or digits) into an int.
2855 * sets *s to point to the char after the options */
2859 Perl_get_debug_opts(pTHX_ const char **s, bool givehelp)
2861 static const char * const usage_msgd[] = {
2862 " Debugging flag values: (see also -d)",
2863 " p Tokenizing and parsing (with v, displays parse stack)",
2864 " s Stack snapshots (with v, displays all stacks)",
2865 " l Context (loop) stack processing",
2866 " t Trace execution",
2867 " o Method and overloading resolution",
2868 " c String/numeric conversions",
2869 " P Print profiling info, preprocessor command for -P, source file input state",
2870 " m Memory allocation",
2871 " f Format processing",
2872 " r Regular expression parsing and execution",
2873 " x Syntax tree dump",
2874 " u Tainting checks",
2875 " H Hash dump -- usurps values()",
2876 " X Scratchpad allocation",
2878 " S Thread synchronization",
2880 " R Include reference counts of dumped variables (eg when using -Ds)",
2881 " J Do not s,t,P-debug (Jump over) opcodes within package DB",
2882 " v Verbose: use in conjunction with other flags",
2884 " A Consistency checks on internal structures",
2885 " q quiet - currently only suppresses the 'EXECUTING' message",
2890 /* if adding extra options, remember to update DEBUG_MASK */
2891 static const char debopts[] = "psltocPmfrxu HXDSTRJvCAq";
2893 for (; isALNUM(**s); (*s)++) {
2894 const char * const d = strchr(debopts,**s);
2896 i |= 1 << (d - debopts);
2897 else if (ckWARN_d(WARN_DEBUGGING))
2898 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
2899 "invalid option -D%c, use -D'' to see choices\n", **s);
2902 else if (isDIGIT(**s)) {
2904 for (; isALNUM(**s); (*s)++) ;
2906 else if (givehelp) {
2907 const char *const *p = usage_msgd;
2908 while (*p) PerlIO_printf(PerlIO_stdout(), "%s\n", *p++);
2911 if ((i & DEBUG_p_FLAG) && ckWARN_d(WARN_DEBUGGING))
2912 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
2913 "-Dp not implemented on this platform\n");
2919 /* This routine handles any switches that can be given during run */
2922 Perl_moreswitches(pTHX_ char *s)
2933 SvREFCNT_dec(PL_rs);
2934 if (s[1] == 'x' && s[2]) {
2935 const char *e = s+=2;
2941 flags = PERL_SCAN_SILENT_ILLDIGIT;
2942 rschar = (U32)grok_hex(s, &numlen, &flags, NULL);
2943 if (s + numlen < e) {
2944 rschar = 0; /* Grandfather -0xFOO as -0 -xFOO. */
2948 PL_rs = newSVpvn("", 0);
2949 SvGROW(PL_rs, (STRLEN)(UNISKIP(rschar) + 1));
2950 tmps = (U8*)SvPVX(PL_rs);
2951 uvchr_to_utf8(tmps, rschar);
2952 SvCUR_set(PL_rs, UNISKIP(rschar));
2957 rschar = (U32)grok_oct(s, &numlen, &flags, NULL);
2958 if (rschar & ~((U8)~0))
2959 PL_rs = &PL_sv_undef;
2960 else if (!rschar && numlen >= 2)
2961 PL_rs = newSVpvn("", 0);
2963 char ch = (char)rschar;
2964 PL_rs = newSVpvn(&ch, 1);
2967 sv_setsv(get_sv("/", TRUE), PL_rs);
2972 PL_unicode = parse_unicode_opts( (const char **)&s );
2977 while (*s && !isSPACE(*s)) ++s;
2979 PL_splitstr = savepv(PL_splitstr);
2993 /* -dt indicates to the debugger that threads will be used */
2994 if (*s == 't' && !isALNUM(s[1])) {
2996 my_setenv("PERL5DB_THREADED", "1");
2999 /* The following permits -d:Mod to accepts arguments following an =
3000 in the fashion that -MSome::Mod does. */
3001 if (*s == ':' || *s == '=') {
3003 SV * const sv = newSVpv("use Devel::", 0);
3005 /* We now allow -d:Module=Foo,Bar */
3006 while(isALNUM(*s) || *s==':') ++s;
3008 sv_catpv(sv, start);
3010 sv_catpvn(sv, start, s-start);
3011 Perl_sv_catpvf(aTHX_ sv, " split(/,/,q%c%s%c)", 0, ++s, 0);
3014 my_setenv("PERL5DB", SvPV_nolen_const(sv));
3017 PL_perldb = PERLDB_ALL;
3026 PL_debug = get_debug_opts( (const char **)&s, 1) | DEBUG_TOP_FLAG;
3027 #else /* !DEBUGGING */
3028 if (ckWARN_d(WARN_DEBUGGING))
3029 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3030 "Recompile perl with -DDEBUGGING to use -D switch (did you mean -d ?)\n");
3031 for (s++; isALNUM(*s); s++) ;
3036 usage(PL_origargv[0]);
3039 Safefree(PL_inplace);
3040 #if defined(__CYGWIN__) /* do backup extension automagically */
3041 if (*(s+1) == '\0') {
3042 PL_inplace = savepv(".bak");
3045 #endif /* __CYGWIN__ */
3046 PL_inplace = savepv(s+1);
3047 for (s = PL_inplace; *s && !isSPACE(*s); s++)
3051 if (*s == '-') /* Additional switches on #! line. */
3055 case 'I': /* -I handled both here and in parse_body() */
3058 while (*s && isSPACE(*s))
3063 /* ignore trailing spaces (possibly followed by other switches) */
3065 for (e = p; *e && !isSPACE(*e); e++) ;
3069 } while (*p && *p != '-');
3070 e = savepvn(s, e-s);
3071 incpush(e, TRUE, TRUE, FALSE, FALSE);
3078 Perl_croak(aTHX_ "No directory specified for -I");
3084 SvREFCNT_dec(PL_ors_sv);
3090 PL_ors_sv = newSVpvn("\n",1);
3091 numlen = 3 + (*s == '0');
3092 *SvPVX(PL_ors_sv) = (char)grok_oct(s, &numlen, &flags, NULL);
3096 if (RsPARA(PL_rs)) {
3097 PL_ors_sv = newSVpvn("\n\n",2);
3100 PL_ors_sv = newSVsv(PL_rs);
3107 PL_preambleav = newAV();
3110 char * const start = s;
3111 SV * const sv = newSVpv("use assertions::activate", 24);
3112 while(isALNUM(*s) || *s == ':') ++s;
3114 sv_catpvn(sv, "::", 2);
3115 sv_catpvn(sv, start, s-start);
3118 Perl_sv_catpvf(aTHX_ sv, " split(/,/,q%c%s%c)", 0, ++s, 0);
3121 else if (*s != '\0') {
3122 Perl_croak(aTHX_ "Can't use '%c' after -A%.*s", *s, (int)(s-start), start);
3124 av_push(PL_preambleav, sv);
3128 forbid_setid("-M"); /* XXX ? */
3131 forbid_setid("-m"); /* XXX ? */
3135 const char *use = "use ";
3136 /* -M-foo == 'no foo' */
3137 /* Leading space on " no " is deliberate, to make both
3138 possibilities the same length. */
3139 if (*s == '-') { use = " no "; ++s; }
3140 sv = newSVpvn(use,4);
3142 /* We allow -M'Module qw(Foo Bar)' */
3143 while(isALNUM(*s) || *s==':') ++s;
3145 sv_catpv(sv, start);
3146 if (*(start-1) == 'm') {
3148 Perl_croak(aTHX_ "Can't use '%c' after -mname", *s);
3149 sv_catpv( sv, " ()");
3153 Perl_croak(aTHX_ "Module name required with -%c option",
3155 sv_catpvn(sv, start, s-start);
3156 sv_catpv(sv, " split(/,/,q");
3157 sv_catpvn(sv, "\0)", 1); /* Use NUL as q//-delimiter. */
3159 sv_catpvn(sv, "\0)", 2);
3163 PL_preambleav = newAV();
3164 av_push(PL_preambleav, sv);
3167 Perl_croak(aTHX_ "Missing argument to -%c", *(s-1));
3179 PL_doswitches = TRUE;
3193 #ifdef MACOS_TRADITIONAL
3194 Perl_croak(aTHX_ "Believe me, you don't want to use \"-u\" on a Macintosh");
3196 PL_do_undump = TRUE;
3204 if (!sv_derived_from(PL_patchlevel, "version"))
3205 (void *)upg_version(PL_patchlevel);
3207 PerlIO_printf(PerlIO_stdout(),
3208 Perl_form(aTHX_ "\nThis is perl, %"SVf" built for %s",
3209 vstringify(PL_patchlevel),
3212 /* Adjust verbose output as in the perl that ships with the DG/UX OS from EMC */
3213 PerlIO_printf(PerlIO_stdout(),
3214 Perl_form(aTHX_ "\nThis is perl, %"SVf"\n",
3215 vstringify(PL_patchlevel)));
3216 PerlIO_printf(PerlIO_stdout(),
3217 Perl_form(aTHX_ " built under %s at %s %s\n",
3218 OSNAME, __DATE__, __TIME__));
3219 PerlIO_printf(PerlIO_stdout(),
3220 Perl_form(aTHX_ " OS Specific Release: %s\n",
3224 #if defined(LOCAL_PATCH_COUNT)
3225 if (LOCAL_PATCH_COUNT > 0)
3226 PerlIO_printf(PerlIO_stdout(),
3227 "\n(with %d registered patch%s, "
3228 "see perl -V for more detail)",
3229 (int)LOCAL_PATCH_COUNT,
3230 (LOCAL_PATCH_COUNT!=1) ? "es" : "");
3233 PerlIO_printf(PerlIO_stdout(),
3234 "\n\nCopyright 1987-2005, Larry Wall\n");
3235 #ifdef MACOS_TRADITIONAL
3236 PerlIO_printf(PerlIO_stdout(),
3237 "\nMac OS port Copyright 1991-2002, Matthias Neeracher;\n"
3238 "maintained by Chris Nandor\n");
3241 PerlIO_printf(PerlIO_stdout(),
3242 "\nMS-DOS port Copyright (c) 1989, 1990, Diomidis Spinellis\n");
3245 PerlIO_printf(PerlIO_stdout(),
3246 "djgpp v2 port (jpl5003c) by Hirofumi Watanabe, 1996\n"
3247 "djgpp v2 port (perl5004+) by Laszlo Molnar, 1997-1999\n");
3250 PerlIO_printf(PerlIO_stdout(),
3251 "\n\nOS/2 port Copyright (c) 1990, 1991, Raymond Chen, Kai Uwe Rommel\n"
3252 "Version 5 port Copyright (c) 1994-2002, Andreas Kaiser, Ilya Zakharevich\n");
3255 PerlIO_printf(PerlIO_stdout(),
3256 "atariST series port, ++jrb bammi@cadence.com\n");
3259 PerlIO_printf(PerlIO_stdout(),
3260 "BeOS port Copyright Tom Spindler, 1997-1999\n");
3263 PerlIO_printf(PerlIO_stdout(),
3264 "MPE/iX port Copyright by Mark Klein and Mark Bixby, 1996-2003\n");
3267 PerlIO_printf(PerlIO_stdout(),
3268 "MVS (OS390) port by Mortice Kern Systems, 1997-1999\n");
3271 PerlIO_printf(PerlIO_stdout(),
3272 "Stratus VOS port by Paul.Green@stratus.com, 1997-2002\n");
3275 PerlIO_printf(PerlIO_stdout(),
3276 "VM/ESA port by Neale Ferguson, 1998-1999\n");
3279 PerlIO_printf(PerlIO_stdout(),
3280 "BS2000 (POSIX) port by Start Amadeus GmbH, 1998-1999\n");
3283 PerlIO_printf(PerlIO_stdout(),
3284 "MiNT port by Guido Flohr, 1997-1999\n");
3287 PerlIO_printf(PerlIO_stdout(),
3288 "EPOC port by Olaf Flebbe, 1999-2002\n");
3291 PerlIO_printf(PerlIO_stdout(),"WINCE port by Rainer Keuchel, 2001-2002\n");
3292 PerlIO_printf(PerlIO_stdout(),"Built on " __DATE__ " " __TIME__ "\n\n");
3295 #ifdef __SYMBIAN32__
3296 PerlIO_printf(PerlIO_stdout(),
3297 "Symbian port by Nokia, 2004-2005\n");
3299 #ifdef BINARY_BUILD_NOTICE
3300 BINARY_BUILD_NOTICE;
3302 PerlIO_printf(PerlIO_stdout(),
3304 Perl may be copied only under the terms of either the Artistic License or the\n\
3305 GNU General Public License, which may be found in the Perl 5 source kit.\n\n\
3306 Complete documentation for Perl, including FAQ lists, should be found on\n\
3307 this system using \"man perl\" or \"perldoc perl\". If you have access to the\n\
3308 Internet, point your browser at http://www.perl.org/, the Perl Home Page.\n\n");
3311 if (! (PL_dowarn & G_WARN_ALL_MASK))
3312 PL_dowarn |= G_WARN_ON;
3316 PL_dowarn = G_WARN_ALL_ON|G_WARN_ON;
3317 if (!specialWARN(PL_compiling.cop_warnings))
3318 SvREFCNT_dec(PL_compiling.cop_warnings);
3319 PL_compiling.cop_warnings = pWARN_ALL ;
3323 PL_dowarn = G_WARN_ALL_OFF;
3324 if (!specialWARN(PL_compiling.cop_warnings))
3325 SvREFCNT_dec(PL_compiling.cop_warnings);
3326 PL_compiling.cop_warnings = pWARN_NONE ;
3331 if (s[1] == '-') /* Additional switches on #! line. */
3336 #if defined(WIN32) || !defined(PERL_STRICT_CR)
3342 #ifdef ALTERNATE_SHEBANG
3343 case 'S': /* OS/2 needs -S on "extproc" line. */
3351 Perl_croak(aTHX_ "Can't emulate -%.1s on #! line",s);
3356 /* compliments of Tom Christiansen */
3358 /* unexec() can be found in the Gnu emacs distribution */
3359 /* Known to work with -DUNEXEC and using unexelf.c from GNU emacs-20.2 */
3362 Perl_my_unexec(pTHX)
3370 prog = newSVpv(BIN_EXP, 0);
3371 sv_catpv(prog, "/perl");
3372 file = newSVpv(PL_origfilename, 0);
3373 sv_catpv(file, ".perldump");
3375 unexec(SvPVX(file), SvPVX(prog), &etext, sbrk(0), 0);
3376 /* unexec prints msg to stderr in case of failure */
3377 PerlProc_exit(status);
3380 # include <lib$routines.h>
3381 lib$signal(SS$_DEBUG); /* ssdef.h #included from vmsish.h */
3383 ABORT(); /* for use with undump */
3388 /* initialize curinterp */
3394 # define PERLVAR(var,type)
3395 # define PERLVARA(var,n,type)
3396 # if defined(PERL_IMPLICIT_CONTEXT)
3397 # if defined(USE_5005THREADS)
3398 # define PERLVARI(var,type,init) PERL_GET_INTERP->var = init;
3399 # define PERLVARIC(var,type,init) PERL_GET_INTERP->var = init;
3400 # else /* !USE_5005THREADS */
3401 # define PERLVARI(var,type,init) aTHX->var = init;
3402 # define PERLVARIC(var,type,init) aTHX->var = init;
3403 # endif /* USE_5005THREADS */
3405 # define PERLVARI(var,type,init) PERL_GET_INTERP->var = init;
3406 # define PERLVARIC(var,type,init) PERL_GET_INTERP->var = init;
3408 # include "intrpvar.h"
3409 # ifndef USE_5005THREADS
3410 # include "thrdvar.h"
3417 # define PERLVAR(var,type)
3418 # define PERLVARA(var,n,type)
3419 # define PERLVARI(var,type,init) PL_##var = init;
3420 # define PERLVARIC(var,type,init) PL_##var = init;
3421 # include "intrpvar.h"
3422 # ifndef USE_5005THREADS
3423 # include "thrdvar.h"
3434 S_init_main_stash(pTHX)
3438 PL_curstash = PL_defstash = newHV();
3439 PL_curstname = newSVpvn("main",4);
3440 gv = gv_fetchpv("main::",TRUE, SVt_PVHV);
3441 SvREFCNT_dec(GvHV(gv));
3442 GvHV(gv) = (HV*)SvREFCNT_inc(PL_defstash);
3444 hv_name_set(PL_defstash, "main", 4, 0);
3445 PL_incgv = gv_HVadd(gv_AVadd(gv_fetchpv("INC",TRUE, SVt_PVAV)));
3446 SvREFCNT_inc(PL_incgv); /* Don't allow it to be freed */
3447 GvMULTI_on(PL_incgv);
3448 PL_hintgv = gv_fetchpv("\010",TRUE, SVt_PV); /* ^H */
3449 GvMULTI_on(PL_hintgv);
3450 PL_defgv = gv_fetchpv("_",TRUE, SVt_PVAV);
3451 SvREFCNT_inc(PL_defgv);
3452 PL_errgv = gv_HVadd(gv_fetchpv("@", TRUE, SVt_PV));
3453 SvREFCNT_inc(PL_errgv);
3454 GvMULTI_on(PL_errgv);
3455 PL_replgv = gv_fetchpv("\022", TRUE, SVt_PV); /* ^R */
3456 GvMULTI_on(PL_replgv);
3457 (void)Perl_form(aTHX_ "%240s",""); /* Preallocate temp - for immediate signals. */
3458 #ifdef PERL_DONT_CREATE_GVSV
3461 sv_grow(ERRSV, 240); /* Preallocate - for immediate signals. */
3462 sv_setpvn(ERRSV, "", 0);
3463 PL_curstash = PL_defstash;
3464 CopSTASH_set(&PL_compiling, PL_defstash);
3465 PL_debstash = GvHV(gv_fetchpv("DB::", GV_ADDMULTI, SVt_PVHV));
3466 PL_globalstash = GvHV(gv_fetchpv("CORE::GLOBAL::", GV_ADDMULTI, SVt_PVHV));
3467 /* We must init $/ before switches are processed. */
3468 sv_setpvn(get_sv("/", TRUE), "\n", 1);
3471 /* PSz 18 Nov 03 fdscript now global but do not change prototype */
3473 S_open_script(pTHX_ const char *scriptname, bool dosearch, SV *sv)
3478 const char *cpp_discard_flag;
3487 PL_origfilename = savepvn("-e", 2);
3490 /* if find_script() returns, it returns a malloc()-ed value */
3491 scriptname = PL_origfilename = find_script(scriptname, dosearch, NULL, 1);
3493 if (strnEQ(scriptname, "/dev/fd/", 8) && isDIGIT(scriptname[8]) ) {
3494 const char *s = scriptname + 8;
3495 PL_fdscript = atoi(s);
3500 * Tell apart "normal" usage of fdscript, e.g.
3501 * with bash on FreeBSD:
3502 * perl <( echo '#!perl -DA'; echo 'print "$0\n"')
3503 * from usage in suidperl.
3504 * Does any "normal" usage leave garbage after the number???
3505 * Is it a mistake to use a similar /dev/fd/ construct for
3510 * Be supersafe and do some sanity-checks.
3511 * Still, can we be sure we got the right thing?
3514 Perl_croak(aTHX_ "Wrong syntax (suid) fd script name \"%s\"\n", s);
3517 Perl_croak(aTHX_ "Missing (suid) fd script name\n");
3519 scriptname = savepv(s + 1);
3520 Safefree(PL_origfilename);
3521 PL_origfilename = (char *)scriptname;
3526 CopFILE_free(PL_curcop);
3527 CopFILE_set(PL_curcop, PL_origfilename);
3528 if (*PL_origfilename == '-' && PL_origfilename[1] == '\0')
3529 scriptname = (char *)"";
3530 if (PL_fdscript >= 0) {
3531 PL_rsfp = PerlIO_fdopen(PL_fdscript,PERL_SCRIPT_MODE);
3532 # if defined(HAS_FCNTL) && defined(F_SETFD)
3534 /* ensure close-on-exec */
3535 fcntl(PerlIO_fileno(PL_rsfp),F_SETFD,1);
3540 Perl_croak(aTHX_ "sperl needs fd script\n"
3541 "You should not call sperl directly; do you need to "
3542 "change a #! line\nfrom sperl to perl?\n");
3545 * Do not open (or do other fancy stuff) while setuid.
3546 * Perl does the open, and hands script to suidperl on a fd;
3547 * suidperl only does some checks, sets up UIDs and re-execs
3548 * perl with that fd as it has always done.
3551 if (PL_suidscript != 1) {
3552 Perl_croak(aTHX_ "suidperl needs (suid) fd script\n");
3555 else if (PL_preprocess) {
3556 const char * const cpp_cfg = CPPSTDIN;
3557 SV * const cpp = newSVpvn("",0);
3558 SV * const cmd = NEWSV(0,0);
3560 if (cpp_cfg[0] == 0) /* PERL_MICRO? */
3561 Perl_croak(aTHX_ "Can't run with cpp -P with CPPSTDIN undefined");
3562 if (strEQ(cpp_cfg, "cppstdin"))
3563 Perl_sv_catpvf(aTHX_ cpp, "%s/", BIN_EXP);
3564 sv_catpv(cpp, cpp_cfg);
3567 sv_catpvn(sv, "-I", 2);
3568 sv_catpv(sv,PRIVLIB_EXP);
3571 DEBUG_P(PerlIO_printf(Perl_debug_log,
3572 "PL_preprocess: scriptname=\"%s\", cpp=\"%s\", sv=\"%s\", CPPMINUS=\"%s\"\n",
3573 scriptname, SvPVX_const (cpp), SvPVX_const (sv),
3576 # if defined(MSDOS) || defined(WIN32) || defined(VMS)
3583 cpp_discard_flag = "";
3585 cpp_discard_flag = "-C";
3589 perl = os2_execname(aTHX);
3591 perl = PL_origargv[0];
3595 /* This strips off Perl comments which might interfere with
3596 the C pre-processor, including #!. #line directives are
3597 deliberately stripped to avoid confusion with Perl's version
3598 of #line. FWP played some golf with it so it will fit
3599 into VMS's 255 character buffer.
3602 code = "(1../^#!.*perl/i)|/^\\s*#(?!\\s*((ifn?|un)def|(el|end)?if|define|include|else|error|pragma)\\b)/||!($|=1)||print";
3604 code = "/^\\s*#(?!\\s*((ifn?|un)def|(el|end)?if|define|include|else|error|pragma)\\b)/||!($|=1)||print";
3606 Perl_sv_setpvf(aTHX_ cmd, "\
3607 %s -ne%s%s%s %s | %"SVf" %s %"SVf" %s",
3608 perl, quote, code, quote, scriptname, cpp,
3609 cpp_discard_flag, sv, CPPMINUS);
3611 PL_doextract = FALSE;
3613 DEBUG_P(PerlIO_printf(Perl_debug_log,
3614 "PL_preprocess: cmd=\"%s\"\n",
3617 PL_rsfp = PerlProc_popen((char *)SvPVX_const(cmd), (char *)"r");
3621 else if (!*scriptname) {
3622 forbid_setid("program input from stdin");
3623 PL_rsfp = PerlIO_stdin();
3626 PL_rsfp = PerlIO_open(scriptname,PERL_SCRIPT_MODE);
3627 # if defined(HAS_FCNTL) && defined(F_SETFD)
3629 /* ensure close-on-exec */
3630 fcntl(PerlIO_fileno(PL_rsfp),F_SETFD,1);
3633 #endif /* IAMSUID */
3635 /* PSz 16 Sep 03 Keep neat error message */
3637 Perl_croak(aTHX_ "Can't open "BIT_BUCKET": %s\n", Strerror(errno));
3639 Perl_croak(aTHX_ "Can't open perl script \"%s\": %s\n",
3640 CopFILE(PL_curcop), Strerror(errno));
3645 * I_SYSSTATVFS HAS_FSTATVFS
3647 * I_STATFS HAS_FSTATFS HAS_GETFSSTAT
3648 * I_MNTENT HAS_GETMNTENT HAS_HASMNTOPT
3649 * here so that metaconfig picks them up. */
3653 S_fd_on_nosuid_fs(pTHX_ int fd)
3656 * We used to do this as "plain" user (after swapping UIDs with setreuid);
3657 * but is needed also on machines without setreuid.
3658 * Seems safe enough to run as root.
3660 int check_okay = 0; /* able to do all the required sys/libcalls */
3661 int on_nosuid = 0; /* the fd is on a nosuid fs */
3663 * Need to check noexec also: nosuid might not be set, the average
3664 * sysadmin would say that nosuid is irrelevant once he sets noexec.
3666 int on_noexec = 0; /* the fd is on a noexec fs */
3669 * Preferred order: fstatvfs(), fstatfs(), ustat()+getmnt(), getmntent().
3670 * fstatvfs() is UNIX98.
3671 * fstatfs() is 4.3 BSD.
3672 * ustat()+getmnt() is pre-4.3 BSD.
3673 * getmntent() is O(number-of-mounted-filesystems) and can hang on
3674 * an irrelevant filesystem while trying to reach the right one.
3677 #undef FD_ON_NOSUID_CHECK_OKAY /* found the syscalls to do the check? */
3679 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3680 defined(HAS_FSTATVFS)
3681 # define FD_ON_NOSUID_CHECK_OKAY
3682 struct statvfs stfs;
3684 check_okay = fstatvfs(fd, &stfs) == 0;
3685 on_nosuid = check_okay && (stfs.f_flag & ST_NOSUID);
3687 /* ST_NOEXEC certainly absent on AIX 5.1, and doesn't seem to be documented
3688 on platforms where it is present. */
3689 on_noexec = check_okay && (stfs.f_flag & ST_NOEXEC);
3691 # endif /* fstatvfs */
3693 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3694 defined(PERL_MOUNT_NOSUID) && \
3695 defined(PERL_MOUNT_NOEXEC) && \
3696 defined(HAS_FSTATFS) && \
3697 defined(HAS_STRUCT_STATFS) && \
3698 defined(HAS_STRUCT_STATFS_F_FLAGS)
3699 # define FD_ON_NOSUID_CHECK_OKAY
3702 check_okay = fstatfs(fd, &stfs) == 0;
3703 on_nosuid = check_okay && (stfs.f_flags & PERL_MOUNT_NOSUID);
3704 on_noexec = check_okay && (stfs.f_flags & PERL_MOUNT_NOEXEC);
3705 # endif /* fstatfs */
3707 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3708 defined(PERL_MOUNT_NOSUID) && \
3709 defined(PERL_MOUNT_NOEXEC) && \
3710 defined(HAS_FSTAT) && \
3711 defined(HAS_USTAT) && \
3712 defined(HAS_GETMNT) && \
3713 defined(HAS_STRUCT_FS_DATA) && \
3715 # define FD_ON_NOSUID_CHECK_OKAY
3718 if (fstat(fd, &fdst) == 0) {
3720 if (ustat(fdst.st_dev, &us) == 0) {
3722 /* NOSTAT_ONE here because we're not examining fields which
3723 * vary between that case and STAT_ONE. */
3724 if (getmnt((int*)0, &fsd, (int)0, NOSTAT_ONE, us.f_fname) == 0) {
3725 size_t cmplen = sizeof(us.f_fname);
3726 if (sizeof(fsd.fd_req.path) < cmplen)
3727 cmplen = sizeof(fsd.fd_req.path);
3728 if (strnEQ(fsd.fd_req.path, us.f_fname, cmplen) &&
3729 fdst.st_dev == fsd.fd_req.dev) {
3731 on_nosuid = fsd.fd_req.flags & PERL_MOUNT_NOSUID;
3732 on_noexec = fsd.fd_req.flags & PERL_MOUNT_NOEXEC;
3737 # endif /* fstat+ustat+getmnt */
3739 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3740 defined(HAS_GETMNTENT) && \
3741 defined(HAS_HASMNTOPT) && \
3742 defined(MNTOPT_NOSUID) && \
3743 defined(MNTOPT_NOEXEC)
3744 # define FD_ON_NOSUID_CHECK_OKAY
3745 FILE *mtab = fopen("/etc/mtab", "r");
3746 struct mntent *entry;
3749 if (mtab && (fstat(fd, &stb) == 0)) {
3750 while (entry = getmntent(mtab)) {
3751 if (stat(entry->mnt_dir, &fsb) == 0
3752 && fsb.st_dev == stb.st_dev)
3754 /* found the filesystem */
3756 if (hasmntopt(entry, MNTOPT_NOSUID))
3758 if (hasmntopt(entry, MNTOPT_NOEXEC))
3761 } /* A single fs may well fail its stat(). */
3766 # endif /* getmntent+hasmntopt */
3769 Perl_croak(aTHX_ "Can't check filesystem of script \"%s\" for nosuid/noexec", PL_origfilename);
3771 Perl_croak(aTHX_ "Setuid script \"%s\" on nosuid filesystem", PL_origfilename);
3773 Perl_croak(aTHX_ "Setuid script \"%s\" on noexec filesystem", PL_origfilename);
3774 return ((!check_okay) || on_nosuid || on_noexec);
3776 #endif /* IAMSUID */
3779 S_validate_suid(pTHX_ const char *validarg, const char *scriptname)
3784 #endif /* IAMSUID */
3786 /* do we need to emulate setuid on scripts? */
3788 /* This code is for those BSD systems that have setuid #! scripts disabled
3789 * in the kernel because of a security problem. Merely defining DOSUID
3790 * in perl will not fix that problem, but if you have disabled setuid
3791 * scripts in the kernel, this will attempt to emulate setuid and setgid
3792 * on scripts that have those now-otherwise-useless bits set. The setuid
3793 * root version must be called suidperl or sperlN.NNN. If regular perl
3794 * discovers that it has opened a setuid script, it calls suidperl with
3795 * the same argv that it had. If suidperl finds that the script it has
3796 * just opened is NOT setuid root, it sets the effective uid back to the
3797 * uid. We don't just make perl setuid root because that loses the
3798 * effective uid we had before invoking perl, if it was different from the
3801 * Description/comments above do not match current workings:
3802 * suidperl must be hardlinked to sperlN.NNN (that is what we exec);
3803 * suidperl called with script open and name changed to /dev/fd/N/X;
3804 * suidperl croaks if script is not setuid;
3805 * making perl setuid would be a huge security risk (and yes, that
3806 * would lose any euid we might have had).
3808 * DOSUID must be defined in both perl and suidperl, and IAMSUID must
3809 * be defined in suidperl only. suidperl must be setuid root. The
3810 * Configure script will set this up for you if you want it.
3816 if (PerlLIO_fstat(PerlIO_fileno(PL_rsfp),&PL_statbuf) < 0) /* normal stat is insecure */
3817 Perl_croak(aTHX_ "Can't stat script \"%s\"",PL_origfilename);
3818 if (PL_statbuf.st_mode & (S_ISUID|S_ISGID)) {
3820 const char *linestr;
3823 if (PL_fdscript < 0 || PL_suidscript != 1)
3824 Perl_croak(aTHX_ "Need (suid) fdscript in suidperl\n"); /* We already checked this */
3826 * Since the script is opened by perl, not suidperl, some of these
3827 * checks are superfluous. Leaving them in probably does not lower
3831 * Do checks even for systems with no HAS_SETREUID.
3832 * We used to swap, then re-swap UIDs with
3834 if (setreuid(PL_euid,PL_uid) < 0
3835 || PerlProc_getuid() != PL_euid || PerlProc_geteuid() != PL_uid)
3836 Perl_croak(aTHX_ "Can't swap uid and euid");
3839 if (setreuid(PL_uid,PL_euid) < 0
3840 || PerlProc_getuid() != PL_uid || PerlProc_geteuid() != PL_euid)
3841 Perl_croak(aTHX_ "Can't reswap uid and euid");
3845 /* On this access check to make sure the directories are readable,
3846 * there is actually a small window that the user could use to make
3847 * filename point to an accessible directory. So there is a faint
3848 * chance that someone could execute a setuid script down in a
3849 * non-accessible directory. I don't know what to do about that.
3850 * But I don't think it's too important. The manual lies when
3851 * it says access() is useful in setuid programs.
3853 * So, access() is pretty useless... but not harmful... do anyway.
3855 if (PerlLIO_access(CopFILE(PL_curcop),1)) { /*double check*/
3856 Perl_croak(aTHX_ "Can't access() script\n");
3859 /* If we can swap euid and uid, then we can determine access rights
3860 * with a simple stat of the file, and then compare device and
3861 * inode to make sure we did stat() on the same file we opened.
3862 * Then we just have to make sure he or she can execute it.
3865 * As the script is opened by perl, not suidperl, we do not need to
3866 * care much about access rights.
3868 * The 'script changed' check is needed, or we can get lied to
3869 * about $0 with e.g.
3870 * suidperl /dev/fd/4//bin/x 4<setuidscript
3871 * Without HAS_SETREUID, is it safe to stat() as root?
3873 * Are there any operating systems that pass /dev/fd/xxx for setuid
3874 * scripts, as suggested/described in perlsec(1)? Surely they do not
3875 * pass the script name as we do, so the "script changed" test would
3876 * fail for them... but we never get here with
3877 * SETUID_SCRIPTS_ARE_SECURE_NOW defined.
3879 * This is one place where we must "lie" about return status: not
3880 * say if the stat() failed. We are doing this as root, and could
3881 * be tricked into reporting existence or not of files that the
3882 * "plain" user cannot even see.
3886 if (PerlLIO_stat(CopFILE(PL_curcop),&tmpstatbuf) < 0 ||
3887 tmpstatbuf.st_dev != PL_statbuf.st_dev ||
3888 tmpstatbuf.st_ino != PL_statbuf.st_ino) {
3889 Perl_croak(aTHX_ "Setuid script changed\n");
3893 if (!cando(S_IXUSR,FALSE,&PL_statbuf)) /* can real uid exec? */
3894 Perl_croak(aTHX_ "Real UID cannot exec script\n");
3897 * We used to do this check as the "plain" user (after swapping
3898 * UIDs). But the check for nosuid and noexec filesystem is needed,
3899 * and should be done even without HAS_SETREUID. (Maybe those
3900 * operating systems do not have such mount options anyway...)
3901 * Seems safe enough to do as root.
3903 #if !defined(NO_NOSUID_CHECK)
3904 if (fd_on_nosuid_fs(PerlIO_fileno(PL_rsfp))) {
3905 Perl_croak(aTHX_ "Setuid script on nosuid or noexec filesystem\n");
3908 #endif /* IAMSUID */
3910 if (!S_ISREG(PL_statbuf.st_mode)) {
3911 Perl_croak(aTHX_ "Setuid script not plain file\n");
3913 if (PL_statbuf.st_mode & S_IWOTH)
3914 Perl_croak(aTHX_ "Setuid/gid script is writable by world");
3915 PL_doswitches = FALSE; /* -s is insecure in suid */
3916 /* PSz 13 Nov 03 But -s was caught elsewhere ... so unsetting it here is useless(?!) */
3917 CopLINE_inc(PL_curcop);
3918 linestr = SvPV_nolen_const(PL_linestr);
3919 if (sv_gets(PL_linestr, PL_rsfp, 0) == Nullch ||
3920 strnNE(linestr,"#!",2) ) /* required even on Sys V */
3921 Perl_croak(aTHX_ "No #! line");
3925 /* Sanity check on line length */
3926 if (strlen(s) < 1 || strlen(s) > 4000)
3927 Perl_croak(aTHX_ "Very long #! line");
3928 /* Allow more than a single space after #! */
3929 while (isSPACE(*s)) s++;
3930 /* Sanity check on buffer end */
3931 while ((*s) && !isSPACE(*s)) s++;
3932 for (s2 = s; (s2 > linestr &&
3933 (isDIGIT(s2[-1]) || s2[-1] == '.' || s2[-1] == '_'
3934 || s2[-1] == '-')); s2--) ;
3935 /* Sanity check on buffer start */
3936 if ( (s2-4 < linestr || strnNE(s2-4,"perl",4)) &&
3937 (s-9 < linestr || strnNE(s-9,"perl",4)) )
3938 Perl_croak(aTHX_ "Not a perl script");
3939 while (*s == ' ' || *s == '\t') s++;
3941 * #! arg must be what we saw above. They can invoke it by
3942 * mentioning suidperl explicitly, but they may not add any strange
3943 * arguments beyond what #! says if they do invoke suidperl that way.
3946 * The way validarg was set up, we rely on the kernel to start
3947 * scripts with argv[1] set to contain all #! line switches (the
3951 * Check that we got all the arguments listed in the #! line (not
3952 * just that there are no extraneous arguments). Might not matter
3953 * much, as switches from #! line seem to be acted upon (also), and
3954 * so may be checked and trapped in perl. But, security checks must
3955 * be done in suidperl and not deferred to perl. Note that suidperl
3956 * does not get around to parsing (and checking) the switches on
3957 * the #! line (but execs perl sooner).
3958 * Allow (require) a trailing newline (which may be of two
3959 * characters on some architectures?) (but no other trailing
3962 len = strlen(validarg);
3963 if (strEQ(validarg," PHOOEY ") ||
3964 strnNE(s,validarg,len) || !isSPACE(s[len]) ||
3965 !(strlen(s) == len+1 || (strlen(s) == len+2 && isSPACE(s[len+1]))))
3966 Perl_croak(aTHX_ "Args must match #! line");
3969 if (PL_fdscript < 0 &&
3970 PL_euid != PL_uid && (PL_statbuf.st_mode & S_ISUID) &&
3971 PL_euid == PL_statbuf.st_uid)
3973 Perl_croak(aTHX_ "YOU HAVEN'T DISABLED SET-ID SCRIPTS IN THE KERNEL YET!\n\
3974 FIX YOUR KERNEL, OR PUT A C WRAPPER AROUND THIS SCRIPT!\n");
3975 #endif /* IAMSUID */
3977 if (PL_fdscript < 0 &&
3978 PL_euid) { /* oops, we're not the setuid root perl */
3980 * When root runs a setuid script, we do not go through the same
3981 * steps of execing sperl and then perl with fd scripts, but
3982 * simply set up UIDs within the same perl invocation; so do
3983 * not have the same checks (on options, whatever) that we have
3984 * for plain users. No problem really: would have to be a script
3985 * that does not actually work for plain users; and if root is
3986 * foolish and can be persuaded to run such an unsafe script, he
3987 * might run also non-setuid ones, and deserves what he gets.
3989 * Or, we might drop the PL_euid check above (and rely just on
3990 * PL_fdscript to avoid loops), and do the execs
3996 * Pass fd script to suidperl.
3997 * Exec suidperl, substituting fd script for scriptname.
3998 * Pass script name as "subdir" of fd, which perl will grok;
3999 * in fact will use that to distinguish this from "normal"
4000 * usage, see comments above.
4002 PerlIO_rewind(PL_rsfp);
4003 PerlLIO_lseek(PerlIO_fileno(PL_rsfp),(Off_t)0,0); /* just in case rewind didn't */
4004 /* PSz 27 Feb 04 Sanity checks on scriptname */
4005 if ((!scriptname) || (!*scriptname) ) {
4006 Perl_croak(aTHX_ "No setuid script name\n");
4008 if (*scriptname == '-') {
4009 Perl_croak(aTHX_ "Setuid script name may not begin with dash\n");
4010 /* Or we might confuse it with an option when replacing
4011 * name in argument list, below (though we do pointer, not
4012 * string, comparisons).
4015 for (which = 1; PL_origargv[which] && PL_origargv[which] != scriptname; which++) ;
4016 if (!PL_origargv[which]) {
4017 Perl_croak(aTHX_ "Can't change argv to have fd script\n");
4019 PL_origargv[which] = savepv(Perl_form(aTHX_ "/dev/fd/%d/%s",
4020 PerlIO_fileno(PL_rsfp), PL_origargv[which]));
4021 #if defined(HAS_FCNTL) && defined(F_SETFD)
4022 fcntl(PerlIO_fileno(PL_rsfp),F_SETFD,0); /* ensure no close-on-exec */
4025 PerlProc_execv(Perl_form(aTHX_ "%s/sperl"PERL_FS_VER_FMT, BIN_EXP,
4026 (int)PERL_REVISION, (int)PERL_VERSION,
4027 (int)PERL_SUBVERSION), PL_origargv);
4029 #endif /* IAMSUID */
4030 Perl_croak(aTHX_ "Can't do setuid (cannot exec sperl)\n");
4033 if (PL_statbuf.st_mode & S_ISGID && PL_statbuf.st_gid != PL_egid) {
4035 * This seems back to front: we try HAS_SETEGID first; if not available
4036 * then try HAS_SETREGID; as a last chance we try HAS_SETRESGID. May be OK
4037 * in the sense that we only want to set EGID; but are there any machines
4038 * with either of the latter, but not the former? Same with UID, later.
4041 (void)setegid(PL_statbuf.st_gid);
4044 (void)setregid((Gid_t)-1,PL_statbuf.st_gid);
4046 #ifdef HAS_SETRESGID
4047 (void)setresgid((Gid_t)-1,PL_statbuf.st_gid,(Gid_t)-1);
4049 PerlProc_setgid(PL_statbuf.st_gid);
4053 if (PerlProc_getegid() != PL_statbuf.st_gid)
4054 Perl_croak(aTHX_ "Can't do setegid!\n");
4056 if (PL_statbuf.st_mode & S_ISUID) {
4057 if (PL_statbuf.st_uid != PL_euid)
4059 (void)seteuid(PL_statbuf.st_uid); /* all that for this */
4062 (void)setreuid((Uid_t)-1,PL_statbuf.st_uid);
4064 #ifdef HAS_SETRESUID
4065 (void)setresuid((Uid_t)-1,PL_statbuf.st_uid,(Uid_t)-1);
4067 PerlProc_setuid(PL_statbuf.st_uid);
4071 if (PerlProc_geteuid() != PL_statbuf.st_uid)
4072 Perl_croak(aTHX_ "Can't do seteuid!\n");
4074 else if (PL_uid) { /* oops, mustn't run as root */
4076 (void)seteuid((Uid_t)PL_uid);
4079 (void)setreuid((Uid_t)-1,(Uid_t)PL_uid);
4081 #ifdef HAS_SETRESUID
4082 (void)setresuid((Uid_t)-1,(Uid_t)PL_uid,(Uid_t)-1);
4084 PerlProc_setuid((Uid_t)PL_uid);
4088 if (PerlProc_geteuid() != PL_uid)
4089 Perl_croak(aTHX_ "Can't do seteuid!\n");
4092 if (!cando(S_IXUSR,TRUE,&PL_statbuf))
4093 Perl_croak(aTHX_ "Effective UID cannot exec script\n"); /* they can't do this */
4096 else if (PL_preprocess) /* PSz 13 Nov 03 Caught elsewhere, useless(?!) here */
4097 Perl_croak(aTHX_ "-P not allowed for setuid/setgid script\n");
4098 else if (PL_fdscript < 0 || PL_suidscript != 1)
4099 /* PSz 13 Nov 03 Caught elsewhere, useless(?!) here */
4100 Perl_croak(aTHX_ "(suid) fdscript needed in suidperl\n");
4102 /* PSz 16 Sep 03 Keep neat error message */
4103 Perl_croak(aTHX_ "Script is not setuid/setgid in suidperl\n");
4106 /* We absolutely must clear out any saved ids here, so we */
4107 /* exec the real perl, substituting fd script for scriptname. */
4108 /* (We pass script name as "subdir" of fd, which perl will grok.) */
4110 * It might be thought that using setresgid and/or setresuid (changed to
4111 * set the saved IDs) above might obviate the need to exec, and we could
4112 * go on to "do the perl thing".
4114 * Is there such a thing as "saved GID", and is that set for setuid (but
4115 * not setgid) execution like suidperl? Without exec, it would not be
4116 * cleared for setuid (but not setgid) scripts (or might need a dummy
4119 * We need suidperl to do the exact same argument checking that perl
4120 * does. Thus it cannot be very small; while it could be significantly
4121 * smaller, it is safer (simpler?) to make it essentially the same
4122 * binary as perl (but they are not identical). - Maybe could defer that
4123 * check to the invoked perl, and suidperl be a tiny wrapper instead;
4124 * but prefer to do thorough checks in suidperl itself. Such deferral
4125 * would make suidperl security rely on perl, a design no-no.
4127 * Setuid things should be short and simple, thus easy to understand and
4128 * verify. They should do their "own thing", without influence by
4129 * attackers. It may help if their internal execution flow is fixed,
4130 * regardless of platform: it may be best to exec anyway.
4132 * Suidperl should at least be conceptually simple: a wrapper only,
4133 * never to do any real perl. Maybe we should put
4135 * Perl_croak(aTHX_ "Suidperl should never do real perl\n");
4137 * into the perly bits.
4139 PerlIO_rewind(PL_rsfp);
4140 PerlLIO_lseek(PerlIO_fileno(PL_rsfp),(Off_t)0,0); /* just in case rewind didn't */
4142 * Keep original arguments: suidperl already has fd script.
4144 /* for (which = 1; PL_origargv[which] && PL_origargv[which] != scriptname; which++) ; */
4145 /* if (!PL_origargv[which]) { */
4146 /* errno = EPERM; */
4147 /* Perl_croak(aTHX_ "Permission denied\n"); */
4149 /* PL_origargv[which] = savepv(Perl_form(aTHX_ "/dev/fd/%d/%s", */
4150 /* PerlIO_fileno(PL_rsfp), PL_origargv[which])); */
4151 #if defined(HAS_FCNTL) && defined(F_SETFD)
4152 fcntl(PerlIO_fileno(PL_rsfp),F_SETFD,0); /* ensure no close-on-exec */
4155 PerlProc_execv(Perl_form(aTHX_ "%s/perl"PERL_FS_VER_FMT, BIN_EXP,
4156 (int)PERL_REVISION, (int)PERL_VERSION,
4157 (int)PERL_SUBVERSION), PL_origargv);/* try again */
4159 Perl_croak(aTHX_ "Can't do setuid (suidperl cannot exec perl)\n");
4160 #endif /* IAMSUID */
4162 if (PL_euid != PL_uid || PL_egid != PL_gid) { /* (suidperl doesn't exist, in fact) */
4163 #ifndef SETUID_SCRIPTS_ARE_SECURE_NOW
4164 PerlLIO_fstat(PerlIO_fileno(PL_rsfp),&PL_statbuf); /* may be either wrapped or real suid */
4165 if ((PL_euid != PL_uid && PL_euid == PL_statbuf.st_uid && PL_statbuf.st_mode & S_ISUID)
4167 (PL_egid != PL_gid && PL_egid == PL_statbuf.st_gid && PL_statbuf.st_mode & S_ISGID)
4170 Perl_croak(aTHX_ "YOU HAVEN'T DISABLED SET-ID SCRIPTS IN THE KERNEL YET!\n\
4171 FIX YOUR KERNEL, PUT A C WRAPPER AROUND THIS SCRIPT, OR USE -u AND UNDUMP!\n");
4172 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4173 /* not set-id, must be wrapped */
4181 S_find_beginning(pTHX)
4184 register const char *s2;
4185 #ifdef MACOS_TRADITIONAL
4189 /* skip forward in input to the real script? */
4192 #ifdef MACOS_TRADITIONAL
4193 /* Since the Mac OS does not honor #! arguments for us, we do it ourselves */
4195 while (PL_doextract || gMacPerl_AlwaysExtract) {
4196 if ((s = sv_gets(PL_linestr, PL_rsfp, 0)) == Nullch) {
4197 if (!gMacPerl_AlwaysExtract)
4198 Perl_croak(aTHX_ "No Perl script found in input\n");
4200 if (PL_doextract) /* require explicit override ? */
4201 if (!OverrideExtract(PL_origfilename))
4202 Perl_croak(aTHX_ "User aborted script\n");
4204 PL_doextract = FALSE;
4206 /* Pater peccavi, file does not have #! */
4207 PerlIO_rewind(PL_rsfp);
4212 while (PL_doextract) {
4213 if ((s = sv_gets(PL_linestr, PL_rsfp, 0)) == Nullch)
4214 Perl_croak(aTHX_ "No Perl script found in input\n");
4217 if (*s == '#' && s[1] == '!' && ((s = instr(s,"perl")) || (s = instr(s2,"PERL")))) {
4218 PerlIO_ungetc(PL_rsfp, '\n'); /* to keep line count right */
4219 PL_doextract = FALSE;
4220 while (*s && !(isSPACE (*s) || *s == '#')) s++;
4222 while (*s == ' ' || *s == '\t') s++;
4224 while (isDIGIT(s2[-1]) || s2[-1] == '-' || s2[-1] == '.'
4225 || s2[-1] == '_') s2--;
4226 if (strnEQ(s2-4,"perl",4))
4227 while ((s = moreswitches(s)))
4230 #ifdef MACOS_TRADITIONAL
4231 /* We are always searching for the #!perl line in MacPerl,
4232 * so if we find it, still keep the line count correct
4233 * by counting lines we already skipped over
4235 for (; maclines > 0 ; maclines--)
4236 PerlIO_ungetc(PL_rsfp, '\n');
4240 /* gMacPerl_AlwaysExtract is false in MPW tool */
4241 } else if (gMacPerl_AlwaysExtract) {
4252 PL_uid = PerlProc_getuid();
4253 PL_euid = PerlProc_geteuid();
4254 PL_gid = PerlProc_getgid();
4255 PL_egid = PerlProc_getegid();
4257 PL_uid |= PL_gid << 16;
4258 PL_euid |= PL_egid << 16;
4260 /* Should not happen: */
4261 CHECK_MALLOC_TAINT(PL_uid && (PL_euid != PL_uid || PL_egid != PL_gid));
4262 PL_tainting |= (PL_uid && (PL_euid != PL_uid || PL_egid != PL_gid));
4265 * Should go by suidscript, not uid!=euid: why disallow
4266 * system("ls") in scripts run from setuid things?
4267 * Or, is this run before we check arguments and set suidscript?
4268 * What about SETUID_SCRIPTS_ARE_SECURE_NOW: could we use fdscript then?
4269 * (We never have suidscript, can we be sure to have fdscript?)
4270 * Or must then go by UID checks? See comments in forbid_setid also.
4274 /* This is used very early in the lifetime of the program,
4275 * before even the options are parsed, so PL_tainting has
4276 * not been initialized properly. */
4278 Perl_doing_taint(int argc, char *argv[], char *envp[])
4280 #ifndef PERL_IMPLICIT_SYS
4281 /* If we have PERL_IMPLICIT_SYS we can't call getuid() et alia
4282 * before we have an interpreter-- and the whole point of this
4283 * function is to be called at such an early stage. If you are on
4284 * a system with PERL_IMPLICIT_SYS but you do have a concept of
4285 * "tainted because running with altered effective ids', you'll
4286 * have to add your own checks somewhere in here. The two most
4287 * known samples of 'implicitness' are Win32 and NetWare, neither
4288 * of which has much of concept of 'uids'. */
4289 int uid = PerlProc_getuid();
4290 int euid = PerlProc_geteuid();
4291 int gid = PerlProc_getgid();
4292 int egid = PerlProc_getegid();
4299 if (uid && (euid != uid || egid != gid))
4301 #endif /* !PERL_IMPLICIT_SYS */
4302 /* This is a really primitive check; environment gets ignored only
4303 * if -T are the first chars together; otherwise one gets
4304 * "Too late" message. */
4305 if ( argc > 1 && argv[1][0] == '-'
4306 && (argv[1][1] == 't' || argv[1][1] == 'T') )
4312 S_forbid_setid(pTHX_ const char *s)
4314 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
4315 if (PL_euid != PL_uid)
4316 Perl_croak(aTHX_ "No %s allowed while running setuid", s);
4317 if (PL_egid != PL_gid)
4318 Perl_croak(aTHX_ "No %s allowed while running setgid", s);
4319 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4321 * Checks for UID/GID above "wrong": why disallow
4322 * perl -e 'print "Hello\n"'
4323 * from within setuid things?? Simply drop them: replaced by
4324 * fdscript/suidscript and #ifdef IAMSUID checks below.
4326 * This may be too late for command-line switches. Will catch those on
4327 * the #! line, after finding the script name and setting up
4328 * fdscript/suidscript. Note that suidperl does not get around to
4329 * parsing (and checking) the switches on the #! line, but checks that
4330 * the two sets are identical.
4332 * With SETUID_SCRIPTS_ARE_SECURE_NOW, could we use fdscript, also or
4333 * instead, or would that be "too late"? (We never have suidscript, can
4334 * we be sure to have fdscript?)
4336 * Catch things with suidscript (in descendant of suidperl), even with
4337 * right UID/GID. Was already checked in suidperl, with #ifdef IAMSUID,
4338 * below; but I am paranoid.
4340 * Also see comments about root running a setuid script, elsewhere.
4342 if (PL_suidscript >= 0)
4343 Perl_croak(aTHX_ "No %s allowed with (suid) fdscript", s);
4345 /* PSz 11 Nov 03 Catch it in suidperl, always! */
4346 Perl_croak(aTHX_ "No %s allowed in suidperl", s);
4347 #endif /* IAMSUID */
4351 Perl_init_debugger(pTHX)
4353 HV * const ostash = PL_curstash;
4355 PL_curstash = PL_debstash;
4356 PL_dbargs = GvAV(gv_AVadd((gv_fetchpv("DB::args", GV_ADDMULTI, SVt_PVAV))));
4357 AvREAL_off(PL_dbargs);
4358 PL_DBgv = gv_fetchpv("DB::DB", GV_ADDMULTI, SVt_PVGV);
4359 PL_DBline = gv_fetchpv("DB::dbline", GV_ADDMULTI, SVt_PVAV);
4360 PL_DBsub = gv_HVadd(gv_fetchpv("DB::sub", GV_ADDMULTI, SVt_PVHV));
4361 PL_DBsingle = GvSV((gv_fetchpv("DB::single", GV_ADDMULTI, SVt_PV)));
4362 sv_setiv(PL_DBsingle, 0);
4363 PL_DBtrace = GvSV((gv_fetchpv("DB::trace", GV_ADDMULTI, SVt_PV)));
4364 sv_setiv(PL_DBtrace, 0);
4365 PL_DBsignal = GvSV((gv_fetchpv("DB::signal", GV_ADDMULTI, SVt_PV)));
4366 sv_setiv(PL_DBsignal, 0);
4367 PL_DBassertion = GvSV((gv_fetchpv("DB::assertion", GV_ADDMULTI, SVt_PV)));
4368 sv_setiv(PL_DBassertion, 0);
4369 PL_curstash = ostash;
4372 #ifndef STRESS_REALLOC
4373 #define REASONABLE(size) (size)
4375 #define REASONABLE(size) (1) /* unreasonable */
4379 Perl_init_stacks(pTHX)
4381 /* start with 128-item stack and 8K cxstack */
4382 PL_curstackinfo = new_stackinfo(REASONABLE(128),
4383 REASONABLE(8192/sizeof(PERL_CONTEXT) - 1));
4384 PL_curstackinfo->si_type = PERLSI_MAIN;
4385 PL_curstack = PL_curstackinfo->si_stack;
4386 PL_mainstack = PL_curstack; /* remember in case we switch stacks */
4388 PL_stack_base = AvARRAY(PL_curstack);
4389 PL_stack_sp = PL_stack_base;
4390 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
4392 Newx(PL_tmps_stack,REASONABLE(128),SV*);
4395 PL_tmps_max = REASONABLE(128);
4397 Newx(PL_markstack,REASONABLE(32),I32);
4398 PL_markstack_ptr = PL_markstack;
4399 PL_markstack_max = PL_markstack + REASONABLE(32);
4403 Newx(PL_scopestack,REASONABLE(32),I32);
4404 PL_scopestack_ix = 0;
4405 PL_scopestack_max = REASONABLE(32);
4407 Newx(PL_savestack,REASONABLE(128),ANY);
4408 PL_savestack_ix = 0;
4409 PL_savestack_max = REASONABLE(128);
4417 while (PL_curstackinfo->si_next)
4418 PL_curstackinfo = PL_curstackinfo->si_next;
4419 while (PL_curstackinfo) {
4420 PERL_SI *p = PL_curstackinfo->si_prev;
4421 /* curstackinfo->si_stack got nuked by sv_free_arenas() */
4422 Safefree(PL_curstackinfo->si_cxstack);
4423 Safefree(PL_curstackinfo);
4424 PL_curstackinfo = p;
4426 Safefree(PL_tmps_stack);
4427 Safefree(PL_markstack);
4428 Safefree(PL_scopestack);
4429 Safefree(PL_savestack);
4438 lex_start(PL_linestr);
4440 PL_subname = newSVpvn("main",4);
4444 S_init_predump_symbols(pTHX)
4449 sv_setpvn(get_sv("\"", TRUE), " ", 1);
4450 PL_stdingv = gv_fetchpv("STDIN",TRUE, SVt_PVIO);
4451 GvMULTI_on(PL_stdingv);
4452 io = GvIOp(PL_stdingv);
4453 IoTYPE(io) = IoTYPE_RDONLY;
4454 IoIFP(io) = PerlIO_stdin();
4455 tmpgv = gv_fetchpv("stdin",TRUE, SVt_PV);
4457 GvIOp(tmpgv) = (IO*)SvREFCNT_inc(io);
4459 tmpgv = gv_fetchpv("STDOUT",TRUE, SVt_PVIO);
4462 IoTYPE(io) = IoTYPE_WRONLY;
4463 IoOFP(io) = IoIFP(io) = PerlIO_stdout();
4465 tmpgv = gv_fetchpv("stdout",TRUE, SVt_PV);
4467 GvIOp(tmpgv) = (IO*)SvREFCNT_inc(io);
4469 PL_stderrgv = gv_fetchpv("STDERR",TRUE, SVt_PVIO);
4470 GvMULTI_on(PL_stderrgv);
4471 io = GvIOp(PL_stderrgv);
4472 IoTYPE(io) = IoTYPE_WRONLY;
4473 IoOFP(io) = IoIFP(io) = PerlIO_stderr();
4474 tmpgv = gv_fetchpv("stderr",TRUE, SVt_PV);
4476 GvIOp(tmpgv) = (IO*)SvREFCNT_inc(io);
4478 PL_statname = NEWSV(66,0); /* last filename we did stat on */
4480 Safefree(PL_osname);
4481 PL_osname = savepv(OSNAME);
4485 Perl_init_argv_symbols(pTHX_ register int argc, register char **argv)
4487 argc--,argv++; /* skip name of script */
4488 if (PL_doswitches) {
4489 for (; argc > 0 && **argv == '-'; argc--,argv++) {
4493 if (argv[0][1] == '-' && !argv[0][2]) {
4497 if ((s = strchr(argv[0], '='))) {
4499 sv_setpv(GvSV(gv_fetchpv(argv[0]+1,TRUE, SVt_PV)),s);
4502 sv_setiv(GvSV(gv_fetchpv(argv[0]+1,TRUE, SVt_PV)),1);
4505 if ((PL_argvgv = gv_fetchpv("ARGV",TRUE, SVt_PVAV))) {
4506 GvMULTI_on(PL_argvgv);
4507 (void)gv_AVadd(PL_argvgv);
4508 av_clear(GvAVn(PL_argvgv));
4509 for (; argc > 0; argc--,argv++) {
4510 SV * const sv = newSVpv(argv[0],0);
4511 av_push(GvAVn(PL_argvgv),sv);
4512 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
4513 if (PL_unicode & PERL_UNICODE_ARGV_FLAG)
4516 if (PL_unicode & PERL_UNICODE_WIDESYSCALLS_FLAG) /* Sarathy? */
4517 (void)sv_utf8_decode(sv);
4523 S_init_postdump_symbols(pTHX_ register int argc, register char **argv, register char **env)
4528 PL_toptarget = NEWSV(0,0);
4529 sv_upgrade(PL_toptarget, SVt_PVFM);
4530 sv_setpvn(PL_toptarget, "", 0);
4531 PL_bodytarget = NEWSV(0,0);
4532 sv_upgrade(PL_bodytarget, SVt_PVFM);
4533 sv_setpvn(PL_bodytarget, "", 0);
4534 PL_formtarget = PL_bodytarget;
4538 init_argv_symbols(argc,argv);
4540 if ((tmpgv = gv_fetchpv("0",TRUE, SVt_PV))) {
4541 #ifdef MACOS_TRADITIONAL
4542 /* $0 is not majick on a Mac */
4543 sv_setpv(GvSV(tmpgv),MacPerl_MPWFileName(PL_origfilename));
4545 sv_setpv(GvSV(tmpgv),PL_origfilename);
4546 magicname("0", "0", 1);
4549 if ((PL_envgv = gv_fetchpv("ENV",TRUE, SVt_PVHV))) {
4551 GvMULTI_on(PL_envgv);
4552 hv = GvHVn(PL_envgv);
4553 hv_magic(hv, Nullgv, PERL_MAGIC_env);
4555 #ifdef USE_ENVIRON_ARRAY
4556 /* Note that if the supplied env parameter is actually a copy
4557 of the global environ then it may now point to free'd memory
4558 if the environment has been modified since. To avoid this
4559 problem we treat env==NULL as meaning 'use the default'
4564 # ifdef USE_ITHREADS
4565 && PL_curinterp == aTHX
4569 environ[0] = Nullch;
4572 char** origenv = environ;
4575 for (; *env; env++) {
4576 if (!(s = strchr(*env,'=')) || s == *env)
4578 #if defined(MSDOS) && !defined(DJGPP)
4583 sv = newSVpv(s+1, 0);
4584 (void)hv_store(hv, *env, s - *env, sv, 0);
4587 if (origenv != environ) {
4588 /* realloc has shifted us */
4589 env = (env - origenv) + environ;
4594 #endif /* USE_ENVIRON_ARRAY */
4595 #endif /* !PERL_MICRO */
4598 if ((tmpgv = gv_fetchpv("$",TRUE, SVt_PV))) {
4599 SvREADONLY_off(GvSV(tmpgv));
4600 sv_setiv(GvSV(tmpgv), (IV)PerlProc_getpid());
4601 SvREADONLY_on(GvSV(tmpgv));
4603 #ifdef THREADS_HAVE_PIDS
4604 PL_ppid = (IV)getppid();
4607 /* touch @F array to prevent spurious warnings 20020415 MJD */
4609 (void) get_av("main::F", TRUE | GV_ADDMULTI);
4611 /* touch @- and @+ arrays to prevent spurious warnings 20020415 MJD */
4612 (void) get_av("main::-", TRUE | GV_ADDMULTI);
4613 (void) get_av("main::+", TRUE | GV_ADDMULTI);
4617 S_init_perllib(pTHX)
4622 s = PerlEnv_getenv("PERL5LIB");
4624 * It isn't possible to delete an environment variable with
4625 * PERL_USE_SAFE_PUTENV set unless unsetenv() is also available, so in that
4626 * case we treat PERL5LIB as undefined if it has a zero-length value.
4628 #if defined(PERL_USE_SAFE_PUTENV) && ! defined(HAS_UNSETENV)
4629 if (s && *s != '\0')
4633 incpush(s, TRUE, TRUE, TRUE, FALSE);
4635 incpush(PerlEnv_getenv("PERLLIB"), FALSE, FALSE, TRUE, FALSE);
4637 /* Treat PERL5?LIB as a possible search list logical name -- the
4638 * "natural" VMS idiom for a Unix path string. We allow each
4639 * element to be a set of |-separated directories for compatibility.
4643 if (my_trnlnm("PERL5LIB",buf,0))
4644 do { incpush(buf,TRUE,TRUE,TRUE,FALSE); } while (my_trnlnm("PERL5LIB",buf,++idx));
4646 while (my_trnlnm("PERLLIB",buf,idx++)) incpush(buf,FALSE,FALSE,TRUE,FALSE);
4650 /* Use the ~-expanded versions of APPLLIB (undocumented),
4651 ARCHLIB PRIVLIB SITEARCH SITELIB VENDORARCH and VENDORLIB
4654 incpush(APPLLIB_EXP, TRUE, TRUE, TRUE, TRUE);
4658 incpush(ARCHLIB_EXP, FALSE, FALSE, TRUE, TRUE);
4660 #ifdef MACOS_TRADITIONAL
4663 SV * privdir = NEWSV(55, 0);
4664 char * macperl = PerlEnv_getenv("MACPERL");
4669 Perl_sv_setpvf(aTHX_ privdir, "%slib:", macperl);
4670 if (PerlLIO_stat(SvPVX(privdir), &tmpstatbuf) >= 0 && S_ISDIR(tmpstatbuf.st_mode))
4671 incpush(SvPVX(privdir), TRUE, FALSE, TRUE, FALSE);
4672 Perl_sv_setpvf(aTHX_ privdir, "%ssite_perl:", macperl);
4673 if (PerlLIO_stat(SvPVX(privdir), &tmpstatbuf) >= 0 && S_ISDIR(tmpstatbuf.st_mode))
4674 incpush(SvPVX(privdir), TRUE, FALSE, TRUE, FALSE);
4676 SvREFCNT_dec(privdir);
4679 incpush(":", FALSE, FALSE, TRUE, FALSE);
4682 # define PRIVLIB_EXP "/usr/local/lib/perl5:/usr/local/lib/perl"
4685 incpush(PRIVLIB_EXP, TRUE, FALSE, TRUE, TRUE);
4687 incpush(PRIVLIB_EXP, FALSE, FALSE, TRUE, TRUE);
4691 /* sitearch is always relative to sitelib on Windows for
4692 * DLL-based path intuition to work correctly */
4693 # if !defined(WIN32)
4694 incpush(SITEARCH_EXP, FALSE, FALSE, TRUE, TRUE);
4700 /* this picks up sitearch as well */
4701 incpush(SITELIB_EXP, TRUE, FALSE, TRUE, TRUE);
4703 incpush(SITELIB_EXP, FALSE, FALSE, TRUE, TRUE);
4707 #ifdef SITELIB_STEM /* Search for version-specific dirs below here */
4708 incpush(SITELIB_STEM, FALSE, TRUE, TRUE, TRUE);
4711 #ifdef PERL_VENDORARCH_EXP
4712 /* vendorarch is always relative to vendorlib on Windows for
4713 * DLL-based path intuition to work correctly */
4714 # if !defined(WIN32)
4715 incpush(PERL_VENDORARCH_EXP, FALSE, FALSE, TRUE, TRUE);
4719 #ifdef PERL_VENDORLIB_EXP
4721 incpush(PERL_VENDORLIB_EXP, TRUE, FALSE, TRUE, TRUE); /* this picks up vendorarch as well */
4723 incpush(PERL_VENDORLIB_EXP, FALSE, FALSE, TRUE, TRUE);
4727 #ifdef PERL_VENDORLIB_STEM /* Search for version-specific dirs below here */
4728 incpush(PERL_VENDORLIB_STEM, FALSE, TRUE, TRUE, TRUE);
4731 #ifdef PERL_OTHERLIBDIRS
4732 incpush(PERL_OTHERLIBDIRS, TRUE, TRUE, TRUE, TRUE);
4736 incpush(".", FALSE, FALSE, TRUE, FALSE);
4737 #endif /* MACOS_TRADITIONAL */
4740 #if defined(DOSISH) || defined(EPOC) || defined(__SYMBIAN32__)
4741 # define PERLLIB_SEP ';'
4744 # define PERLLIB_SEP '|'
4746 # if defined(MACOS_TRADITIONAL)
4747 # define PERLLIB_SEP ','
4749 # define PERLLIB_SEP ':'
4753 #ifndef PERLLIB_MANGLE
4754 # define PERLLIB_MANGLE(s,n) (s)
4757 /* Push a directory onto @INC if it exists.
4758 Generate a new SV if we do this, to save needing to copy the SV we push
4761 S_incpush_if_exists(pTHX_ SV *dir)
4764 if (PerlLIO_stat(SvPVX_const(dir), &tmpstatbuf) >= 0 &&
4765 S_ISDIR(tmpstatbuf.st_mode)) {
4766 av_push(GvAVn(PL_incgv), dir);
4773 S_incpush(pTHX_ const char *dir, bool addsubdirs, bool addoldvers, bool usesep,
4776 SV *subdir = Nullsv;
4777 const char *p = dir;
4782 if (addsubdirs || addoldvers) {
4783 subdir = NEWSV(0,0);