4 * Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001
5 * 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
6 * 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 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 perl_construct(pTHXx)
224 PERL_ARGS_ASSERT_PERL_CONSTRUCT;
228 PL_perl_destruct_level = 1;
230 PERL_UNUSED_ARG(my_perl);
231 if (PL_perl_destruct_level > 0)
234 PL_curcop = &PL_compiling; /* needed by ckWARN, right away */
236 #ifdef PERL_TRACE_OPS
237 Zero(PL_op_exec_cnt, OP_max+2, UV);
242 SvREADONLY_on(&PL_sv_placeholder);
243 SvREFCNT(&PL_sv_placeholder) = SvREFCNT_IMMORTAL;
245 PL_sighandlerp = Perl_sighandler;
246 PL_sighandler1p = Perl_sighandler1;
247 PL_sighandler3p = Perl_sighandler3;
249 #ifdef PERL_USES_PL_PIDSTATUS
250 PL_pidstatus = newHV();
253 PL_rs = newSVpvs("\n");
257 /* The PERL_INTERNAL_RAND_SEED set-up must be after init_stacks because it calls
258 * things that may put SVs on the stack.
261 #ifdef NO_PERL_INTERNAL_RAND_SEED
262 Perl_drand48_init_r(&PL_internal_random_state, seed());
267 if (PerlProc_getuid() != PerlProc_geteuid() ||
268 PerlProc_getgid() != PerlProc_getegid() ||
269 !(env_pv = PerlEnv_getenv("PERL_INTERNAL_RAND_SEED")) ||
270 grok_number(env_pv, strlen(env_pv), &seed) != IS_NUMBER_IN_UV) {
273 Perl_drand48_init_r(&PL_internal_random_state, (U32)seed);
283 (void) uvchr_to_utf8_flags((U8 *) PL_TR_SPECIAL_HANDLING_UTF8,
285 UNICODE_ALLOW_ABOVE_IV_MAX);
287 #if defined(LOCAL_PATCH_COUNT)
288 PL_localpatches = local_patches; /* For possible -v */
291 #if defined(LIBM_LIB_VERSION)
293 * Some BSDs and Cygwin default to POSIX math instead of IEEE.
294 * This switches them over to IEEE.
296 _LIB_VERSION = _IEEE_;
299 #ifdef HAVE_INTERP_INTERN
303 PerlIO_init(aTHX); /* Hook to IO system */
305 PL_fdpid = newAV(); /* for remembering popen pids by fd */
306 PL_modglobal = newHV(); /* pointers to per-interpreter module globals */
307 PL_errors = newSVpvs("");
308 SvPVCLEAR(PERL_DEBUG_PAD(0)); /* For regex debugging. */
309 SvPVCLEAR(PERL_DEBUG_PAD(1)); /* ext/re needs these */
310 SvPVCLEAR(PERL_DEBUG_PAD(2)); /* even without DEBUGGING. */
312 /* First entry is a list of empty elements. It needs to be initialised
313 else all hell breaks loose in S_find_uninit_var(). */
314 Perl_av_create_and_push(aTHX_ &PL_regex_padav, newSVpvs(""));
315 PL_regex_pad = AvARRAY(PL_regex_padav);
316 Newxz(PL_stashpad, PL_stashpadmax, HV *);
318 #ifdef USE_REENTRANT_API
319 Perl_reentrant_init(aTHX);
321 if (PL_hash_seed_set == FALSE) {
322 /* Initialize the hash seed and state at startup. This must be
323 * done very early, before ANY hashes are constructed, and once
324 * setup is fixed for the lifetime of the process.
326 * If you decide to disable the seeding process you should choose
327 * a suitable seed yourself and define PERL_HASH_SEED to a well chosen
328 * string. See hv_func.h for details.
330 #if defined(USE_HASH_SEED)
331 /* get the hash seed from the environment or from an RNG */
332 Perl_get_hash_seed(aTHX_ PL_hash_seed);
334 /* they want a hard coded seed, check that it is long enough */
335 assert( strlen(PERL_HASH_SEED) >= PERL_HASH_SEED_BYTES );
338 /* now we use the chosen seed to initialize the state -
339 * in some configurations this may be a relatively speaking
340 * expensive operation, but we only have to do it once at startup */
341 PERL_HASH_SEED_STATE(PERL_HASH_SEED,PL_hash_state);
343 #ifdef PERL_USE_SINGLE_CHAR_HASH_CACHE
344 /* we can build a special cache for 0/1 byte keys, if people choose
345 * I suspect most of the time it is not worth it */
349 for (i=0;i<256;i++) {
351 PERL_HASH_WITH_STATE(PL_hash_state,PL_hash_chars[i],str,1);
353 PERL_HASH_WITH_STATE(PL_hash_state,PL_hash_chars[256],str,0);
356 /* at this point we have initialezed the hash function, and we can start
357 * constructing hashes */
358 PL_hash_seed_set= TRUE;
361 /* Allow PL_strtab to be pre-initialized before calling perl_construct.
362 * can use a custom optimized PL_strtab hash before calling perl_construct */
364 /* Note that strtab is a rather special HV. Assumptions are made
365 about not iterating on it, and not adding tie magic to it.
366 It is properly deallocated in perl_destruct() */
369 /* SHAREKEYS tells us that the hash has its keys shared with PL_strtab,
370 * which is not the case with PL_strtab itself */
371 HvSHAREKEYS_off(PL_strtab); /* mandatory */
372 hv_ksplit(PL_strtab, 1 << 11);
375 Zero(PL_sv_consts, SV_CONSTS_COUNT, SV*);
378 # ifdef USE_ENVIRON_ARRAY
379 PL_origenviron = environ;
383 /* Use sysconf(_SC_CLK_TCK) if available, if not
384 * available or if the sysconf() fails, use the HZ.
385 * The HZ if not originally defined has been by now
386 * been defined as CLK_TCK, if available. */
387 #if defined(HAS_SYSCONF) && defined(_SC_CLK_TCK)
388 PL_clocktick = sysconf(_SC_CLK_TCK);
389 if (PL_clocktick <= 0)
393 PL_stashcache = newHV();
395 PL_patchlevel = newSVpvs("v" PERL_VERSION_STRING);
398 if (!PL_mmap_page_size) {
399 #if defined(HAS_SYSCONF) && (defined(_SC_PAGESIZE) || defined(_SC_MMAP_PAGE_SIZE))
401 SETERRNO(0, SS_NORMAL);
403 PL_mmap_page_size = sysconf(_SC_PAGESIZE);
405 PL_mmap_page_size = sysconf(_SC_MMAP_PAGE_SIZE);
407 if ((long) PL_mmap_page_size < 0) {
408 Perl_croak(aTHX_ "panic: sysconf: %s",
409 errno ? Strerror(errno) : "pagesize unknown");
412 #elif defined(HAS_GETPAGESIZE)
413 PL_mmap_page_size = getpagesize();
414 #elif defined(I_SYS_PARAM) && defined(PAGESIZE)
415 PL_mmap_page_size = PAGESIZE; /* compiletime, bad */
417 if (PL_mmap_page_size <= 0)
418 Perl_croak(aTHX_ "panic: bad pagesize %" IVdf,
419 (IV) PL_mmap_page_size);
421 #endif /* HAS_MMAP */
423 #if defined(HAS_TIMES) && defined(PERL_NEED_TIMESBASE)
424 PL_timesbase.tms_utime = 0;
425 PL_timesbase.tms_stime = 0;
426 PL_timesbase.tms_cutime = 0;
427 PL_timesbase.tms_cstime = 0;
430 PL_osname = Perl_savepvn(aTHX_ STR_WITH_LEN(OSNAME));
432 PL_registered_mros = newHV();
433 /* Start with 1 bucket, for DFS. It's unlikely we'll need more. */
434 HvMAX(PL_registered_mros) = 0;
436 #ifdef USE_POSIX_2008_LOCALE
437 PL_C_locale_obj = newlocale(LC_ALL_MASK, "C", NULL);
445 =for apidoc nothreadhook
447 Stub that provides thread hook for perl_destruct when there are
454 Perl_nothreadhook(pTHX)
460 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
462 Perl_dump_sv_child(pTHX_ SV *sv)
465 const int sock = PL_dumper_fd;
466 const int debug_fd = PerlIO_fileno(Perl_debug_log);
467 union control_un control;
470 struct cmsghdr *cmptr;
472 unsigned char buffer[256];
474 PERL_ARGS_ASSERT_DUMP_SV_CHILD;
476 if(sock == -1 || debug_fd == -1)
479 PerlIO_flush(Perl_debug_log);
481 /* All these shenanigans are to pass a file descriptor over to our child for
482 it to dump out to. We can't let it hold open the file descriptor when it
483 forks, as the file descriptor it will dump to can turn out to be one end
484 of pipe that some other process will wait on for EOF. (So as it would
485 be open, the wait would be forever.) */
487 msg.msg_control = control.control;
488 msg.msg_controllen = sizeof(control.control);
489 /* We're a connected socket so we don't need a destination */
495 cmptr = CMSG_FIRSTHDR(&msg);
496 cmptr->cmsg_len = CMSG_LEN(sizeof(int));
497 cmptr->cmsg_level = SOL_SOCKET;
498 cmptr->cmsg_type = SCM_RIGHTS;
499 *((int *)CMSG_DATA(cmptr)) = 1;
501 vec[0].iov_base = (void*)&sv;
502 vec[0].iov_len = sizeof(sv);
503 got = sendmsg(sock, &msg, 0);
506 perror("Debug leaking scalars parent sendmsg failed");
509 if(got < sizeof(sv)) {
510 perror("Debug leaking scalars parent short sendmsg");
514 /* Return protocol is
516 unsigned char: length of location string (0 for empty)
517 unsigned char*: string (not terminated)
519 vec[0].iov_base = (void*)&returned_errno;
520 vec[0].iov_len = sizeof(returned_errno);
521 vec[1].iov_base = buffer;
524 got = readv(sock, vec, 2);
527 perror("Debug leaking scalars parent read failed");
528 PerlIO_flush(PerlIO_stderr());
531 if(got < sizeof(returned_errno) + 1) {
532 perror("Debug leaking scalars parent short read");
533 PerlIO_flush(PerlIO_stderr());
538 got = read(sock, buffer + 1, *buffer);
540 perror("Debug leaking scalars parent read 2 failed");
541 PerlIO_flush(PerlIO_stderr());
546 perror("Debug leaking scalars parent short read 2");
547 PerlIO_flush(PerlIO_stderr());
552 if (returned_errno || *buffer) {
553 Perl_warn(aTHX_ "Debug leaking scalars child failed%s%.*s with errno"
554 " %d: %s", (*buffer ? " at " : ""), (int) *buffer, buffer + 1,
555 returned_errno, Strerror(returned_errno));
561 =for apidoc perl_destruct
563 Shuts down a Perl interpreter. See L<perlembed> for a tutorial.
565 C<my_perl> points to the Perl interpreter. It must have been previously
566 created through the use of L</perl_alloc> and L</perl_construct>. It may
567 have been initialised through L</perl_parse>, and may have been used
568 through L</perl_run> and other means. This function should be called for
569 any Perl interpreter that has been constructed with L</perl_construct>,
570 even if subsequent operations on it failed, for example if L</perl_parse>
571 returned a non-zero value.
573 If the interpreter's C<PL_exit_flags> word has the
574 C<PERL_EXIT_DESTRUCT_END> flag set, then this function will execute code
575 in C<END> blocks before performing the rest of destruction. If it is
576 desired to make any use of the interpreter between L</perl_parse> and
577 L</perl_destruct> other than just calling L</perl_run>, then this flag
578 should be set early on. This matters if L</perl_run> will not be called,
579 or if anything else will be done in addition to calling L</perl_run>.
581 Returns a value be a suitable value to pass to the C library function
582 C<exit> (or to return from C<main>), to serve as an exit code indicating
583 the nature of the way the interpreter terminated. This takes into account
584 any failure of L</perl_parse> and any early exit from L</perl_run>.
585 The exit code is of the type required by the host operating system,
586 so because of differing exit code conventions it is not portable to
587 interpret specific numeric values as having specific meanings.
596 volatile signed char destruct_level; /* see possible values in intrpvar.h */
598 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
603 PERL_ARGS_ASSERT_PERL_DESTRUCT;
605 PERL_UNUSED_ARG(my_perl);
608 assert(PL_scopestack_ix == 1);
610 /* wait for all pseudo-forked children to finish */
611 PERL_WAIT_FOR_CHILDREN;
613 destruct_level = PL_perl_destruct_level;
615 const char * const s = PerlEnv_getenv("PERL_DESTRUCT_LEVEL");
618 if (strEQ(s, "-1")) { /* Special case: modperl folklore. */
622 if (grok_atoUV(s, &uv, NULL) && uv <= INT_MAX)
627 if (destruct_level < i) destruct_level = i;
628 #ifdef PERL_TRACK_MEMPOOL
629 /* RT #114496, for perl_free */
630 PL_perl_destruct_level = i;
635 if (PL_exit_flags & PERL_EXIT_DESTRUCT_END) {
641 if (PL_endav && !PL_minus_c) {
642 PERL_SET_PHASE(PERL_PHASE_END);
643 call_list(PL_scopestack_ix, PL_endav);
649 assert(PL_scopestack_ix == 0);
651 /* normally when we get here, PL_parser should be null due to having
652 * its original (null) value restored by SAVEt_PARSER during leaving
653 * scope (usually before run-time starts in fact).
654 * But if a thread is created within a BEGIN block, the parser is
655 * duped, but the SAVEt_PARSER savestack entry isn't. So PL_parser
656 * never gets cleaned up.
657 * Clean it up here instead. This is a bit of a hack.
660 /* stop parser_free() stomping on PL_curcop */
661 PL_parser->saved_curcop = PL_curcop;
662 parser_free(PL_parser);
666 /* Need to flush since END blocks can produce output */
667 /* flush stdout separately, since we can identify it */
670 PerlIO *stdo = PerlIO_stdout();
671 if (*stdo && PerlIO_flush(stdo)) {
672 PerlIO_restore_errno(stdo);
674 PerlIO_printf(PerlIO_stderr(), "Unable to flush stdout: %s\n",
683 #ifdef PERL_TRACE_OPS
684 /* dump OP-counts if $ENV{PERL_TRACE_OPS} > 0 */
686 const char * const ptoenv = PerlEnv_getenv("PERL_TRACE_OPS");
689 if (!ptoenv || !Perl_grok_atoUV(ptoenv, &uv, NULL)
693 PerlIO_printf(Perl_debug_log, "Trace of all OPs executed:\n");
694 for (i = 0; i <= OP_max; ++i) {
695 if (PL_op_exec_cnt[i])
696 PerlIO_printf(Perl_debug_log, " %s: %" UVuf "\n", PL_op_name[i], PL_op_exec_cnt[i]);
698 /* Utility slot for easily doing little tracing experiments in the runloop: */
699 if (PL_op_exec_cnt[OP_max+1] != 0)
700 PerlIO_printf(Perl_debug_log, " SPECIAL: %" UVuf "\n", PL_op_exec_cnt[OP_max+1]);
701 PerlIO_printf(Perl_debug_log, "\n");
706 if (PL_threadhook(aTHX)) {
707 /* Threads hook has vetoed further cleanup */
708 PL_veto_cleanup = TRUE;
712 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
713 if (destruct_level != 0) {
714 /* Fork here to create a child. Our child's job is to preserve the
715 state of scalars prior to destruction, so that we can instruct it
716 to dump any scalars that we later find have leaked.
717 There's no subtlety in this code - it assumes POSIX, and it doesn't
721 if(PerlSock_socketpair_cloexec(AF_UNIX, SOCK_STREAM, 0, fd)) {
722 perror("Debug leaking scalars socketpair failed");
728 perror("Debug leaking scalars fork failed");
732 /* We are the child */
733 const int sock = fd[1];
734 const int debug_fd = PerlIO_fileno(Perl_debug_log);
737 /* Our success message is an integer 0, and a char 0 */
738 static const char success[sizeof(int) + 1] = {0};
742 /* We need to close all other file descriptors otherwise we end up
743 with interesting hangs, where the parent closes its end of a
744 pipe, and sits waiting for (another) child to terminate. Only
745 that child never terminates, because it never gets EOF, because
746 we also have the far end of the pipe open. We even need to
747 close the debugging fd, because sometimes it happens to be one
748 end of a pipe, and a process is waiting on the other end for
749 EOF. Normally it would be closed at some point earlier in
750 destruction, but if we happen to cause the pipe to remain open,
751 EOF never occurs, and we get an infinite hang. Hence all the
752 games to pass in a file descriptor if it's actually needed. */
754 f = sysconf(_SC_OPEN_MAX);
756 where = "sysconf failed";
767 union control_un control;
770 struct cmsghdr *cmptr;
774 msg.msg_control = control.control;
775 msg.msg_controllen = sizeof(control.control);
776 /* We're a connected socket so we don't need a source */
780 msg.msg_iovlen = C_ARRAY_LENGTH(vec);
782 vec[0].iov_base = (void*)⌖
783 vec[0].iov_len = sizeof(target);
785 got = recvmsg(sock, &msg, 0);
790 where = "recv failed";
793 if(got < sizeof(target)) {
794 where = "short recv";
798 if(!(cmptr = CMSG_FIRSTHDR(&msg))) {
802 if(cmptr->cmsg_len != CMSG_LEN(sizeof(int))) {
803 where = "wrong cmsg_len";
806 if(cmptr->cmsg_level != SOL_SOCKET) {
807 where = "wrong cmsg_level";
810 if(cmptr->cmsg_type != SCM_RIGHTS) {
811 where = "wrong cmsg_type";
815 got_fd = *(int*)CMSG_DATA(cmptr);
816 /* For our last little bit of trickery, put the file descriptor
817 back into Perl_debug_log, as if we never actually closed it
819 if(got_fd != debug_fd) {
820 if (PerlLIO_dup2_cloexec(got_fd, debug_fd) == -1) {
827 PerlIO_flush(Perl_debug_log);
829 got = write(sock, &success, sizeof(success));
832 where = "write failed";
835 if(got < sizeof(success)) {
836 where = "short write";
843 int send_errno = errno;
844 unsigned char length = (unsigned char) strlen(where);
845 struct iovec failure[3] = {
846 {(void*)&send_errno, sizeof(send_errno)},
848 {(void*)where, length}
850 int got = writev(sock, failure, 3);
851 /* Bad news travels fast. Faster than data. We'll get a SIGPIPE
852 in the parent if we try to read from the socketpair after the
853 child has exited, even if there was data to read.
854 So sleep a bit to give the parent a fighting chance of
857 _exit((got == -1) ? errno : 0);
861 PL_dumper_fd = fd[0];
866 /* We must account for everything. */
868 /* Destroy the main CV and syntax tree */
869 /* Set PL_curcop now, because destroying ops can cause new SVs
870 to be generated in Perl_pad_swipe, and when running with
871 -DDEBUG_LEAKING_SCALARS they expect PL_curcop to point to a valid
872 op from which the filename structure member is copied. */
873 PL_curcop = &PL_compiling;
875 /* ensure comppad/curpad to refer to main's pad */
876 if (CvPADLIST(PL_main_cv)) {
877 PAD_SET_CUR_NOSAVE(CvPADLIST(PL_main_cv), 1);
878 PL_comppad_name = PadlistNAMES(CvPADLIST(PL_main_cv));
880 op_free(PL_main_root);
883 PL_main_start = NULL;
884 /* note that PL_main_cv isn't usually actually freed at this point,
885 * due to the CvOUTSIDE refs from subs compiled within it. It will
886 * get freed once all the subs are freed in sv_clean_all(), for
887 * destruct_level > 0 */
888 SvREFCNT_dec(PL_main_cv);
890 PERL_SET_PHASE(PERL_PHASE_DESTRUCT);
892 /* Tell PerlIO we are about to tear things apart in case
893 we have layers which are using resources that should
897 PerlIO_destruct(aTHX);
900 * Try to destruct global references. We do this first so that the
901 * destructors and destructees still exist. Some sv's might remain.
902 * Non-referenced objects are on their own.
906 /* unhook hooks which will soon be, or use, destroyed data */
907 SvREFCNT_dec(PL_warnhook);
909 SvREFCNT_dec(PL_diehook);
912 /* call exit list functions */
913 while (PL_exitlistlen-- > 0)
914 PL_exitlist[PL_exitlistlen].fn(aTHX_ PL_exitlist[PL_exitlistlen].ptr);
916 Safefree(PL_exitlist);
921 SvREFCNT_dec(PL_registered_mros);
923 /* jettison our possibly duplicated environment */
924 /* if PERL_USE_SAFE_PUTENV is defined environ will not have been copied
925 * so we certainly shouldn't free it here
928 #if defined(USE_ENVIRON_ARRAY) && !defined(PERL_USE_SAFE_PUTENV)
929 if (environ != PL_origenviron && !PL_use_safe_putenv
931 /* only main thread can free environ[0] contents */
932 && PL_curinterp == aTHX
938 for (i = 0; environ[i]; i++)
939 safesysfree(environ[i]);
941 /* Must use safesysfree() when working with environ. */
942 safesysfree(environ);
944 environ = PL_origenviron;
947 #endif /* !PERL_MICRO */
949 if (destruct_level == 0) {
951 DEBUG_P(debprofdump());
953 #if defined(PERLIO_LAYERS)
954 /* No more IO - including error messages ! */
955 PerlIO_cleanup(aTHX);
958 CopFILE_free(&PL_compiling);
960 /* The exit() function will do everything that needs doing. */
964 /* Below, do clean up for when PERL_DESTRUCT_LEVEL is not 0 */
967 /* the syntax tree is shared between clones
968 * so op_free(PL_main_root) only ReREFCNT_dec's
969 * REGEXPs in the parent interpreter
970 * we need to manually ReREFCNT_dec for the clones
973 I32 i = AvFILLp(PL_regex_padav);
974 SV **ary = AvARRAY(PL_regex_padav);
977 SvREFCNT_dec(ary[i]);
978 ary[i] = &PL_sv_undef;
984 SvREFCNT_dec(MUTABLE_SV(PL_stashcache));
985 PL_stashcache = NULL;
987 /* loosen bonds of global variables */
989 /* XXX can PL_parser still be non-null here? */
990 if(PL_parser && PL_parser->rsfp) {
991 (void)PerlIO_close(PL_parser->rsfp);
992 PL_parser->rsfp = NULL;
996 Safefree(PL_splitstr);
1006 PL_doswitches = FALSE;
1007 PL_dowarn = G_WARN_OFF;
1008 #ifdef PERL_SAWAMPERSAND
1009 PL_sawampersand = 0; /* must save all match strings */
1013 Safefree(PL_inplace);
1015 SvREFCNT_dec(PL_patchlevel);
1018 SvREFCNT_dec(PL_e_script);
1024 /* magical thingies */
1026 SvREFCNT_dec(PL_ofsgv); /* *, */
1029 SvREFCNT_dec(PL_ors_sv); /* $\ */
1032 SvREFCNT_dec(PL_rs); /* $/ */
1035 Safefree(PL_osname); /* $^O */
1038 SvREFCNT_dec(PL_statname);
1042 /* defgv, aka *_ should be taken care of elsewhere */
1045 Safefree(PL_efloatbuf);
1046 PL_efloatbuf = NULL;
1049 /* startup and shutdown function lists */
1050 SvREFCNT_dec(PL_beginav);
1051 SvREFCNT_dec(PL_beginav_save);
1052 SvREFCNT_dec(PL_endav);
1053 SvREFCNT_dec(PL_checkav);
1054 SvREFCNT_dec(PL_checkav_save);
1055 SvREFCNT_dec(PL_unitcheckav);
1056 SvREFCNT_dec(PL_unitcheckav_save);
1057 SvREFCNT_dec(PL_initav);
1059 PL_beginav_save = NULL;
1062 PL_checkav_save = NULL;
1063 PL_unitcheckav = NULL;
1064 PL_unitcheckav_save = NULL;
1067 /* shortcuts just get cleared */
1070 PL_argvoutgv = NULL;
1073 PL_last_in_gv = NULL;
1084 SvREFCNT_dec(PL_envgv);
1085 SvREFCNT_dec(PL_incgv);
1086 SvREFCNT_dec(PL_argvgv);
1087 SvREFCNT_dec(PL_replgv);
1088 SvREFCNT_dec(PL_DBgv);
1089 SvREFCNT_dec(PL_DBline);
1090 SvREFCNT_dec(PL_DBsub);
1099 SvREFCNT_dec(PL_argvout_stack);
1100 PL_argvout_stack = NULL;
1102 SvREFCNT_dec(PL_modglobal);
1103 PL_modglobal = NULL;
1104 SvREFCNT_dec(PL_preambleav);
1105 PL_preambleav = NULL;
1106 SvREFCNT_dec(PL_subname);
1108 #ifdef PERL_USES_PL_PIDSTATUS
1109 SvREFCNT_dec(PL_pidstatus);
1110 PL_pidstatus = NULL;
1112 SvREFCNT_dec(PL_toptarget);
1113 PL_toptarget = NULL;
1114 SvREFCNT_dec(PL_bodytarget);
1115 PL_bodytarget = NULL;
1116 PL_formtarget = NULL;
1118 /* free locale stuff */
1119 #ifdef USE_LOCALE_COLLATE
1120 Safefree(PL_collation_name);
1121 PL_collation_name = NULL;
1123 #if defined(USE_POSIX_2008_LOCALE) \
1124 && defined(USE_THREAD_SAFE_LOCALE) \
1125 && ! defined(HAS_QUERYLOCALE)
1126 for (i = 0; i < (int) C_ARRAY_LENGTH(PL_curlocales); i++) {
1127 Safefree(PL_curlocales[i]);
1128 PL_curlocales[i] = NULL;
1131 #ifdef HAS_POSIX_2008_LOCALE
1133 /* This also makes sure we aren't using a locale object that gets freed
1135 const locale_t old_locale = uselocale(LC_GLOBAL_LOCALE);
1136 if ( old_locale != LC_GLOBAL_LOCALE
1137 # ifdef USE_POSIX_2008_LOCALE
1138 && old_locale != PL_C_locale_obj
1141 DEBUG_Lv(PerlIO_printf(Perl_debug_log,
1142 "%s:%d: Freeing %p\n", __FILE__, __LINE__, old_locale));
1143 freelocale(old_locale);
1146 # ifdef USE_LOCALE_NUMERIC
1147 if (PL_underlying_numeric_obj) {
1148 DEBUG_Lv(PerlIO_printf(Perl_debug_log,
1149 "%s:%d: Freeing %p\n", __FILE__, __LINE__,
1150 PL_underlying_numeric_obj));
1151 freelocale(PL_underlying_numeric_obj);
1152 PL_underlying_numeric_obj = (locale_t) NULL;
1156 #ifdef USE_LOCALE_NUMERIC
1157 Safefree(PL_numeric_name);
1158 PL_numeric_name = NULL;
1159 SvREFCNT_dec(PL_numeric_radix_sv);
1160 PL_numeric_radix_sv = NULL;
1163 if (PL_setlocale_buf) {
1164 Safefree(PL_setlocale_buf);
1165 PL_setlocale_buf = NULL;
1168 if (PL_langinfo_buf) {
1169 Safefree(PL_langinfo_buf);
1170 PL_langinfo_buf = NULL;
1173 #ifdef USE_LOCALE_CTYPE
1174 SvREFCNT_dec(PL_warn_locale);
1175 PL_warn_locale = NULL;
1178 SvREFCNT_dec(PL_AboveLatin1);
1179 PL_AboveLatin1 = NULL;
1180 SvREFCNT_dec(PL_Assigned_invlist);
1181 PL_Assigned_invlist = NULL;
1182 SvREFCNT_dec(PL_GCB_invlist);
1183 PL_GCB_invlist = NULL;
1184 SvREFCNT_dec(PL_HasMultiCharFold);
1185 PL_HasMultiCharFold = NULL;
1186 SvREFCNT_dec(PL_InMultiCharFold);
1187 PL_InMultiCharFold = NULL;
1188 SvREFCNT_dec(PL_Latin1);
1190 SvREFCNT_dec(PL_LB_invlist);
1191 PL_LB_invlist = NULL;
1192 SvREFCNT_dec(PL_SB_invlist);
1193 PL_SB_invlist = NULL;
1194 SvREFCNT_dec(PL_SCX_invlist);
1195 PL_SCX_invlist = NULL;
1196 SvREFCNT_dec(PL_UpperLatin1);
1197 PL_UpperLatin1 = NULL;
1198 SvREFCNT_dec(PL_in_some_fold);
1199 PL_in_some_fold = NULL;
1200 SvREFCNT_dec(PL_utf8_idcont);
1201 PL_utf8_idcont = NULL;
1202 SvREFCNT_dec(PL_utf8_idstart);
1203 PL_utf8_idstart = NULL;
1204 SvREFCNT_dec(PL_utf8_perl_idcont);
1205 PL_utf8_perl_idcont = NULL;
1206 SvREFCNT_dec(PL_utf8_perl_idstart);
1207 PL_utf8_perl_idstart = NULL;
1208 SvREFCNT_dec(PL_utf8_xidcont);
1209 PL_utf8_xidcont = NULL;
1210 SvREFCNT_dec(PL_utf8_xidstart);
1211 PL_utf8_xidstart = NULL;
1212 SvREFCNT_dec(PL_WB_invlist);
1213 PL_WB_invlist = NULL;
1214 SvREFCNT_dec(PL_utf8_toupper);
1215 PL_utf8_toupper = NULL;
1216 SvREFCNT_dec(PL_utf8_totitle);
1217 PL_utf8_totitle = NULL;
1218 SvREFCNT_dec(PL_utf8_tolower);
1219 PL_utf8_tolower = NULL;
1220 SvREFCNT_dec(PL_utf8_tofold);
1221 PL_utf8_tofold = NULL;
1222 SvREFCNT_dec(PL_utf8_tosimplefold);
1223 PL_utf8_tosimplefold = NULL;
1224 SvREFCNT_dec(PL_utf8_charname_begin);
1225 PL_utf8_charname_begin = NULL;
1226 SvREFCNT_dec(PL_utf8_charname_continue);
1227 PL_utf8_charname_continue = NULL;
1228 SvREFCNT_dec(PL_utf8_mark);
1229 PL_utf8_mark = NULL;
1230 SvREFCNT_dec(PL_InBitmap);
1232 SvREFCNT_dec(PL_CCC_non0_non230);
1233 PL_CCC_non0_non230 = NULL;
1234 SvREFCNT_dec(PL_Private_Use);
1235 PL_Private_Use = NULL;
1237 for (i = 0; i < POSIX_CC_COUNT; i++) {
1238 SvREFCNT_dec(PL_XPosix_ptrs[i]);
1239 PL_XPosix_ptrs[i] = NULL;
1241 if (i != _CC_CASED) { /* A copy of Alpha */
1242 SvREFCNT_dec(PL_Posix_ptrs[i]);
1243 PL_Posix_ptrs[i] = NULL;
1247 if (!specialWARN(PL_compiling.cop_warnings))
1248 PerlMemShared_free(PL_compiling.cop_warnings);
1249 PL_compiling.cop_warnings = NULL;
1250 cophh_free(CopHINTHASH_get(&PL_compiling));
1251 CopHINTHASH_set(&PL_compiling, cophh_new_empty());
1252 CopFILE_free(&PL_compiling);
1254 /* Prepare to destruct main symbol table. */
1257 /* break ref loop *:: <=> %:: */
1258 (void)hv_deletes(hv, "main::", G_DISCARD);
1261 SvREFCNT_dec(PL_curstname);
1262 PL_curstname = NULL;
1264 /* clear queued errors */
1265 SvREFCNT_dec(PL_errors);
1268 SvREFCNT_dec(PL_isarev);
1271 if (destruct_level >= 2) {
1272 if (PL_scopestack_ix != 0)
1273 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
1274 "Unbalanced scopes: %ld more ENTERs than LEAVEs\n",
1275 (long)PL_scopestack_ix);
1276 if (PL_savestack_ix != 0)
1277 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
1278 "Unbalanced saves: %ld more saves than restores\n",
1279 (long)PL_savestack_ix);
1280 if (PL_tmps_floor != -1)
1281 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced tmps: %ld more allocs than frees\n",
1282 (long)PL_tmps_floor + 1);
1283 if (cxstack_ix != -1)
1284 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced context: %ld more PUSHes than POPs\n",
1285 (long)cxstack_ix + 1);
1289 SvREFCNT_dec(PL_regex_padav);
1290 PL_regex_padav = NULL;
1291 PL_regex_pad = NULL;
1294 #ifdef PERL_IMPLICIT_CONTEXT
1295 /* the entries in this list are allocated via SV PVX's, so get freed
1296 * in sv_clean_all */
1297 Safefree(PL_my_cxt_list);
1300 /* Now absolutely destruct everything, somehow or other, loops or no. */
1302 /* the 2 is for PL_fdpid and PL_strtab */
1303 while (sv_clean_all() > 2)
1307 Safefree(PL_stashpad); /* must come after sv_clean_all */
1310 AvREAL_off(PL_fdpid); /* no surviving entries */
1311 SvREFCNT_dec(PL_fdpid); /* needed in io_close() */
1314 #ifdef HAVE_INTERP_INTERN
1318 /* constant strings */
1319 for (i = 0; i < SV_CONSTS_COUNT; i++) {
1320 SvREFCNT_dec(PL_sv_consts[i]);
1321 PL_sv_consts[i] = NULL;
1324 /* Destruct the global string table. */
1326 /* Yell and reset the HeVAL() slots that are still holding refcounts,
1327 * so that sv_free() won't fail on them.
1328 * Now that the global string table is using a single hunk of memory
1329 * for both HE and HEK, we either need to explicitly unshare it the
1330 * correct way, or actually free things here.
1333 const I32 max = HvMAX(PL_strtab);
1334 HE * const * const array = HvARRAY(PL_strtab);
1335 HE *hent = array[0];
1338 if (hent && ckWARN_d(WARN_INTERNAL)) {
1339 HE * const next = HeNEXT(hent);
1340 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
1341 "Unbalanced string table refcount: (%ld) for \"%s\"",
1342 (long)hent->he_valu.hent_refcount, HeKEY(hent));
1349 hent = array[riter];
1354 HvARRAY(PL_strtab) = 0;
1355 HvTOTALKEYS(PL_strtab) = 0;
1357 SvREFCNT_dec(PL_strtab);
1360 /* free the pointer tables used for cloning */
1361 ptr_table_free(PL_ptr_table);
1362 PL_ptr_table = (PTR_TBL_t*)NULL;
1365 /* free special SVs */
1367 SvREFCNT(&PL_sv_yes) = 0;
1368 sv_clear(&PL_sv_yes);
1369 SvANY(&PL_sv_yes) = NULL;
1370 SvFLAGS(&PL_sv_yes) = 0;
1372 SvREFCNT(&PL_sv_no) = 0;
1373 sv_clear(&PL_sv_no);
1374 SvANY(&PL_sv_no) = NULL;
1375 SvFLAGS(&PL_sv_no) = 0;
1377 SvREFCNT(&PL_sv_zero) = 0;
1378 sv_clear(&PL_sv_zero);
1379 SvANY(&PL_sv_zero) = NULL;
1380 SvFLAGS(&PL_sv_zero) = 0;
1384 for (i=0; i<=2; i++) {
1385 SvREFCNT(PERL_DEBUG_PAD(i)) = 0;
1386 sv_clear(PERL_DEBUG_PAD(i));
1387 SvANY(PERL_DEBUG_PAD(i)) = NULL;
1388 SvFLAGS(PERL_DEBUG_PAD(i)) = 0;
1392 if (PL_sv_count != 0 && ckWARN_d(WARN_INTERNAL))
1393 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Scalars leaked: %ld\n", (long)PL_sv_count);
1395 #ifdef DEBUG_LEAKING_SCALARS
1396 if (PL_sv_count != 0) {
1401 for (sva = PL_sv_arenaroot; sva; sva = MUTABLE_SV(SvANY(sva))) {
1402 svend = &sva[SvREFCNT(sva)];
1403 for (sv = sva + 1; sv < svend; ++sv) {
1404 if (SvTYPE(sv) != (svtype)SVTYPEMASK) {
1405 PerlIO_printf(Perl_debug_log, "leaked: sv=0x%p"
1407 " refcnt=%" UVuf pTHX__FORMAT "\n"
1408 "\tallocated at %s:%d %s %s (parent 0x%" UVxf ");"
1409 "serial %" UVuf "\n",
1410 (void*)sv, (UV)sv->sv_flags, (UV)sv->sv_refcnt
1412 sv->sv_debug_file ? sv->sv_debug_file : "(unknown)",
1414 sv->sv_debug_inpad ? "for" : "by",
1415 sv->sv_debug_optype ?
1416 PL_op_name[sv->sv_debug_optype]: "(none)",
1417 PTR2UV(sv->sv_debug_parent),
1420 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1421 Perl_dump_sv_child(aTHX_ sv);
1427 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1431 /* Wait for up to 4 seconds for child to terminate.
1432 This seems to be the least effort way of timing out on reaping
1434 struct timeval waitfor = {4, 0};
1435 int sock = PL_dumper_fd;
1439 FD_SET(sock, &rset);
1440 select(sock + 1, &rset, NULL, NULL, &waitfor);
1441 waitpid(child, &status, WNOHANG);
1446 #ifdef DEBUG_LEAKING_SCALARS_ABORT
1452 #if defined(PERLIO_LAYERS)
1453 /* No more IO - including error messages ! */
1454 PerlIO_cleanup(aTHX);
1457 /* sv_undef needs to stay immortal until after PerlIO_cleanup
1458 as currently layers use it rather than NULL as a marker
1459 for no arg - and will try and SvREFCNT_dec it.
1461 SvREFCNT(&PL_sv_undef) = 0;
1462 SvREADONLY_off(&PL_sv_undef);
1464 Safefree(PL_origfilename);
1465 PL_origfilename = NULL;
1466 Safefree(PL_reg_curpm);
1467 free_tied_hv_pool();
1468 Safefree(PL_op_mask);
1469 Safefree(PL_psig_name);
1470 PL_psig_name = (SV**)NULL;
1471 PL_psig_ptr = (SV**)NULL;
1473 /* We need to NULL PL_psig_pend first, so that
1474 signal handlers know not to use it */
1475 int *psig_save = PL_psig_pend;
1476 PL_psig_pend = (int*)NULL;
1477 Safefree(psig_save);
1480 TAINTING_set(FALSE);
1481 TAINT_WARN_set(FALSE);
1482 PL_hints = 0; /* Reset hints. Should hints be per-interpreter ? */
1484 DEBUG_P(debprofdump());
1488 #ifdef USE_REENTRANT_API
1489 Perl_reentrant_free(aTHX);
1492 /* These all point to HVs that are about to be blown away.
1493 Code in core and on CPAN assumes that if the interpreter is re-started
1494 that they will be cleanly NULL or pointing to a valid HV. */
1495 PL_custom_op_names = NULL;
1496 PL_custom_op_descs = NULL;
1497 PL_custom_ops = NULL;
1501 while (PL_regmatch_slab) {
1502 regmatch_slab *s = PL_regmatch_slab;
1503 PL_regmatch_slab = PL_regmatch_slab->next;
1507 /* As the absolutely last thing, free the non-arena SV for mess() */
1510 /* we know that type == SVt_PVMG */
1512 /* it could have accumulated taint magic */
1515 for (mg = SvMAGIC(PL_mess_sv); mg; mg = moremagic) {
1516 moremagic = mg->mg_moremagic;
1517 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global
1519 Safefree(mg->mg_ptr);
1523 /* we know that type >= SVt_PV */
1524 SvPV_free(PL_mess_sv);
1525 Safefree(SvANY(PL_mess_sv));
1526 Safefree(PL_mess_sv);
1533 =for apidoc perl_free
1535 Releases a Perl interpreter. See L<perlembed>.
1545 PERL_ARGS_ASSERT_PERL_FREE;
1547 if (PL_veto_cleanup)
1550 #ifdef PERL_TRACK_MEMPOOL
1553 * Don't free thread memory if PERL_DESTRUCT_LEVEL is set to a non-zero
1554 * value as we're probably hunting memory leaks then
1556 if (PL_perl_destruct_level == 0) {
1557 const U32 old_debug = PL_debug;
1558 /* Emulate the PerlHost behaviour of free()ing all memory allocated in this
1559 thread at thread exit. */
1561 PerlIO_puts(Perl_debug_log, "Disabling memory debugging as we "
1562 "free this thread's memory\n");
1563 PL_debug &= ~ DEBUG_m_FLAG;
1565 while(aTHXx->Imemory_debug_header.next != &(aTHXx->Imemory_debug_header)){
1566 char * next = (char *)(aTHXx->Imemory_debug_header.next);
1567 Malloc_t ptr = PERL_MEMORY_DEBUG_HEADER_SIZE + next;
1570 PL_debug = old_debug;
1575 #if defined(WIN32) || defined(NETWARE)
1576 # if defined(PERL_IMPLICIT_SYS)
1579 void *host = nw_internal_host;
1580 PerlMem_free(aTHXx);
1581 nw_delete_internal_host(host);
1583 void *host = w32_internal_host;
1584 PerlMem_free(aTHXx);
1585 win32_delete_internal_host(host);
1589 PerlMem_free(aTHXx);
1592 PerlMem_free(aTHXx);
1596 #if defined(USE_ITHREADS)
1597 /* provide destructors to clean up the thread key when libperl is unloaded */
1598 #ifndef WIN32 /* handled during DLL_PROCESS_DETACH in win32/perllib.c */
1600 #if defined(__hpux) && !(defined(__ux_version) && __ux_version <= 1020) && !defined(__GNUC__)
1601 #pragma fini "perl_fini"
1602 #elif defined(__sun) && !defined(__GNUC__)
1603 #pragma fini (perl_fini)
1607 #if defined(__GNUC__)
1608 __attribute__((destructor))
1614 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
1617 PL_curinterp && !PL_veto_cleanup)
1622 #endif /* THREADS */
1625 Perl_call_atexit(pTHX_ ATEXIT_t fn, void *ptr)
1627 Renew(PL_exitlist, PL_exitlistlen+1, PerlExitListEntry);
1628 PL_exitlist[PL_exitlistlen].fn = fn;
1629 PL_exitlist[PL_exitlistlen].ptr = ptr;
1634 =for apidoc perl_parse
1636 Tells a Perl interpreter to parse a Perl script. This performs most
1637 of the initialisation of a Perl interpreter. See L<perlembed> for
1640 C<my_perl> points to the Perl interpreter that is to parse the script.
1641 It must have been previously created through the use of L</perl_alloc>
1642 and L</perl_construct>. C<xsinit> points to a callback function that
1643 will be called to set up the ability for this Perl interpreter to load
1644 XS extensions, or may be null to perform no such setup.
1646 C<argc> and C<argv> supply a set of command-line arguments to the Perl
1647 interpreter, as would normally be passed to the C<main> function of
1648 a C program. C<argv[argc]> must be null. These arguments are where
1649 the script to parse is specified, either by naming a script file or by
1650 providing a script in a C<-e> option.
1651 If L<C<$0>|perlvar/$0> will be written to in the Perl interpreter, then
1652 the argument strings must be in writable memory, and so mustn't just be
1655 C<env> specifies a set of environment variables that will be used by
1656 this Perl interpreter. If non-null, it must point to a null-terminated
1657 array of environment strings. If null, the Perl interpreter will use
1658 the environment supplied by the C<environ> global variable.
1660 This function initialises the interpreter, and parses and compiles the
1661 script specified by the command-line arguments. This includes executing
1662 code in C<BEGIN>, C<UNITCHECK>, and C<CHECK> blocks. It does not execute
1663 C<INIT> blocks or the main program.
1665 Returns an integer of slightly tricky interpretation. The correct
1666 use of the return value is as a truth value indicating whether there
1667 was a failure in initialisation. If zero is returned, this indicates
1668 that initialisation was successful, and it is safe to proceed to call
1669 L</perl_run> and make other use of it. If a non-zero value is returned,
1670 this indicates some problem that means the interpreter wants to terminate.
1671 The interpreter should not be just abandoned upon such failure; the caller
1672 should proceed to shut the interpreter down cleanly with L</perl_destruct>
1673 and free it with L</perl_free>.
1675 For historical reasons, the non-zero return value also attempts to
1676 be a suitable value to pass to the C library function C<exit> (or to
1677 return from C<main>), to serve as an exit code indicating the nature
1678 of the way initialisation terminated. However, this isn't portable,
1679 due to differing exit code conventions. A historical bug is preserved
1680 for the time being: if the Perl built-in C<exit> is called during this
1681 function's execution, with a type of exit entailing a zero exit code
1682 under the host operating system's conventions, then this function
1683 returns zero rather than a non-zero value. This bug, [perl #2754],
1684 leads to C<perl_run> being called (and therefore C<INIT> blocks and the
1685 main program running) despite a call to C<exit>. It has been preserved
1686 because a popular module-installing module has come to rely on it and
1687 needs time to be fixed. This issue is [perl #132577], and the original
1688 bug is due to be fixed in Perl 5.30.
1693 #define SET_CURSTASH(newstash) \
1694 if (PL_curstash != newstash) { \
1695 SvREFCNT_dec(PL_curstash); \
1696 PL_curstash = (HV *)SvREFCNT_inc(newstash); \
1700 perl_parse(pTHXx_ XSINIT_t xsinit, int argc, char **argv, char **env)
1707 PERL_ARGS_ASSERT_PERL_PARSE;
1708 #ifndef MULTIPLICITY
1709 PERL_UNUSED_ARG(my_perl);
1711 #if (defined(USE_HASH_SEED) || defined(USE_HASH_SEED_DEBUG)) && !defined(NO_PERL_HASH_SEED_DEBUG)
1713 const char * const s = PerlEnv_getenv("PERL_HASH_SEED_DEBUG");
1715 if (s && strEQ(s, "1")) {
1716 const unsigned char *seed= PERL_HASH_SEED;
1717 const unsigned char *seed_end= PERL_HASH_SEED + PERL_HASH_SEED_BYTES;
1718 PerlIO_printf(Perl_debug_log, "HASH_FUNCTION = %s HASH_SEED = 0x", PERL_HASH_FUNC);
1719 while (seed < seed_end) {
1720 PerlIO_printf(Perl_debug_log, "%02x", *seed++);
1722 #ifdef PERL_HASH_RANDOMIZE_KEYS
1723 PerlIO_printf(Perl_debug_log, " PERTURB_KEYS = %d (%s)",
1724 PL_HASH_RAND_BITS_ENABLED,
1725 PL_HASH_RAND_BITS_ENABLED == 0 ? "NO" : PL_HASH_RAND_BITS_ENABLED == 1 ? "RANDOM" : "DETERMINISTIC");
1727 PerlIO_printf(Perl_debug_log, "\n");
1730 #endif /* #if (defined(USE_HASH_SEED) ... */
1734 struct NameTranslationInfo nti;
1735 __translate_amiga_to_unix_path_name(&argv[0],&nti);
1742 for(i = 0; i != argc; i++)
1744 assert(!argv[argc]);
1749 if (PL_origalen != 0) {
1750 PL_origalen = 1; /* don't use old PL_origalen if perl_parse() is called again */
1753 /* Set PL_origalen be the sum of the contiguous argv[]
1754 * elements plus the size of the env in case that it is
1755 * contiguous with the argv[]. This is used in mg.c:Perl_magic_set()
1756 * as the maximum modifiable length of $0. In the worst case
1757 * the area we are able to modify is limited to the size of
1758 * the original argv[0]. (See below for 'contiguous', though.)
1760 const char *s = NULL;
1761 const UV mask = ~(UV)(PTRSIZE-1);
1762 /* Do the mask check only if the args seem like aligned. */
1764 (mask < ~(UV)0) && ((PTR2UV(argv[0]) & mask) == PTR2UV(argv[0]));
1766 /* See if all the arguments are contiguous in memory. Note
1767 * that 'contiguous' is a loose term because some platforms
1768 * align the argv[] and the envp[]. If the arguments look
1769 * like non-aligned, assume that they are 'strictly' or
1770 * 'traditionally' contiguous. If the arguments look like
1771 * aligned, we just check that they are within aligned
1772 * PTRSIZE bytes. As long as no system has something bizarre
1773 * like the argv[] interleaved with some other data, we are
1774 * fine. (Did I just evoke Murphy's Law?) --jhi */
1775 if (PL_origargv && PL_origargc >= 1 && (s = PL_origargv[0])) {
1778 for (i = 1; i < PL_origargc; i++) {
1779 if ((PL_origargv[i] == s + 1
1781 || PL_origargv[i] == s + 2
1786 (PL_origargv[i] > s &&
1788 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1799 #ifndef PERL_USE_SAFE_PUTENV
1800 /* Can we grab env area too to be used as the area for $0? */
1801 if (s && PL_origenviron && !PL_use_safe_putenv) {
1802 if ((PL_origenviron[0] == s + 1)
1805 (PL_origenviron[0] > s &&
1806 PL_origenviron[0] <=
1807 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1811 #ifndef OS2 /* ENVIRON is read by the kernel too. */
1812 s = PL_origenviron[0];
1815 my_setenv("NoNe SuCh", NULL);
1816 /* Force copy of environment. */
1817 for (i = 1; PL_origenviron[i]; i++) {
1818 if (PL_origenviron[i] == s + 1
1821 (PL_origenviron[i] > s &&
1822 PL_origenviron[i] <=
1823 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1826 s = PL_origenviron[i];
1834 #endif /* !defined(PERL_USE_SAFE_PUTENV) */
1836 PL_origalen = s ? s - PL_origargv[0] + 1 : 0;
1841 /* Come here if running an undumped a.out. */
1843 PL_origfilename = savepv(argv[0]);
1844 PL_do_undump = FALSE;
1845 cxstack_ix = -1; /* start label stack again */
1847 assert (!TAINT_get);
1851 init_postdump_symbols(argc,argv,env);
1856 op_free(PL_main_root);
1857 PL_main_root = NULL;
1859 PL_main_start = NULL;
1860 SvREFCNT_dec(PL_main_cv);
1864 oldscope = PL_scopestack_ix;
1865 PL_dowarn = G_WARN_OFF;
1870 parse_body(env,xsinit);
1871 if (PL_unitcheckav) {
1872 call_list(oldscope, PL_unitcheckav);
1875 PERL_SET_PHASE(PERL_PHASE_CHECK);
1876 call_list(oldscope, PL_checkav);
1884 /* my_exit() was called */
1885 while (PL_scopestack_ix > oldscope)
1888 SET_CURSTASH(PL_defstash);
1889 if (PL_unitcheckav) {
1890 call_list(oldscope, PL_unitcheckav);
1893 PERL_SET_PHASE(PERL_PHASE_CHECK);
1894 call_list(oldscope, PL_checkav);
1899 * At this point we should do
1901 * to avoid [perl #2754], but that bugfix has been postponed
1902 * because of the Module::Install breakage it causes
1908 PerlIO_printf(Perl_error_log, "panic: top_env\n");
1916 /* This needs to stay in perl.c, as perl.c is compiled with different flags for
1917 miniperl, and we need to see those flags reflected in the values here. */
1919 /* What this returns is subject to change. Use the public interface in Config.
1922 S_Internals_V(pTHX_ CV *cv)
1925 #ifdef LOCAL_PATCH_COUNT
1926 const int local_patch_count = LOCAL_PATCH_COUNT;
1928 const int local_patch_count = 0;
1930 const int entries = 3 + local_patch_count;
1932 static const char non_bincompat_options[] =
1939 # ifdef NO_HASH_SEED
1942 # ifdef NO_TAINT_SUPPORT
1945 # ifdef PERL_BOOL_AS_CHAR
1946 " PERL_BOOL_AS_CHAR"
1948 # ifdef PERL_COPY_ON_WRITE
1949 " PERL_COPY_ON_WRITE"
1951 # ifdef PERL_DISABLE_PMC
1954 # ifdef PERL_DONT_CREATE_GVSV
1955 " PERL_DONT_CREATE_GVSV"
1957 # ifdef PERL_EXTERNAL_GLOB
1958 " PERL_EXTERNAL_GLOB"
1960 # ifdef PERL_HASH_FUNC_SIPHASH
1961 " PERL_HASH_FUNC_SIPHASH"
1963 # ifdef PERL_HASH_FUNC_SDBM
1964 " PERL_HASH_FUNC_SDBM"
1966 # ifdef PERL_HASH_FUNC_DJB2
1967 " PERL_HASH_FUNC_DJB2"
1969 # ifdef PERL_HASH_FUNC_SUPERFAST
1970 " PERL_HASH_FUNC_SUPERFAST"
1972 # ifdef PERL_HASH_FUNC_MURMUR3
1973 " PERL_HASH_FUNC_MURMUR3"
1975 # ifdef PERL_HASH_FUNC_ONE_AT_A_TIME
1976 " PERL_HASH_FUNC_ONE_AT_A_TIME"
1978 # ifdef PERL_HASH_FUNC_ONE_AT_A_TIME_HARD
1979 " PERL_HASH_FUNC_ONE_AT_A_TIME_HARD"
1981 # ifdef PERL_HASH_FUNC_ONE_AT_A_TIME_OLD
1982 " PERL_HASH_FUNC_ONE_AT_A_TIME_OLD"
1984 # ifdef PERL_IS_MINIPERL
1987 # ifdef PERL_MALLOC_WRAP
1990 # ifdef PERL_MEM_LOG
1993 # ifdef PERL_MEM_LOG_NOIMPL
1994 " PERL_MEM_LOG_NOIMPL"
1996 # ifdef PERL_OP_PARENT
1999 # ifdef PERL_PERTURB_KEYS_DETERMINISTIC
2000 " PERL_PERTURB_KEYS_DETERMINISTIC"
2002 # ifdef PERL_PERTURB_KEYS_DISABLED
2003 " PERL_PERTURB_KEYS_DISABLED"
2005 # ifdef PERL_PERTURB_KEYS_RANDOM
2006 " PERL_PERTURB_KEYS_RANDOM"
2008 # ifdef PERL_PRESERVE_IVUV
2009 " PERL_PRESERVE_IVUV"
2011 # ifdef PERL_RELOCATABLE_INCPUSH
2012 " PERL_RELOCATABLE_INCPUSH"
2014 # ifdef PERL_USE_DEVEL
2017 # ifdef PERL_USE_SAFE_PUTENV
2018 " PERL_USE_SAFE_PUTENV"
2020 # ifdef SILENT_NO_TAINT_SUPPORT
2021 " SILENT_NO_TAINT_SUPPORT"
2023 # ifdef UNLINK_ALL_VERSIONS
2024 " UNLINK_ALL_VERSIONS"
2026 # ifdef USE_ATTRIBUTES_FOR_PERLIO
2027 " USE_ATTRIBUTES_FOR_PERLIO"
2029 # ifdef USE_FAST_STDIO
2035 # ifdef USE_LOCALE_CTYPE
2038 # ifdef WIN32_NO_REGISTRY
2041 # ifdef USE_PERL_ATOF
2044 # ifdef USE_SITECUSTOMIZE
2045 " USE_SITECUSTOMIZE"
2047 # ifdef USE_THREAD_SAFE_LOCALE
2048 " USE_THREAD_SAFE_LOCALE"
2051 PERL_UNUSED_ARG(cv);
2052 PERL_UNUSED_VAR(items);
2054 EXTEND(SP, entries);
2056 PUSHs(sv_2mortal(newSVpv(PL_bincompat_options, 0)));
2057 PUSHs(Perl_newSVpvn_flags(aTHX_ non_bincompat_options,
2058 sizeof(non_bincompat_options) - 1, SVs_TEMP));
2060 #ifndef PERL_BUILD_DATE
2063 # define PERL_BUILD_DATE __DATE__ " " __TIME__
2065 # define PERL_BUILD_DATE __DATE__
2070 #ifdef PERL_BUILD_DATE
2071 PUSHs(Perl_newSVpvn_flags(aTHX_
2072 STR_WITH_LEN("Compiled at " PERL_BUILD_DATE),
2075 PUSHs(&PL_sv_undef);
2078 for (i = 1; i <= local_patch_count; i++) {
2079 /* This will be an undef, if PL_localpatches[i] is NULL. */
2080 PUSHs(sv_2mortal(newSVpv(PL_localpatches[i], 0)));
2086 #define INCPUSH_UNSHIFT 0x01
2087 #define INCPUSH_ADD_OLD_VERS 0x02
2088 #define INCPUSH_ADD_VERSIONED_SUB_DIRS 0x04
2089 #define INCPUSH_ADD_ARCHONLY_SUB_DIRS 0x08
2090 #define INCPUSH_NOT_BASEDIR 0x10
2091 #define INCPUSH_CAN_RELOCATE 0x20
2092 #define INCPUSH_ADD_SUB_DIRS \
2093 (INCPUSH_ADD_VERSIONED_SUB_DIRS|INCPUSH_ADD_ARCHONLY_SUB_DIRS)
2096 S_parse_body(pTHX_ char **env, XSINIT_t xsinit)
2100 int argc = PL_origargc;
2101 char **argv = PL_origargv;
2102 const char *scriptname = NULL;
2103 bool dosearch = FALSE;
2105 bool doextract = FALSE;
2106 const char *cddir = NULL;
2107 #ifdef USE_SITECUSTOMIZE
2108 bool minus_f = FALSE;
2110 SV *linestr_sv = NULL;
2111 bool add_read_e_script = FALSE;
2112 U32 lex_start_flags = 0;
2114 PERL_SET_PHASE(PERL_PHASE_START);
2120 for (argc--,argv++; argc > 0; argc--,argv++) {
2121 if (argv[0][0] != '-' || !argv[0][1])
2127 #ifndef PERL_STRICT_CR
2151 if ((s = moreswitches(s)))
2156 #if defined(SILENT_NO_TAINT_SUPPORT)
2157 /* silently ignore */
2158 #elif defined(NO_TAINT_SUPPORT)
2159 Perl_croak_nocontext("This perl was compiled without taint support. "
2160 "Cowardly refusing to run with -t or -T flags");
2162 CHECK_MALLOC_TOO_LATE_FOR('t');
2163 if( !TAINTING_get ) {
2164 TAINT_WARN_set(TRUE);
2171 #if defined(SILENT_NO_TAINT_SUPPORT)
2172 /* silently ignore */
2173 #elif defined(NO_TAINT_SUPPORT)
2174 Perl_croak_nocontext("This perl was compiled without taint support. "
2175 "Cowardly refusing to run with -t or -T flags");
2177 CHECK_MALLOC_TOO_LATE_FOR('T');
2179 TAINT_WARN_set(FALSE);
2188 forbid_setid('e', FALSE);
2190 PL_e_script = newSVpvs("");
2191 add_read_e_script = TRUE;
2194 sv_catpv(PL_e_script, s);
2196 sv_catpv(PL_e_script, argv[1]);
2200 Perl_croak(aTHX_ "No code specified for -%c", c);
2201 sv_catpvs(PL_e_script, "\n");
2205 #ifdef USE_SITECUSTOMIZE
2211 case 'I': /* -I handled both here and in moreswitches() */
2212 forbid_setid('I', FALSE);
2213 if (!*++s && (s=argv[1]) != NULL) {
2217 STRLEN len = strlen(s);
2218 incpush(s, len, INCPUSH_ADD_SUB_DIRS|INCPUSH_ADD_OLD_VERS);
2221 Perl_croak(aTHX_ "No directory specified for -I");
2224 forbid_setid('S', FALSE);
2233 opts_prog = newSVpvs("use Config; Config::_V()");
2237 opts_prog = Perl_newSVpvf(aTHX_
2238 "use Config; Config::config_vars(qw%c%s%c)",
2242 Perl_av_create_and_push(aTHX_ &PL_preambleav, opts_prog);
2243 /* don't look for script or read stdin */
2244 scriptname = BIT_BUCKET;
2256 if (!*++s || isSPACE(*s)) {
2260 /* catch use of gnu style long options.
2261 Both of these exit immediately. */
2262 if (strEQ(s, "version"))
2264 if (strEQ(s, "help"))
2269 Perl_croak(aTHX_ "Unrecognized switch: -%s (-h will show valid options)",s);
2280 #ifndef SECURE_INTERNAL_GETENV
2283 (s = PerlEnv_getenv("PERL5OPT")))
2285 /* s points to static memory in getenv(), which may be overwritten at
2286 * any time; use a mortal copy instead */
2287 s = SvPVX(sv_2mortal(newSVpv(s, 0)));
2291 if (*s == '-' && *(s+1) == 'T') {
2292 #if defined(SILENT_NO_TAINT_SUPPORT)
2293 /* silently ignore */
2294 #elif defined(NO_TAINT_SUPPORT)
2295 Perl_croak_nocontext("This perl was compiled without taint support. "
2296 "Cowardly refusing to run with -t or -T flags");
2298 CHECK_MALLOC_TOO_LATE_FOR('T');
2300 TAINT_WARN_set(FALSE);
2304 char *popt_copy = NULL;
2317 if (!memCHRs("CDIMUdmtwW", *s))
2318 Perl_croak(aTHX_ "Illegal switch in PERL5OPT: -%c", *s);
2322 popt_copy = SvPVX(sv_2mortal(newSVpv(d,0)));
2323 s = popt_copy + (s - d);
2331 #if defined(SILENT_NO_TAINT_SUPPORT)
2332 /* silently ignore */
2333 #elif defined(NO_TAINT_SUPPORT)
2334 Perl_croak_nocontext("This perl was compiled without taint support. "
2335 "Cowardly refusing to run with -t or -T flags");
2337 if( !TAINTING_get) {
2338 TAINT_WARN_set(TRUE);
2350 #ifndef NO_PERL_INTERNAL_RAND_SEED
2351 /* If we're not set[ug]id, we might have honored
2352 PERL_INTERNAL_RAND_SEED in perl_construct().
2353 At this point command-line options have been parsed, so if
2354 we're now tainting and not set[ug]id re-seed.
2355 This could possibly be wasteful if PERL_INTERNAL_RAND_SEED is invalid,
2356 but avoids duplicating the logic from perl_construct().
2359 PerlProc_getuid() == PerlProc_geteuid() &&
2360 PerlProc_getgid() == PerlProc_getegid()) {
2361 Perl_drand48_init_r(&PL_internal_random_state, seed());
2365 /* Set $^X early so that it can be used for relocatable paths in @INC */
2366 /* and for SITELIB_EXP in USE_SITECUSTOMIZE */
2367 assert (!TAINT_get);
2372 #if defined(USE_SITECUSTOMIZE)
2374 /* The games with local $! are to avoid setting errno if there is no
2375 sitecustomize script. "q%c...%c", 0, ..., 0 becomes "q\0...\0",
2376 ie a q() operator with a NUL byte as a the delimiter. This avoids
2377 problems with pathnames containing (say) ' */
2378 # ifdef PERL_IS_MINIPERL
2379 AV *const inc = GvAV(PL_incgv);
2380 SV **const inc0 = inc ? av_fetch(inc, 0, FALSE) : NULL;
2383 /* if lib/buildcustomize.pl exists, it should not fail. If it does,
2384 it should be reported immediately as a build failure. */
2385 (void)Perl_av_create_and_unshift_one(aTHX_ &PL_preambleav,
2387 "BEGIN { my $f = q%c%s%" SVf "/buildcustomize.pl%c; "
2388 "do {local $!; -f $f }"
2389 " and do $f || die $@ || qq '$f: $!' }",
2390 0, (TAINTING_get ? "./" : ""), SVfARG(*inc0), 0));
2393 /* SITELIB_EXP is a function call on Win32. */
2394 const char *const raw_sitelib = SITELIB_EXP;
2396 /* process .../.. if PERL_RELOCATABLE_INC is defined */
2397 SV *sitelib_sv = mayberelocate(raw_sitelib, strlen(raw_sitelib),
2398 INCPUSH_CAN_RELOCATE);
2399 const char *const sitelib = SvPVX(sitelib_sv);
2400 (void)Perl_av_create_and_unshift_one(aTHX_ &PL_preambleav,
2402 "BEGIN { do {local $!; -f q%c%s/sitecustomize.pl%c} && do q%c%s/sitecustomize.pl%c }",
2403 0, SVfARG(sitelib), 0,
2404 0, SVfARG(sitelib), 0));
2405 assert (SvREFCNT(sitelib_sv) == 1);
2406 SvREFCNT_dec(sitelib_sv);
2413 scriptname = argv[0];
2416 scriptname = BIT_BUCKET; /* don't look for script or read stdin */
2418 else if (scriptname == NULL) {
2420 if ( PerlLIO_isatty(PerlIO_fileno(PerlIO_stdin())) )
2426 assert (!TAINT_get);
2430 bool suidscript = FALSE;
2432 rsfp = open_script(scriptname, dosearch, &suidscript);
2434 rsfp = PerlIO_stdin();
2435 lex_start_flags = LEX_DONT_CLOSE_RSFP;
2438 validate_suid(rsfp);
2441 # if defined(SIGCHLD) || defined(SIGCLD)
2444 # define SIGCHLD SIGCLD
2446 Sighandler_t sigstate = rsignal_state(SIGCHLD);
2447 if (sigstate == (Sighandler_t) SIG_IGN) {
2448 Perl_ck_warner(aTHX_ packWARN(WARN_SIGNAL),
2449 "Can't ignore signal CHLD, forcing to default");
2450 (void)rsignal(SIGCHLD, (Sighandler_t)SIG_DFL);
2458 /* This will croak if suidscript is true, as -x cannot be used with
2460 forbid_setid('x', suidscript);
2461 /* Hence you can't get here if suidscript is true */
2463 linestr_sv = newSV_type(SVt_PV);
2464 lex_start_flags |= LEX_START_COPIED;
2465 find_beginning(linestr_sv, rsfp);
2466 if (cddir && PerlDir_chdir( (char *)cddir ) < 0)
2467 Perl_croak(aTHX_ "Can't chdir to %s",cddir);
2471 PL_main_cv = PL_compcv = MUTABLE_CV(newSV_type(SVt_PVCV));
2472 CvUNIQUE_on(PL_compcv);
2474 CvPADLIST_set(PL_compcv, pad_new(0));
2476 PL_isarev = newHV();
2479 boot_core_UNIVERSAL();
2481 newXS("Internals::V", S_Internals_V, __FILE__);
2484 (*xsinit)(aTHX); /* in case linked C routines want magical variables */
2486 #if defined(VMS) || defined(WIN32) || defined(DJGPP) || defined(__CYGWIN__) || defined(SYMBIAN)
2492 # ifdef HAS_SOCKS5_INIT
2493 socks5_init(argv[0]);
2499 init_predump_symbols();
2500 /* init_postdump_symbols not currently designed to be called */
2501 /* more than once (ENV isn't cleared first, for example) */
2502 /* But running with -u leaves %ENV & @ARGV undefined! XXX */
2504 init_postdump_symbols(argc,argv,env);
2506 /* PL_unicode is turned on by -C, or by $ENV{PERL_UNICODE},
2507 * or explicitly in some platforms.
2508 * PL_utf8locale is conditionally turned on by
2509 * locale.c:Perl_init_i18nl10n() if the environment
2510 * look like the user wants to use UTF-8. */
2511 #if defined(__SYMBIAN32__)
2512 PL_unicode = PERL_UNICODE_STD_FLAG; /* See PERL_SYMBIAN_CONSOLE_UTF8. */
2514 # ifndef PERL_IS_MINIPERL
2516 /* Requires init_predump_symbols(). */
2517 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
2522 /* Turn on UTF-8-ness on STDIN, STDOUT, STDERR
2523 * and the default open disciplines. */
2524 if ((PL_unicode & PERL_UNICODE_STDIN_FLAG) &&
2525 PL_stdingv && (io = GvIO(PL_stdingv)) &&
2527 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2528 if ((PL_unicode & PERL_UNICODE_STDOUT_FLAG) &&
2529 PL_defoutgv && (io = GvIO(PL_defoutgv)) &&
2531 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2532 if ((PL_unicode & PERL_UNICODE_STDERR_FLAG) &&
2533 PL_stderrgv && (io = GvIO(PL_stderrgv)) &&
2535 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2536 if ((PL_unicode & PERL_UNICODE_INOUT_FLAG) &&
2537 (sv = GvSV(gv_fetchpvs("\017PEN", GV_ADD|GV_NOTQUAL,
2539 U32 in = PL_unicode & PERL_UNICODE_IN_FLAG;
2540 U32 out = PL_unicode & PERL_UNICODE_OUT_FLAG;
2543 sv_setpvs(sv, ":utf8\0:utf8");
2545 sv_setpvs(sv, ":utf8\0");
2548 sv_setpvs(sv, "\0:utf8");
2557 if ((s = PerlEnv_getenv("PERL_SIGNALS"))) {
2558 if (strEQ(s, "unsafe"))
2559 PL_signals |= PERL_SIGNALS_UNSAFE_FLAG;
2560 else if (strEQ(s, "safe"))
2561 PL_signals &= ~PERL_SIGNALS_UNSAFE_FLAG;
2563 Perl_croak(aTHX_ "PERL_SIGNALS illegal: \"%s\"", s);
2568 lex_start(linestr_sv, rsfp, lex_start_flags);
2569 SvREFCNT_dec(linestr_sv);
2571 PL_subname = newSVpvs("main");
2573 if (add_read_e_script)
2574 filter_add(read_e_script, NULL);
2576 /* now parse the script */
2578 SETERRNO(0,SS_NORMAL);
2579 if (yyparse(GRAMPROG) || PL_parser->error_count) {
2580 abort_execution("", PL_origfilename);
2582 CopLINE_set(PL_curcop, 0);
2583 SET_CURSTASH(PL_defstash);
2585 SvREFCNT_dec(PL_e_script);
2593 SAVECOPFILE(PL_curcop);
2594 SAVECOPLINE(PL_curcop);
2595 gv_check(PL_defstash);
2605 s = PerlEnv_getenv("PERL_DEBUG_MSTATS");
2606 if (s && grok_atoUV(s, &uv, NULL) && uv >= 2)
2607 dump_mstats("after compilation:");
2612 PL_restartjmpenv = NULL;
2618 =for apidoc perl_run
2620 Tells a Perl interpreter to run its main program. See L<perlembed>
2623 C<my_perl> points to the Perl interpreter. It must have been previously
2624 created through the use of L</perl_alloc> and L</perl_construct>, and
2625 initialised through L</perl_parse>. This function should not be called
2626 if L</perl_parse> returned a non-zero value, indicating a failure in
2627 initialisation or compilation.
2629 This function executes code in C<INIT> blocks, and then executes the
2630 main program. The code to be executed is that established by the prior
2631 call to L</perl_parse>. If the interpreter's C<PL_exit_flags> word
2632 does not have the C<PERL_EXIT_DESTRUCT_END> flag set, then this function
2633 will also execute code in C<END> blocks. If it is desired to make any
2634 further use of the interpreter after calling this function, then C<END>
2635 blocks should be postponed to L</perl_destruct> time by setting that flag.
2637 Returns an integer of slightly tricky interpretation. The correct use
2638 of the return value is as a truth value indicating whether the program
2639 terminated non-locally. If zero is returned, this indicates that
2640 the program ran to completion, and it is safe to make other use of the
2641 interpreter (provided that the C<PERL_EXIT_DESTRUCT_END> flag was set as
2642 described above). If a non-zero value is returned, this indicates that
2643 the interpreter wants to terminate early. The interpreter should not be
2644 just abandoned because of this desire to terminate; the caller should
2645 proceed to shut the interpreter down cleanly with L</perl_destruct>
2646 and free it with L</perl_free>.
2648 For historical reasons, the non-zero return value also attempts to
2649 be a suitable value to pass to the C library function C<exit> (or to
2650 return from C<main>), to serve as an exit code indicating the nature of
2651 the way the program terminated. However, this isn't portable, due to
2652 differing exit code conventions. An attempt is made to return an exit
2653 code of the type required by the host operating system, but because
2654 it is constrained to be non-zero, it is not necessarily possible to
2655 indicate every type of exit. It is only reliable on Unix, where a zero
2656 exit code can be augmented with a set bit that will be ignored. In any
2657 case, this function is not the correct place to acquire an exit code:
2658 one should get that from L</perl_destruct>.
2670 PERL_ARGS_ASSERT_PERL_RUN;
2671 #ifndef MULTIPLICITY
2672 PERL_UNUSED_ARG(my_perl);
2675 oldscope = PL_scopestack_ix;
2683 cxstack_ix = -1; /* start context stack again */
2685 case 0: /* normal completion */
2689 case 2: /* my_exit() */
2690 while (PL_scopestack_ix > oldscope)
2693 SET_CURSTASH(PL_defstash);
2694 if (!(PL_exit_flags & PERL_EXIT_DESTRUCT_END) &&
2695 PL_endav && !PL_minus_c) {
2696 PERL_SET_PHASE(PERL_PHASE_END);
2697 call_list(oldscope, PL_endav);
2700 if (PerlEnv_getenv("PERL_DEBUG_MSTATS"))
2701 dump_mstats("after execution: ");
2707 POPSTACK_TO(PL_mainstack);
2710 PerlIO_printf(Perl_error_log, "panic: restartop in perl_run\n");
2721 S_run_body(pTHX_ I32 oldscope)
2723 DEBUG_r(PerlIO_printf(Perl_debug_log, "%s $` $& $' support (0x%x).\n",
2724 PL_sawampersand ? "Enabling" : "Omitting",
2725 (unsigned int)(PL_sawampersand)));
2727 if (!PL_restartop) {
2729 if (DEBUG_x_TEST || DEBUG_B_TEST)
2730 dump_all_perl(!DEBUG_B_TEST);
2732 PERL_DEBUG(PerlIO_printf(Perl_debug_log, "\nEXECUTING...\n\n"));
2736 PerlIO_printf(Perl_error_log, "%s syntax OK\n", PL_origfilename);
2739 if (PERLDB_SINGLE && PL_DBsingle)
2742 PERL_SET_PHASE(PERL_PHASE_INIT);
2743 call_list(oldscope, PL_initav);
2745 #ifdef PERL_DEBUG_READONLY_OPS
2746 if (PL_main_root && PL_main_root->op_slabbed)
2747 Slab_to_ro(OpSLAB(PL_main_root));
2753 PERL_SET_PHASE(PERL_PHASE_RUN);
2756 PL_restartjmpenv = NULL;
2757 PL_op = PL_restartop;
2761 else if (PL_main_start) {
2762 CvDEPTH(PL_main_cv) = 1;
2763 PL_op = PL_main_start;
2767 NOT_REACHED; /* NOTREACHED */
2771 =head1 SV Manipulation Functions
2775 Returns the SV of the specified Perl scalar. C<flags> are passed to
2776 C<gv_fetchpv>. If C<GV_ADD> is set and the
2777 Perl variable does not exist then it will be created. If C<flags> is zero
2778 and the variable does not exist then NULL is returned.
2784 Perl_get_sv(pTHX_ const char *name, I32 flags)
2788 PERL_ARGS_ASSERT_GET_SV;
2790 gv = gv_fetchpv(name, flags, SVt_PV);
2797 =head1 Array Manipulation Functions
2801 Returns the AV of the specified Perl global or package array with the given
2802 name (so it won't work on lexical variables). C<flags> are passed
2803 to C<gv_fetchpv>. If C<GV_ADD> is set and the
2804 Perl variable does not exist then it will be created. If C<flags> is zero
2805 and the variable does not exist then NULL is returned.
2807 Perl equivalent: C<@{"$name"}>.
2813 Perl_get_av(pTHX_ const char *name, I32 flags)
2815 GV* const gv = gv_fetchpv(name, flags, SVt_PVAV);
2817 PERL_ARGS_ASSERT_GET_AV;
2827 =head1 Hash Manipulation Functions
2831 Returns the HV of the specified Perl hash. C<flags> are passed to
2832 C<gv_fetchpv>. If C<GV_ADD> is set and the
2833 Perl variable does not exist then it will be created. If C<flags> is zero
2834 and the variable does not exist then C<NULL> is returned.
2840 Perl_get_hv(pTHX_ const char *name, I32 flags)
2842 GV* const gv = gv_fetchpv(name, flags, SVt_PVHV);
2844 PERL_ARGS_ASSERT_GET_HV;
2854 =head1 CV Manipulation Functions
2856 =for apidoc get_cvn_flags
2858 Returns the CV of the specified Perl subroutine. C<flags> are passed to
2859 C<gv_fetchpvn_flags>. If C<GV_ADD> is set and the Perl subroutine does not
2860 exist then it will be declared (which has the same effect as saying
2861 C<sub name;>). If C<GV_ADD> is not set and the subroutine does not exist
2862 then NULL is returned.
2866 Uses C<strlen> to get the length of C<name>, then calls C<get_cvn_flags>.
2872 Perl_get_cvn_flags(pTHX_ const char *name, STRLEN len, I32 flags)
2874 GV* const gv = gv_fetchpvn_flags(name, len, flags, SVt_PVCV);
2876 PERL_ARGS_ASSERT_GET_CVN_FLAGS;
2878 if (gv && UNLIKELY(SvROK(gv)) && SvTYPE(SvRV((SV *)gv)) == SVt_PVCV)
2879 return (CV*)SvRV((SV *)gv);
2881 /* XXX this is probably not what they think they're getting.
2882 * It has the same effect as "sub name;", i.e. just a forward
2884 if ((flags & ~GV_NOADD_MASK) && !GvCVu(gv)) {
2885 return newSTUB(gv,0);
2892 /* Nothing in core calls this now, but we can't replace it with a macro and
2893 move it to mathoms.c as a macro would evaluate name twice. */
2895 Perl_get_cv(pTHX_ const char *name, I32 flags)
2897 PERL_ARGS_ASSERT_GET_CV;
2899 return get_cvn_flags(name, strlen(name), flags);
2902 /* Be sure to refetch the stack pointer after calling these routines. */
2906 =head1 Callback Functions
2908 =for apidoc call_argv
2910 Performs a callback to the specified named and package-scoped Perl subroutine
2911 with C<argv> (a C<NULL>-terminated array of strings) as arguments. See
2914 Approximate Perl equivalent: C<&{"$sub_name"}(@$argv)>.
2920 Perl_call_argv(pTHX_ const char *sub_name, I32 flags, char **argv)
2922 /* See G_* flags in cop.h */
2923 /* null terminated arg list */
2927 PERL_ARGS_ASSERT_CALL_ARGV;
2931 mXPUSHs(newSVpv(*argv,0));
2935 return call_pv(sub_name, flags);
2941 Performs a callback to the specified Perl sub. See L<perlcall>.
2947 Perl_call_pv(pTHX_ const char *sub_name, I32 flags)
2948 /* name of the subroutine */
2949 /* See G_* flags in cop.h */
2951 PERL_ARGS_ASSERT_CALL_PV;
2953 return call_sv(MUTABLE_SV(get_cv(sub_name, GV_ADD)), flags);
2957 =for apidoc call_method
2959 Performs a callback to the specified Perl method. The blessed object must
2960 be on the stack. See L<perlcall>.
2966 Perl_call_method(pTHX_ const char *methname, I32 flags)
2967 /* name of the subroutine */
2968 /* See G_* flags in cop.h */
2972 PERL_ARGS_ASSERT_CALL_METHOD;
2974 len = strlen(methname);
2975 sv = flags & G_METHOD_NAMED
2976 ? sv_2mortal(newSVpvn_share(methname, len,0))
2977 : newSVpvn_flags(methname, len, SVs_TEMP);
2979 return call_sv(sv, flags | G_METHOD);
2982 /* May be called with any of a CV, a GV, or an SV containing the name. */
2986 Performs a callback to the Perl sub specified by the SV.
2988 If neither the C<G_METHOD> nor C<G_METHOD_NAMED> flag is supplied, the
2989 SV may be any of a CV, a GV, a reference to a CV, a reference to a GV
2990 or C<SvPV(sv)> will be used as the name of the sub to call.
2992 If the C<G_METHOD> flag is supplied, the SV may be a reference to a CV or
2993 C<SvPV(sv)> will be used as the name of the method to call.
2995 If the C<G_METHOD_NAMED> flag is supplied, C<SvPV(sv)> will be used as
2996 the name of the method to call.
2998 Some other values are treated specially for internal use and should
3003 =for apidoc Amnh||G_METHOD
3004 =for apidoc Amnh||G_METHOD_NAMED
3010 Perl_call_sv(pTHX_ SV *sv, volatile I32 flags)
3011 /* See G_* flags in cop.h */
3014 LOGOP myop; /* fake syntax tree node */
3017 volatile I32 retval = 0;
3018 bool oldcatch = CATCH_GET;
3020 OP* const oldop = PL_op;
3023 PERL_ARGS_ASSERT_CALL_SV;
3025 if (flags & G_DISCARD) {
3029 if (!(flags & G_WANT)) {
3030 /* Backwards compatibility - as G_SCALAR was 0, it could be omitted.
3035 Zero(&myop, 1, LOGOP);
3036 if (!(flags & G_NOARGS))
3037 myop.op_flags |= OPf_STACKED;
3038 myop.op_flags |= OP_GIMME_REVERSE(flags);
3042 if (!(flags & G_METHOD_NAMED)) {
3050 if (PERLDB_SUB && PL_curstash != PL_debstash
3051 /* Handle first BEGIN of -d. */
3052 && (PL_DBcv || (PL_DBcv = GvCV(PL_DBsub)))
3053 /* Try harder, since this may have been a sighandler, thus
3054 * curstash may be meaningless. */
3055 && (SvTYPE(sv) != SVt_PVCV || CvSTASH((const CV *)sv) != PL_debstash)
3056 && !(flags & G_NODEBUG))
3057 myop.op_private |= OPpENTERSUB_DB;
3059 if (flags & (G_METHOD|G_METHOD_NAMED)) {
3060 Zero(&method_op, 1, METHOP);
3061 method_op.op_next = (OP*)&myop;
3062 PL_op = (OP*)&method_op;
3063 if ( flags & G_METHOD_NAMED ) {
3064 method_op.op_ppaddr = PL_ppaddr[OP_METHOD_NAMED];
3065 method_op.op_type = OP_METHOD_NAMED;
3066 method_op.op_u.op_meth_sv = sv;
3068 method_op.op_ppaddr = PL_ppaddr[OP_METHOD];
3069 method_op.op_type = OP_METHOD;
3071 myop.op_ppaddr = PL_ppaddr[OP_ENTERSUB];
3072 myop.op_type = OP_ENTERSUB;
3075 if (!(flags & G_EVAL)) {
3077 CALL_BODY_SUB((OP*)&myop);
3078 retval = PL_stack_sp - (PL_stack_base + oldmark);
3079 CATCH_SET(oldcatch);
3083 myop.op_other = (OP*)&myop;
3085 old_cxix = cxstack_ix;
3086 create_eval_scope(NULL, flags|G_FAKINGEVAL);
3094 CALL_BODY_SUB((OP*)&myop);
3095 retval = PL_stack_sp - (PL_stack_base + oldmark);
3096 if (!(flags & G_KEEPERR)) {
3104 /* my_exit() was called */
3105 SET_CURSTASH(PL_defstash);
3109 NOT_REACHED; /* NOTREACHED */
3112 PL_restartjmpenv = NULL;
3113 PL_op = PL_restartop;
3117 PL_stack_sp = PL_stack_base + oldmark;
3118 if ((flags & G_WANT) == G_ARRAY)
3122 *++PL_stack_sp = &PL_sv_undef;
3127 /* if we croaked, depending on how we croaked the eval scope
3128 * may or may not have already been popped */
3129 if (cxstack_ix > old_cxix) {
3130 assert(cxstack_ix == old_cxix + 1);
3131 assert(CxTYPE(CX_CUR()) == CXt_EVAL);
3132 delete_eval_scope();
3137 if (flags & G_DISCARD) {
3138 PL_stack_sp = PL_stack_base + oldmark;
3147 /* Eval a string. The G_EVAL flag is always assumed. */
3152 Tells Perl to C<eval> the string in the SV. It supports the same flags
3153 as C<call_sv>, with the obvious exception of C<G_EVAL>. See L<perlcall>.
3155 The C<G_RETHROW> flag can be used if you only need eval_sv() to
3156 execute code specified by a string, but not catch any errors.
3158 =for apidoc Amnh||G_RETHROW
3163 Perl_eval_sv(pTHX_ SV *sv, I32 flags)
3165 /* See G_* flags in cop.h */
3168 UNOP myop; /* fake syntax tree node */
3169 volatile I32 oldmark;
3170 volatile I32 retval = 0;
3172 OP* const oldop = PL_op;
3175 PERL_ARGS_ASSERT_EVAL_SV;
3177 if (flags & G_DISCARD) {
3184 Zero(&myop, 1, UNOP);
3187 oldmark = SP - PL_stack_base;
3193 if (!(flags & G_NOARGS))
3194 myop.op_flags = OPf_STACKED;
3195 myop.op_type = OP_ENTEREVAL;
3196 myop.op_flags |= OP_GIMME_REVERSE(flags);
3197 if (flags & G_KEEPERR)
3198 myop.op_flags |= OPf_SPECIAL;
3200 if (flags & G_RE_REPARSING)
3201 myop.op_private = (OPpEVAL_COPHH | OPpEVAL_RE_REPARSING);
3203 /* fail now; otherwise we could fail after the JMPENV_PUSH but
3204 * before a cx_pusheval(), which corrupts the stack after a croak */
3205 TAINT_PROPER("eval_sv()");
3211 if (PL_op == (OP*)(&myop)) {
3212 PL_op = PL_ppaddr[OP_ENTEREVAL](aTHX);
3214 goto fail; /* failed in compilation */
3217 retval = PL_stack_sp - (PL_stack_base + oldmark);
3218 if (!(flags & G_KEEPERR)) {
3226 /* my_exit() was called */
3227 SET_CURSTASH(PL_defstash);
3231 NOT_REACHED; /* NOTREACHED */
3234 PL_restartjmpenv = NULL;
3235 PL_op = PL_restartop;
3240 if (flags & G_RETHROW) {
3245 PL_stack_sp = PL_stack_base + oldmark;
3246 if ((flags & G_WANT) == G_ARRAY)
3250 *++PL_stack_sp = &PL_sv_undef;
3256 if (flags & G_DISCARD) {
3257 PL_stack_sp = PL_stack_base + oldmark;
3269 Tells Perl to C<eval> the given string in scalar context and return an SV* result.
3275 Perl_eval_pv(pTHX_ const char *p, I32 croak_on_error)
3277 SV* sv = newSVpv(p, 0);
3279 PERL_ARGS_ASSERT_EVAL_PV;
3281 if (croak_on_error) {
3283 eval_sv(sv, G_SCALAR | G_RETHROW);
3286 eval_sv(sv, G_SCALAR);
3299 /* Require a module. */
3302 =head1 Embedding Functions
3304 =for apidoc require_pv
3306 Tells Perl to C<require> the file named by the string argument. It is
3307 analogous to the Perl code C<eval "require '$file'">. It's even
3308 implemented that way; consider using load_module instead.
3313 Perl_require_pv(pTHX_ const char *pv)
3318 PERL_ARGS_ASSERT_REQUIRE_PV;
3320 PUSHSTACKi(PERLSI_REQUIRE);
3321 sv = Perl_newSVpvf(aTHX_ "require q%c%s%c", 0, pv, 0);
3322 eval_sv(sv_2mortal(sv), G_DISCARD);
3327 S_usage(pTHX) /* XXX move this out into a module ? */
3329 /* This message really ought to be max 23 lines.
3330 * Removed -h because the user already knows that option. Others? */
3332 /* Grouped as 6 lines per C string literal, to keep under the ANSI C 89
3333 minimum of 509 character string literals. */
3334 static const char * const usage_msg[] = {
3335 " -0[octal] specify record separator (\\0, if no argument)\n"
3336 " -a autosplit mode with -n or -p (splits $_ into @F)\n"
3337 " -C[number/list] enables the listed Unicode features\n"
3338 " -c check syntax only (runs BEGIN and CHECK blocks)\n"
3339 " -d[:debugger] run program under debugger\n"
3340 " -D[number/list] set debugging flags (argument is a bit mask or alphabets)\n",
3341 " -e program one line of program (several -e's allowed, omit programfile)\n"
3342 " -E program like -e, but enables all optional features\n"
3343 " -f don't do $sitelib/sitecustomize.pl at startup\n"
3344 " -F/pattern/ split() pattern for -a switch (//'s are optional)\n"
3345 " -i[extension] edit <> files in place (makes backup if extension supplied)\n"
3346 " -Idirectory specify @INC/#include directory (several -I's allowed)\n",
3347 " -l[octal] enable line ending processing, specifies line terminator\n"
3348 " -[mM][-]module execute \"use/no module...\" before executing program\n"
3349 " -n assume \"while (<>) { ... }\" loop around program\n"
3350 " -p assume loop like -n but print line also, like sed\n"
3351 " -s enable rudimentary parsing for switches after programfile\n"
3352 " -S look for programfile using PATH environment variable\n",
3353 " -t enable tainting warnings\n"
3354 " -T enable tainting checks\n"
3355 " -u dump core after parsing program\n"
3356 " -U allow unsafe operations\n"
3357 " -v print version, patchlevel and license\n"
3358 " -V[:variable] print configuration summary (or a single Config.pm variable)\n",
3359 " -w enable many useful warnings\n"
3360 " -W enable all warnings\n"
3361 " -x[directory] ignore text before #!perl line (optionally cd to directory)\n"
3362 " -X disable all warnings\n"
3364 "Run 'perldoc perl' for more help with Perl.\n\n",
3367 const char * const *p = usage_msg;
3368 PerlIO *out = PerlIO_stdout();
3371 "\nUsage: %s [switches] [--] [programfile] [arguments]\n",
3374 PerlIO_puts(out, *p++);
3378 /* convert a string of -D options (or digits) into an int.
3379 * sets *s to point to the char after the options */
3383 Perl_get_debug_opts(pTHX_ const char **s, bool givehelp)
3385 static const char * const usage_msgd[] = {
3386 " Debugging flag values: (see also -d)\n"
3387 " p Tokenizing and parsing (with v, displays parse stack)\n"
3388 " s Stack snapshots (with v, displays all stacks)\n"
3389 " l Context (loop) stack processing\n"
3390 " t Trace execution\n"
3391 " o Method and overloading resolution\n",
3392 " c String/numeric conversions\n"
3393 " P Print profiling info, source file input state\n"
3394 " m Memory and SV allocation\n"
3395 " f Format processing\n"
3396 " r Regular expression parsing and execution\n"
3397 " x Syntax tree dump\n",
3398 " u Tainting checks\n"
3399 " H Hash dump -- usurps values()\n"
3400 " X Scratchpad allocation\n"
3402 " S Op slab allocation\n"
3404 " R Include reference counts of dumped variables (eg when using -Ds)\n",
3405 " J Do not s,t,P-debug (Jump over) opcodes within package DB\n"
3406 " v Verbose: use in conjunction with other flags\n"
3407 " C Copy On Write\n"
3408 " A Consistency checks on internal structures\n"
3409 " q quiet - currently only suppresses the 'EXECUTING' message\n"
3410 " M trace smart match resolution\n"
3411 " B dump suBroutine definitions, including special Blocks like BEGIN\n",
3412 " L trace some locale setting information--for Perl core development\n",
3413 " i trace PerlIO layer processing\n",
3414 " y trace y///, tr/// compilation and execution\n",
3419 PERL_ARGS_ASSERT_GET_DEBUG_OPTS;
3422 /* if adding extra options, remember to update DEBUG_MASK */
3423 static const char debopts[] = "psltocPmfrxuUHXDSTRJvCAqMBLiy";
3425 for (; isWORDCHAR(**s); (*s)++) {
3426 const char * const d = strchr(debopts,**s);
3428 uv |= 1 << (d - debopts);
3429 else if (ckWARN_d(WARN_DEBUGGING))
3430 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3431 "invalid option -D%c, use -D'' to see choices\n", **s);
3434 else if (isDIGIT(**s)) {
3435 const char* e = *s + strlen(*s);
3436 if (grok_atoUV(*s, &uv, &e))
3438 for (; isWORDCHAR(**s); (*s)++) ;
3440 else if (givehelp) {
3441 const char *const *p = usage_msgd;
3442 while (*p) PerlIO_puts(PerlIO_stdout(), *p++);
3444 return (int)uv; /* ignore any UV->int conversion loss */
3448 /* This routine handles any switches that can be given during run */
3451 Perl_moreswitches(pTHX_ const char *s)
3455 const char option = *s; /* used to remember option in -m/-M code */
3457 PERL_ARGS_ASSERT_MORESWITCHES;
3465 SvREFCNT_dec(PL_rs);
3466 if (s[1] == 'x' && s[2]) {
3467 const char *e = s+=2;
3473 flags = PERL_SCAN_SILENT_ILLDIGIT;
3474 rschar = (U32)grok_hex(s, &numlen, &flags, NULL);
3475 if (s + numlen < e) {
3476 rschar = 0; /* Grandfather -0xFOO as -0 -xFOO. */
3480 PL_rs = newSVpvs("");
3481 tmps = (U8*) SvGROW(PL_rs, (STRLEN)(UVCHR_SKIP(rschar) + 1));
3482 uvchr_to_utf8(tmps, rschar);
3483 SvCUR_set(PL_rs, UVCHR_SKIP(rschar));
3488 rschar = (U32)grok_oct(s, &numlen, &flags, NULL);
3489 if (rschar & ~((U8)~0))
3490 PL_rs = &PL_sv_undef;
3491 else if (!rschar && numlen >= 2)
3492 PL_rs = newSVpvs("");
3494 char ch = (char)rschar;
3495 PL_rs = newSVpvn(&ch, 1);
3498 sv_setsv(get_sv("/", GV_ADD), PL_rs);
3503 PL_unicode = parse_unicode_opts( (const char **)&s );
3504 if (PL_unicode & PERL_UNICODE_UTF8CACHEASSERT_FLAG)
3512 while (*s && !isSPACE(*s)) ++s;
3513 PL_splitstr = savepvn(PL_splitstr, s - PL_splitstr);
3525 forbid_setid('d', FALSE);
3528 /* -dt indicates to the debugger that threads will be used */
3529 if (*s == 't' && !isWORDCHAR(s[1])) {
3531 my_setenv("PERL5DB_THREADED", "1");
3534 /* The following permits -d:Mod to accepts arguments following an =
3535 in the fashion that -MSome::Mod does. */
3536 if (*s == ':' || *s == '=') {
3543 sv = newSVpvs("no Devel::");
3545 sv = newSVpvs("use Devel::");
3549 end = s + strlen(s);
3551 /* We now allow -d:Module=Foo,Bar and -d:-Module */
3552 while(isWORDCHAR(*s) || *s==':') ++s;
3554 sv_catpvn(sv, start, end - start);
3556 sv_catpvn(sv, start, s-start);
3557 /* Don't use NUL as q// delimiter here, this string goes in the
3559 Perl_sv_catpvf(aTHX_ sv, " split(/,/,q{%s});", ++s);
3562 my_setenv("PERL5DB", SvPV_nolen_const(sv));
3566 PL_perldb = PERLDB_ALL;
3573 forbid_setid('D', FALSE);
3575 PL_debug = get_debug_opts( (const char **)&s, 1) | DEBUG_TOP_FLAG;
3576 #else /* !DEBUGGING */
3577 if (ckWARN_d(WARN_DEBUGGING))
3578 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3579 "Recompile perl with -DDEBUGGING to use -D switch (did you mean -d ?)\n");
3580 for (s++; isWORDCHAR(*s); s++) ;
3583 NOT_REACHED; /* NOTREACHED */
3587 NOT_REACHED; /* NOTREACHED */
3590 Safefree(PL_inplace);
3592 const char * const start = ++s;
3593 while (*s && !isSPACE(*s))
3596 PL_inplace = savepvn(start, s - start);
3599 case 'I': /* -I handled both here and in parse_body() */
3600 forbid_setid('I', FALSE);
3602 while (*s && isSPACE(*s))
3607 /* ignore trailing spaces (possibly followed by other switches) */
3609 for (e = p; *e && !isSPACE(*e); e++) ;
3613 } while (*p && *p != '-');
3615 INCPUSH_ADD_SUB_DIRS|INCPUSH_ADD_OLD_VERS|INCPUSH_UNSHIFT);
3621 Perl_croak(aTHX_ "No directory specified for -I");
3627 SvREFCNT_dec(PL_ors_sv);
3633 PL_ors_sv = newSVpvs("\n");
3634 numlen = 3 + (*s == '0');
3635 *SvPVX(PL_ors_sv) = (char)grok_oct(s, &numlen, &flags, NULL);
3639 if (RsPARA(PL_rs)) {
3640 PL_ors_sv = newSVpvs("\n\n");
3643 PL_ors_sv = newSVsv(PL_rs);
3648 forbid_setid('M', FALSE); /* XXX ? */
3651 forbid_setid('m', FALSE); /* XXX ? */
3656 const char *use = "use ";
3658 /* -M-foo == 'no foo' */
3659 /* Leading space on " no " is deliberate, to make both
3660 possibilities the same length. */
3661 if (*s == '-') { use = " no "; ++s; }
3662 sv = newSVpvn(use,4);
3664 /* We allow -M'Module qw(Foo Bar)' */
3665 while(isWORDCHAR(*s) || *s==':') {
3674 Perl_croak(aTHX_ "Module name required with -%c option",
3677 Perl_croak(aTHX_ "Invalid module name %.*s with -%c option: "
3678 "contains single ':'",
3679 (int)(s - start), start, option);
3680 end = s + strlen(s);
3682 sv_catpvn(sv, start, end - start);
3683 if (option == 'm') {
3685 Perl_croak(aTHX_ "Can't use '%c' after -mname", *s);
3686 sv_catpvs( sv, " ()");
3689 sv_catpvn(sv, start, s-start);
3690 /* Use NUL as q''-delimiter. */
3691 sv_catpvs(sv, " split(/,/,q\0");
3693 sv_catpvn(sv, s, end - s);
3694 sv_catpvs(sv, "\0)");
3697 Perl_av_create_and_push(aTHX_ &PL_preambleav, sv);
3700 Perl_croak(aTHX_ "Missing argument to -%c", option);
3711 forbid_setid('s', FALSE);
3712 PL_doswitches = TRUE;
3717 #if defined(SILENT_NO_TAINT_SUPPORT)
3718 /* silently ignore */
3719 #elif defined(NO_TAINT_SUPPORT)
3720 Perl_croak_nocontext("This perl was compiled without taint support. "
3721 "Cowardly refusing to run with -t or -T flags");
3729 PL_do_undump = TRUE;
3739 if (! (PL_dowarn & G_WARN_ALL_MASK)) {
3740 PL_dowarn |= G_WARN_ON;
3745 PL_dowarn = G_WARN_ALL_ON|G_WARN_ON;
3746 if (!specialWARN(PL_compiling.cop_warnings))
3747 PerlMemShared_free(PL_compiling.cop_warnings);
3748 PL_compiling.cop_warnings = pWARN_ALL ;
3752 PL_dowarn = G_WARN_ALL_OFF;
3753 if (!specialWARN(PL_compiling.cop_warnings))
3754 PerlMemShared_free(PL_compiling.cop_warnings);
3755 PL_compiling.cop_warnings = pWARN_NONE ;
3762 if (s[0] == '-') /* Additional switches on #! line. */
3767 #if defined(WIN32) || !defined(PERL_STRICT_CR)
3773 #ifdef ALTERNATE_SHEBANG
3774 case 'S': /* OS/2 needs -S on "extproc" line. */
3777 case 'e': case 'f': case 'x': case 'E':
3778 #ifndef ALTERNATE_SHEBANG
3782 Perl_croak(aTHX_ "Can't emulate -%.1s on #! line",s);
3785 "Unrecognized switch: -%.1s (-h will show valid options)",s
3795 PerlIO * PIO_stdout;
3797 const char * const level_str = "v" PERL_VERSION_STRING;
3798 const STRLEN level_len = sizeof("v" PERL_VERSION_STRING)-1;
3799 #ifdef PERL_PATCHNUM
3801 # ifdef PERL_GIT_UNCOMMITTED_CHANGES
3802 static const char num [] = PERL_PATCHNUM "*";
3804 static const char num [] = PERL_PATCHNUM;
3807 const STRLEN num_len = sizeof(num)-1;
3808 /* A very advanced compiler would fold away the strnEQ
3809 and this whole conditional, but most (all?) won't do it.
3810 SV level could also be replaced by with preprocessor
3813 if (num_len >= level_len && strnEQ(num,level_str,level_len)) {
3814 /* per 46807d8e80, PERL_PATCHNUM is outside of the control
3815 of the interp so it might contain format characters
3817 level = newSVpvn(num, num_len);
3819 level = Perl_newSVpvf_nocontext("%s (%s)", level_str, num);
3823 SV* level = newSVpvn(level_str, level_len);
3824 #endif /* #ifdef PERL_PATCHNUM */
3825 PIO_stdout = PerlIO_stdout();
3826 PerlIO_printf(PIO_stdout,
3827 "\nThis is perl " STRINGIFY(PERL_REVISION)
3828 ", version " STRINGIFY(PERL_VERSION)
3829 ", subversion " STRINGIFY(PERL_SUBVERSION)
3830 " (%" SVf ") built for " ARCHNAME, SVfARG(level)
3832 SvREFCNT_dec_NN(level);
3834 #if defined(LOCAL_PATCH_COUNT)
3835 if (LOCAL_PATCH_COUNT > 0)
3836 PerlIO_printf(PIO_stdout,
3837 "\n(with %d registered patch%s, "
3838 "see perl -V for more detail)",
3840 (LOCAL_PATCH_COUNT!=1) ? "es" : "");
3843 PerlIO_printf(PIO_stdout,
3844 "\n\nCopyright 1987-2020, Larry Wall\n");
3846 PerlIO_printf(PIO_stdout,
3847 "\nMS-DOS port Copyright (c) 1989, 1990, Diomidis Spinellis\n");
3850 PerlIO_printf(PIO_stdout,
3851 "djgpp v2 port (jpl5003c) by Hirofumi Watanabe, 1996\n"
3852 "djgpp v2 port (perl5004+) by Laszlo Molnar, 1997-1999\n");
3855 PerlIO_printf(PIO_stdout,
3856 "\n\nOS/2 port Copyright (c) 1990, 1991, Raymond Chen, Kai Uwe Rommel\n"
3857 "Version 5 port Copyright (c) 1994-2002, Andreas Kaiser, Ilya Zakharevich\n");
3860 PerlIO_printf(PIO_stdout,
3861 "MVS (OS390) port by Mortice Kern Systems, 1997-1999\n");
3864 PerlIO_printf(PIO_stdout,
3865 "Stratus OpenVOS port by Paul.Green@stratus.com, 1997-2013\n");
3868 PerlIO_printf(PIO_stdout,
3869 "BS2000 (POSIX) port by Start Amadeus GmbH, 1998-1999\n");
3871 #ifdef __SYMBIAN32__
3872 PerlIO_printf(PIO_stdout,
3873 "Symbian port by Nokia, 2004-2005\n");
3875 #ifdef BINARY_BUILD_NOTICE
3876 BINARY_BUILD_NOTICE;
3878 PerlIO_printf(PIO_stdout,
3880 Perl may be copied only under the terms of either the Artistic License or the\n\
3881 GNU General Public License, which may be found in the Perl 5 source kit.\n\n\
3882 Complete documentation for Perl, including FAQ lists, should be found on\n\
3883 this system using \"man perl\" or \"perldoc perl\". If you have access to the\n\
3884 Internet, point your browser at http://www.perl.org/, the Perl Home Page.\n\n");
3888 /* compliments of Tom Christiansen */
3890 /* unexec() can be found in the Gnu emacs distribution */
3891 /* Known to work with -DUNEXEC and using unexelf.c from GNU emacs-20.2 */
3894 #include <lib$routines.h>
3898 Perl_my_unexec(pTHX)
3901 SV * prog = newSVpv(BIN_EXP, 0);
3902 SV * file = newSVpv(PL_origfilename, 0);
3906 sv_catpvs(prog, "/perl");
3907 sv_catpvs(file, ".perldump");
3909 unexec(SvPVX(file), SvPVX(prog), &etext, sbrk(0), 0);
3910 /* unexec prints msg to stderr in case of failure */
3911 PerlProc_exit(status);
3913 PERL_UNUSED_CONTEXT;
3915 lib$signal(SS$_DEBUG); /* ssdef.h #included from vmsish.h */
3916 # elif defined(WIN32) || defined(__CYGWIN__)
3917 Perl_croak_nocontext("dump is not supported");
3919 ABORT(); /* for use with undump */
3924 /* initialize curinterp */
3929 # define PERLVAR(prefix,var,type)
3930 # define PERLVARA(prefix,var,n,type)
3931 # if defined(PERL_IMPLICIT_CONTEXT)
3932 # define PERLVARI(prefix,var,type,init) aTHX->prefix##var = init;
3933 # define PERLVARIC(prefix,var,type,init) aTHX->prefix##var = init;
3935 # define PERLVARI(prefix,var,type,init) PERL_GET_INTERP->var = init;
3936 # define PERLVARIC(prefix,var,type,init) PERL_GET_INTERP->var = init;
3938 # include "intrpvar.h"
3944 # define PERLVAR(prefix,var,type)
3945 # define PERLVARA(prefix,var,n,type)
3946 # define PERLVARI(prefix,var,type,init) PL_##var = init;
3947 # define PERLVARIC(prefix,var,type,init) PL_##var = init;
3948 # include "intrpvar.h"
3958 S_init_main_stash(pTHX)
3963 PL_curstash = PL_defstash = (HV *)SvREFCNT_inc_simple_NN(hv);
3964 /* We know that the string "main" will be in the global shared string
3965 table, so it's a small saving to use it rather than allocate another
3967 PL_curstname = newSVpvs_share("main");
3968 gv = gv_fetchpvs("main::", GV_ADD|GV_NOTQUAL, SVt_PVHV);
3969 /* If we hadn't caused another reference to "main" to be in the shared
3970 string table above, then it would be worth reordering these two,
3971 because otherwise all we do is delete "main" from it as a consequence
3972 of the SvREFCNT_dec, only to add it again with hv_name_set */
3973 SvREFCNT_dec(GvHV(gv));
3974 hv_name_sets(PL_defstash, "main", 0);
3975 GvHV(gv) = MUTABLE_HV(SvREFCNT_inc_simple(PL_defstash));
3977 PL_incgv = gv_HVadd(gv_AVadd(gv_fetchpvs("INC", GV_ADD|GV_NOTQUAL,
3979 SvREFCNT_inc_simple_void(PL_incgv); /* Don't allow it to be freed */
3980 GvMULTI_on(PL_incgv);
3981 PL_hintgv = gv_fetchpvs("\010", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^H */
3982 SvREFCNT_inc_simple_void(PL_hintgv);
3983 GvMULTI_on(PL_hintgv);
3984 PL_defgv = gv_fetchpvs("_", GV_ADD|GV_NOTQUAL, SVt_PVAV);
3985 SvREFCNT_inc_simple_void(PL_defgv);
3986 PL_errgv = gv_fetchpvs("@", GV_ADD|GV_NOTQUAL, SVt_PV);
3987 SvREFCNT_inc_simple_void(PL_errgv);
3988 GvMULTI_on(PL_errgv);
3989 PL_replgv = gv_fetchpvs("\022", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^R */
3990 SvREFCNT_inc_simple_void(PL_replgv);
3991 GvMULTI_on(PL_replgv);
3992 (void)Perl_form(aTHX_ "%240s",""); /* Preallocate temp - for immediate signals. */
3993 #ifdef PERL_DONT_CREATE_GVSV
3994 (void)gv_SVadd(PL_errgv);
3996 sv_grow(ERRSV, 240); /* Preallocate - for immediate signals. */
3998 CopSTASH_set(&PL_compiling, PL_defstash);
3999 PL_debstash = GvHV(gv_fetchpvs("DB::", GV_ADDMULTI, SVt_PVHV));
4000 PL_globalstash = GvHV(gv_fetchpvs("CORE::GLOBAL::", GV_ADDMULTI,
4002 /* We must init $/ before switches are processed. */
4003 sv_setpvs(get_sv("/", GV_ADD), "\n");
4007 S_open_script(pTHX_ const char *scriptname, bool dosearch, bool *suidscript)
4010 PerlIO *rsfp = NULL;
4014 PERL_ARGS_ASSERT_OPEN_SCRIPT;
4017 PL_origfilename = savepvs("-e");
4022 /* if find_script() returns, it returns a malloc()-ed value */
4023 scriptname = PL_origfilename = find_script(scriptname, dosearch, NULL, 1);
4024 s = scriptname + strlen(scriptname);
4026 if (strBEGINs(scriptname, "/dev/fd/")
4027 && isDIGIT(scriptname[8])
4028 && grok_atoUV(scriptname + 8, &uv, &s)
4029 && uv <= PERL_INT_MAX
4034 * Tell apart "normal" usage of fdscript, e.g.
4035 * with bash on FreeBSD:
4036 * perl <( echo '#!perl -DA'; echo 'print "$0\n"')
4037 * from usage in suidperl.
4038 * Does any "normal" usage leave garbage after the number???
4039 * Is it a mistake to use a similar /dev/fd/ construct for
4044 * Be supersafe and do some sanity-checks.
4045 * Still, can we be sure we got the right thing?
4048 Perl_croak(aTHX_ "Wrong syntax (suid) fd script name \"%s\"\n", s);
4051 Perl_croak(aTHX_ "Missing (suid) fd script name\n");
4053 scriptname = savepv(s + 1);
4054 Safefree(PL_origfilename);
4055 PL_origfilename = (char *)scriptname;
4060 CopFILE_free(PL_curcop);
4061 CopFILE_set(PL_curcop, PL_origfilename);
4062 if (*PL_origfilename == '-' && PL_origfilename[1] == '\0')
4063 scriptname = (char *)"";
4064 if (fdscript >= 0) {
4065 rsfp = PerlIO_fdopen(fdscript,PERL_SCRIPT_MODE);
4067 else if (!*scriptname) {
4068 forbid_setid(0, *suidscript);
4072 #ifdef FAKE_BIT_BUCKET
4073 /* This hack allows one not to have /dev/null (or BIT_BUCKET as it
4074 * is called) and still have the "-e" work. (Believe it or not,
4075 * a /dev/null is required for the "-e" to work because source
4076 * filter magic is used to implement it. ) This is *not* a general
4077 * replacement for a /dev/null. What we do here is create a temp
4078 * file (an empty file), open up that as the script, and then
4079 * immediately close and unlink it. Close enough for jazz. */
4080 #define FAKE_BIT_BUCKET_PREFIX "/tmp/perlnull-"
4081 #define FAKE_BIT_BUCKET_SUFFIX "XXXXXXXX"
4082 #define FAKE_BIT_BUCKET_TEMPLATE FAKE_BIT_BUCKET_PREFIX FAKE_BIT_BUCKET_SUFFIX
4083 char tmpname[sizeof(FAKE_BIT_BUCKET_TEMPLATE)] = {
4084 FAKE_BIT_BUCKET_TEMPLATE
4086 const char * const err = "Failed to create a fake bit bucket";
4087 if (strEQ(scriptname, BIT_BUCKET)) {
4088 int tmpfd = Perl_my_mkstemp_cloexec(tmpname);
4090 scriptname = tmpname;
4093 Perl_croak(aTHX_ err);
4096 rsfp = PerlIO_open(scriptname,PERL_SCRIPT_MODE);
4097 #ifdef FAKE_BIT_BUCKET
4098 if ( strBEGINs(scriptname, FAKE_BIT_BUCKET_PREFIX)
4099 && strlen(scriptname) == sizeof(tmpname) - 1)
4103 scriptname = BIT_BUCKET;
4107 /* PSz 16 Sep 03 Keep neat error message */
4109 Perl_croak(aTHX_ "Can't open " BIT_BUCKET ": %s\n", Strerror(errno));
4111 Perl_croak(aTHX_ "Can't open perl script \"%s\": %s\n",
4112 CopFILE(PL_curcop), Strerror(errno));
4114 fd = PerlIO_fileno(rsfp);
4117 (PerlLIO_fstat(fd, &tmpstatbuf) >= 0
4118 && S_ISDIR(tmpstatbuf.st_mode)))
4119 Perl_croak(aTHX_ "Can't open perl script \"%s\": %s\n",
4126 /* In the days of suidperl, we refused to execute a setuid script stored on
4127 * a filesystem mounted nosuid and/or noexec. This meant that we probed for the
4128 * existence of the appropriate filesystem-statting function, and behaved
4129 * accordingly. But even though suidperl is long gone, we must still include
4130 * those probes for the benefit of modules like Filesys::Df, which expect the
4131 * results of those probes to be stored in %Config; see RT#126368. So mention
4132 * the relevant cpp symbols here, to ensure that metaconfig will include their
4133 * probes in the generated Configure:
4135 * I_SYSSTATVFS HAS_FSTATVFS
4137 * I_STATFS HAS_FSTATFS HAS_GETFSSTAT
4138 * I_MNTENT HAS_GETMNTENT HAS_HASMNTOPT
4142 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
4143 /* Don't even need this function. */
4146 S_validate_suid(pTHX_ PerlIO *rsfp)
4148 const Uid_t my_uid = PerlProc_getuid();
4149 const Uid_t my_euid = PerlProc_geteuid();
4150 const Gid_t my_gid = PerlProc_getgid();
4151 const Gid_t my_egid = PerlProc_getegid();
4153 PERL_ARGS_ASSERT_VALIDATE_SUID;
4155 if (my_euid != my_uid || my_egid != my_gid) { /* (suidperl doesn't exist, in fact) */
4157 int fd = PerlIO_fileno(rsfp);
4159 if (fd < 0 || PerlLIO_fstat(fd, &statbuf) < 0) { /* may be either wrapped or real suid */
4160 Perl_croak_nocontext( "Illegal suidscript");
4162 if ((my_euid != my_uid && my_euid == statbuf.st_uid && statbuf.st_mode & S_ISUID)
4164 (my_egid != my_gid && my_egid == statbuf.st_gid && statbuf.st_mode & S_ISGID)
4167 Perl_croak(aTHX_ "YOU HAVEN'T DISABLED SET-ID SCRIPTS IN THE KERNEL YET!\n\
4168 FIX YOUR KERNEL, PUT A C WRAPPER AROUND THIS SCRIPT, OR USE -u AND UNDUMP!\n");
4169 /* not set-id, must be wrapped */
4172 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4175 S_find_beginning(pTHX_ SV* linestr_sv, PerlIO *rsfp)
4180 PERL_ARGS_ASSERT_FIND_BEGINNING;
4182 /* skip forward in input to the real script? */
4185 if ((s = sv_gets(linestr_sv, rsfp, 0)) == NULL)
4186 Perl_croak(aTHX_ "No Perl script found in input\n");
4188 } while (!(*s == '#' && s[1] == '!' && ((s = instr(s,"perl")) || (s = instr(s2,"PERL")))));
4189 PerlIO_ungetc(rsfp, '\n'); /* to keep line count right */
4190 while (*s && !(isSPACE (*s) || *s == '#')) s++;
4192 while (*s == ' ' || *s == '\t') s++;
4194 while (isDIGIT(s2[-1]) || s2[-1] == '-' || s2[-1] == '.'
4195 || s2[-1] == '_') s2--;
4196 if (strBEGINs(s2-4,"perl"))
4197 while ((s = moreswitches(s)))
4206 /* no need to do anything here any more if we don't
4208 #ifndef NO_TAINT_SUPPORT
4209 const Uid_t my_uid = PerlProc_getuid();
4210 const Uid_t my_euid = PerlProc_geteuid();
4211 const Gid_t my_gid = PerlProc_getgid();
4212 const Gid_t my_egid = PerlProc_getegid();
4214 PERL_UNUSED_CONTEXT;
4216 /* Should not happen: */
4217 CHECK_MALLOC_TAINT(my_uid && (my_euid != my_uid || my_egid != my_gid));
4218 TAINTING_set( TAINTING_get | (my_uid && (my_euid != my_uid || my_egid != my_gid)) );
4222 * Should go by suidscript, not uid!=euid: why disallow
4223 * system("ls") in scripts run from setuid things?
4224 * Or, is this run before we check arguments and set suidscript?
4225 * What about SETUID_SCRIPTS_ARE_SECURE_NOW: could we use fdscript then?
4226 * (We never have suidscript, can we be sure to have fdscript?)
4227 * Or must then go by UID checks? See comments in forbid_setid also.
4231 /* This is used very early in the lifetime of the program,
4232 * before even the options are parsed, so PL_tainting has
4233 * not been initialized properly. */
4235 Perl_doing_taint(int argc, char *argv[], char *envp[])
4237 #ifndef PERL_IMPLICIT_SYS
4238 /* If we have PERL_IMPLICIT_SYS we can't call getuid() et alia
4239 * before we have an interpreter-- and the whole point of this
4240 * function is to be called at such an early stage. If you are on
4241 * a system with PERL_IMPLICIT_SYS but you do have a concept of
4242 * "tainted because running with altered effective ids', you'll
4243 * have to add your own checks somewhere in here. The two most
4244 * known samples of 'implicitness' are Win32 and NetWare, neither
4245 * of which has much of concept of 'uids'. */
4246 Uid_t uid = PerlProc_getuid();
4247 Uid_t euid = PerlProc_geteuid();
4248 Gid_t gid = PerlProc_getgid();
4249 Gid_t egid = PerlProc_getegid();
4256 if (uid && (euid != uid || egid != gid))
4258 #endif /* !PERL_IMPLICIT_SYS */
4259 /* This is a really primitive check; environment gets ignored only
4260 * if -T are the first chars together; otherwise one gets
4261 * "Too late" message. */
4262 if ( argc > 1 && argv[1][0] == '-'
4263 && isALPHA_FOLD_EQ(argv[1][1], 't'))
4268 /* Passing the flag as a single char rather than a string is a slight space
4269 optimisation. The only message that isn't /^-.$/ is
4270 "program input from stdin", which is substituted in place of '\0', which
4271 could never be a command line flag. */
4273 S_forbid_setid(pTHX_ const char flag, const bool suidscript) /* g */
4275 char string[3] = "-x";
4276 const char *message = "program input from stdin";
4278 PERL_UNUSED_CONTEXT;
4284 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
4285 if (PerlProc_getuid() != PerlProc_geteuid())
4286 Perl_croak(aTHX_ "No %s allowed while running setuid", message);
4287 if (PerlProc_getgid() != PerlProc_getegid())
4288 Perl_croak(aTHX_ "No %s allowed while running setgid", message);
4289 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4291 Perl_croak(aTHX_ "No %s allowed with (suid) fdscript", message);
4295 Perl_init_dbargs(pTHX)
4297 AV *const args = PL_dbargs = GvAV(gv_AVadd((gv_fetchpvs("DB::args",
4302 /* Someone has already created it.
4303 It might have entries, and if we just turn off AvREAL(), they will
4304 "leak" until global destruction. */
4306 if (SvTIED_mg((const SV *)args, PERL_MAGIC_tied))
4307 Perl_croak(aTHX_ "Cannot set tied @DB::args");
4309 AvREIFY_only(PL_dbargs);
4313 Perl_init_debugger(pTHX)
4315 HV * const ostash = PL_curstash;
4318 PL_curstash = (HV *)SvREFCNT_inc_simple(PL_debstash);
4320 Perl_init_dbargs(aTHX);
4321 PL_DBgv = MUTABLE_GV(
4322 SvREFCNT_inc(gv_fetchpvs("DB::DB", GV_ADDMULTI, SVt_PVGV))
4324 PL_DBline = MUTABLE_GV(
4325 SvREFCNT_inc(gv_fetchpvs("DB::dbline", GV_ADDMULTI, SVt_PVAV))
4327 PL_DBsub = MUTABLE_GV(SvREFCNT_inc(
4328 gv_HVadd(gv_fetchpvs("DB::sub", GV_ADDMULTI, SVt_PVHV))
4330 PL_DBsingle = GvSV((gv_fetchpvs("DB::single", GV_ADDMULTI, SVt_PV)));
4331 if (!SvIOK(PL_DBsingle))
4332 sv_setiv(PL_DBsingle, 0);
4333 mg = sv_magicext(PL_DBsingle, NULL, PERL_MAGIC_debugvar, &PL_vtbl_debugvar, 0, 0);
4334 mg->mg_private = DBVARMG_SINGLE;
4335 SvSETMAGIC(PL_DBsingle);
4337 PL_DBtrace = GvSV((gv_fetchpvs("DB::trace", GV_ADDMULTI, SVt_PV)));
4338 if (!SvIOK(PL_DBtrace))
4339 sv_setiv(PL_DBtrace, 0);
4340 mg = sv_magicext(PL_DBtrace, NULL, PERL_MAGIC_debugvar, &PL_vtbl_debugvar, 0, 0);
4341 mg->mg_private = DBVARMG_TRACE;
4342 SvSETMAGIC(PL_DBtrace);
4344 PL_DBsignal = GvSV((gv_fetchpvs("DB::signal", GV_ADDMULTI, SVt_PV)));
4345 if (!SvIOK(PL_DBsignal))
4346 sv_setiv(PL_DBsignal, 0);
4347 mg = sv_magicext(PL_DBsignal, NULL, PERL_MAGIC_debugvar, &PL_vtbl_debugvar, 0, 0);
4348 mg->mg_private = DBVARMG_SIGNAL;
4349 SvSETMAGIC(PL_DBsignal);
4351 SvREFCNT_dec(PL_curstash);
4352 PL_curstash = ostash;
4355 #ifndef STRESS_REALLOC
4356 #define REASONABLE(size) (size)
4357 #define REASONABLE_but_at_least(size,min) (size)
4359 #define REASONABLE(size) (1) /* unreasonable */
4360 #define REASONABLE_but_at_least(size,min) (min)
4364 Perl_init_stacks(pTHX)
4368 /* start with 128-item stack and 8K cxstack */
4369 PL_curstackinfo = new_stackinfo(REASONABLE(128),
4370 REASONABLE(8192/sizeof(PERL_CONTEXT) - 1));
4371 PL_curstackinfo->si_type = PERLSI_MAIN;
4372 #if defined DEBUGGING && !defined DEBUGGING_RE_ONLY
4373 PL_curstackinfo->si_stack_hwm = 0;
4375 PL_curstack = PL_curstackinfo->si_stack;
4376 PL_mainstack = PL_curstack; /* remember in case we switch stacks */
4378 PL_stack_base = AvARRAY(PL_curstack);
4379 PL_stack_sp = PL_stack_base;
4380 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
4382 Newx(PL_tmps_stack,REASONABLE(128),SV*);
4385 PL_tmps_max = REASONABLE(128);
4387 Newx(PL_markstack,REASONABLE(32),I32);
4388 PL_markstack_ptr = PL_markstack;
4389 PL_markstack_max = PL_markstack + REASONABLE(32);
4393 Newx(PL_scopestack,REASONABLE(32),I32);
4395 Newx(PL_scopestack_name,REASONABLE(32),const char*);
4397 PL_scopestack_ix = 0;
4398 PL_scopestack_max = REASONABLE(32);
4400 size = REASONABLE_but_at_least(128,SS_MAXPUSH);
4401 Newx(PL_savestack, size, ANY);
4402 PL_savestack_ix = 0;
4403 /*PL_savestack_max lies: it always has SS_MAXPUSH more than it claims */
4404 PL_savestack_max = size - SS_MAXPUSH;
4412 while (PL_curstackinfo->si_next)
4413 PL_curstackinfo = PL_curstackinfo->si_next;
4414 while (PL_curstackinfo) {
4415 PERL_SI *p = PL_curstackinfo->si_prev;
4416 /* curstackinfo->si_stack got nuked by sv_free_arenas() */
4417 Safefree(PL_curstackinfo->si_cxstack);
4418 Safefree(PL_curstackinfo);
4419 PL_curstackinfo = p;
4421 Safefree(PL_tmps_stack);
4422 Safefree(PL_markstack);
4423 Safefree(PL_scopestack);
4425 Safefree(PL_scopestack_name);
4427 Safefree(PL_savestack);
4431 Perl_populate_isa(pTHX_ const char *name, STRLEN len, ...)
4433 GV *const gv = gv_fetchpvn(name, len, GV_ADD | GV_ADDMULTI, SVt_PVAV);
4434 AV *const isa = GvAVn(gv);
4437 PERL_ARGS_ASSERT_POPULATE_ISA;
4439 if(AvFILLp(isa) != -1)
4442 /* NOTE: No support for tied ISA */
4444 va_start(args, len);
4446 const char *const parent = va_arg(args, const char*);
4451 parent_len = va_arg(args, size_t);
4453 /* Arguments are supplied with a trailing :: */
4454 assert(parent_len > 2);
4455 assert(parent[parent_len - 1] == ':');
4456 assert(parent[parent_len - 2] == ':');
4457 av_push(isa, newSVpvn(parent, parent_len - 2));
4458 (void) gv_fetchpvn(parent, parent_len, GV_ADD, SVt_PVGV);
4465 S_init_predump_symbols(pTHX)
4470 sv_setpvs(get_sv("\"", GV_ADD), " ");
4471 PL_ofsgv = (GV*)SvREFCNT_inc(gv_fetchpvs(",", GV_ADD|GV_NOTQUAL, SVt_PV));
4474 /* Historically, PVIOs were blessed into IO::Handle, unless
4475 FileHandle was loaded, in which case they were blessed into
4476 that. Action at a distance.
4477 However, if we simply bless into IO::Handle, we break code
4478 that assumes that PVIOs will have (among others) a seek
4479 method. IO::File inherits from IO::Handle and IO::Seekable,
4480 and provides the needed methods. But if we simply bless into
4481 it, then we break code that assumed that by loading
4482 IO::Handle, *it* would work.
4483 So a compromise is to set up the correct @IO::File::ISA,
4484 so that code that does C<use IO::Handle>; will still work.
4487 Perl_populate_isa(aTHX_ STR_WITH_LEN("IO::File::ISA"),
4488 STR_WITH_LEN("IO::Handle::"),
4489 STR_WITH_LEN("IO::Seekable::"),
4490 STR_WITH_LEN("Exporter::"),
4493 PL_stdingv = gv_fetchpvs("STDIN", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4494 GvMULTI_on(PL_stdingv);
4495 io = GvIOp(PL_stdingv);
4496 IoTYPE(io) = IoTYPE_RDONLY;
4497 IoIFP(io) = PerlIO_stdin();
4498 tmpgv = gv_fetchpvs("stdin", GV_ADD|GV_NOTQUAL, SVt_PV);
4500 GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4502 tmpgv = gv_fetchpvs("STDOUT", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4505 IoTYPE(io) = IoTYPE_WRONLY;
4506 IoOFP(io) = IoIFP(io) = PerlIO_stdout();
4508 tmpgv = gv_fetchpvs("stdout", GV_ADD|GV_NOTQUAL, SVt_PV);
4510 GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4512 PL_stderrgv = gv_fetchpvs("STDERR", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4513 GvMULTI_on(PL_stderrgv);
4514 io = GvIOp(PL_stderrgv);
4515 IoTYPE(io) = IoTYPE_WRONLY;
4516 IoOFP(io) = IoIFP(io) = PerlIO_stderr();
4517 tmpgv = gv_fetchpvs("stderr", GV_ADD|GV_NOTQUAL, SVt_PV);
4519 GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4521 PL_statname = newSVpvs(""); /* last filename we did stat on */
4525 Perl_init_argv_symbols(pTHX_ int argc, char **argv)
4527 PERL_ARGS_ASSERT_INIT_ARGV_SYMBOLS;
4529 argc--,argv++; /* skip name of script */
4530 if (PL_doswitches) {
4531 for (; argc > 0 && **argv == '-'; argc--,argv++) {
4535 if (argv[0][1] == '-' && !argv[0][2]) {
4539 if ((s = strchr(argv[0], '='))) {
4540 const char *const start_name = argv[0] + 1;
4541 sv_setpv(GvSV(gv_fetchpvn_flags(start_name, s - start_name,
4542 TRUE, SVt_PV)), s + 1);
4545 sv_setiv(GvSV(gv_fetchpv(argv[0]+1, GV_ADD, SVt_PV)),1);
4548 if ((PL_argvgv = gv_fetchpvs("ARGV", GV_ADD|GV_NOTQUAL, SVt_PVAV))) {
4549 SvREFCNT_inc_simple_void_NN(PL_argvgv);
4550 GvMULTI_on(PL_argvgv);
4551 av_clear(GvAVn(PL_argvgv));
4552 for (; argc > 0; argc--,argv++) {
4553 SV * const sv = newSVpv(argv[0],0);
4554 av_push(GvAV(PL_argvgv),sv);
4555 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
4556 if (PL_unicode & PERL_UNICODE_ARGV_FLAG)
4559 if (PL_unicode & PERL_UNICODE_WIDESYSCALLS_FLAG) /* Sarathy? */
4560 (void)sv_utf8_decode(sv);
4564 if (PL_inplace && (!PL_argvgv || AvFILL(GvAV(PL_argvgv)) == -1))
4565 Perl_ck_warner_d(aTHX_ packWARN(WARN_INPLACE),
4566 "-i used with no filenames on the command line, "
4567 "reading from STDIN");
4571 S_init_postdump_symbols(pTHX_ int argc, char **argv, char **env)
4578 PERL_ARGS_ASSERT_INIT_POSTDUMP_SYMBOLS;
4580 PL_toptarget = newSV_type(SVt_PVIV);
4581 SvPVCLEAR(PL_toptarget);
4582 PL_bodytarget = newSV_type(SVt_PVIV);
4583 SvPVCLEAR(PL_bodytarget);
4584 PL_formtarget = PL_bodytarget;
4588 init_argv_symbols(argc,argv);
4590 if ((tmpgv = gv_fetchpvs("0", GV_ADD|GV_NOTQUAL, SVt_PV))) {
4591 sv_setpv(GvSV(tmpgv),PL_origfilename);
4593 if ((PL_envgv = gv_fetchpvs("ENV", GV_ADD|GV_NOTQUAL, SVt_PVHV))) {
4595 bool env_is_not_environ;
4596 SvREFCNT_inc_simple_void_NN(PL_envgv);
4597 GvMULTI_on(PL_envgv);
4598 hv = GvHVn(PL_envgv);
4599 hv_magic(hv, NULL, PERL_MAGIC_env);
4601 #ifdef USE_ENVIRON_ARRAY
4602 /* Note that if the supplied env parameter is actually a copy
4603 of the global environ then it may now point to free'd memory
4604 if the environment has been modified since. To avoid this
4605 problem we treat env==NULL as meaning 'use the default'
4609 env_is_not_environ = env != environ;
4610 if (env_is_not_environ
4611 # ifdef USE_ITHREADS
4612 && PL_curinterp == aTHX
4624 for (; *env; env++) {
4627 if (!(s = strchr(old_var,'=')) || s == old_var)
4631 #if defined(MSDOS) && !defined(DJGPP)
4633 (void)strupr(old_var);
4636 if (hv_exists(hv, old_var, nlen)) {
4637 const char *name = savepvn(old_var, nlen);
4639 /* make sure we use the same value as getenv(), otherwise code that
4640 uses getenv() (like setlocale()) might see a different value to %ENV
4642 sv = newSVpv(PerlEnv_getenv(name), 0);
4644 /* keep a count of the dups of this name so we can de-dup environ later */
4645 if (hv_exists(dups, name, nlen))
4646 ++SvIVX(*hv_fetch(dups, name, nlen, 0));
4648 (void)hv_store(dups, name, nlen, newSViv(1), 0);
4653 sv = newSVpv(s+1, 0);
4655 (void)hv_store(hv, old_var, nlen, sv, 0);
4656 if (env_is_not_environ)
4660 /* environ has some duplicate definitions, remove them */
4663 while ((entry = hv_iternext_flags(dups, 0))) {
4665 const char *name = HePV(entry, nlen);
4666 IV count = SvIV(HeVAL(entry));
4668 SV **valp = hv_fetch(hv, name, nlen, 0);
4672 /* try to remove any duplicate names, depending on the
4673 * implementation used in my_setenv() the iteration might
4674 * not be necessary, but let's be safe.
4676 for (i = 0; i < count; ++i)
4679 /* and set it back to the value we set $ENV{name} to */
4680 my_setenv(name, SvPV_nolen(*valp));
4683 SvREFCNT_dec_NN(dups);
4685 #endif /* USE_ENVIRON_ARRAY */
4686 #endif /* !PERL_MICRO */
4690 /* touch @F array to prevent spurious warnings 20020415 MJD */
4692 (void) get_av("main::F", GV_ADD | GV_ADDMULTI);
4697 S_init_perllib(pTHX)
4700 const char *perl5lib = NULL;
4703 #if defined(WIN32) && !defined(PERL_IS_MINIPERL)
4707 if (!TAINTING_get) {
4709 perl5lib = PerlEnv_getenv("PERL5LIB");
4711 * It isn't possible to delete an environment variable with
4712 * PERL_USE_SAFE_PUTENV set unless unsetenv() is also available, so in that
4713 * case we treat PERL5LIB as undefined if it has a zero-length value.
4715 #if defined(PERL_USE_SAFE_PUTENV) && ! defined(HAS_UNSETENV)
4716 if (perl5lib && *perl5lib != '\0')
4720 incpush_use_sep(perl5lib, 0, INCPUSH_ADD_SUB_DIRS);
4722 s = PerlEnv_getenv("PERLLIB");
4724 incpush_use_sep(s, 0, 0);
4727 /* Treat PERL5?LIB as a possible search list logical name -- the
4728 * "natural" VMS idiom for a Unix path string. We allow each
4729 * element to be a set of |-separated directories for compatibility.
4733 if (vmstrnenv("PERL5LIB",buf,0,NULL,0))
4735 incpush_use_sep(buf, 0, INCPUSH_ADD_SUB_DIRS);
4736 } while (vmstrnenv("PERL5LIB",buf,++idx,NULL,0));
4738 while (vmstrnenv("PERLLIB",buf,idx++,NULL,0))
4739 incpush_use_sep(buf, 0, 0);
4744 #ifndef PERL_IS_MINIPERL
4745 /* miniperl gets just -I..., the split of $ENV{PERL5LIB}, and "." in @INC
4746 (and not the architecture specific directories from $ENV{PERL5LIB}) */
4748 #include "perl_inc_macro.h"
4749 /* Use the ~-expanded versions of APPLLIB (undocumented),
4750 SITEARCH, SITELIB, VENDORARCH, VENDORLIB, ARCHLIB and PRIVLIB
4753 INCPUSH_SITEARCH_EXP
4755 INCPUSH_PERL_VENDORARCH_EXP
4756 INCPUSH_PERL_VENDORLIB_EXP
4759 INCPUSH_PERL_OTHERLIBDIRS
4761 INCPUSH_APPLLIB_OLD_EXP
4762 INCPUSH_SITELIB_STEM
4763 INCPUSH_PERL_VENDORLIB_STEM
4764 INCPUSH_PERL_OTHERLIBDIRS_ARCHONLY
4766 #endif /* !PERL_IS_MINIPERL */
4768 if (!TAINTING_get) {
4769 #if !defined(PERL_IS_MINIPERL) && defined(DEFAULT_INC_EXCLUDES_DOT)
4770 const char * const unsafe = PerlEnv_getenv("PERL_USE_UNSAFE_INC");
4771 if (unsafe && strEQ(unsafe, "1"))
4773 S_incpush(aTHX_ STR_WITH_LEN("."), 0);
4777 #if defined(DOSISH) || defined(__SYMBIAN32__)
4778 # define PERLLIB_SEP ';'
4779 #elif defined(__VMS)
4780 # define PERLLIB_SEP PL_perllib_sep
4782 # define PERLLIB_SEP ':'
4784 #ifndef PERLLIB_MANGLE
4785 # define PERLLIB_MANGLE(s,n) (s)
4788 #ifndef PERL_IS_MINIPERL
4789 /* Push a directory onto @INC if it exists.
4790 Generate a new SV if we do this, to save needing to copy the SV we push
4793 S_incpush_if_exists(pTHX_ AV *const av, SV *dir, SV *const stem)
4797 PERL_ARGS_ASSERT_INCPUSH_IF_EXISTS;
4799 if (PerlLIO_stat(SvPVX_const(dir), &tmpstatbuf) >= 0 &&
4800 S_ISDIR(tmpstatbuf.st_mode)) {
4802 dir = newSVsv(stem);
4804 /* Truncate dir back to stem. */
4805 SvCUR_set(dir, SvCUR(stem));
4812 S_mayberelocate(pTHX_ const char *const dir, STRLEN len, U32 flags)
4814 const U8 canrelocate = (U8)flags & INCPUSH_CAN_RELOCATE;
4817 PERL_ARGS_ASSERT_MAYBERELOCATE;
4820 /* I am not convinced that this is valid when PERLLIB_MANGLE is
4821 defined to so something (in os2/os2.c), but the code has been
4822 this way, ignoring any possible changed of length, since
4823 760ac839baf413929cd31cc32ffd6dba6b781a81 (5.003_02) so I'll leave
4825 libdir = newSVpvn(PERLLIB_MANGLE(dir, len), len);
4831 if ((unix = tounixspec_ts(SvPV(libdir,len),NULL)) != NULL) {
4833 while (len > 1 && unix[len-1] == '/') len--; /* Cosmetic */
4834 sv_usepvn(libdir,unix,len);
4837 PerlIO_printf(Perl_error_log,
4838 "Failed to unixify @INC element \"%s\"\n",
4839 SvPV_nolen_const(libdir));
4843 /* Do the if() outside the #ifdef to avoid warnings about an unused
4846 #ifdef PERL_RELOCATABLE_INC
4848 * Relocatable include entries are marked with a leading .../
4851 * 0: Remove that leading ".../"
4852 * 1: Remove trailing executable name (anything after the last '/')
4853 * from the perl path to give a perl prefix
4855 * While the @INC element starts "../" and the prefix ends with a real
4856 * directory (ie not . or ..) chop that real directory off the prefix
4857 * and the leading "../" from the @INC element. ie a logical "../"
4859 * Finally concatenate the prefix and the remainder of the @INC element
4860 * The intent is that /usr/local/bin/perl and .../../lib/perl5
4861 * generates /usr/local/lib/perl5
4863 const char *libpath = SvPVX(libdir);
4864 STRLEN libpath_len = SvCUR(libdir);
4865 if (memBEGINs(libpath, libpath_len, ".../")) {
4867 SV * const caret_X = get_sv("\030", 0);
4868 /* Going to use the SV just as a scratch buffer holding a C
4874 /* $^X is *the* source of taint if tainting is on, hence
4875 SvPOK() won't be true. */
4877 assert(SvPOKp(caret_X));
4878 prefix_sv = newSVpvn_flags(SvPVX(caret_X), SvCUR(caret_X),
4880 /* Firstly take off the leading .../
4881 If all else fail we'll do the paths relative to the current
4883 sv_chop(libdir, libpath + 4);
4884 /* Don't use SvPV as we're intentionally bypassing taining,
4885 mortal copies that the mg_get of tainting creates, and
4886 corruption that seems to come via the save stack.
4887 I guess that the save stack isn't correctly set up yet. */
4888 libpath = SvPVX(libdir);
4889 libpath_len = SvCUR(libdir);
4891 prefix = SvPVX(prefix_sv);
4892 lastslash = (char *) my_memrchr(prefix, '/',
4893 SvEND(prefix_sv) - prefix);
4895 /* First time in with the *lastslash = '\0' we just wipe off
4896 the trailing /perl from (say) /usr/foo/bin/perl
4900 while ((*lastslash = '\0'), /* Do that, come what may. */
4901 ( memBEGINs(libpath, libpath_len, "../")
4903 (char *) my_memrchr(prefix, '/',
4904 SvEND(prefix_sv) - prefix))))
4906 if (lastslash[1] == '\0'
4907 || (lastslash[1] == '.'
4908 && (lastslash[2] == '/' /* ends "/." */
4909 || (lastslash[2] == '/'
4910 && lastslash[3] == '/' /* or "/.." */
4912 /* Prefix ends "/" or "/." or "/..", any of which
4913 are fishy, so don't do any more logical cleanup.
4917 /* Remove leading "../" from path */
4920 /* Next iteration round the loop removes the last
4921 directory name from prefix by writing a '\0' in
4922 the while clause. */
4924 /* prefix has been terminated with a '\0' to the correct
4925 length. libpath points somewhere into the libdir SV.
4926 We need to join the 2 with '/' and drop the result into
4928 tempsv = Perl_newSVpvf(aTHX_ "%s/%s", prefix, libpath);
4929 SvREFCNT_dec(libdir);
4930 /* And this is the new libdir. */
4933 (PerlProc_getuid() != PerlProc_geteuid() ||
4934 PerlProc_getgid() != PerlProc_getegid())) {
4935 /* Need to taint relocated paths if running set ID */
4936 SvTAINTED_on(libdir);
4939 SvREFCNT_dec(prefix_sv);
4947 S_incpush(pTHX_ const char *const dir, STRLEN len, U32 flags)
4949 #ifndef PERL_IS_MINIPERL
4950 const U8 using_sub_dirs
4951 = (U8)flags & (INCPUSH_ADD_VERSIONED_SUB_DIRS
4952 |INCPUSH_ADD_ARCHONLY_SUB_DIRS|INCPUSH_ADD_OLD_VERS);
4953 const U8 add_versioned_sub_dirs
4954 = (U8)flags & INCPUSH_ADD_VERSIONED_SUB_DIRS;
4955 const U8 add_archonly_sub_dirs
4956 = (U8)flags & INCPUSH_ADD_ARCHONLY_SUB_DIRS;
4957 #ifdef PERL_INC_VERSION_LIST
4958 const U8 addoldvers = (U8)flags & INCPUSH_ADD_OLD_VERS;
4961 const U8 unshift = (U8)flags & INCPUSH_UNSHIFT;
4962 const U8 push_basedir = (flags & INCPUSH_NOT_BASEDIR) ? 0 : 1;
4963 AV *const inc = GvAVn(PL_incgv);
4965 PERL_ARGS_ASSERT_INCPUSH;
4968 /* Could remove this vestigial extra block, if we don't mind a lot of
4969 re-indenting diff noise. */
4971 SV *const libdir = mayberelocate(dir, len, flags);
4972 /* Change 20189146be79a0596543441fa369c6bf7f85103f, to fix RT#6665,
4973 arranged to unshift #! line -I onto the front of @INC. However,
4974 -I can add version and architecture specific libraries, and they
4975 need to go first. The old code assumed that it was always
4976 pushing. Hence to make it work, need to push the architecture
4977 (etc) libraries onto a temporary array, then "unshift" that onto
4978 the front of @INC. */
4979 #ifndef PERL_IS_MINIPERL
4980 AV *const av = (using_sub_dirs) ? (unshift ? newAV() : inc) : NULL;
4983 * BEFORE pushing libdir onto @INC we may first push version- and
4984 * archname-specific sub-directories.
4986 if (using_sub_dirs) {
4987 SV *subdir = newSVsv(libdir);
4988 #ifdef PERL_INC_VERSION_LIST
4989 /* Configure terminates PERL_INC_VERSION_LIST with a NULL */
4990 const char * const incverlist[] = { PERL_INC_VERSION_LIST };
4991 const char * const *incver;
4994 if (add_versioned_sub_dirs) {
4995 /* .../version/archname if -d .../version/archname */
4996 sv_catpvs(subdir, "/" PERL_FS_VERSION "/" ARCHNAME);
4997 subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
4999 /* .../version if -d .../version */
5000 sv_catpvs(subdir, "/" PERL_FS_VERSION);
5001 subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
5004 #ifdef PERL_INC_VERSION_LIST
5006 for (incver = incverlist; *incver; incver++) {
5007 /* .../xxx if -d .../xxx */
5008 Perl_sv_catpvf(aTHX_ subdir, "/%s", *incver);
5009 subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
5014 if (add_archonly_sub_dirs) {
5015 /* .../archname if -d .../archname */
5016 sv_catpvs(subdir, "/" ARCHNAME);
5017 subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
5021 assert (SvREFCNT(subdir) == 1);
5022 SvREFCNT_dec(subdir);
5024 #endif /* !PERL_IS_MINIPERL */
5025 /* finally add this lib directory at the end of @INC */
5027 #ifdef PERL_IS_MINIPERL
5028 const Size_t extra = 0;
5030 Size_t extra = av_tindex(av) + 1;
5032 av_unshift(inc, extra + push_basedir);
5034 av_store(inc, extra, libdir);
5035 #ifndef PERL_IS_MINIPERL
5037 /* av owns a reference, av_store() expects to be donated a
5038 reference, and av expects to be sane when it's cleared.
5039 If I wanted to be naughty and wrong, I could peek inside the
5040 implementation of av_clear(), realise that it uses
5041 SvREFCNT_dec() too, so av's array could be a run of NULLs,
5042 and so directly steal from it (with a memcpy() to inc, and
5043 then memset() to NULL them out. But people copy code from the
5044 core expecting it to be best practise, so let's use the API.
5045 Although studious readers will note that I'm not checking any
5047 av_store(inc, extra, SvREFCNT_inc(*av_fetch(av, extra, FALSE)));
5052 else if (push_basedir) {
5053 av_push(inc, libdir);
5056 if (!push_basedir) {
5057 assert (SvREFCNT(libdir) == 1);
5058 SvREFCNT_dec(libdir);
5064 S_incpush_use_sep(pTHX_ const char *p, STRLEN len, U32 flags)
5068 /* This logic has been broken out from S_incpush(). It may be possible to
5071 PERL_ARGS_ASSERT_INCPUSH_USE_SEP;
5073 /* perl compiled with -DPERL_RELOCATABLE_INCPUSH will ignore the len
5074 * argument to incpush_use_sep. This allows creation of relocatable
5075 * Perl distributions that patch the binary at install time. Those
5076 * distributions will have to provide their own relocation tools; this
5077 * is not a feature otherwise supported by core Perl.
5079 #ifndef PERL_RELOCATABLE_INCPUSH
5086 /* Break at all separators */
5087 while ((s = (const char*)memchr(p, PERLLIB_SEP, end - p))) {
5089 /* skip any consecutive separators */
5091 /* Uncomment the next line for PATH semantics */
5092 /* But you'll need to write tests */
5093 /* av_push(GvAVn(PL_incgv), newSVpvs(".")); */
5095 incpush(p, (STRLEN)(s - p), flags);
5100 incpush(p, (STRLEN)(end - p), flags);
5105 Perl_call_list(pTHX_ I32 oldscope, AV *paramList)
5108 volatile const line_t oldline = PL_curcop ? CopLINE(PL_curcop) : 0;
5114 PERL_ARGS_ASSERT_CALL_LIST;
5116 while (av_tindex(paramList) >= 0) {
5117 cv = MUTABLE_CV(av_shift(paramList));
5119 if (paramList == PL_beginav) {
5120 /* save PL_beginav for compiler */
5121 Perl_av_create_and_push(aTHX_ &PL_beginav_save, MUTABLE_SV(cv));
5123 else if (paramList == PL_checkav) {
5124 /* save PL_checkav for compiler */
5125 Perl_av_create_and_push(aTHX_ &PL_checkav_save, MUTABLE_SV(cv));
5127 else if (paramList == PL_unitcheckav) {
5128 /* save PL_unitcheckav for compiler */
5129 Perl_av_create_and_push(aTHX_ &PL_unitcheckav_save, MUTABLE_SV(cv));
5139 (void)SvPV_const(atsv, len);
5141 PL_curcop = &PL_compiling;
5142 CopLINE_set(PL_curcop, oldline);
5143 if (paramList == PL_beginav)
5144 sv_catpvs(atsv, "BEGIN failed--compilation aborted");
5146 Perl_sv_catpvf(aTHX_ atsv,
5147 "%s failed--call queue aborted",
5148 paramList == PL_checkav ? "CHECK"
5149 : paramList == PL_initav ? "INIT"
5150 : paramList == PL_unitcheckav ? "UNITCHECK"
5152 while (PL_scopestack_ix > oldscope)
5155 Perl_croak(aTHX_ "%" SVf, SVfARG(atsv));
5162 /* my_exit() was called */
5163 while (PL_scopestack_ix > oldscope)
5166 SET_CURSTASH(PL_defstash);
5167 PL_curcop = &PL_compiling;
5168 CopLINE_set(PL_curcop, oldline);
5171 NOT_REACHED; /* NOTREACHED */
5174 PL_curcop = &PL_compiling;
5175 CopLINE_set(PL_curcop, oldline);
5178 PerlIO_printf(Perl_error_log, "panic: restartop in call_list\n");
5189 A wrapper for the C library L<exit(3)>, honoring what L<perlapi/PL_exit_flags>
5196 Perl_my_exit(pTHX_ U32 status)
5198 if (PL_exit_flags & PERL_EXIT_ABORT) {
5201 if (PL_exit_flags & PERL_EXIT_WARN) {
5202 PL_exit_flags |= PERL_EXIT_ABORT; /* Protect against reentrant calls */
5203 Perl_warn(aTHX_ "Unexpected exit %lu", (unsigned long)status);
5204 PL_exit_flags &= ~PERL_EXIT_ABORT;
5214 STATUS_EXIT_SET(status);
5221 Perl_my_failure_exit(pTHX)
5224 /* We have been called to fall on our sword. The desired exit code
5225 * should be already set in STATUS_UNIX, but could be shifted over
5226 * by 8 bits. STATUS_UNIX_EXIT_SET will handle the cases where a
5229 * If an error code has not been set, then force the issue.
5231 if (MY_POSIX_EXIT) {
5233 /* According to the die_exit.t tests, if errno is non-zero */
5234 /* It should be used for the error status. */
5236 if (errno == EVMSERR) {
5237 STATUS_NATIVE = vaxc$errno;
5240 /* According to die_exit.t tests, if the child_exit code is */
5241 /* also zero, then we need to exit with a code of 255 */
5242 if ((errno != 0) && (errno < 256))
5243 STATUS_UNIX_EXIT_SET(errno);
5244 else if (STATUS_UNIX < 255) {
5245 STATUS_UNIX_EXIT_SET(255);
5250 /* The exit code could have been set by $? or vmsish which
5251 * means that it may not have fatal set. So convert
5252 * success/warning codes to fatal with out changing
5253 * the POSIX status code. The severity makes VMS native
5254 * status handling work, while UNIX mode programs use the
5255 * the POSIX exit codes.
5257 if ((STATUS_NATIVE & (STS$K_SEVERE|STS$K_ERROR)) == 0) {
5258 STATUS_NATIVE &= STS$M_COND_ID;
5259 STATUS_NATIVE |= STS$K_ERROR | STS$M_INHIB_MSG;
5263 /* Traditionally Perl on VMS always expects a Fatal Error. */
5264 if (vaxc$errno & 1) {
5266 /* So force success status to failure */
5267 if (STATUS_NATIVE & 1)
5272 STATUS_UNIX = EINTR; /* In case something cares */
5277 STATUS_NATIVE = vaxc$errno; /* Should already be this */
5279 /* Encode the severity code */
5280 severity = STATUS_NATIVE & STS$M_SEVERITY;
5281 STATUS_UNIX = (severity ? severity : 1) << 8;
5283 /* Perl expects this to be a fatal error */
5284 if (severity != STS$K_SEVERE)
5294 STATUS_UNIX_SET(eno);
5296 exitstatus = STATUS_UNIX >> 8;
5297 if (exitstatus & 255)
5298 STATUS_UNIX_SET(exitstatus);
5300 STATUS_UNIX_SET(255);
5303 if (PL_exit_flags & PERL_EXIT_ABORT) {
5306 if (PL_exit_flags & PERL_EXIT_WARN) {
5307 PL_exit_flags |= PERL_EXIT_ABORT; /* Protect against reentrant calls */
5308 Perl_warn(aTHX_ "Unexpected exit failure %ld", (long)PL_statusvalue);
5309 PL_exit_flags &= ~PERL_EXIT_ABORT;
5315 S_my_exit_jump(pTHX)
5318 SvREFCNT_dec(PL_e_script);
5322 POPSTACK_TO(PL_mainstack);
5323 if (cxstack_ix >= 0) {
5325 cx_popblock(cxstack);
5333 read_e_script(pTHX_ int idx, SV *buf_sv, int maxlen)
5335 const char * const p = SvPVX_const(PL_e_script);
5336 const char * const e = SvEND(PL_e_script);
5337 const char *nl = (char *) memchr(p, '\n', e - p);
5339 PERL_UNUSED_ARG(idx);
5340 PERL_UNUSED_ARG(maxlen);
5342 nl = (nl) ? nl+1 : e;
5344 filter_del(read_e_script);
5347 sv_catpvn(buf_sv, p, nl-p);
5348 sv_chop(PL_e_script, nl);
5352 /* removes boilerplate code at the end of each boot_Module xsub */
5354 Perl_xs_boot_epilog(pTHX_ const I32 ax)
5357 call_list(PL_scopestack_ix, PL_unitcheckav);
5362 * ex: set ts=8 sts=4 sw=4 et: