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