perl.h: White-space, comment
[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         ;
1975     PERL_UNUSED_ARG(cv);
1976     PERL_UNUSED_VAR(items);
1977
1978     EXTEND(SP, entries);
1979
1980     PUSHs(sv_2mortal(newSVpv(PL_bincompat_options, 0)));
1981     PUSHs(Perl_newSVpvn_flags(aTHX_ non_bincompat_options,
1982                               sizeof(non_bincompat_options) - 1, SVs_TEMP));
1983
1984 #ifndef PERL_BUILD_DATE
1985 #  ifdef __DATE__
1986 #    ifdef __TIME__
1987 #      define PERL_BUILD_DATE __DATE__ " " __TIME__
1988 #    else
1989 #      define PERL_BUILD_DATE __DATE__
1990 #    endif
1991 #  endif
1992 #endif
1993
1994 #ifdef PERL_BUILD_DATE
1995     PUSHs(Perl_newSVpvn_flags(aTHX_
1996                               STR_WITH_LEN("Compiled at " PERL_BUILD_DATE),
1997                               SVs_TEMP));
1998 #else
1999     PUSHs(&PL_sv_undef);
2000 #endif
2001
2002     for (i = 1; i <= local_patch_count; i++) {
2003         /* This will be an undef, if PL_localpatches[i] is NULL.  */
2004         PUSHs(sv_2mortal(newSVpv(PL_localpatches[i], 0)));
2005     }
2006
2007     XSRETURN(entries);
2008 }
2009
2010 #define INCPUSH_UNSHIFT                 0x01
2011 #define INCPUSH_ADD_OLD_VERS            0x02
2012 #define INCPUSH_ADD_VERSIONED_SUB_DIRS  0x04
2013 #define INCPUSH_ADD_ARCHONLY_SUB_DIRS   0x08
2014 #define INCPUSH_NOT_BASEDIR             0x10
2015 #define INCPUSH_CAN_RELOCATE            0x20
2016 #define INCPUSH_ADD_SUB_DIRS    \
2017     (INCPUSH_ADD_VERSIONED_SUB_DIRS|INCPUSH_ADD_ARCHONLY_SUB_DIRS)
2018
2019 STATIC void *
2020 S_parse_body(pTHX_ char **env, XSINIT_t xsinit)
2021 {
2022     dVAR;
2023     PerlIO *rsfp;
2024     int argc = PL_origargc;
2025     char **argv = PL_origargv;
2026     const char *scriptname = NULL;
2027     bool dosearch = FALSE;
2028     char c;
2029     bool doextract = FALSE;
2030     const char *cddir = NULL;
2031 #ifdef USE_SITECUSTOMIZE
2032     bool minus_f = FALSE;
2033 #endif
2034     SV *linestr_sv = NULL;
2035     bool add_read_e_script = FALSE;
2036     U32 lex_start_flags = 0;
2037
2038     PERL_SET_PHASE(PERL_PHASE_START);
2039
2040     init_main_stash();
2041
2042     {
2043         const char *s;
2044     for (argc--,argv++; argc > 0; argc--,argv++) {
2045         if (argv[0][0] != '-' || !argv[0][1])
2046             break;
2047         s = argv[0]+1;
2048       reswitch:
2049         switch ((c = *s)) {
2050         case 'C':
2051 #ifndef PERL_STRICT_CR
2052         case '\r':
2053 #endif
2054         case ' ':
2055         case '0':
2056         case 'F':
2057         case 'a':
2058         case 'c':
2059         case 'd':
2060         case 'D':
2061         case 'h':
2062         case 'i':
2063         case 'l':
2064         case 'M':
2065         case 'm':
2066         case 'n':
2067         case 'p':
2068         case 's':
2069         case 'u':
2070         case 'U':
2071         case 'v':
2072         case 'W':
2073         case 'X':
2074         case 'w':
2075             if ((s = moreswitches(s)))
2076                 goto reswitch;
2077             break;
2078
2079         case 't':
2080 #if defined(SILENT_NO_TAINT_SUPPORT)
2081             /* silently ignore */
2082 #elif defined(NO_TAINT_SUPPORT)
2083             Perl_croak_nocontext("This perl was compiled without taint support. "
2084                        "Cowardly refusing to run with -t or -T flags");
2085 #else
2086             CHECK_MALLOC_TOO_LATE_FOR('t');
2087             if( !TAINTING_get ) {
2088                  TAINT_WARN_set(TRUE);
2089                  TAINTING_set(TRUE);
2090             }
2091 #endif
2092             s++;
2093             goto reswitch;
2094         case 'T':
2095 #if defined(SILENT_NO_TAINT_SUPPORT)
2096             /* silently ignore */
2097 #elif defined(NO_TAINT_SUPPORT)
2098             Perl_croak_nocontext("This perl was compiled without taint support. "
2099                        "Cowardly refusing to run with -t or -T flags");
2100 #else
2101             CHECK_MALLOC_TOO_LATE_FOR('T');
2102             TAINTING_set(TRUE);
2103             TAINT_WARN_set(FALSE);
2104 #endif
2105             s++;
2106             goto reswitch;
2107
2108         case 'E':
2109             PL_minus_E = TRUE;
2110             /* FALLTHROUGH */
2111         case 'e':
2112             forbid_setid('e', FALSE);
2113             if (!PL_e_script) {
2114                 PL_e_script = newSVpvs("");
2115                 add_read_e_script = TRUE;
2116             }
2117             if (*++s)
2118                 sv_catpv(PL_e_script, s);
2119             else if (argv[1]) {
2120                 sv_catpv(PL_e_script, argv[1]);
2121                 argc--,argv++;
2122             }
2123             else
2124                 Perl_croak(aTHX_ "No code specified for -%c", c);
2125             sv_catpvs(PL_e_script, "\n");
2126             break;
2127
2128         case 'f':
2129 #ifdef USE_SITECUSTOMIZE
2130             minus_f = TRUE;
2131 #endif
2132             s++;
2133             goto reswitch;
2134
2135         case 'I':       /* -I handled both here and in moreswitches() */
2136             forbid_setid('I', FALSE);
2137             if (!*++s && (s=argv[1]) != NULL) {
2138                 argc--,argv++;
2139             }
2140             if (s && *s) {
2141                 STRLEN len = strlen(s);
2142                 incpush(s, len, INCPUSH_ADD_SUB_DIRS|INCPUSH_ADD_OLD_VERS);
2143             }
2144             else
2145                 Perl_croak(aTHX_ "No directory specified for -I");
2146             break;
2147         case 'S':
2148             forbid_setid('S', FALSE);
2149             dosearch = TRUE;
2150             s++;
2151             goto reswitch;
2152         case 'V':
2153             {
2154                 SV *opts_prog;
2155
2156                 if (*++s != ':')  {
2157                     opts_prog = newSVpvs("use Config; Config::_V()");
2158                 }
2159                 else {
2160                     ++s;
2161                     opts_prog = Perl_newSVpvf(aTHX_
2162                                               "use Config; Config::config_vars(qw%c%s%c)",
2163                                               0, s, 0);
2164                     s += strlen(s);
2165                 }
2166                 Perl_av_create_and_push(aTHX_ &PL_preambleav, opts_prog);
2167                 /* don't look for script or read stdin */
2168                 scriptname = BIT_BUCKET;
2169                 goto reswitch;
2170             }
2171         case 'x':
2172             doextract = TRUE;
2173             s++;
2174             if (*s)
2175                 cddir = s;
2176             break;
2177         case 0:
2178             break;
2179         case '-':
2180             if (!*++s || isSPACE(*s)) {
2181                 argc--,argv++;
2182                 goto switch_end;
2183             }
2184             /* catch use of gnu style long options.
2185                Both of these exit immediately.  */
2186             if (strEQ(s, "version"))
2187                 minus_v();
2188             if (strEQ(s, "help"))
2189                 usage();
2190             s--;
2191             /* FALLTHROUGH */
2192         default:
2193             Perl_croak(aTHX_ "Unrecognized switch: -%s  (-h will show valid options)",s);
2194         }
2195     }
2196     }
2197
2198   switch_end:
2199
2200     {
2201         char *s;
2202
2203     if (
2204 #ifndef SECURE_INTERNAL_GETENV
2205         !TAINTING_get &&
2206 #endif
2207         (s = PerlEnv_getenv("PERL5OPT")))
2208     {
2209         /* s points to static memory in getenv(), which may be overwritten at
2210          * any time; use a mortal copy instead */
2211         s = SvPVX(sv_2mortal(newSVpv(s, 0)));
2212
2213         while (isSPACE(*s))
2214             s++;
2215         if (*s == '-' && *(s+1) == 'T') {
2216 #if defined(SILENT_NO_TAINT_SUPPORT)
2217             /* silently ignore */
2218 #elif defined(NO_TAINT_SUPPORT)
2219             Perl_croak_nocontext("This perl was compiled without taint support. "
2220                        "Cowardly refusing to run with -t or -T flags");
2221 #else
2222             CHECK_MALLOC_TOO_LATE_FOR('T');
2223             TAINTING_set(TRUE);
2224             TAINT_WARN_set(FALSE);
2225 #endif
2226         }
2227         else {
2228             char *popt_copy = NULL;
2229             while (s && *s) {
2230                 const char *d;
2231                 while (isSPACE(*s))
2232                     s++;
2233                 if (*s == '-') {
2234                     s++;
2235                     if (isSPACE(*s))
2236                         continue;
2237                 }
2238                 d = s;
2239                 if (!*s)
2240                     break;
2241                 if (!strchr("CDIMUdmtwW", *s))
2242                     Perl_croak(aTHX_ "Illegal switch in PERL5OPT: -%c", *s);
2243                 while (++s && *s) {
2244                     if (isSPACE(*s)) {
2245                         if (!popt_copy) {
2246                             popt_copy = SvPVX(sv_2mortal(newSVpv(d,0)));
2247                             s = popt_copy + (s - d);
2248                             d = popt_copy;
2249                         }
2250                         *s++ = '\0';
2251                         break;
2252                     }
2253                 }
2254                 if (*d == 't') {
2255 #if defined(SILENT_NO_TAINT_SUPPORT)
2256             /* silently ignore */
2257 #elif defined(NO_TAINT_SUPPORT)
2258                     Perl_croak_nocontext("This perl was compiled without taint support. "
2259                                "Cowardly refusing to run with -t or -T flags");
2260 #else
2261                     if( !TAINTING_get) {
2262                         TAINT_WARN_set(TRUE);
2263                         TAINTING_set(TRUE);
2264                     }
2265 #endif
2266                 } else {
2267                     moreswitches(d);
2268                 }
2269             }
2270         }
2271     }
2272     }
2273
2274 #ifndef NO_PERL_INTERNAL_RAND_SEED
2275     /* If we're not set[ug]id, we might have honored
2276        PERL_INTERNAL_RAND_SEED in perl_construct().
2277        At this point command-line options have been parsed, so if
2278        we're now tainting and not set[ug]id re-seed.
2279        This could possibly be wasteful if PERL_INTERNAL_RAND_SEED is invalid,
2280        but avoids duplicating the logic from perl_construct().
2281     */
2282     if (TAINT_get &&
2283         PerlProc_getuid() == PerlProc_geteuid() &&
2284         PerlProc_getgid() == PerlProc_getegid()) {
2285         Perl_drand48_init_r(&PL_internal_random_state, seed());
2286     }
2287 #endif
2288
2289     /* Set $^X early so that it can be used for relocatable paths in @INC  */
2290     /* and for SITELIB_EXP in USE_SITECUSTOMIZE                            */
2291     assert (!TAINT_get);
2292     TAINT;
2293     set_caret_X();
2294     TAINT_NOT;
2295
2296 #if defined(USE_SITECUSTOMIZE)
2297     if (!minus_f) {
2298         /* The games with local $! are to avoid setting errno if there is no
2299            sitecustomize script.  "q%c...%c", 0, ..., 0 becomes "q\0...\0",
2300            ie a q() operator with a NUL byte as a the delimiter. This avoids
2301            problems with pathnames containing (say) '  */
2302 #  ifdef PERL_IS_MINIPERL
2303         AV *const inc = GvAV(PL_incgv);
2304         SV **const inc0 = inc ? av_fetch(inc, 0, FALSE) : NULL;
2305
2306         if (inc0) {
2307             /* if lib/buildcustomize.pl exists, it should not fail. If it does,
2308                it should be reported immediately as a build failure.  */
2309             (void)Perl_av_create_and_unshift_one(aTHX_ &PL_preambleav,
2310                                                  Perl_newSVpvf(aTHX_
2311                 "BEGIN { my $f = q%c%s%" SVf "/buildcustomize.pl%c; "
2312                         "do {local $!; -f $f }"
2313                         " and do $f || die $@ || qq '$f: $!' }",
2314                                 0, (TAINTING_get ? "./" : ""), SVfARG(*inc0), 0));
2315         }
2316 #  else
2317         /* SITELIB_EXP is a function call on Win32.  */
2318         const char *const raw_sitelib = SITELIB_EXP;
2319         if (raw_sitelib) {
2320             /* process .../.. if PERL_RELOCATABLE_INC is defined */
2321             SV *sitelib_sv = mayberelocate(raw_sitelib, strlen(raw_sitelib),
2322                                            INCPUSH_CAN_RELOCATE);
2323             const char *const sitelib = SvPVX(sitelib_sv);
2324             (void)Perl_av_create_and_unshift_one(aTHX_ &PL_preambleav,
2325                                                  Perl_newSVpvf(aTHX_
2326                                                                "BEGIN { do {local $!; -f q%c%s/sitecustomize.pl%c} && do q%c%s/sitecustomize.pl%c }",
2327                                                                0, SVfARG(sitelib), 0,
2328                                                                0, SVfARG(sitelib), 0));
2329             assert (SvREFCNT(sitelib_sv) == 1);
2330             SvREFCNT_dec(sitelib_sv);
2331         }
2332 #  endif
2333     }
2334 #endif
2335
2336     if (!scriptname)
2337         scriptname = argv[0];
2338     if (PL_e_script) {
2339         argc++,argv--;
2340         scriptname = BIT_BUCKET;        /* don't look for script or read stdin */
2341     }
2342     else if (scriptname == NULL) {
2343 #ifdef MSDOS
2344         if ( PerlLIO_isatty(PerlIO_fileno(PerlIO_stdin())) )
2345             moreswitches("h");
2346 #endif
2347         scriptname = "-";
2348     }
2349
2350     assert (!TAINT_get);
2351     init_perllib();
2352
2353     {
2354         bool suidscript = FALSE;
2355
2356         rsfp = open_script(scriptname, dosearch, &suidscript);
2357         if (!rsfp) {
2358             rsfp = PerlIO_stdin();
2359             lex_start_flags = LEX_DONT_CLOSE_RSFP;
2360         }
2361
2362         validate_suid(rsfp);
2363
2364 #ifndef PERL_MICRO
2365 #  if defined(SIGCHLD) || defined(SIGCLD)
2366         {
2367 #  ifndef SIGCHLD
2368 #    define SIGCHLD SIGCLD
2369 #  endif
2370             Sighandler_t sigstate = rsignal_state(SIGCHLD);
2371             if (sigstate == (Sighandler_t) SIG_IGN) {
2372                 Perl_ck_warner(aTHX_ packWARN(WARN_SIGNAL),
2373                                "Can't ignore signal CHLD, forcing to default");
2374                 (void)rsignal(SIGCHLD, (Sighandler_t)SIG_DFL);
2375             }
2376         }
2377 #  endif
2378 #endif
2379
2380         if (doextract) {
2381
2382             /* This will croak if suidscript is true, as -x cannot be used with
2383                setuid scripts.  */
2384             forbid_setid('x', suidscript);
2385             /* Hence you can't get here if suidscript is true */
2386
2387             linestr_sv = newSV_type(SVt_PV);
2388             lex_start_flags |= LEX_START_COPIED;
2389             find_beginning(linestr_sv, rsfp);
2390             if (cddir && PerlDir_chdir( (char *)cddir ) < 0)
2391                 Perl_croak(aTHX_ "Can't chdir to %s",cddir);
2392         }
2393     }
2394
2395     PL_main_cv = PL_compcv = MUTABLE_CV(newSV_type(SVt_PVCV));
2396     CvUNIQUE_on(PL_compcv);
2397
2398     CvPADLIST_set(PL_compcv, pad_new(0));
2399
2400     PL_isarev = newHV();
2401
2402     boot_core_PerlIO();
2403     boot_core_UNIVERSAL();
2404     boot_core_mro();
2405     newXS("Internals::V", S_Internals_V, __FILE__);
2406
2407     if (xsinit)
2408         (*xsinit)(aTHX);        /* in case linked C routines want magical variables */
2409 #ifndef PERL_MICRO
2410 #if defined(VMS) || defined(WIN32) || defined(DJGPP) || defined(__CYGWIN__) || defined(SYMBIAN)
2411     init_os_extras();
2412 #endif
2413 #endif
2414
2415 #ifdef USE_SOCKS
2416 #   ifdef HAS_SOCKS5_INIT
2417     socks5_init(argv[0]);
2418 #   else
2419     SOCKSinit(argv[0]);
2420 #   endif
2421 #endif
2422
2423     init_predump_symbols();
2424     /* init_postdump_symbols not currently designed to be called */
2425     /* more than once (ENV isn't cleared first, for example)     */
2426     /* But running with -u leaves %ENV & @ARGV undefined!    XXX */
2427     if (!PL_do_undump)
2428         init_postdump_symbols(argc,argv,env);
2429
2430     /* PL_unicode is turned on by -C, or by $ENV{PERL_UNICODE},
2431      * or explicitly in some platforms.
2432      * PL_utf8locale is conditionally turned on by
2433      * locale.c:Perl_init_i18nl10n() if the environment
2434      * look like the user wants to use UTF-8. */
2435 #if defined(__SYMBIAN32__)
2436     PL_unicode = PERL_UNICODE_STD_FLAG; /* See PERL_SYMBIAN_CONSOLE_UTF8. */
2437 #endif
2438 #  ifndef PERL_IS_MINIPERL
2439     if (PL_unicode) {
2440          /* Requires init_predump_symbols(). */
2441          if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
2442               IO* io;
2443               PerlIO* fp;
2444               SV* sv;
2445
2446               /* Turn on UTF-8-ness on STDIN, STDOUT, STDERR
2447                * and the default open disciplines. */
2448               if ((PL_unicode & PERL_UNICODE_STDIN_FLAG) &&
2449                   PL_stdingv  && (io = GvIO(PL_stdingv)) &&
2450                   (fp = IoIFP(io)))
2451                    PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2452               if ((PL_unicode & PERL_UNICODE_STDOUT_FLAG) &&
2453                   PL_defoutgv && (io = GvIO(PL_defoutgv)) &&
2454                   (fp = IoOFP(io)))
2455                    PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2456               if ((PL_unicode & PERL_UNICODE_STDERR_FLAG) &&
2457                   PL_stderrgv && (io = GvIO(PL_stderrgv)) &&
2458                   (fp = IoOFP(io)))
2459                    PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2460               if ((PL_unicode & PERL_UNICODE_INOUT_FLAG) &&
2461                   (sv = GvSV(gv_fetchpvs("\017PEN", GV_ADD|GV_NOTQUAL,
2462                                          SVt_PV)))) {
2463                    U32 in  = PL_unicode & PERL_UNICODE_IN_FLAG;
2464                    U32 out = PL_unicode & PERL_UNICODE_OUT_FLAG;
2465                    if (in) {
2466                         if (out)
2467                              sv_setpvs(sv, ":utf8\0:utf8");
2468                         else
2469                              sv_setpvs(sv, ":utf8\0");
2470                    }
2471                    else if (out)
2472                         sv_setpvs(sv, "\0:utf8");
2473                    SvSETMAGIC(sv);
2474               }
2475          }
2476     }
2477 #endif
2478
2479     {
2480         const char *s;
2481     if ((s = PerlEnv_getenv("PERL_SIGNALS"))) {
2482          if (strEQ(s, "unsafe"))
2483               PL_signals |=  PERL_SIGNALS_UNSAFE_FLAG;
2484          else if (strEQ(s, "safe"))
2485               PL_signals &= ~PERL_SIGNALS_UNSAFE_FLAG;
2486          else
2487               Perl_croak(aTHX_ "PERL_SIGNALS illegal: \"%s\"", s);
2488     }
2489     }
2490
2491
2492     lex_start(linestr_sv, rsfp, lex_start_flags);
2493     SvREFCNT_dec(linestr_sv);
2494
2495     PL_subname = newSVpvs("main");
2496
2497     if (add_read_e_script)
2498         filter_add(read_e_script, NULL);
2499
2500     /* now parse the script */
2501
2502     SETERRNO(0,SS_NORMAL);
2503     if (yyparse(GRAMPROG) || PL_parser->error_count) {
2504         abort_execution("", PL_origfilename);
2505     }
2506     CopLINE_set(PL_curcop, 0);
2507     SET_CURSTASH(PL_defstash);
2508     if (PL_e_script) {
2509         SvREFCNT_dec(PL_e_script);
2510         PL_e_script = NULL;
2511     }
2512
2513     if (PL_do_undump)
2514         my_unexec();
2515
2516     if (isWARN_ONCE) {
2517         SAVECOPFILE(PL_curcop);
2518         SAVECOPLINE(PL_curcop);
2519         gv_check(PL_defstash);
2520     }
2521
2522     LEAVE;
2523     FREETMPS;
2524
2525 #ifdef MYMALLOC
2526     {
2527         const char *s;
2528         UV uv;
2529         s = PerlEnv_getenv("PERL_DEBUG_MSTATS");
2530         if (s && grok_atoUV(s, &uv, NULL) && uv >= 2)
2531             dump_mstats("after compilation:");
2532     }
2533 #endif
2534
2535     ENTER;
2536     PL_restartjmpenv = NULL;
2537     PL_restartop = 0;
2538     return NULL;
2539 }
2540
2541 /*
2542 =for apidoc Am|int|perl_run|PerlInterpreter *my_perl
2543
2544 Tells a Perl interpreter to run its main program.  See L<perlembed>
2545 for a tutorial.
2546
2547 C<my_perl> points to the Perl interpreter.  It must have been previously
2548 created through the use of L</perl_alloc> and L</perl_construct>, and
2549 initialised through L</perl_parse>.  This function should not be called
2550 if L</perl_parse> returned a non-zero value, indicating a failure in
2551 initialisation or compilation.
2552
2553 This function executes code in C<INIT> blocks, and then executes the
2554 main program.  The code to be executed is that established by the prior
2555 call to L</perl_parse>.  If the interpreter's C<PL_exit_flags> word
2556 does not have the C<PERL_EXIT_DESTRUCT_END> flag set, then this function
2557 will also execute code in C<END> blocks.  If it is desired to make any
2558 further use of the interpreter after calling this function, then C<END>
2559 blocks should be postponed to L</perl_destruct> time by setting that flag.
2560
2561 Returns an integer of slightly tricky interpretation.  The correct use
2562 of the return value is as a truth value indicating whether the program
2563 terminated non-locally.  If zero is returned, this indicates that
2564 the program ran to completion, and it is safe to make other use of the
2565 interpreter (provided that the C<PERL_EXIT_DESTRUCT_END> flag was set as
2566 described above).  If a non-zero value is returned, this indicates that
2567 the interpreter wants to terminate early.  The interpreter should not be
2568 just abandoned because of this desire to terminate; the caller should
2569 proceed to shut the interpreter down cleanly with L</perl_destruct>
2570 and free it with L</perl_free>.
2571
2572 For historical reasons, the non-zero return value also attempts to
2573 be a suitable value to pass to the C library function C<exit> (or to
2574 return from C<main>), to serve as an exit code indicating the nature of
2575 the way the program terminated.  However, this isn't portable, due to
2576 differing exit code conventions.  An attempt is made to return an exit
2577 code of the type required by the host operating system, but because
2578 it is constrained to be non-zero, it is not necessarily possible to
2579 indicate every type of exit.  It is only reliable on Unix, where a zero
2580 exit code can be augmented with a set bit that will be ignored.  In any
2581 case, this function is not the correct place to acquire an exit code:
2582 one should get that from L</perl_destruct>.
2583
2584 =cut
2585 */
2586
2587 int
2588 perl_run(pTHXx)
2589 {
2590     I32 oldscope;
2591     int ret = 0;
2592     dJMPENV;
2593
2594     PERL_ARGS_ASSERT_PERL_RUN;
2595 #ifndef MULTIPLICITY
2596     PERL_UNUSED_ARG(my_perl);
2597 #endif
2598
2599     oldscope = PL_scopestack_ix;
2600 #ifdef VMS
2601     VMSISH_HUSHED = 0;
2602 #endif
2603
2604     JMPENV_PUSH(ret);
2605     switch (ret) {
2606     case 1:
2607         cxstack_ix = -1;                /* start context stack again */
2608         goto redo_body;
2609     case 0:                             /* normal completion */
2610  redo_body:
2611         run_body(oldscope);
2612         /* FALLTHROUGH */
2613     case 2:                             /* my_exit() */
2614         while (PL_scopestack_ix > oldscope)
2615             LEAVE;
2616         FREETMPS;
2617         SET_CURSTASH(PL_defstash);
2618         if (!(PL_exit_flags & PERL_EXIT_DESTRUCT_END) &&
2619             PL_endav && !PL_minus_c) {
2620             PERL_SET_PHASE(PERL_PHASE_END);
2621             call_list(oldscope, PL_endav);
2622         }
2623 #ifdef MYMALLOC
2624         if (PerlEnv_getenv("PERL_DEBUG_MSTATS"))
2625             dump_mstats("after execution:  ");
2626 #endif
2627         ret = STATUS_EXIT;
2628         break;
2629     case 3:
2630         if (PL_restartop) {
2631             POPSTACK_TO(PL_mainstack);
2632             goto redo_body;
2633         }
2634         PerlIO_printf(Perl_error_log, "panic: restartop in perl_run\n");
2635         FREETMPS;
2636         ret = 1;
2637         break;
2638     }
2639
2640     JMPENV_POP;
2641     return ret;
2642 }
2643
2644 STATIC void
2645 S_run_body(pTHX_ I32 oldscope)
2646 {
2647     DEBUG_r(PerlIO_printf(Perl_debug_log, "%s $` $& $' support (0x%x).\n",
2648                     PL_sawampersand ? "Enabling" : "Omitting",
2649                     (unsigned int)(PL_sawampersand)));
2650
2651     if (!PL_restartop) {
2652 #ifdef DEBUGGING
2653         if (DEBUG_x_TEST || DEBUG_B_TEST)
2654             dump_all_perl(!DEBUG_B_TEST);
2655         if (!DEBUG_q_TEST)
2656           PERL_DEBUG(PerlIO_printf(Perl_debug_log, "\nEXECUTING...\n\n"));
2657 #endif
2658
2659         if (PL_minus_c) {
2660             PerlIO_printf(Perl_error_log, "%s syntax OK\n", PL_origfilename);
2661             my_exit(0);
2662         }
2663         if (PERLDB_SINGLE && PL_DBsingle)
2664             PL_DBsingle_iv = 1;
2665         if (PL_initav) {
2666             PERL_SET_PHASE(PERL_PHASE_INIT);
2667             call_list(oldscope, PL_initav);
2668         }
2669 #ifdef PERL_DEBUG_READONLY_OPS
2670         if (PL_main_root && PL_main_root->op_slabbed)
2671             Slab_to_ro(OpSLAB(PL_main_root));
2672 #endif
2673     }
2674
2675     /* do it */
2676
2677     PERL_SET_PHASE(PERL_PHASE_RUN);
2678
2679     if (PL_restartop) {
2680         PL_restartjmpenv = NULL;
2681         PL_op = PL_restartop;
2682         PL_restartop = 0;
2683         CALLRUNOPS(aTHX);
2684     }
2685     else if (PL_main_start) {
2686         CvDEPTH(PL_main_cv) = 1;
2687         PL_op = PL_main_start;
2688         CALLRUNOPS(aTHX);
2689     }
2690     my_exit(0);
2691     NOT_REACHED; /* NOTREACHED */
2692 }
2693
2694 /*
2695 =head1 SV Manipulation Functions
2696
2697 =for apidoc p||get_sv
2698
2699 Returns the SV of the specified Perl scalar.  C<flags> are passed to
2700 C<gv_fetchpv>.  If C<GV_ADD> is set and the
2701 Perl variable does not exist then it will be created.  If C<flags> is zero
2702 and the variable does not exist then NULL is returned.
2703
2704 =cut
2705 */
2706
2707 SV*
2708 Perl_get_sv(pTHX_ const char *name, I32 flags)
2709 {
2710     GV *gv;
2711
2712     PERL_ARGS_ASSERT_GET_SV;
2713
2714     gv = gv_fetchpv(name, flags, SVt_PV);
2715     if (gv)
2716         return GvSV(gv);
2717     return NULL;
2718 }
2719
2720 /*
2721 =head1 Array Manipulation Functions
2722
2723 =for apidoc p||get_av
2724
2725 Returns the AV of the specified Perl global or package array with the given
2726 name (so it won't work on lexical variables).  C<flags> are passed 
2727 to C<gv_fetchpv>.  If C<GV_ADD> is set and the
2728 Perl variable does not exist then it will be created.  If C<flags> is zero
2729 and the variable does not exist then NULL is returned.
2730
2731 Perl equivalent: C<@{"$name"}>.
2732
2733 =cut
2734 */
2735
2736 AV*
2737 Perl_get_av(pTHX_ const char *name, I32 flags)
2738 {
2739     GV* const gv = gv_fetchpv(name, flags, SVt_PVAV);
2740
2741     PERL_ARGS_ASSERT_GET_AV;
2742
2743     if (flags)
2744         return GvAVn(gv);
2745     if (gv)
2746         return GvAV(gv);
2747     return NULL;
2748 }
2749
2750 /*
2751 =head1 Hash Manipulation Functions
2752
2753 =for apidoc p||get_hv
2754
2755 Returns the HV of the specified Perl hash.  C<flags> are passed to
2756 C<gv_fetchpv>.  If C<GV_ADD> is set and the
2757 Perl variable does not exist then it will be created.  If C<flags> is zero
2758 and the variable does not exist then C<NULL> is returned.
2759
2760 =cut
2761 */
2762
2763 HV*
2764 Perl_get_hv(pTHX_ const char *name, I32 flags)
2765 {
2766     GV* const gv = gv_fetchpv(name, flags, SVt_PVHV);
2767
2768     PERL_ARGS_ASSERT_GET_HV;
2769
2770     if (flags)
2771         return GvHVn(gv);
2772     if (gv)
2773         return GvHV(gv);
2774     return NULL;
2775 }
2776
2777 /*
2778 =head1 CV Manipulation Functions
2779
2780 =for apidoc p||get_cvn_flags
2781
2782 Returns the CV of the specified Perl subroutine.  C<flags> are passed to
2783 C<gv_fetchpvn_flags>.  If C<GV_ADD> is set and the Perl subroutine does not
2784 exist then it will be declared (which has the same effect as saying
2785 C<sub name;>).  If C<GV_ADD> is not set and the subroutine does not exist
2786 then NULL is returned.
2787
2788 =for apidoc p||get_cv
2789
2790 Uses C<strlen> to get the length of C<name>, then calls C<get_cvn_flags>.
2791
2792 =cut
2793 */
2794
2795 CV*
2796 Perl_get_cvn_flags(pTHX_ const char *name, STRLEN len, I32 flags)
2797 {
2798     GV* const gv = gv_fetchpvn_flags(name, len, flags, SVt_PVCV);
2799
2800     PERL_ARGS_ASSERT_GET_CVN_FLAGS;
2801
2802     if (gv && UNLIKELY(SvROK(gv)) && SvTYPE(SvRV((SV *)gv)) == SVt_PVCV)
2803         return (CV*)SvRV((SV *)gv);
2804
2805     /* XXX this is probably not what they think they're getting.
2806      * It has the same effect as "sub name;", i.e. just a forward
2807      * declaration! */
2808     if ((flags & ~GV_NOADD_MASK) && !GvCVu(gv)) {
2809         return newSTUB(gv,0);
2810     }
2811     if (gv)
2812         return GvCVu(gv);
2813     return NULL;
2814 }
2815
2816 /* Nothing in core calls this now, but we can't replace it with a macro and
2817    move it to mathoms.c as a macro would evaluate name twice.  */
2818 CV*
2819 Perl_get_cv(pTHX_ const char *name, I32 flags)
2820 {
2821     PERL_ARGS_ASSERT_GET_CV;
2822
2823     return get_cvn_flags(name, strlen(name), flags);
2824 }
2825
2826 /* Be sure to refetch the stack pointer after calling these routines. */
2827
2828 /*
2829
2830 =head1 Callback Functions
2831
2832 =for apidoc p||call_argv
2833
2834 Performs a callback to the specified named and package-scoped Perl subroutine 
2835 with C<argv> (a C<NULL>-terminated array of strings) as arguments.  See
2836 L<perlcall>.
2837
2838 Approximate Perl equivalent: C<&{"$sub_name"}(@$argv)>.
2839
2840 =cut
2841 */
2842
2843 I32
2844 Perl_call_argv(pTHX_ const char *sub_name, I32 flags, char **argv)
2845
2846                         /* See G_* flags in cop.h */
2847                         /* null terminated arg list */
2848 {
2849     dSP;
2850
2851     PERL_ARGS_ASSERT_CALL_ARGV;
2852
2853     PUSHMARK(SP);
2854     while (*argv) {
2855         mXPUSHs(newSVpv(*argv,0));
2856         argv++;
2857     }
2858     PUTBACK;
2859     return call_pv(sub_name, flags);
2860 }
2861
2862 /*
2863 =for apidoc p||call_pv
2864
2865 Performs a callback to the specified Perl sub.  See L<perlcall>.
2866
2867 =cut
2868 */
2869
2870 I32
2871 Perl_call_pv(pTHX_ const char *sub_name, I32 flags)
2872                         /* name of the subroutine */
2873                         /* See G_* flags in cop.h */
2874 {
2875     PERL_ARGS_ASSERT_CALL_PV;
2876
2877     return call_sv(MUTABLE_SV(get_cv(sub_name, GV_ADD)), flags);
2878 }
2879
2880 /*
2881 =for apidoc p||call_method
2882
2883 Performs a callback to the specified Perl method.  The blessed object must
2884 be on the stack.  See L<perlcall>.
2885
2886 =cut
2887 */
2888
2889 I32
2890 Perl_call_method(pTHX_ const char *methname, I32 flags)
2891                         /* name of the subroutine */
2892                         /* See G_* flags in cop.h */
2893 {
2894     STRLEN len;
2895     SV* sv;
2896     PERL_ARGS_ASSERT_CALL_METHOD;
2897
2898     len = strlen(methname);
2899     sv = flags & G_METHOD_NAMED
2900         ? sv_2mortal(newSVpvn_share(methname, len,0))
2901         : newSVpvn_flags(methname, len, SVs_TEMP);
2902
2903     return call_sv(sv, flags | G_METHOD);
2904 }
2905
2906 /* May be called with any of a CV, a GV, or an SV containing the name. */
2907 /*
2908 =for apidoc p||call_sv
2909
2910 Performs a callback to the Perl sub specified by the SV.
2911
2912 If neither the C<G_METHOD> nor C<G_METHOD_NAMED> flag is supplied, the
2913 SV may be any of a CV, a GV, a reference to a CV, a reference to a GV
2914 or C<SvPV(sv)> will be used as the name of the sub to call.
2915
2916 If the C<G_METHOD> flag is supplied, the SV may be a reference to a CV or
2917 C<SvPV(sv)> will be used as the name of the method to call.
2918
2919 If the C<G_METHOD_NAMED> flag is supplied, C<SvPV(sv)> will be used as
2920 the name of the method to call.
2921
2922 Some other values are treated specially for internal use and should
2923 not be depended on.
2924
2925 See L<perlcall>.
2926
2927 =cut
2928 */
2929
2930 I32
2931 Perl_call_sv(pTHX_ SV *sv, volatile I32 flags)
2932                         /* See G_* flags in cop.h */
2933 {
2934     dVAR;
2935     LOGOP myop;         /* fake syntax tree node */
2936     METHOP method_op;
2937     I32 oldmark;
2938     volatile I32 retval = 0;
2939     bool oldcatch = CATCH_GET;
2940     int ret;
2941     OP* const oldop = PL_op;
2942     dJMPENV;
2943
2944     PERL_ARGS_ASSERT_CALL_SV;
2945
2946     if (flags & G_DISCARD) {
2947         ENTER;
2948         SAVETMPS;
2949     }
2950     if (!(flags & G_WANT)) {
2951         /* Backwards compatibility - as G_SCALAR was 0, it could be omitted.
2952          */
2953         flags |= G_SCALAR;
2954     }
2955
2956     Zero(&myop, 1, LOGOP);
2957     if (!(flags & G_NOARGS))
2958         myop.op_flags |= OPf_STACKED;
2959     myop.op_flags |= OP_GIMME_REVERSE(flags);
2960     SAVEOP();
2961     PL_op = (OP*)&myop;
2962
2963     if (!(flags & G_METHOD_NAMED)) {
2964         dSP;
2965         EXTEND(SP, 1);
2966         PUSHs(sv);
2967         PUTBACK;
2968     }
2969     oldmark = TOPMARK;
2970
2971     if (PERLDB_SUB && PL_curstash != PL_debstash
2972            /* Handle first BEGIN of -d. */
2973           && (PL_DBcv || (PL_DBcv = GvCV(PL_DBsub)))
2974            /* Try harder, since this may have been a sighandler, thus
2975             * curstash may be meaningless. */
2976           && (SvTYPE(sv) != SVt_PVCV || CvSTASH((const CV *)sv) != PL_debstash)
2977           && !(flags & G_NODEBUG))
2978         myop.op_private |= OPpENTERSUB_DB;
2979
2980     if (flags & (G_METHOD|G_METHOD_NAMED)) {
2981         Zero(&method_op, 1, METHOP);
2982         method_op.op_next = (OP*)&myop;
2983         PL_op = (OP*)&method_op;
2984         if ( flags & G_METHOD_NAMED ) {
2985             method_op.op_ppaddr = PL_ppaddr[OP_METHOD_NAMED];
2986             method_op.op_type = OP_METHOD_NAMED;
2987             method_op.op_u.op_meth_sv = sv;
2988         } else {
2989             method_op.op_ppaddr = PL_ppaddr[OP_METHOD];
2990             method_op.op_type = OP_METHOD;
2991         }
2992         myop.op_ppaddr = PL_ppaddr[OP_ENTERSUB];
2993         myop.op_type = OP_ENTERSUB;
2994     }
2995
2996     if (!(flags & G_EVAL)) {
2997         CATCH_SET(TRUE);
2998         CALL_BODY_SUB((OP*)&myop);
2999         retval = PL_stack_sp - (PL_stack_base + oldmark);
3000         CATCH_SET(oldcatch);
3001     }
3002     else {
3003         I32 old_cxix;
3004         myop.op_other = (OP*)&myop;
3005         (void)POPMARK;
3006         old_cxix = cxstack_ix;
3007         create_eval_scope(NULL, flags|G_FAKINGEVAL);
3008         INCMARK;
3009
3010         JMPENV_PUSH(ret);
3011
3012         switch (ret) {
3013         case 0:
3014  redo_body:
3015             CALL_BODY_SUB((OP*)&myop);
3016             retval = PL_stack_sp - (PL_stack_base + oldmark);
3017             if (!(flags & G_KEEPERR)) {
3018                 CLEAR_ERRSV();
3019             }
3020             break;
3021         case 1:
3022             STATUS_ALL_FAILURE;
3023             /* FALLTHROUGH */
3024         case 2:
3025             /* my_exit() was called */
3026             SET_CURSTASH(PL_defstash);
3027             FREETMPS;
3028             JMPENV_POP;
3029             my_exit_jump();
3030             NOT_REACHED; /* NOTREACHED */
3031         case 3:
3032             if (PL_restartop) {
3033                 PL_restartjmpenv = NULL;
3034                 PL_op = PL_restartop;
3035                 PL_restartop = 0;
3036                 goto redo_body;
3037             }
3038             PL_stack_sp = PL_stack_base + oldmark;
3039             if ((flags & G_WANT) == G_ARRAY)
3040                 retval = 0;
3041             else {
3042                 retval = 1;
3043                 *++PL_stack_sp = &PL_sv_undef;
3044             }
3045             break;
3046         }
3047
3048         /* if we croaked, depending on how we croaked the eval scope
3049          * may or may not have already been popped */
3050         if (cxstack_ix > old_cxix) {
3051             assert(cxstack_ix == old_cxix + 1);
3052             assert(CxTYPE(CX_CUR()) == CXt_EVAL);
3053             delete_eval_scope();
3054         }
3055         JMPENV_POP;
3056     }
3057
3058     if (flags & G_DISCARD) {
3059         PL_stack_sp = PL_stack_base + oldmark;
3060         retval = 0;
3061         FREETMPS;
3062         LEAVE;
3063     }
3064     PL_op = oldop;
3065     return retval;
3066 }
3067
3068 /* Eval a string. The G_EVAL flag is always assumed. */
3069
3070 /*
3071 =for apidoc p||eval_sv
3072
3073 Tells Perl to C<eval> the string in the SV.  It supports the same flags
3074 as C<call_sv>, with the obvious exception of C<G_EVAL>.  See L<perlcall>.
3075
3076 =cut
3077 */
3078
3079 I32
3080 Perl_eval_sv(pTHX_ SV *sv, I32 flags)
3081
3082                         /* See G_* flags in cop.h */
3083 {
3084     dVAR;
3085     UNOP myop;          /* fake syntax tree node */
3086     volatile I32 oldmark;
3087     volatile I32 retval = 0;
3088     int ret;
3089     OP* const oldop = PL_op;
3090     dJMPENV;
3091
3092     PERL_ARGS_ASSERT_EVAL_SV;
3093
3094     if (flags & G_DISCARD) {
3095         ENTER;
3096         SAVETMPS;
3097     }
3098
3099     SAVEOP();
3100     PL_op = (OP*)&myop;
3101     Zero(&myop, 1, UNOP);
3102     {
3103         dSP;
3104         oldmark = SP - PL_stack_base;
3105         EXTEND(SP, 1);
3106         PUSHs(sv);
3107         PUTBACK;
3108     }
3109
3110     if (!(flags & G_NOARGS))
3111         myop.op_flags = OPf_STACKED;
3112     myop.op_type = OP_ENTEREVAL;
3113     myop.op_flags |= OP_GIMME_REVERSE(flags);
3114     if (flags & G_KEEPERR)
3115         myop.op_flags |= OPf_SPECIAL;
3116
3117     if (flags & G_RE_REPARSING)
3118         myop.op_private = (OPpEVAL_COPHH | OPpEVAL_RE_REPARSING);
3119
3120     /* fail now; otherwise we could fail after the JMPENV_PUSH but
3121      * before a cx_pusheval(), which corrupts the stack after a croak */
3122     TAINT_PROPER("eval_sv()");
3123
3124     JMPENV_PUSH(ret);
3125     switch (ret) {
3126     case 0:
3127  redo_body:
3128         if (PL_op == (OP*)(&myop)) {
3129             PL_op = PL_ppaddr[OP_ENTEREVAL](aTHX);
3130             if (!PL_op)
3131                 goto fail; /* failed in compilation */
3132         }
3133         CALLRUNOPS(aTHX);
3134         retval = PL_stack_sp - (PL_stack_base + oldmark);
3135         if (!(flags & G_KEEPERR)) {
3136             CLEAR_ERRSV();
3137         }
3138         break;
3139     case 1:
3140         STATUS_ALL_FAILURE;
3141         /* FALLTHROUGH */
3142     case 2:
3143         /* my_exit() was called */
3144         SET_CURSTASH(PL_defstash);
3145         FREETMPS;
3146         JMPENV_POP;
3147         my_exit_jump();
3148         NOT_REACHED; /* NOTREACHED */
3149     case 3:
3150         if (PL_restartop) {
3151             PL_restartjmpenv = NULL;
3152             PL_op = PL_restartop;
3153             PL_restartop = 0;
3154             goto redo_body;
3155         }
3156       fail:
3157         PL_stack_sp = PL_stack_base + oldmark;
3158         if ((flags & G_WANT) == G_ARRAY)
3159             retval = 0;
3160         else {
3161             retval = 1;
3162             *++PL_stack_sp = &PL_sv_undef;
3163         }
3164         break;
3165     }
3166
3167     JMPENV_POP;
3168     if (flags & G_DISCARD) {
3169         PL_stack_sp = PL_stack_base + oldmark;
3170         retval = 0;
3171         FREETMPS;
3172         LEAVE;
3173     }
3174     PL_op = oldop;
3175     return retval;
3176 }
3177
3178 /*
3179 =for apidoc p||eval_pv
3180
3181 Tells Perl to C<eval> the given string in scalar context and return an SV* result.
3182
3183 =cut
3184 */
3185
3186 SV*
3187 Perl_eval_pv(pTHX_ const char *p, I32 croak_on_error)
3188 {
3189     SV* sv = newSVpv(p, 0);
3190
3191     PERL_ARGS_ASSERT_EVAL_PV;
3192
3193     eval_sv(sv, G_SCALAR);
3194     SvREFCNT_dec(sv);
3195
3196     {
3197         dSP;
3198         sv = POPs;
3199         PUTBACK;
3200     }
3201
3202     /* just check empty string or undef? */
3203     if (croak_on_error) {
3204         SV * const errsv = ERRSV;
3205         if(SvTRUE_NN(errsv))
3206             /* replace with croak_sv? */
3207             Perl_croak_nocontext("%s", SvPV_nolen_const(errsv));
3208     }
3209
3210     return sv;
3211 }
3212
3213 /* Require a module. */
3214
3215 /*
3216 =head1 Embedding Functions
3217
3218 =for apidoc p||require_pv
3219
3220 Tells Perl to C<require> the file named by the string argument.  It is
3221 analogous to the Perl code C<eval "require '$file'">.  It's even
3222 implemented that way; consider using load_module instead.
3223
3224 =cut */
3225
3226 void
3227 Perl_require_pv(pTHX_ const char *pv)
3228 {
3229     dSP;
3230     SV* sv;
3231
3232     PERL_ARGS_ASSERT_REQUIRE_PV;
3233
3234     PUSHSTACKi(PERLSI_REQUIRE);
3235     sv = Perl_newSVpvf(aTHX_ "require q%c%s%c", 0, pv, 0);
3236     eval_sv(sv_2mortal(sv), G_DISCARD);
3237     POPSTACK;
3238 }
3239
3240 STATIC void
3241 S_usage(pTHX)           /* XXX move this out into a module ? */
3242 {
3243     /* This message really ought to be max 23 lines.
3244      * Removed -h because the user already knows that option. Others? */
3245
3246     /* Grouped as 6 lines per C string literal, to keep under the ANSI C 89
3247        minimum of 509 character string literals.  */
3248     static const char * const usage_msg[] = {
3249 "  -0[octal]         specify record separator (\\0, if no argument)\n"
3250 "  -a                autosplit mode with -n or -p (splits $_ into @F)\n"
3251 "  -C[number/list]   enables the listed Unicode features\n"
3252 "  -c                check syntax only (runs BEGIN and CHECK blocks)\n"
3253 "  -d[:debugger]     run program under debugger\n"
3254 "  -D[number/list]   set debugging flags (argument is a bit mask or alphabets)\n",
3255 "  -e program        one line of program (several -e's allowed, omit programfile)\n"
3256 "  -E program        like -e, but enables all optional features\n"
3257 "  -f                don't do $sitelib/sitecustomize.pl at startup\n"
3258 "  -F/pattern/       split() pattern for -a switch (//'s are optional)\n"
3259 "  -i[extension]     edit <> files in place (makes backup if extension supplied)\n"
3260 "  -Idirectory       specify @INC/#include directory (several -I's allowed)\n",
3261 "  -l[octal]         enable line ending processing, specifies line terminator\n"
3262 "  -[mM][-]module    execute \"use/no module...\" before executing program\n"
3263 "  -n                assume \"while (<>) { ... }\" loop around program\n"
3264 "  -p                assume loop like -n but print line also, like sed\n"
3265 "  -s                enable rudimentary parsing for switches after programfile\n"
3266 "  -S                look for programfile using PATH environment variable\n",
3267 "  -t                enable tainting warnings\n"
3268 "  -T                enable tainting checks\n"
3269 "  -u                dump core after parsing program\n"
3270 "  -U                allow unsafe operations\n"
3271 "  -v                print version, patchlevel and license\n"
3272 "  -V[:variable]     print configuration summary (or a single Config.pm variable)\n",
3273 "  -w                enable many useful warnings\n"
3274 "  -W                enable all warnings\n"
3275 "  -x[directory]     ignore text before #!perl line (optionally cd to directory)\n"
3276 "  -X                disable all warnings\n"
3277 "  \n"
3278 "Run 'perldoc perl' for more help with Perl.\n\n",
3279 NULL
3280 };
3281     const char * const *p = usage_msg;
3282     PerlIO *out = PerlIO_stdout();
3283
3284     PerlIO_printf(out,
3285                   "\nUsage: %s [switches] [--] [programfile] [arguments]\n",
3286                   PL_origargv[0]);
3287     while (*p)
3288         PerlIO_puts(out, *p++);
3289     my_exit(0);
3290 }
3291
3292 /* convert a string of -D options (or digits) into an int.
3293  * sets *s to point to the char after the options */
3294
3295 #ifdef DEBUGGING
3296 int
3297 Perl_get_debug_opts(pTHX_ const char **s, bool givehelp)
3298 {
3299     static const char * const usage_msgd[] = {
3300       " Debugging flag values: (see also -d)\n"
3301       "  p  Tokenizing and parsing (with v, displays parse stack)\n"
3302       "  s  Stack snapshots (with v, displays all stacks)\n"
3303       "  l  Context (loop) stack processing\n"
3304       "  t  Trace execution\n"
3305       "  o  Method and overloading resolution\n",
3306       "  c  String/numeric conversions\n"
3307       "  P  Print profiling info, source file input state\n"
3308       "  m  Memory and SV allocation\n"
3309       "  f  Format processing\n"
3310       "  r  Regular expression parsing and execution\n"
3311       "  x  Syntax tree dump\n",
3312       "  u  Tainting checks\n"
3313       "  H  Hash dump -- usurps values()\n"
3314       "  X  Scratchpad allocation\n"
3315       "  D  Cleaning up\n"
3316       "  S  Op slab allocation\n"
3317       "  T  Tokenising\n"
3318       "  R  Include reference counts of dumped variables (eg when using -Ds)\n",
3319       "  J  Do not s,t,P-debug (Jump over) opcodes within package DB\n"
3320       "  v  Verbose: use in conjunction with other flags\n"
3321       "  C  Copy On Write\n"
3322       "  A  Consistency checks on internal structures\n"
3323       "  q  quiet - currently only suppresses the 'EXECUTING' message\n"
3324       "  M  trace smart match resolution\n"
3325       "  B  dump suBroutine definitions, including special Blocks like BEGIN\n",
3326       "  L  trace some locale setting information--for Perl core development\n",
3327       "  i  trace PerlIO layer processing\n",
3328       NULL
3329     };
3330     UV uv = 0;
3331
3332     PERL_ARGS_ASSERT_GET_DEBUG_OPTS;
3333
3334     if (isALPHA(**s)) {
3335         /* if adding extra options, remember to update DEBUG_MASK */
3336         static const char debopts[] = "psltocPmfrxuUHXDSTRJvCAqMBLi";
3337
3338         for (; isWORDCHAR(**s); (*s)++) {
3339             const char * const d = strchr(debopts,**s);
3340             if (d)
3341                 uv |= 1 << (d - debopts);
3342             else if (ckWARN_d(WARN_DEBUGGING))
3343                 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3344                     "invalid option -D%c, use -D'' to see choices\n", **s);
3345         }
3346     }
3347     else if (isDIGIT(**s)) {
3348         const char* e = *s + strlen(*s);
3349         if (grok_atoUV(*s, &uv, &e))
3350             *s = e;
3351         for (; isWORDCHAR(**s); (*s)++) ;
3352     }
3353     else if (givehelp) {
3354       const char *const *p = usage_msgd;
3355       while (*p) PerlIO_puts(PerlIO_stdout(), *p++);
3356     }
3357     return (int)uv; /* ignore any UV->int conversion loss */
3358 }
3359 #endif
3360
3361 /* This routine handles any switches that can be given during run */
3362
3363 const char *
3364 Perl_moreswitches(pTHX_ const char *s)
3365 {
3366     dVAR;
3367     UV rschar;
3368     const char option = *s; /* used to remember option in -m/-M code */
3369
3370     PERL_ARGS_ASSERT_MORESWITCHES;
3371
3372     switch (*s) {
3373     case '0':
3374     {
3375          I32 flags = 0;
3376          STRLEN numlen;
3377
3378          SvREFCNT_dec(PL_rs);
3379          if (s[1] == 'x' && s[2]) {
3380               const char *e = s+=2;
3381               U8 *tmps;
3382
3383               while (*e)
3384                 e++;
3385               numlen = e - s;
3386               flags = PERL_SCAN_SILENT_ILLDIGIT;
3387               rschar = (U32)grok_hex(s, &numlen, &flags, NULL);
3388               if (s + numlen < e) {
3389                    rschar = 0; /* Grandfather -0xFOO as -0 -xFOO. */
3390                    numlen = 0;
3391                    s--;
3392               }
3393               PL_rs = newSVpvs("");
3394               tmps = (U8*) SvGROW(PL_rs, (STRLEN)(UVCHR_SKIP(rschar) + 1));
3395               uvchr_to_utf8(tmps, rschar);
3396               SvCUR_set(PL_rs, UVCHR_SKIP(rschar));
3397               SvUTF8_on(PL_rs);
3398          }
3399          else {
3400               numlen = 4;
3401               rschar = (U32)grok_oct(s, &numlen, &flags, NULL);
3402               if (rschar & ~((U8)~0))
3403                    PL_rs = &PL_sv_undef;
3404               else if (!rschar && numlen >= 2)
3405                    PL_rs = newSVpvs("");
3406               else {
3407                    char ch = (char)rschar;
3408                    PL_rs = newSVpvn(&ch, 1);
3409               }
3410          }
3411          sv_setsv(get_sv("/", GV_ADD), PL_rs);
3412          return s + numlen;
3413     }
3414     case 'C':
3415         s++;
3416         PL_unicode = parse_unicode_opts( (const char **)&s );
3417         if (PL_unicode & PERL_UNICODE_UTF8CACHEASSERT_FLAG)
3418             PL_utf8cache = -1;
3419         return s;
3420     case 'F':
3421         PL_minus_a = TRUE;
3422         PL_minus_F = TRUE;
3423         PL_minus_n = TRUE;
3424         PL_splitstr = ++s;
3425         while (*s && !isSPACE(*s)) ++s;
3426         PL_splitstr = savepvn(PL_splitstr, s - PL_splitstr);
3427         return s;
3428     case 'a':
3429         PL_minus_a = TRUE;
3430         PL_minus_n = TRUE;
3431         s++;
3432         return s;
3433     case 'c':
3434         PL_minus_c = TRUE;
3435         s++;
3436         return s;
3437     case 'd':
3438         forbid_setid('d', FALSE);
3439         s++;
3440
3441         /* -dt indicates to the debugger that threads will be used */
3442         if (*s == 't' && !isWORDCHAR(s[1])) {
3443             ++s;
3444             my_setenv("PERL5DB_THREADED", "1");
3445         }
3446
3447         /* The following permits -d:Mod to accepts arguments following an =
3448            in the fashion that -MSome::Mod does. */
3449         if (*s == ':' || *s == '=') {
3450             const char *start;
3451             const char *end;
3452             SV *sv;
3453
3454             if (*++s == '-') {
3455                 ++s;
3456                 sv = newSVpvs("no Devel::");
3457             } else {
3458                 sv = newSVpvs("use Devel::");
3459             }
3460
3461             start = s;
3462             end = s + strlen(s);
3463
3464             /* We now allow -d:Module=Foo,Bar and -d:-Module */
3465             while(isWORDCHAR(*s) || *s==':') ++s;
3466             if (*s != '=')
3467                 sv_catpvn(sv, start, end - start);
3468             else {
3469                 sv_catpvn(sv, start, s-start);
3470                 /* Don't use NUL as q// delimiter here, this string goes in the
3471                  * environment. */
3472                 Perl_sv_catpvf(aTHX_ sv, " split(/,/,q{%s});", ++s);
3473             }
3474             s = end;
3475             my_setenv("PERL5DB", SvPV_nolen_const(sv));
3476             SvREFCNT_dec(sv);
3477         }
3478         if (!PL_perldb) {
3479             PL_perldb = PERLDB_ALL;
3480             init_debugger();
3481         }
3482         return s;
3483     case 'D':
3484     {   
3485 #ifdef DEBUGGING
3486         forbid_setid('D', FALSE);
3487         s++;
3488         PL_debug = get_debug_opts( (const char **)&s, 1) | DEBUG_TOP_FLAG;
3489 #else /* !DEBUGGING */
3490         if (ckWARN_d(WARN_DEBUGGING))
3491             Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3492                    "Recompile perl with -DDEBUGGING to use -D switch (did you mean -d ?)\n");
3493         for (s++; isWORDCHAR(*s); s++) ;
3494 #endif
3495         return s;
3496         NOT_REACHED; /* NOTREACHED */
3497     }   
3498     case 'h':
3499         usage();
3500         NOT_REACHED; /* NOTREACHED */
3501
3502     case 'i':
3503         Safefree(PL_inplace);
3504         {
3505             const char * const start = ++s;
3506             while (*s && !isSPACE(*s))
3507                 ++s;
3508
3509             PL_inplace = savepvn(start, s - start);
3510         }
3511         return s;
3512     case 'I':   /* -I handled both here and in parse_body() */
3513         forbid_setid('I', FALSE);
3514         ++s;
3515         while (*s && isSPACE(*s))
3516             ++s;
3517         if (*s) {
3518             const char *e, *p;
3519             p = s;
3520             /* ignore trailing spaces (possibly followed by other switches) */
3521             do {
3522                 for (e = p; *e && !isSPACE(*e); e++) ;
3523                 p = e;
3524                 while (isSPACE(*p))
3525                     p++;
3526             } while (*p && *p != '-');
3527             incpush(s, e-s,
3528                     INCPUSH_ADD_SUB_DIRS|INCPUSH_ADD_OLD_VERS|INCPUSH_UNSHIFT);
3529             s = p;
3530             if (*s == '-')
3531                 s++;
3532         }
3533         else
3534             Perl_croak(aTHX_ "No directory specified for -I");
3535         return s;
3536     case 'l':
3537         PL_minus_l = TRUE;
3538         s++;
3539         if (PL_ors_sv) {
3540             SvREFCNT_dec(PL_ors_sv);
3541             PL_ors_sv = NULL;
3542         }
3543         if (isDIGIT(*s)) {
3544             I32 flags = 0;
3545             STRLEN numlen;
3546             PL_ors_sv = newSVpvs("\n");
3547             numlen = 3 + (*s == '0');
3548             *SvPVX(PL_ors_sv) = (char)grok_oct(s, &numlen, &flags, NULL);
3549             s += numlen;
3550         }
3551         else {
3552             if (RsPARA(PL_rs)) {
3553                 PL_ors_sv = newSVpvs("\n\n");
3554             }
3555             else {
3556                 PL_ors_sv = newSVsv(PL_rs);
3557             }
3558         }
3559         return s;
3560     case 'M':
3561         forbid_setid('M', FALSE);       /* XXX ? */
3562         /* FALLTHROUGH */
3563     case 'm':
3564         forbid_setid('m', FALSE);       /* XXX ? */
3565         if (*++s) {
3566             const char *start;
3567             const char *end;
3568             SV *sv;
3569             const char *use = "use ";
3570             bool colon = FALSE;
3571             /* -M-foo == 'no foo'       */
3572             /* Leading space on " no " is deliberate, to make both
3573                possibilities the same length.  */
3574             if (*s == '-') { use = " no "; ++s; }
3575             sv = newSVpvn(use,4);
3576             start = s;
3577             /* We allow -M'Module qw(Foo Bar)'  */
3578             while(isWORDCHAR(*s) || *s==':') {
3579                 if( *s++ == ':' ) {
3580                     if( *s == ':' ) 
3581                         s++;
3582                     else
3583                         colon = TRUE;
3584                 }
3585             }
3586             if (s == start)
3587                 Perl_croak(aTHX_ "Module name required with -%c option",
3588                                     option);
3589             if (colon) 
3590                 Perl_croak(aTHX_ "Invalid module name %.*s with -%c option: "
3591                                     "contains single ':'",
3592                                     (int)(s - start), start, option);
3593             end = s + strlen(s);
3594             if (*s != '=') {
3595                 sv_catpvn(sv, start, end - start);
3596                 if (option == 'm') {
3597                     if (*s != '\0')
3598                         Perl_croak(aTHX_ "Can't use '%c' after -mname", *s);
3599                     sv_catpvs( sv, " ()");
3600                 }
3601             } else {
3602                 sv_catpvn(sv, start, s-start);
3603                 /* Use NUL as q''-delimiter.  */
3604                 sv_catpvs(sv, " split(/,/,q\0");
3605                 ++s;
3606                 sv_catpvn(sv, s, end - s);
3607                 sv_catpvs(sv,  "\0)");
3608             }
3609             s = end;
3610             Perl_av_create_and_push(aTHX_ &PL_preambleav, sv);
3611         }
3612         else
3613             Perl_croak(aTHX_ "Missing argument to -%c", option);
3614         return s;
3615     case 'n':
3616         PL_minus_n = TRUE;
3617         s++;
3618         return s;
3619     case 'p':
3620         PL_minus_p = TRUE;
3621         s++;
3622         return s;
3623     case 's':
3624         forbid_setid('s', FALSE);
3625         PL_doswitches = TRUE;
3626         s++;
3627         return s;
3628     case 't':
3629     case 'T':
3630 #if defined(SILENT_NO_TAINT_SUPPORT)
3631             /* silently ignore */
3632 #elif defined(NO_TAINT_SUPPORT)
3633         Perl_croak_nocontext("This perl was compiled without taint support. "
3634                    "Cowardly refusing to run with -t or -T flags");
3635 #else
3636         if (!TAINTING_get)
3637             TOO_LATE_FOR(*s);
3638 #endif
3639         s++;
3640         return s;
3641     case 'u':
3642         PL_do_undump = TRUE;
3643         s++;
3644         return s;
3645     case 'U':
3646         PL_unsafe = TRUE;
3647         s++;
3648         return s;
3649     case 'v':
3650         minus_v();
3651     case 'w':
3652         if (! (PL_dowarn & G_WARN_ALL_MASK)) {
3653             PL_dowarn |= G_WARN_ON;
3654         }
3655         s++;
3656         return s;
3657     case 'W':
3658         PL_dowarn = G_WARN_ALL_ON|G_WARN_ON;
3659         if (!specialWARN(PL_compiling.cop_warnings))
3660             PerlMemShared_free(PL_compiling.cop_warnings);
3661         PL_compiling.cop_warnings = pWARN_ALL ;
3662         s++;
3663         return s;
3664     case 'X':
3665         PL_dowarn = G_WARN_ALL_OFF;
3666         if (!specialWARN(PL_compiling.cop_warnings))
3667             PerlMemShared_free(PL_compiling.cop_warnings);
3668         PL_compiling.cop_warnings = pWARN_NONE ;
3669         s++;
3670         return s;
3671     case '*':
3672     case ' ':
3673         while( *s == ' ' )
3674           ++s;
3675         if (s[0] == '-')        /* Additional switches on #! line. */
3676             return s+1;
3677         break;
3678     case '-':
3679     case 0:
3680 #if defined(WIN32) || !defined(PERL_STRICT_CR)
3681     case '\r':
3682 #endif
3683     case '\n':
3684     case '\t':
3685         break;
3686 #ifdef ALTERNATE_SHEBANG
3687     case 'S':                   /* OS/2 needs -S on "extproc" line. */
3688         break;
3689 #endif
3690     case 'e': case 'f': case 'x': case 'E':
3691 #ifndef ALTERNATE_SHEBANG
3692     case 'S':
3693 #endif
3694     case 'V':
3695         Perl_croak(aTHX_ "Can't emulate -%.1s on #! line",s);
3696     default:
3697         Perl_croak(aTHX_
3698             "Unrecognized switch: -%.1s  (-h will show valid options)",s
3699         );
3700     }
3701     return NULL;
3702 }
3703
3704
3705 STATIC void
3706 S_minus_v(pTHX)
3707 {
3708         PerlIO * PIO_stdout;
3709         {
3710             const char * const level_str = "v" PERL_VERSION_STRING;
3711             const STRLEN level_len = sizeof("v" PERL_VERSION_STRING)-1;
3712 #ifdef PERL_PATCHNUM
3713             SV* level;
3714 #  ifdef PERL_GIT_UNCOMMITTED_CHANGES
3715             static const char num [] = PERL_PATCHNUM "*";
3716 #  else
3717             static const char num [] = PERL_PATCHNUM;
3718 #  endif
3719             {
3720                 const STRLEN num_len = sizeof(num)-1;
3721                 /* A very advanced compiler would fold away the strnEQ
3722                    and this whole conditional, but most (all?) won't do it.
3723                    SV level could also be replaced by with preprocessor
3724                    catenation.
3725                 */
3726                 if (num_len >= level_len && strnEQ(num,level_str,level_len)) {
3727                     /* per 46807d8e80, PERL_PATCHNUM is outside of the control
3728                        of the interp so it might contain format characters
3729                     */
3730                     level = newSVpvn(num, num_len);
3731                 } else {
3732                     level = Perl_newSVpvf_nocontext("%s (%s)", level_str, num);
3733                 }
3734             }
3735 #else
3736         SV* level = newSVpvn(level_str, level_len);
3737 #endif /* #ifdef PERL_PATCHNUM */
3738         PIO_stdout =  PerlIO_stdout();
3739             PerlIO_printf(PIO_stdout,
3740                 "\nThis is perl "       STRINGIFY(PERL_REVISION)
3741                 ", version "            STRINGIFY(PERL_VERSION)
3742                 ", subversion "         STRINGIFY(PERL_SUBVERSION)
3743                 " (%" SVf ") built for "        ARCHNAME, SVfARG(level)
3744                 );
3745             SvREFCNT_dec_NN(level);
3746         }
3747 #if defined(LOCAL_PATCH_COUNT)
3748         if (LOCAL_PATCH_COUNT > 0)
3749             PerlIO_printf(PIO_stdout,
3750                           "\n(with %d registered patch%s, "
3751                           "see perl -V for more detail)",
3752                           LOCAL_PATCH_COUNT,
3753                           (LOCAL_PATCH_COUNT!=1) ? "es" : "");
3754 #endif
3755
3756         PerlIO_printf(PIO_stdout,
3757                       "\n\nCopyright 1987-2018, Larry Wall\n");
3758 #ifdef MSDOS
3759         PerlIO_printf(PIO_stdout,
3760                       "\nMS-DOS port Copyright (c) 1989, 1990, Diomidis Spinellis\n");
3761 #endif
3762 #ifdef DJGPP
3763         PerlIO_printf(PIO_stdout,
3764                       "djgpp v2 port (jpl5003c) by Hirofumi Watanabe, 1996\n"
3765                       "djgpp v2 port (perl5004+) by Laszlo Molnar, 1997-1999\n");
3766 #endif
3767 #ifdef OS2
3768         PerlIO_printf(PIO_stdout,
3769                       "\n\nOS/2 port Copyright (c) 1990, 1991, Raymond Chen, Kai Uwe Rommel\n"
3770                       "Version 5 port Copyright (c) 1994-2002, Andreas Kaiser, Ilya Zakharevich\n");
3771 #endif
3772 #ifdef OEMVS
3773         PerlIO_printf(PIO_stdout,
3774                       "MVS (OS390) port by Mortice Kern Systems, 1997-1999\n");
3775 #endif
3776 #ifdef __VOS__
3777         PerlIO_printf(PIO_stdout,
3778                       "Stratus OpenVOS port by Paul.Green@stratus.com, 1997-2013\n");
3779 #endif
3780 #ifdef POSIX_BC
3781         PerlIO_printf(PIO_stdout,
3782                       "BS2000 (POSIX) port by Start Amadeus GmbH, 1998-1999\n");
3783 #endif
3784 #ifdef UNDER_CE
3785         PerlIO_printf(PIO_stdout,
3786                         "WINCE port by Rainer Keuchel, 2001-2002\n"
3787                         "Built on " __DATE__ " " __TIME__ "\n\n");
3788         wce_hitreturn();
3789 #endif
3790 #ifdef __SYMBIAN32__
3791         PerlIO_printf(PIO_stdout,
3792                       "Symbian port by Nokia, 2004-2005\n");
3793 #endif
3794 #ifdef BINARY_BUILD_NOTICE
3795         BINARY_BUILD_NOTICE;
3796 #endif
3797         PerlIO_printf(PIO_stdout,
3798                       "\n\
3799 Perl may be copied only under the terms of either the Artistic License or the\n\
3800 GNU General Public License, which may be found in the Perl 5 source kit.\n\n\
3801 Complete documentation for Perl, including FAQ lists, should be found on\n\
3802 this system using \"man perl\" or \"perldoc perl\".  If you have access to the\n\
3803 Internet, point your browser at http://www.perl.org/, the Perl Home Page.\n\n");
3804         my_exit(0);
3805 }
3806
3807 /* compliments of Tom Christiansen */
3808
3809 /* unexec() can be found in the Gnu emacs distribution */
3810 /* Known to work with -DUNEXEC and using unexelf.c from GNU emacs-20.2 */
3811
3812 #ifdef VMS
3813 #include <lib$routines.h>
3814 #endif
3815
3816 void
3817 Perl_my_unexec(pTHX)
3818 {
3819 #ifdef UNEXEC
3820     SV *    prog = newSVpv(BIN_EXP, 0);
3821     SV *    file = newSVpv(PL_origfilename, 0);
3822     int    status = 1;
3823     extern int etext;
3824
3825     sv_catpvs(prog, "/perl");
3826     sv_catpvs(file, ".perldump");
3827
3828     unexec(SvPVX(file), SvPVX(prog), &etext, sbrk(0), 0);
3829     /* unexec prints msg to stderr in case of failure */
3830     PerlProc_exit(status);
3831 #else
3832     PERL_UNUSED_CONTEXT;
3833 #  ifdef VMS
3834      lib$signal(SS$_DEBUG);  /* ssdef.h #included from vmsish.h */
3835 #  elif defined(WIN32) || defined(__CYGWIN__)
3836     Perl_croak_nocontext("dump is not supported");
3837 #  else
3838     ABORT();            /* for use with undump */
3839 #  endif
3840 #endif
3841 }
3842
3843 /* initialize curinterp */
3844 STATIC void
3845 S_init_interp(pTHX)
3846 {
3847 #ifdef MULTIPLICITY
3848 #  define PERLVAR(prefix,var,type)
3849 #  define PERLVARA(prefix,var,n,type)
3850 #  if defined(PERL_IMPLICIT_CONTEXT)
3851 #    define PERLVARI(prefix,var,type,init)      aTHX->prefix##var = init;
3852 #    define PERLVARIC(prefix,var,type,init)     aTHX->prefix##var = init;
3853 #  else
3854 #    define PERLVARI(prefix,var,type,init)      PERL_GET_INTERP->var = init;
3855 #    define PERLVARIC(prefix,var,type,init)     PERL_GET_INTERP->var = init;
3856 #  endif
3857 #  include "intrpvar.h"
3858 #  undef PERLVAR
3859 #  undef PERLVARA
3860 #  undef PERLVARI
3861 #  undef PERLVARIC
3862 #else
3863 #  define PERLVAR(prefix,var,type)
3864 #  define PERLVARA(prefix,var,n,type)
3865 #  define PERLVARI(prefix,var,type,init)        PL_##var = init;
3866 #  define PERLVARIC(prefix,var,type,init)       PL_##var = init;
3867 #  include "intrpvar.h"
3868 #  undef PERLVAR
3869 #  undef PERLVARA
3870 #  undef PERLVARI
3871 #  undef PERLVARIC
3872 #endif
3873
3874 }
3875
3876 STATIC void
3877 S_init_main_stash(pTHX)
3878 {
3879     GV *gv;
3880     HV *hv = newHV();
3881
3882     PL_curstash = PL_defstash = (HV *)SvREFCNT_inc_simple_NN(hv);
3883     /* We know that the string "main" will be in the global shared string
3884        table, so it's a small saving to use it rather than allocate another
3885        8 bytes.  */
3886     PL_curstname = newSVpvs_share("main");
3887     gv = gv_fetchpvs("main::", GV_ADD|GV_NOTQUAL, SVt_PVHV);
3888     /* If we hadn't caused another reference to "main" to be in the shared
3889        string table above, then it would be worth reordering these two,
3890        because otherwise all we do is delete "main" from it as a consequence
3891        of the SvREFCNT_dec, only to add it again with hv_name_set */
3892     SvREFCNT_dec(GvHV(gv));
3893     hv_name_sets(PL_defstash, "main", 0);
3894     GvHV(gv) = MUTABLE_HV(SvREFCNT_inc_simple(PL_defstash));
3895     SvREADONLY_on(gv);
3896     PL_incgv = gv_HVadd(gv_AVadd(gv_fetchpvs("INC", GV_ADD|GV_NOTQUAL,
3897                                              SVt_PVAV)));
3898     SvREFCNT_inc_simple_void(PL_incgv); /* Don't allow it to be freed */
3899     GvMULTI_on(PL_incgv);
3900     PL_hintgv = gv_fetchpvs("\010", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^H */
3901     SvREFCNT_inc_simple_void(PL_hintgv);
3902     GvMULTI_on(PL_hintgv);
3903     PL_defgv = gv_fetchpvs("_", GV_ADD|GV_NOTQUAL, SVt_PVAV);
3904     SvREFCNT_inc_simple_void(PL_defgv);
3905     PL_errgv = gv_fetchpvs("@", GV_ADD|GV_NOTQUAL, SVt_PV);
3906     SvREFCNT_inc_simple_void(PL_errgv);
3907     GvMULTI_on(PL_errgv);
3908     PL_replgv = gv_fetchpvs("\022", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^R */
3909     SvREFCNT_inc_simple_void(PL_replgv);
3910     GvMULTI_on(PL_replgv);
3911     (void)Perl_form(aTHX_ "%240s","");  /* Preallocate temp - for immediate signals. */
3912 #ifdef PERL_DONT_CREATE_GVSV
3913     (void)gv_SVadd(PL_errgv);
3914 #endif
3915     sv_grow(ERRSV, 240);        /* Preallocate - for immediate signals. */
3916     CLEAR_ERRSV();
3917     CopSTASH_set(&PL_compiling, PL_defstash);
3918     PL_debstash = GvHV(gv_fetchpvs("DB::", GV_ADDMULTI, SVt_PVHV));
3919     PL_globalstash = GvHV(gv_fetchpvs("CORE::GLOBAL::", GV_ADDMULTI,
3920                                       SVt_PVHV));
3921     /* We must init $/ before switches are processed. */
3922     sv_setpvs(get_sv("/", GV_ADD), "\n");
3923 }
3924
3925 STATIC PerlIO *
3926 S_open_script(pTHX_ const char *scriptname, bool dosearch, bool *suidscript)
3927 {
3928     int fdscript = -1;
3929     PerlIO *rsfp = NULL;
3930     Stat_t tmpstatbuf;
3931     int fd;
3932
3933     PERL_ARGS_ASSERT_OPEN_SCRIPT;
3934
3935     if (PL_e_script) {
3936         PL_origfilename = savepvs("-e");
3937     }
3938     else {
3939         const char *s;
3940         UV uv;
3941         /* if find_script() returns, it returns a malloc()-ed value */
3942         scriptname = PL_origfilename = find_script(scriptname, dosearch, NULL, 1);
3943         s = scriptname + strlen(scriptname);
3944
3945         if (strBEGINs(scriptname, "/dev/fd/")
3946             && isDIGIT(scriptname[8])
3947             && grok_atoUV(scriptname + 8, &uv, &s)
3948             && uv <= PERL_INT_MAX
3949         ) {
3950             fdscript = (int)uv;
3951             if (*s) {
3952                 /* PSz 18 Feb 04
3953                  * Tell apart "normal" usage of fdscript, e.g.
3954                  * with bash on FreeBSD:
3955                  *   perl <( echo '#!perl -DA'; echo 'print "$0\n"')
3956                  * from usage in suidperl.
3957                  * Does any "normal" usage leave garbage after the number???
3958                  * Is it a mistake to use a similar /dev/fd/ construct for
3959                  * suidperl?
3960                  */
3961                 *suidscript = TRUE;
3962                 /* PSz 20 Feb 04  
3963                  * Be supersafe and do some sanity-checks.
3964                  * Still, can we be sure we got the right thing?
3965                  */
3966                 if (*s != '/') {
3967                     Perl_croak(aTHX_ "Wrong syntax (suid) fd script name \"%s\"\n", s);
3968                 }
3969                 if (! *(s+1)) {
3970                     Perl_croak(aTHX_ "Missing (suid) fd script name\n");
3971                 }
3972                 scriptname = savepv(s + 1);
3973                 Safefree(PL_origfilename);
3974                 PL_origfilename = (char *)scriptname;
3975             }
3976         }
3977     }
3978
3979     CopFILE_free(PL_curcop);
3980     CopFILE_set(PL_curcop, PL_origfilename);
3981     if (*PL_origfilename == '-' && PL_origfilename[1] == '\0')
3982         scriptname = (char *)"";
3983     if (fdscript >= 0) {
3984         rsfp = PerlIO_fdopen(fdscript,PERL_SCRIPT_MODE);
3985     }
3986     else if (!*scriptname) {
3987         forbid_setid(0, *suidscript);
3988         return NULL;
3989     }
3990     else {
3991 #ifdef FAKE_BIT_BUCKET
3992         /* This hack allows one not to have /dev/null (or BIT_BUCKET as it
3993          * is called) and still have the "-e" work.  (Believe it or not,
3994          * a /dev/null is required for the "-e" to work because source
3995          * filter magic is used to implement it. ) This is *not* a general
3996          * replacement for a /dev/null.  What we do here is create a temp
3997          * file (an empty file), open up that as the script, and then
3998          * immediately close and unlink it.  Close enough for jazz. */ 
3999 #define FAKE_BIT_BUCKET_PREFIX "/tmp/perlnull-"
4000 #define FAKE_BIT_BUCKET_SUFFIX "XXXXXXXX"
4001 #define FAKE_BIT_BUCKET_TEMPLATE FAKE_BIT_BUCKET_PREFIX FAKE_BIT_BUCKET_SUFFIX
4002         char tmpname[sizeof(FAKE_BIT_BUCKET_TEMPLATE)] = {
4003             FAKE_BIT_BUCKET_TEMPLATE
4004         };
4005         const char * const err = "Failed to create a fake bit bucket";
4006         if (strEQ(scriptname, BIT_BUCKET)) {
4007             int tmpfd = Perl_my_mkstemp_cloexec(tmpname);
4008             if (tmpfd > -1) {
4009                 scriptname = tmpname;
4010                 close(tmpfd);
4011             } else
4012                 Perl_croak(aTHX_ err);
4013         }
4014 #endif
4015         rsfp = PerlIO_open(scriptname,PERL_SCRIPT_MODE);
4016 #ifdef FAKE_BIT_BUCKET
4017         if (   strBEGINs(scriptname, FAKE_BIT_BUCKET_PREFIX)
4018             && strlen(scriptname) == sizeof(tmpname) - 1)
4019         {
4020             unlink(scriptname);
4021         }
4022         scriptname = BIT_BUCKET;
4023 #endif
4024     }
4025     if (!rsfp) {
4026         /* PSz 16 Sep 03  Keep neat error message */
4027         if (PL_e_script)
4028             Perl_croak(aTHX_ "Can't open " BIT_BUCKET ": %s\n", Strerror(errno));
4029         else
4030             Perl_croak(aTHX_ "Can't open perl script \"%s\": %s\n",
4031                     CopFILE(PL_curcop), Strerror(errno));
4032     }
4033     fd = PerlIO_fileno(rsfp);
4034
4035     if (fd < 0 ||
4036         (PerlLIO_fstat(fd, &tmpstatbuf) >= 0
4037          && S_ISDIR(tmpstatbuf.st_mode)))
4038         Perl_croak(aTHX_ "Can't open perl script \"%s\": %s\n",
4039             CopFILE(PL_curcop),
4040             Strerror(EISDIR));
4041
4042     return rsfp;
4043 }
4044
4045 /* In the days of suidperl, we refused to execute a setuid script stored on
4046  * a filesystem mounted nosuid and/or noexec. This meant that we probed for the
4047  * existence of the appropriate filesystem-statting function, and behaved
4048  * accordingly. But even though suidperl is long gone, we must still include
4049  * those probes for the benefit of modules like Filesys::Df, which expect the
4050  * results of those probes to be stored in %Config; see RT#126368. So mention
4051  * the relevant cpp symbols here, to ensure that metaconfig will include their
4052  * probes in the generated Configure:
4053  *
4054  * I_SYSSTATVFS HAS_FSTATVFS
4055  * I_SYSMOUNT
4056  * I_STATFS     HAS_FSTATFS     HAS_GETFSSTAT
4057  * I_MNTENT     HAS_GETMNTENT   HAS_HASMNTOPT
4058  */
4059
4060
4061 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
4062 /* Don't even need this function.  */
4063 #else
4064 STATIC void
4065 S_validate_suid(pTHX_ PerlIO *rsfp)
4066 {
4067     const Uid_t  my_uid = PerlProc_getuid();
4068     const Uid_t my_euid = PerlProc_geteuid();
4069     const Gid_t  my_gid = PerlProc_getgid();
4070     const Gid_t my_egid = PerlProc_getegid();
4071
4072     PERL_ARGS_ASSERT_VALIDATE_SUID;
4073
4074     if (my_euid != my_uid || my_egid != my_gid) {       /* (suidperl doesn't exist, in fact) */
4075         dVAR;
4076         int fd = PerlIO_fileno(rsfp);
4077         Stat_t statbuf;
4078         if (fd < 0 || PerlLIO_fstat(fd, &statbuf) < 0) { /* may be either wrapped or real suid */
4079             Perl_croak_nocontext( "Illegal suidscript");
4080         }
4081         if ((my_euid != my_uid && my_euid == statbuf.st_uid && statbuf.st_mode & S_ISUID)
4082             ||
4083             (my_egid != my_gid && my_egid == statbuf.st_gid && statbuf.st_mode & S_ISGID)
4084             )
4085             if (!PL_do_undump)
4086                 Perl_croak(aTHX_ "YOU HAVEN'T DISABLED SET-ID SCRIPTS IN THE KERNEL YET!\n\
4087 FIX YOUR KERNEL, PUT A C WRAPPER AROUND THIS SCRIPT, OR USE -u AND UNDUMP!\n");
4088         /* not set-id, must be wrapped */
4089     }
4090 }
4091 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4092
4093 STATIC void
4094 S_find_beginning(pTHX_ SV* linestr_sv, PerlIO *rsfp)
4095 {
4096     const char *s;
4097     const char *s2;
4098
4099     PERL_ARGS_ASSERT_FIND_BEGINNING;
4100
4101     /* skip forward in input to the real script? */
4102
4103     do {
4104         if ((s = sv_gets(linestr_sv, rsfp, 0)) == NULL)
4105             Perl_croak(aTHX_ "No Perl script found in input\n");
4106         s2 = s;
4107     } while (!(*s == '#' && s[1] == '!' && ((s = instr(s,"perl")) || (s = instr(s2,"PERL")))));
4108     PerlIO_ungetc(rsfp, '\n');          /* to keep line count right */
4109     while (*s && !(isSPACE (*s) || *s == '#')) s++;
4110     s2 = s;
4111     while (*s == ' ' || *s == '\t') s++;
4112     if (*s++ == '-') {
4113         while (isDIGIT(s2[-1]) || s2[-1] == '-' || s2[-1] == '.'
4114                || s2[-1] == '_') s2--;
4115         if (strBEGINs(s2-4,"perl"))
4116             while ((s = moreswitches(s)))
4117                 ;
4118     }
4119 }
4120
4121
4122 STATIC void
4123 S_init_ids(pTHX)
4124 {
4125     /* no need to do anything here any more if we don't
4126      * do tainting. */
4127 #ifndef NO_TAINT_SUPPORT
4128     const Uid_t my_uid = PerlProc_getuid();
4129     const Uid_t my_euid = PerlProc_geteuid();
4130     const Gid_t my_gid = PerlProc_getgid();
4131     const Gid_t my_egid = PerlProc_getegid();
4132
4133     PERL_UNUSED_CONTEXT;
4134
4135     /* Should not happen: */
4136     CHECK_MALLOC_TAINT(my_uid && (my_euid != my_uid || my_egid != my_gid));
4137     TAINTING_set( TAINTING_get | (my_uid && (my_euid != my_uid || my_egid != my_gid)) );
4138 #endif
4139     /* BUG */
4140     /* PSz 27 Feb 04
4141      * Should go by suidscript, not uid!=euid: why disallow
4142      * system("ls") in scripts run from setuid things?
4143      * Or, is this run before we check arguments and set suidscript?
4144      * What about SETUID_SCRIPTS_ARE_SECURE_NOW: could we use fdscript then?
4145      * (We never have suidscript, can we be sure to have fdscript?)
4146      * Or must then go by UID checks? See comments in forbid_setid also.
4147      */
4148 }
4149
4150 /* This is used very early in the lifetime of the program,
4151  * before even the options are parsed, so PL_tainting has
4152  * not been initialized properly.  */
4153 bool
4154 Perl_doing_taint(int argc, char *argv[], char *envp[])
4155 {
4156 #ifndef PERL_IMPLICIT_SYS
4157     /* If we have PERL_IMPLICIT_SYS we can't call getuid() et alia
4158      * before we have an interpreter-- and the whole point of this
4159      * function is to be called at such an early stage.  If you are on
4160      * a system with PERL_IMPLICIT_SYS but you do have a concept of
4161      * "tainted because running with altered effective ids', you'll
4162      * have to add your own checks somewhere in here.  The two most
4163      * known samples of 'implicitness' are Win32 and NetWare, neither
4164      * of which has much of concept of 'uids'. */
4165     Uid_t uid  = PerlProc_getuid();
4166     Uid_t euid = PerlProc_geteuid();
4167     Gid_t gid  = PerlProc_getgid();
4168     Gid_t egid = PerlProc_getegid();
4169     (void)envp;
4170
4171 #ifdef VMS
4172     uid  |=  gid << 16;
4173     euid |= egid << 16;
4174 #endif
4175     if (uid && (euid != uid || egid != gid))
4176         return 1;
4177 #endif /* !PERL_IMPLICIT_SYS */
4178     /* This is a really primitive check; environment gets ignored only
4179      * if -T are the first chars together; otherwise one gets
4180      *  "Too late" message. */
4181     if ( argc > 1 && argv[1][0] == '-'
4182          && isALPHA_FOLD_EQ(argv[1][1], 't'))
4183         return 1;
4184     return 0;
4185 }
4186
4187 /* Passing the flag as a single char rather than a string is a slight space
4188    optimisation.  The only message that isn't /^-.$/ is
4189    "program input from stdin", which is substituted in place of '\0', which
4190    could never be a command line flag.  */
4191 STATIC void
4192 S_forbid_setid(pTHX_ const char flag, const bool suidscript) /* g */
4193 {
4194     char string[3] = "-x";
4195     const char *message = "program input from stdin";
4196
4197     PERL_UNUSED_CONTEXT;
4198     if (flag) {
4199         string[1] = flag;
4200         message = string;
4201     }
4202
4203 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
4204     if (PerlProc_getuid() != PerlProc_geteuid())
4205         Perl_croak(aTHX_ "No %s allowed while running setuid", message);
4206     if (PerlProc_getgid() != PerlProc_getegid())
4207         Perl_croak(aTHX_ "No %s allowed while running setgid", message);
4208 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4209     if (suidscript)
4210         Perl_croak(aTHX_ "No %s allowed with (suid) fdscript", message);
4211 }
4212
4213 void
4214 Perl_init_dbargs(pTHX)
4215 {
4216     AV *const args = PL_dbargs = GvAV(gv_AVadd((gv_fetchpvs("DB::args",
4217                                                             GV_ADDMULTI,
4218                                                             SVt_PVAV))));
4219
4220     if (AvREAL(args)) {
4221         /* Someone has already created it.
4222            It might have entries, and if we just turn off AvREAL(), they will
4223            "leak" until global destruction.  */
4224         av_clear(args);
4225         if (SvTIED_mg((const SV *)args, PERL_MAGIC_tied))
4226             Perl_croak(aTHX_ "Cannot set tied @DB::args");
4227     }
4228     AvREIFY_only(PL_dbargs);
4229 }
4230
4231 void
4232 Perl_init_debugger(pTHX)
4233 {
4234     HV * const ostash = PL_curstash;
4235     MAGIC *mg;
4236
4237     PL_curstash = (HV *)SvREFCNT_inc_simple(PL_debstash);
4238
4239     Perl_init_dbargs(aTHX);
4240     PL_DBgv = MUTABLE_GV(
4241         SvREFCNT_inc(gv_fetchpvs("DB::DB", GV_ADDMULTI, SVt_PVGV))
4242     );
4243     PL_DBline = MUTABLE_GV(
4244         SvREFCNT_inc(gv_fetchpvs("DB::dbline", GV_ADDMULTI, SVt_PVAV))
4245     );
4246     PL_DBsub = MUTABLE_GV(SvREFCNT_inc(
4247         gv_HVadd(gv_fetchpvs("DB::sub", GV_ADDMULTI, SVt_PVHV))
4248     ));
4249     PL_DBsingle = GvSV((gv_fetchpvs("DB::single", GV_ADDMULTI, SVt_PV)));
4250     if (!SvIOK(PL_DBsingle))
4251         sv_setiv(PL_DBsingle, 0);
4252     mg = sv_magicext(PL_DBsingle, NULL, PERL_MAGIC_debugvar, &PL_vtbl_debugvar, 0, 0);
4253     mg->mg_private = DBVARMG_SINGLE;
4254     SvSETMAGIC(PL_DBsingle);
4255
4256     PL_DBtrace = GvSV((gv_fetchpvs("DB::trace", GV_ADDMULTI, SVt_PV)));
4257     if (!SvIOK(PL_DBtrace))
4258         sv_setiv(PL_DBtrace, 0);
4259     mg = sv_magicext(PL_DBtrace, NULL, PERL_MAGIC_debugvar, &PL_vtbl_debugvar, 0, 0);
4260     mg->mg_private = DBVARMG_TRACE;
4261     SvSETMAGIC(PL_DBtrace);
4262
4263     PL_DBsignal = GvSV((gv_fetchpvs("DB::signal", GV_ADDMULTI, SVt_PV)));
4264     if (!SvIOK(PL_DBsignal))
4265         sv_setiv(PL_DBsignal, 0);
4266     mg = sv_magicext(PL_DBsignal, NULL, PERL_MAGIC_debugvar, &PL_vtbl_debugvar, 0, 0);
4267     mg->mg_private = DBVARMG_SIGNAL;
4268     SvSETMAGIC(PL_DBsignal);
4269
4270     SvREFCNT_dec(PL_curstash);
4271     PL_curstash = ostash;
4272 }
4273
4274 #ifndef STRESS_REALLOC
4275 #define REASONABLE(size) (size)
4276 #define REASONABLE_but_at_least(size,min) (size)
4277 #else
4278 #define REASONABLE(size) (1) /* unreasonable */
4279 #define REASONABLE_but_at_least(size,min) (min)
4280 #endif
4281
4282 void
4283 Perl_init_stacks(pTHX)
4284 {
4285     SSize_t size;
4286
4287     /* start with 128-item stack and 8K cxstack */
4288     PL_curstackinfo = new_stackinfo(REASONABLE(128),
4289                                  REASONABLE(8192/sizeof(PERL_CONTEXT) - 1));
4290     PL_curstackinfo->si_type = PERLSI_MAIN;
4291 #if defined DEBUGGING && !defined DEBUGGING_RE_ONLY
4292     PL_curstackinfo->si_stack_hwm = 0;
4293 #endif
4294     PL_curstack = PL_curstackinfo->si_stack;
4295     PL_mainstack = PL_curstack;         /* remember in case we switch stacks */
4296
4297     PL_stack_base = AvARRAY(PL_curstack);
4298     PL_stack_sp = PL_stack_base;
4299     PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
4300
4301     Newx(PL_tmps_stack,REASONABLE(128),SV*);
4302     PL_tmps_floor = -1;
4303     PL_tmps_ix = -1;
4304     PL_tmps_max = REASONABLE(128);
4305
4306     Newx(PL_markstack,REASONABLE(32),I32);
4307     PL_markstack_ptr = PL_markstack;
4308     PL_markstack_max = PL_markstack + REASONABLE(32);
4309
4310     SET_MARK_OFFSET;
4311
4312     Newx(PL_scopestack,REASONABLE(32),I32);
4313 #ifdef DEBUGGING
4314     Newx(PL_scopestack_name,REASONABLE(32),const char*);
4315 #endif
4316     PL_scopestack_ix = 0;
4317     PL_scopestack_max = REASONABLE(32);
4318
4319     size = REASONABLE_but_at_least(128,SS_MAXPUSH);
4320     Newx(PL_savestack, size, ANY);
4321     PL_savestack_ix = 0;
4322     /*PL_savestack_max lies: it always has SS_MAXPUSH more than it claims */
4323     PL_savestack_max = size - SS_MAXPUSH;
4324 }
4325
4326 #undef REASONABLE
4327
4328 STATIC void
4329 S_nuke_stacks(pTHX)
4330 {
4331     while (PL_curstackinfo->si_next)
4332         PL_curstackinfo = PL_curstackinfo->si_next;
4333     while (PL_curstackinfo) {
4334         PERL_SI *p = PL_curstackinfo->si_prev;
4335         /* curstackinfo->si_stack got nuked by sv_free_arenas() */
4336         Safefree(PL_curstackinfo->si_cxstack);
4337         Safefree(PL_curstackinfo);
4338         PL_curstackinfo = p;
4339     }
4340     Safefree(PL_tmps_stack);
4341     Safefree(PL_markstack);
4342     Safefree(PL_scopestack);
4343 #ifdef DEBUGGING
4344     Safefree(PL_scopestack_name);
4345 #endif
4346     Safefree(PL_savestack);
4347 }
4348
4349 void
4350 Perl_populate_isa(pTHX_ const char *name, STRLEN len, ...)
4351 {
4352     GV *const gv = gv_fetchpvn(name, len, GV_ADD | GV_ADDMULTI, SVt_PVAV);
4353     AV *const isa = GvAVn(gv);
4354     va_list args;
4355
4356     PERL_ARGS_ASSERT_POPULATE_ISA;
4357
4358     if(AvFILLp(isa) != -1)
4359         return;
4360
4361     /* NOTE: No support for tied ISA */
4362
4363     va_start(args, len);
4364     do {
4365         const char *const parent = va_arg(args, const char*);
4366         size_t parent_len;
4367
4368         if (!parent)
4369             break;
4370         parent_len = va_arg(args, size_t);
4371
4372         /* Arguments are supplied with a trailing ::  */
4373         assert(parent_len > 2);
4374         assert(parent[parent_len - 1] == ':');
4375         assert(parent[parent_len - 2] == ':');
4376         av_push(isa, newSVpvn(parent, parent_len - 2));
4377         (void) gv_fetchpvn(parent, parent_len, GV_ADD, SVt_PVGV);
4378     } while (1);
4379     va_end(args);
4380 }
4381
4382
4383 STATIC void
4384 S_init_predump_symbols(pTHX)
4385 {
4386     GV *tmpgv;
4387     IO *io;
4388
4389     sv_setpvs(get_sv("\"", GV_ADD), " ");
4390     PL_ofsgv = (GV*)SvREFCNT_inc(gv_fetchpvs(",", GV_ADD|GV_NOTQUAL, SVt_PV));
4391
4392
4393     /* Historically, PVIOs were blessed into IO::Handle, unless
4394        FileHandle was loaded, in which case they were blessed into
4395        that. Action at a distance.
4396        However, if we simply bless into IO::Handle, we break code
4397        that assumes that PVIOs will have (among others) a seek
4398        method. IO::File inherits from IO::Handle and IO::Seekable,
4399        and provides the needed methods. But if we simply bless into
4400        it, then we break code that assumed that by loading
4401        IO::Handle, *it* would work.
4402        So a compromise is to set up the correct @IO::File::ISA,
4403        so that code that does C<use IO::Handle>; will still work.
4404     */
4405                    
4406     Perl_populate_isa(aTHX_ STR_WITH_LEN("IO::File::ISA"),
4407                       STR_WITH_LEN("IO::Handle::"),
4408                       STR_WITH_LEN("IO::Seekable::"),
4409                       STR_WITH_LEN("Exporter::"),
4410                       NULL);
4411
4412     PL_stdingv = gv_fetchpvs("STDIN", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4413     GvMULTI_on(PL_stdingv);
4414     io = GvIOp(PL_stdingv);
4415     IoTYPE(io) = IoTYPE_RDONLY;
4416     IoIFP(io) = PerlIO_stdin();
4417     tmpgv = gv_fetchpvs("stdin", GV_ADD|GV_NOTQUAL, SVt_PV);
4418     GvMULTI_on(tmpgv);
4419     GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4420
4421     tmpgv = gv_fetchpvs("STDOUT", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4422     GvMULTI_on(tmpgv);
4423     io = GvIOp(tmpgv);
4424     IoTYPE(io) = IoTYPE_WRONLY;
4425     IoOFP(io) = IoIFP(io) = PerlIO_stdout();
4426     setdefout(tmpgv);
4427     tmpgv = gv_fetchpvs("stdout", GV_ADD|GV_NOTQUAL, SVt_PV);
4428     GvMULTI_on(tmpgv);
4429     GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4430
4431     PL_stderrgv = gv_fetchpvs("STDERR", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4432     GvMULTI_on(PL_stderrgv);
4433     io = GvIOp(PL_stderrgv);
4434     IoTYPE(io) = IoTYPE_WRONLY;
4435     IoOFP(io) = IoIFP(io) = PerlIO_stderr();
4436     tmpgv = gv_fetchpvs("stderr", GV_ADD|GV_NOTQUAL, SVt_PV);
4437     GvMULTI_on(tmpgv);
4438     GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4439
4440     PL_statname = newSVpvs("");         /* last filename we did stat on */
4441 }
4442
4443 void
4444 Perl_init_argv_symbols(pTHX_ int argc, char **argv)
4445 {
4446     PERL_ARGS_ASSERT_INIT_ARGV_SYMBOLS;
4447
4448     argc--,argv++;      /* skip name of script */
4449     if (PL_doswitches) {
4450         for (; argc > 0 && **argv == '-'; argc--,argv++) {
4451             char *s;
4452             if (!argv[0][1])
4453                 break;
4454             if (argv[0][1] == '-' && !argv[0][2]) {
4455                 argc--,argv++;
4456                 break;
4457             }
4458             if ((s = strchr(argv[0], '='))) {
4459                 const char *const start_name = argv[0] + 1;
4460                 sv_setpv(GvSV(gv_fetchpvn_flags(start_name, s - start_name,
4461                                                 TRUE, SVt_PV)), s + 1);
4462             }
4463             else
4464                 sv_setiv(GvSV(gv_fetchpv(argv[0]+1, GV_ADD, SVt_PV)),1);
4465         }
4466     }
4467     if ((PL_argvgv = gv_fetchpvs("ARGV", GV_ADD|GV_NOTQUAL, SVt_PVAV))) {
4468         SvREFCNT_inc_simple_void_NN(PL_argvgv);
4469         GvMULTI_on(PL_argvgv);
4470         av_clear(GvAVn(PL_argvgv));
4471         for (; argc > 0; argc--,argv++) {
4472             SV * const sv = newSVpv(argv[0],0);
4473             av_push(GvAV(PL_argvgv),sv);
4474             if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
4475                  if (PL_unicode & PERL_UNICODE_ARGV_FLAG)
4476                       SvUTF8_on(sv);
4477             }
4478             if (PL_unicode & PERL_UNICODE_WIDESYSCALLS_FLAG) /* Sarathy? */
4479                  (void)sv_utf8_decode(sv);
4480         }
4481     }
4482
4483     if (PL_inplace && (!PL_argvgv || AvFILL(GvAV(PL_argvgv)) == -1))
4484         Perl_ck_warner_d(aTHX_ packWARN(WARN_INPLACE),
4485                          "-i used with no filenames on the command line, "
4486                          "reading from STDIN");
4487 }
4488
4489 STATIC void
4490 S_init_postdump_symbols(pTHX_ int argc, char **argv, char **env)
4491 {
4492 #ifdef USE_ITHREADS
4493     dVAR;
4494 #endif
4495     GV* tmpgv;
4496
4497     PERL_ARGS_ASSERT_INIT_POSTDUMP_SYMBOLS;
4498
4499     PL_toptarget = newSV_type(SVt_PVIV);
4500     SvPVCLEAR(PL_toptarget);
4501     PL_bodytarget = newSV_type(SVt_PVIV);
4502     SvPVCLEAR(PL_bodytarget);
4503     PL_formtarget = PL_bodytarget;
4504
4505     TAINT;
4506
4507     init_argv_symbols(argc,argv);
4508
4509     if ((tmpgv = gv_fetchpvs("0", GV_ADD|GV_NOTQUAL, SVt_PV))) {
4510         sv_setpv(GvSV(tmpgv),PL_origfilename);
4511     }
4512     if ((PL_envgv = gv_fetchpvs("ENV", GV_ADD|GV_NOTQUAL, SVt_PVHV))) {
4513         HV *hv;
4514         bool env_is_not_environ;
4515         SvREFCNT_inc_simple_void_NN(PL_envgv);
4516         GvMULTI_on(PL_envgv);
4517         hv = GvHVn(PL_envgv);
4518         hv_magic(hv, NULL, PERL_MAGIC_env);
4519 #ifndef PERL_MICRO
4520 #ifdef USE_ENVIRON_ARRAY
4521         /* Note that if the supplied env parameter is actually a copy
4522            of the global environ then it may now point to free'd memory
4523            if the environment has been modified since. To avoid this
4524            problem we treat env==NULL as meaning 'use the default'
4525         */
4526         if (!env)
4527             env = environ;
4528         env_is_not_environ = env != environ;
4529         if (env_is_not_environ
4530 #  ifdef USE_ITHREADS
4531             && PL_curinterp == aTHX
4532 #  endif
4533            )
4534         {
4535             environ[0] = NULL;
4536         }
4537         if (env) {
4538           char *s, *old_var;
4539           STRLEN nlen;
4540           SV *sv;
4541           HV *dups = newHV();
4542
4543           for (; *env; env++) {
4544             old_var = *env;
4545
4546             if (!(s = strchr(old_var,'=')) || s == old_var)
4547                 continue;
4548             nlen = s - old_var;
4549
4550 #if defined(MSDOS) && !defined(DJGPP)
4551             *s = '\0';
4552             (void)strupr(old_var);
4553             *s = '=';
4554 #endif
4555             if (hv_exists(hv, old_var, nlen)) {
4556                 const char *name = savepvn(old_var, nlen);
4557
4558                 /* make sure we use the same value as getenv(), otherwise code that
4559                    uses getenv() (like setlocale()) might see a different value to %ENV
4560                  */
4561                 sv = newSVpv(PerlEnv_getenv(name), 0);
4562
4563                 /* keep a count of the dups of this name so we can de-dup environ later */
4564                 if (hv_exists(dups, name, nlen))
4565                     ++SvIVX(*hv_fetch(dups, name, nlen, 0));
4566                 else
4567                     (void)hv_store(dups, name, nlen, newSViv(1), 0);
4568
4569                 Safefree(name);
4570             }
4571             else {
4572                 sv = newSVpv(s+1, 0);
4573             }
4574             (void)hv_store(hv, old_var, nlen, sv, 0);
4575             if (env_is_not_environ)
4576                 mg_set(sv);
4577           }
4578           if (HvKEYS(dups)) {
4579               /* environ has some duplicate definitions, remove them */
4580               HE *entry;
4581               hv_iterinit(dups);
4582               while ((entry = hv_iternext_flags(dups, 0))) {
4583                   STRLEN nlen;
4584                   const char *name = HePV(entry, nlen);
4585                   IV count = SvIV(HeVAL(entry));
4586                   IV i;
4587                   SV **valp = hv_fetch(hv, name, nlen, 0);
4588
4589                   assert(valp);
4590
4591                   /* try to remove any duplicate names, depending on the
4592                    * implementation used in my_setenv() the iteration might
4593                    * not be necessary, but let's be safe.
4594                    */
4595                   for (i = 0; i < count; ++i)
4596                       my_setenv(name, 0);
4597
4598                   /* and set it back to the value we set $ENV{name} to */
4599                   my_setenv(name, SvPV_nolen(*valp));
4600               }
4601           }
4602           SvREFCNT_dec_NN(dups);
4603       }
4604 #endif /* USE_ENVIRON_ARRAY */
4605 #endif /* !PERL_MICRO */
4606     }
4607     TAINT_NOT;
4608
4609     /* touch @F array to prevent spurious warnings 20020415 MJD */
4610     if (PL_minus_a) {
4611       (void) get_av("main::F", GV_ADD | GV_ADDMULTI);
4612     }
4613 }
4614
4615 STATIC void
4616 S_init_perllib(pTHX)
4617 {
4618 #ifndef VMS
4619     const char *perl5lib = NULL;
4620 #endif
4621     const char *s;
4622 #if defined(WIN32) && !defined(PERL_IS_MINIPERL)
4623     STRLEN len;
4624 #endif
4625
4626     if (!TAINTING_get) {
4627 #ifndef VMS
4628         perl5lib = PerlEnv_getenv("PERL5LIB");
4629 /*
4630  * It isn't possible to delete an environment variable with
4631  * PERL_USE_SAFE_PUTENV set unless unsetenv() is also available, so in that
4632  * case we treat PERL5LIB as undefined if it has a zero-length value.
4633  */
4634 #if defined(PERL_USE_SAFE_PUTENV) && ! defined(HAS_UNSETENV)
4635         if (perl5lib && *perl5lib != '\0')
4636 #else
4637         if (perl5lib)
4638 #endif
4639             incpush_use_sep(perl5lib, 0, INCPUSH_ADD_SUB_DIRS);
4640         else {
4641             s = PerlEnv_getenv("PERLLIB");
4642             if (s)
4643                 incpush_use_sep(s, 0, 0);
4644         }
4645 #else /* VMS */
4646         /* Treat PERL5?LIB as a possible search list logical name -- the
4647          * "natural" VMS idiom for a Unix path string.  We allow each
4648          * element to be a set of |-separated directories for compatibility.
4649          */
4650         char buf[256];
4651         int idx = 0;
4652         if (vmstrnenv("PERL5LIB",buf,0,NULL,0))
4653             do {
4654                 incpush_use_sep(buf, 0, INCPUSH_ADD_SUB_DIRS);
4655             } while (vmstrnenv("PERL5LIB",buf,++idx,NULL,0));
4656         else {
4657             while (vmstrnenv("PERLLIB",buf,idx++,NULL,0))
4658                 incpush_use_sep(buf, 0, 0);
4659         }
4660 #endif /* VMS */
4661     }
4662
4663 #ifndef PERL_IS_MINIPERL
4664     /* miniperl gets just -I..., the split of $ENV{PERL5LIB}, and "." in @INC
4665        (and not the architecture specific directories from $ENV{PERL5LIB}) */
4666
4667 #include "perl_inc_macro.h"
4668 /* Use the ~-expanded versions of APPLLIB (undocumented),
4669     SITEARCH, SITELIB, VENDORARCH, VENDORLIB, ARCHLIB and PRIVLIB
4670 */
4671     INCPUSH_APPLLIB_EXP
4672     INCPUSH_SITEARCH_EXP
4673     INCPUSH_SITELIB_EXP
4674     INCPUSH_PERL_VENDORARCH_EXP
4675     INCPUSH_PERL_VENDORLIB_EXP
4676     INCPUSH_ARCHLIB_EXP
4677     INCPUSH_PRIVLIB_EXP
4678     INCPUSH_PERL_OTHERLIBDIRS
4679     INCPUSH_PERL5LIB
4680     INCPUSH_APPLLIB_OLD_EXP
4681     INCPUSH_SITELIB_STEM
4682     INCPUSH_PERL_VENDORLIB_STEM
4683     INCPUSH_PERL_OTHERLIBDIRS_ARCHONLY
4684
4685 #endif /* !PERL_IS_MINIPERL */
4686
4687     if (!TAINTING_get) {
4688 #if !defined(PERL_IS_MINIPERL) && defined(DEFAULT_INC_EXCLUDES_DOT)
4689         const char * const unsafe = PerlEnv_getenv("PERL_USE_UNSAFE_INC");
4690         if (unsafe && strEQ(unsafe, "1"))
4691 #endif
4692           S_incpush(aTHX_ STR_WITH_LEN("."), 0);
4693     }
4694 }
4695
4696 #if defined(DOSISH) || defined(__SYMBIAN32__)
4697 #    define PERLLIB_SEP ';'
4698 #elif defined(__VMS)
4699 #    define PERLLIB_SEP PL_perllib_sep
4700 #else
4701 #    define PERLLIB_SEP ':'
4702 #endif
4703 #ifndef PERLLIB_MANGLE
4704 #  define PERLLIB_MANGLE(s,n) (s)
4705 #endif
4706
4707 #ifndef PERL_IS_MINIPERL
4708 /* Push a directory onto @INC if it exists.
4709    Generate a new SV if we do this, to save needing to copy the SV we push
4710    onto @INC  */
4711 STATIC SV *
4712 S_incpush_if_exists(pTHX_ AV *const av, SV *dir, SV *const stem)
4713 {
4714     Stat_t tmpstatbuf;
4715
4716     PERL_ARGS_ASSERT_INCPUSH_IF_EXISTS;
4717
4718     if (PerlLIO_stat(SvPVX_const(dir), &tmpstatbuf) >= 0 &&
4719         S_ISDIR(tmpstatbuf.st_mode)) {
4720         av_push(av, dir);
4721         dir = newSVsv(stem);
4722     } else {
4723         /* Truncate dir back to stem.  */
4724         SvCUR_set(dir, SvCUR(stem));
4725     }
4726     return dir;
4727 }
4728 #endif
4729
4730 STATIC SV *
4731 S_mayberelocate(pTHX_ const char *const dir, STRLEN len, U32 flags)
4732 {
4733     const U8 canrelocate = (U8)flags & INCPUSH_CAN_RELOCATE;
4734     SV *libdir;
4735
4736     PERL_ARGS_ASSERT_MAYBERELOCATE;
4737     assert(len > 0);
4738
4739     /* I am not convinced that this is valid when PERLLIB_MANGLE is
4740        defined to so something (in os2/os2.c), but the code has been
4741        this way, ignoring any possible changed of length, since
4742        760ac839baf413929cd31cc32ffd6dba6b781a81 (5.003_02) so I'll leave
4743        it be.  */
4744     libdir = newSVpvn(PERLLIB_MANGLE(dir, len), len);
4745
4746 #ifdef VMS
4747     {
4748         char *unix;
4749
4750         if ((unix = tounixspec_ts(SvPV(libdir,len),NULL)) != NULL) {
4751             len = strlen(unix);
4752             while (len > 1 && unix[len-1] == '/') len--;  /* Cosmetic */
4753             sv_usepvn(libdir,unix,len);
4754         }
4755         else
4756             PerlIO_printf(Perl_error_log,
4757                           "Failed to unixify @INC element \"%s\"\n",
4758                           SvPV_nolen_const(libdir));
4759     }
4760 #endif
4761
4762         /* Do the if() outside the #ifdef to avoid warnings about an unused
4763            parameter.  */
4764         if (canrelocate) {
4765 #ifdef PERL_RELOCATABLE_INC
4766         /*
4767          * Relocatable include entries are marked with a leading .../
4768          *
4769          * The algorithm is
4770          * 0: Remove that leading ".../"
4771          * 1: Remove trailing executable name (anything after the last '/')
4772          *    from the perl path to give a perl prefix
4773          * Then
4774          * While the @INC element starts "../" and the prefix ends with a real
4775          * directory (ie not . or ..) chop that real directory off the prefix
4776          * and the leading "../" from the @INC element. ie a logical "../"
4777          * cleanup
4778          * Finally concatenate the prefix and the remainder of the @INC element
4779          * The intent is that /usr/local/bin/perl and .../../lib/perl5
4780          * generates /usr/local/lib/perl5
4781          */
4782             const char *libpath = SvPVX(libdir);
4783             STRLEN libpath_len = SvCUR(libdir);
4784             if (memBEGINs(libpath, libpath_len, ".../")) {
4785                 /* Game on!  */
4786                 SV * const caret_X = get_sv("\030", 0);
4787                 /* Going to use the SV just as a scratch buffer holding a C
4788                    string:  */
4789                 SV *prefix_sv;
4790                 char *prefix;
4791                 char *lastslash;
4792
4793                 /* $^X is *the* source of taint if tainting is on, hence
4794                    SvPOK() won't be true.  */
4795                 assert(caret_X);
4796                 assert(SvPOKp(caret_X));
4797                 prefix_sv = newSVpvn_flags(SvPVX(caret_X), SvCUR(caret_X),
4798                                            SvUTF8(caret_X));
4799                 /* Firstly take off the leading .../
4800                    If all else fail we'll do the paths relative to the current
4801                    directory.  */
4802                 sv_chop(libdir, libpath + 4);
4803                 /* Don't use SvPV as we're intentionally bypassing taining,
4804                    mortal copies that the mg_get of tainting creates, and
4805                    corruption that seems to come via the save stack.
4806                    I guess that the save stack isn't correctly set up yet.  */
4807                 libpath = SvPVX(libdir);
4808                 libpath_len = SvCUR(libdir);
4809
4810                 prefix = SvPVX(prefix_sv);
4811                 lastslash = (char *) my_memrchr(prefix, '/',
4812                              SvEND(prefix_sv) - prefix);
4813
4814                 /* First time in with the *lastslash = '\0' we just wipe off
4815                    the trailing /perl from (say) /usr/foo/bin/perl
4816                 */
4817                 if (lastslash) {
4818                     SV *tempsv;
4819                     while ((*lastslash = '\0'), /* Do that, come what may.  */
4820                            (   memBEGINs(libpath, libpath_len, "../")
4821                             && (lastslash =
4822                                   (char *) my_memrchr(prefix, '/',
4823                                                    SvEND(prefix_sv) - prefix))))
4824                     {
4825                         if (lastslash[1] == '\0'
4826                             || (lastslash[1] == '.'
4827                                 && (lastslash[2] == '/' /* ends "/."  */
4828                                     || (lastslash[2] == '/'
4829                                         && lastslash[3] == '/' /* or "/.."  */
4830                                         )))) {
4831                             /* Prefix ends "/" or "/." or "/..", any of which
4832                                are fishy, so don't do any more logical cleanup.
4833                             */
4834                             break;
4835                         }
4836                         /* Remove leading "../" from path  */
4837                         libpath += 3;
4838                         libpath_len -= 3;
4839                         /* Next iteration round the loop removes the last
4840                            directory name from prefix by writing a '\0' in
4841                            the while clause.  */
4842                     }
4843                     /* prefix has been terminated with a '\0' to the correct
4844                        length. libpath points somewhere into the libdir SV.
4845