3 * Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007 by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
12 * "A ship then new they built for him/of mithril and of elven glass" --Bilbo
15 /* This file contains the top-level functions that are used to create, use
16 * and destroy a perl interpreter, plus the functions used by XS code to
17 * call back into perl. Note that it does not contain the actual main()
18 * function of the interpreter; that can be found in perlmain.c
23 * Be proud that perl(1) may proclaim:
24 * Setuid Perl scripts are safer than C programs ...
25 * Do not abandon (deprecate) suidperl. Do not advocate C wrappers.
27 * The flow was: perl starts, notices script is suid, execs suidperl with same
28 * arguments; suidperl opens script, checks many things, sets itself with
29 * right UID, execs perl with similar arguments but with script pre-opened on
30 * /dev/fd/xxx; perl checks script is as should be and does work. This was
31 * insecure: see perlsec(1) for many problems with this approach.
33 * The "correct" flow should be: perl starts, opens script and notices it is
34 * suid, checks many things, execs suidperl with similar arguments but with
35 * script on /dev/fd/xxx; suidperl checks script and /dev/fd/xxx object are
36 * same, checks arguments match #! line, sets itself with right UID, execs
37 * perl with same arguments; perl checks many things and does work.
39 * (Opening the script in perl instead of suidperl, we "lose" scripts that
40 * are readable to the target UID but not to the invoker. Where did
41 * unreadable scripts work anyway?)
43 * For now, suidperl and perl are pretty much the same large and cumbersome
44 * program, so suidperl can check its argument list (see comments elsewhere).
47 * Original bug report:
48 * http://bugs.perl.org/index.html?req=bug_id&bug_id=20010322.218
49 * http://rt.perl.org/rt2/Ticket/Display.html?id=6511
50 * Comments and discussion with Debian:
51 * http://bugs.debian.org/203426
52 * http://bugs.debian.org/220486
53 * Debian Security Advisory DSA 431-1 (does not fully fix problem):
54 * http://www.debian.org/security/2004/dsa-431
56 * http://cve.mitre.org/cgi-bin/cvename.cgi?name=CAN-2003-0618
57 * Previous versions of this patch sent to perl5-porters:
58 * http://www.mail-archive.com/perl5-porters@perl.org/msg71953.html
59 * http://www.mail-archive.com/perl5-porters@perl.org/msg75245.html
60 * http://www.mail-archive.com/perl5-porters@perl.org/msg75563.html
61 * http://www.mail-archive.com/perl5-porters@perl.org/msg75635.html
63 Paul Szabo - psz@maths.usyd.edu.au http://www.maths.usyd.edu.au:8000/u/psz/
64 School of Mathematics and Statistics University of Sydney 2006 Australia
68 * Use truthful, neat, specific error messages.
69 * Cannot always hide the truth; security must not depend on doing so.
73 * Use global(?), thread-local fdscript for easier checks.
74 * (I do not understand how we could possibly get a thread race:
75 * do not all threads go through the same initialization? Or in
76 * fact, are not threads started only after we get the script and
77 * so know what to do? Oh well, make things super-safe...)
81 #define PERL_IN_PERL_C
83 #include "patchlevel.h" /* for local_patches */
87 char *nw_get_sitelib(const char *pl);
90 /* XXX If this causes problems, set i_unistd=undef in the hint file. */
95 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
97 # include <sys/wait.h>
100 # include <sys/uio.h>
105 char control[CMSG_SPACE(sizeof(int))];
122 #if !defined(STANDARD_C) && !defined(HAS_GETENV_PROTOTYPE) && !defined(PERL_MICRO)
123 char *getenv (char *); /* Usually in <stdlib.h> */
126 static I32 read_e_script(pTHX_ int idx, SV *buf_sv, int maxlen);
130 /* Drop scriptname */
131 # define validate_suid(validarg, scriptname, fdscript, suidscript, linestr_sv, rsfp) S_validate_suid(aTHX_ validarg, fdscript, suidscript, linestr_sv, rsfp)
133 /* Drop suidscript */
134 # define validate_suid(validarg, scriptname, fdscript, suidscript, linestr_sv, rsfp) S_validate_suid(aTHX_ validarg, scriptname, fdscript, linestr_sv, rsfp)
137 # ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
138 /* Drop everything. Heck, don't even try to call it */
139 # define validate_suid(validarg, scriptname, fdscript, suidscript, linestr_sv, rsfp) NOOP
141 /* Drop almost everything */
142 # define validate_suid(validarg, scriptname, fdscript, suidscript, linestr_sv, rsfp) S_validate_suid(aTHX_ rsfp)
146 #define CALL_BODY_EVAL(myop) \
147 if (PL_op == (myop)) \
148 PL_op = Perl_pp_entereval(aTHX); \
152 #define CALL_BODY_SUB(myop) \
153 if (PL_op == (myop)) \
154 PL_op = Perl_pp_entersub(aTHX); \
158 #define CALL_LIST_BODY(cv) \
159 PUSHMARK(PL_stack_sp); \
160 call_sv((SV*)(cv), G_EVAL|G_DISCARD);
163 S_init_tls_and_interp(PerlInterpreter *my_perl)
167 PERL_SET_INTERP(my_perl);
168 #if defined(USE_ITHREADS)
171 PERL_SET_THX(my_perl);
174 MUTEX_INIT(&PL_dollarzero_mutex);
176 #ifdef PERL_IMPLICIT_CONTEXT
177 MUTEX_INIT(&PL_my_ctx_mutex);
180 #if defined(USE_ITHREADS)
183 /* This always happens for non-ithreads */
186 PERL_SET_THX(my_perl);
191 /* these implement the PERL_SYS_INIT, PERL_SYS_INIT3, PERL_SYS_TERM macros */
194 Perl_sys_init(int* argc, char*** argv)
197 PERL_UNUSED_ARG(argc); /* may not be used depending on _BODY macro */
198 PERL_UNUSED_ARG(argv);
199 PERL_SYS_INIT_BODY(argc, argv);
203 Perl_sys_init3(int* argc, char*** argv, char*** env)
206 PERL_UNUSED_ARG(argc); /* may not be used depending on _BODY macro */
207 PERL_UNUSED_ARG(argv);
208 PERL_UNUSED_ARG(env);
209 PERL_SYS_INIT3_BODY(argc, argv, env);
216 if (!PL_veto_cleanup) {
217 PERL_SYS_TERM_BODY();
222 #ifdef PERL_IMPLICIT_SYS
224 perl_alloc_using(struct IPerlMem* ipM, struct IPerlMem* ipMS,
225 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
226 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
227 struct IPerlDir* ipD, struct IPerlSock* ipS,
228 struct IPerlProc* ipP)
230 PerlInterpreter *my_perl;
231 /* Newx() needs interpreter, so call malloc() instead */
232 my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
233 S_init_tls_and_interp(my_perl);
234 Zero(my_perl, 1, PerlInterpreter);
244 INIT_TRACK_MEMPOOL(PL_memory_debug_header, my_perl);
251 =head1 Embedding Functions
253 =for apidoc perl_alloc
255 Allocates a new Perl interpreter. See L<perlembed>.
263 PerlInterpreter *my_perl;
265 /* Newx() needs interpreter, so call malloc() instead */
266 my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
268 S_init_tls_and_interp(my_perl);
269 #ifndef PERL_TRACK_MEMPOOL
270 return (PerlInterpreter *) ZeroD(my_perl, 1, PerlInterpreter);
272 Zero(my_perl, 1, PerlInterpreter);
273 INIT_TRACK_MEMPOOL(PL_memory_debug_header, my_perl);
277 #endif /* PERL_IMPLICIT_SYS */
280 =for apidoc perl_construct
282 Initializes a new Perl interpreter. See L<perlembed>.
288 perl_construct(pTHXx)
291 PERL_UNUSED_ARG(my_perl);
294 PL_perl_destruct_level = 1;
296 if (PL_perl_destruct_level > 0)
299 PL_curcop = &PL_compiling; /* needed by ckWARN, right away */
301 /* set read-only and try to insure than we wont see REFCNT==0
304 SvREADONLY_on(&PL_sv_undef);
305 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
307 sv_setpv(&PL_sv_no,PL_No);
308 /* value lookup in void context - happens to have the side effect
309 of caching the numeric forms. However, as &PL_sv_no doesn't contain
310 a string that is a valid numer, we have to turn the public flags by
316 SvREADONLY_on(&PL_sv_no);
317 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
319 sv_setpv(&PL_sv_yes,PL_Yes);
322 SvREADONLY_on(&PL_sv_yes);
323 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
325 SvREADONLY_on(&PL_sv_placeholder);
326 SvREFCNT(&PL_sv_placeholder) = (~(U32)0)/2;
328 PL_sighandlerp = (Sighandler_t) Perl_sighandler;
329 #ifdef PERL_USES_PL_PIDSTATUS
330 PL_pidstatus = newHV();
333 PL_rs = newSVpvs("\n");
343 SET_NUMERIC_STANDARD();
345 #if defined(LOCAL_PATCH_COUNT)
346 PL_localpatches = local_patches; /* For possible -v */
349 #ifdef HAVE_INTERP_INTERN
353 PerlIO_init(aTHX); /* Hook to IO system */
355 PL_fdpid = newAV(); /* for remembering popen pids by fd */
356 PL_modglobal = newHV(); /* pointers to per-interpreter module globals */
357 PL_errors = newSVpvs("");
358 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
359 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
360 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
362 /* First entry is a list of empty elements. It needs to be initialised
363 else all hell breaks loose in S_find_uninit_var(). */
364 Perl_av_create_and_push(aTHX_ &PL_regex_padav, newSVpvs(""));
365 PL_regex_pad = AvARRAY(PL_regex_padav);
367 #ifdef USE_REENTRANT_API
368 Perl_reentrant_init(aTHX);
371 /* Note that strtab is a rather special HV. Assumptions are made
372 about not iterating on it, and not adding tie magic to it.
373 It is properly deallocated in perl_destruct() */
376 HvSHAREKEYS_off(PL_strtab); /* mandatory */
377 hv_ksplit(PL_strtab, 512);
379 #if defined(__DYNAMIC__) && (defined(NeXT) || defined(__NeXT__))
380 _dyld_lookup_and_bind
381 ("__environ", (unsigned long *) &environ_pointer, NULL);
385 # ifdef USE_ENVIRON_ARRAY
386 PL_origenviron = environ;
390 /* Use sysconf(_SC_CLK_TCK) if available, if not
391 * available or if the sysconf() fails, use the HZ.
392 * BeOS has those, but returns the wrong value.
393 * The HZ if not originally defined has been by now
394 * been defined as CLK_TCK, if available. */
395 #if defined(HAS_SYSCONF) && defined(_SC_CLK_TCK) && !defined(__BEOS__)
396 PL_clocktick = sysconf(_SC_CLK_TCK);
397 if (PL_clocktick <= 0)
401 PL_stashcache = newHV();
403 PL_patchlevel = Perl_newSVpvf(aTHX_ "v%d.%d.%d", (int)PERL_REVISION,
404 (int)PERL_VERSION, (int)PERL_SUBVERSION);
407 if (!PL_mmap_page_size) {
408 #if defined(HAS_SYSCONF) && (defined(_SC_PAGESIZE) || defined(_SC_MMAP_PAGE_SIZE))
410 SETERRNO(0, SS_NORMAL);
412 PL_mmap_page_size = sysconf(_SC_PAGESIZE);
414 PL_mmap_page_size = sysconf(_SC_MMAP_PAGE_SIZE);
416 if ((long) PL_mmap_page_size < 0) {
418 SV * const error = ERRSV;
419 SvUPGRADE(error, SVt_PV);
420 Perl_croak(aTHX_ "panic: sysconf: %s", SvPV_nolen_const(error));
423 Perl_croak(aTHX_ "panic: sysconf: pagesize unknown");
427 # ifdef HAS_GETPAGESIZE
428 PL_mmap_page_size = getpagesize();
430 # if defined(I_SYS_PARAM) && defined(PAGESIZE)
431 PL_mmap_page_size = PAGESIZE; /* compiletime, bad */
435 if (PL_mmap_page_size <= 0)
436 Perl_croak(aTHX_ "panic: bad pagesize %" IVdf,
437 (IV) PL_mmap_page_size);
439 #endif /* HAS_MMAP */
441 #if defined(HAS_TIMES) && defined(PERL_NEED_TIMESBASE)
442 PL_timesbase.tms_utime = 0;
443 PL_timesbase.tms_stime = 0;
444 PL_timesbase.tms_cutime = 0;
445 PL_timesbase.tms_cstime = 0;
452 =for apidoc nothreadhook
454 Stub that provides thread hook for perl_destruct when there are
461 Perl_nothreadhook(pTHX)
467 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
469 Perl_dump_sv_child(pTHX_ SV *sv)
472 const int sock = PL_dumper_fd;
473 const int debug_fd = PerlIO_fileno(Perl_debug_log);
474 union control_un control;
477 struct cmsghdr *cmptr;
479 unsigned char buffer[256];
481 if(sock == -1 || debug_fd == -1)
484 PerlIO_flush(Perl_debug_log);
486 /* All these shenanigans are to pass a file descriptor over to our child for
487 it to dump out to. We can't let it hold open the file descriptor when it
488 forks, as the file descriptor it will dump to can turn out to be one end
489 of pipe that some other process will wait on for EOF. (So as it would
490 be open, the wait would be forever.) */
492 msg.msg_control = control.control;
493 msg.msg_controllen = sizeof(control.control);
494 /* We're a connected socket so we don't need a destination */
500 cmptr = CMSG_FIRSTHDR(&msg);
501 cmptr->cmsg_len = CMSG_LEN(sizeof(int));
502 cmptr->cmsg_level = SOL_SOCKET;
503 cmptr->cmsg_type = SCM_RIGHTS;
504 *((int *)CMSG_DATA(cmptr)) = 1;
506 vec[0].iov_base = (void*)&sv;
507 vec[0].iov_len = sizeof(sv);
508 got = sendmsg(sock, &msg, 0);
511 perror("Debug leaking scalars parent sendmsg failed");
514 if(got < sizeof(sv)) {
515 perror("Debug leaking scalars parent short sendmsg");
519 /* Return protocol is
521 unsigned char: length of location string (0 for empty)
522 unsigned char*: string (not terminated)
524 vec[0].iov_base = (void*)&returned_errno;
525 vec[0].iov_len = sizeof(returned_errno);
526 vec[1].iov_base = buffer;
529 got = readv(sock, vec, 2);
532 perror("Debug leaking scalars parent read failed");
533 PerlIO_flush(PerlIO_stderr());
536 if(got < sizeof(returned_errno) + 1) {
537 perror("Debug leaking scalars parent short read");
538 PerlIO_flush(PerlIO_stderr());
543 got = read(sock, buffer + 1, *buffer);
545 perror("Debug leaking scalars parent read 2 failed");
546 PerlIO_flush(PerlIO_stderr());
551 perror("Debug leaking scalars parent short read 2");
552 PerlIO_flush(PerlIO_stderr());
557 if (returned_errno || *buffer) {
558 Perl_warn(aTHX_ "Debug leaking scalars child failed%s%.*s with errno"
559 " %d: %s", (*buffer ? " at " : ""), (int) *buffer, buffer + 1,
560 returned_errno, strerror(returned_errno));
566 =for apidoc perl_destruct
568 Shuts down a Perl interpreter. See L<perlembed>.
577 VOL signed char destruct_level; /* see possible values in intrpvar.h */
579 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
583 PERL_UNUSED_ARG(my_perl);
585 /* wait for all pseudo-forked children to finish */
586 PERL_WAIT_FOR_CHILDREN;
588 destruct_level = PL_perl_destruct_level;
591 const char * const s = PerlEnv_getenv("PERL_DESTRUCT_LEVEL");
593 const int i = atoi(s);
594 if (destruct_level < i)
600 if (PL_exit_flags & PERL_EXIT_DESTRUCT_END) {
606 if (PL_endav && !PL_minus_c)
607 call_list(PL_scopestack_ix, PL_endav);
613 /* Need to flush since END blocks can produce output */
616 if (CALL_FPTR(PL_threadhook)(aTHX)) {
617 /* Threads hook has vetoed further cleanup */
618 PL_veto_cleanup = TRUE;
622 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
623 if (destruct_level != 0) {
624 /* Fork here to create a child. Our child's job is to preserve the
625 state of scalars prior to destruction, so that we can instruct it
626 to dump any scalars that we later find have leaked.
627 There's no subtlety in this code - it assumes POSIX, and it doesn't
631 if(socketpair(AF_UNIX, SOCK_STREAM, 0, fd)) {
632 perror("Debug leaking scalars socketpair failed");
638 perror("Debug leaking scalars fork failed");
642 /* We are the child */
643 const int sock = fd[1];
644 const int debug_fd = PerlIO_fileno(Perl_debug_log);
647 /* Our success message is an integer 0, and a char 0 */
648 static const char success[sizeof(int) + 1];
652 /* We need to close all other file descriptors otherwise we end up
653 with interesting hangs, where the parent closes its end of a
654 pipe, and sits waiting for (another) child to terminate. Only
655 that child never terminates, because it never gets EOF, because
656 we also have the far end of the pipe open. We even need to
657 close the debugging fd, because sometimes it happens to be one
658 end of a pipe, and a process is waiting on the other end for
659 EOF. Normally it would be closed at some point earlier in
660 destruction, but if we happen to cause the pipe to remain open,
661 EOF never occurs, and we get an infinite hang. Hence all the
662 games to pass in a file descriptor if it's actually needed. */
664 f = sysconf(_SC_OPEN_MAX);
666 where = "sysconf failed";
677 union control_un control;
680 struct cmsghdr *cmptr;
684 msg.msg_control = control.control;
685 msg.msg_controllen = sizeof(control.control);
686 /* We're a connected socket so we don't need a source */
690 msg.msg_iovlen = sizeof(vec)/sizeof(vec[0]);
692 vec[0].iov_base = (void*)⌖
693 vec[0].iov_len = sizeof(target);
695 got = recvmsg(sock, &msg, 0);
700 where = "recv failed";
703 if(got < sizeof(target)) {
704 where = "short recv";
708 if(!(cmptr = CMSG_FIRSTHDR(&msg))) {
712 if(cmptr->cmsg_len != CMSG_LEN(sizeof(int))) {
713 where = "wrong cmsg_len";
716 if(cmptr->cmsg_level != SOL_SOCKET) {
717 where = "wrong cmsg_level";
720 if(cmptr->cmsg_type != SCM_RIGHTS) {
721 where = "wrong cmsg_type";
725 got_fd = *(int*)CMSG_DATA(cmptr);
726 /* For our last little bit of trickery, put the file descriptor
727 back into Perl_debug_log, as if we never actually closed it
729 if(got_fd != debug_fd) {
730 if (dup2(got_fd, debug_fd) == -1) {
737 PerlIO_flush(Perl_debug_log);
739 got = write(sock, &success, sizeof(success));
742 where = "write failed";
745 if(got < sizeof(success)) {
746 where = "short write";
753 int send_errno = errno;
754 unsigned char length = (unsigned char) strlen(where);
755 struct iovec failure[3] = {
756 {(void*)&send_errno, sizeof(send_errno)},
758 {(void*)where, length}
760 int got = writev(sock, failure, 3);
761 /* Bad news travels fast. Faster than data. We'll get a SIGPIPE
762 in the parent if we try to read from the socketpair after the
763 child has exited, even if there was data to read.
764 So sleep a bit to give the parent a fighting chance of
767 _exit((got == -1) ? errno : 0);
771 PL_dumper_fd = fd[0];
776 /* We must account for everything. */
778 /* Destroy the main CV and syntax tree */
779 /* Do this now, because destroying ops can cause new SVs to be generated
780 in Perl_pad_swipe, and when running with -DDEBUG_LEAKING_SCALARS they
781 PL_curcop to point to a valid op from which the filename structure
783 PL_curcop = &PL_compiling;
785 /* ensure comppad/curpad to refer to main's pad */
786 if (CvPADLIST(PL_main_cv)) {
787 PAD_SET_CUR_NOSAVE(CvPADLIST(PL_main_cv), 1);
789 op_free(PL_main_root);
792 PL_main_start = NULL;
793 SvREFCNT_dec(PL_main_cv);
797 /* Tell PerlIO we are about to tear things apart in case
798 we have layers which are using resources that should
802 PerlIO_destruct(aTHX);
804 if (PL_sv_objcount) {
806 * Try to destruct global references. We do this first so that the
807 * destructors and destructees still exist. Some sv's might remain.
808 * Non-referenced objects are on their own.
812 if (PL_defoutgv && !SvREFCNT(PL_defoutgv))
813 PL_defoutgv = NULL; /* may have been freed */
816 /* unhook hooks which will soon be, or use, destroyed data */
817 SvREFCNT_dec(PL_warnhook);
819 SvREFCNT_dec(PL_diehook);
822 /* call exit list functions */
823 while (PL_exitlistlen-- > 0)
824 PL_exitlist[PL_exitlistlen].fn(aTHX_ PL_exitlist[PL_exitlistlen].ptr);
826 Safefree(PL_exitlist);
831 /* jettison our possibly duplicated environment */
832 /* if PERL_USE_SAFE_PUTENV is defined environ will not have been copied
833 * so we certainly shouldn't free it here
836 #if defined(USE_ENVIRON_ARRAY) && !defined(PERL_USE_SAFE_PUTENV)
837 if (environ != PL_origenviron && !PL_use_safe_putenv
839 /* only main thread can free environ[0] contents */
840 && PL_curinterp == aTHX
846 for (i = 0; environ[i]; i++)
847 safesysfree(environ[i]);
849 /* Must use safesysfree() when working with environ. */
850 safesysfree(environ);
852 environ = PL_origenviron;
855 #endif /* !PERL_MICRO */
857 if (destruct_level == 0) {
859 DEBUG_P(debprofdump());
861 #if defined(PERLIO_LAYERS)
862 /* No more IO - including error messages ! */
863 PerlIO_cleanup(aTHX);
866 CopFILE_free(&PL_compiling);
867 CopSTASH_free(&PL_compiling);
869 /* The exit() function will do everything that needs doing. */
873 /* reset so print() ends up where we expect */
877 /* the syntax tree is shared between clones
878 * so op_free(PL_main_root) only ReREFCNT_dec's
879 * REGEXPs in the parent interpreter
880 * we need to manually ReREFCNT_dec for the clones
882 SvREFCNT_dec(PL_regex_padav);
883 PL_regex_padav = NULL;
887 SvREFCNT_dec((SV*) PL_stashcache);
888 PL_stashcache = NULL;
890 /* loosen bonds of global variables */
892 /* XXX can PL_parser still be non-null here? */
893 if(PL_parser && PL_parser->rsfp) {
894 (void)PerlIO_close(PL_parser->rsfp);
895 PL_parser->rsfp = NULL;
899 Safefree(PL_splitstr);
909 PL_doswitches = FALSE;
910 PL_dowarn = G_WARN_OFF;
911 PL_doextract = FALSE;
912 PL_sawampersand = FALSE; /* must save all match strings */
915 Safefree(PL_inplace);
917 SvREFCNT_dec(PL_patchlevel);
920 SvREFCNT_dec(PL_e_script);
926 /* magical thingies */
928 SvREFCNT_dec(PL_ofs_sv); /* $, */
931 SvREFCNT_dec(PL_ors_sv); /* $\ */
934 SvREFCNT_dec(PL_rs); /* $/ */
937 Safefree(PL_osname); /* $^O */
940 SvREFCNT_dec(PL_statname);
944 /* defgv, aka *_ should be taken care of elsewhere */
946 /* clean up after study() */
947 SvREFCNT_dec(PL_lastscream);
948 PL_lastscream = NULL;
949 Safefree(PL_screamfirst);
951 Safefree(PL_screamnext);
955 Safefree(PL_efloatbuf);
959 /* startup and shutdown function lists */
960 SvREFCNT_dec(PL_beginav);
961 SvREFCNT_dec(PL_beginav_save);
962 SvREFCNT_dec(PL_endav);
963 SvREFCNT_dec(PL_checkav);
964 SvREFCNT_dec(PL_checkav_save);
965 SvREFCNT_dec(PL_unitcheckav);
966 SvREFCNT_dec(PL_unitcheckav_save);
967 SvREFCNT_dec(PL_initav);
969 PL_beginav_save = NULL;
972 PL_checkav_save = NULL;
973 PL_unitcheckav = NULL;
974 PL_unitcheckav_save = NULL;
977 /* shortcuts just get cleared */
986 PL_last_in_gv = NULL;
998 SvREFCNT_dec(PL_argvout_stack);
999 PL_argvout_stack = NULL;
1001 SvREFCNT_dec(PL_modglobal);
1002 PL_modglobal = NULL;
1003 SvREFCNT_dec(PL_preambleav);
1004 PL_preambleav = NULL;
1005 SvREFCNT_dec(PL_subname);
1007 #ifdef PERL_USES_PL_PIDSTATUS
1008 SvREFCNT_dec(PL_pidstatus);
1009 PL_pidstatus = NULL;
1011 SvREFCNT_dec(PL_toptarget);
1012 PL_toptarget = NULL;
1013 SvREFCNT_dec(PL_bodytarget);
1014 PL_bodytarget = NULL;
1015 PL_formtarget = NULL;
1017 /* free locale stuff */
1018 #ifdef USE_LOCALE_COLLATE
1019 Safefree(PL_collation_name);
1020 PL_collation_name = NULL;
1023 #ifdef USE_LOCALE_NUMERIC
1024 Safefree(PL_numeric_name);
1025 PL_numeric_name = NULL;
1026 SvREFCNT_dec(PL_numeric_radix_sv);
1027 PL_numeric_radix_sv = NULL;
1030 /* clear utf8 character classes */
1031 SvREFCNT_dec(PL_utf8_alnum);
1032 SvREFCNT_dec(PL_utf8_alnumc);
1033 SvREFCNT_dec(PL_utf8_ascii);
1034 SvREFCNT_dec(PL_utf8_alpha);
1035 SvREFCNT_dec(PL_utf8_space);
1036 SvREFCNT_dec(PL_utf8_cntrl);
1037 SvREFCNT_dec(PL_utf8_graph);
1038 SvREFCNT_dec(PL_utf8_digit);
1039 SvREFCNT_dec(PL_utf8_upper);
1040 SvREFCNT_dec(PL_utf8_lower);
1041 SvREFCNT_dec(PL_utf8_print);
1042 SvREFCNT_dec(PL_utf8_punct);
1043 SvREFCNT_dec(PL_utf8_xdigit);
1044 SvREFCNT_dec(PL_utf8_mark);
1045 SvREFCNT_dec(PL_utf8_toupper);
1046 SvREFCNT_dec(PL_utf8_totitle);
1047 SvREFCNT_dec(PL_utf8_tolower);
1048 SvREFCNT_dec(PL_utf8_tofold);
1049 SvREFCNT_dec(PL_utf8_idstart);
1050 SvREFCNT_dec(PL_utf8_idcont);
1051 PL_utf8_alnum = NULL;
1052 PL_utf8_alnumc = NULL;
1053 PL_utf8_ascii = NULL;
1054 PL_utf8_alpha = NULL;
1055 PL_utf8_space = NULL;
1056 PL_utf8_cntrl = NULL;
1057 PL_utf8_graph = NULL;
1058 PL_utf8_digit = NULL;
1059 PL_utf8_upper = NULL;
1060 PL_utf8_lower = NULL;
1061 PL_utf8_print = NULL;
1062 PL_utf8_punct = NULL;
1063 PL_utf8_xdigit = NULL;
1064 PL_utf8_mark = NULL;
1065 PL_utf8_toupper = NULL;
1066 PL_utf8_totitle = NULL;
1067 PL_utf8_tolower = NULL;
1068 PL_utf8_tofold = NULL;
1069 PL_utf8_idstart = NULL;
1070 PL_utf8_idcont = NULL;
1072 if (!specialWARN(PL_compiling.cop_warnings))
1073 PerlMemShared_free(PL_compiling.cop_warnings);
1074 PL_compiling.cop_warnings = NULL;
1075 Perl_refcounted_he_free(aTHX_ PL_compiling.cop_hints_hash);
1076 PL_compiling.cop_hints_hash = NULL;
1077 CopFILE_free(&PL_compiling);
1078 CopSTASH_free(&PL_compiling);
1080 /* Prepare to destruct main symbol table. */
1085 SvREFCNT_dec(PL_curstname);
1086 PL_curstname = NULL;
1088 /* clear queued errors */
1089 SvREFCNT_dec(PL_errors);
1092 SvREFCNT_dec(PL_isarev);
1095 if (destruct_level >= 2 && ckWARN_d(WARN_INTERNAL)) {
1096 if (PL_scopestack_ix != 0)
1097 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
1098 "Unbalanced scopes: %ld more ENTERs than LEAVEs\n",
1099 (long)PL_scopestack_ix);
1100 if (PL_savestack_ix != 0)
1101 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
1102 "Unbalanced saves: %ld more saves than restores\n",
1103 (long)PL_savestack_ix);
1104 if (PL_tmps_floor != -1)
1105 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced tmps: %ld more allocs than frees\n",
1106 (long)PL_tmps_floor + 1);
1107 if (cxstack_ix != -1)
1108 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced context: %ld more PUSHes than POPs\n",
1109 (long)cxstack_ix + 1);
1112 /* Now absolutely destruct everything, somehow or other, loops or no. */
1113 SvFLAGS(PL_fdpid) |= SVTYPEMASK; /* don't clean out pid table now */
1114 SvFLAGS(PL_strtab) |= SVTYPEMASK; /* don't clean out strtab now */
1116 /* the 2 is for PL_fdpid and PL_strtab */
1117 while (PL_sv_count > 2 && sv_clean_all())
1120 SvFLAGS(PL_fdpid) &= ~SVTYPEMASK;
1121 SvFLAGS(PL_fdpid) |= SVt_PVAV;
1122 SvFLAGS(PL_strtab) &= ~SVTYPEMASK;
1123 SvFLAGS(PL_strtab) |= SVt_PVHV;
1125 AvREAL_off(PL_fdpid); /* no surviving entries */
1126 SvREFCNT_dec(PL_fdpid); /* needed in io_close() */
1129 #ifdef HAVE_INTERP_INTERN
1133 /* Destruct the global string table. */
1135 /* Yell and reset the HeVAL() slots that are still holding refcounts,
1136 * so that sv_free() won't fail on them.
1137 * Now that the global string table is using a single hunk of memory
1138 * for both HE and HEK, we either need to explicitly unshare it the
1139 * correct way, or actually free things here.
1142 const I32 max = HvMAX(PL_strtab);
1143 HE * const * const array = HvARRAY(PL_strtab);
1144 HE *hent = array[0];
1147 if (hent && ckWARN_d(WARN_INTERNAL)) {
1148 HE * const next = HeNEXT(hent);
1149 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
1150 "Unbalanced string table refcount: (%ld) for \"%s\"",
1151 (long)hent->he_valu.hent_refcount, HeKEY(hent));
1158 hent = array[riter];
1163 HvARRAY(PL_strtab) = 0;
1164 HvTOTALKEYS(PL_strtab) = 0;
1165 HvFILL(PL_strtab) = 0;
1167 SvREFCNT_dec(PL_strtab);
1170 /* free the pointer tables used for cloning */
1171 ptr_table_free(PL_ptr_table);
1172 PL_ptr_table = (PTR_TBL_t*)NULL;
1175 /* free special SVs */
1177 SvREFCNT(&PL_sv_yes) = 0;
1178 sv_clear(&PL_sv_yes);
1179 SvANY(&PL_sv_yes) = NULL;
1180 SvFLAGS(&PL_sv_yes) = 0;
1182 SvREFCNT(&PL_sv_no) = 0;
1183 sv_clear(&PL_sv_no);
1184 SvANY(&PL_sv_no) = NULL;
1185 SvFLAGS(&PL_sv_no) = 0;
1189 for (i=0; i<=2; i++) {
1190 SvREFCNT(PERL_DEBUG_PAD(i)) = 0;
1191 sv_clear(PERL_DEBUG_PAD(i));
1192 SvANY(PERL_DEBUG_PAD(i)) = NULL;
1193 SvFLAGS(PERL_DEBUG_PAD(i)) = 0;
1197 if (PL_sv_count != 0 && ckWARN_d(WARN_INTERNAL))
1198 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Scalars leaked: %ld\n", (long)PL_sv_count);
1200 #ifdef DEBUG_LEAKING_SCALARS
1201 if (PL_sv_count != 0) {
1206 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
1207 svend = &sva[SvREFCNT(sva)];
1208 for (sv = sva + 1; sv < svend; ++sv) {
1209 if (SvTYPE(sv) != SVTYPEMASK) {
1210 PerlIO_printf(Perl_debug_log, "leaked: sv=0x%p"
1212 " refcnt=%"UVuf pTHX__FORMAT "\n"
1213 "\tallocated at %s:%d %s %s%s\n",
1214 (void*)sv, (UV)sv->sv_flags, (UV)sv->sv_refcnt
1216 sv->sv_debug_file ? sv->sv_debug_file : "(unknown)",
1218 sv->sv_debug_inpad ? "for" : "by",
1219 sv->sv_debug_optype ?
1220 PL_op_name[sv->sv_debug_optype]: "(none)",
1221 sv->sv_debug_cloned ? " (cloned)" : ""
1223 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1224 Perl_dump_sv_child(aTHX_ sv);
1230 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1234 /* Wait for up to 4 seconds for child to terminate.
1235 This seems to be the least effort way of timing out on reaping
1237 struct timeval waitfor = {4, 0};
1238 int sock = PL_dumper_fd;
1242 FD_SET(sock, &rset);
1243 select(sock + 1, &rset, NULL, NULL, &waitfor);
1244 waitpid(child, &status, WNOHANG);
1249 #ifdef DEBUG_LEAKING_SCALARS_ABORT
1255 #ifdef PERL_DEBUG_READONLY_OPS
1261 #if defined(PERLIO_LAYERS)
1262 /* No more IO - including error messages ! */
1263 PerlIO_cleanup(aTHX);
1266 /* sv_undef needs to stay immortal until after PerlIO_cleanup
1267 as currently layers use it rather than NULL as a marker
1268 for no arg - and will try and SvREFCNT_dec it.
1270 SvREFCNT(&PL_sv_undef) = 0;
1271 SvREADONLY_off(&PL_sv_undef);
1273 Safefree(PL_origfilename);
1274 PL_origfilename = NULL;
1275 Safefree(PL_reg_start_tmp);
1276 PL_reg_start_tmp = (char**)NULL;
1277 PL_reg_start_tmpl = 0;
1278 Safefree(PL_reg_curpm);
1279 Safefree(PL_reg_poscache);
1280 free_tied_hv_pool();
1281 Safefree(PL_op_mask);
1282 Safefree(PL_psig_ptr);
1283 PL_psig_ptr = (SV**)NULL;
1284 Safefree(PL_psig_name);
1285 PL_psig_name = (SV**)NULL;
1286 Safefree(PL_bitcount);
1288 Safefree(PL_psig_pend);
1289 PL_psig_pend = (int*)NULL;
1292 PL_tainting = FALSE;
1293 PL_taint_warn = FALSE;
1294 PL_hints = 0; /* Reset hints. Should hints be per-interpreter ? */
1297 DEBUG_P(debprofdump());
1299 #ifdef USE_REENTRANT_API
1300 Perl_reentrant_free(aTHX);
1305 while (PL_regmatch_slab) {
1306 regmatch_slab *s = PL_regmatch_slab;
1307 PL_regmatch_slab = PL_regmatch_slab->next;
1311 /* As the absolutely last thing, free the non-arena SV for mess() */
1314 /* we know that type == SVt_PVMG */
1316 /* it could have accumulated taint magic */
1319 for (mg = SvMAGIC(PL_mess_sv); mg; mg = moremagic) {
1320 moremagic = mg->mg_moremagic;
1321 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global
1323 Safefree(mg->mg_ptr);
1327 /* we know that type >= SVt_PV */
1328 SvPV_free(PL_mess_sv);
1329 Safefree(SvANY(PL_mess_sv));
1330 Safefree(PL_mess_sv);
1337 =for apidoc perl_free
1339 Releases a Perl interpreter. See L<perlembed>.
1349 if (PL_veto_cleanup)
1352 #ifdef PERL_TRACK_MEMPOOL
1355 * Don't free thread memory if PERL_DESTRUCT_LEVEL is set to a non-zero
1356 * value as we're probably hunting memory leaks then
1358 const char * const s = PerlEnv_getenv("PERL_DESTRUCT_LEVEL");
1359 if (!s || atoi(s) == 0) {
1360 /* Emulate the PerlHost behaviour of free()ing all memory allocated in this
1361 thread at thread exit. */
1362 while(aTHXx->Imemory_debug_header.next != &(aTHXx->Imemory_debug_header))
1363 safesysfree(sTHX + (char *)(aTHXx->Imemory_debug_header.next));
1368 #if defined(WIN32) || defined(NETWARE)
1369 # if defined(PERL_IMPLICIT_SYS)
1372 void *host = nw_internal_host;
1374 void *host = w32_internal_host;
1376 PerlMem_free(aTHXx);
1378 nw_delete_internal_host(host);
1380 win32_delete_internal_host(host);
1384 PerlMem_free(aTHXx);
1387 PerlMem_free(aTHXx);
1391 #if defined(USE_ITHREADS)
1392 /* provide destructors to clean up the thread key when libperl is unloaded */
1393 #ifndef WIN32 /* handled during DLL_PROCESS_DETACH in win32/perllib.c */
1395 #if defined(__hpux) && !(defined(__ux_version) && __ux_version <= 1020) && !defined(__GNUC__)
1396 #pragma fini "perl_fini"
1397 #elif defined(__sun) && !defined(__GNUC__)
1398 #pragma fini (perl_fini)
1402 #if defined(__GNUC__)
1403 __attribute__((destructor))
1408 if (PL_curinterp && !PL_veto_cleanup)
1413 #endif /* THREADS */
1416 Perl_call_atexit(pTHX_ ATEXIT_t fn, void *ptr)
1419 Renew(PL_exitlist, PL_exitlistlen+1, PerlExitListEntry);
1420 PL_exitlist[PL_exitlistlen].fn = fn;
1421 PL_exitlist[PL_exitlistlen].ptr = ptr;
1425 #ifdef HAS_PROCSELFEXE
1426 /* This is a function so that we don't hold on to MAXPATHLEN
1427 bytes of stack longer than necessary
1430 S_procself_val(pTHX_ SV *sv, const char *arg0)
1432 char buf[MAXPATHLEN];
1433 int len = readlink(PROCSELFEXE_PATH, buf, sizeof(buf) - 1);
1435 /* On Playstation2 Linux V1.0 (kernel 2.2.1) readlink(/proc/self/exe)
1436 includes a spurious NUL which will cause $^X to fail in system
1437 or backticks (this will prevent extensions from being built and
1438 many tests from working). readlink is not meant to add a NUL.
1439 Normal readlink works fine.
1441 if (len > 0 && buf[len-1] == '\0') {
1445 /* FreeBSD's implementation is acknowledged to be imperfect, sometimes
1446 returning the text "unknown" from the readlink rather than the path
1447 to the executable (or returning an error from the readlink). Any valid
1448 path has a '/' in it somewhere, so use that to validate the result.
1449 See http://www.freebsd.org/cgi/query-pr.cgi?pr=35703
1451 if (len > 0 && memchr(buf, '/', len)) {
1452 sv_setpvn(sv,buf,len);
1458 #endif /* HAS_PROCSELFEXE */
1461 S_set_caret_X(pTHX) {
1463 GV* tmpgv = gv_fetchpvs("\030", GV_ADD|GV_NOTQUAL, SVt_PV); /* $^X */
1465 #ifdef HAS_PROCSELFEXE
1466 S_procself_val(aTHX_ GvSV(tmpgv), PL_origargv[0]);
1469 sv_setpv(GvSVn(tmpgv), os2_execname(aTHX));
1471 sv_setpv(GvSVn(tmpgv),PL_origargv[0]);
1478 =for apidoc perl_parse
1480 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
1486 perl_parse(pTHXx_ XSINIT_t xsinit, int argc, char **argv, char **env)
1493 PERL_UNUSED_ARG(my_perl);
1495 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW_AND_IAMSUID
1496 Perl_croak(aTHX_ "suidperl is no longer needed since the kernel can now "
1497 "execute\nsetuid perl scripts securely.\n");
1500 #if defined(USE_HASH_SEED) || defined(USE_HASH_SEED_EXPLICIT)
1501 /* [perl #22371] Algorimic Complexity Attack on Perl 5.6.1, 5.8.0
1502 * This MUST be done before any hash stores or fetches take place.
1503 * If you set PL_rehash_seed (and assumedly also PL_rehash_seed_set)
1504 * yourself, it is your responsibility to provide a good random seed!
1505 * You can also define PERL_HASH_SEED in compile time, see hv.h. */
1506 if (!PL_rehash_seed_set)
1507 PL_rehash_seed = get_hash_seed();
1509 const char * const s = PerlEnv_getenv("PERL_HASH_SEED_DEBUG");
1511 if (s && (atoi(s) == 1))
1512 PerlIO_printf(Perl_debug_log, "HASH_SEED = %"UVuf"\n", PL_rehash_seed);
1514 #endif /* #if defined(USE_HASH_SEED) || defined(USE_HASH_SEED_EXPLICIT) */
1519 if (PL_origalen != 0) {
1520 PL_origalen = 1; /* don't use old PL_origalen if perl_parse() is called again */
1523 /* Set PL_origalen be the sum of the contiguous argv[]
1524 * elements plus the size of the env in case that it is
1525 * contiguous with the argv[]. This is used in mg.c:Perl_magic_set()
1526 * as the maximum modifiable length of $0. In the worst case
1527 * the area we are able to modify is limited to the size of
1528 * the original argv[0]. (See below for 'contiguous', though.)
1530 const char *s = NULL;
1533 ~(UV)(PTRSIZE == 4 ? 3 : PTRSIZE == 8 ? 7 : PTRSIZE == 16 ? 15 : 0);
1534 /* Do the mask check only if the args seem like aligned. */
1536 (mask < ~(UV)0) && ((PTR2UV(argv[0]) & mask) == PTR2UV(argv[0]));
1538 /* See if all the arguments are contiguous in memory. Note
1539 * that 'contiguous' is a loose term because some platforms
1540 * align the argv[] and the envp[]. If the arguments look
1541 * like non-aligned, assume that they are 'strictly' or
1542 * 'traditionally' contiguous. If the arguments look like
1543 * aligned, we just check that they are within aligned
1544 * PTRSIZE bytes. As long as no system has something bizarre
1545 * like the argv[] interleaved with some other data, we are
1546 * fine. (Did I just evoke Murphy's Law?) --jhi */
1547 if (PL_origargv && PL_origargc >= 1 && (s = PL_origargv[0])) {
1549 for (i = 1; i < PL_origargc; i++) {
1550 if ((PL_origargv[i] == s + 1
1552 || PL_origargv[i] == s + 2
1557 (PL_origargv[i] > s &&
1559 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1570 #ifndef PERL_USE_SAFE_PUTENV
1571 /* Can we grab env area too to be used as the area for $0? */
1572 if (s && PL_origenviron && !PL_use_safe_putenv) {
1573 if ((PL_origenviron[0] == s + 1)
1576 (PL_origenviron[0] > s &&
1577 PL_origenviron[0] <=
1578 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1581 #ifndef OS2 /* ENVIRON is read by the kernel too. */
1582 s = PL_origenviron[0];
1585 my_setenv("NoNe SuCh", NULL);
1586 /* Force copy of environment. */
1587 for (i = 1; PL_origenviron[i]; i++) {
1588 if (PL_origenviron[i] == s + 1
1591 (PL_origenviron[i] > s &&
1592 PL_origenviron[i] <=
1593 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1596 s = PL_origenviron[i];
1604 #endif /* !defined(PERL_USE_SAFE_PUTENV) */
1606 PL_origalen = s ? s - PL_origargv[0] + 1 : 0;
1611 /* Come here if running an undumped a.out. */
1613 PL_origfilename = savepv(argv[0]);
1614 PL_do_undump = FALSE;
1615 cxstack_ix = -1; /* start label stack again */
1617 assert (!PL_tainted);
1619 S_set_caret_X(aTHX);
1621 init_postdump_symbols(argc,argv,env);
1626 op_free(PL_main_root);
1627 PL_main_root = NULL;
1629 PL_main_start = NULL;
1630 SvREFCNT_dec(PL_main_cv);
1634 oldscope = PL_scopestack_ix;
1635 PL_dowarn = G_WARN_OFF;
1640 parse_body(env,xsinit);
1642 call_list(oldscope, PL_unitcheckav);
1644 call_list(oldscope, PL_checkav);
1651 /* my_exit() was called */
1652 while (PL_scopestack_ix > oldscope)
1655 PL_curstash = PL_defstash;
1657 call_list(oldscope, PL_unitcheckav);
1659 call_list(oldscope, PL_checkav);
1663 PerlIO_printf(Perl_error_log, "panic: top_env\n");
1672 S_parse_body(pTHX_ char **env, XSINIT_t xsinit)
1676 int argc = PL_origargc;
1677 char **argv = PL_origargv;
1678 const char *scriptname = NULL;
1679 VOL bool dosearch = FALSE;
1681 const char *validarg = "";
1685 const char *cddir = NULL;
1686 #ifdef USE_SITECUSTOMIZE
1687 bool minus_f = FALSE;
1689 SV *linestr_sv = newSV_type(SVt_PVIV);
1690 bool add_read_e_script = FALSE;
1692 SvGROW(linestr_sv, 80);
1693 sv_setpvn(linestr_sv,"",0);
1695 sv = newSVpvs(""); /* first used for -I flags */
1701 for (argc--,argv++; argc > 0; argc--,argv++) {
1702 if (argv[0][0] != '-' || !argv[0][1])
1706 validarg = " PHOOEY ";
1710 * Can we rely on the kernel to start scripts with argv[1] set to
1711 * contain all #! line switches (the whole line)? (argv[0] is set to
1712 * the interpreter name, argv[2] to the script name; argv[3] and
1713 * above may contain other arguments.)
1720 #ifndef PERL_STRICT_CR
1744 if ((s = moreswitches(s)))
1749 CHECK_MALLOC_TOO_LATE_FOR('t');
1750 if( !PL_tainting ) {
1751 PL_taint_warn = TRUE;
1757 CHECK_MALLOC_TOO_LATE_FOR('T');
1759 PL_taint_warn = FALSE;
1767 #ifdef MACOS_TRADITIONAL
1768 /* ignore -e for Dev:Pseudo argument */
1769 if (argv[1] && !strcmp(argv[1], "Dev:Pseudo"))
1772 forbid_setid('e', FALSE);
1774 PL_e_script = newSVpvs("");
1775 add_read_e_script = TRUE;
1778 sv_catpv(PL_e_script, s);
1780 sv_catpv(PL_e_script, argv[1]);
1784 Perl_croak(aTHX_ "No code specified for -%c", c);
1785 sv_catpvs(PL_e_script, "\n");
1789 #ifdef USE_SITECUSTOMIZE
1795 case 'I': /* -I handled both here and in moreswitches() */
1796 forbid_setid('I', FALSE);
1797 if (!*++s && (s=argv[1]) != NULL) {
1801 STRLEN len = strlen(s);
1802 const char * const p = savepvn(s, len);
1803 incpush(p, TRUE, TRUE, FALSE, FALSE);
1804 sv_catpvs(sv, "-I");
1805 sv_catpvn(sv, p, len);
1810 Perl_croak(aTHX_ "No directory specified for -I");
1813 forbid_setid('S', FALSE);
1821 Perl_av_create_and_push(aTHX_ &PL_preambleav, newSVpvs("use Config;"));
1823 /* Can't do newSVpvs() as that would involve pre-processor
1824 condititionals inside a macro expansion. */
1825 opts_prog = Perl_newSVpv(aTHX_ "$_ = join ' ', sort qw("
1832 # ifdef PERL_DONT_CREATE_GVSV
1833 " PERL_DONT_CREATE_GVSV"
1835 # ifdef PERL_MALLOC_WRAP
1838 # ifdef PERL_MEM_LOG
1841 # ifdef PERL_MEM_LOG_ENV
1844 # ifdef PERL_MEM_LOG_ENV_FD
1845 " PERL_MEM_LOG_ENV_FD"
1847 # ifdef PERL_MEM_LOG_STDERR
1848 " PERL_MEM_LOG_STDERR"
1850 # ifdef PERL_MEM_LOG_TIMESTAMP
1851 " PERL_MEM_LOG_TIMESTAMP"
1853 # ifdef PERL_USE_SAFE_PUTENV
1854 " PERL_USE_SAFE_PUTENV"
1856 # ifdef USE_SITECUSTOMIZE
1857 " USE_SITECUSTOMIZE"
1861 sv_catpv(opts_prog, PL_bincompat_options);
1862 /* Terminate the qw(, and then wrap at 76 columns. */
1863 sv_catpvs(opts_prog, "); s/(?=.{53})(.{1,53}) /$1\\n /mg;print Config::myconfig(),");
1865 sv_catpvs(opts_prog,"\"\\nCharacteristics of this PERLSHR image: \\n");
1867 sv_catpvs(opts_prog,"\"\\nCharacteristics of this binary (from libperl): \\n");
1870 sv_catpvs(opts_prog," Compile-time options: $_\\n\",");
1872 #if defined(LOCAL_PATCH_COUNT)
1873 if (LOCAL_PATCH_COUNT > 0) {
1875 sv_catpvs(opts_prog,
1876 "\" Locally applied patches:\\n\",");
1877 for (i = 1; i <= LOCAL_PATCH_COUNT; i++) {
1878 if (PL_localpatches[i])
1879 Perl_sv_catpvf(aTHX_ opts_prog,"q%c\t%s\n%c,",
1880 0, PL_localpatches[i], 0);
1884 Perl_sv_catpvf(aTHX_ opts_prog,
1885 "\" Built under %s\\n",OSNAME);
1888 sv_catpvs(opts_prog,
1889 " Compiled at " __DATE__ " " __TIME__ "\\n\"");
1891 sv_catpvs(opts_prog, " Compiled on " __DATE__ "\\n\"");
1894 sv_catpvs(opts_prog, "; $\"=\"\\n \"; "
1895 "@env = map { \"$_=\\\"$ENV{$_}\\\"\" } "
1896 "sort grep {/^PERL/} keys %ENV; ");
1898 sv_catpvs(opts_prog,
1899 "push @env, \"CYGWIN=\\\"$ENV{CYGWIN}\\\"\";");
1901 sv_catpvs(opts_prog,
1902 "print \" \\%ENV:\\n @env\\n\" if @env;"
1903 "print \" \\@INC:\\n @INC\\n\";");
1907 opts_prog = Perl_newSVpvf(aTHX_
1908 "Config::config_vars(qw%c%s%c)",
1912 av_push(PL_preambleav, opts_prog);
1913 /* don't look for script or read stdin */
1914 scriptname = BIT_BUCKET;
1918 PL_doextract = TRUE;
1926 if (!*++s || isSPACE(*s)) {
1930 /* catch use of gnu style long options */
1931 if (strEQ(s, "version")) {
1935 if (strEQ(s, "help")) {
1942 Perl_croak(aTHX_ "Unrecognized switch: -%s (-h will show valid options)",s);
1953 #ifndef SECURE_INTERNAL_GETENV
1956 (s = PerlEnv_getenv("PERL5OPT")))
1958 const char *popt = s;
1961 if (*s == '-' && *(s+1) == 'T') {
1962 CHECK_MALLOC_TOO_LATE_FOR('T');
1964 PL_taint_warn = FALSE;
1967 char *popt_copy = NULL;
1980 if (!strchr("CDIMUdmtw", *s))
1981 Perl_croak(aTHX_ "Illegal switch in PERL5OPT: -%c", *s);
1985 popt_copy = SvPVX(sv_2mortal(newSVpv(popt,0)));
1986 s = popt_copy + (s - popt);
1987 d = popt_copy + (d - popt);
1994 if( !PL_tainting ) {
1995 PL_taint_warn = TRUE;
2006 #ifdef USE_SITECUSTOMIZE
2008 (void)Perl_av_create_and_unshift_one(aTHX_ &PL_preambleav,
2009 Perl_newSVpvf(aTHX_ "BEGIN { do '%s/sitecustomize.pl' }", SITELIB_EXP));
2014 scriptname = argv[0];
2017 scriptname = BIT_BUCKET; /* don't look for script or read stdin */
2019 else if (scriptname == NULL) {
2021 if ( PerlLIO_isatty(PerlIO_fileno(PerlIO_stdin())) )
2027 /* Set $^X early so that it can be used for relocatable paths in @INC */
2028 assert (!PL_tainted);
2030 S_set_caret_X(aTHX);
2035 bool suidscript = FALSE;
2038 const int fdscript =
2040 open_script(scriptname, dosearch, &suidscript, &rsfp);
2042 validate_suid(validarg, scriptname, fdscript, suidscript,
2046 # if defined(SIGCHLD) || defined(SIGCLD)
2049 # define SIGCHLD SIGCLD
2051 Sighandler_t sigstate = rsignal_state(SIGCHLD);
2052 if (sigstate == (Sighandler_t) SIG_IGN) {
2053 if (ckWARN(WARN_SIGNAL))
2054 Perl_warner(aTHX_ packWARN(WARN_SIGNAL),
2055 "Can't ignore signal CHLD, forcing to default");
2056 (void)rsignal(SIGCHLD, (Sighandler_t)SIG_DFL);
2063 #ifdef MACOS_TRADITIONAL
2064 || gMacPerl_AlwaysExtract
2068 /* This will croak if suidscript is true, as -x cannot be used with
2070 forbid_setid('x', suidscript);
2071 /* Hence you can't get here if suidscript is true */
2073 find_beginning(linestr_sv, rsfp);
2074 if (cddir && PerlDir_chdir( (char *)cddir ) < 0)
2075 Perl_croak(aTHX_ "Can't chdir to %s",cddir);
2079 PL_main_cv = PL_compcv = (CV*)newSV_type(SVt_PVCV);
2080 CvUNIQUE_on(PL_compcv);
2082 CvPADLIST(PL_compcv) = pad_new(0);
2084 PL_isarev = newHV();
2087 boot_core_UNIVERSAL();
2088 boot_core_xsutils();
2092 (*xsinit)(aTHX); /* in case linked C routines want magical variables */
2094 #if defined(VMS) || defined(WIN32) || defined(DJGPP) || defined(__CYGWIN__) || defined(EPOC) || defined(SYMBIAN)
2100 # ifdef HAS_SOCKS5_INIT
2101 socks5_init(argv[0]);
2107 init_predump_symbols();
2108 /* init_postdump_symbols not currently designed to be called */
2109 /* more than once (ENV isn't cleared first, for example) */
2110 /* But running with -u leaves %ENV & @ARGV undefined! XXX */
2112 init_postdump_symbols(argc,argv,env);
2114 /* PL_unicode is turned on by -C, or by $ENV{PERL_UNICODE},
2115 * or explicitly in some platforms.
2116 * locale.c:Perl_init_i18nl10n() if the environment
2117 * look like the user wants to use UTF-8. */
2118 #if defined(__SYMBIAN32__)
2119 PL_unicode = PERL_UNICODE_STD_FLAG; /* See PERL_SYMBIAN_CONSOLE_UTF8. */
2122 /* Requires init_predump_symbols(). */
2123 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
2128 /* Turn on UTF-8-ness on STDIN, STDOUT, STDERR
2129 * and the default open disciplines. */
2130 if ((PL_unicode & PERL_UNICODE_STDIN_FLAG) &&
2131 PL_stdingv && (io = GvIO(PL_stdingv)) &&
2133 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2134 if ((PL_unicode & PERL_UNICODE_STDOUT_FLAG) &&
2135 PL_defoutgv && (io = GvIO(PL_defoutgv)) &&
2137 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2138 if ((PL_unicode & PERL_UNICODE_STDERR_FLAG) &&
2139 PL_stderrgv && (io = GvIO(PL_stderrgv)) &&
2141 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2142 if ((PL_unicode & PERL_UNICODE_INOUT_FLAG) &&
2143 (sv = GvSV(gv_fetchpvs("\017PEN", GV_ADD|GV_NOTQUAL,
2145 U32 in = PL_unicode & PERL_UNICODE_IN_FLAG;
2146 U32 out = PL_unicode & PERL_UNICODE_OUT_FLAG;
2149 sv_setpvn(sv, ":utf8\0:utf8", 11);
2151 sv_setpvn(sv, ":utf8\0", 6);
2154 sv_setpvn(sv, "\0:utf8", 6);
2162 if ((s = PerlEnv_getenv("PERL_SIGNALS"))) {
2163 if (strEQ(s, "unsafe"))
2164 PL_signals |= PERL_SIGNALS_UNSAFE_FLAG;
2165 else if (strEQ(s, "safe"))
2166 PL_signals &= ~PERL_SIGNALS_UNSAFE_FLAG;
2168 Perl_croak(aTHX_ "PERL_SIGNALS illegal: \"%s\"", s);
2175 if ((s = PerlEnv_getenv("PERL_XMLDUMP"))) {
2179 PL_xmlfp = PerlIO_stdout();
2181 PL_xmlfp = PerlIO_open(s, "w");
2183 Perl_croak(aTHX_ "Can't open %s", s);
2185 my_setenv("PERL_XMLDUMP", NULL); /* hide from subprocs */
2191 if ((s = PerlEnv_getenv("PERL_MADSKILLS"))) {
2192 PL_madskills = atoi(s);
2193 my_setenv("PERL_MADSKILLS", NULL); /* hide from subprocs */
2198 lex_start(linestr_sv, rsfp, TRUE);
2199 PL_subname = newSVpvs("main");
2201 if (add_read_e_script)
2202 filter_add(read_e_script, NULL);
2204 /* now parse the script */
2206 SETERRNO(0,SS_NORMAL);
2207 #ifdef MACOS_TRADITIONAL
2208 if (gMacPerl_SyntaxError = (yyparse() || PL_parser->error_count)) {
2210 Perl_croak(aTHX_ "%s had compilation errors.\n", MacPerl_MPWFileName(PL_origfilename));
2212 Perl_croak(aTHX_ "Execution of %s aborted due to compilation errors.\n",
2213 MacPerl_MPWFileName(PL_origfilename));
2217 if (yyparse() || PL_parser->error_count) {
2219 Perl_croak(aTHX_ "%s had compilation errors.\n", PL_origfilename);
2221 Perl_croak(aTHX_ "Execution of %s aborted due to compilation errors.\n",
2226 CopLINE_set(PL_curcop, 0);
2227 PL_curstash = PL_defstash;
2229 SvREFCNT_dec(PL_e_script);
2237 SAVECOPFILE(PL_curcop);
2238 SAVECOPLINE(PL_curcop);
2239 gv_check(PL_defstash);
2248 if ((s=PerlEnv_getenv("PERL_DEBUG_MSTATS")) && atoi(s) >= 2)
2249 dump_mstats("after compilation:");
2259 =for apidoc perl_run
2261 Tells a Perl interpreter to run. See L<perlembed>.
2274 PERL_UNUSED_ARG(my_perl);
2276 oldscope = PL_scopestack_ix;
2284 cxstack_ix = -1; /* start context stack again */
2286 case 0: /* normal completion */
2290 case 2: /* my_exit() */
2291 while (PL_scopestack_ix > oldscope)
2294 PL_curstash = PL_defstash;
2295 if (!(PL_exit_flags & PERL_EXIT_DESTRUCT_END) &&
2296 PL_endav && !PL_minus_c)
2297 call_list(oldscope, PL_endav);
2299 if (PerlEnv_getenv("PERL_DEBUG_MSTATS"))
2300 dump_mstats("after execution: ");
2306 POPSTACK_TO(PL_mainstack);
2309 PerlIO_printf(Perl_error_log, "panic: restartop\n");
2320 S_run_body(pTHX_ I32 oldscope)
2323 DEBUG_r(PerlIO_printf(Perl_debug_log, "%s $` $& $' support.\n",
2324 PL_sawampersand ? "Enabling" : "Omitting"));
2326 if (!PL_restartop) {
2330 exit(0); /* less likely to core dump than my_exit(0) */
2333 DEBUG_x(dump_all());
2336 PERL_DEBUG(PerlIO_printf(Perl_debug_log, "\nEXECUTING...\n\n"));
2338 DEBUG_S(PerlIO_printf(Perl_debug_log, "main thread is 0x%"UVxf"\n",
2342 #ifdef MACOS_TRADITIONAL
2343 PerlIO_printf(Perl_error_log, "%s%s syntax OK\n",
2344 (gMacPerl_ErrorFormat ? "# " : ""),
2345 MacPerl_MPWFileName(PL_origfilename));
2347 PerlIO_printf(Perl_error_log, "%s syntax OK\n", PL_origfilename);
2351 if (PERLDB_SINGLE && PL_DBsingle)
2352 sv_setiv(PL_DBsingle, 1);
2354 call_list(oldscope, PL_initav);
2355 #ifdef PERL_DEBUG_READONLY_OPS
2356 Perl_pending_Slabs_to_ro(aTHX);
2363 PL_op = PL_restartop;
2367 else if (PL_main_start) {
2368 CvDEPTH(PL_main_cv) = 1;
2369 PL_op = PL_main_start;
2377 =head1 SV Manipulation Functions
2379 =for apidoc p||get_sv
2381 Returns the SV of the specified Perl scalar. If C<create> is set and the
2382 Perl variable does not exist then it will be created. If C<create> is not
2383 set and the variable does not exist then NULL is returned.
2389 Perl_get_sv(pTHX_ const char *name, I32 create)
2392 gv = gv_fetchpv(name, create, SVt_PV);
2399 =head1 Array Manipulation Functions
2401 =for apidoc p||get_av
2403 Returns the AV of the specified Perl array. If C<create> is set and the
2404 Perl variable does not exist then it will be created. If C<create> is not
2405 set and the variable does not exist then NULL is returned.
2411 Perl_get_av(pTHX_ const char *name, I32 create)
2413 GV* const gv = gv_fetchpv(name, create, SVt_PVAV);
2422 =head1 Hash Manipulation Functions
2424 =for apidoc p||get_hv
2426 Returns the HV of the specified Perl hash. If C<create> is set and the
2427 Perl variable does not exist then it will be created. If C<create> is not
2428 set and the variable does not exist then NULL is returned.
2434 Perl_get_hv(pTHX_ const char *name, I32 create)
2436 GV* const gv = gv_fetchpv(name, create, SVt_PVHV);
2445 =head1 CV Manipulation Functions
2447 =for apidoc p||get_cvn_flags
2449 Returns the CV of the specified Perl subroutine. C<flags> are passed to
2450 C<gv_fetchpvn_flags>. If C<GV_ADD> is set and the Perl subroutine does not
2451 exist then it will be declared (which has the same effect as saying
2452 C<sub name;>). If C<GV_ADD> is not set and the subroutine does not exist
2453 then NULL is returned.
2455 =for apidoc p||get_cv
2457 Uses C<strlen> to get the length of C<name>, then calls C<get_cvn_flags>.
2463 Perl_get_cvn_flags(pTHX_ const char *name, STRLEN len, I32 flags)
2465 GV* const gv = gv_fetchpvn_flags(name, len, flags, SVt_PVCV);
2466 /* XXX this is probably not what they think they're getting.
2467 * It has the same effect as "sub name;", i.e. just a forward
2469 if ((flags & ~GV_NOADD_MASK) && !GvCVu(gv)) {
2470 SV *const sv = newSVpvn_flags(name, len, flags & SVf_UTF8);
2471 return newSUB(start_subparse(FALSE, 0),
2472 newSVOP(OP_CONST, 0, sv),
2481 Perl_get_cv(pTHX_ const char *name, I32 flags)
2483 return get_cvn_flags(name, strlen(name), flags);
2486 /* Be sure to refetch the stack pointer after calling these routines. */
2490 =head1 Callback Functions
2492 =for apidoc p||call_argv
2494 Performs a callback to the specified Perl sub. See L<perlcall>.
2500 Perl_call_argv(pTHX_ const char *sub_name, I32 flags, register char **argv)
2502 /* See G_* flags in cop.h */
2503 /* null terminated arg list */
2511 mXPUSHs(newSVpv(*argv,0));
2516 return call_pv(sub_name, flags);
2520 =for apidoc p||call_pv
2522 Performs a callback to the specified Perl sub. See L<perlcall>.
2528 Perl_call_pv(pTHX_ const char *sub_name, I32 flags)
2529 /* name of the subroutine */
2530 /* See G_* flags in cop.h */
2532 return call_sv((SV*)get_cv(sub_name, TRUE), flags);
2536 =for apidoc p||call_method
2538 Performs a callback to the specified Perl method. The blessed object must
2539 be on the stack. See L<perlcall>.
2545 Perl_call_method(pTHX_ const char *methname, I32 flags)
2546 /* name of the subroutine */
2547 /* See G_* flags in cop.h */
2549 return call_sv(sv_2mortal(newSVpv(methname,0)), flags | G_METHOD);
2552 /* May be called with any of a CV, a GV, or an SV containing the name. */
2554 =for apidoc p||call_sv
2556 Performs a callback to the Perl sub whose name is in the SV. See
2563 Perl_call_sv(pTHX_ SV *sv, I32 flags)
2564 /* See G_* flags in cop.h */
2567 LOGOP myop; /* fake syntax tree node */
2572 bool oldcatch = CATCH_GET;
2574 OP* const oldop = PL_op;
2577 if (flags & G_DISCARD) {
2582 Zero(&myop, 1, LOGOP);
2583 myop.op_next = NULL;
2584 if (!(flags & G_NOARGS))
2585 myop.op_flags |= OPf_STACKED;
2586 myop.op_flags |= OP_GIMME_REVERSE(flags);
2590 EXTEND(PL_stack_sp, 1);
2591 *++PL_stack_sp = sv;
2593 oldscope = PL_scopestack_ix;
2595 if (PERLDB_SUB && PL_curstash != PL_debstash
2596 /* Handle first BEGIN of -d. */
2597 && (PL_DBcv || (PL_DBcv = GvCV(PL_DBsub)))
2598 /* Try harder, since this may have been a sighandler, thus
2599 * curstash may be meaningless. */
2600 && (SvTYPE(sv) != SVt_PVCV || CvSTASH((CV*)sv) != PL_debstash)
2601 && !(flags & G_NODEBUG))
2602 PL_op->op_private |= OPpENTERSUB_DB;
2604 if (flags & G_METHOD) {
2605 Zero(&method_op, 1, UNOP);
2606 method_op.op_next = PL_op;
2607 method_op.op_ppaddr = PL_ppaddr[OP_METHOD];
2608 myop.op_ppaddr = PL_ppaddr[OP_ENTERSUB];
2609 PL_op = (OP*)&method_op;
2612 if (!(flags & G_EVAL)) {
2614 CALL_BODY_SUB((OP*)&myop);
2615 retval = PL_stack_sp - (PL_stack_base + oldmark);
2616 CATCH_SET(oldcatch);
2619 myop.op_other = (OP*)&myop;
2621 create_eval_scope(flags|G_FAKINGEVAL);
2629 CALL_BODY_SUB((OP*)&myop);
2630 retval = PL_stack_sp - (PL_stack_base + oldmark);
2631 if (!(flags & G_KEEPERR))
2632 sv_setpvn(ERRSV,"",0);
2638 /* my_exit() was called */
2639 PL_curstash = PL_defstash;
2642 if (PL_statusvalue && !(PL_exit_flags & PERL_EXIT_EXPECTED))
2643 Perl_croak(aTHX_ "Callback called exit");
2648 PL_op = PL_restartop;
2652 PL_stack_sp = PL_stack_base + oldmark;
2653 if ((flags & G_WANT) == G_ARRAY)
2657 *++PL_stack_sp = &PL_sv_undef;
2662 if (PL_scopestack_ix > oldscope)
2663 delete_eval_scope();
2667 if (flags & G_DISCARD) {
2668 PL_stack_sp = PL_stack_base + oldmark;
2677 /* Eval a string. The G_EVAL flag is always assumed. */
2680 =for apidoc p||eval_sv
2682 Tells Perl to C<eval> the string in the SV.
2688 Perl_eval_sv(pTHX_ SV *sv, I32 flags)
2690 /* See G_* flags in cop.h */
2694 UNOP myop; /* fake syntax tree node */
2695 VOL I32 oldmark = SP - PL_stack_base;
2698 OP* const oldop = PL_op;
2701 if (flags & G_DISCARD) {
2708 Zero(PL_op, 1, UNOP);
2709 EXTEND(PL_stack_sp, 1);
2710 *++PL_stack_sp = sv;
2712 if (!(flags & G_NOARGS))
2713 myop.op_flags = OPf_STACKED;
2714 myop.op_next = NULL;
2715 myop.op_type = OP_ENTEREVAL;
2716 myop.op_flags |= OP_GIMME_REVERSE(flags);
2717 if (flags & G_KEEPERR)
2718 myop.op_flags |= OPf_SPECIAL;
2720 /* fail now; otherwise we could fail after the JMPENV_PUSH but
2721 * before a PUSHEVAL, which corrupts the stack after a croak */
2722 TAINT_PROPER("eval_sv()");
2728 CALL_BODY_EVAL((OP*)&myop);
2729 retval = PL_stack_sp - (PL_stack_base + oldmark);
2730 if (!(flags & G_KEEPERR))
2731 sv_setpvn(ERRSV,"",0);
2737 /* my_exit() was called */
2738 PL_curstash = PL_defstash;
2741 if (PL_statusvalue && !(PL_exit_flags & PERL_EXIT_EXPECTED))
2742 Perl_croak(aTHX_ "Callback called exit");
2747 PL_op = PL_restartop;
2751 PL_stack_sp = PL_stack_base + oldmark;
2752 if ((flags & G_WANT) == G_ARRAY)
2756 *++PL_stack_sp = &PL_sv_undef;
2762 if (flags & G_DISCARD) {
2763 PL_stack_sp = PL_stack_base + oldmark;
2773 =for apidoc p||eval_pv
2775 Tells Perl to C<eval> the given string and return an SV* result.
2781 Perl_eval_pv(pTHX_ const char *p, I32 croak_on_error)
2785 SV* sv = newSVpv(p, 0);
2787 eval_sv(sv, G_SCALAR);
2794 if (croak_on_error && SvTRUE(ERRSV)) {
2795 Perl_croak(aTHX_ SvPVx_nolen_const(ERRSV));
2801 /* Require a module. */
2804 =head1 Embedding Functions
2806 =for apidoc p||require_pv
2808 Tells Perl to C<require> the file named by the string argument. It is
2809 analogous to the Perl code C<eval "require '$file'">. It's even
2810 implemented that way; consider using load_module instead.
2815 Perl_require_pv(pTHX_ const char *pv)
2820 PUSHSTACKi(PERLSI_REQUIRE);
2822 sv = Perl_newSVpvf(aTHX_ "require q%c%s%c", 0, pv, 0);
2823 eval_sv(sv_2mortal(sv), G_DISCARD);
2829 Perl_magicname(pTHX_ const char *sym, const char *name, I32 namlen)
2831 register GV * const gv = gv_fetchpv(sym, GV_ADD, SVt_PV);
2834 sv_magic(GvSV(gv), (SV*)gv, PERL_MAGIC_sv, name, namlen);
2838 S_usage(pTHX_ const char *name) /* XXX move this out into a module ? */
2840 /* This message really ought to be max 23 lines.
2841 * Removed -h because the user already knows that option. Others? */
2843 static const char * const usage_msg[] = {
2844 "-0[octal] specify record separator (\\0, if no argument)",
2845 "-a autosplit mode with -n or -p (splits $_ into @F)",
2846 "-C[number/list] enables the listed Unicode features",
2847 "-c check syntax only (runs BEGIN and CHECK blocks)",
2848 "-d[:debugger] run program under debugger",
2849 "-D[number/list] set debugging flags (argument is a bit mask or alphabets)",
2850 "-e program one line of program (several -e's allowed, omit programfile)",
2851 "-E program like -e, but enables all optional features",
2852 "-f don't do $sitelib/sitecustomize.pl at startup",
2853 "-F/pattern/ split() pattern for -a switch (//'s are optional)",
2854 "-i[extension] edit <> files in place (makes backup if extension supplied)",
2855 "-Idirectory specify @INC/#include directory (several -I's allowed)",
2856 "-l[octal] enable line ending processing, specifies line terminator",
2857 "-[mM][-]module execute \"use/no module...\" before executing program",
2858 "-n assume \"while (<>) { ... }\" loop around program",
2859 "-p assume loop like -n but print line also, like sed",
2860 "-s enable rudimentary parsing for switches after programfile",
2861 "-S look for programfile using PATH environment variable",
2862 "-t enable tainting warnings",
2863 "-T enable tainting checks",
2864 "-u dump core after parsing program",
2865 "-U allow unsafe operations",
2866 "-v print version, subversion (includes VERY IMPORTANT perl info)",
2867 "-V[:variable] print configuration summary (or a single Config.pm variable)",
2868 "-w enable many useful warnings (RECOMMENDED)",
2869 "-W enable all warnings",
2870 "-x[directory] strip off text before #!perl line and perhaps cd to directory",
2871 "-X disable all warnings",
2875 const char * const *p = usage_msg;
2877 PerlIO_printf(PerlIO_stdout(),
2878 "\nUsage: %s [switches] [--] [programfile] [arguments]",
2881 PerlIO_printf(PerlIO_stdout(), "\n %s", *p++);
2884 /* convert a string of -D options (or digits) into an int.
2885 * sets *s to point to the char after the options */
2889 Perl_get_debug_opts(pTHX_ const char **s, bool givehelp)
2891 static const char * const usage_msgd[] = {
2892 " Debugging flag values: (see also -d)",
2893 " p Tokenizing and parsing (with v, displays parse stack)",
2894 " s Stack snapshots (with v, displays all stacks)",
2895 " l Context (loop) stack processing",
2896 " t Trace execution",
2897 " o Method and overloading resolution",
2898 " c String/numeric conversions",
2899 " P Print profiling info, source file input state",
2900 " m Memory allocation",
2901 " f Format processing",
2902 " r Regular expression parsing and execution",
2903 " x Syntax tree dump",
2904 " u Tainting checks",
2905 " H Hash dump -- usurps values()",
2906 " X Scratchpad allocation",
2908 " S Thread synchronization",
2910 " R Include reference counts of dumped variables (eg when using -Ds)",
2911 " J Do not s,t,P-debug (Jump over) opcodes within package DB",
2912 " v Verbose: use in conjunction with other flags",
2914 " A Consistency checks on internal structures",
2915 " q quiet - currently only suppresses the 'EXECUTING' message",
2920 /* if adding extra options, remember to update DEBUG_MASK */
2921 static const char debopts[] = "psltocPmfrxuUHXDSTRJvCAq";
2923 for (; isALNUM(**s); (*s)++) {
2924 const char * const d = strchr(debopts,**s);
2926 i |= 1 << (d - debopts);
2927 else if (ckWARN_d(WARN_DEBUGGING))
2928 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
2929 "invalid option -D%c, use -D'' to see choices\n", **s);
2932 else if (isDIGIT(**s)) {
2934 for (; isALNUM(**s); (*s)++) ;
2936 else if (givehelp) {
2937 const char *const *p = usage_msgd;
2938 while (*p) PerlIO_printf(PerlIO_stdout(), "%s\n", *p++);
2941 if ((i & DEBUG_p_FLAG) && ckWARN_d(WARN_DEBUGGING))
2942 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
2943 "-Dp not implemented on this platform\n");
2949 /* This routine handles any switches that can be given during run */
2952 Perl_moreswitches(pTHX_ const char *s)
2963 SvREFCNT_dec(PL_rs);
2964 if (s[1] == 'x' && s[2]) {
2965 const char *e = s+=2;
2971 flags = PERL_SCAN_SILENT_ILLDIGIT;
2972 rschar = (U32)grok_hex(s, &numlen, &flags, NULL);
2973 if (s + numlen < e) {
2974 rschar = 0; /* Grandfather -0xFOO as -0 -xFOO. */
2978 PL_rs = newSVpvs("");
2979 SvGROW(PL_rs, (STRLEN)(UNISKIP(rschar) + 1));
2980 tmps = (U8*)SvPVX(PL_rs);
2981 uvchr_to_utf8(tmps, rschar);
2982 SvCUR_set(PL_rs, UNISKIP(rschar));
2987 rschar = (U32)grok_oct(s, &numlen, &flags, NULL);
2988 if (rschar & ~((U8)~0))
2989 PL_rs = &PL_sv_undef;
2990 else if (!rschar && numlen >= 2)
2991 PL_rs = newSVpvs("");
2993 char ch = (char)rschar;
2994 PL_rs = newSVpvn(&ch, 1);
2997 sv_setsv(get_sv("/", TRUE), PL_rs);
3002 PL_unicode = parse_unicode_opts( (const char **)&s );
3003 if (PL_unicode & PERL_UNICODE_UTF8CACHEASSERT_FLAG)
3009 while (*s && !isSPACE(*s)) ++s;
3010 PL_splitstr = savepvn(PL_splitstr, s - PL_splitstr);
3021 forbid_setid('d', FALSE);
3024 /* -dt indicates to the debugger that threads will be used */
3025 if (*s == 't' && !isALNUM(s[1])) {
3027 my_setenv("PERL5DB_THREADED", "1");
3030 /* The following permits -d:Mod to accepts arguments following an =
3031 in the fashion that -MSome::Mod does. */
3032 if (*s == ':' || *s == '=') {
3033 const char *start = ++s;
3034 const char *const end = s + strlen(s);
3035 SV * const sv = newSVpvs("use Devel::");
3037 /* We now allow -d:Module=Foo,Bar */
3038 while(isALNUM(*s) || *s==':') ++s;
3040 sv_catpvn(sv, start, end - start);
3042 sv_catpvn(sv, start, s-start);
3043 /* Don't use NUL as q// delimiter here, this string goes in the
3045 Perl_sv_catpvf(aTHX_ sv, " split(/,/,q{%s});", ++s);
3048 my_setenv("PERL5DB", SvPV_nolen_const(sv));
3052 PL_perldb = PERLDB_ALL;
3059 forbid_setid('D', FALSE);
3061 PL_debug = get_debug_opts( (const char **)&s, 1) | DEBUG_TOP_FLAG;
3062 #else /* !DEBUGGING */
3063 if (ckWARN_d(WARN_DEBUGGING))
3064 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3065 "Recompile perl with -DDEBUGGING to use -D switch (did you mean -d ?)\n");
3066 for (s++; isALNUM(*s); s++) ;
3071 usage(PL_origargv[0]);
3074 Safefree(PL_inplace);
3075 #if defined(__CYGWIN__) /* do backup extension automagically */
3076 if (*(s+1) == '\0') {
3077 PL_inplace = savepvs(".bak");
3080 #endif /* __CYGWIN__ */
3082 const char * const start = ++s;
3083 while (*s && !isSPACE(*s))
3086 PL_inplace = savepvn(start, s - start);
3090 if (*s == '-') /* Additional switches on #! line. */
3094 case 'I': /* -I handled both here and in parse_body() */
3095 forbid_setid('I', FALSE);
3097 while (*s && isSPACE(*s))
3102 /* ignore trailing spaces (possibly followed by other switches) */
3104 for (e = p; *e && !isSPACE(*e); e++) ;
3108 } while (*p && *p != '-');
3109 e = savepvn(s, e-s);
3110 incpush(e, TRUE, TRUE, FALSE, FALSE);
3117 Perl_croak(aTHX_ "No directory specified for -I");
3123 SvREFCNT_dec(PL_ors_sv);
3129 PL_ors_sv = newSVpvs("\n");
3130 numlen = 3 + (*s == '0');
3131 *SvPVX(PL_ors_sv) = (char)grok_oct(s, &numlen, &flags, NULL);
3135 if (RsPARA(PL_rs)) {
3136 PL_ors_sv = newSVpvs("\n\n");
3139 PL_ors_sv = newSVsv(PL_rs);
3144 forbid_setid('M', FALSE); /* XXX ? */
3147 forbid_setid('m', FALSE); /* XXX ? */
3152 const char *use = "use ";
3153 /* -M-foo == 'no foo' */
3154 /* Leading space on " no " is deliberate, to make both
3155 possibilities the same length. */
3156 if (*s == '-') { use = " no "; ++s; }
3157 sv = newSVpvn(use,4);
3159 /* We allow -M'Module qw(Foo Bar)' */
3160 while(isALNUM(*s) || *s==':') ++s;
3161 end = s + strlen(s);
3163 sv_catpvn(sv, start, end - start);
3164 if (*(start-1) == 'm') {
3166 Perl_croak(aTHX_ "Can't use '%c' after -mname", *s);
3167 sv_catpvs( sv, " ()");
3171 Perl_croak(aTHX_ "Module name required with -%c option",
3173 sv_catpvn(sv, start, s-start);
3174 /* Use NUL as q''-delimiter. */
3175 sv_catpvs(sv, " split(/,/,q\0");
3177 sv_catpvn(sv, s, end - s);
3178 sv_catpvs(sv, "\0)");
3181 Perl_av_create_and_push(aTHX_ &PL_preambleav, sv);
3184 Perl_croak(aTHX_ "Missing argument to -%c", *(s-1));
3195 forbid_setid('s', FALSE);
3196 PL_doswitches = TRUE;
3210 #ifdef MACOS_TRADITIONAL
3211 Perl_croak(aTHX_ "Believe me, you don't want to use \"-u\" on a Macintosh");
3213 PL_do_undump = TRUE;
3221 if (!sv_derived_from(PL_patchlevel, "version"))
3222 upg_version(PL_patchlevel, TRUE);
3224 PerlIO_printf(PerlIO_stdout(),
3225 Perl_form(aTHX_ "\nThis is perl, %"SVf
3226 #ifdef PERL_PATCHNUM
3227 " DEVEL" STRINGIFY(PERL_PATCHNUM)
3230 SVfARG(vstringify(PL_patchlevel)),
3233 /* Adjust verbose output as in the perl that ships with the DG/UX OS from EMC */
3234 PerlIO_printf(PerlIO_stdout(),
3235 Perl_form(aTHX_ "\nThis is perl, %"SVf"\n",
3236 SVfARG(vstringify(PL_patchlevel))));
3237 PerlIO_printf(PerlIO_stdout(),
3238 Perl_form(aTHX_ " built under %s at %s %s\n",
3239 OSNAME, __DATE__, __TIME__));
3240 PerlIO_printf(PerlIO_stdout(),
3241 Perl_form(aTHX_ " OS Specific Release: %s\n",
3245 #if defined(LOCAL_PATCH_COUNT)
3246 if (LOCAL_PATCH_COUNT > 0)
3247 PerlIO_printf(PerlIO_stdout(),
3248 "\n(with %d registered patch%s, "
3249 "see perl -V for more detail)",
3251 (LOCAL_PATCH_COUNT!=1) ? "es" : "");
3254 PerlIO_printf(PerlIO_stdout(),
3255 "\n\nCopyright 1987-2007, Larry Wall\n");
3256 #ifdef MACOS_TRADITIONAL
3257 PerlIO_printf(PerlIO_stdout(),
3258 "\nMac OS port Copyright 1991-2002, Matthias Neeracher;\n"
3259 "maintained by Chris Nandor\n");
3262 PerlIO_printf(PerlIO_stdout(),
3263 "\nMS-DOS port Copyright (c) 1989, 1990, Diomidis Spinellis\n");
3266 PerlIO_printf(PerlIO_stdout(),
3267 "djgpp v2 port (jpl5003c) by Hirofumi Watanabe, 1996\n"
3268 "djgpp v2 port (perl5004+) by Laszlo Molnar, 1997-1999\n");
3271 PerlIO_printf(PerlIO_stdout(),
3272 "\n\nOS/2 port Copyright (c) 1990, 1991, Raymond Chen, Kai Uwe Rommel\n"
3273 "Version 5 port Copyright (c) 1994-2002, Andreas Kaiser, Ilya Zakharevich\n");
3276 PerlIO_printf(PerlIO_stdout(),
3277 "atariST series port, ++jrb bammi@cadence.com\n");
3280 PerlIO_printf(PerlIO_stdout(),
3281 "BeOS port Copyright Tom Spindler, 1997-1999\n");
3284 PerlIO_printf(PerlIO_stdout(),
3285 "MPE/iX port Copyright by Mark Klein and Mark Bixby, 1996-2003\n");
3288 PerlIO_printf(PerlIO_stdout(),
3289 "MVS (OS390) port by Mortice Kern Systems, 1997-1999\n");
3292 PerlIO_printf(PerlIO_stdout(),
3293 "Stratus VOS port by Paul.Green@stratus.com, 1997-2002\n");
3296 PerlIO_printf(PerlIO_stdout(),
3297 "VM/ESA port by Neale Ferguson, 1998-1999\n");
3300 PerlIO_printf(PerlIO_stdout(),
3301 "BS2000 (POSIX) port by Start Amadeus GmbH, 1998-1999\n");
3304 PerlIO_printf(PerlIO_stdout(),
3305 "MiNT port by Guido Flohr, 1997-1999\n");
3308 PerlIO_printf(PerlIO_stdout(),
3309 "EPOC port by Olaf Flebbe, 1999-2002\n");
3312 PerlIO_printf(PerlIO_stdout(),"WINCE port by Rainer Keuchel, 2001-2002\n");
3313 PerlIO_printf(PerlIO_stdout(),"Built on " __DATE__ " " __TIME__ "\n\n");
3316 #ifdef __SYMBIAN32__
3317 PerlIO_printf(PerlIO_stdout(),
3318 "Symbian port by Nokia, 2004-2005\n");
3320 #ifdef BINARY_BUILD_NOTICE
3321 BINARY_BUILD_NOTICE;
3323 PerlIO_printf(PerlIO_stdout(),
3325 Perl may be copied only under the terms of either the Artistic License or the\n\
3326 GNU General Public License, which may be found in the Perl 5 source kit.\n\n\
3327 Complete documentation for Perl, including FAQ lists, should be found on\n\
3328 this system using \"man perl\" or \"perldoc perl\". If you have access to the\n\
3329 Internet, point your browser at http://www.perl.org/, the Perl Home Page.\n\n");
3332 if (! (PL_dowarn & G_WARN_ALL_MASK)) {
3333 PL_dowarn |= G_WARN_ON;
3338 PL_dowarn = G_WARN_ALL_ON|G_WARN_ON;
3339 if (!specialWARN(PL_compiling.cop_warnings))
3340 PerlMemShared_free(PL_compiling.cop_warnings);
3341 PL_compiling.cop_warnings = pWARN_ALL ;
3345 PL_dowarn = G_WARN_ALL_OFF;
3346 if (!specialWARN(PL_compiling.cop_warnings))
3347 PerlMemShared_free(PL_compiling.cop_warnings);
3348 PL_compiling.cop_warnings = pWARN_NONE ;
3353 if (s[1] == '-') /* Additional switches on #! line. */
3358 #if defined(WIN32) || !defined(PERL_STRICT_CR)
3364 #ifdef ALTERNATE_SHEBANG
3365 case 'S': /* OS/2 needs -S on "extproc" line. */
3369 Perl_croak(aTHX_ "Can't emulate -%.1s on #! line",s);
3374 /* compliments of Tom Christiansen */
3376 /* unexec() can be found in the Gnu emacs distribution */
3377 /* Known to work with -DUNEXEC and using unexelf.c from GNU emacs-20.2 */
3380 Perl_my_unexec(pTHX)
3382 PERL_UNUSED_CONTEXT;
3384 SV * prog = newSVpv(BIN_EXP, 0);
3385 SV * file = newSVpv(PL_origfilename, 0);
3389 sv_catpvs(prog, "/perl");
3390 sv_catpvs(file, ".perldump");
3392 unexec(SvPVX(file), SvPVX(prog), &etext, sbrk(0), 0);
3393 /* unexec prints msg to stderr in case of failure */
3394 PerlProc_exit(status);
3397 # include <lib$routines.h>
3398 lib$signal(SS$_DEBUG); /* ssdef.h #included from vmsish.h */
3399 # elif defined(WIN32) || defined(__CYGWIN__)
3400 Perl_croak(aTHX_ "dump is not supported");
3402 ABORT(); /* for use with undump */
3407 /* initialize curinterp */
3413 # define PERLVAR(var,type)
3414 # define PERLVARA(var,n,type)
3415 # if defined(PERL_IMPLICIT_CONTEXT)
3416 # define PERLVARI(var,type,init) aTHX->var = init;
3417 # define PERLVARIC(var,type,init) aTHX->var = init;
3419 # define PERLVARI(var,type,init) PERL_GET_INTERP->var = init;
3420 # define PERLVARIC(var,type,init) PERL_GET_INTERP->var = init;
3422 # include "intrpvar.h"
3428 # define PERLVAR(var,type)
3429 # define PERLVARA(var,n,type)
3430 # define PERLVARI(var,type,init) PL_##var = init;
3431 # define PERLVARIC(var,type,init) PL_##var = init;
3432 # include "intrpvar.h"
3439 /* As these are inside a structure, PERLVARI isn't capable of initialising
3441 PL_reg_oldcurpm = PL_reg_curpm = NULL;
3442 PL_reg_poscache = PL_reg_starttry = NULL;
3446 S_init_main_stash(pTHX)
3451 PL_curstash = PL_defstash = newHV();
3452 /* We know that the string "main" will be in the global shared string
3453 table, so it's a small saving to use it rather than allocate another
3455 PL_curstname = newSVpvs_share("main");
3456 gv = gv_fetchpvs("main::", GV_ADD|GV_NOTQUAL, SVt_PVHV);
3457 /* If we hadn't caused another reference to "main" to be in the shared
3458 string table above, then it would be worth reordering these two,
3459 because otherwise all we do is delete "main" from it as a consequence
3460 of the SvREFCNT_dec, only to add it again with hv_name_set */
3461 SvREFCNT_dec(GvHV(gv));
3462 hv_name_set(PL_defstash, "main", 4, 0);
3463 GvHV(gv) = (HV*)SvREFCNT_inc_simple(PL_defstash);
3465 PL_incgv = gv_HVadd(gv_AVadd(gv_fetchpvs("INC", GV_ADD|GV_NOTQUAL,
3467 SvREFCNT_inc_simple_void(PL_incgv); /* Don't allow it to be freed */
3468 GvMULTI_on(PL_incgv);
3469 PL_hintgv = gv_fetchpvs("\010", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^H */
3470 GvMULTI_on(PL_hintgv);
3471 PL_defgv = gv_fetchpvs("_", GV_ADD|GV_NOTQUAL, SVt_PVAV);
3472 SvREFCNT_inc_simple_void(PL_defgv);
3473 PL_errgv = gv_HVadd(gv_fetchpvs("@", GV_ADD|GV_NOTQUAL, SVt_PV));
3474 SvREFCNT_inc_simple_void(PL_errgv);
3475 GvMULTI_on(PL_errgv);
3476 PL_replgv = gv_fetchpvs("\022", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^R */
3477 GvMULTI_on(PL_replgv);
3478 (void)Perl_form(aTHX_ "%240s",""); /* Preallocate temp - for immediate signals. */
3479 #ifdef PERL_DONT_CREATE_GVSV
3482 sv_grow(ERRSV, 240); /* Preallocate - for immediate signals. */
3483 sv_setpvn(ERRSV, "", 0);
3484 PL_curstash = PL_defstash;
3485 CopSTASH_set(&PL_compiling, PL_defstash);
3486 PL_debstash = GvHV(gv_fetchpvs("DB::", GV_ADDMULTI, SVt_PVHV));
3487 PL_globalstash = GvHV(gv_fetchpvs("CORE::GLOBAL::", GV_ADDMULTI,
3489 /* We must init $/ before switches are processed. */
3490 sv_setpvn(get_sv("/", TRUE), "\n", 1);
3494 S_open_script(pTHX_ const char *scriptname, bool dosearch,
3495 bool *suidscript, PerlIO **rsfpp)
3501 PL_origfilename = savepvs("-e");
3504 /* if find_script() returns, it returns a malloc()-ed value */
3505 scriptname = PL_origfilename = find_script(scriptname, dosearch, NULL, 1);
3507 if (strnEQ(scriptname, "/dev/fd/", 8) && isDIGIT(scriptname[8]) ) {
3508 const char *s = scriptname + 8;
3514 * Tell apart "normal" usage of fdscript, e.g.
3515 * with bash on FreeBSD:
3516 * perl <( echo '#!perl -DA'; echo 'print "$0\n"')
3517 * from usage in suidperl.
3518 * Does any "normal" usage leave garbage after the number???
3519 * Is it a mistake to use a similar /dev/fd/ construct for
3524 * Be supersafe and do some sanity-checks.
3525 * Still, can we be sure we got the right thing?
3528 Perl_croak(aTHX_ "Wrong syntax (suid) fd script name \"%s\"\n", s);
3531 Perl_croak(aTHX_ "Missing (suid) fd script name\n");
3533 scriptname = savepv(s + 1);
3534 Safefree(PL_origfilename);
3535 PL_origfilename = (char *)scriptname;
3540 CopFILE_free(PL_curcop);
3541 CopFILE_set(PL_curcop, PL_origfilename);
3542 if (*PL_origfilename == '-' && PL_origfilename[1] == '\0')
3543 scriptname = (char *)"";
3544 if (fdscript >= 0) {
3545 *rsfpp = PerlIO_fdopen(fdscript,PERL_SCRIPT_MODE);
3546 # if defined(HAS_FCNTL) && defined(F_SETFD)
3548 /* ensure close-on-exec */
3549 fcntl(PerlIO_fileno(*rsfpp),F_SETFD,1);
3554 Perl_croak(aTHX_ "sperl needs fd script\n"
3555 "You should not call sperl directly; do you need to "
3556 "change a #! line\nfrom sperl to perl?\n");
3559 * Do not open (or do other fancy stuff) while setuid.
3560 * Perl does the open, and hands script to suidperl on a fd;
3561 * suidperl only does some checks, sets up UIDs and re-execs
3562 * perl with that fd as it has always done.
3566 Perl_croak(aTHX_ "suidperl needs (suid) fd script\n");
3569 else if (!*scriptname) {
3570 forbid_setid(0, *suidscript);
3571 *rsfpp = PerlIO_stdin();
3574 #ifdef FAKE_BIT_BUCKET
3575 /* This hack allows one not to have /dev/null (or BIT_BUCKET as it
3576 * is called) and still have the "-e" work. (Believe it or not,
3577 * a /dev/null is required for the "-e" to work because source
3578 * filter magic is used to implement it. ) This is *not* a general
3579 * replacement for a /dev/null. What we do here is create a temp
3580 * file (an empty file), open up that as the script, and then
3581 * immediately close and unlink it. Close enough for jazz. */
3582 #define FAKE_BIT_BUCKET_PREFIX "/tmp/perlnull-"
3583 #define FAKE_BIT_BUCKET_SUFFIX "XXXXXXXX"
3584 #define FAKE_BIT_BUCKET_TEMPLATE FAKE_BIT_BUCKET_PREFIX FAKE_BIT_BUCKET_SUFFIX
3585 char tmpname[sizeof(FAKE_BIT_BUCKET_TEMPLATE)] = {
3586 FAKE_BIT_BUCKET_TEMPLATE
3588 const char * const err = "Failed to create a fake bit bucket";
3589 if (strEQ(scriptname, BIT_BUCKET)) {
3590 #ifdef HAS_MKSTEMP /* Hopefully mkstemp() is safe here. */
3591 int tmpfd = mkstemp(tmpname);
3593 scriptname = tmpname;
3596 Perl_croak(aTHX_ err);
3599 scriptname = mktemp(tmpname);
3601 Perl_croak(aTHX_ err);
3606 *rsfpp = PerlIO_open(scriptname,PERL_SCRIPT_MODE);
3607 #ifdef FAKE_BIT_BUCKET
3608 if (memEQ(scriptname, FAKE_BIT_BUCKET_PREFIX,
3609 sizeof(FAKE_BIT_BUCKET_PREFIX) - 1)
3610 && strlen(scriptname) == sizeof(tmpname) - 1) {
3613 scriptname = BIT_BUCKET;
3615 # if defined(HAS_FCNTL) && defined(F_SETFD)
3617 /* ensure close-on-exec */
3618 fcntl(PerlIO_fileno(*rsfpp),F_SETFD,1);
3621 #endif /* IAMSUID */
3623 /* PSz 16 Sep 03 Keep neat error message */
3625 Perl_croak(aTHX_ "Can't open "BIT_BUCKET": %s\n", Strerror(errno));
3627 Perl_croak(aTHX_ "Can't open perl script \"%s\": %s\n",
3628 CopFILE(PL_curcop), Strerror(errno));
3634 * I_SYSSTATVFS HAS_FSTATVFS
3636 * I_STATFS HAS_FSTATFS HAS_GETFSSTAT
3637 * I_MNTENT HAS_GETMNTENT HAS_HASMNTOPT
3638 * here so that metaconfig picks them up. */
3642 S_fd_on_nosuid_fs(pTHX_ int fd)
3645 * We used to do this as "plain" user (after swapping UIDs with setreuid);
3646 * but is needed also on machines without setreuid.
3647 * Seems safe enough to run as root.
3649 int check_okay = 0; /* able to do all the required sys/libcalls */
3650 int on_nosuid = 0; /* the fd is on a nosuid fs */
3652 * Need to check noexec also: nosuid might not be set, the average
3653 * sysadmin would say that nosuid is irrelevant once he sets noexec.
3655 int on_noexec = 0; /* the fd is on a noexec fs */
3658 * Preferred order: fstatvfs(), fstatfs(), ustat()+getmnt(), getmntent().
3659 * fstatvfs() is UNIX98.
3660 * fstatfs() is 4.3 BSD.
3661 * ustat()+getmnt() is pre-4.3 BSD.
3662 * getmntent() is O(number-of-mounted-filesystems) and can hang on
3663 * an irrelevant filesystem while trying to reach the right one.
3666 #undef FD_ON_NOSUID_CHECK_OKAY /* found the syscalls to do the check? */
3668 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3669 defined(HAS_FSTATVFS)
3670 # define FD_ON_NOSUID_CHECK_OKAY
3671 struct statvfs stfs;
3673 check_okay = fstatvfs(fd, &stfs) == 0;
3674 on_nosuid = check_okay && (stfs.f_flag & ST_NOSUID);
3676 /* ST_NOEXEC certainly absent on AIX 5.1, and doesn't seem to be documented
3677 on platforms where it is present. */
3678 on_noexec = check_okay && (stfs.f_flag & ST_NOEXEC);
3680 # endif /* fstatvfs */
3682 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3683 defined(PERL_MOUNT_NOSUID) && \
3684 defined(PERL_MOUNT_NOEXEC) && \
3685 defined(HAS_FSTATFS) && \
3686 defined(HAS_STRUCT_STATFS) && \
3687 defined(HAS_STRUCT_STATFS_F_FLAGS)
3688 # define FD_ON_NOSUID_CHECK_OKAY
3691 check_okay = fstatfs(fd, &stfs) == 0;
3692 on_nosuid = check_okay && (stfs.f_flags & PERL_MOUNT_NOSUID);
3693 on_noexec = check_okay && (stfs.f_flags & PERL_MOUNT_NOEXEC);
3694 # endif /* fstatfs */
3696 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3697 defined(PERL_MOUNT_NOSUID) && \
3698 defined(PERL_MOUNT_NOEXEC) && \
3699 defined(HAS_FSTAT) && \
3700 defined(HAS_USTAT) && \
3701 defined(HAS_GETMNT) && \
3702 defined(HAS_STRUCT_FS_DATA) && \
3704 # define FD_ON_NOSUID_CHECK_OKAY
3707 if (fstat(fd, &fdst) == 0) {
3709 if (ustat(fdst.st_dev, &us) == 0) {
3711 /* NOSTAT_ONE here because we're not examining fields which
3712 * vary between that case and STAT_ONE. */
3713 if (getmnt((int*)0, &fsd, (int)0, NOSTAT_ONE, us.f_fname) == 0) {
3714 size_t cmplen = sizeof(us.f_fname);
3715 if (sizeof(fsd.fd_req.path) < cmplen)
3716 cmplen = sizeof(fsd.fd_req.path);
3717 if (strnEQ(fsd.fd_req.path, us.f_fname, cmplen) &&
3718 fdst.st_dev == fsd.fd_req.dev) {
3720 on_nosuid = fsd.fd_req.flags & PERL_MOUNT_NOSUID;
3721 on_noexec = fsd.fd_req.flags & PERL_MOUNT_NOEXEC;
3726 # endif /* fstat+ustat+getmnt */
3728 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3729 defined(HAS_GETMNTENT) && \
3730 defined(HAS_HASMNTOPT) && \
3731 defined(MNTOPT_NOSUID) && \
3732 defined(MNTOPT_NOEXEC)
3733 # define FD_ON_NOSUID_CHECK_OKAY
3734 FILE *mtab = fopen("/etc/mtab", "r");
3735 struct mntent *entry;
3738 if (mtab && (fstat(fd, &stb) == 0)) {
3739 while (entry = getmntent(mtab)) {
3740 if (stat(entry->mnt_dir, &fsb) == 0
3741 && fsb.st_dev == stb.st_dev)
3743 /* found the filesystem */
3745 if (hasmntopt(entry, MNTOPT_NOSUID))
3747 if (hasmntopt(entry, MNTOPT_NOEXEC))
3750 } /* A single fs may well fail its stat(). */
3755 # endif /* getmntent+hasmntopt */
3758 Perl_croak(aTHX_ "Can't check filesystem of script \"%s\" for nosuid/noexec", PL_origfilename);
3760 Perl_croak(aTHX_ "Setuid script \"%s\" on nosuid filesystem", PL_origfilename);
3762 Perl_croak(aTHX_ "Setuid script \"%s\" on noexec filesystem", PL_origfilename);
3763 return ((!check_okay) || on_nosuid || on_noexec);
3765 #endif /* IAMSUID */
3769 S_validate_suid(pTHX_ const char *validarg,
3771 const char *scriptname,
3777 SV *linestr_sv, PerlIO *rsfp)
3782 /* do we need to emulate setuid on scripts? */
3784 /* This code is for those BSD systems that have setuid #! scripts disabled
3785 * in the kernel because of a security problem. Merely defining DOSUID
3786 * in perl will not fix that problem, but if you have disabled setuid
3787 * scripts in the kernel, this will attempt to emulate setuid and setgid
3788 * on scripts that have those now-otherwise-useless bits set. The setuid
3789 * root version must be called suidperl or sperlN.NNN. If regular perl
3790 * discovers that it has opened a setuid script, it calls suidperl with
3791 * the same argv that it had. If suidperl finds that the script it has
3792 * just opened is NOT setuid root, it sets the effective uid back to the
3793 * uid. We don't just make perl setuid root because that loses the
3794 * effective uid we had before invoking perl, if it was different from the
3797 * Description/comments above do not match current workings:
3798 * suidperl must be hardlinked to sperlN.NNN (that is what we exec);
3799 * suidperl called with script open and name changed to /dev/fd/N/X;
3800 * suidperl croaks if script is not setuid;
3801 * making perl setuid would be a huge security risk (and yes, that
3802 * would lose any euid we might have had).
3804 * DOSUID must be defined in both perl and suidperl, and IAMSUID must
3805 * be defined in suidperl only. suidperl must be setuid root. The
3806 * Configure script will set this up for you if you want it.
3809 if (PerlLIO_fstat(PerlIO_fileno(rsfp),&PL_statbuf) < 0) /* normal stat is insecure */
3810 Perl_croak(aTHX_ "Can't stat script \"%s\"",PL_origfilename);
3811 if (PL_statbuf.st_mode & (S_ISUID|S_ISGID)) {
3813 const char *linestr;
3817 if (fdscript < 0 || !suidscript)
3818 Perl_croak(aTHX_ "Need (suid) fdscript in suidperl\n"); /* We already checked this */
3820 * Since the script is opened by perl, not suidperl, some of these
3821 * checks are superfluous. Leaving them in probably does not lower
3825 * Do checks even for systems with no HAS_SETREUID.
3826 * We used to swap, then re-swap UIDs with
3827 # ifdef HAS_SETREUID
3828 if (setreuid(PL_euid,PL_uid) < 0
3829 || PerlProc_getuid() != PL_euid || PerlProc_geteuid() != PL_uid)
3830 Perl_croak(aTHX_ "Can't swap uid and euid");
3832 # ifdef HAS_SETREUID
3833 if (setreuid(PL_uid,PL_euid) < 0
3834 || PerlProc_getuid() != PL_uid || PerlProc_geteuid() != PL_euid)
3835 Perl_croak(aTHX_ "Can't reswap uid and euid");
3839 /* On this access check to make sure the directories are readable,
3840 * there is actually a small window that the user could use to make
3841 * filename point to an accessible directory. So there is a faint
3842 * chance that someone could execute a setuid script down in a
3843 * non-accessible directory. I don't know what to do about that.
3844 * But I don't think it's too important. The manual lies when
3845 * it says access() is useful in setuid programs.
3847 * So, access() is pretty useless... but not harmful... do anyway.
3849 if (PerlLIO_access(CopFILE(PL_curcop),1)) { /*double check*/
3850 Perl_croak(aTHX_ "Can't access() script\n");
3853 /* If we can swap euid and uid, then we can determine access rights
3854 * with a simple stat of the file, and then compare device and
3855 * inode to make sure we did stat() on the same file we opened.
3856 * Then we just have to make sure he or she can execute it.
3859 * As the script is opened by perl, not suidperl, we do not need to
3860 * care much about access rights.
3862 * The 'script changed' check is needed, or we can get lied to
3863 * about $0 with e.g.
3864 * suidperl /dev/fd/4//bin/x 4<setuidscript
3865 * Without HAS_SETREUID, is it safe to stat() as root?
3867 * Are there any operating systems that pass /dev/fd/xxx for setuid
3868 * scripts, as suggested/described in perlsec(1)? Surely they do not
3869 * pass the script name as we do, so the "script changed" test would
3870 * fail for them... but we never get here with
3871 * SETUID_SCRIPTS_ARE_SECURE_NOW defined.
3873 * This is one place where we must "lie" about return status: not
3874 * say if the stat() failed. We are doing this as root, and could
3875 * be tricked into reporting existence or not of files that the
3876 * "plain" user cannot even see.
3880 if (PerlLIO_stat(CopFILE(PL_curcop),&tmpstatbuf) < 0 ||
3881 tmpstatbuf.st_dev != PL_statbuf.st_dev ||
3882 tmpstatbuf.st_ino != PL_statbuf.st_ino) {
3883 Perl_croak(aTHX_ "Setuid script changed\n");
3887 if (!cando(S_IXUSR,FALSE,&PL_statbuf)) /* can real uid exec? */
3888 Perl_croak(aTHX_ "Real UID cannot exec script\n");
3891 * We used to do this check as the "plain" user (after swapping
3892 * UIDs). But the check for nosuid and noexec filesystem is needed,
3893 * and should be done even without HAS_SETREUID. (Maybe those
3894 * operating systems do not have such mount options anyway...)
3895 * Seems safe enough to do as root.
3897 # if !defined(NO_NOSUID_CHECK)
3898 if (fd_on_nosuid_fs(PerlIO_fileno(rsfp))) {
3899 Perl_croak(aTHX_ "Setuid script on nosuid or noexec filesystem\n");
3902 # endif /* IAMSUID */
3904 if (!S_ISREG(PL_statbuf.st_mode)) {
3905 Perl_croak(aTHX_ "Setuid script not plain file\n");
3907 if (PL_statbuf.st_mode & S_IWOTH)
3908 Perl_croak(aTHX_ "Setuid/gid script is writable by world");
3909 PL_doswitches = FALSE; /* -s is insecure in suid */
3910 /* PSz 13 Nov 03 But -s was caught elsewhere ... so unsetting it here is useless(?!) */
3911 CopLINE_inc(PL_curcop);
3912 if (sv_gets(linestr_sv, rsfp, 0) == NULL)
3913 Perl_croak(aTHX_ "No #! line");
3914 linestr = SvPV_nolen_const(linestr_sv);
3915 /* required even on Sys V */
3916 if (!*linestr || !linestr[1] || strnNE(linestr,"#!",2))
3917 Perl_croak(aTHX_ "No #! line");
3921 /* Sanity check on line length */
3922 s_end = s + strlen(s);
3923 if (s_end == s || (s_end - s) > 4000)
3924 Perl_croak(aTHX_ "Very long #! line");
3925 /* Allow more than a single space after #! */
3926 while (isSPACE(*s)) s++;
3927 /* Sanity check on buffer end */
3928 while ((*s) && !isSPACE(*s)) s++;
3929 for (s2 = s; (s2 > linestr &&
3930 (isDIGIT(s2[-1]) || s2[-1] == '.' || s2[-1] == '_'
3931 || s2[-1] == '-')); s2--) ;
3932 /* Sanity check on buffer start */
3933 if ( (s2-4 < linestr || strnNE(s2-4,"perl",4)) &&
3934 (s-9 < linestr || strnNE(s-9,"perl",4)) )
3935 Perl_croak(aTHX_ "Not a perl script");
3936 while (*s == ' ' || *s == '\t') s++;
3938 * #! arg must be what we saw above. They can invoke it by
3939 * mentioning suidperl explicitly, but they may not add any strange
3940 * arguments beyond what #! says if they do invoke suidperl that way.
3943 * The way validarg was set up, we rely on the kernel to start
3944 * scripts with argv[1] set to contain all #! line switches (the
3948 * Check that we got all the arguments listed in the #! line (not
3949 * just that there are no extraneous arguments). Might not matter
3950 * much, as switches from #! line seem to be acted upon (also), and
3951 * so may be checked and trapped in perl. But, security checks must
3952 * be done in suidperl and not deferred to perl. Note that suidperl
3953 * does not get around to parsing (and checking) the switches on
3954 * the #! line (but execs perl sooner).
3955 * Allow (require) a trailing newline (which may be of two
3956 * characters on some architectures?) (but no other trailing
3959 len = strlen(validarg);
3960 if (strEQ(validarg," PHOOEY ") ||
3961 strnNE(s,validarg,len) || !isSPACE(s[len]) ||
3962 !((s_end - s) == len+1
3963 || ((s_end - s) == len+2 && isSPACE(s[len+1]))))
3964 Perl_croak(aTHX_ "Args must match #! line");
3968 PL_euid != PL_uid && (PL_statbuf.st_mode & S_ISUID) &&
3969 PL_euid == PL_statbuf.st_uid)
3971 Perl_croak(aTHX_ "YOU HAVEN'T DISABLED SET-ID SCRIPTS IN THE KERNEL YET!\n\
3972 FIX YOUR KERNEL, OR PUT A C WRAPPER AROUND THIS SCRIPT!\n");
3973 # endif /* IAMSUID */
3976 PL_euid) { /* oops, we're not the setuid root perl */
3978 * When root runs a setuid script, we do not go through the same
3979 * steps of execing sperl and then perl with fd scripts, but
3980 * simply set up UIDs within the same perl invocation; so do
3981 * not have the same checks (on options, whatever) that we have
3982 * for plain users. No problem really: would have to be a script
3983 * that does not actually work for plain users; and if root is
3984 * foolish and can be persuaded to run such an unsafe script, he
3985 * might run also non-setuid ones, and deserves what he gets.
3987 * Or, we might drop the PL_euid check above (and rely just on
3988 * fdscript to avoid loops), and do the execs
3994 * Pass fd script to suidperl.
3995 * Exec suidperl, substituting fd script for scriptname.
3996 * Pass script name as "subdir" of fd, which perl will grok;
3997 * in fact will use that to distinguish this from "normal"
3998 * usage, see comments above.
4000 PerlIO_rewind(rsfp);
4001 PerlLIO_lseek(PerlIO_fileno(rsfp),(Off_t)0,0); /* just in case rewind didn't */
4002 /* PSz 27 Feb 04 Sanity checks on scriptname */
4003 if ((!scriptname) || (!*scriptname) ) {
4004 Perl_croak(aTHX_ "No setuid script name\n");
4006 if (*scriptname == '-') {
4007 Perl_croak(aTHX_ "Setuid script name may not begin with dash\n");
4008 /* Or we might confuse it with an option when replacing
4009 * name in argument list, below (though we do pointer, not
4010 * string, comparisons).
4013 for (which = 1; PL_origargv[which] && PL_origargv[which] != scriptname; which++) ;
4014 if (!PL_origargv[which]) {
4015 Perl_croak(aTHX_ "Can't change argv to have fd script\n");
4017 PL_origargv[which] = savepv(Perl_form(aTHX_ "/dev/fd/%d/%s",
4018 PerlIO_fileno(rsfp), PL_origargv[which]));
4019 # if defined(HAS_FCNTL) && defined(F_SETFD)
4020 fcntl(PerlIO_fileno(rsfp),F_SETFD,0); /* ensure no close-on-exec */
4023 PerlProc_execv(Perl_form(aTHX_ "%s/sperl"PERL_FS_VER_FMT, BIN_EXP,
4024 (int)PERL_REVISION, (int)PERL_VERSION,
4025 (int)PERL_SUBVERSION), PL_origargv);
4027 # endif /* IAMSUID */
4028 Perl_croak(aTHX_ "Can't do setuid (cannot exec sperl)\n");
4031 if (PL_statbuf.st_mode & S_ISGID && PL_statbuf.st_gid != PL_egid) {
4033 * This seems back to front: we try HAS_SETEGID first; if not available
4034 * then try HAS_SETREGID; as a last chance we try HAS_SETRESGID. May be OK
4035 * in the sense that we only want to set EGID; but are there any machines
4036 * with either of the latter, but not the former? Same with UID, later.
4039 (void)setegid(PL_statbuf.st_gid);
4041 # ifdef HAS_SETREGID
4042 (void)setregid((Gid_t)-1,PL_statbuf.st_gid);
4044 # ifdef HAS_SETRESGID
4045 (void)setresgid((Gid_t)-1,PL_statbuf.st_gid,(Gid_t)-1);
4047 PerlProc_setgid(PL_statbuf.st_gid);
4051 if (PerlProc_getegid() != PL_statbuf.st_gid)
4052 Perl_croak(aTHX_ "Can't do setegid!\n");
4054 if (PL_statbuf.st_mode & S_ISUID) {
4055 if (PL_statbuf.st_uid != PL_euid)
4057 (void)seteuid(PL_statbuf.st_uid); /* all that for this */
4059 # ifdef HAS_SETREUID
4060 (void)setreuid((Uid_t)-1,PL_statbuf.st_uid);
4062 # ifdef HAS_SETRESUID
4063 (void)setresuid((Uid_t)-1,PL_statbuf.st_uid,(Uid_t)-1);
4065 PerlProc_setuid(PL_statbuf.st_uid);
4069 if (PerlProc_geteuid() != PL_statbuf.st_uid)
4070 Perl_croak(aTHX_ "Can't do seteuid!\n");
4072 else if (PL_uid) { /* oops, mustn't run as root */
4074 (void)seteuid((Uid_t)PL_uid);
4076 # ifdef HAS_SETREUID
4077 (void)setreuid((Uid_t)-1,(Uid_t)PL_uid);
4079 # ifdef HAS_SETRESUID
4080 (void)setresuid((Uid_t)-1,(Uid_t)PL_uid,(Uid_t)-1);
4082 PerlProc_setuid((Uid_t)PL_uid);
4086 if (PerlProc_geteuid() != PL_uid)
4087 Perl_croak(aTHX_ "Can't do seteuid!\n");
4090 if (!cando(S_IXUSR,TRUE,&PL_statbuf))
4091 Perl_croak(aTHX_ "Effective UID cannot exec script\n"); /* they can't do this */
4094 else if (fdscript < 0 || !suidscript)
4095 /* PSz 13 Nov 03 Caught elsewhere, useless(?!) here */
4096 Perl_croak(aTHX_ "(suid) fdscript needed in suidperl\n");
4098 /* PSz 16 Sep 03 Keep neat error message */
4099 Perl_croak(aTHX_ "Script is not setuid/setgid in suidperl\n");
4102 /* We absolutely must clear out any saved ids here, so we */
4103 /* exec the real perl, substituting fd script for scriptname. */
4104 /* (We pass script name as "subdir" of fd, which perl will grok.) */
4106 * It might be thought that using setresgid and/or setresuid (changed to
4107 * set the saved IDs) above might obviate the need to exec, and we could
4108 * go on to "do the perl thing".
4110 * Is there such a thing as "saved GID", and is that set for setuid (but
4111 * not setgid) execution like suidperl? Without exec, it would not be
4112 * cleared for setuid (but not setgid) scripts (or might need a dummy
4115 * We need suidperl to do the exact same argument checking that perl
4116 * does. Thus it cannot be very small; while it could be significantly
4117 * smaller, it is safer (simpler?) to make it essentially the same
4118 * binary as perl (but they are not identical). - Maybe could defer that
4119 * check to the invoked perl, and suidperl be a tiny wrapper instead;
4120 * but prefer to do thorough checks in suidperl itself. Such deferral
4121 * would make suidperl security rely on perl, a design no-no.
4123 * Setuid things should be short and simple, thus easy to understand and
4124 * verify. They should do their "own thing", without influence by
4125 * attackers. It may help if their internal execution flow is fixed,
4126 * regardless of platform: it may be best to exec anyway.
4128 * Suidperl should at least be conceptually simple: a wrapper only,
4129 * never to do any real perl. Maybe we should put
4131 * Perl_croak(aTHX_ "Suidperl should never do real perl\n");
4133 * into the perly bits.
4135 PerlIO_rewind(rsfp);
4136 PerlLIO_lseek(PerlIO_fileno(rsfp),(Off_t)0,0); /* just in case rewind didn't */
4138 * Keep original arguments: suidperl already has fd script.
4140 # if defined(HAS_FCNTL) && defined(F_SETFD)
4141 fcntl(PerlIO_fileno(rsfp),F_SETFD,0); /* ensure no close-on-exec */
4144 PerlProc_execv(Perl_form(aTHX_ "%s/perl"PERL_FS_VER_FMT, BIN_EXP,
4145 (int)PERL_REVISION, (int)PERL_VERSION,
4146 (int)PERL_SUBVERSION), PL_origargv);/* try again */
4148 Perl_croak(aTHX_ "Can't do setuid (suidperl cannot exec perl)\n");
4149 # endif /* IAMSUID */
4154 # ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
4155 /* Don't even need this function. */
4158 S_validate_suid(pTHX_ PerlIO *rsfp)
4160 if (PL_euid != PL_uid || PL_egid != PL_gid) { /* (suidperl doesn't exist, in fact) */
4161 # ifndef SETUID_SCRIPTS_ARE_SECURE_NOW
4162 PerlLIO_fstat(PerlIO_fileno(rsfp),&PL_statbuf); /* may be either wrapped or real suid */
4163 if ((PL_euid != PL_uid && PL_euid == PL_statbuf.st_uid && PL_statbuf.st_mode & S_ISUID)
4165 (PL_egid != PL_gid && PL_egid == PL_statbuf.st_gid && PL_statbuf.st_mode & S_ISGID)
4168 Perl_croak(aTHX_ "YOU HAVEN'T DISABLED SET-ID SCRIPTS IN THE KERNEL YET!\n\
4169 FIX YOUR KERNEL, PUT A C WRAPPER AROUND THIS SCRIPT, OR USE -u AND UNDUMP!\n");
4170 # endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4171 /* not set-id, must be wrapped */
4174 # endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4178 S_find_beginning(pTHX_ SV* linestr_sv, PerlIO *rsfp)
4182 register const char *s2;
4183 #ifdef MACOS_TRADITIONAL
4187 /* skip forward in input to the real script? */
4189 #ifdef MACOS_TRADITIONAL
4190 /* Since the Mac OS does not honor #! arguments for us, we do it ourselves */
4192 while (PL_doextract || gMacPerl_AlwaysExtract) {
4193 if ((s = sv_gets(linestr_sv, rsfp, 0)) == NULL) {
4194 if (!gMacPerl_AlwaysExtract)
4195 Perl_croak(aTHX_ "No Perl script found in input\n");
4197 if (PL_doextract) /* require explicit override ? */
4198 if (!OverrideExtract(PL_origfilename))
4199 Perl_croak(aTHX_ "User aborted script\n");
4201 PL_doextract = FALSE;
4203 /* Pater peccavi, file does not have #! */
4204 PerlIO_rewind(rsfp);
4209 while (PL_doextract) {
4210 if ((s = sv_gets(linestr_sv, rsfp, 0)) == NULL)
4211 Perl_croak(aTHX_ "No Perl script found in input\n");
4214 if (*s == '#' && s[1] == '!' && ((s = instr(s,"perl")) || (s = instr(s2,"PERL")))) {
4215 PerlIO_ungetc(rsfp, '\n'); /* to keep line count right */
4216 PL_doextract = FALSE;
4217 while (*s && !(isSPACE (*s) || *s == '#')) s++;
4219 while (*s == ' ' || *s == '\t') s++;
4221 while (isDIGIT(s2[-1]) || s2[-1] == '-' || s2[-1] == '.'
4222 || s2[-1] == '_') s2--;
4223 if (strnEQ(s2-4,"perl",4))
4224 while ((s = moreswitches(s)))
4227 #ifdef MACOS_TRADITIONAL
4228 /* We are always searching for the #!perl line in MacPerl,
4229 * so if we find it, still keep the line count correct
4230 * by counting lines we already skipped over
4232 for (; maclines > 0 ; maclines--)
4233 PerlIO_ungetc(rsfp, '\n');
4237 /* gMacPerl_AlwaysExtract is false in MPW tool */
4238 } else if (gMacPerl_AlwaysExtract) {
4250 PL_uid = PerlProc_getuid();
4251 PL_euid = PerlProc_geteuid();
4252 PL_gid = PerlProc_getgid();
4253 PL_egid = PerlProc_getegid();
4255 PL_uid |= PL_gid << 16;
4256 PL_euid |= PL_egid << 16;
4258 /* Should not happen: */
4259 CHECK_MALLOC_TAINT(PL_uid && (PL_euid != PL_uid || PL_egid != PL_gid));
4260 PL_tainting |= (PL_uid && (PL_euid != PL_uid || PL_egid != PL_gid));
4263 * Should go by suidscript, not uid!=euid: why disallow
4264 * system("ls") in scripts run from setuid things?
4265 * Or, is this run before we check arguments and set suidscript?
4266 * What about SETUID_SCRIPTS_ARE_SECURE_NOW: could we use fdscript then?
4267 * (We never have suidscript, can we be sure to have fdscript?)
4268 * Or must then go by UID checks? See comments in forbid_setid also.
4272 /* This is used very early in the lifetime of the program,
4273 * before even the options are parsed, so PL_tainting has
4274 * not been initialized properly. */
4276 Perl_doing_taint(int argc, char *argv[], char *envp[])
4278 #ifndef PERL_IMPLICIT_SYS
4279 /* If we have PERL_IMPLICIT_SYS we can't call getuid() et alia
4280 * before we have an interpreter-- and the whole point of this
4281 * function is to be called at such an early stage. If you are on
4282 * a system with PERL_IMPLICIT_SYS but you do have a concept of
4283 * "tainted because running with altered effective ids', you'll
4284 * have to add your own checks somewhere in here. The two most
4285 * known samples of 'implicitness' are Win32 and NetWare, neither
4286 * of which has much of concept of 'uids'. */
4287 int uid = PerlProc_getuid();
4288 int euid = PerlProc_geteuid();
4289 int gid = PerlProc_getgid();
4290 int egid = PerlProc_getegid();
4297 if (uid && (euid != uid || egid != gid))
4299 #endif /* !PERL_IMPLICIT_SYS */
4300 /* This is a really primitive check; environment gets ignored only
4301 * if -T are the first chars together; otherwise one gets
4302 * "Too late" message. */
4303 if ( argc > 1 && argv[1][0] == '-'
4304 && (argv[1][1] == 't' || argv[1][1] == 'T') )
4309 /* Passing the flag as a single char rather than a string is a slight space
4310 optimisation. The only message that isn't /^-.$/ is
4311 "program input from stdin", which is substituted in place of '\0', which
4312 could never be a command line flag. */
4314 S_forbid_setid(pTHX_ const char flag, const bool suidscript) /* g */
4317 char string[3] = "-x";
4318 const char *message = "program input from stdin";
4325 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
4326 if (PL_euid != PL_uid)
4327 Perl_croak(aTHX_ "No %s allowed while running setuid", message);
4328 if (PL_egid != PL_gid)
4329 Perl_croak(aTHX_ "No %s allowed while running setgid", message);
4330 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4332 * Checks for UID/GID above "wrong": why disallow
4333 * perl -e 'print "Hello\n"'
4334 * from within setuid things?? Simply drop them: replaced by
4335 * fdscript/suidscript and #ifdef IAMSUID checks below.
4337 * This may be too late for command-line switches. Will catch those on
4338 * the #! line, after finding the script name and setting up
4339 * fdscript/suidscript. Note that suidperl does not get around to
4340 * parsing (and checking) the switches on the #! line, but checks that
4341 * the two sets are identical.
4343 * With SETUID_SCRIPTS_ARE_SECURE_NOW, could we use fdscript, also or
4344 * instead, or would that be "too late"? (We never have suidscript, can
4345 * we be sure to have fdscript?)
4347 * Catch things with suidscript (in descendant of suidperl), even with
4348 * right UID/GID. Was already checked in suidperl, with #ifdef IAMSUID,
4349 * below; but I am paranoid.
4351 * Also see comments about root running a setuid script, elsewhere.
4354 Perl_croak(aTHX_ "No %s allowed with (suid) fdscript", message);
4356 /* PSz 11 Nov 03 Catch it in suidperl, always! */
4357 Perl_croak(aTHX_ "No %s allowed in suidperl", message);
4358 #endif /* IAMSUID */
4362 Perl_init_debugger(pTHX)
4365 HV * const ostash = PL_curstash;
4367 PL_curstash = PL_debstash;
4368 PL_dbargs = GvAV(gv_AVadd((gv_fetchpvs("DB::args", GV_ADDMULTI,
4370 AvREAL_off(PL_dbargs);
4371 PL_DBgv = gv_fetchpvs("DB::DB", GV_ADDMULTI, SVt_PVGV);
4372 PL_DBline = gv_fetchpvs("DB::dbline", GV_ADDMULTI, SVt_PVAV);
4373 PL_DBsub = gv_HVadd(gv_fetchpvs("DB::sub", GV_ADDMULTI, SVt_PVHV));
4374 PL_DBsingle = GvSV((gv_fetchpvs("DB::single", GV_ADDMULTI, SVt_PV)));
4375 sv_setiv(PL_DBsingle, 0);
4376 PL_DBtrace = GvSV((gv_fetchpvs("DB::trace", GV_ADDMULTI, SVt_PV)));
4377 sv_setiv(PL_DBtrace, 0);
4378 PL_DBsignal = GvSV((gv_fetchpvs("DB::signal", GV_ADDMULTI, SVt_PV)));
4379 sv_setiv(PL_DBsignal, 0);
4380 PL_curstash = ostash;
4383 #ifndef STRESS_REALLOC
4384 #define REASONABLE(size) (size)
4386 #define REASONABLE(size) (1) /* unreasonable */
4390 Perl_init_stacks(pTHX)
4393 /* start with 128-item stack and 8K cxstack */
4394 PL_curstackinfo = new_stackinfo(REASONABLE(128),
4395 REASONABLE(8192/sizeof(PERL_CONTEXT) - 1));
4396 PL_curstackinfo->si_type = PERLSI_MAIN;
4397 PL_curstack = PL_curstackinfo->si_stack;
4398 PL_mainstack = PL_curstack; /* remember in case we switch stacks */
4400 PL_stack_base = AvARRAY(PL_curstack);
4401 PL_stack_sp = PL_stack_base;
4402 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
4404 Newx(PL_tmps_stack,REASONABLE(128),SV*);
4407 PL_tmps_max = REASONABLE(128);
4409 Newx(PL_markstack,REASONABLE(32),I32);
4410 PL_markstack_ptr = PL_markstack;
4411 PL_markstack_max = PL_markstack + REASONABLE(32);
4415 Newx(PL_scopestack,REASONABLE(32),I32);
4416 PL_scopestack_ix = 0;
4417 PL_scopestack_max = REASONABLE(32);
4419 Newx(PL_savestack,REASONABLE(128),ANY);
4420 PL_savestack_ix = 0;
4421 PL_savestack_max = REASONABLE(128);
4430 while (PL_curstackinfo->si_next)
4431 PL_curstackinfo = PL_curstackinfo->si_next;
4432 while (PL_curstackinfo) {
4433 PERL_SI *p = PL_curstackinfo->si_prev;
4434 /* curstackinfo->si_stack got nuked by sv_free_arenas() */
4435 Safefree(PL_curstackinfo->si_cxstack);
4436 Safefree(PL_curstackinfo);
4437 PL_curstackinfo = p;
4439 Safefree(PL_tmps_stack);
4440 Safefree(PL_markstack);
4441 Safefree(PL_scopestack);
4442 Safefree(PL_savestack);
4447 S_init_predump_symbols(pTHX)
4453 sv_setpvn(get_sv("\"", TRUE), " ", 1);
4454 PL_stdingv = gv_fetchpvs("STDIN", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4455 GvMULTI_on(PL_stdingv);
4456 io = GvIOp(PL_stdingv);
4457 IoTYPE(io) = IoTYPE_RDONLY;
4458 IoIFP(io) = PerlIO_stdin();
4459 tmpgv = gv_fetchpvs("stdin", GV_ADD|GV_NOTQUAL, SVt_PV);
4461 GvIOp(tmpgv) = (IO*)SvREFCNT_inc_simple(io);
4463 tmpgv = gv_fetchpvs("STDOUT", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4466 IoTYPE(io) = IoTYPE_WRONLY;
4467 IoOFP(io) = IoIFP(io) = PerlIO_stdout();
4469 tmpgv = gv_fetchpvs("stdout", GV_ADD|GV_NOTQUAL, SVt_PV);
4471 GvIOp(tmpgv) = (IO*)SvREFCNT_inc_simple(io);
4473 PL_stderrgv = gv_fetchpvs("STDERR", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4474 GvMULTI_on(PL_stderrgv);
4475 io = GvIOp(PL_stderrgv);
4476 IoTYPE(io) = IoTYPE_WRONLY;
4477 IoOFP(io) = IoIFP(io) = PerlIO_stderr();
4478 tmpgv = gv_fetchpvs("stderr", GV_ADD|GV_NOTQUAL, SVt_PV);
4480 GvIOp(tmpgv) = (IO*)SvREFCNT_inc_simple(io);
4482 PL_statname = newSV(0); /* last filename we did stat on */
4484 Safefree(PL_osname);
4485 PL_osname = savepv(OSNAME);
4489 Perl_init_argv_symbols(pTHX_ register int argc, register char **argv)
4492 argc--,argv++; /* skip name of script */
4493 if (PL_doswitches) {
4494 for (; argc > 0 && **argv == '-'; argc--,argv++) {
4498 if (argv[0][1] == '-' && !argv[0][2]) {
4502 if ((s = strchr(argv[0], '='))) {
4503 const char *const start_name = argv[0] + 1;
4504 sv_setpv(GvSV(gv_fetchpvn_flags(start_name, s - start_name,
4505 TRUE, SVt_PV)), s + 1);
4508 sv_setiv(GvSV(gv_fetchpv(argv[0]+1, GV_ADD, SVt_PV)),1);
4511 if ((PL_argvgv = gv_fetchpvs("ARGV", GV_ADD|GV_NOTQUAL, SVt_PVAV))) {
4512 GvMULTI_on(PL_argvgv);
4513 (void)gv_AVadd(PL_argvgv);
4514 av_clear(GvAVn(PL_argvgv));
4515 for (; argc > 0; argc--,argv++) {
4516 SV * const sv = newSVpv(argv[0],0);
4517 av_push(GvAVn(PL_argvgv),sv);
4518 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
4519 if (PL_unicode & PERL_UNICODE_ARGV_FLAG)
4522 if (PL_unicode & PERL_UNICODE_WIDESYSCALLS_FLAG) /* Sarathy? */
4523 (void)sv_utf8_decode(sv);
4529 S_init_postdump_symbols(pTHX_ register int argc, register char **argv, register char **env)
4534 PL_toptarget = newSV_type(SVt_PVFM);
4535 sv_setpvn(PL_toptarget, "", 0);
4536 PL_bodytarget = newSV_type(SVt_PVFM);
4537 sv_setpvn(PL_bodytarget, "", 0);
4538 PL_formtarget = PL_bodytarget;
4542 init_argv_symbols(argc,argv);
4544 if ((tmpgv = gv_fetchpvs("0", GV_ADD|GV_NOTQUAL, SVt_PV))) {
4545 #ifdef MACOS_TRADITIONAL
4546 /* $0 is not majick on a Mac */
4547 sv_setpv(GvSV(tmpgv),MacPerl_MPWFileName(PL_origfilename));
4549 sv_setpv(GvSV(tmpgv),PL_origfilename);
4550 magicname("0", "0", 1);
4553 if ((PL_envgv = gv_fetchpvs("ENV", GV_ADD|GV_NOTQUAL, SVt_PVHV))) {
4555 bool env_is_not_environ;
4556 GvMULTI_on(PL_envgv);
4557 hv = GvHVn(PL_envgv);
4558 hv_magic(hv, NULL, PERL_MAGIC_env);
4560 #ifdef USE_ENVIRON_ARRAY
4561 /* Note that if the supplied env parameter is actually a copy
4562 of the global environ then it may now point to free'd memory
4563 if the environment has been modified since. To avoid this
4564 problem we treat env==NULL as meaning 'use the default'
4568 env_is_not_environ = env != environ;
4569 if (env_is_not_environ
4570 # ifdef USE_ITHREADS
4571 && PL_curinterp == aTHX
4580 for (; *env; env++) {
4581 if (!(s = strchr(*env,'=')) || s == *env)
4583 #if defined(MSDOS) && !defined(DJGPP)
4588 sv = newSVpv(s+1, 0);
4589 (void)hv_store(hv, *env, s - *env, sv, 0);
4590 if (env_is_not_environ)
4594 #endif /* USE_ENVIRON_ARRAY */
4595 #endif /* !PERL_MICRO */
4598 if ((tmpgv = gv_fetchpvs("$", GV_ADD|GV_NOTQUAL, 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);
4614 S_init_perllib(pTHX)
4620 s = PerlEnv_getenv("PERL5LIB");
4622 * It isn't possible to delete an environment variable with
4623 * PERL_USE_SAFE_PUTENV set unless unsetenv() is also available, so in that
4624 * case we treat PERL5LIB as undefined if it has a zero-length value.
4626 #if defined(PERL_USE_SAFE_PUTENV) && ! defined(HAS_UNSETENV)
4627 if (s && *s != '\0')
4631 incpush(s, TRUE, TRUE, TRUE, FALSE);
4633 incpush(PerlEnv_getenv("PERLLIB"), FALSE, FALSE, TRUE, FALSE);
4635 /* Treat PERL5?LIB as a possible search list logical name -- the
4636 * "natural" VMS idiom for a Unix path string. We allow each
4637 * element to be a set of |-separated directories for compatibility.
4641 if (my_trnlnm("PERL5LIB",buf,0))
4642 do { incpush(buf,TRUE,TRUE,TRUE,FALSE); } while (my_trnlnm("PERL5LIB",buf,++idx));
4644 while (my_trnlnm("PERLLIB",buf,idx++)) incpush(buf,FALSE,FALSE,TRUE,FALSE);
4648 /* Use the ~-expanded versions of APPLLIB (undocumented),
4649 ARCHLIB PRIVLIB SITEARCH SITELIB VENDORARCH and VENDORLIB
4652 incpush(APPLLIB_EXP, TRUE, TRUE, TRUE, TRUE);
4656 incpush(ARCHLIB_EXP, FALSE, FALSE, TRUE, TRUE);
4658 #ifdef MACOS_TRADITIONAL
4661 SV * privdir = newSV(0);
4662 char * macperl = PerlEnv_getenv("MACPERL");
4667 Perl_sv_setpvf(aTHX_ privdir, "%slib:", macperl);
4668 if (PerlLIO_stat(SvPVX(privdir), &tmpstatbuf) >= 0 && S_ISDIR(tmpstatbuf.st_mode))
4669 incpush(SvPVX(privdir), TRUE, FALSE, TRUE, FALSE);
4670 Perl_sv_setpvf(aTHX_ privdir, "%ssite_perl:", macperl);
4671 if (PerlLIO_stat(SvPVX(privdir), &tmpstatbuf) >= 0 && S_ISDIR(tmpstatbuf.st_mode))
4672 incpush(SvPVX(privdir), TRUE, FALSE, TRUE, FALSE);
4674 SvREFCNT_dec(privdir);
4677 incpush(":", FALSE, FALSE, TRUE, FALSE);
4680 # define PRIVLIB_EXP "/usr/local/lib/perl5:/usr/local/lib/perl"
4683 incpush(PRIVLIB_EXP, TRUE, FALSE, TRUE, TRUE);
4685 incpush(PRIVLIB_EXP, FALSE, FALSE, TRUE, TRUE);
4689 /* sitearch is always relative to sitelib on Windows for
4690 * DLL-based path intuition to work correctly */
4691 # if !defined(WIN32)
4692 incpush(SITEARCH_EXP, FALSE, FALSE, TRUE, TRUE);
4698 /* this picks up sitearch as well */
4699 incpush(SITELIB_EXP, TRUE, FALSE, TRUE, TRUE);
4701 incpush(SITELIB_EXP, FALSE, FALSE, TRUE, TRUE);
4705 #if defined(SITELIB_STEM) && defined(PERL_INC_VERSION_LIST)
4706 /* Search for version-specific dirs below here */
4707 incpush(SITELIB_STEM, FALSE, TRUE, TRUE, TRUE);
4710 #ifdef PERL_VENDORARCH_EXP
4711 /* vendorarch is always relative to vendorlib on Windows for
4712 * DLL-based path intuition to work correctly */
4713 # if !defined(WIN32)
4714 incpush(PERL_VENDORARCH_EXP, FALSE, FALSE, TRUE, TRUE);
4718 #ifdef PERL_VENDORLIB_EXP
4720 incpush(PERL_VENDORLIB_EXP, TRUE, FALSE, TRUE, TRUE); /* this picks up vendorarch as well */
4722 incpush(PERL_VENDORLIB_EXP, FALSE, FALSE, TRUE, TRUE);
4726 #ifdef PERL_VENDORLIB_STEM /* Search for version-specific dirs below here */
4727 incpush(PERL_VENDORLIB_STEM, FALSE, TRUE, TRUE, TRUE);
4730 #ifdef PERL_OTHERLIBDIRS
4731 incpush(PERL_OTHERLIBDIRS, TRUE, TRUE, TRUE, TRUE);
4735 incpush(".", FALSE, FALSE, TRUE, FALSE);
4736 #endif /* MACOS_TRADITIONAL */
4739 #if defined(DOSISH) || defined(EPOC) || defined(__SYMBIAN32__)
4740 # define PERLLIB_SEP ';'
4743 # define PERLLIB_SEP '|'
4745 # if defined(MACOS_TRADITIONAL)
4746 # define PERLLIB_SEP ','
4748 # define PERLLIB_SEP ':'
4752 #ifndef PERLLIB_MANGLE
4753 # define PERLLIB_MANGLE(s,n) (s)
4756 /* Push a directory onto @INC if it exists.
4757 Generate a new SV if we do this, to save needing to copy the SV we push
4760 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,
4778 const char *p = dir;
4783 if (addsubdirs || addoldvers) {
4787 /* Break at all separators */
4789 SV *libdir = newSV(0);
4792 /* skip any consecutive separators */
4794 while ( *p == PERLLIB_SEP ) {