4 * Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001
5 * 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
6 * 2013, 2014, 2015, 2016, 2017, 2018 by Larry Wall and others
8 * You may distribute under the terms of either the GNU General Public
9 * License or the Artistic License, as specified in the README file.
14 * A ship then new they built for him
15 * of mithril and of elven-glass
16 * --from Bilbo's song of EƤrendil
18 * [p.236 of _The Lord of the Rings_, II/i: "Many Meetings"]
21 /* This file contains the top-level functions that are used to create, use
22 * and destroy a perl interpreter, plus the functions used by XS code to
23 * call back into perl. Note that it does not contain the actual main()
24 * function of the interpreter; that can be found in perlmain.c
26 * Note that at build time this file is also linked to as perlmini.c,
27 * and perlmini.o is then built with PERL_IS_MINIPERL defined, which is
28 * then used to create the miniperl executable, rather than perl.o.
31 #if defined(PERL_IS_MINIPERL) && !defined(USE_SITECUSTOMIZE)
32 # define USE_SITECUSTOMIZE
36 #define PERL_IN_PERL_C
38 #include "patchlevel.h" /* for local_patches */
45 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
52 char control[CMSG_SPACE(sizeof(int))];
65 static I32 read_e_script(pTHX_ int idx, SV *buf_sv, int maxlen);
67 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
68 # define validate_suid(rsfp) NOOP
70 # define validate_suid(rsfp) S_validate_suid(aTHX_ rsfp)
73 #define CALL_BODY_SUB(myop) \
74 if (PL_op == (myop)) \
75 PL_op = PL_ppaddr[OP_ENTERSUB](aTHX); \
79 #define CALL_LIST_BODY(cv) \
80 PUSHMARK(PL_stack_sp); \
81 call_sv(MUTABLE_SV((cv)), G_EVAL|G_DISCARD|G_VOID);
84 S_init_tls_and_interp(PerlInterpreter *my_perl)
88 PERL_SET_INTERP(my_perl);
89 #if defined(USE_ITHREADS)
92 PERL_SET_THX(my_perl);
95 KEYWORD_PLUGIN_MUTEX_INIT;
98 MUTEX_INIT(&PL_dollarzero_mutex);
99 MUTEX_INIT(&PL_my_ctx_mutex);
102 #if defined(USE_ITHREADS)
105 /* This always happens for non-ithreads */
108 PERL_SET_THX(my_perl);
113 /* these implement the PERL_SYS_INIT, PERL_SYS_INIT3, PERL_SYS_TERM macros */
116 Perl_sys_init(int* argc, char*** argv)
120 PERL_ARGS_ASSERT_SYS_INIT;
122 PERL_UNUSED_ARG(argc); /* may not be used depending on _BODY macro */
123 PERL_UNUSED_ARG(argv);
124 PERL_SYS_INIT_BODY(argc, argv);
128 Perl_sys_init3(int* argc, char*** argv, char*** env)
132 PERL_ARGS_ASSERT_SYS_INIT3;
134 PERL_UNUSED_ARG(argc); /* may not be used depending on _BODY macro */
135 PERL_UNUSED_ARG(argv);
136 PERL_UNUSED_ARG(env);
137 PERL_SYS_INIT3_BODY(argc, argv, env);
144 if (!PL_veto_cleanup) {
145 PERL_SYS_TERM_BODY();
150 #ifdef PERL_IMPLICIT_SYS
152 perl_alloc_using(struct IPerlMem* ipM, struct IPerlMem* ipMS,
153 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
154 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
155 struct IPerlDir* ipD, struct IPerlSock* ipS,
156 struct IPerlProc* ipP)
158 PerlInterpreter *my_perl;
160 PERL_ARGS_ASSERT_PERL_ALLOC_USING;
162 /* Newx() needs interpreter, so call malloc() instead */
163 my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
164 S_init_tls_and_interp(my_perl);
165 Zero(my_perl, 1, PerlInterpreter);
175 INIT_TRACK_MEMPOOL(PL_memory_debug_header, my_perl);
182 =head1 Embedding Functions
184 =for apidoc perl_alloc
186 Allocates a new Perl interpreter. See L<perlembed>.
194 PerlInterpreter *my_perl;
196 /* Newx() needs interpreter, so call malloc() instead */
197 my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
199 S_init_tls_and_interp(my_perl);
200 #ifndef PERL_TRACK_MEMPOOL
201 return (PerlInterpreter *) ZeroD(my_perl, 1, PerlInterpreter);
203 Zero(my_perl, 1, PerlInterpreter);
204 INIT_TRACK_MEMPOOL(PL_memory_debug_header, my_perl);
208 #endif /* PERL_IMPLICIT_SYS */
211 =for apidoc perl_construct
213 Initializes a new Perl interpreter. See L<perlembed>.
219 S_fixup_platform_bugs(void)
221 #if defined(__GLIBC__) && IVSIZE == 8 \
222 && ( __GLIBC__ < 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ < 8))
226 /* Cannot do this check with inlined IV constants since
227 * that seems to work correctly even with the buggy glibc. */
230 /* Yikes, we have the bug.
231 * Patch in the workaround version. */
232 PL_ppaddr[OP_I_MODULO] = &Perl_pp_i_modulo_glibc_bugfix;
239 perl_construct(pTHXx)
243 PERL_ARGS_ASSERT_PERL_CONSTRUCT;
247 PL_perl_destruct_level = 1;
249 PERL_UNUSED_ARG(my_perl);
250 if (PL_perl_destruct_level > 0)
253 PL_curcop = &PL_compiling; /* needed by ckWARN, right away */
255 #ifdef PERL_TRACE_OPS
256 Zero(PL_op_exec_cnt, OP_max+2, UV);
261 SvREADONLY_on(&PL_sv_placeholder);
262 SvREFCNT(&PL_sv_placeholder) = SvREFCNT_IMMORTAL;
264 PL_sighandlerp = (Sighandler_t) Perl_sighandler;
265 #ifdef PERL_USES_PL_PIDSTATUS
266 PL_pidstatus = newHV();
269 PL_rs = newSVpvs("\n");
273 /* The PERL_INTERNAL_RAND_SEED set-up must be after init_stacks because it calls
274 * things that may put SVs on the stack.
277 #ifdef NO_PERL_INTERNAL_RAND_SEED
278 Perl_drand48_init_r(&PL_internal_random_state, seed());
283 if (PerlProc_getuid() != PerlProc_geteuid() ||
284 PerlProc_getgid() != PerlProc_getegid() ||
285 !(env_pv = PerlEnv_getenv("PERL_INTERNAL_RAND_SEED")) ||
286 grok_number(env_pv, strlen(env_pv), &seed) != IS_NUMBER_IN_UV) {
289 Perl_drand48_init_r(&PL_internal_random_state, (U32)seed);
295 S_fixup_platform_bugs();
302 #if defined(LOCAL_PATCH_COUNT)
303 PL_localpatches = local_patches; /* For possible -v */
306 #if defined(LIBM_LIB_VERSION)
308 * Some BSDs and Cygwin default to POSIX math instead of IEEE.
309 * This switches them over to IEEE.
311 _LIB_VERSION = _IEEE_;
314 #ifdef HAVE_INTERP_INTERN
318 PerlIO_init(aTHX); /* Hook to IO system */
320 PL_fdpid = newAV(); /* for remembering popen pids by fd */
321 PL_modglobal = newHV(); /* pointers to per-interpreter module globals */
322 PL_errors = newSVpvs("");
323 SvPVCLEAR(PERL_DEBUG_PAD(0)); /* For regex debugging. */
324 SvPVCLEAR(PERL_DEBUG_PAD(1)); /* ext/re needs these */
325 SvPVCLEAR(PERL_DEBUG_PAD(2)); /* even without DEBUGGING. */
327 /* First entry is a list of empty elements. It needs to be initialised
328 else all hell breaks loose in S_find_uninit_var(). */
329 Perl_av_create_and_push(aTHX_ &PL_regex_padav, newSVpvs(""));
330 PL_regex_pad = AvARRAY(PL_regex_padav);
331 Newxz(PL_stashpad, PL_stashpadmax, HV *);
333 #ifdef USE_REENTRANT_API
334 Perl_reentrant_init(aTHX);
336 if (PL_hash_seed_set == FALSE) {
337 /* Initialize the hash seed and state at startup. This must be
338 * done very early, before ANY hashes are constructed, and once
339 * setup is fixed for the lifetime of the process.
341 * If you decide to disable the seeding process you should choose
342 * a suitable seed yourself and define PERL_HASH_SEED to a well chosen
343 * string. See hv_func.h for details.
345 #if defined(USE_HASH_SEED)
346 /* get the hash seed from the environment or from an RNG */
347 Perl_get_hash_seed(aTHX_ PL_hash_seed);
349 /* they want a hard coded seed, check that it is long enough */
350 assert( strlen(PERL_HASH_SEED) >= PERL_HASH_SEED_BYTES );
353 /* now we use the chosen seed to initialize the state -
354 * in some configurations this may be a relatively speaking
355 * expensive operation, but we only have to do it once at startup */
356 PERL_HASH_SEED_STATE(PERL_HASH_SEED,PL_hash_state);
358 #ifdef PERL_USE_SINGLE_CHAR_HASH_CACHE
359 /* we can build a special cache for 0/1 byte keys, if people choose
360 * I suspect most of the time it is not worth it */
364 for (i=0;i<256;i++) {
366 PERL_HASH_WITH_STATE(PL_hash_state,PL_hash_chars[i],str,1);
368 PERL_HASH_WITH_STATE(PL_hash_state,PL_hash_chars[256],str,0);
371 /* at this point we have initialezed the hash function, and we can start
372 * constructing hashes */
373 PL_hash_seed_set= TRUE;
376 /* Allow PL_strtab to be pre-initialized before calling perl_construct.
377 * can use a custom optimized PL_strtab hash before calling perl_construct */
379 /* Note that strtab is a rather special HV. Assumptions are made
380 about not iterating on it, and not adding tie magic to it.
381 It is properly deallocated in perl_destruct() */
384 /* SHAREKEYS tells us that the hash has its keys shared with PL_strtab,
385 * which is not the case with PL_strtab itself */
386 HvSHAREKEYS_off(PL_strtab); /* mandatory */
387 hv_ksplit(PL_strtab, 1 << 11);
390 Zero(PL_sv_consts, SV_CONSTS_COUNT, SV*);
393 # ifdef USE_ENVIRON_ARRAY
394 PL_origenviron = environ;
398 /* Use sysconf(_SC_CLK_TCK) if available, if not
399 * available or if the sysconf() fails, use the HZ.
400 * The HZ if not originally defined has been by now
401 * been defined as CLK_TCK, if available. */
402 #if defined(HAS_SYSCONF) && defined(_SC_CLK_TCK)
403 PL_clocktick = sysconf(_SC_CLK_TCK);
404 if (PL_clocktick <= 0)
408 PL_stashcache = newHV();
410 PL_patchlevel = newSVpvs("v" PERL_VERSION_STRING);
413 if (!PL_mmap_page_size) {
414 #if defined(HAS_SYSCONF) && (defined(_SC_PAGESIZE) || defined(_SC_MMAP_PAGE_SIZE))
416 SETERRNO(0, SS_NORMAL);
418 PL_mmap_page_size = sysconf(_SC_PAGESIZE);
420 PL_mmap_page_size = sysconf(_SC_MMAP_PAGE_SIZE);
422 if ((long) PL_mmap_page_size < 0) {
423 Perl_croak(aTHX_ "panic: sysconf: %s",
424 errno ? Strerror(errno) : "pagesize unknown");
427 #elif defined(HAS_GETPAGESIZE)
428 PL_mmap_page_size = getpagesize();
429 #elif defined(I_SYS_PARAM) && defined(PAGESIZE)
430 PL_mmap_page_size = PAGESIZE; /* compiletime, bad */
432 if (PL_mmap_page_size <= 0)
433 Perl_croak(aTHX_ "panic: bad pagesize %" IVdf,
434 (IV) PL_mmap_page_size);
436 #endif /* HAS_MMAP */
438 #if defined(HAS_TIMES) && defined(PERL_NEED_TIMESBASE)
439 PL_timesbase.tms_utime = 0;
440 PL_timesbase.tms_stime = 0;
441 PL_timesbase.tms_cutime = 0;
442 PL_timesbase.tms_cstime = 0;
445 PL_osname = Perl_savepvn(aTHX_ STR_WITH_LEN(OSNAME));
447 PL_registered_mros = newHV();
448 /* Start with 1 bucket, for DFS. It's unlikely we'll need more. */
449 HvMAX(PL_registered_mros) = 0;
451 #ifdef USE_POSIX_2008_LOCALE
452 PL_C_locale_obj = newlocale(LC_ALL_MASK, "C", NULL);
460 =for apidoc nothreadhook
462 Stub that provides thread hook for perl_destruct when there are
469 Perl_nothreadhook(pTHX)
475 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
477 Perl_dump_sv_child(pTHX_ SV *sv)
480 const int sock = PL_dumper_fd;
481 const int debug_fd = PerlIO_fileno(Perl_debug_log);
482 union control_un control;
485 struct cmsghdr *cmptr;
487 unsigned char buffer[256];
489 PERL_ARGS_ASSERT_DUMP_SV_CHILD;
491 if(sock == -1 || debug_fd == -1)
494 PerlIO_flush(Perl_debug_log);
496 /* All these shenanigans are to pass a file descriptor over to our child for
497 it to dump out to. We can't let it hold open the file descriptor when it
498 forks, as the file descriptor it will dump to can turn out to be one end
499 of pipe that some other process will wait on for EOF. (So as it would
500 be open, the wait would be forever.) */
502 msg.msg_control = control.control;
503 msg.msg_controllen = sizeof(control.control);
504 /* We're a connected socket so we don't need a destination */
510 cmptr = CMSG_FIRSTHDR(&msg);
511 cmptr->cmsg_len = CMSG_LEN(sizeof(int));
512 cmptr->cmsg_level = SOL_SOCKET;
513 cmptr->cmsg_type = SCM_RIGHTS;
514 *((int *)CMSG_DATA(cmptr)) = 1;
516 vec[0].iov_base = (void*)&sv;
517 vec[0].iov_len = sizeof(sv);
518 got = sendmsg(sock, &msg, 0);
521 perror("Debug leaking scalars parent sendmsg failed");
524 if(got < sizeof(sv)) {
525 perror("Debug leaking scalars parent short sendmsg");
529 /* Return protocol is
531 unsigned char: length of location string (0 for empty)
532 unsigned char*: string (not terminated)
534 vec[0].iov_base = (void*)&returned_errno;
535 vec[0].iov_len = sizeof(returned_errno);
536 vec[1].iov_base = buffer;
539 got = readv(sock, vec, 2);
542 perror("Debug leaking scalars parent read failed");
543 PerlIO_flush(PerlIO_stderr());
546 if(got < sizeof(returned_errno) + 1) {
547 perror("Debug leaking scalars parent short read");
548 PerlIO_flush(PerlIO_stderr());
553 got = read(sock, buffer + 1, *buffer);
555 perror("Debug leaking scalars parent read 2 failed");
556 PerlIO_flush(PerlIO_stderr());
561 perror("Debug leaking scalars parent short read 2");
562 PerlIO_flush(PerlIO_stderr());
567 if (returned_errno || *buffer) {
568 Perl_warn(aTHX_ "Debug leaking scalars child failed%s%.*s with errno"
569 " %d: %s", (*buffer ? " at " : ""), (int) *buffer, buffer + 1,
570 returned_errno, Strerror(returned_errno));
576 =for apidoc Am|int|perl_destruct|PerlInterpreter *my_perl
578 Shuts down a Perl interpreter. See L<perlembed> for a tutorial.
580 C<my_perl> points to the Perl interpreter. It must have been previously
581 created through the use of L</perl_alloc> and L</perl_construct>. It may
582 have been initialised through L</perl_parse>, and may have been used
583 through L</perl_run> and other means. This function should be called for
584 any Perl interpreter that has been constructed with L</perl_construct>,
585 even if subsequent operations on it failed, for example if L</perl_parse>
586 returned a non-zero value.
588 If the interpreter's C<PL_exit_flags> word has the
589 C<PERL_EXIT_DESTRUCT_END> flag set, then this function will execute code
590 in C<END> blocks before performing the rest of destruction. If it is
591 desired to make any use of the interpreter between L</perl_parse> and
592 L</perl_destruct> other than just calling L</perl_run>, then this flag
593 should be set early on. This matters if L</perl_run> will not be called,
594 or if anything else will be done in addition to calling L</perl_run>.
596 Returns a value be a suitable value to pass to the C library function
597 C<exit> (or to return from C<main>), to serve as an exit code indicating
598 the nature of the way the interpreter terminated. This takes into account
599 any failure of L</perl_parse> and any early exit from L</perl_run>.
600 The exit code is of the type required by the host operating system,
601 so because of differing exit code conventions it is not portable to
602 interpret specific numeric values as having specific meanings.
611 volatile signed char destruct_level; /* see possible values in intrpvar.h */
613 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
618 PERL_ARGS_ASSERT_PERL_DESTRUCT;
620 PERL_UNUSED_ARG(my_perl);
623 assert(PL_scopestack_ix == 1);
625 /* wait for all pseudo-forked children to finish */
626 PERL_WAIT_FOR_CHILDREN;
628 destruct_level = PL_perl_destruct_level;
629 #if defined(DEBUGGING) || defined(PERL_TRACK_MEMPOOL)
631 const char * const s = PerlEnv_getenv("PERL_DESTRUCT_LEVEL");
634 if (strEQ(s, "-1")) { /* Special case: modperl folklore. */
638 if (grok_atoUV(s, &uv, NULL) && uv <= INT_MAX)
644 if (destruct_level < i) destruct_level = i;
646 #ifdef PERL_TRACK_MEMPOOL
647 /* RT #114496, for perl_free */
648 PL_perl_destruct_level = i;
654 if (PL_exit_flags & PERL_EXIT_DESTRUCT_END) {
660 if (PL_endav && !PL_minus_c) {
661 PERL_SET_PHASE(PERL_PHASE_END);
662 call_list(PL_scopestack_ix, PL_endav);
668 assert(PL_scopestack_ix == 0);
670 /* Need to flush since END blocks can produce output */
671 /* flush stdout separately, since we can identify it */
674 PerlIO *stdo = PerlIO_stdout();
675 if (*stdo && PerlIO_flush(stdo)) {
676 PerlIO_restore_errno(stdo);
678 PerlIO_printf(PerlIO_stderr(), "Unable to flush stdout: %s\n",
687 #ifdef PERL_TRACE_OPS
688 /* dump OP-counts if $ENV{PERL_TRACE_OPS} > 0 */
690 const char * const ptoenv = PerlEnv_getenv("PERL_TRACE_OPS");
693 if (!ptoenv || !Perl_grok_atoUV(ptoenv, &uv, NULL)
697 PerlIO_printf(Perl_debug_log, "Trace of all OPs executed:\n");
698 for (i = 0; i <= OP_max; ++i) {
699 if (PL_op_exec_cnt[i])
700 PerlIO_printf(Perl_debug_log, " %s: %" UVuf "\n", PL_op_name[i], PL_op_exec_cnt[i]);
702 /* Utility slot for easily doing little tracing experiments in the runloop: */
703 if (PL_op_exec_cnt[OP_max+1] != 0)
704 PerlIO_printf(Perl_debug_log, " SPECIAL: %" UVuf "\n", PL_op_exec_cnt[OP_max+1]);
705 PerlIO_printf(Perl_debug_log, "\n");
710 if (PL_threadhook(aTHX)) {
711 /* Threads hook has vetoed further cleanup */
712 PL_veto_cleanup = TRUE;
716 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
717 if (destruct_level != 0) {
718 /* Fork here to create a child. Our child's job is to preserve the
719 state of scalars prior to destruction, so that we can instruct it
720 to dump any scalars that we later find have leaked.
721 There's no subtlety in this code - it assumes POSIX, and it doesn't
725 if(PerlSock_socketpair_cloexec(AF_UNIX, SOCK_STREAM, 0, fd)) {
726 perror("Debug leaking scalars socketpair failed");
732 perror("Debug leaking scalars fork failed");
736 /* We are the child */
737 const int sock = fd[1];
738 const int debug_fd = PerlIO_fileno(Perl_debug_log);
741 /* Our success message is an integer 0, and a char 0 */
742 static const char success[sizeof(int) + 1] = {0};
746 /* We need to close all other file descriptors otherwise we end up
747 with interesting hangs, where the parent closes its end of a
748 pipe, and sits waiting for (another) child to terminate. Only
749 that child never terminates, because it never gets EOF, because
750 we also have the far end of the pipe open. We even need to
751 close the debugging fd, because sometimes it happens to be one
752 end of a pipe, and a process is waiting on the other end for
753 EOF. Normally it would be closed at some point earlier in
754 destruction, but if we happen to cause the pipe to remain open,
755 EOF never occurs, and we get an infinite hang. Hence all the
756 games to pass in a file descriptor if it's actually needed. */
758 f = sysconf(_SC_OPEN_MAX);
760 where = "sysconf failed";
771 union control_un control;
774 struct cmsghdr *cmptr;
778 msg.msg_control = control.control;
779 msg.msg_controllen = sizeof(control.control);
780 /* We're a connected socket so we don't need a source */
784 msg.msg_iovlen = C_ARRAY_LENGTH(vec);
786 vec[0].iov_base = (void*)⌖
787 vec[0].iov_len = sizeof(target);
789 got = recvmsg(sock, &msg, 0);
794 where = "recv failed";
797 if(got < sizeof(target)) {
798 where = "short recv";
802 if(!(cmptr = CMSG_FIRSTHDR(&msg))) {
806 if(cmptr->cmsg_len != CMSG_LEN(sizeof(int))) {
807 where = "wrong cmsg_len";
810 if(cmptr->cmsg_level != SOL_SOCKET) {
811 where = "wrong cmsg_level";
814 if(cmptr->cmsg_type != SCM_RIGHTS) {
815 where = "wrong cmsg_type";
819 got_fd = *(int*)CMSG_DATA(cmptr);
820 /* For our last little bit of trickery, put the file descriptor
821 back into Perl_debug_log, as if we never actually closed it
823 if(got_fd != debug_fd) {
824 if (PerlLIO_dup2_cloexec(got_fd, debug_fd) == -1) {
831 PerlIO_flush(Perl_debug_log);
833 got = write(sock, &success, sizeof(success));
836 where = "write failed";
839 if(got < sizeof(success)) {
840 where = "short write";
847 int send_errno = errno;
848 unsigned char length = (unsigned char) strlen(where);
849 struct iovec failure[3] = {
850 {(void*)&send_errno, sizeof(send_errno)},
852 {(void*)where, length}
854 int got = writev(sock, failure, 3);
855 /* Bad news travels fast. Faster than data. We'll get a SIGPIPE
856 in the parent if we try to read from the socketpair after the
857 child has exited, even if there was data to read.
858 So sleep a bit to give the parent a fighting chance of
861 _exit((got == -1) ? errno : 0);
865 PL_dumper_fd = fd[0];
870 /* We must account for everything. */
872 /* Destroy the main CV and syntax tree */
873 /* Set PL_curcop now, because destroying ops can cause new SVs
874 to be generated in Perl_pad_swipe, and when running with
875 -DDEBUG_LEAKING_SCALARS they expect PL_curcop to point to a valid
876 op from which the filename structure member is copied. */
877 PL_curcop = &PL_compiling;
879 /* ensure comppad/curpad to refer to main's pad */
880 if (CvPADLIST(PL_main_cv)) {
881 PAD_SET_CUR_NOSAVE(CvPADLIST(PL_main_cv), 1);
882 PL_comppad_name = PadlistNAMES(CvPADLIST(PL_main_cv));
884 op_free(PL_main_root);
887 PL_main_start = NULL;
888 /* note that PL_main_cv isn't usually actually freed at this point,
889 * due to the CvOUTSIDE refs from subs compiled within it. It will
890 * get freed once all the subs are freed in sv_clean_all(), for
891 * destruct_level > 0 */
892 SvREFCNT_dec(PL_main_cv);
894 PERL_SET_PHASE(PERL_PHASE_DESTRUCT);
896 /* Tell PerlIO we are about to tear things apart in case
897 we have layers which are using resources that should
901 PerlIO_destruct(aTHX);
904 * Try to destruct global references. We do this first so that the
905 * destructors and destructees still exist. Some sv's might remain.
906 * Non-referenced objects are on their own.
910 /* unhook hooks which will soon be, or use, destroyed data */
911 SvREFCNT_dec(PL_warnhook);
913 SvREFCNT_dec(PL_diehook);
916 /* call exit list functions */
917 while (PL_exitlistlen-- > 0)
918 PL_exitlist[PL_exitlistlen].fn(aTHX_ PL_exitlist[PL_exitlistlen].ptr);
920 Safefree(PL_exitlist);
925 SvREFCNT_dec(PL_registered_mros);
927 /* jettison our possibly duplicated environment */
928 /* if PERL_USE_SAFE_PUTENV is defined environ will not have been copied
929 * so we certainly shouldn't free it here
932 #if defined(USE_ENVIRON_ARRAY) && !defined(PERL_USE_SAFE_PUTENV)
933 if (environ != PL_origenviron && !PL_use_safe_putenv
935 /* only main thread can free environ[0] contents */
936 && PL_curinterp == aTHX
942 for (i = 0; environ[i]; i++)
943 safesysfree(environ[i]);
945 /* Must use safesysfree() when working with environ. */
946 safesysfree(environ);
948 environ = PL_origenviron;
951 #endif /* !PERL_MICRO */
953 if (destruct_level == 0) {
955 DEBUG_P(debprofdump());
957 #if defined(PERLIO_LAYERS)
958 /* No more IO - including error messages ! */
959 PerlIO_cleanup(aTHX);
962 CopFILE_free(&PL_compiling);
964 /* The exit() function will do everything that needs doing. */
968 /* Below, do clean up for when PERL_DESTRUCT_LEVEL is not 0 */
971 /* the syntax tree is shared between clones
972 * so op_free(PL_main_root) only ReREFCNT_dec's
973 * REGEXPs in the parent interpreter
974 * we need to manually ReREFCNT_dec for the clones
977 I32 i = AvFILLp(PL_regex_padav);
978 SV **ary = AvARRAY(PL_regex_padav);
981 SvREFCNT_dec(ary[i]);
982 ary[i] = &PL_sv_undef;
988 SvREFCNT_dec(MUTABLE_SV(PL_stashcache));
989 PL_stashcache = NULL;
991 /* loosen bonds of global variables */
993 /* XXX can PL_parser still be non-null here? */
994 if(PL_parser && PL_parser->rsfp) {
995 (void)PerlIO_close(PL_parser->rsfp);
996 PL_parser->rsfp = NULL;
1000 Safefree(PL_splitstr);
1010 PL_doswitches = FALSE;
1011 PL_dowarn = G_WARN_OFF;
1012 #ifdef PERL_SAWAMPERSAND
1013 PL_sawampersand = 0; /* must save all match strings */
1017 Safefree(PL_inplace);
1019 SvREFCNT_dec(PL_patchlevel);
1022 SvREFCNT_dec(PL_e_script);
1028 /* magical thingies */
1030 SvREFCNT_dec(PL_ofsgv); /* *, */
1033 SvREFCNT_dec(PL_ors_sv); /* $\ */
1036 SvREFCNT_dec(PL_rs); /* $/ */
1039 Safefree(PL_osname); /* $^O */
1042 SvREFCNT_dec(PL_statname);
1046 /* defgv, aka *_ should be taken care of elsewhere */
1049 Safefree(PL_efloatbuf);
1050 PL_efloatbuf = NULL;
1053 /* startup and shutdown function lists */
1054 SvREFCNT_dec(PL_beginav);
1055 SvREFCNT_dec(PL_beginav_save);
1056 SvREFCNT_dec(PL_endav);
1057 SvREFCNT_dec(PL_checkav);
1058 SvREFCNT_dec(PL_checkav_save);
1059 SvREFCNT_dec(PL_unitcheckav);
1060 SvREFCNT_dec(PL_unitcheckav_save);
1061 SvREFCNT_dec(PL_initav);
1063 PL_beginav_save = NULL;
1066 PL_checkav_save = NULL;
1067 PL_unitcheckav = NULL;
1068 PL_unitcheckav_save = NULL;
1071 /* shortcuts just get cleared */
1074 PL_argvoutgv = NULL;
1077 PL_last_in_gv = NULL;
1088 SvREFCNT_dec(PL_envgv);
1089 SvREFCNT_dec(PL_incgv);
1090 SvREFCNT_dec(PL_argvgv);
1091 SvREFCNT_dec(PL_replgv);
1092 SvREFCNT_dec(PL_DBgv);
1093 SvREFCNT_dec(PL_DBline);
1094 SvREFCNT_dec(PL_DBsub);
1103 SvREFCNT_dec(PL_argvout_stack);
1104 PL_argvout_stack = NULL;
1106 SvREFCNT_dec(PL_modglobal);
1107 PL_modglobal = NULL;
1108 SvREFCNT_dec(PL_preambleav);
1109 PL_preambleav = NULL;
1110 SvREFCNT_dec(PL_subname);
1112 #ifdef PERL_USES_PL_PIDSTATUS
1113 SvREFCNT_dec(PL_pidstatus);
1114 PL_pidstatus = NULL;
1116 SvREFCNT_dec(PL_toptarget);
1117 PL_toptarget = NULL;
1118 SvREFCNT_dec(PL_bodytarget);
1119 PL_bodytarget = NULL;
1120 PL_formtarget = NULL;
1122 /* free locale stuff */
1123 #ifdef USE_LOCALE_COLLATE
1124 Safefree(PL_collation_name);
1125 PL_collation_name = NULL;
1127 #if defined(USE_POSIX_2008_LOCALE) \
1128 && defined(USE_THREAD_SAFE_LOCALE) \
1129 && ! defined(HAS_QUERYLOCALE)
1130 for (i = 0; i < (int) C_ARRAY_LENGTH(PL_curlocales); i++) {
1131 Safefree(PL_curlocales[i]);
1132 PL_curlocales[i] = NULL;
1135 #ifdef HAS_POSIX_2008_LOCALE
1137 /* This also makes sure we aren't using a locale object that gets freed
1139 const locale_t old_locale = uselocale(LC_GLOBAL_LOCALE);
1140 if (old_locale != LC_GLOBAL_LOCALE) {
1141 freelocale(old_locale);
1144 # ifdef USE_LOCALE_NUMERIC
1145 if (PL_underlying_numeric_obj) {
1146 freelocale(PL_underlying_numeric_obj);
1147 PL_underlying_numeric_obj = (locale_t) NULL;
1151 #ifdef USE_LOCALE_NUMERIC
1152 Safefree(PL_numeric_name);
1153 PL_numeric_name = NULL;
1154 SvREFCNT_dec(PL_numeric_radix_sv);
1155 PL_numeric_radix_sv = NULL;
1158 if (PL_setlocale_buf) {
1159 Safefree(PL_setlocale_buf);
1160 PL_setlocale_buf = NULL;
1163 if (PL_langinfo_buf) {
1164 Safefree(PL_langinfo_buf);
1165 PL_langinfo_buf = NULL;
1168 /* clear character classes */
1169 #ifdef USE_LOCALE_CTYPE
1170 SvREFCNT_dec(PL_warn_locale);
1171 PL_warn_locale = NULL;
1174 if (!specialWARN(PL_compiling.cop_warnings))
1175 PerlMemShared_free(PL_compiling.cop_warnings);
1176 PL_compiling.cop_warnings = NULL;
1177 cophh_free(CopHINTHASH_get(&PL_compiling));
1178 CopHINTHASH_set(&PL_compiling, cophh_new_empty());
1179 CopFILE_free(&PL_compiling);
1181 /* Prepare to destruct main symbol table. */
1184 /* break ref loop *:: <=> %:: */
1185 (void)hv_deletes(hv, "main::", G_DISCARD);
1188 SvREFCNT_dec(PL_curstname);
1189 PL_curstname = NULL;
1191 /* clear queued errors */
1192 SvREFCNT_dec(PL_errors);
1195 SvREFCNT_dec(PL_isarev);
1198 if (destruct_level >= 2) {
1199 if (PL_scopestack_ix != 0)
1200 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
1201 "Unbalanced scopes: %ld more ENTERs than LEAVEs\n",
1202 (long)PL_scopestack_ix);
1203 if (PL_savestack_ix != 0)
1204 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
1205 "Unbalanced saves: %ld more saves than restores\n",
1206 (long)PL_savestack_ix);
1207 if (PL_tmps_floor != -1)
1208 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced tmps: %ld more allocs than frees\n",
1209 (long)PL_tmps_floor + 1);
1210 if (cxstack_ix != -1)
1211 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced context: %ld more PUSHes than POPs\n",
1212 (long)cxstack_ix + 1);
1216 SvREFCNT_dec(PL_regex_padav);
1217 PL_regex_padav = NULL;
1218 PL_regex_pad = NULL;
1221 #ifdef PERL_IMPLICIT_CONTEXT
1222 /* the entries in this list are allocated via SV PVX's, so get freed
1223 * in sv_clean_all */
1224 Safefree(PL_my_cxt_list);
1227 /* Now absolutely destruct everything, somehow or other, loops or no. */
1229 /* the 2 is for PL_fdpid and PL_strtab */
1230 while (sv_clean_all() > 2)
1234 Safefree(PL_stashpad); /* must come after sv_clean_all */
1237 AvREAL_off(PL_fdpid); /* no surviving entries */
1238 SvREFCNT_dec(PL_fdpid); /* needed in io_close() */
1241 #ifdef HAVE_INTERP_INTERN
1245 /* constant strings */
1246 for (i = 0; i < SV_CONSTS_COUNT; i++) {
1247 SvREFCNT_dec(PL_sv_consts[i]);
1248 PL_sv_consts[i] = NULL;
1251 /* Destruct the global string table. */
1253 /* Yell and reset the HeVAL() slots that are still holding refcounts,
1254 * so that sv_free() won't fail on them.
1255 * Now that the global string table is using a single hunk of memory
1256 * for both HE and HEK, we either need to explicitly unshare it the
1257 * correct way, or actually free things here.
1260 const I32 max = HvMAX(PL_strtab);
1261 HE * const * const array = HvARRAY(PL_strtab);
1262 HE *hent = array[0];
1265 if (hent && ckWARN_d(WARN_INTERNAL)) {
1266 HE * const next = HeNEXT(hent);
1267 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
1268 "Unbalanced string table refcount: (%ld) for \"%s\"",
1269 (long)hent->he_valu.hent_refcount, HeKEY(hent));
1276 hent = array[riter];
1281 HvARRAY(PL_strtab) = 0;
1282 HvTOTALKEYS(PL_strtab) = 0;
1284 SvREFCNT_dec(PL_strtab);
1287 /* free the pointer tables used for cloning */
1288 ptr_table_free(PL_ptr_table);
1289 PL_ptr_table = (PTR_TBL_t*)NULL;
1292 /* free special SVs */
1294 SvREFCNT(&PL_sv_yes) = 0;
1295 sv_clear(&PL_sv_yes);
1296 SvANY(&PL_sv_yes) = NULL;
1297 SvFLAGS(&PL_sv_yes) = 0;
1299 SvREFCNT(&PL_sv_no) = 0;
1300 sv_clear(&PL_sv_no);
1301 SvANY(&PL_sv_no) = NULL;
1302 SvFLAGS(&PL_sv_no) = 0;
1304 SvREFCNT(&PL_sv_zero) = 0;
1305 sv_clear(&PL_sv_zero);
1306 SvANY(&PL_sv_zero) = NULL;
1307 SvFLAGS(&PL_sv_zero) = 0;
1311 for (i=0; i<=2; i++) {
1312 SvREFCNT(PERL_DEBUG_PAD(i)) = 0;
1313 sv_clear(PERL_DEBUG_PAD(i));
1314 SvANY(PERL_DEBUG_PAD(i)) = NULL;
1315 SvFLAGS(PERL_DEBUG_PAD(i)) = 0;
1319 if (PL_sv_count != 0 && ckWARN_d(WARN_INTERNAL))
1320 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Scalars leaked: %ld\n", (long)PL_sv_count);
1322 #ifdef DEBUG_LEAKING_SCALARS
1323 if (PL_sv_count != 0) {
1328 for (sva = PL_sv_arenaroot; sva; sva = MUTABLE_SV(SvANY(sva))) {
1329 svend = &sva[SvREFCNT(sva)];
1330 for (sv = sva + 1; sv < svend; ++sv) {
1331 if (SvTYPE(sv) != (svtype)SVTYPEMASK) {
1332 PerlIO_printf(Perl_debug_log, "leaked: sv=0x%p"
1334 " refcnt=%" UVuf pTHX__FORMAT "\n"
1335 "\tallocated at %s:%d %s %s (parent 0x%" UVxf ");"
1336 "serial %" UVuf "\n",
1337 (void*)sv, (UV)sv->sv_flags, (UV)sv->sv_refcnt
1339 sv->sv_debug_file ? sv->sv_debug_file : "(unknown)",
1341 sv->sv_debug_inpad ? "for" : "by",
1342 sv->sv_debug_optype ?
1343 PL_op_name[sv->sv_debug_optype]: "(none)",
1344 PTR2UV(sv->sv_debug_parent),
1347 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1348 Perl_dump_sv_child(aTHX_ sv);
1354 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1358 /* Wait for up to 4 seconds for child to terminate.
1359 This seems to be the least effort way of timing out on reaping
1361 struct timeval waitfor = {4, 0};
1362 int sock = PL_dumper_fd;
1366 FD_SET(sock, &rset);
1367 select(sock + 1, &rset, NULL, NULL, &waitfor);
1368 waitpid(child, &status, WNOHANG);
1373 #ifdef DEBUG_LEAKING_SCALARS_ABORT
1379 #if defined(PERLIO_LAYERS)
1380 /* No more IO - including error messages ! */
1381 PerlIO_cleanup(aTHX);
1384 /* sv_undef needs to stay immortal until after PerlIO_cleanup
1385 as currently layers use it rather than NULL as a marker
1386 for no arg - and will try and SvREFCNT_dec it.
1388 SvREFCNT(&PL_sv_undef) = 0;
1389 SvREADONLY_off(&PL_sv_undef);
1391 Safefree(PL_origfilename);
1392 PL_origfilename = NULL;
1393 Safefree(PL_reg_curpm);
1394 free_tied_hv_pool();
1395 Safefree(PL_op_mask);
1396 Safefree(PL_psig_name);
1397 PL_psig_name = (SV**)NULL;
1398 PL_psig_ptr = (SV**)NULL;
1400 /* We need to NULL PL_psig_pend first, so that
1401 signal handlers know not to use it */
1402 int *psig_save = PL_psig_pend;
1403 PL_psig_pend = (int*)NULL;
1404 Safefree(psig_save);
1407 TAINTING_set(FALSE);
1408 TAINT_WARN_set(FALSE);
1409 PL_hints = 0; /* Reset hints. Should hints be per-interpreter ? */
1411 DEBUG_P(debprofdump());
1415 #ifdef USE_REENTRANT_API
1416 Perl_reentrant_free(aTHX);
1419 /* These all point to HVs that are about to be blown away.
1420 Code in core and on CPAN assumes that if the interpreter is re-started
1421 that they will be cleanly NULL or pointing to a valid HV. */
1422 PL_custom_op_names = NULL;
1423 PL_custom_op_descs = NULL;
1424 PL_custom_ops = NULL;
1428 while (PL_regmatch_slab) {
1429 regmatch_slab *s = PL_regmatch_slab;
1430 PL_regmatch_slab = PL_regmatch_slab->next;
1434 /* As the absolutely last thing, free the non-arena SV for mess() */
1437 /* we know that type == SVt_PVMG */
1439 /* it could have accumulated taint magic */
1442 for (mg = SvMAGIC(PL_mess_sv); mg; mg = moremagic) {
1443 moremagic = mg->mg_moremagic;
1444 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global
1446 Safefree(mg->mg_ptr);
1450 /* we know that type >= SVt_PV */
1451 SvPV_free(PL_mess_sv);
1452 Safefree(SvANY(PL_mess_sv));
1453 Safefree(PL_mess_sv);
1460 =for apidoc perl_free
1462 Releases a Perl interpreter. See L<perlembed>.
1472 PERL_ARGS_ASSERT_PERL_FREE;
1474 if (PL_veto_cleanup)
1477 #ifdef PERL_TRACK_MEMPOOL
1480 * Don't free thread memory if PERL_DESTRUCT_LEVEL is set to a non-zero
1481 * value as we're probably hunting memory leaks then
1483 if (PL_perl_destruct_level == 0) {
1484 const U32 old_debug = PL_debug;
1485 /* Emulate the PerlHost behaviour of free()ing all memory allocated in this
1486 thread at thread exit. */
1488 PerlIO_puts(Perl_debug_log, "Disabling memory debugging as we "
1489 "free this thread's memory\n");
1490 PL_debug &= ~ DEBUG_m_FLAG;
1492 while(aTHXx->Imemory_debug_header.next != &(aTHXx->Imemory_debug_header)){
1493 char * next = (char *)(aTHXx->Imemory_debug_header.next);
1494 Malloc_t ptr = PERL_MEMORY_DEBUG_HEADER_SIZE + next;
1497 PL_debug = old_debug;
1502 #if defined(WIN32) || defined(NETWARE)
1503 # if defined(PERL_IMPLICIT_SYS)
1506 void *host = nw_internal_host;
1507 PerlMem_free(aTHXx);
1508 nw_delete_internal_host(host);
1510 void *host = w32_internal_host;
1511 PerlMem_free(aTHXx);
1512 win32_delete_internal_host(host);
1516 PerlMem_free(aTHXx);
1519 PerlMem_free(aTHXx);
1523 #if defined(USE_ITHREADS)
1524 /* provide destructors to clean up the thread key when libperl is unloaded */
1525 #ifndef WIN32 /* handled during DLL_PROCESS_DETACH in win32/perllib.c */
1527 #if defined(__hpux) && !(defined(__ux_version) && __ux_version <= 1020) && !defined(__GNUC__)
1528 #pragma fini "perl_fini"
1529 #elif defined(__sun) && !defined(__GNUC__)
1530 #pragma fini (perl_fini)
1534 #if defined(__GNUC__)
1535 __attribute__((destructor))
1541 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
1544 PL_curinterp && !PL_veto_cleanup)
1549 #endif /* THREADS */
1552 Perl_call_atexit(pTHX_ ATEXIT_t fn, void *ptr)
1554 Renew(PL_exitlist, PL_exitlistlen+1, PerlExitListEntry);
1555 PL_exitlist[PL_exitlistlen].fn = fn;
1556 PL_exitlist[PL_exitlistlen].ptr = ptr;
1561 =for apidoc Am|int|perl_parse|PerlInterpreter *my_perl|XSINIT_t xsinit|int argc|char **argv|char **env
1563 Tells a Perl interpreter to parse a Perl script. This performs most
1564 of the initialisation of a Perl interpreter. See L<perlembed> for
1567 C<my_perl> points to the Perl interpreter that is to parse the script.
1568 It must have been previously created through the use of L</perl_alloc>
1569 and L</perl_construct>. C<xsinit> points to a callback function that
1570 will be called to set up the ability for this Perl interpreter to load
1571 XS extensions, or may be null to perform no such setup.
1573 C<argc> and C<argv> supply a set of command-line arguments to the Perl
1574 interpreter, as would normally be passed to the C<main> function of
1575 a C program. C<argv[argc]> must be null. These arguments are where
1576 the script to parse is specified, either by naming a script file or by
1577 providing a script in a C<-e> option.
1578 If L<C<$0>|perlvar/$0> will be written to in the Perl interpreter, then
1579 the argument strings must be in writable memory, and so mustn't just be
1582 C<env> specifies a set of environment variables that will be used by
1583 this Perl interpreter. If non-null, it must point to a null-terminated
1584 array of environment strings. If null, the Perl interpreter will use
1585 the environment supplied by the C<environ> global variable.
1587 This function initialises the interpreter, and parses and compiles the
1588 script specified by the command-line arguments. This includes executing
1589 code in C<BEGIN>, C<UNITCHECK>, and C<CHECK> blocks. It does not execute
1590 C<INIT> blocks or the main program.
1592 Returns an integer of slightly tricky interpretation. The correct
1593 use of the return value is as a truth value indicating whether there
1594 was a failure in initialisation. If zero is returned, this indicates
1595 that initialisation was successful, and it is safe to proceed to call
1596 L</perl_run> and make other use of it. If a non-zero value is returned,
1597 this indicates some problem that means the interpreter wants to terminate.
1598 The interpreter should not be just abandoned upon such failure; the caller
1599 should proceed to shut the interpreter down cleanly with L</perl_destruct>
1600 and free it with L</perl_free>.
1602 For historical reasons, the non-zero return value also attempts to
1603 be a suitable value to pass to the C library function C<exit> (or to
1604 return from C<main>), to serve as an exit code indicating the nature
1605 of the way initialisation terminated. However, this isn't portable,
1606 due to differing exit code conventions. A historical bug is preserved
1607 for the time being: if the Perl built-in C<exit> is called during this
1608 function's execution, with a type of exit entailing a zero exit code
1609 under the host operating system's conventions, then this function
1610 returns zero rather than a non-zero value. This bug, [perl #2754],
1611 leads to C<perl_run> being called (and therefore C<INIT> blocks and the
1612 main program running) despite a call to C<exit>. It has been preserved
1613 because a popular module-installing module has come to rely on it and
1614 needs time to be fixed. This issue is [perl #132577], and the original
1615 bug is due to be fixed in Perl 5.30.
1620 #define SET_CURSTASH(newstash) \
1621 if (PL_curstash != newstash) { \
1622 SvREFCNT_dec(PL_curstash); \
1623 PL_curstash = (HV *)SvREFCNT_inc(newstash); \
1627 perl_parse(pTHXx_ XSINIT_t xsinit, int argc, char **argv, char **env)
1634 PERL_ARGS_ASSERT_PERL_PARSE;
1635 #ifndef MULTIPLICITY
1636 PERL_UNUSED_ARG(my_perl);
1638 #if (defined(USE_HASH_SEED) || defined(USE_HASH_SEED_DEBUG)) && !defined(NO_PERL_HASH_SEED_DEBUG)
1640 const char * const s = PerlEnv_getenv("PERL_HASH_SEED_DEBUG");
1642 if (s && strEQ(s, "1")) {
1643 const unsigned char *seed= PERL_HASH_SEED;
1644 const unsigned char *seed_end= PERL_HASH_SEED + PERL_HASH_SEED_BYTES;
1645 PerlIO_printf(Perl_debug_log, "HASH_FUNCTION = %s HASH_SEED = 0x", PERL_HASH_FUNC);
1646 while (seed < seed_end) {
1647 PerlIO_printf(Perl_debug_log, "%02x", *seed++);
1649 #ifdef PERL_HASH_RANDOMIZE_KEYS
1650 PerlIO_printf(Perl_debug_log, " PERTURB_KEYS = %d (%s)",
1651 PL_HASH_RAND_BITS_ENABLED,
1652 PL_HASH_RAND_BITS_ENABLED == 0 ? "NO" : PL_HASH_RAND_BITS_ENABLED == 1 ? "RANDOM" : "DETERMINISTIC");
1654 PerlIO_printf(Perl_debug_log, "\n");
1657 #endif /* #if (defined(USE_HASH_SEED) ... */
1661 struct NameTranslationInfo nti;
1662 __translate_amiga_to_unix_path_name(&argv[0],&nti);
1669 for(i = 0; i != argc; i++)
1671 assert(!argv[argc]);
1676 if (PL_origalen != 0) {
1677 PL_origalen = 1; /* don't use old PL_origalen if perl_parse() is called again */
1680 /* Set PL_origalen be the sum of the contiguous argv[]
1681 * elements plus the size of the env in case that it is
1682 * contiguous with the argv[]. This is used in mg.c:Perl_magic_set()
1683 * as the maximum modifiable length of $0. In the worst case
1684 * the area we are able to modify is limited to the size of
1685 * the original argv[0]. (See below for 'contiguous', though.)
1687 const char *s = NULL;
1688 const UV mask = ~(UV)(PTRSIZE-1);
1689 /* Do the mask check only if the args seem like aligned. */
1691 (mask < ~(UV)0) && ((PTR2UV(argv[0]) & mask) == PTR2UV(argv[0]));
1693 /* See if all the arguments are contiguous in memory. Note
1694 * that 'contiguous' is a loose term because some platforms
1695 * align the argv[] and the envp[]. If the arguments look
1696 * like non-aligned, assume that they are 'strictly' or
1697 * 'traditionally' contiguous. If the arguments look like
1698 * aligned, we just check that they are within aligned
1699 * PTRSIZE bytes. As long as no system has something bizarre
1700 * like the argv[] interleaved with some other data, we are
1701 * fine. (Did I just evoke Murphy's Law?) --jhi */
1702 if (PL_origargv && PL_origargc >= 1 && (s = PL_origargv[0])) {
1705 for (i = 1; i < PL_origargc; i++) {
1706 if ((PL_origargv[i] == s + 1
1708 || PL_origargv[i] == s + 2
1713 (PL_origargv[i] > s &&
1715 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1726 #ifndef PERL_USE_SAFE_PUTENV
1727 /* Can we grab env area too to be used as the area for $0? */
1728 if (s && PL_origenviron && !PL_use_safe_putenv) {
1729 if ((PL_origenviron[0] == s + 1)
1732 (PL_origenviron[0] > s &&
1733 PL_origenviron[0] <=
1734 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1738 #ifndef OS2 /* ENVIRON is read by the kernel too. */
1739 s = PL_origenviron[0];
1742 my_setenv("NoNe SuCh", NULL);
1743 /* Force copy of environment. */
1744 for (i = 1; PL_origenviron[i]; i++) {
1745 if (PL_origenviron[i] == s + 1
1748 (PL_origenviron[i] > s &&
1749 PL_origenviron[i] <=
1750 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1753 s = PL_origenviron[i];
1761 #endif /* !defined(PERL_USE_SAFE_PUTENV) */
1763 PL_origalen = s ? s - PL_origargv[0] + 1 : 0;
1768 /* Come here if running an undumped a.out. */
1770 PL_origfilename = savepv(argv[0]);
1771 PL_do_undump = FALSE;
1772 cxstack_ix = -1; /* start label stack again */
1774 assert (!TAINT_get);
1778 init_postdump_symbols(argc,argv,env);
1783 op_free(PL_main_root);
1784 PL_main_root = NULL;
1786 PL_main_start = NULL;
1787 SvREFCNT_dec(PL_main_cv);
1791 oldscope = PL_scopestack_ix;
1792 PL_dowarn = G_WARN_OFF;
1797 parse_body(env,xsinit);
1798 if (PL_unitcheckav) {
1799 call_list(oldscope, PL_unitcheckav);
1802 PERL_SET_PHASE(PERL_PHASE_CHECK);
1803 call_list(oldscope, PL_checkav);
1811 /* my_exit() was called */
1812 while (PL_scopestack_ix > oldscope)
1815 SET_CURSTASH(PL_defstash);
1816 if (PL_unitcheckav) {
1817 call_list(oldscope, PL_unitcheckav);
1820 PERL_SET_PHASE(PERL_PHASE_CHECK);
1821 call_list(oldscope, PL_checkav);
1826 * At this point we should do
1828 * to avoid [perl #2754], but that bugfix has been postponed
1829 * because of the Module::Install breakage it causes
1835 PerlIO_printf(Perl_error_log, "panic: top_env\n");
1843 /* This needs to stay in perl.c, as perl.c is compiled with different flags for
1844 miniperl, and we need to see those flags reflected in the values here. */
1846 /* What this returns is subject to change. Use the public interface in Config.
1849 S_Internals_V(pTHX_ CV *cv)
1852 #ifdef LOCAL_PATCH_COUNT
1853 const int local_patch_count = LOCAL_PATCH_COUNT;
1855 const int local_patch_count = 0;
1857 const int entries = 3 + local_patch_count;
1859 static const char non_bincompat_options[] =
1866 # ifdef NO_HASH_SEED
1869 # ifdef NO_TAINT_SUPPORT
1872 # ifdef PERL_BOOL_AS_CHAR
1873 " PERL_BOOL_AS_CHAR"
1875 # ifdef PERL_COPY_ON_WRITE
1876 " PERL_COPY_ON_WRITE"
1878 # ifdef PERL_DISABLE_PMC
1881 # ifdef PERL_DONT_CREATE_GVSV
1882 " PERL_DONT_CREATE_GVSV"
1884 # ifdef PERL_EXTERNAL_GLOB
1885 " PERL_EXTERNAL_GLOB"
1887 # ifdef PERL_HASH_FUNC_SIPHASH
1888 " PERL_HASH_FUNC_SIPHASH"
1890 # ifdef PERL_HASH_FUNC_SDBM
1891 " PERL_HASH_FUNC_SDBM"
1893 # ifdef PERL_HASH_FUNC_DJB2
1894 " PERL_HASH_FUNC_DJB2"
1896 # ifdef PERL_HASH_FUNC_SUPERFAST
1897 " PERL_HASH_FUNC_SUPERFAST"
1899 # ifdef PERL_HASH_FUNC_MURMUR3
1900 " PERL_HASH_FUNC_MURMUR3"
1902 # ifdef PERL_HASH_FUNC_ONE_AT_A_TIME
1903 " PERL_HASH_FUNC_ONE_AT_A_TIME"
1905 # ifdef PERL_HASH_FUNC_ONE_AT_A_TIME_HARD
1906 " PERL_HASH_FUNC_ONE_AT_A_TIME_HARD"
1908 # ifdef PERL_HASH_FUNC_ONE_AT_A_TIME_OLD
1909 " PERL_HASH_FUNC_ONE_AT_A_TIME_OLD"
1911 # ifdef PERL_IS_MINIPERL
1914 # ifdef PERL_MALLOC_WRAP
1917 # ifdef PERL_MEM_LOG
1920 # ifdef PERL_MEM_LOG_NOIMPL
1921 " PERL_MEM_LOG_NOIMPL"
1923 # ifdef PERL_OP_PARENT
1926 # ifdef PERL_PERTURB_KEYS_DETERMINISTIC
1927 " PERL_PERTURB_KEYS_DETERMINISTIC"
1929 # ifdef PERL_PERTURB_KEYS_DISABLED
1930 " PERL_PERTURB_KEYS_DISABLED"
1932 # ifdef PERL_PERTURB_KEYS_RANDOM
1933 " PERL_PERTURB_KEYS_RANDOM"
1935 # ifdef PERL_PRESERVE_IVUV
1936 " PERL_PRESERVE_IVUV"
1938 # ifdef PERL_RELOCATABLE_INCPUSH
1939 " PERL_RELOCATABLE_INCPUSH"
1941 # ifdef PERL_USE_DEVEL
1944 # ifdef PERL_USE_SAFE_PUTENV
1945 " PERL_USE_SAFE_PUTENV"
1947 # ifdef SILENT_NO_TAINT_SUPPORT
1948 " SILENT_NO_TAINT_SUPPORT"
1950 # ifdef UNLINK_ALL_VERSIONS
1951 " UNLINK_ALL_VERSIONS"
1953 # ifdef USE_ATTRIBUTES_FOR_PERLIO
1954 " USE_ATTRIBUTES_FOR_PERLIO"
1956 # ifdef USE_FAST_STDIO
1962 # ifdef USE_LOCALE_CTYPE
1965 # ifdef WIN32_NO_REGISTRY
1968 # ifdef USE_PERL_ATOF
1971 # ifdef USE_SITECUSTOMIZE
1972 " USE_SITECUSTOMIZE"
1974 # ifdef USE_THREAD_SAFE_LOCALE
1975 " USE_THREAD_SAFE_LOCALE"
1978 PERL_UNUSED_ARG(cv);
1979 PERL_UNUSED_VAR(items);
1981 EXTEND(SP, entries);
1983 PUSHs(sv_2mortal(newSVpv(PL_bincompat_options, 0)));
1984 PUSHs(Perl_newSVpvn_flags(aTHX_ non_bincompat_options,
1985 sizeof(non_bincompat_options) - 1, SVs_TEMP));
1987 #ifndef PERL_BUILD_DATE
1990 # define PERL_BUILD_DATE __DATE__ " " __TIME__
1992 # define PERL_BUILD_DATE __DATE__
1997 #ifdef PERL_BUILD_DATE
1998 PUSHs(Perl_newSVpvn_flags(aTHX_
1999 STR_WITH_LEN("Compiled at " PERL_BUILD_DATE),
2002 PUSHs(&PL_sv_undef);
2005 for (i = 1; i <= local_patch_count; i++) {
2006 /* This will be an undef, if PL_localpatches[i] is NULL. */
2007 PUSHs(sv_2mortal(newSVpv(PL_localpatches[i], 0)));
2013 #define INCPUSH_UNSHIFT 0x01
2014 #define INCPUSH_ADD_OLD_VERS 0x02
2015 #define INCPUSH_ADD_VERSIONED_SUB_DIRS 0x04
2016 #define INCPUSH_ADD_ARCHONLY_SUB_DIRS 0x08
2017 #define INCPUSH_NOT_BASEDIR 0x10
2018 #define INCPUSH_CAN_RELOCATE 0x20
2019 #define INCPUSH_ADD_SUB_DIRS \
2020 (INCPUSH_ADD_VERSIONED_SUB_DIRS|INCPUSH_ADD_ARCHONLY_SUB_DIRS)
2023 S_parse_body(pTHX_ char **env, XSINIT_t xsinit)
2027 int argc = PL_origargc;
2028 char **argv = PL_origargv;
2029 const char *scriptname = NULL;
2030 bool dosearch = FALSE;
2032 bool doextract = FALSE;
2033 const char *cddir = NULL;
2034 #ifdef USE_SITECUSTOMIZE
2035 bool minus_f = FALSE;
2037 SV *linestr_sv = NULL;
2038 bool add_read_e_script = FALSE;
2039 U32 lex_start_flags = 0;
2041 PERL_SET_PHASE(PERL_PHASE_START);
2047 for (argc--,argv++; argc > 0; argc--,argv++) {
2048 if (argv[0][0] != '-' || !argv[0][1])
2054 #ifndef PERL_STRICT_CR
2078 if ((s = moreswitches(s)))
2083 #if defined(SILENT_NO_TAINT_SUPPORT)
2084 /* silently ignore */
2085 #elif defined(NO_TAINT_SUPPORT)
2086 Perl_croak_nocontext("This perl was compiled without taint support. "
2087 "Cowardly refusing to run with -t or -T flags");
2089 CHECK_MALLOC_TOO_LATE_FOR('t');
2090 if( !TAINTING_get ) {
2091 TAINT_WARN_set(TRUE);
2098 #if defined(SILENT_NO_TAINT_SUPPORT)
2099 /* silently ignore */
2100 #elif defined(NO_TAINT_SUPPORT)
2101 Perl_croak_nocontext("This perl was compiled without taint support. "
2102 "Cowardly refusing to run with -t or -T flags");
2104 CHECK_MALLOC_TOO_LATE_FOR('T');
2106 TAINT_WARN_set(FALSE);
2115 forbid_setid('e', FALSE);
2117 PL_e_script = newSVpvs("");
2118 add_read_e_script = TRUE;
2121 sv_catpv(PL_e_script, s);
2123 sv_catpv(PL_e_script, argv[1]);
2127 Perl_croak(aTHX_ "No code specified for -%c", c);
2128 sv_catpvs(PL_e_script, "\n");
2132 #ifdef USE_SITECUSTOMIZE
2138 case 'I': /* -I handled both here and in moreswitches() */
2139 forbid_setid('I', FALSE);
2140 if (!*++s && (s=argv[1]) != NULL) {
2144 STRLEN len = strlen(s);
2145 incpush(s, len, INCPUSH_ADD_SUB_DIRS|INCPUSH_ADD_OLD_VERS);
2148 Perl_croak(aTHX_ "No directory specified for -I");
2151 forbid_setid('S', FALSE);
2160 opts_prog = newSVpvs("use Config; Config::_V()");
2164 opts_prog = Perl_newSVpvf(aTHX_
2165 "use Config; Config::config_vars(qw%c%s%c)",
2169 Perl_av_create_and_push(aTHX_ &PL_preambleav, opts_prog);
2170 /* don't look for script or read stdin */
2171 scriptname = BIT_BUCKET;
2183 if (!*++s || isSPACE(*s)) {
2187 /* catch use of gnu style long options.
2188 Both of these exit immediately. */
2189 if (strEQ(s, "version"))
2191 if (strEQ(s, "help"))
2196 Perl_croak(aTHX_ "Unrecognized switch: -%s (-h will show valid options)",s);
2207 #ifndef SECURE_INTERNAL_GETENV
2210 (s = PerlEnv_getenv("PERL5OPT")))
2212 /* s points to static memory in getenv(), which may be overwritten at
2213 * any time; use a mortal copy instead */
2214 s = SvPVX(sv_2mortal(newSVpv(s, 0)));
2218 if (*s == '-' && *(s+1) == 'T') {
2219 #if defined(SILENT_NO_TAINT_SUPPORT)
2220 /* silently ignore */
2221 #elif defined(NO_TAINT_SUPPORT)
2222 Perl_croak_nocontext("This perl was compiled without taint support. "
2223 "Cowardly refusing to run with -t or -T flags");
2225 CHECK_MALLOC_TOO_LATE_FOR('T');
2227 TAINT_WARN_set(FALSE);
2231 char *popt_copy = NULL;
2244 if (!strchr("CDIMUdmtwW", *s))
2245 Perl_croak(aTHX_ "Illegal switch in PERL5OPT: -%c", *s);
2249 popt_copy = SvPVX(sv_2mortal(newSVpv(d,0)));
2250 s = popt_copy + (s - d);
2258 #if defined(SILENT_NO_TAINT_SUPPORT)
2259 /* silently ignore */
2260 #elif defined(NO_TAINT_SUPPORT)
2261 Perl_croak_nocontext("This perl was compiled without taint support. "
2262 "Cowardly refusing to run with -t or -T flags");
2264 if( !TAINTING_get) {
2265 TAINT_WARN_set(TRUE);
2277 #ifndef NO_PERL_INTERNAL_RAND_SEED
2278 /* If we're not set[ug]id, we might have honored
2279 PERL_INTERNAL_RAND_SEED in perl_construct().
2280 At this point command-line options have been parsed, so if
2281 we're now tainting and not set[ug]id re-seed.
2282 This could possibly be wasteful if PERL_INTERNAL_RAND_SEED is invalid,
2283 but avoids duplicating the logic from perl_construct().
2286 PerlProc_getuid() == PerlProc_geteuid() &&
2287 PerlProc_getgid() == PerlProc_getegid()) {
2288 Perl_drand48_init_r(&PL_internal_random_state, seed());
2292 /* Set $^X early so that it can be used for relocatable paths in @INC */
2293 /* and for SITELIB_EXP in USE_SITECUSTOMIZE */
2294 assert (!TAINT_get);
2299 #if defined(USE_SITECUSTOMIZE)
2301 /* The games with local $! are to avoid setting errno if there is no
2302 sitecustomize script. "q%c...%c", 0, ..., 0 becomes "q\0...\0",
2303 ie a q() operator with a NUL byte as a the delimiter. This avoids
2304 problems with pathnames containing (say) ' */
2305 # ifdef PERL_IS_MINIPERL
2306 AV *const inc = GvAV(PL_incgv);
2307 SV **const inc0 = inc ? av_fetch(inc, 0, FALSE) : NULL;
2310 /* if lib/buildcustomize.pl exists, it should not fail. If it does,
2311 it should be reported immediately as a build failure. */
2312 (void)Perl_av_create_and_unshift_one(aTHX_ &PL_preambleav,
2314 "BEGIN { my $f = q%c%s%" SVf "/buildcustomize.pl%c; "
2315 "do {local $!; -f $f }"
2316 " and do $f || die $@ || qq '$f: $!' }",
2317 0, (TAINTING_get ? "./" : ""), SVfARG(*inc0), 0));
2320 /* SITELIB_EXP is a function call on Win32. */
2321 const char *const raw_sitelib = SITELIB_EXP;
2323 /* process .../.. if PERL_RELOCATABLE_INC is defined */
2324 SV *sitelib_sv = mayberelocate(raw_sitelib, strlen(raw_sitelib),
2325 INCPUSH_CAN_RELOCATE);
2326 const char *const sitelib = SvPVX(sitelib_sv);
2327 (void)Perl_av_create_and_unshift_one(aTHX_ &PL_preambleav,
2329 "BEGIN { do {local $!; -f q%c%s/sitecustomize.pl%c} && do q%c%s/sitecustomize.pl%c }",
2330 0, SVfARG(sitelib), 0,
2331 0, SVfARG(sitelib), 0));
2332 assert (SvREFCNT(sitelib_sv) == 1);
2333 SvREFCNT_dec(sitelib_sv);
2340 scriptname = argv[0];
2343 scriptname = BIT_BUCKET; /* don't look for script or read stdin */
2345 else if (scriptname == NULL) {
2347 if ( PerlLIO_isatty(PerlIO_fileno(PerlIO_stdin())) )
2353 assert (!TAINT_get);
2357 bool suidscript = FALSE;
2359 rsfp = open_script(scriptname, dosearch, &suidscript);
2361 rsfp = PerlIO_stdin();
2362 lex_start_flags = LEX_DONT_CLOSE_RSFP;
2365 validate_suid(rsfp);
2368 # if defined(SIGCHLD) || defined(SIGCLD)
2371 # define SIGCHLD SIGCLD
2373 Sighandler_t sigstate = rsignal_state(SIGCHLD);
2374 if (sigstate == (Sighandler_t) SIG_IGN) {
2375 Perl_ck_warner(aTHX_ packWARN(WARN_SIGNAL),
2376 "Can't ignore signal CHLD, forcing to default");
2377 (void)rsignal(SIGCHLD, (Sighandler_t)SIG_DFL);
2385 /* This will croak if suidscript is true, as -x cannot be used with
2387 forbid_setid('x', suidscript);
2388 /* Hence you can't get here if suidscript is true */
2390 linestr_sv = newSV_type(SVt_PV);
2391 lex_start_flags |= LEX_START_COPIED;
2392 find_beginning(linestr_sv, rsfp);
2393 if (cddir && PerlDir_chdir( (char *)cddir ) < 0)
2394 Perl_croak(aTHX_ "Can't chdir to %s",cddir);
2398 PL_main_cv = PL_compcv = MUTABLE_CV(newSV_type(SVt_PVCV));
2399 CvUNIQUE_on(PL_compcv);
2401 CvPADLIST_set(PL_compcv, pad_new(0));
2403 PL_isarev = newHV();
2406 boot_core_UNIVERSAL();
2408 newXS("Internals::V", S_Internals_V, __FILE__);
2411 (*xsinit)(aTHX); /* in case linked C routines want magical variables */
2413 #if defined(VMS) || defined(WIN32) || defined(DJGPP) || defined(__CYGWIN__) || defined(SYMBIAN)
2419 # ifdef HAS_SOCKS5_INIT
2420 socks5_init(argv[0]);
2426 init_predump_symbols();
2427 /* init_postdump_symbols not currently designed to be called */
2428 /* more than once (ENV isn't cleared first, for example) */
2429 /* But running with -u leaves %ENV & @ARGV undefined! XXX */
2431 init_postdump_symbols(argc,argv,env);
2433 /* PL_unicode is turned on by -C, or by $ENV{PERL_UNICODE},
2434 * or explicitly in some platforms.
2435 * PL_utf8locale is conditionally turned on by
2436 * locale.c:Perl_init_i18nl10n() if the environment
2437 * look like the user wants to use UTF-8. */
2438 #if defined(__SYMBIAN32__)
2439 PL_unicode = PERL_UNICODE_STD_FLAG; /* See PERL_SYMBIAN_CONSOLE_UTF8. */
2441 # ifndef PERL_IS_MINIPERL
2443 /* Requires init_predump_symbols(). */
2444 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
2449 /* Turn on UTF-8-ness on STDIN, STDOUT, STDERR
2450 * and the default open disciplines. */
2451 if ((PL_unicode & PERL_UNICODE_STDIN_FLAG) &&
2452 PL_stdingv && (io = GvIO(PL_stdingv)) &&
2454 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2455 if ((PL_unicode & PERL_UNICODE_STDOUT_FLAG) &&
2456 PL_defoutgv && (io = GvIO(PL_defoutgv)) &&
2458 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2459 if ((PL_unicode & PERL_UNICODE_STDERR_FLAG) &&
2460 PL_stderrgv && (io = GvIO(PL_stderrgv)) &&
2462 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2463 if ((PL_unicode & PERL_UNICODE_INOUT_FLAG) &&
2464 (sv = GvSV(gv_fetchpvs("\017PEN", GV_ADD|GV_NOTQUAL,
2466 U32 in = PL_unicode & PERL_UNICODE_IN_FLAG;
2467 U32 out = PL_unicode & PERL_UNICODE_OUT_FLAG;
2470 sv_setpvs(sv, ":utf8\0:utf8");
2472 sv_setpvs(sv, ":utf8\0");
2475 sv_setpvs(sv, "\0:utf8");
2484 if ((s = PerlEnv_getenv("PERL_SIGNALS"))) {
2485 if (strEQ(s, "unsafe"))
2486 PL_signals |= PERL_SIGNALS_UNSAFE_FLAG;
2487 else if (strEQ(s, "safe"))
2488 PL_signals &= ~PERL_SIGNALS_UNSAFE_FLAG;
2490 Perl_croak(aTHX_ "PERL_SIGNALS illegal: \"%s\"", s);
2495 lex_start(linestr_sv, rsfp, lex_start_flags);
2496 SvREFCNT_dec(linestr_sv);
2498 PL_subname = newSVpvs("main");
2500 if (add_read_e_script)
2501 filter_add(read_e_script, NULL);
2503 /* now parse the script */
2505 SETERRNO(0,SS_NORMAL);
2506 if (yyparse(GRAMPROG) || PL_parser->error_count) {
2507 abort_execution("", PL_origfilename);
2509 CopLINE_set(PL_curcop, 0);
2510 SET_CURSTASH(PL_defstash);
2512 SvREFCNT_dec(PL_e_script);
2520 SAVECOPFILE(PL_curcop);
2521 SAVECOPLINE(PL_curcop);
2522 gv_check(PL_defstash);
2532 s = PerlEnv_getenv("PERL_DEBUG_MSTATS");
2533 if (s && grok_atoUV(s, &uv, NULL) && uv >= 2)
2534 dump_mstats("after compilation:");
2539 PL_restartjmpenv = NULL;
2545 =for apidoc Am|int|perl_run|PerlInterpreter *my_perl
2547 Tells a Perl interpreter to run its main program. See L<perlembed>
2550 C<my_perl> points to the Perl interpreter. It must have been previously
2551 created through the use of L</perl_alloc> and L</perl_construct>, and
2552 initialised through L</perl_parse>. This function should not be called
2553 if L</perl_parse> returned a non-zero value, indicating a failure in
2554 initialisation or compilation.
2556 This function executes code in C<INIT> blocks, and then executes the
2557 main program. The code to be executed is that established by the prior
2558 call to L</perl_parse>. If the interpreter's C<PL_exit_flags> word
2559 does not have the C<PERL_EXIT_DESTRUCT_END> flag set, then this function
2560 will also execute code in C<END> blocks. If it is desired to make any
2561 further use of the interpreter after calling this function, then C<END>
2562 blocks should be postponed to L</perl_destruct> time by setting that flag.
2564 Returns an integer of slightly tricky interpretation. The correct use
2565 of the return value is as a truth value indicating whether the program
2566 terminated non-locally. If zero is returned, this indicates that
2567 the program ran to completion, and it is safe to make other use of the
2568 interpreter (provided that the C<PERL_EXIT_DESTRUCT_END> flag was set as
2569 described above). If a non-zero value is returned, this indicates that
2570 the interpreter wants to terminate early. The interpreter should not be
2571 just abandoned because of this desire to terminate; the caller should
2572 proceed to shut the interpreter down cleanly with L</perl_destruct>
2573 and free it with L</perl_free>.
2575 For historical reasons, the non-zero return value also attempts to
2576 be a suitable value to pass to the C library function C<exit> (or to
2577 return from C<main>), to serve as an exit code indicating the nature of
2578 the way the program terminated. However, this isn't portable, due to
2579 differing exit code conventions. An attempt is made to return an exit
2580 code of the type required by the host operating system, but because
2581 it is constrained to be non-zero, it is not necessarily possible to
2582 indicate every type of exit. It is only reliable on Unix, where a zero
2583 exit code can be augmented with a set bit that will be ignored. In any
2584 case, this function is not the correct place to acquire an exit code:
2585 one should get that from L</perl_destruct>.
2597 PERL_ARGS_ASSERT_PERL_RUN;
2598 #ifndef MULTIPLICITY
2599 PERL_UNUSED_ARG(my_perl);
2602 oldscope = PL_scopestack_ix;
2610 cxstack_ix = -1; /* start context stack again */
2612 case 0: /* normal completion */
2616 case 2: /* my_exit() */
2617 while (PL_scopestack_ix > oldscope)
2620 SET_CURSTASH(PL_defstash);
2621 if (!(PL_exit_flags & PERL_EXIT_DESTRUCT_END) &&
2622 PL_endav && !PL_minus_c) {
2623 PERL_SET_PHASE(PERL_PHASE_END);
2624 call_list(oldscope, PL_endav);
2627 if (PerlEnv_getenv("PERL_DEBUG_MSTATS"))
2628 dump_mstats("after execution: ");
2634 POPSTACK_TO(PL_mainstack);
2637 PerlIO_printf(Perl_error_log, "panic: restartop in perl_run\n");
2648 S_run_body(pTHX_ I32 oldscope)
2650 DEBUG_r(PerlIO_printf(Perl_debug_log, "%s $` $& $' support (0x%x).\n",
2651 PL_sawampersand ? "Enabling" : "Omitting",
2652 (unsigned int)(PL_sawampersand)));
2654 if (!PL_restartop) {
2656 if (DEBUG_x_TEST || DEBUG_B_TEST)
2657 dump_all_perl(!DEBUG_B_TEST);
2659 PERL_DEBUG(PerlIO_printf(Perl_debug_log, "\nEXECUTING...\n\n"));
2663 PerlIO_printf(Perl_error_log, "%s syntax OK\n", PL_origfilename);
2666 if (PERLDB_SINGLE && PL_DBsingle)
2669 PERL_SET_PHASE(PERL_PHASE_INIT);
2670 call_list(oldscope, PL_initav);
2672 #ifdef PERL_DEBUG_READONLY_OPS
2673 if (PL_main_root && PL_main_root->op_slabbed)
2674 Slab_to_ro(OpSLAB(PL_main_root));
2680 PERL_SET_PHASE(PERL_PHASE_RUN);
2683 PL_restartjmpenv = NULL;
2684 PL_op = PL_restartop;
2688 else if (PL_main_start) {
2689 CvDEPTH(PL_main_cv) = 1;
2690 PL_op = PL_main_start;
2694 NOT_REACHED; /* NOTREACHED */
2698 =head1 SV Manipulation Functions
2700 =for apidoc p||get_sv
2702 Returns the SV of the specified Perl scalar. C<flags> are passed to
2703 C<gv_fetchpv>. If C<GV_ADD> is set and the
2704 Perl variable does not exist then it will be created. If C<flags> is zero
2705 and the variable does not exist then NULL is returned.
2711 Perl_get_sv(pTHX_ const char *name, I32 flags)
2715 PERL_ARGS_ASSERT_GET_SV;
2717 gv = gv_fetchpv(name, flags, SVt_PV);
2724 =head1 Array Manipulation Functions
2726 =for apidoc p||get_av
2728 Returns the AV of the specified Perl global or package array with the given
2729 name (so it won't work on lexical variables). C<flags> are passed
2730 to C<gv_fetchpv>. If C<GV_ADD> is set and the
2731 Perl variable does not exist then it will be created. If C<flags> is zero
2732 and the variable does not exist then NULL is returned.
2734 Perl equivalent: C<@{"$name"}>.
2740 Perl_get_av(pTHX_ const char *name, I32 flags)
2742 GV* const gv = gv_fetchpv(name, flags, SVt_PVAV);
2744 PERL_ARGS_ASSERT_GET_AV;
2754 =head1 Hash Manipulation Functions
2756 =for apidoc p||get_hv
2758 Returns the HV of the specified Perl hash. C<flags> are passed to
2759 C<gv_fetchpv>. If C<GV_ADD> is set and the
2760 Perl variable does not exist then it will be created. If C<flags> is zero
2761 and the variable does not exist then C<NULL> is returned.
2767 Perl_get_hv(pTHX_ const char *name, I32 flags)
2769 GV* const gv = gv_fetchpv(name, flags, SVt_PVHV);
2771 PERL_ARGS_ASSERT_GET_HV;
2781 =head1 CV Manipulation Functions
2783 =for apidoc p||get_cvn_flags
2785 Returns the CV of the specified Perl subroutine. C<flags> are passed to
2786 C<gv_fetchpvn_flags>. If C<GV_ADD> is set and the Perl subroutine does not
2787 exist then it will be declared (which has the same effect as saying
2788 C<sub name;>). If C<GV_ADD> is not set and the subroutine does not exist
2789 then NULL is returned.
2791 =for apidoc p||get_cv
2793 Uses C<strlen> to get the length of C<name>, then calls C<get_cvn_flags>.
2799 Perl_get_cvn_flags(pTHX_ const char *name, STRLEN len, I32 flags)
2801 GV* const gv = gv_fetchpvn_flags(name, len, flags, SVt_PVCV);
2803 PERL_ARGS_ASSERT_GET_CVN_FLAGS;
2805 if (gv && UNLIKELY(SvROK(gv)) && SvTYPE(SvRV((SV *)gv)) == SVt_PVCV)
2806 return (CV*)SvRV((SV *)gv);
2808 /* XXX this is probably not what they think they're getting.
2809 * It has the same effect as "sub name;", i.e. just a forward
2811 if ((flags & ~GV_NOADD_MASK) && !GvCVu(gv)) {
2812 return newSTUB(gv,0);
2819 /* Nothing in core calls this now, but we can't replace it with a macro and
2820 move it to mathoms.c as a macro would evaluate name twice. */
2822 Perl_get_cv(pTHX_ const char *name, I32 flags)
2824 PERL_ARGS_ASSERT_GET_CV;
2826 return get_cvn_flags(name, strlen(name), flags);
2829 /* Be sure to refetch the stack pointer after calling these routines. */
2833 =head1 Callback Functions
2835 =for apidoc p||call_argv
2837 Performs a callback to the specified named and package-scoped Perl subroutine
2838 with C<argv> (a C<NULL>-terminated array of strings) as arguments. See
2841 Approximate Perl equivalent: C<&{"$sub_name"}(@$argv)>.
2847 Perl_call_argv(pTHX_ const char *sub_name, I32 flags, char **argv)
2849 /* See G_* flags in cop.h */
2850 /* null terminated arg list */
2854 PERL_ARGS_ASSERT_CALL_ARGV;
2858 mXPUSHs(newSVpv(*argv,0));
2862 return call_pv(sub_name, flags);
2866 =for apidoc p||call_pv
2868 Performs a callback to the specified Perl sub. See L<perlcall>.
2874 Perl_call_pv(pTHX_ const char *sub_name, I32 flags)
2875 /* name of the subroutine */
2876 /* See G_* flags in cop.h */
2878 PERL_ARGS_ASSERT_CALL_PV;
2880 return call_sv(MUTABLE_SV(get_cv(sub_name, GV_ADD)), flags);
2884 =for apidoc p||call_method
2886 Performs a callback to the specified Perl method. The blessed object must
2887 be on the stack. See L<perlcall>.
2893 Perl_call_method(pTHX_ const char *methname, I32 flags)
2894 /* name of the subroutine */
2895 /* See G_* flags in cop.h */
2899 PERL_ARGS_ASSERT_CALL_METHOD;
2901 len = strlen(methname);
2902 sv = flags & G_METHOD_NAMED
2903 ? sv_2mortal(newSVpvn_share(methname, len,0))
2904 : newSVpvn_flags(methname, len, SVs_TEMP);
2906 return call_sv(sv, flags | G_METHOD);
2909 /* May be called with any of a CV, a GV, or an SV containing the name. */
2911 =for apidoc p||call_sv
2913 Performs a callback to the Perl sub specified by the SV.
2915 If neither the C<G_METHOD> nor C<G_METHOD_NAMED> flag is supplied, the
2916 SV may be any of a CV, a GV, a reference to a CV, a reference to a GV
2917 or C<SvPV(sv)> will be used as the name of the sub to call.
2919 If the C<G_METHOD> flag is supplied, the SV may be a reference to a CV or
2920 C<SvPV(sv)> will be used as the name of the method to call.
2922 If the C<G_METHOD_NAMED> flag is supplied, C<SvPV(sv)> will be used as
2923 the name of the method to call.
2925 Some other values are treated specially for internal use and should
2934 Perl_call_sv(pTHX_ SV *sv, volatile I32 flags)
2935 /* See G_* flags in cop.h */
2938 LOGOP myop; /* fake syntax tree node */
2941 volatile I32 retval = 0;
2942 bool oldcatch = CATCH_GET;
2944 OP* const oldop = PL_op;
2947 PERL_ARGS_ASSERT_CALL_SV;
2949 if (flags & G_DISCARD) {
2953 if (!(flags & G_WANT)) {
2954 /* Backwards compatibility - as G_SCALAR was 0, it could be omitted.
2959 Zero(&myop, 1, LOGOP);
2960 if (!(flags & G_NOARGS))
2961 myop.op_flags |= OPf_STACKED;
2962 myop.op_flags |= OP_GIMME_REVERSE(flags);
2966 if (!(flags & G_METHOD_NAMED)) {
2974 if (PERLDB_SUB && PL_curstash != PL_debstash
2975 /* Handle first BEGIN of -d. */
2976 && (PL_DBcv || (PL_DBcv = GvCV(PL_DBsub)))
2977 /* Try harder, since this may have been a sighandler, thus
2978 * curstash may be meaningless. */
2979 && (SvTYPE(sv) != SVt_PVCV || CvSTASH((const CV *)sv) != PL_debstash)
2980 && !(flags & G_NODEBUG))
2981 myop.op_private |= OPpENTERSUB_DB;
2983 if (flags & (G_METHOD|G_METHOD_NAMED)) {
2984 Zero(&method_op, 1, METHOP);
2985 method_op.op_next = (OP*)&myop;
2986 PL_op = (OP*)&method_op;
2987 if ( flags & G_METHOD_NAMED ) {
2988 method_op.op_ppaddr = PL_ppaddr[OP_METHOD_NAMED];
2989 method_op.op_type = OP_METHOD_NAMED;
2990 method_op.op_u.op_meth_sv = sv;
2992 method_op.op_ppaddr = PL_ppaddr[OP_METHOD];
2993 method_op.op_type = OP_METHOD;
2995 myop.op_ppaddr = PL_ppaddr[OP_ENTERSUB];
2996 myop.op_type = OP_ENTERSUB;
2999 if (!(flags & G_EVAL)) {
3001 CALL_BODY_SUB((OP*)&myop);
3002 retval = PL_stack_sp - (PL_stack_base + oldmark);
3003 CATCH_SET(oldcatch);
3007 myop.op_other = (OP*)&myop;
3009 old_cxix = cxstack_ix;
3010 create_eval_scope(NULL, flags|G_FAKINGEVAL);
3018 CALL_BODY_SUB((OP*)&myop);
3019 retval = PL_stack_sp - (PL_stack_base + oldmark);
3020 if (!(flags & G_KEEPERR)) {
3028 /* my_exit() was called */
3029 SET_CURSTASH(PL_defstash);
3033 NOT_REACHED; /* NOTREACHED */
3036 PL_restartjmpenv = NULL;
3037 PL_op = PL_restartop;
3041 PL_stack_sp = PL_stack_base + oldmark;
3042 if ((flags & G_WANT) == G_ARRAY)
3046 *++PL_stack_sp = &PL_sv_undef;
3051 /* if we croaked, depending on how we croaked the eval scope
3052 * may or may not have already been popped */
3053 if (cxstack_ix > old_cxix) {
3054 assert(cxstack_ix == old_cxix + 1);
3055 assert(CxTYPE(CX_CUR()) == CXt_EVAL);
3056 delete_eval_scope();
3061 if (flags & G_DISCARD) {
3062 PL_stack_sp = PL_stack_base + oldmark;
3071 /* Eval a string. The G_EVAL flag is always assumed. */
3074 =for apidoc p||eval_sv
3076 Tells Perl to C<eval> the string in the SV. It supports the same flags
3077 as C<call_sv>, with the obvious exception of C<G_EVAL>. See L<perlcall>.
3083 Perl_eval_sv(pTHX_ SV *sv, I32 flags)
3085 /* See G_* flags in cop.h */
3088 UNOP myop; /* fake syntax tree node */
3089 volatile I32 oldmark;
3090 volatile I32 retval = 0;
3092 OP* const oldop = PL_op;
3095 PERL_ARGS_ASSERT_EVAL_SV;
3097 if (flags & G_DISCARD) {
3104 Zero(&myop, 1, UNOP);
3107 oldmark = SP - PL_stack_base;
3113 if (!(flags & G_NOARGS))
3114 myop.op_flags = OPf_STACKED;
3115 myop.op_type = OP_ENTEREVAL;
3116 myop.op_flags |= OP_GIMME_REVERSE(flags);
3117 if (flags & G_KEEPERR)
3118 myop.op_flags |= OPf_SPECIAL;
3120 if (flags & G_RE_REPARSING)
3121 myop.op_private = (OPpEVAL_COPHH | OPpEVAL_RE_REPARSING);
3123 /* fail now; otherwise we could fail after the JMPENV_PUSH but
3124 * before a cx_pusheval(), which corrupts the stack after a croak */
3125 TAINT_PROPER("eval_sv()");
3131 if (PL_op == (OP*)(&myop)) {
3132 PL_op = PL_ppaddr[OP_ENTEREVAL](aTHX);
3134 goto fail; /* failed in compilation */
3137 retval = PL_stack_sp - (PL_stack_base + oldmark);
3138 if (!(flags & G_KEEPERR)) {
3146 /* my_exit() was called */
3147 SET_CURSTASH(PL_defstash);
3151 NOT_REACHED; /* NOTREACHED */
3154 PL_restartjmpenv = NULL;
3155 PL_op = PL_restartop;
3160 PL_stack_sp = PL_stack_base + oldmark;
3161 if ((flags & G_WANT) == G_ARRAY)
3165 *++PL_stack_sp = &PL_sv_undef;
3171 if (flags & G_DISCARD) {
3172 PL_stack_sp = PL_stack_base + oldmark;
3182 =for apidoc p||eval_pv
3184 Tells Perl to C<eval> the given string in scalar context and return an SV* result.
3190 Perl_eval_pv(pTHX_ const char *p, I32 croak_on_error)
3192 SV* sv = newSVpv(p, 0);
3194 PERL_ARGS_ASSERT_EVAL_PV;
3196 eval_sv(sv, G_SCALAR);
3205 /* just check empty string or undef? */
3206 if (croak_on_error) {
3207 SV * const errsv = ERRSV;
3208 if(SvTRUE_NN(errsv))
3209 /* replace with croak_sv? */
3210 Perl_croak_nocontext("%s", SvPV_nolen_const(errsv));
3216 /* Require a module. */
3219 =head1 Embedding Functions
3221 =for apidoc p||require_pv
3223 Tells Perl to C<require> the file named by the string argument. It is
3224 analogous to the Perl code C<eval "require '$file'">. It's even
3225 implemented that way; consider using load_module instead.
3230 Perl_require_pv(pTHX_ const char *pv)
3235 PERL_ARGS_ASSERT_REQUIRE_PV;
3237 PUSHSTACKi(PERLSI_REQUIRE);
3238 sv = Perl_newSVpvf(aTHX_ "require q%c%s%c", 0, pv, 0);
3239 eval_sv(sv_2mortal(sv), G_DISCARD);
3244 S_usage(pTHX) /* XXX move this out into a module ? */
3246 /* This message really ought to be max 23 lines.
3247 * Removed -h because the user already knows that option. Others? */
3249 /* Grouped as 6 lines per C string literal, to keep under the ANSI C 89
3250 minimum of 509 character string literals. */
3251 static const char * const usage_msg[] = {
3252 " -0[octal] specify record separator (\\0, if no argument)\n"
3253 " -a autosplit mode with -n or -p (splits $_ into @F)\n"
3254 " -C[number/list] enables the listed Unicode features\n"
3255 " -c check syntax only (runs BEGIN and CHECK blocks)\n"
3256 " -d[:debugger] run program under debugger\n"
3257 " -D[number/list] set debugging flags (argument is a bit mask or alphabets)\n",
3258 " -e program one line of program (several -e's allowed, omit programfile)\n"
3259 " -E program like -e, but enables all optional features\n"
3260 " -f don't do $sitelib/sitecustomize.pl at startup\n"
3261 " -F/pattern/ split() pattern for -a switch (//'s are optional)\n"
3262 " -i[extension] edit <> files in place (makes backup if extension supplied)\n"
3263 " -Idirectory specify @INC/#include directory (several -I's allowed)\n",
3264 " -l[octal] enable line ending processing, specifies line terminator\n"
3265 " -[mM][-]module execute \"use/no module...\" before executing program\n"
3266 " -n assume \"while (<>) { ... }\" loop around program\n"
3267 " -p assume loop like -n but print line also, like sed\n"
3268 " -s enable rudimentary parsing for switches after programfile\n"
3269 " -S look for programfile using PATH environment variable\n",
3270 " -t enable tainting warnings\n"
3271 " -T enable tainting checks\n"
3272 " -u dump core after parsing program\n"
3273 " -U allow unsafe operations\n"
3274 " -v print version, patchlevel and license\n"
3275 " -V[:variable] print configuration summary (or a single Config.pm variable)\n",
3276 " -w enable many useful warnings\n"
3277 " -W enable all warnings\n"
3278 " -x[directory] ignore text before #!perl line (optionally cd to directory)\n"
3279 " -X disable all warnings\n"
3281 "Run 'perldoc perl' for more help with Perl.\n\n",
3284 const char * const *p = usage_msg;
3285 PerlIO *out = PerlIO_stdout();
3288 "\nUsage: %s [switches] [--] [programfile] [arguments]\n",
3291 PerlIO_puts(out, *p++);
3295 /* convert a string of -D options (or digits) into an int.
3296 * sets *s to point to the char after the options */
3300 Perl_get_debug_opts(pTHX_ const char **s, bool givehelp)
3302 static const char * const usage_msgd[] = {
3303 " Debugging flag values: (see also -d)\n"
3304 " p Tokenizing and parsing (with v, displays parse stack)\n"
3305 " s Stack snapshots (with v, displays all stacks)\n"
3306 " l Context (loop) stack processing\n"
3307 " t Trace execution\n"
3308 " o Method and overloading resolution\n",
3309 " c String/numeric conversions\n"
3310 " P Print profiling info, source file input state\n"
3311 " m Memory and SV allocation\n"
3312 " f Format processing\n"
3313 " r Regular expression parsing and execution\n"
3314 " x Syntax tree dump\n",
3315 " u Tainting checks\n"
3316 " H Hash dump -- usurps values()\n"
3317 " X Scratchpad allocation\n"
3319 " S Op slab allocation\n"
3321 " R Include reference counts of dumped variables (eg when using -Ds)\n",
3322 " J Do not s,t,P-debug (Jump over) opcodes within package DB\n"
3323 " v Verbose: use in conjunction with other flags\n"
3324 " C Copy On Write\n"
3325 " A Consistency checks on internal structures\n"
3326 " q quiet - currently only suppresses the 'EXECUTING' message\n"
3327 " M trace smart match resolution\n"
3328 " B dump suBroutine definitions, including special Blocks like BEGIN\n",
3329 " L trace some locale setting information--for Perl core development\n",
3330 " i trace PerlIO layer processing\n",
3335 PERL_ARGS_ASSERT_GET_DEBUG_OPTS;
3338 /* if adding extra options, remember to update DEBUG_MASK */
3339 static const char debopts[] = "psltocPmfrxuUHXDSTRJvCAqMBLi";
3341 for (; isWORDCHAR(**s); (*s)++) {
3342 const char * const d = strchr(debopts,**s);
3344 uv |= 1 << (d - debopts);
3345 else if (ckWARN_d(WARN_DEBUGGING))
3346 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3347 "invalid option -D%c, use -D'' to see choices\n", **s);
3350 else if (isDIGIT(**s)) {
3351 const char* e = *s + strlen(*s);
3352 if (grok_atoUV(*s, &uv, &e))
3354 for (; isWORDCHAR(**s); (*s)++) ;
3356 else if (givehelp) {
3357 const char *const *p = usage_msgd;
3358 while (*p) PerlIO_puts(PerlIO_stdout(), *p++);
3360 return (int)uv; /* ignore any UV->int conversion loss */
3364 /* This routine handles any switches that can be given during run */
3367 Perl_moreswitches(pTHX_ const char *s)
3371 const char option = *s; /* used to remember option in -m/-M code */
3373 PERL_ARGS_ASSERT_MORESWITCHES;
3381 SvREFCNT_dec(PL_rs);
3382 if (s[1] == 'x' && s[2]) {
3383 const char *e = s+=2;
3389 flags = PERL_SCAN_SILENT_ILLDIGIT;
3390 rschar = (U32)grok_hex(s, &numlen, &flags, NULL);
3391 if (s + numlen < e) {
3392 rschar = 0; /* Grandfather -0xFOO as -0 -xFOO. */
3396 PL_rs = newSVpvs("");
3397 tmps = (U8*) SvGROW(PL_rs, (STRLEN)(UVCHR_SKIP(rschar) + 1));
3398 uvchr_to_utf8(tmps, rschar);
3399 SvCUR_set(PL_rs, UVCHR_SKIP(rschar));
3404 rschar = (U32)grok_oct(s, &numlen, &flags, NULL);
3405 if (rschar & ~((U8)~0))
3406 PL_rs = &PL_sv_undef;
3407 else if (!rschar && numlen >= 2)
3408 PL_rs = newSVpvs("");
3410 char ch = (char)rschar;
3411 PL_rs = newSVpvn(&ch, 1);
3414 sv_setsv(get_sv("/", GV_ADD), PL_rs);
3419 PL_unicode = parse_unicode_opts( (const char **)&s );
3420 if (PL_unicode & PERL_UNICODE_UTF8CACHEASSERT_FLAG)
3428 while (*s && !isSPACE(*s)) ++s;
3429 PL_splitstr = savepvn(PL_splitstr, s - PL_splitstr);
3441 forbid_setid('d', FALSE);
3444 /* -dt indicates to the debugger that threads will be used */
3445 if (*s == 't' && !isWORDCHAR(s[1])) {
3447 my_setenv("PERL5DB_THREADED", "1");
3450 /* The following permits -d:Mod to accepts arguments following an =
3451 in the fashion that -MSome::Mod does. */
3452 if (*s == ':' || *s == '=') {
3459 sv = newSVpvs("no Devel::");
3461 sv = newSVpvs("use Devel::");
3465 end = s + strlen(s);
3467 /* We now allow -d:Module=Foo,Bar and -d:-Module */
3468 while(isWORDCHAR(*s) || *s==':') ++s;
3470 sv_catpvn(sv, start, end - start);
3472 sv_catpvn(sv, start, s-start);
3473 /* Don't use NUL as q// delimiter here, this string goes in the
3475 Perl_sv_catpvf(aTHX_ sv, " split(/,/,q{%s});", ++s);
3478 my_setenv("PERL5DB", SvPV_nolen_const(sv));
3482 PL_perldb = PERLDB_ALL;
3489 forbid_setid('D', FALSE);
3491 PL_debug = get_debug_opts( (const char **)&s, 1) | DEBUG_TOP_FLAG;
3492 #else /* !DEBUGGING */
3493 if (ckWARN_d(WARN_DEBUGGING))
3494 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3495 "Recompile perl with -DDEBUGGING to use -D switch (did you mean -d ?)\n");
3496 for (s++; isWORDCHAR(*s); s++) ;
3499 NOT_REACHED; /* NOTREACHED */
3503 NOT_REACHED; /* NOTREACHED */
3506 Safefree(PL_inplace);
3508 const char * const start = ++s;
3509 while (*s && !isSPACE(*s))
3512 PL_inplace = savepvn(start, s - start);
3515 case 'I': /* -I handled both here and in parse_body() */
3516 forbid_setid('I', FALSE);
3518 while (*s && isSPACE(*s))
3523 /* ignore trailing spaces (possibly followed by other switches) */
3525 for (e = p; *e && !isSPACE(*e); e++) ;
3529 } while (*p && *p != '-');
3531 INCPUSH_ADD_SUB_DIRS|INCPUSH_ADD_OLD_VERS|INCPUSH_UNSHIFT);
3537 Perl_croak(aTHX_ "No directory specified for -I");
3543 SvREFCNT_dec(PL_ors_sv);
3549 PL_ors_sv = newSVpvs("\n");
3550 numlen = 3 + (*s == '0');
3551 *SvPVX(PL_ors_sv) = (char)grok_oct(s, &numlen, &flags, NULL);
3555 if (RsPARA(PL_rs)) {
3556 PL_ors_sv = newSVpvs("\n\n");
3559 PL_ors_sv = newSVsv(PL_rs);
3564 forbid_setid('M', FALSE); /* XXX ? */
3567 forbid_setid('m', FALSE); /* XXX ? */
3572 const char *use = "use ";
3574 /* -M-foo == 'no foo' */
3575 /* Leading space on " no " is deliberate, to make both
3576 possibilities the same length. */
3577 if (*s == '-') { use = " no "; ++s; }
3578 sv = newSVpvn(use,4);
3580 /* We allow -M'Module qw(Foo Bar)' */
3581 while(isWORDCHAR(*s) || *s==':') {
3590 Perl_croak(aTHX_ "Module name required with -%c option",
3593 Perl_croak(aTHX_ "Invalid module name %.*s with -%c option: "
3594 "contains single ':'",
3595 (int)(s - start), start, option);
3596 end = s + strlen(s);
3598 sv_catpvn(sv, start, end - start);
3599 if (option == 'm') {
3601 Perl_croak(aTHX_ "Can't use '%c' after -mname", *s);
3602 sv_catpvs( sv, " ()");
3605 sv_catpvn(sv, start, s-start);
3606 /* Use NUL as q''-delimiter. */
3607 sv_catpvs(sv, " split(/,/,q\0");
3609 sv_catpvn(sv, s, end - s);
3610 sv_catpvs(sv, "\0)");
3613 Perl_av_create_and_push(aTHX_ &PL_preambleav, sv);
3616 Perl_croak(aTHX_ "Missing argument to -%c", option);
3627 forbid_setid('s', FALSE);
3628 PL_doswitches = TRUE;
3633 #if defined(SILENT_NO_TAINT_SUPPORT)
3634 /* silently ignore */
3635 #elif defined(NO_TAINT_SUPPORT)
3636 Perl_croak_nocontext("This perl was compiled without taint support. "
3637 "Cowardly refusing to run with -t or -T flags");
3645 PL_do_undump = TRUE;
3655 if (! (PL_dowarn & G_WARN_ALL_MASK)) {
3656 PL_dowarn |= G_WARN_ON;
3661 PL_dowarn = G_WARN_ALL_ON|G_WARN_ON;
3662 if (!specialWARN(PL_compiling.cop_warnings))
3663 PerlMemShared_free(PL_compiling.cop_warnings);
3664 PL_compiling.cop_warnings = pWARN_ALL ;
3668 PL_dowarn = G_WARN_ALL_OFF;
3669 if (!specialWARN(PL_compiling.cop_warnings))
3670 PerlMemShared_free(PL_compiling.cop_warnings);
3671 PL_compiling.cop_warnings = pWARN_NONE ;
3678 if (s[0] == '-') /* Additional switches on #! line. */
3683 #if defined(WIN32) || !defined(PERL_STRICT_CR)
3689 #ifdef ALTERNATE_SHEBANG
3690 case 'S': /* OS/2 needs -S on "extproc" line. */
3693 case 'e': case 'f': case 'x': case 'E':
3694 #ifndef ALTERNATE_SHEBANG
3698 Perl_croak(aTHX_ "Can't emulate -%.1s on #! line",s);
3701 "Unrecognized switch: -%.1s (-h will show valid options)",s
3711 PerlIO * PIO_stdout;
3713 const char * const level_str = "v" PERL_VERSION_STRING;
3714 const STRLEN level_len = sizeof("v" PERL_VERSION_STRING)-1;
3715 #ifdef PERL_PATCHNUM
3717 # ifdef PERL_GIT_UNCOMMITTED_CHANGES
3718 static const char num [] = PERL_PATCHNUM "*";
3720 static const char num [] = PERL_PATCHNUM;
3723 const STRLEN num_len = sizeof(num)-1;
3724 /* A very advanced compiler would fold away the strnEQ
3725 and this whole conditional, but most (all?) won't do it.
3726 SV level could also be replaced by with preprocessor
3729 if (num_len >= level_len && strnEQ(num,level_str,level_len)) {
3730 /* per 46807d8e80, PERL_PATCHNUM is outside of the control
3731 of the interp so it might contain format characters
3733 level = newSVpvn(num, num_len);
3735 level = Perl_newSVpvf_nocontext("%s (%s)", level_str, num);
3739 SV* level = newSVpvn(level_str, level_len);
3740 #endif /* #ifdef PERL_PATCHNUM */
3741 PIO_stdout = PerlIO_stdout();
3742 PerlIO_printf(PIO_stdout,
3743 "\nThis is perl " STRINGIFY(PERL_REVISION)
3744 ", version " STRINGIFY(PERL_VERSION)
3745 ", subversion " STRINGIFY(PERL_SUBVERSION)
3746 " (%" SVf ") built for " ARCHNAME, SVfARG(level)
3748 SvREFCNT_dec_NN(level);
3750 #if defined(LOCAL_PATCH_COUNT)
3751 if (LOCAL_PATCH_COUNT > 0)
3752 PerlIO_printf(PIO_stdout,
3753 "\n(with %d registered patch%s, "
3754 "see perl -V for more detail)",
3756 (LOCAL_PATCH_COUNT!=1) ? "es" : "");
3759 PerlIO_printf(PIO_stdout,
3760 "\n\nCopyright 1987-2018, Larry Wall\n");
3762 PerlIO_printf(PIO_stdout,
3763 "\nMS-DOS port Copyright (c) 1989, 1990, Diomidis Spinellis\n");
3766 PerlIO_printf(PIO_stdout,
3767 "djgpp v2 port (jpl5003c) by Hirofumi Watanabe, 1996\n"
3768 "djgpp v2 port (perl5004+) by Laszlo Molnar, 1997-1999\n");
3771 PerlIO_printf(PIO_stdout,
3772 "\n\nOS/2 port Copyright (c) 1990, 1991, Raymond Chen, Kai Uwe Rommel\n"
3773 "Version 5 port Copyright (c) 1994-2002, Andreas Kaiser, Ilya Zakharevich\n");
3776 PerlIO_printf(PIO_stdout,
3777 "MVS (OS390) port by Mortice Kern Systems, 1997-1999\n");
3780 PerlIO_printf(PIO_stdout,
3781 "Stratus OpenVOS port by Paul.Green@stratus.com, 1997-2013\n");
3784 PerlIO_printf(PIO_stdout,
3785 "BS2000 (POSIX) port by Start Amadeus GmbH, 1998-1999\n");
3788 PerlIO_printf(PIO_stdout,
3789 "WINCE port by Rainer Keuchel, 2001-2002\n"
3790 "Built on " __DATE__ " " __TIME__ "\n\n");
3793 #ifdef __SYMBIAN32__
3794 PerlIO_printf(PIO_stdout,
3795 "Symbian port by Nokia, 2004-2005\n");
3797 #ifdef BINARY_BUILD_NOTICE
3798 BINARY_BUILD_NOTICE;
3800 PerlIO_printf(PIO_stdout,
3802 Perl may be copied only under the terms of either the Artistic License or the\n\
3803 GNU General Public License, which may be found in the Perl 5 source kit.\n\n\
3804 Complete documentation for Perl, including FAQ lists, should be found on\n\
3805 this system using \"man perl\" or \"perldoc perl\". If you have access to the\n\
3806 Internet, point your browser at http://www.perl.org/, the Perl Home Page.\n\n");
3810 /* compliments of Tom Christiansen */
3812 /* unexec() can be found in the Gnu emacs distribution */
3813 /* Known to work with -DUNEXEC and using unexelf.c from GNU emacs-20.2 */
3816 #include <lib$routines.h>
3820 Perl_my_unexec(pTHX)
3823 SV * prog = newSVpv(BIN_EXP, 0);
3824 SV * file = newSVpv(PL_origfilename, 0);
3828 sv_catpvs(prog, "/perl");
3829 sv_catpvs(file, ".perldump");
3831 unexec(SvPVX(file), SvPVX(prog), &etext, sbrk(0), 0);
3832 /* unexec prints msg to stderr in case of failure */
3833 PerlProc_exit(status);
3835 PERL_UNUSED_CONTEXT;
3837 lib$signal(SS$_DEBUG); /* ssdef.h #included from vmsish.h */
3838 # elif defined(WIN32) || defined(__CYGWIN__)
3839 Perl_croak_nocontext("dump is not supported");
3841 ABORT(); /* for use with undump */
3846 /* initialize curinterp */
3851 # define PERLVAR(prefix,var,type)
3852 # define PERLVARA(prefix,var,n,type)
3853 # if defined(PERL_IMPLICIT_CONTEXT)
3854 # define PERLVARI(prefix,var,type,init) aTHX->prefix##var = init;
3855 # define PERLVARIC(prefix,var,type,init) aTHX->prefix##var = init;
3857 # define PERLVARI(prefix,var,type,init) PERL_GET_INTERP->var = init;
3858 # define PERLVARIC(prefix,var,type,init) PERL_GET_INTERP->var = init;
3860 # include "intrpvar.h"
3866 # define PERLVAR(prefix,var,type)
3867 # define PERLVARA(prefix,var,n,type)
3868 # define PERLVARI(prefix,var,type,init) PL_##var = init;
3869 # define PERLVARIC(prefix,var,type,init) PL_##var = init;
3870 # include "intrpvar.h"
3880 S_init_main_stash(pTHX)
3885 PL_curstash = PL_defstash = (HV *)SvREFCNT_inc_simple_NN(hv);
3886 /* We know that the string "main" will be in the global shared string
3887 table, so it's a small saving to use it rather than allocate another
3889 PL_curstname = newSVpvs_share("main");
3890 gv = gv_fetchpvs("main::", GV_ADD|GV_NOTQUAL, SVt_PVHV);
3891 /* If we hadn't caused another reference to "main" to be in the shared
3892 string table above, then it would be worth reordering these two,
3893 because otherwise all we do is delete "main" from it as a consequence
3894 of the SvREFCNT_dec, only to add it again with hv_name_set */
3895 SvREFCNT_dec(GvHV(gv));
3896 hv_name_sets(PL_defstash, "main", 0);
3897 GvHV(gv) = MUTABLE_HV(SvREFCNT_inc_simple(PL_defstash));
3899 PL_incgv = gv_HVadd(gv_AVadd(gv_fetchpvs("INC", GV_ADD|GV_NOTQUAL,
3901 SvREFCNT_inc_simple_void(PL_incgv); /* Don't allow it to be freed */
3902 GvMULTI_on(PL_incgv);
3903 PL_hintgv = gv_fetchpvs("\010", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^H */
3904 SvREFCNT_inc_simple_void(PL_hintgv);
3905 GvMULTI_on(PL_hintgv);
3906 PL_defgv = gv_fetchpvs("_", GV_ADD|GV_NOTQUAL, SVt_PVAV);
3907 SvREFCNT_inc_simple_void(PL_defgv);
3908 PL_errgv = gv_fetchpvs("@", GV_ADD|GV_NOTQUAL, SVt_PV);
3909 SvREFCNT_inc_simple_void(PL_errgv);
3910 GvMULTI_on(PL_errgv);
3911 PL_replgv = gv_fetchpvs("\022", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^R */
3912 SvREFCNT_inc_simple_void(PL_replgv);
3913 GvMULTI_on(PL_replgv);
3914 (void)Perl_form(aTHX_ "%240s",""); /* Preallocate temp - for immediate signals. */
3915 #ifdef PERL_DONT_CREATE_GVSV
3916 (void)gv_SVadd(PL_errgv);
3918 sv_grow(ERRSV, 240); /* Preallocate - for immediate signals. */
3920 CopSTASH_set(&PL_compiling, PL_defstash);
3921 PL_debstash = GvHV(gv_fetchpvs("DB::", GV_ADDMULTI, SVt_PVHV));
3922 PL_globalstash = GvHV(gv_fetchpvs("CORE::GLOBAL::", GV_ADDMULTI,
3924 /* We must init $/ before switches are processed. */
3925 sv_setpvs(get_sv("/", GV_ADD), "\n");
3929 S_open_script(pTHX_ const char *scriptname, bool dosearch, bool *suidscript)
3932 PerlIO *rsfp = NULL;
3936 PERL_ARGS_ASSERT_OPEN_SCRIPT;
3939 PL_origfilename = savepvs("-e");
3944 /* if find_script() returns, it returns a malloc()-ed value */
3945 scriptname = PL_origfilename = find_script(scriptname, dosearch, NULL, 1);
3946 s = scriptname + strlen(scriptname);
3948 if (strBEGINs(scriptname, "/dev/fd/")
3949 && isDIGIT(scriptname[8])
3950 && grok_atoUV(scriptname + 8, &uv, &s)
3951 && uv <= PERL_INT_MAX
3956 * Tell apart "normal" usage of fdscript, e.g.
3957 * with bash on FreeBSD:
3958 * perl <( echo '#!perl -DA'; echo 'print "$0\n"')
3959 * from usage in suidperl.
3960 * Does any "normal" usage leave garbage after the number???
3961 * Is it a mistake to use a similar /dev/fd/ construct for
3966 * Be supersafe and do some sanity-checks.
3967 * Still, can we be sure we got the right thing?
3970 Perl_croak(aTHX_ "Wrong syntax (suid) fd script name \"%s\"\n", s);
3973 Perl_croak(aTHX_ "Missing (suid) fd script name\n");
3975 scriptname = savepv(s + 1);
3976 Safefree(PL_origfilename);
3977 PL_origfilename = (char *)scriptname;
3982 CopFILE_free(PL_curcop);
3983 CopFILE_set(PL_curcop, PL_origfilename);
3984 if (*PL_origfilename == '-' && PL_origfilename[1] == '\0')
3985 scriptname = (char *)"";
3986 if (fdscript >= 0) {
3987 rsfp = PerlIO_fdopen(fdscript,PERL_SCRIPT_MODE);
3989 else if (!*scriptname) {
3990 forbid_setid(0, *suidscript);
3994 #ifdef FAKE_BIT_BUCKET
3995 /* This hack allows one not to have /dev/null (or BIT_BUCKET as it
3996 * is called) and still have the "-e" work. (Believe it or not,
3997 * a /dev/null is required for the "-e" to work because source
3998 * filter magic is used to implement it. ) This is *not* a general
3999 * replacement for a /dev/null. What we do here is create a temp
4000 * file (an empty file), open up that as the script, and then
4001 * immediately close and unlink it. Close enough for jazz. */
4002 #define FAKE_BIT_BUCKET_PREFIX "/tmp/perlnull-"
4003 #define FAKE_BIT_BUCKET_SUFFIX "XXXXXXXX"
4004 #define FAKE_BIT_BUCKET_TEMPLATE FAKE_BIT_BUCKET_PREFIX FAKE_BIT_BUCKET_SUFFIX
4005 char tmpname[sizeof(FAKE_BIT_BUCKET_TEMPLATE)] = {
4006 FAKE_BIT_BUCKET_TEMPLATE
4008 const char * const err = "Failed to create a fake bit bucket";
4009 if (strEQ(scriptname, BIT_BUCKET)) {
4010 int tmpfd = Perl_my_mkstemp_cloexec(tmpname);
4012 scriptname = tmpname;
4015 Perl_croak(aTHX_ err);
4018 rsfp = PerlIO_open(scriptname,PERL_SCRIPT_MODE);
4019 #ifdef FAKE_BIT_BUCKET
4020 if ( strBEGINs(scriptname, FAKE_BIT_BUCKET_PREFIX)
4021 && strlen(scriptname) == sizeof(tmpname) - 1)
4025 scriptname = BIT_BUCKET;
4029 /* PSz 16 Sep 03 Keep neat error message */
4031 Perl_croak(aTHX_ "Can't open " BIT_BUCKET ": %s\n", Strerror(errno));
4033 Perl_croak(aTHX_ "Can't open perl script \"%s\": %s\n",
4034 CopFILE(PL_curcop), Strerror(errno));
4036 fd = PerlIO_fileno(rsfp);
4039 (PerlLIO_fstat(fd, &tmpstatbuf) >= 0
4040 && S_ISDIR(tmpstatbuf.st_mode)))
4041 Perl_croak(aTHX_ "Can't open perl script \"%s\": %s\n",
4048 /* In the days of suidperl, we refused to execute a setuid script stored on
4049 * a filesystem mounted nosuid and/or noexec. This meant that we probed for the
4050 * existence of the appropriate filesystem-statting function, and behaved
4051 * accordingly. But even though suidperl is long gone, we must still include
4052 * those probes for the benefit of modules like Filesys::Df, which expect the
4053 * results of those probes to be stored in %Config; see RT#126368. So mention
4054 * the relevant cpp symbols here, to ensure that metaconfig will include their
4055 * probes in the generated Configure:
4057 * I_SYSSTATVFS HAS_FSTATVFS
4059 * I_STATFS HAS_FSTATFS HAS_GETFSSTAT
4060 * I_MNTENT HAS_GETMNTENT HAS_HASMNTOPT
4064 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
4065 /* Don't even need this function. */
4068 S_validate_suid(pTHX_ PerlIO *rsfp)
4070 const Uid_t my_uid = PerlProc_getuid();
4071 const Uid_t my_euid = PerlProc_geteuid();
4072 const Gid_t my_gid = PerlProc_getgid();
4073 const Gid_t my_egid = PerlProc_getegid();
4075 PERL_ARGS_ASSERT_VALIDATE_SUID;
4077 if (my_euid != my_uid || my_egid != my_gid) { /* (suidperl doesn't exist, in fact) */
4079 int fd = PerlIO_fileno(rsfp);
4081 if (fd < 0 || PerlLIO_fstat(fd, &statbuf) < 0) { /* may be either wrapped or real suid */
4082 Perl_croak_nocontext( "Illegal suidscript");
4084 if ((my_euid != my_uid && my_euid == statbuf.st_uid && statbuf.st_mode & S_ISUID)
4086 (my_egid != my_gid && my_egid == statbuf.st_gid && statbuf.st_mode & S_ISGID)
4089 Perl_croak(aTHX_ "YOU HAVEN'T DISABLED SET-ID SCRIPTS IN THE KERNEL YET!\n\
4090 FIX YOUR KERNEL, PUT A C WRAPPER AROUND THIS SCRIPT, OR USE -u AND UNDUMP!\n");
4091 /* not set-id, must be wrapped */
4094 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4097 S_find_beginning(pTHX_ SV* linestr_sv, PerlIO *rsfp)
4102 PERL_ARGS_ASSERT_FIND_BEGINNING;
4104 /* skip forward in input to the real script? */
4107 if ((s = sv_gets(linestr_sv, rsfp, 0)) == NULL)
4108 Perl_croak(aTHX_ "No Perl script found in input\n");
4110 } while (!(*s == '#' && s[1] == '!' && ((s = instr(s,"perl")) || (s = instr(s2,"PERL")))));
4111 PerlIO_ungetc(rsfp, '\n'); /* to keep line count right */
4112 while (*s && !(isSPACE (*s) || *s == '#')) s++;
4114 while (*s == ' ' || *s == '\t') s++;
4116 while (isDIGIT(s2[-1]) || s2[-1] == '-' || s2[-1] == '.'
4117 || s2[-1] == '_') s2--;
4118 if (strBEGINs(s2-4,"perl"))
4119 while ((s = moreswitches(s)))
4128 /* no need to do anything here any more if we don't
4130 #ifndef NO_TAINT_SUPPORT
4131 const Uid_t my_uid = PerlProc_getuid();
4132 const Uid_t my_euid = PerlProc_geteuid();
4133 const Gid_t my_gid = PerlProc_getgid();
4134 const Gid_t my_egid = PerlProc_getegid();
4136 PERL_UNUSED_CONTEXT;
4138 /* Should not happen: */
4139 CHECK_MALLOC_TAINT(my_uid && (my_euid != my_uid || my_egid != my_gid));
4140 TAINTING_set( TAINTING_get | (my_uid && (my_euid != my_uid || my_egid != my_gid)) );
4144 * Should go by suidscript, not uid!=euid: why disallow
4145 * system("ls") in scripts run from setuid things?
4146 * Or, is this run before we check arguments and set suidscript?
4147 * What about SETUID_SCRIPTS_ARE_SECURE_NOW: could we use fdscript then?
4148 * (We never have suidscript, can we be sure to have fdscript?)
4149 * Or must then go by UID checks? See comments in forbid_setid also.
4153 /* This is used very early in the lifetime of the program,
4154 * before even the options are parsed, so PL_tainting has
4155 * not been initialized properly. */
4157 Perl_doing_taint(int argc, char *argv[], char *envp[])
4159 #ifndef PERL_IMPLICIT_SYS
4160 /* If we have PERL_IMPLICIT_SYS we can't call getuid() et alia
4161 * before we have an interpreter-- and the whole point of this
4162 * function is to be called at such an early stage. If you are on
4163 * a system with PERL_IMPLICIT_SYS but you do have a concept of
4164 * "tainted because running with altered effective ids', you'll
4165 * have to add your own checks somewhere in here. The two most
4166 * known samples of 'implicitness' are Win32 and NetWare, neither
4167 * of which has much of concept of 'uids'. */
4168 Uid_t uid = PerlProc_getuid();
4169 Uid_t euid = PerlProc_geteuid();
4170 Gid_t gid = PerlProc_getgid();
4171 Gid_t egid = PerlProc_getegid();
4178 if (uid && (euid != uid || egid != gid))
4180 #endif /* !PERL_IMPLICIT_SYS */
4181 /* This is a really primitive check; environment gets ignored only
4182 * if -T are the first chars together; otherwise one gets
4183 * "Too late" message. */
4184 if ( argc > 1 && argv[1][0] == '-'
4185 && isALPHA_FOLD_EQ(argv[1][1], 't'))
4190 /* Passing the flag as a single char rather than a string is a slight space
4191 optimisation. The only message that isn't /^-.$/ is
4192 "program input from stdin", which is substituted in place of '\0', which
4193 could never be a command line flag. */
4195 S_forbid_setid(pTHX_ const char flag, const bool suidscript) /* g */
4197 char string[3] = "-x";
4198 const char *message = "program input from stdin";
4200 PERL_UNUSED_CONTEXT;
4206 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
4207 if (PerlProc_getuid() != PerlProc_geteuid())
4208 Perl_croak(aTHX_ "No %s allowed while running setuid", message);
4209 if (PerlProc_getgid() != PerlProc_getegid())
4210 Perl_croak(aTHX_ "No %s allowed while running setgid", message);
4211 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4213 Perl_croak(aTHX_ "No %s allowed with (suid) fdscript", message);
4217 Perl_init_dbargs(pTHX)
4219 AV *const args = PL_dbargs = GvAV(gv_AVadd((gv_fetchpvs("DB::args",
4224 /* Someone has already created it.
4225 It might have entries, and if we just turn off AvREAL(), they will
4226 "leak" until global destruction. */
4228 if (SvTIED_mg((const SV *)args, PERL_MAGIC_tied))
4229 Perl_croak(aTHX_ "Cannot set tied @DB::args");
4231 AvREIFY_only(PL_dbargs);
4235 Perl_init_debugger(pTHX)
4237 HV * const ostash = PL_curstash;
4240 PL_curstash = (HV *)SvREFCNT_inc_simple(PL_debstash);
4242 Perl_init_dbargs(aTHX);
4243 PL_DBgv = MUTABLE_GV(
4244 SvREFCNT_inc(gv_fetchpvs("DB::DB", GV_ADDMULTI, SVt_PVGV))
4246 PL_DBline = MUTABLE_GV(
4247 SvREFCNT_inc(gv_fetchpvs("DB::dbline", GV_ADDMULTI, SVt_PVAV))
4249 PL_DBsub = MUTABLE_GV(SvREFCNT_inc(
4250 gv_HVadd(gv_fetchpvs("DB::sub", GV_ADDMULTI, SVt_PVHV))
4252 PL_DBsingle = GvSV((gv_fetchpvs("DB::single", GV_ADDMULTI, SVt_PV)));
4253 if (!SvIOK(PL_DBsingle))
4254 sv_setiv(PL_DBsingle, 0);
4255 mg = sv_magicext(PL_DBsingle, NULL, PERL_MAGIC_debugvar, &PL_vtbl_debugvar, 0, 0);
4256 mg->mg_private = DBVARMG_SINGLE;
4257 SvSETMAGIC(PL_DBsingle);
4259 PL_DBtrace = GvSV((gv_fetchpvs("DB::trace", GV_ADDMULTI, SVt_PV)));
4260 if (!SvIOK(PL_DBtrace))
4261 sv_setiv(PL_DBtrace, 0);
4262 mg = sv_magicext(PL_DBtrace, NULL, PERL_MAGIC_debugvar, &PL_vtbl_debugvar, 0, 0);
4263 mg->mg_private = DBVARMG_TRACE;
4264 SvSETMAGIC(PL_DBtrace);
4266 PL_DBsignal = GvSV((gv_fetchpvs("DB::signal", GV_ADDMULTI, SVt_PV)));
4267 if (!SvIOK(PL_DBsignal))
4268 sv_setiv(PL_DBsignal, 0);
4269 mg = sv_magicext(PL_DBsignal, NULL, PERL_MAGIC_debugvar, &PL_vtbl_debugvar, 0, 0);
4270 mg->mg_private = DBVARMG_SIGNAL;
4271 SvSETMAGIC(PL_DBsignal);
4273 SvREFCNT_dec(PL_curstash);
4274 PL_curstash = ostash;
4277 #ifndef STRESS_REALLOC
4278 #define REASONABLE(size) (size)
4279 #define REASONABLE_but_at_least(size,min) (size)
4281 #define REASONABLE(size) (1) /* unreasonable */
4282 #define REASONABLE_but_at_least(size,min) (min)
4286 Perl_init_stacks(pTHX)
4290 /* start with 128-item stack and 8K cxstack */
4291 PL_curstackinfo = new_stackinfo(REASONABLE(128),
4292 REASONABLE(8192/sizeof(PERL_CONTEXT) - 1));
4293 PL_curstackinfo->si_type = PERLSI_MAIN;
4294 #if defined DEBUGGING && !defined DEBUGGING_RE_ONLY
4295 PL_curstackinfo->si_stack_hwm = 0;
4297 PL_curstack = PL_curstackinfo->si_stack;
4298 PL_mainstack = PL_curstack; /* remember in case we switch stacks */
4300 PL_stack_base = AvARRAY(PL_curstack);
4301 PL_stack_sp = PL_stack_base;
4302 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
4304 Newx(PL_tmps_stack,REASONABLE(128),SV*);
4307 PL_tmps_max = REASONABLE(128);
4309 Newx(PL_markstack,REASONABLE(32),I32);
4310 PL_markstack_ptr = PL_markstack;
4311 PL_markstack_max = PL_markstack + REASONABLE(32);
4315 Newx(PL_scopestack,REASONABLE(32),I32);
4317 Newx(PL_scopestack_name,REASONABLE(32),const char*);
4319 PL_scopestack_ix = 0;
4320 PL_scopestack_max = REASONABLE(32);
4322 size = REASONABLE_but_at_least(128,SS_MAXPUSH);
4323 Newx(PL_savestack, size, ANY);
4324 PL_savestack_ix = 0;
4325 /*PL_savestack_max lies: it always has SS_MAXPUSH more than it claims */
4326 PL_savestack_max = size - SS_MAXPUSH;
4334 while (PL_curstackinfo->si_next)
4335 PL_curstackinfo = PL_curstackinfo->si_next;
4336 while (PL_curstackinfo) {
4337 PERL_SI *p = PL_curstackinfo->si_prev;
4338 /* curstackinfo->si_stack got nuked by sv_free_arenas() */
4339 Safefree(PL_curstackinfo->si_cxstack);
4340 Safefree(PL_curstackinfo);
4341 PL_curstackinfo = p;
4343 Safefree(PL_tmps_stack);
4344 Safefree(PL_markstack);
4345 Safefree(PL_scopestack);
4347 Safefree(PL_scopestack_name);
4349 Safefree(PL_savestack);
4353 Perl_populate_isa(pTHX_ const char *name, STRLEN len, ...)
4355 GV *const gv = gv_fetchpvn(name, len, GV_ADD | GV_ADDMULTI, SVt_PVAV);
4356 AV *const isa = GvAVn(gv);
4359 PERL_ARGS_ASSERT_POPULATE_ISA;
4361 if(AvFILLp(isa) != -1)
4364 /* NOTE: No support for tied ISA */
4366 va_start(args, len);
4368 const char *const parent = va_arg(args, const char*);
4373 parent_len = va_arg(args, size_t);
4375 /* Arguments are supplied with a trailing :: */
4376 assert(parent_len > 2);
4377 assert(parent[parent_len - 1] == ':');
4378 assert(parent[parent_len - 2] == ':');
4379 av_push(isa, newSVpvn(parent, parent_len - 2));
4380 (void) gv_fetchpvn(parent, parent_len, GV_ADD, SVt_PVGV);
4387 S_init_predump_symbols(pTHX)
4392 sv_setpvs(get_sv("\"", GV_ADD), " ");
4393 PL_ofsgv = (GV*)SvREFCNT_inc(gv_fetchpvs(",", GV_ADD|GV_NOTQUAL, SVt_PV));
4396 /* Historically, PVIOs were blessed into IO::Handle, unless
4397 FileHandle was loaded, in which case they were blessed into
4398 that. Action at a distance.
4399 However, if we simply bless into IO::Handle, we break code
4400 that assumes that PVIOs will have (among others) a seek
4401 method. IO::File inherits from IO::Handle and IO::Seekable,
4402 and provides the needed methods. But if we simply bless into
4403 it, then we break code that assumed that by loading
4404 IO::Handle, *it* would work.
4405 So a compromise is to set up the correct @IO::File::ISA,
4406 so that code that does C<use IO::Handle>; will still work.
4409 Perl_populate_isa(aTHX_ STR_WITH_LEN("IO::File::ISA"),
4410 STR_WITH_LEN("IO::Handle::"),
4411 STR_WITH_LEN("IO::Seekable::"),
4412 STR_WITH_LEN("Exporter::"),
4415 PL_stdingv = gv_fetchpvs("STDIN", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4416 GvMULTI_on(PL_stdingv);
4417 io = GvIOp(PL_stdingv);
4418 IoTYPE(io) = IoTYPE_RDONLY;
4419 IoIFP(io) = PerlIO_stdin();
4420 tmpgv = gv_fetchpvs("stdin", GV_ADD|GV_NOTQUAL, SVt_PV);
4422 GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4424 tmpgv = gv_fetchpvs("STDOUT", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4427 IoTYPE(io) = IoTYPE_WRONLY;
4428 IoOFP(io) = IoIFP(io) = PerlIO_stdout();
4430 tmpgv = gv_fetchpvs("stdout", GV_ADD|GV_NOTQUAL, SVt_PV);
4432 GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4434 PL_stderrgv = gv_fetchpvs("STDERR", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4435 GvMULTI_on(PL_stderrgv);
4436 io = GvIOp(PL_stderrgv);
4437 IoTYPE(io) = IoTYPE_WRONLY;
4438 IoOFP(io) = IoIFP(io) = PerlIO_stderr();
4439 tmpgv = gv_fetchpvs("stderr", GV_ADD|GV_NOTQUAL, SVt_PV);
4441 GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4443 PL_statname = newSVpvs(""); /* last filename we did stat on */
4447 Perl_init_argv_symbols(pTHX_ int argc, char **argv)
4449 PERL_ARGS_ASSERT_INIT_ARGV_SYMBOLS;
4451 argc--,argv++; /* skip name of script */
4452 if (PL_doswitches) {
4453 for (; argc > 0 && **argv == '-'; argc--,argv++) {
4457 if (argv[0][1] == '-' && !argv[0][2]) {
4461 if ((s = strchr(argv[0], '='))) {
4462 const char *const start_name = argv[0] + 1;
4463 sv_setpv(GvSV(gv_fetchpvn_flags(start_name, s - start_name,
4464 TRUE, SVt_PV)), s + 1);
4467 sv_setiv(GvSV(gv_fetchpv(argv[0]+1, GV_ADD, SVt_PV)),1);
4470 if ((PL_argvgv = gv_fetchpvs("ARGV", GV_ADD|GV_NOTQUAL, SVt_PVAV))) {
4471 SvREFCNT_inc_simple_void_NN(PL_argvgv);
4472 GvMULTI_on(PL_argvgv);
4473 av_clear(GvAVn(PL_argvgv));
4474 for (; argc > 0; argc--,argv++) {
4475 SV * const sv = newSVpv(argv[0],0);
4476 av_push(GvAV(PL_argvgv),sv);
4477 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
4478 if (PL_unicode & PERL_UNICODE_ARGV_FLAG)
4481 if (PL_unicode & PERL_UNICODE_WIDESYSCALLS_FLAG) /* Sarathy? */
4482 (void)sv_utf8_decode(sv);
4486 if (PL_inplace && (!PL_argvgv || AvFILL(GvAV(PL_argvgv)) == -1))
4487 Perl_ck_warner_d(aTHX_ packWARN(WARN_INPLACE),
4488 "-i used with no filenames on the command line, "
4489 "reading from STDIN");
4493 S_init_postdump_symbols(pTHX_ int argc, char **argv, char **env)
4500 PERL_ARGS_ASSERT_INIT_POSTDUMP_SYMBOLS;
4502 PL_toptarget = newSV_type(SVt_PVIV);
4503 SvPVCLEAR(PL_toptarget);
4504 PL_bodytarget = newSV_type(SVt_PVIV);
4505 SvPVCLEAR(PL_bodytarget);
4506 PL_formtarget = PL_bodytarget;
4510 init_argv_symbols(argc,argv);
4512 if ((tmpgv = gv_fetchpvs("0", GV_ADD|GV_NOTQUAL, SVt_PV))) {
4513 sv_setpv(GvSV(tmpgv),PL_origfilename);
4515 if ((PL_envgv = gv_fetchpvs("ENV", GV_ADD|GV_NOTQUAL, SVt_PVHV))) {
4517 bool env_is_not_environ;
4518 SvREFCNT_inc_simple_void_NN(PL_envgv);
4519 GvMULTI_on(PL_envgv);
4520 hv = GvHVn(PL_envgv);
4521 hv_magic(hv, NULL, PERL_MAGIC_env);
4523 #ifdef USE_ENVIRON_ARRAY
4524 /* Note that if the supplied env parameter is actually a copy
4525 of the global environ then it may now point to free'd memory
4526 if the environment has been modified since. To avoid this
4527 problem we treat env==NULL as meaning 'use the default'
4531 env_is_not_environ = env != environ;
4532 if (env_is_not_environ
4533 # ifdef USE_ITHREADS
4534 && PL_curinterp == aTHX
4546 for (; *env; env++) {
4549 if (!(s = strchr(old_var,'=')) || s == old_var)
4553 #if defined(MSDOS) && !defined(DJGPP)
4555 (void)strupr(old_var);
4558 if (hv_exists(hv, old_var, nlen)) {
4559 const char *name = savepvn(old_var, nlen);
4561 /* make sure we use the same value as getenv(), otherwise code that
4562 uses getenv() (like setlocale()) might see a different value to %ENV
4564 sv = newSVpv(PerlEnv_getenv(name), 0);
4566 /* keep a count of the dups of this name so we can de-dup environ later */
4567 if (hv_exists(dups, name, nlen))
4568 ++SvIVX(*hv_fetch(dups, name, nlen, 0));
4570 (void)hv_store(dups, name, nlen, newSViv(1), 0);
4575 sv = newSVpv(s+1, 0);
4577 (void)hv_store(hv, old_var, nlen, sv, 0);
4578 if (env_is_not_environ)
4582 /* environ has some duplicate definitions, remove them */
4585 while ((entry = hv_iternext_flags(dups, 0))) {
4587 const char *name = HePV(entry, nlen);
4588 IV count = SvIV(HeVAL(entry));
4590 SV **valp = hv_fetch(hv, name, nlen, 0);
4594 /* try to remove any duplicate names, depending on the
4595 * implementation used in my_setenv() the iteration might
4596 * not be necessary, but let's be safe.
4598 for (i = 0; i < count; ++i)
4601 /* and set it back to the value we set $ENV{name} to */
4602 my_setenv(name, SvPV_nolen(*valp));
4605 SvREFCNT_dec_NN(dups);
4607 #endif /* USE_ENVIRON_ARRAY */
4608 #endif /* !PERL_MICRO */
4612 /* touch @F array to prevent spurious warnings 20020415 MJD */
4614 (void) get_av("main::F", GV_ADD | GV_ADDMULTI);
4619 S_init_perllib(pTHX)
4622 const char *perl5lib = NULL;
4625 #if defined(WIN32) && !defined(PERL_IS_MINIPERL)
4629 if (!TAINTING_get) {
4631 perl5lib = PerlEnv_getenv("PERL5LIB");
4633 * It isn't possible to delete an environment variable with
4634 * PERL_USE_SAFE_PUTENV set unless unsetenv() is also available, so in that
4635 * case we treat PERL5LIB as undefined if it has a zero-length value.
4637 #if defined(PERL_USE_SAFE_PUTENV) && ! defined(HAS_UNSETENV)
4638 if (perl5lib && *perl5lib != '\0')
4642 incpush_use_sep(perl5lib, 0, INCPUSH_ADD_SUB_DIRS);
4644 s = PerlEnv_getenv("PERLLIB");
4646 incpush_use_sep(s, 0, 0);
4649 /* Treat PERL5?LIB as a possible search list logical name -- the
4650 * "natural" VMS idiom for a Unix path string. We allow each
4651 * element to be a set of |-separated directories for compatibility.
4655 if (vmstrnenv("PERL5LIB",buf,0,NULL,0))
4657 incpush_use_sep(buf, 0, INCPUSH_ADD_SUB_DIRS);
4658 } while (vmstrnenv("PERL5LIB",buf,++idx,NULL,0));
4660 while (vmstrnenv("PERLLIB",buf,idx++,NULL,0))
4661 incpush_use_sep(buf, 0, 0);
4666 #ifndef PERL_IS_MINIPERL
4667 /* miniperl gets just -I..., the split of $ENV{PERL5LIB}, and "." in @INC
4668 (and not the architecture specific directories from $ENV{PERL5LIB}) */
4670 #include "perl_inc_macro.h"
4671 /* Use the ~-expanded versions of APPLLIB (undocumented),
4672 SITEARCH, SITELIB, VENDORARCH, VENDORLIB, ARCHLIB and PRIVLIB
4675 INCPUSH_SITEARCH_EXP
4677 INCPUSH_PERL_VENDORARCH_EXP
4678 INCPUSH_PERL_VENDORLIB_EXP
4681 INCPUSH_PERL_OTHERLIBDIRS
4683 INCPUSH_APPLLIB_OLD_EXP
4684 INCPUSH_SITELIB_STEM
4685 INCPUSH_PERL_VENDORLIB_STEM
4686 INCPUSH_PERL_OTHERLIBDIRS_ARCHONLY
4688 #endif /* !PERL_IS_MINIPERL */
4690 if (!TAINTING_get) {
4691 #if !defined(PERL_IS_MINIPERL) && defined(DEFAULT_INC_EXCLUDES_DOT)
4692 const char * const unsafe = PerlEnv_getenv("PERL_USE_UNSAFE_INC");
4693 if (unsafe && strEQ(unsafe, "1"))
4695 S_incpush(aTHX_ STR_WITH_LEN("."), 0);
4699 #if defined(DOSISH) || defined(__SYMBIAN32__)
4700 # define PERLLIB_SEP ';'
4701 #elif defined(__VMS)
4702 # define PERLLIB_SEP PL_perllib_sep
4704 # define PERLLIB_SEP ':'
4706 #ifndef PERLLIB_MANGLE
4707 # define PERLLIB_MANGLE(s,n) (s)
4710 #ifndef PERL_IS_MINIPERL
4711 /* Push a directory onto @INC if it exists.
4712 Generate a new SV if we do this, to save needing to copy the SV we push
4715 S_incpush_if_exists(pTHX_ AV *const av, SV *dir, SV *const stem)
4719 PERL_ARGS_ASSERT_INCPUSH_IF_EXISTS;
4721 if (PerlLIO_stat(SvPVX_const(dir), &tmpstatbuf) >= 0 &&
4722 S_ISDIR(tmpstatbuf.st_mode)) {
4724 dir = newSVsv(stem);
4726 /* Truncate dir back to stem. */
4727 SvCUR_set(dir, SvCUR(stem));
4734 S_mayberelocate(pTHX_ const char *const dir, STRLEN len, U32 flags)
4736 const U8 canrelocate = (U8)flags & INCPUSH_CAN_RELOCATE;
4739 PERL_ARGS_ASSERT_MAYBERELOCATE;
4742 /* I am not convinced that this is valid when PERLLIB_MANGLE is
4743 defined to so something (in os2/os2.c), but the code has been
4744 this way, ignoring any possible changed of length, since
4745 760ac839baf413929cd31cc32ffd6dba6b781a81 (5.003_02) so I'll leave
4747 libdir = newSVpvn(PERLLIB_MANGLE(dir, len), len);
4753 if ((unix = tounixspec_ts(SvPV(libdir,len),NULL)) != NULL) {
4755 while (len > 1 && unix[len-1] == '/') len--; /* Cosmetic */
4756 sv_usepvn(libdir,unix,len);
4759 PerlIO_printf(Perl_error_log,
4760 "Failed to unixify @INC element \"%s\"\n",
4761 SvPV_nolen_const(libdir));
4765 /* Do the if() outside the #ifdef to avoid warnings about an unused
4768 #ifdef PERL_RELOCATABLE_INC
4770 * Relocatable include entries are marked with a leading .../
4773 * 0: Remove that leading ".../"
4774 * 1: Remove trailing executable name (anything after the last '/')
4775 * from the perl path to give a perl prefix
4777 * While the @INC element starts "../" and the prefix ends with a real
4778 * directory (ie not . or ..) chop that real directory off the prefix
4779 * and the leading "../" from the @INC element. ie a logical "../"
4781 * Finally concatenate the prefix and the remainder of the @INC element
4782 * The intent is that /usr/local/bin/perl and .../../lib/perl5
4783 * generates /usr/local/lib/perl5
4785 const char *libpath = SvPVX(libdir);
4786 STRLEN libpath_len = SvCUR(libdir);
4787 if (memBEGINs(libpath, libpath_len, ".../")) {
4789 SV * const caret_X = get_sv("\030", 0);
4790 /* Going to use the SV just as a scratch buffer holding a C
4796 /* $^X is *the* source of taint if tainting is on, hence
4797 SvPOK() won't be true. */
4799 assert(SvPOKp(caret_X));
4800 prefix_sv = newSVpvn_flags(SvPVX(caret_X), SvCUR(caret_X),
4802 /* Firstly take off the leading .../
4803 If all else fail we'll do the paths relative to the current
4805 sv_chop(libdir, libpath + 4);
4806 /* Don't use SvPV as we're intentionally bypassing taining,
4807 mortal copies that the mg_get of tainting creates, and
4808 corruption that seems to come via the save stack.
4809 I guess that the save stack isn't correctly set up yet. */
4810 libpath = SvPVX(libdir);
4811 libpath_len = SvCUR(libdir);
4813 prefix = SvPVX(prefix_sv);
4814 lastslash = (char *) my_memrchr(prefix, '/',
4815 SvEND(prefix_sv) - prefix);
4817 /* First time in with the *lastslash = '\0' we just wipe off
4818 the trailing /perl from (say) /usr/foo/bin/perl
4822 while ((*lastslash = '\0'), /* Do that, come what may. */
4823 ( memBEGINs(libpath, libpath_len, "../")
4825 (char *) my_memrchr(prefix, '/',
4826 SvEND(prefix_sv) - prefix))))
4828 if (lastslash[1] == '\0'
4829 || (lastslash[1] == '.'
4830 && (lastslash[2] == '/' /* ends "/." */
4831 || (lastslash[2] == '/'
4832 && lastslash[3] == '/' /* or "/.." */
4834 /* Prefix ends "/" or "/." or "/..", any of which
4835 are fishy, so don't do any more logical cleanup.
4839 /* Remove leading "../" from path */
4842 /* Next iteration round the loop removes the last
4843 directory name from prefix by writing a '\0' in
4844 the while clause. */
4846 /* prefix has been terminated with a '\0' to the correct
4847 length. libpath points somewhere into the libdir SV.
4848 We need to join the 2 with '/' and drop the result into
4850 tempsv = Perl_newSVpvf(aTHX_ "%s/%s", prefix, libpath);
4851 SvREFCNT_dec(libdir);
4852 /* And this is the new libdir. */
4855 (PerlProc_getuid() != PerlProc_geteuid() ||
4856 PerlProc_getgid() != PerlProc_getegid())) {
4857 /* Need to taint relocated paths if running set ID */
4858 SvTAINTED_on(libdir);
4861 SvREFCNT_dec(prefix_sv);
4869 S_incpush(pTHX_ const char *const dir, STRLEN len, U32 flags)
4871 #ifndef PERL_IS_MINIPERL
4872 const U8 using_sub_dirs
4873 = (U8)flags & (INCPUSH_ADD_VERSIONED_SUB_DIRS
4874 |INCPUSH_ADD_ARCHONLY_SUB_DIRS|INCPUSH_ADD_OLD_VERS);
4875 const U8 add_versioned_sub_dirs
4876 = (U8)flags & INCPUSH_ADD_VERSIONED_SUB_DIRS;
4877 const U8 add_archonly_sub_dirs
4878 = (U8)flags & INCPUSH_ADD_ARCHONLY_SUB_DIRS;
4879 #ifdef PERL_INC_VERSION_LIST
4880 const U8 addoldvers = (U8)flags & INCPUSH_ADD_OLD_VERS;
4883 const U8 unshift = (U8)flags & INCPUSH_UNSHIFT;
4884 const U8 push_basedir = (flags & INCPUSH_NOT_BASEDIR) ? 0 : 1;
4885 AV *const inc = GvAVn(PL_incgv);
4887 PERL_ARGS_ASSERT_INCPUSH;
4890 /* Could remove this vestigial extra block, if we don't mind a lot of
4891 re-indenting diff noise. */
4893 SV *const libdir = mayberelocate(dir, len, flags);
4894 /* Change 20189146be79a0596543441fa369c6bf7f85103f, to fix RT#6665,
4895 arranged to unshift #! line -I onto the front of @INC. However,
4896 -I can add version and architecture specific libraries, and they
4897 need to go first. The old code assumed that it was always
4898 pushing. Hence to make it work, need to push the architecture
4899 (etc) libraries onto a temporary array, then "unshift" that onto
4900 the front of @INC. */
4901 #ifndef PERL_IS_MINIPERL
4902 AV *const av = (using_sub_dirs) ? (unshift ? newAV() : inc) : NULL;
4905 * BEFORE pushing libdir onto @INC we may first push version- and
4906 * archname-specific sub-directories.
4908 if (using_sub_dirs) {
4909 SV *subdir = newSVsv(libdir);
4910 #ifdef PERL_INC_VERSION_LIST
4911 /* Configure terminates PERL_INC_VERSION_LIST with a NULL */
4912 const char * const incverlist[] = { PERL_INC_VERSION_LIST };
4913 const char * const *incver;
4916 if (add_versioned_sub_dirs) {
4917 /* .../version/archname if -d .../version/archname */
4918 sv_catpvs(subdir, "/" PERL_FS_VERSION "/" ARCHNAME);
4919 subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
4921 /* .../version if -d .../version */
4922 sv_catpvs(subdir, "/" PERL_FS_VERSION);
4923 subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
4926 #ifdef PERL_INC_VERSION_LIST
4928 for (incver = incverlist; *incver; incver++) {
4929 /* .../xxx if -d .../xxx */
4930 Perl_sv_catpvf(aTHX_ subdir, "/%s", *incver);
4931 subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
4936 if (add_archonly_sub_dirs) {
4937 /* .../archname if -d .../archname */
4938 sv_catpvs(subdir, "/" ARCHNAME);
4939 subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
4943 assert (SvREFCNT(subdir) == 1);
4944 SvREFCNT_dec(subdir);
4946 #endif /* !PERL_IS_MINIPERL */
4947 /* finally add this lib directory at the end of @INC */
4949 #ifdef PERL_IS_MINIPERL
4950 const Size_t extra = 0;
4952 Size_t extra = av_tindex(av) + 1;
4954 av_unshift(inc, extra + push_basedir);
4956 av_store(inc, extra, libdir);
4957 #ifndef PERL_IS_MINIPERL
4959 /* av owns a reference, av_store() expects to be donated a
4960 reference, and av expects to be sane when it's cleared.
4961 If I wanted to be naughty and wrong, I could peek inside the
4962 implementation of av_clear(), realise that it uses
4963 SvREFCNT_dec() too, so av's array could be a run of NULLs,
4964 and so directly steal from it (with a memcpy() to inc, and
4965 then memset() to NULL them out. But people copy code from the
4966 core expecting it to be best practise, so let's use the API.
4967 Although studious readers will note that I'm not checking any
4969 av_store(inc, extra, SvREFCNT_inc(*av_fetch(av, extra, FALSE)));
4974 else if (push_basedir) {
4975 av_push(inc, libdir);
4978 if (!push_basedir) {
4979 assert (SvREFCNT(libdir) == 1);
4980 SvREFCNT_dec(libdir);
4986 S_incpush_use_sep(pTHX_ const char *p, STRLEN len, U32 flags)
4990 /* This logic has been broken out from S_incpush(). It may be possible to
4993 PERL_ARGS_ASSERT_INCPUSH_USE_SEP;
4995 /* perl compiled with -DPERL_RELOCATABLE_INCPUSH will ignore the len
4996 * argument to incpush_use_sep. This allows creation of relocatable
4997 * Perl distributions that patch the binary at install time. Those
4998 * distributions will have to provide their own relocation tools; this
4999 * is not a feature otherwise supported by core Perl.
5001 #ifndef PERL_RELOCATABLE_INCPUSH
5008 /* Break at all separators */
5009 while ((s = (const char*)memchr(p, PERLLIB_SEP, end - p))) {
5011 /* skip any consecutive separators */
5013 /* Uncomment the next line for PATH semantics */
5014 /* But you'll need to write tests */
5015 /* av_push(GvAVn(PL_incgv), newSVpvs(".")); */
5017 incpush(p, (STRLEN)(s - p), flags);
5022 incpush(p, (STRLEN)(end - p), flags);
5027 Perl_call_list(pTHX_ I32 oldscope, AV *paramList)
5030 volatile const line_t oldline = PL_curcop ? CopLINE(PL_curcop) : 0;
5036 PERL_ARGS_ASSERT_CALL_LIST;
5038 while (av_tindex(paramList) >= 0) {
5039 cv = MUTABLE_CV(av_shift(paramList));
5041 if (paramList == PL_beginav) {
5042 /* save PL_beginav for compiler */
5043 Perl_av_create_and_push(aTHX_ &PL_beginav_save, MUTABLE_SV(cv));
5045 else if (paramList == PL_checkav) {
5046 /* save PL_checkav for compiler */
5047 Perl_av_create_and_push(aTHX_ &PL_checkav_save, MUTABLE_SV(cv));
5049 else if (paramList == PL_unitcheckav) {
5050 /* save PL_unitcheckav for compiler */
5051 Perl_av_create_and_push(aTHX_ &PL_unitcheckav_save, MUTABLE_SV(cv));
5061 (void)SvPV_const(atsv, len);
5063 PL_curcop = &PL_compiling;
5064 CopLINE_set(PL_curcop, oldline);
5065 if (paramList == PL_beginav)
5066 sv_catpvs(atsv, "BEGIN failed--compilation aborted");
5068 Perl_sv_catpvf(aTHX_ atsv,
5069 "%s failed--call queue aborted",
5070 paramList == PL_checkav ? "CHECK"
5071 : paramList == PL_initav ? "INIT"
5072 : paramList == PL_unitcheckav ? "UNITCHECK"
5074 while (PL_scopestack_ix > oldscope)
5077 Perl_croak(aTHX_ "%" SVf, SVfARG(atsv));
5084 /* my_exit() was called */
5085 while (PL_scopestack_ix > oldscope)
5088 SET_CURSTASH(PL_defstash);
5089 PL_curcop = &PL_compiling;
5090 CopLINE_set(PL_curcop, oldline);
5093 NOT_REACHED; /* NOTREACHED */
5096 PL_curcop = &PL_compiling;
5097 CopLINE_set(PL_curcop, oldline);
5100 PerlIO_printf(Perl_error_log, "panic: restartop in call_list\n");
5109 Perl_my_exit(pTHX_ U32 status)
5111 if (PL_exit_flags & PERL_EXIT_ABORT) {
5114 if (PL_exit_flags & PERL_EXIT_WARN) {
5115 PL_exit_flags |= PERL_EXIT_ABORT; /* Protect against reentrant calls */
5116 Perl_warn(aTHX_ "Unexpected exit %lu", (unsigned long)status);
5117 PL_exit_flags &= ~PERL_EXIT_ABORT;
5127 STATUS_EXIT_SET(status);
5134 Perl_my_failure_exit(pTHX)
5137 /* We have been called to fall on our sword. The desired exit code
5138 * should be already set in STATUS_UNIX, but could be shifted over
5139 * by 8 bits. STATUS_UNIX_EXIT_SET will handle the cases where a
5142 * If an error code has not been set, then force the issue.
5144 if (MY_POSIX_EXIT) {
5146 /* According to the die_exit.t tests, if errno is non-zero */
5147 /* It should be used for the error status. */
5149 if (errno == EVMSERR) {
5150 STATUS_NATIVE = vaxc$errno;
5153 /* According to die_exit.t tests, if the child_exit code is */
5154 /* also zero, then we need to exit with a code of 255 */
5155 if ((errno != 0) && (errno < 256))
5156 STATUS_UNIX_EXIT_SET(errno);
5157 else if (STATUS_UNIX < 255) {
5158 STATUS_UNIX_EXIT_SET(255);
5163 /* The exit code could have been set by $? or vmsish which
5164 * means that it may not have fatal set. So convert
5165 * success/warning codes to fatal with out changing
5166 * the POSIX status code. The severity makes VMS native
5167 * status handling work, while UNIX mode programs use the
5168 * the POSIX exit codes.
5170 if ((STATUS_NATIVE & (STS$K_SEVERE|STS$K_ERROR)) == 0) {
5171 STATUS_NATIVE &= STS$M_COND_ID;
5172 STATUS_NATIVE |= STS$K_ERROR | STS$M_INHIB_MSG;
5176 /* Traditionally Perl on VMS always expects a Fatal Error. */
5177 if (vaxc$errno & 1) {
5179 /* So force success status to failure */
5180 if (STATUS_NATIVE & 1)
5185 STATUS_UNIX = EINTR; /* In case something cares */
5190 STATUS_NATIVE = vaxc$errno; /* Should already be this */
5192 /* Encode the severity code */
5193 severity = STATUS_NATIVE & STS$M_SEVERITY;
5194 STATUS_UNIX = (severity ? severity : 1) << 8;
5196 /* Perl expects this to be a fatal error */
5197 if (severity != STS$K_SEVERE)
5207 STATUS_UNIX_SET(eno);
5209 exitstatus = STATUS_UNIX >> 8;
5210 if (exitstatus & 255)
5211 STATUS_UNIX_SET(exitstatus);
5213 STATUS_UNIX_SET(255);
5216 if (PL_exit_flags & PERL_EXIT_ABORT) {
5219 if (PL_exit_flags & PERL_EXIT_WARN) {
5220 PL_exit_flags |= PERL_EXIT_ABORT; /* Protect against reentrant calls */
5221 Perl_warn(aTHX_ "Unexpected exit failure %ld", (long)PL_statusvalue);
5222 PL_exit_flags &= ~PERL_EXIT_ABORT;
5228 S_my_exit_jump(pTHX)
5231 SvREFCNT_dec(PL_e_script);
5235 POPSTACK_TO(PL_mainstack);
5236 if (cxstack_ix >= 0) {
5238 cx_popblock(cxstack);
5246 read_e_script(pTHX_ int idx, SV *buf_sv, int maxlen)
5248 const char * const p = SvPVX_const(PL_e_script);
5249 const char * const e = SvEND(PL_e_script);
5250 const char *nl = (char *) memchr(p, '\n', e - p);
5252 PERL_UNUSED_ARG(idx);
5253 PERL_UNUSED_ARG(maxlen);
5255 nl = (nl) ? nl+1 : e;
5257 filter_del(read_e_script);
5260 sv_catpvn(buf_sv, p, nl-p);
5261 sv_chop(PL_e_script, nl);
5265 /* removes boilerplate code at the end of each boot_Module xsub */
5267 Perl_xs_boot_epilog(pTHX_ const I32 ax)
5270 call_list(PL_scopestack_ix, PL_unitcheckav);
5275 * ex: set ts=8 sts=4 sw=4 et: