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