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 * 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
27 #ifdef PERL_IS_MINIPERL
28 # define USE_SITECUSTOMIZE
32 #define PERL_IN_PERL_C
34 #include "patchlevel.h" /* for local_patches */
41 #ifdef USE_KERN_PROC_PATHNAME
42 # include <sys/sysctl.h>
45 #ifdef USE_NSGETEXECUTABLEPATH
46 # include <mach-o/dyld.h>
49 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
56 char control[CMSG_SPACE(sizeof(int))];
73 #if !defined(STANDARD_C) && !defined(HAS_GETENV_PROTOTYPE) && !defined(PERL_MICRO)
74 char *getenv (char *); /* Usually in <stdlib.h> */
77 static I32 read_e_script(pTHX_ int idx, SV *buf_sv, int maxlen);
79 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
80 /* Drop everything. Heck, don't even try to call it */
81 # define validate_suid(validarg, scriptname, fdscript, suidscript, linestr_sv, rsfp) NOOP
83 /* Drop almost everything */
84 # define validate_suid(validarg, scriptname, fdscript, suidscript, linestr_sv, rsfp) S_validate_suid(aTHX_ rsfp)
87 #define CALL_BODY_SUB(myop) \
88 if (PL_op == (myop)) \
89 PL_op = PL_ppaddr[OP_ENTERSUB](aTHX); \
93 #define CALL_LIST_BODY(cv) \
94 PUSHMARK(PL_stack_sp); \
95 call_sv(MUTABLE_SV((cv)), G_EVAL|G_DISCARD|G_VOID);
98 S_init_tls_and_interp(PerlInterpreter *my_perl)
102 PERL_SET_INTERP(my_perl);
103 #if defined(USE_ITHREADS)
106 PERL_SET_THX(my_perl);
110 MUTEX_INIT(&PL_dollarzero_mutex);
111 MUTEX_INIT(&PL_my_ctx_mutex);
114 #if defined(USE_ITHREADS)
117 /* This always happens for non-ithreads */
120 PERL_SET_THX(my_perl);
125 /* these implement the PERL_SYS_INIT, PERL_SYS_INIT3, PERL_SYS_TERM macros */
128 Perl_sys_init(int* argc, char*** argv)
132 PERL_ARGS_ASSERT_SYS_INIT;
134 PERL_UNUSED_ARG(argc); /* may not be used depending on _BODY macro */
135 PERL_UNUSED_ARG(argv);
136 PERL_SYS_INIT_BODY(argc, argv);
140 Perl_sys_init3(int* argc, char*** argv, char*** env)
144 PERL_ARGS_ASSERT_SYS_INIT3;
146 PERL_UNUSED_ARG(argc); /* may not be used depending on _BODY macro */
147 PERL_UNUSED_ARG(argv);
148 PERL_UNUSED_ARG(env);
149 PERL_SYS_INIT3_BODY(argc, argv, env);
156 if (!PL_veto_cleanup) {
157 PERL_SYS_TERM_BODY();
162 #ifdef PERL_IMPLICIT_SYS
164 perl_alloc_using(struct IPerlMem* ipM, struct IPerlMem* ipMS,
165 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
166 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
167 struct IPerlDir* ipD, struct IPerlSock* ipS,
168 struct IPerlProc* ipP)
170 PerlInterpreter *my_perl;
172 PERL_ARGS_ASSERT_PERL_ALLOC_USING;
174 /* Newx() needs interpreter, so call malloc() instead */
175 my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
176 S_init_tls_and_interp(my_perl);
177 Zero(my_perl, 1, PerlInterpreter);
187 INIT_TRACK_MEMPOOL(PL_memory_debug_header, my_perl);
194 =head1 Embedding Functions
196 =for apidoc perl_alloc
198 Allocates a new Perl interpreter. See L<perlembed>.
206 PerlInterpreter *my_perl;
208 /* Newx() needs interpreter, so call malloc() instead */
209 my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
211 S_init_tls_and_interp(my_perl);
212 #ifndef PERL_TRACK_MEMPOOL
213 return (PerlInterpreter *) ZeroD(my_perl, 1, PerlInterpreter);
215 Zero(my_perl, 1, PerlInterpreter);
216 INIT_TRACK_MEMPOOL(PL_memory_debug_header, my_perl);
220 #endif /* PERL_IMPLICIT_SYS */
223 =for apidoc perl_construct
225 Initializes a new Perl interpreter. See L<perlembed>.
231 perl_construct(pTHXx)
235 PERL_ARGS_ASSERT_PERL_CONSTRUCT;
239 PL_perl_destruct_level = 1;
241 PERL_UNUSED_ARG(my_perl);
242 if (PL_perl_destruct_level > 0)
245 PL_curcop = &PL_compiling; /* needed by ckWARN, right away */
247 /* set read-only and try to insure than we wont see REFCNT==0
250 SvREADONLY_on(&PL_sv_undef);
251 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
253 sv_setpv(&PL_sv_no,PL_No);
254 /* value lookup in void context - happens to have the side effect
255 of caching the numeric forms. However, as &PL_sv_no doesn't contain
256 a string that is a valid numer, we have to turn the public flags by
262 SvREADONLY_on(&PL_sv_no);
263 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
265 sv_setpv(&PL_sv_yes,PL_Yes);
268 SvREADONLY_on(&PL_sv_yes);
269 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
271 SvREADONLY_on(&PL_sv_placeholder);
272 SvREFCNT(&PL_sv_placeholder) = (~(U32)0)/2;
274 PL_sighandlerp = (Sighandler_t) Perl_sighandler;
275 #ifdef PERL_USES_PL_PIDSTATUS
276 PL_pidstatus = newHV();
279 PL_rs = newSVpvs("\n");
289 SET_NUMERIC_STANDARD();
291 #if defined(LOCAL_PATCH_COUNT)
292 PL_localpatches = local_patches; /* For possible -v */
295 #ifdef HAVE_INTERP_INTERN
299 PerlIO_init(aTHX); /* Hook to IO system */
301 PL_fdpid = newAV(); /* for remembering popen pids by fd */
302 PL_modglobal = newHV(); /* pointers to per-interpreter module globals */
303 PL_errors = newSVpvs("");
304 sv_setpvs(PERL_DEBUG_PAD(0), ""); /* For regex debugging. */
305 sv_setpvs(PERL_DEBUG_PAD(1), ""); /* ext/re needs these */
306 sv_setpvs(PERL_DEBUG_PAD(2), ""); /* even without DEBUGGING. */
308 /* First entry is a list of empty elements. It needs to be initialised
309 else all hell breaks loose in S_find_uninit_var(). */
310 Perl_av_create_and_push(aTHX_ &PL_regex_padav, newSVpvs(""));
311 PL_regex_pad = AvARRAY(PL_regex_padav);
313 #ifdef USE_REENTRANT_API
314 Perl_reentrant_init(aTHX);
317 /* Note that strtab is a rather special HV. Assumptions are made
318 about not iterating on it, and not adding tie magic to it.
319 It is properly deallocated in perl_destruct() */
322 HvSHAREKEYS_off(PL_strtab); /* mandatory */
323 hv_ksplit(PL_strtab, 512);
325 #if defined(__DYNAMIC__) && (defined(NeXT) || defined(__NeXT__))
326 _dyld_lookup_and_bind
327 ("__environ", (unsigned long *) &environ_pointer, NULL);
331 # ifdef USE_ENVIRON_ARRAY
332 PL_origenviron = environ;
336 /* Use sysconf(_SC_CLK_TCK) if available, if not
337 * available or if the sysconf() fails, use the HZ.
338 * BeOS has those, but returns the wrong value.
339 * The HZ if not originally defined has been by now
340 * been defined as CLK_TCK, if available. */
341 #if defined(HAS_SYSCONF) && defined(_SC_CLK_TCK) && !defined(__BEOS__)
342 PL_clocktick = sysconf(_SC_CLK_TCK);
343 if (PL_clocktick <= 0)
347 PL_stashcache = newHV();
349 PL_patchlevel = newSVpvs("v" PERL_VERSION_STRING);
350 PL_apiversion = newSVpvs("v" PERL_API_VERSION_STRING);
353 if (!PL_mmap_page_size) {
354 #if defined(HAS_SYSCONF) && (defined(_SC_PAGESIZE) || defined(_SC_MMAP_PAGE_SIZE))
356 SETERRNO(0, SS_NORMAL);
358 PL_mmap_page_size = sysconf(_SC_PAGESIZE);
360 PL_mmap_page_size = sysconf(_SC_MMAP_PAGE_SIZE);
362 if ((long) PL_mmap_page_size < 0) {
364 SV * const error = ERRSV;
365 SvUPGRADE(error, SVt_PV);
366 Perl_croak(aTHX_ "panic: sysconf: %s", SvPV_nolen_const(error));
369 Perl_croak(aTHX_ "panic: sysconf: pagesize unknown");
373 # ifdef HAS_GETPAGESIZE
374 PL_mmap_page_size = getpagesize();
376 # if defined(I_SYS_PARAM) && defined(PAGESIZE)
377 PL_mmap_page_size = PAGESIZE; /* compiletime, bad */
381 if (PL_mmap_page_size <= 0)
382 Perl_croak(aTHX_ "panic: bad pagesize %" IVdf,
383 (IV) PL_mmap_page_size);
385 #endif /* HAS_MMAP */
387 #if defined(HAS_TIMES) && defined(PERL_NEED_TIMESBASE)
388 PL_timesbase.tms_utime = 0;
389 PL_timesbase.tms_stime = 0;
390 PL_timesbase.tms_cutime = 0;
391 PL_timesbase.tms_cstime = 0;
394 PL_osname = Perl_savepvn(aTHX_ STR_WITH_LEN(OSNAME));
396 PL_registered_mros = newHV();
397 /* Start with 1 bucket, for DFS. It's unlikely we'll need more. */
398 HvMAX(PL_registered_mros) = 0;
404 =for apidoc nothreadhook
406 Stub that provides thread hook for perl_destruct when there are
413 Perl_nothreadhook(pTHX)
419 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
421 Perl_dump_sv_child(pTHX_ SV *sv)
424 const int sock = PL_dumper_fd;
425 const int debug_fd = PerlIO_fileno(Perl_debug_log);
426 union control_un control;
429 struct cmsghdr *cmptr;
431 unsigned char buffer[256];
433 PERL_ARGS_ASSERT_DUMP_SV_CHILD;
435 if(sock == -1 || debug_fd == -1)
438 PerlIO_flush(Perl_debug_log);
440 /* All these shenanigans are to pass a file descriptor over to our child for
441 it to dump out to. We can't let it hold open the file descriptor when it
442 forks, as the file descriptor it will dump to can turn out to be one end
443 of pipe that some other process will wait on for EOF. (So as it would
444 be open, the wait would be forever.) */
446 msg.msg_control = control.control;
447 msg.msg_controllen = sizeof(control.control);
448 /* We're a connected socket so we don't need a destination */
454 cmptr = CMSG_FIRSTHDR(&msg);
455 cmptr->cmsg_len = CMSG_LEN(sizeof(int));
456 cmptr->cmsg_level = SOL_SOCKET;
457 cmptr->cmsg_type = SCM_RIGHTS;
458 *((int *)CMSG_DATA(cmptr)) = 1;
460 vec[0].iov_base = (void*)&sv;
461 vec[0].iov_len = sizeof(sv);
462 got = sendmsg(sock, &msg, 0);
465 perror("Debug leaking scalars parent sendmsg failed");
468 if(got < sizeof(sv)) {
469 perror("Debug leaking scalars parent short sendmsg");
473 /* Return protocol is
475 unsigned char: length of location string (0 for empty)
476 unsigned char*: string (not terminated)
478 vec[0].iov_base = (void*)&returned_errno;
479 vec[0].iov_len = sizeof(returned_errno);
480 vec[1].iov_base = buffer;
483 got = readv(sock, vec, 2);
486 perror("Debug leaking scalars parent read failed");
487 PerlIO_flush(PerlIO_stderr());
490 if(got < sizeof(returned_errno) + 1) {
491 perror("Debug leaking scalars parent short read");
492 PerlIO_flush(PerlIO_stderr());
497 got = read(sock, buffer + 1, *buffer);
499 perror("Debug leaking scalars parent read 2 failed");
500 PerlIO_flush(PerlIO_stderr());
505 perror("Debug leaking scalars parent short read 2");
506 PerlIO_flush(PerlIO_stderr());
511 if (returned_errno || *buffer) {
512 Perl_warn(aTHX_ "Debug leaking scalars child failed%s%.*s with errno"
513 " %d: %s", (*buffer ? " at " : ""), (int) *buffer, buffer + 1,
514 returned_errno, strerror(returned_errno));
520 =for apidoc perl_destruct
522 Shuts down a Perl interpreter. See L<perlembed>.
531 VOL signed char destruct_level; /* see possible values in intrpvar.h */
533 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
537 PERL_ARGS_ASSERT_PERL_DESTRUCT;
539 PERL_UNUSED_ARG(my_perl);
542 assert(PL_scopestack_ix == 1);
544 /* wait for all pseudo-forked children to finish */
545 PERL_WAIT_FOR_CHILDREN;
547 destruct_level = PL_perl_destruct_level;
550 const char * const s = PerlEnv_getenv("PERL_DESTRUCT_LEVEL");
552 const int i = atoi(s);
553 if (destruct_level < i)
559 if (PL_exit_flags & PERL_EXIT_DESTRUCT_END) {
565 if (PL_endav && !PL_minus_c) {
566 PERL_SET_PHASE(PERL_PHASE_END);
567 call_list(PL_scopestack_ix, PL_endav);
573 assert(PL_scopestack_ix == 0);
575 /* Need to flush since END blocks can produce output */
578 if (PL_threadhook(aTHX)) {
579 /* Threads hook has vetoed further cleanup */
580 PL_veto_cleanup = TRUE;
584 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
585 if (destruct_level != 0) {
586 /* Fork here to create a child. Our child's job is to preserve the
587 state of scalars prior to destruction, so that we can instruct it
588 to dump any scalars that we later find have leaked.
589 There's no subtlety in this code - it assumes POSIX, and it doesn't
593 if(socketpair(AF_UNIX, SOCK_STREAM, 0, fd)) {
594 perror("Debug leaking scalars socketpair failed");
600 perror("Debug leaking scalars fork failed");
604 /* We are the child */
605 const int sock = fd[1];
606 const int debug_fd = PerlIO_fileno(Perl_debug_log);
609 /* Our success message is an integer 0, and a char 0 */
610 static const char success[sizeof(int) + 1] = {0};
614 /* We need to close all other file descriptors otherwise we end up
615 with interesting hangs, where the parent closes its end of a
616 pipe, and sits waiting for (another) child to terminate. Only
617 that child never terminates, because it never gets EOF, because
618 we also have the far end of the pipe open. We even need to
619 close the debugging fd, because sometimes it happens to be one
620 end of a pipe, and a process is waiting on the other end for
621 EOF. Normally it would be closed at some point earlier in
622 destruction, but if we happen to cause the pipe to remain open,
623 EOF never occurs, and we get an infinite hang. Hence all the
624 games to pass in a file descriptor if it's actually needed. */
626 f = sysconf(_SC_OPEN_MAX);
628 where = "sysconf failed";
639 union control_un control;
642 struct cmsghdr *cmptr;
646 msg.msg_control = control.control;
647 msg.msg_controllen = sizeof(control.control);
648 /* We're a connected socket so we don't need a source */
652 msg.msg_iovlen = sizeof(vec)/sizeof(vec[0]);
654 vec[0].iov_base = (void*)⌖
655 vec[0].iov_len = sizeof(target);
657 got = recvmsg(sock, &msg, 0);
662 where = "recv failed";
665 if(got < sizeof(target)) {
666 where = "short recv";
670 if(!(cmptr = CMSG_FIRSTHDR(&msg))) {
674 if(cmptr->cmsg_len != CMSG_LEN(sizeof(int))) {
675 where = "wrong cmsg_len";
678 if(cmptr->cmsg_level != SOL_SOCKET) {
679 where = "wrong cmsg_level";
682 if(cmptr->cmsg_type != SCM_RIGHTS) {
683 where = "wrong cmsg_type";
687 got_fd = *(int*)CMSG_DATA(cmptr);
688 /* For our last little bit of trickery, put the file descriptor
689 back into Perl_debug_log, as if we never actually closed it
691 if(got_fd != debug_fd) {
692 if (dup2(got_fd, debug_fd) == -1) {
699 PerlIO_flush(Perl_debug_log);
701 got = write(sock, &success, sizeof(success));
704 where = "write failed";
707 if(got < sizeof(success)) {
708 where = "short write";
715 int send_errno = errno;
716 unsigned char length = (unsigned char) strlen(where);
717 struct iovec failure[3] = {
718 {(void*)&send_errno, sizeof(send_errno)},
720 {(void*)where, length}
722 int got = writev(sock, failure, 3);
723 /* Bad news travels fast. Faster than data. We'll get a SIGPIPE
724 in the parent if we try to read from the socketpair after the
725 child has exited, even if there was data to read.
726 So sleep a bit to give the parent a fighting chance of
729 _exit((got == -1) ? errno : 0);
733 PL_dumper_fd = fd[0];
738 /* We must account for everything. */
740 /* Destroy the main CV and syntax tree */
741 /* Do this now, because destroying ops can cause new SVs to be generated
742 in Perl_pad_swipe, and when running with -DDEBUG_LEAKING_SCALARS they
743 PL_curcop to point to a valid op from which the filename structure
745 PL_curcop = &PL_compiling;
747 /* ensure comppad/curpad to refer to main's pad */
748 if (CvPADLIST(PL_main_cv)) {
749 PAD_SET_CUR_NOSAVE(CvPADLIST(PL_main_cv), 1);
751 op_free(PL_main_root);
754 PL_main_start = NULL;
755 /* note that PL_main_cv isn't usually actually freed at this point,
756 * due to the CvOUTSIDE refs from subs compiled within it. It will
757 * get freed once all the subs are freed in sv_clean_all(), for
758 * destruct_level > 0 */
759 SvREFCNT_dec(PL_main_cv);
761 PERL_SET_PHASE(PERL_PHASE_DESTRUCT);
763 /* Tell PerlIO we are about to tear things apart in case
764 we have layers which are using resources that should
768 PerlIO_destruct(aTHX);
770 if (PL_sv_objcount) {
772 * Try to destruct global references. We do this first so that the
773 * destructors and destructees still exist. Some sv's might remain.
774 * Non-referenced objects are on their own.
780 /* unhook hooks which will soon be, or use, destroyed data */
781 SvREFCNT_dec(PL_warnhook);
783 SvREFCNT_dec(PL_diehook);
786 /* call exit list functions */
787 while (PL_exitlistlen-- > 0)
788 PL_exitlist[PL_exitlistlen].fn(aTHX_ PL_exitlist[PL_exitlistlen].ptr);
790 Safefree(PL_exitlist);
795 SvREFCNT_dec(PL_registered_mros);
797 /* jettison our possibly duplicated environment */
798 /* if PERL_USE_SAFE_PUTENV is defined environ will not have been copied
799 * so we certainly shouldn't free it here
802 #if defined(USE_ENVIRON_ARRAY) && !defined(PERL_USE_SAFE_PUTENV)
803 if (environ != PL_origenviron && !PL_use_safe_putenv
805 /* only main thread can free environ[0] contents */
806 && PL_curinterp == aTHX
812 for (i = 0; environ[i]; i++)
813 safesysfree(environ[i]);
815 /* Must use safesysfree() when working with environ. */
816 safesysfree(environ);
818 environ = PL_origenviron;
821 #endif /* !PERL_MICRO */
823 if (destruct_level == 0) {
825 DEBUG_P(debprofdump());
827 #if defined(PERLIO_LAYERS)
828 /* No more IO - including error messages ! */
829 PerlIO_cleanup(aTHX);
832 CopFILE_free(&PL_compiling);
833 CopSTASH_free(&PL_compiling);
835 /* The exit() function will do everything that needs doing. */
840 /* the syntax tree is shared between clones
841 * so op_free(PL_main_root) only ReREFCNT_dec's
842 * REGEXPs in the parent interpreter
843 * we need to manually ReREFCNT_dec for the clones
845 SvREFCNT_dec(PL_regex_padav);
846 PL_regex_padav = NULL;
850 SvREFCNT_dec(MUTABLE_SV(PL_stashcache));
851 PL_stashcache = NULL;
853 /* loosen bonds of global variables */
855 /* XXX can PL_parser still be non-null here? */
856 if(PL_parser && PL_parser->rsfp) {
857 (void)PerlIO_close(PL_parser->rsfp);
858 PL_parser->rsfp = NULL;
862 Safefree(PL_splitstr);
872 PL_doswitches = FALSE;
873 PL_dowarn = G_WARN_OFF;
874 PL_sawampersand = FALSE; /* must save all match strings */
877 Safefree(PL_inplace);
879 SvREFCNT_dec(PL_patchlevel);
880 SvREFCNT_dec(PL_apiversion);
883 SvREFCNT_dec(PL_e_script);
889 /* magical thingies */
891 SvREFCNT_dec(PL_ofsgv); /* *, */
894 SvREFCNT_dec(PL_ors_sv); /* $\ */
897 SvREFCNT_dec(PL_rs); /* $/ */
900 Safefree(PL_osname); /* $^O */
903 SvREFCNT_dec(PL_statname);
907 /* defgv, aka *_ should be taken care of elsewhere */
910 Safefree(PL_efloatbuf);
914 /* startup and shutdown function lists */
915 SvREFCNT_dec(PL_beginav);
916 SvREFCNT_dec(PL_beginav_save);
917 SvREFCNT_dec(PL_endav);
918 SvREFCNT_dec(PL_checkav);
919 SvREFCNT_dec(PL_checkav_save);
920 SvREFCNT_dec(PL_unitcheckav);
921 SvREFCNT_dec(PL_unitcheckav_save);
922 SvREFCNT_dec(PL_initav);
924 PL_beginav_save = NULL;
927 PL_checkav_save = NULL;
928 PL_unitcheckav = NULL;
929 PL_unitcheckav_save = NULL;
932 /* shortcuts just get cleared */
941 PL_last_in_gv = NULL;
953 SvREFCNT_dec(PL_argvout_stack);
954 PL_argvout_stack = NULL;
956 SvREFCNT_dec(PL_modglobal);
958 SvREFCNT_dec(PL_preambleav);
959 PL_preambleav = NULL;
960 SvREFCNT_dec(PL_subname);
962 #ifdef PERL_USES_PL_PIDSTATUS
963 SvREFCNT_dec(PL_pidstatus);
966 SvREFCNT_dec(PL_toptarget);
968 SvREFCNT_dec(PL_bodytarget);
969 PL_bodytarget = NULL;
970 PL_formtarget = NULL;
972 /* free locale stuff */
973 #ifdef USE_LOCALE_COLLATE
974 Safefree(PL_collation_name);
975 PL_collation_name = NULL;
978 #ifdef USE_LOCALE_NUMERIC
979 Safefree(PL_numeric_name);
980 PL_numeric_name = NULL;
981 SvREFCNT_dec(PL_numeric_radix_sv);
982 PL_numeric_radix_sv = NULL;
985 /* clear utf8 character classes */
986 SvREFCNT_dec(PL_utf8_alnum);
987 SvREFCNT_dec(PL_utf8_alpha);
988 SvREFCNT_dec(PL_utf8_space);
989 SvREFCNT_dec(PL_utf8_graph);
990 SvREFCNT_dec(PL_utf8_digit);
991 SvREFCNT_dec(PL_utf8_upper);
992 SvREFCNT_dec(PL_utf8_lower);
993 SvREFCNT_dec(PL_utf8_print);
994 SvREFCNT_dec(PL_utf8_punct);
995 SvREFCNT_dec(PL_utf8_xdigit);
996 SvREFCNT_dec(PL_utf8_mark);
997 SvREFCNT_dec(PL_utf8_toupper);
998 SvREFCNT_dec(PL_utf8_totitle);
999 SvREFCNT_dec(PL_utf8_tolower);
1000 SvREFCNT_dec(PL_utf8_tofold);
1001 SvREFCNT_dec(PL_utf8_idstart);
1002 SvREFCNT_dec(PL_utf8_idcont);
1003 SvREFCNT_dec(PL_utf8_foldclosures);
1004 PL_utf8_alnum = NULL;
1005 PL_utf8_alpha = NULL;
1006 PL_utf8_space = NULL;
1007 PL_utf8_graph = NULL;
1008 PL_utf8_digit = NULL;
1009 PL_utf8_upper = NULL;
1010 PL_utf8_lower = NULL;
1011 PL_utf8_print = NULL;
1012 PL_utf8_punct = NULL;
1013 PL_utf8_xdigit = NULL;
1014 PL_utf8_mark = NULL;
1015 PL_utf8_toupper = NULL;
1016 PL_utf8_totitle = NULL;
1017 PL_utf8_tolower = NULL;
1018 PL_utf8_tofold = NULL;
1019 PL_utf8_idstart = NULL;
1020 PL_utf8_idcont = NULL;
1021 PL_utf8_foldclosures = NULL;
1023 if (!specialWARN(PL_compiling.cop_warnings))
1024 PerlMemShared_free(PL_compiling.cop_warnings);
1025 PL_compiling.cop_warnings = NULL;
1026 cophh_free(CopHINTHASH_get(&PL_compiling));
1027 CopHINTHASH_set(&PL_compiling, cophh_new_empty());
1028 CopFILE_free(&PL_compiling);
1029 CopSTASH_free(&PL_compiling);
1031 /* Prepare to destruct main symbol table. */
1034 /* break ref loop *:: <=> %:: */
1035 (void)hv_delete(hv, "main::", 6, G_DISCARD);
1038 SvREFCNT_dec(PL_curstname);
1039 PL_curstname = NULL;
1041 /* clear queued errors */
1042 SvREFCNT_dec(PL_errors);
1045 SvREFCNT_dec(PL_isarev);
1048 if (destruct_level >= 2) {
1049 if (PL_scopestack_ix != 0)
1050 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
1051 "Unbalanced scopes: %ld more ENTERs than LEAVEs\n",
1052 (long)PL_scopestack_ix);
1053 if (PL_savestack_ix != 0)
1054 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
1055 "Unbalanced saves: %ld more saves than restores\n",
1056 (long)PL_savestack_ix);
1057 if (PL_tmps_floor != -1)
1058 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced tmps: %ld more allocs than frees\n",
1059 (long)PL_tmps_floor + 1);
1060 if (cxstack_ix != -1)
1061 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced context: %ld more PUSHes than POPs\n",
1062 (long)cxstack_ix + 1);
1065 #ifdef PERL_IMPLICIT_CONTEXT
1066 /* the entries in this list are allocated via SV PVX's, so get freed
1067 * in sv_clean_all */
1068 Safefree(PL_my_cxt_list);
1071 /* Now absolutely destruct everything, somehow or other, loops or no. */
1073 /* the 2 is for PL_fdpid and PL_strtab */
1074 while (sv_clean_all() > 2)
1077 AvREAL_off(PL_fdpid); /* no surviving entries */
1078 SvREFCNT_dec(PL_fdpid); /* needed in io_close() */
1081 #ifdef HAVE_INTERP_INTERN
1085 /* Destruct the global string table. */
1087 /* Yell and reset the HeVAL() slots that are still holding refcounts,
1088 * so that sv_free() won't fail on them.
1089 * Now that the global string table is using a single hunk of memory
1090 * for both HE and HEK, we either need to explicitly unshare it the
1091 * correct way, or actually free things here.
1094 const I32 max = HvMAX(PL_strtab);
1095 HE * const * const array = HvARRAY(PL_strtab);
1096 HE *hent = array[0];
1099 if (hent && ckWARN_d(WARN_INTERNAL)) {
1100 HE * const next = HeNEXT(hent);
1101 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
1102 "Unbalanced string table refcount: (%ld) for \"%s\"",
1103 (long)hent->he_valu.hent_refcount, HeKEY(hent));
1110 hent = array[riter];
1115 HvARRAY(PL_strtab) = 0;
1116 HvTOTALKEYS(PL_strtab) = 0;
1118 SvREFCNT_dec(PL_strtab);
1121 /* free the pointer tables used for cloning */
1122 ptr_table_free(PL_ptr_table);
1123 PL_ptr_table = (PTR_TBL_t*)NULL;
1126 /* free special SVs */
1128 SvREFCNT(&PL_sv_yes) = 0;
1129 sv_clear(&PL_sv_yes);
1130 SvANY(&PL_sv_yes) = NULL;
1131 SvFLAGS(&PL_sv_yes) = 0;
1133 SvREFCNT(&PL_sv_no) = 0;
1134 sv_clear(&PL_sv_no);
1135 SvANY(&PL_sv_no) = NULL;
1136 SvFLAGS(&PL_sv_no) = 0;
1140 for (i=0; i<=2; i++) {
1141 SvREFCNT(PERL_DEBUG_PAD(i)) = 0;
1142 sv_clear(PERL_DEBUG_PAD(i));
1143 SvANY(PERL_DEBUG_PAD(i)) = NULL;
1144 SvFLAGS(PERL_DEBUG_PAD(i)) = 0;
1148 if (PL_sv_count != 0 && ckWARN_d(WARN_INTERNAL))
1149 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Scalars leaked: %ld\n", (long)PL_sv_count);
1151 #ifdef DEBUG_LEAKING_SCALARS
1152 if (PL_sv_count != 0) {
1157 for (sva = PL_sv_arenaroot; sva; sva = MUTABLE_SV(SvANY(sva))) {
1158 svend = &sva[SvREFCNT(sva)];
1159 for (sv = sva + 1; sv < svend; ++sv) {
1160 if (SvTYPE(sv) != (svtype)SVTYPEMASK) {
1161 PerlIO_printf(Perl_debug_log, "leaked: sv=0x%p"
1163 " refcnt=%"UVuf pTHX__FORMAT "\n"
1164 "\tallocated at %s:%d %s %s (parent 0x%"UVxf");"
1166 (void*)sv, (UV)sv->sv_flags, (UV)sv->sv_refcnt
1168 sv->sv_debug_file ? sv->sv_debug_file : "(unknown)",
1170 sv->sv_debug_inpad ? "for" : "by",
1171 sv->sv_debug_optype ?
1172 PL_op_name[sv->sv_debug_optype]: "(none)",
1173 PTR2UV(sv->sv_debug_parent),
1176 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1177 Perl_dump_sv_child(aTHX_ sv);
1183 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1187 /* Wait for up to 4 seconds for child to terminate.
1188 This seems to be the least effort way of timing out on reaping
1190 struct timeval waitfor = {4, 0};
1191 int sock = PL_dumper_fd;
1195 FD_SET(sock, &rset);
1196 select(sock + 1, &rset, NULL, NULL, &waitfor);
1197 waitpid(child, &status, WNOHANG);
1202 #ifdef DEBUG_LEAKING_SCALARS_ABORT
1208 #ifdef PERL_DEBUG_READONLY_OPS
1214 #if defined(PERLIO_LAYERS)
1215 /* No more IO - including error messages ! */
1216 PerlIO_cleanup(aTHX);
1219 /* sv_undef needs to stay immortal until after PerlIO_cleanup
1220 as currently layers use it rather than NULL as a marker
1221 for no arg - and will try and SvREFCNT_dec it.
1223 SvREFCNT(&PL_sv_undef) = 0;
1224 SvREADONLY_off(&PL_sv_undef);
1226 Safefree(PL_origfilename);
1227 PL_origfilename = NULL;
1228 Safefree(PL_reg_start_tmp);
1229 PL_reg_start_tmp = (char**)NULL;
1230 PL_reg_start_tmpl = 0;
1231 Safefree(PL_reg_curpm);
1232 Safefree(PL_reg_poscache);
1233 free_tied_hv_pool();
1234 Safefree(PL_op_mask);
1235 Safefree(PL_psig_name);
1236 PL_psig_name = (SV**)NULL;
1237 PL_psig_ptr = (SV**)NULL;
1239 /* We need to NULL PL_psig_pend first, so that
1240 signal handlers know not to use it */
1241 int *psig_save = PL_psig_pend;
1242 PL_psig_pend = (int*)NULL;
1243 Safefree(psig_save);
1247 PL_tainting = FALSE;
1248 PL_taint_warn = FALSE;
1249 PL_hints = 0; /* Reset hints. Should hints be per-interpreter ? */
1252 DEBUG_P(debprofdump());
1254 #ifdef USE_REENTRANT_API
1255 Perl_reentrant_free(aTHX);
1260 while (PL_regmatch_slab) {
1261 regmatch_slab *s = PL_regmatch_slab;
1262 PL_regmatch_slab = PL_regmatch_slab->next;
1266 /* As the absolutely last thing, free the non-arena SV for mess() */
1269 /* we know that type == SVt_PVMG */
1271 /* it could have accumulated taint magic */
1274 for (mg = SvMAGIC(PL_mess_sv); mg; mg = moremagic) {
1275 moremagic = mg->mg_moremagic;
1276 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global
1278 Safefree(mg->mg_ptr);
1282 /* we know that type >= SVt_PV */
1283 SvPV_free(PL_mess_sv);
1284 Safefree(SvANY(PL_mess_sv));
1285 Safefree(PL_mess_sv);
1292 =for apidoc perl_free
1294 Releases a Perl interpreter. See L<perlembed>.
1304 PERL_ARGS_ASSERT_PERL_FREE;
1306 if (PL_veto_cleanup)
1309 #ifdef PERL_TRACK_MEMPOOL
1312 * Don't free thread memory if PERL_DESTRUCT_LEVEL is set to a non-zero
1313 * value as we're probably hunting memory leaks then
1315 const char * const s = PerlEnv_getenv("PERL_DESTRUCT_LEVEL");
1316 if (!s || atoi(s) == 0) {
1317 const U32 old_debug = PL_debug;
1318 /* Emulate the PerlHost behaviour of free()ing all memory allocated in this
1319 thread at thread exit. */
1321 PerlIO_puts(Perl_debug_log, "Disabling memory debugging as we "
1322 "free this thread's memory\n");
1323 PL_debug &= ~ DEBUG_m_FLAG;
1325 while(aTHXx->Imemory_debug_header.next != &(aTHXx->Imemory_debug_header))
1326 safesysfree(sTHX + (char *)(aTHXx->Imemory_debug_header.next));
1327 PL_debug = old_debug;
1332 #if defined(WIN32) || defined(NETWARE)
1333 # if defined(PERL_IMPLICIT_SYS)
1336 void *host = nw_internal_host;
1338 void *host = w32_internal_host;
1340 PerlMem_free(aTHXx);
1342 nw_delete_internal_host(host);
1344 win32_delete_internal_host(host);
1348 PerlMem_free(aTHXx);
1351 PerlMem_free(aTHXx);
1355 #if defined(USE_ITHREADS)
1356 /* provide destructors to clean up the thread key when libperl is unloaded */
1357 #ifndef WIN32 /* handled during DLL_PROCESS_DETACH in win32/perllib.c */
1359 #if defined(__hpux) && !(defined(__ux_version) && __ux_version <= 1020) && !defined(__GNUC__)
1360 #pragma fini "perl_fini"
1361 #elif defined(__sun) && !defined(__GNUC__)
1362 #pragma fini (perl_fini)
1366 #if defined(__GNUC__)
1367 __attribute__((destructor))
1372 if (PL_curinterp && !PL_veto_cleanup)
1377 #endif /* THREADS */
1380 Perl_call_atexit(pTHX_ ATEXIT_t fn, void *ptr)
1383 Renew(PL_exitlist, PL_exitlistlen+1, PerlExitListEntry);
1384 PL_exitlist[PL_exitlistlen].fn = fn;
1385 PL_exitlist[PL_exitlistlen].ptr = ptr;
1390 S_set_caret_X(pTHX) {
1392 GV* tmpgv = gv_fetchpvs("\030", GV_ADD|GV_NOTQUAL, SVt_PV); /* $^X */
1394 SV *const caret_x = GvSV(tmpgv);
1396 sv_setpv(caret_x, os2_execname(aTHX));
1398 # ifdef USE_KERN_PROC_PATHNAME
1403 mib[2] = KERN_PROC_PATHNAME;
1406 if (sysctl(mib, 4, NULL, &size, NULL, 0) == 0
1407 && size > 0 && size < MAXPATHLEN * MAXPATHLEN) {
1408 sv_grow(caret_x, size);
1410 if (sysctl(mib, 4, SvPVX(caret_x), &size, NULL, 0) == 0
1412 SvPOK_only(caret_x);
1413 SvCUR_set(caret_x, size - 1);
1418 # elif defined(USE_NSGETEXECUTABLEPATH)
1420 uint32_t size = sizeof(buf);
1422 _NSGetExecutablePath(buf, &size);
1423 if (size < MAXPATHLEN * MAXPATHLEN) {
1424 sv_grow(caret_x, size);
1425 if (_NSGetExecutablePath(SvPVX(caret_x), &size) == 0) {
1426 char *const tidied = realpath(SvPVX(caret_x), NULL);
1428 sv_setpv(caret_x, tidied);
1431 SvPOK_only(caret_x);
1432 SvCUR_set(caret_x, size);
1437 # elif defined(HAS_PROCSELFEXE)
1438 char buf[MAXPATHLEN];
1439 int len = readlink(PROCSELFEXE_PATH, buf, sizeof(buf) - 1);
1441 /* On Playstation2 Linux V1.0 (kernel 2.2.1) readlink(/proc/self/exe)
1442 includes a spurious NUL which will cause $^X to fail in system
1443 or backticks (this will prevent extensions from being built and
1444 many tests from working). readlink is not meant to add a NUL.
1445 Normal readlink works fine.
1447 if (len > 0 && buf[len-1] == '\0') {
1451 /* FreeBSD's implementation is acknowledged to be imperfect, sometimes
1452 returning the text "unknown" from the readlink rather than the path
1453 to the executable (or returning an error from the readlink). Any
1454 valid path has a '/' in it somewhere, so use that to validate the
1455 result. See http://www.freebsd.org/cgi/query-pr.cgi?pr=35703
1457 if (len > 0 && memchr(buf, '/', len)) {
1458 sv_setpvn(caret_x, buf, len);
1462 /* Fallback to this: */
1463 sv_setpv(caret_x, PL_origargv[0]);
1469 =for apidoc perl_parse
1471 Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
1476 #define SET_CURSTASH(newstash) \
1477 if (PL_curstash != newstash) { \
1478 SvREFCNT_dec(PL_curstash); \
1479 PL_curstash = (HV *)SvREFCNT_inc(newstash); \
1483 perl_parse(pTHXx_ XSINIT_t xsinit, int argc, char **argv, char **env)
1490 PERL_ARGS_ASSERT_PERL_PARSE;
1491 #ifndef MULTIPLICITY
1492 PERL_UNUSED_ARG(my_perl);
1495 #if defined(USE_HASH_SEED) || defined(USE_HASH_SEED_EXPLICIT)
1496 /* [perl #22371] Algorimic Complexity Attack on Perl 5.6.1, 5.8.0
1497 * This MUST be done before any hash stores or fetches take place.
1498 * If you set PL_rehash_seed (and presumably also PL_rehash_seed_set)
1499 * yourself, it is your responsibility to provide a good random seed!
1500 * You can also define PERL_HASH_SEED in compile time, see hv.h. */
1501 if (!PL_rehash_seed_set)
1502 PL_rehash_seed = get_hash_seed();
1504 const char * const s = PerlEnv_getenv("PERL_HASH_SEED_DEBUG");
1506 if (s && (atoi(s) == 1))
1507 PerlIO_printf(Perl_debug_log, "HASH_SEED = %"UVuf"\n", PL_rehash_seed);
1509 #endif /* #if defined(USE_HASH_SEED) || defined(USE_HASH_SEED_EXPLICIT) */
1514 if (PL_origalen != 0) {
1515 PL_origalen = 1; /* don't use old PL_origalen if perl_parse() is called again */
1518 /* Set PL_origalen be the sum of the contiguous argv[]
1519 * elements plus the size of the env in case that it is
1520 * contiguous with the argv[]. This is used in mg.c:Perl_magic_set()
1521 * as the maximum modifiable length of $0. In the worst case
1522 * the area we are able to modify is limited to the size of
1523 * the original argv[0]. (See below for 'contiguous', though.)
1525 const char *s = NULL;
1528 ~(UV)(PTRSIZE == 4 ? 3 : PTRSIZE == 8 ? 7 : PTRSIZE == 16 ? 15 : 0);
1529 /* Do the mask check only if the args seem like aligned. */
1531 (mask < ~(UV)0) && ((PTR2UV(argv[0]) & mask) == PTR2UV(argv[0]));
1533 /* See if all the arguments are contiguous in memory. Note
1534 * that 'contiguous' is a loose term because some platforms
1535 * align the argv[] and the envp[]. If the arguments look
1536 * like non-aligned, assume that they are 'strictly' or
1537 * 'traditionally' contiguous. If the arguments look like
1538 * aligned, we just check that they are within aligned
1539 * PTRSIZE bytes. As long as no system has something bizarre
1540 * like the argv[] interleaved with some other data, we are
1541 * fine. (Did I just evoke Murphy's Law?) --jhi */
1542 if (PL_origargv && PL_origargc >= 1 && (s = PL_origargv[0])) {
1544 for (i = 1; i < PL_origargc; i++) {
1545 if ((PL_origargv[i] == s + 1
1547 || PL_origargv[i] == s + 2
1552 (PL_origargv[i] > s &&
1554 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1565 #ifndef PERL_USE_SAFE_PUTENV
1566 /* Can we grab env area too to be used as the area for $0? */
1567 if (s && PL_origenviron && !PL_use_safe_putenv) {
1568 if ((PL_origenviron[0] == s + 1)
1571 (PL_origenviron[0] > s &&
1572 PL_origenviron[0] <=
1573 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1576 #ifndef OS2 /* ENVIRON is read by the kernel too. */
1577 s = PL_origenviron[0];
1580 my_setenv("NoNe SuCh", NULL);
1581 /* Force copy of environment. */
1582 for (i = 1; PL_origenviron[i]; i++) {
1583 if (PL_origenviron[i] == s + 1
1586 (PL_origenviron[i] > s &&
1587 PL_origenviron[i] <=
1588 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1591 s = PL_origenviron[i];
1599 #endif /* !defined(PERL_USE_SAFE_PUTENV) */
1601 PL_origalen = s ? s - PL_origargv[0] + 1 : 0;
1606 /* Come here if running an undumped a.out. */
1608 PL_origfilename = savepv(argv[0]);
1609 PL_do_undump = FALSE;
1610 cxstack_ix = -1; /* start label stack again */
1612 assert (!PL_tainted);
1614 S_set_caret_X(aTHX);
1616 init_postdump_symbols(argc,argv,env);
1621 op_free(PL_main_root);
1622 PL_main_root = NULL;
1624 PL_main_start = NULL;
1625 SvREFCNT_dec(PL_main_cv);
1629 oldscope = PL_scopestack_ix;
1630 PL_dowarn = G_WARN_OFF;
1635 parse_body(env,xsinit);
1636 if (PL_unitcheckav) {
1637 call_list(oldscope, PL_unitcheckav);
1640 PERL_SET_PHASE(PERL_PHASE_CHECK);
1641 call_list(oldscope, PL_checkav);
1649 /* my_exit() was called */
1650 while (PL_scopestack_ix > oldscope)
1653 SET_CURSTASH(PL_defstash);
1654 if (PL_unitcheckav) {
1655 call_list(oldscope, PL_unitcheckav);
1658 PERL_SET_PHASE(PERL_PHASE_CHECK);
1659 call_list(oldscope, PL_checkav);
1664 PerlIO_printf(Perl_error_log, "panic: top_env\n");
1672 /* This needs to stay in perl.c, as perl.c is compiled with different flags for
1673 miniperl, and we need to see those flags reflected in the values here. */
1675 /* What this returns is subject to change. Use the public interface in Config.
1678 S_Internals_V(pTHX_ CV *cv)
1681 #ifdef LOCAL_PATCH_COUNT
1682 const int local_patch_count = LOCAL_PATCH_COUNT;
1684 const int local_patch_count = 0;
1686 const int entries = 3 + local_patch_count;
1688 static char non_bincompat_options[] =
1695 # ifdef PERL_DISABLE_PMC
1698 # ifdef PERL_DONT_CREATE_GVSV
1699 " PERL_DONT_CREATE_GVSV"
1701 # ifdef PERL_EXTERNAL_GLOB
1702 " PERL_EXTERNAL_GLOB"
1704 # ifdef PERL_IS_MINIPERL
1707 # ifdef PERL_MALLOC_WRAP
1710 # ifdef PERL_MEM_LOG
1713 # ifdef PERL_MEM_LOG_NOIMPL
1714 " PERL_MEM_LOG_NOIMPL"
1716 # ifdef PERL_PRESERVE_IVUV
1717 " PERL_PRESERVE_IVUV"
1719 # ifdef PERL_RELOCATABLE_INCPUSH
1720 " PERL_RELOCATABLE_INCPUSH"
1722 # ifdef PERL_USE_DEVEL
1725 # ifdef PERL_USE_SAFE_PUTENV
1726 " PERL_USE_SAFE_PUTENV"
1728 # ifdef UNLINK_ALL_VERSIONS
1729 " UNLINK_ALL_VERSIONS"
1731 # ifdef USE_ATTRIBUTES_FOR_PERLIO
1732 " USE_ATTRIBUTES_FOR_PERLIO"
1734 # ifdef USE_FAST_STDIO
1740 # ifdef USE_LOCALE_CTYPE
1743 # ifdef USE_PERL_ATOF
1746 # ifdef USE_SITECUSTOMIZE
1747 " USE_SITECUSTOMIZE"
1750 PERL_UNUSED_ARG(cv);
1751 PERL_UNUSED_ARG(items);
1753 EXTEND(SP, entries);
1755 PUSHs(sv_2mortal(newSVpv(PL_bincompat_options, 0)));
1756 PUSHs(Perl_newSVpvn_flags(aTHX_ non_bincompat_options,
1757 sizeof(non_bincompat_options) - 1, SVs_TEMP));
1761 PUSHs(Perl_newSVpvn_flags(aTHX_
1762 STR_WITH_LEN("Compiled at " __DATE__ " " __TIME__),
1765 PUSHs(Perl_newSVpvn_flags(aTHX_ STR_WITH_LEN("Compiled on " __DATE__),
1769 PUSHs(&PL_sv_undef);
1772 for (i = 1; i <= local_patch_count; i++) {
1773 /* This will be an undef, if PL_localpatches[i] is NULL. */
1774 PUSHs(sv_2mortal(newSVpv(PL_localpatches[i], 0)));
1780 #define INCPUSH_UNSHIFT 0x01
1781 #define INCPUSH_ADD_OLD_VERS 0x02
1782 #define INCPUSH_ADD_VERSIONED_SUB_DIRS 0x04
1783 #define INCPUSH_ADD_ARCHONLY_SUB_DIRS 0x08
1784 #define INCPUSH_NOT_BASEDIR 0x10
1785 #define INCPUSH_CAN_RELOCATE 0x20
1786 #define INCPUSH_ADD_SUB_DIRS \
1787 (INCPUSH_ADD_VERSIONED_SUB_DIRS|INCPUSH_ADD_ARCHONLY_SUB_DIRS)
1790 S_parse_body(pTHX_ char **env, XSINIT_t xsinit)
1794 int argc = PL_origargc;
1795 char **argv = PL_origargv;
1796 const char *scriptname = NULL;
1797 VOL bool dosearch = FALSE;
1799 bool doextract = FALSE;
1800 const char *cddir = NULL;
1801 #ifdef USE_SITECUSTOMIZE
1802 bool minus_f = FALSE;
1804 SV *linestr_sv = newSV_type(SVt_PVIV);
1805 bool add_read_e_script = FALSE;
1806 U32 lex_start_flags = 0;
1808 PERL_SET_PHASE(PERL_PHASE_START);
1810 SvGROW(linestr_sv, 80);
1811 sv_setpvs(linestr_sv,"");
1817 for (argc--,argv++; argc > 0; argc--,argv++) {
1818 if (argv[0][0] != '-' || !argv[0][1])
1824 #ifndef PERL_STRICT_CR
1848 if ((s = moreswitches(s)))
1853 CHECK_MALLOC_TOO_LATE_FOR('t');
1854 if( !PL_tainting ) {
1855 PL_taint_warn = TRUE;
1861 CHECK_MALLOC_TOO_LATE_FOR('T');
1863 PL_taint_warn = FALSE;
1871 forbid_setid('e', FALSE);
1873 PL_e_script = newSVpvs("");
1874 add_read_e_script = TRUE;
1877 sv_catpv(PL_e_script, s);
1879 sv_catpv(PL_e_script, argv[1]);
1883 Perl_croak(aTHX_ "No code specified for -%c", c);
1884 sv_catpvs(PL_e_script, "\n");
1888 #ifdef USE_SITECUSTOMIZE
1894 case 'I': /* -I handled both here and in moreswitches() */
1895 forbid_setid('I', FALSE);
1896 if (!*++s && (s=argv[1]) != NULL) {
1900 STRLEN len = strlen(s);
1901 incpush(s, len, INCPUSH_ADD_SUB_DIRS|INCPUSH_ADD_OLD_VERS);
1904 Perl_croak(aTHX_ "No directory specified for -I");
1907 forbid_setid('S', FALSE);
1916 opts_prog = newSVpvs("use Config; Config::_V()");
1920 opts_prog = Perl_newSVpvf(aTHX_
1921 "use Config; Config::config_vars(qw%c%s%c)",
1925 Perl_av_create_and_push(aTHX_ &PL_preambleav, opts_prog);
1926 /* don't look for script or read stdin */
1927 scriptname = BIT_BUCKET;
1939 if (!*++s || isSPACE(*s)) {
1943 /* catch use of gnu style long options.
1944 Both of these exit immediately. */
1945 if (strEQ(s, "version"))
1947 if (strEQ(s, "help"))
1952 Perl_croak(aTHX_ "Unrecognized switch: -%s (-h will show valid options)",s);
1963 #ifndef SECURE_INTERNAL_GETENV
1966 (s = PerlEnv_getenv("PERL5OPT")))
1970 if (*s == '-' && *(s+1) == 'T') {
1971 CHECK_MALLOC_TOO_LATE_FOR('T');
1973 PL_taint_warn = FALSE;
1976 char *popt_copy = NULL;
1989 if (!strchr("CDIMUdmtwW", *s))
1990 Perl_croak(aTHX_ "Illegal switch in PERL5OPT: -%c", *s);
1994 popt_copy = SvPVX(sv_2mortal(newSVpv(d,0)));
1995 s = popt_copy + (s - d);
2003 if( !PL_tainting ) {
2004 PL_taint_warn = TRUE;
2015 /* Set $^X early so that it can be used for relocatable paths in @INC */
2016 /* and for SITELIB_EXP in USE_SITECUSTOMIZE */
2017 assert (!PL_tainted);
2019 S_set_caret_X(aTHX);
2022 #if defined(USE_SITECUSTOMIZE)
2024 /* The games with local $! are to avoid setting errno if there is no
2025 sitecustomize script. "q%c...%c", 0, ..., 0 becomes "q\0...\0",
2026 ie a q() operator with a NUL byte as a the delimiter. This avoids
2027 problems with pathnames containing (say) ' */
2028 # ifdef PERL_IS_MINIPERL
2029 AV *const inc = GvAV(PL_incgv);
2030 SV **const inc0 = inc ? av_fetch(inc, 0, FALSE) : NULL;
2033 (void)Perl_av_create_and_unshift_one(aTHX_ &PL_preambleav,
2035 "BEGIN { do {local $!; -f q%c%"SVf"/buildcustomize.pl%c} && do q%c%"SVf"/buildcustomize.pl%c }",
2040 /* SITELIB_EXP is a function call on Win32. */
2041 const char *const raw_sitelib = SITELIB_EXP;
2042 /* process .../.. if PERL_RELOCATABLE_INC is defined */
2043 SV *sitelib_sv = mayberelocate(raw_sitelib, strlen(raw_sitelib),
2044 INCPUSH_CAN_RELOCATE);
2045 const char *const sitelib = SvPVX(sitelib_sv);
2046 (void)Perl_av_create_and_unshift_one(aTHX_ &PL_preambleav,
2048 "BEGIN { do {local $!; -f q%c%s/sitecustomize.pl%c} && do q%c%s/sitecustomize.pl%c }",
2051 assert (SvREFCNT(sitelib_sv) == 1);
2052 SvREFCNT_dec(sitelib_sv);
2058 scriptname = argv[0];
2061 scriptname = BIT_BUCKET; /* don't look for script or read stdin */
2063 else if (scriptname == NULL) {
2065 if ( PerlLIO_isatty(PerlIO_fileno(PerlIO_stdin())) )
2071 assert (!PL_tainted);
2075 bool suidscript = FALSE;
2077 rsfp = open_script(scriptname, dosearch, &suidscript);
2079 rsfp = PerlIO_stdin();
2080 lex_start_flags = LEX_DONT_CLOSE_RSFP;
2083 validate_suid(validarg, scriptname, fdscript, suidscript,
2087 # if defined(SIGCHLD) || defined(SIGCLD)
2090 # define SIGCHLD SIGCLD
2092 Sighandler_t sigstate = rsignal_state(SIGCHLD);
2093 if (sigstate == (Sighandler_t) SIG_IGN) {
2094 Perl_ck_warner(aTHX_ packWARN(WARN_SIGNAL),
2095 "Can't ignore signal CHLD, forcing to default");
2096 (void)rsignal(SIGCHLD, (Sighandler_t)SIG_DFL);
2104 /* This will croak if suidscript is true, as -x cannot be used with
2106 forbid_setid('x', suidscript);
2107 /* Hence you can't get here if suidscript is true */
2109 find_beginning(linestr_sv, rsfp);
2110 if (cddir && PerlDir_chdir( (char *)cddir ) < 0)
2111 Perl_croak(aTHX_ "Can't chdir to %s",cddir);
2115 PL_main_cv = PL_compcv = MUTABLE_CV(newSV_type(SVt_PVCV));
2116 CvUNIQUE_on(PL_compcv);
2118 CvPADLIST(PL_compcv) = pad_new(0);
2120 PL_isarev = newHV();
2123 boot_core_UNIVERSAL();
2125 newXS("Internals::V", S_Internals_V, __FILE__);
2128 (*xsinit)(aTHX); /* in case linked C routines want magical variables */
2130 #if defined(VMS) || defined(WIN32) || defined(DJGPP) || defined(__CYGWIN__) || defined(EPOC) || defined(SYMBIAN)
2136 # ifdef HAS_SOCKS5_INIT
2137 socks5_init(argv[0]);
2143 init_predump_symbols();
2144 /* init_postdump_symbols not currently designed to be called */
2145 /* more than once (ENV isn't cleared first, for example) */
2146 /* But running with -u leaves %ENV & @ARGV undefined! XXX */
2148 init_postdump_symbols(argc,argv,env);
2150 /* PL_unicode is turned on by -C, or by $ENV{PERL_UNICODE},
2151 * or explicitly in some platforms.
2152 * locale.c:Perl_init_i18nl10n() if the environment
2153 * look like the user wants to use UTF-8. */
2154 #if defined(__SYMBIAN32__)
2155 PL_unicode = PERL_UNICODE_STD_FLAG; /* See PERL_SYMBIAN_CONSOLE_UTF8. */
2157 # ifndef PERL_IS_MINIPERL
2159 /* Requires init_predump_symbols(). */
2160 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
2165 /* Turn on UTF-8-ness on STDIN, STDOUT, STDERR
2166 * and the default open disciplines. */
2167 if ((PL_unicode & PERL_UNICODE_STDIN_FLAG) &&
2168 PL_stdingv && (io = GvIO(PL_stdingv)) &&
2170 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2171 if ((PL_unicode & PERL_UNICODE_STDOUT_FLAG) &&
2172 PL_defoutgv && (io = GvIO(PL_defoutgv)) &&
2174 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2175 if ((PL_unicode & PERL_UNICODE_STDERR_FLAG) &&
2176 PL_stderrgv && (io = GvIO(PL_stderrgv)) &&
2178 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2179 if ((PL_unicode & PERL_UNICODE_INOUT_FLAG) &&
2180 (sv = GvSV(gv_fetchpvs("\017PEN", GV_ADD|GV_NOTQUAL,
2182 U32 in = PL_unicode & PERL_UNICODE_IN_FLAG;
2183 U32 out = PL_unicode & PERL_UNICODE_OUT_FLAG;
2186 sv_setpvs(sv, ":utf8\0:utf8");
2188 sv_setpvs(sv, ":utf8\0");
2191 sv_setpvs(sv, "\0:utf8");
2200 if ((s = PerlEnv_getenv("PERL_SIGNALS"))) {
2201 if (strEQ(s, "unsafe"))
2202 PL_signals |= PERL_SIGNALS_UNSAFE_FLAG;
2203 else if (strEQ(s, "safe"))
2204 PL_signals &= ~PERL_SIGNALS_UNSAFE_FLAG;
2206 Perl_croak(aTHX_ "PERL_SIGNALS illegal: \"%s\"", s);
2213 if ((s = PerlEnv_getenv("PERL_XMLDUMP"))) {
2217 PL_xmlfp = PerlIO_stdout();
2219 PL_xmlfp = PerlIO_open(s, "w");
2221 Perl_croak(aTHX_ "Can't open %s", s);
2223 my_setenv("PERL_XMLDUMP", NULL); /* hide from subprocs */
2229 if ((s = PerlEnv_getenv("PERL_MADSKILLS"))) {
2230 PL_madskills = atoi(s);
2231 my_setenv("PERL_MADSKILLS", NULL); /* hide from subprocs */
2236 lex_start(linestr_sv, rsfp, lex_start_flags);
2237 PL_subname = newSVpvs("main");
2239 if (add_read_e_script)
2240 filter_add(read_e_script, NULL);
2242 /* now parse the script */
2244 SETERRNO(0,SS_NORMAL);
2245 if (yyparse(GRAMPROG) || PL_parser->error_count) {
2247 Perl_croak(aTHX_ "%s had compilation errors.\n", PL_origfilename);
2249 Perl_croak(aTHX_ "Execution of %s aborted due to compilation errors.\n",
2253 CopLINE_set(PL_curcop, 0);
2254 SET_CURSTASH(PL_defstash);
2256 SvREFCNT_dec(PL_e_script);
2264 SAVECOPFILE(PL_curcop);
2265 SAVECOPLINE(PL_curcop);
2266 gv_check(PL_defstash);
2275 if ((s=PerlEnv_getenv("PERL_DEBUG_MSTATS")) && atoi(s) >= 2)
2276 dump_mstats("after compilation:");
2281 PL_restartjmpenv = NULL;
2287 =for apidoc perl_run
2289 Tells a Perl interpreter to run. See L<perlembed>.
2302 PERL_ARGS_ASSERT_PERL_RUN;
2303 #ifndef MULTIPLICITY
2304 PERL_UNUSED_ARG(my_perl);
2307 oldscope = PL_scopestack_ix;
2315 cxstack_ix = -1; /* start context stack again */
2317 case 0: /* normal completion */
2321 case 2: /* my_exit() */
2322 while (PL_scopestack_ix > oldscope)
2325 SET_CURSTASH(PL_defstash);
2326 if (!(PL_exit_flags & PERL_EXIT_DESTRUCT_END) &&
2327 PL_endav && !PL_minus_c) {
2328 PERL_SET_PHASE(PERL_PHASE_END);
2329 call_list(oldscope, PL_endav);
2332 if (PerlEnv_getenv("PERL_DEBUG_MSTATS"))
2333 dump_mstats("after execution: ");
2339 POPSTACK_TO(PL_mainstack);
2342 PerlIO_printf(Perl_error_log, "panic: restartop in perl_run\n");
2353 S_run_body(pTHX_ I32 oldscope)
2356 DEBUG_r(PerlIO_printf(Perl_debug_log, "%s $` $& $' support.\n",
2357 PL_sawampersand ? "Enabling" : "Omitting"));
2359 if (!PL_restartop) {
2363 exit(0); /* less likely to core dump than my_exit(0) */
2367 if (DEBUG_x_TEST || DEBUG_B_TEST)
2368 dump_all_perl(!DEBUG_B_TEST);
2370 PERL_DEBUG(PerlIO_printf(Perl_debug_log, "\nEXECUTING...\n\n"));
2374 PerlIO_printf(Perl_error_log, "%s syntax OK\n", PL_origfilename);
2377 if (PERLDB_SINGLE && PL_DBsingle)
2378 sv_setiv(PL_DBsingle, 1);
2380 PERL_SET_PHASE(PERL_PHASE_INIT);
2381 call_list(oldscope, PL_initav);
2383 #ifdef PERL_DEBUG_READONLY_OPS
2384 Perl_pending_Slabs_to_ro(aTHX);
2390 PERL_SET_PHASE(PERL_PHASE_RUN);
2393 PL_restartjmpenv = NULL;
2394 PL_op = PL_restartop;
2398 else if (PL_main_start) {
2399 CvDEPTH(PL_main_cv) = 1;
2400 PL_op = PL_main_start;
2408 =head1 SV Manipulation Functions
2410 =for apidoc p||get_sv
2412 Returns the SV of the specified Perl scalar. C<flags> are passed to
2413 C<gv_fetchpv>. If C<GV_ADD> is set and the
2414 Perl variable does not exist then it will be created. If C<flags> is zero
2415 and the variable does not exist then NULL is returned.
2421 Perl_get_sv(pTHX_ const char *name, I32 flags)
2425 PERL_ARGS_ASSERT_GET_SV;
2427 gv = gv_fetchpv(name, flags, SVt_PV);
2434 =head1 Array Manipulation Functions
2436 =for apidoc p||get_av
2438 Returns the AV of the specified Perl global or package array with the given
2439 name (so it won't work on lexical variables). C<flags> are passed
2440 to C<gv_fetchpv>. If C<GV_ADD> is set and the
2441 Perl variable does not exist then it will be created. If C<flags> is zero
2442 and the variable does not exist then NULL is returned.
2444 Perl equivalent: C<@{"$name"}>.
2450 Perl_get_av(pTHX_ const char *name, I32 flags)
2452 GV* const gv = gv_fetchpv(name, flags, SVt_PVAV);
2454 PERL_ARGS_ASSERT_GET_AV;
2464 =head1 Hash Manipulation Functions
2466 =for apidoc p||get_hv
2468 Returns the HV of the specified Perl hash. C<flags> are passed to
2469 C<gv_fetchpv>. If C<GV_ADD> is set and the
2470 Perl variable does not exist then it will be created. If C<flags> is zero
2471 and the variable does not exist then NULL is returned.
2477 Perl_get_hv(pTHX_ const char *name, I32 flags)
2479 GV* const gv = gv_fetchpv(name, flags, SVt_PVHV);
2481 PERL_ARGS_ASSERT_GET_HV;
2491 =head1 CV Manipulation Functions
2493 =for apidoc p||get_cvn_flags
2495 Returns the CV of the specified Perl subroutine. C<flags> are passed to
2496 C<gv_fetchpvn_flags>. If C<GV_ADD> is set and the Perl subroutine does not
2497 exist then it will be declared (which has the same effect as saying
2498 C<sub name;>). If C<GV_ADD> is not set and the subroutine does not exist
2499 then NULL is returned.
2501 =for apidoc p||get_cv
2503 Uses C<strlen> to get the length of C<name>, then calls C<get_cvn_flags>.
2509 Perl_get_cvn_flags(pTHX_ const char *name, STRLEN len, I32 flags)
2511 GV* const gv = gv_fetchpvn_flags(name, len, flags, SVt_PVCV);
2512 /* XXX this is probably not what they think they're getting.
2513 * It has the same effect as "sub name;", i.e. just a forward
2516 PERL_ARGS_ASSERT_GET_CVN_FLAGS;
2518 if ((flags & ~GV_NOADD_MASK) && !GvCVu(gv)) {
2519 SV *const sv = newSVpvn_flags(name, len, flags & SVf_UTF8);
2520 return newSUB(start_subparse(FALSE, 0),
2521 newSVOP(OP_CONST, 0, sv),
2529 /* Nothing in core calls this now, but we can't replace it with a macro and
2530 move it to mathoms.c as a macro would evaluate name twice. */
2532 Perl_get_cv(pTHX_ const char *name, I32 flags)
2534 PERL_ARGS_ASSERT_GET_CV;
2536 return get_cvn_flags(name, strlen(name), flags);
2539 /* Be sure to refetch the stack pointer after calling these routines. */
2543 =head1 Callback Functions
2545 =for apidoc p||call_argv
2547 Performs a callback to the specified named and package-scoped Perl subroutine
2548 with C<argv> (a NULL-terminated array of strings) as arguments. See L<perlcall>.
2550 Approximate Perl equivalent: C<&{"$sub_name"}(@$argv)>.
2556 Perl_call_argv(pTHX_ const char *sub_name, I32 flags, register char **argv)
2558 /* See G_* flags in cop.h */
2559 /* null terminated arg list */
2564 PERL_ARGS_ASSERT_CALL_ARGV;
2569 mXPUSHs(newSVpv(*argv,0));
2574 return call_pv(sub_name, flags);
2578 =for apidoc p||call_pv
2580 Performs a callback to the specified Perl sub. See L<perlcall>.
2586 Perl_call_pv(pTHX_ const char *sub_name, I32 flags)
2587 /* name of the subroutine */
2588 /* See G_* flags in cop.h */
2590 PERL_ARGS_ASSERT_CALL_PV;
2592 return call_sv(MUTABLE_SV(get_cv(sub_name, GV_ADD)), flags);
2596 =for apidoc p||call_method
2598 Performs a callback to the specified Perl method. The blessed object must
2599 be on the stack. See L<perlcall>.
2605 Perl_call_method(pTHX_ const char *methname, I32 flags)
2606 /* name of the subroutine */
2607 /* See G_* flags in cop.h */
2610 PERL_ARGS_ASSERT_CALL_METHOD;
2612 len = strlen(methname);
2614 /* XXX: sv_2mortal(newSVpvn_share(methname, len)) can be faster */
2615 return call_sv(newSVpvn_flags(methname, len, SVs_TEMP), flags | G_METHOD);
2618 /* May be called with any of a CV, a GV, or an SV containing the name. */
2620 =for apidoc p||call_sv
2622 Performs a callback to the Perl sub whose name is in the SV. See
2629 Perl_call_sv(pTHX_ SV *sv, VOL I32 flags)
2630 /* See G_* flags in cop.h */
2633 LOGOP myop; /* fake syntax tree node */
2638 bool oldcatch = CATCH_GET;
2640 OP* const oldop = PL_op;
2643 PERL_ARGS_ASSERT_CALL_SV;
2645 if (flags & G_DISCARD) {
2649 if (!(flags & G_WANT)) {
2650 /* Backwards compatibility - as G_SCALAR was 0, it could be omitted.
2655 Zero(&myop, 1, LOGOP);
2656 myop.op_next = NULL;
2657 if (!(flags & G_NOARGS))
2658 myop.op_flags |= OPf_STACKED;
2659 myop.op_flags |= OP_GIMME_REVERSE(flags);
2663 EXTEND(PL_stack_sp, 1);
2664 *++PL_stack_sp = sv;
2666 oldscope = PL_scopestack_ix;
2668 if (PERLDB_SUB && PL_curstash != PL_debstash
2669 /* Handle first BEGIN of -d. */
2670 && (PL_DBcv || (PL_DBcv = GvCV(PL_DBsub)))
2671 /* Try harder, since this may have been a sighandler, thus
2672 * curstash may be meaningless. */
2673 && (SvTYPE(sv) != SVt_PVCV || CvSTASH((const CV *)sv) != PL_debstash)
2674 && !(flags & G_NODEBUG))
2675 PL_op->op_private |= OPpENTERSUB_DB;
2677 if (flags & G_METHOD) {
2678 Zero(&method_op, 1, UNOP);
2679 method_op.op_next = PL_op;
2680 method_op.op_ppaddr = PL_ppaddr[OP_METHOD];
2681 method_op.op_type = OP_METHOD;
2682 myop.op_ppaddr = PL_ppaddr[OP_ENTERSUB];
2683 myop.op_type = OP_ENTERSUB;
2684 PL_op = (OP*)&method_op;
2687 if (!(flags & G_EVAL)) {
2689 CALL_BODY_SUB((OP*)&myop);
2690 retval = PL_stack_sp - (PL_stack_base + oldmark);
2691 CATCH_SET(oldcatch);
2694 myop.op_other = (OP*)&myop;
2696 create_eval_scope(flags|G_FAKINGEVAL);
2704 CALL_BODY_SUB((OP*)&myop);
2705 retval = PL_stack_sp - (PL_stack_base + oldmark);
2706 if (!(flags & G_KEEPERR)) {
2714 /* my_exit() was called */
2715 SET_CURSTASH(PL_defstash);
2722 PL_restartjmpenv = NULL;
2723 PL_op = PL_restartop;
2727 PL_stack_sp = PL_stack_base + oldmark;
2728 if ((flags & G_WANT) == G_ARRAY)
2732 *++PL_stack_sp = &PL_sv_undef;
2737 if (PL_scopestack_ix > oldscope)
2738 delete_eval_scope();
2742 if (flags & G_DISCARD) {
2743 PL_stack_sp = PL_stack_base + oldmark;
2752 /* Eval a string. The G_EVAL flag is always assumed. */
2755 =for apidoc p||eval_sv
2757 Tells Perl to C<eval> the string in the SV. It supports the same flags
2758 as C<call_sv>, with the obvious exception of G_EVAL. See L<perlcall>.
2764 Perl_eval_sv(pTHX_ SV *sv, I32 flags)
2766 /* See G_* flags in cop.h */
2770 UNOP myop; /* fake syntax tree node */
2771 VOL I32 oldmark = SP - PL_stack_base;
2774 OP* const oldop = PL_op;
2777 PERL_ARGS_ASSERT_EVAL_SV;
2779 if (flags & G_DISCARD) {
2786 Zero(PL_op, 1, UNOP);
2787 EXTEND(PL_stack_sp, 1);
2788 *++PL_stack_sp = sv;
2790 if (!(flags & G_NOARGS))
2791 myop.op_flags = OPf_STACKED;
2792 myop.op_next = NULL;
2793 myop.op_type = OP_ENTEREVAL;
2794 myop.op_flags |= OP_GIMME_REVERSE(flags);
2795 if (flags & G_KEEPERR)
2796 myop.op_flags |= OPf_SPECIAL;
2798 /* fail now; otherwise we could fail after the JMPENV_PUSH but
2799 * before a PUSHEVAL, which corrupts the stack after a croak */
2800 TAINT_PROPER("eval_sv()");
2806 if (PL_op == (OP*)(&myop)) {
2807 PL_op = PL_ppaddr[OP_ENTEREVAL](aTHX);
2809 goto fail; /* failed in compilation */
2812 retval = PL_stack_sp - (PL_stack_base + oldmark);
2813 if (!(flags & G_KEEPERR)) {
2821 /* my_exit() was called */
2822 SET_CURSTASH(PL_defstash);
2829 PL_restartjmpenv = NULL;
2830 PL_op = PL_restartop;
2835 PL_stack_sp = PL_stack_base + oldmark;
2836 if ((flags & G_WANT) == G_ARRAY)
2840 *++PL_stack_sp = &PL_sv_undef;
2846 if (flags & G_DISCARD) {
2847 PL_stack_sp = PL_stack_base + oldmark;
2857 =for apidoc p||eval_pv
2859 Tells Perl to C<eval> the given string and return an SV* result.
2865 Perl_eval_pv(pTHX_ const char *p, I32 croak_on_error)
2869 SV* sv = newSVpv(p, 0);
2871 PERL_ARGS_ASSERT_EVAL_PV;
2873 eval_sv(sv, G_SCALAR);
2880 if (croak_on_error && SvTRUE(ERRSV)) {
2881 Perl_croak(aTHX_ "%s", SvPVx_nolen_const(ERRSV));
2887 /* Require a module. */
2890 =head1 Embedding Functions
2892 =for apidoc p||require_pv
2894 Tells Perl to C<require> the file named by the string argument. It is
2895 analogous to the Perl code C<eval "require '$file'">. It's even
2896 implemented that way; consider using load_module instead.
2901 Perl_require_pv(pTHX_ const char *pv)
2907 PERL_ARGS_ASSERT_REQUIRE_PV;
2909 PUSHSTACKi(PERLSI_REQUIRE);
2911 sv = Perl_newSVpvf(aTHX_ "require q%c%s%c", 0, pv, 0);
2912 eval_sv(sv_2mortal(sv), G_DISCARD);
2918 S_usage(pTHX) /* XXX move this out into a module ? */
2920 /* This message really ought to be max 23 lines.
2921 * Removed -h because the user already knows that option. Others? */
2923 /* Grouped as 6 lines per C string literal, to keep under the ANSI C 89
2924 minimum of 509 character string literals. */
2925 static const char * const usage_msg[] = {
2926 " -0[octal] specify record separator (\\0, if no argument)\n"
2927 " -a autosplit mode with -n or -p (splits $_ into @F)\n"
2928 " -C[number/list] enables the listed Unicode features\n"
2929 " -c check syntax only (runs BEGIN and CHECK blocks)\n"
2930 " -d[:debugger] run program under debugger\n"
2931 " -D[number/list] set debugging flags (argument is a bit mask or alphabets)\n",
2932 " -e program one line of program (several -e's allowed, omit programfile)\n"
2933 " -E program like -e, but enables all optional features\n"
2934 " -f don't do $sitelib/sitecustomize.pl at startup\n"
2935 " -F/pattern/ split() pattern for -a switch (//'s are optional)\n"
2936 " -i[extension] edit <> files in place (makes backup if extension supplied)\n"
2937 " -Idirectory specify @INC/#include directory (several -I's allowed)\n",
2938 " -l[octal] enable line ending processing, specifies line terminator\n"
2939 " -[mM][-]module execute \"use/no module...\" before executing program\n"
2940 " -n assume \"while (<>) { ... }\" loop around program\n"
2941 " -p assume loop like -n but print line also, like sed\n"
2942 " -s enable rudimentary parsing for switches after programfile\n"
2943 " -S look for programfile using PATH environment variable\n",
2944 " -t enable tainting warnings\n"
2945 " -T enable tainting checks\n"
2946 " -u dump core after parsing program\n"
2947 " -U allow unsafe operations\n"
2948 " -v print version, patchlevel and license\n"
2949 " -V[:variable] print configuration summary (or a single Config.pm variable)\n",
2950 " -w enable many useful warnings\n"
2951 " -W enable all warnings\n"
2952 " -x[directory] ignore text before #!perl line (optionally cd to directory)\n"
2953 " -X disable all warnings\n"
2955 "Run 'perldoc perl' for more help with Perl.\n\n",
2958 const char * const *p = usage_msg;
2959 PerlIO *out = PerlIO_stdout();
2962 "\nUsage: %s [switches] [--] [programfile] [arguments]\n",
2965 PerlIO_puts(out, *p++);
2969 /* convert a string of -D options (or digits) into an int.
2970 * sets *s to point to the char after the options */
2974 Perl_get_debug_opts(pTHX_ const char **s, bool givehelp)
2976 static const char * const usage_msgd[] = {
2977 " Debugging flag values: (see also -d)\n"
2978 " p Tokenizing and parsing (with v, displays parse stack)\n"
2979 " s Stack snapshots (with v, displays all stacks)\n"
2980 " l Context (loop) stack processing\n"
2981 " t Trace execution\n"
2982 " o Method and overloading resolution\n",
2983 " c String/numeric conversions\n"
2984 " P Print profiling info, source file input state\n"
2985 " m Memory and SV allocation\n"
2986 " f Format processing\n"
2987 " r Regular expression parsing and execution\n"
2988 " x Syntax tree dump\n",
2989 " u Tainting checks\n"
2990 " H Hash dump -- usurps values()\n"
2991 " X Scratchpad allocation\n"
2994 " R Include reference counts of dumped variables (eg when using -Ds)\n",
2995 " J Do not s,t,P-debug (Jump over) opcodes within package DB\n"
2996 " v Verbose: use in conjunction with other flags\n"
2997 " C Copy On Write\n"
2998 " A Consistency checks on internal structures\n"
2999 " q quiet - currently only suppresses the 'EXECUTING' message\n"
3000 " M trace smart match resolution\n"
3001 " B dump suBroutine definitions, including special Blocks like BEGIN\n",
3006 PERL_ARGS_ASSERT_GET_DEBUG_OPTS;
3009 /* if adding extra options, remember to update DEBUG_MASK */
3010 static const char debopts[] = "psltocPmfrxuUHXDSTRJvCAqMB";
3012 for (; isALNUM(**s); (*s)++) {
3013 const char * const d = strchr(debopts,**s);
3015 i |= 1 << (d - debopts);
3016 else if (ckWARN_d(WARN_DEBUGGING))
3017 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3018 "invalid option -D%c, use -D'' to see choices\n", **s);
3021 else if (isDIGIT(**s)) {
3023 for (; isALNUM(**s); (*s)++) ;
3025 else if (givehelp) {
3026 const char *const *p = usage_msgd;
3027 while (*p) PerlIO_puts(PerlIO_stdout(), *p++);
3030 if ((i & DEBUG_p_FLAG) && ckWARN_d(WARN_DEBUGGING))
3031 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3032 "-Dp not implemented on this platform\n");
3038 /* This routine handles any switches that can be given during run */
3041 Perl_moreswitches(pTHX_ const char *s)
3045 const char option = *s; /* used to remember option in -m/-M code */
3047 PERL_ARGS_ASSERT_MORESWITCHES;
3055 SvREFCNT_dec(PL_rs);
3056 if (s[1] == 'x' && s[2]) {
3057 const char *e = s+=2;
3063 flags = PERL_SCAN_SILENT_ILLDIGIT;
3064 rschar = (U32)grok_hex(s, &numlen, &flags, NULL);
3065 if (s + numlen < e) {
3066 rschar = 0; /* Grandfather -0xFOO as -0 -xFOO. */
3070 PL_rs = newSVpvs("");
3071 SvGROW(PL_rs, (STRLEN)(UNISKIP(rschar) + 1));
3072 tmps = (U8*)SvPVX(PL_rs);
3073 uvchr_to_utf8(tmps, rschar);
3074 SvCUR_set(PL_rs, UNISKIP(rschar));
3079 rschar = (U32)grok_oct(s, &numlen, &flags, NULL);
3080 if (rschar & ~((U8)~0))
3081 PL_rs = &PL_sv_undef;
3082 else if (!rschar && numlen >= 2)
3083 PL_rs = newSVpvs("");
3085 char ch = (char)rschar;
3086 PL_rs = newSVpvn(&ch, 1);
3089 sv_setsv(get_sv("/", GV_ADD), PL_rs);
3094 PL_unicode = parse_unicode_opts( (const char **)&s );
3095 if (PL_unicode & PERL_UNICODE_UTF8CACHEASSERT_FLAG)
3101 while (*s && !isSPACE(*s)) ++s;
3102 PL_splitstr = savepvn(PL_splitstr, s - PL_splitstr);
3113 forbid_setid('d', FALSE);
3116 /* -dt indicates to the debugger that threads will be used */
3117 if (*s == 't' && !isALNUM(s[1])) {
3119 my_setenv("PERL5DB_THREADED", "1");
3122 /* The following permits -d:Mod to accepts arguments following an =
3123 in the fashion that -MSome::Mod does. */
3124 if (*s == ':' || *s == '=') {
3131 sv = newSVpvs("no Devel::");
3133 sv = newSVpvs("use Devel::");
3137 end = s + strlen(s);
3139 /* We now allow -d:Module=Foo,Bar and -d:-Module */
3140 while(isALNUM(*s) || *s==':') ++s;
3142 sv_catpvn(sv, start, end - start);
3144 sv_catpvn(sv, start, s-start);
3145 /* Don't use NUL as q// delimiter here, this string goes in the
3147 Perl_sv_catpvf(aTHX_ sv, " split(/,/,q{%s});", ++s);
3150 my_setenv("PERL5DB", SvPV_nolen_const(sv));
3154 PL_perldb = PERLDB_ALL;
3161 forbid_setid('D', FALSE);
3163 PL_debug = get_debug_opts( (const char **)&s, 1) | DEBUG_TOP_FLAG;
3164 #else /* !DEBUGGING */
3165 if (ckWARN_d(WARN_DEBUGGING))
3166 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3167 "Recompile perl with -DDEBUGGING to use -D switch (did you mean -d ?)\n");
3168 for (s++; isALNUM(*s); s++) ;
3175 Safefree(PL_inplace);
3176 #if defined(__CYGWIN__) /* do backup extension automagically */
3177 if (*(s+1) == '\0') {
3178 PL_inplace = savepvs(".bak");
3181 #endif /* __CYGWIN__ */
3183 const char * const start = ++s;
3184 while (*s && !isSPACE(*s))
3187 PL_inplace = savepvn(start, s - start);
3191 if (*s == '-') /* Additional switches on #! line. */
3195 case 'I': /* -I handled both here and in parse_body() */
3196 forbid_setid('I', FALSE);
3198 while (*s && isSPACE(*s))
3203 /* ignore trailing spaces (possibly followed by other switches) */
3205 for (e = p; *e && !isSPACE(*e); e++) ;
3209 } while (*p && *p != '-');
3211 INCPUSH_ADD_SUB_DIRS|INCPUSH_ADD_OLD_VERS|INCPUSH_UNSHIFT);
3217 Perl_croak(aTHX_ "No directory specified for -I");
3223 SvREFCNT_dec(PL_ors_sv);
3229 PL_ors_sv = newSVpvs("\n");
3230 numlen = 3 + (*s == '0');
3231 *SvPVX(PL_ors_sv) = (char)grok_oct(s, &numlen, &flags, NULL);
3235 if (RsPARA(PL_rs)) {
3236 PL_ors_sv = newSVpvs("\n\n");
3239 PL_ors_sv = newSVsv(PL_rs);
3244 forbid_setid('M', FALSE); /* XXX ? */
3247 forbid_setid('m', FALSE); /* XXX ? */
3252 const char *use = "use ";
3254 /* -M-foo == 'no foo' */
3255 /* Leading space on " no " is deliberate, to make both
3256 possibilities the same length. */
3257 if (*s == '-') { use = " no "; ++s; }
3258 sv = newSVpvn(use,4);
3260 /* We allow -M'Module qw(Foo Bar)' */
3261 while(isALNUM(*s) || *s==':') {
3270 Perl_croak(aTHX_ "Module name required with -%c option",
3273 Perl_croak(aTHX_ "Invalid module name %.*s with -%c option: "
3274 "contains single ':'",
3275 (int)(s - start), start, option);
3276 end = s + strlen(s);
3278 sv_catpvn(sv, start, end - start);
3279 if (option == 'm') {
3281 Perl_croak(aTHX_ "Can't use '%c' after -mname", *s);
3282 sv_catpvs( sv, " ()");
3285 sv_catpvn(sv, start, s-start);
3286 /* Use NUL as q''-delimiter. */
3287 sv_catpvs(sv, " split(/,/,q\0");
3289 sv_catpvn(sv, s, end - s);
3290 sv_catpvs(sv, "\0)");
3293 Perl_av_create_and_push(aTHX_ &PL_preambleav, sv);
3296 Perl_croak(aTHX_ "Missing argument to -%c", option);
3307 forbid_setid('s', FALSE);
3308 PL_doswitches = TRUE;
3318 PL_do_undump = TRUE;
3328 if (! (PL_dowarn & G_WARN_ALL_MASK)) {
3329 PL_dowarn |= G_WARN_ON;
3334 PL_dowarn = G_WARN_ALL_ON|G_WARN_ON;
3335 if (!specialWARN(PL_compiling.cop_warnings))
3336 PerlMemShared_free(PL_compiling.cop_warnings);
3337 PL_compiling.cop_warnings = pWARN_ALL ;
3341 PL_dowarn = G_WARN_ALL_OFF;
3342 if (!specialWARN(PL_compiling.cop_warnings))
3343 PerlMemShared_free(PL_compiling.cop_warnings);
3344 PL_compiling.cop_warnings = pWARN_NONE ;
3351 if (s[0] == '-') /* Additional switches on #! line. */
3356 #if defined(WIN32) || !defined(PERL_STRICT_CR)
3362 #ifdef ALTERNATE_SHEBANG
3363 case 'S': /* OS/2 needs -S on "extproc" line. */
3366 case 'e': case 'f': case 'x': case 'E':
3367 #ifndef ALTERNATE_SHEBANG
3371 Perl_croak(aTHX_ "Can't emulate -%.1s on #! line",s);
3374 "Unrecognized switch: -%.1s (-h will show valid options)",s
3384 if (!sv_derived_from(PL_patchlevel, "version"))
3385 upg_version(PL_patchlevel, TRUE);
3388 SV* level= vstringify(PL_patchlevel);
3389 #ifdef PERL_PATCHNUM
3390 # ifdef PERL_GIT_UNCOMMITTED_CHANGES
3391 SV *num = newSVpvs(PERL_PATCHNUM "*");
3393 SV *num = newSVpvs(PERL_PATCHNUM);
3396 if (sv_len(num)>=sv_len(level) && strnEQ(SvPV_nolen(num),SvPV_nolen(level),sv_len(level))) {
3397 SvREFCNT_dec(level);
3400 Perl_sv_catpvf(aTHX_ level, " (%"SVf")", num);
3404 PerlIO_printf(PerlIO_stdout(),
3405 "\nThis is perl " STRINGIFY(PERL_REVISION)
3406 ", version " STRINGIFY(PERL_VERSION)
3407 ", subversion " STRINGIFY(PERL_SUBVERSION)
3408 " (%"SVf") built for " ARCHNAME, level
3410 SvREFCNT_dec(level);
3413 /* Adjust verbose output as in the perl that ships with the DG/UX OS from EMC */
3414 PerlIO_printf(PerlIO_stdout(),
3415 Perl_form(aTHX_ "\nThis is perl, %"SVf"\n",
3416 SVfARG(vstringify(PL_patchlevel))));
3417 PerlIO_printf(PerlIO_stdout(),
3418 Perl_form(aTHX_ " built under %s at %s %s\n",
3419 OSNAME, __DATE__, __TIME__));
3420 PerlIO_printf(PerlIO_stdout(),
3421 Perl_form(aTHX_ " OS Specific Release: %s\n",
3424 #if defined(LOCAL_PATCH_COUNT)
3425 if (LOCAL_PATCH_COUNT > 0)
3426 PerlIO_printf(PerlIO_stdout(),
3427 "\n(with %d registered patch%s, "
3428 "see perl -V for more detail)",
3430 (LOCAL_PATCH_COUNT!=1) ? "es" : "");
3433 PerlIO_printf(PerlIO_stdout(),
3434 "\n\nCopyright 1987-2012, Larry Wall\n");
3436 PerlIO_printf(PerlIO_stdout(),
3437 "\nMS-DOS port Copyright (c) 1989, 1990, Diomidis Spinellis\n");
3440 PerlIO_printf(PerlIO_stdout(),
3441 "djgpp v2 port (jpl5003c) by Hirofumi Watanabe, 1996\n"
3442 "djgpp v2 port (perl5004+) by Laszlo Molnar, 1997-1999\n");
3445 PerlIO_printf(PerlIO_stdout(),
3446 "\n\nOS/2 port Copyright (c) 1990, 1991, Raymond Chen, Kai Uwe Rommel\n"
3447 "Version 5 port Copyright (c) 1994-2002, Andreas Kaiser, Ilya Zakharevich\n");
3450 PerlIO_printf(PerlIO_stdout(),
3451 "atariST series port, ++jrb bammi@cadence.com\n");
3454 PerlIO_printf(PerlIO_stdout(),
3455 "BeOS port Copyright Tom Spindler, 1997-1999\n");
3458 PerlIO_printf(PerlIO_stdout(),
3459 "MPE/iX port Copyright by Mark Klein and Mark Bixby, 1996-2003\n");
3462 PerlIO_printf(PerlIO_stdout(),
3463 "MVS (OS390) port by Mortice Kern Systems, 1997-1999\n");
3466 PerlIO_printf(PerlIO_stdout(),
3467 "Stratus VOS port by Paul.Green@stratus.com, 1997-2002\n");
3470 PerlIO_printf(PerlIO_stdout(),
3471 "VM/ESA port by Neale Ferguson, 1998-1999\n");
3474 PerlIO_printf(PerlIO_stdout(),
3475 "BS2000 (POSIX) port by Start Amadeus GmbH, 1998-1999\n");
3478 PerlIO_printf(PerlIO_stdout(),
3479 "EPOC port by Olaf Flebbe, 1999-2002\n");
3482 PerlIO_printf(PerlIO_stdout(),"WINCE port by Rainer Keuchel, 2001-2002\n");
3483 PerlIO_printf(PerlIO_stdout(),"Built on " __DATE__ " " __TIME__ "\n\n");
3486 #ifdef __SYMBIAN32__
3487 PerlIO_printf(PerlIO_stdout(),
3488 "Symbian port by Nokia, 2004-2005\n");
3490 #ifdef BINARY_BUILD_NOTICE
3491 BINARY_BUILD_NOTICE;
3493 PerlIO_printf(PerlIO_stdout(),
3495 Perl may be copied only under the terms of either the Artistic License or the\n\
3496 GNU General Public License, which may be found in the Perl 5 source kit.\n\n\
3497 Complete documentation for Perl, including FAQ lists, should be found on\n\
3498 this system using \"man perl\" or \"perldoc perl\". If you have access to the\n\
3499 Internet, point your browser at http://www.perl.org/, the Perl Home Page.\n\n");
3503 /* compliments of Tom Christiansen */
3505 /* unexec() can be found in the Gnu emacs distribution */
3506 /* Known to work with -DUNEXEC and using unexelf.c from GNU emacs-20.2 */
3509 Perl_my_unexec(pTHX)
3511 PERL_UNUSED_CONTEXT;
3513 SV * prog = newSVpv(BIN_EXP, 0);
3514 SV * file = newSVpv(PL_origfilename, 0);
3518 sv_catpvs(prog, "/perl");
3519 sv_catpvs(file, ".perldump");
3521 unexec(SvPVX(file), SvPVX(prog), &etext, sbrk(0), 0);
3522 /* unexec prints msg to stderr in case of failure */
3523 PerlProc_exit(status);
3526 # include <lib$routines.h>
3527 lib$signal(SS$_DEBUG); /* ssdef.h #included from vmsish.h */
3528 # elif defined(WIN32) || defined(__CYGWIN__)
3529 Perl_croak(aTHX_ "dump is not supported");
3531 ABORT(); /* for use with undump */
3536 /* initialize curinterp */
3542 # define PERLVAR(prefix,var,type)
3543 # define PERLVARA(prefix,var,n,type)
3544 # if defined(PERL_IMPLICIT_CONTEXT)
3545 # define PERLVARI(prefix,var,type,init) aTHX->prefix##var = init;
3546 # define PERLVARIC(prefix,var,type,init) aTHX->prefix##var = init;
3548 # define PERLVARI(prefix,var,type,init) PERL_GET_INTERP->var = init;
3549 # define PERLVARIC(prefix,var,type,init) PERL_GET_INTERP->var = init;
3551 # include "intrpvar.h"
3557 # define PERLVAR(prefix,var,type)
3558 # define PERLVARA(prefix,var,n,type)
3559 # define PERLVARI(prefix,var,type,init) PL_##var = init;
3560 # define PERLVARIC(prefix,var,type,init) PL_##var = init;
3561 # include "intrpvar.h"
3568 /* As these are inside a structure, PERLVARI isn't capable of initialising
3570 PL_reg_oldcurpm = PL_reg_curpm = NULL;
3571 PL_reg_poscache = PL_reg_starttry = NULL;
3575 S_init_main_stash(pTHX)
3580 PL_curstash = PL_defstash = (HV *)SvREFCNT_inc_simple_NN(newHV());
3581 /* We know that the string "main" will be in the global shared string
3582 table, so it's a small saving to use it rather than allocate another
3584 PL_curstname = newSVpvs_share("main");
3585 gv = gv_fetchpvs("main::", GV_ADD|GV_NOTQUAL, SVt_PVHV);
3586 /* If we hadn't caused another reference to "main" to be in the shared
3587 string table above, then it would be worth reordering these two,
3588 because otherwise all we do is delete "main" from it as a consequence
3589 of the SvREFCNT_dec, only to add it again with hv_name_set */
3590 SvREFCNT_dec(GvHV(gv));
3591 hv_name_set(PL_defstash, "main", 4, 0);
3592 GvHV(gv) = MUTABLE_HV(SvREFCNT_inc_simple(PL_defstash));
3594 PL_incgv = gv_HVadd(gv_AVadd(gv_fetchpvs("INC", GV_ADD|GV_NOTQUAL,
3596 SvREFCNT_inc_simple_void(PL_incgv); /* Don't allow it to be freed */
3597 GvMULTI_on(PL_incgv);
3598 PL_hintgv = gv_fetchpvs("\010", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^H */
3599 GvMULTI_on(PL_hintgv);
3600 PL_defgv = gv_fetchpvs("_", GV_ADD|GV_NOTQUAL, SVt_PVAV);
3601 SvREFCNT_inc_simple_void(PL_defgv);
3602 PL_errgv = gv_HVadd(gv_fetchpvs("@", GV_ADD|GV_NOTQUAL, SVt_PV));
3603 SvREFCNT_inc_simple_void(PL_errgv);
3604 GvMULTI_on(PL_errgv);
3605 PL_replgv = gv_fetchpvs("\022", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^R */
3606 GvMULTI_on(PL_replgv);
3607 (void)Perl_form(aTHX_ "%240s",""); /* Preallocate temp - for immediate signals. */
3608 #ifdef PERL_DONT_CREATE_GVSV
3611 sv_grow(ERRSV, 240); /* Preallocate - for immediate signals. */
3613 SET_CURSTASH(PL_defstash);
3614 CopSTASH_set(&PL_compiling, PL_defstash);
3615 PL_debstash = GvHV(gv_fetchpvs("DB::", GV_ADDMULTI, SVt_PVHV));
3616 PL_globalstash = GvHV(gv_fetchpvs("CORE::GLOBAL::", GV_ADDMULTI,
3618 /* We must init $/ before switches are processed. */
3619 sv_setpvs(get_sv("/", GV_ADD), "\n");
3623 S_open_script(pTHX_ const char *scriptname, bool dosearch, bool *suidscript)
3626 PerlIO *rsfp = NULL;
3629 PERL_ARGS_ASSERT_OPEN_SCRIPT;
3632 PL_origfilename = savepvs("-e");
3635 /* if find_script() returns, it returns a malloc()-ed value */
3636 scriptname = PL_origfilename = find_script(scriptname, dosearch, NULL, 1);
3638 if (strnEQ(scriptname, "/dev/fd/", 8) && isDIGIT(scriptname[8]) ) {
3639 const char *s = scriptname + 8;
3645 * Tell apart "normal" usage of fdscript, e.g.
3646 * with bash on FreeBSD:
3647 * perl <( echo '#!perl -DA'; echo 'print "$0\n"')
3648 * from usage in suidperl.
3649 * Does any "normal" usage leave garbage after the number???
3650 * Is it a mistake to use a similar /dev/fd/ construct for
3655 * Be supersafe and do some sanity-checks.
3656 * Still, can we be sure we got the right thing?
3659 Perl_croak(aTHX_ "Wrong syntax (suid) fd script name \"%s\"\n", s);
3662 Perl_croak(aTHX_ "Missing (suid) fd script name\n");
3664 scriptname = savepv(s + 1);
3665 Safefree(PL_origfilename);
3666 PL_origfilename = (char *)scriptname;
3671 CopFILE_free(PL_curcop);
3672 CopFILE_set(PL_curcop, PL_origfilename);
3673 if (*PL_origfilename == '-' && PL_origfilename[1] == '\0')
3674 scriptname = (char *)"";
3675 if (fdscript >= 0) {
3676 rsfp = PerlIO_fdopen(fdscript,PERL_SCRIPT_MODE);
3678 else if (!*scriptname) {
3679 forbid_setid(0, *suidscript);
3683 #ifdef FAKE_BIT_BUCKET
3684 /* This hack allows one not to have /dev/null (or BIT_BUCKET as it
3685 * is called) and still have the "-e" work. (Believe it or not,
3686 * a /dev/null is required for the "-e" to work because source
3687 * filter magic is used to implement it. ) This is *not* a general
3688 * replacement for a /dev/null. What we do here is create a temp
3689 * file (an empty file), open up that as the script, and then
3690 * immediately close and unlink it. Close enough for jazz. */
3691 #define FAKE_BIT_BUCKET_PREFIX "/tmp/perlnull-"
3692 #define FAKE_BIT_BUCKET_SUFFIX "XXXXXXXX"
3693 #define FAKE_BIT_BUCKET_TEMPLATE FAKE_BIT_BUCKET_PREFIX FAKE_BIT_BUCKET_SUFFIX
3694 char tmpname[sizeof(FAKE_BIT_BUCKET_TEMPLATE)] = {
3695 FAKE_BIT_BUCKET_TEMPLATE
3697 const char * const err = "Failed to create a fake bit bucket";
3698 if (strEQ(scriptname, BIT_BUCKET)) {
3699 #ifdef HAS_MKSTEMP /* Hopefully mkstemp() is safe here. */
3700 int tmpfd = mkstemp(tmpname);
3702 scriptname = tmpname;
3705 Perl_croak(aTHX_ err);
3708 scriptname = mktemp(tmpname);
3710 Perl_croak(aTHX_ err);
3715 rsfp = PerlIO_open(scriptname,PERL_SCRIPT_MODE);
3716 #ifdef FAKE_BIT_BUCKET
3717 if (memEQ(scriptname, FAKE_BIT_BUCKET_PREFIX,
3718 sizeof(FAKE_BIT_BUCKET_PREFIX) - 1)
3719 && strlen(scriptname) == sizeof(tmpname) - 1) {
3722 scriptname = BIT_BUCKET;
3726 /* PSz 16 Sep 03 Keep neat error message */
3728 Perl_croak(aTHX_ "Can't open "BIT_BUCKET": %s\n", Strerror(errno));
3730 Perl_croak(aTHX_ "Can't open perl script \"%s\": %s\n",
3731 CopFILE(PL_curcop), Strerror(errno));
3733 #if defined(HAS_FCNTL) && defined(F_SETFD)
3734 /* ensure close-on-exec */
3735 fcntl(PerlIO_fileno(rsfp), F_SETFD, 1);
3741 * I_SYSSTATVFS HAS_FSTATVFS
3743 * I_STATFS HAS_FSTATFS HAS_GETFSSTAT
3744 * I_MNTENT HAS_GETMNTENT HAS_HASMNTOPT
3745 * here so that metaconfig picks them up. */
3748 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
3749 /* Don't even need this function. */
3752 S_validate_suid(pTHX_ PerlIO *rsfp)
3754 const UV my_uid = PerlProc_getuid();
3755 const UV my_euid = PerlProc_geteuid();
3756 const UV my_gid = PerlProc_getgid();
3757 const UV my_egid = PerlProc_getegid();
3759 PERL_ARGS_ASSERT_VALIDATE_SUID;
3761 if (my_euid != my_uid || my_egid != my_gid) { /* (suidperl doesn't exist, in fact) */
3764 PerlLIO_fstat(PerlIO_fileno(rsfp),&PL_statbuf); /* may be either wrapped or real suid */
3765 if ((my_euid != my_uid && my_euid == PL_statbuf.st_uid && PL_statbuf.st_mode & S_ISUID)
3767 (my_egid != my_gid && my_egid == PL_statbuf.st_gid && PL_statbuf.st_mode & S_ISGID)
3770 Perl_croak(aTHX_ "YOU HAVEN'T DISABLED SET-ID SCRIPTS IN THE KERNEL YET!\n\
3771 FIX YOUR KERNEL, PUT A C WRAPPER AROUND THIS SCRIPT, OR USE -u AND UNDUMP!\n");
3772 /* not set-id, must be wrapped */
3775 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
3778 S_find_beginning(pTHX_ SV* linestr_sv, PerlIO *rsfp)
3782 register const char *s2;
3784 PERL_ARGS_ASSERT_FIND_BEGINNING;
3786 /* skip forward in input to the real script? */
3789 if ((s = sv_gets(linestr_sv, rsfp, 0)) == NULL)
3790 Perl_croak(aTHX_ "No Perl script found in input\n");
3792 } while (!(*s == '#' && s[1] == '!' && ((s = instr(s,"perl")) || (s = instr(s2,"PERL")))));
3793 PerlIO_ungetc(rsfp, '\n'); /* to keep line count right */
3794 while (*s && !(isSPACE (*s) || *s == '#')) s++;
3796 while (*s == ' ' || *s == '\t') s++;
3798 while (isDIGIT(s2[-1]) || s2[-1] == '-' || s2[-1] == '.'
3799 || s2[-1] == '_') s2--;
3800 if (strnEQ(s2-4,"perl",4))
3801 while ((s = moreswitches(s)))
3811 const UV my_uid = PerlProc_getuid();
3812 const UV my_euid = PerlProc_geteuid();
3813 const UV my_gid = PerlProc_getgid();
3814 const UV my_egid = PerlProc_getegid();
3816 /* Should not happen: */
3817 CHECK_MALLOC_TAINT(my_uid && (my_euid != my_uid || my_egid != my_gid));
3818 PL_tainting |= (my_uid && (my_euid != my_uid || my_egid != my_gid));
3821 * Should go by suidscript, not uid!=euid: why disallow
3822 * system("ls") in scripts run from setuid things?
3823 * Or, is this run before we check arguments and set suidscript?
3824 * What about SETUID_SCRIPTS_ARE_SECURE_NOW: could we use fdscript then?
3825 * (We never have suidscript, can we be sure to have fdscript?)
3826 * Or must then go by UID checks? See comments in forbid_setid also.
3830 /* This is used very early in the lifetime of the program,
3831 * before even the options are parsed, so PL_tainting has
3832 * not been initialized properly. */
3834 Perl_doing_taint(int argc, char *argv[], char *envp[])
3836 #ifndef PERL_IMPLICIT_SYS
3837 /* If we have PERL_IMPLICIT_SYS we can't call getuid() et alia
3838 * before we have an interpreter-- and the whole point of this
3839 * function is to be called at such an early stage. If you are on
3840 * a system with PERL_IMPLICIT_SYS but you do have a concept of
3841 * "tainted because running with altered effective ids', you'll
3842 * have to add your own checks somewhere in here. The two most
3843 * known samples of 'implicitness' are Win32 and NetWare, neither
3844 * of which has much of concept of 'uids'. */
3845 int uid = PerlProc_getuid();
3846 int euid = PerlProc_geteuid();
3847 int gid = PerlProc_getgid();
3848 int egid = PerlProc_getegid();
3855 if (uid && (euid != uid || egid != gid))
3857 #endif /* !PERL_IMPLICIT_SYS */
3858 /* This is a really primitive check; environment gets ignored only
3859 * if -T are the first chars together; otherwise one gets
3860 * "Too late" message. */
3861 if ( argc > 1 && argv[1][0] == '-'
3862 && (argv[1][1] == 't' || argv[1][1] == 'T') )
3867 /* Passing the flag as a single char rather than a string is a slight space
3868 optimisation. The only message that isn't /^-.$/ is
3869 "program input from stdin", which is substituted in place of '\0', which
3870 could never be a command line flag. */
3872 S_forbid_setid(pTHX_ const char flag, const bool suidscript) /* g */
3875 char string[3] = "-x";
3876 const char *message = "program input from stdin";
3883 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
3884 if (PerlProc_getuid() != PerlProc_geteuid())
3885 Perl_croak(aTHX_ "No %s allowed while running setuid", message);
3886 if (PerlProc_getgid() != PerlProc_getegid())
3887 Perl_croak(aTHX_ "No %s allowed while running setgid", message);
3888 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
3890 Perl_croak(aTHX_ "No %s allowed with (suid) fdscript", message);
3894 Perl_init_dbargs(pTHX)
3896 AV *const args = PL_dbargs = GvAV(gv_AVadd((gv_fetchpvs("DB::args",
3901 /* Someone has already created it.
3902 It might have entries, and if we just turn off AvREAL(), they will
3903 "leak" until global destruction. */
3905 if (SvTIED_mg((const SV *)args, PERL_MAGIC_tied))
3906 Perl_croak(aTHX_ "Cannot set tied @DB::args");
3908 AvREIFY_only(PL_dbargs);
3912 Perl_init_debugger(pTHX)
3915 HV * const ostash = PL_curstash;
3917 PL_curstash = (HV *)SvREFCNT_inc_simple(PL_debstash);
3919 Perl_init_dbargs(aTHX);
3920 PL_DBgv = gv_fetchpvs("DB::DB", GV_ADDMULTI, SVt_PVGV);
3921 PL_DBline = gv_fetchpvs("DB::dbline", GV_ADDMULTI, SVt_PVAV);
3922 PL_DBsub = gv_HVadd(gv_fetchpvs("DB::sub", GV_ADDMULTI, SVt_PVHV));
3923 PL_DBsingle = GvSV((gv_fetchpvs("DB::single", GV_ADDMULTI, SVt_PV)));
3924 if (!SvIOK(PL_DBsingle))
3925 sv_setiv(PL_DBsingle, 0);
3926 PL_DBtrace = GvSV((gv_fetchpvs("DB::trace", GV_ADDMULTI, SVt_PV)));
3927 if (!SvIOK(PL_DBtrace))
3928 sv_setiv(PL_DBtrace, 0);
3929 PL_DBsignal = GvSV((gv_fetchpvs("DB::signal", GV_ADDMULTI, SVt_PV)));
3930 if (!SvIOK(PL_DBsignal))
3931 sv_setiv(PL_DBsignal, 0);
3932 SvREFCNT_dec(PL_curstash);
3933 PL_curstash = ostash;
3936 #ifndef STRESS_REALLOC
3937 #define REASONABLE(size) (size)
3939 #define REASONABLE(size) (1) /* unreasonable */
3943 Perl_init_stacks(pTHX)
3946 /* start with 128-item stack and 8K cxstack */
3947 PL_curstackinfo = new_stackinfo(REASONABLE(128),
3948 REASONABLE(8192/sizeof(PERL_CONTEXT) - 1));
3949 PL_curstackinfo->si_type = PERLSI_MAIN;
3950 PL_curstack = PL_curstackinfo->si_stack;
3951 PL_mainstack = PL_curstack; /* remember in case we switch stacks */
3953 PL_stack_base = AvARRAY(PL_curstack);
3954 PL_stack_sp = PL_stack_base;
3955 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
3957 Newx(PL_tmps_stack,REASONABLE(128),SV*);
3960 PL_tmps_max = REASONABLE(128);
3962 Newx(PL_markstack,REASONABLE(32),I32);
3963 PL_markstack_ptr = PL_markstack;
3964 PL_markstack_max = PL_markstack + REASONABLE(32);
3968 Newx(PL_scopestack,REASONABLE(32),I32);
3970 Newx(PL_scopestack_name,REASONABLE(32),const char*);
3972 PL_scopestack_ix = 0;
3973 PL_scopestack_max = REASONABLE(32);
3975 Newx(PL_savestack,REASONABLE(128),ANY);
3976 PL_savestack_ix = 0;
3977 PL_savestack_max = REASONABLE(128);
3986 while (PL_curstackinfo->si_next)
3987 PL_curstackinfo = PL_curstackinfo->si_next;
3988 while (PL_curstackinfo) {
3989 PERL_SI *p = PL_curstackinfo->si_prev;
3990 /* curstackinfo->si_stack got nuked by sv_free_arenas() */
3991 Safefree(PL_curstackinfo->si_cxstack);
3992 Safefree(PL_curstackinfo);
3993 PL_curstackinfo = p;
3995 Safefree(PL_tmps_stack);
3996 Safefree(PL_markstack);
3997 Safefree(PL_scopestack);
3999 Safefree(PL_scopestack_name);
4001 Safefree(PL_savestack);
4005 Perl_populate_isa(pTHX_ const char *name, STRLEN len, ...)
4007 GV *const gv = gv_fetchpvn(name, len, GV_ADD | GV_ADDMULTI, SVt_PVAV);
4008 AV *const isa = GvAVn(gv);
4011 PERL_ARGS_ASSERT_POPULATE_ISA;
4013 if(AvFILLp(isa) != -1)
4016 /* NOTE: No support for tied ISA */
4018 va_start(args, len);
4020 const char *const parent = va_arg(args, const char*);
4025 parent_len = va_arg(args, size_t);
4027 /* Arguments are supplied with a trailing :: */
4028 assert(parent_len > 2);
4029 assert(parent[parent_len - 1] == ':');
4030 assert(parent[parent_len - 2] == ':');
4031 av_push(isa, newSVpvn(parent, parent_len - 2));
4032 (void) gv_fetchpvn(parent, parent_len, GV_ADD, SVt_PVGV);
4039 S_init_predump_symbols(pTHX)
4045 sv_setpvs(get_sv("\"", GV_ADD), " ");
4046 PL_ofsgv = (GV*)SvREFCNT_inc(gv_fetchpvs(",", GV_ADD|GV_NOTQUAL, SVt_PV));
4049 /* Historically, PVIOs were blessed into IO::Handle, unless
4050 FileHandle was loaded, in which case they were blessed into
4051 that. Action at a distance.
4052 However, if we simply bless into IO::Handle, we break code
4053 that assumes that PVIOs will have (among others) a seek
4054 method. IO::File inherits from IO::Handle and IO::Seekable,
4055 and provides the needed methods. But if we simply bless into
4056 it, then we break code that assumed that by loading
4057 IO::Handle, *it* would work.
4058 So a compromise is to set up the correct @IO::File::ISA,
4059 so that code that does C<use IO::Handle>; will still work.
4062 Perl_populate_isa(aTHX_ STR_WITH_LEN("IO::File::ISA"),
4063 STR_WITH_LEN("IO::Handle::"),
4064 STR_WITH_LEN("IO::Seekable::"),
4065 STR_WITH_LEN("Exporter::"),
4068 PL_stdingv = gv_fetchpvs("STDIN", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4069 GvMULTI_on(PL_stdingv);
4070 io = GvIOp(PL_stdingv);
4071 IoTYPE(io) = IoTYPE_RDONLY;
4072 IoIFP(io) = PerlIO_stdin();
4073 tmpgv = gv_fetchpvs("stdin", GV_ADD|GV_NOTQUAL, SVt_PV);
4075 GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4077 tmpgv = gv_fetchpvs("STDOUT", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4080 IoTYPE(io) = IoTYPE_WRONLY;
4081 IoOFP(io) = IoIFP(io) = PerlIO_stdout();
4083 tmpgv = gv_fetchpvs("stdout", GV_ADD|GV_NOTQUAL, SVt_PV);
4085 GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4087 PL_stderrgv = gv_fetchpvs("STDERR", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4088 GvMULTI_on(PL_stderrgv);
4089 io = GvIOp(PL_stderrgv);
4090 IoTYPE(io) = IoTYPE_WRONLY;
4091 IoOFP(io) = IoIFP(io) = PerlIO_stderr();
4092 tmpgv = gv_fetchpvs("stderr", GV_ADD|GV_NOTQUAL, SVt_PV);
4094 GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4096 PL_statname = newSVpvs(""); /* last filename we did stat on */
4100 Perl_init_argv_symbols(pTHX_ register int argc, register char **argv)
4104 PERL_ARGS_ASSERT_INIT_ARGV_SYMBOLS;
4106 argc--,argv++; /* skip name of script */
4107 if (PL_doswitches) {
4108 for (; argc > 0 && **argv == '-'; argc--,argv++) {
4112 if (argv[0][1] == '-' && !argv[0][2]) {
4116 if ((s = strchr(argv[0], '='))) {
4117 const char *const start_name = argv[0] + 1;
4118 sv_setpv(GvSV(gv_fetchpvn_flags(start_name, s - start_name,
4119 TRUE, SVt_PV)), s + 1);
4122 sv_setiv(GvSV(gv_fetchpv(argv[0]+1, GV_ADD, SVt_PV)),1);
4125 if ((PL_argvgv = gv_fetchpvs("ARGV", GV_ADD|GV_NOTQUAL, SVt_PVAV))) {
4126 GvMULTI_on(PL_argvgv);
4127 (void)gv_AVadd(PL_argvgv);
4128 av_clear(GvAVn(PL_argvgv));
4129 for (; argc > 0; argc--,argv++) {
4130 SV * const sv = newSVpv(argv[0],0);
4131 av_push(GvAVn(PL_argvgv),sv);
4132 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
4133 if (PL_unicode & PERL_UNICODE_ARGV_FLAG)
4136 if (PL_unicode & PERL_UNICODE_WIDESYSCALLS_FLAG) /* Sarathy? */
4137 (void)sv_utf8_decode(sv);
4143 S_init_postdump_symbols(pTHX_ register int argc, register char **argv, register char **env)
4148 PERL_ARGS_ASSERT_INIT_POSTDUMP_SYMBOLS;
4150 PL_toptarget = newSV_type(SVt_PVFM);
4151 sv_setpvs(PL_toptarget, "");
4152 PL_bodytarget = newSV_type(SVt_PVFM);
4153 sv_setpvs(PL_bodytarget, "");
4154 PL_formtarget = PL_bodytarget;
4158 init_argv_symbols(argc,argv);
4160 if ((tmpgv = gv_fetchpvs("0", GV_ADD|GV_NOTQUAL, SVt_PV))) {
4161 sv_setpv(GvSV(tmpgv),PL_origfilename);
4163 if ((PL_envgv = gv_fetchpvs("ENV", GV_ADD|GV_NOTQUAL, SVt_PVHV))) {
4165 bool env_is_not_environ;
4166 GvMULTI_on(PL_envgv);
4167 hv = GvHVn(PL_envgv);
4168 hv_magic(hv, NULL, PERL_MAGIC_env);
4170 #ifdef USE_ENVIRON_ARRAY
4171 /* Note that if the supplied env parameter is actually a copy
4172 of the global environ then it may now point to free'd memory
4173 if the environment has been modified since. To avoid this
4174 problem we treat env==NULL as meaning 'use the default'
4178 env_is_not_environ = env != environ;
4179 if (env_is_not_environ
4180 # ifdef USE_ITHREADS
4181 && PL_curinterp == aTHX
4190 for (; *env; env++) {
4193 if (!(s = strchr(old_var,'=')) || s == old_var)
4196 #if defined(MSDOS) && !defined(DJGPP)
4198 (void)strupr(old_var);
4201 sv = newSVpv(s+1, 0);
4202 (void)hv_store(hv, old_var, s - old_var, sv, 0);
4203 if (env_is_not_environ)
4207 #endif /* USE_ENVIRON_ARRAY */
4208 #endif /* !PERL_MICRO */
4212 /* touch @F array to prevent spurious warnings 20020415 MJD */
4214 (void) get_av("main::F", GV_ADD | GV_ADDMULTI);
4219 S_init_perllib(pTHX)
4223 const char *perl5lib = NULL;
4226 #if defined(WIN32) && !defined(PERL_IS_MINIPERL)
4232 perl5lib = PerlEnv_getenv("PERL5LIB");
4234 * It isn't possible to delete an environment variable with
4235 * PERL_USE_SAFE_PUTENV set unless unsetenv() is also available, so in that
4236 * case we treat PERL5LIB as undefined if it has a zero-length value.
4238 #if defined(PERL_USE_SAFE_PUTENV) && ! defined(HAS_UNSETENV)
4239 if (perl5lib && *perl5lib != '\0')
4243 incpush_use_sep(perl5lib, 0, INCPUSH_ADD_SUB_DIRS);
4245 s = PerlEnv_getenv("PERLLIB");
4247 incpush_use_sep(s, 0, 0);
4250 /* Treat PERL5?LIB as a possible search list logical name -- the
4251 * "natural" VMS idiom for a Unix path string. We allow each
4252 * element to be a set of |-separated directories for compatibility.
4256 if (my_trnlnm("PERL5LIB",buf,0))
4258 incpush_use_sep(buf, 0, INCPUSH_ADD_SUB_DIRS);
4259 } while (my_trnlnm("PERL5LIB",buf,++idx));
4261 while (my_trnlnm("PERLLIB",buf,idx++))
4262 incpush_use_sep(buf, 0, 0);
4267 #ifndef PERL_IS_MINIPERL
4268 /* miniperl gets just -I..., the split of $ENV{PERL5LIB}, and "." in @INC
4269 (and not the architecture specific directories from $ENV{PERL5LIB}) */
4271 /* Use the ~-expanded versions of APPLLIB (undocumented),
4272 SITEARCH, SITELIB, VENDORARCH, VENDORLIB, ARCHLIB and PRIVLIB
4275 S_incpush_use_sep(aTHX_ STR_WITH_LEN(APPLLIB_EXP),
4276 INCPUSH_ADD_SUB_DIRS|INCPUSH_CAN_RELOCATE);
4280 /* sitearch is always relative to sitelib on Windows for
4281 * DLL-based path intuition to work correctly */
4282 # if !defined(WIN32)
4283 S_incpush_use_sep(aTHX_ STR_WITH_LEN(SITEARCH_EXP),
4284 INCPUSH_CAN_RELOCATE);
4290 /* this picks up sitearch as well */
4291 s = win32_get_sitelib(PERL_FS_VERSION, &len);
4293 incpush_use_sep(s, len, INCPUSH_ADD_SUB_DIRS|INCPUSH_CAN_RELOCATE);
4295 S_incpush_use_sep(aTHX_ STR_WITH_LEN(SITELIB_EXP), INCPUSH_CAN_RELOCATE);
4299 #ifdef PERL_VENDORARCH_EXP
4300 /* vendorarch is always relative to vendorlib on Windows for
4301 * DLL-based path intuition to work correctly */
4302 # if !defined(WIN32)
4303 S_incpush_use_sep(aTHX_ STR_WITH_LEN(PERL_VENDORARCH_EXP),
4304 INCPUSH_CAN_RELOCATE);
4308 #ifdef PERL_VENDORLIB_EXP
4310 /* this picks up vendorarch as well */
4311 s = win32_get_vendorlib(PERL_FS_VERSION, &len);
4313 incpush_use_sep(s, len, INCPUSH_ADD_SUB_DIRS|INCPUSH_CAN_RELOCATE);
4315 S_incpush_use_sep(aTHX_ STR_WITH_LEN(PERL_VENDORLIB_EXP),
4316 INCPUSH_CAN_RELOCATE);
4321 S_incpush_use_sep(aTHX_ STR_WITH_LEN(ARCHLIB_EXP), INCPUSH_CAN_RELOCATE);
4325 # define PRIVLIB_EXP "/usr/local/lib/perl5:/usr/local/lib/perl"
4329 s = win32_get_privlib(PERL_FS_VERSION, &len);
4331 incpush_use_sep(s, len, INCPUSH_ADD_SUB_DIRS|INCPUSH_CAN_RELOCATE);
4334 S_incpush_use_sep(aTHX_ PRIVLIB_EXP, 0, INCPUSH_CAN_RELOCATE);
4336 S_incpush_use_sep(aTHX_ STR_WITH_LEN(PRIVLIB_EXP), INCPUSH_CAN_RELOCATE);
4340 #ifdef PERL_OTHERLIBDIRS
4341 S_incpush_use_sep(aTHX_ STR_WITH_LEN(PERL_OTHERLIBDIRS),
4342 INCPUSH_ADD_VERSIONED_SUB_DIRS|INCPUSH_NOT_BASEDIR
4343 |INCPUSH_CAN_RELOCATE);
4349 * It isn't possible to delete an environment variable with
4350 * PERL_USE_SAFE_PUTENV set unless unsetenv() is also available, so in that
4351 * case we treat PERL5LIB as undefined if it has a zero-length value.
4353 #if defined(PERL_USE_SAFE_PUTENV) && ! defined(HAS_UNSETENV)
4354 if (perl5lib && *perl5lib != '\0')
4358 incpush_use_sep(perl5lib, 0,
4359 INCPUSH_ADD_OLD_VERS|INCPUSH_NOT_BASEDIR);
4361 /* Treat PERL5?LIB as a possible search list logical name -- the
4362 * "natural" VMS idiom for a Unix path string. We allow each
4363 * element to be a set of |-separated directories for compatibility.
4367 if (my_trnlnm("PERL5LIB",buf,0))
4369 incpush_use_sep(buf, 0,
4370 INCPUSH_ADD_OLD_VERS|INCPUSH_NOT_BASEDIR);
4371 } while (my_trnlnm("PERL5LIB",buf,++idx));
4375 /* Use the ~-expanded versions of APPLLIB (undocumented),
4376 SITELIB and VENDORLIB for older versions
4379 S_incpush_use_sep(aTHX_ STR_WITH_LEN(APPLLIB_EXP), INCPUSH_ADD_OLD_VERS
4380 |INCPUSH_NOT_BASEDIR|INCPUSH_CAN_RELOCATE);
4383 #if defined(SITELIB_STEM) && defined(PERL_INC_VERSION_LIST)
4384 /* Search for version-specific dirs below here */
4385 S_incpush_use_sep(aTHX_ STR_WITH_LEN(SITELIB_STEM),
4386 INCPUSH_ADD_OLD_VERS|INCPUSH_CAN_RELOCATE);
4390 #if defined(PERL_VENDORLIB_STEM) && defined(PERL_INC_VERSION_LIST)
4391 /* Search for version-specific dirs below here */
4392 S_incpush_use_sep(aTHX_ STR_WITH_LEN(PERL_VENDORLIB_STEM),
4393 INCPUSH_ADD_OLD_VERS|INCPUSH_CAN_RELOCATE);
4396 #ifdef PERL_OTHERLIBDIRS
4397 S_incpush_use_sep(aTHX_ STR_WITH_LEN(PERL_OTHERLIBDIRS),
4398 INCPUSH_ADD_OLD_VERS|INCPUSH_ADD_ARCHONLY_SUB_DIRS
4399 |INCPUSH_CAN_RELOCATE);
4401 #endif /* !PERL_IS_MINIPERL */
4404 S_incpush(aTHX_ STR_WITH_LEN("."), 0);
4407 #if defined(DOSISH) || defined(EPOC) || defined(__SYMBIAN32__)
4408 # define PERLLIB_SEP ';'
4411 # define PERLLIB_SEP '|'
4413 # define PERLLIB_SEP ':'
4416 #ifndef PERLLIB_MANGLE
4417 # define PERLLIB_MANGLE(s,n) (s)
4420 #ifndef PERL_IS_MINIPERL
4421 /* Push a directory onto @INC if it exists.
4422 Generate a new SV if we do this, to save needing to copy the SV we push
4425 S_incpush_if_exists(pTHX_ AV *const av, SV *dir, SV *const stem)
4430 PERL_ARGS_ASSERT_INCPUSH_IF_EXISTS;
4432 if (PerlLIO_stat(SvPVX_const(dir), &tmpstatbuf) >= 0 &&
4433 S_ISDIR(tmpstatbuf.st_mode)) {
4435 dir = newSVsv(stem);
4437 /* Truncate dir back to stem. */
4438 SvCUR_set(dir, SvCUR(stem));
4445 S_mayberelocate(pTHX_ const char *const dir, STRLEN len, U32 flags)
4447 const U8 canrelocate = (U8)flags & INCPUSH_CAN_RELOCATE;
4450 PERL_ARGS_ASSERT_MAYBERELOCATE;
4454 /* I am not convinced that this is valid when PERLLIB_MANGLE is
4455 defined to so something (in os2/os2.c), but the code has been
4456 this way, ignoring any possible changed of length, since
4457 760ac839baf413929cd31cc32ffd6dba6b781a81 (5.003_02) so I'll leave
4459 libdir = newSVpvn(PERLLIB_MANGLE(dir, len), len);
4461 libdir = newSVpv(PERLLIB_MANGLE(dir, 0), 0);
4468 if ((unix = tounixspec_ts(SvPV(libdir,len),NULL)) != NULL) {
4470 while (unix[len-1] == '/') len--; /* Cosmetic */
4471 sv_usepvn(libdir,unix,len);
4474 PerlIO_printf(Perl_error_log,
4475 "Failed to unixify @INC element \"%s\"\n",
4476 SvPV_nolen_const(libdir));
4480 /* Do the if() outside the #ifdef to avoid warnings about an unused
4483 #ifdef PERL_RELOCATABLE_INC
4485 * Relocatable include entries are marked with a leading .../
4488 * 0: Remove that leading ".../"
4489 * 1: Remove trailing executable name (anything after the last '/')
4490 * from the perl path to give a perl prefix
4492 * While the @INC element starts "../" and the prefix ends with a real
4493 * directory (ie not . or ..) chop that real directory off the prefix
4494 * and the leading "../" from the @INC element. ie a logical "../"
4496 * Finally concatenate the prefix and the remainder of the @INC element
4497 * The intent is that /usr/local/bin/perl and .../../lib/perl5
4498 * generates /usr/local/lib/perl5
4500 const char *libpath = SvPVX(libdir);
4501 STRLEN libpath_len = SvCUR(libdir);
4502 if (libpath_len >= 4 && memEQ (libpath, ".../", 4)) {
4504 SV * const caret_X = get_sv("\030", 0);
4505 /* Going to use the SV just as a scratch buffer holding a C
4511 /* $^X is *the* source of taint if tainting is on, hence
4512 SvPOK() won't be true. */
4514 assert(SvPOKp(caret_X));
4515 prefix_sv = newSVpvn_flags(SvPVX(caret_X), SvCUR(caret_X),
4517 /* Firstly take off the leading .../
4518 If all else fail we'll do the paths relative to the current
4520 sv_chop(libdir, libpath + 4);
4521 /* Don't use SvPV as we're intentionally bypassing taining,
4522 mortal copies that the mg_get of tainting creates, and
4523 corruption that seems to come via the save stack.
4524 I guess that the save stack isn't correctly set up yet. */
4525 libpath = SvPVX(libdir);
4526 libpath_len = SvCUR(libdir);
4528 /* This would work more efficiently with memrchr, but as it's
4529 only a GNU extension we'd need to probe for it and
4530 implement our own. Not hard, but maybe not worth it? */
4532 prefix = SvPVX(prefix_sv);
4533 lastslash = strrchr(prefix, '/');
4535 /* First time in with the *lastslash = '\0' we just wipe off
4536 the trailing /perl from (say) /usr/foo/bin/perl
4540 while ((*lastslash = '\0'), /* Do that, come what may. */
4541 (libpath_len >= 3 && memEQ(libpath, "../", 3)
4542 && (lastslash = strrchr(prefix, '/')))) {
4543 if (lastslash[1] == '\0'
4544 || (lastslash[1] == '.'
4545 && (lastslash[2] == '/' /* ends "/." */
4546 || (lastslash[2] == '/'
4547 && lastslash[3] == '/' /* or "/.." */
4549 /* Prefix ends "/" or "/." or "/..", any of which
4550 are fishy, so don't do any more logical cleanup.
4554 /* Remove leading "../" from path */
4557 /* Next iteration round the loop removes the last
4558 directory name from prefix by writing a '\0' in
4559 the while clause. */
4561 /* prefix has been terminated with a '\0' to the correct
4562 length. libpath points somewhere into the libdir SV.
4563 We need to join the 2 with '/' and drop the result into
4565 tempsv = Perl_newSVpvf(aTHX_ "%s/%s", prefix, libpath);
4566 SvREFCNT_dec(libdir);
4567 /* And this is the new libdir. */
4570 (PerlProc_getuid() != PerlProc_geteuid() ||
4571 PerlProc_getgid() != PerlProc_getegid())) {
4572 /* Need to taint relocated paths if running set ID */
4573 SvTAINTED_on(libdir);
4576 SvREFCNT_dec(prefix_sv);
4584 S_incpush(pTHX_ const char *const dir, STRLEN len, U32 flags)
4587 #ifndef PERL_IS_MINIPERL
4588 const U8 using_sub_dirs
4589 = (U8)flags & (INCPUSH_ADD_VERSIONED_SUB_DIRS
4590 |INCPUSH_ADD_ARCHONLY_SUB_DIRS|INCPUSH_ADD_OLD_VERS);
4591 const U8 add_versioned_sub_dirs
4592 = (U8)flags & INCPUSH_ADD_VERSIONED_SUB_DIRS;
4593 const U8 add_archonly_sub_dirs
4594 = (U8)flags & INCPUSH_ADD_ARCHONLY_SUB_DIRS;
4595 #ifdef PERL_INC_VERSION_LIST
4596 const U8 addoldvers = (U8)flags & INCPUSH_ADD_OLD_VERS;
4599 const U8 unshift = (U8)flags & INCPUSH_UNSHIFT;
4600 const U8 push_basedir = (flags & INCPUSH_NOT_BASEDIR) ? 0 : 1;
4601 AV *const inc = GvAVn(PL_incgv);
4603 PERL_ARGS_ASSERT_INCPUSH;
4606 /* Could remove this vestigial extra block, if we don't mind a lot of
4607 re-indenting diff noise. */
4609 SV *const libdir = mayberelocate(dir, len, flags);
4610 /* Change 20189146be79a0596543441fa369c6bf7f85103f, to fix RT#6665,
4611 arranged to unshift #! line -I onto the front of @INC. However,
4612 -I can add version and architecture specific libraries, and they
4613 need to go first. The old code assumed that it was always
4614 pushing. Hence to make it work, need to push the architecture
4615 (etc) libraries onto a temporary array, then "unshift" that onto
4616 the front of @INC. */
4617 #ifndef PERL_IS_MINIPERL
4618 AV *const av = (using_sub_dirs) ? (unshift ? newAV() : inc) : NULL;
4621 * BEFORE pushing libdir onto @INC we may first push version- and
4622 * archname-specific sub-directories.
4624 if (using_sub_dirs) {
4625 SV *subdir = newSVsv(libdir);
4626 #ifdef PERL_INC_VERSION_LIST
4627 /* Configure terminates PERL_INC_VERSION_LIST with a NULL */
4628 const char * const incverlist[] = { PERL_INC_VERSION_LIST };
4629 const char * const *incver;
4632 if (add_versioned_sub_dirs) {
4633 /* .../version/archname if -d .../version/archname */
4634 sv_catpvs(subdir, "/" PERL_FS_VERSION "/" ARCHNAME);
4635 subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
4637 /* .../version if -d .../version */
4638 sv_catpvs(subdir, "/" PERL_FS_VERSION);
4639 subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
4642 #ifdef PERL_INC_VERSION_LIST
4644 for (incver = incverlist; *incver; incver++) {
4645 /* .../xxx if -d .../xxx */
4646 Perl_sv_catpvf(aTHX_ subdir, "/%s", *incver);
4647 subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
4652 if (add_archonly_sub_dirs) {
4653 /* .../archname if -d .../archname */
4654 sv_catpvs(subdir, "/" ARCHNAME);
4655 subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
4659 assert (SvREFCNT(subdir) == 1);
4660 SvREFCNT_dec(subdir);
4662 #endif /* !PERL_IS_MINIPERL */
4663 /* finally add this lib directory at the end of @INC */
4665 #ifdef PERL_IS_MINIPERL
4666 const U32 extra = 0;
4668 U32 extra = av_len(av) + 1;
4670 av_unshift(inc, extra + push_basedir);
4672 av_store(inc, extra, libdir);
4673 #ifndef PERL_IS_MINIPERL
4675 /* av owns a reference, av_store() expects to be donated a
4676 reference, and av expects to be sane when it's cleared.
4677 If I wanted to be naughty and wrong, I could peek inside the
4678 implementation of av_clear(), realise that it uses
4679 SvREFCNT_dec() too, so av's array could be a run of NULLs,
4680 and so directly steal from it (with a memcpy() to inc, and
4681 then memset() to NULL them out. But people copy code from the
4682 core expecting it to be best practise, so let's use the API.
4683 Although studious readers will note that I'm not checking any
4685 av_store(inc, extra, SvREFCNT_inc(*av_fetch(av, extra, FALSE)));
4690 else if (push_basedir) {
4691 av_push(inc, libdir);
4694 if (!push_basedir) {
4695 assert (SvREFCNT(libdir) == 1);
4696 SvREFCNT_dec(libdir);
4702 S_incpush_use_sep(pTHX_ const char *p, STRLEN len, U32 flags)
4706 /* This logic has been broken out from S_incpush(). It may be possible to
4709 PERL_ARGS_ASSERT_INCPUSH_USE_SEP;
4711 /* perl compiled with -DPERL_RELOCATABLE_INCPUSH will ignore the len
4712 * argument to incpush_use_sep. This allows creation of relocatable
4713 * Perl distributions that patch the binary at install time. Those
4714 * distributions will have to provide their own relocation tools; this
4715 * is not a feature otherwise supported by core Perl.
4717 #ifndef PERL_RELOCATABLE_INCPUSH
4724 /* Break at all separators */
4725 while ((s = (const char*)memchr(p, PERLLIB_SEP, end - p))) {
4727 /* skip any consecutive separators */
4729 /* Uncomment the next line for PATH semantics */
4730 /* But you'll need to write tests */
4731 /* av_push(GvAVn(PL_incgv), newSVpvs(".")); */
4733 incpush(p, (STRLEN)(s - p), flags);
4738 incpush(p, (STRLEN)(end - p), flags);
4743 Perl_call_list(pTHX_ I32 oldscope, AV *paramList)
4747 volatile const line_t oldline = PL_curcop ? CopLINE(PL_curcop) : 0;
4753 PERL_ARGS_ASSERT_CALL_LIST;
4755 while (av_len(paramList) >= 0) {
4756 cv = MUTABLE_CV(av_shift(paramList));
4758 if (paramList == PL_beginav) {
4759 /* save PL_beginav for compiler */
4760 Perl_av_create_and_push(aTHX_ &PL_beginav_save, MUTABLE_SV(cv));
4762 else if (paramList == PL_checkav) {
4763 /* save PL_checkav for compiler */
4764 Perl_av_create_and_push(aTHX_ &PL_checkav_save, MUTABLE_SV(cv));
4766 else if (paramList == PL_unitcheckav) {
4767 /* save PL_unitcheckav for compiler */
4768 Perl_av_create_and_push(aTHX_ &PL_unitcheckav_save, MUTABLE_SV(cv));
4779 PL_madskills |= 16384;
4784 PL_madskills &= ~16384;
4787 (void)SvPV_const(atsv, len);
4789 PL_curcop = &PL_compiling;
4790 CopLINE_set(PL_curcop, oldline);
4791 if (paramList == PL_beginav)
4792 sv_catpvs(atsv, "BEGIN failed--compilation aborted");
4794 Perl_sv_catpvf(aTHX_ atsv,
4795 "%s failed--call queue aborted",
4796 paramList == PL_checkav ? "CHECK"
4797 : paramList == PL_initav ? "INIT"
4798 : paramList == PL_unitcheckav ? "UNITCHECK"
4800 while (PL_scopestack_ix > oldscope)
4803 Perl_croak(aTHX_ "%"SVf"", SVfARG(atsv));
4810 /* my_exit() was called */
4811 while (PL_scopestack_ix > oldscope)
4814 SET_CURSTASH(PL_defstash);
4815 PL_curcop = &PL_compiling;
4816 CopLINE_set(PL_curcop, oldline);
4822 PL_curcop = &PL_compiling;
4823 CopLINE_set(PL_curcop, oldline);
4826 PerlIO_printf(Perl_error_log, "panic: restartop in call_list\n");
4835 Perl_my_exit(pTHX_ U32 status)
4846 STATUS_EXIT_SET(status);
4853 Perl_my_failure_exit(pTHX)
4857 /* We have been called to fall on our sword. The desired exit code
4858 * should be already set in STATUS_UNIX, but could be shifted over
4859 * by 8 bits. STATUS_UNIX_EXIT_SET will handle the cases where a
4862 * If an error code has not been set, then force the issue.
4864 if (MY_POSIX_EXIT) {
4866 /* According to the die_exit.t tests, if errno is non-zero */
4867 /* It should be used for the error status. */
4869 if (errno == EVMSERR) {
4870 STATUS_NATIVE = vaxc$errno;
4873 /* According to die_exit.t tests, if the child_exit code is */
4874 /* also zero, then we need to exit with a code of 255 */
4875 if ((errno != 0) && (errno < 256))
4876 STATUS_UNIX_EXIT_SET(errno);
4877 else if (STATUS_UNIX < 255) {
4878 STATUS_UNIX_EXIT_SET(255);
4883 /* The exit code could have been set by $? or vmsish which
4884 * means that it may not have fatal set. So convert
4885 * success/warning codes to fatal with out changing
4886 * the POSIX status code. The severity makes VMS native
4887 * status handling work, while UNIX mode programs use the
4888 * the POSIX exit codes.
4890 if ((STATUS_NATIVE & (STS$K_SEVERE|STS$K_ERROR)) == 0) {
4891 STATUS_NATIVE &= STS$M_COND_ID;
4892 STATUS_NATIVE |= STS$K_ERROR | STS$M_INHIB_MSG;
4896 /* Traditionally Perl on VMS always expects a Fatal Error. */
4897 if (vaxc$errno & 1) {
4899 /* So force success status to failure */
4900 if (STATUS_NATIVE & 1)
4905 STATUS_UNIX = EINTR; /* In case something cares */
4910 STATUS_NATIVE = vaxc$errno; /* Should already be this */
4912 /* Encode the severity code */
4913 severity = STATUS_NATIVE & STS$M_SEVERITY;
4914 STATUS_UNIX = (severity ? severity : 1) << 8;
4916 /* Perl expects this to be a fatal error */
4917 if (severity != STS$K_SEVERE)
4926 STATUS_UNIX_SET(errno);
4928 exitstatus = STATUS_UNIX >> 8;
4929 if (exitstatus & 255)
4930 STATUS_UNIX_SET(exitstatus);
4932 STATUS_UNIX_SET(255);
4939 S_my_exit_jump(pTHX)
4944 SvREFCNT_dec(PL_e_script);
4948 POPSTACK_TO(PL_mainstack);
4956 read_e_script(pTHX_ int idx, SV *buf_sv, int maxlen)
4959 const char * const p = SvPVX_const(PL_e_script);
4960 const char *nl = strchr(p, '\n');
4962 PERL_UNUSED_ARG(idx);
4963 PERL_UNUSED_ARG(maxlen);
4965 nl = (nl) ? nl+1 : SvEND(PL_e_script);
4967 filter_del(read_e_script);
4970 sv_catpvn(buf_sv, p, nl-p);
4971 sv_chop(PL_e_script, nl);
4977 * c-indentation-style: bsd
4979 * indent-tabs-mode: t
4982 * ex: set ts=8 sts=4 sw=4 noet: