3 * Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001
4 * 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
12 * A ship then new they built for him
13 * of mithril and of elven-glass
14 * --from Bilbo's song of EƤrendil
16 * [p.236 of _The Lord of the Rings_, II/i: "Many Meetings"]
19 /* This file contains the top-level functions that are used to create, use
20 * and destroy a perl interpreter, plus the functions used by XS code to
21 * call back into perl. Note that it does not contain the actual main()
22 * function of the interpreter; that can be found in perlmain.c
27 * Be proud that perl(1) may proclaim:
28 * Setuid Perl scripts are safer than C programs ...
29 * Do not abandon (deprecate) suidperl. Do not advocate C wrappers.
31 * The flow was: perl starts, notices script is suid, execs suidperl with same
32 * arguments; suidperl opens script, checks many things, sets itself with
33 * right UID, execs perl with similar arguments but with script pre-opened on
34 * /dev/fd/xxx; perl checks script is as should be and does work. This was
35 * insecure: see perlsec(1) for many problems with this approach.
37 * The "correct" flow should be: perl starts, opens script and notices it is
38 * suid, checks many things, execs suidperl with similar arguments but with
39 * script on /dev/fd/xxx; suidperl checks script and /dev/fd/xxx object are
40 * same, checks arguments match #! line, sets itself with right UID, execs
41 * perl with same arguments; perl checks many things and does work.
43 * (Opening the script in perl instead of suidperl, we "lose" scripts that
44 * are readable to the target UID but not to the invoker. Where did
45 * unreadable scripts work anyway?)
47 * For now, suidperl and perl are pretty much the same large and cumbersome
48 * program, so suidperl can check its argument list (see comments elsewhere).
51 * Original bug report:
52 * http://bugs.perl.org/index.html?req=bug_id&bug_id=20010322.218
53 * http://rt.perl.org/rt2/Ticket/Display.html?id=6511
54 * Comments and discussion with Debian:
55 * http://bugs.debian.org/203426
56 * http://bugs.debian.org/220486
57 * Debian Security Advisory DSA 431-1 (does not fully fix problem):
58 * http://www.debian.org/security/2004/dsa-431
60 * http://cve.mitre.org/cgi-bin/cvename.cgi?name=CAN-2003-0618
61 * Previous versions of this patch sent to perl5-porters:
62 * http://www.mail-archive.com/perl5-porters@perl.org/msg71953.html
63 * http://www.mail-archive.com/perl5-porters@perl.org/msg75245.html
64 * http://www.mail-archive.com/perl5-porters@perl.org/msg75563.html
65 * http://www.mail-archive.com/perl5-porters@perl.org/msg75635.html
67 Paul Szabo - psz@maths.usyd.edu.au http://www.maths.usyd.edu.au:8000/u/psz/
68 School of Mathematics and Statistics University of Sydney 2006 Australia
72 * Use truthful, neat, specific error messages.
73 * Cannot always hide the truth; security must not depend on doing so.
77 * Use global(?), thread-local fdscript for easier checks.
78 * (I do not understand how we could possibly get a thread race:
79 * do not all threads go through the same initialization? Or in
80 * fact, are not threads started only after we get the script and
81 * so know what to do? Oh well, make things super-safe...)
85 #define PERL_IN_PERL_C
87 #include "patchlevel.h" /* for local_patches */
91 char *nw_get_sitelib(const char *pl);
94 /* XXX If this causes problems, set i_unistd=undef in the hint file. */
99 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
101 # include <sys/wait.h>
104 # include <sys/uio.h>
109 char control[CMSG_SPACE(sizeof(int))];
126 #if !defined(STANDARD_C) && !defined(HAS_GETENV_PROTOTYPE) && !defined(PERL_MICRO)
127 char *getenv (char *); /* Usually in <stdlib.h> */
130 static I32 read_e_script(pTHX_ int idx, SV *buf_sv, int maxlen);
134 /* Drop scriptname */
135 # define validate_suid(validarg, scriptname, fdscript, suidscript, linestr_sv, rsfp) S_validate_suid(aTHX_ validarg, fdscript, suidscript, linestr_sv, rsfp)
137 /* Drop suidscript */
138 # define validate_suid(validarg, scriptname, fdscript, suidscript, linestr_sv, rsfp) S_validate_suid(aTHX_ validarg, scriptname, fdscript, linestr_sv, rsfp)
141 # ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
142 /* Drop everything. Heck, don't even try to call it */
143 # define validate_suid(validarg, scriptname, fdscript, suidscript, linestr_sv, rsfp) NOOP
145 /* Drop almost everything */
146 # define validate_suid(validarg, scriptname, fdscript, suidscript, linestr_sv, rsfp) S_validate_suid(aTHX_ rsfp)
150 #define CALL_BODY_EVAL(myop) \
151 if (PL_op == (myop)) \
152 PL_op = PL_ppaddr[OP_ENTEREVAL](aTHX); \
156 #define CALL_BODY_SUB(myop) \
157 if (PL_op == (myop)) \
158 PL_op = PL_ppaddr[OP_ENTERSUB](aTHX); \
162 #define CALL_LIST_BODY(cv) \
163 PUSHMARK(PL_stack_sp); \
164 call_sv(MUTABLE_SV((cv)), G_EVAL|G_DISCARD);
167 S_init_tls_and_interp(PerlInterpreter *my_perl)
171 PERL_SET_INTERP(my_perl);
172 #if defined(USE_ITHREADS)
175 PERL_SET_THX(my_perl);
178 MUTEX_INIT(&PL_dollarzero_mutex);
180 #ifdef PERL_IMPLICIT_CONTEXT
181 MUTEX_INIT(&PL_my_ctx_mutex);
184 #if defined(USE_ITHREADS)
187 /* This always happens for non-ithreads */
190 PERL_SET_THX(my_perl);
195 /* these implement the PERL_SYS_INIT, PERL_SYS_INIT3, PERL_SYS_TERM macros */
198 Perl_sys_init(int* argc, char*** argv)
202 PERL_ARGS_ASSERT_SYS_INIT;
204 PERL_UNUSED_ARG(argc); /* may not be used depending on _BODY macro */
205 PERL_UNUSED_ARG(argv);
206 PERL_SYS_INIT_BODY(argc, argv);
210 Perl_sys_init3(int* argc, char*** argv, char*** env)
214 PERL_ARGS_ASSERT_SYS_INIT3;
216 PERL_UNUSED_ARG(argc); /* may not be used depending on _BODY macro */
217 PERL_UNUSED_ARG(argv);
218 PERL_UNUSED_ARG(env);
219 PERL_SYS_INIT3_BODY(argc, argv, env);
226 if (!PL_veto_cleanup) {
227 PERL_SYS_TERM_BODY();
232 #ifdef PERL_IMPLICIT_SYS
234 perl_alloc_using(struct IPerlMem* ipM, struct IPerlMem* ipMS,
235 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
236 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
237 struct IPerlDir* ipD, struct IPerlSock* ipS,
238 struct IPerlProc* ipP)
240 PerlInterpreter *my_perl;
242 PERL_ARGS_ASSERT_PERL_ALLOC_USING;
244 /* Newx() needs interpreter, so call malloc() instead */
245 my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
246 S_init_tls_and_interp(my_perl);
247 Zero(my_perl, 1, PerlInterpreter);
257 INIT_TRACK_MEMPOOL(PL_memory_debug_header, my_perl);
264 =head1 Embedding Functions
266 =for apidoc perl_alloc
268 Allocates a new Perl interpreter. See L<perlembed>.
276 PerlInterpreter *my_perl;
278 /* Newx() needs interpreter, so call malloc() instead */
279 my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
281 S_init_tls_and_interp(my_perl);
282 #ifndef PERL_TRACK_MEMPOOL
283 return (PerlInterpreter *) ZeroD(my_perl, 1, PerlInterpreter);
285 Zero(my_perl, 1, PerlInterpreter);
286 INIT_TRACK_MEMPOOL(PL_memory_debug_header, my_perl);
290 #endif /* PERL_IMPLICIT_SYS */
293 =for apidoc perl_construct
295 Initializes a new Perl interpreter. See L<perlembed>.
301 perl_construct(pTHXx)
305 PERL_ARGS_ASSERT_PERL_CONSTRUCT;
309 PL_perl_destruct_level = 1;
311 PERL_UNUSED_ARG(my_perl);
312 if (PL_perl_destruct_level > 0)
315 PL_curcop = &PL_compiling; /* needed by ckWARN, right away */
317 /* set read-only and try to insure than we wont see REFCNT==0
320 SvREADONLY_on(&PL_sv_undef);
321 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
323 sv_setpv(&PL_sv_no,PL_No);
324 /* value lookup in void context - happens to have the side effect
325 of caching the numeric forms. However, as &PL_sv_no doesn't contain
326 a string that is a valid numer, we have to turn the public flags by
332 SvREADONLY_on(&PL_sv_no);
333 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
335 sv_setpv(&PL_sv_yes,PL_Yes);
338 SvREADONLY_on(&PL_sv_yes);
339 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
341 SvREADONLY_on(&PL_sv_placeholder);
342 SvREFCNT(&PL_sv_placeholder) = (~(U32)0)/2;
344 PL_sighandlerp = (Sighandler_t) Perl_sighandler;
345 #ifdef PERL_USES_PL_PIDSTATUS
346 PL_pidstatus = newHV();
349 PL_rs = newSVpvs("\n");
359 SET_NUMERIC_STANDARD();
361 #if defined(LOCAL_PATCH_COUNT)
362 PL_localpatches = local_patches; /* For possible -v */
365 #ifdef HAVE_INTERP_INTERN
369 PerlIO_init(aTHX); /* Hook to IO system */
371 PL_fdpid = newAV(); /* for remembering popen pids by fd */
372 PL_modglobal = newHV(); /* pointers to per-interpreter module globals */
373 PL_errors = newSVpvs("");
374 sv_setpvs(PERL_DEBUG_PAD(0), ""); /* For regex debugging. */
375 sv_setpvs(PERL_DEBUG_PAD(1), ""); /* ext/re needs these */
376 sv_setpvs(PERL_DEBUG_PAD(2), ""); /* even without DEBUGGING. */
378 /* First entry is a list of empty elements. It needs to be initialised
379 else all hell breaks loose in S_find_uninit_var(). */
380 Perl_av_create_and_push(aTHX_ &PL_regex_padav, newSVpvs(""));
381 PL_regex_pad = AvARRAY(PL_regex_padav);
383 #ifdef USE_REENTRANT_API
384 Perl_reentrant_init(aTHX);
387 /* Note that strtab is a rather special HV. Assumptions are made
388 about not iterating on it, and not adding tie magic to it.
389 It is properly deallocated in perl_destruct() */
392 HvSHAREKEYS_off(PL_strtab); /* mandatory */
393 hv_ksplit(PL_strtab, 512);
395 #if defined(__DYNAMIC__) && (defined(NeXT) || defined(__NeXT__))
396 _dyld_lookup_and_bind
397 ("__environ", (unsigned long *) &environ_pointer, NULL);
401 # ifdef USE_ENVIRON_ARRAY
402 PL_origenviron = environ;
406 /* Use sysconf(_SC_CLK_TCK) if available, if not
407 * available or if the sysconf() fails, use the HZ.
408 * BeOS has those, but returns the wrong value.
409 * The HZ if not originally defined has been by now
410 * been defined as CLK_TCK, if available. */
411 #if defined(HAS_SYSCONF) && defined(_SC_CLK_TCK) && !defined(__BEOS__)
412 PL_clocktick = sysconf(_SC_CLK_TCK);
413 if (PL_clocktick <= 0)
417 PL_stashcache = newHV();
419 PL_patchlevel = Perl_newSVpvf(aTHX_ "v%d.%d.%d", (int)PERL_REVISION,
420 (int)PERL_VERSION, (int)PERL_SUBVERSION);
423 if (!PL_mmap_page_size) {
424 #if defined(HAS_SYSCONF) && (defined(_SC_PAGESIZE) || defined(_SC_MMAP_PAGE_SIZE))
426 SETERRNO(0, SS_NORMAL);
428 PL_mmap_page_size = sysconf(_SC_PAGESIZE);
430 PL_mmap_page_size = sysconf(_SC_MMAP_PAGE_SIZE);
432 if ((long) PL_mmap_page_size < 0) {
434 SV * const error = ERRSV;
435 SvUPGRADE(error, SVt_PV);
436 Perl_croak(aTHX_ "panic: sysconf: %s", SvPV_nolen_const(error));
439 Perl_croak(aTHX_ "panic: sysconf: pagesize unknown");
443 # ifdef HAS_GETPAGESIZE
444 PL_mmap_page_size = getpagesize();
446 # if defined(I_SYS_PARAM) && defined(PAGESIZE)
447 PL_mmap_page_size = PAGESIZE; /* compiletime, bad */
451 if (PL_mmap_page_size <= 0)
452 Perl_croak(aTHX_ "panic: bad pagesize %" IVdf,
453 (IV) PL_mmap_page_size);
455 #endif /* HAS_MMAP */
457 #if defined(HAS_TIMES) && defined(PERL_NEED_TIMESBASE)
458 PL_timesbase.tms_utime = 0;
459 PL_timesbase.tms_stime = 0;
460 PL_timesbase.tms_cutime = 0;
461 PL_timesbase.tms_cstime = 0;
464 PL_registered_mros = newHV();
465 /* Start with 1 bucket, for DFS. It's unlikely we'll need more. */
466 HvMAX(PL_registered_mros) = 0;
472 =for apidoc nothreadhook
474 Stub that provides thread hook for perl_destruct when there are
481 Perl_nothreadhook(pTHX)
487 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
489 Perl_dump_sv_child(pTHX_ SV *sv)
492 const int sock = PL_dumper_fd;
493 const int debug_fd = PerlIO_fileno(Perl_debug_log);
494 union control_un control;
497 struct cmsghdr *cmptr;
499 unsigned char buffer[256];
501 PERL_ARGS_ASSERT_DUMP_SV_CHILD;
503 if(sock == -1 || debug_fd == -1)
506 PerlIO_flush(Perl_debug_log);
508 /* All these shenanigans are to pass a file descriptor over to our child for
509 it to dump out to. We can't let it hold open the file descriptor when it
510 forks, as the file descriptor it will dump to can turn out to be one end
511 of pipe that some other process will wait on for EOF. (So as it would
512 be open, the wait would be forever.) */
514 msg.msg_control = control.control;
515 msg.msg_controllen = sizeof(control.control);
516 /* We're a connected socket so we don't need a destination */
522 cmptr = CMSG_FIRSTHDR(&msg);
523 cmptr->cmsg_len = CMSG_LEN(sizeof(int));
524 cmptr->cmsg_level = SOL_SOCKET;
525 cmptr->cmsg_type = SCM_RIGHTS;
526 *((int *)CMSG_DATA(cmptr)) = 1;
528 vec[0].iov_base = (void*)&sv;
529 vec[0].iov_len = sizeof(sv);
530 got = sendmsg(sock, &msg, 0);
533 perror("Debug leaking scalars parent sendmsg failed");
536 if(got < sizeof(sv)) {
537 perror("Debug leaking scalars parent short sendmsg");
541 /* Return protocol is
543 unsigned char: length of location string (0 for empty)
544 unsigned char*: string (not terminated)
546 vec[0].iov_base = (void*)&returned_errno;
547 vec[0].iov_len = sizeof(returned_errno);
548 vec[1].iov_base = buffer;
551 got = readv(sock, vec, 2);
554 perror("Debug leaking scalars parent read failed");
555 PerlIO_flush(PerlIO_stderr());
558 if(got < sizeof(returned_errno) + 1) {
559 perror("Debug leaking scalars parent short read");
560 PerlIO_flush(PerlIO_stderr());
565 got = read(sock, buffer + 1, *buffer);
567 perror("Debug leaking scalars parent read 2 failed");
568 PerlIO_flush(PerlIO_stderr());
573 perror("Debug leaking scalars parent short read 2");
574 PerlIO_flush(PerlIO_stderr());
579 if (returned_errno || *buffer) {
580 Perl_warn(aTHX_ "Debug leaking scalars child failed%s%.*s with errno"
581 " %d: %s", (*buffer ? " at " : ""), (int) *buffer, buffer + 1,
582 returned_errno, strerror(returned_errno));
588 =for apidoc perl_destruct
590 Shuts down a Perl interpreter. See L<perlembed>.
599 VOL signed char destruct_level; /* see possible values in intrpvar.h */
601 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
605 PERL_ARGS_ASSERT_PERL_DESTRUCT;
607 PERL_UNUSED_ARG(my_perl);
610 /* wait for all pseudo-forked children to finish */
611 PERL_WAIT_FOR_CHILDREN;
613 destruct_level = PL_perl_destruct_level;
616 const char * const s = PerlEnv_getenv("PERL_DESTRUCT_LEVEL");
618 const int i = atoi(s);
619 if (destruct_level < i)
625 if (PL_exit_flags & PERL_EXIT_DESTRUCT_END) {
631 if (PL_endav && !PL_minus_c)
632 call_list(PL_scopestack_ix, PL_endav);
638 /* Need to flush since END blocks can produce output */
641 if (CALL_FPTR(PL_threadhook)(aTHX)) {
642 /* Threads hook has vetoed further cleanup */
643 PL_veto_cleanup = TRUE;
647 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
648 if (destruct_level != 0) {
649 /* Fork here to create a child. Our child's job is to preserve the
650 state of scalars prior to destruction, so that we can instruct it
651 to dump any scalars that we later find have leaked.
652 There's no subtlety in this code - it assumes POSIX, and it doesn't
656 if(socketpair(AF_UNIX, SOCK_STREAM, 0, fd)) {
657 perror("Debug leaking scalars socketpair failed");
663 perror("Debug leaking scalars fork failed");
667 /* We are the child */
668 const int sock = fd[1];
669 const int debug_fd = PerlIO_fileno(Perl_debug_log);
672 /* Our success message is an integer 0, and a char 0 */
673 static const char success[sizeof(int) + 1] = {0};
677 /* We need to close all other file descriptors otherwise we end up
678 with interesting hangs, where the parent closes its end of a
679 pipe, and sits waiting for (another) child to terminate. Only
680 that child never terminates, because it never gets EOF, because
681 we also have the far end of the pipe open. We even need to
682 close the debugging fd, because sometimes it happens to be one
683 end of a pipe, and a process is waiting on the other end for
684 EOF. Normally it would be closed at some point earlier in
685 destruction, but if we happen to cause the pipe to remain open,
686 EOF never occurs, and we get an infinite hang. Hence all the
687 games to pass in a file descriptor if it's actually needed. */
689 f = sysconf(_SC_OPEN_MAX);
691 where = "sysconf failed";
702 union control_un control;
705 struct cmsghdr *cmptr;
709 msg.msg_control = control.control;
710 msg.msg_controllen = sizeof(control.control);
711 /* We're a connected socket so we don't need a source */
715 msg.msg_iovlen = sizeof(vec)/sizeof(vec[0]);
717 vec[0].iov_base = (void*)⌖
718 vec[0].iov_len = sizeof(target);
720 got = recvmsg(sock, &msg, 0);
725 where = "recv failed";
728 if(got < sizeof(target)) {
729 where = "short recv";
733 if(!(cmptr = CMSG_FIRSTHDR(&msg))) {
737 if(cmptr->cmsg_len != CMSG_LEN(sizeof(int))) {
738 where = "wrong cmsg_len";
741 if(cmptr->cmsg_level != SOL_SOCKET) {
742 where = "wrong cmsg_level";
745 if(cmptr->cmsg_type != SCM_RIGHTS) {
746 where = "wrong cmsg_type";
750 got_fd = *(int*)CMSG_DATA(cmptr);
751 /* For our last little bit of trickery, put the file descriptor
752 back into Perl_debug_log, as if we never actually closed it
754 if(got_fd != debug_fd) {
755 if (dup2(got_fd, debug_fd) == -1) {
762 PerlIO_flush(Perl_debug_log);
764 got = write(sock, &success, sizeof(success));
767 where = "write failed";
770 if(got < sizeof(success)) {
771 where = "short write";
778 int send_errno = errno;
779 unsigned char length = (unsigned char) strlen(where);
780 struct iovec failure[3] = {
781 {(void*)&send_errno, sizeof(send_errno)},
783 {(void*)where, length}
785 int got = writev(sock, failure, 3);
786 /* Bad news travels fast. Faster than data. We'll get a SIGPIPE
787 in the parent if we try to read from the socketpair after the
788 child has exited, even if there was data to read.
789 So sleep a bit to give the parent a fighting chance of
792 _exit((got == -1) ? errno : 0);
796 PL_dumper_fd = fd[0];
801 /* We must account for everything. */
803 /* Destroy the main CV and syntax tree */
804 /* Do this now, because destroying ops can cause new SVs to be generated
805 in Perl_pad_swipe, and when running with -DDEBUG_LEAKING_SCALARS they
806 PL_curcop to point to a valid op from which the filename structure
808 PL_curcop = &PL_compiling;
810 /* ensure comppad/curpad to refer to main's pad */
811 if (CvPADLIST(PL_main_cv)) {
812 PAD_SET_CUR_NOSAVE(CvPADLIST(PL_main_cv), 1);
814 op_free(PL_main_root);
817 PL_main_start = NULL;
818 SvREFCNT_dec(PL_main_cv);
822 /* Tell PerlIO we are about to tear things apart in case
823 we have layers which are using resources that should
827 PerlIO_destruct(aTHX);
829 if (PL_sv_objcount) {
831 * Try to destruct global references. We do this first so that the
832 * destructors and destructees still exist. Some sv's might remain.
833 * Non-referenced objects are on their own.
837 if (PL_defoutgv && !SvREFCNT(PL_defoutgv))
838 PL_defoutgv = NULL; /* may have been freed */
841 /* unhook hooks which will soon be, or use, destroyed data */
842 SvREFCNT_dec(PL_warnhook);
844 SvREFCNT_dec(PL_diehook);
847 /* call exit list functions */
848 while (PL_exitlistlen-- > 0)
849 PL_exitlist[PL_exitlistlen].fn(aTHX_ PL_exitlist[PL_exitlistlen].ptr);
851 Safefree(PL_exitlist);
856 SvREFCNT_dec(PL_registered_mros);
858 /* jettison our possibly duplicated environment */
859 /* if PERL_USE_SAFE_PUTENV is defined environ will not have been copied
860 * so we certainly shouldn't free it here
863 #if defined(USE_ENVIRON_ARRAY) && !defined(PERL_USE_SAFE_PUTENV)
864 if (environ != PL_origenviron && !PL_use_safe_putenv
866 /* only main thread can free environ[0] contents */
867 && PL_curinterp == aTHX
873 for (i = 0; environ[i]; i++)
874 safesysfree(environ[i]);
876 /* Must use safesysfree() when working with environ. */
877 safesysfree(environ);
879 environ = PL_origenviron;
882 #endif /* !PERL_MICRO */
884 if (destruct_level == 0) {
886 DEBUG_P(debprofdump());
888 #if defined(PERLIO_LAYERS)
889 /* No more IO - including error messages ! */
890 PerlIO_cleanup(aTHX);
893 CopFILE_free(&PL_compiling);
894 CopSTASH_free(&PL_compiling);
896 /* The exit() function will do everything that needs doing. */
900 /* reset so print() ends up where we expect */
904 /* the syntax tree is shared between clones
905 * so op_free(PL_main_root) only ReREFCNT_dec's
906 * REGEXPs in the parent interpreter
907 * we need to manually ReREFCNT_dec for the clones
909 SvREFCNT_dec(PL_regex_padav);
910 PL_regex_padav = NULL;
914 SvREFCNT_dec(MUTABLE_SV(PL_stashcache));
915 PL_stashcache = NULL;
917 /* loosen bonds of global variables */
919 /* XXX can PL_parser still be non-null here? */
920 if(PL_parser && PL_parser->rsfp) {
921 (void)PerlIO_close(PL_parser->rsfp);
922 PL_parser->rsfp = NULL;
926 Safefree(PL_splitstr);
936 PL_doswitches = FALSE;
937 PL_dowarn = G_WARN_OFF;
938 PL_doextract = FALSE;
939 PL_sawampersand = FALSE; /* must save all match strings */
942 Safefree(PL_inplace);
944 SvREFCNT_dec(PL_patchlevel);
947 SvREFCNT_dec(PL_e_script);
953 /* magical thingies */
955 SvREFCNT_dec(PL_ofsgv); /* *, */
958 SvREFCNT_dec(PL_ors_sv); /* $\ */
961 SvREFCNT_dec(PL_rs); /* $/ */
964 Safefree(PL_osname); /* $^O */
967 SvREFCNT_dec(PL_statname);
971 /* defgv, aka *_ should be taken care of elsewhere */
973 /* clean up after study() */
974 SvREFCNT_dec(PL_lastscream);
975 PL_lastscream = NULL;
976 Safefree(PL_screamfirst);
978 Safefree(PL_screamnext);
982 Safefree(PL_efloatbuf);
986 /* startup and shutdown function lists */
987 SvREFCNT_dec(PL_beginav);
988 SvREFCNT_dec(PL_beginav_save);
989 SvREFCNT_dec(PL_endav);
990 SvREFCNT_dec(PL_checkav);
991 SvREFCNT_dec(PL_checkav_save);
992 SvREFCNT_dec(PL_unitcheckav);
993 SvREFCNT_dec(PL_unitcheckav_save);
994 SvREFCNT_dec(PL_initav);
996 PL_beginav_save = NULL;
999 PL_checkav_save = NULL;
1000 PL_unitcheckav = NULL;
1001 PL_unitcheckav_save = NULL;
1004 /* shortcuts just get cleared */
1010 PL_argvoutgv = NULL;
1013 PL_last_in_gv = NULL;
1025 SvREFCNT_dec(PL_argvout_stack);
1026 PL_argvout_stack = NULL;
1028 SvREFCNT_dec(PL_modglobal);
1029 PL_modglobal = NULL;
1030 SvREFCNT_dec(PL_preambleav);
1031 PL_preambleav = NULL;
1032 SvREFCNT_dec(PL_subname);
1034 #ifdef PERL_USES_PL_PIDSTATUS
1035 SvREFCNT_dec(PL_pidstatus);
1036 PL_pidstatus = NULL;
1038 SvREFCNT_dec(PL_toptarget);
1039 PL_toptarget = NULL;
1040 SvREFCNT_dec(PL_bodytarget);
1041 PL_bodytarget = NULL;
1042 PL_formtarget = NULL;
1044 /* free locale stuff */
1045 #ifdef USE_LOCALE_COLLATE
1046 Safefree(PL_collation_name);
1047 PL_collation_name = NULL;
1050 #ifdef USE_LOCALE_NUMERIC
1051 Safefree(PL_numeric_name);
1052 PL_numeric_name = NULL;
1053 SvREFCNT_dec(PL_numeric_radix_sv);
1054 PL_numeric_radix_sv = NULL;
1057 /* clear utf8 character classes */
1058 SvREFCNT_dec(PL_utf8_alnum);
1059 SvREFCNT_dec(PL_utf8_alnumc);
1060 SvREFCNT_dec(PL_utf8_ascii);
1061 SvREFCNT_dec(PL_utf8_alpha);
1062 SvREFCNT_dec(PL_utf8_space);
1063 SvREFCNT_dec(PL_utf8_cntrl);
1064 SvREFCNT_dec(PL_utf8_graph);
1065 SvREFCNT_dec(PL_utf8_digit);
1066 SvREFCNT_dec(PL_utf8_upper);
1067 SvREFCNT_dec(PL_utf8_lower);
1068 SvREFCNT_dec(PL_utf8_print);
1069 SvREFCNT_dec(PL_utf8_punct);
1070 SvREFCNT_dec(PL_utf8_xdigit);
1071 SvREFCNT_dec(PL_utf8_mark);
1072 SvREFCNT_dec(PL_utf8_toupper);
1073 SvREFCNT_dec(PL_utf8_totitle);
1074 SvREFCNT_dec(PL_utf8_tolower);
1075 SvREFCNT_dec(PL_utf8_tofold);
1076 SvREFCNT_dec(PL_utf8_idstart);
1077 SvREFCNT_dec(PL_utf8_idcont);
1078 PL_utf8_alnum = NULL;
1079 PL_utf8_alnumc = NULL;
1080 PL_utf8_ascii = NULL;
1081 PL_utf8_alpha = NULL;
1082 PL_utf8_space = NULL;
1083 PL_utf8_cntrl = NULL;
1084 PL_utf8_graph = NULL;
1085 PL_utf8_digit = NULL;
1086 PL_utf8_upper = NULL;
1087 PL_utf8_lower = NULL;
1088 PL_utf8_print = NULL;
1089 PL_utf8_punct = NULL;
1090 PL_utf8_xdigit = NULL;
1091 PL_utf8_mark = NULL;
1092 PL_utf8_toupper = NULL;
1093 PL_utf8_totitle = NULL;
1094 PL_utf8_tolower = NULL;
1095 PL_utf8_tofold = NULL;
1096 PL_utf8_idstart = NULL;
1097 PL_utf8_idcont = NULL;
1099 if (!specialWARN(PL_compiling.cop_warnings))
1100 PerlMemShared_free(PL_compiling.cop_warnings);
1101 PL_compiling.cop_warnings = NULL;
1102 Perl_refcounted_he_free(aTHX_ PL_compiling.cop_hints_hash);
1103 PL_compiling.cop_hints_hash = NULL;
1104 CopFILE_free(&PL_compiling);
1105 CopSTASH_free(&PL_compiling);
1107 /* Prepare to destruct main symbol table. */
1112 SvREFCNT_dec(PL_curstname);
1113 PL_curstname = NULL;
1115 /* clear queued errors */
1116 SvREFCNT_dec(PL_errors);
1119 SvREFCNT_dec(PL_isarev);
1122 if (destruct_level >= 2 && ckWARN_d(WARN_INTERNAL)) {
1123 if (PL_scopestack_ix != 0)
1124 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
1125 "Unbalanced scopes: %ld more ENTERs than LEAVEs\n",
1126 (long)PL_scopestack_ix);
1127 if (PL_savestack_ix != 0)
1128 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
1129 "Unbalanced saves: %ld more saves than restores\n",
1130 (long)PL_savestack_ix);
1131 if (PL_tmps_floor != -1)
1132 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced tmps: %ld more allocs than frees\n",
1133 (long)PL_tmps_floor + 1);
1134 if (cxstack_ix != -1)
1135 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced context: %ld more PUSHes than POPs\n",
1136 (long)cxstack_ix + 1);
1139 /* Now absolutely destruct everything, somehow or other, loops or no. */
1141 /* the 2 is for PL_fdpid and PL_strtab */
1142 while (sv_clean_all() > 2)
1145 AvREAL_off(PL_fdpid); /* no surviving entries */
1146 SvREFCNT_dec(PL_fdpid); /* needed in io_close() */
1149 #ifdef HAVE_INTERP_INTERN
1153 /* Destruct the global string table. */
1155 /* Yell and reset the HeVAL() slots that are still holding refcounts,
1156 * so that sv_free() won't fail on them.
1157 * Now that the global string table is using a single hunk of memory
1158 * for both HE and HEK, we either need to explicitly unshare it the
1159 * correct way, or actually free things here.
1162 const I32 max = HvMAX(PL_strtab);
1163 HE * const * const array = HvARRAY(PL_strtab);
1164 HE *hent = array[0];
1167 if (hent && ckWARN_d(WARN_INTERNAL)) {
1168 HE * const next = HeNEXT(hent);
1169 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
1170 "Unbalanced string table refcount: (%ld) for \"%s\"",
1171 (long)hent->he_valu.hent_refcount, HeKEY(hent));
1178 hent = array[riter];
1183 HvARRAY(PL_strtab) = 0;
1184 HvTOTALKEYS(PL_strtab) = 0;
1185 HvFILL(PL_strtab) = 0;
1187 SvREFCNT_dec(PL_strtab);
1190 /* free the pointer tables used for cloning */
1191 ptr_table_free(PL_ptr_table);
1192 PL_ptr_table = (PTR_TBL_t*)NULL;
1195 /* free special SVs */
1197 SvREFCNT(&PL_sv_yes) = 0;
1198 sv_clear(&PL_sv_yes);
1199 SvANY(&PL_sv_yes) = NULL;
1200 SvFLAGS(&PL_sv_yes) = 0;
1202 SvREFCNT(&PL_sv_no) = 0;
1203 sv_clear(&PL_sv_no);
1204 SvANY(&PL_sv_no) = NULL;
1205 SvFLAGS(&PL_sv_no) = 0;
1209 for (i=0; i<=2; i++) {
1210 SvREFCNT(PERL_DEBUG_PAD(i)) = 0;
1211 sv_clear(PERL_DEBUG_PAD(i));
1212 SvANY(PERL_DEBUG_PAD(i)) = NULL;
1213 SvFLAGS(PERL_DEBUG_PAD(i)) = 0;
1217 if (PL_sv_count != 0 && ckWARN_d(WARN_INTERNAL))
1218 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Scalars leaked: %ld\n", (long)PL_sv_count);
1220 #ifdef DEBUG_LEAKING_SCALARS
1221 if (PL_sv_count != 0) {
1226 for (sva = PL_sv_arenaroot; sva; sva = MUTABLE_SV(SvANY(sva))) {
1227 svend = &sva[SvREFCNT(sva)];
1228 for (sv = sva + 1; sv < svend; ++sv) {
1229 if (SvTYPE(sv) != SVTYPEMASK) {
1230 PerlIO_printf(Perl_debug_log, "leaked: sv=0x%p"
1232 " refcnt=%"UVuf pTHX__FORMAT "\n"
1233 "\tallocated at %s:%d %s %s%s\n",
1234 (void*)sv, (UV)sv->sv_flags, (UV)sv->sv_refcnt
1236 sv->sv_debug_file ? sv->sv_debug_file : "(unknown)",
1238 sv->sv_debug_inpad ? "for" : "by",
1239 sv->sv_debug_optype ?
1240 PL_op_name[sv->sv_debug_optype]: "(none)",
1241 sv->sv_debug_cloned ? " (cloned)" : ""
1243 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1244 Perl_dump_sv_child(aTHX_ sv);
1250 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1254 /* Wait for up to 4 seconds for child to terminate.
1255 This seems to be the least effort way of timing out on reaping
1257 struct timeval waitfor = {4, 0};
1258 int sock = PL_dumper_fd;
1262 FD_SET(sock, &rset);
1263 select(sock + 1, &rset, NULL, NULL, &waitfor);
1264 waitpid(child, &status, WNOHANG);
1269 #ifdef DEBUG_LEAKING_SCALARS_ABORT
1275 #ifdef PERL_DEBUG_READONLY_OPS
1281 #if defined(PERLIO_LAYERS)
1282 /* No more IO - including error messages ! */
1283 PerlIO_cleanup(aTHX);
1286 /* sv_undef needs to stay immortal until after PerlIO_cleanup
1287 as currently layers use it rather than NULL as a marker
1288 for no arg - and will try and SvREFCNT_dec it.
1290 SvREFCNT(&PL_sv_undef) = 0;
1291 SvREADONLY_off(&PL_sv_undef);
1293 Safefree(PL_origfilename);
1294 PL_origfilename = NULL;
1295 Safefree(PL_reg_start_tmp);
1296 PL_reg_start_tmp = (char**)NULL;
1297 PL_reg_start_tmpl = 0;
1298 Safefree(PL_reg_curpm);
1299 Safefree(PL_reg_poscache);
1300 free_tied_hv_pool();
1301 Safefree(PL_op_mask);
1302 Safefree(PL_psig_ptr);
1303 PL_psig_ptr = (SV**)NULL;
1304 Safefree(PL_psig_name);
1305 PL_psig_name = (SV**)NULL;
1306 Safefree(PL_bitcount);
1308 Safefree(PL_psig_pend);
1309 PL_psig_pend = (int*)NULL;
1312 PL_tainting = FALSE;
1313 PL_taint_warn = FALSE;
1314 PL_hints = 0; /* Reset hints. Should hints be per-interpreter ? */
1317 DEBUG_P(debprofdump());
1319 #ifdef USE_REENTRANT_API
1320 Perl_reentrant_free(aTHX);
1325 while (PL_regmatch_slab) {
1326 regmatch_slab *s = PL_regmatch_slab;
1327 PL_regmatch_slab = PL_regmatch_slab->next;
1331 /* As the absolutely last thing, free the non-arena SV for mess() */
1334 /* we know that type == SVt_PVMG */
1336 /* it could have accumulated taint magic */
1339 for (mg = SvMAGIC(PL_mess_sv); mg; mg = moremagic) {
1340 moremagic = mg->mg_moremagic;
1341 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global
1343 Safefree(mg->mg_ptr);
1347 /* we know that type >= SVt_PV */
1348 SvPV_free(PL_mess_sv);
1349 Safefree(SvANY(PL_mess_sv));
1350 Safefree(PL_mess_sv);
1357 =for apidoc perl_free
1359 Releases a Perl interpreter. See L<perlembed>.
1369 PERL_ARGS_ASSERT_PERL_FREE;
1371 if (PL_veto_cleanup)
1374 #ifdef PERL_TRACK_MEMPOOL
1377 * Don't free thread memory if PERL_DESTRUCT_LEVEL is set to a non-zero
1378 * value as we're probably hunting memory leaks then
1380 const char * const s = PerlEnv_getenv("PERL_DESTRUCT_LEVEL");
1381 if (!s || atoi(s) == 0) {
1382 const U32 old_debug = PL_debug;
1383 /* Emulate the PerlHost behaviour of free()ing all memory allocated in this
1384 thread at thread exit. */
1386 PerlIO_puts(Perl_debug_log, "Disabling memory debugging as we "
1387 "free this thread's memory\n");
1388 PL_debug &= ~ DEBUG_m_FLAG;
1390 while(aTHXx->Imemory_debug_header.next != &(aTHXx->Imemory_debug_header))
1391 safesysfree(sTHX + (char *)(aTHXx->Imemory_debug_header.next));
1392 PL_debug = old_debug;
1397 #if defined(WIN32) || defined(NETWARE)
1398 # if defined(PERL_IMPLICIT_SYS)
1401 void *host = nw_internal_host;
1403 void *host = w32_internal_host;
1405 PerlMem_free(aTHXx);
1407 nw_delete_internal_host(host);
1409 win32_delete_internal_host(host);
1413 PerlMem_free(aTHXx);
1416 PerlMem_free(aTHXx);
1420 #if defined(USE_ITHREADS)
1421 /* provide destructors to clean up the thread key when libperl is unloaded */
1422 #ifndef WIN32 /* handled during DLL_PROCESS_DETACH in win32/perllib.c */
1424 #if defined(__hpux) && !(defined(__ux_version) && __ux_version <= 1020) && !defined(__GNUC__)
1425 #pragma fini "perl_fini"
1426 #elif defined(__sun) && !defined(__GNUC__)
1427 #pragma fini (perl_fini)
1431 #if defined(__GNUC__)
1432 __attribute__((destructor))
1437 if (PL_curinterp && !PL_veto_cleanup)
1442 #endif /* THREADS */
1445 Perl_call_atexit(pTHX_ ATEXIT_t fn, void *ptr)
1448 Renew(PL_exitlist, PL_exitlistlen+1, PerlExitListEntry);
1449 PL_exitlist[PL_exitlistlen].fn = fn;
1450 PL_exitlist[PL_exitlistlen].ptr = ptr;
1454 #ifdef HAS_PROCSELFEXE
1455 /* This is a function so that we don't hold on to MAXPATHLEN
1456 bytes of stack longer than necessary
1459 S_procself_val(pTHX_ SV *sv, const char *arg0)
1461 char buf[MAXPATHLEN];
1462 int len = readlink(PROCSELFEXE_PATH, buf, sizeof(buf) - 1);
1464 /* On Playstation2 Linux V1.0 (kernel 2.2.1) readlink(/proc/self/exe)
1465 includes a spurious NUL which will cause $^X to fail in system
1466 or backticks (this will prevent extensions from being built and
1467 many tests from working). readlink is not meant to add a NUL.
1468 Normal readlink works fine.
1470 if (len > 0 && buf[len-1] == '\0') {
1474 /* FreeBSD's implementation is acknowledged to be imperfect, sometimes
1475 returning the text "unknown" from the readlink rather than the path
1476 to the executable (or returning an error from the readlink). Any valid
1477 path has a '/' in it somewhere, so use that to validate the result.
1478 See http://www.freebsd.org/cgi/query-pr.cgi?pr=35703
1480 if (len > 0 && memchr(buf, '/', len)) {
1481 sv_setpvn(sv,buf,len);
1487 #endif /* HAS_PROCSELFEXE */
1490 S_set_caret_X(pTHX) {
1492 GV* tmpgv = gv_fetchpvs("\030", GV_ADD|GV_NOTQUAL, SVt_PV); /* $^X */
1494 #ifdef HAS_PROCSELFEXE
1495 S_procself_val(aTHX_ GvSV(tmpgv), PL_origargv[0]);
1498 sv_setpv(GvSVn(tmpgv), os2_execname(aTHX));
1500 sv_setpv(GvSVn(tmpgv),PL_origargv[0]);
1507 =for apidoc perl_parse
1509 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
1515 perl_parse(pTHXx_ XSINIT_t xsinit, int argc, char **argv, char **env)
1522 PERL_ARGS_ASSERT_PERL_PARSE;
1523 #ifndef MULTIPLICITY
1524 PERL_UNUSED_ARG(my_perl);
1527 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW_AND_IAMSUID
1528 Perl_croak(aTHX_ "suidperl is no longer needed since the kernel can now "
1529 "execute\nsetuid perl scripts securely.\n");
1532 #if defined(USE_HASH_SEED) || defined(USE_HASH_SEED_EXPLICIT)
1533 /* [perl #22371] Algorimic Complexity Attack on Perl 5.6.1, 5.8.0
1534 * This MUST be done before any hash stores or fetches take place.
1535 * If you set PL_rehash_seed (and assumedly also PL_rehash_seed_set)
1536 * yourself, it is your responsibility to provide a good random seed!
1537 * You can also define PERL_HASH_SEED in compile time, see hv.h. */
1538 if (!PL_rehash_seed_set)
1539 PL_rehash_seed = get_hash_seed();
1541 const char * const s = PerlEnv_getenv("PERL_HASH_SEED_DEBUG");
1543 if (s && (atoi(s) == 1))
1544 PerlIO_printf(Perl_debug_log, "HASH_SEED = %"UVuf"\n", PL_rehash_seed);
1546 #endif /* #if defined(USE_HASH_SEED) || defined(USE_HASH_SEED_EXPLICIT) */
1551 if (PL_origalen != 0) {
1552 PL_origalen = 1; /* don't use old PL_origalen if perl_parse() is called again */
1555 /* Set PL_origalen be the sum of the contiguous argv[]
1556 * elements plus the size of the env in case that it is
1557 * contiguous with the argv[]. This is used in mg.c:Perl_magic_set()
1558 * as the maximum modifiable length of $0. In the worst case
1559 * the area we are able to modify is limited to the size of
1560 * the original argv[0]. (See below for 'contiguous', though.)
1562 const char *s = NULL;
1565 ~(UV)(PTRSIZE == 4 ? 3 : PTRSIZE == 8 ? 7 : PTRSIZE == 16 ? 15 : 0);
1566 /* Do the mask check only if the args seem like aligned. */
1568 (mask < ~(UV)0) && ((PTR2UV(argv[0]) & mask) == PTR2UV(argv[0]));
1570 /* See if all the arguments are contiguous in memory. Note
1571 * that 'contiguous' is a loose term because some platforms
1572 * align the argv[] and the envp[]. If the arguments look
1573 * like non-aligned, assume that they are 'strictly' or
1574 * 'traditionally' contiguous. If the arguments look like
1575 * aligned, we just check that they are within aligned
1576 * PTRSIZE bytes. As long as no system has something bizarre
1577 * like the argv[] interleaved with some other data, we are
1578 * fine. (Did I just evoke Murphy's Law?) --jhi */
1579 if (PL_origargv && PL_origargc >= 1 && (s = PL_origargv[0])) {
1581 for (i = 1; i < PL_origargc; i++) {
1582 if ((PL_origargv[i] == s + 1
1584 || PL_origargv[i] == s + 2
1589 (PL_origargv[i] > s &&
1591 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1602 #ifndef PERL_USE_SAFE_PUTENV
1603 /* Can we grab env area too to be used as the area for $0? */
1604 if (s && PL_origenviron && !PL_use_safe_putenv) {
1605 if ((PL_origenviron[0] == s + 1)
1608 (PL_origenviron[0] > s &&
1609 PL_origenviron[0] <=
1610 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1613 #ifndef OS2 /* ENVIRON is read by the kernel too. */
1614 s = PL_origenviron[0];
1617 my_setenv("NoNe SuCh", NULL);
1618 /* Force copy of environment. */
1619 for (i = 1; PL_origenviron[i]; i++) {
1620 if (PL_origenviron[i] == s + 1
1623 (PL_origenviron[i] > s &&
1624 PL_origenviron[i] <=
1625 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1628 s = PL_origenviron[i];
1636 #endif /* !defined(PERL_USE_SAFE_PUTENV) */
1638 PL_origalen = s ? s - PL_origargv[0] + 1 : 0;
1643 /* Come here if running an undumped a.out. */
1645 PL_origfilename = savepv(argv[0]);
1646 PL_do_undump = FALSE;
1647 cxstack_ix = -1; /* start label stack again */
1649 assert (!PL_tainted);
1651 S_set_caret_X(aTHX);
1653 init_postdump_symbols(argc,argv,env);
1658 op_free(PL_main_root);
1659 PL_main_root = NULL;
1661 PL_main_start = NULL;
1662 SvREFCNT_dec(PL_main_cv);
1666 oldscope = PL_scopestack_ix;
1667 PL_dowarn = G_WARN_OFF;
1672 parse_body(env,xsinit);
1674 call_list(oldscope, PL_unitcheckav);
1676 call_list(oldscope, PL_checkav);
1683 /* my_exit() was called */
1684 while (PL_scopestack_ix > oldscope)
1687 PL_curstash = PL_defstash;
1689 call_list(oldscope, PL_unitcheckav);
1691 call_list(oldscope, PL_checkav);
1695 PerlIO_printf(Perl_error_log, "panic: top_env\n");
1704 S_parse_body(pTHX_ char **env, XSINIT_t xsinit)
1708 int argc = PL_origargc;
1709 char **argv = PL_origargv;
1710 const char *scriptname = NULL;
1711 VOL bool dosearch = FALSE;
1713 const char *validarg = "";
1717 const char *cddir = NULL;
1718 #ifdef USE_SITECUSTOMIZE
1719 bool minus_f = FALSE;
1721 SV *linestr_sv = newSV_type(SVt_PVIV);
1722 bool add_read_e_script = FALSE;
1724 SvGROW(linestr_sv, 80);
1725 sv_setpvs(linestr_sv,"");
1727 sv = newSVpvs(""); /* first used for -I flags */
1733 for (argc--,argv++; argc > 0; argc--,argv++) {
1734 if (argv[0][0] != '-' || !argv[0][1])
1738 validarg = " PHOOEY ";
1742 * Can we rely on the kernel to start scripts with argv[1] set to
1743 * contain all #! line switches (the whole line)? (argv[0] is set to
1744 * the interpreter name, argv[2] to the script name; argv[3] and
1745 * above may contain other arguments.)
1752 #ifndef PERL_STRICT_CR
1776 if ((s = moreswitches(s)))
1781 CHECK_MALLOC_TOO_LATE_FOR('t');
1782 if( !PL_tainting ) {
1783 PL_taint_warn = TRUE;
1789 CHECK_MALLOC_TOO_LATE_FOR('T');
1791 PL_taint_warn = FALSE;
1799 #ifdef MACOS_TRADITIONAL
1800 /* ignore -e for Dev:Pseudo argument */
1801 if (argv[1] && !strcmp(argv[1], "Dev:Pseudo"))
1804 forbid_setid('e', FALSE);
1806 PL_e_script = newSVpvs("");
1807 add_read_e_script = TRUE;
1810 sv_catpv(PL_e_script, s);
1812 sv_catpv(PL_e_script, argv[1]);
1816 Perl_croak(aTHX_ "No code specified for -%c", c);
1817 sv_catpvs(PL_e_script, "\n");
1821 #ifdef USE_SITECUSTOMIZE
1827 case 'I': /* -I handled both here and in moreswitches() */
1828 forbid_setid('I', FALSE);
1829 if (!*++s && (s=argv[1]) != NULL) {
1833 STRLEN len = strlen(s);
1834 const char * const p = savepvn(s, len);
1835 incpush(p, TRUE, TRUE, FALSE, FALSE, FALSE);
1836 sv_catpvs(sv, "-I");
1837 sv_catpvn(sv, p, len);
1842 Perl_croak(aTHX_ "No directory specified for -I");
1845 forbid_setid('S', FALSE);
1853 Perl_av_create_and_push(aTHX_ &PL_preambleav, newSVpvs("use Config;"));
1855 /* Can't do newSVpvs() as that would involve pre-processor
1856 condititionals inside a macro expansion. */
1857 opts_prog = Perl_newSVpv(aTHX_ "$_ = join ' ', sort qw("
1864 # ifdef PERL_DONT_CREATE_GVSV
1865 " PERL_DONT_CREATE_GVSV"
1867 # ifdef PERL_MALLOC_WRAP
1870 # ifdef PERL_MEM_LOG
1873 # ifdef PERL_MEM_LOG_ENV
1876 # ifdef PERL_MEM_LOG_ENV_FD
1877 " PERL_MEM_LOG_ENV_FD"
1879 # ifdef PERL_MEM_LOG_STDERR
1880 " PERL_MEM_LOG_STDERR"
1882 # ifdef PERL_MEM_LOG_TIMESTAMP
1883 " PERL_MEM_LOG_TIMESTAMP"
1885 # ifdef PERL_USE_DEVEL
1888 # ifdef PERL_USE_SAFE_PUTENV
1889 " PERL_USE_SAFE_PUTENV"
1891 # ifdef USE_SITECUSTOMIZE
1892 " USE_SITECUSTOMIZE"
1894 # ifdef USE_FAST_STDIO
1899 sv_catpv(opts_prog, PL_bincompat_options);
1900 /* Terminate the qw(, and then wrap at 76 columns. */
1901 sv_catpvs(opts_prog, "); s/(?=.{53})(.{1,53}) /$1\\n /mg;print Config::myconfig(),");
1903 sv_catpvs(opts_prog,"\"\\nCharacteristics of this PERLSHR image: \\n");
1905 sv_catpvs(opts_prog,"\"\\nCharacteristics of this binary (from libperl): \\n");
1907 sv_catpvs(opts_prog," Compile-time options: $_\\n\",");
1909 #if defined(LOCAL_PATCH_COUNT)
1910 if (LOCAL_PATCH_COUNT > 0) {
1912 sv_catpvs(opts_prog,
1913 "\" Locally applied patches:\\n\",");
1914 for (i = 1; i <= LOCAL_PATCH_COUNT; i++) {
1915 if (PL_localpatches[i])
1916 Perl_sv_catpvf(aTHX_ opts_prog,"q%c\t%s\n%c,",
1917 0, PL_localpatches[i], 0);
1921 Perl_sv_catpvf(aTHX_ opts_prog,
1922 "\" Built under %s\\n",OSNAME);
1925 sv_catpvs(opts_prog,
1926 " Compiled at " __DATE__ " " __TIME__ "\\n\"");
1928 sv_catpvs(opts_prog, " Compiled on " __DATE__ "\\n\"");
1931 sv_catpvs(opts_prog, "; $\"=\"\\n \"; "
1932 "@env = map { \"$_=\\\"$ENV{$_}\\\"\" } "
1933 "sort grep {/^PERL/} keys %ENV; ");
1935 sv_catpvs(opts_prog,
1936 "push @env, \"CYGWIN=\\\"$ENV{CYGWIN}\\\"\";");
1938 sv_catpvs(opts_prog,
1939 "print \" \\%ENV:\\n @env\\n\" if @env;"
1940 "print \" \\@INC:\\n @INC\\n\";");
1944 opts_prog = Perl_newSVpvf(aTHX_
1945 "Config::config_vars(qw%c%s%c)",
1949 av_push(PL_preambleav, opts_prog);
1950 /* don't look for script or read stdin */
1951 scriptname = BIT_BUCKET;
1955 PL_doextract = TRUE;
1963 if (!*++s || isSPACE(*s)) {
1967 /* catch use of gnu style long options */
1968 if (strEQ(s, "version")) {
1972 if (strEQ(s, "help")) {
1979 Perl_croak(aTHX_ "Unrecognized switch: -%s (-h will show valid options)",s);
1990 #ifndef SECURE_INTERNAL_GETENV
1993 (s = PerlEnv_getenv("PERL5OPT")))
1997 if (*s == '-' && *(s+1) == 'T') {
1998 CHECK_MALLOC_TOO_LATE_FOR('T');
2000 PL_taint_warn = FALSE;
2003 char *popt_copy = NULL;
2016 if (!strchr("CDIMUdmtw", *s))
2017 Perl_croak(aTHX_ "Illegal switch in PERL5OPT: -%c", *s);
2021 popt_copy = SvPVX(sv_2mortal(newSVpv(d,0)));
2022 s = popt_copy + (s - d);
2030 if( !PL_tainting ) {
2031 PL_taint_warn = TRUE;
2042 #ifdef USE_SITECUSTOMIZE
2044 (void)Perl_av_create_and_unshift_one(aTHX_ &PL_preambleav,
2045 Perl_newSVpvf(aTHX_ "BEGIN { do '%s/sitecustomize.pl' }", SITELIB_EXP));
2050 scriptname = argv[0];
2053 scriptname = BIT_BUCKET; /* don't look for script or read stdin */
2055 else if (scriptname == NULL) {
2057 if ( PerlLIO_isatty(PerlIO_fileno(PerlIO_stdin())) )
2063 /* Set $^X early so that it can be used for relocatable paths in @INC */
2064 assert (!PL_tainted);
2066 S_set_caret_X(aTHX);
2071 bool suidscript = FALSE;
2074 const int fdscript =
2076 open_script(scriptname, dosearch, &suidscript, &rsfp);
2078 validate_suid(validarg, scriptname, fdscript, suidscript,
2082 # if defined(SIGCHLD) || defined(SIGCLD)
2085 # define SIGCHLD SIGCLD
2087 Sighandler_t sigstate = rsignal_state(SIGCHLD);
2088 if (sigstate == (Sighandler_t) SIG_IGN) {
2089 if (ckWARN(WARN_SIGNAL))
2090 Perl_warner(aTHX_ packWARN(WARN_SIGNAL),
2091 "Can't ignore signal CHLD, forcing to default");
2092 (void)rsignal(SIGCHLD, (Sighandler_t)SIG_DFL);
2099 #ifdef MACOS_TRADITIONAL
2100 || gMacPerl_AlwaysExtract
2104 /* This will croak if suidscript is true, as -x cannot be used with
2106 forbid_setid('x', suidscript);
2107 /* Hence you can't get here if suidscript is true */
2109 find_beginning(linestr_sv, rsfp);
2110 if (cddir && PerlDir_chdir( (char *)cddir ) < 0)
2111 Perl_croak(aTHX_ "Can't chdir to %s",cddir);
2115 PL_main_cv = PL_compcv = MUTABLE_CV(newSV_type(SVt_PVCV));
2116 CvUNIQUE_on(PL_compcv);
2118 CvPADLIST(PL_compcv) = pad_new(0);
2120 PL_isarev = newHV();
2123 boot_core_UNIVERSAL();
2124 boot_core_xsutils();
2128 (*xsinit)(aTHX); /* in case linked C routines want magical variables */
2130 #if defined(VMS) || defined(WIN32) || defined(DJGPP) || defined(__CYGWIN__) || defined(EPOC) || defined(SYMBIAN)
2136 # ifdef HAS_SOCKS5_INIT
2137 socks5_init(argv[0]);
2143 init_predump_symbols();
2144 /* init_postdump_symbols not currently designed to be called */
2145 /* more than once (ENV isn't cleared first, for example) */
2146 /* But running with -u leaves %ENV & @ARGV undefined! XXX */
2148 init_postdump_symbols(argc,argv,env);
2150 /* PL_unicode is turned on by -C, or by $ENV{PERL_UNICODE},
2151 * or explicitly in some platforms.
2152 * locale.c:Perl_init_i18nl10n() if the environment
2153 * look like the user wants to use UTF-8. */
2154 #if defined(__SYMBIAN32__)
2155 PL_unicode = PERL_UNICODE_STD_FLAG; /* See PERL_SYMBIAN_CONSOLE_UTF8. */
2158 /* Requires init_predump_symbols(). */
2159 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
2164 /* Turn on UTF-8-ness on STDIN, STDOUT, STDERR
2165 * and the default open disciplines. */
2166 if ((PL_unicode & PERL_UNICODE_STDIN_FLAG) &&
2167 PL_stdingv && (io = GvIO(PL_stdingv)) &&
2169 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2170 if ((PL_unicode & PERL_UNICODE_STDOUT_FLAG) &&
2171 PL_defoutgv && (io = GvIO(PL_defoutgv)) &&
2173 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2174 if ((PL_unicode & PERL_UNICODE_STDERR_FLAG) &&
2175 PL_stderrgv && (io = GvIO(PL_stderrgv)) &&
2177 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2178 if ((PL_unicode & PERL_UNICODE_INOUT_FLAG) &&
2179 (sv = GvSV(gv_fetchpvs("\017PEN", GV_ADD|GV_NOTQUAL,
2181 U32 in = PL_unicode & PERL_UNICODE_IN_FLAG;
2182 U32 out = PL_unicode & PERL_UNICODE_OUT_FLAG;
2185 sv_setpvs(sv, ":utf8\0:utf8");
2187 sv_setpvs(sv, ":utf8\0");
2190 sv_setpvs(sv, "\0:utf8");
2198 if ((s = PerlEnv_getenv("PERL_SIGNALS"))) {
2199 if (strEQ(s, "unsafe"))
2200 PL_signals |= PERL_SIGNALS_UNSAFE_FLAG;
2201 else if (strEQ(s, "safe"))
2202 PL_signals &= ~PERL_SIGNALS_UNSAFE_FLAG;
2204 Perl_croak(aTHX_ "PERL_SIGNALS illegal: \"%s\"", s);
2211 if ((s = PerlEnv_getenv("PERL_XMLDUMP"))) {
2215 PL_xmlfp = PerlIO_stdout();
2217 PL_xmlfp = PerlIO_open(s, "w");
2219 Perl_croak(aTHX_ "Can't open %s", s);
2221 my_setenv("PERL_XMLDUMP", NULL); /* hide from subprocs */
2227 if ((s = PerlEnv_getenv("PERL_MADSKILLS"))) {
2228 PL_madskills = atoi(s);
2229 my_setenv("PERL_MADSKILLS", NULL); /* hide from subprocs */
2234 lex_start(linestr_sv, rsfp, TRUE);
2235 PL_subname = newSVpvs("main");
2237 if (add_read_e_script)
2238 filter_add(read_e_script, NULL);
2240 /* now parse the script */
2242 SETERRNO(0,SS_NORMAL);
2243 #ifdef MACOS_TRADITIONAL
2244 if (gMacPerl_SyntaxError = (yyparse() || PL_parser->error_count)) {
2246 Perl_croak(aTHX_ "%s had compilation errors.\n", MacPerl_MPWFileName(PL_origfilename));
2248 Perl_croak(aTHX_ "Execution of %s aborted due to compilation errors.\n",
2249 MacPerl_MPWFileName(PL_origfilename));
2253 if (yyparse() || PL_parser->error_count) {
2255 Perl_croak(aTHX_ "%s had compilation errors.\n", PL_origfilename);
2257 Perl_croak(aTHX_ "Execution of %s aborted due to compilation errors.\n",
2262 CopLINE_set(PL_curcop, 0);
2263 PL_curstash = PL_defstash;
2265 SvREFCNT_dec(PL_e_script);
2273 SAVECOPFILE(PL_curcop);
2274 SAVECOPLINE(PL_curcop);
2275 gv_check(PL_defstash);
2284 if ((s=PerlEnv_getenv("PERL_DEBUG_MSTATS")) && atoi(s) >= 2)
2285 dump_mstats("after compilation:");
2295 =for apidoc perl_run
2297 Tells a Perl interpreter to run. See L<perlembed>.
2310 PERL_ARGS_ASSERT_PERL_RUN;
2311 #ifndef MULTIPLICITY
2312 PERL_UNUSED_ARG(my_perl);
2315 oldscope = PL_scopestack_ix;
2323 cxstack_ix = -1; /* start context stack again */
2325 case 0: /* normal completion */
2329 case 2: /* my_exit() */
2330 while (PL_scopestack_ix > oldscope)
2333 PL_curstash = PL_defstash;
2334 if (!(PL_exit_flags & PERL_EXIT_DESTRUCT_END) &&
2335 PL_endav && !PL_minus_c)
2336 call_list(oldscope, PL_endav);
2338 if (PerlEnv_getenv("PERL_DEBUG_MSTATS"))
2339 dump_mstats("after execution: ");
2345 POPSTACK_TO(PL_mainstack);
2348 PerlIO_printf(Perl_error_log, "panic: restartop\n");
2359 S_run_body(pTHX_ I32 oldscope)
2362 DEBUG_r(PerlIO_printf(Perl_debug_log, "%s $` $& $' support.\n",
2363 PL_sawampersand ? "Enabling" : "Omitting"));
2365 if (!PL_restartop) {
2369 exit(0); /* less likely to core dump than my_exit(0) */
2372 DEBUG_x(dump_all());
2375 PERL_DEBUG(PerlIO_printf(Perl_debug_log, "\nEXECUTING...\n\n"));
2379 #ifdef MACOS_TRADITIONAL
2380 PerlIO_printf(Perl_error_log, "%s%s syntax OK\n",
2381 (gMacPerl_ErrorFormat ? "# " : ""),
2382 MacPerl_MPWFileName(PL_origfilename));
2384 PerlIO_printf(Perl_error_log, "%s syntax OK\n", PL_origfilename);
2388 if (PERLDB_SINGLE && PL_DBsingle)
2389 sv_setiv(PL_DBsingle, 1);
2391 call_list(oldscope, PL_initav);
2392 #ifdef PERL_DEBUG_READONLY_OPS
2393 Perl_pending_Slabs_to_ro(aTHX);
2400 PL_op = PL_restartop;
2404 else if (PL_main_start) {
2405 CvDEPTH(PL_main_cv) = 1;
2406 PL_op = PL_main_start;
2414 =head1 SV Manipulation Functions
2416 =for apidoc p||get_sv
2418 Returns the SV of the specified Perl scalar. If C<create> is set and the
2419 Perl variable does not exist then it will be created. If C<create> is not
2420 set and the variable does not exist then NULL is returned.
2426 Perl_get_sv(pTHX_ const char *name, I32 create)
2430 PERL_ARGS_ASSERT_GET_SV;
2432 gv = gv_fetchpv(name, create, SVt_PV);
2439 =head1 Array Manipulation Functions
2441 =for apidoc p||get_av
2443 Returns the AV of the specified Perl array. C<flags> are passed to
2444 C<gv_fetchpv>. If C<GV_ADD> is set and the
2445 Perl variable does not exist then it will be created. If C<flags> is zero
2446 and the variable does not exist then NULL is returned.
2452 Perl_get_av(pTHX_ const char *name, I32 flags)
2454 GV* const gv = gv_fetchpv(name, flags, SVt_PVAV);
2456 PERL_ARGS_ASSERT_GET_AV;
2466 =head1 Hash Manipulation Functions
2468 =for apidoc p||get_hv
2470 Returns the HV of the specified Perl hash. C<flags> are passed to
2471 C<gv_fetchpv>. If C<GV_ADD> is set and the
2472 Perl variable does not exist then it will be created. If C<flags> is zero
2473 and the variable does not exist then NULL is returned.
2479 Perl_get_hv(pTHX_ const char *name, I32 flags)
2481 GV* const gv = gv_fetchpv(name, flags, SVt_PVHV);
2483 PERL_ARGS_ASSERT_GET_HV;
2493 =head1 CV Manipulation Functions
2495 =for apidoc p||get_cvn_flags
2497 Returns the CV of the specified Perl subroutine. C<flags> are passed to
2498 C<gv_fetchpvn_flags>. If C<GV_ADD> is set and the Perl subroutine does not
2499 exist then it will be declared (which has the same effect as saying
2500 C<sub name;>). If C<GV_ADD> is not set and the subroutine does not exist
2501 then NULL is returned.
2503 =for apidoc p||get_cv
2505 Uses C<strlen> to get the length of C<name>, then calls C<get_cvn_flags>.
2511 Perl_get_cvn_flags(pTHX_ const char *name, STRLEN len, I32 flags)
2513 GV* const gv = gv_fetchpvn_flags(name, len, flags, SVt_PVCV);
2514 /* XXX this is probably not what they think they're getting.
2515 * It has the same effect as "sub name;", i.e. just a forward
2518 PERL_ARGS_ASSERT_GET_CVN_FLAGS;
2520 if ((flags & ~GV_NOADD_MASK) && !GvCVu(gv)) {
2521 SV *const sv = newSVpvn_flags(name, len, flags & SVf_UTF8);
2522 return newSUB(start_subparse(FALSE, 0),
2523 newSVOP(OP_CONST, 0, sv),
2532 Perl_get_cv(pTHX_ const char *name, I32 flags)
2534 PERL_ARGS_ASSERT_GET_CV;
2536 return get_cvn_flags(name, strlen(name), flags);
2539 /* Be sure to refetch the stack pointer after calling these routines. */
2543 =head1 Callback Functions
2545 =for apidoc p||call_argv
2547 Performs a callback to the specified Perl sub. See L<perlcall>.
2553 Perl_call_argv(pTHX_ const char *sub_name, I32 flags, register char **argv)
2555 /* See G_* flags in cop.h */
2556 /* null terminated arg list */
2561 PERL_ARGS_ASSERT_CALL_ARGV;
2566 mXPUSHs(newSVpv(*argv,0));
2571 return call_pv(sub_name, flags);
2575 =for apidoc p||call_pv
2577 Performs a callback to the specified Perl sub. See L<perlcall>.
2583 Perl_call_pv(pTHX_ const char *sub_name, I32 flags)
2584 /* name of the subroutine */
2585 /* See G_* flags in cop.h */
2587 PERL_ARGS_ASSERT_CALL_PV;
2589 return call_sv(MUTABLE_SV(get_cv(sub_name, TRUE)), flags);
2593 =for apidoc p||call_method
2595 Performs a callback to the specified Perl method. The blessed object must
2596 be on the stack. See L<perlcall>.
2602 Perl_call_method(pTHX_ const char *methname, I32 flags)
2603 /* name of the subroutine */
2604 /* See G_* flags in cop.h */
2606 PERL_ARGS_ASSERT_CALL_METHOD;
2608 return call_sv(sv_2mortal(newSVpv(methname,0)), flags | G_METHOD);
2611 /* May be called with any of a CV, a GV, or an SV containing the name. */
2613 =for apidoc p||call_sv
2615 Performs a callback to the Perl sub whose name is in the SV. See
2622 Perl_call_sv(pTHX_ SV *sv, VOL I32 flags)
2623 /* See G_* flags in cop.h */
2626 LOGOP myop; /* fake syntax tree node */
2631 bool oldcatch = CATCH_GET;
2633 OP* const oldop = PL_op;
2636 PERL_ARGS_ASSERT_CALL_SV;
2638 if (flags & G_DISCARD) {
2642 if (!(flags & G_WANT)) {
2643 /* Backwards compatibility - as G_SCALAR was 0, it could be omitted.
2648 Zero(&myop, 1, LOGOP);
2649 myop.op_next = NULL;
2650 if (!(flags & G_NOARGS))
2651 myop.op_flags |= OPf_STACKED;
2652 myop.op_flags |= OP_GIMME_REVERSE(flags);
2656 EXTEND(PL_stack_sp, 1);
2657 *++PL_stack_sp = sv;
2659 oldscope = PL_scopestack_ix;
2661 if (PERLDB_SUB && PL_curstash != PL_debstash
2662 /* Handle first BEGIN of -d. */
2663 && (PL_DBcv || (PL_DBcv = GvCV(PL_DBsub)))
2664 /* Try harder, since this may have been a sighandler, thus
2665 * curstash may be meaningless. */
2666 && (SvTYPE(sv) != SVt_PVCV || CvSTASH((const CV *)sv) != PL_debstash)
2667 && !(flags & G_NODEBUG))
2668 PL_op->op_private |= OPpENTERSUB_DB;
2670 if (flags & G_METHOD) {
2671 Zero(&method_op, 1, UNOP);
2672 method_op.op_next = PL_op;
2673 method_op.op_ppaddr = PL_ppaddr[OP_METHOD];
2674 method_op.op_type = OP_METHOD;
2675 myop.op_ppaddr = PL_ppaddr[OP_ENTERSUB];
2676 myop.op_type = OP_ENTERSUB;
2677 PL_op = (OP*)&method_op;
2680 if (!(flags & G_EVAL)) {
2682 CALL_BODY_SUB((OP*)&myop);
2683 retval = PL_stack_sp - (PL_stack_base + oldmark);
2684 CATCH_SET(oldcatch);
2687 myop.op_other = (OP*)&myop;
2689 create_eval_scope(flags|G_FAKINGEVAL);
2697 CALL_BODY_SUB((OP*)&myop);
2698 retval = PL_stack_sp - (PL_stack_base + oldmark);
2699 if (!(flags & G_KEEPERR)) {
2707 /* my_exit() was called */
2708 PL_curstash = PL_defstash;
2711 if (PL_statusvalue && !(PL_exit_flags & PERL_EXIT_EXPECTED))
2712 Perl_croak(aTHX_ "Callback called exit");
2717 PL_op = PL_restartop;
2721 PL_stack_sp = PL_stack_base + oldmark;
2722 if ((flags & G_WANT) == G_ARRAY)
2726 *++PL_stack_sp = &PL_sv_undef;
2731 if (PL_scopestack_ix > oldscope)
2732 delete_eval_scope();
2736 if (flags & G_DISCARD) {
2737 PL_stack_sp = PL_stack_base + oldmark;
2746 /* Eval a string. The G_EVAL flag is always assumed. */
2749 =for apidoc p||eval_sv
2751 Tells Perl to C<eval> the string in the SV.
2757 Perl_eval_sv(pTHX_ SV *sv, I32 flags)
2759 /* See G_* flags in cop.h */
2763 UNOP myop; /* fake syntax tree node */
2764 VOL I32 oldmark = SP - PL_stack_base;
2767 OP* const oldop = PL_op;
2770 PERL_ARGS_ASSERT_EVAL_SV;
2772 if (flags & G_DISCARD) {
2779 Zero(PL_op, 1, UNOP);
2780 EXTEND(PL_stack_sp, 1);
2781 *++PL_stack_sp = sv;
2783 if (!(flags & G_NOARGS))
2784 myop.op_flags = OPf_STACKED;
2785 myop.op_next = NULL;
2786 myop.op_type = OP_ENTEREVAL;
2787 myop.op_flags |= OP_GIMME_REVERSE(flags);
2788 if (flags & G_KEEPERR)
2789 myop.op_flags |= OPf_SPECIAL;
2791 /* fail now; otherwise we could fail after the JMPENV_PUSH but
2792 * before a PUSHEVAL, which corrupts the stack after a croak */
2793 TAINT_PROPER("eval_sv()");
2799 CALL_BODY_EVAL((OP*)&myop);
2800 retval = PL_stack_sp - (PL_stack_base + oldmark);
2801 if (!(flags & G_KEEPERR)) {
2809 /* my_exit() was called */
2810 PL_curstash = PL_defstash;
2813 if (PL_statusvalue && !(PL_exit_flags & PERL_EXIT_EXPECTED))
2814 Perl_croak(aTHX_ "Callback called exit");
2819 PL_op = PL_restartop;
2823 PL_stack_sp = PL_stack_base + oldmark;
2824 if ((flags & G_WANT) == G_ARRAY)
2828 *++PL_stack_sp = &PL_sv_undef;
2834 if (flags & G_DISCARD) {
2835 PL_stack_sp = PL_stack_base + oldmark;
2845 =for apidoc p||eval_pv
2847 Tells Perl to C<eval> the given string and return an SV* result.
2853 Perl_eval_pv(pTHX_ const char *p, I32 croak_on_error)
2857 SV* sv = newSVpv(p, 0);
2859 PERL_ARGS_ASSERT_EVAL_PV;
2861 eval_sv(sv, G_SCALAR);
2868 if (croak_on_error && SvTRUE(ERRSV)) {
2869 Perl_croak(aTHX_ "%s", SvPVx_nolen_const(ERRSV));
2875 /* Require a module. */
2878 =head1 Embedding Functions
2880 =for apidoc p||require_pv
2882 Tells Perl to C<require> the file named by the string argument. It is
2883 analogous to the Perl code C<eval "require '$file'">. It's even
2884 implemented that way; consider using load_module instead.
2889 Perl_require_pv(pTHX_ const char *pv)
2895 PERL_ARGS_ASSERT_REQUIRE_PV;
2897 PUSHSTACKi(PERLSI_REQUIRE);
2899 sv = Perl_newSVpvf(aTHX_ "require q%c%s%c", 0, pv, 0);
2900 eval_sv(sv_2mortal(sv), G_DISCARD);
2906 S_usage(pTHX_ const char *name) /* XXX move this out into a module ? */
2908 /* This message really ought to be max 23 lines.
2909 * Removed -h because the user already knows that option. Others? */
2911 static const char * const usage_msg[] = {
2912 "-0[octal] specify record separator (\\0, if no argument)",
2913 "-a autosplit mode with -n or -p (splits $_ into @F)",
2914 "-C[number/list] enables the listed Unicode features",
2915 "-c check syntax only (runs BEGIN and CHECK blocks)",
2916 "-d[:debugger] run program under debugger",
2917 "-D[number/list] set debugging flags (argument is a bit mask or alphabets)",
2918 "-e program one line of program (several -e's allowed, omit programfile)",
2919 "-E program like -e, but enables all optional features",
2920 "-f don't do $sitelib/sitecustomize.pl at startup",
2921 "-F/pattern/ split() pattern for -a switch (//'s are optional)",
2922 "-i[extension] edit <> files in place (makes backup if extension supplied)",
2923 "-Idirectory specify @INC/#include directory (several -I's allowed)",
2924 "-l[octal] enable line ending processing, specifies line terminator",
2925 "-[mM][-]module execute \"use/no module...\" before executing program",
2926 "-n assume \"while (<>) { ... }\" loop around program",
2927 "-p assume loop like -n but print line also, like sed",
2928 "-s enable rudimentary parsing for switches after programfile",
2929 "-S look for programfile using PATH environment variable",
2930 "-t enable tainting warnings",
2931 "-T enable tainting checks",
2932 "-u dump core after parsing program",
2933 "-U allow unsafe operations",
2934 "-v print version, subversion (includes VERY IMPORTANT perl info)",
2935 "-V[:variable] print configuration summary (or a single Config.pm variable)",
2936 "-w enable many useful warnings (RECOMMENDED)",
2937 "-W enable all warnings",
2938 "-x[directory] strip off text before #!perl line and perhaps cd to directory",
2939 "-X disable all warnings",
2943 const char * const *p = usage_msg;
2945 PERL_ARGS_ASSERT_USAGE;
2947 PerlIO_printf(PerlIO_stdout(),
2948 "\nUsage: %s [switches] [--] [programfile] [arguments]",
2951 PerlIO_printf(PerlIO_stdout(), "\n %s", *p++);
2954 /* convert a string of -D options (or digits) into an int.
2955 * sets *s to point to the char after the options */
2959 Perl_get_debug_opts(pTHX_ const char **s, bool givehelp)
2961 static const char * const usage_msgd[] = {
2962 " Debugging flag values: (see also -d)",
2963 " p Tokenizing and parsing (with v, displays parse stack)",
2964 " s Stack snapshots (with v, displays all stacks)",
2965 " l Context (loop) stack processing",
2966 " t Trace execution",
2967 " o Method and overloading resolution",
2968 " c String/numeric conversions",
2969 " P Print profiling info, source file input state",
2970 " m Memory and SV allocation",
2971 " f Format processing",
2972 " r Regular expression parsing and execution",
2973 " x Syntax tree dump",
2974 " u Tainting checks",
2975 " H Hash dump -- usurps values()",
2976 " X Scratchpad allocation",
2979 " R Include reference counts of dumped variables (eg when using -Ds)",
2980 " J Do not s,t,P-debug (Jump over) opcodes within package DB",
2981 " v Verbose: use in conjunction with other flags",
2983 " A Consistency checks on internal structures",
2984 " q quiet - currently only suppresses the 'EXECUTING' message",
2989 PERL_ARGS_ASSERT_GET_DEBUG_OPTS;
2992 /* if adding extra options, remember to update DEBUG_MASK */
2993 static const char debopts[] = "psltocPmfrxuUHXDSTRJvCAq";
2995 for (; isALNUM(**s); (*s)++) {
2996 const char * const d = strchr(debopts,**s);
2998 i |= 1 << (d - debopts);
2999 else if (ckWARN_d(WARN_DEBUGGING))
3000 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3001 "invalid option -D%c, use -D'' to see choices\n", **s);
3004 else if (isDIGIT(**s)) {
3006 for (; isALNUM(**s); (*s)++) ;
3008 else if (givehelp) {
3009 const char *const *p = usage_msgd;
3010 while (*p) PerlIO_printf(PerlIO_stdout(), "%s\n", *p++);
3013 if ((i & DEBUG_p_FLAG) && ckWARN_d(WARN_DEBUGGING))
3014 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3015 "-Dp not implemented on this platform\n");
3021 /* This routine handles any switches that can be given during run */
3024 Perl_moreswitches(pTHX_ const char *s)
3028 const char option = *s; /* used to remember option in -m/-M code */
3030 PERL_ARGS_ASSERT_MORESWITCHES;
3038 SvREFCNT_dec(PL_rs);
3039 if (s[1] == 'x' && s[2]) {
3040 const char *e = s+=2;
3046 flags = PERL_SCAN_SILENT_ILLDIGIT;
3047 rschar = (U32)grok_hex(s, &numlen, &flags, NULL);
3048 if (s + numlen < e) {
3049 rschar = 0; /* Grandfather -0xFOO as -0 -xFOO. */
3053 PL_rs = newSVpvs("");
3054 SvGROW(PL_rs, (STRLEN)(UNISKIP(rschar) + 1));
3055 tmps = (U8*)SvPVX(PL_rs);
3056 uvchr_to_utf8(tmps, rschar);
3057 SvCUR_set(PL_rs, UNISKIP(rschar));
3062 rschar = (U32)grok_oct(s, &numlen, &flags, NULL);
3063 if (rschar & ~((U8)~0))
3064 PL_rs = &PL_sv_undef;
3065 else if (!rschar && numlen >= 2)
3066 PL_rs = newSVpvs("");
3068 char ch = (char)rschar;
3069 PL_rs = newSVpvn(&ch, 1);
3072 sv_setsv(get_sv("/", TRUE), PL_rs);
3077 PL_unicode = parse_unicode_opts( (const char **)&s );
3078 if (PL_unicode & PERL_UNICODE_UTF8CACHEASSERT_FLAG)
3084 while (*s && !isSPACE(*s)) ++s;
3085 PL_splitstr = savepvn(PL_splitstr, s - PL_splitstr);
3096 forbid_setid('d', FALSE);
3099 /* -dt indicates to the debugger that threads will be used */
3100 if (*s == 't' && !isALNUM(s[1])) {
3102 my_setenv("PERL5DB_THREADED", "1");
3105 /* The following permits -d:Mod to accepts arguments following an =
3106 in the fashion that -MSome::Mod does. */
3107 if (*s == ':' || *s == '=') {
3108 const char *start = ++s;
3109 const char *const end = s + strlen(s);
3110 SV * const sv = newSVpvs("use Devel::");
3112 /* We now allow -d:Module=Foo,Bar */
3113 while(isALNUM(*s) || *s==':') ++s;
3115 sv_catpvn(sv, start, end - start);
3117 sv_catpvn(sv, start, s-start);
3118 /* Don't use NUL as q// delimiter here, this string goes in the
3120 Perl_sv_catpvf(aTHX_ sv, " split(/,/,q{%s});", ++s);
3123 my_setenv("PERL5DB", SvPV_nolen_const(sv));
3127 PL_perldb = PERLDB_ALL;
3134 forbid_setid('D', FALSE);
3136 PL_debug = get_debug_opts( (const char **)&s, 1) | DEBUG_TOP_FLAG;
3137 #else /* !DEBUGGING */
3138 if (ckWARN_d(WARN_DEBUGGING))
3139 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3140 "Recompile perl with -DDEBUGGING to use -D switch (did you mean -d ?)\n");
3141 for (s++; isALNUM(*s); s++) ;
3146 usage(PL_origargv[0]);
3149 Safefree(PL_inplace);
3150 #if defined(__CYGWIN__) /* do backup extension automagically */
3151 if (*(s+1) == '\0') {
3152 PL_inplace = savepvs(".bak");
3155 #endif /* __CYGWIN__ */
3157 const char * const start = ++s;
3158 while (*s && !isSPACE(*s))
3161 PL_inplace = savepvn(start, s - start);
3165 if (*s == '-') /* Additional switches on #! line. */
3169 case 'I': /* -I handled both here and in parse_body() */
3170 forbid_setid('I', FALSE);
3172 while (*s && isSPACE(*s))
3177 /* ignore trailing spaces (possibly followed by other switches) */
3179 for (e = p; *e && !isSPACE(*e); e++) ;
3183 } while (*p && *p != '-');
3184 e = savepvn(s, e-s);
3185 incpush(e, TRUE, TRUE, FALSE, FALSE, TRUE);
3192 Perl_croak(aTHX_ "No directory specified for -I");
3198 SvREFCNT_dec(PL_ors_sv);
3204 PL_ors_sv = newSVpvs("\n");
3205 numlen = 3 + (*s == '0');
3206 *SvPVX(PL_ors_sv) = (char)grok_oct(s, &numlen, &flags, NULL);
3210 if (RsPARA(PL_rs)) {
3211 PL_ors_sv = newSVpvs("\n\n");
3214 PL_ors_sv = newSVsv(PL_rs);
3219 forbid_setid('M', FALSE); /* XXX ? */
3222 forbid_setid('m', FALSE); /* XXX ? */
3227 const char *use = "use ";
3229 /* -M-foo == 'no foo' */
3230 /* Leading space on " no " is deliberate, to make both
3231 possibilities the same length. */
3232 if (*s == '-') { use = " no "; ++s; }
3233 sv = newSVpvn(use,4);
3235 /* We allow -M'Module qw(Foo Bar)' */
3236 while(isALNUM(*s) || *s==':') {
3245 Perl_croak(aTHX_ "Module name required with -%c option",
3248 Perl_croak(aTHX_ "Invalid module name %.*s with -%c option: "
3249 "contains single ':'",
3250 (int)(s - start), start, option);
3251 end = s + strlen(s);
3253 sv_catpvn(sv, start, end - start);
3254 if (option == 'm') {
3256 Perl_croak(aTHX_ "Can't use '%c' after -mname", *s);
3257 sv_catpvs( sv, " ()");
3260 sv_catpvn(sv, start, s-start);
3261 /* Use NUL as q''-delimiter. */
3262 sv_catpvs(sv, " split(/,/,q\0");
3264 sv_catpvn(sv, s, end - s);
3265 sv_catpvs(sv, "\0)");
3268 Perl_av_create_and_push(aTHX_ &PL_preambleav, sv);
3271 Perl_croak(aTHX_ "Missing argument to -%c", option);
3282 forbid_setid('s', FALSE);
3283 PL_doswitches = TRUE;
3297 #ifdef MACOS_TRADITIONAL
3298 Perl_croak(aTHX_ "Believe me, you don't want to use \"-u\" on a Macintosh");
3300 PL_do_undump = TRUE;
3308 if (!sv_derived_from(PL_patchlevel, "version"))
3309 upg_version(PL_patchlevel, TRUE);
3312 SV* level= vstringify(PL_patchlevel);
3313 #ifdef PERL_PATCHNUM
3314 SV* num= newSVpvn(PERL_PATCHNUM,sizeof(PERL_PATCHNUM)-1);
3315 #ifdef PERL_GIT_UNCOMMITTED_CHANGES
3316 sv_catpvs(num, "*");
3319 if (sv_len(num)>=sv_len(level) && strnEQ(SvPV_nolen(num),SvPV_nolen(level),sv_len(level))) {
3320 SvREFCNT_dec(level);
3323 Perl_sv_catpvf(aTHX_ level, " (%"SVf")", num);
3327 PerlIO_printf(PerlIO_stdout(),
3328 "\nThis is perl, %"SVf
3332 SvREFCNT_dec(level);
3335 /* Adjust verbose output as in the perl that ships with the DG/UX OS from EMC */
3336 PerlIO_printf(PerlIO_stdout(),
3337 Perl_form(aTHX_ "\nThis is perl, %"SVf"\n",
3338 SVfARG(vstringify(PL_patchlevel))));
3339 PerlIO_printf(PerlIO_stdout(),
3340 Perl_form(aTHX_ " built under %s at %s %s\n",
3341 OSNAME, __DATE__, __TIME__));
3342 PerlIO_printf(PerlIO_stdout(),
3343 Perl_form(aTHX_ " OS Specific Release: %s\n",
3346 #if defined(LOCAL_PATCH_COUNT)
3347 if (LOCAL_PATCH_COUNT > 0)
3348 PerlIO_printf(PerlIO_stdout(),
3349 "\n(with %d registered patch%s, "
3350 "see perl -V for more detail)",
3352 (LOCAL_PATCH_COUNT!=1) ? "es" : "");
3355 PerlIO_printf(PerlIO_stdout(),
3356 "\n\nCopyright 1987-2009, Larry Wall\n");
3357 #ifdef MACOS_TRADITIONAL
3358 PerlIO_printf(PerlIO_stdout(),
3359 "\nMac OS port Copyright 1991-2002, Matthias Neeracher;\n"
3360 "maintained by Chris Nandor\n");
3363 PerlIO_printf(PerlIO_stdout(),
3364 "\nMS-DOS port Copyright (c) 1989, 1990, Diomidis Spinellis\n");
3367 PerlIO_printf(PerlIO_stdout(),
3368 "djgpp v2 port (jpl5003c) by Hirofumi Watanabe, 1996\n"
3369 "djgpp v2 port (perl5004+) by Laszlo Molnar, 1997-1999\n");
3372 PerlIO_printf(PerlIO_stdout(),
3373 "\n\nOS/2 port Copyright (c) 1990, 1991, Raymond Chen, Kai Uwe Rommel\n"
3374 "Version 5 port Copyright (c) 1994-2002, Andreas Kaiser, Ilya Zakharevich\n");
3377 PerlIO_printf(PerlIO_stdout(),
3378 "atariST series port, ++jrb bammi@cadence.com\n");
3381 PerlIO_printf(PerlIO_stdout(),
3382 "BeOS port Copyright Tom Spindler, 1997-1999\n");
3385 PerlIO_printf(PerlIO_stdout(),
3386 "MPE/iX port Copyright by Mark Klein and Mark Bixby, 1996-2003\n");
3389 PerlIO_printf(PerlIO_stdout(),
3390 "MVS (OS390) port by Mortice Kern Systems, 1997-1999\n");
3393 PerlIO_printf(PerlIO_stdout(),
3394 "Stratus VOS port by Paul.Green@stratus.com, 1997-2002\n");
3397 PerlIO_printf(PerlIO_stdout(),
3398 "VM/ESA port by Neale Ferguson, 1998-1999\n");
3401 PerlIO_printf(PerlIO_stdout(),
3402 "BS2000 (POSIX) port by Start Amadeus GmbH, 1998-1999\n");
3405 PerlIO_printf(PerlIO_stdout(),
3406 "MiNT port by Guido Flohr, 1997-1999\n");
3409 PerlIO_printf(PerlIO_stdout(),
3410 "EPOC port by Olaf Flebbe, 1999-2002\n");
3413 PerlIO_printf(PerlIO_stdout(),"WINCE port by Rainer Keuchel, 2001-2002\n");
3414 PerlIO_printf(PerlIO_stdout(),"Built on " __DATE__ " " __TIME__ "\n\n");
3417 #ifdef __SYMBIAN32__
3418 PerlIO_printf(PerlIO_stdout(),
3419 "Symbian port by Nokia, 2004-2005\n");
3421 #ifdef BINARY_BUILD_NOTICE
3422 BINARY_BUILD_NOTICE;
3424 PerlIO_printf(PerlIO_stdout(),
3426 Perl may be copied only under the terms of either the Artistic License or the\n\
3427 GNU General Public License, which may be found in the Perl 5 source kit.\n\n\
3428 Complete documentation for Perl, including FAQ lists, should be found on\n\
3429 this system using \"man perl\" or \"perldoc perl\". If you have access to the\n\
3430 Internet, point your browser at http://www.perl.org/, the Perl Home Page.\n\n");
3433 if (! (PL_dowarn & G_WARN_ALL_MASK)) {
3434 PL_dowarn |= G_WARN_ON;
3439 PL_dowarn = G_WARN_ALL_ON|G_WARN_ON;
3440 if (!specialWARN(PL_compiling.cop_warnings))
3441 PerlMemShared_free(PL_compiling.cop_warnings);
3442 PL_compiling.cop_warnings = pWARN_ALL ;
3446 PL_dowarn = G_WARN_ALL_OFF;
3447 if (!specialWARN(PL_compiling.cop_warnings))
3448 PerlMemShared_free(PL_compiling.cop_warnings);
3449 PL_compiling.cop_warnings = pWARN_NONE ;
3456 if (s[0] == '-') /* Additional switches on #! line. */
3461 #if defined(WIN32) || !defined(PERL_STRICT_CR)
3467 #ifdef ALTERNATE_SHEBANG
3468 case 'S': /* OS/2 needs -S on "extproc" line. */
3472 Perl_croak(aTHX_ "Can't emulate -%.1s on #! line",s);
3477 /* compliments of Tom Christiansen */
3479 /* unexec() can be found in the Gnu emacs distribution */
3480 /* Known to work with -DUNEXEC and using unexelf.c from GNU emacs-20.2 */
3483 Perl_my_unexec(pTHX)
3485 PERL_UNUSED_CONTEXT;
3487 SV * prog = newSVpv(BIN_EXP, 0);
3488 SV * file = newSVpv(PL_origfilename, 0);
3492 sv_catpvs(prog, "/perl");
3493 sv_catpvs(file, ".perldump");
3495 unexec(SvPVX(file), SvPVX(prog), &etext, sbrk(0), 0);
3496 /* unexec prints msg to stderr in case of failure */
3497 PerlProc_exit(status);
3500 # include <lib$routines.h>
3501 lib$signal(SS$_DEBUG); /* ssdef.h #included from vmsish.h */
3502 # elif defined(WIN32) || defined(__CYGWIN__)
3503 Perl_croak(aTHX_ "dump is not supported");
3505 ABORT(); /* for use with undump */
3510 /* initialize curinterp */
3516 # define PERLVAR(var,type)
3517 # define PERLVARA(var,n,type)
3518 # if defined(PERL_IMPLICIT_CONTEXT)
3519 # define PERLVARI(var,type,init) aTHX->var = init;
3520 # define PERLVARIC(var,type,init) aTHX->var = init;
3522 # define PERLVARI(var,type,init) PERL_GET_INTERP->var = init;
3523 # define PERLVARIC(var,type,init) PERL_GET_INTERP->var = init;
3525 # include "intrpvar.h"
3531 # define PERLVAR(var,type)
3532 # define PERLVARA(var,n,type)
3533 # define PERLVARI(var,type,init) PL_##var = init;
3534 # define PERLVARIC(var,type,init) PL_##var = init;
3535 # include "intrpvar.h"
3542 /* As these are inside a structure, PERLVARI isn't capable of initialising
3544 PL_reg_oldcurpm = PL_reg_curpm = NULL;
3545 PL_reg_poscache = PL_reg_starttry = NULL;
3549 S_init_main_stash(pTHX)
3554 PL_curstash = PL_defstash = newHV();
3555 /* We know that the string "main" will be in the global shared string
3556 table, so it's a small saving to use it rather than allocate another
3558 PL_curstname = newSVpvs_share("main");
3559 gv = gv_fetchpvs("main::", GV_ADD|GV_NOTQUAL, SVt_PVHV);
3560 /* If we hadn't caused another reference to "main" to be in the shared
3561 string table above, then it would be worth reordering these two,
3562 because otherwise all we do is delete "main" from it as a consequence
3563 of the SvREFCNT_dec, only to add it again with hv_name_set */
3564 SvREFCNT_dec(GvHV(gv));
3565 hv_name_set(PL_defstash, "main", 4, 0);
3566 GvHV(gv) = MUTABLE_HV(SvREFCNT_inc_simple(PL_defstash));
3568 PL_incgv = gv_HVadd(gv_AVadd(gv_fetchpvs("INC", GV_ADD|GV_NOTQUAL,
3570 SvREFCNT_inc_simple_void(PL_incgv); /* Don't allow it to be freed */
3571 GvMULTI_on(PL_incgv);
3572 PL_hintgv = gv_fetchpvs("\010", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^H */
3573 GvMULTI_on(PL_hintgv);
3574 PL_defgv = gv_fetchpvs("_", GV_ADD|GV_NOTQUAL, SVt_PVAV);
3575 SvREFCNT_inc_simple_void(PL_defgv);
3576 PL_errgv = gv_HVadd(gv_fetchpvs("@", GV_ADD|GV_NOTQUAL, SVt_PV));
3577 SvREFCNT_inc_simple_void(PL_errgv);
3578 GvMULTI_on(PL_errgv);
3579 PL_replgv = gv_fetchpvs("\022", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^R */
3580 GvMULTI_on(PL_replgv);
3581 (void)Perl_form(aTHX_ "%240s",""); /* Preallocate temp - for immediate signals. */
3582 #ifdef PERL_DONT_CREATE_GVSV
3585 sv_grow(ERRSV, 240); /* Preallocate - for immediate signals. */
3587 PL_curstash = PL_defstash;
3588 CopSTASH_set(&PL_compiling, PL_defstash);
3589 PL_debstash = GvHV(gv_fetchpvs("DB::", GV_ADDMULTI, SVt_PVHV));
3590 PL_globalstash = GvHV(gv_fetchpvs("CORE::GLOBAL::", GV_ADDMULTI,
3592 /* We must init $/ before switches are processed. */
3593 sv_setpvs(get_sv("/", TRUE), "\n");
3597 S_open_script(pTHX_ const char *scriptname, bool dosearch,
3598 bool *suidscript, PerlIO **rsfpp)
3603 PERL_ARGS_ASSERT_OPEN_SCRIPT;
3606 PL_origfilename = (PL_minus_E ? savepvs("-E") : savepvs( "-e" ));
3609 /* if find_script() returns, it returns a malloc()-ed value */
3610 scriptname = PL_origfilename = find_script(scriptname, dosearch, NULL, 1);
3612 if (strnEQ(scriptname, "/dev/fd/", 8) && isDIGIT(scriptname[8]) ) {
3613 const char *s = scriptname + 8;
3619 * Tell apart "normal" usage of fdscript, e.g.
3620 * with bash on FreeBSD:
3621 * perl <( echo '#!perl -DA'; echo 'print "$0\n"')
3622 * from usage in suidperl.
3623 * Does any "normal" usage leave garbage after the number???
3624 * Is it a mistake to use a similar /dev/fd/ construct for
3629 * Be supersafe and do some sanity-checks.
3630 * Still, can we be sure we got the right thing?
3633 Perl_croak(aTHX_ "Wrong syntax (suid) fd script name \"%s\"\n", s);
3636 Perl_croak(aTHX_ "Missing (suid) fd script name\n");
3638 scriptname = savepv(s + 1);
3639 Safefree(PL_origfilename);
3640 PL_origfilename = (char *)scriptname;
3645 CopFILE_free(PL_curcop);
3646 CopFILE_set(PL_curcop, PL_origfilename);
3647 if (*PL_origfilename == '-' && PL_origfilename[1] == '\0')
3648 scriptname = (char *)"";
3649 if (fdscript >= 0) {
3650 *rsfpp = PerlIO_fdopen(fdscript,PERL_SCRIPT_MODE);
3651 # if defined(HAS_FCNTL) && defined(F_SETFD)
3653 /* ensure close-on-exec */
3654 fcntl(PerlIO_fileno(*rsfpp),F_SETFD,1);
3659 Perl_croak(aTHX_ "sperl needs fd script\n"
3660 "You should not call sperl directly; do you need to "
3661 "change a #! line\nfrom sperl to perl?\n");
3664 * Do not open (or do other fancy stuff) while setuid.
3665 * Perl does the open, and hands script to suidperl on a fd;
3666 * suidperl only does some checks, sets up UIDs and re-execs
3667 * perl with that fd as it has always done.
3671 Perl_croak(aTHX_ "suidperl needs (suid) fd script\n");
3674 else if (!*scriptname) {
3675 forbid_setid(0, *suidscript);
3676 *rsfpp = PerlIO_stdin();
3679 #ifdef FAKE_BIT_BUCKET
3680 /* This hack allows one not to have /dev/null (or BIT_BUCKET as it
3681 * is called) and still have the "-e" work. (Believe it or not,
3682 * a /dev/null is required for the "-e" to work because source
3683 * filter magic is used to implement it. ) This is *not* a general
3684 * replacement for a /dev/null. What we do here is create a temp
3685 * file (an empty file), open up that as the script, and then
3686 * immediately close and unlink it. Close enough for jazz. */
3687 #define FAKE_BIT_BUCKET_PREFIX "/tmp/perlnull-"
3688 #define FAKE_BIT_BUCKET_SUFFIX "XXXXXXXX"
3689 #define FAKE_BIT_BUCKET_TEMPLATE FAKE_BIT_BUCKET_PREFIX FAKE_BIT_BUCKET_SUFFIX
3690 char tmpname[sizeof(FAKE_BIT_BUCKET_TEMPLATE)] = {
3691 FAKE_BIT_BUCKET_TEMPLATE
3693 const char * const err = "Failed to create a fake bit bucket";
3694 if (strEQ(scriptname, BIT_BUCKET)) {
3695 #ifdef HAS_MKSTEMP /* Hopefully mkstemp() is safe here. */
3696 int tmpfd = mkstemp(tmpname);
3698 scriptname = tmpname;
3701 Perl_croak(aTHX_ err);
3704 scriptname = mktemp(tmpname);
3706 Perl_croak(aTHX_ err);
3711 *rsfpp = PerlIO_open(scriptname,PERL_SCRIPT_MODE);
3712 #ifdef FAKE_BIT_BUCKET
3713 if (memEQ(scriptname, FAKE_BIT_BUCKET_PREFIX,
3714 sizeof(FAKE_BIT_BUCKET_PREFIX) - 1)
3715 && strlen(scriptname) == sizeof(tmpname) - 1) {
3718 scriptname = BIT_BUCKET;
3720 # if defined(HAS_FCNTL) && defined(F_SETFD)
3722 /* ensure close-on-exec */
3723 fcntl(PerlIO_fileno(*rsfpp),F_SETFD,1);
3726 #endif /* IAMSUID */
3728 /* PSz 16 Sep 03 Keep neat error message */
3730 Perl_croak(aTHX_ "Can't open "BIT_BUCKET": %s\n", Strerror(errno));
3732 Perl_croak(aTHX_ "Can't open perl script \"%s\": %s\n",
3733 CopFILE(PL_curcop), Strerror(errno));
3739 * I_SYSSTATVFS HAS_FSTATVFS
3741 * I_STATFS HAS_FSTATFS HAS_GETFSSTAT
3742 * I_MNTENT HAS_GETMNTENT HAS_HASMNTOPT
3743 * here so that metaconfig picks them up. */
3747 S_fd_on_nosuid_fs(pTHX_ int fd)
3750 * We used to do this as "plain" user (after swapping UIDs with setreuid);
3751 * but is needed also on machines without setreuid.
3752 * Seems safe enough to run as root.
3754 int check_okay = 0; /* able to do all the required sys/libcalls */
3755 int on_nosuid = 0; /* the fd is on a nosuid fs */
3757 * Need to check noexec also: nosuid might not be set, the average
3758 * sysadmin would say that nosuid is irrelevant once he sets noexec.
3760 int on_noexec = 0; /* the fd is on a noexec fs */
3763 * Preferred order: fstatvfs(), fstatfs(), ustat()+getmnt(), getmntent().
3764 * fstatvfs() is UNIX98.
3765 * fstatfs() is 4.3 BSD.
3766 * ustat()+getmnt() is pre-4.3 BSD.
3767 * getmntent() is O(number-of-mounted-filesystems) and can hang on
3768 * an irrelevant filesystem while trying to reach the right one.
3771 #undef FD_ON_NOSUID_CHECK_OKAY /* found the syscalls to do the check? */
3773 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3774 defined(HAS_FSTATVFS)
3775 # define FD_ON_NOSUID_CHECK_OKAY
3776 struct statvfs stfs;
3778 check_okay = fstatvfs(fd, &stfs) == 0;
3779 on_nosuid = check_okay && (stfs.f_flag & ST_NOSUID);
3781 /* ST_NOEXEC certainly absent on AIX 5.1, and doesn't seem to be documented
3782 on platforms where it is present. */
3783 on_noexec = check_okay && (stfs.f_flag & ST_NOEXEC);
3785 # endif /* fstatvfs */
3787 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3788 defined(PERL_MOUNT_NOSUID) && \
3789 defined(PERL_MOUNT_NOEXEC) && \
3790 defined(HAS_FSTATFS) && \
3791 defined(HAS_STRUCT_STATFS) && \
3792 defined(HAS_STRUCT_STATFS_F_FLAGS)
3793 # define FD_ON_NOSUID_CHECK_OKAY
3796 check_okay = fstatfs(fd, &stfs) == 0;
3797 on_nosuid = check_okay && (stfs.f_flags & PERL_MOUNT_NOSUID);
3798 on_noexec = check_okay && (stfs.f_flags & PERL_MOUNT_NOEXEC);
3799 # endif /* fstatfs */
3801 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3802 defined(PERL_MOUNT_NOSUID) && \
3803 defined(PERL_MOUNT_NOEXEC) && \
3804 defined(HAS_FSTAT) && \
3805 defined(HAS_USTAT) && \
3806 defined(HAS_GETMNT) && \
3807 defined(HAS_STRUCT_FS_DATA) && \
3809 # define FD_ON_NOSUID_CHECK_OKAY
3812 if (fstat(fd, &fdst) == 0) {
3814 if (ustat(fdst.st_dev, &us) == 0) {
3816 /* NOSTAT_ONE here because we're not examining fields which
3817 * vary between that case and STAT_ONE. */
3818 if (getmnt((int*)0, &fsd, (int)0, NOSTAT_ONE, us.f_fname) == 0) {
3819 size_t cmplen = sizeof(us.f_fname);
3820 if (sizeof(fsd.fd_req.path) < cmplen)
3821 cmplen = sizeof(fsd.fd_req.path);
3822 if (strnEQ(fsd.fd_req.path, us.f_fname, cmplen) &&
3823 fdst.st_dev == fsd.fd_req.dev) {
3825 on_nosuid = fsd.fd_req.flags & PERL_MOUNT_NOSUID;
3826 on_noexec = fsd.fd_req.flags & PERL_MOUNT_NOEXEC;
3831 # endif /* fstat+ustat+getmnt */
3833 # if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3834 defined(HAS_GETMNTENT) && \
3835 defined(HAS_HASMNTOPT) && \
3836 defined(MNTOPT_NOSUID) && \
3837 defined(MNTOPT_NOEXEC)
3838 # define FD_ON_NOSUID_CHECK_OKAY
3839 FILE *mtab = fopen("/etc/mtab", "r");
3840 struct mntent *entry;
3843 if (mtab && (fstat(fd, &stb) == 0)) {
3844 while (entry = getmntent(mtab)) {
3845 if (stat(entry->mnt_dir, &fsb) == 0
3846 && fsb.st_dev == stb.st_dev)
3848 /* found the filesystem */
3850 if (hasmntopt(entry, MNTOPT_NOSUID))
3852 if (hasmntopt(entry, MNTOPT_NOEXEC))
3855 } /* A single fs may well fail its stat(). */
3860 # endif /* getmntent+hasmntopt */
3863 Perl_croak(aTHX_ "Can't check filesystem of script \"%s\" for nosuid/noexec", PL_origfilename);
3865 Perl_croak(aTHX_ "Setuid script \"%s\" on nosuid filesystem", PL_origfilename);
3867 Perl_croak(aTHX_ "Setuid script \"%s\" on noexec filesystem", PL_origfilename);
3868 return ((!check_okay) || on_nosuid || on_noexec);
3870 #endif /* IAMSUID */
3874 S_validate_suid(pTHX_ const char *validarg,
3876 const char *scriptname,
3882 SV *linestr_sv, PerlIO *rsfp)
3887 PERL_ARGS_ASSERT_VALIDATE_SUID;
3889 /* do we need to emulate setuid on scripts? */
3891 /* This code is for those BSD systems that have setuid #! scripts disabled
3892 * in the kernel because of a security problem. Merely defining DOSUID
3893 * in perl will not fix that problem, but if you have disabled setuid
3894 * scripts in the kernel, this will attempt to emulate setuid and setgid
3895 * on scripts that have those now-otherwise-useless bits set. The setuid
3896 * root version must be called suidperl or sperlN.NNN. If regular perl
3897 * discovers that it has opened a setuid script, it calls suidperl with
3898 * the same argv that it had. If suidperl finds that the script it has
3899 * just opened is NOT setuid root, it sets the effective uid back to the
3900 * uid. We don't just make perl setuid root because that loses the
3901 * effective uid we had before invoking perl, if it was different from the
3904 * Description/comments above do not match current workings:
3905 * suidperl must be hardlinked to sperlN.NNN (that is what we exec);
3906 * suidperl called with script open and name changed to /dev/fd/N/X;
3907 * suidperl croaks if script is not setuid;
3908 * making perl setuid would be a huge security risk (and yes, that
3909 * would lose any euid we might have had).
3911 * DOSUID must be defined in both perl and suidperl, and IAMSUID must
3912 * be defined in suidperl only. suidperl must be setuid root. The
3913 * Configure script will set this up for you if you want it.
3916 if (PerlLIO_fstat(PerlIO_fileno(rsfp),&PL_statbuf) < 0) /* normal stat is insecure */
3917 Perl_croak(aTHX_ "Can't stat script \"%s\"",PL_origfilename);
3918 if (PL_statbuf.st_mode & (S_ISUID|S_ISGID)) {
3920 const char *linestr;
3924 if (fdscript < 0 || !suidscript)
3925 Perl_croak(aTHX_ "Need (suid) fdscript in suidperl\n"); /* We already checked this */
3927 * Since the script is opened by perl, not suidperl, some of these
3928 * checks are superfluous. Leaving them in probably does not lower
3932 * Do checks even for systems with no HAS_SETREUID.
3933 * We used to swap, then re-swap UIDs with
3934 # ifdef HAS_SETREUID
3935 if (setreuid(PL_euid,PL_uid) < 0
3936 || PerlProc_getuid() != PL_euid || PerlProc_geteuid() != PL_uid)
3937 Perl_croak(aTHX_ "Can't swap uid and euid");
3939 # ifdef HAS_SETREUID
3940 if (setreuid(PL_uid,PL_euid) < 0
3941 || PerlProc_getuid() != PL_uid || PerlProc_geteuid() != PL_euid)
3942 Perl_croak(aTHX_ "Can't reswap uid and euid");
3946 /* On this access check to make sure the directories are readable,
3947 * there is actually a small window that the user could use to make
3948 * filename point to an accessible directory. So there is a faint
3949 * chance that someone could execute a setuid script down in a
3950 * non-accessible directory. I don't know what to do about that.
3951 * But I don't think it's too important. The manual lies when
3952 * it says access() is useful in setuid programs.
3954 * So, access() is pretty useless... but not harmful... do anyway.
3956 if (PerlLIO_access(CopFILE(PL_curcop),1)) { /*double check*/
3957 Perl_croak(aTHX_ "Can't access() script\n");
3960 /* If we can swap euid and uid, then we can determine access rights
3961 * with a simple stat of the file, and then compare device and
3962 * inode to make sure we did stat() on the same file we opened.
3963 * Then we just have to make sure he or she can execute it.
3966 * As the script is opened by perl, not suidperl, we do not need to
3967 * care much about access rights.
3969 * The 'script changed' check is needed, or we can get lied to
3970 * about $0 with e.g.
3971 * suidperl /dev/fd/4//bin/x 4<setuidscript
3972 * Without HAS_SETREUID, is it safe to stat() as root?
3974 * Are there any operating systems that pass /dev/fd/xxx for setuid
3975 * scripts, as suggested/described in perlsec(1)? Surely they do not
3976 * pass the script name as we do, so the "script changed" test would
3977 * fail for them... but we never get here with
3978 * SETUID_SCRIPTS_ARE_SECURE_NOW defined.
3980 * This is one place where we must "lie" about return status: not
3981 * say if the stat() failed. We are doing this as root, and could
3982 * be tricked into reporting existence or not of files that the
3983 * "plain" user cannot even see.
3987 if (PerlLIO_stat(CopFILE(PL_curcop),&tmpstatbuf) < 0 ||
3988 tmpstatbuf.st_dev != PL_statbuf.st_dev ||
3989 tmpstatbuf.st_ino != PL_statbuf.st_ino) {
3990 Perl_croak(aTHX_ "Setuid script changed\n");
3994 if (!cando(S_IXUSR,FALSE,&PL_statbuf)) /* can real uid exec? */
3995 Perl_croak(aTHX_ "Real UID cannot exec script\n");
3998 * We used to do this check as the "plain" user (after swapping
3999 * UIDs). But the check for nosuid and noexec filesystem is needed,
4000 * and should be done even without HAS_SETREUID. (Maybe those
4001 * operating systems do not have such mount options anyway...)
4002 * Seems safe enough to do as root.
4004 # if !defined(NO_NOSUID_CHECK)
4005 if (fd_on_nosuid_fs(PerlIO_fileno(rsfp))) {
4006 Perl_croak(aTHX_ "Setuid script on nosuid or noexec filesystem\n");
4009 # endif /* IAMSUID */
4011 if (!S_ISREG(PL_statbuf.st_mode)) {
4012 Perl_croak(aTHX_ "Setuid script not plain file\n");
4014 if (PL_statbuf.st_mode & S_IWOTH)
4015 Perl_croak(aTHX_ "Setuid/gid script is writable by world");
4016 PL_doswitches = FALSE; /* -s is insecure in suid */
4017 /* PSz 13 Nov 03 But -s was caught elsewhere ... so unsetting it here is useless(?!) */
4018 CopLINE_inc(PL_curcop);
4019 if (sv_gets(linestr_sv, rsfp, 0) == NULL)
4020 Perl_croak(aTHX_ "No #! line");
4021 linestr = SvPV_nolen_const(linestr_sv);
4022 /* required even on Sys V */
4023 if (!*linestr || !linestr[1] || strnNE(linestr,"#!",2))
4024 Perl_croak(aTHX_ "No #! line");
4028 /* Sanity check on line length */
4029 s_end = s + strlen(s);
4030 if (s_end == s || (s_end - s) > 4000)
4031 Perl_croak(aTHX_ "Very long #! line");
4032 /* Allow more than a single space after #! */
4033 while (isSPACE(*s)) s++;
4034 /* Sanity check on buffer end */
4035 while ((*s) && !isSPACE(*s)) s++;
4036 for (s2 = s; (s2 > linestr &&
4037 (isDIGIT(s2[-1]) || s2[-1] == '.' || s2[-1] == '_'
4038 || s2[-1] == '-')); s2--) ;
4039 /* Sanity check on buffer start */
4040 if ( (s2-4 < linestr || strnNE(s2-4,"perl",4)) &&
4041 (s-9 < linestr || strnNE(s-9,"perl",4)) )
4042 Perl_croak(aTHX_ "Not a perl script");
4043 while (*s == ' ' || *s == '\t') s++;
4045 * #! arg must be what we saw above. They can invoke it by
4046 * mentioning suidperl explicitly, but they may not add any strange
4047 * arguments beyond what #! says if they do invoke suidperl that way.
4050 * The way validarg was set up, we rely on the kernel to start
4051 * scripts with argv[1] set to contain all #! line switches (the
4055 * Check that we got all the arguments listed in the #! line (not
4056 * just that there are no extraneous arguments). Might not matter
4057 * much, as switches from #! line seem to be acted upon (also), and
4058 * so may be checked and trapped in perl. But, security checks must
4059 * be done in suidperl and not deferred to perl. Note that suidperl
4060 * does not get around to parsing (and checking) the switches on
4061 * the #! line (but execs perl sooner).
4062 * Allow (require) a trailing newline (which may be of two
4063 * characters on some architectures?) (but no other trailing
4066 len = strlen(validarg);
4067 if (strEQ(validarg," PHOOEY ") ||
4068 strnNE(s,validarg,len) || !isSPACE(s[len]) ||
4069 !((s_end - s) == len+1
4070 || ((s_end - s) == len+2 && isSPACE(s[len+1]))))
4071 Perl_croak(aTHX_ "Args must match #! line");
4075 PL_euid != PL_uid && (PL_statbuf.st_mode & S_ISUID) &&
4076 PL_euid == PL_statbuf.st_uid)
4078 Perl_croak(aTHX_ "YOU HAVEN'T DISABLED SET-ID SCRIPTS IN THE KERNEL YET!\n\
4079 FIX YOUR KERNEL, OR PUT A C WRAPPER AROUND THIS SCRIPT!\n");
4080 # endif /* IAMSUID */
4083 PL_euid) { /* oops, we're not the setuid root perl */
4085 * When root runs a setuid script, we do not go through the same
4086 * steps of execing sperl and then perl with fd scripts, but
4087 * simply set up UIDs within the same perl invocation; so do
4088 * not have the same checks (on options, whatever) that we have
4089 * for plain users. No problem really: would have to be a script
4090 * that does not actually work for plain users; and if root is
4091 * foolish and can be persuaded to run such an unsafe script, he
4092 * might run also non-setuid ones, and deserves what he gets.
4094 * Or, we might drop the PL_euid check above (and rely just on
4095 * fdscript to avoid loops), and do the execs
4101 * Pass fd script to suidperl.
4102 * Exec suidperl, substituting fd script for scriptname.
4103 * Pass script name as "subdir" of fd, which perl will grok;
4104 * in fact will use that to distinguish this from "normal"
4105 * usage, see comments above.
4107 PerlIO_rewind(rsfp);
4108 PerlLIO_lseek(PerlIO_fileno(rsfp),(Off_t)0,0); /* just in case rewind didn't */
4109 /* PSz 27 Feb 04 Sanity checks on scriptname */
4110 if ((!scriptname) || (!*scriptname) ) {
4111 Perl_croak(aTHX_ "No setuid script name\n");
4113 if (*scriptname == '-') {
4114 Perl_croak(aTHX_ "Setuid script name may not begin with dash\n");
4115 /* Or we might confuse it with an option when replacing
4116 * name in argument list, below (though we do pointer, not
4117 * string, comparisons).
4120 for (which = 1; PL_origargv[which] && PL_origargv[which] != scriptname; which++) ;
4121 if (!PL_origargv[which]) {
4122 Perl_croak(aTHX_ "Can't change argv to have fd script\n");
4124 PL_origargv[which] = savepv(Perl_form(aTHX_ "/dev/fd/%d/%s",
4125 PerlIO_fileno(rsfp), PL_origargv[which]));
4126 # if defined(HAS_FCNTL) && defined(F_SETFD)
4127 fcntl(PerlIO_fileno(rsfp),F_SETFD,0); /* ensure no close-on-exec */
4130 PerlProc_execv(Perl_form(aTHX_ "%s/sperl"PERL_FS_VER_FMT, BIN_EXP,
4131 (int)PERL_REVISION, (int)PERL_VERSION,
4132 (int)PERL_SUBVERSION), PL_origargv);
4134 # endif /* IAMSUID */
4135 Perl_croak(aTHX_ "Can't do setuid (cannot exec sperl)\n");
4138 if (PL_statbuf.st_mode & S_ISGID && PL_statbuf.st_gid != PL_egid) {
4140 * This seems back to front: we try HAS_SETEGID first; if not available
4141 * then try HAS_SETREGID; as a last chance we try HAS_SETRESGID. May be OK
4142 * in the sense that we only want to set EGID; but are there any machines
4143 * with either of the latter, but not the former? Same with UID, later.
4146 (void)setegid(PL_statbuf.st_gid);
4148 # ifdef HAS_SETREGID
4149 (void)setregid((Gid_t)-1,PL_statbuf.st_gid);
4151 # ifdef HAS_SETRESGID
4152 (void)setresgid((Gid_t)-1,PL_statbuf.st_gid,(Gid_t)-1);
4154 PerlProc_setgid(PL_statbuf.st_gid);
4158 if (PerlProc_getegid() != PL_statbuf.st_gid)
4159 Perl_croak(aTHX_ "Can't do setegid!\n");
4161 if (PL_statbuf.st_mode & S_ISUID) {
4162 if (PL_statbuf.st_uid != PL_euid)
4164 (void)seteuid(PL_statbuf.st_uid); /* all that for this */
4166 # ifdef HAS_SETREUID
4167 (void)setreuid((Uid_t)-1,PL_statbuf.st_uid);
4169 # ifdef HAS_SETRESUID
4170 (void)setresuid((Uid_t)-1,PL_statbuf.st_uid,(Uid_t)-1);
4172 PerlProc_setuid(PL_statbuf.st_uid);
4176 if (PerlProc_geteuid() != PL_statbuf.st_uid)
4177 Perl_croak(aTHX_ "Can't do seteuid!\n");
4179 else if (PL_uid) { /* oops, mustn't run as root */
4181 (void)seteuid((Uid_t)PL_uid);
4183 # ifdef HAS_SETREUID
4184 (void)setreuid((Uid_t)-1,(Uid_t)PL_uid);
4186 # ifdef HAS_SETRESUID
4187 (void)setresuid((Uid_t)-1,(Uid_t)PL_uid,(Uid_t)-1);
4189 PerlProc_setuid((Uid_t)PL_uid);
4193 if (PerlProc_geteuid() != PL_uid)
4194 Perl_croak(aTHX_ "Can't do seteuid!\n");
4197 if (!cando(S_IXUSR,TRUE,&PL_statbuf))
4198 Perl_croak(aTHX_ "Effective UID cannot exec script\n"); /* they can't do this */
4201 else if (fdscript < 0 || !suidscript)
4202 /* PSz 13 Nov 03 Caught elsewhere, useless(?!) here */
4203 Perl_croak(aTHX_ "(suid) fdscript needed in suidperl\n");
4205 /* PSz 16 Sep 03 Keep neat error message */
4206 Perl_croak(aTHX_ "Script is not setuid/setgid in suidperl\n");
4209 /* We absolutely must clear out any saved ids here, so we */
4210 /* exec the real perl, substituting fd script for scriptname. */
4211 /* (We pass script name as "subdir" of fd, which perl will grok.) */
4213 * It might be thought that using setresgid and/or setresuid (changed to
4214 * set the saved IDs) above might obviate the need to exec, and we could
4215 * go on to "do the perl thing".
4217 * Is there such a thing as "saved GID", and is that set for setuid (but
4218 * not setgid) execution like suidperl? Without exec, it would not be
4219 * cleared for setuid (but not setgid) scripts (or might need a dummy
4222 * We need suidperl to do the exact same argument checking that perl
4223 * does. Thus it cannot be very small; while it could be significantly
4224 * smaller, it is safer (simpler?) to make it essentially the same
4225 * binary as perl (but they are not identical). - Maybe could defer that
4226 * check to the invoked perl, and suidperl be a tiny wrapper instead;
4227 * but prefer to do thorough checks in suidperl itself. Such deferral
4228 * would make suidperl security rely on perl, a design no-no.
4230 * Setuid things should be short and simple, thus easy to understand and
4231 * verify. They should do their "own thing", without influence by
4232 * attackers. It may help if their internal execution flow is fixed,
4233 * regardless of platform: it may be best to exec anyway.
4235 * Suidperl should at least be conceptually simple: a wrapper only,
4236 * never to do any real perl. Maybe we should put
4238 * Perl_croak(aTHX_ "Suidperl should never do real perl\n");
4240 * into the perly bits.
4242 PerlIO_rewind(rsfp);
4243 PerlLIO_lseek(PerlIO_fileno(rsfp),(Off_t)0,0); /* just in case rewind didn't */
4245 * Keep original arguments: suidperl already has fd script.
4247 # if defined(HAS_FCNTL) && defined(F_SETFD)
4248 fcntl(PerlIO_fileno(rsfp),F_SETFD,0); /* ensure no close-on-exec */
4251 PerlProc_execv(Perl_form(aTHX_ "%s/perl"PERL_FS_VER_FMT, BIN_EXP,
4252 (int)PERL_REVISION, (int)PERL_VERSION,
4253 (int)PERL_SUBVERSION), PL_origargv);/* try again */
4255 Perl_croak(aTHX_ "Can't do setuid (suidperl cannot exec perl)\n");
4256 # endif /* IAMSUID */
4261 # ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
4262 /* Don't even need this function. */
4265 S_validate_suid(pTHX_ PerlIO *rsfp)
4267 PERL_ARGS_ASSERT_VALIDATE_SUID;
4269 if (PL_euid != PL_uid || PL_egid != PL_gid) { /* (suidperl doesn't exist, in fact) */
4270 # ifndef SETUID_SCRIPTS_ARE_SECURE_NOW
4273 PerlLIO_fstat(PerlIO_fileno(rsfp),&PL_statbuf); /* may be either wrapped or real suid */
4274 if ((PL_euid != PL_uid && PL_euid == PL_statbuf.st_uid && PL_statbuf.st_mode & S_ISUID)
4276 (PL_egid != PL_gid && PL_egid == PL_statbuf.st_gid && PL_statbuf.st_mode & S_ISGID)
4279 Perl_croak(aTHX_ "YOU HAVEN'T DISABLED SET-ID SCRIPTS IN THE KERNEL YET!\n\
4280 FIX YOUR KERNEL, PUT A C WRAPPER AROUND THIS SCRIPT, OR USE -u AND UNDUMP!\n");
4281 # endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4282 /* not set-id, must be wrapped */
4285 # endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4289 S_find_beginning(pTHX_ SV* linestr_sv, PerlIO *rsfp)
4293 register const char *s2;
4294 #ifdef MACOS_TRADITIONAL
4298 PERL_ARGS_ASSERT_FIND_BEGINNING;
4300 /* skip forward in input to the real script? */
4302 #ifdef MACOS_TRADITIONAL
4303 /* Since the Mac OS does not honor #! arguments for us, we do it ourselves */
4305 while (PL_doextract || gMacPerl_AlwaysExtract) {
4306 if ((s = sv_gets(linestr_sv, rsfp, 0)) == NULL) {
4307 if (!gMacPerl_AlwaysExtract)
4308 Perl_croak(aTHX_ "No Perl script found in input\n");
4310 if (PL_doextract) /* require explicit override ? */
4311 if (!OverrideExtract(PL_origfilename))
4312 Perl_croak(aTHX_ "User aborted script\n");
4314 PL_doextract = FALSE;
4316 /* Pater peccavi, file does not have #! */
4317 PerlIO_rewind(rsfp);
4322 while (PL_doextract) {
4323 if ((s = sv_gets(linestr_sv, rsfp, 0)) == NULL)
4324 Perl_croak(aTHX_ "No Perl script found in input\n");
4327 if (*s == '#' && s[1] == '!' && ((s = instr(s,"perl")) || (s = instr(s2,"PERL")))) {
4328 PerlIO_ungetc(rsfp, '\n'); /* to keep line count right */
4329 PL_doextract = FALSE;
4330 while (*s && !(isSPACE (*s) || *s == '#')) s++;
4332 while (*s == ' ' || *s == '\t') s++;
4334 while (isDIGIT(s2[-1]) || s2[-1] == '-' || s2[-1] == '.'
4335 || s2[-1] == '_') s2--;
4336 if (strnEQ(s2-4,"perl",4))
4337 while ((s = moreswitches(s)))
4340 #ifdef MACOS_TRADITIONAL
4341 /* We are always searching for the #!perl line in MacPerl,
4342 * so if we find it, still keep the line count correct
4343 * by counting lines we already skipped over
4345 for (; maclines > 0 ; maclines--)
4346 PerlIO_ungetc(rsfp, '\n');
4350 /* gMacPerl_AlwaysExtract is false in MPW tool */
4351 } else if (gMacPerl_AlwaysExtract) {
4363 PL_uid = PerlProc_getuid();
4364 PL_euid = PerlProc_geteuid();
4365 PL_gid = PerlProc_getgid();
4366 PL_egid = PerlProc_getegid();
4368 PL_uid |= PL_gid << 16;
4369 PL_euid |= PL_egid << 16;
4371 /* Should not happen: */
4372 CHECK_MALLOC_TAINT(PL_uid && (PL_euid != PL_uid || PL_egid != PL_gid));
4373 PL_tainting |= (PL_uid && (PL_euid != PL_uid || PL_egid != PL_gid));
4376 * Should go by suidscript, not uid!=euid: why disallow
4377 * system("ls") in scripts run from setuid things?
4378 * Or, is this run before we check arguments and set suidscript?
4379 * What about SETUID_SCRIPTS_ARE_SECURE_NOW: could we use fdscript then?
4380 * (We never have suidscript, can we be sure to have fdscript?)
4381 * Or must then go by UID checks? See comments in forbid_setid also.
4385 /* This is used very early in the lifetime of the program,
4386 * before even the options are parsed, so PL_tainting has
4387 * not been initialized properly. */
4389 Perl_doing_taint(int argc, char *argv[], char *envp[])
4391 #ifndef PERL_IMPLICIT_SYS
4392 /* If we have PERL_IMPLICIT_SYS we can't call getuid() et alia
4393 * before we have an interpreter-- and the whole point of this
4394 * function is to be called at such an early stage. If you are on
4395 * a system with PERL_IMPLICIT_SYS but you do have a concept of
4396 * "tainted because running with altered effective ids', you'll
4397 * have to add your own checks somewhere in here. The two most
4398 * known samples of 'implicitness' are Win32 and NetWare, neither
4399 * of which has much of concept of 'uids'. */
4400 int uid = PerlProc_getuid();
4401 int euid = PerlProc_geteuid();
4402 int gid = PerlProc_getgid();
4403 int egid = PerlProc_getegid();
4410 if (uid && (euid != uid || egid != gid))
4412 #endif /* !PERL_IMPLICIT_SYS */
4413 /* This is a really primitive check; environment gets ignored only
4414 * if -T are the first chars together; otherwise one gets
4415 * "Too late" message. */
4416 if ( argc > 1 && argv[1][0] == '-'
4417 && (argv[1][1] == 't' || argv[1][1] == 'T') )
4422 /* Passing the flag as a single char rather than a string is a slight space
4423 optimisation. The only message that isn't /^-.$/ is
4424 "program input from stdin", which is substituted in place of '\0', which
4425 could never be a command line flag. */
4427 S_forbid_setid(pTHX_ const char flag, const bool suidscript) /* g */
4430 char string[3] = "-x";
4431 const char *message = "program input from stdin";
4438 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
4439 if (PL_euid != PL_uid)
4440 Perl_croak(aTHX_ "No %s allowed while running setuid", message);
4441 if (PL_egid != PL_gid)
4442 Perl_croak(aTHX_ "No %s allowed while running setgid", message);
4443 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4445 * Checks for UID/GID above "wrong": why disallow
4446 * perl -e 'print "Hello\n"'
4447 * from within setuid things?? Simply drop them: replaced by
4448 * fdscript/suidscript and #ifdef IAMSUID checks below.
4450 * This may be too late for command-line switches. Will catch those on
4451 * the #! line, after finding the script name and setting up
4452 * fdscript/suidscript. Note that suidperl does not get around to
4453 * parsing (and checking) the switches on the #! line, but checks that
4454 * the two sets are identical.
4456 * With SETUID_SCRIPTS_ARE_SECURE_NOW, could we use fdscript, also or
4457 * instead, or would that be "too late"? (We never have suidscript, can
4458 * we be sure to have fdscript?)
4460 * Catch things with suidscript (in descendant of suidperl), even with
4461 * right UID/GID. Was already checked in suidperl, with #ifdef IAMSUID,
4462 * below; but I am paranoid.
4464 * Also see comments about root running a setuid script, elsewhere.
4467 Perl_croak(aTHX_ "No %s allowed with (suid) fdscript", message);
4469 /* PSz 11 Nov 03 Catch it in suidperl, always! */
4470 Perl_croak(aTHX_ "No %s allowed in suidperl", message);
4471 #endif /* IAMSUID */
4475 Perl_init_debugger(pTHX)
4478 HV * const ostash = PL_curstash;
4480 PL_curstash = PL_debstash;
4481 PL_dbargs = GvAV(gv_AVadd((gv_fetchpvs("DB::args", GV_ADDMULTI,
4483 AvREAL_off(PL_dbargs);
4484 PL_DBgv = gv_fetchpvs("DB::DB", GV_ADDMULTI, SVt_PVGV);
4485 PL_DBline = gv_fetchpvs("DB::dbline", GV_ADDMULTI, SVt_PVAV);
4486 PL_DBsub = gv_HVadd(gv_fetchpvs("DB::sub", GV_ADDMULTI, SVt_PVHV));
4487 PL_DBsingle = GvSV((gv_fetchpvs("DB::single", GV_ADDMULTI, SVt_PV)));
4488 sv_setiv(PL_DBsingle, 0);
4489 PL_DBtrace = GvSV((gv_fetchpvs("DB::trace", GV_ADDMULTI, SVt_PV)));
4490 sv_setiv(PL_DBtrace, 0);
4491 PL_DBsignal = GvSV((gv_fetchpvs("DB::signal", GV_ADDMULTI, SVt_PV)));
4492 sv_setiv(PL_DBsignal, 0);
4493 PL_curstash = ostash;
4496 #ifndef STRESS_REALLOC
4497 #define REASONABLE(size) (size)
4499 #define REASONABLE(size) (1) /* unreasonable */
4503 Perl_init_stacks(pTHX)
4506 /* start with 128-item stack and 8K cxstack */
4507 PL_curstackinfo = new_stackinfo(REASONABLE(128),
4508 REASONABLE(8192/sizeof(PERL_CONTEXT) - 1));
4509 PL_curstackinfo->si_type = PERLSI_MAIN;
4510 PL_curstack = PL_curstackinfo->si_stack;
4511 PL_mainstack = PL_curstack; /* remember in case we switch stacks */
4513 PL_stack_base = AvARRAY(PL_curstack);
4514 PL_stack_sp = PL_stack_base;
4515 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
4517 Newx(PL_tmps_stack,REASONABLE(128),SV*);
4520 PL_tmps_max = REASONABLE(128);
4522 Newx(PL_markstack,REASONABLE(32),I32);
4523 PL_markstack_ptr = PL_markstack;
4524 PL_markstack_max = PL_markstack + REASONABLE(32);
4528 Newx(PL_scopestack,REASONABLE(32),I32);
4529 PL_scopestack_ix = 0;
4530 PL_scopestack_max = REASONABLE(32);
4532 Newx(PL_savestack,REASONABLE(128),ANY);
4533 PL_savestack_ix = 0;
4534 PL_savestack_max = REASONABLE(128);
4543 while (PL_curstackinfo->si_next)
4544 PL_curstackinfo = PL_curstackinfo->si_next;
4545 while (PL_curstackinfo) {
4546 PERL_SI *p = PL_curstackinfo->si_prev;
4547 /* curstackinfo->si_stack got nuked by sv_free_arenas() */
4548 Safefree(PL_curstackinfo->si_cxstack);
4549 Safefree(PL_curstackinfo);
4550 PL_curstackinfo = p;
4552 Safefree(PL_tmps_stack);
4553 Safefree(PL_markstack);
4554 Safefree(PL_scopestack);
4555 Safefree(PL_savestack);
4560 S_init_predump_symbols(pTHX)
4566 sv_setpvs(get_sv("\"", TRUE), " ");
4567 PL_ofsgv = (GV*)SvREFCNT_inc(gv_fetchpvs(",", GV_ADD|GV_NOTQUAL, SVt_PV));
4569 PL_stdingv = gv_fetchpvs("STDIN", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4570 GvMULTI_on(PL_stdingv);
4571 io = GvIOp(PL_stdingv);
4572 IoTYPE(io) = IoTYPE_RDONLY;
4573 IoIFP(io) = PerlIO_stdin();
4574 tmpgv = gv_fetchpvs("stdin", GV_ADD|GV_NOTQUAL, SVt_PV);
4576 GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4578 tmpgv = gv_fetchpvs("STDOUT", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4581 IoTYPE(io) = IoTYPE_WRONLY;
4582 IoOFP(io) = IoIFP(io) = PerlIO_stdout();
4584 tmpgv = gv_fetchpvs("stdout", GV_ADD|GV_NOTQUAL, SVt_PV);
4586 GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4588 PL_stderrgv = gv_fetchpvs("STDERR", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4589 GvMULTI_on(PL_stderrgv);
4590 io = GvIOp(PL_stderrgv);
4591 IoTYPE(io) = IoTYPE_WRONLY;
4592 IoOFP(io) = IoIFP(io) = PerlIO_stderr();
4593 tmpgv = gv_fetchpvs("stderr", GV_ADD|GV_NOTQUAL, SVt_PV);
4595 GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4597 PL_statname = newSV(0); /* last filename we did stat on */
4599 Safefree(PL_osname);
4600 PL_osname = savepv(OSNAME);
4604 Perl_init_argv_symbols(pTHX_ register int argc, register char **argv)
4608 PERL_ARGS_ASSERT_INIT_ARGV_SYMBOLS;
4610 argc--,argv++; /* skip name of script */
4611 if (PL_doswitches) {
4612 for (; argc > 0 && **argv == '-'; argc--,argv++) {
4616 if (argv[0][1] == '-' && !argv[0][2]) {
4620 if ((s = strchr(argv[0], '='))) {
4621 const char *const start_name = argv[0] + 1;
4622 sv_setpv(GvSV(gv_fetchpvn_flags(start_name, s - start_name,
4623 TRUE, SVt_PV)), s + 1);
4626 sv_setiv(GvSV(gv_fetchpv(argv[0]+1, GV_ADD, SVt_PV)),1);
4629 if ((PL_argvgv = gv_fetchpvs("ARGV", GV_ADD|GV_NOTQUAL, SVt_PVAV))) {
4630 GvMULTI_on(PL_argvgv);
4631 (void)gv_AVadd(PL_argvgv);
4632 av_clear(GvAVn(PL_argvgv));
4633 for (; argc > 0; argc--,argv++) {
4634 SV * const sv = newSVpv(argv[0],0);
4635 av_push(GvAVn(PL_argvgv),sv);
4636 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
4637 if (PL_unicode & PERL_UNICODE_ARGV_FLAG)
4640 if (PL_unicode & PERL_UNICODE_WIDESYSCALLS_FLAG) /* Sarathy? */
4641 (void)sv_utf8_decode(sv);
4647 S_init_postdump_symbols(pTHX_ register int argc, register char **argv, register char **env)
4652 PERL_ARGS_ASSERT_INIT_POSTDUMP_SYMBOLS;
4654 PL_toptarget = newSV_type(SVt_PVFM);
4655 sv_setpvs(PL_toptarget, "");
4656 PL_bodytarget = newSV_type(SVt_PVFM);
4657 sv_setpvs(PL_bodytarget, "");
4658 PL_formtarget = PL_bodytarget;
4662 init_argv_symbols(argc,argv);
4664 if ((tmpgv = gv_fetchpvs("0", GV_ADD|GV_NOTQUAL, SVt_PV))) {
4665 #ifdef MACOS_TRADITIONAL
4666 /* $0 is not majick on a Mac */
4667 sv_setpv(GvSV(tmpgv),MacPerl_MPWFileName(PL_origfilename));
4669 sv_setpv(GvSV(tmpgv),PL_origfilename);
4671 GV * const gv = gv_fetchpv("0", GV_ADD, SVt_PV);
4673 sv_magic(GvSV(gv), MUTABLE_SV(gv), PERL_MAGIC_sv, "0", 1);
4677 if ((PL_envgv = gv_fetchpvs("ENV", GV_ADD|GV_NOTQUAL, SVt_PVHV))) {
4679 bool env_is_not_environ;
4680 GvMULTI_on(PL_envgv);
4681 hv = GvHVn(PL_envgv);
4682 hv_magic(hv, NULL, PERL_MAGIC_env);
4684 #ifdef USE_ENVIRON_ARRAY
4685 /* Note that if the supplied env parameter is actually a copy
4686 of the global environ then it may now point to free'd memory
4687 if the environment has been modified since. To avoid this
4688 problem we treat env==NULL as meaning 'use the default'
4692 env_is_not_environ = env != environ;
4693 if (env_is_not_environ
4694 # ifdef USE_ITHREADS
4695 && PL_curinterp == aTHX
4704 for (; *env; env++) {
4707 if (!(s = strchr(old_var,'=')) || s == old_var)
4710 #if defined(MSDOS) && !defined(DJGPP)
4712 (void)strupr(old_var);
4715 sv = newSVpv(s+1, 0);
4716 (void)hv_store(hv, old_var, s - old_var, sv, 0);
4717 if (env_is_not_environ)
4721 #endif /* USE_ENVIRON_ARRAY */
4722 #endif /* !PERL_MICRO */
4725 if ((tmpgv = gv_fetchpvs("$", GV_ADD|GV_NOTQUAL, SVt_PV))) {
4726 SvREADONLY_off(GvSV(tmpgv));
4727 sv_setiv(GvSV(tmpgv), (IV)PerlProc_getpid());
4728 SvREADONLY_on(GvSV(tmpgv));
4730 #ifdef THREADS_HAVE_PIDS
4731 PL_ppid = (IV)getppid();
4734 /* touch @F array to prevent spurious warnings 20020415 MJD */
4736 (void) get_av("main::F", GV_ADD | GV_ADDMULTI);
4741 S_init_perllib(pTHX)
4747 s = PerlEnv_getenv("PERL5LIB");
4749 * It isn't possible to delete an environment variable with
4750 * PERL_USE_SAFE_PUTENV set unless unsetenv() is also available, so in that
4751 * case we treat PERL5LIB as undefined if it has a zero-length value.
4753 #if defined(PERL_USE_SAFE_PUTENV) && ! defined(HAS_UNSETENV)
4754 if (s && *s != '\0')
4758 incpush(s, TRUE, TRUE, TRUE, FALSE, FALSE);
4760 incpush(PerlEnv_getenv("PERLLIB"), FALSE, FALSE, TRUE, FALSE, FALSE);
4762 /* Treat PERL5?LIB as a possible search list logical name -- the
4763 * "natural" VMS idiom for a Unix path string. We allow each
4764 * element to be a set of |-separated directories for compatibility.
4768 if (my_trnlnm("PERL5LIB",buf,0))
4769 do { incpush(buf,TRUE,TRUE,TRUE,FALSE, FALSE); } while (my_trnlnm("PERL5LIB",buf,++idx));
4771 while (my_trnlnm("PERLLIB",buf,idx++)) incpush(buf,FALSE,FALSE,TRUE,FALSE, FALSE);
4775 /* Use the ~-expanded versions of APPLLIB (undocumented),
4776 ARCHLIB PRIVLIB SITEARCH SITELIB VENDORARCH and VENDORLIB
4779 incpush(APPLLIB_EXP, TRUE, TRUE, TRUE, TRUE, FALSE);
4783 incpush(ARCHLIB_EXP, FALSE, FALSE, TRUE, TRUE, FALSE);
4785 #ifdef MACOS_TRADITIONAL
4788 SV * privdir = newSV(0);
4789 char * macperl = PerlEnv_getenv("MACPERL");
4794 Perl_sv_setpvf(aTHX_ privdir, "%slib:", macperl);
4795 if (PerlLIO_stat(SvPVX(privdir), &tmpstatbuf) >= 0 && S_ISDIR(tmpstatbuf.st_mode))
4796 incpush(SvPVX(privdir), TRUE, FALSE, TRUE, FALSE, FALSE);
4797 Perl_sv_setpvf(aTHX_ privdir, "%ssite_perl:", macperl);
4798 if (PerlLIO_stat(SvPVX(privdir), &tmpstatbuf) >= 0 && S_ISDIR(tmpstatbuf.st_mode))
4799 incpush(SvPVX(privdir), TRUE, FALSE, TRUE, FALSE, FALSE);
4801 SvREFCNT_dec(privdir);
4804 incpush(":", FALSE, FALSE, FALSE, FALSE, FALSE);
4807 # define PRIVLIB_EXP "/usr/local/lib/perl5:/usr/local/lib/perl"
4810 incpush(PRIVLIB_EXP, TRUE, FALSE, TRUE, TRUE, FALSE);
4812 incpush(PRIVLIB_EXP, FALSE, FALSE, TRUE, TRUE, FALSE);
4816 /* sitearch is always relative to sitelib on Windows for
4817 * DLL-based path intuition to work correctly */
4818 # if !defined(WIN32)
4819 incpush(SITEARCH_EXP, FALSE, FALSE, TRUE, TRUE, FALSE);
4825 /* this picks up sitearch as well */
4826 incpush(SITELIB_EXP, TRUE, FALSE, TRUE, TRUE, FALSE);
4828 incpush(SITELIB_EXP, FALSE, FALSE, TRUE, TRUE, FALSE);
4832 #if defined(SITELIB_STEM) && defined(PERL_INC_VERSION_LIST)
4833 /* Search for version-specific dirs below here */
4834 incpush(SITELIB_STEM, FALSE, TRUE, TRUE, TRUE, FALSE);
4837 #ifdef PERL_VENDORARCH_EXP
4838 /* vendorarch is always relative to vendorlib on Windows for
4839 * DLL-based path intuition to work correctly */
4840 # if !defined(WIN32)
4841 incpush(PERL_VENDORARCH_EXP, FALSE, FALSE, TRUE, TRUE, FALSE);
4845 #ifdef PERL_VENDORLIB_EXP
4847 incpush(PERL_VENDORLIB_EXP, TRUE, FALSE, TRUE, TRUE, FALSE); /* this picks up vendorarch as well */
4849 incpush(PERL_VENDORLIB_EXP, FALSE, FALSE, TRUE, TRUE, FALSE);
4853 #if defined(PERL_VENDORLIB_STEM) && defined(PERL_INC_VERSION_LIST)
4854 /* Search for version-specific dirs below here */
4855 incpush(PERL_VENDORLIB_STEM, FALSE, TRUE, TRUE, TRUE, FALSE);
4858 #ifdef PERL_OTHERLIBDIRS
4859 incpush(PERL_OTHERLIBDIRS, TRUE, TRUE, TRUE, TRUE, FALSE);
4863 incpush(".", FALSE, FALSE, FALSE, FALSE, FALSE);
4864 #endif /* MACOS_TRADITIONAL */
4867 #if defined(DOSISH) || defined(EPOC) || defined(__SYMBIAN32__)
4868 # define PERLLIB_SEP ';'
4871 # define PERLLIB_SEP '|'
4873 # if defined(MACOS_TRADITIONAL)
4874 # define PERLLIB_SEP ','
4876 # define PERLLIB_SEP ':'
4880 #ifndef PERLLIB_MANGLE
4881 # define PERLLIB_MANGLE(s,n) (s)
4884 /* Push a directory onto @INC if it exists.
4885 Generate a new SV if we do this, to save needing to copy the SV we push
4888 S_incpush_if_exists(pTHX_ SV *dir)
4893 PERL_ARGS_ASSERT_INCPUSH_IF_EXISTS;
4895 if (PerlLIO_stat(SvPVX_const(dir), &tmpstatbuf) >= 0 &&
4896 S_ISDIR(tmpstatbuf.st_mode)) {
4897 av_push(GvAVn(PL_incgv), dir);
4904 S_incpush(pTHX_ const char *dir, bool addsubdirs, bool addoldvers, bool usesep,
4905 bool canrelocate, bool unshift)
4909 const char *p = dir;
4914 if (addsubdirs || addoldvers) {
4918 /* Break at all separators */
4920 SV *libdir = newSV(0);
4923 /* skip any consecutive separators */
4925 while ( *p == PERLLIB_SEP ) {
4926 /* Uncomment the next line for PATH semantics */
4927 /* av_push(GvAVn(PL_incgv), newSVpvs(".")); */
4932 if ( usesep && (s = strchr(p, PERLLIB_SEP)) != NULL ) {
4933 sv_setpvn(libdir, PERLLIB_MANGLE(p, (STRLEN)(s - p)),
4938 sv_setpv(libdir, PERLLIB_MANGLE(p, 0));
4939 p = NULL; /* break out */
4941 #ifdef MACOS_TRADITIONAL
4942 if (!strchr(SvPVX(libdir), ':')) {
4945 sv_setpv(libdir, MacPerl_CanonDir(SvPVX(libdir), buf, 0));
4947 if (SvPVX(libdir)[SvCUR(libdir)-1] != ':')
4948 sv_catpvs(libdir, ":");
4951 /* Do the if() outside the #ifdef to avoid warnings about an unused
4954 #ifdef PERL_RELOCATABLE_INC
4956 * Relocatable include entries are marked with a leading .../
4959 * 0: Remove that leading ".../"
4960 * 1: Remove trailing executable name (anything after the last '/')
4961 * from the perl path to give a perl prefix
4963 * While the @INC element starts "../" and the prefix ends with a real
4964 * directory (ie not . or ..) chop that real directory off the prefix
4965 * and the leading "../" from the @INC element. ie a logical "../"
4967 * Finally concatenate the prefix and the remainder of the @INC element
4968 * The intent is that /usr/local/bin/perl and .../../lib/perl5
4969 * generates /usr/local/lib/perl5
4971 const char *libpath = SvPVX(libdir);
4972 STRLEN libpath_len = SvCUR(libdir);
4973 if (libpath_len >= 4 && memEQ (libpath, ".../", 4)) {
4975 SV * const caret_X = get_sv("\030", 0);
4976 /* Going to use the SV just as a scratch buffer holding a C
4982 /* $^X is *the* source of taint if tainting is on, hence
4983 SvPOK() won't be true. */
4985 assert(SvPOKp(caret_X));
4986 prefix_sv = newSVpvn_flags(SvPVX(caret_X), SvCUR(caret_X),
4988 /* Firstly take off the leading .../
4989 If all else fail we'll do the paths relative to the current
4991 sv_chop(libdir, libpath + 4);
4992 /* Don't use SvPV as we're intentionally bypassing taining,
4993 mortal copies that the mg_get of tainting creates, and
4994 corruption that seems to come via the save stack.
4995 I guess that the save stack isn't correctly set up yet. */
4996 libpath = SvPVX(libdir);
4997 libpath_len = SvCUR(libdir);
4999 /* This would work more efficiently with memrchr, but as it's
5000 only a GNU extension we'd need to probe for it and
5001 implement our own. Not hard, but maybe not worth it? */
5003 prefix = SvPVX(prefix_sv);
5004 lastslash = strrchr(prefix, '/');
5006 /* First time in with the *lastslash = '\0' we just wipe off
5007 the trailing /perl from (say) /usr/foo/bin/perl
5011 while ((*lastslash = '\0'), /* Do that, come what may. */
5012 (libpath_len >= 3 && memEQ(libpath, "../", 3)
5013 && (lastslash = strrchr(prefix, '/')))) {
5014 if (lastslash[1] == '\0'
5015 || (lastslash[1] == '.'
5016 && (lastslash[2] == '/' /* ends "/." */
5017 || (lastslash[2] == '/'
5018 && lastslash[3] == '/' /* or "/.." */
5020 /* Prefix ends "/" or "/." or "/..", any of which
5021 are fishy, so don't do any more logical cleanup.
5025 /* Remove leading "../" from path */
5028 /* Next iteration round the loop removes the last
5029 directory name from prefix by writing a '\0' in
5030 the while clause. */
5032 /* prefix has been terminated with a '\0' to the correct
5033 length. libpath points somewhere into the libdir SV.
5034 We need to join the 2 with '/' and drop the result into
5036 tempsv = Perl_newSVpvf(aTHX_ "%s/%s", prefix, libpath);
5037 SvREFCNT_dec(libdir);
5038 /* And this is the new libdir. */
5041 (PL_uid != PL_euid || PL_gid != PL_egid)) {
5042 /* Need to taint reloccated paths if running set ID */
5043 SvTAINTED_on(libdir);
5046 SvREFCNT_dec(prefix_sv);
5051 * BEFORE pushing libdir onto @INC we may first push version- and
5052 * archname-specific sub-directories.
5054 if (addsubdirs || addoldvers) {
5055 #ifdef PERL_INC_VERSION_LIST
5056 /* Configure terminates PERL_INC_VERSION_LIST with a NULL */
5057 const char * const incverlist[] = { PERL_INC_VERSION_LIST };
5058 const char * const *incver;
5064 if ((unix = tounixspec_ts(SvPV(libdir,len),NULL)) != NULL) {
5066 while (unix[len-1] == '/') len--; /* Cosmetic */
5067 sv_usepvn(libdir,unix,len);
5070 PerlIO_printf(Perl_error_log,
5071 "Failed to unixify @INC element \"%s\"\n",
5075 #ifdef MACOS_TRADITIONAL
5076 #define PERL_AV_SUFFIX_FMT ""
5077 #define PERL_ARCH_FMT "%s:"
5078 #define PERL_ARCH_FMT_PATH PERL_FS_VER_FMT PERL_AV_SUFFIX_FMT
5080 #define PERL_AV_SUFFIX_FMT "/"
5081 #define PERL_ARCH_FMT "/%s"
5082 #define PERL_ARCH_FMT_PATH PERL_AV_SUFFIX_FMT PERL_FS_VER_FMT
5084 /* .../version/archname if -d .../version/archname */
5085 Perl_sv_setpvf(aTHX_ subdir, "%"SVf PERL_ARCH_FMT_PATH PERL_ARCH_FMT,
5087 (int)PERL_REVISION, (int)PERL_VERSION,
5088 (int)PERL_SUBVERSION, ARCHNAME);
5089 subdir = S_incpush_if_exists(aTHX_ subdir);
5091 /* .../version if -d .../version */
5092 Perl_sv_setpvf(aTHX_ subdir, "%"SVf PERL_ARCH_FMT_PATH,
5094 (int)PERL_REVISION, (int)PERL_VERSION,
5095 (int)PERL_SUBVERSION);
5096 subdir = S_incpush_if_exists(aTHX_ subdir);
5098 /* .../archname if -d .../archname */
5099 Perl_sv_setpvf(aTHX_ subdir, "%"SVf PERL_ARCH_FMT,
5100 SVfARG(libdir), ARCHNAME);
5101 subdir = S_incpush_if_exists(aTHX_ subdir);
5105 #ifdef PERL_INC_VERSION_LIST
5107 for (incver = incverlist; *incver; incver++) {
5108 /* .../xxx if -d .../xxx */
5109 Perl_sv_setpvf(aTHX_ subdir, "%"SVf PERL_ARCH_FMT,
5110 SVfARG(libdir), *incver);
5111 subdir = S_incpush_if_exists(aTHX_ subdir);
5117 /* finally add this lib directory at the end of @INC */
5119 av_unshift( GvAVn( PL_incgv ), 1 );
5120 av_store( GvAVn( PL_incgv ), 0, libdir );
5123 av_push(GvAVn(PL_incgv), libdir);
5127 assert (SvREFCNT(subdir) == 1);
5128 SvREFCNT_dec(subdir);
5134 Perl_call_list(pTHX_ I32 oldscope, AV *paramList)
5138 volatile const line_t oldline = PL_curcop ? CopLINE(PL_curcop) : 0;
5144 PERL_ARGS_ASSERT_CALL_LIST;
5146 while (av_len(paramList) >= 0) {
5147 cv = MUTABLE_CV(av_shift(paramList));
5149 if (paramList == PL_beginav) {
5150 /* save PL_beginav for compiler */
5151 Perl_av_create_and_push(aTHX_ &PL_beginav_save, MUTABLE_SV(cv));
5153 else if (paramList == PL_checkav) {
5154 /* save PL_checkav for compiler */
5155 Perl_av_create_and_push(aTHX_ &PL_checkav_save, MUTABLE_SV(cv));
5157 else if (paramList == PL_unitcheckav) {
5158 /* save PL_unitcheckav for compiler */
5159 Perl_av_create_and_push(aTHX_ &PL_unitcheckav_save, MUTABLE_SV(cv));
5170 PL_madskills |= 16384;
5175 PL_madskills &= ~16384;
5178 (void)SvPV_const(atsv, len);
5180 PL_curcop = &PL_compiling;
5181 CopLINE_set(PL_curcop, oldline);
5182 if (paramList == PL_beginav)
5183 sv_catpvs(atsv, "BEGIN failed--compilation aborted");
5185 Perl_sv_catpvf(aTHX_ atsv,
5186 "%s failed--call queue aborted",
5187 paramList == PL_checkav ? "CHECK"
5188 : paramList == PL_initav ? "INIT"
5189 : paramList == PL_unitcheckav ? "UNITCHECK"
5191 while (PL_scopestack_ix > oldscope)
5194 Perl_croak(aTHX_ "%"SVf"", SVfARG(atsv));
5201 /* my_exit() was called */
5202 while (PL_scopestack_ix > oldscope)
5205 PL_curstash = PL_defstash;
5206 PL_curcop = &PL_compiling;
5207 CopLINE_set(PL_curcop, oldline);
5209 if (PL_statusvalue && !(PL_exit_flags & PERL_EXIT_EXPECTED)) {
5210 if (paramList == PL_beginav)
5211 Perl_croak(aTHX_ "BEGIN failed--compilation aborted");
5213 Perl_croak(aTHX_ "%s failed--call queue aborted",
5214 paramList == PL_checkav ? "CHECK"
5215 : paramList == PL_initav ? "INIT"
5216 : paramList == PL_unitcheckav ? "UNITCHECK"
5223 PL_curcop = &PL_compiling;
5224 CopLINE_set(PL_curcop, oldline);
5227 PerlIO_printf(Perl_error_log, "panic: restartop\n");
5236 Perl_my_exit(pTHX_ U32 status)
5247 STATUS_EXIT_SET(status);
5254 Perl_my_failure_exit(pTHX)
5258 /* We have been called to fall on our sword. The desired exit code
5259 * should be already set in STATUS_UNIX, but could be shifted over
5260 * by 8 bits. STATUS_UNIX_EXIT_SET will handle the cases where a
5263 * If an error code has not been set, then force the issue.
5265 if (MY_POSIX_EXIT) {
5267 /* According to the die_exit.t tests, if errno is non-zero */
5268 /* It should be used for the error status. */
5270 if (errno == EVMSERR) {
5271 STATUS_NATIVE = vaxc$errno;
5274 /* According to die_exit.t tests, if the child_exit code is */
5275 /* also zero, then we need to exit with a code of 255 */
5276 if ((errno != 0) && (errno < 256))
5277 STATUS_UNIX_EXIT_SET(errno);
5278 else if (STATUS_UNIX < 255) {
5279 STATUS_UNIX_EXIT_SET(255);
5284 /* The exit code could have been set by $? or vmsish which
5285 * means that it may not have fatal set. So convert
5286 * success/warning codes to fatal with out changing
5287 * the POSIX status code. The severity makes VMS native
5288 * status handling work, while UNIX mode programs use the
5289 * the POSIX exit codes.
5291 if ((STATUS_NATIVE & (STS$K_SEVERE|STS$K_ERROR)) == 0) {
5292 STATUS_NATIVE &= STS$M_COND_ID;
5293 STATUS_NATIVE |= STS$K_ERROR | STS$M_INHIB_MSG;
5297 /* Traditionally Perl on VMS always expects a Fatal Error. */
5298 if (vaxc$errno & 1) {
5300 /* So force success status to failure */
5301 if (STATUS_NATIVE & 1)
5306 STATUS_UNIX = EINTR; /* In case something cares */
5311 STATUS_NATIVE = vaxc$errno; /* Should already be this */
5313 /* Encode the severity code */
5314 severity = STATUS_NATIVE & STS$M_SEVERITY;
5315 STATUS_UNIX = (severity ? severity : 1) << 8;
5317 /* Perl expects this to be a fatal error */
5318 if (severity != STS$K_SEVERE)
5327 STATUS_UNIX_SET(errno);
5329 exitstatus = STATUS_UNIX >> 8;
5330 if (exitstatus & 255)
5331 STATUS_UNIX_SET(exitstatus);
5333 STATUS_UNIX_SET(255);
5340 S_my_exit_jump(pTHX)
5345 SvREFCNT_dec(PL_e_script);
5349 POPSTACK_TO(PL_mainstack);
5357 read_e_script(pTHX_ int idx, SV *buf_sv, int maxlen)
5360 const char * const p = SvPVX_const(PL_e_script);
5361 const char *nl = strchr(p, '\n');
5363 PERL_UNUSED_ARG(idx);
5364 PERL_UNUSED_ARG(maxlen);
5366 nl = (nl) ? nl+1 : SvEND(PL_e_script);
5368 filter_del(read_e_script);
5371 sv_catpvn(buf_sv, p, nl-p);
5372 sv_chop(PL_e_script, nl);
5378 * c-indentation-style: bsd
5380 * indent-tabs-mode: t
5383 * ex: set ts=8 sts=4 sw=4 noet: