4 * Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001
5 * 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
6 * 2013, 2014, 2015, 2016, 2017, 2018, 2019 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;
99 MUTEX_INIT(&PL_dollarzero_mutex);
100 MUTEX_INIT(&PL_my_ctx_mutex);
103 #if defined(USE_ITHREADS)
106 /* This always happens for non-ithreads */
109 PERL_SET_THX(my_perl);
114 /* these implement the PERL_SYS_INIT, PERL_SYS_INIT3, PERL_SYS_TERM macros */
117 Perl_sys_init(int* argc, char*** argv)
121 PERL_ARGS_ASSERT_SYS_INIT;
123 PERL_UNUSED_ARG(argc); /* may not be used depending on _BODY macro */
124 PERL_UNUSED_ARG(argv);
125 PERL_SYS_INIT_BODY(argc, argv);
129 Perl_sys_init3(int* argc, char*** argv, char*** env)
133 PERL_ARGS_ASSERT_SYS_INIT3;
135 PERL_UNUSED_ARG(argc); /* may not be used depending on _BODY macro */
136 PERL_UNUSED_ARG(argv);
137 PERL_UNUSED_ARG(env);
138 PERL_SYS_INIT3_BODY(argc, argv, env);
145 if (!PL_veto_cleanup) {
146 PERL_SYS_TERM_BODY();
151 #ifdef PERL_IMPLICIT_SYS
153 perl_alloc_using(struct IPerlMem* ipM, struct IPerlMem* ipMS,
154 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
155 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
156 struct IPerlDir* ipD, struct IPerlSock* ipS,
157 struct IPerlProc* ipP)
159 PerlInterpreter *my_perl;
161 PERL_ARGS_ASSERT_PERL_ALLOC_USING;
163 /* Newx() needs interpreter, so call malloc() instead */
164 my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
165 S_init_tls_and_interp(my_perl);
166 Zero(my_perl, 1, PerlInterpreter);
176 INIT_TRACK_MEMPOOL(PL_memory_debug_header, my_perl);
183 =head1 Embedding Functions
185 =for apidoc perl_alloc
187 Allocates a new Perl interpreter. See L<perlembed>.
195 PerlInterpreter *my_perl;
197 /* Newx() needs interpreter, so call malloc() instead */
198 my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
200 S_init_tls_and_interp(my_perl);
201 #ifndef PERL_TRACK_MEMPOOL
202 return (PerlInterpreter *) ZeroD(my_perl, 1, PerlInterpreter);
204 Zero(my_perl, 1, PerlInterpreter);
205 INIT_TRACK_MEMPOOL(PL_memory_debug_header, my_perl);
209 #endif /* PERL_IMPLICIT_SYS */
212 =for apidoc perl_construct
214 Initializes a new Perl interpreter. See L<perlembed>.
220 S_fixup_platform_bugs(void)
222 #if defined(__GLIBC__) && IVSIZE == 8 \
223 && ( __GLIBC__ < 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ < 8))
227 /* Cannot do this check with inlined IV constants since
228 * that seems to work correctly even with the buggy glibc. */
231 /* Yikes, we have the bug.
232 * Patch in the workaround version. */
233 PL_ppaddr[OP_I_MODULO] = &Perl_pp_i_modulo_glibc_bugfix;
240 perl_construct(pTHXx)
244 PERL_ARGS_ASSERT_PERL_CONSTRUCT;
248 PL_perl_destruct_level = 1;
250 PERL_UNUSED_ARG(my_perl);
251 if (PL_perl_destruct_level > 0)
254 PL_curcop = &PL_compiling; /* needed by ckWARN, right away */
256 #ifdef PERL_TRACE_OPS
257 Zero(PL_op_exec_cnt, OP_max+2, UV);
262 SvREADONLY_on(&PL_sv_placeholder);
263 SvREFCNT(&PL_sv_placeholder) = SvREFCNT_IMMORTAL;
265 PL_sighandlerp = (Sighandler_t) Perl_sighandler;
266 #ifdef PERL_USES_PL_PIDSTATUS
267 PL_pidstatus = newHV();
270 PL_rs = newSVpvs("\n");
274 /* The PERL_INTERNAL_RAND_SEED set-up must be after init_stacks because it calls
275 * things that may put SVs on the stack.
278 #ifdef NO_PERL_INTERNAL_RAND_SEED
279 Perl_drand48_init_r(&PL_internal_random_state, seed());
284 if (PerlProc_getuid() != PerlProc_geteuid() ||
285 PerlProc_getgid() != PerlProc_getegid() ||
286 !(env_pv = PerlEnv_getenv("PERL_INTERNAL_RAND_SEED")) ||
287 grok_number(env_pv, strlen(env_pv), &seed) != IS_NUMBER_IN_UV) {
290 Perl_drand48_init_r(&PL_internal_random_state, (U32)seed);
296 S_fixup_platform_bugs();
302 (void) uvchr_to_utf8_flags((U8 *) PL_TR_SPECIAL_HANDLING_UTF8,
304 UNICODE_ALLOW_ABOVE_IV_MAX);
306 #if defined(LOCAL_PATCH_COUNT)
307 PL_localpatches = local_patches; /* For possible -v */
310 #if defined(LIBM_LIB_VERSION)
312 * Some BSDs and Cygwin default to POSIX math instead of IEEE.
313 * This switches them over to IEEE.
315 _LIB_VERSION = _IEEE_;
318 #ifdef HAVE_INTERP_INTERN
322 PerlIO_init(aTHX); /* Hook to IO system */
324 PL_fdpid = newAV(); /* for remembering popen pids by fd */
325 PL_modglobal = newHV(); /* pointers to per-interpreter module globals */
326 PL_errors = newSVpvs("");
327 SvPVCLEAR(PERL_DEBUG_PAD(0)); /* For regex debugging. */
328 SvPVCLEAR(PERL_DEBUG_PAD(1)); /* ext/re needs these */
329 SvPVCLEAR(PERL_DEBUG_PAD(2)); /* even without DEBUGGING. */
331 /* First entry is a list of empty elements. It needs to be initialised
332 else all hell breaks loose in S_find_uninit_var(). */
333 Perl_av_create_and_push(aTHX_ &PL_regex_padav, newSVpvs(""));
334 PL_regex_pad = AvARRAY(PL_regex_padav);
335 Newxz(PL_stashpad, PL_stashpadmax, HV *);
337 #ifdef USE_REENTRANT_API
338 Perl_reentrant_init(aTHX);
340 if (PL_hash_seed_set == FALSE) {
341 /* Initialize the hash seed and state at startup. This must be
342 * done very early, before ANY hashes are constructed, and once
343 * setup is fixed for the lifetime of the process.
345 * If you decide to disable the seeding process you should choose
346 * a suitable seed yourself and define PERL_HASH_SEED to a well chosen
347 * string. See hv_func.h for details.
349 #if defined(USE_HASH_SEED)
350 /* get the hash seed from the environment or from an RNG */
351 Perl_get_hash_seed(aTHX_ PL_hash_seed);
353 /* they want a hard coded seed, check that it is long enough */
354 assert( strlen(PERL_HASH_SEED) >= PERL_HASH_SEED_BYTES );
357 /* now we use the chosen seed to initialize the state -
358 * in some configurations this may be a relatively speaking
359 * expensive operation, but we only have to do it once at startup */
360 PERL_HASH_SEED_STATE(PERL_HASH_SEED,PL_hash_state);
362 #ifdef PERL_USE_SINGLE_CHAR_HASH_CACHE
363 /* we can build a special cache for 0/1 byte keys, if people choose
364 * I suspect most of the time it is not worth it */
368 for (i=0;i<256;i++) {
370 PERL_HASH_WITH_STATE(PL_hash_state,PL_hash_chars[i],str,1);
372 PERL_HASH_WITH_STATE(PL_hash_state,PL_hash_chars[256],str,0);
375 /* at this point we have initialezed the hash function, and we can start
376 * constructing hashes */
377 PL_hash_seed_set= TRUE;
380 /* Allow PL_strtab to be pre-initialized before calling perl_construct.
381 * can use a custom optimized PL_strtab hash before calling perl_construct */
383 /* Note that strtab is a rather special HV. Assumptions are made
384 about not iterating on it, and not adding tie magic to it.
385 It is properly deallocated in perl_destruct() */
388 /* SHAREKEYS tells us that the hash has its keys shared with PL_strtab,
389 * which is not the case with PL_strtab itself */
390 HvSHAREKEYS_off(PL_strtab); /* mandatory */
391 hv_ksplit(PL_strtab, 1 << 11);
394 Zero(PL_sv_consts, SV_CONSTS_COUNT, SV*);
397 # ifdef USE_ENVIRON_ARRAY
398 PL_origenviron = environ;
402 /* Use sysconf(_SC_CLK_TCK) if available, if not
403 * available or if the sysconf() fails, use the HZ.
404 * The HZ if not originally defined has been by now
405 * been defined as CLK_TCK, if available. */
406 #if defined(HAS_SYSCONF) && defined(_SC_CLK_TCK)
407 PL_clocktick = sysconf(_SC_CLK_TCK);
408 if (PL_clocktick <= 0)
412 PL_stashcache = newHV();
414 PL_patchlevel = newSVpvs("v" PERL_VERSION_STRING);
417 if (!PL_mmap_page_size) {
418 #if defined(HAS_SYSCONF) && (defined(_SC_PAGESIZE) || defined(_SC_MMAP_PAGE_SIZE))
420 SETERRNO(0, SS_NORMAL);
422 PL_mmap_page_size = sysconf(_SC_PAGESIZE);
424 PL_mmap_page_size = sysconf(_SC_MMAP_PAGE_SIZE);
426 if ((long) PL_mmap_page_size < 0) {
427 Perl_croak(aTHX_ "panic: sysconf: %s",
428 errno ? Strerror(errno) : "pagesize unknown");
431 #elif defined(HAS_GETPAGESIZE)
432 PL_mmap_page_size = getpagesize();
433 #elif defined(I_SYS_PARAM) && defined(PAGESIZE)
434 PL_mmap_page_size = PAGESIZE; /* compiletime, bad */
436 if (PL_mmap_page_size <= 0)
437 Perl_croak(aTHX_ "panic: bad pagesize %" IVdf,
438 (IV) PL_mmap_page_size);
440 #endif /* HAS_MMAP */
442 #if defined(HAS_TIMES) && defined(PERL_NEED_TIMESBASE)
443 PL_timesbase.tms_utime = 0;
444 PL_timesbase.tms_stime = 0;
445 PL_timesbase.tms_cutime = 0;
446 PL_timesbase.tms_cstime = 0;
449 PL_osname = Perl_savepvn(aTHX_ STR_WITH_LEN(OSNAME));
451 PL_registered_mros = newHV();
452 /* Start with 1 bucket, for DFS. It's unlikely we'll need more. */
453 HvMAX(PL_registered_mros) = 0;
455 #ifdef USE_POSIX_2008_LOCALE
456 PL_C_locale_obj = newlocale(LC_ALL_MASK, "C", NULL);
464 =for apidoc nothreadhook
466 Stub that provides thread hook for perl_destruct when there are
473 Perl_nothreadhook(pTHX)
479 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
481 Perl_dump_sv_child(pTHX_ SV *sv)
484 const int sock = PL_dumper_fd;
485 const int debug_fd = PerlIO_fileno(Perl_debug_log);
486 union control_un control;
489 struct cmsghdr *cmptr;
491 unsigned char buffer[256];
493 PERL_ARGS_ASSERT_DUMP_SV_CHILD;
495 if(sock == -1 || debug_fd == -1)
498 PerlIO_flush(Perl_debug_log);
500 /* All these shenanigans are to pass a file descriptor over to our child for
501 it to dump out to. We can't let it hold open the file descriptor when it
502 forks, as the file descriptor it will dump to can turn out to be one end
503 of pipe that some other process will wait on for EOF. (So as it would
504 be open, the wait would be forever.) */
506 msg.msg_control = control.control;
507 msg.msg_controllen = sizeof(control.control);
508 /* We're a connected socket so we don't need a destination */
514 cmptr = CMSG_FIRSTHDR(&msg);
515 cmptr->cmsg_len = CMSG_LEN(sizeof(int));
516 cmptr->cmsg_level = SOL_SOCKET;
517 cmptr->cmsg_type = SCM_RIGHTS;
518 *((int *)CMSG_DATA(cmptr)) = 1;
520 vec[0].iov_base = (void*)&sv;
521 vec[0].iov_len = sizeof(sv);
522 got = sendmsg(sock, &msg, 0);
525 perror("Debug leaking scalars parent sendmsg failed");
528 if(got < sizeof(sv)) {
529 perror("Debug leaking scalars parent short sendmsg");
533 /* Return protocol is
535 unsigned char: length of location string (0 for empty)
536 unsigned char*: string (not terminated)
538 vec[0].iov_base = (void*)&returned_errno;
539 vec[0].iov_len = sizeof(returned_errno);
540 vec[1].iov_base = buffer;
543 got = readv(sock, vec, 2);
546 perror("Debug leaking scalars parent read failed");
547 PerlIO_flush(PerlIO_stderr());
550 if(got < sizeof(returned_errno) + 1) {
551 perror("Debug leaking scalars parent short read");
552 PerlIO_flush(PerlIO_stderr());
557 got = read(sock, buffer + 1, *buffer);
559 perror("Debug leaking scalars parent read 2 failed");
560 PerlIO_flush(PerlIO_stderr());
565 perror("Debug leaking scalars parent short read 2");
566 PerlIO_flush(PerlIO_stderr());
571 if (returned_errno || *buffer) {
572 Perl_warn(aTHX_ "Debug leaking scalars child failed%s%.*s with errno"
573 " %d: %s", (*buffer ? " at " : ""), (int) *buffer, buffer + 1,
574 returned_errno, Strerror(returned_errno));
580 =for apidoc perl_destruct
582 Shuts down a Perl interpreter. See L<perlembed> for a tutorial.
584 C<my_perl> points to the Perl interpreter. It must have been previously
585 created through the use of L</perl_alloc> and L</perl_construct>. It may
586 have been initialised through L</perl_parse>, and may have been used
587 through L</perl_run> and other means. This function should be called for
588 any Perl interpreter that has been constructed with L</perl_construct>,
589 even if subsequent operations on it failed, for example if L</perl_parse>
590 returned a non-zero value.
592 If the interpreter's C<PL_exit_flags> word has the
593 C<PERL_EXIT_DESTRUCT_END> flag set, then this function will execute code
594 in C<END> blocks before performing the rest of destruction. If it is
595 desired to make any use of the interpreter between L</perl_parse> and
596 L</perl_destruct> other than just calling L</perl_run>, then this flag
597 should be set early on. This matters if L</perl_run> will not be called,
598 or if anything else will be done in addition to calling L</perl_run>.
600 Returns a value be a suitable value to pass to the C library function
601 C<exit> (or to return from C<main>), to serve as an exit code indicating
602 the nature of the way the interpreter terminated. This takes into account
603 any failure of L</perl_parse> and any early exit from L</perl_run>.
604 The exit code is of the type required by the host operating system,
605 so because of differing exit code conventions it is not portable to
606 interpret specific numeric values as having specific meanings.
615 volatile signed char destruct_level; /* see possible values in intrpvar.h */
617 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
622 PERL_ARGS_ASSERT_PERL_DESTRUCT;
624 PERL_UNUSED_ARG(my_perl);
627 assert(PL_scopestack_ix == 1);
629 /* wait for all pseudo-forked children to finish */
630 PERL_WAIT_FOR_CHILDREN;
632 destruct_level = PL_perl_destruct_level;
634 const char * const s = PerlEnv_getenv("PERL_DESTRUCT_LEVEL");
637 if (strEQ(s, "-1")) { /* Special case: modperl folklore. */
641 if (grok_atoUV(s, &uv, NULL) && uv <= INT_MAX)
646 if (destruct_level < i) destruct_level = i;
647 #ifdef PERL_TRACK_MEMPOOL
648 /* RT #114496, for perl_free */
649 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 /* normally when we get here, PL_parser should be null due to having
671 * its original (null) value restored by SAVEt_PARSER during leaving
672 * scope (usually before run-time starts in fact).
673 * But if a thread is created within a BEGIN block, the parser is
674 * duped, but the SAVEt_PARSER savestack entry isn't. So PL_parser
675 * never gets cleaned up.
676 * Clean it up here instead. This is a bit of a hack.
679 /* stop parser_free() stomping on PL_curcop */
680 PL_parser->saved_curcop = PL_curcop;
681 parser_free(PL_parser);
685 /* Need to flush since END blocks can produce output */
686 /* flush stdout separately, since we can identify it */
689 PerlIO *stdo = PerlIO_stdout();
690 if (*stdo && PerlIO_flush(stdo)) {
691 PerlIO_restore_errno(stdo);
693 PerlIO_printf(PerlIO_stderr(), "Unable to flush stdout: %s\n",
702 #ifdef PERL_TRACE_OPS
703 /* dump OP-counts if $ENV{PERL_TRACE_OPS} > 0 */
705 const char * const ptoenv = PerlEnv_getenv("PERL_TRACE_OPS");
708 if (!ptoenv || !Perl_grok_atoUV(ptoenv, &uv, NULL)
712 PerlIO_printf(Perl_debug_log, "Trace of all OPs executed:\n");
713 for (i = 0; i <= OP_max; ++i) {
714 if (PL_op_exec_cnt[i])
715 PerlIO_printf(Perl_debug_log, " %s: %" UVuf "\n", PL_op_name[i], PL_op_exec_cnt[i]);
717 /* Utility slot for easily doing little tracing experiments in the runloop: */
718 if (PL_op_exec_cnt[OP_max+1] != 0)
719 PerlIO_printf(Perl_debug_log, " SPECIAL: %" UVuf "\n", PL_op_exec_cnt[OP_max+1]);
720 PerlIO_printf(Perl_debug_log, "\n");
725 if (PL_threadhook(aTHX)) {
726 /* Threads hook has vetoed further cleanup */
727 PL_veto_cleanup = TRUE;
731 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
732 if (destruct_level != 0) {
733 /* Fork here to create a child. Our child's job is to preserve the
734 state of scalars prior to destruction, so that we can instruct it
735 to dump any scalars that we later find have leaked.
736 There's no subtlety in this code - it assumes POSIX, and it doesn't
740 if(PerlSock_socketpair_cloexec(AF_UNIX, SOCK_STREAM, 0, fd)) {
741 perror("Debug leaking scalars socketpair failed");
747 perror("Debug leaking scalars fork failed");
751 /* We are the child */
752 const int sock = fd[1];
753 const int debug_fd = PerlIO_fileno(Perl_debug_log);
756 /* Our success message is an integer 0, and a char 0 */
757 static const char success[sizeof(int) + 1] = {0};
761 /* We need to close all other file descriptors otherwise we end up
762 with interesting hangs, where the parent closes its end of a
763 pipe, and sits waiting for (another) child to terminate. Only
764 that child never terminates, because it never gets EOF, because
765 we also have the far end of the pipe open. We even need to
766 close the debugging fd, because sometimes it happens to be one
767 end of a pipe, and a process is waiting on the other end for
768 EOF. Normally it would be closed at some point earlier in
769 destruction, but if we happen to cause the pipe to remain open,
770 EOF never occurs, and we get an infinite hang. Hence all the
771 games to pass in a file descriptor if it's actually needed. */
773 f = sysconf(_SC_OPEN_MAX);
775 where = "sysconf failed";
786 union control_un control;
789 struct cmsghdr *cmptr;
793 msg.msg_control = control.control;
794 msg.msg_controllen = sizeof(control.control);
795 /* We're a connected socket so we don't need a source */
799 msg.msg_iovlen = C_ARRAY_LENGTH(vec);
801 vec[0].iov_base = (void*)⌖
802 vec[0].iov_len = sizeof(target);
804 got = recvmsg(sock, &msg, 0);
809 where = "recv failed";
812 if(got < sizeof(target)) {
813 where = "short recv";
817 if(!(cmptr = CMSG_FIRSTHDR(&msg))) {
821 if(cmptr->cmsg_len != CMSG_LEN(sizeof(int))) {
822 where = "wrong cmsg_len";
825 if(cmptr->cmsg_level != SOL_SOCKET) {
826 where = "wrong cmsg_level";
829 if(cmptr->cmsg_type != SCM_RIGHTS) {
830 where = "wrong cmsg_type";
834 got_fd = *(int*)CMSG_DATA(cmptr);
835 /* For our last little bit of trickery, put the file descriptor
836 back into Perl_debug_log, as if we never actually closed it
838 if(got_fd != debug_fd) {
839 if (PerlLIO_dup2_cloexec(got_fd, debug_fd) == -1) {
846 PerlIO_flush(Perl_debug_log);
848 got = write(sock, &success, sizeof(success));
851 where = "write failed";
854 if(got < sizeof(success)) {
855 where = "short write";
862 int send_errno = errno;
863 unsigned char length = (unsigned char) strlen(where);
864 struct iovec failure[3] = {
865 {(void*)&send_errno, sizeof(send_errno)},
867 {(void*)where, length}
869 int got = writev(sock, failure, 3);
870 /* Bad news travels fast. Faster than data. We'll get a SIGPIPE
871 in the parent if we try to read from the socketpair after the
872 child has exited, even if there was data to read.
873 So sleep a bit to give the parent a fighting chance of
876 _exit((got == -1) ? errno : 0);
880 PL_dumper_fd = fd[0];
885 /* We must account for everything. */
887 /* Destroy the main CV and syntax tree */
888 /* Set PL_curcop now, because destroying ops can cause new SVs
889 to be generated in Perl_pad_swipe, and when running with
890 -DDEBUG_LEAKING_SCALARS they expect PL_curcop to point to a valid
891 op from which the filename structure member is copied. */
892 PL_curcop = &PL_compiling;
894 /* ensure comppad/curpad to refer to main's pad */
895 if (CvPADLIST(PL_main_cv)) {
896 PAD_SET_CUR_NOSAVE(CvPADLIST(PL_main_cv), 1);
897 PL_comppad_name = PadlistNAMES(CvPADLIST(PL_main_cv));
899 op_free(PL_main_root);
902 PL_main_start = NULL;
903 /* note that PL_main_cv isn't usually actually freed at this point,
904 * due to the CvOUTSIDE refs from subs compiled within it. It will
905 * get freed once all the subs are freed in sv_clean_all(), for
906 * destruct_level > 0 */
907 SvREFCNT_dec(PL_main_cv);
909 PERL_SET_PHASE(PERL_PHASE_DESTRUCT);
911 /* Tell PerlIO we are about to tear things apart in case
912 we have layers which are using resources that should
916 PerlIO_destruct(aTHX);
919 * Try to destruct global references. We do this first so that the
920 * destructors and destructees still exist. Some sv's might remain.
921 * Non-referenced objects are on their own.
925 /* unhook hooks which will soon be, or use, destroyed data */
926 SvREFCNT_dec(PL_warnhook);
928 SvREFCNT_dec(PL_diehook);
931 /* call exit list functions */
932 while (PL_exitlistlen-- > 0)
933 PL_exitlist[PL_exitlistlen].fn(aTHX_ PL_exitlist[PL_exitlistlen].ptr);
935 Safefree(PL_exitlist);
940 SvREFCNT_dec(PL_registered_mros);
942 /* jettison our possibly duplicated environment */
943 /* if PERL_USE_SAFE_PUTENV is defined environ will not have been copied
944 * so we certainly shouldn't free it here
947 #if defined(USE_ENVIRON_ARRAY) && !defined(PERL_USE_SAFE_PUTENV)
948 if (environ != PL_origenviron && !PL_use_safe_putenv
950 /* only main thread can free environ[0] contents */
951 && PL_curinterp == aTHX
957 for (i = 0; environ[i]; i++)
958 safesysfree(environ[i]);
960 /* Must use safesysfree() when working with environ. */
961 safesysfree(environ);
963 environ = PL_origenviron;
966 #endif /* !PERL_MICRO */
968 if (destruct_level == 0) {
970 DEBUG_P(debprofdump());
972 #if defined(PERLIO_LAYERS)
973 /* No more IO - including error messages ! */
974 PerlIO_cleanup(aTHX);
977 CopFILE_free(&PL_compiling);
979 /* The exit() function will do everything that needs doing. */
983 /* Below, do clean up for when PERL_DESTRUCT_LEVEL is not 0 */
986 /* the syntax tree is shared between clones
987 * so op_free(PL_main_root) only ReREFCNT_dec's
988 * REGEXPs in the parent interpreter
989 * we need to manually ReREFCNT_dec for the clones
992 I32 i = AvFILLp(PL_regex_padav);
993 SV **ary = AvARRAY(PL_regex_padav);
996 SvREFCNT_dec(ary[i]);
997 ary[i] = &PL_sv_undef;
1003 SvREFCNT_dec(MUTABLE_SV(PL_stashcache));
1004 PL_stashcache = NULL;
1006 /* loosen bonds of global variables */
1008 /* XXX can PL_parser still be non-null here? */
1009 if(PL_parser && PL_parser->rsfp) {
1010 (void)PerlIO_close(PL_parser->rsfp);
1011 PL_parser->rsfp = NULL;
1015 Safefree(PL_splitstr);
1025 PL_doswitches = FALSE;
1026 PL_dowarn = G_WARN_OFF;
1027 #ifdef PERL_SAWAMPERSAND
1028 PL_sawampersand = 0; /* must save all match strings */
1032 Safefree(PL_inplace);
1034 SvREFCNT_dec(PL_patchlevel);
1037 SvREFCNT_dec(PL_e_script);
1043 /* magical thingies */
1045 SvREFCNT_dec(PL_ofsgv); /* *, */
1048 SvREFCNT_dec(PL_ors_sv); /* $\ */
1051 SvREFCNT_dec(PL_rs); /* $/ */
1054 Safefree(PL_osname); /* $^O */
1057 SvREFCNT_dec(PL_statname);
1061 /* defgv, aka *_ should be taken care of elsewhere */
1064 Safefree(PL_efloatbuf);
1065 PL_efloatbuf = NULL;
1068 /* startup and shutdown function lists */
1069 SvREFCNT_dec(PL_beginav);
1070 SvREFCNT_dec(PL_beginav_save);
1071 SvREFCNT_dec(PL_endav);
1072 SvREFCNT_dec(PL_checkav);
1073 SvREFCNT_dec(PL_checkav_save);
1074 SvREFCNT_dec(PL_unitcheckav);
1075 SvREFCNT_dec(PL_unitcheckav_save);
1076 SvREFCNT_dec(PL_initav);
1078 PL_beginav_save = NULL;
1081 PL_checkav_save = NULL;
1082 PL_unitcheckav = NULL;
1083 PL_unitcheckav_save = NULL;
1086 /* shortcuts just get cleared */
1089 PL_argvoutgv = NULL;
1092 PL_last_in_gv = NULL;
1103 SvREFCNT_dec(PL_envgv);
1104 SvREFCNT_dec(PL_incgv);
1105 SvREFCNT_dec(PL_argvgv);
1106 SvREFCNT_dec(PL_replgv);
1107 SvREFCNT_dec(PL_DBgv);
1108 SvREFCNT_dec(PL_DBline);
1109 SvREFCNT_dec(PL_DBsub);
1118 SvREFCNT_dec(PL_argvout_stack);
1119 PL_argvout_stack = NULL;
1121 SvREFCNT_dec(PL_modglobal);
1122 PL_modglobal = NULL;
1123 SvREFCNT_dec(PL_preambleav);
1124 PL_preambleav = NULL;
1125 SvREFCNT_dec(PL_subname);
1127 #ifdef PERL_USES_PL_PIDSTATUS
1128 SvREFCNT_dec(PL_pidstatus);
1129 PL_pidstatus = NULL;
1131 SvREFCNT_dec(PL_toptarget);
1132 PL_toptarget = NULL;
1133 SvREFCNT_dec(PL_bodytarget);
1134 PL_bodytarget = NULL;
1135 PL_formtarget = NULL;
1137 /* free locale stuff */
1138 #ifdef USE_LOCALE_COLLATE
1139 Safefree(PL_collation_name);
1140 PL_collation_name = NULL;
1142 #if defined(USE_POSIX_2008_LOCALE) \
1143 && defined(USE_THREAD_SAFE_LOCALE) \
1144 && ! defined(HAS_QUERYLOCALE)
1145 for (i = 0; i < (int) C_ARRAY_LENGTH(PL_curlocales); i++) {
1146 Safefree(PL_curlocales[i]);
1147 PL_curlocales[i] = NULL;
1150 #ifdef HAS_POSIX_2008_LOCALE
1152 /* This also makes sure we aren't using a locale object that gets freed
1154 const locale_t old_locale = uselocale(LC_GLOBAL_LOCALE);
1155 if ( old_locale != LC_GLOBAL_LOCALE
1156 # ifdef USE_POSIX_2008_LOCALE
1157 && old_locale != PL_C_locale_obj
1160 DEBUG_Lv(PerlIO_printf(Perl_debug_log,
1161 "%s:%d: Freeing %p\n", __FILE__, __LINE__, old_locale));
1162 freelocale(old_locale);
1165 # ifdef USE_LOCALE_NUMERIC
1166 if (PL_underlying_numeric_obj) {
1167 DEBUG_Lv(PerlIO_printf(Perl_debug_log,
1168 "%s:%d: Freeing %p\n", __FILE__, __LINE__,
1169 PL_underlying_numeric_obj));
1170 freelocale(PL_underlying_numeric_obj);
1171 PL_underlying_numeric_obj = (locale_t) NULL;
1175 #ifdef USE_LOCALE_NUMERIC
1176 Safefree(PL_numeric_name);
1177 PL_numeric_name = NULL;
1178 SvREFCNT_dec(PL_numeric_radix_sv);
1179 PL_numeric_radix_sv = NULL;
1182 if (PL_setlocale_buf) {
1183 Safefree(PL_setlocale_buf);
1184 PL_setlocale_buf = NULL;
1187 if (PL_langinfo_buf) {
1188 Safefree(PL_langinfo_buf);
1189 PL_langinfo_buf = NULL;
1192 #ifdef USE_LOCALE_CTYPE
1193 SvREFCNT_dec(PL_warn_locale);
1194 PL_warn_locale = NULL;
1197 if (!specialWARN(PL_compiling.cop_warnings))
1198 PerlMemShared_free(PL_compiling.cop_warnings);
1199 PL_compiling.cop_warnings = NULL;
1200 cophh_free(CopHINTHASH_get(&PL_compiling));
1201 CopHINTHASH_set(&PL_compiling, cophh_new_empty());
1202 CopFILE_free(&PL_compiling);
1204 /* Prepare to destruct main symbol table. */
1207 /* break ref loop *:: <=> %:: */
1208 (void)hv_deletes(hv, "main::", G_DISCARD);
1211 SvREFCNT_dec(PL_curstname);
1212 PL_curstname = NULL;
1214 /* clear queued errors */
1215 SvREFCNT_dec(PL_errors);
1218 SvREFCNT_dec(PL_isarev);
1221 if (destruct_level >= 2) {
1222 if (PL_scopestack_ix != 0)
1223 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
1224 "Unbalanced scopes: %ld more ENTERs than LEAVEs\n",
1225 (long)PL_scopestack_ix);
1226 if (PL_savestack_ix != 0)
1227 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
1228 "Unbalanced saves: %ld more saves than restores\n",
1229 (long)PL_savestack_ix);
1230 if (PL_tmps_floor != -1)
1231 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced tmps: %ld more allocs than frees\n",
1232 (long)PL_tmps_floor + 1);
1233 if (cxstack_ix != -1)
1234 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced context: %ld more PUSHes than POPs\n",
1235 (long)cxstack_ix + 1);
1239 SvREFCNT_dec(PL_regex_padav);
1240 PL_regex_padav = NULL;
1241 PL_regex_pad = NULL;
1244 #ifdef PERL_IMPLICIT_CONTEXT
1245 /* the entries in this list are allocated via SV PVX's, so get freed
1246 * in sv_clean_all */
1247 Safefree(PL_my_cxt_list);
1250 /* Now absolutely destruct everything, somehow or other, loops or no. */
1252 /* the 2 is for PL_fdpid and PL_strtab */
1253 while (sv_clean_all() > 2)
1257 Safefree(PL_stashpad); /* must come after sv_clean_all */
1260 AvREAL_off(PL_fdpid); /* no surviving entries */
1261 SvREFCNT_dec(PL_fdpid); /* needed in io_close() */
1264 #ifdef HAVE_INTERP_INTERN
1268 /* constant strings */
1269 for (i = 0; i < SV_CONSTS_COUNT; i++) {
1270 SvREFCNT_dec(PL_sv_consts[i]);
1271 PL_sv_consts[i] = NULL;
1274 /* Destruct the global string table. */
1276 /* Yell and reset the HeVAL() slots that are still holding refcounts,
1277 * so that sv_free() won't fail on them.
1278 * Now that the global string table is using a single hunk of memory
1279 * for both HE and HEK, we either need to explicitly unshare it the
1280 * correct way, or actually free things here.
1283 const I32 max = HvMAX(PL_strtab);
1284 HE * const * const array = HvARRAY(PL_strtab);
1285 HE *hent = array[0];
1288 if (hent && ckWARN_d(WARN_INTERNAL)) {
1289 HE * const next = HeNEXT(hent);
1290 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
1291 "Unbalanced string table refcount: (%ld) for \"%s\"",
1292 (long)hent->he_valu.hent_refcount, HeKEY(hent));
1299 hent = array[riter];
1304 HvARRAY(PL_strtab) = 0;
1305 HvTOTALKEYS(PL_strtab) = 0;
1307 SvREFCNT_dec(PL_strtab);
1310 /* free the pointer tables used for cloning */
1311 ptr_table_free(PL_ptr_table);
1312 PL_ptr_table = (PTR_TBL_t*)NULL;
1315 /* free special SVs */
1317 SvREFCNT(&PL_sv_yes) = 0;
1318 sv_clear(&PL_sv_yes);
1319 SvANY(&PL_sv_yes) = NULL;
1320 SvFLAGS(&PL_sv_yes) = 0;
1322 SvREFCNT(&PL_sv_no) = 0;
1323 sv_clear(&PL_sv_no);
1324 SvANY(&PL_sv_no) = NULL;
1325 SvFLAGS(&PL_sv_no) = 0;
1327 SvREFCNT(&PL_sv_zero) = 0;
1328 sv_clear(&PL_sv_zero);
1329 SvANY(&PL_sv_zero) = NULL;
1330 SvFLAGS(&PL_sv_zero) = 0;
1334 for (i=0; i<=2; i++) {
1335 SvREFCNT(PERL_DEBUG_PAD(i)) = 0;
1336 sv_clear(PERL_DEBUG_PAD(i));
1337 SvANY(PERL_DEBUG_PAD(i)) = NULL;
1338 SvFLAGS(PERL_DEBUG_PAD(i)) = 0;
1342 if (PL_sv_count != 0 && ckWARN_d(WARN_INTERNAL))
1343 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Scalars leaked: %ld\n", (long)PL_sv_count);
1345 #ifdef DEBUG_LEAKING_SCALARS
1346 if (PL_sv_count != 0) {
1351 for (sva = PL_sv_arenaroot; sva; sva = MUTABLE_SV(SvANY(sva))) {
1352 svend = &sva[SvREFCNT(sva)];
1353 for (sv = sva + 1; sv < svend; ++sv) {
1354 if (SvTYPE(sv) != (svtype)SVTYPEMASK) {
1355 PerlIO_printf(Perl_debug_log, "leaked: sv=0x%p"
1357 " refcnt=%" UVuf pTHX__FORMAT "\n"
1358 "\tallocated at %s:%d %s %s (parent 0x%" UVxf ");"
1359 "serial %" UVuf "\n",
1360 (void*)sv, (UV)sv->sv_flags, (UV)sv->sv_refcnt
1362 sv->sv_debug_file ? sv->sv_debug_file : "(unknown)",
1364 sv->sv_debug_inpad ? "for" : "by",
1365 sv->sv_debug_optype ?
1366 PL_op_name[sv->sv_debug_optype]: "(none)",
1367 PTR2UV(sv->sv_debug_parent),
1370 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1371 Perl_dump_sv_child(aTHX_ sv);
1377 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1381 /* Wait for up to 4 seconds for child to terminate.
1382 This seems to be the least effort way of timing out on reaping
1384 struct timeval waitfor = {4, 0};
1385 int sock = PL_dumper_fd;
1389 FD_SET(sock, &rset);
1390 select(sock + 1, &rset, NULL, NULL, &waitfor);
1391 waitpid(child, &status, WNOHANG);
1396 #ifdef DEBUG_LEAKING_SCALARS_ABORT
1402 #if defined(PERLIO_LAYERS)
1403 /* No more IO - including error messages ! */
1404 PerlIO_cleanup(aTHX);
1407 /* sv_undef needs to stay immortal until after PerlIO_cleanup
1408 as currently layers use it rather than NULL as a marker
1409 for no arg - and will try and SvREFCNT_dec it.
1411 SvREFCNT(&PL_sv_undef) = 0;
1412 SvREADONLY_off(&PL_sv_undef);
1414 Safefree(PL_origfilename);
1415 PL_origfilename = NULL;
1416 Safefree(PL_reg_curpm);
1417 free_tied_hv_pool();
1418 Safefree(PL_op_mask);
1419 Safefree(PL_psig_name);
1420 PL_psig_name = (SV**)NULL;
1421 PL_psig_ptr = (SV**)NULL;
1423 /* We need to NULL PL_psig_pend first, so that
1424 signal handlers know not to use it */
1425 int *psig_save = PL_psig_pend;
1426 PL_psig_pend = (int*)NULL;
1427 Safefree(psig_save);
1430 TAINTING_set(FALSE);
1431 TAINT_WARN_set(FALSE);
1432 PL_hints = 0; /* Reset hints. Should hints be per-interpreter ? */
1434 DEBUG_P(debprofdump());
1438 #ifdef USE_REENTRANT_API
1439 Perl_reentrant_free(aTHX);
1442 /* These all point to HVs that are about to be blown away.
1443 Code in core and on CPAN assumes that if the interpreter is re-started
1444 that they will be cleanly NULL or pointing to a valid HV. */
1445 PL_custom_op_names = NULL;
1446 PL_custom_op_descs = NULL;
1447 PL_custom_ops = NULL;
1451 while (PL_regmatch_slab) {
1452 regmatch_slab *s = PL_regmatch_slab;
1453 PL_regmatch_slab = PL_regmatch_slab->next;
1457 /* As the absolutely last thing, free the non-arena SV for mess() */
1460 /* we know that type == SVt_PVMG */
1462 /* it could have accumulated taint magic */
1465 for (mg = SvMAGIC(PL_mess_sv); mg; mg = moremagic) {
1466 moremagic = mg->mg_moremagic;
1467 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global
1469 Safefree(mg->mg_ptr);
1473 /* we know that type >= SVt_PV */
1474 SvPV_free(PL_mess_sv);
1475 Safefree(SvANY(PL_mess_sv));
1476 Safefree(PL_mess_sv);
1483 =for apidoc perl_free
1485 Releases a Perl interpreter. See L<perlembed>.
1495 PERL_ARGS_ASSERT_PERL_FREE;
1497 if (PL_veto_cleanup)
1500 #ifdef PERL_TRACK_MEMPOOL
1503 * Don't free thread memory if PERL_DESTRUCT_LEVEL is set to a non-zero
1504 * value as we're probably hunting memory leaks then
1506 if (PL_perl_destruct_level == 0) {
1507 const U32 old_debug = PL_debug;
1508 /* Emulate the PerlHost behaviour of free()ing all memory allocated in this
1509 thread at thread exit. */
1511 PerlIO_puts(Perl_debug_log, "Disabling memory debugging as we "
1512 "free this thread's memory\n");
1513 PL_debug &= ~ DEBUG_m_FLAG;
1515 while(aTHXx->Imemory_debug_header.next != &(aTHXx->Imemory_debug_header)){
1516 char * next = (char *)(aTHXx->Imemory_debug_header.next);
1517 Malloc_t ptr = PERL_MEMORY_DEBUG_HEADER_SIZE + next;
1520 PL_debug = old_debug;
1525 #if defined(WIN32) || defined(NETWARE)
1526 # if defined(PERL_IMPLICIT_SYS)
1529 void *host = nw_internal_host;
1530 PerlMem_free(aTHXx);
1531 nw_delete_internal_host(host);
1533 void *host = w32_internal_host;
1534 PerlMem_free(aTHXx);
1535 win32_delete_internal_host(host);
1539 PerlMem_free(aTHXx);
1542 PerlMem_free(aTHXx);
1546 #if defined(USE_ITHREADS)
1547 /* provide destructors to clean up the thread key when libperl is unloaded */
1548 #ifndef WIN32 /* handled during DLL_PROCESS_DETACH in win32/perllib.c */
1550 #if defined(__hpux) && !(defined(__ux_version) && __ux_version <= 1020) && !defined(__GNUC__)
1551 #pragma fini "perl_fini"
1552 #elif defined(__sun) && !defined(__GNUC__)
1553 #pragma fini (perl_fini)
1557 #if defined(__GNUC__)
1558 __attribute__((destructor))
1564 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
1567 PL_curinterp && !PL_veto_cleanup)
1572 #endif /* THREADS */
1575 Perl_call_atexit(pTHX_ ATEXIT_t fn, void *ptr)
1577 Renew(PL_exitlist, PL_exitlistlen+1, PerlExitListEntry);
1578 PL_exitlist[PL_exitlistlen].fn = fn;
1579 PL_exitlist[PL_exitlistlen].ptr = ptr;
1584 =for apidoc perl_parse
1586 Tells a Perl interpreter to parse a Perl script. This performs most
1587 of the initialisation of a Perl interpreter. See L<perlembed> for
1590 C<my_perl> points to the Perl interpreter that is to parse the script.
1591 It must have been previously created through the use of L</perl_alloc>
1592 and L</perl_construct>. C<xsinit> points to a callback function that
1593 will be called to set up the ability for this Perl interpreter to load
1594 XS extensions, or may be null to perform no such setup.
1596 C<argc> and C<argv> supply a set of command-line arguments to the Perl
1597 interpreter, as would normally be passed to the C<main> function of
1598 a C program. C<argv[argc]> must be null. These arguments are where
1599 the script to parse is specified, either by naming a script file or by
1600 providing a script in a C<-e> option.
1601 If L<C<$0>|perlvar/$0> will be written to in the Perl interpreter, then
1602 the argument strings must be in writable memory, and so mustn't just be
1605 C<env> specifies a set of environment variables that will be used by
1606 this Perl interpreter. If non-null, it must point to a null-terminated
1607 array of environment strings. If null, the Perl interpreter will use
1608 the environment supplied by the C<environ> global variable.
1610 This function initialises the interpreter, and parses and compiles the
1611 script specified by the command-line arguments. This includes executing
1612 code in C<BEGIN>, C<UNITCHECK>, and C<CHECK> blocks. It does not execute
1613 C<INIT> blocks or the main program.
1615 Returns an integer of slightly tricky interpretation. The correct
1616 use of the return value is as a truth value indicating whether there
1617 was a failure in initialisation. If zero is returned, this indicates
1618 that initialisation was successful, and it is safe to proceed to call
1619 L</perl_run> and make other use of it. If a non-zero value is returned,
1620 this indicates some problem that means the interpreter wants to terminate.
1621 The interpreter should not be just abandoned upon such failure; the caller
1622 should proceed to shut the interpreter down cleanly with L</perl_destruct>
1623 and free it with L</perl_free>.
1625 For historical reasons, the non-zero return value also attempts to
1626 be a suitable value to pass to the C library function C<exit> (or to
1627 return from C<main>), to serve as an exit code indicating the nature
1628 of the way initialisation terminated. However, this isn't portable,
1629 due to differing exit code conventions. A historical bug is preserved
1630 for the time being: if the Perl built-in C<exit> is called during this
1631 function's execution, with a type of exit entailing a zero exit code
1632 under the host operating system's conventions, then this function
1633 returns zero rather than a non-zero value. This bug, [perl #2754],
1634 leads to C<perl_run> being called (and therefore C<INIT> blocks and the
1635 main program running) despite a call to C<exit>. It has been preserved
1636 because a popular module-installing module has come to rely on it and
1637 needs time to be fixed. This issue is [perl #132577], and the original
1638 bug is due to be fixed in Perl 5.30.
1643 #define SET_CURSTASH(newstash) \
1644 if (PL_curstash != newstash) { \
1645 SvREFCNT_dec(PL_curstash); \
1646 PL_curstash = (HV *)SvREFCNT_inc(newstash); \
1650 perl_parse(pTHXx_ XSINIT_t xsinit, int argc, char **argv, char **env)
1657 PERL_ARGS_ASSERT_PERL_PARSE;
1658 #ifndef MULTIPLICITY
1659 PERL_UNUSED_ARG(my_perl);
1661 #if (defined(USE_HASH_SEED) || defined(USE_HASH_SEED_DEBUG)) && !defined(NO_PERL_HASH_SEED_DEBUG)
1663 const char * const s = PerlEnv_getenv("PERL_HASH_SEED_DEBUG");
1665 if (s && strEQ(s, "1")) {
1666 const unsigned char *seed= PERL_HASH_SEED;
1667 const unsigned char *seed_end= PERL_HASH_SEED + PERL_HASH_SEED_BYTES;
1668 PerlIO_printf(Perl_debug_log, "HASH_FUNCTION = %s HASH_SEED = 0x", PERL_HASH_FUNC);
1669 while (seed < seed_end) {
1670 PerlIO_printf(Perl_debug_log, "%02x", *seed++);
1672 #ifdef PERL_HASH_RANDOMIZE_KEYS
1673 PerlIO_printf(Perl_debug_log, " PERTURB_KEYS = %d (%s)",
1674 PL_HASH_RAND_BITS_ENABLED,
1675 PL_HASH_RAND_BITS_ENABLED == 0 ? "NO" : PL_HASH_RAND_BITS_ENABLED == 1 ? "RANDOM" : "DETERMINISTIC");
1677 PerlIO_printf(Perl_debug_log, "\n");
1680 #endif /* #if (defined(USE_HASH_SEED) ... */
1684 struct NameTranslationInfo nti;
1685 __translate_amiga_to_unix_path_name(&argv[0],&nti);
1692 for(i = 0; i != argc; i++)
1694 assert(!argv[argc]);
1699 if (PL_origalen != 0) {
1700 PL_origalen = 1; /* don't use old PL_origalen if perl_parse() is called again */
1703 /* Set PL_origalen be the sum of the contiguous argv[]
1704 * elements plus the size of the env in case that it is
1705 * contiguous with the argv[]. This is used in mg.c:Perl_magic_set()
1706 * as the maximum modifiable length of $0. In the worst case
1707 * the area we are able to modify is limited to the size of
1708 * the original argv[0]. (See below for 'contiguous', though.)
1710 const char *s = NULL;
1711 const UV mask = ~(UV)(PTRSIZE-1);
1712 /* Do the mask check only if the args seem like aligned. */
1714 (mask < ~(UV)0) && ((PTR2UV(argv[0]) & mask) == PTR2UV(argv[0]));
1716 /* See if all the arguments are contiguous in memory. Note
1717 * that 'contiguous' is a loose term because some platforms
1718 * align the argv[] and the envp[]. If the arguments look
1719 * like non-aligned, assume that they are 'strictly' or
1720 * 'traditionally' contiguous. If the arguments look like
1721 * aligned, we just check that they are within aligned
1722 * PTRSIZE bytes. As long as no system has something bizarre
1723 * like the argv[] interleaved with some other data, we are
1724 * fine. (Did I just evoke Murphy's Law?) --jhi */
1725 if (PL_origargv && PL_origargc >= 1 && (s = PL_origargv[0])) {
1728 for (i = 1; i < PL_origargc; i++) {
1729 if ((PL_origargv[i] == s + 1
1731 || PL_origargv[i] == s + 2
1736 (PL_origargv[i] > s &&
1738 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1749 #ifndef PERL_USE_SAFE_PUTENV
1750 /* Can we grab env area too to be used as the area for $0? */
1751 if (s && PL_origenviron && !PL_use_safe_putenv) {
1752 if ((PL_origenviron[0] == s + 1)
1755 (PL_origenviron[0] > s &&
1756 PL_origenviron[0] <=
1757 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1761 #ifndef OS2 /* ENVIRON is read by the kernel too. */
1762 s = PL_origenviron[0];
1765 my_setenv("NoNe SuCh", NULL);
1766 /* Force copy of environment. */
1767 for (i = 1; PL_origenviron[i]; i++) {
1768 if (PL_origenviron[i] == s + 1
1771 (PL_origenviron[i] > s &&
1772 PL_origenviron[i] <=
1773 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1776 s = PL_origenviron[i];
1784 #endif /* !defined(PERL_USE_SAFE_PUTENV) */
1786 PL_origalen = s ? s - PL_origargv[0] + 1 : 0;
1791 /* Come here if running an undumped a.out. */
1793 PL_origfilename = savepv(argv[0]);
1794 PL_do_undump = FALSE;
1795 cxstack_ix = -1; /* start label stack again */
1797 assert (!TAINT_get);
1801 init_postdump_symbols(argc,argv,env);
1806 op_free(PL_main_root);
1807 PL_main_root = NULL;
1809 PL_main_start = NULL;
1810 SvREFCNT_dec(PL_main_cv);
1814 oldscope = PL_scopestack_ix;
1815 PL_dowarn = G_WARN_OFF;
1820 parse_body(env,xsinit);
1821 if (PL_unitcheckav) {
1822 call_list(oldscope, PL_unitcheckav);
1825 PERL_SET_PHASE(PERL_PHASE_CHECK);
1826 call_list(oldscope, PL_checkav);
1834 /* my_exit() was called */
1835 while (PL_scopestack_ix > oldscope)
1838 SET_CURSTASH(PL_defstash);
1839 if (PL_unitcheckav) {
1840 call_list(oldscope, PL_unitcheckav);
1843 PERL_SET_PHASE(PERL_PHASE_CHECK);
1844 call_list(oldscope, PL_checkav);
1849 * At this point we should do
1851 * to avoid [perl #2754], but that bugfix has been postponed
1852 * because of the Module::Install breakage it causes
1858 PerlIO_printf(Perl_error_log, "panic: top_env\n");
1866 /* This needs to stay in perl.c, as perl.c is compiled with different flags for
1867 miniperl, and we need to see those flags reflected in the values here. */
1869 /* What this returns is subject to change. Use the public interface in Config.
1872 S_Internals_V(pTHX_ CV *cv)
1875 #ifdef LOCAL_PATCH_COUNT
1876 const int local_patch_count = LOCAL_PATCH_COUNT;
1878 const int local_patch_count = 0;
1880 const int entries = 3 + local_patch_count;
1882 static const char non_bincompat_options[] =
1889 # ifdef NO_HASH_SEED
1892 # ifdef NO_TAINT_SUPPORT
1895 # ifdef PERL_BOOL_AS_CHAR
1896 " PERL_BOOL_AS_CHAR"
1898 # ifdef PERL_COPY_ON_WRITE
1899 " PERL_COPY_ON_WRITE"
1901 # ifdef PERL_DISABLE_PMC
1904 # ifdef PERL_DONT_CREATE_GVSV
1905 " PERL_DONT_CREATE_GVSV"
1907 # ifdef PERL_EXTERNAL_GLOB
1908 " PERL_EXTERNAL_GLOB"
1910 # ifdef PERL_HASH_FUNC_SIPHASH
1911 " PERL_HASH_FUNC_SIPHASH"
1913 # ifdef PERL_HASH_FUNC_SDBM
1914 " PERL_HASH_FUNC_SDBM"
1916 # ifdef PERL_HASH_FUNC_DJB2
1917 " PERL_HASH_FUNC_DJB2"
1919 # ifdef PERL_HASH_FUNC_SUPERFAST
1920 " PERL_HASH_FUNC_SUPERFAST"
1922 # ifdef PERL_HASH_FUNC_MURMUR3
1923 " PERL_HASH_FUNC_MURMUR3"
1925 # ifdef PERL_HASH_FUNC_ONE_AT_A_TIME
1926 " PERL_HASH_FUNC_ONE_AT_A_TIME"
1928 # ifdef PERL_HASH_FUNC_ONE_AT_A_TIME_HARD
1929 " PERL_HASH_FUNC_ONE_AT_A_TIME_HARD"
1931 # ifdef PERL_HASH_FUNC_ONE_AT_A_TIME_OLD
1932 " PERL_HASH_FUNC_ONE_AT_A_TIME_OLD"
1934 # ifdef PERL_IS_MINIPERL
1937 # ifdef PERL_MALLOC_WRAP
1940 # ifdef PERL_MEM_LOG
1943 # ifdef PERL_MEM_LOG_NOIMPL
1944 " PERL_MEM_LOG_NOIMPL"
1946 # ifdef PERL_OP_PARENT
1949 # ifdef PERL_PERTURB_KEYS_DETERMINISTIC
1950 " PERL_PERTURB_KEYS_DETERMINISTIC"
1952 # ifdef PERL_PERTURB_KEYS_DISABLED
1953 " PERL_PERTURB_KEYS_DISABLED"
1955 # ifdef PERL_PERTURB_KEYS_RANDOM
1956 " PERL_PERTURB_KEYS_RANDOM"
1958 # ifdef PERL_PRESERVE_IVUV
1959 " PERL_PRESERVE_IVUV"
1961 # ifdef PERL_RELOCATABLE_INCPUSH
1962 " PERL_RELOCATABLE_INCPUSH"
1964 # ifdef PERL_USE_DEVEL
1967 # ifdef PERL_USE_SAFE_PUTENV
1968 " PERL_USE_SAFE_PUTENV"
1970 # ifdef SILENT_NO_TAINT_SUPPORT
1971 " SILENT_NO_TAINT_SUPPORT"
1973 # ifdef UNLINK_ALL_VERSIONS
1974 " UNLINK_ALL_VERSIONS"
1976 # ifdef USE_ATTRIBUTES_FOR_PERLIO
1977 " USE_ATTRIBUTES_FOR_PERLIO"
1979 # ifdef USE_FAST_STDIO
1985 # ifdef USE_LOCALE_CTYPE
1988 # ifdef WIN32_NO_REGISTRY
1991 # ifdef USE_PERL_ATOF
1994 # ifdef USE_SITECUSTOMIZE
1995 " USE_SITECUSTOMIZE"
1997 # ifdef USE_THREAD_SAFE_LOCALE
1998 " USE_THREAD_SAFE_LOCALE"
2001 PERL_UNUSED_ARG(cv);
2002 PERL_UNUSED_VAR(items);
2004 EXTEND(SP, entries);
2006 PUSHs(sv_2mortal(newSVpv(PL_bincompat_options, 0)));
2007 PUSHs(Perl_newSVpvn_flags(aTHX_ non_bincompat_options,
2008 sizeof(non_bincompat_options) - 1, SVs_TEMP));
2010 #ifndef PERL_BUILD_DATE
2013 # define PERL_BUILD_DATE __DATE__ " " __TIME__
2015 # define PERL_BUILD_DATE __DATE__
2020 #ifdef PERL_BUILD_DATE
2021 PUSHs(Perl_newSVpvn_flags(aTHX_
2022 STR_WITH_LEN("Compiled at " PERL_BUILD_DATE),
2025 PUSHs(&PL_sv_undef);
2028 for (i = 1; i <= local_patch_count; i++) {
2029 /* This will be an undef, if PL_localpatches[i] is NULL. */
2030 PUSHs(sv_2mortal(newSVpv(PL_localpatches[i], 0)));
2036 #define INCPUSH_UNSHIFT 0x01
2037 #define INCPUSH_ADD_OLD_VERS 0x02
2038 #define INCPUSH_ADD_VERSIONED_SUB_DIRS 0x04
2039 #define INCPUSH_ADD_ARCHONLY_SUB_DIRS 0x08
2040 #define INCPUSH_NOT_BASEDIR 0x10
2041 #define INCPUSH_CAN_RELOCATE 0x20
2042 #define INCPUSH_ADD_SUB_DIRS \
2043 (INCPUSH_ADD_VERSIONED_SUB_DIRS|INCPUSH_ADD_ARCHONLY_SUB_DIRS)
2046 S_parse_body(pTHX_ char **env, XSINIT_t xsinit)
2050 int argc = PL_origargc;
2051 char **argv = PL_origargv;
2052 const char *scriptname = NULL;
2053 bool dosearch = FALSE;
2055 bool doextract = FALSE;
2056 const char *cddir = NULL;
2057 #ifdef USE_SITECUSTOMIZE
2058 bool minus_f = FALSE;
2060 SV *linestr_sv = NULL;
2061 bool add_read_e_script = FALSE;
2062 U32 lex_start_flags = 0;
2064 PERL_SET_PHASE(PERL_PHASE_START);
2070 for (argc--,argv++; argc > 0; argc--,argv++) {
2071 if (argv[0][0] != '-' || !argv[0][1])
2077 #ifndef PERL_STRICT_CR
2101 if ((s = moreswitches(s)))
2106 #if defined(SILENT_NO_TAINT_SUPPORT)
2107 /* silently ignore */
2108 #elif defined(NO_TAINT_SUPPORT)
2109 Perl_croak_nocontext("This perl was compiled without taint support. "
2110 "Cowardly refusing to run with -t or -T flags");
2112 CHECK_MALLOC_TOO_LATE_FOR('t');
2113 if( !TAINTING_get ) {
2114 TAINT_WARN_set(TRUE);
2121 #if defined(SILENT_NO_TAINT_SUPPORT)
2122 /* silently ignore */
2123 #elif defined(NO_TAINT_SUPPORT)
2124 Perl_croak_nocontext("This perl was compiled without taint support. "
2125 "Cowardly refusing to run with -t or -T flags");
2127 CHECK_MALLOC_TOO_LATE_FOR('T');
2129 TAINT_WARN_set(FALSE);
2138 forbid_setid('e', FALSE);
2140 PL_e_script = newSVpvs("");
2141 add_read_e_script = TRUE;
2144 sv_catpv(PL_e_script, s);
2146 sv_catpv(PL_e_script, argv[1]);
2150 Perl_croak(aTHX_ "No code specified for -%c", c);
2151 sv_catpvs(PL_e_script, "\n");
2155 #ifdef USE_SITECUSTOMIZE
2161 case 'I': /* -I handled both here and in moreswitches() */
2162 forbid_setid('I', FALSE);
2163 if (!*++s && (s=argv[1]) != NULL) {
2167 STRLEN len = strlen(s);
2168 incpush(s, len, INCPUSH_ADD_SUB_DIRS|INCPUSH_ADD_OLD_VERS);
2171 Perl_croak(aTHX_ "No directory specified for -I");
2174 forbid_setid('S', FALSE);
2183 opts_prog = newSVpvs("use Config; Config::_V()");
2187 opts_prog = Perl_newSVpvf(aTHX_
2188 "use Config; Config::config_vars(qw%c%s%c)",
2192 Perl_av_create_and_push(aTHX_ &PL_preambleav, opts_prog);
2193 /* don't look for script or read stdin */
2194 scriptname = BIT_BUCKET;
2206 if (!*++s || isSPACE(*s)) {
2210 /* catch use of gnu style long options.
2211 Both of these exit immediately. */
2212 if (strEQ(s, "version"))
2214 if (strEQ(s, "help"))
2219 Perl_croak(aTHX_ "Unrecognized switch: -%s (-h will show valid options)",s);
2230 #ifndef SECURE_INTERNAL_GETENV
2233 (s = PerlEnv_getenv("PERL5OPT")))
2235 /* s points to static memory in getenv(), which may be overwritten at
2236 * any time; use a mortal copy instead */
2237 s = SvPVX(sv_2mortal(newSVpv(s, 0)));
2241 if (*s == '-' && *(s+1) == 'T') {
2242 #if defined(SILENT_NO_TAINT_SUPPORT)
2243 /* silently ignore */
2244 #elif defined(NO_TAINT_SUPPORT)
2245 Perl_croak_nocontext("This perl was compiled without taint support. "
2246 "Cowardly refusing to run with -t or -T flags");
2248 CHECK_MALLOC_TOO_LATE_FOR('T');
2250 TAINT_WARN_set(FALSE);
2254 char *popt_copy = NULL;
2267 if (!strchr("CDIMUdmtwW", *s))
2268 Perl_croak(aTHX_ "Illegal switch in PERL5OPT: -%c", *s);
2272 popt_copy = SvPVX(sv_2mortal(newSVpv(d,0)));
2273 s = popt_copy + (s - d);
2281 #if defined(SILENT_NO_TAINT_SUPPORT)
2282 /* silently ignore */
2283 #elif defined(NO_TAINT_SUPPORT)
2284 Perl_croak_nocontext("This perl was compiled without taint support. "
2285 "Cowardly refusing to run with -t or -T flags");
2287 if( !TAINTING_get) {
2288 TAINT_WARN_set(TRUE);
2300 #ifndef NO_PERL_INTERNAL_RAND_SEED
2301 /* If we're not set[ug]id, we might have honored
2302 PERL_INTERNAL_RAND_SEED in perl_construct().
2303 At this point command-line options have been parsed, so if
2304 we're now tainting and not set[ug]id re-seed.
2305 This could possibly be wasteful if PERL_INTERNAL_RAND_SEED is invalid,
2306 but avoids duplicating the logic from perl_construct().
2309 PerlProc_getuid() == PerlProc_geteuid() &&
2310 PerlProc_getgid() == PerlProc_getegid()) {
2311 Perl_drand48_init_r(&PL_internal_random_state, seed());
2315 /* Set $^X early so that it can be used for relocatable paths in @INC */
2316 /* and for SITELIB_EXP in USE_SITECUSTOMIZE */
2317 assert (!TAINT_get);
2322 #if defined(USE_SITECUSTOMIZE)
2324 /* The games with local $! are to avoid setting errno if there is no
2325 sitecustomize script. "q%c...%c", 0, ..., 0 becomes "q\0...\0",
2326 ie a q() operator with a NUL byte as a the delimiter. This avoids
2327 problems with pathnames containing (say) ' */
2328 # ifdef PERL_IS_MINIPERL
2329 AV *const inc = GvAV(PL_incgv);
2330 SV **const inc0 = inc ? av_fetch(inc, 0, FALSE) : NULL;
2333 /* if lib/buildcustomize.pl exists, it should not fail. If it does,
2334 it should be reported immediately as a build failure. */
2335 (void)Perl_av_create_and_unshift_one(aTHX_ &PL_preambleav,
2337 "BEGIN { my $f = q%c%s%" SVf "/buildcustomize.pl%c; "
2338 "do {local $!; -f $f }"
2339 " and do $f || die $@ || qq '$f: $!' }",
2340 0, (TAINTING_get ? "./" : ""), SVfARG(*inc0), 0));
2343 /* SITELIB_EXP is a function call on Win32. */
2344 const char *const raw_sitelib = SITELIB_EXP;
2346 /* process .../.. if PERL_RELOCATABLE_INC is defined */
2347 SV *sitelib_sv = mayberelocate(raw_sitelib, strlen(raw_sitelib),
2348 INCPUSH_CAN_RELOCATE);
2349 const char *const sitelib = SvPVX(sitelib_sv);
2350 (void)Perl_av_create_and_unshift_one(aTHX_ &PL_preambleav,
2352 "BEGIN { do {local $!; -f q%c%s/sitecustomize.pl%c} && do q%c%s/sitecustomize.pl%c }",
2353 0, SVfARG(sitelib), 0,
2354 0, SVfARG(sitelib), 0));
2355 assert (SvREFCNT(sitelib_sv) == 1);
2356 SvREFCNT_dec(sitelib_sv);
2363 scriptname = argv[0];
2366 scriptname = BIT_BUCKET; /* don't look for script or read stdin */
2368 else if (scriptname == NULL) {
2370 if ( PerlLIO_isatty(PerlIO_fileno(PerlIO_stdin())) )
2376 assert (!TAINT_get);
2380 bool suidscript = FALSE;
2382 rsfp = open_script(scriptname, dosearch, &suidscript);
2384 rsfp = PerlIO_stdin();
2385 lex_start_flags = LEX_DONT_CLOSE_RSFP;
2388 validate_suid(rsfp);
2391 # if defined(SIGCHLD) || defined(SIGCLD)
2394 # define SIGCHLD SIGCLD
2396 Sighandler_t sigstate = rsignal_state(SIGCHLD);
2397 if (sigstate == (Sighandler_t) SIG_IGN) {
2398 Perl_ck_warner(aTHX_ packWARN(WARN_SIGNAL),
2399 "Can't ignore signal CHLD, forcing to default");
2400 (void)rsignal(SIGCHLD, (Sighandler_t)SIG_DFL);
2408 /* This will croak if suidscript is true, as -x cannot be used with
2410 forbid_setid('x', suidscript);
2411 /* Hence you can't get here if suidscript is true */
2413 linestr_sv = newSV_type(SVt_PV);
2414 lex_start_flags |= LEX_START_COPIED;
2415 find_beginning(linestr_sv, rsfp);
2416 if (cddir && PerlDir_chdir( (char *)cddir ) < 0)
2417 Perl_croak(aTHX_ "Can't chdir to %s",cddir);
2421 PL_main_cv = PL_compcv = MUTABLE_CV(newSV_type(SVt_PVCV));
2422 CvUNIQUE_on(PL_compcv);
2424 CvPADLIST_set(PL_compcv, pad_new(0));
2426 PL_isarev = newHV();
2429 boot_core_UNIVERSAL();
2431 newXS("Internals::V", S_Internals_V, __FILE__);
2434 (*xsinit)(aTHX); /* in case linked C routines want magical variables */
2436 #if defined(VMS) || defined(WIN32) || defined(DJGPP) || defined(__CYGWIN__) || defined(SYMBIAN)
2442 # ifdef HAS_SOCKS5_INIT
2443 socks5_init(argv[0]);
2449 init_predump_symbols();
2450 /* init_postdump_symbols not currently designed to be called */
2451 /* more than once (ENV isn't cleared first, for example) */
2452 /* But running with -u leaves %ENV & @ARGV undefined! XXX */
2454 init_postdump_symbols(argc,argv,env);
2456 /* PL_unicode is turned on by -C, or by $ENV{PERL_UNICODE},
2457 * or explicitly in some platforms.
2458 * PL_utf8locale is conditionally turned on by
2459 * locale.c:Perl_init_i18nl10n() if the environment
2460 * look like the user wants to use UTF-8. */
2461 #if defined(__SYMBIAN32__)
2462 PL_unicode = PERL_UNICODE_STD_FLAG; /* See PERL_SYMBIAN_CONSOLE_UTF8. */
2464 # ifndef PERL_IS_MINIPERL
2466 /* Requires init_predump_symbols(). */
2467 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
2472 /* Turn on UTF-8-ness on STDIN, STDOUT, STDERR
2473 * and the default open disciplines. */
2474 if ((PL_unicode & PERL_UNICODE_STDIN_FLAG) &&
2475 PL_stdingv && (io = GvIO(PL_stdingv)) &&
2477 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2478 if ((PL_unicode & PERL_UNICODE_STDOUT_FLAG) &&
2479 PL_defoutgv && (io = GvIO(PL_defoutgv)) &&
2481 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2482 if ((PL_unicode & PERL_UNICODE_STDERR_FLAG) &&
2483 PL_stderrgv && (io = GvIO(PL_stderrgv)) &&
2485 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2486 if ((PL_unicode & PERL_UNICODE_INOUT_FLAG) &&
2487 (sv = GvSV(gv_fetchpvs("\017PEN", GV_ADD|GV_NOTQUAL,
2489 U32 in = PL_unicode & PERL_UNICODE_IN_FLAG;
2490 U32 out = PL_unicode & PERL_UNICODE_OUT_FLAG;
2493 sv_setpvs(sv, ":utf8\0:utf8");
2495 sv_setpvs(sv, ":utf8\0");
2498 sv_setpvs(sv, "\0:utf8");
2507 if ((s = PerlEnv_getenv("PERL_SIGNALS"))) {
2508 if (strEQ(s, "unsafe"))
2509 PL_signals |= PERL_SIGNALS_UNSAFE_FLAG;
2510 else if (strEQ(s, "safe"))
2511 PL_signals &= ~PERL_SIGNALS_UNSAFE_FLAG;
2513 Perl_croak(aTHX_ "PERL_SIGNALS illegal: \"%s\"", s);
2518 lex_start(linestr_sv, rsfp, lex_start_flags);
2519 SvREFCNT_dec(linestr_sv);
2521 PL_subname = newSVpvs("main");
2523 if (add_read_e_script)
2524 filter_add(read_e_script, NULL);
2526 /* now parse the script */
2528 SETERRNO(0,SS_NORMAL);
2529 if (yyparse(GRAMPROG) || PL_parser->error_count) {
2530 abort_execution("", PL_origfilename);
2532 CopLINE_set(PL_curcop, 0);
2533 SET_CURSTASH(PL_defstash);
2535 SvREFCNT_dec(PL_e_script);
2543 SAVECOPFILE(PL_curcop);
2544 SAVECOPLINE(PL_curcop);
2545 gv_check(PL_defstash);
2555 s = PerlEnv_getenv("PERL_DEBUG_MSTATS");
2556 if (s && grok_atoUV(s, &uv, NULL) && uv >= 2)
2557 dump_mstats("after compilation:");
2562 PL_restartjmpenv = NULL;
2568 =for apidoc perl_run
2570 Tells a Perl interpreter to run its main program. See L<perlembed>
2573 C<my_perl> points to the Perl interpreter. It must have been previously
2574 created through the use of L</perl_alloc> and L</perl_construct>, and
2575 initialised through L</perl_parse>. This function should not be called
2576 if L</perl_parse> returned a non-zero value, indicating a failure in
2577 initialisation or compilation.
2579 This function executes code in C<INIT> blocks, and then executes the
2580 main program. The code to be executed is that established by the prior
2581 call to L</perl_parse>. If the interpreter's C<PL_exit_flags> word
2582 does not have the C<PERL_EXIT_DESTRUCT_END> flag set, then this function
2583 will also execute code in C<END> blocks. If it is desired to make any
2584 further use of the interpreter after calling this function, then C<END>
2585 blocks should be postponed to L</perl_destruct> time by setting that flag.
2587 Returns an integer of slightly tricky interpretation. The correct use
2588 of the return value is as a truth value indicating whether the program
2589 terminated non-locally. If zero is returned, this indicates that
2590 the program ran to completion, and it is safe to make other use of the
2591 interpreter (provided that the C<PERL_EXIT_DESTRUCT_END> flag was set as
2592 described above). If a non-zero value is returned, this indicates that
2593 the interpreter wants to terminate early. The interpreter should not be
2594 just abandoned because of this desire to terminate; the caller should
2595 proceed to shut the interpreter down cleanly with L</perl_destruct>
2596 and free it with L</perl_free>.
2598 For historical reasons, the non-zero return value also attempts to
2599 be a suitable value to pass to the C library function C<exit> (or to
2600 return from C<main>), to serve as an exit code indicating the nature of
2601 the way the program terminated. However, this isn't portable, due to
2602 differing exit code conventions. An attempt is made to return an exit
2603 code of the type required by the host operating system, but because
2604 it is constrained to be non-zero, it is not necessarily possible to
2605 indicate every type of exit. It is only reliable on Unix, where a zero
2606 exit code can be augmented with a set bit that will be ignored. In any
2607 case, this function is not the correct place to acquire an exit code:
2608 one should get that from L</perl_destruct>.
2620 PERL_ARGS_ASSERT_PERL_RUN;
2621 #ifndef MULTIPLICITY
2622 PERL_UNUSED_ARG(my_perl);
2625 oldscope = PL_scopestack_ix;
2633 cxstack_ix = -1; /* start context stack again */
2635 case 0: /* normal completion */
2639 case 2: /* my_exit() */
2640 while (PL_scopestack_ix > oldscope)
2643 SET_CURSTASH(PL_defstash);
2644 if (!(PL_exit_flags & PERL_EXIT_DESTRUCT_END) &&
2645 PL_endav && !PL_minus_c) {
2646 PERL_SET_PHASE(PERL_PHASE_END);
2647 call_list(oldscope, PL_endav);
2650 if (PerlEnv_getenv("PERL_DEBUG_MSTATS"))
2651 dump_mstats("after execution: ");
2657 POPSTACK_TO(PL_mainstack);
2660 PerlIO_printf(Perl_error_log, "panic: restartop in perl_run\n");
2671 S_run_body(pTHX_ I32 oldscope)
2673 DEBUG_r(PerlIO_printf(Perl_debug_log, "%s $` $& $' support (0x%x).\n",
2674 PL_sawampersand ? "Enabling" : "Omitting",
2675 (unsigned int)(PL_sawampersand)));
2677 if (!PL_restartop) {
2679 if (DEBUG_x_TEST || DEBUG_B_TEST)
2680 dump_all_perl(!DEBUG_B_TEST);
2682 PERL_DEBUG(PerlIO_printf(Perl_debug_log, "\nEXECUTING...\n\n"));
2686 PerlIO_printf(Perl_error_log, "%s syntax OK\n", PL_origfilename);
2689 if (PERLDB_SINGLE && PL_DBsingle)
2692 PERL_SET_PHASE(PERL_PHASE_INIT);
2693 call_list(oldscope, PL_initav);
2695 #ifdef PERL_DEBUG_READONLY_OPS
2696 if (PL_main_root && PL_main_root->op_slabbed)
2697 Slab_to_ro(OpSLAB(PL_main_root));
2703 PERL_SET_PHASE(PERL_PHASE_RUN);
2706 PL_restartjmpenv = NULL;
2707 PL_op = PL_restartop;
2711 else if (PL_main_start) {
2712 CvDEPTH(PL_main_cv) = 1;
2713 PL_op = PL_main_start;
2717 NOT_REACHED; /* NOTREACHED */
2721 =head1 SV Manipulation Functions
2725 Returns the SV of the specified Perl scalar. C<flags> are passed to
2726 C<gv_fetchpv>. If C<GV_ADD> is set and the
2727 Perl variable does not exist then it will be created. If C<flags> is zero
2728 and the variable does not exist then NULL is returned.
2734 Perl_get_sv(pTHX_ const char *name, I32 flags)
2738 PERL_ARGS_ASSERT_GET_SV;
2740 gv = gv_fetchpv(name, flags, SVt_PV);
2747 =head1 Array Manipulation Functions
2751 Returns the AV of the specified Perl global or package array with the given
2752 name (so it won't work on lexical variables). C<flags> are passed
2753 to C<gv_fetchpv>. If C<GV_ADD> is set and the
2754 Perl variable does not exist then it will be created. If C<flags> is zero
2755 and the variable does not exist then NULL is returned.
2757 Perl equivalent: C<@{"$name"}>.
2763 Perl_get_av(pTHX_ const char *name, I32 flags)
2765 GV* const gv = gv_fetchpv(name, flags, SVt_PVAV);
2767 PERL_ARGS_ASSERT_GET_AV;
2777 =head1 Hash Manipulation Functions
2781 Returns the HV of the specified Perl hash. C<flags> are passed to
2782 C<gv_fetchpv>. If C<GV_ADD> is set and the
2783 Perl variable does not exist then it will be created. If C<flags> is zero
2784 and the variable does not exist then C<NULL> is returned.
2790 Perl_get_hv(pTHX_ const char *name, I32 flags)
2792 GV* const gv = gv_fetchpv(name, flags, SVt_PVHV);
2794 PERL_ARGS_ASSERT_GET_HV;
2804 =head1 CV Manipulation Functions
2806 =for apidoc get_cvn_flags
2808 Returns the CV of the specified Perl subroutine. C<flags> are passed to
2809 C<gv_fetchpvn_flags>. If C<GV_ADD> is set and the Perl subroutine does not
2810 exist then it will be declared (which has the same effect as saying
2811 C<sub name;>). If C<GV_ADD> is not set and the subroutine does not exist
2812 then NULL is returned.
2816 Uses C<strlen> to get the length of C<name>, then calls C<get_cvn_flags>.
2822 Perl_get_cvn_flags(pTHX_ const char *name, STRLEN len, I32 flags)
2824 GV* const gv = gv_fetchpvn_flags(name, len, flags, SVt_PVCV);
2826 PERL_ARGS_ASSERT_GET_CVN_FLAGS;
2828 if (gv && UNLIKELY(SvROK(gv)) && SvTYPE(SvRV((SV *)gv)) == SVt_PVCV)
2829 return (CV*)SvRV((SV *)gv);
2831 /* XXX this is probably not what they think they're getting.
2832 * It has the same effect as "sub name;", i.e. just a forward
2834 if ((flags & ~GV_NOADD_MASK) && !GvCVu(gv)) {
2835 return newSTUB(gv,0);
2842 /* Nothing in core calls this now, but we can't replace it with a macro and
2843 move it to mathoms.c as a macro would evaluate name twice. */
2845 Perl_get_cv(pTHX_ const char *name, I32 flags)
2847 PERL_ARGS_ASSERT_GET_CV;
2849 return get_cvn_flags(name, strlen(name), flags);
2852 /* Be sure to refetch the stack pointer after calling these routines. */
2856 =head1 Callback Functions
2858 =for apidoc call_argv
2860 Performs a callback to the specified named and package-scoped Perl subroutine
2861 with C<argv> (a C<NULL>-terminated array of strings) as arguments. See
2864 Approximate Perl equivalent: C<&{"$sub_name"}(@$argv)>.
2870 Perl_call_argv(pTHX_ const char *sub_name, I32 flags, char **argv)
2872 /* See G_* flags in cop.h */
2873 /* null terminated arg list */
2877 PERL_ARGS_ASSERT_CALL_ARGV;
2881 mXPUSHs(newSVpv(*argv,0));
2885 return call_pv(sub_name, flags);
2891 Performs a callback to the specified Perl sub. See L<perlcall>.
2897 Perl_call_pv(pTHX_ const char *sub_name, I32 flags)
2898 /* name of the subroutine */
2899 /* See G_* flags in cop.h */
2901 PERL_ARGS_ASSERT_CALL_PV;
2903 return call_sv(MUTABLE_SV(get_cv(sub_name, GV_ADD)), flags);
2907 =for apidoc call_method
2909 Performs a callback to the specified Perl method. The blessed object must
2910 be on the stack. See L<perlcall>.
2916 Perl_call_method(pTHX_ const char *methname, I32 flags)
2917 /* name of the subroutine */
2918 /* See G_* flags in cop.h */
2922 PERL_ARGS_ASSERT_CALL_METHOD;
2924 len = strlen(methname);
2925 sv = flags & G_METHOD_NAMED
2926 ? sv_2mortal(newSVpvn_share(methname, len,0))
2927 : newSVpvn_flags(methname, len, SVs_TEMP);
2929 return call_sv(sv, flags | G_METHOD);
2932 /* May be called with any of a CV, a GV, or an SV containing the name. */
2936 Performs a callback to the Perl sub specified by the SV.
2938 If neither the C<G_METHOD> nor C<G_METHOD_NAMED> flag is supplied, the
2939 SV may be any of a CV, a GV, a reference to a CV, a reference to a GV
2940 or C<SvPV(sv)> will be used as the name of the sub to call.
2942 If the C<G_METHOD> flag is supplied, the SV may be a reference to a CV or
2943 C<SvPV(sv)> will be used as the name of the method to call.
2945 If the C<G_METHOD_NAMED> flag is supplied, C<SvPV(sv)> will be used as
2946 the name of the method to call.
2948 Some other values are treated specially for internal use and should
2953 =for apidoc Amnh||G_METHOD
2954 =for apidoc Amnh||G_METHOD_NAMED
2960 Perl_call_sv(pTHX_ SV *sv, volatile I32 flags)
2961 /* See G_* flags in cop.h */
2964 LOGOP myop; /* fake syntax tree node */
2967 volatile I32 retval = 0;
2968 bool oldcatch = CATCH_GET;
2970 OP* const oldop = PL_op;
2973 PERL_ARGS_ASSERT_CALL_SV;
2975 if (flags & G_DISCARD) {
2979 if (!(flags & G_WANT)) {
2980 /* Backwards compatibility - as G_SCALAR was 0, it could be omitted.
2985 Zero(&myop, 1, LOGOP);
2986 if (!(flags & G_NOARGS))
2987 myop.op_flags |= OPf_STACKED;
2988 myop.op_flags |= OP_GIMME_REVERSE(flags);
2992 if (!(flags & G_METHOD_NAMED)) {
3000 if (PERLDB_SUB && PL_curstash != PL_debstash
3001 /* Handle first BEGIN of -d. */
3002 && (PL_DBcv || (PL_DBcv = GvCV(PL_DBsub)))
3003 /* Try harder, since this may have been a sighandler, thus
3004 * curstash may be meaningless. */
3005 && (SvTYPE(sv) != SVt_PVCV || CvSTASH((const CV *)sv) != PL_debstash)
3006 && !(flags & G_NODEBUG))
3007 myop.op_private |= OPpENTERSUB_DB;
3009 if (flags & (G_METHOD|G_METHOD_NAMED)) {
3010 Zero(&method_op, 1, METHOP);
3011 method_op.op_next = (OP*)&myop;
3012 PL_op = (OP*)&method_op;
3013 if ( flags & G_METHOD_NAMED ) {
3014 method_op.op_ppaddr = PL_ppaddr[OP_METHOD_NAMED];
3015 method_op.op_type = OP_METHOD_NAMED;
3016 method_op.op_u.op_meth_sv = sv;
3018 method_op.op_ppaddr = PL_ppaddr[OP_METHOD];
3019 method_op.op_type = OP_METHOD;
3021 myop.op_ppaddr = PL_ppaddr[OP_ENTERSUB];
3022 myop.op_type = OP_ENTERSUB;
3025 if (!(flags & G_EVAL)) {
3027 CALL_BODY_SUB((OP*)&myop);
3028 retval = PL_stack_sp - (PL_stack_base + oldmark);
3029 CATCH_SET(oldcatch);
3033 myop.op_other = (OP*)&myop;
3035 old_cxix = cxstack_ix;
3036 create_eval_scope(NULL, flags|G_FAKINGEVAL);
3044 CALL_BODY_SUB((OP*)&myop);
3045 retval = PL_stack_sp - (PL_stack_base + oldmark);
3046 if (!(flags & G_KEEPERR)) {
3054 /* my_exit() was called */
3055 SET_CURSTASH(PL_defstash);
3059 NOT_REACHED; /* NOTREACHED */
3062 PL_restartjmpenv = NULL;
3063 PL_op = PL_restartop;
3067 PL_stack_sp = PL_stack_base + oldmark;
3068 if ((flags & G_WANT) == G_ARRAY)
3072 *++PL_stack_sp = &PL_sv_undef;
3077 /* if we croaked, depending on how we croaked the eval scope
3078 * may or may not have already been popped */
3079 if (cxstack_ix > old_cxix) {
3080 assert(cxstack_ix == old_cxix + 1);
3081 assert(CxTYPE(CX_CUR()) == CXt_EVAL);
3082 delete_eval_scope();
3087 if (flags & G_DISCARD) {
3088 PL_stack_sp = PL_stack_base + oldmark;
3097 /* Eval a string. The G_EVAL flag is always assumed. */
3102 Tells Perl to C<eval> the string in the SV. It supports the same flags
3103 as C<call_sv>, with the obvious exception of C<G_EVAL>. See L<perlcall>.
3105 The C<G_RETHROW> flag can be used if you only need eval_sv() to
3106 execute code specified by a string, but not catch any errors.
3112 Perl_eval_sv(pTHX_ SV *sv, I32 flags)
3114 /* See G_* flags in cop.h */
3117 UNOP myop; /* fake syntax tree node */
3118 volatile I32 oldmark;
3119 volatile I32 retval = 0;
3121 OP* const oldop = PL_op;
3124 PERL_ARGS_ASSERT_EVAL_SV;
3126 if (flags & G_DISCARD) {
3133 Zero(&myop, 1, UNOP);
3136 oldmark = SP - PL_stack_base;
3142 if (!(flags & G_NOARGS))
3143 myop.op_flags = OPf_STACKED;
3144 myop.op_type = OP_ENTEREVAL;
3145 myop.op_flags |= OP_GIMME_REVERSE(flags);
3146 if (flags & G_KEEPERR)
3147 myop.op_flags |= OPf_SPECIAL;
3149 if (flags & G_RE_REPARSING)
3150 myop.op_private = (OPpEVAL_COPHH | OPpEVAL_RE_REPARSING);
3152 /* fail now; otherwise we could fail after the JMPENV_PUSH but
3153 * before a cx_pusheval(), which corrupts the stack after a croak */
3154 TAINT_PROPER("eval_sv()");
3160 if (PL_op == (OP*)(&myop)) {
3161 PL_op = PL_ppaddr[OP_ENTEREVAL](aTHX);
3163 goto fail; /* failed in compilation */
3166 retval = PL_stack_sp - (PL_stack_base + oldmark);
3167 if (!(flags & G_KEEPERR)) {
3175 /* my_exit() was called */
3176 SET_CURSTASH(PL_defstash);
3180 NOT_REACHED; /* NOTREACHED */
3183 PL_restartjmpenv = NULL;
3184 PL_op = PL_restartop;
3189 if (flags & G_RETHROW) {
3194 PL_stack_sp = PL_stack_base + oldmark;
3195 if ((flags & G_WANT) == G_ARRAY)
3199 *++PL_stack_sp = &PL_sv_undef;
3205 if (flags & G_DISCARD) {
3206 PL_stack_sp = PL_stack_base + oldmark;
3218 Tells Perl to C<eval> the given string in scalar context and return an SV* result.
3224 Perl_eval_pv(pTHX_ const char *p, I32 croak_on_error)
3226 SV* sv = newSVpv(p, 0);
3228 PERL_ARGS_ASSERT_EVAL_PV;
3230 if (croak_on_error) {
3232 eval_sv(sv, G_SCALAR | G_RETHROW);
3235 eval_sv(sv, G_SCALAR);
3248 /* Require a module. */
3251 =head1 Embedding Functions
3253 =for apidoc require_pv
3255 Tells Perl to C<require> the file named by the string argument. It is
3256 analogous to the Perl code C<eval "require '$file'">. It's even
3257 implemented that way; consider using load_module instead.
3262 Perl_require_pv(pTHX_ const char *pv)
3267 PERL_ARGS_ASSERT_REQUIRE_PV;
3269 PUSHSTACKi(PERLSI_REQUIRE);
3270 sv = Perl_newSVpvf(aTHX_ "require q%c%s%c", 0, pv, 0);
3271 eval_sv(sv_2mortal(sv), G_DISCARD);
3276 S_usage(pTHX) /* XXX move this out into a module ? */
3278 /* This message really ought to be max 23 lines.
3279 * Removed -h because the user already knows that option. Others? */
3281 /* Grouped as 6 lines per C string literal, to keep under the ANSI C 89
3282 minimum of 509 character string literals. */
3283 static const char * const usage_msg[] = {
3284 " -0[octal] specify record separator (\\0, if no argument)\n"
3285 " -a autosplit mode with -n or -p (splits $_ into @F)\n"
3286 " -C[number/list] enables the listed Unicode features\n"
3287 " -c check syntax only (runs BEGIN and CHECK blocks)\n"
3288 " -d[:debugger] run program under debugger\n"
3289 " -D[number/list] set debugging flags (argument is a bit mask or alphabets)\n",
3290 " -e program one line of program (several -e's allowed, omit programfile)\n"
3291 " -E program like -e, but enables all optional features\n"
3292 " -f don't do $sitelib/sitecustomize.pl at startup\n"
3293 " -F/pattern/ split() pattern for -a switch (//'s are optional)\n"
3294 " -i[extension] edit <> files in place (makes backup if extension supplied)\n"
3295 " -Idirectory specify @INC/#include directory (several -I's allowed)\n",
3296 " -l[octal] enable line ending processing, specifies line terminator\n"
3297 " -[mM][-]module execute \"use/no module...\" before executing program\n"
3298 " -n assume \"while (<>) { ... }\" loop around program\n"
3299 " -p assume loop like -n but print line also, like sed\n"
3300 " -s enable rudimentary parsing for switches after programfile\n"
3301 " -S look for programfile using PATH environment variable\n",
3302 " -t enable tainting warnings\n"
3303 " -T enable tainting checks\n"
3304 " -u dump core after parsing program\n"
3305 " -U allow unsafe operations\n"
3306 " -v print version, patchlevel and license\n"
3307 " -V[:variable] print configuration summary (or a single Config.pm variable)\n",
3308 " -w enable many useful warnings\n"
3309 " -W enable all warnings\n"
3310 " -x[directory] ignore text before #!perl line (optionally cd to directory)\n"
3311 " -X disable all warnings\n"
3313 "Run 'perldoc perl' for more help with Perl.\n\n",
3316 const char * const *p = usage_msg;
3317 PerlIO *out = PerlIO_stdout();
3320 "\nUsage: %s [switches] [--] [programfile] [arguments]\n",
3323 PerlIO_puts(out, *p++);
3327 /* convert a string of -D options (or digits) into an int.
3328 * sets *s to point to the char after the options */
3332 Perl_get_debug_opts(pTHX_ const char **s, bool givehelp)
3334 static const char * const usage_msgd[] = {
3335 " Debugging flag values: (see also -d)\n"
3336 " p Tokenizing and parsing (with v, displays parse stack)\n"
3337 " s Stack snapshots (with v, displays all stacks)\n"
3338 " l Context (loop) stack processing\n"
3339 " t Trace execution\n"
3340 " o Method and overloading resolution\n",
3341 " c String/numeric conversions\n"
3342 " P Print profiling info, source file input state\n"
3343 " m Memory and SV allocation\n"
3344 " f Format processing\n"
3345 " r Regular expression parsing and execution\n"
3346 " x Syntax tree dump\n",
3347 " u Tainting checks\n"
3348 " H Hash dump -- usurps values()\n"
3349 " X Scratchpad allocation\n"
3351 " S Op slab allocation\n"
3353 " R Include reference counts of dumped variables (eg when using -Ds)\n",
3354 " J Do not s,t,P-debug (Jump over) opcodes within package DB\n"
3355 " v Verbose: use in conjunction with other flags\n"
3356 " C Copy On Write\n"
3357 " A Consistency checks on internal structures\n"
3358 " q quiet - currently only suppresses the 'EXECUTING' message\n"
3359 " M trace smart match resolution\n"
3360 " B dump suBroutine definitions, including special Blocks like BEGIN\n",
3361 " L trace some locale setting information--for Perl core development\n",
3362 " i trace PerlIO layer processing\n",
3367 PERL_ARGS_ASSERT_GET_DEBUG_OPTS;
3370 /* if adding extra options, remember to update DEBUG_MASK */
3371 static const char debopts[] = "psltocPmfrxuUHXDSTRJvCAqMBLi";
3373 for (; isWORDCHAR(**s); (*s)++) {
3374 const char * const d = strchr(debopts,**s);
3376 uv |= 1 << (d - debopts);
3377 else if (ckWARN_d(WARN_DEBUGGING))
3378 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3379 "invalid option -D%c, use -D'' to see choices\n", **s);
3382 else if (isDIGIT(**s)) {
3383 const char* e = *s + strlen(*s);
3384 if (grok_atoUV(*s, &uv, &e))
3386 for (; isWORDCHAR(**s); (*s)++) ;
3388 else if (givehelp) {
3389 const char *const *p = usage_msgd;
3390 while (*p) PerlIO_puts(PerlIO_stdout(), *p++);
3392 return (int)uv; /* ignore any UV->int conversion loss */
3396 /* This routine handles any switches that can be given during run */
3399 Perl_moreswitches(pTHX_ const char *s)
3403 const char option = *s; /* used to remember option in -m/-M code */
3405 PERL_ARGS_ASSERT_MORESWITCHES;
3413 SvREFCNT_dec(PL_rs);
3414 if (s[1] == 'x' && s[2]) {
3415 const char *e = s+=2;
3421 flags = PERL_SCAN_SILENT_ILLDIGIT;
3422 rschar = (U32)grok_hex(s, &numlen, &flags, NULL);
3423 if (s + numlen < e) {
3424 rschar = 0; /* Grandfather -0xFOO as -0 -xFOO. */
3428 PL_rs = newSVpvs("");
3429 tmps = (U8*) SvGROW(PL_rs, (STRLEN)(UVCHR_SKIP(rschar) + 1));
3430 uvchr_to_utf8(tmps, rschar);
3431 SvCUR_set(PL_rs, UVCHR_SKIP(rschar));
3436 rschar = (U32)grok_oct(s, &numlen, &flags, NULL);
3437 if (rschar & ~((U8)~0))
3438 PL_rs = &PL_sv_undef;
3439 else if (!rschar && numlen >= 2)
3440 PL_rs = newSVpvs("");
3442 char ch = (char)rschar;
3443 PL_rs = newSVpvn(&ch, 1);
3446 sv_setsv(get_sv("/", GV_ADD), PL_rs);
3451 PL_unicode = parse_unicode_opts( (const char **)&s );
3452 if (PL_unicode & PERL_UNICODE_UTF8CACHEASSERT_FLAG)
3460 while (*s && !isSPACE(*s)) ++s;
3461 PL_splitstr = savepvn(PL_splitstr, s - PL_splitstr);
3473 forbid_setid('d', FALSE);
3476 /* -dt indicates to the debugger that threads will be used */
3477 if (*s == 't' && !isWORDCHAR(s[1])) {
3479 my_setenv("PERL5DB_THREADED", "1");
3482 /* The following permits -d:Mod to accepts arguments following an =
3483 in the fashion that -MSome::Mod does. */
3484 if (*s == ':' || *s == '=') {
3491 sv = newSVpvs("no Devel::");
3493 sv = newSVpvs("use Devel::");
3497 end = s + strlen(s);
3499 /* We now allow -d:Module=Foo,Bar and -d:-Module */
3500 while(isWORDCHAR(*s) || *s==':') ++s;
3502 sv_catpvn(sv, start, end - start);
3504 sv_catpvn(sv, start, s-start);
3505 /* Don't use NUL as q// delimiter here, this string goes in the
3507 Perl_sv_catpvf(aTHX_ sv, " split(/,/,q{%s});", ++s);
3510 my_setenv("PERL5DB", SvPV_nolen_const(sv));
3514 PL_perldb = PERLDB_ALL;
3521 forbid_setid('D', FALSE);
3523 PL_debug = get_debug_opts( (const char **)&s, 1) | DEBUG_TOP_FLAG;
3524 #else /* !DEBUGGING */
3525 if (ckWARN_d(WARN_DEBUGGING))
3526 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3527 "Recompile perl with -DDEBUGGING to use -D switch (did you mean -d ?)\n");
3528 for (s++; isWORDCHAR(*s); s++) ;
3531 NOT_REACHED; /* NOTREACHED */
3535 NOT_REACHED; /* NOTREACHED */
3538 Safefree(PL_inplace);
3540 const char * const start = ++s;
3541 while (*s && !isSPACE(*s))
3544 PL_inplace = savepvn(start, s - start);
3547 case 'I': /* -I handled both here and in parse_body() */
3548 forbid_setid('I', FALSE);
3550 while (*s && isSPACE(*s))
3555 /* ignore trailing spaces (possibly followed by other switches) */
3557 for (e = p; *e && !isSPACE(*e); e++) ;
3561 } while (*p && *p != '-');
3563 INCPUSH_ADD_SUB_DIRS|INCPUSH_ADD_OLD_VERS|INCPUSH_UNSHIFT);
3569 Perl_croak(aTHX_ "No directory specified for -I");
3575 SvREFCNT_dec(PL_ors_sv);
3581 PL_ors_sv = newSVpvs("\n");
3582 numlen = 3 + (*s == '0');
3583 *SvPVX(PL_ors_sv) = (char)grok_oct(s, &numlen, &flags, NULL);
3587 if (RsPARA(PL_rs)) {
3588 PL_ors_sv = newSVpvs("\n\n");
3591 PL_ors_sv = newSVsv(PL_rs);
3596 forbid_setid('M', FALSE); /* XXX ? */
3599 forbid_setid('m', FALSE); /* XXX ? */
3604 const char *use = "use ";
3606 /* -M-foo == 'no foo' */
3607 /* Leading space on " no " is deliberate, to make both
3608 possibilities the same length. */
3609 if (*s == '-') { use = " no "; ++s; }
3610 sv = newSVpvn(use,4);
3612 /* We allow -M'Module qw(Foo Bar)' */
3613 while(isWORDCHAR(*s) || *s==':') {
3622 Perl_croak(aTHX_ "Module name required with -%c option",
3625 Perl_croak(aTHX_ "Invalid module name %.*s with -%c option: "
3626 "contains single ':'",
3627 (int)(s - start), start, option);
3628 end = s + strlen(s);
3630 sv_catpvn(sv, start, end - start);
3631 if (option == 'm') {
3633 Perl_croak(aTHX_ "Can't use '%c' after -mname", *s);
3634 sv_catpvs( sv, " ()");
3637 sv_catpvn(sv, start, s-start);
3638 /* Use NUL as q''-delimiter. */
3639 sv_catpvs(sv, " split(/,/,q\0");
3641 sv_catpvn(sv, s, end - s);
3642 sv_catpvs(sv, "\0)");
3645 Perl_av_create_and_push(aTHX_ &PL_preambleav, sv);
3648 Perl_croak(aTHX_ "Missing argument to -%c", option);
3659 forbid_setid('s', FALSE);
3660 PL_doswitches = TRUE;
3665 #if defined(SILENT_NO_TAINT_SUPPORT)
3666 /* silently ignore */
3667 #elif defined(NO_TAINT_SUPPORT)
3668 Perl_croak_nocontext("This perl was compiled without taint support. "
3669 "Cowardly refusing to run with -t or -T flags");
3677 PL_do_undump = TRUE;
3687 if (! (PL_dowarn & G_WARN_ALL_MASK)) {
3688 PL_dowarn |= G_WARN_ON;
3693 PL_dowarn = G_WARN_ALL_ON|G_WARN_ON;
3694 if (!specialWARN(PL_compiling.cop_warnings))
3695 PerlMemShared_free(PL_compiling.cop_warnings);
3696 PL_compiling.cop_warnings = pWARN_ALL ;
3700 PL_dowarn = G_WARN_ALL_OFF;
3701 if (!specialWARN(PL_compiling.cop_warnings))
3702 PerlMemShared_free(PL_compiling.cop_warnings);
3703 PL_compiling.cop_warnings = pWARN_NONE ;
3710 if (s[0] == '-') /* Additional switches on #! line. */
3715 #if defined(WIN32) || !defined(PERL_STRICT_CR)
3721 #ifdef ALTERNATE_SHEBANG
3722 case 'S': /* OS/2 needs -S on "extproc" line. */
3725 case 'e': case 'f': case 'x': case 'E':
3726 #ifndef ALTERNATE_SHEBANG
3730 Perl_croak(aTHX_ "Can't emulate -%.1s on #! line",s);
3733 "Unrecognized switch: -%.1s (-h will show valid options)",s
3743 PerlIO * PIO_stdout;
3745 const char * const level_str = "v" PERL_VERSION_STRING;
3746 const STRLEN level_len = sizeof("v" PERL_VERSION_STRING)-1;
3747 #ifdef PERL_PATCHNUM
3749 # ifdef PERL_GIT_UNCOMMITTED_CHANGES
3750 static const char num [] = PERL_PATCHNUM "*";
3752 static const char num [] = PERL_PATCHNUM;
3755 const STRLEN num_len = sizeof(num)-1;
3756 /* A very advanced compiler would fold away the strnEQ
3757 and this whole conditional, but most (all?) won't do it.
3758 SV level could also be replaced by with preprocessor
3761 if (num_len >= level_len && strnEQ(num,level_str,level_len)) {
3762 /* per 46807d8e80, PERL_PATCHNUM is outside of the control
3763 of the interp so it might contain format characters
3765 level = newSVpvn(num, num_len);
3767 level = Perl_newSVpvf_nocontext("%s (%s)", level_str, num);
3771 SV* level = newSVpvn(level_str, level_len);
3772 #endif /* #ifdef PERL_PATCHNUM */
3773 PIO_stdout = PerlIO_stdout();
3774 PerlIO_printf(PIO_stdout,
3775 "\nThis is perl " STRINGIFY(PERL_REVISION)
3776 ", version " STRINGIFY(PERL_VERSION)
3777 ", subversion " STRINGIFY(PERL_SUBVERSION)
3778 " (%" SVf ") built for " ARCHNAME, SVfARG(level)
3780 SvREFCNT_dec_NN(level);
3782 #if defined(LOCAL_PATCH_COUNT)
3783 if (LOCAL_PATCH_COUNT > 0)
3784 PerlIO_printf(PIO_stdout,
3785 "\n(with %d registered patch%s, "
3786 "see perl -V for more detail)",
3788 (LOCAL_PATCH_COUNT!=1) ? "es" : "");
3791 PerlIO_printf(PIO_stdout,
3792 "\n\nCopyright 1987-2019, Larry Wall\n");
3794 PerlIO_printf(PIO_stdout,
3795 "\nMS-DOS port Copyright (c) 1989, 1990, Diomidis Spinellis\n");
3798 PerlIO_printf(PIO_stdout,
3799 "djgpp v2 port (jpl5003c) by Hirofumi Watanabe, 1996\n"
3800 "djgpp v2 port (perl5004+) by Laszlo Molnar, 1997-1999\n");
3803 PerlIO_printf(PIO_stdout,
3804 "\n\nOS/2 port Copyright (c) 1990, 1991, Raymond Chen, Kai Uwe Rommel\n"
3805 "Version 5 port Copyright (c) 1994-2002, Andreas Kaiser, Ilya Zakharevich\n");
3808 PerlIO_printf(PIO_stdout,
3809 "MVS (OS390) port by Mortice Kern Systems, 1997-1999\n");
3812 PerlIO_printf(PIO_stdout,
3813 "Stratus OpenVOS port by Paul.Green@stratus.com, 1997-2013\n");
3816 PerlIO_printf(PIO_stdout,
3817 "BS2000 (POSIX) port by Start Amadeus GmbH, 1998-1999\n");
3819 #ifdef __SYMBIAN32__
3820 PerlIO_printf(PIO_stdout,
3821 "Symbian port by Nokia, 2004-2005\n");
3823 #ifdef BINARY_BUILD_NOTICE
3824 BINARY_BUILD_NOTICE;
3826 PerlIO_printf(PIO_stdout,
3828 Perl may be copied only under the terms of either the Artistic License or the\n\
3829 GNU General Public License, which may be found in the Perl 5 source kit.\n\n\
3830 Complete documentation for Perl, including FAQ lists, should be found on\n\
3831 this system using \"man perl\" or \"perldoc perl\". If you have access to the\n\
3832 Internet, point your browser at http://www.perl.org/, the Perl Home Page.\n\n");
3836 /* compliments of Tom Christiansen */
3838 /* unexec() can be found in the Gnu emacs distribution */
3839 /* Known to work with -DUNEXEC and using unexelf.c from GNU emacs-20.2 */
3842 #include <lib$routines.h>
3846 Perl_my_unexec(pTHX)
3849 SV * prog = newSVpv(BIN_EXP, 0);
3850 SV * file = newSVpv(PL_origfilename, 0);
3854 sv_catpvs(prog, "/perl");
3855 sv_catpvs(file, ".perldump");
3857 unexec(SvPVX(file), SvPVX(prog), &etext, sbrk(0), 0);
3858 /* unexec prints msg to stderr in case of failure */
3859 PerlProc_exit(status);
3861 PERL_UNUSED_CONTEXT;
3863 lib$signal(SS$_DEBUG); /* ssdef.h #included from vmsish.h */
3864 # elif defined(WIN32) || defined(__CYGWIN__)
3865 Perl_croak_nocontext("dump is not supported");
3867 ABORT(); /* for use with undump */
3872 /* initialize curinterp */
3877 # define PERLVAR(prefix,var,type)
3878 # define PERLVARA(prefix,var,n,type)
3879 # if defined(PERL_IMPLICIT_CONTEXT)
3880 # define PERLVARI(prefix,var,type,init) aTHX->prefix##var = init;
3881 # define PERLVARIC(prefix,var,type,init) aTHX->prefix##var = init;
3883 # define PERLVARI(prefix,var,type,init) PERL_GET_INTERP->var = init;
3884 # define PERLVARIC(prefix,var,type,init) PERL_GET_INTERP->var = init;
3886 # include "intrpvar.h"
3892 # define PERLVAR(prefix,var,type)
3893 # define PERLVARA(prefix,var,n,type)
3894 # define PERLVARI(prefix,var,type,init) PL_##var = init;
3895 # define PERLVARIC(prefix,var,type,init) PL_##var = init;
3896 # include "intrpvar.h"
3906 S_init_main_stash(pTHX)
3911 PL_curstash = PL_defstash = (HV *)SvREFCNT_inc_simple_NN(hv);
3912 /* We know that the string "main" will be in the global shared string
3913 table, so it's a small saving to use it rather than allocate another
3915 PL_curstname = newSVpvs_share("main");
3916 gv = gv_fetchpvs("main::", GV_ADD|GV_NOTQUAL, SVt_PVHV);
3917 /* If we hadn't caused another reference to "main" to be in the shared
3918 string table above, then it would be worth reordering these two,
3919 because otherwise all we do is delete "main" from it as a consequence
3920 of the SvREFCNT_dec, only to add it again with hv_name_set */
3921 SvREFCNT_dec(GvHV(gv));
3922 hv_name_sets(PL_defstash, "main", 0);
3923 GvHV(gv) = MUTABLE_HV(SvREFCNT_inc_simple(PL_defstash));
3925 PL_incgv = gv_HVadd(gv_AVadd(gv_fetchpvs("INC", GV_ADD|GV_NOTQUAL,
3927 SvREFCNT_inc_simple_void(PL_incgv); /* Don't allow it to be freed */
3928 GvMULTI_on(PL_incgv);
3929 PL_hintgv = gv_fetchpvs("\010", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^H */
3930 SvREFCNT_inc_simple_void(PL_hintgv);
3931 GvMULTI_on(PL_hintgv);
3932 PL_defgv = gv_fetchpvs("_", GV_ADD|GV_NOTQUAL, SVt_PVAV);
3933 SvREFCNT_inc_simple_void(PL_defgv);
3934 PL_errgv = gv_fetchpvs("@", GV_ADD|GV_NOTQUAL, SVt_PV);
3935 SvREFCNT_inc_simple_void(PL_errgv);
3936 GvMULTI_on(PL_errgv);
3937 PL_replgv = gv_fetchpvs("\022", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^R */
3938 SvREFCNT_inc_simple_void(PL_replgv);
3939 GvMULTI_on(PL_replgv);
3940 (void)Perl_form(aTHX_ "%240s",""); /* Preallocate temp - for immediate signals. */
3941 #ifdef PERL_DONT_CREATE_GVSV
3942 (void)gv_SVadd(PL_errgv);
3944 sv_grow(ERRSV, 240); /* Preallocate - for immediate signals. */
3946 CopSTASH_set(&PL_compiling, PL_defstash);
3947 PL_debstash = GvHV(gv_fetchpvs("DB::", GV_ADDMULTI, SVt_PVHV));
3948 PL_globalstash = GvHV(gv_fetchpvs("CORE::GLOBAL::", GV_ADDMULTI,
3950 /* We must init $/ before switches are processed. */
3951 sv_setpvs(get_sv("/", GV_ADD), "\n");
3955 S_open_script(pTHX_ const char *scriptname, bool dosearch, bool *suidscript)
3958 PerlIO *rsfp = NULL;
3962 PERL_ARGS_ASSERT_OPEN_SCRIPT;
3965 PL_origfilename = savepvs("-e");
3970 /* if find_script() returns, it returns a malloc()-ed value */
3971 scriptname = PL_origfilename = find_script(scriptname, dosearch, NULL, 1);
3972 s = scriptname + strlen(scriptname);
3974 if (strBEGINs(scriptname, "/dev/fd/")
3975 && isDIGIT(scriptname[8])
3976 && grok_atoUV(scriptname + 8, &uv, &s)
3977 && uv <= PERL_INT_MAX
3982 * Tell apart "normal" usage of fdscript, e.g.
3983 * with bash on FreeBSD:
3984 * perl <( echo '#!perl -DA'; echo 'print "$0\n"')
3985 * from usage in suidperl.
3986 * Does any "normal" usage leave garbage after the number???
3987 * Is it a mistake to use a similar /dev/fd/ construct for
3992 * Be supersafe and do some sanity-checks.
3993 * Still, can we be sure we got the right thing?
3996 Perl_croak(aTHX_ "Wrong syntax (suid) fd script name \"%s\"\n", s);
3999 Perl_croak(aTHX_ "Missing (suid) fd script name\n");
4001 scriptname = savepv(s + 1);
4002 Safefree(PL_origfilename);
4003 PL_origfilename = (char *)scriptname;
4008 CopFILE_free(PL_curcop);
4009 CopFILE_set(PL_curcop, PL_origfilename);
4010 if (*PL_origfilename == '-' && PL_origfilename[1] == '\0')
4011 scriptname = (char *)"";
4012 if (fdscript >= 0) {
4013 rsfp = PerlIO_fdopen(fdscript,PERL_SCRIPT_MODE);
4015 else if (!*scriptname) {
4016 forbid_setid(0, *suidscript);
4020 #ifdef FAKE_BIT_BUCKET
4021 /* This hack allows one not to have /dev/null (or BIT_BUCKET as it
4022 * is called) and still have the "-e" work. (Believe it or not,
4023 * a /dev/null is required for the "-e" to work because source
4024 * filter magic is used to implement it. ) This is *not* a general
4025 * replacement for a /dev/null. What we do here is create a temp
4026 * file (an empty file), open up that as the script, and then
4027 * immediately close and unlink it. Close enough for jazz. */
4028 #define FAKE_BIT_BUCKET_PREFIX "/tmp/perlnull-"
4029 #define FAKE_BIT_BUCKET_SUFFIX "XXXXXXXX"
4030 #define FAKE_BIT_BUCKET_TEMPLATE FAKE_BIT_BUCKET_PREFIX FAKE_BIT_BUCKET_SUFFIX
4031 char tmpname[sizeof(FAKE_BIT_BUCKET_TEMPLATE)] = {
4032 FAKE_BIT_BUCKET_TEMPLATE
4034 const char * const err = "Failed to create a fake bit bucket";
4035 if (strEQ(scriptname, BIT_BUCKET)) {
4036 int tmpfd = Perl_my_mkstemp_cloexec(tmpname);
4038 scriptname = tmpname;
4041 Perl_croak(aTHX_ err);
4044 rsfp = PerlIO_open(scriptname,PERL_SCRIPT_MODE);
4045 #ifdef FAKE_BIT_BUCKET
4046 if ( strBEGINs(scriptname, FAKE_BIT_BUCKET_PREFIX)
4047 && strlen(scriptname) == sizeof(tmpname) - 1)
4051 scriptname = BIT_BUCKET;
4055 /* PSz 16 Sep 03 Keep neat error message */
4057 Perl_croak(aTHX_ "Can't open " BIT_BUCKET ": %s\n", Strerror(errno));
4059 Perl_croak(aTHX_ "Can't open perl script \"%s\": %s\n",
4060 CopFILE(PL_curcop), Strerror(errno));
4062 fd = PerlIO_fileno(rsfp);
4065 (PerlLIO_fstat(fd, &tmpstatbuf) >= 0
4066 && S_ISDIR(tmpstatbuf.st_mode)))
4067 Perl_croak(aTHX_ "Can't open perl script \"%s\": %s\n",
4074 /* In the days of suidperl, we refused to execute a setuid script stored on
4075 * a filesystem mounted nosuid and/or noexec. This meant that we probed for the
4076 * existence of the appropriate filesystem-statting function, and behaved
4077 * accordingly. But even though suidperl is long gone, we must still include
4078 * those probes for the benefit of modules like Filesys::Df, which expect the
4079 * results of those probes to be stored in %Config; see RT#126368. So mention
4080 * the relevant cpp symbols here, to ensure that metaconfig will include their
4081 * probes in the generated Configure:
4083 * I_SYSSTATVFS HAS_FSTATVFS
4085 * I_STATFS HAS_FSTATFS HAS_GETFSSTAT
4086 * I_MNTENT HAS_GETMNTENT HAS_HASMNTOPT
4090 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
4091 /* Don't even need this function. */
4094 S_validate_suid(pTHX_ PerlIO *rsfp)
4096 const Uid_t my_uid = PerlProc_getuid();
4097 const Uid_t my_euid = PerlProc_geteuid();
4098 const Gid_t my_gid = PerlProc_getgid();
4099 const Gid_t my_egid = PerlProc_getegid();
4101 PERL_ARGS_ASSERT_VALIDATE_SUID;
4103 if (my_euid != my_uid || my_egid != my_gid) { /* (suidperl doesn't exist, in fact) */
4105 int fd = PerlIO_fileno(rsfp);
4107 if (fd < 0 || PerlLIO_fstat(fd, &statbuf) < 0) { /* may be either wrapped or real suid */
4108 Perl_croak_nocontext( "Illegal suidscript");
4110 if ((my_euid != my_uid && my_euid == statbuf.st_uid && statbuf.st_mode & S_ISUID)
4112 (my_egid != my_gid && my_egid == statbuf.st_gid && statbuf.st_mode & S_ISGID)
4115 Perl_croak(aTHX_ "YOU HAVEN'T DISABLED SET-ID SCRIPTS IN THE KERNEL YET!\n\
4116 FIX YOUR KERNEL, PUT A C WRAPPER AROUND THIS SCRIPT, OR USE -u AND UNDUMP!\n");
4117 /* not set-id, must be wrapped */
4120 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4123 S_find_beginning(pTHX_ SV* linestr_sv, PerlIO *rsfp)
4128 PERL_ARGS_ASSERT_FIND_BEGINNING;
4130 /* skip forward in input to the real script? */
4133 if ((s = sv_gets(linestr_sv, rsfp, 0)) == NULL)
4134 Perl_croak(aTHX_ "No Perl script found in input\n");
4136 } while (!(*s == '#' && s[1] == '!' && ((s = instr(s,"perl")) || (s = instr(s2,"PERL")))));
4137 PerlIO_ungetc(rsfp, '\n'); /* to keep line count right */
4138 while (*s && !(isSPACE (*s) || *s == '#')) s++;
4140 while (*s == ' ' || *s == '\t') s++;
4142 while (isDIGIT(s2[-1]) || s2[-1] == '-' || s2[-1] == '.'
4143 || s2[-1] == '_') s2--;
4144 if (strBEGINs(s2-4,"perl"))
4145 while ((s = moreswitches(s)))
4154 /* no need to do anything here any more if we don't
4156 #ifndef NO_TAINT_SUPPORT
4157 const Uid_t my_uid = PerlProc_getuid();
4158 const Uid_t my_euid = PerlProc_geteuid();
4159 const Gid_t my_gid = PerlProc_getgid();
4160 const Gid_t my_egid = PerlProc_getegid();
4162 PERL_UNUSED_CONTEXT;
4164 /* Should not happen: */
4165 CHECK_MALLOC_TAINT(my_uid && (my_euid != my_uid || my_egid != my_gid));
4166 TAINTING_set( TAINTING_get | (my_uid && (my_euid != my_uid || my_egid != my_gid)) );
4170 * Should go by suidscript, not uid!=euid: why disallow
4171 * system("ls") in scripts run from setuid things?
4172 * Or, is this run before we check arguments and set suidscript?
4173 * What about SETUID_SCRIPTS_ARE_SECURE_NOW: could we use fdscript then?
4174 * (We never have suidscript, can we be sure to have fdscript?)
4175 * Or must then go by UID checks? See comments in forbid_setid also.
4179 /* This is used very early in the lifetime of the program,
4180 * before even the options are parsed, so PL_tainting has
4181 * not been initialized properly. */
4183 Perl_doing_taint(int argc, char *argv[], char *envp[])
4185 #ifndef PERL_IMPLICIT_SYS
4186 /* If we have PERL_IMPLICIT_SYS we can't call getuid() et alia
4187 * before we have an interpreter-- and the whole point of this
4188 * function is to be called at such an early stage. If you are on
4189 * a system with PERL_IMPLICIT_SYS but you do have a concept of
4190 * "tainted because running with altered effective ids', you'll
4191 * have to add your own checks somewhere in here. The two most
4192 * known samples of 'implicitness' are Win32 and NetWare, neither
4193 * of which has much of concept of 'uids'. */
4194 Uid_t uid = PerlProc_getuid();
4195 Uid_t euid = PerlProc_geteuid();
4196 Gid_t gid = PerlProc_getgid();
4197 Gid_t egid = PerlProc_getegid();
4204 if (uid && (euid != uid || egid != gid))
4206 #endif /* !PERL_IMPLICIT_SYS */
4207 /* This is a really primitive check; environment gets ignored only
4208 * if -T are the first chars together; otherwise one gets
4209 * "Too late" message. */
4210 if ( argc > 1 && argv[1][0] == '-'
4211 && isALPHA_FOLD_EQ(argv[1][1], 't'))
4216 /* Passing the flag as a single char rather than a string is a slight space
4217 optimisation. The only message that isn't /^-.$/ is
4218 "program input from stdin", which is substituted in place of '\0', which
4219 could never be a command line flag. */
4221 S_forbid_setid(pTHX_ const char flag, const bool suidscript) /* g */
4223 char string[3] = "-x";
4224 const char *message = "program input from stdin";
4226 PERL_UNUSED_CONTEXT;
4232 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
4233 if (PerlProc_getuid() != PerlProc_geteuid())
4234 Perl_croak(aTHX_ "No %s allowed while running setuid", message);
4235 if (PerlProc_getgid() != PerlProc_getegid())
4236 Perl_croak(aTHX_ "No %s allowed while running setgid", message);
4237 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4239 Perl_croak(aTHX_ "No %s allowed with (suid) fdscript", message);
4243 Perl_init_dbargs(pTHX)
4245 AV *const args = PL_dbargs = GvAV(gv_AVadd((gv_fetchpvs("DB::args",
4250 /* Someone has already created it.
4251 It might have entries, and if we just turn off AvREAL(), they will
4252 "leak" until global destruction. */
4254 if (SvTIED_mg((const SV *)args, PERL_MAGIC_tied))
4255 Perl_croak(aTHX_ "Cannot set tied @DB::args");
4257 AvREIFY_only(PL_dbargs);
4261 Perl_init_debugger(pTHX)
4263 HV * const ostash = PL_curstash;
4266 PL_curstash = (HV *)SvREFCNT_inc_simple(PL_debstash);
4268 Perl_init_dbargs(aTHX);
4269 PL_DBgv = MUTABLE_GV(
4270 SvREFCNT_inc(gv_fetchpvs("DB::DB", GV_ADDMULTI, SVt_PVGV))
4272 PL_DBline = MUTABLE_GV(
4273 SvREFCNT_inc(gv_fetchpvs("DB::dbline", GV_ADDMULTI, SVt_PVAV))
4275 PL_DBsub = MUTABLE_GV(SvREFCNT_inc(
4276 gv_HVadd(gv_fetchpvs("DB::sub", GV_ADDMULTI, SVt_PVHV))
4278 PL_DBsingle = GvSV((gv_fetchpvs("DB::single", GV_ADDMULTI, SVt_PV)));
4279 if (!SvIOK(PL_DBsingle))
4280 sv_setiv(PL_DBsingle, 0);
4281 mg = sv_magicext(PL_DBsingle, NULL, PERL_MAGIC_debugvar, &PL_vtbl_debugvar, 0, 0);
4282 mg->mg_private = DBVARMG_SINGLE;
4283 SvSETMAGIC(PL_DBsingle);
4285 PL_DBtrace = GvSV((gv_fetchpvs("DB::trace", GV_ADDMULTI, SVt_PV)));
4286 if (!SvIOK(PL_DBtrace))
4287 sv_setiv(PL_DBtrace, 0);
4288 mg = sv_magicext(PL_DBtrace, NULL, PERL_MAGIC_debugvar, &PL_vtbl_debugvar, 0, 0);
4289 mg->mg_private = DBVARMG_TRACE;
4290 SvSETMAGIC(PL_DBtrace);
4292 PL_DBsignal = GvSV((gv_fetchpvs("DB::signal", GV_ADDMULTI, SVt_PV)));
4293 if (!SvIOK(PL_DBsignal))
4294 sv_setiv(PL_DBsignal, 0);
4295 mg = sv_magicext(PL_DBsignal, NULL, PERL_MAGIC_debugvar, &PL_vtbl_debugvar, 0, 0);
4296 mg->mg_private = DBVARMG_SIGNAL;
4297 SvSETMAGIC(PL_DBsignal);
4299 SvREFCNT_dec(PL_curstash);
4300 PL_curstash = ostash;
4303 #ifndef STRESS_REALLOC
4304 #define REASONABLE(size) (size)
4305 #define REASONABLE_but_at_least(size,min) (size)
4307 #define REASONABLE(size) (1) /* unreasonable */
4308 #define REASONABLE_but_at_least(size,min) (min)
4312 Perl_init_stacks(pTHX)
4316 /* start with 128-item stack and 8K cxstack */
4317 PL_curstackinfo = new_stackinfo(REASONABLE(128),
4318 REASONABLE(8192/sizeof(PERL_CONTEXT) - 1));
4319 PL_curstackinfo->si_type = PERLSI_MAIN;
4320 #if defined DEBUGGING && !defined DEBUGGING_RE_ONLY
4321 PL_curstackinfo->si_stack_hwm = 0;
4323 PL_curstack = PL_curstackinfo->si_stack;
4324 PL_mainstack = PL_curstack; /* remember in case we switch stacks */
4326 PL_stack_base = AvARRAY(PL_curstack);
4327 PL_stack_sp = PL_stack_base;
4328 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
4330 Newx(PL_tmps_stack,REASONABLE(128),SV*);
4333 PL_tmps_max = REASONABLE(128);
4335 Newx(PL_markstack,REASONABLE(32),I32);
4336 PL_markstack_ptr = PL_markstack;
4337 PL_markstack_max = PL_markstack + REASONABLE(32);
4341 Newx(PL_scopestack,REASONABLE(32),I32);
4343 Newx(PL_scopestack_name,REASONABLE(32),const char*);
4345 PL_scopestack_ix = 0;
4346 PL_scopestack_max = REASONABLE(32);
4348 size = REASONABLE_but_at_least(128,SS_MAXPUSH);
4349 Newx(PL_savestack, size, ANY);
4350 PL_savestack_ix = 0;
4351 /*PL_savestack_max lies: it always has SS_MAXPUSH more than it claims */
4352 PL_savestack_max = size - SS_MAXPUSH;
4360 while (PL_curstackinfo->si_next)
4361 PL_curstackinfo = PL_curstackinfo->si_next;
4362 while (PL_curstackinfo) {
4363 PERL_SI *p = PL_curstackinfo->si_prev;
4364 /* curstackinfo->si_stack got nuked by sv_free_arenas() */
4365 Safefree(PL_curstackinfo->si_cxstack);
4366 Safefree(PL_curstackinfo);
4367 PL_curstackinfo = p;
4369 Safefree(PL_tmps_stack);
4370 Safefree(PL_markstack);
4371 Safefree(PL_scopestack);
4373 Safefree(PL_scopestack_name);
4375 Safefree(PL_savestack);
4379 Perl_populate_isa(pTHX_ const char *name, STRLEN len, ...)
4381 GV *const gv = gv_fetchpvn(name, len, GV_ADD | GV_ADDMULTI, SVt_PVAV);
4382 AV *const isa = GvAVn(gv);
4385 PERL_ARGS_ASSERT_POPULATE_ISA;
4387 if(AvFILLp(isa) != -1)
4390 /* NOTE: No support for tied ISA */
4392 va_start(args, len);
4394 const char *const parent = va_arg(args, const char*);
4399 parent_len = va_arg(args, size_t);
4401 /* Arguments are supplied with a trailing :: */
4402 assert(parent_len > 2);
4403 assert(parent[parent_len - 1] == ':');
4404 assert(parent[parent_len - 2] == ':');
4405 av_push(isa, newSVpvn(parent, parent_len - 2));
4406 (void) gv_fetchpvn(parent, parent_len, GV_ADD, SVt_PVGV);
4413 S_init_predump_symbols(pTHX)
4418 sv_setpvs(get_sv("\"", GV_ADD), " ");
4419 PL_ofsgv = (GV*)SvREFCNT_inc(gv_fetchpvs(",", GV_ADD|GV_NOTQUAL, SVt_PV));
4422 /* Historically, PVIOs were blessed into IO::Handle, unless
4423 FileHandle was loaded, in which case they were blessed into
4424 that. Action at a distance.
4425 However, if we simply bless into IO::Handle, we break code
4426 that assumes that PVIOs will have (among others) a seek
4427 method. IO::File inherits from IO::Handle and IO::Seekable,
4428 and provides the needed methods. But if we simply bless into
4429 it, then we break code that assumed that by loading
4430 IO::Handle, *it* would work.
4431 So a compromise is to set up the correct @IO::File::ISA,
4432 so that code that does C<use IO::Handle>; will still work.
4435 Perl_populate_isa(aTHX_ STR_WITH_LEN("IO::File::ISA"),
4436 STR_WITH_LEN("IO::Handle::"),
4437 STR_WITH_LEN("IO::Seekable::"),
4438 STR_WITH_LEN("Exporter::"),
4441 PL_stdingv = gv_fetchpvs("STDIN", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4442 GvMULTI_on(PL_stdingv);
4443 io = GvIOp(PL_stdingv);
4444 IoTYPE(io) = IoTYPE_RDONLY;
4445 IoIFP(io) = PerlIO_stdin();
4446 tmpgv = gv_fetchpvs("stdin", GV_ADD|GV_NOTQUAL, SVt_PV);
4448 GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4450 tmpgv = gv_fetchpvs("STDOUT", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4453 IoTYPE(io) = IoTYPE_WRONLY;
4454 IoOFP(io) = IoIFP(io) = PerlIO_stdout();
4456 tmpgv = gv_fetchpvs("stdout", GV_ADD|GV_NOTQUAL, SVt_PV);
4458 GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4460 PL_stderrgv = gv_fetchpvs("STDERR", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4461 GvMULTI_on(PL_stderrgv);
4462 io = GvIOp(PL_stderrgv);
4463 IoTYPE(io) = IoTYPE_WRONLY;
4464 IoOFP(io) = IoIFP(io) = PerlIO_stderr();
4465 tmpgv = gv_fetchpvs("stderr", GV_ADD|GV_NOTQUAL, SVt_PV);
4467 GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4469 PL_statname = newSVpvs(""); /* last filename we did stat on */
4473 Perl_init_argv_symbols(pTHX_ int argc, char **argv)
4475 PERL_ARGS_ASSERT_INIT_ARGV_SYMBOLS;
4477 argc--,argv++; /* skip name of script */
4478 if (PL_doswitches) {
4479 for (; argc > 0 && **argv == '-'; argc--,argv++) {
4483 if (argv[0][1] == '-' && !argv[0][2]) {
4487 if ((s = strchr(argv[0], '='))) {
4488 const char *const start_name = argv[0] + 1;
4489 sv_setpv(GvSV(gv_fetchpvn_flags(start_name, s - start_name,
4490 TRUE, SVt_PV)), s + 1);
4493 sv_setiv(GvSV(gv_fetchpv(argv[0]+1, GV_ADD, SVt_PV)),1);
4496 if ((PL_argvgv = gv_fetchpvs("ARGV", GV_ADD|GV_NOTQUAL, SVt_PVAV))) {
4497 SvREFCNT_inc_simple_void_NN(PL_argvgv);
4498 GvMULTI_on(PL_argvgv);
4499 av_clear(GvAVn(PL_argvgv));
4500 for (; argc > 0; argc--,argv++) {
4501 SV * const sv = newSVpv(argv[0],0);
4502 av_push(GvAV(PL_argvgv),sv);
4503 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
4504 if (PL_unicode & PERL_UNICODE_ARGV_FLAG)
4507 if (PL_unicode & PERL_UNICODE_WIDESYSCALLS_FLAG) /* Sarathy? */
4508 (void)sv_utf8_decode(sv);
4512 if (PL_inplace && (!PL_argvgv || AvFILL(GvAV(PL_argvgv)) == -1))
4513 Perl_ck_warner_d(aTHX_ packWARN(WARN_INPLACE),
4514 "-i used with no filenames on the command line, "
4515 "reading from STDIN");
4519 S_init_postdump_symbols(pTHX_ int argc, char **argv, char **env)
4526 PERL_ARGS_ASSERT_INIT_POSTDUMP_SYMBOLS;
4528 PL_toptarget = newSV_type(SVt_PVIV);
4529 SvPVCLEAR(PL_toptarget);
4530 PL_bodytarget = newSV_type(SVt_PVIV);
4531 SvPVCLEAR(PL_bodytarget);
4532 PL_formtarget = PL_bodytarget;
4536 init_argv_symbols(argc,argv);
4538 if ((tmpgv = gv_fetchpvs("0", GV_ADD|GV_NOTQUAL, SVt_PV))) {
4539 sv_setpv(GvSV(tmpgv),PL_origfilename);
4541 if ((PL_envgv = gv_fetchpvs("ENV", GV_ADD|GV_NOTQUAL, SVt_PVHV))) {
4543 bool env_is_not_environ;
4544 SvREFCNT_inc_simple_void_NN(PL_envgv);
4545 GvMULTI_on(PL_envgv);
4546 hv = GvHVn(PL_envgv);
4547 hv_magic(hv, NULL, PERL_MAGIC_env);
4549 #ifdef USE_ENVIRON_ARRAY
4550 /* Note that if the supplied env parameter is actually a copy
4551 of the global environ then it may now point to free'd memory
4552 if the environment has been modified since. To avoid this
4553 problem we treat env==NULL as meaning 'use the default'
4557 env_is_not_environ = env != environ;
4558 if (env_is_not_environ
4559 # ifdef USE_ITHREADS
4560 && PL_curinterp == aTHX
4572 for (; *env; env++) {
4575 if (!(s = strchr(old_var,'=')) || s == old_var)
4579 #if defined(MSDOS) && !defined(DJGPP)
4581 (void)strupr(old_var);
4584 if (hv_exists(hv, old_var, nlen)) {
4585 const char *name = savepvn(old_var, nlen);
4587 /* make sure we use the same value as getenv(), otherwise code that
4588 uses getenv() (like setlocale()) might see a different value to %ENV
4590 sv = newSVpv(PerlEnv_getenv(name), 0);
4592 /* keep a count of the dups of this name so we can de-dup environ later */
4593 if (hv_exists(dups, name, nlen))
4594 ++SvIVX(*hv_fetch(dups, name, nlen, 0));
4596 (void)hv_store(dups, name, nlen, newSViv(1), 0);
4601 sv = newSVpv(s+1, 0);
4603 (void)hv_store(hv, old_var, nlen, sv, 0);
4604 if (env_is_not_environ)
4608 /* environ has some duplicate definitions, remove them */
4611 while ((entry = hv_iternext_flags(dups, 0))) {
4613 const char *name = HePV(entry, nlen);
4614 IV count = SvIV(HeVAL(entry));
4616 SV **valp = hv_fetch(hv, name, nlen, 0);
4620 /* try to remove any duplicate names, depending on the
4621 * implementation used in my_setenv() the iteration might
4622 * not be necessary, but let's be safe.
4624 for (i = 0; i < count; ++i)
4627 /* and set it back to the value we set $ENV{name} to */
4628 my_setenv(name, SvPV_nolen(*valp));
4631 SvREFCNT_dec_NN(dups);
4633 #endif /* USE_ENVIRON_ARRAY */
4634 #endif /* !PERL_MICRO */
4638 /* touch @F array to prevent spurious warnings 20020415 MJD */
4640 (void) get_av("main::F", GV_ADD | GV_ADDMULTI);
4645 S_init_perllib(pTHX)
4648 const char *perl5lib = NULL;
4651 #if defined(WIN32) && !defined(PERL_IS_MINIPERL)
4655 if (!TAINTING_get) {
4657 perl5lib = PerlEnv_getenv("PERL5LIB");
4659 * It isn't possible to delete an environment variable with
4660 * PERL_USE_SAFE_PUTENV set unless unsetenv() is also available, so in that
4661 * case we treat PERL5LIB as undefined if it has a zero-length value.
4663 #if defined(PERL_USE_SAFE_PUTENV) && ! defined(HAS_UNSETENV)
4664 if (perl5lib && *perl5lib != '\0')
4668 incpush_use_sep(perl5lib, 0, INCPUSH_ADD_SUB_DIRS);
4670 s = PerlEnv_getenv("PERLLIB");
4672 incpush_use_sep(s, 0, 0);
4675 /* Treat PERL5?LIB as a possible search list logical name -- the
4676 * "natural" VMS idiom for a Unix path string. We allow each
4677 * element to be a set of |-separated directories for compatibility.
4681 if (vmstrnenv("PERL5LIB",buf,0,NULL,0))
4683 incpush_use_sep(buf, 0, INCPUSH_ADD_SUB_DIRS);
4684 } while (vmstrnenv("PERL5LIB",buf,++idx,NULL,0));
4686 while (vmstrnenv("PERLLIB",buf,idx++,NULL,0))
4687 incpush_use_sep(buf, 0, 0);
4692 #ifndef PERL_IS_MINIPERL
4693 /* miniperl gets just -I..., the split of $ENV{PERL5LIB}, and "." in @INC
4694 (and not the architecture specific directories from $ENV{PERL5LIB}) */
4696 #include "perl_inc_macro.h"
4697 /* Use the ~-expanded versions of APPLLIB (undocumented),
4698 SITEARCH, SITELIB, VENDORARCH, VENDORLIB, ARCHLIB and PRIVLIB
4701 INCPUSH_SITEARCH_EXP
4703 INCPUSH_PERL_VENDORARCH_EXP
4704 INCPUSH_PERL_VENDORLIB_EXP
4707 INCPUSH_PERL_OTHERLIBDIRS
4709 INCPUSH_APPLLIB_OLD_EXP
4710 INCPUSH_SITELIB_STEM
4711 INCPUSH_PERL_VENDORLIB_STEM
4712 INCPUSH_PERL_OTHERLIBDIRS_ARCHONLY
4714 #endif /* !PERL_IS_MINIPERL */
4716 if (!TAINTING_get) {
4717 #if !defined(PERL_IS_MINIPERL) && defined(DEFAULT_INC_EXCLUDES_DOT)
4718 const char * const unsafe = PerlEnv_getenv("PERL_USE_UNSAFE_INC");
4719 if (unsafe && strEQ(unsafe, "1"))
4721 S_incpush(aTHX_ STR_WITH_LEN("."), 0);
4725 #if defined(DOSISH) || defined(__SYMBIAN32__)
4726 # define PERLLIB_SEP ';'
4727 #elif defined(__VMS)
4728 # define PERLLIB_SEP PL_perllib_sep
4730 # define PERLLIB_SEP ':'
4732 #ifndef PERLLIB_MANGLE
4733 # define PERLLIB_MANGLE(s,n) (s)
4736 #ifndef PERL_IS_MINIPERL
4737 /* Push a directory onto @INC if it exists.
4738 Generate a new SV if we do this, to save needing to copy the SV we push
4741 S_incpush_if_exists(pTHX_ AV *const av, SV *dir, SV *const stem)
4745 PERL_ARGS_ASSERT_INCPUSH_IF_EXISTS;
4747 if (PerlLIO_stat(SvPVX_const(dir), &tmpstatbuf) >= 0 &&
4748 S_ISDIR(tmpstatbuf.st_mode)) {
4750 dir = newSVsv(stem);
4752 /* Truncate dir back to stem. */
4753 SvCUR_set(dir, SvCUR(stem));
4760 S_mayberelocate(pTHX_ const char *const dir, STRLEN len, U32 flags)
4762 const U8 canrelocate = (U8)flags & INCPUSH_CAN_RELOCATE;
4765 PERL_ARGS_ASSERT_MAYBERELOCATE;
4768 /* I am not convinced that this is valid when PERLLIB_MANGLE is
4769 defined to so something (in os2/os2.c), but the code has been
4770 this way, ignoring any possible changed of length, since
4771 760ac839baf413929cd31cc32ffd6dba6b781a81 (5.003_02) so I'll leave
4773 libdir = newSVpvn(PERLLIB_MANGLE(dir, len), len);
4779 if ((unix = tounixspec_ts(SvPV(libdir,len),NULL)) != NULL) {
4781 while (len > 1 && unix[len-1] == '/') len--; /* Cosmetic */
4782 sv_usepvn(libdir,unix,len);
4785 PerlIO_printf(Perl_error_log,
4786 "Failed to unixify @INC element \"%s\"\n",
4787 SvPV_nolen_const(libdir));
4791 /* Do the if() outside the #ifdef to avoid warnings about an unused
4794 #ifdef PERL_RELOCATABLE_INC
4796 * Relocatable include entries are marked with a leading .../
4799 * 0: Remove that leading ".../"
4800 * 1: Remove trailing executable name (anything after the last '/')
4801 * from the perl path to give a perl prefix
4803 * While the @INC element starts "../" and the prefix ends with a real
4804 * directory (ie not . or ..) chop that real directory off the prefix
4805 * and the leading "../" from the @INC element. ie a logical "../"
4807 * Finally concatenate the prefix and the remainder of the @INC element
4808 * The intent is that /usr/local/bin/perl and .../../lib/perl5
4809 * generates /usr/local/lib/perl5
4811 const char *libpath = SvPVX(libdir);
4812 STRLEN libpath_len = SvCUR(libdir);
4813 if (memBEGINs(libpath, libpath_len, ".../")) {
4815 SV * const caret_X = get_sv("\030", 0);
4816 /* Going to use the SV just as a scratch buffer holding a C
4822 /* $^X is *the* source of taint if tainting is on, hence
4823 SvPOK() won't be true. */
4825 assert(SvPOKp(caret_X));
4826 prefix_sv = newSVpvn_flags(SvPVX(caret_X), SvCUR(caret_X),
4828 /* Firstly take off the leading .../
4829 If all else fail we'll do the paths relative to the current
4831 sv_chop(libdir, libpath + 4);
4832 /* Don't use SvPV as we're intentionally bypassing taining,
4833 mortal copies that the mg_get of tainting creates, and
4834 corruption that seems to come via the save stack.
4835 I guess that the save stack isn't correctly set up yet. */
4836 libpath = SvPVX(libdir);
4837 libpath_len = SvCUR(libdir);
4839 prefix = SvPVX(prefix_sv);
4840 lastslash = (char *) my_memrchr(prefix, '/',