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