This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Perl_sv_2pv_flags: Potentially avoid work
[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
d33b2eba 1149
b9582b6a 1150#ifdef USE_LOCALE_NUMERIC
d33b2eba 1151 Safefree(PL_numeric_name);
bd61b366 1152 PL_numeric_name = NULL;
a453c169 1153 SvREFCNT_dec(PL_numeric_radix_sv);
a0714e2c 1154 PL_numeric_radix_sv = NULL;
b9582b6a 1155#endif
d33b2eba 1156
f7416781
KW
1157 if (PL_langinfo_buf) {
1158 Safefree(PL_langinfo_buf);
1159 PL_langinfo_buf = NULL;
1160 }
1161
9c0b6888
KW
1162 /* clear character classes */
1163 for (i = 0; i < POSIX_SWASH_COUNT; i++) {
1164 SvREFCNT_dec(PL_utf8_swash_ptrs[i]);
1165 PL_utf8_swash_ptrs[i] = NULL;
1166 }
5c831c24
GS
1167 SvREFCNT_dec(PL_utf8_mark);
1168 SvREFCNT_dec(PL_utf8_toupper);
4dbdbdc2 1169 SvREFCNT_dec(PL_utf8_totitle);
5c831c24 1170 SvREFCNT_dec(PL_utf8_tolower);
b4e400f9 1171 SvREFCNT_dec(PL_utf8_tofold);
82686b01
JH
1172 SvREFCNT_dec(PL_utf8_idstart);
1173 SvREFCNT_dec(PL_utf8_idcont);
c60f4405 1174 SvREFCNT_dec(PL_utf8_foldable);
2726813d 1175 SvREFCNT_dec(PL_utf8_foldclosures);
9fa9f06b 1176 SvREFCNT_dec(PL_AboveLatin1);
e0a1ff7a 1177 SvREFCNT_dec(PL_InBitmap);
9fa9f06b
KW
1178 SvREFCNT_dec(PL_UpperLatin1);
1179 SvREFCNT_dec(PL_Latin1);
1180 SvREFCNT_dec(PL_NonL1NonFinalFold);
1181 SvREFCNT_dec(PL_HasMultiCharFold);
5b7de470 1182#ifdef USE_LOCALE_CTYPE
780fcc9f 1183 SvREFCNT_dec(PL_warn_locale);
5b7de470 1184#endif
a0714e2c
SS
1185 PL_utf8_mark = NULL;
1186 PL_utf8_toupper = NULL;
1187 PL_utf8_totitle = NULL;
1188 PL_utf8_tolower = NULL;
1189 PL_utf8_tofold = NULL;
1190 PL_utf8_idstart = NULL;
1191 PL_utf8_idcont = NULL;
2726813d 1192 PL_utf8_foldclosures = NULL;
9fa9f06b 1193 PL_AboveLatin1 = NULL;
e0a1ff7a 1194 PL_InBitmap = NULL;
9fa9f06b 1195 PL_HasMultiCharFold = NULL;
5b7de470 1196#ifdef USE_LOCALE_CTYPE
780fcc9f 1197 PL_warn_locale = NULL;
5b7de470 1198#endif
9fa9f06b
KW
1199 PL_Latin1 = NULL;
1200 PL_NonL1NonFinalFold = NULL;
1201 PL_UpperLatin1 = NULL;
86f72d56 1202 for (i = 0; i < POSIX_CC_COUNT; i++) {
cac6e0ca
KW
1203 SvREFCNT_dec(PL_XPosix_ptrs[i]);
1204 PL_XPosix_ptrs[i] = NULL;
86f72d56 1205 }
64935bc6 1206 PL_GCB_invlist = NULL;
6b659339 1207 PL_LB_invlist = NULL;
06ae2722 1208 PL_SB_invlist = NULL;
034602eb 1209 PL_SCX_invlist = NULL;
ae3bb8ea 1210 PL_WB_invlist = NULL;
9e7ded3f 1211 PL_Assigned_invlist = NULL;
5c831c24 1212
971a9dd3 1213 if (!specialWARN(PL_compiling.cop_warnings))
72dc9ed5 1214 PerlMemShared_free(PL_compiling.cop_warnings);
a0714e2c 1215 PL_compiling.cop_warnings = NULL;
20439bc7
Z
1216 cophh_free(CopHINTHASH_get(&PL_compiling));
1217 CopHINTHASH_set(&PL_compiling, cophh_new_empty());
05ec9bb3 1218 CopFILE_free(&PL_compiling);
5c831c24 1219
a0d0e21e 1220 /* Prepare to destruct main symbol table. */
5f05dabc 1221
3280af22 1222 hv = PL_defstash;
ca556bcd 1223 /* break ref loop *:: <=> %:: */
854da30f 1224 (void)hv_deletes(hv, "main::", G_DISCARD);
3280af22 1225 PL_defstash = 0;
a0d0e21e 1226 SvREFCNT_dec(hv);
5c831c24 1227 SvREFCNT_dec(PL_curstname);
a0714e2c 1228 PL_curstname = NULL;
a0d0e21e 1229
5a844595
GS
1230 /* clear queued errors */
1231 SvREFCNT_dec(PL_errors);
a0714e2c 1232 PL_errors = NULL;
5a844595 1233
dd69841b
BB
1234 SvREFCNT_dec(PL_isarev);
1235
a0d0e21e 1236 FREETMPS;
9b387841 1237 if (destruct_level >= 2) {
3280af22 1238 if (PL_scopestack_ix != 0)
9b387841
NC
1239 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
1240 "Unbalanced scopes: %ld more ENTERs than LEAVEs\n",
1241 (long)PL_scopestack_ix);
3280af22 1242 if (PL_savestack_ix != 0)
9b387841
NC
1243 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
1244 "Unbalanced saves: %ld more saves than restores\n",
1245 (long)PL_savestack_ix);
3280af22 1246 if (PL_tmps_floor != -1)
9b387841
NC
1247 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced tmps: %ld more allocs than frees\n",
1248 (long)PL_tmps_floor + 1);
a0d0e21e 1249 if (cxstack_ix != -1)
9b387841
NC
1250 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced context: %ld more PUSHes than POPs\n",
1251 (long)cxstack_ix + 1);
a0d0e21e 1252 }
8990e307 1253
0547a729
DM
1254#ifdef USE_ITHREADS
1255 SvREFCNT_dec(PL_regex_padav);
1256 PL_regex_padav = NULL;
1257 PL_regex_pad = NULL;
1258#endif
1259
776df701 1260#ifdef PERL_IMPLICIT_CONTEXT
57bb2458
JH
1261 /* the entries in this list are allocated via SV PVX's, so get freed
1262 * in sv_clean_all */
1263 Safefree(PL_my_cxt_list);
776df701 1264#endif
57bb2458 1265
8990e307 1266 /* Now absolutely destruct everything, somehow or other, loops or no. */
5226ed68
JH
1267
1268 /* the 2 is for PL_fdpid and PL_strtab */
d17ea597 1269 while (sv_clean_all() > 2)
5226ed68
JH
1270 ;
1271
23083432
FC
1272#ifdef USE_ITHREADS
1273 Safefree(PL_stashpad); /* must come after sv_clean_all */
1274#endif
1275
d4777f27
GS
1276 AvREAL_off(PL_fdpid); /* no surviving entries */
1277 SvREFCNT_dec(PL_fdpid); /* needed in io_close() */
7d49f689 1278 PL_fdpid = NULL;
d33b2eba 1279
6c644e78
GS
1280#ifdef HAVE_INTERP_INTERN
1281 sys_intern_clear();
1282#endif
1283
a38ab475
RZ
1284 /* constant strings */
1285 for (i = 0; i < SV_CONSTS_COUNT; i++) {
1286 SvREFCNT_dec(PL_sv_consts[i]);
1287 PL_sv_consts[i] = NULL;
1288 }
1289
6e72f9df
PP
1290 /* Destruct the global string table. */
1291 {
1292 /* Yell and reset the HeVAL() slots that are still holding refcounts,
1293 * so that sv_free() won't fail on them.
80459961
NC
1294 * Now that the global string table is using a single hunk of memory
1295 * for both HE and HEK, we either need to explicitly unshare it the
1296 * correct way, or actually free things here.
6e72f9df 1297 */
80459961
NC
1298 I32 riter = 0;
1299 const I32 max = HvMAX(PL_strtab);
c4420975 1300 HE * const * const array = HvARRAY(PL_strtab);
80459961
NC
1301 HE *hent = array[0];
1302
6e72f9df 1303 for (;;) {
0453d815 1304 if (hent && ckWARN_d(WARN_INTERNAL)) {
44f8325f 1305 HE * const next = HeNEXT(hent);
9014280d 1306 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
44f8325f 1307 "Unbalanced string table refcount: (%ld) for \"%s\"",
de616631 1308 (long)hent->he_valu.hent_refcount, HeKEY(hent));
80459961
NC
1309 Safefree(hent);
1310 hent = next;
6e72f9df
PP
1311 }
1312 if (!hent) {
1313 if (++riter > max)
1314 break;
1315 hent = array[riter];
1316 }
1317 }
80459961
NC
1318
1319 Safefree(array);
1320 HvARRAY(PL_strtab) = 0;
1321 HvTOTALKEYS(PL_strtab) = 0;
6e72f9df 1322 }
3280af22 1323 SvREFCNT_dec(PL_strtab);
6e72f9df 1324
e652bb2f 1325#ifdef USE_ITHREADS
c21d1a0f 1326 /* free the pointer tables used for cloning */
a0739874 1327 ptr_table_free(PL_ptr_table);
bf9cdc68 1328 PL_ptr_table = (PTR_TBL_t*)NULL;
53186e96 1329#endif
a0739874 1330
d33b2eba
GS
1331 /* free special SVs */
1332
1333 SvREFCNT(&PL_sv_yes) = 0;
1334 sv_clear(&PL_sv_yes);
1335 SvANY(&PL_sv_yes) = NULL;
4c5e2b0d 1336 SvFLAGS(&PL_sv_yes) = 0;
d33b2eba
GS
1337
1338 SvREFCNT(&PL_sv_no) = 0;
1339 sv_clear(&PL_sv_no);
1340 SvANY(&PL_sv_no) = NULL;
4c5e2b0d 1341 SvFLAGS(&PL_sv_no) = 0;
01724ea0 1342
5a6c2837
DM
1343 SvREFCNT(&PL_sv_zero) = 0;
1344 sv_clear(&PL_sv_zero);
1345 SvANY(&PL_sv_zero) = NULL;
1346 SvFLAGS(&PL_sv_zero) = 0;
1347
9f375a43
DM
1348 {
1349 int i;
1350 for (i=0; i<=2; i++) {
1351 SvREFCNT(PERL_DEBUG_PAD(i)) = 0;
1352 sv_clear(PERL_DEBUG_PAD(i));
1353 SvANY(PERL_DEBUG_PAD(i)) = NULL;
1354 SvFLAGS(PERL_DEBUG_PAD(i)) = 0;
1355 }
1356 }
1357
0453d815 1358 if (PL_sv_count != 0 && ckWARN_d(WARN_INTERNAL))
9014280d 1359 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Scalars leaked: %ld\n", (long)PL_sv_count);
6e72f9df 1360
eba0f806
DM
1361#ifdef DEBUG_LEAKING_SCALARS
1362 if (PL_sv_count != 0) {
1363 SV* sva;
1364 SV* sv;
eb578fdb 1365 SV* svend;
eba0f806 1366
ad64d0ec 1367 for (sva = PL_sv_arenaroot; sva; sva = MUTABLE_SV(SvANY(sva))) {
eba0f806
DM
1368 svend = &sva[SvREFCNT(sva)];
1369 for (sv = sva + 1; sv < svend; ++sv) {
e4787c0c 1370 if (SvTYPE(sv) != (svtype)SVTYPEMASK) {
a548cda8 1371 PerlIO_printf(Perl_debug_log, "leaked: sv=0x%p"
61b61456 1372 " flags=0x%"UVxf
fd0854ff 1373 " refcnt=%"UVuf pTHX__FORMAT "\n"
147e3846
KW
1374 "\tallocated at %s:%d %s %s (parent 0x%" UVxf ");"
1375 "serial %" UVuf "\n",
574b8821
NC
1376 (void*)sv, (UV)sv->sv_flags, (UV)sv->sv_refcnt
1377 pTHX__VALUE,
fd0854ff
DM
1378 sv->sv_debug_file ? sv->sv_debug_file : "(unknown)",
1379 sv->sv_debug_line,
1380 sv->sv_debug_inpad ? "for" : "by",
1381 sv->sv_debug_optype ?
1382 PL_op_name[sv->sv_debug_optype]: "(none)",
cd676548 1383 PTR2UV(sv->sv_debug_parent),
cbe56f1d 1384 sv->sv_debug_serial
fd0854ff 1385 );
2aa47728 1386#ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
41e4abd8 1387 Perl_dump_sv_child(aTHX_ sv);
2aa47728 1388#endif
eba0f806
DM
1389 }
1390 }
1391 }
1392 }
2aa47728
NC
1393#ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1394 {
1395 int status;
1396 fd_set rset;
1397 /* Wait for up to 4 seconds for child to terminate.
1398 This seems to be the least effort way of timing out on reaping
1399 its exit status. */
1400 struct timeval waitfor = {4, 0};
41e4abd8 1401 int sock = PL_dumper_fd;
2aa47728
NC
1402
1403 shutdown(sock, 1);
1404 FD_ZERO(&rset);
1405 FD_SET(sock, &rset);
1406 select(sock + 1, &rset, NULL, NULL, &waitfor);
1407 waitpid(child, &status, WNOHANG);
1408 close(sock);
1409 }
1410#endif
eba0f806 1411#endif
77abb4c6
NC
1412#ifdef DEBUG_LEAKING_SCALARS_ABORT
1413 if (PL_sv_count)
1414 abort();
1415#endif
bf9cdc68 1416 PL_sv_count = 0;
eba0f806 1417
56a2bab7 1418#if defined(PERLIO_LAYERS)
3a1ee7e8
NIS
1419 /* No more IO - including error messages ! */
1420 PerlIO_cleanup(aTHX);
1421#endif
1422
9f4bd222 1423 /* sv_undef needs to stay immortal until after PerlIO_cleanup
a0714e2c 1424 as currently layers use it rather than NULL as a marker
9f4bd222
NIS
1425 for no arg - and will try and SvREFCNT_dec it.
1426 */
1427 SvREFCNT(&PL_sv_undef) = 0;
1428 SvREADONLY_off(&PL_sv_undef);
1429
3280af22 1430 Safefree(PL_origfilename);
bd61b366 1431 PL_origfilename = NULL;
43c5f42d 1432 Safefree(PL_reg_curpm);
dd28f7bb 1433 free_tied_hv_pool();
3280af22 1434 Safefree(PL_op_mask);
cf36064f 1435 Safefree(PL_psig_name);
bf9cdc68 1436 PL_psig_name = (SV**)NULL;
d525a7b2 1437 PL_psig_ptr = (SV**)NULL;
31c91b43
LR
1438 {
1439 /* We need to NULL PL_psig_pend first, so that
1440 signal handlers know not to use it */
1441 int *psig_save = PL_psig_pend;
1442 PL_psig_pend = (int*)NULL;
1443 Safefree(psig_save);
1444 }
6e72f9df 1445 nuke_stacks();
284167a5
SM
1446 TAINTING_set(FALSE);
1447 TAINT_WARN_set(FALSE);
3280af22 1448 PL_hints = 0; /* Reset hints. Should hints be per-interpreter ? */
ac27b0f5 1449
a0d0e21e 1450 DEBUG_P(debprofdump());
d33b2eba 1451
b173165c
FC
1452 PL_debug = 0;
1453
e5dd39fc 1454#ifdef USE_REENTRANT_API
10bc17b6 1455 Perl_reentrant_free(aTHX);
e5dd39fc
AB
1456#endif
1457
a24da70b
NC
1458 /* These all point to HVs that are about to be blown away.
1459 Code in core and on CPAN assumes that if the interpreter is re-started
1460 that they will be cleanly NULL or pointing to a valid HV. */
1461 PL_custom_op_names = NULL;
1462 PL_custom_op_descs = NULL;
1463 PL_custom_ops = NULL;
1464
612f20c3
GS
1465 sv_free_arenas();
1466
5d9a96ca
DM
1467 while (PL_regmatch_slab) {
1468 regmatch_slab *s = PL_regmatch_slab;
1469 PL_regmatch_slab = PL_regmatch_slab->next;
1470 Safefree(s);
1471 }
1472
fc36a67e
PP
1473 /* As the absolutely last thing, free the non-arena SV for mess() */
1474
3280af22 1475 if (PL_mess_sv) {
f350b448
NC
1476 /* we know that type == SVt_PVMG */
1477
9c63abab 1478 /* it could have accumulated taint magic */
f350b448
NC
1479 MAGIC* mg;
1480 MAGIC* moremagic;
1481 for (mg = SvMAGIC(PL_mess_sv); mg; mg = moremagic) {
1482 moremagic = mg->mg_moremagic;
1483 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global
1484 && mg->mg_len >= 0)
1485 Safefree(mg->mg_ptr);
1486 Safefree(mg);
9c63abab 1487 }
f350b448 1488
fc36a67e 1489 /* we know that type >= SVt_PV */
8bd4d4c5 1490 SvPV_free(PL_mess_sv);
3280af22
NIS
1491 Safefree(SvANY(PL_mess_sv));
1492 Safefree(PL_mess_sv);
a0714e2c 1493 PL_mess_sv = NULL;
fc36a67e 1494 }
37038d91 1495 return STATUS_EXIT;
79072805
LW
1496}
1497
954c1994
GS
1498/*
1499=for apidoc perl_free
1500
1501Releases a Perl interpreter. See L<perlembed>.
1502
1503=cut
1504*/
1505
79072805 1506void
0cb96387 1507perl_free(pTHXx)
79072805 1508{
5174512c
NC
1509 dVAR;
1510
7918f24d
NC
1511 PERL_ARGS_ASSERT_PERL_FREE;
1512
c301d606
DM
1513 if (PL_veto_cleanup)
1514 return;
1515
7cb608b5 1516#ifdef PERL_TRACK_MEMPOOL
55ef9aae
MHM
1517 {
1518 /*
1519 * Don't free thread memory if PERL_DESTRUCT_LEVEL is set to a non-zero
1520 * value as we're probably hunting memory leaks then
1521 */
36e77d41 1522 if (PL_perl_destruct_level == 0) {
4fd0a9b8 1523 const U32 old_debug = PL_debug;
55ef9aae
MHM
1524 /* Emulate the PerlHost behaviour of free()ing all memory allocated in this
1525 thread at thread exit. */
4fd0a9b8
NC
1526 if (DEBUG_m_TEST) {
1527 PerlIO_puts(Perl_debug_log, "Disabling memory debugging as we "
1528 "free this thread's memory\n");
1529 PL_debug &= ~ DEBUG_m_FLAG;
1530 }
6edcbed6
DD
1531 while(aTHXx->Imemory_debug_header.next != &(aTHXx->Imemory_debug_header)){
1532 char * next = (char *)(aTHXx->Imemory_debug_header.next);
1533 Malloc_t ptr = PERL_MEMORY_DEBUG_HEADER_SIZE + next;
1534 safesysfree(ptr);
1535 }
4fd0a9b8 1536 PL_debug = old_debug;
55ef9aae
MHM
1537 }
1538 }
7cb608b5
NC
1539#endif
1540
acfe0abc 1541#if defined(WIN32) || defined(NETWARE)
ce3e5b80 1542# if defined(PERL_IMPLICIT_SYS)
b36c9a52 1543 {
acfe0abc 1544# ifdef NETWARE
7af12a34 1545 void *host = nw_internal_host;
7af12a34 1546 PerlMem_free(aTHXx);
7af12a34 1547 nw_delete_internal_host(host);
acfe0abc 1548# else
bdb50480
NC
1549 void *host = w32_internal_host;
1550 PerlMem_free(aTHXx);
7af12a34 1551 win32_delete_internal_host(host);
acfe0abc 1552# endif
7af12a34 1553 }
1c0ca838
GS
1554# else
1555 PerlMem_free(aTHXx);
1556# endif
acfe0abc
GS
1557#else
1558 PerlMem_free(aTHXx);
76e3520e 1559#endif
79072805
LW
1560}
1561
b7f7fff6 1562#if defined(USE_ITHREADS)
aebd1ac7
GA
1563/* provide destructors to clean up the thread key when libperl is unloaded */
1564#ifndef WIN32 /* handled during DLL_PROCESS_DETACH in win32/perllib.c */
1565
826955bd 1566#if defined(__hpux) && !(defined(__ux_version) && __ux_version <= 1020) && !defined(__GNUC__)
aebd1ac7 1567#pragma fini "perl_fini"
666ad1ec
GA
1568#elif defined(__sun) && !defined(__GNUC__)
1569#pragma fini (perl_fini)
aebd1ac7
GA
1570#endif
1571
0dbb1585
AL
1572static void
1573#if defined(__GNUC__)
1574__attribute__((destructor))
aebd1ac7 1575#endif
de009b76 1576perl_fini(void)
aebd1ac7 1577{
27da23d5 1578 dVAR;
5c64bffd
NC
1579 if (
1580#ifdef PERL_GLOBAL_STRUCT_PRIVATE
1581 my_vars &&
1582#endif
1583 PL_curinterp && !PL_veto_cleanup)
aebd1ac7
GA
1584 FREE_THREAD_KEY;
1585}
1586
1587#endif /* WIN32 */
1588#endif /* THREADS */
1589
4b556e6c 1590void
864dbfa3 1591Perl_call_atexit(pTHX_ ATEXIT_t fn, void *ptr)
4b556e6c 1592{
3280af22
NIS
1593 Renew(PL_exitlist, PL_exitlistlen+1, PerlExitListEntry);
1594 PL_exitlist[PL_exitlistlen].fn = fn;
1595 PL_exitlist[PL_exitlistlen].ptr = ptr;
1596 ++PL_exitlistlen;
4b556e6c
JD
1597}
1598
954c1994 1599/*
0301e899
Z
1600=for apidoc Am|int|perl_parse|PerlInterpreter *my_perl|XSINIT_t xsinit|int argc|char **argv|char **env
1601
1602Tells a Perl interpreter to parse a Perl script. This performs most
1603of the initialisation of a Perl interpreter. See L<perlembed> for
1604a tutorial.
1605
1606C<my_perl> points to the Perl interpreter that is to parse the script.
1607It must have been previously created through the use of L</perl_alloc>
1608and L</perl_construct>. C<xsinit> points to a callback function that
1609will be called to set up the ability for this Perl interpreter to load
1610XS extensions, or may be null to perform no such setup.
1611
1612C<argc> and C<argv> supply a set of command-line arguments to the Perl
1613interpreter, as would normally be passed to the C<main> function of
1614a C program. C<argv[argc]> must be null. These arguments are where
1615the script to parse is specified, either by naming a script file or by
1616providing a script in a C<-e> option.
a3e261d5
Z
1617If L<C<$0>|perlvar/$0> will be written to in the Perl interpreter, then
1618the argument strings must be in writable memory, and so mustn't just be
1619string constants.
0301e899
Z
1620
1621C<env> specifies a set of environment variables that will be used by
1622this Perl interpreter. If non-null, it must point to a null-terminated
1623array of environment strings. If null, the Perl interpreter will use
1624the environment supplied by the C<environ> global variable.
1625
1626This function initialises the interpreter, and parses and compiles the
1627script specified by the command-line arguments. This includes executing
1628code in C<BEGIN>, C<UNITCHECK>, and C<CHECK> blocks. It does not execute
1629C<INIT> blocks or the main program.
1630
1631Returns an integer of slightly tricky interpretation. The correct
1632use of the return value is as a truth value indicating whether there
1633was a failure in initialisation. If zero is returned, this indicates
1634that initialisation was successful, and it is safe to proceed to call
1635L</perl_run> and make other use of it. If a non-zero value is returned,
1636this indicates some problem that means the interpreter wants to terminate.
1637The interpreter should not be just abandoned upon such failure; the caller
1638should proceed to shut the interpreter down cleanly with L</perl_destruct>
1639and free it with L</perl_free>.
1640
1641For historical reasons, the non-zero return value also attempts to
1642be a suitable value to pass to the C library function C<exit> (or to
1643return from C<main>), to serve as an exit code indicating the nature
1644of the way initialisation terminated. However, this isn't portable,
857320cb
Z
1645due to differing exit code conventions. A historical bug is preserved
1646for the time being: if the Perl built-in C<exit> is called during this
1647function's execution, with a type of exit entailing a zero exit code
1648under the host operating system's conventions, then this function
1649returns zero rather than a non-zero value. This bug, [perl #2754],
1650leads to C<perl_run> being called (and therefore C<INIT> blocks and the
1651main program running) despite a call to C<exit>. It has been preserved
1652because a popular module-installing module has come to rely on it and
1653needs time to be fixed. This issue is [perl #132577], and the original
1654bug is due to be fixed in Perl 5.30.
0301e899 1655
954c1994
GS
1656=cut
1657*/
1658
03d9f026
FC
1659#define SET_CURSTASH(newstash) \
1660 if (PL_curstash != newstash) { \
1661 SvREFCNT_dec(PL_curstash); \
1662 PL_curstash = (HV *)SvREFCNT_inc(newstash); \
1663 }
1664
79072805 1665int
0cb96387 1666perl_parse(pTHXx_ XSINIT_t xsinit, int argc, char **argv, char **env)
8d063cd8 1667{
27da23d5 1668 dVAR;
6224f72b 1669 I32 oldscope;
6224f72b 1670 int ret;
db36c5a1 1671 dJMPENV;
8d063cd8 1672
7918f24d
NC
1673 PERL_ARGS_ASSERT_PERL_PARSE;
1674#ifndef MULTIPLICITY
ed6c66dd 1675 PERL_UNUSED_ARG(my_perl);
7918f24d 1676#endif
1a237f4f 1677#if (defined(USE_HASH_SEED) || defined(USE_HASH_SEED_DEBUG)) && !defined(NO_PERL_HASH_SEED_DEBUG)
b0891165 1678 {
7dc86639
YO
1679 const char * const s = PerlEnv_getenv("PERL_HASH_SEED_DEBUG");
1680
22ff3130 1681 if (s && strEQ(s, "1")) {
25c1b134
TC
1682 const unsigned char *seed= PERL_HASH_SEED;
1683 const unsigned char *seed_end= PERL_HASH_SEED + PERL_HASH_SEED_BYTES;
7dc86639
YO
1684 PerlIO_printf(Perl_debug_log, "HASH_FUNCTION = %s HASH_SEED = 0x", PERL_HASH_FUNC);
1685 while (seed < seed_end) {
1686 PerlIO_printf(Perl_debug_log, "%02x", *seed++);
1687 }
6a5b4183
YO
1688#ifdef PERL_HASH_RANDOMIZE_KEYS
1689 PerlIO_printf(Perl_debug_log, " PERTURB_KEYS = %d (%s)",
1690 PL_HASH_RAND_BITS_ENABLED,
1691 PL_HASH_RAND_BITS_ENABLED == 0 ? "NO" : PL_HASH_RAND_BITS_ENABLED == 1 ? "RANDOM" : "DETERMINISTIC");
1692#endif
7dc86639
YO
1693 PerlIO_printf(Perl_debug_log, "\n");
1694 }
b0891165 1695 }
1a237f4f 1696#endif /* #if (defined(USE_HASH_SEED) ... */
43238333 1697
ea34f6bd 1698#ifdef __amigaos4__
43238333
AB
1699 {
1700 struct NameTranslationInfo nti;
1701 __translate_amiga_to_unix_path_name(&argv[0],&nti);
1702 }
1703#endif
1704
cc85e83f
Z
1705 {
1706 int i;
1707 assert(argc >= 0);
1708 for(i = 0; i != argc; i++)
1709 assert(argv[i]);
1710 assert(!argv[argc]);
1711 }
3280af22 1712 PL_origargc = argc;
e2975953 1713 PL_origargv = argv;
a0d0e21e 1714
a2722ac9
GA
1715 if (PL_origalen != 0) {
1716 PL_origalen = 1; /* don't use old PL_origalen if perl_parse() is called again */
1717 }
1718 else {
3cb9023d
JH
1719 /* Set PL_origalen be the sum of the contiguous argv[]
1720 * elements plus the size of the env in case that it is
e9137a8e 1721 * contiguous with the argv[]. This is used in mg.c:Perl_magic_set()
3cb9023d
JH
1722 * as the maximum modifiable length of $0. In the worst case
1723 * the area we are able to modify is limited to the size of
43c32782 1724 * the original argv[0]. (See below for 'contiguous', though.)
3cb9023d 1725 * --jhi */
e1ec3a88 1726 const char *s = NULL;
b7249aaf 1727 const UV mask = ~(UV)(PTRSIZE-1);
43c32782 1728 /* Do the mask check only if the args seem like aligned. */
1b6737cc 1729 const UV aligned =
43c32782
JH
1730 (mask < ~(UV)0) && ((PTR2UV(argv[0]) & mask) == PTR2UV(argv[0]));
1731
1732 /* See if all the arguments are contiguous in memory. Note
1733 * that 'contiguous' is a loose term because some platforms
1734 * align the argv[] and the envp[]. If the arguments look
1735 * like non-aligned, assume that they are 'strictly' or
1736 * 'traditionally' contiguous. If the arguments look like
1737 * aligned, we just check that they are within aligned
1738 * PTRSIZE bytes. As long as no system has something bizarre
1739 * like the argv[] interleaved with some other data, we are
1740 * fine. (Did I just evoke Murphy's Law?) --jhi */
c8941eeb 1741 if (PL_origargv && PL_origargc >= 1 && (s = PL_origargv[0])) {
19742f39 1742 int i;
c8941eeb
JH
1743 while (*s) s++;
1744 for (i = 1; i < PL_origargc; i++) {
1745 if ((PL_origargv[i] == s + 1
43c32782 1746#ifdef OS2
c8941eeb 1747 || PL_origargv[i] == s + 2
43c32782 1748#endif
c8941eeb
JH
1749 )
1750 ||
1751 (aligned &&
1752 (PL_origargv[i] > s &&
1753 PL_origargv[i] <=
1754 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1755 )
1756 {
1757 s = PL_origargv[i];
1758 while (*s) s++;
1759 }
1760 else
1761 break;
54bfe034 1762 }
54bfe034 1763 }
a4a109c2
JD
1764
1765#ifndef PERL_USE_SAFE_PUTENV
3cb9023d 1766 /* Can we grab env area too to be used as the area for $0? */
a4a109c2 1767 if (s && PL_origenviron && !PL_use_safe_putenv) {
9d419b5f 1768 if ((PL_origenviron[0] == s + 1)
43c32782
JH
1769 ||
1770 (aligned &&
1771 (PL_origenviron[0] > s &&
1772 PL_origenviron[0] <=
1773 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1774 )
1775 {
19742f39 1776 int i;
9d419b5f 1777#ifndef OS2 /* ENVIRON is read by the kernel too. */
43c32782
JH
1778 s = PL_origenviron[0];
1779 while (*s) s++;
1780#endif
bd61b366 1781 my_setenv("NoNe SuCh", NULL);
43c32782
JH
1782 /* Force copy of environment. */
1783 for (i = 1; PL_origenviron[i]; i++) {
1784 if (PL_origenviron[i] == s + 1
1785 ||
1786 (aligned &&
1787 (PL_origenviron[i] > s &&
1788 PL_origenviron[i] <=
1789 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1790 )
1791 {
1792 s = PL_origenviron[i];
1793 while (*s) s++;
1794 }
1795 else
1796 break;
54bfe034 1797 }
43c32782 1798 }
54bfe034 1799 }
a4a109c2
JD
1800#endif /* !defined(PERL_USE_SAFE_PUTENV) */
1801
2d2af554 1802 PL_origalen = s ? s - PL_origargv[0] + 1 : 0;
54bfe034
JH
1803 }
1804
3280af22 1805 if (PL_do_undump) {
a0d0e21e
LW
1806
1807 /* Come here if running an undumped a.out. */
1808
3280af22
NIS
1809 PL_origfilename = savepv(argv[0]);
1810 PL_do_undump = FALSE;
a0d0e21e 1811 cxstack_ix = -1; /* start label stack again */
748a9306 1812 init_ids();
284167a5 1813 assert (!TAINT_get);
b7975bdd 1814 TAINT;
e2051532 1815 set_caret_X();
b7975bdd 1816 TAINT_NOT;
a0d0e21e
LW
1817 init_postdump_symbols(argc,argv,env);
1818 return 0;
1819 }
1820
3280af22 1821 if (PL_main_root) {
3280af22 1822 op_free(PL_main_root);
5f66b61c 1823 PL_main_root = NULL;
ff0cee69 1824 }
5f66b61c 1825 PL_main_start = NULL;
3280af22 1826 SvREFCNT_dec(PL_main_cv);
601f1833 1827 PL_main_cv = NULL;
79072805 1828
3280af22
NIS
1829 time(&PL_basetime);
1830 oldscope = PL_scopestack_ix;
599cee73 1831 PL_dowarn = G_WARN_OFF;
f86702cc 1832
14dd3ad8 1833 JMPENV_PUSH(ret);
6224f72b 1834 switch (ret) {
312caa8e 1835 case 0:
14dd3ad8 1836 parse_body(env,xsinit);
9ebf26ad 1837 if (PL_unitcheckav) {
3c10abe3 1838 call_list(oldscope, PL_unitcheckav);
9ebf26ad
FR
1839 }
1840 if (PL_checkav) {
ca7b837b 1841 PERL_SET_PHASE(PERL_PHASE_CHECK);
7d30b5c4 1842 call_list(oldscope, PL_checkav);
9ebf26ad 1843 }
14dd3ad8
GS
1844 ret = 0;
1845 break;
6224f72b
GS
1846 case 1:
1847 STATUS_ALL_FAILURE;
924ba076 1848 /* FALLTHROUGH */
6224f72b
GS
1849 case 2:
1850 /* my_exit() was called */
3280af22 1851 while (PL_scopestack_ix > oldscope)
6224f72b
GS
1852 LEAVE;
1853 FREETMPS;
03d9f026 1854 SET_CURSTASH(PL_defstash);
9ebf26ad 1855 if (PL_unitcheckav) {
3c10abe3 1856 call_list(oldscope, PL_unitcheckav);
9ebf26ad
FR
1857 }
1858 if (PL_checkav) {
ca7b837b 1859 PERL_SET_PHASE(PERL_PHASE_CHECK);
7d30b5c4 1860 call_list(oldscope, PL_checkav);
9ebf26ad 1861 }
37038d91 1862 ret = STATUS_EXIT;
857320cb
Z
1863 if (ret == 0) {
1864 /*
1865 * At this point we should do
1866 * ret = 0x100;
1867 * to avoid [perl #2754], but that bugfix has been postponed
1868 * because of the Module::Install breakage it causes
1869 * [perl #132577].
1870 */
1871 }
14dd3ad8 1872 break;
6224f72b 1873 case 3:
bf49b057 1874 PerlIO_printf(Perl_error_log, "panic: top_env\n");
14dd3ad8
GS
1875 ret = 1;
1876 break;
6224f72b 1877 }
14dd3ad8
GS
1878 JMPENV_POP;
1879 return ret;
1880}
1881
4a5df386
NC
1882/* This needs to stay in perl.c, as perl.c is compiled with different flags for
1883 miniperl, and we need to see those flags reflected in the values here. */
1884
1885/* What this returns is subject to change. Use the public interface in Config.
1886 */
1887static void
1888S_Internals_V(pTHX_ CV *cv)
1889{
1890 dXSARGS;
1891#ifdef LOCAL_PATCH_COUNT
1892 const int local_patch_count = LOCAL_PATCH_COUNT;
1893#else
1894 const int local_patch_count = 0;
1895#endif
2dc296d2 1896 const int entries = 3 + local_patch_count;
4a5df386 1897 int i;
fe1c5936 1898 static const char non_bincompat_options[] =
4a5df386
NC
1899# ifdef DEBUGGING
1900 " DEBUGGING"
1901# endif
1902# ifdef NO_MATHOMS
0d311fbe 1903 " NO_MATHOMS"
4a5df386 1904# endif
59b86f4b
DM
1905# ifdef NO_HASH_SEED
1906 " NO_HASH_SEED"
1907# endif
3b0e4ee2
MB
1908# ifdef NO_TAINT_SUPPORT
1909 " NO_TAINT_SUPPORT"
1910# endif
cb26ef7a
MB
1911# ifdef PERL_BOOL_AS_CHAR
1912 " PERL_BOOL_AS_CHAR"
1913# endif
93c10d60
FC
1914# ifdef PERL_COPY_ON_WRITE
1915 " PERL_COPY_ON_WRITE"
1916# endif
4a5df386
NC
1917# ifdef PERL_DISABLE_PMC
1918 " PERL_DISABLE_PMC"
1919# endif
1920# ifdef PERL_DONT_CREATE_GVSV
1921 " PERL_DONT_CREATE_GVSV"
1922# endif
9a044a43
NC
1923# ifdef PERL_EXTERNAL_GLOB
1924 " PERL_EXTERNAL_GLOB"
1925# endif
59b86f4b
DM
1926# ifdef PERL_HASH_FUNC_SIPHASH
1927 " PERL_HASH_FUNC_SIPHASH"
1928# endif
1929# ifdef PERL_HASH_FUNC_SDBM
1930 " PERL_HASH_FUNC_SDBM"
1931# endif
1932# ifdef PERL_HASH_FUNC_DJB2
1933 " PERL_HASH_FUNC_DJB2"
1934# endif
1935# ifdef PERL_HASH_FUNC_SUPERFAST
1936 " PERL_HASH_FUNC_SUPERFAST"
1937# endif
1938# ifdef PERL_HASH_FUNC_MURMUR3
1939 " PERL_HASH_FUNC_MURMUR3"
1940# endif
1941# ifdef PERL_HASH_FUNC_ONE_AT_A_TIME
1942 " PERL_HASH_FUNC_ONE_AT_A_TIME"
1943# endif
1944# ifdef PERL_HASH_FUNC_ONE_AT_A_TIME_HARD
1945 " PERL_HASH_FUNC_ONE_AT_A_TIME_HARD"
1946# endif
1947# ifdef PERL_HASH_FUNC_ONE_AT_A_TIME_OLD
1948 " PERL_HASH_FUNC_ONE_AT_A_TIME_OLD"
1949# endif
4a5df386
NC
1950# ifdef PERL_IS_MINIPERL
1951 " PERL_IS_MINIPERL"
1952# endif
1953# ifdef PERL_MALLOC_WRAP
1954 " PERL_MALLOC_WRAP"
1955# endif
1956# ifdef PERL_MEM_LOG
1957 " PERL_MEM_LOG"
1958# endif
1959# ifdef PERL_MEM_LOG_NOIMPL
1960 " PERL_MEM_LOG_NOIMPL"
1961# endif
4e499636
DM
1962# ifdef PERL_OP_PARENT
1963 " PERL_OP_PARENT"
1964# endif
59b86f4b
DM
1965# ifdef PERL_PERTURB_KEYS_DETERMINISTIC
1966 " PERL_PERTURB_KEYS_DETERMINISTIC"
1967# endif
1968# ifdef PERL_PERTURB_KEYS_DISABLED
1969 " PERL_PERTURB_KEYS_DISABLED"
1970# endif
1971# ifdef PERL_PERTURB_KEYS_RANDOM
1972 " PERL_PERTURB_KEYS_RANDOM"
1973# endif
c3cf41ec
NC
1974# ifdef PERL_PRESERVE_IVUV
1975 " PERL_PRESERVE_IVUV"
1976# endif
c051e30b
NC
1977# ifdef PERL_RELOCATABLE_INCPUSH
1978 " PERL_RELOCATABLE_INCPUSH"
1979# endif
4a5df386
NC
1980# ifdef PERL_USE_DEVEL
1981 " PERL_USE_DEVEL"
1982# endif
1983# ifdef PERL_USE_SAFE_PUTENV
1984 " PERL_USE_SAFE_PUTENV"
1985# endif
102b7877
YO
1986# ifdef SILENT_NO_TAINT_SUPPORT
1987 " SILENT_NO_TAINT_SUPPORT"
1988# endif
a3749cf3
NC
1989# ifdef UNLINK_ALL_VERSIONS
1990 " UNLINK_ALL_VERSIONS"
1991# endif
de618ee4
NC
1992# ifdef USE_ATTRIBUTES_FOR_PERLIO
1993 " USE_ATTRIBUTES_FOR_PERLIO"
1994# endif
4a5df386
NC
1995# ifdef USE_FAST_STDIO
1996 " USE_FAST_STDIO"
1997# endif
98548bdf
NC
1998# ifdef USE_LOCALE
1999 " USE_LOCALE"
2000# endif
98548bdf
NC
2001# ifdef USE_LOCALE_CTYPE
2002 " USE_LOCALE_CTYPE"
2003# endif
6937817d
DD
2004# ifdef WIN32_NO_REGISTRY
2005 " USE_NO_REGISTRY"
2006# endif
5a8d8935
NC
2007# ifdef USE_PERL_ATOF
2008 " USE_PERL_ATOF"
2009# endif
0d311fbe
NC
2010# ifdef USE_SITECUSTOMIZE
2011 " USE_SITECUSTOMIZE"
2012# endif
4a5df386
NC
2013 ;
2014 PERL_UNUSED_ARG(cv);
d3db1514 2015 PERL_UNUSED_VAR(items);
4a5df386
NC
2016
2017 EXTEND(SP, entries);
2018
2019 PUSHs(sv_2mortal(newSVpv(PL_bincompat_options, 0)));
2020 PUSHs(Perl_newSVpvn_flags(aTHX_ non_bincompat_options,
2021 sizeof(non_bincompat_options) - 1, SVs_TEMP));
2022
6baa8dbd
NT
2023#ifndef PERL_BUILD_DATE
2024# ifdef __DATE__
2025# ifdef __TIME__
2026# define PERL_BUILD_DATE __DATE__ " " __TIME__
2027# else
2028# define PERL_BUILD_DATE __DATE__
2029# endif
2030# endif
2031#endif
2032
2033#ifdef PERL_BUILD_DATE
4a5df386 2034 PUSHs(Perl_newSVpvn_flags(aTHX_
6baa8dbd 2035 STR_WITH_LEN("Compiled at " PERL_BUILD_DATE),
4a5df386 2036 SVs_TEMP));
4a5df386
NC
2037#else
2038 PUSHs(&PL_sv_undef);
2039#endif
2040
4a5df386
NC
2041 for (i = 1; i <= local_patch_count; i++) {
2042 /* This will be an undef, if PL_localpatches[i] is NULL. */
2043 PUSHs(sv_2mortal(newSVpv(PL_localpatches[i], 0)));
2044 }
2045
2046 XSRETURN(entries);
2047}
2048
be71fc8f
NC
2049#define INCPUSH_UNSHIFT 0x01
2050#define INCPUSH_ADD_OLD_VERS 0x02
2051#define INCPUSH_ADD_VERSIONED_SUB_DIRS 0x04
2052#define INCPUSH_ADD_ARCHONLY_SUB_DIRS 0x08
2053#define INCPUSH_NOT_BASEDIR 0x10
2054#define INCPUSH_CAN_RELOCATE 0x20
1e3208d8
NC
2055#define INCPUSH_ADD_SUB_DIRS \
2056 (INCPUSH_ADD_VERSIONED_SUB_DIRS|INCPUSH_ADD_ARCHONLY_SUB_DIRS)
e28f3139 2057
312caa8e 2058STATIC void *
14dd3ad8 2059S_parse_body(pTHX_ char **env, XSINIT_t xsinit)
312caa8e 2060{
27da23d5 2061 dVAR;
2f9285f8 2062 PerlIO *rsfp;
312caa8e 2063 int argc = PL_origargc;
8f42b153 2064 char **argv = PL_origargv;
e1ec3a88 2065 const char *scriptname = NULL;
402582ca 2066 bool dosearch = FALSE;
eb578fdb 2067 char c;
737c24fc 2068 bool doextract = FALSE;
bd61b366 2069 const char *cddir = NULL;
ab019eaa 2070#ifdef USE_SITECUSTOMIZE
20ef40cf 2071 bool minus_f = FALSE;
ab019eaa 2072#endif
95670bde 2073 SV *linestr_sv = NULL;
5486870f 2074 bool add_read_e_script = FALSE;
87606032 2075 U32 lex_start_flags = 0;
009d90df 2076
ca7b837b 2077 PERL_SET_PHASE(PERL_PHASE_START);
9ebf26ad 2078
6224f72b 2079 init_main_stash();
54310121 2080
c7030b81
NC
2081 {
2082 const char *s;
6224f72b
GS
2083 for (argc--,argv++; argc > 0; argc--,argv++) {
2084 if (argv[0][0] != '-' || !argv[0][1])
2085 break;
6224f72b
GS
2086 s = argv[0]+1;
2087 reswitch:
47f56822 2088 switch ((c = *s)) {
729a02f2 2089 case 'C':
1d5472a9
GS
2090#ifndef PERL_STRICT_CR
2091 case '\r':
2092#endif
6224f72b
GS
2093 case ' ':
2094 case '0':
2095 case 'F':
2096 case 'a':
2097 case 'c':
2098 case 'd':
2099 case 'D':
2100 case 'h':
2101 case 'i':
2102 case 'l':
2103 case 'M':
2104 case 'm':
2105 case 'n':
2106 case 'p':
2107 case 's':
2108 case 'u':
2109 case 'U':
2110 case 'v':
599cee73
PM
2111 case 'W':
2112 case 'X':
6224f72b 2113 case 'w':
97bd5664 2114 if ((s = moreswitches(s)))
6224f72b
GS
2115 goto reswitch;
2116 break;
33b78306 2117
1dbad523 2118 case 't':
dc6d7f5c 2119#if defined(SILENT_NO_TAINT_SUPPORT)
284167a5 2120 /* silently ignore */
dc6d7f5c 2121#elif defined(NO_TAINT_SUPPORT)
3231f579 2122 Perl_croak_nocontext("This perl was compiled without taint support. "
284167a5
SM
2123 "Cowardly refusing to run with -t or -T flags");
2124#else
22f7c9c9 2125 CHECK_MALLOC_TOO_LATE_FOR('t');
284167a5
SM
2126 if( !TAINTING_get ) {
2127 TAINT_WARN_set(TRUE);
2128 TAINTING_set(TRUE);
317ea90d 2129 }
284167a5 2130#endif
317ea90d
MS
2131 s++;
2132 goto reswitch;
6224f72b 2133 case 'T':
dc6d7f5c 2134#if defined(SILENT_NO_TAINT_SUPPORT)
284167a5 2135 /* silently ignore */
dc6d7f5c 2136#elif defined(NO_TAINT_SUPPORT)
3231f579 2137 Perl_croak_nocontext("This perl was compiled without taint support. "
284167a5
SM
2138 "Cowardly refusing to run with -t or -T flags");
2139#else
22f7c9c9 2140 CHECK_MALLOC_TOO_LATE_FOR('T');
284167a5
SM
2141 TAINTING_set(TRUE);
2142 TAINT_WARN_set(FALSE);
2143#endif
6224f72b
GS
2144 s++;
2145 goto reswitch;
f86702cc 2146
bc9b29db
RH
2147 case 'E':
2148 PL_minus_E = TRUE;
924ba076 2149 /* FALLTHROUGH */
6224f72b 2150 case 'e':
f20b2998 2151 forbid_setid('e', FALSE);
3280af22 2152 if (!PL_e_script) {
396482e1 2153 PL_e_script = newSVpvs("");
5486870f 2154 add_read_e_script = TRUE;
6224f72b
GS
2155 }
2156 if (*++s)
3280af22 2157 sv_catpv(PL_e_script, s);
6224f72b 2158 else if (argv[1]) {
3280af22 2159 sv_catpv(PL_e_script, argv[1]);
6224f72b
GS
2160 argc--,argv++;
2161 }
2162 else
47f56822 2163 Perl_croak(aTHX_ "No code specified for -%c", c);
396482e1 2164 sv_catpvs(PL_e_script, "\n");
6224f72b 2165 break;
afe37c7d 2166
20ef40cf 2167 case 'f':
f5542d3a 2168#ifdef USE_SITECUSTOMIZE
20ef40cf 2169 minus_f = TRUE;
f5542d3a 2170#endif
20ef40cf
GA
2171 s++;
2172 goto reswitch;
2173
6224f72b 2174 case 'I': /* -I handled both here and in moreswitches() */
f20b2998 2175 forbid_setid('I', FALSE);
bd61b366 2176 if (!*++s && (s=argv[1]) != NULL) {
6224f72b
GS
2177 argc--,argv++;
2178 }
6224f72b 2179 if (s && *s) {
0df16ed7 2180 STRLEN len = strlen(s);
55b4bc1c 2181 incpush(s, len, INCPUSH_ADD_SUB_DIRS|INCPUSH_ADD_OLD_VERS);
0df16ed7
GS
2182 }
2183 else
a67e862a 2184 Perl_croak(aTHX_ "No directory specified for -I");
6224f72b 2185 break;
6224f72b 2186 case 'S':
f20b2998 2187 forbid_setid('S', FALSE);
6224f72b
GS
2188 dosearch = TRUE;
2189 s++;
2190 goto reswitch;
2191 case 'V':
7edfd0ef
NC
2192 {
2193 SV *opts_prog;
2194
7edfd0ef 2195 if (*++s != ':') {
37ca4a5b 2196 opts_prog = newSVpvs("use Config; Config::_V()");
7edfd0ef
NC
2197 }
2198 else {
2199 ++s;
2200 opts_prog = Perl_newSVpvf(aTHX_
37ca4a5b 2201 "use Config; Config::config_vars(qw%c%s%c)",
7edfd0ef
NC
2202 0, s, 0);
2203 s += strlen(s);
2204 }
37ca4a5b 2205 Perl_av_create_and_push(aTHX_ &PL_preambleav, opts_prog);
7edfd0ef
NC
2206 /* don't look for script or read stdin */
2207 scriptname = BIT_BUCKET;
2208 goto reswitch;
6224f72b 2209 }
6224f72b 2210 case 'x':
737c24fc 2211 doextract = TRUE;
6224f72b 2212 s++;
304334da 2213 if (*s)
f4c556ac 2214 cddir = s;
6224f72b
GS
2215 break;
2216 case 0:
2217 break;
2218 case '-':
2219 if (!*++s || isSPACE(*s)) {
2220 argc--,argv++;
2221 goto switch_end;
2222 }
ee8bc8b7
NC
2223 /* catch use of gnu style long options.
2224 Both of these exit immediately. */
2225 if (strEQ(s, "version"))
2226 minus_v();
2227 if (strEQ(s, "help"))
2228 usage();
6224f72b 2229 s--;
924ba076 2230 /* FALLTHROUGH */
6224f72b 2231 default:
cea2e8a9 2232 Perl_croak(aTHX_ "Unrecognized switch: -%s (-h will show valid options)",s);
8d063cd8
LW
2233 }
2234 }
c7030b81
NC
2235 }
2236
6224f72b 2237 switch_end:
54310121 2238
c7030b81
NC
2239 {
2240 char *s;
2241
f675dbe5
CB
2242 if (
2243#ifndef SECURE_INTERNAL_GETENV
284167a5 2244 !TAINTING_get &&
f675dbe5 2245#endif
cf756827 2246 (s = PerlEnv_getenv("PERL5OPT")))
0df16ed7 2247 {
9e0b0d62
KW
2248 /* s points to static memory in getenv(), which may be overwritten at
2249 * any time; use a mortal copy instead */
2250 s = SvPVX(sv_2mortal(newSVpv(s, 0)));
2251
74288ac8
GS
2252 while (isSPACE(*s))
2253 s++;
317ea90d 2254 if (*s == '-' && *(s+1) == 'T') {
dc6d7f5c 2255#if defined(SILENT_NO_TAINT_SUPPORT)
284167a5 2256 /* silently ignore */
dc6d7f5c 2257#elif defined(NO_TAINT_SUPPORT)
3231f579 2258 Perl_croak_nocontext("This perl was compiled without taint support. "
284167a5
SM
2259 "Cowardly refusing to run with -t or -T flags");
2260#else
22f7c9c9 2261 CHECK_MALLOC_TOO_LATE_FOR('T');
284167a5
SM
2262 TAINTING_set(TRUE);
2263 TAINT_WARN_set(FALSE);
2264#endif
317ea90d 2265 }
74288ac8 2266 else {
bd61b366 2267 char *popt_copy = NULL;
74288ac8 2268 while (s && *s) {
54913509 2269 const char *d;
74288ac8
GS
2270 while (isSPACE(*s))
2271 s++;
2272 if (*s == '-') {
2273 s++;
2274 if (isSPACE(*s))
2275 continue;
2276 }
4ea8f8fb 2277 d = s;
74288ac8
GS
2278 if (!*s)
2279 break;
2b622f1a 2280 if (!strchr("CDIMUdmtwW", *s))
cea2e8a9 2281 Perl_croak(aTHX_ "Illegal switch in PERL5OPT: -%c", *s);
4ea8f8fb
MS
2282 while (++s && *s) {
2283 if (isSPACE(*s)) {
cf756827 2284 if (!popt_copy) {
bfa6c418
NC
2285 popt_copy = SvPVX(sv_2mortal(newSVpv(d,0)));
2286 s = popt_copy + (s - d);
2287 d = popt_copy;
cf756827 2288 }
4ea8f8fb
MS
2289 *s++ = '\0';
2290 break;
2291 }
2292 }
1c4db469 2293 if (*d == 't') {
dc6d7f5c 2294#if defined(SILENT_NO_TAINT_SUPPORT)
284167a5 2295 /* silently ignore */
dc6d7f5c 2296#elif defined(NO_TAINT_SUPPORT)
3231f579 2297 Perl_croak_nocontext("This perl was compiled without taint support. "
284167a5
SM
2298 "Cowardly refusing to run with -t or -T flags");
2299#else
2300 if( !TAINTING_get) {
2301 TAINT_WARN_set(TRUE);
2302 TAINTING_set(TRUE);
317ea90d 2303 }
284167a5 2304#endif
1c4db469 2305 } else {
97bd5664 2306 moreswitches(d);
1c4db469 2307 }
6224f72b 2308 }
6224f72b
GS
2309 }
2310 }
c7030b81 2311 }
a0d0e21e 2312
d6295071
TC
2313#ifndef NO_PERL_INTERNAL_RAND_SEED
2314 /* If we're not set[ug]id, we might have honored
2315 PERL_INTERNAL_RAND_SEED in perl_construct().
2316 At this point command-line options have been parsed, so if
2317 we're now tainting and not set[ug]id re-seed.
2318 This could possibly be wasteful if PERL_INTERNAL_RAND_SEED is invalid,
2319 but avoids duplicating the logic from perl_construct().
2320 */
2321 if (PL_tainting &&
2322 PerlProc_getuid() == PerlProc_geteuid() &&
2323 PerlProc_getgid() == PerlProc_getegid()) {
2324 Perl_drand48_init_r(&PL_internal_random_state, seed());
2325 }
2326#endif
2327
c29067d7
CH
2328 /* Set $^X early so that it can be used for relocatable paths in @INC */
2329 /* and for SITELIB_EXP in USE_SITECUSTOMIZE */
284167a5 2330 assert (!TAINT_get);
c29067d7 2331 TAINT;
e2051532 2332 set_caret_X();
c29067d7
CH
2333 TAINT_NOT;
2334
43c0c913 2335#if defined(USE_SITECUSTOMIZE)
20ef40cf 2336 if (!minus_f) {
43c0c913 2337 /* The games with local $! are to avoid setting errno if there is no
fc81b718
NC
2338 sitecustomize script. "q%c...%c", 0, ..., 0 becomes "q\0...\0",
2339 ie a q() operator with a NUL byte as a the delimiter. This avoids
2340 problems with pathnames containing (say) ' */
43c0c913
NC
2341# ifdef PERL_IS_MINIPERL
2342 AV *const inc = GvAV(PL_incgv);
2343 SV **const inc0 = inc ? av_fetch(inc, 0, FALSE) : NULL;
2344
2345 if (inc0) {
15870c5c
NC
2346 /* if lib/buildcustomize.pl exists, it should not fail. If it does,
2347 it should be reported immediately as a build failure. */
43c0c913
NC
2348 (void)Perl_av_create_and_unshift_one(aTHX_ &PL_preambleav,
2349 Perl_newSVpvf(aTHX_
147e3846 2350 "BEGIN { my $f = q%c%s%" SVf "/buildcustomize.pl%c; "
af26e4f2
FC
2351 "do {local $!; -f $f }"
2352 " and do $f || die $@ || qq '$f: $!' }",
5de87db5 2353 0, (TAINTING_get ? "./" : ""), SVfARG(*inc0), 0));
43c0c913
NC
2354 }
2355# else
2356 /* SITELIB_EXP is a function call on Win32. */
c29067d7 2357 const char *const raw_sitelib = SITELIB_EXP;
bac5c4fc
JD
2358 if (raw_sitelib) {
2359 /* process .../.. if PERL_RELOCATABLE_INC is defined */
2360 SV *sitelib_sv = mayberelocate(raw_sitelib, strlen(raw_sitelib),
2361 INCPUSH_CAN_RELOCATE);
2362 const char *const sitelib = SvPVX(sitelib_sv);
2363 (void)Perl_av_create_and_unshift_one(aTHX_ &PL_preambleav,
2364 Perl_newSVpvf(aTHX_
2365 "BEGIN { do {local $!; -f q%c%s/sitecustomize.pl%c} && do q%c%s/sitecustomize.pl%c }",
c1f6cd39
BF
2366 0, SVfARG(sitelib), 0,
2367 0, SVfARG(sitelib), 0));
bac5c4fc
JD
2368 assert (SvREFCNT(sitelib_sv) == 1);
2369 SvREFCNT_dec(sitelib_sv);
2370 }
43c0c913 2371# endif
20ef40cf
GA
2372 }
2373#endif
2374
6224f72b
GS
2375 if (!scriptname)
2376 scriptname = argv[0];
3280af22 2377 if (PL_e_script) {
6224f72b
GS
2378 argc++,argv--;
2379 scriptname = BIT_BUCKET; /* don't look for script or read stdin */
2380 }
bd61b366 2381 else if (scriptname == NULL) {
6224f72b
GS
2382#ifdef MSDOS
2383 if ( PerlLIO_isatty(PerlIO_fileno(PerlIO_stdin())) )
97bd5664 2384 moreswitches("h");
6224f72b
GS
2385#endif
2386 scriptname = "-";
2387 }
2388
284167a5 2389 assert (!TAINT_get);
2cace6ac 2390 init_perllib();
6224f72b 2391
a52eba0e 2392 {
f20b2998 2393 bool suidscript = FALSE;
829372d3 2394
8d113837 2395 rsfp = open_script(scriptname, dosearch, &suidscript);
c0b3891a
NC
2396 if (!rsfp) {
2397 rsfp = PerlIO_stdin();
87606032 2398 lex_start_flags = LEX_DONT_CLOSE_RSFP;
c0b3891a 2399 }
6224f72b 2400
b24bc095 2401 validate_suid(rsfp);
6224f72b 2402
64ca3a65 2403#ifndef PERL_MICRO
a52eba0e
NC
2404# if defined(SIGCHLD) || defined(SIGCLD)
2405 {
2406# ifndef SIGCHLD
2407# define SIGCHLD SIGCLD
2408# endif
2409 Sighandler_t sigstate = rsignal_state(SIGCHLD);
2410 if (sigstate == (Sighandler_t) SIG_IGN) {
a2a5de95
NC
2411 Perl_ck_warner(aTHX_ packWARN(WARN_SIGNAL),
2412 "Can't ignore signal CHLD, forcing to default");
a52eba0e
NC
2413 (void)rsignal(SIGCHLD, (Sighandler_t)SIG_DFL);
2414 }
0b5b802d 2415 }
a52eba0e 2416# endif
64ca3a65 2417#endif
0b5b802d 2418
737c24fc 2419 if (doextract) {
faef540c 2420
f20b2998 2421 /* This will croak if suidscript is true, as -x cannot be used with
faef540c
NC
2422 setuid scripts. */
2423 forbid_setid('x', suidscript);
f20b2998 2424 /* Hence you can't get here if suidscript is true */
faef540c 2425
95670bde
NC
2426 linestr_sv = newSV_type(SVt_PV);
2427 lex_start_flags |= LEX_START_COPIED;
2f9285f8 2428 find_beginning(linestr_sv, rsfp);
a52eba0e
NC
2429 if (cddir && PerlDir_chdir( (char *)cddir ) < 0)
2430 Perl_croak(aTHX_ "Can't chdir to %s",cddir);
2431 }
f4c556ac 2432 }
6224f72b 2433
ea726b52 2434 PL_main_cv = PL_compcv = MUTABLE_CV(newSV_type(SVt_PVCV));
3280af22
NIS
2435 CvUNIQUE_on(PL_compcv);
2436
eacbb379 2437 CvPADLIST_set(PL_compcv, pad_new(0));
6224f72b 2438
dd69841b
BB
2439 PL_isarev = newHV();
2440
0c4f7ff0 2441 boot_core_PerlIO();
6224f72b 2442 boot_core_UNIVERSAL();
e1a479c5 2443 boot_core_mro();
4a5df386 2444 newXS("Internals::V", S_Internals_V, __FILE__);
6224f72b
GS
2445
2446 if (xsinit)
acfe0abc 2447 (*xsinit)(aTHX); /* in case linked C routines want magical variables */
64ca3a65 2448#ifndef PERL_MICRO
739a0b84 2449#if defined(VMS) || defined(WIN32) || defined(DJGPP) || defined(__CYGWIN__) || defined(SYMBIAN)
c5be433b 2450 init_os_extras();
6224f72b 2451#endif
64ca3a65 2452#endif
6224f72b 2453
29209bc5 2454#ifdef USE_SOCKS
1b9c9cf5
DH
2455# ifdef HAS_SOCKS5_INIT
2456 socks5_init(argv[0]);
2457# else
29209bc5 2458 SOCKSinit(argv[0]);
1b9c9cf5 2459# endif
ac27b0f5 2460#endif
29209bc5 2461
6224f72b
GS
2462 init_predump_symbols();
2463 /* init_postdump_symbols not currently designed to be called */
2464 /* more than once (ENV isn't cleared first, for example) */
2465 /* But running with -u leaves %ENV & @ARGV undefined! XXX */
3280af22 2466 if (!PL_do_undump)
6224f72b
GS
2467 init_postdump_symbols(argc,argv,env);
2468
27da23d5
JH
2469 /* PL_unicode is turned on by -C, or by $ENV{PERL_UNICODE},
2470 * or explicitly in some platforms.
73e1bd1a 2471 * PL_utf8locale is conditionally turned on by
085a54d9 2472 * locale.c:Perl_init_i18nl10n() if the environment
a05d7ebb 2473 * look like the user wants to use UTF-8. */
a0fd4948 2474#if defined(__SYMBIAN32__)
27da23d5
JH
2475 PL_unicode = PERL_UNICODE_STD_FLAG; /* See PERL_SYMBIAN_CONSOLE_UTF8. */
2476#endif
e27b5b51 2477# ifndef PERL_IS_MINIPERL
06e66572
JH
2478 if (PL_unicode) {
2479 /* Requires init_predump_symbols(). */
a05d7ebb 2480 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
06e66572
JH
2481 IO* io;
2482 PerlIO* fp;
2483 SV* sv;
2484
a05d7ebb 2485 /* Turn on UTF-8-ness on STDIN, STDOUT, STDERR
06e66572 2486 * and the default open disciplines. */
a05d7ebb
JH
2487 if ((PL_unicode & PERL_UNICODE_STDIN_FLAG) &&
2488 PL_stdingv && (io = GvIO(PL_stdingv)) &&
2489 (fp = IoIFP(io)))
2490 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2491 if ((PL_unicode & PERL_UNICODE_STDOUT_FLAG) &&
2492 PL_defoutgv && (io = GvIO(PL_defoutgv)) &&
2493 (fp = IoOFP(io)))
2494 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2495 if ((PL_unicode & PERL_UNICODE_STDERR_FLAG) &&
2496 PL_stderrgv && (io = GvIO(PL_stderrgv)) &&
2497 (fp = IoOFP(io)))
2498 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2499 if ((PL_unicode & PERL_UNICODE_INOUT_FLAG) &&
fafc274c
NC
2500 (sv = GvSV(gv_fetchpvs("\017PEN", GV_ADD|GV_NOTQUAL,
2501 SVt_PV)))) {
a05d7ebb
JH
2502 U32 in = PL_unicode & PERL_UNICODE_IN_FLAG;
2503 U32 out = PL_unicode & PERL_UNICODE_OUT_FLAG;
2504 if (in) {
2505 if (out)
76f68e9b 2506 sv_setpvs(sv, ":utf8\0:utf8");
a05d7ebb 2507 else
76f68e9b 2508 sv_setpvs(sv, ":utf8\0");
a05d7ebb
JH
2509 }
2510 else if (out)
76f68e9b 2511 sv_setpvs(sv, "\0:utf8");
a05d7ebb
JH
2512 SvSETMAGIC(sv);
2513 }
b310b053
JH
2514 }
2515 }
e27b5b51 2516#endif
b310b053 2517
c7030b81
NC
2518 {
2519 const char *s;
4ffa73a3
JH
2520 if ((s = PerlEnv_getenv("PERL_SIGNALS"))) {
2521 if (strEQ(s, "unsafe"))
2522 PL_signals |= PERL_SIGNALS_UNSAFE_FLAG;
2523 else if (strEQ(s, "safe"))
2524 PL_signals &= ~PERL_SIGNALS_UNSAFE_FLAG;
2525 else
2526 Perl_croak(aTHX_ "PERL_SIGNALS illegal: \"%s\"", s);
2527 }
c7030b81 2528 }
4ffa73a3 2529
81d86705 2530
87606032 2531 lex_start(linestr_sv, rsfp, lex_start_flags);
d2687c98 2532 SvREFCNT_dec(linestr_sv);
95670bde 2533
219f7226 2534 PL_subname = newSVpvs("main");
6224f72b 2535
5486870f
DM
2536 if (add_read_e_script)
2537 filter_add(read_e_script, NULL);
2538
6224f72b
GS
2539 /* now parse the script */
2540
93189314 2541 SETERRNO(0,SS_NORMAL);
28ac2b49 2542 if (yyparse(GRAMPROG) || PL_parser->error_count) {
c77da5ff 2543 abort_execution("", PL_origfilename);
6224f72b 2544 }
57843af0 2545 CopLINE_set(PL_curcop, 0);
03d9f026 2546 SET_CURSTASH(PL_defstash);
3280af22
NIS
2547 if (PL_e_script) {
2548 SvREFCNT_dec(PL_e_script);
a0714e2c 2549 PL_e_script = NULL;
6224f72b
GS
2550 }
2551
3280af22 2552 if (PL_do_undump)
6224f72b
GS
2553 my_unexec();
2554
57843af0
GS
2555 if (isWARN_ONCE) {
2556 SAVECOPFILE(PL_curcop);
2557 SAVECOPLINE(PL_curcop);
3280af22 2558 gv_check(PL_defstash);
57843af0 2559 }
6224f72b
GS
2560
2561 LEAVE;
2562 FREETMPS;
2563
2564#ifdef MYMALLOC
f6a607bc
RGS
2565 {
2566 const char *s;
22ff3130
HS
2567 UV uv;
2568 s = PerlEnv_getenv("PERL_DEBUG_MSTATS");
2569 if (s && grok_atoUV(s, &uv, NULL) && uv >= 2)
96e440d2 2570 dump_mstats("after compilation:");
f6a607bc 2571 }
6224f72b
GS
2572#endif
2573
2574 ENTER;
febb3a6d 2575 PL_restartjmpenv = NULL;
3280af22 2576 PL_restartop = 0;
312caa8e 2577 return NULL;
6224f72b
GS
2578}
2579
954c1994 2580/*
0301e899
Z
2581=for apidoc Am|int|perl_run|PerlInterpreter *my_perl
2582
2583Tells a Perl interpreter to run its main program. See L<perlembed>
2584for a tutorial.
2585
2586C<my_perl> points to the Perl interpreter. It must have been previously
2587created through the use of L</perl_alloc> and L</perl_construct>, and
2588initialised through L</perl_parse>. This function should not be called
2589if L</perl_parse> returned a non-zero value, indicating a failure in
2590initialisation or compilation.
2591
2592This function executes code in C<INIT> blocks, and then executes the
2593main program. The code to be executed is that established by the prior
2594call to L</perl_parse>. If the interpreter's C<PL_exit_flags> word
2595does not have the C<PERL_EXIT_DESTRUCT_END> flag set, then this function
2596will also execute code in C<END> blocks. If it is desired to make any
2597further use of the interpreter after calling this function, then C<END>
2598blocks should be postponed to L</perl_destruct> time by setting that flag.
2599
2600Returns an integer of slightly tricky interpretation. The correct use
2601of the return value is as a truth value indicating whether the program
2602terminated non-locally. If zero is returned, this indicates that
2603the program ran to completion, and it is safe to make other use of the
2604interpreter (provided that the C<PERL_EXIT_DESTRUCT_END> flag was set as
2605described above). If a non-zero value is returned, this indicates that
2606the interpreter wants to terminate early. The interpreter should not be
2607just abandoned because of this desire to terminate; the caller should
2608proceed to shut the interpreter down cleanly with L</perl_destruct>
2609and free it with L</perl_free>.
2610
2611For historical reasons, the non-zero return value also attempts to
2612be a suitable value to pass to the C library function C<exit> (or to
2613return from C<main>), to serve as an exit code indicating the nature of
2614the way the program terminated. However, this isn't portable, due to
2615differing exit code conventions. An attempt is made to return an exit
2616code of the type required by the host operating system, but because
2617it is constrained to be non-zero, it is not necessarily possible to
2618indicate every type of exit. It is only reliable on Unix, where a zero
2619exit code can be augmented with a set bit that will be ignored. In any
2620case, this function is not the correct place to acquire an exit code:
2621one should get that from L</perl_destruct>.
954c1994
GS
2622
2623=cut
2624*/
2625
6224f72b 2626int
0cb96387 2627perl_run(pTHXx)
6224f72b 2628{
6224f72b 2629 I32 oldscope;
0301e899 2630 int ret = 0, exit_called = 0;
db36c5a1 2631 dJMPENV;
6224f72b 2632
7918f24d
NC
2633 PERL_ARGS_ASSERT_PERL_RUN;
2634#ifndef MULTIPLICITY
ed6c66dd 2635 PERL_UNUSED_ARG(my_perl);
7918f24d 2636#endif
9d4ba2ae 2637
3280af22 2638 oldscope = PL_scopestack_ix;
96e176bf
CL
2639#ifdef VMS
2640 VMSISH_HUSHED = 0;
2641#endif
6224f72b 2642
14dd3ad8 2643 JMPENV_PUSH(ret);
6224f72b
GS
2644 switch (ret) {
2645 case 1:
2646 cxstack_ix = -1; /* start context stack again */
312caa8e 2647 goto redo_body;
14dd3ad8 2648 case 0: /* normal completion */
14dd3ad8
GS
2649 redo_body:
2650 run_body(oldscope);
0301e899 2651 goto handle_exit;
14dd3ad8 2652 case 2: /* my_exit() */
0301e899
Z
2653 exit_called = 1;
2654 handle_exit:
3280af22 2655 while (PL_scopestack_ix > oldscope)
6224f72b
GS
2656 LEAVE;
2657 FREETMPS;
03d9f026 2658 SET_CURSTASH(PL_defstash);
3a1ee7e8 2659 if (!(PL_exit_flags & PERL_EXIT_DESTRUCT_END) &&
9ebf26ad 2660 PL_endav && !PL_minus_c) {
ca7b837b 2661 PERL_SET_PHASE(PERL_PHASE_END);
31d77e54 2662 call_list(oldscope, PL_endav);
9ebf26ad 2663 }
6224f72b
GS
2664#ifdef MYMALLOC
2665 if (PerlEnv_getenv("PERL_DEBUG_MSTATS"))
2666 dump_mstats("after execution: ");
2667#endif
0301e899
Z
2668 if (exit_called) {
2669 ret = STATUS_EXIT;
2670 if (ret == 0) ret = 0x100;
2671 } else {
2672 ret = 0;
2673 }
14dd3ad8 2674 break;
6224f72b 2675 case 3:
312caa8e
CS
2676 if (PL_restartop) {
2677 POPSTACK_TO(PL_mainstack);
2678 goto redo_body;
6224f72b 2679 }
5637ef5b 2680 PerlIO_printf(Perl_error_log, "panic: restartop in perl_run\n");
312caa8e 2681 FREETMPS;
14dd3ad8
GS
2682 ret = 1;
2683 break;
6224f72b
GS
2684 }
2685
14dd3ad8
GS
2686 JMPENV_POP;
2687 return ret;
312caa8e
CS
2688}
2689
dd374669 2690STATIC void
14dd3ad8
GS
2691S_run_body(pTHX_ I32 oldscope)
2692{
d3b97530
DM
2693 DEBUG_r(PerlIO_printf(Perl_debug_log, "%s $` $& $' support (0x%x).\n",
2694 PL_sawampersand ? "Enabling" : "Omitting",
2695 (unsigned int)(PL_sawampersand)));
6224f72b 2696
3280af22 2697 if (!PL_restartop) {
cf2782cd 2698#ifdef DEBUGGING
f0e3f042
CS
2699 if (DEBUG_x_TEST || DEBUG_B_TEST)
2700 dump_all_perl(!DEBUG_B_TEST);
ecae49c0
NC
2701 if (!DEBUG_q_TEST)
2702 PERL_DEBUG(PerlIO_printf(Perl_debug_log, "\nEXECUTING...\n\n"));
cf2782cd 2703#endif
6224f72b 2704
3280af22 2705 if (PL_minus_c) {
bf49b057 2706 PerlIO_printf(Perl_error_log, "%s syntax OK\n", PL_origfilename);
6224f72b
GS
2707 my_exit(0);
2708 }
3280af22 2709 if (PERLDB_SINGLE && PL_DBsingle)
a6d69523 2710 PL_DBsingle_iv = 1;
9ebf26ad 2711 if (PL_initav) {
ca7b837b 2712 PERL_SET_PHASE(PERL_PHASE_INIT);
3280af22 2713 call_list(oldscope, PL_initav);
9ebf26ad 2714 }
f1fac472 2715#ifdef PERL_DEBUG_READONLY_OPS
3107b51f
FC
2716 if (PL_main_root && PL_main_root->op_slabbed)
2717 Slab_to_ro(OpSLAB(PL_main_root));
f1fac472 2718#endif
6224f72b
GS
2719 }
2720
2721 /* do it */
2722
ca7b837b 2723 PERL_SET_PHASE(PERL_PHASE_RUN);
9ebf26ad 2724
3280af22 2725 if (PL_restartop) {
febb3a6d 2726 PL_restartjmpenv = NULL;
533c011a 2727 PL_op = PL_restartop;
3280af22 2728 PL_restartop = 0;
cea2e8a9 2729 CALLRUNOPS(aTHX);
6224f72b 2730 }
3280af22
NIS
2731 else if (PL_main_start) {
2732 CvDEPTH(PL_main_cv) = 1;
533c011a 2733 PL_op = PL_main_start;
cea2e8a9 2734 CALLRUNOPS(aTHX);
6224f72b 2735 }
f6b3007c 2736 my_exit(0);
e5964223 2737 NOT_REACHED; /* NOTREACHED */
6224f72b
GS
2738}
2739
954c1994 2740/*
ccfc67b7
JH
2741=head1 SV Manipulation Functions
2742
954c1994
GS
2743=for apidoc p||get_sv
2744
64ace3f8 2745Returns the SV of the specified Perl scalar. C<flags> are passed to
72d33970 2746C<gv_fetchpv>. If C<GV_ADD> is set and the
64ace3f8
NC
2747Perl variable does not exist then it will be created. If C<flags> is zero
2748and the variable does not exist then NULL is returned.
954c1994
GS
2749
2750=cut
2751*/
2752
6224f72b 2753SV*
64ace3f8 2754Perl_get_sv(pTHX_ const char *name, I32 flags)
6224f72b
GS
2755{
2756 GV *gv;
7918f24d
NC
2757
2758 PERL_ARGS_ASSERT_GET_SV;
2759
64ace3f8 2760 gv = gv_fetchpv(name, flags, SVt_PV);
6224f72b
GS
2761 if (gv)
2762 return GvSV(gv);
a0714e2c 2763 return NULL;
6224f72b
GS
2764}
2765
954c1994 2766/*
ccfc67b7
JH
2767=head1 Array Manipulation Functions
2768
954c1994
GS
2769=for apidoc p||get_av
2770
f0b90de1
SF
2771Returns the AV of the specified Perl global or package array with the given
2772name (so it won't work on lexical variables). C<flags> are passed
72d33970 2773to C<gv_fetchpv>. If C<GV_ADD> is set and the
cbfd0a87
NC
2774Perl variable does not exist then it will be created. If C<flags> is zero
2775and the variable does not exist then NULL is returned.
954c1994 2776
f0b90de1
SF
2777Perl equivalent: C<@{"$name"}>.
2778
954c1994
GS
2779=cut
2780*/
2781
6224f72b 2782AV*
cbfd0a87 2783Perl_get_av(pTHX_ const char *name, I32 flags)
6224f72b 2784{
cbfd0a87 2785 GV* const gv = gv_fetchpv(name, flags, SVt_PVAV);
7918f24d
NC
2786
2787 PERL_ARGS_ASSERT_GET_AV;
2788
cbfd0a87 2789 if (flags)
6224f72b
GS
2790 return GvAVn(gv);
2791 if (gv)
2792 return GvAV(gv);
7d49f689 2793 return NULL;
6224f72b
GS
2794}
2795
954c1994 2796/*
ccfc67b7
JH
2797=head1 Hash Manipulation Functions
2798
954c1994
GS
2799=for apidoc p||get_hv
2800
6673a63c 2801Returns the HV of the specified Perl hash. C<flags> are passed to
72d33970 2802C<gv_fetchpv>. If C<GV_ADD> is set and the
6673a63c 2803Perl variable does not exist then it will be created. If C<flags> is zero
796b6530 2804and the variable does not exist then C<NULL> is returned.
954c1994
GS
2805
2806=cut
2807*/
2808
6224f72b 2809HV*
6673a63c 2810Perl_get_hv(pTHX_ const char *name, I32 flags)
6224f72b 2811{
6673a63c 2812 GV* const gv = gv_fetchpv(name, flags, SVt_PVHV);
7918f24d
NC
2813
2814 PERL_ARGS_ASSERT_GET_HV;
2815
6673a63c 2816 if (flags)
a0d0e21e
LW
2817 return GvHVn(gv);
2818 if (gv)
2819 return GvHV(gv);
5c284bb0 2820 return NULL;
a0d0e21e
LW
2821}
2822
954c1994 2823/*
ccfc67b7
JH
2824=head1 CV Manipulation Functions
2825
780a5241
NC
2826=for apidoc p||get_cvn_flags
2827
2828Returns the CV of the specified Perl subroutine. C<flags> are passed to
72d33970 2829C<gv_fetchpvn_flags>. If C<GV_ADD> is set and the Perl subroutine does not
780a5241
NC
2830exist then it will be declared (which has the same effect as saying
2831C<sub name;>). If C<GV_ADD> is not set and the subroutine does not exist
2832then NULL is returned.
2833
954c1994
GS
2834=for apidoc p||get_cv
2835
780a5241 2836Uses C<strlen> to get the length of C<name>, then calls C<get_cvn_flags>.
954c1994
GS
2837
2838=cut
2839*/
2840
a0d0e21e 2841CV*
780a5241 2842Perl_get_cvn_flags(pTHX_ const char *name, STRLEN len, I32 flags)
a0d0e21e 2843{
780a5241 2844 GV* const gv = gv_fetchpvn_flags(name, len, flags, SVt_PVCV);
7918f24d
NC
2845
2846 PERL_ARGS_ASSERT_GET_CVN_FLAGS;
2847
a385812b 2848 if (gv && UNLIKELY(SvROK(gv)) && SvTYPE(SvRV((SV *)gv)) == SVt_PVCV)
e05a85b2 2849 return (CV*)SvRV((SV *)gv);
a385812b 2850
334dda80
FC
2851 /* XXX this is probably not what they think they're getting.
2852 * It has the same effect as "sub name;", i.e. just a forward
2853 * declaration! */
780a5241 2854 if ((flags & ~GV_NOADD_MASK) && !GvCVu(gv)) {
186a5ba8 2855 return newSTUB(gv,0);
780a5241 2856 }
a0d0e21e 2857 if (gv)
8ebc5c01 2858 return GvCVu(gv);
601f1833 2859 return NULL;
a0d0e21e
LW
2860}
2861
2c67934f
NC
2862/* Nothing in core calls this now, but we can't replace it with a macro and
2863 move it to mathoms.c as a macro would evaluate name twice. */
780a5241
NC
2864CV*
2865Perl_get_cv(pTHX_ const char *name, I32 flags)
2866{
7918f24d
NC
2867 PERL_ARGS_ASSERT_GET_CV;
2868
780a5241
NC
2869 return get_cvn_flags(name, strlen(name), flags);
2870}
2871
79072805
LW
2872/* Be sure to refetch the stack pointer after calling these routines. */
2873
954c1994 2874/*
ccfc67b7
JH
2875
2876=head1 Callback Functions
2877
954c1994
GS
2878=for apidoc p||call_argv
2879
f0b90de1 2880Performs a callback to the specified named and package-scoped Perl subroutine
796b6530 2881with C<argv> (a C<NULL>-terminated array of strings) as arguments. See
72d33970 2882L<perlcall>.
f0b90de1
SF
2883
2884Approximate Perl equivalent: C<&{"$sub_name"}(@$argv)>.
954c1994
GS
2885
2886=cut
2887*/
2888
a0d0e21e 2889I32
5aaab254 2890Perl_call_argv(pTHX_ const char *sub_name, I32 flags, char **argv)
ac27b0f5 2891
8ac85365
NIS
2892 /* See G_* flags in cop.h */
2893 /* null terminated arg list */
8990e307 2894{
a0d0e21e 2895 dSP;
8990e307 2896
7918f24d
NC
2897 PERL_ARGS_ASSERT_CALL_ARGV;
2898
924508f0 2899 PUSHMARK(SP);
3dc78631
DM
2900 while (*argv) {
2901 mXPUSHs(newSVpv(*argv,0));
2902 argv++;
8990e307 2903 }
3dc78631 2904 PUTBACK;
864dbfa3 2905 return call_pv(sub_name, flags);
8990e307
LW
2906}
2907
954c1994
GS
2908/*
2909=for apidoc p||call_pv
2910
2911Performs a callback to the specified Perl sub. See L<perlcall>.
2912
2913=cut
2914*/
2915
a0d0e21e 2916I32
864dbfa3 2917Perl_call_pv(pTHX_ const char *sub_name, I32 flags)
8ac85365
NIS
2918 /* name of the subroutine */
2919 /* See G_* flags in cop.h */
a0d0e21e 2920{
7918f24d
NC
2921 PERL_ARGS_ASSERT_CALL_PV;
2922
0da0e728 2923 return call_sv(MUTABLE_SV(get_cv(sub_name, GV_ADD)), flags);
a0d0e21e
LW
2924}
2925
954c1994
GS
2926/*
2927=for apidoc p||call_method
2928
2929Performs a callback to the specified Perl method. The blessed object must
2930be on the stack. See L<perlcall>.
2931
2932=cut
2933*/
2934
a0d0e21e 2935I32
864dbfa3 2936Perl_call_method(pTHX_ const char *methname, I32 flags)
8ac85365
NIS
2937 /* name of the subroutine */
2938 /* See G_* flags in cop.h */
a0d0e21e 2939{
46ca9bac 2940 STRLEN len;
c106c2be 2941 SV* sv;
7918f24d
NC
2942 PERL_ARGS_ASSERT_CALL_METHOD;
2943
46ca9bac 2944 len = strlen(methname);
c106c2be
RZ
2945 sv = flags & G_METHOD_NAMED
2946 ? sv_2mortal(newSVpvn_share(methname, len,0))
2947 : newSVpvn_flags(methname, len, SVs_TEMP);
46ca9bac 2948
c106c2be 2949 return call_sv(sv, flags | G_METHOD);
a0d0e21e
LW
2950}
2951
2952/* May be called with any of a CV, a GV, or an SV containing the name. */
954c1994
GS
2953/*
2954=for apidoc p||call_sv
2955
078e2213
TC
2956Performs a callback to the Perl sub specified by the SV.
2957
7c0c544c 2958If neither the C<G_METHOD> nor C<G_METHOD_NAMED> flag is supplied, the
078e2213
TC
2959SV may be any of a CV, a GV, a reference to a CV, a reference to a GV
2960or C<SvPV(sv)> will be used as the name of the sub to call.
2961
2962If the C<G_METHOD> flag is supplied, the SV may be a reference to a CV or
2963C<SvPV(sv)> will be used as the name of the method to call.
2964
2965If the C<G_METHOD_NAMED> flag is supplied, C<SvPV(sv)> will be used as
2966the name of the method to call.
2967
2968Some other values are treated specially for internal use and should
2969not be depended on.
2970
2971See L<perlcall>.
954c1994
GS
2972
2973=cut
2974*/
2975
a0d0e21e 2976I32
8162b70e 2977Perl_call_sv(pTHX_ SV *sv, volatile I32 flags)
8ac85365 2978 /* See G_* flags in cop.h */
a0d0e21e 2979{
5b434c73 2980 dVAR;
a0d0e21e 2981 LOGOP myop; /* fake syntax tree node */
b46e009d 2982 METHOP method_op;
aa689395 2983 I32 oldmark;
8162b70e 2984 volatile I32 retval = 0;
54310121 2985 bool oldcatch = CATCH_GET;
6224f72b 2986 int ret;
c4420975 2987 OP* const oldop = PL_op;
db36c5a1 2988 dJMPENV;
1e422769 2989
7918f24d
NC
2990 PERL_ARGS_ASSERT_CALL_SV;
2991
a0d0e21e
LW
2992 if (flags & G_DISCARD) {
2993 ENTER;
2994 SAVETMPS;
2995 }
2f8edad0
NC
2996 if (!(flags & G_WANT)) {
2997 /* Backwards compatibility - as G_SCALAR was 0, it could be omitted.
2998 */
2999 flags |= G_SCALAR;
3000 }
a0d0e21e 3001
aa689395 3002 Zero(&myop, 1, LOGOP);
f51d4af5 3003 if (!(flags & G_NOARGS))
aa689395 3004 myop.op_flags |= OPf_STACKED;
4f911530 3005 myop.op_flags |= OP_GIMME_REVERSE(flags);
462e5cf6 3006 SAVEOP();
533c011a 3007 PL_op = (OP*)&myop;
aa689395 3008
8c9009ad 3009 if (!(flags & G_METHOD_NAMED)) {
5b434c73
DD
3010 dSP;
3011 EXTEND(SP, 1);
8c9009ad
DD
3012 PUSHs(sv);
3013 PUTBACK;
5b434c73 3014 }
aa689395 3015 oldmark = TOPMARK;
a0d0e21e 3016
3280af22 3017 if (PERLDB_SUB && PL_curstash != PL_debstash
36477c24 3018 /* Handle first BEGIN of -d. */
3280af22 3019 && (PL_DBcv || (PL_DBcv = GvCV(PL_DBsub)))
36477c24
PP
3020 /* Try harder, since this may have been a sighandler, thus
3021 * curstash may be meaningless. */
ea726b52 3022 && (SvTYPE(sv) != SVt_PVCV || CvSTASH((const CV *)sv) != PL_debstash)
491527d0 3023 && !(flags & G_NODEBUG))
5ff48db8 3024 myop.op_private |= OPpENTERSUB_DB;
a0d0e21e 3025
c106c2be 3026 if (flags & (G_METHOD|G_METHOD_NAMED)) {
b46e009d 3027 Zero(&method_op, 1, METHOP);
3028 method_op.op_next = (OP*)&myop;
3029 PL_op = (OP*)&method_op;
c106c2be 3030 if ( flags & G_METHOD_NAMED ) {
b46e009d 3031 method_op.op_ppaddr = PL_ppaddr[OP_METHOD_NAMED];
3032 method_op.op_type = OP_METHOD_NAMED;
3033 method_op.op_u.op_meth_sv = sv;
c106c2be 3034 } else {
b46e009d 3035 method_op.op_ppaddr = PL_ppaddr[OP_METHOD];
3036 method_op.op_type = OP_METHOD;
c106c2be
RZ
3037 }
3038 myop.op_ppaddr = PL_ppaddr[OP_ENTERSUB];
3039 myop.op_type = OP_ENTERSUB;
968b3946
GS
3040 }
3041
312caa8e 3042 if (!(flags & G_EVAL)) {
0cdb2077 3043 CATCH_SET(TRUE);
d6f07c05 3044 CALL_BODY_SUB((OP*)&myop);
312caa8e 3045 retval = PL_stack_sp - (PL_stack_base + oldmark);
0253cb41 3046 CATCH_SET(oldcatch);
312caa8e
CS
3047 }
3048 else {
8e90e786 3049 I32 old_cxix;
d78bda3d 3050 myop.op_other = (OP*)&myop;
101d6365 3051 (void)POPMARK;
8e90e786 3052 old_cxix = cxstack_ix;
274ed8ae 3053 create_eval_scope(NULL, flags|G_FAKINGEVAL);
c318a6ee 3054 INCMARK;
a0d0e21e 3055
14dd3ad8 3056 JMPENV_PUSH(ret);
edb2152a 3057
6224f72b
GS
3058 switch (ret) {
3059 case 0:
14dd3ad8 3060 redo_body:
d6f07c05 3061 CALL_BODY_SUB((OP*)&myop);
312caa8e 3062 retval = PL_stack_sp - (PL_stack_base + oldmark);
8433848b 3063 if (!(flags & G_KEEPERR)) {
ab69dbc2 3064 CLEAR_ERRSV();
8433848b 3065 }
a0d0e21e 3066 break;
6224f72b 3067 case 1:
f86702cc 3068 STATUS_ALL_FAILURE;
924ba076 3069 /* FALLTHROUGH */
6224f72b 3070 case 2:
a0d0e21e 3071 /* my_exit() was called */
03d9f026 3072 SET_CURSTASH(PL_defstash);
a0d0e21e 3073 FREETMPS;
14dd3ad8 3074 JMPENV_POP;
f86702cc 3075 my_exit_jump();
e5964223 3076 NOT_REACHED; /* NOTREACHED */
6224f72b 3077 case 3:
3280af22 3078 if (PL_restartop) {
febb3a6d 3079 PL_restartjmpenv = NULL;
533c011a 3080 PL_op = PL_restartop;
3280af22 3081 PL_restartop = 0;
312caa8e 3082 goto redo_body;
a0d0e21e 3083 }
3280af22 3084 PL_stack_sp = PL_stack_base + oldmark;
51ce5529 3085 if ((flags & G_WANT) == G_ARRAY)
a0d0e21e
LW
3086 retval = 0;
3087 else {
3088 retval = 1;
3280af22 3089 *++PL_stack_sp = &PL_sv_undef;
a0d0e21e 3090 }
312caa8e 3091 break;
a0d0e21e 3092 }
a0d0e21e 3093
8e90e786
DM
3094 /* if we croaked, depending on how we croaked the eval scope
3095 * may or may not have already been popped */
3096 if (cxstack_ix > old_cxix) {
3097 assert(cxstack_ix == old_cxix + 1);
4ebe6e95 3098 assert(CxTYPE(CX_CUR()) == CXt_EVAL);
edb2152a 3099 delete_eval_scope();
8e90e786 3100 }
14dd3ad8 3101 JMPENV_POP;
a0d0e21e 3102 }
1e422769 3103
a0d0e21e 3104 if (flags & G_DISCARD) {
3280af22 3105 PL_stack_sp = PL_stack_base + oldmark;
a0d0e21e
LW
3106 retval = 0;
3107 FREETMPS;
3108 LEAVE;
3109 }
533c011a 3110 PL_op = oldop;
a0d0e21e
LW
3111 return retval;
3112}
3113
6e72f9df 3114/* Eval a string. The G_EVAL flag is always assumed. */
8990e307 3115
954c1994
GS
3116/*
3117=for apidoc p||eval_sv
3118
72d33970 3119Tells Perl to C<eval> the string in the SV. It supports the same flags
796b6530 3120as C<call_sv>, with the obvious exception of C<G_EVAL>. See L<perlcall>.
954c1994
GS
3121
3122=cut
3123*/
3124
a0d0e21e 3125I32
864dbfa3 3126Perl_eval_sv(pTHX_ SV *sv, I32 flags)
ac27b0f5 3127
8ac85365 3128 /* See G_* flags in cop.h */
a0d0e21e 3129{
97aff369 3130 dVAR;
a0d0e21e 3131 UNOP myop; /* fake syntax tree node */
8162b70e
AC
3132 volatile I32 oldmark;
3133 volatile I32 retval = 0;
6224f72b 3134 int ret;
c4420975 3135 OP* const oldop = PL_op;
db36c5a1 3136 dJMPENV;
84902520 3137
7918f24d
NC
3138 PERL_ARGS_ASSERT_EVAL_SV;
3139
4633a7c4
LW
3140 if (flags & G_DISCARD) {
3141 ENTER;
3142 SAVETMPS;
3143 }
3144
462e5cf6 3145 SAVEOP();
533c011a 3146 PL_op = (OP*)&myop;
5ff48db8 3147 Zero(&myop, 1, UNOP);
5b434c73
DD
3148 {
3149 dSP;
3150 oldmark = SP - PL_stack_base;
3151 EXTEND(SP, 1);
3152 PUSHs(sv);
3153 PUTBACK;
3154 }
79072805 3155
4633a7c4
LW
3156 if (!(flags & G_NOARGS))
3157 myop.op_flags = OPf_STACKED;
6e72f9df 3158 myop.op_type = OP_ENTEREVAL;
4f911530 3159 myop.op_flags |= OP_GIMME_REVERSE(flags);
6e72f9df
PP
3160 if (flags & G_KEEPERR)
3161 myop.op_flags |= OPf_SPECIAL;
a1941760
DM
3162
3163 if (flags & G_RE_REPARSING)
3164 myop.op_private = (OPpEVAL_COPHH | OPpEVAL_RE_REPARSING);
4633a7c4 3165
dedbcade 3166 /* fail now; otherwise we could fail after the JMPENV_PUSH but
13febba5 3167 * before a cx_pusheval(), which corrupts the stack after a croak */
dedbcade
DM
3168 TAINT_PROPER("eval_sv()");
3169
14dd3ad8 3170 JMPENV_PUSH(ret);
6224f72b
GS
3171 switch (ret) {
3172 case 0:
14dd3ad8 3173 redo_body:
2ba65d5f
DM
3174 if (PL_op == (OP*)(&myop)) {
3175 PL_op = PL_ppaddr[OP_ENTEREVAL](aTHX);
3176 if (!PL_op)
3177 goto fail; /* failed in compilation */
3178 }
4aca2f62 3179 CALLRUNOPS(aTHX);
312caa8e 3180 retval = PL_stack_sp - (PL_stack_base + oldmark);
8433848b 3181 if (!(flags & G_KEEPERR)) {
ab69dbc2 3182 CLEAR_ERRSV();
8433848b 3183 }
4633a7c4 3184 break;
6224f72b 3185 case 1:
f86702cc 3186 STATUS_ALL_FAILURE;
924ba076 3187 /* FALLTHROUGH */
6224f72b 3188 case 2:
4633a7c4 3189 /* my_exit() was called */
03d9f026 3190 SET_CURSTASH(PL_defstash);
4633a7c4 3191 FREETMPS;
14dd3ad8 3192 JMPENV_POP;
f86702cc 3193 my_exit_jump();
e5964223 3194 NOT_REACHED; /* NOTREACHED */
6224f72b 3195 case 3:
3280af22 3196 if (PL_restartop) {
febb3a6d 3197 PL_restartjmpenv = NULL;
533c011a 3198 PL_op = PL_restartop;
3280af22 3199 PL_restartop = 0;
312caa8e 3200 goto redo_body;
4633a7c4 3201 }
4aca2f62 3202 fail:
3280af22 3203 PL_stack_sp = PL_stack_base + oldmark;
51ce5529 3204 if ((flags & G_WANT) == G_ARRAY)
4633a7c4
LW
3205 retval = 0;
3206 else {
3207 retval = 1;
3280af22 3208 *++PL_stack_sp = &PL_sv_undef;
4633a7c4 3209 }
312caa8e 3210 break;
4633a7c4
LW
3211 }
3212
14dd3ad8 3213 JMPENV_POP;
4633a7c4 3214 if (flags & G_DISCARD) {
3280af22 3215 PL_stack_sp = PL_stack_base + oldmark;
4633a7c4
LW
3216 retval = 0;
3217 FREETMPS;
3218 LEAVE;
3219 }
533c011a 3220 PL_op = oldop;
4633a7c4
LW
3221 return retval;
3222}
3223
954c1994
GS
3224/*
3225=for apidoc p||eval_pv
3226
422791e4 3227Tells Perl to C<eval> the given string in scalar context and return an SV* result.
954c1994
GS
3228
3229=cut
3230*/
3231
137443ea 3232SV*
864dbfa3 3233Perl_eval_pv(pTHX_ const char *p, I32 croak_on_error)
137443ea 3234{
137443ea
PP
3235 SV* sv = newSVpv(p, 0);
3236
7918f24d
NC
3237 PERL_ARGS_ASSERT_EVAL_PV;
3238
864dbfa3 3239 eval_sv(sv, G_SCALAR);
137443ea
PP
3240 SvREFCNT_dec(sv);
3241
ed1786ad
DD
3242 {
3243 dSP;
3244 sv = POPs;
3245 PUTBACK;
3246 }
137443ea 3247
eed484f9
DD
3248 /* just check empty string or undef? */
3249 if (croak_on_error) {
3250 SV * const errsv = ERRSV;
3251 if(SvTRUE_NN(errsv))
3252 /* replace with croak_sv? */
3253 Perl_croak_nocontext("%s", SvPV_nolen_const(errsv));
2d8e6c8d 3254 }
137443ea
PP
3255
3256 return sv;
3257}
3258
4633a7c4
LW
3259/* Require a module. */
3260
954c1994 3261/*
ccfc67b7
JH
3262=head1 Embedding Functions
3263
954c1994
GS
3264=for apidoc p||require_pv
3265
7d3fb230
BS
3266Tells Perl to C<require> the file named by the string argument. It is
3267analogous to the Perl code C<eval "require '$file'">. It's even
2307c6d0 3268implemented that way; consider using load_module instead.
954c1994 3269
7d3fb230 3270=cut */
954c1994 3271
4633a7c4 3272void
864dbfa3 3273Perl_require_pv(pTHX_ const char *pv)
4633a7c4 3274{
d3acc0f7 3275 dSP;
97aff369 3276 SV* sv;
7918f24d
NC
3277
3278 PERL_ARGS_ASSERT_REQUIRE_PV;
3279
e788e7d3 3280 PUSHSTACKi(PERLSI_REQUIRE);
be41e5d9
NC
3281 sv = Perl_newSVpvf(aTHX_ "require q%c%s%c", 0, pv, 0);
3282 eval_sv(sv_2mortal(sv), G_DISCARD);
d3acc0f7 3283 POPSTACK;
79072805
LW
3284}
3285
76e3520e 3286STATIC void
b6f82619 3287S_usage(pTHX) /* XXX move this out into a module ? */
4633a7c4 3288{
ab821d7f 3289 /* This message really ought to be max 23 lines.
75c72d73 3290 * Removed -h because the user already knows that option. Others? */
fb73857a 3291
1566c39d
NC
3292 /* Grouped as 6 lines per C string literal, to keep under the ANSI C 89
3293 minimum of 509 character string literals. */
27da23d5 3294 static const char * const usage_msg[] = {
1566c39d
NC
3295" -0[octal] specify record separator (\\0, if no argument)\n"
3296" -a autosplit mode with -n or -p (splits $_ into @F)\n"
3297" -C[number/list] enables the listed Unicode features\n"
3298" -c check syntax only (runs BEGIN and CHECK blocks)\n"
3299" -d[:debugger] run program under debugger\n"
3300" -D[number/list] set debugging flags (argument is a bit mask or alphabets)\n",
3301" -e program one line of program (several -e's allowed, omit programfile)\n"
3302" -E program like -e, but enables all optional features\n"
3303" -f don't do $sitelib/sitecustomize.pl at startup\n"
3304" -F/pattern/ split() pattern for -a switch (//'s are optional)\n"
3305" -i[extension] edit <> files in place (makes backup if extension supplied)\n"
3306" -Idirectory specify @INC/#include directory (several -I's allowed)\n",
3307" -l[octal] enable line ending processing, specifies line terminator\n"
3308" -[mM][-]module execute \"use/no module...\" before executing program\n"
3309" -n assume \"while (<>) { ... }\" loop around program\n"
3310" -p assume loop like -n but print line also, like sed\n"
3311" -s enable rudimentary parsing for switches after programfile\n"
3312" -S look for programfile using PATH environment variable\n",
3313" -t enable tainting warnings\n"
3314" -T enable tainting checks\n"
3315" -u dump core after parsing program\n"
3316" -U allow unsafe operations\n"
3317" -v print version, patchlevel and license\n"
3318" -V[:variable] print configuration summary (or a single Config.pm variable)\n",
60eaec42 3319" -w enable many useful warnings\n"
1566c39d
NC
3320" -W enable all warnings\n"
3321" -x[directory] ignore text before #!perl line (optionally cd to directory)\n"
3322" -X disable all warnings\n"
3323" \n"
3324"Run 'perldoc perl' for more help with Perl.\n\n",
fb73857a
PP
3325NULL
3326};
27da23d5 3327 const char * const *p = usage_msg;
1566c39d 3328 PerlIO *out = PerlIO_stdout();
fb73857a 3329
1566c39d
NC
3330 PerlIO_printf(out,
3331 "\nUsage: %s [switches] [--] [programfile] [arguments]\n",
b6f82619 3332 PL_origargv[0]);
fb73857a 3333 while (*p)
1566c39d 3334 PerlIO_puts(out, *p++);
b6f82619 3335 my_exit(0);
4633a7c4
LW
3336}
3337
b4ab917c
DM
3338/* convert a string of -D options (or digits) into an int.
3339 * sets *s to point to the char after the options */
3340
3341#ifdef DEBUGGING
3342int
e1ec3a88 3343Perl_get_debug_opts(pTHX_ const char **s, bool givehelp)
b4ab917c 3344{
27da23d5 3345 static const char * const usage_msgd[] = {
651b8f1a
NC
3346 " Debugging flag values: (see also -d)\n"
3347 " p Tokenizing and parsing (with v, displays parse stack)\n"
3348 " s Stack snapshots (with v, displays all stacks)\n"
3349 " l Context (loop) stack processing\n"
3350 " t Trace execution\n"
3351 " o Method and overloading resolution\n",
3352 " c String/numeric conversions\n"
3353 " P Print profiling info, source file input state\n"
3354 " m Memory and SV allocation\n"
3355 " f Format processing\n"
3356 " r Regular expression parsing and execution\n"
3357 " x Syntax tree dump\n",
3358 " u Tainting checks\n"
3359 " H Hash dump -- usurps values()\n"
3360 " X Scratchpad allocation\n"
3361 " D Cleaning up\n"
56967202 3362 " S Op slab allocation\n"
651b8f1a
NC
3363 " T Tokenising\n"
3364 " R Include reference counts of dumped variables (eg when using -Ds)\n",
3365 " J Do not s,t,P-debug (Jump over) opcodes within package DB\n"
3366 " v Verbose: use in conjunction with other flags\n"
3367 " C Copy On Write\n"
3368 " A Consistency checks on internal structures\n"
3369 " q quiet - currently only suppresses the 'EXECUTING' message\n"
3370 " M trace smart match resolution\n"
3371 " B dump suBroutine definitions, including special Blocks like BEGIN\n",
69014004 3372 " L trace some locale setting information--for Perl core development\n",
e17bc05a 3373 " i trace PerlIO layer processing\n",
e6e64d9b
JC
3374 NULL
3375 };
22ff3130 3376 UV uv = 0;
7918f24d
NC
3377
3378 PERL_ARGS_ASSERT_GET_DEBUG_OPTS;
3379
b4ab917c
DM
3380 if (isALPHA(**s)) {
3381 /* if adding extra options, remember to update DEBUG_MASK */
e17bc05a 3382 static const char debopts[] = "psltocPmfrxuUHXDSTRJvCAqMBLi";
b4ab917c 3383
0eb30aeb 3384 for (; isWORDCHAR(**s); (*s)++) {
c4420975 3385 const char * const d = strchr(debopts,**s);
b4ab917c 3386 if (d)
22ff3130 3387 uv |= 1 << (d - debopts);
b4ab917c 3388 else if (ckWARN_d(WARN_DEBUGGING))
e6e64d9b
JC
3389 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3390 "invalid option -D%c, use -D'' to see choices\n", **s);
b4ab917c
DM
3391 }
3392 }
e6e64d9b 3393 else if (isDIGIT(**s)) {
96e440d2 3394 const char* e;
22ff3130 3395 if (grok_atoUV(*s, &uv, &e))
96e440d2 3396 *s = e;
0eb30aeb 3397 for (; isWORDCHAR(**s); (*s)++) ;
b4ab917c 3398 }
ddcf8bc1 3399 else if (givehelp) {
06e869a4 3400 const char *const *p = usage_msgd;
651b8f1a 3401 while (*p) PerlIO_puts(PerlIO_stdout(), *p++);
e6e64d9b 3402 }
22ff3130 3403 return (int)uv; /* ignore any UV->int conversion loss */
b4ab917c
DM
3404}
3405#endif
3406
79072805
LW
3407/* This routine handles any switches that can be given during run */
3408
c7030b81
NC
3409const char *
3410Perl_moreswitches(pTHX_ const char *s)
79072805 3411{
27da23d5 3412 dVAR;
84c133a0 3413 UV rschar;
0544e6df 3414 const char option = *s; /* used to remember option in -m/-M code */
79072805 3415
7918f24d
NC
3416 PERL_ARGS_ASSERT_MORESWITCHES;
3417
79072805
LW
3418 switch (*s) {
3419 case '0':
a863c7d1 3420 {
f2095865 3421 I32 flags = 0;
a3b680e6 3422 STRLEN numlen;
f2095865
JH
3423
3424 SvREFCNT_dec(PL_rs);
3425 if (s[1] == 'x' && s[2]) {
a3b680e6 3426 const char *e = s+=2;
f2095865
JH
3427 U8 *tmps;
3428
a3b680e6
AL
3429 while (*e)
3430 e++;
f2095865
JH
3431 numlen = e - s;
3432 flags = PERL_SCAN_SILENT_ILLDIGIT;
3433 rschar = (U32)grok_hex(s, &numlen, &flags, NULL);
3434 if (s + numlen < e) {
3435 rschar = 0; /* Grandfather -0xFOO as -0 -xFOO. */
3436 numlen = 0;
3437 s--;
3438 }
396482e1 3439 PL_rs = newSVpvs("");
10656159 3440 tmps = (U8*) SvGROW(PL_rs, (STRLEN)(UVCHR_SKIP(rschar) + 1));
f2095865 3441 uvchr_to_utf8(tmps, rschar);
5f560d8a 3442 SvCUR_set(PL_rs, UVCHR_SKIP(rschar));
f2095865
JH
3443 SvUTF8_on(PL_rs);
3444 }
3445 else {
3446 numlen = 4;
3447 rschar = (U32)grok_oct(s, &numlen, &flags, NULL);
3448 if (rschar & ~((U8)~0))
3449 PL_rs = &PL_sv_undef;
3450 else if (!rschar && numlen >= 2)
396482e1 3451 PL_rs = newSVpvs("");
f2095865
JH
3452 else {
3453 char ch = (char)rschar;
3454 PL_rs = newSVpvn(&ch, 1);
3455 }
3456 }
64ace3f8 3457 sv_setsv(get_sv("/", GV_ADD), PL_rs);
f2095865 3458 return s + numlen;
a863c7d1 3459 }
46487f74 3460 case 'C':
a05d7ebb 3461 s++;
dd374669 3462 PL_unicode = parse_unicode_opts( (const char **)&s );
5a22a2bb
NC
3463 if (PL_unicode & PERL_UNICODE_UTF8CACHEASSERT_FLAG)
3464 PL_utf8cache = -1;
46487f74 3465 return s;
2304df62 3466 case 'F':
5fc691f1 3467 PL_minus_a = TRUE;
3280af22 3468 PL_minus_F = TRUE;
24ffa309 3469 PL_minus_n = TRUE;
ebce5377
RGS
3470 PL_splitstr = ++s;
3471 while (*s && !isSPACE(*s)) ++s;
e49e380e 3472 PL_splitstr = savepvn(PL_splitstr, s - PL_splitstr);
2304df62 3473 return s;
79072805 3474 case 'a':
3280af22 3475 PL_minus_a = TRUE;
24ffa309 3476 PL_minus_n = TRUE;
79072805
LW
3477 s++;
3478 return s;
3479 case 'c':
3280af22 3480 PL_minus_c = TRUE;
79072805
LW
3481 s++;
3482 return s;
3483 case 'd':
f20b2998 3484 forbid_setid('d', FALSE);
4633a7c4 3485 s++;
2cbb2ee1
RGS
3486
3487 /* -dt indicates to the debugger that threads will be used */
0eb30aeb 3488 if (*s == 't' && !isWORDCHAR(s[1])) {
2cbb2ee1
RGS
3489 ++s;
3490 my_setenv("PERL5DB_THREADED", "1");
3491 }
3492
70c94a19
RR
3493 /* The following permits -d:Mod to accepts arguments following an =
3494 in the fashion that -MSome::Mod does. */
3495 if (*s == ':' || *s == '=') {
b19934fb
NC
3496 const char *start;
3497 const char *end;
3498 SV *sv;
3499
3500 if (*++s == '-') {
3501 ++s;
3502 sv = newSVpvs("no Devel::");
3503 } else {
3504 sv = newSVpvs("use Devel::");
3505 }
3506
3507 start = s;
3508 end = s + strlen(s);
f85893a1 3509
b19934fb 3510 /* We now allow -d:Module=Foo,Bar and -d:-Module */
0eb30aeb 3511 while(isWORDCHAR(*s) || *s==':') ++s;
70c94a19 3512 if (*s != '=')
f85893a1 3513 sv_catpvn(sv, start, end - start);
70c94a19
RR
3514 else {
3515 sv_catpvn(sv, start, s-start);
95a2b409
RGS
3516 /* Don't use NUL as q// delimiter here, this string goes in the
3517 * environment. */
3518 Perl_sv_catpvf(aTHX_ sv, " split(/,/,q{%s});", ++s);
70c94a19 3519 }