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