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, 2023
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_LIST_BODY(cv) \
71 PUSHMARK(PL_stack_sp); \
72 call_sv(MUTABLE_SV((cv)), G_EVAL|G_DISCARD|G_VOID);
75 S_init_tls_and_interp(PerlInterpreter *my_perl)
78 PERL_SET_INTERP(my_perl);
79 #if defined(USE_ITHREADS)
82 PERL_SET_THX(my_perl);
85 KEYWORD_PLUGIN_MUTEX_INIT;
90 MUTEX_INIT(&PL_dollarzero_mutex);
91 MUTEX_INIT(&PL_my_ctx_mutex);
94 #if defined(USE_ITHREADS)
97 /* This always happens for non-ithreads */
100 PERL_SET_THX(my_perl);
105 #ifndef PLATFORM_SYS_INIT_
106 # define PLATFORM_SYS_INIT_ NOOP
109 #ifndef PLATFORM_SYS_TERM_
110 # define PLATFORM_SYS_TERM_ NOOP
113 #ifndef PERL_SYS_INIT_BODY
114 # define PERL_SYS_INIT_BODY(c,v) \
115 MALLOC_CHECK_TAINT2(*c,*v) PERL_FPU_INIT; PERLIO_INIT; \
116 MALLOC_INIT; PLATFORM_SYS_INIT_;
119 /* Generally add things last-in first-terminated. IO and memory terminations
120 * need to be generally last
122 * BEWARE that using PerlIO in these will be using freed memory, so may appear
123 * to work, but must NOT be retained in production code. */
124 #ifndef PERL_SYS_TERM_BODY
125 # define PERL_SYS_TERM_BODY() \
126 ENV_TERM; USER_PROP_MUTEX_TERM; LOCALE_TERM; \
127 HINTS_REFCNT_TERM; KEYWORD_PLUGIN_MUTEX_TERM; \
128 OP_CHECK_MUTEX_TERM; OP_REFCNT_TERM; \
129 PERLIO_TERM; MALLOC_TERM; \
133 /* these implement the PERL_SYS_INIT, PERL_SYS_INIT3, PERL_SYS_TERM macros */
136 Perl_sys_init(int* argc, char*** argv)
139 PERL_ARGS_ASSERT_SYS_INIT;
141 PERL_UNUSED_ARG(argc); /* may not be used depending on _BODY macro */
142 PERL_UNUSED_ARG(argv);
143 PERL_SYS_INIT_BODY(argc, argv);
147 Perl_sys_init3(int* argc, char*** argv, char*** env)
150 PERL_ARGS_ASSERT_SYS_INIT3;
152 PERL_UNUSED_ARG(argc); /* may not be used depending on _BODY macro */
153 PERL_UNUSED_ARG(argv);
154 PERL_UNUSED_ARG(env);
155 PERL_SYS_INIT3_BODY(argc, argv, env);
161 if (!PL_veto_cleanup) {
162 PERL_SYS_TERM_BODY();
167 #ifdef PERL_IMPLICIT_SYS
169 perl_alloc_using(struct IPerlMem* ipM, struct IPerlMem* ipMS,
170 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
171 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
172 struct IPerlDir* ipD, struct IPerlSock* ipS,
173 struct IPerlProc* ipP)
175 PerlInterpreter *my_perl;
177 PERL_ARGS_ASSERT_PERL_ALLOC_USING;
179 /* Newx() needs interpreter, so call malloc() instead */
180 my_perl = (PerlInterpreter*)(*ipM->pCalloc)(ipM, 1, sizeof(PerlInterpreter));
181 S_init_tls_and_interp(my_perl);
191 INIT_TRACK_MEMPOOL(PL_memory_debug_header, my_perl);
198 =for apidoc_section $embedding
200 =for apidoc perl_alloc
202 Allocates a new Perl interpreter. See L<perlembed>.
210 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_calloc(1, sizeof(PerlInterpreter));
212 S_init_tls_and_interp(my_perl);
213 INIT_TRACK_MEMPOOL(PL_memory_debug_header, my_perl);
216 #endif /* PERL_IMPLICIT_SYS */
219 =for apidoc perl_construct
221 Initializes a new Perl interpreter. See L<perlembed>.
227 perl_construct(pTHXx)
230 PERL_ARGS_ASSERT_PERL_CONSTRUCT;
234 PL_perl_destruct_level = 1;
236 PERL_UNUSED_ARG(my_perl);
237 if (PL_perl_destruct_level > 0)
240 PL_curcop = &PL_compiling; /* needed by ckWARN, right away */
242 #ifdef PERL_TRACE_OPS
243 Zero(PL_op_exec_cnt, OP_max+2, UV);
248 SvREADONLY_on(&PL_sv_placeholder);
249 SvREFCNT(&PL_sv_placeholder) = SvREFCNT_IMMORTAL;
251 PL_sighandlerp = Perl_sighandler;
252 PL_sighandler1p = Perl_sighandler1;
253 PL_sighandler3p = Perl_sighandler3;
255 #ifdef PERL_USES_PL_PIDSTATUS
256 PL_pidstatus = newHV();
259 PL_rs = newSVpvs("\n");
263 #if !defined(NO_PERL_RAND_SEED) || !defined(NO_PERL_INTERNAL_HASH_SEED)
264 bool sensitive_env_vars_allowed =
265 (PerlProc_getuid() == PerlProc_geteuid() &&
266 PerlProc_getgid() == PerlProc_getegid()) ? TRUE : FALSE;
269 /* The seed set-up must be after init_stacks because it calls
270 * things that may put SVs on the stack.
272 #ifndef NO_PERL_RAND_SEED
273 if (sensitive_env_vars_allowed) {
276 if ((env_pv = PerlEnv_getenv("PERL_RAND_SEED")) &&
277 grok_number(env_pv, strlen(env_pv), &seed) == IS_NUMBER_IN_UV)
280 PL_srand_override_next = seed;
281 PERL_SRAND_OVERRIDE_NEXT_INIT();
286 /* This is NOT the state used for C<rand()>, this is only
287 * used in internal functionality */
288 #ifdef NO_PERL_INTERNAL_RAND_SEED
289 Perl_drand48_init_r(&PL_internal_random_state, seed());
295 !sensitive_env_vars_allowed ||
296 !(env_pv = PerlEnv_getenv("PERL_INTERNAL_RAND_SEED")) ||
297 grok_number(env_pv, strlen(env_pv), &seed) != IS_NUMBER_IN_UV)
299 /* use a randomly generated seed */
302 Perl_drand48_init_r(&PL_internal_random_state, (U32)seed);
312 (void) uvchr_to_utf8_flags((U8 *) PL_TR_SPECIAL_HANDLING_UTF8,
314 UNICODE_ALLOW_ABOVE_IV_MAX);
316 #if defined(LOCAL_PATCH_COUNT)
317 PL_localpatches = local_patches; /* For possible -v */
320 #if defined(LIBM_LIB_VERSION)
322 * Some BSDs and Cygwin default to POSIX math instead of IEEE.
323 * This switches them over to IEEE.
325 _LIB_VERSION = _IEEE_;
328 #ifdef HAVE_INTERP_INTERN
332 PerlIO_init(aTHX); /* Hook to IO system */
334 PL_fdpid = newAV(); /* for remembering popen pids by fd */
335 PL_modglobal = newHV(); /* pointers to per-interpreter module globals */
336 PL_errors = newSVpvs("");
337 SvPVCLEAR(PERL_DEBUG_PAD(0)); /* For regex debugging. */
338 SvPVCLEAR(PERL_DEBUG_PAD(1)); /* ext/re needs these */
339 SvPVCLEAR(PERL_DEBUG_PAD(2)); /* even without DEBUGGING. */
341 /* First entry is a list of empty elements. It needs to be initialised
342 else all hell breaks loose in S_find_uninit_var(). */
343 Perl_av_create_and_push(aTHX_ &PL_regex_padav, newSVpvs(""));
344 PL_regex_pad = AvARRAY(PL_regex_padav);
345 Newxz(PL_stashpad, PL_stashpadmax, HV *);
347 #ifdef USE_REENTRANT_API
348 Perl_reentrant_init(aTHX);
350 if (PL_hash_seed_set == FALSE) {
351 /* Initialize the hash seed and state at startup. This must be
352 * done very early, before ANY hashes are constructed, and once
353 * setup is fixed for the lifetime of the process.
355 * If you decide to disable the seeding process you should choose
356 * a suitable seed yourself and define PERL_HASH_SEED to a well chosen
357 * string. See hv_func.h for details.
359 #if defined(USE_HASH_SEED)
360 /* get the hash seed from the environment or from an RNG */
361 Perl_get_hash_seed(aTHX_ PL_hash_seed);
363 /* they want a hard coded seed, check that it is long enough */
364 assert( strlen(PERL_HASH_SEED) >= PERL_HASH_SEED_BYTES );
367 /* now we use the chosen seed to initialize the state -
368 * in some configurations this may be a relatively speaking
369 * expensive operation, but we only have to do it once at startup */
370 PERL_HASH_SEED_STATE(PERL_HASH_SEED,PL_hash_state);
372 #ifdef PERL_USE_SINGLE_CHAR_HASH_CACHE
373 /* we can build a special cache for 0/1 byte keys, if people choose
374 * I suspect most of the time it is not worth it */
378 for (i=0;i<256;i++) {
380 PERL_HASH_WITH_STATE(PL_hash_state,PL_hash_chars[i],str,1);
382 PERL_HASH_WITH_STATE(PL_hash_state,PL_hash_chars[256],str,0);
385 /* at this point we have initialized the hash function, and we can start
386 * constructing hashes */
387 PL_hash_seed_set= TRUE;
390 /* Allow PL_strtab to be pre-initialized before calling perl_construct.
391 * can use a custom optimized PL_strtab hash before calling perl_construct */
393 /* Note that strtab is a rather special HV. Assumptions are made
394 about not iterating on it, and not adding tie magic to it.
395 It is properly deallocated in perl_destruct() */
398 /* SHAREKEYS tells us that the hash has its keys shared with PL_strtab,
399 * which is not the case with PL_strtab itself */
400 HvSHAREKEYS_off(PL_strtab); /* mandatory */
401 hv_ksplit(PL_strtab, 1 << 11);
405 PL_compiling.cop_file = NULL;
406 PL_compiling.cop_warnings = NULL;
409 Zero(PL_sv_consts, SV_CONSTS_COUNT, SV*);
411 #ifdef USE_ENVIRON_ARRAY
413 PL_origenviron = environ;
416 /* Use sysconf(_SC_CLK_TCK) if available, if not
417 * available or if the sysconf() fails, use the HZ.
418 * The HZ if not originally defined has been by now
419 * been defined as CLK_TCK, if available. */
420 #if defined(HAS_SYSCONF) && defined(_SC_CLK_TCK)
421 PL_clocktick = sysconf(_SC_CLK_TCK);
422 if (PL_clocktick <= 0)
426 PL_stashcache = newHV();
428 PL_patchlevel = newSVpvs("v" PERL_VERSION_STRING);
431 if (!PL_mmap_page_size) {
432 #if defined(HAS_SYSCONF) && (defined(_SC_PAGESIZE) || defined(_SC_MMAP_PAGE_SIZE))
434 SETERRNO(0, SS_NORMAL);
436 PL_mmap_page_size = sysconf(_SC_PAGESIZE);
438 PL_mmap_page_size = sysconf(_SC_MMAP_PAGE_SIZE);
440 if ((long) PL_mmap_page_size < 0) {
441 Perl_croak(aTHX_ "panic: sysconf: %s",
442 errno ? Strerror(errno) : "pagesize unknown");
445 #elif defined(HAS_GETPAGESIZE)
446 PL_mmap_page_size = getpagesize();
447 #elif defined(I_SYS_PARAM) && defined(PAGESIZE)
448 PL_mmap_page_size = PAGESIZE; /* compiletime, bad */
450 if (PL_mmap_page_size <= 0)
451 Perl_croak(aTHX_ "panic: bad pagesize %" IVdf,
452 (IV) PL_mmap_page_size);
454 #endif /* HAS_MMAP */
456 PL_osname = Perl_savepvn(aTHX_ STR_WITH_LEN(OSNAME));
458 PL_registered_mros = newHV();
459 /* Start with 1 bucket, for DFS. It's unlikely we'll need more. */
460 HvMAX(PL_registered_mros) = 0;
467 =for apidoc nothreadhook
469 Stub that provides thread hook for perl_destruct when there are
476 Perl_nothreadhook(pTHX)
482 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
484 Perl_dump_sv_child(pTHX_ SV *sv)
487 const int sock = PL_dumper_fd;
488 const int debug_fd = PerlIO_fileno(Perl_debug_log);
489 union control_un control;
492 struct cmsghdr *cmptr;
494 unsigned char buffer[256];
496 PERL_ARGS_ASSERT_DUMP_SV_CHILD;
498 if(sock == -1 || debug_fd == -1)
501 PerlIO_flush(Perl_debug_log);
503 /* All these shenanigans are to pass a file descriptor over to our child for
504 it to dump out to. We can't let it hold open the file descriptor when it
505 forks, as the file descriptor it will dump to can turn out to be one end
506 of pipe that some other process will wait on for EOF. (So as it would
507 be open, the wait would be forever.) */
509 msg.msg_control = control.control;
510 msg.msg_controllen = sizeof(control.control);
511 /* We're a connected socket so we don't need a destination */
517 cmptr = CMSG_FIRSTHDR(&msg);
518 cmptr->cmsg_len = CMSG_LEN(sizeof(int));
519 cmptr->cmsg_level = SOL_SOCKET;
520 cmptr->cmsg_type = SCM_RIGHTS;
521 *((int *)CMSG_DATA(cmptr)) = 1;
523 vec[0].iov_base = (void*)&sv;
524 vec[0].iov_len = sizeof(sv);
525 got = sendmsg(sock, &msg, 0);
528 perror("Debug leaking scalars parent sendmsg failed");
531 if(got < sizeof(sv)) {
532 perror("Debug leaking scalars parent short sendmsg");
536 /* Return protocol is
538 unsigned char: length of location string (0 for empty)
539 unsigned char*: string (not terminated)
541 vec[0].iov_base = (void*)&returned_errno;
542 vec[0].iov_len = sizeof(returned_errno);
543 vec[1].iov_base = buffer;
546 got = readv(sock, vec, 2);
549 perror("Debug leaking scalars parent read failed");
550 PerlIO_flush(PerlIO_stderr());
553 if(got < sizeof(returned_errno) + 1) {
554 perror("Debug leaking scalars parent short read");
555 PerlIO_flush(PerlIO_stderr());
560 got = read(sock, buffer + 1, *buffer);
562 perror("Debug leaking scalars parent read 2 failed");
563 PerlIO_flush(PerlIO_stderr());
568 perror("Debug leaking scalars parent short read 2");
569 PerlIO_flush(PerlIO_stderr());
574 if (returned_errno || *buffer) {
575 Perl_warn(aTHX_ "Debug leaking scalars child failed%s%.*s with errno"
576 " %d: %s", (*buffer ? " at " : ""), (int) *buffer, buffer + 1,
577 returned_errno, Strerror(returned_errno));
583 =for apidoc perl_destruct
585 Shuts down a Perl interpreter. See L<perlembed> for a tutorial.
587 C<my_perl> points to the Perl interpreter. It must have been previously
588 created through the use of L</perl_alloc> and L</perl_construct>. It may
589 have been initialised through L</perl_parse>, and may have been used
590 through L</perl_run> and other means. This function should be called for
591 any Perl interpreter that has been constructed with L</perl_construct>,
592 even if subsequent operations on it failed, for example if L</perl_parse>
593 returned a non-zero value.
595 If the interpreter's C<PL_exit_flags> word has the
596 C<PERL_EXIT_DESTRUCT_END> flag set, then this function will execute code
597 in C<END> blocks before performing the rest of destruction. If it is
598 desired to make any use of the interpreter between L</perl_parse> and
599 L</perl_destruct> other than just calling L</perl_run>, then this flag
600 should be set early on. This matters if L</perl_run> will not be called,
601 or if anything else will be done in addition to calling L</perl_run>.
603 Returns a value be a suitable value to pass to the C library function
604 C<exit> (or to return from C<main>), to serve as an exit code indicating
605 the nature of the way the interpreter terminated. This takes into account
606 any failure of L</perl_parse> and any early exit from L</perl_run>.
607 The exit code is of the type required by the host operating system,
608 so because of differing exit code conventions it is not portable to
609 interpret specific numeric values as having specific meanings.
617 volatile signed char destruct_level; /* see possible values in intrpvar.h */
619 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
624 PERL_ARGS_ASSERT_PERL_DESTRUCT;
626 PERL_UNUSED_ARG(my_perl);
629 assert(PL_scopestack_ix == 1);
631 destruct_level = PL_perl_destruct_level;
633 const char * const s = PerlEnv_getenv("PERL_DESTRUCT_LEVEL");
636 if (strEQ(s, "-1")) { /* Special case: modperl folklore. */
640 if (grok_atoUV(s, &uv, NULL) && uv <= INT_MAX)
645 if (destruct_level < i) destruct_level = i;
646 #ifdef PERL_TRACK_MEMPOOL
647 /* RT #114496, for perl_free */
648 PL_perl_destruct_level = i;
653 if (PL_exit_flags & PERL_EXIT_DESTRUCT_END) {
659 if (PL_endav && !PL_minus_c) {
660 PERL_SET_PHASE(PERL_PHASE_END);
661 call_list(PL_scopestack_ix, PL_endav);
667 assert(PL_scopestack_ix == 0);
669 /* wait for all pseudo-forked children to finish */
670 PERL_WAIT_FOR_CHILDREN;
673 /* normally when we get here, PL_parser should be null due to having
674 * its original (null) value restored by SAVEt_PARSER during leaving
675 * scope (usually before run-time starts in fact).
676 * But if a thread is created within a BEGIN block, the parser is
677 * duped, but the SAVEt_PARSER savestack entry isn't. So PL_parser
678 * never gets cleaned up.
679 * Clean it up here instead. This is a bit of a hack.
682 /* stop parser_free() stomping on PL_curcop */
683 PL_parser->saved_curcop = PL_curcop;
684 parser_free(PL_parser);
688 /* Need to flush since END blocks can produce output */
689 /* flush stdout separately, since we can identify it */
692 PerlIO *stdo = PerlIO_stdout();
693 if (*stdo && PerlIO_flush(stdo)) {
694 PerlIO_restore_errno(stdo);
696 PerlIO_printf(PerlIO_stderr(), "Unable to flush stdout: %s\n",
705 #ifdef PERL_TRACE_OPS
706 /* dump OP-counts if $ENV{PERL_TRACE_OPS} > 0 */
708 const char * const ptoenv = PerlEnv_getenv("PERL_TRACE_OPS");
711 if (!ptoenv || !Perl_grok_atoUV(ptoenv, &uv, NULL)
715 PerlIO_printf(Perl_debug_log, "Trace of all OPs executed:\n");
716 for (i = 0; i <= OP_max; ++i) {
717 if (PL_op_exec_cnt[i])
718 PerlIO_printf(Perl_debug_log, " %s: %" UVuf "\n", PL_op_name[i], PL_op_exec_cnt[i]);
720 /* Utility slot for easily doing little tracing experiments in the runloop: */
721 if (PL_op_exec_cnt[OP_max+1] != 0)
722 PerlIO_printf(Perl_debug_log, " SPECIAL: %" UVuf "\n", PL_op_exec_cnt[OP_max+1]);
723 PerlIO_printf(Perl_debug_log, "\n");
728 if (PL_threadhook(aTHX)) {
729 /* Threads hook has vetoed further cleanup */
730 PL_veto_cleanup = TRUE;
734 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
735 if (destruct_level != 0) {
736 /* Fork here to create a child. Our child's job is to preserve the
737 state of scalars prior to destruction, so that we can instruct it
738 to dump any scalars that we later find have leaked.
739 There's no subtlety in this code - it assumes POSIX, and it doesn't
743 if(PerlSock_socketpair_cloexec(AF_UNIX, SOCK_STREAM, 0, fd)) {
744 perror("Debug leaking scalars socketpair failed");
750 perror("Debug leaking scalars fork failed");
754 /* We are the child */
755 const int sock = fd[1];
756 const int debug_fd = PerlIO_fileno(Perl_debug_log);
759 /* Our success message is an integer 0, and a char 0 */
760 static const char success[sizeof(int) + 1] = {0};
764 /* We need to close all other file descriptors otherwise we end up
765 with interesting hangs, where the parent closes its end of a
766 pipe, and sits waiting for (another) child to terminate. Only
767 that child never terminates, because it never gets EOF, because
768 we also have the far end of the pipe open. We even need to
769 close the debugging fd, because sometimes it happens to be one
770 end of a pipe, and a process is waiting on the other end for
771 EOF. Normally it would be closed at some point earlier in
772 destruction, but if we happen to cause the pipe to remain open,
773 EOF never occurs, and we get an infinite hang. Hence all the
774 games to pass in a file descriptor if it's actually needed. */
776 f = sysconf(_SC_OPEN_MAX);
778 where = "sysconf failed";
789 union control_un control;
792 struct cmsghdr *cmptr;
796 msg.msg_control = control.control;
797 msg.msg_controllen = sizeof(control.control);
798 /* We're a connected socket so we don't need a source */
802 msg.msg_iovlen = C_ARRAY_LENGTH(vec);
804 vec[0].iov_base = (void*)⌖
805 vec[0].iov_len = sizeof(target);
807 got = recvmsg(sock, &msg, 0);
812 where = "recv failed";
815 if(got < sizeof(target)) {
816 where = "short recv";
820 if(!(cmptr = CMSG_FIRSTHDR(&msg))) {
824 if(cmptr->cmsg_len != CMSG_LEN(sizeof(int))) {
825 where = "wrong cmsg_len";
828 if(cmptr->cmsg_level != SOL_SOCKET) {
829 where = "wrong cmsg_level";
832 if(cmptr->cmsg_type != SCM_RIGHTS) {
833 where = "wrong cmsg_type";
837 got_fd = *(int*)CMSG_DATA(cmptr);
838 /* For our last little bit of trickery, put the file descriptor
839 back into Perl_debug_log, as if we never actually closed it
841 if(got_fd != debug_fd) {
842 if (PerlLIO_dup2_cloexec(got_fd, debug_fd) == -1) {
849 PerlIO_flush(Perl_debug_log);
851 got = write(sock, &success, sizeof(success));
854 where = "write failed";
857 if(got < sizeof(success)) {
858 where = "short write";
865 int send_errno = errno;
866 unsigned char length = (unsigned char) strlen(where);
867 struct iovec failure[3] = {
868 {(void*)&send_errno, sizeof(send_errno)},
870 {(void*)where, length}
872 int got = writev(sock, failure, 3);
873 /* Bad news travels fast. Faster than data. We'll get a SIGPIPE
874 in the parent if we try to read from the socketpair after the
875 child has exited, even if there was data to read.
876 So sleep a bit to give the parent a fighting chance of
879 _exit((got == -1) ? errno : 0);
883 PL_dumper_fd = fd[0];
888 /* We must account for everything. */
890 /* Destroy the main CV and syntax tree */
891 /* Set PL_curcop now, because destroying ops can cause new SVs
892 to be generated in Perl_pad_swipe, and when running with
893 -DDEBUG_LEAKING_SCALARS they expect PL_curcop to point to a valid
894 op from which the filename structure member is copied. */
895 PL_curcop = &PL_compiling;
897 /* ensure comppad/curpad to refer to main's pad */
898 if (CvPADLIST(PL_main_cv)) {
899 PAD_SET_CUR_NOSAVE(CvPADLIST(PL_main_cv), 1);
900 PL_comppad_name = PadlistNAMES(CvPADLIST(PL_main_cv));
902 op_free(PL_main_root);
905 PL_main_start = NULL;
906 /* note that PL_main_cv isn't usually actually freed at this point,
907 * due to the CvOUTSIDE refs from subs compiled within it. It will
908 * get freed once all the subs are freed in sv_clean_all(), for
909 * destruct_level > 0 */
910 SvREFCNT_dec(PL_main_cv);
912 PERL_SET_PHASE(PERL_PHASE_DESTRUCT);
914 /* Tell PerlIO we are about to tear things apart in case
915 we have layers which are using resources that should
919 PerlIO_destruct(aTHX);
922 * Try to destruct global references. We do this first so that the
923 * destructors and destructees still exist. Some sv's might remain.
924 * Non-referenced objects are on their own.
928 /* unhook hooks which will soon be, or use, destroyed data */
929 SvREFCNT_dec(PL_warnhook);
931 SvREFCNT_dec(PL_diehook);
933 SvREFCNT_dec(PL_hook__require__before);
934 PL_hook__require__before = NULL;
935 SvREFCNT_dec(PL_hook__require__after);
936 PL_hook__require__after = NULL;
938 /* call exit list functions */
939 while (PL_exitlistlen-- > 0)
940 PL_exitlist[PL_exitlistlen].fn(aTHX_ PL_exitlist[PL_exitlistlen].ptr);
942 Safefree(PL_exitlist);
947 SvREFCNT_dec(PL_registered_mros);
949 if (destruct_level == 0) {
951 DEBUG_P(debprofdump());
953 #if defined(PERLIO_LAYERS)
954 /* No more IO - including error messages ! */
955 PerlIO_cleanup(aTHX);
958 CopFILE_free(&PL_compiling);
960 /* The exit() function will do everything that needs doing. */
964 /* Below, do clean up for when PERL_DESTRUCT_LEVEL is not 0 */
967 /* the syntax tree is shared between clones
968 * so op_free(PL_main_root) only ReREFCNT_dec's
969 * REGEXPs in the parent interpreter
970 * we need to manually ReREFCNT_dec for the clones
973 I32 i = AvFILLp(PL_regex_padav);
974 SV **ary = AvARRAY(PL_regex_padav);
977 SvREFCNT_dec(ary[i]);
978 ary[i] = &PL_sv_undef;
984 SvREFCNT_dec(MUTABLE_SV(PL_stashcache));
985 PL_stashcache = NULL;
987 /* loosen bonds of global variables */
989 /* XXX can PL_parser still be non-null here? */
990 if(PL_parser && PL_parser->rsfp) {
991 (void)PerlIO_close(PL_parser->rsfp);
992 PL_parser->rsfp = NULL;
996 Safefree(PL_splitstr);
1006 PL_doswitches = FALSE;
1007 PL_dowarn = G_WARN_OFF;
1008 #ifdef PERL_SAWAMPERSAND
1009 PL_sawampersand = 0; /* must save all match strings */
1013 Safefree(PL_inplace);
1015 SvREFCNT_dec(PL_patchlevel);
1018 SvREFCNT_dec(PL_e_script);
1024 /* magical thingies */
1026 SvREFCNT_dec(PL_ofsgv); /* *, */
1029 SvREFCNT_dec(PL_ors_sv); /* $\ */
1032 SvREFCNT_dec(PL_rs); /* $/ */
1035 Safefree(PL_osname); /* $^O */
1038 SvREFCNT_dec(PL_statname);
1042 /* defgv, aka *_ should be taken care of elsewhere */
1045 Safefree(PL_efloatbuf);
1046 PL_efloatbuf = NULL;
1049 /* startup and shutdown function lists */
1050 SvREFCNT_dec(PL_beginav);
1051 SvREFCNT_dec(PL_beginav_save);
1052 SvREFCNT_dec(PL_endav);
1053 SvREFCNT_dec(PL_checkav);
1054 SvREFCNT_dec(PL_checkav_save);
1055 SvREFCNT_dec(PL_unitcheckav);
1056 SvREFCNT_dec(PL_unitcheckav_save);
1057 SvREFCNT_dec(PL_initav);
1059 PL_beginav_save = NULL;
1062 PL_checkav_save = NULL;
1063 PL_unitcheckav = NULL;
1064 PL_unitcheckav_save = NULL;
1067 /* shortcuts just get cleared */
1070 PL_argvoutgv = NULL;
1073 PL_last_in_gv = NULL;
1084 SvREFCNT_dec(PL_envgv);
1085 SvREFCNT_dec(PL_incgv);
1086 SvREFCNT_dec(PL_argvgv);
1087 SvREFCNT_dec(PL_replgv);
1088 SvREFCNT_dec(PL_DBgv);
1089 SvREFCNT_dec(PL_DBline);
1090 SvREFCNT_dec(PL_DBsub);
1099 SvREFCNT_dec(PL_argvout_stack);
1100 PL_argvout_stack = NULL;
1102 SvREFCNT_dec(PL_modglobal);
1103 PL_modglobal = NULL;
1104 SvREFCNT_dec(PL_preambleav);
1105 PL_preambleav = NULL;
1106 SvREFCNT_dec(PL_subname);
1108 #ifdef PERL_USES_PL_PIDSTATUS
1109 SvREFCNT_dec(PL_pidstatus);
1110 PL_pidstatus = NULL;
1112 SvREFCNT_dec(PL_toptarget);
1113 PL_toptarget = NULL;
1114 SvREFCNT_dec(PL_bodytarget);
1115 PL_bodytarget = NULL;
1116 PL_formtarget = NULL;
1118 /* free locale stuff */
1119 #ifdef USE_LOCALE_COLLATE
1120 Safefree(PL_collation_name);
1121 PL_collation_name = NULL;
1123 #if defined(USE_PL_CURLOCALES)
1124 for (i = 0; i < (int) C_ARRAY_LENGTH(PL_curlocales); i++) {
1125 Safefree(PL_curlocales[i]);
1126 PL_curlocales[i] = NULL;
1129 #if defined(USE_POSIX_2008_LOCALE) && defined(USE_THREADS)
1131 /* This also makes sure we aren't using a locale object that gets freed
1133 if ( PL_cur_locale_obj != NULL
1134 && PL_cur_locale_obj != LC_GLOBAL_LOCALE
1135 && PL_cur_locale_obj != PL_C_locale_obj
1137 locale_t cur_locale = uselocale((locale_t) 0);
1138 if (cur_locale == PL_cur_locale_obj) {
1139 uselocale(LC_GLOBAL_LOCALE);
1142 freelocale(PL_cur_locale_obj);
1143 PL_cur_locale_obj = NULL;
1147 # ifdef USE_PL_CUR_LC_ALL
1149 if (PL_cur_LC_ALL) {
1150 DEBUG_L( PerlIO_printf(Perl_debug_log, "PL_cur_LC_ALL=%p\n", PL_cur_LC_ALL));
1151 Safefree(PL_cur_LC_ALL);
1152 PL_cur_LC_ALL = NULL;
1157 if (PL_scratch_locale_obj) {
1158 freelocale(PL_scratch_locale_obj);
1159 PL_scratch_locale_obj = NULL;
1162 #ifdef USE_LOCALE_NUMERIC
1163 Safefree(PL_numeric_name);
1164 PL_numeric_name = NULL;
1165 SvREFCNT_dec(PL_numeric_radix_sv);
1166 PL_numeric_radix_sv = NULL;
1167 SvREFCNT_dec(PL_underlying_radix_sv);
1168 PL_underlying_radix_sv = NULL;
1170 #ifdef USE_LOCALE_CTYPE
1171 Safefree(PL_ctype_name);
1172 PL_ctype_name = NULL;
1175 if (PL_setlocale_buf) {
1176 Safefree(PL_setlocale_buf);
1177 PL_setlocale_buf = NULL;
1180 if (PL_langinfo_buf) {
1181 Safefree(PL_langinfo_buf);
1182 PL_langinfo_buf = NULL;
1185 #if defined(USE_LOCALE_THREADS) && ! defined(USE_THREAD_SAFE_LOCALE)
1186 if (PL_less_dicey_locale_buf) {
1187 Safefree(PL_less_dicey_locale_buf);
1188 PL_less_dicey_locale_buf = NULL;
1192 #ifdef USE_LOCALE_CTYPE
1193 SvREFCNT_dec(PL_warn_locale);
1194 PL_warn_locale = NULL;
1197 SvREFCNT_dec(PL_AboveLatin1);
1198 PL_AboveLatin1 = NULL;
1199 SvREFCNT_dec(PL_Assigned_invlist);
1200 PL_Assigned_invlist = NULL;
1201 SvREFCNT_dec(PL_GCB_invlist);
1202 PL_GCB_invlist = NULL;
1203 SvREFCNT_dec(PL_HasMultiCharFold);
1204 PL_HasMultiCharFold = NULL;
1205 SvREFCNT_dec(PL_InMultiCharFold);
1206 PL_InMultiCharFold = NULL;
1207 SvREFCNT_dec(PL_Latin1);
1209 SvREFCNT_dec(PL_LB_invlist);
1210 PL_LB_invlist = NULL;
1211 SvREFCNT_dec(PL_SB_invlist);
1212 PL_SB_invlist = NULL;
1213 SvREFCNT_dec(PL_SCX_invlist);
1214 PL_SCX_invlist = NULL;
1215 SvREFCNT_dec(PL_UpperLatin1);
1216 PL_UpperLatin1 = NULL;
1217 SvREFCNT_dec(PL_in_some_fold);
1218 PL_in_some_fold = NULL;
1219 SvREFCNT_dec(PL_utf8_foldclosures);
1220 PL_utf8_foldclosures = NULL;
1221 SvREFCNT_dec(PL_utf8_idcont);
1222 PL_utf8_idcont = NULL;
1223 SvREFCNT_dec(PL_utf8_idstart);
1224 PL_utf8_idstart = NULL;
1225 SvREFCNT_dec(PL_utf8_perl_idcont);
1226 PL_utf8_perl_idcont = NULL;
1227 SvREFCNT_dec(PL_utf8_perl_idstart);
1228 PL_utf8_perl_idstart = NULL;
1229 SvREFCNT_dec(PL_utf8_xidcont);
1230 PL_utf8_xidcont = NULL;
1231 SvREFCNT_dec(PL_utf8_xidstart);
1232 PL_utf8_xidstart = NULL;
1233 SvREFCNT_dec(PL_WB_invlist);
1234 PL_WB_invlist = NULL;
1235 SvREFCNT_dec(PL_utf8_toupper);
1236 PL_utf8_toupper = NULL;
1237 SvREFCNT_dec(PL_utf8_totitle);
1238 PL_utf8_totitle = NULL;
1239 SvREFCNT_dec(PL_utf8_tolower);
1240 PL_utf8_tolower = NULL;
1241 SvREFCNT_dec(PL_utf8_tofold);
1242 PL_utf8_tofold = NULL;
1243 SvREFCNT_dec(PL_utf8_tosimplefold);
1244 PL_utf8_tosimplefold = NULL;
1245 SvREFCNT_dec(PL_utf8_charname_begin);
1246 PL_utf8_charname_begin = NULL;
1247 SvREFCNT_dec(PL_utf8_charname_continue);
1248 PL_utf8_charname_continue = NULL;
1249 SvREFCNT_dec(PL_utf8_mark);
1250 PL_utf8_mark = NULL;
1251 SvREFCNT_dec(PL_InBitmap);
1253 SvREFCNT_dec(PL_CCC_non0_non230);
1254 PL_CCC_non0_non230 = NULL;
1255 SvREFCNT_dec(PL_Private_Use);
1256 PL_Private_Use = NULL;
1258 for (i = 0; i < POSIX_CC_COUNT; i++) {
1259 SvREFCNT_dec(PL_XPosix_ptrs[i]);
1260 PL_XPosix_ptrs[i] = NULL;
1262 if (i != CC_CASED_) { /* A copy of Alpha */
1263 SvREFCNT_dec(PL_Posix_ptrs[i]);
1264 PL_Posix_ptrs[i] = NULL;
1268 free_and_set_cop_warnings(&PL_compiling, NULL);
1269 cophh_free(CopHINTHASH_get(&PL_compiling));
1270 CopHINTHASH_set(&PL_compiling, cophh_new_empty());
1271 CopFILE_free(&PL_compiling);
1273 /* Prepare to destruct main symbol table. */
1276 /* break ref loop *:: <=> %:: */
1277 (void)hv_deletes(hv, "main::", G_DISCARD);
1280 SvREFCNT_dec(PL_curstname);
1281 PL_curstname = NULL;
1283 /* clear queued errors */
1284 SvREFCNT_dec(PL_errors);
1287 SvREFCNT_dec(PL_isarev);
1290 if (destruct_level >= 2) {
1291 if (PL_scopestack_ix != 0)
1292 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
1293 "Unbalanced scopes: %ld more ENTERs than LEAVEs\n",
1294 (long)PL_scopestack_ix);
1295 if (PL_savestack_ix != 0)
1296 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
1297 "Unbalanced saves: %ld more saves than restores\n",
1298 (long)PL_savestack_ix);
1299 if (PL_tmps_floor != -1)
1300 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced tmps: %ld more allocs than frees\n",
1301 (long)PL_tmps_floor + 1);
1302 if (cxstack_ix != -1)
1303 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced context: %ld more PUSHes than POPs\n",
1304 (long)cxstack_ix + 1);
1308 SvREFCNT_dec(PL_regex_padav);
1309 PL_regex_padav = NULL;
1310 PL_regex_pad = NULL;
1314 /* the entries in this list are allocated via SV PVX's, so get freed
1315 * in sv_clean_all */
1316 Safefree(PL_my_cxt_list);
1319 /* Now absolutely destruct everything, somehow or other, loops or no. */
1321 /* the 2 is for PL_fdpid and PL_strtab */
1322 while (sv_clean_all() > 2)
1326 Safefree(PL_stashpad); /* must come after sv_clean_all */
1329 AvREAL_off(PL_fdpid); /* no surviving entries */
1330 SvREFCNT_dec(PL_fdpid); /* needed in io_close() */
1333 #ifdef HAVE_INTERP_INTERN
1337 /* constant strings */
1338 for (i = 0; i < SV_CONSTS_COUNT; i++) {
1339 SvREFCNT_dec(PL_sv_consts[i]);
1340 PL_sv_consts[i] = NULL;
1343 /* Destruct the global string table. */
1345 /* Yell and reset the HeVAL() slots that are still holding refcounts,
1346 * so that sv_free() won't fail on them.
1347 * Now that the global string table is using a single hunk of memory
1348 * for both HE and HEK, we either need to explicitly unshare it the
1349 * correct way, or actually free things here.
1352 const I32 max = HvMAX(PL_strtab);
1353 HE * const * const array = HvARRAY(PL_strtab);
1354 HE *hent = array[0];
1357 if (hent && ckWARN_d(WARN_INTERNAL)) {
1358 HE * const next = HeNEXT(hent);
1359 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
1360 "Unbalanced string table refcount: (%ld) for \"%s\"",
1361 (long)hent->he_valu.hent_refcount, HeKEY(hent));
1368 hent = array[riter];
1373 HvARRAY(PL_strtab) = 0;
1374 HvTOTALKEYS(PL_strtab) = 0;
1376 SvREFCNT_dec(PL_strtab);
1379 /* free the pointer tables used for cloning */
1380 ptr_table_free(PL_ptr_table);
1381 PL_ptr_table = (PTR_TBL_t*)NULL;
1384 /* free special SVs */
1386 SvREFCNT(&PL_sv_yes) = 0;
1387 sv_clear(&PL_sv_yes);
1388 SvANY(&PL_sv_yes) = NULL;
1389 SvFLAGS(&PL_sv_yes) = 0;
1391 SvREFCNT(&PL_sv_no) = 0;
1392 sv_clear(&PL_sv_no);
1393 SvANY(&PL_sv_no) = NULL;
1394 SvFLAGS(&PL_sv_no) = 0;
1396 SvREFCNT(&PL_sv_zero) = 0;
1397 sv_clear(&PL_sv_zero);
1398 SvANY(&PL_sv_zero) = NULL;
1399 SvFLAGS(&PL_sv_zero) = 0;
1403 for (i=0; i<=2; i++) {
1404 SvREFCNT(PERL_DEBUG_PAD(i)) = 0;
1405 sv_clear(PERL_DEBUG_PAD(i));
1406 SvANY(PERL_DEBUG_PAD(i)) = NULL;
1407 SvFLAGS(PERL_DEBUG_PAD(i)) = 0;
1411 if (PL_sv_count != 0 && ckWARN_d(WARN_INTERNAL))
1412 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Scalars leaked: %ld\n", (long)PL_sv_count);
1414 #ifdef DEBUG_LEAKING_SCALARS
1415 if (PL_sv_count != 0) {
1420 for (sva = PL_sv_arenaroot; sva; sva = MUTABLE_SV(SvANY(sva))) {
1421 svend = &sva[SvREFCNT(sva)];
1422 for (sv = sva + 1; sv < svend; ++sv) {
1423 if (!SvIS_FREED(sv)) {
1424 PerlIO_printf(Perl_debug_log, "leaked: sv=0x%p"
1426 " refcnt=%" UVuf pTHX__FORMAT "\n"
1427 "\tallocated at %s:%d %s %s (parent 0x%" UVxf ");"
1428 "serial %" UVuf "\n",
1429 (void*)sv, (UV)sv->sv_flags, (UV)sv->sv_refcnt
1431 sv->sv_debug_file ? sv->sv_debug_file : "(unknown)",
1433 sv->sv_debug_inpad ? "for" : "by",
1434 sv->sv_debug_optype ?
1435 PL_op_name[sv->sv_debug_optype]: "(none)",
1436 PTR2UV(sv->sv_debug_parent),
1439 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1440 Perl_dump_sv_child(aTHX_ sv);
1446 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1450 /* Wait for up to 4 seconds for child to terminate.
1451 This seems to be the least effort way of timing out on reaping
1453 struct timeval waitfor = {4, 0};
1454 int sock = PL_dumper_fd;
1458 FD_SET(sock, &rset);
1459 select(sock + 1, &rset, NULL, NULL, &waitfor);
1460 waitpid(child, &status, WNOHANG);
1465 #ifdef DEBUG_LEAKING_SCALARS_ABORT
1471 #if defined(PERLIO_LAYERS)
1472 /* No more IO - including error messages ! */
1473 PerlIO_cleanup(aTHX);
1476 /* sv_undef needs to stay immortal until after PerlIO_cleanup
1477 as currently layers use it rather than NULL as a marker
1478 for no arg - and will try and SvREFCNT_dec it.
1480 SvREFCNT(&PL_sv_undef) = 0;
1481 SvREADONLY_off(&PL_sv_undef);
1483 Safefree(PL_origfilename);
1484 PL_origfilename = NULL;
1485 Safefree(PL_reg_curpm);
1486 free_tied_hv_pool();
1487 Safefree(PL_op_mask);
1488 Safefree(PL_psig_name);
1489 PL_psig_name = (SV**)NULL;
1490 PL_psig_ptr = (SV**)NULL;
1492 /* We need to NULL PL_psig_pend first, so that
1493 signal handlers know not to use it */
1494 int *psig_save = PL_psig_pend;
1495 PL_psig_pend = (int*)NULL;
1496 Safefree(psig_save);
1499 TAINTING_set(FALSE);
1500 TAINT_WARN_set(FALSE);
1501 PL_hints = 0; /* Reset hints. Should hints be per-interpreter ? */
1503 DEBUG_P(debprofdump());
1507 #ifdef USE_REENTRANT_API
1508 Perl_reentrant_free(aTHX);
1511 /* These all point to HVs that are about to be blown away.
1512 Code in core and on CPAN assumes that if the interpreter is re-started
1513 that they will be cleanly NULL or pointing to a valid HV. */
1514 PL_custom_op_names = NULL;
1515 PL_custom_op_descs = NULL;
1516 PL_custom_ops = NULL;
1520 while (PL_regmatch_slab) {
1521 regmatch_slab *s = PL_regmatch_slab;
1522 PL_regmatch_slab = PL_regmatch_slab->next;
1526 /* As the absolutely last thing, free the non-arena SV for mess() */
1529 /* we know that type == SVt_PVMG */
1531 /* it could have accumulated taint magic */
1534 for (mg = SvMAGIC(PL_mess_sv); mg; mg = moremagic) {
1535 moremagic = mg->mg_moremagic;
1536 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global
1538 Safefree(mg->mg_ptr);
1542 /* we know that type >= SVt_PV */
1543 SvPV_free(PL_mess_sv);
1544 Safefree(SvANY(PL_mess_sv));
1545 Safefree(PL_mess_sv);
1552 =for apidoc perl_free
1554 Releases a Perl interpreter. See L<perlembed>.
1563 PERL_ARGS_ASSERT_PERL_FREE;
1565 if (PL_veto_cleanup)
1568 #ifdef PERL_TRACK_MEMPOOL
1571 * Don't free thread memory if PERL_DESTRUCT_LEVEL is set to a non-zero
1572 * value as we're probably hunting memory leaks then
1574 if (PL_perl_destruct_level == 0) {
1575 const U32 old_debug = PL_debug;
1576 /* Emulate the PerlHost behaviour of free()ing all memory allocated in this
1577 thread at thread exit. */
1579 PerlIO_puts(Perl_debug_log, "Disabling memory debugging as we "
1580 "free this thread's memory\n");
1581 PL_debug &= ~ DEBUG_m_FLAG;
1583 while(aTHXx->Imemory_debug_header.next != &(aTHXx->Imemory_debug_header)){
1584 char * next = (char *)(aTHXx->Imemory_debug_header.next);
1585 Malloc_t ptr = PERL_MEMORY_DEBUG_HEADER_SIZE + next;
1588 PL_debug = old_debug;
1594 # if defined(PERL_IMPLICIT_SYS)
1596 void *host = w32_internal_host;
1597 PerlMem_free(aTHXx);
1598 win32_delete_internal_host(host);
1601 PerlMem_free(aTHXx);
1604 PerlMem_free(aTHXx);
1608 #if defined(USE_ITHREADS)
1609 /* provide destructors to clean up the thread key when libperl is unloaded */
1610 #ifndef WIN32 /* handled during DLL_PROCESS_DETACH in win32/perllib.c */
1612 #if defined(__hpux) && !(defined(__ux_version) && __ux_version <= 1020) && !defined(__GNUC__)
1613 #pragma fini "perl_fini"
1614 #elif defined(__sun) && !defined(__GNUC__)
1615 #pragma fini (perl_fini)
1619 #if defined(__GNUC__)
1620 __attribute__((destructor))
1625 PL_curinterp && !PL_veto_cleanup)
1630 #endif /* THREADS */
1633 =for apidoc call_atexit
1635 Add a function C<fn> to the list of functions to be called at global
1636 destruction. C<ptr> will be passed as an argument to C<fn>; it can point to a
1637 C<struct> so that you can pass anything you want.
1639 Note that under threads, C<fn> may run multiple times. This is because the
1640 list is executed each time the current or any descendent thread terminates.
1646 Perl_call_atexit(pTHX_ ATEXIT_t fn, void *ptr)
1648 Renew(PL_exitlist, PL_exitlistlen+1, PerlExitListEntry);
1649 PL_exitlist[PL_exitlistlen].fn = fn;
1650 PL_exitlist[PL_exitlistlen].ptr = ptr;
1654 #ifdef USE_ENVIRON_ARRAY
1658 # ifdef USE_ITHREADS
1659 if (aTHX != PL_curinterp)
1665 size_t n_entries = 0, vars_size = 0;
1667 for (char **ep = environ; *ep; ++ep) {
1669 vars_size += strlen(*ep) + 1;
1672 /* To save memory, we store both the environ array and its values in a
1673 * single memory block. */
1674 char **new_environ = (char**)PerlMemShared_malloc(
1675 (sizeof(char*) * (n_entries + 1)) + vars_size
1677 char *vars = (char*)(new_environ + n_entries + 1);
1679 for (size_t i = 0, copied = 0; n_entries > i; ++i) {
1680 size_t len = strlen(environ[i]) + 1;
1681 new_environ[i] = (char *) CopyD(environ[i], vars + copied, len, char);
1684 new_environ[n_entries] = NULL;
1686 environ = new_environ;
1687 /* Store a pointer in a global variable to ensure it's always reachable so
1688 * LeakSanitizer/Valgrind won't complain about it. We can't ever free it.
1689 * Even if libc allocates a new environ, it's possible that some of its
1690 * values will still be pointing to the old environ.
1692 PL_my_environ = new_environ;
1697 =for apidoc perl_parse
1699 Tells a Perl interpreter to parse a Perl script. This performs most
1700 of the initialisation of a Perl interpreter. See L<perlembed> for
1703 C<my_perl> points to the Perl interpreter that is to parse the script.
1704 It must have been previously created through the use of L</perl_alloc>
1705 and L</perl_construct>. C<xsinit> points to a callback function that
1706 will be called to set up the ability for this Perl interpreter to load
1707 XS extensions, or may be null to perform no such setup.
1709 C<argc> and C<argv> supply a set of command-line arguments to the Perl
1710 interpreter, as would normally be passed to the C<main> function of
1711 a C program. C<argv[argc]> must be null. These arguments are where
1712 the script to parse is specified, either by naming a script file or by
1713 providing a script in a C<-e> option.
1714 If L<C<$0>|perlvar/$0> will be written to in the Perl interpreter, then
1715 the argument strings must be in writable memory, and so mustn't just be
1718 C<env> specifies a set of environment variables that will be used by
1719 this Perl interpreter. If non-null, it must point to a null-terminated
1720 array of environment strings. If null, the Perl interpreter will use
1721 the environment supplied by the C<environ> global variable.
1723 This function initialises the interpreter, and parses and compiles the
1724 script specified by the command-line arguments. This includes executing
1725 code in C<BEGIN>, C<UNITCHECK>, and C<CHECK> blocks. It does not execute
1726 C<INIT> blocks or the main program.
1728 Returns an integer of slightly tricky interpretation. The correct
1729 use of the return value is as a truth value indicating whether there
1730 was a failure in initialisation. If zero is returned, this indicates
1731 that initialisation was successful, and it is safe to proceed to call
1732 L</perl_run> and make other use of it. If a non-zero value is returned,
1733 this indicates some problem that means the interpreter wants to terminate.
1734 The interpreter should not be just abandoned upon such failure; the caller
1735 should proceed to shut the interpreter down cleanly with L</perl_destruct>
1736 and free it with L</perl_free>.
1738 For historical reasons, the non-zero return value also attempts to
1739 be a suitable value to pass to the C library function C<exit> (or to
1740 return from C<main>), to serve as an exit code indicating the nature
1741 of the way initialisation terminated. However, this isn't portable,
1742 due to differing exit code conventions. An attempt is made to return
1743 an exit code of the type required by the host operating system, but
1744 because it is constrained to be non-zero, it is not necessarily possible
1745 to indicate every type of exit. It is only reliable on Unix, where a
1746 zero exit code can be augmented with a set bit that will be ignored.
1747 In any case, this function is not the correct place to acquire an exit
1748 code: one should get that from L</perl_destruct>.
1753 #define SET_CURSTASH(newstash) \
1754 if (PL_curstash != newstash) { \
1755 SvREFCNT_dec(PL_curstash); \
1756 PL_curstash = (HV *)SvREFCNT_inc(newstash); \
1760 perl_parse(pTHXx_ XSINIT_t xsinit, int argc, char **argv, char **env)
1766 PERL_ARGS_ASSERT_PERL_PARSE;
1767 #ifndef MULTIPLICITY
1768 PERL_UNUSED_ARG(my_perl);
1770 debug_hash_seed(false);
1773 struct NameTranslationInfo nti;
1774 __translate_amiga_to_unix_path_name(&argv[0],&nti);
1781 for(i = 0; i != argc; i++)
1783 assert(!argv[argc]);
1788 if (PL_origalen != 0) {
1789 PL_origalen = 1; /* don't use old PL_origalen if perl_parse() is called again */
1792 /* Set PL_origalen be the sum of the contiguous argv[]
1793 * elements plus the size of the env in case that it is
1794 * contiguous with the argv[]. This is used in mg.c:Perl_magic_set()
1795 * as the maximum modifiable length of $0. In the worst case
1796 * the area we are able to modify is limited to the size of
1797 * the original argv[0]. (See below for 'contiguous', though.)
1799 const char *s = NULL;
1800 const UV mask = ~(UV)(PTRSIZE-1);
1801 /* Do the mask check only if the args seem like aligned. */
1803 (mask < ~(UV)0) && ((PTR2UV(argv[0]) & mask) == PTR2UV(argv[0]));
1805 /* See if all the arguments are contiguous in memory. Note
1806 * that 'contiguous' is a loose term because some platforms
1807 * align the argv[] and the envp[]. If the arguments look
1808 * like non-aligned, assume that they are 'strictly' or
1809 * 'traditionally' contiguous. If the arguments look like
1810 * aligned, we just check that they are within aligned
1811 * PTRSIZE bytes. As long as no system has something bizarre
1812 * like the argv[] interleaved with some other data, we are
1813 * fine. (Did I just evoke Murphy's Law?) --jhi */
1814 if (PL_origargv && PL_origargc >= 1 && (s = PL_origargv[0])) {
1817 for (i = 1; i < PL_origargc; i++) {
1818 if ((PL_origargv[i] == s + 1
1820 || PL_origargv[i] == s + 2
1825 (PL_origargv[i] > s &&
1827 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1838 #ifdef USE_ENVIRON_ARRAY
1839 /* Can we grab env area too to be used as the area for $0? */
1840 if (s && PL_origenviron) {
1841 if ((PL_origenviron[0] == s + 1)
1844 (PL_origenviron[0] > s &&
1845 PL_origenviron[0] <=
1846 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1850 #ifndef OS2 /* ENVIRON is read by the kernel too. */
1851 s = PL_origenviron[0];
1855 /* Force copy of environment. */
1856 if (PL_origenviron == environ)
1859 for (i = 1; PL_origenviron[i]; i++) {
1860 if (PL_origenviron[i] == s + 1
1863 (PL_origenviron[i] > s &&
1864 PL_origenviron[i] <=
1865 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1868 s = PL_origenviron[i];
1876 #endif /* USE_ENVIRON_ARRAY */
1878 PL_origalen = s ? s - PL_origargv[0] + 1 : 0;
1883 /* Come here if running an undumped a.out. */
1885 PL_origfilename = savepv(argv[0]);
1886 PL_do_undump = FALSE;
1887 cxstack_ix = -1; /* start label stack again */
1889 assert (!TAINT_get);
1893 init_postdump_symbols(argc,argv,env);
1897 op_free(PL_main_root);
1898 PL_main_root = NULL;
1900 PL_main_start = NULL;
1901 SvREFCNT_dec(PL_main_cv);
1905 oldscope = PL_scopestack_ix;
1906 PL_dowarn = G_WARN_OFF;
1911 parse_body(env,xsinit);
1912 if (PL_unitcheckav) {
1913 call_list(oldscope, PL_unitcheckav);
1916 PERL_SET_PHASE(PERL_PHASE_CHECK);
1917 call_list(oldscope, PL_checkav);
1925 /* my_exit() was called */
1926 while (PL_scopestack_ix > oldscope)
1929 SET_CURSTASH(PL_defstash);
1930 if (PL_unitcheckav) {
1931 call_list(oldscope, PL_unitcheckav);
1934 PERL_SET_PHASE(PERL_PHASE_CHECK);
1935 call_list(oldscope, PL_checkav);
1940 * We do this here to avoid [perl #2754].
1941 * Note this may cause trouble with Module::Install.
1942 * See: [perl #132577].
1948 PerlIO_printf(Perl_error_log, "panic: top_env\n");
1956 /* This needs to stay in perl.c, as perl.c is compiled with different flags for
1957 miniperl, and we need to see those flags reflected in the values here. */
1959 /* What this returns is subject to change. Use the public interface in Config.
1963 S_Internals_V(pTHX_ CV *cv)
1966 #ifdef LOCAL_PATCH_COUNT
1967 const int local_patch_count = LOCAL_PATCH_COUNT;
1969 const int local_patch_count = 0;
1971 const int entries = 3 + local_patch_count;
1973 /* NOTE - This list must remain sorted. Do not put any settings here
1974 * which affect binary compatibility */
1975 static const char non_bincompat_options[] =
1979 # ifdef HAS_LONG_DOUBLE
1988 # ifdef NO_PERL_INTERNAL_RAND_SEED
1989 " NO_PERL_INTERNAL_RAND_SEED"
1991 # ifdef NO_PERL_RAND_SEED
1992 " NO_PERL_RAND_SEED"
1994 # ifdef NO_TAINT_SUPPORT
1997 # ifdef PERL_COPY_ON_WRITE
1998 " PERL_COPY_ON_WRITE"
2000 # ifdef PERL_DISABLE_PMC
2003 # ifdef PERL_DONT_CREATE_GVSV
2004 " PERL_DONT_CREATE_GVSV"
2006 # ifdef PERL_EXTERNAL_GLOB
2007 " PERL_EXTERNAL_GLOB"
2009 # ifdef PERL_IS_MINIPERL
2012 # ifdef PERL_MALLOC_WRAP
2015 # ifdef PERL_MEM_LOG
2018 # ifdef PERL_MEM_LOG_NOIMPL
2019 " PERL_MEM_LOG_NOIMPL"
2021 # ifdef PERL_OP_PARENT
2024 # ifdef PERL_PERTURB_KEYS_DETERMINISTIC
2025 " PERL_PERTURB_KEYS_DETERMINISTIC"
2027 # ifdef PERL_PERTURB_KEYS_DISABLED
2028 " PERL_PERTURB_KEYS_DISABLED"
2030 # ifdef PERL_PERTURB_KEYS_RANDOM
2031 " PERL_PERTURB_KEYS_RANDOM"
2033 # ifdef PERL_PRESERVE_IVUV
2034 " PERL_PRESERVE_IVUV"
2036 # ifdef PERL_RC_STACK
2039 # ifdef PERL_RELOCATABLE_INCPUSH
2040 " PERL_RELOCATABLE_INCPUSH"
2042 # ifdef PERL_USE_DEVEL
2045 # ifdef PERL_USE_SAFE_PUTENV
2046 " PERL_USE_SAFE_PUTENV"
2049 # ifdef PERL_USE_UNSHARED_KEYS_IN_LARGE_HASHES
2050 " PERL_USE_UNSHARED_KEYS_IN_LARGE_HASHES"
2052 # ifdef SILENT_NO_TAINT_SUPPORT
2053 " SILENT_NO_TAINT_SUPPORT"
2055 # ifdef UNLINK_ALL_VERSIONS
2056 " UNLINK_ALL_VERSIONS"
2058 # ifdef USE_ATTRIBUTES_FOR_PERLIO
2059 " USE_ATTRIBUTES_FOR_PERLIO"
2061 # ifdef USE_FAST_STDIO
2067 # ifdef USE_LOCALE_CTYPE
2070 # ifdef WIN32_NO_REGISTRY
2073 # ifdef USE_PERL_ATOF
2076 # ifdef USE_SITECUSTOMIZE
2077 " USE_SITECUSTOMIZE"
2079 # ifdef USE_THREAD_SAFE_LOCALE
2080 " USE_THREAD_SAFE_LOCALE"
2082 ""; /* keep this on a line by itself, WITH the empty string */
2084 PERL_UNUSED_ARG(cv);
2085 PERL_UNUSED_VAR(items);
2087 EXTEND(SP, entries);
2089 PUSHs(newSVpvn_flags(PL_bincompat_options, strlen(PL_bincompat_options),
2091 PUSHs(Perl_newSVpvn_flags(aTHX_ non_bincompat_options,
2092 sizeof(non_bincompat_options) - 1, SVs_TEMP));
2094 #ifndef PERL_BUILD_DATE
2097 # define PERL_BUILD_DATE __DATE__ " " __TIME__
2099 # define PERL_BUILD_DATE __DATE__
2104 #ifdef PERL_BUILD_DATE
2105 PUSHs(Perl_newSVpvn_flags(aTHX_
2106 STR_WITH_LEN("Compiled at " PERL_BUILD_DATE),
2109 PUSHs(&PL_sv_undef);
2112 for (i = 1; i <= local_patch_count; i++) {
2113 /* This will be an undef, if PL_localpatches[i] is NULL. */
2114 PUSHs(newSVpvn_flags(PL_localpatches[i],
2115 PL_localpatches[i] == NULL ? 0 : strlen(PL_localpatches[i]),
2122 #define INCPUSH_UNSHIFT 0x01
2123 #define INCPUSH_ADD_OLD_VERS 0x02
2124 #define INCPUSH_ADD_VERSIONED_SUB_DIRS 0x04
2125 #define INCPUSH_ADD_ARCHONLY_SUB_DIRS 0x08
2126 #define INCPUSH_NOT_BASEDIR 0x10
2127 #define INCPUSH_CAN_RELOCATE 0x20
2128 #define INCPUSH_ADD_SUB_DIRS \
2129 (INCPUSH_ADD_VERSIONED_SUB_DIRS|INCPUSH_ADD_ARCHONLY_SUB_DIRS)
2132 S_parse_body(pTHX_ char **env, XSINIT_t xsinit)
2135 int argc = PL_origargc;
2136 char **argv = PL_origargv;
2137 const char *scriptname = NULL;
2138 bool dosearch = FALSE;
2140 bool doextract = FALSE;
2141 const char *cddir = NULL;
2142 bool minus_e = FALSE; /* both -e and -E */
2143 #ifdef USE_SITECUSTOMIZE
2144 bool minus_f = FALSE;
2146 SV *linestr_sv = NULL;
2147 bool add_read_e_script = FALSE;
2148 U32 lex_start_flags = 0;
2150 PERL_SET_PHASE(PERL_PHASE_START);
2156 for (argc--,argv++; argc > 0; argc--,argv++) {
2157 if (argv[0][0] != '-' || !argv[0][1])
2163 #ifndef PERL_STRICT_CR
2189 if ((s = moreswitches(s)))
2194 #if defined(SILENT_NO_TAINT_SUPPORT)
2195 /* silently ignore */
2196 #elif defined(NO_TAINT_SUPPORT)
2197 Perl_croak_nocontext("This perl was compiled without taint support. "
2198 "Cowardly refusing to run with -t or -T flags");
2200 CHECK_MALLOC_TOO_LATE_FOR('t');
2201 if( !TAINTING_get ) {
2202 TAINT_WARN_set(TRUE);
2209 #if defined(SILENT_NO_TAINT_SUPPORT)
2210 /* silently ignore */
2211 #elif defined(NO_TAINT_SUPPORT)
2212 Perl_croak_nocontext("This perl was compiled without taint support. "
2213 "Cowardly refusing to run with -t or -T flags");
2215 CHECK_MALLOC_TOO_LATE_FOR('T');
2217 TAINT_WARN_set(FALSE);
2226 forbid_setid('e', FALSE);
2229 PL_e_script = newSVpvs("");
2230 add_read_e_script = TRUE;
2233 sv_catpv(PL_e_script, s);
2235 sv_catpv(PL_e_script, argv[1]);
2239 Perl_croak(aTHX_ "No code specified for -%c", c);
2240 sv_catpvs(PL_e_script, "\n");
2244 #ifdef USE_SITECUSTOMIZE
2250 case 'I': /* -I handled both here and in moreswitches() */
2251 forbid_setid('I', FALSE);
2252 if (!*++s && (s=argv[1]) != NULL) {
2256 STRLEN len = strlen(s);
2257 incpush(s, len, INCPUSH_ADD_SUB_DIRS|INCPUSH_ADD_OLD_VERS);
2260 Perl_croak(aTHX_ "No directory specified for -I");
2263 forbid_setid('S', FALSE);
2272 opts_prog = newSVpvs("use Config; Config::_V()");
2276 opts_prog = Perl_newSVpvf(aTHX_
2277 "use Config; Config::config_vars(qw%c%s%c)",
2281 Perl_av_create_and_push(aTHX_ &PL_preambleav, opts_prog);
2282 /* don't look for script or read stdin */
2283 scriptname = BIT_BUCKET;
2295 if (!*++s || isSPACE(*s)) {
2299 /* catch use of gnu style long options.
2300 Both of these exit immediately. */
2301 if (strEQ(s, "version"))
2303 if (strEQ(s, "help"))
2308 Perl_croak(aTHX_ "Unrecognized switch: -%s (-h will show valid options)",s);
2319 #ifndef SECURE_INTERNAL_GETENV
2322 (s = PerlEnv_getenv("PERL5OPT")))
2326 if (*s == '-' && *(s+1) == 'T') {
2327 #if defined(SILENT_NO_TAINT_SUPPORT)
2328 /* silently ignore */
2329 #elif defined(NO_TAINT_SUPPORT)
2330 Perl_croak_nocontext("This perl was compiled without taint support. "
2331 "Cowardly refusing to run with -t or -T flags");
2333 CHECK_MALLOC_TOO_LATE_FOR('T');
2335 TAINT_WARN_set(FALSE);
2339 char *popt_copy = NULL;
2352 if (!memCHRs("CDIMUdmtwW", *s))
2353 Perl_croak(aTHX_ "Illegal switch in PERL5OPT: -%c", *s);
2357 popt_copy = SvPVX(newSVpvn_flags(d, strlen(d), SVs_TEMP));
2358 s = popt_copy + (s - d);
2366 #if defined(SILENT_NO_TAINT_SUPPORT)
2367 /* silently ignore */
2368 #elif defined(NO_TAINT_SUPPORT)
2369 Perl_croak_nocontext("This perl was compiled without taint support. "
2370 "Cowardly refusing to run with -t or -T flags");
2372 if( !TAINTING_get) {
2373 TAINT_WARN_set(TRUE);
2385 #ifndef NO_PERL_INTERNAL_RAND_SEED
2386 /* If we're not set[ug]id, we might have honored
2387 PERL_INTERNAL_RAND_SEED in perl_construct().
2388 At this point command-line options have been parsed, so if
2389 we're now tainting and not set[ug]id re-seed.
2390 This could possibly be wasteful if PERL_INTERNAL_RAND_SEED is invalid,
2391 but avoids duplicating the logic from perl_construct().
2394 PerlProc_getuid() == PerlProc_geteuid() &&
2395 PerlProc_getgid() == PerlProc_getegid()) {
2396 Perl_drand48_init_r(&PL_internal_random_state, seed());
2400 debug_hash_seed(true);
2402 /* Set $^X early so that it can be used for relocatable paths in @INC */
2403 /* and for SITELIB_EXP in USE_SITECUSTOMIZE */
2404 assert (!TAINT_get);
2409 #if defined(USE_SITECUSTOMIZE)
2411 /* The games with local $! are to avoid setting errno if there is no
2412 sitecustomize script. "q%c...%c", 0, ..., 0 becomes "q\0...\0",
2413 ie a q() operator with a NUL byte as a the delimiter. This avoids
2414 problems with pathnames containing (say) ' */
2415 # ifdef PERL_IS_MINIPERL
2416 AV *const inc = GvAV(PL_incgv);
2417 SV **const inc0 = inc ? av_fetch(inc, 0, FALSE) : NULL;
2420 /* if lib/buildcustomize.pl exists, it should not fail. If it does,
2421 it should be reported immediately as a build failure. */
2422 (void)Perl_av_create_and_unshift_one(aTHX_ &PL_preambleav,
2424 "BEGIN { my $f = q%c%s%" SVf "/buildcustomize.pl%c; "
2425 "do {local $!; -f $f }"
2426 " and do $f || die $@ || qq '$f: $!' }",
2427 0, (TAINTING_get ? "./" : ""), SVfARG(*inc0), 0));
2430 /* SITELIB_EXP is a function call on Win32. */
2431 const char *const raw_sitelib = SITELIB_EXP;
2433 /* process .../.. if PERL_RELOCATABLE_INC is defined */
2434 SV *sitelib_sv = mayberelocate(raw_sitelib, strlen(raw_sitelib),
2435 INCPUSH_CAN_RELOCATE);
2436 const char *const sitelib = SvPVX(sitelib_sv);
2437 (void)Perl_av_create_and_unshift_one(aTHX_ &PL_preambleav,
2439 "BEGIN { do {local $!; -f q%c%s/sitecustomize.pl%c} && do q%c%s/sitecustomize.pl%c }",
2442 assert (SvREFCNT(sitelib_sv) == 1);
2443 SvREFCNT_dec(sitelib_sv);
2450 scriptname = argv[0];
2453 scriptname = BIT_BUCKET; /* don't look for script or read stdin */
2455 else if (scriptname == NULL) {
2459 assert (!TAINT_get);
2463 bool suidscript = FALSE;
2465 rsfp = open_script(scriptname, dosearch, &suidscript);
2467 rsfp = PerlIO_stdin();
2468 lex_start_flags = LEX_DONT_CLOSE_RSFP;
2471 validate_suid(rsfp);
2473 #if defined(SIGCHLD) || defined(SIGCLD)
2476 # define SIGCHLD SIGCLD
2478 Sighandler_t sigstate = rsignal_state(SIGCHLD);
2479 if (sigstate == (Sighandler_t) SIG_IGN) {
2480 Perl_ck_warner(aTHX_ packWARN(WARN_SIGNAL),
2481 "Can't ignore signal CHLD, forcing to default");
2482 (void)rsignal(SIGCHLD, (Sighandler_t)SIG_DFL);
2489 /* This will croak if suidscript is true, as -x cannot be used with
2491 forbid_setid('x', suidscript);
2492 /* Hence you can't get here if suidscript is true */
2494 linestr_sv = newSV_type(SVt_PV);
2495 lex_start_flags |= LEX_START_COPIED;
2496 find_beginning(linestr_sv, rsfp);
2497 if (cddir && PerlDir_chdir( (char *)cddir ) < 0)
2498 Perl_croak(aTHX_ "Can't chdir to %s",cddir);
2502 PL_main_cv = PL_compcv = MUTABLE_CV(newSV_type(SVt_PVCV));
2503 CvUNIQUE_on(PL_compcv);
2505 CvPADLIST_set(PL_compcv, pad_new(0));
2507 PL_isarev = newHV();
2510 boot_core_UNIVERSAL();
2511 boot_core_builtin();
2513 newXS("Internals::V", S_Internals_V, __FILE__);
2516 (*xsinit)(aTHX); /* in case linked C routines want magical variables */
2517 #if defined(VMS) || defined(WIN32) || defined(__CYGWIN__)
2522 # ifdef HAS_SOCKS5_INIT
2523 socks5_init(argv[0]);
2529 init_predump_symbols();
2530 /* init_postdump_symbols not currently designed to be called */
2531 /* more than once (ENV isn't cleared first, for example) */
2532 /* But running with -u leaves %ENV & @ARGV undefined! XXX */
2534 init_postdump_symbols(argc,argv,env);
2536 /* PL_unicode is turned on by -C, or by $ENV{PERL_UNICODE},
2537 * or explicitly in some platforms.
2538 * PL_utf8locale is conditionally turned on by
2539 * locale.c:Perl_init_i18nl10n() if the environment
2540 * look like the user wants to use UTF-8. */
2541 # ifndef PERL_IS_MINIPERL
2543 /* Requires init_predump_symbols(). */
2544 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
2549 /* Turn on UTF-8-ness on STDIN, STDOUT, STDERR
2550 * and the default open disciplines. */
2551 if ((PL_unicode & PERL_UNICODE_STDIN_FLAG) &&
2552 PL_stdingv && (io = GvIO(PL_stdingv)) &&
2554 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2555 if ((PL_unicode & PERL_UNICODE_STDOUT_FLAG) &&
2556 PL_defoutgv && (io = GvIO(PL_defoutgv)) &&
2558 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2559 if ((PL_unicode & PERL_UNICODE_STDERR_FLAG) &&
2560 PL_stderrgv && (io = GvIO(PL_stderrgv)) &&
2562 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2563 if ((PL_unicode & PERL_UNICODE_INOUT_FLAG) &&
2564 (sv = GvSV(gv_fetchpvs("\017PEN", GV_ADD|GV_NOTQUAL,
2566 U32 in = PL_unicode & PERL_UNICODE_IN_FLAG;
2567 U32 out = PL_unicode & PERL_UNICODE_OUT_FLAG;
2570 sv_setpvs(sv, ":utf8\0:utf8");
2572 sv_setpvs(sv, ":utf8\0");
2575 sv_setpvs(sv, "\0:utf8");
2584 if ((s = PerlEnv_getenv("PERL_SIGNALS"))) {
2585 if (strEQ(s, "unsafe"))
2586 PL_signals |= PERL_SIGNALS_UNSAFE_FLAG;
2587 else if (strEQ(s, "safe"))
2588 PL_signals &= ~PERL_SIGNALS_UNSAFE_FLAG;
2590 Perl_croak(aTHX_ "PERL_SIGNALS illegal: \"%s\"", s);
2595 lex_start(linestr_sv, rsfp, lex_start_flags);
2596 SvREFCNT_dec(linestr_sv);
2598 PL_subname = newSVpvs("main");
2600 if (add_read_e_script)
2601 filter_add(read_e_script, NULL);
2603 /* now parse the script */
2604 if (minus_e == FALSE)
2605 PL_hints |= HINTS_DEFAULT; /* after init_main_stash ; need to be after init_predump_symbols */
2607 SETERRNO(0,SS_NORMAL);
2608 if (yyparse(GRAMPROG) || PL_parser->error_count) {
2609 abort_execution(NULL, PL_origfilename);
2611 CopLINE_set(PL_curcop, 0);
2612 SET_CURSTASH(PL_defstash);
2614 SvREFCNT_dec(PL_e_script);
2622 SAVECOPFILE(PL_curcop);
2623 SAVECOPLINE(PL_curcop);
2624 gv_check(PL_defstash);
2634 s = PerlEnv_getenv("PERL_DEBUG_MSTATS");
2635 if (s && grok_atoUV(s, &uv, NULL) && uv >= 2)
2636 dump_mstats("after compilation:");
2641 PL_restartjmpenv = NULL;
2647 =for apidoc perl_run
2649 Tells a Perl interpreter to run its main program. See L<perlembed>
2652 C<my_perl> points to the Perl interpreter. It must have been previously
2653 created through the use of L</perl_alloc> and L</perl_construct>, and
2654 initialised through L</perl_parse>. This function should not be called
2655 if L</perl_parse> returned a non-zero value, indicating a failure in
2656 initialisation or compilation.
2658 This function executes code in C<INIT> blocks, and then executes the
2659 main program. The code to be executed is that established by the prior
2660 call to L</perl_parse>. If the interpreter's C<PL_exit_flags> word
2661 does not have the C<PERL_EXIT_DESTRUCT_END> flag set, then this function
2662 will also execute code in C<END> blocks. If it is desired to make any
2663 further use of the interpreter after calling this function, then C<END>
2664 blocks should be postponed to L</perl_destruct> time by setting that flag.
2666 Returns an integer of slightly tricky interpretation. The correct use
2667 of the return value is as a truth value indicating whether the program
2668 terminated non-locally. If zero is returned, this indicates that
2669 the program ran to completion, and it is safe to make other use of the
2670 interpreter (provided that the C<PERL_EXIT_DESTRUCT_END> flag was set as
2671 described above). If a non-zero value is returned, this indicates that
2672 the interpreter wants to terminate early. The interpreter should not be
2673 just abandoned because of this desire to terminate; the caller should
2674 proceed to shut the interpreter down cleanly with L</perl_destruct>
2675 and free it with L</perl_free>.
2677 For historical reasons, the non-zero return value also attempts to
2678 be a suitable value to pass to the C library function C<exit> (or to
2679 return from C<main>), to serve as an exit code indicating the nature of
2680 the way the program terminated. However, this isn't portable, due to
2681 differing exit code conventions. An attempt is made to return an exit
2682 code of the type required by the host operating system, but because
2683 it is constrained to be non-zero, it is not necessarily possible to
2684 indicate every type of exit. It is only reliable on Unix, where a zero
2685 exit code can be augmented with a set bit that will be ignored. In any
2686 case, this function is not the correct place to acquire an exit code:
2687 one should get that from L</perl_destruct>.
2699 PERL_ARGS_ASSERT_PERL_RUN;
2700 #ifndef MULTIPLICITY
2701 PERL_UNUSED_ARG(my_perl);
2704 oldscope = PL_scopestack_ix;
2712 cxstack_ix = -1; /* start context stack again */
2714 case 0: /* normal completion */
2718 case 2: /* my_exit() */
2719 while (PL_scopestack_ix > oldscope)
2722 SET_CURSTASH(PL_defstash);
2723 if (!(PL_exit_flags & PERL_EXIT_DESTRUCT_END) &&
2724 PL_endav && !PL_minus_c) {
2725 PERL_SET_PHASE(PERL_PHASE_END);
2726 call_list(oldscope, PL_endav);
2729 if (PerlEnv_getenv("PERL_DEBUG_MSTATS"))
2730 dump_mstats("after execution: ");
2736 POPSTACK_TO(PL_mainstack);
2739 PerlIO_printf(Perl_error_log, "panic: restartop in perl_run\n");
2750 S_run_body(pTHX_ I32 oldscope)
2752 DEBUG_r(PerlIO_printf(Perl_debug_log, "%s $` $& $' support (0x%x).\n",
2753 PL_sawampersand ? "Enabling" : "Omitting",
2754 (unsigned int)(PL_sawampersand)));
2756 if (!PL_restartop) {
2758 if (DEBUG_x_TEST || DEBUG_B_TEST)
2759 dump_all_perl(!DEBUG_B_TEST);
2761 PERL_DEBUG(PerlIO_printf(Perl_debug_log, "\nEXECUTING...\n\n"));
2765 PerlIO_printf(Perl_error_log, "%s syntax OK\n", PL_origfilename);
2768 if (PERLDB_SINGLE && PL_DBsingle)
2771 PERL_SET_PHASE(PERL_PHASE_INIT);
2772 call_list(oldscope, PL_initav);
2774 #ifdef PERL_DEBUG_READONLY_OPS
2775 if (PL_main_root && PL_main_root->op_slabbed)
2776 Slab_to_ro(OpSLAB(PL_main_root));
2782 PERL_SET_PHASE(PERL_PHASE_RUN);
2786 /* this complements the "EXECUTING..." debug we emit above.
2787 * it will show up when an eval fails in the main program level
2788 * and the code continues after the error.
2791 PERL_DEBUG(PerlIO_printf(Perl_debug_log, "\nCONTINUING...\n\n"));
2793 PL_restartjmpenv = NULL;
2794 PL_op = PL_restartop;
2798 else if (PL_main_start) {
2799 CvDEPTH(PL_main_cv) = 1;
2800 PL_op = PL_main_start;
2804 NOT_REACHED; /* NOTREACHED */
2808 =for apidoc_section $SV
2812 Returns the SV of the specified Perl scalar. C<flags> are passed to
2813 L</C<gv_fetchpv>>. If C<GV_ADD> is set and the
2814 Perl variable does not exist then it will be created. If C<flags> is zero
2815 and the variable does not exist then NULL is returned.
2821 Perl_get_sv(pTHX_ const char *name, I32 flags)
2825 PERL_ARGS_ASSERT_GET_SV;
2827 gv = gv_fetchpv(name, flags, SVt_PV);
2834 =for apidoc_section $AV
2838 Returns the AV of the specified Perl global or package array with the given
2839 name (so it won't work on lexical variables). C<flags> are passed
2840 to C<gv_fetchpv>. If C<GV_ADD> is set and the
2841 Perl variable does not exist then it will be created. If C<flags> is zero
2842 (ignoring C<SVf_UTF8>) and the variable does not exist then C<NULL> is
2845 Perl equivalent: C<@{"$name"}>.
2851 Perl_get_av(pTHX_ const char *name, I32 flags)
2853 GV* const gv = gv_fetchpv(name, flags, SVt_PVAV);
2855 PERL_ARGS_ASSERT_GET_AV;
2857 if (flags & ~SVf_UTF8)
2865 =for apidoc_section $HV
2869 Returns the HV of the specified Perl hash. C<flags> are passed to
2870 C<gv_fetchpv>. If C<GV_ADD> is set and the
2871 Perl variable does not exist then it will be created. If C<flags> is zero
2872 (ignoring C<SVf_UTF8>) and the variable does not exist then C<NULL> is
2879 Perl_get_hv(pTHX_ const char *name, I32 flags)
2881 GV* const gv = gv_fetchpv(name, flags, SVt_PVHV);
2883 PERL_ARGS_ASSERT_GET_HV;
2885 if (flags & ~SVf_UTF8)
2893 =for apidoc_section $CV
2896 =for apidoc_item get_cvn_flags
2897 =for apidoc_item |CV *|get_cvs|"string"|I32 flags
2899 These return the CV of the specified Perl subroutine. C<flags> are passed to
2900 C<gv_fetchpvn_flags>. If C<GV_ADD> is set and the Perl subroutine does not
2901 exist then it will be declared (which has the same effect as saying
2902 C<sub name;>). If C<GV_ADD> is not set and the subroutine does not exist,
2903 then NULL is returned.
2905 The forms differ only in how the subroutine is specified.. With C<get_cvs>,
2906 the name is a literal C string, enclosed in double quotes. With C<get_cv>, the
2907 name is given by the C<name> parameter, which must be a NUL-terminated C
2908 string. With C<get_cvn_flags>, the name is also given by the C<name>
2909 parameter, but it is a Perl string (possibly containing embedded NUL bytes),
2910 and its length in bytes is contained in the C<len> parameter.
2912 =for apidoc Amnh||GV_ADD
2918 Perl_get_cvn_flags(pTHX_ const char *name, STRLEN len, I32 flags)
2920 GV* const gv = gv_fetchpvn_flags(name, len, flags, SVt_PVCV);
2922 PERL_ARGS_ASSERT_GET_CVN_FLAGS;
2924 if (gv && UNLIKELY(SvROK(gv)) && SvTYPE(SvRV((SV *)gv)) == SVt_PVCV)
2925 return (CV*)SvRV((SV *)gv);
2927 /* XXX this is probably not what they think they're getting.
2928 * It has the same effect as "sub name;", i.e. just a forward
2930 if ((flags & ~GV_NOADD_MASK) && !GvCVu(gv)) {
2931 return newSTUB(gv,0);
2938 /* Nothing in core calls this now, but we can't replace it with a macro and
2939 move it to mathoms.c as a macro would evaluate name twice. */
2941 Perl_get_cv(pTHX_ const char *name, I32 flags)
2943 PERL_ARGS_ASSERT_GET_CV;
2945 return get_cvn_flags(name, strlen(name), flags);
2948 /* Be sure to refetch the stack pointer after calling these routines. */
2952 =for apidoc_section $callback
2954 =for apidoc call_argv
2956 Performs a callback to the specified named and package-scoped Perl subroutine
2957 with C<argv> (a C<NULL>-terminated array of strings) as arguments. See
2960 Approximate Perl equivalent: C<&{"$sub_name"}(@$argv)>.
2966 Perl_call_argv(pTHX_ const char *sub_name, I32 flags, char **argv)
2968 /* See G_* flags in cop.h */
2969 /* null terminated arg list */
2971 PERL_ARGS_ASSERT_CALL_ARGV;
2974 #ifdef PERL_RC_STACK
2979 PUSHMARK(PL_stack_sp);
2981 SV *newsv = newSVpv(*argv,0);
2983 *++PL_stack_sp = newsv;
2988 return call_pv(sub_name, flags);
2994 Performs a callback to the specified Perl sub. See L<perlcall>.
3000 Perl_call_pv(pTHX_ const char *sub_name, I32 flags)
3001 /* name of the subroutine */
3002 /* See G_* flags in cop.h */
3004 PERL_ARGS_ASSERT_CALL_PV;
3006 return call_sv(MUTABLE_SV(get_cv(sub_name, GV_ADD)), flags);
3010 =for apidoc call_method
3012 Performs a callback to the specified Perl method. The blessed object must
3013 be on the stack. See L<perlcall>.
3019 Perl_call_method(pTHX_ const char *methname, I32 flags)
3020 /* name of the subroutine */
3021 /* See G_* flags in cop.h */
3025 PERL_ARGS_ASSERT_CALL_METHOD;
3027 len = strlen(methname);
3028 sv = flags & G_METHOD_NAMED
3029 ? sv_2mortal(newSVpvn_share(methname, len,0))
3030 : newSVpvn_flags(methname, len, SVs_TEMP);
3032 return call_sv(sv, flags | G_METHOD);
3035 /* May be called with any of a CV, a GV, or an SV containing the name. */
3039 Performs a callback to the Perl sub specified by the SV.
3041 If neither the C<G_METHOD> nor C<G_METHOD_NAMED> flag is supplied, the
3042 SV may be any of a CV, a GV, a reference to a CV, a reference to a GV
3043 or C<SvPV(sv)> will be used as the name of the sub to call.
3045 If the C<G_METHOD> flag is supplied, the SV may be a reference to a CV or
3046 C<SvPV(sv)> will be used as the name of the method to call.
3048 If the C<G_METHOD_NAMED> flag is supplied, C<SvPV(sv)> will be used as
3049 the name of the method to call.
3051 Some other values are treated specially for internal use and should
3056 =for apidoc Amnh||G_METHOD
3057 =for apidoc Amnh||G_METHOD_NAMED
3063 Perl_call_sv(pTHX_ SV *sv, I32 arg_flags)
3064 /* See G_* flags in cop.h */
3066 LOGOP myop; /* fake syntax tree node */
3069 volatile SSize_t retval = 0;
3070 bool oldcatch = CATCH_GET;
3072 OP* const oldop = PL_op;
3073 /* Since we don't modify flags after setjmp() we don't really need to make
3074 flags volatile, but gcc complains that it could be clobbered anyway.
3076 volatile I32 flags = arg_flags;
3079 PERL_ARGS_ASSERT_CALL_SV;
3081 if (flags & G_DISCARD) {
3085 if (!(flags & G_WANT)) {
3086 /* Backwards compatibility - as G_SCALAR was 0, it could be omitted.
3091 Zero(&myop, 1, LOGOP);
3092 if (!(flags & G_NOARGS))
3093 myop.op_flags |= OPf_STACKED;
3094 myop.op_flags |= OP_GIMME_REVERSE(flags);
3095 myop.op_ppaddr = PL_ppaddr[OP_ENTERSUB];
3096 myop.op_type = OP_ENTERSUB;
3100 if (!(flags & G_METHOD_NAMED)) {
3102 *++PL_stack_sp = sv;
3103 #ifdef PERL_RC_STACK
3104 if (rpp_stack_is_rc())
3105 SvREFCNT_inc_simple_void_NN(sv);
3110 if (PERLDB_SUB && PL_curstash != PL_debstash
3111 /* Handle first BEGIN of -d. */
3112 && (PL_DBcv || (PL_DBcv = GvCV(PL_DBsub)))
3113 /* Try harder, since this may have been a sighandler, thus
3114 * curstash may be meaningless. */
3115 && (SvTYPE(sv) != SVt_PVCV || CvSTASH((const CV *)sv) != PL_debstash)
3116 && !(flags & G_NODEBUG))
3117 myop.op_private |= OPpENTERSUB_DB;
3119 if (flags & (G_METHOD|G_METHOD_NAMED)) {
3120 Zero(&method_op, 1, METHOP);
3121 method_op.op_next = (OP*)&myop;
3122 PL_op = (OP*)&method_op;
3123 if ( flags & G_METHOD_NAMED ) {
3124 method_op.op_ppaddr = PL_ppaddr[OP_METHOD_NAMED];
3125 method_op.op_type = OP_METHOD_NAMED;
3126 method_op.op_u.op_meth_sv = sv;
3128 method_op.op_ppaddr = PL_ppaddr[OP_METHOD];
3129 method_op.op_type = OP_METHOD;
3133 if (!(flags & G_EVAL)) {
3136 retval = PL_stack_sp - (PL_stack_base + oldmark);
3137 CATCH_SET(oldcatch);
3141 myop.op_other = (OP*)&myop;
3143 old_cxix = cxstack_ix;
3144 create_eval_scope( NULL, PL_stack_base + oldmark, flags|G_FAKINGEVAL);
3153 retval = PL_stack_sp - (PL_stack_base + oldmark);
3154 if (!(flags & G_KEEPERR)) {
3162 /* my_exit() was called */
3163 SET_CURSTASH(PL_defstash);
3167 NOT_REACHED; /* NOTREACHED */
3170 PL_restartjmpenv = NULL;
3171 PL_op = PL_restartop;
3175 /* Should be nothing left in stack frame apart from a possible
3176 * scalar context undef. Assert it's safe to reset the stack */
3177 assert( PL_stack_sp == PL_stack_base + oldmark
3178 || (PL_stack_sp == PL_stack_base + oldmark + 1
3179 && *PL_stack_sp == &PL_sv_undef));
3180 PL_stack_sp = PL_stack_base + oldmark;
3181 if ((flags & G_WANT) == G_LIST)
3185 *++PL_stack_sp = &PL_sv_undef;
3190 /* if we croaked, depending on how we croaked the eval scope
3191 * may or may not have already been popped */
3192 if (cxstack_ix > old_cxix) {
3193 assert(cxstack_ix == old_cxix + 1);
3194 assert(CxTYPE(CX_CUR()) == CXt_EVAL);
3195 delete_eval_scope();
3200 if (flags & G_DISCARD) {
3201 #ifdef PERL_RC_STACK
3202 if (rpp_stack_is_rc())
3203 rpp_popfree_to(PL_stack_base + oldmark);
3206 PL_stack_sp = PL_stack_base + oldmark;
3215 /* Eval a string. The G_EVAL flag is always assumed. */
3220 Tells Perl to C<eval> the string in the SV. It supports the same flags
3221 as C<call_sv>, with the obvious exception of C<G_EVAL>. See L<perlcall>.
3223 The C<G_RETHROW> flag can be used if you only need eval_sv() to
3224 execute code specified by a string, but not catch any errors.
3226 By default the code is compiled and executed with the default hints,
3227 such as strict and features. Set C<G_USEHINTS> in flags to use the
3228 current hints from C<PL_curcop>.
3230 =for apidoc Amnh||G_RETHROW
3231 =for apidoc Amnh||G_USEHINTS
3236 Perl_eval_sv(pTHX_ SV *sv, I32 flags)
3238 /* See G_* flags in cop.h */
3240 UNOP myop; /* fake syntax tree node */
3241 volatile SSize_t oldmark;
3242 volatile SSize_t retval = 0;
3244 OP* const oldop = PL_op;
3247 PERL_ARGS_ASSERT_EVAL_SV;
3249 if (flags & G_DISCARD) {
3256 Zero(&myop, 1, UNOP);
3257 myop.op_ppaddr = PL_ppaddr[OP_ENTEREVAL];
3258 myop.op_type = OP_ENTEREVAL;
3260 oldmark = PL_stack_sp - PL_stack_base;
3262 *++PL_stack_sp = sv;
3263 #ifdef PERL_RC_STACK
3264 if (rpp_stack_is_rc())
3265 SvREFCNT_inc_simple_void_NN(sv);
3268 if (!(flags & G_NOARGS))
3269 myop.op_flags = OPf_STACKED;
3270 myop.op_type = OP_ENTEREVAL;
3271 myop.op_flags |= OP_GIMME_REVERSE(flags);
3272 if (flags & G_KEEPERR)
3273 myop.op_flags |= OPf_SPECIAL;
3275 myop.op_private = (OPpEVAL_EVALSV); /* tell pp_entereval we're the caller */
3276 if (flags & G_RE_REPARSING)
3277 myop.op_private |= (OPpEVAL_COPHH | OPpEVAL_RE_REPARSING);
3279 if (flags & G_USEHINTS)
3280 myop.op_private |= OPpEVAL_COPHH;
3282 /* fail now; otherwise we could fail after the JMPENV_PUSH but
3283 * before a cx_pusheval(), which corrupts the stack after a croak */
3284 TAINT_PROPER("eval_sv()");
3290 if (!*PL_stack_sp) {
3291 /* In the presence of the OPpEVAL_EVALSV flag,
3292 * pp_entereval() pushes a NULL pointer onto the stack to
3293 * indicate compilation failure. Otherwise, the top slot on
3294 * the stack will be a non-NULL pointer to whatever scalar or
3295 * list value(s) the eval returned. In void context it will
3296 * be whatever our caller has at the top of stack at the time,
3297 * or the &PL_sv_undef guard at PL_stack_base[0]. Note that
3298 * NULLs are not pushed on the stack except in a few very
3299 * specific circumstances (such as this) to flag something
3305 retval = PL_stack_sp - (PL_stack_base + oldmark);
3306 if (!(flags & G_KEEPERR)) {
3314 /* my_exit() was called */
3315 SET_CURSTASH(PL_defstash);
3319 NOT_REACHED; /* NOTREACHED */
3322 PL_restartjmpenv = NULL;
3323 PL_op = PL_restartop;
3329 if (flags & G_RETHROW) {
3333 /* Should be nothing left in stack frame apart from a possible
3334 * scalar context undef. Assert it's safe to reset the stack */
3335 assert( PL_stack_sp == PL_stack_base + oldmark
3336 || (PL_stack_sp == PL_stack_base + oldmark + 1
3337 && *PL_stack_sp == &PL_sv_undef));
3338 PL_stack_sp = PL_stack_base + oldmark;
3339 if ((flags & G_WANT) == G_LIST)
3343 *++PL_stack_sp = &PL_sv_undef;
3349 if (flags & G_DISCARD) {
3350 #ifdef PERL_RC_STACK
3351 if (rpp_stack_is_rc())
3352 rpp_popfree_to(PL_stack_base + oldmark);
3355 PL_stack_sp = PL_stack_base + oldmark;
3367 Tells Perl to C<eval> the given string in scalar context and return an SV* result.
3373 Perl_eval_pv(pTHX_ const char *p, I32 croak_on_error)
3375 SV* sv = newSVpv(p, 0);
3377 PERL_ARGS_ASSERT_EVAL_PV;
3379 if (croak_on_error) {
3381 eval_sv(sv, G_SCALAR | G_RETHROW);
3384 eval_sv(sv, G_SCALAR);
3390 #ifdef PERL_RC_STACK
3391 if (rpp_stack_is_rc()) {
3392 SvREFCNT_inc_NN(sv_2mortal(sv));
3402 /* Require a module. */
3405 =for apidoc_section $embedding
3407 =for apidoc require_pv
3409 Tells Perl to C<require> the file named by the string argument. It is
3410 analogous to the Perl code C<eval "require '$file'">. It's even
3411 implemented that way; consider using load_module instead.
3416 Perl_require_pv(pTHX_ const char *pv)
3421 PERL_ARGS_ASSERT_REQUIRE_PV;
3423 PUSHSTACKi(PERLSI_REQUIRE);
3424 sv = Perl_newSVpvf(aTHX_ "require q%c%s%c", 0, pv, 0);
3425 eval_sv(sv_2mortal(sv), G_DISCARD);
3430 S_usage(pTHX) /* XXX move this out into a module ? */
3432 /* This message really ought to be max 23 lines.
3433 * Removed -h because the user already knows that option. Others? */
3435 /* Grouped as 6 lines per C string literal, to keep under the ANSI C 89
3436 minimum of 509 character string literals. */
3437 static const char * const usage_msg[] = {
3438 " -0[octal/hexadecimal] specify record separator (\\0, if no argument)\n"
3439 " -a autosplit mode with -n or -p (splits $_ into @F)\n"
3440 " -C[number/list] enables the listed Unicode features\n"
3441 " -c check syntax only (runs BEGIN and CHECK blocks)\n"
3442 " -d[t][:MOD] run program under debugger or module Devel::MOD\n"
3443 " -D[number/letters] set debugging flags (argument is a bit mask or alphabets)\n",
3444 " -e commandline one line of program (several -e's allowed, omit programfile)\n"
3445 " -E commandline like -e, but enables all optional features\n"
3446 " -f don't do $sitelib/sitecustomize.pl at startup\n"
3447 " -F/pattern/ split() pattern for -a switch (//'s are optional)\n"
3448 " -g read all input in one go (slurp), rather than line-by-line (alias for -0777)\n"
3449 " -i[extension] edit <> files in place (makes backup if extension supplied)\n"
3450 " -Idirectory specify @INC/#include directory (several -I's allowed)\n",
3451 " -l[octnum] enable line ending processing, specifies line terminator\n"
3452 " -[mM][-]module execute \"use/no module...\" before executing program\n"
3453 " -n assume \"while (<>) { ... }\" loop around program\n"
3454 " -p assume loop like -n but print line also, like sed\n"
3455 " -s enable rudimentary parsing for switches after programfile\n"
3456 " -S look for programfile using PATH environment variable\n",
3457 " -t enable tainting warnings\n"
3458 " -T enable tainting checks\n"
3459 " -u dump core after parsing program\n"
3460 " -U allow unsafe operations\n"
3461 " -v print version, patchlevel and license\n"
3462 " -V[:configvar] print configuration summary (or a single Config.pm variable)\n",
3463 " -w enable many useful warnings\n"
3464 " -W enable all warnings\n"
3465 " -x[directory] ignore text before #!perl line (optionally cd to directory)\n"
3466 " -X disable all warnings\n"
3468 "Run 'perldoc perl' for more help with Perl.\n\n",
3471 const char * const *p = usage_msg;
3472 PerlIO *out = PerlIO_stdout();
3475 "\nUsage: %s [switches] [--] [programfile] [arguments]\n",
3478 PerlIO_puts(out, *p++);
3482 /* convert a string of -D options (or digits) into an int.
3483 * sets *s to point to the char after the options */
3487 Perl_get_debug_opts(pTHX_ const char **s, bool givehelp)
3489 static const char * const usage_msgd[] = {
3490 " Debugging flag values: (see also -d)\n"
3491 " p Tokenizing and parsing (with v, displays parse stack)\n"
3492 " s Stack snapshots (with v, displays all stacks)\n"
3493 " l Context (loop) stack processing\n"
3494 " t Trace execution\n"
3495 " o Method and overloading resolution\n",
3496 " c String/numeric conversions\n"
3497 " P Print profiling info, source file input state\n"
3498 " m Memory and SV allocation\n"
3499 " f Format processing\n"
3500 " r Regular expression parsing and execution\n"
3501 " x Syntax tree dump\n",
3502 " u Tainting checks\n"
3503 " X Scratchpad allocation\n"
3505 " S Op slab allocation\n"
3507 " R Include reference counts of dumped variables (eg when using -Ds)\n",
3508 " J Do not s,t,P-debug (Jump over) opcodes within package DB\n"
3509 " v Verbose: use in conjunction with other flags\n"
3510 " C Copy On Write\n"
3511 " A Consistency checks on internal structures\n"
3512 " q quiet - currently only suppresses the 'EXECUTING' message\n"
3513 " M trace smart match resolution\n"
3514 " B dump suBroutine definitions, including special Blocks like BEGIN\n",
3515 " L trace some locale setting information--for Perl core development\n",
3516 " i trace PerlIO layer processing\n",
3517 " y trace y///, tr/// compilation and execution\n",
3518 " h Show (h)ash randomization debug output"
3519 " (changes to PL_hash_rand_bits)\n",
3524 PERL_ARGS_ASSERT_GET_DEBUG_OPTS;
3528 * If adding new options add them to the END of debopts[].
3529 * If you remove an option replace it with a '?'.
3530 * If there is a free slot available marked with '?' feel
3531 * free to reuse it for something else.
3533 * Regardless remember to update DEBUG_MASK in perl.h, and
3534 * update the documentation above AND in pod/perlrun.pod.
3536 * Note that the ? indicates an unused slot. As the code below
3537 * indicates the position in this list is important. You cannot
3538 * change the order or delete a character from the list without
3539 * impacting the definitions of all the other flags in perl.h
3540 * However because the logic is guarded by isWORDCHAR we can
3541 * fill in holes with non-wordchar characters instead. */
3542 static const char debopts[] = "psltocPmfrxuUhXDSTRJvCAqMBLiy";
3544 for (; isWORDCHAR(**s); (*s)++) {
3545 const char * const d = strchr(debopts,**s);
3547 uv |= 1 << (d - debopts);
3548 else if (ckWARN_d(WARN_DEBUGGING))
3549 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3550 "invalid option -D%c, use -D'' to see choices\n", **s);
3553 else if (isDIGIT(**s)) {
3554 const char* e = *s + strlen(*s);
3555 if (grok_atoUV(*s, &uv, &e))
3557 for (; isWORDCHAR(**s); (*s)++) ;
3559 else if (givehelp) {
3560 const char *const *p = usage_msgd;
3561 while (*p) PerlIO_puts(PerlIO_stdout(), *p++);
3563 return (int)uv; /* ignore any UV->int conversion loss */
3567 /* This routine handles any switches that can be given during run */
3570 Perl_moreswitches(pTHX_ const char *s)
3573 const char option = *s; /* used to remember option in -m/-M code */
3575 PERL_ARGS_ASSERT_MORESWITCHES;
3583 SvREFCNT_dec(PL_rs);
3584 if (s[1] == 'x' && s[2]) {
3585 const char *e = s+=2;
3591 flags = PERL_SCAN_SILENT_ILLDIGIT;
3592 rschar = (U32)grok_hex(s, &numlen, &flags, NULL);
3593 if (s + numlen < e) {
3594 /* Continue to treat -0xFOO as -0 -xFOO
3595 * (ie NUL as the input record separator, and -x with FOO
3596 * as the directory argument)
3598 * hex support for -0 was only added in 5.8.1, hence this
3599 * heuristic to distinguish between it and '-0' clustered with
3600 * '-x' with an argument. The text following '-0x' is only
3601 * processed as the IRS specified in hexadecimal if all
3602 * characters are valid hex digits. */
3607 PL_rs = newSV((STRLEN)(UVCHR_SKIP(rschar) + 1));
3608 tmps = (U8*)SvPVCLEAR_FRESH(PL_rs);
3609 uvchr_to_utf8(tmps, rschar);
3610 SvCUR_set(PL_rs, UVCHR_SKIP(rschar));
3615 rschar = (U32)grok_oct(s, &numlen, &flags, NULL);
3616 if (rschar & ~((U8)~0))
3617 PL_rs = &PL_sv_undef;
3618 else if (!rschar && numlen >= 2)
3619 PL_rs = newSVpvs("");
3621 char ch = (char)rschar;
3622 PL_rs = newSVpvn(&ch, 1);
3625 sv_setsv(get_sv("/", GV_ADD), PL_rs);
3630 PL_unicode = parse_unicode_opts( (const char **)&s );
3631 if (PL_unicode & PERL_UNICODE_UTF8CACHEASSERT_FLAG)
3639 const char *start = ++s;
3640 while (*s && !isSPACE(*s)) ++s;
3641 Safefree(PL_splitstr);
3642 PL_splitstr = savepvn(start, s - start);
3655 forbid_setid('d', FALSE);
3658 /* -dt indicates to the debugger that threads will be used */
3659 if (*s == 't' && !isWORDCHAR(s[1])) {
3661 my_setenv("PERL5DB_THREADED", "1");
3664 /* The following permits -d:Mod to accepts arguments following an =
3665 in the fashion that -MSome::Mod does. */
3666 if (*s == ':' || *s == '=') {
3673 sv = newSVpvs("no Devel::");
3675 sv = newSVpvs("use Devel::");
3679 end = s + strlen(s);
3681 /* We now allow -d:Module=Foo,Bar and -d:-Module */
3682 while(isWORDCHAR(*s) || *s==':') ++s;
3684 sv_catpvn(sv, start, end - start);
3686 sv_catpvn(sv, start, s-start);
3687 /* Don't use NUL as q// delimiter here, this string goes in the
3689 Perl_sv_catpvf(aTHX_ sv, " split(/,/,q{%s});", ++s);
3692 my_setenv("PERL5DB", SvPV_nolen_const(sv));
3696 PL_perldb = PERLDB_ALL;
3703 forbid_setid('D', FALSE);
3705 PL_debug = get_debug_opts( (const char **)&s, 1) | DEBUG_TOP_FLAG;
3706 #else /* !DEBUGGING */
3707 if (ckWARN_d(WARN_DEBUGGING))
3708 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3709 "Recompile perl with -DDEBUGGING to use -D switch (did you mean -d ?)\n");
3710 for (s++; isWORDCHAR(*s); s++) ;
3713 NOT_REACHED; /* NOTREACHED */
3716 SvREFCNT_dec(PL_rs);
3717 PL_rs = &PL_sv_undef;
3718 sv_setsv(get_sv("/", GV_ADD), PL_rs);
3725 NOT_REACHED; /* NOTREACHED */
3728 Safefree(PL_inplace);
3730 const char * const start = ++s;
3731 while (*s && !isSPACE(*s))
3734 PL_inplace = savepvn(start, s - start);
3737 case 'I': /* -I handled both here and in parse_body() */
3738 forbid_setid('I', FALSE);
3740 while (*s && isSPACE(*s))
3745 /* ignore trailing spaces (possibly followed by other switches) */
3747 for (e = p; *e && !isSPACE(*e); e++) ;
3751 } while (*p && *p != '-');
3753 INCPUSH_ADD_SUB_DIRS|INCPUSH_ADD_OLD_VERS|INCPUSH_UNSHIFT);
3759 Perl_croak(aTHX_ "No directory specified for -I");
3765 SvREFCNT_dec(PL_ors_sv);
3771 PL_ors_sv = newSVpvs("\n");
3772 numlen = 3 + (*s == '0');
3773 *SvPVX(PL_ors_sv) = (char)grok_oct(s, &numlen, &flags, NULL);
3777 if (RsPARA(PL_rs)) {
3778 PL_ors_sv = newSVpvs("\n\n");
3781 PL_ors_sv = newSVsv(PL_rs);
3786 forbid_setid('M', FALSE); /* XXX ? */
3789 forbid_setid('m', FALSE); /* XXX ? */
3794 const char *use = "use ";
3796 /* -M-foo == 'no foo' */
3797 /* Leading space on " no " is deliberate, to make both
3798 possibilities the same length. */
3799 if (*s == '-') { use = " no "; ++s; }
3800 sv = newSVpvn(use,4);
3802 /* We allow -M'Module qw(Foo Bar)' */
3803 while(isWORDCHAR(*s) || *s==':') {
3812 Perl_croak(aTHX_ "Module name required with -%c option",
3815 Perl_croak(aTHX_ "Invalid module name %.*s with -%c option: "
3816 "contains single ':'",
3817 (int)(s - start), start, option);
3818 end = s + strlen(s);
3820 sv_catpvn(sv, start, end - start);
3821 if (option == 'm') {
3823 Perl_croak(aTHX_ "Can't use '%c' after -mname", *s);
3824 sv_catpvs( sv, " ()");
3827 sv_catpvn(sv, start, s-start);
3828 /* Use NUL as q''-delimiter. */
3829 sv_catpvs(sv, " split(/,/,q\0");
3831 sv_catpvn(sv, s, end - s);
3832 sv_catpvs(sv, "\0)");
3835 Perl_av_create_and_push(aTHX_ &PL_preambleav, sv);
3838 Perl_croak(aTHX_ "Missing argument to -%c", option);
3849 forbid_setid('s', FALSE);
3850 PL_doswitches = TRUE;
3855 #if defined(SILENT_NO_TAINT_SUPPORT)
3856 /* silently ignore */
3857 #elif defined(NO_TAINT_SUPPORT)
3858 Perl_croak_nocontext("This perl was compiled without taint support. "
3859 "Cowardly refusing to run with -t or -T flags");
3867 PL_do_undump = TRUE;
3877 if (! (PL_dowarn & G_WARN_ALL_MASK)) {
3878 PL_dowarn |= G_WARN_ON;
3883 PL_dowarn = G_WARN_ALL_ON|G_WARN_ON;
3884 free_and_set_cop_warnings(&PL_compiling, pWARN_ALL);
3888 PL_dowarn = G_WARN_ALL_OFF;
3889 free_and_set_cop_warnings(&PL_compiling, pWARN_NONE);
3896 if (s[0] == '-') /* Additional switches on #! line. */
3901 #if defined(WIN32) || !defined(PERL_STRICT_CR)
3907 #ifdef ALTERNATE_SHEBANG
3908 case 'S': /* OS/2 needs -S on "extproc" line. */
3911 case 'e': case 'f': case 'x': case 'E':
3912 #ifndef ALTERNATE_SHEBANG
3916 Perl_croak(aTHX_ "Can't emulate -%.1s on #! line",s);
3919 "Unrecognized switch: -%.1s (-h will show valid options)",s
3929 PerlIO * PIO_stdout;
3931 const char * const level_str = "v" PERL_VERSION_STRING;
3932 const STRLEN level_len = sizeof("v" PERL_VERSION_STRING)-1;
3933 #ifdef PERL_PATCHNUM
3935 # ifdef PERL_GIT_UNCOMMITTED_CHANGES
3936 static const char num [] = PERL_PATCHNUM "*";
3938 static const char num [] = PERL_PATCHNUM;
3941 const STRLEN num_len = sizeof(num)-1;
3942 /* A very advanced compiler would fold away the strnEQ
3943 and this whole conditional, but most (all?) won't do it.
3944 SV level could also be replaced by with preprocessor
3947 if (num_len >= level_len && strnEQ(num,level_str,level_len)) {
3948 /* per 46807d8e80, PERL_PATCHNUM is outside of the control
3949 of the interp so it might contain format characters
3951 level = newSVpvn(num, num_len);
3953 level = Perl_newSVpvf_nocontext("%s (%s)", level_str, num);
3957 SV* level = newSVpvn(level_str, level_len);
3958 #endif /* #ifdef PERL_PATCHNUM */
3959 PIO_stdout = PerlIO_stdout();
3960 PerlIO_printf(PIO_stdout,
3961 "\nThis is perl " STRINGIFY(PERL_REVISION)
3962 ", version " STRINGIFY(PERL_VERSION)
3963 ", subversion " STRINGIFY(PERL_SUBVERSION)
3964 " (%" SVf ") built for " ARCHNAME, SVfARG(level)
3966 SvREFCNT_dec_NN(level);
3968 #if defined(LOCAL_PATCH_COUNT)
3969 if (LOCAL_PATCH_COUNT > 0)
3970 PerlIO_printf(PIO_stdout,
3971 "\n(with %d registered patch%s, "
3972 "see perl -V for more detail)",
3974 (LOCAL_PATCH_COUNT!=1) ? "es" : "");
3977 PerlIO_printf(PIO_stdout,
3978 "\n\nCopyright 1987-2023, Larry Wall\n");
3980 PerlIO_printf(PIO_stdout,
3981 "\n\nOS/2 port Copyright (c) 1990, 1991, Raymond Chen, Kai Uwe Rommel\n"
3982 "Version 5 port Copyright (c) 1994-2002, Andreas Kaiser, Ilya Zakharevich\n");
3985 PerlIO_printf(PIO_stdout,
3986 "MVS (OS390) port by Mortice Kern Systems, 1997-1999\n");
3989 PerlIO_printf(PIO_stdout,
3990 "Stratus OpenVOS port by Paul.Green@stratus.com, 1997-2013\n");
3993 PerlIO_printf(PIO_stdout,
3994 "BS2000 (POSIX) port by Start Amadeus GmbH, 1998-1999\n");
3996 #ifdef BINARY_BUILD_NOTICE
3997 BINARY_BUILD_NOTICE;
3999 PerlIO_printf(PIO_stdout,
4001 Perl may be copied only under the terms of either the Artistic License or the\n\
4002 GNU General Public License, which may be found in the Perl 5 source kit.\n\n\
4003 Complete documentation for Perl, including FAQ lists, should be found on\n\
4004 this system using \"man perl\" or \"perldoc perl\". If you have access to the\n\
4005 Internet, point your browser at https://www.perl.org/, the Perl Home Page.\n\n");
4009 /* compliments of Tom Christiansen */
4011 /* unexec() can be found in the Gnu emacs distribution */
4012 /* Known to work with -DUNEXEC and using unexelf.c from GNU emacs-20.2 */
4015 #include <lib$routines.h>
4019 Perl_my_unexec(pTHX)
4022 SV * prog = newSVpv(BIN_EXP, 0);
4023 SV * file = newSVpv(PL_origfilename, 0);
4027 sv_catpvs(prog, "/perl");
4028 sv_catpvs(file, ".perldump");
4030 unexec(SvPVX(file), SvPVX(prog), &etext, sbrk(0), 0);
4031 /* unexec prints msg to stderr in case of failure */
4032 PerlProc_exit(status);
4034 PERL_UNUSED_CONTEXT;
4036 lib$signal(SS$_DEBUG); /* ssdef.h #included from vmsish.h */
4037 # elif defined(WIN32) || defined(__CYGWIN__)
4038 Perl_croak_nocontext("dump is not supported");
4040 ABORT(); /* for use with undump */
4045 /* initialize curinterp */
4050 # define PERLVAR(prefix,var,type)
4051 # define PERLVARA(prefix,var,n,type)
4052 # if defined(MULTIPLICITY)
4053 # define PERLVARI(prefix,var,type,init) aTHX->prefix##var = init;
4054 # define PERLVARIC(prefix,var,type,init) aTHX->prefix##var = init;
4056 # define PERLVARI(prefix,var,type,init) PERL_GET_INTERP->var = init;
4057 # define PERLVARIC(prefix,var,type,init) PERL_GET_INTERP->var = init;
4059 # include "intrpvar.h"
4065 # define PERLVAR(prefix,var,type)
4066 # define PERLVARA(prefix,var,n,type)
4067 # define PERLVARI(prefix,var,type,init) PL_##var = init;
4068 # define PERLVARIC(prefix,var,type,init) PL_##var = init;
4069 # include "intrpvar.h"
4079 S_init_main_stash(pTHX)
4084 PL_curstash = PL_defstash = (HV *)SvREFCNT_inc_simple_NN(hv);
4085 /* We know that the string "main" will be in the global shared string
4086 table, so it's a small saving to use it rather than allocate another
4088 PL_curstname = newSVpvs_share("main");
4089 gv = gv_fetchpvs("main::", GV_ADD|GV_NOTQUAL, SVt_PVHV);
4090 /* If we hadn't caused another reference to "main" to be in the shared
4091 string table above, then it would be worth reordering these two,
4092 because otherwise all we do is delete "main" from it as a consequence
4093 of the SvREFCNT_dec, only to add it again with hv_name_set */
4094 SvREFCNT_dec(GvHV(gv));
4095 hv_name_sets(PL_defstash, "main", 0);
4096 GvHV(gv) = MUTABLE_HV(SvREFCNT_inc_simple(PL_defstash));
4098 PL_incgv = gv_HVadd(gv_AVadd(gv_fetchpvs("INC", GV_ADD|GV_NOTQUAL,
4100 SvREFCNT_inc_simple_void(PL_incgv); /* Don't allow it to be freed */
4101 GvMULTI_on(PL_incgv);
4102 PL_hintgv = gv_fetchpvs("\010", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^H */
4103 SvREFCNT_inc_simple_void(PL_hintgv);
4104 GvMULTI_on(PL_hintgv);
4105 PL_defgv = gv_fetchpvs("_", GV_ADD|GV_NOTQUAL, SVt_PVAV);
4106 SvREFCNT_inc_simple_void(PL_defgv);
4107 PL_errgv = gv_fetchpvs("@", GV_ADD|GV_NOTQUAL, SVt_PV);
4108 SvREFCNT_inc_simple_void(PL_errgv);
4109 GvMULTI_on(PL_errgv);
4110 PL_replgv = gv_fetchpvs("\022", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^R */
4111 SvREFCNT_inc_simple_void(PL_replgv);
4112 GvMULTI_on(PL_replgv);
4113 (void)Perl_form(aTHX_ "%240s",""); /* Preallocate temp - for immediate signals. */
4114 #ifdef PERL_DONT_CREATE_GVSV
4115 (void)gv_SVadd(PL_errgv);
4117 sv_grow(ERRSV, 240); /* Preallocate - for immediate signals. */
4119 CopSTASH_set(&PL_compiling, PL_defstash);
4120 PL_debstash = GvHV(gv_fetchpvs("DB::", GV_ADDMULTI, SVt_PVHV));
4121 PL_globalstash = GvHV(gv_fetchpvs("CORE::GLOBAL::", GV_ADDMULTI,
4123 /* We must init $/ before switches are processed. */
4124 sv_setpvs(get_sv("/", GV_ADD), "\n");
4128 S_open_script(pTHX_ const char *scriptname, bool dosearch, bool *suidscript)
4131 PerlIO *rsfp = NULL;
4135 PERL_ARGS_ASSERT_OPEN_SCRIPT;
4138 PL_origfilename = savepvs("-e");
4143 /* if find_script() returns, it returns a malloc()-ed value */
4144 scriptname = PL_origfilename = find_script(scriptname, dosearch, NULL, 1);
4145 s = scriptname + strlen(scriptname);
4147 if (strBEGINs(scriptname, "/dev/fd/")
4148 && isDIGIT(scriptname[8])
4149 && grok_atoUV(scriptname + 8, &uv, &s)
4150 && uv <= PERL_INT_MAX
4155 * Tell apart "normal" usage of fdscript, e.g.
4156 * with bash on FreeBSD:
4157 * perl <( echo '#!perl -DA'; echo 'print "$0\n"')
4158 * from usage in suidperl.
4159 * Does any "normal" usage leave garbage after the number???
4160 * Is it a mistake to use a similar /dev/fd/ construct for
4165 * Be supersafe and do some sanity-checks.
4166 * Still, can we be sure we got the right thing?
4169 Perl_croak(aTHX_ "Wrong syntax (suid) fd script name \"%s\"\n", s);
4172 Perl_croak(aTHX_ "Missing (suid) fd script name\n");
4174 scriptname = savepv(s + 1);
4175 Safefree(PL_origfilename);
4176 PL_origfilename = (char *)scriptname;
4181 CopFILE_free(PL_curcop);
4182 CopFILE_set(PL_curcop, PL_origfilename);
4183 if (*PL_origfilename == '-' && PL_origfilename[1] == '\0')
4184 scriptname = (char *)"";
4185 if (fdscript >= 0) {
4186 rsfp = PerlIO_fdopen(fdscript,PERL_SCRIPT_MODE);
4188 else if (!*scriptname) {
4189 forbid_setid(0, *suidscript);
4193 #ifdef FAKE_BIT_BUCKET
4194 /* This hack allows one not to have /dev/null (or BIT_BUCKET as it
4195 * is called) and still have the "-e" work. (Believe it or not,
4196 * a /dev/null is required for the "-e" to work because source
4197 * filter magic is used to implement it. ) This is *not* a general
4198 * replacement for a /dev/null. What we do here is create a temp
4199 * file (an empty file), open up that as the script, and then
4200 * immediately close and unlink it. Close enough for jazz. */
4201 #define FAKE_BIT_BUCKET_PREFIX "/tmp/perlnull-"
4202 #define FAKE_BIT_BUCKET_SUFFIX "XXXXXXXX"
4203 #define FAKE_BIT_BUCKET_TEMPLATE FAKE_BIT_BUCKET_PREFIX FAKE_BIT_BUCKET_SUFFIX
4204 char tmpname[sizeof(FAKE_BIT_BUCKET_TEMPLATE)] = {
4205 FAKE_BIT_BUCKET_TEMPLATE
4207 const char * const err = "Failed to create a fake bit bucket";
4208 if (strEQ(scriptname, BIT_BUCKET)) {
4209 int tmpfd = Perl_my_mkstemp_cloexec(tmpname);
4211 scriptname = tmpname;
4214 Perl_croak(aTHX_ err);
4217 rsfp = PerlIO_open(scriptname,PERL_SCRIPT_MODE);
4218 #ifdef FAKE_BIT_BUCKET
4219 if ( strBEGINs(scriptname, FAKE_BIT_BUCKET_PREFIX)
4220 && strlen(scriptname) == sizeof(tmpname) - 1)
4224 scriptname = BIT_BUCKET;
4228 /* PSz 16 Sep 03 Keep neat error message */
4230 Perl_croak(aTHX_ "Can't open " BIT_BUCKET ": %s\n", Strerror(errno));
4232 Perl_croak(aTHX_ "Can't open perl script \"%s\": %s\n",
4233 CopFILE(PL_curcop), Strerror(errno));
4235 fd = PerlIO_fileno(rsfp);
4238 (PerlLIO_fstat(fd, &tmpstatbuf) >= 0
4239 && S_ISDIR(tmpstatbuf.st_mode)))
4240 Perl_croak(aTHX_ "Can't open perl script \"%s\": %s\n",
4247 /* In the days of suidperl, we refused to execute a setuid script stored on
4248 * a filesystem mounted nosuid and/or noexec. This meant that we probed for the
4249 * existence of the appropriate filesystem-statting function, and behaved
4250 * accordingly. But even though suidperl is long gone, we must still include
4251 * those probes for the benefit of modules like Filesys::Df, which expect the
4252 * results of those probes to be stored in %Config; see RT#126368. So mention
4253 * the relevant cpp symbols here, to ensure that metaconfig will include their
4254 * probes in the generated Configure:
4256 * I_SYSSTATVFS HAS_FSTATVFS
4258 * I_STATFS HAS_FSTATFS HAS_GETFSSTAT
4259 * I_MNTENT HAS_GETMNTENT HAS_HASMNTOPT
4263 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
4264 /* Don't even need this function. */
4267 S_validate_suid(pTHX_ PerlIO *rsfp)
4269 const Uid_t my_uid = PerlProc_getuid();
4270 const Uid_t my_euid = PerlProc_geteuid();
4271 const Gid_t my_gid = PerlProc_getgid();
4272 const Gid_t my_egid = PerlProc_getegid();
4274 PERL_ARGS_ASSERT_VALIDATE_SUID;
4276 if (my_euid != my_uid || my_egid != my_gid) { /* (suidperl doesn't exist, in fact) */
4277 int fd = PerlIO_fileno(rsfp);
4279 if (fd < 0 || PerlLIO_fstat(fd, &statbuf) < 0) { /* may be either wrapped or real suid */
4280 Perl_croak_nocontext( "Illegal suidscript");
4282 if ((my_euid != my_uid && my_euid == statbuf.st_uid && statbuf.st_mode & S_ISUID)
4284 (my_egid != my_gid && my_egid == statbuf.st_gid && statbuf.st_mode & S_ISGID)
4287 Perl_croak(aTHX_ "YOU HAVEN'T DISABLED SET-ID SCRIPTS IN THE KERNEL YET!\n\
4288 FIX YOUR KERNEL, PUT A C WRAPPER AROUND THIS SCRIPT, OR USE -u AND UNDUMP!\n");
4289 /* not set-id, must be wrapped */
4292 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4295 S_find_beginning(pTHX_ SV* linestr_sv, PerlIO *rsfp)
4300 PERL_ARGS_ASSERT_FIND_BEGINNING;
4302 /* skip forward in input to the real script? */
4305 if ((s = sv_gets(linestr_sv, rsfp, 0)) == NULL)
4306 Perl_croak(aTHX_ "No Perl script found in input\n");
4308 } while (!(*s == '#' && s[1] == '!' && ((s = instr(s,"perl")) || (s = instr(s2,"PERL")))));
4309 PerlIO_ungetc(rsfp, '\n'); /* to keep line count right */
4310 while (*s && !(isSPACE (*s) || *s == '#')) s++;
4312 while (*s == ' ' || *s == '\t') s++;
4314 while (isDIGIT(s2[-1]) || s2[-1] == '-' || s2[-1] == '.'
4315 || s2[-1] == '_') s2--;
4316 if (strBEGINs(s2-4,"perl"))
4317 while ((s = moreswitches(s)))
4326 /* no need to do anything here any more if we don't
4328 #ifndef NO_TAINT_SUPPORT
4329 const Uid_t my_uid = PerlProc_getuid();
4330 const Uid_t my_euid = PerlProc_geteuid();
4331 const Gid_t my_gid = PerlProc_getgid();
4332 const Gid_t my_egid = PerlProc_getegid();
4334 PERL_UNUSED_CONTEXT;
4336 /* Should not happen: */
4337 CHECK_MALLOC_TAINT(my_uid && (my_euid != my_uid || my_egid != my_gid));
4338 TAINTING_set( TAINTING_get | (my_uid && (my_euid != my_uid || my_egid != my_gid)) );
4342 * Should go by suidscript, not uid!=euid: why disallow
4343 * system("ls") in scripts run from setuid things?
4344 * Or, is this run before we check arguments and set suidscript?
4345 * What about SETUID_SCRIPTS_ARE_SECURE_NOW: could we use fdscript then?
4346 * (We never have suidscript, can we be sure to have fdscript?)
4347 * Or must then go by UID checks? See comments in forbid_setid also.
4351 /* This is used very early in the lifetime of the program,
4352 * before even the options are parsed, so PL_tainting has
4353 * not been initialized properly. */
4355 Perl_doing_taint(int argc, char *argv[], char *envp[])
4357 #ifndef PERL_IMPLICIT_SYS
4358 /* If we have PERL_IMPLICIT_SYS we can't call getuid() et alia
4359 * before we have an interpreter-- and the whole point of this
4360 * function is to be called at such an early stage. If you are on
4361 * a system with PERL_IMPLICIT_SYS but you do have a concept of
4362 * "tainted because running with altered effective ids', you'll
4363 * have to add your own checks somewhere in here. The most known
4364 * sample of 'implicitness' is Win32, which doesn't have much of
4365 * concept of 'uids'. */
4366 Uid_t uid = PerlProc_getuid();
4367 Uid_t euid = PerlProc_geteuid();
4368 Gid_t gid = PerlProc_getgid();
4369 Gid_t egid = PerlProc_getegid();
4376 if (uid && (euid != uid || egid != gid))
4378 #endif /* !PERL_IMPLICIT_SYS */
4379 /* This is a really primitive check; environment gets ignored only
4380 * if -T are the first chars together; otherwise one gets
4381 * "Too late" message. */
4382 if ( argc > 1 && argv[1][0] == '-'
4383 && isALPHA_FOLD_EQ(argv[1][1], 't'))
4388 /* Passing the flag as a single char rather than a string is a slight space
4389 optimisation. The only message that isn't /^-.$/ is
4390 "program input from stdin", which is substituted in place of '\0', which
4391 could never be a command line flag. */
4393 S_forbid_setid(pTHX_ const char flag, const bool suidscript) /* g */
4395 char string[3] = "-x";
4396 const char *message = "program input from stdin";
4398 PERL_UNUSED_CONTEXT;
4404 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
4405 if (PerlProc_getuid() != PerlProc_geteuid())
4406 Perl_croak(aTHX_ "No %s allowed while running setuid", message);
4407 if (PerlProc_getgid() != PerlProc_getegid())
4408 Perl_croak(aTHX_ "No %s allowed while running setgid", message);
4409 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4411 Perl_croak(aTHX_ "No %s allowed with (suid) fdscript", message);
4415 Perl_init_dbargs(pTHX)
4417 AV *const args = PL_dbargs = GvAV(gv_AVadd((gv_fetchpvs("DB::args",
4422 /* Someone has already created it.
4423 It might have entries, and if we just turn off AvREAL(), they will
4424 "leak" until global destruction. */
4426 if (SvTIED_mg((const SV *)args, PERL_MAGIC_tied))
4427 Perl_croak(aTHX_ "Cannot set tied @DB::args");
4429 AvREIFY_only(PL_dbargs);
4433 Perl_init_debugger(pTHX)
4435 HV * const ostash = PL_curstash;
4438 PL_curstash = (HV *)SvREFCNT_inc_simple(PL_debstash);
4440 Perl_init_dbargs(aTHX);
4441 PL_DBgv = MUTABLE_GV(
4442 SvREFCNT_inc(gv_fetchpvs("DB::DB", GV_ADDMULTI, SVt_PVGV))
4444 PL_DBline = MUTABLE_GV(
4445 SvREFCNT_inc(gv_fetchpvs("DB::dbline", GV_ADDMULTI, SVt_PVAV))
4447 PL_DBsub = MUTABLE_GV(SvREFCNT_inc(
4448 gv_HVadd(gv_fetchpvs("DB::sub", GV_ADDMULTI, SVt_PVHV))
4450 PL_DBsingle = GvSV((gv_fetchpvs("DB::single", GV_ADDMULTI, SVt_PV)));
4451 if (!SvIOK(PL_DBsingle))
4452 sv_setiv(PL_DBsingle, 0);
4453 mg = sv_magicext(PL_DBsingle, NULL, PERL_MAGIC_debugvar, &PL_vtbl_debugvar, 0, 0);
4454 mg->mg_private = DBVARMG_SINGLE;
4455 SvSETMAGIC(PL_DBsingle);
4457 PL_DBtrace = GvSV((gv_fetchpvs("DB::trace", GV_ADDMULTI, SVt_PV)));
4458 if (!SvIOK(PL_DBtrace))
4459 sv_setiv(PL_DBtrace, 0);
4460 mg = sv_magicext(PL_DBtrace, NULL, PERL_MAGIC_debugvar, &PL_vtbl_debugvar, 0, 0);
4461 mg->mg_private = DBVARMG_TRACE;
4462 SvSETMAGIC(PL_DBtrace);
4464 PL_DBsignal = GvSV((gv_fetchpvs("DB::signal", GV_ADDMULTI, SVt_PV)));
4465 if (!SvIOK(PL_DBsignal))
4466 sv_setiv(PL_DBsignal, 0);
4467 mg = sv_magicext(PL_DBsignal, NULL, PERL_MAGIC_debugvar, &PL_vtbl_debugvar, 0, 0);
4468 mg->mg_private = DBVARMG_SIGNAL;
4469 SvSETMAGIC(PL_DBsignal);
4471 SvREFCNT_dec(PL_curstash);
4472 PL_curstash = ostash;
4475 #ifndef STRESS_REALLOC
4476 #define REASONABLE(size) (size)
4477 #define REASONABLE_but_at_least(size,min) (size)
4479 #define REASONABLE(size) (1) /* unreasonable */
4480 #define REASONABLE_but_at_least(size,min) (min)
4484 Perl_init_stacks(pTHX)
4488 #ifdef PERL_RC_STACK
4489 const UV make_real = 1;
4491 const UV make_real = 0;
4493 /* start with 128-item stack and 8K cxstack */
4494 PL_curstackinfo = new_stackinfo_flags(REASONABLE(128),
4495 REASONABLE(8192/sizeof(PERL_CONTEXT) - 1),
4497 PL_curstackinfo->si_type = PERLSI_MAIN;
4498 #if defined DEBUGGING && !defined DEBUGGING_RE_ONLY
4499 PL_curstackinfo->si_stack_hwm = 0;
4501 PL_curstack = PL_curstackinfo->si_stack;
4502 PL_mainstack = PL_curstack; /* remember in case we switch stacks */
4504 PL_stack_base = AvARRAY(PL_curstack);
4505 PL_stack_sp = PL_stack_base;
4506 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
4508 Newxz(PL_tmps_stack,REASONABLE(128),SV*);
4511 PL_tmps_max = REASONABLE(128);
4513 Newxz(PL_markstack, REASONABLE(32), Stack_off_t);
4514 PL_markstack_ptr = PL_markstack;
4515 PL_markstack_max = PL_markstack + REASONABLE(32);
4519 Newxz(PL_scopestack,REASONABLE(32),I32);
4521 Newxz(PL_scopestack_name,REASONABLE(32),const char*);
4523 PL_scopestack_ix = 0;
4524 PL_scopestack_max = REASONABLE(32);
4526 size = REASONABLE_but_at_least(128,SS_MAXPUSH);
4527 Newxz(PL_savestack, size, ANY);
4528 PL_savestack_ix = 0;
4529 /*PL_savestack_max lies: it always has SS_MAXPUSH more than it claims */
4530 PL_savestack_max = size - SS_MAXPUSH;
4538 while (PL_curstackinfo->si_next)
4539 PL_curstackinfo = PL_curstackinfo->si_next;
4540 while (PL_curstackinfo) {
4541 PERL_SI *p = PL_curstackinfo->si_prev;
4542 /* curstackinfo->si_stack got nuked by sv_free_arenas() */
4543 Safefree(PL_curstackinfo->si_cxstack);
4544 Safefree(PL_curstackinfo);
4545 PL_curstackinfo = p;
4547 Safefree(PL_tmps_stack);
4548 Safefree(PL_markstack);
4549 Safefree(PL_scopestack);
4551 Safefree(PL_scopestack_name);
4553 Safefree(PL_savestack);
4557 Perl_populate_isa(pTHX_ const char *name, STRLEN len, ...)
4559 GV *const gv = gv_fetchpvn(name, len, GV_ADD | GV_ADDMULTI, SVt_PVAV);
4560 AV *const isa = GvAVn(gv);
4563 PERL_ARGS_ASSERT_POPULATE_ISA;
4565 if(AvFILLp(isa) != -1)
4568 /* NOTE: No support for tied ISA */
4570 va_start(args, len);
4572 const char *const parent = va_arg(args, const char*);
4577 parent_len = va_arg(args, size_t);
4579 /* Arguments are supplied with a trailing :: */
4580 assert(parent_len > 2);
4581 assert(parent[parent_len - 1] == ':');
4582 assert(parent[parent_len - 2] == ':');
4583 av_push(isa, newSVpvn(parent, parent_len - 2));
4584 (void) gv_fetchpvn(parent, parent_len, GV_ADD, SVt_PVGV);
4591 S_init_predump_symbols(pTHX)
4596 sv_setpvs(get_sv("\"", GV_ADD), " ");
4597 PL_ofsgv = (GV*)SvREFCNT_inc(gv_fetchpvs(",", GV_ADD|GV_NOTQUAL, SVt_PV));
4600 /* Historically, PVIOs were blessed into IO::Handle, unless
4601 FileHandle was loaded, in which case they were blessed into
4602 that. Action at a distance.
4603 However, if we simply bless into IO::Handle, we break code
4604 that assumes that PVIOs will have (among others) a seek
4605 method. IO::File inherits from IO::Handle and IO::Seekable,
4606 and provides the needed methods. But if we simply bless into
4607 it, then we break code that assumed that by loading
4608 IO::Handle, *it* would work.
4609 So a compromise is to set up the correct @IO::File::ISA,
4610 so that code that does C<use IO::Handle>; will still work.
4613 Perl_populate_isa(aTHX_ STR_WITH_LEN("IO::File::ISA"),
4614 STR_WITH_LEN("IO::Handle::"),
4615 STR_WITH_LEN("IO::Seekable::"),
4616 STR_WITH_LEN("Exporter::"),
4619 PL_stdingv = gv_fetchpvs("STDIN", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4620 GvMULTI_on(PL_stdingv);
4621 io = GvIOp(PL_stdingv);
4622 IoTYPE(io) = IoTYPE_RDONLY;
4623 IoIFP(io) = PerlIO_stdin();
4624 tmpgv = gv_fetchpvs("stdin", GV_ADD|GV_NOTQUAL, SVt_PV);
4626 GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4628 tmpgv = gv_fetchpvs("STDOUT", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4631 IoTYPE(io) = IoTYPE_WRONLY;
4632 IoOFP(io) = IoIFP(io) = PerlIO_stdout();
4634 tmpgv = gv_fetchpvs("stdout", GV_ADD|GV_NOTQUAL, SVt_PV);
4636 GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4638 PL_stderrgv = gv_fetchpvs("STDERR", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4639 GvMULTI_on(PL_stderrgv);
4640 io = GvIOp(PL_stderrgv);
4641 IoTYPE(io) = IoTYPE_WRONLY;
4642 IoOFP(io) = IoIFP(io) = PerlIO_stderr();
4643 tmpgv = gv_fetchpvs("stderr", GV_ADD|GV_NOTQUAL, SVt_PV);
4645 GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4647 PL_statname = newSVpvs(""); /* last filename we did stat on */
4651 Perl_init_argv_symbols(pTHX_ int argc, char **argv)
4653 PERL_ARGS_ASSERT_INIT_ARGV_SYMBOLS;
4655 argc--,argv++; /* skip name of script */
4656 if (PL_doswitches) {
4657 for (; argc > 0 && **argv == '-'; argc--,argv++) {
4661 if (argv[0][1] == '-' && !argv[0][2]) {
4665 if ((s = strchr(argv[0], '='))) {
4666 const char *const start_name = argv[0] + 1;
4667 sv_setpv(GvSV(gv_fetchpvn_flags(start_name, s - start_name,
4668 TRUE, SVt_PV)), s + 1);
4671 sv_setiv(GvSV(gv_fetchpv(argv[0]+1, GV_ADD, SVt_PV)),1);
4674 if ((PL_argvgv = gv_fetchpvs("ARGV", GV_ADD|GV_NOTQUAL, SVt_PVAV))) {
4675 SvREFCNT_inc_simple_void_NN(PL_argvgv);
4676 GvMULTI_on(PL_argvgv);
4677 av_clear(GvAVn(PL_argvgv));
4678 for (; argc > 0; argc--,argv++) {
4679 SV * const sv = newSVpv(argv[0],0);
4680 av_push(GvAV(PL_argvgv),sv);
4681 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
4682 if (PL_unicode & PERL_UNICODE_ARGV_FLAG)
4685 if (PL_unicode & PERL_UNICODE_WIDESYSCALLS_FLAG) /* Sarathy? */
4686 (void)sv_utf8_decode(sv);
4690 if (PL_inplace && (!PL_argvgv || AvFILL(GvAV(PL_argvgv)) == -1))
4691 Perl_ck_warner_d(aTHX_ packWARN(WARN_INPLACE),
4692 "-i used with no filenames on the command line, "
4693 "reading from STDIN");
4697 S_init_postdump_symbols(pTHX_ int argc, char **argv, char **env)
4701 PERL_ARGS_ASSERT_INIT_POSTDUMP_SYMBOLS;
4703 PL_toptarget = newSV_type(SVt_PVIV);
4704 SvPVCLEAR(PL_toptarget);
4705 PL_bodytarget = newSV_type(SVt_PVIV);
4706 SvPVCLEAR(PL_bodytarget);
4707 PL_formtarget = PL_bodytarget;
4711 init_argv_symbols(argc,argv);
4713 if ((tmpgv = gv_fetchpvs("0", GV_ADD|GV_NOTQUAL, SVt_PV))) {
4714 sv_setpv(GvSV(tmpgv),PL_origfilename);
4716 if ((PL_envgv = gv_fetchpvs("ENV", GV_ADD|GV_NOTQUAL, SVt_PVHV))) {
4718 bool env_is_not_environ;
4719 SvREFCNT_inc_simple_void_NN(PL_envgv);
4720 GvMULTI_on(PL_envgv);
4721 hv = GvHVn(PL_envgv);
4722 hv_magic(hv, NULL, PERL_MAGIC_env);
4723 #if defined(USE_ENVIRON_ARRAY) || defined(WIN32)
4724 /* Note that if the supplied env parameter is actually a copy
4725 of the global environ then it may now point to free'd memory
4726 if the environment has been modified since. To avoid this
4727 problem we treat env==NULL as meaning 'use the default'
4731 env_is_not_environ = env != environ;
4732 if (env_is_not_environ
4733 # ifdef USE_ITHREADS
4734 && PL_curinterp == aTHX
4742 char **env_copy = env;
4749 count = env_copy - env;
4751 if (count > PERL_HASH_DEFAULT_HvMAX) {
4752 /* This might be an over-estimate (due to dups and other skips),
4753 * but if so, likely it won't hurt much.
4754 * A straw poll of login environments I have suggests that
4755 * between 23 and 52 environment variables are typical (and no
4756 * dups). As the default hash size is 8 buckets, expanding in
4757 * advance saves between 2 and 3 splits in the loop below. */
4758 hv_ksplit(hv, count);
4762 for (; *env; env++) {
4763 char *old_var = *env;
4764 char *s = strchr(old_var, '=');
4768 if (!s || s == old_var)
4773 /* It's tempting to think that this hv_exists/hv_store pair should
4774 * be replaced with a single hv_fetch with the LVALUE flag true.
4775 * However, hv has magic, and if you follow the code in hv_common
4776 * then for LVALUE fetch it recurses once, whereas exists and
4777 * store do not recurse. Hence internally there would be no
4778 * difference in the complexity of the code run. Moreover, all
4779 * calls pass through "is there magic?" special case code, which
4780 * in turn has its own #ifdef ENV_IS_CASELESS special case special
4781 * case. Hence this code shouldn't change, as doing so won't give
4782 * any meaningful speedup, and might well add bugs. */
4784 if (hv_exists(hv, old_var, nlen)) {
4786 const char *name = savepvn(old_var, nlen);
4788 /* make sure we use the same value as getenv(), otherwise code that
4789 uses getenv() (like setlocale()) might see a different value to %ENV
4791 sv = newSVpv(PerlEnv_getenv(name), 0);
4793 /* keep a count of the dups of this name so we can de-dup environ later */
4794 dup = hv_fetch(dups, name, nlen, TRUE);
4802 sv = newSVpv(s+1, 0);
4804 (void)hv_store(hv, old_var, nlen, sv, 0);
4805 if (env_is_not_environ)
4808 if (HvTOTALKEYS(dups)) {
4809 /* environ has some duplicate definitions, remove them */
4812 while ((entry = hv_iternext_flags(dups, 0))) {
4814 const char *name = HePV(entry, nlen);
4815 IV count = SvIV(HeVAL(entry));
4817 SV **valp = hv_fetch(hv, name, nlen, 0);
4821 /* try to remove any duplicate names, depending on the
4822 * implementation used in my_setenv() the iteration might
4823 * not be necessary, but let's be safe.
4825 for (i = 0; i < count; ++i)
4828 /* and set it back to the value we set $ENV{name} to */
4829 my_setenv(name, SvPV_nolen(*valp));
4832 SvREFCNT_dec_NN(dups);
4834 #endif /* USE_ENVIRON_ARRAY */
4838 /* touch @F array to prevent spurious warnings 20020415 MJD */
4840 (void) get_av("main::F", GV_ADD | GV_ADDMULTI);
4845 S_init_perllib(pTHX)
4848 const char *perl5lib = NULL;
4851 #if defined(WIN32) && !defined(PERL_IS_MINIPERL)
4855 if (!TAINTING_get) {
4857 perl5lib = PerlEnv_getenv("PERL5LIB");
4858 if (perl5lib && *perl5lib != '\0')
4859 incpush_use_sep(perl5lib, 0, INCPUSH_ADD_SUB_DIRS);
4861 s = PerlEnv_getenv("PERLLIB");
4863 incpush_use_sep(s, 0, 0);
4866 /* Treat PERL5?LIB as a possible search list logical name -- the
4867 * "natural" VMS idiom for a Unix path string. We allow each
4868 * element to be a set of |-separated directories for compatibility.
4872 if (vmstrnenv("PERL5LIB",buf,0,NULL,0))
4874 incpush_use_sep(buf, 0, INCPUSH_ADD_SUB_DIRS);
4875 } while (vmstrnenv("PERL5LIB",buf,++idx,NULL,0));
4877 while (vmstrnenv("PERLLIB",buf,idx++,NULL,0))
4878 incpush_use_sep(buf, 0, 0);
4883 #ifndef PERL_IS_MINIPERL
4884 /* miniperl gets just -I..., the split of $ENV{PERL5LIB}, and "." in @INC
4885 (and not the architecture specific directories from $ENV{PERL5LIB}) */
4887 #include "perl_inc_macro.h"
4888 /* Use the ~-expanded versions of APPLLIB (undocumented),
4889 SITEARCH, SITELIB, VENDORARCH, VENDORLIB, ARCHLIB and PRIVLIB
4892 INCPUSH_SITEARCH_EXP
4894 INCPUSH_PERL_VENDORARCH_EXP
4895 INCPUSH_PERL_VENDORLIB_EXP
4898 INCPUSH_PERL_OTHERLIBDIRS
4900 INCPUSH_APPLLIB_OLD_EXP
4901 INCPUSH_SITELIB_STEM
4902 INCPUSH_PERL_VENDORLIB_STEM
4903 INCPUSH_PERL_OTHERLIBDIRS_ARCHONLY
4905 #endif /* !PERL_IS_MINIPERL */
4907 if (!TAINTING_get) {
4908 #if !defined(PERL_IS_MINIPERL) && defined(DEFAULT_INC_EXCLUDES_DOT)
4909 const char * const unsafe = PerlEnv_getenv("PERL_USE_UNSAFE_INC");
4910 if (unsafe && strEQ(unsafe, "1"))
4912 S_incpush(aTHX_ STR_WITH_LEN("."), 0);
4917 # define PERLLIB_SEP ';'
4918 #elif defined(__VMS)
4919 # define PERLLIB_SEP PL_perllib_sep
4921 # define PERLLIB_SEP ':'
4923 #ifndef PERLLIB_MANGLE
4924 # define PERLLIB_MANGLE(s,n) (s)
4927 #ifndef PERL_IS_MINIPERL
4928 /* Push a directory onto @INC if it exists.
4929 Generate a new SV if we do this, to save needing to copy the SV we push
4932 S_incpush_if_exists(pTHX_ AV *const av, SV *dir, SV *const stem)
4936 PERL_ARGS_ASSERT_INCPUSH_IF_EXISTS;
4938 if (PerlLIO_stat(SvPVX_const(dir), &tmpstatbuf) >= 0 &&
4939 S_ISDIR(tmpstatbuf.st_mode)) {
4941 dir = newSVsv(stem);
4943 /* Truncate dir back to stem. */
4944 SvCUR_set(dir, SvCUR(stem));
4951 S_mayberelocate(pTHX_ const char *const dir, STRLEN len, U32 flags)
4953 const U8 canrelocate = (U8)flags & INCPUSH_CAN_RELOCATE;
4956 PERL_ARGS_ASSERT_MAYBERELOCATE;
4959 /* I am not convinced that this is valid when PERLLIB_MANGLE is
4960 defined to so something (in os2/os2.c), but the code has been
4961 this way, ignoring any possible changed of length, since
4962 760ac839baf413929cd31cc32ffd6dba6b781a81 (5.003_02) so I'll leave
4964 libdir = newSVpvn(PERLLIB_MANGLE(dir, len), len);
4970 if ((unix = tounixspec_ts(SvPV(libdir,len),NULL)) != NULL) {
4972 while (len > 1 && unix[len-1] == '/') len--; /* Cosmetic */
4973 sv_usepvn(libdir,unix,len);
4976 PerlIO_printf(Perl_error_log,
4977 "Failed to unixify @INC element \"%s\"\n",
4978 SvPV_nolen_const(libdir));
4982 /* Do the if() outside the #ifdef to avoid warnings about an unused
4985 #ifdef PERL_RELOCATABLE_INC
4987 * Relocatable include entries are marked with a leading .../
4990 * 0: Remove that leading ".../"
4991 * 1: Remove trailing executable name (anything after the last '/')
4992 * from the perl path to give a perl prefix
4994 * While the @INC element starts "../" and the prefix ends with a real
4995 * directory (ie not . or ..) chop that real directory off the prefix
4996 * and the leading "../" from the @INC element. ie a logical "../"
4998 * Finally concatenate the prefix and the remainder of the @INC element
4999 * The intent is that /usr/local/bin/perl and .../../lib/perl5
5000 * generates /usr/local/lib/perl5
5002 const char *libpath = SvPVX(libdir);
5003 STRLEN libpath_len = SvCUR(libdir);
5004 if (memBEGINs(libpath, libpath_len, ".../")) {
5006 SV * const caret_X = get_sv("\030", 0);
5007 /* Going to use the SV just as a scratch buffer holding a C
5013 /* $^X is *the* source of taint if tainting is on, hence
5014 SvPOK() won't be true. */
5016 assert(SvPOKp(caret_X));
5017 prefix_sv = newSVpvn_flags(SvPVX(caret_X), SvCUR(caret_X),
5019 /* Firstly take off the leading .../
5020 If all else fail we'll do the paths relative to the current
5022 sv_chop(libdir, libpath + 4);
5023 /* Don't use SvPV as we're intentionally bypassing taining,
5024 mortal copies that the mg_get of tainting creates, and
5025 corruption that seems to come via the save stack.
5026 I guess that the save stack isn't correctly set up yet. */
5027 libpath = SvPVX(libdir);
5028 libpath_len = SvCUR(libdir);
5030 prefix = SvPVX(prefix_sv);
5031 lastslash = (char *) my_memrchr(prefix, '/',
5032 SvEND(prefix_sv) - prefix);
5034 /* First time in with the *lastslash = '\0' we just wipe off
5035 the trailing /perl from (say) /usr/foo/bin/perl
5039 while ((*lastslash = '\0'), /* Do that, come what may. */
5040 ( memBEGINs(libpath, libpath_len, "../")
5042 (char *) my_memrchr(prefix, '/',
5043 SvEND(prefix_sv) - prefix))))
5045 if (lastslash[1] == '\0'
5046 || (lastslash[1] == '.'
5047 && (lastslash[2] == '/' /* ends "/." */
5048 || (lastslash[2] == '/'
5049 && lastslash[3] == '/' /* or "/.." */
5051 /* Prefix ends "/" or "/." or "/..", any of which
5052 are fishy, so don't do any more logical cleanup.
5056 /* Remove leading "../" from path */
5059 /* Next iteration round the loop removes the last
5060 directory name from prefix by writing a '\0' in
5061 the while clause. */
5063 /* prefix has been terminated with a '\0' to the correct
5064 length. libpath points somewhere into the libdir SV.
5065 We need to join the 2 with '/' and drop the result into
5067 tempsv = Perl_newSVpvf(aTHX_ "%s/%s", prefix, libpath);
5068 SvREFCNT_dec(libdir);
5069 /* And this is the new libdir. */
5072 (PerlProc_getuid() != PerlProc_geteuid() ||
5073 PerlProc_getgid() != PerlProc_getegid())) {
5074 /* Need to taint relocated paths if running set ID */
5075 SvTAINTED_on(libdir);
5078 SvREFCNT_dec(prefix_sv);
5086 S_incpush(pTHX_ const char *const dir, STRLEN len, U32 flags)
5088 #ifndef PERL_IS_MINIPERL
5089 const U8 using_sub_dirs
5090 = (U8)flags & (INCPUSH_ADD_VERSIONED_SUB_DIRS
5091 |INCPUSH_ADD_ARCHONLY_SUB_DIRS|INCPUSH_ADD_OLD_VERS);
5092 const U8 add_versioned_sub_dirs
5093 = (U8)flags & INCPUSH_ADD_VERSIONED_SUB_DIRS;
5094 const U8 add_archonly_sub_dirs
5095 = (U8)flags & INCPUSH_ADD_ARCHONLY_SUB_DIRS;
5096 #ifdef PERL_INC_VERSION_LIST
5097 const U8 addoldvers = (U8)flags & INCPUSH_ADD_OLD_VERS;
5100 const U8 unshift = (U8)flags & INCPUSH_UNSHIFT;
5101 const U8 push_basedir = (flags & INCPUSH_NOT_BASEDIR) ? 0 : 1;
5102 AV *const inc = GvAVn(PL_incgv);
5104 PERL_ARGS_ASSERT_INCPUSH;
5107 /* Could remove this vestigial extra block, if we don't mind a lot of
5108 re-indenting diff noise. */
5110 SV *const libdir = mayberelocate(dir, len, flags);
5111 /* Change 20189146be79a0596543441fa369c6bf7f85103f, to fix RT#6665,
5112 arranged to unshift #! line -I onto the front of @INC. However,
5113 -I can add version and architecture specific libraries, and they
5114 need to go first. The old code assumed that it was always
5115 pushing. Hence to make it work, need to push the architecture
5116 (etc) libraries onto a temporary array, then "unshift" that onto
5117 the front of @INC. */
5118 #ifndef PERL_IS_MINIPERL
5119 AV *const av = (using_sub_dirs) ? (unshift ? newAV() : inc) : NULL;
5122 * BEFORE pushing libdir onto @INC we may first push version- and
5123 * archname-specific sub-directories.
5125 if (using_sub_dirs) {
5126 SV *subdir = newSVsv(libdir);
5127 #ifdef PERL_INC_VERSION_LIST
5128 /* Configure terminates PERL_INC_VERSION_LIST with a NULL */
5129 const char * const incverlist[] = { PERL_INC_VERSION_LIST };
5130 const char * const *incver;
5133 if (add_versioned_sub_dirs) {
5134 /* .../version/archname if -d .../version/archname */
5135 sv_catpvs(subdir, "/" PERL_FS_VERSION "/" ARCHNAME);
5136 subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
5138 /* .../version if -d .../version */
5139 sv_catpvs(subdir, "/" PERL_FS_VERSION);
5140 subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
5143 #ifdef PERL_INC_VERSION_LIST
5145 for (incver = incverlist; *incver; incver++) {
5146 /* .../xxx if -d .../xxx */
5147 Perl_sv_catpvf(aTHX_ subdir, "/%s", *incver);
5148 subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
5153 if (add_archonly_sub_dirs) {
5154 /* .../archname if -d .../archname */
5155 sv_catpvs(subdir, "/" ARCHNAME);
5156 subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
5160 assert (SvREFCNT(subdir) == 1);
5161 SvREFCNT_dec(subdir);
5163 #endif /* !PERL_IS_MINIPERL */
5164 /* finally add this lib directory at the end of @INC */
5166 #ifdef PERL_IS_MINIPERL
5167 const Size_t extra = 0;
5169 Size_t extra = av_count(av);
5171 av_unshift(inc, extra + push_basedir);
5173 av_store(inc, extra, libdir);
5174 #ifndef PERL_IS_MINIPERL
5176 /* av owns a reference, av_store() expects to be donated a
5177 reference, and av expects to be sane when it's cleared.
5178 If I wanted to be naughty and wrong, I could peek inside the
5179 implementation of av_clear(), realise that it uses
5180 SvREFCNT_dec() too, so av's array could be a run of NULLs,
5181 and so directly steal from it (with a memcpy() to inc, and
5182 then memset() to NULL them out. But people copy code from the
5183 core expecting it to be best practise, so let's use the API.
5184 Although studious readers will note that I'm not checking any
5186 av_store(inc, extra, SvREFCNT_inc(*av_fetch(av, extra, FALSE)));
5191 else if (push_basedir) {
5192 av_push(inc, libdir);
5195 if (!push_basedir) {
5196 assert (SvREFCNT(libdir) == 1);
5197 SvREFCNT_dec(libdir);
5203 S_incpush_use_sep(pTHX_ const char *p, STRLEN len, U32 flags)
5207 /* This logic has been broken out from S_incpush(). It may be possible to
5210 PERL_ARGS_ASSERT_INCPUSH_USE_SEP;
5212 /* perl compiled with -DPERL_RELOCATABLE_INCPUSH will ignore the len
5213 * argument to incpush_use_sep. This allows creation of relocatable
5214 * Perl distributions that patch the binary at install time. Those
5215 * distributions will have to provide their own relocation tools; this
5216 * is not a feature otherwise supported by core Perl.
5218 #ifndef PERL_RELOCATABLE_INCPUSH
5225 /* Break at all separators */
5226 while ((s = (const char*)memchr(p, PERLLIB_SEP, end - p))) {
5228 /* skip any consecutive separators */
5230 /* Uncomment the next line for PATH semantics */
5231 /* But you'll need to write tests */
5232 /* av_push(GvAVn(PL_incgv), newSVpvs(".")); */
5234 incpush(p, (STRLEN)(s - p), flags);
5239 incpush(p, (STRLEN)(end - p), flags);
5244 Perl_call_list(pTHX_ I32 oldscope, AV *paramList)
5247 volatile const line_t oldline = PL_curcop ? CopLINE(PL_curcop) : 0;
5253 PERL_ARGS_ASSERT_CALL_LIST;
5255 while (av_count(paramList) > 0) {
5256 cv = MUTABLE_CV(av_shift(paramList));
5258 if (paramList == PL_beginav) {
5259 /* save PL_beginav for compiler */
5260 Perl_av_create_and_push(aTHX_ &PL_beginav_save, MUTABLE_SV(cv));
5262 else if (paramList == PL_checkav) {
5263 /* save PL_checkav for compiler */
5264 Perl_av_create_and_push(aTHX_ &PL_checkav_save, MUTABLE_SV(cv));
5266 else if (paramList == PL_unitcheckav) {
5267 /* save PL_unitcheckav for compiler */
5268 Perl_av_create_and_push(aTHX_ &PL_unitcheckav_save, MUTABLE_SV(cv));
5278 (void)SvPV_const(atsv, len);
5280 PL_curcop = &PL_compiling;
5281 CopLINE_set(PL_curcop, oldline);
5282 if (paramList == PL_beginav)
5283 sv_catpvs(atsv, "BEGIN failed--compilation aborted");
5285 Perl_sv_catpvf(aTHX_ atsv,
5286 "%s failed--call queue aborted",
5287 paramList == PL_checkav ? "CHECK"
5288 : paramList == PL_initav ? "INIT"
5289 : paramList == PL_unitcheckav ? "UNITCHECK"
5291 while (PL_scopestack_ix > oldscope)
5294 Perl_croak(aTHX_ "%" SVf, SVfARG(atsv));
5301 /* my_exit() was called */
5302 while (PL_scopestack_ix > oldscope)
5305 SET_CURSTASH(PL_defstash);
5306 PL_curcop = &PL_compiling;
5307 CopLINE_set(PL_curcop, oldline);
5310 NOT_REACHED; /* NOTREACHED */
5313 PL_curcop = &PL_compiling;
5314 CopLINE_set(PL_curcop, oldline);
5317 PerlIO_printf(Perl_error_log, "panic: restartop in call_list\n");
5328 A wrapper for the C library L<exit(3)>, honoring what L<perlapi/PL_exit_flags>
5335 Perl_my_exit(pTHX_ U32 status)
5337 if (PL_exit_flags & PERL_EXIT_ABORT) {
5340 if (PL_exit_flags & PERL_EXIT_WARN) {
5341 PL_exit_flags |= PERL_EXIT_ABORT; /* Protect against reentrant calls */
5342 Perl_warn(aTHX_ "Unexpected exit %lu", (unsigned long)status);
5343 PL_exit_flags &= ~PERL_EXIT_ABORT;
5353 STATUS_EXIT_SET(status);
5360 =for apidoc my_failure_exit
5362 Exit the running Perl process with an error.
5364 On non-VMS platforms, this is essentially equivalent to L</C<my_exit>>, using
5365 C<errno>, but forces an en error code of 255 if C<errno> is 0.
5367 On VMS, it takes care to set the appropriate severity bits in the exit status.
5373 Perl_my_failure_exit(pTHX)
5376 /* We have been called to fall on our sword. The desired exit code
5377 * should be already set in STATUS_UNIX, but could be shifted over
5378 * by 8 bits. STATUS_UNIX_EXIT_SET will handle the cases where a
5381 * If an error code has not been set, then force the issue.
5383 if (MY_POSIX_EXIT) {
5385 /* According to the die_exit.t tests, if errno is non-zero */
5386 /* It should be used for the error status. */
5388 if (errno == EVMSERR) {
5389 STATUS_NATIVE = vaxc$errno;
5392 /* According to die_exit.t tests, if the child_exit code is */
5393 /* also zero, then we need to exit with a code of 255 */
5394 if ((errno != 0) && (errno < 256))
5395 STATUS_UNIX_EXIT_SET(errno);
5396 else if (STATUS_UNIX < 255) {
5397 STATUS_UNIX_EXIT_SET(255);
5402 /* The exit code could have been set by $? or vmsish which
5403 * means that it may not have fatal set. So convert
5404 * success/warning codes to fatal with out changing
5405 * the POSIX status code. The severity makes VMS native
5406 * status handling work, while UNIX mode programs use the
5409 if ((STATUS_NATIVE & (STS$K_SEVERE|STS$K_ERROR)) == 0) {
5410 STATUS_NATIVE &= STS$M_COND_ID;
5411 STATUS_NATIVE |= STS$K_ERROR | STS$M_INHIB_MSG;
5415 /* Traditionally Perl on VMS always expects a Fatal Error. */
5416 if (vaxc$errno & 1) {
5418 /* So force success status to failure */
5419 if (STATUS_NATIVE & 1)
5424 STATUS_UNIX = EINTR; /* In case something cares */
5429 STATUS_NATIVE = vaxc$errno; /* Should already be this */
5431 /* Encode the severity code */
5432 severity = STATUS_NATIVE & STS$M_SEVERITY;
5433 STATUS_UNIX = (severity ? severity : 1) << 8;
5435 /* Perl expects this to be a fatal error */
5436 if (severity != STS$K_SEVERE)
5446 STATUS_UNIX_SET(eno);
5448 exitstatus = STATUS_UNIX >> 8;
5449 if (exitstatus & 255)
5450 STATUS_UNIX_SET(exitstatus);
5452 STATUS_UNIX_SET(255);
5455 if (PL_exit_flags & PERL_EXIT_ABORT) {
5458 if (PL_exit_flags & PERL_EXIT_WARN) {
5459 PL_exit_flags |= PERL_EXIT_ABORT; /* Protect against reentrant calls */
5460 Perl_warn(aTHX_ "Unexpected exit failure %ld", (long)PL_statusvalue);
5461 PL_exit_flags &= ~PERL_EXIT_ABORT;
5467 S_my_exit_jump(pTHX)
5470 SvREFCNT_dec(PL_e_script);
5474 POPSTACK_TO(PL_mainstack);
5475 if (cxstack_ix >= 0) {
5478 rpp_obliterate_stack_to(0);
5485 read_e_script(pTHX_ int idx, SV *buf_sv, int maxlen)
5487 const char * const p = SvPVX_const(PL_e_script);
5488 const char * const e = SvEND(PL_e_script);
5489 const char *nl = (char *) memchr(p, '\n', e - p);
5491 PERL_UNUSED_ARG(idx);
5492 PERL_UNUSED_ARG(maxlen);
5494 nl = (nl) ? nl+1 : e;
5496 filter_del(read_e_script);
5499 sv_catpvn(buf_sv, p, nl-p);
5500 sv_chop(PL_e_script, nl);
5504 /* removes boilerplate code at the end of each boot_Module xsub */
5506 Perl_xs_boot_epilog(pTHX_ const SSize_t ax)
5509 call_list(PL_scopestack_ix, PL_unitcheckav);
5514 * ex: set ts=8 sts=4 sw=4 et: