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 by Larry Wall
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 */
46 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
53 char control[CMSG_SPACE(sizeof(int))];
66 static I32 read_e_script(pTHX_ int idx, SV *buf_sv, int maxlen);
68 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
69 # define validate_suid(rsfp) NOOP
71 # define validate_suid(rsfp) S_validate_suid(aTHX_ rsfp)
74 #define CALL_BODY_SUB(myop) \
75 if (PL_op == (myop)) \
76 PL_op = PL_ppaddr[OP_ENTERSUB](aTHX); \
80 #define CALL_LIST_BODY(cv) \
81 PUSHMARK(PL_stack_sp); \
82 call_sv(MUTABLE_SV((cv)), G_EVAL|G_DISCARD|G_VOID);
85 S_init_tls_and_interp(PerlInterpreter *my_perl)
88 PERL_SET_INTERP(my_perl);
89 #if defined(USE_ITHREADS)
92 PERL_SET_THX(my_perl);
95 KEYWORD_PLUGIN_MUTEX_INIT;
100 MUTEX_INIT(&PL_dollarzero_mutex);
101 MUTEX_INIT(&PL_my_ctx_mutex);
104 #if defined(USE_ITHREADS)
107 /* This always happens for non-ithreads */
110 PERL_SET_THX(my_perl);
115 /* these implement the PERL_SYS_INIT, PERL_SYS_INIT3, PERL_SYS_TERM macros */
118 Perl_sys_init(int* argc, char*** argv)
121 PERL_ARGS_ASSERT_SYS_INIT;
123 PERL_UNUSED_ARG(argc); /* may not be used depending on _BODY macro */
124 PERL_UNUSED_ARG(argv);
125 PERL_SYS_INIT_BODY(argc, argv);
129 Perl_sys_init3(int* argc, char*** argv, char*** env)
132 PERL_ARGS_ASSERT_SYS_INIT3;
134 PERL_UNUSED_ARG(argc); /* may not be used depending on _BODY macro */
135 PERL_UNUSED_ARG(argv);
136 PERL_UNUSED_ARG(env);
137 PERL_SYS_INIT3_BODY(argc, argv, env);
143 if (!PL_veto_cleanup) {
144 PERL_SYS_TERM_BODY();
149 #ifdef PERL_IMPLICIT_SYS
151 perl_alloc_using(struct IPerlMem* ipM, struct IPerlMem* ipMS,
152 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
153 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
154 struct IPerlDir* ipD, struct IPerlSock* ipS,
155 struct IPerlProc* ipP)
157 PerlInterpreter *my_perl;
159 PERL_ARGS_ASSERT_PERL_ALLOC_USING;
161 /* Newx() needs interpreter, so call malloc() instead */
162 my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
163 S_init_tls_and_interp(my_perl);
164 Zero(my_perl, 1, PerlInterpreter);
174 INIT_TRACK_MEMPOOL(PL_memory_debug_header, my_perl);
181 =for apidoc_section $embedding
183 =for apidoc perl_alloc
185 Allocates a new Perl interpreter. See L<perlembed>.
193 PerlInterpreter *my_perl;
195 /* Newx() needs interpreter, so call malloc() instead */
196 my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
198 S_init_tls_and_interp(my_perl);
199 #ifndef PERL_TRACK_MEMPOOL
200 return (PerlInterpreter *) ZeroD(my_perl, 1, PerlInterpreter);
202 Zero(my_perl, 1, PerlInterpreter);
203 INIT_TRACK_MEMPOOL(PL_memory_debug_header, my_perl);
207 #endif /* PERL_IMPLICIT_SYS */
210 =for apidoc perl_construct
212 Initializes a new Perl interpreter. See L<perlembed>.
218 perl_construct(pTHXx)
221 PERL_ARGS_ASSERT_PERL_CONSTRUCT;
225 PL_perl_destruct_level = 1;
227 PERL_UNUSED_ARG(my_perl);
228 if (PL_perl_destruct_level > 0)
231 PL_curcop = &PL_compiling; /* needed by ckWARN, right away */
233 #ifdef PERL_TRACE_OPS
234 Zero(PL_op_exec_cnt, OP_max+2, UV);
239 SvREADONLY_on(&PL_sv_placeholder);
240 SvREFCNT(&PL_sv_placeholder) = SvREFCNT_IMMORTAL;
242 PL_sighandlerp = Perl_sighandler;
243 PL_sighandler1p = Perl_sighandler1;
244 PL_sighandler3p = Perl_sighandler3;
246 #ifdef PERL_USES_PL_PIDSTATUS
247 PL_pidstatus = newHV();
250 PL_rs = newSVpvs("\n");
254 /* The PERL_INTERNAL_RAND_SEED set-up must be after init_stacks because it calls
255 * things that may put SVs on the stack.
258 #ifdef NO_PERL_INTERNAL_RAND_SEED
259 Perl_drand48_init_r(&PL_internal_random_state, seed());
264 if (PerlProc_getuid() != PerlProc_geteuid() ||
265 PerlProc_getgid() != PerlProc_getegid() ||
266 !(env_pv = PerlEnv_getenv("PERL_INTERNAL_RAND_SEED")) ||
267 grok_number(env_pv, strlen(env_pv), &seed) != IS_NUMBER_IN_UV) {
270 Perl_drand48_init_r(&PL_internal_random_state, (U32)seed);
280 (void) uvchr_to_utf8_flags((U8 *) PL_TR_SPECIAL_HANDLING_UTF8,
282 UNICODE_ALLOW_ABOVE_IV_MAX);
284 #if defined(LOCAL_PATCH_COUNT)
285 PL_localpatches = local_patches; /* For possible -v */
288 #if defined(LIBM_LIB_VERSION)
290 * Some BSDs and Cygwin default to POSIX math instead of IEEE.
291 * This switches them over to IEEE.
293 _LIB_VERSION = _IEEE_;
296 #ifdef HAVE_INTERP_INTERN
300 PerlIO_init(aTHX); /* Hook to IO system */
302 PL_fdpid = newAV(); /* for remembering popen pids by fd */
303 PL_modglobal = newHV(); /* pointers to per-interpreter module globals */
304 PL_errors = newSVpvs("");
305 SvPVCLEAR(PERL_DEBUG_PAD(0)); /* For regex debugging. */
306 SvPVCLEAR(PERL_DEBUG_PAD(1)); /* ext/re needs these */
307 SvPVCLEAR(PERL_DEBUG_PAD(2)); /* even without DEBUGGING. */
309 /* First entry is a list of empty elements. It needs to be initialised
310 else all hell breaks loose in S_find_uninit_var(). */
311 Perl_av_create_and_push(aTHX_ &PL_regex_padav, newSVpvs(""));
312 PL_regex_pad = AvARRAY(PL_regex_padav);
313 Newxz(PL_stashpad, PL_stashpadmax, HV *);
315 #ifdef USE_REENTRANT_API
316 Perl_reentrant_init(aTHX);
318 if (PL_hash_seed_set == FALSE) {
319 /* Initialize the hash seed and state at startup. This must be
320 * done very early, before ANY hashes are constructed, and once
321 * setup is fixed for the lifetime of the process.
323 * If you decide to disable the seeding process you should choose
324 * a suitable seed yourself and define PERL_HASH_SEED to a well chosen
325 * string. See hv_func.h for details.
327 #if defined(USE_HASH_SEED)
328 /* get the hash seed from the environment or from an RNG */
329 Perl_get_hash_seed(aTHX_ PL_hash_seed);
331 /* they want a hard coded seed, check that it is long enough */
332 assert( strlen(PERL_HASH_SEED) >= PERL_HASH_SEED_BYTES );
335 /* now we use the chosen seed to initialize the state -
336 * in some configurations this may be a relatively speaking
337 * expensive operation, but we only have to do it once at startup */
338 PERL_HASH_SEED_STATE(PERL_HASH_SEED,PL_hash_state);
340 #ifdef PERL_USE_SINGLE_CHAR_HASH_CACHE
341 /* we can build a special cache for 0/1 byte keys, if people choose
342 * I suspect most of the time it is not worth it */
346 for (i=0;i<256;i++) {
348 PERL_HASH_WITH_STATE(PL_hash_state,PL_hash_chars[i],str,1);
350 PERL_HASH_WITH_STATE(PL_hash_state,PL_hash_chars[256],str,0);
353 /* at this point we have initialezed the hash function, and we can start
354 * constructing hashes */
355 PL_hash_seed_set= TRUE;
358 /* Allow PL_strtab to be pre-initialized before calling perl_construct.
359 * can use a custom optimized PL_strtab hash before calling perl_construct */
361 /* Note that strtab is a rather special HV. Assumptions are made
362 about not iterating on it, and not adding tie magic to it.
363 It is properly deallocated in perl_destruct() */
366 /* SHAREKEYS tells us that the hash has its keys shared with PL_strtab,
367 * which is not the case with PL_strtab itself */
368 HvSHAREKEYS_off(PL_strtab); /* mandatory */
369 hv_ksplit(PL_strtab, 1 << 11);
372 Zero(PL_sv_consts, SV_CONSTS_COUNT, SV*);
375 # ifdef USE_ENVIRON_ARRAY
376 PL_origenviron = environ;
380 /* Use sysconf(_SC_CLK_TCK) if available, if not
381 * available or if the sysconf() fails, use the HZ.
382 * The HZ if not originally defined has been by now
383 * been defined as CLK_TCK, if available. */
384 #if defined(HAS_SYSCONF) && defined(_SC_CLK_TCK)
385 PL_clocktick = sysconf(_SC_CLK_TCK);
386 if (PL_clocktick <= 0)
390 PL_stashcache = newHV();
392 PL_patchlevel = newSVpvs("v" PERL_VERSION_STRING);
395 if (!PL_mmap_page_size) {
396 #if defined(HAS_SYSCONF) && (defined(_SC_PAGESIZE) || defined(_SC_MMAP_PAGE_SIZE))
398 SETERRNO(0, SS_NORMAL);
400 PL_mmap_page_size = sysconf(_SC_PAGESIZE);
402 PL_mmap_page_size = sysconf(_SC_MMAP_PAGE_SIZE);
404 if ((long) PL_mmap_page_size < 0) {
405 Perl_croak(aTHX_ "panic: sysconf: %s",
406 errno ? Strerror(errno) : "pagesize unknown");
409 #elif defined(HAS_GETPAGESIZE)
410 PL_mmap_page_size = getpagesize();
411 #elif defined(I_SYS_PARAM) && defined(PAGESIZE)
412 PL_mmap_page_size = PAGESIZE; /* compiletime, bad */
414 if (PL_mmap_page_size <= 0)
415 Perl_croak(aTHX_ "panic: bad pagesize %" IVdf,
416 (IV) PL_mmap_page_size);
418 #endif /* HAS_MMAP */
420 PL_osname = Perl_savepvn(aTHX_ STR_WITH_LEN(OSNAME));
422 PL_registered_mros = newHV();
423 /* Start with 1 bucket, for DFS. It's unlikely we'll need more. */
424 HvMAX(PL_registered_mros) = 0;
426 #ifdef USE_POSIX_2008_LOCALE
427 PL_C_locale_obj = newlocale(LC_ALL_MASK, "C", NULL);
435 =for apidoc nothreadhook
437 Stub that provides thread hook for perl_destruct when there are
444 Perl_nothreadhook(pTHX)
450 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
452 Perl_dump_sv_child(pTHX_ SV *sv)
455 const int sock = PL_dumper_fd;
456 const int debug_fd = PerlIO_fileno(Perl_debug_log);
457 union control_un control;
460 struct cmsghdr *cmptr;
462 unsigned char buffer[256];
464 PERL_ARGS_ASSERT_DUMP_SV_CHILD;
466 if(sock == -1 || debug_fd == -1)
469 PerlIO_flush(Perl_debug_log);
471 /* All these shenanigans are to pass a file descriptor over to our child for
472 it to dump out to. We can't let it hold open the file descriptor when it
473 forks, as the file descriptor it will dump to can turn out to be one end
474 of pipe that some other process will wait on for EOF. (So as it would
475 be open, the wait would be forever.) */
477 msg.msg_control = control.control;
478 msg.msg_controllen = sizeof(control.control);
479 /* We're a connected socket so we don't need a destination */
485 cmptr = CMSG_FIRSTHDR(&msg);
486 cmptr->cmsg_len = CMSG_LEN(sizeof(int));
487 cmptr->cmsg_level = SOL_SOCKET;
488 cmptr->cmsg_type = SCM_RIGHTS;
489 *((int *)CMSG_DATA(cmptr)) = 1;
491 vec[0].iov_base = (void*)&sv;
492 vec[0].iov_len = sizeof(sv);
493 got = sendmsg(sock, &msg, 0);
496 perror("Debug leaking scalars parent sendmsg failed");
499 if(got < sizeof(sv)) {
500 perror("Debug leaking scalars parent short sendmsg");
504 /* Return protocol is
506 unsigned char: length of location string (0 for empty)
507 unsigned char*: string (not terminated)
509 vec[0].iov_base = (void*)&returned_errno;
510 vec[0].iov_len = sizeof(returned_errno);
511 vec[1].iov_base = buffer;
514 got = readv(sock, vec, 2);
517 perror("Debug leaking scalars parent read failed");
518 PerlIO_flush(PerlIO_stderr());
521 if(got < sizeof(returned_errno) + 1) {
522 perror("Debug leaking scalars parent short read");
523 PerlIO_flush(PerlIO_stderr());
528 got = read(sock, buffer + 1, *buffer);
530 perror("Debug leaking scalars parent read 2 failed");
531 PerlIO_flush(PerlIO_stderr());
536 perror("Debug leaking scalars parent short read 2");
537 PerlIO_flush(PerlIO_stderr());
542 if (returned_errno || *buffer) {
543 Perl_warn(aTHX_ "Debug leaking scalars child failed%s%.*s with errno"
544 " %d: %s", (*buffer ? " at " : ""), (int) *buffer, buffer + 1,
545 returned_errno, Strerror(returned_errno));
551 =for apidoc perl_destruct
553 Shuts down a Perl interpreter. See L<perlembed> for a tutorial.
555 C<my_perl> points to the Perl interpreter. It must have been previously
556 created through the use of L</perl_alloc> and L</perl_construct>. It may
557 have been initialised through L</perl_parse>, and may have been used
558 through L</perl_run> and other means. This function should be called for
559 any Perl interpreter that has been constructed with L</perl_construct>,
560 even if subsequent operations on it failed, for example if L</perl_parse>
561 returned a non-zero value.
563 If the interpreter's C<PL_exit_flags> word has the
564 C<PERL_EXIT_DESTRUCT_END> flag set, then this function will execute code
565 in C<END> blocks before performing the rest of destruction. If it is
566 desired to make any use of the interpreter between L</perl_parse> and
567 L</perl_destruct> other than just calling L</perl_run>, then this flag
568 should be set early on. This matters if L</perl_run> will not be called,
569 or if anything else will be done in addition to calling L</perl_run>.
571 Returns a value be a suitable value to pass to the C library function
572 C<exit> (or to return from C<main>), to serve as an exit code indicating
573 the nature of the way the interpreter terminated. This takes into account
574 any failure of L</perl_parse> and any early exit from L</perl_run>.
575 The exit code is of the type required by the host operating system,
576 so because of differing exit code conventions it is not portable to
577 interpret specific numeric values as having specific meanings.
585 volatile signed char destruct_level; /* see possible values in intrpvar.h */
587 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
592 PERL_ARGS_ASSERT_PERL_DESTRUCT;
594 PERL_UNUSED_ARG(my_perl);
597 assert(PL_scopestack_ix == 1);
599 /* wait for all pseudo-forked children to finish */
600 PERL_WAIT_FOR_CHILDREN;
602 destruct_level = PL_perl_destruct_level;
604 const char * const s = PerlEnv_getenv("PERL_DESTRUCT_LEVEL");
607 if (strEQ(s, "-1")) { /* Special case: modperl folklore. */
611 if (grok_atoUV(s, &uv, NULL) && uv <= INT_MAX)
616 if (destruct_level < i) destruct_level = i;
617 #ifdef PERL_TRACK_MEMPOOL
618 /* RT #114496, for perl_free */
619 PL_perl_destruct_level = i;
624 if (PL_exit_flags & PERL_EXIT_DESTRUCT_END) {
630 if (PL_endav && !PL_minus_c) {
631 PERL_SET_PHASE(PERL_PHASE_END);
632 call_list(PL_scopestack_ix, PL_endav);
638 assert(PL_scopestack_ix == 0);
640 /* normally when we get here, PL_parser should be null due to having
641 * its original (null) value restored by SAVEt_PARSER during leaving
642 * scope (usually before run-time starts in fact).
643 * But if a thread is created within a BEGIN block, the parser is
644 * duped, but the SAVEt_PARSER savestack entry isn't. So PL_parser
645 * never gets cleaned up.
646 * Clean it up here instead. This is a bit of a hack.
649 /* stop parser_free() stomping on PL_curcop */
650 PL_parser->saved_curcop = PL_curcop;
651 parser_free(PL_parser);
655 /* Need to flush since END blocks can produce output */
656 /* flush stdout separately, since we can identify it */
659 PerlIO *stdo = PerlIO_stdout();
660 if (*stdo && PerlIO_flush(stdo)) {
661 PerlIO_restore_errno(stdo);
663 PerlIO_printf(PerlIO_stderr(), "Unable to flush stdout: %s\n",
672 #ifdef PERL_TRACE_OPS
673 /* dump OP-counts if $ENV{PERL_TRACE_OPS} > 0 */
675 const char * const ptoenv = PerlEnv_getenv("PERL_TRACE_OPS");
678 if (!ptoenv || !Perl_grok_atoUV(ptoenv, &uv, NULL)
682 PerlIO_printf(Perl_debug_log, "Trace of all OPs executed:\n");
683 for (i = 0; i <= OP_max; ++i) {
684 if (PL_op_exec_cnt[i])
685 PerlIO_printf(Perl_debug_log, " %s: %" UVuf "\n", PL_op_name[i], PL_op_exec_cnt[i]);
687 /* Utility slot for easily doing little tracing experiments in the runloop: */
688 if (PL_op_exec_cnt[OP_max+1] != 0)
689 PerlIO_printf(Perl_debug_log, " SPECIAL: %" UVuf "\n", PL_op_exec_cnt[OP_max+1]);
690 PerlIO_printf(Perl_debug_log, "\n");
695 if (PL_threadhook(aTHX)) {
696 /* Threads hook has vetoed further cleanup */
697 PL_veto_cleanup = TRUE;
701 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
702 if (destruct_level != 0) {
703 /* Fork here to create a child. Our child's job is to preserve the
704 state of scalars prior to destruction, so that we can instruct it
705 to dump any scalars that we later find have leaked.
706 There's no subtlety in this code - it assumes POSIX, and it doesn't
710 if(PerlSock_socketpair_cloexec(AF_UNIX, SOCK_STREAM, 0, fd)) {
711 perror("Debug leaking scalars socketpair failed");
717 perror("Debug leaking scalars fork failed");
721 /* We are the child */
722 const int sock = fd[1];
723 const int debug_fd = PerlIO_fileno(Perl_debug_log);
726 /* Our success message is an integer 0, and a char 0 */
727 static const char success[sizeof(int) + 1] = {0};
731 /* We need to close all other file descriptors otherwise we end up
732 with interesting hangs, where the parent closes its end of a
733 pipe, and sits waiting for (another) child to terminate. Only
734 that child never terminates, because it never gets EOF, because
735 we also have the far end of the pipe open. We even need to
736 close the debugging fd, because sometimes it happens to be one
737 end of a pipe, and a process is waiting on the other end for
738 EOF. Normally it would be closed at some point earlier in
739 destruction, but if we happen to cause the pipe to remain open,
740 EOF never occurs, and we get an infinite hang. Hence all the
741 games to pass in a file descriptor if it's actually needed. */
743 f = sysconf(_SC_OPEN_MAX);
745 where = "sysconf failed";
756 union control_un control;
759 struct cmsghdr *cmptr;
763 msg.msg_control = control.control;
764 msg.msg_controllen = sizeof(control.control);
765 /* We're a connected socket so we don't need a source */
769 msg.msg_iovlen = C_ARRAY_LENGTH(vec);
771 vec[0].iov_base = (void*)⌖
772 vec[0].iov_len = sizeof(target);
774 got = recvmsg(sock, &msg, 0);
779 where = "recv failed";
782 if(got < sizeof(target)) {
783 where = "short recv";
787 if(!(cmptr = CMSG_FIRSTHDR(&msg))) {
791 if(cmptr->cmsg_len != CMSG_LEN(sizeof(int))) {
792 where = "wrong cmsg_len";
795 if(cmptr->cmsg_level != SOL_SOCKET) {
796 where = "wrong cmsg_level";
799 if(cmptr->cmsg_type != SCM_RIGHTS) {
800 where = "wrong cmsg_type";
804 got_fd = *(int*)CMSG_DATA(cmptr);
805 /* For our last little bit of trickery, put the file descriptor
806 back into Perl_debug_log, as if we never actually closed it
808 if(got_fd != debug_fd) {
809 if (PerlLIO_dup2_cloexec(got_fd, debug_fd) == -1) {
816 PerlIO_flush(Perl_debug_log);
818 got = write(sock, &success, sizeof(success));
821 where = "write failed";
824 if(got < sizeof(success)) {
825 where = "short write";
832 int send_errno = errno;
833 unsigned char length = (unsigned char) strlen(where);
834 struct iovec failure[3] = {
835 {(void*)&send_errno, sizeof(send_errno)},
837 {(void*)where, length}
839 int got = writev(sock, failure, 3);
840 /* Bad news travels fast. Faster than data. We'll get a SIGPIPE
841 in the parent if we try to read from the socketpair after the
842 child has exited, even if there was data to read.
843 So sleep a bit to give the parent a fighting chance of
846 _exit((got == -1) ? errno : 0);
850 PL_dumper_fd = fd[0];
855 /* We must account for everything. */
857 /* Destroy the main CV and syntax tree */
858 /* Set PL_curcop now, because destroying ops can cause new SVs
859 to be generated in Perl_pad_swipe, and when running with
860 -DDEBUG_LEAKING_SCALARS they expect PL_curcop to point to a valid
861 op from which the filename structure member is copied. */
862 PL_curcop = &PL_compiling;
864 /* ensure comppad/curpad to refer to main's pad */
865 if (CvPADLIST(PL_main_cv)) {
866 PAD_SET_CUR_NOSAVE(CvPADLIST(PL_main_cv), 1);
867 PL_comppad_name = PadlistNAMES(CvPADLIST(PL_main_cv));
869 op_free(PL_main_root);
872 PL_main_start = NULL;
873 /* note that PL_main_cv isn't usually actually freed at this point,
874 * due to the CvOUTSIDE refs from subs compiled within it. It will
875 * get freed once all the subs are freed in sv_clean_all(), for
876 * destruct_level > 0 */
877 SvREFCNT_dec(PL_main_cv);
879 PERL_SET_PHASE(PERL_PHASE_DESTRUCT);
881 /* Tell PerlIO we are about to tear things apart in case
882 we have layers which are using resources that should
886 PerlIO_destruct(aTHX);
889 * Try to destruct global references. We do this first so that the
890 * destructors and destructees still exist. Some sv's might remain.
891 * Non-referenced objects are on their own.
895 /* unhook hooks which will soon be, or use, destroyed data */
896 SvREFCNT_dec(PL_warnhook);
898 SvREFCNT_dec(PL_diehook);
901 /* call exit list functions */
902 while (PL_exitlistlen-- > 0)
903 PL_exitlist[PL_exitlistlen].fn(aTHX_ PL_exitlist[PL_exitlistlen].ptr);
905 Safefree(PL_exitlist);
910 SvREFCNT_dec(PL_registered_mros);
912 /* jettison our possibly duplicated environment */
913 /* if PERL_USE_SAFE_PUTENV is defined environ will not have been copied
914 * so we certainly shouldn't free it here
917 #if defined(USE_ENVIRON_ARRAY) && !defined(PERL_USE_SAFE_PUTENV)
918 if (environ != PL_origenviron && !PL_use_safe_putenv
920 /* only main thread can free environ[0] contents */
921 && PL_curinterp == aTHX
927 for (i = 0; environ[i]; i++)
928 safesysfree(environ[i]);
930 /* Must use safesysfree() when working with environ. */
931 safesysfree(environ);
933 environ = PL_origenviron;
936 #endif /* !PERL_MICRO */
938 if (destruct_level == 0) {
940 DEBUG_P(debprofdump());
942 #if defined(PERLIO_LAYERS)
943 /* No more IO - including error messages ! */
944 PerlIO_cleanup(aTHX);
947 CopFILE_free(&PL_compiling);
949 /* The exit() function will do everything that needs doing. */
953 /* Below, do clean up for when PERL_DESTRUCT_LEVEL is not 0 */
956 /* the syntax tree is shared between clones
957 * so op_free(PL_main_root) only ReREFCNT_dec's
958 * REGEXPs in the parent interpreter
959 * we need to manually ReREFCNT_dec for the clones
962 I32 i = AvFILLp(PL_regex_padav);
963 SV **ary = AvARRAY(PL_regex_padav);
966 SvREFCNT_dec(ary[i]);
967 ary[i] = &PL_sv_undef;
973 SvREFCNT_dec(MUTABLE_SV(PL_stashcache));
974 PL_stashcache = NULL;
976 /* loosen bonds of global variables */
978 /* XXX can PL_parser still be non-null here? */
979 if(PL_parser && PL_parser->rsfp) {
980 (void)PerlIO_close(PL_parser->rsfp);
981 PL_parser->rsfp = NULL;
985 Safefree(PL_splitstr);
995 PL_doswitches = FALSE;
996 PL_dowarn = G_WARN_OFF;
997 #ifdef PERL_SAWAMPERSAND
998 PL_sawampersand = 0; /* must save all match strings */
1002 Safefree(PL_inplace);
1004 SvREFCNT_dec(PL_patchlevel);
1007 SvREFCNT_dec(PL_e_script);
1013 /* magical thingies */
1015 SvREFCNT_dec(PL_ofsgv); /* *, */
1018 SvREFCNT_dec(PL_ors_sv); /* $\ */
1021 SvREFCNT_dec(PL_rs); /* $/ */
1024 Safefree(PL_osname); /* $^O */
1027 SvREFCNT_dec(PL_statname);
1031 /* defgv, aka *_ should be taken care of elsewhere */
1034 Safefree(PL_efloatbuf);
1035 PL_efloatbuf = NULL;
1038 /* startup and shutdown function lists */
1039 SvREFCNT_dec(PL_beginav);
1040 SvREFCNT_dec(PL_beginav_save);
1041 SvREFCNT_dec(PL_endav);
1042 SvREFCNT_dec(PL_checkav);
1043 SvREFCNT_dec(PL_checkav_save);
1044 SvREFCNT_dec(PL_unitcheckav);
1045 SvREFCNT_dec(PL_unitcheckav_save);
1046 SvREFCNT_dec(PL_initav);
1048 PL_beginav_save = NULL;
1051 PL_checkav_save = NULL;
1052 PL_unitcheckav = NULL;
1053 PL_unitcheckav_save = NULL;
1056 /* shortcuts just get cleared */
1059 PL_argvoutgv = NULL;
1062 PL_last_in_gv = NULL;
1073 SvREFCNT_dec(PL_envgv);
1074 SvREFCNT_dec(PL_incgv);
1075 SvREFCNT_dec(PL_argvgv);
1076 SvREFCNT_dec(PL_replgv);
1077 SvREFCNT_dec(PL_DBgv);
1078 SvREFCNT_dec(PL_DBline);
1079 SvREFCNT_dec(PL_DBsub);
1088 SvREFCNT_dec(PL_argvout_stack);
1089 PL_argvout_stack = NULL;
1091 SvREFCNT_dec(PL_modglobal);
1092 PL_modglobal = NULL;
1093 SvREFCNT_dec(PL_preambleav);
1094 PL_preambleav = NULL;
1095 SvREFCNT_dec(PL_subname);
1097 #ifdef PERL_USES_PL_PIDSTATUS
1098 SvREFCNT_dec(PL_pidstatus);
1099 PL_pidstatus = NULL;
1101 SvREFCNT_dec(PL_toptarget);
1102 PL_toptarget = NULL;
1103 SvREFCNT_dec(PL_bodytarget);
1104 PL_bodytarget = NULL;
1105 PL_formtarget = NULL;
1107 /* free locale stuff */
1108 #ifdef USE_LOCALE_COLLATE
1109 Safefree(PL_collation_name);
1110 PL_collation_name = NULL;
1112 #if defined(USE_POSIX_2008_LOCALE) \
1113 && defined(USE_THREAD_SAFE_LOCALE) \
1114 && ! defined(HAS_QUERYLOCALE)
1115 for (i = 0; i < (int) C_ARRAY_LENGTH(PL_curlocales); i++) {
1116 Safefree(PL_curlocales[i]);
1117 PL_curlocales[i] = NULL;
1120 #ifdef HAS_POSIX_2008_LOCALE
1122 /* This also makes sure we aren't using a locale object that gets freed
1124 const locale_t old_locale = uselocale(LC_GLOBAL_LOCALE);
1125 if ( old_locale != LC_GLOBAL_LOCALE
1126 # ifdef USE_POSIX_2008_LOCALE
1127 && old_locale != PL_C_locale_obj
1130 DEBUG_Lv(PerlIO_printf(Perl_debug_log,
1131 "%s:%d: Freeing %p\n", __FILE__, __LINE__, old_locale));
1132 freelocale(old_locale);
1135 # ifdef USE_LOCALE_NUMERIC
1136 if (PL_underlying_numeric_obj) {
1137 DEBUG_Lv(PerlIO_printf(Perl_debug_log,
1138 "%s:%d: Freeing %p\n", __FILE__, __LINE__,
1139 PL_underlying_numeric_obj));
1140 freelocale(PL_underlying_numeric_obj);
1141 PL_underlying_numeric_obj = (locale_t) NULL;
1145 #ifdef USE_LOCALE_NUMERIC
1146 Safefree(PL_numeric_name);
1147 PL_numeric_name = NULL;
1148 SvREFCNT_dec(PL_numeric_radix_sv);
1149 PL_numeric_radix_sv = NULL;
1152 if (PL_setlocale_buf) {
1153 Safefree(PL_setlocale_buf);
1154 PL_setlocale_buf = NULL;
1157 if (PL_langinfo_buf) {
1158 Safefree(PL_langinfo_buf);
1159 PL_langinfo_buf = NULL;
1162 #ifdef USE_LOCALE_CTYPE
1163 SvREFCNT_dec(PL_warn_locale);
1164 PL_warn_locale = NULL;
1167 SvREFCNT_dec(PL_AboveLatin1);
1168 PL_AboveLatin1 = NULL;
1169 SvREFCNT_dec(PL_Assigned_invlist);
1170 PL_Assigned_invlist = NULL;
1171 SvREFCNT_dec(PL_GCB_invlist);
1172 PL_GCB_invlist = NULL;
1173 SvREFCNT_dec(PL_HasMultiCharFold);
1174 PL_HasMultiCharFold = NULL;
1175 SvREFCNT_dec(PL_InMultiCharFold);
1176 PL_InMultiCharFold = NULL;
1177 SvREFCNT_dec(PL_Latin1);
1179 SvREFCNT_dec(PL_LB_invlist);
1180 PL_LB_invlist = NULL;
1181 SvREFCNT_dec(PL_SB_invlist);
1182 PL_SB_invlist = NULL;
1183 SvREFCNT_dec(PL_SCX_invlist);
1184 PL_SCX_invlist = NULL;
1185 SvREFCNT_dec(PL_UpperLatin1);
1186 PL_UpperLatin1 = NULL;
1187 SvREFCNT_dec(PL_in_some_fold);
1188 PL_in_some_fold = NULL;
1189 SvREFCNT_dec(PL_utf8_foldclosures);
1190 PL_utf8_foldclosures = NULL;
1191 SvREFCNT_dec(PL_utf8_idcont);
1192 PL_utf8_idcont = NULL;
1193 SvREFCNT_dec(PL_utf8_idstart);
1194 PL_utf8_idstart = NULL;
1195 SvREFCNT_dec(PL_utf8_perl_idcont);
1196 PL_utf8_perl_idcont = NULL;
1197 SvREFCNT_dec(PL_utf8_perl_idstart);
1198 PL_utf8_perl_idstart = NULL;
1199 SvREFCNT_dec(PL_utf8_xidcont);
1200 PL_utf8_xidcont = NULL;
1201 SvREFCNT_dec(PL_utf8_xidstart);
1202 PL_utf8_xidstart = NULL;
1203 SvREFCNT_dec(PL_WB_invlist);
1204 PL_WB_invlist = NULL;
1205 SvREFCNT_dec(PL_utf8_toupper);
1206 PL_utf8_toupper = NULL;
1207 SvREFCNT_dec(PL_utf8_totitle);
1208 PL_utf8_totitle = NULL;
1209 SvREFCNT_dec(PL_utf8_tolower);
1210 PL_utf8_tolower = NULL;
1211 SvREFCNT_dec(PL_utf8_tofold);
1212 PL_utf8_tofold = NULL;
1213 SvREFCNT_dec(PL_utf8_tosimplefold);
1214 PL_utf8_tosimplefold = NULL;
1215 SvREFCNT_dec(PL_utf8_charname_begin);
1216 PL_utf8_charname_begin = NULL;
1217 SvREFCNT_dec(PL_utf8_charname_continue);
1218 PL_utf8_charname_continue = NULL;
1219 SvREFCNT_dec(PL_utf8_mark);
1220 PL_utf8_mark = NULL;
1221 SvREFCNT_dec(PL_InBitmap);
1223 SvREFCNT_dec(PL_CCC_non0_non230);
1224 PL_CCC_non0_non230 = NULL;
1225 SvREFCNT_dec(PL_Private_Use);
1226 PL_Private_Use = NULL;
1228 for (i = 0; i < POSIX_CC_COUNT; i++) {
1229 SvREFCNT_dec(PL_XPosix_ptrs[i]);
1230 PL_XPosix_ptrs[i] = NULL;
1232 if (i != _CC_CASED) { /* A copy of Alpha */
1233 SvREFCNT_dec(PL_Posix_ptrs[i]);
1234 PL_Posix_ptrs[i] = NULL;
1238 free_and_set_cop_warnings(&PL_compiling, NULL);
1239 cophh_free(CopHINTHASH_get(&PL_compiling));
1240 CopHINTHASH_set(&PL_compiling, cophh_new_empty());
1241 CopFILE_free(&PL_compiling);
1243 /* Prepare to destruct main symbol table. */
1246 /* break ref loop *:: <=> %:: */
1247 (void)hv_deletes(hv, "main::", G_DISCARD);
1250 SvREFCNT_dec(PL_curstname);
1251 PL_curstname = NULL;
1253 /* clear queued errors */
1254 SvREFCNT_dec(PL_errors);
1257 SvREFCNT_dec(PL_isarev);
1260 if (destruct_level >= 2) {
1261 if (PL_scopestack_ix != 0)
1262 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
1263 "Unbalanced scopes: %ld more ENTERs than LEAVEs\n",
1264 (long)PL_scopestack_ix);
1265 if (PL_savestack_ix != 0)
1266 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
1267 "Unbalanced saves: %ld more saves than restores\n",
1268 (long)PL_savestack_ix);
1269 if (PL_tmps_floor != -1)
1270 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced tmps: %ld more allocs than frees\n",
1271 (long)PL_tmps_floor + 1);
1272 if (cxstack_ix != -1)
1273 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced context: %ld more PUSHes than POPs\n",
1274 (long)cxstack_ix + 1);
1278 SvREFCNT_dec(PL_regex_padav);
1279 PL_regex_padav = NULL;
1280 PL_regex_pad = NULL;
1283 #ifdef PERL_IMPLICIT_CONTEXT
1284 /* the entries in this list are allocated via SV PVX's, so get freed
1285 * in sv_clean_all */
1286 Safefree(PL_my_cxt_list);
1289 /* Now absolutely destruct everything, somehow or other, loops or no. */
1291 /* the 2 is for PL_fdpid and PL_strtab */
1292 while (sv_clean_all() > 2)
1296 Safefree(PL_stashpad); /* must come after sv_clean_all */
1299 AvREAL_off(PL_fdpid); /* no surviving entries */
1300 SvREFCNT_dec(PL_fdpid); /* needed in io_close() */
1303 #ifdef HAVE_INTERP_INTERN
1307 /* constant strings */
1308 for (i = 0; i < SV_CONSTS_COUNT; i++) {
1309 SvREFCNT_dec(PL_sv_consts[i]);
1310 PL_sv_consts[i] = NULL;
1313 /* Destruct the global string table. */
1315 /* Yell and reset the HeVAL() slots that are still holding refcounts,
1316 * so that sv_free() won't fail on them.
1317 * Now that the global string table is using a single hunk of memory
1318 * for both HE and HEK, we either need to explicitly unshare it the
1319 * correct way, or actually free things here.
1322 const I32 max = HvMAX(PL_strtab);
1323 HE * const * const array = HvARRAY(PL_strtab);
1324 HE *hent = array[0];
1327 if (hent && ckWARN_d(WARN_INTERNAL)) {
1328 HE * const next = HeNEXT(hent);
1329 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
1330 "Unbalanced string table refcount: (%ld) for \"%s\"",
1331 (long)hent->he_valu.hent_refcount, HeKEY(hent));
1338 hent = array[riter];
1343 HvARRAY(PL_strtab) = 0;
1344 HvTOTALKEYS(PL_strtab) = 0;
1346 SvREFCNT_dec(PL_strtab);
1349 /* free the pointer tables used for cloning */
1350 ptr_table_free(PL_ptr_table);
1351 PL_ptr_table = (PTR_TBL_t*)NULL;
1354 /* free special SVs */
1356 SvREFCNT(&PL_sv_yes) = 0;
1357 sv_clear(&PL_sv_yes);
1358 SvANY(&PL_sv_yes) = NULL;
1359 SvFLAGS(&PL_sv_yes) = 0;
1361 SvREFCNT(&PL_sv_no) = 0;
1362 sv_clear(&PL_sv_no);
1363 SvANY(&PL_sv_no) = NULL;
1364 SvFLAGS(&PL_sv_no) = 0;
1366 SvREFCNT(&PL_sv_zero) = 0;
1367 sv_clear(&PL_sv_zero);
1368 SvANY(&PL_sv_zero) = NULL;
1369 SvFLAGS(&PL_sv_zero) = 0;
1373 for (i=0; i<=2; i++) {
1374 SvREFCNT(PERL_DEBUG_PAD(i)) = 0;
1375 sv_clear(PERL_DEBUG_PAD(i));
1376 SvANY(PERL_DEBUG_PAD(i)) = NULL;
1377 SvFLAGS(PERL_DEBUG_PAD(i)) = 0;
1381 if (PL_sv_count != 0 && ckWARN_d(WARN_INTERNAL))
1382 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Scalars leaked: %ld\n", (long)PL_sv_count);
1384 #ifdef DEBUG_LEAKING_SCALARS
1385 if (PL_sv_count != 0) {
1390 for (sva = PL_sv_arenaroot; sva; sva = MUTABLE_SV(SvANY(sva))) {
1391 svend = &sva[SvREFCNT(sva)];
1392 for (sv = sva + 1; sv < svend; ++sv) {
1393 if (SvTYPE(sv) != (svtype)SVTYPEMASK) {
1394 PerlIO_printf(Perl_debug_log, "leaked: sv=0x%p"
1396 " refcnt=%" UVuf pTHX__FORMAT "\n"
1397 "\tallocated at %s:%d %s %s (parent 0x%" UVxf ");"
1398 "serial %" UVuf "\n",
1399 (void*)sv, (UV)sv->sv_flags, (UV)sv->sv_refcnt
1401 sv->sv_debug_file ? sv->sv_debug_file : "(unknown)",
1403 sv->sv_debug_inpad ? "for" : "by",
1404 sv->sv_debug_optype ?
1405 PL_op_name[sv->sv_debug_optype]: "(none)",
1406 PTR2UV(sv->sv_debug_parent),
1409 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1410 Perl_dump_sv_child(aTHX_ sv);
1416 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1420 /* Wait for up to 4 seconds for child to terminate.
1421 This seems to be the least effort way of timing out on reaping
1423 struct timeval waitfor = {4, 0};
1424 int sock = PL_dumper_fd;
1428 FD_SET(sock, &rset);
1429 select(sock + 1, &rset, NULL, NULL, &waitfor);
1430 waitpid(child, &status, WNOHANG);
1435 #ifdef DEBUG_LEAKING_SCALARS_ABORT
1441 #if defined(PERLIO_LAYERS)
1442 /* No more IO - including error messages ! */
1443 PerlIO_cleanup(aTHX);
1446 /* sv_undef needs to stay immortal until after PerlIO_cleanup
1447 as currently layers use it rather than NULL as a marker
1448 for no arg - and will try and SvREFCNT_dec it.
1450 SvREFCNT(&PL_sv_undef) = 0;
1451 SvREADONLY_off(&PL_sv_undef);
1453 Safefree(PL_origfilename);
1454 PL_origfilename = NULL;
1455 Safefree(PL_reg_curpm);
1456 free_tied_hv_pool();
1457 Safefree(PL_op_mask);
1458 Safefree(PL_psig_name);
1459 PL_psig_name = (SV**)NULL;
1460 PL_psig_ptr = (SV**)NULL;
1462 /* We need to NULL PL_psig_pend first, so that
1463 signal handlers know not to use it */
1464 int *psig_save = PL_psig_pend;
1465 PL_psig_pend = (int*)NULL;
1466 Safefree(psig_save);
1469 TAINTING_set(FALSE);
1470 TAINT_WARN_set(FALSE);
1471 PL_hints = 0; /* Reset hints. Should hints be per-interpreter ? */
1473 DEBUG_P(debprofdump());
1477 #ifdef USE_REENTRANT_API
1478 Perl_reentrant_free(aTHX);
1481 /* These all point to HVs that are about to be blown away.
1482 Code in core and on CPAN assumes that if the interpreter is re-started
1483 that they will be cleanly NULL or pointing to a valid HV. */
1484 PL_custom_op_names = NULL;
1485 PL_custom_op_descs = NULL;
1486 PL_custom_ops = NULL;
1490 while (PL_regmatch_slab) {
1491 regmatch_slab *s = PL_regmatch_slab;
1492 PL_regmatch_slab = PL_regmatch_slab->next;
1496 /* As the absolutely last thing, free the non-arena SV for mess() */
1499 /* we know that type == SVt_PVMG */
1501 /* it could have accumulated taint magic */
1504 for (mg = SvMAGIC(PL_mess_sv); mg; mg = moremagic) {
1505 moremagic = mg->mg_moremagic;
1506 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global
1508 Safefree(mg->mg_ptr);
1512 /* we know that type >= SVt_PV */
1513 SvPV_free(PL_mess_sv);
1514 Safefree(SvANY(PL_mess_sv));
1515 Safefree(PL_mess_sv);
1522 =for apidoc perl_free
1524 Releases a Perl interpreter. See L<perlembed>.
1533 PERL_ARGS_ASSERT_PERL_FREE;
1535 if (PL_veto_cleanup)
1538 #ifdef PERL_TRACK_MEMPOOL
1541 * Don't free thread memory if PERL_DESTRUCT_LEVEL is set to a non-zero
1542 * value as we're probably hunting memory leaks then
1544 if (PL_perl_destruct_level == 0) {
1545 const U32 old_debug = PL_debug;
1546 /* Emulate the PerlHost behaviour of free()ing all memory allocated in this
1547 thread at thread exit. */
1549 PerlIO_puts(Perl_debug_log, "Disabling memory debugging as we "
1550 "free this thread's memory\n");
1551 PL_debug &= ~ DEBUG_m_FLAG;
1553 while(aTHXx->Imemory_debug_header.next != &(aTHXx->Imemory_debug_header)){
1554 char * next = (char *)(aTHXx->Imemory_debug_header.next);
1555 Malloc_t ptr = PERL_MEMORY_DEBUG_HEADER_SIZE + next;
1558 PL_debug = old_debug;
1563 #if defined(WIN32) || defined(NETWARE)
1564 # if defined(PERL_IMPLICIT_SYS)
1567 void *host = nw_internal_host;
1568 PerlMem_free(aTHXx);
1569 nw_delete_internal_host(host);
1571 void *host = w32_internal_host;
1572 PerlMem_free(aTHXx);
1573 win32_delete_internal_host(host);
1577 PerlMem_free(aTHXx);
1580 PerlMem_free(aTHXx);
1584 #if defined(USE_ITHREADS)
1585 /* provide destructors to clean up the thread key when libperl is unloaded */
1586 #ifndef WIN32 /* handled during DLL_PROCESS_DETACH in win32/perllib.c */
1588 #if defined(__hpux) && !(defined(__ux_version) && __ux_version <= 1020) && !defined(__GNUC__)
1589 #pragma fini "perl_fini"
1590 #elif defined(__sun) && !defined(__GNUC__)
1591 #pragma fini (perl_fini)
1595 #if defined(__GNUC__)
1596 __attribute__((destructor))
1601 PL_curinterp && !PL_veto_cleanup)
1606 #endif /* THREADS */
1609 Perl_call_atexit(pTHX_ ATEXIT_t fn, void *ptr)
1611 Renew(PL_exitlist, PL_exitlistlen+1, PerlExitListEntry);
1612 PL_exitlist[PL_exitlistlen].fn = fn;
1613 PL_exitlist[PL_exitlistlen].ptr = ptr;
1618 =for apidoc perl_parse
1620 Tells a Perl interpreter to parse a Perl script. This performs most
1621 of the initialisation of a Perl interpreter. See L<perlembed> for
1624 C<my_perl> points to the Perl interpreter that is to parse the script.
1625 It must have been previously created through the use of L</perl_alloc>
1626 and L</perl_construct>. C<xsinit> points to a callback function that
1627 will be called to set up the ability for this Perl interpreter to load
1628 XS extensions, or may be null to perform no such setup.
1630 C<argc> and C<argv> supply a set of command-line arguments to the Perl
1631 interpreter, as would normally be passed to the C<main> function of
1632 a C program. C<argv[argc]> must be null. These arguments are where
1633 the script to parse is specified, either by naming a script file or by
1634 providing a script in a C<-e> option.
1635 If L<C<$0>|perlvar/$0> will be written to in the Perl interpreter, then
1636 the argument strings must be in writable memory, and so mustn't just be
1639 C<env> specifies a set of environment variables that will be used by
1640 this Perl interpreter. If non-null, it must point to a null-terminated
1641 array of environment strings. If null, the Perl interpreter will use
1642 the environment supplied by the C<environ> global variable.
1644 This function initialises the interpreter, and parses and compiles the
1645 script specified by the command-line arguments. This includes executing
1646 code in C<BEGIN>, C<UNITCHECK>, and C<CHECK> blocks. It does not execute
1647 C<INIT> blocks or the main program.
1649 Returns an integer of slightly tricky interpretation. The correct
1650 use of the return value is as a truth value indicating whether there
1651 was a failure in initialisation. If zero is returned, this indicates
1652 that initialisation was successful, and it is safe to proceed to call
1653 L</perl_run> and make other use of it. If a non-zero value is returned,
1654 this indicates some problem that means the interpreter wants to terminate.
1655 The interpreter should not be just abandoned upon such failure; the caller
1656 should proceed to shut the interpreter down cleanly with L</perl_destruct>
1657 and free it with L</perl_free>.
1659 For historical reasons, the non-zero return value also attempts to
1660 be a suitable value to pass to the C library function C<exit> (or to
1661 return from C<main>), to serve as an exit code indicating the nature
1662 of the way initialisation terminated. However, this isn't portable,
1663 due to differing exit code conventions. A historical bug is preserved
1664 for the time being: if the Perl built-in C<exit> is called during this
1665 function's execution, with a type of exit entailing a zero exit code
1666 under the host operating system's conventions, then this function
1667 returns zero rather than a non-zero value. This bug, [perl #2754],
1668 leads to C<perl_run> being called (and therefore C<INIT> blocks and the
1669 main program running) despite a call to C<exit>. It has been preserved
1670 because a popular module-installing module has come to rely on it and
1671 needs time to be fixed. This issue is [perl #132577], and the original
1672 bug is due to be fixed in Perl 5.30.
1677 #define SET_CURSTASH(newstash) \
1678 if (PL_curstash != newstash) { \
1679 SvREFCNT_dec(PL_curstash); \
1680 PL_curstash = (HV *)SvREFCNT_inc(newstash); \
1684 perl_parse(pTHXx_ XSINIT_t xsinit, int argc, char **argv, char **env)
1690 PERL_ARGS_ASSERT_PERL_PARSE;
1691 #ifndef MULTIPLICITY
1692 PERL_UNUSED_ARG(my_perl);
1694 #if (defined(USE_HASH_SEED) || defined(USE_HASH_SEED_DEBUG)) && !defined(NO_PERL_HASH_SEED_DEBUG)
1696 const char * const s = PerlEnv_getenv("PERL_HASH_SEED_DEBUG");
1698 if (s && strEQ(s, "1")) {
1699 const unsigned char *seed= PERL_HASH_SEED;
1700 const unsigned char *seed_end= PERL_HASH_SEED + PERL_HASH_SEED_BYTES;
1701 PerlIO_printf(Perl_debug_log, "HASH_FUNCTION = %s HASH_SEED = 0x", PERL_HASH_FUNC);
1702 while (seed < seed_end) {
1703 PerlIO_printf(Perl_debug_log, "%02x", *seed++);
1705 #ifdef PERL_HASH_RANDOMIZE_KEYS
1706 PerlIO_printf(Perl_debug_log, " PERTURB_KEYS = %d (%s)",
1707 PL_HASH_RAND_BITS_ENABLED,
1708 PL_HASH_RAND_BITS_ENABLED == 0 ? "NO" : PL_HASH_RAND_BITS_ENABLED == 1 ? "RANDOM" : "DETERMINISTIC");
1710 PerlIO_printf(Perl_debug_log, "\n");
1713 #endif /* #if (defined(USE_HASH_SEED) ... */
1717 struct NameTranslationInfo nti;
1718 __translate_amiga_to_unix_path_name(&argv[0],&nti);
1725 for(i = 0; i != argc; i++)
1727 assert(!argv[argc]);
1732 if (PL_origalen != 0) {
1733 PL_origalen = 1; /* don't use old PL_origalen if perl_parse() is called again */
1736 /* Set PL_origalen be the sum of the contiguous argv[]
1737 * elements plus the size of the env in case that it is
1738 * contiguous with the argv[]. This is used in mg.c:Perl_magic_set()
1739 * as the maximum modifiable length of $0. In the worst case
1740 * the area we are able to modify is limited to the size of
1741 * the original argv[0]. (See below for 'contiguous', though.)
1743 const char *s = NULL;
1744 const UV mask = ~(UV)(PTRSIZE-1);
1745 /* Do the mask check only if the args seem like aligned. */
1747 (mask < ~(UV)0) && ((PTR2UV(argv[0]) & mask) == PTR2UV(argv[0]));
1749 /* See if all the arguments are contiguous in memory. Note
1750 * that 'contiguous' is a loose term because some platforms
1751 * align the argv[] and the envp[]. If the arguments look
1752 * like non-aligned, assume that they are 'strictly' or
1753 * 'traditionally' contiguous. If the arguments look like
1754 * aligned, we just check that they are within aligned
1755 * PTRSIZE bytes. As long as no system has something bizarre
1756 * like the argv[] interleaved with some other data, we are
1757 * fine. (Did I just evoke Murphy's Law?) --jhi */
1758 if (PL_origargv && PL_origargc >= 1 && (s = PL_origargv[0])) {
1761 for (i = 1; i < PL_origargc; i++) {
1762 if ((PL_origargv[i] == s + 1
1764 || PL_origargv[i] == s + 2
1769 (PL_origargv[i] > s &&
1771 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1782 #ifndef PERL_USE_SAFE_PUTENV
1783 /* Can we grab env area too to be used as the area for $0? */
1784 if (s && PL_origenviron && !PL_use_safe_putenv) {
1785 if ((PL_origenviron[0] == s + 1)
1788 (PL_origenviron[0] > s &&
1789 PL_origenviron[0] <=
1790 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1794 #ifndef OS2 /* ENVIRON is read by the kernel too. */
1795 s = PL_origenviron[0];
1798 my_setenv("NoNe SuCh", NULL);
1799 /* Force copy of environment. */
1800 for (i = 1; PL_origenviron[i]; i++) {
1801 if (PL_origenviron[i] == s + 1
1804 (PL_origenviron[i] > s &&
1805 PL_origenviron[i] <=
1806 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1809 s = PL_origenviron[i];
1817 #endif /* !defined(PERL_USE_SAFE_PUTENV) */
1819 PL_origalen = s ? s - PL_origargv[0] + 1 : 0;
1824 /* Come here if running an undumped a.out. */
1826 PL_origfilename = savepv(argv[0]);
1827 PL_do_undump = FALSE;
1828 cxstack_ix = -1; /* start label stack again */
1830 assert (!TAINT_get);
1834 init_postdump_symbols(argc,argv,env);
1839 op_free(PL_main_root);
1840 PL_main_root = NULL;
1842 PL_main_start = NULL;
1843 SvREFCNT_dec(PL_main_cv);
1847 oldscope = PL_scopestack_ix;
1848 PL_dowarn = G_WARN_OFF;
1853 parse_body(env,xsinit);
1854 if (PL_unitcheckav) {
1855 call_list(oldscope, PL_unitcheckav);
1858 PERL_SET_PHASE(PERL_PHASE_CHECK);
1859 call_list(oldscope, PL_checkav);
1867 /* my_exit() was called */
1868 while (PL_scopestack_ix > oldscope)
1871 SET_CURSTASH(PL_defstash);
1872 if (PL_unitcheckav) {
1873 call_list(oldscope, PL_unitcheckav);
1876 PERL_SET_PHASE(PERL_PHASE_CHECK);
1877 call_list(oldscope, PL_checkav);
1882 * At this point we should do
1884 * to avoid [perl #2754], but that bugfix has been postponed
1885 * because of the Module::Install breakage it causes
1891 PerlIO_printf(Perl_error_log, "panic: top_env\n");
1899 /* This needs to stay in perl.c, as perl.c is compiled with different flags for
1900 miniperl, and we need to see those flags reflected in the values here. */
1902 /* What this returns is subject to change. Use the public interface in Config.
1905 S_Internals_V(pTHX_ CV *cv)
1908 #ifdef LOCAL_PATCH_COUNT
1909 const int local_patch_count = LOCAL_PATCH_COUNT;
1911 const int local_patch_count = 0;
1913 const int entries = 3 + local_patch_count;
1915 static const char non_bincompat_options[] =
1922 # ifdef NO_HASH_SEED
1925 # ifdef NO_TAINT_SUPPORT
1928 # ifdef PERL_BOOL_AS_CHAR
1929 " PERL_BOOL_AS_CHAR"
1931 # ifdef PERL_COPY_ON_WRITE
1932 " PERL_COPY_ON_WRITE"
1934 # ifdef PERL_DISABLE_PMC
1937 # ifdef PERL_DONT_CREATE_GVSV
1938 " PERL_DONT_CREATE_GVSV"
1940 # ifdef PERL_EXTERNAL_GLOB
1941 " PERL_EXTERNAL_GLOB"
1943 # ifdef PERL_HASH_FUNC_SIPHASH
1944 " PERL_HASH_FUNC_SIPHASH"
1946 # ifdef PERL_HASH_FUNC_SDBM
1947 " PERL_HASH_FUNC_SDBM"
1949 # ifdef PERL_HASH_FUNC_DJB2
1950 " PERL_HASH_FUNC_DJB2"
1952 # ifdef PERL_HASH_FUNC_SUPERFAST
1953 " PERL_HASH_FUNC_SUPERFAST"
1955 # ifdef PERL_HASH_FUNC_MURMUR3
1956 " PERL_HASH_FUNC_MURMUR3"
1958 # ifdef PERL_HASH_FUNC_ONE_AT_A_TIME
1959 " PERL_HASH_FUNC_ONE_AT_A_TIME"
1961 # ifdef PERL_HASH_FUNC_ONE_AT_A_TIME_HARD
1962 " PERL_HASH_FUNC_ONE_AT_A_TIME_HARD"
1964 # ifdef PERL_HASH_FUNC_ONE_AT_A_TIME_OLD
1965 " PERL_HASH_FUNC_ONE_AT_A_TIME_OLD"
1967 # ifdef PERL_IS_MINIPERL
1970 # ifdef PERL_MALLOC_WRAP
1973 # ifdef PERL_MEM_LOG
1976 # ifdef PERL_MEM_LOG_NOIMPL
1977 " PERL_MEM_LOG_NOIMPL"
1979 # ifdef PERL_OP_PARENT
1982 # ifdef PERL_PERTURB_KEYS_DETERMINISTIC
1983 " PERL_PERTURB_KEYS_DETERMINISTIC"
1985 # ifdef PERL_PERTURB_KEYS_DISABLED
1986 " PERL_PERTURB_KEYS_DISABLED"
1988 # ifdef PERL_PERTURB_KEYS_RANDOM
1989 " PERL_PERTURB_KEYS_RANDOM"
1991 # ifdef PERL_PRESERVE_IVUV
1992 " PERL_PRESERVE_IVUV"
1994 # ifdef PERL_RELOCATABLE_INCPUSH
1995 " PERL_RELOCATABLE_INCPUSH"
1997 # ifdef PERL_USE_DEVEL
2000 # ifdef PERL_USE_SAFE_PUTENV
2001 " PERL_USE_SAFE_PUTENV"
2003 # ifdef SILENT_NO_TAINT_SUPPORT
2004 " SILENT_NO_TAINT_SUPPORT"
2006 # ifdef UNLINK_ALL_VERSIONS
2007 " UNLINK_ALL_VERSIONS"
2009 # ifdef USE_ATTRIBUTES_FOR_PERLIO
2010 " USE_ATTRIBUTES_FOR_PERLIO"
2012 # ifdef USE_FAST_STDIO
2018 # ifdef USE_LOCALE_CTYPE
2021 # ifdef WIN32_NO_REGISTRY
2024 # ifdef USE_PERL_ATOF
2027 # ifdef USE_SITECUSTOMIZE
2028 " USE_SITECUSTOMIZE"
2030 # ifdef USE_THREAD_SAFE_LOCALE
2031 " USE_THREAD_SAFE_LOCALE"
2034 PERL_UNUSED_ARG(cv);
2035 PERL_UNUSED_VAR(items);
2037 EXTEND(SP, entries);
2039 PUSHs(sv_2mortal(newSVpv(PL_bincompat_options, 0)));
2040 PUSHs(Perl_newSVpvn_flags(aTHX_ non_bincompat_options,
2041 sizeof(non_bincompat_options) - 1, SVs_TEMP));
2043 #ifndef PERL_BUILD_DATE
2046 # define PERL_BUILD_DATE __DATE__ " " __TIME__
2048 # define PERL_BUILD_DATE __DATE__
2053 #ifdef PERL_BUILD_DATE
2054 PUSHs(Perl_newSVpvn_flags(aTHX_
2055 STR_WITH_LEN("Compiled at " PERL_BUILD_DATE),
2058 PUSHs(&PL_sv_undef);
2061 for (i = 1; i <= local_patch_count; i++) {
2062 /* This will be an undef, if PL_localpatches[i] is NULL. */
2063 PUSHs(sv_2mortal(newSVpv(PL_localpatches[i], 0)));
2069 #define INCPUSH_UNSHIFT 0x01
2070 #define INCPUSH_ADD_OLD_VERS 0x02
2071 #define INCPUSH_ADD_VERSIONED_SUB_DIRS 0x04
2072 #define INCPUSH_ADD_ARCHONLY_SUB_DIRS 0x08
2073 #define INCPUSH_NOT_BASEDIR 0x10
2074 #define INCPUSH_CAN_RELOCATE 0x20
2075 #define INCPUSH_ADD_SUB_DIRS \
2076 (INCPUSH_ADD_VERSIONED_SUB_DIRS|INCPUSH_ADD_ARCHONLY_SUB_DIRS)
2079 S_parse_body(pTHX_ char **env, XSINIT_t xsinit)
2082 int argc = PL_origargc;
2083 char **argv = PL_origargv;
2084 const char *scriptname = NULL;
2085 bool dosearch = FALSE;
2087 bool doextract = FALSE;
2088 const char *cddir = NULL;
2089 bool minus_e = FALSE; /* both -e and -E */
2090 #ifdef USE_SITECUSTOMIZE
2091 bool minus_f = FALSE;
2093 SV *linestr_sv = NULL;
2094 bool add_read_e_script = FALSE;
2095 U32 lex_start_flags = 0;
2097 PERL_SET_PHASE(PERL_PHASE_START);
2103 for (argc--,argv++; argc > 0; argc--,argv++) {
2104 if (argv[0][0] != '-' || !argv[0][1])
2110 #ifndef PERL_STRICT_CR
2134 if ((s = moreswitches(s)))
2139 #if defined(SILENT_NO_TAINT_SUPPORT)
2140 /* silently ignore */
2141 #elif defined(NO_TAINT_SUPPORT)
2142 Perl_croak_nocontext("This perl was compiled without taint support. "
2143 "Cowardly refusing to run with -t or -T flags");
2145 CHECK_MALLOC_TOO_LATE_FOR('t');
2146 if( !TAINTING_get ) {
2147 TAINT_WARN_set(TRUE);
2154 #if defined(SILENT_NO_TAINT_SUPPORT)
2155 /* silently ignore */
2156 #elif defined(NO_TAINT_SUPPORT)
2157 Perl_croak_nocontext("This perl was compiled without taint support. "
2158 "Cowardly refusing to run with -t or -T flags");
2160 CHECK_MALLOC_TOO_LATE_FOR('T');
2162 TAINT_WARN_set(FALSE);
2171 forbid_setid('e', FALSE);
2174 PL_e_script = newSVpvs("");
2175 add_read_e_script = TRUE;
2178 sv_catpv(PL_e_script, s);
2180 sv_catpv(PL_e_script, argv[1]);
2184 Perl_croak(aTHX_ "No code specified for -%c", c);
2185 sv_catpvs(PL_e_script, "\n");
2189 #ifdef USE_SITECUSTOMIZE
2195 case 'I': /* -I handled both here and in moreswitches() */
2196 forbid_setid('I', FALSE);
2197 if (!*++s && (s=argv[1]) != NULL) {
2201 STRLEN len = strlen(s);
2202 incpush(s, len, INCPUSH_ADD_SUB_DIRS|INCPUSH_ADD_OLD_VERS);
2205 Perl_croak(aTHX_ "No directory specified for -I");
2208 forbid_setid('S', FALSE);
2217 opts_prog = newSVpvs("use Config; Config::_V()");
2221 opts_prog = Perl_newSVpvf(aTHX_
2222 "use Config; Config::config_vars(qw%c%s%c)",
2226 Perl_av_create_and_push(aTHX_ &PL_preambleav, opts_prog);
2227 /* don't look for script or read stdin */
2228 scriptname = BIT_BUCKET;
2240 if (!*++s || isSPACE(*s)) {
2244 /* catch use of gnu style long options.
2245 Both of these exit immediately. */
2246 if (strEQ(s, "version"))
2248 if (strEQ(s, "help"))
2253 Perl_croak(aTHX_ "Unrecognized switch: -%s (-h will show valid options)",s);
2264 #ifndef SECURE_INTERNAL_GETENV
2267 (s = PerlEnv_getenv("PERL5OPT")))
2271 if (*s == '-' && *(s+1) == 'T') {
2272 #if defined(SILENT_NO_TAINT_SUPPORT)
2273 /* silently ignore */
2274 #elif defined(NO_TAINT_SUPPORT)
2275 Perl_croak_nocontext("This perl was compiled without taint support. "
2276 "Cowardly refusing to run with -t or -T flags");
2278 CHECK_MALLOC_TOO_LATE_FOR('T');
2280 TAINT_WARN_set(FALSE);
2284 char *popt_copy = NULL;
2297 if (!memCHRs("CDIMUdmtwW", *s))
2298 Perl_croak(aTHX_ "Illegal switch in PERL5OPT: -%c", *s);
2302 popt_copy = SvPVX(sv_2mortal(newSVpv(d,0)));
2303 s = popt_copy + (s - d);
2311 #if defined(SILENT_NO_TAINT_SUPPORT)
2312 /* silently ignore */
2313 #elif defined(NO_TAINT_SUPPORT)
2314 Perl_croak_nocontext("This perl was compiled without taint support. "
2315 "Cowardly refusing to run with -t or -T flags");
2317 if( !TAINTING_get) {
2318 TAINT_WARN_set(TRUE);
2330 #ifndef NO_PERL_INTERNAL_RAND_SEED
2331 /* If we're not set[ug]id, we might have honored
2332 PERL_INTERNAL_RAND_SEED in perl_construct().
2333 At this point command-line options have been parsed, so if
2334 we're now tainting and not set[ug]id re-seed.
2335 This could possibly be wasteful if PERL_INTERNAL_RAND_SEED is invalid,
2336 but avoids duplicating the logic from perl_construct().
2339 PerlProc_getuid() == PerlProc_geteuid() &&
2340 PerlProc_getgid() == PerlProc_getegid()) {
2341 Perl_drand48_init_r(&PL_internal_random_state, seed());
2345 /* Set $^X early so that it can be used for relocatable paths in @INC */
2346 /* and for SITELIB_EXP in USE_SITECUSTOMIZE */
2347 assert (!TAINT_get);
2352 #if defined(USE_SITECUSTOMIZE)
2354 /* The games with local $! are to avoid setting errno if there is no
2355 sitecustomize script. "q%c...%c", 0, ..., 0 becomes "q\0...\0",
2356 ie a q() operator with a NUL byte as a the delimiter. This avoids
2357 problems with pathnames containing (say) ' */
2358 # ifdef PERL_IS_MINIPERL
2359 AV *const inc = GvAV(PL_incgv);
2360 SV **const inc0 = inc ? av_fetch(inc, 0, FALSE) : NULL;
2363 /* if lib/buildcustomize.pl exists, it should not fail. If it does,
2364 it should be reported immediately as a build failure. */
2365 (void)Perl_av_create_and_unshift_one(aTHX_ &PL_preambleav,
2367 "BEGIN { my $f = q%c%s%" SVf "/buildcustomize.pl%c; "
2368 "do {local $!; -f $f }"
2369 " and do $f || die $@ || qq '$f: $!' }",
2370 0, (TAINTING_get ? "./" : ""), SVfARG(*inc0), 0));
2373 /* SITELIB_EXP is a function call on Win32. */
2374 const char *const raw_sitelib = SITELIB_EXP;
2376 /* process .../.. if PERL_RELOCATABLE_INC is defined */
2377 SV *sitelib_sv = mayberelocate(raw_sitelib, strlen(raw_sitelib),
2378 INCPUSH_CAN_RELOCATE);
2379 const char *const sitelib = SvPVX(sitelib_sv);
2380 (void)Perl_av_create_and_unshift_one(aTHX_ &PL_preambleav,
2382 "BEGIN { do {local $!; -f q%c%s/sitecustomize.pl%c} && do q%c%s/sitecustomize.pl%c }",
2383 0, SVfARG(sitelib), 0,
2384 0, SVfARG(sitelib), 0));
2385 assert (SvREFCNT(sitelib_sv) == 1);
2386 SvREFCNT_dec(sitelib_sv);
2393 scriptname = argv[0];
2396 scriptname = BIT_BUCKET; /* don't look for script or read stdin */
2398 else if (scriptname == NULL) {
2400 if ( PerlLIO_isatty(PerlIO_fileno(PerlIO_stdin())) )
2406 assert (!TAINT_get);
2410 bool suidscript = FALSE;
2412 rsfp = open_script(scriptname, dosearch, &suidscript);
2414 rsfp = PerlIO_stdin();
2415 lex_start_flags = LEX_DONT_CLOSE_RSFP;
2418 validate_suid(rsfp);
2421 # if defined(SIGCHLD) || defined(SIGCLD)
2424 # define SIGCHLD SIGCLD
2426 Sighandler_t sigstate = rsignal_state(SIGCHLD);
2427 if (sigstate == (Sighandler_t) SIG_IGN) {
2428 Perl_ck_warner(aTHX_ packWARN(WARN_SIGNAL),
2429 "Can't ignore signal CHLD, forcing to default");
2430 (void)rsignal(SIGCHLD, (Sighandler_t)SIG_DFL);
2438 /* This will croak if suidscript is true, as -x cannot be used with
2440 forbid_setid('x', suidscript);
2441 /* Hence you can't get here if suidscript is true */
2443 linestr_sv = newSV_type(SVt_PV);
2444 lex_start_flags |= LEX_START_COPIED;
2445 find_beginning(linestr_sv, rsfp);
2446 if (cddir && PerlDir_chdir( (char *)cddir ) < 0)
2447 Perl_croak(aTHX_ "Can't chdir to %s",cddir);
2451 PL_main_cv = PL_compcv = MUTABLE_CV(newSV_type(SVt_PVCV));
2452 CvUNIQUE_on(PL_compcv);
2454 CvPADLIST_set(PL_compcv, pad_new(0));
2456 PL_isarev = newHV();
2459 boot_core_UNIVERSAL();
2461 newXS("Internals::V", S_Internals_V, __FILE__);
2464 (*xsinit)(aTHX); /* in case linked C routines want magical variables */
2466 #if defined(VMS) || defined(WIN32) || defined(DJGPP) || defined(__CYGWIN__)
2472 # ifdef HAS_SOCKS5_INIT
2473 socks5_init(argv[0]);
2479 init_predump_symbols();
2480 /* init_postdump_symbols not currently designed to be called */
2481 /* more than once (ENV isn't cleared first, for example) */
2482 /* But running with -u leaves %ENV & @ARGV undefined! XXX */
2484 init_postdump_symbols(argc,argv,env);
2486 /* PL_unicode is turned on by -C, or by $ENV{PERL_UNICODE},
2487 * or explicitly in some platforms.
2488 * PL_utf8locale is conditionally turned on by
2489 * locale.c:Perl_init_i18nl10n() if the environment
2490 * look like the user wants to use UTF-8. */
2491 # ifndef PERL_IS_MINIPERL
2493 /* Requires init_predump_symbols(). */
2494 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
2499 /* Turn on UTF-8-ness on STDIN, STDOUT, STDERR
2500 * and the default open disciplines. */
2501 if ((PL_unicode & PERL_UNICODE_STDIN_FLAG) &&
2502 PL_stdingv && (io = GvIO(PL_stdingv)) &&
2504 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2505 if ((PL_unicode & PERL_UNICODE_STDOUT_FLAG) &&
2506 PL_defoutgv && (io = GvIO(PL_defoutgv)) &&
2508 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2509 if ((PL_unicode & PERL_UNICODE_STDERR_FLAG) &&
2510 PL_stderrgv && (io = GvIO(PL_stderrgv)) &&
2512 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2513 if ((PL_unicode & PERL_UNICODE_INOUT_FLAG) &&
2514 (sv = GvSV(gv_fetchpvs("\017PEN", GV_ADD|GV_NOTQUAL,
2516 U32 in = PL_unicode & PERL_UNICODE_IN_FLAG;
2517 U32 out = PL_unicode & PERL_UNICODE_OUT_FLAG;
2520 sv_setpvs(sv, ":utf8\0:utf8");
2522 sv_setpvs(sv, ":utf8\0");
2525 sv_setpvs(sv, "\0:utf8");
2534 if ((s = PerlEnv_getenv("PERL_SIGNALS"))) {
2535 if (strEQ(s, "unsafe"))
2536 PL_signals |= PERL_SIGNALS_UNSAFE_FLAG;
2537 else if (strEQ(s, "safe"))
2538 PL_signals &= ~PERL_SIGNALS_UNSAFE_FLAG;
2540 Perl_croak(aTHX_ "PERL_SIGNALS illegal: \"%s\"", s);
2545 lex_start(linestr_sv, rsfp, lex_start_flags);
2546 SvREFCNT_dec(linestr_sv);
2548 PL_subname = newSVpvs("main");
2550 if (add_read_e_script)
2551 filter_add(read_e_script, NULL);
2553 /* now parse the script */
2554 if (minus_e == FALSE)
2555 PL_hints |= HINTS_DEFAULT; /* after init_main_stash ; need to be after init_predump_symbols */
2557 SETERRNO(0,SS_NORMAL);
2558 if (yyparse(GRAMPROG) || PL_parser->error_count) {
2559 abort_execution("", PL_origfilename);
2561 CopLINE_set(PL_curcop, 0);
2562 SET_CURSTASH(PL_defstash);
2564 SvREFCNT_dec(PL_e_script);
2572 SAVECOPFILE(PL_curcop);
2573 SAVECOPLINE(PL_curcop);
2574 gv_check(PL_defstash);
2584 s = PerlEnv_getenv("PERL_DEBUG_MSTATS");
2585 if (s && grok_atoUV(s, &uv, NULL) && uv >= 2)
2586 dump_mstats("after compilation:");
2591 PL_restartjmpenv = NULL;
2597 =for apidoc perl_run
2599 Tells a Perl interpreter to run its main program. See L<perlembed>
2602 C<my_perl> points to the Perl interpreter. It must have been previously
2603 created through the use of L</perl_alloc> and L</perl_construct>, and
2604 initialised through L</perl_parse>. This function should not be called
2605 if L</perl_parse> returned a non-zero value, indicating a failure in
2606 initialisation or compilation.
2608 This function executes code in C<INIT> blocks, and then executes the
2609 main program. The code to be executed is that established by the prior
2610 call to L</perl_parse>. If the interpreter's C<PL_exit_flags> word
2611 does not have the C<PERL_EXIT_DESTRUCT_END> flag set, then this function
2612 will also execute code in C<END> blocks. If it is desired to make any
2613 further use of the interpreter after calling this function, then C<END>
2614 blocks should be postponed to L</perl_destruct> time by setting that flag.
2616 Returns an integer of slightly tricky interpretation. The correct use
2617 of the return value is as a truth value indicating whether the program
2618 terminated non-locally. If zero is returned, this indicates that
2619 the program ran to completion, and it is safe to make other use of the
2620 interpreter (provided that the C<PERL_EXIT_DESTRUCT_END> flag was set as
2621 described above). If a non-zero value is returned, this indicates that
2622 the interpreter wants to terminate early. The interpreter should not be
2623 just abandoned because of this desire to terminate; the caller should
2624 proceed to shut the interpreter down cleanly with L</perl_destruct>
2625 and free it with L</perl_free>.
2627 For historical reasons, the non-zero return value also attempts to
2628 be a suitable value to pass to the C library function C<exit> (or to
2629 return from C<main>), to serve as an exit code indicating the nature of
2630 the way the program terminated. However, this isn't portable, due to
2631 differing exit code conventions. An attempt is made to return an exit
2632 code of the type required by the host operating system, but because
2633 it is constrained to be non-zero, it is not necessarily possible to
2634 indicate every type of exit. It is only reliable on Unix, where a zero
2635 exit code can be augmented with a set bit that will be ignored. In any
2636 case, this function is not the correct place to acquire an exit code:
2637 one should get that from L</perl_destruct>.
2649 PERL_ARGS_ASSERT_PERL_RUN;
2650 #ifndef MULTIPLICITY
2651 PERL_UNUSED_ARG(my_perl);
2654 oldscope = PL_scopestack_ix;
2662 cxstack_ix = -1; /* start context stack again */
2664 case 0: /* normal completion */
2668 case 2: /* my_exit() */
2669 while (PL_scopestack_ix > oldscope)
2672 SET_CURSTASH(PL_defstash);
2673 if (!(PL_exit_flags & PERL_EXIT_DESTRUCT_END) &&
2674 PL_endav && !PL_minus_c) {
2675 PERL_SET_PHASE(PERL_PHASE_END);
2676 call_list(oldscope, PL_endav);
2679 if (PerlEnv_getenv("PERL_DEBUG_MSTATS"))
2680 dump_mstats("after execution: ");
2686 POPSTACK_TO(PL_mainstack);
2689 PerlIO_printf(Perl_error_log, "panic: restartop in perl_run\n");
2700 S_run_body(pTHX_ I32 oldscope)
2702 DEBUG_r(PerlIO_printf(Perl_debug_log, "%s $` $& $' support (0x%x).\n",
2703 PL_sawampersand ? "Enabling" : "Omitting",
2704 (unsigned int)(PL_sawampersand)));
2706 if (!PL_restartop) {
2708 if (DEBUG_x_TEST || DEBUG_B_TEST)
2709 dump_all_perl(!DEBUG_B_TEST);
2711 PERL_DEBUG(PerlIO_printf(Perl_debug_log, "\nEXECUTING...\n\n"));
2715 PerlIO_printf(Perl_error_log, "%s syntax OK\n", PL_origfilename);
2718 if (PERLDB_SINGLE && PL_DBsingle)
2721 PERL_SET_PHASE(PERL_PHASE_INIT);
2722 call_list(oldscope, PL_initav);
2724 #ifdef PERL_DEBUG_READONLY_OPS
2725 if (PL_main_root && PL_main_root->op_slabbed)
2726 Slab_to_ro(OpSLAB(PL_main_root));
2732 PERL_SET_PHASE(PERL_PHASE_RUN);
2735 PL_restartjmpenv = NULL;
2736 PL_op = PL_restartop;
2740 else if (PL_main_start) {
2741 CvDEPTH(PL_main_cv) = 1;
2742 PL_op = PL_main_start;
2746 NOT_REACHED; /* NOTREACHED */
2750 =for apidoc_section $SV
2754 Returns the SV of the specified Perl scalar. C<flags> are passed to
2755 C<gv_fetchpv>. If C<GV_ADD> is set and the
2756 Perl variable does not exist then it will be created. If C<flags> is zero
2757 and the variable does not exist then NULL is returned.
2763 Perl_get_sv(pTHX_ const char *name, I32 flags)
2767 PERL_ARGS_ASSERT_GET_SV;
2769 gv = gv_fetchpv(name, flags, SVt_PV);
2776 =for apidoc_section $AV
2780 Returns the AV of the specified Perl global or package array with the given
2781 name (so it won't work on lexical variables). C<flags> are passed
2782 to C<gv_fetchpv>. If C<GV_ADD> is set and the
2783 Perl variable does not exist then it will be created. If C<flags> is zero
2784 and the variable does not exist then NULL is returned.
2786 Perl equivalent: C<@{"$name"}>.
2792 Perl_get_av(pTHX_ const char *name, I32 flags)
2794 GV* const gv = gv_fetchpv(name, flags, SVt_PVAV);
2796 PERL_ARGS_ASSERT_GET_AV;
2806 =for apidoc_section $HV
2810 Returns the HV of the specified Perl hash. C<flags> are passed to
2811 C<gv_fetchpv>. If C<GV_ADD> is set and the
2812 Perl variable does not exist then it will be created. If C<flags> is zero
2813 and the variable does not exist then C<NULL> is returned.
2819 Perl_get_hv(pTHX_ const char *name, I32 flags)
2821 GV* const gv = gv_fetchpv(name, flags, SVt_PVHV);
2823 PERL_ARGS_ASSERT_GET_HV;
2833 =for apidoc_section $CV
2836 =for apidoc_item |CV *|get_cvs|"string"|I32 flags
2837 =for apidoc_item get_cvn_flags
2839 These return the CV of the specified Perl subroutine. C<flags> are passed to
2840 C<gv_fetchpvn_flags>. If C<GV_ADD> is set and the Perl subroutine does not
2841 exist then it will be declared (which has the same effect as saying
2842 C<sub name;>). If C<GV_ADD> is not set and the subroutine does not exist,
2843 then NULL is returned.
2845 The forms differ only in how the subroutine is specified.. With C<get_cvs>,
2846 the name is a literal C string, enclosed in double quotes. With C<get_cv>, the
2847 name is given by the C<name> parameter, which must be a NUL-terminated C
2848 string. With C<get_cvn_flags>, the name is also given by the C<name>
2849 parameter, but it is a Perl string (possibly containing embedded NUL bytes),
2850 and its length in bytes is contained in the C<len> parameter.
2852 =for apidoc Amnh||GV_ADD
2858 Perl_get_cvn_flags(pTHX_ const char *name, STRLEN len, I32 flags)
2860 GV* const gv = gv_fetchpvn_flags(name, len, flags, SVt_PVCV);
2862 PERL_ARGS_ASSERT_GET_CVN_FLAGS;
2864 if (gv && UNLIKELY(SvROK(gv)) && SvTYPE(SvRV((SV *)gv)) == SVt_PVCV)
2865 return (CV*)SvRV((SV *)gv);
2867 /* XXX this is probably not what they think they're getting.
2868 * It has the same effect as "sub name;", i.e. just a forward
2870 if ((flags & ~GV_NOADD_MASK) && !GvCVu(gv)) {
2871 return newSTUB(gv,0);
2878 /* Nothing in core calls this now, but we can't replace it with a macro and
2879 move it to mathoms.c as a macro would evaluate name twice. */
2881 Perl_get_cv(pTHX_ const char *name, I32 flags)
2883 PERL_ARGS_ASSERT_GET_CV;
2885 return get_cvn_flags(name, strlen(name), flags);
2888 /* Be sure to refetch the stack pointer after calling these routines. */
2892 =for apidoc_section $callback
2894 =for apidoc call_argv
2896 Performs a callback to the specified named and package-scoped Perl subroutine
2897 with C<argv> (a C<NULL>-terminated array of strings) as arguments. See
2900 Approximate Perl equivalent: C<&{"$sub_name"}(@$argv)>.
2906 Perl_call_argv(pTHX_ const char *sub_name, I32 flags, char **argv)
2908 /* See G_* flags in cop.h */
2909 /* null terminated arg list */
2913 PERL_ARGS_ASSERT_CALL_ARGV;
2917 mXPUSHs(newSVpv(*argv,0));
2921 return call_pv(sub_name, flags);
2927 Performs a callback to the specified Perl sub. See L<perlcall>.
2933 Perl_call_pv(pTHX_ const char *sub_name, I32 flags)
2934 /* name of the subroutine */
2935 /* See G_* flags in cop.h */
2937 PERL_ARGS_ASSERT_CALL_PV;
2939 return call_sv(MUTABLE_SV(get_cv(sub_name, GV_ADD)), flags);
2943 =for apidoc call_method
2945 Performs a callback to the specified Perl method. The blessed object must
2946 be on the stack. See L<perlcall>.
2952 Perl_call_method(pTHX_ const char *methname, I32 flags)
2953 /* name of the subroutine */
2954 /* See G_* flags in cop.h */
2958 PERL_ARGS_ASSERT_CALL_METHOD;
2960 len = strlen(methname);
2961 sv = flags & G_METHOD_NAMED
2962 ? sv_2mortal(newSVpvn_share(methname, len,0))
2963 : newSVpvn_flags(methname, len, SVs_TEMP);
2965 return call_sv(sv, flags | G_METHOD);
2968 /* May be called with any of a CV, a GV, or an SV containing the name. */
2972 Performs a callback to the Perl sub specified by the SV.
2974 If neither the C<G_METHOD> nor C<G_METHOD_NAMED> flag is supplied, the
2975 SV may be any of a CV, a GV, a reference to a CV, a reference to a GV
2976 or C<SvPV(sv)> will be used as the name of the sub to call.
2978 If the C<G_METHOD> flag is supplied, the SV may be a reference to a CV or
2979 C<SvPV(sv)> will be used as the name of the method to call.
2981 If the C<G_METHOD_NAMED> flag is supplied, C<SvPV(sv)> will be used as
2982 the name of the method to call.
2984 Some other values are treated specially for internal use and should
2989 =for apidoc Amnh||G_METHOD
2990 =for apidoc Amnh||G_METHOD_NAMED
2996 Perl_call_sv(pTHX_ SV *sv, volatile I32 flags)
2997 /* See G_* flags in cop.h */
2999 LOGOP myop; /* fake syntax tree node */
3002 volatile I32 retval = 0;
3003 bool oldcatch = CATCH_GET;
3005 OP* const oldop = PL_op;
3008 PERL_ARGS_ASSERT_CALL_SV;
3010 if (flags & G_DISCARD) {
3014 if (!(flags & G_WANT)) {
3015 /* Backwards compatibility - as G_SCALAR was 0, it could be omitted.
3020 Zero(&myop, 1, LOGOP);
3021 if (!(flags & G_NOARGS))
3022 myop.op_flags |= OPf_STACKED;
3023 myop.op_flags |= OP_GIMME_REVERSE(flags);
3027 if (!(flags & G_METHOD_NAMED)) {
3035 if (PERLDB_SUB && PL_curstash != PL_debstash
3036 /* Handle first BEGIN of -d. */
3037 && (PL_DBcv || (PL_DBcv = GvCV(PL_DBsub)))
3038 /* Try harder, since this may have been a sighandler, thus
3039 * curstash may be meaningless. */
3040 && (SvTYPE(sv) != SVt_PVCV || CvSTASH((const CV *)sv) != PL_debstash)
3041 && !(flags & G_NODEBUG))
3042 myop.op_private |= OPpENTERSUB_DB;
3044 if (flags & (G_METHOD|G_METHOD_NAMED)) {
3045 Zero(&method_op, 1, METHOP);
3046 method_op.op_next = (OP*)&myop;
3047 PL_op = (OP*)&method_op;
3048 if ( flags & G_METHOD_NAMED ) {
3049 method_op.op_ppaddr = PL_ppaddr[OP_METHOD_NAMED];
3050 method_op.op_type = OP_METHOD_NAMED;
3051 method_op.op_u.op_meth_sv = sv;
3053 method_op.op_ppaddr = PL_ppaddr[OP_METHOD];
3054 method_op.op_type = OP_METHOD;
3056 myop.op_ppaddr = PL_ppaddr[OP_ENTERSUB];
3057 myop.op_type = OP_ENTERSUB;
3060 if (!(flags & G_EVAL)) {
3062 CALL_BODY_SUB((OP*)&myop);
3063 retval = PL_stack_sp - (PL_stack_base + oldmark);
3064 CATCH_SET(oldcatch);
3068 myop.op_other = (OP*)&myop;
3070 old_cxix = cxstack_ix;
3071 create_eval_scope(NULL, flags|G_FAKINGEVAL);
3079 CALL_BODY_SUB((OP*)&myop);
3080 retval = PL_stack_sp - (PL_stack_base + oldmark);
3081 if (!(flags & G_KEEPERR)) {
3089 /* my_exit() was called */
3090 SET_CURSTASH(PL_defstash);
3094 NOT_REACHED; /* NOTREACHED */
3097 PL_restartjmpenv = NULL;
3098 PL_op = PL_restartop;
3102 PL_stack_sp = PL_stack_base + oldmark;
3103 if ((flags & G_WANT) == G_ARRAY)
3107 *++PL_stack_sp = &PL_sv_undef;
3112 /* if we croaked, depending on how we croaked the eval scope
3113 * may or may not have already been popped */
3114 if (cxstack_ix > old_cxix) {
3115 assert(cxstack_ix == old_cxix + 1);
3116 assert(CxTYPE(CX_CUR()) == CXt_EVAL);
3117 delete_eval_scope();
3122 if (flags & G_DISCARD) {
3123 PL_stack_sp = PL_stack_base + oldmark;
3132 /* Eval a string. The G_EVAL flag is always assumed. */
3137 Tells Perl to C<eval> the string in the SV. It supports the same flags
3138 as C<call_sv>, with the obvious exception of C<G_EVAL>. See L<perlcall>.
3140 The C<G_RETHROW> flag can be used if you only need eval_sv() to
3141 execute code specified by a string, but not catch any errors.
3143 =for apidoc Amnh||G_RETHROW
3148 Perl_eval_sv(pTHX_ SV *sv, I32 flags)
3150 /* See G_* flags in cop.h */
3152 UNOP myop; /* fake syntax tree node */
3153 volatile I32 oldmark;
3154 volatile I32 retval = 0;
3156 OP* const oldop = PL_op;
3159 PERL_ARGS_ASSERT_EVAL_SV;
3161 if (flags & G_DISCARD) {
3168 Zero(&myop, 1, UNOP);
3171 oldmark = SP - PL_stack_base;
3177 if (!(flags & G_NOARGS))
3178 myop.op_flags = OPf_STACKED;
3179 myop.op_type = OP_ENTEREVAL;
3180 myop.op_flags |= OP_GIMME_REVERSE(flags);
3181 if (flags & G_KEEPERR)
3182 myop.op_flags |= OPf_SPECIAL;
3184 if (flags & G_RE_REPARSING)
3185 myop.op_private = (OPpEVAL_COPHH | OPpEVAL_RE_REPARSING);
3187 /* fail now; otherwise we could fail after the JMPENV_PUSH but
3188 * before a cx_pusheval(), which corrupts the stack after a croak */
3189 TAINT_PROPER("eval_sv()");
3195 if (PL_op == (OP*)(&myop)) {
3196 PL_op = PL_ppaddr[OP_ENTEREVAL](aTHX);
3198 goto fail; /* failed in compilation */
3201 retval = PL_stack_sp - (PL_stack_base + oldmark);
3202 if (!(flags & G_KEEPERR)) {
3210 /* my_exit() was called */
3211 SET_CURSTASH(PL_defstash);
3215 NOT_REACHED; /* NOTREACHED */
3218 PL_restartjmpenv = NULL;
3219 PL_op = PL_restartop;
3224 if (flags & G_RETHROW) {
3229 PL_stack_sp = PL_stack_base + oldmark;
3230 if ((flags & G_WANT) == G_ARRAY)
3234 *++PL_stack_sp = &PL_sv_undef;
3240 if (flags & G_DISCARD) {
3241 PL_stack_sp = PL_stack_base + oldmark;
3253 Tells Perl to C<eval> the given string in scalar context and return an SV* result.
3259 Perl_eval_pv(pTHX_ const char *p, I32 croak_on_error)
3261 SV* sv = newSVpv(p, 0);
3263 PERL_ARGS_ASSERT_EVAL_PV;
3265 if (croak_on_error) {
3267 eval_sv(sv, G_SCALAR | G_RETHROW);
3270 eval_sv(sv, G_SCALAR);
3283 /* Require a module. */
3286 =for apidoc_section $embedding
3288 =for apidoc require_pv
3290 Tells Perl to C<require> the file named by the string argument. It is
3291 analogous to the Perl code C<eval "require '$file'">. It's even
3292 implemented that way; consider using load_module instead.
3297 Perl_require_pv(pTHX_ const char *pv)
3302 PERL_ARGS_ASSERT_REQUIRE_PV;
3304 PUSHSTACKi(PERLSI_REQUIRE);
3305 sv = Perl_newSVpvf(aTHX_ "require q%c%s%c", 0, pv, 0);
3306 eval_sv(sv_2mortal(sv), G_DISCARD);
3311 S_usage(pTHX) /* XXX move this out into a module ? */
3313 /* This message really ought to be max 23 lines.
3314 * Removed -h because the user already knows that option. Others? */
3316 /* Grouped as 6 lines per C string literal, to keep under the ANSI C 89
3317 minimum of 509 character string literals. */
3318 static const char * const usage_msg[] = {
3319 " -0[octal/hexadecimal] specify record separator (\\0, if no argument)\n"
3320 " -a autosplit mode with -n or -p (splits $_ into @F)\n"
3321 " -C[number/list] enables the listed Unicode features\n"
3322 " -c check syntax only (runs BEGIN and CHECK blocks)\n"
3323 " -d[t][:MOD] run program under debugger or module Devel::MOD\n"
3324 " -D[number/letters] set debugging flags (argument is a bit mask or alphabets)\n",
3325 " -e commandline one line of program (several -e's allowed, omit programfile)\n"
3326 " -E commandline like -e, but enables all optional features\n"
3327 " -f don't do $sitelib/sitecustomize.pl at startup\n"
3328 " -F/pattern/ split() pattern for -a switch (//'s are optional)\n"
3329 " -i[extension] edit <> files in place (makes backup if extension supplied)\n"
3330 " -Idirectory specify @INC/#include directory (several -I's allowed)\n",
3331 " -l[octnum] enable line ending processing, specifies line terminator\n"
3332 " -[mM][-]module execute \"use/no module...\" before executing program\n"
3333 " -n assume \"while (<>) { ... }\" loop around program\n"
3334 " -p assume loop like -n but print line also, like sed\n"
3335 " -s enable rudimentary parsing for switches after programfile\n"
3336 " -S look for programfile using PATH environment variable\n",
3337 " -t enable tainting warnings\n"
3338 " -T enable tainting checks\n"
3339 " -u dump core after parsing program\n"
3340 " -U allow unsafe operations\n"
3341 " -v print version, patchlevel and license\n"
3342 " -V[:configvar] print configuration summary (or a single Config.pm variable)\n",
3343 " -w enable many useful warnings\n"
3344 " -W enable all warnings\n"
3345 " -x[directory] ignore text before #!perl line (optionally cd to directory)\n"
3346 " -X disable all warnings\n"
3348 "Run 'perldoc perl' for more help with Perl.\n\n",
3351 const char * const *p = usage_msg;
3352 PerlIO *out = PerlIO_stdout();
3355 "\nUsage: %s [switches] [--] [programfile] [arguments]\n",
3358 PerlIO_puts(out, *p++);
3362 /* convert a string of -D options (or digits) into an int.
3363 * sets *s to point to the char after the options */
3367 Perl_get_debug_opts(pTHX_ const char **s, bool givehelp)
3369 static const char * const usage_msgd[] = {
3370 " Debugging flag values: (see also -d)\n"
3371 " p Tokenizing and parsing (with v, displays parse stack)\n"
3372 " s Stack snapshots (with v, displays all stacks)\n"
3373 " l Context (loop) stack processing\n"
3374 " t Trace execution\n"
3375 " o Method and overloading resolution\n",
3376 " c String/numeric conversions\n"
3377 " P Print profiling info, source file input state\n"
3378 " m Memory and SV allocation\n"
3379 " f Format processing\n"
3380 " r Regular expression parsing and execution\n"
3381 " x Syntax tree dump\n",
3382 " u Tainting checks\n"
3383 " H Hash dump -- usurps values()\n"
3384 " X Scratchpad allocation\n"
3386 " S Op slab allocation\n"
3388 " R Include reference counts of dumped variables (eg when using -Ds)\n",
3389 " J Do not s,t,P-debug (Jump over) opcodes within package DB\n"
3390 " v Verbose: use in conjunction with other flags\n"
3391 " C Copy On Write\n"
3392 " A Consistency checks on internal structures\n"
3393 " q quiet - currently only suppresses the 'EXECUTING' message\n"
3394 " M trace smart match resolution\n"
3395 " B dump suBroutine definitions, including special Blocks like BEGIN\n",
3396 " L trace some locale setting information--for Perl core development\n",
3397 " i trace PerlIO layer processing\n",
3398 " y trace y///, tr/// compilation and execution\n",
3403 PERL_ARGS_ASSERT_GET_DEBUG_OPTS;
3406 /* if adding extra options, remember to update DEBUG_MASK */
3407 static const char debopts[] = "psltocPmfrxuUHXDSTRJvCAqMBLiy";
3409 for (; isWORDCHAR(**s); (*s)++) {
3410 const char * const d = strchr(debopts,**s);
3412 uv |= 1 << (d - debopts);
3413 else if (ckWARN_d(WARN_DEBUGGING))
3414 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3415 "invalid option -D%c, use -D'' to see choices\n", **s);
3418 else if (isDIGIT(**s)) {
3419 const char* e = *s + strlen(*s);
3420 if (grok_atoUV(*s, &uv, &e))
3422 for (; isWORDCHAR(**s); (*s)++) ;
3424 else if (givehelp) {
3425 const char *const *p = usage_msgd;
3426 while (*p) PerlIO_puts(PerlIO_stdout(), *p++);
3428 return (int)uv; /* ignore any UV->int conversion loss */
3432 /* This routine handles any switches that can be given during run */
3435 Perl_moreswitches(pTHX_ const char *s)
3438 const char option = *s; /* used to remember option in -m/-M code */
3440 PERL_ARGS_ASSERT_MORESWITCHES;
3448 SvREFCNT_dec(PL_rs);
3449 if (s[1] == 'x' && s[2]) {
3450 const char *e = s+=2;
3456 flags = PERL_SCAN_SILENT_ILLDIGIT;
3457 rschar = (U32)grok_hex(s, &numlen, &flags, NULL);
3458 if (s + numlen < e) {
3459 rschar = 0; /* Grandfather -0xFOO as -0 -xFOO. */
3463 PL_rs = newSVpvs("");
3464 tmps = (U8*) SvGROW(PL_rs, (STRLEN)(UVCHR_SKIP(rschar) + 1));
3465 uvchr_to_utf8(tmps, rschar);
3466 SvCUR_set(PL_rs, UVCHR_SKIP(rschar));
3471 rschar = (U32)grok_oct(s, &numlen, &flags, NULL);
3472 if (rschar & ~((U8)~0))
3473 PL_rs = &PL_sv_undef;
3474 else if (!rschar && numlen >= 2)
3475 PL_rs = newSVpvs("");
3477 char ch = (char)rschar;
3478 PL_rs = newSVpvn(&ch, 1);
3481 sv_setsv(get_sv("/", GV_ADD), PL_rs);
3486 PL_unicode = parse_unicode_opts( (const char **)&s );
3487 if (PL_unicode & PERL_UNICODE_UTF8CACHEASSERT_FLAG)
3495 while (*s && !isSPACE(*s)) ++s;
3496 PL_splitstr = savepvn(PL_splitstr, s - PL_splitstr);
3508 forbid_setid('d', FALSE);
3511 /* -dt indicates to the debugger that threads will be used */
3512 if (*s == 't' && !isWORDCHAR(s[1])) {
3514 my_setenv("PERL5DB_THREADED", "1");
3517 /* The following permits -d:Mod to accepts arguments following an =
3518 in the fashion that -MSome::Mod does. */
3519 if (*s == ':' || *s == '=') {
3526 sv = newSVpvs("no Devel::");
3528 sv = newSVpvs("use Devel::");
3532 end = s + strlen(s);
3534 /* We now allow -d:Module=Foo,Bar and -d:-Module */
3535 while(isWORDCHAR(*s) || *s==':') ++s;
3537 sv_catpvn(sv, start, end - start);
3539 sv_catpvn(sv, start, s-start);
3540 /* Don't use NUL as q// delimiter here, this string goes in the
3542 Perl_sv_catpvf(aTHX_ sv, " split(/,/,q{%s});", ++s);
3545 my_setenv("PERL5DB", SvPV_nolen_const(sv));
3549 PL_perldb = PERLDB_ALL;
3556 forbid_setid('D', FALSE);
3558 PL_debug = get_debug_opts( (const char **)&s, 1) | DEBUG_TOP_FLAG;
3559 #else /* !DEBUGGING */
3560 if (ckWARN_d(WARN_DEBUGGING))
3561 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3562 "Recompile perl with -DDEBUGGING to use -D switch (did you mean -d ?)\n");
3563 for (s++; isWORDCHAR(*s); s++) ;
3566 NOT_REACHED; /* NOTREACHED */
3570 NOT_REACHED; /* NOTREACHED */
3573 Safefree(PL_inplace);
3575 const char * const start = ++s;
3576 while (*s && !isSPACE(*s))
3579 PL_inplace = savepvn(start, s - start);
3582 case 'I': /* -I handled both here and in parse_body() */
3583 forbid_setid('I', FALSE);
3585 while (*s && isSPACE(*s))
3590 /* ignore trailing spaces (possibly followed by other switches) */
3592 for (e = p; *e && !isSPACE(*e); e++) ;
3596 } while (*p && *p != '-');
3598 INCPUSH_ADD_SUB_DIRS|INCPUSH_ADD_OLD_VERS|INCPUSH_UNSHIFT);
3604 Perl_croak(aTHX_ "No directory specified for -I");
3610 SvREFCNT_dec(PL_ors_sv);
3616 PL_ors_sv = newSVpvs("\n");
3617 numlen = 3 + (*s == '0');
3618 *SvPVX(PL_ors_sv) = (char)grok_oct(s, &numlen, &flags, NULL);
3622 if (RsPARA(PL_rs)) {
3623 PL_ors_sv = newSVpvs("\n\n");
3626 PL_ors_sv = newSVsv(PL_rs);
3631 forbid_setid('M', FALSE); /* XXX ? */
3634 forbid_setid('m', FALSE); /* XXX ? */
3639 const char *use = "use ";
3641 /* -M-foo == 'no foo' */
3642 /* Leading space on " no " is deliberate, to make both
3643 possibilities the same length. */
3644 if (*s == '-') { use = " no "; ++s; }
3645 sv = newSVpvn(use,4);
3647 /* We allow -M'Module qw(Foo Bar)' */
3648 while(isWORDCHAR(*s) || *s==':') {
3657 Perl_croak(aTHX_ "Module name required with -%c option",
3660 Perl_croak(aTHX_ "Invalid module name %.*s with -%c option: "
3661 "contains single ':'",
3662 (int)(s - start), start, option);
3663 end = s + strlen(s);
3665 sv_catpvn(sv, start, end - start);
3666 if (option == 'm') {
3668 Perl_croak(aTHX_ "Can't use '%c' after -mname", *s);
3669 sv_catpvs( sv, " ()");
3672 sv_catpvn(sv, start, s-start);
3673 /* Use NUL as q''-delimiter. */
3674 sv_catpvs(sv, " split(/,/,q\0");
3676 sv_catpvn(sv, s, end - s);
3677 sv_catpvs(sv, "\0)");
3680 Perl_av_create_and_push(aTHX_ &PL_preambleav, sv);
3683 Perl_croak(aTHX_ "Missing argument to -%c", option);
3694 forbid_setid('s', FALSE);
3695 PL_doswitches = TRUE;
3700 #if defined(SILENT_NO_TAINT_SUPPORT)
3701 /* silently ignore */
3702 #elif defined(NO_TAINT_SUPPORT)
3703 Perl_croak_nocontext("This perl was compiled without taint support. "
3704 "Cowardly refusing to run with -t or -T flags");
3712 PL_do_undump = TRUE;
3722 if (! (PL_dowarn & G_WARN_ALL_MASK)) {
3723 PL_dowarn |= G_WARN_ON;
3728 PL_dowarn = G_WARN_ALL_ON|G_WARN_ON;
3729 free_and_set_cop_warnings(&PL_compiling, pWARN_ALL);
3733 PL_dowarn = G_WARN_ALL_OFF;
3734 free_and_set_cop_warnings(&PL_compiling, pWARN_NONE);
3741 if (s[0] == '-') /* Additional switches on #! line. */
3746 #if defined(WIN32) || !defined(PERL_STRICT_CR)
3752 #ifdef ALTERNATE_SHEBANG
3753 case 'S': /* OS/2 needs -S on "extproc" line. */
3756 case 'e': case 'f': case 'x': case 'E':
3757 #ifndef ALTERNATE_SHEBANG
3761 Perl_croak(aTHX_ "Can't emulate -%.1s on #! line",s);
3764 "Unrecognized switch: -%.1s (-h will show valid options)",s
3774 PerlIO * PIO_stdout;
3776 const char * const level_str = "v" PERL_VERSION_STRING;
3777 const STRLEN level_len = sizeof("v" PERL_VERSION_STRING)-1;
3778 #ifdef PERL_PATCHNUM
3780 # ifdef PERL_GIT_UNCOMMITTED_CHANGES
3781 static const char num [] = PERL_PATCHNUM "*";
3783 static const char num [] = PERL_PATCHNUM;
3786 const STRLEN num_len = sizeof(num)-1;
3787 /* A very advanced compiler would fold away the strnEQ
3788 and this whole conditional, but most (all?) won't do it.
3789 SV level could also be replaced by with preprocessor
3792 if (num_len >= level_len && strnEQ(num,level_str,level_len)) {
3793 /* per 46807d8e80, PERL_PATCHNUM is outside of the control
3794 of the interp so it might contain format characters
3796 level = newSVpvn(num, num_len);
3798 level = Perl_newSVpvf_nocontext("%s (%s)", level_str, num);
3802 SV* level = newSVpvn(level_str, level_len);
3803 #endif /* #ifdef PERL_PATCHNUM */
3804 PIO_stdout = PerlIO_stdout();
3805 PerlIO_printf(PIO_stdout,
3806 "\nThis is perl " STRINGIFY(PERL_REVISION)
3807 ", version " STRINGIFY(PERL_VERSION)
3808 ", subversion " STRINGIFY(PERL_SUBVERSION)
3809 " (%" SVf ") built for " ARCHNAME, SVfARG(level)
3811 SvREFCNT_dec_NN(level);
3813 #if defined(LOCAL_PATCH_COUNT)
3814 if (LOCAL_PATCH_COUNT > 0)
3815 PerlIO_printf(PIO_stdout,
3816 "\n(with %d registered patch%s, "
3817 "see perl -V for more detail)",
3819 (LOCAL_PATCH_COUNT!=1) ? "es" : "");
3822 PerlIO_printf(PIO_stdout,
3823 "\n\nCopyright 1987-2021, Larry Wall\n");
3825 PerlIO_printf(PIO_stdout,
3826 "\nMS-DOS port Copyright (c) 1989, 1990, Diomidis Spinellis\n");
3829 PerlIO_printf(PIO_stdout,
3830 "djgpp v2 port (jpl5003c) by Hirofumi Watanabe, 1996\n"
3831 "djgpp v2 port (perl5004+) by Laszlo Molnar, 1997-1999\n");
3834 PerlIO_printf(PIO_stdout,
3835 "\n\nOS/2 port Copyright (c) 1990, 1991, Raymond Chen, Kai Uwe Rommel\n"
3836 "Version 5 port Copyright (c) 1994-2002, Andreas Kaiser, Ilya Zakharevich\n");
3839 PerlIO_printf(PIO_stdout,
3840 "MVS (OS390) port by Mortice Kern Systems, 1997-1999\n");
3843 PerlIO_printf(PIO_stdout,
3844 "Stratus OpenVOS port by Paul.Green@stratus.com, 1997-2013\n");
3847 PerlIO_printf(PIO_stdout,
3848 "BS2000 (POSIX) port by Start Amadeus GmbH, 1998-1999\n");
3850 #ifdef BINARY_BUILD_NOTICE
3851 BINARY_BUILD_NOTICE;
3853 PerlIO_printf(PIO_stdout,
3855 Perl may be copied only under the terms of either the Artistic License or the\n\
3856 GNU General Public License, which may be found in the Perl 5 source kit.\n\n\
3857 Complete documentation for Perl, including FAQ lists, should be found on\n\
3858 this system using \"man perl\" or \"perldoc perl\". If you have access to the\n\
3859 Internet, point your browser at http://www.perl.org/, the Perl Home Page.\n\n");
3863 /* compliments of Tom Christiansen */
3865 /* unexec() can be found in the Gnu emacs distribution */
3866 /* Known to work with -DUNEXEC and using unexelf.c from GNU emacs-20.2 */
3869 #include <lib$routines.h>
3873 Perl_my_unexec(pTHX)
3876 SV * prog = newSVpv(BIN_EXP, 0);
3877 SV * file = newSVpv(PL_origfilename, 0);
3881 sv_catpvs(prog, "/perl");
3882 sv_catpvs(file, ".perldump");
3884 unexec(SvPVX(file), SvPVX(prog), &etext, sbrk(0), 0);
3885 /* unexec prints msg to stderr in case of failure */
3886 PerlProc_exit(status);
3888 PERL_UNUSED_CONTEXT;
3890 lib$signal(SS$_DEBUG); /* ssdef.h #included from vmsish.h */
3891 # elif defined(WIN32) || defined(__CYGWIN__)
3892 Perl_croak_nocontext("dump is not supported");
3894 ABORT(); /* for use with undump */
3899 /* initialize curinterp */
3904 # define PERLVAR(prefix,var,type)
3905 # define PERLVARA(prefix,var,n,type)
3906 # if defined(PERL_IMPLICIT_CONTEXT)
3907 # define PERLVARI(prefix,var,type,init) aTHX->prefix##var = init;
3908 # define PERLVARIC(prefix,var,type,init) aTHX->prefix##var = init;
3910 # define PERLVARI(prefix,var,type,init) PERL_GET_INTERP->var = init;
3911 # define PERLVARIC(prefix,var,type,init) PERL_GET_INTERP->var = init;
3913 # include "intrpvar.h"
3919 # define PERLVAR(prefix,var,type)
3920 # define PERLVARA(prefix,var,n,type)
3921 # define PERLVARI(prefix,var,type,init) PL_##var = init;
3922 # define PERLVARIC(prefix,var,type,init) PL_##var = init;
3923 # include "intrpvar.h"
3933 S_init_main_stash(pTHX)
3938 PL_curstash = PL_defstash = (HV *)SvREFCNT_inc_simple_NN(hv);
3939 /* We know that the string "main" will be in the global shared string
3940 table, so it's a small saving to use it rather than allocate another
3942 PL_curstname = newSVpvs_share("main");
3943 gv = gv_fetchpvs("main::", GV_ADD|GV_NOTQUAL, SVt_PVHV);
3944 /* If we hadn't caused another reference to "main" to be in the shared
3945 string table above, then it would be worth reordering these two,
3946 because otherwise all we do is delete "main" from it as a consequence
3947 of the SvREFCNT_dec, only to add it again with hv_name_set */
3948 SvREFCNT_dec(GvHV(gv));
3949 hv_name_sets(PL_defstash, "main", 0);
3950 GvHV(gv) = MUTABLE_HV(SvREFCNT_inc_simple(PL_defstash));
3952 PL_incgv = gv_HVadd(gv_AVadd(gv_fetchpvs("INC", GV_ADD|GV_NOTQUAL,
3954 SvREFCNT_inc_simple_void(PL_incgv); /* Don't allow it to be freed */
3955 GvMULTI_on(PL_incgv);
3956 PL_hintgv = gv_fetchpvs("\010", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^H */
3957 SvREFCNT_inc_simple_void(PL_hintgv);
3958 GvMULTI_on(PL_hintgv);
3959 PL_defgv = gv_fetchpvs("_", GV_ADD|GV_NOTQUAL, SVt_PVAV);
3960 SvREFCNT_inc_simple_void(PL_defgv);
3961 PL_errgv = gv_fetchpvs("@", GV_ADD|GV_NOTQUAL, SVt_PV);
3962 SvREFCNT_inc_simple_void(PL_errgv);
3963 GvMULTI_on(PL_errgv);
3964 PL_replgv = gv_fetchpvs("\022", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^R */
3965 SvREFCNT_inc_simple_void(PL_replgv);
3966 GvMULTI_on(PL_replgv);
3967 (void)Perl_form(aTHX_ "%240s",""); /* Preallocate temp - for immediate signals. */
3968 #ifdef PERL_DONT_CREATE_GVSV
3969 (void)gv_SVadd(PL_errgv);
3971 sv_grow(ERRSV, 240); /* Preallocate - for immediate signals. */
3973 CopSTASH_set(&PL_compiling, PL_defstash);
3974 PL_debstash = GvHV(gv_fetchpvs("DB::", GV_ADDMULTI, SVt_PVHV));
3975 PL_globalstash = GvHV(gv_fetchpvs("CORE::GLOBAL::", GV_ADDMULTI,
3977 /* We must init $/ before switches are processed. */
3978 sv_setpvs(get_sv("/", GV_ADD), "\n");
3982 S_open_script(pTHX_ const char *scriptname, bool dosearch, bool *suidscript)
3985 PerlIO *rsfp = NULL;
3989 PERL_ARGS_ASSERT_OPEN_SCRIPT;
3992 PL_origfilename = savepvs("-e");
3997 /* if find_script() returns, it returns a malloc()-ed value */
3998 scriptname = PL_origfilename = find_script(scriptname, dosearch, NULL, 1);
3999 s = scriptname + strlen(scriptname);
4001 if (strBEGINs(scriptname, "/dev/fd/")
4002 && isDIGIT(scriptname[8])
4003 && grok_atoUV(scriptname + 8, &uv, &s)
4004 && uv <= PERL_INT_MAX
4009 * Tell apart "normal" usage of fdscript, e.g.
4010 * with bash on FreeBSD:
4011 * perl <( echo '#!perl -DA'; echo 'print "$0\n"')
4012 * from usage in suidperl.
4013 * Does any "normal" usage leave garbage after the number???
4014 * Is it a mistake to use a similar /dev/fd/ construct for
4019 * Be supersafe and do some sanity-checks.
4020 * Still, can we be sure we got the right thing?
4023 Perl_croak(aTHX_ "Wrong syntax (suid) fd script name \"%s\"\n", s);
4026 Perl_croak(aTHX_ "Missing (suid) fd script name\n");
4028 scriptname = savepv(s + 1);
4029 Safefree(PL_origfilename);
4030 PL_origfilename = (char *)scriptname;
4035 CopFILE_free(PL_curcop);
4036 CopFILE_set(PL_curcop, PL_origfilename);
4037 if (*PL_origfilename == '-' && PL_origfilename[1] == '\0')
4038 scriptname = (char *)"";
4039 if (fdscript >= 0) {
4040 rsfp = PerlIO_fdopen(fdscript,PERL_SCRIPT_MODE);
4042 else if (!*scriptname) {
4043 forbid_setid(0, *suidscript);
4047 #ifdef FAKE_BIT_BUCKET
4048 /* This hack allows one not to have /dev/null (or BIT_BUCKET as it
4049 * is called) and still have the "-e" work. (Believe it or not,
4050 * a /dev/null is required for the "-e" to work because source
4051 * filter magic is used to implement it. ) This is *not* a general
4052 * replacement for a /dev/null. What we do here is create a temp
4053 * file (an empty file), open up that as the script, and then
4054 * immediately close and unlink it. Close enough for jazz. */
4055 #define FAKE_BIT_BUCKET_PREFIX "/tmp/perlnull-"
4056 #define FAKE_BIT_BUCKET_SUFFIX "XXXXXXXX"
4057 #define FAKE_BIT_BUCKET_TEMPLATE FAKE_BIT_BUCKET_PREFIX FAKE_BIT_BUCKET_SUFFIX
4058 char tmpname[sizeof(FAKE_BIT_BUCKET_TEMPLATE)] = {
4059 FAKE_BIT_BUCKET_TEMPLATE
4061 const char * const err = "Failed to create a fake bit bucket";
4062 if (strEQ(scriptname, BIT_BUCKET)) {
4063 int tmpfd = Perl_my_mkstemp_cloexec(tmpname);
4065 scriptname = tmpname;
4068 Perl_croak(aTHX_ err);
4071 rsfp = PerlIO_open(scriptname,PERL_SCRIPT_MODE);
4072 #ifdef FAKE_BIT_BUCKET
4073 if ( strBEGINs(scriptname, FAKE_BIT_BUCKET_PREFIX)
4074 && strlen(scriptname) == sizeof(tmpname) - 1)
4078 scriptname = BIT_BUCKET;
4082 /* PSz 16 Sep 03 Keep neat error message */
4084 Perl_croak(aTHX_ "Can't open " BIT_BUCKET ": %s\n", Strerror(errno));
4086 Perl_croak(aTHX_ "Can't open perl script \"%s\": %s\n",
4087 CopFILE(PL_curcop), Strerror(errno));
4089 fd = PerlIO_fileno(rsfp);
4092 (PerlLIO_fstat(fd, &tmpstatbuf) >= 0
4093 && S_ISDIR(tmpstatbuf.st_mode)))
4094 Perl_croak(aTHX_ "Can't open perl script \"%s\": %s\n",
4101 /* In the days of suidperl, we refused to execute a setuid script stored on
4102 * a filesystem mounted nosuid and/or noexec. This meant that we probed for the
4103 * existence of the appropriate filesystem-statting function, and behaved
4104 * accordingly. But even though suidperl is long gone, we must still include
4105 * those probes for the benefit of modules like Filesys::Df, which expect the
4106 * results of those probes to be stored in %Config; see RT#126368. So mention
4107 * the relevant cpp symbols here, to ensure that metaconfig will include their
4108 * probes in the generated Configure:
4110 * I_SYSSTATVFS HAS_FSTATVFS
4112 * I_STATFS HAS_FSTATFS HAS_GETFSSTAT
4113 * I_MNTENT HAS_GETMNTENT HAS_HASMNTOPT
4117 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
4118 /* Don't even need this function. */
4121 S_validate_suid(pTHX_ PerlIO *rsfp)
4123 const Uid_t my_uid = PerlProc_getuid();
4124 const Uid_t my_euid = PerlProc_geteuid();
4125 const Gid_t my_gid = PerlProc_getgid();
4126 const Gid_t my_egid = PerlProc_getegid();
4128 PERL_ARGS_ASSERT_VALIDATE_SUID;
4130 if (my_euid != my_uid || my_egid != my_gid) { /* (suidperl doesn't exist, in fact) */
4131 int fd = PerlIO_fileno(rsfp);
4133 if (fd < 0 || PerlLIO_fstat(fd, &statbuf) < 0) { /* may be either wrapped or real suid */
4134 Perl_croak_nocontext( "Illegal suidscript");
4136 if ((my_euid != my_uid && my_euid == statbuf.st_uid && statbuf.st_mode & S_ISUID)
4138 (my_egid != my_gid && my_egid == statbuf.st_gid && statbuf.st_mode & S_ISGID)
4141 Perl_croak(aTHX_ "YOU HAVEN'T DISABLED SET-ID SCRIPTS IN THE KERNEL YET!\n\
4142 FIX YOUR KERNEL, PUT A C WRAPPER AROUND THIS SCRIPT, OR USE -u AND UNDUMP!\n");
4143 /* not set-id, must be wrapped */
4146 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4149 S_find_beginning(pTHX_ SV* linestr_sv, PerlIO *rsfp)
4154 PERL_ARGS_ASSERT_FIND_BEGINNING;
4156 /* skip forward in input to the real script? */
4159 if ((s = sv_gets(linestr_sv, rsfp, 0)) == NULL)
4160 Perl_croak(aTHX_ "No Perl script found in input\n");
4162 } while (!(*s == '#' && s[1] == '!' && ((s = instr(s,"perl")) || (s = instr(s2,"PERL")))));
4163 PerlIO_ungetc(rsfp, '\n'); /* to keep line count right */
4164 while (*s && !(isSPACE (*s) || *s == '#')) s++;
4166 while (*s == ' ' || *s == '\t') s++;
4168 while (isDIGIT(s2[-1]) || s2[-1] == '-' || s2[-1] == '.'
4169 || s2[-1] == '_') s2--;
4170 if (strBEGINs(s2-4,"perl"))
4171 while ((s = moreswitches(s)))
4180 /* no need to do anything here any more if we don't
4182 #ifndef NO_TAINT_SUPPORT
4183 const Uid_t my_uid = PerlProc_getuid();
4184 const Uid_t my_euid = PerlProc_geteuid();
4185 const Gid_t my_gid = PerlProc_getgid();
4186 const Gid_t my_egid = PerlProc_getegid();
4188 PERL_UNUSED_CONTEXT;
4190 /* Should not happen: */
4191 CHECK_MALLOC_TAINT(my_uid && (my_euid != my_uid || my_egid != my_gid));
4192 TAINTING_set( TAINTING_get | (my_uid && (my_euid != my_uid || my_egid != my_gid)) );
4196 * Should go by suidscript, not uid!=euid: why disallow
4197 * system("ls") in scripts run from setuid things?
4198 * Or, is this run before we check arguments and set suidscript?
4199 * What about SETUID_SCRIPTS_ARE_SECURE_NOW: could we use fdscript then?
4200 * (We never have suidscript, can we be sure to have fdscript?)
4201 * Or must then go by UID checks? See comments in forbid_setid also.
4205 /* This is used very early in the lifetime of the program,
4206 * before even the options are parsed, so PL_tainting has
4207 * not been initialized properly. */
4209 Perl_doing_taint(int argc, char *argv[], char *envp[])
4211 #ifndef PERL_IMPLICIT_SYS
4212 /* If we have PERL_IMPLICIT_SYS we can't call getuid() et alia
4213 * before we have an interpreter-- and the whole point of this
4214 * function is to be called at such an early stage. If you are on
4215 * a system with PERL_IMPLICIT_SYS but you do have a concept of
4216 * "tainted because running with altered effective ids', you'll
4217 * have to add your own checks somewhere in here. The two most
4218 * known samples of 'implicitness' are Win32 and NetWare, neither
4219 * of which has much of concept of 'uids'. */
4220 Uid_t uid = PerlProc_getuid();
4221 Uid_t euid = PerlProc_geteuid();
4222 Gid_t gid = PerlProc_getgid();
4223 Gid_t egid = PerlProc_getegid();
4230 if (uid && (euid != uid || egid != gid))
4232 #endif /* !PERL_IMPLICIT_SYS */
4233 /* This is a really primitive check; environment gets ignored only
4234 * if -T are the first chars together; otherwise one gets
4235 * "Too late" message. */
4236 if ( argc > 1 && argv[1][0] == '-'
4237 && isALPHA_FOLD_EQ(argv[1][1], 't'))
4242 /* Passing the flag as a single char rather than a string is a slight space
4243 optimisation. The only message that isn't /^-.$/ is
4244 "program input from stdin", which is substituted in place of '\0', which
4245 could never be a command line flag. */
4247 S_forbid_setid(pTHX_ const char flag, const bool suidscript) /* g */
4249 char string[3] = "-x";
4250 const char *message = "program input from stdin";
4252 PERL_UNUSED_CONTEXT;
4258 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
4259 if (PerlProc_getuid() != PerlProc_geteuid())
4260 Perl_croak(aTHX_ "No %s allowed while running setuid", message);
4261 if (PerlProc_getgid() != PerlProc_getegid())
4262 Perl_croak(aTHX_ "No %s allowed while running setgid", message);
4263 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4265 Perl_croak(aTHX_ "No %s allowed with (suid) fdscript", message);
4269 Perl_init_dbargs(pTHX)
4271 AV *const args = PL_dbargs = GvAV(gv_AVadd((gv_fetchpvs("DB::args",
4276 /* Someone has already created it.
4277 It might have entries, and if we just turn off AvREAL(), they will
4278 "leak" until global destruction. */
4280 if (SvTIED_mg((const SV *)args, PERL_MAGIC_tied))
4281 Perl_croak(aTHX_ "Cannot set tied @DB::args");
4283 AvREIFY_only(PL_dbargs);
4287 Perl_init_debugger(pTHX)
4289 HV * const ostash = PL_curstash;
4292 PL_curstash = (HV *)SvREFCNT_inc_simple(PL_debstash);
4294 Perl_init_dbargs(aTHX);
4295 PL_DBgv = MUTABLE_GV(
4296 SvREFCNT_inc(gv_fetchpvs("DB::DB", GV_ADDMULTI, SVt_PVGV))
4298 PL_DBline = MUTABLE_GV(
4299 SvREFCNT_inc(gv_fetchpvs("DB::dbline", GV_ADDMULTI, SVt_PVAV))
4301 PL_DBsub = MUTABLE_GV(SvREFCNT_inc(
4302 gv_HVadd(gv_fetchpvs("DB::sub", GV_ADDMULTI, SVt_PVHV))
4304 PL_DBsingle = GvSV((gv_fetchpvs("DB::single", GV_ADDMULTI, SVt_PV)));
4305 if (!SvIOK(PL_DBsingle))
4306 sv_setiv(PL_DBsingle, 0);
4307 mg = sv_magicext(PL_DBsingle, NULL, PERL_MAGIC_debugvar, &PL_vtbl_debugvar, 0, 0);
4308 mg->mg_private = DBVARMG_SINGLE;
4309 SvSETMAGIC(PL_DBsingle);
4311 PL_DBtrace = GvSV((gv_fetchpvs("DB::trace", GV_ADDMULTI, SVt_PV)));
4312 if (!SvIOK(PL_DBtrace))
4313 sv_setiv(PL_DBtrace, 0);
4314 mg = sv_magicext(PL_DBtrace, NULL, PERL_MAGIC_debugvar, &PL_vtbl_debugvar, 0, 0);
4315 mg->mg_private = DBVARMG_TRACE;
4316 SvSETMAGIC(PL_DBtrace);
4318 PL_DBsignal = GvSV((gv_fetchpvs("DB::signal", GV_ADDMULTI, SVt_PV)));
4319 if (!SvIOK(PL_DBsignal))
4320 sv_setiv(PL_DBsignal, 0);
4321 mg = sv_magicext(PL_DBsignal, NULL, PERL_MAGIC_debugvar, &PL_vtbl_debugvar, 0, 0);
4322 mg->mg_private = DBVARMG_SIGNAL;
4323 SvSETMAGIC(PL_DBsignal);
4325 SvREFCNT_dec(PL_curstash);
4326 PL_curstash = ostash;
4329 #ifndef STRESS_REALLOC
4330 #define REASONABLE(size) (size)
4331 #define REASONABLE_but_at_least(size,min) (size)
4333 #define REASONABLE(size) (1) /* unreasonable */
4334 #define REASONABLE_but_at_least(size,min) (min)
4338 Perl_init_stacks(pTHX)
4342 /* start with 128-item stack and 8K cxstack */
4343 PL_curstackinfo = new_stackinfo(REASONABLE(128),
4344 REASONABLE(8192/sizeof(PERL_CONTEXT) - 1));
4345 PL_curstackinfo->si_type = PERLSI_MAIN;
4346 #if defined DEBUGGING && !defined DEBUGGING_RE_ONLY
4347 PL_curstackinfo->si_stack_hwm = 0;
4349 PL_curstack = PL_curstackinfo->si_stack;
4350 PL_mainstack = PL_curstack; /* remember in case we switch stacks */
4352 PL_stack_base = AvARRAY(PL_curstack);
4353 PL_stack_sp = PL_stack_base;
4354 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
4356 Newx(PL_tmps_stack,REASONABLE(128),SV*);
4359 PL_tmps_max = REASONABLE(128);
4361 Newx(PL_markstack,REASONABLE(32),I32);
4362 PL_markstack_ptr = PL_markstack;
4363 PL_markstack_max = PL_markstack + REASONABLE(32);
4367 Newx(PL_scopestack,REASONABLE(32),I32);
4369 Newx(PL_scopestack_name,REASONABLE(32),const char*);
4371 PL_scopestack_ix = 0;
4372 PL_scopestack_max = REASONABLE(32);
4374 size = REASONABLE_but_at_least(128,SS_MAXPUSH);
4375 Newx(PL_savestack, size, ANY);
4376 PL_savestack_ix = 0;
4377 /*PL_savestack_max lies: it always has SS_MAXPUSH more than it claims */
4378 PL_savestack_max = size - SS_MAXPUSH;
4386 while (PL_curstackinfo->si_next)
4387 PL_curstackinfo = PL_curstackinfo->si_next;
4388 while (PL_curstackinfo) {
4389 PERL_SI *p = PL_curstackinfo->si_prev;
4390 /* curstackinfo->si_stack got nuked by sv_free_arenas() */
4391 Safefree(PL_curstackinfo->si_cxstack);
4392 Safefree(PL_curstackinfo);
4393 PL_curstackinfo = p;
4395 Safefree(PL_tmps_stack);
4396 Safefree(PL_markstack);
4397 Safefree(PL_scopestack);
4399 Safefree(PL_scopestack_name);
4401 Safefree(PL_savestack);
4405 Perl_populate_isa(pTHX_ const char *name, STRLEN len, ...)
4407 GV *const gv = gv_fetchpvn(name, len, GV_ADD | GV_ADDMULTI, SVt_PVAV);
4408 AV *const isa = GvAVn(gv);
4411 PERL_ARGS_ASSERT_POPULATE_ISA;
4413 if(AvFILLp(isa) != -1)
4416 /* NOTE: No support for tied ISA */
4418 va_start(args, len);
4420 const char *const parent = va_arg(args, const char*);
4425 parent_len = va_arg(args, size_t);
4427 /* Arguments are supplied with a trailing :: */
4428 assert(parent_len > 2);
4429 assert(parent[parent_len - 1] == ':');
4430 assert(parent[parent_len - 2] == ':');
4431 av_push(isa, newSVpvn(parent, parent_len - 2));
4432 (void) gv_fetchpvn(parent, parent_len, GV_ADD, SVt_PVGV);
4439 S_init_predump_symbols(pTHX)
4444 sv_setpvs(get_sv("\"", GV_ADD), " ");
4445 PL_ofsgv = (GV*)SvREFCNT_inc(gv_fetchpvs(",", GV_ADD|GV_NOTQUAL, SVt_PV));
4448 /* Historically, PVIOs were blessed into IO::Handle, unless
4449 FileHandle was loaded, in which case they were blessed into
4450 that. Action at a distance.
4451 However, if we simply bless into IO::Handle, we break code
4452 that assumes that PVIOs will have (among others) a seek
4453 method. IO::File inherits from IO::Handle and IO::Seekable,
4454 and provides the needed methods. But if we simply bless into
4455 it, then we break code that assumed that by loading
4456 IO::Handle, *it* would work.
4457 So a compromise is to set up the correct @IO::File::ISA,
4458 so that code that does C<use IO::Handle>; will still work.
4461 Perl_populate_isa(aTHX_ STR_WITH_LEN("IO::File::ISA"),
4462 STR_WITH_LEN("IO::Handle::"),
4463 STR_WITH_LEN("IO::Seekable::"),
4464 STR_WITH_LEN("Exporter::"),
4467 PL_stdingv = gv_fetchpvs("STDIN", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4468 GvMULTI_on(PL_stdingv);
4469 io = GvIOp(PL_stdingv);
4470 IoTYPE(io) = IoTYPE_RDONLY;
4471 IoIFP(io) = PerlIO_stdin();
4472 tmpgv = gv_fetchpvs("stdin", GV_ADD|GV_NOTQUAL, SVt_PV);
4474 GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4476 tmpgv = gv_fetchpvs("STDOUT", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4479 IoTYPE(io) = IoTYPE_WRONLY;
4480 IoOFP(io) = IoIFP(io) = PerlIO_stdout();
4482 tmpgv = gv_fetchpvs("stdout", GV_ADD|GV_NOTQUAL, SVt_PV);
4484 GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4486 PL_stderrgv = gv_fetchpvs("STDERR", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4487 GvMULTI_on(PL_stderrgv);
4488 io = GvIOp(PL_stderrgv);
4489 IoTYPE(io) = IoTYPE_WRONLY;
4490 IoOFP(io) = IoIFP(io) = PerlIO_stderr();
4491 tmpgv = gv_fetchpvs("stderr", GV_ADD|GV_NOTQUAL, SVt_PV);
4493 GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4495 PL_statname = newSVpvs(""); /* last filename we did stat on */
4499 Perl_init_argv_symbols(pTHX_ int argc, char **argv)
4501 PERL_ARGS_ASSERT_INIT_ARGV_SYMBOLS;
4503 argc--,argv++; /* skip name of script */
4504 if (PL_doswitches) {
4505 for (; argc > 0 && **argv == '-'; argc--,argv++) {
4509 if (argv[0][1] == '-' && !argv[0][2]) {
4513 if ((s = strchr(argv[0], '='))) {
4514 const char *const start_name = argv[0] + 1;
4515 sv_setpv(GvSV(gv_fetchpvn_flags(start_name, s - start_name,
4516 TRUE, SVt_PV)), s + 1);
4519 sv_setiv(GvSV(gv_fetchpv(argv[0]+1, GV_ADD, SVt_PV)),1);
4522 if ((PL_argvgv = gv_fetchpvs("ARGV", GV_ADD|GV_NOTQUAL, SVt_PVAV))) {
4523 SvREFCNT_inc_simple_void_NN(PL_argvgv);
4524 GvMULTI_on(PL_argvgv);
4525 av_clear(GvAVn(PL_argvgv));
4526 for (; argc > 0; argc--,argv++) {
4527 SV * const sv = newSVpv(argv[0],0);
4528 av_push(GvAV(PL_argvgv),sv);
4529 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
4530 if (PL_unicode & PERL_UNICODE_ARGV_FLAG)
4533 if (PL_unicode & PERL_UNICODE_WIDESYSCALLS_FLAG) /* Sarathy? */
4534 (void)sv_utf8_decode(sv);
4538 if (PL_inplace && (!PL_argvgv || AvFILL(GvAV(PL_argvgv)) == -1))
4539 Perl_ck_warner_d(aTHX_ packWARN(WARN_INPLACE),
4540 "-i used with no filenames on the command line, "
4541 "reading from STDIN");
4545 S_init_postdump_symbols(pTHX_ int argc, char **argv, char **env)
4549 PERL_ARGS_ASSERT_INIT_POSTDUMP_SYMBOLS;
4551 PL_toptarget = newSV_type(SVt_PVIV);
4552 SvPVCLEAR(PL_toptarget);
4553 PL_bodytarget = newSV_type(SVt_PVIV);
4554 SvPVCLEAR(PL_bodytarget);
4555 PL_formtarget = PL_bodytarget;
4559 init_argv_symbols(argc,argv);
4561 if ((tmpgv = gv_fetchpvs("0", GV_ADD|GV_NOTQUAL, SVt_PV))) {
4562 sv_setpv(GvSV(tmpgv),PL_origfilename);
4564 if ((PL_envgv = gv_fetchpvs("ENV", GV_ADD|GV_NOTQUAL, SVt_PVHV))) {
4566 bool env_is_not_environ;
4567 SvREFCNT_inc_simple_void_NN(PL_envgv);
4568 GvMULTI_on(PL_envgv);
4569 hv = GvHVn(PL_envgv);
4570 hv_magic(hv, NULL, PERL_MAGIC_env);
4572 #ifdef USE_ENVIRON_ARRAY
4573 /* Note that if the supplied env parameter is actually a copy
4574 of the global environ then it may now point to free'd memory
4575 if the environment has been modified since. To avoid this
4576 problem we treat env==NULL as meaning 'use the default'
4580 env_is_not_environ = env != environ;
4581 if (env_is_not_environ
4582 # ifdef USE_ITHREADS
4583 && PL_curinterp == aTHX
4595 for (; *env; env++) {
4598 if (!(s = strchr(old_var,'=')) || s == old_var)
4602 #if defined(MSDOS) && !defined(DJGPP)
4604 (void)strupr(old_var);
4607 if (hv_exists(hv, old_var, nlen)) {
4608 const char *name = savepvn(old_var, nlen);
4610 /* make sure we use the same value as getenv(), otherwise code that
4611 uses getenv() (like setlocale()) might see a different value to %ENV
4613 sv = newSVpv(PerlEnv_getenv(name), 0);
4615 /* keep a count of the dups of this name so we can de-dup environ later */
4616 if (hv_exists(dups, name, nlen))
4617 ++SvIVX(*hv_fetch(dups, name, nlen, 0));
4619 (void)hv_store(dups, name, nlen, newSViv(1), 0);
4624 sv = newSVpv(s+1, 0);
4626 (void)hv_store(hv, old_var, nlen, sv, 0);
4627 if (env_is_not_environ)
4631 /* environ has some duplicate definitions, remove them */
4634 while ((entry = hv_iternext_flags(dups, 0))) {
4636 const char *name = HePV(entry, nlen);
4637 IV count = SvIV(HeVAL(entry));
4639 SV **valp = hv_fetch(hv, name, nlen, 0);
4643 /* try to remove any duplicate names, depending on the
4644 * implementation used in my_setenv() the iteration might
4645 * not be necessary, but let's be safe.
4647 for (i = 0; i < count; ++i)
4650 /* and set it back to the value we set $ENV{name} to */
4651 my_setenv(name, SvPV_nolen(*valp));
4654 SvREFCNT_dec_NN(dups);
4656 #endif /* USE_ENVIRON_ARRAY */
4657 #endif /* !PERL_MICRO */
4661 /* touch @F array to prevent spurious warnings 20020415 MJD */
4663 (void) get_av("main::F", GV_ADD | GV_ADDMULTI);
4668 S_init_perllib(pTHX)
4671 const char *perl5lib = NULL;
4674 #if defined(WIN32) && !defined(PERL_IS_MINIPERL)
4678 if (!TAINTING_get) {
4680 perl5lib = PerlEnv_getenv("PERL5LIB");
4682 * It isn't possible to delete an environment variable with
4683 * PERL_USE_SAFE_PUTENV set unless unsetenv() is also available, so in that
4684 * case we treat PERL5LIB as undefined if it has a zero-length value.
4686 #if defined(PERL_USE_SAFE_PUTENV) && ! defined(HAS_UNSETENV)
4687 if (perl5lib && *perl5lib != '\0')
4691 incpush_use_sep(perl5lib, 0, INCPUSH_ADD_SUB_DIRS);
4693 s = PerlEnv_getenv("PERLLIB");
4695 incpush_use_sep(s, 0, 0);
4698 /* Treat PERL5?LIB as a possible search list logical name -- the
4699 * "natural" VMS idiom for a Unix path string. We allow each
4700 * element to be a set of |-separated directories for compatibility.
4704 if (vmstrnenv("PERL5LIB",buf,0,NULL,0))
4706 incpush_use_sep(buf, 0, INCPUSH_ADD_SUB_DIRS);
4707 } while (vmstrnenv("PERL5LIB",buf,++idx,NULL,0));
4709 while (vmstrnenv("PERLLIB",buf,idx++,NULL,0))
4710 incpush_use_sep(buf, 0, 0);
4715 #ifndef PERL_IS_MINIPERL
4716 /* miniperl gets just -I..., the split of $ENV{PERL5LIB}, and "." in @INC
4717 (and not the architecture specific directories from $ENV{PERL5LIB}) */
4719 #include "perl_inc_macro.h"
4720 /* Use the ~-expanded versions of APPLLIB (undocumented),
4721 SITEARCH, SITELIB, VENDORARCH, VENDORLIB, ARCHLIB and PRIVLIB
4724 INCPUSH_SITEARCH_EXP
4726 INCPUSH_PERL_VENDORARCH_EXP
4727 INCPUSH_PERL_VENDORLIB_EXP
4730 INCPUSH_PERL_OTHERLIBDIRS
4732 INCPUSH_APPLLIB_OLD_EXP
4733 INCPUSH_SITELIB_STEM
4734 INCPUSH_PERL_VENDORLIB_STEM
4735 INCPUSH_PERL_OTHERLIBDIRS_ARCHONLY
4737 #endif /* !PERL_IS_MINIPERL */
4739 if (!TAINTING_get) {
4740 #if !defined(PERL_IS_MINIPERL) && defined(DEFAULT_INC_EXCLUDES_DOT)
4741 const char * const unsafe = PerlEnv_getenv("PERL_USE_UNSAFE_INC");
4742 if (unsafe && strEQ(unsafe, "1"))
4744 S_incpush(aTHX_ STR_WITH_LEN("."), 0);
4749 # define PERLLIB_SEP ';'
4750 #elif defined(__VMS)
4751 # define PERLLIB_SEP PL_perllib_sep
4753 # define PERLLIB_SEP ':'
4755 #ifndef PERLLIB_MANGLE
4756 # define PERLLIB_MANGLE(s,n) (s)
4759 #ifndef PERL_IS_MINIPERL
4760 /* Push a directory onto @INC if it exists.
4761 Generate a new SV if we do this, to save needing to copy the SV we push
4764 S_incpush_if_exists(pTHX_ AV *const av, SV *dir, SV *const stem)
4768 PERL_ARGS_ASSERT_INCPUSH_IF_EXISTS;
4770 if (PerlLIO_stat(SvPVX_const(dir), &tmpstatbuf) >= 0 &&
4771 S_ISDIR(tmpstatbuf.st_mode)) {
4773 dir = newSVsv(stem);
4775 /* Truncate dir back to stem. */
4776 SvCUR_set(dir, SvCUR(stem));
4783 S_mayberelocate(pTHX_ const char *const dir, STRLEN len, U32 flags)
4785 const U8 canrelocate = (U8)flags & INCPUSH_CAN_RELOCATE;
4788 PERL_ARGS_ASSERT_MAYBERELOCATE;
4791 /* I am not convinced that this is valid when PERLLIB_MANGLE is
4792 defined to so something (in os2/os2.c), but the code has been
4793 this way, ignoring any possible changed of length, since
4794 760ac839baf413929cd31cc32ffd6dba6b781a81 (5.003_02) so I'll leave
4796 libdir = newSVpvn(PERLLIB_MANGLE(dir, len), len);
4802 if ((unix = tounixspec_ts(SvPV(libdir,len),NULL)) != NULL) {
4804 while (len > 1 && unix[len-1] == '/') len--; /* Cosmetic */
4805 sv_usepvn(libdir,unix,len);
4808 PerlIO_printf(Perl_error_log,
4809 "Failed to unixify @INC element \"%s\"\n",
4810 SvPV_nolen_const(libdir));
4814 /* Do the if() outside the #ifdef to avoid warnings about an unused
4817 #ifdef PERL_RELOCATABLE_INC
4819 * Relocatable include entries are marked with a leading .../
4822 * 0: Remove that leading ".../"
4823 * 1: Remove trailing executable name (anything after the last '/')
4824 * from the perl path to give a perl prefix
4826 * While the @INC element starts "../" and the prefix ends with a real
4827 * directory (ie not . or ..) chop that real directory off the prefix
4828 * and the leading "../" from the @INC element. ie a logical "../"
4830 * Finally concatenate the prefix and the remainder of the @INC element
4831 * The intent is that /usr/local/bin/perl and .../../lib/perl5
4832 * generates /usr/local/lib/perl5
4834 const char *libpath = SvPVX(libdir);
4835 STRLEN libpath_len = SvCUR(libdir);
4836 if (memBEGINs(libpath, libpath_len, ".../")) {
4838 SV * const caret_X = get_sv("\030", 0);
4839 /* Going to use the SV just as a scratch buffer holding a C
4845 /* $^X is *the* source of taint if tainting is on, hence
4846 SvPOK() won't be true. */
4848 assert(SvPOKp(caret_X));
4849 prefix_sv = newSVpvn_flags(SvPVX(caret_X), SvCUR(caret_X),
4851 /* Firstly take off the leading .../
4852 If all else fail we'll do the paths relative to the current
4854 sv_chop(libdir, libpath + 4);
4855 /* Don't use SvPV as we're intentionally bypassing taining,
4856 mortal copies that the mg_get of tainting creates, and
4857 corruption that seems to come via the save stack.
4858 I guess that the save stack isn't correctly set up yet. */
4859 libpath = SvPVX(libdir);
4860 libpath_len = SvCUR(libdir);
4862 prefix = SvPVX(prefix_sv);
4863 lastslash = (char *) my_memrchr(prefix, '/',
4864 SvEND(prefix_sv) - prefix);
4866 /* First time in with the *lastslash = '\0' we just wipe off
4867 the trailing /perl from (say) /usr/foo/bin/perl
4871 while ((*lastslash = '\0'), /* Do that, come what may. */
4872 ( memBEGINs(libpath, libpath_len, "../")
4874 (char *) my_memrchr(prefix, '/',
4875 SvEND(prefix_sv) - prefix))))
4877 if (lastslash[1] == '\0'
4878 || (lastslash[1] == '.'
4879 && (lastslash[2] == '/' /* ends "/." */
4880 || (lastslash[2] == '/'
4881 && lastslash[3] == '/' /* or "/.." */
4883 /* Prefix ends "/" or "/." or "/..", any of which
4884 are fishy, so don't do any more logical cleanup.
4888 /* Remove leading "../" from path */
4891 /* Next iteration round the loop removes the last
4892 directory name from prefix by writing a '\0' in
4893 the while clause. */
4895 /* prefix has been terminated with a '\0' to the correct
4896 length. libpath points somewhere into the libdir SV.
4897 We need to join the 2 with '/' and drop the result into
4899 tempsv = Perl_newSVpvf(aTHX_ "%s/%s", prefix, libpath);
4900 SvREFCNT_dec(libdir);
4901 /* And this is the new libdir. */
4904 (PerlProc_getuid() != PerlProc_geteuid() ||
4905 PerlProc_getgid() != PerlProc_getegid())) {
4906 /* Need to taint relocated paths if running set ID */
4907 SvTAINTED_on(libdir);
4910 SvREFCNT_dec(prefix_sv);
4918 S_incpush(pTHX_ const char *const dir, STRLEN len, U32 flags)
4920 #ifndef PERL_IS_MINIPERL
4921 const U8 using_sub_dirs
4922 = (U8)flags & (INCPUSH_ADD_VERSIONED_SUB_DIRS
4923 |INCPUSH_ADD_ARCHONLY_SUB_DIRS|INCPUSH_ADD_OLD_VERS);
4924 const U8 add_versioned_sub_dirs
4925 = (U8)flags & INCPUSH_ADD_VERSIONED_SUB_DIRS;
4926 const U8 add_archonly_sub_dirs
4927 = (U8)flags & INCPUSH_ADD_ARCHONLY_SUB_DIRS;
4928 #ifdef PERL_INC_VERSION_LIST
4929 const U8 addoldvers = (U8)flags & INCPUSH_ADD_OLD_VERS;
4932 const U8 unshift = (U8)flags & INCPUSH_UNSHIFT;
4933 const U8 push_basedir = (flags & INCPUSH_NOT_BASEDIR) ? 0 : 1;
4934 AV *const inc = GvAVn(PL_incgv);
4936 PERL_ARGS_ASSERT_INCPUSH;
4939 /* Could remove this vestigial extra block, if we don't mind a lot of
4940 re-indenting diff noise. */
4942 SV *const libdir = mayberelocate(dir, len, flags);
4943 /* Change 20189146be79a0596543441fa369c6bf7f85103f, to fix RT#6665,
4944 arranged to unshift #! line -I onto the front of @INC. However,
4945 -I can add version and architecture specific libraries, and they
4946 need to go first. The old code assumed that it was always
4947 pushing. Hence to make it work, need to push the architecture
4948 (etc) libraries onto a temporary array, then "unshift" that onto
4949 the front of @INC. */
4950 #ifndef PERL_IS_MINIPERL
4951 AV *const av = (using_sub_dirs) ? (unshift ? newAV() : inc) : NULL;
4954 * BEFORE pushing libdir onto @INC we may first push version- and
4955 * archname-specific sub-directories.
4957 if (using_sub_dirs) {
4958 SV *subdir = newSVsv(libdir);
4959 #ifdef PERL_INC_VERSION_LIST
4960 /* Configure terminates PERL_INC_VERSION_LIST with a NULL */
4961 const char * const incverlist[] = { PERL_INC_VERSION_LIST };
4962 const char * const *incver;
4965 if (add_versioned_sub_dirs) {
4966 /* .../version/archname if -d .../version/archname */
4967 sv_catpvs(subdir, "/" PERL_FS_VERSION "/" ARCHNAME);
4968 subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
4970 /* .../version if -d .../version */
4971 sv_catpvs(subdir, "/" PERL_FS_VERSION);
4972 subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
4975 #ifdef PERL_INC_VERSION_LIST
4977 for (incver = incverlist; *incver; incver++) {
4978 /* .../xxx if -d .../xxx */
4979 Perl_sv_catpvf(aTHX_ subdir, "/%s", *incver);
4980 subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
4985 if (add_archonly_sub_dirs) {
4986 /* .../archname if -d .../archname */
4987 sv_catpvs(subdir, "/" ARCHNAME);
4988 subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
4992 assert (SvREFCNT(subdir) == 1);
4993 SvREFCNT_dec(subdir);
4995 #endif /* !PERL_IS_MINIPERL */
4996 /* finally add this lib directory at the end of @INC */
4998 #ifdef PERL_IS_MINIPERL
4999 const Size_t extra = 0;
5001 Size_t extra = av_count(av);
5003 av_unshift(inc, extra + push_basedir);
5005 av_store(inc, extra, libdir);
5006 #ifndef PERL_IS_MINIPERL
5008 /* av owns a reference, av_store() expects to be donated a
5009 reference, and av expects to be sane when it's cleared.
5010 If I wanted to be naughty and wrong, I could peek inside the
5011 implementation of av_clear(), realise that it uses
5012 SvREFCNT_dec() too, so av's array could be a run of NULLs,
5013 and so directly steal from it (with a memcpy() to inc, and
5014 then memset() to NULL them out. But people copy code from the
5015 core expecting it to be best practise, so let's use the API.
5016 Although studious readers will note that I'm not checking any
5018 av_store(inc, extra, SvREFCNT_inc(*av_fetch(av, extra, FALSE)));
5023 else if (push_basedir) {
5024 av_push(inc, libdir);
5027 if (!push_basedir) {
5028 assert (SvREFCNT(libdir) == 1);
5029 SvREFCNT_dec(libdir);
5035 S_incpush_use_sep(pTHX_ const char *p, STRLEN len, U32 flags)
5039 /* This logic has been broken out from S_incpush(). It may be possible to
5042 PERL_ARGS_ASSERT_INCPUSH_USE_SEP;
5044 /* perl compiled with -DPERL_RELOCATABLE_INCPUSH will ignore the len
5045 * argument to incpush_use_sep. This allows creation of relocatable
5046 * Perl distributions that patch the binary at install time. Those
5047 * distributions will have to provide their own relocation tools; this
5048 * is not a feature otherwise supported by core Perl.
5050 #ifndef PERL_RELOCATABLE_INCPUSH
5057 /* Break at all separators */
5058 while ((s = (const char*)memchr(p, PERLLIB_SEP, end - p))) {
5060 /* skip any consecutive separators */
5062 /* Uncomment the next line for PATH semantics */
5063 /* But you'll need to write tests */
5064 /* av_push(GvAVn(PL_incgv), newSVpvs(".")); */
5066 incpush(p, (STRLEN)(s - p), flags);
5071 incpush(p, (STRLEN)(end - p), flags);
5076 Perl_call_list(pTHX_ I32 oldscope, AV *paramList)
5079 volatile const line_t oldline = PL_curcop ? CopLINE(PL_curcop) : 0;
5085 PERL_ARGS_ASSERT_CALL_LIST;
5087 while (av_count(paramList) > 0) {
5088 cv = MUTABLE_CV(av_shift(paramList));
5090 if (paramList == PL_beginav) {
5091 /* save PL_beginav for compiler */
5092 Perl_av_create_and_push(aTHX_ &PL_beginav_save, MUTABLE_SV(cv));
5094 else if (paramList == PL_checkav) {
5095 /* save PL_checkav for compiler */
5096 Perl_av_create_and_push(aTHX_ &PL_checkav_save, MUTABLE_SV(cv));
5098 else if (paramList == PL_unitcheckav) {
5099 /* save PL_unitcheckav for compiler */
5100 Perl_av_create_and_push(aTHX_ &PL_unitcheckav_save, MUTABLE_SV(cv));
5110 (void)SvPV_const(atsv, len);
5112 PL_curcop = &PL_compiling;
5113 CopLINE_set(PL_curcop, oldline);
5114 if (paramList == PL_beginav)
5115 sv_catpvs(atsv, "BEGIN failed--compilation aborted");
5117 Perl_sv_catpvf(aTHX_ atsv,
5118 "%s failed--call queue aborted",
5119 paramList == PL_checkav ? "CHECK"
5120 : paramList == PL_initav ? "INIT"
5121 : paramList == PL_unitcheckav ? "UNITCHECK"
5123 while (PL_scopestack_ix > oldscope)
5126 Perl_croak(aTHX_ "%" SVf, SVfARG(atsv));
5133 /* my_exit() was called */
5134 while (PL_scopestack_ix > oldscope)
5137 SET_CURSTASH(PL_defstash);
5138 PL_curcop = &PL_compiling;
5139 CopLINE_set(PL_curcop, oldline);
5142 NOT_REACHED; /* NOTREACHED */
5145 PL_curcop = &PL_compiling;
5146 CopLINE_set(PL_curcop, oldline);
5149 PerlIO_printf(Perl_error_log, "panic: restartop in call_list\n");
5160 A wrapper for the C library L<exit(3)>, honoring what L<perlapi/PL_exit_flags>
5167 Perl_my_exit(pTHX_ U32 status)
5169 if (PL_exit_flags & PERL_EXIT_ABORT) {
5172 if (PL_exit_flags & PERL_EXIT_WARN) {
5173 PL_exit_flags |= PERL_EXIT_ABORT; /* Protect against reentrant calls */
5174 Perl_warn(aTHX_ "Unexpected exit %lu", (unsigned long)status);
5175 PL_exit_flags &= ~PERL_EXIT_ABORT;
5185 STATUS_EXIT_SET(status);
5192 Perl_my_failure_exit(pTHX)
5195 /* We have been called to fall on our sword. The desired exit code
5196 * should be already set in STATUS_UNIX, but could be shifted over
5197 * by 8 bits. STATUS_UNIX_EXIT_SET will handle the cases where a
5200 * If an error code has not been set, then force the issue.
5202 if (MY_POSIX_EXIT) {
5204 /* According to the die_exit.t tests, if errno is non-zero */
5205 /* It should be used for the error status. */
5207 if (errno == EVMSERR) {
5208 STATUS_NATIVE = vaxc$errno;
5211 /* According to die_exit.t tests, if the child_exit code is */
5212 /* also zero, then we need to exit with a code of 255 */
5213 if ((errno != 0) && (errno < 256))
5214 STATUS_UNIX_EXIT_SET(errno);
5215 else if (STATUS_UNIX < 255) {
5216 STATUS_UNIX_EXIT_SET(255);
5221 /* The exit code could have been set by $? or vmsish which
5222 * means that it may not have fatal set. So convert
5223 * success/warning codes to fatal with out changing
5224 * the POSIX status code. The severity makes VMS native
5225 * status handling work, while UNIX mode programs use the
5228 if ((STATUS_NATIVE & (STS$K_SEVERE|STS$K_ERROR)) == 0) {
5229 STATUS_NATIVE &= STS$M_COND_ID;
5230 STATUS_NATIVE |= STS$K_ERROR | STS$M_INHIB_MSG;
5234 /* Traditionally Perl on VMS always expects a Fatal Error. */
5235 if (vaxc$errno & 1) {
5237 /* So force success status to failure */
5238 if (STATUS_NATIVE & 1)
5243 STATUS_UNIX = EINTR; /* In case something cares */
5248 STATUS_NATIVE = vaxc$errno; /* Should already be this */
5250 /* Encode the severity code */
5251 severity = STATUS_NATIVE & STS$M_SEVERITY;
5252 STATUS_UNIX = (severity ? severity : 1) << 8;
5254 /* Perl expects this to be a fatal error */
5255 if (severity != STS$K_SEVERE)
5265 STATUS_UNIX_SET(eno);
5267 exitstatus = STATUS_UNIX >> 8;
5268 if (exitstatus & 255)
5269 STATUS_UNIX_SET(exitstatus);
5271 STATUS_UNIX_SET(255);
5274 if (PL_exit_flags & PERL_EXIT_ABORT) {
5277 if (PL_exit_flags & PERL_EXIT_WARN) {
5278 PL_exit_flags |= PERL_EXIT_ABORT; /* Protect against reentrant calls */
5279 Perl_warn(aTHX_ "Unexpected exit failure %ld", (long)PL_statusvalue);
5280 PL_exit_flags &= ~PERL_EXIT_ABORT;
5286 S_my_exit_jump(pTHX)
5289 SvREFCNT_dec(PL_e_script);
5293 POPSTACK_TO(PL_mainstack);
5294 if (cxstack_ix >= 0) {
5296 cx_popblock(cxstack);
5304 read_e_script(pTHX_ int idx, SV *buf_sv, int maxlen)
5306 const char * const p = SvPVX_const(PL_e_script);
5307 const char * const e = SvEND(PL_e_script);
5308 const char *nl = (char *) memchr(p, '\n', e - p);
5310 PERL_UNUSED_ARG(idx);
5311 PERL_UNUSED_ARG(maxlen);
5313 nl = (nl) ? nl+1 : e;
5315 filter_del(read_e_script);
5318 sv_catpvn(buf_sv, p, nl-p);
5319 sv_chop(PL_e_script, nl);
5323 /* removes boilerplate code at the end of each boot_Module xsub */
5325 Perl_xs_boot_epilog(pTHX_ const I32 ax)
5328 call_list(PL_scopestack_ix, PL_unitcheckav);
5333 * ex: set ts=8 sts=4 sw=4 et: