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 S_fixup_platform_bugs(void)
222 #if defined(__GLIBC__) && IVSIZE == 8 \
223 && ( __GLIBC__ < 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ < 8))
227 /* Cannot do this check with inlined IV constants since
228 * that seems to work correctly even with the buggy glibc. */
231 /* Yikes, we have the bug.
232 * Patch in the workaround version. */
233 PL_ppaddr[OP_I_MODULO] = &Perl_pp_i_modulo_glibc_bugfix;
240 perl_construct(pTHXx)
244 PERL_ARGS_ASSERT_PERL_CONSTRUCT;
248 PL_perl_destruct_level = 1;
250 PERL_UNUSED_ARG(my_perl);
251 if (PL_perl_destruct_level > 0)
254 PL_curcop = &PL_compiling; /* needed by ckWARN, right away */
256 #ifdef PERL_TRACE_OPS
257 Zero(PL_op_exec_cnt, OP_max+2, UV);
262 SvREADONLY_on(&PL_sv_placeholder);
263 SvREFCNT(&PL_sv_placeholder) = SvREFCNT_IMMORTAL;
265 PL_sighandlerp = Perl_sighandler;
266 PL_sighandler1p = Perl_sighandler1;
267 PL_sighandler3p = Perl_sighandler3;
269 #ifdef PERL_USES_PL_PIDSTATUS
270 PL_pidstatus = newHV();
273 PL_rs = newSVpvs("\n");
277 /* The PERL_INTERNAL_RAND_SEED set-up must be after init_stacks because it calls
278 * things that may put SVs on the stack.
281 #ifdef NO_PERL_INTERNAL_RAND_SEED
282 Perl_drand48_init_r(&PL_internal_random_state, seed());
287 if (PerlProc_getuid() != PerlProc_geteuid() ||
288 PerlProc_getgid() != PerlProc_getegid() ||
289 !(env_pv = PerlEnv_getenv("PERL_INTERNAL_RAND_SEED")) ||
290 grok_number(env_pv, strlen(env_pv), &seed) != IS_NUMBER_IN_UV) {
293 Perl_drand48_init_r(&PL_internal_random_state, (U32)seed);
299 S_fixup_platform_bugs();
305 (void) uvchr_to_utf8_flags((U8 *) PL_TR_SPECIAL_HANDLING_UTF8,
307 UNICODE_ALLOW_ABOVE_IV_MAX);
309 #if defined(LOCAL_PATCH_COUNT)
310 PL_localpatches = local_patches; /* For possible -v */
313 #if defined(LIBM_LIB_VERSION)
315 * Some BSDs and Cygwin default to POSIX math instead of IEEE.
316 * This switches them over to IEEE.
318 _LIB_VERSION = _IEEE_;
321 #ifdef HAVE_INTERP_INTERN
325 PerlIO_init(aTHX); /* Hook to IO system */
327 PL_fdpid = newAV(); /* for remembering popen pids by fd */
328 PL_modglobal = newHV(); /* pointers to per-interpreter module globals */
329 PL_errors = newSVpvs("");
330 SvPVCLEAR(PERL_DEBUG_PAD(0)); /* For regex debugging. */
331 SvPVCLEAR(PERL_DEBUG_PAD(1)); /* ext/re needs these */
332 SvPVCLEAR(PERL_DEBUG_PAD(2)); /* even without DEBUGGING. */
334 /* First entry is a list of empty elements. It needs to be initialised
335 else all hell breaks loose in S_find_uninit_var(). */
336 Perl_av_create_and_push(aTHX_ &PL_regex_padav, newSVpvs(""));
337 PL_regex_pad = AvARRAY(PL_regex_padav);
338 Newxz(PL_stashpad, PL_stashpadmax, HV *);
340 #ifdef USE_REENTRANT_API
341 Perl_reentrant_init(aTHX);
343 if (PL_hash_seed_set == FALSE) {
344 /* Initialize the hash seed and state at startup. This must be
345 * done very early, before ANY hashes are constructed, and once
346 * setup is fixed for the lifetime of the process.
348 * If you decide to disable the seeding process you should choose
349 * a suitable seed yourself and define PERL_HASH_SEED to a well chosen
350 * string. See hv_func.h for details.
352 #if defined(USE_HASH_SEED)
353 /* get the hash seed from the environment or from an RNG */
354 Perl_get_hash_seed(aTHX_ PL_hash_seed);
356 /* they want a hard coded seed, check that it is long enough */
357 assert( strlen(PERL_HASH_SEED) >= PERL_HASH_SEED_BYTES );
360 /* now we use the chosen seed to initialize the state -
361 * in some configurations this may be a relatively speaking
362 * expensive operation, but we only have to do it once at startup */
363 PERL_HASH_SEED_STATE(PERL_HASH_SEED,PL_hash_state);
365 #ifdef PERL_USE_SINGLE_CHAR_HASH_CACHE
366 /* we can build a special cache for 0/1 byte keys, if people choose
367 * I suspect most of the time it is not worth it */
371 for (i=0;i<256;i++) {
373 PERL_HASH_WITH_STATE(PL_hash_state,PL_hash_chars[i],str,1);
375 PERL_HASH_WITH_STATE(PL_hash_state,PL_hash_chars[256],str,0);
378 /* at this point we have initialezed the hash function, and we can start
379 * constructing hashes */
380 PL_hash_seed_set= TRUE;
383 /* Allow PL_strtab to be pre-initialized before calling perl_construct.
384 * can use a custom optimized PL_strtab hash before calling perl_construct */
386 /* Note that strtab is a rather special HV. Assumptions are made
387 about not iterating on it, and not adding tie magic to it.
388 It is properly deallocated in perl_destruct() */
391 /* SHAREKEYS tells us that the hash has its keys shared with PL_strtab,
392 * which is not the case with PL_strtab itself */
393 HvSHAREKEYS_off(PL_strtab); /* mandatory */
394 hv_ksplit(PL_strtab, 1 << 11);
397 Zero(PL_sv_consts, SV_CONSTS_COUNT, SV*);
400 # ifdef USE_ENVIRON_ARRAY
401 PL_origenviron = environ;
405 /* Use sysconf(_SC_CLK_TCK) if available, if not
406 * available or if the sysconf() fails, use the HZ.
407 * The HZ if not originally defined has been by now
408 * been defined as CLK_TCK, if available. */
409 #if defined(HAS_SYSCONF) && defined(_SC_CLK_TCK)
410 PL_clocktick = sysconf(_SC_CLK_TCK);
411 if (PL_clocktick <= 0)
415 PL_stashcache = newHV();
417 PL_patchlevel = newSVpvs("v" PERL_VERSION_STRING);
420 if (!PL_mmap_page_size) {
421 #if defined(HAS_SYSCONF) && (defined(_SC_PAGESIZE) || defined(_SC_MMAP_PAGE_SIZE))
423 SETERRNO(0, SS_NORMAL);
425 PL_mmap_page_size = sysconf(_SC_PAGESIZE);
427 PL_mmap_page_size = sysconf(_SC_MMAP_PAGE_SIZE);
429 if ((long) PL_mmap_page_size < 0) {
430 Perl_croak(aTHX_ "panic: sysconf: %s",
431 errno ? Strerror(errno) : "pagesize unknown");
434 #elif defined(HAS_GETPAGESIZE)
435 PL_mmap_page_size = getpagesize();
436 #elif defined(I_SYS_PARAM) && defined(PAGESIZE)
437 PL_mmap_page_size = PAGESIZE; /* compiletime, bad */
439 if (PL_mmap_page_size <= 0)
440 Perl_croak(aTHX_ "panic: bad pagesize %" IVdf,
441 (IV) PL_mmap_page_size);
443 #endif /* HAS_MMAP */
445 #if defined(HAS_TIMES) && defined(PERL_NEED_TIMESBASE)
446 PL_timesbase.tms_utime = 0;
447 PL_timesbase.tms_stime = 0;
448 PL_timesbase.tms_cutime = 0;
449 PL_timesbase.tms_cstime = 0;
452 PL_osname = Perl_savepvn(aTHX_ STR_WITH_LEN(OSNAME));
454 PL_registered_mros = newHV();
455 /* Start with 1 bucket, for DFS. It's unlikely we'll need more. */
456 HvMAX(PL_registered_mros) = 0;
458 #ifdef USE_POSIX_2008_LOCALE
459 PL_C_locale_obj = newlocale(LC_ALL_MASK, "C", NULL);
467 =for apidoc nothreadhook
469 Stub that provides thread hook for perl_destruct when there are
476 Perl_nothreadhook(pTHX)
482 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
484 Perl_dump_sv_child(pTHX_ SV *sv)
487 const int sock = PL_dumper_fd;
488 const int debug_fd = PerlIO_fileno(Perl_debug_log);
489 union control_un control;
492 struct cmsghdr *cmptr;
494 unsigned char buffer[256];
496 PERL_ARGS_ASSERT_DUMP_SV_CHILD;
498 if(sock == -1 || debug_fd == -1)
501 PerlIO_flush(Perl_debug_log);
503 /* All these shenanigans are to pass a file descriptor over to our child for
504 it to dump out to. We can't let it hold open the file descriptor when it
505 forks, as the file descriptor it will dump to can turn out to be one end
506 of pipe that some other process will wait on for EOF. (So as it would
507 be open, the wait would be forever.) */
509 msg.msg_control = control.control;
510 msg.msg_controllen = sizeof(control.control);
511 /* We're a connected socket so we don't need a destination */
517 cmptr = CMSG_FIRSTHDR(&msg);
518 cmptr->cmsg_len = CMSG_LEN(sizeof(int));
519 cmptr->cmsg_level = SOL_SOCKET;
520 cmptr->cmsg_type = SCM_RIGHTS;
521 *((int *)CMSG_DATA(cmptr)) = 1;
523 vec[0].iov_base = (void*)&sv;
524 vec[0].iov_len = sizeof(sv);
525 got = sendmsg(sock, &msg, 0);
528 perror("Debug leaking scalars parent sendmsg failed");
531 if(got < sizeof(sv)) {
532 perror("Debug leaking scalars parent short sendmsg");
536 /* Return protocol is
538 unsigned char: length of location string (0 for empty)
539 unsigned char*: string (not terminated)
541 vec[0].iov_base = (void*)&returned_errno;
542 vec[0].iov_len = sizeof(returned_errno);
543 vec[1].iov_base = buffer;
546 got = readv(sock, vec, 2);
549 perror("Debug leaking scalars parent read failed");
550 PerlIO_flush(PerlIO_stderr());
553 if(got < sizeof(returned_errno) + 1) {
554 perror("Debug leaking scalars parent short read");
555 PerlIO_flush(PerlIO_stderr());
560 got = read(sock, buffer + 1, *buffer);
562 perror("Debug leaking scalars parent read 2 failed");
563 PerlIO_flush(PerlIO_stderr());
568 perror("Debug leaking scalars parent short read 2");
569 PerlIO_flush(PerlIO_stderr());
574 if (returned_errno || *buffer) {
575 Perl_warn(aTHX_ "Debug leaking scalars child failed%s%.*s with errno"
576 " %d: %s", (*buffer ? " at " : ""), (int) *buffer, buffer + 1,
577 returned_errno, Strerror(returned_errno));
583 =for apidoc perl_destruct
585 Shuts down a Perl interpreter. See L<perlembed> for a tutorial.
587 C<my_perl> points to the Perl interpreter. It must have been previously
588 created through the use of L</perl_alloc> and L</perl_construct>. It may
589 have been initialised through L</perl_parse>, and may have been used
590 through L</perl_run> and other means. This function should be called for
591 any Perl interpreter that has been constructed with L</perl_construct>,
592 even if subsequent operations on it failed, for example if L</perl_parse>
593 returned a non-zero value.
595 If the interpreter's C<PL_exit_flags> word has the
596 C<PERL_EXIT_DESTRUCT_END> flag set, then this function will execute code
597 in C<END> blocks before performing the rest of destruction. If it is
598 desired to make any use of the interpreter between L</perl_parse> and
599 L</perl_destruct> other than just calling L</perl_run>, then this flag
600 should be set early on. This matters if L</perl_run> will not be called,
601 or if anything else will be done in addition to calling L</perl_run>.
603 Returns a value be a suitable value to pass to the C library function
604 C<exit> (or to return from C<main>), to serve as an exit code indicating
605 the nature of the way the interpreter terminated. This takes into account
606 any failure of L</perl_parse> and any early exit from L</perl_run>.
607 The exit code is of the type required by the host operating system,
608 so because of differing exit code conventions it is not portable to
609 interpret specific numeric values as having specific meanings.
618 volatile signed char destruct_level; /* see possible values in intrpvar.h */
620 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
625 PERL_ARGS_ASSERT_PERL_DESTRUCT;
627 PERL_UNUSED_ARG(my_perl);
630 assert(PL_scopestack_ix == 1);
632 /* wait for all pseudo-forked children to finish */
633 PERL_WAIT_FOR_CHILDREN;
635 destruct_level = PL_perl_destruct_level;
637 const char * const s = PerlEnv_getenv("PERL_DESTRUCT_LEVEL");
640 if (strEQ(s, "-1")) { /* Special case: modperl folklore. */
644 if (grok_atoUV(s, &uv, NULL) && uv <= INT_MAX)
649 if (destruct_level < i) destruct_level = i;
650 #ifdef PERL_TRACK_MEMPOOL
651 /* RT #114496, for perl_free */
652 PL_perl_destruct_level = i;
657 if (PL_exit_flags & PERL_EXIT_DESTRUCT_END) {
663 if (PL_endav && !PL_minus_c) {
664 PERL_SET_PHASE(PERL_PHASE_END);
665 call_list(PL_scopestack_ix, PL_endav);
671 assert(PL_scopestack_ix == 0);
673 /* normally when we get here, PL_parser should be null due to having
674 * its original (null) value restored by SAVEt_PARSER during leaving
675 * scope (usually before run-time starts in fact).
676 * But if a thread is created within a BEGIN block, the parser is
677 * duped, but the SAVEt_PARSER savestack entry isn't. So PL_parser
678 * never gets cleaned up.
679 * Clean it up here instead. This is a bit of a hack.
682 /* stop parser_free() stomping on PL_curcop */
683 PL_parser->saved_curcop = PL_curcop;
684 parser_free(PL_parser);
688 /* Need to flush since END blocks can produce output */
689 /* flush stdout separately, since we can identify it */
692 PerlIO *stdo = PerlIO_stdout();
693 if (*stdo && PerlIO_flush(stdo)) {
694 PerlIO_restore_errno(stdo);
696 PerlIO_printf(PerlIO_stderr(), "Unable to flush stdout: %s\n",
705 #ifdef PERL_TRACE_OPS
706 /* dump OP-counts if $ENV{PERL_TRACE_OPS} > 0 */
708 const char * const ptoenv = PerlEnv_getenv("PERL_TRACE_OPS");
711 if (!ptoenv || !Perl_grok_atoUV(ptoenv, &uv, NULL)
715 PerlIO_printf(Perl_debug_log, "Trace of all OPs executed:\n");
716 for (i = 0; i <= OP_max; ++i) {
717 if (PL_op_exec_cnt[i])
718 PerlIO_printf(Perl_debug_log, " %s: %" UVuf "\n", PL_op_name[i], PL_op_exec_cnt[i]);
720 /* Utility slot for easily doing little tracing experiments in the runloop: */
721 if (PL_op_exec_cnt[OP_max+1] != 0)
722 PerlIO_printf(Perl_debug_log, " SPECIAL: %" UVuf "\n", PL_op_exec_cnt[OP_max+1]);
723 PerlIO_printf(Perl_debug_log, "\n");
728 if (PL_threadhook(aTHX)) {
729 /* Threads hook has vetoed further cleanup */
730 PL_veto_cleanup = TRUE;
734 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
735 if (destruct_level != 0) {
736 /* Fork here to create a child. Our child's job is to preserve the
737 state of scalars prior to destruction, so that we can instruct it
738 to dump any scalars that we later find have leaked.
739 There's no subtlety in this code - it assumes POSIX, and it doesn't
743 if(PerlSock_socketpair_cloexec(AF_UNIX, SOCK_STREAM, 0, fd)) {
744 perror("Debug leaking scalars socketpair failed");
750 perror("Debug leaking scalars fork failed");
754 /* We are the child */
755 const int sock = fd[1];
756 const int debug_fd = PerlIO_fileno(Perl_debug_log);
759 /* Our success message is an integer 0, and a char 0 */
760 static const char success[sizeof(int) + 1] = {0};
764 /* We need to close all other file descriptors otherwise we end up
765 with interesting hangs, where the parent closes its end of a
766 pipe, and sits waiting for (another) child to terminate. Only
767 that child never terminates, because it never gets EOF, because
768 we also have the far end of the pipe open. We even need to
769 close the debugging fd, because sometimes it happens to be one
770 end of a pipe, and a process is waiting on the other end for
771 EOF. Normally it would be closed at some point earlier in
772 destruction, but if we happen to cause the pipe to remain open,
773 EOF never occurs, and we get an infinite hang. Hence all the
774 games to pass in a file descriptor if it's actually needed. */
776 f = sysconf(_SC_OPEN_MAX);
778 where = "sysconf failed";
789 union control_un control;
792 struct cmsghdr *cmptr;
796 msg.msg_control = control.control;
797 msg.msg_controllen = sizeof(control.control);
798 /* We're a connected socket so we don't need a source */
802 msg.msg_iovlen = C_ARRAY_LENGTH(vec);
804 vec[0].iov_base = (void*)⌖
805 vec[0].iov_len = sizeof(target);
807 got = recvmsg(sock, &msg, 0);
812 where = "recv failed";
815 if(got < sizeof(target)) {
816 where = "short recv";
820 if(!(cmptr = CMSG_FIRSTHDR(&msg))) {
824 if(cmptr->cmsg_len != CMSG_LEN(sizeof(int))) {
825 where = "wrong cmsg_len";
828 if(cmptr->cmsg_level != SOL_SOCKET) {
829 where = "wrong cmsg_level";
832 if(cmptr->cmsg_type != SCM_RIGHTS) {
833 where = "wrong cmsg_type";
837 got_fd = *(int*)CMSG_DATA(cmptr);
838 /* For our last little bit of trickery, put the file descriptor
839 back into Perl_debug_log, as if we never actually closed it
841 if(got_fd != debug_fd) {
842 if (PerlLIO_dup2_cloexec(got_fd, debug_fd) == -1) {
849 PerlIO_flush(Perl_debug_log);
851 got = write(sock, &success, sizeof(success));
854 where = "write failed";
857 if(got < sizeof(success)) {
858 where = "short write";
865 int send_errno = errno;
866 unsigned char length = (unsigned char) strlen(where);
867 struct iovec failure[3] = {
868 {(void*)&send_errno, sizeof(send_errno)},
870 {(void*)where, length}
872 int got = writev(sock, failure, 3);
873 /* Bad news travels fast. Faster than data. We'll get a SIGPIPE
874 in the parent if we try to read from the socketpair after the
875 child has exited, even if there was data to read.
876 So sleep a bit to give the parent a fighting chance of
879 _exit((got == -1) ? errno : 0);
883 PL_dumper_fd = fd[0];
888 /* We must account for everything. */
890 /* Destroy the main CV and syntax tree */
891 /* Set PL_curcop now, because destroying ops can cause new SVs
892 to be generated in Perl_pad_swipe, and when running with
893 -DDEBUG_LEAKING_SCALARS they expect PL_curcop to point to a valid
894 op from which the filename structure member is copied. */
895 PL_curcop = &PL_compiling;
897 /* ensure comppad/curpad to refer to main's pad */
898 if (CvPADLIST(PL_main_cv)) {
899 PAD_SET_CUR_NOSAVE(CvPADLIST(PL_main_cv), 1);
900 PL_comppad_name = PadlistNAMES(CvPADLIST(PL_main_cv));
902 op_free(PL_main_root);
905 PL_main_start = NULL;
906 /* note that PL_main_cv isn't usually actually freed at this point,
907 * due to the CvOUTSIDE refs from subs compiled within it. It will
908 * get freed once all the subs are freed in sv_clean_all(), for
909 * destruct_level > 0 */
910 SvREFCNT_dec(PL_main_cv);
912 PERL_SET_PHASE(PERL_PHASE_DESTRUCT);
914 /* Tell PerlIO we are about to tear things apart in case
915 we have layers which are using resources that should
919 PerlIO_destruct(aTHX);
922 * Try to destruct global references. We do this first so that the
923 * destructors and destructees still exist. Some sv's might remain.
924 * Non-referenced objects are on their own.
928 /* unhook hooks which will soon be, or use, destroyed data */
929 SvREFCNT_dec(PL_warnhook);
931 SvREFCNT_dec(PL_diehook);
934 /* call exit list functions */
935 while (PL_exitlistlen-- > 0)
936 PL_exitlist[PL_exitlistlen].fn(aTHX_ PL_exitlist[PL_exitlistlen].ptr);
938 Safefree(PL_exitlist);
943 SvREFCNT_dec(PL_registered_mros);
945 /* jettison our possibly duplicated environment */
946 /* if PERL_USE_SAFE_PUTENV is defined environ will not have been copied
947 * so we certainly shouldn't free it here
950 #if defined(USE_ENVIRON_ARRAY) && !defined(PERL_USE_SAFE_PUTENV)
951 if (environ != PL_origenviron && !PL_use_safe_putenv
953 /* only main thread can free environ[0] contents */
954 && PL_curinterp == aTHX
960 for (i = 0; environ[i]; i++)
961 safesysfree(environ[i]);
963 /* Must use safesysfree() when working with environ. */
964 safesysfree(environ);
966 environ = PL_origenviron;
969 #endif /* !PERL_MICRO */
971 if (destruct_level == 0) {
973 DEBUG_P(debprofdump());
975 #if defined(PERLIO_LAYERS)
976 /* No more IO - including error messages ! */
977 PerlIO_cleanup(aTHX);
980 CopFILE_free(&PL_compiling);
982 /* The exit() function will do everything that needs doing. */
986 /* Below, do clean up for when PERL_DESTRUCT_LEVEL is not 0 */
989 /* the syntax tree is shared between clones
990 * so op_free(PL_main_root) only ReREFCNT_dec's
991 * REGEXPs in the parent interpreter
992 * we need to manually ReREFCNT_dec for the clones
995 I32 i = AvFILLp(PL_regex_padav);
996 SV **ary = AvARRAY(PL_regex_padav);
999 SvREFCNT_dec(ary[i]);
1000 ary[i] = &PL_sv_undef;
1006 SvREFCNT_dec(MUTABLE_SV(PL_stashcache));
1007 PL_stashcache = NULL;
1009 /* loosen bonds of global variables */
1011 /* XXX can PL_parser still be non-null here? */
1012 if(PL_parser && PL_parser->rsfp) {
1013 (void)PerlIO_close(PL_parser->rsfp);
1014 PL_parser->rsfp = NULL;
1018 Safefree(PL_splitstr);
1028 PL_doswitches = FALSE;
1029 PL_dowarn = G_WARN_OFF;
1030 #ifdef PERL_SAWAMPERSAND
1031 PL_sawampersand = 0; /* must save all match strings */
1035 Safefree(PL_inplace);
1037 SvREFCNT_dec(PL_patchlevel);
1040 SvREFCNT_dec(PL_e_script);
1046 /* magical thingies */
1048 SvREFCNT_dec(PL_ofsgv); /* *, */
1051 SvREFCNT_dec(PL_ors_sv); /* $\ */
1054 SvREFCNT_dec(PL_rs); /* $/ */
1057 Safefree(PL_osname); /* $^O */
1060 SvREFCNT_dec(PL_statname);
1064 /* defgv, aka *_ should be taken care of elsewhere */
1067 Safefree(PL_efloatbuf);
1068 PL_efloatbuf = NULL;
1071 /* startup and shutdown function lists */
1072 SvREFCNT_dec(PL_beginav);
1073 SvREFCNT_dec(PL_beginav_save);
1074 SvREFCNT_dec(PL_endav);
1075 SvREFCNT_dec(PL_checkav);
1076 SvREFCNT_dec(PL_checkav_save);
1077 SvREFCNT_dec(PL_unitcheckav);
1078 SvREFCNT_dec(PL_unitcheckav_save);
1079 SvREFCNT_dec(PL_initav);
1081 PL_beginav_save = NULL;
1084 PL_checkav_save = NULL;
1085 PL_unitcheckav = NULL;
1086 PL_unitcheckav_save = NULL;
1089 /* shortcuts just get cleared */
1092 PL_argvoutgv = NULL;
1095 PL_last_in_gv = NULL;
1106 SvREFCNT_dec(PL_envgv);
1107 SvREFCNT_dec(PL_incgv);
1108 SvREFCNT_dec(PL_argvgv);
1109 SvREFCNT_dec(PL_replgv);
1110 SvREFCNT_dec(PL_DBgv);
1111 SvREFCNT_dec(PL_DBline);
1112 SvREFCNT_dec(PL_DBsub);
1121 SvREFCNT_dec(PL_argvout_stack);
1122 PL_argvout_stack = NULL;
1124 SvREFCNT_dec(PL_modglobal);
1125 PL_modglobal = NULL;
1126 SvREFCNT_dec(PL_preambleav);
1127 PL_preambleav = NULL;
1128 SvREFCNT_dec(PL_subname);
1130 #ifdef PERL_USES_PL_PIDSTATUS
1131 SvREFCNT_dec(PL_pidstatus);
1132 PL_pidstatus = NULL;
1134 SvREFCNT_dec(PL_toptarget);
1135 PL_toptarget = NULL;
1136 SvREFCNT_dec(PL_bodytarget);
1137 PL_bodytarget = NULL;
1138 PL_formtarget = NULL;
1140 /* free locale stuff */
1141 #ifdef USE_LOCALE_COLLATE
1142 Safefree(PL_collation_name);
1143 PL_collation_name = NULL;
1145 #if defined(USE_POSIX_2008_LOCALE) \
1146 && defined(USE_THREAD_SAFE_LOCALE) \
1147 && ! defined(HAS_QUERYLOCALE)
1148 for (i = 0; i < (int) C_ARRAY_LENGTH(PL_curlocales); i++) {
1149 Safefree(PL_curlocales[i]);
1150 PL_curlocales[i] = NULL;
1153 #ifdef HAS_POSIX_2008_LOCALE
1155 /* This also makes sure we aren't using a locale object that gets freed
1157 const locale_t old_locale = uselocale(LC_GLOBAL_LOCALE);
1158 if ( old_locale != LC_GLOBAL_LOCALE
1159 # ifdef USE_POSIX_2008_LOCALE
1160 && old_locale != PL_C_locale_obj
1163 DEBUG_Lv(PerlIO_printf(Perl_debug_log,
1164 "%s:%d: Freeing %p\n", __FILE__, __LINE__, old_locale));
1165 freelocale(old_locale);
1168 # ifdef USE_LOCALE_NUMERIC
1169 if (PL_underlying_numeric_obj) {
1170 DEBUG_Lv(PerlIO_printf(Perl_debug_log,
1171 "%s:%d: Freeing %p\n", __FILE__, __LINE__,
1172 PL_underlying_numeric_obj));
1173 freelocale(PL_underlying_numeric_obj);
1174 PL_underlying_numeric_obj = (locale_t) NULL;
1178 #ifdef USE_LOCALE_NUMERIC
1179 Safefree(PL_numeric_name);
1180 PL_numeric_name = NULL;
1181 SvREFCNT_dec(PL_numeric_radix_sv);
1182 PL_numeric_radix_sv = NULL;
1185 if (PL_setlocale_buf) {
1186 Safefree(PL_setlocale_buf);
1187 PL_setlocale_buf = NULL;
1190 if (PL_langinfo_buf) {
1191 Safefree(PL_langinfo_buf);
1192 PL_langinfo_buf = NULL;
1195 #ifdef USE_LOCALE_CTYPE
1196 SvREFCNT_dec(PL_warn_locale);
1197 PL_warn_locale = NULL;
1200 SvREFCNT_dec(PL_AboveLatin1);
1201 PL_AboveLatin1 = NULL;
1202 SvREFCNT_dec(PL_Assigned_invlist);
1203 PL_Assigned_invlist = NULL;
1204 SvREFCNT_dec(PL_GCB_invlist);
1205 PL_GCB_invlist = NULL;
1206 SvREFCNT_dec(PL_HasMultiCharFold);
1207 PL_HasMultiCharFold = NULL;
1208 SvREFCNT_dec(PL_InMultiCharFold);
1209 PL_InMultiCharFold = NULL;
1210 SvREFCNT_dec(PL_Latin1);
1212 SvREFCNT_dec(PL_LB_invlist);
1213 PL_LB_invlist = NULL;
1214 SvREFCNT_dec(PL_SB_invlist);
1215 PL_SB_invlist = NULL;
1216 SvREFCNT_dec(PL_SCX_invlist);
1217 PL_SCX_invlist = NULL;
1218 SvREFCNT_dec(PL_UpperLatin1);
1219 PL_UpperLatin1 = NULL;
1220 SvREFCNT_dec(PL_in_some_fold);
1221 PL_in_some_fold = NULL;
1222 SvREFCNT_dec(PL_utf8_idcont);
1223 PL_utf8_idcont = NULL;
1224 SvREFCNT_dec(PL_utf8_idstart);
1225 PL_utf8_idstart = NULL;
1226 SvREFCNT_dec(PL_utf8_perl_idcont);
1227 PL_utf8_perl_idcont = NULL;
1228 SvREFCNT_dec(PL_utf8_perl_idstart);
1229 PL_utf8_perl_idstart = NULL;
1230 SvREFCNT_dec(PL_utf8_xidcont);
1231 PL_utf8_xidcont = NULL;
1232 SvREFCNT_dec(PL_utf8_xidstart);
1233 PL_utf8_xidstart = NULL;
1234 SvREFCNT_dec(PL_WB_invlist);
1235 PL_WB_invlist = NULL;
1236 SvREFCNT_dec(PL_utf8_toupper);
1237 PL_utf8_toupper = NULL;
1238 SvREFCNT_dec(PL_utf8_totitle);
1239 PL_utf8_totitle = NULL;
1240 SvREFCNT_dec(PL_utf8_tolower);
1241 PL_utf8_tolower = NULL;
1242 SvREFCNT_dec(PL_utf8_tofold);
1243 PL_utf8_tofold = NULL;
1244 SvREFCNT_dec(PL_utf8_tosimplefold);
1245 PL_utf8_tosimplefold = NULL;
1246 SvREFCNT_dec(PL_utf8_charname_begin);
1247 PL_utf8_charname_begin = NULL;
1248 SvREFCNT_dec(PL_utf8_charname_continue);
1249 PL_utf8_charname_continue = NULL;
1250 SvREFCNT_dec(PL_utf8_mark);
1251 PL_utf8_mark = NULL;
1252 SvREFCNT_dec(PL_InBitmap);
1254 SvREFCNT_dec(PL_CCC_non0_non230);
1255 PL_CCC_non0_non230 = NULL;
1256 SvREFCNT_dec(PL_Private_Use);
1257 PL_Private_Use = NULL;
1259 for (i = 0; i < POSIX_CC_COUNT; i++) {
1260 SvREFCNT_dec(PL_XPosix_ptrs[i]);
1261 PL_XPosix_ptrs[i] = NULL;
1263 if (i != _CC_CASED) { /* A copy of Alpha */
1264 SvREFCNT_dec(PL_Posix_ptrs[i]);
1265 PL_Posix_ptrs[i] = NULL;
1269 if (!specialWARN(PL_compiling.cop_warnings))
1270 PerlMemShared_free(PL_compiling.cop_warnings);
1271 PL_compiling.cop_warnings = NULL;
1272 cophh_free(CopHINTHASH_get(&PL_compiling));
1273 CopHINTHASH_set(&PL_compiling, cophh_new_empty());
1274 CopFILE_free(&PL_compiling);
1276 /* Prepare to destruct main symbol table. */
1279 /* break ref loop *:: <=> %:: */
1280 (void)hv_deletes(hv, "main::", G_DISCARD);
1283 SvREFCNT_dec(PL_curstname);
1284 PL_curstname = NULL;
1286 /* clear queued errors */
1287 SvREFCNT_dec(PL_errors);
1290 SvREFCNT_dec(PL_isarev);
1293 if (destruct_level >= 2) {
1294 if (PL_scopestack_ix != 0)
1295 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
1296 "Unbalanced scopes: %ld more ENTERs than LEAVEs\n",
1297 (long)PL_scopestack_ix);
1298 if (PL_savestack_ix != 0)
1299 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
1300 "Unbalanced saves: %ld more saves than restores\n",
1301 (long)PL_savestack_ix);
1302 if (PL_tmps_floor != -1)
1303 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced tmps: %ld more allocs than frees\n",
1304 (long)PL_tmps_floor + 1);
1305 if (cxstack_ix != -1)
1306 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced context: %ld more PUSHes than POPs\n",
1307 (long)cxstack_ix + 1);
1311 SvREFCNT_dec(PL_regex_padav);
1312 PL_regex_padav = NULL;
1313 PL_regex_pad = NULL;
1316 #ifdef PERL_IMPLICIT_CONTEXT
1317 /* the entries in this list are allocated via SV PVX's, so get freed
1318 * in sv_clean_all */
1319 Safefree(PL_my_cxt_list);
1322 /* Now absolutely destruct everything, somehow or other, loops or no. */
1324 /* the 2 is for PL_fdpid and PL_strtab */
1325 while (sv_clean_all() > 2)
1329 Safefree(PL_stashpad); /* must come after sv_clean_all */
1332 AvREAL_off(PL_fdpid); /* no surviving entries */
1333 SvREFCNT_dec(PL_fdpid); /* needed in io_close() */
1336 #ifdef HAVE_INTERP_INTERN
1340 /* constant strings */
1341 for (i = 0; i < SV_CONSTS_COUNT; i++) {
1342 SvREFCNT_dec(PL_sv_consts[i]);
1343 PL_sv_consts[i] = NULL;
1346 /* Destruct the global string table. */
1348 /* Yell and reset the HeVAL() slots that are still holding refcounts,
1349 * so that sv_free() won't fail on them.
1350 * Now that the global string table is using a single hunk of memory
1351 * for both HE and HEK, we either need to explicitly unshare it the
1352 * correct way, or actually free things here.
1355 const I32 max = HvMAX(PL_strtab);
1356 HE * const * const array = HvARRAY(PL_strtab);
1357 HE *hent = array[0];
1360 if (hent && ckWARN_d(WARN_INTERNAL)) {
1361 HE * const next = HeNEXT(hent);
1362 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
1363 "Unbalanced string table refcount: (%ld) for \"%s\"",
1364 (long)hent->he_valu.hent_refcount, HeKEY(hent));
1371 hent = array[riter];
1376 HvARRAY(PL_strtab) = 0;
1377 HvTOTALKEYS(PL_strtab) = 0;
1379 SvREFCNT_dec(PL_strtab);
1382 /* free the pointer tables used for cloning */
1383 ptr_table_free(PL_ptr_table);
1384 PL_ptr_table = (PTR_TBL_t*)NULL;
1387 /* free special SVs */
1389 SvREFCNT(&PL_sv_yes) = 0;
1390 sv_clear(&PL_sv_yes);
1391 SvANY(&PL_sv_yes) = NULL;
1392 SvFLAGS(&PL_sv_yes) = 0;
1394 SvREFCNT(&PL_sv_no) = 0;
1395 sv_clear(&PL_sv_no);
1396 SvANY(&PL_sv_no) = NULL;
1397 SvFLAGS(&PL_sv_no) = 0;
1399 SvREFCNT(&PL_sv_zero) = 0;
1400 sv_clear(&PL_sv_zero);
1401 SvANY(&PL_sv_zero) = NULL;
1402 SvFLAGS(&PL_sv_zero) = 0;
1406 for (i=0; i<=2; i++) {
1407 SvREFCNT(PERL_DEBUG_PAD(i)) = 0;
1408 sv_clear(PERL_DEBUG_PAD(i));
1409 SvANY(PERL_DEBUG_PAD(i)) = NULL;
1410 SvFLAGS(PERL_DEBUG_PAD(i)) = 0;
1414 if (PL_sv_count != 0 && ckWARN_d(WARN_INTERNAL))
1415 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Scalars leaked: %ld\n", (long)PL_sv_count);
1417 #ifdef DEBUG_LEAKING_SCALARS
1418 if (PL_sv_count != 0) {
1423 for (sva = PL_sv_arenaroot; sva; sva = MUTABLE_SV(SvANY(sva))) {
1424 svend = &sva[SvREFCNT(sva)];
1425 for (sv = sva + 1; sv < svend; ++sv) {
1426 if (SvTYPE(sv) != (svtype)SVTYPEMASK) {
1427 PerlIO_printf(Perl_debug_log, "leaked: sv=0x%p"
1429 " refcnt=%" UVuf pTHX__FORMAT "\n"
1430 "\tallocated at %s:%d %s %s (parent 0x%" UVxf ");"
1431 "serial %" UVuf "\n",
1432 (void*)sv, (UV)sv->sv_flags, (UV)sv->sv_refcnt
1434 sv->sv_debug_file ? sv->sv_debug_file : "(unknown)",
1436 sv->sv_debug_inpad ? "for" : "by",
1437 sv->sv_debug_optype ?
1438 PL_op_name[sv->sv_debug_optype]: "(none)",
1439 PTR2UV(sv->sv_debug_parent),
1442 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1443 Perl_dump_sv_child(aTHX_ sv);
1449 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1453 /* Wait for up to 4 seconds for child to terminate.
1454 This seems to be the least effort way of timing out on reaping
1456 struct timeval waitfor = {4, 0};
1457 int sock = PL_dumper_fd;
1461 FD_SET(sock, &rset);
1462 select(sock + 1, &rset, NULL, NULL, &waitfor);
1463 waitpid(child, &status, WNOHANG);
1468 #ifdef DEBUG_LEAKING_SCALARS_ABORT
1474 #if defined(PERLIO_LAYERS)
1475 /* No more IO - including error messages ! */
1476 PerlIO_cleanup(aTHX);
1479 /* sv_undef needs to stay immortal until after PerlIO_cleanup
1480 as currently layers use it rather than NULL as a marker
1481 for no arg - and will try and SvREFCNT_dec it.
1483 SvREFCNT(&PL_sv_undef) = 0;
1484 SvREADONLY_off(&PL_sv_undef);
1486 Safefree(PL_origfilename);
1487 PL_origfilename = NULL;
1488 Safefree(PL_reg_curpm);
1489 free_tied_hv_pool();
1490 Safefree(PL_op_mask);
1491 Safefree(PL_psig_name);
1492 PL_psig_name = (SV**)NULL;
1493 PL_psig_ptr = (SV**)NULL;
1495 /* We need to NULL PL_psig_pend first, so that
1496 signal handlers know not to use it */
1497 int *psig_save = PL_psig_pend;
1498 PL_psig_pend = (int*)NULL;
1499 Safefree(psig_save);
1502 TAINTING_set(FALSE);
1503 TAINT_WARN_set(FALSE);
1504 PL_hints = 0; /* Reset hints. Should hints be per-interpreter ? */
1506 DEBUG_P(debprofdump());
1510 #ifdef USE_REENTRANT_API
1511 Perl_reentrant_free(aTHX);
1514 /* These all point to HVs that are about to be blown away.
1515 Code in core and on CPAN assumes that if the interpreter is re-started
1516 that they will be cleanly NULL or pointing to a valid HV. */
1517 PL_custom_op_names = NULL;
1518 PL_custom_op_descs = NULL;
1519 PL_custom_ops = NULL;
1523 while (PL_regmatch_slab) {
1524 regmatch_slab *s = PL_regmatch_slab;
1525 PL_regmatch_slab = PL_regmatch_slab->next;
1529 /* As the absolutely last thing, free the non-arena SV for mess() */
1532 /* we know that type == SVt_PVMG */
1534 /* it could have accumulated taint magic */
1537 for (mg = SvMAGIC(PL_mess_sv); mg; mg = moremagic) {
1538 moremagic = mg->mg_moremagic;
1539 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global
1541 Safefree(mg->mg_ptr);
1545 /* we know that type >= SVt_PV */
1546 SvPV_free(PL_mess_sv);
1547 Safefree(SvANY(PL_mess_sv));
1548 Safefree(PL_mess_sv);
1555 =for apidoc perl_free
1557 Releases a Perl interpreter. See L<perlembed>.
1567 PERL_ARGS_ASSERT_PERL_FREE;
1569 if (PL_veto_cleanup)
1572 #ifdef PERL_TRACK_MEMPOOL
1575 * Don't free thread memory if PERL_DESTRUCT_LEVEL is set to a non-zero
1576 * value as we're probably hunting memory leaks then
1578 if (PL_perl_destruct_level == 0) {
1579 const U32 old_debug = PL_debug;
1580 /* Emulate the PerlHost behaviour of free()ing all memory allocated in this
1581 thread at thread exit. */
1583 PerlIO_puts(Perl_debug_log, "Disabling memory debugging as we "
1584 "free this thread's memory\n");
1585 PL_debug &= ~ DEBUG_m_FLAG;
1587 while(aTHXx->Imemory_debug_header.next != &(aTHXx->Imemory_debug_header)){
1588 char * next = (char *)(aTHXx->Imemory_debug_header.next);
1589 Malloc_t ptr = PERL_MEMORY_DEBUG_HEADER_SIZE + next;
1592 PL_debug = old_debug;
1597 #if defined(WIN32) || defined(NETWARE)
1598 # if defined(PERL_IMPLICIT_SYS)
1601 void *host = nw_internal_host;
1602 PerlMem_free(aTHXx);
1603 nw_delete_internal_host(host);
1605 void *host = w32_internal_host;
1606 PerlMem_free(aTHXx);
1607 win32_delete_internal_host(host);
1611 PerlMem_free(aTHXx);
1614 PerlMem_free(aTHXx);
1618 #if defined(USE_ITHREADS)
1619 /* provide destructors to clean up the thread key when libperl is unloaded */
1620 #ifndef WIN32 /* handled during DLL_PROCESS_DETACH in win32/perllib.c */
1622 #if defined(__hpux) && !(defined(__ux_version) && __ux_version <= 1020) && !defined(__GNUC__)
1623 #pragma fini "perl_fini"
1624 #elif defined(__sun) && !defined(__GNUC__)
1625 #pragma fini (perl_fini)
1629 #if defined(__GNUC__)
1630 __attribute__((destructor))
1636 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
1639 PL_curinterp && !PL_veto_cleanup)
1644 #endif /* THREADS */
1647 Perl_call_atexit(pTHX_ ATEXIT_t fn, void *ptr)
1649 Renew(PL_exitlist, PL_exitlistlen+1, PerlExitListEntry);
1650 PL_exitlist[PL_exitlistlen].fn = fn;
1651 PL_exitlist[PL_exitlistlen].ptr = ptr;
1656 =for apidoc perl_parse
1658 Tells a Perl interpreter to parse a Perl script. This performs most
1659 of the initialisation of a Perl interpreter. See L<perlembed> for
1662 C<my_perl> points to the Perl interpreter that is to parse the script.
1663 It must have been previously created through the use of L</perl_alloc>
1664 and L</perl_construct>. C<xsinit> points to a callback function that
1665 will be called to set up the ability for this Perl interpreter to load
1666 XS extensions, or may be null to perform no such setup.
1668 C<argc> and C<argv> supply a set of command-line arguments to the Perl
1669 interpreter, as would normally be passed to the C<main> function of
1670 a C program. C<argv[argc]> must be null. These arguments are where
1671 the script to parse is specified, either by naming a script file or by
1672 providing a script in a C<-e> option.
1673 If L<C<$0>|perlvar/$0> will be written to in the Perl interpreter, then
1674 the argument strings must be in writable memory, and so mustn't just be
1677 C<env> specifies a set of environment variables that will be used by
1678 this Perl interpreter. If non-null, it must point to a null-terminated
1679 array of environment strings. If null, the Perl interpreter will use
1680 the environment supplied by the C<environ> global variable.
1682 This function initialises the interpreter, and parses and compiles the
1683 script specified by the command-line arguments. This includes executing
1684 code in C<BEGIN>, C<UNITCHECK>, and C<CHECK> blocks. It does not execute
1685 C<INIT> blocks or the main program.
1687 Returns an integer of slightly tricky interpretation. The correct
1688 use of the return value is as a truth value indicating whether there
1689 was a failure in initialisation. If zero is returned, this indicates
1690 that initialisation was successful, and it is safe to proceed to call
1691 L</perl_run> and make other use of it. If a non-zero value is returned,
1692 this indicates some problem that means the interpreter wants to terminate.
1693 The interpreter should not be just abandoned upon such failure; the caller
1694 should proceed to shut the interpreter down cleanly with L</perl_destruct>
1695 and free it with L</perl_free>.
1697 For historical reasons, the non-zero return value also attempts to
1698 be a suitable value to pass to the C library function C<exit> (or to
1699 return from C<main>), to serve as an exit code indicating the nature
1700 of the way initialisation terminated. However, this isn't portable,
1701 due to differing exit code conventions. A historical bug is preserved
1702 for the time being: if the Perl built-in C<exit> is called during this
1703 function's execution, with a type of exit entailing a zero exit code
1704 under the host operating system's conventions, then this function
1705 returns zero rather than a non-zero value. This bug, [perl #2754],
1706 leads to C<perl_run> being called (and therefore C<INIT> blocks and the
1707 main program running) despite a call to C<exit>. It has been preserved
1708 because a popular module-installing module has come to rely on it and
1709 needs time to be fixed. This issue is [perl #132577], and the original
1710 bug is due to be fixed in Perl 5.30.
1715 #define SET_CURSTASH(newstash) \
1716 if (PL_curstash != newstash) { \
1717 SvREFCNT_dec(PL_curstash); \
1718 PL_curstash = (HV *)SvREFCNT_inc(newstash); \
1722 perl_parse(pTHXx_ XSINIT_t xsinit, int argc, char **argv, char **env)
1729 PERL_ARGS_ASSERT_PERL_PARSE;
1730 #ifndef MULTIPLICITY
1731 PERL_UNUSED_ARG(my_perl);
1733 #if (defined(USE_HASH_SEED) || defined(USE_HASH_SEED_DEBUG)) && !defined(NO_PERL_HASH_SEED_DEBUG)
1735 const char * const s = PerlEnv_getenv("PERL_HASH_SEED_DEBUG");
1737 if (s && strEQ(s, "1")) {
1738 const unsigned char *seed= PERL_HASH_SEED;
1739 const unsigned char *seed_end= PERL_HASH_SEED + PERL_HASH_SEED_BYTES;
1740 PerlIO_printf(Perl_debug_log, "HASH_FUNCTION = %s HASH_SEED = 0x", PERL_HASH_FUNC);
1741 while (seed < seed_end) {
1742 PerlIO_printf(Perl_debug_log, "%02x", *seed++);
1744 #ifdef PERL_HASH_RANDOMIZE_KEYS
1745 PerlIO_printf(Perl_debug_log, " PERTURB_KEYS = %d (%s)",
1746 PL_HASH_RAND_BITS_ENABLED,
1747 PL_HASH_RAND_BITS_ENABLED == 0 ? "NO" : PL_HASH_RAND_BITS_ENABLED == 1 ? "RANDOM" : "DETERMINISTIC");
1749 PerlIO_printf(Perl_debug_log, "\n");
1752 #endif /* #if (defined(USE_HASH_SEED) ... */
1756 struct NameTranslationInfo nti;
1757 __translate_amiga_to_unix_path_name(&argv[0],&nti);
1764 for(i = 0; i != argc; i++)
1766 assert(!argv[argc]);
1771 if (PL_origalen != 0) {
1772 PL_origalen = 1; /* don't use old PL_origalen if perl_parse() is called again */
1775 /* Set PL_origalen be the sum of the contiguous argv[]
1776 * elements plus the size of the env in case that it is
1777 * contiguous with the argv[]. This is used in mg.c:Perl_magic_set()
1778 * as the maximum modifiable length of $0. In the worst case
1779 * the area we are able to modify is limited to the size of
1780 * the original argv[0]. (See below for 'contiguous', though.)
1782 const char *s = NULL;
1783 const UV mask = ~(UV)(PTRSIZE-1);
1784 /* Do the mask check only if the args seem like aligned. */
1786 (mask < ~(UV)0) && ((PTR2UV(argv[0]) & mask) == PTR2UV(argv[0]));
1788 /* See if all the arguments are contiguous in memory. Note
1789 * that 'contiguous' is a loose term because some platforms
1790 * align the argv[] and the envp[]. If the arguments look
1791 * like non-aligned, assume that they are 'strictly' or
1792 * 'traditionally' contiguous. If the arguments look like
1793 * aligned, we just check that they are within aligned
1794 * PTRSIZE bytes. As long as no system has something bizarre
1795 * like the argv[] interleaved with some other data, we are
1796 * fine. (Did I just evoke Murphy's Law?) --jhi */
1797 if (PL_origargv && PL_origargc >= 1 && (s = PL_origargv[0])) {
1800 for (i = 1; i < PL_origargc; i++) {
1801 if ((PL_origargv[i] == s + 1
1803 || PL_origargv[i] == s + 2
1808 (PL_origargv[i] > s &&
1810 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1821 #ifndef PERL_USE_SAFE_PUTENV
1822 /* Can we grab env area too to be used as the area for $0? */
1823 if (s && PL_origenviron && !PL_use_safe_putenv) {
1824 if ((PL_origenviron[0] == s + 1)
1827 (PL_origenviron[0] > s &&
1828 PL_origenviron[0] <=
1829 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1833 #ifndef OS2 /* ENVIRON is read by the kernel too. */
1834 s = PL_origenviron[0];
1837 my_setenv("NoNe SuCh", NULL);
1838 /* Force copy of environment. */
1839 for (i = 1; PL_origenviron[i]; i++) {
1840 if (PL_origenviron[i] == s + 1
1843 (PL_origenviron[i] > s &&
1844 PL_origenviron[i] <=
1845 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1848 s = PL_origenviron[i];
1856 #endif /* !defined(PERL_USE_SAFE_PUTENV) */
1858 PL_origalen = s ? s - PL_origargv[0] + 1 : 0;
1863 /* Come here if running an undumped a.out. */
1865 PL_origfilename = savepv(argv[0]);
1866 PL_do_undump = FALSE;
1867 cxstack_ix = -1; /* start label stack again */
1869 assert (!TAINT_get);
1873 init_postdump_symbols(argc,argv,env);
1878 op_free(PL_main_root);
1879 PL_main_root = NULL;
1881 PL_main_start = NULL;
1882 SvREFCNT_dec(PL_main_cv);
1886 oldscope = PL_scopestack_ix;
1887 PL_dowarn = G_WARN_OFF;
1892 parse_body(env,xsinit);
1893 if (PL_unitcheckav) {
1894 call_list(oldscope, PL_unitcheckav);
1897 PERL_SET_PHASE(PERL_PHASE_CHECK);
1898 call_list(oldscope, PL_checkav);
1906 /* my_exit() was called */
1907 while (PL_scopestack_ix > oldscope)
1910 SET_CURSTASH(PL_defstash);
1911 if (PL_unitcheckav) {
1912 call_list(oldscope, PL_unitcheckav);
1915 PERL_SET_PHASE(PERL_PHASE_CHECK);
1916 call_list(oldscope, PL_checkav);
1921 * At this point we should do
1923 * to avoid [perl #2754], but that bugfix has been postponed
1924 * because of the Module::Install breakage it causes
1930 PerlIO_printf(Perl_error_log, "panic: top_env\n");
1938 /* This needs to stay in perl.c, as perl.c is compiled with different flags for
1939 miniperl, and we need to see those flags reflected in the values here. */
1941 /* What this returns is subject to change. Use the public interface in Config.
1944 S_Internals_V(pTHX_ CV *cv)
1947 #ifdef LOCAL_PATCH_COUNT
1948 const int local_patch_count = LOCAL_PATCH_COUNT;
1950 const int local_patch_count = 0;
1952 const int entries = 3 + local_patch_count;
1954 static const char non_bincompat_options[] =
1961 # ifdef NO_HASH_SEED
1964 # ifdef NO_TAINT_SUPPORT
1967 # ifdef PERL_BOOL_AS_CHAR
1968 " PERL_BOOL_AS_CHAR"
1970 # ifdef PERL_COPY_ON_WRITE
1971 " PERL_COPY_ON_WRITE"
1973 # ifdef PERL_DISABLE_PMC
1976 # ifdef PERL_DONT_CREATE_GVSV
1977 " PERL_DONT_CREATE_GVSV"
1979 # ifdef PERL_EXTERNAL_GLOB
1980 " PERL_EXTERNAL_GLOB"
1982 # ifdef PERL_HASH_FUNC_SIPHASH
1983 " PERL_HASH_FUNC_SIPHASH"
1985 # ifdef PERL_HASH_FUNC_SDBM
1986 " PERL_HASH_FUNC_SDBM"
1988 # ifdef PERL_HASH_FUNC_DJB2
1989 " PERL_HASH_FUNC_DJB2"
1991 # ifdef PERL_HASH_FUNC_SUPERFAST
1992 " PERL_HASH_FUNC_SUPERFAST"
1994 # ifdef PERL_HASH_FUNC_MURMUR3
1995 " PERL_HASH_FUNC_MURMUR3"
1997 # ifdef PERL_HASH_FUNC_ONE_AT_A_TIME
1998 " PERL_HASH_FUNC_ONE_AT_A_TIME"
2000 # ifdef PERL_HASH_FUNC_ONE_AT_A_TIME_HARD
2001 " PERL_HASH_FUNC_ONE_AT_A_TIME_HARD"
2003 # ifdef PERL_HASH_FUNC_ONE_AT_A_TIME_OLD
2004 " PERL_HASH_FUNC_ONE_AT_A_TIME_OLD"
2006 # ifdef PERL_IS_MINIPERL
2009 # ifdef PERL_MALLOC_WRAP
2012 # ifdef PERL_MEM_LOG
2015 # ifdef PERL_MEM_LOG_NOIMPL
2016 " PERL_MEM_LOG_NOIMPL"
2018 # ifdef PERL_OP_PARENT
2021 # ifdef PERL_PERTURB_KEYS_DETERMINISTIC
2022 " PERL_PERTURB_KEYS_DETERMINISTIC"
2024 # ifdef PERL_PERTURB_KEYS_DISABLED
2025 " PERL_PERTURB_KEYS_DISABLED"
2027 # ifdef PERL_PERTURB_KEYS_RANDOM
2028 " PERL_PERTURB_KEYS_RANDOM"
2030 # ifdef PERL_PRESERVE_IVUV
2031 " PERL_PRESERVE_IVUV"
2033 # ifdef PERL_RELOCATABLE_INCPUSH
2034 " PERL_RELOCATABLE_INCPUSH"
2036 # ifdef PERL_USE_DEVEL
2039 # ifdef PERL_USE_SAFE_PUTENV
2040 " PERL_USE_SAFE_PUTENV"
2042 # ifdef SILENT_NO_TAINT_SUPPORT
2043 " SILENT_NO_TAINT_SUPPORT"
2045 # ifdef UNLINK_ALL_VERSIONS
2046 " UNLINK_ALL_VERSIONS"
2048 # ifdef USE_ATTRIBUTES_FOR_PERLIO
2049 " USE_ATTRIBUTES_FOR_PERLIO"
2051 # ifdef USE_FAST_STDIO
2057 # ifdef USE_LOCALE_CTYPE
2060 # ifdef WIN32_NO_REGISTRY
2063 # ifdef USE_PERL_ATOF
2066 # ifdef USE_SITECUSTOMIZE
2067 " USE_SITECUSTOMIZE"
2069 # ifdef USE_THREAD_SAFE_LOCALE
2070 " USE_THREAD_SAFE_LOCALE"
2073 PERL_UNUSED_ARG(cv);
2074 PERL_UNUSED_VAR(items);
2076 EXTEND(SP, entries);
2078 PUSHs(sv_2mortal(newSVpv(PL_bincompat_options, 0)));
2079 PUSHs(Perl_newSVpvn_flags(aTHX_ non_bincompat_options,
2080 sizeof(non_bincompat_options) - 1, SVs_TEMP));
2082 #ifndef PERL_BUILD_DATE
2085 # define PERL_BUILD_DATE __DATE__ " " __TIME__
2087 # define PERL_BUILD_DATE __DATE__
2092 #ifdef PERL_BUILD_DATE
2093 PUSHs(Perl_newSVpvn_flags(aTHX_
2094 STR_WITH_LEN("Compiled at " PERL_BUILD_DATE),
2097 PUSHs(&PL_sv_undef);
2100 for (i = 1; i <= local_patch_count; i++) {
2101 /* This will be an undef, if PL_localpatches[i] is NULL. */
2102 PUSHs(sv_2mortal(newSVpv(PL_localpatches[i], 0)));
2108 #define INCPUSH_UNSHIFT 0x01
2109 #define INCPUSH_ADD_OLD_VERS 0x02
2110 #define INCPUSH_ADD_VERSIONED_SUB_DIRS 0x04
2111 #define INCPUSH_ADD_ARCHONLY_SUB_DIRS 0x08
2112 #define INCPUSH_NOT_BASEDIR 0x10
2113 #define INCPUSH_CAN_RELOCATE 0x20
2114 #define INCPUSH_ADD_SUB_DIRS \
2115 (INCPUSH_ADD_VERSIONED_SUB_DIRS|INCPUSH_ADD_ARCHONLY_SUB_DIRS)
2118 S_parse_body(pTHX_ char **env, XSINIT_t xsinit)
2122 int argc = PL_origargc;
2123 char **argv = PL_origargv;
2124 const char *scriptname = NULL;
2125 bool dosearch = FALSE;
2127 bool doextract = FALSE;
2128 const char *cddir = NULL;
2129 #ifdef USE_SITECUSTOMIZE
2130 bool minus_f = FALSE;
2132 SV *linestr_sv = NULL;
2133 bool add_read_e_script = FALSE;
2134 U32 lex_start_flags = 0;
2136 PERL_SET_PHASE(PERL_PHASE_START);
2142 for (argc--,argv++; argc > 0; argc--,argv++) {
2143 if (argv[0][0] != '-' || !argv[0][1])
2149 #ifndef PERL_STRICT_CR
2173 if ((s = moreswitches(s)))
2178 #if defined(SILENT_NO_TAINT_SUPPORT)
2179 /* silently ignore */
2180 #elif defined(NO_TAINT_SUPPORT)
2181 Perl_croak_nocontext("This perl was compiled without taint support. "
2182 "Cowardly refusing to run with -t or -T flags");
2184 CHECK_MALLOC_TOO_LATE_FOR('t');
2185 if( !TAINTING_get ) {
2186 TAINT_WARN_set(TRUE);
2193 #if defined(SILENT_NO_TAINT_SUPPORT)
2194 /* silently ignore */
2195 #elif defined(NO_TAINT_SUPPORT)
2196 Perl_croak_nocontext("This perl was compiled without taint support. "
2197 "Cowardly refusing to run with -t or -T flags");
2199 CHECK_MALLOC_TOO_LATE_FOR('T');
2201 TAINT_WARN_set(FALSE);
2210 forbid_setid('e', FALSE);
2212 PL_e_script = newSVpvs("");
2213 add_read_e_script = TRUE;
2216 sv_catpv(PL_e_script, s);
2218 sv_catpv(PL_e_script, argv[1]);
2222 Perl_croak(aTHX_ "No code specified for -%c", c);
2223 sv_catpvs(PL_e_script, "\n");
2227 #ifdef USE_SITECUSTOMIZE
2233 case 'I': /* -I handled both here and in moreswitches() */
2234 forbid_setid('I', FALSE);
2235 if (!*++s && (s=argv[1]) != NULL) {
2239 STRLEN len = strlen(s);
2240 incpush(s, len, INCPUSH_ADD_SUB_DIRS|INCPUSH_ADD_OLD_VERS);
2243 Perl_croak(aTHX_ "No directory specified for -I");
2246 forbid_setid('S', FALSE);
2255 opts_prog = newSVpvs("use Config; Config::_V()");
2259 opts_prog = Perl_newSVpvf(aTHX_
2260 "use Config; Config::config_vars(qw%c%s%c)",
2264 Perl_av_create_and_push(aTHX_ &PL_preambleav, opts_prog);
2265 /* don't look for script or read stdin */
2266 scriptname = BIT_BUCKET;
2278 if (!*++s || isSPACE(*s)) {
2282 /* catch use of gnu style long options.
2283 Both of these exit immediately. */
2284 if (strEQ(s, "version"))
2286 if (strEQ(s, "help"))
2291 Perl_croak(aTHX_ "Unrecognized switch: -%s (-h will show valid options)",s);
2302 #ifndef SECURE_INTERNAL_GETENV
2305 (s = PerlEnv_getenv("PERL5OPT")))
2307 /* s points to static memory in getenv(), which may be overwritten at
2308 * any time; use a mortal copy instead */
2309 s = SvPVX(sv_2mortal(newSVpv(s, 0)));
2313 if (*s == '-' && *(s+1) == 'T') {
2314 #if defined(SILENT_NO_TAINT_SUPPORT)
2315 /* silently ignore */
2316 #elif defined(NO_TAINT_SUPPORT)
2317 Perl_croak_nocontext("This perl was compiled without taint support. "
2318 "Cowardly refusing to run with -t or -T flags");
2320 CHECK_MALLOC_TOO_LATE_FOR('T');
2322 TAINT_WARN_set(FALSE);
2326 char *popt_copy = NULL;
2339 if (!memCHRs("CDIMUdmtwW", *s))
2340 Perl_croak(aTHX_ "Illegal switch in PERL5OPT: -%c", *s);
2344 popt_copy = SvPVX(sv_2mortal(newSVpv(d,0)));
2345 s = popt_copy + (s - d);
2353 #if defined(SILENT_NO_TAINT_SUPPORT)
2354 /* silently ignore */
2355 #elif defined(NO_TAINT_SUPPORT)
2356 Perl_croak_nocontext("This perl was compiled without taint support. "
2357 "Cowardly refusing to run with -t or -T flags");
2359 if( !TAINTING_get) {
2360 TAINT_WARN_set(TRUE);
2372 #ifndef NO_PERL_INTERNAL_RAND_SEED
2373 /* If we're not set[ug]id, we might have honored
2374 PERL_INTERNAL_RAND_SEED in perl_construct().
2375 At this point command-line options have been parsed, so if
2376 we're now tainting and not set[ug]id re-seed.
2377 This could possibly be wasteful if PERL_INTERNAL_RAND_SEED is invalid,
2378 but avoids duplicating the logic from perl_construct().
2381 PerlProc_getuid() == PerlProc_geteuid() &&
2382 PerlProc_getgid() == PerlProc_getegid()) {
2383 Perl_drand48_init_r(&PL_internal_random_state, seed());
2387 /* Set $^X early so that it can be used for relocatable paths in @INC */
2388 /* and for SITELIB_EXP in USE_SITECUSTOMIZE */
2389 assert (!TAINT_get);
2394 #if defined(USE_SITECUSTOMIZE)
2396 /* The games with local $! are to avoid setting errno if there is no
2397 sitecustomize script. "q%c...%c", 0, ..., 0 becomes "q\0...\0",
2398 ie a q() operator with a NUL byte as a the delimiter. This avoids
2399 problems with pathnames containing (say) ' */
2400 # ifdef PERL_IS_MINIPERL
2401 AV *const inc = GvAV(PL_incgv);
2402 SV **const inc0 = inc ? av_fetch(inc, 0, FALSE) : NULL;
2405 /* if lib/buildcustomize.pl exists, it should not fail. If it does,
2406 it should be reported immediately as a build failure. */
2407 (void)Perl_av_create_and_unshift_one(aTHX_ &PL_preambleav,
2409 "BEGIN { my $f = q%c%s%" SVf "/buildcustomize.pl%c; "
2410 "do {local $!; -f $f }"
2411 " and do $f || die $@ || qq '$f: $!' }",
2412 0, (TAINTING_get ? "./" : ""), SVfARG(*inc0), 0));
2415 /* SITELIB_EXP is a function call on Win32. */
2416 const char *const raw_sitelib = SITELIB_EXP;
2418 /* process .../.. if PERL_RELOCATABLE_INC is defined */
2419 SV *sitelib_sv = mayberelocate(raw_sitelib, strlen(raw_sitelib),
2420 INCPUSH_CAN_RELOCATE);
2421 const char *const sitelib = SvPVX(sitelib_sv);
2422 (void)Perl_av_create_and_unshift_one(aTHX_ &PL_preambleav,
2424 "BEGIN { do {local $!; -f q%c%s/sitecustomize.pl%c} && do q%c%s/sitecustomize.pl%c }",
2425 0, SVfARG(sitelib), 0,
2426 0, SVfARG(sitelib), 0));
2427 assert (SvREFCNT(sitelib_sv) == 1);
2428 SvREFCNT_dec(sitelib_sv);
2435 scriptname = argv[0];
2438 scriptname = BIT_BUCKET; /* don't look for script or read stdin */
2440 else if (scriptname == NULL) {
2442 if ( PerlLIO_isatty(PerlIO_fileno(PerlIO_stdin())) )
2448 assert (!TAINT_get);
2452 bool suidscript = FALSE;
2454 rsfp = open_script(scriptname, dosearch, &suidscript);
2456 rsfp = PerlIO_stdin();
2457 lex_start_flags = LEX_DONT_CLOSE_RSFP;
2460 validate_suid(rsfp);
2463 # if defined(SIGCHLD) || defined(SIGCLD)
2466 # define SIGCHLD SIGCLD
2468 Sighandler_t sigstate = rsignal_state(SIGCHLD);
2469 if (sigstate == (Sighandler_t) SIG_IGN) {
2470 Perl_ck_warner(aTHX_ packWARN(WARN_SIGNAL),
2471 "Can't ignore signal CHLD, forcing to default");
2472 (void)rsignal(SIGCHLD, (Sighandler_t)SIG_DFL);
2480 /* This will croak if suidscript is true, as -x cannot be used with
2482 forbid_setid('x', suidscript);
2483 /* Hence you can't get here if suidscript is true */
2485 linestr_sv = newSV_type(SVt_PV);
2486 lex_start_flags |= LEX_START_COPIED;
2487 find_beginning(linestr_sv, rsfp);
2488 if (cddir && PerlDir_chdir( (char *)cddir ) < 0)
2489 Perl_croak(aTHX_ "Can't chdir to %s",cddir);
2493 PL_main_cv = PL_compcv = MUTABLE_CV(newSV_type(SVt_PVCV));
2494 CvUNIQUE_on(PL_compcv);
2496 CvPADLIST_set(PL_compcv, pad_new(0));
2498 PL_isarev = newHV();
2501 boot_core_UNIVERSAL();
2503 newXS("Internals::V", S_Internals_V, __FILE__);
2506 (*xsinit)(aTHX); /* in case linked C routines want magical variables */
2508 #if defined(VMS) || defined(WIN32) || defined(DJGPP) || defined(__CYGWIN__) || defined(SYMBIAN)
2514 # ifdef HAS_SOCKS5_INIT
2515 socks5_init(argv[0]);
2521 init_predump_symbols();
2522 /* init_postdump_symbols not currently designed to be called */
2523 /* more than once (ENV isn't cleared first, for example) */
2524 /* But running with -u leaves %ENV & @ARGV undefined! XXX */
2526 init_postdump_symbols(argc,argv,env);
2528 /* PL_unicode is turned on by -C, or by $ENV{PERL_UNICODE},
2529 * or explicitly in some platforms.
2530 * PL_utf8locale is conditionally turned on by
2531 * locale.c:Perl_init_i18nl10n() if the environment
2532 * look like the user wants to use UTF-8. */
2533 #if defined(__SYMBIAN32__)
2534 PL_unicode = PERL_UNICODE_STD_FLAG; /* See PERL_SYMBIAN_CONSOLE_UTF8. */
2536 # ifndef PERL_IS_MINIPERL
2538 /* Requires init_predump_symbols(). */
2539 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
2544 /* Turn on UTF-8-ness on STDIN, STDOUT, STDERR
2545 * and the default open disciplines. */
2546 if ((PL_unicode & PERL_UNICODE_STDIN_FLAG) &&
2547 PL_stdingv && (io = GvIO(PL_stdingv)) &&
2549 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2550 if ((PL_unicode & PERL_UNICODE_STDOUT_FLAG) &&
2551 PL_defoutgv && (io = GvIO(PL_defoutgv)) &&
2553 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2554 if ((PL_unicode & PERL_UNICODE_STDERR_FLAG) &&
2555 PL_stderrgv && (io = GvIO(PL_stderrgv)) &&
2557 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2558 if ((PL_unicode & PERL_UNICODE_INOUT_FLAG) &&
2559 (sv = GvSV(gv_fetchpvs("\017PEN", GV_ADD|GV_NOTQUAL,
2561 U32 in = PL_unicode & PERL_UNICODE_IN_FLAG;
2562 U32 out = PL_unicode & PERL_UNICODE_OUT_FLAG;
2565 sv_setpvs(sv, ":utf8\0:utf8");
2567 sv_setpvs(sv, ":utf8\0");
2570 sv_setpvs(sv, "\0:utf8");
2579 if ((s = PerlEnv_getenv("PERL_SIGNALS"))) {
2580 if (strEQ(s, "unsafe"))
2581 PL_signals |= PERL_SIGNALS_UNSAFE_FLAG;
2582 else if (strEQ(s, "safe"))
2583 PL_signals &= ~PERL_SIGNALS_UNSAFE_FLAG;
2585 Perl_croak(aTHX_ "PERL_SIGNALS illegal: \"%s\"", s);
2590 lex_start(linestr_sv, rsfp, lex_start_flags);
2591 SvREFCNT_dec(linestr_sv);
2593 PL_subname = newSVpvs("main");
2595 if (add_read_e_script)
2596 filter_add(read_e_script, NULL);
2598 /* now parse the script */
2600 SETERRNO(0,SS_NORMAL);
2601 if (yyparse(GRAMPROG) || PL_parser->error_count) {
2602 abort_execution("", PL_origfilename);
2604 CopLINE_set(PL_curcop, 0);
2605 SET_CURSTASH(PL_defstash);
2607 SvREFCNT_dec(PL_e_script);
2615 SAVECOPFILE(PL_curcop);
2616 SAVECOPLINE(PL_curcop);
2617 gv_check(PL_defstash);
2627 s = PerlEnv_getenv("PERL_DEBUG_MSTATS");
2628 if (s && grok_atoUV(s, &uv, NULL) && uv >= 2)
2629 dump_mstats("after compilation:");
2634 PL_restartjmpenv = NULL;
2640 =for apidoc perl_run
2642 Tells a Perl interpreter to run its main program. See L<perlembed>
2645 C<my_perl> points to the Perl interpreter. It must have been previously
2646 created through the use of L</perl_alloc> and L</perl_construct>, and
2647 initialised through L</perl_parse>. This function should not be called
2648 if L</perl_parse> returned a non-zero value, indicating a failure in
2649 initialisation or compilation.
2651 This function executes code in C<INIT> blocks, and then executes the
2652 main program. The code to be executed is that established by the prior
2653 call to L</perl_parse>. If the interpreter's C<PL_exit_flags> word
2654 does not have the C<PERL_EXIT_DESTRUCT_END> flag set, then this function
2655 will also execute code in C<END> blocks. If it is desired to make any
2656 further use of the interpreter after calling this function, then C<END>
2657 blocks should be postponed to L</perl_destruct> time by setting that flag.
2659 Returns an integer of slightly tricky interpretation. The correct use
2660 of the return value is as a truth value indicating whether the program
2661 terminated non-locally. If zero is returned, this indicates that
2662 the program ran to completion, and it is safe to make other use of the
2663 interpreter (provided that the C<PERL_EXIT_DESTRUCT_END> flag was set as
2664 described above). If a non-zero value is returned, this indicates that
2665 the interpreter wants to terminate early. The interpreter should not be
2666 just abandoned because of this desire to terminate; the caller should
2667 proceed to shut the interpreter down cleanly with L</perl_destruct>
2668 and free it with L</perl_free>.
2670 For historical reasons, the non-zero return value also attempts to
2671 be a suitable value to pass to the C library function C<exit> (or to
2672 return from C<main>), to serve as an exit code indicating the nature of
2673 the way the program terminated. However, this isn't portable, due to
2674 differing exit code conventions. An attempt is made to return an exit
2675 code of the type required by the host operating system, but because
2676 it is constrained to be non-zero, it is not necessarily possible to
2677 indicate every type of exit. It is only reliable on Unix, where a zero
2678 exit code can be augmented with a set bit that will be ignored. In any
2679 case, this function is not the correct place to acquire an exit code:
2680 one should get that from L</perl_destruct>.
2692 PERL_ARGS_ASSERT_PERL_RUN;
2693 #ifndef MULTIPLICITY
2694 PERL_UNUSED_ARG(my_perl);
2697 oldscope = PL_scopestack_ix;
2705 cxstack_ix = -1; /* start context stack again */
2707 case 0: /* normal completion */
2711 case 2: /* my_exit() */
2712 while (PL_scopestack_ix > oldscope)
2715 SET_CURSTASH(PL_defstash);
2716 if (!(PL_exit_flags & PERL_EXIT_DESTRUCT_END) &&
2717 PL_endav && !PL_minus_c) {
2718 PERL_SET_PHASE(PERL_PHASE_END);
2719 call_list(oldscope, PL_endav);
2722 if (PerlEnv_getenv("PERL_DEBUG_MSTATS"))
2723 dump_mstats("after execution: ");
2729 POPSTACK_TO(PL_mainstack);
2732 PerlIO_printf(Perl_error_log, "panic: restartop in perl_run\n");
2743 S_run_body(pTHX_ I32 oldscope)
2745 DEBUG_r(PerlIO_printf(Perl_debug_log, "%s $` $& $' support (0x%x).\n",
2746 PL_sawampersand ? "Enabling" : "Omitting",
2747 (unsigned int)(PL_sawampersand)));
2749 if (!PL_restartop) {
2751 if (DEBUG_x_TEST || DEBUG_B_TEST)
2752 dump_all_perl(!DEBUG_B_TEST);
2754 PERL_DEBUG(PerlIO_printf(Perl_debug_log, "\nEXECUTING...\n\n"));
2758 PerlIO_printf(Perl_error_log, "%s syntax OK\n", PL_origfilename);
2761 if (PERLDB_SINGLE && PL_DBsingle)
2764 PERL_SET_PHASE(PERL_PHASE_INIT);
2765 call_list(oldscope, PL_initav);
2767 #ifdef PERL_DEBUG_READONLY_OPS
2768 if (PL_main_root && PL_main_root->op_slabbed)
2769 Slab_to_ro(OpSLAB(PL_main_root));
2775 PERL_SET_PHASE(PERL_PHASE_RUN);
2778 PL_restartjmpenv = NULL;
2779 PL_op = PL_restartop;
2783 else if (PL_main_start) {
2784 CvDEPTH(PL_main_cv) = 1;
2785 PL_op = PL_main_start;
2789 NOT_REACHED; /* NOTREACHED */
2793 =head1 SV Manipulation Functions
2797 Returns the SV of the specified Perl scalar. C<flags> are passed to
2798 C<gv_fetchpv>. If C<GV_ADD> is set and the
2799 Perl variable does not exist then it will be created. If C<flags> is zero
2800 and the variable does not exist then NULL is returned.
2806 Perl_get_sv(pTHX_ const char *name, I32 flags)
2810 PERL_ARGS_ASSERT_GET_SV;
2812 gv = gv_fetchpv(name, flags, SVt_PV);
2819 =head1 Array Manipulation Functions
2823 Returns the AV of the specified Perl global or package array with the given
2824 name (so it won't work on lexical variables). C<flags> are passed
2825 to C<gv_fetchpv>. If C<GV_ADD> is set and the
2826 Perl variable does not exist then it will be created. If C<flags> is zero
2827 and the variable does not exist then NULL is returned.
2829 Perl equivalent: C<@{"$name"}>.
2835 Perl_get_av(pTHX_ const char *name, I32 flags)
2837 GV* const gv = gv_fetchpv(name, flags, SVt_PVAV);
2839 PERL_ARGS_ASSERT_GET_AV;
2849 =head1 Hash Manipulation Functions
2853 Returns the HV of the specified Perl hash. C<flags> are passed to
2854 C<gv_fetchpv>. If C<GV_ADD> is set and the
2855 Perl variable does not exist then it will be created. If C<flags> is zero
2856 and the variable does not exist then C<NULL> is returned.
2862 Perl_get_hv(pTHX_ const char *name, I32 flags)
2864 GV* const gv = gv_fetchpv(name, flags, SVt_PVHV);
2866 PERL_ARGS_ASSERT_GET_HV;
2876 =head1 CV Manipulation Functions
2878 =for apidoc get_cvn_flags
2880 Returns the CV of the specified Perl subroutine. C<flags> are passed to
2881 C<gv_fetchpvn_flags>. If C<GV_ADD> is set and the Perl subroutine does not
2882 exist then it will be declared (which has the same effect as saying
2883 C<sub name;>). If C<GV_ADD> is not set and the subroutine does not exist
2884 then NULL is returned.
2888 Uses C<strlen> to get the length of C<name>, then calls C<get_cvn_flags>.
2894 Perl_get_cvn_flags(pTHX_ const char *name, STRLEN len, I32 flags)
2896 GV* const gv = gv_fetchpvn_flags(name, len, flags, SVt_PVCV);
2898 PERL_ARGS_ASSERT_GET_CVN_FLAGS;
2900 if (gv && UNLIKELY(SvROK(gv)) && SvTYPE(SvRV((SV *)gv)) == SVt_PVCV)
2901 return (CV*)SvRV((SV *)gv);
2903 /* XXX this is probably not what they think they're getting.
2904 * It has the same effect as "sub name;", i.e. just a forward
2906 if ((flags & ~GV_NOADD_MASK) && !GvCVu(gv)) {
2907 return newSTUB(gv,0);
2914 /* Nothing in core calls this now, but we can't replace it with a macro and
2915 move it to mathoms.c as a macro would evaluate name twice. */
2917 Perl_get_cv(pTHX_ const char *name, I32 flags)
2919 PERL_ARGS_ASSERT_GET_CV;
2921 return get_cvn_flags(name, strlen(name), flags);
2924 /* Be sure to refetch the stack pointer after calling these routines. */
2928 =head1 Callback Functions
2930 =for apidoc call_argv
2932 Performs a callback to the specified named and package-scoped Perl subroutine
2933 with C<argv> (a C<NULL>-terminated array of strings) as arguments. See
2936 Approximate Perl equivalent: C<&{"$sub_name"}(@$argv)>.
2942 Perl_call_argv(pTHX_ const char *sub_name, I32 flags, char **argv)
2944 /* See G_* flags in cop.h */
2945 /* null terminated arg list */
2949 PERL_ARGS_ASSERT_CALL_ARGV;
2953 mXPUSHs(newSVpv(*argv,0));
2957 return call_pv(sub_name, flags);
2963 Performs a callback to the specified Perl sub. See L<perlcall>.
2969 Perl_call_pv(pTHX_ const char *sub_name, I32 flags)
2970 /* name of the subroutine */
2971 /* See G_* flags in cop.h */
2973 PERL_ARGS_ASSERT_CALL_PV;
2975 return call_sv(MUTABLE_SV(get_cv(sub_name, GV_ADD)), flags);
2979 =for apidoc call_method
2981 Performs a callback to the specified Perl method. The blessed object must
2982 be on the stack. See L<perlcall>.
2988 Perl_call_method(pTHX_ const char *methname, I32 flags)
2989 /* name of the subroutine */
2990 /* See G_* flags in cop.h */
2994 PERL_ARGS_ASSERT_CALL_METHOD;
2996 len = strlen(methname);
2997 sv = flags & G_METHOD_NAMED
2998 ? sv_2mortal(newSVpvn_share(methname, len,0))
2999 : newSVpvn_flags(methname, len, SVs_TEMP);
3001 return call_sv(sv, flags | G_METHOD);
3004 /* May be called with any of a CV, a GV, or an SV containing the name. */
3008 Performs a callback to the Perl sub specified by the SV.
3010 If neither the C<G_METHOD> nor C<G_METHOD_NAMED> flag is supplied, the
3011 SV may be any of a CV, a GV, a reference to a CV, a reference to a GV
3012 or C<SvPV(sv)> will be used as the name of the sub to call.
3014 If the C<G_METHOD> flag is supplied, the SV may be a reference to a CV or
3015 C<SvPV(sv)> will be used as the name of the method to call.
3017 If the C<G_METHOD_NAMED> flag is supplied, C<SvPV(sv)> will be used as
3018 the name of the method to call.
3020 Some other values are treated specially for internal use and should
3025 =for apidoc Amnh||G_METHOD
3026 =for apidoc Amnh||G_METHOD_NAMED
3032 Perl_call_sv(pTHX_ SV *sv, volatile I32 flags)
3033 /* See G_* flags in cop.h */
3036 LOGOP myop; /* fake syntax tree node */
3039 volatile I32 retval = 0;
3040 bool oldcatch = CATCH_GET;
3042 OP* const oldop = PL_op;
3045 PERL_ARGS_ASSERT_CALL_SV;
3047 if (flags & G_DISCARD) {
3051 if (!(flags & G_WANT)) {
3052 /* Backwards compatibility - as G_SCALAR was 0, it could be omitted.
3057 Zero(&myop, 1, LOGOP);
3058 if (!(flags & G_NOARGS))
3059 myop.op_flags |= OPf_STACKED;
3060 myop.op_flags |= OP_GIMME_REVERSE(flags);
3064 if (!(flags & G_METHOD_NAMED)) {
3072 if (PERLDB_SUB && PL_curstash != PL_debstash
3073 /* Handle first BEGIN of -d. */
3074 && (PL_DBcv || (PL_DBcv = GvCV(PL_DBsub)))
3075 /* Try harder, since this may have been a sighandler, thus
3076 * curstash may be meaningless. */
3077 && (SvTYPE(sv) != SVt_PVCV || CvSTASH((const CV *)sv) != PL_debstash)
3078 && !(flags & G_NODEBUG))
3079 myop.op_private |= OPpENTERSUB_DB;
3081 if (flags & (G_METHOD|G_METHOD_NAMED)) {
3082 Zero(&method_op, 1, METHOP);
3083 method_op.op_next = (OP*)&myop;
3084 PL_op = (OP*)&method_op;
3085 if ( flags & G_METHOD_NAMED ) {
3086 method_op.op_ppaddr = PL_ppaddr[OP_METHOD_NAMED];
3087 method_op.op_type = OP_METHOD_NAMED;
3088 method_op.op_u.op_meth_sv = sv;
3090 method_op.op_ppaddr = PL_ppaddr[OP_METHOD];
3091 method_op.op_type = OP_METHOD;
3093 myop.op_ppaddr = PL_ppaddr[OP_ENTERSUB];
3094 myop.op_type = OP_ENTERSUB;
3097 if (!(flags & G_EVAL)) {
3099 CALL_BODY_SUB((OP*)&myop);
3100 retval = PL_stack_sp - (PL_stack_base + oldmark);
3101 CATCH_SET(oldcatch);
3105 myop.op_other = (OP*)&myop;
3107 old_cxix = cxstack_ix;
3108 create_eval_scope(NULL, flags|G_FAKINGEVAL);
3116 CALL_BODY_SUB((OP*)&myop);
3117 retval = PL_stack_sp - (PL_stack_base + oldmark);
3118 if (!(flags & G_KEEPERR)) {
3126 /* my_exit() was called */
3127 SET_CURSTASH(PL_defstash);
3131 NOT_REACHED; /* NOTREACHED */
3134 PL_restartjmpenv = NULL;
3135 PL_op = PL_restartop;
3139 PL_stack_sp = PL_stack_base + oldmark;
3140 if ((flags & G_WANT) == G_ARRAY)
3144 *++PL_stack_sp = &PL_sv_undef;
3149 /* if we croaked, depending on how we croaked the eval scope
3150 * may or may not have already been popped */
3151 if (cxstack_ix > old_cxix) {
3152 assert(cxstack_ix == old_cxix + 1);
3153 assert(CxTYPE(CX_CUR()) == CXt_EVAL);
3154 delete_eval_scope();
3159 if (flags & G_DISCARD) {
3160 PL_stack_sp = PL_stack_base + oldmark;
3169 /* Eval a string. The G_EVAL flag is always assumed. */
3174 Tells Perl to C<eval> the string in the SV. It supports the same flags
3175 as C<call_sv>, with the obvious exception of C<G_EVAL>. See L<perlcall>.
3177 The C<G_RETHROW> flag can be used if you only need eval_sv() to
3178 execute code specified by a string, but not catch any errors.
3180 =for apidoc Amnh||G_RETHROW
3185 Perl_eval_sv(pTHX_ SV *sv, I32 flags)
3187 /* See G_* flags in cop.h */
3190 UNOP myop; /* fake syntax tree node */
3191 volatile I32 oldmark;
3192 volatile I32 retval = 0;
3194 OP* const oldop = PL_op;
3197 PERL_ARGS_ASSERT_EVAL_SV;
3199 if (flags & G_DISCARD) {
3206 Zero(&myop, 1, UNOP);
3209 oldmark = SP - PL_stack_base;
3215 if (!(flags & G_NOARGS))
3216 myop.op_flags = OPf_STACKED;
3217 myop.op_type = OP_ENTEREVAL;
3218 myop.op_flags |= OP_GIMME_REVERSE(flags);
3219 if (flags & G_KEEPERR)
3220 myop.op_flags |= OPf_SPECIAL;
3222 if (flags & G_RE_REPARSING)
3223 myop.op_private = (OPpEVAL_COPHH | OPpEVAL_RE_REPARSING);
3225 /* fail now; otherwise we could fail after the JMPENV_PUSH but
3226 * before a cx_pusheval(), which corrupts the stack after a croak */
3227 TAINT_PROPER("eval_sv()");
3233 if (PL_op == (OP*)(&myop)) {
3234 PL_op = PL_ppaddr[OP_ENTEREVAL](aTHX);
3236 goto fail; /* failed in compilation */
3239 retval = PL_stack_sp - (PL_stack_base + oldmark);
3240 if (!(flags & G_KEEPERR)) {
3248 /* my_exit() was called */
3249 SET_CURSTASH(PL_defstash);
3253 NOT_REACHED; /* NOTREACHED */
3256 PL_restartjmpenv = NULL;
3257 PL_op = PL_restartop;
3262 if (flags & G_RETHROW) {
3267 PL_stack_sp = PL_stack_base + oldmark;
3268 if ((flags & G_WANT) == G_ARRAY)
3272 *++PL_stack_sp = &PL_sv_undef;
3278 if (flags & G_DISCARD) {
3279 PL_stack_sp = PL_stack_base + oldmark;
3291 Tells Perl to C<eval> the given string in scalar context and return an SV* result.
3297 Perl_eval_pv(pTHX_ const char *p, I32 croak_on_error)
3299 SV* sv = newSVpv(p, 0);
3301 PERL_ARGS_ASSERT_EVAL_PV;
3303 if (croak_on_error) {
3305 eval_sv(sv, G_SCALAR | G_RETHROW);
3308 eval_sv(sv, G_SCALAR);
3321 /* Require a module. */
3324 =head1 Embedding Functions
3326 =for apidoc require_pv
3328 Tells Perl to C<require> the file named by the string argument. It is
3329 analogous to the Perl code C<eval "require '$file'">. It's even
3330 implemented that way; consider using load_module instead.
3335 Perl_require_pv(pTHX_ const char *pv)
3340 PERL_ARGS_ASSERT_REQUIRE_PV;
3342 PUSHSTACKi(PERLSI_REQUIRE);
3343 sv = Perl_newSVpvf(aTHX_ "require q%c%s%c", 0, pv, 0);
3344 eval_sv(sv_2mortal(sv), G_DISCARD);
3349 S_usage(pTHX) /* XXX move this out into a module ? */
3351 /* This message really ought to be max 23 lines.
3352 * Removed -h because the user already knows that option. Others? */
3354 /* Grouped as 6 lines per C string literal, to keep under the ANSI C 89
3355 minimum of 509 character string literals. */
3356 static const char * const usage_msg[] = {
3357 " -0[octal] specify record separator (\\0, if no argument)\n"
3358 " -a autosplit mode with -n or -p (splits $_ into @F)\n"
3359 " -C[number/list] enables the listed Unicode features\n"
3360 " -c check syntax only (runs BEGIN and CHECK blocks)\n"
3361 " -d[:debugger] run program under debugger\n"
3362 " -D[number/list] set debugging flags (argument is a bit mask or alphabets)\n",
3363 " -e program one line of program (several -e's allowed, omit programfile)\n"
3364 " -E program like -e, but enables all optional features\n"
3365 " -f don't do $sitelib/sitecustomize.pl at startup\n"
3366 " -F/pattern/ split() pattern for -a switch (//'s are optional)\n"
3367 " -i[extension] edit <> files in place (makes backup if extension supplied)\n"
3368 " -Idirectory specify @INC/#include directory (several -I's allowed)\n",
3369 " -l[octal] enable line ending processing, specifies line terminator\n"
3370 " -[mM][-]module execute \"use/no module...\" before executing program\n"
3371 " -n assume \"while (<>) { ... }\" loop around program\n"
3372 " -p assume loop like -n but print line also, like sed\n"
3373 " -s enable rudimentary parsing for switches after programfile\n"
3374 " -S look for programfile using PATH environment variable\n",
3375 " -t enable tainting warnings\n"
3376 " -T enable tainting checks\n"
3377 " -u dump core after parsing program\n"
3378 " -U allow unsafe operations\n"
3379 " -v print version, patchlevel and license\n"
3380 " -V[:variable] print configuration summary (or a single Config.pm variable)\n",
3381 " -w enable many useful warnings\n"
3382 " -W enable all warnings\n"
3383 " -x[directory] ignore text before #!perl line (optionally cd to directory)\n"
3384 " -X disable all warnings\n"
3386 "Run 'perldoc perl' for more help with Perl.\n\n",
3389 const char * const *p = usage_msg;
3390 PerlIO *out = PerlIO_stdout();
3393 "\nUsage: %s [switches] [--] [programfile] [arguments]\n",
3396 PerlIO_puts(out, *p++);
3400 /* convert a string of -D options (or digits) into an int.
3401 * sets *s to point to the char after the options */
3405 Perl_get_debug_opts(pTHX_ const char **s, bool givehelp)
3407 static const char * const usage_msgd[] = {
3408 " Debugging flag values: (see also -d)\n"
3409 " p Tokenizing and parsing (with v, displays parse stack)\n"
3410 " s Stack snapshots (with v, displays all stacks)\n"
3411 " l Context (loop) stack processing\n"
3412 " t Trace execution\n"
3413 " o Method and overloading resolution\n",
3414 " c String/numeric conversions\n"
3415 " P Print profiling info, source file input state\n"
3416 " m Memory and SV allocation\n"
3417 " f Format processing\n"
3418 " r Regular expression parsing and execution\n"
3419 " x Syntax tree dump\n",
3420 " u Tainting checks\n"
3421 " H Hash dump -- usurps values()\n"
3422 " X Scratchpad allocation\n"
3424 " S Op slab allocation\n"
3426 " R Include reference counts of dumped variables (eg when using -Ds)\n",
3427 " J Do not s,t,P-debug (Jump over) opcodes within package DB\n"
3428 " v Verbose: use in conjunction with other flags\n"
3429 " C Copy On Write\n"
3430 " A Consistency checks on internal structures\n"
3431 " q quiet - currently only suppresses the 'EXECUTING' message\n"
3432 " M trace smart match resolution\n"
3433 " B dump suBroutine definitions, including special Blocks like BEGIN\n",
3434 " L trace some locale setting information--for Perl core development\n",
3435 " i trace PerlIO layer processing\n",
3436 " y trace y///, tr/// compilation and execution\n",
3441 PERL_ARGS_ASSERT_GET_DEBUG_OPTS;
3444 /* if adding extra options, remember to update DEBUG_MASK */
3445 static const char debopts[] = "psltocPmfrxuUHXDSTRJvCAqMBLiy";
3447 for (; isWORDCHAR(**s); (*s)++) {
3448 const char * const d = strchr(debopts,**s);
3450 uv |= 1 << (d - debopts);
3451 else if (ckWARN_d(WARN_DEBUGGING))
3452 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3453 "invalid option -D%c, use -D'' to see choices\n", **s);
3456 else if (isDIGIT(**s)) {
3457 const char* e = *s + strlen(*s);
3458 if (grok_atoUV(*s, &uv, &e))
3460 for (; isWORDCHAR(**s); (*s)++) ;
3462 else if (givehelp) {
3463 const char *const *p = usage_msgd;
3464 while (*p) PerlIO_puts(PerlIO_stdout(), *p++);
3466 return (int)uv; /* ignore any UV->int conversion loss */
3470 /* This routine handles any switches that can be given during run */
3473 Perl_moreswitches(pTHX_ const char *s)
3477 const char option = *s; /* used to remember option in -m/-M code */
3479 PERL_ARGS_ASSERT_MORESWITCHES;
3487 SvREFCNT_dec(PL_rs);
3488 if (s[1] == 'x' && s[2]) {
3489 const char *e = s+=2;
3495 flags = PERL_SCAN_SILENT_ILLDIGIT;
3496 rschar = (U32)grok_hex(s, &numlen, &flags, NULL);
3497 if (s + numlen < e) {
3498 rschar = 0; /* Grandfather -0xFOO as -0 -xFOO. */
3502 PL_rs = newSVpvs("");
3503 tmps = (U8*) SvGROW(PL_rs, (STRLEN)(UVCHR_SKIP(rschar) + 1));
3504 uvchr_to_utf8(tmps, rschar);
3505 SvCUR_set(PL_rs, UVCHR_SKIP(rschar));
3510 rschar = (U32)grok_oct(s, &numlen, &flags, NULL);
3511 if (rschar & ~((U8)~0))
3512 PL_rs = &PL_sv_undef;
3513 else if (!rschar && numlen >= 2)
3514 PL_rs = newSVpvs("");
3516 char ch = (char)rschar;
3517 PL_rs = newSVpvn(&ch, 1);
3520 sv_setsv(get_sv("/", GV_ADD), PL_rs);
3525 PL_unicode = parse_unicode_opts( (const char **)&s );
3526 if (PL_unicode & PERL_UNICODE_UTF8CACHEASSERT_FLAG)
3534 while (*s && !isSPACE(*s)) ++s;
3535 PL_splitstr = savepvn(PL_splitstr, s - PL_splitstr);
3547 forbid_setid('d', FALSE);
3550 /* -dt indicates to the debugger that threads will be used */
3551 if (*s == 't' && !isWORDCHAR(s[1])) {
3553 my_setenv("PERL5DB_THREADED", "1");
3556 /* The following permits -d:Mod to accepts arguments following an =
3557 in the fashion that -MSome::Mod does. */
3558 if (*s == ':' || *s == '=') {
3565 sv = newSVpvs("no Devel::");
3567 sv = newSVpvs("use Devel::");
3571 end = s + strlen(s);
3573 /* We now allow -d:Module=Foo,Bar and -d:-Module */
3574 while(isWORDCHAR(*s) || *s==':') ++s;
3576 sv_catpvn(sv, start, end - start);
3578 sv_catpvn(sv, start, s-start);
3579 /* Don't use NUL as q// delimiter here, this string goes in the
3581 Perl_sv_catpvf(aTHX_ sv, " split(/,/,q{%s});", ++s);
3584 my_setenv("PERL5DB", SvPV_nolen_const(sv));
3588 PL_perldb = PERLDB_ALL;
3595 forbid_setid('D', FALSE);
3597 PL_debug = get_debug_opts( (const char **)&s, 1) | DEBUG_TOP_FLAG;
3598 #else /* !DEBUGGING */
3599 if (ckWARN_d(WARN_DEBUGGING))
3600 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3601 "Recompile perl with -DDEBUGGING to use -D switch (did you mean -d ?)\n");
3602 for (s++; isWORDCHAR(*s); s++) ;
3605 NOT_REACHED; /* NOTREACHED */
3609 NOT_REACHED; /* NOTREACHED */
3612 Safefree(PL_inplace);
3614 const char * const start = ++s;
3615 while (*s && !isSPACE(*s))
3618 PL_inplace = savepvn(start, s - start);
3621 case 'I': /* -I handled both here and in parse_body() */
3622 forbid_setid('I', FALSE);
3624 while (*s && isSPACE(*s))
3629 /* ignore trailing spaces (possibly followed by other switches) */
3631 for (e = p; *e && !isSPACE(*e); e++) ;
3635 } while (*p && *p != '-');
3637 INCPUSH_ADD_SUB_DIRS|INCPUSH_ADD_OLD_VERS|INCPUSH_UNSHIFT);
3643 Perl_croak(aTHX_ "No directory specified for -I");
3649 SvREFCNT_dec(PL_ors_sv);
3655 PL_ors_sv = newSVpvs("\n");
3656 numlen = 3 + (*s == '0');
3657 *SvPVX(PL_ors_sv) = (char)grok_oct(s, &numlen, &flags, NULL);
3661 if (RsPARA(PL_rs)) {
3662 PL_ors_sv = newSVpvs("\n\n");
3665 PL_ors_sv = newSVsv(PL_rs);
3670 forbid_setid('M', FALSE); /* XXX ? */
3673 forbid_setid('m', FALSE); /* XXX ? */
3678 const char *use = "use ";
3680 /* -M-foo == 'no foo' */
3681 /* Leading space on " no " is deliberate, to make both
3682 possibilities the same length. */
3683 if (*s == '-') { use = " no "; ++s; }
3684 sv = newSVpvn(use,4);
3686 /* We allow -M'Module qw(Foo Bar)' */
3687 while(isWORDCHAR(*s) || *s==':') {
3696 Perl_croak(aTHX_ "Module name required with -%c option",
3699 Perl_croak(aTHX_ "Invalid module name %.*s with -%c option: "
3700 "contains single ':'",
3701 (int)(s - start), start, option);
3702 end = s + strlen(s);
3704 sv_catpvn(sv, start, end - start);
3705 if (option == 'm') {
3707 Perl_croak(aTHX_ "Can't use '%c' after -mname", *s);
3708 sv_catpvs( sv, " ()");
3711 sv_catpvn(sv, start, s-start);
3712 /* Use NUL as q''-delimiter. */
3713 sv_catpvs(sv, " split(/,/,q\0");
3715 sv_catpvn(sv, s, end - s);
3716 sv_catpvs(sv, "\0)");
3719 Perl_av_create_and_push(aTHX_ &PL_preambleav, sv);
3722 Perl_croak(aTHX_ "Missing argument to -%c", option);
3733 forbid_setid('s', FALSE);
3734 PL_doswitches = TRUE;
3739 #if defined(SILENT_NO_TAINT_SUPPORT)
3740 /* silently ignore */
3741 #elif defined(NO_TAINT_SUPPORT)
3742 Perl_croak_nocontext("This perl was compiled without taint support. "
3743 "Cowardly refusing to run with -t or -T flags");
3751 PL_do_undump = TRUE;
3761 if (! (PL_dowarn & G_WARN_ALL_MASK)) {
3762 PL_dowarn |= G_WARN_ON;
3767 PL_dowarn = G_WARN_ALL_ON|G_WARN_ON;
3768 if (!specialWARN(PL_compiling.cop_warnings))
3769 PerlMemShared_free(PL_compiling.cop_warnings);
3770 PL_compiling.cop_warnings = pWARN_ALL ;
3774 PL_dowarn = G_WARN_ALL_OFF;
3775 if (!specialWARN(PL_compiling.cop_warnings))
3776 PerlMemShared_free(PL_compiling.cop_warnings);
3777 PL_compiling.cop_warnings = pWARN_NONE ;
3784 if (s[0] == '-') /* Additional switches on #! line. */
3789 #if defined(WIN32) || !defined(PERL_STRICT_CR)
3795 #ifdef ALTERNATE_SHEBANG
3796 case 'S': /* OS/2 needs -S on "extproc" line. */
3799 case 'e': case 'f': case 'x': case 'E':
3800 #ifndef ALTERNATE_SHEBANG
3804 Perl_croak(aTHX_ "Can't emulate -%.1s on #! line",s);
3807 "Unrecognized switch: -%.1s (-h will show valid options)",s
3817 PerlIO * PIO_stdout;
3819 const char * const level_str = "v" PERL_VERSION_STRING;
3820 const STRLEN level_len = sizeof("v" PERL_VERSION_STRING)-1;
3821 #ifdef PERL_PATCHNUM
3823 # ifdef PERL_GIT_UNCOMMITTED_CHANGES
3824 static const char num [] = PERL_PATCHNUM "*";
3826 static const char num [] = PERL_PATCHNUM;
3829 const STRLEN num_len = sizeof(num)-1;
3830 /* A very advanced compiler would fold away the strnEQ
3831 and this whole conditional, but most (all?) won't do it.
3832 SV level could also be replaced by with preprocessor
3835 if (num_len >= level_len && strnEQ(num,level_str,level_len)) {
3836 /* per 46807d8e80, PERL_PATCHNUM is outside of the control
3837 of the interp so it might contain format characters
3839 level = newSVpvn(num, num_len);
3841 level = Perl_newSVpvf_nocontext("%s (%s)", level_str, num);
3845 SV* level = newSVpvn(level_str, level_len);
3846 #endif /* #ifdef PERL_PATCHNUM */
3847 PIO_stdout = PerlIO_stdout();
3848 PerlIO_printf(PIO_stdout,
3849 "\nThis is perl " STRINGIFY(PERL_REVISION)
3850 ", version " STRINGIFY(PERL_VERSION)
3851 ", subversion " STRINGIFY(PERL_SUBVERSION)
3852 " (%" SVf ") built for " ARCHNAME, SVfARG(level)
3854 SvREFCNT_dec_NN(level);
3856 #if defined(LOCAL_PATCH_COUNT)
3857 if (LOCAL_PATCH_COUNT > 0)
3858 PerlIO_printf(PIO_stdout,
3859 "\n(with %d registered patch%s, "
3860 "see perl -V for more detail)",
3862 (LOCAL_PATCH_COUNT!=1) ? "es" : "");
3865 PerlIO_printf(PIO_stdout,
3866 "\n\nCopyright 1987-2020, Larry Wall\n");
3868 PerlIO_printf(PIO_stdout,
3869 "\nMS-DOS port Copyright (c) 1989, 1990, Diomidis Spinellis\n");
3872 PerlIO_printf(PIO_stdout,
3873 "djgpp v2 port (jpl5003c) by Hirofumi Watanabe, 1996\n"
3874 "djgpp v2 port (perl5004+) by Laszlo Molnar, 1997-1999\n");
3877 PerlIO_printf(PIO_stdout,
3878 "\n\nOS/2 port Copyright (c) 1990, 1991, Raymond Chen, Kai Uwe Rommel\n"
3879 "Version 5 port Copyright (c) 1994-2002, Andreas Kaiser, Ilya Zakharevich\n");
3882 PerlIO_printf(PIO_stdout,
3883 "MVS (OS390) port by Mortice Kern Systems, 1997-1999\n");
3886 PerlIO_printf(PIO_stdout,
3887 "Stratus OpenVOS port by Paul.Green@stratus.com, 1997-2013\n");
3890 PerlIO_printf(PIO_stdout,
3891 "BS2000 (POSIX) port by Start Amadeus GmbH, 1998-1999\n");
3893 #ifdef __SYMBIAN32__
3894 PerlIO_printf(PIO_stdout,
3895 "Symbian port by Nokia, 2004-2005\n");
3897 #ifdef BINARY_BUILD_NOTICE
3898 BINARY_BUILD_NOTICE;
3900 PerlIO_printf(PIO_stdout,
3902 Perl may be copied only under the terms of either the Artistic License or the\n\
3903 GNU General Public License, which may be found in the Perl 5 source kit.\n\n\
3904 Complete documentation for Perl, including FAQ lists, should be found on\n\
3905 this system using \"man perl\" or \"perldoc perl\". If you have access to the\n\
3906 Internet, point your browser at http://www.perl.org/, the Perl Home Page.\n\n");
3910 /* compliments of Tom Christiansen */
3912 /* unexec() can be found in the Gnu emacs distribution */
3913 /* Known to work with -DUNEXEC and using unexelf.c from GNU emacs-20.2 */
3916 #include <lib$routines.h>
3920 Perl_my_unexec(pTHX)
3923 SV * prog = newSVpv(BIN_EXP, 0);
3924 SV * file = newSVpv(PL_origfilename, 0);
3928 sv_catpvs(prog, "/perl");
3929 sv_catpvs(file, ".perldump");
3931 unexec(SvPVX(file), SvPVX(prog), &etext, sbrk(0), 0);
3932 /* unexec prints msg to stderr in case of failure */
3933 PerlProc_exit(status);
3935 PERL_UNUSED_CONTEXT;
3937 lib$signal(SS$_DEBUG); /* ssdef.h #included from vmsish.h */
3938 # elif defined(WIN32) || defined(__CYGWIN__)
3939 Perl_croak_nocontext("dump is not supported");
3941 ABORT(); /* for use with undump */
3946 /* initialize curinterp */
3951 # define PERLVAR(prefix,var,type)
3952 # define PERLVARA(prefix,var,n,type)
3953 # if defined(PERL_IMPLICIT_CONTEXT)
3954 # define PERLVARI(prefix,var,type,init) aTHX->prefix##var = init;
3955 # define PERLVARIC(prefix,var,type,init) aTHX->prefix##var = init;
3957 # define PERLVARI(prefix,var,type,init) PERL_GET_INTERP->var = init;
3958 # define PERLVARIC(prefix,var,type,init) PERL_GET_INTERP->var = init;
3960 # include "intrpvar.h"
3966 # define PERLVAR(prefix,var,type)
3967 # define PERLVARA(prefix,var,n,type)
3968 # define PERLVARI(prefix,var,type,init) PL_##var = init;
3969 # define PERLVARIC(prefix,var,type,init) PL_##var = init;
3970 # include "intrpvar.h"
3980 S_init_main_stash(pTHX)
3985 PL_curstash = PL_defstash = (HV *)SvREFCNT_inc_simple_NN(hv);
3986 /* We know that the string "main" will be in the global shared string
3987 table, so it's a small saving to use it rather than allocate another
3989 PL_curstname = newSVpvs_share("main");
3990 gv = gv_fetchpvs("main::", GV_ADD|GV_NOTQUAL, SVt_PVHV);
3991 /* If we hadn't caused another reference to "main" to be in the shared
3992 string table above, then it would be worth reordering these two,
3993 because otherwise all we do is delete "main" from it as a consequence
3994 of the SvREFCNT_dec, only to add it again with hv_name_set */
3995 SvREFCNT_dec(GvHV(gv));
3996 hv_name_sets(PL_defstash, "main", 0);
3997 GvHV(gv) = MUTABLE_HV(SvREFCNT_inc_simple(PL_defstash));
3999 PL_incgv = gv_HVadd(gv_AVadd(gv_fetchpvs("INC", GV_ADD|GV_NOTQUAL,
4001 SvREFCNT_inc_simple_void(PL_incgv); /* Don't allow it to be freed */
4002 GvMULTI_on(PL_incgv);
4003 PL_hintgv = gv_fetchpvs("\010", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^H */
4004 SvREFCNT_inc_simple_void(PL_hintgv);
4005 GvMULTI_on(PL_hintgv);
4006 PL_defgv = gv_fetchpvs("_", GV_ADD|GV_NOTQUAL, SVt_PVAV);
4007 SvREFCNT_inc_simple_void(PL_defgv);
4008 PL_errgv = gv_fetchpvs("@", GV_ADD|GV_NOTQUAL, SVt_PV);
4009 SvREFCNT_inc_simple_void(PL_errgv);
4010 GvMULTI_on(PL_errgv);
4011 PL_replgv = gv_fetchpvs("\022", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^R */
4012 SvREFCNT_inc_simple_void(PL_replgv);
4013 GvMULTI_on(PL_replgv);
4014 (void)Perl_form(aTHX_ "%240s",""); /* Preallocate temp - for immediate signals. */
4015 #ifdef PERL_DONT_CREATE_GVSV
4016 (void)gv_SVadd(PL_errgv);
4018 sv_grow(ERRSV, 240); /* Preallocate - for immediate signals. */
4020 CopSTASH_set(&PL_compiling, PL_defstash);
4021 PL_debstash = GvHV(gv_fetchpvs("DB::", GV_ADDMULTI, SVt_PVHV));
4022 PL_globalstash = GvHV(gv_fetchpvs("CORE::GLOBAL::", GV_ADDMULTI,
4024 /* We must init $/ before switches are processed. */
4025 sv_setpvs(get_sv("/", GV_ADD), "\n");
4029 S_open_script(pTHX_ const char *scriptname, bool dosearch, bool *suidscript)
4032 PerlIO *rsfp = NULL;
4036 PERL_ARGS_ASSERT_OPEN_SCRIPT;
4039 PL_origfilename = savepvs("-e");
4044 /* if find_script() returns, it returns a malloc()-ed value */
4045 scriptname = PL_origfilename = find_script(scriptname, dosearch, NULL, 1);
4046 s = scriptname + strlen(scriptname);
4048 if (strBEGINs(scriptname, "/dev/fd/")
4049 && isDIGIT(scriptname[8])
4050 && grok_atoUV(scriptname + 8, &uv, &s)
4051 && uv <= PERL_INT_MAX
4056 * Tell apart "normal" usage of fdscript, e.g.
4057 * with bash on FreeBSD:
4058 * perl <( echo '#!perl -DA'; echo 'print "$0\n"')
4059 * from usage in suidperl.
4060 * Does any "normal" usage leave garbage after the number???
4061 * Is it a mistake to use a similar /dev/fd/ construct for
4066 * Be supersafe and do some sanity-checks.
4067 * Still, can we be sure we got the right thing?
4070 Perl_croak(aTHX_ "Wrong syntax (suid) fd script name \"%s\"\n", s);
4073 Perl_croak(aTHX_ "Missing (suid) fd script name\n");
4075 scriptname = savepv(s + 1);
4076 Safefree(PL_origfilename);
4077 PL_origfilename = (char *)scriptname;
4082 CopFILE_free(PL_curcop);
4083 CopFILE_set(PL_curcop, PL_origfilename);
4084 if (*PL_origfilename == '-' && PL_origfilename[1] == '\0')
4085 scriptname = (char *)"";
4086 if (fdscript >= 0) {
4087 rsfp = PerlIO_fdopen(fdscript,PERL_SCRIPT_MODE);
4089 else if (!*scriptname) {
4090 forbid_setid(0, *suidscript);
4094 #ifdef FAKE_BIT_BUCKET
4095 /* This hack allows one not to have /dev/null (or BIT_BUCKET as it
4096 * is called) and still have the "-e" work. (Believe it or not,
4097 * a /dev/null is required for the "-e" to work because source
4098 * filter magic is used to implement it. ) This is *not* a general
4099 * replacement for a /dev/null. What we do here is create a temp
4100 * file (an empty file), open up that as the script, and then
4101 * immediately close and unlink it. Close enough for jazz. */
4102 #define FAKE_BIT_BUCKET_PREFIX "/tmp/perlnull-"
4103 #define FAKE_BIT_BUCKET_SUFFIX "XXXXXXXX"
4104 #define FAKE_BIT_BUCKET_TEMPLATE FAKE_BIT_BUCKET_PREFIX FAKE_BIT_BUCKET_SUFFIX
4105 char tmpname[sizeof(FAKE_BIT_BUCKET_TEMPLATE)] = {
4106 FAKE_BIT_BUCKET_TEMPLATE
4108 const char * const err = "Failed to create a fake bit bucket";
4109 if (strEQ(scriptname, BIT_BUCKET)) {
4110 int tmpfd = Perl_my_mkstemp_cloexec(tmpname);
4112 scriptname = tmpname;
4115 Perl_croak(aTHX_ err);
4118 rsfp = PerlIO_open(scriptname,PERL_SCRIPT_MODE);
4119 #ifdef FAKE_BIT_BUCKET
4120 if ( strBEGINs(scriptname, FAKE_BIT_BUCKET_PREFIX)
4121 && strlen(scriptname) == sizeof(tmpname) - 1)
4125 scriptname = BIT_BUCKET;
4129 /* PSz 16 Sep 03 Keep neat error message */
4131 Perl_croak(aTHX_ "Can't open " BIT_BUCKET ": %s\n", Strerror(errno));
4133 Perl_croak(aTHX_ "Can't open perl script \"%s\": %s\n",
4134 CopFILE(PL_curcop), Strerror(errno));
4136 fd = PerlIO_fileno(rsfp);
4139 (PerlLIO_fstat(fd, &tmpstatbuf) >= 0
4140 && S_ISDIR(tmpstatbuf.st_mode)))
4141 Perl_croak(aTHX_ "Can't open perl script \"%s\": %s\n",
4148 /* In the days of suidperl, we refused to execute a setuid script stored on
4149 * a filesystem mounted nosuid and/or noexec. This meant that we probed for the
4150 * existence of the appropriate filesystem-statting function, and behaved
4151 * accordingly. But even though suidperl is long gone, we must still include
4152 * those probes for the benefit of modules like Filesys::Df, which expect the
4153 * results of those probes to be stored in %Config; see RT#126368. So mention
4154 * the relevant cpp symbols here, to ensure that metaconfig will include their
4155 * probes in the generated Configure:
4157 * I_SYSSTATVFS HAS_FSTATVFS
4159 * I_STATFS HAS_FSTATFS HAS_GETFSSTAT
4160 * I_MNTENT HAS_GETMNTENT HAS_HASMNTOPT
4164 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
4165 /* Don't even need this function. */
4168 S_validate_suid(pTHX_ PerlIO *rsfp)
4170 const Uid_t my_uid = PerlProc_getuid();
4171 const Uid_t my_euid = PerlProc_geteuid();
4172 const Gid_t my_gid = PerlProc_getgid();
4173 const Gid_t my_egid = PerlProc_getegid();
4175 PERL_ARGS_ASSERT_VALIDATE_SUID;
4177 if (my_euid != my_uid || my_egid != my_gid) { /* (suidperl doesn't exist, in fact) */
4179 int fd = PerlIO_fileno(rsfp);
4181 if (fd < 0 || PerlLIO_fstat(fd, &statbuf) < 0) { /* may be either wrapped or real suid */
4182 Perl_croak_nocontext( "Illegal suidscript");
4184 if ((my_euid != my_uid && my_euid == statbuf.st_uid && statbuf.st_mode & S_ISUID)
4186 (my_egid != my_gid && my_egid == statbuf.st_gid && statbuf.st_mode & S_ISGID)
4189 Perl_croak(aTHX_ "YOU HAVEN'T DISABLED SET-ID SCRIPTS IN THE KERNEL YET!\n\
4190 FIX YOUR KERNEL, PUT A C WRAPPER AROUND THIS SCRIPT, OR USE -u AND UNDUMP!\n");
4191 /* not set-id, must be wrapped */
4194 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4197 S_find_beginning(pTHX_ SV* linestr_sv, PerlIO *rsfp)
4202 PERL_ARGS_ASSERT_FIND_BEGINNING;
4204 /* skip forward in input to the real script? */
4207 if ((s = sv_gets(linestr_sv, rsfp, 0)) == NULL)
4208 Perl_croak(aTHX_ "No Perl script found in input\n");
4210 } while (!(*s == '#' && s[1] == '!' && ((s = instr(s,"perl")) || (s = instr(s2,"PERL")))));
4211 PerlIO_ungetc(rsfp, '\n'); /* to keep line count right */
4212 while (*s && !(isSPACE (*s) || *s == '#')) s++;
4214 while (*s == ' ' || *s == '\t') s++;
4216 while (isDIGIT(s2[-1]) || s2[-1] == '-' || s2[-1] == '.'
4217 || s2[-1] == '_') s2--;
4218 if (strBEGINs(s2-4,"perl"))
4219 while ((s = moreswitches(s)))
4228 /* no need to do anything here any more if we don't
4230 #ifndef NO_TAINT_SUPPORT
4231 const Uid_t my_uid = PerlProc_getuid();
4232 const Uid_t my_euid = PerlProc_geteuid();
4233 const Gid_t my_gid = PerlProc_getgid();
4234 const Gid_t my_egid = PerlProc_getegid();
4236 PERL_UNUSED_CONTEXT;
4238 /* Should not happen: */
4239 CHECK_MALLOC_TAINT(my_uid && (my_euid != my_uid || my_egid != my_gid));
4240 TAINTING_set( TAINTING_get | (my_uid && (my_euid != my_uid || my_egid != my_gid)) );
4244 * Should go by suidscript, not uid!=euid: why disallow
4245 * system("ls") in scripts run from setuid things?
4246 * Or, is this run before we check arguments and set suidscript?
4247 * What about SETUID_SCRIPTS_ARE_SECURE_NOW: could we use fdscript then?
4248 * (We never have suidscript, can we be sure to have fdscript?)
4249 * Or must then go by UID checks? See comments in forbid_setid also.
4253 /* This is used very early in the lifetime of the program,
4254 * before even the options are parsed, so PL_tainting has
4255 * not been initialized properly. */
4257 Perl_doing_taint(int argc, char *argv[], char *envp[])
4259 #ifndef PERL_IMPLICIT_SYS
4260 /* If we have PERL_IMPLICIT_SYS we can't call getuid() et alia
4261 * before we have an interpreter-- and the whole point of this
4262 * function is to be called at such an early stage. If you are on
4263 * a system with PERL_IMPLICIT_SYS but you do have a concept of
4264 * "tainted because running with altered effective ids', you'll
4265 * have to add your own checks somewhere in here. The two most
4266 * known samples of 'implicitness' are Win32 and NetWare, neither
4267 * of which has much of concept of 'uids'. */
4268 Uid_t uid = PerlProc_getuid();
4269 Uid_t euid = PerlProc_geteuid();
4270 Gid_t gid = PerlProc_getgid();
4271 Gid_t egid = PerlProc_getegid();
4278 if (uid && (euid != uid || egid != gid))
4280 #endif /* !PERL_IMPLICIT_SYS */
4281 /* This is a really primitive check; environment gets ignored only
4282 * if -T are the first chars together; otherwise one gets
4283 * "Too late" message. */
4284 if ( argc > 1 && argv[1][0] == '-'
4285 && isALPHA_FOLD_EQ(argv[1][1], 't'))
4290 /* Passing the flag as a single char rather than a string is a slight space
4291 optimisation. The only message that isn't /^-.$/ is
4292 "program input from stdin", which is substituted in place of '\0', which
4293 could never be a command line flag. */
4295 S_forbid_setid(pTHX_ const char flag, const bool suidscript) /* g */
4297 char string[3] = "-x";
4298 const char *message = "program input from stdin";
4300 PERL_UNUSED_CONTEXT;
4306 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
4307 if (PerlProc_getuid() != PerlProc_geteuid())
4308 Perl_croak(aTHX_ "No %s allowed while running setuid", message);
4309 if (PerlProc_getgid() != PerlProc_getegid())
4310 Perl_croak(aTHX_ "No %s allowed while running setgid", message);
4311 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4313 Perl_croak(aTHX_ "No %s allowed with (suid) fdscript", message);
4317 Perl_init_dbargs(pTHX)
4319 AV *const args = PL_dbargs = GvAV(gv_AVadd((gv_fetchpvs("DB::args",
4324 /* Someone has already created it.
4325 It might have entries, and if we just turn off AvREAL(), they will
4326 "leak" until global destruction. */
4328 if (SvTIED_mg((const SV *)args, PERL_MAGIC_tied))
4329 Perl_croak(aTHX_ "Cannot set tied @DB::args");
4331 AvREIFY_only(PL_dbargs);
4335 Perl_init_debugger(pTHX)
4337 HV * const ostash = PL_curstash;
4340 PL_curstash = (HV *)SvREFCNT_inc_simple(PL_debstash);
4342 Perl_init_dbargs(aTHX);
4343 PL_DBgv = MUTABLE_GV(
4344 SvREFCNT_inc(gv_fetchpvs("DB::DB", GV_ADDMULTI, SVt_PVGV))
4346 PL_DBline = MUTABLE_GV(
4347 SvREFCNT_inc(gv_fetchpvs("DB::dbline", GV_ADDMULTI, SVt_PVAV))
4349 PL_DBsub = MUTABLE_GV(SvREFCNT_inc(
4350 gv_HVadd(gv_fetchpvs("DB::sub", GV_ADDMULTI, SVt_PVHV))
4352 PL_DBsingle = GvSV((gv_fetchpvs("DB::single", GV_ADDMULTI, SVt_PV)));
4353 if (!SvIOK(PL_DBsingle))
4354 sv_setiv(PL_DBsingle, 0);
4355 mg = sv_magicext(PL_DBsingle, NULL, PERL_MAGIC_debugvar, &PL_vtbl_debugvar, 0, 0);
4356 mg->mg_private = DBVARMG_SINGLE;
4357 SvSETMAGIC(PL_DBsingle);
4359 PL_DBtrace = GvSV((gv_fetchpvs("DB::trace", GV_ADDMULTI, SVt_PV)));
4360 if (!SvIOK(PL_DBtrace))
4361 sv_setiv(PL_DBtrace, 0);
4362 mg = sv_magicext(PL_DBtrace, NULL, PERL_MAGIC_debugvar, &PL_vtbl_debugvar, 0, 0);
4363 mg->mg_private = DBVARMG_TRACE;
4364 SvSETMAGIC(PL_DBtrace);
4366 PL_DBsignal = GvSV((gv_fetchpvs("DB::signal", GV_ADDMULTI, SVt_PV)));
4367 if (!SvIOK(PL_DBsignal))
4368 sv_setiv(PL_DBsignal, 0);
4369 mg = sv_magicext(PL_DBsignal, NULL, PERL_MAGIC_debugvar, &PL_vtbl_debugvar, 0, 0);
4370 mg->mg_private = DBVARMG_SIGNAL;
4371 SvSETMAGIC(PL_DBsignal);
4373 SvREFCNT_dec(PL_curstash);
4374 PL_curstash = ostash;
4377 #ifndef STRESS_REALLOC
4378 #define REASONABLE(size) (size)
4379 #define REASONABLE_but_at_least(size,min) (size)
4381 #define REASONABLE(size) (1) /* unreasonable */
4382 #define REASONABLE_but_at_least(size,min) (min)
4386 Perl_init_stacks(pTHX)
4390 /* start with 128-item stack and 8K cxstack */
4391 PL_curstackinfo = new_stackinfo(REASONABLE(128),
4392 REASONABLE(8192/sizeof(PERL_CONTEXT) - 1));
4393 PL_curstackinfo->si_type = PERLSI_MAIN;
4394 #if defined DEBUGGING && !defined DEBUGGING_RE_ONLY
4395 PL_curstackinfo->si_stack_hwm = 0;
4397 PL_curstack = PL_curstackinfo->si_stack;
4398 PL_mainstack = PL_curstack; /* remember in case we switch stacks */
4400 PL_stack_base = AvARRAY(PL_curstack);
4401 PL_stack_sp = PL_stack_base;
4402 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
4404 Newx(PL_tmps_stack,REASONABLE(128),SV*);
4407 PL_tmps_max = REASONABLE(128);
4409 Newx(PL_markstack,REASONABLE(32),I32);
4410 PL_markstack_ptr = PL_markstack;
4411 PL_markstack_max = PL_markstack + REASONABLE(32);
4415 Newx(PL_scopestack,REASONABLE(32),I32);
4417 Newx(PL_scopestack_name,REASONABLE(32),const char*);
4419 PL_scopestack_ix = 0;
4420 PL_scopestack_max = REASONABLE(32);
4422 size = REASONABLE_but_at_least(128,SS_MAXPUSH);
4423 Newx(PL_savestack, size, ANY);
4424 PL_savestack_ix = 0;
4425 /*PL_savestack_max lies: it always has SS_MAXPUSH more than it claims */
4426 PL_savestack_max = size - SS_MAXPUSH;
4434 while (PL_curstackinfo->si_next)
4435 PL_curstackinfo = PL_curstackinfo->si_next;
4436 while (PL_curstackinfo) {
4437 PERL_SI *p = PL_curstackinfo->si_prev;
4438 /* curstackinfo->si_stack got nuked by sv_free_arenas() */
4439 Safefree(PL_curstackinfo->si_cxstack);
4440 Safefree(PL_curstackinfo);
4441 PL_curstackinfo = p;
4443 Safefree(PL_tmps_stack);
4444 Safefree(PL_markstack);
4445 Safefree(PL_scopestack);
4447 Safefree(PL_scopestack_name);
4449 Safefree(PL_savestack);
4453 Perl_populate_isa(pTHX_ const char *name, STRLEN len, ...)
4455 GV *const gv = gv_fetchpvn(name, len, GV_ADD | GV_ADDMULTI, SVt_PVAV);
4456 AV *const isa = GvAVn(gv);
4459 PERL_ARGS_ASSERT_POPULATE_ISA;
4461 if(AvFILLp(isa) != -1)
4464 /* NOTE: No support for tied ISA */
4466 va_start(args, len);
4468 const char *const parent = va_arg(args, const char*);
4473 parent_len = va_arg(args, size_t);
4475 /* Arguments are supplied with a trailing :: */
4476 assert(parent_len > 2);
4477 assert(parent[parent_len - 1] == ':');
4478 assert(parent[parent_len - 2] == ':');
4479 av_push(isa, newSVpvn(parent, parent_len - 2));
4480 (void) gv_fetchpvn(parent, parent_len, GV_ADD, SVt_PVGV);
4487 S_init_predump_symbols(pTHX)
4492 sv_setpvs(get_sv("\"", GV_ADD), " ");
4493 PL_ofsgv = (GV*)SvREFCNT_inc(gv_fetchpvs(",", GV_ADD|GV_NOTQUAL, SVt_PV));
4496 /* Historically, PVIOs were blessed into IO::Handle, unless
4497 FileHandle was loaded, in which case they were blessed into
4498 that. Action at a distance.
4499 However, if we simply bless into IO::Handle, we break code
4500 that assumes that PVIOs will have (among others) a seek
4501 method. IO::File inherits from IO::Handle and IO::Seekable,
4502 and provides the needed methods. But if we simply bless into
4503 it, then we break code that assumed that by loading
4504 IO::Handle, *it* would work.
4505 So a compromise is to set up the correct @IO::File::ISA,
4506 so that code that does C<use IO::Handle>; will still work.
4509 Perl_populate_isa(aTHX_ STR_WITH_LEN("IO::File::ISA"),
4510 STR_WITH_LEN("IO::Handle::"),
4511 STR_WITH_LEN("IO::Seekable::"),
4512 STR_WITH_LEN("Exporter::"),
4515 PL_stdingv = gv_fetchpvs("STDIN", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4516 GvMULTI_on(PL_stdingv);
4517 io = GvIOp(PL_stdingv);
4518 IoTYPE(io) = IoTYPE_RDONLY;
4519 IoIFP(io) = PerlIO_stdin();
4520 tmpgv = gv_fetchpvs("stdin", GV_ADD|GV_NOTQUAL, SVt_PV);
4522 GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4524 tmpgv = gv_fetchpvs("STDOUT", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4527 IoTYPE(io) = IoTYPE_WRONLY;
4528 IoOFP(io) = IoIFP(io) = PerlIO_stdout();
4530 tmpgv = gv_fetchpvs("stdout", GV_ADD|GV_NOTQUAL, SVt_PV);
4532 GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4534 PL_stderrgv = gv_fetchpvs("STDERR", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4535 GvMULTI_on(PL_stderrgv);
4536 io = GvIOp(PL_stderrgv);
4537 IoTYPE(io) = IoTYPE_WRONLY;
4538 IoOFP(io) = IoIFP(io) = PerlIO_stderr();
4539 tmpgv = gv_fetchpvs("stderr", GV_ADD|GV_NOTQUAL, SVt_PV);
4541 GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4543 PL_statname = newSVpvs(""); /* last filename we did stat on */
4547 Perl_init_argv_symbols(pTHX_ int argc, char **argv)
4549 PERL_ARGS_ASSERT_INIT_ARGV_SYMBOLS;
4551 argc--,argv++; /* skip name of script */
4552 if (PL_doswitches) {
4553 for (; argc > 0 && **argv == '-'; argc--,argv++) {
4557 if (argv[0][1] == '-' && !argv[0][2]) {
4561 if ((s = strchr(argv[0], '='))) {
4562 const char *const start_name = argv[0] + 1;
4563 sv_setpv(GvSV(gv_fetchpvn_flags(start_name, s - start_name,
4564 TRUE, SVt_PV)), s + 1);
4567 sv_setiv(GvSV(gv_fetchpv(argv[0]+1, GV_ADD, SVt_PV)),1);
4570 if ((PL_argvgv = gv_fetchpvs("ARGV", GV_ADD|GV_NOTQUAL, SVt_PVAV))) {
4571 SvREFCNT_inc_simple_void_NN(PL_argvgv);
4572 GvMULTI_on(PL_argvgv);
4573 av_clear(GvAVn(PL_argvgv));
4574 for (; argc > 0; argc--,argv++) {
4575 SV * const sv = newSVpv(argv[0],0);
4576 av_push(GvAV(PL_argvgv),sv);
4577 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
4578 if (PL_unicode & PERL_UNICODE_ARGV_FLAG)
4581 if (PL_unicode & PERL_UNICODE_WIDESYSCALLS_FLAG) /* Sarathy? */
4582 (void)sv_utf8_decode(sv);
4586 if (PL_inplace && (!PL_argvgv || AvFILL(GvAV(PL_argvgv)) == -1))
4587 Perl_ck_warner_d(aTHX_ packWARN(WARN_INPLACE),
4588 "-i used with no filenames on the command line, "
4589 "reading from STDIN");
4593 S_init_postdump_symbols(pTHX_ int argc, char **argv, char **env)
4600 PERL_ARGS_ASSERT_INIT_POSTDUMP_SYMBOLS;
4602 PL_toptarget = newSV_type(SVt_PVIV);
4603 SvPVCLEAR(PL_toptarget);
4604 PL_bodytarget = newSV_type(SVt_PVIV);
4605 SvPVCLEAR(PL_bodytarget);
4606 PL_formtarget = PL_bodytarget;
4610 init_argv_symbols(argc,argv);
4612 if ((tmpgv = gv_fetchpvs("0", GV_ADD|GV_NOTQUAL, SVt_PV))) {
4613 sv_setpv(GvSV(tmpgv),PL_origfilename);
4615 if ((PL_envgv = gv_fetchpvs("ENV", GV_ADD|GV_NOTQUAL, SVt_PVHV))) {
4617 bool env_is_not_environ;
4618 SvREFCNT_inc_simple_void_NN(PL_envgv);
4619 GvMULTI_on(PL_envgv);
4620 hv = GvHVn(PL_envgv);
4621 hv_magic(hv, NULL, PERL_MAGIC_env);
4623 #ifdef USE_ENVIRON_ARRAY
4624 /* Note that if the supplied env parameter is actually a copy
4625 of the global environ then it may now point to free'd memory
4626 if the environment has been modified since. To avoid this
4627 problem we treat env==NULL as meaning 'use the default'
4631 env_is_not_environ = env != environ;
4632 if (env_is_not_environ
4633 # ifdef USE_ITHREADS
4634 && PL_curinterp == aTHX
4646 for (; *env; env++) {
4649 if (!(s = strchr(old_var,'=')) || s == old_var)
4653 #if defined(MSDOS) && !defined(DJGPP)
4655 (void)strupr(old_var);
4658 if (hv_exists(hv, old_var, nlen)) {
4659 const char *name = savepvn(old_var, nlen);
4661 /* make sure we use the same value as getenv(), otherwise code that
4662 uses getenv() (like setlocale()) might see a different value to %ENV
4664 sv = newSVpv(PerlEnv_getenv(name), 0);
4666 /* keep a count of the dups of this name so we can de-dup environ later */
4667 if (hv_exists(dups, name, nlen))
4668 ++SvIVX(*hv_fetch(dups, name, nlen, 0));
4670 (void)hv_store(dups, name, nlen, newSViv(1), 0);
4675 sv = newSVpv(s+1, 0);
4677 (void)hv_store(hv, old_var, nlen, sv, 0);
4678 if (env_is_not_environ)
4682 /* environ has some duplicate definitions, remove them */
4685 while ((entry = hv_iternext_flags(dups, 0))) {
4687 const char *name = HePV(entry, nlen);
4688 IV count = SvIV(HeVAL(entry));
4690 SV **valp = hv_fetch(hv, name, nlen, 0);
4694 /* try to remove any duplicate names, depending on the
4695 * implementation used in my_setenv() the iteration might
4696 * not be necessary, but let's be safe.
4698 for (i = 0; i < count; ++i)
4701 /* and set it back to the value we set $ENV{name} to */
4702 my_setenv(name, SvPV_nolen(*valp));
4705 SvREFCNT_dec_NN(dups);
4707 #endif /* USE_ENVIRON_ARRAY */
4708 #endif /* !PERL_MICRO */
4712 /* touch @F array to prevent spurious warnings 20020415 MJD */
4714 (void) get_av("main::F", GV_ADD | GV_ADDMULTI);
4719 S_init_perllib(pTHX)
4722 const char *perl5lib = NULL;
4725 #if defined(WIN32) && !defined(PERL_IS_MINIPERL)
4729 if (!TAINTING_get) {
4731 perl5lib = PerlEnv_getenv("PERL5LIB");
4733 * It isn't possible to delete an environment variable with
4734 * PERL_USE_SAFE_PUTENV set unless unsetenv() is also available, so in that
4735 * case we treat PERL5LIB as undefined if it has a zero-length value.
4737 #if defined(PERL_USE_SAFE_PUTENV) && ! defined(HAS_UNSETENV)
4738 if (perl5lib && *perl5lib != '\0')
4742 incpush_use_sep(perl5lib, 0, INCPUSH_ADD_SUB_DIRS);
4744 s = PerlEnv_getenv("PERLLIB");
4746 incpush_use_sep(s, 0, 0);
4749 /* Treat PERL5?LIB as a possible search list logical name -- the
4750 * "natural" VMS idiom for a Unix path string. We allow each
4751 * element to be a set of |-separated directories for compatibility.
4755 if (vmstrnenv("PERL5LIB",buf,0,NULL,0))
4757 incpush_use_sep(buf, 0, INCPUSH_ADD_SUB_DIRS);
4758 } while (vmstrnenv("PERL5LIB",buf,++idx,NULL,0));
4760 while (vmstrnenv("PERLLIB",buf,idx++,NULL,0))
4761 incpush_use_sep(buf, 0, 0);
4766 #ifndef PERL_IS_MINIPERL
4767 /* miniperl gets just -I..., the split of $ENV{PERL5LIB}, and "." in @INC
4768 (and not the architecture specific directories from $ENV{PERL5LIB}) */
4770 #include "perl_inc_macro.h"
4771 /* Use the ~-expanded versions of APPLLIB (undocumented),
4772 SITEARCH, SITELIB, VENDORARCH, VENDORLIB, ARCHLIB and PRIVLIB
4775 INCPUSH_SITEARCH_EXP
4777 INCPUSH_PERL_VENDORARCH_EXP
4778 INCPUSH_PERL_VENDORLIB_EXP
4781 INCPUSH_PERL_OTHERLIBDIRS
4783 INCPUSH_APPLLIB_OLD_EXP
4784 INCPUSH_SITELIB_STEM
4785 INCPUSH_PERL_VENDORLIB_STEM
4786 INCPUSH_PERL_OTHERLIBDIRS_ARCHONLY
4788 #endif /* !PERL_IS_MINIPERL */
4790 if (!TAINTING_get) {
4791 #if !defined(PERL_IS_MINIPERL) && defined(DEFAULT_INC_EXCLUDES_DOT)
4792 const char * const unsafe = PerlEnv_getenv("PERL_USE_UNSAFE_INC");
4793 if (unsafe && strEQ(unsafe, "1"))
4795 S_incpush(aTHX_ STR_WITH_LEN("."), 0);
4799 #if defined(DOSISH) || defined(__SYMBIAN32__)
4800 # define PERLLIB_SEP ';'
4801 #elif defined(__VMS)
4802 # define PERLLIB_SEP PL_perllib_sep
4804 # define PERLLIB_SEP ':'
4806 #ifndef PERLLIB_MANGLE
4807 # define PERLLIB_MANGLE(s,n) (s)
4810 #ifndef PERL_IS_MINIPERL
4811 /* Push a directory onto @INC if it exists.
4812 Generate a new SV if we do this, to save needing to copy the SV we push
4815 S_incpush_if_exists(pTHX_ AV *const av, SV *dir, SV *const stem)
4819 PERL_ARGS_ASSERT_INCPUSH_IF_EXISTS;
4821 if (PerlLIO_stat(SvPVX_const(dir), &tmpstatbuf) >= 0 &&
4822 S_ISDIR(tmpstatbuf.st_mode)) {
4824 dir = newSVsv(stem);
4826 /* Truncate dir back to stem. */
4827 SvCUR_set(dir, SvCUR(stem));
4834 S_mayberelocate(pTHX_ const char *const dir, STRLEN len, U32 flags)
4836 const U8 canrelocate = (U8)flags & INCPUSH_CAN_RELOCATE;
4839 PERL_ARGS_ASSERT_MAYBERELOCATE;
4842 /* I am not convinced that this is valid when PERLLIB_MANGLE is
4843 defined to so something (in os2/os2.c), but the code has been
4844 this way, ignoring any possible changed of length, since
4845 760ac839baf413929cd31cc32ffd6dba6b781a81 (5.003_02) so I'll leave
4847 libdir = newSVpvn(PERLLIB_MANGLE(dir, len), len);
4853 if ((unix = tounixspec_ts(SvPV(libdir,len),NULL)) != NULL) {
4855 while (len > 1 && unix[len-1] == '/') len--; /* Cosmetic */
4856 sv_usepvn(libdir,unix,len);
4859 PerlIO_printf(Perl_error_log,
4860 "Failed to unixify @INC element \"%s\"\n",
4861 SvPV_nolen_const(libdir));
4865 /* Do the if() outside the #ifdef to avoid warnings about an unused
4868 #ifdef PERL_RELOCATABLE_INC
4870 * Relocatable include entries are marked with a leading .../
4873 * 0: Remove that leading ".../"
4874 * 1: Remove trailing executable name (anything after the last '/')
4875 * from the perl path to give a perl prefix
4877 * While the @INC element starts "../" and the prefix ends with a real
4878 * directory (ie not . or ..) chop that real directory off the prefix
4879 * and the leading "../" from the @INC element. ie a logical "../"
4881 * Finally concatenate the prefix and the remainder of the @INC element
4882 * The intent is that /usr/local/bin/perl and .../../lib/perl5
4883 * generates /usr/local/lib/perl5
4885 const char *libpath = SvPVX(libdir);
4886 STRLEN libpath_len = SvCUR(libdir);
4887 if (memBEGINs(libpath, libpath_len, ".../")) {
4889 SV * const caret_X = get_sv("\030", 0);
4890 /* Going to use the SV just as a scratch buffer holding a C
4896 /* $^X is *the* source of taint if tainting is on, hence
4897 SvPOK() won't be true. */
4899 assert(SvPOKp(caret_X));
4900 prefix_sv = newSVpvn_flags(SvPVX(caret_X), SvCUR(caret_X),
4902 /* Firstly take off the leading .../
4903 If all else fail we'll do the paths relative to the current
4905 sv_chop(libdir, libpath + 4);
4906 /* Don't use SvPV as we're intentionally bypassing taining,
4907 mortal copies that the mg_get of tainting creates, and
4908 corruption that seems to come via the save stack.
4909 I guess that the save stack isn't correctly set up yet. */
4910 libpath = SvPVX(libdir);
4911 libpath_len = SvCUR(libdir);
4913 prefix = SvPVX(prefix_sv);
4914 lastslash = (char *) my_memrchr(prefix, '/',
4915 SvEND(prefix_sv) - prefix);
4917 /* First time in with the *lastslash = '\0' we just wipe off
4918 the trailing /perl from (say) /usr/foo/bin/perl
4922 while ((*lastslash = '\0'), /* Do that, come what may. */
4923 ( memBEGINs(libpath, libpath_len, "../")
4925 (char *) my_memrchr(prefix, '/',
4926 SvEND(prefix_sv) - prefix))))
4928 if (lastslash[1] == '\0'
4929 || (lastslash[1] == '.'
4930 && (lastslash[2] == '/' /* ends "/." */
4931 || (lastslash[2] == '/'
4932 && lastslash[3] == '/' /* or "/.." */
4934 /* Prefix ends "/" or "/." or "/..", any of which
4935 are fishy, so don't do any more logical cleanup.
4939 /* Remove leading "../" from path */
4942 /* Next iteration round the loop removes the last
4943 directory name from prefix by writing a '\0' in
4944 the while clause. */
4946 /* prefix has been terminated with a '\0' to the correct
4947 length. libpath points somewhere into the libdir SV.
4948 We need to join the 2 with '/' and drop the result into
4950 tempsv = Perl_newSVpvf(aTHX_ "%s/%s", prefix, libpath);
4951 SvREFCNT_dec(libdir);
4952 /* And this is the new libdir. */
4955 (PerlProc_getuid() != PerlProc_geteuid() ||
4956 PerlProc_getgid() != PerlProc_getegid())) {
4957 /* Need to taint relocated paths if running set ID */
4958 SvTAINTED_on(libdir);
4961 SvREFCNT_dec(prefix_sv);
4969 S_incpush(pTHX_ const char *const dir, STRLEN len, U32 flags)
4971 #ifndef PERL_IS_MINIPERL
4972 const U8 using_sub_dirs
4973 = (U8)flags & (INCPUSH_ADD_VERSIONED_SUB_DIRS
4974 |INCPUSH_ADD_ARCHONLY_SUB_DIRS|INCPUSH_ADD_OLD_VERS);
4975 const U8 add_versioned_sub_dirs
4976 = (U8)flags & INCPUSH_ADD_VERSIONED_SUB_DIRS;
4977 const U8 add_archonly_sub_dirs
4978 = (U8)flags & INCPUSH_ADD_ARCHONLY_SUB_DIRS;
4979 #ifdef PERL_INC_VERSION_LIST
4980 const U8 addoldvers = (U8)flags & INCPUSH_ADD_OLD_VERS;
4983 const U8 unshift = (U8)flags & INCPUSH_UNSHIFT;
4984 const U8 push_basedir = (flags & INCPUSH_NOT_BASEDIR) ? 0 : 1;
4985 AV *const inc = GvAVn(PL_incgv);
4987 PERL_ARGS_ASSERT_INCPUSH;
4990 /* Could remove this vestigial extra block, if we don't mind a lot of
4991 re-indenting diff noise. */
4993 SV *const libdir = mayberelocate(dir, len, flags);
4994 /* Change 20189146be79a0596543441fa369c6bf7f85103f, to fix RT#6665,
4995 arranged to unshift #! line -I onto the front of @INC. However,
4996 -I can add version and architecture specific libraries, and they
4997 need to go first. The old code assumed that it was always
4998 pushing. Hence to make it work, need to push the architecture
4999 (etc) libraries onto a temporary array, then "unshift" that onto
5000 the front of @INC. */
5001 #ifndef PERL_IS_MINIPERL
5002 AV *const av = (using_sub_dirs) ? (unshift ? newAV() : inc) : NULL;
5005 * BEFORE pushing libdir onto @INC we may first push version- and
5006 * archname-specific sub-directories.
5008 if (using_sub_dirs) {
5009 SV *subdir = newSVsv(libdir);
5010 #ifdef PERL_INC_VERSION_LIST
5011 /* Configure terminates PERL_INC_VERSION_LIST with a NULL */
5012 const char * const incverlist[] = { PERL_INC_VERSION_LIST };
5013 const char * const *incver;
5016 if (add_versioned_sub_dirs) {
5017 /* .../version/archname if -d .../version/archname */
5018 sv_catpvs(subdir, "/" PERL_FS_VERSION "/" ARCHNAME);
5019 subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
5021 /* .../version if -d .../version */
5022 sv_catpvs(subdir, "/" PERL_FS_VERSION);
5023 subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
5026 #ifdef PERL_INC_VERSION_LIST
5028 for (incver = incverlist; *incver; incver++) {
5029 /* .../xxx if -d .../xxx */
5030 Perl_sv_catpvf(aTHX_ subdir, "/%s", *incver);
5031 subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
5036 if (add_archonly_sub_dirs) {
5037 /* .../archname if -d .../archname */
5038 sv_catpvs(subdir, "/" ARCHNAME);
5039 subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
5043 assert (SvREFCNT(subdir) == 1);
5044 SvREFCNT_dec(subdir);
5046 #endif /* !PERL_IS_MINIPERL */
5047 /* finally add this lib directory at the end of @INC */
5049 #ifdef PERL_IS_MINIPERL
5050 const Size_t extra = 0;
5052 Size_t extra = av_tindex(av) + 1;
5054 av_unshift(inc, extra + push_basedir);
5056 av_store(inc, extra, libdir);
5057 #ifndef PERL_IS_MINIPERL
5059 /* av owns a reference, av_store() expects to be donated a
5060 reference, and av expects to be sane when it's cleared.
5061 If I wanted to be naughty and wrong, I could peek inside the
5062 implementation of av_clear(), realise that it uses
5063 SvREFCNT_dec() too, so av's array could be a run of NULLs,
5064 and so directly steal from it (with a memcpy() to inc, and
5065 then memset() to NULL them out. But people copy code from the
5066 core expecting it to be best practise, so let's use the API.
5067 Although studious readers will note that I'm not checking any
5069 av_store(inc, extra, SvREFCNT_inc(*av_fetch(av, extra, FALSE)));
5074 else if (push_basedir) {
5075 av_push(inc, libdir);
5078 if (!push_basedir) {
5079 assert (SvREFCNT(libdir) == 1);
5080 SvREFCNT_dec(libdir);
5086 S_incpush_use_sep(pTHX_ const char *p, STRLEN len, U32 flags)
5090 /* This logic has been broken out from S_incpush(). It may be possible to
5093 PERL_ARGS_ASSERT_INCPUSH_USE_SEP;
5095 /* perl compiled with -DPERL_RELOCATABLE_INCPUSH will ignore the len
5096 * argument to incpush_use_sep. This allows creation of relocatable
5097 * Perl distributions that patch the binary at install time. Those
5098 * distributions will have to provide their own relocation tools; this
5099 * is not a feature otherwise supported by core Perl.
5101 #ifndef PERL_RELOCATABLE_INCPUSH
5108 /* Break at all separators */
5109 while ((s = (const char*)memchr(p, PERLLIB_SEP, end - p))) {
5111 /* skip any consecutive separators */
5113 /* Uncomment the next line for PATH semantics */
5114 /* But you'll need to write tests */
5115 /* av_push(GvAVn(PL_incgv), newSVpvs(".")); */
5117 incpush(p, (STRLEN)(s - p), flags);
5122 incpush(p, (STRLEN)(end - p), flags);
5127 Perl_call_list(pTHX_ I32 oldscope, AV *paramList)
5130 volatile const line_t oldline = PL_curcop ? CopLINE(PL_curcop) : 0;
5136 PERL_ARGS_ASSERT_CALL_LIST;
5138 while (av_tindex(paramList) >= 0) {
5139 cv = MUTABLE_CV(av_shift(paramList));
5141 if (paramList == PL_beginav) {
5142 /* save PL_beginav for compiler */
5143 Perl_av_create_and_push(aTHX_ &PL_beginav_save, MUTABLE_SV(cv));
5145 else if (paramList == PL_checkav) {
5146 /* save PL_checkav for compiler */
5147 Perl_av_create_and_push(aTHX_ &PL_checkav_save, MUTABLE_SV(cv));
5149 else if (paramList == PL_unitcheckav) {
5150 /* save PL_unitcheckav for compiler */
5151 Perl_av_create_and_push(aTHX_ &PL_unitcheckav_save, MUTABLE_SV(cv));
5161 (void)SvPV_const(atsv, len);
5163 PL_curcop = &PL_compiling;
5164 CopLINE_set(PL_curcop, oldline);
5165 if (paramList == PL_beginav)
5166 sv_catpvs(atsv, "BEGIN failed--compilation aborted");
5168 Perl_sv_catpvf(aTHX_ atsv,
5169 "%s failed--call queue aborted",
5170 paramList == PL_checkav ? "CHECK"
5171 : paramList == PL_initav ? "INIT"
5172 : paramList == PL_unitcheckav ? "UNITCHECK"
5174 while (PL_scopestack_ix > oldscope)
5177 Perl_croak(aTHX_ "%" SVf, SVfARG(atsv));
5184 /* my_exit() was called */
5185 while (PL_scopestack_ix > oldscope)
5188 SET_CURSTASH(PL_defstash);
5189 PL_curcop = &PL_compiling;
5190 CopLINE_set(PL_curcop, oldline);
5193 NOT_REACHED; /* NOTREACHED */
5196 PL_curcop = &PL_compiling;
5197 CopLINE_set(PL_curcop, oldline);
5200 PerlIO_printf(Perl_error_log, "panic: restartop in call_list\n");
5211 A wrapper for the C library L<exit(3)>, honoring what L<perlapi/PL_exit_flags>
5218 Perl_my_exit(pTHX_ U32 status)
5220 if (PL_exit_flags & PERL_EXIT_ABORT) {
5223 if (PL_exit_flags & PERL_EXIT_WARN) {
5224 PL_exit_flags |= PERL_EXIT_ABORT; /* Protect against reentrant calls */
5225 Perl_warn(aTHX_ "Unexpected exit %lu", (unsigned long)status);
5226 PL_exit_flags &= ~PERL_EXIT_ABORT;
5236 STATUS_EXIT_SET(status);
5243 Perl_my_failure_exit(pTHX)
5246 /* We have been called to fall on our sword. The desired exit code
5247 * should be already set in STATUS_UNIX, but could be shifted over
5248 * by 8 bits. STATUS_UNIX_EXIT_SET will handle the cases where a
5251 * If an error code has not been set, then force the issue.
5253 if (MY_POSIX_EXIT) {
5255 /* According to the die_exit.t tests, if errno is non-zero */
5256 /* It should be used for the error status. */
5258 if (errno == EVMSERR) {
5259 STATUS_NATIVE = vaxc$errno;
5262 /* According to die_exit.t tests, if the child_exit code is */
5263 /* also zero, then we need to exit with a code of 255 */
5264 if ((errno != 0) && (errno < 256))
5265 STATUS_UNIX_EXIT_SET(errno);
5266 else if (STATUS_UNIX < 255) {
5267 STATUS_UNIX_EXIT_SET(255);
5272 /* The exit code could have been set by $? or vmsish which
5273 * means that it may not have fatal set. So convert
5274 * success/warning codes to fatal with out changing
5275 * the POSIX status code. The severity makes VMS native
5276 * status handling work, while UNIX mode programs use the
5277 * the POSIX exit codes.
5279 if ((STATUS_NATIVE & (STS$K_SEVERE|STS$K_ERROR)) == 0) {
5280 STATUS_NATIVE &= STS$M_COND_ID;
5281 STATUS_NATIVE |= STS$K_ERROR | STS$M_INHIB_MSG;
5285 /* Traditionally Perl on VMS always expects a Fatal Error. */
5286 if (vaxc$errno & 1) {
5288 /* So force success status to failure */
5289 if (STATUS_NATIVE & 1)
5294 STATUS_UNIX = EINTR; /* In case something cares */
5299 STATUS_NATIVE = vaxc$errno; /* Should already be this */
5301 /* Encode the severity code */
5302 severity = STATUS_NATIVE & STS$M_SEVERITY;
5303 STATUS_UNIX = (severity ? severity : 1) << 8;
5305 /* Perl expects this to be a fatal error */
5306 if (severity != STS$K_SEVERE)
5316 STATUS_UNIX_SET(eno);
5318 exitstatus = STATUS_UNIX >> 8;
5319 if (exitstatus & 255)
5320 STATUS_UNIX_SET(exitstatus);
5322 STATUS_UNIX_SET(255);
5325 if (PL_exit_flags & PERL_EXIT_ABORT) {
5328 if (PL_exit_flags & PERL_EXIT_WARN) {
5329 PL_exit_flags |= PERL_EXIT_ABORT; /* Protect against reentrant calls */
5330 Perl_warn(aTHX_ "Unexpected exit failure %ld", (long)PL_statusvalue);
5331 PL_exit_flags &= ~PERL_EXIT_ABORT;
5337 S_my_exit_jump(pTHX)
5340 SvREFCNT_dec(PL_e_script);
5344 POPSTACK_TO(PL_mainstack);
5345 if (cxstack_ix >= 0) {
5347 cx_popblock(cxstack);
5355 read_e_script(pTHX_ int idx, SV *buf_sv, int maxlen)
5357 const char * const p = SvPVX_const(PL_e_script);
5358 const char * const e = SvEND(PL_e_script);
5359 const char *nl = (char *) memchr(p, '\n', e - p);
5361 PERL_UNUSED_ARG(idx);
5362 PERL_UNUSED_ARG(maxlen);
5364 nl = (nl) ? nl+1 : e;
5366 filter_del(read_e_script);
5369 sv_catpvn(buf_sv, p, nl-p);
5370 sv_chop(PL_e_script, nl);
5374 /* removes boilerplate code at the end of each boot_Module xsub */
5376 Perl_xs_boot_epilog(pTHX_ const I32 ax)
5379 call_list(PL_scopestack_ix, PL_unitcheckav);
5384 * ex: set ts=8 sts=4 sw=4 et: