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