4 * Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001
5 * 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
6 * 2013, 2014, 2015, 2016, 2017, 2018 by Larry Wall and others
8 * You may distribute under the terms of either the GNU General Public
9 * License or the Artistic License, as specified in the README file.
14 * A ship then new they built for him
15 * of mithril and of elven-glass
16 * --from Bilbo's song of EƤrendil
18 * [p.236 of _The Lord of the Rings_, II/i: "Many Meetings"]
21 /* This file contains the top-level functions that are used to create, use
22 * and destroy a perl interpreter, plus the functions used by XS code to
23 * call back into perl. Note that it does not contain the actual main()
24 * function of the interpreter; that can be found in perlmain.c
26 * Note that at build time this file is also linked to as perlmini.c,
27 * and perlmini.o is then built with PERL_IS_MINIPERL defined, which is
28 * then used to create the miniperl executable, rather than perl.o.
31 #if defined(PERL_IS_MINIPERL) && !defined(USE_SITECUSTOMIZE)
32 # define USE_SITECUSTOMIZE
36 #define PERL_IN_PERL_C
38 #include "patchlevel.h" /* for local_patches */
45 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
52 char control[CMSG_SPACE(sizeof(int))];
65 static I32 read_e_script(pTHX_ int idx, SV *buf_sv, int maxlen);
67 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
68 # define validate_suid(rsfp) NOOP
70 # define validate_suid(rsfp) S_validate_suid(aTHX_ rsfp)
73 #define CALL_BODY_SUB(myop) \
74 if (PL_op == (myop)) \
75 PL_op = PL_ppaddr[OP_ENTERSUB](aTHX); \
79 #define CALL_LIST_BODY(cv) \
80 PUSHMARK(PL_stack_sp); \
81 call_sv(MUTABLE_SV((cv)), G_EVAL|G_DISCARD|G_VOID);
84 S_init_tls_and_interp(PerlInterpreter *my_perl)
88 PERL_SET_INTERP(my_perl);
89 #if defined(USE_ITHREADS)
92 PERL_SET_THX(my_perl);
95 KEYWORD_PLUGIN_MUTEX_INIT;
98 MUTEX_INIT(&PL_dollarzero_mutex);
99 MUTEX_INIT(&PL_my_ctx_mutex);
102 #if defined(USE_ITHREADS)
105 /* This always happens for non-ithreads */
108 PERL_SET_THX(my_perl);
113 /* these implement the PERL_SYS_INIT, PERL_SYS_INIT3, PERL_SYS_TERM macros */
116 Perl_sys_init(int* argc, char*** argv)
120 PERL_ARGS_ASSERT_SYS_INIT;
122 PERL_UNUSED_ARG(argc); /* may not be used depending on _BODY macro */
123 PERL_UNUSED_ARG(argv);
124 PERL_SYS_INIT_BODY(argc, argv);
128 Perl_sys_init3(int* argc, char*** argv, char*** env)
132 PERL_ARGS_ASSERT_SYS_INIT3;
134 PERL_UNUSED_ARG(argc); /* may not be used depending on _BODY macro */
135 PERL_UNUSED_ARG(argv);
136 PERL_UNUSED_ARG(env);
137 PERL_SYS_INIT3_BODY(argc, argv, env);
144 if (!PL_veto_cleanup) {
145 PERL_SYS_TERM_BODY();
150 #ifdef PERL_IMPLICIT_SYS
152 perl_alloc_using(struct IPerlMem* ipM, struct IPerlMem* ipMS,
153 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
154 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
155 struct IPerlDir* ipD, struct IPerlSock* ipS,
156 struct IPerlProc* ipP)
158 PerlInterpreter *my_perl;
160 PERL_ARGS_ASSERT_PERL_ALLOC_USING;
162 /* Newx() needs interpreter, so call malloc() instead */
163 my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
164 S_init_tls_and_interp(my_perl);
165 Zero(my_perl, 1, PerlInterpreter);
175 INIT_TRACK_MEMPOOL(PL_memory_debug_header, my_perl);
182 =head1 Embedding Functions
184 =for apidoc perl_alloc
186 Allocates a new Perl interpreter. See L<perlembed>.
194 PerlInterpreter *my_perl;
196 /* Newx() needs interpreter, so call malloc() instead */
197 my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
199 S_init_tls_and_interp(my_perl);
200 #ifndef PERL_TRACK_MEMPOOL
201 return (PerlInterpreter *) ZeroD(my_perl, 1, PerlInterpreter);
203 Zero(my_perl, 1, PerlInterpreter);
204 INIT_TRACK_MEMPOOL(PL_memory_debug_header, my_perl);
208 #endif /* PERL_IMPLICIT_SYS */
211 =for apidoc perl_construct
213 Initializes a new Perl interpreter. See L<perlembed>.
219 S_fixup_platform_bugs(void)
221 #if defined(__GLIBC__) && IVSIZE == 8 \
222 && ( __GLIBC__ < 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ < 8))
226 /* Cannot do this check with inlined IV constants since
227 * that seems to work correctly even with the buggy glibc. */
230 /* Yikes, we have the bug.
231 * Patch in the workaround version. */
232 PL_ppaddr[OP_I_MODULO] = &Perl_pp_i_modulo_glibc_bugfix;
239 perl_construct(pTHXx)
243 PERL_ARGS_ASSERT_PERL_CONSTRUCT;
247 PL_perl_destruct_level = 1;
249 PERL_UNUSED_ARG(my_perl);
250 if (PL_perl_destruct_level > 0)
253 PL_curcop = &PL_compiling; /* needed by ckWARN, right away */
255 #ifdef PERL_TRACE_OPS
256 Zero(PL_op_exec_cnt, OP_max+2, UV);
261 SvREADONLY_on(&PL_sv_placeholder);
262 SvREFCNT(&PL_sv_placeholder) = SvREFCNT_IMMORTAL;
264 PL_sighandlerp = (Sighandler_t) Perl_sighandler;
265 #ifdef PERL_USES_PL_PIDSTATUS
266 PL_pidstatus = newHV();
269 PL_rs = newSVpvs("\n");
273 /* The PERL_INTERNAL_RAND_SEED set-up must be after init_stacks because it calls
274 * things that may put SVs on the stack.
277 #ifdef NO_PERL_INTERNAL_RAND_SEED
278 Perl_drand48_init_r(&PL_internal_random_state, seed());
283 if (PerlProc_getuid() != PerlProc_geteuid() ||
284 PerlProc_getgid() != PerlProc_getegid() ||
285 !(env_pv = PerlEnv_getenv("PERL_INTERNAL_RAND_SEED")) ||
286 grok_number(env_pv, strlen(env_pv), &seed) != IS_NUMBER_IN_UV) {
289 Perl_drand48_init_r(&PL_internal_random_state, (U32)seed);
295 S_fixup_platform_bugs();
300 PL_XPosix_ptrs[_CC_ASCII] = _new_invlist_C_array(ASCII_invlist);
301 PL_XPosix_ptrs[_CC_ALPHANUMERIC] = _new_invlist_C_array(XPosixAlnum_invlist);
302 PL_XPosix_ptrs[_CC_ALPHA] = _new_invlist_C_array(XPosixAlpha_invlist);
303 PL_XPosix_ptrs[_CC_BLANK] = _new_invlist_C_array(XPosixBlank_invlist);
304 PL_XPosix_ptrs[_CC_CASED] = _new_invlist_C_array(Cased_invlist);
305 PL_XPosix_ptrs[_CC_CNTRL] = _new_invlist_C_array(XPosixCntrl_invlist);
306 PL_XPosix_ptrs[_CC_DIGIT] = _new_invlist_C_array(XPosixDigit_invlist);
307 PL_XPosix_ptrs[_CC_GRAPH] = _new_invlist_C_array(XPosixGraph_invlist);
308 PL_XPosix_ptrs[_CC_LOWER] = _new_invlist_C_array(XPosixLower_invlist);
309 PL_XPosix_ptrs[_CC_PRINT] = _new_invlist_C_array(XPosixPrint_invlist);
310 PL_XPosix_ptrs[_CC_PUNCT] = _new_invlist_C_array(XPosixPunct_invlist);
311 PL_XPosix_ptrs[_CC_SPACE] = _new_invlist_C_array(XPerlSpace_invlist);
312 PL_XPosix_ptrs[_CC_UPPER] = _new_invlist_C_array(XPosixUpper_invlist);
313 PL_XPosix_ptrs[_CC_VERTSPACE] = _new_invlist_C_array(VertSpace_invlist);
314 PL_XPosix_ptrs[_CC_WORDCHAR] = _new_invlist_C_array(XPosixWord_invlist);
315 PL_XPosix_ptrs[_CC_XDIGIT] = _new_invlist_C_array(XPosixXDigit_invlist);
316 PL_GCB_invlist = _new_invlist_C_array(_Perl_GCB_invlist);
317 PL_SB_invlist = _new_invlist_C_array(_Perl_SB_invlist);
318 PL_WB_invlist = _new_invlist_C_array(_Perl_WB_invlist);
319 PL_LB_invlist = _new_invlist_C_array(_Perl_LB_invlist);
320 PL_Assigned_invlist = _new_invlist_C_array(Assigned_invlist);
321 PL_SCX_invlist = _new_invlist_C_array(_Perl_SCX_invlist);
324 #if defined(LOCAL_PATCH_COUNT)
325 PL_localpatches = local_patches; /* For possible -v */
328 #if defined(LIBM_LIB_VERSION)
330 * Some BSDs and Cygwin default to POSIX math instead of IEEE.
331 * This switches them over to IEEE.
333 _LIB_VERSION = _IEEE_;
336 #ifdef HAVE_INTERP_INTERN
340 PerlIO_init(aTHX); /* Hook to IO system */
342 PL_fdpid = newAV(); /* for remembering popen pids by fd */
343 PL_modglobal = newHV(); /* pointers to per-interpreter module globals */
344 PL_errors = newSVpvs("");
345 SvPVCLEAR(PERL_DEBUG_PAD(0)); /* For regex debugging. */
346 SvPVCLEAR(PERL_DEBUG_PAD(1)); /* ext/re needs these */
347 SvPVCLEAR(PERL_DEBUG_PAD(2)); /* even without DEBUGGING. */
349 /* First entry is a list of empty elements. It needs to be initialised
350 else all hell breaks loose in S_find_uninit_var(). */
351 Perl_av_create_and_push(aTHX_ &PL_regex_padav, newSVpvs(""));
352 PL_regex_pad = AvARRAY(PL_regex_padav);
353 Newxz(PL_stashpad, PL_stashpadmax, HV *);
355 #ifdef USE_REENTRANT_API
356 Perl_reentrant_init(aTHX);
358 if (PL_hash_seed_set == FALSE) {
359 /* Initialize the hash seed and state at startup. This must be
360 * done very early, before ANY hashes are constructed, and once
361 * setup is fixed for the lifetime of the process.
363 * If you decide to disable the seeding process you should choose
364 * a suitable seed yourself and define PERL_HASH_SEED to a well chosen
365 * string. See hv_func.h for details.
367 #if defined(USE_HASH_SEED)
368 /* get the hash seed from the environment or from an RNG */
369 Perl_get_hash_seed(aTHX_ PL_hash_seed);
371 /* they want a hard coded seed, check that it is long enough */
372 assert( strlen(PERL_HASH_SEED) >= PERL_HASH_SEED_BYTES );
375 /* now we use the chosen seed to initialize the state -
376 * in some configurations this may be a relatively speaking
377 * expensive operation, but we only have to do it once at startup */
378 PERL_HASH_SEED_STATE(PERL_HASH_SEED,PL_hash_state);
380 #ifdef PERL_USE_SINGLE_CHAR_HASH_CACHE
381 /* we can build a special cache for 0/1 byte keys, if people choose
382 * I suspect most of the time it is not worth it */
386 for (i=0;i<256;i++) {
388 PERL_HASH_WITH_STATE(PL_hash_state,PL_hash_chars[i],str,1);
390 PERL_HASH_WITH_STATE(PL_hash_state,PL_hash_chars[256],str,0);
393 /* at this point we have initialezed the hash function, and we can start
394 * constructing hashes */
395 PL_hash_seed_set= TRUE;
398 /* Allow PL_strtab to be pre-initialized before calling perl_construct.
399 * can use a custom optimized PL_strtab hash before calling perl_construct */
401 /* Note that strtab is a rather special HV. Assumptions are made
402 about not iterating on it, and not adding tie magic to it.
403 It is properly deallocated in perl_destruct() */
406 /* SHAREKEYS tells us that the hash has its keys shared with PL_strtab,
407 * which is not the case with PL_strtab itself */
408 HvSHAREKEYS_off(PL_strtab); /* mandatory */
409 hv_ksplit(PL_strtab, 1 << 11);
412 Zero(PL_sv_consts, SV_CONSTS_COUNT, SV*);
415 # ifdef USE_ENVIRON_ARRAY
416 PL_origenviron = environ;
420 /* Use sysconf(_SC_CLK_TCK) if available, if not
421 * available or if the sysconf() fails, use the HZ.
422 * The HZ if not originally defined has been by now
423 * been defined as CLK_TCK, if available. */
424 #if defined(HAS_SYSCONF) && defined(_SC_CLK_TCK)
425 PL_clocktick = sysconf(_SC_CLK_TCK);
426 if (PL_clocktick <= 0)
430 PL_stashcache = newHV();
432 PL_patchlevel = newSVpvs("v" PERL_VERSION_STRING);
435 if (!PL_mmap_page_size) {
436 #if defined(HAS_SYSCONF) && (defined(_SC_PAGESIZE) || defined(_SC_MMAP_PAGE_SIZE))
438 SETERRNO(0, SS_NORMAL);
440 PL_mmap_page_size = sysconf(_SC_PAGESIZE);
442 PL_mmap_page_size = sysconf(_SC_MMAP_PAGE_SIZE);
444 if ((long) PL_mmap_page_size < 0) {
445 Perl_croak(aTHX_ "panic: sysconf: %s",
446 errno ? Strerror(errno) : "pagesize unknown");
449 #elif defined(HAS_GETPAGESIZE)
450 PL_mmap_page_size = getpagesize();
451 #elif defined(I_SYS_PARAM) && defined(PAGESIZE)
452 PL_mmap_page_size = PAGESIZE; /* compiletime, bad */
454 if (PL_mmap_page_size <= 0)
455 Perl_croak(aTHX_ "panic: bad pagesize %" IVdf,
456 (IV) PL_mmap_page_size);
458 #endif /* HAS_MMAP */
460 #if defined(HAS_TIMES) && defined(PERL_NEED_TIMESBASE)
461 PL_timesbase.tms_utime = 0;
462 PL_timesbase.tms_stime = 0;
463 PL_timesbase.tms_cutime = 0;
464 PL_timesbase.tms_cstime = 0;
467 PL_osname = Perl_savepvn(aTHX_ STR_WITH_LEN(OSNAME));
469 PL_registered_mros = newHV();
470 /* Start with 1 bucket, for DFS. It's unlikely we'll need more. */
471 HvMAX(PL_registered_mros) = 0;
473 #ifdef USE_POSIX_2008_LOCALE
474 PL_C_locale_obj = newlocale(LC_ALL_MASK, "C", NULL);
482 =for apidoc nothreadhook
484 Stub that provides thread hook for perl_destruct when there are
491 Perl_nothreadhook(pTHX)
497 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
499 Perl_dump_sv_child(pTHX_ SV *sv)
502 const int sock = PL_dumper_fd;
503 const int debug_fd = PerlIO_fileno(Perl_debug_log);
504 union control_un control;
507 struct cmsghdr *cmptr;
509 unsigned char buffer[256];
511 PERL_ARGS_ASSERT_DUMP_SV_CHILD;
513 if(sock == -1 || debug_fd == -1)
516 PerlIO_flush(Perl_debug_log);
518 /* All these shenanigans are to pass a file descriptor over to our child for
519 it to dump out to. We can't let it hold open the file descriptor when it
520 forks, as the file descriptor it will dump to can turn out to be one end
521 of pipe that some other process will wait on for EOF. (So as it would
522 be open, the wait would be forever.) */
524 msg.msg_control = control.control;
525 msg.msg_controllen = sizeof(control.control);
526 /* We're a connected socket so we don't need a destination */
532 cmptr = CMSG_FIRSTHDR(&msg);
533 cmptr->cmsg_len = CMSG_LEN(sizeof(int));
534 cmptr->cmsg_level = SOL_SOCKET;
535 cmptr->cmsg_type = SCM_RIGHTS;
536 *((int *)CMSG_DATA(cmptr)) = 1;
538 vec[0].iov_base = (void*)&sv;
539 vec[0].iov_len = sizeof(sv);
540 got = sendmsg(sock, &msg, 0);
543 perror("Debug leaking scalars parent sendmsg failed");
546 if(got < sizeof(sv)) {
547 perror("Debug leaking scalars parent short sendmsg");
551 /* Return protocol is
553 unsigned char: length of location string (0 for empty)
554 unsigned char*: string (not terminated)
556 vec[0].iov_base = (void*)&returned_errno;
557 vec[0].iov_len = sizeof(returned_errno);
558 vec[1].iov_base = buffer;
561 got = readv(sock, vec, 2);
564 perror("Debug leaking scalars parent read failed");
565 PerlIO_flush(PerlIO_stderr());
568 if(got < sizeof(returned_errno) + 1) {
569 perror("Debug leaking scalars parent short read");
570 PerlIO_flush(PerlIO_stderr());
575 got = read(sock, buffer + 1, *buffer);
577 perror("Debug leaking scalars parent read 2 failed");
578 PerlIO_flush(PerlIO_stderr());
583 perror("Debug leaking scalars parent short read 2");
584 PerlIO_flush(PerlIO_stderr());
589 if (returned_errno || *buffer) {
590 Perl_warn(aTHX_ "Debug leaking scalars child failed%s%.*s with errno"
591 " %d: %s", (*buffer ? " at " : ""), (int) *buffer, buffer + 1,
592 returned_errno, Strerror(returned_errno));
598 =for apidoc Am|int|perl_destruct|PerlInterpreter *my_perl
600 Shuts down a Perl interpreter. See L<perlembed> for a tutorial.
602 C<my_perl> points to the Perl interpreter. It must have been previously
603 created through the use of L</perl_alloc> and L</perl_construct>. It may
604 have been initialised through L</perl_parse>, and may have been used
605 through L</perl_run> and other means. This function should be called for
606 any Perl interpreter that has been constructed with L</perl_construct>,
607 even if subsequent operations on it failed, for example if L</perl_parse>
608 returned a non-zero value.
610 If the interpreter's C<PL_exit_flags> word has the
611 C<PERL_EXIT_DESTRUCT_END> flag set, then this function will execute code
612 in C<END> blocks before performing the rest of destruction. If it is
613 desired to make any use of the interpreter between L</perl_parse> and
614 L</perl_destruct> other than just calling L</perl_run>, then this flag
615 should be set early on. This matters if L</perl_run> will not be called,
616 or if anything else will be done in addition to calling L</perl_run>.
618 Returns a value be a suitable value to pass to the C library function
619 C<exit> (or to return from C<main>), to serve as an exit code indicating
620 the nature of the way the interpreter terminated. This takes into account
621 any failure of L</perl_parse> and any early exit from L</perl_run>.
622 The exit code is of the type required by the host operating system,
623 so because of differing exit code conventions it is not portable to
624 interpret specific numeric values as having specific meanings.
633 volatile signed char destruct_level; /* see possible values in intrpvar.h */
635 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
640 PERL_ARGS_ASSERT_PERL_DESTRUCT;
642 PERL_UNUSED_ARG(my_perl);
645 assert(PL_scopestack_ix == 1);
647 /* wait for all pseudo-forked children to finish */
648 PERL_WAIT_FOR_CHILDREN;
650 destruct_level = PL_perl_destruct_level;
651 #if defined(DEBUGGING) || defined(PERL_TRACK_MEMPOOL)
653 const char * const s = PerlEnv_getenv("PERL_DESTRUCT_LEVEL");
656 if (strEQ(s, "-1")) { /* Special case: modperl folklore. */
660 if (grok_atoUV(s, &uv, NULL) && uv <= INT_MAX)
666 if (destruct_level < i) destruct_level = i;
668 #ifdef PERL_TRACK_MEMPOOL
669 /* RT #114496, for perl_free */
670 PL_perl_destruct_level = i;
676 if (PL_exit_flags & PERL_EXIT_DESTRUCT_END) {
682 if (PL_endav && !PL_minus_c) {
683 PERL_SET_PHASE(PERL_PHASE_END);
684 call_list(PL_scopestack_ix, PL_endav);
690 assert(PL_scopestack_ix == 0);
692 /* Need to flush since END blocks can produce output */
693 /* flush stdout separately, since we can identify it */
696 PerlIO *stdo = PerlIO_stdout();
697 if (*stdo && PerlIO_flush(stdo)) {
698 PerlIO_restore_errno(stdo);
700 PerlIO_printf(PerlIO_stderr(), "Unable to flush stdout: %s\n",
709 #ifdef PERL_TRACE_OPS
710 /* dump OP-counts if $ENV{PERL_TRACE_OPS} > 0 */
712 const char * const ptoenv = PerlEnv_getenv("PERL_TRACE_OPS");
715 if (!ptoenv || !Perl_grok_atoUV(ptoenv, &uv, NULL)
719 PerlIO_printf(Perl_debug_log, "Trace of all OPs executed:\n");
720 for (i = 0; i <= OP_max; ++i) {
721 if (PL_op_exec_cnt[i])
722 PerlIO_printf(Perl_debug_log, " %s: %" UVuf "\n", PL_op_name[i], PL_op_exec_cnt[i]);
724 /* Utility slot for easily doing little tracing experiments in the runloop: */
725 if (PL_op_exec_cnt[OP_max+1] != 0)
726 PerlIO_printf(Perl_debug_log, " SPECIAL: %" UVuf "\n", PL_op_exec_cnt[OP_max+1]);
727 PerlIO_printf(Perl_debug_log, "\n");
732 if (PL_threadhook(aTHX)) {
733 /* Threads hook has vetoed further cleanup */
734 PL_veto_cleanup = TRUE;
738 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
739 if (destruct_level != 0) {
740 /* Fork here to create a child. Our child's job is to preserve the
741 state of scalars prior to destruction, so that we can instruct it
742 to dump any scalars that we later find have leaked.
743 There's no subtlety in this code - it assumes POSIX, and it doesn't
747 if(PerlSock_socketpair_cloexec(AF_UNIX, SOCK_STREAM, 0, fd)) {
748 perror("Debug leaking scalars socketpair failed");
754 perror("Debug leaking scalars fork failed");
758 /* We are the child */
759 const int sock = fd[1];
760 const int debug_fd = PerlIO_fileno(Perl_debug_log);
763 /* Our success message is an integer 0, and a char 0 */
764 static const char success[sizeof(int) + 1] = {0};
768 /* We need to close all other file descriptors otherwise we end up
769 with interesting hangs, where the parent closes its end of a
770 pipe, and sits waiting for (another) child to terminate. Only
771 that child never terminates, because it never gets EOF, because
772 we also have the far end of the pipe open. We even need to
773 close the debugging fd, because sometimes it happens to be one
774 end of a pipe, and a process is waiting on the other end for
775 EOF. Normally it would be closed at some point earlier in
776 destruction, but if we happen to cause the pipe to remain open,
777 EOF never occurs, and we get an infinite hang. Hence all the
778 games to pass in a file descriptor if it's actually needed. */
780 f = sysconf(_SC_OPEN_MAX);
782 where = "sysconf failed";
793 union control_un control;
796 struct cmsghdr *cmptr;
800 msg.msg_control = control.control;
801 msg.msg_controllen = sizeof(control.control);
802 /* We're a connected socket so we don't need a source */
806 msg.msg_iovlen = C_ARRAY_LENGTH(vec);
808 vec[0].iov_base = (void*)⌖
809 vec[0].iov_len = sizeof(target);
811 got = recvmsg(sock, &msg, 0);
816 where = "recv failed";
819 if(got < sizeof(target)) {
820 where = "short recv";
824 if(!(cmptr = CMSG_FIRSTHDR(&msg))) {
828 if(cmptr->cmsg_len != CMSG_LEN(sizeof(int))) {
829 where = "wrong cmsg_len";
832 if(cmptr->cmsg_level != SOL_SOCKET) {
833 where = "wrong cmsg_level";
836 if(cmptr->cmsg_type != SCM_RIGHTS) {
837 where = "wrong cmsg_type";
841 got_fd = *(int*)CMSG_DATA(cmptr);
842 /* For our last little bit of trickery, put the file descriptor
843 back into Perl_debug_log, as if we never actually closed it
845 if(got_fd != debug_fd) {
846 if (PerlLIO_dup2_cloexec(got_fd, debug_fd) == -1) {
853 PerlIO_flush(Perl_debug_log);
855 got = write(sock, &success, sizeof(success));
858 where = "write failed";
861 if(got < sizeof(success)) {
862 where = "short write";
869 int send_errno = errno;
870 unsigned char length = (unsigned char) strlen(where);
871 struct iovec failure[3] = {
872 {(void*)&send_errno, sizeof(send_errno)},
874 {(void*)where, length}
876 int got = writev(sock, failure, 3);
877 /* Bad news travels fast. Faster than data. We'll get a SIGPIPE
878 in the parent if we try to read from the socketpair after the
879 child has exited, even if there was data to read.
880 So sleep a bit to give the parent a fighting chance of
883 _exit((got == -1) ? errno : 0);
887 PL_dumper_fd = fd[0];
892 /* We must account for everything. */
894 /* Destroy the main CV and syntax tree */
895 /* Set PL_curcop now, because destroying ops can cause new SVs
896 to be generated in Perl_pad_swipe, and when running with
897 -DDEBUG_LEAKING_SCALARS they expect PL_curcop to point to a valid
898 op from which the filename structure member is copied. */
899 PL_curcop = &PL_compiling;
901 /* ensure comppad/curpad to refer to main's pad */
902 if (CvPADLIST(PL_main_cv)) {
903 PAD_SET_CUR_NOSAVE(CvPADLIST(PL_main_cv), 1);
904 PL_comppad_name = PadlistNAMES(CvPADLIST(PL_main_cv));
906 op_free(PL_main_root);
909 PL_main_start = NULL;
910 /* note that PL_main_cv isn't usually actually freed at this point,
911 * due to the CvOUTSIDE refs from subs compiled within it. It will
912 * get freed once all the subs are freed in sv_clean_all(), for
913 * destruct_level > 0 */
914 SvREFCNT_dec(PL_main_cv);
916 PERL_SET_PHASE(PERL_PHASE_DESTRUCT);
918 /* Tell PerlIO we are about to tear things apart in case
919 we have layers which are using resources that should
923 PerlIO_destruct(aTHX);
926 * Try to destruct global references. We do this first so that the
927 * destructors and destructees still exist. Some sv's might remain.
928 * Non-referenced objects are on their own.
932 /* unhook hooks which will soon be, or use, destroyed data */
933 SvREFCNT_dec(PL_warnhook);
935 SvREFCNT_dec(PL_diehook);
938 /* call exit list functions */
939 while (PL_exitlistlen-- > 0)
940 PL_exitlist[PL_exitlistlen].fn(aTHX_ PL_exitlist[PL_exitlistlen].ptr);
942 Safefree(PL_exitlist);
947 SvREFCNT_dec(PL_registered_mros);
949 /* jettison our possibly duplicated environment */
950 /* if PERL_USE_SAFE_PUTENV is defined environ will not have been copied
951 * so we certainly shouldn't free it here
954 #if defined(USE_ENVIRON_ARRAY) && !defined(PERL_USE_SAFE_PUTENV)
955 if (environ != PL_origenviron && !PL_use_safe_putenv
957 /* only main thread can free environ[0] contents */
958 && PL_curinterp == aTHX
964 for (i = 0; environ[i]; i++)
965 safesysfree(environ[i]);
967 /* Must use safesysfree() when working with environ. */
968 safesysfree(environ);
970 environ = PL_origenviron;
973 #endif /* !PERL_MICRO */
975 if (destruct_level == 0) {
977 DEBUG_P(debprofdump());
979 #if defined(PERLIO_LAYERS)
980 /* No more IO - including error messages ! */
981 PerlIO_cleanup(aTHX);
984 CopFILE_free(&PL_compiling);
986 /* The exit() function will do everything that needs doing. */
990 /* Below, do clean up for when PERL_DESTRUCT_LEVEL is not 0 */
993 /* the syntax tree is shared between clones
994 * so op_free(PL_main_root) only ReREFCNT_dec's
995 * REGEXPs in the parent interpreter
996 * we need to manually ReREFCNT_dec for the clones
999 I32 i = AvFILLp(PL_regex_padav);
1000 SV **ary = AvARRAY(PL_regex_padav);
1003 SvREFCNT_dec(ary[i]);
1004 ary[i] = &PL_sv_undef;
1010 SvREFCNT_dec(MUTABLE_SV(PL_stashcache));
1011 PL_stashcache = NULL;
1013 /* loosen bonds of global variables */
1015 /* XXX can PL_parser still be non-null here? */
1016 if(PL_parser && PL_parser->rsfp) {
1017 (void)PerlIO_close(PL_parser->rsfp);
1018 PL_parser->rsfp = NULL;
1022 Safefree(PL_splitstr);
1032 PL_doswitches = FALSE;
1033 PL_dowarn = G_WARN_OFF;
1034 #ifdef PERL_SAWAMPERSAND
1035 PL_sawampersand = 0; /* must save all match strings */
1039 Safefree(PL_inplace);
1041 SvREFCNT_dec(PL_patchlevel);
1044 SvREFCNT_dec(PL_e_script);
1050 /* magical thingies */
1052 SvREFCNT_dec(PL_ofsgv); /* *, */
1055 SvREFCNT_dec(PL_ors_sv); /* $\ */
1058 SvREFCNT_dec(PL_rs); /* $/ */
1061 Safefree(PL_osname); /* $^O */
1064 SvREFCNT_dec(PL_statname);
1068 /* defgv, aka *_ should be taken care of elsewhere */
1071 Safefree(PL_efloatbuf);
1072 PL_efloatbuf = NULL;
1075 /* startup and shutdown function lists */
1076 SvREFCNT_dec(PL_beginav);
1077 SvREFCNT_dec(PL_beginav_save);
1078 SvREFCNT_dec(PL_endav);
1079 SvREFCNT_dec(PL_checkav);
1080 SvREFCNT_dec(PL_checkav_save);
1081 SvREFCNT_dec(PL_unitcheckav);
1082 SvREFCNT_dec(PL_unitcheckav_save);
1083 SvREFCNT_dec(PL_initav);
1085 PL_beginav_save = NULL;
1088 PL_checkav_save = NULL;
1089 PL_unitcheckav = NULL;
1090 PL_unitcheckav_save = NULL;
1093 /* shortcuts just get cleared */
1096 PL_argvoutgv = NULL;
1099 PL_last_in_gv = NULL;
1110 SvREFCNT_dec(PL_envgv);
1111 SvREFCNT_dec(PL_incgv);
1112 SvREFCNT_dec(PL_argvgv);
1113 SvREFCNT_dec(PL_replgv);
1114 SvREFCNT_dec(PL_DBgv);
1115 SvREFCNT_dec(PL_DBline);
1116 SvREFCNT_dec(PL_DBsub);
1125 SvREFCNT_dec(PL_argvout_stack);
1126 PL_argvout_stack = NULL;
1128 SvREFCNT_dec(PL_modglobal);
1129 PL_modglobal = NULL;
1130 SvREFCNT_dec(PL_preambleav);
1131 PL_preambleav = NULL;
1132 SvREFCNT_dec(PL_subname);
1134 #ifdef PERL_USES_PL_PIDSTATUS
1135 SvREFCNT_dec(PL_pidstatus);
1136 PL_pidstatus = NULL;
1138 SvREFCNT_dec(PL_toptarget);
1139 PL_toptarget = NULL;
1140 SvREFCNT_dec(PL_bodytarget);
1141 PL_bodytarget = NULL;
1142 PL_formtarget = NULL;
1144 /* free locale stuff */
1145 #ifdef USE_LOCALE_COLLATE
1146 Safefree(PL_collation_name);
1147 PL_collation_name = NULL;
1149 #if defined(USE_POSIX_2008_LOCALE) \
1150 && defined(USE_THREAD_SAFE_LOCALE) \
1151 && ! defined(HAS_QUERYLOCALE)
1152 for (i = 0; i < (int) C_ARRAY_LENGTH(PL_curlocales); i++) {
1153 Safefree(PL_curlocales[i]);
1154 PL_curlocales[i] = NULL;
1157 #ifdef USE_LOCALE_NUMERIC
1158 Safefree(PL_numeric_name);
1159 PL_numeric_name = NULL;
1160 SvREFCNT_dec(PL_numeric_radix_sv);
1161 PL_numeric_radix_sv = NULL;
1163 # ifdef HAS_POSIX_2008_LOCALE
1164 if (PL_underlying_numeric_obj) {
1165 /* Make sure we aren't using the locale space we are about to free */
1166 uselocale(LC_GLOBAL_LOCALE);
1167 freelocale(PL_underlying_numeric_obj);
1168 PL_underlying_numeric_obj = (locale_t) NULL;
1173 if (PL_setlocale_buf) {
1174 Safefree(PL_setlocale_buf);
1175 PL_setlocale_buf = NULL;
1178 if (PL_langinfo_buf) {
1179 Safefree(PL_langinfo_buf);
1180 PL_langinfo_buf = NULL;
1183 /* clear character classes */
1184 for (i = 0; i < POSIX_SWASH_COUNT; i++) {
1185 SvREFCNT_dec(PL_utf8_swash_ptrs[i]);
1186 PL_utf8_swash_ptrs[i] = NULL;
1188 SvREFCNT_dec(PL_utf8_mark);
1189 SvREFCNT_dec(PL_utf8_toupper);
1190 SvREFCNT_dec(PL_utf8_totitle);
1191 SvREFCNT_dec(PL_utf8_tolower);
1192 SvREFCNT_dec(PL_utf8_tofold);
1193 SvREFCNT_dec(PL_utf8_foldclosures);
1194 SvREFCNT_dec(PL_InBitmap);
1195 #ifdef USE_LOCALE_CTYPE
1196 SvREFCNT_dec(PL_warn_locale);
1198 PL_utf8_mark = NULL;
1199 PL_utf8_toupper = NULL;
1200 PL_utf8_totitle = NULL;
1201 PL_utf8_tolower = NULL;
1202 PL_utf8_tofold = NULL;
1203 PL_utf8_foldclosures = NULL;
1205 #ifdef USE_LOCALE_CTYPE
1206 PL_warn_locale = NULL;
1209 if (!specialWARN(PL_compiling.cop_warnings))
1210 PerlMemShared_free(PL_compiling.cop_warnings);
1211 PL_compiling.cop_warnings = NULL;
1212 cophh_free(CopHINTHASH_get(&PL_compiling));
1213 CopHINTHASH_set(&PL_compiling, cophh_new_empty());
1214 CopFILE_free(&PL_compiling);
1216 /* Prepare to destruct main symbol table. */
1219 /* break ref loop *:: <=> %:: */
1220 (void)hv_deletes(hv, "main::", G_DISCARD);
1223 SvREFCNT_dec(PL_curstname);
1224 PL_curstname = NULL;
1226 /* clear queued errors */
1227 SvREFCNT_dec(PL_errors);
1230 SvREFCNT_dec(PL_isarev);
1233 if (destruct_level >= 2) {
1234 if (PL_scopestack_ix != 0)
1235 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
1236 "Unbalanced scopes: %ld more ENTERs than LEAVEs\n",
1237 (long)PL_scopestack_ix);
1238 if (PL_savestack_ix != 0)
1239 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
1240 "Unbalanced saves: %ld more saves than restores\n",
1241 (long)PL_savestack_ix);
1242 if (PL_tmps_floor != -1)
1243 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced tmps: %ld more allocs than frees\n",
1244 (long)PL_tmps_floor + 1);
1245 if (cxstack_ix != -1)
1246 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced context: %ld more PUSHes than POPs\n",
1247 (long)cxstack_ix + 1);
1251 SvREFCNT_dec(PL_regex_padav);
1252 PL_regex_padav = NULL;
1253 PL_regex_pad = NULL;
1256 #ifdef PERL_IMPLICIT_CONTEXT
1257 /* the entries in this list are allocated via SV PVX's, so get freed
1258 * in sv_clean_all */
1259 Safefree(PL_my_cxt_list);
1262 /* Now absolutely destruct everything, somehow or other, loops or no. */
1264 /* the 2 is for PL_fdpid and PL_strtab */
1265 while (sv_clean_all() > 2)
1269 Safefree(PL_stashpad); /* must come after sv_clean_all */
1272 AvREAL_off(PL_fdpid); /* no surviving entries */
1273 SvREFCNT_dec(PL_fdpid); /* needed in io_close() */
1276 #ifdef HAVE_INTERP_INTERN
1280 /* constant strings */
1281 for (i = 0; i < SV_CONSTS_COUNT; i++) {
1282 SvREFCNT_dec(PL_sv_consts[i]);
1283 PL_sv_consts[i] = NULL;
1286 /* Destruct the global string table. */
1288 /* Yell and reset the HeVAL() slots that are still holding refcounts,
1289 * so that sv_free() won't fail on them.
1290 * Now that the global string table is using a single hunk of memory
1291 * for both HE and HEK, we either need to explicitly unshare it the
1292 * correct way, or actually free things here.
1295 const I32 max = HvMAX(PL_strtab);
1296 HE * const * const array = HvARRAY(PL_strtab);
1297 HE *hent = array[0];
1300 if (hent && ckWARN_d(WARN_INTERNAL)) {
1301 HE * const next = HeNEXT(hent);
1302 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
1303 "Unbalanced string table refcount: (%ld) for \"%s\"",
1304 (long)hent->he_valu.hent_refcount, HeKEY(hent));
1311 hent = array[riter];
1316 HvARRAY(PL_strtab) = 0;
1317 HvTOTALKEYS(PL_strtab) = 0;
1319 SvREFCNT_dec(PL_strtab);
1322 /* free the pointer tables used for cloning */
1323 ptr_table_free(PL_ptr_table);
1324 PL_ptr_table = (PTR_TBL_t*)NULL;
1327 /* free special SVs */
1329 SvREFCNT(&PL_sv_yes) = 0;
1330 sv_clear(&PL_sv_yes);
1331 SvANY(&PL_sv_yes) = NULL;
1332 SvFLAGS(&PL_sv_yes) = 0;
1334 SvREFCNT(&PL_sv_no) = 0;
1335 sv_clear(&PL_sv_no);
1336 SvANY(&PL_sv_no) = NULL;
1337 SvFLAGS(&PL_sv_no) = 0;
1339 SvREFCNT(&PL_sv_zero) = 0;
1340 sv_clear(&PL_sv_zero);
1341 SvANY(&PL_sv_zero) = NULL;
1342 SvFLAGS(&PL_sv_zero) = 0;
1346 for (i=0; i<=2; i++) {
1347 SvREFCNT(PERL_DEBUG_PAD(i)) = 0;
1348 sv_clear(PERL_DEBUG_PAD(i));
1349 SvANY(PERL_DEBUG_PAD(i)) = NULL;
1350 SvFLAGS(PERL_DEBUG_PAD(i)) = 0;
1354 if (PL_sv_count != 0 && ckWARN_d(WARN_INTERNAL))
1355 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Scalars leaked: %ld\n", (long)PL_sv_count);
1357 #ifdef DEBUG_LEAKING_SCALARS
1358 if (PL_sv_count != 0) {
1363 for (sva = PL_sv_arenaroot; sva; sva = MUTABLE_SV(SvANY(sva))) {
1364 svend = &sva[SvREFCNT(sva)];
1365 for (sv = sva + 1; sv < svend; ++sv) {
1366 if (SvTYPE(sv) != (svtype)SVTYPEMASK) {
1367 PerlIO_printf(Perl_debug_log, "leaked: sv=0x%p"
1369 " refcnt=%"UVuf pTHX__FORMAT "\n"
1370 "\tallocated at %s:%d %s %s (parent 0x%" UVxf ");"
1371 "serial %" UVuf "\n",
1372 (void*)sv, (UV)sv->sv_flags, (UV)sv->sv_refcnt
1374 sv->sv_debug_file ? sv->sv_debug_file : "(unknown)",
1376 sv->sv_debug_inpad ? "for" : "by",
1377 sv->sv_debug_optype ?
1378 PL_op_name[sv->sv_debug_optype]: "(none)",
1379 PTR2UV(sv->sv_debug_parent),
1382 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1383 Perl_dump_sv_child(aTHX_ sv);
1389 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1393 /* Wait for up to 4 seconds for child to terminate.
1394 This seems to be the least effort way of timing out on reaping
1396 struct timeval waitfor = {4, 0};
1397 int sock = PL_dumper_fd;
1401 FD_SET(sock, &rset);
1402 select(sock + 1, &rset, NULL, NULL, &waitfor);
1403 waitpid(child, &status, WNOHANG);
1408 #ifdef DEBUG_LEAKING_SCALARS_ABORT
1414 #if defined(PERLIO_LAYERS)
1415 /* No more IO - including error messages ! */
1416 PerlIO_cleanup(aTHX);
1419 /* sv_undef needs to stay immortal until after PerlIO_cleanup
1420 as currently layers use it rather than NULL as a marker
1421 for no arg - and will try and SvREFCNT_dec it.
1423 SvREFCNT(&PL_sv_undef) = 0;
1424 SvREADONLY_off(&PL_sv_undef);
1426 Safefree(PL_origfilename);
1427 PL_origfilename = NULL;
1428 Safefree(PL_reg_curpm);
1429 free_tied_hv_pool();
1430 Safefree(PL_op_mask);
1431 Safefree(PL_psig_name);
1432 PL_psig_name = (SV**)NULL;
1433 PL_psig_ptr = (SV**)NULL;
1435 /* We need to NULL PL_psig_pend first, so that
1436 signal handlers know not to use it */
1437 int *psig_save = PL_psig_pend;
1438 PL_psig_pend = (int*)NULL;
1439 Safefree(psig_save);
1442 TAINTING_set(FALSE);
1443 TAINT_WARN_set(FALSE);
1444 PL_hints = 0; /* Reset hints. Should hints be per-interpreter ? */
1446 DEBUG_P(debprofdump());
1450 #ifdef USE_REENTRANT_API
1451 Perl_reentrant_free(aTHX);
1454 /* These all point to HVs that are about to be blown away.
1455 Code in core and on CPAN assumes that if the interpreter is re-started
1456 that they will be cleanly NULL or pointing to a valid HV. */
1457 PL_custom_op_names = NULL;
1458 PL_custom_op_descs = NULL;
1459 PL_custom_ops = NULL;
1463 while (PL_regmatch_slab) {
1464 regmatch_slab *s = PL_regmatch_slab;
1465 PL_regmatch_slab = PL_regmatch_slab->next;
1469 /* As the absolutely last thing, free the non-arena SV for mess() */
1472 /* we know that type == SVt_PVMG */
1474 /* it could have accumulated taint magic */
1477 for (mg = SvMAGIC(PL_mess_sv); mg; mg = moremagic) {
1478 moremagic = mg->mg_moremagic;
1479 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global
1481 Safefree(mg->mg_ptr);
1485 /* we know that type >= SVt_PV */
1486 SvPV_free(PL_mess_sv);
1487 Safefree(SvANY(PL_mess_sv));
1488 Safefree(PL_mess_sv);
1495 =for apidoc perl_free
1497 Releases a Perl interpreter. See L<perlembed>.
1507 PERL_ARGS_ASSERT_PERL_FREE;
1509 if (PL_veto_cleanup)
1512 #ifdef PERL_TRACK_MEMPOOL
1515 * Don't free thread memory if PERL_DESTRUCT_LEVEL is set to a non-zero
1516 * value as we're probably hunting memory leaks then
1518 if (PL_perl_destruct_level == 0) {
1519 const U32 old_debug = PL_debug;
1520 /* Emulate the PerlHost behaviour of free()ing all memory allocated in this
1521 thread at thread exit. */
1523 PerlIO_puts(Perl_debug_log, "Disabling memory debugging as we "
1524 "free this thread's memory\n");
1525 PL_debug &= ~ DEBUG_m_FLAG;
1527 while(aTHXx->Imemory_debug_header.next != &(aTHXx->Imemory_debug_header)){
1528 char * next = (char *)(aTHXx->Imemory_debug_header.next);
1529 Malloc_t ptr = PERL_MEMORY_DEBUG_HEADER_SIZE + next;
1532 PL_debug = old_debug;
1537 #if defined(WIN32) || defined(NETWARE)
1538 # if defined(PERL_IMPLICIT_SYS)
1541 void *host = nw_internal_host;
1542 PerlMem_free(aTHXx);
1543 nw_delete_internal_host(host);
1545 void *host = w32_internal_host;
1546 PerlMem_free(aTHXx);
1547 win32_delete_internal_host(host);
1551 PerlMem_free(aTHXx);
1554 PerlMem_free(aTHXx);
1558 #if defined(USE_ITHREADS)
1559 /* provide destructors to clean up the thread key when libperl is unloaded */
1560 #ifndef WIN32 /* handled during DLL_PROCESS_DETACH in win32/perllib.c */
1562 #if defined(__hpux) && !(defined(__ux_version) && __ux_version <= 1020) && !defined(__GNUC__)
1563 #pragma fini "perl_fini"
1564 #elif defined(__sun) && !defined(__GNUC__)
1565 #pragma fini (perl_fini)
1569 #if defined(__GNUC__)
1570 __attribute__((destructor))
1576 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
1579 PL_curinterp && !PL_veto_cleanup)
1584 #endif /* THREADS */
1587 Perl_call_atexit(pTHX_ ATEXIT_t fn, void *ptr)
1589 Renew(PL_exitlist, PL_exitlistlen+1, PerlExitListEntry);
1590 PL_exitlist[PL_exitlistlen].fn = fn;
1591 PL_exitlist[PL_exitlistlen].ptr = ptr;
1596 =for apidoc Am|int|perl_parse|PerlInterpreter *my_perl|XSINIT_t xsinit|int argc|char **argv|char **env
1598 Tells a Perl interpreter to parse a Perl script. This performs most
1599 of the initialisation of a Perl interpreter. See L<perlembed> for
1602 C<my_perl> points to the Perl interpreter that is to parse the script.
1603 It must have been previously created through the use of L</perl_alloc>
1604 and L</perl_construct>. C<xsinit> points to a callback function that
1605 will be called to set up the ability for this Perl interpreter to load
1606 XS extensions, or may be null to perform no such setup.
1608 C<argc> and C<argv> supply a set of command-line arguments to the Perl
1609 interpreter, as would normally be passed to the C<main> function of
1610 a C program. C<argv[argc]> must be null. These arguments are where
1611 the script to parse is specified, either by naming a script file or by
1612 providing a script in a C<-e> option.
1613 If L<C<$0>|perlvar/$0> will be written to in the Perl interpreter, then
1614 the argument strings must be in writable memory, and so mustn't just be
1617 C<env> specifies a set of environment variables that will be used by
1618 this Perl interpreter. If non-null, it must point to a null-terminated
1619 array of environment strings. If null, the Perl interpreter will use
1620 the environment supplied by the C<environ> global variable.
1622 This function initialises the interpreter, and parses and compiles the
1623 script specified by the command-line arguments. This includes executing
1624 code in C<BEGIN>, C<UNITCHECK>, and C<CHECK> blocks. It does not execute
1625 C<INIT> blocks or the main program.
1627 Returns an integer of slightly tricky interpretation. The correct
1628 use of the return value is as a truth value indicating whether there
1629 was a failure in initialisation. If zero is returned, this indicates
1630 that initialisation was successful, and it is safe to proceed to call
1631 L</perl_run> and make other use of it. If a non-zero value is returned,
1632 this indicates some problem that means the interpreter wants to terminate.
1633 The interpreter should not be just abandoned upon such failure; the caller
1634 should proceed to shut the interpreter down cleanly with L</perl_destruct>
1635 and free it with L</perl_free>.
1637 For historical reasons, the non-zero return value also attempts to
1638 be a suitable value to pass to the C library function C<exit> (or to
1639 return from C<main>), to serve as an exit code indicating the nature
1640 of the way initialisation terminated. However, this isn't portable,
1641 due to differing exit code conventions. A historical bug is preserved
1642 for the time being: if the Perl built-in C<exit> is called during this
1643 function's execution, with a type of exit entailing a zero exit code
1644 under the host operating system's conventions, then this function
1645 returns zero rather than a non-zero value. This bug, [perl #2754],
1646 leads to C<perl_run> being called (and therefore C<INIT> blocks and the
1647 main program running) despite a call to C<exit>. It has been preserved
1648 because a popular module-installing module has come to rely on it and
1649 needs time to be fixed. This issue is [perl #132577], and the original
1650 bug is due to be fixed in Perl 5.30.
1655 #define SET_CURSTASH(newstash) \
1656 if (PL_curstash != newstash) { \
1657 SvREFCNT_dec(PL_curstash); \
1658 PL_curstash = (HV *)SvREFCNT_inc(newstash); \
1662 perl_parse(pTHXx_ XSINIT_t xsinit, int argc, char **argv, char **env)
1669 PERL_ARGS_ASSERT_PERL_PARSE;
1670 #ifndef MULTIPLICITY
1671 PERL_UNUSED_ARG(my_perl);
1673 #if (defined(USE_HASH_SEED) || defined(USE_HASH_SEED_DEBUG)) && !defined(NO_PERL_HASH_SEED_DEBUG)
1675 const char * const s = PerlEnv_getenv("PERL_HASH_SEED_DEBUG");
1677 if (s && strEQ(s, "1")) {
1678 const unsigned char *seed= PERL_HASH_SEED;
1679 const unsigned char *seed_end= PERL_HASH_SEED + PERL_HASH_SEED_BYTES;
1680 PerlIO_printf(Perl_debug_log, "HASH_FUNCTION = %s HASH_SEED = 0x", PERL_HASH_FUNC);
1681 while (seed < seed_end) {
1682 PerlIO_printf(Perl_debug_log, "%02x", *seed++);
1684 #ifdef PERL_HASH_RANDOMIZE_KEYS
1685 PerlIO_printf(Perl_debug_log, " PERTURB_KEYS = %d (%s)",
1686 PL_HASH_RAND_BITS_ENABLED,
1687 PL_HASH_RAND_BITS_ENABLED == 0 ? "NO" : PL_HASH_RAND_BITS_ENABLED == 1 ? "RANDOM" : "DETERMINISTIC");
1689 PerlIO_printf(Perl_debug_log, "\n");
1692 #endif /* #if (defined(USE_HASH_SEED) ... */
1696 struct NameTranslationInfo nti;
1697 __translate_amiga_to_unix_path_name(&argv[0],&nti);
1704 for(i = 0; i != argc; i++)
1706 assert(!argv[argc]);
1711 if (PL_origalen != 0) {
1712 PL_origalen = 1; /* don't use old PL_origalen if perl_parse() is called again */
1715 /* Set PL_origalen be the sum of the contiguous argv[]
1716 * elements plus the size of the env in case that it is
1717 * contiguous with the argv[]. This is used in mg.c:Perl_magic_set()
1718 * as the maximum modifiable length of $0. In the worst case
1719 * the area we are able to modify is limited to the size of
1720 * the original argv[0]. (See below for 'contiguous', though.)
1722 const char *s = NULL;
1723 const UV mask = ~(UV)(PTRSIZE-1);
1724 /* Do the mask check only if the args seem like aligned. */
1726 (mask < ~(UV)0) && ((PTR2UV(argv[0]) & mask) == PTR2UV(argv[0]));
1728 /* See if all the arguments are contiguous in memory. Note
1729 * that 'contiguous' is a loose term because some platforms
1730 * align the argv[] and the envp[]. If the arguments look
1731 * like non-aligned, assume that they are 'strictly' or
1732 * 'traditionally' contiguous. If the arguments look like
1733 * aligned, we just check that they are within aligned
1734 * PTRSIZE bytes. As long as no system has something bizarre
1735 * like the argv[] interleaved with some other data, we are
1736 * fine. (Did I just evoke Murphy's Law?) --jhi */
1737 if (PL_origargv && PL_origargc >= 1 && (s = PL_origargv[0])) {
1740 for (i = 1; i < PL_origargc; i++) {
1741 if ((PL_origargv[i] == s + 1
1743 || PL_origargv[i] == s + 2
1748 (PL_origargv[i] > s &&
1750 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1761 #ifndef PERL_USE_SAFE_PUTENV
1762 /* Can we grab env area too to be used as the area for $0? */
1763 if (s && PL_origenviron && !PL_use_safe_putenv) {
1764 if ((PL_origenviron[0] == s + 1)
1767 (PL_origenviron[0] > s &&
1768 PL_origenviron[0] <=
1769 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1773 #ifndef OS2 /* ENVIRON is read by the kernel too. */
1774 s = PL_origenviron[0];
1777 my_setenv("NoNe SuCh", NULL);
1778 /* Force copy of environment. */
1779 for (i = 1; PL_origenviron[i]; i++) {
1780 if (PL_origenviron[i] == s + 1
1783 (PL_origenviron[i] > s &&
1784 PL_origenviron[i] <=
1785 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1788 s = PL_origenviron[i];
1796 #endif /* !defined(PERL_USE_SAFE_PUTENV) */
1798 PL_origalen = s ? s - PL_origargv[0] + 1 : 0;
1803 /* Come here if running an undumped a.out. */
1805 PL_origfilename = savepv(argv[0]);
1806 PL_do_undump = FALSE;
1807 cxstack_ix = -1; /* start label stack again */
1809 assert (!TAINT_get);
1813 init_postdump_symbols(argc,argv,env);
1818 op_free(PL_main_root);
1819 PL_main_root = NULL;
1821 PL_main_start = NULL;
1822 SvREFCNT_dec(PL_main_cv);
1826 oldscope = PL_scopestack_ix;
1827 PL_dowarn = G_WARN_OFF;
1832 parse_body(env,xsinit);
1833 if (PL_unitcheckav) {
1834 call_list(oldscope, PL_unitcheckav);
1837 PERL_SET_PHASE(PERL_PHASE_CHECK);
1838 call_list(oldscope, PL_checkav);
1846 /* my_exit() was called */
1847 while (PL_scopestack_ix > oldscope)
1850 SET_CURSTASH(PL_defstash);
1851 if (PL_unitcheckav) {
1852 call_list(oldscope, PL_unitcheckav);
1855 PERL_SET_PHASE(PERL_PHASE_CHECK);
1856 call_list(oldscope, PL_checkav);
1861 * At this point we should do
1863 * to avoid [perl #2754], but that bugfix has been postponed
1864 * because of the Module::Install breakage it causes
1870 PerlIO_printf(Perl_error_log, "panic: top_env\n");
1878 /* This needs to stay in perl.c, as perl.c is compiled with different flags for
1879 miniperl, and we need to see those flags reflected in the values here. */
1881 /* What this returns is subject to change. Use the public interface in Config.
1884 S_Internals_V(pTHX_ CV *cv)
1887 #ifdef LOCAL_PATCH_COUNT
1888 const int local_patch_count = LOCAL_PATCH_COUNT;
1890 const int local_patch_count = 0;
1892 const int entries = 3 + local_patch_count;
1894 static const char non_bincompat_options[] =
1901 # ifdef NO_HASH_SEED
1904 # ifdef NO_TAINT_SUPPORT
1907 # ifdef PERL_BOOL_AS_CHAR
1908 " PERL_BOOL_AS_CHAR"
1910 # ifdef PERL_COPY_ON_WRITE
1911 " PERL_COPY_ON_WRITE"
1913 # ifdef PERL_DISABLE_PMC
1916 # ifdef PERL_DONT_CREATE_GVSV
1917 " PERL_DONT_CREATE_GVSV"
1919 # ifdef PERL_EXTERNAL_GLOB
1920 " PERL_EXTERNAL_GLOB"
1922 # ifdef PERL_HASH_FUNC_SIPHASH
1923 " PERL_HASH_FUNC_SIPHASH"
1925 # ifdef PERL_HASH_FUNC_SDBM
1926 " PERL_HASH_FUNC_SDBM"
1928 # ifdef PERL_HASH_FUNC_DJB2
1929 " PERL_HASH_FUNC_DJB2"
1931 # ifdef PERL_HASH_FUNC_SUPERFAST
1932 " PERL_HASH_FUNC_SUPERFAST"
1934 # ifdef PERL_HASH_FUNC_MURMUR3
1935 " PERL_HASH_FUNC_MURMUR3"
1937 # ifdef PERL_HASH_FUNC_ONE_AT_A_TIME
1938 " PERL_HASH_FUNC_ONE_AT_A_TIME"
1940 # ifdef PERL_HASH_FUNC_ONE_AT_A_TIME_HARD
1941 " PERL_HASH_FUNC_ONE_AT_A_TIME_HARD"
1943 # ifdef PERL_HASH_FUNC_ONE_AT_A_TIME_OLD
1944 " PERL_HASH_FUNC_ONE_AT_A_TIME_OLD"
1946 # ifdef PERL_IS_MINIPERL
1949 # ifdef PERL_MALLOC_WRAP
1952 # ifdef PERL_MEM_LOG
1955 # ifdef PERL_MEM_LOG_NOIMPL
1956 " PERL_MEM_LOG_NOIMPL"
1958 # ifdef PERL_OP_PARENT
1961 # ifdef PERL_PERTURB_KEYS_DETERMINISTIC
1962 " PERL_PERTURB_KEYS_DETERMINISTIC"
1964 # ifdef PERL_PERTURB_KEYS_DISABLED
1965 " PERL_PERTURB_KEYS_DISABLED"
1967 # ifdef PERL_PERTURB_KEYS_RANDOM
1968 " PERL_PERTURB_KEYS_RANDOM"
1970 # ifdef PERL_PRESERVE_IVUV
1971 " PERL_PRESERVE_IVUV"
1973 # ifdef PERL_RELOCATABLE_INCPUSH
1974 " PERL_RELOCATABLE_INCPUSH"
1976 # ifdef PERL_USE_DEVEL
1979 # ifdef PERL_USE_SAFE_PUTENV
1980 " PERL_USE_SAFE_PUTENV"
1982 # ifdef SILENT_NO_TAINT_SUPPORT
1983 " SILENT_NO_TAINT_SUPPORT"
1985 # ifdef UNLINK_ALL_VERSIONS
1986 " UNLINK_ALL_VERSIONS"
1988 # ifdef USE_ATTRIBUTES_FOR_PERLIO
1989 " USE_ATTRIBUTES_FOR_PERLIO"
1991 # ifdef USE_FAST_STDIO
1997 # ifdef USE_LOCALE_CTYPE
2000 # ifdef WIN32_NO_REGISTRY
2003 # ifdef USE_PERL_ATOF
2006 # ifdef USE_SITECUSTOMIZE
2007 " USE_SITECUSTOMIZE"
2010 PERL_UNUSED_ARG(cv);
2011 PERL_UNUSED_VAR(items);
2013 EXTEND(SP, entries);
2015 PUSHs(sv_2mortal(newSVpv(PL_bincompat_options, 0)));
2016 PUSHs(Perl_newSVpvn_flags(aTHX_ non_bincompat_options,
2017 sizeof(non_bincompat_options) - 1, SVs_TEMP));
2019 #ifndef PERL_BUILD_DATE
2022 # define PERL_BUILD_DATE __DATE__ " " __TIME__
2024 # define PERL_BUILD_DATE __DATE__
2029 #ifdef PERL_BUILD_DATE
2030 PUSHs(Perl_newSVpvn_flags(aTHX_
2031 STR_WITH_LEN("Compiled at " PERL_BUILD_DATE),
2034 PUSHs(&PL_sv_undef);
2037 for (i = 1; i <= local_patch_count; i++) {
2038 /* This will be an undef, if PL_localpatches[i] is NULL. */
2039 PUSHs(sv_2mortal(newSVpv(PL_localpatches[i], 0)));
2045 #define INCPUSH_UNSHIFT 0x01
2046 #define INCPUSH_ADD_OLD_VERS 0x02
2047 #define INCPUSH_ADD_VERSIONED_SUB_DIRS 0x04
2048 #define INCPUSH_ADD_ARCHONLY_SUB_DIRS 0x08
2049 #define INCPUSH_NOT_BASEDIR 0x10
2050 #define INCPUSH_CAN_RELOCATE 0x20
2051 #define INCPUSH_ADD_SUB_DIRS \
2052 (INCPUSH_ADD_VERSIONED_SUB_DIRS|INCPUSH_ADD_ARCHONLY_SUB_DIRS)
2055 S_parse_body(pTHX_ char **env, XSINIT_t xsinit)
2059 int argc = PL_origargc;
2060 char **argv = PL_origargv;
2061 const char *scriptname = NULL;
2062 bool dosearch = FALSE;
2064 bool doextract = FALSE;
2065 const char *cddir = NULL;
2066 #ifdef USE_SITECUSTOMIZE
2067 bool minus_f = FALSE;
2069 SV *linestr_sv = NULL;
2070 bool add_read_e_script = FALSE;
2071 U32 lex_start_flags = 0;
2073 PERL_SET_PHASE(PERL_PHASE_START);
2079 for (argc--,argv++; argc > 0; argc--,argv++) {
2080 if (argv[0][0] != '-' || !argv[0][1])
2086 #ifndef PERL_STRICT_CR
2110 if ((s = moreswitches(s)))
2115 #if defined(SILENT_NO_TAINT_SUPPORT)
2116 /* silently ignore */
2117 #elif defined(NO_TAINT_SUPPORT)
2118 Perl_croak_nocontext("This perl was compiled without taint support. "
2119 "Cowardly refusing to run with -t or -T flags");
2121 CHECK_MALLOC_TOO_LATE_FOR('t');
2122 if( !TAINTING_get ) {
2123 TAINT_WARN_set(TRUE);
2130 #if defined(SILENT_NO_TAINT_SUPPORT)
2131 /* silently ignore */
2132 #elif defined(NO_TAINT_SUPPORT)
2133 Perl_croak_nocontext("This perl was compiled without taint support. "
2134 "Cowardly refusing to run with -t or -T flags");
2136 CHECK_MALLOC_TOO_LATE_FOR('T');
2138 TAINT_WARN_set(FALSE);
2147 forbid_setid('e', FALSE);
2149 PL_e_script = newSVpvs("");
2150 add_read_e_script = TRUE;
2153 sv_catpv(PL_e_script, s);
2155 sv_catpv(PL_e_script, argv[1]);
2159 Perl_croak(aTHX_ "No code specified for -%c", c);
2160 sv_catpvs(PL_e_script, "\n");
2164 #ifdef USE_SITECUSTOMIZE
2170 case 'I': /* -I handled both here and in moreswitches() */
2171 forbid_setid('I', FALSE);
2172 if (!*++s && (s=argv[1]) != NULL) {
2176 STRLEN len = strlen(s);
2177 incpush(s, len, INCPUSH_ADD_SUB_DIRS|INCPUSH_ADD_OLD_VERS);
2180 Perl_croak(aTHX_ "No directory specified for -I");
2183 forbid_setid('S', FALSE);
2192 opts_prog = newSVpvs("use Config; Config::_V()");
2196 opts_prog = Perl_newSVpvf(aTHX_
2197 "use Config; Config::config_vars(qw%c%s%c)",
2201 Perl_av_create_and_push(aTHX_ &PL_preambleav, opts_prog);
2202 /* don't look for script or read stdin */
2203 scriptname = BIT_BUCKET;
2215 if (!*++s || isSPACE(*s)) {
2219 /* catch use of gnu style long options.
2220 Both of these exit immediately. */
2221 if (strEQ(s, "version"))
2223 if (strEQ(s, "help"))
2228 Perl_croak(aTHX_ "Unrecognized switch: -%s (-h will show valid options)",s);
2239 #ifndef SECURE_INTERNAL_GETENV
2242 (s = PerlEnv_getenv("PERL5OPT")))
2244 /* s points to static memory in getenv(), which may be overwritten at
2245 * any time; use a mortal copy instead */
2246 s = SvPVX(sv_2mortal(newSVpv(s, 0)));
2250 if (*s == '-' && *(s+1) == 'T') {
2251 #if defined(SILENT_NO_TAINT_SUPPORT)
2252 /* silently ignore */
2253 #elif defined(NO_TAINT_SUPPORT)
2254 Perl_croak_nocontext("This perl was compiled without taint support. "
2255 "Cowardly refusing to run with -t or -T flags");
2257 CHECK_MALLOC_TOO_LATE_FOR('T');
2259 TAINT_WARN_set(FALSE);
2263 char *popt_copy = NULL;
2276 if (!strchr("CDIMUdmtwW", *s))
2277 Perl_croak(aTHX_ "Illegal switch in PERL5OPT: -%c", *s);
2281 popt_copy = SvPVX(sv_2mortal(newSVpv(d,0)));
2282 s = popt_copy + (s - d);
2290 #if defined(SILENT_NO_TAINT_SUPPORT)
2291 /* silently ignore */
2292 #elif defined(NO_TAINT_SUPPORT)
2293 Perl_croak_nocontext("This perl was compiled without taint support. "
2294 "Cowardly refusing to run with -t or -T flags");
2296 if( !TAINTING_get) {
2297 TAINT_WARN_set(TRUE);
2309 #ifndef NO_PERL_INTERNAL_RAND_SEED
2310 /* If we're not set[ug]id, we might have honored
2311 PERL_INTERNAL_RAND_SEED in perl_construct().
2312 At this point command-line options have been parsed, so if
2313 we're now tainting and not set[ug]id re-seed.
2314 This could possibly be wasteful if PERL_INTERNAL_RAND_SEED is invalid,
2315 but avoids duplicating the logic from perl_construct().
2318 PerlProc_getuid() == PerlProc_geteuid() &&
2319 PerlProc_getgid() == PerlProc_getegid()) {
2320 Perl_drand48_init_r(&PL_internal_random_state, seed());
2324 /* Set $^X early so that it can be used for relocatable paths in @INC */
2325 /* and for SITELIB_EXP in USE_SITECUSTOMIZE */
2326 assert (!TAINT_get);
2331 #if defined(USE_SITECUSTOMIZE)
2333 /* The games with local $! are to avoid setting errno if there is no
2334 sitecustomize script. "q%c...%c", 0, ..., 0 becomes "q\0...\0",
2335 ie a q() operator with a NUL byte as a the delimiter. This avoids
2336 problems with pathnames containing (say) ' */
2337 # ifdef PERL_IS_MINIPERL
2338 AV *const inc = GvAV(PL_incgv);
2339 SV **const inc0 = inc ? av_fetch(inc, 0, FALSE) : NULL;
2342 /* if lib/buildcustomize.pl exists, it should not fail. If it does,
2343 it should be reported immediately as a build failure. */
2344 (void)Perl_av_create_and_unshift_one(aTHX_ &PL_preambleav,
2346 "BEGIN { my $f = q%c%s%" SVf "/buildcustomize.pl%c; "
2347 "do {local $!; -f $f }"
2348 " and do $f || die $@ || qq '$f: $!' }",
2349 0, (TAINTING_get ? "./" : ""), SVfARG(*inc0), 0));
2352 /* SITELIB_EXP is a function call on Win32. */
2353 const char *const raw_sitelib = SITELIB_EXP;
2355 /* process .../.. if PERL_RELOCATABLE_INC is defined */
2356 SV *sitelib_sv = mayberelocate(raw_sitelib, strlen(raw_sitelib),
2357 INCPUSH_CAN_RELOCATE);
2358 const char *const sitelib = SvPVX(sitelib_sv);
2359 (void)Perl_av_create_and_unshift_one(aTHX_ &PL_preambleav,
2361 "BEGIN { do {local $!; -f q%c%s/sitecustomize.pl%c} && do q%c%s/sitecustomize.pl%c }",
2362 0, SVfARG(sitelib), 0,
2363 0, SVfARG(sitelib), 0));
2364 assert (SvREFCNT(sitelib_sv) == 1);
2365 SvREFCNT_dec(sitelib_sv);
2372 scriptname = argv[0];
2375 scriptname = BIT_BUCKET; /* don't look for script or read stdin */
2377 else if (scriptname == NULL) {
2379 if ( PerlLIO_isatty(PerlIO_fileno(PerlIO_stdin())) )
2385 assert (!TAINT_get);
2389 bool suidscript = FALSE;
2391 rsfp = open_script(scriptname, dosearch, &suidscript);
2393 rsfp = PerlIO_stdin();
2394 lex_start_flags = LEX_DONT_CLOSE_RSFP;
2397 validate_suid(rsfp);
2400 # if defined(SIGCHLD) || defined(SIGCLD)
2403 # define SIGCHLD SIGCLD
2405 Sighandler_t sigstate = rsignal_state(SIGCHLD);
2406 if (sigstate == (Sighandler_t) SIG_IGN) {
2407 Perl_ck_warner(aTHX_ packWARN(WARN_SIGNAL),
2408 "Can't ignore signal CHLD, forcing to default");
2409 (void)rsignal(SIGCHLD, (Sighandler_t)SIG_DFL);
2417 /* This will croak if suidscript is true, as -x cannot be used with
2419 forbid_setid('x', suidscript);
2420 /* Hence you can't get here if suidscript is true */
2422 linestr_sv = newSV_type(SVt_PV);
2423 lex_start_flags |= LEX_START_COPIED;
2424 find_beginning(linestr_sv, rsfp);
2425 if (cddir && PerlDir_chdir( (char *)cddir ) < 0)
2426 Perl_croak(aTHX_ "Can't chdir to %s",cddir);
2430 PL_main_cv = PL_compcv = MUTABLE_CV(newSV_type(SVt_PVCV));
2431 CvUNIQUE_on(PL_compcv);
2433 CvPADLIST_set(PL_compcv, pad_new(0));
2435 PL_isarev = newHV();
2438 boot_core_UNIVERSAL();
2440 newXS("Internals::V", S_Internals_V, __FILE__);
2443 (*xsinit)(aTHX); /* in case linked C routines want magical variables */
2445 #if defined(VMS) || defined(WIN32) || defined(DJGPP) || defined(__CYGWIN__) || defined(SYMBIAN)
2451 # ifdef HAS_SOCKS5_INIT
2452 socks5_init(argv[0]);
2458 init_predump_symbols();
2459 /* init_postdump_symbols not currently designed to be called */
2460 /* more than once (ENV isn't cleared first, for example) */
2461 /* But running with -u leaves %ENV & @ARGV undefined! XXX */
2463 init_postdump_symbols(argc,argv,env);
2465 /* PL_unicode is turned on by -C, or by $ENV{PERL_UNICODE},
2466 * or explicitly in some platforms.
2467 * PL_utf8locale is conditionally turned on by
2468 * locale.c:Perl_init_i18nl10n() if the environment
2469 * look like the user wants to use UTF-8. */
2470 #if defined(__SYMBIAN32__)
2471 PL_unicode = PERL_UNICODE_STD_FLAG; /* See PERL_SYMBIAN_CONSOLE_UTF8. */
2473 # ifndef PERL_IS_MINIPERL
2475 /* Requires init_predump_symbols(). */
2476 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
2481 /* Turn on UTF-8-ness on STDIN, STDOUT, STDERR
2482 * and the default open disciplines. */
2483 if ((PL_unicode & PERL_UNICODE_STDIN_FLAG) &&
2484 PL_stdingv && (io = GvIO(PL_stdingv)) &&
2486 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2487 if ((PL_unicode & PERL_UNICODE_STDOUT_FLAG) &&
2488 PL_defoutgv && (io = GvIO(PL_defoutgv)) &&
2490 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2491 if ((PL_unicode & PERL_UNICODE_STDERR_FLAG) &&
2492 PL_stderrgv && (io = GvIO(PL_stderrgv)) &&
2494 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2495 if ((PL_unicode & PERL_UNICODE_INOUT_FLAG) &&
2496 (sv = GvSV(gv_fetchpvs("\017PEN", GV_ADD|GV_NOTQUAL,
2498 U32 in = PL_unicode & PERL_UNICODE_IN_FLAG;
2499 U32 out = PL_unicode & PERL_UNICODE_OUT_FLAG;
2502 sv_setpvs(sv, ":utf8\0:utf8");
2504 sv_setpvs(sv, ":utf8\0");
2507 sv_setpvs(sv, "\0:utf8");
2516 if ((s = PerlEnv_getenv("PERL_SIGNALS"))) {
2517 if (strEQ(s, "unsafe"))
2518 PL_signals |= PERL_SIGNALS_UNSAFE_FLAG;
2519 else if (strEQ(s, "safe"))
2520 PL_signals &= ~PERL_SIGNALS_UNSAFE_FLAG;
2522 Perl_croak(aTHX_ "PERL_SIGNALS illegal: \"%s\"", s);
2527 lex_start(linestr_sv, rsfp, lex_start_flags);
2528 SvREFCNT_dec(linestr_sv);
2530 PL_subname = newSVpvs("main");
2532 if (add_read_e_script)
2533 filter_add(read_e_script, NULL);
2535 /* now parse the script */
2537 SETERRNO(0,SS_NORMAL);
2538 if (yyparse(GRAMPROG) || PL_parser->error_count) {
2539 abort_execution("", PL_origfilename);
2541 CopLINE_set(PL_curcop, 0);
2542 SET_CURSTASH(PL_defstash);
2544 SvREFCNT_dec(PL_e_script);
2552 SAVECOPFILE(PL_curcop);
2553 SAVECOPLINE(PL_curcop);
2554 gv_check(PL_defstash);
2564 s = PerlEnv_getenv("PERL_DEBUG_MSTATS");
2565 if (s && grok_atoUV(s, &uv, NULL) && uv >= 2)
2566 dump_mstats("after compilation:");
2571 PL_restartjmpenv = NULL;
2577 =for apidoc Am|int|perl_run|PerlInterpreter *my_perl
2579 Tells a Perl interpreter to run its main program. See L<perlembed>
2582 C<my_perl> points to the Perl interpreter. It must have been previously
2583 created through the use of L</perl_alloc> and L</perl_construct>, and
2584 initialised through L</perl_parse>. This function should not be called
2585 if L</perl_parse> returned a non-zero value, indicating a failure in
2586 initialisation or compilation.
2588 This function executes code in C<INIT> blocks, and then executes the
2589 main program. The code to be executed is that established by the prior
2590 call to L</perl_parse>. If the interpreter's C<PL_exit_flags> word
2591 does not have the C<PERL_EXIT_DESTRUCT_END> flag set, then this function
2592 will also execute code in C<END> blocks. If it is desired to make any
2593 further use of the interpreter after calling this function, then C<END>
2594 blocks should be postponed to L</perl_destruct> time by setting that flag.
2596 Returns an integer of slightly tricky interpretation. The correct use
2597 of the return value is as a truth value indicating whether the program
2598 terminated non-locally. If zero is returned, this indicates that
2599 the program ran to completion, and it is safe to make other use of the
2600 interpreter (provided that the C<PERL_EXIT_DESTRUCT_END> flag was set as
2601 described above). If a non-zero value is returned, this indicates that
2602 the interpreter wants to terminate early. The interpreter should not be
2603 just abandoned because of this desire to terminate; the caller should
2604 proceed to shut the interpreter down cleanly with L</perl_destruct>
2605 and free it with L</perl_free>.
2607 For historical reasons, the non-zero return value also attempts to
2608 be a suitable value to pass to the C library function C<exit> (or to
2609 return from C<main>), to serve as an exit code indicating the nature of
2610 the way the program terminated. However, this isn't portable, due to
2611 differing exit code conventions. An attempt is made to return an exit
2612 code of the type required by the host operating system, but because
2613 it is constrained to be non-zero, it is not necessarily possible to
2614 indicate every type of exit. It is only reliable on Unix, where a zero
2615 exit code can be augmented with a set bit that will be ignored. In any
2616 case, this function is not the correct place to acquire an exit code:
2617 one should get that from L</perl_destruct>.
2626 int ret = 0, exit_called = 0;
2629 PERL_ARGS_ASSERT_PERL_RUN;
2630 #ifndef MULTIPLICITY
2631 PERL_UNUSED_ARG(my_perl);
2634 oldscope = PL_scopestack_ix;
2642 cxstack_ix = -1; /* start context stack again */
2644 case 0: /* normal completion */
2648 case 2: /* my_exit() */
2651 while (PL_scopestack_ix > oldscope)
2654 SET_CURSTASH(PL_defstash);
2655 if (!(PL_exit_flags & PERL_EXIT_DESTRUCT_END) &&
2656 PL_endav && !PL_minus_c) {
2657 PERL_SET_PHASE(PERL_PHASE_END);
2658 call_list(oldscope, PL_endav);
2661 if (PerlEnv_getenv("PERL_DEBUG_MSTATS"))
2662 dump_mstats("after execution: ");
2666 if (ret == 0) ret = 0x100;
2673 POPSTACK_TO(PL_mainstack);
2676 PerlIO_printf(Perl_error_log, "panic: restartop in perl_run\n");
2687 S_run_body(pTHX_ I32 oldscope)
2689 DEBUG_r(PerlIO_printf(Perl_debug_log, "%s $` $& $' support (0x%x).\n",
2690 PL_sawampersand ? "Enabling" : "Omitting",
2691 (unsigned int)(PL_sawampersand)));
2693 if (!PL_restartop) {
2695 if (DEBUG_x_TEST || DEBUG_B_TEST)
2696 dump_all_perl(!DEBUG_B_TEST);
2698 PERL_DEBUG(PerlIO_printf(Perl_debug_log, "\nEXECUTING...\n\n"));
2702 PerlIO_printf(Perl_error_log, "%s syntax OK\n", PL_origfilename);
2705 if (PERLDB_SINGLE && PL_DBsingle)
2708 PERL_SET_PHASE(PERL_PHASE_INIT);
2709 call_list(oldscope, PL_initav);
2711 #ifdef PERL_DEBUG_READONLY_OPS
2712 if (PL_main_root && PL_main_root->op_slabbed)
2713 Slab_to_ro(OpSLAB(PL_main_root));
2719 PERL_SET_PHASE(PERL_PHASE_RUN);
2722 PL_restartjmpenv = NULL;
2723 PL_op = PL_restartop;
2727 else if (PL_main_start) {
2728 CvDEPTH(PL_main_cv) = 1;
2729 PL_op = PL_main_start;
2733 NOT_REACHED; /* NOTREACHED */
2737 =head1 SV Manipulation Functions
2739 =for apidoc p||get_sv
2741 Returns the SV of the specified Perl scalar. C<flags> are passed to
2742 C<gv_fetchpv>. If C<GV_ADD> is set and the
2743 Perl variable does not exist then it will be created. If C<flags> is zero
2744 and the variable does not exist then NULL is returned.
2750 Perl_get_sv(pTHX_ const char *name, I32 flags)
2754 PERL_ARGS_ASSERT_GET_SV;
2756 gv = gv_fetchpv(name, flags, SVt_PV);
2763 =head1 Array Manipulation Functions
2765 =for apidoc p||get_av
2767 Returns the AV of the specified Perl global or package array with the given
2768 name (so it won't work on lexical variables). C<flags> are passed
2769 to C<gv_fetchpv>. If C<GV_ADD> is set and the
2770 Perl variable does not exist then it will be created. If C<flags> is zero
2771 and the variable does not exist then NULL is returned.
2773 Perl equivalent: C<@{"$name"}>.
2779 Perl_get_av(pTHX_ const char *name, I32 flags)
2781 GV* const gv = gv_fetchpv(name, flags, SVt_PVAV);
2783 PERL_ARGS_ASSERT_GET_AV;
2793 =head1 Hash Manipulation Functions
2795 =for apidoc p||get_hv
2797 Returns the HV of the specified Perl hash. C<flags> are passed to
2798 C<gv_fetchpv>. If C<GV_ADD> is set and the
2799 Perl variable does not exist then it will be created. If C<flags> is zero
2800 and the variable does not exist then C<NULL> is returned.
2806 Perl_get_hv(pTHX_ const char *name, I32 flags)
2808 GV* const gv = gv_fetchpv(name, flags, SVt_PVHV);
2810 PERL_ARGS_ASSERT_GET_HV;
2820 =head1 CV Manipulation Functions
2822 =for apidoc p||get_cvn_flags
2824 Returns the CV of the specified Perl subroutine. C<flags> are passed to
2825 C<gv_fetchpvn_flags>. If C<GV_ADD> is set and the Perl subroutine does not
2826 exist then it will be declared (which has the same effect as saying
2827 C<sub name;>). If C<GV_ADD> is not set and the subroutine does not exist
2828 then NULL is returned.
2830 =for apidoc p||get_cv
2832 Uses C<strlen> to get the length of C<name>, then calls C<get_cvn_flags>.
2838 Perl_get_cvn_flags(pTHX_ const char *name, STRLEN len, I32 flags)
2840 GV* const gv = gv_fetchpvn_flags(name, len, flags, SVt_PVCV);
2842 PERL_ARGS_ASSERT_GET_CVN_FLAGS;
2844 if (gv && UNLIKELY(SvROK(gv)) && SvTYPE(SvRV((SV *)gv)) == SVt_PVCV)
2845 return (CV*)SvRV((SV *)gv);
2847 /* XXX this is probably not what they think they're getting.
2848 * It has the same effect as "sub name;", i.e. just a forward
2850 if ((flags & ~GV_NOADD_MASK) && !GvCVu(gv)) {
2851 return newSTUB(gv,0);
2858 /* Nothing in core calls this now, but we can't replace it with a macro and
2859 move it to mathoms.c as a macro would evaluate name twice. */
2861 Perl_get_cv(pTHX_ const char *name, I32 flags)
2863 PERL_ARGS_ASSERT_GET_CV;
2865 return get_cvn_flags(name, strlen(name), flags);
2868 /* Be sure to refetch the stack pointer after calling these routines. */
2872 =head1 Callback Functions
2874 =for apidoc p||call_argv
2876 Performs a callback to the specified named and package-scoped Perl subroutine
2877 with C<argv> (a C<NULL>-terminated array of strings) as arguments. See
2880 Approximate Perl equivalent: C<&{"$sub_name"}(@$argv)>.
2886 Perl_call_argv(pTHX_ const char *sub_name, I32 flags, char **argv)
2888 /* See G_* flags in cop.h */
2889 /* null terminated arg list */
2893 PERL_ARGS_ASSERT_CALL_ARGV;
2897 mXPUSHs(newSVpv(*argv,0));
2901 return call_pv(sub_name, flags);
2905 =for apidoc p||call_pv
2907 Performs a callback to the specified Perl sub. See L<perlcall>.
2913 Perl_call_pv(pTHX_ const char *sub_name, I32 flags)
2914 /* name of the subroutine */
2915 /* See G_* flags in cop.h */
2917 PERL_ARGS_ASSERT_CALL_PV;
2919 return call_sv(MUTABLE_SV(get_cv(sub_name, GV_ADD)), flags);
2923 =for apidoc p||call_method
2925 Performs a callback to the specified Perl method. The blessed object must
2926 be on the stack. See L<perlcall>.
2932 Perl_call_method(pTHX_ const char *methname, I32 flags)
2933 /* name of the subroutine */
2934 /* See G_* flags in cop.h */
2938 PERL_ARGS_ASSERT_CALL_METHOD;
2940 len = strlen(methname);
2941 sv = flags & G_METHOD_NAMED
2942 ? sv_2mortal(newSVpvn_share(methname, len,0))
2943 : newSVpvn_flags(methname, len, SVs_TEMP);
2945 return call_sv(sv, flags | G_METHOD);
2948 /* May be called with any of a CV, a GV, or an SV containing the name. */
2950 =for apidoc p||call_sv
2952 Performs a callback to the Perl sub specified by the SV.
2954 If neither the C<G_METHOD> nor C<G_METHOD_NAMED> flag is supplied, the
2955 SV may be any of a CV, a GV, a reference to a CV, a reference to a GV
2956 or C<SvPV(sv)> will be used as the name of the sub to call.
2958 If the C<G_METHOD> flag is supplied, the SV may be a reference to a CV or
2959 C<SvPV(sv)> will be used as the name of the method to call.
2961 If the C<G_METHOD_NAMED> flag is supplied, C<SvPV(sv)> will be used as
2962 the name of the method to call.
2964 Some other values are treated specially for internal use and should
2973 Perl_call_sv(pTHX_ SV *sv, volatile I32 flags)
2974 /* See G_* flags in cop.h */
2977 LOGOP myop; /* fake syntax tree node */
2980 volatile I32 retval = 0;
2981 bool oldcatch = CATCH_GET;
2983 OP* const oldop = PL_op;
2986 PERL_ARGS_ASSERT_CALL_SV;
2988 if (flags & G_DISCARD) {
2992 if (!(flags & G_WANT)) {
2993 /* Backwards compatibility - as G_SCALAR was 0, it could be omitted.
2998 Zero(&myop, 1, LOGOP);
2999 if (!(flags & G_NOARGS))
3000 myop.op_flags |= OPf_STACKED;
3001 myop.op_flags |= OP_GIMME_REVERSE(flags);
3005 if (!(flags & G_METHOD_NAMED)) {
3013 if (PERLDB_SUB && PL_curstash != PL_debstash
3014 /* Handle first BEGIN of -d. */
3015 && (PL_DBcv || (PL_DBcv = GvCV(PL_DBsub)))
3016 /* Try harder, since this may have been a sighandler, thus
3017 * curstash may be meaningless. */
3018 && (SvTYPE(sv) != SVt_PVCV || CvSTASH((const CV *)sv) != PL_debstash)
3019 && !(flags & G_NODEBUG))
3020 myop.op_private |= OPpENTERSUB_DB;
3022 if (flags & (G_METHOD|G_METHOD_NAMED)) {
3023 Zero(&method_op, 1, METHOP);
3024 method_op.op_next = (OP*)&myop;
3025 PL_op = (OP*)&method_op;
3026 if ( flags & G_METHOD_NAMED ) {
3027 method_op.op_ppaddr = PL_ppaddr[OP_METHOD_NAMED];
3028 method_op.op_type = OP_METHOD_NAMED;
3029 method_op.op_u.op_meth_sv = sv;
3031 method_op.op_ppaddr = PL_ppaddr[OP_METHOD];
3032 method_op.op_type = OP_METHOD;
3034 myop.op_ppaddr = PL_ppaddr[OP_ENTERSUB];
3035 myop.op_type = OP_ENTERSUB;
3038 if (!(flags & G_EVAL)) {
3040 CALL_BODY_SUB((OP*)&myop);
3041 retval = PL_stack_sp - (PL_stack_base + oldmark);
3042 CATCH_SET(oldcatch);
3046 myop.op_other = (OP*)&myop;
3048 old_cxix = cxstack_ix;
3049 create_eval_scope(NULL, flags|G_FAKINGEVAL);
3057 CALL_BODY_SUB((OP*)&myop);
3058 retval = PL_stack_sp - (PL_stack_base + oldmark);
3059 if (!(flags & G_KEEPERR)) {
3067 /* my_exit() was called */
3068 SET_CURSTASH(PL_defstash);
3072 NOT_REACHED; /* NOTREACHED */
3075 PL_restartjmpenv = NULL;
3076 PL_op = PL_restartop;
3080 PL_stack_sp = PL_stack_base + oldmark;
3081 if ((flags & G_WANT) == G_ARRAY)
3085 *++PL_stack_sp = &PL_sv_undef;
3090 /* if we croaked, depending on how we croaked the eval scope
3091 * may or may not have already been popped */
3092 if (cxstack_ix > old_cxix) {
3093 assert(cxstack_ix == old_cxix + 1);
3094 assert(CxTYPE(CX_CUR()) == CXt_EVAL);
3095 delete_eval_scope();
3100 if (flags & G_DISCARD) {
3101 PL_stack_sp = PL_stack_base + oldmark;
3110 /* Eval a string. The G_EVAL flag is always assumed. */
3113 =for apidoc p||eval_sv
3115 Tells Perl to C<eval> the string in the SV. It supports the same flags
3116 as C<call_sv>, with the obvious exception of C<G_EVAL>. See L<perlcall>.
3122 Perl_eval_sv(pTHX_ SV *sv, I32 flags)
3124 /* See G_* flags in cop.h */
3127 UNOP myop; /* fake syntax tree node */
3128 volatile I32 oldmark;
3129 volatile I32 retval = 0;
3131 OP* const oldop = PL_op;
3134 PERL_ARGS_ASSERT_EVAL_SV;
3136 if (flags & G_DISCARD) {
3143 Zero(&myop, 1, UNOP);
3146 oldmark = SP - PL_stack_base;
3152 if (!(flags & G_NOARGS))
3153 myop.op_flags = OPf_STACKED;
3154 myop.op_type = OP_ENTEREVAL;
3155 myop.op_flags |= OP_GIMME_REVERSE(flags);
3156 if (flags & G_KEEPERR)
3157 myop.op_flags |= OPf_SPECIAL;
3159 if (flags & G_RE_REPARSING)
3160 myop.op_private = (OPpEVAL_COPHH | OPpEVAL_RE_REPARSING);
3162 /* fail now; otherwise we could fail after the JMPENV_PUSH but
3163 * before a cx_pusheval(), which corrupts the stack after a croak */
3164 TAINT_PROPER("eval_sv()");
3170 if (PL_op == (OP*)(&myop)) {
3171 PL_op = PL_ppaddr[OP_ENTEREVAL](aTHX);
3173 goto fail; /* failed in compilation */
3176 retval = PL_stack_sp - (PL_stack_base + oldmark);
3177 if (!(flags & G_KEEPERR)) {
3185 /* my_exit() was called */
3186 SET_CURSTASH(PL_defstash);
3190 NOT_REACHED; /* NOTREACHED */
3193 PL_restartjmpenv = NULL;
3194 PL_op = PL_restartop;
3199 PL_stack_sp = PL_stack_base + oldmark;
3200 if ((flags & G_WANT) == G_ARRAY)
3204 *++PL_stack_sp = &PL_sv_undef;
3210 if (flags & G_DISCARD) {
3211 PL_stack_sp = PL_stack_base + oldmark;
3221 =for apidoc p||eval_pv
3223 Tells Perl to C<eval> the given string in scalar context and return an SV* result.
3229 Perl_eval_pv(pTHX_ const char *p, I32 croak_on_error)
3231 SV* sv = newSVpv(p, 0);
3233 PERL_ARGS_ASSERT_EVAL_PV;
3235 eval_sv(sv, G_SCALAR);
3244 /* just check empty string or undef? */
3245 if (croak_on_error) {
3246 SV * const errsv = ERRSV;
3247 if(SvTRUE_NN(errsv))
3248 /* replace with croak_sv? */
3249 Perl_croak_nocontext("%s", SvPV_nolen_const(errsv));
3255 /* Require a module. */
3258 =head1 Embedding Functions
3260 =for apidoc p||require_pv
3262 Tells Perl to C<require> the file named by the string argument. It is
3263 analogous to the Perl code C<eval "require '$file'">. It's even
3264 implemented that way; consider using load_module instead.
3269 Perl_require_pv(pTHX_ const char *pv)
3274 PERL_ARGS_ASSERT_REQUIRE_PV;
3276 PUSHSTACKi(PERLSI_REQUIRE);
3277 sv = Perl_newSVpvf(aTHX_ "require q%c%s%c", 0, pv, 0);
3278 eval_sv(sv_2mortal(sv), G_DISCARD);
3283 S_usage(pTHX) /* XXX move this out into a module ? */
3285 /* This message really ought to be max 23 lines.
3286 * Removed -h because the user already knows that option. Others? */
3288 /* Grouped as 6 lines per C string literal, to keep under the ANSI C 89
3289 minimum of 509 character string literals. */
3290 static const char * const usage_msg[] = {
3291 " -0[octal] specify record separator (\\0, if no argument)\n"
3292 " -a autosplit mode with -n or -p (splits $_ into @F)\n"
3293 " -C[number/list] enables the listed Unicode features\n"
3294 " -c check syntax only (runs BEGIN and CHECK blocks)\n"
3295 " -d[:debugger] run program under debugger\n"
3296 " -D[number/list] set debugging flags (argument is a bit mask or alphabets)\n",
3297 " -e program one line of program (several -e's allowed, omit programfile)\n"
3298 " -E program like -e, but enables all optional features\n"
3299 " -f don't do $sitelib/sitecustomize.pl at startup\n"
3300 " -F/pattern/ split() pattern for -a switch (//'s are optional)\n"
3301 " -i[extension] edit <> files in place (makes backup if extension supplied)\n"
3302 " -Idirectory specify @INC/#include directory (several -I's allowed)\n",
3303 " -l[octal] enable line ending processing, specifies line terminator\n"
3304 " -[mM][-]module execute \"use/no module...\" before executing program\n"
3305 " -n assume \"while (<>) { ... }\" loop around program\n"
3306 " -p assume loop like -n but print line also, like sed\n"
3307 " -s enable rudimentary parsing for switches after programfile\n"
3308 " -S look for programfile using PATH environment variable\n",
3309 " -t enable tainting warnings\n"
3310 " -T enable tainting checks\n"
3311 " -u dump core after parsing program\n"
3312 " -U allow unsafe operations\n"
3313 " -v print version, patchlevel and license\n"
3314 " -V[:variable] print configuration summary (or a single Config.pm variable)\n",
3315 " -w enable many useful warnings\n"
3316 " -W enable all warnings\n"
3317 " -x[directory] ignore text before #!perl line (optionally cd to directory)\n"
3318 " -X disable all warnings\n"
3320 "Run 'perldoc perl' for more help with Perl.\n\n",
3323 const char * const *p = usage_msg;
3324 PerlIO *out = PerlIO_stdout();
3327 "\nUsage: %s [switches] [--] [programfile] [arguments]\n",
3330 PerlIO_puts(out, *p++);
3334 /* convert a string of -D options (or digits) into an int.
3335 * sets *s to point to the char after the options */
3339 Perl_get_debug_opts(pTHX_ const char **s, bool givehelp)
3341 static const char * const usage_msgd[] = {
3342 " Debugging flag values: (see also -d)\n"
3343 " p Tokenizing and parsing (with v, displays parse stack)\n"
3344 " s Stack snapshots (with v, displays all stacks)\n"
3345 " l Context (loop) stack processing\n"
3346 " t Trace execution\n"
3347 " o Method and overloading resolution\n",
3348 " c String/numeric conversions\n"
3349 " P Print profiling info, source file input state\n"
3350 " m Memory and SV allocation\n"
3351 " f Format processing\n"
3352 " r Regular expression parsing and execution\n"
3353 " x Syntax tree dump\n",
3354 " u Tainting checks\n"
3355 " H Hash dump -- usurps values()\n"
3356 " X Scratchpad allocation\n"
3358 " S Op slab allocation\n"
3360 " R Include reference counts of dumped variables (eg when using -Ds)\n",
3361 " J Do not s,t,P-debug (Jump over) opcodes within package DB\n"
3362 " v Verbose: use in conjunction with other flags\n"
3363 " C Copy On Write\n"
3364 " A Consistency checks on internal structures\n"
3365 " q quiet - currently only suppresses the 'EXECUTING' message\n"
3366 " M trace smart match resolution\n"
3367 " B dump suBroutine definitions, including special Blocks like BEGIN\n",
3368 " L trace some locale setting information--for Perl core development\n",
3369 " i trace PerlIO layer processing\n",
3374 PERL_ARGS_ASSERT_GET_DEBUG_OPTS;
3377 /* if adding extra options, remember to update DEBUG_MASK */
3378 static const char debopts[] = "psltocPmfrxuUHXDSTRJvCAqMBLi";
3380 for (; isWORDCHAR(**s); (*s)++) {
3381 const char * const d = strchr(debopts,**s);
3383 uv |= 1 << (d - debopts);
3384 else if (ckWARN_d(WARN_DEBUGGING))
3385 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3386 "invalid option -D%c, use -D'' to see choices\n", **s);
3389 else if (isDIGIT(**s)) {
3391 if (grok_atoUV(*s, &uv, &e))
3393 for (; isWORDCHAR(**s); (*s)++) ;
3395 else if (givehelp) {
3396 const char *const *p = usage_msgd;
3397 while (*p) PerlIO_puts(PerlIO_stdout(), *p++);
3399 return (int)uv; /* ignore any UV->int conversion loss */
3403 /* This routine handles any switches that can be given during run */
3406 Perl_moreswitches(pTHX_ const char *s)
3410 const char option = *s; /* used to remember option in -m/-M code */
3412 PERL_ARGS_ASSERT_MORESWITCHES;
3420 SvREFCNT_dec(PL_rs);
3421 if (s[1] == 'x' && s[2]) {
3422 const char *e = s+=2;
3428 flags = PERL_SCAN_SILENT_ILLDIGIT;
3429 rschar = (U32)grok_hex(s, &numlen, &flags, NULL);
3430 if (s + numlen < e) {
3431 rschar = 0; /* Grandfather -0xFOO as -0 -xFOO. */
3435 PL_rs = newSVpvs("");
3436 tmps = (U8*) SvGROW(PL_rs, (STRLEN)(UVCHR_SKIP(rschar) + 1));
3437 uvchr_to_utf8(tmps, rschar);
3438 SvCUR_set(PL_rs, UVCHR_SKIP(rschar));
3443 rschar = (U32)grok_oct(s, &numlen, &flags, NULL);
3444 if (rschar & ~((U8)~0))
3445 PL_rs = &PL_sv_undef;
3446 else if (!rschar && numlen >= 2)
3447 PL_rs = newSVpvs("");
3449 char ch = (char)rschar;
3450 PL_rs = newSVpvn(&ch, 1);
3453 sv_setsv(get_sv("/", GV_ADD), PL_rs);
3458 PL_unicode = parse_unicode_opts( (const char **)&s );
3459 if (PL_unicode & PERL_UNICODE_UTF8CACHEASSERT_FLAG)
3467 while (*s && !isSPACE(*s)) ++s;
3468 PL_splitstr = savepvn(PL_splitstr, s - PL_splitstr);
3480 forbid_setid('d', FALSE);
3483 /* -dt indicates to the debugger that threads will be used */
3484 if (*s == 't' && !isWORDCHAR(s[1])) {
3486 my_setenv("PERL5DB_THREADED", "1");
3489 /* The following permits -d:Mod to accepts arguments following an =
3490 in the fashion that -MSome::Mod does. */
3491 if (*s == ':' || *s == '=') {
3498 sv = newSVpvs("no Devel::");
3500 sv = newSVpvs("use Devel::");
3504 end = s + strlen(s);
3506 /* We now allow -d:Module=Foo,Bar and -d:-Module */
3507 while(isWORDCHAR(*s) || *s==':') ++s;
3509 sv_catpvn(sv, start, end - start);
3511 sv_catpvn(sv, start, s-start);
3512 /* Don't use NUL as q// delimiter here, this string goes in the
3514 Perl_sv_catpvf(aTHX_ sv, " split(/,/,q{%s});", ++s);
3517 my_setenv("PERL5DB", SvPV_nolen_const(sv));
3521 PL_perldb = PERLDB_ALL;
3528 forbid_setid('D', FALSE);
3530 PL_debug = get_debug_opts( (const char **)&s, 1) | DEBUG_TOP_FLAG;
3531 #else /* !DEBUGGING */
3532 if (ckWARN_d(WARN_DEBUGGING))
3533 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3534 "Recompile perl with -DDEBUGGING to use -D switch (did you mean -d ?)\n");
3535 for (s++; isWORDCHAR(*s); s++) ;
3538 NOT_REACHED; /* NOTREACHED */
3542 NOT_REACHED; /* NOTREACHED */
3545 Safefree(PL_inplace);
3547 const char * const start = ++s;
3548 while (*s && !isSPACE(*s))
3551 PL_inplace = savepvn(start, s - start);
3554 case 'I': /* -I handled both here and in parse_body() */
3555 forbid_setid('I', FALSE);
3557 while (*s && isSPACE(*s))
3562 /* ignore trailing spaces (possibly followed by other switches) */
3564 for (e = p; *e && !isSPACE(*e); e++) ;
3568 } while (*p && *p != '-');
3570 INCPUSH_ADD_SUB_DIRS|INCPUSH_ADD_OLD_VERS|INCPUSH_UNSHIFT);
3576 Perl_croak(aTHX_ "No directory specified for -I");
3582 SvREFCNT_dec(PL_ors_sv);
3588 PL_ors_sv = newSVpvs("\n");
3589 numlen = 3 + (*s == '0');
3590 *SvPVX(PL_ors_sv) = (char)grok_oct(s, &numlen, &flags, NULL);
3594 if (RsPARA(PL_rs)) {
3595 PL_ors_sv = newSVpvs("\n\n");
3598 PL_ors_sv = newSVsv(PL_rs);
3603 forbid_setid('M', FALSE); /* XXX ? */
3606 forbid_setid('m', FALSE); /* XXX ? */
3611 const char *use = "use ";
3613 /* -M-foo == 'no foo' */
3614 /* Leading space on " no " is deliberate, to make both
3615 possibilities the same length. */
3616 if (*s == '-') { use = " no "; ++s; }
3617 sv = newSVpvn(use,4);
3619 /* We allow -M'Module qw(Foo Bar)' */
3620 while(isWORDCHAR(*s) || *s==':') {
3629 Perl_croak(aTHX_ "Module name required with -%c option",
3632 Perl_croak(aTHX_ "Invalid module name %.*s with -%c option: "
3633 "contains single ':'",
3634 (int)(s - start), start, option);
3635 end = s + strlen(s);
3637 sv_catpvn(sv, start, end - start);
3638 if (option == 'm') {
3640 Perl_croak(aTHX_ "Can't use '%c' after -mname", *s);
3641 sv_catpvs( sv, " ()");
3644 sv_catpvn(sv, start, s-start);
3645 /* Use NUL as q''-delimiter. */
3646 sv_catpvs(sv, " split(/,/,q\0");
3648 sv_catpvn(sv, s, end - s);
3649 sv_catpvs(sv, "\0)");
3652 Perl_av_create_and_push(aTHX_ &PL_preambleav, sv);
3655 Perl_croak(aTHX_ "Missing argument to -%c", option);
3666 forbid_setid('s', FALSE);
3667 PL_doswitches = TRUE;
3672 #if defined(SILENT_NO_TAINT_SUPPORT)
3673 /* silently ignore */
3674 #elif defined(NO_TAINT_SUPPORT)
3675 Perl_croak_nocontext("This perl was compiled without taint support. "
3676 "Cowardly refusing to run with -t or -T flags");
3684 PL_do_undump = TRUE;
3694 if (! (PL_dowarn & G_WARN_ALL_MASK)) {
3695 PL_dowarn |= G_WARN_ON;
3700 PL_dowarn = G_WARN_ALL_ON|G_WARN_ON;
3701 if (!specialWARN(PL_compiling.cop_warnings))
3702 PerlMemShared_free(PL_compiling.cop_warnings);
3703 PL_compiling.cop_warnings = pWARN_ALL ;
3707 PL_dowarn = G_WARN_ALL_OFF;
3708 if (!specialWARN(PL_compiling.cop_warnings))
3709 PerlMemShared_free(PL_compiling.cop_warnings);
3710 PL_compiling.cop_warnings = pWARN_NONE ;
3717 if (s[0] == '-') /* Additional switches on #! line. */
3722 #if defined(WIN32) || !defined(PERL_STRICT_CR)
3728 #ifdef ALTERNATE_SHEBANG
3729 case 'S': /* OS/2 needs -S on "extproc" line. */
3732 case 'e': case 'f': case 'x': case 'E':
3733 #ifndef ALTERNATE_SHEBANG
3737 Perl_croak(aTHX_ "Can't emulate -%.1s on #! line",s);
3740 "Unrecognized switch: -%.1s (-h will show valid options)",s
3750 PerlIO * PIO_stdout;
3752 const char * const level_str = "v" PERL_VERSION_STRING;
3753 const STRLEN level_len = sizeof("v" PERL_VERSION_STRING)-1;
3754 #ifdef PERL_PATCHNUM
3756 # ifdef PERL_GIT_UNCOMMITTED_CHANGES
3757 static const char num [] = PERL_PATCHNUM "*";
3759 static const char num [] = PERL_PATCHNUM;
3762 const STRLEN num_len = sizeof(num)-1;
3763 /* A very advanced compiler would fold away the strnEQ
3764 and this whole conditional, but most (all?) won't do it.
3765 SV level could also be replaced by with preprocessor
3768 if (num_len >= level_len && strnEQ(num,level_str,level_len)) {
3769 /* per 46807d8e80, PERL_PATCHNUM is outside of the control
3770 of the interp so it might contain format characters
3772 level = newSVpvn(num, num_len);
3774 level = Perl_newSVpvf_nocontext("%s (%s)", level_str, num);
3778 SV* level = newSVpvn(level_str, level_len);
3779 #endif /* #ifdef PERL_PATCHNUM */
3780 PIO_stdout = PerlIO_stdout();
3781 PerlIO_printf(PIO_stdout,
3782 "\nThis is perl " STRINGIFY(PERL_REVISION)
3783 ", version " STRINGIFY(PERL_VERSION)
3784 ", subversion " STRINGIFY(PERL_SUBVERSION)
3785 " (%" SVf ") built for " ARCHNAME, SVfARG(level)
3787 SvREFCNT_dec_NN(level);
3789 #if defined(LOCAL_PATCH_COUNT)
3790 if (LOCAL_PATCH_COUNT > 0)
3791 PerlIO_printf(PIO_stdout,
3792 "\n(with %d registered patch%s, "
3793 "see perl -V for more detail)",
3795 (LOCAL_PATCH_COUNT!=1) ? "es" : "");
3798 PerlIO_printf(PIO_stdout,
3799 "\n\nCopyright 1987-2018, Larry Wall\n");
3801 PerlIO_printf(PIO_stdout,
3802 "\nMS-DOS port Copyright (c) 1989, 1990, Diomidis Spinellis\n");
3805 PerlIO_printf(PIO_stdout,
3806 "djgpp v2 port (jpl5003c) by Hirofumi Watanabe, 1996\n"
3807 "djgpp v2 port (perl5004+) by Laszlo Molnar, 1997-1999\n");
3810 PerlIO_printf(PIO_stdout,
3811 "\n\nOS/2 port Copyright (c) 1990, 1991, Raymond Chen, Kai Uwe Rommel\n"
3812 "Version 5 port Copyright (c) 1994-2002, Andreas Kaiser, Ilya Zakharevich\n");
3815 PerlIO_printf(PIO_stdout,
3816 "MVS (OS390) port by Mortice Kern Systems, 1997-1999\n");
3819 PerlIO_printf(PIO_stdout,
3820 "Stratus OpenVOS port by Paul.Green@stratus.com, 1997-2013\n");
3823 PerlIO_printf(PIO_stdout,
3824 "BS2000 (POSIX) port by Start Amadeus GmbH, 1998-1999\n");
3827 PerlIO_printf(PIO_stdout,
3828 "WINCE port by Rainer Keuchel, 2001-2002\n"
3829 "Built on " __DATE__ " " __TIME__ "\n\n");
3832 #ifdef __SYMBIAN32__
3833 PerlIO_printf(PIO_stdout,
3834 "Symbian port by Nokia, 2004-2005\n");
3836 #ifdef BINARY_BUILD_NOTICE
3837 BINARY_BUILD_NOTICE;
3839 PerlIO_printf(PIO_stdout,
3841 Perl may be copied only under the terms of either the Artistic License or the\n\
3842 GNU General Public License, which may be found in the Perl 5 source kit.\n\n\
3843 Complete documentation for Perl, including FAQ lists, should be found on\n\
3844 this system using \"man perl\" or \"perldoc perl\". If you have access to the\n\
3845 Internet, point your browser at http://www.perl.org/, the Perl Home Page.\n\n");
3849 /* compliments of Tom Christiansen */
3851 /* unexec() can be found in the Gnu emacs distribution */
3852 /* Known to work with -DUNEXEC and using unexelf.c from GNU emacs-20.2 */
3855 #include <lib$routines.h>
3859 Perl_my_unexec(pTHX)
3862 SV * prog = newSVpv(BIN_EXP, 0);
3863 SV * file = newSVpv(PL_origfilename, 0);
3867 sv_catpvs(prog, "/perl");
3868 sv_catpvs(file, ".perldump");
3870 unexec(SvPVX(file), SvPVX(prog), &etext, sbrk(0), 0);
3871 /* unexec prints msg to stderr in case of failure */
3872 PerlProc_exit(status);
3874 PERL_UNUSED_CONTEXT;
3876 lib$signal(SS$_DEBUG); /* ssdef.h #included from vmsish.h */
3877 # elif defined(WIN32) || defined(__CYGWIN__)
3878 Perl_croak_nocontext("dump is not supported");
3880 ABORT(); /* for use with undump */
3885 /* initialize curinterp */
3890 # define PERLVAR(prefix,var,type)
3891 # define PERLVARA(prefix,var,n,type)
3892 # if defined(PERL_IMPLICIT_CONTEXT)
3893 # define PERLVARI(prefix,var,type,init) aTHX->prefix##var = init;
3894 # define PERLVARIC(prefix,var,type,init) aTHX->prefix##var = init;
3896 # define PERLVARI(prefix,var,type,init) PERL_GET_INTERP->var = init;
3897 # define PERLVARIC(prefix,var,type,init) PERL_GET_INTERP->var = init;
3899 # include "intrpvar.h"
3905 # define PERLVAR(prefix,var,type)
3906 # define PERLVARA(prefix,var,n,type)
3907 # define PERLVARI(prefix,var,type,init) PL_##var = init;
3908 # define PERLVARIC(prefix,var,type,init) PL_##var = init;
3909 # include "intrpvar.h"
3919 S_init_main_stash(pTHX)
3924 PL_curstash = PL_defstash = (HV *)SvREFCNT_inc_simple_NN(hv);
3925 /* We know that the string "main" will be in the global shared string
3926 table, so it's a small saving to use it rather than allocate another
3928 PL_curstname = newSVpvs_share("main");
3929 gv = gv_fetchpvs("main::", GV_ADD|GV_NOTQUAL, SVt_PVHV);
3930 /* If we hadn't caused another reference to "main" to be in the shared
3931 string table above, then it would be worth reordering these two,
3932 because otherwise all we do is delete "main" from it as a consequence
3933 of the SvREFCNT_dec, only to add it again with hv_name_set */
3934 SvREFCNT_dec(GvHV(gv));
3935 hv_name_sets(PL_defstash, "main", 0);
3936 GvHV(gv) = MUTABLE_HV(SvREFCNT_inc_simple(PL_defstash));
3938 PL_incgv = gv_HVadd(gv_AVadd(gv_fetchpvs("INC", GV_ADD|GV_NOTQUAL,
3940 SvREFCNT_inc_simple_void(PL_incgv); /* Don't allow it to be freed */
3941 GvMULTI_on(PL_incgv);
3942 PL_hintgv = gv_fetchpvs("\010", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^H */
3943 SvREFCNT_inc_simple_void(PL_hintgv);
3944 GvMULTI_on(PL_hintgv);
3945 PL_defgv = gv_fetchpvs("_", GV_ADD|GV_NOTQUAL, SVt_PVAV);
3946 SvREFCNT_inc_simple_void(PL_defgv);
3947 PL_errgv = gv_fetchpvs("@", GV_ADD|GV_NOTQUAL, SVt_PV);
3948 SvREFCNT_inc_simple_void(PL_errgv);
3949 GvMULTI_on(PL_errgv);
3950 PL_replgv = gv_fetchpvs("\022", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^R */
3951 SvREFCNT_inc_simple_void(PL_replgv);
3952 GvMULTI_on(PL_replgv);
3953 (void)Perl_form(aTHX_ "%240s",""); /* Preallocate temp - for immediate signals. */
3954 #ifdef PERL_DONT_CREATE_GVSV
3955 (void)gv_SVadd(PL_errgv);
3957 sv_grow(ERRSV, 240); /* Preallocate - for immediate signals. */
3959 CopSTASH_set(&PL_compiling, PL_defstash);
3960 PL_debstash = GvHV(gv_fetchpvs("DB::", GV_ADDMULTI, SVt_PVHV));
3961 PL_globalstash = GvHV(gv_fetchpvs("CORE::GLOBAL::", GV_ADDMULTI,
3963 /* We must init $/ before switches are processed. */
3964 sv_setpvs(get_sv("/", GV_ADD), "\n");
3968 S_open_script(pTHX_ const char *scriptname, bool dosearch, bool *suidscript)
3971 PerlIO *rsfp = NULL;
3975 PERL_ARGS_ASSERT_OPEN_SCRIPT;
3978 PL_origfilename = savepvs("-e");
3983 /* if find_script() returns, it returns a malloc()-ed value */
3984 scriptname = PL_origfilename = find_script(scriptname, dosearch, NULL, 1);
3986 if (strBEGINs(scriptname, "/dev/fd/")
3987 && isDIGIT(scriptname[8])
3988 && grok_atoUV(scriptname + 8, &uv, &s)
3989 && uv <= PERL_INT_MAX
3994 * Tell apart "normal" usage of fdscript, e.g.
3995 * with bash on FreeBSD:
3996 * perl <( echo '#!perl -DA'; echo 'print "$0\n"')
3997 * from usage in suidperl.
3998 * Does any "normal" usage leave garbage after the number???
3999 * Is it a mistake to use a similar /dev/fd/ construct for
4004 * Be supersafe and do some sanity-checks.
4005 * Still, can we be sure we got the right thing?
4008 Perl_croak(aTHX_ "Wrong syntax (suid) fd script name \"%s\"\n", s);
4011 Perl_croak(aTHX_ "Missing (suid) fd script name\n");
4013 scriptname = savepv(s + 1);
4014 Safefree(PL_origfilename);
4015 PL_origfilename = (char *)scriptname;
4020 CopFILE_free(PL_curcop);
4021 CopFILE_set(PL_curcop, PL_origfilename);
4022 if (*PL_origfilename == '-' && PL_origfilename[1] == '\0')
4023 scriptname = (char *)"";
4024 if (fdscript >= 0) {
4025 rsfp = PerlIO_fdopen(fdscript,PERL_SCRIPT_MODE);
4027 else if (!*scriptname) {
4028 forbid_setid(0, *suidscript);
4032 #ifdef FAKE_BIT_BUCKET
4033 /* This hack allows one not to have /dev/null (or BIT_BUCKET as it
4034 * is called) and still have the "-e" work. (Believe it or not,
4035 * a /dev/null is required for the "-e" to work because source
4036 * filter magic is used to implement it. ) This is *not* a general
4037 * replacement for a /dev/null. What we do here is create a temp
4038 * file (an empty file), open up that as the script, and then
4039 * immediately close and unlink it. Close enough for jazz. */
4040 #define FAKE_BIT_BUCKET_PREFIX "/tmp/perlnull-"
4041 #define FAKE_BIT_BUCKET_SUFFIX "XXXXXXXX"
4042 #define FAKE_BIT_BUCKET_TEMPLATE FAKE_BIT_BUCKET_PREFIX FAKE_BIT_BUCKET_SUFFIX
4043 char tmpname[sizeof(FAKE_BIT_BUCKET_TEMPLATE)] = {
4044 FAKE_BIT_BUCKET_TEMPLATE
4046 const char * const err = "Failed to create a fake bit bucket";
4047 if (strEQ(scriptname, BIT_BUCKET)) {
4048 int tmpfd = Perl_my_mkstemp_cloexec(tmpname);
4050 scriptname = tmpname;
4053 Perl_croak(aTHX_ err);
4056 rsfp = PerlIO_open(scriptname,PERL_SCRIPT_MODE);
4057 #ifdef FAKE_BIT_BUCKET
4058 if ( strBEGINs(scriptname, FAKE_BIT_BUCKET_PREFIX)
4059 && strlen(scriptname) == sizeof(tmpname) - 1)
4063 scriptname = BIT_BUCKET;
4067 /* PSz 16 Sep 03 Keep neat error message */
4069 Perl_croak(aTHX_ "Can't open " BIT_BUCKET ": %s\n", Strerror(errno));
4071 Perl_croak(aTHX_ "Can't open perl script \"%s\": %s\n",
4072 CopFILE(PL_curcop), Strerror(errno));
4074 fd = PerlIO_fileno(rsfp);
4077 (PerlLIO_fstat(fd, &tmpstatbuf) >= 0
4078 && S_ISDIR(tmpstatbuf.st_mode)))
4079 Perl_croak(aTHX_ "Can't open perl script \"%s\": %s\n",
4086 /* In the days of suidperl, we refused to execute a setuid script stored on
4087 * a filesystem mounted nosuid and/or noexec. This meant that we probed for the
4088 * existence of the appropriate filesystem-statting function, and behaved
4089 * accordingly. But even though suidperl is long gone, we must still include
4090 * those probes for the benefit of modules like Filesys::Df, which expect the
4091 * results of those probes to be stored in %Config; see RT#126368. So mention
4092 * the relevant cpp symbols here, to ensure that metaconfig will include their
4093 * probes in the generated Configure:
4095 * I_SYSSTATVFS HAS_FSTATVFS
4097 * I_STATFS HAS_FSTATFS HAS_GETFSSTAT
4098 * I_MNTENT HAS_GETMNTENT HAS_HASMNTOPT
4102 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
4103 /* Don't even need this function. */
4106 S_validate_suid(pTHX_ PerlIO *rsfp)
4108 const Uid_t my_uid = PerlProc_getuid();
4109 const Uid_t my_euid = PerlProc_geteuid();
4110 const Gid_t my_gid = PerlProc_getgid();
4111 const Gid_t my_egid = PerlProc_getegid();
4113 PERL_ARGS_ASSERT_VALIDATE_SUID;
4115 if (my_euid != my_uid || my_egid != my_gid) { /* (suidperl doesn't exist, in fact) */
4117 int fd = PerlIO_fileno(rsfp);
4119 if (fd < 0 || PerlLIO_fstat(fd, &statbuf) < 0) { /* may be either wrapped or real suid */
4120 Perl_croak_nocontext( "Illegal suidscript");
4122 if ((my_euid != my_uid && my_euid == statbuf.st_uid && statbuf.st_mode & S_ISUID)
4124 (my_egid != my_gid && my_egid == statbuf.st_gid && statbuf.st_mode & S_ISGID)
4127 Perl_croak(aTHX_ "YOU HAVEN'T DISABLED SET-ID SCRIPTS IN THE KERNEL YET!\n\
4128 FIX YOUR KERNEL, PUT A C WRAPPER AROUND THIS SCRIPT, OR USE -u AND UNDUMP!\n");
4129 /* not set-id, must be wrapped */
4132 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4135 S_find_beginning(pTHX_ SV* linestr_sv, PerlIO *rsfp)
4140 PERL_ARGS_ASSERT_FIND_BEGINNING;
4142 /* skip forward in input to the real script? */
4145 if ((s = sv_gets(linestr_sv, rsfp, 0)) == NULL)
4146 Perl_croak(aTHX_ "No Perl script found in input\n");
4148 } while (!(*s == '#' && s[1] == '!' && ((s = instr(s,"perl")) || (s = instr(s2,"PERL")))));
4149 PerlIO_ungetc(rsfp, '\n'); /* to keep line count right */
4150 while (*s && !(isSPACE (*s) || *s == '#')) s++;
4152 while (*s == ' ' || *s == '\t') s++;
4154 while (isDIGIT(s2[-1]) || s2[-1] == '-' || s2[-1] == '.'
4155 || s2[-1] == '_') s2--;
4156 if (strBEGINs(s2-4,"perl"))
4157 while ((s = moreswitches(s)))
4166 /* no need to do anything here any more if we don't
4168 #ifndef NO_TAINT_SUPPORT
4169 const Uid_t my_uid = PerlProc_getuid();
4170 const Uid_t my_euid = PerlProc_geteuid();
4171 const Gid_t my_gid = PerlProc_getgid();
4172 const Gid_t my_egid = PerlProc_getegid();
4174 PERL_UNUSED_CONTEXT;
4176 /* Should not happen: */
4177 CHECK_MALLOC_TAINT(my_uid && (my_euid != my_uid || my_egid != my_gid));
4178 TAINTING_set( TAINTING_get | (my_uid && (my_euid != my_uid || my_egid != my_gid)) );
4182 * Should go by suidscript, not uid!=euid: why disallow
4183 * system("ls") in scripts run from setuid things?
4184 * Or, is this run before we check arguments and set suidscript?
4185 * What about SETUID_SCRIPTS_ARE_SECURE_NOW: could we use fdscript then?
4186 * (We never have suidscript, can we be sure to have fdscript?)
4187 * Or must then go by UID checks? See comments in forbid_setid also.
4191 /* This is used very early in the lifetime of the program,
4192 * before even the options are parsed, so PL_tainting has
4193 * not been initialized properly. */
4195 Perl_doing_taint(int argc, char *argv[], char *envp[])
4197 #ifndef PERL_IMPLICIT_SYS
4198 /* If we have PERL_IMPLICIT_SYS we can't call getuid() et alia
4199 * before we have an interpreter-- and the whole point of this
4200 * function is to be called at such an early stage. If you are on
4201 * a system with PERL_IMPLICIT_SYS but you do have a concept of
4202 * "tainted because running with altered effective ids', you'll
4203 * have to add your own checks somewhere in here. The two most
4204 * known samples of 'implicitness' are Win32 and NetWare, neither
4205 * of which has much of concept of 'uids'. */
4206 Uid_t uid = PerlProc_getuid();
4207 Uid_t euid = PerlProc_geteuid();
4208 Gid_t gid = PerlProc_getgid();
4209 Gid_t egid = PerlProc_getegid();
4216 if (uid && (euid != uid || egid != gid))
4218 #endif /* !PERL_IMPLICIT_SYS */
4219 /* This is a really primitive check; environment gets ignored only
4220 * if -T are the first chars together; otherwise one gets
4221 * "Too late" message. */
4222 if ( argc > 1 && argv[1][0] == '-'
4223 && isALPHA_FOLD_EQ(argv[1][1], 't'))
4228 /* Passing the flag as a single char rather than a string is a slight space
4229 optimisation. The only message that isn't /^-.$/ is
4230 "program input from stdin", which is substituted in place of '\0', which
4231 could never be a command line flag. */
4233 S_forbid_setid(pTHX_ const char flag, const bool suidscript) /* g */
4235 char string[3] = "-x";
4236 const char *message = "program input from stdin";
4238 PERL_UNUSED_CONTEXT;
4244 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
4245 if (PerlProc_getuid() != PerlProc_geteuid())
4246 Perl_croak(aTHX_ "No %s allowed while running setuid", message);
4247 if (PerlProc_getgid() != PerlProc_getegid())
4248 Perl_croak(aTHX_ "No %s allowed while running setgid", message);
4249 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4251 Perl_croak(aTHX_ "No %s allowed with (suid) fdscript", message);
4255 Perl_init_dbargs(pTHX)
4257 AV *const args = PL_dbargs = GvAV(gv_AVadd((gv_fetchpvs("DB::args",
4262 /* Someone has already created it.
4263 It might have entries, and if we just turn off AvREAL(), they will
4264 "leak" until global destruction. */
4266 if (SvTIED_mg((const SV *)args, PERL_MAGIC_tied))
4267 Perl_croak(aTHX_ "Cannot set tied @DB::args");
4269 AvREIFY_only(PL_dbargs);
4273 Perl_init_debugger(pTHX)
4275 HV * const ostash = PL_curstash;
4278 PL_curstash = (HV *)SvREFCNT_inc_simple(PL_debstash);
4280 Perl_init_dbargs(aTHX);
4281 PL_DBgv = MUTABLE_GV(
4282 SvREFCNT_inc(gv_fetchpvs("DB::DB", GV_ADDMULTI, SVt_PVGV))
4284 PL_DBline = MUTABLE_GV(
4285 SvREFCNT_inc(gv_fetchpvs("DB::dbline", GV_ADDMULTI, SVt_PVAV))
4287 PL_DBsub = MUTABLE_GV(SvREFCNT_inc(
4288 gv_HVadd(gv_fetchpvs("DB::sub", GV_ADDMULTI, SVt_PVHV))
4290 PL_DBsingle = GvSV((gv_fetchpvs("DB::single", GV_ADDMULTI, SVt_PV)));
4291 if (!SvIOK(PL_DBsingle))
4292 sv_setiv(PL_DBsingle, 0);
4293 mg = sv_magicext(PL_DBsingle, NULL, PERL_MAGIC_debugvar, &PL_vtbl_debugvar, 0, 0);
4294 mg->mg_private = DBVARMG_SINGLE;
4295 SvSETMAGIC(PL_DBsingle);
4297 PL_DBtrace = GvSV((gv_fetchpvs("DB::trace", GV_ADDMULTI, SVt_PV)));
4298 if (!SvIOK(PL_DBtrace))
4299 sv_setiv(PL_DBtrace, 0);
4300 mg = sv_magicext(PL_DBtrace, NULL, PERL_MAGIC_debugvar, &PL_vtbl_debugvar, 0, 0);
4301 mg->mg_private = DBVARMG_TRACE;
4302 SvSETMAGIC(PL_DBtrace);
4304 PL_DBsignal = GvSV((gv_fetchpvs("DB::signal", GV_ADDMULTI, SVt_PV)));
4305 if (!SvIOK(PL_DBsignal))
4306 sv_setiv(PL_DBsignal, 0);
4307 mg = sv_magicext(PL_DBsignal, NULL, PERL_MAGIC_debugvar, &PL_vtbl_debugvar, 0, 0);
4308 mg->mg_private = DBVARMG_SIGNAL;
4309 SvSETMAGIC(PL_DBsignal);
4311 SvREFCNT_dec(PL_curstash);
4312 PL_curstash = ostash;
4315 #ifndef STRESS_REALLOC
4316 #define REASONABLE(size) (size)
4317 #define REASONABLE_but_at_least(size,min) (size)
4319 #define REASONABLE(size) (1) /* unreasonable */
4320 #define REASONABLE_but_at_least(size,min) (min)
4324 Perl_init_stacks(pTHX)
4328 /* start with 128-item stack and 8K cxstack */
4329 PL_curstackinfo = new_stackinfo(REASONABLE(128),
4330 REASONABLE(8192/sizeof(PERL_CONTEXT) - 1));
4331 PL_curstackinfo->si_type = PERLSI_MAIN;
4332 #if defined DEBUGGING && !defined DEBUGGING_RE_ONLY
4333 PL_curstackinfo->si_stack_hwm = 0;
4335 PL_curstack = PL_curstackinfo->si_stack;
4336 PL_mainstack = PL_curstack; /* remember in case we switch stacks */
4338 PL_stack_base = AvARRAY(PL_curstack);
4339 PL_stack_sp = PL_stack_base;
4340 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
4342 Newx(PL_tmps_stack,REASONABLE(128),SV*);
4345 PL_tmps_max = REASONABLE(128);
4347 Newx(PL_markstack,REASONABLE(32),I32);
4348 PL_markstack_ptr = PL_markstack;
4349 PL_markstack_max = PL_markstack + REASONABLE(32);
4353 Newx(PL_scopestack,REASONABLE(32),I32);
4355 Newx(PL_scopestack_name,REASONABLE(32),const char*);
4357 PL_scopestack_ix = 0;
4358 PL_scopestack_max = REASONABLE(32);
4360 size = REASONABLE_but_at_least(128,SS_MAXPUSH);
4361 Newx(PL_savestack, size, ANY);
4362 PL_savestack_ix = 0;
4363 /*PL_savestack_max lies: it always has SS_MAXPUSH more than it claims */
4364 PL_savestack_max = size - SS_MAXPUSH;
4372 while (PL_curstackinfo->si_next)
4373 PL_curstackinfo = PL_curstackinfo->si_next;
4374 while (PL_curstackinfo) {
4375 PERL_SI *p = PL_curstackinfo->si_prev;
4376 /* curstackinfo->si_stack got nuked by sv_free_arenas() */
4377 Safefree(PL_curstackinfo->si_cxstack);
4378 Safefree(PL_curstackinfo);
4379 PL_curstackinfo = p;
4381 Safefree(PL_tmps_stack);
4382 Safefree(PL_markstack);
4383 Safefree(PL_scopestack);
4385 Safefree(PL_scopestack_name);
4387 Safefree(PL_savestack);
4391 Perl_populate_isa(pTHX_ const char *name, STRLEN len, ...)
4393 GV *const gv = gv_fetchpvn(name, len, GV_ADD | GV_ADDMULTI, SVt_PVAV);
4394 AV *const isa = GvAVn(gv);
4397 PERL_ARGS_ASSERT_POPULATE_ISA;
4399 if(AvFILLp(isa) != -1)
4402 /* NOTE: No support for tied ISA */
4404 va_start(args, len);
4406 const char *const parent = va_arg(args, const char*);
4411 parent_len = va_arg(args, size_t);
4413 /* Arguments are supplied with a trailing :: */
4414 assert(parent_len > 2);
4415 assert(parent[parent_len - 1] == ':');
4416 assert(parent[parent_len - 2] == ':');
4417 av_push(isa, newSVpvn(parent, parent_len - 2));
4418 (void) gv_fetchpvn(parent, parent_len, GV_ADD, SVt_PVGV);
4425 S_init_predump_symbols(pTHX)
4430 sv_setpvs(get_sv("\"", GV_ADD), " ");
4431 PL_ofsgv = (GV*)SvREFCNT_inc(gv_fetchpvs(",", GV_ADD|GV_NOTQUAL, SVt_PV));
4434 /* Historically, PVIOs were blessed into IO::Handle, unless
4435 FileHandle was loaded, in which case they were blessed into
4436 that. Action at a distance.
4437 However, if we simply bless into IO::Handle, we break code
4438 that assumes that PVIOs will have (among others) a seek
4439 method. IO::File inherits from IO::Handle and IO::Seekable,
4440 and provides the needed methods. But if we simply bless into
4441 it, then we break code that assumed that by loading
4442 IO::Handle, *it* would work.
4443 So a compromise is to set up the correct @IO::File::ISA,
4444 so that code that does C<use IO::Handle>; will still work.
4447 Perl_populate_isa(aTHX_ STR_WITH_LEN("IO::File::ISA"),
4448 STR_WITH_LEN("IO::Handle::"),
4449 STR_WITH_LEN("IO::Seekable::"),
4450 STR_WITH_LEN("Exporter::"),
4453 PL_stdingv = gv_fetchpvs("STDIN", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4454 GvMULTI_on(PL_stdingv);
4455 io = GvIOp(PL_stdingv);
4456 IoTYPE(io) = IoTYPE_RDONLY;
4457 IoIFP(io) = PerlIO_stdin();
4458 tmpgv = gv_fetchpvs("stdin", GV_ADD|GV_NOTQUAL, SVt_PV);
4460 GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4462 tmpgv = gv_fetchpvs("STDOUT", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4465 IoTYPE(io) = IoTYPE_WRONLY;
4466 IoOFP(io) = IoIFP(io) = PerlIO_stdout();
4468 tmpgv = gv_fetchpvs("stdout", GV_ADD|GV_NOTQUAL, SVt_PV);
4470 GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4472 PL_stderrgv = gv_fetchpvs("STDERR", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4473 GvMULTI_on(PL_stderrgv);
4474 io = GvIOp(PL_stderrgv);
4475 IoTYPE(io) = IoTYPE_WRONLY;
4476 IoOFP(io) = IoIFP(io) = PerlIO_stderr();
4477 tmpgv = gv_fetchpvs("stderr", GV_ADD|GV_NOTQUAL, SVt_PV);
4479 GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4481 PL_statname = newSVpvs(""); /* last filename we did stat on */
4485 Perl_init_argv_symbols(pTHX_ int argc, char **argv)
4487 PERL_ARGS_ASSERT_INIT_ARGV_SYMBOLS;
4489 argc--,argv++; /* skip name of script */
4490 if (PL_doswitches) {
4491 for (; argc > 0 && **argv == '-'; argc--,argv++) {
4495 if (argv[0][1] == '-' && !argv[0][2]) {
4499 if ((s = strchr(argv[0], '='))) {
4500 const char *const start_name = argv[0] + 1;
4501 sv_setpv(GvSV(gv_fetchpvn_flags(start_name, s - start_name,
4502 TRUE, SVt_PV)), s + 1);
4505 sv_setiv(GvSV(gv_fetchpv(argv[0]+1, GV_ADD, SVt_PV)),1);
4508 if ((PL_argvgv = gv_fetchpvs("ARGV", GV_ADD|GV_NOTQUAL, SVt_PVAV))) {
4509 SvREFCNT_inc_simple_void_NN(PL_argvgv);
4510 GvMULTI_on(PL_argvgv);
4511 av_clear(GvAVn(PL_argvgv));
4512 for (; argc > 0; argc--,argv++) {
4513 SV * const sv = newSVpv(argv[0],0);
4514 av_push(GvAV(PL_argvgv),sv);
4515 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
4516 if (PL_unicode & PERL_UNICODE_ARGV_FLAG)
4519 if (PL_unicode & PERL_UNICODE_WIDESYSCALLS_FLAG) /* Sarathy? */
4520 (void)sv_utf8_decode(sv);
4524 if (PL_inplace && (!PL_argvgv || AvFILL(GvAV(PL_argvgv)) == -1))
4525 Perl_ck_warner_d(aTHX_ packWARN(WARN_INPLACE),
4526 "-i used with no filenames on the command line, "
4527 "reading from STDIN");
4531 S_init_postdump_symbols(pTHX_ int argc, char **argv, char **env)
4538 PERL_ARGS_ASSERT_INIT_POSTDUMP_SYMBOLS;
4540 PL_toptarget = newSV_type(SVt_PVIV);
4541 SvPVCLEAR(PL_toptarget);
4542 PL_bodytarget = newSV_type(SVt_PVIV);
4543 SvPVCLEAR(PL_bodytarget);
4544 PL_formtarget = PL_bodytarget;
4548 init_argv_symbols(argc,argv);
4550 if ((tmpgv = gv_fetchpvs("0", GV_ADD|GV_NOTQUAL, SVt_PV))) {
4551 sv_setpv(GvSV(tmpgv),PL_origfilename);
4553 if ((PL_envgv = gv_fetchpvs("ENV", GV_ADD|GV_NOTQUAL, SVt_PVHV))) {
4555 bool env_is_not_environ;
4556 SvREFCNT_inc_simple_void_NN(PL_envgv);
4557 GvMULTI_on(PL_envgv);
4558 hv = GvHVn(PL_envgv);
4559 hv_magic(hv, NULL, PERL_MAGIC_env);
4561 #ifdef USE_ENVIRON_ARRAY
4562 /* Note that if the supplied env parameter is actually a copy
4563 of the global environ then it may now point to free'd memory
4564 if the environment has been modified since. To avoid this
4565 problem we treat env==NULL as meaning 'use the default'
4569 env_is_not_environ = env != environ;
4570 if (env_is_not_environ
4571 # ifdef USE_ITHREADS
4572 && PL_curinterp == aTHX
4584 for (; *env; env++) {
4587 if (!(s = strchr(old_var,'=')) || s == old_var)
4591 #if defined(MSDOS) && !defined(DJGPP)
4593 (void)strupr(old_var);
4596 if (hv_exists(hv, old_var, nlen)) {
4597 const char *name = savepvn(old_var, nlen);
4599 /* make sure we use the same value as getenv(), otherwise code that
4600 uses getenv() (like setlocale()) might see a different value to %ENV
4602 sv = newSVpv(PerlEnv_getenv(name), 0);
4604 /* keep a count of the dups of this name so we can de-dup environ later */
4605 if (hv_exists(dups, name, nlen))
4606 ++SvIVX(*hv_fetch(dups, name, nlen, 0));
4608 (void)hv_store(dups, name, nlen, newSViv(1), 0);
4613 sv = newSVpv(s+1, 0);
4615 (void)hv_store(hv, old_var, nlen, sv, 0);
4616 if (env_is_not_environ)
4620 /* environ has some duplicate definitions, remove them */
4623 while ((entry = hv_iternext_flags(dups, 0))) {
4625 const char *name = HePV(entry, nlen);
4626 IV count = SvIV(HeVAL(entry));
4628 SV **valp = hv_fetch(hv, name, nlen, 0);
4632 /* try to remove any duplicate names, depending on the
4633 * implementation used in my_setenv() the iteration might
4634 * not be necessary, but let's be safe.
4636 for (i = 0; i < count; ++i)
4639 /* and set it back to the value we set $ENV{name} to */
4640 my_setenv(name, SvPV_nolen(*valp));
4643 SvREFCNT_dec_NN(dups);
4645 #endif /* USE_ENVIRON_ARRAY */
4646 #endif /* !PERL_MICRO */
4650 /* touch @F array to prevent spurious warnings 20020415 MJD */
4652 (void) get_av("main::F", GV_ADD | GV_ADDMULTI);
4657 S_init_perllib(pTHX)
4660 const char *perl5lib = NULL;
4663 #if defined(WIN32) && !defined(PERL_IS_MINIPERL)
4667 if (!TAINTING_get) {
4669 perl5lib = PerlEnv_getenv("PERL5LIB");
4671 * It isn't possible to delete an environment variable with
4672 * PERL_USE_SAFE_PUTENV set unless unsetenv() is also available, so in that
4673 * case we treat PERL5LIB as undefined if it has a zero-length value.
4675 #if defined(PERL_USE_SAFE_PUTENV) && ! defined(HAS_UNSETENV)
4676 if (perl5lib && *perl5lib != '\0')
4680 incpush_use_sep(perl5lib, 0, INCPUSH_ADD_SUB_DIRS);
4682 s = PerlEnv_getenv("PERLLIB");
4684 incpush_use_sep(s, 0, 0);
4687 /* Treat PERL5?LIB as a possible search list logical name -- the
4688 * "natural" VMS idiom for a Unix path string. We allow each
4689 * element to be a set of |-separated directories for compatibility.
4693 if (vmstrnenv("PERL5LIB",buf,0,NULL,0))
4695 incpush_use_sep(buf, 0, INCPUSH_ADD_SUB_DIRS);
4696 } while (vmstrnenv("PERL5LIB",buf,++idx,NULL,0));
4698 while (vmstrnenv("PERLLIB",buf,idx++,NULL,0))
4699 incpush_use_sep(buf, 0, 0);
4704 #ifndef PERL_IS_MINIPERL
4705 /* miniperl gets just -I..., the split of $ENV{PERL5LIB}, and "." in @INC
4706 (and not the architecture specific directories from $ENV{PERL5LIB}) */
4708 #include "perl_inc_macro.h"
4709 /* Use the ~-expanded versions of APPLLIB (undocumented),
4710 SITEARCH, SITELIB, VENDORARCH, VENDORLIB, ARCHLIB and PRIVLIB
4713 INCPUSH_SITEARCH_EXP
4715 INCPUSH_PERL_VENDORARCH_EXP
4716 INCPUSH_PERL_VENDORLIB_EXP
4719 INCPUSH_PERL_OTHERLIBDIRS
4721 INCPUSH_APPLLIB_OLD_EXP
4722 INCPUSH_SITELIB_STEM
4723 INCPUSH_PERL_VENDORLIB_STEM
4724 INCPUSH_PERL_OTHERLIBDIRS_ARCHONLY
4726 #endif /* !PERL_IS_MINIPERL */
4728 if (!TAINTING_get) {
4729 #if !defined(PERL_IS_MINIPERL) && defined(DEFAULT_INC_EXCLUDES_DOT)
4730 const char * const unsafe = PerlEnv_getenv("PERL_USE_UNSAFE_INC");
4731 if (unsafe && strEQ(unsafe, "1"))
4733 S_incpush(aTHX_ STR_WITH_LEN("."), 0);
4737 #if defined(DOSISH) || defined(__SYMBIAN32__)
4738 # define PERLLIB_SEP ';'
4739 #elif defined(__VMS)
4740 # define PERLLIB_SEP PL_perllib_sep
4742 # define PERLLIB_SEP ':'
4744 #ifndef PERLLIB_MANGLE
4745 # define PERLLIB_MANGLE(s,n) (s)
4748 #ifndef PERL_IS_MINIPERL
4749 /* Push a directory onto @INC if it exists.
4750 Generate a new SV if we do this, to save needing to copy the SV we push
4753 S_incpush_if_exists(pTHX_ AV *const av, SV *dir, SV *const stem)
4757 PERL_ARGS_ASSERT_INCPUSH_IF_EXISTS;
4759 if (PerlLIO_stat(SvPVX_const(dir), &tmpstatbuf) >= 0 &&
4760 S_ISDIR(tmpstatbuf.st_mode)) {
4762 dir = newSVsv(stem);
4764 /* Truncate dir back to stem. */
4765 SvCUR_set(dir, SvCUR(stem));
4772 S_mayberelocate(pTHX_ const char *const dir, STRLEN len, U32 flags)
4774 const U8 canrelocate = (U8)flags & INCPUSH_CAN_RELOCATE;
4777 PERL_ARGS_ASSERT_MAYBERELOCATE;
4780 /* I am not convinced that this is valid when PERLLIB_MANGLE is
4781 defined to so something (in os2/os2.c), but the code has been
4782 this way, ignoring any possible changed of length, since
4783 760ac839baf413929cd31cc32ffd6dba6b781a81 (5.003_02) so I'll leave
4785 libdir = newSVpvn(PERLLIB_MANGLE(dir, len), len);
4791 if ((unix = tounixspec_ts(SvPV(libdir,len),NULL)) != NULL) {
4793 while (len > 1 && unix[len-1] == '/') len--; /* Cosmetic */
4794 sv_usepvn(libdir,unix,len);
4797 PerlIO_printf(Perl_error_log,
4798 "Failed to unixify @INC element \"%s\"\n",
4799 SvPV_nolen_const(libdir));
4803 /* Do the if() outside the #ifdef to avoid warnings about an unused
4806 #ifdef PERL_RELOCATABLE_INC
4808 * Relocatable include entries are marked with a leading .../
4811 * 0: Remove that leading ".../"
4812 * 1: Remove trailing executable name (anything after the last '/')
4813 * from the perl path to give a perl prefix
4815 * While the @INC element starts "../" and the prefix ends with a real
4816 * directory (ie not . or ..) chop that real directory off the prefix
4817 * and the leading "../" from the @INC element. ie a logical "../"
4819 * Finally concatenate the prefix and the remainder of the @INC element
4820 * The intent is that /usr/local/bin/perl and .../../lib/perl5
4821 * generates /usr/local/lib/perl5
4823 const char *libpath = SvPVX(libdir);
4824 STRLEN libpath_len = SvCUR(libdir);
4825 if (memBEGINs(libpath, libpath_len, ".../")) {
4827 SV * const caret_X = get_sv("\030", 0);
4828 /* Going to use the SV just as a scratch buffer holding a C
4834 /* $^X is *the* source of taint if tainting is on, hence
4835 SvPOK() won't be true. */
4837 assert(SvPOKp(caret_X));
4838 prefix_sv = newSVpvn_flags(SvPVX(caret_X), SvCUR(caret_X),
4840 /* Firstly take off the leading .../
4841 If all else fail we'll do the paths relative to the current
4843 sv_chop(libdir, libpath + 4);
4844 /* Don't use SvPV as we're intentionally bypassing taining,
4845 mortal copies that the mg_get of tainting creates, and
4846 corruption that seems to come via the save stack.
4847 I guess that the save stack isn't correctly set up yet. */
4848 libpath = SvPVX(libdir);
4849 libpath_len = SvCUR(libdir);
4851 prefix = SvPVX(prefix_sv);
4852 lastslash = (char *) my_memrchr(prefix, '/',
4853 SvEND(prefix_sv) - prefix);
4855 /* First time in with the *lastslash = '\0' we just wipe off
4856 the trailing /perl from (say) /usr/foo/bin/perl
4860 while ((*lastslash = '\0'), /* Do that, come what may. */
4861 ( memBEGINs(libpath, libpath_len, "../")
4863 (char *) my_memrchr(prefix, '/',
4864 SvEND(prefix_sv) - prefix))))
4866 if (lastslash[1] == '\0'
4867 || (lastslash[1] == '.'
4868 && (lastslash[2] == '/' /* ends "/." */
4869 || (lastslash[2] == '/'
4870 && lastslash[3] == '/' /* or "/.." */
4872 /* Prefix ends "/" or "/." or "/..", any of which
4873 are fishy, so don't do any more logical cleanup.
4877 /* Remove leading "../" from path */
4880 /* Next iteration round the loop removes the last
4881 directory name from prefix by writing a '\0' in
4882 the while clause. */
4884 /* prefix has been terminated with a '\0' to the correct
4885 length. libpath points somewhere into the libdir SV.
4886 We need to join the 2 with '/' and drop the result into
4888 tempsv = Perl_newSVpvf(aTHX_ "%s/%s", prefix, libpath);
4889 SvREFCNT_dec(libdir);
4890 /* And this is the new libdir. */
4893 (PerlProc_getuid() != PerlProc_geteuid() ||
4894 PerlProc_getgid() != PerlProc_getegid())) {
4895 /* Need to taint relocated paths if running set ID */
4896 SvTAINTED_on(libdir);
4899 SvREFCNT_dec(prefix_sv);
4907 S_incpush(pTHX_ const char *const dir, STRLEN len, U32 flags)
4909 #ifndef PERL_IS_MINIPERL
4910 const U8 using_sub_dirs
4911 = (U8)flags & (INCPUSH_ADD_VERSIONED_SUB_DIRS
4912 |INCPUSH_ADD_ARCHONLY_SUB_DIRS|INCPUSH_ADD_OLD_VERS);
4913 const U8 add_versioned_sub_dirs
4914 = (U8)flags & INCPUSH_ADD_VERSIONED_SUB_DIRS;
4915 const U8 add_archonly_sub_dirs
4916 = (U8)flags & INCPUSH_ADD_ARCHONLY_SUB_DIRS;
4917 #ifdef PERL_INC_VERSION_LIST
4918 const U8 addoldvers = (U8)flags & INCPUSH_ADD_OLD_VERS;
4921 const U8 unshift = (U8)flags & INCPUSH_UNSHIFT;
4922 const U8 push_basedir = (flags & INCPUSH_NOT_BASEDIR) ? 0 : 1;
4923 AV *const inc = GvAVn(PL_incgv);
4925 PERL_ARGS_ASSERT_INCPUSH;
4928 /* Could remove this vestigial extra block, if we don't mind a lot of
4929 re-indenting diff noise. */
4931 SV *const libdir = mayberelocate(dir, len, flags);
4932 /* Change 20189146be79a0596543441fa369c6bf7f85103f, to fix RT#6665,
4933 arranged to unshift #! line -I onto the front of @INC. However,
4934 -I can add version and architecture specific libraries, and they
4935 need to go first. The old code assumed that it was always
4936 pushing. Hence to make it work, need to push the architecture
4937 (etc) libraries onto a temporary array, then "unshift" that onto
4938 the front of @INC. */
4939 #ifndef PERL_IS_MINIPERL
4940 AV *const av = (using_sub_dirs) ? (unshift ? newAV() : inc) : NULL;
4943 * BEFORE pushing libdir onto @INC we may first push version- and
4944 * archname-specific sub-directories.
4946 if (using_sub_dirs) {
4947 SV *subdir = newSVsv(libdir);
4948 #ifdef PERL_INC_VERSION_LIST
4949 /* Configure terminates PERL_INC_VERSION_LIST with a NULL */
4950 const char * const incverlist[] = { PERL_INC_VERSION_LIST };
4951 const char * const *incver;
4954 if (add_versioned_sub_dirs) {
4955 /* .../version/archname if -d .../version/archname */
4956 sv_catpvs(subdir, "/" PERL_FS_VERSION "/" ARCHNAME);
4957 subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
4959 /* .../version if -d .../version */
4960 sv_catpvs(subdir, "/" PERL_FS_VERSION);
4961 subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
4964 #ifdef PERL_INC_VERSION_LIST
4966 for (incver = incverlist; *incver; incver++) {
4967 /* .../xxx if -d .../xxx */
4968 Perl_sv_catpvf(aTHX_ subdir, "/%s", *incver);
4969 subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
4974 if (add_archonly_sub_dirs) {
4975 /* .../archname if -d .../archname */
4976 sv_catpvs(subdir, "/" ARCHNAME);
4977 subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
4981 assert (SvREFCNT(subdir) == 1);
4982 SvREFCNT_dec(subdir);
4984 #endif /* !PERL_IS_MINIPERL */
4985 /* finally add this lib directory at the end of @INC */
4987 #ifdef PERL_IS_MINIPERL
4988 const Size_t extra = 0;
4990 Size_t extra = av_tindex(av) + 1;
4992 av_unshift(inc, extra + push_basedir);
4994 av_store(inc, extra, libdir);
4995 #ifndef PERL_IS_MINIPERL
4997 /* av owns a reference, av_store() expects to be donated a
4998 reference, and av expects to be sane when it's cleared.
4999 If I wanted to be naughty and wrong, I could peek inside the
5000 implementation of av_clear(), realise that it uses
5001 SvREFCNT_dec() too, so av's array could be a run of NULLs,
5002 and so directly steal from it (with a memcpy() to inc, and
5003 then memset() to NULL them out. But people copy code from the
5004 core expecting it to be best practise, so let's use the API.
5005 Although studious readers will note that I'm not checking any
5007 av_store(inc, extra, SvREFCNT_inc(*av_fetch(av, extra, FALSE)));
5012 else if (push_basedir) {
5013 av_push(inc, libdir);
5016 if (!push_basedir) {
5017 assert (SvREFCNT(libdir) == 1);
5018 SvREFCNT_dec(libdir);
5024 S_incpush_use_sep(pTHX_ const char *p, STRLEN len, U32 flags)
5028 /* This logic has been broken out from S_incpush(). It may be possible to
5031 PERL_ARGS_ASSERT_INCPUSH_USE_SEP;
5033 /* perl compiled with -DPERL_RELOCATABLE_INCPUSH will ignore the len
5034 * argument to incpush_use_sep. This allows creation of relocatable
5035 * Perl distributions that patch the binary at install time. Those
5036 * distributions will have to provide their own relocation tools; this
5037 * is not a feature otherwise supported by core Perl.
5039 #ifndef PERL_RELOCATABLE_INCPUSH
5046 /* Break at all separators */
5047 while ((s = (const char*)memchr(p, PERLLIB_SEP, end - p))) {
5049 /* skip any consecutive separators */
5051 /* Uncomment the next line for PATH semantics */
5052 /* But you'll need to write tests */
5053 /* av_push(GvAVn(PL_incgv), newSVpvs(".")); */
5055 incpush(p, (STRLEN)(s - p), flags);
5060 incpush(p, (STRLEN)(end - p), flags);
5065 Perl_call_list(pTHX_ I32 oldscope, AV *paramList)
5068 volatile const line_t oldline = PL_curcop ? CopLINE(PL_curcop) : 0;
5074 PERL_ARGS_ASSERT_CALL_LIST;
5076 while (av_tindex(paramList) >= 0) {
5077 cv = MUTABLE_CV(av_shift(paramList));
5079 if (paramList == PL_beginav) {
5080 /* save PL_beginav for compiler */
5081 Perl_av_create_and_push(aTHX_ &PL_beginav_save, MUTABLE_SV(cv));
5083 else if (paramList == PL_checkav) {
5084 /* save PL_checkav for compiler */
5085 Perl_av_create_and_push(aTHX_ &PL_checkav_save, MUTABLE_SV(cv));
5087 else if (paramList == PL_unitcheckav) {
5088 /* save PL_unitcheckav for compiler */
5089 Perl_av_create_and_push(aTHX_ &PL_unitcheckav_save, MUTABLE_SV(cv));
5099 (void)SvPV_const(atsv, len);
5101 PL_curcop = &PL_compiling;
5102 CopLINE_set(PL_curcop, oldline);
5103 if (paramList == PL_beginav)
5104 sv_catpvs(atsv, "BEGIN failed--compilation aborted");
5106 Perl_sv_catpvf(aTHX_ atsv,
5107 "%s failed--call queue aborted",
5108 paramList == PL_checkav ? "CHECK"
5109 : paramList == PL_initav ? "INIT"
5110 : paramList == PL_unitcheckav ? "UNITCHECK"
5112 while (PL_scopestack_ix > oldscope)
5115 Perl_croak(aTHX_ "%" SVf, SVfARG(atsv));
5122 /* my_exit() was called */
5123 while (PL_scopestack_ix > oldscope)
5126 SET_CURSTASH(PL_defstash);
5127 PL_curcop = &PL_compiling;
5128 CopLINE_set(PL_curcop, oldline);
5131 NOT_REACHED; /* NOTREACHED */
5134 PL_curcop = &PL_compiling;
5135 CopLINE_set(PL_curcop, oldline);
5138 PerlIO_printf(Perl_error_log, "panic: restartop in call_list\n");
5147 Perl_my_exit(pTHX_ U32 status)
5149 if (PL_exit_flags & PERL_EXIT_ABORT) {
5152 if (PL_exit_flags & PERL_EXIT_WARN) {
5153 PL_exit_flags |= PERL_EXIT_ABORT; /* Protect against reentrant calls */
5154 Perl_warn(aTHX_ "Unexpected exit %lu", (unsigned long)status);
5155 PL_exit_flags &= ~PERL_EXIT_ABORT;
5165 STATUS_EXIT_SET(status);
5172 Perl_my_failure_exit(pTHX)
5175 /* We have been called to fall on our sword. The desired exit code
5176 * should be already set in STATUS_UNIX, but could be shifted over
5177 * by 8 bits. STATUS_UNIX_EXIT_SET will handle the cases where a
5180 * If an error code has not been set, then force the issue.
5182 if (MY_POSIX_EXIT) {
5184 /* According to the die_exit.t tests, if errno is non-zero */
5185 /* It should be used for the error status. */
5187 if (errno == EVMSERR) {
5188 STATUS_NATIVE = vaxc$errno;
5191 /* According to die_exit.t tests, if the child_exit code is */
5192 /* also zero, then we need to exit with a code of 255 */
5193 if ((errno != 0) && (errno < 256))
5194 STATUS_UNIX_EXIT_SET(errno);
5195 else if (STATUS_UNIX < 255) {
5196 STATUS_UNIX_EXIT_SET(255);
5201 /* The exit code could have been set by $? or vmsish which
5202 * means that it may not have fatal set. So convert
5203 * success/warning codes to fatal with out changing
5204 * the POSIX status code. The severity makes VMS native
5205 * status handling work, while UNIX mode programs use the
5206 * the POSIX exit codes.
5208 if ((STATUS_NATIVE & (STS$K_SEVERE|STS$K_ERROR)) == 0) {
5209 STATUS_NATIVE &= STS$M_COND_ID;
5210 STATUS_NATIVE |= STS$K_ERROR | STS$M_INHIB_MSG;
5214 /* Traditionally Perl on VMS always expects a Fatal Error. */
5215 if (vaxc$errno & 1) {
5217 /* So force success status to failure */
5218 if (STATUS_NATIVE & 1)
5223 STATUS_UNIX = EINTR; /* In case something cares */
5228 STATUS_NATIVE = vaxc$errno; /* Should already be this */
5230 /* Encode the severity code */
5231 severity = STATUS_NATIVE & STS$M_SEVERITY;
5232 STATUS_UNIX = (severity ? severity : 1) << 8;
5234 /* Perl expects this to be a fatal error */
5235 if (severity != STS$K_SEVERE)
5245 STATUS_UNIX_SET(eno);
5247 exitstatus = STATUS_UNIX >> 8;
5248 if (exitstatus & 255)
5249 STATUS_UNIX_SET(exitstatus);
5251 STATUS_UNIX_SET(255);
5254 if (PL_exit_flags & PERL_EXIT_ABORT) {
5257 if (PL_exit_flags & PERL_EXIT_WARN) {
5258 PL_exit_flags |= PERL_EXIT_ABORT; /* Protect against reentrant calls */
5259 Perl_warn(aTHX_ "Unexpected exit failure %ld", (long)PL_statusvalue);
5260 PL_exit_flags &= ~PERL_EXIT_ABORT;
5266 S_my_exit_jump(pTHX)
5269 SvREFCNT_dec(PL_e_script);
5273 POPSTACK_TO(PL_mainstack);
5274 if (cxstack_ix >= 0) {
5276 cx_popblock(cxstack);
5284 read_e_script(pTHX_ int idx, SV *buf_sv, int maxlen)
5286 const char * const p = SvPVX_const(PL_e_script);
5287 const char * const e = SvEND(PL_e_script);
5288 const char *nl = (char *) memchr(p, '\n', e - p);
5290 PERL_UNUSED_ARG(idx);
5291 PERL_UNUSED_ARG(maxlen);
5293 nl = (nl) ? nl+1 : e;
5295 filter_del(read_e_script);
5298 sv_catpvn(buf_sv, p, nl-p);
5299 sv_chop(PL_e_script, nl);
5303 /* removes boilerplate code at the end of each boot_Module xsub */
5305 Perl_xs_boot_epilog(pTHX_ const I32 ax)
5308 call_list(PL_scopestack_ix, PL_unitcheckav);
5313 * ex: set ts=8 sts=4 sw=4 et: