4 * Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001
5 * 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
6 * 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021, 2022
7 * by Larry Wall and others
9 * You may distribute under the terms of either the GNU General Public
10 * License or the Artistic License, as specified in the README file.
15 * A ship then new they built for him
16 * of mithril and of elven-glass
17 * --from Bilbo's song of EƤrendil
19 * [p.236 of _The Lord of the Rings_, II/i: "Many Meetings"]
22 /* This file contains the top-level functions that are used to create, use
23 * and destroy a perl interpreter, plus the functions used by XS code to
24 * call back into perl. Note that it does not contain the actual main()
25 * function of the interpreter; that can be found in perlmain.c
27 * Note that at build time this file is also linked to as perlmini.c,
28 * and perlmini.o is then built with PERL_IS_MINIPERL defined, which is
29 * then used to create the miniperl executable, rather than perl.o.
32 #if defined(PERL_IS_MINIPERL) && !defined(USE_SITECUSTOMIZE)
33 # define USE_SITECUSTOMIZE
37 #define PERL_IN_PERL_C
39 #include "patchlevel.h" /* for local_patches */
42 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
49 char control[CMSG_SPACE(sizeof(int))];
62 static I32 read_e_script(pTHX_ int idx, SV *buf_sv, int maxlen);
64 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
65 # define validate_suid(rsfp) NOOP
67 # define validate_suid(rsfp) S_validate_suid(aTHX_ rsfp)
70 #define CALL_BODY_SUB(myop) \
71 if (PL_op == (myop)) \
72 PL_op = PL_ppaddr[OP_ENTERSUB](aTHX); \
76 #define CALL_LIST_BODY(cv) \
77 PUSHMARK(PL_stack_sp); \
78 call_sv(MUTABLE_SV((cv)), G_EVAL|G_DISCARD|G_VOID);
81 S_init_tls_and_interp(PerlInterpreter *my_perl)
84 PERL_SET_INTERP(my_perl);
85 #if defined(USE_ITHREADS)
88 PERL_SET_THX(my_perl);
91 KEYWORD_PLUGIN_MUTEX_INIT;
96 MUTEX_INIT(&PL_dollarzero_mutex);
97 MUTEX_INIT(&PL_my_ctx_mutex);
100 #if defined(USE_ITHREADS)
103 /* This always happens for non-ithreads */
106 PERL_SET_THX(my_perl);
111 #ifndef PLATFORM_SYS_INIT_
112 # define PLATFORM_SYS_INIT_ NOOP
115 #ifndef PLATFORM_SYS_TERM_
116 # define PLATFORM_SYS_TERM_ NOOP
119 #ifndef PERL_SYS_INIT_BODY
120 # define PERL_SYS_INIT_BODY(c,v) \
121 MALLOC_CHECK_TAINT2(*c,*v) PERL_FPU_INIT; PERLIO_INIT; \
122 MALLOC_INIT; PLATFORM_SYS_INIT_;
125 /* Generally add things last-in first-terminated. IO and memory terminations
126 * need to be generally last
128 * BEWARE that using PerlIO in these will be using freed memory, so may appear
129 * to work, but must NOT be retained in production code. */
130 #ifndef PERL_SYS_TERM_BODY
131 # define PERL_SYS_TERM_BODY() \
132 ENV_TERM; USER_PROP_MUTEX_TERM; LOCALE_TERM; \
133 HINTS_REFCNT_TERM; KEYWORD_PLUGIN_MUTEX_TERM; \
134 OP_CHECK_MUTEX_TERM; OP_REFCNT_TERM; \
135 PERLIO_TERM; MALLOC_TERM; \
139 /* these implement the PERL_SYS_INIT, PERL_SYS_INIT3, PERL_SYS_TERM macros */
142 Perl_sys_init(int* argc, char*** argv)
145 PERL_ARGS_ASSERT_SYS_INIT;
147 PERL_UNUSED_ARG(argc); /* may not be used depending on _BODY macro */
148 PERL_UNUSED_ARG(argv);
149 PERL_SYS_INIT_BODY(argc, argv);
153 Perl_sys_init3(int* argc, char*** argv, char*** env)
156 PERL_ARGS_ASSERT_SYS_INIT3;
158 PERL_UNUSED_ARG(argc); /* may not be used depending on _BODY macro */
159 PERL_UNUSED_ARG(argv);
160 PERL_UNUSED_ARG(env);
161 PERL_SYS_INIT3_BODY(argc, argv, env);
167 if (!PL_veto_cleanup) {
168 PERL_SYS_TERM_BODY();
173 #ifdef PERL_IMPLICIT_SYS
175 perl_alloc_using(struct IPerlMem* ipM, struct IPerlMem* ipMS,
176 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
177 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
178 struct IPerlDir* ipD, struct IPerlSock* ipS,
179 struct IPerlProc* ipP)
181 PerlInterpreter *my_perl;
183 PERL_ARGS_ASSERT_PERL_ALLOC_USING;
185 /* Newx() needs interpreter, so call malloc() instead */
186 my_perl = (PerlInterpreter*)(*ipM->pCalloc)(ipM, 1, sizeof(PerlInterpreter));
187 S_init_tls_and_interp(my_perl);
197 INIT_TRACK_MEMPOOL(PL_memory_debug_header, my_perl);
204 =for apidoc_section $embedding
206 =for apidoc perl_alloc
208 Allocates a new Perl interpreter. See L<perlembed>.
216 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_calloc(1, sizeof(PerlInterpreter));
218 S_init_tls_and_interp(my_perl);
219 INIT_TRACK_MEMPOOL(PL_memory_debug_header, my_perl);
222 #endif /* PERL_IMPLICIT_SYS */
225 =for apidoc perl_construct
227 Initializes a new Perl interpreter. See L<perlembed>.
233 perl_construct(pTHXx)
236 PERL_ARGS_ASSERT_PERL_CONSTRUCT;
240 PL_perl_destruct_level = 1;
242 PERL_UNUSED_ARG(my_perl);
243 if (PL_perl_destruct_level > 0)
246 PL_curcop = &PL_compiling; /* needed by ckWARN, right away */
248 #ifdef PERL_TRACE_OPS
249 Zero(PL_op_exec_cnt, OP_max+2, UV);
254 SvREADONLY_on(&PL_sv_placeholder);
255 SvREFCNT(&PL_sv_placeholder) = SvREFCNT_IMMORTAL;
257 PL_sighandlerp = Perl_sighandler;
258 PL_sighandler1p = Perl_sighandler1;
259 PL_sighandler3p = Perl_sighandler3;
261 #ifdef PERL_USES_PL_PIDSTATUS
262 PL_pidstatus = newHV();
265 PL_rs = newSVpvs("\n");
269 #if !defined(NO_PERL_RAND_SEED) || !defined(NO_PERL_INTERNAL_HASH_SEED)
270 bool sensitive_env_vars_allowed =
271 (PerlProc_getuid() == PerlProc_geteuid() &&
272 PerlProc_getgid() == PerlProc_getegid()) ? TRUE : FALSE;
275 /* The seed set-up must be after init_stacks because it calls
276 * things that may put SVs on the stack.
278 #ifndef NO_PERL_RAND_SEED
279 if (sensitive_env_vars_allowed) {
282 if ((env_pv = PerlEnv_getenv("PERL_RAND_SEED")) &&
283 grok_number(env_pv, strlen(env_pv), &seed) == IS_NUMBER_IN_UV)
286 PL_srand_override_next = seed;
287 PERL_SRAND_OVERRIDE_NEXT_INIT();
292 /* This is NOT the state used for C<rand()>, this is only
293 * used in internal functionality */
294 #ifdef NO_PERL_INTERNAL_RAND_SEED
295 Perl_drand48_init_r(&PL_internal_random_state, seed());
301 !sensitive_env_vars_allowed ||
302 !(env_pv = PerlEnv_getenv("PERL_INTERNAL_RAND_SEED")) ||
303 grok_number(env_pv, strlen(env_pv), &seed) != IS_NUMBER_IN_UV)
305 /* use a randomly generated seed */
308 Perl_drand48_init_r(&PL_internal_random_state, (U32)seed);
318 (void) uvchr_to_utf8_flags((U8 *) PL_TR_SPECIAL_HANDLING_UTF8,
320 UNICODE_ALLOW_ABOVE_IV_MAX);
322 #if defined(LOCAL_PATCH_COUNT)
323 PL_localpatches = local_patches; /* For possible -v */
326 #if defined(LIBM_LIB_VERSION)
328 * Some BSDs and Cygwin default to POSIX math instead of IEEE.
329 * This switches them over to IEEE.
331 _LIB_VERSION = _IEEE_;
334 #ifdef HAVE_INTERP_INTERN
338 PerlIO_init(aTHX); /* Hook to IO system */
340 PL_fdpid = newAV(); /* for remembering popen pids by fd */
341 PL_modglobal = newHV(); /* pointers to per-interpreter module globals */
342 PL_errors = newSVpvs("");
343 SvPVCLEAR(PERL_DEBUG_PAD(0)); /* For regex debugging. */
344 SvPVCLEAR(PERL_DEBUG_PAD(1)); /* ext/re needs these */
345 SvPVCLEAR(PERL_DEBUG_PAD(2)); /* even without DEBUGGING. */
347 /* First entry is a list of empty elements. It needs to be initialised
348 else all hell breaks loose in S_find_uninit_var(). */
349 Perl_av_create_and_push(aTHX_ &PL_regex_padav, newSVpvs(""));
350 PL_regex_pad = AvARRAY(PL_regex_padav);
351 Newxz(PL_stashpad, PL_stashpadmax, HV *);
353 #ifdef USE_REENTRANT_API
354 Perl_reentrant_init(aTHX);
356 if (PL_hash_seed_set == FALSE) {
357 /* Initialize the hash seed and state at startup. This must be
358 * done very early, before ANY hashes are constructed, and once
359 * setup is fixed for the lifetime of the process.
361 * If you decide to disable the seeding process you should choose
362 * a suitable seed yourself and define PERL_HASH_SEED to a well chosen
363 * string. See hv_func.h for details.
365 #if defined(USE_HASH_SEED)
366 /* get the hash seed from the environment or from an RNG */
367 Perl_get_hash_seed(aTHX_ PL_hash_seed);
369 /* they want a hard coded seed, check that it is long enough */
370 assert( strlen(PERL_HASH_SEED) >= PERL_HASH_SEED_BYTES );
373 /* now we use the chosen seed to initialize the state -
374 * in some configurations this may be a relatively speaking
375 * expensive operation, but we only have to do it once at startup */
376 PERL_HASH_SEED_STATE(PERL_HASH_SEED,PL_hash_state);
378 #ifdef PERL_USE_SINGLE_CHAR_HASH_CACHE
379 /* we can build a special cache for 0/1 byte keys, if people choose
380 * I suspect most of the time it is not worth it */
384 for (i=0;i<256;i++) {
386 PERL_HASH_WITH_STATE(PL_hash_state,PL_hash_chars[i],str,1);
388 PERL_HASH_WITH_STATE(PL_hash_state,PL_hash_chars[256],str,0);
391 /* at this point we have initialezed the hash function, and we can start
392 * constructing hashes */
393 PL_hash_seed_set= TRUE;
396 /* Allow PL_strtab to be pre-initialized before calling perl_construct.
397 * can use a custom optimized PL_strtab hash before calling perl_construct */
399 /* Note that strtab is a rather special HV. Assumptions are made
400 about not iterating on it, and not adding tie magic to it.
401 It is properly deallocated in perl_destruct() */
404 /* SHAREKEYS tells us that the hash has its keys shared with PL_strtab,
405 * which is not the case with PL_strtab itself */
406 HvSHAREKEYS_off(PL_strtab); /* mandatory */
407 hv_ksplit(PL_strtab, 1 << 11);
410 Zero(PL_sv_consts, SV_CONSTS_COUNT, SV*);
413 # ifdef USE_ENVIRON_ARRAY
415 PL_origenviron = environ;
419 /* Use sysconf(_SC_CLK_TCK) if available, if not
420 * available or if the sysconf() fails, use the HZ.
421 * The HZ if not originally defined has been by now
422 * been defined as CLK_TCK, if available. */
423 #if defined(HAS_SYSCONF) && defined(_SC_CLK_TCK)
424 PL_clocktick = sysconf(_SC_CLK_TCK);
425 if (PL_clocktick <= 0)
429 PL_stashcache = newHV();
431 PL_patchlevel = newSVpvs("v" PERL_VERSION_STRING);
434 if (!PL_mmap_page_size) {
435 #if defined(HAS_SYSCONF) && (defined(_SC_PAGESIZE) || defined(_SC_MMAP_PAGE_SIZE))
437 SETERRNO(0, SS_NORMAL);
439 PL_mmap_page_size = sysconf(_SC_PAGESIZE);
441 PL_mmap_page_size = sysconf(_SC_MMAP_PAGE_SIZE);
443 if ((long) PL_mmap_page_size < 0) {
444 Perl_croak(aTHX_ "panic: sysconf: %s",
445 errno ? Strerror(errno) : "pagesize unknown");
448 #elif defined(HAS_GETPAGESIZE)
449 PL_mmap_page_size = getpagesize();
450 #elif defined(I_SYS_PARAM) && defined(PAGESIZE)
451 PL_mmap_page_size = PAGESIZE; /* compiletime, bad */
453 if (PL_mmap_page_size <= 0)
454 Perl_croak(aTHX_ "panic: bad pagesize %" IVdf,
455 (IV) PL_mmap_page_size);
457 #endif /* HAS_MMAP */
459 PL_osname = Perl_savepvn(aTHX_ STR_WITH_LEN(OSNAME));
461 PL_registered_mros = newHV();
462 /* Start with 1 bucket, for DFS. It's unlikely we'll need more. */
463 HvMAX(PL_registered_mros) = 0;
470 =for apidoc nothreadhook
472 Stub that provides thread hook for perl_destruct when there are
479 Perl_nothreadhook(pTHX)
485 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
487 Perl_dump_sv_child(pTHX_ SV *sv)
490 const int sock = PL_dumper_fd;
491 const int debug_fd = PerlIO_fileno(Perl_debug_log);
492 union control_un control;
495 struct cmsghdr *cmptr;
497 unsigned char buffer[256];
499 PERL_ARGS_ASSERT_DUMP_SV_CHILD;
501 if(sock == -1 || debug_fd == -1)
504 PerlIO_flush(Perl_debug_log);
506 /* All these shenanigans are to pass a file descriptor over to our child for
507 it to dump out to. We can't let it hold open the file descriptor when it
508 forks, as the file descriptor it will dump to can turn out to be one end
509 of pipe that some other process will wait on for EOF. (So as it would
510 be open, the wait would be forever.) */
512 msg.msg_control = control.control;
513 msg.msg_controllen = sizeof(control.control);
514 /* We're a connected socket so we don't need a destination */
520 cmptr = CMSG_FIRSTHDR(&msg);
521 cmptr->cmsg_len = CMSG_LEN(sizeof(int));
522 cmptr->cmsg_level = SOL_SOCKET;
523 cmptr->cmsg_type = SCM_RIGHTS;
524 *((int *)CMSG_DATA(cmptr)) = 1;
526 vec[0].iov_base = (void*)&sv;
527 vec[0].iov_len = sizeof(sv);
528 got = sendmsg(sock, &msg, 0);
531 perror("Debug leaking scalars parent sendmsg failed");
534 if(got < sizeof(sv)) {
535 perror("Debug leaking scalars parent short sendmsg");
539 /* Return protocol is
541 unsigned char: length of location string (0 for empty)
542 unsigned char*: string (not terminated)
544 vec[0].iov_base = (void*)&returned_errno;
545 vec[0].iov_len = sizeof(returned_errno);
546 vec[1].iov_base = buffer;
549 got = readv(sock, vec, 2);
552 perror("Debug leaking scalars parent read failed");
553 PerlIO_flush(PerlIO_stderr());
556 if(got < sizeof(returned_errno) + 1) {
557 perror("Debug leaking scalars parent short read");
558 PerlIO_flush(PerlIO_stderr());
563 got = read(sock, buffer + 1, *buffer);
565 perror("Debug leaking scalars parent read 2 failed");
566 PerlIO_flush(PerlIO_stderr());
571 perror("Debug leaking scalars parent short read 2");
572 PerlIO_flush(PerlIO_stderr());
577 if (returned_errno || *buffer) {
578 Perl_warn(aTHX_ "Debug leaking scalars child failed%s%.*s with errno"
579 " %d: %s", (*buffer ? " at " : ""), (int) *buffer, buffer + 1,
580 returned_errno, Strerror(returned_errno));
586 =for apidoc perl_destruct
588 Shuts down a Perl interpreter. See L<perlembed> for a tutorial.
590 C<my_perl> points to the Perl interpreter. It must have been previously
591 created through the use of L</perl_alloc> and L</perl_construct>. It may
592 have been initialised through L</perl_parse>, and may have been used
593 through L</perl_run> and other means. This function should be called for
594 any Perl interpreter that has been constructed with L</perl_construct>,
595 even if subsequent operations on it failed, for example if L</perl_parse>
596 returned a non-zero value.
598 If the interpreter's C<PL_exit_flags> word has the
599 C<PERL_EXIT_DESTRUCT_END> flag set, then this function will execute code
600 in C<END> blocks before performing the rest of destruction. If it is
601 desired to make any use of the interpreter between L</perl_parse> and
602 L</perl_destruct> other than just calling L</perl_run>, then this flag
603 should be set early on. This matters if L</perl_run> will not be called,
604 or if anything else will be done in addition to calling L</perl_run>.
606 Returns a value be a suitable value to pass to the C library function
607 C<exit> (or to return from C<main>), to serve as an exit code indicating
608 the nature of the way the interpreter terminated. This takes into account
609 any failure of L</perl_parse> and any early exit from L</perl_run>.
610 The exit code is of the type required by the host operating system,
611 so because of differing exit code conventions it is not portable to
612 interpret specific numeric values as having specific meanings.
620 volatile signed char destruct_level; /* see possible values in intrpvar.h */
622 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
627 PERL_ARGS_ASSERT_PERL_DESTRUCT;
629 PERL_UNUSED_ARG(my_perl);
632 assert(PL_scopestack_ix == 1);
634 /* wait for all pseudo-forked children to finish */
635 PERL_WAIT_FOR_CHILDREN;
637 destruct_level = PL_perl_destruct_level;
639 const char * const s = PerlEnv_getenv("PERL_DESTRUCT_LEVEL");
642 if (strEQ(s, "-1")) { /* Special case: modperl folklore. */
646 if (grok_atoUV(s, &uv, NULL) && uv <= INT_MAX)
651 if (destruct_level < i) destruct_level = i;
652 #ifdef PERL_TRACK_MEMPOOL
653 /* RT #114496, for perl_free */
654 PL_perl_destruct_level = i;
659 if (PL_exit_flags & PERL_EXIT_DESTRUCT_END) {
665 if (PL_endav && !PL_minus_c) {
666 PERL_SET_PHASE(PERL_PHASE_END);
667 call_list(PL_scopestack_ix, PL_endav);
673 assert(PL_scopestack_ix == 0);
675 /* normally when we get here, PL_parser should be null due to having
676 * its original (null) value restored by SAVEt_PARSER during leaving
677 * scope (usually before run-time starts in fact).
678 * But if a thread is created within a BEGIN block, the parser is
679 * duped, but the SAVEt_PARSER savestack entry isn't. So PL_parser
680 * never gets cleaned up.
681 * Clean it up here instead. This is a bit of a hack.
684 /* stop parser_free() stomping on PL_curcop */
685 PL_parser->saved_curcop = PL_curcop;
686 parser_free(PL_parser);
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\n",
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(PerlSock_socketpair_cloexec(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 (PerlLIO_dup2_cloexec(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 if (destruct_level == 0) {
949 DEBUG_P(debprofdump());
951 #if defined(PERLIO_LAYERS)
952 /* No more IO - including error messages ! */
953 PerlIO_cleanup(aTHX);
956 CopFILE_free(&PL_compiling);
958 /* The exit() function will do everything that needs doing. */
962 /* Below, do clean up for when PERL_DESTRUCT_LEVEL is not 0 */
965 /* the syntax tree is shared between clones
966 * so op_free(PL_main_root) only ReREFCNT_dec's
967 * REGEXPs in the parent interpreter
968 * we need to manually ReREFCNT_dec for the clones
971 I32 i = AvFILLp(PL_regex_padav);
972 SV **ary = AvARRAY(PL_regex_padav);
975 SvREFCNT_dec(ary[i]);
976 ary[i] = &PL_sv_undef;
982 SvREFCNT_dec(MUTABLE_SV(PL_stashcache));
983 PL_stashcache = NULL;
985 /* loosen bonds of global variables */
987 /* XXX can PL_parser still be non-null here? */
988 if(PL_parser && PL_parser->rsfp) {
989 (void)PerlIO_close(PL_parser->rsfp);
990 PL_parser->rsfp = NULL;
994 Safefree(PL_splitstr);
1004 PL_doswitches = FALSE;
1005 PL_dowarn = G_WARN_OFF;
1006 #ifdef PERL_SAWAMPERSAND
1007 PL_sawampersand = 0; /* must save all match strings */
1011 Safefree(PL_inplace);
1013 SvREFCNT_dec(PL_patchlevel);
1016 SvREFCNT_dec(PL_e_script);
1022 /* magical thingies */
1024 SvREFCNT_dec(PL_ofsgv); /* *, */
1027 SvREFCNT_dec(PL_ors_sv); /* $\ */
1030 SvREFCNT_dec(PL_rs); /* $/ */
1033 Safefree(PL_osname); /* $^O */
1036 SvREFCNT_dec(PL_statname);
1040 /* defgv, aka *_ should be taken care of elsewhere */
1043 Safefree(PL_efloatbuf);
1044 PL_efloatbuf = NULL;
1047 /* startup and shutdown function lists */
1048 SvREFCNT_dec(PL_beginav);
1049 SvREFCNT_dec(PL_beginav_save);
1050 SvREFCNT_dec(PL_endav);
1051 SvREFCNT_dec(PL_checkav);
1052 SvREFCNT_dec(PL_checkav_save);
1053 SvREFCNT_dec(PL_unitcheckav);
1054 SvREFCNT_dec(PL_unitcheckav_save);
1055 SvREFCNT_dec(PL_initav);
1057 PL_beginav_save = NULL;
1060 PL_checkav_save = NULL;
1061 PL_unitcheckav = NULL;
1062 PL_unitcheckav_save = NULL;
1065 /* shortcuts just get cleared */
1068 PL_argvoutgv = NULL;
1071 PL_last_in_gv = NULL;
1082 SvREFCNT_dec(PL_envgv);
1083 SvREFCNT_dec(PL_incgv);
1084 SvREFCNT_dec(PL_argvgv);
1085 SvREFCNT_dec(PL_replgv);
1086 SvREFCNT_dec(PL_DBgv);
1087 SvREFCNT_dec(PL_DBline);
1088 SvREFCNT_dec(PL_DBsub);
1097 SvREFCNT_dec(PL_argvout_stack);
1098 PL_argvout_stack = NULL;
1100 SvREFCNT_dec(PL_modglobal);
1101 PL_modglobal = NULL;
1102 SvREFCNT_dec(PL_preambleav);
1103 PL_preambleav = NULL;
1104 SvREFCNT_dec(PL_subname);
1106 #ifdef PERL_USES_PL_PIDSTATUS
1107 SvREFCNT_dec(PL_pidstatus);
1108 PL_pidstatus = NULL;
1110 SvREFCNT_dec(PL_toptarget);
1111 PL_toptarget = NULL;
1112 SvREFCNT_dec(PL_bodytarget);
1113 PL_bodytarget = NULL;
1114 PL_formtarget = NULL;
1116 /* free locale stuff */
1117 #ifdef USE_LOCALE_COLLATE
1118 Safefree(PL_collation_name);
1119 PL_collation_name = NULL;
1121 #if defined(USE_POSIX_2008_LOCALE) \
1122 && defined(USE_THREAD_SAFE_LOCALE) \
1123 && ! defined(HAS_QUERYLOCALE)
1124 for (i = 0; i < (int) C_ARRAY_LENGTH(PL_curlocales); i++) {
1125 Safefree(PL_curlocales[i]);
1126 PL_curlocales[i] = NULL;
1129 #ifdef USE_POSIX_2008_LOCALE
1131 /* This also makes sure we aren't using a locale object that gets freed
1133 const locale_t old_locale = uselocale(LC_GLOBAL_LOCALE);
1134 if ( old_locale != LC_GLOBAL_LOCALE
1135 # ifdef USE_POSIX_2008_LOCALE
1136 && old_locale != PL_C_locale_obj
1139 DEBUG_Lv(PerlIO_printf(Perl_debug_log,
1140 "%s:%d: Freeing %p\n", __FILE__, __LINE__, old_locale));
1141 freelocale(old_locale);
1144 if (PL_scratch_locale_obj) {
1145 freelocale(PL_scratch_locale_obj);
1146 PL_scratch_locale_obj = NULL;
1148 # ifdef USE_LOCALE_NUMERIC
1149 if (PL_underlying_numeric_obj) {
1150 DEBUG_Lv(PerlIO_printf(Perl_debug_log,
1151 "%s:%d: Freeing %p\n", __FILE__, __LINE__,
1152 PL_underlying_numeric_obj));
1153 freelocale(PL_underlying_numeric_obj);
1154 PL_underlying_numeric_obj = (locale_t) NULL;
1158 #ifdef USE_LOCALE_NUMERIC
1159 Safefree(PL_numeric_name);
1160 PL_numeric_name = NULL;
1161 SvREFCNT_dec(PL_numeric_radix_sv);
1162 PL_numeric_radix_sv = NULL;
1165 if (PL_setlocale_buf) {
1166 Safefree(PL_setlocale_buf);
1167 PL_setlocale_buf = NULL;
1170 if (PL_langinfo_buf) {
1171 Safefree(PL_langinfo_buf);
1172 PL_langinfo_buf = NULL;
1175 if (PL_stdize_locale_buf) {
1176 Safefree(PL_stdize_locale_buf);
1177 PL_stdize_locale_buf = NULL;
1180 #ifdef USE_LOCALE_CTYPE
1181 SvREFCNT_dec(PL_warn_locale);
1182 PL_warn_locale = NULL;
1185 SvREFCNT_dec(PL_AboveLatin1);
1186 PL_AboveLatin1 = NULL;
1187 SvREFCNT_dec(PL_Assigned_invlist);
1188 PL_Assigned_invlist = NULL;
1189 SvREFCNT_dec(PL_GCB_invlist);
1190 PL_GCB_invlist = NULL;
1191 SvREFCNT_dec(PL_HasMultiCharFold);
1192 PL_HasMultiCharFold = NULL;
1193 SvREFCNT_dec(PL_InMultiCharFold);
1194 PL_InMultiCharFold = NULL;
1195 SvREFCNT_dec(PL_Latin1);
1197 SvREFCNT_dec(PL_LB_invlist);
1198 PL_LB_invlist = NULL;
1199 SvREFCNT_dec(PL_SB_invlist);
1200 PL_SB_invlist = NULL;
1201 SvREFCNT_dec(PL_SCX_invlist);
1202 PL_SCX_invlist = NULL;
1203 SvREFCNT_dec(PL_UpperLatin1);
1204 PL_UpperLatin1 = NULL;
1205 SvREFCNT_dec(PL_in_some_fold);
1206 PL_in_some_fold = NULL;
1207 SvREFCNT_dec(PL_utf8_foldclosures);
1208 PL_utf8_foldclosures = NULL;
1209 SvREFCNT_dec(PL_utf8_idcont);
1210 PL_utf8_idcont = NULL;
1211 SvREFCNT_dec(PL_utf8_idstart);
1212 PL_utf8_idstart = NULL;
1213 SvREFCNT_dec(PL_utf8_perl_idcont);
1214 PL_utf8_perl_idcont = NULL;
1215 SvREFCNT_dec(PL_utf8_perl_idstart);
1216 PL_utf8_perl_idstart = NULL;
1217 SvREFCNT_dec(PL_utf8_xidcont);
1218 PL_utf8_xidcont = NULL;
1219 SvREFCNT_dec(PL_utf8_xidstart);
1220 PL_utf8_xidstart = NULL;
1221 SvREFCNT_dec(PL_WB_invlist);
1222 PL_WB_invlist = NULL;
1223 SvREFCNT_dec(PL_utf8_toupper);
1224 PL_utf8_toupper = NULL;
1225 SvREFCNT_dec(PL_utf8_totitle);
1226 PL_utf8_totitle = NULL;
1227 SvREFCNT_dec(PL_utf8_tolower);
1228 PL_utf8_tolower = NULL;
1229 SvREFCNT_dec(PL_utf8_tofold);
1230 PL_utf8_tofold = NULL;
1231 SvREFCNT_dec(PL_utf8_tosimplefold);
1232 PL_utf8_tosimplefold = NULL;
1233 SvREFCNT_dec(PL_utf8_charname_begin);
1234 PL_utf8_charname_begin = NULL;
1235 SvREFCNT_dec(PL_utf8_charname_continue);
1236 PL_utf8_charname_continue = NULL;
1237 SvREFCNT_dec(PL_utf8_mark);
1238 PL_utf8_mark = NULL;
1239 SvREFCNT_dec(PL_InBitmap);
1241 SvREFCNT_dec(PL_CCC_non0_non230);
1242 PL_CCC_non0_non230 = NULL;
1243 SvREFCNT_dec(PL_Private_Use);
1244 PL_Private_Use = NULL;
1246 for (i = 0; i < POSIX_CC_COUNT; i++) {
1247 SvREFCNT_dec(PL_XPosix_ptrs[i]);
1248 PL_XPosix_ptrs[i] = NULL;
1250 if (i != CC_CASED_) { /* A copy of Alpha */
1251 SvREFCNT_dec(PL_Posix_ptrs[i]);
1252 PL_Posix_ptrs[i] = NULL;
1256 free_and_set_cop_warnings(&PL_compiling, NULL);
1257 cophh_free(CopHINTHASH_get(&PL_compiling));
1258 CopHINTHASH_set(&PL_compiling, cophh_new_empty());
1259 CopFILE_free(&PL_compiling);
1261 /* Prepare to destruct main symbol table. */
1264 /* break ref loop *:: <=> %:: */
1265 (void)hv_deletes(hv, "main::", G_DISCARD);
1268 SvREFCNT_dec(PL_curstname);
1269 PL_curstname = NULL;
1271 /* clear queued errors */
1272 SvREFCNT_dec(PL_errors);
1275 SvREFCNT_dec(PL_isarev);
1278 if (destruct_level >= 2) {
1279 if (PL_scopestack_ix != 0)
1280 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
1281 "Unbalanced scopes: %ld more ENTERs than LEAVEs\n",
1282 (long)PL_scopestack_ix);
1283 if (PL_savestack_ix != 0)
1284 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
1285 "Unbalanced saves: %ld more saves than restores\n",
1286 (long)PL_savestack_ix);
1287 if (PL_tmps_floor != -1)
1288 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced tmps: %ld more allocs than frees\n",
1289 (long)PL_tmps_floor + 1);
1290 if (cxstack_ix != -1)
1291 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced context: %ld more PUSHes than POPs\n",
1292 (long)cxstack_ix + 1);
1296 SvREFCNT_dec(PL_regex_padav);
1297 PL_regex_padav = NULL;
1298 PL_regex_pad = NULL;
1302 /* the entries in this list are allocated via SV PVX's, so get freed
1303 * in sv_clean_all */
1304 Safefree(PL_my_cxt_list);
1307 /* Now absolutely destruct everything, somehow or other, loops or no. */
1309 /* the 2 is for PL_fdpid and PL_strtab */
1310 while (sv_clean_all() > 2)
1314 Safefree(PL_stashpad); /* must come after sv_clean_all */
1317 AvREAL_off(PL_fdpid); /* no surviving entries */
1318 SvREFCNT_dec(PL_fdpid); /* needed in io_close() */
1321 #ifdef HAVE_INTERP_INTERN
1325 /* constant strings */
1326 for (i = 0; i < SV_CONSTS_COUNT; i++) {
1327 SvREFCNT_dec(PL_sv_consts[i]);
1328 PL_sv_consts[i] = NULL;
1331 /* Destruct the global string table. */
1333 /* Yell and reset the HeVAL() slots that are still holding refcounts,
1334 * so that sv_free() won't fail on them.
1335 * Now that the global string table is using a single hunk of memory
1336 * for both HE and HEK, we either need to explicitly unshare it the
1337 * correct way, or actually free things here.
1340 const I32 max = HvMAX(PL_strtab);
1341 HE * const * const array = HvARRAY(PL_strtab);
1342 HE *hent = array[0];
1345 if (hent && ckWARN_d(WARN_INTERNAL)) {
1346 HE * const next = HeNEXT(hent);
1347 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
1348 "Unbalanced string table refcount: (%ld) for \"%s\"",
1349 (long)hent->he_valu.hent_refcount, HeKEY(hent));
1356 hent = array[riter];
1361 HvARRAY(PL_strtab) = 0;
1362 HvTOTALKEYS(PL_strtab) = 0;
1364 SvREFCNT_dec(PL_strtab);
1367 /* free the pointer tables used for cloning */
1368 ptr_table_free(PL_ptr_table);
1369 PL_ptr_table = (PTR_TBL_t*)NULL;
1372 /* free special SVs */
1374 SvREFCNT(&PL_sv_yes) = 0;
1375 sv_clear(&PL_sv_yes);
1376 SvANY(&PL_sv_yes) = NULL;
1377 SvFLAGS(&PL_sv_yes) = 0;
1379 SvREFCNT(&PL_sv_no) = 0;
1380 sv_clear(&PL_sv_no);
1381 SvANY(&PL_sv_no) = NULL;
1382 SvFLAGS(&PL_sv_no) = 0;
1384 SvREFCNT(&PL_sv_zero) = 0;
1385 sv_clear(&PL_sv_zero);
1386 SvANY(&PL_sv_zero) = NULL;
1387 SvFLAGS(&PL_sv_zero) = 0;
1391 for (i=0; i<=2; i++) {
1392 SvREFCNT(PERL_DEBUG_PAD(i)) = 0;
1393 sv_clear(PERL_DEBUG_PAD(i));
1394 SvANY(PERL_DEBUG_PAD(i)) = NULL;
1395 SvFLAGS(PERL_DEBUG_PAD(i)) = 0;
1399 if (PL_sv_count != 0 && ckWARN_d(WARN_INTERNAL))
1400 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Scalars leaked: %ld\n", (long)PL_sv_count);
1402 #ifdef DEBUG_LEAKING_SCALARS
1403 if (PL_sv_count != 0) {
1408 for (sva = PL_sv_arenaroot; sva; sva = MUTABLE_SV(SvANY(sva))) {
1409 svend = &sva[SvREFCNT(sva)];
1410 for (sv = sva + 1; sv < svend; ++sv) {
1411 if (SvTYPE(sv) != (svtype)SVTYPEMASK) {
1412 PerlIO_printf(Perl_debug_log, "leaked: sv=0x%p"
1414 " refcnt=%" UVuf pTHX__FORMAT "\n"
1415 "\tallocated at %s:%d %s %s (parent 0x%" UVxf ");"
1416 "serial %" UVuf "\n",
1417 (void*)sv, (UV)sv->sv_flags, (UV)sv->sv_refcnt
1419 sv->sv_debug_file ? sv->sv_debug_file : "(unknown)",
1421 sv->sv_debug_inpad ? "for" : "by",
1422 sv->sv_debug_optype ?
1423 PL_op_name[sv->sv_debug_optype]: "(none)",
1424 PTR2UV(sv->sv_debug_parent),
1427 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1428 Perl_dump_sv_child(aTHX_ sv);
1434 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1438 /* Wait for up to 4 seconds for child to terminate.
1439 This seems to be the least effort way of timing out on reaping
1441 struct timeval waitfor = {4, 0};
1442 int sock = PL_dumper_fd;
1446 FD_SET(sock, &rset);
1447 select(sock + 1, &rset, NULL, NULL, &waitfor);
1448 waitpid(child, &status, WNOHANG);
1453 #ifdef DEBUG_LEAKING_SCALARS_ABORT
1459 #if defined(PERLIO_LAYERS)
1460 /* No more IO - including error messages ! */
1461 PerlIO_cleanup(aTHX);
1464 /* sv_undef needs to stay immortal until after PerlIO_cleanup
1465 as currently layers use it rather than NULL as a marker
1466 for no arg - and will try and SvREFCNT_dec it.
1468 SvREFCNT(&PL_sv_undef) = 0;
1469 SvREADONLY_off(&PL_sv_undef);
1471 Safefree(PL_origfilename);
1472 PL_origfilename = NULL;
1473 Safefree(PL_reg_curpm);
1474 free_tied_hv_pool();
1475 Safefree(PL_op_mask);
1476 Safefree(PL_psig_name);
1477 PL_psig_name = (SV**)NULL;
1478 PL_psig_ptr = (SV**)NULL;
1480 /* We need to NULL PL_psig_pend first, so that
1481 signal handlers know not to use it */
1482 int *psig_save = PL_psig_pend;
1483 PL_psig_pend = (int*)NULL;
1484 Safefree(psig_save);
1487 TAINTING_set(FALSE);
1488 TAINT_WARN_set(FALSE);
1489 PL_hints = 0; /* Reset hints. Should hints be per-interpreter ? */
1491 DEBUG_P(debprofdump());
1495 #ifdef USE_REENTRANT_API
1496 Perl_reentrant_free(aTHX);
1499 /* These all point to HVs that are about to be blown away.
1500 Code in core and on CPAN assumes that if the interpreter is re-started
1501 that they will be cleanly NULL or pointing to a valid HV. */
1502 PL_custom_op_names = NULL;
1503 PL_custom_op_descs = NULL;
1504 PL_custom_ops = NULL;
1508 while (PL_regmatch_slab) {
1509 regmatch_slab *s = PL_regmatch_slab;
1510 PL_regmatch_slab = PL_regmatch_slab->next;
1514 /* As the absolutely last thing, free the non-arena SV for mess() */
1517 /* we know that type == SVt_PVMG */
1519 /* it could have accumulated taint magic */
1522 for (mg = SvMAGIC(PL_mess_sv); mg; mg = moremagic) {
1523 moremagic = mg->mg_moremagic;
1524 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global
1526 Safefree(mg->mg_ptr);
1530 /* we know that type >= SVt_PV */
1531 SvPV_free(PL_mess_sv);
1532 Safefree(SvANY(PL_mess_sv));
1533 Safefree(PL_mess_sv);
1540 =for apidoc perl_free
1542 Releases a Perl interpreter. See L<perlembed>.
1551 PERL_ARGS_ASSERT_PERL_FREE;
1553 if (PL_veto_cleanup)
1556 #ifdef PERL_TRACK_MEMPOOL
1559 * Don't free thread memory if PERL_DESTRUCT_LEVEL is set to a non-zero
1560 * value as we're probably hunting memory leaks then
1562 if (PL_perl_destruct_level == 0) {
1563 const U32 old_debug = PL_debug;
1564 /* Emulate the PerlHost behaviour of free()ing all memory allocated in this
1565 thread at thread exit. */
1567 PerlIO_puts(Perl_debug_log, "Disabling memory debugging as we "
1568 "free this thread's memory\n");
1569 PL_debug &= ~ DEBUG_m_FLAG;
1571 while(aTHXx->Imemory_debug_header.next != &(aTHXx->Imemory_debug_header)){
1572 char * next = (char *)(aTHXx->Imemory_debug_header.next);
1573 Malloc_t ptr = PERL_MEMORY_DEBUG_HEADER_SIZE + next;
1576 PL_debug = old_debug;
1582 # if defined(PERL_IMPLICIT_SYS)
1584 void *host = w32_internal_host;
1585 PerlMem_free(aTHXx);
1586 win32_delete_internal_host(host);
1589 PerlMem_free(aTHXx);
1592 PerlMem_free(aTHXx);
1596 #if defined(USE_ITHREADS)
1597 /* provide destructors to clean up the thread key when libperl is unloaded */
1598 #ifndef WIN32 /* handled during DLL_PROCESS_DETACH in win32/perllib.c */
1600 #if defined(__hpux) && !(defined(__ux_version) && __ux_version <= 1020) && !defined(__GNUC__)
1601 #pragma fini "perl_fini"
1602 #elif defined(__sun) && !defined(__GNUC__)
1603 #pragma fini (perl_fini)
1607 #if defined(__GNUC__)
1608 __attribute__((destructor))
1613 PL_curinterp && !PL_veto_cleanup)
1618 #endif /* THREADS */
1621 =for apidoc call_atexit
1623 Add a function C<fn> to the list of functions to be called at global
1624 destruction. C<ptr> will be passed as an argument to C<fn>; it can point to a
1625 C<struct> so that you can pass anything you want.
1627 Note that under threads, C<fn> may run multiple times. This is because the
1628 list is executed each time the current or any descendent thread terminates.
1634 Perl_call_atexit(pTHX_ ATEXIT_t fn, void *ptr)
1636 Renew(PL_exitlist, PL_exitlistlen+1, PerlExitListEntry);
1637 PL_exitlist[PL_exitlistlen].fn = fn;
1638 PL_exitlist[PL_exitlistlen].ptr = ptr;
1642 #ifdef USE_ENVIRON_ARRAY
1646 # ifdef USE_ITHREADS
1647 if (aTHX != PL_curinterp)
1653 size_t n_entries = 0, vars_size = 0;
1655 for (char **ep = environ; *ep; ++ep) {
1657 vars_size += strlen(*ep) + 1;
1660 /* To save memory, we store both the environ array and its values in a
1661 * single memory block. */
1662 char **new_environ = (char**)PerlMemShared_malloc(
1663 (sizeof(char*) * (n_entries + 1)) + vars_size
1665 char *vars = (char*)(new_environ + n_entries + 1);
1667 for (size_t i = 0, copied = 0; n_entries > i; ++i) {
1668 size_t len = strlen(environ[i]) + 1;
1669 new_environ[i] = (char *) CopyD(environ[i], vars + copied, len, char);
1672 new_environ[n_entries] = NULL;
1674 environ = new_environ;
1675 /* Store a pointer in a global variable to ensure it's always reachable so
1676 * LeakSanitizer/Valgrind won't complain about it. We can't ever free it.
1677 * Even if libc allocates a new environ, it's possible that some of its
1678 * values will still be pointing to the old environ.
1680 PL_my_environ = new_environ;
1685 =for apidoc perl_parse
1687 Tells a Perl interpreter to parse a Perl script. This performs most
1688 of the initialisation of a Perl interpreter. See L<perlembed> for
1691 C<my_perl> points to the Perl interpreter that is to parse the script.
1692 It must have been previously created through the use of L</perl_alloc>
1693 and L</perl_construct>. C<xsinit> points to a callback function that
1694 will be called to set up the ability for this Perl interpreter to load
1695 XS extensions, or may be null to perform no such setup.
1697 C<argc> and C<argv> supply a set of command-line arguments to the Perl
1698 interpreter, as would normally be passed to the C<main> function of
1699 a C program. C<argv[argc]> must be null. These arguments are where
1700 the script to parse is specified, either by naming a script file or by
1701 providing a script in a C<-e> option.
1702 If L<C<$0>|perlvar/$0> will be written to in the Perl interpreter, then
1703 the argument strings must be in writable memory, and so mustn't just be
1706 C<env> specifies a set of environment variables that will be used by
1707 this Perl interpreter. If non-null, it must point to a null-terminated
1708 array of environment strings. If null, the Perl interpreter will use
1709 the environment supplied by the C<environ> global variable.
1711 This function initialises the interpreter, and parses and compiles the
1712 script specified by the command-line arguments. This includes executing
1713 code in C<BEGIN>, C<UNITCHECK>, and C<CHECK> blocks. It does not execute
1714 C<INIT> blocks or the main program.
1716 Returns an integer of slightly tricky interpretation. The correct
1717 use of the return value is as a truth value indicating whether there
1718 was a failure in initialisation. If zero is returned, this indicates
1719 that initialisation was successful, and it is safe to proceed to call
1720 L</perl_run> and make other use of it. If a non-zero value is returned,
1721 this indicates some problem that means the interpreter wants to terminate.
1722 The interpreter should not be just abandoned upon such failure; the caller
1723 should proceed to shut the interpreter down cleanly with L</perl_destruct>
1724 and free it with L</perl_free>.
1726 For historical reasons, the non-zero return value also attempts to
1727 be a suitable value to pass to the C library function C<exit> (or to
1728 return from C<main>), to serve as an exit code indicating the nature
1729 of the way initialisation terminated. However, this isn't portable,
1730 due to differing exit code conventions. A historical bug is preserved
1731 for the time being: if the Perl built-in C<exit> is called during this
1732 function's execution, with a type of exit entailing a zero exit code
1733 under the host operating system's conventions, then this function
1734 returns zero rather than a non-zero value. This bug, [perl #2754],
1735 leads to C<perl_run> being called (and therefore C<INIT> blocks and the
1736 main program running) despite a call to C<exit>. It has been preserved
1737 because a popular module-installing module has come to rely on it and
1738 needs time to be fixed. This issue is [perl #132577], and the original
1739 bug is due to be fixed in Perl 5.30.
1744 #define SET_CURSTASH(newstash) \
1745 if (PL_curstash != newstash) { \
1746 SvREFCNT_dec(PL_curstash); \
1747 PL_curstash = (HV *)SvREFCNT_inc(newstash); \
1751 perl_parse(pTHXx_ XSINIT_t xsinit, int argc, char **argv, char **env)
1757 PERL_ARGS_ASSERT_PERL_PARSE;
1758 #ifndef MULTIPLICITY
1759 PERL_UNUSED_ARG(my_perl);
1761 debug_hash_seed(false);
1764 struct NameTranslationInfo nti;
1765 __translate_amiga_to_unix_path_name(&argv[0],&nti);
1772 for(i = 0; i != argc; i++)
1774 assert(!argv[argc]);
1779 if (PL_origalen != 0) {
1780 PL_origalen = 1; /* don't use old PL_origalen if perl_parse() is called again */
1783 /* Set PL_origalen be the sum of the contiguous argv[]
1784 * elements plus the size of the env in case that it is
1785 * contiguous with the argv[]. This is used in mg.c:Perl_magic_set()
1786 * as the maximum modifiable length of $0. In the worst case
1787 * the area we are able to modify is limited to the size of
1788 * the original argv[0]. (See below for 'contiguous', though.)
1790 const char *s = NULL;
1791 const UV mask = ~(UV)(PTRSIZE-1);
1792 /* Do the mask check only if the args seem like aligned. */
1794 (mask < ~(UV)0) && ((PTR2UV(argv[0]) & mask) == PTR2UV(argv[0]));
1796 /* See if all the arguments are contiguous in memory. Note
1797 * that 'contiguous' is a loose term because some platforms
1798 * align the argv[] and the envp[]. If the arguments look
1799 * like non-aligned, assume that they are 'strictly' or
1800 * 'traditionally' contiguous. If the arguments look like
1801 * aligned, we just check that they are within aligned
1802 * PTRSIZE bytes. As long as no system has something bizarre
1803 * like the argv[] interleaved with some other data, we are
1804 * fine. (Did I just evoke Murphy's Law?) --jhi */
1805 if (PL_origargv && PL_origargc >= 1 && (s = PL_origargv[0])) {
1808 for (i = 1; i < PL_origargc; i++) {
1809 if ((PL_origargv[i] == s + 1
1811 || PL_origargv[i] == s + 2
1816 (PL_origargv[i] > s &&
1818 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1829 #ifdef USE_ENVIRON_ARRAY
1830 /* Can we grab env area too to be used as the area for $0? */
1831 if (s && PL_origenviron) {
1832 if ((PL_origenviron[0] == s + 1)
1835 (PL_origenviron[0] > s &&
1836 PL_origenviron[0] <=
1837 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1841 #ifndef OS2 /* ENVIRON is read by the kernel too. */
1842 s = PL_origenviron[0];
1846 /* Force copy of environment. */
1847 if (PL_origenviron == environ)
1850 for (i = 1; PL_origenviron[i]; i++) {
1851 if (PL_origenviron[i] == s + 1
1854 (PL_origenviron[i] > s &&
1855 PL_origenviron[i] <=
1856 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1859 s = PL_origenviron[i];
1867 #endif /* USE_ENVIRON_ARRAY */
1869 PL_origalen = s ? s - PL_origargv[0] + 1 : 0;
1874 /* Come here if running an undumped a.out. */
1876 PL_origfilename = savepv(argv[0]);
1877 PL_do_undump = FALSE;
1878 cxstack_ix = -1; /* start label stack again */
1880 assert (!TAINT_get);
1884 init_postdump_symbols(argc,argv,env);
1889 op_free(PL_main_root);
1890 PL_main_root = NULL;
1892 PL_main_start = NULL;
1893 SvREFCNT_dec(PL_main_cv);
1897 oldscope = PL_scopestack_ix;
1898 PL_dowarn = G_WARN_OFF;
1903 parse_body(env,xsinit);
1904 if (PL_unitcheckav) {
1905 call_list(oldscope, PL_unitcheckav);
1908 PERL_SET_PHASE(PERL_PHASE_CHECK);
1909 call_list(oldscope, PL_checkav);
1917 /* my_exit() was called */
1918 while (PL_scopestack_ix > oldscope)
1921 SET_CURSTASH(PL_defstash);
1922 if (PL_unitcheckav) {
1923 call_list(oldscope, PL_unitcheckav);
1926 PERL_SET_PHASE(PERL_PHASE_CHECK);
1927 call_list(oldscope, PL_checkav);
1932 * At this point we should do
1934 * to avoid [perl #2754], but that bugfix has been postponed
1935 * because of the Module::Install breakage it causes
1941 PerlIO_printf(Perl_error_log, "panic: top_env\n");
1949 /* This needs to stay in perl.c, as perl.c is compiled with different flags for
1950 miniperl, and we need to see those flags reflected in the values here. */
1952 /* What this returns is subject to change. Use the public interface in Config.
1956 S_Internals_V(pTHX_ CV *cv)
1959 #ifdef LOCAL_PATCH_COUNT
1960 const int local_patch_count = LOCAL_PATCH_COUNT;
1962 const int local_patch_count = 0;
1964 const int entries = 3 + local_patch_count;
1966 /* NOTE - This list must remain sorted. Do not put any settings here
1967 * which affect binary compatibility */
1968 static const char non_bincompat_options[] =
1975 # ifdef NO_TAINT_SUPPORT
1978 # ifdef PERL_COPY_ON_WRITE
1979 " PERL_COPY_ON_WRITE"
1981 # ifdef PERL_DISABLE_PMC
1984 # ifdef PERL_DONT_CREATE_GVSV
1985 " PERL_DONT_CREATE_GVSV"
1987 # ifdef PERL_EXTERNAL_GLOB
1988 " PERL_EXTERNAL_GLOB"
1990 # ifdef PERL_IS_MINIPERL
1993 # ifdef PERL_MALLOC_WRAP
1996 # ifdef PERL_MEM_LOG
1999 # ifdef PERL_MEM_LOG_NOIMPL
2000 " PERL_MEM_LOG_NOIMPL"
2002 # ifdef PERL_OP_PARENT
2005 # ifdef PERL_PERTURB_KEYS_DETERMINISTIC
2006 " PERL_PERTURB_KEYS_DETERMINISTIC"
2008 # ifdef PERL_PERTURB_KEYS_DISABLED
2009 " PERL_PERTURB_KEYS_DISABLED"
2011 # ifdef PERL_PERTURB_KEYS_RANDOM
2012 " PERL_PERTURB_KEYS_RANDOM"
2014 # ifdef PERL_PRESERVE_IVUV
2015 " PERL_PRESERVE_IVUV"
2017 # ifdef PERL_RELOCATABLE_INCPUSH
2018 " PERL_RELOCATABLE_INCPUSH"
2020 # ifdef PERL_USE_DEVEL
2023 # ifdef PERL_USE_SAFE_PUTENV
2024 " PERL_USE_SAFE_PUTENV"
2027 # ifdef PERL_USE_UNSHARED_KEYS_IN_LARGE_HASHES
2028 " PERL_USE_UNSHARED_KEYS_IN_LARGE_HASHES"
2030 # ifdef SILENT_NO_TAINT_SUPPORT
2031 " SILENT_NO_TAINT_SUPPORT"
2033 # ifdef UNLINK_ALL_VERSIONS
2034 " UNLINK_ALL_VERSIONS"
2036 # ifdef USE_ATTRIBUTES_FOR_PERLIO
2037 " USE_ATTRIBUTES_FOR_PERLIO"
2039 # ifdef USE_FAST_STDIO
2045 # ifdef USE_LOCALE_CTYPE
2048 # ifdef WIN32_NO_REGISTRY
2051 # ifdef USE_PERL_ATOF
2054 # ifdef USE_SITECUSTOMIZE
2055 " USE_SITECUSTOMIZE"
2057 # ifdef USE_THREAD_SAFE_LOCALE
2058 " USE_THREAD_SAFE_LOCALE"
2060 # ifdef NO_PERL_RAND_SEED
2061 " NO_PERL_RAND_SEED"
2063 # ifdef NO_PERL_INTERNAL_RAND_SEED
2064 " NO_PERL_INTERNAL_RAND_SEED"
2067 PERL_UNUSED_ARG(cv);
2068 PERL_UNUSED_VAR(items);
2070 EXTEND(SP, entries);
2072 PUSHs(newSVpvn_flags(PL_bincompat_options, strlen(PL_bincompat_options),
2074 PUSHs(Perl_newSVpvn_flags(aTHX_ non_bincompat_options,
2075 sizeof(non_bincompat_options) - 1, SVs_TEMP));
2077 #ifndef PERL_BUILD_DATE
2080 # define PERL_BUILD_DATE __DATE__ " " __TIME__
2082 # define PERL_BUILD_DATE __DATE__
2087 #ifdef PERL_BUILD_DATE
2088 PUSHs(Perl_newSVpvn_flags(aTHX_
2089 STR_WITH_LEN("Compiled at " PERL_BUILD_DATE),
2092 PUSHs(&PL_sv_undef);
2095 for (i = 1; i <= local_patch_count; i++) {
2096 /* This will be an undef, if PL_localpatches[i] is NULL. */
2097 PUSHs(newSVpvn_flags(PL_localpatches[i],
2098 PL_localpatches[i] == NULL ? 0 : strlen(PL_localpatches[i]),
2105 #define INCPUSH_UNSHIFT 0x01
2106 #define INCPUSH_ADD_OLD_VERS 0x02
2107 #define INCPUSH_ADD_VERSIONED_SUB_DIRS 0x04
2108 #define INCPUSH_ADD_ARCHONLY_SUB_DIRS 0x08
2109 #define INCPUSH_NOT_BASEDIR 0x10
2110 #define INCPUSH_CAN_RELOCATE 0x20
2111 #define INCPUSH_ADD_SUB_DIRS \
2112 (INCPUSH_ADD_VERSIONED_SUB_DIRS|INCPUSH_ADD_ARCHONLY_SUB_DIRS)
2115 S_parse_body(pTHX_ char **env, XSINIT_t xsinit)
2118 int argc = PL_origargc;
2119 char **argv = PL_origargv;
2120 const char *scriptname = NULL;
2121 bool dosearch = FALSE;
2123 bool doextract = FALSE;
2124 const char *cddir = NULL;
2125 bool minus_e = FALSE; /* both -e and -E */
2126 #ifdef USE_SITECUSTOMIZE
2127 bool minus_f = FALSE;
2129 SV *linestr_sv = NULL;
2130 bool add_read_e_script = FALSE;
2131 U32 lex_start_flags = 0;
2133 PERL_SET_PHASE(PERL_PHASE_START);
2139 for (argc--,argv++; argc > 0; argc--,argv++) {
2140 if (argv[0][0] != '-' || !argv[0][1])
2146 #ifndef PERL_STRICT_CR
2172 if ((s = moreswitches(s)))
2177 #if defined(SILENT_NO_TAINT_SUPPORT)
2178 /* silently ignore */
2179 #elif defined(NO_TAINT_SUPPORT)
2180 Perl_croak_nocontext("This perl was compiled without taint support. "
2181 "Cowardly refusing to run with -t or -T flags");
2183 CHECK_MALLOC_TOO_LATE_FOR('t');
2184 if( !TAINTING_get ) {
2185 TAINT_WARN_set(TRUE);
2192 #if defined(SILENT_NO_TAINT_SUPPORT)
2193 /* silently ignore */
2194 #elif defined(NO_TAINT_SUPPORT)
2195 Perl_croak_nocontext("This perl was compiled without taint support. "
2196 "Cowardly refusing to run with -t or -T flags");
2198 CHECK_MALLOC_TOO_LATE_FOR('T');
2200 TAINT_WARN_set(FALSE);
2209 forbid_setid('e', FALSE);
2212 PL_e_script = newSVpvs("");
2213 add_read_e_script = TRUE;
2216 sv_catpv(PL_e_script, s);
2218 sv_catpv(PL_e_script, argv[1]);
2222 Perl_croak(aTHX_ "No code specified for -%c", c);
2223 sv_catpvs(PL_e_script, "\n");
2227 #ifdef USE_SITECUSTOMIZE
2233 case 'I': /* -I handled both here and in moreswitches() */
2234 forbid_setid('I', FALSE);
2235 if (!*++s && (s=argv[1]) != NULL) {
2239 STRLEN len = strlen(s);
2240 incpush(s, len, INCPUSH_ADD_SUB_DIRS|INCPUSH_ADD_OLD_VERS);
2243 Perl_croak(aTHX_ "No directory specified for -I");
2246 forbid_setid('S', FALSE);
2255 opts_prog = newSVpvs("use Config; Config::_V()");
2259 opts_prog = Perl_newSVpvf(aTHX_
2260 "use Config; Config::config_vars(qw%c%s%c)",
2264 Perl_av_create_and_push(aTHX_ &PL_preambleav, opts_prog);
2265 /* don't look for script or read stdin */
2266 scriptname = BIT_BUCKET;
2278 if (!*++s || isSPACE(*s)) {
2282 /* catch use of gnu style long options.
2283 Both of these exit immediately. */
2284 if (strEQ(s, "version"))
2286 if (strEQ(s, "help"))
2291 Perl_croak(aTHX_ "Unrecognized switch: -%s (-h will show valid options)",s);
2302 #ifndef SECURE_INTERNAL_GETENV
2305 (s = PerlEnv_getenv("PERL5OPT")))
2309 if (*s == '-' && *(s+1) == 'T') {
2310 #if defined(SILENT_NO_TAINT_SUPPORT)
2311 /* silently ignore */
2312 #elif defined(NO_TAINT_SUPPORT)
2313 Perl_croak_nocontext("This perl was compiled without taint support. "
2314 "Cowardly refusing to run with -t or -T flags");
2316 CHECK_MALLOC_TOO_LATE_FOR('T');
2318 TAINT_WARN_set(FALSE);
2322 char *popt_copy = NULL;
2335 if (!memCHRs("CDIMUdmtwW", *s))
2336 Perl_croak(aTHX_ "Illegal switch in PERL5OPT: -%c", *s);
2340 popt_copy = SvPVX(newSVpvn_flags(d, strlen(d), SVs_TEMP));
2341 s = popt_copy + (s - d);
2349 #if defined(SILENT_NO_TAINT_SUPPORT)
2350 /* silently ignore */
2351 #elif defined(NO_TAINT_SUPPORT)
2352 Perl_croak_nocontext("This perl was compiled without taint support. "
2353 "Cowardly refusing to run with -t or -T flags");
2355 if( !TAINTING_get) {
2356 TAINT_WARN_set(TRUE);
2368 #ifndef NO_PERL_INTERNAL_RAND_SEED
2369 /* If we're not set[ug]id, we might have honored
2370 PERL_INTERNAL_RAND_SEED in perl_construct().
2371 At this point command-line options have been parsed, so if
2372 we're now tainting and not set[ug]id re-seed.
2373 This could possibly be wasteful if PERL_INTERNAL_RAND_SEED is invalid,
2374 but avoids duplicating the logic from perl_construct().
2377 PerlProc_getuid() == PerlProc_geteuid() &&
2378 PerlProc_getgid() == PerlProc_getegid()) {
2379 Perl_drand48_init_r(&PL_internal_random_state, seed());
2383 debug_hash_seed(true);
2385 /* Set $^X early so that it can be used for relocatable paths in @INC */
2386 /* and for SITELIB_EXP in USE_SITECUSTOMIZE */
2387 assert (!TAINT_get);
2392 #if defined(USE_SITECUSTOMIZE)
2394 /* The games with local $! are to avoid setting errno if there is no
2395 sitecustomize script. "q%c...%c", 0, ..., 0 becomes "q\0...\0",
2396 ie a q() operator with a NUL byte as a the delimiter. This avoids
2397 problems with pathnames containing (say) ' */
2398 # ifdef PERL_IS_MINIPERL
2399 AV *const inc = GvAV(PL_incgv);
2400 SV **const inc0 = inc ? av_fetch(inc, 0, FALSE) : NULL;
2403 /* if lib/buildcustomize.pl exists, it should not fail. If it does,
2404 it should be reported immediately as a build failure. */
2405 (void)Perl_av_create_and_unshift_one(aTHX_ &PL_preambleav,
2407 "BEGIN { my $f = q%c%s%" SVf "/buildcustomize.pl%c; "
2408 "do {local $!; -f $f }"
2409 " and do $f || die $@ || qq '$f: $!' }",
2410 0, (TAINTING_get ? "./" : ""), SVfARG(*inc0), 0));
2413 /* SITELIB_EXP is a function call on Win32. */
2414 const char *const raw_sitelib = SITELIB_EXP;
2416 /* process .../.. if PERL_RELOCATABLE_INC is defined */
2417 SV *sitelib_sv = mayberelocate(raw_sitelib, strlen(raw_sitelib),
2418 INCPUSH_CAN_RELOCATE);
2419 const char *const sitelib = SvPVX(sitelib_sv);
2420 (void)Perl_av_create_and_unshift_one(aTHX_ &PL_preambleav,
2422 "BEGIN { do {local $!; -f q%c%s/sitecustomize.pl%c} && do q%c%s/sitecustomize.pl%c }",
2425 assert (SvREFCNT(sitelib_sv) == 1);
2426 SvREFCNT_dec(sitelib_sv);
2433 scriptname = argv[0];
2436 scriptname = BIT_BUCKET; /* don't look for script or read stdin */
2438 else if (scriptname == NULL) {
2442 assert (!TAINT_get);
2446 bool suidscript = FALSE;
2448 rsfp = open_script(scriptname, dosearch, &suidscript);
2450 rsfp = PerlIO_stdin();
2451 lex_start_flags = LEX_DONT_CLOSE_RSFP;
2454 validate_suid(rsfp);
2457 # if defined(SIGCHLD) || defined(SIGCLD)
2460 # define SIGCHLD SIGCLD
2462 Sighandler_t sigstate = rsignal_state(SIGCHLD);
2463 if (sigstate == (Sighandler_t) SIG_IGN) {
2464 Perl_ck_warner(aTHX_ packWARN(WARN_SIGNAL),
2465 "Can't ignore signal CHLD, forcing to default");
2466 (void)rsignal(SIGCHLD, (Sighandler_t)SIG_DFL);
2474 /* This will croak if suidscript is true, as -x cannot be used with
2476 forbid_setid('x', suidscript);
2477 /* Hence you can't get here if suidscript is true */
2479 linestr_sv = newSV_type(SVt_PV);
2480 lex_start_flags |= LEX_START_COPIED;
2481 find_beginning(linestr_sv, rsfp);
2482 if (cddir && PerlDir_chdir( (char *)cddir ) < 0)
2483 Perl_croak(aTHX_ "Can't chdir to %s",cddir);
2487 PL_main_cv = PL_compcv = MUTABLE_CV(newSV_type(SVt_PVCV));
2488 CvUNIQUE_on(PL_compcv);
2490 CvPADLIST_set(PL_compcv, pad_new(0));
2492 PL_isarev = newHV();
2495 boot_core_UNIVERSAL();
2496 boot_core_builtin();
2498 newXS("Internals::V", S_Internals_V, __FILE__);
2501 (*xsinit)(aTHX); /* in case linked C routines want magical variables */
2503 #if defined(VMS) || defined(WIN32) || defined(__CYGWIN__)
2509 # ifdef HAS_SOCKS5_INIT
2510 socks5_init(argv[0]);
2516 init_predump_symbols();
2517 /* init_postdump_symbols not currently designed to be called */
2518 /* more than once (ENV isn't cleared first, for example) */
2519 /* But running with -u leaves %ENV & @ARGV undefined! XXX */
2521 init_postdump_symbols(argc,argv,env);
2523 /* PL_unicode is turned on by -C, or by $ENV{PERL_UNICODE},
2524 * or explicitly in some platforms.
2525 * PL_utf8locale is conditionally turned on by
2526 * locale.c:Perl_init_i18nl10n() if the environment
2527 * look like the user wants to use UTF-8. */
2528 # ifndef PERL_IS_MINIPERL
2530 /* Requires init_predump_symbols(). */
2531 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
2536 /* Turn on UTF-8-ness on STDIN, STDOUT, STDERR
2537 * and the default open disciplines. */
2538 if ((PL_unicode & PERL_UNICODE_STDIN_FLAG) &&
2539 PL_stdingv && (io = GvIO(PL_stdingv)) &&
2541 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2542 if ((PL_unicode & PERL_UNICODE_STDOUT_FLAG) &&
2543 PL_defoutgv && (io = GvIO(PL_defoutgv)) &&
2545 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2546 if ((PL_unicode & PERL_UNICODE_STDERR_FLAG) &&
2547 PL_stderrgv && (io = GvIO(PL_stderrgv)) &&
2549 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2550 if ((PL_unicode & PERL_UNICODE_INOUT_FLAG) &&
2551 (sv = GvSV(gv_fetchpvs("\017PEN", GV_ADD|GV_NOTQUAL,
2553 U32 in = PL_unicode & PERL_UNICODE_IN_FLAG;
2554 U32 out = PL_unicode & PERL_UNICODE_OUT_FLAG;
2557 sv_setpvs(sv, ":utf8\0:utf8");
2559 sv_setpvs(sv, ":utf8\0");
2562 sv_setpvs(sv, "\0:utf8");
2571 if ((s = PerlEnv_getenv("PERL_SIGNALS"))) {
2572 if (strEQ(s, "unsafe"))
2573 PL_signals |= PERL_SIGNALS_UNSAFE_FLAG;
2574 else if (strEQ(s, "safe"))
2575 PL_signals &= ~PERL_SIGNALS_UNSAFE_FLAG;
2577 Perl_croak(aTHX_ "PERL_SIGNALS illegal: \"%s\"", s);
2582 lex_start(linestr_sv, rsfp, lex_start_flags);
2583 SvREFCNT_dec(linestr_sv);
2585 PL_subname = newSVpvs("main");
2587 if (add_read_e_script)
2588 filter_add(read_e_script, NULL);
2590 /* now parse the script */
2591 if (minus_e == FALSE)
2592 PL_hints |= HINTS_DEFAULT; /* after init_main_stash ; need to be after init_predump_symbols */
2594 SETERRNO(0,SS_NORMAL);
2595 if (yyparse(GRAMPROG) || PL_parser->error_count) {
2596 abort_execution("", PL_origfilename);
2598 CopLINE_set(PL_curcop, 0);
2599 SET_CURSTASH(PL_defstash);
2601 SvREFCNT_dec(PL_e_script);
2609 SAVECOPFILE(PL_curcop);
2610 SAVECOPLINE(PL_curcop);
2611 gv_check(PL_defstash);
2621 s = PerlEnv_getenv("PERL_DEBUG_MSTATS");
2622 if (s && grok_atoUV(s, &uv, NULL) && uv >= 2)
2623 dump_mstats("after compilation:");
2628 PL_restartjmpenv = NULL;
2634 =for apidoc perl_run
2636 Tells a Perl interpreter to run its main program. See L<perlembed>
2639 C<my_perl> points to the Perl interpreter. It must have been previously
2640 created through the use of L</perl_alloc> and L</perl_construct>, and
2641 initialised through L</perl_parse>. This function should not be called
2642 if L</perl_parse> returned a non-zero value, indicating a failure in
2643 initialisation or compilation.
2645 This function executes code in C<INIT> blocks, and then executes the
2646 main program. The code to be executed is that established by the prior
2647 call to L</perl_parse>. If the interpreter's C<PL_exit_flags> word
2648 does not have the C<PERL_EXIT_DESTRUCT_END> flag set, then this function
2649 will also execute code in C<END> blocks. If it is desired to make any
2650 further use of the interpreter after calling this function, then C<END>
2651 blocks should be postponed to L</perl_destruct> time by setting that flag.
2653 Returns an integer of slightly tricky interpretation. The correct use
2654 of the return value is as a truth value indicating whether the program
2655 terminated non-locally. If zero is returned, this indicates that
2656 the program ran to completion, and it is safe to make other use of the
2657 interpreter (provided that the C<PERL_EXIT_DESTRUCT_END> flag was set as
2658 described above). If a non-zero value is returned, this indicates that
2659 the interpreter wants to terminate early. The interpreter should not be
2660 just abandoned because of this desire to terminate; the caller should
2661 proceed to shut the interpreter down cleanly with L</perl_destruct>
2662 and free it with L</perl_free>.
2664 For historical reasons, the non-zero return value also attempts to
2665 be a suitable value to pass to the C library function C<exit> (or to
2666 return from C<main>), to serve as an exit code indicating the nature of
2667 the way the program terminated. However, this isn't portable, due to
2668 differing exit code conventions. An attempt is made to return an exit
2669 code of the type required by the host operating system, but because
2670 it is constrained to be non-zero, it is not necessarily possible to
2671 indicate every type of exit. It is only reliable on Unix, where a zero
2672 exit code can be augmented with a set bit that will be ignored. In any
2673 case, this function is not the correct place to acquire an exit code:
2674 one should get that from L</perl_destruct>.
2686 PERL_ARGS_ASSERT_PERL_RUN;
2687 #ifndef MULTIPLICITY
2688 PERL_UNUSED_ARG(my_perl);
2691 oldscope = PL_scopestack_ix;
2699 cxstack_ix = -1; /* start context stack again */
2701 case 0: /* normal completion */
2705 case 2: /* my_exit() */
2706 while (PL_scopestack_ix > oldscope)
2709 SET_CURSTASH(PL_defstash);
2710 if (!(PL_exit_flags & PERL_EXIT_DESTRUCT_END) &&
2711 PL_endav && !PL_minus_c) {
2712 PERL_SET_PHASE(PERL_PHASE_END);
2713 call_list(oldscope, PL_endav);
2716 if (PerlEnv_getenv("PERL_DEBUG_MSTATS"))
2717 dump_mstats("after execution: ");
2723 POPSTACK_TO(PL_mainstack);
2726 PerlIO_printf(Perl_error_log, "panic: restartop in perl_run\n");
2737 S_run_body(pTHX_ I32 oldscope)
2739 DEBUG_r(PerlIO_printf(Perl_debug_log, "%s $` $& $' support (0x%x).\n",
2740 PL_sawampersand ? "Enabling" : "Omitting",
2741 (unsigned int)(PL_sawampersand)));
2743 if (!PL_restartop) {
2745 if (DEBUG_x_TEST || DEBUG_B_TEST)
2746 dump_all_perl(!DEBUG_B_TEST);
2748 PERL_DEBUG(PerlIO_printf(Perl_debug_log, "\nEXECUTING...\n\n"));
2752 PerlIO_printf(Perl_error_log, "%s syntax OK\n", PL_origfilename);
2755 if (PERLDB_SINGLE && PL_DBsingle)
2758 PERL_SET_PHASE(PERL_PHASE_INIT);
2759 call_list(oldscope, PL_initav);
2761 #ifdef PERL_DEBUG_READONLY_OPS
2762 if (PL_main_root && PL_main_root->op_slabbed)
2763 Slab_to_ro(OpSLAB(PL_main_root));
2769 PERL_SET_PHASE(PERL_PHASE_RUN);
2772 PL_restartjmpenv = NULL;
2773 PL_op = PL_restartop;
2777 else if (PL_main_start) {
2778 CvDEPTH(PL_main_cv) = 1;
2779 PL_op = PL_main_start;
2783 NOT_REACHED; /* NOTREACHED */
2787 =for apidoc_section $SV
2791 Returns the SV of the specified Perl scalar. C<flags> are passed to
2792 L</C<gv_fetchpv>>. If C<GV_ADD> is set and the
2793 Perl variable does not exist then it will be created. If C<flags> is zero
2794 and the variable does not exist then NULL is returned.
2800 Perl_get_sv(pTHX_ const char *name, I32 flags)
2804 PERL_ARGS_ASSERT_GET_SV;
2806 gv = gv_fetchpv(name, flags, SVt_PV);
2813 =for apidoc_section $AV
2817 Returns the AV of the specified Perl global or package array with the given
2818 name (so it won't work on lexical variables). C<flags> are passed
2819 to C<gv_fetchpv>. If C<GV_ADD> is set and the
2820 Perl variable does not exist then it will be created. If C<flags> is zero
2821 and the variable does not exist then NULL is returned.
2823 Perl equivalent: C<@{"$name"}>.
2829 Perl_get_av(pTHX_ const char *name, I32 flags)
2831 GV* const gv = gv_fetchpv(name, flags, SVt_PVAV);
2833 PERL_ARGS_ASSERT_GET_AV;
2843 =for apidoc_section $HV
2847 Returns the HV of the specified Perl hash. C<flags> are passed to
2848 C<gv_fetchpv>. If C<GV_ADD> is set and the
2849 Perl variable does not exist then it will be created. If C<flags> is zero
2850 and the variable does not exist then C<NULL> is returned.
2856 Perl_get_hv(pTHX_ const char *name, I32 flags)
2858 GV* const gv = gv_fetchpv(name, flags, SVt_PVHV);
2860 PERL_ARGS_ASSERT_GET_HV;
2870 =for apidoc_section $CV
2873 =for apidoc_item get_cvn_flags
2874 =for apidoc_item |CV *|get_cvs|"string"|I32 flags
2876 These return the CV of the specified Perl subroutine. C<flags> are passed to
2877 C<gv_fetchpvn_flags>. If C<GV_ADD> is set and the Perl subroutine does not
2878 exist then it will be declared (which has the same effect as saying
2879 C<sub name;>). If C<GV_ADD> is not set and the subroutine does not exist,
2880 then NULL is returned.
2882 The forms differ only in how the subroutine is specified.. With C<get_cvs>,
2883 the name is a literal C string, enclosed in double quotes. With C<get_cv>, the
2884 name is given by the C<name> parameter, which must be a NUL-terminated C
2885 string. With C<get_cvn_flags>, the name is also given by the C<name>
2886 parameter, but it is a Perl string (possibly containing embedded NUL bytes),
2887 and its length in bytes is contained in the C<len> parameter.
2889 =for apidoc Amnh||GV_ADD
2895 Perl_get_cvn_flags(pTHX_ const char *name, STRLEN len, I32 flags)
2897 GV* const gv = gv_fetchpvn_flags(name, len, flags, SVt_PVCV);
2899 PERL_ARGS_ASSERT_GET_CVN_FLAGS;
2901 if (gv && UNLIKELY(SvROK(gv)) && SvTYPE(SvRV((SV *)gv)) == SVt_PVCV)
2902 return (CV*)SvRV((SV *)gv);
2904 /* XXX this is probably not what they think they're getting.
2905 * It has the same effect as "sub name;", i.e. just a forward
2907 if ((flags & ~GV_NOADD_MASK) && !GvCVu(gv)) {
2908 return newSTUB(gv,0);
2915 /* Nothing in core calls this now, but we can't replace it with a macro and
2916 move it to mathoms.c as a macro would evaluate name twice. */
2918 Perl_get_cv(pTHX_ const char *name, I32 flags)
2920 PERL_ARGS_ASSERT_GET_CV;
2922 return get_cvn_flags(name, strlen(name), flags);
2925 /* Be sure to refetch the stack pointer after calling these routines. */
2929 =for apidoc_section $callback
2931 =for apidoc call_argv
2933 Performs a callback to the specified named and package-scoped Perl subroutine
2934 with C<argv> (a C<NULL>-terminated array of strings) as arguments. See
2937 Approximate Perl equivalent: C<&{"$sub_name"}(@$argv)>.
2943 Perl_call_argv(pTHX_ const char *sub_name, I32 flags, char **argv)
2945 /* See G_* flags in cop.h */
2946 /* null terminated arg list */
2950 PERL_ARGS_ASSERT_CALL_ARGV;
2954 mXPUSHs(newSVpv(*argv,0));
2958 return call_pv(sub_name, flags);
2964 Performs a callback to the specified Perl sub. See L<perlcall>.
2970 Perl_call_pv(pTHX_ const char *sub_name, I32 flags)
2971 /* name of the subroutine */
2972 /* See G_* flags in cop.h */
2974 PERL_ARGS_ASSERT_CALL_PV;
2976 return call_sv(MUTABLE_SV(get_cv(sub_name, GV_ADD)), flags);
2980 =for apidoc call_method
2982 Performs a callback to the specified Perl method. The blessed object must
2983 be on the stack. See L<perlcall>.
2989 Perl_call_method(pTHX_ const char *methname, I32 flags)
2990 /* name of the subroutine */
2991 /* See G_* flags in cop.h */
2995 PERL_ARGS_ASSERT_CALL_METHOD;
2997 len = strlen(methname);
2998 sv = flags & G_METHOD_NAMED
2999 ? sv_2mortal(newSVpvn_share(methname, len,0))
3000 : newSVpvn_flags(methname, len, SVs_TEMP);
3002 return call_sv(sv, flags | G_METHOD);
3005 /* May be called with any of a CV, a GV, or an SV containing the name. */
3009 Performs a callback to the Perl sub specified by the SV.
3011 If neither the C<G_METHOD> nor C<G_METHOD_NAMED> flag is supplied, the
3012 SV may be any of a CV, a GV, a reference to a CV, a reference to a GV
3013 or C<SvPV(sv)> will be used as the name of the sub to call.
3015 If the C<G_METHOD> flag is supplied, the SV may be a reference to a CV or
3016 C<SvPV(sv)> will be used as the name of the method to call.
3018 If the C<G_METHOD_NAMED> flag is supplied, C<SvPV(sv)> will be used as
3019 the name of the method to call.
3021 Some other values are treated specially for internal use and should
3026 =for apidoc Amnh||G_METHOD
3027 =for apidoc Amnh||G_METHOD_NAMED
3033 Perl_call_sv(pTHX_ SV *sv, volatile I32 flags)
3034 /* See G_* flags in cop.h */
3036 LOGOP myop; /* fake syntax tree node */
3039 volatile I32 retval = 0;
3040 bool oldcatch = CATCH_GET;
3042 OP* const oldop = PL_op;
3045 PERL_ARGS_ASSERT_CALL_SV;
3047 if (flags & G_DISCARD) {
3051 if (!(flags & G_WANT)) {
3052 /* Backwards compatibility - as G_SCALAR was 0, it could be omitted.
3057 Zero(&myop, 1, LOGOP);
3058 if (!(flags & G_NOARGS))
3059 myop.op_flags |= OPf_STACKED;
3060 myop.op_flags |= OP_GIMME_REVERSE(flags);
3064 if (!(flags & G_METHOD_NAMED)) {
3072 if (PERLDB_SUB && PL_curstash != PL_debstash
3073 /* Handle first BEGIN of -d. */
3074 && (PL_DBcv || (PL_DBcv = GvCV(PL_DBsub)))
3075 /* Try harder, since this may have been a sighandler, thus
3076 * curstash may be meaningless. */
3077 && (SvTYPE(sv) != SVt_PVCV || CvSTASH((const CV *)sv) != PL_debstash)
3078 && !(flags & G_NODEBUG))
3079 myop.op_private |= OPpENTERSUB_DB;
3081 if (flags & (G_METHOD|G_METHOD_NAMED)) {
3082 Zero(&method_op, 1, METHOP);
3083 method_op.op_next = (OP*)&myop;
3084 PL_op = (OP*)&method_op;
3085 if ( flags & G_METHOD_NAMED ) {
3086 method_op.op_ppaddr = PL_ppaddr[OP_METHOD_NAMED];
3087 method_op.op_type = OP_METHOD_NAMED;
3088 method_op.op_u.op_meth_sv = sv;
3090 method_op.op_ppaddr = PL_ppaddr[OP_METHOD];
3091 method_op.op_type = OP_METHOD;
3093 myop.op_ppaddr = PL_ppaddr[OP_ENTERSUB];
3094 myop.op_type = OP_ENTERSUB;
3097 if (!(flags & G_EVAL)) {
3099 CALL_BODY_SUB((OP*)&myop);
3100 retval = PL_stack_sp - (PL_stack_base + oldmark);
3101 CATCH_SET(oldcatch);
3105 myop.op_other = (OP*)&myop;
3107 old_cxix = cxstack_ix;
3108 create_eval_scope(NULL, flags|G_FAKINGEVAL);
3116 CALL_BODY_SUB((OP*)&myop);
3117 retval = PL_stack_sp - (PL_stack_base + oldmark);
3118 if (!(flags & G_KEEPERR)) {
3126 /* my_exit() was called */
3127 SET_CURSTASH(PL_defstash);
3131 NOT_REACHED; /* NOTREACHED */
3134 PL_restartjmpenv = NULL;
3135 PL_op = PL_restartop;
3139 PL_stack_sp = PL_stack_base + oldmark;
3140 if ((flags & G_WANT) == G_LIST)
3144 *++PL_stack_sp = &PL_sv_undef;
3149 /* if we croaked, depending on how we croaked the eval scope
3150 * may or may not have already been popped */
3151 if (cxstack_ix > old_cxix) {
3152 assert(cxstack_ix == old_cxix + 1);
3153 assert(CxTYPE(CX_CUR()) == CXt_EVAL);
3154 delete_eval_scope();
3159 if (flags & G_DISCARD) {
3160 PL_stack_sp = PL_stack_base + oldmark;
3169 /* Eval a string. The G_EVAL flag is always assumed. */
3174 Tells Perl to C<eval> the string in the SV. It supports the same flags
3175 as C<call_sv>, with the obvious exception of C<G_EVAL>. See L<perlcall>.
3177 The C<G_RETHROW> flag can be used if you only need eval_sv() to
3178 execute code specified by a string, but not catch any errors.
3180 =for apidoc Amnh||G_RETHROW
3185 Perl_eval_sv(pTHX_ SV *sv, I32 flags)
3187 /* See G_* flags in cop.h */
3189 UNOP myop; /* fake syntax tree node */
3190 volatile I32 oldmark;
3191 volatile I32 retval = 0;
3193 OP* const oldop = PL_op;
3196 PERL_ARGS_ASSERT_EVAL_SV;
3198 if (flags & G_DISCARD) {
3205 Zero(&myop, 1, UNOP);
3208 oldmark = SP - PL_stack_base;
3214 if (!(flags & G_NOARGS))
3215 myop.op_flags = OPf_STACKED;
3216 myop.op_type = OP_ENTEREVAL;
3217 myop.op_flags |= OP_GIMME_REVERSE(flags);
3218 if (flags & G_KEEPERR)
3219 myop.op_flags |= OPf_SPECIAL;
3221 if (flags & G_RE_REPARSING)
3222 myop.op_private = (OPpEVAL_COPHH | OPpEVAL_RE_REPARSING);
3224 /* fail now; otherwise we could fail after the JMPENV_PUSH but
3225 * before a cx_pusheval(), which corrupts the stack after a croak */
3226 TAINT_PROPER("eval_sv()");
3232 if (PL_op == (OP*)(&myop)) {
3233 PL_op = PL_ppaddr[OP_ENTEREVAL](aTHX);
3235 goto fail; /* failed in compilation */
3238 retval = PL_stack_sp - (PL_stack_base + oldmark);
3239 if (!(flags & G_KEEPERR)) {
3247 /* my_exit() was called */
3248 SET_CURSTASH(PL_defstash);
3252 NOT_REACHED; /* NOTREACHED */
3255 PL_restartjmpenv = NULL;
3256 PL_op = PL_restartop;
3261 if (flags & G_RETHROW) {
3266 PL_stack_sp = PL_stack_base + oldmark;
3267 if ((flags & G_WANT) == G_LIST)
3271 *++PL_stack_sp = &PL_sv_undef;
3277 if (flags & G_DISCARD) {
3278 PL_stack_sp = PL_stack_base + oldmark;
3290 Tells Perl to C<eval> the given string in scalar context and return an SV* result.
3296 Perl_eval_pv(pTHX_ const char *p, I32 croak_on_error)
3298 SV* sv = newSVpv(p, 0);
3300 PERL_ARGS_ASSERT_EVAL_PV;
3302 if (croak_on_error) {
3304 eval_sv(sv, G_SCALAR | G_RETHROW);
3307 eval_sv(sv, G_SCALAR);
3320 /* Require a module. */
3323 =for apidoc_section $embedding
3325 =for apidoc require_pv
3327 Tells Perl to C<require> the file named by the string argument. It is
3328 analogous to the Perl code C<eval "require '$file'">. It's even
3329 implemented that way; consider using load_module instead.
3334 Perl_require_pv(pTHX_ const char *pv)
3339 PERL_ARGS_ASSERT_REQUIRE_PV;
3341 PUSHSTACKi(PERLSI_REQUIRE);
3342 sv = Perl_newSVpvf(aTHX_ "require q%c%s%c", 0, pv, 0);
3343 eval_sv(sv_2mortal(sv), G_DISCARD);
3348 S_usage(pTHX) /* XXX move this out into a module ? */
3350 /* This message really ought to be max 23 lines.
3351 * Removed -h because the user already knows that option. Others? */
3353 /* Grouped as 6 lines per C string literal, to keep under the ANSI C 89
3354 minimum of 509 character string literals. */
3355 static const char * const usage_msg[] = {
3356 " -0[octal/hexadecimal] specify record separator (\\0, if no argument)\n"
3357 " -a autosplit mode with -n or -p (splits $_ into @F)\n"
3358 " -C[number/list] enables the listed Unicode features\n"
3359 " -c check syntax only (runs BEGIN and CHECK blocks)\n"
3360 " -d[t][:MOD] run program under debugger or module Devel::MOD\n"
3361 " -D[number/letters] set debugging flags (argument is a bit mask or alphabets)\n",
3362 " -e commandline one line of program (several -e's allowed, omit programfile)\n"
3363 " -E commandline like -e, but enables all optional features\n"
3364 " -f don't do $sitelib/sitecustomize.pl at startup\n"
3365 " -F/pattern/ split() pattern for -a switch (//'s are optional)\n"
3366 " -g read all input in one go (slurp), rather than line-by-line (alias for -0777)\n"
3367 " -i[extension] edit <> files in place (makes backup if extension supplied)\n"
3368 " -Idirectory specify @INC/#include directory (several -I's allowed)\n",
3369 " -l[octnum] enable line ending processing, specifies line terminator\n"
3370 " -[mM][-]module execute \"use/no module...\" before executing program\n"
3371 " -n assume \"while (<>) { ... }\" loop around program\n"
3372 " -p assume loop like -n but print line also, like sed\n"
3373 " -s enable rudimentary parsing for switches after programfile\n"
3374 " -S look for programfile using PATH environment variable\n",
3375 " -t enable tainting warnings\n"
3376 " -T enable tainting checks\n"
3377 " -u dump core after parsing program\n"
3378 " -U allow unsafe operations\n"
3379 " -v print version, patchlevel and license\n"
3380 " -V[:configvar] print configuration summary (or a single Config.pm variable)\n",
3381 " -w enable many useful warnings\n"
3382 " -W enable all warnings\n"
3383 " -x[directory] ignore text before #!perl line (optionally cd to directory)\n"
3384 " -X disable all warnings\n"
3386 "Run 'perldoc perl' for more help with Perl.\n\n",
3389 const char * const *p = usage_msg;
3390 PerlIO *out = PerlIO_stdout();
3393 "\nUsage: %s [switches] [--] [programfile] [arguments]\n",
3396 PerlIO_puts(out, *p++);
3400 /* convert a string of -D options (or digits) into an int.
3401 * sets *s to point to the char after the options */
3405 Perl_get_debug_opts(pTHX_ const char **s, bool givehelp)
3407 static const char * const usage_msgd[] = {
3408 " Debugging flag values: (see also -d)\n"
3409 " p Tokenizing and parsing (with v, displays parse stack)\n"
3410 " s Stack snapshots (with v, displays all stacks)\n"
3411 " l Context (loop) stack processing\n"
3412 " t Trace execution\n"
3413 " o Method and overloading resolution\n",
3414 " c String/numeric conversions\n"
3415 " P Print profiling info, source file input state\n"
3416 " m Memory and SV allocation\n"
3417 " f Format processing\n"
3418 " r Regular expression parsing and execution\n"
3419 " x Syntax tree dump\n",
3420 " u Tainting checks\n"
3421 " X Scratchpad allocation\n"
3423 " S Op slab allocation\n"
3425 " R Include reference counts of dumped variables (eg when using -Ds)\n",
3426 " J Do not s,t,P-debug (Jump over) opcodes within package DB\n"
3427 " v Verbose: use in conjunction with other flags\n"
3428 " C Copy On Write\n"
3429 " A Consistency checks on internal structures\n"
3430 " q quiet - currently only suppresses the 'EXECUTING' message\n"
3431 " M trace smart match resolution\n"
3432 " B dump suBroutine definitions, including special Blocks like BEGIN\n",
3433 " L trace some locale setting information--for Perl core development\n",
3434 " i trace PerlIO layer processing\n",
3435 " y trace y///, tr/// compilation and execution\n",
3436 " h Show (h)ash randomization debug output"
3437 " (changes to PL_hash_rand_bits)\n",
3442 PERL_ARGS_ASSERT_GET_DEBUG_OPTS;
3446 * If adding new options add them to the END of debopts[].
3447 * If you remove an option replace it with a '?'.
3448 * If there is a free slot available marked with '?' feel
3449 * free to reuse it for something else.
3451 * Regardles remember to update DEBUG_MASK in perl.h, and
3452 * update the documentation above AND in pod/perlrun.pod.
3454 * Note that the ? indicates an unused slot. As the code below
3455 * indicates the position in this list is important. You cannot
3456 * change the order or delete a character from the list without
3457 * impacting the definitions of all the other flags in perl.h
3458 * However because the logic is guarded by isWORDCHAR we can
3459 * fill in holes with non-wordchar characters instead. */
3460 static const char debopts[] = "psltocPmfrxuUhXDSTRJvCAqMBLiy";
3462 for (; isWORDCHAR(**s); (*s)++) {
3463 const char * const d = strchr(debopts,**s);
3465 uv |= 1 << (d - debopts);
3466 else if (ckWARN_d(WARN_DEBUGGING))
3467 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3468 "invalid option -D%c, use -D'' to see choices\n", **s);
3471 else if (isDIGIT(**s)) {
3472 const char* e = *s + strlen(*s);
3473 if (grok_atoUV(*s, &uv, &e))
3475 for (; isWORDCHAR(**s); (*s)++) ;
3477 else if (givehelp) {
3478 const char *const *p = usage_msgd;
3479 while (*p) PerlIO_puts(PerlIO_stdout(), *p++);
3481 return (int)uv; /* ignore any UV->int conversion loss */
3485 /* This routine handles any switches that can be given during run */
3488 Perl_moreswitches(pTHX_ const char *s)
3491 const char option = *s; /* used to remember option in -m/-M code */
3493 PERL_ARGS_ASSERT_MORESWITCHES;
3501 SvREFCNT_dec(PL_rs);
3502 if (s[1] == 'x' && s[2]) {
3503 const char *e = s+=2;
3509 flags = PERL_SCAN_SILENT_ILLDIGIT;
3510 rschar = (U32)grok_hex(s, &numlen, &flags, NULL);
3511 if (s + numlen < e) {
3512 /* Continue to treat -0xFOO as -0 -xFOO
3513 * (ie NUL as the input record separator, and -x with FOO
3514 * as the directory argument)
3516 * hex support for -0 was only added in 5.8.1, hence this
3517 * heuristic to distinguish between it and '-0' clustered with
3518 * '-x' with an argument. The text following '-0x' is only
3519 * processed as the IRS specified in hexadecimal if all
3520 * characters are valid hex digits. */
3525 PL_rs = newSVpvs("");
3526 tmps = (U8*) SvGROW(PL_rs, (STRLEN)(UVCHR_SKIP(rschar) + 1));
3527 uvchr_to_utf8(tmps, rschar);
3528 SvCUR_set(PL_rs, UVCHR_SKIP(rschar));
3533 rschar = (U32)grok_oct(s, &numlen, &flags, NULL);
3534 if (rschar & ~((U8)~0))
3535 PL_rs = &PL_sv_undef;
3536 else if (!rschar && numlen >= 2)
3537 PL_rs = newSVpvs("");
3539 char ch = (char)rschar;
3540 PL_rs = newSVpvn(&ch, 1);
3543 sv_setsv(get_sv("/", GV_ADD), PL_rs);
3548 PL_unicode = parse_unicode_opts( (const char **)&s );
3549 if (PL_unicode & PERL_UNICODE_UTF8CACHEASSERT_FLAG)
3557 while (*s && !isSPACE(*s)) ++s;
3558 PL_splitstr = savepvn(PL_splitstr, s - PL_splitstr);
3570 forbid_setid('d', FALSE);
3573 /* -dt indicates to the debugger that threads will be used */
3574 if (*s == 't' && !isWORDCHAR(s[1])) {
3576 my_setenv("PERL5DB_THREADED", "1");
3579 /* The following permits -d:Mod to accepts arguments following an =
3580 in the fashion that -MSome::Mod does. */
3581 if (*s == ':' || *s == '=') {
3588 sv = newSVpvs("no Devel::");
3590 sv = newSVpvs("use Devel::");
3594 end = s + strlen(s);
3596 /* We now allow -d:Module=Foo,Bar and -d:-Module */
3597 while(isWORDCHAR(*s) || *s==':') ++s;
3599 sv_catpvn(sv, start, end - start);
3601 sv_catpvn(sv, start, s-start);
3602 /* Don't use NUL as q// delimiter here, this string goes in the
3604 Perl_sv_catpvf(aTHX_ sv, " split(/,/,q{%s});", ++s);
3607 my_setenv("PERL5DB", SvPV_nolen_const(sv));
3611 PL_perldb = PERLDB_ALL;
3618 forbid_setid('D', FALSE);
3620 PL_debug = get_debug_opts( (const char **)&s, 1) | DEBUG_TOP_FLAG;
3621 #else /* !DEBUGGING */
3622 if (ckWARN_d(WARN_DEBUGGING))
3623 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3624 "Recompile perl with -DDEBUGGING to use -D switch (did you mean -d ?)\n");
3625 for (s++; isWORDCHAR(*s); s++) ;
3628 NOT_REACHED; /* NOTREACHED */
3631 SvREFCNT_dec(PL_rs);
3632 PL_rs = &PL_sv_undef;
3633 sv_setsv(get_sv("/", GV_ADD), PL_rs);
3640 NOT_REACHED; /* NOTREACHED */
3643 Safefree(PL_inplace);
3645 const char * const start = ++s;
3646 while (*s && !isSPACE(*s))
3649 PL_inplace = savepvn(start, s - start);
3652 case 'I': /* -I handled both here and in parse_body() */
3653 forbid_setid('I', FALSE);
3655 while (*s && isSPACE(*s))
3660 /* ignore trailing spaces (possibly followed by other switches) */
3662 for (e = p; *e && !isSPACE(*e); e++) ;
3666 } while (*p && *p != '-');
3668 INCPUSH_ADD_SUB_DIRS|INCPUSH_ADD_OLD_VERS|INCPUSH_UNSHIFT);
3674 Perl_croak(aTHX_ "No directory specified for -I");
3680 SvREFCNT_dec(PL_ors_sv);
3686 PL_ors_sv = newSVpvs("\n");
3687 numlen = 3 + (*s == '0');
3688 *SvPVX(PL_ors_sv) = (char)grok_oct(s, &numlen, &flags, NULL);
3692 if (RsPARA(PL_rs)) {
3693 PL_ors_sv = newSVpvs("\n\n");
3696 PL_ors_sv = newSVsv(PL_rs);
3701 forbid_setid('M', FALSE); /* XXX ? */
3704 forbid_setid('m', FALSE); /* XXX ? */
3709 const char *use = "use ";
3711 /* -M-foo == 'no foo' */
3712 /* Leading space on " no " is deliberate, to make both
3713 possibilities the same length. */
3714 if (*s == '-') { use = " no "; ++s; }
3715 sv = newSVpvn(use,4);
3717 /* We allow -M'Module qw(Foo Bar)' */
3718 while(isWORDCHAR(*s) || *s==':') {
3727 Perl_croak(aTHX_ "Module name required with -%c option",
3730 Perl_croak(aTHX_ "Invalid module name %.*s with -%c option: "
3731 "contains single ':'",
3732 (int)(s - start), start, option);
3733 end = s + strlen(s);
3735 sv_catpvn(sv, start, end - start);
3736 if (option == 'm') {
3738 Perl_croak(aTHX_ "Can't use '%c' after -mname", *s);
3739 sv_catpvs( sv, " ()");
3742 sv_catpvn(sv, start, s-start);
3743 /* Use NUL as q''-delimiter. */
3744 sv_catpvs(sv, " split(/,/,q\0");
3746 sv_catpvn(sv, s, end - s);
3747 sv_catpvs(sv, "\0)");
3750 Perl_av_create_and_push(aTHX_ &PL_preambleav, sv);
3753 Perl_croak(aTHX_ "Missing argument to -%c", option);
3764 forbid_setid('s', FALSE);
3765 PL_doswitches = TRUE;
3770 #if defined(SILENT_NO_TAINT_SUPPORT)
3771 /* silently ignore */
3772 #elif defined(NO_TAINT_SUPPORT)
3773 Perl_croak_nocontext("This perl was compiled without taint support. "
3774 "Cowardly refusing to run with -t or -T flags");
3782 PL_do_undump = TRUE;
3792 if (! (PL_dowarn & G_WARN_ALL_MASK)) {
3793 PL_dowarn |= G_WARN_ON;
3798 PL_dowarn = G_WARN_ALL_ON|G_WARN_ON;
3799 free_and_set_cop_warnings(&PL_compiling, pWARN_ALL);
3803 PL_dowarn = G_WARN_ALL_OFF;
3804 free_and_set_cop_warnings(&PL_compiling, pWARN_NONE);
3811 if (s[0] == '-') /* Additional switches on #! line. */
3816 #if defined(WIN32) || !defined(PERL_STRICT_CR)
3822 #ifdef ALTERNATE_SHEBANG
3823 case 'S': /* OS/2 needs -S on "extproc" line. */
3826 case 'e': case 'f': case 'x': case 'E':
3827 #ifndef ALTERNATE_SHEBANG
3831 Perl_croak(aTHX_ "Can't emulate -%.1s on #! line",s);
3834 "Unrecognized switch: -%.1s (-h will show valid options)",s
3844 PerlIO * PIO_stdout;
3846 const char * const level_str = "v" PERL_VERSION_STRING;
3847 const STRLEN level_len = sizeof("v" PERL_VERSION_STRING)-1;
3848 #ifdef PERL_PATCHNUM
3850 # ifdef PERL_GIT_UNCOMMITTED_CHANGES
3851 static const char num [] = PERL_PATCHNUM "*";
3853 static const char num [] = PERL_PATCHNUM;
3856 const STRLEN num_len = sizeof(num)-1;
3857 /* A very advanced compiler would fold away the strnEQ
3858 and this whole conditional, but most (all?) won't do it.
3859 SV level could also be replaced by with preprocessor
3862 if (num_len >= level_len && strnEQ(num,level_str,level_len)) {
3863 /* per 46807d8e80, PERL_PATCHNUM is outside of the control
3864 of the interp so it might contain format characters
3866 level = newSVpvn(num, num_len);
3868 level = Perl_newSVpvf_nocontext("%s (%s)", level_str, num);
3872 SV* level = newSVpvn(level_str, level_len);
3873 #endif /* #ifdef PERL_PATCHNUM */
3874 PIO_stdout = PerlIO_stdout();
3875 PerlIO_printf(PIO_stdout,
3876 "\nThis is perl " STRINGIFY(PERL_REVISION)
3877 ", version " STRINGIFY(PERL_VERSION)
3878 ", subversion " STRINGIFY(PERL_SUBVERSION)
3879 " (%" SVf ") built for " ARCHNAME, SVfARG(level)
3881 SvREFCNT_dec_NN(level);
3883 #if defined(LOCAL_PATCH_COUNT)
3884 if (LOCAL_PATCH_COUNT > 0)
3885 PerlIO_printf(PIO_stdout,
3886 "\n(with %d registered patch%s, "
3887 "see perl -V for more detail)",
3889 (LOCAL_PATCH_COUNT!=1) ? "es" : "");
3892 PerlIO_printf(PIO_stdout,
3893 "\n\nCopyright 1987-2022, Larry Wall\n");
3895 PerlIO_printf(PIO_stdout,
3896 "\n\nOS/2 port Copyright (c) 1990, 1991, Raymond Chen, Kai Uwe Rommel\n"
3897 "Version 5 port Copyright (c) 1994-2002, Andreas Kaiser, Ilya Zakharevich\n");
3900 PerlIO_printf(PIO_stdout,
3901 "MVS (OS390) port by Mortice Kern Systems, 1997-1999\n");
3904 PerlIO_printf(PIO_stdout,
3905 "Stratus OpenVOS port by Paul.Green@stratus.com, 1997-2013\n");
3908 PerlIO_printf(PIO_stdout,
3909 "BS2000 (POSIX) port by Start Amadeus GmbH, 1998-1999\n");
3911 #ifdef BINARY_BUILD_NOTICE
3912 BINARY_BUILD_NOTICE;
3914 PerlIO_printf(PIO_stdout,
3916 Perl may be copied only under the terms of either the Artistic License or the\n\
3917 GNU General Public License, which may be found in the Perl 5 source kit.\n\n\
3918 Complete documentation for Perl, including FAQ lists, should be found on\n\
3919 this system using \"man perl\" or \"perldoc perl\". If you have access to the\n\
3920 Internet, point your browser at https://www.perl.org/, the Perl Home Page.\n\n");
3924 /* compliments of Tom Christiansen */
3926 /* unexec() can be found in the Gnu emacs distribution */
3927 /* Known to work with -DUNEXEC and using unexelf.c from GNU emacs-20.2 */
3930 #include <lib$routines.h>
3934 Perl_my_unexec(pTHX)
3937 SV * prog = newSVpv(BIN_EXP, 0);
3938 SV * file = newSVpv(PL_origfilename, 0);
3942 sv_catpvs(prog, "/perl");
3943 sv_catpvs(file, ".perldump");
3945 unexec(SvPVX(file), SvPVX(prog), &etext, sbrk(0), 0);
3946 /* unexec prints msg to stderr in case of failure */
3947 PerlProc_exit(status);
3949 PERL_UNUSED_CONTEXT;
3951 lib$signal(SS$_DEBUG); /* ssdef.h #included from vmsish.h */
3952 # elif defined(WIN32) || defined(__CYGWIN__)
3953 Perl_croak_nocontext("dump is not supported");
3955 ABORT(); /* for use with undump */
3960 /* initialize curinterp */
3965 # define PERLVAR(prefix,var,type)
3966 # define PERLVARA(prefix,var,n,type)
3967 # if defined(MULTIPLICITY)
3968 # define PERLVARI(prefix,var,type,init) aTHX->prefix##var = init;
3969 # define PERLVARIC(prefix,var,type,init) aTHX->prefix##var = init;
3971 # define PERLVARI(prefix,var,type,init) PERL_GET_INTERP->var = init;
3972 # define PERLVARIC(prefix,var,type,init) PERL_GET_INTERP->var = init;
3974 # include "intrpvar.h"
3980 # define PERLVAR(prefix,var,type)
3981 # define PERLVARA(prefix,var,n,type)
3982 # define PERLVARI(prefix,var,type,init) PL_##var = init;
3983 # define PERLVARIC(prefix,var,type,init) PL_##var = init;
3984 # include "intrpvar.h"
3994 S_init_main_stash(pTHX)
3999 PL_curstash = PL_defstash = (HV *)SvREFCNT_inc_simple_NN(hv);
4000 /* We know that the string "main" will be in the global shared string
4001 table, so it's a small saving to use it rather than allocate another
4003 PL_curstname = newSVpvs_share("main");
4004 gv = gv_fetchpvs("main::", GV_ADD|GV_NOTQUAL, SVt_PVHV);
4005 /* If we hadn't caused another reference to "main" to be in the shared
4006 string table above, then it would be worth reordering these two,
4007 because otherwise all we do is delete "main" from it as a consequence
4008 of the SvREFCNT_dec, only to add it again with hv_name_set */
4009 SvREFCNT_dec(GvHV(gv));
4010 hv_name_sets(PL_defstash, "main", 0);
4011 GvHV(gv) = MUTABLE_HV(SvREFCNT_inc_simple(PL_defstash));
4013 PL_incgv = gv_HVadd(gv_AVadd(gv_fetchpvs("INC", GV_ADD|GV_NOTQUAL,
4015 SvREFCNT_inc_simple_void(PL_incgv); /* Don't allow it to be freed */
4016 GvMULTI_on(PL_incgv);
4017 PL_hintgv = gv_fetchpvs("\010", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^H */
4018 SvREFCNT_inc_simple_void(PL_hintgv);
4019 GvMULTI_on(PL_hintgv);
4020 PL_defgv = gv_fetchpvs("_", GV_ADD|GV_NOTQUAL, SVt_PVAV);
4021 SvREFCNT_inc_simple_void(PL_defgv);
4022 PL_errgv = gv_fetchpvs("@", GV_ADD|GV_NOTQUAL, SVt_PV);
4023 SvREFCNT_inc_simple_void(PL_errgv);
4024 GvMULTI_on(PL_errgv);
4025 PL_replgv = gv_fetchpvs("\022", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^R */
4026 SvREFCNT_inc_simple_void(PL_replgv);
4027 GvMULTI_on(PL_replgv);
4028 (void)Perl_form(aTHX_ "%240s",""); /* Preallocate temp - for immediate signals. */
4029 #ifdef PERL_DONT_CREATE_GVSV
4030 (void)gv_SVadd(PL_errgv);
4032 sv_grow(ERRSV, 240); /* Preallocate - for immediate signals. */
4034 CopSTASH_set(&PL_compiling, PL_defstash);
4035 PL_debstash = GvHV(gv_fetchpvs("DB::", GV_ADDMULTI, SVt_PVHV));
4036 PL_globalstash = GvHV(gv_fetchpvs("CORE::GLOBAL::", GV_ADDMULTI,
4038 /* We must init $/ before switches are processed. */
4039 sv_setpvs(get_sv("/", GV_ADD), "\n");
4043 S_open_script(pTHX_ const char *scriptname, bool dosearch, bool *suidscript)
4046 PerlIO *rsfp = NULL;
4050 PERL_ARGS_ASSERT_OPEN_SCRIPT;
4053 PL_origfilename = savepvs("-e");
4058 /* if find_script() returns, it returns a malloc()-ed value */
4059 scriptname = PL_origfilename = find_script(scriptname, dosearch, NULL, 1);
4060 s = scriptname + strlen(scriptname);
4062 if (strBEGINs(scriptname, "/dev/fd/")
4063 && isDIGIT(scriptname[8])
4064 && grok_atoUV(scriptname + 8, &uv, &s)
4065 && uv <= PERL_INT_MAX
4070 * Tell apart "normal" usage of fdscript, e.g.
4071 * with bash on FreeBSD:
4072 * perl <( echo '#!perl -DA'; echo 'print "$0\n"')
4073 * from usage in suidperl.
4074 * Does any "normal" usage leave garbage after the number???
4075 * Is it a mistake to use a similar /dev/fd/ construct for
4080 * Be supersafe and do some sanity-checks.
4081 * Still, can we be sure we got the right thing?
4084 Perl_croak(aTHX_ "Wrong syntax (suid) fd script name \"%s\"\n", s);
4087 Perl_croak(aTHX_ "Missing (suid) fd script name\n");
4089 scriptname = savepv(s + 1);
4090 Safefree(PL_origfilename);
4091 PL_origfilename = (char *)scriptname;
4096 CopFILE_free(PL_curcop);
4097 CopFILE_set(PL_curcop, PL_origfilename);
4098 if (*PL_origfilename == '-' && PL_origfilename[1] == '\0')
4099 scriptname = (char *)"";
4100 if (fdscript >= 0) {
4101 rsfp = PerlIO_fdopen(fdscript,PERL_SCRIPT_MODE);
4103 else if (!*scriptname) {
4104 forbid_setid(0, *suidscript);
4108 #ifdef FAKE_BIT_BUCKET
4109 /* This hack allows one not to have /dev/null (or BIT_BUCKET as it
4110 * is called) and still have the "-e" work. (Believe it or not,
4111 * a /dev/null is required for the "-e" to work because source
4112 * filter magic is used to implement it. ) This is *not* a general
4113 * replacement for a /dev/null. What we do here is create a temp
4114 * file (an empty file), open up that as the script, and then
4115 * immediately close and unlink it. Close enough for jazz. */
4116 #define FAKE_BIT_BUCKET_PREFIX "/tmp/perlnull-"
4117 #define FAKE_BIT_BUCKET_SUFFIX "XXXXXXXX"
4118 #define FAKE_BIT_BUCKET_TEMPLATE FAKE_BIT_BUCKET_PREFIX FAKE_BIT_BUCKET_SUFFIX
4119 char tmpname[sizeof(FAKE_BIT_BUCKET_TEMPLATE)] = {
4120 FAKE_BIT_BUCKET_TEMPLATE
4122 const char * const err = "Failed to create a fake bit bucket";
4123 if (strEQ(scriptname, BIT_BUCKET)) {
4124 int tmpfd = Perl_my_mkstemp_cloexec(tmpname);
4126 scriptname = tmpname;
4129 Perl_croak(aTHX_ err);
4132 rsfp = PerlIO_open(scriptname,PERL_SCRIPT_MODE);
4133 #ifdef FAKE_BIT_BUCKET
4134 if ( strBEGINs(scriptname, FAKE_BIT_BUCKET_PREFIX)
4135 && strlen(scriptname) == sizeof(tmpname) - 1)
4139 scriptname = BIT_BUCKET;
4143 /* PSz 16 Sep 03 Keep neat error message */
4145 Perl_croak(aTHX_ "Can't open " BIT_BUCKET ": %s\n", Strerror(errno));
4147 Perl_croak(aTHX_ "Can't open perl script \"%s\": %s\n",
4148 CopFILE(PL_curcop), Strerror(errno));
4150 fd = PerlIO_fileno(rsfp);
4153 (PerlLIO_fstat(fd, &tmpstatbuf) >= 0
4154 && S_ISDIR(tmpstatbuf.st_mode)))
4155 Perl_croak(aTHX_ "Can't open perl script \"%s\": %s\n",
4162 /* In the days of suidperl, we refused to execute a setuid script stored on
4163 * a filesystem mounted nosuid and/or noexec. This meant that we probed for the
4164 * existence of the appropriate filesystem-statting function, and behaved
4165 * accordingly. But even though suidperl is long gone, we must still include
4166 * those probes for the benefit of modules like Filesys::Df, which expect the
4167 * results of those probes to be stored in %Config; see RT#126368. So mention
4168 * the relevant cpp symbols here, to ensure that metaconfig will include their
4169 * probes in the generated Configure:
4171 * I_SYSSTATVFS HAS_FSTATVFS
4173 * I_STATFS HAS_FSTATFS HAS_GETFSSTAT
4174 * I_MNTENT HAS_GETMNTENT HAS_HASMNTOPT
4178 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
4179 /* Don't even need this function. */
4182 S_validate_suid(pTHX_ PerlIO *rsfp)
4184 const Uid_t my_uid = PerlProc_getuid();
4185 const Uid_t my_euid = PerlProc_geteuid();
4186 const Gid_t my_gid = PerlProc_getgid();
4187 const Gid_t my_egid = PerlProc_getegid();
4189 PERL_ARGS_ASSERT_VALIDATE_SUID;
4191 if (my_euid != my_uid || my_egid != my_gid) { /* (suidperl doesn't exist, in fact) */
4192 int fd = PerlIO_fileno(rsfp);
4194 if (fd < 0 || PerlLIO_fstat(fd, &statbuf) < 0) { /* may be either wrapped or real suid */
4195 Perl_croak_nocontext( "Illegal suidscript");
4197 if ((my_euid != my_uid && my_euid == statbuf.st_uid && statbuf.st_mode & S_ISUID)
4199 (my_egid != my_gid && my_egid == statbuf.st_gid && statbuf.st_mode & S_ISGID)
4202 Perl_croak(aTHX_ "YOU HAVEN'T DISABLED SET-ID SCRIPTS IN THE KERNEL YET!\n\
4203 FIX YOUR KERNEL, PUT A C WRAPPER AROUND THIS SCRIPT, OR USE -u AND UNDUMP!\n");
4204 /* not set-id, must be wrapped */
4207 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4210 S_find_beginning(pTHX_ SV* linestr_sv, PerlIO *rsfp)
4215 PERL_ARGS_ASSERT_FIND_BEGINNING;
4217 /* skip forward in input to the real script? */
4220 if ((s = sv_gets(linestr_sv, rsfp, 0)) == NULL)
4221 Perl_croak(aTHX_ "No Perl script found in input\n");
4223 } while (!(*s == '#' && s[1] == '!' && ((s = instr(s,"perl")) || (s = instr(s2,"PERL")))));
4224 PerlIO_ungetc(rsfp, '\n'); /* to keep line count right */
4225 while (*s && !(isSPACE (*s) || *s == '#')) s++;
4227 while (*s == ' ' || *s == '\t') s++;
4229 while (isDIGIT(s2[-1]) || s2[-1] == '-' || s2[-1] == '.'
4230 || s2[-1] == '_') s2--;
4231 if (strBEGINs(s2-4,"perl"))
4232 while ((s = moreswitches(s)))
4241 /* no need to do anything here any more if we don't
4243 #ifndef NO_TAINT_SUPPORT
4244 const Uid_t my_uid = PerlProc_getuid();
4245 const Uid_t my_euid = PerlProc_geteuid();
4246 const Gid_t my_gid = PerlProc_getgid();
4247 const Gid_t my_egid = PerlProc_getegid();
4249 PERL_UNUSED_CONTEXT;
4251 /* Should not happen: */
4252 CHECK_MALLOC_TAINT(my_uid && (my_euid != my_uid || my_egid != my_gid));
4253 TAINTING_set( TAINTING_get | (my_uid && (my_euid != my_uid || my_egid != my_gid)) );
4257 * Should go by suidscript, not uid!=euid: why disallow
4258 * system("ls") in scripts run from setuid things?
4259 * Or, is this run before we check arguments and set suidscript?
4260 * What about SETUID_SCRIPTS_ARE_SECURE_NOW: could we use fdscript then?
4261 * (We never have suidscript, can we be sure to have fdscript?)
4262 * Or must then go by UID checks? See comments in forbid_setid also.
4266 /* This is used very early in the lifetime of the program,
4267 * before even the options are parsed, so PL_tainting has
4268 * not been initialized properly. */
4270 Perl_doing_taint(int argc, char *argv[], char *envp[])
4272 #ifndef PERL_IMPLICIT_SYS
4273 /* If we have PERL_IMPLICIT_SYS we can't call getuid() et alia
4274 * before we have an interpreter-- and the whole point of this
4275 * function is to be called at such an early stage. If you are on
4276 * a system with PERL_IMPLICIT_SYS but you do have a concept of
4277 * "tainted because running with altered effective ids', you'll
4278 * have to add your own checks somewhere in here. The most known
4279 * sample of 'implicitness' is Win32, which doesn't have much of
4280 * concept of 'uids'. */
4281 Uid_t uid = PerlProc_getuid();
4282 Uid_t euid = PerlProc_geteuid();
4283 Gid_t gid = PerlProc_getgid();
4284 Gid_t egid = PerlProc_getegid();
4291 if (uid && (euid != uid || egid != gid))
4293 #endif /* !PERL_IMPLICIT_SYS */
4294 /* This is a really primitive check; environment gets ignored only
4295 * if -T are the first chars together; otherwise one gets
4296 * "Too late" message. */
4297 if ( argc > 1 && argv[1][0] == '-'
4298 && isALPHA_FOLD_EQ(argv[1][1], 't'))
4303 /* Passing the flag as a single char rather than a string is a slight space
4304 optimisation. The only message that isn't /^-.$/ is
4305 "program input from stdin", which is substituted in place of '\0', which
4306 could never be a command line flag. */
4308 S_forbid_setid(pTHX_ const char flag, const bool suidscript) /* g */
4310 char string[3] = "-x";
4311 const char *message = "program input from stdin";
4313 PERL_UNUSED_CONTEXT;
4319 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
4320 if (PerlProc_getuid() != PerlProc_geteuid())
4321 Perl_croak(aTHX_ "No %s allowed while running setuid", message);
4322 if (PerlProc_getgid() != PerlProc_getegid())
4323 Perl_croak(aTHX_ "No %s allowed while running setgid", message);
4324 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4326 Perl_croak(aTHX_ "No %s allowed with (suid) fdscript", message);
4330 Perl_init_dbargs(pTHX)
4332 AV *const args = PL_dbargs = GvAV(gv_AVadd((gv_fetchpvs("DB::args",
4337 /* Someone has already created it.
4338 It might have entries, and if we just turn off AvREAL(), they will
4339 "leak" until global destruction. */
4341 if (SvTIED_mg((const SV *)args, PERL_MAGIC_tied))
4342 Perl_croak(aTHX_ "Cannot set tied @DB::args");
4344 AvREIFY_only(PL_dbargs);
4348 Perl_init_debugger(pTHX)
4350 HV * const ostash = PL_curstash;
4353 PL_curstash = (HV *)SvREFCNT_inc_simple(PL_debstash);
4355 Perl_init_dbargs(aTHX);
4356 PL_DBgv = MUTABLE_GV(
4357 SvREFCNT_inc(gv_fetchpvs("DB::DB", GV_ADDMULTI, SVt_PVGV))
4359 PL_DBline = MUTABLE_GV(
4360 SvREFCNT_inc(gv_fetchpvs("DB::dbline", GV_ADDMULTI, SVt_PVAV))
4362 PL_DBsub = MUTABLE_GV(SvREFCNT_inc(
4363 gv_HVadd(gv_fetchpvs("DB::sub", GV_ADDMULTI, SVt_PVHV))
4365 PL_DBsingle = GvSV((gv_fetchpvs("DB::single", GV_ADDMULTI, SVt_PV)));
4366 if (!SvIOK(PL_DBsingle))
4367 sv_setiv(PL_DBsingle, 0);
4368 mg = sv_magicext(PL_DBsingle, NULL, PERL_MAGIC_debugvar, &PL_vtbl_debugvar, 0, 0);
4369 mg->mg_private = DBVARMG_SINGLE;
4370 SvSETMAGIC(PL_DBsingle);
4372 PL_DBtrace = GvSV((gv_fetchpvs("DB::trace", GV_ADDMULTI, SVt_PV)));
4373 if (!SvIOK(PL_DBtrace))
4374 sv_setiv(PL_DBtrace, 0);
4375 mg = sv_magicext(PL_DBtrace, NULL, PERL_MAGIC_debugvar, &PL_vtbl_debugvar, 0, 0);
4376 mg->mg_private = DBVARMG_TRACE;
4377 SvSETMAGIC(PL_DBtrace);
4379 PL_DBsignal = GvSV((gv_fetchpvs("DB::signal", GV_ADDMULTI, SVt_PV)));
4380 if (!SvIOK(PL_DBsignal))
4381 sv_setiv(PL_DBsignal, 0);
4382 mg = sv_magicext(PL_DBsignal, NULL, PERL_MAGIC_debugvar, &PL_vtbl_debugvar, 0, 0);
4383 mg->mg_private = DBVARMG_SIGNAL;
4384 SvSETMAGIC(PL_DBsignal);
4386 SvREFCNT_dec(PL_curstash);
4387 PL_curstash = ostash;
4390 #ifndef STRESS_REALLOC
4391 #define REASONABLE(size) (size)
4392 #define REASONABLE_but_at_least(size,min) (size)
4394 #define REASONABLE(size) (1) /* unreasonable */
4395 #define REASONABLE_but_at_least(size,min) (min)
4399 Perl_init_stacks(pTHX)
4403 /* start with 128-item stack and 8K cxstack */
4404 PL_curstackinfo = new_stackinfo(REASONABLE(128),
4405 REASONABLE(8192/sizeof(PERL_CONTEXT) - 1));
4406 PL_curstackinfo->si_type = PERLSI_MAIN;
4407 #if defined DEBUGGING && !defined DEBUGGING_RE_ONLY
4408 PL_curstackinfo->si_stack_hwm = 0;
4410 PL_curstack = PL_curstackinfo->si_stack;
4411 PL_mainstack = PL_curstack; /* remember in case we switch stacks */
4413 PL_stack_base = AvARRAY(PL_curstack);
4414 PL_stack_sp = PL_stack_base;
4415 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
4417 Newxz(PL_tmps_stack,REASONABLE(128),SV*);
4420 PL_tmps_max = REASONABLE(128);
4422 Newxz(PL_markstack,REASONABLE(32),I32);
4423 PL_markstack_ptr = PL_markstack;
4424 PL_markstack_max = PL_markstack + REASONABLE(32);
4428 Newxz(PL_scopestack,REASONABLE(32),I32);
4430 Newxz(PL_scopestack_name,REASONABLE(32),const char*);
4432 PL_scopestack_ix = 0;
4433 PL_scopestack_max = REASONABLE(32);
4435 size = REASONABLE_but_at_least(128,SS_MAXPUSH);
4436 Newxz(PL_savestack, size, ANY);
4437 PL_savestack_ix = 0;
4438 /*PL_savestack_max lies: it always has SS_MAXPUSH more than it claims */
4439 PL_savestack_max = size - SS_MAXPUSH;
4447 while (PL_curstackinfo->si_next)
4448 PL_curstackinfo = PL_curstackinfo->si_next;
4449 while (PL_curstackinfo) {
4450 PERL_SI *p = PL_curstackinfo->si_prev;
4451 /* curstackinfo->si_stack got nuked by sv_free_arenas() */
4452 Safefree(PL_curstackinfo->si_cxstack);
4453 Safefree(PL_curstackinfo);
4454 PL_curstackinfo = p;
4456 Safefree(PL_tmps_stack);
4457 Safefree(PL_markstack);
4458 Safefree(PL_scopestack);
4460 Safefree(PL_scopestack_name);
4462 Safefree(PL_savestack);
4466 Perl_populate_isa(pTHX_ const char *name, STRLEN len, ...)
4468 GV *const gv = gv_fetchpvn(name, len, GV_ADD | GV_ADDMULTI, SVt_PVAV);
4469 AV *const isa = GvAVn(gv);
4472 PERL_ARGS_ASSERT_POPULATE_ISA;
4474 if(AvFILLp(isa) != -1)
4477 /* NOTE: No support for tied ISA */
4479 va_start(args, len);
4481 const char *const parent = va_arg(args, const char*);
4486 parent_len = va_arg(args, size_t);
4488 /* Arguments are supplied with a trailing :: */
4489 assert(parent_len > 2);
4490 assert(parent[parent_len - 1] == ':');
4491 assert(parent[parent_len - 2] == ':');
4492 av_push(isa, newSVpvn(parent, parent_len - 2));
4493 (void) gv_fetchpvn(parent, parent_len, GV_ADD, SVt_PVGV);
4500 S_init_predump_symbols(pTHX)
4505 sv_setpvs(get_sv("\"", GV_ADD), " ");
4506 PL_ofsgv = (GV*)SvREFCNT_inc(gv_fetchpvs(",", GV_ADD|GV_NOTQUAL, SVt_PV));
4509 /* Historically, PVIOs were blessed into IO::Handle, unless
4510 FileHandle was loaded, in which case they were blessed into
4511 that. Action at a distance.
4512 However, if we simply bless into IO::Handle, we break code
4513 that assumes that PVIOs will have (among others) a seek
4514 method. IO::File inherits from IO::Handle and IO::Seekable,
4515 and provides the needed methods. But if we simply bless into
4516 it, then we break code that assumed that by loading
4517 IO::Handle, *it* would work.
4518 So a compromise is to set up the correct @IO::File::ISA,
4519 so that code that does C<use IO::Handle>; will still work.
4522 Perl_populate_isa(aTHX_ STR_WITH_LEN("IO::File::ISA"),
4523 STR_WITH_LEN("IO::Handle::"),
4524 STR_WITH_LEN("IO::Seekable::"),
4525 STR_WITH_LEN("Exporter::"),
4528 PL_stdingv = gv_fetchpvs("STDIN", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4529 GvMULTI_on(PL_stdingv);
4530 io = GvIOp(PL_stdingv);
4531 IoTYPE(io) = IoTYPE_RDONLY;
4532 IoIFP(io) = PerlIO_stdin();
4533 tmpgv = gv_fetchpvs("stdin", GV_ADD|GV_NOTQUAL, SVt_PV);
4535 GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4537 tmpgv = gv_fetchpvs("STDOUT", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4540 IoTYPE(io) = IoTYPE_WRONLY;
4541 IoOFP(io) = IoIFP(io) = PerlIO_stdout();
4543 tmpgv = gv_fetchpvs("stdout", GV_ADD|GV_NOTQUAL, SVt_PV);
4545 GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4547 PL_stderrgv = gv_fetchpvs("STDERR", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4548 GvMULTI_on(PL_stderrgv);
4549 io = GvIOp(PL_stderrgv);
4550 IoTYPE(io) = IoTYPE_WRONLY;
4551 IoOFP(io) = IoIFP(io) = PerlIO_stderr();
4552 tmpgv = gv_fetchpvs("stderr", GV_ADD|GV_NOTQUAL, SVt_PV);
4554 GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4556 PL_statname = newSVpvs(""); /* last filename we did stat on */
4560 Perl_init_argv_symbols(pTHX_ int argc, char **argv)
4562 PERL_ARGS_ASSERT_INIT_ARGV_SYMBOLS;
4564 argc--,argv++; /* skip name of script */
4565 if (PL_doswitches) {
4566 for (; argc > 0 && **argv == '-'; argc--,argv++) {
4570 if (argv[0][1] == '-' && !argv[0][2]) {
4574 if ((s = strchr(argv[0], '='))) {
4575 const char *const start_name = argv[0] + 1;
4576 sv_setpv(GvSV(gv_fetchpvn_flags(start_name, s - start_name,
4577 TRUE, SVt_PV)), s + 1);
4580 sv_setiv(GvSV(gv_fetchpv(argv[0]+1, GV_ADD, SVt_PV)),1);
4583 if ((PL_argvgv = gv_fetchpvs("ARGV", GV_ADD|GV_NOTQUAL, SVt_PVAV))) {
4584 SvREFCNT_inc_simple_void_NN(PL_argvgv);
4585 GvMULTI_on(PL_argvgv);
4586 av_clear(GvAVn(PL_argvgv));
4587 for (; argc > 0; argc--,argv++) {
4588 SV * const sv = newSVpv(argv[0],0);
4589 av_push(GvAV(PL_argvgv),sv);
4590 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
4591 if (PL_unicode & PERL_UNICODE_ARGV_FLAG)
4594 if (PL_unicode & PERL_UNICODE_WIDESYSCALLS_FLAG) /* Sarathy? */
4595 (void)sv_utf8_decode(sv);
4599 if (PL_inplace && (!PL_argvgv || AvFILL(GvAV(PL_argvgv)) == -1))
4600 Perl_ck_warner_d(aTHX_ packWARN(WARN_INPLACE),
4601 "-i used with no filenames on the command line, "
4602 "reading from STDIN");
4606 S_init_postdump_symbols(pTHX_ int argc, char **argv, char **env)
4610 PERL_ARGS_ASSERT_INIT_POSTDUMP_SYMBOLS;
4612 PL_toptarget = newSV_type(SVt_PVIV);
4613 SvPVCLEAR(PL_toptarget);
4614 PL_bodytarget = newSV_type(SVt_PVIV);
4615 SvPVCLEAR(PL_bodytarget);
4616 PL_formtarget = PL_bodytarget;
4620 init_argv_symbols(argc,argv);
4622 if ((tmpgv = gv_fetchpvs("0", GV_ADD|GV_NOTQUAL, SVt_PV))) {
4623 sv_setpv(GvSV(tmpgv),PL_origfilename);
4625 if ((PL_envgv = gv_fetchpvs("ENV", GV_ADD|GV_NOTQUAL, SVt_PVHV))) {
4627 bool env_is_not_environ;
4628 SvREFCNT_inc_simple_void_NN(PL_envgv);
4629 GvMULTI_on(PL_envgv);
4630 hv = GvHVn(PL_envgv);
4631 hv_magic(hv, NULL, PERL_MAGIC_env);
4633 #if defined(USE_ENVIRON_ARRAY) || defined(WIN32)
4634 /* Note that if the supplied env parameter is actually a copy
4635 of the global environ then it may now point to free'd memory
4636 if the environment has been modified since. To avoid this
4637 problem we treat env==NULL as meaning 'use the default'
4641 env_is_not_environ = env != environ;
4642 if (env_is_not_environ
4643 # ifdef USE_ITHREADS
4644 && PL_curinterp == aTHX
4652 char **env_copy = env;
4659 count = env_copy - env;
4661 if (count > PERL_HASH_DEFAULT_HvMAX) {
4662 /* This might be an over-estimate (due to dups and other skips),
4663 * but if so, likely it won't hurt much.
4664 * A straw poll of login environments I have suggests that
4665 * between 23 and 52 environment variables are typical (and no
4666 * dups). As the default hash size is 8 buckets, expanding in
4667 * advance saves between 2 and 3 splits in the loop below. */
4668 hv_ksplit(hv, count);
4672 for (; *env; env++) {
4673 char *old_var = *env;
4674 char *s = strchr(old_var, '=');
4678 if (!s || s == old_var)
4683 /* It's tempting to think that this hv_exists/hv_store pair should
4684 * be replaced with a single hv_fetch with the LVALUE flag true.
4685 * However, hv has magic, and if you follow the code in hv_common
4686 * then for LVALUE fetch it recurses once, whereas exists and
4687 * store do not recurse. Hence internally there would be no
4688 * difference in the complexity of the code run. Moreover, all
4689 * calls pass through "is there magic?" special case code, which
4690 * in turn has its own #ifdef ENV_IS_CASELESS special case special
4691 * case. Hence this code shouldn't change, as doing so won't give
4692 * any meaningful speedup, and might well add bugs. */
4694 if (hv_exists(hv, old_var, nlen)) {
4696 const char *name = savepvn(old_var, nlen);
4698 /* make sure we use the same value as getenv(), otherwise code that
4699 uses getenv() (like setlocale()) might see a different value to %ENV
4701 sv = newSVpv(PerlEnv_getenv(name), 0);
4703 /* keep a count of the dups of this name so we can de-dup environ later */
4704 dup = hv_fetch(dups, name, nlen, TRUE);
4712 sv = newSVpv(s+1, 0);
4714 (void)hv_store(hv, old_var, nlen, sv, 0);
4715 if (env_is_not_environ)
4718 if (HvTOTALKEYS(dups)) {
4719 /* environ has some duplicate definitions, remove them */
4722 while ((entry = hv_iternext_flags(dups, 0))) {
4724 const char *name = HePV(entry, nlen);
4725 IV count = SvIV(HeVAL(entry));
4727 SV **valp = hv_fetch(hv, name, nlen, 0);
4731 /* try to remove any duplicate names, depending on the
4732 * implementation used in my_setenv() the iteration might
4733 * not be necessary, but let's be safe.
4735 for (i = 0; i < count; ++i)
4738 /* and set it back to the value we set $ENV{name} to */
4739 my_setenv(name, SvPV_nolen(*valp));
4742 SvREFCNT_dec_NN(dups);
4744 #endif /* USE_ENVIRON_ARRAY */
4745 #endif /* !PERL_MICRO */
4749 /* touch @F array to prevent spurious warnings 20020415 MJD */
4751 (void) get_av("main::F", GV_ADD | GV_ADDMULTI);
4756 S_init_perllib(pTHX)
4759 const char *perl5lib = NULL;
4762 #if defined(WIN32) && !defined(PERL_IS_MINIPERL)
4766 if (!TAINTING_get) {
4768 perl5lib = PerlEnv_getenv("PERL5LIB");
4769 if (perl5lib && *perl5lib != '\0')
4770 incpush_use_sep(perl5lib, 0, INCPUSH_ADD_SUB_DIRS);
4772 s = PerlEnv_getenv("PERLLIB");
4774 incpush_use_sep(s, 0, 0);
4777 /* Treat PERL5?LIB as a possible search list logical name -- the
4778 * "natural" VMS idiom for a Unix path string. We allow each
4779 * element to be a set of |-separated directories for compatibility.
4783 if (vmstrnenv("PERL5LIB",buf,0,NULL,0))
4785 incpush_use_sep(buf, 0, INCPUSH_ADD_SUB_DIRS);
4786 } while (vmstrnenv("PERL5LIB",buf,++idx,NULL,0));
4788 while (vmstrnenv("PERLLIB",buf,idx++,NULL,0))
4789 incpush_use_sep(buf, 0, 0);
4794 #ifndef PERL_IS_MINIPERL
4795 /* miniperl gets just -I..., the split of $ENV{PERL5LIB}, and "." in @INC
4796 (and not the architecture specific directories from $ENV{PERL5LIB}) */
4798 #include "perl_inc_macro.h"
4799 /* Use the ~-expanded versions of APPLLIB (undocumented),
4800 SITEARCH, SITELIB, VENDORARCH, VENDORLIB, ARCHLIB and PRIVLIB
4803 INCPUSH_SITEARCH_EXP
4805 INCPUSH_PERL_VENDORARCH_EXP
4806 INCPUSH_PERL_VENDORLIB_EXP
4809 INCPUSH_PERL_OTHERLIBDIRS
4811 INCPUSH_APPLLIB_OLD_EXP
4812 INCPUSH_SITELIB_STEM
4813 INCPUSH_PERL_VENDORLIB_STEM
4814 INCPUSH_PERL_OTHERLIBDIRS_ARCHONLY
4816 #endif /* !PERL_IS_MINIPERL */
4818 if (!TAINTING_get) {
4819 #if !defined(PERL_IS_MINIPERL) && defined(DEFAULT_INC_EXCLUDES_DOT)
4820 const char * const unsafe = PerlEnv_getenv("PERL_USE_UNSAFE_INC");
4821 if (unsafe && strEQ(unsafe, "1"))
4823 S_incpush(aTHX_ STR_WITH_LEN("."), 0);
4828 # define PERLLIB_SEP ';'
4829 #elif defined(__VMS)
4830 # define PERLLIB_SEP PL_perllib_sep
4832 # define PERLLIB_SEP ':'
4834 #ifndef PERLLIB_MANGLE
4835 # define PERLLIB_MANGLE(s,n) (s)
4838 #ifndef PERL_IS_MINIPERL
4839 /* Push a directory onto @INC if it exists.
4840 Generate a new SV if we do this, to save needing to copy the SV we push
4843 S_incpush_if_exists(pTHX_ AV *const av, SV *dir, SV *const stem)
4847 PERL_ARGS_ASSERT_INCPUSH_IF_EXISTS;
4849 if (PerlLIO_stat(SvPVX_const(dir), &tmpstatbuf) >= 0 &&
4850 S_ISDIR(tmpstatbuf.st_mode)) {
4852 dir = newSVsv(stem);
4854 /* Truncate dir back to stem. */
4855 SvCUR_set(dir, SvCUR(stem));
4862 S_mayberelocate(pTHX_ const char *const dir, STRLEN len, U32 flags)
4864 const U8 canrelocate = (U8)flags & INCPUSH_CAN_RELOCATE;
4867 PERL_ARGS_ASSERT_MAYBERELOCATE;
4870 /* I am not convinced that this is valid when PERLLIB_MANGLE is
4871 defined to so something (in os2/os2.c), but the code has been
4872 this way, ignoring any possible changed of length, since
4873 760ac839baf413929cd31cc32ffd6dba6b781a81 (5.003_02) so I'll leave
4875 libdir = newSVpvn(PERLLIB_MANGLE(dir, len), len);
4881 if ((unix = tounixspec_ts(SvPV(libdir,len),NULL)) != NULL) {
4883 while (len > 1 && unix[len-1] == '/') len--; /* Cosmetic */
4884 sv_usepvn(libdir,unix,len);
4887 PerlIO_printf(Perl_error_log,
4888 "Failed to unixify @INC element \"%s\"\n",
4889 SvPV_nolen_const(libdir));
4893 /* Do the if() outside the #ifdef to avoid warnings about an unused
4896 #ifdef PERL_RELOCATABLE_INC
4898 * Relocatable include entries are marked with a leading .../
4901 * 0: Remove that leading ".../"
4902 * 1: Remove trailing executable name (anything after the last '/')
4903 * from the perl path to give a perl prefix
4905 * While the @INC element starts "../" and the prefix ends with a real
4906 * directory (ie not . or ..) chop that real directory off the prefix
4907 * and the leading "../" from the @INC element. ie a logical "../"
4909 * Finally concatenate the prefix and the remainder of the @INC element
4910 * The intent is that /usr/local/bin/perl and .../../lib/perl5
4911 * generates /usr/local/lib/perl5
4913 const char *libpath = SvPVX(libdir);
4914 STRLEN libpath_len = SvCUR(libdir);
4915 if (memBEGINs(libpath, libpath_len, ".../")) {
4917 SV * const caret_X = get_sv("\030", 0);
4918 /* Going to use the SV just as a scratch buffer holding a C
4924 /* $^X is *the* source of taint if tainting is on, hence
4925 SvPOK() won't be true. */
4927 assert(SvPOKp(caret_X));
4928 prefix_sv = newSVpvn_flags(SvPVX(caret_X), SvCUR(caret_X),
4930 /* Firstly take off the leading .../
4931 If all else fail we'll do the paths relative to the current
4933 sv_chop(libdir, libpath + 4);
4934 /* Don't use SvPV as we're intentionally bypassing taining,
4935 mortal copies that the mg_get of tainting creates, and
4936 corruption that seems to come via the save stack.
4937 I guess that the save stack isn't correctly set up yet. */
4938 libpath = SvPVX(libdir);
4939 libpath_len = SvCUR(libdir);
4941 prefix = SvPVX(prefix_sv);
4942 lastslash = (char *) my_memrchr(prefix, '/',
4943 SvEND(prefix_sv) - prefix);
4945 /* First time in with the *lastslash = '\0' we just wipe off
4946 the trailing /perl from (say) /usr/foo/bin/perl
4950 while ((*lastslash = '\0'), /* Do that, come what may. */
4951 ( memBEGINs(libpath, libpath_len, "../")
4953 (char *) my_memrchr(prefix, '/',
4954 SvEND(prefix_sv) - prefix))))
4956 if (lastslash[1] == '\0'
4957 || (lastslash[1] == '.'
4958 && (lastslash[2] == '/' /* ends "/." */
4959 || (lastslash[2] == '/'
4960 && lastslash[3] == '/' /* or "/.." */
4962 /* Prefix ends "/" or "/." or "/..", any of which
4963 are fishy, so don't do any more logical cleanup.
4967 /* Remove leading "../" from path */
4970 /* Next iteration round the loop removes the last
4971 directory name from prefix by writing a '\0' in
4972 the while clause. */
4974 /* prefix has been terminated with a '\0' to the correct
4975 length. libpath points somewhere into the libdir SV.
4976 We need to join the 2 with '/' and drop the result into
4978 tempsv = Perl_newSVpvf(aTHX_ "%s/%s", prefix, libpath);
4979 SvREFCNT_dec(libdir);
4980 /* And this is the new libdir. */
4983 (PerlProc_getuid() != PerlProc_geteuid() ||
4984 PerlProc_getgid() != PerlProc_getegid())) {
4985 /* Need to taint relocated paths if running set ID */
4986 SvTAINTED_on(libdir);
4989 SvREFCNT_dec(prefix_sv);
4997 S_incpush(pTHX_ const char *const dir, STRLEN len, U32 flags)
4999 #ifndef PERL_IS_MINIPERL
5000 const U8 using_sub_dirs
5001 = (U8)flags & (INCPUSH_ADD_VERSIONED_SUB_DIRS
5002 |INCPUSH_ADD_ARCHONLY_SUB_DIRS|INCPUSH_ADD_OLD_VERS);
5003 const U8 add_versioned_sub_dirs
5004 = (U8)flags & INCPUSH_ADD_VERSIONED_SUB_DIRS;
5005 const U8 add_archonly_sub_dirs
5006 = (U8)flags & INCPUSH_ADD_ARCHONLY_SUB_DIRS;
5007 #ifdef PERL_INC_VERSION_LIST
5008 const U8 addoldvers = (U8)flags & INCPUSH_ADD_OLD_VERS;
5011 const U8 unshift = (U8)flags & INCPUSH_UNSHIFT;
5012 const U8 push_basedir = (flags & INCPUSH_NOT_BASEDIR) ? 0 : 1;
5013 AV *const inc = GvAVn(PL_incgv);
5015 PERL_ARGS_ASSERT_INCPUSH;
5018 /* Could remove this vestigial extra block, if we don't mind a lot of
5019 re-indenting diff noise. */
5021 SV *const libdir = mayberelocate(dir, len, flags);
5022 /* Change 20189146be79a0596543441fa369c6bf7f85103f, to fix RT#6665,
5023 arranged to unshift #! line -I onto the front of @INC. However,
5024 -I can add version and architecture specific libraries, and they
5025 need to go first. The old code assumed that it was always
5026 pushing. Hence to make it work, need to push the architecture
5027 (etc) libraries onto a temporary array, then "unshift" that onto
5028 the front of @INC. */
5029 #ifndef PERL_IS_MINIPERL
5030 AV *const av = (using_sub_dirs) ? (unshift ? newAV() : inc) : NULL;
5033 * BEFORE pushing libdir onto @INC we may first push version- and
5034 * archname-specific sub-directories.
5036 if (using_sub_dirs) {
5037 SV *subdir = newSVsv(libdir);
5038 #ifdef PERL_INC_VERSION_LIST
5039 /* Configure terminates PERL_INC_VERSION_LIST with a NULL */
5040 const char * const incverlist[] = { PERL_INC_VERSION_LIST };
5041 const char * const *incver;
5044 if (add_versioned_sub_dirs) {
5045 /* .../version/archname if -d .../version/archname */
5046 sv_catpvs(subdir, "/" PERL_FS_VERSION "/" ARCHNAME);
5047 subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
5049 /* .../version if -d .../version */
5050 sv_catpvs(subdir, "/" PERL_FS_VERSION);
5051 subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
5054 #ifdef PERL_INC_VERSION_LIST
5056 for (incver = incverlist; *incver; incver++) {
5057 /* .../xxx if -d .../xxx */
5058 Perl_sv_catpvf(aTHX_ subdir, "/%s", *incver);
5059 subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
5064 if (add_archonly_sub_dirs) {
5065 /* .../archname if -d .../archname */
5066 sv_catpvs(subdir, "/" ARCHNAME);
5067 subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
5071 assert (SvREFCNT(subdir) == 1);
5072 SvREFCNT_dec(subdir);
5074 #endif /* !PERL_IS_MINIPERL */
5075 /* finally add this lib directory at the end of @INC */
5077 #ifdef PERL_IS_MINIPERL
5078 const Size_t extra = 0;
5080 Size_t extra = av_count(av);
5082 av_unshift(inc, extra + push_basedir);
5084 av_store(inc, extra, libdir);
5085 #ifndef PERL_IS_MINIPERL
5087 /* av owns a reference, av_store() expects to be donated a
5088 reference, and av expects to be sane when it's cleared.
5089 If I wanted to be naughty and wrong, I could peek inside the
5090 implementation of av_clear(), realise that it uses
5091 SvREFCNT_dec() too, so av's array could be a run of NULLs,
5092 and so directly steal from it (with a memcpy() to inc, and
5093 then memset() to NULL them out. But people copy code from the
5094 core expecting it to be best practise, so let's use the API.
5095 Although studious readers will note that I'm not checking any
5097 av_store(inc, extra, SvREFCNT_inc(*av_fetch(av, extra, FALSE)));
5102 else if (push_basedir) {
5103 av_push(inc, libdir);
5106 if (!push_basedir) {
5107 assert (SvREFCNT(libdir) == 1);
5108 SvREFCNT_dec(libdir);
5114 S_incpush_use_sep(pTHX_ const char *p, STRLEN len, U32 flags)
5118 /* This logic has been broken out from S_incpush(). It may be possible to
5121 PERL_ARGS_ASSERT_INCPUSH_USE_SEP;
5123 /* perl compiled with -DPERL_RELOCATABLE_INCPUSH will ignore the len
5124 * argument to incpush_use_sep. This allows creation of relocatable
5125 * Perl distributions that patch the binary at install time. Those
5126 * distributions will have to provide their own relocation tools; this
5127 * is not a feature otherwise supported by core Perl.
5129 #ifndef PERL_RELOCATABLE_INCPUSH
5136 /* Break at all separators */
5137 while ((s = (const char*)memchr(p, PERLLIB_SEP, end - p))) {
5139 /* skip any consecutive separators */
5141 /* Uncomment the next line for PATH semantics */
5142 /* But you'll need to write tests */
5143 /* av_push(GvAVn(PL_incgv), newSVpvs(".")); */
5145 incpush(p, (STRLEN)(s - p), flags);
5150 incpush(p, (STRLEN)(end - p), flags);
5155 Perl_call_list(pTHX_ I32 oldscope, AV *paramList)
5158 volatile const line_t oldline = PL_curcop ? CopLINE(PL_curcop) : 0;
5164 PERL_ARGS_ASSERT_CALL_LIST;
5166 while (av_count(paramList) > 0) {
5167 cv = MUTABLE_CV(av_shift(paramList));
5169 if (paramList == PL_beginav) {
5170 /* save PL_beginav for compiler */
5171 Perl_av_create_and_push(aTHX_ &PL_beginav_save, MUTABLE_SV(cv));
5173 else if (paramList == PL_checkav) {
5174 /* save PL_checkav for compiler */
5175 Perl_av_create_and_push(aTHX_ &PL_checkav_save, MUTABLE_SV(cv));
5177 else if (paramList == PL_unitcheckav) {
5178 /* save PL_unitcheckav for compiler */
5179 Perl_av_create_and_push(aTHX_ &PL_unitcheckav_save, MUTABLE_SV(cv));
5189 (void)SvPV_const(atsv, len);
5191 PL_curcop = &PL_compiling;
5192 CopLINE_set(PL_curcop, oldline);
5193 if (paramList == PL_beginav)
5194 sv_catpvs(atsv, "BEGIN failed--compilation aborted");
5196 Perl_sv_catpvf(aTHX_ atsv,
5197 "%s failed--call queue aborted",
5198 paramList == PL_checkav ? "CHECK"
5199 : paramList == PL_initav ? "INIT"
5200 : paramList == PL_unitcheckav ? "UNITCHECK"
5202 while (PL_scopestack_ix > oldscope)
5205 Perl_croak(aTHX_ "%" SVf, SVfARG(atsv));
5212 /* my_exit() was called */
5213 while (PL_scopestack_ix > oldscope)
5216 SET_CURSTASH(PL_defstash);
5217 PL_curcop = &PL_compiling;
5218 CopLINE_set(PL_curcop, oldline);
5221 NOT_REACHED; /* NOTREACHED */
5224 PL_curcop = &PL_compiling;
5225 CopLINE_set(PL_curcop, oldline);
5228 PerlIO_printf(Perl_error_log, "panic: restartop in call_list\n");
5239 A wrapper for the C library L<exit(3)>, honoring what L<perlapi/PL_exit_flags>
5246 Perl_my_exit(pTHX_ U32 status)
5248 if (PL_exit_flags & PERL_EXIT_ABORT) {
5251 if (PL_exit_flags & PERL_EXIT_WARN) {
5252 PL_exit_flags |= PERL_EXIT_ABORT; /* Protect against reentrant calls */
5253 Perl_warn(aTHX_ "Unexpected exit %lu", (unsigned long)status);
5254 PL_exit_flags &= ~PERL_EXIT_ABORT;
5264 STATUS_EXIT_SET(status);
5271 =for apidoc my_failure_exit
5273 Exit the running Perl process with an error.
5275 On non-VMS platforms, this is essentially equivalent to L</C<my_exit>>, using
5276 C<errno>, but forces an en error code of 255 if C<errno> is 0.
5278 On VMS, it takes care to set the appropriate severity bits in the exit status.
5284 Perl_my_failure_exit(pTHX)
5287 /* We have been called to fall on our sword. The desired exit code
5288 * should be already set in STATUS_UNIX, but could be shifted over
5289 * by 8 bits. STATUS_UNIX_EXIT_SET will handle the cases where a
5292 * If an error code has not been set, then force the issue.
5294 if (MY_POSIX_EXIT) {
5296 /* According to the die_exit.t tests, if errno is non-zero */
5297 /* It should be used for the error status. */
5299 if (errno == EVMSERR) {
5300 STATUS_NATIVE = vaxc$errno;
5303 /* According to die_exit.t tests, if the child_exit code is */
5304 /* also zero, then we need to exit with a code of 255 */
5305 if ((errno != 0) && (errno < 256))
5306 STATUS_UNIX_EXIT_SET(errno);
5307 else if (STATUS_UNIX < 255) {
5308 STATUS_UNIX_EXIT_SET(255);
5313 /* The exit code could have been set by $? or vmsish which
5314 * means that it may not have fatal set. So convert
5315 * success/warning codes to fatal with out changing
5316 * the POSIX status code. The severity makes VMS native
5317 * status handling work, while UNIX mode programs use the
5320 if ((STATUS_NATIVE & (STS$K_SEVERE|STS$K_ERROR)) == 0) {
5321 STATUS_NATIVE &= STS$M_COND_ID;
5322 STATUS_NATIVE |= STS$K_ERROR | STS$M_INHIB_MSG;
5326 /* Traditionally Perl on VMS always expects a Fatal Error. */
5327 if (vaxc$errno & 1) {
5329 /* So force success status to failure */
5330 if (STATUS_NATIVE & 1)
5335 STATUS_UNIX = EINTR; /* In case something cares */
5340 STATUS_NATIVE = vaxc$errno; /* Should already be this */
5342 /* Encode the severity code */
5343 severity = STATUS_NATIVE & STS$M_SEVERITY;
5344 STATUS_UNIX = (severity ? severity : 1) << 8;
5346 /* Perl expects this to be a fatal error */
5347 if (severity != STS$K_SEVERE)
5357 STATUS_UNIX_SET(eno);
5359 exitstatus = STATUS_UNIX >> 8;
5360 if (exitstatus & 255)
5361 STATUS_UNIX_SET(exitstatus);
5363 STATUS_UNIX_SET(255);
5366 if (PL_exit_flags & PERL_EXIT_ABORT) {
5369 if (PL_exit_flags & PERL_EXIT_WARN) {
5370 PL_exit_flags |= PERL_EXIT_ABORT; /* Protect against reentrant calls */
5371 Perl_warn(aTHX_ "Unexpected exit failure %ld", (long)PL_statusvalue);
5372 PL_exit_flags &= ~PERL_EXIT_ABORT;
5378 S_my_exit_jump(pTHX)
5381 SvREFCNT_dec(PL_e_script);
5385 POPSTACK_TO(PL_mainstack);
5386 if (cxstack_ix >= 0) {
5388 cx_popblock(cxstack);
5396 read_e_script(pTHX_ int idx, SV *buf_sv, int maxlen)
5398 const char * const p = SvPVX_const(PL_e_script);
5399 const char * const e = SvEND(PL_e_script);
5400 const char *nl = (char *) memchr(p, '\n', e - p);
5402 PERL_UNUSED_ARG(idx);
5403 PERL_UNUSED_ARG(maxlen);
5405 nl = (nl) ? nl+1 : e;
5407 filter_del(read_e_script);
5410 sv_catpvn(buf_sv, p, nl-p);
5411 sv_chop(PL_e_script, nl);
5415 /* removes boilerplate code at the end of each boot_Module xsub */
5417 Perl_xs_boot_epilog(pTHX_ const I32 ax)
5420 call_list(PL_scopestack_ix, PL_unitcheckav);
5425 * ex: set ts=8 sts=4 sw=4 et: