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);
325 #if defined(LOCAL_PATCH_COUNT)
326 PL_localpatches = local_patches; /* For possible -v */
329 #if defined(LIBM_LIB_VERSION)
331 * Some BSDs and Cygwin default to POSIX math instead of IEEE.
332 * This switches them over to IEEE.
334 _LIB_VERSION = _IEEE_;
337 #ifdef HAVE_INTERP_INTERN
341 PerlIO_init(aTHX); /* Hook to IO system */
343 PL_fdpid = newAV(); /* for remembering popen pids by fd */
344 PL_modglobal = newHV(); /* pointers to per-interpreter module globals */
345 PL_errors = newSVpvs("");
346 SvPVCLEAR(PERL_DEBUG_PAD(0)); /* For regex debugging. */
347 SvPVCLEAR(PERL_DEBUG_PAD(1)); /* ext/re needs these */
348 SvPVCLEAR(PERL_DEBUG_PAD(2)); /* even without DEBUGGING. */
350 /* First entry is a list of empty elements. It needs to be initialised
351 else all hell breaks loose in S_find_uninit_var(). */
352 Perl_av_create_and_push(aTHX_ &PL_regex_padav, newSVpvs(""));
353 PL_regex_pad = AvARRAY(PL_regex_padav);
354 Newxz(PL_stashpad, PL_stashpadmax, HV *);
356 #ifdef USE_REENTRANT_API
357 Perl_reentrant_init(aTHX);
359 if (PL_hash_seed_set == FALSE) {
360 /* Initialize the hash seed and state at startup. This must be
361 * done very early, before ANY hashes are constructed, and once
362 * setup is fixed for the lifetime of the process.
364 * If you decide to disable the seeding process you should choose
365 * a suitable seed yourself and define PERL_HASH_SEED to a well chosen
366 * string. See hv_func.h for details.
368 #if defined(USE_HASH_SEED)
369 /* get the hash seed from the environment or from an RNG */
370 Perl_get_hash_seed(aTHX_ PL_hash_seed);
372 /* they want a hard coded seed, check that it is long enough */
373 assert( strlen(PERL_HASH_SEED) >= PERL_HASH_SEED_BYTES );
376 /* now we use the chosen seed to initialize the state -
377 * in some configurations this may be a relatively speaking
378 * expensive operation, but we only have to do it once at startup */
379 PERL_HASH_SEED_STATE(PERL_HASH_SEED,PL_hash_state);
381 #ifdef PERL_USE_SINGLE_CHAR_HASH_CACHE
382 /* we can build a special cache for 0/1 byte keys, if people choose
383 * I suspect most of the time it is not worth it */
387 for (i=0;i<256;i++) {
389 PERL_HASH_WITH_STATE(PL_hash_state,PL_hash_chars[i],str,1);
391 PERL_HASH_WITH_STATE(PL_hash_state,PL_hash_chars[256],str,0);
394 /* at this point we have initialezed the hash function, and we can start
395 * constructing hashes */
396 PL_hash_seed_set= TRUE;
399 /* Allow PL_strtab to be pre-initialized before calling perl_construct.
400 * can use a custom optimized PL_strtab hash before calling perl_construct */
402 /* Note that strtab is a rather special HV. Assumptions are made
403 about not iterating on it, and not adding tie magic to it.
404 It is properly deallocated in perl_destruct() */
407 /* SHAREKEYS tells us that the hash has its keys shared with PL_strtab,
408 * which is not the case with PL_strtab itself */
409 HvSHAREKEYS_off(PL_strtab); /* mandatory */
410 hv_ksplit(PL_strtab, 1 << 11);
413 Zero(PL_sv_consts, SV_CONSTS_COUNT, SV*);
416 # ifdef USE_ENVIRON_ARRAY
417 PL_origenviron = environ;
421 /* Use sysconf(_SC_CLK_TCK) if available, if not
422 * available or if the sysconf() fails, use the HZ.
423 * The HZ if not originally defined has been by now
424 * been defined as CLK_TCK, if available. */
425 #if defined(HAS_SYSCONF) && defined(_SC_CLK_TCK)
426 PL_clocktick = sysconf(_SC_CLK_TCK);
427 if (PL_clocktick <= 0)
431 PL_stashcache = newHV();
433 PL_patchlevel = newSVpvs("v" PERL_VERSION_STRING);
436 if (!PL_mmap_page_size) {
437 #if defined(HAS_SYSCONF) && (defined(_SC_PAGESIZE) || defined(_SC_MMAP_PAGE_SIZE))
439 SETERRNO(0, SS_NORMAL);
441 PL_mmap_page_size = sysconf(_SC_PAGESIZE);
443 PL_mmap_page_size = sysconf(_SC_MMAP_PAGE_SIZE);
445 if ((long) PL_mmap_page_size < 0) {
446 Perl_croak(aTHX_ "panic: sysconf: %s",
447 errno ? Strerror(errno) : "pagesize unknown");
450 #elif defined(HAS_GETPAGESIZE)
451 PL_mmap_page_size = getpagesize();
452 #elif defined(I_SYS_PARAM) && defined(PAGESIZE)
453 PL_mmap_page_size = PAGESIZE; /* compiletime, bad */
455 if (PL_mmap_page_size <= 0)
456 Perl_croak(aTHX_ "panic: bad pagesize %" IVdf,
457 (IV) PL_mmap_page_size);
459 #endif /* HAS_MMAP */
461 #if defined(HAS_TIMES) && defined(PERL_NEED_TIMESBASE)
462 PL_timesbase.tms_utime = 0;
463 PL_timesbase.tms_stime = 0;
464 PL_timesbase.tms_cutime = 0;
465 PL_timesbase.tms_cstime = 0;
468 PL_osname = Perl_savepvn(aTHX_ STR_WITH_LEN(OSNAME));
470 PL_registered_mros = newHV();
471 /* Start with 1 bucket, for DFS. It's unlikely we'll need more. */
472 HvMAX(PL_registered_mros) = 0;
474 #ifdef HAS_POSIX_2008_LOCALE
475 PL_C_locale_obj = newlocale(LC_ALL_MASK, "C", NULL);
482 =for apidoc nothreadhook
484 Stub that provides thread hook for perl_destruct when there are
491 Perl_nothreadhook(pTHX)
497 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
499 Perl_dump_sv_child(pTHX_ SV *sv)
502 const int sock = PL_dumper_fd;
503 const int debug_fd = PerlIO_fileno(Perl_debug_log);
504 union control_un control;
507 struct cmsghdr *cmptr;
509 unsigned char buffer[256];
511 PERL_ARGS_ASSERT_DUMP_SV_CHILD;
513 if(sock == -1 || debug_fd == -1)
516 PerlIO_flush(Perl_debug_log);
518 /* All these shenanigans are to pass a file descriptor over to our child for
519 it to dump out to. We can't let it hold open the file descriptor when it
520 forks, as the file descriptor it will dump to can turn out to be one end
521 of pipe that some other process will wait on for EOF. (So as it would
522 be open, the wait would be forever.) */
524 msg.msg_control = control.control;
525 msg.msg_controllen = sizeof(control.control);
526 /* We're a connected socket so we don't need a destination */
532 cmptr = CMSG_FIRSTHDR(&msg);
533 cmptr->cmsg_len = CMSG_LEN(sizeof(int));
534 cmptr->cmsg_level = SOL_SOCKET;
535 cmptr->cmsg_type = SCM_RIGHTS;
536 *((int *)CMSG_DATA(cmptr)) = 1;
538 vec[0].iov_base = (void*)&sv;
539 vec[0].iov_len = sizeof(sv);
540 got = sendmsg(sock, &msg, 0);
543 perror("Debug leaking scalars parent sendmsg failed");
546 if(got < sizeof(sv)) {
547 perror("Debug leaking scalars parent short sendmsg");
551 /* Return protocol is
553 unsigned char: length of location string (0 for empty)
554 unsigned char*: string (not terminated)
556 vec[0].iov_base = (void*)&returned_errno;
557 vec[0].iov_len = sizeof(returned_errno);
558 vec[1].iov_base = buffer;
561 got = readv(sock, vec, 2);
564 perror("Debug leaking scalars parent read failed");
565 PerlIO_flush(PerlIO_stderr());
568 if(got < sizeof(returned_errno) + 1) {
569 perror("Debug leaking scalars parent short read");
570 PerlIO_flush(PerlIO_stderr());
575 got = read(sock, buffer + 1, *buffer);
577 perror("Debug leaking scalars parent read 2 failed");
578 PerlIO_flush(PerlIO_stderr());
583 perror("Debug leaking scalars parent short read 2");
584 PerlIO_flush(PerlIO_stderr());
589 if (returned_errno || *buffer) {
590 Perl_warn(aTHX_ "Debug leaking scalars child failed%s%.*s with errno"
591 " %d: %s", (*buffer ? " at " : ""), (int) *buffer, buffer + 1,
592 returned_errno, Strerror(returned_errno));
598 =for apidoc Am|int|perl_destruct|PerlInterpreter *my_perl
600 Shuts down a Perl interpreter. See L<perlembed> for a tutorial.
602 C<my_perl> points to the Perl interpreter. It must have been previously
603 created through the use of L</perl_alloc> and L</perl_construct>. It may
604 have been initialised through L</perl_parse>, and may have been used
605 through L</perl_run> and other means. This function should be called for
606 any Perl interpreter that has been constructed with L</perl_construct>,
607 even if subsequent operations on it failed, for example if L</perl_parse>
608 returned a non-zero value.
610 If the interpreter's C<PL_exit_flags> word has the
611 C<PERL_EXIT_DESTRUCT_END> flag set, then this function will execute code
612 in C<END> blocks before performing the rest of destruction. If it is
613 desired to make any use of the interpreter between L</perl_parse> and
614 L</perl_destruct> other than just calling L</perl_run>, then this flag
615 should be set early on. This matters if L</perl_run> will not be called,
616 or if anything else will be done in addition to calling L</perl_run>.
618 Returns a value be a suitable value to pass to the C library function
619 C<exit> (or to return from C<main>), to serve as an exit code indicating
620 the nature of the way the interpreter terminated. This takes into account
621 any failure of L</perl_parse> and any early exit from L</perl_run>.
622 The exit code is of the type required by the host operating system,
623 so because of differing exit code conventions it is not portable to
624 interpret specific numeric values as having specific meanings.
633 volatile signed char destruct_level; /* see possible values in intrpvar.h */
635 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
640 PERL_ARGS_ASSERT_PERL_DESTRUCT;
642 PERL_UNUSED_ARG(my_perl);
645 assert(PL_scopestack_ix == 1);
647 /* wait for all pseudo-forked children to finish */
648 PERL_WAIT_FOR_CHILDREN;
650 destruct_level = PL_perl_destruct_level;
651 #if defined(DEBUGGING) || defined(PERL_TRACK_MEMPOOL)
653 const char * const s = PerlEnv_getenv("PERL_DESTRUCT_LEVEL");
656 if (strEQ(s, "-1")) { /* Special case: modperl folklore. */
660 if (grok_atoUV(s, &uv, NULL) && uv <= INT_MAX)
666 if (destruct_level < i) destruct_level = i;
668 #ifdef PERL_TRACK_MEMPOOL
669 /* RT #114496, for perl_free */
670 PL_perl_destruct_level = i;
676 if (PL_exit_flags & PERL_EXIT_DESTRUCT_END) {
682 if (PL_endav && !PL_minus_c) {
683 PERL_SET_PHASE(PERL_PHASE_END);
684 call_list(PL_scopestack_ix, PL_endav);
690 assert(PL_scopestack_ix == 0);
692 /* Need to flush since END blocks can produce output */
693 /* flush stdout separately, since we can identify it */
696 PerlIO *stdo = PerlIO_stdout();
697 if (*stdo && PerlIO_flush(stdo)) {
698 PerlIO_restore_errno(stdo);
700 PerlIO_printf(PerlIO_stderr(), "Unable to flush stdout: %s\n",
709 #ifdef PERL_TRACE_OPS
710 /* dump OP-counts if $ENV{PERL_TRACE_OPS} > 0 */
712 const char * const ptoenv = PerlEnv_getenv("PERL_TRACE_OPS");
715 if (!ptoenv || !Perl_grok_atoUV(ptoenv, &uv, NULL)
719 PerlIO_printf(Perl_debug_log, "Trace of all OPs executed:\n");
720 for (i = 0; i <= OP_max; ++i) {
721 if (PL_op_exec_cnt[i])
722 PerlIO_printf(Perl_debug_log, " %s: %" UVuf "\n", PL_op_name[i], PL_op_exec_cnt[i]);
724 /* Utility slot for easily doing little tracing experiments in the runloop: */
725 if (PL_op_exec_cnt[OP_max+1] != 0)
726 PerlIO_printf(Perl_debug_log, " SPECIAL: %" UVuf "\n", PL_op_exec_cnt[OP_max+1]);
727 PerlIO_printf(Perl_debug_log, "\n");
732 if (PL_threadhook(aTHX)) {
733 /* Threads hook has vetoed further cleanup */
734 PL_veto_cleanup = TRUE;
738 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
739 if (destruct_level != 0) {
740 /* Fork here to create a child. Our child's job is to preserve the
741 state of scalars prior to destruction, so that we can instruct it
742 to dump any scalars that we later find have leaked.
743 There's no subtlety in this code - it assumes POSIX, and it doesn't
747 if(PerlSock_socketpair_cloexec(AF_UNIX, SOCK_STREAM, 0, fd)) {
748 perror("Debug leaking scalars socketpair failed");
754 perror("Debug leaking scalars fork failed");
758 /* We are the child */
759 const int sock = fd[1];
760 const int debug_fd = PerlIO_fileno(Perl_debug_log);
763 /* Our success message is an integer 0, and a char 0 */
764 static const char success[sizeof(int) + 1] = {0};
768 /* We need to close all other file descriptors otherwise we end up
769 with interesting hangs, where the parent closes its end of a
770 pipe, and sits waiting for (another) child to terminate. Only
771 that child never terminates, because it never gets EOF, because
772 we also have the far end of the pipe open. We even need to
773 close the debugging fd, because sometimes it happens to be one
774 end of a pipe, and a process is waiting on the other end for
775 EOF. Normally it would be closed at some point earlier in
776 destruction, but if we happen to cause the pipe to remain open,
777 EOF never occurs, and we get an infinite hang. Hence all the
778 games to pass in a file descriptor if it's actually needed. */
780 f = sysconf(_SC_OPEN_MAX);
782 where = "sysconf failed";
793 union control_un control;
796 struct cmsghdr *cmptr;
800 msg.msg_control = control.control;
801 msg.msg_controllen = sizeof(control.control);
802 /* We're a connected socket so we don't need a source */
806 msg.msg_iovlen = C_ARRAY_LENGTH(vec);
808 vec[0].iov_base = (void*)⌖
809 vec[0].iov_len = sizeof(target);
811 got = recvmsg(sock, &msg, 0);
816 where = "recv failed";
819 if(got < sizeof(target)) {
820 where = "short recv";
824 if(!(cmptr = CMSG_FIRSTHDR(&msg))) {
828 if(cmptr->cmsg_len != CMSG_LEN(sizeof(int))) {
829 where = "wrong cmsg_len";
832 if(cmptr->cmsg_level != SOL_SOCKET) {
833 where = "wrong cmsg_level";
836 if(cmptr->cmsg_type != SCM_RIGHTS) {
837 where = "wrong cmsg_type";
841 got_fd = *(int*)CMSG_DATA(cmptr);
842 /* For our last little bit of trickery, put the file descriptor
843 back into Perl_debug_log, as if we never actually closed it
845 if(got_fd != debug_fd) {
846 if (PerlLIO_dup2_cloexec(got_fd, debug_fd) == -1) {
853 PerlIO_flush(Perl_debug_log);
855 got = write(sock, &success, sizeof(success));
858 where = "write failed";
861 if(got < sizeof(success)) {
862 where = "short write";
869 int send_errno = errno;
870 unsigned char length = (unsigned char) strlen(where);
871 struct iovec failure[3] = {
872 {(void*)&send_errno, sizeof(send_errno)},
874 {(void*)where, length}
876 int got = writev(sock, failure, 3);
877 /* Bad news travels fast. Faster than data. We'll get a SIGPIPE
878 in the parent if we try to read from the socketpair after the
879 child has exited, even if there was data to read.
880 So sleep a bit to give the parent a fighting chance of
883 _exit((got == -1) ? errno : 0);
887 PL_dumper_fd = fd[0];
892 /* We must account for everything. */
894 /* Destroy the main CV and syntax tree */
895 /* Set PL_curcop now, because destroying ops can cause new SVs
896 to be generated in Perl_pad_swipe, and when running with
897 -DDEBUG_LEAKING_SCALARS they expect PL_curcop to point to a valid
898 op from which the filename structure member is copied. */
899 PL_curcop = &PL_compiling;
901 /* ensure comppad/curpad to refer to main's pad */
902 if (CvPADLIST(PL_main_cv)) {
903 PAD_SET_CUR_NOSAVE(CvPADLIST(PL_main_cv), 1);
904 PL_comppad_name = PadlistNAMES(CvPADLIST(PL_main_cv));
906 op_free(PL_main_root);
909 PL_main_start = NULL;
910 /* note that PL_main_cv isn't usually actually freed at this point,
911 * due to the CvOUTSIDE refs from subs compiled within it. It will
912 * get freed once all the subs are freed in sv_clean_all(), for
913 * destruct_level > 0 */
914 SvREFCNT_dec(PL_main_cv);
916 PERL_SET_PHASE(PERL_PHASE_DESTRUCT);
918 /* Tell PerlIO we are about to tear things apart in case
919 we have layers which are using resources that should
923 PerlIO_destruct(aTHX);
926 * Try to destruct global references. We do this first so that the
927 * destructors and destructees still exist. Some sv's might remain.
928 * Non-referenced objects are on their own.
932 /* unhook hooks which will soon be, or use, destroyed data */
933 SvREFCNT_dec(PL_warnhook);
935 SvREFCNT_dec(PL_diehook);
938 /* call exit list functions */
939 while (PL_exitlistlen-- > 0)
940 PL_exitlist[PL_exitlistlen].fn(aTHX_ PL_exitlist[PL_exitlistlen].ptr);
942 Safefree(PL_exitlist);
947 SvREFCNT_dec(PL_registered_mros);
949 /* jettison our possibly duplicated environment */
950 /* if PERL_USE_SAFE_PUTENV is defined environ will not have been copied
951 * so we certainly shouldn't free it here
954 #if defined(USE_ENVIRON_ARRAY) && !defined(PERL_USE_SAFE_PUTENV)
955 if (environ != PL_origenviron && !PL_use_safe_putenv
957 /* only main thread can free environ[0] contents */
958 && PL_curinterp == aTHX
964 for (i = 0; environ[i]; i++)
965 safesysfree(environ[i]);
967 /* Must use safesysfree() when working with environ. */
968 safesysfree(environ);
970 environ = PL_origenviron;
973 #endif /* !PERL_MICRO */
975 if (destruct_level == 0) {
977 DEBUG_P(debprofdump());
979 #if defined(PERLIO_LAYERS)
980 /* No more IO - including error messages ! */
981 PerlIO_cleanup(aTHX);
984 CopFILE_free(&PL_compiling);
986 /* The exit() function will do everything that needs doing. */
990 /* Below, do clean up for when PERL_DESTRUCT_LEVEL is not 0 */
993 /* the syntax tree is shared between clones
994 * so op_free(PL_main_root) only ReREFCNT_dec's
995 * REGEXPs in the parent interpreter
996 * we need to manually ReREFCNT_dec for the clones
999 I32 i = AvFILLp(PL_regex_padav);
1000 SV **ary = AvARRAY(PL_regex_padav);
1003 SvREFCNT_dec(ary[i]);
1004 ary[i] = &PL_sv_undef;
1010 SvREFCNT_dec(MUTABLE_SV(PL_stashcache));
1011 PL_stashcache = NULL;
1013 /* loosen bonds of global variables */
1015 /* XXX can PL_parser still be non-null here? */
1016 if(PL_parser && PL_parser->rsfp) {
1017 (void)PerlIO_close(PL_parser->rsfp);
1018 PL_parser->rsfp = NULL;
1022 Safefree(PL_splitstr);
1032 PL_doswitches = FALSE;
1033 PL_dowarn = G_WARN_OFF;
1034 #ifdef PERL_SAWAMPERSAND
1035 PL_sawampersand = 0; /* must save all match strings */
1039 Safefree(PL_inplace);
1041 SvREFCNT_dec(PL_patchlevel);
1044 SvREFCNT_dec(PL_e_script);
1050 /* magical thingies */
1052 SvREFCNT_dec(PL_ofsgv); /* *, */
1055 SvREFCNT_dec(PL_ors_sv); /* $\ */
1058 SvREFCNT_dec(PL_rs); /* $/ */
1061 Safefree(PL_osname); /* $^O */
1064 SvREFCNT_dec(PL_statname);
1068 /* defgv, aka *_ should be taken care of elsewhere */
1071 Safefree(PL_efloatbuf);
1072 PL_efloatbuf = NULL;
1075 /* startup and shutdown function lists */
1076 SvREFCNT_dec(PL_beginav);
1077 SvREFCNT_dec(PL_beginav_save);
1078 SvREFCNT_dec(PL_endav);
1079 SvREFCNT_dec(PL_checkav);
1080 SvREFCNT_dec(PL_checkav_save);
1081 SvREFCNT_dec(PL_unitcheckav);
1082 SvREFCNT_dec(PL_unitcheckav_save);
1083 SvREFCNT_dec(PL_initav);
1085 PL_beginav_save = NULL;
1088 PL_checkav_save = NULL;
1089 PL_unitcheckav = NULL;
1090 PL_unitcheckav_save = NULL;
1093 /* shortcuts just get cleared */
1096 PL_argvoutgv = NULL;
1099 PL_last_in_gv = NULL;
1110 SvREFCNT_dec(PL_envgv);
1111 SvREFCNT_dec(PL_incgv);
1112 SvREFCNT_dec(PL_argvgv);
1113 SvREFCNT_dec(PL_replgv);
1114 SvREFCNT_dec(PL_DBgv);
1115 SvREFCNT_dec(PL_DBline);
1116 SvREFCNT_dec(PL_DBsub);
1125 SvREFCNT_dec(PL_argvout_stack);
1126 PL_argvout_stack = NULL;
1128 SvREFCNT_dec(PL_modglobal);
1129 PL_modglobal = NULL;
1130 SvREFCNT_dec(PL_preambleav);
1131 PL_preambleav = NULL;
1132 SvREFCNT_dec(PL_subname);
1134 #ifdef PERL_USES_PL_PIDSTATUS
1135 SvREFCNT_dec(PL_pidstatus);
1136 PL_pidstatus = NULL;
1138 SvREFCNT_dec(PL_toptarget);
1139 PL_toptarget = NULL;
1140 SvREFCNT_dec(PL_bodytarget);
1141 PL_bodytarget = NULL;
1142 PL_formtarget = NULL;
1144 /* free locale stuff */
1145 #ifdef USE_LOCALE_COLLATE
1146 Safefree(PL_collation_name);
1147 PL_collation_name = NULL;
1149 #if defined(USE_POSIX_2008_LOCALE) \
1150 && defined(USE_THREAD_SAFE_LOCALE) \
1151 && ! defined(HAS_QUERYLOCALE)
1152 for (i = 0; i < (int) C_ARRAY_LENGTH(PL_curlocales); i++) {
1153 Safefree(PL_curlocales[i]);
1154 PL_curlocales[i] = NULL;
1157 #ifdef USE_LOCALE_NUMERIC
1158 Safefree(PL_numeric_name);
1159 PL_numeric_name = NULL;
1160 SvREFCNT_dec(PL_numeric_radix_sv);
1161 PL_numeric_radix_sv = NULL;
1163 # ifdef HAS_POSIX_2008_LOCALE
1164 if (PL_underlying_numeric_obj) {
1165 /* Make sure we aren't using the locale space we are about to free */
1166 uselocale(LC_GLOBAL_LOCALE);
1167 freelocale(PL_underlying_numeric_obj);
1168 PL_underlying_numeric_obj = (locale_t) NULL;
1173 if (PL_setlocale_buf) {
1174 Safefree(PL_setlocale_buf);
1175 PL_setlocale_buf = NULL;
1178 if (PL_langinfo_buf) {
1179 Safefree(PL_langinfo_buf);
1180 PL_langinfo_buf = NULL;
1183 /* clear character classes */
1184 for (i = 0; i < POSIX_SWASH_COUNT; i++) {
1185 SvREFCNT_dec(PL_utf8_swash_ptrs[i]);
1186 PL_utf8_swash_ptrs[i] = NULL;
1188 SvREFCNT_dec(PL_utf8_mark);
1189 SvREFCNT_dec(PL_utf8_toupper);
1190 SvREFCNT_dec(PL_utf8_totitle);
1191 SvREFCNT_dec(PL_utf8_tolower);
1192 SvREFCNT_dec(PL_utf8_tofold);
1193 SvREFCNT_dec(PL_utf8_idstart);
1194 SvREFCNT_dec(PL_utf8_idcont);
1195 SvREFCNT_dec(PL_utf8_foldable);
1196 SvREFCNT_dec(PL_utf8_foldclosures);
1197 SvREFCNT_dec(PL_AboveLatin1);
1198 SvREFCNT_dec(PL_InBitmap);
1199 SvREFCNT_dec(PL_UpperLatin1);
1200 SvREFCNT_dec(PL_Latin1);
1201 SvREFCNT_dec(PL_NonL1NonFinalFold);
1202 SvREFCNT_dec(PL_HasMultiCharFold);
1203 #ifdef USE_LOCALE_CTYPE
1204 SvREFCNT_dec(PL_warn_locale);
1206 PL_utf8_mark = NULL;
1207 PL_utf8_toupper = NULL;
1208 PL_utf8_totitle = NULL;
1209 PL_utf8_tolower = NULL;
1210 PL_utf8_tofold = NULL;
1211 PL_utf8_idstart = NULL;
1212 PL_utf8_idcont = NULL;
1213 PL_utf8_foldclosures = NULL;
1214 PL_AboveLatin1 = NULL;
1216 PL_HasMultiCharFold = NULL;
1217 #ifdef USE_LOCALE_CTYPE
1218 PL_warn_locale = NULL;
1221 PL_NonL1NonFinalFold = NULL;
1222 PL_UpperLatin1 = NULL;
1223 for (i = 0; i < POSIX_CC_COUNT; i++) {
1224 SvREFCNT_dec(PL_XPosix_ptrs[i]);
1225 PL_XPosix_ptrs[i] = NULL;
1227 PL_GCB_invlist = NULL;
1228 PL_LB_invlist = NULL;
1229 PL_SB_invlist = NULL;
1230 PL_SCX_invlist = NULL;
1231 PL_WB_invlist = NULL;
1232 PL_Assigned_invlist = NULL;
1234 if (!specialWARN(PL_compiling.cop_warnings))
1235 PerlMemShared_free(PL_compiling.cop_warnings);
1236 PL_compiling.cop_warnings = NULL;
1237 cophh_free(CopHINTHASH_get(&PL_compiling));
1238 CopHINTHASH_set(&PL_compiling, cophh_new_empty());
1239 CopFILE_free(&PL_compiling);
1241 /* Prepare to destruct main symbol table. */
1244 /* break ref loop *:: <=> %:: */
1245 (void)hv_deletes(hv, "main::", G_DISCARD);
1248 SvREFCNT_dec(PL_curstname);
1249 PL_curstname = NULL;
1251 /* clear queued errors */
1252 SvREFCNT_dec(PL_errors);
1255 SvREFCNT_dec(PL_isarev);
1258 if (destruct_level >= 2) {
1259 if (PL_scopestack_ix != 0)
1260 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
1261 "Unbalanced scopes: %ld more ENTERs than LEAVEs\n",
1262 (long)PL_scopestack_ix);
1263 if (PL_savestack_ix != 0)
1264 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
1265 "Unbalanced saves: %ld more saves than restores\n",
1266 (long)PL_savestack_ix);
1267 if (PL_tmps_floor != -1)
1268 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced tmps: %ld more allocs than frees\n",
1269 (long)PL_tmps_floor + 1);
1270 if (cxstack_ix != -1)
1271 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced context: %ld more PUSHes than POPs\n",
1272 (long)cxstack_ix + 1);
1276 SvREFCNT_dec(PL_regex_padav);
1277 PL_regex_padav = NULL;
1278 PL_regex_pad = NULL;
1281 #ifdef PERL_IMPLICIT_CONTEXT
1282 /* the entries in this list are allocated via SV PVX's, so get freed
1283 * in sv_clean_all */
1284 Safefree(PL_my_cxt_list);
1287 /* Now absolutely destruct everything, somehow or other, loops or no. */
1289 /* the 2 is for PL_fdpid and PL_strtab */
1290 while (sv_clean_all() > 2)
1294 Safefree(PL_stashpad); /* must come after sv_clean_all */
1297 AvREAL_off(PL_fdpid); /* no surviving entries */
1298 SvREFCNT_dec(PL_fdpid); /* needed in io_close() */
1301 #ifdef HAVE_INTERP_INTERN
1305 /* constant strings */
1306 for (i = 0; i < SV_CONSTS_COUNT; i++) {
1307 SvREFCNT_dec(PL_sv_consts[i]);
1308 PL_sv_consts[i] = NULL;
1311 /* Destruct the global string table. */
1313 /* Yell and reset the HeVAL() slots that are still holding refcounts,
1314 * so that sv_free() won't fail on them.
1315 * Now that the global string table is using a single hunk of memory
1316 * for both HE and HEK, we either need to explicitly unshare it the
1317 * correct way, or actually free things here.
1320 const I32 max = HvMAX(PL_strtab);
1321 HE * const * const array = HvARRAY(PL_strtab);
1322 HE *hent = array[0];
1325 if (hent && ckWARN_d(WARN_INTERNAL)) {
1326 HE * const next = HeNEXT(hent);
1327 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
1328 "Unbalanced string table refcount: (%ld) for \"%s\"",
1329 (long)hent->he_valu.hent_refcount, HeKEY(hent));
1336 hent = array[riter];
1341 HvARRAY(PL_strtab) = 0;
1342 HvTOTALKEYS(PL_strtab) = 0;
1344 SvREFCNT_dec(PL_strtab);
1347 /* free the pointer tables used for cloning */
1348 ptr_table_free(PL_ptr_table);
1349 PL_ptr_table = (PTR_TBL_t*)NULL;
1352 /* free special SVs */
1354 SvREFCNT(&PL_sv_yes) = 0;
1355 sv_clear(&PL_sv_yes);
1356 SvANY(&PL_sv_yes) = NULL;
1357 SvFLAGS(&PL_sv_yes) = 0;
1359 SvREFCNT(&PL_sv_no) = 0;
1360 sv_clear(&PL_sv_no);
1361 SvANY(&PL_sv_no) = NULL;
1362 SvFLAGS(&PL_sv_no) = 0;
1364 SvREFCNT(&PL_sv_zero) = 0;
1365 sv_clear(&PL_sv_zero);
1366 SvANY(&PL_sv_zero) = NULL;
1367 SvFLAGS(&PL_sv_zero) = 0;
1371 for (i=0; i<=2; i++) {
1372 SvREFCNT(PERL_DEBUG_PAD(i)) = 0;
1373 sv_clear(PERL_DEBUG_PAD(i));
1374 SvANY(PERL_DEBUG_PAD(i)) = NULL;
1375 SvFLAGS(PERL_DEBUG_PAD(i)) = 0;
1379 if (PL_sv_count != 0 && ckWARN_d(WARN_INTERNAL))
1380 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Scalars leaked: %ld\n", (long)PL_sv_count);
1382 #ifdef DEBUG_LEAKING_SCALARS
1383 if (PL_sv_count != 0) {
1388 for (sva = PL_sv_arenaroot; sva; sva = MUTABLE_SV(SvANY(sva))) {
1389 svend = &sva[SvREFCNT(sva)];
1390 for (sv = sva + 1; sv < svend; ++sv) {
1391 if (SvTYPE(sv) != (svtype)SVTYPEMASK) {
1392 PerlIO_printf(Perl_debug_log, "leaked: sv=0x%p"
1394 " refcnt=%"UVuf pTHX__FORMAT "\n"
1395 "\tallocated at %s:%d %s %s (parent 0x%" UVxf ");"
1396 "serial %" UVuf "\n",
1397 (void*)sv, (UV)sv->sv_flags, (UV)sv->sv_refcnt
1399 sv->sv_debug_file ? sv->sv_debug_file : "(unknown)",
1401 sv->sv_debug_inpad ? "for" : "by",
1402 sv->sv_debug_optype ?
1403 PL_op_name[sv->sv_debug_optype]: "(none)",
1404 PTR2UV(sv->sv_debug_parent),
1407 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1408 Perl_dump_sv_child(aTHX_ sv);
1414 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1418 /* Wait for up to 4 seconds for child to terminate.
1419 This seems to be the least effort way of timing out on reaping
1421 struct timeval waitfor = {4, 0};
1422 int sock = PL_dumper_fd;
1426 FD_SET(sock, &rset);
1427 select(sock + 1, &rset, NULL, NULL, &waitfor);
1428 waitpid(child, &status, WNOHANG);
1433 #ifdef DEBUG_LEAKING_SCALARS_ABORT
1439 #if defined(PERLIO_LAYERS)
1440 /* No more IO - including error messages ! */
1441 PerlIO_cleanup(aTHX);
1444 /* sv_undef needs to stay immortal until after PerlIO_cleanup
1445 as currently layers use it rather than NULL as a marker
1446 for no arg - and will try and SvREFCNT_dec it.
1448 SvREFCNT(&PL_sv_undef) = 0;
1449 SvREADONLY_off(&PL_sv_undef);
1451 Safefree(PL_origfilename);
1452 PL_origfilename = NULL;
1453 Safefree(PL_reg_curpm);
1454 free_tied_hv_pool();
1455 Safefree(PL_op_mask);
1456 Safefree(PL_psig_name);
1457 PL_psig_name = (SV**)NULL;
1458 PL_psig_ptr = (SV**)NULL;
1460 /* We need to NULL PL_psig_pend first, so that
1461 signal handlers know not to use it */
1462 int *psig_save = PL_psig_pend;
1463 PL_psig_pend = (int*)NULL;
1464 Safefree(psig_save);
1467 TAINTING_set(FALSE);
1468 TAINT_WARN_set(FALSE);
1469 PL_hints = 0; /* Reset hints. Should hints be per-interpreter ? */
1471 DEBUG_P(debprofdump());
1475 #ifdef USE_REENTRANT_API
1476 Perl_reentrant_free(aTHX);
1479 /* These all point to HVs that are about to be blown away.
1480 Code in core and on CPAN assumes that if the interpreter is re-started
1481 that they will be cleanly NULL or pointing to a valid HV. */
1482 PL_custom_op_names = NULL;
1483 PL_custom_op_descs = NULL;
1484 PL_custom_ops = NULL;
1488 while (PL_regmatch_slab) {
1489 regmatch_slab *s = PL_regmatch_slab;
1490 PL_regmatch_slab = PL_regmatch_slab->next;
1494 /* As the absolutely last thing, free the non-arena SV for mess() */
1497 /* we know that type == SVt_PVMG */
1499 /* it could have accumulated taint magic */
1502 for (mg = SvMAGIC(PL_mess_sv); mg; mg = moremagic) {
1503 moremagic = mg->mg_moremagic;
1504 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global
1506 Safefree(mg->mg_ptr);
1510 /* we know that type >= SVt_PV */
1511 SvPV_free(PL_mess_sv);
1512 Safefree(SvANY(PL_mess_sv));
1513 Safefree(PL_mess_sv);
1520 =for apidoc perl_free
1522 Releases a Perl interpreter. See L<perlembed>.
1532 PERL_ARGS_ASSERT_PERL_FREE;
1534 if (PL_veto_cleanup)
1537 #ifdef PERL_TRACK_MEMPOOL
1540 * Don't free thread memory if PERL_DESTRUCT_LEVEL is set to a non-zero
1541 * value as we're probably hunting memory leaks then
1543 if (PL_perl_destruct_level == 0) {
1544 const U32 old_debug = PL_debug;
1545 /* Emulate the PerlHost behaviour of free()ing all memory allocated in this
1546 thread at thread exit. */
1548 PerlIO_puts(Perl_debug_log, "Disabling memory debugging as we "
1549 "free this thread's memory\n");
1550 PL_debug &= ~ DEBUG_m_FLAG;
1552 while(aTHXx->Imemory_debug_header.next != &(aTHXx->Imemory_debug_header)){
1553 char * next = (char *)(aTHXx->Imemory_debug_header.next);
1554 Malloc_t ptr = PERL_MEMORY_DEBUG_HEADER_SIZE + next;
1557 PL_debug = old_debug;
1562 #if defined(WIN32) || defined(NETWARE)
1563 # if defined(PERL_IMPLICIT_SYS)
1566 void *host = nw_internal_host;
1567 PerlMem_free(aTHXx);
1568 nw_delete_internal_host(host);
1570 void *host = w32_internal_host;
1571 PerlMem_free(aTHXx);
1572 win32_delete_internal_host(host);
1576 PerlMem_free(aTHXx);
1579 PerlMem_free(aTHXx);
1583 #if defined(USE_ITHREADS)
1584 /* provide destructors to clean up the thread key when libperl is unloaded */
1585 #ifndef WIN32 /* handled during DLL_PROCESS_DETACH in win32/perllib.c */
1587 #if defined(__hpux) && !(defined(__ux_version) && __ux_version <= 1020) && !defined(__GNUC__)
1588 #pragma fini "perl_fini"
1589 #elif defined(__sun) && !defined(__GNUC__)
1590 #pragma fini (perl_fini)
1594 #if defined(__GNUC__)
1595 __attribute__((destructor))
1601 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
1604 PL_curinterp && !PL_veto_cleanup)
1609 #endif /* THREADS */
1612 Perl_call_atexit(pTHX_ ATEXIT_t fn, void *ptr)
1614 Renew(PL_exitlist, PL_exitlistlen+1, PerlExitListEntry);
1615 PL_exitlist[PL_exitlistlen].fn = fn;
1616 PL_exitlist[PL_exitlistlen].ptr = ptr;
1621 =for apidoc Am|int|perl_parse|PerlInterpreter *my_perl|XSINIT_t xsinit|int argc|char **argv|char **env
1623 Tells a Perl interpreter to parse a Perl script. This performs most
1624 of the initialisation of a Perl interpreter. See L<perlembed> for
1627 C<my_perl> points to the Perl interpreter that is to parse the script.
1628 It must have been previously created through the use of L</perl_alloc>
1629 and L</perl_construct>. C<xsinit> points to a callback function that
1630 will be called to set up the ability for this Perl interpreter to load
1631 XS extensions, or may be null to perform no such setup.
1633 C<argc> and C<argv> supply a set of command-line arguments to the Perl
1634 interpreter, as would normally be passed to the C<main> function of
1635 a C program. C<argv[argc]> must be null. These arguments are where
1636 the script to parse is specified, either by naming a script file or by
1637 providing a script in a C<-e> option.
1638 If L<C<$0>|perlvar/$0> will be written to in the Perl interpreter, then
1639 the argument strings must be in writable memory, and so mustn't just be
1642 C<env> specifies a set of environment variables that will be used by
1643 this Perl interpreter. If non-null, it must point to a null-terminated
1644 array of environment strings. If null, the Perl interpreter will use
1645 the environment supplied by the C<environ> global variable.
1647 This function initialises the interpreter, and parses and compiles the
1648 script specified by the command-line arguments. This includes executing
1649 code in C<BEGIN>, C<UNITCHECK>, and C<CHECK> blocks. It does not execute
1650 C<INIT> blocks or the main program.
1652 Returns an integer of slightly tricky interpretation. The correct
1653 use of the return value is as a truth value indicating whether there
1654 was a failure in initialisation. If zero is returned, this indicates
1655 that initialisation was successful, and it is safe to proceed to call
1656 L</perl_run> and make other use of it. If a non-zero value is returned,
1657 this indicates some problem that means the interpreter wants to terminate.
1658 The interpreter should not be just abandoned upon such failure; the caller
1659 should proceed to shut the interpreter down cleanly with L</perl_destruct>
1660 and free it with L</perl_free>.
1662 For historical reasons, the non-zero return value also attempts to
1663 be a suitable value to pass to the C library function C<exit> (or to
1664 return from C<main>), to serve as an exit code indicating the nature
1665 of the way initialisation terminated. However, this isn't portable,
1666 due to differing exit code conventions. A historical bug is preserved
1667 for the time being: if the Perl built-in C<exit> is called during this
1668 function's execution, with a type of exit entailing a zero exit code
1669 under the host operating system's conventions, then this function
1670 returns zero rather than a non-zero value. This bug, [perl #2754],
1671 leads to C<perl_run> being called (and therefore C<INIT> blocks and the
1672 main program running) despite a call to C<exit>. It has been preserved
1673 because a popular module-installing module has come to rely on it and
1674 needs time to be fixed. This issue is [perl #132577], and the original
1675 bug is due to be fixed in Perl 5.30.
1680 #define SET_CURSTASH(newstash) \
1681 if (PL_curstash != newstash) { \
1682 SvREFCNT_dec(PL_curstash); \
1683 PL_curstash = (HV *)SvREFCNT_inc(newstash); \
1687 perl_parse(pTHXx_ XSINIT_t xsinit, int argc, char **argv, char **env)
1694 PERL_ARGS_ASSERT_PERL_PARSE;
1695 #ifndef MULTIPLICITY
1696 PERL_UNUSED_ARG(my_perl);
1698 #if (defined(USE_HASH_SEED) || defined(USE_HASH_SEED_DEBUG)) && !defined(NO_PERL_HASH_SEED_DEBUG)
1700 const char * const s = PerlEnv_getenv("PERL_HASH_SEED_DEBUG");
1702 if (s && strEQ(s, "1")) {
1703 const unsigned char *seed= PERL_HASH_SEED;
1704 const unsigned char *seed_end= PERL_HASH_SEED + PERL_HASH_SEED_BYTES;
1705 PerlIO_printf(Perl_debug_log, "HASH_FUNCTION = %s HASH_SEED = 0x", PERL_HASH_FUNC);
1706 while (seed < seed_end) {
1707 PerlIO_printf(Perl_debug_log, "%02x", *seed++);
1709 #ifdef PERL_HASH_RANDOMIZE_KEYS
1710 PerlIO_printf(Perl_debug_log, " PERTURB_KEYS = %d (%s)",
1711 PL_HASH_RAND_BITS_ENABLED,
1712 PL_HASH_RAND_BITS_ENABLED == 0 ? "NO" : PL_HASH_RAND_BITS_ENABLED == 1 ? "RANDOM" : "DETERMINISTIC");
1714 PerlIO_printf(Perl_debug_log, "\n");
1717 #endif /* #if (defined(USE_HASH_SEED) ... */
1721 struct NameTranslationInfo nti;
1722 __translate_amiga_to_unix_path_name(&argv[0],&nti);
1729 for(i = 0; i != argc; i++)
1731 assert(!argv[argc]);
1736 if (PL_origalen != 0) {
1737 PL_origalen = 1; /* don't use old PL_origalen if perl_parse() is called again */
1740 /* Set PL_origalen be the sum of the contiguous argv[]
1741 * elements plus the size of the env in case that it is
1742 * contiguous with the argv[]. This is used in mg.c:Perl_magic_set()
1743 * as the maximum modifiable length of $0. In the worst case
1744 * the area we are able to modify is limited to the size of
1745 * the original argv[0]. (See below for 'contiguous', though.)
1747 const char *s = NULL;
1748 const UV mask = ~(UV)(PTRSIZE-1);
1749 /* Do the mask check only if the args seem like aligned. */
1751 (mask < ~(UV)0) && ((PTR2UV(argv[0]) & mask) == PTR2UV(argv[0]));
1753 /* See if all the arguments are contiguous in memory. Note
1754 * that 'contiguous' is a loose term because some platforms
1755 * align the argv[] and the envp[]. If the arguments look
1756 * like non-aligned, assume that they are 'strictly' or
1757 * 'traditionally' contiguous. If the arguments look like
1758 * aligned, we just check that they are within aligned
1759 * PTRSIZE bytes. As long as no system has something bizarre
1760 * like the argv[] interleaved with some other data, we are
1761 * fine. (Did I just evoke Murphy's Law?) --jhi */
1762 if (PL_origargv && PL_origargc >= 1 && (s = PL_origargv[0])) {
1765 for (i = 1; i < PL_origargc; i++) {
1766 if ((PL_origargv[i] == s + 1
1768 || PL_origargv[i] == s + 2
1773 (PL_origargv[i] > s &&
1775 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1786 #ifndef PERL_USE_SAFE_PUTENV
1787 /* Can we grab env area too to be used as the area for $0? */
1788 if (s && PL_origenviron && !PL_use_safe_putenv) {
1789 if ((PL_origenviron[0] == s + 1)
1792 (PL_origenviron[0] > s &&
1793 PL_origenviron[0] <=
1794 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1798 #ifndef OS2 /* ENVIRON is read by the kernel too. */
1799 s = PL_origenviron[0];
1802 my_setenv("NoNe SuCh", NULL);
1803 /* Force copy of environment. */
1804 for (i = 1; PL_origenviron[i]; i++) {
1805 if (PL_origenviron[i] == s + 1
1808 (PL_origenviron[i] > s &&
1809 PL_origenviron[i] <=
1810 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1813 s = PL_origenviron[i];
1821 #endif /* !defined(PERL_USE_SAFE_PUTENV) */
1823 PL_origalen = s ? s - PL_origargv[0] + 1 : 0;
1828 /* Come here if running an undumped a.out. */
1830 PL_origfilename = savepv(argv[0]);
1831 PL_do_undump = FALSE;
1832 cxstack_ix = -1; /* start label stack again */
1834 assert (!TAINT_get);
1838 init_postdump_symbols(argc,argv,env);
1843 op_free(PL_main_root);
1844 PL_main_root = NULL;
1846 PL_main_start = NULL;
1847 SvREFCNT_dec(PL_main_cv);
1851 oldscope = PL_scopestack_ix;
1852 PL_dowarn = G_WARN_OFF;
1857 parse_body(env,xsinit);
1858 if (PL_unitcheckav) {
1859 call_list(oldscope, PL_unitcheckav);
1862 PERL_SET_PHASE(PERL_PHASE_CHECK);
1863 call_list(oldscope, PL_checkav);
1871 /* my_exit() was called */
1872 while (PL_scopestack_ix > oldscope)
1875 SET_CURSTASH(PL_defstash);
1876 if (PL_unitcheckav) {
1877 call_list(oldscope, PL_unitcheckav);
1880 PERL_SET_PHASE(PERL_PHASE_CHECK);
1881 call_list(oldscope, PL_checkav);
1886 * At this point we should do
1888 * to avoid [perl #2754], but that bugfix has been postponed
1889 * because of the Module::Install breakage it causes
1895 PerlIO_printf(Perl_error_log, "panic: top_env\n");
1903 /* This needs to stay in perl.c, as perl.c is compiled with different flags for
1904 miniperl, and we need to see those flags reflected in the values here. */
1906 /* What this returns is subject to change. Use the public interface in Config.
1909 S_Internals_V(pTHX_ CV *cv)
1912 #ifdef LOCAL_PATCH_COUNT
1913 const int local_patch_count = LOCAL_PATCH_COUNT;
1915 const int local_patch_count = 0;
1917 const int entries = 3 + local_patch_count;
1919 static const char non_bincompat_options[] =
1926 # ifdef NO_HASH_SEED
1929 # ifdef NO_TAINT_SUPPORT
1932 # ifdef PERL_BOOL_AS_CHAR
1933 " PERL_BOOL_AS_CHAR"
1935 # ifdef PERL_COPY_ON_WRITE
1936 " PERL_COPY_ON_WRITE"
1938 # ifdef PERL_DISABLE_PMC
1941 # ifdef PERL_DONT_CREATE_GVSV
1942 " PERL_DONT_CREATE_GVSV"
1944 # ifdef PERL_EXTERNAL_GLOB
1945 " PERL_EXTERNAL_GLOB"
1947 # ifdef PERL_HASH_FUNC_SIPHASH
1948 " PERL_HASH_FUNC_SIPHASH"
1950 # ifdef PERL_HASH_FUNC_SDBM
1951 " PERL_HASH_FUNC_SDBM"
1953 # ifdef PERL_HASH_FUNC_DJB2
1954 " PERL_HASH_FUNC_DJB2"
1956 # ifdef PERL_HASH_FUNC_SUPERFAST
1957 " PERL_HASH_FUNC_SUPERFAST"
1959 # ifdef PERL_HASH_FUNC_MURMUR3
1960 " PERL_HASH_FUNC_MURMUR3"
1962 # ifdef PERL_HASH_FUNC_ONE_AT_A_TIME
1963 " PERL_HASH_FUNC_ONE_AT_A_TIME"
1965 # ifdef PERL_HASH_FUNC_ONE_AT_A_TIME_HARD
1966 " PERL_HASH_FUNC_ONE_AT_A_TIME_HARD"
1968 # ifdef PERL_HASH_FUNC_ONE_AT_A_TIME_OLD
1969 " PERL_HASH_FUNC_ONE_AT_A_TIME_OLD"
1971 # ifdef PERL_IS_MINIPERL
1974 # ifdef PERL_MALLOC_WRAP
1977 # ifdef PERL_MEM_LOG
1980 # ifdef PERL_MEM_LOG_NOIMPL
1981 " PERL_MEM_LOG_NOIMPL"
1983 # ifdef PERL_OP_PARENT
1986 # ifdef PERL_PERTURB_KEYS_DETERMINISTIC
1987 " PERL_PERTURB_KEYS_DETERMINISTIC"
1989 # ifdef PERL_PERTURB_KEYS_DISABLED
1990 " PERL_PERTURB_KEYS_DISABLED"
1992 # ifdef PERL_PERTURB_KEYS_RANDOM
1993 " PERL_PERTURB_KEYS_RANDOM"
1995 # ifdef PERL_PRESERVE_IVUV
1996 " PERL_PRESERVE_IVUV"
1998 # ifdef PERL_RELOCATABLE_INCPUSH
1999 " PERL_RELOCATABLE_INCPUSH"
2001 # ifdef PERL_USE_DEVEL
2004 # ifdef PERL_USE_SAFE_PUTENV
2005 " PERL_USE_SAFE_PUTENV"
2007 # ifdef SILENT_NO_TAINT_SUPPORT
2008 " SILENT_NO_TAINT_SUPPORT"
2010 # ifdef UNLINK_ALL_VERSIONS
2011 " UNLINK_ALL_VERSIONS"
2013 # ifdef USE_ATTRIBUTES_FOR_PERLIO
2014 " USE_ATTRIBUTES_FOR_PERLIO"
2016 # ifdef USE_FAST_STDIO
2022 # ifdef USE_LOCALE_CTYPE
2025 # ifdef WIN32_NO_REGISTRY
2028 # ifdef USE_PERL_ATOF
2031 # ifdef USE_SITECUSTOMIZE
2032 " USE_SITECUSTOMIZE"
2035 PERL_UNUSED_ARG(cv);
2036 PERL_UNUSED_VAR(items);
2038 EXTEND(SP, entries);
2040 PUSHs(sv_2mortal(newSVpv(PL_bincompat_options, 0)));
2041 PUSHs(Perl_newSVpvn_flags(aTHX_ non_bincompat_options,
2042 sizeof(non_bincompat_options) - 1, SVs_TEMP));
2044 #ifndef PERL_BUILD_DATE
2047 # define PERL_BUILD_DATE __DATE__ " " __TIME__
2049 # define PERL_BUILD_DATE __DATE__
2054 #ifdef PERL_BUILD_DATE
2055 PUSHs(Perl_newSVpvn_flags(aTHX_
2056 STR_WITH_LEN("Compiled at " PERL_BUILD_DATE),
2059 PUSHs(&PL_sv_undef);
2062 for (i = 1; i <= local_patch_count; i++) {
2063 /* This will be an undef, if PL_localpatches[i] is NULL. */
2064 PUSHs(sv_2mortal(newSVpv(PL_localpatches[i], 0)));
2070 #define INCPUSH_UNSHIFT 0x01
2071 #define INCPUSH_ADD_OLD_VERS 0x02
2072 #define INCPUSH_ADD_VERSIONED_SUB_DIRS 0x04
2073 #define INCPUSH_ADD_ARCHONLY_SUB_DIRS 0x08
2074 #define INCPUSH_NOT_BASEDIR 0x10
2075 #define INCPUSH_CAN_RELOCATE 0x20
2076 #define INCPUSH_ADD_SUB_DIRS \
2077 (INCPUSH_ADD_VERSIONED_SUB_DIRS|INCPUSH_ADD_ARCHONLY_SUB_DIRS)
2080 S_parse_body(pTHX_ char **env, XSINIT_t xsinit)
2084 int argc = PL_origargc;
2085 char **argv = PL_origargv;
2086 const char *scriptname = NULL;
2087 bool dosearch = FALSE;
2089 bool doextract = FALSE;
2090 const char *cddir = NULL;
2091 #ifdef USE_SITECUSTOMIZE
2092 bool minus_f = FALSE;
2094 SV *linestr_sv = NULL;
2095 bool add_read_e_script = FALSE;
2096 U32 lex_start_flags = 0;
2098 PERL_SET_PHASE(PERL_PHASE_START);
2104 for (argc--,argv++; argc > 0; argc--,argv++) {
2105 if (argv[0][0] != '-' || !argv[0][1])
2111 #ifndef PERL_STRICT_CR
2135 if ((s = moreswitches(s)))
2140 #if defined(SILENT_NO_TAINT_SUPPORT)
2141 /* silently ignore */
2142 #elif defined(NO_TAINT_SUPPORT)
2143 Perl_croak_nocontext("This perl was compiled without taint support. "
2144 "Cowardly refusing to run with -t or -T flags");
2146 CHECK_MALLOC_TOO_LATE_FOR('t');
2147 if( !TAINTING_get ) {
2148 TAINT_WARN_set(TRUE);
2155 #if defined(SILENT_NO_TAINT_SUPPORT)
2156 /* silently ignore */
2157 #elif defined(NO_TAINT_SUPPORT)
2158 Perl_croak_nocontext("This perl was compiled without taint support. "
2159 "Cowardly refusing to run with -t or -T flags");
2161 CHECK_MALLOC_TOO_LATE_FOR('T');
2163 TAINT_WARN_set(FALSE);
2172 forbid_setid('e', FALSE);
2174 PL_e_script = newSVpvs("");
2175 add_read_e_script = TRUE;
2178 sv_catpv(PL_e_script, s);
2180 sv_catpv(PL_e_script, argv[1]);
2184 Perl_croak(aTHX_ "No code specified for -%c", c);
2185 sv_catpvs(PL_e_script, "\n");
2189 #ifdef USE_SITECUSTOMIZE
2195 case 'I': /* -I handled both here and in moreswitches() */
2196 forbid_setid('I', FALSE);
2197 if (!*++s && (s=argv[1]) != NULL) {
2201 STRLEN len = strlen(s);
2202 incpush(s, len, INCPUSH_ADD_SUB_DIRS|INCPUSH_ADD_OLD_VERS);
2205 Perl_croak(aTHX_ "No directory specified for -I");
2208 forbid_setid('S', FALSE);
2217 opts_prog = newSVpvs("use Config; Config::_V()");
2221 opts_prog = Perl_newSVpvf(aTHX_
2222 "use Config; Config::config_vars(qw%c%s%c)",
2226 Perl_av_create_and_push(aTHX_ &PL_preambleav, opts_prog);
2227 /* don't look for script or read stdin */
2228 scriptname = BIT_BUCKET;
2240 if (!*++s || isSPACE(*s)) {
2244 /* catch use of gnu style long options.
2245 Both of these exit immediately. */
2246 if (strEQ(s, "version"))
2248 if (strEQ(s, "help"))
2253 Perl_croak(aTHX_ "Unrecognized switch: -%s (-h will show valid options)",s);
2264 #ifndef SECURE_INTERNAL_GETENV
2267 (s = PerlEnv_getenv("PERL5OPT")))
2269 /* s points to static memory in getenv(), which may be overwritten at
2270 * any time; use a mortal copy instead */
2271 s = SvPVX(sv_2mortal(newSVpv(s, 0)));
2275 if (*s == '-' && *(s+1) == 'T') {
2276 #if defined(SILENT_NO_TAINT_SUPPORT)
2277 /* silently ignore */
2278 #elif defined(NO_TAINT_SUPPORT)
2279 Perl_croak_nocontext("This perl was compiled without taint support. "
2280 "Cowardly refusing to run with -t or -T flags");
2282 CHECK_MALLOC_TOO_LATE_FOR('T');
2284 TAINT_WARN_set(FALSE);
2288 char *popt_copy = NULL;
2301 if (!strchr("CDIMUdmtwW", *s))
2302 Perl_croak(aTHX_ "Illegal switch in PERL5OPT: -%c", *s);
2306 popt_copy = SvPVX(sv_2mortal(newSVpv(d,0)));
2307 s = popt_copy + (s - d);
2315 #if defined(SILENT_NO_TAINT_SUPPORT)
2316 /* silently ignore */
2317 #elif defined(NO_TAINT_SUPPORT)
2318 Perl_croak_nocontext("This perl was compiled without taint support. "
2319 "Cowardly refusing to run with -t or -T flags");
2321 if( !TAINTING_get) {
2322 TAINT_WARN_set(TRUE);
2334 #ifndef NO_PERL_INTERNAL_RAND_SEED
2335 /* If we're not set[ug]id, we might have honored
2336 PERL_INTERNAL_RAND_SEED in perl_construct().
2337 At this point command-line options have been parsed, so if
2338 we're now tainting and not set[ug]id re-seed.
2339 This could possibly be wasteful if PERL_INTERNAL_RAND_SEED is invalid,
2340 but avoids duplicating the logic from perl_construct().
2343 PerlProc_getuid() == PerlProc_geteuid() &&
2344 PerlProc_getgid() == PerlProc_getegid()) {
2345 Perl_drand48_init_r(&PL_internal_random_state, seed());
2349 /* Set $^X early so that it can be used for relocatable paths in @INC */
2350 /* and for SITELIB_EXP in USE_SITECUSTOMIZE */
2351 assert (!TAINT_get);
2356 #if defined(USE_SITECUSTOMIZE)
2358 /* The games with local $! are to avoid setting errno if there is no
2359 sitecustomize script. "q%c...%c", 0, ..., 0 becomes "q\0...\0",
2360 ie a q() operator with a NUL byte as a the delimiter. This avoids
2361 problems with pathnames containing (say) ' */
2362 # ifdef PERL_IS_MINIPERL
2363 AV *const inc = GvAV(PL_incgv);
2364 SV **const inc0 = inc ? av_fetch(inc, 0, FALSE) : NULL;
2367 /* if lib/buildcustomize.pl exists, it should not fail. If it does,
2368 it should be reported immediately as a build failure. */
2369 (void)Perl_av_create_and_unshift_one(aTHX_ &PL_preambleav,
2371 "BEGIN { my $f = q%c%s%" SVf "/buildcustomize.pl%c; "
2372 "do {local $!; -f $f }"
2373 " and do $f || die $@ || qq '$f: $!' }",
2374 0, (TAINTING_get ? "./" : ""), SVfARG(*inc0), 0));
2377 /* SITELIB_EXP is a function call on Win32. */
2378 const char *const raw_sitelib = SITELIB_EXP;
2380 /* process .../.. if PERL_RELOCATABLE_INC is defined */
2381 SV *sitelib_sv = mayberelocate(raw_sitelib, strlen(raw_sitelib),
2382 INCPUSH_CAN_RELOCATE);
2383 const char *const sitelib = SvPVX(sitelib_sv);
2384 (void)Perl_av_create_and_unshift_one(aTHX_ &PL_preambleav,
2386 "BEGIN { do {local $!; -f q%c%s/sitecustomize.pl%c} && do q%c%s/sitecustomize.pl%c }",
2387 0, SVfARG(sitelib), 0,
2388 0, SVfARG(sitelib), 0));
2389 assert (SvREFCNT(sitelib_sv) == 1);
2390 SvREFCNT_dec(sitelib_sv);
2397 scriptname = argv[0];
2400 scriptname = BIT_BUCKET; /* don't look for script or read stdin */
2402 else if (scriptname == NULL) {
2404 if ( PerlLIO_isatty(PerlIO_fileno(PerlIO_stdin())) )
2410 assert (!TAINT_get);
2414 bool suidscript = FALSE;
2416 rsfp = open_script(scriptname, dosearch, &suidscript);
2418 rsfp = PerlIO_stdin();
2419 lex_start_flags = LEX_DONT_CLOSE_RSFP;
2422 validate_suid(rsfp);
2425 # if defined(SIGCHLD) || defined(SIGCLD)
2428 # define SIGCHLD SIGCLD
2430 Sighandler_t sigstate = rsignal_state(SIGCHLD);
2431 if (sigstate == (Sighandler_t) SIG_IGN) {
2432 Perl_ck_warner(aTHX_ packWARN(WARN_SIGNAL),
2433 "Can't ignore signal CHLD, forcing to default");
2434 (void)rsignal(SIGCHLD, (Sighandler_t)SIG_DFL);
2442 /* This will croak if suidscript is true, as -x cannot be used with
2444 forbid_setid('x', suidscript);
2445 /* Hence you can't get here if suidscript is true */
2447 linestr_sv = newSV_type(SVt_PV);
2448 lex_start_flags |= LEX_START_COPIED;
2449 find_beginning(linestr_sv, rsfp);
2450 if (cddir && PerlDir_chdir( (char *)cddir ) < 0)
2451 Perl_croak(aTHX_ "Can't chdir to %s",cddir);
2455 PL_main_cv = PL_compcv = MUTABLE_CV(newSV_type(SVt_PVCV));
2456 CvUNIQUE_on(PL_compcv);
2458 CvPADLIST_set(PL_compcv, pad_new(0));
2460 PL_isarev = newHV();
2463 boot_core_UNIVERSAL();
2465 newXS("Internals::V", S_Internals_V, __FILE__);
2468 (*xsinit)(aTHX); /* in case linked C routines want magical variables */
2470 #if defined(VMS) || defined(WIN32) || defined(DJGPP) || defined(__CYGWIN__) || defined(SYMBIAN)
2476 # ifdef HAS_SOCKS5_INIT
2477 socks5_init(argv[0]);
2483 init_predump_symbols();
2484 /* init_postdump_symbols not currently designed to be called */
2485 /* more than once (ENV isn't cleared first, for example) */
2486 /* But running with -u leaves %ENV & @ARGV undefined! XXX */
2488 init_postdump_symbols(argc,argv,env);
2490 /* PL_unicode is turned on by -C, or by $ENV{PERL_UNICODE},
2491 * or explicitly in some platforms.
2492 * PL_utf8locale is conditionally turned on by
2493 * locale.c:Perl_init_i18nl10n() if the environment
2494 * look like the user wants to use UTF-8. */
2495 #if defined(__SYMBIAN32__)
2496 PL_unicode = PERL_UNICODE_STD_FLAG; /* See PERL_SYMBIAN_CONSOLE_UTF8. */
2498 # ifndef PERL_IS_MINIPERL
2500 /* Requires init_predump_symbols(). */
2501 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
2506 /* Turn on UTF-8-ness on STDIN, STDOUT, STDERR
2507 * and the default open disciplines. */
2508 if ((PL_unicode & PERL_UNICODE_STDIN_FLAG) &&
2509 PL_stdingv && (io = GvIO(PL_stdingv)) &&
2511 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2512 if ((PL_unicode & PERL_UNICODE_STDOUT_FLAG) &&
2513 PL_defoutgv && (io = GvIO(PL_defoutgv)) &&
2515 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2516 if ((PL_unicode & PERL_UNICODE_STDERR_FLAG) &&
2517 PL_stderrgv && (io = GvIO(PL_stderrgv)) &&
2519 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2520 if ((PL_unicode & PERL_UNICODE_INOUT_FLAG) &&
2521 (sv = GvSV(gv_fetchpvs("\017PEN", GV_ADD|GV_NOTQUAL,
2523 U32 in = PL_unicode & PERL_UNICODE_IN_FLAG;
2524 U32 out = PL_unicode & PERL_UNICODE_OUT_FLAG;
2527 sv_setpvs(sv, ":utf8\0:utf8");
2529 sv_setpvs(sv, ":utf8\0");
2532 sv_setpvs(sv, "\0:utf8");
2541 if ((s = PerlEnv_getenv("PERL_SIGNALS"))) {
2542 if (strEQ(s, "unsafe"))
2543 PL_signals |= PERL_SIGNALS_UNSAFE_FLAG;
2544 else if (strEQ(s, "safe"))
2545 PL_signals &= ~PERL_SIGNALS_UNSAFE_FLAG;
2547 Perl_croak(aTHX_ "PERL_SIGNALS illegal: \"%s\"", s);
2552 lex_start(linestr_sv, rsfp, lex_start_flags);
2553 SvREFCNT_dec(linestr_sv);
2555 PL_subname = newSVpvs("main");
2557 if (add_read_e_script)
2558 filter_add(read_e_script, NULL);
2560 /* now parse the script */
2562 SETERRNO(0,SS_NORMAL);
2563 if (yyparse(GRAMPROG) || PL_parser->error_count) {
2564 abort_execution("", PL_origfilename);
2566 CopLINE_set(PL_curcop, 0);
2567 SET_CURSTASH(PL_defstash);
2569 SvREFCNT_dec(PL_e_script);
2577 SAVECOPFILE(PL_curcop);
2578 SAVECOPLINE(PL_curcop);
2579 gv_check(PL_defstash);
2589 s = PerlEnv_getenv("PERL_DEBUG_MSTATS");
2590 if (s && grok_atoUV(s, &uv, NULL) && uv >= 2)
2591 dump_mstats("after compilation:");
2596 PL_restartjmpenv = NULL;
2602 =for apidoc Am|int|perl_run|PerlInterpreter *my_perl
2604 Tells a Perl interpreter to run its main program. See L<perlembed>
2607 C<my_perl> points to the Perl interpreter. It must have been previously
2608 created through the use of L</perl_alloc> and L</perl_construct>, and
2609 initialised through L</perl_parse>. This function should not be called
2610 if L</perl_parse> returned a non-zero value, indicating a failure in
2611 initialisation or compilation.
2613 This function executes code in C<INIT> blocks, and then executes the
2614 main program. The code to be executed is that established by the prior
2615 call to L</perl_parse>. If the interpreter's C<PL_exit_flags> word
2616 does not have the C<PERL_EXIT_DESTRUCT_END> flag set, then this function
2617 will also execute code in C<END> blocks. If it is desired to make any
2618 further use of the interpreter after calling this function, then C<END>
2619 blocks should be postponed to L</perl_destruct> time by setting that flag.
2621 Returns an integer of slightly tricky interpretation. The correct use
2622 of the return value is as a truth value indicating whether the program
2623 terminated non-locally. If zero is returned, this indicates that
2624 the program ran to completion, and it is safe to make other use of the
2625 interpreter (provided that the C<PERL_EXIT_DESTRUCT_END> flag was set as
2626 described above). If a non-zero value is returned, this indicates that
2627 the interpreter wants to terminate early. The interpreter should not be
2628 just abandoned because of this desire to terminate; the caller should
2629 proceed to shut the interpreter down cleanly with L</perl_destruct>
2630 and free it with L</perl_free>.
2632 For historical reasons, the non-zero return value also attempts to
2633 be a suitable value to pass to the C library function C<exit> (or to
2634 return from C<main>), to serve as an exit code indicating the nature of
2635 the way the program terminated. However, this isn't portable, due to
2636 differing exit code conventions. An attempt is made to return an exit
2637 code of the type required by the host operating system, but because
2638 it is constrained to be non-zero, it is not necessarily possible to
2639 indicate every type of exit. It is only reliable on Unix, where a zero
2640 exit code can be augmented with a set bit that will be ignored. In any
2641 case, this function is not the correct place to acquire an exit code:
2642 one should get that from L</perl_destruct>.
2651 int ret = 0, exit_called = 0;
2654 PERL_ARGS_ASSERT_PERL_RUN;
2655 #ifndef MULTIPLICITY
2656 PERL_UNUSED_ARG(my_perl);
2659 oldscope = PL_scopestack_ix;
2667 cxstack_ix = -1; /* start context stack again */
2669 case 0: /* normal completion */
2673 case 2: /* my_exit() */
2676 while (PL_scopestack_ix > oldscope)
2679 SET_CURSTASH(PL_defstash);
2680 if (!(PL_exit_flags & PERL_EXIT_DESTRUCT_END) &&
2681 PL_endav && !PL_minus_c) {
2682 PERL_SET_PHASE(PERL_PHASE_END);
2683 call_list(oldscope, PL_endav);
2686 if (PerlEnv_getenv("PERL_DEBUG_MSTATS"))
2687 dump_mstats("after execution: ");
2691 if (ret == 0) ret = 0x100;
2698 POPSTACK_TO(PL_mainstack);
2701 PerlIO_printf(Perl_error_log, "panic: restartop in perl_run\n");
2712 S_run_body(pTHX_ I32 oldscope)
2714 DEBUG_r(PerlIO_printf(Perl_debug_log, "%s $` $& $' support (0x%x).\n",
2715 PL_sawampersand ? "Enabling" : "Omitting",
2716 (unsigned int)(PL_sawampersand)));
2718 if (!PL_restartop) {
2720 if (DEBUG_x_TEST || DEBUG_B_TEST)
2721 dump_all_perl(!DEBUG_B_TEST);
2723 PERL_DEBUG(PerlIO_printf(Perl_debug_log, "\nEXECUTING...\n\n"));
2727 PerlIO_printf(Perl_error_log, "%s syntax OK\n", PL_origfilename);
2730 if (PERLDB_SINGLE && PL_DBsingle)
2733 PERL_SET_PHASE(PERL_PHASE_INIT);
2734 call_list(oldscope, PL_initav);
2736 #ifdef PERL_DEBUG_READONLY_OPS
2737 if (PL_main_root && PL_main_root->op_slabbed)
2738 Slab_to_ro(OpSLAB(PL_main_root));
2744 PERL_SET_PHASE(PERL_PHASE_RUN);
2747 PL_restartjmpenv = NULL;
2748 PL_op = PL_restartop;
2752 else if (PL_main_start) {
2753 CvDEPTH(PL_main_cv) = 1;
2754 PL_op = PL_main_start;
2758 NOT_REACHED; /* NOTREACHED */
2762 =head1 SV Manipulation Functions
2764 =for apidoc p||get_sv
2766 Returns the SV of the specified Perl scalar. C<flags> are passed to
2767 C<gv_fetchpv>. If C<GV_ADD> is set and the
2768 Perl variable does not exist then it will be created. If C<flags> is zero
2769 and the variable does not exist then NULL is returned.
2775 Perl_get_sv(pTHX_ const char *name, I32 flags)
2779 PERL_ARGS_ASSERT_GET_SV;
2781 gv = gv_fetchpv(name, flags, SVt_PV);
2788 =head1 Array Manipulation Functions
2790 =for apidoc p||get_av
2792 Returns the AV of the specified Perl global or package array with the given
2793 name (so it won't work on lexical variables). C<flags> are passed
2794 to C<gv_fetchpv>. If C<GV_ADD> is set and the
2795 Perl variable does not exist then it will be created. If C<flags> is zero
2796 and the variable does not exist then NULL is returned.
2798 Perl equivalent: C<@{"$name"}>.
2804 Perl_get_av(pTHX_ const char *name, I32 flags)
2806 GV* const gv = gv_fetchpv(name, flags, SVt_PVAV);
2808 PERL_ARGS_ASSERT_GET_AV;
2818 =head1 Hash Manipulation Functions
2820 =for apidoc p||get_hv
2822 Returns the HV of the specified Perl hash. C<flags> are passed to
2823 C<gv_fetchpv>. If C<GV_ADD> is set and the
2824 Perl variable does not exist then it will be created. If C<flags> is zero
2825 and the variable does not exist then C<NULL> is returned.
2831 Perl_get_hv(pTHX_ const char *name, I32 flags)
2833 GV* const gv = gv_fetchpv(name, flags, SVt_PVHV);
2835 PERL_ARGS_ASSERT_GET_HV;
2845 =head1 CV Manipulation Functions
2847 =for apidoc p||get_cvn_flags
2849 Returns the CV of the specified Perl subroutine. C<flags> are passed to
2850 C<gv_fetchpvn_flags>. If C<GV_ADD> is set and the Perl subroutine does not
2851 exist then it will be declared (which has the same effect as saying
2852 C<sub name;>). If C<GV_ADD> is not set and the subroutine does not exist
2853 then NULL is returned.
2855 =for apidoc p||get_cv
2857 Uses C<strlen> to get the length of C<name>, then calls C<get_cvn_flags>.
2863 Perl_get_cvn_flags(pTHX_ const char *name, STRLEN len, I32 flags)
2865 GV* const gv = gv_fetchpvn_flags(name, len, flags, SVt_PVCV);
2867 PERL_ARGS_ASSERT_GET_CVN_FLAGS;
2869 if (gv && UNLIKELY(SvROK(gv)) && SvTYPE(SvRV((SV *)gv)) == SVt_PVCV)
2870 return (CV*)SvRV((SV *)gv);
2872 /* XXX this is probably not what they think they're getting.
2873 * It has the same effect as "sub name;", i.e. just a forward
2875 if ((flags & ~GV_NOADD_MASK) && !GvCVu(gv)) {
2876 return newSTUB(gv,0);
2883 /* Nothing in core calls this now, but we can't replace it with a macro and
2884 move it to mathoms.c as a macro would evaluate name twice. */
2886 Perl_get_cv(pTHX_ const char *name, I32 flags)
2888 PERL_ARGS_ASSERT_GET_CV;
2890 return get_cvn_flags(name, strlen(name), flags);
2893 /* Be sure to refetch the stack pointer after calling these routines. */
2897 =head1 Callback Functions
2899 =for apidoc p||call_argv
2901 Performs a callback to the specified named and package-scoped Perl subroutine
2902 with C<argv> (a C<NULL>-terminated array of strings) as arguments. See
2905 Approximate Perl equivalent: C<&{"$sub_name"}(@$argv)>.
2911 Perl_call_argv(pTHX_ const char *sub_name, I32 flags, char **argv)
2913 /* See G_* flags in cop.h */
2914 /* null terminated arg list */
2918 PERL_ARGS_ASSERT_CALL_ARGV;
2922 mXPUSHs(newSVpv(*argv,0));
2926 return call_pv(sub_name, flags);
2930 =for apidoc p||call_pv
2932 Performs a callback to the specified Perl sub. See L<perlcall>.
2938 Perl_call_pv(pTHX_ const char *sub_name, I32 flags)
2939 /* name of the subroutine */
2940 /* See G_* flags in cop.h */
2942 PERL_ARGS_ASSERT_CALL_PV;
2944 return call_sv(MUTABLE_SV(get_cv(sub_name, GV_ADD)), flags);
2948 =for apidoc p||call_method
2950 Performs a callback to the specified Perl method. The blessed object must
2951 be on the stack. See L<perlcall>.
2957 Perl_call_method(pTHX_ const char *methname, I32 flags)
2958 /* name of the subroutine */
2959 /* See G_* flags in cop.h */
2963 PERL_ARGS_ASSERT_CALL_METHOD;
2965 len = strlen(methname);
2966 sv = flags & G_METHOD_NAMED
2967 ? sv_2mortal(newSVpvn_share(methname, len,0))
2968 : newSVpvn_flags(methname, len, SVs_TEMP);
2970 return call_sv(sv, flags | G_METHOD);
2973 /* May be called with any of a CV, a GV, or an SV containing the name. */
2975 =for apidoc p||call_sv
2977 Performs a callback to the Perl sub specified by the SV.
2979 If neither the C<G_METHOD> nor C<G_METHOD_NAMED> flag is supplied, the
2980 SV may be any of a CV, a GV, a reference to a CV, a reference to a GV
2981 or C<SvPV(sv)> will be used as the name of the sub to call.
2983 If the C<G_METHOD> flag is supplied, the SV may be a reference to a CV or
2984 C<SvPV(sv)> will be used as the name of the method to call.
2986 If the C<G_METHOD_NAMED> flag is supplied, C<SvPV(sv)> will be used as
2987 the name of the method to call.
2989 Some other values are treated specially for internal use and should
2998 Perl_call_sv(pTHX_ SV *sv, volatile I32 flags)
2999 /* See G_* flags in cop.h */
3002 LOGOP myop; /* fake syntax tree node */
3005 volatile I32 retval = 0;
3006 bool oldcatch = CATCH_GET;
3008 OP* const oldop = PL_op;
3011 PERL_ARGS_ASSERT_CALL_SV;
3013 if (flags & G_DISCARD) {
3017 if (!(flags & G_WANT)) {
3018 /* Backwards compatibility - as G_SCALAR was 0, it could be omitted.
3023 Zero(&myop, 1, LOGOP);
3024 if (!(flags & G_NOARGS))
3025 myop.op_flags |= OPf_STACKED;
3026 myop.op_flags |= OP_GIMME_REVERSE(flags);
3030 if (!(flags & G_METHOD_NAMED)) {
3038 if (PERLDB_SUB && PL_curstash != PL_debstash
3039 /* Handle first BEGIN of -d. */
3040 && (PL_DBcv || (PL_DBcv = GvCV(PL_DBsub)))
3041 /* Try harder, since this may have been a sighandler, thus
3042 * curstash may be meaningless. */
3043 && (SvTYPE(sv) != SVt_PVCV || CvSTASH((const CV *)sv) != PL_debstash)
3044 && !(flags & G_NODEBUG))
3045 myop.op_private |= OPpENTERSUB_DB;
3047 if (flags & (G_METHOD|G_METHOD_NAMED)) {
3048 Zero(&method_op, 1, METHOP);
3049 method_op.op_next = (OP*)&myop;
3050 PL_op = (OP*)&method_op;
3051 if ( flags & G_METHOD_NAMED ) {
3052 method_op.op_ppaddr = PL_ppaddr[OP_METHOD_NAMED];
3053 method_op.op_type = OP_METHOD_NAMED;
3054 method_op.op_u.op_meth_sv = sv;
3056 method_op.op_ppaddr = PL_ppaddr[OP_METHOD];
3057 method_op.op_type = OP_METHOD;
3059 myop.op_ppaddr = PL_ppaddr[OP_ENTERSUB];
3060 myop.op_type = OP_ENTERSUB;
3063 if (!(flags & G_EVAL)) {
3065 CALL_BODY_SUB((OP*)&myop);
3066 retval = PL_stack_sp - (PL_stack_base + oldmark);
3067 CATCH_SET(oldcatch);
3071 myop.op_other = (OP*)&myop;
3073 old_cxix = cxstack_ix;
3074 create_eval_scope(NULL, flags|G_FAKINGEVAL);
3082 CALL_BODY_SUB((OP*)&myop);
3083 retval = PL_stack_sp - (PL_stack_base + oldmark);
3084 if (!(flags & G_KEEPERR)) {
3092 /* my_exit() was called */
3093 SET_CURSTASH(PL_defstash);
3097 NOT_REACHED; /* NOTREACHED */
3100 PL_restartjmpenv = NULL;
3101 PL_op = PL_restartop;
3105 PL_stack_sp = PL_stack_base + oldmark;
3106 if ((flags & G_WANT) == G_ARRAY)
3110 *++PL_stack_sp = &PL_sv_undef;
3115 /* if we croaked, depending on how we croaked the eval scope
3116 * may or may not have already been popped */
3117 if (cxstack_ix > old_cxix) {
3118 assert(cxstack_ix == old_cxix + 1);
3119 assert(CxTYPE(CX_CUR()) == CXt_EVAL);
3120 delete_eval_scope();
3125 if (flags & G_DISCARD) {
3126 PL_stack_sp = PL_stack_base + oldmark;
3135 /* Eval a string. The G_EVAL flag is always assumed. */
3138 =for apidoc p||eval_sv
3140 Tells Perl to C<eval> the string in the SV. It supports the same flags
3141 as C<call_sv>, with the obvious exception of C<G_EVAL>. See L<perlcall>.
3147 Perl_eval_sv(pTHX_ SV *sv, I32 flags)
3149 /* See G_* flags in cop.h */
3152 UNOP myop; /* fake syntax tree node */
3153 volatile I32 oldmark;
3154 volatile I32 retval = 0;
3156 OP* const oldop = PL_op;
3159 PERL_ARGS_ASSERT_EVAL_SV;
3161 if (flags & G_DISCARD) {
3168 Zero(&myop, 1, UNOP);
3171 oldmark = SP - PL_stack_base;
3177 if (!(flags & G_NOARGS))
3178 myop.op_flags = OPf_STACKED;
3179 myop.op_type = OP_ENTEREVAL;
3180 myop.op_flags |= OP_GIMME_REVERSE(flags);
3181 if (flags & G_KEEPERR)
3182 myop.op_flags |= OPf_SPECIAL;
3184 if (flags & G_RE_REPARSING)
3185 myop.op_private = (OPpEVAL_COPHH | OPpEVAL_RE_REPARSING);
3187 /* fail now; otherwise we could fail after the JMPENV_PUSH but
3188 * before a cx_pusheval(), which corrupts the stack after a croak */
3189 TAINT_PROPER("eval_sv()");
3195 if (PL_op == (OP*)(&myop)) {
3196 PL_op = PL_ppaddr[OP_ENTEREVAL](aTHX);
3198 goto fail; /* failed in compilation */
3201 retval = PL_stack_sp - (PL_stack_base + oldmark);
3202 if (!(flags & G_KEEPERR)) {
3210 /* my_exit() was called */
3211 SET_CURSTASH(PL_defstash);
3215 NOT_REACHED; /* NOTREACHED */
3218 PL_restartjmpenv = NULL;
3219 PL_op = PL_restartop;
3224 PL_stack_sp = PL_stack_base + oldmark;
3225 if ((flags & G_WANT) == G_ARRAY)
3229 *++PL_stack_sp = &PL_sv_undef;
3235 if (flags & G_DISCARD) {
3236 PL_stack_sp = PL_stack_base + oldmark;
3246 =for apidoc p||eval_pv
3248 Tells Perl to C<eval> the given string in scalar context and return an SV* result.
3254 Perl_eval_pv(pTHX_ const char *p, I32 croak_on_error)
3256 SV* sv = newSVpv(p, 0);
3258 PERL_ARGS_ASSERT_EVAL_PV;
3260 eval_sv(sv, G_SCALAR);
3269 /* just check empty string or undef? */
3270 if (croak_on_error) {
3271 SV * const errsv = ERRSV;
3272 if(SvTRUE_NN(errsv))
3273 /* replace with croak_sv? */
3274 Perl_croak_nocontext("%s", SvPV_nolen_const(errsv));
3280 /* Require a module. */
3283 =head1 Embedding Functions
3285 =for apidoc p||require_pv
3287 Tells Perl to C<require> the file named by the string argument. It is
3288 analogous to the Perl code C<eval "require '$file'">. It's even
3289 implemented that way; consider using load_module instead.
3294 Perl_require_pv(pTHX_ const char *pv)
3299 PERL_ARGS_ASSERT_REQUIRE_PV;
3301 PUSHSTACKi(PERLSI_REQUIRE);
3302 sv = Perl_newSVpvf(aTHX_ "require q%c%s%c", 0, pv, 0);
3303 eval_sv(sv_2mortal(sv), G_DISCARD);
3308 S_usage(pTHX) /* XXX move this out into a module ? */
3310 /* This message really ought to be max 23 lines.
3311 * Removed -h because the user already knows that option. Others? */
3313 /* Grouped as 6 lines per C string literal, to keep under the ANSI C 89
3314 minimum of 509 character string literals. */
3315 static const char * const usage_msg[] = {
3316 " -0[octal] specify record separator (\\0, if no argument)\n"
3317 " -a autosplit mode with -n or -p (splits $_ into @F)\n"
3318 " -C[number/list] enables the listed Unicode features\n"
3319 " -c check syntax only (runs BEGIN and CHECK blocks)\n"
3320 " -d[:debugger] run program under debugger\n"
3321 " -D[number/list] set debugging flags (argument is a bit mask or alphabets)\n",
3322 " -e program one line of program (several -e's allowed, omit programfile)\n"
3323 " -E program like -e, but enables all optional features\n"
3324 " -f don't do $sitelib/sitecustomize.pl at startup\n"
3325 " -F/pattern/ split() pattern for -a switch (//'s are optional)\n"
3326 " -i[extension] edit <> files in place (makes backup if extension supplied)\n"
3327 " -Idirectory specify @INC/#include directory (several -I's allowed)\n",
3328 " -l[octal] enable line ending processing, specifies line terminator\n"
3329 " -[mM][-]module execute \"use/no module...\" before executing program\n"
3330 " -n assume \"while (<>) { ... }\" loop around program\n"
3331 " -p assume loop like -n but print line also, like sed\n"
3332 " -s enable rudimentary parsing for switches after programfile\n"
3333 " -S look for programfile using PATH environment variable\n",
3334 " -t enable tainting warnings\n"
3335 " -T enable tainting checks\n"
3336 " -u dump core after parsing program\n"
3337 " -U allow unsafe operations\n"
3338 " -v print version, patchlevel and license\n"
3339 " -V[:variable] print configuration summary (or a single Config.pm variable)\n",
3340 " -w enable many useful warnings\n"
3341 " -W enable all warnings\n"
3342 " -x[directory] ignore text before #!perl line (optionally cd to directory)\n"
3343 " -X disable all warnings\n"
3345 "Run 'perldoc perl' for more help with Perl.\n\n",
3348 const char * const *p = usage_msg;
3349 PerlIO *out = PerlIO_stdout();
3352 "\nUsage: %s [switches] [--] [programfile] [arguments]\n",
3355 PerlIO_puts(out, *p++);
3359 /* convert a string of -D options (or digits) into an int.
3360 * sets *s to point to the char after the options */
3364 Perl_get_debug_opts(pTHX_ const char **s, bool givehelp)
3366 static const char * const usage_msgd[] = {
3367 " Debugging flag values: (see also -d)\n"
3368 " p Tokenizing and parsing (with v, displays parse stack)\n"
3369 " s Stack snapshots (with v, displays all stacks)\n"
3370 " l Context (loop) stack processing\n"
3371 " t Trace execution\n"
3372 " o Method and overloading resolution\n",
3373 " c String/numeric conversions\n"
3374 " P Print profiling info, source file input state\n"
3375 " m Memory and SV allocation\n"
3376 " f Format processing\n"
3377 " r Regular expression parsing and execution\n"
3378 " x Syntax tree dump\n",
3379 " u Tainting checks\n"
3380 " H Hash dump -- usurps values()\n"
3381 " X Scratchpad allocation\n"
3383 " S Op slab allocation\n"
3385 " R Include reference counts of dumped variables (eg when using -Ds)\n",
3386 " J Do not s,t,P-debug (Jump over) opcodes within package DB\n"
3387 " v Verbose: use in conjunction with other flags\n"
3388 " C Copy On Write\n"
3389 " A Consistency checks on internal structures\n"
3390 " q quiet - currently only suppresses the 'EXECUTING' message\n"
3391 " M trace smart match resolution\n"
3392 " B dump suBroutine definitions, including special Blocks like BEGIN\n",
3393 " L trace some locale setting information--for Perl core development\n",
3394 " i trace PerlIO layer processing\n",
3399 PERL_ARGS_ASSERT_GET_DEBUG_OPTS;
3402 /* if adding extra options, remember to update DEBUG_MASK */
3403 static const char debopts[] = "psltocPmfrxuUHXDSTRJvCAqMBLi";
3405 for (; isWORDCHAR(**s); (*s)++) {
3406 const char * const d = strchr(debopts,**s);
3408 uv |= 1 << (d - debopts);
3409 else if (ckWARN_d(WARN_DEBUGGING))
3410 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3411 "invalid option -D%c, use -D'' to see choices\n", **s);
3414 else if (isDIGIT(**s)) {
3416 if (grok_atoUV(*s, &uv, &e))
3418 for (; isWORDCHAR(**s); (*s)++) ;
3420 else if (givehelp) {
3421 const char *const *p = usage_msgd;
3422 while (*p) PerlIO_puts(PerlIO_stdout(), *p++);
3424 return (int)uv; /* ignore any UV->int conversion loss */
3428 /* This routine handles any switches that can be given during run */
3431 Perl_moreswitches(pTHX_ const char *s)
3435 const char option = *s; /* used to remember option in -m/-M code */
3437 PERL_ARGS_ASSERT_MORESWITCHES;
3445 SvREFCNT_dec(PL_rs);
3446 if (s[1] == 'x' && s[2]) {
3447 const char *e = s+=2;
3453 flags = PERL_SCAN_SILENT_ILLDIGIT;
3454 rschar = (U32)grok_hex(s, &numlen, &flags, NULL);
3455 if (s + numlen < e) {
3456 rschar = 0; /* Grandfather -0xFOO as -0 -xFOO. */
3460 PL_rs = newSVpvs("");
3461 tmps = (U8*) SvGROW(PL_rs, (STRLEN)(UVCHR_SKIP(rschar) + 1));
3462 uvchr_to_utf8(tmps, rschar);
3463 SvCUR_set(PL_rs, UVCHR_SKIP(rschar));
3468 rschar = (U32)grok_oct(s, &numlen, &flags, NULL);
3469 if (rschar & ~((U8)~0))
3470 PL_rs = &PL_sv_undef;
3471 else if (!rschar && numlen >= 2)
3472 PL_rs = newSVpvs("");
3474 char ch = (char)rschar;
3475 PL_rs = newSVpvn(&ch, 1);
3478 sv_setsv(get_sv("/", GV_ADD), PL_rs);
3483 PL_unicode = parse_unicode_opts( (const char **)&s );
3484 if (PL_unicode & PERL_UNICODE_UTF8CACHEASSERT_FLAG)
3492 while (*s && !isSPACE(*s)) ++s;
3493 PL_splitstr = savepvn(PL_splitstr, s - PL_splitstr);
3505 forbid_setid('d', FALSE);
3508 /* -dt indicates to the debugger that threads will be used */
3509 if (*s == 't' && !isWORDCHAR(s[1])) {
3511 my_setenv("PERL5DB_THREADED", "1");
3514 /* The following permits -d:Mod to accepts arguments following an =
3515 in the fashion that -MSome::Mod does. */
3516 if (*s == ':' || *s == '=') {
3523 sv = newSVpvs("no Devel::");
3525 sv = newSVpvs("use Devel::");
3529 end = s + strlen(s);
3531 /* We now allow -d:Module=Foo,Bar and -d:-Module */
3532 while(isWORDCHAR(*s) || *s==':') ++s;
3534 sv_catpvn(sv, start, end - start);
3536 sv_catpvn(sv, start, s-start);
3537 /* Don't use NUL as q// delimiter here, this string goes in the
3539 Perl_sv_catpvf(aTHX_ sv, " split(/,/,q{%s});", ++s);
3542 my_setenv("PERL5DB", SvPV_nolen_const(sv));
3546 PL_perldb = PERLDB_ALL;
3553 forbid_setid('D', FALSE);
3555 PL_debug = get_debug_opts( (const char **)&s, 1) | DEBUG_TOP_FLAG;
3556 #else /* !DEBUGGING */
3557 if (ckWARN_d(WARN_DEBUGGING))
3558 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3559 "Recompile perl with -DDEBUGGING to use -D switch (did you mean -d ?)\n");
3560 for (s++; isWORDCHAR(*s); s++) ;
3563 NOT_REACHED; /* NOTREACHED */
3567 NOT_REACHED; /* NOTREACHED */
3570 Safefree(PL_inplace);
3572 const char * const start = ++s;
3573 while (*s && !isSPACE(*s))
3576 PL_inplace = savepvn(start, s - start);
3579 case 'I': /* -I handled both here and in parse_body() */
3580 forbid_setid('I', FALSE);
3582 while (*s && isSPACE(*s))
3587 /* ignore trailing spaces (possibly followed by other switches) */
3589 for (e = p; *e && !isSPACE(*e); e++) ;
3593 } while (*p && *p != '-');
3595 INCPUSH_ADD_SUB_DIRS|INCPUSH_ADD_OLD_VERS|INCPUSH_UNSHIFT);
3601 Perl_croak(aTHX_ "No directory specified for -I");
3607 SvREFCNT_dec(PL_ors_sv);
3613 PL_ors_sv = newSVpvs("\n");
3614 numlen = 3 + (*s == '0');
3615 *SvPVX(PL_ors_sv) = (char)grok_oct(s, &numlen, &flags, NULL);
3619 if (RsPARA(PL_rs)) {
3620 PL_ors_sv = newSVpvs("\n\n");
3623 PL_ors_sv = newSVsv(PL_rs);
3628 forbid_setid('M', FALSE); /* XXX ? */
3631 forbid_setid('m', FALSE); /* XXX ? */
3636 const char *use = "use ";
3638 /* -M-foo == 'no foo' */
3639 /* Leading space on " no " is deliberate, to make both
3640 possibilities the same length. */
3641 if (*s == '-') { use = " no "; ++s; }
3642 sv = newSVpvn(use,4);
3644 /* We allow -M'Module qw(Foo Bar)' */
3645 while(isWORDCHAR(*s) || *s==':') {
3654 Perl_croak(aTHX_ "Module name required with -%c option",
3657 Perl_croak(aTHX_ "Invalid module name %.*s with -%c option: "
3658 "contains single ':'",
3659 (int)(s - start), start, option);
3660 end = s + strlen(s);
3662 sv_catpvn(sv, start, end - start);
3663 if (option == 'm') {
3665 Perl_croak(aTHX_ "Can't use '%c' after -mname", *s);
3666 sv_catpvs( sv, " ()");
3669 sv_catpvn(sv, start, s-start);
3670 /* Use NUL as q''-delimiter. */
3671 sv_catpvs(sv, " split(/,/,q\0");
3673 sv_catpvn(sv, s, end - s);
3674 sv_catpvs(sv, "\0)");
3677 Perl_av_create_and_push(aTHX_ &PL_preambleav, sv);
3680 Perl_croak(aTHX_ "Missing argument to -%c", option);
3691 forbid_setid('s', FALSE);
3692 PL_doswitches = TRUE;
3697 #if defined(SILENT_NO_TAINT_SUPPORT)
3698 /* silently ignore */
3699 #elif defined(NO_TAINT_SUPPORT)
3700 Perl_croak_nocontext("This perl was compiled without taint support. "
3701 "Cowardly refusing to run with -t or -T flags");
3709 PL_do_undump = TRUE;
3719 if (! (PL_dowarn & G_WARN_ALL_MASK)) {
3720 PL_dowarn |= G_WARN_ON;
3725 PL_dowarn = G_WARN_ALL_ON|G_WARN_ON;
3726 if (!specialWARN(PL_compiling.cop_warnings))
3727 PerlMemShared_free(PL_compiling.cop_warnings);
3728 PL_compiling.cop_warnings = pWARN_ALL ;
3732 PL_dowarn = G_WARN_ALL_OFF;
3733 if (!specialWARN(PL_compiling.cop_warnings))
3734 PerlMemShared_free(PL_compiling.cop_warnings);
3735 PL_compiling.cop_warnings = pWARN_NONE ;
3742 if (s[0] == '-') /* Additional switches on #! line. */
3747 #if defined(WIN32) || !defined(PERL_STRICT_CR)
3753 #ifdef ALTERNATE_SHEBANG
3754 case 'S': /* OS/2 needs -S on "extproc" line. */
3757 case 'e': case 'f': case 'x': case 'E':
3758 #ifndef ALTERNATE_SHEBANG
3762 Perl_croak(aTHX_ "Can't emulate -%.1s on #! line",s);
3765 "Unrecognized switch: -%.1s (-h will show valid options)",s
3775 PerlIO * PIO_stdout;
3777 const char * const level_str = "v" PERL_VERSION_STRING;
3778 const STRLEN level_len = sizeof("v" PERL_VERSION_STRING)-1;
3779 #ifdef PERL_PATCHNUM
3781 # ifdef PERL_GIT_UNCOMMITTED_CHANGES
3782 static const char num [] = PERL_PATCHNUM "*";
3784 static const char num [] = PERL_PATCHNUM;
3787 const STRLEN num_len = sizeof(num)-1;
3788 /* A very advanced compiler would fold away the strnEQ
3789 and this whole conditional, but most (all?) won't do it.
3790 SV level could also be replaced by with preprocessor
3793 if (num_len >= level_len && strnEQ(num,level_str,level_len)) {
3794 /* per 46807d8e80, PERL_PATCHNUM is outside of the control
3795 of the interp so it might contain format characters
3797 level = newSVpvn(num, num_len);
3799 level = Perl_newSVpvf_nocontext("%s (%s)", level_str, num);
3803 SV* level = newSVpvn(level_str, level_len);
3804 #endif /* #ifdef PERL_PATCHNUM */
3805 PIO_stdout = PerlIO_stdout();
3806 PerlIO_printf(PIO_stdout,
3807 "\nThis is perl " STRINGIFY(PERL_REVISION)
3808 ", version " STRINGIFY(PERL_VERSION)
3809 ", subversion " STRINGIFY(PERL_SUBVERSION)
3810 " (%" SVf ") built for " ARCHNAME, SVfARG(level)
3812 SvREFCNT_dec_NN(level);
3814 #if defined(LOCAL_PATCH_COUNT)
3815 if (LOCAL_PATCH_COUNT > 0)
3816 PerlIO_printf(PIO_stdout,
3817 "\n(with %d registered patch%s, "
3818 "see perl -V for more detail)",
3820 (LOCAL_PATCH_COUNT!=1) ? "es" : "");
3823 PerlIO_printf(PIO_stdout,
3824 "\n\nCopyright 1987-2018, Larry Wall\n");
3826 PerlIO_printf(PIO_stdout,
3827 "\nMS-DOS port Copyright (c) 1989, 1990, Diomidis Spinellis\n");
3830 PerlIO_printf(PIO_stdout,
3831 "djgpp v2 port (jpl5003c) by Hirofumi Watanabe, 1996\n"
3832 "djgpp v2 port (perl5004+) by Laszlo Molnar, 1997-1999\n");
3835 PerlIO_printf(PIO_stdout,
3836 "\n\nOS/2 port Copyright (c) 1990, 1991, Raymond Chen, Kai Uwe Rommel\n"
3837 "Version 5 port Copyright (c) 1994-2002, Andreas Kaiser, Ilya Zakharevich\n");
3840 PerlIO_printf(PIO_stdout,
3841 "MVS (OS390) port by Mortice Kern Systems, 1997-1999\n");
3844 PerlIO_printf(PIO_stdout,
3845 "Stratus OpenVOS port by Paul.Green@stratus.com, 1997-2013\n");
3848 PerlIO_printf(PIO_stdout,
3849 "BS2000 (POSIX) port by Start Amadeus GmbH, 1998-1999\n");
3852 PerlIO_printf(PIO_stdout,
3853 "WINCE port by Rainer Keuchel, 2001-2002\n"
3854 "Built on " __DATE__ " " __TIME__ "\n\n");
3857 #ifdef __SYMBIAN32__
3858 PerlIO_printf(PIO_stdout,
3859 "Symbian port by Nokia, 2004-2005\n");
3861 #ifdef BINARY_BUILD_NOTICE
3862 BINARY_BUILD_NOTICE;
3864 PerlIO_printf(PIO_stdout,
3866 Perl may be copied only under the terms of either the Artistic License or the\n\
3867 GNU General Public License, which may be found in the Perl 5 source kit.\n\n\
3868 Complete documentation for Perl, including FAQ lists, should be found on\n\
3869 this system using \"man perl\" or \"perldoc perl\". If you have access to the\n\
3870 Internet, point your browser at http://www.perl.org/, the Perl Home Page.\n\n");
3874 /* compliments of Tom Christiansen */
3876 /* unexec() can be found in the Gnu emacs distribution */
3877 /* Known to work with -DUNEXEC and using unexelf.c from GNU emacs-20.2 */
3880 #include <lib$routines.h>
3884 Perl_my_unexec(pTHX)
3887 SV * prog = newSVpv(BIN_EXP, 0);
3888 SV * file = newSVpv(PL_origfilename, 0);
3892 sv_catpvs(prog, "/perl");
3893 sv_catpvs(file, ".perldump");
3895 unexec(SvPVX(file), SvPVX(prog), &etext, sbrk(0), 0);
3896 /* unexec prints msg to stderr in case of failure */
3897 PerlProc_exit(status);
3899 PERL_UNUSED_CONTEXT;
3901 lib$signal(SS$_DEBUG); /* ssdef.h #included from vmsish.h */
3902 # elif defined(WIN32) || defined(__CYGWIN__)
3903 Perl_croak_nocontext("dump is not supported");
3905 ABORT(); /* for use with undump */
3910 /* initialize curinterp */
3915 # define PERLVAR(prefix,var,type)
3916 # define PERLVARA(prefix,var,n,type)
3917 # if defined(PERL_IMPLICIT_CONTEXT)
3918 # define PERLVARI(prefix,var,type,init) aTHX->prefix##var = init;
3919 # define PERLVARIC(prefix,var,type,init) aTHX->prefix##var = init;
3921 # define PERLVARI(prefix,var,type,init) PERL_GET_INTERP->var = init;
3922 # define PERLVARIC(prefix,var,type,init) PERL_GET_INTERP->var = init;
3924 # include "intrpvar.h"
3930 # define PERLVAR(prefix,var,type)
3931 # define PERLVARA(prefix,var,n,type)
3932 # define PERLVARI(prefix,var,type,init) PL_##var = init;
3933 # define PERLVARIC(prefix,var,type,init) PL_##var = init;
3934 # include "intrpvar.h"
3944 S_init_main_stash(pTHX)
3949 PL_curstash = PL_defstash = (HV *)SvREFCNT_inc_simple_NN(hv);
3950 /* We know that the string "main" will be in the global shared string
3951 table, so it's a small saving to use it rather than allocate another
3953 PL_curstname = newSVpvs_share("main");
3954 gv = gv_fetchpvs("main::", GV_ADD|GV_NOTQUAL, SVt_PVHV);
3955 /* If we hadn't caused another reference to "main" to be in the shared
3956 string table above, then it would be worth reordering these two,
3957 because otherwise all we do is delete "main" from it as a consequence
3958 of the SvREFCNT_dec, only to add it again with hv_name_set */
3959 SvREFCNT_dec(GvHV(gv));
3960 hv_name_sets(PL_defstash, "main", 0);
3961 GvHV(gv) = MUTABLE_HV(SvREFCNT_inc_simple(PL_defstash));
3963 PL_incgv = gv_HVadd(gv_AVadd(gv_fetchpvs("INC", GV_ADD|GV_NOTQUAL,
3965 SvREFCNT_inc_simple_void(PL_incgv); /* Don't allow it to be freed */
3966 GvMULTI_on(PL_incgv);
3967 PL_hintgv = gv_fetchpvs("\010", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^H */
3968 SvREFCNT_inc_simple_void(PL_hintgv);
3969 GvMULTI_on(PL_hintgv);
3970 PL_defgv = gv_fetchpvs("_", GV_ADD|GV_NOTQUAL, SVt_PVAV);
3971 SvREFCNT_inc_simple_void(PL_defgv);
3972 PL_errgv = gv_fetchpvs("@", GV_ADD|GV_NOTQUAL, SVt_PV);
3973 SvREFCNT_inc_simple_void(PL_errgv);
3974 GvMULTI_on(PL_errgv);
3975 PL_replgv = gv_fetchpvs("\022", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^R */
3976 SvREFCNT_inc_simple_void(PL_replgv);
3977 GvMULTI_on(PL_replgv);
3978 (void)Perl_form(aTHX_ "%240s",""); /* Preallocate temp - for immediate signals. */
3979 #ifdef PERL_DONT_CREATE_GVSV
3980 (void)gv_SVadd(PL_errgv);
3982 sv_grow(ERRSV, 240); /* Preallocate - for immediate signals. */
3984 CopSTASH_set(&PL_compiling, PL_defstash);
3985 PL_debstash = GvHV(gv_fetchpvs("DB::", GV_ADDMULTI, SVt_PVHV));
3986 PL_globalstash = GvHV(gv_fetchpvs("CORE::GLOBAL::", GV_ADDMULTI,
3988 /* We must init $/ before switches are processed. */
3989 sv_setpvs(get_sv("/", GV_ADD), "\n");
3993 S_open_script(pTHX_ const char *scriptname, bool dosearch, bool *suidscript)
3996 PerlIO *rsfp = NULL;
4000 PERL_ARGS_ASSERT_OPEN_SCRIPT;
4003 PL_origfilename = savepvs("-e");
4008 /* if find_script() returns, it returns a malloc()-ed value */
4009 scriptname = PL_origfilename = find_script(scriptname, dosearch, NULL, 1);
4011 if (strBEGINs(scriptname, "/dev/fd/")
4012 && isDIGIT(scriptname[8])
4013 && grok_atoUV(scriptname + 8, &uv, &s)
4014 && uv <= PERL_INT_MAX
4019 * Tell apart "normal" usage of fdscript, e.g.
4020 * with bash on FreeBSD:
4021 * perl <( echo '#!perl -DA'; echo 'print "$0\n"')
4022 * from usage in suidperl.
4023 * Does any "normal" usage leave garbage after the number???
4024 * Is it a mistake to use a similar /dev/fd/ construct for
4029 * Be supersafe and do some sanity-checks.
4030 * Still, can we be sure we got the right thing?
4033 Perl_croak(aTHX_ "Wrong syntax (suid) fd script name \"%s\"\n", s);
4036 Perl_croak(aTHX_ "Missing (suid) fd script name\n");
4038 scriptname = savepv(s + 1);
4039 Safefree(PL_origfilename);
4040 PL_origfilename = (char *)scriptname;
4045 CopFILE_free(PL_curcop);
4046 CopFILE_set(PL_curcop, PL_origfilename);
4047 if (*PL_origfilename == '-' && PL_origfilename[1] == '\0')
4048 scriptname = (char *)"";
4049 if (fdscript >= 0) {
4050 rsfp = PerlIO_fdopen(fdscript,PERL_SCRIPT_MODE);
4052 else if (!*scriptname) {
4053 forbid_setid(0, *suidscript);
4057 #ifdef FAKE_BIT_BUCKET
4058 /* This hack allows one not to have /dev/null (or BIT_BUCKET as it
4059 * is called) and still have the "-e" work. (Believe it or not,
4060 * a /dev/null is required for the "-e" to work because source
4061 * filter magic is used to implement it. ) This is *not* a general
4062 * replacement for a /dev/null. What we do here is create a temp
4063 * file (an empty file), open up that as the script, and then
4064 * immediately close and unlink it. Close enough for jazz. */
4065 #define FAKE_BIT_BUCKET_PREFIX "/tmp/perlnull-"
4066 #define FAKE_BIT_BUCKET_SUFFIX "XXXXXXXX"
4067 #define FAKE_BIT_BUCKET_TEMPLATE FAKE_BIT_BUCKET_PREFIX FAKE_BIT_BUCKET_SUFFIX
4068 char tmpname[sizeof(FAKE_BIT_BUCKET_TEMPLATE)] = {
4069 FAKE_BIT_BUCKET_TEMPLATE
4071 const char * const err = "Failed to create a fake bit bucket";
4072 if (strEQ(scriptname, BIT_BUCKET)) {
4073 int tmpfd = Perl_my_mkstemp_cloexec(tmpname);
4075 scriptname = tmpname;
4078 Perl_croak(aTHX_ err);
4081 rsfp = PerlIO_open(scriptname,PERL_SCRIPT_MODE);
4082 #ifdef FAKE_BIT_BUCKET
4083 if ( strBEGINs(scriptname, FAKE_BIT_BUCKET_PREFIX)
4084 && strlen(scriptname) == sizeof(tmpname) - 1)
4088 scriptname = BIT_BUCKET;
4092 /* PSz 16 Sep 03 Keep neat error message */
4094 Perl_croak(aTHX_ "Can't open " BIT_BUCKET ": %s\n", Strerror(errno));
4096 Perl_croak(aTHX_ "Can't open perl script \"%s\": %s\n",
4097 CopFILE(PL_curcop), Strerror(errno));
4099 fd = PerlIO_fileno(rsfp);
4102 (PerlLIO_fstat(fd, &tmpstatbuf) >= 0
4103 && S_ISDIR(tmpstatbuf.st_mode)))
4104 Perl_croak(aTHX_ "Can't open perl script \"%s\": %s\n",
4111 /* In the days of suidperl, we refused to execute a setuid script stored on
4112 * a filesystem mounted nosuid and/or noexec. This meant that we probed for the
4113 * existence of the appropriate filesystem-statting function, and behaved
4114 * accordingly. But even though suidperl is long gone, we must still include
4115 * those probes for the benefit of modules like Filesys::Df, which expect the
4116 * results of those probes to be stored in %Config; see RT#126368. So mention
4117 * the relevant cpp symbols here, to ensure that metaconfig will include their
4118 * probes in the generated Configure:
4120 * I_SYSSTATVFS HAS_FSTATVFS
4122 * I_STATFS HAS_FSTATFS HAS_GETFSSTAT
4123 * I_MNTENT HAS_GETMNTENT HAS_HASMNTOPT
4127 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
4128 /* Don't even need this function. */
4131 S_validate_suid(pTHX_ PerlIO *rsfp)
4133 const Uid_t my_uid = PerlProc_getuid();
4134 const Uid_t my_euid = PerlProc_geteuid();
4135 const Gid_t my_gid = PerlProc_getgid();
4136 const Gid_t my_egid = PerlProc_getegid();
4138 PERL_ARGS_ASSERT_VALIDATE_SUID;
4140 if (my_euid != my_uid || my_egid != my_gid) { /* (suidperl doesn't exist, in fact) */
4142 int fd = PerlIO_fileno(rsfp);
4144 if (fd < 0 || PerlLIO_fstat(fd, &statbuf) < 0) { /* may be either wrapped or real suid */
4145 Perl_croak_nocontext( "Illegal suidscript");
4147 if ((my_euid != my_uid && my_euid == statbuf.st_uid && statbuf.st_mode & S_ISUID)
4149 (my_egid != my_gid && my_egid == statbuf.st_gid && statbuf.st_mode & S_ISGID)
4152 Perl_croak(aTHX_ "YOU HAVEN'T DISABLED SET-ID SCRIPTS IN THE KERNEL YET!\n\
4153 FIX YOUR KERNEL, PUT A C WRAPPER AROUND THIS SCRIPT, OR USE -u AND UNDUMP!\n");
4154 /* not set-id, must be wrapped */
4157 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4160 S_find_beginning(pTHX_ SV* linestr_sv, PerlIO *rsfp)
4165 PERL_ARGS_ASSERT_FIND_BEGINNING;
4167 /* skip forward in input to the real script? */
4170 if ((s = sv_gets(linestr_sv, rsfp, 0)) == NULL)
4171 Perl_croak(aTHX_ "No Perl script found in input\n");
4173 } while (!(*s == '#' && s[1] == '!' && ((s = instr(s,"perl")) || (s = instr(s2,"PERL")))));
4174 PerlIO_ungetc(rsfp, '\n'); /* to keep line count right */
4175 while (*s && !(isSPACE (*s) || *s == '#')) s++;
4177 while (*s == ' ' || *s == '\t') s++;
4179 while (isDIGIT(s2[-1]) || s2[-1] == '-' || s2[-1] == '.'
4180 || s2[-1] == '_') s2--;
4181 if (strBEGINs(s2-4,"perl"))
4182 while ((s = moreswitches(s)))
4191 /* no need to do anything here any more if we don't
4193 #ifndef NO_TAINT_SUPPORT
4194 const Uid_t my_uid = PerlProc_getuid();
4195 const Uid_t my_euid = PerlProc_geteuid();
4196 const Gid_t my_gid = PerlProc_getgid();
4197 const Gid_t my_egid = PerlProc_getegid();
4199 PERL_UNUSED_CONTEXT;
4201 /* Should not happen: */
4202 CHECK_MALLOC_TAINT(my_uid && (my_euid != my_uid || my_egid != my_gid));
4203 TAINTING_set( TAINTING_get | (my_uid && (my_euid != my_uid || my_egid != my_gid)) );
4207 * Should go by suidscript, not uid!=euid: why disallow
4208 * system("ls") in scripts run from setuid things?
4209 * Or, is this run before we check arguments and set suidscript?
4210 * What about SETUID_SCRIPTS_ARE_SECURE_NOW: could we use fdscript then?
4211 * (We never have suidscript, can we be sure to have fdscript?)
4212 * Or must then go by UID checks? See comments in forbid_setid also.
4216 /* This is used very early in the lifetime of the program,
4217 * before even the options are parsed, so PL_tainting has
4218 * not been initialized properly. */
4220 Perl_doing_taint(int argc, char *argv[], char *envp[])
4222 #ifndef PERL_IMPLICIT_SYS
4223 /* If we have PERL_IMPLICIT_SYS we can't call getuid() et alia
4224 * before we have an interpreter-- and the whole point of this
4225 * function is to be called at such an early stage. If you are on
4226 * a system with PERL_IMPLICIT_SYS but you do have a concept of
4227 * "tainted because running with altered effective ids', you'll
4228 * have to add your own checks somewhere in here. The two most
4229 * known samples of 'implicitness' are Win32 and NetWare, neither
4230 * of which has much of concept of 'uids'. */
4231 Uid_t uid = PerlProc_getuid();
4232 Uid_t euid = PerlProc_geteuid();
4233 Gid_t gid = PerlProc_getgid();
4234 Gid_t egid = PerlProc_getegid();
4241 if (uid && (euid != uid || egid != gid))
4243 #endif /* !PERL_IMPLICIT_SYS */
4244 /* This is a really primitive check; environment gets ignored only
4245 * if -T are the first chars together; otherwise one gets
4246 * "Too late" message. */
4247 if ( argc > 1 && argv[1][0] == '-'
4248 && isALPHA_FOLD_EQ(argv[1][1], 't'))
4253 /* Passing the flag as a single char rather than a string is a slight space
4254 optimisation. The only message that isn't /^-.$/ is
4255 "program input from stdin", which is substituted in place of '\0', which
4256 could never be a command line flag. */
4258 S_forbid_setid(pTHX_ const char flag, const bool suidscript) /* g */
4260 char string[3] = "-x";
4261 const char *message = "program input from stdin";
4263 PERL_UNUSED_CONTEXT;
4269 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
4270 if (PerlProc_getuid() != PerlProc_geteuid())
4271 Perl_croak(aTHX_ "No %s allowed while running setuid", message);
4272 if (PerlProc_getgid() != PerlProc_getegid())
4273 Perl_croak(aTHX_ "No %s allowed while running setgid", message);
4274 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4276 Perl_croak(aTHX_ "No %s allowed with (suid) fdscript", message);
4280 Perl_init_dbargs(pTHX)
4282 AV *const args = PL_dbargs = GvAV(gv_AVadd((gv_fetchpvs("DB::args",
4287 /* Someone has already created it.
4288 It might have entries, and if we just turn off AvREAL(), they will
4289 "leak" until global destruction. */
4291 if (SvTIED_mg((const SV *)args, PERL_MAGIC_tied))
4292 Perl_croak(aTHX_ "Cannot set tied @DB::args");
4294 AvREIFY_only(PL_dbargs);
4298 Perl_init_debugger(pTHX)
4300 HV * const ostash = PL_curstash;
4303 PL_curstash = (HV *)SvREFCNT_inc_simple(PL_debstash);
4305 Perl_init_dbargs(aTHX);
4306 PL_DBgv = MUTABLE_GV(
4307 SvREFCNT_inc(gv_fetchpvs("DB::DB", GV_ADDMULTI, SVt_PVGV))
4309 PL_DBline = MUTABLE_GV(
4310 SvREFCNT_inc(gv_fetchpvs("DB::dbline", GV_ADDMULTI, SVt_PVAV))
4312 PL_DBsub = MUTABLE_GV(SvREFCNT_inc(
4313 gv_HVadd(gv_fetchpvs("DB::sub", GV_ADDMULTI, SVt_PVHV))
4315 PL_DBsingle = GvSV((gv_fetchpvs("DB::single", GV_ADDMULTI, SVt_PV)));
4316 if (!SvIOK(PL_DBsingle))
4317 sv_setiv(PL_DBsingle, 0);
4318 mg = sv_magicext(PL_DBsingle, NULL, PERL_MAGIC_debugvar, &PL_vtbl_debugvar, 0, 0);
4319 mg->mg_private = DBVARMG_SINGLE;
4320 SvSETMAGIC(PL_DBsingle);
4322 PL_DBtrace = GvSV((gv_fetchpvs("DB::trace", GV_ADDMULTI, SVt_PV)));
4323 if (!SvIOK(PL_DBtrace))
4324 sv_setiv(PL_DBtrace, 0);
4325 mg = sv_magicext(PL_DBtrace, NULL, PERL_MAGIC_debugvar, &PL_vtbl_debugvar, 0, 0);
4326 mg->mg_private = DBVARMG_TRACE;
4327 SvSETMAGIC(PL_DBtrace);
4329 PL_DBsignal = GvSV((gv_fetchpvs("DB::signal", GV_ADDMULTI, SVt_PV)));
4330 if (!SvIOK(PL_DBsignal))
4331 sv_setiv(PL_DBsignal, 0);
4332 mg = sv_magicext(PL_DBsignal, NULL, PERL_MAGIC_debugvar, &PL_vtbl_debugvar, 0, 0);
4333 mg->mg_private = DBVARMG_SIGNAL;
4334 SvSETMAGIC(PL_DBsignal);
4336 SvREFCNT_dec(PL_curstash);
4337 PL_curstash = ostash;
4340 #ifndef STRESS_REALLOC
4341 #define REASONABLE(size) (size)
4342 #define REASONABLE_but_at_least(size,min) (size)
4344 #define REASONABLE(size) (1) /* unreasonable */
4345 #define REASONABLE_but_at_least(size,min) (min)
4349 Perl_init_stacks(pTHX)
4353 /* start with 128-item stack and 8K cxstack */
4354 PL_curstackinfo = new_stackinfo(REASONABLE(128),
4355 REASONABLE(8192/sizeof(PERL_CONTEXT) - 1));
4356 PL_curstackinfo->si_type = PERLSI_MAIN;
4357 #if defined DEBUGGING && !defined DEBUGGING_RE_ONLY
4358 PL_curstackinfo->si_stack_hwm = 0;
4360 PL_curstack = PL_curstackinfo->si_stack;
4361 PL_mainstack = PL_curstack; /* remember in case we switch stacks */
4363 PL_stack_base = AvARRAY(PL_curstack);
4364 PL_stack_sp = PL_stack_base;
4365 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
4367 Newx(PL_tmps_stack,REASONABLE(128),SV*);
4370 PL_tmps_max = REASONABLE(128);
4372 Newx(PL_markstack,REASONABLE(32),I32);
4373 PL_markstack_ptr = PL_markstack;
4374 PL_markstack_max = PL_markstack + REASONABLE(32);
4378 Newx(PL_scopestack,REASONABLE(32),I32);
4380 Newx(PL_scopestack_name,REASONABLE(32),const char*);
4382 PL_scopestack_ix = 0;
4383 PL_scopestack_max = REASONABLE(32);
4385 size = REASONABLE_but_at_least(128,SS_MAXPUSH);
4386 Newx(PL_savestack, size, ANY);
4387 PL_savestack_ix = 0;
4388 /*PL_savestack_max lies: it always has SS_MAXPUSH more than it claims */
4389 PL_savestack_max = size - SS_MAXPUSH;
4397 while (PL_curstackinfo->si_next)
4398 PL_curstackinfo = PL_curstackinfo->si_next;
4399 while (PL_curstackinfo) {
4400 PERL_SI *p = PL_curstackinfo->si_prev;
4401 /* curstackinfo->si_stack got nuked by sv_free_arenas() */
4402 Safefree(PL_curstackinfo->si_cxstack);
4403 Safefree(PL_curstackinfo);
4404 PL_curstackinfo = p;
4406 Safefree(PL_tmps_stack);
4407 Safefree(PL_markstack);
4408 Safefree(PL_scopestack);
4410 Safefree(PL_scopestack_name);
4412 Safefree(PL_savestack);
4416 Perl_populate_isa(pTHX_ const char *name, STRLEN len, ...)
4418 GV *const gv = gv_fetchpvn(name, len, GV_ADD | GV_ADDMULTI, SVt_PVAV);
4419 AV *const isa = GvAVn(gv);
4422 PERL_ARGS_ASSERT_POPULATE_ISA;
4424 if(AvFILLp(isa) != -1)
4427 /* NOTE: No support for tied ISA */
4429 va_start(args, len);
4431 const char *const parent = va_arg(args, const char*);
4436 parent_len = va_arg(args, size_t);
4438 /* Arguments are supplied with a trailing :: */
4439 assert(parent_len > 2);
4440 assert(parent[parent_len - 1] == ':');
4441 assert(parent[parent_len - 2] == ':');
4442 av_push(isa, newSVpvn(parent, parent_len - 2));
4443 (void) gv_fetchpvn(parent, parent_len, GV_ADD, SVt_PVGV);
4450 S_init_predump_symbols(pTHX)
4455 sv_setpvs(get_sv("\"", GV_ADD), " ");
4456 PL_ofsgv = (GV*)SvREFCNT_inc(gv_fetchpvs(",", GV_ADD|GV_NOTQUAL, SVt_PV));
4459 /* Historically, PVIOs were blessed into IO::Handle, unless
4460 FileHandle was loaded, in which case they were blessed into
4461 that. Action at a distance.
4462 However, if we simply bless into IO::Handle, we break code
4463 that assumes that PVIOs will have (among others) a seek
4464 method. IO::File inherits from IO::Handle and IO::Seekable,
4465 and provides the needed methods. But if we simply bless into
4466 it, then we break code that assumed that by loading
4467 IO::Handle, *it* would work.
4468 So a compromise is to set up the correct @IO::File::ISA,
4469 so that code that does C<use IO::Handle>; will still work.
4472 Perl_populate_isa(aTHX_ STR_WITH_LEN("IO::File::ISA"),
4473 STR_WITH_LEN("IO::Handle::"),
4474 STR_WITH_LEN("IO::Seekable::"),
4475 STR_WITH_LEN("Exporter::"),
4478 PL_stdingv = gv_fetchpvs("STDIN", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4479 GvMULTI_on(PL_stdingv);
4480 io = GvIOp(PL_stdingv);
4481 IoTYPE(io) = IoTYPE_RDONLY;
4482 IoIFP(io) = PerlIO_stdin();
4483 tmpgv = gv_fetchpvs("stdin", GV_ADD|GV_NOTQUAL, SVt_PV);
4485 GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4487 tmpgv = gv_fetchpvs("STDOUT", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4490 IoTYPE(io) = IoTYPE_WRONLY;
4491 IoOFP(io) = IoIFP(io) = PerlIO_stdout();
4493 tmpgv = gv_fetchpvs("stdout", GV_ADD|GV_NOTQUAL, SVt_PV);
4495 GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4497 PL_stderrgv = gv_fetchpvs("STDERR", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4498 GvMULTI_on(PL_stderrgv);
4499 io = GvIOp(PL_stderrgv);
4500 IoTYPE(io) = IoTYPE_WRONLY;
4501 IoOFP(io) = IoIFP(io) = PerlIO_stderr();
4502 tmpgv = gv_fetchpvs("stderr", GV_ADD|GV_NOTQUAL, SVt_PV);
4504 GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4506 PL_statname = newSVpvs(""); /* last filename we did stat on */
4510 Perl_init_argv_symbols(pTHX_ int argc, char **argv)
4512 PERL_ARGS_ASSERT_INIT_ARGV_SYMBOLS;
4514 argc--,argv++; /* skip name of script */
4515 if (PL_doswitches) {
4516 for (; argc > 0 && **argv == '-'; argc--,argv++) {
4520 if (argv[0][1] == '-' && !argv[0][2]) {
4524 if ((s = strchr(argv[0], '='))) {
4525 const char *const start_name = argv[0] + 1;
4526 sv_setpv(GvSV(gv_fetchpvn_flags(start_name, s - start_name,
4527 TRUE, SVt_PV)), s + 1);
4530 sv_setiv(GvSV(gv_fetchpv(argv[0]+1, GV_ADD, SVt_PV)),1);
4533 if ((PL_argvgv = gv_fetchpvs("ARGV", GV_ADD|GV_NOTQUAL, SVt_PVAV))) {
4534 SvREFCNT_inc_simple_void_NN(PL_argvgv);
4535 GvMULTI_on(PL_argvgv);
4536 av_clear(GvAVn(PL_argvgv));
4537 for (; argc > 0; argc--,argv++) {
4538 SV * const sv = newSVpv(argv[0],0);
4539 av_push(GvAV(PL_argvgv),sv);
4540 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
4541 if (PL_unicode & PERL_UNICODE_ARGV_FLAG)
4544 if (PL_unicode & PERL_UNICODE_WIDESYSCALLS_FLAG) /* Sarathy? */
4545 (void)sv_utf8_decode(sv);
4549 if (PL_inplace && (!PL_argvgv || AvFILL(GvAV(PL_argvgv)) == -1))
4550 Perl_ck_warner_d(aTHX_ packWARN(WARN_INPLACE),
4551 "-i used with no filenames on the command line, "
4552 "reading from STDIN");
4556 S_init_postdump_symbols(pTHX_ int argc, char **argv, char **env)
4563 PERL_ARGS_ASSERT_INIT_POSTDUMP_SYMBOLS;
4565 PL_toptarget = newSV_type(SVt_PVIV);
4566 SvPVCLEAR(PL_toptarget);
4567 PL_bodytarget = newSV_type(SVt_PVIV);
4568 SvPVCLEAR(PL_bodytarget);
4569 PL_formtarget = PL_bodytarget;
4573 init_argv_symbols(argc,argv);
4575 if ((tmpgv = gv_fetchpvs("0", GV_ADD|GV_NOTQUAL, SVt_PV))) {
4576 sv_setpv(GvSV(tmpgv),PL_origfilename);
4578 if ((PL_envgv = gv_fetchpvs("ENV", GV_ADD|GV_NOTQUAL, SVt_PVHV))) {
4580 bool env_is_not_environ;
4581 SvREFCNT_inc_simple_void_NN(PL_envgv);
4582 GvMULTI_on(PL_envgv);
4583 hv = GvHVn(PL_envgv);
4584 hv_magic(hv, NULL, PERL_MAGIC_env);
4586 #ifdef USE_ENVIRON_ARRAY
4587 /* Note that if the supplied env parameter is actually a copy
4588 of the global environ then it may now point to free'd memory
4589 if the environment has been modified since. To avoid this
4590 problem we treat env==NULL as meaning 'use the default'
4594 env_is_not_environ = env != environ;
4595 if (env_is_not_environ
4596 # ifdef USE_ITHREADS
4597 && PL_curinterp == aTHX
4609 for (; *env; env++) {
4612 if (!(s = strchr(old_var,'=')) || s == old_var)
4616 #if defined(MSDOS) && !defined(DJGPP)
4618 (void)strupr(old_var);
4621 if (hv_exists(hv, old_var, nlen)) {
4622 const char *name = savepvn(old_var, nlen);
4624 /* make sure we use the same value as getenv(), otherwise code that
4625 uses getenv() (like setlocale()) might see a different value to %ENV
4627 sv = newSVpv(PerlEnv_getenv(name), 0);
4629 /* keep a count of the dups of this name so we can de-dup environ later */
4630 if (hv_exists(dups, name, nlen))
4631 ++SvIVX(*hv_fetch(dups, name, nlen, 0));
4633 (void)hv_store(dups, name, nlen, newSViv(1), 0);
4638 sv = newSVpv(s+1, 0);
4640 (void)hv_store(hv, old_var, nlen, sv, 0);
4641 if (env_is_not_environ)
4645 /* environ has some duplicate definitions, remove them */
4648 while ((entry = hv_iternext_flags(dups, 0))) {
4650 const char *name = HePV(entry, nlen);
4651 IV count = SvIV(HeVAL(entry));
4653 SV **valp = hv_fetch(hv, name, nlen, 0);
4657 /* try to remove any duplicate names, depending on the
4658 * implementation used in my_setenv() the iteration might
4659 * not be necessary, but let's be safe.
4661 for (i = 0; i < count; ++i)
4664 /* and set it back to the value we set $ENV{name} to */
4665 my_setenv(name, SvPV_nolen(*valp));
4668 SvREFCNT_dec_NN(dups);
4670 #endif /* USE_ENVIRON_ARRAY */
4671 #endif /* !PERL_MICRO */
4675 /* touch @F array to prevent spurious warnings 20020415 MJD */
4677 (void) get_av("main::F", GV_ADD | GV_ADDMULTI);
4682 S_init_perllib(pTHX)
4685 const char *perl5lib = NULL;
4688 #if defined(WIN32) && !defined(PERL_IS_MINIPERL)
4692 if (!TAINTING_get) {
4694 perl5lib = PerlEnv_getenv("PERL5LIB");
4696 * It isn't possible to delete an environment variable with
4697 * PERL_USE_SAFE_PUTENV set unless unsetenv() is also available, so in that
4698 * case we treat PERL5LIB as undefined if it has a zero-length value.
4700 #if defined(PERL_USE_SAFE_PUTENV) && ! defined(HAS_UNSETENV)
4701 if (perl5lib && *perl5lib != '\0')
4705 incpush_use_sep(perl5lib, 0, INCPUSH_ADD_SUB_DIRS);
4707 s = PerlEnv_getenv("PERLLIB");
4709 incpush_use_sep(s, 0, 0);
4712 /* Treat PERL5?LIB as a possible search list logical name -- the
4713 * "natural" VMS idiom for a Unix path string. We allow each
4714 * element to be a set of |-separated directories for compatibility.
4718 if (vmstrnenv("PERL5LIB",buf,0,NULL,0))
4720 incpush_use_sep(buf, 0, INCPUSH_ADD_SUB_DIRS);
4721 } while (vmstrnenv("PERL5LIB",buf,++idx,NULL,0));
4723 while (vmstrnenv("PERLLIB",buf,idx++,NULL,0))
4724 incpush_use_sep(buf, 0, 0);
4729 #ifndef PERL_IS_MINIPERL
4730 /* miniperl gets just -I..., the split of $ENV{PERL5LIB}, and "." in @INC
4731 (and not the architecture specific directories from $ENV{PERL5LIB}) */
4733 #include "perl_inc_macro.h"
4734 /* Use the ~-expanded versions of APPLLIB (undocumented),
4735 SITEARCH, SITELIB, VENDORARCH, VENDORLIB, ARCHLIB and PRIVLIB
4738 INCPUSH_SITEARCH_EXP
4740 INCPUSH_PERL_VENDORARCH_EXP
4741 INCPUSH_PERL_VENDORLIB_EXP
4744 INCPUSH_PERL_OTHERLIBDIRS
4746 INCPUSH_APPLLIB_OLD_EXP
4747 INCPUSH_SITELIB_STEM
4748 INCPUSH_PERL_VENDORLIB_STEM
4749 INCPUSH_PERL_OTHERLIBDIRS_ARCHONLY
4751 #endif /* !PERL_IS_MINIPERL */
4753 if (!TAINTING_get) {
4754 #if !defined(PERL_IS_MINIPERL) && defined(DEFAULT_INC_EXCLUDES_DOT)
4755 const char * const unsafe = PerlEnv_getenv("PERL_USE_UNSAFE_INC");
4756 if (unsafe && strEQ(unsafe, "1"))
4758 S_incpush(aTHX_ STR_WITH_LEN("."), 0);
4762 #if defined(DOSISH) || defined(__SYMBIAN32__)
4763 # define PERLLIB_SEP ';'
4764 #elif defined(__VMS)
4765 # define PERLLIB_SEP PL_perllib_sep
4767 # define PERLLIB_SEP ':'
4769 #ifndef PERLLIB_MANGLE
4770 # define PERLLIB_MANGLE(s,n) (s)
4773 #ifndef PERL_IS_MINIPERL
4774 /* Push a directory onto @INC if it exists.
4775 Generate a new SV if we do this, to save needing to copy the SV we push
4778 S_incpush_if_exists(pTHX_ AV *const av, SV *dir, SV *const stem)
4782 PERL_ARGS_ASSERT_INCPUSH_IF_EXISTS;
4784 if (PerlLIO_stat(SvPVX_const(dir), &tmpstatbuf) >= 0 &&
4785 S_ISDIR(tmpstatbuf.st_mode)) {
4787 dir = newSVsv(stem);
4789 /* Truncate dir back to stem. */
4790 SvCUR_set(dir, SvCUR(stem));
4797 S_mayberelocate(pTHX_ const char *const dir, STRLEN len, U32 flags)
4799 const U8 canrelocate = (U8)flags & INCPUSH_CAN_RELOCATE;
4802 PERL_ARGS_ASSERT_MAYBERELOCATE;
4805 /* I am not convinced that this is valid when PERLLIB_MANGLE is
4806 defined to so something (in os2/os2.c), but the code has been
4807 this way, ignoring any possible changed of length, since
4808 760ac839baf413929cd31cc32ffd6dba6b781a81 (5.003_02) so I'll leave
4810 libdir = newSVpvn(PERLLIB_MANGLE(dir, len), len);
4816 if ((unix = tounixspec_ts(SvPV(libdir,len),NULL)) != NULL) {
4818 while (len > 1 && unix[len-1] == '/') len--; /* Cosmetic */
4819 sv_usepvn(libdir,unix,len);
4822 PerlIO_printf(Perl_error_log,
4823 "Failed to unixify @INC element \"%s\"\n",
4824 SvPV_nolen_const(libdir));
4828 /* Do the if() outside the #ifdef to avoid warnings about an unused
4831 #ifdef PERL_RELOCATABLE_INC
4833 * Relocatable include entries are marked with a leading .../
4836 * 0: Remove that leading ".../"
4837 * 1: Remove trailing executable name (anything after the last '/')
4838 * from the perl path to give a perl prefix
4840 * While the @INC element starts "../" and the prefix ends with a real
4841 * directory (ie not . or ..) chop that real directory off the prefix
4842 * and the leading "../" from the @INC element. ie a logical "../"
4844 * Finally concatenate the prefix and the remainder of the @INC element
4845 * The intent is that /usr/local/bin/perl and .../../lib/perl5
4846 * generates /usr/local/lib/perl5
4848 const char *libpath = SvPVX(libdir);
4849 STRLEN libpath_len = SvCUR(libdir);
4850 if (memBEGINs(libpath, libpath_len, ".../")) {
4852 SV * const caret_X = get_sv("\030", 0);
4853 /* Going to use the SV just as a scratch buffer holding a C
4859 /* $^X is *the* source of taint if tainting is on, hence
4860 SvPOK() won't be true. */
4862 assert(SvPOKp(caret_X));
4863 prefix_sv = newSVpvn_flags(SvPVX(caret_X), SvCUR(caret_X),
4865 /* Firstly take off the leading .../
4866 If all else fail we'll do the paths relative to the current
4868 sv_chop(libdir, libpath + 4);
4869 /* Don't use SvPV as we're intentionally bypassing taining,
4870 mortal copies that the mg_get of tainting creates, and
4871 corruption that seems to come via the save stack.
4872 I guess that the save stack isn't correctly set up yet. */
4873 libpath = SvPVX(libdir);
4874 libpath_len = SvCUR(libdir);
4876 prefix = SvPVX(prefix_sv);
4877 lastslash = (char *) my_memrchr(prefix, '/',
4878 SvEND(prefix_sv) - prefix);
4880 /* First time in with the *lastslash = '\0' we just wipe off
4881 the trailing /perl from (say) /usr/foo/bin/perl
4885 while ((*lastslash = '\0'), /* Do that, come what may. */
4886 ( memBEGINs(libpath, libpath_len, "../")
4888 (char *) my_memrchr(prefix, '/',
4889 SvEND(prefix_sv) - prefix))))
4891 if (lastslash[1] == '\0'
4892 || (lastslash[1] == '.'
4893 && (lastslash[2] == '/' /* ends "/." */
4894 || (lastslash[2] == '/'
4895 && lastslash[3] == '/' /* or "/.." */
4897 /* Prefix ends "/" or "/." or "/..", any of which
4898 are fishy, so don't do any more logical cleanup.
4902 /* Remove leading "../" from path */
4905 /* Next iteration round the loop removes the last
4906 directory name from prefix by writing a '\0' in
4907 the while clause. */
4909 /* prefix has been terminated with a '\0' to the correct
4910 length. libpath points somewhere into the libdir SV.
4911 We need to join the 2 with '/' and drop the result into
4913 tempsv = Perl_newSVpvf(aTHX_ "%s/%s", prefix, libpath);
4914 SvREFCNT_dec(libdir);
4915 /* And this is the new libdir. */
4918 (PerlProc_getuid() != PerlProc_geteuid() ||
4919 PerlProc_getgid() != PerlProc_getegid())) {
4920 /* Need to taint relocated paths if running set ID */
4921 SvTAINTED_on(libdir);
4924 SvREFCNT_dec(prefix_sv);
4932 S_incpush(pTHX_ const char *const dir, STRLEN len, U32 flags)
4934 #ifndef PERL_IS_MINIPERL
4935 const U8 using_sub_dirs
4936 = (U8)flags & (INCPUSH_ADD_VERSIONED_SUB_DIRS
4937 |INCPUSH_ADD_ARCHONLY_SUB_DIRS|INCPUSH_ADD_OLD_VERS);
4938 const U8 add_versioned_sub_dirs
4939 = (U8)flags & INCPUSH_ADD_VERSIONED_SUB_DIRS;
4940 const U8 add_archonly_sub_dirs
4941 = (U8)flags & INCPUSH_ADD_ARCHONLY_SUB_DIRS;
4942 #ifdef PERL_INC_VERSION_LIST
4943 const U8 addoldvers = (U8)flags & INCPUSH_ADD_OLD_VERS;
4946 const U8 unshift = (U8)flags & INCPUSH_UNSHIFT;
4947 const U8 push_basedir = (flags & INCPUSH_NOT_BASEDIR) ? 0 : 1;
4948 AV *const inc = GvAVn(PL_incgv);
4950 PERL_ARGS_ASSERT_INCPUSH;
4953 /* Could remove this vestigial extra block, if we don't mind a lot of
4954 re-indenting diff noise. */
4956 SV *const libdir = mayberelocate(dir, len, flags);
4957 /* Change 20189146be79a0596543441fa369c6bf7f85103f, to fix RT#6665,
4958 arranged to unshift #! line -I onto the front of @INC. However,
4959 -I can add version and architecture specific libraries, and they
4960 need to go first. The old code assumed that it was always
4961 pushing. Hence to make it work, need to push the architecture
4962 (etc) libraries onto a temporary array, then "unshift" that onto
4963 the front of @INC. */
4964 #ifndef PERL_IS_MINIPERL
4965 AV *const av = (using_sub_dirs) ? (unshift ? newAV() : inc) : NULL;
4968 * BEFORE pushing libdir onto @INC we may first push version- and
4969 * archname-specific sub-directories.
4971 if (using_sub_dirs) {
4972 SV *subdir = newSVsv(libdir);
4973 #ifdef PERL_INC_VERSION_LIST
4974 /* Configure terminates PERL_INC_VERSION_LIST with a NULL */
4975 const char * const incverlist[] = { PERL_INC_VERSION_LIST };
4976 const char * const *incver;
4979 if (add_versioned_sub_dirs) {
4980 /* .../version/archname if -d .../version/archname */
4981 sv_catpvs(subdir, "/" PERL_FS_VERSION "/" ARCHNAME);
4982 subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
4984 /* .../version if -d .../version */
4985 sv_catpvs(subdir, "/" PERL_FS_VERSION);
4986 subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
4989 #ifdef PERL_INC_VERSION_LIST
4991 for (incver = incverlist; *incver; incver++) {
4992 /* .../xxx if -d .../xxx */
4993 Perl_sv_catpvf(aTHX_ subdir, "/%s", *incver);
4994 subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
4999 if (add_archonly_sub_dirs) {
5000 /* .../archname if -d .../archname */
5001 sv_catpvs(subdir, "/" ARCHNAME);
5002 subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
5006 assert (SvREFCNT(subdir) == 1);
5007 SvREFCNT_dec(subdir);
5009 #endif /* !PERL_IS_MINIPERL */
5010 /* finally add this lib directory at the end of @INC */
5012 #ifdef PERL_IS_MINIPERL
5013 const Size_t extra = 0;
5015 Size_t extra = av_tindex(av) + 1;
5017 av_unshift(inc, extra + push_basedir);
5019 av_store(inc, extra, libdir);
5020 #ifndef PERL_IS_MINIPERL
5022 /* av owns a reference, av_store() expects to be donated a
5023 reference, and av expects to be sane when it's cleared.
5024 If I wanted to be naughty and wrong, I could peek inside the
5025 implementation of av_clear(), realise that it uses
5026 SvREFCNT_dec() too, so av's array could be a run of NULLs,
5027 and so directly steal from it (with a memcpy() to inc, and
5028 then memset() to NULL them out. But people copy code from the
5029 core expecting it to be best practise, so let's use the API.
5030 Although studious readers will note that I'm not checking any
5032 av_store(inc, extra, SvREFCNT_inc(*av_fetch(av, extra, FALSE)));
5037 else if (push_basedir) {
5038 av_push(inc, libdir);
5041 if (!push_basedir) {
5042 assert (SvREFCNT(libdir) == 1);
5043 SvREFCNT_dec(libdir);
5049 S_incpush_use_sep(pTHX_ const char *p, STRLEN len, U32 flags)
5053 /* This logic has been broken out from S_incpush(). It may be possible to
5056 PERL_ARGS_ASSERT_INCPUSH_USE_SEP;
5058 /* perl compiled with -DPERL_RELOCATABLE_INCPUSH will ignore the len
5059 * argument to incpush_use_sep. This allows creation of relocatable
5060 * Perl distributions that patch the binary at install time. Those
5061 * distributions will have to provide their own relocation tools; this
5062 * is not a feature otherwise supported by core Perl.
5064 #ifndef PERL_RELOCATABLE_INCPUSH
5071 /* Break at all separators */
5072 while ((s = (const char*)memchr(p, PERLLIB_SEP, end - p))) {
5074 /* skip any consecutive separators */
5076 /* Uncomment the next line for PATH semantics */
5077 /* But you'll need to write tests */
5078 /* av_push(GvAVn(PL_incgv), newSVpvs(".")); */
5080 incpush(p, (STRLEN)(s - p), flags);
5085 incpush(p, (STRLEN)(end - p), flags);
5090 Perl_call_list(pTHX_ I32 oldscope, AV *paramList)
5093 volatile const line_t oldline = PL_curcop ? CopLINE(PL_curcop) : 0;
5099 PERL_ARGS_ASSERT_CALL_LIST;
5101 while (av_tindex(paramList) >= 0) {
5102 cv = MUTABLE_CV(av_shift(paramList));
5104 if (paramList == PL_beginav) {
5105 /* save PL_beginav for compiler */
5106 Perl_av_create_and_push(aTHX_ &PL_beginav_save, MUTABLE_SV(cv));
5108 else if (paramList == PL_checkav) {
5109 /* save PL_checkav for compiler */
5110 Perl_av_create_and_push(aTHX_ &PL_checkav_save, MUTABLE_SV(cv));
5112 else if (paramList == PL_unitcheckav) {
5113 /* save PL_unitcheckav for compiler */
5114 Perl_av_create_and_push(aTHX_ &PL_unitcheckav_save, MUTABLE_SV(cv));
5124 (void)SvPV_const(atsv, len);
5126 PL_curcop = &PL_compiling;
5127 CopLINE_set(PL_curcop, oldline);
5128 if (paramList == PL_beginav)
5129 sv_catpvs(atsv, "BEGIN failed--compilation aborted");
5131 Perl_sv_catpvf(aTHX_ atsv,
5132 "%s failed--call queue aborted",
5133 paramList == PL_checkav ? "CHECK"
5134 : paramList == PL_initav ? "INIT"
5135 : paramList == PL_unitcheckav ? "UNITCHECK"
5137 while (PL_scopestack_ix > oldscope)
5140 Perl_croak(aTHX_ "%" SVf, SVfARG(atsv));
5147 /* my_exit() was called */
5148 while (PL_scopestack_ix > oldscope)
5151 SET_CURSTASH(PL_defstash);
5152 PL_curcop = &PL_compiling;
5153 CopLINE_set(PL_curcop, oldline);
5156 NOT_REACHED; /* NOTREACHED */
5159 PL_curcop = &PL_compiling;
5160 CopLINE_set(PL_curcop, oldline);
5163 PerlIO_printf(Perl_error_log, "panic: restartop in call_list\n");
5172 Perl_my_exit(pTHX_ U32 status)
5174 if (PL_exit_flags & PERL_EXIT_ABORT) {
5177 if (PL_exit_flags & PERL_EXIT_WARN) {
5178 PL_exit_flags |= PERL_EXIT_ABORT; /* Protect against reentrant calls */
5179 Perl_warn(aTHX_ "Unexpected exit %lu", (unsigned long)status);
5180 PL_exit_flags &= ~PERL_EXIT_ABORT;
5190 STATUS_EXIT_SET(status);
5197 Perl_my_failure_exit(pTHX)
5200 /* We have been called to fall on our sword. The desired exit code
5201 * should be already set in STATUS_UNIX, but could be shifted over
5202 * by 8 bits. STATUS_UNIX_EXIT_SET will handle the cases where a
5205 * If an error code has not been set, then force the issue.
5207 if (MY_POSIX_EXIT) {
5209 /* According to the die_exit.t tests, if errno is non-zero */
5210 /* It should be used for the error status. */
5212 if (errno == EVMSERR) {
5213 STATUS_NATIVE = vaxc$errno;
5216 /* According to die_exit.t tests, if the child_exit code is */
5217 /* also zero, then we need to exit with a code of 255 */
5218 if ((errno != 0) && (errno < 256))
5219 STATUS_UNIX_EXIT_SET(errno);
5220 else if (STATUS_UNIX < 255) {
5221 STATUS_UNIX_EXIT_SET(255);
5226 /* The exit code could have been set by $? or vmsish which
5227 * means that it may not have fatal set. So convert
5228 * success/warning codes to fatal with out changing
5229 * the POSIX status code. The severity makes VMS native
5230 * status handling work, while UNIX mode programs use the
5231 * the POSIX exit codes.
5233 if ((STATUS_NATIVE & (STS$K_SEVERE|STS$K_ERROR)) == 0) {
5234 STATUS_NATIVE &= STS$M_COND_ID;
5235 STATUS_NATIVE |= STS$K_ERROR | STS$M_INHIB_MSG;
5239 /* Traditionally Perl on VMS always expects a Fatal Error. */
5240 if (vaxc$errno & 1) {
5242 /* So force success status to failure */
5243 if (STATUS_NATIVE & 1)
5248 STATUS_UNIX = EINTR; /* In case something cares */
5253 STATUS_NATIVE = vaxc$errno; /* Should already be this */
5255 /* Encode the severity code */
5256 severity = STATUS_NATIVE & STS$M_SEVERITY;
5257 STATUS_UNIX = (severity ? severity : 1) << 8;
5259 /* Perl expects this to be a fatal error */
5260 if (severity != STS$K_SEVERE)
5270 STATUS_UNIX_SET(eno);
5272 exitstatus = STATUS_UNIX >> 8;
5273 if (exitstatus & 255)
5274 STATUS_UNIX_SET(exitstatus);
5276 STATUS_UNIX_SET(255);
5279 if (PL_exit_flags & PERL_EXIT_ABORT) {
5282 if (PL_exit_flags & PERL_EXIT_WARN) {
5283 PL_exit_flags |= PERL_EXIT_ABORT; /* Protect against reentrant calls */
5284 Perl_warn(aTHX_ "Unexpected exit failure %ld", (long)PL_statusvalue);
5285 PL_exit_flags &= ~PERL_EXIT_ABORT;
5291 S_my_exit_jump(pTHX)
5294 SvREFCNT_dec(PL_e_script);
5298 POPSTACK_TO(PL_mainstack);
5299 if (cxstack_ix >= 0) {
5301 cx_popblock(cxstack);
5309 read_e_script(pTHX_ int idx, SV *buf_sv, int maxlen)
5311 const char * const p = SvPVX_const(PL_e_script);
5312 const char * const e = SvEND(PL_e_script);
5313 const char *nl = (char *) memchr(p, '\n', e - p);
5315 PERL_UNUSED_ARG(idx);
5316 PERL_UNUSED_ARG(maxlen);
5318 nl = (nl) ? nl+1 : e;
5320 filter_del(read_e_script);
5323 sv_catpvn(buf_sv, p, nl-p);
5324 sv_chop(PL_e_script, nl);
5328 /* removes boilerplate code at the end of each boot_Module xsub */
5330 Perl_xs_boot_epilog(pTHX_ const I32 ax)
5333 call_list(PL_scopestack_ix, PL_unitcheckav);
5338 * ex: set ts=8 sts=4 sw=4 et: