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 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();
302 #if defined(LOCAL_PATCH_COUNT)
303 PL_localpatches = local_patches; /* For possible -v */
306 #if defined(LIBM_LIB_VERSION)
308 * Some BSDs and Cygwin default to POSIX math instead of IEEE.
309 * This switches them over to IEEE.
311 _LIB_VERSION = _IEEE_;
314 #ifdef HAVE_INTERP_INTERN
318 PerlIO_init(aTHX); /* Hook to IO system */
320 PL_fdpid = newAV(); /* for remembering popen pids by fd */
321 PL_modglobal = newHV(); /* pointers to per-interpreter module globals */
322 PL_errors = newSVpvs("");
323 SvPVCLEAR(PERL_DEBUG_PAD(0)); /* For regex debugging. */
324 SvPVCLEAR(PERL_DEBUG_PAD(1)); /* ext/re needs these */
325 SvPVCLEAR(PERL_DEBUG_PAD(2)); /* even without DEBUGGING. */
327 /* First entry is a list of empty elements. It needs to be initialised
328 else all hell breaks loose in S_find_uninit_var(). */
329 Perl_av_create_and_push(aTHX_ &PL_regex_padav, newSVpvs(""));
330 PL_regex_pad = AvARRAY(PL_regex_padav);
331 Newxz(PL_stashpad, PL_stashpadmax, HV *);
333 #ifdef USE_REENTRANT_API
334 Perl_reentrant_init(aTHX);
336 if (PL_hash_seed_set == FALSE) {
337 /* Initialize the hash seed and state at startup. This must be
338 * done very early, before ANY hashes are constructed, and once
339 * setup is fixed for the lifetime of the process.
341 * If you decide to disable the seeding process you should choose
342 * a suitable seed yourself and define PERL_HASH_SEED to a well chosen
343 * string. See hv_func.h for details.
345 #if defined(USE_HASH_SEED)
346 /* get the hash seed from the environment or from an RNG */
347 Perl_get_hash_seed(aTHX_ PL_hash_seed);
349 /* they want a hard coded seed, check that it is long enough */
350 assert( strlen(PERL_HASH_SEED) >= PERL_HASH_SEED_BYTES );
353 /* now we use the chosen seed to initialize the state -
354 * in some configurations this may be a relatively speaking
355 * expensive operation, but we only have to do it once at startup */
356 PERL_HASH_SEED_STATE(PERL_HASH_SEED,PL_hash_state);
358 #ifdef PERL_USE_SINGLE_CHAR_HASH_CACHE
359 /* we can build a special cache for 0/1 byte keys, if people choose
360 * I suspect most of the time it is not worth it */
364 for (i=0;i<256;i++) {
366 PERL_HASH_WITH_STATE(PL_hash_state,PL_hash_chars[i],str,1);
368 PERL_HASH_WITH_STATE(PL_hash_state,PL_hash_chars[256],str,0);
371 /* at this point we have initialezed the hash function, and we can start
372 * constructing hashes */
373 PL_hash_seed_set= TRUE;
376 /* Allow PL_strtab to be pre-initialized before calling perl_construct.
377 * can use a custom optimized PL_strtab hash before calling perl_construct */
379 /* Note that strtab is a rather special HV. Assumptions are made
380 about not iterating on it, and not adding tie magic to it.
381 It is properly deallocated in perl_destruct() */
384 /* SHAREKEYS tells us that the hash has its keys shared with PL_strtab,
385 * which is not the case with PL_strtab itself */
386 HvSHAREKEYS_off(PL_strtab); /* mandatory */
387 hv_ksplit(PL_strtab, 1 << 11);
390 Zero(PL_sv_consts, SV_CONSTS_COUNT, SV*);
393 # ifdef USE_ENVIRON_ARRAY
394 PL_origenviron = environ;
398 /* Use sysconf(_SC_CLK_TCK) if available, if not
399 * available or if the sysconf() fails, use the HZ.
400 * The HZ if not originally defined has been by now
401 * been defined as CLK_TCK, if available. */
402 #if defined(HAS_SYSCONF) && defined(_SC_CLK_TCK)
403 PL_clocktick = sysconf(_SC_CLK_TCK);
404 if (PL_clocktick <= 0)
408 PL_stashcache = newHV();
410 PL_patchlevel = newSVpvs("v" PERL_VERSION_STRING);
413 if (!PL_mmap_page_size) {
414 #if defined(HAS_SYSCONF) && (defined(_SC_PAGESIZE) || defined(_SC_MMAP_PAGE_SIZE))
416 SETERRNO(0, SS_NORMAL);
418 PL_mmap_page_size = sysconf(_SC_PAGESIZE);
420 PL_mmap_page_size = sysconf(_SC_MMAP_PAGE_SIZE);
422 if ((long) PL_mmap_page_size < 0) {
423 Perl_croak(aTHX_ "panic: sysconf: %s",
424 errno ? Strerror(errno) : "pagesize unknown");
427 #elif defined(HAS_GETPAGESIZE)
428 PL_mmap_page_size = getpagesize();
429 #elif defined(I_SYS_PARAM) && defined(PAGESIZE)
430 PL_mmap_page_size = PAGESIZE; /* compiletime, bad */
432 if (PL_mmap_page_size <= 0)
433 Perl_croak(aTHX_ "panic: bad pagesize %" IVdf,
434 (IV) PL_mmap_page_size);
436 #endif /* HAS_MMAP */
438 #if defined(HAS_TIMES) && defined(PERL_NEED_TIMESBASE)
439 PL_timesbase.tms_utime = 0;
440 PL_timesbase.tms_stime = 0;
441 PL_timesbase.tms_cutime = 0;
442 PL_timesbase.tms_cstime = 0;
445 PL_osname = Perl_savepvn(aTHX_ STR_WITH_LEN(OSNAME));
447 PL_registered_mros = newHV();
448 /* Start with 1 bucket, for DFS. It's unlikely we'll need more. */
449 HvMAX(PL_registered_mros) = 0;
451 PL_XPosix_ptrs[_CC_ASCII] = _new_invlist_C_array(ASCII_invlist);
452 PL_XPosix_ptrs[_CC_ALPHANUMERIC] = _new_invlist_C_array(XPosixAlnum_invlist);
453 PL_XPosix_ptrs[_CC_ALPHA] = _new_invlist_C_array(XPosixAlpha_invlist);
454 PL_XPosix_ptrs[_CC_BLANK] = _new_invlist_C_array(XPosixBlank_invlist);
455 PL_XPosix_ptrs[_CC_CASED] = _new_invlist_C_array(Cased_invlist);
456 PL_XPosix_ptrs[_CC_CNTRL] = _new_invlist_C_array(XPosixCntrl_invlist);
457 PL_XPosix_ptrs[_CC_DIGIT] = _new_invlist_C_array(XPosixDigit_invlist);
458 PL_XPosix_ptrs[_CC_GRAPH] = _new_invlist_C_array(XPosixGraph_invlist);
459 PL_XPosix_ptrs[_CC_LOWER] = _new_invlist_C_array(XPosixLower_invlist);
460 PL_XPosix_ptrs[_CC_PRINT] = _new_invlist_C_array(XPosixPrint_invlist);
461 PL_XPosix_ptrs[_CC_PUNCT] = _new_invlist_C_array(XPosixPunct_invlist);
462 PL_XPosix_ptrs[_CC_SPACE] = _new_invlist_C_array(XPerlSpace_invlist);
463 PL_XPosix_ptrs[_CC_UPPER] = _new_invlist_C_array(XPosixUpper_invlist);
464 PL_XPosix_ptrs[_CC_VERTSPACE] = _new_invlist_C_array(VertSpace_invlist);
465 PL_XPosix_ptrs[_CC_WORDCHAR] = _new_invlist_C_array(XPosixWord_invlist);
466 PL_XPosix_ptrs[_CC_XDIGIT] = _new_invlist_C_array(XPosixXDigit_invlist);
467 PL_GCB_invlist = _new_invlist_C_array(_Perl_GCB_invlist);
468 PL_SB_invlist = _new_invlist_C_array(_Perl_SB_invlist);
469 PL_WB_invlist = _new_invlist_C_array(_Perl_WB_invlist);
470 PL_LB_invlist = _new_invlist_C_array(_Perl_LB_invlist);
471 PL_Assigned_invlist = _new_invlist_C_array(Assigned_invlist);
472 #ifdef HAS_POSIX_2008_LOCALE
473 PL_C_locale_obj = newlocale(LC_ALL_MASK, "C", NULL);
480 =for apidoc nothreadhook
482 Stub that provides thread hook for perl_destruct when there are
489 Perl_nothreadhook(pTHX)
495 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
497 Perl_dump_sv_child(pTHX_ SV *sv)
500 const int sock = PL_dumper_fd;
501 const int debug_fd = PerlIO_fileno(Perl_debug_log);
502 union control_un control;
505 struct cmsghdr *cmptr;
507 unsigned char buffer[256];
509 PERL_ARGS_ASSERT_DUMP_SV_CHILD;
511 if(sock == -1 || debug_fd == -1)
514 PerlIO_flush(Perl_debug_log);
516 /* All these shenanigans are to pass a file descriptor over to our child for
517 it to dump out to. We can't let it hold open the file descriptor when it
518 forks, as the file descriptor it will dump to can turn out to be one end
519 of pipe that some other process will wait on for EOF. (So as it would
520 be open, the wait would be forever.) */
522 msg.msg_control = control.control;
523 msg.msg_controllen = sizeof(control.control);
524 /* We're a connected socket so we don't need a destination */
530 cmptr = CMSG_FIRSTHDR(&msg);
531 cmptr->cmsg_len = CMSG_LEN(sizeof(int));
532 cmptr->cmsg_level = SOL_SOCKET;
533 cmptr->cmsg_type = SCM_RIGHTS;
534 *((int *)CMSG_DATA(cmptr)) = 1;
536 vec[0].iov_base = (void*)&sv;
537 vec[0].iov_len = sizeof(sv);
538 got = sendmsg(sock, &msg, 0);
541 perror("Debug leaking scalars parent sendmsg failed");
544 if(got < sizeof(sv)) {
545 perror("Debug leaking scalars parent short sendmsg");
549 /* Return protocol is
551 unsigned char: length of location string (0 for empty)
552 unsigned char*: string (not terminated)
554 vec[0].iov_base = (void*)&returned_errno;
555 vec[0].iov_len = sizeof(returned_errno);
556 vec[1].iov_base = buffer;
559 got = readv(sock, vec, 2);
562 perror("Debug leaking scalars parent read failed");
563 PerlIO_flush(PerlIO_stderr());
566 if(got < sizeof(returned_errno) + 1) {
567 perror("Debug leaking scalars parent short read");
568 PerlIO_flush(PerlIO_stderr());
573 got = read(sock, buffer + 1, *buffer);
575 perror("Debug leaking scalars parent read 2 failed");
576 PerlIO_flush(PerlIO_stderr());
581 perror("Debug leaking scalars parent short read 2");
582 PerlIO_flush(PerlIO_stderr());
587 if (returned_errno || *buffer) {
588 Perl_warn(aTHX_ "Debug leaking scalars child failed%s%.*s with errno"
589 " %d: %s", (*buffer ? " at " : ""), (int) *buffer, buffer + 1,
590 returned_errno, Strerror(returned_errno));
596 =for apidoc Am|int|perl_destruct|PerlInterpreter *my_perl
598 Shuts down a Perl interpreter. See L<perlembed> for a tutorial.
600 C<my_perl> points to the Perl interpreter. It must have been previously
601 created through the use of L</perl_alloc> and L</perl_construct>. It may
602 have been initialised through L</perl_parse>, and may have been used
603 through L</perl_run> and other means. This function should be called for
604 any Perl interpreter that has been constructed with L</perl_construct>,
605 even if subsequent operations on it failed, for example if L</perl_parse>
606 returned a non-zero value.
608 If the interpreter's C<PL_exit_flags> word has the
609 C<PERL_EXIT_DESTRUCT_END> flag set, then this function will execute code
610 in C<END> blocks before performing the rest of destruction. If it is
611 desired to make any use of the interpreter between L</perl_parse> and
612 L</perl_destruct> other than just calling L</perl_run>, then this flag
613 should be set early on. This matters if L</perl_run> will not be called,
614 or if anything else will be done in addition to calling L</perl_run>.
616 Returns a value be a suitable value to pass to the C library function
617 C<exit> (or to return from C<main>), to serve as an exit code indicating
618 the nature of the way the interpreter terminated. This takes into account
619 any failure of L</perl_parse> and any early exit from L</perl_run>.
620 The exit code is of the type required by the host operating system,
621 so because of differing exit code conventions it is not portable to
622 interpret specific numeric values as having specific meanings.
631 volatile signed char destruct_level; /* see possible values in intrpvar.h */
633 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
638 PERL_ARGS_ASSERT_PERL_DESTRUCT;
640 PERL_UNUSED_ARG(my_perl);
643 assert(PL_scopestack_ix == 1);
645 /* wait for all pseudo-forked children to finish */
646 PERL_WAIT_FOR_CHILDREN;
648 destruct_level = PL_perl_destruct_level;
649 #if defined(DEBUGGING) || defined(PERL_TRACK_MEMPOOL)
651 const char * const s = PerlEnv_getenv("PERL_DESTRUCT_LEVEL");
654 if (strEQ(s, "-1")) { /* Special case: modperl folklore. */
658 if (grok_atoUV(s, &uv, NULL) && uv <= INT_MAX)
664 if (destruct_level < i) destruct_level = i;
666 #ifdef PERL_TRACK_MEMPOOL
667 /* RT #114496, for perl_free */
668 PL_perl_destruct_level = i;
674 if (PL_exit_flags & PERL_EXIT_DESTRUCT_END) {
680 if (PL_endav && !PL_minus_c) {
681 PERL_SET_PHASE(PERL_PHASE_END);
682 call_list(PL_scopestack_ix, PL_endav);
688 assert(PL_scopestack_ix == 0);
690 /* Need to flush since END blocks can produce output */
691 /* flush stdout separately, since we can identify it */
694 PerlIO *stdo = PerlIO_stdout();
695 if (*stdo && PerlIO_flush(stdo)) {
696 PerlIO_restore_errno(stdo);
698 PerlIO_printf(PerlIO_stderr(), "Unable to flush stdout: %s",
707 #ifdef PERL_TRACE_OPS
708 /* dump OP-counts if $ENV{PERL_TRACE_OPS} > 0 */
710 const char * const ptoenv = PerlEnv_getenv("PERL_TRACE_OPS");
713 if (!ptoenv || !Perl_grok_atoUV(ptoenv, &uv, NULL)
717 PerlIO_printf(Perl_debug_log, "Trace of all OPs executed:\n");
718 for (i = 0; i <= OP_max; ++i) {
719 if (PL_op_exec_cnt[i])
720 PerlIO_printf(Perl_debug_log, " %s: %" UVuf "\n", PL_op_name[i], PL_op_exec_cnt[i]);
722 /* Utility slot for easily doing little tracing experiments in the runloop: */
723 if (PL_op_exec_cnt[OP_max+1] != 0)
724 PerlIO_printf(Perl_debug_log, " SPECIAL: %" UVuf "\n", PL_op_exec_cnt[OP_max+1]);
725 PerlIO_printf(Perl_debug_log, "\n");
730 if (PL_threadhook(aTHX)) {
731 /* Threads hook has vetoed further cleanup */
732 PL_veto_cleanup = TRUE;
736 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
737 if (destruct_level != 0) {
738 /* Fork here to create a child. Our child's job is to preserve the
739 state of scalars prior to destruction, so that we can instruct it
740 to dump any scalars that we later find have leaked.
741 There's no subtlety in this code - it assumes POSIX, and it doesn't
745 if(socketpair(AF_UNIX, SOCK_STREAM, 0, fd)) {
746 perror("Debug leaking scalars socketpair failed");
752 perror("Debug leaking scalars fork failed");
756 /* We are the child */
757 const int sock = fd[1];
758 const int debug_fd = PerlIO_fileno(Perl_debug_log);
761 /* Our success message is an integer 0, and a char 0 */
762 static const char success[sizeof(int) + 1] = {0};
766 /* We need to close all other file descriptors otherwise we end up
767 with interesting hangs, where the parent closes its end of a
768 pipe, and sits waiting for (another) child to terminate. Only
769 that child never terminates, because it never gets EOF, because
770 we also have the far end of the pipe open. We even need to
771 close the debugging fd, because sometimes it happens to be one
772 end of a pipe, and a process is waiting on the other end for
773 EOF. Normally it would be closed at some point earlier in
774 destruction, but if we happen to cause the pipe to remain open,
775 EOF never occurs, and we get an infinite hang. Hence all the
776 games to pass in a file descriptor if it's actually needed. */
778 f = sysconf(_SC_OPEN_MAX);
780 where = "sysconf failed";
791 union control_un control;
794 struct cmsghdr *cmptr;
798 msg.msg_control = control.control;
799 msg.msg_controllen = sizeof(control.control);
800 /* We're a connected socket so we don't need a source */
804 msg.msg_iovlen = C_ARRAY_LENGTH(vec);
806 vec[0].iov_base = (void*)⌖
807 vec[0].iov_len = sizeof(target);
809 got = recvmsg(sock, &msg, 0);
814 where = "recv failed";
817 if(got < sizeof(target)) {
818 where = "short recv";
822 if(!(cmptr = CMSG_FIRSTHDR(&msg))) {
826 if(cmptr->cmsg_len != CMSG_LEN(sizeof(int))) {
827 where = "wrong cmsg_len";
830 if(cmptr->cmsg_level != SOL_SOCKET) {
831 where = "wrong cmsg_level";
834 if(cmptr->cmsg_type != SCM_RIGHTS) {
835 where = "wrong cmsg_type";
839 got_fd = *(int*)CMSG_DATA(cmptr);
840 /* For our last little bit of trickery, put the file descriptor
841 back into Perl_debug_log, as if we never actually closed it
843 if(got_fd != debug_fd) {
844 if (dup2(got_fd, debug_fd) == -1) {
851 PerlIO_flush(Perl_debug_log);
853 got = write(sock, &success, sizeof(success));
856 where = "write failed";
859 if(got < sizeof(success)) {
860 where = "short write";
867 int send_errno = errno;
868 unsigned char length = (unsigned char) strlen(where);
869 struct iovec failure[3] = {
870 {(void*)&send_errno, sizeof(send_errno)},
872 {(void*)where, length}
874 int got = writev(sock, failure, 3);
875 /* Bad news travels fast. Faster than data. We'll get a SIGPIPE
876 in the parent if we try to read from the socketpair after the
877 child has exited, even if there was data to read.
878 So sleep a bit to give the parent a fighting chance of
881 _exit((got == -1) ? errno : 0);
885 PL_dumper_fd = fd[0];
890 /* We must account for everything. */
892 /* Destroy the main CV and syntax tree */
893 /* Set PL_curcop now, because destroying ops can cause new SVs
894 to be generated in Perl_pad_swipe, and when running with
895 -DDEBUG_LEAKING_SCALARS they expect PL_curcop to point to a valid
896 op from which the filename structure member is copied. */
897 PL_curcop = &PL_compiling;
899 /* ensure comppad/curpad to refer to main's pad */
900 if (CvPADLIST(PL_main_cv)) {
901 PAD_SET_CUR_NOSAVE(CvPADLIST(PL_main_cv), 1);
902 PL_comppad_name = PadlistNAMES(CvPADLIST(PL_main_cv));
904 op_free(PL_main_root);
907 PL_main_start = NULL;
908 /* note that PL_main_cv isn't usually actually freed at this point,
909 * due to the CvOUTSIDE refs from subs compiled within it. It will
910 * get freed once all the subs are freed in sv_clean_all(), for
911 * destruct_level > 0 */
912 SvREFCNT_dec(PL_main_cv);
914 PERL_SET_PHASE(PERL_PHASE_DESTRUCT);
916 /* Tell PerlIO we are about to tear things apart in case
917 we have layers which are using resources that should
921 PerlIO_destruct(aTHX);
924 * Try to destruct global references. We do this first so that the
925 * destructors and destructees still exist. Some sv's might remain.
926 * Non-referenced objects are on their own.
930 /* unhook hooks which will soon be, or use, destroyed data */
931 SvREFCNT_dec(PL_warnhook);
933 SvREFCNT_dec(PL_diehook);
936 /* call exit list functions */
937 while (PL_exitlistlen-- > 0)
938 PL_exitlist[PL_exitlistlen].fn(aTHX_ PL_exitlist[PL_exitlistlen].ptr);
940 Safefree(PL_exitlist);
945 SvREFCNT_dec(PL_registered_mros);
947 /* jettison our possibly duplicated environment */
948 /* if PERL_USE_SAFE_PUTENV is defined environ will not have been copied
949 * so we certainly shouldn't free it here
952 #if defined(USE_ENVIRON_ARRAY) && !defined(PERL_USE_SAFE_PUTENV)
953 if (environ != PL_origenviron && !PL_use_safe_putenv
955 /* only main thread can free environ[0] contents */
956 && PL_curinterp == aTHX
962 for (i = 0; environ[i]; i++)
963 safesysfree(environ[i]);
965 /* Must use safesysfree() when working with environ. */
966 safesysfree(environ);
968 environ = PL_origenviron;
971 #endif /* !PERL_MICRO */
973 if (destruct_level == 0) {
975 DEBUG_P(debprofdump());
977 #if defined(PERLIO_LAYERS)
978 /* No more IO - including error messages ! */
979 PerlIO_cleanup(aTHX);
982 CopFILE_free(&PL_compiling);
984 /* The exit() function will do everything that needs doing. */
988 /* Below, do clean up for when PERL_DESTRUCT_LEVEL is not 0 */
991 /* the syntax tree is shared between clones
992 * so op_free(PL_main_root) only ReREFCNT_dec's
993 * REGEXPs in the parent interpreter
994 * we need to manually ReREFCNT_dec for the clones
997 I32 i = AvFILLp(PL_regex_padav);
998 SV **ary = AvARRAY(PL_regex_padav);
1001 SvREFCNT_dec(ary[i]);
1002 ary[i] = &PL_sv_undef;
1008 SvREFCNT_dec(MUTABLE_SV(PL_stashcache));
1009 PL_stashcache = NULL;
1011 /* loosen bonds of global variables */
1013 /* XXX can PL_parser still be non-null here? */
1014 if(PL_parser && PL_parser->rsfp) {
1015 (void)PerlIO_close(PL_parser->rsfp);
1016 PL_parser->rsfp = NULL;
1020 Safefree(PL_splitstr);
1030 PL_doswitches = FALSE;
1031 PL_dowarn = G_WARN_OFF;
1032 #ifdef PERL_SAWAMPERSAND
1033 PL_sawampersand = 0; /* must save all match strings */
1037 Safefree(PL_inplace);
1039 SvREFCNT_dec(PL_patchlevel);
1042 SvREFCNT_dec(PL_e_script);
1048 /* magical thingies */
1050 SvREFCNT_dec(PL_ofsgv); /* *, */
1053 SvREFCNT_dec(PL_ors_sv); /* $\ */
1056 SvREFCNT_dec(PL_rs); /* $/ */
1059 Safefree(PL_osname); /* $^O */
1062 SvREFCNT_dec(PL_statname);
1066 /* defgv, aka *_ should be taken care of elsewhere */
1069 Safefree(PL_efloatbuf);
1070 PL_efloatbuf = NULL;
1073 /* startup and shutdown function lists */
1074 SvREFCNT_dec(PL_beginav);
1075 SvREFCNT_dec(PL_beginav_save);
1076 SvREFCNT_dec(PL_endav);
1077 SvREFCNT_dec(PL_checkav);
1078 SvREFCNT_dec(PL_checkav_save);
1079 SvREFCNT_dec(PL_unitcheckav);
1080 SvREFCNT_dec(PL_unitcheckav_save);
1081 SvREFCNT_dec(PL_initav);
1083 PL_beginav_save = NULL;
1086 PL_checkav_save = NULL;
1087 PL_unitcheckav = NULL;
1088 PL_unitcheckav_save = NULL;
1091 /* shortcuts just get cleared */
1094 PL_argvoutgv = NULL;
1097 PL_last_in_gv = NULL;
1108 SvREFCNT_dec(PL_envgv);
1109 SvREFCNT_dec(PL_incgv);
1110 SvREFCNT_dec(PL_argvgv);
1111 SvREFCNT_dec(PL_replgv);
1112 SvREFCNT_dec(PL_DBgv);
1113 SvREFCNT_dec(PL_DBline);
1114 SvREFCNT_dec(PL_DBsub);
1123 SvREFCNT_dec(PL_argvout_stack);
1124 PL_argvout_stack = NULL;
1126 SvREFCNT_dec(PL_modglobal);
1127 PL_modglobal = NULL;
1128 SvREFCNT_dec(PL_preambleav);
1129 PL_preambleav = NULL;
1130 SvREFCNT_dec(PL_subname);
1132 #ifdef PERL_USES_PL_PIDSTATUS
1133 SvREFCNT_dec(PL_pidstatus);
1134 PL_pidstatus = NULL;
1136 SvREFCNT_dec(PL_toptarget);
1137 PL_toptarget = NULL;
1138 SvREFCNT_dec(PL_bodytarget);
1139 PL_bodytarget = NULL;
1140 PL_formtarget = NULL;
1142 /* free locale stuff */
1143 #ifdef USE_LOCALE_COLLATE
1144 Safefree(PL_collation_name);
1145 PL_collation_name = NULL;
1148 #ifdef USE_LOCALE_NUMERIC
1149 Safefree(PL_numeric_name);
1150 PL_numeric_name = NULL;
1151 SvREFCNT_dec(PL_numeric_radix_sv);
1152 PL_numeric_radix_sv = NULL;
1155 if (PL_langinfo_buf) {
1156 Safefree(PL_langinfo_buf);
1157 PL_langinfo_buf = NULL;
1160 /* clear character classes */
1161 for (i = 0; i < POSIX_SWASH_COUNT; i++) {
1162 SvREFCNT_dec(PL_utf8_swash_ptrs[i]);
1163 PL_utf8_swash_ptrs[i] = NULL;
1165 SvREFCNT_dec(PL_utf8_mark);
1166 SvREFCNT_dec(PL_utf8_toupper);
1167 SvREFCNT_dec(PL_utf8_totitle);
1168 SvREFCNT_dec(PL_utf8_tolower);
1169 SvREFCNT_dec(PL_utf8_tofold);
1170 SvREFCNT_dec(PL_utf8_idstart);
1171 SvREFCNT_dec(PL_utf8_idcont);
1172 SvREFCNT_dec(PL_utf8_foldable);
1173 SvREFCNT_dec(PL_utf8_foldclosures);
1174 SvREFCNT_dec(PL_AboveLatin1);
1175 SvREFCNT_dec(PL_InBitmap);
1176 SvREFCNT_dec(PL_UpperLatin1);
1177 SvREFCNT_dec(PL_Latin1);
1178 SvREFCNT_dec(PL_NonL1NonFinalFold);
1179 SvREFCNT_dec(PL_HasMultiCharFold);
1180 #ifdef USE_LOCALE_CTYPE
1181 SvREFCNT_dec(PL_warn_locale);
1183 PL_utf8_mark = NULL;
1184 PL_utf8_toupper = NULL;
1185 PL_utf8_totitle = NULL;
1186 PL_utf8_tolower = NULL;
1187 PL_utf8_tofold = NULL;
1188 PL_utf8_idstart = NULL;
1189 PL_utf8_idcont = NULL;
1190 PL_utf8_foldclosures = NULL;
1191 PL_AboveLatin1 = NULL;
1193 PL_HasMultiCharFold = NULL;
1194 #ifdef USE_LOCALE_CTYPE
1195 PL_warn_locale = NULL;
1198 PL_NonL1NonFinalFold = NULL;
1199 PL_UpperLatin1 = NULL;
1200 for (i = 0; i < POSIX_CC_COUNT; i++) {
1201 SvREFCNT_dec(PL_XPosix_ptrs[i]);
1202 PL_XPosix_ptrs[i] = NULL;
1204 PL_GCB_invlist = NULL;
1205 PL_LB_invlist = NULL;
1206 PL_SB_invlist = NULL;
1207 PL_WB_invlist = NULL;
1208 PL_Assigned_invlist = NULL;
1210 if (!specialWARN(PL_compiling.cop_warnings))
1211 PerlMemShared_free(PL_compiling.cop_warnings);
1212 PL_compiling.cop_warnings = NULL;
1213 cophh_free(CopHINTHASH_get(&PL_compiling));
1214 CopHINTHASH_set(&PL_compiling, cophh_new_empty());
1215 CopFILE_free(&PL_compiling);
1217 /* Prepare to destruct main symbol table. */
1220 /* break ref loop *:: <=> %:: */
1221 (void)hv_deletes(hv, "main::", G_DISCARD);
1224 SvREFCNT_dec(PL_curstname);
1225 PL_curstname = NULL;
1227 /* clear queued errors */
1228 SvREFCNT_dec(PL_errors);
1231 SvREFCNT_dec(PL_isarev);
1234 if (destruct_level >= 2) {
1235 if (PL_scopestack_ix != 0)
1236 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
1237 "Unbalanced scopes: %ld more ENTERs than LEAVEs\n",
1238 (long)PL_scopestack_ix);
1239 if (PL_savestack_ix != 0)
1240 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
1241 "Unbalanced saves: %ld more saves than restores\n",
1242 (long)PL_savestack_ix);
1243 if (PL_tmps_floor != -1)
1244 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced tmps: %ld more allocs than frees\n",
1245 (long)PL_tmps_floor + 1);
1246 if (cxstack_ix != -1)
1247 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced context: %ld more PUSHes than POPs\n",
1248 (long)cxstack_ix + 1);
1252 SvREFCNT_dec(PL_regex_padav);
1253 PL_regex_padav = NULL;
1254 PL_regex_pad = NULL;
1257 #ifdef PERL_IMPLICIT_CONTEXT
1258 /* the entries in this list are allocated via SV PVX's, so get freed
1259 * in sv_clean_all */
1260 Safefree(PL_my_cxt_list);
1263 /* Now absolutely destruct everything, somehow or other, loops or no. */
1265 /* the 2 is for PL_fdpid and PL_strtab */
1266 while (sv_clean_all() > 2)
1270 Safefree(PL_stashpad); /* must come after sv_clean_all */
1273 AvREAL_off(PL_fdpid); /* no surviving entries */
1274 SvREFCNT_dec(PL_fdpid); /* needed in io_close() */
1277 #ifdef HAVE_INTERP_INTERN
1281 /* constant strings */
1282 for (i = 0; i < SV_CONSTS_COUNT; i++) {
1283 SvREFCNT_dec(PL_sv_consts[i]);
1284 PL_sv_consts[i] = NULL;
1287 /* Destruct the global string table. */
1289 /* Yell and reset the HeVAL() slots that are still holding refcounts,
1290 * so that sv_free() won't fail on them.
1291 * Now that the global string table is using a single hunk of memory
1292 * for both HE and HEK, we either need to explicitly unshare it the
1293 * correct way, or actually free things here.
1296 const I32 max = HvMAX(PL_strtab);
1297 HE * const * const array = HvARRAY(PL_strtab);
1298 HE *hent = array[0];
1301 if (hent && ckWARN_d(WARN_INTERNAL)) {
1302 HE * const next = HeNEXT(hent);
1303 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
1304 "Unbalanced string table refcount: (%ld) for \"%s\"",
1305 (long)hent->he_valu.hent_refcount, HeKEY(hent));
1312 hent = array[riter];
1317 HvARRAY(PL_strtab) = 0;
1318 HvTOTALKEYS(PL_strtab) = 0;
1320 SvREFCNT_dec(PL_strtab);
1323 /* free the pointer tables used for cloning */
1324 ptr_table_free(PL_ptr_table);
1325 PL_ptr_table = (PTR_TBL_t*)NULL;
1328 /* free special SVs */
1330 SvREFCNT(&PL_sv_yes) = 0;
1331 sv_clear(&PL_sv_yes);
1332 SvANY(&PL_sv_yes) = NULL;
1333 SvFLAGS(&PL_sv_yes) = 0;
1335 SvREFCNT(&PL_sv_no) = 0;
1336 sv_clear(&PL_sv_no);
1337 SvANY(&PL_sv_no) = NULL;
1338 SvFLAGS(&PL_sv_no) = 0;
1340 SvREFCNT(&PL_sv_zero) = 0;
1341 sv_clear(&PL_sv_zero);
1342 SvANY(&PL_sv_zero) = NULL;
1343 SvFLAGS(&PL_sv_zero) = 0;
1347 for (i=0; i<=2; i++) {
1348 SvREFCNT(PERL_DEBUG_PAD(i)) = 0;
1349 sv_clear(PERL_DEBUG_PAD(i));
1350 SvANY(PERL_DEBUG_PAD(i)) = NULL;
1351 SvFLAGS(PERL_DEBUG_PAD(i)) = 0;
1355 if (PL_sv_count != 0 && ckWARN_d(WARN_INTERNAL))
1356 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Scalars leaked: %ld\n", (long)PL_sv_count);
1358 #ifdef DEBUG_LEAKING_SCALARS
1359 if (PL_sv_count != 0) {
1364 for (sva = PL_sv_arenaroot; sva; sva = MUTABLE_SV(SvANY(sva))) {
1365 svend = &sva[SvREFCNT(sva)];
1366 for (sv = sva + 1; sv < svend; ++sv) {
1367 if (SvTYPE(sv) != (svtype)SVTYPEMASK) {
1368 PerlIO_printf(Perl_debug_log, "leaked: sv=0x%p"
1370 " refcnt=%"UVuf pTHX__FORMAT "\n"
1371 "\tallocated at %s:%d %s %s (parent 0x%" UVxf ");"
1372 "serial %" UVuf "\n",
1373 (void*)sv, (UV)sv->sv_flags, (UV)sv->sv_refcnt
1375 sv->sv_debug_file ? sv->sv_debug_file : "(unknown)",
1377 sv->sv_debug_inpad ? "for" : "by",
1378 sv->sv_debug_optype ?
1379 PL_op_name[sv->sv_debug_optype]: "(none)",
1380 PTR2UV(sv->sv_debug_parent),
1383 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1384 Perl_dump_sv_child(aTHX_ sv);
1390 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1394 /* Wait for up to 4 seconds for child to terminate.
1395 This seems to be the least effort way of timing out on reaping
1397 struct timeval waitfor = {4, 0};
1398 int sock = PL_dumper_fd;
1402 FD_SET(sock, &rset);
1403 select(sock + 1, &rset, NULL, NULL, &waitfor);
1404 waitpid(child, &status, WNOHANG);
1409 #ifdef DEBUG_LEAKING_SCALARS_ABORT
1415 #if defined(PERLIO_LAYERS)
1416 /* No more IO - including error messages ! */
1417 PerlIO_cleanup(aTHX);
1420 /* sv_undef needs to stay immortal until after PerlIO_cleanup
1421 as currently layers use it rather than NULL as a marker
1422 for no arg - and will try and SvREFCNT_dec it.
1424 SvREFCNT(&PL_sv_undef) = 0;
1425 SvREADONLY_off(&PL_sv_undef);
1427 Safefree(PL_origfilename);
1428 PL_origfilename = NULL;
1429 Safefree(PL_reg_curpm);
1430 free_tied_hv_pool();
1431 Safefree(PL_op_mask);
1432 Safefree(PL_psig_name);
1433 PL_psig_name = (SV**)NULL;
1434 PL_psig_ptr = (SV**)NULL;
1436 /* We need to NULL PL_psig_pend first, so that
1437 signal handlers know not to use it */
1438 int *psig_save = PL_psig_pend;
1439 PL_psig_pend = (int*)NULL;
1440 Safefree(psig_save);
1443 TAINTING_set(FALSE);
1444 TAINT_WARN_set(FALSE);
1445 PL_hints = 0; /* Reset hints. Should hints be per-interpreter ? */
1447 DEBUG_P(debprofdump());
1451 #ifdef USE_REENTRANT_API
1452 Perl_reentrant_free(aTHX);
1455 /* These all point to HVs that are about to be blown away.
1456 Code in core and on CPAN assumes that if the interpreter is re-started
1457 that they will be cleanly NULL or pointing to a valid HV. */
1458 PL_custom_op_names = NULL;
1459 PL_custom_op_descs = NULL;
1460 PL_custom_ops = NULL;
1464 while (PL_regmatch_slab) {
1465 regmatch_slab *s = PL_regmatch_slab;
1466 PL_regmatch_slab = PL_regmatch_slab->next;
1470 /* As the absolutely last thing, free the non-arena SV for mess() */
1473 /* we know that type == SVt_PVMG */
1475 /* it could have accumulated taint magic */
1478 for (mg = SvMAGIC(PL_mess_sv); mg; mg = moremagic) {
1479 moremagic = mg->mg_moremagic;
1480 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global
1482 Safefree(mg->mg_ptr);
1486 /* we know that type >= SVt_PV */
1487 SvPV_free(PL_mess_sv);
1488 Safefree(SvANY(PL_mess_sv));
1489 Safefree(PL_mess_sv);
1496 =for apidoc perl_free
1498 Releases a Perl interpreter. See L<perlembed>.
1508 PERL_ARGS_ASSERT_PERL_FREE;
1510 if (PL_veto_cleanup)
1513 #ifdef PERL_TRACK_MEMPOOL
1516 * Don't free thread memory if PERL_DESTRUCT_LEVEL is set to a non-zero
1517 * value as we're probably hunting memory leaks then
1519 if (PL_perl_destruct_level == 0) {
1520 const U32 old_debug = PL_debug;
1521 /* Emulate the PerlHost behaviour of free()ing all memory allocated in this
1522 thread at thread exit. */
1524 PerlIO_puts(Perl_debug_log, "Disabling memory debugging as we "
1525 "free this thread's memory\n");
1526 PL_debug &= ~ DEBUG_m_FLAG;
1528 while(aTHXx->Imemory_debug_header.next != &(aTHXx->Imemory_debug_header)){
1529 char * next = (char *)(aTHXx->Imemory_debug_header.next);
1530 Malloc_t ptr = PERL_MEMORY_DEBUG_HEADER_SIZE + next;
1533 PL_debug = old_debug;
1538 #if defined(WIN32) || defined(NETWARE)
1539 # if defined(PERL_IMPLICIT_SYS)
1542 void *host = nw_internal_host;
1543 PerlMem_free(aTHXx);
1544 nw_delete_internal_host(host);
1546 void *host = w32_internal_host;
1547 PerlMem_free(aTHXx);
1548 win32_delete_internal_host(host);
1552 PerlMem_free(aTHXx);
1555 PerlMem_free(aTHXx);
1559 #if defined(USE_ITHREADS)
1560 /* provide destructors to clean up the thread key when libperl is unloaded */
1561 #ifndef WIN32 /* handled during DLL_PROCESS_DETACH in win32/perllib.c */
1563 #if defined(__hpux) && !(defined(__ux_version) && __ux_version <= 1020) && !defined(__GNUC__)
1564 #pragma fini "perl_fini"
1565 #elif defined(__sun) && !defined(__GNUC__)
1566 #pragma fini (perl_fini)
1570 #if defined(__GNUC__)
1571 __attribute__((destructor))
1577 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
1580 PL_curinterp && !PL_veto_cleanup)
1585 #endif /* THREADS */
1588 Perl_call_atexit(pTHX_ ATEXIT_t fn, void *ptr)
1590 Renew(PL_exitlist, PL_exitlistlen+1, PerlExitListEntry);
1591 PL_exitlist[PL_exitlistlen].fn = fn;
1592 PL_exitlist[PL_exitlistlen].ptr = ptr;
1597 =for apidoc Am|int|perl_parse|PerlInterpreter *my_perl|XSINIT_t xsinit|int argc|char **argv|char **env
1599 Tells a Perl interpreter to parse a Perl script. This performs most
1600 of the initialisation of a Perl interpreter. See L<perlembed> for
1603 C<my_perl> points to the Perl interpreter that is to parse the script.
1604 It must have been previously created through the use of L</perl_alloc>
1605 and L</perl_construct>. C<xsinit> points to a callback function that
1606 will be called to set up the ability for this Perl interpreter to load
1607 XS extensions, or may be null to perform no such setup.
1609 C<argc> and C<argv> supply a set of command-line arguments to the Perl
1610 interpreter, as would normally be passed to the C<main> function of
1611 a C program. C<argv[argc]> must be null. These arguments are where
1612 the script to parse is specified, either by naming a script file or by
1613 providing a script in a C<-e> option.
1615 C<env> specifies a set of environment variables that will be used by
1616 this Perl interpreter. If non-null, it must point to a null-terminated
1617 array of environment strings. If null, the Perl interpreter will use
1618 the environment supplied by the C<environ> global variable.
1620 This function initialises the interpreter, and parses and compiles the
1621 script specified by the command-line arguments. This includes executing
1622 code in C<BEGIN>, C<UNITCHECK>, and C<CHECK> blocks. It does not execute
1623 C<INIT> blocks or the main program.
1625 Returns an integer of slightly tricky interpretation. The correct
1626 use of the return value is as a truth value indicating whether there
1627 was a failure in initialisation. If zero is returned, this indicates
1628 that initialisation was successful, and it is safe to proceed to call
1629 L</perl_run> and make other use of it. If a non-zero value is returned,
1630 this indicates some problem that means the interpreter wants to terminate.
1631 The interpreter should not be just abandoned upon such failure; the caller
1632 should proceed to shut the interpreter down cleanly with L</perl_destruct>
1633 and free it with L</perl_free>.
1635 For historical reasons, the non-zero return value also attempts to
1636 be a suitable value to pass to the C library function C<exit> (or to
1637 return from C<main>), to serve as an exit code indicating the nature
1638 of the way initialisation terminated. However, this isn't portable,
1639 due to differing exit code conventions. An attempt is made to return
1640 an exit code of the type required by the host operating system, but
1641 because it is constrained to be non-zero, it is not necessarily possible
1642 to indicate every type of exit. It is only reliable on Unix, where a
1643 zero exit code can be augmented with a set bit that will be ignored.
1644 In any case, this function is not the correct place to acquire an exit
1645 code: one should get that from L</perl_destruct>.
1650 #define SET_CURSTASH(newstash) \
1651 if (PL_curstash != newstash) { \
1652 SvREFCNT_dec(PL_curstash); \
1653 PL_curstash = (HV *)SvREFCNT_inc(newstash); \
1657 perl_parse(pTHXx_ XSINIT_t xsinit, int argc, char **argv, char **env)
1664 PERL_ARGS_ASSERT_PERL_PARSE;
1665 #ifndef MULTIPLICITY
1666 PERL_UNUSED_ARG(my_perl);
1668 #if (defined(USE_HASH_SEED) || defined(USE_HASH_SEED_DEBUG)) && !defined(NO_PERL_HASH_SEED_DEBUG)
1670 const char * const s = PerlEnv_getenv("PERL_HASH_SEED_DEBUG");
1672 if (s && strEQ(s, "1")) {
1673 const unsigned char *seed= PERL_HASH_SEED;
1674 const unsigned char *seed_end= PERL_HASH_SEED + PERL_HASH_SEED_BYTES;
1675 PerlIO_printf(Perl_debug_log, "HASH_FUNCTION = %s HASH_SEED = 0x", PERL_HASH_FUNC);
1676 while (seed < seed_end) {
1677 PerlIO_printf(Perl_debug_log, "%02x", *seed++);
1679 #ifdef PERL_HASH_RANDOMIZE_KEYS
1680 PerlIO_printf(Perl_debug_log, " PERTURB_KEYS = %d (%s)",
1681 PL_HASH_RAND_BITS_ENABLED,
1682 PL_HASH_RAND_BITS_ENABLED == 0 ? "NO" : PL_HASH_RAND_BITS_ENABLED == 1 ? "RANDOM" : "DETERMINISTIC");
1684 PerlIO_printf(Perl_debug_log, "\n");
1687 #endif /* #if (defined(USE_HASH_SEED) ... */
1691 struct NameTranslationInfo nti;
1692 __translate_amiga_to_unix_path_name(&argv[0],&nti);
1699 if (PL_origalen != 0) {
1700 PL_origalen = 1; /* don't use old PL_origalen if perl_parse() is called again */
1703 /* Set PL_origalen be the sum of the contiguous argv[]
1704 * elements plus the size of the env in case that it is
1705 * contiguous with the argv[]. This is used in mg.c:Perl_magic_set()
1706 * as the maximum modifiable length of $0. In the worst case
1707 * the area we are able to modify is limited to the size of
1708 * the original argv[0]. (See below for 'contiguous', though.)
1710 const char *s = NULL;
1711 const UV mask = ~(UV)(PTRSIZE-1);
1712 /* Do the mask check only if the args seem like aligned. */
1714 (mask < ~(UV)0) && ((PTR2UV(argv[0]) & mask) == PTR2UV(argv[0]));
1716 /* See if all the arguments are contiguous in memory. Note
1717 * that 'contiguous' is a loose term because some platforms
1718 * align the argv[] and the envp[]. If the arguments look
1719 * like non-aligned, assume that they are 'strictly' or
1720 * 'traditionally' contiguous. If the arguments look like
1721 * aligned, we just check that they are within aligned
1722 * PTRSIZE bytes. As long as no system has something bizarre
1723 * like the argv[] interleaved with some other data, we are
1724 * fine. (Did I just evoke Murphy's Law?) --jhi */
1725 if (PL_origargv && PL_origargc >= 1 && (s = PL_origargv[0])) {
1728 for (i = 1; i < PL_origargc; i++) {
1729 if ((PL_origargv[i] == s + 1
1731 || PL_origargv[i] == s + 2
1736 (PL_origargv[i] > s &&
1738 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1749 #ifndef PERL_USE_SAFE_PUTENV
1750 /* Can we grab env area too to be used as the area for $0? */
1751 if (s && PL_origenviron && !PL_use_safe_putenv) {
1752 if ((PL_origenviron[0] == s + 1)
1755 (PL_origenviron[0] > s &&
1756 PL_origenviron[0] <=
1757 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1761 #ifndef OS2 /* ENVIRON is read by the kernel too. */
1762 s = PL_origenviron[0];
1765 my_setenv("NoNe SuCh", NULL);
1766 /* Force copy of environment. */
1767 for (i = 1; PL_origenviron[i]; i++) {
1768 if (PL_origenviron[i] == s + 1
1771 (PL_origenviron[i] > s &&
1772 PL_origenviron[i] <=
1773 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1776 s = PL_origenviron[i];
1784 #endif /* !defined(PERL_USE_SAFE_PUTENV) */
1786 PL_origalen = s ? s - PL_origargv[0] + 1 : 0;
1791 /* Come here if running an undumped a.out. */
1793 PL_origfilename = savepv(argv[0]);
1794 PL_do_undump = FALSE;
1795 cxstack_ix = -1; /* start label stack again */
1797 assert (!TAINT_get);
1801 init_postdump_symbols(argc,argv,env);
1806 op_free(PL_main_root);
1807 PL_main_root = NULL;
1809 PL_main_start = NULL;
1810 SvREFCNT_dec(PL_main_cv);
1814 oldscope = PL_scopestack_ix;
1815 PL_dowarn = G_WARN_OFF;
1820 parse_body(env,xsinit);
1821 if (PL_unitcheckav) {
1822 call_list(oldscope, PL_unitcheckav);
1825 PERL_SET_PHASE(PERL_PHASE_CHECK);
1826 call_list(oldscope, PL_checkav);
1834 /* my_exit() was called */
1835 while (PL_scopestack_ix > oldscope)
1838 SET_CURSTASH(PL_defstash);
1839 if (PL_unitcheckav) {
1840 call_list(oldscope, PL_unitcheckav);
1843 PERL_SET_PHASE(PERL_PHASE_CHECK);
1844 call_list(oldscope, PL_checkav);
1847 if (ret == 0) ret = 0x100;
1850 PerlIO_printf(Perl_error_log, "panic: top_env\n");
1858 /* This needs to stay in perl.c, as perl.c is compiled with different flags for
1859 miniperl, and we need to see those flags reflected in the values here. */
1861 /* What this returns is subject to change. Use the public interface in Config.
1864 S_Internals_V(pTHX_ CV *cv)
1867 #ifdef LOCAL_PATCH_COUNT
1868 const int local_patch_count = LOCAL_PATCH_COUNT;
1870 const int local_patch_count = 0;
1872 const int entries = 3 + local_patch_count;
1874 static const char non_bincompat_options[] =
1881 # ifdef NO_HASH_SEED
1884 # ifdef NO_TAINT_SUPPORT
1887 # ifdef PERL_BOOL_AS_CHAR
1888 " PERL_BOOL_AS_CHAR"
1890 # ifdef PERL_COPY_ON_WRITE
1891 " PERL_COPY_ON_WRITE"
1893 # ifdef PERL_DISABLE_PMC
1896 # ifdef PERL_DONT_CREATE_GVSV
1897 " PERL_DONT_CREATE_GVSV"
1899 # ifdef PERL_EXTERNAL_GLOB
1900 " PERL_EXTERNAL_GLOB"
1902 # ifdef PERL_HASH_FUNC_SIPHASH
1903 " PERL_HASH_FUNC_SIPHASH"
1905 # ifdef PERL_HASH_FUNC_SDBM
1906 " PERL_HASH_FUNC_SDBM"
1908 # ifdef PERL_HASH_FUNC_DJB2
1909 " PERL_HASH_FUNC_DJB2"
1911 # ifdef PERL_HASH_FUNC_SUPERFAST
1912 " PERL_HASH_FUNC_SUPERFAST"
1914 # ifdef PERL_HASH_FUNC_MURMUR3
1915 " PERL_HASH_FUNC_MURMUR3"
1917 # ifdef PERL_HASH_FUNC_ONE_AT_A_TIME
1918 " PERL_HASH_FUNC_ONE_AT_A_TIME"
1920 # ifdef PERL_HASH_FUNC_ONE_AT_A_TIME_HARD
1921 " PERL_HASH_FUNC_ONE_AT_A_TIME_HARD"
1923 # ifdef PERL_HASH_FUNC_ONE_AT_A_TIME_OLD
1924 " PERL_HASH_FUNC_ONE_AT_A_TIME_OLD"
1926 # ifdef PERL_IS_MINIPERL
1929 # ifdef PERL_MALLOC_WRAP
1932 # ifdef PERL_MEM_LOG
1935 # ifdef PERL_MEM_LOG_NOIMPL
1936 " PERL_MEM_LOG_NOIMPL"
1938 # ifdef PERL_OP_PARENT
1941 # ifdef PERL_PERTURB_KEYS_DETERMINISTIC
1942 " PERL_PERTURB_KEYS_DETERMINISTIC"
1944 # ifdef PERL_PERTURB_KEYS_DISABLED
1945 " PERL_PERTURB_KEYS_DISABLED"
1947 # ifdef PERL_PERTURB_KEYS_RANDOM
1948 " PERL_PERTURB_KEYS_RANDOM"
1950 # ifdef PERL_PRESERVE_IVUV
1951 " PERL_PRESERVE_IVUV"
1953 # ifdef PERL_RELOCATABLE_INCPUSH
1954 " PERL_RELOCATABLE_INCPUSH"
1956 # ifdef PERL_USE_DEVEL
1959 # ifdef PERL_USE_SAFE_PUTENV
1960 " PERL_USE_SAFE_PUTENV"
1962 # ifdef SILENT_NO_TAINT_SUPPORT
1963 " SILENT_NO_TAINT_SUPPORT"
1965 # ifdef UNLINK_ALL_VERSIONS
1966 " UNLINK_ALL_VERSIONS"
1968 # ifdef USE_ATTRIBUTES_FOR_PERLIO
1969 " USE_ATTRIBUTES_FOR_PERLIO"
1971 # ifdef USE_FAST_STDIO
1977 # ifdef USE_LOCALE_CTYPE
1980 # ifdef WIN32_NO_REGISTRY
1983 # ifdef USE_PERL_ATOF
1986 # ifdef USE_SITECUSTOMIZE
1987 " USE_SITECUSTOMIZE"
1990 PERL_UNUSED_ARG(cv);
1991 PERL_UNUSED_VAR(items);
1993 EXTEND(SP, entries);
1995 PUSHs(sv_2mortal(newSVpv(PL_bincompat_options, 0)));
1996 PUSHs(Perl_newSVpvn_flags(aTHX_ non_bincompat_options,
1997 sizeof(non_bincompat_options) - 1, SVs_TEMP));
1999 #ifndef PERL_BUILD_DATE
2002 # define PERL_BUILD_DATE __DATE__ " " __TIME__
2004 # define PERL_BUILD_DATE __DATE__
2009 #ifdef PERL_BUILD_DATE
2010 PUSHs(Perl_newSVpvn_flags(aTHX_
2011 STR_WITH_LEN("Compiled at " PERL_BUILD_DATE),
2014 PUSHs(&PL_sv_undef);
2017 for (i = 1; i <= local_patch_count; i++) {
2018 /* This will be an undef, if PL_localpatches[i] is NULL. */
2019 PUSHs(sv_2mortal(newSVpv(PL_localpatches[i], 0)));
2025 #define INCPUSH_UNSHIFT 0x01
2026 #define INCPUSH_ADD_OLD_VERS 0x02
2027 #define INCPUSH_ADD_VERSIONED_SUB_DIRS 0x04
2028 #define INCPUSH_ADD_ARCHONLY_SUB_DIRS 0x08
2029 #define INCPUSH_NOT_BASEDIR 0x10
2030 #define INCPUSH_CAN_RELOCATE 0x20
2031 #define INCPUSH_ADD_SUB_DIRS \
2032 (INCPUSH_ADD_VERSIONED_SUB_DIRS|INCPUSH_ADD_ARCHONLY_SUB_DIRS)
2035 S_parse_body(pTHX_ char **env, XSINIT_t xsinit)
2039 int argc = PL_origargc;
2040 char **argv = PL_origargv;
2041 const char *scriptname = NULL;
2042 bool dosearch = FALSE;
2044 bool doextract = FALSE;
2045 const char *cddir = NULL;
2046 #ifdef USE_SITECUSTOMIZE
2047 bool minus_f = FALSE;
2049 SV *linestr_sv = NULL;
2050 bool add_read_e_script = FALSE;
2051 U32 lex_start_flags = 0;
2053 PERL_SET_PHASE(PERL_PHASE_START);
2059 for (argc--,argv++; argc > 0; argc--,argv++) {
2060 if (argv[0][0] != '-' || !argv[0][1])
2066 #ifndef PERL_STRICT_CR
2090 if ((s = moreswitches(s)))
2095 #if defined(SILENT_NO_TAINT_SUPPORT)
2096 /* silently ignore */
2097 #elif defined(NO_TAINT_SUPPORT)
2098 Perl_croak_nocontext("This perl was compiled without taint support. "
2099 "Cowardly refusing to run with -t or -T flags");
2101 CHECK_MALLOC_TOO_LATE_FOR('t');
2102 if( !TAINTING_get ) {
2103 TAINT_WARN_set(TRUE);
2110 #if defined(SILENT_NO_TAINT_SUPPORT)
2111 /* silently ignore */
2112 #elif defined(NO_TAINT_SUPPORT)
2113 Perl_croak_nocontext("This perl was compiled without taint support. "
2114 "Cowardly refusing to run with -t or -T flags");
2116 CHECK_MALLOC_TOO_LATE_FOR('T');
2118 TAINT_WARN_set(FALSE);
2127 forbid_setid('e', FALSE);
2129 PL_e_script = newSVpvs("");
2130 add_read_e_script = TRUE;
2133 sv_catpv(PL_e_script, s);
2135 sv_catpv(PL_e_script, argv[1]);
2139 Perl_croak(aTHX_ "No code specified for -%c", c);
2140 sv_catpvs(PL_e_script, "\n");
2144 #ifdef USE_SITECUSTOMIZE
2150 case 'I': /* -I handled both here and in moreswitches() */
2151 forbid_setid('I', FALSE);
2152 if (!*++s && (s=argv[1]) != NULL) {
2156 STRLEN len = strlen(s);
2157 incpush(s, len, INCPUSH_ADD_SUB_DIRS|INCPUSH_ADD_OLD_VERS);
2160 Perl_croak(aTHX_ "No directory specified for -I");
2163 forbid_setid('S', FALSE);
2172 opts_prog = newSVpvs("use Config; Config::_V()");
2176 opts_prog = Perl_newSVpvf(aTHX_
2177 "use Config; Config::config_vars(qw%c%s%c)",
2181 Perl_av_create_and_push(aTHX_ &PL_preambleav, opts_prog);
2182 /* don't look for script or read stdin */
2183 scriptname = BIT_BUCKET;
2195 if (!*++s || isSPACE(*s)) {
2199 /* catch use of gnu style long options.
2200 Both of these exit immediately. */
2201 if (strEQ(s, "version"))
2203 if (strEQ(s, "help"))
2208 Perl_croak(aTHX_ "Unrecognized switch: -%s (-h will show valid options)",s);
2219 #ifndef SECURE_INTERNAL_GETENV
2222 (s = PerlEnv_getenv("PERL5OPT")))
2224 /* s points to static memory in getenv(), which may be overwritten at
2225 * any time; use a mortal copy instead */
2226 s = SvPVX(sv_2mortal(newSVpv(s, 0)));
2230 if (*s == '-' && *(s+1) == 'T') {
2231 #if defined(SILENT_NO_TAINT_SUPPORT)
2232 /* silently ignore */
2233 #elif defined(NO_TAINT_SUPPORT)
2234 Perl_croak_nocontext("This perl was compiled without taint support. "
2235 "Cowardly refusing to run with -t or -T flags");
2237 CHECK_MALLOC_TOO_LATE_FOR('T');
2239 TAINT_WARN_set(FALSE);
2243 char *popt_copy = NULL;
2256 if (!strchr("CDIMUdmtwW", *s))
2257 Perl_croak(aTHX_ "Illegal switch in PERL5OPT: -%c", *s);
2261 popt_copy = SvPVX(sv_2mortal(newSVpv(d,0)));
2262 s = popt_copy + (s - d);
2270 #if defined(SILENT_NO_TAINT_SUPPORT)
2271 /* silently ignore */
2272 #elif defined(NO_TAINT_SUPPORT)
2273 Perl_croak_nocontext("This perl was compiled without taint support. "
2274 "Cowardly refusing to run with -t or -T flags");
2276 if( !TAINTING_get) {
2277 TAINT_WARN_set(TRUE);
2289 #ifndef NO_PERL_INTERNAL_RAND_SEED
2290 /* If we're not set[ug]id, we might have honored
2291 PERL_INTERNAL_RAND_SEED in perl_construct().
2292 At this point command-line options have been parsed, so if
2293 we're now tainting and not set[ug]id re-seed.
2294 This could possibly be wasteful if PERL_INTERNAL_RAND_SEED is invalid,
2295 but avoids duplicating the logic from perl_construct().
2298 PerlProc_getuid() == PerlProc_geteuid() &&
2299 PerlProc_getgid() == PerlProc_getegid()) {
2300 Perl_drand48_init_r(&PL_internal_random_state, seed());
2304 /* Set $^X early so that it can be used for relocatable paths in @INC */
2305 /* and for SITELIB_EXP in USE_SITECUSTOMIZE */
2306 assert (!TAINT_get);
2311 #if defined(USE_SITECUSTOMIZE)
2313 /* The games with local $! are to avoid setting errno if there is no
2314 sitecustomize script. "q%c...%c", 0, ..., 0 becomes "q\0...\0",
2315 ie a q() operator with a NUL byte as a the delimiter. This avoids
2316 problems with pathnames containing (say) ' */
2317 # ifdef PERL_IS_MINIPERL
2318 AV *const inc = GvAV(PL_incgv);
2319 SV **const inc0 = inc ? av_fetch(inc, 0, FALSE) : NULL;
2322 /* if lib/buildcustomize.pl exists, it should not fail. If it does,
2323 it should be reported immediately as a build failure. */
2324 (void)Perl_av_create_and_unshift_one(aTHX_ &PL_preambleav,
2326 "BEGIN { my $f = q%c%s%" SVf "/buildcustomize.pl%c; "
2327 "do {local $!; -f $f }"
2328 " and do $f || die $@ || qq '$f: $!' }",
2329 0, (TAINTING_get ? "./" : ""), SVfARG(*inc0), 0));
2332 /* SITELIB_EXP is a function call on Win32. */
2333 const char *const raw_sitelib = SITELIB_EXP;
2335 /* process .../.. if PERL_RELOCATABLE_INC is defined */
2336 SV *sitelib_sv = mayberelocate(raw_sitelib, strlen(raw_sitelib),
2337 INCPUSH_CAN_RELOCATE);
2338 const char *const sitelib = SvPVX(sitelib_sv);
2339 (void)Perl_av_create_and_unshift_one(aTHX_ &PL_preambleav,
2341 "BEGIN { do {local $!; -f q%c%s/sitecustomize.pl%c} && do q%c%s/sitecustomize.pl%c }",
2342 0, SVfARG(sitelib), 0,
2343 0, SVfARG(sitelib), 0));
2344 assert (SvREFCNT(sitelib_sv) == 1);
2345 SvREFCNT_dec(sitelib_sv);
2352 scriptname = argv[0];
2355 scriptname = BIT_BUCKET; /* don't look for script or read stdin */
2357 else if (scriptname == NULL) {
2359 if ( PerlLIO_isatty(PerlIO_fileno(PerlIO_stdin())) )
2365 assert (!TAINT_get);
2369 bool suidscript = FALSE;
2371 rsfp = open_script(scriptname, dosearch, &suidscript);
2373 rsfp = PerlIO_stdin();
2374 lex_start_flags = LEX_DONT_CLOSE_RSFP;
2377 validate_suid(rsfp);
2380 # if defined(SIGCHLD) || defined(SIGCLD)
2383 # define SIGCHLD SIGCLD
2385 Sighandler_t sigstate = rsignal_state(SIGCHLD);
2386 if (sigstate == (Sighandler_t) SIG_IGN) {
2387 Perl_ck_warner(aTHX_ packWARN(WARN_SIGNAL),
2388 "Can't ignore signal CHLD, forcing to default");
2389 (void)rsignal(SIGCHLD, (Sighandler_t)SIG_DFL);
2397 /* This will croak if suidscript is true, as -x cannot be used with
2399 forbid_setid('x', suidscript);
2400 /* Hence you can't get here if suidscript is true */
2402 linestr_sv = newSV_type(SVt_PV);
2403 lex_start_flags |= LEX_START_COPIED;
2404 find_beginning(linestr_sv, rsfp);
2405 if (cddir && PerlDir_chdir( (char *)cddir ) < 0)
2406 Perl_croak(aTHX_ "Can't chdir to %s",cddir);
2410 PL_main_cv = PL_compcv = MUTABLE_CV(newSV_type(SVt_PVCV));
2411 CvUNIQUE_on(PL_compcv);
2413 CvPADLIST_set(PL_compcv, pad_new(0));
2415 PL_isarev = newHV();
2418 boot_core_UNIVERSAL();
2420 newXS("Internals::V", S_Internals_V, __FILE__);
2423 (*xsinit)(aTHX); /* in case linked C routines want magical variables */
2425 #if defined(VMS) || defined(WIN32) || defined(DJGPP) || defined(__CYGWIN__) || defined(SYMBIAN)
2431 # ifdef HAS_SOCKS5_INIT
2432 socks5_init(argv[0]);
2438 init_predump_symbols();
2439 /* init_postdump_symbols not currently designed to be called */
2440 /* more than once (ENV isn't cleared first, for example) */
2441 /* But running with -u leaves %ENV & @ARGV undefined! XXX */
2443 init_postdump_symbols(argc,argv,env);
2445 /* PL_unicode is turned on by -C, or by $ENV{PERL_UNICODE},
2446 * or explicitly in some platforms.
2447 * PL_utf8locale is conditionally turned on by
2448 * locale.c:Perl_init_i18nl10n() if the environment
2449 * look like the user wants to use UTF-8. */
2450 #if defined(__SYMBIAN32__)
2451 PL_unicode = PERL_UNICODE_STD_FLAG; /* See PERL_SYMBIAN_CONSOLE_UTF8. */
2453 # ifndef PERL_IS_MINIPERL
2455 /* Requires init_predump_symbols(). */
2456 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
2461 /* Turn on UTF-8-ness on STDIN, STDOUT, STDERR
2462 * and the default open disciplines. */
2463 if ((PL_unicode & PERL_UNICODE_STDIN_FLAG) &&
2464 PL_stdingv && (io = GvIO(PL_stdingv)) &&
2466 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2467 if ((PL_unicode & PERL_UNICODE_STDOUT_FLAG) &&
2468 PL_defoutgv && (io = GvIO(PL_defoutgv)) &&
2470 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2471 if ((PL_unicode & PERL_UNICODE_STDERR_FLAG) &&
2472 PL_stderrgv && (io = GvIO(PL_stderrgv)) &&
2474 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2475 if ((PL_unicode & PERL_UNICODE_INOUT_FLAG) &&
2476 (sv = GvSV(gv_fetchpvs("\017PEN", GV_ADD|GV_NOTQUAL,
2478 U32 in = PL_unicode & PERL_UNICODE_IN_FLAG;
2479 U32 out = PL_unicode & PERL_UNICODE_OUT_FLAG;
2482 sv_setpvs(sv, ":utf8\0:utf8");
2484 sv_setpvs(sv, ":utf8\0");
2487 sv_setpvs(sv, "\0:utf8");
2496 if ((s = PerlEnv_getenv("PERL_SIGNALS"))) {
2497 if (strEQ(s, "unsafe"))
2498 PL_signals |= PERL_SIGNALS_UNSAFE_FLAG;
2499 else if (strEQ(s, "safe"))
2500 PL_signals &= ~PERL_SIGNALS_UNSAFE_FLAG;
2502 Perl_croak(aTHX_ "PERL_SIGNALS illegal: \"%s\"", s);
2507 lex_start(linestr_sv, rsfp, lex_start_flags);
2508 SvREFCNT_dec(linestr_sv);
2510 PL_subname = newSVpvs("main");
2512 if (add_read_e_script)
2513 filter_add(read_e_script, NULL);
2515 /* now parse the script */
2517 SETERRNO(0,SS_NORMAL);
2518 if (yyparse(GRAMPROG) || PL_parser->error_count) {
2519 abort_execution("", PL_origfilename);
2521 CopLINE_set(PL_curcop, 0);
2522 SET_CURSTASH(PL_defstash);
2524 SvREFCNT_dec(PL_e_script);
2532 SAVECOPFILE(PL_curcop);
2533 SAVECOPLINE(PL_curcop);
2534 gv_check(PL_defstash);
2544 s = PerlEnv_getenv("PERL_DEBUG_MSTATS");
2545 if (s && grok_atoUV(s, &uv, NULL) && uv >= 2)
2546 dump_mstats("after compilation:");
2551 PL_restartjmpenv = NULL;
2557 =for apidoc Am|int|perl_run|PerlInterpreter *my_perl
2559 Tells a Perl interpreter to run its main program. See L<perlembed>
2562 C<my_perl> points to the Perl interpreter. It must have been previously
2563 created through the use of L</perl_alloc> and L</perl_construct>, and
2564 initialised through L</perl_parse>. This function should not be called
2565 if L</perl_parse> returned a non-zero value, indicating a failure in
2566 initialisation or compilation.
2568 This function executes code in C<INIT> blocks, and then executes the
2569 main program. The code to be executed is that established by the prior
2570 call to L</perl_parse>. If the interpreter's C<PL_exit_flags> word
2571 does not have the C<PERL_EXIT_DESTRUCT_END> flag set, then this function
2572 will also execute code in C<END> blocks. If it is desired to make any
2573 further use of the interpreter after calling this function, then C<END>
2574 blocks should be postponed to L</perl_destruct> time by setting that flag.
2576 Returns an integer of slightly tricky interpretation. The correct use
2577 of the return value is as a truth value indicating whether the program
2578 terminated non-locally. If zero is returned, this indicates that
2579 the program ran to completion, and it is safe to make other use of the
2580 interpreter (provided that the C<PERL_EXIT_DESTRUCT_END> flag was set as
2581 described above). If a non-zero value is returned, this indicates that
2582 the interpreter wants to terminate early. The interpreter should not be
2583 just abandoned because of this desire to terminate; the caller should
2584 proceed to shut the interpreter down cleanly with L</perl_destruct>
2585 and free it with L</perl_free>.
2587 For historical reasons, the non-zero return value also attempts to
2588 be a suitable value to pass to the C library function C<exit> (or to
2589 return from C<main>), to serve as an exit code indicating the nature of
2590 the way the program terminated. However, this isn't portable, due to
2591 differing exit code conventions. An attempt is made to return an exit
2592 code of the type required by the host operating system, but because
2593 it is constrained to be non-zero, it is not necessarily possible to
2594 indicate every type of exit. It is only reliable on Unix, where a zero
2595 exit code can be augmented with a set bit that will be ignored. In any
2596 case, this function is not the correct place to acquire an exit code:
2597 one should get that from L</perl_destruct>.
2606 int ret = 0, exit_called = 0;
2609 PERL_ARGS_ASSERT_PERL_RUN;
2610 #ifndef MULTIPLICITY
2611 PERL_UNUSED_ARG(my_perl);
2614 oldscope = PL_scopestack_ix;
2622 cxstack_ix = -1; /* start context stack again */
2624 case 0: /* normal completion */
2628 case 2: /* my_exit() */
2631 while (PL_scopestack_ix > oldscope)
2634 SET_CURSTASH(PL_defstash);
2635 if (!(PL_exit_flags & PERL_EXIT_DESTRUCT_END) &&
2636 PL_endav && !PL_minus_c) {
2637 PERL_SET_PHASE(PERL_PHASE_END);
2638 call_list(oldscope, PL_endav);
2641 if (PerlEnv_getenv("PERL_DEBUG_MSTATS"))
2642 dump_mstats("after execution: ");
2646 if (ret == 0) ret = 0x100;
2653 POPSTACK_TO(PL_mainstack);
2656 PerlIO_printf(Perl_error_log, "panic: restartop in perl_run\n");
2667 S_run_body(pTHX_ I32 oldscope)
2669 DEBUG_r(PerlIO_printf(Perl_debug_log, "%s $` $& $' support (0x%x).\n",
2670 PL_sawampersand ? "Enabling" : "Omitting",
2671 (unsigned int)(PL_sawampersand)));
2673 if (!PL_restartop) {
2675 if (DEBUG_x_TEST || DEBUG_B_TEST)
2676 dump_all_perl(!DEBUG_B_TEST);
2678 PERL_DEBUG(PerlIO_printf(Perl_debug_log, "\nEXECUTING...\n\n"));
2682 PerlIO_printf(Perl_error_log, "%s syntax OK\n", PL_origfilename);
2685 if (PERLDB_SINGLE && PL_DBsingle)
2688 PERL_SET_PHASE(PERL_PHASE_INIT);
2689 call_list(oldscope, PL_initav);
2691 #ifdef PERL_DEBUG_READONLY_OPS
2692 if (PL_main_root && PL_main_root->op_slabbed)
2693 Slab_to_ro(OpSLAB(PL_main_root));
2699 PERL_SET_PHASE(PERL_PHASE_RUN);
2702 PL_restartjmpenv = NULL;
2703 PL_op = PL_restartop;
2707 else if (PL_main_start) {
2708 CvDEPTH(PL_main_cv) = 1;
2709 PL_op = PL_main_start;
2713 NOT_REACHED; /* NOTREACHED */
2717 =head1 SV Manipulation Functions
2719 =for apidoc p||get_sv
2721 Returns the SV of the specified Perl scalar. C<flags> are passed to
2722 C<gv_fetchpv>. If C<GV_ADD> is set and the
2723 Perl variable does not exist then it will be created. If C<flags> is zero
2724 and the variable does not exist then NULL is returned.
2730 Perl_get_sv(pTHX_ const char *name, I32 flags)
2734 PERL_ARGS_ASSERT_GET_SV;
2736 gv = gv_fetchpv(name, flags, SVt_PV);
2743 =head1 Array Manipulation Functions
2745 =for apidoc p||get_av
2747 Returns the AV of the specified Perl global or package array with the given
2748 name (so it won't work on lexical variables). C<flags> are passed
2749 to C<gv_fetchpv>. If C<GV_ADD> is set and the
2750 Perl variable does not exist then it will be created. If C<flags> is zero
2751 and the variable does not exist then NULL is returned.
2753 Perl equivalent: C<@{"$name"}>.
2759 Perl_get_av(pTHX_ const char *name, I32 flags)
2761 GV* const gv = gv_fetchpv(name, flags, SVt_PVAV);
2763 PERL_ARGS_ASSERT_GET_AV;
2773 =head1 Hash Manipulation Functions
2775 =for apidoc p||get_hv
2777 Returns the HV of the specified Perl hash. C<flags> are passed to
2778 C<gv_fetchpv>. If C<GV_ADD> is set and the
2779 Perl variable does not exist then it will be created. If C<flags> is zero
2780 and the variable does not exist then C<NULL> is returned.
2786 Perl_get_hv(pTHX_ const char *name, I32 flags)
2788 GV* const gv = gv_fetchpv(name, flags, SVt_PVHV);
2790 PERL_ARGS_ASSERT_GET_HV;
2800 =head1 CV Manipulation Functions
2802 =for apidoc p||get_cvn_flags
2804 Returns the CV of the specified Perl subroutine. C<flags> are passed to
2805 C<gv_fetchpvn_flags>. If C<GV_ADD> is set and the Perl subroutine does not
2806 exist then it will be declared (which has the same effect as saying
2807 C<sub name;>). If C<GV_ADD> is not set and the subroutine does not exist
2808 then NULL is returned.
2810 =for apidoc p||get_cv
2812 Uses C<strlen> to get the length of C<name>, then calls C<get_cvn_flags>.
2818 Perl_get_cvn_flags(pTHX_ const char *name, STRLEN len, I32 flags)
2820 GV* const gv = gv_fetchpvn_flags(name, len, flags, SVt_PVCV);
2822 PERL_ARGS_ASSERT_GET_CVN_FLAGS;
2824 if (gv && UNLIKELY(SvROK(gv)) && SvTYPE(SvRV((SV *)gv)) == SVt_PVCV)
2825 return (CV*)SvRV((SV *)gv);
2827 /* XXX this is probably not what they think they're getting.
2828 * It has the same effect as "sub name;", i.e. just a forward
2830 if ((flags & ~GV_NOADD_MASK) && !GvCVu(gv)) {
2831 return newSTUB(gv,0);
2838 /* Nothing in core calls this now, but we can't replace it with a macro and
2839 move it to mathoms.c as a macro would evaluate name twice. */
2841 Perl_get_cv(pTHX_ const char *name, I32 flags)
2843 PERL_ARGS_ASSERT_GET_CV;
2845 return get_cvn_flags(name, strlen(name), flags);
2848 /* Be sure to refetch the stack pointer after calling these routines. */
2852 =head1 Callback Functions
2854 =for apidoc p||call_argv
2856 Performs a callback to the specified named and package-scoped Perl subroutine
2857 with C<argv> (a C<NULL>-terminated array of strings) as arguments. See
2860 Approximate Perl equivalent: C<&{"$sub_name"}(@$argv)>.
2866 Perl_call_argv(pTHX_ const char *sub_name, I32 flags, char **argv)
2868 /* See G_* flags in cop.h */
2869 /* null terminated arg list */
2873 PERL_ARGS_ASSERT_CALL_ARGV;
2877 mXPUSHs(newSVpv(*argv,0));
2881 return call_pv(sub_name, flags);
2885 =for apidoc p||call_pv
2887 Performs a callback to the specified Perl sub. See L<perlcall>.
2893 Perl_call_pv(pTHX_ const char *sub_name, I32 flags)
2894 /* name of the subroutine */
2895 /* See G_* flags in cop.h */
2897 PERL_ARGS_ASSERT_CALL_PV;
2899 return call_sv(MUTABLE_SV(get_cv(sub_name, GV_ADD)), flags);
2903 =for apidoc p||call_method
2905 Performs a callback to the specified Perl method. The blessed object must
2906 be on the stack. See L<perlcall>.
2912 Perl_call_method(pTHX_ const char *methname, I32 flags)
2913 /* name of the subroutine */
2914 /* See G_* flags in cop.h */
2918 PERL_ARGS_ASSERT_CALL_METHOD;
2920 len = strlen(methname);
2921 sv = flags & G_METHOD_NAMED
2922 ? sv_2mortal(newSVpvn_share(methname, len,0))
2923 : newSVpvn_flags(methname, len, SVs_TEMP);
2925 return call_sv(sv, flags | G_METHOD);
2928 /* May be called with any of a CV, a GV, or an SV containing the name. */
2930 =for apidoc p||call_sv
2932 Performs a callback to the Perl sub specified by the SV.
2934 If neither the C<G_METHOD> nor C<G_METHOD_NAMED> flag is supplied, the
2935 SV may be any of a CV, a GV, a reference to a CV, a reference to a GV
2936 or C<SvPV(sv)> will be used as the name of the sub to call.
2938 If the C<G_METHOD> flag is supplied, the SV may be a reference to a CV or
2939 C<SvPV(sv)> will be used as the name of the method to call.
2941 If the C<G_METHOD_NAMED> flag is supplied, C<SvPV(sv)> will be used as
2942 the name of the method to call.
2944 Some other values are treated specially for internal use and should
2953 Perl_call_sv(pTHX_ SV *sv, volatile I32 flags)
2954 /* See G_* flags in cop.h */
2957 LOGOP myop; /* fake syntax tree node */
2960 volatile I32 retval = 0;
2961 bool oldcatch = CATCH_GET;
2963 OP* const oldop = PL_op;
2966 PERL_ARGS_ASSERT_CALL_SV;
2968 if (flags & G_DISCARD) {
2972 if (!(flags & G_WANT)) {
2973 /* Backwards compatibility - as G_SCALAR was 0, it could be omitted.
2978 Zero(&myop, 1, LOGOP);
2979 if (!(flags & G_NOARGS))
2980 myop.op_flags |= OPf_STACKED;
2981 myop.op_flags |= OP_GIMME_REVERSE(flags);
2985 if (!(flags & G_METHOD_NAMED)) {
2993 if (PERLDB_SUB && PL_curstash != PL_debstash
2994 /* Handle first BEGIN of -d. */
2995 && (PL_DBcv || (PL_DBcv = GvCV(PL_DBsub)))
2996 /* Try harder, since this may have been a sighandler, thus
2997 * curstash may be meaningless. */
2998 && (SvTYPE(sv) != SVt_PVCV || CvSTASH((const CV *)sv) != PL_debstash)
2999 && !(flags & G_NODEBUG))
3000 myop.op_private |= OPpENTERSUB_DB;
3002 if (flags & (G_METHOD|G_METHOD_NAMED)) {
3003 Zero(&method_op, 1, METHOP);
3004 method_op.op_next = (OP*)&myop;
3005 PL_op = (OP*)&method_op;
3006 if ( flags & G_METHOD_NAMED ) {
3007 method_op.op_ppaddr = PL_ppaddr[OP_METHOD_NAMED];
3008 method_op.op_type = OP_METHOD_NAMED;
3009 method_op.op_u.op_meth_sv = sv;
3011 method_op.op_ppaddr = PL_ppaddr[OP_METHOD];
3012 method_op.op_type = OP_METHOD;
3014 myop.op_ppaddr = PL_ppaddr[OP_ENTERSUB];
3015 myop.op_type = OP_ENTERSUB;
3018 if (!(flags & G_EVAL)) {
3020 CALL_BODY_SUB((OP*)&myop);
3021 retval = PL_stack_sp - (PL_stack_base + oldmark);
3022 CATCH_SET(oldcatch);
3026 myop.op_other = (OP*)&myop;
3028 old_cxix = cxstack_ix;
3029 create_eval_scope(NULL, flags|G_FAKINGEVAL);
3037 CALL_BODY_SUB((OP*)&myop);
3038 retval = PL_stack_sp - (PL_stack_base + oldmark);
3039 if (!(flags & G_KEEPERR)) {
3047 /* my_exit() was called */
3048 SET_CURSTASH(PL_defstash);
3052 NOT_REACHED; /* NOTREACHED */
3055 PL_restartjmpenv = NULL;
3056 PL_op = PL_restartop;
3060 PL_stack_sp = PL_stack_base + oldmark;
3061 if ((flags & G_WANT) == G_ARRAY)
3065 *++PL_stack_sp = &PL_sv_undef;
3070 /* if we croaked, depending on how we croaked the eval scope
3071 * may or may not have already been popped */
3072 if (cxstack_ix > old_cxix) {
3073 assert(cxstack_ix == old_cxix + 1);
3074 assert(CxTYPE(CX_CUR()) == CXt_EVAL);
3075 delete_eval_scope();
3080 if (flags & G_DISCARD) {
3081 PL_stack_sp = PL_stack_base + oldmark;
3090 /* Eval a string. The G_EVAL flag is always assumed. */
3093 =for apidoc p||eval_sv
3095 Tells Perl to C<eval> the string in the SV. It supports the same flags
3096 as C<call_sv>, with the obvious exception of C<G_EVAL>. See L<perlcall>.
3102 Perl_eval_sv(pTHX_ SV *sv, I32 flags)
3104 /* See G_* flags in cop.h */
3107 UNOP myop; /* fake syntax tree node */
3108 volatile I32 oldmark;
3109 volatile I32 retval = 0;
3111 OP* const oldop = PL_op;
3114 PERL_ARGS_ASSERT_EVAL_SV;
3116 if (flags & G_DISCARD) {
3123 Zero(&myop, 1, UNOP);
3126 oldmark = SP - PL_stack_base;
3132 if (!(flags & G_NOARGS))
3133 myop.op_flags = OPf_STACKED;
3134 myop.op_type = OP_ENTEREVAL;
3135 myop.op_flags |= OP_GIMME_REVERSE(flags);
3136 if (flags & G_KEEPERR)
3137 myop.op_flags |= OPf_SPECIAL;
3139 if (flags & G_RE_REPARSING)
3140 myop.op_private = (OPpEVAL_COPHH | OPpEVAL_RE_REPARSING);
3142 /* fail now; otherwise we could fail after the JMPENV_PUSH but
3143 * before a cx_pusheval(), which corrupts the stack after a croak */
3144 TAINT_PROPER("eval_sv()");
3150 if (PL_op == (OP*)(&myop)) {
3151 PL_op = PL_ppaddr[OP_ENTEREVAL](aTHX);
3153 goto fail; /* failed in compilation */
3156 retval = PL_stack_sp - (PL_stack_base + oldmark);
3157 if (!(flags & G_KEEPERR)) {
3165 /* my_exit() was called */
3166 SET_CURSTASH(PL_defstash);
3170 NOT_REACHED; /* NOTREACHED */
3173 PL_restartjmpenv = NULL;
3174 PL_op = PL_restartop;
3179 PL_stack_sp = PL_stack_base + oldmark;
3180 if ((flags & G_WANT) == G_ARRAY)
3184 *++PL_stack_sp = &PL_sv_undef;
3190 if (flags & G_DISCARD) {
3191 PL_stack_sp = PL_stack_base + oldmark;
3201 =for apidoc p||eval_pv
3203 Tells Perl to C<eval> the given string in scalar context and return an SV* result.
3209 Perl_eval_pv(pTHX_ const char *p, I32 croak_on_error)
3211 SV* sv = newSVpv(p, 0);
3213 PERL_ARGS_ASSERT_EVAL_PV;
3215 eval_sv(sv, G_SCALAR);
3224 /* just check empty string or undef? */
3225 if (croak_on_error) {
3226 SV * const errsv = ERRSV;
3227 if(SvTRUE_NN(errsv))
3228 /* replace with croak_sv? */
3229 Perl_croak_nocontext("%s", SvPV_nolen_const(errsv));
3235 /* Require a module. */
3238 =head1 Embedding Functions
3240 =for apidoc p||require_pv
3242 Tells Perl to C<require> the file named by the string argument. It is
3243 analogous to the Perl code C<eval "require '$file'">. It's even
3244 implemented that way; consider using load_module instead.
3249 Perl_require_pv(pTHX_ const char *pv)
3254 PERL_ARGS_ASSERT_REQUIRE_PV;
3256 PUSHSTACKi(PERLSI_REQUIRE);
3257 sv = Perl_newSVpvf(aTHX_ "require q%c%s%c", 0, pv, 0);
3258 eval_sv(sv_2mortal(sv), G_DISCARD);
3263 S_usage(pTHX) /* XXX move this out into a module ? */
3265 /* This message really ought to be max 23 lines.
3266 * Removed -h because the user already knows that option. Others? */
3268 /* Grouped as 6 lines per C string literal, to keep under the ANSI C 89
3269 minimum of 509 character string literals. */
3270 static const char * const usage_msg[] = {
3271 " -0[octal] specify record separator (\\0, if no argument)\n"
3272 " -a autosplit mode with -n or -p (splits $_ into @F)\n"
3273 " -C[number/list] enables the listed Unicode features\n"
3274 " -c check syntax only (runs BEGIN and CHECK blocks)\n"
3275 " -d[:debugger] run program under debugger\n"
3276 " -D[number/list] set debugging flags (argument is a bit mask or alphabets)\n",
3277 " -e program one line of program (several -e's allowed, omit programfile)\n"
3278 " -E program like -e, but enables all optional features\n"
3279 " -f don't do $sitelib/sitecustomize.pl at startup\n"
3280 " -F/pattern/ split() pattern for -a switch (//'s are optional)\n"
3281 " -i[extension] edit <> files in place (makes backup if extension supplied)\n"
3282 " -Idirectory specify @INC/#include directory (several -I's allowed)\n",
3283 " -l[octal] enable line ending processing, specifies line terminator\n"
3284 " -[mM][-]module execute \"use/no module...\" before executing program\n"
3285 " -n assume \"while (<>) { ... }\" loop around program\n"
3286 " -p assume loop like -n but print line also, like sed\n"
3287 " -s enable rudimentary parsing for switches after programfile\n"
3288 " -S look for programfile using PATH environment variable\n",
3289 " -t enable tainting warnings\n"
3290 " -T enable tainting checks\n"
3291 " -u dump core after parsing program\n"
3292 " -U allow unsafe operations\n"
3293 " -v print version, patchlevel and license\n"
3294 " -V[:variable] print configuration summary (or a single Config.pm variable)\n",
3295 " -w enable many useful warnings\n"
3296 " -W enable all warnings\n"
3297 " -x[directory] ignore text before #!perl line (optionally cd to directory)\n"
3298 " -X disable all warnings\n"
3300 "Run 'perldoc perl' for more help with Perl.\n\n",
3303 const char * const *p = usage_msg;
3304 PerlIO *out = PerlIO_stdout();
3307 "\nUsage: %s [switches] [--] [programfile] [arguments]\n",
3310 PerlIO_puts(out, *p++);
3314 /* convert a string of -D options (or digits) into an int.
3315 * sets *s to point to the char after the options */
3319 Perl_get_debug_opts(pTHX_ const char **s, bool givehelp)
3321 static const char * const usage_msgd[] = {
3322 " Debugging flag values: (see also -d)\n"
3323 " p Tokenizing and parsing (with v, displays parse stack)\n"
3324 " s Stack snapshots (with v, displays all stacks)\n"
3325 " l Context (loop) stack processing\n"
3326 " t Trace execution\n"
3327 " o Method and overloading resolution\n",
3328 " c String/numeric conversions\n"
3329 " P Print profiling info, source file input state\n"
3330 " m Memory and SV allocation\n"
3331 " f Format processing\n"
3332 " r Regular expression parsing and execution\n"
3333 " x Syntax tree dump\n",
3334 " u Tainting checks\n"
3335 " H Hash dump -- usurps values()\n"
3336 " X Scratchpad allocation\n"
3338 " S Op slab allocation\n"
3340 " R Include reference counts of dumped variables (eg when using -Ds)\n",
3341 " J Do not s,t,P-debug (Jump over) opcodes within package DB\n"
3342 " v Verbose: use in conjunction with other flags\n"
3343 " C Copy On Write\n"
3344 " A Consistency checks on internal structures\n"
3345 " q quiet - currently only suppresses the 'EXECUTING' message\n"
3346 " M trace smart match resolution\n"
3347 " B dump suBroutine definitions, including special Blocks like BEGIN\n",
3348 " L trace some locale setting information--for Perl core development\n",
3349 " i trace PerlIO layer processing\n",
3354 PERL_ARGS_ASSERT_GET_DEBUG_OPTS;
3357 /* if adding extra options, remember to update DEBUG_MASK */
3358 static const char debopts[] = "psltocPmfrxuUHXDSTRJvCAqMBLi";
3360 for (; isWORDCHAR(**s); (*s)++) {
3361 const char * const d = strchr(debopts,**s);
3363 uv |= 1 << (d - debopts);
3364 else if (ckWARN_d(WARN_DEBUGGING))
3365 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3366 "invalid option -D%c, use -D'' to see choices\n", **s);
3369 else if (isDIGIT(**s)) {
3371 if (grok_atoUV(*s, &uv, &e))
3373 for (; isWORDCHAR(**s); (*s)++) ;
3375 else if (givehelp) {
3376 const char *const *p = usage_msgd;
3377 while (*p) PerlIO_puts(PerlIO_stdout(), *p++);
3379 return (int)uv; /* ignore any UV->int conversion loss */
3383 /* This routine handles any switches that can be given during run */
3386 Perl_moreswitches(pTHX_ const char *s)
3390 const char option = *s; /* used to remember option in -m/-M code */
3392 PERL_ARGS_ASSERT_MORESWITCHES;
3400 SvREFCNT_dec(PL_rs);
3401 if (s[1] == 'x' && s[2]) {
3402 const char *e = s+=2;
3408 flags = PERL_SCAN_SILENT_ILLDIGIT;
3409 rschar = (U32)grok_hex(s, &numlen, &flags, NULL);
3410 if (s + numlen < e) {
3411 rschar = 0; /* Grandfather -0xFOO as -0 -xFOO. */
3415 PL_rs = newSVpvs("");
3416 tmps = (U8*) SvGROW(PL_rs, (STRLEN)(UVCHR_SKIP(rschar) + 1));
3417 uvchr_to_utf8(tmps, rschar);
3418 SvCUR_set(PL_rs, UVCHR_SKIP(rschar));
3423 rschar = (U32)grok_oct(s, &numlen, &flags, NULL);
3424 if (rschar & ~((U8)~0))
3425 PL_rs = &PL_sv_undef;
3426 else if (!rschar && numlen >= 2)
3427 PL_rs = newSVpvs("");
3429 char ch = (char)rschar;
3430 PL_rs = newSVpvn(&ch, 1);
3433 sv_setsv(get_sv("/", GV_ADD), PL_rs);
3438 PL_unicode = parse_unicode_opts( (const char **)&s );
3439 if (PL_unicode & PERL_UNICODE_UTF8CACHEASSERT_FLAG)
3447 while (*s && !isSPACE(*s)) ++s;
3448 PL_splitstr = savepvn(PL_splitstr, s - PL_splitstr);
3460 forbid_setid('d', FALSE);
3463 /* -dt indicates to the debugger that threads will be used */
3464 if (*s == 't' && !isWORDCHAR(s[1])) {
3466 my_setenv("PERL5DB_THREADED", "1");
3469 /* The following permits -d:Mod to accepts arguments following an =
3470 in the fashion that -MSome::Mod does. */
3471 if (*s == ':' || *s == '=') {
3478 sv = newSVpvs("no Devel::");
3480 sv = newSVpvs("use Devel::");
3484 end = s + strlen(s);
3486 /* We now allow -d:Module=Foo,Bar and -d:-Module */
3487 while(isWORDCHAR(*s) || *s==':') ++s;
3489 sv_catpvn(sv, start, end - start);
3491 sv_catpvn(sv, start, s-start);
3492 /* Don't use NUL as q// delimiter here, this string goes in the
3494 Perl_sv_catpvf(aTHX_ sv, " split(/,/,q{%s});", ++s);
3497 my_setenv("PERL5DB", SvPV_nolen_const(sv));
3501 PL_perldb = PERLDB_ALL;
3508 forbid_setid('D', FALSE);
3510 PL_debug = get_debug_opts( (const char **)&s, 1) | DEBUG_TOP_FLAG;
3511 #else /* !DEBUGGING */
3512 if (ckWARN_d(WARN_DEBUGGING))
3513 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3514 "Recompile perl with -DDEBUGGING to use -D switch (did you mean -d ?)\n");
3515 for (s++; isWORDCHAR(*s); s++) ;
3518 NOT_REACHED; /* NOTREACHED */
3522 NOT_REACHED; /* NOTREACHED */
3525 Safefree(PL_inplace);
3527 const char * const start = ++s;
3528 while (*s && !isSPACE(*s))
3531 PL_inplace = savepvn(start, s - start);
3534 case 'I': /* -I handled both here and in parse_body() */
3535 forbid_setid('I', FALSE);
3537 while (*s && isSPACE(*s))
3542 /* ignore trailing spaces (possibly followed by other switches) */
3544 for (e = p; *e && !isSPACE(*e); e++) ;
3548 } while (*p && *p != '-');
3550 INCPUSH_ADD_SUB_DIRS|INCPUSH_ADD_OLD_VERS|INCPUSH_UNSHIFT);
3556 Perl_croak(aTHX_ "No directory specified for -I");
3562 SvREFCNT_dec(PL_ors_sv);
3568 PL_ors_sv = newSVpvs("\n");
3569 numlen = 3 + (*s == '0');
3570 *SvPVX(PL_ors_sv) = (char)grok_oct(s, &numlen, &flags, NULL);
3574 if (RsPARA(PL_rs)) {
3575 PL_ors_sv = newSVpvs("\n\n");
3578 PL_ors_sv = newSVsv(PL_rs);
3583 forbid_setid('M', FALSE); /* XXX ? */
3586 forbid_setid('m', FALSE); /* XXX ? */
3591 const char *use = "use ";
3593 /* -M-foo == 'no foo' */
3594 /* Leading space on " no " is deliberate, to make both
3595 possibilities the same length. */
3596 if (*s == '-') { use = " no "; ++s; }
3597 sv = newSVpvn(use,4);
3599 /* We allow -M'Module qw(Foo Bar)' */
3600 while(isWORDCHAR(*s) || *s==':') {
3609 Perl_croak(aTHX_ "Module name required with -%c option",
3612 Perl_croak(aTHX_ "Invalid module name %.*s with -%c option: "
3613 "contains single ':'",
3614 (int)(s - start), start, option);
3615 end = s + strlen(s);
3617 sv_catpvn(sv, start, end - start);
3618 if (option == 'm') {
3620 Perl_croak(aTHX_ "Can't use '%c' after -mname", *s);
3621 sv_catpvs( sv, " ()");
3624 sv_catpvn(sv, start, s-start);
3625 /* Use NUL as q''-delimiter. */
3626 sv_catpvs(sv, " split(/,/,q\0");
3628 sv_catpvn(sv, s, end - s);
3629 sv_catpvs(sv, "\0)");
3632 Perl_av_create_and_push(aTHX_ &PL_preambleav, sv);
3635 Perl_croak(aTHX_ "Missing argument to -%c", option);
3646 forbid_setid('s', FALSE);
3647 PL_doswitches = TRUE;
3652 #if defined(SILENT_NO_TAINT_SUPPORT)
3653 /* silently ignore */
3654 #elif defined(NO_TAINT_SUPPORT)
3655 Perl_croak_nocontext("This perl was compiled without taint support. "
3656 "Cowardly refusing to run with -t or -T flags");
3664 PL_do_undump = TRUE;
3674 if (! (PL_dowarn & G_WARN_ALL_MASK)) {
3675 PL_dowarn |= G_WARN_ON;
3680 PL_dowarn = G_WARN_ALL_ON|G_WARN_ON;
3681 if (!specialWARN(PL_compiling.cop_warnings))
3682 PerlMemShared_free(PL_compiling.cop_warnings);
3683 PL_compiling.cop_warnings = pWARN_ALL ;
3687 PL_dowarn = G_WARN_ALL_OFF;
3688 if (!specialWARN(PL_compiling.cop_warnings))
3689 PerlMemShared_free(PL_compiling.cop_warnings);
3690 PL_compiling.cop_warnings = pWARN_NONE ;
3697 if (s[0] == '-') /* Additional switches on #! line. */
3702 #if defined(WIN32) || !defined(PERL_STRICT_CR)
3708 #ifdef ALTERNATE_SHEBANG
3709 case 'S': /* OS/2 needs -S on "extproc" line. */
3712 case 'e': case 'f': case 'x': case 'E':
3713 #ifndef ALTERNATE_SHEBANG
3717 Perl_croak(aTHX_ "Can't emulate -%.1s on #! line",s);
3720 "Unrecognized switch: -%.1s (-h will show valid options)",s
3730 PerlIO * PIO_stdout;
3732 const char * const level_str = "v" PERL_VERSION_STRING;
3733 const STRLEN level_len = sizeof("v" PERL_VERSION_STRING)-1;
3734 #ifdef PERL_PATCHNUM
3736 # ifdef PERL_GIT_UNCOMMITTED_CHANGES
3737 static const char num [] = PERL_PATCHNUM "*";
3739 static const char num [] = PERL_PATCHNUM;
3742 const STRLEN num_len = sizeof(num)-1;
3743 /* A very advanced compiler would fold away the strnEQ
3744 and this whole conditional, but most (all?) won't do it.
3745 SV level could also be replaced by with preprocessor
3748 if (num_len >= level_len && strnEQ(num,level_str,level_len)) {
3749 /* per 46807d8e80, PERL_PATCHNUM is outside of the control
3750 of the interp so it might contain format characters
3752 level = newSVpvn(num, num_len);
3754 level = Perl_newSVpvf_nocontext("%s (%s)", level_str, num);
3758 SV* level = newSVpvn(level_str, level_len);
3759 #endif /* #ifdef PERL_PATCHNUM */
3760 PIO_stdout = PerlIO_stdout();
3761 PerlIO_printf(PIO_stdout,
3762 "\nThis is perl " STRINGIFY(PERL_REVISION)
3763 ", version " STRINGIFY(PERL_VERSION)
3764 ", subversion " STRINGIFY(PERL_SUBVERSION)
3765 " (%" SVf ") built for " ARCHNAME, SVfARG(level)
3767 SvREFCNT_dec_NN(level);
3769 #if defined(LOCAL_PATCH_COUNT)
3770 if (LOCAL_PATCH_COUNT > 0)
3771 PerlIO_printf(PIO_stdout,
3772 "\n(with %d registered patch%s, "
3773 "see perl -V for more detail)",
3775 (LOCAL_PATCH_COUNT!=1) ? "es" : "");
3778 PerlIO_printf(PIO_stdout,
3779 "\n\nCopyright 1987-2017, Larry Wall\n");
3781 PerlIO_printf(PIO_stdout,
3782 "\nMS-DOS port Copyright (c) 1989, 1990, Diomidis Spinellis\n");
3785 PerlIO_printf(PIO_stdout,
3786 "djgpp v2 port (jpl5003c) by Hirofumi Watanabe, 1996\n"
3787 "djgpp v2 port (perl5004+) by Laszlo Molnar, 1997-1999\n");
3790 PerlIO_printf(PIO_stdout,
3791 "\n\nOS/2 port Copyright (c) 1990, 1991, Raymond Chen, Kai Uwe Rommel\n"
3792 "Version 5 port Copyright (c) 1994-2002, Andreas Kaiser, Ilya Zakharevich\n");
3795 PerlIO_printf(PIO_stdout,
3796 "MVS (OS390) port by Mortice Kern Systems, 1997-1999\n");
3799 PerlIO_printf(PIO_stdout,
3800 "Stratus OpenVOS port by Paul.Green@stratus.com, 1997-2013\n");
3803 PerlIO_printf(PIO_stdout,
3804 "BS2000 (POSIX) port by Start Amadeus GmbH, 1998-1999\n");
3807 PerlIO_printf(PIO_stdout,
3808 "WINCE port by Rainer Keuchel, 2001-2002\n"
3809 "Built on " __DATE__ " " __TIME__ "\n\n");
3812 #ifdef __SYMBIAN32__
3813 PerlIO_printf(PIO_stdout,
3814 "Symbian port by Nokia, 2004-2005\n");
3816 #ifdef BINARY_BUILD_NOTICE
3817 BINARY_BUILD_NOTICE;
3819 PerlIO_printf(PIO_stdout,
3821 Perl may be copied only under the terms of either the Artistic License or the\n\
3822 GNU General Public License, which may be found in the Perl 5 source kit.\n\n\
3823 Complete documentation for Perl, including FAQ lists, should be found on\n\
3824 this system using \"man perl\" or \"perldoc perl\". If you have access to the\n\
3825 Internet, point your browser at http://www.perl.org/, the Perl Home Page.\n\n");
3829 /* compliments of Tom Christiansen */
3831 /* unexec() can be found in the Gnu emacs distribution */
3832 /* Known to work with -DUNEXEC and using unexelf.c from GNU emacs-20.2 */
3835 #include <lib$routines.h>
3839 Perl_my_unexec(pTHX)
3842 SV * prog = newSVpv(BIN_EXP, 0);
3843 SV * file = newSVpv(PL_origfilename, 0);
3847 sv_catpvs(prog, "/perl");
3848 sv_catpvs(file, ".perldump");
3850 unexec(SvPVX(file), SvPVX(prog), &etext, sbrk(0), 0);
3851 /* unexec prints msg to stderr in case of failure */
3852 PerlProc_exit(status);
3854 PERL_UNUSED_CONTEXT;
3856 lib$signal(SS$_DEBUG); /* ssdef.h #included from vmsish.h */
3857 # elif defined(WIN32) || defined(__CYGWIN__)
3858 Perl_croak_nocontext("dump is not supported");
3860 ABORT(); /* for use with undump */
3865 /* initialize curinterp */
3870 # define PERLVAR(prefix,var,type)
3871 # define PERLVARA(prefix,var,n,type)
3872 # if defined(PERL_IMPLICIT_CONTEXT)
3873 # define PERLVARI(prefix,var,type,init) aTHX->prefix##var = init;
3874 # define PERLVARIC(prefix,var,type,init) aTHX->prefix##var = init;
3876 # define PERLVARI(prefix,var,type,init) PERL_GET_INTERP->var = init;
3877 # define PERLVARIC(prefix,var,type,init) PERL_GET_INTERP->var = init;
3879 # include "intrpvar.h"
3885 # define PERLVAR(prefix,var,type)
3886 # define PERLVARA(prefix,var,n,type)
3887 # define PERLVARI(prefix,var,type,init) PL_##var = init;
3888 # define PERLVARIC(prefix,var,type,init) PL_##var = init;
3889 # include "intrpvar.h"
3899 S_init_main_stash(pTHX)
3904 PL_curstash = PL_defstash = (HV *)SvREFCNT_inc_simple_NN(hv);
3905 /* We know that the string "main" will be in the global shared string
3906 table, so it's a small saving to use it rather than allocate another
3908 PL_curstname = newSVpvs_share("main");
3909 gv = gv_fetchpvs("main::", GV_ADD|GV_NOTQUAL, SVt_PVHV);
3910 /* If we hadn't caused another reference to "main" to be in the shared
3911 string table above, then it would be worth reordering these two,
3912 because otherwise all we do is delete "main" from it as a consequence
3913 of the SvREFCNT_dec, only to add it again with hv_name_set */
3914 SvREFCNT_dec(GvHV(gv));
3915 hv_name_sets(PL_defstash, "main", 0);
3916 GvHV(gv) = MUTABLE_HV(SvREFCNT_inc_simple(PL_defstash));
3918 PL_incgv = gv_HVadd(gv_AVadd(gv_fetchpvs("INC", GV_ADD|GV_NOTQUAL,
3920 SvREFCNT_inc_simple_void(PL_incgv); /* Don't allow it to be freed */
3921 GvMULTI_on(PL_incgv);
3922 PL_hintgv = gv_fetchpvs("\010", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^H */
3923 SvREFCNT_inc_simple_void(PL_hintgv);
3924 GvMULTI_on(PL_hintgv);
3925 PL_defgv = gv_fetchpvs("_", GV_ADD|GV_NOTQUAL, SVt_PVAV);
3926 SvREFCNT_inc_simple_void(PL_defgv);
3927 PL_errgv = gv_fetchpvs("@", GV_ADD|GV_NOTQUAL, SVt_PV);
3928 SvREFCNT_inc_simple_void(PL_errgv);
3929 GvMULTI_on(PL_errgv);
3930 PL_replgv = gv_fetchpvs("\022", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^R */
3931 SvREFCNT_inc_simple_void(PL_replgv);
3932 GvMULTI_on(PL_replgv);
3933 (void)Perl_form(aTHX_ "%240s",""); /* Preallocate temp - for immediate signals. */
3934 #ifdef PERL_DONT_CREATE_GVSV
3935 (void)gv_SVadd(PL_errgv);
3937 sv_grow(ERRSV, 240); /* Preallocate - for immediate signals. */
3939 CopSTASH_set(&PL_compiling, PL_defstash);
3940 PL_debstash = GvHV(gv_fetchpvs("DB::", GV_ADDMULTI, SVt_PVHV));
3941 PL_globalstash = GvHV(gv_fetchpvs("CORE::GLOBAL::", GV_ADDMULTI,
3943 /* We must init $/ before switches are processed. */
3944 sv_setpvs(get_sv("/", GV_ADD), "\n");
3948 S_open_script(pTHX_ const char *scriptname, bool dosearch, bool *suidscript)
3951 PerlIO *rsfp = NULL;
3955 PERL_ARGS_ASSERT_OPEN_SCRIPT;
3958 PL_origfilename = savepvs("-e");
3963 /* if find_script() returns, it returns a malloc()-ed value */
3964 scriptname = PL_origfilename = find_script(scriptname, dosearch, NULL, 1);
3966 if (strBEGINs(scriptname, "/dev/fd/")
3967 && isDIGIT(scriptname[8])
3968 && grok_atoUV(scriptname + 8, &uv, &s)
3969 && uv <= PERL_INT_MAX
3974 * Tell apart "normal" usage of fdscript, e.g.
3975 * with bash on FreeBSD:
3976 * perl <( echo '#!perl -DA'; echo 'print "$0\n"')
3977 * from usage in suidperl.
3978 * Does any "normal" usage leave garbage after the number???
3979 * Is it a mistake to use a similar /dev/fd/ construct for
3984 * Be supersafe and do some sanity-checks.
3985 * Still, can we be sure we got the right thing?
3988 Perl_croak(aTHX_ "Wrong syntax (suid) fd script name \"%s\"\n", s);
3991 Perl_croak(aTHX_ "Missing (suid) fd script name\n");
3993 scriptname = savepv(s + 1);
3994 Safefree(PL_origfilename);
3995 PL_origfilename = (char *)scriptname;
4000 CopFILE_free(PL_curcop);
4001 CopFILE_set(PL_curcop, PL_origfilename);
4002 if (*PL_origfilename == '-' && PL_origfilename[1] == '\0')
4003 scriptname = (char *)"";
4004 if (fdscript >= 0) {
4005 rsfp = PerlIO_fdopen(fdscript,PERL_SCRIPT_MODE);
4007 else if (!*scriptname) {
4008 forbid_setid(0, *suidscript);
4012 #ifdef FAKE_BIT_BUCKET
4013 /* This hack allows one not to have /dev/null (or BIT_BUCKET as it
4014 * is called) and still have the "-e" work. (Believe it or not,
4015 * a /dev/null is required for the "-e" to work because source
4016 * filter magic is used to implement it. ) This is *not* a general
4017 * replacement for a /dev/null. What we do here is create a temp
4018 * file (an empty file), open up that as the script, and then
4019 * immediately close and unlink it. Close enough for jazz. */
4020 #define FAKE_BIT_BUCKET_PREFIX "/tmp/perlnull-"
4021 #define FAKE_BIT_BUCKET_SUFFIX "XXXXXXXX"
4022 #define FAKE_BIT_BUCKET_TEMPLATE FAKE_BIT_BUCKET_PREFIX FAKE_BIT_BUCKET_SUFFIX
4023 char tmpname[sizeof(FAKE_BIT_BUCKET_TEMPLATE)] = {
4024 FAKE_BIT_BUCKET_TEMPLATE
4026 const char * const err = "Failed to create a fake bit bucket";
4027 if (strEQ(scriptname, BIT_BUCKET)) {
4028 #ifdef HAS_MKSTEMP /* Hopefully mkstemp() is safe here. */
4029 int old_umask = umask(0177);
4030 int tmpfd = mkstemp(tmpname);
4033 scriptname = tmpname;
4036 Perl_croak(aTHX_ err);
4040 rsfp = PerlIO_open(scriptname,PERL_SCRIPT_MODE);
4041 #ifdef FAKE_BIT_BUCKET
4042 if ( strBEGINs(scriptname, FAKE_BIT_BUCKET_PREFIX)
4043 && strlen(scriptname) == sizeof(tmpname) - 1)
4047 scriptname = BIT_BUCKET;
4051 /* PSz 16 Sep 03 Keep neat error message */
4053 Perl_croak(aTHX_ "Can't open " BIT_BUCKET ": %s\n", Strerror(errno));
4055 Perl_croak(aTHX_ "Can't open perl script \"%s\": %s\n",
4056 CopFILE(PL_curcop), Strerror(errno));
4058 fd = PerlIO_fileno(rsfp);
4059 #if defined(HAS_FCNTL) && defined(F_SETFD) && defined(FD_CLOEXEC)
4061 /* ensure close-on-exec */
4062 if (fcntl(fd, F_SETFD, FD_CLOEXEC) < 0) {
4063 Perl_croak(aTHX_ "Can't open perl script \"%s\": %s\n",
4064 CopFILE(PL_curcop), Strerror(errno));
4070 (PerlLIO_fstat(fd, &tmpstatbuf) >= 0
4071 && S_ISDIR(tmpstatbuf.st_mode)))
4072 Perl_croak(aTHX_ "Can't open perl script \"%s\": %s\n",
4079 /* In the days of suidperl, we refused to execute a setuid script stored on
4080 * a filesystem mounted nosuid and/or noexec. This meant that we probed for the
4081 * existence of the appropriate filesystem-statting function, and behaved
4082 * accordingly. But even though suidperl is long gone, we must still include
4083 * those probes for the benefit of modules like Filesys::Df, which expect the
4084 * results of those probes to be stored in %Config; see RT#126368. So mention
4085 * the relevant cpp symbols here, to ensure that metaconfig will include their
4086 * probes in the generated Configure:
4088 * I_SYSSTATVFS HAS_FSTATVFS
4090 * I_STATFS HAS_FSTATFS HAS_GETFSSTAT
4091 * I_MNTENT HAS_GETMNTENT HAS_HASMNTOPT
4095 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
4096 /* Don't even need this function. */
4099 S_validate_suid(pTHX_ PerlIO *rsfp)
4101 const Uid_t my_uid = PerlProc_getuid();
4102 const Uid_t my_euid = PerlProc_geteuid();
4103 const Gid_t my_gid = PerlProc_getgid();
4104 const Gid_t my_egid = PerlProc_getegid();
4106 PERL_ARGS_ASSERT_VALIDATE_SUID;
4108 if (my_euid != my_uid || my_egid != my_gid) { /* (suidperl doesn't exist, in fact) */
4110 int fd = PerlIO_fileno(rsfp);
4112 if (fd < 0 || PerlLIO_fstat(fd, &statbuf) < 0) { /* may be either wrapped or real suid */
4113 Perl_croak_nocontext( "Illegal suidscript");
4115 if ((my_euid != my_uid && my_euid == statbuf.st_uid && statbuf.st_mode & S_ISUID)
4117 (my_egid != my_gid && my_egid == statbuf.st_gid && statbuf.st_mode & S_ISGID)
4120 Perl_croak(aTHX_ "YOU HAVEN'T DISABLED SET-ID SCRIPTS IN THE KERNEL YET!\n\
4121 FIX YOUR KERNEL, PUT A C WRAPPER AROUND THIS SCRIPT, OR USE -u AND UNDUMP!\n");
4122 /* not set-id, must be wrapped */
4125 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4128 S_find_beginning(pTHX_ SV* linestr_sv, PerlIO *rsfp)
4133 PERL_ARGS_ASSERT_FIND_BEGINNING;
4135 /* skip forward in input to the real script? */
4138 if ((s = sv_gets(linestr_sv, rsfp, 0)) == NULL)
4139 Perl_croak(aTHX_ "No Perl script found in input\n");
4141 } while (!(*s == '#' && s[1] == '!' && ((s = instr(s,"perl")) || (s = instr(s2,"PERL")))));
4142 PerlIO_ungetc(rsfp, '\n'); /* to keep line count right */
4143 while (*s && !(isSPACE (*s) || *s == '#')) s++;
4145 while (*s == ' ' || *s == '\t') s++;
4147 while (isDIGIT(s2[-1]) || s2[-1] == '-' || s2[-1] == '.'
4148 || s2[-1] == '_') s2--;
4149 if (strBEGINs(s2-4,"perl"))
4150 while ((s = moreswitches(s)))
4159 /* no need to do anything here any more if we don't
4161 #ifndef NO_TAINT_SUPPORT
4162 const Uid_t my_uid = PerlProc_getuid();
4163 const Uid_t my_euid = PerlProc_geteuid();
4164 const Gid_t my_gid = PerlProc_getgid();
4165 const Gid_t my_egid = PerlProc_getegid();
4167 PERL_UNUSED_CONTEXT;
4169 /* Should not happen: */
4170 CHECK_MALLOC_TAINT(my_uid && (my_euid != my_uid || my_egid != my_gid));
4171 TAINTING_set( TAINTING_get | (my_uid && (my_euid != my_uid || my_egid != my_gid)) );
4175 * Should go by suidscript, not uid!=euid: why disallow
4176 * system("ls") in scripts run from setuid things?
4177 * Or, is this run before we check arguments and set suidscript?
4178 * What about SETUID_SCRIPTS_ARE_SECURE_NOW: could we use fdscript then?
4179 * (We never have suidscript, can we be sure to have fdscript?)
4180 * Or must then go by UID checks? See comments in forbid_setid also.
4184 /* This is used very early in the lifetime of the program,
4185 * before even the options are parsed, so PL_tainting has
4186 * not been initialized properly. */
4188 Perl_doing_taint(int argc, char *argv[], char *envp[])
4190 #ifndef PERL_IMPLICIT_SYS
4191 /* If we have PERL_IMPLICIT_SYS we can't call getuid() et alia
4192 * before we have an interpreter-- and the whole point of this
4193 * function is to be called at such an early stage. If you are on
4194 * a system with PERL_IMPLICIT_SYS but you do have a concept of
4195 * "tainted because running with altered effective ids', you'll
4196 * have to add your own checks somewhere in here. The two most
4197 * known samples of 'implicitness' are Win32 and NetWare, neither
4198 * of which has much of concept of 'uids'. */
4199 Uid_t uid = PerlProc_getuid();
4200 Uid_t euid = PerlProc_geteuid();
4201 Gid_t gid = PerlProc_getgid();
4202 Gid_t egid = PerlProc_getegid();
4209 if (uid && (euid != uid || egid != gid))
4211 #endif /* !PERL_IMPLICIT_SYS */
4212 /* This is a really primitive check; environment gets ignored only
4213 * if -T are the first chars together; otherwise one gets
4214 * "Too late" message. */
4215 if ( argc > 1 && argv[1][0] == '-'
4216 && isALPHA_FOLD_EQ(argv[1][1], 't'))
4221 /* Passing the flag as a single char rather than a string is a slight space
4222 optimisation. The only message that isn't /^-.$/ is
4223 "program input from stdin", which is substituted in place of '\0', which
4224 could never be a command line flag. */
4226 S_forbid_setid(pTHX_ const char flag, const bool suidscript) /* g */
4228 char string[3] = "-x";
4229 const char *message = "program input from stdin";
4231 PERL_UNUSED_CONTEXT;
4237 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
4238 if (PerlProc_getuid() != PerlProc_geteuid())
4239 Perl_croak(aTHX_ "No %s allowed while running setuid", message);
4240 if (PerlProc_getgid() != PerlProc_getegid())
4241 Perl_croak(aTHX_ "No %s allowed while running setgid", message);
4242 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4244 Perl_croak(aTHX_ "No %s allowed with (suid) fdscript", message);
4248 Perl_init_dbargs(pTHX)
4250 AV *const args = PL_dbargs = GvAV(gv_AVadd((gv_fetchpvs("DB::args",
4255 /* Someone has already created it.
4256 It might have entries, and if we just turn off AvREAL(), they will
4257 "leak" until global destruction. */
4259 if (SvTIED_mg((const SV *)args, PERL_MAGIC_tied))
4260 Perl_croak(aTHX_ "Cannot set tied @DB::args");
4262 AvREIFY_only(PL_dbargs);
4266 Perl_init_debugger(pTHX)
4268 HV * const ostash = PL_curstash;
4271 PL_curstash = (HV *)SvREFCNT_inc_simple(PL_debstash);
4273 Perl_init_dbargs(aTHX);
4274 PL_DBgv = MUTABLE_GV(
4275 SvREFCNT_inc(gv_fetchpvs("DB::DB", GV_ADDMULTI, SVt_PVGV))
4277 PL_DBline = MUTABLE_GV(
4278 SvREFCNT_inc(gv_fetchpvs("DB::dbline", GV_ADDMULTI, SVt_PVAV))
4280 PL_DBsub = MUTABLE_GV(SvREFCNT_inc(
4281 gv_HVadd(gv_fetchpvs("DB::sub", GV_ADDMULTI, SVt_PVHV))
4283 PL_DBsingle = GvSV((gv_fetchpvs("DB::single", GV_ADDMULTI, SVt_PV)));
4284 if (!SvIOK(PL_DBsingle))
4285 sv_setiv(PL_DBsingle, 0);
4286 mg = sv_magicext(PL_DBsingle, NULL, PERL_MAGIC_debugvar, &PL_vtbl_debugvar, 0, 0);
4287 mg->mg_private = DBVARMG_SINGLE;
4288 SvSETMAGIC(PL_DBsingle);
4290 PL_DBtrace = GvSV((gv_fetchpvs("DB::trace", GV_ADDMULTI, SVt_PV)));
4291 if (!SvIOK(PL_DBtrace))
4292 sv_setiv(PL_DBtrace, 0);
4293 mg = sv_magicext(PL_DBtrace, NULL, PERL_MAGIC_debugvar, &PL_vtbl_debugvar, 0, 0);
4294 mg->mg_private = DBVARMG_TRACE;
4295 SvSETMAGIC(PL_DBtrace);
4297 PL_DBsignal = GvSV((gv_fetchpvs("DB::signal", GV_ADDMULTI, SVt_PV)));
4298 if (!SvIOK(PL_DBsignal))
4299 sv_setiv(PL_DBsignal, 0);
4300 mg = sv_magicext(PL_DBsignal, NULL, PERL_MAGIC_debugvar, &PL_vtbl_debugvar, 0, 0);
4301 mg->mg_private = DBVARMG_SIGNAL;
4302 SvSETMAGIC(PL_DBsignal);
4304 SvREFCNT_dec(PL_curstash);
4305 PL_curstash = ostash;
4308 #ifndef STRESS_REALLOC
4309 #define REASONABLE(size) (size)
4310 #define REASONABLE_but_at_least(size,min) (size)
4312 #define REASONABLE(size) (1) /* unreasonable */
4313 #define REASONABLE_but_at_least(size,min) (min)
4317 Perl_init_stacks(pTHX)
4321 /* start with 128-item stack and 8K cxstack */
4322 PL_curstackinfo = new_stackinfo(REASONABLE(128),
4323 REASONABLE(8192/sizeof(PERL_CONTEXT) - 1));
4324 PL_curstackinfo->si_type = PERLSI_MAIN;
4325 #if defined DEBUGGING && !defined DEBUGGING_RE_ONLY
4326 PL_curstackinfo->si_stack_hwm = 0;
4328 PL_curstack = PL_curstackinfo->si_stack;
4329 PL_mainstack = PL_curstack; /* remember in case we switch stacks */
4331 PL_stack_base = AvARRAY(PL_curstack);
4332 PL_stack_sp = PL_stack_base;
4333 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
4335 Newx(PL_tmps_stack,REASONABLE(128),SV*);
4338 PL_tmps_max = REASONABLE(128);
4340 Newx(PL_markstack,REASONABLE(32),I32);
4341 PL_markstack_ptr = PL_markstack;
4342 PL_markstack_max = PL_markstack + REASONABLE(32);
4346 Newx(PL_scopestack,REASONABLE(32),I32);
4348 Newx(PL_scopestack_name,REASONABLE(32),const char*);
4350 PL_scopestack_ix = 0;
4351 PL_scopestack_max = REASONABLE(32);
4353 size = REASONABLE_but_at_least(128,SS_MAXPUSH);
4354 Newx(PL_savestack, size, ANY);
4355 PL_savestack_ix = 0;
4356 /*PL_savestack_max lies: it always has SS_MAXPUSH more than it claims */
4357 PL_savestack_max = size - SS_MAXPUSH;
4365 while (PL_curstackinfo->si_next)
4366 PL_curstackinfo = PL_curstackinfo->si_next;
4367 while (PL_curstackinfo) {
4368 PERL_SI *p = PL_curstackinfo->si_prev;
4369 /* curstackinfo->si_stack got nuked by sv_free_arenas() */
4370 Safefree(PL_curstackinfo->si_cxstack);
4371 Safefree(PL_curstackinfo);
4372 PL_curstackinfo = p;
4374 Safefree(PL_tmps_stack);
4375 Safefree(PL_markstack);
4376 Safefree(PL_scopestack);
4378 Safefree(PL_scopestack_name);
4380 Safefree(PL_savestack);
4384 Perl_populate_isa(pTHX_ const char *name, STRLEN len, ...)
4386 GV *const gv = gv_fetchpvn(name, len, GV_ADD | GV_ADDMULTI, SVt_PVAV);
4387 AV *const isa = GvAVn(gv);
4390 PERL_ARGS_ASSERT_POPULATE_ISA;
4392 if(AvFILLp(isa) != -1)
4395 /* NOTE: No support for tied ISA */
4397 va_start(args, len);
4399 const char *const parent = va_arg(args, const char*);
4404 parent_len = va_arg(args, size_t);
4406 /* Arguments are supplied with a trailing :: */
4407 assert(parent_len > 2);
4408 assert(parent[parent_len - 1] == ':');
4409 assert(parent[parent_len - 2] == ':');
4410 av_push(isa, newSVpvn(parent, parent_len - 2));
4411 (void) gv_fetchpvn(parent, parent_len, GV_ADD, SVt_PVGV);
4418 S_init_predump_symbols(pTHX)
4423 sv_setpvs(get_sv("\"", GV_ADD), " ");
4424 PL_ofsgv = (GV*)SvREFCNT_inc(gv_fetchpvs(",", GV_ADD|GV_NOTQUAL, SVt_PV));
4427 /* Historically, PVIOs were blessed into IO::Handle, unless
4428 FileHandle was loaded, in which case they were blessed into
4429 that. Action at a distance.
4430 However, if we simply bless into IO::Handle, we break code
4431 that assumes that PVIOs will have (among others) a seek
4432 method. IO::File inherits from IO::Handle and IO::Seekable,
4433 and provides the needed methods. But if we simply bless into
4434 it, then we break code that assumed that by loading
4435 IO::Handle, *it* would work.
4436 So a compromise is to set up the correct @IO::File::ISA,
4437 so that code that does C<use IO::Handle>; will still work.
4440 Perl_populate_isa(aTHX_ STR_WITH_LEN("IO::File::ISA"),
4441 STR_WITH_LEN("IO::Handle::"),
4442 STR_WITH_LEN("IO::Seekable::"),
4443 STR_WITH_LEN("Exporter::"),
4446 PL_stdingv = gv_fetchpvs("STDIN", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4447 GvMULTI_on(PL_stdingv);
4448 io = GvIOp(PL_stdingv);
4449 IoTYPE(io) = IoTYPE_RDONLY;
4450 IoIFP(io) = PerlIO_stdin();
4451 tmpgv = gv_fetchpvs("stdin", GV_ADD|GV_NOTQUAL, SVt_PV);
4453 GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4455 tmpgv = gv_fetchpvs("STDOUT", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4458 IoTYPE(io) = IoTYPE_WRONLY;
4459 IoOFP(io) = IoIFP(io) = PerlIO_stdout();
4461 tmpgv = gv_fetchpvs("stdout", GV_ADD|GV_NOTQUAL, SVt_PV);
4463 GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4465 PL_stderrgv = gv_fetchpvs("STDERR", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4466 GvMULTI_on(PL_stderrgv);
4467 io = GvIOp(PL_stderrgv);
4468 IoTYPE(io) = IoTYPE_WRONLY;
4469 IoOFP(io) = IoIFP(io) = PerlIO_stderr();
4470 tmpgv = gv_fetchpvs("stderr", GV_ADD|GV_NOTQUAL, SVt_PV);
4472 GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4474 PL_statname = newSVpvs(""); /* last filename we did stat on */
4478 Perl_init_argv_symbols(pTHX_ int argc, char **argv)
4480 PERL_ARGS_ASSERT_INIT_ARGV_SYMBOLS;
4482 argc--,argv++; /* skip name of script */
4483 if (PL_doswitches) {
4484 for (; argc > 0 && **argv == '-'; argc--,argv++) {
4488 if (argv[0][1] == '-' && !argv[0][2]) {
4492 if ((s = strchr(argv[0], '='))) {
4493 const char *const start_name = argv[0] + 1;
4494 sv_setpv(GvSV(gv_fetchpvn_flags(start_name, s - start_name,
4495 TRUE, SVt_PV)), s + 1);
4498 sv_setiv(GvSV(gv_fetchpv(argv[0]+1, GV_ADD, SVt_PV)),1);
4501 if ((PL_argvgv = gv_fetchpvs("ARGV", GV_ADD|GV_NOTQUAL, SVt_PVAV))) {
4502 SvREFCNT_inc_simple_void_NN(PL_argvgv);
4503 GvMULTI_on(PL_argvgv);
4504 av_clear(GvAVn(PL_argvgv));
4505 for (; argc > 0; argc--,argv++) {
4506 SV * const sv = newSVpv(argv[0],0);
4507 av_push(GvAV(PL_argvgv),sv);
4508 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
4509 if (PL_unicode & PERL_UNICODE_ARGV_FLAG)
4512 if (PL_unicode & PERL_UNICODE_WIDESYSCALLS_FLAG) /* Sarathy? */
4513 (void)sv_utf8_decode(sv);
4517 if (PL_inplace && (!PL_argvgv || AvFILL(GvAV(PL_argvgv)) == -1))
4518 Perl_ck_warner_d(aTHX_ packWARN(WARN_INPLACE),
4519 "-i used with no filenames on the command line, "
4520 "reading from STDIN");
4524 S_init_postdump_symbols(pTHX_ int argc, char **argv, char **env)
4531 PERL_ARGS_ASSERT_INIT_POSTDUMP_SYMBOLS;
4533 PL_toptarget = newSV_type(SVt_PVIV);
4534 SvPVCLEAR(PL_toptarget);
4535 PL_bodytarget = newSV_type(SVt_PVIV);
4536 SvPVCLEAR(PL_bodytarget);
4537 PL_formtarget = PL_bodytarget;
4541 init_argv_symbols(argc,argv);
4543 if ((tmpgv = gv_fetchpvs("0", GV_ADD|GV_NOTQUAL, SVt_PV))) {
4544 sv_setpv(GvSV(tmpgv),PL_origfilename);
4546 if ((PL_envgv = gv_fetchpvs("ENV", GV_ADD|GV_NOTQUAL, SVt_PVHV))) {
4548 bool env_is_not_environ;
4549 SvREFCNT_inc_simple_void_NN(PL_envgv);
4550 GvMULTI_on(PL_envgv);
4551 hv = GvHVn(PL_envgv);
4552 hv_magic(hv, NULL, PERL_MAGIC_env);
4554 #ifdef USE_ENVIRON_ARRAY
4555 /* Note that if the supplied env parameter is actually a copy
4556 of the global environ then it may now point to free'd memory
4557 if the environment has been modified since. To avoid this
4558 problem we treat env==NULL as meaning 'use the default'
4562 env_is_not_environ = env != environ;
4563 if (env_is_not_environ
4564 # ifdef USE_ITHREADS
4565 && PL_curinterp == aTHX
4577 for (; *env; env++) {
4580 if (!(s = strchr(old_var,'=')) || s == old_var)
4584 #if defined(MSDOS) && !defined(DJGPP)
4586 (void)strupr(old_var);
4589 if (hv_exists(hv, old_var, nlen)) {
4590 const char *name = savepvn(old_var, nlen);
4592 /* make sure we use the same value as getenv(), otherwise code that
4593 uses getenv() (like setlocale()) might see a different value to %ENV
4595 sv = newSVpv(PerlEnv_getenv(name), 0);
4597 /* keep a count of the dups of this name so we can de-dup environ later */
4598 if (hv_exists(dups, name, nlen))
4599 ++SvIVX(*hv_fetch(dups, name, nlen, 0));
4601 (void)hv_store(dups, name, nlen, newSViv(1), 0);
4606 sv = newSVpv(s+1, 0);
4608 (void)hv_store(hv, old_var, nlen, sv, 0);
4609 if (env_is_not_environ)
4613 /* environ has some duplicate definitions, remove them */
4616 while ((entry = hv_iternext_flags(dups, 0))) {
4618 const char *name = HePV(entry, nlen);
4619 IV count = SvIV(HeVAL(entry));
4621 SV **valp = hv_fetch(hv, name, nlen, 0);
4625 /* try to remove any duplicate names, depending on the
4626 * implementation used in my_setenv() the iteration might
4627 * not be necessary, but let's be safe.
4629 for (i = 0; i < count; ++i)
4632 /* and set it back to the value we set $ENV{name} to */
4633 my_setenv(name, SvPV_nolen(*valp));
4636 SvREFCNT_dec_NN(dups);
4638 #endif /* USE_ENVIRON_ARRAY */
4639 #endif /* !PERL_MICRO */
4643 /* touch @F array to prevent spurious warnings 20020415 MJD */
4645 (void) get_av("main::F", GV_ADD | GV_ADDMULTI);
4650 S_init_perllib(pTHX)
4653 const char *perl5lib = NULL;
4656 #if defined(WIN32) && !defined(PERL_IS_MINIPERL)
4660 if (!TAINTING_get) {
4662 perl5lib = PerlEnv_getenv("PERL5LIB");
4664 * It isn't possible to delete an environment variable with
4665 * PERL_USE_SAFE_PUTENV set unless unsetenv() is also available, so in that
4666 * case we treat PERL5LIB as undefined if it has a zero-length value.
4668 #if defined(PERL_USE_SAFE_PUTENV) && ! defined(HAS_UNSETENV)
4669 if (perl5lib && *perl5lib != '\0')
4673 incpush_use_sep(perl5lib, 0, INCPUSH_ADD_SUB_DIRS);
4675 s = PerlEnv_getenv("PERLLIB");
4677 incpush_use_sep(s, 0, 0);
4680 /* Treat PERL5?LIB as a possible search list logical name -- the
4681 * "natural" VMS idiom for a Unix path string. We allow each
4682 * element to be a set of |-separated directories for compatibility.
4686 if (vmstrnenv("PERL5LIB",buf,0,NULL,0))
4688 incpush_use_sep(buf, 0, INCPUSH_ADD_SUB_DIRS);
4689 } while (vmstrnenv("PERL5LIB",buf,++idx,NULL,0));
4691 while (vmstrnenv("PERLLIB",buf,idx++,NULL,0))
4692 incpush_use_sep(buf, 0, 0);
4697 #ifndef PERL_IS_MINIPERL
4698 /* miniperl gets just -I..., the split of $ENV{PERL5LIB}, and "." in @INC
4699 (and not the architecture specific directories from $ENV{PERL5LIB}) */
4701 #include "perl_inc_macro.h"
4702 /* Use the ~-expanded versions of APPLLIB (undocumented),
4703 SITEARCH, SITELIB, VENDORARCH, VENDORLIB, ARCHLIB and PRIVLIB
4706 INCPUSH_SITEARCH_EXP
4708 INCPUSH_PERL_VENDORARCH_EXP
4709 INCPUSH_PERL_VENDORLIB_EXP
4712 INCPUSH_PERL_OTHERLIBDIRS
4714 INCPUSH_APPLLIB_OLD_EXP
4715 INCPUSH_SITELIB_STEM
4716 INCPUSH_PERL_VENDORLIB_STEM
4717 INCPUSH_PERL_OTHERLIBDIRS_ARCHONLY
4719 #endif /* !PERL_IS_MINIPERL */
4721 if (!TAINTING_get) {
4722 #if !defined(PERL_IS_MINIPERL) && defined(DEFAULT_INC_EXCLUDES_DOT)
4723 const char * const unsafe = PerlEnv_getenv("PERL_USE_UNSAFE_INC");
4724 if (unsafe && strEQ(unsafe, "1"))
4726 S_incpush(aTHX_ STR_WITH_LEN("."), 0);
4730 #if defined(DOSISH) || defined(__SYMBIAN32__)
4731 # define PERLLIB_SEP ';'
4732 #elif defined(__VMS)
4733 # define PERLLIB_SEP PL_perllib_sep
4735 # define PERLLIB_SEP ':'
4737 #ifndef PERLLIB_MANGLE
4738 # define PERLLIB_MANGLE(s,n) (s)
4741 #ifndef PERL_IS_MINIPERL
4742 /* Push a directory onto @INC if it exists.
4743 Generate a new SV if we do this, to save needing to copy the SV we push
4746 S_incpush_if_exists(pTHX_ AV *const av, SV *dir, SV *const stem)
4750 PERL_ARGS_ASSERT_INCPUSH_IF_EXISTS;
4752 if (PerlLIO_stat(SvPVX_const(dir), &tmpstatbuf) >= 0 &&
4753 S_ISDIR(tmpstatbuf.st_mode)) {
4755 dir = newSVsv(stem);
4757 /* Truncate dir back to stem. */
4758 SvCUR_set(dir, SvCUR(stem));
4765 S_mayberelocate(pTHX_ const char *const dir, STRLEN len, U32 flags)
4767 const U8 canrelocate = (U8)flags & INCPUSH_CAN_RELOCATE;
4770 PERL_ARGS_ASSERT_MAYBERELOCATE;
4773 /* I am not convinced that this is valid when PERLLIB_MANGLE is
4774 defined to so something (in os2/os2.c), but the code has been
4775 this way, ignoring any possible changed of length, since
4776 760ac839baf413929cd31cc32ffd6dba6b781a81 (5.003_02) so I'll leave
4778 libdir = newSVpvn(PERLLIB_MANGLE(dir, len), len);
4784 if ((unix = tounixspec_ts(SvPV(libdir,len),NULL)) != NULL) {
4786 while (len > 1 && unix[len-1] == '/') len--; /* Cosmetic */
4787 sv_usepvn(libdir,unix,len);
4790 PerlIO_printf(Perl_error_log,
4791 "Failed to unixify @INC element \"%s\"\n",
4792 SvPV_nolen_const(libdir));
4796 /* Do the if() outside the #ifdef to avoid warnings about an unused
4799 #ifdef PERL_RELOCATABLE_INC
4801 * Relocatable include entries are marked with a leading .../
4804 * 0: Remove that leading ".../"
4805 * 1: Remove trailing executable name (anything after the last '/')
4806 * from the perl path to give a perl prefix
4808 * While the @INC element starts "../" and the prefix ends with a real
4809 * directory (ie not . or ..) chop that real directory off the prefix
4810 * and the leading "../" from the @INC element. ie a logical "../"
4812 * Finally concatenate the prefix and the remainder of the @INC element
4813 * The intent is that /usr/local/bin/perl and .../../lib/perl5
4814 * generates /usr/local/lib/perl5
4816 const char *libpath = SvPVX(libdir);
4817 STRLEN libpath_len = SvCUR(libdir);
4818 if (memBEGINs(libpath, libpath_len, ".../")) {
4820 SV * const caret_X = get_sv("\030", 0);
4821 /* Going to use the SV just as a scratch buffer holding a C
4827 /* $^X is *the* source of taint if tainting is on, hence
4828 SvPOK() won't be true. */
4830 assert(SvPOKp(caret_X));
4831 prefix_sv = newSVpvn_flags(SvPVX(caret_X), SvCUR(caret_X),
4833 /* Firstly take off the leading .../
4834 If all else fail we'll do the paths relative to the current
4836 sv_chop(libdir, libpath + 4);
4837 /* Don't use SvPV as we're intentionally bypassing taining,
4838 mortal copies that the mg_get of tainting creates, and
4839 corruption that seems to come via the save stack.
4840 I guess that the save stack isn't correctly set up yet. */
4841 libpath = SvPVX(libdir);
4842 libpath_len = SvCUR(libdir);