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