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);
322 PL_utf8_toupper = _new_invlist_C_array(Uppercase_Mapping_invlist);
323 PL_utf8_tolower = _new_invlist_C_array(Lowercase_Mapping_invlist);
324 PL_utf8_totitle = _new_invlist_C_array(Titlecase_Mapping_invlist);
325 PL_utf8_tofold = _new_invlist_C_array(Case_Folding_invlist);
326 PL_utf8_tosimplefold = _new_invlist_C_array(Simple_Case_Folding_invlist);
327 PL_utf8_perl_idstart = _new_invlist_C_array(_Perl_IDStart_invlist);
328 PL_utf8_perl_idcont = _new_invlist_C_array(_Perl_IDCont_invlist);
329 PL_AboveLatin1 = _new_invlist_C_array(AboveLatin1_invlist);
330 PL_Latin1 = _new_invlist_C_array(Latin1_invlist);
331 PL_UpperLatin1 = _new_invlist_C_array(UpperLatin1_invlist);
332 PL_utf8_foldable = _new_invlist_C_array(_Perl_Any_Folds_invlist);
333 PL_HasMultiCharFold = _new_invlist_C_array(
334 _Perl_Folds_To_Multi_Char_invlist);
335 PL_NonL1NonFinalFold = _new_invlist_C_array(
336 NonL1_Perl_Non_Final_Folds_invlist);
337 PL_utf8_charname_begin = _new_invlist_C_array(_Perl_Charname_Begin_invlist);
338 PL_utf8_charname_continue = _new_invlist_C_array(_Perl_Charname_Continue_invlist);
339 PL_utf8_foldclosures = _new_invlist_C_array(_Perl_IVCF_invlist);
342 #if defined(LOCAL_PATCH_COUNT)
343 PL_localpatches = local_patches; /* For possible -v */
346 #if defined(LIBM_LIB_VERSION)
348 * Some BSDs and Cygwin default to POSIX math instead of IEEE.
349 * This switches them over to IEEE.
351 _LIB_VERSION = _IEEE_;
354 #ifdef HAVE_INTERP_INTERN
358 PerlIO_init(aTHX); /* Hook to IO system */
360 PL_fdpid = newAV(); /* for remembering popen pids by fd */
361 PL_modglobal = newHV(); /* pointers to per-interpreter module globals */
362 PL_errors = newSVpvs("");
363 SvPVCLEAR(PERL_DEBUG_PAD(0)); /* For regex debugging. */
364 SvPVCLEAR(PERL_DEBUG_PAD(1)); /* ext/re needs these */
365 SvPVCLEAR(PERL_DEBUG_PAD(2)); /* even without DEBUGGING. */
367 /* First entry is a list of empty elements. It needs to be initialised
368 else all hell breaks loose in S_find_uninit_var(). */
369 Perl_av_create_and_push(aTHX_ &PL_regex_padav, newSVpvs(""));
370 PL_regex_pad = AvARRAY(PL_regex_padav);
371 Newxz(PL_stashpad, PL_stashpadmax, HV *);
373 #ifdef USE_REENTRANT_API
374 Perl_reentrant_init(aTHX);
376 if (PL_hash_seed_set == FALSE) {
377 /* Initialize the hash seed and state at startup. This must be
378 * done very early, before ANY hashes are constructed, and once
379 * setup is fixed for the lifetime of the process.
381 * If you decide to disable the seeding process you should choose
382 * a suitable seed yourself and define PERL_HASH_SEED to a well chosen
383 * string. See hv_func.h for details.
385 #if defined(USE_HASH_SEED)
386 /* get the hash seed from the environment or from an RNG */
387 Perl_get_hash_seed(aTHX_ PL_hash_seed);
389 /* they want a hard coded seed, check that it is long enough */
390 assert( strlen(PERL_HASH_SEED) >= PERL_HASH_SEED_BYTES );
393 /* now we use the chosen seed to initialize the state -
394 * in some configurations this may be a relatively speaking
395 * expensive operation, but we only have to do it once at startup */
396 PERL_HASH_SEED_STATE(PERL_HASH_SEED,PL_hash_state);
398 #ifdef PERL_USE_SINGLE_CHAR_HASH_CACHE
399 /* we can build a special cache for 0/1 byte keys, if people choose
400 * I suspect most of the time it is not worth it */
404 for (i=0;i<256;i++) {
406 PERL_HASH_WITH_STATE(PL_hash_state,PL_hash_chars[i],str,1);
408 PERL_HASH_WITH_STATE(PL_hash_state,PL_hash_chars[256],str,0);
411 /* at this point we have initialezed the hash function, and we can start
412 * constructing hashes */
413 PL_hash_seed_set= TRUE;
416 /* Allow PL_strtab to be pre-initialized before calling perl_construct.
417 * can use a custom optimized PL_strtab hash before calling perl_construct */
419 /* Note that strtab is a rather special HV. Assumptions are made
420 about not iterating on it, and not adding tie magic to it.
421 It is properly deallocated in perl_destruct() */
424 /* SHAREKEYS tells us that the hash has its keys shared with PL_strtab,
425 * which is not the case with PL_strtab itself */
426 HvSHAREKEYS_off(PL_strtab); /* mandatory */
427 hv_ksplit(PL_strtab, 1 << 11);
430 Zero(PL_sv_consts, SV_CONSTS_COUNT, SV*);
433 # ifdef USE_ENVIRON_ARRAY
434 PL_origenviron = environ;
438 /* Use sysconf(_SC_CLK_TCK) if available, if not
439 * available or if the sysconf() fails, use the HZ.
440 * The HZ if not originally defined has been by now
441 * been defined as CLK_TCK, if available. */
442 #if defined(HAS_SYSCONF) && defined(_SC_CLK_TCK)
443 PL_clocktick = sysconf(_SC_CLK_TCK);
444 if (PL_clocktick <= 0)
448 PL_stashcache = newHV();
450 PL_patchlevel = newSVpvs("v" PERL_VERSION_STRING);
453 if (!PL_mmap_page_size) {
454 #if defined(HAS_SYSCONF) && (defined(_SC_PAGESIZE) || defined(_SC_MMAP_PAGE_SIZE))
456 SETERRNO(0, SS_NORMAL);
458 PL_mmap_page_size = sysconf(_SC_PAGESIZE);
460 PL_mmap_page_size = sysconf(_SC_MMAP_PAGE_SIZE);
462 if ((long) PL_mmap_page_size < 0) {
463 Perl_croak(aTHX_ "panic: sysconf: %s",
464 errno ? Strerror(errno) : "pagesize unknown");
467 #elif defined(HAS_GETPAGESIZE)
468 PL_mmap_page_size = getpagesize();
469 #elif defined(I_SYS_PARAM) && defined(PAGESIZE)
470 PL_mmap_page_size = PAGESIZE; /* compiletime, bad */
472 if (PL_mmap_page_size <= 0)
473 Perl_croak(aTHX_ "panic: bad pagesize %" IVdf,
474 (IV) PL_mmap_page_size);
476 #endif /* HAS_MMAP */
478 #if defined(HAS_TIMES) && defined(PERL_NEED_TIMESBASE)
479 PL_timesbase.tms_utime = 0;
480 PL_timesbase.tms_stime = 0;
481 PL_timesbase.tms_cutime = 0;
482 PL_timesbase.tms_cstime = 0;
485 PL_osname = Perl_savepvn(aTHX_ STR_WITH_LEN(OSNAME));
487 PL_registered_mros = newHV();
488 /* Start with 1 bucket, for DFS. It's unlikely we'll need more. */
489 HvMAX(PL_registered_mros) = 0;
491 #ifdef USE_POSIX_2008_LOCALE
492 PL_C_locale_obj = newlocale(LC_ALL_MASK, "C", NULL);
500 =for apidoc nothreadhook
502 Stub that provides thread hook for perl_destruct when there are
509 Perl_nothreadhook(pTHX)
515 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
517 Perl_dump_sv_child(pTHX_ SV *sv)
520 const int sock = PL_dumper_fd;
521 const int debug_fd = PerlIO_fileno(Perl_debug_log);
522 union control_un control;
525 struct cmsghdr *cmptr;
527 unsigned char buffer[256];
529 PERL_ARGS_ASSERT_DUMP_SV_CHILD;
531 if(sock == -1 || debug_fd == -1)
534 PerlIO_flush(Perl_debug_log);
536 /* All these shenanigans are to pass a file descriptor over to our child for
537 it to dump out to. We can't let it hold open the file descriptor when it
538 forks, as the file descriptor it will dump to can turn out to be one end
539 of pipe that some other process will wait on for EOF. (So as it would
540 be open, the wait would be forever.) */
542 msg.msg_control = control.control;
543 msg.msg_controllen = sizeof(control.control);
544 /* We're a connected socket so we don't need a destination */
550 cmptr = CMSG_FIRSTHDR(&msg);
551 cmptr->cmsg_len = CMSG_LEN(sizeof(int));
552 cmptr->cmsg_level = SOL_SOCKET;
553 cmptr->cmsg_type = SCM_RIGHTS;
554 *((int *)CMSG_DATA(cmptr)) = 1;
556 vec[0].iov_base = (void*)&sv;
557 vec[0].iov_len = sizeof(sv);
558 got = sendmsg(sock, &msg, 0);
561 perror("Debug leaking scalars parent sendmsg failed");
564 if(got < sizeof(sv)) {
565 perror("Debug leaking scalars parent short sendmsg");
569 /* Return protocol is
571 unsigned char: length of location string (0 for empty)
572 unsigned char*: string (not terminated)
574 vec[0].iov_base = (void*)&returned_errno;
575 vec[0].iov_len = sizeof(returned_errno);
576 vec[1].iov_base = buffer;
579 got = readv(sock, vec, 2);
582 perror("Debug leaking scalars parent read failed");
583 PerlIO_flush(PerlIO_stderr());
586 if(got < sizeof(returned_errno) + 1) {
587 perror("Debug leaking scalars parent short read");
588 PerlIO_flush(PerlIO_stderr());
593 got = read(sock, buffer + 1, *buffer);
595 perror("Debug leaking scalars parent read 2 failed");
596 PerlIO_flush(PerlIO_stderr());
601 perror("Debug leaking scalars parent short read 2");
602 PerlIO_flush(PerlIO_stderr());
607 if (returned_errno || *buffer) {
608 Perl_warn(aTHX_ "Debug leaking scalars child failed%s%.*s with errno"
609 " %d: %s", (*buffer ? " at " : ""), (int) *buffer, buffer + 1,
610 returned_errno, Strerror(returned_errno));
616 =for apidoc Am|int|perl_destruct|PerlInterpreter *my_perl
618 Shuts down a Perl interpreter. See L<perlembed> for a tutorial.
620 C<my_perl> points to the Perl interpreter. It must have been previously
621 created through the use of L</perl_alloc> and L</perl_construct>. It may
622 have been initialised through L</perl_parse>, and may have been used
623 through L</perl_run> and other means. This function should be called for
624 any Perl interpreter that has been constructed with L</perl_construct>,
625 even if subsequent operations on it failed, for example if L</perl_parse>
626 returned a non-zero value.
628 If the interpreter's C<PL_exit_flags> word has the
629 C<PERL_EXIT_DESTRUCT_END> flag set, then this function will execute code
630 in C<END> blocks before performing the rest of destruction. If it is
631 desired to make any use of the interpreter between L</perl_parse> and
632 L</perl_destruct> other than just calling L</perl_run>, then this flag
633 should be set early on. This matters if L</perl_run> will not be called,
634 or if anything else will be done in addition to calling L</perl_run>.
636 Returns a value be a suitable value to pass to the C library function
637 C<exit> (or to return from C<main>), to serve as an exit code indicating
638 the nature of the way the interpreter terminated. This takes into account
639 any failure of L</perl_parse> and any early exit from L</perl_run>.
640 The exit code is of the type required by the host operating system,
641 so because of differing exit code conventions it is not portable to
642 interpret specific numeric values as having specific meanings.
651 volatile signed char destruct_level; /* see possible values in intrpvar.h */
653 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
658 PERL_ARGS_ASSERT_PERL_DESTRUCT;
660 PERL_UNUSED_ARG(my_perl);
663 assert(PL_scopestack_ix == 1);
665 /* wait for all pseudo-forked children to finish */
666 PERL_WAIT_FOR_CHILDREN;
668 destruct_level = PL_perl_destruct_level;
669 #if defined(DEBUGGING) || defined(PERL_TRACK_MEMPOOL)
671 const char * const s = PerlEnv_getenv("PERL_DESTRUCT_LEVEL");
674 if (strEQ(s, "-1")) { /* Special case: modperl folklore. */
678 if (grok_atoUV(s, &uv, NULL) && uv <= INT_MAX)
684 if (destruct_level < i) destruct_level = i;
686 #ifdef PERL_TRACK_MEMPOOL
687 /* RT #114496, for perl_free */
688 PL_perl_destruct_level = i;
694 if (PL_exit_flags & PERL_EXIT_DESTRUCT_END) {
700 if (PL_endav && !PL_minus_c) {
701 PERL_SET_PHASE(PERL_PHASE_END);
702 call_list(PL_scopestack_ix, PL_endav);
708 assert(PL_scopestack_ix == 0);
710 /* Need to flush since END blocks can produce output */
711 /* flush stdout separately, since we can identify it */
714 PerlIO *stdo = PerlIO_stdout();
715 if (*stdo && PerlIO_flush(stdo)) {
716 PerlIO_restore_errno(stdo);
718 PerlIO_printf(PerlIO_stderr(), "Unable to flush stdout: %s\n",
727 #ifdef PERL_TRACE_OPS
728 /* dump OP-counts if $ENV{PERL_TRACE_OPS} > 0 */
730 const char * const ptoenv = PerlEnv_getenv("PERL_TRACE_OPS");
733 if (!ptoenv || !Perl_grok_atoUV(ptoenv, &uv, NULL)
737 PerlIO_printf(Perl_debug_log, "Trace of all OPs executed:\n");
738 for (i = 0; i <= OP_max; ++i) {
739 if (PL_op_exec_cnt[i])
740 PerlIO_printf(Perl_debug_log, " %s: %" UVuf "\n", PL_op_name[i], PL_op_exec_cnt[i]);
742 /* Utility slot for easily doing little tracing experiments in the runloop: */
743 if (PL_op_exec_cnt[OP_max+1] != 0)
744 PerlIO_printf(Perl_debug_log, " SPECIAL: %" UVuf "\n", PL_op_exec_cnt[OP_max+1]);
745 PerlIO_printf(Perl_debug_log, "\n");
750 if (PL_threadhook(aTHX)) {
751 /* Threads hook has vetoed further cleanup */
752 PL_veto_cleanup = TRUE;
756 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
757 if (destruct_level != 0) {
758 /* Fork here to create a child. Our child's job is to preserve the
759 state of scalars prior to destruction, so that we can instruct it
760 to dump any scalars that we later find have leaked.
761 There's no subtlety in this code - it assumes POSIX, and it doesn't
765 if(PerlSock_socketpair_cloexec(AF_UNIX, SOCK_STREAM, 0, fd)) {
766 perror("Debug leaking scalars socketpair failed");
772 perror("Debug leaking scalars fork failed");
776 /* We are the child */
777 const int sock = fd[1];
778 const int debug_fd = PerlIO_fileno(Perl_debug_log);
781 /* Our success message is an integer 0, and a char 0 */
782 static const char success[sizeof(int) + 1] = {0};
786 /* We need to close all other file descriptors otherwise we end up
787 with interesting hangs, where the parent closes its end of a
788 pipe, and sits waiting for (another) child to terminate. Only
789 that child never terminates, because it never gets EOF, because
790 we also have the far end of the pipe open. We even need to
791 close the debugging fd, because sometimes it happens to be one
792 end of a pipe, and a process is waiting on the other end for
793 EOF. Normally it would be closed at some point earlier in
794 destruction, but if we happen to cause the pipe to remain open,
795 EOF never occurs, and we get an infinite hang. Hence all the
796 games to pass in a file descriptor if it's actually needed. */
798 f = sysconf(_SC_OPEN_MAX);
800 where = "sysconf failed";
811 union control_un control;
814 struct cmsghdr *cmptr;
818 msg.msg_control = control.control;
819 msg.msg_controllen = sizeof(control.control);
820 /* We're a connected socket so we don't need a source */
824 msg.msg_iovlen = C_ARRAY_LENGTH(vec);
826 vec[0].iov_base = (void*)⌖
827 vec[0].iov_len = sizeof(target);
829 got = recvmsg(sock, &msg, 0);
834 where = "recv failed";
837 if(got < sizeof(target)) {
838 where = "short recv";
842 if(!(cmptr = CMSG_FIRSTHDR(&msg))) {
846 if(cmptr->cmsg_len != CMSG_LEN(sizeof(int))) {
847 where = "wrong cmsg_len";
850 if(cmptr->cmsg_level != SOL_SOCKET) {
851 where = "wrong cmsg_level";
854 if(cmptr->cmsg_type != SCM_RIGHTS) {
855 where = "wrong cmsg_type";
859 got_fd = *(int*)CMSG_DATA(cmptr);
860 /* For our last little bit of trickery, put the file descriptor
861 back into Perl_debug_log, as if we never actually closed it
863 if(got_fd != debug_fd) {
864 if (PerlLIO_dup2_cloexec(got_fd, debug_fd) == -1) {
871 PerlIO_flush(Perl_debug_log);
873 got = write(sock, &success, sizeof(success));
876 where = "write failed";
879 if(got < sizeof(success)) {
880 where = "short write";
887 int send_errno = errno;
888 unsigned char length = (unsigned char) strlen(where);
889 struct iovec failure[3] = {
890 {(void*)&send_errno, sizeof(send_errno)},
892 {(void*)where, length}
894 int got = writev(sock, failure, 3);
895 /* Bad news travels fast. Faster than data. We'll get a SIGPIPE
896 in the parent if we try to read from the socketpair after the
897 child has exited, even if there was data to read.
898 So sleep a bit to give the parent a fighting chance of
901 _exit((got == -1) ? errno : 0);
905 PL_dumper_fd = fd[0];
910 /* We must account for everything. */
912 /* Destroy the main CV and syntax tree */
913 /* Set PL_curcop now, because destroying ops can cause new SVs
914 to be generated in Perl_pad_swipe, and when running with
915 -DDEBUG_LEAKING_SCALARS they expect PL_curcop to point to a valid
916 op from which the filename structure member is copied. */
917 PL_curcop = &PL_compiling;
919 /* ensure comppad/curpad to refer to main's pad */
920 if (CvPADLIST(PL_main_cv)) {
921 PAD_SET_CUR_NOSAVE(CvPADLIST(PL_main_cv), 1);
922 PL_comppad_name = PadlistNAMES(CvPADLIST(PL_main_cv));
924 op_free(PL_main_root);
927 PL_main_start = NULL;
928 /* note that PL_main_cv isn't usually actually freed at this point,
929 * due to the CvOUTSIDE refs from subs compiled within it. It will
930 * get freed once all the subs are freed in sv_clean_all(), for
931 * destruct_level > 0 */
932 SvREFCNT_dec(PL_main_cv);
934 PERL_SET_PHASE(PERL_PHASE_DESTRUCT);
936 /* Tell PerlIO we are about to tear things apart in case
937 we have layers which are using resources that should
941 PerlIO_destruct(aTHX);
944 * Try to destruct global references. We do this first so that the
945 * destructors and destructees still exist. Some sv's might remain.
946 * Non-referenced objects are on their own.
950 /* unhook hooks which will soon be, or use, destroyed data */
951 SvREFCNT_dec(PL_warnhook);
953 SvREFCNT_dec(PL_diehook);
956 /* call exit list functions */
957 while (PL_exitlistlen-- > 0)
958 PL_exitlist[PL_exitlistlen].fn(aTHX_ PL_exitlist[PL_exitlistlen].ptr);
960 Safefree(PL_exitlist);
965 SvREFCNT_dec(PL_registered_mros);
967 /* jettison our possibly duplicated environment */
968 /* if PERL_USE_SAFE_PUTENV is defined environ will not have been copied
969 * so we certainly shouldn't free it here
972 #if defined(USE_ENVIRON_ARRAY) && !defined(PERL_USE_SAFE_PUTENV)
973 if (environ != PL_origenviron && !PL_use_safe_putenv
975 /* only main thread can free environ[0] contents */
976 && PL_curinterp == aTHX
982 for (i = 0; environ[i]; i++)
983 safesysfree(environ[i]);
985 /* Must use safesysfree() when working with environ. */
986 safesysfree(environ);
988 environ = PL_origenviron;
991 #endif /* !PERL_MICRO */
993 if (destruct_level == 0) {
995 DEBUG_P(debprofdump());
997 #if defined(PERLIO_LAYERS)
998 /* No more IO - including error messages ! */
999 PerlIO_cleanup(aTHX);
1002 CopFILE_free(&PL_compiling);
1004 /* The exit() function will do everything that needs doing. */
1008 /* Below, do clean up for when PERL_DESTRUCT_LEVEL is not 0 */
1011 /* the syntax tree is shared between clones
1012 * so op_free(PL_main_root) only ReREFCNT_dec's
1013 * REGEXPs in the parent interpreter
1014 * we need to manually ReREFCNT_dec for the clones
1017 I32 i = AvFILLp(PL_regex_padav);
1018 SV **ary = AvARRAY(PL_regex_padav);
1021 SvREFCNT_dec(ary[i]);
1022 ary[i] = &PL_sv_undef;
1028 SvREFCNT_dec(MUTABLE_SV(PL_stashcache));
1029 PL_stashcache = NULL;
1031 /* loosen bonds of global variables */
1033 /* XXX can PL_parser still be non-null here? */
1034 if(PL_parser && PL_parser->rsfp) {
1035 (void)PerlIO_close(PL_parser->rsfp);
1036 PL_parser->rsfp = NULL;
1040 Safefree(PL_splitstr);
1050 PL_doswitches = FALSE;
1051 PL_dowarn = G_WARN_OFF;
1052 #ifdef PERL_SAWAMPERSAND
1053 PL_sawampersand = 0; /* must save all match strings */
1057 Safefree(PL_inplace);
1059 SvREFCNT_dec(PL_patchlevel);
1062 SvREFCNT_dec(PL_e_script);
1068 /* magical thingies */
1070 SvREFCNT_dec(PL_ofsgv); /* *, */
1073 SvREFCNT_dec(PL_ors_sv); /* $\ */
1076 SvREFCNT_dec(PL_rs); /* $/ */
1079 Safefree(PL_osname); /* $^O */
1082 SvREFCNT_dec(PL_statname);
1086 /* defgv, aka *_ should be taken care of elsewhere */
1089 Safefree(PL_efloatbuf);
1090 PL_efloatbuf = NULL;
1093 /* startup and shutdown function lists */
1094 SvREFCNT_dec(PL_beginav);
1095 SvREFCNT_dec(PL_beginav_save);
1096 SvREFCNT_dec(PL_endav);
1097 SvREFCNT_dec(PL_checkav);
1098 SvREFCNT_dec(PL_checkav_save);
1099 SvREFCNT_dec(PL_unitcheckav);
1100 SvREFCNT_dec(PL_unitcheckav_save);
1101 SvREFCNT_dec(PL_initav);
1103 PL_beginav_save = NULL;
1106 PL_checkav_save = NULL;
1107 PL_unitcheckav = NULL;
1108 PL_unitcheckav_save = NULL;
1111 /* shortcuts just get cleared */
1114 PL_argvoutgv = NULL;
1117 PL_last_in_gv = NULL;
1128 SvREFCNT_dec(PL_envgv);
1129 SvREFCNT_dec(PL_incgv);
1130 SvREFCNT_dec(PL_argvgv);
1131 SvREFCNT_dec(PL_replgv);
1132 SvREFCNT_dec(PL_DBgv);
1133 SvREFCNT_dec(PL_DBline);
1134 SvREFCNT_dec(PL_DBsub);
1143 SvREFCNT_dec(PL_argvout_stack);
1144 PL_argvout_stack = NULL;
1146 SvREFCNT_dec(PL_modglobal);
1147 PL_modglobal = NULL;
1148 SvREFCNT_dec(PL_preambleav);
1149 PL_preambleav = NULL;
1150 SvREFCNT_dec(PL_subname);
1152 #ifdef PERL_USES_PL_PIDSTATUS
1153 SvREFCNT_dec(PL_pidstatus);
1154 PL_pidstatus = NULL;
1156 SvREFCNT_dec(PL_toptarget);
1157 PL_toptarget = NULL;
1158 SvREFCNT_dec(PL_bodytarget);
1159 PL_bodytarget = NULL;
1160 PL_formtarget = NULL;
1162 /* free locale stuff */
1163 #ifdef USE_LOCALE_COLLATE
1164 Safefree(PL_collation_name);
1165 PL_collation_name = NULL;
1167 #if defined(USE_POSIX_2008_LOCALE) \
1168 && defined(USE_THREAD_SAFE_LOCALE) \
1169 && ! defined(HAS_QUERYLOCALE)
1170 for (i = 0; i < (int) C_ARRAY_LENGTH(PL_curlocales); i++) {
1171 Safefree(PL_curlocales[i]);
1172 PL_curlocales[i] = NULL;
1175 #ifdef HAS_POSIX_2008_LOCALE
1177 /* This also makes sure we aren't using a locale object that gets freed
1179 const locale_t old_locale = uselocale(LC_GLOBAL_LOCALE);
1180 if (old_locale != LC_GLOBAL_LOCALE) {
1181 freelocale(old_locale);
1184 # ifdef USE_LOCALE_NUMERIC
1185 if (PL_underlying_numeric_obj) {
1186 freelocale(PL_underlying_numeric_obj);
1187 PL_underlying_numeric_obj = (locale_t) NULL;
1191 #ifdef USE_LOCALE_NUMERIC
1192 Safefree(PL_numeric_name);
1193 PL_numeric_name = NULL;
1194 SvREFCNT_dec(PL_numeric_radix_sv);
1195 PL_numeric_radix_sv = NULL;
1198 if (PL_setlocale_buf) {
1199 Safefree(PL_setlocale_buf);
1200 PL_setlocale_buf = NULL;
1203 if (PL_langinfo_buf) {
1204 Safefree(PL_langinfo_buf);
1205 PL_langinfo_buf = NULL;
1208 /* clear character classes */
1209 SvREFCNT_dec(PL_utf8_mark);
1210 SvREFCNT_dec(PL_InBitmap);
1211 #ifdef USE_LOCALE_CTYPE
1212 SvREFCNT_dec(PL_warn_locale);
1214 PL_utf8_mark = NULL;
1216 #ifdef USE_LOCALE_CTYPE
1217 PL_warn_locale = NULL;
1220 if (!specialWARN(PL_compiling.cop_warnings))
1221 PerlMemShared_free(PL_compiling.cop_warnings);
1222 PL_compiling.cop_warnings = NULL;
1223 cophh_free(CopHINTHASH_get(&PL_compiling));
1224 CopHINTHASH_set(&PL_compiling, cophh_new_empty());
1225 CopFILE_free(&PL_compiling);
1227 /* Prepare to destruct main symbol table. */
1230 /* break ref loop *:: <=> %:: */
1231 (void)hv_deletes(hv, "main::", G_DISCARD);
1234 SvREFCNT_dec(PL_curstname);
1235 PL_curstname = NULL;
1237 /* clear queued errors */
1238 SvREFCNT_dec(PL_errors);
1241 SvREFCNT_dec(PL_isarev);
1244 if (destruct_level >= 2) {
1245 if (PL_scopestack_ix != 0)
1246 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
1247 "Unbalanced scopes: %ld more ENTERs than LEAVEs\n",
1248 (long)PL_scopestack_ix);
1249 if (PL_savestack_ix != 0)
1250 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
1251 "Unbalanced saves: %ld more saves than restores\n",
1252 (long)PL_savestack_ix);
1253 if (PL_tmps_floor != -1)
1254 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced tmps: %ld more allocs than frees\n",
1255 (long)PL_tmps_floor + 1);
1256 if (cxstack_ix != -1)
1257 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced context: %ld more PUSHes than POPs\n",
1258 (long)cxstack_ix + 1);
1262 SvREFCNT_dec(PL_regex_padav);
1263 PL_regex_padav = NULL;
1264 PL_regex_pad = NULL;
1267 #ifdef PERL_IMPLICIT_CONTEXT
1268 /* the entries in this list are allocated via SV PVX's, so get freed
1269 * in sv_clean_all */
1270 Safefree(PL_my_cxt_list);
1273 /* Now absolutely destruct everything, somehow or other, loops or no. */
1275 /* the 2 is for PL_fdpid and PL_strtab */
1276 while (sv_clean_all() > 2)
1280 Safefree(PL_stashpad); /* must come after sv_clean_all */
1283 AvREAL_off(PL_fdpid); /* no surviving entries */
1284 SvREFCNT_dec(PL_fdpid); /* needed in io_close() */
1287 #ifdef HAVE_INTERP_INTERN
1291 /* constant strings */
1292 for (i = 0; i < SV_CONSTS_COUNT; i++) {
1293 SvREFCNT_dec(PL_sv_consts[i]);
1294 PL_sv_consts[i] = NULL;
1297 /* Destruct the global string table. */
1299 /* Yell and reset the HeVAL() slots that are still holding refcounts,
1300 * so that sv_free() won't fail on them.
1301 * Now that the global string table is using a single hunk of memory
1302 * for both HE and HEK, we either need to explicitly unshare it the
1303 * correct way, or actually free things here.
1306 const I32 max = HvMAX(PL_strtab);
1307 HE * const * const array = HvARRAY(PL_strtab);
1308 HE *hent = array[0];
1311 if (hent && ckWARN_d(WARN_INTERNAL)) {
1312 HE * const next = HeNEXT(hent);
1313 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
1314 "Unbalanced string table refcount: (%ld) for \"%s\"",
1315 (long)hent->he_valu.hent_refcount, HeKEY(hent));
1322 hent = array[riter];
1327 HvARRAY(PL_strtab) = 0;
1328 HvTOTALKEYS(PL_strtab) = 0;
1330 SvREFCNT_dec(PL_strtab);
1333 /* free the pointer tables used for cloning */
1334 ptr_table_free(PL_ptr_table);
1335 PL_ptr_table = (PTR_TBL_t*)NULL;
1338 /* free special SVs */
1340 SvREFCNT(&PL_sv_yes) = 0;
1341 sv_clear(&PL_sv_yes);
1342 SvANY(&PL_sv_yes) = NULL;
1343 SvFLAGS(&PL_sv_yes) = 0;
1345 SvREFCNT(&PL_sv_no) = 0;
1346 sv_clear(&PL_sv_no);
1347 SvANY(&PL_sv_no) = NULL;
1348 SvFLAGS(&PL_sv_no) = 0;
1350 SvREFCNT(&PL_sv_zero) = 0;
1351 sv_clear(&PL_sv_zero);
1352 SvANY(&PL_sv_zero) = NULL;
1353 SvFLAGS(&PL_sv_zero) = 0;
1357 for (i=0; i<=2; i++) {
1358 SvREFCNT(PERL_DEBUG_PAD(i)) = 0;
1359 sv_clear(PERL_DEBUG_PAD(i));
1360 SvANY(PERL_DEBUG_PAD(i)) = NULL;
1361 SvFLAGS(PERL_DEBUG_PAD(i)) = 0;
1365 if (PL_sv_count != 0 && ckWARN_d(WARN_INTERNAL))
1366 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Scalars leaked: %ld\n", (long)PL_sv_count);
1368 #ifdef DEBUG_LEAKING_SCALARS
1369 if (PL_sv_count != 0) {
1374 for (sva = PL_sv_arenaroot; sva; sva = MUTABLE_SV(SvANY(sva))) {
1375 svend = &sva[SvREFCNT(sva)];
1376 for (sv = sva + 1; sv < svend; ++sv) {
1377 if (SvTYPE(sv) != (svtype)SVTYPEMASK) {
1378 PerlIO_printf(Perl_debug_log, "leaked: sv=0x%p"
1380 " refcnt=%"UVuf pTHX__FORMAT "\n"
1381 "\tallocated at %s:%d %s %s (parent 0x%" UVxf ");"
1382 "serial %" UVuf "\n",
1383 (void*)sv, (UV)sv->sv_flags, (UV)sv->sv_refcnt
1385 sv->sv_debug_file ? sv->sv_debug_file : "(unknown)",
1387 sv->sv_debug_inpad ? "for" : "by",
1388 sv->sv_debug_optype ?
1389 PL_op_name[sv->sv_debug_optype]: "(none)",
1390 PTR2UV(sv->sv_debug_parent),
1393 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1394 Perl_dump_sv_child(aTHX_ sv);
1400 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1404 /* Wait for up to 4 seconds for child to terminate.
1405 This seems to be the least effort way of timing out on reaping
1407 struct timeval waitfor = {4, 0};
1408 int sock = PL_dumper_fd;
1412 FD_SET(sock, &rset);
1413 select(sock + 1, &rset, NULL, NULL, &waitfor);
1414 waitpid(child, &status, WNOHANG);
1419 #ifdef DEBUG_LEAKING_SCALARS_ABORT
1425 #if defined(PERLIO_LAYERS)
1426 /* No more IO - including error messages ! */
1427 PerlIO_cleanup(aTHX);
1430 /* sv_undef needs to stay immortal until after PerlIO_cleanup
1431 as currently layers use it rather than NULL as a marker
1432 for no arg - and will try and SvREFCNT_dec it.
1434 SvREFCNT(&PL_sv_undef) = 0;
1435 SvREADONLY_off(&PL_sv_undef);
1437 Safefree(PL_origfilename);
1438 PL_origfilename = NULL;
1439 Safefree(PL_reg_curpm);
1440 free_tied_hv_pool();
1441 Safefree(PL_op_mask);
1442 Safefree(PL_psig_name);
1443 PL_psig_name = (SV**)NULL;
1444 PL_psig_ptr = (SV**)NULL;
1446 /* We need to NULL PL_psig_pend first, so that
1447 signal handlers know not to use it */
1448 int *psig_save = PL_psig_pend;
1449 PL_psig_pend = (int*)NULL;
1450 Safefree(psig_save);
1453 TAINTING_set(FALSE);
1454 TAINT_WARN_set(FALSE);
1455 PL_hints = 0; /* Reset hints. Should hints be per-interpreter ? */
1457 DEBUG_P(debprofdump());
1461 #ifdef USE_REENTRANT_API
1462 Perl_reentrant_free(aTHX);
1465 /* These all point to HVs that are about to be blown away.
1466 Code in core and on CPAN assumes that if the interpreter is re-started
1467 that they will be cleanly NULL or pointing to a valid HV. */
1468 PL_custom_op_names = NULL;
1469 PL_custom_op_descs = NULL;
1470 PL_custom_ops = NULL;
1474 while (PL_regmatch_slab) {
1475 regmatch_slab *s = PL_regmatch_slab;
1476 PL_regmatch_slab = PL_regmatch_slab->next;
1480 /* As the absolutely last thing, free the non-arena SV for mess() */
1483 /* we know that type == SVt_PVMG */
1485 /* it could have accumulated taint magic */
1488 for (mg = SvMAGIC(PL_mess_sv); mg; mg = moremagic) {
1489 moremagic = mg->mg_moremagic;
1490 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global
1492 Safefree(mg->mg_ptr);
1496 /* we know that type >= SVt_PV */
1497 SvPV_free(PL_mess_sv);
1498 Safefree(SvANY(PL_mess_sv));
1499 Safefree(PL_mess_sv);
1506 =for apidoc perl_free
1508 Releases a Perl interpreter. See L<perlembed>.
1518 PERL_ARGS_ASSERT_PERL_FREE;
1520 if (PL_veto_cleanup)
1523 #ifdef PERL_TRACK_MEMPOOL
1526 * Don't free thread memory if PERL_DESTRUCT_LEVEL is set to a non-zero
1527 * value as we're probably hunting memory leaks then
1529 if (PL_perl_destruct_level == 0) {
1530 const U32 old_debug = PL_debug;
1531 /* Emulate the PerlHost behaviour of free()ing all memory allocated in this
1532 thread at thread exit. */
1534 PerlIO_puts(Perl_debug_log, "Disabling memory debugging as we "
1535 "free this thread's memory\n");
1536 PL_debug &= ~ DEBUG_m_FLAG;
1538 while(aTHXx->Imemory_debug_header.next != &(aTHXx->Imemory_debug_header)){
1539 char * next = (char *)(aTHXx->Imemory_debug_header.next);
1540 Malloc_t ptr = PERL_MEMORY_DEBUG_HEADER_SIZE + next;
1543 PL_debug = old_debug;
1548 #if defined(WIN32) || defined(NETWARE)
1549 # if defined(PERL_IMPLICIT_SYS)
1552 void *host = nw_internal_host;
1553 PerlMem_free(aTHXx);
1554 nw_delete_internal_host(host);
1556 void *host = w32_internal_host;
1557 PerlMem_free(aTHXx);
1558 win32_delete_internal_host(host);
1562 PerlMem_free(aTHXx);
1565 PerlMem_free(aTHXx);
1569 #if defined(USE_ITHREADS)
1570 /* provide destructors to clean up the thread key when libperl is unloaded */
1571 #ifndef WIN32 /* handled during DLL_PROCESS_DETACH in win32/perllib.c */
1573 #if defined(__hpux) && !(defined(__ux_version) && __ux_version <= 1020) && !defined(__GNUC__)
1574 #pragma fini "perl_fini"
1575 #elif defined(__sun) && !defined(__GNUC__)
1576 #pragma fini (perl_fini)
1580 #if defined(__GNUC__)
1581 __attribute__((destructor))
1587 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
1590 PL_curinterp && !PL_veto_cleanup)
1595 #endif /* THREADS */
1598 Perl_call_atexit(pTHX_ ATEXIT_t fn, void *ptr)
1600 Renew(PL_exitlist, PL_exitlistlen+1, PerlExitListEntry);
1601 PL_exitlist[PL_exitlistlen].fn = fn;
1602 PL_exitlist[PL_exitlistlen].ptr = ptr;
1607 =for apidoc Am|int|perl_parse|PerlInterpreter *my_perl|XSINIT_t xsinit|int argc|char **argv|char **env
1609 Tells a Perl interpreter to parse a Perl script. This performs most
1610 of the initialisation of a Perl interpreter. See L<perlembed> for
1613 C<my_perl> points to the Perl interpreter that is to parse the script.
1614 It must have been previously created through the use of L</perl_alloc>
1615 and L</perl_construct>. C<xsinit> points to a callback function that
1616 will be called to set up the ability for this Perl interpreter to load
1617 XS extensions, or may be null to perform no such setup.
1619 C<argc> and C<argv> supply a set of command-line arguments to the Perl
1620 interpreter, as would normally be passed to the C<main> function of
1621 a C program. C<argv[argc]> must be null. These arguments are where
1622 the script to parse is specified, either by naming a script file or by
1623 providing a script in a C<-e> option.
1624 If L<C<$0>|perlvar/$0> will be written to in the Perl interpreter, then
1625 the argument strings must be in writable memory, and so mustn't just be
1628 C<env> specifies a set of environment variables that will be used by
1629 this Perl interpreter. If non-null, it must point to a null-terminated
1630 array of environment strings. If null, the Perl interpreter will use
1631 the environment supplied by the C<environ> global variable.
1633 This function initialises the interpreter, and parses and compiles the
1634 script specified by the command-line arguments. This includes executing
1635 code in C<BEGIN>, C<UNITCHECK>, and C<CHECK> blocks. It does not execute
1636 C<INIT> blocks or the main program.
1638 Returns an integer of slightly tricky interpretation. The correct
1639 use of the return value is as a truth value indicating whether there
1640 was a failure in initialisation. If zero is returned, this indicates
1641 that initialisation was successful, and it is safe to proceed to call
1642 L</perl_run> and make other use of it. If a non-zero value is returned,
1643 this indicates some problem that means the interpreter wants to terminate.
1644 The interpreter should not be just abandoned upon such failure; the caller
1645 should proceed to shut the interpreter down cleanly with L</perl_destruct>
1646 and free it with L</perl_free>.
1648 For historical reasons, the non-zero return value also attempts to
1649 be a suitable value to pass to the C library function C<exit> (or to
1650 return from C<main>), to serve as an exit code indicating the nature
1651 of the way initialisation terminated. However, this isn't portable,
1652 due to differing exit code conventions. A historical bug is preserved
1653 for the time being: if the Perl built-in C<exit> is called during this
1654 function's execution, with a type of exit entailing a zero exit code
1655 under the host operating system's conventions, then this function
1656 returns zero rather than a non-zero value. This bug, [perl #2754],
1657 leads to C<perl_run> being called (and therefore C<INIT> blocks and the
1658 main program running) despite a call to C<exit>. It has been preserved
1659 because a popular module-installing module has come to rely on it and
1660 needs time to be fixed. This issue is [perl #132577], and the original
1661 bug is due to be fixed in Perl 5.30.
1666 #define SET_CURSTASH(newstash) \
1667 if (PL_curstash != newstash) { \
1668 SvREFCNT_dec(PL_curstash); \
1669 PL_curstash = (HV *)SvREFCNT_inc(newstash); \
1673 perl_parse(pTHXx_ XSINIT_t xsinit, int argc, char **argv, char **env)
1680 PERL_ARGS_ASSERT_PERL_PARSE;
1681 #ifndef MULTIPLICITY
1682 PERL_UNUSED_ARG(my_perl);
1684 #if (defined(USE_HASH_SEED) || defined(USE_HASH_SEED_DEBUG)) && !defined(NO_PERL_HASH_SEED_DEBUG)
1686 const char * const s = PerlEnv_getenv("PERL_HASH_SEED_DEBUG");
1688 if (s && strEQ(s, "1")) {
1689 const unsigned char *seed= PERL_HASH_SEED;
1690 const unsigned char *seed_end= PERL_HASH_SEED + PERL_HASH_SEED_BYTES;
1691 PerlIO_printf(Perl_debug_log, "HASH_FUNCTION = %s HASH_SEED = 0x", PERL_HASH_FUNC);
1692 while (seed < seed_end) {
1693 PerlIO_printf(Perl_debug_log, "%02x", *seed++);
1695 #ifdef PERL_HASH_RANDOMIZE_KEYS
1696 PerlIO_printf(Perl_debug_log, " PERTURB_KEYS = %d (%s)",
1697 PL_HASH_RAND_BITS_ENABLED,
1698 PL_HASH_RAND_BITS_ENABLED == 0 ? "NO" : PL_HASH_RAND_BITS_ENABLED == 1 ? "RANDOM" : "DETERMINISTIC");
1700 PerlIO_printf(Perl_debug_log, "\n");
1703 #endif /* #if (defined(USE_HASH_SEED) ... */
1707 struct NameTranslationInfo nti;
1708 __translate_amiga_to_unix_path_name(&argv[0],&nti);
1715 for(i = 0; i != argc; i++)
1717 assert(!argv[argc]);
1722 if (PL_origalen != 0) {
1723 PL_origalen = 1; /* don't use old PL_origalen if perl_parse() is called again */
1726 /* Set PL_origalen be the sum of the contiguous argv[]
1727 * elements plus the size of the env in case that it is
1728 * contiguous with the argv[]. This is used in mg.c:Perl_magic_set()
1729 * as the maximum modifiable length of $0. In the worst case
1730 * the area we are able to modify is limited to the size of
1731 * the original argv[0]. (See below for 'contiguous', though.)
1733 const char *s = NULL;
1734 const UV mask = ~(UV)(PTRSIZE-1);
1735 /* Do the mask check only if the args seem like aligned. */
1737 (mask < ~(UV)0) && ((PTR2UV(argv[0]) & mask) == PTR2UV(argv[0]));
1739 /* See if all the arguments are contiguous in memory. Note
1740 * that 'contiguous' is a loose term because some platforms
1741 * align the argv[] and the envp[]. If the arguments look
1742 * like non-aligned, assume that they are 'strictly' or
1743 * 'traditionally' contiguous. If the arguments look like
1744 * aligned, we just check that they are within aligned
1745 * PTRSIZE bytes. As long as no system has something bizarre
1746 * like the argv[] interleaved with some other data, we are
1747 * fine. (Did I just evoke Murphy's Law?) --jhi */
1748 if (PL_origargv && PL_origargc >= 1 && (s = PL_origargv[0])) {
1751 for (i = 1; i < PL_origargc; i++) {
1752 if ((PL_origargv[i] == s + 1
1754 || PL_origargv[i] == s + 2
1759 (PL_origargv[i] > s &&
1761 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1772 #ifndef PERL_USE_SAFE_PUTENV
1773 /* Can we grab env area too to be used as the area for $0? */
1774 if (s && PL_origenviron && !PL_use_safe_putenv) {
1775 if ((PL_origenviron[0] == s + 1)
1778 (PL_origenviron[0] > s &&
1779 PL_origenviron[0] <=
1780 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1784 #ifndef OS2 /* ENVIRON is read by the kernel too. */
1785 s = PL_origenviron[0];
1788 my_setenv("NoNe SuCh", NULL);
1789 /* Force copy of environment. */
1790 for (i = 1; PL_origenviron[i]; i++) {
1791 if (PL_origenviron[i] == s + 1
1794 (PL_origenviron[i] > s &&
1795 PL_origenviron[i] <=
1796 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1799 s = PL_origenviron[i];
1807 #endif /* !defined(PERL_USE_SAFE_PUTENV) */
1809 PL_origalen = s ? s - PL_origargv[0] + 1 : 0;
1814 /* Come here if running an undumped a.out. */
1816 PL_origfilename = savepv(argv[0]);
1817 PL_do_undump = FALSE;
1818 cxstack_ix = -1; /* start label stack again */
1820 assert (!TAINT_get);
1824 init_postdump_symbols(argc,argv,env);
1829 op_free(PL_main_root);
1830 PL_main_root = NULL;
1832 PL_main_start = NULL;
1833 SvREFCNT_dec(PL_main_cv);
1837 oldscope = PL_scopestack_ix;
1838 PL_dowarn = G_WARN_OFF;
1843 parse_body(env,xsinit);
1844 if (PL_unitcheckav) {
1845 call_list(oldscope, PL_unitcheckav);
1848 PERL_SET_PHASE(PERL_PHASE_CHECK);
1849 call_list(oldscope, PL_checkav);
1857 /* my_exit() was called */
1858 while (PL_scopestack_ix > oldscope)
1861 SET_CURSTASH(PL_defstash);
1862 if (PL_unitcheckav) {
1863 call_list(oldscope, PL_unitcheckav);
1866 PERL_SET_PHASE(PERL_PHASE_CHECK);
1867 call_list(oldscope, PL_checkav);
1872 * At this point we should do
1874 * to avoid [perl #2754], but that bugfix has been postponed
1875 * because of the Module::Install breakage it causes
1881 PerlIO_printf(Perl_error_log, "panic: top_env\n");
1889 /* This needs to stay in perl.c, as perl.c is compiled with different flags for
1890 miniperl, and we need to see those flags reflected in the values here. */
1892 /* What this returns is subject to change. Use the public interface in Config.
1895 S_Internals_V(pTHX_ CV *cv)
1898 #ifdef LOCAL_PATCH_COUNT
1899 const int local_patch_count = LOCAL_PATCH_COUNT;
1901 const int local_patch_count = 0;
1903 const int entries = 3 + local_patch_count;
1905 static const char non_bincompat_options[] =
1912 # ifdef NO_HASH_SEED
1915 # ifdef NO_TAINT_SUPPORT
1918 # ifdef PERL_BOOL_AS_CHAR
1919 " PERL_BOOL_AS_CHAR"
1921 # ifdef PERL_COPY_ON_WRITE
1922 " PERL_COPY_ON_WRITE"
1924 # ifdef PERL_DISABLE_PMC
1927 # ifdef PERL_DONT_CREATE_GVSV
1928 " PERL_DONT_CREATE_GVSV"
1930 # ifdef PERL_EXTERNAL_GLOB
1931 " PERL_EXTERNAL_GLOB"
1933 # ifdef PERL_HASH_FUNC_SIPHASH
1934 " PERL_HASH_FUNC_SIPHASH"
1936 # ifdef PERL_HASH_FUNC_SDBM
1937 " PERL_HASH_FUNC_SDBM"
1939 # ifdef PERL_HASH_FUNC_DJB2
1940 " PERL_HASH_FUNC_DJB2"
1942 # ifdef PERL_HASH_FUNC_SUPERFAST
1943 " PERL_HASH_FUNC_SUPERFAST"
1945 # ifdef PERL_HASH_FUNC_MURMUR3
1946 " PERL_HASH_FUNC_MURMUR3"
1948 # ifdef PERL_HASH_FUNC_ONE_AT_A_TIME
1949 " PERL_HASH_FUNC_ONE_AT_A_TIME"
1951 # ifdef PERL_HASH_FUNC_ONE_AT_A_TIME_HARD
1952 " PERL_HASH_FUNC_ONE_AT_A_TIME_HARD"
1954 # ifdef PERL_HASH_FUNC_ONE_AT_A_TIME_OLD
1955 " PERL_HASH_FUNC_ONE_AT_A_TIME_OLD"
1957 # ifdef PERL_IS_MINIPERL
1960 # ifdef PERL_MALLOC_WRAP
1963 # ifdef PERL_MEM_LOG
1966 # ifdef PERL_MEM_LOG_NOIMPL
1967 " PERL_MEM_LOG_NOIMPL"
1969 # ifdef PERL_OP_PARENT
1972 # ifdef PERL_PERTURB_KEYS_DETERMINISTIC
1973 " PERL_PERTURB_KEYS_DETERMINISTIC"
1975 # ifdef PERL_PERTURB_KEYS_DISABLED
1976 " PERL_PERTURB_KEYS_DISABLED"
1978 # ifdef PERL_PERTURB_KEYS_RANDOM
1979 " PERL_PERTURB_KEYS_RANDOM"
1981 # ifdef PERL_PRESERVE_IVUV
1982 " PERL_PRESERVE_IVUV"
1984 # ifdef PERL_RELOCATABLE_INCPUSH
1985 " PERL_RELOCATABLE_INCPUSH"
1987 # ifdef PERL_USE_DEVEL
1990 # ifdef PERL_USE_SAFE_PUTENV
1991 " PERL_USE_SAFE_PUTENV"
1993 # ifdef SILENT_NO_TAINT_SUPPORT
1994 " SILENT_NO_TAINT_SUPPORT"
1996 # ifdef UNLINK_ALL_VERSIONS
1997 " UNLINK_ALL_VERSIONS"
1999 # ifdef USE_ATTRIBUTES_FOR_PERLIO
2000 " USE_ATTRIBUTES_FOR_PERLIO"
2002 # ifdef USE_FAST_STDIO
2008 # ifdef USE_LOCALE_CTYPE
2011 # ifdef WIN32_NO_REGISTRY
2014 # ifdef USE_PERL_ATOF
2017 # ifdef USE_SITECUSTOMIZE
2018 " USE_SITECUSTOMIZE"
2021 PERL_UNUSED_ARG(cv);
2022 PERL_UNUSED_VAR(items);
2024 EXTEND(SP, entries);
2026 PUSHs(sv_2mortal(newSVpv(PL_bincompat_options, 0)));
2027 PUSHs(Perl_newSVpvn_flags(aTHX_ non_bincompat_options,
2028 sizeof(non_bincompat_options) - 1, SVs_TEMP));
2030 #ifndef PERL_BUILD_DATE
2033 # define PERL_BUILD_DATE __DATE__ " " __TIME__
2035 # define PERL_BUILD_DATE __DATE__
2040 #ifdef PERL_BUILD_DATE
2041 PUSHs(Perl_newSVpvn_flags(aTHX_
2042 STR_WITH_LEN("Compiled at " PERL_BUILD_DATE),
2045 PUSHs(&PL_sv_undef);
2048 for (i = 1; i <= local_patch_count; i++) {
2049 /* This will be an undef, if PL_localpatches[i] is NULL. */
2050 PUSHs(sv_2mortal(newSVpv(PL_localpatches[i], 0)));
2056 #define INCPUSH_UNSHIFT 0x01
2057 #define INCPUSH_ADD_OLD_VERS 0x02
2058 #define INCPUSH_ADD_VERSIONED_SUB_DIRS 0x04
2059 #define INCPUSH_ADD_ARCHONLY_SUB_DIRS 0x08
2060 #define INCPUSH_NOT_BASEDIR 0x10
2061 #define INCPUSH_CAN_RELOCATE 0x20
2062 #define INCPUSH_ADD_SUB_DIRS \
2063 (INCPUSH_ADD_VERSIONED_SUB_DIRS|INCPUSH_ADD_ARCHONLY_SUB_DIRS)
2066 S_parse_body(pTHX_ char **env, XSINIT_t xsinit)
2070 int argc = PL_origargc;
2071 char **argv = PL_origargv;
2072 const char *scriptname = NULL;
2073 bool dosearch = FALSE;
2075 bool doextract = FALSE;
2076 const char *cddir = NULL;
2077 #ifdef USE_SITECUSTOMIZE
2078 bool minus_f = FALSE;
2080 SV *linestr_sv = NULL;
2081 bool add_read_e_script = FALSE;
2082 U32 lex_start_flags = 0;
2084 PERL_SET_PHASE(PERL_PHASE_START);
2090 for (argc--,argv++; argc > 0; argc--,argv++) {
2091 if (argv[0][0] != '-' || !argv[0][1])
2097 #ifndef PERL_STRICT_CR
2121 if ((s = moreswitches(s)))
2126 #if defined(SILENT_NO_TAINT_SUPPORT)
2127 /* silently ignore */
2128 #elif defined(NO_TAINT_SUPPORT)
2129 Perl_croak_nocontext("This perl was compiled without taint support. "
2130 "Cowardly refusing to run with -t or -T flags");
2132 CHECK_MALLOC_TOO_LATE_FOR('t');
2133 if( !TAINTING_get ) {
2134 TAINT_WARN_set(TRUE);
2141 #if defined(SILENT_NO_TAINT_SUPPORT)
2142 /* silently ignore */
2143 #elif defined(NO_TAINT_SUPPORT)
2144 Perl_croak_nocontext("This perl was compiled without taint support. "
2145 "Cowardly refusing to run with -t or -T flags");
2147 CHECK_MALLOC_TOO_LATE_FOR('T');
2149 TAINT_WARN_set(FALSE);
2158 forbid_setid('e', FALSE);
2160 PL_e_script = newSVpvs("");
2161 add_read_e_script = TRUE;
2164 sv_catpv(PL_e_script, s);
2166 sv_catpv(PL_e_script, argv[1]);
2170 Perl_croak(aTHX_ "No code specified for -%c", c);
2171 sv_catpvs(PL_e_script, "\n");
2175 #ifdef USE_SITECUSTOMIZE
2181 case 'I': /* -I handled both here and in moreswitches() */
2182 forbid_setid('I', FALSE);
2183 if (!*++s && (s=argv[1]) != NULL) {
2187 STRLEN len = strlen(s);
2188 incpush(s, len, INCPUSH_ADD_SUB_DIRS|INCPUSH_ADD_OLD_VERS);
2191 Perl_croak(aTHX_ "No directory specified for -I");
2194 forbid_setid('S', FALSE);
2203 opts_prog = newSVpvs("use Config; Config::_V()");
2207 opts_prog = Perl_newSVpvf(aTHX_
2208 "use Config; Config::config_vars(qw%c%s%c)",
2212 Perl_av_create_and_push(aTHX_ &PL_preambleav, opts_prog);
2213 /* don't look for script or read stdin */
2214 scriptname = BIT_BUCKET;
2226 if (!*++s || isSPACE(*s)) {
2230 /* catch use of gnu style long options.
2231 Both of these exit immediately. */
2232 if (strEQ(s, "version"))
2234 if (strEQ(s, "help"))
2239 Perl_croak(aTHX_ "Unrecognized switch: -%s (-h will show valid options)",s);
2250 #ifndef SECURE_INTERNAL_GETENV
2253 (s = PerlEnv_getenv("PERL5OPT")))
2255 /* s points to static memory in getenv(), which may be overwritten at
2256 * any time; use a mortal copy instead */
2257 s = SvPVX(sv_2mortal(newSVpv(s, 0)));
2261 if (*s == '-' && *(s+1) == 'T') {
2262 #if defined(SILENT_NO_TAINT_SUPPORT)
2263 /* silently ignore */
2264 #elif defined(NO_TAINT_SUPPORT)
2265 Perl_croak_nocontext("This perl was compiled without taint support. "
2266 "Cowardly refusing to run with -t or -T flags");
2268 CHECK_MALLOC_TOO_LATE_FOR('T');
2270 TAINT_WARN_set(FALSE);
2274 char *popt_copy = NULL;
2287 if (!strchr("CDIMUdmtwW", *s))
2288 Perl_croak(aTHX_ "Illegal switch in PERL5OPT: -%c", *s);
2292 popt_copy = SvPVX(sv_2mortal(newSVpv(d,0)));
2293 s = popt_copy + (s - d);
2301 #if defined(SILENT_NO_TAINT_SUPPORT)
2302 /* silently ignore */
2303 #elif defined(NO_TAINT_SUPPORT)
2304 Perl_croak_nocontext("This perl was compiled without taint support. "
2305 "Cowardly refusing to run with -t or -T flags");
2307 if( !TAINTING_get) {
2308 TAINT_WARN_set(TRUE);
2320 #ifndef NO_PERL_INTERNAL_RAND_SEED
2321 /* If we're not set[ug]id, we might have honored
2322 PERL_INTERNAL_RAND_SEED in perl_construct().
2323 At this point command-line options have been parsed, so if
2324 we're now tainting and not set[ug]id re-seed.
2325 This could possibly be wasteful if PERL_INTERNAL_RAND_SEED is invalid,
2326 but avoids duplicating the logic from perl_construct().
2329 PerlProc_getuid() == PerlProc_geteuid() &&
2330 PerlProc_getgid() == PerlProc_getegid()) {
2331 Perl_drand48_init_r(&PL_internal_random_state, seed());
2335 /* Set $^X early so that it can be used for relocatable paths in @INC */
2336 /* and for SITELIB_EXP in USE_SITECUSTOMIZE */
2337 assert (!TAINT_get);
2342 #if defined(USE_SITECUSTOMIZE)
2344 /* The games with local $! are to avoid setting errno if there is no
2345 sitecustomize script. "q%c...%c", 0, ..., 0 becomes "q\0...\0",
2346 ie a q() operator with a NUL byte as a the delimiter. This avoids
2347 problems with pathnames containing (say) ' */
2348 # ifdef PERL_IS_MINIPERL
2349 AV *const inc = GvAV(PL_incgv);
2350 SV **const inc0 = inc ? av_fetch(inc, 0, FALSE) : NULL;
2353 /* if lib/buildcustomize.pl exists, it should not fail. If it does,
2354 it should be reported immediately as a build failure. */
2355 (void)Perl_av_create_and_unshift_one(aTHX_ &PL_preambleav,
2357 "BEGIN { my $f = q%c%s%" SVf "/buildcustomize.pl%c; "
2358 "do {local $!; -f $f }"
2359 " and do $f || die $@ || qq '$f: $!' }",
2360 0, (TAINTING_get ? "./" : ""), SVfARG(*inc0), 0));
2363 /* SITELIB_EXP is a function call on Win32. */
2364 const char *const raw_sitelib = SITELIB_EXP;
2366 /* process .../.. if PERL_RELOCATABLE_INC is defined */
2367 SV *sitelib_sv = mayberelocate(raw_sitelib, strlen(raw_sitelib),
2368 INCPUSH_CAN_RELOCATE);
2369 const char *const sitelib = SvPVX(sitelib_sv);
2370 (void)Perl_av_create_and_unshift_one(aTHX_ &PL_preambleav,
2372 "BEGIN { do {local $!; -f q%c%s/sitecustomize.pl%c} && do q%c%s/sitecustomize.pl%c }",
2373 0, SVfARG(sitelib), 0,
2374 0, SVfARG(sitelib), 0));
2375 assert (SvREFCNT(sitelib_sv) == 1);
2376 SvREFCNT_dec(sitelib_sv);
2383 scriptname = argv[0];
2386 scriptname = BIT_BUCKET; /* don't look for script or read stdin */
2388 else if (scriptname == NULL) {
2390 if ( PerlLIO_isatty(PerlIO_fileno(PerlIO_stdin())) )
2396 assert (!TAINT_get);
2400 bool suidscript = FALSE;
2402 rsfp = open_script(scriptname, dosearch, &suidscript);
2404 rsfp = PerlIO_stdin();
2405 lex_start_flags = LEX_DONT_CLOSE_RSFP;
2408 validate_suid(rsfp);
2411 # if defined(SIGCHLD) || defined(SIGCLD)
2414 # define SIGCHLD SIGCLD
2416 Sighandler_t sigstate = rsignal_state(SIGCHLD);
2417 if (sigstate == (Sighandler_t) SIG_IGN) {
2418 Perl_ck_warner(aTHX_ packWARN(WARN_SIGNAL),
2419 "Can't ignore signal CHLD, forcing to default");
2420 (void)rsignal(SIGCHLD, (Sighandler_t)SIG_DFL);
2428 /* This will croak if suidscript is true, as -x cannot be used with
2430 forbid_setid('x', suidscript);
2431 /* Hence you can't get here if suidscript is true */
2433 linestr_sv = newSV_type(SVt_PV);
2434 lex_start_flags |= LEX_START_COPIED;
2435 find_beginning(linestr_sv, rsfp);
2436 if (cddir && PerlDir_chdir( (char *)cddir ) < 0)
2437 Perl_croak(aTHX_ "Can't chdir to %s",cddir);
2441 PL_main_cv = PL_compcv = MUTABLE_CV(newSV_type(SVt_PVCV));
2442 CvUNIQUE_on(PL_compcv);
2444 CvPADLIST_set(PL_compcv, pad_new(0));
2446 PL_isarev = newHV();
2449 boot_core_UNIVERSAL();
2451 newXS("Internals::V", S_Internals_V, __FILE__);
2454 (*xsinit)(aTHX); /* in case linked C routines want magical variables */
2456 #if defined(VMS) || defined(WIN32) || defined(DJGPP) || defined(__CYGWIN__) || defined(SYMBIAN)
2462 # ifdef HAS_SOCKS5_INIT
2463 socks5_init(argv[0]);
2469 init_predump_symbols();
2470 /* init_postdump_symbols not currently designed to be called */
2471 /* more than once (ENV isn't cleared first, for example) */
2472 /* But running with -u leaves %ENV & @ARGV undefined! XXX */
2474 init_postdump_symbols(argc,argv,env);
2476 /* PL_unicode is turned on by -C, or by $ENV{PERL_UNICODE},
2477 * or explicitly in some platforms.
2478 * PL_utf8locale is conditionally turned on by
2479 * locale.c:Perl_init_i18nl10n() if the environment
2480 * look like the user wants to use UTF-8. */
2481 #if defined(__SYMBIAN32__)
2482 PL_unicode = PERL_UNICODE_STD_FLAG; /* See PERL_SYMBIAN_CONSOLE_UTF8. */
2484 # ifndef PERL_IS_MINIPERL
2486 /* Requires init_predump_symbols(). */
2487 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
2492 /* Turn on UTF-8-ness on STDIN, STDOUT, STDERR
2493 * and the default open disciplines. */
2494 if ((PL_unicode & PERL_UNICODE_STDIN_FLAG) &&
2495 PL_stdingv && (io = GvIO(PL_stdingv)) &&
2497 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2498 if ((PL_unicode & PERL_UNICODE_STDOUT_FLAG) &&
2499 PL_defoutgv && (io = GvIO(PL_defoutgv)) &&
2501 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2502 if ((PL_unicode & PERL_UNICODE_STDERR_FLAG) &&
2503 PL_stderrgv && (io = GvIO(PL_stderrgv)) &&
2505 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2506 if ((PL_unicode & PERL_UNICODE_INOUT_FLAG) &&
2507 (sv = GvSV(gv_fetchpvs("\017PEN", GV_ADD|GV_NOTQUAL,
2509 U32 in = PL_unicode & PERL_UNICODE_IN_FLAG;
2510 U32 out = PL_unicode & PERL_UNICODE_OUT_FLAG;
2513 sv_setpvs(sv, ":utf8\0:utf8");
2515 sv_setpvs(sv, ":utf8\0");
2518 sv_setpvs(sv, "\0:utf8");
2527 if ((s = PerlEnv_getenv("PERL_SIGNALS"))) {
2528 if (strEQ(s, "unsafe"))
2529 PL_signals |= PERL_SIGNALS_UNSAFE_FLAG;
2530 else if (strEQ(s, "safe"))
2531 PL_signals &= ~PERL_SIGNALS_UNSAFE_FLAG;
2533 Perl_croak(aTHX_ "PERL_SIGNALS illegal: \"%s\"", s);
2538 lex_start(linestr_sv, rsfp, lex_start_flags);
2539 SvREFCNT_dec(linestr_sv);
2541 PL_subname = newSVpvs("main");
2543 if (add_read_e_script)
2544 filter_add(read_e_script, NULL);
2546 /* now parse the script */
2548 SETERRNO(0,SS_NORMAL);
2549 if (yyparse(GRAMPROG) || PL_parser->error_count) {
2550 abort_execution("", PL_origfilename);
2552 CopLINE_set(PL_curcop, 0);
2553 SET_CURSTASH(PL_defstash);
2555 SvREFCNT_dec(PL_e_script);
2563 SAVECOPFILE(PL_curcop);
2564 SAVECOPLINE(PL_curcop);
2565 gv_check(PL_defstash);
2575 s = PerlEnv_getenv("PERL_DEBUG_MSTATS");
2576 if (s && grok_atoUV(s, &uv, NULL) && uv >= 2)
2577 dump_mstats("after compilation:");
2582 PL_restartjmpenv = NULL;
2588 =for apidoc Am|int|perl_run|PerlInterpreter *my_perl
2590 Tells a Perl interpreter to run its main program. See L<perlembed>
2593 C<my_perl> points to the Perl interpreter. It must have been previously
2594 created through the use of L</perl_alloc> and L</perl_construct>, and
2595 initialised through L</perl_parse>. This function should not be called
2596 if L</perl_parse> returned a non-zero value, indicating a failure in
2597 initialisation or compilation.
2599 This function executes code in C<INIT> blocks, and then executes the
2600 main program. The code to be executed is that established by the prior
2601 call to L</perl_parse>. If the interpreter's C<PL_exit_flags> word
2602 does not have the C<PERL_EXIT_DESTRUCT_END> flag set, then this function
2603 will also execute code in C<END> blocks. If it is desired to make any
2604 further use of the interpreter after calling this function, then C<END>
2605 blocks should be postponed to L</perl_destruct> time by setting that flag.
2607 Returns an integer of slightly tricky interpretation. The correct use
2608 of the return value is as a truth value indicating whether the program
2609 terminated non-locally. If zero is returned, this indicates that
2610 the program ran to completion, and it is safe to make other use of the
2611 interpreter (provided that the C<PERL_EXIT_DESTRUCT_END> flag was set as
2612 described above). If a non-zero value is returned, this indicates that
2613 the interpreter wants to terminate early. The interpreter should not be
2614 just abandoned because of this desire to terminate; the caller should
2615 proceed to shut the interpreter down cleanly with L</perl_destruct>
2616 and free it with L</perl_free>.
2618 For historical reasons, the non-zero return value also attempts to
2619 be a suitable value to pass to the C library function C<exit> (or to
2620 return from C<main>), to serve as an exit code indicating the nature of
2621 the way the program terminated. However, this isn't portable, due to
2622 differing exit code conventions. An attempt is made to return an exit
2623 code of the type required by the host operating system, but because
2624 it is constrained to be non-zero, it is not necessarily possible to
2625 indicate every type of exit. It is only reliable on Unix, where a zero
2626 exit code can be augmented with a set bit that will be ignored. In any
2627 case, this function is not the correct place to acquire an exit code:
2628 one should get that from L</perl_destruct>.
2637 int ret = 0, exit_called = 0;
2640 PERL_ARGS_ASSERT_PERL_RUN;
2641 #ifndef MULTIPLICITY
2642 PERL_UNUSED_ARG(my_perl);
2645 oldscope = PL_scopestack_ix;
2653 cxstack_ix = -1; /* start context stack again */
2655 case 0: /* normal completion */
2659 case 2: /* my_exit() */
2662 while (PL_scopestack_ix > oldscope)
2665 SET_CURSTASH(PL_defstash);
2666 if (!(PL_exit_flags & PERL_EXIT_DESTRUCT_END) &&
2667 PL_endav && !PL_minus_c) {
2668 PERL_SET_PHASE(PERL_PHASE_END);
2669 call_list(oldscope, PL_endav);
2672 if (PerlEnv_getenv("PERL_DEBUG_MSTATS"))
2673 dump_mstats("after execution: ");
2677 if (ret == 0) ret = 0x100;
2684 POPSTACK_TO(PL_mainstack);
2687 PerlIO_printf(Perl_error_log, "panic: restartop in perl_run\n");
2698 S_run_body(pTHX_ I32 oldscope)
2700 DEBUG_r(PerlIO_printf(Perl_debug_log, "%s $` $& $' support (0x%x).\n",
2701 PL_sawampersand ? "Enabling" : "Omitting",
2702 (unsigned int)(PL_sawampersand)));
2704 if (!PL_restartop) {
2706 if (DEBUG_x_TEST || DEBUG_B_TEST)
2707 dump_all_perl(!DEBUG_B_TEST);
2709 PERL_DEBUG(PerlIO_printf(Perl_debug_log, "\nEXECUTING...\n\n"));
2713 PerlIO_printf(Perl_error_log, "%s syntax OK\n", PL_origfilename);
2716 if (PERLDB_SINGLE && PL_DBsingle)
2719 PERL_SET_PHASE(PERL_PHASE_INIT);
2720 call_list(oldscope, PL_initav);
2722 #ifdef PERL_DEBUG_READONLY_OPS
2723 if (PL_main_root && PL_main_root->op_slabbed)
2724 Slab_to_ro(OpSLAB(PL_main_root));
2730 PERL_SET_PHASE(PERL_PHASE_RUN);
2733 PL_restartjmpenv = NULL;
2734 PL_op = PL_restartop;
2738 else if (PL_main_start) {
2739 CvDEPTH(PL_main_cv) = 1;
2740 PL_op = PL_main_start;
2744 NOT_REACHED; /* NOTREACHED */
2748 =head1 SV Manipulation Functions
2750 =for apidoc p||get_sv
2752 Returns the SV of the specified Perl scalar. C<flags> are passed to
2753 C<gv_fetchpv>. If C<GV_ADD> is set and the
2754 Perl variable does not exist then it will be created. If C<flags> is zero
2755 and the variable does not exist then NULL is returned.
2761 Perl_get_sv(pTHX_ const char *name, I32 flags)
2765 PERL_ARGS_ASSERT_GET_SV;
2767 gv = gv_fetchpv(name, flags, SVt_PV);
2774 =head1 Array Manipulation Functions
2776 =for apidoc p||get_av
2778 Returns the AV of the specified Perl global or package array with the given
2779 name (so it won't work on lexical variables). C<flags> are passed
2780 to C<gv_fetchpv>. If C<GV_ADD> is set and the
2781 Perl variable does not exist then it will be created. If C<flags> is zero
2782 and the variable does not exist then NULL is returned.
2784 Perl equivalent: C<@{"$name"}>.
2790 Perl_get_av(pTHX_ const char *name, I32 flags)
2792 GV* const gv = gv_fetchpv(name, flags, SVt_PVAV);
2794 PERL_ARGS_ASSERT_GET_AV;
2804 =head1 Hash Manipulation Functions
2806 =for apidoc p||get_hv
2808 Returns the HV of the specified Perl hash. C<flags> are passed to
2809 C<gv_fetchpv>. If C<GV_ADD> is set and the
2810 Perl variable does not exist then it will be created. If C<flags> is zero
2811 and the variable does not exist then C<NULL> is returned.
2817 Perl_get_hv(pTHX_ const char *name, I32 flags)
2819 GV* const gv = gv_fetchpv(name, flags, SVt_PVHV);
2821 PERL_ARGS_ASSERT_GET_HV;
2831 =head1 CV Manipulation Functions
2833 =for apidoc p||get_cvn_flags
2835 Returns the CV of the specified Perl subroutine. C<flags> are passed to
2836 C<gv_fetchpvn_flags>. If C<GV_ADD> is set and the Perl subroutine does not
2837 exist then it will be declared (which has the same effect as saying
2838 C<sub name;>). If C<GV_ADD> is not set and the subroutine does not exist
2839 then NULL is returned.
2841 =for apidoc p||get_cv
2843 Uses C<strlen> to get the length of C<name>, then calls C<get_cvn_flags>.
2849 Perl_get_cvn_flags(pTHX_ const char *name, STRLEN len, I32 flags)
2851 GV* const gv = gv_fetchpvn_flags(name, len, flags, SVt_PVCV);
2853 PERL_ARGS_ASSERT_GET_CVN_FLAGS;
2855 if (gv && UNLIKELY(SvROK(gv)) && SvTYPE(SvRV((SV *)gv)) == SVt_PVCV)
2856 return (CV*)SvRV((SV *)gv);
2858 /* XXX this is probably not what they think they're getting.
2859 * It has the same effect as "sub name;", i.e. just a forward
2861 if ((flags & ~GV_NOADD_MASK) && !GvCVu(gv)) {
2862 return newSTUB(gv,0);
2869 /* Nothing in core calls this now, but we can't replace it with a macro and
2870 move it to mathoms.c as a macro would evaluate name twice. */
2872 Perl_get_cv(pTHX_ const char *name, I32 flags)
2874 PERL_ARGS_ASSERT_GET_CV;
2876 return get_cvn_flags(name, strlen(name), flags);
2879 /* Be sure to refetch the stack pointer after calling these routines. */
2883 =head1 Callback Functions
2885 =for apidoc p||call_argv
2887 Performs a callback to the specified named and package-scoped Perl subroutine
2888 with C<argv> (a C<NULL>-terminated array of strings) as arguments. See
2891 Approximate Perl equivalent: C<&{"$sub_name"}(@$argv)>.
2897 Perl_call_argv(pTHX_ const char *sub_name, I32 flags, char **argv)
2899 /* See G_* flags in cop.h */
2900 /* null terminated arg list */
2904 PERL_ARGS_ASSERT_CALL_ARGV;
2908 mXPUSHs(newSVpv(*argv,0));
2912 return call_pv(sub_name, flags);
2916 =for apidoc p||call_pv
2918 Performs a callback to the specified Perl sub. See L<perlcall>.
2924 Perl_call_pv(pTHX_ const char *sub_name, I32 flags)
2925 /* name of the subroutine */
2926 /* See G_* flags in cop.h */
2928 PERL_ARGS_ASSERT_CALL_PV;
2930 return call_sv(MUTABLE_SV(get_cv(sub_name, GV_ADD)), flags);
2934 =for apidoc p||call_method
2936 Performs a callback to the specified Perl method. The blessed object must
2937 be on the stack. See L<perlcall>.
2943 Perl_call_method(pTHX_ const char *methname, I32 flags)
2944 /* name of the subroutine */
2945 /* See G_* flags in cop.h */
2949 PERL_ARGS_ASSERT_CALL_METHOD;
2951 len = strlen(methname);
2952 sv = flags & G_METHOD_NAMED
2953 ? sv_2mortal(newSVpvn_share(methname, len,0))
2954 : newSVpvn_flags(methname, len, SVs_TEMP);
2956 return call_sv(sv, flags | G_METHOD);
2959 /* May be called with any of a CV, a GV, or an SV containing the name. */
2961 =for apidoc p||call_sv
2963 Performs a callback to the Perl sub specified by the SV.
2965 If neither the C<G_METHOD> nor C<G_METHOD_NAMED> flag is supplied, the
2966 SV may be any of a CV, a GV, a reference to a CV, a reference to a GV
2967 or C<SvPV(sv)> will be used as the name of the sub to call.
2969 If the C<G_METHOD> flag is supplied, the SV may be a reference to a CV or
2970 C<SvPV(sv)> will be used as the name of the method to call.
2972 If the C<G_METHOD_NAMED> flag is supplied, C<SvPV(sv)> will be used as
2973 the name of the method to call.
2975 Some other values are treated specially for internal use and should
2984 Perl_call_sv(pTHX_ SV *sv, volatile I32 flags)
2985 /* See G_* flags in cop.h */
2988 LOGOP myop; /* fake syntax tree node */
2991 volatile I32 retval = 0;
2992 bool oldcatch = CATCH_GET;
2994 OP* const oldop = PL_op;
2997 PERL_ARGS_ASSERT_CALL_SV;
2999 if (flags & G_DISCARD) {
3003 if (!(flags & G_WANT)) {
3004 /* Backwards compatibility - as G_SCALAR was 0, it could be omitted.
3009 Zero(&myop, 1, LOGOP);
3010 if (!(flags & G_NOARGS))
3011 myop.op_flags |= OPf_STACKED;
3012 myop.op_flags |= OP_GIMME_REVERSE(flags);
3016 if (!(flags & G_METHOD_NAMED)) {
3024 if (PERLDB_SUB && PL_curstash != PL_debstash
3025 /* Handle first BEGIN of -d. */
3026 && (PL_DBcv || (PL_DBcv = GvCV(PL_DBsub)))
3027 /* Try harder, since this may have been a sighandler, thus
3028 * curstash may be meaningless. */
3029 && (SvTYPE(sv) != SVt_PVCV || CvSTASH((const CV *)sv) != PL_debstash)
3030 && !(flags & G_NODEBUG))
3031 myop.op_private |= OPpENTERSUB_DB;
3033 if (flags & (G_METHOD|G_METHOD_NAMED)) {
3034 Zero(&method_op, 1, METHOP);
3035 method_op.op_next = (OP*)&myop;
3036 PL_op = (OP*)&method_op;
3037 if ( flags & G_METHOD_NAMED ) {
3038 method_op.op_ppaddr = PL_ppaddr[OP_METHOD_NAMED];
3039 method_op.op_type = OP_METHOD_NAMED;
3040 method_op.op_u.op_meth_sv = sv;
3042 method_op.op_ppaddr = PL_ppaddr[OP_METHOD];
3043 method_op.op_type = OP_METHOD;
3045 myop.op_ppaddr = PL_ppaddr[OP_ENTERSUB];
3046 myop.op_type = OP_ENTERSUB;
3049 if (!(flags & G_EVAL)) {
3051 CALL_BODY_SUB((OP*)&myop);
3052 retval = PL_stack_sp - (PL_stack_base + oldmark);
3053 CATCH_SET(oldcatch);
3057 myop.op_other = (OP*)&myop;
3059 old_cxix = cxstack_ix;
3060 create_eval_scope(NULL, flags|G_FAKINGEVAL);
3068 CALL_BODY_SUB((OP*)&myop);
3069 retval = PL_stack_sp - (PL_stack_base + oldmark);
3070 if (!(flags & G_KEEPERR)) {
3078 /* my_exit() was called */
3079 SET_CURSTASH(PL_defstash);
3083 NOT_REACHED; /* NOTREACHED */
3086 PL_restartjmpenv = NULL;
3087 PL_op = PL_restartop;
3091 PL_stack_sp = PL_stack_base + oldmark;
3092 if ((flags & G_WANT) == G_ARRAY)
3096 *++PL_stack_sp = &PL_sv_undef;
3101 /* if we croaked, depending on how we croaked the eval scope
3102 * may or may not have already been popped */
3103 if (cxstack_ix > old_cxix) {
3104 assert(cxstack_ix == old_cxix + 1);
3105 assert(CxTYPE(CX_CUR()) == CXt_EVAL);
3106 delete_eval_scope();
3111 if (flags & G_DISCARD) {
3112 PL_stack_sp = PL_stack_base + oldmark;
3121 /* Eval a string. The G_EVAL flag is always assumed. */
3124 =for apidoc p||eval_sv
3126 Tells Perl to C<eval> the string in the SV. It supports the same flags
3127 as C<call_sv>, with the obvious exception of C<G_EVAL>. See L<perlcall>.
3133 Perl_eval_sv(pTHX_ SV *sv, I32 flags)
3135 /* See G_* flags in cop.h */
3138 UNOP myop; /* fake syntax tree node */
3139 volatile I32 oldmark;
3140 volatile I32 retval = 0;
3142 OP* const oldop = PL_op;
3145 PERL_ARGS_ASSERT_EVAL_SV;
3147 if (flags & G_DISCARD) {
3154 Zero(&myop, 1, UNOP);
3157 oldmark = SP - PL_stack_base;
3163 if (!(flags & G_NOARGS))
3164 myop.op_flags = OPf_STACKED;
3165 myop.op_type = OP_ENTEREVAL;
3166 myop.op_flags |= OP_GIMME_REVERSE(flags);
3167 if (flags & G_KEEPERR)
3168 myop.op_flags |= OPf_SPECIAL;
3170 if (flags & G_RE_REPARSING)
3171 myop.op_private = (OPpEVAL_COPHH | OPpEVAL_RE_REPARSING);
3173 /* fail now; otherwise we could fail after the JMPENV_PUSH but
3174 * before a cx_pusheval(), which corrupts the stack after a croak */
3175 TAINT_PROPER("eval_sv()");
3181 if (PL_op == (OP*)(&myop)) {
3182 PL_op = PL_ppaddr[OP_ENTEREVAL](aTHX);
3184 goto fail; /* failed in compilation */
3187 retval = PL_stack_sp - (PL_stack_base + oldmark);
3188 if (!(flags & G_KEEPERR)) {
3196 /* my_exit() was called */
3197 SET_CURSTASH(PL_defstash);
3201 NOT_REACHED; /* NOTREACHED */
3204 PL_restartjmpenv = NULL;
3205 PL_op = PL_restartop;
3210 PL_stack_sp = PL_stack_base + oldmark;
3211 if ((flags & G_WANT) == G_ARRAY)
3215 *++PL_stack_sp = &PL_sv_undef;
3221 if (flags & G_DISCARD) {
3222 PL_stack_sp = PL_stack_base + oldmark;
3232 =for apidoc p||eval_pv
3234 Tells Perl to C<eval> the given string in scalar context and return an SV* result.
3240 Perl_eval_pv(pTHX_ const char *p, I32 croak_on_error)
3242 SV* sv = newSVpv(p, 0);
3244 PERL_ARGS_ASSERT_EVAL_PV;
3246 eval_sv(sv, G_SCALAR);
3255 /* just check empty string or undef? */
3256 if (croak_on_error) {
3257 SV * const errsv = ERRSV;
3258 if(SvTRUE_NN(errsv))
3259 /* replace with croak_sv? */
3260 Perl_croak_nocontext("%s", SvPV_nolen_const(errsv));
3266 /* Require a module. */
3269 =head1 Embedding Functions
3271 =for apidoc p||require_pv
3273 Tells Perl to C<require> the file named by the string argument. It is
3274 analogous to the Perl code C<eval "require '$file'">. It's even
3275 implemented that way; consider using load_module instead.
3280 Perl_require_pv(pTHX_ const char *pv)
3285 PERL_ARGS_ASSERT_REQUIRE_PV;
3287 PUSHSTACKi(PERLSI_REQUIRE);
3288 sv = Perl_newSVpvf(aTHX_ "require q%c%s%c", 0, pv, 0);
3289 eval_sv(sv_2mortal(sv), G_DISCARD);
3294 S_usage(pTHX) /* XXX move this out into a module ? */
3296 /* This message really ought to be max 23 lines.
3297 * Removed -h because the user already knows that option. Others? */
3299 /* Grouped as 6 lines per C string literal, to keep under the ANSI C 89
3300 minimum of 509 character string literals. */
3301 static const char * const usage_msg[] = {
3302 " -0[octal] specify record separator (\\0, if no argument)\n"
3303 " -a autosplit mode with -n or -p (splits $_ into @F)\n"
3304 " -C[number/list] enables the listed Unicode features\n"
3305 " -c check syntax only (runs BEGIN and CHECK blocks)\n"
3306 " -d[:debugger] run program under debugger\n"
3307 " -D[number/list] set debugging flags (argument is a bit mask or alphabets)\n",
3308 " -e program one line of program (several -e's allowed, omit programfile)\n"
3309 " -E program like -e, but enables all optional features\n"
3310 " -f don't do $sitelib/sitecustomize.pl at startup\n"
3311 " -F/pattern/ split() pattern for -a switch (//'s are optional)\n"
3312 " -i[extension] edit <> files in place (makes backup if extension supplied)\n"
3313 " -Idirectory specify @INC/#include directory (several -I's allowed)\n",
3314 " -l[octal] enable line ending processing, specifies line terminator\n"
3315 " -[mM][-]module execute \"use/no module...\" before executing program\n"
3316 " -n assume \"while (<>) { ... }\" loop around program\n"
3317 " -p assume loop like -n but print line also, like sed\n"
3318 " -s enable rudimentary parsing for switches after programfile\n"
3319 " -S look for programfile using PATH environment variable\n",
3320 " -t enable tainting warnings\n"
3321 " -T enable tainting checks\n"
3322 " -u dump core after parsing program\n"
3323 " -U allow unsafe operations\n"
3324 " -v print version, patchlevel and license\n"
3325 " -V[:variable] print configuration summary (or a single Config.pm variable)\n",
3326 " -w enable many useful warnings\n"
3327 " -W enable all warnings\n"
3328 " -x[directory] ignore text before #!perl line (optionally cd to directory)\n"
3329 " -X disable all warnings\n"
3331 "Run 'perldoc perl' for more help with Perl.\n\n",
3334 const char * const *p = usage_msg;
3335 PerlIO *out = PerlIO_stdout();
3338 "\nUsage: %s [switches] [--] [programfile] [arguments]\n",
3341 PerlIO_puts(out, *p++);
3345 /* convert a string of -D options (or digits) into an int.
3346 * sets *s to point to the char after the options */
3350 Perl_get_debug_opts(pTHX_ const char **s, bool givehelp)
3352 static const char * const usage_msgd[] = {
3353 " Debugging flag values: (see also -d)\n"
3354 " p Tokenizing and parsing (with v, displays parse stack)\n"
3355 " s Stack snapshots (with v, displays all stacks)\n"
3356 " l Context (loop) stack processing\n"
3357 " t Trace execution\n"
3358 " o Method and overloading resolution\n",
3359 " c String/numeric conversions\n"
3360 " P Print profiling info, source file input state\n"
3361 " m Memory and SV allocation\n"
3362 " f Format processing\n"
3363 " r Regular expression parsing and execution\n"
3364 " x Syntax tree dump\n",
3365 " u Tainting checks\n"
3366 " H Hash dump -- usurps values()\n"
3367 " X Scratchpad allocation\n"
3369 " S Op slab allocation\n"
3371 " R Include reference counts of dumped variables (eg when using -Ds)\n",
3372 " J Do not s,t,P-debug (Jump over) opcodes within package DB\n"
3373 " v Verbose: use in conjunction with other flags\n"
3374 " C Copy On Write\n"
3375 " A Consistency checks on internal structures\n"
3376 " q quiet - currently only suppresses the 'EXECUTING' message\n"
3377 " M trace smart match resolution\n"
3378 " B dump suBroutine definitions, including special Blocks like BEGIN\n",
3379 " L trace some locale setting information--for Perl core development\n",
3380 " i trace PerlIO layer processing\n",
3385 PERL_ARGS_ASSERT_GET_DEBUG_OPTS;
3388 /* if adding extra options, remember to update DEBUG_MASK */
3389 static const char debopts[] = "psltocPmfrxuUHXDSTRJvCAqMBLi";
3391 for (; isWORDCHAR(**s); (*s)++) {
3392 const char * const d = strchr(debopts,**s);
3394 uv |= 1 << (d - debopts);
3395 else if (ckWARN_d(WARN_DEBUGGING))
3396 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3397 "invalid option -D%c, use -D'' to see choices\n", **s);
3400 else if (isDIGIT(**s)) {
3402 if (grok_atoUV(*s, &uv, &e))
3404 for (; isWORDCHAR(**s); (*s)++) ;
3406 else if (givehelp) {
3407 const char *const *p = usage_msgd;
3408 while (*p) PerlIO_puts(PerlIO_stdout(), *p++);
3410 return (int)uv; /* ignore any UV->int conversion loss */
3414 /* This routine handles any switches that can be given during run */
3417 Perl_moreswitches(pTHX_ const char *s)
3421 const char option = *s; /* used to remember option in -m/-M code */
3423 PERL_ARGS_ASSERT_MORESWITCHES;
3431 SvREFCNT_dec(PL_rs);
3432 if (s[1] == 'x' && s[2]) {
3433 const char *e = s+=2;
3439 flags = PERL_SCAN_SILENT_ILLDIGIT;
3440 rschar = (U32)grok_hex(s, &numlen, &flags, NULL);
3441 if (s + numlen < e) {
3442 rschar = 0; /* Grandfather -0xFOO as -0 -xFOO. */
3446 PL_rs = newSVpvs("");
3447 tmps = (U8*) SvGROW(PL_rs, (STRLEN)(UVCHR_SKIP(rschar) + 1));
3448 uvchr_to_utf8(tmps, rschar);
3449 SvCUR_set(PL_rs, UVCHR_SKIP(rschar));
3454 rschar = (U32)grok_oct(s, &numlen, &flags, NULL);
3455 if (rschar & ~((U8)~0))
3456 PL_rs = &PL_sv_undef;
3457 else if (!rschar && numlen >= 2)
3458 PL_rs = newSVpvs("");
3460 char ch = (char)rschar;
3461 PL_rs = newSVpvn(&ch, 1);
3464 sv_setsv(get_sv("/", GV_ADD), PL_rs);
3469 PL_unicode = parse_unicode_opts( (const char **)&s );
3470 if (PL_unicode & PERL_UNICODE_UTF8CACHEASSERT_FLAG)
3478 while (*s && !isSPACE(*s)) ++s;
3479 PL_splitstr = savepvn(PL_splitstr, s - PL_splitstr);
3491 forbid_setid('d', FALSE);
3494 /* -dt indicates to the debugger that threads will be used */
3495 if (*s == 't' && !isWORDCHAR(s[1])) {
3497 my_setenv("PERL5DB_THREADED", "1");
3500 /* The following permits -d:Mod to accepts arguments following an =
3501 in the fashion that -MSome::Mod does. */
3502 if (*s == ':' || *s == '=') {
3509 sv = newSVpvs("no Devel::");
3511 sv = newSVpvs("use Devel::");
3515 end = s + strlen(s);
3517 /* We now allow -d:Module=Foo,Bar and -d:-Module */
3518 while(isWORDCHAR(*s) || *s==':') ++s;
3520 sv_catpvn(sv, start, end - start);
3522 sv_catpvn(sv, start, s-start);
3523 /* Don't use NUL as q// delimiter here, this string goes in the
3525 Perl_sv_catpvf(aTHX_ sv, " split(/,/,q{%s});", ++s);
3528 my_setenv("PERL5DB", SvPV_nolen_const(sv));
3532 PL_perldb = PERLDB_ALL;
3539 forbid_setid('D', FALSE);
3541 PL_debug = get_debug_opts( (const char **)&s, 1) | DEBUG_TOP_FLAG;
3542 #else /* !DEBUGGING */
3543 if (ckWARN_d(WARN_DEBUGGING))
3544 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3545 "Recompile perl with -DDEBUGGING to use -D switch (did you mean -d ?)\n");
3546 for (s++; isWORDCHAR(*s); s++) ;
3549 NOT_REACHED; /* NOTREACHED */
3553 NOT_REACHED; /* NOTREACHED */
3556 Safefree(PL_inplace);
3558 const char * const start = ++s;
3559 while (*s && !isSPACE(*s))
3562 PL_inplace = savepvn(start, s - start);
3565 case 'I': /* -I handled both here and in parse_body() */
3566 forbid_setid('I', FALSE);
3568 while (*s && isSPACE(*s))
3573 /* ignore trailing spaces (possibly followed by other switches) */
3575 for (e = p; *e && !isSPACE(*e); e++) ;
3579 } while (*p && *p != '-');
3581 INCPUSH_ADD_SUB_DIRS|INCPUSH_ADD_OLD_VERS|INCPUSH_UNSHIFT);
3587 Perl_croak(aTHX_ "No directory specified for -I");
3593 SvREFCNT_dec(PL_ors_sv);
3599 PL_ors_sv = newSVpvs("\n");
3600 numlen = 3 + (*s == '0');
3601 *SvPVX(PL_ors_sv) = (char)grok_oct(s, &numlen, &flags, NULL);
3605 if (RsPARA(PL_rs)) {
3606 PL_ors_sv = newSVpvs("\n\n");
3609 PL_ors_sv = newSVsv(PL_rs);
3614 forbid_setid('M', FALSE); /* XXX ? */
3617 forbid_setid('m', FALSE); /* XXX ? */
3622 const char *use = "use ";
3624 /* -M-foo == 'no foo' */
3625 /* Leading space on " no " is deliberate, to make both
3626 possibilities the same length. */
3627 if (*s == '-') { use = " no "; ++s; }
3628 sv = newSVpvn(use,4);
3630 /* We allow -M'Module qw(Foo Bar)' */
3631 while(isWORDCHAR(*s) || *s==':') {
3640 Perl_croak(aTHX_ "Module name required with -%c option",
3643 Perl_croak(aTHX_ "Invalid module name %.*s with -%c option: "
3644 "contains single ':'",
3645 (int)(s - start), start, option);
3646 end = s + strlen(s);
3648 sv_catpvn(sv, start, end - start);
3649 if (option == 'm') {
3651 Perl_croak(aTHX_ "Can't use '%c' after -mname", *s);
3652 sv_catpvs( sv, " ()");
3655 sv_catpvn(sv, start, s-start);
3656 /* Use NUL as q''-delimiter. */
3657 sv_catpvs(sv, " split(/,/,q\0");
3659 sv_catpvn(sv, s, end - s);
3660 sv_catpvs(sv, "\0)");
3663 Perl_av_create_and_push(aTHX_ &PL_preambleav, sv);
3666 Perl_croak(aTHX_ "Missing argument to -%c", option);
3677 forbid_setid('s', FALSE);
3678 PL_doswitches = TRUE;
3683 #if defined(SILENT_NO_TAINT_SUPPORT)
3684 /* silently ignore */
3685 #elif defined(NO_TAINT_SUPPORT)
3686 Perl_croak_nocontext("This perl was compiled without taint support. "
3687 "Cowardly refusing to run with -t or -T flags");
3695 PL_do_undump = TRUE;
3705 if (! (PL_dowarn & G_WARN_ALL_MASK)) {
3706 PL_dowarn |= G_WARN_ON;
3711 PL_dowarn = G_WARN_ALL_ON|G_WARN_ON;
3712 if (!specialWARN(PL_compiling.cop_warnings))
3713 PerlMemShared_free(PL_compiling.cop_warnings);
3714 PL_compiling.cop_warnings = pWARN_ALL ;
3718 PL_dowarn = G_WARN_ALL_OFF;
3719 if (!specialWARN(PL_compiling.cop_warnings))
3720 PerlMemShared_free(PL_compiling.cop_warnings);
3721 PL_compiling.cop_warnings = pWARN_NONE ;
3728 if (s[0] == '-') /* Additional switches on #! line. */
3733 #if defined(WIN32) || !defined(PERL_STRICT_CR)
3739 #ifdef ALTERNATE_SHEBANG
3740 case 'S': /* OS/2 needs -S on "extproc" line. */
3743 case 'e': case 'f': case 'x': case 'E':
3744 #ifndef ALTERNATE_SHEBANG
3748 Perl_croak(aTHX_ "Can't emulate -%.1s on #! line",s);
3751 "Unrecognized switch: -%.1s (-h will show valid options)",s
3761 PerlIO * PIO_stdout;
3763 const char * const level_str = "v" PERL_VERSION_STRING;
3764 const STRLEN level_len = sizeof("v" PERL_VERSION_STRING)-1;
3765 #ifdef PERL_PATCHNUM
3767 # ifdef PERL_GIT_UNCOMMITTED_CHANGES
3768 static const char num [] = PERL_PATCHNUM "*";
3770 static const char num [] = PERL_PATCHNUM;
3773 const STRLEN num_len = sizeof(num)-1;
3774 /* A very advanced compiler would fold away the strnEQ
3775 and this whole conditional, but most (all?) won't do it.
3776 SV level could also be replaced by with preprocessor
3779 if (num_len >= level_len && strnEQ(num,level_str,level_len)) {
3780 /* per 46807d8e80, PERL_PATCHNUM is outside of the control
3781 of the interp so it might contain format characters
3783 level = newSVpvn(num, num_len);
3785 level = Perl_newSVpvf_nocontext("%s (%s)", level_str, num);
3789 SV* level = newSVpvn(level_str, level_len);
3790 #endif /* #ifdef PERL_PATCHNUM */
3791 PIO_stdout = PerlIO_stdout();
3792 PerlIO_printf(PIO_stdout,
3793 "\nThis is perl " STRINGIFY(PERL_REVISION)
3794 ", version " STRINGIFY(PERL_VERSION)
3795 ", subversion " STRINGIFY(PERL_SUBVERSION)
3796 " (%" SVf ") built for " ARCHNAME, SVfARG(level)
3798 SvREFCNT_dec_NN(level);
3800 #if defined(LOCAL_PATCH_COUNT)
3801 if (LOCAL_PATCH_COUNT > 0)
3802 PerlIO_printf(PIO_stdout,
3803 "\n(with %d registered patch%s, "
3804 "see perl -V for more detail)",
3806 (LOCAL_PATCH_COUNT!=1) ? "es" : "");
3809 PerlIO_printf(PIO_stdout,
3810 "\n\nCopyright 1987-2018, Larry Wall\n");
3812 PerlIO_printf(PIO_stdout,
3813 "\nMS-DOS port Copyright (c) 1989, 1990, Diomidis Spinellis\n");
3816 PerlIO_printf(PIO_stdout,
3817 "djgpp v2 port (jpl5003c) by Hirofumi Watanabe, 1996\n"
3818 "djgpp v2 port (perl5004+) by Laszlo Molnar, 1997-1999\n");
3821 PerlIO_printf(PIO_stdout,
3822 "\n\nOS/2 port Copyright (c) 1990, 1991, Raymond Chen, Kai Uwe Rommel\n"
3823 "Version 5 port Copyright (c) 1994-2002, Andreas Kaiser, Ilya Zakharevich\n");
3826 PerlIO_printf(PIO_stdout,
3827 "MVS (OS390) port by Mortice Kern Systems, 1997-1999\n");
3830 PerlIO_printf(PIO_stdout,
3831 "Stratus OpenVOS port by Paul.Green@stratus.com, 1997-2013\n");
3834 PerlIO_printf(PIO_stdout,
3835 "BS2000 (POSIX) port by Start Amadeus GmbH, 1998-1999\n");
3838 PerlIO_printf(PIO_stdout,
3839 "WINCE port by Rainer Keuchel, 2001-2002\n"
3840 "Built on " __DATE__ " " __TIME__ "\n\n");
3843 #ifdef __SYMBIAN32__
3844 PerlIO_printf(PIO_stdout,
3845 "Symbian port by Nokia, 2004-2005\n");
3847 #ifdef BINARY_BUILD_NOTICE
3848 BINARY_BUILD_NOTICE;
3850 PerlIO_printf(PIO_stdout,
3852 Perl may be copied only under the terms of either the Artistic License or the\n\
3853 GNU General Public License, which may be found in the Perl 5 source kit.\n\n\
3854 Complete documentation for Perl, including FAQ lists, should be found on\n\
3855 this system using \"man perl\" or \"perldoc perl\". If you have access to the\n\
3856 Internet, point your browser at http://www.perl.org/, the Perl Home Page.\n\n");
3860 /* compliments of Tom Christiansen */
3862 /* unexec() can be found in the Gnu emacs distribution */
3863 /* Known to work with -DUNEXEC and using unexelf.c from GNU emacs-20.2 */
3866 #include <lib$routines.h>
3870 Perl_my_unexec(pTHX)
3873 SV * prog = newSVpv(BIN_EXP, 0);
3874 SV * file = newSVpv(PL_origfilename, 0);
3878 sv_catpvs(prog, "/perl");
3879 sv_catpvs(file, ".perldump");
3881 unexec(SvPVX(file), SvPVX(prog), &etext, sbrk(0), 0);
3882 /* unexec prints msg to stderr in case of failure */
3883 PerlProc_exit(status);
3885 PERL_UNUSED_CONTEXT;
3887 lib$signal(SS$_DEBUG); /* ssdef.h #included from vmsish.h */
3888 # elif defined(WIN32) || defined(__CYGWIN__)
3889 Perl_croak_nocontext("dump is not supported");
3891 ABORT(); /* for use with undump */
3896 /* initialize curinterp */
3901 # define PERLVAR(prefix,var,type)
3902 # define PERLVARA(prefix,var,n,type)
3903 # if defined(PERL_IMPLICIT_CONTEXT)
3904 # define PERLVARI(prefix,var,type,init) aTHX->prefix##var = init;
3905 # define PERLVARIC(prefix,var,type,init) aTHX->prefix##var = init;
3907 # define PERLVARI(prefix,var,type,init) PERL_GET_INTERP->var = init;
3908 # define PERLVARIC(prefix,var,type,init) PERL_GET_INTERP->var = init;
3910 # include "intrpvar.h"
3916 # define PERLVAR(prefix,var,type)
3917 # define PERLVARA(prefix,var,n,type)
3918 # define PERLVARI(prefix,var,type,init) PL_##var = init;
3919 # define PERLVARIC(prefix,var,type,init) PL_##var = init;
3920 # include "intrpvar.h"
3930 S_init_main_stash(pTHX)
3935 PL_curstash = PL_defstash = (HV *)SvREFCNT_inc_simple_NN(hv);
3936 /* We know that the string "main" will be in the global shared string
3937 table, so it's a small saving to use it rather than allocate another
3939 PL_curstname = newSVpvs_share("main");
3940 gv = gv_fetchpvs("main::", GV_ADD|GV_NOTQUAL, SVt_PVHV);
3941 /* If we hadn't caused another reference to "main" to be in the shared
3942 string table above, then it would be worth reordering these two,
3943 because otherwise all we do is delete "main" from it as a consequence
3944 of the SvREFCNT_dec, only to add it again with hv_name_set */
3945 SvREFCNT_dec(GvHV(gv));
3946 hv_name_sets(PL_defstash, "main", 0);
3947 GvHV(gv) = MUTABLE_HV(SvREFCNT_inc_simple(PL_defstash));
3949 PL_incgv = gv_HVadd(gv_AVadd(gv_fetchpvs("INC", GV_ADD|GV_NOTQUAL,
3951 SvREFCNT_inc_simple_void(PL_incgv); /* Don't allow it to be freed */
3952 GvMULTI_on(PL_incgv);
3953 PL_hintgv = gv_fetchpvs("\010", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^H */
3954 SvREFCNT_inc_simple_void(PL_hintgv);
3955 GvMULTI_on(PL_hintgv);
3956 PL_defgv = gv_fetchpvs("_", GV_ADD|GV_NOTQUAL, SVt_PVAV);
3957 SvREFCNT_inc_simple_void(PL_defgv);
3958 PL_errgv = gv_fetchpvs("@", GV_ADD|GV_NOTQUAL, SVt_PV);
3959 SvREFCNT_inc_simple_void(PL_errgv);
3960 GvMULTI_on(PL_errgv);
3961 PL_replgv = gv_fetchpvs("\022", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^R */
3962 SvREFCNT_inc_simple_void(PL_replgv);
3963 GvMULTI_on(PL_replgv);
3964 (void)Perl_form(aTHX_ "%240s",""); /* Preallocate temp - for immediate signals. */
3965 #ifdef PERL_DONT_CREATE_GVSV
3966 (void)gv_SVadd(PL_errgv);
3968 sv_grow(ERRSV, 240); /* Preallocate - for immediate signals. */
3970 CopSTASH_set(&PL_compiling, PL_defstash);
3971 PL_debstash = GvHV(gv_fetchpvs("DB::", GV_ADDMULTI, SVt_PVHV));
3972 PL_globalstash = GvHV(gv_fetchpvs("CORE::GLOBAL::", GV_ADDMULTI,
3974 /* We must init $/ before switches are processed. */
3975 sv_setpvs(get_sv("/", GV_ADD), "\n");
3979 S_open_script(pTHX_ const char *scriptname, bool dosearch, bool *suidscript)
3982 PerlIO *rsfp = NULL;
3986 PERL_ARGS_ASSERT_OPEN_SCRIPT;
3989 PL_origfilename = savepvs("-e");
3994 /* if find_script() returns, it returns a malloc()-ed value */
3995 scriptname = PL_origfilename = find_script(scriptname, dosearch, NULL, 1);
3997 if (strBEGINs(scriptname, "/dev/fd/")
3998 && isDIGIT(scriptname[8])
3999 && grok_atoUV(scriptname + 8, &uv, &s)
4000 && uv <= PERL_INT_MAX
4005 * Tell apart "normal" usage of fdscript, e.g.
4006 * with bash on FreeBSD:
4007 * perl <( echo '#!perl -DA'; echo 'print "$0\n"')
4008 * from usage in suidperl.
4009 * Does any "normal" usage leave garbage after the number???
4010 * Is it a mistake to use a similar /dev/fd/ construct for
4015 * Be supersafe and do some sanity-checks.
4016 * Still, can we be sure we got the right thing?
4019 Perl_croak(aTHX_ "Wrong syntax (suid) fd script name \"%s\"\n", s);
4022 Perl_croak(aTHX_ "Missing (suid) fd script name\n");
4024 scriptname = savepv(s + 1);
4025 Safefree(PL_origfilename);
4026 PL_origfilename = (char *)scriptname;
4031 CopFILE_free(PL_curcop);
4032 CopFILE_set(PL_curcop, PL_origfilename);
4033 if (*PL_origfilename == '-' && PL_origfilename[1] == '\0')
4034 scriptname = (char *)"";
4035 if (fdscript >= 0) {
4036 rsfp = PerlIO_fdopen(fdscript,PERL_SCRIPT_MODE);
4038 else if (!*scriptname) {
4039 forbid_setid(0, *suidscript);
4043 #ifdef FAKE_BIT_BUCKET
4044 /* This hack allows one not to have /dev/null (or BIT_BUCKET as it
4045 * is called) and still have the "-e" work. (Believe it or not,
4046 * a /dev/null is required for the "-e" to work because source
4047 * filter magic is used to implement it. ) This is *not* a general
4048 * replacement for a /dev/null. What we do here is create a temp
4049 * file (an empty file), open up that as the script, and then
4050 * immediately close and unlink it. Close enough for jazz. */
4051 #define FAKE_BIT_BUCKET_PREFIX "/tmp/perlnull-"
4052 #define FAKE_BIT_BUCKET_SUFFIX "XXXXXXXX"
4053 #define FAKE_BIT_BUCKET_TEMPLATE FAKE_BIT_BUCKET_PREFIX FAKE_BIT_BUCKET_SUFFIX
4054 char tmpname[sizeof(FAKE_BIT_BUCKET_TEMPLATE)] = {
4055 FAKE_BIT_BUCKET_TEMPLATE
4057 const char * const err = "Failed to create a fake bit bucket";
4058 if (strEQ(scriptname, BIT_BUCKET)) {
4059 int tmpfd = Perl_my_mkstemp_cloexec(tmpname);
4061 scriptname = tmpname;
4064 Perl_croak(aTHX_ err);
4067 rsfp = PerlIO_open(scriptname,PERL_SCRIPT_MODE);
4068 #ifdef FAKE_BIT_BUCKET
4069 if ( strBEGINs(scriptname, FAKE_BIT_BUCKET_PREFIX)
4070 && strlen(scriptname) == sizeof(tmpname) - 1)
4074 scriptname = BIT_BUCKET;
4078 /* PSz 16 Sep 03 Keep neat error message */
4080 Perl_croak(aTHX_ "Can't open " BIT_BUCKET ": %s\n", Strerror(errno));
4082 Perl_croak(aTHX_ "Can't open perl script \"%s\": %s\n",
4083 CopFILE(PL_curcop), Strerror(errno));
4085 fd = PerlIO_fileno(rsfp);
4088 (PerlLIO_fstat(fd, &tmpstatbuf) >= 0
4089 && S_ISDIR(tmpstatbuf.st_mode)))
4090 Perl_croak(aTHX_ "Can't open perl script \"%s\": %s\n",
4097 /* In the days of suidperl, we refused to execute a setuid script stored on
4098 * a filesystem mounted nosuid and/or noexec. This meant that we probed for the
4099 * existence of the appropriate filesystem-statting function, and behaved
4100 * accordingly. But even though suidperl is long gone, we must still include
4101 * those probes for the benefit of modules like Filesys::Df, which expect the
4102 * results of those probes to be stored in %Config; see RT#126368. So mention
4103 * the relevant cpp symbols here, to ensure that metaconfig will include their
4104 * probes in the generated Configure:
4106 * I_SYSSTATVFS HAS_FSTATVFS
4108 * I_STATFS HAS_FSTATFS HAS_GETFSSTAT
4109 * I_MNTENT HAS_GETMNTENT HAS_HASMNTOPT
4113 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
4114 /* Don't even need this function. */
4117 S_validate_suid(pTHX_ PerlIO *rsfp)
4119 const Uid_t my_uid = PerlProc_getuid();
4120 const Uid_t my_euid = PerlProc_geteuid();
4121 const Gid_t my_gid = PerlProc_getgid();
4122 const Gid_t my_egid = PerlProc_getegid();
4124 PERL_ARGS_ASSERT_VALIDATE_SUID;
4126 if (my_euid != my_uid || my_egid != my_gid) { /* (suidperl doesn't exist, in fact) */
4128 int fd = PerlIO_fileno(rsfp);
4130 if (fd < 0 || PerlLIO_fstat(fd, &statbuf) < 0) { /* may be either wrapped or real suid */
4131 Perl_croak_nocontext( "Illegal suidscript");
4133 if ((my_euid != my_uid && my_euid == statbuf.st_uid && statbuf.st_mode & S_ISUID)
4135 (my_egid != my_gid && my_egid == statbuf.st_gid && statbuf.st_mode & S_ISGID)
4138 Perl_croak(aTHX_ "YOU HAVEN'T DISABLED SET-ID SCRIPTS IN THE KERNEL YET!\n\
4139 FIX YOUR KERNEL, PUT A C WRAPPER AROUND THIS SCRIPT, OR USE -u AND UNDUMP!\n");
4140 /* not set-id, must be wrapped */
4143 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4146 S_find_beginning(pTHX_ SV* linestr_sv, PerlIO *rsfp)
4151 PERL_ARGS_ASSERT_FIND_BEGINNING;
4153 /* skip forward in input to the real script? */
4156 if ((s = sv_gets(linestr_sv, rsfp, 0)) == NULL)
4157 Perl_croak(aTHX_ "No Perl script found in input\n");
4159 } while (!(*s == '#' && s[1] == '!' && ((s = instr(s,"perl")) || (s = instr(s2,"PERL")))));
4160 PerlIO_ungetc(rsfp, '\n'); /* to keep line count right */
4161 while (*s && !(isSPACE (*s) || *s == '#')) s++;
4163 while (*s == ' ' || *s == '\t') s++;
4165 while (isDIGIT(s2[-1]) || s2[-1] == '-' || s2[-1] == '.'
4166 || s2[-1] == '_') s2--;
4167 if (strBEGINs(s2-4,"perl"))
4168 while ((s = moreswitches(s)))
4177 /* no need to do anything here any more if we don't
4179 #ifndef NO_TAINT_SUPPORT
4180 const Uid_t my_uid = PerlProc_getuid();
4181 const Uid_t my_euid = PerlProc_geteuid();
4182 const Gid_t my_gid = PerlProc_getgid();
4183 const Gid_t my_egid = PerlProc_getegid();
4185 PERL_UNUSED_CONTEXT;
4187 /* Should not happen: */
4188 CHECK_MALLOC_TAINT(my_uid && (my_euid != my_uid || my_egid != my_gid));
4189 TAINTING_set( TAINTING_get | (my_uid && (my_euid != my_uid || my_egid != my_gid)) );
4193 * Should go by suidscript, not uid!=euid: why disallow
4194 * system("ls") in scripts run from setuid things?
4195 * Or, is this run before we check arguments and set suidscript?
4196 * What about SETUID_SCRIPTS_ARE_SECURE_NOW: could we use fdscript then?
4197 * (We never have suidscript, can we be sure to have fdscript?)
4198 * Or must then go by UID checks? See comments in forbid_setid also.
4202 /* This is used very early in the lifetime of the program,
4203 * before even the options are parsed, so PL_tainting has
4204 * not been initialized properly. */
4206 Perl_doing_taint(int argc, char *argv[], char *envp[])
4208 #ifndef PERL_IMPLICIT_SYS
4209 /* If we have PERL_IMPLICIT_SYS we can't call getuid() et alia
4210 * before we have an interpreter-- and the whole point of this
4211 * function is to be called at such an early stage. If you are on
4212 * a system with PERL_IMPLICIT_SYS but you do have a concept of
4213 * "tainted because running with altered effective ids', you'll
4214 * have to add your own checks somewhere in here. The two most
4215 * known samples of 'implicitness' are Win32 and NetWare, neither
4216 * of which has much of concept of 'uids'. */
4217 Uid_t uid = PerlProc_getuid();
4218 Uid_t euid = PerlProc_geteuid();
4219 Gid_t gid = PerlProc_getgid();
4220 Gid_t egid = PerlProc_getegid();
4227 if (uid && (euid != uid || egid != gid))
4229 #endif /* !PERL_IMPLICIT_SYS */
4230 /* This is a really primitive check; environment gets ignored only
4231 * if -T are the first chars together; otherwise one gets
4232 * "Too late" message. */
4233 if ( argc > 1 && argv[1][0] == '-'
4234 && isALPHA_FOLD_EQ(argv[1][1], 't'))
4239 /* Passing the flag as a single char rather than a string is a slight space
4240 optimisation. The only message that isn't /^-.$/ is
4241 "program input from stdin", which is substituted in place of '\0', which
4242 could never be a command line flag. */
4244 S_forbid_setid(pTHX_ const char flag, const bool suidscript) /* g */
4246 char string[3] = "-x";
4247 const char *message = "program input from stdin";
4249 PERL_UNUSED_CONTEXT;
4255 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
4256 if (PerlProc_getuid() != PerlProc_geteuid())
4257 Perl_croak(aTHX_ "No %s allowed while running setuid", message);
4258 if (PerlProc_getgid() != PerlProc_getegid())
4259 Perl_croak(aTHX_ "No %s allowed while running setgid", message);
4260 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4262 Perl_croak(aTHX_ "No %s allowed with (suid) fdscript", message);
4266 Perl_init_dbargs(pTHX)
4268 AV *const args = PL_dbargs = GvAV(gv_AVadd((gv_fetchpvs("DB::args",
4273 /* Someone has already created it.
4274 It might have entries, and if we just turn off AvREAL(), they will
4275 "leak" until global destruction. */
4277 if (SvTIED_mg((const SV *)args, PERL_MAGIC_tied))
4278 Perl_croak(aTHX_ "Cannot set tied @DB::args");
4280 AvREIFY_only(PL_dbargs);
4284 Perl_init_debugger(pTHX)
4286 HV * const ostash = PL_curstash;
4289 PL_curstash = (HV *)SvREFCNT_inc_simple(PL_debstash);
4291 Perl_init_dbargs(aTHX);
4292 PL_DBgv = MUTABLE_GV(
4293 SvREFCNT_inc(gv_fetchpvs("DB::DB", GV_ADDMULTI, SVt_PVGV))
4295 PL_DBline = MUTABLE_GV(
4296 SvREFCNT_inc(gv_fetchpvs("DB::dbline", GV_ADDMULTI, SVt_PVAV))
4298 PL_DBsub = MUTABLE_GV(SvREFCNT_inc(
4299 gv_HVadd(gv_fetchpvs("DB::sub", GV_ADDMULTI, SVt_PVHV))
4301 PL_DBsingle = GvSV((gv_fetchpvs("DB::single", GV_ADDMULTI, SVt_PV)));
4302 if (!SvIOK(PL_DBsingle))
4303 sv_setiv(PL_DBsingle, 0);
4304 mg = sv_magicext(PL_DBsingle, NULL, PERL_MAGIC_debugvar, &PL_vtbl_debugvar, 0, 0);
4305 mg->mg_private = DBVARMG_SINGLE;
4306 SvSETMAGIC(PL_DBsingle);
4308 PL_DBtrace = GvSV((gv_fetchpvs("DB::trace", GV_ADDMULTI, SVt_PV)));
4309 if (!SvIOK(PL_DBtrace))
4310 sv_setiv(PL_DBtrace, 0);
4311 mg = sv_magicext(PL_DBtrace, NULL, PERL_MAGIC_debugvar, &PL_vtbl_debugvar, 0, 0);
4312 mg->mg_private = DBVARMG_TRACE;
4313 SvSETMAGIC(PL_DBtrace);
4315 PL_DBsignal = GvSV((gv_fetchpvs("DB::signal", GV_ADDMULTI, SVt_PV)));
4316 if (!SvIOK(PL_DBsignal))
4317 sv_setiv(PL_DBsignal, 0);
4318 mg = sv_magicext(PL_DBsignal, NULL, PERL_MAGIC_debugvar, &PL_vtbl_debugvar, 0, 0);
4319 mg->mg_private = DBVARMG_SIGNAL;
4320 SvSETMAGIC(PL_DBsignal);
4322 SvREFCNT_dec(PL_curstash);
4323 PL_curstash = ostash;
4326 #ifndef STRESS_REALLOC
4327 #define REASONABLE(size) (size)
4328 #define REASONABLE_but_at_least(size,min) (size)
4330 #define REASONABLE(size) (1) /* unreasonable */
4331 #define REASONABLE_but_at_least(size,min) (min)
4335 Perl_init_stacks(pTHX)
4339 /* start with 128-item stack and 8K cxstack */
4340 PL_curstackinfo = new_stackinfo(REASONABLE(128),
4341 REASONABLE(8192/sizeof(PERL_CONTEXT) - 1));
4342 PL_curstackinfo->si_type = PERLSI_MAIN;
4343 #if defined DEBUGGING && !defined DEBUGGING_RE_ONLY
4344 PL_curstackinfo->si_stack_hwm = 0;
4346 PL_curstack = PL_curstackinfo->si_stack;
4347 PL_mainstack = PL_curstack; /* remember in case we switch stacks */
4349 PL_stack_base = AvARRAY(PL_curstack);
4350 PL_stack_sp = PL_stack_base;
4351 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
4353 Newx(PL_tmps_stack,REASONABLE(128),SV*);
4356 PL_tmps_max = REASONABLE(128);
4358 Newx(PL_markstack,REASONABLE(32),I32);
4359 PL_markstack_ptr = PL_markstack;
4360 PL_markstack_max = PL_markstack + REASONABLE(32);
4364 Newx(PL_scopestack,REASONABLE(32),I32);
4366 Newx(PL_scopestack_name,REASONABLE(32),const char*);
4368 PL_scopestack_ix = 0;
4369 PL_scopestack_max = REASONABLE(32);
4371 size = REASONABLE_but_at_least(128,SS_MAXPUSH);
4372 Newx(PL_savestack, size, ANY);
4373 PL_savestack_ix = 0;
4374 /*PL_savestack_max lies: it always has SS_MAXPUSH more than it claims */
4375 PL_savestack_max = size - SS_MAXPUSH;
4383 while (PL_curstackinfo->si_next)
4384 PL_curstackinfo = PL_curstackinfo->si_next;
4385 while (PL_curstackinfo) {
4386 PERL_SI *p = PL_curstackinfo->si_prev;
4387 /* curstackinfo->si_stack got nuked by sv_free_arenas() */
4388 Safefree(PL_curstackinfo->si_cxstack);
4389 Safefree(PL_curstackinfo);
4390 PL_curstackinfo = p;
4392 Safefree(PL_tmps_stack);
4393 Safefree(PL_markstack);
4394 Safefree(PL_scopestack);
4396 Safefree(PL_scopestack_name);
4398 Safefree(PL_savestack);
4402 Perl_populate_isa(pTHX_ const char *name, STRLEN len, ...)
4404 GV *const gv = gv_fetchpvn(name, len, GV_ADD | GV_ADDMULTI, SVt_PVAV);
4405 AV *const isa = GvAVn(gv);
4408 PERL_ARGS_ASSERT_POPULATE_ISA;
4410 if(AvFILLp(isa) != -1)
4413 /* NOTE: No support for tied ISA */
4415 va_start(args, len);
4417 const char *const parent = va_arg(args, const char*);
4422 parent_len = va_arg(args, size_t);
4424 /* Arguments are supplied with a trailing :: */
4425 assert(parent_len > 2);
4426 assert(parent[parent_len - 1] == ':');
4427 assert(parent[parent_len - 2] == ':');
4428 av_push(isa, newSVpvn(parent, parent_len - 2));
4429 (void) gv_fetchpvn(parent, parent_len, GV_ADD, SVt_PVGV);
4436 S_init_predump_symbols(pTHX)
4441 sv_setpvs(get_sv("\"", GV_ADD), " ");
4442 PL_ofsgv = (GV*)SvREFCNT_inc(gv_fetchpvs(",", GV_ADD|GV_NOTQUAL, SVt_PV));
4445 /* Historically, PVIOs were blessed into IO::Handle, unless
4446 FileHandle was loaded, in which case they were blessed into
4447 that. Action at a distance.
4448 However, if we simply bless into IO::Handle, we break code
4449 that assumes that PVIOs will have (among others) a seek
4450 method. IO::File inherits from IO::Handle and IO::Seekable,
4451 and provides the needed methods. But if we simply bless into
4452 it, then we break code that assumed that by loading
4453 IO::Handle, *it* would work.
4454 So a compromise is to set up the correct @IO::File::ISA,
4455 so that code that does C<use IO::Handle>; will still work.
4458 Perl_populate_isa(aTHX_ STR_WITH_LEN("IO::File::ISA"),
4459 STR_WITH_LEN("IO::Handle::"),
4460 STR_WITH_LEN("IO::Seekable::"),
4461 STR_WITH_LEN("Exporter::"),
4464 PL_stdingv = gv_fetchpvs("STDIN", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4465 GvMULTI_on(PL_stdingv);
4466 io = GvIOp(PL_stdingv);
4467 IoTYPE(io) = IoTYPE_RDONLY;
4468 IoIFP(io) = PerlIO_stdin();
4469 tmpgv = gv_fetchpvs("stdin", GV_ADD|GV_NOTQUAL, SVt_PV);
4471 GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4473 tmpgv = gv_fetchpvs("STDOUT", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4476 IoTYPE(io) = IoTYPE_WRONLY;
4477 IoOFP(io) = IoIFP(io) = PerlIO_stdout();
4479 tmpgv = gv_fetchpvs("stdout", GV_ADD|GV_NOTQUAL, SVt_PV);
4481 GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4483 PL_stderrgv = gv_fetchpvs("STDERR", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4484 GvMULTI_on(PL_stderrgv);
4485 io = GvIOp(PL_stderrgv);
4486 IoTYPE(io) = IoTYPE_WRONLY;
4487 IoOFP(io) = IoIFP(io) = PerlIO_stderr();
4488 tmpgv = gv_fetchpvs("stderr", GV_ADD|GV_NOTQUAL, SVt_PV);
4490 GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4492 PL_statname = newSVpvs(""); /* last filename we did stat on */
4496 Perl_init_argv_symbols(pTHX_ int argc, char **argv)
4498 PERL_ARGS_ASSERT_INIT_ARGV_SYMBOLS;
4500 argc--,argv++; /* skip name of script */
4501 if (PL_doswitches) {
4502 for (; argc > 0 && **argv == '-'; argc--,argv++) {
4506 if (argv[0][1] == '-' && !argv[0][2]) {
4510 if ((s = strchr(argv[0], '='))) {
4511 const char *const start_name = argv[0] + 1;
4512 sv_setpv(GvSV(gv_fetchpvn_flags(start_name, s - start_name,
4513 TRUE, SVt_PV)), s + 1);
4516 sv_setiv(GvSV(gv_fetchpv(argv[0]+1, GV_ADD, SVt_PV)),1);
4519 if ((PL_argvgv = gv_fetchpvs("ARGV", GV_ADD|GV_NOTQUAL, SVt_PVAV))) {
4520 SvREFCNT_inc_simple_void_NN(PL_argvgv);
4521 GvMULTI_on(PL_argvgv);
4522 av_clear(GvAVn(PL_argvgv));
4523 for (; argc > 0; argc--,argv++) {
4524 SV * const sv = newSVpv(argv[0],0);
4525 av_push(GvAV(PL_argvgv),sv);
4526 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
4527 if (PL_unicode & PERL_UNICODE_ARGV_FLAG)
4530 if (PL_unicode & PERL_UNICODE_WIDESYSCALLS_FLAG) /* Sarathy? */
4531 (void)sv_utf8_decode(sv);
4535 if (PL_inplace && (!PL_argvgv || AvFILL(GvAV(PL_argvgv)) == -1))
4536 Perl_ck_warner_d(aTHX_ packWARN(WARN_INPLACE),
4537 "-i used with no filenames on the command line, "
4538 "reading from STDIN");
4542 S_init_postdump_symbols(pTHX_ int argc, char **argv, char **env)
4549 PERL_ARGS_ASSERT_INIT_POSTDUMP_SYMBOLS;
4551 PL_toptarget = newSV_type(SVt_PVIV);
4552 SvPVCLEAR(PL_toptarget);
4553 PL_bodytarget = newSV_type(SVt_PVIV);
4554 SvPVCLEAR(PL_bodytarget);
4555 PL_formtarget = PL_bodytarget;
4559 init_argv_symbols(argc,argv);
4561 if ((tmpgv = gv_fetchpvs("0", GV_ADD|GV_NOTQUAL, SVt_PV))) {
4562 sv_setpv(GvSV(tmpgv),PL_origfilename);
4564 if ((PL_envgv = gv_fetchpvs("ENV", GV_ADD|GV_NOTQUAL, SVt_PVHV))) {
4566 bool env_is_not_environ;
4567 SvREFCNT_inc_simple_void_NN(PL_envgv);
4568 GvMULTI_on(PL_envgv);
4569 hv = GvHVn(PL_envgv);
4570 hv_magic(hv, NULL, PERL_MAGIC_env);
4572 #ifdef USE_ENVIRON_ARRAY
4573 /* Note that if the supplied env parameter is actually a copy
4574 of the global environ then it may now point to free'd memory
4575 if the environment has been modified since. To avoid this
4576 problem we treat env==NULL as meaning 'use the default'
4580 env_is_not_environ = env != environ;
4581 if (env_is_not_environ
4582 # ifdef USE_ITHREADS
4583 && PL_curinterp == aTHX
4595 for (; *env; env++) {
4598 if (!(s = strchr(old_var,'=')) || s == old_var)
4602 #if defined(MSDOS) && !defined(DJGPP)
4604 (void)strupr(old_var);
4607 if (hv_exists(hv, old_var, nlen)) {
4608 const char *name = savepvn(old_var, nlen);
4610 /* make sure we use the same value as getenv(), otherwise code that
4611 uses getenv() (like setlocale()) might see a different value to %ENV
4613 sv = newSVpv(PerlEnv_getenv(name), 0);
4615 /* keep a count of the dups of this name so we can de-dup environ later */
4616 if (hv_exists(dups, name, nlen))
4617 ++SvIVX(*hv_fetch(dups, name, nlen, 0));
4619 (void)hv_store(dups, name, nlen, newSViv(1), 0);
4624 sv = newSVpv(s+1, 0);
4626 (void)hv_store(hv, old_var, nlen, sv, 0);
4627 if (env_is_not_environ)
4631 /* environ has some duplicate definitions, remove them */
4634 while ((entry = hv_iternext_flags(dups, 0))) {
4636 const char *name = HePV(entry, nlen);
4637 IV count = SvIV(HeVAL(entry));
4639 SV **valp = hv_fetch(hv, name, nlen, 0);
4643 /* try to remove any duplicate names, depending on the
4644 * implementation used in my_setenv() the iteration might
4645 * not be necessary, but let's be safe.
4647 for (i = 0; i < count; ++i)
4650 /* and set it back to the value we set $ENV{name} to */
4651 my_setenv(name, SvPV_nolen(*valp));
4654 SvREFCNT_dec_NN(dups);
4656 #endif /* USE_ENVIRON_ARRAY */
4657 #endif /* !PERL_MICRO */
4661 /* touch @F array to prevent spurious warnings 20020415 MJD */
4663 (void) get_av("main::F", GV_ADD | GV_ADDMULTI);
4668 S_init_perllib(pTHX)
4671 const char *perl5lib = NULL;
4674 #if defined(WIN32) && !defined(PERL_IS_MINIPERL)
4678 if (!TAINTING_get) {
4680 perl5lib = PerlEnv_getenv("PERL5LIB");
4682 * It isn't possible to delete an environment variable with
4683 * PERL_USE_SAFE_PUTENV set unless unsetenv() is also available, so in that
4684 * case we treat PERL5LIB as undefined if it has a zero-length value.
4686 #if defined(PERL_USE_SAFE_PUTENV) && ! defined(HAS_UNSETENV)
4687 if (perl5lib && *perl5lib != '\0')
4691 incpush_use_sep(perl5lib, 0, INCPUSH_ADD_SUB_DIRS);
4693 s = PerlEnv_getenv("PERLLIB");
4695 incpush_use_sep(s, 0, 0);
4698 /* Treat PERL5?LIB as a possible search list logical name -- the
4699 * "natural" VMS idiom for a Unix path string. We allow each
4700 * element to be a set of |-separated directories for compatibility.
4704 if (vmstrnenv("PERL5LIB",buf,0,NULL,0))
4706 incpush_use_sep(buf, 0, INCPUSH_ADD_SUB_DIRS);
4707 } while (vmstrnenv("PERL5LIB",buf,++idx,NULL,0));
4709 while (vmstrnenv("PERLLIB",buf,idx++,NULL,0))
4710 incpush_use_sep(buf, 0, 0);
4715 #ifndef PERL_IS_MINIPERL
4716 /* miniperl gets just -I..., the split of $ENV{PERL5LIB}, and "." in @INC
4717 (and not the architecture specific directories from $ENV{PERL5LIB}) */
4719 #include "perl_inc_macro.h"
4720 /* Use the ~-expanded versions of APPLLIB (undocumented),
4721 SITEARCH, SITELIB, VENDORARCH, VENDORLIB, ARCHLIB and PRIVLIB
4724 INCPUSH_SITEARCH_EXP
4726 INCPUSH_PERL_VENDORARCH_EXP
4727 INCPUSH_PERL_VENDORLIB_EXP
4730 INCPUSH_PERL_OTHERLIBDIRS
4732 INCPUSH_APPLLIB_OLD_EXP
4733 INCPUSH_SITELIB_STEM
4734 INCPUSH_PERL_VENDORLIB_STEM
4735 INCPUSH_PERL_OTHERLIBDIRS_ARCHONLY
4737 #endif /* !PERL_IS_MINIPERL */
4739 if (!TAINTING_get) {
4740 #if !defined(PERL_IS_MINIPERL) && defined(DEFAULT_INC_EXCLUDES_DOT)
4741 const char * const unsafe = PerlEnv_getenv("PERL_USE_UNSAFE_INC");
4742 if (unsafe && strEQ(unsafe, "1"))
4744 S_incpush(aTHX_ STR_WITH_LEN("."), 0);
4748 #if defined(DOSISH) || defined(__SYMBIAN32__)
4749 # define PERLLIB_SEP ';'
4750 #elif defined(__VMS)
4751 # define PERLLIB_SEP PL_perllib_sep
4753 # define PERLLIB_SEP ':'
4755 #ifndef PERLLIB_MANGLE
4756 # define PERLLIB_MANGLE(s,n) (s)
4759 #ifndef PERL_IS_MINIPERL
4760 /* Push a directory onto @INC if it exists.
4761 Generate a new SV if we do this, to save needing to copy the SV we push
4764 S_incpush_if_exists(pTHX_ AV *const av, SV *dir, SV *const stem)
4768 PERL_ARGS_ASSERT_INCPUSH_IF_EXISTS;
4770 if (PerlLIO_stat(SvPVX_const(dir), &tmpstatbuf) >= 0 &&
4771 S_ISDIR(tmpstatbuf.st_mode)) {
4773 dir = newSVsv(stem);
4775 /* Truncate dir back to stem. */
4776 SvCUR_set(dir, SvCUR(stem));
4783 S_mayberelocate(pTHX_ const char *const dir, STRLEN len, U32 flags)
4785 const U8 canrelocate = (U8)flags & INCPUSH_CAN_RELOCATE;
4788 PERL_ARGS_ASSERT_MAYBERELOCATE;
4791 /* I am not convinced that this is valid when PERLLIB_MANGLE is
4792 defined to so something (in os2/os2.c), but the code has been
4793 this way, ignoring any possible changed of length, since
4794 760ac839baf413929cd31cc32ffd6dba6b781a81 (5.003_02) so I'll leave
4796 libdir = newSVpvn(PERLLIB_MANGLE(dir, len), len);
4802 if ((unix = tounixspec_ts(SvPV(libdir,len),NULL)) != NULL) {
4804 while (len > 1 && unix[len-1] == '/') len--; /* Cosmetic */
4805 sv_usepvn(libdir,unix,len);
4808 PerlIO_printf(Perl_error_log,
4809 "Failed to unixify @INC element \"%s\"\n",
4810 SvPV_nolen_const(libdir));
4814 /* Do the if() outside the #ifdef to avoid warnings about an unused
4817 #ifdef PERL_RELOCATABLE_INC
4819 * Relocatable include entries are marked with a leading .../
4822 * 0: Remove that leading ".../"
4823 * 1: Remove trailing executable name (anything after the last '/')
4824 * from the perl path to give a perl prefix
4826 * While the @INC element starts "../" and the prefix ends with a real
4827 * directory (ie not . or ..) chop that real directory off the prefix
4828 * and the leading "../" from the @INC element. ie a logical "../"
4830 * Finally concatenate the prefix and the remainder of the @INC element
4831 * The intent is that /usr/local/bin/perl and .../../lib/perl5
4832 * generates /usr/local/lib/perl5
4834 const char *libpath = SvPVX(libdir);
4835 STRLEN libpath_len = SvCUR(libdir);
4836 if (memBEGINs(libpath, libpath_len, ".../")) {
4838 SV * const caret_X = get_sv("\030", 0);
4839 /* Going to use the SV just as a scratch buffer holding a C
4845 /* $^X is *the* source of taint if tainting is on, hence
4846 SvPOK() won't be true. */
4848 assert(SvPOKp(caret_X));
4849 prefix_sv = newSVpvn_flags(SvPVX(caret_X), SvCUR(caret_X),
4851 /* Firstly take off the leading .../
4852 If all else fail we'll do the paths relative to the current
4854 sv_chop(libdir, libpath + 4);
4855 /* Don't use SvPV as we're intentionally bypassing taining,
4856 mortal copies that the mg_get of tainting creates, and
4857 corruption that seems to come via the save stack.
4858 I guess that the save stack isn't correctly set up yet. */
4859 libpath = SvPVX(libdir);
4860 libpath_len = SvCUR(libdir);
4862 prefix = SvPVX(prefix_sv);
4863 lastslash = (char *) my_memrchr(prefix, '/',
4864 SvEND(prefix_sv) - prefix);
4866 /* First time in with the *lastslash = '\0' we just wipe off
4867 the trailing /perl from (say) /usr/foo/bin/perl
4871 while ((*lastslash = '\0'), /* Do that, come what may. */
4872 ( memBEGINs(libpath, libpath_len, "../")
4874 (char *) my_memrchr(prefix, '/',
4875 SvEND(prefix_sv) - prefix))))
4877 if (lastslash[1] == '\0'
4878 || (lastslash[1] == '.'
4879 && (lastslash[2] == '/' /* ends "/." */
4880 || (lastslash[2] == '/'
4881 && lastslash[3] == '/' /* or "/.." */
4883 /* Prefix ends "/" or "/." or "/..", any of which
4884 are fishy, so don't do any more logical cleanup.
4888 /* Remove leading "../" from path */
4891 /* Next iteration round the loop removes the last
4892 directory name from prefix by writing a '\0' in
4893 the while clause. */
4895 /* prefix has been terminated with a '\0' to the correct
4896 length. libpath points somewhere into the libdir SV.
4897 We need to join the 2 with '/' and drop the result into
4899 tempsv = Perl_newSVpvf(aTHX_ "%s/%s", prefix, libpath);
4900 SvREFCNT_dec(libdir);
4901 /* And this is the new libdir. */
4904 (PerlProc_getuid() != PerlProc_geteuid() ||
4905 PerlProc_getgid() != PerlProc_getegid())) {
4906 /* Need to taint relocated paths if running set ID */
4907 SvTAINTED_on(libdir);
4910 SvREFCNT_dec(prefix_sv);
4918 S_incpush(pTHX_ const char *const dir, STRLEN len, U32 flags)
4920 #ifndef PERL_IS_MINIPERL
4921 const U8 using_sub_dirs
4922 = (U8)flags & (INCPUSH_ADD_VERSIONED_SUB_DIRS
4923 |INCPUSH_ADD_ARCHONLY_SUB_DIRS|INCPUSH_ADD_OLD_VERS);
4924 const U8 add_versioned_sub_dirs
4925 = (U8)flags & INCPUSH_ADD_VERSIONED_SUB_DIRS;
4926 const U8 add_archonly_sub_dirs
4927 = (U8)flags & INCPUSH_ADD_ARCHONLY_SUB_DIRS;
4928 #ifdef PERL_INC_VERSION_LIST
4929 const U8 addoldvers = (U8)flags & INCPUSH_ADD_OLD_VERS;
4932 const U8 unshift = (U8)flags & INCPUSH_UNSHIFT;
4933 const U8 push_basedir = (flags & INCPUSH_NOT_BASEDIR) ? 0 : 1;
4934 AV *const inc = GvAVn(PL_incgv);
4936 PERL_ARGS_ASSERT_INCPUSH;
4939 /* Could remove this vestigial extra block, if we don't mind a lot of
4940 re-indenting diff noise. */
4942 SV *const libdir = mayberelocate(dir, len, flags);
4943 /* Change 20189146be79a0596543441fa369c6bf7f85103f, to fix RT#6665,
4944 arranged to unshift #! line -I onto the front of @INC. However,
4945 -I can add version and architecture specific libraries, and they
4946 need to go first. The old code assumed that it was always
4947 pushing. Hence to make it work, need to push the architecture
4948 (etc) libraries onto a temporary array, then "unshift" that onto
4949 the front of @INC. */
4950 #ifndef PERL_IS_MINIPERL
4951 AV *const av = (using_sub_dirs) ? (unshift ? newAV() : inc) : NULL;
4954 * BEFORE pushing libdir onto @INC we may first push version- and
4955 * archname-specific sub-directories.
4957 if (using_sub_dirs) {
4958 SV *subdir = newSVsv(libdir);
4959 #ifdef PERL_INC_VERSION_LIST
4960 /* Configure terminates PERL_INC_VERSION_LIST with a NULL */
4961 const char * const incverlist[] = { PERL_INC_VERSION_LIST };
4962 const char * const *incver;
4965 if (add_versioned_sub_dirs) {
4966 /* .../version/archname if -d .../version/archname */
4967 sv_catpvs(subdir, "/" PERL_FS_VERSION "/" ARCHNAME);
4968 subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
4970 /* .../version if -d .../version */
4971 sv_catpvs(subdir, "/" PERL_FS_VERSION);
4972 subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
4975 #ifdef PERL_INC_VERSION_LIST
4977 for (incver = incverlist; *incver; incver++) {
4978 /* .../xxx if -d .../xxx */
4979 Perl_sv_catpvf(aTHX_ subdir, "/%s", *incver);
4980 subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
4985 if (add_archonly_sub_dirs) {
4986 /* .../archname if -d .../archname */
4987 sv_catpvs(subdir, "/" ARCHNAME);
4988 subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
4992 assert (SvREFCNT(subdir) == 1);
4993 SvREFCNT_dec(subdir);
4995 #endif /* !PERL_IS_MINIPERL */
4996 /* finally add this lib directory at the end of @INC */
4998 #ifdef PERL_IS_MINIPERL
4999 const Size_t extra = 0;
5001 Size_t extra = av_tindex(av) + 1;
5003 av_unshift(inc, extra + push_basedir);
5005 av_store(inc, extra, libdir);
5006 #ifndef PERL_IS_MINIPERL
5008 /* av owns a reference, av_store() expects to be donated a
5009 reference, and av expects to be sane when it's cleared.
5010 If I wanted to be naughty and wrong, I could peek inside the
5011 implementation of av_clear(), realise that it uses
5012 SvREFCNT_dec() too, so av's array could be a run of NULLs,
5013 and so directly steal from it (with a memcpy() to inc, and
5014 then memset() to NULL them out. But people copy code from the
5015 core expecting it to be best practise, so let's use the API.
5016 Although studious readers will note that I'm not checking any
5018 av_store(inc, extra, SvREFCNT_inc(*av_fetch(av, extra, FALSE)));
5023 else if (push_basedir) {
5024 av_push(inc, libdir);
5027 if (!push_basedir) {
5028 assert (SvREFCNT(libdir) == 1);
5029 SvREFCNT_dec(libdir);
5035 S_incpush_use_sep(pTHX_ const char *p, STRLEN len, U32 flags)
5039 /* This logic has been broken out from S_incpush(). It may be possible to
5042 PERL_ARGS_ASSERT_INCPUSH_USE_SEP;
5044 /* perl compiled with -DPERL_RELOCATABLE_INCPUSH will ignore the len
5045 * argument to incpush_use_sep. This allows creation of relocatable
5046 * Perl distributions that patch the binary at install time. Those
5047 * distributions will have to provide their own relocation tools; this
5048 * is not a feature otherwise supported by core Perl.
5050 #ifndef PERL_RELOCATABLE_INCPUSH
5057 /* Break at all separators */
5058 while ((s = (const char*)memchr(p, PERLLIB_SEP, end - p))) {
5060 /* skip any consecutive separators */
5062 /* Uncomment the next line for PATH semantics */
5063 /* But you'll need to write tests */
5064 /* av_push(GvAVn(PL_incgv), newSVpvs(".")); */
5066 incpush(p, (STRLEN)(s - p), flags);
5071 incpush(p, (STRLEN)(end - p), flags);
5076 Perl_call_list(pTHX_ I32 oldscope, AV *paramList)
5079 volatile const line_t oldline = PL_curcop ? CopLINE(PL_curcop) : 0;
5085 PERL_ARGS_ASSERT_CALL_LIST;
5087 while (av_tindex(paramList) >= 0) {
5088 cv = MUTABLE_CV(av_shift(paramList));
5090 if (paramList == PL_beginav) {
5091 /* save PL_beginav for compiler */
5092 Perl_av_create_and_push(aTHX_ &PL_beginav_save, MUTABLE_SV(cv));
5094 else if (paramList == PL_checkav) {
5095 /* save PL_checkav for compiler */
5096 Perl_av_create_and_push(aTHX_ &PL_checkav_save, MUTABLE_SV(cv));
5098 else if (paramList == PL_unitcheckav) {
5099 /* save PL_unitcheckav for compiler */
5100 Perl_av_create_and_push(aTHX_ &PL_unitcheckav_save, MUTABLE_SV(cv));
5110 (void)SvPV_const(atsv, len);
5112 PL_curcop = &PL_compiling;
5113 CopLINE_set(PL_curcop, oldline);
5114 if (paramList == PL_beginav)
5115 sv_catpvs(atsv, "BEGIN failed--compilation aborted");
5117 Perl_sv_catpvf(aTHX_ atsv,
5118 "%s failed--call queue aborted",
5119 paramList == PL_checkav ? "CHECK"
5120 : paramList == PL_initav ? "INIT"
5121 : paramList == PL_unitcheckav ? "UNITCHECK"
5123 while (PL_scopestack_ix > oldscope)
5126 Perl_croak(aTHX_ "%" SVf, SVfARG(atsv));
5133 /* my_exit() was called */
5134 while (PL_scopestack_ix > oldscope)
5137 SET_CURSTASH(PL_defstash);
5138 PL_curcop = &PL_compiling;
5139 CopLINE_set(PL_curcop, oldline);
5142 NOT_REACHED; /* NOTREACHED */
5145 PL_curcop = &PL_compiling;
5146 CopLINE_set(PL_curcop, oldline);
5149 PerlIO_printf(Perl_error_log, "panic: restartop in call_list\n");
5158 Perl_my_exit(pTHX_ U32 status)
5160 if (PL_exit_flags & PERL_EXIT_ABORT) {
5163 if (PL_exit_flags & PERL_EXIT_WARN) {
5164 PL_exit_flags |= PERL_EXIT_ABORT; /* Protect against reentrant calls */
5165 Perl_warn(aTHX_ "Unexpected exit %lu", (unsigned long)status);
5166 PL_exit_flags &= ~PERL_EXIT_ABORT;
5176 STATUS_EXIT_SET(status);
5183 Perl_my_failure_exit(pTHX)
5186 /* We have been called to fall on our sword. The desired exit code
5187 * should be already set in STATUS_UNIX, but could be shifted over
5188 * by 8 bits. STATUS_UNIX_EXIT_SET will handle the cases where a
5191 * If an error code has not been set, then force the issue.
5193 if (MY_POSIX_EXIT) {
5195 /* According to the die_exit.t tests, if errno is non-zero */
5196 /* It should be used for the error status. */
5198 if (errno == EVMSERR) {
5199 STATUS_NATIVE = vaxc$errno;
5202 /* According to die_exit.t tests, if the child_exit code is */
5203 /* also zero, then we need to exit with a code of 255 */
5204 if ((errno != 0) && (errno < 256))
5205 STATUS_UNIX_EXIT_SET(errno);
5206 else if (STATUS_UNIX < 255) {
5207 STATUS_UNIX_EXIT_SET(255);
5212 /* The exit code could have been set by $? or vmsish which
5213 * means that it may not have fatal set. So convert
5214 * success/warning codes to fatal with out changing
5215 * the POSIX status code. The severity makes VMS native
5216 * status handling work, while UNIX mode programs use the
5217 * the POSIX exit codes.
5219 if ((STATUS_NATIVE & (STS$K_SEVERE|STS$K_ERROR)) == 0) {
5220 STATUS_NATIVE &= STS$M_COND_ID;
5221 STATUS_NATIVE |= STS$K_ERROR | STS$M_INHIB_MSG;
5225 /* Traditionally Perl on VMS always expects a Fatal Error. */
5226 if (vaxc$errno & 1) {
5228 /* So force success status to failure */
5229 if (STATUS_NATIVE & 1)
5234 STATUS_UNIX = EINTR; /* In case something cares */
5239 STATUS_NATIVE = vaxc$errno; /* Should already be this */
5241 /* Encode the severity code */
5242 severity = STATUS_NATIVE & STS$M_SEVERITY;
5243 STATUS_UNIX = (severity ? severity : 1) << 8;
5245 /* Perl expects this to be a fatal error */
5246 if (severity != STS$K_SEVERE)
5256 STATUS_UNIX_SET(eno);
5258 exitstatus = STATUS_UNIX >> 8;
5259 if (exitstatus & 255)
5260 STATUS_UNIX_SET(exitstatus);
5262 STATUS_UNIX_SET(255);
5265 if (PL_exit_flags & PERL_EXIT_ABORT) {
5268 if (PL_exit_flags & PERL_EXIT_WARN) {
5269 PL_exit_flags |= PERL_EXIT_ABORT; /* Protect against reentrant calls */
5270 Perl_warn(aTHX_ "Unexpected exit failure %ld", (long)PL_statusvalue);
5271 PL_exit_flags &= ~PERL_EXIT_ABORT;
5277 S_my_exit_jump(pTHX)
5280 SvREFCNT_dec(PL_e_script);
5284 POPSTACK_TO(PL_mainstack);
5285 if (cxstack_ix >= 0) {
5287 cx_popblock(cxstack);
5295 read_e_script(pTHX_ int idx, SV *buf_sv, int maxlen)
5297 const char * const p = SvPVX_const(PL_e_script);
5298 const char * const e = SvEND(PL_e_script);
5299 const char *nl = (char *) memchr(p, '\n', e - p);
5301 PERL_UNUSED_ARG(idx);
5302 PERL_UNUSED_ARG(maxlen);
5304 nl = (nl) ? nl+1 : e;
5306 filter_del(read_e_script);
5309 sv_catpvn(buf_sv, p, nl-p);
5310 sv_chop(PL_e_script, nl);
5314 /* removes boilerplate code at the end of each boot_Module xsub */
5316 Perl_xs_boot_epilog(pTHX_ const I32 ax)
5319 call_list(PL_scopestack_ix, PL_unitcheckav);
5324 * ex: set ts=8 sts=4 sw=4 et: