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