This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
5.26.2 today
[perl5.git] / perl.c
1 #line 2 "perl.c"
2 /*    perl.c
3  *
4  *    Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001
5  *    2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
6  *    2013, 2014, 2015, 2016, 2017, 2018 by Larry Wall and others
7  *
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.
10  *
11  */
12
13 /*
14  *      A ship then new they built for him
15  *      of mithril and of elven-glass
16  *              --from Bilbo's song of EƤrendil
17  *
18  *     [p.236 of _The Lord of the Rings_, II/i: "Many Meetings"]
19  */
20
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
25  *
26  * Note that at build time this file is also linked to as perlmini.c,
27  * and perlmini.o is then built with PERL_IS_MINIPERL defined, which is
28  * then used to create the miniperl executable, rather than perl.o.
29  */
30
31 #if defined(PERL_IS_MINIPERL) && !defined(USE_SITECUSTOMIZE)
32 #  define USE_SITECUSTOMIZE
33 #endif
34
35 #include "EXTERN.h"
36 #define PERL_IN_PERL_C
37 #include "perl.h"
38 #include "patchlevel.h"                 /* for local_patches */
39 #include "XSUB.h"
40
41 #ifdef NETWARE
42 #include "nwutil.h"     
43 #endif
44
45 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
46 #  ifdef I_SYSUIO
47 #    include <sys/uio.h>
48 #  endif
49
50 union control_un {
51   struct cmsghdr cm;
52   char control[CMSG_SPACE(sizeof(int))];
53 };
54
55 #endif
56
57 #ifndef HZ
58 #  ifdef CLK_TCK
59 #    define HZ CLK_TCK
60 #  else
61 #    define HZ 60
62 #  endif
63 #endif
64
65 static I32 read_e_script(pTHX_ int idx, SV *buf_sv, int maxlen);
66
67 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
68 #  define validate_suid(rsfp) NOOP
69 #else
70 #  define validate_suid(rsfp) S_validate_suid(aTHX_ rsfp)
71 #endif
72
73 #define CALL_BODY_SUB(myop) \
74     if (PL_op == (myop)) \
75         PL_op = PL_ppaddr[OP_ENTERSUB](aTHX); \
76     if (PL_op) \
77         CALLRUNOPS(aTHX);
78
79 #define CALL_LIST_BODY(cv) \
80     PUSHMARK(PL_stack_sp); \
81     call_sv(MUTABLE_SV((cv)), G_EVAL|G_DISCARD|G_VOID);
82
83 static void
84 S_init_tls_and_interp(PerlInterpreter *my_perl)
85 {
86     dVAR;
87     if (!PL_curinterp) {                        
88         PERL_SET_INTERP(my_perl);
89 #if defined(USE_ITHREADS)
90         INIT_THREADS;
91         ALLOC_THREAD_KEY;
92         PERL_SET_THX(my_perl);
93         OP_REFCNT_INIT;
94         OP_CHECK_MUTEX_INIT;
95         KEYWORD_PLUGIN_MUTEX_INIT;
96         HINTS_REFCNT_INIT;
97         LOCALE_INIT;
98         MUTEX_INIT(&PL_dollarzero_mutex);
99         MUTEX_INIT(&PL_my_ctx_mutex);
100 #  endif
101     }
102 #if defined(USE_ITHREADS)
103     else
104 #else
105     /* This always happens for non-ithreads  */
106 #endif
107     {
108         PERL_SET_THX(my_perl);
109     }
110 }
111
112
113 /* these implement the PERL_SYS_INIT, PERL_SYS_INIT3, PERL_SYS_TERM macros */
114
115 void
116 Perl_sys_init(int* argc, char*** argv)
117 {
118     dVAR;
119
120     PERL_ARGS_ASSERT_SYS_INIT;
121
122     PERL_UNUSED_ARG(argc); /* may not be used depending on _BODY macro */
123     PERL_UNUSED_ARG(argv);
124     PERL_SYS_INIT_BODY(argc, argv);
125 }
126
127 void
128 Perl_sys_init3(int* argc, char*** argv, char*** env)
129 {
130     dVAR;
131
132     PERL_ARGS_ASSERT_SYS_INIT3;
133
134     PERL_UNUSED_ARG(argc); /* may not be used depending on _BODY macro */
135     PERL_UNUSED_ARG(argv);
136     PERL_UNUSED_ARG(env);
137     PERL_SYS_INIT3_BODY(argc, argv, env);
138 }
139
140 void
141 Perl_sys_term(void)
142 {
143     dVAR;
144     if (!PL_veto_cleanup) {
145         PERL_SYS_TERM_BODY();
146     }
147 }
148
149
150 #ifdef PERL_IMPLICIT_SYS
151 PerlInterpreter *
152 perl_alloc_using(struct IPerlMem* ipM, struct IPerlMem* ipMS,
153                  struct IPerlMem* ipMP, struct IPerlEnv* ipE,
154                  struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
155                  struct IPerlDir* ipD, struct IPerlSock* ipS,
156                  struct IPerlProc* ipP)
157 {
158     PerlInterpreter *my_perl;
159
160     PERL_ARGS_ASSERT_PERL_ALLOC_USING;
161
162     /* Newx() needs interpreter, so call malloc() instead */
163     my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
164     S_init_tls_and_interp(my_perl);
165     Zero(my_perl, 1, PerlInterpreter);
166     PL_Mem = ipM;
167     PL_MemShared = ipMS;
168     PL_MemParse = ipMP;
169     PL_Env = ipE;
170     PL_StdIO = ipStd;
171     PL_LIO = ipLIO;
172     PL_Dir = ipD;
173     PL_Sock = ipS;
174     PL_Proc = ipP;
175     INIT_TRACK_MEMPOOL(PL_memory_debug_header, my_perl);
176
177     return my_perl;
178 }
179 #else
180
181 /*
182 =head1 Embedding Functions
183
184 =for apidoc perl_alloc
185
186 Allocates a new Perl interpreter.  See L<perlembed>.
187
188 =cut
189 */
190
191 PerlInterpreter *
192 perl_alloc(void)
193 {
194     PerlInterpreter *my_perl;
195
196     /* Newx() needs interpreter, so call malloc() instead */
197     my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
198
199     S_init_tls_and_interp(my_perl);
200 #ifndef PERL_TRACK_MEMPOOL
201     return (PerlInterpreter *) ZeroD(my_perl, 1, PerlInterpreter);
202 #else
203     Zero(my_perl, 1, PerlInterpreter);
204     INIT_TRACK_MEMPOOL(PL_memory_debug_header, my_perl);
205     return my_perl;
206 #endif
207 }
208 #endif /* PERL_IMPLICIT_SYS */
209
210 /*
211 =for apidoc perl_construct
212
213 Initializes a new Perl interpreter.  See L<perlembed>.
214
215 =cut
216 */
217
218 static void
219 S_fixup_platform_bugs(void)
220 {
221 #if defined(__GLIBC__) && IVSIZE == 8 \
222     && ( __GLIBC__ < 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ < 8))
223     {
224         IV l =   3;
225         IV r = -10;
226         /* Cannot do this check with inlined IV constants since
227          * that seems to work correctly even with the buggy glibc. */
228         if (l % r == -3) {
229             dTHX;
230             /* Yikes, we have the bug.
231              * Patch in the workaround version. */
232             PL_ppaddr[OP_I_MODULO] = &Perl_pp_i_modulo_glibc_bugfix;
233         }
234     }
235 #endif
236 }
237
238 void
239 perl_construct(pTHXx)
240 {
241     dVAR;
242
243     PERL_ARGS_ASSERT_PERL_CONSTRUCT;
244
245 #ifdef MULTIPLICITY
246     init_interp();
247     PL_perl_destruct_level = 1;
248 #else
249     PERL_UNUSED_ARG(my_perl);
250    if (PL_perl_destruct_level > 0)
251        init_interp();
252 #endif
253     PL_curcop = &PL_compiling;  /* needed by ckWARN, right away */
254
255 #ifdef PERL_TRACE_OPS
256     Zero(PL_op_exec_cnt, OP_max+2, UV);
257 #endif
258
259     init_constants();
260
261     SvREADONLY_on(&PL_sv_placeholder);
262     SvREFCNT(&PL_sv_placeholder) = SvREFCNT_IMMORTAL;
263
264     PL_sighandlerp = (Sighandler_t) Perl_sighandler;
265 #ifdef PERL_USES_PL_PIDSTATUS
266     PL_pidstatus = newHV();
267 #endif
268
269     PL_rs = newSVpvs("\n");
270
271     init_stacks();
272
273 /* The PERL_INTERNAL_RAND_SEED set-up must be after init_stacks because it calls
274  * things that may put SVs on the stack.
275  */
276
277 #ifdef NO_PERL_INTERNAL_RAND_SEED
278     Perl_drand48_init_r(&PL_internal_random_state, seed());
279 #else
280     {
281         UV seed;
282         const char *env_pv;
283         if (PerlProc_getuid() != PerlProc_geteuid() ||
284             PerlProc_getgid() != PerlProc_getegid() ||
285             !(env_pv = PerlEnv_getenv("PERL_INTERNAL_RAND_SEED")) ||
286             grok_number(env_pv, strlen(env_pv), &seed) != IS_NUMBER_IN_UV) {
287             seed = seed();
288         }
289         Perl_drand48_init_r(&PL_internal_random_state, (U32)seed);
290     }
291 #endif
292
293     init_ids();
294
295     S_fixup_platform_bugs();
296
297     JMPENV_BOOTSTRAP;
298     STATUS_ALL_SUCCESS;
299
300     PL_XPosix_ptrs[_CC_ASCII] = _new_invlist_C_array(ASCII_invlist);
301     PL_XPosix_ptrs[_CC_ALPHANUMERIC] = _new_invlist_C_array(XPosixAlnum_invlist);
302     PL_XPosix_ptrs[_CC_ALPHA] = _new_invlist_C_array(XPosixAlpha_invlist);
303     PL_XPosix_ptrs[_CC_BLANK] = _new_invlist_C_array(XPosixBlank_invlist);
304     PL_XPosix_ptrs[_CC_CASED] =  _new_invlist_C_array(Cased_invlist);
305     PL_XPosix_ptrs[_CC_CNTRL] = _new_invlist_C_array(XPosixCntrl_invlist);
306     PL_XPosix_ptrs[_CC_DIGIT] = _new_invlist_C_array(XPosixDigit_invlist);
307     PL_XPosix_ptrs[_CC_GRAPH] = _new_invlist_C_array(XPosixGraph_invlist);
308     PL_XPosix_ptrs[_CC_LOWER] = _new_invlist_C_array(XPosixLower_invlist);
309     PL_XPosix_ptrs[_CC_PRINT] = _new_invlist_C_array(XPosixPrint_invlist);
310     PL_XPosix_ptrs[_CC_PUNCT] = _new_invlist_C_array(XPosixPunct_invlist);
311     PL_XPosix_ptrs[_CC_SPACE] = _new_invlist_C_array(XPerlSpace_invlist);
312     PL_XPosix_ptrs[_CC_UPPER] = _new_invlist_C_array(XPosixUpper_invlist);
313     PL_XPosix_ptrs[_CC_VERTSPACE] = _new_invlist_C_array(VertSpace_invlist);
314     PL_XPosix_ptrs[_CC_WORDCHAR] = _new_invlist_C_array(XPosixWord_invlist);
315     PL_XPosix_ptrs[_CC_XDIGIT] = _new_invlist_C_array(XPosixXDigit_invlist);
316     PL_GCB_invlist = _new_invlist_C_array(_Perl_GCB_invlist);
317     PL_SB_invlist = _new_invlist_C_array(_Perl_SB_invlist);
318     PL_WB_invlist = _new_invlist_C_array(_Perl_WB_invlist);
319     PL_LB_invlist = _new_invlist_C_array(_Perl_LB_invlist);
320     PL_Assigned_invlist = _new_invlist_C_array(Assigned_invlist);
321     PL_SCX_invlist = _new_invlist_C_array(_Perl_SCX_invlist);
322     PL_utf8_toupper = _new_invlist_C_array(Uppercase_Mapping_invlist);
323     PL_utf8_tolower = _new_invlist_C_array(Lowercase_Mapping_invlist);
324     PL_utf8_totitle = _new_invlist_C_array(Titlecase_Mapping_invlist);
325     PL_utf8_tofold = _new_invlist_C_array(Case_Folding_invlist);
326     PL_utf8_tosimplefold = _new_invlist_C_array(Simple_Case_Folding_invlist);
327     PL_utf8_perl_idstart = _new_invlist_C_array(_Perl_IDStart_invlist);
328     PL_utf8_perl_idcont = _new_invlist_C_array(_Perl_IDCont_invlist);
329     PL_AboveLatin1 = _new_invlist_C_array(AboveLatin1_invlist);
330     PL_Latin1 = _new_invlist_C_array(Latin1_invlist);
331     PL_UpperLatin1 = _new_invlist_C_array(UpperLatin1_invlist);
332     PL_utf8_foldable = _new_invlist_C_array(_Perl_Any_Folds_invlist);
333     PL_HasMultiCharFold = _new_invlist_C_array(
334                                             _Perl_Folds_To_Multi_Char_invlist);
335     PL_NonL1NonFinalFold = _new_invlist_C_array(
336                                             NonL1_Perl_Non_Final_Folds_invlist);
337     PL_utf8_charname_begin = _new_invlist_C_array(_Perl_Charname_Begin_invlist);
338     PL_utf8_charname_continue = _new_invlist_C_array(_Perl_Charname_Continue_invlist);
339     PL_utf8_foldclosures = _new_invlist_C_array(_Perl_IVCF_invlist);
340
341
342 #if defined(LOCAL_PATCH_COUNT)
343     PL_localpatches = local_patches;    /* For possible -v */
344 #endif
345
346 #if defined(LIBM_LIB_VERSION)
347     /*
348      * Some BSDs and Cygwin default to POSIX math instead of IEEE.
349      * This switches them over to IEEE.
350      */
351     _LIB_VERSION = _IEEE_;
352 #endif
353
354 #ifdef HAVE_INTERP_INTERN
355     sys_intern_init();
356 #endif
357
358     PerlIO_init(aTHX);                  /* Hook to IO system */
359
360     PL_fdpid = newAV();                 /* for remembering popen pids by fd */
361     PL_modglobal = newHV();             /* pointers to per-interpreter module globals */
362     PL_errors = newSVpvs("");
363     SvPVCLEAR(PERL_DEBUG_PAD(0));        /* For regex debugging. */
364     SvPVCLEAR(PERL_DEBUG_PAD(1));        /* ext/re needs these */
365     SvPVCLEAR(PERL_DEBUG_PAD(2));        /* even without DEBUGGING. */
366 #ifdef USE_ITHREADS
367     /* First entry is a list of empty elements. It needs to be initialised
368        else all hell breaks loose in S_find_uninit_var().  */
369     Perl_av_create_and_push(aTHX_ &PL_regex_padav, newSVpvs(""));
370     PL_regex_pad = AvARRAY(PL_regex_padav);
371     Newxz(PL_stashpad, PL_stashpadmax, HV *);
372 #endif
373 #ifdef USE_REENTRANT_API
374     Perl_reentrant_init(aTHX);
375 #endif
376     if (PL_hash_seed_set == FALSE) {
377         /* Initialize the hash seed and state at startup. This must be
378          * done very early, before ANY hashes are constructed, and once
379          * setup is fixed for the lifetime of the process.
380          *
381          * If you decide to disable the seeding process you should choose
382          * a suitable seed yourself and define PERL_HASH_SEED to a well chosen
383          * string. See hv_func.h for details.
384          */
385 #if defined(USE_HASH_SEED)
386         /* get the hash seed from the environment or from an RNG */
387         Perl_get_hash_seed(aTHX_ PL_hash_seed);
388 #else
389         /* they want a hard coded seed, check that it is long enough */
390         assert( strlen(PERL_HASH_SEED) >= PERL_HASH_SEED_BYTES );
391 #endif
392
393         /* now we use the chosen seed to initialize the state -
394          * in some configurations this may be a relatively speaking
395          * expensive operation, but we only have to do it once at startup */
396         PERL_HASH_SEED_STATE(PERL_HASH_SEED,PL_hash_state);
397
398 #ifdef PERL_USE_SINGLE_CHAR_HASH_CACHE
399         /* we can build a special cache for 0/1 byte keys, if people choose
400          * I suspect most of the time it is not worth it */
401         {
402             char str[2]="\0";
403             int i;
404             for (i=0;i<256;i++) {
405                 str[0]= i;
406                 PERL_HASH_WITH_STATE(PL_hash_state,PL_hash_chars[i],str,1);
407             }
408             PERL_HASH_WITH_STATE(PL_hash_state,PL_hash_chars[256],str,0);
409         }
410 #endif
411         /* at this point we have initialezed the hash function, and we can start
412          * constructing hashes */
413         PL_hash_seed_set= TRUE;
414     }
415
416     /* Allow PL_strtab to be pre-initialized before calling perl_construct.
417     * can use a custom optimized PL_strtab hash before calling perl_construct */
418     if (!PL_strtab) {
419         /* Note that strtab is a rather special HV.  Assumptions are made
420            about not iterating on it, and not adding tie magic to it.
421            It is properly deallocated in perl_destruct() */
422         PL_strtab = newHV();
423
424         /* SHAREKEYS tells us that the hash has its keys shared with PL_strtab,
425          * which is not the case with PL_strtab itself */
426         HvSHAREKEYS_off(PL_strtab);                     /* mandatory */
427         hv_ksplit(PL_strtab, 1 << 11);
428     }
429
430     Zero(PL_sv_consts, SV_CONSTS_COUNT, SV*);
431
432 #ifndef PERL_MICRO
433 #   ifdef  USE_ENVIRON_ARRAY
434     PL_origenviron = environ;
435 #   endif
436 #endif
437
438     /* Use sysconf(_SC_CLK_TCK) if available, if not
439      * available or if the sysconf() fails, use the HZ.
440      * The HZ if not originally defined has been by now
441      * been defined as CLK_TCK, if available. */
442 #if defined(HAS_SYSCONF) && defined(_SC_CLK_TCK)
443     PL_clocktick = sysconf(_SC_CLK_TCK);
444     if (PL_clocktick <= 0)
445 #endif
446          PL_clocktick = HZ;
447
448     PL_stashcache = newHV();
449
450     PL_patchlevel = newSVpvs("v" PERL_VERSION_STRING);
451
452 #ifdef HAS_MMAP
453     if (!PL_mmap_page_size) {
454 #if defined(HAS_SYSCONF) && (defined(_SC_PAGESIZE) || defined(_SC_MMAP_PAGE_SIZE))
455       {
456         SETERRNO(0, SS_NORMAL);
457 #   ifdef _SC_PAGESIZE
458         PL_mmap_page_size = sysconf(_SC_PAGESIZE);
459 #   else
460         PL_mmap_page_size = sysconf(_SC_MMAP_PAGE_SIZE);
461 #   endif
462         if ((long) PL_mmap_page_size < 0) {
463             Perl_croak(aTHX_ "panic: sysconf: %s",
464                 errno ? Strerror(errno) : "pagesize unknown");
465         }
466       }
467 #elif defined(HAS_GETPAGESIZE)
468       PL_mmap_page_size = getpagesize();
469 #elif defined(I_SYS_PARAM) && defined(PAGESIZE)
470       PL_mmap_page_size = PAGESIZE;       /* compiletime, bad */
471 #endif
472       if (PL_mmap_page_size <= 0)
473         Perl_croak(aTHX_ "panic: bad pagesize %" IVdf,
474                    (IV) PL_mmap_page_size);
475     }
476 #endif /* HAS_MMAP */
477
478 #if defined(HAS_TIMES) && defined(PERL_NEED_TIMESBASE)
479     PL_timesbase.tms_utime  = 0;
480     PL_timesbase.tms_stime  = 0;
481     PL_timesbase.tms_cutime = 0;
482     PL_timesbase.tms_cstime = 0;
483 #endif
484
485     PL_osname = Perl_savepvn(aTHX_ STR_WITH_LEN(OSNAME));
486
487     PL_registered_mros = newHV();
488     /* Start with 1 bucket, for DFS.  It's unlikely we'll need more.  */
489     HvMAX(PL_registered_mros) = 0;
490
491 #ifdef USE_POSIX_2008_LOCALE
492     PL_C_locale_obj = newlocale(LC_ALL_MASK, "C", NULL);
493 #endif
494
495     ENTER;
496     init_i18nl10n(1);
497 }
498
499 /*
500 =for apidoc nothreadhook
501
502 Stub that provides thread hook for perl_destruct when there are
503 no threads.
504
505 =cut
506 */
507
508 int
509 Perl_nothreadhook(pTHX)
510 {
511     PERL_UNUSED_CONTEXT;
512     return 0;
513 }
514
515 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
516 void
517 Perl_dump_sv_child(pTHX_ SV *sv)
518 {
519     ssize_t got;
520     const int sock = PL_dumper_fd;
521     const int debug_fd = PerlIO_fileno(Perl_debug_log);
522     union control_un control;
523     struct msghdr msg;
524     struct iovec vec[2];
525     struct cmsghdr *cmptr;
526     int returned_errno;
527     unsigned char buffer[256];
528
529     PERL_ARGS_ASSERT_DUMP_SV_CHILD;
530
531     if(sock == -1 || debug_fd == -1)
532         return;
533
534     PerlIO_flush(Perl_debug_log);
535
536     /* All these shenanigans are to pass a file descriptor over to our child for
537        it to dump out to.  We can't let it hold open the file descriptor when it
538        forks, as the file descriptor it will dump to can turn out to be one end
539        of pipe that some other process will wait on for EOF. (So as it would
540        be open, the wait would be forever.)  */
541
542     msg.msg_control = control.control;
543     msg.msg_controllen = sizeof(control.control);
544     /* We're a connected socket so we don't need a destination  */
545     msg.msg_name = NULL;
546     msg.msg_namelen = 0;
547     msg.msg_iov = vec;
548     msg.msg_iovlen = 1;
549
550     cmptr = CMSG_FIRSTHDR(&msg);
551     cmptr->cmsg_len = CMSG_LEN(sizeof(int));
552     cmptr->cmsg_level = SOL_SOCKET;
553     cmptr->cmsg_type = SCM_RIGHTS;
554     *((int *)CMSG_DATA(cmptr)) = 1;
555
556     vec[0].iov_base = (void*)&sv;
557     vec[0].iov_len = sizeof(sv);
558     got = sendmsg(sock, &msg, 0);
559
560     if(got < 0) {
561         perror("Debug leaking scalars parent sendmsg failed");
562         abort();
563     }
564     if(got < sizeof(sv)) {
565         perror("Debug leaking scalars parent short sendmsg");
566         abort();
567     }
568
569     /* Return protocol is
570        int:             errno value
571        unsigned char:   length of location string (0 for empty)
572        unsigned char*:  string (not terminated)
573     */
574     vec[0].iov_base = (void*)&returned_errno;
575     vec[0].iov_len = sizeof(returned_errno);
576     vec[1].iov_base = buffer;
577     vec[1].iov_len = 1;
578
579     got = readv(sock, vec, 2);
580
581     if(got < 0) {
582         perror("Debug leaking scalars parent read failed");
583         PerlIO_flush(PerlIO_stderr());
584         abort();
585     }
586     if(got < sizeof(returned_errno) + 1) {
587         perror("Debug leaking scalars parent short read");
588         PerlIO_flush(PerlIO_stderr());
589         abort();
590     }
591
592     if (*buffer) {
593         got = read(sock, buffer + 1, *buffer);
594         if(got < 0) {
595             perror("Debug leaking scalars parent read 2 failed");
596             PerlIO_flush(PerlIO_stderr());
597             abort();
598         }
599
600         if(got < *buffer) {
601             perror("Debug leaking scalars parent short read 2");
602             PerlIO_flush(PerlIO_stderr());
603             abort();
604         }
605     }
606
607     if (returned_errno || *buffer) {
608         Perl_warn(aTHX_ "Debug leaking scalars child failed%s%.*s with errno"
609                   " %d: %s", (*buffer ? " at " : ""), (int) *buffer, buffer + 1,
610                   returned_errno, Strerror(returned_errno));
611     }
612 }
613 #endif
614
615 /*
616 =for apidoc Am|int|perl_destruct|PerlInterpreter *my_perl
617
618 Shuts down a Perl interpreter.  See L<perlembed> for a tutorial.
619
620 C<my_perl> points to the Perl interpreter.  It must have been previously
621 created through the use of L</perl_alloc> and L</perl_construct>.  It may
622 have been initialised through L</perl_parse>, and may have been used
623 through L</perl_run> and other means.  This function should be called for
624 any Perl interpreter that has been constructed with L</perl_construct>,
625 even if subsequent operations on it failed, for example if L</perl_parse>
626 returned a non-zero value.
627
628 If the interpreter's C<PL_exit_flags> word has the
629 C<PERL_EXIT_DESTRUCT_END> flag set, then this function will execute code
630 in C<END> blocks before performing the rest of destruction.  If it is
631 desired to make any use of the interpreter between L</perl_parse> and
632 L</perl_destruct> other than just calling L</perl_run>, then this flag
633 should be set early on.  This matters if L</perl_run> will not be called,
634 or if anything else will be done in addition to calling L</perl_run>.
635
636 Returns a value be a suitable value to pass to the C library function
637 C<exit> (or to return from C<main>), to serve as an exit code indicating
638 the nature of the way the interpreter terminated.  This takes into account
639 any failure of L</perl_parse> and any early exit from L</perl_run>.
640 The exit code is of the type required by the host operating system,
641 so because of differing exit code conventions it is not portable to
642 interpret specific numeric values as having specific meanings.
643
644 =cut
645 */
646
647 int
648 perl_destruct(pTHXx)
649 {
650     dVAR;
651     volatile signed char destruct_level;  /* see possible values in intrpvar.h */
652     HV *hv;
653 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
654     pid_t child;
655 #endif
656     int i;
657
658     PERL_ARGS_ASSERT_PERL_DESTRUCT;
659 #ifndef MULTIPLICITY
660     PERL_UNUSED_ARG(my_perl);
661 #endif
662
663     assert(PL_scopestack_ix == 1);
664
665     /* wait for all pseudo-forked children to finish */
666     PERL_WAIT_FOR_CHILDREN;
667
668     destruct_level = PL_perl_destruct_level;
669 #if defined(DEBUGGING) || defined(PERL_TRACK_MEMPOOL)
670     {
671         const char * const s = PerlEnv_getenv("PERL_DESTRUCT_LEVEL");
672         if (s) {
673             int i;
674             if (strEQ(s, "-1")) { /* Special case: modperl folklore. */
675                 i = -1;
676             } else {
677                 UV uv;
678                 if (grok_atoUV(s, &uv, NULL) && uv <= INT_MAX)
679                     i = (int)uv;
680                 else
681                     i = 0;
682             }
683 #ifdef DEBUGGING
684             if (destruct_level < i) destruct_level = i;
685 #endif
686 #ifdef PERL_TRACK_MEMPOOL
687             /* RT #114496, for perl_free */
688             PL_perl_destruct_level = i;
689 #endif
690         }
691     }
692 #endif
693
694     if (PL_exit_flags & PERL_EXIT_DESTRUCT_END) {
695         dJMPENV;
696         int x = 0;
697
698         JMPENV_PUSH(x);
699         PERL_UNUSED_VAR(x);
700         if (PL_endav && !PL_minus_c) {
701             PERL_SET_PHASE(PERL_PHASE_END);
702             call_list(PL_scopestack_ix, PL_endav);
703         }
704         JMPENV_POP;
705     }
706     LEAVE;
707     FREETMPS;
708     assert(PL_scopestack_ix == 0);
709
710     /* Need to flush since END blocks can produce output */
711     /* flush stdout separately, since we can identify it */
712 #ifdef USE_PERLIO
713     {
714         PerlIO *stdo = PerlIO_stdout();
715         if (*stdo && PerlIO_flush(stdo)) {
716             PerlIO_restore_errno(stdo);
717             if (errno)
718                 PerlIO_printf(PerlIO_stderr(), "Unable to flush stdout: %s\n",
719                     Strerror(errno));
720             if (!STATUS_UNIX)
721                 STATUS_ALL_FAILURE;
722         }
723     }
724 #endif
725     my_fflush_all();
726
727 #ifdef PERL_TRACE_OPS
728     /* dump OP-counts if $ENV{PERL_TRACE_OPS} > 0 */
729     {
730         const char * const ptoenv = PerlEnv_getenv("PERL_TRACE_OPS");
731         UV uv;
732
733         if (!ptoenv || !Perl_grok_atoUV(ptoenv, &uv, NULL)
734             || !(uv > 0))
735         goto no_trace_out;
736     }
737     PerlIO_printf(Perl_debug_log, "Trace of all OPs executed:\n");
738     for (i = 0; i <= OP_max; ++i) {
739         if (PL_op_exec_cnt[i])
740             PerlIO_printf(Perl_debug_log, "  %s: %" UVuf "\n", PL_op_name[i], PL_op_exec_cnt[i]);
741     }
742     /* Utility slot for easily doing little tracing experiments in the runloop: */
743     if (PL_op_exec_cnt[OP_max+1] != 0)
744         PerlIO_printf(Perl_debug_log, "  SPECIAL: %" UVuf "\n", PL_op_exec_cnt[OP_max+1]);
745     PerlIO_printf(Perl_debug_log, "\n");
746  no_trace_out:
747 #endif
748
749
750     if (PL_threadhook(aTHX)) {
751         /* Threads hook has vetoed further cleanup */
752         PL_veto_cleanup = TRUE;
753         return STATUS_EXIT;
754     }
755
756 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
757     if (destruct_level != 0) {
758         /* Fork here to create a child. Our child's job is to preserve the
759            state of scalars prior to destruction, so that we can instruct it
760            to dump any scalars that we later find have leaked.
761            There's no subtlety in this code - it assumes POSIX, and it doesn't
762            fail gracefully  */
763         int fd[2];
764
765         if(PerlSock_socketpair_cloexec(AF_UNIX, SOCK_STREAM, 0, fd)) {
766             perror("Debug leaking scalars socketpair failed");
767             abort();
768         }
769
770         child = fork();
771         if(child == -1) {
772             perror("Debug leaking scalars fork failed");
773             abort();
774         }
775         if (!child) {
776             /* We are the child */
777             const int sock = fd[1];
778             const int debug_fd = PerlIO_fileno(Perl_debug_log);
779             int f;
780             const char *where;
781             /* Our success message is an integer 0, and a char 0  */
782             static const char success[sizeof(int) + 1] = {0};
783
784             close(fd[0]);
785
786             /* We need to close all other file descriptors otherwise we end up
787                with interesting hangs, where the parent closes its end of a
788                pipe, and sits waiting for (another) child to terminate. Only
789                that child never terminates, because it never gets EOF, because
790                we also have the far end of the pipe open.  We even need to
791                close the debugging fd, because sometimes it happens to be one
792                end of a pipe, and a process is waiting on the other end for
793                EOF. Normally it would be closed at some point earlier in
794                destruction, but if we happen to cause the pipe to remain open,
795                EOF never occurs, and we get an infinite hang. Hence all the
796                games to pass in a file descriptor if it's actually needed.  */
797
798             f = sysconf(_SC_OPEN_MAX);
799             if(f < 0) {
800                 where = "sysconf failed";
801                 goto abort;
802             }
803             while (f--) {
804                 if (f == sock)
805                     continue;
806                 close(f);
807             }
808
809             while (1) {
810                 SV *target;
811                 union control_un control;
812                 struct msghdr msg;
813                 struct iovec vec[1];
814                 struct cmsghdr *cmptr;
815                 ssize_t got;
816                 int got_fd;
817
818                 msg.msg_control = control.control;
819                 msg.msg_controllen = sizeof(control.control);
820                 /* We're a connected socket so we don't need a source  */
821                 msg.msg_name = NULL;
822                 msg.msg_namelen = 0;
823                 msg.msg_iov = vec;
824                 msg.msg_iovlen = C_ARRAY_LENGTH(vec);
825
826                 vec[0].iov_base = (void*)&target;
827                 vec[0].iov_len = sizeof(target);
828       
829                 got = recvmsg(sock, &msg, 0);
830
831                 if(got == 0)
832                     break;
833                 if(got < 0) {
834                     where = "recv failed";
835                     goto abort;
836                 }
837                 if(got < sizeof(target)) {
838                     where = "short recv";
839                     goto abort;
840                 }
841
842                 if(!(cmptr = CMSG_FIRSTHDR(&msg))) {
843                     where = "no cmsg";
844                     goto abort;
845                 }
846                 if(cmptr->cmsg_len != CMSG_LEN(sizeof(int))) {
847                     where = "wrong cmsg_len";
848                     goto abort;
849                 }
850                 if(cmptr->cmsg_level != SOL_SOCKET) {
851                     where = "wrong cmsg_level";
852                     goto abort;
853                 }
854                 if(cmptr->cmsg_type != SCM_RIGHTS) {
855                     where = "wrong cmsg_type";
856                     goto abort;
857                 }
858
859                 got_fd = *(int*)CMSG_DATA(cmptr);
860                 /* For our last little bit of trickery, put the file descriptor
861                    back into Perl_debug_log, as if we never actually closed it
862                 */
863                 if(got_fd != debug_fd) {
864                     if (PerlLIO_dup2_cloexec(got_fd, debug_fd) == -1) {
865                         where = "dup2";
866                         goto abort;
867                     }
868                 }
869                 sv_dump(target);
870
871                 PerlIO_flush(Perl_debug_log);
872
873                 got = write(sock, &success, sizeof(success));
874
875                 if(got < 0) {
876                     where = "write failed";
877                     goto abort;
878                 }
879                 if(got < sizeof(success)) {
880                     where = "short write";
881                     goto abort;
882                 }
883             }
884             _exit(0);
885         abort:
886             {
887                 int send_errno = errno;
888                 unsigned char length = (unsigned char) strlen(where);
889                 struct iovec failure[3] = {
890                     {(void*)&send_errno, sizeof(send_errno)},
891                     {&length, 1},
892                     {(void*)where, length}
893                 };
894                 int got = writev(sock, failure, 3);
895                 /* Bad news travels fast. Faster than data. We'll get a SIGPIPE
896                    in the parent if we try to read from the socketpair after the
897                    child has exited, even if there was data to read.
898                    So sleep a bit to give the parent a fighting chance of
899                    reading the data.  */
900                 sleep(2);
901                 _exit((got == -1) ? errno : 0);
902             }
903             /* End of child.  */
904         }
905         PL_dumper_fd = fd[0];
906         close(fd[1]);
907     }
908 #endif
909     
910     /* We must account for everything.  */
911
912     /* Destroy the main CV and syntax tree */
913     /* Set PL_curcop now, because destroying ops can cause new SVs
914        to be generated in Perl_pad_swipe, and when running with
915       -DDEBUG_LEAKING_SCALARS they expect PL_curcop to point to a valid
916        op from which the filename structure member is copied.  */
917     PL_curcop = &PL_compiling;
918     if (PL_main_root) {
919         /* ensure comppad/curpad to refer to main's pad */
920         if (CvPADLIST(PL_main_cv)) {
921             PAD_SET_CUR_NOSAVE(CvPADLIST(PL_main_cv), 1);
922             PL_comppad_name = PadlistNAMES(CvPADLIST(PL_main_cv));
923         }
924         op_free(PL_main_root);
925         PL_main_root = NULL;
926     }
927     PL_main_start = NULL;
928     /* note that  PL_main_cv isn't usually actually freed at this point,
929      * due to the CvOUTSIDE refs from subs compiled within it. It will
930      * get freed once all the subs are freed in sv_clean_all(), for
931      * destruct_level > 0 */
932     SvREFCNT_dec(PL_main_cv);
933     PL_main_cv = NULL;
934     PERL_SET_PHASE(PERL_PHASE_DESTRUCT);
935
936     /* Tell PerlIO we are about to tear things apart in case
937        we have layers which are using resources that should
938        be cleaned up now.
939      */
940
941     PerlIO_destruct(aTHX);
942
943     /*
944      * Try to destruct global references.  We do this first so that the
945      * destructors and destructees still exist.  Some sv's might remain.
946      * Non-referenced objects are on their own.
947      */
948     sv_clean_objs();
949
950     /* unhook hooks which will soon be, or use, destroyed data */
951     SvREFCNT_dec(PL_warnhook);
952     PL_warnhook = NULL;
953     SvREFCNT_dec(PL_diehook);
954     PL_diehook = NULL;
955
956     /* call exit list functions */
957     while (PL_exitlistlen-- > 0)
958         PL_exitlist[PL_exitlistlen].fn(aTHX_ PL_exitlist[PL_exitlistlen].ptr);
959
960     Safefree(PL_exitlist);
961
962     PL_exitlist = NULL;
963     PL_exitlistlen = 0;
964
965     SvREFCNT_dec(PL_registered_mros);
966
967     /* jettison our possibly duplicated environment */
968     /* if PERL_USE_SAFE_PUTENV is defined environ will not have been copied
969      * so we certainly shouldn't free it here
970      */
971 #ifndef PERL_MICRO
972 #if defined(USE_ENVIRON_ARRAY) && !defined(PERL_USE_SAFE_PUTENV)
973     if (environ != PL_origenviron && !PL_use_safe_putenv
974 #ifdef USE_ITHREADS
975         /* only main thread can free environ[0] contents */
976         && PL_curinterp == aTHX
977 #endif
978         )
979     {
980         I32 i;
981
982         for (i = 0; environ[i]; i++)
983             safesysfree(environ[i]);
984
985         /* Must use safesysfree() when working with environ. */
986         safesysfree(environ);           
987
988         environ = PL_origenviron;
989     }
990 #endif
991 #endif /* !PERL_MICRO */
992
993     if (destruct_level == 0) {
994
995         DEBUG_P(debprofdump());
996
997 #if defined(PERLIO_LAYERS)
998         /* No more IO - including error messages ! */
999         PerlIO_cleanup(aTHX);
1000 #endif
1001
1002         CopFILE_free(&PL_compiling);
1003
1004         /* The exit() function will do everything that needs doing. */
1005         return STATUS_EXIT;
1006     }
1007
1008     /* Below, do clean up for when PERL_DESTRUCT_LEVEL is not 0 */
1009
1010 #ifdef USE_ITHREADS
1011     /* the syntax tree is shared between clones
1012      * so op_free(PL_main_root) only ReREFCNT_dec's
1013      * REGEXPs in the parent interpreter
1014      * we need to manually ReREFCNT_dec for the clones
1015      */
1016     {
1017         I32 i = AvFILLp(PL_regex_padav);
1018         SV **ary = AvARRAY(PL_regex_padav);
1019
1020         for (; i; i--) {
1021             SvREFCNT_dec(ary[i]);
1022             ary[i] = &PL_sv_undef;
1023         }
1024     }
1025 #endif
1026
1027
1028     SvREFCNT_dec(MUTABLE_SV(PL_stashcache));
1029     PL_stashcache = NULL;
1030
1031     /* loosen bonds of global variables */
1032
1033     /* XXX can PL_parser still be non-null here? */
1034     if(PL_parser && PL_parser->rsfp) {
1035         (void)PerlIO_close(PL_parser->rsfp);
1036         PL_parser->rsfp = NULL;
1037     }
1038
1039     if (PL_minus_F) {
1040         Safefree(PL_splitstr);
1041         PL_splitstr = NULL;
1042     }
1043
1044     /* switches */
1045     PL_minus_n      = FALSE;
1046     PL_minus_p      = FALSE;
1047     PL_minus_l      = FALSE;
1048     PL_minus_a      = FALSE;
1049     PL_minus_F      = FALSE;
1050     PL_doswitches   = FALSE;
1051     PL_dowarn       = G_WARN_OFF;
1052 #ifdef PERL_SAWAMPERSAND
1053     PL_sawampersand = 0;        /* must save all match strings */
1054 #endif
1055     PL_unsafe       = FALSE;
1056
1057     Safefree(PL_inplace);
1058     PL_inplace = NULL;
1059     SvREFCNT_dec(PL_patchlevel);
1060
1061     if (PL_e_script) {
1062         SvREFCNT_dec(PL_e_script);
1063         PL_e_script = NULL;
1064     }
1065
1066     PL_perldb = 0;
1067
1068     /* magical thingies */
1069
1070     SvREFCNT_dec(PL_ofsgv);     /* *, */
1071     PL_ofsgv = NULL;
1072
1073     SvREFCNT_dec(PL_ors_sv);    /* $\ */
1074     PL_ors_sv = NULL;
1075
1076     SvREFCNT_dec(PL_rs);        /* $/ */
1077     PL_rs = NULL;
1078
1079     Safefree(PL_osname);        /* $^O */
1080     PL_osname = NULL;
1081
1082     SvREFCNT_dec(PL_statname);
1083     PL_statname = NULL;
1084     PL_statgv = NULL;
1085
1086     /* defgv, aka *_ should be taken care of elsewhere */
1087
1088     /* float buffer */
1089     Safefree(PL_efloatbuf);
1090     PL_efloatbuf = NULL;
1091     PL_efloatsize = 0;
1092
1093     /* startup and shutdown function lists */
1094     SvREFCNT_dec(PL_beginav);
1095     SvREFCNT_dec(PL_beginav_save);
1096     SvREFCNT_dec(PL_endav);
1097     SvREFCNT_dec(PL_checkav);
1098     SvREFCNT_dec(PL_checkav_save);
1099     SvREFCNT_dec(PL_unitcheckav);
1100     SvREFCNT_dec(PL_unitcheckav_save);
1101     SvREFCNT_dec(PL_initav);
1102     PL_beginav = NULL;
1103     PL_beginav_save = NULL;
1104     PL_endav = NULL;
1105     PL_checkav = NULL;
1106     PL_checkav_save = NULL;
1107     PL_unitcheckav = NULL;
1108     PL_unitcheckav_save = NULL;
1109     PL_initav = NULL;
1110
1111     /* shortcuts just get cleared */
1112     PL_hintgv = NULL;
1113     PL_errgv = NULL;
1114     PL_argvoutgv = NULL;
1115     PL_stdingv = NULL;
1116     PL_stderrgv = NULL;
1117     PL_last_in_gv = NULL;
1118     PL_DBsingle = NULL;
1119     PL_DBtrace = NULL;
1120     PL_DBsignal = NULL;
1121     PL_DBsingle_iv = 0;
1122     PL_DBtrace_iv = 0;
1123     PL_DBsignal_iv = 0;
1124     PL_DBcv = NULL;
1125     PL_dbargs = NULL;
1126     PL_debstash = NULL;
1127
1128     SvREFCNT_dec(PL_envgv);
1129     SvREFCNT_dec(PL_incgv);
1130     SvREFCNT_dec(PL_argvgv);
1131     SvREFCNT_dec(PL_replgv);
1132     SvREFCNT_dec(PL_DBgv);
1133     SvREFCNT_dec(PL_DBline);
1134     SvREFCNT_dec(PL_DBsub);
1135     PL_envgv = NULL;
1136     PL_incgv = NULL;
1137     PL_argvgv = NULL;
1138     PL_replgv = NULL;
1139     PL_DBgv = NULL;
1140     PL_DBline = NULL;
1141     PL_DBsub = NULL;
1142
1143     SvREFCNT_dec(PL_argvout_stack);
1144     PL_argvout_stack = NULL;
1145
1146     SvREFCNT_dec(PL_modglobal);
1147     PL_modglobal = NULL;
1148     SvREFCNT_dec(PL_preambleav);
1149     PL_preambleav = NULL;
1150     SvREFCNT_dec(PL_subname);
1151     PL_subname = NULL;
1152 #ifdef PERL_USES_PL_PIDSTATUS
1153     SvREFCNT_dec(PL_pidstatus);
1154     PL_pidstatus = NULL;
1155 #endif
1156     SvREFCNT_dec(PL_toptarget);
1157     PL_toptarget = NULL;
1158     SvREFCNT_dec(PL_bodytarget);
1159     PL_bodytarget = NULL;
1160     PL_formtarget = NULL;
1161
1162     /* free locale stuff */
1163 #ifdef USE_LOCALE_COLLATE
1164     Safefree(PL_collation_name);
1165     PL_collation_name = NULL;
1166 #endif
1167 #if   defined(USE_POSIX_2008_LOCALE)      \
1168  &&   defined(USE_THREAD_SAFE_LOCALE)     \
1169  && ! defined(HAS_QUERYLOCALE)
1170     for (i = 0; i < (int) C_ARRAY_LENGTH(PL_curlocales); i++) {
1171         Safefree(PL_curlocales[i]);
1172         PL_curlocales[i] = NULL;
1173     }
1174 #endif
1175 #ifdef HAS_POSIX_2008_LOCALE
1176     {
1177         /* This also makes sure we aren't using a locale object that gets freed
1178          * below */
1179         const locale_t old_locale = uselocale(LC_GLOBAL_LOCALE);
1180         if (old_locale != LC_GLOBAL_LOCALE) {
1181             freelocale(old_locale);
1182         }
1183     }
1184 #  ifdef USE_LOCALE_NUMERIC
1185     if (PL_underlying_numeric_obj) {
1186         freelocale(PL_underlying_numeric_obj);
1187         PL_underlying_numeric_obj = (locale_t) NULL;
1188     }
1189 #  endif
1190 #endif
1191 #ifdef USE_LOCALE_NUMERIC
1192     Safefree(PL_numeric_name);
1193     PL_numeric_name = NULL;
1194     SvREFCNT_dec(PL_numeric_radix_sv);
1195     PL_numeric_radix_sv = NULL;
1196 #endif
1197
1198     if (PL_setlocale_buf) {
1199         Safefree(PL_setlocale_buf);
1200         PL_setlocale_buf = NULL;
1201     }
1202
1203     if (PL_langinfo_buf) {
1204         Safefree(PL_langinfo_buf);
1205         PL_langinfo_buf = NULL;
1206     }
1207
1208     /* clear character classes  */
1209     SvREFCNT_dec(PL_utf8_mark);
1210     SvREFCNT_dec(PL_InBitmap);
1211 #ifdef USE_LOCALE_CTYPE
1212     SvREFCNT_dec(PL_warn_locale);
1213 #endif
1214     PL_utf8_mark        = NULL;
1215     PL_InBitmap          = NULL;
1216 #ifdef USE_LOCALE_CTYPE
1217     PL_warn_locale       = NULL;
1218 #endif
1219
1220     if (!specialWARN(PL_compiling.cop_warnings))
1221         PerlMemShared_free(PL_compiling.cop_warnings);
1222     PL_compiling.cop_warnings = NULL;
1223     cophh_free(CopHINTHASH_get(&PL_compiling));
1224     CopHINTHASH_set(&PL_compiling, cophh_new_empty());
1225     CopFILE_free(&PL_compiling);
1226
1227     /* Prepare to destruct main symbol table.  */
1228
1229     hv = PL_defstash;
1230     /* break ref loop  *:: <=> %:: */
1231     (void)hv_deletes(hv, "main::", G_DISCARD);
1232     PL_defstash = 0;
1233     SvREFCNT_dec(hv);
1234     SvREFCNT_dec(PL_curstname);
1235     PL_curstname = NULL;
1236
1237     /* clear queued errors */
1238     SvREFCNT_dec(PL_errors);
1239     PL_errors = NULL;
1240
1241     SvREFCNT_dec(PL_isarev);
1242
1243     FREETMPS;
1244     if (destruct_level >= 2) {
1245         if (PL_scopestack_ix != 0)
1246             Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
1247                              "Unbalanced scopes: %ld more ENTERs than LEAVEs\n",
1248                              (long)PL_scopestack_ix);
1249         if (PL_savestack_ix != 0)
1250             Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
1251                              "Unbalanced saves: %ld more saves than restores\n",
1252                              (long)PL_savestack_ix);
1253         if (PL_tmps_floor != -1)
1254             Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced tmps: %ld more allocs than frees\n",
1255                              (long)PL_tmps_floor + 1);
1256         if (cxstack_ix != -1)
1257             Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced context: %ld more PUSHes than POPs\n",
1258                              (long)cxstack_ix + 1);
1259     }
1260
1261 #ifdef USE_ITHREADS
1262     SvREFCNT_dec(PL_regex_padav);
1263     PL_regex_padav = NULL;
1264     PL_regex_pad = NULL;
1265 #endif
1266
1267 #ifdef PERL_IMPLICIT_CONTEXT
1268     /* the entries in this list are allocated via SV PVX's, so get freed
1269      * in sv_clean_all */
1270     Safefree(PL_my_cxt_list);
1271 #endif
1272
1273     /* Now absolutely destruct everything, somehow or other, loops or no. */
1274
1275     /* the 2 is for PL_fdpid and PL_strtab */
1276     while (sv_clean_all() > 2)
1277         ;
1278
1279 #ifdef USE_ITHREADS
1280     Safefree(PL_stashpad); /* must come after sv_clean_all */
1281 #endif
1282
1283     AvREAL_off(PL_fdpid);               /* no surviving entries */
1284     SvREFCNT_dec(PL_fdpid);             /* needed in io_close() */
1285     PL_fdpid = NULL;
1286
1287 #ifdef HAVE_INTERP_INTERN
1288     sys_intern_clear();
1289 #endif
1290
1291     /* constant strings */
1292     for (i = 0; i < SV_CONSTS_COUNT; i++) {
1293         SvREFCNT_dec(PL_sv_consts[i]);
1294         PL_sv_consts[i] = NULL;
1295     }
1296
1297     /* Destruct the global string table. */
1298     {
1299         /* Yell and reset the HeVAL() slots that are still holding refcounts,
1300          * so that sv_free() won't fail on them.
1301          * Now that the global string table is using a single hunk of memory
1302          * for both HE and HEK, we either need to explicitly unshare it the
1303          * correct way, or actually free things here.
1304          */
1305         I32 riter = 0;
1306         const I32 max = HvMAX(PL_strtab);
1307         HE * const * const array = HvARRAY(PL_strtab);
1308         HE *hent = array[0];
1309
1310         for (;;) {
1311             if (hent && ckWARN_d(WARN_INTERNAL)) {
1312                 HE * const next = HeNEXT(hent);
1313                 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
1314                      "Unbalanced string table refcount: (%ld) for \"%s\"",
1315                      (long)hent->he_valu.hent_refcount, HeKEY(hent));
1316                 Safefree(hent);
1317                 hent = next;
1318             }
1319             if (!hent) {
1320                 if (++riter > max)
1321                     break;
1322                 hent = array[riter];
1323             }
1324         }
1325
1326         Safefree(array);
1327         HvARRAY(PL_strtab) = 0;
1328         HvTOTALKEYS(PL_strtab) = 0;
1329     }
1330     SvREFCNT_dec(PL_strtab);
1331
1332 #ifdef USE_ITHREADS
1333     /* free the pointer tables used for cloning */
1334     ptr_table_free(PL_ptr_table);
1335     PL_ptr_table = (PTR_TBL_t*)NULL;
1336 #endif
1337
1338     /* free special SVs */
1339
1340     SvREFCNT(&PL_sv_yes) = 0;
1341     sv_clear(&PL_sv_yes);
1342     SvANY(&PL_sv_yes) = NULL;
1343     SvFLAGS(&PL_sv_yes) = 0;
1344
1345     SvREFCNT(&PL_sv_no) = 0;
1346     sv_clear(&PL_sv_no);
1347     SvANY(&PL_sv_no) = NULL;
1348     SvFLAGS(&PL_sv_no) = 0;
1349
1350     SvREFCNT(&PL_sv_zero) = 0;
1351     sv_clear(&PL_sv_zero);
1352     SvANY(&PL_sv_zero) = NULL;
1353     SvFLAGS(&PL_sv_zero) = 0;
1354
1355     {
1356         int i;
1357         for (i=0; i<=2; i++) {
1358             SvREFCNT(PERL_DEBUG_PAD(i)) = 0;
1359             sv_clear(PERL_DEBUG_PAD(i));
1360             SvANY(PERL_DEBUG_PAD(i)) = NULL;
1361             SvFLAGS(PERL_DEBUG_PAD(i)) = 0;
1362         }
1363     }
1364
1365     if (PL_sv_count != 0 && ckWARN_d(WARN_INTERNAL))
1366         Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Scalars leaked: %ld\n", (long)PL_sv_count);
1367
1368 #ifdef DEBUG_LEAKING_SCALARS
1369     if (PL_sv_count != 0) {
1370         SV* sva;
1371         SV* sv;
1372         SV* svend;
1373
1374         for (sva = PL_sv_arenaroot; sva; sva = MUTABLE_SV(SvANY(sva))) {
1375             svend = &sva[SvREFCNT(sva)];
1376             for (sv = sva + 1; sv < svend; ++sv) {
1377                 if (SvTYPE(sv) != (svtype)SVTYPEMASK) {
1378                     PerlIO_printf(Perl_debug_log, "leaked: sv=0x%p"
1379                         " flags=0x%"UVxf
1380                         " refcnt=%"UVuf pTHX__FORMAT "\n"
1381                         "\tallocated at %s:%d %s %s (parent 0x%" UVxf ");"
1382                         "serial %" UVuf "\n",
1383                         (void*)sv, (UV)sv->sv_flags, (UV)sv->sv_refcnt
1384                         pTHX__VALUE,
1385                         sv->sv_debug_file ? sv->sv_debug_file : "(unknown)",
1386                         sv->sv_debug_line,
1387                         sv->sv_debug_inpad ? "for" : "by",
1388                         sv->sv_debug_optype ?
1389                             PL_op_name[sv->sv_debug_optype]: "(none)",
1390                         PTR2UV(sv->sv_debug_parent),
1391                         sv->sv_debug_serial
1392                     );
1393 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1394                     Perl_dump_sv_child(aTHX_ sv);
1395 #endif
1396                 }
1397             }
1398         }
1399     }
1400 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1401     {
1402         int status;
1403         fd_set rset;
1404         /* Wait for up to 4 seconds for child to terminate.
1405            This seems to be the least effort way of timing out on reaping
1406            its exit status.  */
1407         struct timeval waitfor = {4, 0};
1408         int sock = PL_dumper_fd;
1409
1410         shutdown(sock, 1);
1411         FD_ZERO(&rset);
1412         FD_SET(sock, &rset);
1413         select(sock + 1, &rset, NULL, NULL, &waitfor);
1414         waitpid(child, &status, WNOHANG);
1415         close(sock);
1416     }
1417 #endif
1418 #endif
1419 #ifdef DEBUG_LEAKING_SCALARS_ABORT
1420     if (PL_sv_count)
1421         abort();
1422 #endif
1423     PL_sv_count = 0;
1424
1425 #if defined(PERLIO_LAYERS)
1426     /* No more IO - including error messages ! */
1427     PerlIO_cleanup(aTHX);
1428 #endif
1429
1430     /* sv_undef needs to stay immortal until after PerlIO_cleanup
1431        as currently layers use it rather than NULL as a marker
1432        for no arg - and will try and SvREFCNT_dec it.
1433      */
1434     SvREFCNT(&PL_sv_undef) = 0;
1435     SvREADONLY_off(&PL_sv_undef);
1436
1437     Safefree(PL_origfilename);
1438     PL_origfilename = NULL;
1439     Safefree(PL_reg_curpm);
1440     free_tied_hv_pool();
1441     Safefree(PL_op_mask);
1442     Safefree(PL_psig_name);
1443     PL_psig_name = (SV**)NULL;
1444     PL_psig_ptr = (SV**)NULL;
1445     {
1446         /* We need to NULL PL_psig_pend first, so that
1447            signal handlers know not to use it */
1448         int *psig_save = PL_psig_pend;
1449         PL_psig_pend = (int*)NULL;
1450         Safefree(psig_save);
1451     }
1452     nuke_stacks();
1453     TAINTING_set(FALSE);
1454     TAINT_WARN_set(FALSE);
1455     PL_hints = 0;               /* Reset hints. Should hints be per-interpreter ? */
1456
1457     DEBUG_P(debprofdump());
1458
1459     PL_debug = 0;
1460
1461 #ifdef USE_REENTRANT_API
1462     Perl_reentrant_free(aTHX);
1463 #endif
1464
1465     /* These all point to HVs that are about to be blown away.
1466        Code in core and on CPAN assumes that if the interpreter is re-started
1467        that they will be cleanly NULL or pointing to a valid HV.  */
1468     PL_custom_op_names = NULL;
1469     PL_custom_op_descs = NULL;
1470     PL_custom_ops = NULL;
1471
1472     sv_free_arenas();
1473
1474     while (PL_regmatch_slab) {
1475         regmatch_slab  *s = PL_regmatch_slab;
1476         PL_regmatch_slab = PL_regmatch_slab->next;
1477         Safefree(s);
1478     }
1479
1480     /* As the absolutely last thing, free the non-arena SV for mess() */
1481
1482     if (PL_mess_sv) {
1483         /* we know that type == SVt_PVMG */
1484
1485         /* it could have accumulated taint magic */
1486         MAGIC* mg;
1487         MAGIC* moremagic;
1488         for (mg = SvMAGIC(PL_mess_sv); mg; mg = moremagic) {
1489             moremagic = mg->mg_moremagic;
1490             if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global
1491                 && mg->mg_len >= 0)
1492                 Safefree(mg->mg_ptr);
1493             Safefree(mg);
1494         }
1495
1496         /* we know that type >= SVt_PV */
1497         SvPV_free(PL_mess_sv);
1498         Safefree(SvANY(PL_mess_sv));
1499         Safefree(PL_mess_sv);
1500         PL_mess_sv = NULL;
1501     }
1502     return STATUS_EXIT;
1503 }
1504
1505 /*
1506 =for apidoc perl_free
1507
1508 Releases a Perl interpreter.  See L<perlembed>.
1509
1510 =cut
1511 */
1512
1513 void
1514 perl_free(pTHXx)
1515 {
1516     dVAR;
1517
1518     PERL_ARGS_ASSERT_PERL_FREE;
1519
1520     if (PL_veto_cleanup)
1521         return;
1522
1523 #ifdef PERL_TRACK_MEMPOOL
1524     {
1525         /*
1526          * Don't free thread memory if PERL_DESTRUCT_LEVEL is set to a non-zero
1527          * value as we're probably hunting memory leaks then
1528          */
1529         if (PL_perl_destruct_level == 0) {
1530             const U32 old_debug = PL_debug;
1531             /* Emulate the PerlHost behaviour of free()ing all memory allocated in this
1532                thread at thread exit.  */
1533             if (DEBUG_m_TEST) {
1534                 PerlIO_puts(Perl_debug_log, "Disabling memory debugging as we "
1535                             "free this thread's memory\n");
1536                 PL_debug &= ~ DEBUG_m_FLAG;
1537             }
1538             while(aTHXx->Imemory_debug_header.next != &(aTHXx->Imemory_debug_header)){
1539                 char * next = (char *)(aTHXx->Imemory_debug_header.next);
1540                 Malloc_t ptr = PERL_MEMORY_DEBUG_HEADER_SIZE + next;
1541                 safesysfree(ptr);
1542             }
1543             PL_debug = old_debug;
1544         }
1545     }
1546 #endif
1547
1548 #if defined(WIN32) || defined(NETWARE)
1549 #  if defined(PERL_IMPLICIT_SYS)
1550     {
1551 #    ifdef NETWARE
1552         void *host = nw_internal_host;
1553         PerlMem_free(aTHXx);
1554         nw_delete_internal_host(host);
1555 #    else
1556         void *host = w32_internal_host;
1557         PerlMem_free(aTHXx);
1558         win32_delete_internal_host(host);
1559 #    endif
1560     }
1561 #  else
1562     PerlMem_free(aTHXx);
1563 #  endif
1564 #else
1565     PerlMem_free(aTHXx);
1566 #endif
1567 }
1568
1569 #if defined(USE_ITHREADS)
1570 /* provide destructors to clean up the thread key when libperl is unloaded */
1571 #ifndef WIN32 /* handled during DLL_PROCESS_DETACH in win32/perllib.c */
1572
1573 #if defined(__hpux) && !(defined(__ux_version) && __ux_version <= 1020) && !defined(__GNUC__)
1574 #pragma fini "perl_fini"
1575 #elif defined(__sun) && !defined(__GNUC__)
1576 #pragma fini (perl_fini)
1577 #endif
1578
1579 static void
1580 #if defined(__GNUC__)
1581 __attribute__((destructor))
1582 #endif
1583 perl_fini(void)
1584 {
1585     dVAR;
1586     if (
1587 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
1588         my_vars &&
1589 #endif
1590         PL_curinterp && !PL_veto_cleanup)
1591         FREE_THREAD_KEY;
1592 }
1593
1594 #endif /* WIN32 */
1595 #endif /* THREADS */
1596
1597 void
1598 Perl_call_atexit(pTHX_ ATEXIT_t fn, void *ptr)
1599 {
1600     Renew(PL_exitlist, PL_exitlistlen+1, PerlExitListEntry);
1601     PL_exitlist[PL_exitlistlen].fn = fn;
1602     PL_exitlist[PL_exitlistlen].ptr = ptr;
1603     ++PL_exitlistlen;
1604 }
1605
1606 /*
1607 =for apidoc Am|int|perl_parse|PerlInterpreter *my_perl|XSINIT_t xsinit|int argc|char **argv|char **env
1608
1609 Tells a Perl interpreter to parse a Perl script.  This performs most
1610 of the initialisation of a Perl interpreter.  See L<perlembed> for
1611 a tutorial.
1612
1613 C<my_perl> points to the Perl interpreter that is to parse the script.
1614 It must have been previously created through the use of L</perl_alloc>
1615 and L</perl_construct>.  C<xsinit> points to a callback function that
1616 will be called to set up the ability for this Perl interpreter to load
1617 XS extensions, or may be null to perform no such setup.
1618
1619 C<argc> and C<argv> supply a set of command-line arguments to the Perl
1620 interpreter, as would normally be passed to the C<main> function of
1621 a C program.  C<argv[argc]> must be null.  These arguments are where
1622 the script to parse is specified, either by naming a script file or by
1623 providing a script in a C<-e> option.
1624 If L<C<$0>|perlvar/$0> will be written to in the Perl interpreter, then
1625 the argument strings must be in writable memory, and so mustn't just be
1626 string constants.
1627
1628 C<env> specifies a set of environment variables that will be used by
1629 this Perl interpreter.  If non-null, it must point to a null-terminated
1630 array of environment strings.  If null, the Perl interpreter will use
1631 the environment supplied by the C<environ> global variable.
1632
1633 This function initialises the interpreter, and parses and compiles the
1634 script specified by the command-line arguments.  This includes executing
1635 code in C<BEGIN>, C<UNITCHECK>, and C<CHECK> blocks.  It does not execute
1636 C<INIT> blocks or the main program.
1637
1638 Returns an integer of slightly tricky interpretation.  The correct
1639 use of the return value is as a truth value indicating whether there
1640 was a failure in initialisation.  If zero is returned, this indicates
1641 that initialisation was successful, and it is safe to proceed to call
1642 L</perl_run> and make other use of it.  If a non-zero value is returned,
1643 this indicates some problem that means the interpreter wants to terminate.
1644 The interpreter should not be just abandoned upon such failure; the caller
1645 should proceed to shut the interpreter down cleanly with L</perl_destruct>
1646 and free it with L</perl_free>.
1647
1648 For historical reasons, the non-zero return value also attempts to
1649 be a suitable value to pass to the C library function C<exit> (or to
1650 return from C<main>), to serve as an exit code indicating the nature
1651 of the way initialisation terminated.  However, this isn't portable,
1652 due to differing exit code conventions.  A historical bug is preserved
1653 for the time being: if the Perl built-in C<exit> is called during this
1654 function's execution, with a type of exit entailing a zero exit code
1655 under the host operating system's conventions, then this function
1656 returns zero rather than a non-zero value.  This bug, [perl #2754],
1657 leads to C<perl_run> being called (and therefore C<INIT> blocks and the
1658 main program running) despite a call to C<exit>.  It has been preserved
1659 because a popular module-installing module has come to rely on it and
1660 needs time to be fixed.  This issue is [perl #132577], and the original
1661 bug is due to be fixed in Perl 5.30.
1662
1663 =cut
1664 */
1665
1666 #define SET_CURSTASH(newstash)                       \
1667         if (PL_curstash != newstash) {                \
1668             SvREFCNT_dec(PL_curstash);                 \
1669             PL_curstash = (HV *)SvREFCNT_inc(newstash); \
1670         }
1671
1672 int
1673 perl_parse(pTHXx_ XSINIT_t xsinit, int argc, char **argv, char **env)
1674 {
1675     dVAR;
1676     I32 oldscope;
1677     int ret;
1678     dJMPENV;
1679
1680     PERL_ARGS_ASSERT_PERL_PARSE;
1681 #ifndef MULTIPLICITY
1682     PERL_UNUSED_ARG(my_perl);
1683 #endif
1684 #if (defined(USE_HASH_SEED) || defined(USE_HASH_SEED_DEBUG)) && !defined(NO_PERL_HASH_SEED_DEBUG)
1685     {
1686         const char * const s = PerlEnv_getenv("PERL_HASH_SEED_DEBUG");
1687
1688         if (s && strEQ(s, "1")) {
1689             const unsigned char *seed= PERL_HASH_SEED;
1690             const unsigned char *seed_end= PERL_HASH_SEED + PERL_HASH_SEED_BYTES;
1691             PerlIO_printf(Perl_debug_log, "HASH_FUNCTION = %s HASH_SEED = 0x", PERL_HASH_FUNC);
1692             while (seed < seed_end) {
1693                 PerlIO_printf(Perl_debug_log, "%02x", *seed++);
1694             }
1695 #ifdef PERL_HASH_RANDOMIZE_KEYS
1696             PerlIO_printf(Perl_debug_log, " PERTURB_KEYS = %d (%s)",
1697                     PL_HASH_RAND_BITS_ENABLED,
1698                     PL_HASH_RAND_BITS_ENABLED == 0 ? "NO" : PL_HASH_RAND_BITS_ENABLED == 1 ? "RANDOM" : "DETERMINISTIC");
1699 #endif
1700             PerlIO_printf(Perl_debug_log, "\n");
1701         }
1702     }
1703 #endif /* #if (defined(USE_HASH_SEED) ... */
1704
1705 #ifdef __amigaos4__
1706     {
1707         struct NameTranslationInfo nti;
1708         __translate_amiga_to_unix_path_name(&argv[0],&nti); 
1709     }
1710 #endif
1711
1712     {
1713         int i;
1714         assert(argc >= 0);
1715         for(i = 0; i != argc; i++)
1716             assert(argv[i]);
1717         assert(!argv[argc]);
1718     }
1719     PL_origargc = argc;
1720     PL_origargv = argv;
1721
1722     if (PL_origalen != 0) {
1723         PL_origalen = 1; /* don't use old PL_origalen if perl_parse() is called again */
1724     }
1725     else {
1726         /* Set PL_origalen be the sum of the contiguous argv[]
1727          * elements plus the size of the env in case that it is
1728          * contiguous with the argv[].  This is used in mg.c:Perl_magic_set()
1729          * as the maximum modifiable length of $0.  In the worst case
1730          * the area we are able to modify is limited to the size of
1731          * the original argv[0].  (See below for 'contiguous', though.)
1732          * --jhi */
1733          const char *s = NULL;
1734          const UV mask = ~(UV)(PTRSIZE-1);
1735          /* Do the mask check only if the args seem like aligned. */
1736          const UV aligned =
1737            (mask < ~(UV)0) && ((PTR2UV(argv[0]) & mask) == PTR2UV(argv[0]));
1738
1739          /* See if all the arguments are contiguous in memory.  Note
1740           * that 'contiguous' is a loose term because some platforms
1741           * align the argv[] and the envp[].  If the arguments look
1742           * like non-aligned, assume that they are 'strictly' or
1743           * 'traditionally' contiguous.  If the arguments look like
1744           * aligned, we just check that they are within aligned
1745           * PTRSIZE bytes.  As long as no system has something bizarre
1746           * like the argv[] interleaved with some other data, we are
1747           * fine.  (Did I just evoke Murphy's Law?)  --jhi */
1748          if (PL_origargv && PL_origargc >= 1 && (s = PL_origargv[0])) {
1749               int i;
1750               while (*s) s++;
1751               for (i = 1; i < PL_origargc; i++) {
1752                    if ((PL_origargv[i] == s + 1
1753 #ifdef OS2
1754                         || PL_origargv[i] == s + 2
1755 #endif 
1756                             )
1757                        ||
1758                        (aligned &&
1759                         (PL_origargv[i] >  s &&
1760                          PL_origargv[i] <=
1761                          INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1762                         )
1763                    {
1764                         s = PL_origargv[i];
1765                         while (*s) s++;
1766                    }
1767                    else
1768                         break;
1769               }
1770          }
1771
1772 #ifndef PERL_USE_SAFE_PUTENV
1773          /* Can we grab env area too to be used as the area for $0? */
1774          if (s && PL_origenviron && !PL_use_safe_putenv) {
1775               if ((PL_origenviron[0] == s + 1)
1776                   ||
1777                   (aligned &&
1778                    (PL_origenviron[0] >  s &&
1779                     PL_origenviron[0] <=
1780                     INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1781                  )
1782               {
1783                    int i;
1784 #ifndef OS2             /* ENVIRON is read by the kernel too. */
1785                    s = PL_origenviron[0];
1786                    while (*s) s++;
1787 #endif
1788                    my_setenv("NoNe  SuCh", NULL);
1789                    /* Force copy of environment. */
1790                    for (i = 1; PL_origenviron[i]; i++) {
1791                         if (PL_origenviron[i] == s + 1
1792                             ||
1793                             (aligned &&
1794                              (PL_origenviron[i] >  s &&
1795                               PL_origenviron[i] <=
1796                               INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1797                            )
1798                         {
1799                              s = PL_origenviron[i];
1800                              while (*s) s++;
1801                         }
1802                         else
1803                              break;
1804                    }
1805               }
1806          }
1807 #endif /* !defined(PERL_USE_SAFE_PUTENV) */
1808
1809          PL_origalen = s ? s - PL_origargv[0] + 1 : 0;
1810     }
1811
1812     if (PL_do_undump) {
1813
1814         /* Come here if running an undumped a.out. */
1815
1816         PL_origfilename = savepv(argv[0]);
1817         PL_do_undump = FALSE;
1818         cxstack_ix = -1;                /* start label stack again */
1819         init_ids();
1820         assert (!TAINT_get);
1821         TAINT;
1822         set_caret_X();
1823         TAINT_NOT;
1824         init_postdump_symbols(argc,argv,env);
1825         return 0;
1826     }
1827
1828     if (PL_main_root) {
1829         op_free(PL_main_root);
1830         PL_main_root = NULL;
1831     }
1832     PL_main_start = NULL;
1833     SvREFCNT_dec(PL_main_cv);
1834     PL_main_cv = NULL;
1835
1836     time(&PL_basetime);
1837     oldscope = PL_scopestack_ix;
1838     PL_dowarn = G_WARN_OFF;
1839
1840     JMPENV_PUSH(ret);
1841     switch (ret) {
1842     case 0:
1843         parse_body(env,xsinit);
1844         if (PL_unitcheckav) {
1845             call_list(oldscope, PL_unitcheckav);
1846         }
1847         if (PL_checkav) {
1848             PERL_SET_PHASE(PERL_PHASE_CHECK);
1849             call_list(oldscope, PL_checkav);
1850         }
1851         ret = 0;
1852         break;
1853     case 1:
1854         STATUS_ALL_FAILURE;
1855         /* FALLTHROUGH */
1856     case 2:
1857         /* my_exit() was called */
1858         while (PL_scopestack_ix > oldscope)
1859             LEAVE;
1860         FREETMPS;
1861         SET_CURSTASH(PL_defstash);
1862         if (PL_unitcheckav) {
1863             call_list(oldscope, PL_unitcheckav);
1864         }
1865         if (PL_checkav) {
1866             PERL_SET_PHASE(PERL_PHASE_CHECK);
1867             call_list(oldscope, PL_checkav);
1868         }
1869         ret = STATUS_EXIT;
1870         if (ret == 0) {
1871             /*
1872              * At this point we should do
1873              *     ret = 0x100;
1874              * to avoid [perl #2754], but that bugfix has been postponed
1875              * because of the Module::Install breakage it causes
1876              * [perl #132577].
1877              */
1878         }
1879         break;
1880     case 3:
1881         PerlIO_printf(Perl_error_log, "panic: top_env\n");
1882         ret = 1;
1883         break;
1884     }
1885     JMPENV_POP;
1886     return ret;
1887 }
1888
1889 /* This needs to stay in perl.c, as perl.c is compiled with different flags for
1890    miniperl, and we need to see those flags reflected in the values here.  */
1891
1892 /* What this returns is subject to change.  Use the public interface in Config.
1893  */
1894 static void
1895 S_Internals_V(pTHX_ CV *cv)
1896 {
1897     dXSARGS;
1898 #ifdef LOCAL_PATCH_COUNT
1899     const int local_patch_count = LOCAL_PATCH_COUNT;
1900 #else
1901     const int local_patch_count = 0;
1902 #endif
1903     const int entries = 3 + local_patch_count;
1904     int i;
1905     static const char non_bincompat_options[] = 
1906 #  ifdef DEBUGGING
1907                              " DEBUGGING"
1908 #  endif
1909 #  ifdef NO_MATHOMS
1910                              " NO_MATHOMS"
1911 #  endif
1912 #  ifdef NO_HASH_SEED
1913                              " NO_HASH_SEED"
1914 #  endif
1915 #  ifdef NO_TAINT_SUPPORT
1916                              " NO_TAINT_SUPPORT"
1917 #  endif
1918 #  ifdef PERL_BOOL_AS_CHAR
1919                              " PERL_BOOL_AS_CHAR"
1920 #  endif
1921 #  ifdef PERL_COPY_ON_WRITE
1922                              " PERL_COPY_ON_WRITE"
1923 #  endif
1924 #  ifdef PERL_DISABLE_PMC
1925                              " PERL_DISABLE_PMC"
1926 #  endif
1927 #  ifdef PERL_DONT_CREATE_GVSV
1928                              " PERL_DONT_CREATE_GVSV"
1929 #  endif
1930 #  ifdef PERL_EXTERNAL_GLOB
1931                              " PERL_EXTERNAL_GLOB"
1932 #  endif
1933 #  ifdef PERL_HASH_FUNC_SIPHASH
1934                              " PERL_HASH_FUNC_SIPHASH"
1935 #  endif
1936 #  ifdef PERL_HASH_FUNC_SDBM
1937                              " PERL_HASH_FUNC_SDBM"
1938 #  endif
1939 #  ifdef PERL_HASH_FUNC_DJB2
1940                              " PERL_HASH_FUNC_DJB2"
1941 #  endif
1942 #  ifdef PERL_HASH_FUNC_SUPERFAST
1943                              " PERL_HASH_FUNC_SUPERFAST"
1944 #  endif
1945 #  ifdef PERL_HASH_FUNC_MURMUR3
1946                              " PERL_HASH_FUNC_MURMUR3"
1947 #  endif
1948 #  ifdef PERL_HASH_FUNC_ONE_AT_A_TIME
1949                              " PERL_HASH_FUNC_ONE_AT_A_TIME"
1950 #  endif
1951 #  ifdef PERL_HASH_FUNC_ONE_AT_A_TIME_HARD
1952                              " PERL_HASH_FUNC_ONE_AT_A_TIME_HARD"
1953 #  endif
1954 #  ifdef PERL_HASH_FUNC_ONE_AT_A_TIME_OLD
1955                              " PERL_HASH_FUNC_ONE_AT_A_TIME_OLD"
1956 #  endif
1957 #  ifdef PERL_IS_MINIPERL
1958                              " PERL_IS_MINIPERL"
1959 #  endif
1960 #  ifdef PERL_MALLOC_WRAP
1961                              " PERL_MALLOC_WRAP"
1962 #  endif
1963 #  ifdef PERL_MEM_LOG
1964                              " PERL_MEM_LOG"
1965 #  endif
1966 #  ifdef PERL_MEM_LOG_NOIMPL
1967                              " PERL_MEM_LOG_NOIMPL"
1968 #  endif
1969 #  ifdef PERL_OP_PARENT
1970                              " PERL_OP_PARENT"
1971 #  endif
1972 #  ifdef PERL_PERTURB_KEYS_DETERMINISTIC
1973                              " PERL_PERTURB_KEYS_DETERMINISTIC"
1974 #  endif
1975 #  ifdef PERL_PERTURB_KEYS_DISABLED
1976                              " PERL_PERTURB_KEYS_DISABLED"
1977 #  endif
1978 #  ifdef PERL_PERTURB_KEYS_RANDOM
1979                              " PERL_PERTURB_KEYS_RANDOM"
1980 #  endif
1981 #  ifdef PERL_PRESERVE_IVUV
1982                              " PERL_PRESERVE_IVUV"
1983 #  endif
1984 #  ifdef PERL_RELOCATABLE_INCPUSH
1985                              " PERL_RELOCATABLE_INCPUSH"
1986 #  endif
1987 #  ifdef PERL_USE_DEVEL
1988                              " PERL_USE_DEVEL"
1989 #  endif
1990 #  ifdef PERL_USE_SAFE_PUTENV
1991                              " PERL_USE_SAFE_PUTENV"
1992 #  endif
1993 #  ifdef SILENT_NO_TAINT_SUPPORT
1994                              " SILENT_NO_TAINT_SUPPORT"
1995 #  endif
1996 #  ifdef UNLINK_ALL_VERSIONS
1997                              " UNLINK_ALL_VERSIONS"
1998 #  endif
1999 #  ifdef USE_ATTRIBUTES_FOR_PERLIO
2000                              " USE_ATTRIBUTES_FOR_PERLIO"
2001 #  endif
2002 #  ifdef USE_FAST_STDIO
2003                              " USE_FAST_STDIO"
2004 #  endif               
2005 #  ifdef USE_LOCALE
2006                              " USE_LOCALE"
2007 #  endif
2008 #  ifdef USE_LOCALE_CTYPE
2009                              " USE_LOCALE_CTYPE"
2010 #  endif
2011 #  ifdef WIN32_NO_REGISTRY
2012                              " USE_NO_REGISTRY"
2013 #  endif
2014 #  ifdef USE_PERL_ATOF
2015                              " USE_PERL_ATOF"
2016 #  endif               
2017 #  ifdef USE_SITECUSTOMIZE
2018                              " USE_SITECUSTOMIZE"
2019 #  endif               
2020         ;
2021     PERL_UNUSED_ARG(cv);
2022     PERL_UNUSED_VAR(items);
2023
2024     EXTEND(SP, entries);
2025
2026     PUSHs(sv_2mortal(newSVpv(PL_bincompat_options, 0)));
2027     PUSHs(Perl_newSVpvn_flags(aTHX_ non_bincompat_options,
2028                               sizeof(non_bincompat_options) - 1, SVs_TEMP));
2029
2030 #ifndef PERL_BUILD_DATE
2031 #  ifdef __DATE__
2032 #    ifdef __TIME__
2033 #      define PERL_BUILD_DATE __DATE__ " " __TIME__
2034 #    else
2035 #      define PERL_BUILD_DATE __DATE__
2036 #    endif
2037 #  endif
2038 #endif
2039
2040 #ifdef PERL_BUILD_DATE
2041     PUSHs(Perl_newSVpvn_flags(aTHX_
2042                               STR_WITH_LEN("Compiled at " PERL_BUILD_DATE),
2043                               SVs_TEMP));
2044 #else
2045     PUSHs(&PL_sv_undef);
2046 #endif
2047
2048     for (i = 1; i <= local_patch_count; i++) {
2049         /* This will be an undef, if PL_localpatches[i] is NULL.  */
2050         PUSHs(sv_2mortal(newSVpv(PL_localpatches[i], 0)));
2051     }
2052
2053     XSRETURN(entries);
2054 }
2055
2056 #define INCPUSH_UNSHIFT                 0x01
2057 #define INCPUSH_ADD_OLD_VERS            0x02
2058 #define INCPUSH_ADD_VERSIONED_SUB_DIRS  0x04
2059 #define INCPUSH_ADD_ARCHONLY_SUB_DIRS   0x08
2060 #define INCPUSH_NOT_BASEDIR             0x10
2061 #define INCPUSH_CAN_RELOCATE            0x20
2062 #define INCPUSH_ADD_SUB_DIRS    \
2063     (INCPUSH_ADD_VERSIONED_SUB_DIRS|INCPUSH_ADD_ARCHONLY_SUB_DIRS)
2064
2065 STATIC void *
2066 S_parse_body(pTHX_ char **env, XSINIT_t xsinit)
2067 {
2068     dVAR;
2069     PerlIO *rsfp;
2070     int argc = PL_origargc;
2071     char **argv = PL_origargv;
2072     const char *scriptname = NULL;
2073     bool dosearch = FALSE;
2074     char c;
2075     bool doextract = FALSE;
2076     const char *cddir = NULL;
2077 #ifdef USE_SITECUSTOMIZE
2078     bool minus_f = FALSE;
2079 #endif
2080     SV *linestr_sv = NULL;
2081     bool add_read_e_script = FALSE;
2082     U32 lex_start_flags = 0;
2083
2084     PERL_SET_PHASE(PERL_PHASE_START);
2085
2086     init_main_stash();
2087
2088     {
2089         const char *s;
2090     for (argc--,argv++; argc > 0; argc--,argv++) {
2091         if (argv[0][0] != '-' || !argv[0][1])
2092             break;
2093         s = argv[0]+1;
2094       reswitch:
2095         switch ((c = *s)) {
2096         case 'C':
2097 #ifndef PERL_STRICT_CR
2098         case '\r':
2099 #endif
2100         case ' ':
2101         case '0':
2102         case 'F':
2103         case 'a':
2104         case 'c':
2105         case 'd':
2106         case 'D':
2107         case 'h':
2108         case 'i':
2109         case 'l':
2110         case 'M':
2111         case 'm':
2112         case 'n':
2113         case 'p':
2114         case 's':
2115         case 'u':
2116         case 'U':
2117         case 'v':
2118         case 'W':
2119         case 'X':
2120         case 'w':
2121             if ((s = moreswitches(s)))
2122                 goto reswitch;
2123             break;
2124
2125         case 't':
2126 #if defined(SILENT_NO_TAINT_SUPPORT)
2127             /* silently ignore */
2128 #elif defined(NO_TAINT_SUPPORT)
2129             Perl_croak_nocontext("This perl was compiled without taint support. "
2130                        "Cowardly refusing to run with -t or -T flags");
2131 #else
2132             CHECK_MALLOC_TOO_LATE_FOR('t');
2133             if( !TAINTING_get ) {
2134                  TAINT_WARN_set(TRUE);
2135                  TAINTING_set(TRUE);
2136             }
2137 #endif
2138             s++;
2139             goto reswitch;
2140         case 'T':
2141 #if defined(SILENT_NO_TAINT_SUPPORT)
2142             /* silently ignore */
2143 #elif defined(NO_TAINT_SUPPORT)
2144             Perl_croak_nocontext("This perl was compiled without taint support. "
2145                        "Cowardly refusing to run with -t or -T flags");
2146 #else
2147             CHECK_MALLOC_TOO_LATE_FOR('T');
2148             TAINTING_set(TRUE);
2149             TAINT_WARN_set(FALSE);
2150 #endif
2151             s++;
2152             goto reswitch;
2153
2154         case 'E':
2155             PL_minus_E = TRUE;
2156             /* FALLTHROUGH */
2157         case 'e':
2158             forbid_setid('e', FALSE);
2159             if (!PL_e_script) {
2160                 PL_e_script = newSVpvs("");
2161                 add_read_e_script = TRUE;
2162             }
2163             if (*++s)
2164                 sv_catpv(PL_e_script, s);
2165             else if (argv[1]) {
2166                 sv_catpv(PL_e_script, argv[1]);
2167                 argc--,argv++;
2168             }
2169             else
2170                 Perl_croak(aTHX_ "No code specified for -%c", c);
2171             sv_catpvs(PL_e_script, "\n");
2172             break;
2173
2174         case 'f':
2175 #ifdef USE_SITECUSTOMIZE
2176             minus_f = TRUE;
2177 #endif
2178             s++;
2179             goto reswitch;
2180
2181         case 'I':       /* -I handled both here and in moreswitches() */
2182             forbid_setid('I', FALSE);
2183             if (!*++s && (s=argv[1]) != NULL) {
2184                 argc--,argv++;
2185             }
2186             if (s && *s) {
2187                 STRLEN len = strlen(s);
2188                 incpush(s, len, INCPUSH_ADD_SUB_DIRS|INCPUSH_ADD_OLD_VERS);
2189             }
2190             else
2191                 Perl_croak(aTHX_ "No directory specified for -I");
2192             break;
2193         case 'S':
2194             forbid_setid('S', FALSE);
2195             dosearch = TRUE;
2196             s++;
2197             goto reswitch;
2198         case 'V':
2199             {
2200                 SV *opts_prog;
2201
2202                 if (*++s != ':')  {
2203                     opts_prog = newSVpvs("use Config; Config::_V()");
2204                 }
2205                 else {
2206                     ++s;
2207                     opts_prog = Perl_newSVpvf(aTHX_
2208                                               "use Config; Config::config_vars(qw%c%s%c)",
2209                                               0, s, 0);
2210                     s += strlen(s);
2211                 }
2212                 Perl_av_create_and_push(aTHX_ &PL_preambleav, opts_prog);
2213                 /* don't look for script or read stdin */
2214                 scriptname = BIT_BUCKET;
2215                 goto reswitch;
2216             }
2217         case 'x':
2218             doextract = TRUE;
2219             s++;
2220             if (*s)
2221                 cddir = s;
2222             break;
2223         case 0:
2224             break;
2225         case '-':
2226             if (!*++s || isSPACE(*s)) {
2227                 argc--,argv++;
2228                 goto switch_end;
2229             }
2230             /* catch use of gnu style long options.
2231                Both of these exit immediately.  */
2232             if (strEQ(s, "version"))
2233                 minus_v();
2234             if (strEQ(s, "help"))
2235                 usage();
2236             s--;
2237             /* FALLTHROUGH */
2238         default:
2239             Perl_croak(aTHX_ "Unrecognized switch: -%s  (-h will show valid options)",s);
2240         }
2241     }
2242     }
2243
2244   switch_end:
2245
2246     {
2247         char *s;
2248
2249     if (
2250 #ifndef SECURE_INTERNAL_GETENV
2251         !TAINTING_get &&
2252 #endif
2253         (s = PerlEnv_getenv("PERL5OPT")))
2254     {
2255         /* s points to static memory in getenv(), which may be overwritten at
2256          * any time; use a mortal copy instead */
2257         s = SvPVX(sv_2mortal(newSVpv(s, 0)));
2258
2259         while (isSPACE(*s))
2260             s++;
2261         if (*s == '-' && *(s+1) == 'T') {
2262 #if defined(SILENT_NO_TAINT_SUPPORT)
2263             /* silently ignore */
2264 #elif defined(NO_TAINT_SUPPORT)
2265             Perl_croak_nocontext("This perl was compiled without taint support. "
2266                        "Cowardly refusing to run with -t or -T flags");
2267 #else
2268             CHECK_MALLOC_TOO_LATE_FOR('T');
2269             TAINTING_set(TRUE);
2270             TAINT_WARN_set(FALSE);
2271 #endif
2272         }
2273         else {
2274             char *popt_copy = NULL;
2275             while (s && *s) {
2276                 const char *d;
2277                 while (isSPACE(*s))
2278                     s++;
2279                 if (*s == '-') {
2280                     s++;
2281                     if (isSPACE(*s))
2282                         continue;
2283                 }
2284                 d = s;
2285                 if (!*s)
2286                     break;
2287                 if (!strchr("CDIMUdmtwW", *s))
2288                     Perl_croak(aTHX_ "Illegal switch in PERL5OPT: -%c", *s);
2289                 while (++s && *s) {
2290                     if (isSPACE(*s)) {
2291                         if (!popt_copy) {
2292                             popt_copy = SvPVX(sv_2mortal(newSVpv(d,0)));
2293                             s = popt_copy + (s - d);
2294                             d = popt_copy;
2295                         }
2296                         *s++ = '\0';
2297                         break;
2298                     }
2299                 }
2300                 if (*d == 't') {
2301 #if defined(SILENT_NO_TAINT_SUPPORT)
2302             /* silently ignore */
2303 #elif defined(NO_TAINT_SUPPORT)
2304                     Perl_croak_nocontext("This perl was compiled without taint support. "
2305                                "Cowardly refusing to run with -t or -T flags");
2306 #else
2307                     if( !TAINTING_get) {
2308                         TAINT_WARN_set(TRUE);
2309                         TAINTING_set(TRUE);
2310                     }
2311 #endif
2312                 } else {
2313                     moreswitches(d);
2314                 }
2315             }
2316         }
2317     }
2318     }
2319
2320 #ifndef NO_PERL_INTERNAL_RAND_SEED
2321     /* If we're not set[ug]id, we might have honored
2322        PERL_INTERNAL_RAND_SEED in perl_construct().
2323        At this point command-line options have been parsed, so if
2324        we're now tainting and not set[ug]id re-seed.
2325        This could possibly be wasteful if PERL_INTERNAL_RAND_SEED is invalid,
2326        but avoids duplicating the logic from perl_construct().
2327     */
2328     if (PL_tainting &&
2329         PerlProc_getuid() == PerlProc_geteuid() &&
2330         PerlProc_getgid() == PerlProc_getegid()) {
2331         Perl_drand48_init_r(&PL_internal_random_state, seed());
2332     }
2333 #endif
2334
2335     /* Set $^X early so that it can be used for relocatable paths in @INC  */
2336     /* and for SITELIB_EXP in USE_SITECUSTOMIZE                            */
2337     assert (!TAINT_get);
2338     TAINT;
2339     set_caret_X();
2340     TAINT_NOT;
2341
2342 #if defined(USE_SITECUSTOMIZE)
2343     if (!minus_f) {
2344         /* The games with local $! are to avoid setting errno if there is no
2345            sitecustomize script.  "q%c...%c", 0, ..., 0 becomes "q\0...\0",
2346            ie a q() operator with a NUL byte as a the delimiter. This avoids
2347            problems with pathnames containing (say) '  */
2348 #  ifdef PERL_IS_MINIPERL
2349         AV *const inc = GvAV(PL_incgv);
2350         SV **const inc0 = inc ? av_fetch(inc, 0, FALSE) : NULL;
2351
2352         if (inc0) {
2353             /* if lib/buildcustomize.pl exists, it should not fail. If it does,
2354                it should be reported immediately as a build failure.  */
2355             (void)Perl_av_create_and_unshift_one(aTHX_ &PL_preambleav,
2356                                                  Perl_newSVpvf(aTHX_
2357                 "BEGIN { my $f = q%c%s%" SVf "/buildcustomize.pl%c; "
2358                         "do {local $!; -f $f }"
2359                         " and do $f || die $@ || qq '$f: $!' }",
2360                                 0, (TAINTING_get ? "./" : ""), SVfARG(*inc0), 0));
2361         }
2362 #  else
2363         /* SITELIB_EXP is a function call on Win32.  */
2364         const char *const raw_sitelib = SITELIB_EXP;
2365         if (raw_sitelib) {
2366             /* process .../.. if PERL_RELOCATABLE_INC is defined */
2367             SV *sitelib_sv = mayberelocate(raw_sitelib, strlen(raw_sitelib),
2368                                            INCPUSH_CAN_RELOCATE);
2369             const char *const sitelib = SvPVX(sitelib_sv);
2370             (void)Perl_av_create_and_unshift_one(aTHX_ &PL_preambleav,
2371                                                  Perl_newSVpvf(aTHX_
2372                                                                "BEGIN { do {local $!; -f q%c%s/sitecustomize.pl%c} && do q%c%s/sitecustomize.pl%c }",
2373                                                                0, SVfARG(sitelib), 0,
2374                                                                0, SVfARG(sitelib), 0));
2375             assert (SvREFCNT(sitelib_sv) == 1);
2376             SvREFCNT_dec(sitelib_sv);
2377         }
2378 #  endif
2379     }
2380 #endif
2381
2382     if (!scriptname)
2383         scriptname = argv[0];
2384     if (PL_e_script) {
2385         argc++,argv--;
2386         scriptname = BIT_BUCKET;        /* don't look for script or read stdin */
2387     }
2388     else if (scriptname == NULL) {
2389 #ifdef MSDOS
2390         if ( PerlLIO_isatty(PerlIO_fileno(PerlIO_stdin())) )
2391             moreswitches("h");
2392 #endif
2393         scriptname = "-";
2394     }
2395
2396     assert (!TAINT_get);
2397     init_perllib();
2398
2399     {
2400         bool suidscript = FALSE;
2401
2402         rsfp = open_script(scriptname, dosearch, &suidscript);
2403         if (!rsfp) {
2404             rsfp = PerlIO_stdin();
2405             lex_start_flags = LEX_DONT_CLOSE_RSFP;
2406         }
2407
2408         validate_suid(rsfp);
2409
2410 #ifndef PERL_MICRO
2411 #  if defined(SIGCHLD) || defined(SIGCLD)
2412         {
2413 #  ifndef SIGCHLD
2414 #    define SIGCHLD SIGCLD
2415 #  endif
2416             Sighandler_t sigstate = rsignal_state(SIGCHLD);
2417             if (sigstate == (Sighandler_t) SIG_IGN) {
2418                 Perl_ck_warner(aTHX_ packWARN(WARN_SIGNAL),
2419                                "Can't ignore signal CHLD, forcing to default");
2420                 (void)rsignal(SIGCHLD, (Sighandler_t)SIG_DFL);
2421             }
2422         }
2423 #  endif
2424 #endif
2425
2426         if (doextract) {
2427
2428             /* This will croak if suidscript is true, as -x cannot be used with
2429                setuid scripts.  */
2430             forbid_setid('x', suidscript);
2431             /* Hence you can't get here if suidscript is true */
2432
2433             linestr_sv = newSV_type(SVt_PV);
2434             lex_start_flags |= LEX_START_COPIED;
2435             find_beginning(linestr_sv, rsfp);
2436             if (cddir && PerlDir_chdir( (char *)cddir ) < 0)
2437                 Perl_croak(aTHX_ "Can't chdir to %s",cddir);
2438         }
2439     }
2440
2441     PL_main_cv = PL_compcv = MUTABLE_CV(newSV_type(SVt_PVCV));
2442     CvUNIQUE_on(PL_compcv);
2443
2444     CvPADLIST_set(PL_compcv, pad_new(0));
2445
2446     PL_isarev = newHV();
2447
2448     boot_core_PerlIO();
2449     boot_core_UNIVERSAL();
2450     boot_core_mro();
2451     newXS("Internals::V", S_Internals_V, __FILE__);
2452
2453     if (xsinit)
2454         (*xsinit)(aTHX);        /* in case linked C routines want magical variables */
2455 #ifndef PERL_MICRO
2456 #if defined(VMS) || defined(WIN32) || defined(DJGPP) || defined(__CYGWIN__) || defined(SYMBIAN)
2457     init_os_extras();
2458 #endif
2459 #endif
2460
2461 #ifdef USE_SOCKS
2462 #   ifdef HAS_SOCKS5_INIT
2463     socks5_init(argv[0]);
2464 #   else
2465     SOCKSinit(argv[0]);
2466 #   endif
2467 #endif
2468
2469     init_predump_symbols();
2470     /* init_postdump_symbols not currently designed to be called */
2471     /* more than once (ENV isn't cleared first, for example)     */
2472     /* But running with -u leaves %ENV & @ARGV undefined!    XXX */
2473     if (!PL_do_undump)
2474         init_postdump_symbols(argc,argv,env);
2475
2476     /* PL_unicode is turned on by -C, or by $ENV{PERL_UNICODE},
2477      * or explicitly in some platforms.
2478      * PL_utf8locale is conditionally turned on by
2479      * locale.c:Perl_init_i18nl10n() if the environment
2480      * look like the user wants to use UTF-8. */
2481 #if defined(__SYMBIAN32__)
2482     PL_unicode = PERL_UNICODE_STD_FLAG; /* See PERL_SYMBIAN_CONSOLE_UTF8. */
2483 #endif
2484 #  ifndef PERL_IS_MINIPERL
2485     if (PL_unicode) {
2486          /* Requires init_predump_symbols(). */
2487          if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
2488               IO* io;
2489               PerlIO* fp;
2490               SV* sv;
2491
2492               /* Turn on UTF-8-ness on STDIN, STDOUT, STDERR
2493                * and the default open disciplines. */
2494               if ((PL_unicode & PERL_UNICODE_STDIN_FLAG) &&
2495                   PL_stdingv  && (io = GvIO(PL_stdingv)) &&
2496                   (fp = IoIFP(io)))
2497                    PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2498               if ((PL_unicode & PERL_UNICODE_STDOUT_FLAG) &&
2499                   PL_defoutgv && (io = GvIO(PL_defoutgv)) &&
2500                   (fp = IoOFP(io)))
2501                    PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2502               if ((PL_unicode & PERL_UNICODE_STDERR_FLAG) &&
2503                   PL_stderrgv && (io = GvIO(PL_stderrgv)) &&
2504                   (fp = IoOFP(io)))
2505                    PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2506               if ((PL_unicode & PERL_UNICODE_INOUT_FLAG) &&
2507                   (sv = GvSV(gv_fetchpvs("\017PEN", GV_ADD|GV_NOTQUAL,
2508                                          SVt_PV)))) {
2509                    U32 in  = PL_unicode & PERL_UNICODE_IN_FLAG;
2510                    U32 out = PL_unicode & PERL_UNICODE_OUT_FLAG;
2511                    if (in) {
2512                         if (out)
2513                              sv_setpvs(sv, ":utf8\0:utf8");
2514                         else
2515                              sv_setpvs(sv, ":utf8\0");
2516                    }
2517                    else if (out)
2518                         sv_setpvs(sv, "\0:utf8");
2519                    SvSETMAGIC(sv);
2520               }
2521          }
2522     }
2523 #endif
2524
2525     {
2526         const char *s;
2527     if ((s = PerlEnv_getenv("PERL_SIGNALS"))) {
2528          if (strEQ(s, "unsafe"))
2529               PL_signals |=  PERL_SIGNALS_UNSAFE_FLAG;
2530          else if (strEQ(s, "safe"))
2531               PL_signals &= ~PERL_SIGNALS_UNSAFE_FLAG;
2532          else
2533               Perl_croak(aTHX_ "PERL_SIGNALS illegal: \"%s\"", s);
2534     }
2535     }
2536
2537
2538     lex_start(linestr_sv, rsfp, lex_start_flags);
2539     SvREFCNT_dec(linestr_sv);
2540
2541     PL_subname = newSVpvs("main");
2542
2543     if (add_read_e_script)
2544         filter_add(read_e_script, NULL);
2545
2546     /* now parse the script */
2547
2548     SETERRNO(0,SS_NORMAL);
2549     if (yyparse(GRAMPROG) || PL_parser->error_count) {
2550         abort_execution("", PL_origfilename);
2551     }
2552     CopLINE_set(PL_curcop, 0);
2553     SET_CURSTASH(PL_defstash);
2554     if (PL_e_script) {
2555         SvREFCNT_dec(PL_e_script);
2556         PL_e_script = NULL;
2557     }
2558
2559     if (PL_do_undump)
2560         my_unexec();
2561
2562     if (isWARN_ONCE) {
2563         SAVECOPFILE(PL_curcop);
2564         SAVECOPLINE(PL_curcop);
2565         gv_check(PL_defstash);
2566     }
2567
2568     LEAVE;
2569     FREETMPS;
2570
2571 #ifdef MYMALLOC
2572     {
2573         const char *s;
2574         UV uv;
2575         s = PerlEnv_getenv("PERL_DEBUG_MSTATS");
2576         if (s && grok_atoUV(s, &uv, NULL) && uv >= 2)
2577             dump_mstats("after compilation:");
2578     }
2579 #endif
2580
2581     ENTER;
2582     PL_restartjmpenv = NULL;
2583     PL_restartop = 0;
2584     return NULL;
2585 }
2586
2587 /*
2588 =for apidoc Am|int|perl_run|PerlInterpreter *my_perl
2589
2590 Tells a Perl interpreter to run its main program.  See L<perlembed>
2591 for a tutorial.
2592
2593 C<my_perl> points to the Perl interpreter.  It must have been previously
2594 created through the use of L</perl_alloc> and L</perl_construct>, and
2595 initialised through L</perl_parse>.  This function should not be called
2596 if L</perl_parse> returned a non-zero value, indicating a failure in
2597 initialisation or compilation.
2598
2599 This function executes code in C<INIT> blocks, and then executes the
2600 main program.  The code to be executed is that established by the prior
2601 call to L</perl_parse>.  If the interpreter's C<PL_exit_flags> word
2602 does not have the C<PERL_EXIT_DESTRUCT_END> flag set, then this function
2603 will also execute code in C<END> blocks.  If it is desired to make any
2604 further use of the interpreter after calling this function, then C<END>
2605 blocks should be postponed to L</perl_destruct> time by setting that flag.
2606
2607 Returns an integer of slightly tricky interpretation.  The correct use
2608 of the return value is as a truth value indicating whether the program
2609 terminated non-locally.  If zero is returned, this indicates that
2610 the program ran to completion, and it is safe to make other use of the
2611 interpreter (provided that the C<PERL_EXIT_DESTRUCT_END> flag was set as
2612 described above).  If a non-zero value is returned, this indicates that
2613 the interpreter wants to terminate early.  The interpreter should not be
2614 just abandoned because of this desire to terminate; the caller should
2615 proceed to shut the interpreter down cleanly with L</perl_destruct>
2616 and free it with L</perl_free>.
2617
2618 For historical reasons, the non-zero return value also attempts to
2619 be a suitable value to pass to the C library function C<exit> (or to
2620 return from C<main>), to serve as an exit code indicating the nature of
2621 the way the program terminated.  However, this isn't portable, due to
2622 differing exit code conventions.  An attempt is made to return an exit
2623 code of the type required by the host operating system, but because
2624 it is constrained to be non-zero, it is not necessarily possible to
2625 indicate every type of exit.  It is only reliable on Unix, where a zero
2626 exit code can be augmented with a set bit that will be ignored.  In any
2627 case, this function is not the correct place to acquire an exit code:
2628 one should get that from L</perl_destruct>.
2629
2630 =cut
2631 */
2632
2633 int
2634 perl_run(pTHXx)
2635 {
2636     I32 oldscope;
2637     int ret = 0, exit_called = 0;
2638     dJMPENV;
2639
2640     PERL_ARGS_ASSERT_PERL_RUN;
2641 #ifndef MULTIPLICITY
2642     PERL_UNUSED_ARG(my_perl);
2643 #endif
2644
2645     oldscope = PL_scopestack_ix;
2646 #ifdef VMS
2647     VMSISH_HUSHED = 0;
2648 #endif
2649
2650     JMPENV_PUSH(ret);
2651     switch (ret) {
2652     case 1:
2653         cxstack_ix = -1;                /* start context stack again */
2654         goto redo_body;
2655     case 0:                             /* normal completion */
2656  redo_body:
2657         run_body(oldscope);
2658         goto handle_exit;
2659     case 2:                             /* my_exit() */
2660         exit_called = 1;
2661     handle_exit:
2662         while (PL_scopestack_ix > oldscope)
2663             LEAVE;
2664         FREETMPS;
2665         SET_CURSTASH(PL_defstash);
2666         if (!(PL_exit_flags & PERL_EXIT_DESTRUCT_END) &&
2667             PL_endav && !PL_minus_c) {
2668             PERL_SET_PHASE(PERL_PHASE_END);
2669             call_list(oldscope, PL_endav);
2670         }
2671 #ifdef MYMALLOC
2672         if (PerlEnv_getenv("PERL_DEBUG_MSTATS"))
2673             dump_mstats("after execution:  ");
2674 #endif
2675         if (exit_called) {
2676             ret = STATUS_EXIT;
2677             if (ret == 0) ret = 0x100;
2678         } else {
2679             ret = 0;
2680         }
2681         break;
2682     case 3:
2683         if (PL_restartop) {
2684             POPSTACK_TO(PL_mainstack);
2685             goto redo_body;
2686         }
2687         PerlIO_printf(Perl_error_log, "panic: restartop in perl_run\n");
2688         FREETMPS;
2689         ret = 1;
2690         break;
2691     }
2692
2693     JMPENV_POP;
2694     return ret;
2695 }
2696
2697 STATIC void
2698 S_run_body(pTHX_ I32 oldscope)
2699 {
2700     DEBUG_r(PerlIO_printf(Perl_debug_log, "%s $` $& $' support (0x%x).\n",
2701                     PL_sawampersand ? "Enabling" : "Omitting",
2702                     (unsigned int)(PL_sawampersand)));
2703
2704     if (!PL_restartop) {
2705 #ifdef DEBUGGING
2706         if (DEBUG_x_TEST || DEBUG_B_TEST)
2707             dump_all_perl(!DEBUG_B_TEST);
2708         if (!DEBUG_q_TEST)
2709           PERL_DEBUG(PerlIO_printf(Perl_debug_log, "\nEXECUTING...\n\n"));
2710 #endif
2711
2712         if (PL_minus_c) {
2713             PerlIO_printf(Perl_error_log, "%s syntax OK\n", PL_origfilename);
2714             my_exit(0);
2715         }
2716         if (PERLDB_SINGLE && PL_DBsingle)
2717             PL_DBsingle_iv = 1;
2718         if (PL_initav) {
2719             PERL_SET_PHASE(PERL_PHASE_INIT);
2720             call_list(oldscope, PL_initav);
2721         }
2722 #ifdef PERL_DEBUG_READONLY_OPS
2723         if (PL_main_root && PL_main_root->op_slabbed)
2724             Slab_to_ro(OpSLAB(PL_main_root));
2725 #endif
2726     }
2727
2728     /* do it */
2729
2730     PERL_SET_PHASE(PERL_PHASE_RUN);
2731
2732     if (PL_restartop) {
2733         PL_restartjmpenv = NULL;
2734         PL_op = PL_restartop;
2735         PL_restartop = 0;
2736         CALLRUNOPS(aTHX);
2737     }
2738     else if (PL_main_start) {
2739         CvDEPTH(PL_main_cv) = 1;
2740         PL_op = PL_main_start;
2741         CALLRUNOPS(aTHX);
2742     }
2743     my_exit(0);
2744     NOT_REACHED; /* NOTREACHED */
2745 }
2746
2747 /*
2748 =head1 SV Manipulation Functions
2749
2750 =for apidoc p||get_sv
2751
2752 Returns the SV of the specified Perl scalar.  C<flags> are passed to
2753 C<gv_fetchpv>.  If C<GV_ADD> is set and the
2754 Perl variable does not exist then it will be created.  If C<flags> is zero
2755 and the variable does not exist then NULL is returned.
2756
2757 =cut
2758 */
2759
2760 SV*
2761 Perl_get_sv(pTHX_ const char *name, I32 flags)
2762 {
2763     GV *gv;
2764
2765     PERL_ARGS_ASSERT_GET_SV;
2766
2767     gv = gv_fetchpv(name, flags, SVt_PV);
2768     if (gv)
2769         return GvSV(gv);
2770     return NULL;
2771 }
2772
2773 /*
2774 =head1 Array Manipulation Functions
2775
2776 =for apidoc p||get_av
2777
2778 Returns the AV of the specified Perl global or package array with the given
2779 name (so it won't work on lexical variables).  C<flags> are passed 
2780 to C<gv_fetchpv>.  If C<GV_ADD> is set and the
2781 Perl variable does not exist then it will be created.  If C<flags> is zero
2782 and the variable does not exist then NULL is returned.
2783
2784 Perl equivalent: C<@{"$name"}>.
2785
2786 =cut
2787 */
2788
2789 AV*
2790 Perl_get_av(pTHX_ const char *name, I32 flags)
2791 {
2792     GV* const gv = gv_fetchpv(name, flags, SVt_PVAV);
2793
2794     PERL_ARGS_ASSERT_GET_AV;
2795
2796     if (flags)
2797         return GvAVn(gv);
2798     if (gv)
2799         return GvAV(gv);
2800     return NULL;
2801 }
2802
2803 /*
2804 =head1 Hash Manipulation Functions
2805
2806 =for apidoc p||get_hv
2807
2808 Returns the HV of the specified Perl hash.  C<flags> are passed to
2809 C<gv_fetchpv>.  If C<GV_ADD> is set and the
2810 Perl variable does not exist then it will be created.  If C<flags> is zero
2811 and the variable does not exist then C<NULL> is returned.
2812
2813 =cut
2814 */
2815
2816 HV*
2817 Perl_get_hv(pTHX_ const char *name, I32 flags)
2818 {
2819     GV* const gv = gv_fetchpv(name, flags, SVt_PVHV);
2820
2821     PERL_ARGS_ASSERT_GET_HV;
2822
2823     if (flags)
2824         return GvHVn(gv);
2825     if (gv)
2826         return GvHV(gv);
2827     return NULL;
2828 }
2829
2830 /*
2831 =head1 CV Manipulation Functions
2832
2833 =for apidoc p||get_cvn_flags
2834
2835 Returns the CV of the specified Perl subroutine.  C<flags> are passed to
2836 C<gv_fetchpvn_flags>.  If C<GV_ADD> is set and the Perl subroutine does not
2837 exist then it will be declared (which has the same effect as saying
2838 C<sub name;>).  If C<GV_ADD> is not set and the subroutine does not exist
2839 then NULL is returned.
2840
2841 =for apidoc p||get_cv
2842
2843 Uses C<strlen> to get the length of C<name>, then calls C<get_cvn_flags>.
2844
2845 =cut
2846 */
2847
2848 CV*
2849 Perl_get_cvn_flags(pTHX_ const char *name, STRLEN len, I32 flags)
2850 {
2851     GV* const gv = gv_fetchpvn_flags(name, len, flags, SVt_PVCV);
2852
2853     PERL_ARGS_ASSERT_GET_CVN_FLAGS;
2854
2855     if (gv && UNLIKELY(SvROK(gv)) && SvTYPE(SvRV((SV *)gv)) == SVt_PVCV)
2856         return (CV*)SvRV((SV *)gv);
2857
2858     /* XXX this is probably not what they think they're getting.
2859      * It has the same effect as "sub name;", i.e. just a forward
2860      * declaration! */
2861     if ((flags & ~GV_NOADD_MASK) && !GvCVu(gv)) {
2862         return newSTUB(gv,0);
2863     }
2864     if (gv)
2865         return GvCVu(gv);
2866     return NULL;
2867 }
2868
2869 /* Nothing in core calls this now, but we can't replace it with a macro and
2870    move it to mathoms.c as a macro would evaluate name twice.  */
2871 CV*
2872 Perl_get_cv(pTHX_ const char *name, I32 flags)
2873 {
2874     PERL_ARGS_ASSERT_GET_CV;
2875
2876     return get_cvn_flags(name, strlen(name), flags);
2877 }
2878
2879 /* Be sure to refetch the stack pointer after calling these routines. */
2880
2881 /*
2882
2883 =head1 Callback Functions
2884
2885 =for apidoc p||call_argv
2886
2887 Performs a callback to the specified named and package-scoped Perl subroutine 
2888 with C<argv> (a C<NULL>-terminated array of strings) as arguments.  See
2889 L<perlcall>.
2890
2891 Approximate Perl equivalent: C<&{"$sub_name"}(@$argv)>.
2892
2893 =cut
2894 */
2895
2896 I32
2897 Perl_call_argv(pTHX_ const char *sub_name, I32 flags, char **argv)
2898
2899                         /* See G_* flags in cop.h */
2900                         /* null terminated arg list */
2901 {
2902     dSP;
2903
2904     PERL_ARGS_ASSERT_CALL_ARGV;
2905
2906     PUSHMARK(SP);
2907     while (*argv) {
2908         mXPUSHs(newSVpv(*argv,0));
2909         argv++;
2910     }
2911     PUTBACK;
2912     return call_pv(sub_name, flags);
2913 }
2914
2915 /*
2916 =for apidoc p||call_pv
2917
2918 Performs a callback to the specified Perl sub.  See L<perlcall>.
2919
2920 =cut
2921 */
2922
2923 I32
2924 Perl_call_pv(pTHX_ const char *sub_name, I32 flags)
2925                         /* name of the subroutine */
2926                         /* See G_* flags in cop.h */
2927 {
2928     PERL_ARGS_ASSERT_CALL_PV;
2929
2930     return call_sv(MUTABLE_SV(get_cv(sub_name, GV_ADD)), flags);
2931 }
2932
2933 /*
2934 =for apidoc p||call_method
2935
2936 Performs a callback to the specified Perl method.  The blessed object must
2937 be on the stack.  See L<perlcall>.
2938
2939 =cut
2940 */
2941
2942 I32
2943 Perl_call_method(pTHX_ const char *methname, I32 flags)
2944                         /* name of the subroutine */
2945                         /* See G_* flags in cop.h */
2946 {
2947     STRLEN len;
2948     SV* sv;
2949     PERL_ARGS_ASSERT_CALL_METHOD;
2950
2951     len = strlen(methname);
2952     sv = flags & G_METHOD_NAMED
2953         ? sv_2mortal(newSVpvn_share(methname, len,0))
2954         : newSVpvn_flags(methname, len, SVs_TEMP);
2955
2956     return call_sv(sv, flags | G_METHOD);
2957 }
2958
2959 /* May be called with any of a CV, a GV, or an SV containing the name. */
2960 /*
2961 =for apidoc p||call_sv
2962
2963 Performs a callback to the Perl sub specified by the SV.
2964
2965 If neither the C<G_METHOD> nor C<G_METHOD_NAMED> flag is supplied, the
2966 SV may be any of a CV, a GV, a reference to a CV, a reference to a GV
2967 or C<SvPV(sv)> will be used as the name of the sub to call.
2968
2969 If the C<G_METHOD> flag is supplied, the SV may be a reference to a CV or
2970 C<SvPV(sv)> will be used as the name of the method to call.
2971
2972 If the C<G_METHOD_NAMED> flag is supplied, C<SvPV(sv)> will be used as
2973 the name of the method to call.
2974
2975 Some other values are treated specially for internal use and should
2976 not be depended on.
2977
2978 See L<perlcall>.
2979
2980 =cut
2981 */
2982
2983 I32
2984 Perl_call_sv(pTHX_ SV *sv, volatile I32 flags)
2985                         /* See G_* flags in cop.h */
2986 {
2987     dVAR;
2988     LOGOP myop;         /* fake syntax tree node */
2989     METHOP method_op;
2990     I32 oldmark;
2991     volatile I32 retval = 0;
2992     bool oldcatch = CATCH_GET;
2993     int ret;
2994     OP* const oldop = PL_op;
2995     dJMPENV;
2996
2997     PERL_ARGS_ASSERT_CALL_SV;
2998
2999     if (flags & G_DISCARD) {
3000         ENTER;
3001         SAVETMPS;
3002     }
3003     if (!(flags & G_WANT)) {
3004         /* Backwards compatibility - as G_SCALAR was 0, it could be omitted.
3005          */
3006         flags |= G_SCALAR;
3007     }
3008
3009     Zero(&myop, 1, LOGOP);
3010     if (!(flags & G_NOARGS))
3011         myop.op_flags |= OPf_STACKED;
3012     myop.op_flags |= OP_GIMME_REVERSE(flags);
3013     SAVEOP();
3014     PL_op = (OP*)&myop;
3015
3016     if (!(flags & G_METHOD_NAMED)) {
3017         dSP;
3018         EXTEND(SP, 1);
3019         PUSHs(sv);
3020         PUTBACK;
3021     }
3022     oldmark = TOPMARK;
3023
3024     if (PERLDB_SUB && PL_curstash != PL_debstash
3025            /* Handle first BEGIN of -d. */
3026           && (PL_DBcv || (PL_DBcv = GvCV(PL_DBsub)))
3027            /* Try harder, since this may have been a sighandler, thus
3028             * curstash may be meaningless. */
3029           && (SvTYPE(sv) != SVt_PVCV || CvSTASH((const CV *)sv) != PL_debstash)
3030           && !(flags & G_NODEBUG))
3031         myop.op_private |= OPpENTERSUB_DB;
3032
3033     if (flags & (G_METHOD|G_METHOD_NAMED)) {
3034         Zero(&method_op, 1, METHOP);
3035         method_op.op_next = (OP*)&myop;
3036         PL_op = (OP*)&method_op;
3037         if ( flags & G_METHOD_NAMED ) {
3038             method_op.op_ppaddr = PL_ppaddr[OP_METHOD_NAMED];
3039             method_op.op_type = OP_METHOD_NAMED;
3040             method_op.op_u.op_meth_sv = sv;
3041         } else {
3042             method_op.op_ppaddr = PL_ppaddr[OP_METHOD];
3043             method_op.op_type = OP_METHOD;
3044         }
3045         myop.op_ppaddr = PL_ppaddr[OP_ENTERSUB];
3046         myop.op_type = OP_ENTERSUB;
3047     }
3048
3049     if (!(flags & G_EVAL)) {
3050         CATCH_SET(TRUE);
3051         CALL_BODY_SUB((OP*)&myop);
3052         retval = PL_stack_sp - (PL_stack_base + oldmark);
3053         CATCH_SET(oldcatch);
3054     }
3055     else {
3056         I32 old_cxix;
3057         myop.op_other = (OP*)&myop;
3058         (void)POPMARK;
3059         old_cxix = cxstack_ix;
3060         create_eval_scope(NULL, flags|G_FAKINGEVAL);
3061         INCMARK;
3062
3063         JMPENV_PUSH(ret);
3064
3065         switch (ret) {
3066         case 0:
3067  redo_body:
3068             CALL_BODY_SUB((OP*)&myop);
3069             retval = PL_stack_sp - (PL_stack_base + oldmark);
3070             if (!(flags & G_KEEPERR)) {
3071                 CLEAR_ERRSV();
3072             }
3073             break;
3074         case 1:
3075             STATUS_ALL_FAILURE;
3076             /* FALLTHROUGH */
3077         case 2:
3078             /* my_exit() was called */
3079             SET_CURSTASH(PL_defstash);
3080             FREETMPS;
3081             JMPENV_POP;
3082             my_exit_jump();
3083             NOT_REACHED; /* NOTREACHED */
3084         case 3:
3085             if (PL_restartop) {
3086                 PL_restartjmpenv = NULL;
3087                 PL_op = PL_restartop;
3088                 PL_restartop = 0;
3089                 goto redo_body;
3090             }
3091             PL_stack_sp = PL_stack_base + oldmark;
3092             if ((flags & G_WANT) == G_ARRAY)
3093                 retval = 0;
3094             else {
3095                 retval = 1;
3096                 *++PL_stack_sp = &PL_sv_undef;
3097             }
3098             break;
3099         }
3100
3101         /* if we croaked, depending on how we croaked the eval scope
3102          * may or may not have already been popped */
3103         if (cxstack_ix > old_cxix) {
3104             assert(cxstack_ix == old_cxix + 1);
3105             assert(CxTYPE(CX_CUR()) == CXt_EVAL);
3106             delete_eval_scope();
3107         }
3108         JMPENV_POP;
3109     }
3110
3111     if (flags & G_DISCARD) {
3112         PL_stack_sp = PL_stack_base + oldmark;
3113         retval = 0;
3114         FREETMPS;
3115         LEAVE;
3116     }
3117     PL_op = oldop;
3118     return retval;
3119 }
3120
3121 /* Eval a string. The G_EVAL flag is always assumed. */
3122
3123 /*
3124 =for apidoc p||eval_sv
3125
3126 Tells Perl to C<eval> the string in the SV.  It supports the same flags
3127 as C<call_sv>, with the obvious exception of C<G_EVAL>.  See L<perlcall>.
3128
3129 =cut
3130 */
3131
3132 I32
3133 Perl_eval_sv(pTHX_ SV *sv, I32 flags)
3134
3135                         /* See G_* flags in cop.h */
3136 {
3137     dVAR;
3138     UNOP myop;          /* fake syntax tree node */
3139     volatile I32 oldmark;
3140     volatile I32 retval = 0;
3141     int ret;
3142     OP* const oldop = PL_op;
3143     dJMPENV;
3144
3145     PERL_ARGS_ASSERT_EVAL_SV;
3146
3147     if (flags & G_DISCARD) {
3148         ENTER;
3149         SAVETMPS;
3150     }
3151
3152     SAVEOP();
3153     PL_op = (OP*)&myop;
3154     Zero(&myop, 1, UNOP);
3155     {
3156         dSP;
3157         oldmark = SP - PL_stack_base;
3158         EXTEND(SP, 1);
3159         PUSHs(sv);
3160         PUTBACK;
3161     }
3162
3163     if (!(flags & G_NOARGS))
3164         myop.op_flags = OPf_STACKED;
3165     myop.op_type = OP_ENTEREVAL;
3166     myop.op_flags |= OP_GIMME_REVERSE(flags);
3167     if (flags & G_KEEPERR)
3168         myop.op_flags |= OPf_SPECIAL;
3169
3170     if (flags & G_RE_REPARSING)
3171         myop.op_private = (OPpEVAL_COPHH | OPpEVAL_RE_REPARSING);
3172
3173     /* fail now; otherwise we could fail after the JMPENV_PUSH but
3174      * before a cx_pusheval(), which corrupts the stack after a croak */
3175     TAINT_PROPER("eval_sv()");
3176
3177     JMPENV_PUSH(ret);
3178     switch (ret) {
3179     case 0:
3180  redo_body:
3181         if (PL_op == (OP*)(&myop)) {
3182             PL_op = PL_ppaddr[OP_ENTEREVAL](aTHX);
3183             if (!PL_op)
3184                 goto fail; /* failed in compilation */
3185         }
3186         CALLRUNOPS(aTHX);
3187         retval = PL_stack_sp - (PL_stack_base + oldmark);
3188         if (!(flags & G_KEEPERR)) {
3189             CLEAR_ERRSV();
3190         }
3191         break;
3192     case 1:
3193         STATUS_ALL_FAILURE;
3194         /* FALLTHROUGH */
3195     case 2:
3196         /* my_exit() was called */
3197         SET_CURSTASH(PL_defstash);
3198         FREETMPS;
3199         JMPENV_POP;
3200         my_exit_jump();
3201         NOT_REACHED; /* NOTREACHED */
3202     case 3:
3203         if (PL_restartop) {
3204             PL_restartjmpenv = NULL;
3205             PL_op = PL_restartop;
3206             PL_restartop = 0;
3207             goto redo_body;
3208         }
3209       fail:
3210         PL_stack_sp = PL_stack_base + oldmark;
3211         if ((flags & G_WANT) == G_ARRAY)
3212             retval = 0;
3213         else {
3214             retval = 1;
3215             *++PL_stack_sp = &PL_sv_undef;
3216         }
3217         break;
3218     }
3219
3220     JMPENV_POP;
3221     if (flags & G_DISCARD) {
3222         PL_stack_sp = PL_stack_base + oldmark;
3223         retval = 0;
3224         FREETMPS;
3225         LEAVE;
3226     }
3227     PL_op = oldop;
3228     return retval;
3229 }
3230
3231 /*
3232 =for apidoc p||eval_pv
3233
3234 Tells Perl to C<eval> the given string in scalar context and return an SV* result.
3235
3236 =cut
3237 */
3238
3239 SV*
3240 Perl_eval_pv(pTHX_ const char *p, I32 croak_on_error)
3241 {
3242     SV* sv = newSVpv(p, 0);
3243
3244     PERL_ARGS_ASSERT_EVAL_PV;
3245
3246     eval_sv(sv, G_SCALAR);
3247     SvREFCNT_dec(sv);
3248
3249     {
3250         dSP;
3251         sv = POPs;
3252         PUTBACK;
3253     }
3254
3255     /* just check empty string or undef? */
3256     if (croak_on_error) {
3257         SV * const errsv = ERRSV;
3258         if(SvTRUE_NN(errsv))
3259             /* replace with croak_sv? */
3260             Perl_croak_nocontext("%s", SvPV_nolen_const(errsv));
3261     }
3262
3263     return sv;
3264 }
3265
3266 /* Require a module. */
3267
3268 /*
3269 =head1 Embedding Functions
3270
3271 =for apidoc p||require_pv
3272
3273 Tells Perl to C<require> the file named by the string argument.  It is
3274 analogous to the Perl code C<eval "require '$file'">.  It's even
3275 implemented that way; consider using load_module instead.
3276
3277 =cut */
3278
3279 void
3280 Perl_require_pv(pTHX_ const char *pv)
3281 {
3282     dSP;
3283     SV* sv;
3284
3285     PERL_ARGS_ASSERT_REQUIRE_PV;
3286
3287     PUSHSTACKi(PERLSI_REQUIRE);
3288     sv = Perl_newSVpvf(aTHX_ "require q%c%s%c", 0, pv, 0);
3289     eval_sv(sv_2mortal(sv), G_DISCARD);
3290     POPSTACK;
3291 }
3292
3293 STATIC void
3294 S_usage(pTHX)           /* XXX move this out into a module ? */
3295 {
3296     /* This message really ought to be max 23 lines.
3297      * Removed -h because the user already knows that option. Others? */
3298
3299     /* Grouped as 6 lines per C string literal, to keep under the ANSI C 89
3300        minimum of 509 character string literals.  */
3301     static const char * const usage_msg[] = {
3302 "  -0[octal]         specify record separator (\\0, if no argument)\n"
3303 "  -a                autosplit mode with -n or -p (splits $_ into @F)\n"
3304 "  -C[number/list]   enables the listed Unicode features\n"
3305 "  -c                check syntax only (runs BEGIN and CHECK blocks)\n"
3306 "  -d[:debugger]     run program under debugger\n"
3307 "  -D[number/list]   set debugging flags (argument is a bit mask or alphabets)\n",
3308 "  -e program        one line of program (several -e's allowed, omit programfile)\n"
3309 "  -E program        like -e, but enables all optional features\n"
3310 "  -f                don't do $sitelib/sitecustomize.pl at startup\n"
3311 "  -F/pattern/       split() pattern for -a switch (//'s are optional)\n"
3312 "  -i[extension]     edit <> files in place (makes backup if extension supplied)\n"
3313 "  -Idirectory       specify @INC/#include directory (several -I's allowed)\n",
3314 "  -l[octal]         enable line ending processing, specifies line terminator\n"
3315 "  -[mM][-]module    execute \"use/no module...\" before executing program\n"
3316 "  -n                assume \"while (<>) { ... }\" loop around program\n"
3317 "  -p                assume loop like -n but print line also, like sed\n"
3318 "  -s                enable rudimentary parsing for switches after programfile\n"
3319 "  -S                look for programfile using PATH environment variable\n",
3320 "  -t                enable tainting warnings\n"
3321 "  -T                enable tainting checks\n"
3322 "  -u                dump core after parsing program\n"
3323 "  -U                allow unsafe operations\n"
3324 "  -v                print version, patchlevel and license\n"
3325 "  -V[:variable]     print configuration summary (or a single Config.pm variable)\n",
3326 "  -w                enable many useful warnings\n"
3327 "  -W                enable all warnings\n"
3328 "  -x[directory]     ignore text before #!perl line (optionally cd to directory)\n"
3329 "  -X                disable all warnings\n"
3330 "  \n"
3331 "Run 'perldoc perl' for more help with Perl.\n\n",
3332 NULL
3333 };
3334     const char * const *p = usage_msg;
3335     PerlIO *out = PerlIO_stdout();
3336
3337     PerlIO_printf(out,
3338                   "\nUsage: %s [switches] [--] [programfile] [arguments]\n",
3339                   PL_origargv[0]);
3340     while (*p)
3341         PerlIO_puts(out, *p++);
3342     my_exit(0);
3343 }
3344
3345 /* convert a string of -D options (or digits) into an int.
3346  * sets *s to point to the char after the options */
3347
3348 #ifdef DEBUGGING
3349 int
3350 Perl_get_debug_opts(pTHX_ const char **s, bool givehelp)
3351 {
3352     static const char * const usage_msgd[] = {
3353       " Debugging flag values: (see also -d)\n"
3354       "  p  Tokenizing and parsing (with v, displays parse stack)\n"
3355       "  s  Stack snapshots (with v, displays all stacks)\n"
3356       "  l  Context (loop) stack processing\n"
3357       "  t  Trace execution\n"
3358       "  o  Method and overloading resolution\n",
3359       "  c  String/numeric conversions\n"
3360       "  P  Print profiling info, source file input state\n"
3361       "  m  Memory and SV allocation\n"
3362       "  f  Format processing\n"
3363       "  r  Regular expression parsing and execution\n"
3364       "  x  Syntax tree dump\n",
3365       "  u  Tainting checks\n"
3366       "  H  Hash dump -- usurps values()\n"
3367       "  X  Scratchpad allocation\n"
3368       "  D  Cleaning up\n"
3369       "  S  Op slab allocation\n"
3370       "  T  Tokenising\n"
3371       "  R  Include reference counts of dumped variables (eg when using -Ds)\n",
3372       "  J  Do not s,t,P-debug (Jump over) opcodes within package DB\n"
3373       "  v  Verbose: use in conjunction with other flags\n"
3374       "  C  Copy On Write\n"
3375       "  A  Consistency checks on internal structures\n"
3376       "  q  quiet - currently only suppresses the 'EXECUTING' message\n"
3377       "  M  trace smart match resolution\n"
3378       "  B  dump suBroutine definitions, including special Blocks like BEGIN\n",
3379       "  L  trace some locale setting information--for Perl core development\n",
3380       "  i  trace PerlIO layer processing\n",
3381       NULL
3382     };
3383     UV uv = 0;
3384
3385     PERL_ARGS_ASSERT_GET_DEBUG_OPTS;
3386
3387     if (isALPHA(**s)) {
3388         /* if adding extra options, remember to update DEBUG_MASK */
3389         static const char debopts[] = "psltocPmfrxuUHXDSTRJvCAqMBLi";
3390
3391         for (; isWORDCHAR(**s); (*s)++) {
3392             const char * const d = strchr(debopts,**s);
3393             if (d)
3394                 uv |= 1 << (d - debopts);
3395             else if (ckWARN_d(WARN_DEBUGGING))
3396                 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3397                     "invalid option -D%c, use -D'' to see choices\n", **s);
3398         }
3399     }
3400     else if (isDIGIT(**s)) {
3401         const char* e;
3402         if (grok_atoUV(*s, &uv, &e))
3403             *s = e;
3404         for (; isWORDCHAR(**s); (*s)++) ;
3405     }
3406     else if (givehelp) {
3407       const char *const *p = usage_msgd;
3408       while (*p) PerlIO_puts(PerlIO_stdout(), *p++);
3409     }
3410     return (int)uv; /* ignore any UV->int conversion loss */
3411 }
3412 #endif
3413
3414 /* This routine handles any switches that can be given during run */
3415
3416 const char *
3417 Perl_moreswitches(pTHX_ const char *s)
3418 {
3419     dVAR;
3420     UV rschar;
3421     const char option = *s; /* used to remember option in -m/-M code */
3422
3423     PERL_ARGS_ASSERT_MORESWITCHES;
3424
3425     switch (*s) {
3426     case '0':
3427     {
3428          I32 flags = 0;
3429          STRLEN numlen;
3430
3431          SvREFCNT_dec(PL_rs);
3432          if (s[1] == 'x' && s[2]) {
3433               const char *e = s+=2;
3434               U8 *tmps;
3435
3436               while (*e)
3437                 e++;
3438               numlen = e - s;
3439               flags = PERL_SCAN_SILENT_ILLDIGIT;
3440               rschar = (U32)grok_hex(s, &numlen, &flags, NULL);
3441               if (s + numlen < e) {
3442                    rschar = 0; /* Grandfather -0xFOO as -0 -xFOO. */
3443                    numlen = 0;
3444                    s--;
3445               }
3446               PL_rs = newSVpvs("");
3447               tmps = (U8*) SvGROW(PL_rs, (STRLEN)(UVCHR_SKIP(rschar) + 1));
3448               uvchr_to_utf8(tmps, rschar);
3449               SvCUR_set(PL_rs, UVCHR_SKIP(rschar));
3450               SvUTF8_on(PL_rs);
3451          }
3452          else {
3453               numlen = 4;
3454               rschar = (U32)grok_oct(s, &numlen, &flags, NULL);
3455               if (rschar & ~((U8)~0))
3456                    PL_rs = &PL_sv_undef;
3457               else if (!rschar && numlen >= 2)
3458                    PL_rs = newSVpvs("");
3459               else {
3460                    char ch = (char)rschar;
3461                    PL_rs = newSVpvn(&ch, 1);
3462               }
3463          }
3464          sv_setsv(get_sv("/", GV_ADD), PL_rs);
3465          return s + numlen;
3466     }
3467     case 'C':
3468         s++;
3469         PL_unicode = parse_unicode_opts( (const char **)&s );
3470         if (PL_unicode & PERL_UNICODE_UTF8CACHEASSERT_FLAG)
3471             PL_utf8cache = -1;
3472         return s;
3473     case 'F':
3474         PL_minus_a = TRUE;
3475         PL_minus_F = TRUE;
3476         PL_minus_n = TRUE;
3477         PL_splitstr = ++s;
3478         while (*s && !isSPACE(*s)) ++s;
3479         PL_splitstr = savepvn(PL_splitstr, s - PL_splitstr);
3480         return s;
3481     case 'a':
3482         PL_minus_a = TRUE;
3483         PL_minus_n = TRUE;
3484         s++;
3485         return s;
3486     case 'c':
3487         PL_minus_c = TRUE;
3488         s++;
3489         return s;
3490     case 'd':
3491         forbid_setid('d', FALSE);
3492         s++;
3493
3494         /* -dt indicates to the debugger that threads will be used */
3495         if (*s == 't' && !isWORDCHAR(s[1])) {
3496             ++s;
3497             my_setenv("PERL5DB_THREADED", "1");
3498         }
3499
3500         /* The following permits -d:Mod to accepts arguments following an =
3501            in the fashion that -MSome::Mod does. */
3502         if (*s == ':' || *s == '=') {
3503             const char *start;
3504             const char *end;
3505             SV *sv;
3506
3507             if (*++s == '-') {
3508                 ++s;
3509                 sv = newSVpvs("no Devel::");
3510             } else {
3511                 sv = newSVpvs("use Devel::");
3512             }
3513
3514             start = s;
3515             end = s + strlen(s);
3516
3517             /* We now allow -d:Module=Foo,Bar and -d:-Module */
3518             while(isWORDCHAR(*s) || *s==':') ++s;
3519             if (*s != '=')
3520                 sv_catpvn(sv, start, end - start);
3521             else {
3522                 sv_catpvn(sv, start, s-start);
3523                 /* Don't use NUL as q// delimiter here, this string goes in the
3524                  * environment. */
3525                 Perl_sv_catpvf(aTHX_ sv, " split(/,/,q{%s});", ++s);
3526             }
3527             s = end;
3528             my_setenv("PERL5DB", SvPV_nolen_const(sv));
3529             SvREFCNT_dec(sv);
3530         }
3531         if (!PL_perldb) {
3532             PL_perldb = PERLDB_ALL;
3533             init_debugger();
3534         }
3535         return s;
3536     case 'D':
3537     {   
3538 #ifdef DEBUGGING
3539         forbid_setid('D', FALSE);
3540         s++;
3541         PL_debug = get_debug_opts( (const char **)&s, 1) | DEBUG_TOP_FLAG;
3542 #else /* !DEBUGGING */
3543         if (ckWARN_d(WARN_DEBUGGING))
3544             Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3545                    "Recompile perl with -DDEBUGGING to use -D switch (did you mean -d ?)\n");
3546         for (s++; isWORDCHAR(*s); s++) ;
3547 #endif
3548         return s;
3549         NOT_REACHED; /* NOTREACHED */
3550     }   
3551     case 'h':
3552         usage();
3553         NOT_REACHED; /* NOTREACHED */
3554
3555     case 'i':
3556         Safefree(PL_inplace);
3557         {
3558             const char * const start = ++s;
3559             while (*s && !isSPACE(*s))
3560                 ++s;
3561
3562             PL_inplace = savepvn(start, s - start);
3563         }
3564         return s;
3565     case 'I':   /* -I handled both here and in parse_body() */
3566         forbid_setid('I', FALSE);
3567         ++s;
3568         while (*s && isSPACE(*s))
3569             ++s;
3570         if (*s) {
3571             const char *e, *p;
3572             p = s;
3573             /* ignore trailing spaces (possibly followed by other switches) */
3574             do {
3575                 for (e = p; *e && !isSPACE(*e); e++) ;
3576                 p = e;
3577                 while (isSPACE(*p))
3578                     p++;
3579             } while (*p && *p != '-');
3580             incpush(s, e-s,
3581                     INCPUSH_ADD_SUB_DIRS|INCPUSH_ADD_OLD_VERS|INCPUSH_UNSHIFT);
3582             s = p;
3583             if (*s == '-')
3584                 s++;
3585         }
3586         else
3587             Perl_croak(aTHX_ "No directory specified for -I");
3588         return s;
3589     case 'l':
3590         PL_minus_l = TRUE;
3591         s++;
3592         if (PL_ors_sv) {
3593             SvREFCNT_dec(PL_ors_sv);
3594             PL_ors_sv = NULL;
3595         }
3596         if (isDIGIT(*s)) {
3597             I32 flags = 0;
3598             STRLEN numlen;
3599             PL_ors_sv = newSVpvs("\n");
3600             numlen = 3 + (*s == '0');
3601             *SvPVX(PL_ors_sv) = (char)grok_oct(s, &numlen, &flags, NULL);
3602             s += numlen;
3603         }
3604         else {
3605             if (RsPARA(PL_rs)) {
3606                 PL_ors_sv = newSVpvs("\n\n");
3607             }
3608             else {
3609                 PL_ors_sv = newSVsv(PL_rs);
3610             }
3611         }
3612         return s;
3613     case 'M':
3614         forbid_setid('M', FALSE);       /* XXX ? */
3615         /* FALLTHROUGH */
3616     case 'm':
3617         forbid_setid('m', FALSE);       /* XXX ? */
3618         if (*++s) {
3619             const char *start;
3620             const char *end;
3621             SV *sv;
3622             const char *use = "use ";
3623             bool colon = FALSE;
3624             /* -M-foo == 'no foo'       */
3625             /* Leading space on " no " is deliberate, to make both
3626                possibilities the same length.  */
3627             if (*s == '-') { use = " no "; ++s; }
3628             sv = newSVpvn(use,4);
3629             start = s;
3630             /* We allow -M'Module qw(Foo Bar)'  */
3631             while(isWORDCHAR(*s) || *s==':') {
3632                 if( *s++ == ':' ) {
3633                     if( *s == ':' ) 
3634                         s++;
3635                     else
3636                         colon = TRUE;
3637                 }
3638             }
3639             if (s == start)
3640                 Perl_croak(aTHX_ "Module name required with -%c option",
3641                                     option);
3642             if (colon) 
3643                 Perl_croak(aTHX_ "Invalid module name %.*s with -%c option: "
3644                                     "contains single ':'",
3645                                     (int)(s - start), start, option);
3646             end = s + strlen(s);
3647             if (*s != '=') {
3648                 sv_catpvn(sv, start, end - start);
3649                 if (option == 'm') {
3650                     if (*s != '\0')
3651                         Perl_croak(aTHX_ "Can't use '%c' after -mname", *s);
3652                     sv_catpvs( sv, " ()");
3653                 }
3654             } else {
3655                 sv_catpvn(sv, start, s-start);
3656                 /* Use NUL as q''-delimiter.  */
3657                 sv_catpvs(sv, " split(/,/,q\0");
3658                 ++s;
3659                 sv_catpvn(sv, s, end - s);
3660                 sv_catpvs(sv,  "\0)");
3661             }
3662             s = end;
3663             Perl_av_create_and_push(aTHX_ &PL_preambleav, sv);
3664         }
3665         else
3666             Perl_croak(aTHX_ "Missing argument to -%c", option);
3667         return s;
3668     case 'n':
3669         PL_minus_n = TRUE;
3670         s++;
3671         return s;
3672     case 'p':
3673         PL_minus_p = TRUE;
3674         s++;
3675         return s;
3676     case 's':
3677         forbid_setid('s', FALSE);
3678         PL_doswitches = TRUE;
3679         s++;
3680         return s;
3681     case 't':
3682     case 'T':
3683 #if defined(SILENT_NO_TAINT_SUPPORT)
3684             /* silently ignore */
3685 #elif defined(NO_TAINT_SUPPORT)
3686         Perl_croak_nocontext("This perl was compiled without taint support. "
3687                    "Cowardly refusing to run with -t or -T flags");
3688 #else
3689         if (!TAINTING_get)
3690             TOO_LATE_FOR(*s);
3691 #endif
3692         s++;
3693         return s;
3694     case 'u':
3695         PL_do_undump = TRUE;
3696         s++;
3697         return s;
3698     case 'U':
3699         PL_unsafe = TRUE;
3700         s++;
3701         return s;
3702     case 'v':
3703         minus_v();
3704     case 'w':
3705         if (! (PL_dowarn & G_WARN_ALL_MASK)) {
3706             PL_dowarn |= G_WARN_ON;
3707         }
3708         s++;
3709         return s;
3710     case 'W':
3711         PL_dowarn = G_WARN_ALL_ON|G_WARN_ON;
3712         if (!specialWARN(PL_compiling.cop_warnings))
3713             PerlMemShared_free(PL_compiling.cop_warnings);
3714         PL_compiling.cop_warnings = pWARN_ALL ;
3715         s++;
3716         return s;
3717     case 'X':
3718         PL_dowarn = G_WARN_ALL_OFF;
3719         if (!specialWARN(PL_compiling.cop_warnings))
3720             PerlMemShared_free(PL_compiling.cop_warnings);
3721         PL_compiling.cop_warnings = pWARN_NONE ;
3722         s++;
3723         return s;
3724     case '*':
3725     case ' ':
3726         while( *s == ' ' )
3727           ++s;
3728         if (s[0] == '-')        /* Additional switches on #! line. */
3729             return s+1;
3730         break;
3731     case '-':
3732     case 0:
3733 #if defined(WIN32) || !defined(PERL_STRICT_CR)
3734     case '\r':
3735 #endif
3736     case '\n':
3737     case '\t':
3738         break;
3739 #ifdef ALTERNATE_SHEBANG
3740     case 'S':                   /* OS/2 needs -S on "extproc" line. */
3741         break;
3742 #endif
3743     case 'e': case 'f': case 'x': case 'E':
3744 #ifndef ALTERNATE_SHEBANG
3745     case 'S':
3746 #endif
3747     case 'V':
3748         Perl_croak(aTHX_ "Can't emulate -%.1s on #! line",s);
3749     default:
3750         Perl_croak(aTHX_
3751             "Unrecognized switch: -%.1s  (-h will show valid options)",s
3752         );
3753     }
3754     return NULL;
3755 }
3756
3757
3758 STATIC void
3759 S_minus_v(pTHX)
3760 {
3761         PerlIO * PIO_stdout;
3762         {
3763             const char * const level_str = "v" PERL_VERSION_STRING;
3764             const STRLEN level_len = sizeof("v" PERL_VERSION_STRING)-1;
3765 #ifdef PERL_PATCHNUM
3766             SV* level;
3767 #  ifdef PERL_GIT_UNCOMMITTED_CHANGES
3768             static const char num [] = PERL_PATCHNUM "*";
3769 #  else
3770             static const char num [] = PERL_PATCHNUM;
3771 #  endif
3772             {
3773                 const STRLEN num_len = sizeof(num)-1;
3774                 /* A very advanced compiler would fold away the strnEQ
3775                    and this whole conditional, but most (all?) won't do it.
3776                    SV level could also be replaced by with preprocessor
3777                    catenation.
3778                 */
3779                 if (num_len >= level_len && strnEQ(num,level_str,level_len)) {
3780                     /* per 46807d8e80, PERL_PATCHNUM is outside of the control
3781                        of the interp so it might contain format characters
3782                     */
3783                     level = newSVpvn(num, num_len);
3784                 } else {
3785                     level = Perl_newSVpvf_nocontext("%s (%s)", level_str, num);
3786                 }
3787             }
3788 #else
3789         SV* level = newSVpvn(level_str, level_len);
3790 #endif /* #ifdef PERL_PATCHNUM */
3791         PIO_stdout =  PerlIO_stdout();
3792             PerlIO_printf(PIO_stdout,
3793                 "\nThis is perl "       STRINGIFY(PERL_REVISION)
3794                 ", version "            STRINGIFY(PERL_VERSION)
3795                 ", subversion "         STRINGIFY(PERL_SUBVERSION)
3796                 " (%" SVf ") built for "        ARCHNAME, SVfARG(level)
3797                 );
3798             SvREFCNT_dec_NN(level);
3799         }
3800 #if defined(LOCAL_PATCH_COUNT)
3801         if (LOCAL_PATCH_COUNT > 0)
3802             PerlIO_printf(PIO_stdout,
3803                           "\n(with %d registered patch%s, "
3804                           "see perl -V for more detail)",
3805                           LOCAL_PATCH_COUNT,
3806                           (LOCAL_PATCH_COUNT!=1) ? "es" : "");
3807 #endif
3808
3809         PerlIO_printf(PIO_stdout,
3810                       "\n\nCopyright 1987-2018, Larry Wall\n");
3811 #ifdef MSDOS
3812         PerlIO_printf(PIO_stdout,
3813                       "\nMS-DOS port Copyright (c) 1989, 1990, Diomidis Spinellis\n");
3814 #endif
3815 #ifdef DJGPP
3816         PerlIO_printf(PIO_stdout,
3817                       "djgpp v2 port (jpl5003c) by Hirofumi Watanabe, 1996\n"
3818                       "djgpp v2 port (perl5004+) by Laszlo Molnar, 1997-1999\n");
3819 #endif
3820 #ifdef OS2
3821         PerlIO_printf(PIO_stdout,
3822                       "\n\nOS/2 port Copyright (c) 1990, 1991, Raymond Chen, Kai Uwe Rommel\n"
3823                       "Version 5 port Copyright (c) 1994-2002, Andreas Kaiser, Ilya Zakharevich\n");
3824 #endif
3825 #ifdef OEMVS
3826         PerlIO_printf(PIO_stdout,
3827                       "MVS (OS390) port by Mortice Kern Systems, 1997-1999\n");
3828 #endif
3829 #ifdef __VOS__
3830         PerlIO_printf(PIO_stdout,
3831                       "Stratus OpenVOS port by Paul.Green@stratus.com, 1997-2013\n");
3832 #endif
3833 #ifdef POSIX_BC
3834         PerlIO_printf(PIO_stdout,
3835                       "BS2000 (POSIX) port by Start Amadeus GmbH, 1998-1999\n");
3836 #endif
3837 #ifdef UNDER_CE
3838         PerlIO_printf(PIO_stdout,
3839                         "WINCE port by Rainer Keuchel, 2001-2002\n"
3840                         "Built on " __DATE__ " " __TIME__ "\n\n");
3841         wce_hitreturn();
3842 #endif
3843 #ifdef __SYMBIAN32__
3844         PerlIO_printf(PIO_stdout,
3845                       "Symbian port by Nokia, 2004-2005\n");
3846 #endif
3847 #ifdef BINARY_BUILD_NOTICE
3848         BINARY_BUILD_NOTICE;
3849 #endif
3850         PerlIO_printf(PIO_stdout,
3851                       "\n\
3852 Perl may be copied only under the terms of either the Artistic License or the\n\
3853 GNU General Public License, which may be found in the Perl 5 source kit.\n\n\
3854 Complete documentation for Perl, including FAQ lists, should be found on\n\
3855 this system using \"man perl\" or \"perldoc perl\".  If you have access to the\n\
3856 Internet, point your browser at http://www.perl.org/, the Perl Home Page.\n\n");
3857         my_exit(0);
3858 }
3859
3860 /* compliments of Tom Christiansen */
3861
3862 /* unexec() can be found in the Gnu emacs distribution */
3863 /* Known to work with -DUNEXEC and using unexelf.c from GNU emacs-20.2 */
3864
3865 #ifdef VMS
3866 #include <lib$routines.h>
3867 #endif
3868
3869 void
3870 Perl_my_unexec(pTHX)
3871 {
3872 #ifdef UNEXEC
3873     SV *    prog = newSVpv(BIN_EXP, 0);
3874     SV *    file = newSVpv(PL_origfilename, 0);
3875     int    status = 1;
3876     extern int etext;
3877
3878     sv_catpvs(prog, "/perl");
3879     sv_catpvs(file, ".perldump");
3880
3881     unexec(SvPVX(file), SvPVX(prog), &etext, sbrk(0), 0);
3882     /* unexec prints msg to stderr in case of failure */
3883     PerlProc_exit(status);
3884 #else
3885     PERL_UNUSED_CONTEXT;
3886 #  ifdef VMS
3887      lib$signal(SS$_DEBUG);  /* ssdef.h #included from vmsish.h */
3888 #  elif defined(WIN32) || defined(__CYGWIN__)
3889     Perl_croak_nocontext("dump is not supported");
3890 #  else
3891     ABORT();            /* for use with undump */
3892 #  endif
3893 #endif
3894 }
3895
3896 /* initialize curinterp */
3897 STATIC void
3898 S_init_interp(pTHX)
3899 {
3900 #ifdef MULTIPLICITY
3901 #  define PERLVAR(prefix,var,type)
3902 #  define PERLVARA(prefix,var,n,type)
3903 #  if defined(PERL_IMPLICIT_CONTEXT)
3904 #    define PERLVARI(prefix,var,type,init)      aTHX->prefix##var = init;
3905 #    define PERLVARIC(prefix,var,type,init)     aTHX->prefix##var = init;
3906 #  else
3907 #    define PERLVARI(prefix,var,type,init)      PERL_GET_INTERP->var = init;
3908 #    define PERLVARIC(prefix,var,type,init)     PERL_GET_INTERP->var = init;
3909 #  endif
3910 #  include "intrpvar.h"
3911 #  undef PERLVAR
3912 #  undef PERLVARA
3913 #  undef PERLVARI
3914 #  undef PERLVARIC
3915 #else
3916 #  define PERLVAR(prefix,var,type)
3917 #  define PERLVARA(prefix,var,n,type)
3918 #  define PERLVARI(prefix,var,type,init)        PL_##var = init;
3919 #  define PERLVARIC(prefix,var,type,init)       PL_##var = init;
3920 #  include "intrpvar.h"
3921 #  undef PERLVAR
3922 #  undef PERLVARA
3923 #  undef PERLVARI
3924 #  undef PERLVARIC
3925 #endif
3926
3927 }
3928
3929 STATIC void
3930 S_init_main_stash(pTHX)
3931 {
3932     GV *gv;
3933     HV *hv = newHV();
3934
3935     PL_curstash = PL_defstash = (HV *)SvREFCNT_inc_simple_NN(hv);
3936     /* We know that the string "main" will be in the global shared string
3937        table, so it's a small saving to use it rather than allocate another
3938        8 bytes.  */
3939     PL_curstname = newSVpvs_share("main");
3940     gv = gv_fetchpvs("main::", GV_ADD|GV_NOTQUAL, SVt_PVHV);
3941     /* If we hadn't caused another reference to "main" to be in the shared
3942        string table above, then it would be worth reordering these two,
3943        because otherwise all we do is delete "main" from it as a consequence
3944        of the SvREFCNT_dec, only to add it again with hv_name_set */
3945     SvREFCNT_dec(GvHV(gv));
3946     hv_name_sets(PL_defstash, "main", 0);
3947     GvHV(gv) = MUTABLE_HV(SvREFCNT_inc_simple(PL_defstash));
3948     SvREADONLY_on(gv);
3949     PL_incgv = gv_HVadd(gv_AVadd(gv_fetchpvs("INC", GV_ADD|GV_NOTQUAL,
3950                                              SVt_PVAV)));
3951     SvREFCNT_inc_simple_void(PL_incgv); /* Don't allow it to be freed */
3952     GvMULTI_on(PL_incgv);
3953     PL_hintgv = gv_fetchpvs("\010", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^H */
3954     SvREFCNT_inc_simple_void(PL_hintgv);
3955     GvMULTI_on(PL_hintgv);
3956     PL_defgv = gv_fetchpvs("_", GV_ADD|GV_NOTQUAL, SVt_PVAV);
3957     SvREFCNT_inc_simple_void(PL_defgv);
3958     PL_errgv = gv_fetchpvs("@", GV_ADD|GV_NOTQUAL, SVt_PV);
3959     SvREFCNT_inc_simple_void(PL_errgv);
3960     GvMULTI_on(PL_errgv);
3961     PL_replgv = gv_fetchpvs("\022", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^R */
3962     SvREFCNT_inc_simple_void(PL_replgv);
3963     GvMULTI_on(PL_replgv);
3964     (void)Perl_form(aTHX_ "%240s","");  /* Preallocate temp - for immediate signals. */
3965 #ifdef PERL_DONT_CREATE_GVSV
3966     (void)gv_SVadd(PL_errgv);
3967 #endif
3968     sv_grow(ERRSV, 240);        /* Preallocate - for immediate signals. */
3969     CLEAR_ERRSV();
3970     CopSTASH_set(&PL_compiling, PL_defstash);
3971     PL_debstash = GvHV(gv_fetchpvs("DB::", GV_ADDMULTI, SVt_PVHV));
3972     PL_globalstash = GvHV(gv_fetchpvs("CORE::GLOBAL::", GV_ADDMULTI,
3973                                       SVt_PVHV));
3974     /* We must init $/ before switches are processed. */
3975     sv_setpvs(get_sv("/", GV_ADD), "\n");
3976 }
3977
3978 STATIC PerlIO *
3979 S_open_script(pTHX_ const char *scriptname, bool dosearch, bool *suidscript)
3980 {
3981     int fdscript = -1;
3982     PerlIO *rsfp = NULL;
3983     Stat_t tmpstatbuf;
3984     int fd;
3985
3986     PERL_ARGS_ASSERT_OPEN_SCRIPT;
3987
3988     if (PL_e_script) {
3989         PL_origfilename = savepvs("-e");
3990     }
3991     else {
3992         const char *s;
3993         UV uv;
3994         /* if find_script() returns, it returns a malloc()-ed value */
3995         scriptname = PL_origfilename = find_script(scriptname, dosearch, NULL, 1);
3996
3997         if (strBEGINs(scriptname, "/dev/fd/")
3998             && isDIGIT(scriptname[8])
3999             && grok_atoUV(scriptname + 8, &uv, &s)
4000             && uv <= PERL_INT_MAX
4001         ) {
4002             fdscript = (int)uv;
4003             if (*s) {
4004                 /* PSz 18 Feb 04
4005                  * Tell apart "normal" usage of fdscript, e.g.
4006                  * with bash on FreeBSD:
4007                  *   perl <( echo '#!perl -DA'; echo 'print "$0\n"')
4008                  * from usage in suidperl.
4009                  * Does any "normal" usage leave garbage after the number???
4010                  * Is it a mistake to use a similar /dev/fd/ construct for
4011                  * suidperl?
4012                  */
4013                 *suidscript = TRUE;
4014                 /* PSz 20 Feb 04  
4015                  * Be supersafe and do some sanity-checks.
4016                  * Still, can we be sure we got the right thing?
4017                  */
4018                 if (*s != '/') {
4019                     Perl_croak(aTHX_ "Wrong syntax (suid) fd script name \"%s\"\n", s);
4020                 }
4021                 if (! *(s+1)) {
4022                     Perl_croak(aTHX_ "Missing (suid) fd script name\n");
4023                 }
4024                 scriptname = savepv(s + 1);
4025                 Safefree(PL_origfilename);
4026                 PL_origfilename = (char *)scriptname;
4027             }
4028         }
4029     }
4030
4031     CopFILE_free(PL_curcop);
4032     CopFILE_set(PL_curcop, PL_origfilename);
4033     if (*PL_origfilename == '-' && PL_origfilename[1] == '\0')
4034         scriptname = (char *)"";
4035     if (fdscript >= 0) {
4036         rsfp = PerlIO_fdopen(fdscript,PERL_SCRIPT_MODE);
4037     }
4038     else if (!*scriptname) {
4039         forbid_setid(0, *suidscript);
4040         return NULL;
4041     }
4042     else {
4043 #ifdef FAKE_BIT_BUCKET
4044         /* This hack allows one not to have /dev/null (or BIT_BUCKET as it
4045          * is called) and still have the "-e" work.  (Believe it or not,
4046          * a /dev/null is required for the "-e" to work because source
4047          * filter magic is used to implement it. ) This is *not* a general
4048          * replacement for a /dev/null.  What we do here is create a temp
4049          * file (an empty file), open up that as the script, and then
4050          * immediately close and unlink it.  Close enough for jazz. */ 
4051 #define FAKE_BIT_BUCKET_PREFIX "/tmp/perlnull-"
4052 #define FAKE_BIT_BUCKET_SUFFIX "XXXXXXXX"
4053 #define FAKE_BIT_BUCKET_TEMPLATE FAKE_BIT_BUCKET_PREFIX FAKE_BIT_BUCKET_SUFFIX
4054         char tmpname[sizeof(FAKE_BIT_BUCKET_TEMPLATE)] = {
4055             FAKE_BIT_BUCKET_TEMPLATE
4056         };
4057         const char * const err = "Failed to create a fake bit bucket";
4058         if (strEQ(scriptname, BIT_BUCKET)) {
4059             int tmpfd = Perl_my_mkstemp_cloexec(tmpname);
4060             if (tmpfd > -1) {
4061                 scriptname = tmpname;
4062                 close(tmpfd);
4063             } else
4064                 Perl_croak(aTHX_ err);
4065         }
4066 #endif
4067         rsfp = PerlIO_open(scriptname,PERL_SCRIPT_MODE);
4068 #ifdef FAKE_BIT_BUCKET
4069         if (   strBEGINs(scriptname, FAKE_BIT_BUCKET_PREFIX)
4070             && strlen(scriptname) == sizeof(tmpname) - 1)
4071         {
4072             unlink(scriptname);
4073         }
4074         scriptname = BIT_BUCKET;
4075 #endif
4076     }
4077     if (!rsfp) {
4078         /* PSz 16 Sep 03  Keep neat error message */
4079         if (PL_e_script)
4080             Perl_croak(aTHX_ "Can't open " BIT_BUCKET ": %s\n", Strerror(errno));
4081         else
4082             Perl_croak(aTHX_ "Can't open perl script \"%s\": %s\n",
4083                     CopFILE(PL_curcop), Strerror(errno));
4084     }
4085     fd = PerlIO_fileno(rsfp);
4086
4087     if (fd < 0 ||
4088         (PerlLIO_fstat(fd, &tmpstatbuf) >= 0
4089          && S_ISDIR(tmpstatbuf.st_mode)))
4090         Perl_croak(aTHX_ "Can't open perl script \"%s\": %s\n",
4091             CopFILE(PL_curcop),
4092             Strerror(EISDIR));
4093
4094     return rsfp;
4095 }
4096
4097 /* In the days of suidperl, we refused to execute a setuid script stored on
4098  * a filesystem mounted nosuid and/or noexec. This meant that we probed for the
4099  * existence of the appropriate filesystem-statting function, and behaved
4100  * accordingly. But even though suidperl is long gone, we must still include
4101  * those probes for the benefit of modules like Filesys::Df, which expect the
4102  * results of those probes to be stored in %Config; see RT#126368. So mention
4103  * the relevant cpp symbols here, to ensure that metaconfig will include their
4104  * probes in the generated Configure:
4105  *
4106  * I_SYSSTATVFS HAS_FSTATVFS
4107  * I_SYSMOUNT
4108  * I_STATFS     HAS_FSTATFS     HAS_GETFSSTAT
4109  * I_MNTENT     HAS_GETMNTENT   HAS_HASMNTOPT
4110  */
4111
4112
4113 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
4114 /* Don't even need this function.  */
4115 #else
4116 STATIC void
4117 S_validate_suid(pTHX_ PerlIO *rsfp)
4118 {
4119     const Uid_t  my_uid = PerlProc_getuid();
4120     const Uid_t my_euid = PerlProc_geteuid();
4121     const Gid_t  my_gid = PerlProc_getgid();
4122     const Gid_t my_egid = PerlProc_getegid();
4123
4124     PERL_ARGS_ASSERT_VALIDATE_SUID;
4125
4126     if (my_euid != my_uid || my_egid != my_gid) {       /* (suidperl doesn't exist, in fact) */
4127         dVAR;
4128         int fd = PerlIO_fileno(rsfp);
4129         Stat_t statbuf;
4130         if (fd < 0 || PerlLIO_fstat(fd, &statbuf) < 0) { /* may be either wrapped or real suid */
4131             Perl_croak_nocontext( "Illegal suidscript");
4132         }
4133         if ((my_euid != my_uid && my_euid == statbuf.st_uid && statbuf.st_mode & S_ISUID)
4134             ||
4135             (my_egid != my_gid && my_egid == statbuf.st_gid && statbuf.st_mode & S_ISGID)
4136             )
4137             if (!PL_do_undump)
4138                 Perl_croak(aTHX_ "YOU HAVEN'T DISABLED SET-ID SCRIPTS IN THE KERNEL YET!\n\
4139 FIX YOUR KERNEL, PUT A C WRAPPER AROUND THIS SCRIPT, OR USE -u AND UNDUMP!\n");
4140         /* not set-id, must be wrapped */
4141     }
4142 }
4143 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4144
4145 STATIC void
4146 S_find_beginning(pTHX_ SV* linestr_sv, PerlIO *rsfp)
4147 {
4148     const char *s;
4149     const char *s2;
4150
4151     PERL_ARGS_ASSERT_FIND_BEGINNING;
4152
4153     /* skip forward in input to the real script? */
4154
4155     do {
4156         if ((s = sv_gets(linestr_sv, rsfp, 0)) == NULL)
4157             Perl_croak(aTHX_ "No Perl script found in input\n");
4158         s2 = s;
4159     } while (!(*s == '#' && s[1] == '!' && ((s = instr(s,"perl")) || (s = instr(s2,"PERL")))));
4160     PerlIO_ungetc(rsfp, '\n');          /* to keep line count right */
4161     while (*s && !(isSPACE (*s) || *s == '#')) s++;
4162     s2 = s;
4163     while (*s == ' ' || *s == '\t') s++;
4164     if (*s++ == '-') {
4165         while (isDIGIT(s2[-1]) || s2[-1] == '-' || s2[-1] == '.'
4166                || s2[-1] == '_') s2--;
4167         if (strBEGINs(s2-4,"perl"))
4168             while ((s = moreswitches(s)))
4169                 ;
4170     }
4171 }
4172
4173
4174 STATIC void
4175 S_init_ids(pTHX)
4176 {
4177     /* no need to do anything here any more if we don't
4178      * do tainting. */
4179 #ifndef NO_TAINT_SUPPORT
4180     const Uid_t my_uid = PerlProc_getuid();
4181     const Uid_t my_euid = PerlProc_geteuid();
4182     const Gid_t my_gid = PerlProc_getgid();
4183     const Gid_t my_egid = PerlProc_getegid();
4184
4185     PERL_UNUSED_CONTEXT;
4186
4187     /* Should not happen: */
4188     CHECK_MALLOC_TAINT(my_uid && (my_euid != my_uid || my_egid != my_gid));
4189     TAINTING_set( TAINTING_get | (my_uid && (my_euid != my_uid || my_egid != my_gid)) );
4190 #endif
4191     /* BUG */
4192     /* PSz 27 Feb 04
4193      * Should go by suidscript, not uid!=euid: why disallow
4194      * system("ls") in scripts run from setuid things?
4195      * Or, is this run before we check arguments and set suidscript?
4196      * What about SETUID_SCRIPTS_ARE_SECURE_NOW: could we use fdscript then?
4197      * (We never have suidscript, can we be sure to have fdscript?)
4198      * Or must then go by UID checks? See comments in forbid_setid also.
4199      */
4200 }
4201
4202 /* This is used very early in the lifetime of the program,
4203  * before even the options are parsed, so PL_tainting has
4204  * not been initialized properly.  */
4205 bool
4206 Perl_doing_taint(int argc, char *argv[], char *envp[])
4207 {
4208 #ifndef PERL_IMPLICIT_SYS
4209     /* If we have PERL_IMPLICIT_SYS we can't call getuid() et alia
4210      * before we have an interpreter-- and the whole point of this
4211      * function is to be called at such an early stage.  If you are on
4212      * a system with PERL_IMPLICIT_SYS but you do have a concept of
4213      * "tainted because running with altered effective ids', you'll
4214      * have to add your own checks somewhere in here.  The two most
4215      * known samples of 'implicitness' are Win32 and NetWare, neither
4216      * of which has much of concept of 'uids'. */
4217     Uid_t uid  = PerlProc_getuid();
4218     Uid_t euid = PerlProc_geteuid();
4219     Gid_t gid  = PerlProc_getgid();
4220     Gid_t egid = PerlProc_getegid();
4221     (void)envp;
4222
4223 #ifdef VMS
4224     uid  |=  gid << 16;
4225     euid |= egid << 16;
4226 #endif
4227     if (uid && (euid != uid || egid != gid))
4228         return 1;
4229 #endif /* !PERL_IMPLICIT_SYS */
4230     /* This is a really primitive check; environment gets ignored only
4231      * if -T are the first chars together; otherwise one gets
4232      *  "Too late" message. */
4233     if ( argc > 1 && argv[1][0] == '-'
4234          && isALPHA_FOLD_EQ(argv[1][1], 't'))
4235         return 1;
4236     return 0;
4237 }
4238
4239 /* Passing the flag as a single char rather than a string is a slight space
4240    optimisation.  The only message that isn't /^-.$/ is
4241    "program input from stdin", which is substituted in place of '\0', which
4242    could never be a command line flag.  */
4243 STATIC void
4244 S_forbid_setid(pTHX_ const char flag, const bool suidscript) /* g */
4245 {
4246     char string[3] = "-x";
4247     const char *message = "program input from stdin";
4248
4249     PERL_UNUSED_CONTEXT;
4250     if (flag) {
4251         string[1] = flag;
4252         message = string;
4253     }
4254
4255 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
4256     if (PerlProc_getuid() != PerlProc_geteuid())
4257         Perl_croak(aTHX_ "No %s allowed while running setuid", message);
4258     if (PerlProc_getgid() != PerlProc_getegid())
4259         Perl_croak(aTHX_ "No %s allowed while running setgid", message);
4260 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4261     if (suidscript)
4262         Perl_croak(aTHX_ "No %s allowed with (suid) fdscript", message);
4263 }
4264
4265 void
4266 Perl_init_dbargs(pTHX)
4267 {
4268     AV *const args = PL_dbargs = GvAV(gv_AVadd((gv_fetchpvs("DB::args",
4269                                                             GV_ADDMULTI,
4270                                                             SVt_PVAV))));
4271
4272     if (AvREAL(args)) {
4273         /* Someone has already created it.
4274            It might have entries, and if we just turn off AvREAL(), they will
4275            "leak" until global destruction.  */
4276         av_clear(args);
4277         if (SvTIED_mg((const SV *)args, PERL_MAGIC_tied))
4278             Perl_croak(aTHX_ "Cannot set tied @DB::args");
4279     }
4280     AvREIFY_only(PL_dbargs);
4281 }
4282
4283 void
4284 Perl_init_debugger(pTHX)
4285 {
4286     HV * const ostash = PL_curstash;
4287     MAGIC *mg;
4288
4289     PL_curstash = (HV *)SvREFCNT_inc_simple(PL_debstash);
4290
4291     Perl_init_dbargs(aTHX);
4292     PL_DBgv = MUTABLE_GV(
4293         SvREFCNT_inc(gv_fetchpvs("DB::DB", GV_ADDMULTI, SVt_PVGV))
4294     );
4295     PL_DBline = MUTABLE_GV(
4296         SvREFCNT_inc(gv_fetchpvs("DB::dbline", GV_ADDMULTI, SVt_PVAV))
4297     );
4298     PL_DBsub = MUTABLE_GV(SvREFCNT_inc(
4299         gv_HVadd(gv_fetchpvs("DB::sub", GV_ADDMULTI, SVt_PVHV))
4300     ));
4301     PL_DBsingle = GvSV((gv_fetchpvs("DB::single", GV_ADDMULTI, SVt_PV)));
4302     if (!SvIOK(PL_DBsingle))
4303         sv_setiv(PL_DBsingle, 0);
4304     mg = sv_magicext(PL_DBsingle, NULL, PERL_MAGIC_debugvar, &PL_vtbl_debugvar, 0, 0);
4305     mg->mg_private = DBVARMG_SINGLE;
4306     SvSETMAGIC(PL_DBsingle);
4307
4308     PL_DBtrace = GvSV((gv_fetchpvs("DB::trace", GV_ADDMULTI, SVt_PV)));
4309     if (!SvIOK(PL_DBtrace))
4310         sv_setiv(PL_DBtrace, 0);
4311     mg = sv_magicext(PL_DBtrace, NULL, PERL_MAGIC_debugvar, &PL_vtbl_debugvar, 0, 0);
4312     mg->mg_private = DBVARMG_TRACE;
4313     SvSETMAGIC(PL_DBtrace);
4314
4315     PL_DBsignal = GvSV((gv_fetchpvs("DB::signal", GV_ADDMULTI, SVt_PV)));
4316     if (!SvIOK(PL_DBsignal))
4317         sv_setiv(PL_DBsignal, 0);
4318     mg = sv_magicext(PL_DBsignal, NULL, PERL_MAGIC_debugvar, &PL_vtbl_debugvar, 0, 0);
4319     mg->mg_private = DBVARMG_SIGNAL;
4320     SvSETMAGIC(PL_DBsignal);
4321
4322     SvREFCNT_dec(PL_curstash);
4323     PL_curstash = ostash;
4324 }
4325
4326 #ifndef STRESS_REALLOC
4327 #define REASONABLE(size) (size)
4328 #define REASONABLE_but_at_least(size,min) (size)
4329 #else
4330 #define REASONABLE(size) (1) /* unreasonable */
4331 #define REASONABLE_but_at_least(size,min) (min)
4332 #endif
4333
4334 void
4335 Perl_init_stacks(pTHX)
4336 {
4337     SSize_t size;
4338
4339     /* start with 128-item stack and 8K cxstack */
4340     PL_curstackinfo = new_stackinfo(REASONABLE(128),
4341                                  REASONABLE(8192/sizeof(PERL_CONTEXT) - 1));
4342     PL_curstackinfo->si_type = PERLSI_MAIN;
4343 #if defined DEBUGGING && !defined DEBUGGING_RE_ONLY
4344     PL_curstackinfo->si_stack_hwm = 0;
4345 #endif
4346     PL_curstack = PL_curstackinfo->si_stack;
4347     PL_mainstack = PL_curstack;         /* remember in case we switch stacks */
4348
4349     PL_stack_base = AvARRAY(PL_curstack);
4350     PL_stack_sp = PL_stack_base;
4351     PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
4352
4353     Newx(PL_tmps_stack,REASONABLE(128),SV*);
4354     PL_tmps_floor = -1;
4355     PL_tmps_ix = -1;
4356     PL_tmps_max = REASONABLE(128);
4357
4358     Newx(PL_markstack,REASONABLE(32),I32);
4359     PL_markstack_ptr = PL_markstack;
4360     PL_markstack_max = PL_markstack + REASONABLE(32);
4361
4362     SET_MARK_OFFSET;
4363
4364     Newx(PL_scopestack,REASONABLE(32),I32);
4365 #ifdef DEBUGGING
4366     Newx(PL_scopestack_name,REASONABLE(32),const char*);
4367 #endif
4368     PL_scopestack_ix = 0;
4369     PL_scopestack_max = REASONABLE(32);
4370
4371     size = REASONABLE_but_at_least(128,SS_MAXPUSH);
4372     Newx(PL_savestack, size, ANY);
4373     PL_savestack_ix = 0;
4374     /*PL_savestack_max lies: it always has SS_MAXPUSH more than it claims */
4375     PL_savestack_max = size - SS_MAXPUSH;
4376 }
4377
4378 #undef REASONABLE
4379
4380 STATIC void
4381 S_nuke_stacks(pTHX)
4382 {
4383     while (PL_curstackinfo->si_next)
4384         PL_curstackinfo = PL_curstackinfo->si_next;
4385     while (PL_curstackinfo) {
4386         PERL_SI *p = PL_curstackinfo->si_prev;
4387         /* curstackinfo->si_stack got nuked by sv_free_arenas() */
4388         Safefree(PL_curstackinfo->si_cxstack);
4389         Safefree(PL_curstackinfo);
4390         PL_curstackinfo = p;
4391     }
4392     Safefree(PL_tmps_stack);
4393     Safefree(PL_markstack);
4394     Safefree(PL_scopestack);
4395 #ifdef DEBUGGING
4396     Safefree(PL_scopestack_name);
4397 #endif
4398     Safefree(PL_savestack);
4399 }
4400
4401 void
4402 Perl_populate_isa(pTHX_ const char *name, STRLEN len, ...)
4403 {
4404     GV *const gv = gv_fetchpvn(name, len, GV_ADD | GV_ADDMULTI, SVt_PVAV);
4405     AV *const isa = GvAVn(gv);
4406     va_list args;
4407
4408     PERL_ARGS_ASSERT_POPULATE_ISA;
4409
4410     if(AvFILLp(isa) != -1)
4411         return;
4412
4413     /* NOTE: No support for tied ISA */
4414
4415     va_start(args, len);
4416     do {
4417         const char *const parent = va_arg(args, const char*);
4418         size_t parent_len;
4419
4420         if (!parent)
4421             break;
4422         parent_len = va_arg(args, size_t);
4423
4424         /* Arguments are supplied with a trailing ::  */
4425         assert(parent_len > 2);
4426         assert(parent[parent_len - 1] == ':');
4427         assert(parent[parent_len - 2] == ':');
4428         av_push(isa, newSVpvn(parent, parent_len - 2));
4429         (void) gv_fetchpvn(parent, parent_len, GV_ADD, SVt_PVGV);
4430     } while (1);
4431     va_end(args);
4432 }
4433
4434
4435 STATIC void
4436 S_init_predump_symbols(pTHX)
4437 {
4438     GV *tmpgv;
4439     IO *io;
4440
4441     sv_setpvs(get_sv("\"", GV_ADD), " ");
4442     PL_ofsgv = (GV*)SvREFCNT_inc(gv_fetchpvs(",", GV_ADD|GV_NOTQUAL, SVt_PV));
4443
4444
4445     /* Historically, PVIOs were blessed into IO::Handle, unless
4446        FileHandle was loaded, in which case they were blessed into
4447        that. Action at a distance.
4448        However, if we simply bless into IO::Handle, we break code
4449        that assumes that PVIOs will have (among others) a seek
4450        method. IO::File inherits from IO::Handle and IO::Seekable,
4451        and provides the needed methods. But if we simply bless into
4452        it, then we break code that assumed that by loading
4453        IO::Handle, *it* would work.
4454        So a compromise is to set up the correct @IO::File::ISA,
4455        so that code that does C<use IO::Handle>; will still work.
4456     */
4457                    
4458     Perl_populate_isa(aTHX_ STR_WITH_LEN("IO::File::ISA"),
4459                       STR_WITH_LEN("IO::Handle::"),
4460                       STR_WITH_LEN("IO::Seekable::"),
4461                       STR_WITH_LEN("Exporter::"),
4462                       NULL);
4463
4464     PL_stdingv = gv_fetchpvs("STDIN", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4465     GvMULTI_on(PL_stdingv);
4466     io = GvIOp(PL_stdingv);
4467     IoTYPE(io) = IoTYPE_RDONLY;
4468     IoIFP(io) = PerlIO_stdin();
4469     tmpgv = gv_fetchpvs("stdin", GV_ADD|GV_NOTQUAL, SVt_PV);
4470     GvMULTI_on(tmpgv);
4471     GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4472
4473     tmpgv = gv_fetchpvs("STDOUT", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4474     GvMULTI_on(tmpgv);
4475     io = GvIOp(tmpgv);
4476     IoTYPE(io) = IoTYPE_WRONLY;
4477     IoOFP(io) = IoIFP(io) = PerlIO_stdout();
4478     setdefout(tmpgv);
4479     tmpgv = gv_fetchpvs("stdout", GV_ADD|GV_NOTQUAL, SVt_PV);
4480     GvMULTI_on(tmpgv);
4481     GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4482
4483     PL_stderrgv = gv_fetchpvs("STDERR", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4484     GvMULTI_on(PL_stderrgv);
4485     io = GvIOp(PL_stderrgv);
4486     IoTYPE(io) = IoTYPE_WRONLY;
4487     IoOFP(io) = IoIFP(io) = PerlIO_stderr();
4488     tmpgv = gv_fetchpvs("stderr", GV_ADD|GV_NOTQUAL, SVt_PV);
4489     GvMULTI_on(tmpgv);
4490     GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4491
4492     PL_statname = newSVpvs("");         /* last filename we did stat on */
4493 }
4494
4495 void
4496 Perl_init_argv_symbols(pTHX_ int argc, char **argv)
4497 {
4498     PERL_ARGS_ASSERT_INIT_ARGV_SYMBOLS;
4499
4500     argc--,argv++;      /* skip name of script */
4501     if (PL_doswitches) {
4502         for (; argc > 0 && **argv == '-'; argc--,argv++) {
4503             char *s;
4504             if (!argv[0][1])
4505                 break;
4506             if (argv[0][1] == '-' && !argv[0][2]) {
4507                 argc--,argv++;
4508                 break;
4509             }
4510             if ((s = strchr(argv[0], '='))) {
4511                 const char *const start_name = argv[0] + 1;
4512                 sv_setpv(GvSV(gv_fetchpvn_flags(start_name, s - start_name,
4513                                                 TRUE, SVt_PV)), s + 1);
4514             }
4515             else
4516                 sv_setiv(GvSV(gv_fetchpv(argv[0]+1, GV_ADD, SVt_PV)),1);
4517         }
4518     }
4519     if ((PL_argvgv = gv_fetchpvs("ARGV", GV_ADD|GV_NOTQUAL, SVt_PVAV))) {
4520         SvREFCNT_inc_simple_void_NN(PL_argvgv);
4521         GvMULTI_on(PL_argvgv);
4522         av_clear(GvAVn(PL_argvgv));
4523         for (; argc > 0; argc--,argv++) {
4524             SV * const sv = newSVpv(argv[0],0);
4525             av_push(GvAV(PL_argvgv),sv);
4526             if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
4527                  if (PL_unicode & PERL_UNICODE_ARGV_FLAG)
4528                       SvUTF8_on(sv);
4529             }
4530             if (PL_unicode & PERL_UNICODE_WIDESYSCALLS_FLAG) /* Sarathy? */
4531                  (void)sv_utf8_decode(sv);
4532         }
4533     }
4534
4535     if (PL_inplace && (!PL_argvgv || AvFILL(GvAV(PL_argvgv)) == -1))
4536         Perl_ck_warner_d(aTHX_ packWARN(WARN_INPLACE),
4537                          "-i used with no filenames on the command line, "
4538                          "reading from STDIN");
4539 }
4540
4541 STATIC void
4542 S_init_postdump_symbols(pTHX_ int argc, char **argv, char **env)
4543 {
4544 #ifdef USE_ITHREADS
4545     dVAR;
4546 #endif
4547     GV* tmpgv;
4548
4549     PERL_ARGS_ASSERT_INIT_POSTDUMP_SYMBOLS;
4550
4551     PL_toptarget = newSV_type(SVt_PVIV);
4552     SvPVCLEAR(PL_toptarget);
4553     PL_bodytarget = newSV_type(SVt_PVIV);
4554     SvPVCLEAR(PL_bodytarget);
4555     PL_formtarget = PL_bodytarget;
4556
4557     TAINT;
4558
4559     init_argv_symbols(argc,argv);
4560
4561     if ((tmpgv = gv_fetchpvs("0", GV_ADD|GV_NOTQUAL, SVt_PV))) {
4562         sv_setpv(GvSV(tmpgv),PL_origfilename);
4563     }
4564     if ((PL_envgv = gv_fetchpvs("ENV", GV_ADD|GV_NOTQUAL, SVt_PVHV))) {
4565         HV *hv;
4566         bool env_is_not_environ;
4567         SvREFCNT_inc_simple_void_NN(PL_envgv);
4568         GvMULTI_on(PL_envgv);
4569         hv = GvHVn(PL_envgv);
4570         hv_magic(hv, NULL, PERL_MAGIC_env);
4571 #ifndef PERL_MICRO
4572 #ifdef USE_ENVIRON_ARRAY
4573         /* Note that if the supplied env parameter is actually a copy
4574            of the global environ then it may now point to free'd memory
4575            if the environment has been modified since. To avoid this
4576            problem we treat env==NULL as meaning 'use the default'
4577         */
4578         if (!env)
4579             env = environ;
4580         env_is_not_environ = env != environ;
4581         if (env_is_not_environ
4582 #  ifdef USE_ITHREADS
4583             && PL_curinterp == aTHX
4584 #  endif
4585            )
4586         {
4587             environ[0] = NULL;
4588         }
4589         if (env) {
4590           char *s, *old_var;
4591           STRLEN nlen;
4592           SV *sv;
4593           HV *dups = newHV();
4594
4595           for (; *env; env++) {
4596             old_var = *env;
4597
4598             if (!(s = strchr(old_var,'=')) || s == old_var)
4599                 continue;
4600             nlen = s - old_var;
4601
4602 #if defined(MSDOS) && !defined(DJGPP)
4603             *s = '\0';
4604             (void)strupr(old_var);
4605             *s = '=';
4606 #endif
4607             if (hv_exists(hv, old_var, nlen)) {
4608                 const char *name = savepvn(old_var, nlen);
4609
4610                 /* make sure we use the same value as getenv(), otherwise code that
4611                    uses getenv() (like setlocale()) might see a different value to %ENV
4612                  */
4613                 sv = newSVpv(PerlEnv_getenv(name), 0);
4614
4615                 /* keep a count of the dups of this name so we can de-dup environ later */
4616                 if (hv_exists(dups, name, nlen))
4617                     ++SvIVX(*hv_fetch(dups, name, nlen, 0));
4618                 else
4619                     (void)hv_store(dups, name, nlen, newSViv(1), 0);
4620
4621                 Safefree(name);
4622             }
4623             else {
4624                 sv = newSVpv(s+1, 0);
4625             }
4626             (void)hv_store(hv, old_var, nlen, sv, 0);
4627             if (env_is_not_environ)
4628                 mg_set(sv);
4629           }
4630           if (HvKEYS(dups)) {
4631               /* environ has some duplicate definitions, remove them */
4632               HE *entry;
4633               hv_iterinit(dups);
4634               while ((entry = hv_iternext_flags(dups, 0))) {
4635                   STRLEN nlen;
4636                   const char *name = HePV(entry, nlen);
4637                   IV count = SvIV(HeVAL(entry));
4638                   IV i;
4639                   SV **valp = hv_fetch(hv, name, nlen, 0);
4640
4641                   assert(valp);
4642
4643                   /* try to remove any duplicate names, depending on the
4644                    * implementation used in my_setenv() the iteration might
4645                    * not be necessary, but let's be safe.
4646                    */
4647                   for (i = 0; i < count; ++i)
4648                       my_setenv(name, 0);
4649
4650                   /* and set it back to the value we set $ENV{name} to */
4651                   my_setenv(name, SvPV_nolen(*valp));
4652               }
4653           }
4654           SvREFCNT_dec_NN(dups);
4655       }
4656 #endif /* USE_ENVIRON_ARRAY */
4657 #endif /* !PERL_MICRO */
4658     }
4659     TAINT_NOT;
4660
4661     /* touch @F array to prevent spurious warnings 20020415 MJD */
4662     if (PL_minus_a) {
4663       (void) get_av("main::F", GV_ADD | GV_ADDMULTI);
4664     }
4665 }
4666
4667 STATIC void
4668 S_init_perllib(pTHX)
4669 {
4670 #ifndef VMS
4671     const char *perl5lib = NULL;
4672 #endif
4673     const char *s;
4674 #if defined(WIN32) && !defined(PERL_IS_MINIPERL)
4675     STRLEN len;
4676 #endif
4677
4678     if (!TAINTING_get) {
4679 #ifndef VMS
4680         perl5lib = PerlEnv_getenv("PERL5LIB");
4681 /*
4682  * It isn't possible to delete an environment variable with
4683  * PERL_USE_SAFE_PUTENV set unless unsetenv() is also available, so in that
4684  * case we treat PERL5LIB as undefined if it has a zero-length value.
4685  */
4686 #if defined(PERL_USE_SAFE_PUTENV) && ! defined(HAS_UNSETENV)
4687         if (perl5lib && *perl5lib != '\0')
4688 #else
4689         if (perl5lib)
4690 #endif
4691             incpush_use_sep(perl5lib, 0, INCPUSH_ADD_SUB_DIRS);
4692         else {
4693             s = PerlEnv_getenv("PERLLIB");
4694             if (s)
4695                 incpush_use_sep(s, 0, 0);
4696         }
4697 #else /* VMS */
4698         /* Treat PERL5?LIB as a possible search list logical name -- the
4699          * "natural" VMS idiom for a Unix path string.  We allow each
4700          * element to be a set of |-separated directories for compatibility.
4701          */
4702         char buf[256];
4703         int idx = 0;
4704         if (vmstrnenv("PERL5LIB",buf,0,NULL,0))
4705             do {
4706                 incpush_use_sep(buf, 0, INCPUSH_ADD_SUB_DIRS);
4707             } while (vmstrnenv("PERL5LIB",buf,++idx,NULL,0));
4708         else {
4709             while (vmstrnenv("PERLLIB",buf,idx++,NULL,0))
4710                 incpush_use_sep(buf, 0, 0);
4711         }
4712 #endif /* VMS */
4713     }
4714
4715 #ifndef PERL_IS_MINIPERL
4716     /* miniperl gets just -I..., the split of $ENV{PERL5LIB}, and "." in @INC
4717        (and not the architecture specific directories from $ENV{PERL5LIB}) */
4718
4719 #include "perl_inc_macro.h"
4720 /* Use the ~-expanded versions of APPLLIB (undocumented),
4721     SITEARCH, SITELIB, VENDORARCH, VENDORLIB, ARCHLIB and PRIVLIB
4722 */
4723     INCPUSH_APPLLIB_EXP
4724     INCPUSH_SITEARCH_EXP
4725     INCPUSH_SITELIB_EXP
4726     INCPUSH_PERL_VENDORARCH_EXP
4727     INCPUSH_PERL_VENDORLIB_EXP
4728     INCPUSH_ARCHLIB_EXP
4729     INCPUSH_PRIVLIB_EXP
4730     INCPUSH_PERL_OTHERLIBDIRS
4731     INCPUSH_PERL5LIB
4732     INCPUSH_APPLLIB_OLD_EXP
4733     INCPUSH_SITELIB_STEM
4734     INCPUSH_PERL_VENDORLIB_STEM
4735     INCPUSH_PERL_OTHERLIBDIRS_ARCHONLY
4736
4737 #endif /* !PERL_IS_MINIPERL */
4738
4739     if (!TAINTING_get) {
4740 #if !defined(PERL_IS_MINIPERL) && defined(DEFAULT_INC_EXCLUDES_DOT)
4741         const char * const unsafe = PerlEnv_getenv("PERL_USE_UNSAFE_INC");
4742         if (unsafe && strEQ(unsafe, "1"))
4743 #endif
4744           S_incpush(aTHX_ STR_WITH_LEN("."), 0);
4745     }
4746 }
4747
4748 #if defined(DOSISH) || defined(__SYMBIAN32__)
4749 #    define PERLLIB_SEP ';'
4750 #elif defined(__VMS)
4751 #    define PERLLIB_SEP PL_perllib_sep
4752 #else
4753 #    define PERLLIB_SEP ':'
4754 #endif
4755 #ifndef PERLLIB_MANGLE
4756 #  define PERLLIB_MANGLE(s,n) (s)
4757 #endif
4758
4759 #ifndef PERL_IS_MINIPERL
4760 /* Push a directory onto @INC if it exists.
4761    Generate a new SV if we do this, to save needing to copy the SV we push
4762    onto @INC  */
4763 STATIC SV *
4764 S_incpush_if_exists(pTHX_ AV *const av, SV *dir, SV *const stem)
4765 {
4766     Stat_t tmpstatbuf;
4767
4768     PERL_ARGS_ASSERT_INCPUSH_IF_EXISTS;
4769
4770     if (PerlLIO_stat(SvPVX_const(dir), &tmpstatbuf) >= 0 &&
4771         S_ISDIR(tmpstatbuf.st_mode)) {
4772         av_push(av, dir);
4773         dir = newSVsv(stem);
4774     } else {
4775         /* Truncate dir back to stem.  */
4776         SvCUR_set(dir, SvCUR(stem));
4777     }
4778     return dir;
4779 }
4780 #endif
4781
4782 STATIC SV *
4783 S_mayberelocate(pTHX_ const char *const dir, STRLEN len, U32 flags)
4784 {
4785     const U8 canrelocate = (U8)flags & INCPUSH_CAN_RELOCATE;
4786     SV *libdir;
4787
4788     PERL_ARGS_ASSERT_MAYBERELOCATE;
4789     assert(len > 0);
4790
4791     /* I am not convinced that this is valid when PERLLIB_MANGLE is
4792        defined to so something (in os2/os2.c), but the code has been
4793        this way, ignoring any possible changed of length, since
4794        760ac839baf413929cd31cc32ffd6dba6b781a81 (5.003_02) so I'll leave
4795        it be.  */
4796     libdir = newSVpvn(PERLLIB_MANGLE(dir, len), len);
4797
4798 #ifdef VMS
4799     {
4800         char *unix;
4801
4802         if ((unix = tounixspec_ts(SvPV(libdir,len),NULL)) != NULL) {
4803             len = strlen(unix);
4804             while (len > 1 && unix[len-1] == '/') len--;  /* Cosmetic */
4805             sv_usepvn(libdir,unix,len);
4806         }
4807         else
4808             PerlIO_printf(Perl_error_log,
4809                           "Failed to unixify @INC element \"%s\"\n",
4810                           SvPV_nolen_const(libdir));
4811     }
4812 #endif
4813
4814         /* Do the if() outside the #ifdef to avoid warnings about an unused
4815            parameter.  */
4816         if (canrelocate) {
4817 #ifdef PERL_RELOCATABLE_INC
4818         /*
4819          * Relocatable include entries are marked with a leading .../
4820          *
4821          * The algorithm is
4822          * 0: Remove that leading ".../"
4823          * 1: Remove trailing executable name (anything after the last '/')
4824          *    from the perl path to give a perl prefix
4825          * Then
4826          * While the @INC element starts "../" and the prefix ends with a real
4827          * directory (ie not . or ..) chop that real directory off the prefix
4828          * and the leading "../" from the @INC element. ie a logical "../"
4829          * cleanup
4830          * Finally concatenate the prefix and the remainder of the @INC element
4831          * The intent is that /usr/local/bin/perl and .../../lib/perl5
4832          * generates /usr/local/lib/perl5
4833          */
4834             const char *libpath = SvPVX(libdir);
4835             STRLEN libpath_len = SvCUR(libdir);
4836             if (memBEGINs(libpath, libpath_len, ".../")) {
4837                 /* Game on!  */
4838                 SV * const caret_X = get_sv("\030", 0);
4839                 /* Going to use the SV just as a scratch buffer holding a C
4840                    string:  */
4841                 SV *prefix_sv;
4842                 char *prefix;
4843                 char *lastslash;
4844
4845                 /* $^X is *the* source of taint if tainting is on, hence
4846                    SvPOK() won't be true.  */
4847                 assert(caret_X);
4848                 assert(SvPOKp(caret_X));
4849                 prefix_sv = newSVpvn_flags(SvPVX(caret_X), SvCUR(caret_X),
4850                                            SvUTF8(caret_X));
4851                 /* Firstly take off the leading .../
4852                    If all else fail we'll do the paths relative to the current
4853                    directory.  */
4854                 sv_chop(libdir, libpath + 4);
4855                 /* Don't use SvPV as we're intentionally bypassing taining,
4856                    mortal copies that the mg_get of tainting creates, and
4857                    corruption that seems to come via the save stack.
4858                    I guess that the save stack isn't correctly set up yet.  */
4859                 libpath = SvPVX(libdir);
4860                 libpath_len = SvCUR(libdir);
4861
4862                 prefix = SvPVX(prefix_sv);
4863                 lastslash = (char *) my_memrchr(prefix, '/',
4864                              SvEND(prefix_sv) - prefix);
4865
4866                 /* First time in with the *lastslash = '\0' we just wipe off
4867                    the trailing /perl from (say) /usr/foo/bin/perl
4868                 */
4869                 if (lastslash) {
4870                     SV *tempsv;
4871                     while ((*lastslash = '\0'), /* Do that, come what may.  */
4872                            (   memBEGINs(libpath, libpath_len, "../")
4873                             && (lastslash =
4874                                   (char *) my_memrchr(prefix, '/',
4875                                                    SvEND(prefix_sv) - prefix))))
4876                     {
4877                         if (lastslash[1] == '\0'
4878                             || (lastslash[1] == '.'
4879                                 && (lastslash[2] == '/' /* ends "/."  */
4880                                     || (lastslash[2] == '/'
4881                                         && lastslash[3] == '/' /* or "/.."  */
4882                                         )))) {
4883                             /* Prefix ends "/" or "/." or "/..", any of which
4884                                are fishy, so don't do any more logical cleanup.
4885                             */
4886                             break;
4887                         }
4888                         /* Remove leading "../" from path  */
4889                         libpath += 3;
4890                         libpath_len -= 3;
4891                         /* Next iteration round the loop removes the last
4892                            directory name from prefix by writing a '\0' in
4893                            the while clause.  */
4894                     }
4895                     /* prefix has been terminated with a '\0' to the correct
4896                        length. libpath points somewhere into the libdir SV.
4897                        We need to join the 2 with '/' and drop the result into
4898                        libdir.  */
4899                     tempsv = Perl_newSVpvf(aTHX_ "%s/%s", prefix, libpath);
4900                     SvREFCNT_dec(libdir);
4901                     /* And this is the new libdir.  */
4902                     libdir = tempsv;
4903                     if (TAINTING_get &&
4904                         (PerlProc_getuid() != PerlProc_geteuid() ||
4905                          PerlProc_getgid() != PerlProc_getegid())) {
4906                         /* Need to taint relocated paths if running set ID  */
4907                         SvTAINTED_on(libdir);
4908                     }
4909                 }
4910                 SvREFCNT_dec(prefix_sv);
4911             }
4912 #endif
4913         }
4914     return libdir;
4915 }
4916
4917 STATIC void
4918 S_incpush(pTHX_ const char *const dir, STRLEN len, U32 flags)
4919 {
4920 #ifndef PERL_IS_MINIPERL
4921     const U8 using_sub_dirs
4922         = (U8)flags & (INCPUSH_ADD_VERSIONED_SUB_DIRS
4923                        |INCPUSH_ADD_ARCHONLY_SUB_DIRS|INCPUSH_ADD_OLD_VERS);
4924     const U8 add_versioned_sub_dirs
4925         = (U8)flags & INCPUSH_ADD_VERSIONED_SUB_DIRS;
4926     const U8 add_archonly_sub_dirs
4927         = (U8)flags & INCPUSH_ADD_ARCHONLY_SUB_DIRS;
4928 #ifdef PERL_INC_VERSION_LIST
4929     const U8 addoldvers  = (U8)flags & INCPUSH_ADD_OLD_VERS;
4930 #endif
4931 #endif
4932     const U8 unshift     = (U8)flags & INCPUSH_UNSHIFT;
4933     const U8 push_basedir = (flags & INCPUSH_NOT_BASEDIR) ? 0 : 1;
4934     AV *const inc = GvAVn(PL_incgv);
4935
4936     PERL_ARGS_ASSERT_INCPUSH;
4937     assert(len > 0);
4938
4939     /* Could remove this vestigial extra block, if we don't mind a lot of
4940        re-indenting diff noise.  */
4941     {
4942         SV *const libdir = mayberelocate(dir, len, flags);
4943         /* Change 20189146be79a0596543441fa369c6bf7f85103f, to fix RT#6665,
4944            arranged to unshift #! line -I onto the front of @INC. However,
4945            -I can add version and architecture specific libraries, and they
4946            need to go first. The old code assumed that it was always
4947            pushing. Hence to make it work, need to push the architecture
4948            (etc) libraries onto a temporary array, then "unshift" that onto
4949            the front of @INC.  */
4950 #ifndef PERL_IS_MINIPERL
4951         AV *const av = (using_sub_dirs) ? (unshift ? newAV() : inc) : NULL;
4952
4953         /*
4954          * BEFORE pushing libdir onto @INC we may first push version- and
4955          * archname-specific sub-directories.
4956          */
4957         if (using_sub_dirs) {
4958             SV *subdir = newSVsv(libdir);
4959 #ifdef PERL_INC_VERSION_LIST
4960             /* Configure terminates PERL_INC_VERSION_LIST with a NULL */
4961             const char * const incverlist[] = { PERL_INC_VERSION_LIST };
4962             const char * const *incver;
4963 #endif
4964
4965             if (add_versioned_sub_dirs) {
4966                 /* .../version/archname if -d .../version/archname */
4967                 sv_catpvs(subdir, "/" PERL_FS_VERSION "/" ARCHNAME);
4968                 subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
4969
4970                 /* .../version if -d .../version */
4971                 sv_catpvs(subdir, "/" PERL_FS_VERSION);
4972                 subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
4973             }
4974
4975 #ifdef PERL_INC_VERSION_LIST
4976             if (addoldvers) {
4977                 for (incver = incverlist; *incver; incver++) {
4978                     /* .../xxx if -d .../xxx */
4979                     Perl_sv_catpvf(aTHX_ subdir, "/%s", *incver);
4980                     subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
4981                 }
4982             }
4983 #endif
4984
4985             if (add_archonly_sub_dirs) {
4986                 /* .../archname if -d .../archname */
4987                 sv_catpvs(subdir, "/" ARCHNAME);
4988                 subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
4989
4990             }
4991
4992             assert (SvREFCNT(subdir) == 1);
4993             SvREFCNT_dec(subdir);
4994         }
4995 #endif /* !PERL_IS_MINIPERL */
4996         /* finally add this lib directory at the end of @INC */
4997         if (unshift) {
4998 #ifdef PERL_IS_MINIPERL
4999             const Size_t extra = 0;
5000 #else
5001             Size_t extra = av_tindex(av) + 1;
5002 #endif
5003             av_unshift(inc, extra + push_basedir);
5004             if (push_basedir)
5005                 av_store(inc, extra, libdir);
5006 #ifndef PERL_IS_MINIPERL
5007             while (extra--) {
5008                 /* av owns a reference, av_store() expects to be donated a
5009                    reference, and av expects to be sane when it's cleared.
5010                    If I wanted to be naughty and wrong, I could peek inside the
5011                    implementation of av_clear(), realise that it uses
5012                    SvREFCNT_dec() too, so av's array could be a run of NULLs,
5013                    and so directly steal from it (with a memcpy() to inc, and
5014                    then memset() to NULL them out. But people copy code from the
5015                    core expecting it to be best practise, so let's use the API.
5016                    Although studious readers will note that I'm not checking any
5017                    return codes.  */
5018                 av_store(inc, extra, SvREFCNT_inc(*av_fetch(av, extra, FALSE)));
5019             }
5020             SvREFCNT_dec(av);
5021 #endif
5022         }
5023         else if (push_basedir) {
5024             av_push(inc, libdir);
5025         }
5026
5027         if (!push_basedir) {
5028             assert (SvREFCNT(libdir) == 1);
5029             SvREFCNT_dec(libdir);
5030         }
5031     }
5032 }
5033
5034 STATIC void
5035 S_incpush_use_sep(pTHX_ const char *p, STRLEN len, U32 flags)
5036 {
5037     const char *s;
5038     const char *end;
5039     /* This logic has been broken out from S_incpush(). It may be possible to
5040        simplify it.  */
5041
5042     PERL_ARGS_ASSERT_INCPUSH_USE_SEP;
5043
5044     /* perl compiled with -DPERL_RELOCATABLE_INCPUSH will ignore the len
5045      * argument to incpush_use_sep.  This allows creation of relocatable
5046      * Perl distributions that patch the binary at install time.  Those
5047      * distributions will have to provide their own relocation tools; this
5048      * is not a feature otherwise supported by core Perl.
5049      */
5050 #ifndef PERL_RELOCATABLE_INCPUSH
5051     if (!len)
5052 #endif
5053         len = strlen(p);
5054
5055     end = p + len;
5056
5057     /* Break at all separators */
5058     while ((s = (const char*)memchr(p, PERLLIB_SEP, end - p))) {
5059         if (s == p) {
5060             /* skip any consecutive separators */
5061
5062             /* Uncomment the next line for PATH semantics */
5063             /* But you'll need to write tests */
5064             /* av_push(GvAVn(PL_incgv), newSVpvs(".")); */
5065         } else {
5066             incpush(p, (STRLEN)(s - p), flags);
5067         }
5068         p = s + 1;
5069     }
5070     if (p != end)
5071         incpush(p, (STRLEN)(end - p), flags);
5072
5073 }
5074
5075 void
5076 Perl_call_list(pTHX_ I32 oldscope, AV *paramList)
5077 {
5078     SV *atsv;
5079     volatile const line_t oldline = PL_curcop ? CopLINE(PL_curcop) : 0;
5080     CV *cv;
5081     STRLEN len;
5082     int ret;
5083     dJMPENV;
5084
5085     PERL_ARGS_ASSERT_CALL_LIST;
5086
5087     while (av_tindex(paramList) >= 0) {
5088         cv = MUTABLE_CV(av_shift(paramList));
5089         if (PL_savebegin) {
5090             if (paramList == PL_beginav) {
5091                 /* save PL_beginav for compiler */
5092                 Perl_av_create_and_push(aTHX_ &PL_beginav_save, MUTABLE_SV(cv));
5093             }
5094             else if (paramList == PL_checkav) {
5095                 /* save PL_checkav for compiler */
5096                 Perl_av_create_and_push(aTHX_ &PL_checkav_save, MUTABLE_SV(cv));
5097             }
5098             else if (paramList == PL_unitcheckav) {
5099                 /* save PL_unitcheckav for compiler */
5100                 Perl_av_create_and_push(aTHX_ &PL_unitcheckav_save, MUTABLE_SV(cv));
5101             }
5102         } else {
5103             SAVEFREESV(cv);
5104         }
5105         JMPENV_PUSH(ret);
5106         switch (ret) {
5107         case 0:
5108             CALL_LIST_BODY(cv);
5109             atsv = ERRSV;
5110             (void)SvPV_const(atsv, len);
5111             if (len) {
5112                 PL_curcop = &PL_compiling;
5113                 CopLINE_set(PL_curcop, oldline);
5114                 if (paramList == PL_beginav)
5115                     sv_catpvs(atsv, "BEGIN failed--compilation aborted");
5116                 else
5117                     Perl_sv_catpvf(aTHX_ atsv,
5118                                    "%s failed--call queue aborted",
5119                                    paramList == PL_checkav ? "CHECK"
5120                                    : paramList == PL_initav ? "INIT"
5121                                    : paramList == PL_unitcheckav ? "UNITCHECK"
5122                                    : "END");
5123                 while (PL_scopestack_ix > oldscope)
5124                     LEAVE;
5125                 JMPENV_POP;
5126                 Perl_croak(aTHX_ "%" SVf, SVfARG(atsv));
5127             }
5128             break;
5129         case 1:
5130             STATUS_ALL_FAILURE;
5131             /* FALLTHROUGH */
5132         case 2:
5133             /* my_exit() was called */
5134             while (PL_scopestack_ix > oldscope)
5135                 LEAVE;
5136             FREETMPS;
5137             SET_CURSTASH(PL_defstash);
5138             PL_curcop = &PL_compiling;
5139             CopLINE_set(PL_curcop, oldline);
5140             JMPENV_POP;
5141             my_exit_jump();
5142             NOT_REACHED; /* NOTREACHED */
5143         case 3:
5144             if (PL_restartop) {
5145                 PL_curcop = &PL_compiling;
5146                 CopLINE_set(PL_curcop, oldline);
5147                 JMPENV_JUMP(3);
5148             }
5149             PerlIO_printf(Perl_error_log, "panic: restartop in call_list\n");
5150             FREETMPS;
5151             break;
5152         }
5153         JMPENV_POP;
5154     }
5155 }
5156
5157 void
5158 Perl_my_exit(pTHX_ U32 status)
5159 {
5160     if (PL_exit_flags & PERL_EXIT_ABORT) {
5161         abort();
5162     }
5163     if (PL_exit_flags & PERL_EXIT_WARN) {
5164         PL_exit_flags |= PERL_EXIT_ABORT; /* Protect against reentrant calls */
5165         Perl_warn(aTHX_ "Unexpected exit %lu", (unsigned long)status);
5166         PL_exit_flags &= ~PERL_EXIT_ABORT;
5167     }
5168     switch (status) {
5169     case 0:
5170         STATUS_ALL_SUCCESS;
5171         break;
5172     case 1:
5173         STATUS_ALL_FAILURE;
5174         break;
5175     default:
5176         STATUS_EXIT_SET(status);
5177         break;
5178     }
5179     my_exit_jump();
5180 }
5181
5182 void
5183 Perl_my_failure_exit(pTHX)
5184 {
5185 #ifdef VMS
5186      /* We have been called to fall on our sword.  The desired exit code
5187       * should be already set in STATUS_UNIX, but could be shifted over
5188       * by 8 bits.  STATUS_UNIX_EXIT_SET will handle the cases where a
5189       * that code is set.
5190       *
5191       * If an error code has not been set, then force the issue.
5192       */
5193     if (MY_POSIX_EXIT) {
5194
5195         /* According to the die_exit.t tests, if errno is non-zero */
5196         /* It should be used for the error status. */
5197
5198         if (errno == EVMSERR) {
5199             STATUS_NATIVE = vaxc$errno;
5200         } else {
5201
5202             /* According to die_exit.t tests, if the child_exit code is */
5203             /* also zero, then we need to exit with a code of 255 */
5204             if ((errno != 0) && (errno < 256))
5205                 STATUS_UNIX_EXIT_SET(errno);
5206             else if (STATUS_UNIX < 255) {
5207                 STATUS_UNIX_EXIT_SET(255);
5208             }
5209
5210         }
5211
5212         /* The exit code could have been set by $? or vmsish which
5213          * means that it may not have fatal set.  So convert
5214          * success/warning codes to fatal with out changing
5215          * the POSIX status code.  The severity makes VMS native
5216          * status handling work, while UNIX mode programs use the
5217          * the POSIX exit codes.
5218          */
5219          if ((STATUS_NATIVE & (STS$K_SEVERE|STS$K_ERROR)) == 0) {
5220             STATUS_NATIVE &= STS$M_COND_ID;
5221             STATUS_NATIVE |= STS$K_ERROR | STS$M_INHIB_MSG;
5222          }
5223     }
5224     else {
5225         /* Traditionally Perl on VMS always expects a Fatal Error. */
5226         if (vaxc$errno & 1) {
5227
5228             /* So force success status to failure */
5229             if (STATUS_NATIVE & 1)
5230                 STATUS_ALL_FAILURE;
5231         }
5232         else {
5233             if (!vaxc$errno) {
5234                 STATUS_UNIX = EINTR; /* In case something cares */
5235                 STATUS_ALL_FAILURE;
5236             }
5237             else {
5238                 int severity;
5239                 STATUS_NATIVE = vaxc$errno; /* Should already be this */
5240
5241                 /* Encode the severity code */
5242                 severity = STATUS_NATIVE & STS$M_SEVERITY;
5243                 STATUS_UNIX = (severity ? severity : 1) << 8;
5244
5245                 /* Perl expects this to be a fatal error */
5246                 if (severity != STS$K_SEVERE)
5247                     STATUS_ALL_FAILURE;
5248             }
5249         }
5250     }
5251
5252 #else
5253     int exitstatus;
5254     int eno = errno;
5255     if (eno & 255)
5256         STATUS_UNIX_SET(eno);
5257     else {
5258         exitstatus = STATUS_UNIX >> 8;
5259         if (exitstatus & 255)
5260             STATUS_UNIX_SET(exitstatus);
5261         else
5262             STATUS_UNIX_SET(255);
5263     }
5264 #endif
5265     if (PL_exit_flags & PERL_EXIT_ABORT) {
5266         abort();
5267     }
5268     if (PL_exit_flags & PERL_EXIT_WARN) {
5269         PL_exit_flags |= PERL_EXIT_ABORT; /* Protect against reentrant calls */
5270         Perl_warn(aTHX_ "Unexpected exit failure %ld", (long)PL_statusvalue);
5271         PL_exit_flags &= ~PERL_EXIT_ABORT;
5272     }
5273     my_exit_jump();
5274 }
5275
5276 STATIC void
5277 S_my_exit_jump(pTHX)
5278 {
5279     if (PL_e_script) {
5280         SvREFCNT_dec(PL_e_script);
5281         PL_e_script = NULL;
5282     }
5283
5284     POPSTACK_TO(PL_mainstack);
5285     if (cxstack_ix >= 0) {
5286         dounwind(-1);
5287         cx_popblock(cxstack);
5288     }
5289     LEAVE_SCOPE(0);
5290
5291     JMPENV_JUMP(2);
5292 }
5293
5294 static I32
5295 read_e_script(pTHX_ int idx, SV *buf_sv, int maxlen)
5296 {
5297     const char * const p  = SvPVX_const(PL_e_script);
5298     const char * const e  = SvEND(PL_e_script);
5299     const char *nl = (char *) memchr(p, '\n', e - p);
5300
5301     PERL_UNUSED_ARG(idx);
5302     PERL_UNUSED_ARG(maxlen);
5303
5304     nl = (nl) ? nl+1 : e;
5305     if (nl-p == 0) {
5306         filter_del(read_e_script);
5307         return 0;
5308     }
5309     sv_catpvn(buf_sv, p, nl-p);
5310     sv_chop(PL_e_script, nl);
5311     return 1;
5312 }
5313
5314 /* removes boilerplate code at the end of each boot_Module xsub */
5315 void
5316 Perl_xs_boot_epilog(pTHX_ const I32 ax)
5317 {
5318   if (PL_unitcheckav)
5319         call_list(PL_scopestack_ix, PL_unitcheckav);
5320     XSRETURN_YES;
5321 }
5322
5323 /*
5324  * ex: set ts=8 sts=4 sw=4 et:
5325  */