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