This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
fix leak in cloned regexes.
[perl5.git] / perl.c
CommitLineData
4b88f280 1#line 2 "perl.c"
a0d0e21e
LW
2/* perl.c
3 *
737f4459 4 * Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001
2eee27d7 5 * 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
4a29172e 6 * 2013, 2014, 2015, 2016, 2017, 2018, 2019 by Larry Wall and others
a687059c 7 *
352d5a3a
LW
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.
a687059c 10 *
8d063cd8
LW
11 */
12
a0d0e21e 13/*
4ac71550
TC
14 * A ship then new they built for him
15 * of mithril and of elven-glass
cdad3b53 16 * --from Bilbo's song of Eärendil
4ac71550
TC
17 *
18 * [p.236 of _The Lord of the Rings_, II/i: "Many Meetings"]
a0d0e21e 19 */
45d8adaa 20
166f8a29
DM
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()
ddfa107c 24 * function of the interpreter; that can be found in perlmain.c
a1b69980
DM
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.
166f8a29
DM
29 */
30
c44493f1 31#if defined(PERL_IS_MINIPERL) && !defined(USE_SITECUSTOMIZE)
43c0c913
NC
32# define USE_SITECUSTOMIZE
33#endif
34
378cc40b 35#include "EXTERN.h"
864dbfa3 36#define PERL_IN_PERL_C
378cc40b 37#include "perl.h"
e3321bb0 38#include "patchlevel.h" /* for local_patches */
4a5df386 39#include "XSUB.h"
378cc40b 40
011f1a1a
JH
41#ifdef NETWARE
42#include "nwutil.h"
011f1a1a
JH
43#endif
44
2aa47728 45#ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
bf357333
NC
46# ifdef I_SYSUIO
47# include <sys/uio.h>
48# endif
49
50union control_un {
51 struct cmsghdr cm;
52 char control[CMSG_SPACE(sizeof(int))];
53};
54
2aa47728
NC
55#endif
56
5311654c
JH
57#ifndef HZ
58# ifdef CLK_TCK
59# define HZ CLK_TCK
60# else
61# define HZ 60
62# endif
63#endif
64
acfe0abc 65static I32 read_e_script(pTHX_ int idx, SV *buf_sv, int maxlen);
0cb96387 66
cc69b689 67#ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
b24bc095 68# define validate_suid(rsfp) NOOP
cc69b689 69#else
b24bc095 70# define validate_suid(rsfp) S_validate_suid(aTHX_ rsfp)
a687059c 71#endif
8d063cd8 72
d6f07c05
AL
73#define CALL_BODY_SUB(myop) \
74 if (PL_op == (myop)) \
139d0ce6 75 PL_op = PL_ppaddr[OP_ENTERSUB](aTHX); \
d6f07c05
AL
76 if (PL_op) \
77 CALLRUNOPS(aTHX);
78
79#define CALL_LIST_BODY(cv) \
80 PUSHMARK(PL_stack_sp); \
9a8aa25b 81 call_sv(MUTABLE_SV((cv)), G_EVAL|G_DISCARD|G_VOID);
d6f07c05 82
e6827a76 83static void
daa7d858 84S_init_tls_and_interp(PerlInterpreter *my_perl)
e6827a76 85{
27da23d5 86 dVAR;
e6827a76
NC
87 if (!PL_curinterp) {
88 PERL_SET_INTERP(my_perl);
3db8f154 89#if defined(USE_ITHREADS)
e6827a76
NC
90 INIT_THREADS;
91 ALLOC_THREAD_KEY;
92 PERL_SET_THX(my_perl);
93 OP_REFCNT_INIT;
e8570548 94 OP_CHECK_MUTEX_INIT;
1e5c5f69 95 KEYWORD_PLUGIN_MUTEX_INIT;
71ad1b0c 96 HINTS_REFCNT_INIT;
929e1213 97 LOCALE_INIT;
8310e7fa 98 USER_PROP_MUTEX_INIT;
e6827a76 99 MUTEX_INIT(&PL_dollarzero_mutex);
016af4f1
DM
100 MUTEX_INIT(&PL_my_ctx_mutex);
101# endif
e6827a76 102 }
c0bce9aa
NC
103#if defined(USE_ITHREADS)
104 else
105#else
106 /* This always happens for non-ithreads */
107#endif
108 {
e6827a76
NC
109 PERL_SET_THX(my_perl);
110 }
111}
06d86050 112
cbec8ebe
DM
113
114/* these implement the PERL_SYS_INIT, PERL_SYS_INIT3, PERL_SYS_TERM macros */
115
116void
117Perl_sys_init(int* argc, char*** argv)
118{
4fc0badb 119 dVAR;
7918f24d
NC
120
121 PERL_ARGS_ASSERT_SYS_INIT;
122
cbec8ebe
DM
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
128void
129Perl_sys_init3(int* argc, char*** argv, char*** env)
130{
4fc0badb 131 dVAR;
7918f24d
NC
132
133 PERL_ARGS_ASSERT_SYS_INIT3;
134
cbec8ebe
DM
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
141void
88772978 142Perl_sys_term(void)
cbec8ebe 143{
4fc0badb 144 dVAR;
bf81751b
DM
145 if (!PL_veto_cleanup) {
146 PERL_SYS_TERM_BODY();
147 }
cbec8ebe
DM
148}
149
150
32e30700
GS
151#ifdef PERL_IMPLICIT_SYS
152PerlInterpreter *
7766f137
GS
153perl_alloc_using(struct IPerlMem* ipM, struct IPerlMem* ipMS,
154 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
32e30700
GS
155 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
156 struct IPerlDir* ipD, struct IPerlSock* ipS,
157 struct IPerlProc* ipP)
158{
159 PerlInterpreter *my_perl;
7918f24d
NC
160
161 PERL_ARGS_ASSERT_PERL_ALLOC_USING;
162
9f653bb5 163 /* Newx() needs interpreter, so call malloc() instead */
32e30700 164 my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
e6827a76 165 S_init_tls_and_interp(my_perl);
32e30700
GS
166 Zero(my_perl, 1, PerlInterpreter);
167 PL_Mem = ipM;
7766f137
GS
168 PL_MemShared = ipMS;
169 PL_MemParse = ipMP;
32e30700
GS
170 PL_Env = ipE;
171 PL_StdIO = ipStd;
172 PL_LIO = ipLIO;
173 PL_Dir = ipD;
174 PL_Sock = ipS;
175 PL_Proc = ipP;
7cb608b5 176 INIT_TRACK_MEMPOOL(PL_memory_debug_header, my_perl);
7766f137 177
32e30700
GS
178 return my_perl;
179}
180#else
954c1994
GS
181
182/*
ccfc67b7
JH
183=head1 Embedding Functions
184
954c1994
GS
185=for apidoc perl_alloc
186
187Allocates a new Perl interpreter. See L<perlembed>.
188
189=cut
190*/
191
93a17b20 192PerlInterpreter *
cea2e8a9 193perl_alloc(void)
79072805 194{
cea2e8a9 195 PerlInterpreter *my_perl;
79072805 196
9f653bb5 197 /* Newx() needs interpreter, so call malloc() instead */
e8ee3774 198 my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
ba869deb 199
e6827a76 200 S_init_tls_and_interp(my_perl);
7cb608b5 201#ifndef PERL_TRACK_MEMPOOL
07409e01 202 return (PerlInterpreter *) ZeroD(my_perl, 1, PerlInterpreter);
7cb608b5
NC
203#else
204 Zero(my_perl, 1, PerlInterpreter);
205 INIT_TRACK_MEMPOOL(PL_memory_debug_header, my_perl);
206 return my_perl;
207#endif
79072805 208}
32e30700 209#endif /* PERL_IMPLICIT_SYS */
79072805 210
954c1994
GS
211/*
212=for apidoc perl_construct
213
214Initializes a new Perl interpreter. See L<perlembed>.
215
216=cut
217*/
218
0927ade0 219static void
220S_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
79072805 239void
0cb96387 240perl_construct(pTHXx)
79072805 241{
27da23d5 242 dVAR;
7918f24d
NC
243
244 PERL_ARGS_ASSERT_PERL_CONSTRUCT;
245
8990e307 246#ifdef MULTIPLICITY
54aff467 247 init_interp();
ac27b0f5 248 PL_perl_destruct_level = 1;
54aff467 249#else
7918f24d 250 PERL_UNUSED_ARG(my_perl);
54aff467
GS
251 if (PL_perl_destruct_level > 0)
252 init_interp();
253#endif
34caed6d
DM
254 PL_curcop = &PL_compiling; /* needed by ckWARN, right away */
255
75d476e2
SM
256#ifdef PERL_TRACE_OPS
257 Zero(PL_op_exec_cnt, OP_max+2, UV);
258#endif
259
0d96b528 260 init_constants();
34caed6d 261
e04fc1aa
CB
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
d6295071 278#ifdef NO_PERL_INTERNAL_RAND_SEED
f26b33bd 279 Perl_drand48_init_r(&PL_internal_random_state, seed());
d6295071
TC
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
f26b33bd 293
748a9306 294 init_ids();
a5f75d66 295
0927ade0 296 S_fixup_platform_bugs();
297
312caa8e 298 JMPENV_BOOTSTRAP;
f86702cc
PP
299 STATUS_ALL_SUCCESS;
300
95e064d9 301 init_uniprops();
0b5b802d 302
ab821d7f 303#if defined(LOCAL_PATCH_COUNT)
3280af22 304 PL_localpatches = local_patches; /* For possible -v */
ab821d7f
PP
305#endif
306
fa2e4594
TC
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
52853b95
GS
315#ifdef HAVE_INTERP_INTERN
316 sys_intern_init();
317#endif
318
3a1ee7e8 319 PerlIO_init(aTHX); /* Hook to IO system */
760ac839 320
3280af22
NIS
321 PL_fdpid = newAV(); /* for remembering popen pids by fd */
322 PL_modglobal = newHV(); /* pointers to per-interpreter module globals */
396482e1 323 PL_errors = newSVpvs("");
854da30f
YO
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. */
1fcf4c12 327#ifdef USE_ITHREADS
402d2eb1
NC
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(""));
13137afc 331 PL_regex_pad = AvARRAY(PL_regex_padav);
d4d03940 332 Newxz(PL_stashpad, PL_stashpadmax, HV *);
1fcf4c12 333#endif
e5dd39fc 334#ifdef USE_REENTRANT_API
59bd0823 335 Perl_reentrant_init(aTHX);
e5dd39fc 336#endif
e6a172f3 337 if (PL_hash_seed_set == FALSE) {
9d5e3f1a
YO
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 */
1a237f4f 346#if defined(USE_HASH_SEED)
9d5e3f1a 347 /* get the hash seed from the environment or from an RNG */
7dc86639 348 Perl_get_hash_seed(aTHX_ PL_hash_seed);
1a237f4f 349#else
9d5e3f1a
YO
350 /* they want a hard coded seed, check that it is long enough */
351 assert( strlen(PERL_HASH_SEED) >= PERL_HASH_SEED_BYTES );
1a237f4f 352#endif
e6a172f3 353
9d5e3f1a
YO
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 }
c82f4881
N
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 }
3d47000e 390
a38ab475
RZ
391 Zero(PL_sv_consts, SV_CONSTS_COUNT, SV*);
392
2f42fcb0
JH
393#ifndef PERL_MICRO
394# ifdef USE_ENVIRON_ARRAY
0631ea03 395 PL_origenviron = environ;
2f42fcb0 396# endif
0631ea03
AB
397#endif
398
5311654c 399 /* Use sysconf(_SC_CLK_TCK) if available, if not
dbc1d986 400 * available or if the sysconf() fails, use the HZ.
27da23d5
JH
401 * The HZ if not originally defined has been by now
402 * been defined as CLK_TCK, if available. */
b6c36746 403#if defined(HAS_SYSCONF) && defined(_SC_CLK_TCK)
5311654c
JH
404 PL_clocktick = sysconf(_SC_CLK_TCK);
405 if (PL_clocktick <= 0)
406#endif
407 PL_clocktick = HZ;
408
081fc587
AB
409 PL_stashcache = newHV();
410
e8e3635e 411 PL_patchlevel = newSVpvs("v" PERL_VERSION_STRING);
d7aa5382 412
27da23d5
JH
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) {
f63f4036
Z
424 Perl_croak(aTHX_ "panic: sysconf: %s",
425 errno ? Strerror(errno) : "pagesize unknown");
27da23d5
JH
426 }
427 }
39bb759e 428#elif defined(HAS_GETPAGESIZE)
27da23d5 429 PL_mmap_page_size = getpagesize();
39bb759e 430#elif defined(I_SYS_PARAM) && defined(PAGESIZE)
27da23d5 431 PL_mmap_page_size = PAGESIZE; /* compiletime, bad */
27da23d5
JH
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
7d113631
NC
446 PL_osname = Perl_savepvn(aTHX_ STR_WITH_LEN(OSNAME));
447
a3e6e81e 448 PL_registered_mros = newHV();
9e169432
NC
449 /* Start with 1 bucket, for DFS. It's unlikely we'll need more. */
450 HvMAX(PL_registered_mros) = 0;
a3e6e81e 451
39e69e77 452#ifdef USE_POSIX_2008_LOCALE
6ebbc862
KW
453 PL_C_locale_obj = newlocale(LC_ALL_MASK, "C", NULL);
454#endif
7b8dd5f4 455
8990e307 456 ENTER;
cb3fd6ac 457 init_i18nl10n(1);
79072805
LW
458}
459
954c1994 460/*
62375a60
NIS
461=for apidoc nothreadhook
462
463Stub that provides thread hook for perl_destruct when there are
464no threads.
465
466=cut
467*/
468
469int
4e9e3734 470Perl_nothreadhook(pTHX)
62375a60 471{
96a5add6 472 PERL_UNUSED_CONTEXT;
62375a60
NIS
473 return 0;
474}
475
41e4abd8
NC
476#ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
477void
478Perl_dump_sv_child(pTHX_ SV *sv)
479{
480 ssize_t got;
bf357333
NC
481 const int sock = PL_dumper_fd;
482 const int debug_fd = PerlIO_fileno(Perl_debug_log);
bf357333
NC
483 union control_un control;
484 struct msghdr msg;
808ad2d0 485 struct iovec vec[2];
bf357333 486 struct cmsghdr *cmptr;
808ad2d0
NC
487 int returned_errno;
488 unsigned char buffer[256];
41e4abd8 489
7918f24d
NC
490 PERL_ARGS_ASSERT_DUMP_SV_CHILD;
491
bf357333 492 if(sock == -1 || debug_fd == -1)
41e4abd8
NC
493 return;
494
495 PerlIO_flush(Perl_debug_log);
496
bf357333
NC
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
b293a5f8 501 be open, the wait would be forever.) */
bf357333
NC
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;
808ad2d0 509 msg.msg_iovlen = 1;
bf357333
NC
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);
41e4abd8
NC
520
521 if(got < 0) {
bf357333 522 perror("Debug leaking scalars parent sendmsg failed");
41e4abd8
NC
523 abort();
524 }
bf357333
NC
525 if(got < sizeof(sv)) {
526 perror("Debug leaking scalars parent short sendmsg");
41e4abd8
NC
527 abort();
528 }
529
808ad2d0
NC
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);
41e4abd8
NC
541
542 if(got < 0) {
543 perror("Debug leaking scalars parent read failed");
808ad2d0 544 PerlIO_flush(PerlIO_stderr());
41e4abd8
NC
545 abort();
546 }
808ad2d0 547 if(got < sizeof(returned_errno) + 1) {
41e4abd8 548 perror("Debug leaking scalars parent short read");
808ad2d0 549 PerlIO_flush(PerlIO_stderr());
41e4abd8
NC
550 abort();
551 }
552
808ad2d0
NC
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,
0c0d42ff 571 returned_errno, Strerror(returned_errno));
41e4abd8
NC
572 }
573}
574#endif
575
62375a60 576/*
0301e899
Z
577=for apidoc Am|int|perl_destruct|PerlInterpreter *my_perl
578
579Shuts down a Perl interpreter. See L<perlembed> for a tutorial.
580
581C<my_perl> points to the Perl interpreter. It must have been previously
582created through the use of L</perl_alloc> and L</perl_construct>. It may
583have been initialised through L</perl_parse>, and may have been used
584through L</perl_run> and other means. This function should be called for
585any Perl interpreter that has been constructed with L</perl_construct>,
586even if subsequent operations on it failed, for example if L</perl_parse>
587returned a non-zero value.
588
589If the interpreter's C<PL_exit_flags> word has the
590C<PERL_EXIT_DESTRUCT_END> flag set, then this function will execute code
591in C<END> blocks before performing the rest of destruction. If it is
592desired to make any use of the interpreter between L</perl_parse> and
593L</perl_destruct> other than just calling L</perl_run>, then this flag
594should be set early on. This matters if L</perl_run> will not be called,
595or if anything else will be done in addition to calling L</perl_run>.
596
597Returns a value be a suitable value to pass to the C library function
598C<exit> (or to return from C<main>), to serve as an exit code indicating
599the nature of the way the interpreter terminated. This takes into account
600any failure of L</perl_parse> and any early exit from L</perl_run>.
601The exit code is of the type required by the host operating system,
602so because of differing exit code conventions it is not portable to
603interpret specific numeric values as having specific meanings.
954c1994
GS
604
605=cut
606*/
607
31d77e54 608int
0cb96387 609perl_destruct(pTHXx)
79072805 610{
27da23d5 611 dVAR;
8162b70e 612 volatile signed char destruct_level; /* see possible values in intrpvar.h */
a0d0e21e 613 HV *hv;
2aa47728 614#ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
2aa47728
NC
615 pid_t child;
616#endif
9c0b6888 617 int i;
8990e307 618
7918f24d
NC
619 PERL_ARGS_ASSERT_PERL_DESTRUCT;
620#ifndef MULTIPLICITY
ed6c66dd 621 PERL_UNUSED_ARG(my_perl);
7918f24d 622#endif
9d4ba2ae 623
3d22c4f0
GG
624 assert(PL_scopestack_ix == 1);
625
7766f137
GS
626 /* wait for all pseudo-forked children to finish */
627 PERL_WAIT_FOR_CHILDREN;
628
3280af22 629 destruct_level = PL_perl_destruct_level;
36e77d41 630#if defined(DEBUGGING) || defined(PERL_TRACK_MEMPOOL)
4633a7c4 631 {
9d4ba2ae
AL
632 const char * const s = PerlEnv_getenv("PERL_DESTRUCT_LEVEL");
633 if (s) {
96e440d2
JH
634 int i;
635 if (strEQ(s, "-1")) { /* Special case: modperl folklore. */
636 i = -1;
637 } else {
22ff3130
HS
638 UV uv;
639 if (grok_atoUV(s, &uv, NULL) && uv <= INT_MAX)
640 i = (int)uv;
641 else
642 i = 0;
96e440d2 643 }
36e77d41
DD
644#ifdef DEBUGGING
645 if (destruct_level < i) destruct_level = i;
646#endif
647#ifdef PERL_TRACK_MEMPOOL
f5199772
KW
648 /* RT #114496, for perl_free */
649 PL_perl_destruct_level = i;
36e77d41 650#endif
5f05dabc 651 }
4633a7c4
LW
652 }
653#endif
654
27da23d5 655 if (PL_exit_flags & PERL_EXIT_DESTRUCT_END) {
f3faeb53
AB
656 dJMPENV;
657 int x = 0;
658
659 JMPENV_PUSH(x);
1b6737cc 660 PERL_UNUSED_VAR(x);
9ebf26ad 661 if (PL_endav && !PL_minus_c) {
ca7b837b 662 PERL_SET_PHASE(PERL_PHASE_END);
f3faeb53 663 call_list(PL_scopestack_ix, PL_endav);
9ebf26ad 664 }
f3faeb53 665 JMPENV_POP;
26f423df 666 }
f3faeb53 667 LEAVE;
a0d0e21e 668 FREETMPS;
3d22c4f0 669 assert(PL_scopestack_ix == 0);
a0d0e21e 670
e00b64d4 671 /* Need to flush since END blocks can produce output */
8abddda3
TC
672 /* flush stdout separately, since we can identify it */
673#ifdef USE_PERLIO
674 {
675 PerlIO *stdo = PerlIO_stdout();
676 if (*stdo && PerlIO_flush(stdo)) {
677 PerlIO_restore_errno(stdo);
675c73ca 678 if (errno)
37537123 679 PerlIO_printf(PerlIO_stderr(), "Unable to flush stdout: %s\n",
675c73ca 680 Strerror(errno));
8abddda3
TC
681 if (!STATUS_UNIX)
682 STATUS_ALL_FAILURE;
683 }
684 }
685#endif
f13a2bc0 686 my_fflush_all();
e00b64d4 687
75d476e2 688#ifdef PERL_TRACE_OPS
e71f25b3
JC
689 /* dump OP-counts if $ENV{PERL_TRACE_OPS} > 0 */
690 {
691 const char * const ptoenv = PerlEnv_getenv("PERL_TRACE_OPS");
692 UV uv;
693
694 if (!ptoenv || !Perl_grok_atoUV(ptoenv, &uv, NULL)
695 || !(uv > 0))
696 goto no_trace_out;
697 }
75d476e2
SM
698 PerlIO_printf(Perl_debug_log, "Trace of all OPs executed:\n");
699 for (i = 0; i <= OP_max; ++i) {
e71f25b3 700 if (PL_op_exec_cnt[i])
147e3846 701 PerlIO_printf(Perl_debug_log, " %s: %" UVuf "\n", PL_op_name[i], PL_op_exec_cnt[i]);
75d476e2
SM
702 }
703 /* Utility slot for easily doing little tracing experiments in the runloop: */
704 if (PL_op_exec_cnt[OP_max+1] != 0)
147e3846 705 PerlIO_printf(Perl_debug_log, " SPECIAL: %" UVuf "\n", PL_op_exec_cnt[OP_max+1]);
75d476e2 706 PerlIO_printf(Perl_debug_log, "\n");
e71f25b3 707 no_trace_out:
75d476e2
SM
708#endif
709
710
16c91539 711 if (PL_threadhook(aTHX)) {
62375a60 712 /* Threads hook has vetoed further cleanup */
c301d606 713 PL_veto_cleanup = TRUE;
37038d91 714 return STATUS_EXIT;
62375a60
NIS
715 }
716
2aa47728
NC
717#ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
718 if (destruct_level != 0) {
719 /* Fork here to create a child. Our child's job is to preserve the
720 state of scalars prior to destruction, so that we can instruct it
721 to dump any scalars that we later find have leaked.
722 There's no subtlety in this code - it assumes POSIX, and it doesn't
723 fail gracefully */
724 int fd[2];
725
49836294 726 if(PerlSock_socketpair_cloexec(AF_UNIX, SOCK_STREAM, 0, fd)) {
2aa47728
NC
727 perror("Debug leaking scalars socketpair failed");
728 abort();
729 }
730
731 child = fork();
732 if(child == -1) {
733 perror("Debug leaking scalars fork failed");
734 abort();
735 }
736 if (!child) {
737 /* We are the child */
3125a5a4
NC
738 const int sock = fd[1];
739 const int debug_fd = PerlIO_fileno(Perl_debug_log);
740 int f;
808ad2d0
NC
741 const char *where;
742 /* Our success message is an integer 0, and a char 0 */
b61433a9 743 static const char success[sizeof(int) + 1] = {0};
3125a5a4 744
2aa47728 745 close(fd[0]);
2aa47728 746
3125a5a4
NC
747 /* We need to close all other file descriptors otherwise we end up
748 with interesting hangs, where the parent closes its end of a
749 pipe, and sits waiting for (another) child to terminate. Only
750 that child never terminates, because it never gets EOF, because
bf357333
NC
751 we also have the far end of the pipe open. We even need to
752 close the debugging fd, because sometimes it happens to be one
753 end of a pipe, and a process is waiting on the other end for
754 EOF. Normally it would be closed at some point earlier in
755 destruction, but if we happen to cause the pipe to remain open,
756 EOF never occurs, and we get an infinite hang. Hence all the
757 games to pass in a file descriptor if it's actually needed. */
3125a5a4
NC
758
759 f = sysconf(_SC_OPEN_MAX);
760 if(f < 0) {
808ad2d0
NC
761 where = "sysconf failed";
762 goto abort;
3125a5a4
NC
763 }
764 while (f--) {
765 if (f == sock)
766 continue;
3125a5a4
NC
767 close(f);
768 }
769
2aa47728
NC
770 while (1) {
771 SV *target;
bf357333
NC
772 union control_un control;
773 struct msghdr msg;
774 struct iovec vec[1];
775 struct cmsghdr *cmptr;
776 ssize_t got;
777 int got_fd;
778
779 msg.msg_control = control.control;
780 msg.msg_controllen = sizeof(control.control);
781 /* We're a connected socket so we don't need a source */
782 msg.msg_name = NULL;
783 msg.msg_namelen = 0;
784 msg.msg_iov = vec;
c3caa5c3 785 msg.msg_iovlen = C_ARRAY_LENGTH(vec);
bf357333
NC
786
787 vec[0].iov_base = (void*)&target;
788 vec[0].iov_len = sizeof(target);
789
790 got = recvmsg(sock, &msg, 0);
2aa47728
NC
791
792 if(got == 0)
793 break;
794 if(got < 0) {
808ad2d0
NC
795 where = "recv failed";
796 goto abort;
2aa47728
NC
797 }
798 if(got < sizeof(target)) {
808ad2d0
NC
799 where = "short recv";
800 goto abort;
2aa47728 801 }
bf357333 802
808ad2d0
NC
803 if(!(cmptr = CMSG_FIRSTHDR(&msg))) {
804 where = "no cmsg";
805 goto abort;
806 }
807 if(cmptr->cmsg_len != CMSG_LEN(sizeof(int))) {
808 where = "wrong cmsg_len";
809 goto abort;
810 }
811 if(cmptr->cmsg_level != SOL_SOCKET) {
812 where = "wrong cmsg_level";
813 goto abort;
814 }
815 if(cmptr->cmsg_type != SCM_RIGHTS) {
816 where = "wrong cmsg_type";
817 goto abort;
818 }
bf357333
NC
819
820 got_fd = *(int*)CMSG_DATA(cmptr);
821 /* For our last little bit of trickery, put the file descriptor
822 back into Perl_debug_log, as if we never actually closed it
823 */
808ad2d0 824 if(got_fd != debug_fd) {
884fc2d3 825 if (PerlLIO_dup2_cloexec(got_fd, debug_fd) == -1) {
808ad2d0
NC
826 where = "dup2";
827 goto abort;
828 }
829 }
2aa47728 830 sv_dump(target);
bf357333 831
2aa47728
NC
832 PerlIO_flush(Perl_debug_log);
833
808ad2d0 834 got = write(sock, &success, sizeof(success));
2aa47728
NC
835
836 if(got < 0) {
808ad2d0
NC
837 where = "write failed";
838 goto abort;
2aa47728 839 }
808ad2d0
NC
840 if(got < sizeof(success)) {
841 where = "short write";
842 goto abort;
2aa47728
NC
843 }
844 }
845 _exit(0);
808ad2d0
NC
846 abort:
847 {
848 int send_errno = errno;
849 unsigned char length = (unsigned char) strlen(where);
850 struct iovec failure[3] = {
851 {(void*)&send_errno, sizeof(send_errno)},
852 {&length, 1},
853 {(void*)where, length}
854 };
855 int got = writev(sock, failure, 3);
856 /* Bad news travels fast. Faster than data. We'll get a SIGPIPE
857 in the parent if we try to read from the socketpair after the
858 child has exited, even if there was data to read.
859 So sleep a bit to give the parent a fighting chance of
860 reading the data. */
861 sleep(2);
862 _exit((got == -1) ? errno : 0);
863 }
bf357333 864 /* End of child. */
2aa47728 865 }
41e4abd8 866 PL_dumper_fd = fd[0];
2aa47728
NC
867 close(fd[1]);
868 }
869#endif
870
ff0cee69
PP
871 /* We must account for everything. */
872
873 /* Destroy the main CV and syntax tree */
37e77c23
FC
874 /* Set PL_curcop now, because destroying ops can cause new SVs
875 to be generated in Perl_pad_swipe, and when running with
876 -DDEBUG_LEAKING_SCALARS they expect PL_curcop to point to a valid
877 op from which the filename structure member is copied. */
17fbfdf6 878 PL_curcop = &PL_compiling;
3280af22 879 if (PL_main_root) {
4e380990
DM
880 /* ensure comppad/curpad to refer to main's pad */
881 if (CvPADLIST(PL_main_cv)) {
882 PAD_SET_CUR_NOSAVE(CvPADLIST(PL_main_cv), 1);
325e1816 883 PL_comppad_name = PadlistNAMES(CvPADLIST(PL_main_cv));
4e380990 884 }
3280af22 885 op_free(PL_main_root);
5f66b61c 886 PL_main_root = NULL;
a0d0e21e 887 }
5f66b61c 888 PL_main_start = NULL;
aac9d523
DM
889 /* note that PL_main_cv isn't usually actually freed at this point,
890 * due to the CvOUTSIDE refs from subs compiled within it. It will
891 * get freed once all the subs are freed in sv_clean_all(), for
892 * destruct_level > 0 */
3280af22 893 SvREFCNT_dec(PL_main_cv);
601f1833 894 PL_main_cv = NULL;
ca7b837b 895 PERL_SET_PHASE(PERL_PHASE_DESTRUCT);
ff0cee69 896
13621cfb
NIS
897 /* Tell PerlIO we are about to tear things apart in case
898 we have layers which are using resources that should
899 be cleaned up now.
900 */
901
902 PerlIO_destruct(aTHX);
903
ddf23d4a
SM
904 /*
905 * Try to destruct global references. We do this first so that the
906 * destructors and destructees still exist. Some sv's might remain.
907 * Non-referenced objects are on their own.
908 */
909 sv_clean_objs();
8990e307 910
5cd24f17 911 /* unhook hooks which will soon be, or use, destroyed data */
3280af22 912 SvREFCNT_dec(PL_warnhook);
a0714e2c 913 PL_warnhook = NULL;
3280af22 914 SvREFCNT_dec(PL_diehook);
a0714e2c 915 PL_diehook = NULL;
5cd24f17 916
4b556e6c 917 /* call exit list functions */
3280af22 918 while (PL_exitlistlen-- > 0)
acfe0abc 919 PL_exitlist[PL_exitlistlen].fn(aTHX_ PL_exitlist[PL_exitlistlen].ptr);
4b556e6c 920
3280af22 921 Safefree(PL_exitlist);
4b556e6c 922
1c4916e5
CB
923 PL_exitlist = NULL;
924 PL_exitlistlen = 0;
925
a3e6e81e
NC
926 SvREFCNT_dec(PL_registered_mros);
927
551a8b83 928 /* jettison our possibly duplicated environment */
4b647fb0
DM
929 /* if PERL_USE_SAFE_PUTENV is defined environ will not have been copied
930 * so we certainly shouldn't free it here
931 */
2f42fcb0 932#ifndef PERL_MICRO
4b647fb0 933#if defined(USE_ENVIRON_ARRAY) && !defined(PERL_USE_SAFE_PUTENV)
50acdf95 934 if (environ != PL_origenviron && !PL_use_safe_putenv
4efc5df6
GS
935#ifdef USE_ITHREADS
936 /* only main thread can free environ[0] contents */
937 && PL_curinterp == aTHX
938#endif
939 )
940 {
551a8b83
JH
941 I32 i;
942
943 for (i = 0; environ[i]; i++)
4b420006 944 safesysfree(environ[i]);
0631ea03 945
4b420006
JH
946 /* Must use safesysfree() when working with environ. */
947 safesysfree(environ);
551a8b83
JH
948
949 environ = PL_origenviron;
950 }
951#endif
2f42fcb0 952#endif /* !PERL_MICRO */
551a8b83 953
30985c42
JH
954 if (destruct_level == 0) {
955
956 DEBUG_P(debprofdump());
957
958#if defined(PERLIO_LAYERS)
959 /* No more IO - including error messages ! */
960 PerlIO_cleanup(aTHX);
961#endif
962
963 CopFILE_free(&PL_compiling);
30985c42
JH
964
965 /* The exit() function will do everything that needs doing. */
966 return STATUS_EXIT;
967 }
968
9fa9f06b
KW
969 /* Below, do clean up for when PERL_DESTRUCT_LEVEL is not 0 */
970
5f8cb046
DM
971#ifdef USE_ITHREADS
972 /* the syntax tree is shared between clones
973 * so op_free(PL_main_root) only ReREFCNT_dec's
974 * REGEXPs in the parent interpreter
975 * we need to manually ReREFCNT_dec for the clones
976 */
0547a729
DM
977 {
978 I32 i = AvFILLp(PL_regex_padav);
979 SV **ary = AvARRAY(PL_regex_padav);
980
981 for (; i; i--) {
982 SvREFCNT_dec(ary[i]);
983 ary[i] = &PL_sv_undef;
984 }
985 }
5f8cb046
DM
986#endif
987
0547a729 988
ad64d0ec 989 SvREFCNT_dec(MUTABLE_SV(PL_stashcache));
081fc587
AB
990 PL_stashcache = NULL;
991
5f05dabc
PP
992 /* loosen bonds of global variables */
993
2f9285f8
DM
994 /* XXX can PL_parser still be non-null here? */
995 if(PL_parser && PL_parser->rsfp) {
996 (void)PerlIO_close(PL_parser->rsfp);
997 PL_parser->rsfp = NULL;
8ebc5c01
PP
998 }
999
84386e14
RGS
1000 if (PL_minus_F) {
1001 Safefree(PL_splitstr);
1002 PL_splitstr = NULL;
1003 }
1004
8ebc5c01 1005 /* switches */
3280af22
NIS
1006 PL_minus_n = FALSE;
1007 PL_minus_p = FALSE;
1008 PL_minus_l = FALSE;
1009 PL_minus_a = FALSE;
1010 PL_minus_F = FALSE;
1011 PL_doswitches = FALSE;
599cee73 1012 PL_dowarn = G_WARN_OFF;
1a904fc8 1013#ifdef PERL_SAWAMPERSAND
d3b97530 1014 PL_sawampersand = 0; /* must save all match strings */
1a904fc8 1015#endif
3280af22
NIS
1016 PL_unsafe = FALSE;
1017
1018 Safefree(PL_inplace);
bd61b366 1019 PL_inplace = NULL;
a7cb1f99 1020 SvREFCNT_dec(PL_patchlevel);
3280af22
NIS
1021
1022 if (PL_e_script) {
1023 SvREFCNT_dec(PL_e_script);
a0714e2c 1024 PL_e_script = NULL;
8ebc5c01
PP
1025 }
1026
bf9cdc68
RG
1027 PL_perldb = 0;
1028
8ebc5c01
PP
1029 /* magical thingies */
1030
e23d9e2f
CS
1031 SvREFCNT_dec(PL_ofsgv); /* *, */
1032 PL_ofsgv = NULL;
5f05dabc 1033
7889fe52 1034 SvREFCNT_dec(PL_ors_sv); /* $\ */
a0714e2c 1035 PL_ors_sv = NULL;
8ebc5c01 1036
3280af22 1037 SvREFCNT_dec(PL_rs); /* $/ */
a0714e2c 1038 PL_rs = NULL;
dc92893f 1039
d33b2eba 1040 Safefree(PL_osname); /* $^O */
bd61b366 1041 PL_osname = NULL;
5f05dabc 1042
3280af22 1043 SvREFCNT_dec(PL_statname);
a0714e2c
SS
1044 PL_statname = NULL;
1045 PL_statgv = NULL;
5f05dabc 1046
8ebc5c01
PP
1047 /* defgv, aka *_ should be taken care of elsewhere */
1048
7d5ea4e7
GS
1049 /* float buffer */
1050 Safefree(PL_efloatbuf);
bd61b366 1051 PL_efloatbuf = NULL;
7d5ea4e7
GS
1052 PL_efloatsize = 0;
1053
8ebc5c01 1054 /* startup and shutdown function lists */
3280af22 1055 SvREFCNT_dec(PL_beginav);
5a837c8f 1056 SvREFCNT_dec(PL_beginav_save);
3280af22 1057 SvREFCNT_dec(PL_endav);
7d30b5c4 1058 SvREFCNT_dec(PL_checkav);
ece599bd 1059 SvREFCNT_dec(PL_checkav_save);
3c10abe3
AG
1060 SvREFCNT_dec(PL_unitcheckav);
1061 SvREFCNT_dec(PL_unitcheckav_save);
3280af22 1062 SvREFCNT_dec(PL_initav);
7d49f689
NC
1063 PL_beginav = NULL;
1064 PL_beginav_save = NULL;
1065 PL_endav = NULL;
1066 PL_checkav = NULL;
1067 PL_checkav_save = NULL;
3c10abe3
AG
1068 PL_unitcheckav = NULL;
1069 PL_unitcheckav_save = NULL;
7d49f689 1070 PL_initav = NULL;
5618dfe8 1071
8ebc5c01 1072 /* shortcuts just get cleared */
a0714e2c
SS
1073 PL_hintgv = NULL;
1074 PL_errgv = NULL;
a0714e2c
SS
1075 PL_argvoutgv = NULL;
1076 PL_stdingv = NULL;
1077 PL_stderrgv = NULL;
1078 PL_last_in_gv = NULL;
a0714e2c
SS
1079 PL_DBsingle = NULL;
1080 PL_DBtrace = NULL;
1081 PL_DBsignal = NULL;
a6d69523
TC
1082 PL_DBsingle_iv = 0;
1083 PL_DBtrace_iv = 0;
1084 PL_DBsignal_iv = 0;
601f1833 1085 PL_DBcv = NULL;
7d49f689 1086 PL_dbargs = NULL;
5c284bb0 1087 PL_debstash = NULL;
8ebc5c01 1088
cf93a474 1089 SvREFCNT_dec(PL_envgv);
f03015cd 1090 SvREFCNT_dec(PL_incgv);
722fa0e9 1091 SvREFCNT_dec(PL_argvgv);
475b1e90 1092 SvREFCNT_dec(PL_replgv);
8cece913
FC
1093 SvREFCNT_dec(PL_DBgv);
1094 SvREFCNT_dec(PL_DBline);
1095 SvREFCNT_dec(PL_DBsub);
cf93a474 1096 PL_envgv = NULL;
f03015cd 1097 PL_incgv = NULL;
722fa0e9 1098 PL_argvgv = NULL;
475b1e90 1099 PL_replgv = NULL;
8cece913
FC
1100 PL_DBgv = NULL;
1101 PL_DBline = NULL;
1102 PL_DBsub = NULL;
1103
7a1c5554 1104 SvREFCNT_dec(PL_argvout_stack);
7d49f689 1105 PL_argvout_stack = NULL;
8ebc5c01 1106
5c831c24 1107 SvREFCNT_dec(PL_modglobal);
5c284bb0 1108 PL_modglobal = NULL;
5c831c24 1109 SvREFCNT_dec(PL_preambleav);
7d49f689 1110 PL_preambleav = NULL;
5c831c24 1111 SvREFCNT_dec(PL_subname);
a0714e2c 1112 PL_subname = NULL;
ca0c25f6 1113#ifdef PERL_USES_PL_PIDSTATUS
5c831c24 1114 SvREFCNT_dec(PL_pidstatus);
5c284bb0 1115 PL_pidstatus = NULL;
ca0c25f6 1116#endif
5c831c24 1117 SvREFCNT_dec(PL_toptarget);
a0714e2c 1118 PL_toptarget = NULL;
5c831c24 1119 SvREFCNT_dec(PL_bodytarget);
a0714e2c
SS
1120 PL_bodytarget = NULL;
1121 PL_formtarget = NULL;
5c831c24 1122
d33b2eba 1123 /* free locale stuff */
b9582b6a 1124#ifdef USE_LOCALE_COLLATE
d33b2eba 1125 Safefree(PL_collation_name);
bd61b366 1126 PL_collation_name = NULL;
b9582b6a 1127#endif
e9bc6d6b
KW
1128#if defined(USE_POSIX_2008_LOCALE) \
1129 && defined(USE_THREAD_SAFE_LOCALE) \
1130 && ! defined(HAS_QUERYLOCALE)
1131 for (i = 0; i < (int) C_ARRAY_LENGTH(PL_curlocales); i++) {
1132 Safefree(PL_curlocales[i]);
1133 PL_curlocales[i] = NULL;
1134 }
1135#endif
9fe4122e
KW
1136#ifdef HAS_POSIX_2008_LOCALE
1137 {
1138 /* This also makes sure we aren't using a locale object that gets freed
1139 * below */
1140 const locale_t old_locale = uselocale(LC_GLOBAL_LOCALE);
1141 if (old_locale != LC_GLOBAL_LOCALE) {
19ee3daf
KW
1142 DEBUG_Lv(PerlIO_printf(Perl_debug_log,
1143 "%s:%d: Freeing %p\n", __FILE__, __LINE__, old_locale));
9fe4122e
KW
1144 freelocale(old_locale);
1145 }
1146 }
1147# ifdef USE_LOCALE_NUMERIC
e1aa2579 1148 if (PL_underlying_numeric_obj) {
19ee3daf
KW
1149 DEBUG_Lv(PerlIO_printf(Perl_debug_log,
1150 "%s:%d: Freeing %p\n", __FILE__, __LINE__,
1151 PL_underlying_numeric_obj));
e1aa2579
KW
1152 freelocale(PL_underlying_numeric_obj);
1153 PL_underlying_numeric_obj = (locale_t) NULL;
1154 }
e1aa2579 1155# endif
9fe4122e
KW
1156#endif
1157#ifdef USE_LOCALE_NUMERIC
1158 Safefree(PL_numeric_name);
1159 PL_numeric_name = NULL;
1160 SvREFCNT_dec(PL_numeric_radix_sv);
1161 PL_numeric_radix_sv = NULL;
e1aa2579
KW
1162#endif
1163
9aac5db8
KW
1164 if (PL_setlocale_buf) {
1165 Safefree(PL_setlocale_buf);
1166 PL_setlocale_buf = NULL;
1167 }
1168
7e5377f7
KW
1169 if (PL_langinfo_buf) {
1170 Safefree(PL_langinfo_buf);
1171 PL_langinfo_buf = NULL;
1172 }
1173
9c0b6888 1174 /* clear character classes */
5b7de470 1175#ifdef USE_LOCALE_CTYPE
780fcc9f 1176 SvREFCNT_dec(PL_warn_locale);
780fcc9f 1177 PL_warn_locale = NULL;
5b7de470 1178#endif
5c831c24 1179
971a9dd3 1180 if (!specialWARN(PL_compiling.cop_warnings))
72dc9ed5 1181 PerlMemShared_free(PL_compiling.cop_warnings);
a0714e2c 1182 PL_compiling.cop_warnings = NULL;
20439bc7
Z
1183 cophh_free(CopHINTHASH_get(&PL_compiling));
1184 CopHINTHASH_set(&PL_compiling, cophh_new_empty());
05ec9bb3 1185 CopFILE_free(&PL_compiling);
5c831c24 1186
a0d0e21e 1187 /* Prepare to destruct main symbol table. */
5f05dabc 1188
3280af22 1189 hv = PL_defstash;
ca556bcd 1190 /* break ref loop *:: <=> %:: */
854da30f 1191 (void)hv_deletes(hv, "main::", G_DISCARD);
3280af22 1192 PL_defstash = 0;
a0d0e21e 1193 SvREFCNT_dec(hv);
5c831c24 1194 SvREFCNT_dec(PL_curstname);
a0714e2c 1195 PL_curstname = NULL;
a0d0e21e 1196
5a844595
GS
1197 /* clear queued errors */
1198 SvREFCNT_dec(PL_errors);
a0714e2c 1199 PL_errors = NULL;
5a844595 1200
dd69841b
BB
1201 SvREFCNT_dec(PL_isarev);
1202
a0d0e21e 1203 FREETMPS;
9b387841 1204 if (destruct_level >= 2) {
3280af22 1205 if (PL_scopestack_ix != 0)
9b387841
NC
1206 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
1207 "Unbalanced scopes: %ld more ENTERs than LEAVEs\n",
1208 (long)PL_scopestack_ix);
3280af22 1209 if (PL_savestack_ix != 0)
9b387841
NC
1210 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
1211 "Unbalanced saves: %ld more saves than restores\n",
1212 (long)PL_savestack_ix);
3280af22 1213 if (PL_tmps_floor != -1)
9b387841
NC
1214 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced tmps: %ld more allocs than frees\n",
1215 (long)PL_tmps_floor + 1);
a0d0e21e 1216 if (cxstack_ix != -1)
9b387841
NC
1217 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced context: %ld more PUSHes than POPs\n",
1218 (long)cxstack_ix + 1);
a0d0e21e 1219 }
8990e307 1220
0547a729
DM
1221#ifdef USE_ITHREADS
1222 SvREFCNT_dec(PL_regex_padav);
1223 PL_regex_padav = NULL;
1224 PL_regex_pad = NULL;
1225#endif
1226
776df701 1227#ifdef PERL_IMPLICIT_CONTEXT
57bb2458
JH
1228 /* the entries in this list are allocated via SV PVX's, so get freed
1229 * in sv_clean_all */
1230 Safefree(PL_my_cxt_list);
776df701 1231#endif
57bb2458 1232
8990e307 1233 /* Now absolutely destruct everything, somehow or other, loops or no. */
5226ed68
JH
1234
1235 /* the 2 is for PL_fdpid and PL_strtab */
d17ea597 1236 while (sv_clean_all() > 2)
5226ed68
JH
1237 ;
1238
23083432
FC
1239#ifdef USE_ITHREADS
1240 Safefree(PL_stashpad); /* must come after sv_clean_all */
1241#endif
1242
d4777f27
GS
1243 AvREAL_off(PL_fdpid); /* no surviving entries */
1244 SvREFCNT_dec(PL_fdpid); /* needed in io_close() */
7d49f689 1245 PL_fdpid = NULL;
d33b2eba 1246
6c644e78
GS
1247#ifdef HAVE_INTERP_INTERN
1248 sys_intern_clear();
1249#endif
1250
a38ab475
RZ
1251 /* constant strings */
1252 for (i = 0; i < SV_CONSTS_COUNT; i++) {
1253 SvREFCNT_dec(PL_sv_consts[i]);
1254 PL_sv_consts[i] = NULL;
1255 }
1256
6e72f9df
PP
1257 /* Destruct the global string table. */
1258 {
1259 /* Yell and reset the HeVAL() slots that are still holding refcounts,
1260 * so that sv_free() won't fail on them.
80459961
NC
1261 * Now that the global string table is using a single hunk of memory
1262 * for both HE and HEK, we either need to explicitly unshare it the
1263 * correct way, or actually free things here.
6e72f9df 1264 */
80459961
NC
1265 I32 riter = 0;
1266 const I32 max = HvMAX(PL_strtab);
c4420975 1267 HE * const * const array = HvARRAY(PL_strtab);
80459961
NC
1268 HE *hent = array[0];
1269
6e72f9df 1270 for (;;) {
0453d815 1271 if (hent && ckWARN_d(WARN_INTERNAL)) {
44f8325f 1272 HE * const next = HeNEXT(hent);
9014280d 1273 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
44f8325f 1274 "Unbalanced string table refcount: (%ld) for \"%s\"",
de616631 1275 (long)hent->he_valu.hent_refcount, HeKEY(hent));
80459961
NC
1276 Safefree(hent);
1277 hent = next;
6e72f9df
PP
1278 }
1279 if (!hent) {
1280 if (++riter > max)
1281 break;
1282 hent = array[riter];
1283 }
1284 }
80459961
NC
1285
1286 Safefree(array);
1287 HvARRAY(PL_strtab) = 0;
1288 HvTOTALKEYS(PL_strtab) = 0;
6e72f9df 1289 }
3280af22 1290 SvREFCNT_dec(PL_strtab);
6e72f9df 1291
e652bb2f 1292#ifdef USE_ITHREADS
c21d1a0f 1293 /* free the pointer tables used for cloning */
a0739874 1294 ptr_table_free(PL_ptr_table);
bf9cdc68 1295 PL_ptr_table = (PTR_TBL_t*)NULL;
53186e96 1296#endif
a0739874 1297
d33b2eba
GS
1298 /* free special SVs */
1299
1300 SvREFCNT(&PL_sv_yes) = 0;
1301 sv_clear(&PL_sv_yes);
1302 SvANY(&PL_sv_yes) = NULL;
4c5e2b0d 1303 SvFLAGS(&PL_sv_yes) = 0;
d33b2eba
GS
1304
1305 SvREFCNT(&PL_sv_no) = 0;
1306 sv_clear(&PL_sv_no);
1307 SvANY(&PL_sv_no) = NULL;
4c5e2b0d 1308 SvFLAGS(&PL_sv_no) = 0;
01724ea0 1309
5a6c2837
DM
1310 SvREFCNT(&PL_sv_zero) = 0;
1311 sv_clear(&PL_sv_zero);
1312 SvANY(&PL_sv_zero) = NULL;
1313 SvFLAGS(&PL_sv_zero) = 0;
1314
9f375a43
DM
1315 {
1316 int i;
1317 for (i=0; i<=2; i++) {
1318 SvREFCNT(PERL_DEBUG_PAD(i)) = 0;
1319 sv_clear(PERL_DEBUG_PAD(i));
1320 SvANY(PERL_DEBUG_PAD(i)) = NULL;
1321 SvFLAGS(PERL_DEBUG_PAD(i)) = 0;
1322 }
1323 }
1324
0453d815 1325 if (PL_sv_count != 0 && ckWARN_d(WARN_INTERNAL))
9014280d 1326 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Scalars leaked: %ld\n", (long)PL_sv_count);
6e72f9df 1327
eba0f806
DM
1328#ifdef DEBUG_LEAKING_SCALARS
1329 if (PL_sv_count != 0) {
1330 SV* sva;
1331 SV* sv;
eb578fdb 1332 SV* svend;
eba0f806 1333
ad64d0ec 1334 for (sva = PL_sv_arenaroot; sva; sva = MUTABLE_SV(SvANY(sva))) {
eba0f806
DM
1335 svend = &sva[SvREFCNT(sva)];
1336 for (sv = sva + 1; sv < svend; ++sv) {
e4787c0c 1337 if (SvTYPE(sv) != (svtype)SVTYPEMASK) {
a548cda8 1338 PerlIO_printf(Perl_debug_log, "leaked: sv=0x%p"
72ba98d5
KW
1339 " flags=0x%" UVxf
1340 " refcnt=%" UVuf pTHX__FORMAT "\n"
147e3846
KW
1341 "\tallocated at %s:%d %s %s (parent 0x%" UVxf ");"
1342 "serial %" UVuf "\n",
574b8821
NC
1343 (void*)sv, (UV)sv->sv_flags, (UV)sv->sv_refcnt
1344 pTHX__VALUE,
fd0854ff
DM
1345 sv->sv_debug_file ? sv->sv_debug_file : "(unknown)",
1346 sv->sv_debug_line,
1347 sv->sv_debug_inpad ? "for" : "by",
1348 sv->sv_debug_optype ?
1349 PL_op_name[sv->sv_debug_optype]: "(none)",
cd676548 1350 PTR2UV(sv->sv_debug_parent),
cbe56f1d 1351 sv->sv_debug_serial
fd0854ff 1352 );
2aa47728 1353#ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
41e4abd8 1354 Perl_dump_sv_child(aTHX_ sv);
2aa47728 1355#endif
eba0f806
DM
1356 }
1357 }
1358 }
1359 }
2aa47728
NC
1360#ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1361 {
1362 int status;
1363 fd_set rset;
1364 /* Wait for up to 4 seconds for child to terminate.
1365 This seems to be the least effort way of timing out on reaping
1366 its exit status. */
1367 struct timeval waitfor = {4, 0};
41e4abd8 1368 int sock = PL_dumper_fd;
2aa47728
NC
1369
1370 shutdown(sock, 1);
1371 FD_ZERO(&rset);
1372 FD_SET(sock, &rset);
1373 select(sock + 1, &rset, NULL, NULL, &waitfor);
1374 waitpid(child, &status, WNOHANG);
1375 close(sock);
1376 }
1377#endif
eba0f806 1378#endif
77abb4c6
NC
1379#ifdef DEBUG_LEAKING_SCALARS_ABORT
1380 if (PL_sv_count)
1381 abort();
1382#endif
bf9cdc68 1383 PL_sv_count = 0;
eba0f806 1384
56a2bab7 1385#if defined(PERLIO_LAYERS)
3a1ee7e8
NIS
1386 /* No more IO - including error messages ! */
1387 PerlIO_cleanup(aTHX);
1388#endif
1389
9f4bd222 1390 /* sv_undef needs to stay immortal until after PerlIO_cleanup
a0714e2c 1391 as currently layers use it rather than NULL as a marker
9f4bd222
NIS
1392 for no arg - and will try and SvREFCNT_dec it.
1393 */
1394 SvREFCNT(&PL_sv_undef) = 0;
1395 SvREADONLY_off(&PL_sv_undef);
1396
3280af22 1397 Safefree(PL_origfilename);
bd61b366 1398 PL_origfilename = NULL;
43c5f42d 1399 Safefree(PL_reg_curpm);
dd28f7bb 1400 free_tied_hv_pool();
3280af22 1401 Safefree(PL_op_mask);
cf36064f 1402 Safefree(PL_psig_name);
bf9cdc68 1403 PL_psig_name = (SV**)NULL;
d525a7b2 1404 PL_psig_ptr = (SV**)NULL;
31c91b43
LR
1405 {
1406 /* We need to NULL PL_psig_pend first, so that
1407 signal handlers know not to use it */
1408 int *psig_save = PL_psig_pend;
1409 PL_psig_pend = (int*)NULL;
1410 Safefree(psig_save);
1411 }
6e72f9df 1412 nuke_stacks();
284167a5
SM
1413 TAINTING_set(FALSE);
1414 TAINT_WARN_set(FALSE);
3280af22 1415 PL_hints = 0; /* Reset hints. Should hints be per-interpreter ? */
ac27b0f5 1416
a0d0e21e 1417 DEBUG_P(debprofdump());
d33b2eba 1418
b173165c
FC
1419 PL_debug = 0;
1420
e5dd39fc 1421#ifdef USE_REENTRANT_API
10bc17b6 1422 Perl_reentrant_free(aTHX);
e5dd39fc
AB
1423#endif
1424
a24da70b
NC
1425 /* These all point to HVs that are about to be blown away.
1426 Code in core and on CPAN assumes that if the interpreter is re-started
1427 that they will be cleanly NULL or pointing to a valid HV. */
1428 PL_custom_op_names = NULL;
1429 PL_custom_op_descs = NULL;
1430 PL_custom_ops = NULL;
1431
612f20c3
GS
1432 sv_free_arenas();
1433
5d9a96ca
DM
1434 while (PL_regmatch_slab) {
1435 regmatch_slab *s = PL_regmatch_slab;
1436 PL_regmatch_slab = PL_regmatch_slab->next;
1437 Safefree(s);
1438 }
1439
fc36a67e
PP
1440 /* As the absolutely last thing, free the non-arena SV for mess() */
1441
3280af22 1442 if (PL_mess_sv) {
f350b448
NC
1443 /* we know that type == SVt_PVMG */
1444
9c63abab 1445 /* it could have accumulated taint magic */
f350b448
NC
1446 MAGIC* mg;
1447 MAGIC* moremagic;
1448 for (mg = SvMAGIC(PL_mess_sv); mg; mg = moremagic) {
1449 moremagic = mg->mg_moremagic;
1450 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global
1451 && mg->mg_len >= 0)
1452 Safefree(mg->mg_ptr);
1453 Safefree(mg);
9c63abab 1454 }
f350b448 1455
fc36a67e 1456 /* we know that type >= SVt_PV */
8bd4d4c5 1457 SvPV_free(PL_mess_sv);
3280af22
NIS
1458 Safefree(SvANY(PL_mess_sv));
1459 Safefree(PL_mess_sv);
a0714e2c 1460 PL_mess_sv = NULL;
fc36a67e 1461 }
37038d91 1462 return STATUS_EXIT;
79072805
LW
1463}
1464
954c1994
GS
1465/*
1466=for apidoc perl_free
1467
1468Releases a Perl interpreter. See L<perlembed>.
1469
1470=cut
1471*/
1472
79072805 1473void
0cb96387 1474perl_free(pTHXx)
79072805 1475{
5174512c
NC
1476 dVAR;
1477
7918f24d
NC
1478 PERL_ARGS_ASSERT_PERL_FREE;
1479
c301d606
DM
1480 if (PL_veto_cleanup)
1481 return;
1482
7cb608b5 1483#ifdef PERL_TRACK_MEMPOOL
55ef9aae
MHM
1484 {
1485 /*
1486 * Don't free thread memory if PERL_DESTRUCT_LEVEL is set to a non-zero
1487 * value as we're probably hunting memory leaks then
1488 */
36e77d41 1489 if (PL_perl_destruct_level == 0) {
4fd0a9b8 1490 const U32 old_debug = PL_debug;
55ef9aae
MHM
1491 /* Emulate the PerlHost behaviour of free()ing all memory allocated in this
1492 thread at thread exit. */
4fd0a9b8
NC
1493 if (DEBUG_m_TEST) {
1494 PerlIO_puts(Perl_debug_log, "Disabling memory debugging as we "
1495 "free this thread's memory\n");
1496 PL_debug &= ~ DEBUG_m_FLAG;
1497 }
6edcbed6
DD
1498 while(aTHXx->Imemory_debug_header.next != &(aTHXx->Imemory_debug_header)){
1499 char * next = (char *)(aTHXx->Imemory_debug_header.next);
1500 Malloc_t ptr = PERL_MEMORY_DEBUG_HEADER_SIZE + next;
1501 safesysfree(ptr);
1502 }
4fd0a9b8 1503 PL_debug = old_debug;
55ef9aae
MHM
1504 }
1505 }
7cb608b5
NC
1506#endif
1507
acfe0abc 1508#if defined(WIN32) || defined(NETWARE)
ce3e5b80 1509# if defined(PERL_IMPLICIT_SYS)
b36c9a52 1510 {
acfe0abc 1511# ifdef NETWARE
7af12a34 1512 void *host = nw_internal_host;
7af12a34 1513 PerlMem_free(aTHXx);
7af12a34 1514 nw_delete_internal_host(host);
acfe0abc 1515# else
bdb50480
NC
1516 void *host = w32_internal_host;
1517 PerlMem_free(aTHXx);
7af12a34 1518 win32_delete_internal_host(host);
acfe0abc 1519# endif
7af12a34 1520 }
1c0ca838
GS
1521# else
1522 PerlMem_free(aTHXx);
1523# endif
acfe0abc
GS
1524#else
1525 PerlMem_free(aTHXx);
76e3520e 1526#endif
79072805
LW
1527}
1528
b7f7fff6 1529#if defined(USE_ITHREADS)
aebd1ac7
GA
1530/* provide destructors to clean up the thread key when libperl is unloaded */
1531#ifndef WIN32 /* handled during DLL_PROCESS_DETACH in win32/perllib.c */
1532
826955bd 1533#if defined(__hpux) && !(defined(__ux_version) && __ux_version <= 1020) && !defined(__GNUC__)
aebd1ac7 1534#pragma fini "perl_fini"
666ad1ec
GA
1535#elif defined(__sun) && !defined(__GNUC__)
1536#pragma fini (perl_fini)
aebd1ac7
GA
1537#endif
1538
0dbb1585
AL
1539static void
1540#if defined(__GNUC__)
1541__attribute__((destructor))
aebd1ac7 1542#endif
de009b76 1543perl_fini(void)
aebd1ac7 1544{
27da23d5 1545 dVAR;
5c64bffd
NC
1546 if (
1547#ifdef PERL_GLOBAL_STRUCT_PRIVATE
1548 my_vars &&
1549#endif
1550 PL_curinterp && !PL_veto_cleanup)
aebd1ac7
GA
1551 FREE_THREAD_KEY;
1552}
1553
1554#endif /* WIN32 */
1555#endif /* THREADS */
1556
4b556e6c 1557void
864dbfa3 1558Perl_call_atexit(pTHX_ ATEXIT_t fn, void *ptr)
4b556e6c 1559{
3280af22
NIS
1560 Renew(PL_exitlist, PL_exitlistlen+1, PerlExitListEntry);
1561 PL_exitlist[PL_exitlistlen].fn = fn;
1562 PL_exitlist[PL_exitlistlen].ptr = ptr;
1563 ++PL_exitlistlen;
4b556e6c
JD
1564}
1565
954c1994 1566/*
0301e899
Z
1567=for apidoc Am|int|perl_parse|PerlInterpreter *my_perl|XSINIT_t xsinit|int argc|char **argv|char **env
1568
1569Tells a Perl interpreter to parse a Perl script. This performs most
1570of the initialisation of a Perl interpreter. See L<perlembed> for
1571a tutorial.
1572
1573C<my_perl> points to the Perl interpreter that is to parse the script.
1574It must have been previously created through the use of L</perl_alloc>
1575and L</perl_construct>. C<xsinit> points to a callback function that
1576will be called to set up the ability for this Perl interpreter to load
1577XS extensions, or may be null to perform no such setup.
1578
1579C<argc> and C<argv> supply a set of command-line arguments to the Perl
1580interpreter, as would normally be passed to the C<main> function of
1581a C program. C<argv[argc]> must be null. These arguments are where
1582the script to parse is specified, either by naming a script file or by
1583providing a script in a C<-e> option.
a3e261d5
Z
1584If L<C<$0>|perlvar/$0> will be written to in the Perl interpreter, then
1585the argument strings must be in writable memory, and so mustn't just be
1586string constants.
0301e899
Z
1587
1588C<env> specifies a set of environment variables that will be used by
1589this Perl interpreter. If non-null, it must point to a null-terminated
1590array of environment strings. If null, the Perl interpreter will use
1591the environment supplied by the C<environ> global variable.
1592
1593This function initialises the interpreter, and parses and compiles the
1594script specified by the command-line arguments. This includes executing
1595code in C<BEGIN>, C<UNITCHECK>, and C<CHECK> blocks. It does not execute
1596C<INIT> blocks or the main program.
1597
1598Returns an integer of slightly tricky interpretation. The correct
1599use of the return value is as a truth value indicating whether there
1600was a failure in initialisation. If zero is returned, this indicates
1601that initialisation was successful, and it is safe to proceed to call
1602L</perl_run> and make other use of it. If a non-zero value is returned,
1603this indicates some problem that means the interpreter wants to terminate.
1604The interpreter should not be just abandoned upon such failure; the caller
1605should proceed to shut the interpreter down cleanly with L</perl_destruct>
1606and free it with L</perl_free>.
1607
1608For historical reasons, the non-zero return value also attempts to
1609be a suitable value to pass to the C library function C<exit> (or to
1610return from C<main>), to serve as an exit code indicating the nature
1611of the way initialisation terminated. However, this isn't portable,
857320cb
Z
1612due to differing exit code conventions. A historical bug is preserved
1613for the time being: if the Perl built-in C<exit> is called during this
1614function's execution, with a type of exit entailing a zero exit code
1615under the host operating system's conventions, then this function
1616returns zero rather than a non-zero value. This bug, [perl #2754],
1617leads to C<perl_run> being called (and therefore C<INIT> blocks and the
1618main program running) despite a call to C<exit>. It has been preserved
1619because a popular module-installing module has come to rely on it and
1620needs time to be fixed. This issue is [perl #132577], and the original
1621bug is due to be fixed in Perl 5.30.
0301e899 1622
954c1994
GS
1623=cut
1624*/
1625
03d9f026
FC
1626#define SET_CURSTASH(newstash) \
1627 if (PL_curstash != newstash) { \
1628 SvREFCNT_dec(PL_curstash); \
1629 PL_curstash = (HV *)SvREFCNT_inc(newstash); \
1630 }
1631
79072805 1632int
0cb96387 1633perl_parse(pTHXx_ XSINIT_t xsinit, int argc, char **argv, char **env)
8d063cd8 1634{
27da23d5 1635 dVAR;
6224f72b 1636 I32 oldscope;
6224f72b 1637 int ret;
db36c5a1 1638 dJMPENV;
8d063cd8 1639
7918f24d
NC
1640 PERL_ARGS_ASSERT_PERL_PARSE;
1641#ifndef MULTIPLICITY
ed6c66dd 1642 PERL_UNUSED_ARG(my_perl);
7918f24d 1643#endif
1a237f4f 1644#if (defined(USE_HASH_SEED) || defined(USE_HASH_SEED_DEBUG)) && !defined(NO_PERL_HASH_SEED_DEBUG)
b0891165 1645 {
7dc86639
YO
1646 const char * const s = PerlEnv_getenv("PERL_HASH_SEED_DEBUG");
1647
22ff3130 1648 if (s && strEQ(s, "1")) {
25c1b134
TC
1649 const unsigned char *seed= PERL_HASH_SEED;
1650 const unsigned char *seed_end= PERL_HASH_SEED + PERL_HASH_SEED_BYTES;
7dc86639
YO
1651 PerlIO_printf(Perl_debug_log, "HASH_FUNCTION = %s HASH_SEED = 0x", PERL_HASH_FUNC);
1652 while (seed < seed_end) {
1653 PerlIO_printf(Perl_debug_log, "%02x", *seed++);
1654 }
6a5b4183
YO
1655#ifdef PERL_HASH_RANDOMIZE_KEYS
1656 PerlIO_printf(Perl_debug_log, " PERTURB_KEYS = %d (%s)",
1657 PL_HASH_RAND_BITS_ENABLED,
1658 PL_HASH_RAND_BITS_ENABLED == 0 ? "NO" : PL_HASH_RAND_BITS_ENABLED == 1 ? "RANDOM" : "DETERMINISTIC");
1659#endif
7dc86639
YO
1660 PerlIO_printf(Perl_debug_log, "\n");
1661 }
b0891165 1662 }
1a237f4f 1663#endif /* #if (defined(USE_HASH_SEED) ... */
43238333 1664
ea34f6bd 1665#ifdef __amigaos4__
43238333
AB
1666 {
1667 struct NameTranslationInfo nti;
1668 __translate_amiga_to_unix_path_name(&argv[0],&nti);
1669 }
1670#endif
1671
cc85e83f
Z
1672 {
1673 int i;
1674 assert(argc >= 0);
1675 for(i = 0; i != argc; i++)
1676 assert(argv[i]);
1677 assert(!argv[argc]);
1678 }
3280af22 1679 PL_origargc = argc;
e2975953 1680 PL_origargv = argv;
a0d0e21e 1681
a2722ac9
GA
1682 if (PL_origalen != 0) {
1683 PL_origalen = 1; /* don't use old PL_origalen if perl_parse() is called again */
1684 }
1685 else {
3cb9023d
JH
1686 /* Set PL_origalen be the sum of the contiguous argv[]
1687 * elements plus the size of the env in case that it is
e9137a8e 1688 * contiguous with the argv[]. This is used in mg.c:Perl_magic_set()
3cb9023d
JH
1689 * as the maximum modifiable length of $0. In the worst case
1690 * the area we are able to modify is limited to the size of
43c32782 1691 * the original argv[0]. (See below for 'contiguous', though.)
3cb9023d 1692 * --jhi */
e1ec3a88 1693 const char *s = NULL;
b7249aaf 1694 const UV mask = ~(UV)(PTRSIZE-1);
43c32782 1695 /* Do the mask check only if the args seem like aligned. */
1b6737cc 1696 const UV aligned =
43c32782
JH
1697 (mask < ~(UV)0) && ((PTR2UV(argv[0]) & mask) == PTR2UV(argv[0]));
1698
1699 /* See if all the arguments are contiguous in memory. Note
1700 * that 'contiguous' is a loose term because some platforms
1701 * align the argv[] and the envp[]. If the arguments look
1702 * like non-aligned, assume that they are 'strictly' or
1703 * 'traditionally' contiguous. If the arguments look like
1704 * aligned, we just check that they are within aligned
1705 * PTRSIZE bytes. As long as no system has something bizarre
1706 * like the argv[] interleaved with some other data, we are
1707 * fine. (Did I just evoke Murphy's Law?) --jhi */
c8941eeb 1708 if (PL_origargv && PL_origargc >= 1 && (s = PL_origargv[0])) {
19742f39 1709 int i;
c8941eeb
JH
1710 while (*s) s++;
1711 for (i = 1; i < PL_origargc; i++) {
1712 if ((PL_origargv[i] == s + 1
43c32782 1713#ifdef OS2
c8941eeb 1714 || PL_origargv[i] == s + 2
43c32782 1715#endif
c8941eeb
JH
1716 )
1717 ||
1718 (aligned &&
1719 (PL_origargv[i] > s &&
1720 PL_origargv[i] <=
1721 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1722 )
1723 {
1724 s = PL_origargv[i];
1725 while (*s) s++;
1726 }
1727 else
1728 break;
54bfe034 1729 }
54bfe034 1730 }
a4a109c2
JD
1731
1732#ifndef PERL_USE_SAFE_PUTENV
3cb9023d 1733 /* Can we grab env area too to be used as the area for $0? */
a4a109c2 1734 if (s && PL_origenviron && !PL_use_safe_putenv) {
9d419b5f 1735 if ((PL_origenviron[0] == s + 1)
43c32782
JH
1736 ||
1737 (aligned &&
1738 (PL_origenviron[0] > s &&
1739 PL_origenviron[0] <=
1740 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1741 )
1742 {
19742f39 1743 int i;
9d419b5f 1744#ifndef OS2 /* ENVIRON is read by the kernel too. */
43c32782
JH
1745 s = PL_origenviron[0];
1746 while (*s) s++;
1747#endif
bd61b366 1748 my_setenv("NoNe SuCh", NULL);
43c32782
JH
1749 /* Force copy of environment. */
1750 for (i = 1; PL_origenviron[i]; i++) {
1751 if (PL_origenviron[i] == s + 1
1752 ||
1753 (aligned &&
1754 (PL_origenviron[i] > s &&
1755 PL_origenviron[i] <=
1756 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1757 )
1758 {
1759 s = PL_origenviron[i];
1760 while (*s) s++;
1761 }
1762 else
1763 break;
54bfe034 1764 }
43c32782 1765 }
54bfe034 1766 }
a4a109c2
JD
1767#endif /* !defined(PERL_USE_SAFE_PUTENV) */
1768
2d2af554 1769 PL_origalen = s ? s - PL_origargv[0] + 1 : 0;
54bfe034
JH
1770 }
1771
3280af22 1772 if (PL_do_undump) {
a0d0e21e
LW
1773
1774 /* Come here if running an undumped a.out. */
1775
3280af22
NIS
1776 PL_origfilename = savepv(argv[0]);
1777 PL_do_undump = FALSE;
a0d0e21e 1778 cxstack_ix = -1; /* start label stack again */
748a9306 1779 init_ids();
284167a5 1780 assert (!TAINT_get);
b7975bdd 1781 TAINT;
e2051532 1782 set_caret_X();
b7975bdd 1783 TAINT_NOT;
a0d0e21e
LW
1784 init_postdump_symbols(argc,argv,env);
1785 return 0;
1786 }
1787
3280af22 1788 if (PL_main_root) {
3280af22 1789 op_free(PL_main_root);
5f66b61c 1790 PL_main_root = NULL;
ff0cee69 1791 }
5f66b61c 1792 PL_main_start = NULL;
3280af22 1793 SvREFCNT_dec(PL_main_cv);
601f1833 1794 PL_main_cv = NULL;
79072805 1795
3280af22
NIS
1796 time(&PL_basetime);
1797 oldscope = PL_scopestack_ix;
599cee73 1798 PL_dowarn = G_WARN_OFF;
f86702cc 1799
14dd3ad8 1800 JMPENV_PUSH(ret);
6224f72b 1801 switch (ret) {
312caa8e 1802 case 0:
14dd3ad8 1803 parse_body(env,xsinit);
9ebf26ad 1804 if (PL_unitcheckav) {
3c10abe3 1805 call_list(oldscope, PL_unitcheckav);
9ebf26ad
FR
1806 }
1807 if (PL_checkav) {
ca7b837b 1808 PERL_SET_PHASE(PERL_PHASE_CHECK);
7d30b5c4 1809 call_list(oldscope, PL_checkav);
9ebf26ad 1810 }
14dd3ad8
GS
1811 ret = 0;
1812 break;
6224f72b
GS
1813 case 1:
1814 STATUS_ALL_FAILURE;
924ba076 1815 /* FALLTHROUGH */
6224f72b
GS
1816 case 2:
1817 /* my_exit() was called */
3280af22 1818 while (PL_scopestack_ix > oldscope)
6224f72b
GS
1819 LEAVE;
1820 FREETMPS;
03d9f026 1821 SET_CURSTASH(PL_defstash);
9ebf26ad 1822 if (PL_unitcheckav) {
3c10abe3 1823 call_list(oldscope, PL_unitcheckav);
9ebf26ad
FR
1824 }
1825 if (PL_checkav) {
ca7b837b 1826 PERL_SET_PHASE(PERL_PHASE_CHECK);
7d30b5c4 1827 call_list(oldscope, PL_checkav);
9ebf26ad 1828 }
37038d91 1829 ret = STATUS_EXIT;
857320cb
Z
1830 if (ret == 0) {
1831 /*
1832 * At this point we should do
1833 * ret = 0x100;
1834 * to avoid [perl #2754], but that bugfix has been postponed
1835 * because of the Module::Install breakage it causes
1836 * [perl #132577].
1837 */
1838 }
14dd3ad8 1839 break;
6224f72b 1840 case 3:
bf49b057 1841 PerlIO_printf(Perl_error_log, "panic: top_env\n");
14dd3ad8
GS
1842 ret = 1;
1843 break;
6224f72b 1844 }
14dd3ad8
GS
1845 JMPENV_POP;
1846 return ret;
1847}
1848
4a5df386
NC
1849/* This needs to stay in perl.c, as perl.c is compiled with different flags for
1850 miniperl, and we need to see those flags reflected in the values here. */
1851
1852/* What this returns is subject to change. Use the public interface in Config.
1853 */
1854static void
1855S_Internals_V(pTHX_ CV *cv)
1856{
1857 dXSARGS;
1858#ifdef LOCAL_PATCH_COUNT
1859 const int local_patch_count = LOCAL_PATCH_COUNT;
1860#else
1861 const int local_patch_count = 0;
1862#endif
2dc296d2 1863 const int entries = 3 + local_patch_count;
4a5df386 1864 int i;
fe1c5936 1865 static const char non_bincompat_options[] =
4a5df386
NC
1866# ifdef DEBUGGING
1867 " DEBUGGING"
1868# endif
1869# ifdef NO_MATHOMS
0d311fbe 1870 " NO_MATHOMS"
4a5df386 1871# endif
59b86f4b
DM
1872# ifdef NO_HASH_SEED
1873 " NO_HASH_SEED"
1874# endif
3b0e4ee2
MB
1875# ifdef NO_TAINT_SUPPORT
1876 " NO_TAINT_SUPPORT"
1877# endif
cb26ef7a
MB
1878# ifdef PERL_BOOL_AS_CHAR
1879 " PERL_BOOL_AS_CHAR"
1880# endif
93c10d60
FC
1881# ifdef PERL_COPY_ON_WRITE
1882 " PERL_COPY_ON_WRITE"
1883# endif
4a5df386
NC
1884# ifdef PERL_DISABLE_PMC
1885 " PERL_DISABLE_PMC"
1886# endif
1887# ifdef PERL_DONT_CREATE_GVSV
1888 " PERL_DONT_CREATE_GVSV"
1889# endif
9a044a43
NC
1890# ifdef PERL_EXTERNAL_GLOB
1891 " PERL_EXTERNAL_GLOB"
1892# endif
59b86f4b
DM
1893# ifdef PERL_HASH_FUNC_SIPHASH
1894 " PERL_HASH_FUNC_SIPHASH"
1895# endif
1896# ifdef PERL_HASH_FUNC_SDBM
1897 " PERL_HASH_FUNC_SDBM"
1898# endif
1899# ifdef PERL_HASH_FUNC_DJB2
1900 " PERL_HASH_FUNC_DJB2"
1901# endif
1902# ifdef PERL_HASH_FUNC_SUPERFAST
1903 " PERL_HASH_FUNC_SUPERFAST"
1904# endif
1905# ifdef PERL_HASH_FUNC_MURMUR3
1906 " PERL_HASH_FUNC_MURMUR3"
1907# endif
1908# ifdef PERL_HASH_FUNC_ONE_AT_A_TIME
1909 " PERL_HASH_FUNC_ONE_AT_A_TIME"
1910# endif
1911# ifdef PERL_HASH_FUNC_ONE_AT_A_TIME_HARD
1912 " PERL_HASH_FUNC_ONE_AT_A_TIME_HARD"
1913# endif
1914# ifdef PERL_HASH_FUNC_ONE_AT_A_TIME_OLD
1915 " PERL_HASH_FUNC_ONE_AT_A_TIME_OLD"
1916# endif
4a5df386
NC
1917# ifdef PERL_IS_MINIPERL
1918 " PERL_IS_MINIPERL"
1919# endif
1920# ifdef PERL_MALLOC_WRAP
1921 " PERL_MALLOC_WRAP"
1922# endif
1923# ifdef PERL_MEM_LOG
1924 " PERL_MEM_LOG"
1925# endif
1926# ifdef PERL_MEM_LOG_NOIMPL
1927 " PERL_MEM_LOG_NOIMPL"
1928# endif
4e499636
DM
1929# ifdef PERL_OP_PARENT
1930 " PERL_OP_PARENT"
1931# endif
59b86f4b
DM
1932# ifdef PERL_PERTURB_KEYS_DETERMINISTIC
1933 " PERL_PERTURB_KEYS_DETERMINISTIC"
1934# endif
1935# ifdef PERL_PERTURB_KEYS_DISABLED
1936 " PERL_PERTURB_KEYS_DISABLED"
1937# endif
1938# ifdef PERL_PERTURB_KEYS_RANDOM
1939 " PERL_PERTURB_KEYS_RANDOM"
1940# endif
c3cf41ec
NC
1941# ifdef PERL_PRESERVE_IVUV
1942 " PERL_PRESERVE_IVUV"
1943# endif
c051e30b
NC
1944# ifdef PERL_RELOCATABLE_INCPUSH
1945 " PERL_RELOCATABLE_INCPUSH"
1946# endif
4a5df386
NC
1947# ifdef PERL_USE_DEVEL
1948 " PERL_USE_DEVEL"
1949# endif
1950# ifdef PERL_USE_SAFE_PUTENV
1951 " PERL_USE_SAFE_PUTENV"
1952# endif
102b7877 1953# ifdef SILENT_NO_TAINT_SUPPORT
81f816b3 1954 " SILENT_NO_TAINT_SUPPORT"
102b7877 1955# endif
a3749cf3
NC
1956# ifdef UNLINK_ALL_VERSIONS
1957 " UNLINK_ALL_VERSIONS"
1958# endif
de618ee4
NC
1959# ifdef USE_ATTRIBUTES_FOR_PERLIO
1960 " USE_ATTRIBUTES_FOR_PERLIO"
1961# endif
4a5df386
NC
1962# ifdef USE_FAST_STDIO
1963 " USE_FAST_STDIO"
1964# endif
98548bdf
NC
1965# ifdef USE_LOCALE
1966 " USE_LOCALE"
1967# endif
98548bdf
NC
1968# ifdef USE_LOCALE_CTYPE
1969 " USE_LOCALE_CTYPE"
1970# endif
6937817d
DD
1971# ifdef WIN32_NO_REGISTRY
1972 " USE_NO_REGISTRY"
1973# endif
5a8d8935
NC
1974# ifdef USE_PERL_ATOF
1975 " USE_PERL_ATOF"
1976# endif
0d311fbe
NC
1977# ifdef USE_SITECUSTOMIZE
1978 " USE_SITECUSTOMIZE"
1979# endif
25a72d73
KW
1980# ifdef USE_THREAD_SAFE_LOCALE
1981 " USE_THREAD_SAFE_LOCALE"
1982# endif
4a5df386
NC
1983 ;
1984 PERL_UNUSED_ARG(cv);
d3db1514 1985 PERL_UNUSED_VAR(items);
4a5df386
NC
1986
1987 EXTEND(SP, entries);
1988
1989 PUSHs(sv_2mortal(newSVpv(PL_bincompat_options, 0)));
1990 PUSHs(Perl_newSVpvn_flags(aTHX_ non_bincompat_options,
1991 sizeof(non_bincompat_options) - 1, SVs_TEMP));
1992
6baa8dbd
NT
1993#ifndef PERL_BUILD_DATE
1994# ifdef __DATE__
1995# ifdef __TIME__
1996# define PERL_BUILD_DATE __DATE__ " " __TIME__
1997# else
1998# define PERL_BUILD_DATE __DATE__
1999# endif
2000# endif
2001#endif
2002
2003#ifdef PERL_BUILD_DATE
4a5df386 2004 PUSHs(Perl_newSVpvn_flags(aTHX_
6baa8dbd 2005 STR_WITH_LEN("Compiled at " PERL_BUILD_DATE),
4a5df386 2006 SVs_TEMP));
4a5df386
NC
2007#else
2008 PUSHs(&PL_sv_undef);
2009#endif
2010
4a5df386
NC
2011 for (i = 1; i <= local_patch_count; i++) {
2012 /* This will be an undef, if PL_localpatches[i] is NULL. */
2013 PUSHs(sv_2mortal(newSVpv(PL_localpatches[i], 0)));
2014 }
2015
2016 XSRETURN(entries);
2017}
2018
be71fc8f
NC
2019#define INCPUSH_UNSHIFT 0x01
2020#define INCPUSH_ADD_OLD_VERS 0x02
2021#define INCPUSH_ADD_VERSIONED_SUB_DIRS 0x04
2022#define INCPUSH_ADD_ARCHONLY_SUB_DIRS 0x08
2023#define INCPUSH_NOT_BASEDIR 0x10
2024#define INCPUSH_CAN_RELOCATE 0x20
1e3208d8
NC
2025#define INCPUSH_ADD_SUB_DIRS \
2026 (INCPUSH_ADD_VERSIONED_SUB_DIRS|INCPUSH_ADD_ARCHONLY_SUB_DIRS)
e28f3139 2027
312caa8e 2028STATIC void *
14dd3ad8 2029S_parse_body(pTHX_ char **env, XSINIT_t xsinit)
312caa8e 2030{
27da23d5 2031 dVAR;
2f9285f8 2032 PerlIO *rsfp;
312caa8e 2033 int argc = PL_origargc;
8f42b153 2034 char **argv = PL_origargv;
e1ec3a88 2035 const char *scriptname = NULL;
402582ca 2036 bool dosearch = FALSE;
eb578fdb 2037 char c;
737c24fc 2038 bool doextract = FALSE;
bd61b366 2039 const char *cddir = NULL;
ab019eaa 2040#ifdef USE_SITECUSTOMIZE
20ef40cf 2041 bool minus_f = FALSE;
ab019eaa 2042#endif
95670bde 2043 SV *linestr_sv = NULL;
5486870f 2044 bool add_read_e_script = FALSE;
87606032 2045 U32 lex_start_flags = 0;
009d90df 2046
ca7b837b 2047 PERL_SET_PHASE(PERL_PHASE_START);
9ebf26ad 2048
6224f72b 2049 init_main_stash();
54310121 2050
c7030b81
NC
2051 {
2052 const char *s;
6224f72b
GS
2053 for (argc--,argv++; argc > 0; argc--,argv++) {
2054 if (argv[0][0] != '-' || !argv[0][1])
2055 break;
6224f72b
GS
2056 s = argv[0]+1;
2057 reswitch:
47f56822 2058 switch ((c = *s)) {
729a02f2 2059 case 'C':
1d5472a9
GS
2060#ifndef PERL_STRICT_CR
2061 case '\r':
2062#endif
6224f72b
GS
2063 case ' ':
2064 case '0':
2065 case 'F':
2066 case 'a':
2067 case 'c':
2068 case 'd':
2069 case 'D':
2070 case 'h':
2071 case 'i':
2072 case 'l':
2073 case 'M':
2074 case 'm':
2075 case 'n':
2076 case 'p':
2077 case 's':
2078 case 'u':
2079 case 'U':
2080 case 'v':
599cee73
PM
2081 case 'W':
2082 case 'X':
6224f72b 2083 case 'w':
97bd5664 2084 if ((s = moreswitches(s)))
6224f72b
GS
2085 goto reswitch;
2086 break;
33b78306 2087
1dbad523 2088 case 't':
dc6d7f5c 2089#if defined(SILENT_NO_TAINT_SUPPORT)
284167a5 2090 /* silently ignore */
dc6d7f5c 2091#elif defined(NO_TAINT_SUPPORT)
3231f579 2092 Perl_croak_nocontext("This perl was compiled without taint support. "
284167a5
SM
2093 "Cowardly refusing to run with -t or -T flags");
2094#else
22f7c9c9 2095 CHECK_MALLOC_TOO_LATE_FOR('t');
284167a5
SM
2096 if( !TAINTING_get ) {
2097 TAINT_WARN_set(TRUE);
2098 TAINTING_set(TRUE);
317ea90d 2099 }
284167a5 2100#endif
317ea90d
MS
2101 s++;
2102 goto reswitch;
6224f72b 2103 case 'T':
dc6d7f5c 2104#if defined(SILENT_NO_TAINT_SUPPORT)
284167a5 2105 /* silently ignore */
dc6d7f5c 2106#elif defined(NO_TAINT_SUPPORT)
3231f579 2107 Perl_croak_nocontext("This perl was compiled without taint support. "
284167a5
SM
2108 "Cowardly refusing to run with -t or -T flags");
2109#else
22f7c9c9 2110 CHECK_MALLOC_TOO_LATE_FOR('T');
284167a5
SM
2111 TAINTING_set(TRUE);
2112 TAINT_WARN_set(FALSE);
2113#endif
6224f72b
GS
2114 s++;
2115 goto reswitch;
f86702cc 2116
bc9b29db
RH
2117 case 'E':
2118 PL_minus_E = TRUE;
924ba076 2119 /* FALLTHROUGH */
6224f72b 2120 case 'e':
f20b2998 2121 forbid_setid('e', FALSE);
3280af22 2122 if (!PL_e_script) {
396482e1 2123 PL_e_script = newSVpvs("");
5486870f 2124 add_read_e_script = TRUE;
6224f72b
GS
2125 }
2126 if (*++s)
3280af22 2127 sv_catpv(PL_e_script, s);
6224f72b 2128 else if (argv[1]) {
3280af22 2129 sv_catpv(PL_e_script, argv[1]);
6224f72b
GS
2130 argc--,argv++;
2131 }
2132 else
47f56822 2133 Perl_croak(aTHX_ "No code specified for -%c", c);
396482e1 2134 sv_catpvs(PL_e_script, "\n");
6224f72b 2135 break;
afe37c7d 2136
20ef40cf 2137 case 'f':
f5542d3a 2138#ifdef USE_SITECUSTOMIZE
20ef40cf 2139 minus_f = TRUE;
f5542d3a 2140#endif
20ef40cf
GA
2141 s++;
2142 goto reswitch;
2143
6224f72b 2144 case 'I': /* -I handled both here and in moreswitches() */
f20b2998 2145 forbid_setid('I', FALSE);
bd61b366 2146 if (!*++s && (s=argv[1]) != NULL) {
6224f72b
GS
2147 argc--,argv++;
2148 }
6224f72b 2149 if (s && *s) {
0df16ed7 2150 STRLEN len = strlen(s);
55b4bc1c 2151 incpush(s, len, INCPUSH_ADD_SUB_DIRS|INCPUSH_ADD_OLD_VERS);
0df16ed7
GS
2152 }
2153 else
a67e862a 2154 Perl_croak(aTHX_ "No directory specified for -I");
6224f72b 2155 break;
6224f72b 2156 case 'S':
f20b2998 2157 forbid_setid('S', FALSE);
6224f72b
GS
2158 dosearch = TRUE;
2159 s++;
2160 goto reswitch;
2161 case 'V':
7edfd0ef
NC
2162 {
2163 SV *opts_prog;
2164
7edfd0ef 2165 if (*++s != ':') {
37ca4a5b 2166 opts_prog = newSVpvs("use Config; Config::_V()");
7edfd0ef
NC
2167 }
2168 else {
2169 ++s;
2170 opts_prog = Perl_newSVpvf(aTHX_
37ca4a5b 2171 "use Config; Config::config_vars(qw%c%s%c)",
7edfd0ef
NC
2172 0, s, 0);
2173 s += strlen(s);
2174 }
37ca4a5b 2175 Perl_av_create_and_push(aTHX_ &PL_preambleav, opts_prog);
7edfd0ef
NC
2176 /* don't look for script or read stdin */
2177 scriptname = BIT_BUCKET;
2178 goto reswitch;
6224f72b 2179 }
6224f72b 2180 case 'x':
737c24fc 2181 doextract = TRUE;
6224f72b 2182 s++;
304334da 2183 if (*s)
f4c556ac 2184 cddir = s;
6224f72b
GS
2185 break;
2186 case 0:
2187 break;
2188 case '-':
2189 if (!*++s || isSPACE(*s)) {
2190 argc--,argv++;
2191 goto switch_end;
2192 }
ee8bc8b7
NC
2193 /* catch use of gnu style long options.
2194 Both of these exit immediately. */
2195 if (strEQ(s, "version"))
2196 minus_v();
2197 if (strEQ(s, "help"))
2198 usage();
6224f72b 2199 s--;
924ba076 2200 /* FALLTHROUGH */
6224f72b 2201 default:
cea2e8a9 2202 Perl_croak(aTHX_ "Unrecognized switch: -%s (-h will show valid options)",s);
8d063cd8
LW
2203 }
2204 }
c7030b81
NC
2205 }
2206
6224f72b 2207 switch_end:
54310121 2208
c7030b81
NC
2209 {
2210 char *s;
2211
f675dbe5
CB
2212 if (
2213#ifndef SECURE_INTERNAL_GETENV
284167a5 2214 !TAINTING_get &&
f675dbe5 2215#endif
cf756827 2216 (s = PerlEnv_getenv("PERL5OPT")))
0df16ed7 2217 {
9e0b0d62
KW
2218 /* s points to static memory in getenv(), which may be overwritten at
2219 * any time; use a mortal copy instead */
2220 s = SvPVX(sv_2mortal(newSVpv(s, 0)));
2221
74288ac8
GS
2222 while (isSPACE(*s))
2223 s++;
317ea90d 2224 if (*s == '-' && *(s+1) == 'T') {
dc6d7f5c 2225#if defined(SILENT_NO_TAINT_SUPPORT)
284167a5 2226 /* silently ignore */
dc6d7f5c 2227#elif defined(NO_TAINT_SUPPORT)
3231f579 2228 Perl_croak_nocontext("This perl was compiled without taint support. "
284167a5
SM
2229 "Cowardly refusing to run with -t or -T flags");
2230#else
22f7c9c9 2231 CHECK_MALLOC_TOO_LATE_FOR('T');
284167a5
SM
2232 TAINTING_set(TRUE);
2233 TAINT_WARN_set(FALSE);
2234#endif
317ea90d 2235 }
74288ac8 2236 else {
bd61b366 2237 char *popt_copy = NULL;
74288ac8 2238 while (s && *s) {
54913509 2239 const char *d;
74288ac8
GS
2240 while (isSPACE(*s))
2241 s++;
2242 if (*s == '-') {
2243 s++;
2244 if (isSPACE(*s))
2245 continue;
2246 }
4ea8f8fb 2247 d = s;
74288ac8
GS
2248 if (!*s)
2249 break;
2b622f1a 2250 if (!strchr("CDIMUdmtwW", *s))
cea2e8a9 2251 Perl_croak(aTHX_ "Illegal switch in PERL5OPT: -%c", *s);
4ea8f8fb
MS
2252 while (++s && *s) {
2253 if (isSPACE(*s)) {
cf756827 2254 if (!popt_copy) {
bfa6c418
NC
2255 popt_copy = SvPVX(sv_2mortal(newSVpv(d,0)));
2256 s = popt_copy + (s - d);
2257 d = popt_copy;
cf756827 2258 }
4ea8f8fb
MS
2259 *s++ = '\0';
2260 break;
2261 }
2262 }
1c4db469 2263 if (*d == 't') {
dc6d7f5c 2264#if defined(SILENT_NO_TAINT_SUPPORT)
284167a5 2265 /* silently ignore */
dc6d7f5c 2266#elif defined(NO_TAINT_SUPPORT)
3231f579 2267 Perl_croak_nocontext("This perl was compiled without taint support. "
284167a5
SM
2268 "Cowardly refusing to run with -t or -T flags");
2269#else
2270 if( !TAINTING_get) {
2271 TAINT_WARN_set(TRUE);
2272 TAINTING_set(TRUE);
317ea90d 2273 }
284167a5 2274#endif
1c4db469 2275 } else {
97bd5664 2276 moreswitches(d);
1c4db469 2277 }
6224f72b 2278 }
6224f72b
GS
2279 }
2280 }
c7030b81 2281 }
a0d0e21e 2282
d6295071
TC
2283#ifndef NO_PERL_INTERNAL_RAND_SEED
2284 /* If we're not set[ug]id, we might have honored
2285 PERL_INTERNAL_RAND_SEED in perl_construct().
2286 At this point command-line options have been parsed, so if
2287 we're now tainting and not set[ug]id re-seed.
2288 This could possibly be wasteful if PERL_INTERNAL_RAND_SEED is invalid,
2289 but avoids duplicating the logic from perl_construct().
2290 */
3337f21a 2291 if (TAINT_get &&
d6295071
TC
2292 PerlProc_getuid() == PerlProc_geteuid() &&
2293 PerlProc_getgid() == PerlProc_getegid()) {
2294 Perl_drand48_init_r(&PL_internal_random_state, seed());
2295 }
2296#endif
2297
c29067d7
CH
2298 /* Set $^X early so that it can be used for relocatable paths in @INC */
2299 /* and for SITELIB_EXP in USE_SITECUSTOMIZE */
284167a5 2300 assert (!TAINT_get);
c29067d7 2301 TAINT;
e2051532 2302 set_caret_X();
c29067d7
CH
2303 TAINT_NOT;
2304
43c0c913 2305#if defined(USE_SITECUSTOMIZE)
20ef40cf 2306 if (!minus_f) {
43c0c913 2307 /* The games with local $! are to avoid setting errno if there is no
fc81b718
NC
2308 sitecustomize script. "q%c...%c", 0, ..., 0 becomes "q\0...\0",
2309 ie a q() operator with a NUL byte as a the delimiter. This avoids
2310 problems with pathnames containing (say) ' */
43c0c913
NC
2311# ifdef PERL_IS_MINIPERL
2312 AV *const inc = GvAV(PL_incgv);
2313 SV **const inc0 = inc ? av_fetch(inc, 0, FALSE) : NULL;
2314
2315 if (inc0) {
15870c5c
NC
2316 /* if lib/buildcustomize.pl exists, it should not fail. If it does,
2317 it should be reported immediately as a build failure. */
43c0c913
NC
2318 (void)Perl_av_create_and_unshift_one(aTHX_ &PL_preambleav,
2319 Perl_newSVpvf(aTHX_
147e3846 2320 "BEGIN { my $f = q%c%s%" SVf "/buildcustomize.pl%c; "
af26e4f2
FC
2321 "do {local $!; -f $f }"
2322 " and do $f || die $@ || qq '$f: $!' }",
5de87db5 2323 0, (TAINTING_get ? "./" : ""), SVfARG(*inc0), 0));
43c0c913
NC
2324 }
2325# else
2326 /* SITELIB_EXP is a function call on Win32. */
c29067d7 2327 const char *const raw_sitelib = SITELIB_EXP;
bac5c4fc
JD
2328 if (raw_sitelib) {
2329 /* process .../.. if PERL_RELOCATABLE_INC is defined */
2330 SV *sitelib_sv = mayberelocate(raw_sitelib, strlen(raw_sitelib),
2331 INCPUSH_CAN_RELOCATE);
2332 const char *const sitelib = SvPVX(sitelib_sv);
2333 (void)Perl_av_create_and_unshift_one(aTHX_ &PL_preambleav,
2334 Perl_newSVpvf(aTHX_
2335 "BEGIN { do {local $!; -f q%c%s/sitecustomize.pl%c} && do q%c%s/sitecustomize.pl%c }",
c1f6cd39
BF
2336 0, SVfARG(sitelib), 0,
2337 0, SVfARG(sitelib), 0));
bac5c4fc
JD
2338 assert (SvREFCNT(sitelib_sv) == 1);
2339 SvREFCNT_dec(sitelib_sv);
2340 }
43c0c913 2341# endif
20ef40cf
GA
2342 }
2343#endif
2344
6224f72b
GS
2345 if (!scriptname)
2346 scriptname = argv[0];
3280af22 2347 if (PL_e_script) {
6224f72b
GS
2348 argc++,argv--;
2349 scriptname = BIT_BUCKET; /* don't look for script or read stdin */
2350 }
bd61b366 2351 else if (scriptname == NULL) {
6224f72b
GS
2352#ifdef MSDOS
2353 if ( PerlLIO_isatty(PerlIO_fileno(PerlIO_stdin())) )
97bd5664 2354 moreswitches("h");
6224f72b
GS
2355#endif
2356 scriptname = "-";
2357 }
2358
284167a5 2359 assert (!TAINT_get);
2cace6ac 2360 init_perllib();
6224f72b 2361
a52eba0e 2362 {
f20b2998 2363 bool suidscript = FALSE;
829372d3 2364
8d113837 2365 rsfp = open_script(scriptname, dosearch, &suidscript);
c0b3891a
NC
2366 if (!rsfp) {
2367 rsfp = PerlIO_stdin();
87606032 2368 lex_start_flags = LEX_DONT_CLOSE_RSFP;
c0b3891a 2369 }
6224f72b 2370
b24bc095 2371 validate_suid(rsfp);
6224f72b 2372
64ca3a65 2373#ifndef PERL_MICRO
a52eba0e
NC
2374# if defined(SIGCHLD) || defined(SIGCLD)
2375 {
2376# ifndef SIGCHLD
2377# define SIGCHLD SIGCLD
2378# endif
2379 Sighandler_t sigstate = rsignal_state(SIGCHLD);
2380 if (sigstate == (Sighandler_t) SIG_IGN) {
a2a5de95
NC
2381 Perl_ck_warner(aTHX_ packWARN(WARN_SIGNAL),
2382 "Can't ignore signal CHLD, forcing to default");
a52eba0e
NC
2383 (void)rsignal(SIGCHLD, (Sighandler_t)SIG_DFL);
2384 }
0b5b802d 2385 }
a52eba0e 2386# endif
64ca3a65 2387#endif
0b5b802d 2388
737c24fc 2389 if (doextract) {
faef540c 2390
f20b2998 2391 /* This will croak if suidscript is true, as -x cannot be used with
faef540c
NC
2392 setuid scripts. */
2393 forbid_setid('x', suidscript);
f20b2998 2394 /* Hence you can't get here if suidscript is true */
faef540c 2395
95670bde
NC
2396 linestr_sv = newSV_type(SVt_PV);
2397 lex_start_flags |= LEX_START_COPIED;
2f9285f8 2398 find_beginning(linestr_sv, rsfp);
a52eba0e
NC
2399 if (cddir && PerlDir_chdir( (char *)cddir ) < 0)
2400 Perl_croak(aTHX_ "Can't chdir to %s",cddir);
2401 }
f4c556ac 2402 }
6224f72b 2403
ea726b52 2404 PL_main_cv = PL_compcv = MUTABLE_CV(newSV_type(SVt_PVCV));
3280af22
NIS
2405 CvUNIQUE_on(PL_compcv);
2406
eacbb379 2407 CvPADLIST_set(PL_compcv, pad_new(0));
6224f72b 2408
dd69841b
BB
2409 PL_isarev = newHV();
2410
0c4f7ff0 2411 boot_core_PerlIO();
6224f72b 2412 boot_core_UNIVERSAL();
e1a479c5 2413 boot_core_mro();
4a5df386 2414 newXS("Internals::V", S_Internals_V, __FILE__);
6224f72b
GS
2415
2416 if (xsinit)
acfe0abc 2417 (*xsinit)(aTHX); /* in case linked C routines want magical variables */
64ca3a65 2418#ifndef PERL_MICRO
739a0b84 2419#if defined(VMS) || defined(WIN32) || defined(DJGPP) || defined(__CYGWIN__) || defined(SYMBIAN)
c5be433b 2420 init_os_extras();
6224f72b 2421#endif
64ca3a65 2422#endif
6224f72b 2423
29209bc5 2424#ifdef USE_SOCKS
1b9c9cf5
DH
2425# ifdef HAS_SOCKS5_INIT
2426 socks5_init(argv[0]);
2427# else
29209bc5 2428 SOCKSinit(argv[0]);
1b9c9cf5 2429# endif
ac27b0f5 2430#endif
29209bc5 2431
6224f72b
GS
2432 init_predump_symbols();
2433 /* init_postdump_symbols not currently designed to be called */
2434 /* more than once (ENV isn't cleared first, for example) */
2435 /* But running with -u leaves %ENV & @ARGV undefined! XXX */
3280af22 2436 if (!PL_do_undump)
6224f72b
GS
2437 init_postdump_symbols(argc,argv,env);
2438
27da23d5
JH
2439 /* PL_unicode is turned on by -C, or by $ENV{PERL_UNICODE},
2440 * or explicitly in some platforms.
73e1bd1a 2441 * PL_utf8locale is conditionally turned on by
085a54d9 2442 * locale.c:Perl_init_i18nl10n() if the environment
a05d7ebb 2443 * look like the user wants to use UTF-8. */
a0fd4948 2444#if defined(__SYMBIAN32__)
27da23d5
JH
2445 PL_unicode = PERL_UNICODE_STD_FLAG; /* See PERL_SYMBIAN_CONSOLE_UTF8. */
2446#endif
e27b5b51 2447# ifndef PERL_IS_MINIPERL
06e66572
JH
2448 if (PL_unicode) {
2449 /* Requires init_predump_symbols(). */
a05d7ebb 2450 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
06e66572
JH
2451 IO* io;
2452 PerlIO* fp;
2453 SV* sv;
2454
a05d7ebb 2455 /* Turn on UTF-8-ness on STDIN, STDOUT, STDERR
06e66572 2456 * and the default open disciplines. */
a05d7ebb
JH
2457 if ((PL_unicode & PERL_UNICODE_STDIN_FLAG) &&
2458 PL_stdingv && (io = GvIO(PL_stdingv)) &&
2459 (fp = IoIFP(io)))
2460 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2461 if ((PL_unicode & PERL_UNICODE_STDOUT_FLAG) &&
2462 PL_defoutgv && (io = GvIO(PL_defoutgv)) &&
2463 (fp = IoOFP(io)))
2464 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2465 if ((PL_unicode & PERL_UNICODE_STDERR_FLAG) &&
2466 PL_stderrgv && (io = GvIO(PL_stderrgv)) &&
2467 (fp = IoOFP(io)))
2468 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2469 if ((PL_unicode & PERL_UNICODE_INOUT_FLAG) &&
fafc274c
NC
2470 (sv = GvSV(gv_fetchpvs("\017PEN", GV_ADD|GV_NOTQUAL,
2471 SVt_PV)))) {
a05d7ebb
JH
2472 U32 in = PL_unicode & PERL_UNICODE_IN_FLAG;
2473 U32 out = PL_unicode & PERL_UNICODE_OUT_FLAG;
2474 if (in) {
2475 if (out)
76f68e9b 2476 sv_setpvs(sv, ":utf8\0:utf8");
a05d7ebb 2477 else
76f68e9b 2478 sv_setpvs(sv, ":utf8\0");
a05d7ebb
JH
2479 }
2480 else if (out)
76f68e9b 2481 sv_setpvs(sv, "\0:utf8");
a05d7ebb
JH
2482 SvSETMAGIC(sv);
2483 }
b310b053
JH
2484 }
2485 }
e27b5b51 2486#endif
b310b053 2487
c7030b81
NC
2488 {
2489 const char *s;
4ffa73a3
JH
2490 if ((s = PerlEnv_getenv("PERL_SIGNALS"))) {
2491 if (strEQ(s, "unsafe"))
2492 PL_signals |= PERL_SIGNALS_UNSAFE_FLAG;
2493 else if (strEQ(s, "safe"))
2494 PL_signals &= ~PERL_SIGNALS_UNSAFE_FLAG;
2495 else
2496 Perl_croak(aTHX_ "PERL_SIGNALS illegal: \"%s\"", s);
2497 }
c7030b81 2498 }
4ffa73a3 2499
81d86705 2500
87606032 2501 lex_start(linestr_sv, rsfp, lex_start_flags);
d2687c98 2502 SvREFCNT_dec(linestr_sv);
95670bde 2503
219f7226 2504 PL_subname = newSVpvs("main");
6224f72b 2505
5486870f
DM
2506 if (add_read_e_script)
2507 filter_add(read_e_script, NULL);
2508
6224f72b
GS
2509 /* now parse the script */
2510
93189314 2511 SETERRNO(0,SS_NORMAL);
28ac2b49 2512 if (yyparse(GRAMPROG) || PL_parser->error_count) {
c77da5ff 2513 abort_execution("", PL_origfilename);
6224f72b 2514 }
57843af0 2515 CopLINE_set(PL_curcop, 0);
03d9f026 2516 SET_CURSTASH(PL_defstash);
3280af22
NIS
2517 if (PL_e_script) {
2518 SvREFCNT_dec(PL_e_script);
a0714e2c 2519 PL_e_script = NULL;
6224f72b
GS
2520 }
2521
3280af22 2522 if (PL_do_undump)
6224f72b
GS
2523 my_unexec();
2524
57843af0
GS
2525 if (isWARN_ONCE) {
2526 SAVECOPFILE(PL_curcop);
2527 SAVECOPLINE(PL_curcop);
3280af22 2528 gv_check(PL_defstash);
57843af0 2529 }
6224f72b
GS
2530
2531 LEAVE;
2532 FREETMPS;
2533
2534#ifdef MYMALLOC
f6a607bc
RGS
2535 {
2536 const char *s;
22ff3130
HS
2537 UV uv;
2538 s = PerlEnv_getenv("PERL_DEBUG_MSTATS");
2539 if (s && grok_atoUV(s, &uv, NULL) && uv >= 2)
96e440d2 2540 dump_mstats("after compilation:");
f6a607bc 2541 }
6224f72b
GS
2542#endif
2543
2544 ENTER;
febb3a6d 2545 PL_restartjmpenv = NULL;
3280af22 2546 PL_restartop = 0;
312caa8e 2547 return NULL;
6224f72b
GS
2548}
2549
954c1994 2550/*
0301e899
Z
2551=for apidoc Am|int|perl_run|PerlInterpreter *my_perl
2552
2553Tells a Perl interpreter to run its main program. See L<perlembed>
2554for a tutorial.
2555
2556C<my_perl> points to the Perl interpreter. It must have been previously
2557created through the use of L</perl_alloc> and L</perl_construct>, and
2558initialised through L</perl_parse>. This function should not be called
2559if L</perl_parse> returned a non-zero value, indicating a failure in
2560initialisation or compilation.
2561
2562This function executes code in C<INIT> blocks, and then executes the
2563main program. The code to be executed is that established by the prior
2564call to L</perl_parse>. If the interpreter's C<PL_exit_flags> word
2565does not have the C<PERL_EXIT_DESTRUCT_END> flag set, then this function
2566will also execute code in C<END> blocks. If it is desired to make any
2567further use of the interpreter after calling this function, then C<END>
2568blocks should be postponed to L</perl_destruct> time by setting that flag.
2569
2570Returns an integer of slightly tricky interpretation. The correct use
2571of the return value is as a truth value indicating whether the program
2572terminated non-locally. If zero is returned, this indicates that
2573the program ran to completion, and it is safe to make other use of the
2574interpreter (provided that the C<PERL_EXIT_DESTRUCT_END> flag was set as
2575described above). If a non-zero value is returned, this indicates that
2576the interpreter wants to terminate early. The interpreter should not be
2577just abandoned because of this desire to terminate; the caller should
2578proceed to shut the interpreter down cleanly with L</perl_destruct>
2579and free it with L</perl_free>.
2580
2581For historical reasons, the non-zero return value also attempts to
2582be a suitable value to pass to the C library function C<exit> (or to
2583return from C<main>), to serve as an exit code indicating the nature of
2584the way the program terminated. However, this isn't portable, due to
2585differing exit code conventions. An attempt is made to return an exit
2586code of the type required by the host operating system, but because
2587it is constrained to be non-zero, it is not necessarily possible to
2588indicate every type of exit. It is only reliable on Unix, where a zero
2589exit code can be augmented with a set bit that will be ignored. In any
2590case, this function is not the correct place to acquire an exit code:
2591one should get that from L</perl_destruct>.
954c1994
GS
2592
2593=cut
2594*/
2595
6224f72b 2596int
0cb96387 2597perl_run(pTHXx)
6224f72b 2598{
6224f72b 2599 I32 oldscope;
9f960638 2600 int ret = 0;
db36c5a1 2601 dJMPENV;
6224f72b 2602
7918f24d
NC
2603 PERL_ARGS_ASSERT_PERL_RUN;
2604#ifndef MULTIPLICITY
ed6c66dd 2605 PERL_UNUSED_ARG(my_perl);
7918f24d 2606#endif
9d4ba2ae 2607
3280af22 2608 oldscope = PL_scopestack_ix;
96e176bf
CL
2609#ifdef VMS
2610 VMSISH_HUSHED = 0;
2611#endif
6224f72b 2612
14dd3ad8 2613 JMPENV_PUSH(ret);
6224f72b
GS
2614 switch (ret) {
2615 case 1:
2616 cxstack_ix = -1; /* start context stack again */
312caa8e 2617 goto redo_body;
14dd3ad8 2618 case 0: /* normal completion */
14dd3ad8
GS
2619 redo_body:
2620 run_body(oldscope);
9f960638 2621 /* FALLTHROUGH */
14dd3ad8 2622 case 2: /* my_exit() */
3280af22 2623 while (PL_scopestack_ix > oldscope)
6224f72b
GS
2624 LEAVE;
2625 FREETMPS;
03d9f026 2626 SET_CURSTASH(PL_defstash);
3a1ee7e8 2627 if (!(PL_exit_flags & PERL_EXIT_DESTRUCT_END) &&
9ebf26ad 2628 PL_endav && !PL_minus_c) {
ca7b837b 2629 PERL_SET_PHASE(PERL_PHASE_END);
31d77e54 2630 call_list(oldscope, PL_endav);
9ebf26ad 2631 }
6224f72b
GS
2632#ifdef MYMALLOC
2633 if (PerlEnv_getenv("PERL_DEBUG_MSTATS"))
2634 dump_mstats("after execution: ");
2635#endif
9f960638 2636 ret = STATUS_EXIT;
14dd3ad8 2637 break;
6224f72b 2638 case 3:
312caa8e
CS
2639 if (PL_restartop) {
2640 POPSTACK_TO(PL_mainstack);
2641 goto redo_body;
6224f72b 2642 }
5637ef5b 2643 PerlIO_printf(Perl_error_log, "panic: restartop in perl_run\n");
312caa8e 2644 FREETMPS;
14dd3ad8
GS
2645 ret = 1;
2646 break;
6224f72b
GS
2647 }
2648
14dd3ad8
GS
2649 JMPENV_POP;
2650 return ret;
312caa8e
CS
2651}
2652
dd374669 2653STATIC void
14dd3ad8
GS
2654S_run_body(pTHX_ I32 oldscope)
2655{
d3b97530
DM
2656 DEBUG_r(PerlIO_printf(Perl_debug_log, "%s $` $& $' support (0x%x).\n",
2657 PL_sawampersand ? "Enabling" : "Omitting",
2658 (unsigned int)(PL_sawampersand)));
6224f72b 2659
3280af22 2660 if (!PL_restartop) {
cf2782cd 2661#ifdef DEBUGGING
f0e3f042
CS
2662 if (DEBUG_x_TEST || DEBUG_B_TEST)
2663 dump_all_perl(!DEBUG_B_TEST);
ecae49c0
NC
2664 if (!DEBUG_q_TEST)
2665 PERL_DEBUG(PerlIO_printf(Perl_debug_log, "\nEXECUTING...\n\n"));
cf2782cd 2666#endif
6224f72b 2667
3280af22 2668 if (PL_minus_c) {
bf49b057 2669 PerlIO_printf(Perl_error_log, "%s syntax OK\n", PL_origfilename);
6224f72b
GS
2670 my_exit(0);
2671 }
3280af22 2672 if (PERLDB_SINGLE && PL_DBsingle)
a6d69523 2673 PL_DBsingle_iv = 1;
9ebf26ad 2674 if (PL_initav) {
ca7b837b 2675 PERL_SET_PHASE(PERL_PHASE_INIT);
3280af22 2676 call_list(oldscope, PL_initav);
9ebf26ad 2677 }
f1fac472 2678#ifdef PERL_DEBUG_READONLY_OPS
3107b51f
FC
2679 if (PL_main_root && PL_main_root->op_slabbed)
2680 Slab_to_ro(OpSLAB(PL_main_root));
f1fac472 2681#endif
6224f72b
GS
2682 }
2683
2684 /* do it */
2685
ca7b837b 2686 PERL_SET_PHASE(PERL_PHASE_RUN);
9ebf26ad 2687
3280af22 2688 if (PL_restartop) {
febb3a6d 2689 PL_restartjmpenv = NULL;
533c011a 2690 PL_op = PL_restartop;
3280af22 2691 PL_restartop = 0;
cea2e8a9 2692 CALLRUNOPS(aTHX);
6224f72b 2693 }
3280af22
NIS
2694 else if (PL_main_start) {
2695 CvDEPTH(PL_main_cv) = 1;
533c011a 2696 PL_op = PL_main_start;
cea2e8a9 2697 CALLRUNOPS(aTHX);
6224f72b 2698 }
f6b3007c 2699 my_exit(0);
e5964223 2700 NOT_REACHED; /* NOTREACHED */
6224f72b
GS
2701}
2702
954c1994 2703/*
ccfc67b7
JH
2704=head1 SV Manipulation Functions
2705
954c1994
GS
2706=for apidoc p||get_sv
2707
64ace3f8 2708Returns the SV of the specified Perl scalar. C<flags> are passed to
72d33970 2709C<gv_fetchpv>. If C<GV_ADD> is set and the
64ace3f8
NC
2710Perl variable does not exist then it will be created. If C<flags> is zero
2711and the variable does not exist then NULL is returned.
954c1994
GS
2712
2713=cut
2714*/
2715
6224f72b 2716SV*
64ace3f8 2717Perl_get_sv(pTHX_ const char *name, I32 flags)
6224f72b
GS
2718{
2719 GV *gv;
7918f24d
NC
2720
2721 PERL_ARGS_ASSERT_GET_SV;
2722
64ace3f8 2723 gv = gv_fetchpv(name, flags, SVt_PV);
6224f72b
GS
2724 if (gv)
2725 return GvSV(gv);
a0714e2c 2726 return NULL;
6224f72b
GS
2727}
2728
954c1994 2729/*
ccfc67b7
JH
2730=head1 Array Manipulation Functions
2731
954c1994
GS
2732=for apidoc p||get_av
2733
f0b90de1
SF
2734Returns the AV of the specified Perl global or package array with the given
2735name (so it won't work on lexical variables). C<flags> are passed
72d33970 2736to C<gv_fetchpv>. If C<GV_ADD> is set and the
cbfd0a87
NC
2737Perl variable does not exist then it will be created. If C<flags> is zero
2738and the variable does not exist then NULL is returned.
954c1994 2739
f0b90de1
SF
2740Perl equivalent: C<@{"$name"}>.
2741
954c1994
GS
2742=cut
2743*/
2744
6224f72b 2745AV*
cbfd0a87 2746Perl_get_av(pTHX_ const char *name, I32 flags)
6224f72b 2747{
cbfd0a87 2748 GV* const gv = gv_fetchpv(name, flags, SVt_PVAV);
7918f24d
NC
2749
2750 PERL_ARGS_ASSERT_GET_AV;
2751
cbfd0a87 2752 if (flags)
6224f72b
GS
2753 return GvAVn(gv);
2754 if (gv)
2755 return GvAV(gv);
7d49f689 2756 return NULL;
6224f72b
GS
2757}
2758
954c1994 2759/*
ccfc67b7
JH
2760=head1 Hash Manipulation Functions
2761
954c1994
GS
2762=for apidoc p||get_hv
2763
6673a63c 2764Returns the HV of the specified Perl hash. C<flags> are passed to
72d33970 2765C<gv_fetchpv>. If C<GV_ADD> is set and the
6673a63c 2766Perl variable does not exist then it will be created. If C<flags> is zero
796b6530 2767and the variable does not exist then C<NULL> is returned.
954c1994
GS
2768
2769=cut
2770*/
2771
6224f72b 2772HV*
6673a63c 2773Perl_get_hv(pTHX_ const char *name, I32 flags)
6224f72b 2774{
6673a63c 2775 GV* const gv = gv_fetchpv(name, flags, SVt_PVHV);
7918f24d
NC
2776
2777 PERL_ARGS_ASSERT_GET_HV;
2778
6673a63c 2779 if (flags)
a0d0e21e
LW
2780 return GvHVn(gv);
2781 if (gv)
2782 return GvHV(gv);
5c284bb0 2783 return NULL;
a0d0e21e
LW
2784}
2785
954c1994 2786/*
ccfc67b7
JH
2787=head1 CV Manipulation Functions
2788
780a5241
NC
2789=for apidoc p||get_cvn_flags
2790
2791Returns the CV of the specified Perl subroutine. C<flags> are passed to
72d33970 2792C<gv_fetchpvn_flags>. If C<GV_ADD> is set and the Perl subroutine does not
780a5241
NC
2793exist then it will be declared (which has the same effect as saying
2794C<sub name;>). If C<GV_ADD> is not set and the subroutine does not exist
2795then NULL is returned.
2796
954c1994
GS
2797=for apidoc p||get_cv
2798
780a5241 2799Uses C<strlen> to get the length of C<name>, then calls C<get_cvn_flags>.
954c1994
GS
2800
2801=cut
2802*/
2803
a0d0e21e 2804CV*
780a5241 2805Perl_get_cvn_flags(pTHX_ const char *name, STRLEN len, I32 flags)
a0d0e21e 2806{
780a5241 2807 GV* const gv = gv_fetchpvn_flags(name, len, flags, SVt_PVCV);
7918f24d
NC
2808
2809 PERL_ARGS_ASSERT_GET_CVN_FLAGS;
2810
a385812b 2811 if (gv && UNLIKELY(SvROK(gv)) && SvTYPE(SvRV((SV *)gv)) == SVt_PVCV)
e05a85b2 2812 return (CV*)SvRV((SV *)gv);
a385812b 2813
334dda80
FC
2814 /* XXX this is probably not what they think they're getting.
2815 * It has the same effect as "sub name;", i.e. just a forward
2816 * declaration! */
780a5241 2817 if ((flags & ~GV_NOADD_MASK) && !GvCVu(gv)) {
186a5ba8 2818 return newSTUB(gv,0);
780a5241 2819 }
a0d0e21e 2820 if (gv)
8ebc5c01 2821 return GvCVu(gv);
601f1833 2822 return NULL;
a0d0e21e
LW
2823}
2824
2c67934f
NC
2825/* Nothing in core calls this now, but we can't replace it with a macro and
2826 move it to mathoms.c as a macro would evaluate name twice. */
780a5241
NC
2827CV*
2828Perl_get_cv(pTHX_ const char *name, I32 flags)
2829{
7918f24d
NC
2830 PERL_ARGS_ASSERT_GET_CV;
2831
780a5241
NC
2832 return get_cvn_flags(name, strlen(name), flags);
2833}
2834
79072805
LW
2835/* Be sure to refetch the stack pointer after calling these routines. */
2836
954c1994 2837/*
ccfc67b7
JH
2838
2839=head1 Callback Functions
2840
954c1994
GS
2841=for apidoc p||call_argv
2842
f0b90de1 2843Performs a callback to the specified named and package-scoped Perl subroutine
796b6530 2844with C<argv> (a C<NULL>-terminated array of strings) as arguments. See
72d33970 2845L<perlcall>.
f0b90de1
SF
2846
2847Approximate Perl equivalent: C<&{"$sub_name"}(@$argv)>.
954c1994
GS
2848
2849=cut
2850*/
2851
a0d0e21e 2852I32
5aaab254 2853Perl_call_argv(pTHX_ const char *sub_name, I32 flags, char **argv)
ac27b0f5 2854
8ac85365
NIS
2855 /* See G_* flags in cop.h */
2856 /* null terminated arg list */
8990e307 2857{
a0d0e21e 2858 dSP;
8990e307 2859
7918f24d
NC
2860 PERL_ARGS_ASSERT_CALL_ARGV;
2861
924508f0 2862 PUSHMARK(SP);
3dc78631
DM
2863 while (*argv) {
2864 mXPUSHs(newSVpv(*argv,0));
2865 argv++;
8990e307 2866 }
3dc78631 2867 PUTBACK;
864dbfa3 2868 return call_pv(sub_name, flags);
8990e307
LW
2869}
2870
954c1994
GS
2871/*
2872=for apidoc p||call_pv
2873
2874Performs a callback to the specified Perl sub. See L<perlcall>.
2875
2876=cut
2877*/
2878
a0d0e21e 2879I32
864dbfa3 2880Perl_call_pv(pTHX_ const char *sub_name, I32 flags)
8ac85365
NIS
2881 /* name of the subroutine */
2882 /* See G_* flags in cop.h */
a0d0e21e 2883{
7918f24d
NC
2884 PERL_ARGS_ASSERT_CALL_PV;
2885
0da0e728 2886 return call_sv(MUTABLE_SV(get_cv(sub_name, GV_ADD)), flags);
a0d0e21e
LW
2887}
2888
954c1994
GS
2889/*
2890=for apidoc p||call_method
2891
2892Performs a callback to the specified Perl method. The blessed object must
2893be on the stack. See L<perlcall>.
2894
2895=cut
2896*/
2897
a0d0e21e 2898I32
864dbfa3 2899Perl_call_method(pTHX_ const char *methname, I32 flags)
8ac85365
NIS
2900 /* name of the subroutine */
2901 /* See G_* flags in cop.h */
a0d0e21e 2902{
46ca9bac 2903 STRLEN len;
c106c2be 2904 SV* sv;
7918f24d
NC
2905 PERL_ARGS_ASSERT_CALL_METHOD;
2906
46ca9bac 2907 len = strlen(methname);
c106c2be
RZ
2908 sv = flags & G_METHOD_NAMED
2909 ? sv_2mortal(newSVpvn_share(methname, len,0))
2910 : newSVpvn_flags(methname, len, SVs_TEMP);
46ca9bac 2911
c106c2be 2912 return call_sv(sv, flags | G_METHOD);
a0d0e21e
LW
2913}
2914
2915/* May be called with any of a CV, a GV, or an SV containing the name. */
954c1994
GS
2916/*
2917=for apidoc p||call_sv
2918
078e2213
TC
2919Performs a callback to the Perl sub specified by the SV.
2920
7c0c544c 2921If neither the C<G_METHOD> nor C<G_METHOD_NAMED> flag is supplied, the
078e2213
TC
2922SV may be any of a CV, a GV, a reference to a CV, a reference to a GV
2923or C<SvPV(sv)> will be used as the name of the sub to call.
2924
2925If the C<G_METHOD> flag is supplied, the SV may be a reference to a CV or
2926C<SvPV(sv)> will be used as the name of the method to call.
2927
2928If the C<G_METHOD_NAMED> flag is supplied, C<SvPV(sv)> will be used as
2929the name of the method to call.
2930
2931Some other values are treated specially for internal use and should
2932not be depended on.
2933
2934See L<perlcall>.
954c1994
GS
2935
2936=cut
2937*/
2938
a0d0e21e 2939I32
8162b70e 2940Perl_call_sv(pTHX_ SV *sv, volatile I32 flags)
8ac85365 2941 /* See G_* flags in cop.h */
a0d0e21e 2942{
5b434c73 2943 dVAR;
a0d0e21e 2944 LOGOP myop; /* fake syntax tree node */
b46e009d 2945 METHOP method_op;
aa689395 2946 I32 oldmark;
8162b70e 2947 volatile I32 retval = 0;
54310121 2948 bool oldcatch = CATCH_GET;
6224f72b 2949 int ret;
c4420975 2950 OP* const oldop = PL_op;
db36c5a1 2951 dJMPENV;
1e422769 2952
7918f24d
NC
2953 PERL_ARGS_ASSERT_CALL_SV;
2954
a0d0e21e
LW
2955 if (flags & G_DISCARD) {
2956 ENTER;
2957 SAVETMPS;
2958 }
2f8edad0
NC
2959 if (!(flags & G_WANT)) {
2960 /* Backwards compatibility - as G_SCALAR was 0, it could be omitted.
2961 */
2962 flags |= G_SCALAR;
2963 }
a0d0e21e 2964
aa689395 2965 Zero(&myop, 1, LOGOP);
f51d4af5 2966 if (!(flags & G_NOARGS))
aa689395 2967 myop.op_flags |= OPf_STACKED;
4f911530 2968 myop.op_flags |= OP_GIMME_REVERSE(flags);
462e5cf6 2969 SAVEOP();
533c011a 2970 PL_op = (OP*)&myop;
aa689395 2971
8c9009ad 2972 if (!(flags & G_METHOD_NAMED)) {
5b434c73
DD
2973 dSP;
2974 EXTEND(SP, 1);
8c9009ad
DD
2975 PUSHs(sv);
2976 PUTBACK;
5b434c73 2977 }
aa689395 2978 oldmark = TOPMARK;
a0d0e21e 2979
3280af22 2980 if (PERLDB_SUB && PL_curstash != PL_debstash
36477c24 2981 /* Handle first BEGIN of -d. */
3280af22 2982 && (PL_DBcv || (PL_DBcv = GvCV(PL_DBsub)))
36477c24
PP
2983 /* Try harder, since this may have been a sighandler, thus
2984 * curstash may be meaningless. */
ea726b52 2985 && (SvTYPE(sv) != SVt_PVCV || CvSTASH((const CV *)sv) != PL_debstash)
491527d0 2986 && !(flags & G_NODEBUG))
5ff48db8 2987 myop.op_private |= OPpENTERSUB_DB;
a0d0e21e 2988
c106c2be 2989 if (flags & (G_METHOD|G_METHOD_NAMED)) {
b46e009d 2990 Zero(&method_op, 1, METHOP);
2991 method_op.op_next = (OP*)&myop;
2992 PL_op = (OP*)&method_op;
c106c2be 2993 if ( flags & G_METHOD_NAMED ) {
b46e009d 2994 method_op.op_ppaddr = PL_ppaddr[OP_METHOD_NAMED];
2995 method_op.op_type = OP_METHOD_NAMED;
2996 method_op.op_u.op_meth_sv = sv;
c106c2be 2997 } else {
b46e009d 2998 method_op.op_ppaddr = PL_ppaddr[OP_METHOD];
2999 method_op.op_type = OP_METHOD;
c106c2be
RZ
3000 }
3001 myop.op_ppaddr = PL_ppaddr[OP_ENTERSUB];
3002 myop.op_type = OP_ENTERSUB;
968b3946
GS
3003 }
3004
312caa8e 3005 if (!(flags & G_EVAL)) {
0cdb2077 3006 CATCH_SET(TRUE);
d6f07c05 3007 CALL_BODY_SUB((OP*)&myop);
312caa8e 3008 retval = PL_stack_sp - (PL_stack_base + oldmark);
0253cb41 3009 CATCH_SET(oldcatch);
312caa8e
CS
3010 }
3011 else {
8e90e786 3012 I32 old_cxix;
d78bda3d 3013 myop.op_other = (OP*)&myop;
101d6365 3014 (void)POPMARK;
8e90e786 3015 old_cxix = cxstack_ix;
274ed8ae 3016 create_eval_scope(NULL, flags|G_FAKINGEVAL);
c318a6ee 3017 INCMARK;
a0d0e21e 3018
14dd3ad8 3019 JMPENV_PUSH(ret);
edb2152a 3020
6224f72b
GS
3021 switch (ret) {
3022 case 0:
14dd3ad8 3023 redo_body:
d6f07c05 3024 CALL_BODY_SUB((OP*)&myop);
312caa8e 3025 retval = PL_stack_sp - (PL_stack_base + oldmark);
8433848b 3026 if (!(flags & G_KEEPERR)) {
ab69dbc2 3027 CLEAR_ERRSV();
8433848b 3028 }
a0d0e21e 3029 break;
6224f72b 3030 case 1:
f86702cc 3031 STATUS_ALL_FAILURE;
924ba076 3032 /* FALLTHROUGH */
6224f72b 3033 case 2:
a0d0e21e 3034 /* my_exit() was called */
03d9f026 3035 SET_CURSTASH(PL_defstash);
a0d0e21e 3036 FREETMPS;
14dd3ad8 3037 JMPENV_POP;
f86702cc 3038 my_exit_jump();
e5964223 3039 NOT_REACHED; /* NOTREACHED */
6224f72b 3040 case 3:
3280af22 3041 if (PL_restartop) {
febb3a6d 3042 PL_restartjmpenv = NULL;
533c011a 3043 PL_op = PL_restartop;
3280af22 3044 PL_restartop = 0;
312caa8e 3045 goto redo_body;
a0d0e21e 3046 }
3280af22 3047 PL_stack_sp = PL_stack_base + oldmark;
51ce5529 3048 if ((flags & G_WANT) == G_ARRAY)
a0d0e21e
LW
3049 retval = 0;
3050 else {
3051 retval = 1;
3280af22 3052 *++PL_stack_sp = &PL_sv_undef;
a0d0e21e 3053 }
312caa8e 3054 break;
a0d0e21e 3055 }
a0d0e21e 3056
8e90e786
DM
3057 /* if we croaked, depending on how we croaked the eval scope
3058 * may or may not have already been popped */
3059 if (cxstack_ix > old_cxix) {
3060 assert(cxstack_ix == old_cxix + 1);
4ebe6e95 3061 assert(CxTYPE(CX_CUR()) == CXt_EVAL);
edb2152a 3062 delete_eval_scope();
8e90e786 3063 }
14dd3ad8 3064 JMPENV_POP;
a0d0e21e 3065 }
1e422769 3066
a0d0e21e 3067 if (flags & G_DISCARD) {
3280af22 3068 PL_stack_sp = PL_stack_base + oldmark;
a0d0e21e
LW
3069 retval = 0;
3070 FREETMPS;
3071 LEAVE;
3072 }
533c011a 3073 PL_op = oldop;
a0d0e21e
LW
3074 return retval;
3075}
3076
6e72f9df 3077/* Eval a string. The G_EVAL flag is always assumed. */
8990e307 3078
954c1994
GS
3079/*
3080=for apidoc p||eval_sv
3081
72d33970 3082Tells Perl to C<eval> the string in the SV. It supports the same flags
796b6530 3083as C<call_sv>, with the obvious exception of C<G_EVAL>. See L<perlcall>.
954c1994
GS
3084
3085=cut
3086*/
3087
a0d0e21e 3088I32
864dbfa3 3089Perl_eval_sv(pTHX_ SV *sv, I32 flags)
ac27b0f5 3090
8ac85365 3091 /* See G_* flags in cop.h */
a0d0e21e 3092{
97aff369 3093 dVAR;
a0d0e21e 3094 UNOP myop; /* fake syntax tree node */
8162b70e
AC
3095 volatile I32 oldmark;
3096 volatile I32 retval = 0;
6224f72b 3097 int ret;
c4420975 3098 OP* const oldop = PL_op;
db36c5a1 3099 dJMPENV;
84902520 3100
7918f24d
NC
3101 PERL_ARGS_ASSERT_EVAL_SV;
3102
4633a7c4
LW
3103 if (flags & G_DISCARD) {
3104 ENTER;
3105 SAVETMPS;
3106 }
3107
462e5cf6 3108 SAVEOP();
533c011a 3109 PL_op = (OP*)&myop;
5ff48db8 3110 Zero(&myop, 1, UNOP);
5b434c73
DD
3111 {
3112 dSP;
3113 oldmark = SP - PL_stack_base;
3114 EXTEND(SP, 1);
3115 PUSHs(sv);
3116 PUTBACK;
3117 }
79072805 3118
4633a7c4
LW
3119 if (!(flags & G_NOARGS))
3120 myop.op_flags = OPf_STACKED;
6e72f9df 3121 myop.op_type = OP_ENTEREVAL;
4f911530 3122 myop.op_flags |= OP_GIMME_REVERSE(flags);
6e72f9df
PP
3123 if (flags & G_KEEPERR)
3124 myop.op_flags |= OPf_SPECIAL;
a1941760
DM
3125
3126 if (flags & G_RE_REPARSING)
3127 myop.op_private = (OPpEVAL_COPHH | OPpEVAL_RE_REPARSING);
4633a7c4 3128
dedbcade 3129 /* fail now; otherwise we could fail after the JMPENV_PUSH but
13febba5 3130 * before a cx_pusheval(), which corrupts the stack after a croak */
dedbcade
DM
3131 TAINT_PROPER("eval_sv()");
3132
14dd3ad8 3133 JMPENV_PUSH(ret);
6224f72b
GS
3134 switch (ret) {
3135 case 0:
14dd3ad8 3136 redo_body:
2ba65d5f
DM
3137 if (PL_op == (OP*)(&myop)) {
3138 PL_op = PL_ppaddr[OP_ENTEREVAL](aTHX);
3139 if (!PL_op)
3140 goto fail; /* failed in compilation */
3141 }
4aca2f62 3142 CALLRUNOPS(aTHX);
312caa8e 3143 retval = PL_stack_sp - (PL_stack_base + oldmark);
8433848b 3144 if (!(flags & G_KEEPERR)) {
ab69dbc2 3145 CLEAR_ERRSV();
8433848b 3146 }
4633a7c4 3147 break;
6224f72b 3148 case 1:
f86702cc 3149 STATUS_ALL_FAILURE;
924ba076 3150 /* FALLTHROUGH */
6224f72b 3151 case 2:
4633a7c4 3152 /* my_exit() was called */
03d9f026 3153 SET_CURSTASH(PL_defstash);
4633a7c4 3154 FREETMPS;
14dd3ad8 3155 JMPENV_POP;
f86702cc 3156 my_exit_jump();
e5964223 3157 NOT_REACHED; /* NOTREACHED */
6224f72b 3158 case 3:
3280af22 3159 if (PL_restartop) {
febb3a6d 3160 PL_restartjmpenv = NULL;
533c011a 3161 PL_op = PL_restartop;
3280af22 3162 PL_restartop = 0;
312caa8e 3163 goto redo_body;
4633a7c4 3164 }
4aca2f62 3165 fail:
3280af22 3166 PL_stack_sp = PL_stack_base + oldmark;
51ce5529 3167 if ((flags & G_WANT) == G_ARRAY)
4633a7c4
LW
3168 retval = 0;
3169 else {
3170 retval = 1;
3280af22 3171 *++PL_stack_sp = &PL_sv_undef;
4633a7c4 3172 }
312caa8e 3173 break;
4633a7c4
LW
3174 }
3175
14dd3ad8 3176 JMPENV_POP;
4633a7c4 3177 if (flags & G_DISCARD) {
3280af22 3178 PL_stack_sp = PL_stack_base + oldmark;
4633a7c4
LW
3179 retval = 0;
3180 FREETMPS;
3181 LEAVE;
3182 }
533c011a 3183 PL_op = oldop;
4633a7c4
LW
3184 return retval;
3185}
3186
954c1994
GS
3187/*
3188=for apidoc p||eval_pv
3189
422791e4 3190Tells Perl to C<eval> the given string in scalar context and return an SV* result.
954c1994
GS
3191
3192=cut
3193*/
3194
137443ea 3195SV*
864dbfa3 3196Perl_eval_pv(pTHX_ const char *p, I32 croak_on_error)
137443ea 3197{
137443ea
PP
3198 SV* sv = newSVpv(p, 0);
3199
7918f24d
NC
3200 PERL_ARGS_ASSERT_EVAL_PV;
3201
864dbfa3 3202 eval_sv(sv, G_SCALAR);
137443ea
PP
3203 SvREFCNT_dec(sv);
3204
ed1786ad
DD
3205 {
3206 dSP;
3207 sv = POPs;
3208 PUTBACK;
3209 }
137443ea 3210
eed484f9
DD
3211 /* just check empty string or undef? */
3212 if (croak_on_error) {
3213 SV * const errsv = ERRSV;
3214 if(SvTRUE_NN(errsv))
3215 /* replace with croak_sv? */
3216 Perl_croak_nocontext("%s", SvPV_nolen_const(errsv));
2d8e6c8d 3217 }
137443ea
PP
3218
3219 return sv;
3220}
3221
4633a7c4
LW
3222/* Require a module. */
3223
954c1994 3224/*
ccfc67b7
JH
3225=head1 Embedding Functions
3226
954c1994
GS
3227=for apidoc p||require_pv
3228
7d3fb230
BS
3229Tells Perl to C<require> the file named by the string argument. It is
3230analogous to the Perl code C<eval "require '$file'">. It's even
2307c6d0 3231implemented that way; consider using load_module instead.
954c1994 3232
7d3fb230 3233=cut */
954c1994 3234
4633a7c4 3235void
864dbfa3 3236Perl_require_pv(pTHX_ const char *pv)
4633a7c4 3237{
d3acc0f7 3238 dSP;
97aff369 3239 SV* sv;
7918f24d
NC
3240
3241 PERL_ARGS_ASSERT_REQUIRE_PV;
3242
e788e7d3 3243 PUSHSTACKi(PERLSI_REQUIRE);
be41e5d9
NC
3244 sv = Perl_newSVpvf(aTHX_ "require q%c%s%c", 0, pv, 0);
3245 eval_sv(sv_2mortal(sv), G_DISCARD);
d3acc0f7 3246 POPSTACK;
79072805
LW
3247}
3248
76e3520e 3249STATIC void
b6f82619 3250S_usage(pTHX) /* XXX move this out into a module ? */
4633a7c4 3251{
ab821d7f 3252 /* This message really ought to be max 23 lines.
75c72d73 3253 * Removed -h because the user already knows that option. Others? */
fb73857a 3254
1566c39d
NC
3255 /* Grouped as 6 lines per C string literal, to keep under the ANSI C 89
3256 minimum of 509 character string literals. */
27da23d5 3257 static const char * const usage_msg[] = {
1566c39d
NC
3258" -0[octal] specify record separator (\\0, if no argument)\n"
3259" -a autosplit mode with -n or -p (splits $_ into @F)\n"
3260" -C[number/list] enables the listed Unicode features\n"
3261" -c check syntax only (runs BEGIN and CHECK blocks)\n"
3262" -d[:debugger] run program under debugger\n"
3263" -D[number/list] set debugging flags (argument is a bit mask or alphabets)\n",
3264" -e program one line of program (several -e's allowed, omit programfile)\n"
3265" -E program like -e, but enables all optional features\n"
3266" -f don't do $sitelib/sitecustomize.pl at startup\n"
3267" -F/pattern/ split() pattern for -a switch (//'s are optional)\n"
3268" -i[extension] edit <> files in place (makes backup if extension supplied)\n"
3269" -Idirectory specify @INC/#include directory (several -I's allowed)\n",
3270" -l[octal] enable line ending processing, specifies line terminator\n"
3271" -[mM][-]module execute \"use/no module...\" before executing program\n"
3272" -n assume \"while (<>) { ... }\" loop around program\n"
3273" -p assume loop like -n but print line also, like sed\n"
3274" -s enable rudimentary parsing for switches after programfile\n"
3275" -S look for programfile using PATH environment variable\n",
3276" -t enable tainting warnings\n"
3277" -T enable tainting checks\n"
3278" -u dump core after parsing program\n"
3279" -U allow unsafe operations\n"
3280" -v print version, patchlevel and license\n"
3281" -V[:variable] print configuration summary (or a single Config.pm variable)\n",
60eaec42 3282" -w enable many useful warnings\n"
1566c39d
NC
3283" -W enable all warnings\n"
3284" -x[directory] ignore text before #!perl line (optionally cd to directory)\n"
3285" -X disable all warnings\n"
3286" \n"
3287"Run 'perldoc perl' for more help with Perl.\n\n",
fb73857a
PP
3288NULL
3289};
27da23d5 3290 const char * const *p = usage_msg;
1566c39d 3291 PerlIO *out = PerlIO_stdout();
fb73857a 3292
1566c39d
NC
3293 PerlIO_printf(out,
3294 "\nUsage: %s [switches] [--] [programfile] [arguments]\n",
b6f82619 3295 PL_origargv[0]);
fb73857a 3296 while (*p)
1566c39d 3297 PerlIO_puts(out, *p++);
b6f82619 3298 my_exit(0);
4633a7c4
LW
3299}
3300
b4ab917c
DM
3301/* convert a string of -D options (or digits) into an int.
3302 * sets *s to point to the char after the options */
3303
3304#ifdef DEBUGGING
3305int
e1ec3a88 3306Perl_get_debug_opts(pTHX_ const char **s, bool givehelp)
b4ab917c 3307{
27da23d5 3308 static const char * const usage_msgd[] = {
651b8f1a
NC
3309 " Debugging flag values: (see also -d)\n"
3310 " p Tokenizing and parsing (with v, displays parse stack)\n"
3311 " s Stack snapshots (with v, displays all stacks)\n"
3312 " l Context (loop) stack processing\n"
3313 " t Trace execution\n"
3314 " o Method and overloading resolution\n",
3315 " c String/numeric conversions\n"
3316 " P Print profiling info, source file input state\n"
3317 " m Memory and SV allocation\n"
3318 " f Format processing\n"
3319 " r Regular expression parsing and execution\n"
3320 " x Syntax tree dump\n",
3321 " u Tainting checks\n"
3322 " H Hash dump -- usurps values()\n"
3323 " X Scratchpad allocation\n"
3324 " D Cleaning up\n"
56967202 3325 " S Op slab allocation\n"
651b8f1a
NC
3326 " T Tokenising\n"
3327 " R Include reference counts of dumped variables (eg when using -Ds)\n",
3328 " J Do not s,t,P-debug (Jump over) opcodes within package DB\n"
3329 " v Verbose: use in conjunction with other flags\n"
3330 " C Copy On Write\n"
3331 " A Consistency checks on internal structures\n"
3332 " q quiet - currently only suppresses the 'EXECUTING' message\n"
3333 " M trace smart match resolution\n"
3334 " B dump suBroutine definitions, including special Blocks like BEGIN\n",
69014004 3335 " L trace some locale setting information--for Perl core development\n",
e17bc05a 3336 " i trace PerlIO layer processing\n",
e6e64d9b
JC
3337 NULL
3338 };
22ff3130 3339 UV uv = 0;
7918f24d
NC
3340
3341 PERL_ARGS_ASSERT_GET_DEBUG_OPTS;
3342
b4ab917c
DM
3343 if (isALPHA(**s)) {
3344 /* if adding extra options, remember to update DEBUG_MASK */
e17bc05a 3345 static const char debopts[] = "psltocPmfrxuUHXDSTRJvCAqMBLi";
b4ab917c 3346
0eb30aeb 3347 for (; isWORDCHAR(**s); (*s)++) {
c4420975 3348 const char * const d = strchr(debopts,**s);
b4ab917c 3349 if (d)
22ff3130 3350 uv |= 1 << (d - debopts);
b4ab917c 3351 else if (ckWARN_d(WARN_DEBUGGING))
e6e64d9b
JC
3352 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3353 "invalid option -D%c, use -D'' to see choices\n", **s);
b4ab917c
DM
3354 }
3355 }
e6e64d9b 3356 else if (isDIGIT(**s)) {
5d4a52b5 3357 const char* e = *s + strlen(*s);
22ff3130 3358 if (grok_atoUV(*s, &uv, &e))
96e440d2 3359 *s = e;
0eb30aeb 3360 for (; isWORDCHAR(**s); (*s)++) ;
b4ab917c 3361 }
ddcf8bc1 3362 else if (givehelp) {
06e869a4 3363 const char *const *p = usage_msgd;
651b8f1a 3364 while (*p) PerlIO_puts(PerlIO_stdout(), *p++);
e6e64d9b 3365 }
22ff3130 3366 return (int)uv; /* ignore any UV->int conversion loss */
b4ab917c
DM
3367}
3368#endif
3369
79072805
LW
3370/* This routine handles any switches that can be given during run */
3371
c7030b81
NC
3372const char *
3373Perl_moreswitches(pTHX_ const char *s)
79072805 3374{
27da23d5 3375 dVAR;
84c133a0 3376 UV rschar;
0544e6df 3377 const char option = *s; /* used to remember option in -m/-M code */
79072805 3378
7918f24d
NC
3379 PERL_ARGS_ASSERT_MORESWITCHES;
3380
79072805
LW
3381 switch (*s) {
3382 case '0':
a863c7d1 3383 {
f2095865 3384 I32 flags = 0;
a3b680e6 3385 STRLEN numlen;
f2095865
JH
3386
3387 SvREFCNT_dec(PL_rs);
3388 if (s[1] == 'x' && s[2]) {
a3b680e6 3389 const char *e = s+=2;
f2095865
JH
3390 U8 *tmps;
3391
a3b680e6
AL
3392 while (*e)
3393 e++;
f2095865
JH
3394 numlen = e - s;
3395 flags = PERL_SCAN_SILENT_ILLDIGIT;
3396 rschar = (U32)grok_hex(s, &numlen, &flags, NULL);
3397 if (s + numlen < e) {
3398 rschar = 0; /* Grandfather -0xFOO as -0 -xFOO. */
3399 numlen = 0;
3400 s--;
3401 }
396482e1 3402 PL_rs = newSVpvs("");
10656159 3403 tmps = (U8*) SvGROW(PL_rs, (STRLEN)(UVCHR_SKIP(rschar) + 1));
f2095865 3404 uvchr_to_utf8(tmps, rschar);
5f560d8a 3405 SvCUR_set(PL_rs, UVCHR_SKIP(rschar));
f2095865
JH
3406 SvUTF8_on(PL_rs);
3407 }
3408 else {
3409 numlen = 4;
3410 rschar = (U32)grok_oct(s, &numlen, &flags, NULL);
3411 if (rschar & ~((U8)~0))
3412 PL_rs = &PL_sv_undef;
3413 else if (!rschar && numlen >= 2)
396482e1 3414 PL_rs = newSVpvs("");
f2095865
JH
3415 else {
3416 char ch = (char)rschar;
3417 PL_rs = newSVpvn(&ch, 1);
3418 }
3419 }
64ace3f8 3420 sv_setsv(get_sv("/", GV_ADD), PL_rs);
f2095865 3421 return s + numlen;
a863c7d1 3422 }
46487f74 3423 case 'C':
a05d7ebb 3424 s++;
dd374669 3425 PL_unicode = parse_unicode_opts( (const char **)&s );
5a22a2bb
NC
3426 if (PL_unicode & PERL_UNICODE_UTF8CACHEASSERT_FLAG)
3427 PL_utf8cache = -1;
46487f74 3428 return s;
2304df62 3429 case 'F':
5fc691f1 3430 PL_minus_a = TRUE;
3280af22 3431 PL_minus_F = TRUE;
24ffa309 3432 PL_minus_n = TRUE;
ebce5377
RGS
3433 PL_splitstr = ++s;
3434 while (*s && !isSPACE(*s)) ++s;
e49e380e 3435 PL_splitstr = savepvn(PL_splitstr, s - PL_splitstr);
2304df62 3436 return s;
79072805 3437 case 'a':
3280af22 3438 PL_minus_a = TRUE;
24ffa309 3439 PL_minus_n = TRUE;
79072805
LW
3440 s++;
3441 return s;
3442 case 'c':
3280af22 3443 PL_minus_c = TRUE;
79072805
LW
3444 s++;
3445 return s;
3446 case 'd':
f20b2998 3447 forbid_setid('d', FALSE);
4633a7c4 3448 s++;
2cbb2ee1
RGS
3449
3450 /* -dt indicates to the debugger that threads will be used */
0eb30aeb 3451 if (*s == 't' && !isWORDCHAR(s[1])) {
2cbb2ee1
RGS
3452 ++s;
3453 my_setenv("PERL5DB_THREADED", "1");
3454 }
3455
70c94a19
RR
3456 /* The following permits -d:Mod to accepts arguments following an =
3457 in the fashion that -MSome::Mod does. */
3458 if (*s == ':' || *s == '=') {
b19934fb
NC
3459 const char *start;
3460 const char *end;
3461 SV *sv;
3462
3463 if (*++s == '-') {
3464 ++s;
3465 sv = newSVpvs("no Devel::");
3466 } else {
3467 sv = newSVpvs("use Devel::");
3468 }
3469
3470 start = s;
3471 end = s + strlen(s);
f85893a1 3472
b19934fb 3473 /* We now allow -d:Module=Foo,Bar and -d:-Module */
0eb30aeb 3474 while(isWORDCHAR(*s) || *s==':') ++s;
70c94a19 3475 if (*s != '=')
f85893a1 3476 sv_catpvn(sv, start, end - start);
70c94a19
RR
3477 else {
3478 sv_catpvn(sv, start, s-start);
95a2b409
RGS
3479 /* Don't use NUL as q// delimiter here, this string goes in the
3480 * environment. */
3481 Perl_sv_catpvf(aTHX_ sv, " split(/,/,q{%s});", ++s);
70c94a19 3482 }
f85893a1 3483 s = end;
184f32ec 3484 my_setenv("PERL5DB", SvPV_nolen_const(sv));
c4db126b 3485 SvREFCNT_dec(sv);
4633a7c4 3486 }
ed094faf 3487 if (!PL_perldb) {
3280af22 3488 PL_perldb = PERLDB_ALL;
a0d0e21e 3489 init_debugger();
ed094faf 3490 }
79072805
LW
3491 return s;
3492 case 'D':
0453d815 3493 {
79072805 3494#ifdef DEBUGGING
f20b2998 3495 forbid_setid('D', FALSE);
b4ab917c 3496 s++;
dd374669 3497 PL_debug = get_debug_opts( (const char **)&s, 1) | DEBUG_TOP_FLAG;
12a43e32 3498#else /* !DEBUGGING */
0453d815 3499 if (ckWARN_d(WARN_DEBUGGING))
9014280d 3500 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
e6e64d9b 3501 "Recompile perl with -DDEBUGGING to use -D switch (did you mean -d ?)\n");
0eb30aeb 3502 for (s++; isWORDCHAR(*s); s++) ;
79072805 3503#endif
79072805 3504 return s;
2b5060ae 3505 NOT_REACHED; /* NOTREACHED */
0453d815 3506 }
4633a7c4 3507 case 'h':
b6f82619 3508 usage();
2b5060ae
DM
3509 NOT_REACHED; /* NOTREACHED */
3510
79072805 3511 case 'i':
43c5f42d 3512 Safefree(PL_inplace);
5ef5d758 3513 {
d4c19fe8 3514 const char * const start = ++s;
5ef5d758
NC