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