This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
regcomp.c: Remove memory leak
[perl5.git] / perl.c
... / ...
CommitLineData
1#line 2 "perl.c"
2/* perl.c
3 *
4 * Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001
5 * 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
6 * 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021 by Larry Wall
7 * and others
8 *
9 * You may distribute under the terms of either the GNU General Public
10 * License or the Artistic License, as specified in the README file.
11 *
12 */
13
14/*
15 * A ship then new they built for him
16 * of mithril and of elven-glass
17 * --from Bilbo's song of EƤrendil
18 *
19 * [p.236 of _The Lord of the Rings_, II/i: "Many Meetings"]
20 */
21
22/* This file contains the top-level functions that are used to create, use
23 * and destroy a perl interpreter, plus the functions used by XS code to
24 * call back into perl. Note that it does not contain the actual main()
25 * function of the interpreter; that can be found in perlmain.c
26 *
27 * Note that at build time this file is also linked to as perlmini.c,
28 * and perlmini.o is then built with PERL_IS_MINIPERL defined, which is
29 * then used to create the miniperl executable, rather than perl.o.
30 */
31
32#if defined(PERL_IS_MINIPERL) && !defined(USE_SITECUSTOMIZE)
33# define USE_SITECUSTOMIZE
34#endif
35
36#include "EXTERN.h"
37#define PERL_IN_PERL_C
38#include "perl.h"
39#include "patchlevel.h" /* for local_patches */
40#include "XSUB.h"
41
42#ifdef NETWARE
43#include "nwutil.h"
44#endif
45
46#ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
47# ifdef I_SYSUIO
48# include <sys/uio.h>
49# endif
50
51union control_un {
52 struct cmsghdr cm;
53 char control[CMSG_SPACE(sizeof(int))];
54};
55
56#endif
57
58#ifndef HZ
59# ifdef CLK_TCK
60# define HZ CLK_TCK
61# else
62# define HZ 60
63# endif
64#endif
65
66static I32 read_e_script(pTHX_ int idx, SV *buf_sv, int maxlen);
67
68#ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
69# define validate_suid(rsfp) NOOP
70#else
71# define validate_suid(rsfp) S_validate_suid(aTHX_ rsfp)
72#endif
73
74#define CALL_BODY_SUB(myop) \
75 if (PL_op == (myop)) \
76 PL_op = PL_ppaddr[OP_ENTERSUB](aTHX); \
77 if (PL_op) \
78 CALLRUNOPS(aTHX);
79
80#define CALL_LIST_BODY(cv) \
81 PUSHMARK(PL_stack_sp); \
82 call_sv(MUTABLE_SV((cv)), G_EVAL|G_DISCARD|G_VOID);
83
84static void
85S_init_tls_and_interp(PerlInterpreter *my_perl)
86{
87 if (!PL_curinterp) {
88 PERL_SET_INTERP(my_perl);
89#if defined(USE_ITHREADS)
90 INIT_THREADS;
91 ALLOC_THREAD_KEY;
92 PERL_SET_THX(my_perl);
93 OP_REFCNT_INIT;
94 OP_CHECK_MUTEX_INIT;
95 KEYWORD_PLUGIN_MUTEX_INIT;
96 HINTS_REFCNT_INIT;
97 LOCALE_INIT;
98 USER_PROP_MUTEX_INIT;
99 ENV_INIT;
100 MUTEX_INIT(&PL_dollarzero_mutex);
101 MUTEX_INIT(&PL_my_ctx_mutex);
102# endif
103 }
104#if defined(USE_ITHREADS)
105 else
106#else
107 /* This always happens for non-ithreads */
108#endif
109 {
110 PERL_SET_THX(my_perl);
111 }
112}
113
114
115/* these implement the PERL_SYS_INIT, PERL_SYS_INIT3, PERL_SYS_TERM macros */
116
117void
118Perl_sys_init(int* argc, char*** argv)
119{
120
121 PERL_ARGS_ASSERT_SYS_INIT;
122
123 PERL_UNUSED_ARG(argc); /* may not be used depending on _BODY macro */
124 PERL_UNUSED_ARG(argv);
125 PERL_SYS_INIT_BODY(argc, argv);
126}
127
128void
129Perl_sys_init3(int* argc, char*** argv, char*** env)
130{
131
132 PERL_ARGS_ASSERT_SYS_INIT3;
133
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
141Perl_sys_term(void)
142{
143 if (!PL_veto_cleanup) {
144 PERL_SYS_TERM_BODY();
145 }
146}
147
148
149#ifdef PERL_IMPLICIT_SYS
150PerlInterpreter *
151perl_alloc_using(struct IPerlMem* ipM, struct IPerlMem* ipMS,
152 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
153 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
154 struct IPerlDir* ipD, struct IPerlSock* ipS,
155 struct IPerlProc* ipP)
156{
157 PerlInterpreter *my_perl;
158
159 PERL_ARGS_ASSERT_PERL_ALLOC_USING;
160
161 /* Newx() needs interpreter, so call malloc() instead */
162 my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
163 S_init_tls_and_interp(my_perl);
164 Zero(my_perl, 1, PerlInterpreter);
165 PL_Mem = ipM;
166 PL_MemShared = ipMS;
167 PL_MemParse = ipMP;
168 PL_Env = ipE;
169 PL_StdIO = ipStd;
170 PL_LIO = ipLIO;
171 PL_Dir = ipD;
172 PL_Sock = ipS;
173 PL_Proc = ipP;
174 INIT_TRACK_MEMPOOL(PL_memory_debug_header, my_perl);
175
176 return my_perl;
177}
178#else
179
180/*
181=for apidoc_section $embedding
182
183=for apidoc perl_alloc
184
185Allocates a new Perl interpreter. See L<perlembed>.
186
187=cut
188*/
189
190PerlInterpreter *
191perl_alloc(void)
192{
193 PerlInterpreter *my_perl;
194
195 /* Newx() needs interpreter, so call malloc() instead */
196 my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
197
198 S_init_tls_and_interp(my_perl);
199#ifndef PERL_TRACK_MEMPOOL
200 return (PerlInterpreter *) ZeroD(my_perl, 1, PerlInterpreter);
201#else
202 Zero(my_perl, 1, PerlInterpreter);
203 INIT_TRACK_MEMPOOL(PL_memory_debug_header, my_perl);
204 return my_perl;
205#endif
206}
207#endif /* PERL_IMPLICIT_SYS */
208
209/*
210=for apidoc perl_construct
211
212Initializes a new Perl interpreter. See L<perlembed>.
213
214=cut
215*/
216
217void
218perl_construct(pTHXx)
219{
220
221 PERL_ARGS_ASSERT_PERL_CONSTRUCT;
222
223#ifdef MULTIPLICITY
224 init_interp();
225 PL_perl_destruct_level = 1;
226#else
227 PERL_UNUSED_ARG(my_perl);
228 if (PL_perl_destruct_level > 0)
229 init_interp();
230#endif
231 PL_curcop = &PL_compiling; /* needed by ckWARN, right away */
232
233#ifdef PERL_TRACE_OPS
234 Zero(PL_op_exec_cnt, OP_max+2, UV);
235#endif
236
237 init_constants();
238
239 SvREADONLY_on(&PL_sv_placeholder);
240 SvREFCNT(&PL_sv_placeholder) = SvREFCNT_IMMORTAL;
241
242 PL_sighandlerp = Perl_sighandler;
243 PL_sighandler1p = Perl_sighandler1;
244 PL_sighandler3p = Perl_sighandler3;
245
246#ifdef PERL_USES_PL_PIDSTATUS
247 PL_pidstatus = newHV();
248#endif
249
250 PL_rs = newSVpvs("\n");
251
252 init_stacks();
253
254/* The PERL_INTERNAL_RAND_SEED set-up must be after init_stacks because it calls
255 * things that may put SVs on the stack.
256 */
257
258#ifdef NO_PERL_INTERNAL_RAND_SEED
259 Perl_drand48_init_r(&PL_internal_random_state, seed());
260#else
261 {
262 UV seed;
263 const char *env_pv;
264 if (PerlProc_getuid() != PerlProc_geteuid() ||
265 PerlProc_getgid() != PerlProc_getegid() ||
266 !(env_pv = PerlEnv_getenv("PERL_INTERNAL_RAND_SEED")) ||
267 grok_number(env_pv, strlen(env_pv), &seed) != IS_NUMBER_IN_UV) {
268 seed = seed();
269 }
270 Perl_drand48_init_r(&PL_internal_random_state, (U32)seed);
271 }
272#endif
273
274 init_ids();
275
276 JMPENV_BOOTSTRAP;
277 STATUS_ALL_SUCCESS;
278
279 init_uniprops();
280 (void) uvchr_to_utf8_flags((U8 *) PL_TR_SPECIAL_HANDLING_UTF8,
281 TR_SPECIAL_HANDLING,
282 UNICODE_ALLOW_ABOVE_IV_MAX);
283
284#if defined(LOCAL_PATCH_COUNT)
285 PL_localpatches = local_patches; /* For possible -v */
286#endif
287
288#if defined(LIBM_LIB_VERSION)
289 /*
290 * Some BSDs and Cygwin default to POSIX math instead of IEEE.
291 * This switches them over to IEEE.
292 */
293 _LIB_VERSION = _IEEE_;
294#endif
295
296#ifdef HAVE_INTERP_INTERN
297 sys_intern_init();
298#endif
299
300 PerlIO_init(aTHX); /* Hook to IO system */
301
302 PL_fdpid = newAV(); /* for remembering popen pids by fd */
303 PL_modglobal = newHV(); /* pointers to per-interpreter module globals */
304 PL_errors = newSVpvs("");
305 SvPVCLEAR(PERL_DEBUG_PAD(0)); /* For regex debugging. */
306 SvPVCLEAR(PERL_DEBUG_PAD(1)); /* ext/re needs these */
307 SvPVCLEAR(PERL_DEBUG_PAD(2)); /* even without DEBUGGING. */
308#ifdef USE_ITHREADS
309 /* First entry is a list of empty elements. It needs to be initialised
310 else all hell breaks loose in S_find_uninit_var(). */
311 Perl_av_create_and_push(aTHX_ &PL_regex_padav, newSVpvs(""));
312 PL_regex_pad = AvARRAY(PL_regex_padav);
313 Newxz(PL_stashpad, PL_stashpadmax, HV *);
314#endif
315#ifdef USE_REENTRANT_API
316 Perl_reentrant_init(aTHX);
317#endif
318 if (PL_hash_seed_set == FALSE) {
319 /* Initialize the hash seed and state at startup. This must be
320 * done very early, before ANY hashes are constructed, and once
321 * setup is fixed for the lifetime of the process.
322 *
323 * If you decide to disable the seeding process you should choose
324 * a suitable seed yourself and define PERL_HASH_SEED to a well chosen
325 * string. See hv_func.h for details.
326 */
327#if defined(USE_HASH_SEED)
328 /* get the hash seed from the environment or from an RNG */
329 Perl_get_hash_seed(aTHX_ PL_hash_seed);
330#else
331 /* they want a hard coded seed, check that it is long enough */
332 assert( strlen(PERL_HASH_SEED) >= PERL_HASH_SEED_BYTES );
333#endif
334
335 /* now we use the chosen seed to initialize the state -
336 * in some configurations this may be a relatively speaking
337 * expensive operation, but we only have to do it once at startup */
338 PERL_HASH_SEED_STATE(PERL_HASH_SEED,PL_hash_state);
339
340#ifdef PERL_USE_SINGLE_CHAR_HASH_CACHE
341 /* we can build a special cache for 0/1 byte keys, if people choose
342 * I suspect most of the time it is not worth it */
343 {
344 char str[2]="\0";
345 int i;
346 for (i=0;i<256;i++) {
347 str[0]= i;
348 PERL_HASH_WITH_STATE(PL_hash_state,PL_hash_chars[i],str,1);
349 }
350 PERL_HASH_WITH_STATE(PL_hash_state,PL_hash_chars[256],str,0);
351 }
352#endif
353 /* at this point we have initialezed the hash function, and we can start
354 * constructing hashes */
355 PL_hash_seed_set= TRUE;
356 }
357
358 /* Allow PL_strtab to be pre-initialized before calling perl_construct.
359 * can use a custom optimized PL_strtab hash before calling perl_construct */
360 if (!PL_strtab) {
361 /* Note that strtab is a rather special HV. Assumptions are made
362 about not iterating on it, and not adding tie magic to it.
363 It is properly deallocated in perl_destruct() */
364 PL_strtab = newHV();
365
366 /* SHAREKEYS tells us that the hash has its keys shared with PL_strtab,
367 * which is not the case with PL_strtab itself */
368 HvSHAREKEYS_off(PL_strtab); /* mandatory */
369 hv_ksplit(PL_strtab, 1 << 11);
370 }
371
372 Zero(PL_sv_consts, SV_CONSTS_COUNT, SV*);
373
374#ifndef PERL_MICRO
375# ifdef USE_ENVIRON_ARRAY
376 PL_origenviron = environ;
377# endif
378#endif
379
380 /* Use sysconf(_SC_CLK_TCK) if available, if not
381 * available or if the sysconf() fails, use the HZ.
382 * The HZ if not originally defined has been by now
383 * been defined as CLK_TCK, if available. */
384#if defined(HAS_SYSCONF) && defined(_SC_CLK_TCK)
385 PL_clocktick = sysconf(_SC_CLK_TCK);
386 if (PL_clocktick <= 0)
387#endif
388 PL_clocktick = HZ;
389
390 PL_stashcache = newHV();
391
392 PL_patchlevel = newSVpvs("v" PERL_VERSION_STRING);
393
394#ifdef HAS_MMAP
395 if (!PL_mmap_page_size) {
396#if defined(HAS_SYSCONF) && (defined(_SC_PAGESIZE) || defined(_SC_MMAP_PAGE_SIZE))
397 {
398 SETERRNO(0, SS_NORMAL);
399# ifdef _SC_PAGESIZE
400 PL_mmap_page_size = sysconf(_SC_PAGESIZE);
401# else
402 PL_mmap_page_size = sysconf(_SC_MMAP_PAGE_SIZE);
403# endif
404 if ((long) PL_mmap_page_size < 0) {
405 Perl_croak(aTHX_ "panic: sysconf: %s",
406 errno ? Strerror(errno) : "pagesize unknown");
407 }
408 }
409#elif defined(HAS_GETPAGESIZE)
410 PL_mmap_page_size = getpagesize();
411#elif defined(I_SYS_PARAM) && defined(PAGESIZE)
412 PL_mmap_page_size = PAGESIZE; /* compiletime, bad */
413#endif
414 if (PL_mmap_page_size <= 0)
415 Perl_croak(aTHX_ "panic: bad pagesize %" IVdf,
416 (IV) PL_mmap_page_size);
417 }
418#endif /* HAS_MMAP */
419
420 PL_osname = Perl_savepvn(aTHX_ STR_WITH_LEN(OSNAME));
421
422 PL_registered_mros = newHV();
423 /* Start with 1 bucket, for DFS. It's unlikely we'll need more. */
424 HvMAX(PL_registered_mros) = 0;
425
426#ifdef USE_POSIX_2008_LOCALE
427 PL_C_locale_obj = newlocale(LC_ALL_MASK, "C", NULL);
428#endif
429
430 ENTER;
431 init_i18nl10n(1);
432}
433
434/*
435=for apidoc nothreadhook
436
437Stub that provides thread hook for perl_destruct when there are
438no threads.
439
440=cut
441*/
442
443int
444Perl_nothreadhook(pTHX)
445{
446 PERL_UNUSED_CONTEXT;
447 return 0;
448}
449
450#ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
451void
452Perl_dump_sv_child(pTHX_ SV *sv)
453{
454 ssize_t got;
455 const int sock = PL_dumper_fd;
456 const int debug_fd = PerlIO_fileno(Perl_debug_log);
457 union control_un control;
458 struct msghdr msg;
459 struct iovec vec[2];
460 struct cmsghdr *cmptr;
461 int returned_errno;
462 unsigned char buffer[256];
463
464 PERL_ARGS_ASSERT_DUMP_SV_CHILD;
465
466 if(sock == -1 || debug_fd == -1)
467 return;
468
469 PerlIO_flush(Perl_debug_log);
470
471 /* All these shenanigans are to pass a file descriptor over to our child for
472 it to dump out to. We can't let it hold open the file descriptor when it
473 forks, as the file descriptor it will dump to can turn out to be one end
474 of pipe that some other process will wait on for EOF. (So as it would
475 be open, the wait would be forever.) */
476
477 msg.msg_control = control.control;
478 msg.msg_controllen = sizeof(control.control);
479 /* We're a connected socket so we don't need a destination */
480 msg.msg_name = NULL;
481 msg.msg_namelen = 0;
482 msg.msg_iov = vec;
483 msg.msg_iovlen = 1;
484
485 cmptr = CMSG_FIRSTHDR(&msg);
486 cmptr->cmsg_len = CMSG_LEN(sizeof(int));
487 cmptr->cmsg_level = SOL_SOCKET;
488 cmptr->cmsg_type = SCM_RIGHTS;
489 *((int *)CMSG_DATA(cmptr)) = 1;
490
491 vec[0].iov_base = (void*)&sv;
492 vec[0].iov_len = sizeof(sv);
493 got = sendmsg(sock, &msg, 0);
494
495 if(got < 0) {
496 perror("Debug leaking scalars parent sendmsg failed");
497 abort();
498 }
499 if(got < sizeof(sv)) {
500 perror("Debug leaking scalars parent short sendmsg");
501 abort();
502 }
503
504 /* Return protocol is
505 int: errno value
506 unsigned char: length of location string (0 for empty)
507 unsigned char*: string (not terminated)
508 */
509 vec[0].iov_base = (void*)&returned_errno;
510 vec[0].iov_len = sizeof(returned_errno);
511 vec[1].iov_base = buffer;
512 vec[1].iov_len = 1;
513
514 got = readv(sock, vec, 2);
515
516 if(got < 0) {
517 perror("Debug leaking scalars parent read failed");
518 PerlIO_flush(PerlIO_stderr());
519 abort();
520 }
521 if(got < sizeof(returned_errno) + 1) {
522 perror("Debug leaking scalars parent short read");
523 PerlIO_flush(PerlIO_stderr());
524 abort();
525 }
526
527 if (*buffer) {
528 got = read(sock, buffer + 1, *buffer);
529 if(got < 0) {
530 perror("Debug leaking scalars parent read 2 failed");
531 PerlIO_flush(PerlIO_stderr());
532 abort();
533 }
534
535 if(got < *buffer) {
536 perror("Debug leaking scalars parent short read 2");
537 PerlIO_flush(PerlIO_stderr());
538 abort();
539 }
540 }
541
542 if (returned_errno || *buffer) {
543 Perl_warn(aTHX_ "Debug leaking scalars child failed%s%.*s with errno"
544 " %d: %s", (*buffer ? " at " : ""), (int) *buffer, buffer + 1,
545 returned_errno, Strerror(returned_errno));
546 }
547}
548#endif
549
550/*
551=for apidoc perl_destruct
552
553Shuts down a Perl interpreter. See L<perlembed> for a tutorial.
554
555C<my_perl> points to the Perl interpreter. It must have been previously
556created through the use of L</perl_alloc> and L</perl_construct>. It may
557have been initialised through L</perl_parse>, and may have been used
558through L</perl_run> and other means. This function should be called for
559any Perl interpreter that has been constructed with L</perl_construct>,
560even if subsequent operations on it failed, for example if L</perl_parse>
561returned a non-zero value.
562
563If the interpreter's C<PL_exit_flags> word has the
564C<PERL_EXIT_DESTRUCT_END> flag set, then this function will execute code
565in C<END> blocks before performing the rest of destruction. If it is
566desired to make any use of the interpreter between L</perl_parse> and
567L</perl_destruct> other than just calling L</perl_run>, then this flag
568should be set early on. This matters if L</perl_run> will not be called,
569or if anything else will be done in addition to calling L</perl_run>.
570
571Returns a value be a suitable value to pass to the C library function
572C<exit> (or to return from C<main>), to serve as an exit code indicating
573the nature of the way the interpreter terminated. This takes into account
574any failure of L</perl_parse> and any early exit from L</perl_run>.
575The exit code is of the type required by the host operating system,
576so because of differing exit code conventions it is not portable to
577interpret specific numeric values as having specific meanings.
578
579=cut
580*/
581
582int
583perl_destruct(pTHXx)
584{
585 volatile signed char destruct_level; /* see possible values in intrpvar.h */
586 HV *hv;
587#ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
588 pid_t child;
589#endif
590 int i;
591
592 PERL_ARGS_ASSERT_PERL_DESTRUCT;
593#ifndef MULTIPLICITY
594 PERL_UNUSED_ARG(my_perl);
595#endif
596
597 assert(PL_scopestack_ix == 1);
598
599 /* wait for all pseudo-forked children to finish */
600 PERL_WAIT_FOR_CHILDREN;
601
602 destruct_level = PL_perl_destruct_level;
603 {
604 const char * const s = PerlEnv_getenv("PERL_DESTRUCT_LEVEL");
605 if (s) {
606 int i;
607 if (strEQ(s, "-1")) { /* Special case: modperl folklore. */
608 i = -1;
609 } else {
610 UV uv;
611 if (grok_atoUV(s, &uv, NULL) && uv <= INT_MAX)
612 i = (int)uv;
613 else
614 i = 0;
615 }
616 if (destruct_level < i) destruct_level = i;
617#ifdef PERL_TRACK_MEMPOOL
618 /* RT #114496, for perl_free */
619 PL_perl_destruct_level = i;
620#endif
621 }
622 }
623
624 if (PL_exit_flags & PERL_EXIT_DESTRUCT_END) {
625 dJMPENV;
626 int x = 0;
627
628 JMPENV_PUSH(x);
629 PERL_UNUSED_VAR(x);
630 if (PL_endav && !PL_minus_c) {
631 PERL_SET_PHASE(PERL_PHASE_END);
632 call_list(PL_scopestack_ix, PL_endav);
633 }
634 JMPENV_POP;
635 }
636 LEAVE;
637 FREETMPS;
638 assert(PL_scopestack_ix == 0);
639
640 /* normally when we get here, PL_parser should be null due to having
641 * its original (null) value restored by SAVEt_PARSER during leaving
642 * scope (usually before run-time starts in fact).
643 * But if a thread is created within a BEGIN block, the parser is
644 * duped, but the SAVEt_PARSER savestack entry isn't. So PL_parser
645 * never gets cleaned up.
646 * Clean it up here instead. This is a bit of a hack.
647 */
648 if (PL_parser) {
649 /* stop parser_free() stomping on PL_curcop */
650 PL_parser->saved_curcop = PL_curcop;
651 parser_free(PL_parser);
652 }
653
654
655 /* Need to flush since END blocks can produce output */
656 /* flush stdout separately, since we can identify it */
657#ifdef USE_PERLIO
658 {
659 PerlIO *stdo = PerlIO_stdout();
660 if (*stdo && PerlIO_flush(stdo)) {
661 PerlIO_restore_errno(stdo);
662 if (errno)
663 PerlIO_printf(PerlIO_stderr(), "Unable to flush stdout: %s\n",
664 Strerror(errno));
665 if (!STATUS_UNIX)
666 STATUS_ALL_FAILURE;
667 }
668 }
669#endif
670 my_fflush_all();
671
672#ifdef PERL_TRACE_OPS
673 /* dump OP-counts if $ENV{PERL_TRACE_OPS} > 0 */
674 {
675 const char * const ptoenv = PerlEnv_getenv("PERL_TRACE_OPS");
676 UV uv;
677
678 if (!ptoenv || !Perl_grok_atoUV(ptoenv, &uv, NULL)
679 || !(uv > 0))
680 goto no_trace_out;
681 }
682 PerlIO_printf(Perl_debug_log, "Trace of all OPs executed:\n");
683 for (i = 0; i <= OP_max; ++i) {
684 if (PL_op_exec_cnt[i])
685 PerlIO_printf(Perl_debug_log, " %s: %" UVuf "\n", PL_op_name[i], PL_op_exec_cnt[i]);
686 }
687 /* Utility slot for easily doing little tracing experiments in the runloop: */
688 if (PL_op_exec_cnt[OP_max+1] != 0)
689 PerlIO_printf(Perl_debug_log, " SPECIAL: %" UVuf "\n", PL_op_exec_cnt[OP_max+1]);
690 PerlIO_printf(Perl_debug_log, "\n");
691 no_trace_out:
692#endif
693
694
695 if (PL_threadhook(aTHX)) {
696 /* Threads hook has vetoed further cleanup */
697 PL_veto_cleanup = TRUE;
698 return STATUS_EXIT;
699 }
700
701#ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
702 if (destruct_level != 0) {
703 /* Fork here to create a child. Our child's job is to preserve the
704 state of scalars prior to destruction, so that we can instruct it
705 to dump any scalars that we later find have leaked.
706 There's no subtlety in this code - it assumes POSIX, and it doesn't
707 fail gracefully */
708 int fd[2];
709
710 if(PerlSock_socketpair_cloexec(AF_UNIX, SOCK_STREAM, 0, fd)) {
711 perror("Debug leaking scalars socketpair failed");
712 abort();
713 }
714
715 child = fork();
716 if(child == -1) {
717 perror("Debug leaking scalars fork failed");
718 abort();
719 }
720 if (!child) {
721 /* We are the child */
722 const int sock = fd[1];
723 const int debug_fd = PerlIO_fileno(Perl_debug_log);
724 int f;
725 const char *where;
726 /* Our success message is an integer 0, and a char 0 */
727 static const char success[sizeof(int) + 1] = {0};
728
729 close(fd[0]);
730
731 /* We need to close all other file descriptors otherwise we end up
732 with interesting hangs, where the parent closes its end of a
733 pipe, and sits waiting for (another) child to terminate. Only
734 that child never terminates, because it never gets EOF, because
735 we also have the far end of the pipe open. We even need to
736 close the debugging fd, because sometimes it happens to be one
737 end of a pipe, and a process is waiting on the other end for
738 EOF. Normally it would be closed at some point earlier in
739 destruction, but if we happen to cause the pipe to remain open,
740 EOF never occurs, and we get an infinite hang. Hence all the
741 games to pass in a file descriptor if it's actually needed. */
742
743 f = sysconf(_SC_OPEN_MAX);
744 if(f < 0) {
745 where = "sysconf failed";
746 goto abort;
747 }
748 while (f--) {
749 if (f == sock)
750 continue;
751 close(f);
752 }
753
754 while (1) {
755 SV *target;
756 union control_un control;
757 struct msghdr msg;
758 struct iovec vec[1];
759 struct cmsghdr *cmptr;
760 ssize_t got;
761 int got_fd;
762
763 msg.msg_control = control.control;
764 msg.msg_controllen = sizeof(control.control);
765 /* We're a connected socket so we don't need a source */
766 msg.msg_name = NULL;
767 msg.msg_namelen = 0;
768 msg.msg_iov = vec;
769 msg.msg_iovlen = C_ARRAY_LENGTH(vec);
770
771 vec[0].iov_base = (void*)&target;
772 vec[0].iov_len = sizeof(target);
773
774 got = recvmsg(sock, &msg, 0);
775
776 if(got == 0)
777 break;
778 if(got < 0) {
779 where = "recv failed";
780 goto abort;
781 }
782 if(got < sizeof(target)) {
783 where = "short recv";
784 goto abort;
785 }
786
787 if(!(cmptr = CMSG_FIRSTHDR(&msg))) {
788 where = "no cmsg";
789 goto abort;
790 }
791 if(cmptr->cmsg_len != CMSG_LEN(sizeof(int))) {
792 where = "wrong cmsg_len";
793 goto abort;
794 }
795 if(cmptr->cmsg_level != SOL_SOCKET) {
796 where = "wrong cmsg_level";
797 goto abort;
798 }
799 if(cmptr->cmsg_type != SCM_RIGHTS) {
800 where = "wrong cmsg_type";
801 goto abort;
802 }
803
804 got_fd = *(int*)CMSG_DATA(cmptr);
805 /* For our last little bit of trickery, put the file descriptor
806 back into Perl_debug_log, as if we never actually closed it
807 */
808 if(got_fd != debug_fd) {
809 if (PerlLIO_dup2_cloexec(got_fd, debug_fd) == -1) {
810 where = "dup2";
811 goto abort;
812 }
813 }
814 sv_dump(target);
815
816 PerlIO_flush(Perl_debug_log);
817
818 got = write(sock, &success, sizeof(success));
819
820 if(got < 0) {
821 where = "write failed";
822 goto abort;
823 }
824 if(got < sizeof(success)) {
825 where = "short write";
826 goto abort;
827 }
828 }
829 _exit(0);
830 abort:
831 {
832 int send_errno = errno;
833 unsigned char length = (unsigned char) strlen(where);
834 struct iovec failure[3] = {
835 {(void*)&send_errno, sizeof(send_errno)},
836 {&length, 1},
837 {(void*)where, length}
838 };
839 int got = writev(sock, failure, 3);
840 /* Bad news travels fast. Faster than data. We'll get a SIGPIPE
841 in the parent if we try to read from the socketpair after the
842 child has exited, even if there was data to read.
843 So sleep a bit to give the parent a fighting chance of
844 reading the data. */
845 sleep(2);
846 _exit((got == -1) ? errno : 0);
847 }
848 /* End of child. */
849 }
850 PL_dumper_fd = fd[0];
851 close(fd[1]);
852 }
853#endif
854
855 /* We must account for everything. */
856
857 /* Destroy the main CV and syntax tree */
858 /* Set PL_curcop now, because destroying ops can cause new SVs
859 to be generated in Perl_pad_swipe, and when running with
860 -DDEBUG_LEAKING_SCALARS they expect PL_curcop to point to a valid
861 op from which the filename structure member is copied. */
862 PL_curcop = &PL_compiling;
863 if (PL_main_root) {
864 /* ensure comppad/curpad to refer to main's pad */
865 if (CvPADLIST(PL_main_cv)) {
866 PAD_SET_CUR_NOSAVE(CvPADLIST(PL_main_cv), 1);
867 PL_comppad_name = PadlistNAMES(CvPADLIST(PL_main_cv));
868 }
869 op_free(PL_main_root);
870 PL_main_root = NULL;
871 }
872 PL_main_start = NULL;
873 /* note that PL_main_cv isn't usually actually freed at this point,
874 * due to the CvOUTSIDE refs from subs compiled within it. It will
875 * get freed once all the subs are freed in sv_clean_all(), for
876 * destruct_level > 0 */
877 SvREFCNT_dec(PL_main_cv);
878 PL_main_cv = NULL;
879 PERL_SET_PHASE(PERL_PHASE_DESTRUCT);
880
881 /* Tell PerlIO we are about to tear things apart in case
882 we have layers which are using resources that should
883 be cleaned up now.
884 */
885
886 PerlIO_destruct(aTHX);
887
888 /*
889 * Try to destruct global references. We do this first so that the
890 * destructors and destructees still exist. Some sv's might remain.
891 * Non-referenced objects are on their own.
892 */
893 sv_clean_objs();
894
895 /* unhook hooks which will soon be, or use, destroyed data */
896 SvREFCNT_dec(PL_warnhook);
897 PL_warnhook = NULL;
898 SvREFCNT_dec(PL_diehook);
899 PL_diehook = NULL;
900
901 /* call exit list functions */
902 while (PL_exitlistlen-- > 0)
903 PL_exitlist[PL_exitlistlen].fn(aTHX_ PL_exitlist[PL_exitlistlen].ptr);
904
905 Safefree(PL_exitlist);
906
907 PL_exitlist = NULL;
908 PL_exitlistlen = 0;
909
910 SvREFCNT_dec(PL_registered_mros);
911
912 /* jettison our possibly duplicated environment */
913 /* if PERL_USE_SAFE_PUTENV is defined environ will not have been copied
914 * so we certainly shouldn't free it here
915 */
916#ifndef PERL_MICRO
917#if defined(USE_ENVIRON_ARRAY) && !defined(PERL_USE_SAFE_PUTENV)
918 if (environ != PL_origenviron && !PL_use_safe_putenv
919#ifdef USE_ITHREADS
920 /* only main thread can free environ[0] contents */
921 && PL_curinterp == aTHX
922#endif
923 )
924 {
925 I32 i;
926
927 for (i = 0; environ[i]; i++)
928 safesysfree(environ[i]);
929
930 /* Must use safesysfree() when working with environ. */
931 safesysfree(environ);
932
933 environ = PL_origenviron;
934 }
935#endif
936#endif /* !PERL_MICRO */
937
938 if (destruct_level == 0) {
939
940 DEBUG_P(debprofdump());
941
942#if defined(PERLIO_LAYERS)
943 /* No more IO - including error messages ! */
944 PerlIO_cleanup(aTHX);
945#endif
946
947 CopFILE_free(&PL_compiling);
948
949 /* The exit() function will do everything that needs doing. */
950 return STATUS_EXIT;
951 }
952
953 /* Below, do clean up for when PERL_DESTRUCT_LEVEL is not 0 */
954
955#ifdef USE_ITHREADS
956 /* the syntax tree is shared between clones
957 * so op_free(PL_main_root) only ReREFCNT_dec's
958 * REGEXPs in the parent interpreter
959 * we need to manually ReREFCNT_dec for the clones
960 */
961 {
962 I32 i = AvFILLp(PL_regex_padav);
963 SV **ary = AvARRAY(PL_regex_padav);
964
965 for (; i; i--) {
966 SvREFCNT_dec(ary[i]);
967 ary[i] = &PL_sv_undef;
968 }
969 }
970#endif
971
972
973 SvREFCNT_dec(MUTABLE_SV(PL_stashcache));
974 PL_stashcache = NULL;
975
976 /* loosen bonds of global variables */
977
978 /* XXX can PL_parser still be non-null here? */
979 if(PL_parser && PL_parser->rsfp) {
980 (void)PerlIO_close(PL_parser->rsfp);
981 PL_parser->rsfp = NULL;
982 }
983
984 if (PL_minus_F) {
985 Safefree(PL_splitstr);
986 PL_splitstr = NULL;
987 }
988
989 /* switches */
990 PL_minus_n = FALSE;
991 PL_minus_p = FALSE;
992 PL_minus_l = FALSE;
993 PL_minus_a = FALSE;
994 PL_minus_F = FALSE;
995 PL_doswitches = FALSE;
996 PL_dowarn = G_WARN_OFF;
997#ifdef PERL_SAWAMPERSAND
998 PL_sawampersand = 0; /* must save all match strings */
999#endif
1000 PL_unsafe = FALSE;
1001
1002 Safefree(PL_inplace);
1003 PL_inplace = NULL;
1004 SvREFCNT_dec(PL_patchlevel);
1005
1006 if (PL_e_script) {
1007 SvREFCNT_dec(PL_e_script);
1008 PL_e_script = NULL;
1009 }
1010
1011 PL_perldb = 0;
1012
1013 /* magical thingies */
1014
1015 SvREFCNT_dec(PL_ofsgv); /* *, */
1016 PL_ofsgv = NULL;
1017
1018 SvREFCNT_dec(PL_ors_sv); /* $\ */
1019 PL_ors_sv = NULL;
1020
1021 SvREFCNT_dec(PL_rs); /* $/ */
1022 PL_rs = NULL;
1023
1024 Safefree(PL_osname); /* $^O */
1025 PL_osname = NULL;
1026
1027 SvREFCNT_dec(PL_statname);
1028 PL_statname = NULL;
1029 PL_statgv = NULL;
1030
1031 /* defgv, aka *_ should be taken care of elsewhere */
1032
1033 /* float buffer */
1034 Safefree(PL_efloatbuf);
1035 PL_efloatbuf = NULL;
1036 PL_efloatsize = 0;
1037
1038 /* startup and shutdown function lists */
1039 SvREFCNT_dec(PL_beginav);
1040 SvREFCNT_dec(PL_beginav_save);
1041 SvREFCNT_dec(PL_endav);
1042 SvREFCNT_dec(PL_checkav);
1043 SvREFCNT_dec(PL_checkav_save);
1044 SvREFCNT_dec(PL_unitcheckav);
1045 SvREFCNT_dec(PL_unitcheckav_save);
1046 SvREFCNT_dec(PL_initav);
1047 PL_beginav = NULL;
1048 PL_beginav_save = NULL;
1049 PL_endav = NULL;
1050 PL_checkav = NULL;
1051 PL_checkav_save = NULL;
1052 PL_unitcheckav = NULL;
1053 PL_unitcheckav_save = NULL;
1054 PL_initav = NULL;
1055
1056 /* shortcuts just get cleared */
1057 PL_hintgv = NULL;
1058 PL_errgv = NULL;
1059 PL_argvoutgv = NULL;
1060 PL_stdingv = NULL;
1061 PL_stderrgv = NULL;
1062 PL_last_in_gv = NULL;
1063 PL_DBsingle = NULL;
1064 PL_DBtrace = NULL;
1065 PL_DBsignal = NULL;
1066 PL_DBsingle_iv = 0;
1067 PL_DBtrace_iv = 0;
1068 PL_DBsignal_iv = 0;
1069 PL_DBcv = NULL;
1070 PL_dbargs = NULL;
1071 PL_debstash = NULL;
1072
1073 SvREFCNT_dec(PL_envgv);
1074 SvREFCNT_dec(PL_incgv);
1075 SvREFCNT_dec(PL_argvgv);
1076 SvREFCNT_dec(PL_replgv);
1077 SvREFCNT_dec(PL_DBgv);
1078 SvREFCNT_dec(PL_DBline);
1079 SvREFCNT_dec(PL_DBsub);
1080 PL_envgv = NULL;
1081 PL_incgv = NULL;
1082 PL_argvgv = NULL;
1083 PL_replgv = NULL;
1084 PL_DBgv = NULL;
1085 PL_DBline = NULL;
1086 PL_DBsub = NULL;
1087
1088 SvREFCNT_dec(PL_argvout_stack);
1089 PL_argvout_stack = NULL;
1090
1091 SvREFCNT_dec(PL_modglobal);
1092 PL_modglobal = NULL;
1093 SvREFCNT_dec(PL_preambleav);
1094 PL_preambleav = NULL;
1095 SvREFCNT_dec(PL_subname);
1096 PL_subname = NULL;
1097#ifdef PERL_USES_PL_PIDSTATUS
1098 SvREFCNT_dec(PL_pidstatus);
1099 PL_pidstatus = NULL;
1100#endif
1101 SvREFCNT_dec(PL_toptarget);
1102 PL_toptarget = NULL;
1103 SvREFCNT_dec(PL_bodytarget);
1104 PL_bodytarget = NULL;
1105 PL_formtarget = NULL;
1106
1107 /* free locale stuff */
1108#ifdef USE_LOCALE_COLLATE
1109 Safefree(PL_collation_name);
1110 PL_collation_name = NULL;
1111#endif
1112#if defined(USE_POSIX_2008_LOCALE) \
1113 && defined(USE_THREAD_SAFE_LOCALE) \
1114 && ! defined(HAS_QUERYLOCALE)
1115 for (i = 0; i < (int) C_ARRAY_LENGTH(PL_curlocales); i++) {
1116 Safefree(PL_curlocales[i]);
1117 PL_curlocales[i] = NULL;
1118 }
1119#endif
1120#ifdef HAS_POSIX_2008_LOCALE
1121 {
1122 /* This also makes sure we aren't using a locale object that gets freed
1123 * below */
1124 const locale_t old_locale = uselocale(LC_GLOBAL_LOCALE);
1125 if ( old_locale != LC_GLOBAL_LOCALE
1126# ifdef USE_POSIX_2008_LOCALE
1127 && old_locale != PL_C_locale_obj
1128# endif
1129 ) {
1130 DEBUG_Lv(PerlIO_printf(Perl_debug_log,
1131 "%s:%d: Freeing %p\n", __FILE__, __LINE__, old_locale));
1132 freelocale(old_locale);
1133 }
1134 }
1135# ifdef USE_LOCALE_NUMERIC
1136 if (PL_underlying_numeric_obj) {
1137 DEBUG_Lv(PerlIO_printf(Perl_debug_log,
1138 "%s:%d: Freeing %p\n", __FILE__, __LINE__,
1139 PL_underlying_numeric_obj));
1140 freelocale(PL_underlying_numeric_obj);
1141 PL_underlying_numeric_obj = (locale_t) NULL;
1142 }
1143# endif
1144#endif
1145#ifdef USE_LOCALE_NUMERIC
1146 Safefree(PL_numeric_name);
1147 PL_numeric_name = NULL;
1148 SvREFCNT_dec(PL_numeric_radix_sv);
1149 PL_numeric_radix_sv = NULL;
1150#endif
1151
1152 if (PL_setlocale_buf) {
1153 Safefree(PL_setlocale_buf);
1154 PL_setlocale_buf = NULL;
1155 }
1156
1157 if (PL_langinfo_buf) {
1158 Safefree(PL_langinfo_buf);
1159 PL_langinfo_buf = NULL;
1160 }
1161
1162#ifdef USE_LOCALE_CTYPE
1163 SvREFCNT_dec(PL_warn_locale);
1164 PL_warn_locale = NULL;
1165#endif
1166
1167 SvREFCNT_dec(PL_AboveLatin1);
1168 PL_AboveLatin1 = NULL;
1169 SvREFCNT_dec(PL_Assigned_invlist);
1170 PL_Assigned_invlist = NULL;
1171 SvREFCNT_dec(PL_GCB_invlist);
1172 PL_GCB_invlist = NULL;
1173 SvREFCNT_dec(PL_HasMultiCharFold);
1174 PL_HasMultiCharFold = NULL;
1175 SvREFCNT_dec(PL_InMultiCharFold);
1176 PL_InMultiCharFold = NULL;
1177 SvREFCNT_dec(PL_Latin1);
1178 PL_Latin1 = NULL;
1179 SvREFCNT_dec(PL_LB_invlist);
1180 PL_LB_invlist = NULL;
1181 SvREFCNT_dec(PL_SB_invlist);
1182 PL_SB_invlist = NULL;
1183 SvREFCNT_dec(PL_SCX_invlist);
1184 PL_SCX_invlist = NULL;
1185 SvREFCNT_dec(PL_UpperLatin1);
1186 PL_UpperLatin1 = NULL;
1187 SvREFCNT_dec(PL_in_some_fold);
1188 PL_in_some_fold = NULL;
1189 SvREFCNT_dec(PL_utf8_foldclosures);
1190 PL_utf8_foldclosures = NULL;
1191 SvREFCNT_dec(PL_utf8_idcont);
1192 PL_utf8_idcont = NULL;
1193 SvREFCNT_dec(PL_utf8_idstart);
1194 PL_utf8_idstart = NULL;
1195 SvREFCNT_dec(PL_utf8_perl_idcont);
1196 PL_utf8_perl_idcont = NULL;
1197 SvREFCNT_dec(PL_utf8_perl_idstart);
1198 PL_utf8_perl_idstart = NULL;
1199 SvREFCNT_dec(PL_utf8_xidcont);
1200 PL_utf8_xidcont = NULL;
1201 SvREFCNT_dec(PL_utf8_xidstart);
1202 PL_utf8_xidstart = NULL;
1203 SvREFCNT_dec(PL_WB_invlist);
1204 PL_WB_invlist = NULL;
1205 SvREFCNT_dec(PL_utf8_toupper);
1206 PL_utf8_toupper = NULL;
1207 SvREFCNT_dec(PL_utf8_totitle);
1208 PL_utf8_totitle = NULL;
1209 SvREFCNT_dec(PL_utf8_tolower);
1210 PL_utf8_tolower = NULL;
1211 SvREFCNT_dec(PL_utf8_tofold);
1212 PL_utf8_tofold = NULL;
1213 SvREFCNT_dec(PL_utf8_tosimplefold);
1214 PL_utf8_tosimplefold = NULL;
1215 SvREFCNT_dec(PL_utf8_charname_begin);
1216 PL_utf8_charname_begin = NULL;
1217 SvREFCNT_dec(PL_utf8_charname_continue);
1218 PL_utf8_charname_continue = NULL;
1219 SvREFCNT_dec(PL_utf8_mark);
1220 PL_utf8_mark = NULL;
1221 SvREFCNT_dec(PL_InBitmap);
1222 PL_InBitmap = NULL;
1223 SvREFCNT_dec(PL_CCC_non0_non230);
1224 PL_CCC_non0_non230 = NULL;
1225 SvREFCNT_dec(PL_Private_Use);
1226 PL_Private_Use = NULL;
1227
1228 for (i = 0; i < POSIX_CC_COUNT; i++) {
1229 SvREFCNT_dec(PL_XPosix_ptrs[i]);
1230 PL_XPosix_ptrs[i] = NULL;
1231
1232 if (i != _CC_CASED) { /* A copy of Alpha */
1233 SvREFCNT_dec(PL_Posix_ptrs[i]);
1234 PL_Posix_ptrs[i] = NULL;
1235 }
1236 }
1237
1238 free_and_set_cop_warnings(&PL_compiling, NULL);
1239 cophh_free(CopHINTHASH_get(&PL_compiling));
1240 CopHINTHASH_set(&PL_compiling, cophh_new_empty());
1241 CopFILE_free(&PL_compiling);
1242
1243 /* Prepare to destruct main symbol table. */
1244
1245 hv = PL_defstash;
1246 /* break ref loop *:: <=> %:: */
1247 (void)hv_deletes(hv, "main::", G_DISCARD);
1248 PL_defstash = 0;
1249 SvREFCNT_dec(hv);
1250 SvREFCNT_dec(PL_curstname);
1251 PL_curstname = NULL;
1252
1253 /* clear queued errors */
1254 SvREFCNT_dec(PL_errors);
1255 PL_errors = NULL;
1256
1257 SvREFCNT_dec(PL_isarev);
1258
1259 FREETMPS;
1260 if (destruct_level >= 2) {
1261 if (PL_scopestack_ix != 0)
1262 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
1263 "Unbalanced scopes: %ld more ENTERs than LEAVEs\n",
1264 (long)PL_scopestack_ix);
1265 if (PL_savestack_ix != 0)
1266 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
1267 "Unbalanced saves: %ld more saves than restores\n",
1268 (long)PL_savestack_ix);
1269 if (PL_tmps_floor != -1)
1270 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced tmps: %ld more allocs than frees\n",
1271 (long)PL_tmps_floor + 1);
1272 if (cxstack_ix != -1)
1273 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced context: %ld more PUSHes than POPs\n",
1274 (long)cxstack_ix + 1);
1275 }
1276
1277#ifdef USE_ITHREADS
1278 SvREFCNT_dec(PL_regex_padav);
1279 PL_regex_padav = NULL;
1280 PL_regex_pad = NULL;
1281#endif
1282
1283#ifdef PERL_IMPLICIT_CONTEXT
1284 /* the entries in this list are allocated via SV PVX's, so get freed
1285 * in sv_clean_all */
1286 Safefree(PL_my_cxt_list);
1287#endif
1288
1289 /* Now absolutely destruct everything, somehow or other, loops or no. */
1290
1291 /* the 2 is for PL_fdpid and PL_strtab */
1292 while (sv_clean_all() > 2)
1293 ;
1294
1295#ifdef USE_ITHREADS
1296 Safefree(PL_stashpad); /* must come after sv_clean_all */
1297#endif
1298
1299 AvREAL_off(PL_fdpid); /* no surviving entries */
1300 SvREFCNT_dec(PL_fdpid); /* needed in io_close() */
1301 PL_fdpid = NULL;
1302
1303#ifdef HAVE_INTERP_INTERN
1304 sys_intern_clear();
1305#endif
1306
1307 /* constant strings */
1308 for (i = 0; i < SV_CONSTS_COUNT; i++) {
1309 SvREFCNT_dec(PL_sv_consts[i]);
1310 PL_sv_consts[i] = NULL;
1311 }
1312
1313 /* Destruct the global string table. */
1314 {
1315 /* Yell and reset the HeVAL() slots that are still holding refcounts,
1316 * so that sv_free() won't fail on them.
1317 * Now that the global string table is using a single hunk of memory
1318 * for both HE and HEK, we either need to explicitly unshare it the
1319 * correct way, or actually free things here.
1320 */
1321 I32 riter = 0;
1322 const I32 max = HvMAX(PL_strtab);
1323 HE * const * const array = HvARRAY(PL_strtab);
1324 HE *hent = array[0];
1325
1326 for (;;) {
1327 if (hent && ckWARN_d(WARN_INTERNAL)) {
1328 HE * const next = HeNEXT(hent);
1329 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
1330 "Unbalanced string table refcount: (%ld) for \"%s\"",
1331 (long)hent->he_valu.hent_refcount, HeKEY(hent));
1332 Safefree(hent);
1333 hent = next;
1334 }
1335 if (!hent) {
1336 if (++riter > max)
1337 break;
1338 hent = array[riter];
1339 }
1340 }
1341
1342 Safefree(array);
1343 HvARRAY(PL_strtab) = 0;
1344 HvTOTALKEYS(PL_strtab) = 0;
1345 }
1346 SvREFCNT_dec(PL_strtab);
1347
1348#ifdef USE_ITHREADS
1349 /* free the pointer tables used for cloning */
1350 ptr_table_free(PL_ptr_table);
1351 PL_ptr_table = (PTR_TBL_t*)NULL;
1352#endif
1353
1354 /* free special SVs */
1355
1356 SvREFCNT(&PL_sv_yes) = 0;
1357 sv_clear(&PL_sv_yes);
1358 SvANY(&PL_sv_yes) = NULL;
1359 SvFLAGS(&PL_sv_yes) = 0;
1360
1361 SvREFCNT(&PL_sv_no) = 0;
1362 sv_clear(&PL_sv_no);
1363 SvANY(&PL_sv_no) = NULL;
1364 SvFLAGS(&PL_sv_no) = 0;
1365
1366 SvREFCNT(&PL_sv_zero) = 0;
1367 sv_clear(&PL_sv_zero);
1368 SvANY(&PL_sv_zero) = NULL;
1369 SvFLAGS(&PL_sv_zero) = 0;
1370
1371 {
1372 int i;
1373 for (i=0; i<=2; i++) {
1374 SvREFCNT(PERL_DEBUG_PAD(i)) = 0;
1375 sv_clear(PERL_DEBUG_PAD(i));
1376 SvANY(PERL_DEBUG_PAD(i)) = NULL;
1377 SvFLAGS(PERL_DEBUG_PAD(i)) = 0;
1378 }
1379 }
1380
1381 if (PL_sv_count != 0 && ckWARN_d(WARN_INTERNAL))
1382 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Scalars leaked: %ld\n", (long)PL_sv_count);
1383
1384#ifdef DEBUG_LEAKING_SCALARS
1385 if (PL_sv_count != 0) {
1386 SV* sva;
1387 SV* sv;
1388 SV* svend;
1389
1390 for (sva = PL_sv_arenaroot; sva; sva = MUTABLE_SV(SvANY(sva))) {
1391 svend = &sva[SvREFCNT(sva)];
1392 for (sv = sva + 1; sv < svend; ++sv) {
1393 if (SvTYPE(sv) != (svtype)SVTYPEMASK) {
1394 PerlIO_printf(Perl_debug_log, "leaked: sv=0x%p"
1395 " flags=0x%" UVxf
1396 " refcnt=%" UVuf pTHX__FORMAT "\n"
1397 "\tallocated at %s:%d %s %s (parent 0x%" UVxf ");"
1398 "serial %" UVuf "\n",
1399 (void*)sv, (UV)sv->sv_flags, (UV)sv->sv_refcnt
1400 pTHX__VALUE,
1401 sv->sv_debug_file ? sv->sv_debug_file : "(unknown)",
1402 sv->sv_debug_line,
1403 sv->sv_debug_inpad ? "for" : "by",
1404 sv->sv_debug_optype ?
1405 PL_op_name[sv->sv_debug_optype]: "(none)",
1406 PTR2UV(sv->sv_debug_parent),
1407 sv->sv_debug_serial
1408 );
1409#ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1410 Perl_dump_sv_child(aTHX_ sv);
1411#endif
1412 }
1413 }
1414 }
1415 }
1416#ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1417 {
1418 int status;
1419 fd_set rset;
1420 /* Wait for up to 4 seconds for child to terminate.
1421 This seems to be the least effort way of timing out on reaping
1422 its exit status. */
1423 struct timeval waitfor = {4, 0};
1424 int sock = PL_dumper_fd;
1425
1426 shutdown(sock, 1);
1427 FD_ZERO(&rset);
1428 FD_SET(sock, &rset);
1429 select(sock + 1, &rset, NULL, NULL, &waitfor);
1430 waitpid(child, &status, WNOHANG);
1431 close(sock);
1432 }
1433#endif
1434#endif
1435#ifdef DEBUG_LEAKING_SCALARS_ABORT
1436 if (PL_sv_count)
1437 abort();
1438#endif
1439 PL_sv_count = 0;
1440
1441#if defined(PERLIO_LAYERS)
1442 /* No more IO - including error messages ! */
1443 PerlIO_cleanup(aTHX);
1444#endif
1445
1446 /* sv_undef needs to stay immortal until after PerlIO_cleanup
1447 as currently layers use it rather than NULL as a marker
1448 for no arg - and will try and SvREFCNT_dec it.
1449 */
1450 SvREFCNT(&PL_sv_undef) = 0;
1451 SvREADONLY_off(&PL_sv_undef);
1452
1453 Safefree(PL_origfilename);
1454 PL_origfilename = NULL;
1455 Safefree(PL_reg_curpm);
1456 free_tied_hv_pool();
1457 Safefree(PL_op_mask);
1458 Safefree(PL_psig_name);
1459 PL_psig_name = (SV**)NULL;
1460 PL_psig_ptr = (SV**)NULL;
1461 {
1462 /* We need to NULL PL_psig_pend first, so that
1463 signal handlers know not to use it */
1464 int *psig_save = PL_psig_pend;
1465 PL_psig_pend = (int*)NULL;
1466 Safefree(psig_save);
1467 }
1468 nuke_stacks();
1469 TAINTING_set(FALSE);
1470 TAINT_WARN_set(FALSE);
1471 PL_hints = 0; /* Reset hints. Should hints be per-interpreter ? */
1472
1473 DEBUG_P(debprofdump());
1474
1475 PL_debug = 0;
1476
1477#ifdef USE_REENTRANT_API
1478 Perl_reentrant_free(aTHX);
1479#endif
1480
1481 /* These all point to HVs that are about to be blown away.
1482 Code in core and on CPAN assumes that if the interpreter is re-started
1483 that they will be cleanly NULL or pointing to a valid HV. */
1484 PL_custom_op_names = NULL;
1485 PL_custom_op_descs = NULL;
1486 PL_custom_ops = NULL;
1487
1488 sv_free_arenas();
1489
1490 while (PL_regmatch_slab) {
1491 regmatch_slab *s = PL_regmatch_slab;
1492 PL_regmatch_slab = PL_regmatch_slab->next;
1493 Safefree(s);
1494 }
1495
1496 /* As the absolutely last thing, free the non-arena SV for mess() */
1497
1498 if (PL_mess_sv) {
1499 /* we know that type == SVt_PVMG */
1500
1501 /* it could have accumulated taint magic */
1502 MAGIC* mg;
1503 MAGIC* moremagic;
1504 for (mg = SvMAGIC(PL_mess_sv); mg; mg = moremagic) {
1505 moremagic = mg->mg_moremagic;
1506 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global
1507 && mg->mg_len >= 0)
1508 Safefree(mg->mg_ptr);
1509 Safefree(mg);
1510 }
1511
1512 /* we know that type >= SVt_PV */
1513 SvPV_free(PL_mess_sv);
1514 Safefree(SvANY(PL_mess_sv));
1515 Safefree(PL_mess_sv);
1516 PL_mess_sv = NULL;
1517 }
1518 return STATUS_EXIT;
1519}
1520
1521/*
1522=for apidoc perl_free
1523
1524Releases a Perl interpreter. See L<perlembed>.
1525
1526=cut
1527*/
1528
1529void
1530perl_free(pTHXx)
1531{
1532
1533 PERL_ARGS_ASSERT_PERL_FREE;
1534
1535 if (PL_veto_cleanup)
1536 return;
1537
1538#ifdef PERL_TRACK_MEMPOOL
1539 {
1540 /*
1541 * Don't free thread memory if PERL_DESTRUCT_LEVEL is set to a non-zero
1542 * value as we're probably hunting memory leaks then
1543 */
1544 if (PL_perl_destruct_level == 0) {
1545 const U32 old_debug = PL_debug;
1546 /* Emulate the PerlHost behaviour of free()ing all memory allocated in this
1547 thread at thread exit. */
1548 if (DEBUG_m_TEST) {
1549 PerlIO_puts(Perl_debug_log, "Disabling memory debugging as we "
1550 "free this thread's memory\n");
1551 PL_debug &= ~ DEBUG_m_FLAG;
1552 }
1553 while(aTHXx->Imemory_debug_header.next != &(aTHXx->Imemory_debug_header)){
1554 char * next = (char *)(aTHXx->Imemory_debug_header.next);
1555 Malloc_t ptr = PERL_MEMORY_DEBUG_HEADER_SIZE + next;
1556 safesysfree(ptr);
1557 }
1558 PL_debug = old_debug;
1559 }
1560 }
1561#endif
1562
1563#if defined(WIN32) || defined(NETWARE)
1564# if defined(PERL_IMPLICIT_SYS)
1565 {
1566# ifdef NETWARE
1567 void *host = nw_internal_host;
1568 PerlMem_free(aTHXx);
1569 nw_delete_internal_host(host);
1570# else
1571 void *host = w32_internal_host;
1572 PerlMem_free(aTHXx);
1573 win32_delete_internal_host(host);
1574# endif
1575 }
1576# else
1577 PerlMem_free(aTHXx);
1578# endif
1579#else
1580 PerlMem_free(aTHXx);
1581#endif
1582}
1583
1584#if defined(USE_ITHREADS)
1585/* provide destructors to clean up the thread key when libperl is unloaded */
1586#ifndef WIN32 /* handled during DLL_PROCESS_DETACH in win32/perllib.c */
1587
1588#if defined(__hpux) && !(defined(__ux_version) && __ux_version <= 1020) && !defined(__GNUC__)
1589#pragma fini "perl_fini"
1590#elif defined(__sun) && !defined(__GNUC__)
1591#pragma fini (perl_fini)
1592#endif
1593
1594static void
1595#if defined(__GNUC__)
1596__attribute__((destructor))
1597#endif
1598perl_fini(void)
1599{
1600 if (
1601 PL_curinterp && !PL_veto_cleanup)
1602 FREE_THREAD_KEY;
1603}
1604
1605#endif /* WIN32 */
1606#endif /* THREADS */
1607
1608void
1609Perl_call_atexit(pTHX_ ATEXIT_t fn, void *ptr)
1610{
1611 Renew(PL_exitlist, PL_exitlistlen+1, PerlExitListEntry);
1612 PL_exitlist[PL_exitlistlen].fn = fn;
1613 PL_exitlist[PL_exitlistlen].ptr = ptr;
1614 ++PL_exitlistlen;
1615}
1616
1617/*
1618=for apidoc perl_parse
1619
1620Tells a Perl interpreter to parse a Perl script. This performs most
1621of the initialisation of a Perl interpreter. See L<perlembed> for
1622a tutorial.
1623
1624C<my_perl> points to the Perl interpreter that is to parse the script.
1625It must have been previously created through the use of L</perl_alloc>
1626and L</perl_construct>. C<xsinit> points to a callback function that
1627will be called to set up the ability for this Perl interpreter to load
1628XS extensions, or may be null to perform no such setup.
1629
1630C<argc> and C<argv> supply a set of command-line arguments to the Perl
1631interpreter, as would normally be passed to the C<main> function of
1632a C program. C<argv[argc]> must be null. These arguments are where
1633the script to parse is specified, either by naming a script file or by
1634providing a script in a C<-e> option.
1635If L<C<$0>|perlvar/$0> will be written to in the Perl interpreter, then
1636the argument strings must be in writable memory, and so mustn't just be
1637string constants.
1638
1639C<env> specifies a set of environment variables that will be used by
1640this Perl interpreter. If non-null, it must point to a null-terminated
1641array of environment strings. If null, the Perl interpreter will use
1642the environment supplied by the C<environ> global variable.
1643
1644This function initialises the interpreter, and parses and compiles the
1645script specified by the command-line arguments. This includes executing
1646code in C<BEGIN>, C<UNITCHECK>, and C<CHECK> blocks. It does not execute
1647C<INIT> blocks or the main program.
1648
1649Returns an integer of slightly tricky interpretation. The correct
1650use of the return value is as a truth value indicating whether there
1651was a failure in initialisation. If zero is returned, this indicates
1652that initialisation was successful, and it is safe to proceed to call
1653L</perl_run> and make other use of it. If a non-zero value is returned,
1654this indicates some problem that means the interpreter wants to terminate.
1655The interpreter should not be just abandoned upon such failure; the caller
1656should proceed to shut the interpreter down cleanly with L</perl_destruct>
1657and free it with L</perl_free>.
1658
1659For historical reasons, the non-zero return value also attempts to
1660be a suitable value to pass to the C library function C<exit> (or to
1661return from C<main>), to serve as an exit code indicating the nature
1662of the way initialisation terminated. However, this isn't portable,
1663due to differing exit code conventions. A historical bug is preserved
1664for the time being: if the Perl built-in C<exit> is called during this
1665function's execution, with a type of exit entailing a zero exit code
1666under the host operating system's conventions, then this function
1667returns zero rather than a non-zero value. This bug, [perl #2754],
1668leads to C<perl_run> being called (and therefore C<INIT> blocks and the
1669main program running) despite a call to C<exit>. It has been preserved
1670because a popular module-installing module has come to rely on it and
1671needs time to be fixed. This issue is [perl #132577], and the original
1672bug is due to be fixed in Perl 5.30.
1673
1674=cut
1675*/
1676
1677#define SET_CURSTASH(newstash) \
1678 if (PL_curstash != newstash) { \
1679 SvREFCNT_dec(PL_curstash); \
1680 PL_curstash = (HV *)SvREFCNT_inc(newstash); \
1681 }
1682
1683int
1684perl_parse(pTHXx_ XSINIT_t xsinit, int argc, char **argv, char **env)
1685{
1686 I32 oldscope;
1687 int ret;
1688 dJMPENV;
1689
1690 PERL_ARGS_ASSERT_PERL_PARSE;
1691#ifndef MULTIPLICITY
1692 PERL_UNUSED_ARG(my_perl);
1693#endif
1694#if (defined(USE_HASH_SEED) || defined(USE_HASH_SEED_DEBUG)) && !defined(NO_PERL_HASH_SEED_DEBUG)
1695 {
1696 const char * const s = PerlEnv_getenv("PERL_HASH_SEED_DEBUG");
1697
1698 if (s && strEQ(s, "1")) {
1699 const unsigned char *seed= PERL_HASH_SEED;
1700 const unsigned char *seed_end= PERL_HASH_SEED + PERL_HASH_SEED_BYTES;
1701 PerlIO_printf(Perl_debug_log, "HASH_FUNCTION = %s HASH_SEED = 0x", PERL_HASH_FUNC);
1702 while (seed < seed_end) {
1703 PerlIO_printf(Perl_debug_log, "%02x", *seed++);
1704 }
1705#ifdef PERL_HASH_RANDOMIZE_KEYS
1706 PerlIO_printf(Perl_debug_log, " PERTURB_KEYS = %d (%s)",
1707 PL_HASH_RAND_BITS_ENABLED,
1708 PL_HASH_RAND_BITS_ENABLED == 0 ? "NO" : PL_HASH_RAND_BITS_ENABLED == 1 ? "RANDOM" : "DETERMINISTIC");
1709#endif
1710 PerlIO_printf(Perl_debug_log, "\n");
1711 }
1712 }
1713#endif /* #if (defined(USE_HASH_SEED) ... */
1714
1715#ifdef __amigaos4__
1716 {
1717 struct NameTranslationInfo nti;
1718 __translate_amiga_to_unix_path_name(&argv[0],&nti);
1719 }
1720#endif
1721
1722 {
1723 int i;
1724 assert(argc >= 0);
1725 for(i = 0; i != argc; i++)
1726 assert(argv[i]);
1727 assert(!argv[argc]);
1728 }
1729 PL_origargc = argc;
1730 PL_origargv = argv;
1731
1732 if (PL_origalen != 0) {
1733 PL_origalen = 1; /* don't use old PL_origalen if perl_parse() is called again */
1734 }
1735 else {
1736 /* Set PL_origalen be the sum of the contiguous argv[]
1737 * elements plus the size of the env in case that it is
1738 * contiguous with the argv[]. This is used in mg.c:Perl_magic_set()
1739 * as the maximum modifiable length of $0. In the worst case
1740 * the area we are able to modify is limited to the size of
1741 * the original argv[0]. (See below for 'contiguous', though.)
1742 * --jhi */
1743 const char *s = NULL;
1744 const UV mask = ~(UV)(PTRSIZE-1);
1745 /* Do the mask check only if the args seem like aligned. */
1746 const UV aligned =
1747 (mask < ~(UV)0) && ((PTR2UV(argv[0]) & mask) == PTR2UV(argv[0]));
1748
1749 /* See if all the arguments are contiguous in memory. Note
1750 * that 'contiguous' is a loose term because some platforms
1751 * align the argv[] and the envp[]. If the arguments look
1752 * like non-aligned, assume that they are 'strictly' or
1753 * 'traditionally' contiguous. If the arguments look like
1754 * aligned, we just check that they are within aligned
1755 * PTRSIZE bytes. As long as no system has something bizarre
1756 * like the argv[] interleaved with some other data, we are
1757 * fine. (Did I just evoke Murphy's Law?) --jhi */
1758 if (PL_origargv && PL_origargc >= 1 && (s = PL_origargv[0])) {
1759 int i;
1760 while (*s) s++;
1761 for (i = 1; i < PL_origargc; i++) {
1762 if ((PL_origargv[i] == s + 1
1763#ifdef OS2
1764 || PL_origargv[i] == s + 2
1765#endif
1766 )
1767 ||
1768 (aligned &&
1769 (PL_origargv[i] > s &&
1770 PL_origargv[i] <=
1771 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1772 )
1773 {
1774 s = PL_origargv[i];
1775 while (*s) s++;
1776 }
1777 else
1778 break;
1779 }
1780 }
1781
1782#ifndef PERL_USE_SAFE_PUTENV
1783 /* Can we grab env area too to be used as the area for $0? */
1784 if (s && PL_origenviron && !PL_use_safe_putenv) {
1785 if ((PL_origenviron[0] == s + 1)
1786 ||
1787 (aligned &&
1788 (PL_origenviron[0] > s &&
1789 PL_origenviron[0] <=
1790 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1791 )
1792 {
1793 int i;
1794#ifndef OS2 /* ENVIRON is read by the kernel too. */
1795 s = PL_origenviron[0];
1796 while (*s) s++;
1797#endif
1798 my_setenv("NoNe SuCh", NULL);
1799 /* Force copy of environment. */
1800 for (i = 1; PL_origenviron[i]; i++) {
1801 if (PL_origenviron[i] == s + 1
1802 ||
1803 (aligned &&
1804 (PL_origenviron[i] > s &&
1805 PL_origenviron[i] <=
1806 INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1807 )
1808 {
1809 s = PL_origenviron[i];
1810 while (*s) s++;
1811 }
1812 else
1813 break;
1814 }
1815 }
1816 }
1817#endif /* !defined(PERL_USE_SAFE_PUTENV) */
1818
1819 PL_origalen = s ? s - PL_origargv[0] + 1 : 0;
1820 }
1821
1822 if (PL_do_undump) {
1823
1824 /* Come here if running an undumped a.out. */
1825
1826 PL_origfilename = savepv(argv[0]);
1827 PL_do_undump = FALSE;
1828 cxstack_ix = -1; /* start label stack again */
1829 init_ids();
1830 assert (!TAINT_get);
1831 TAINT;
1832 set_caret_X();
1833 TAINT_NOT;
1834 init_postdump_symbols(argc,argv,env);
1835 return 0;
1836 }
1837
1838 if (PL_main_root) {
1839 op_free(PL_main_root);
1840 PL_main_root = NULL;
1841 }
1842 PL_main_start = NULL;
1843 SvREFCNT_dec(PL_main_cv);
1844 PL_main_cv = NULL;
1845
1846 time(&PL_basetime);
1847 oldscope = PL_scopestack_ix;
1848 PL_dowarn = G_WARN_OFF;
1849
1850 JMPENV_PUSH(ret);
1851 switch (ret) {
1852 case 0:
1853 parse_body(env,xsinit);
1854 if (PL_unitcheckav) {
1855 call_list(oldscope, PL_unitcheckav);
1856 }
1857 if (PL_checkav) {
1858 PERL_SET_PHASE(PERL_PHASE_CHECK);
1859 call_list(oldscope, PL_checkav);
1860 }
1861 ret = 0;
1862 break;
1863 case 1:
1864 STATUS_ALL_FAILURE;
1865 /* FALLTHROUGH */
1866 case 2:
1867 /* my_exit() was called */
1868 while (PL_scopestack_ix > oldscope)
1869 LEAVE;
1870 FREETMPS;
1871 SET_CURSTASH(PL_defstash);
1872 if (PL_unitcheckav) {
1873 call_list(oldscope, PL_unitcheckav);
1874 }
1875 if (PL_checkav) {
1876 PERL_SET_PHASE(PERL_PHASE_CHECK);
1877 call_list(oldscope, PL_checkav);
1878 }
1879 ret = STATUS_EXIT;
1880 if (ret == 0) {
1881 /*
1882 * At this point we should do
1883 * ret = 0x100;
1884 * to avoid [perl #2754], but that bugfix has been postponed
1885 * because of the Module::Install breakage it causes
1886 * [perl #132577].
1887 */
1888 }
1889 break;
1890 case 3:
1891 PerlIO_printf(Perl_error_log, "panic: top_env\n");
1892 ret = 1;
1893 break;
1894 }
1895 JMPENV_POP;
1896 return ret;
1897}
1898
1899/* This needs to stay in perl.c, as perl.c is compiled with different flags for
1900 miniperl, and we need to see those flags reflected in the values here. */
1901
1902/* What this returns is subject to change. Use the public interface in Config.
1903 */
1904static void
1905S_Internals_V(pTHX_ CV *cv)
1906{
1907 dXSARGS;
1908#ifdef LOCAL_PATCH_COUNT
1909 const int local_patch_count = LOCAL_PATCH_COUNT;
1910#else
1911 const int local_patch_count = 0;
1912#endif
1913 const int entries = 3 + local_patch_count;
1914 int i;
1915 static const char non_bincompat_options[] =
1916# ifdef DEBUGGING
1917 " DEBUGGING"
1918# endif
1919# ifdef NO_MATHOMS
1920 " NO_MATHOMS"
1921# endif
1922# ifdef NO_HASH_SEED
1923 " NO_HASH_SEED"
1924# endif
1925# ifdef NO_TAINT_SUPPORT
1926 " NO_TAINT_SUPPORT"
1927# endif
1928# ifdef PERL_BOOL_AS_CHAR
1929 " PERL_BOOL_AS_CHAR"
1930# endif
1931# ifdef PERL_COPY_ON_WRITE
1932 " PERL_COPY_ON_WRITE"
1933# endif
1934# ifdef PERL_DISABLE_PMC
1935 " PERL_DISABLE_PMC"
1936# endif
1937# ifdef PERL_DONT_CREATE_GVSV
1938 " PERL_DONT_CREATE_GVSV"
1939# endif
1940# ifdef PERL_EXTERNAL_GLOB
1941 " PERL_EXTERNAL_GLOB"
1942# endif
1943# ifdef PERL_HASH_FUNC_SIPHASH
1944 " PERL_HASH_FUNC_SIPHASH"
1945# endif
1946# ifdef PERL_HASH_FUNC_SDBM
1947 " PERL_HASH_FUNC_SDBM"
1948# endif
1949# ifdef PERL_HASH_FUNC_DJB2
1950 " PERL_HASH_FUNC_DJB2"
1951# endif
1952# ifdef PERL_HASH_FUNC_SUPERFAST
1953 " PERL_HASH_FUNC_SUPERFAST"
1954# endif
1955# ifdef PERL_HASH_FUNC_MURMUR3
1956 " PERL_HASH_FUNC_MURMUR3"
1957# endif
1958# ifdef PERL_HASH_FUNC_ONE_AT_A_TIME
1959 " PERL_HASH_FUNC_ONE_AT_A_TIME"
1960# endif
1961# ifdef PERL_HASH_FUNC_ONE_AT_A_TIME_HARD
1962 " PERL_HASH_FUNC_ONE_AT_A_TIME_HARD"
1963# endif
1964# ifdef PERL_HASH_FUNC_ONE_AT_A_TIME_OLD
1965 " PERL_HASH_FUNC_ONE_AT_A_TIME_OLD"
1966# endif
1967# ifdef PERL_IS_MINIPERL
1968 " PERL_IS_MINIPERL"
1969# endif
1970# ifdef PERL_MALLOC_WRAP
1971 " PERL_MALLOC_WRAP"
1972# endif
1973# ifdef PERL_MEM_LOG
1974 " PERL_MEM_LOG"
1975# endif
1976# ifdef PERL_MEM_LOG_NOIMPL
1977 " PERL_MEM_LOG_NOIMPL"
1978# endif
1979# ifdef PERL_OP_PARENT
1980 " PERL_OP_PARENT"
1981# endif
1982# ifdef PERL_PERTURB_KEYS_DETERMINISTIC
1983 " PERL_PERTURB_KEYS_DETERMINISTIC"
1984# endif
1985# ifdef PERL_PERTURB_KEYS_DISABLED
1986 " PERL_PERTURB_KEYS_DISABLED"
1987# endif
1988# ifdef PERL_PERTURB_KEYS_RANDOM
1989 " PERL_PERTURB_KEYS_RANDOM"
1990# endif
1991# ifdef PERL_PRESERVE_IVUV
1992 " PERL_PRESERVE_IVUV"
1993# endif
1994# ifdef PERL_RELOCATABLE_INCPUSH
1995 " PERL_RELOCATABLE_INCPUSH"
1996# endif
1997# ifdef PERL_USE_DEVEL
1998 " PERL_USE_DEVEL"
1999# endif
2000# ifdef PERL_USE_SAFE_PUTENV
2001 " PERL_USE_SAFE_PUTENV"
2002# endif
2003# ifdef SILENT_NO_TAINT_SUPPORT
2004 " SILENT_NO_TAINT_SUPPORT"
2005# endif
2006# ifdef UNLINK_ALL_VERSIONS
2007 " UNLINK_ALL_VERSIONS"
2008# endif
2009# ifdef USE_ATTRIBUTES_FOR_PERLIO
2010 " USE_ATTRIBUTES_FOR_PERLIO"
2011# endif
2012# ifdef USE_FAST_STDIO
2013 " USE_FAST_STDIO"
2014# endif
2015# ifdef USE_LOCALE
2016 " USE_LOCALE"
2017# endif
2018# ifdef USE_LOCALE_CTYPE
2019 " USE_LOCALE_CTYPE"
2020# endif
2021# ifdef WIN32_NO_REGISTRY
2022 " USE_NO_REGISTRY"
2023# endif
2024# ifdef USE_PERL_ATOF
2025 " USE_PERL_ATOF"
2026# endif
2027# ifdef USE_SITECUSTOMIZE
2028 " USE_SITECUSTOMIZE"
2029# endif
2030# ifdef USE_THREAD_SAFE_LOCALE
2031 " USE_THREAD_SAFE_LOCALE"
2032# endif
2033 ;
2034 PERL_UNUSED_ARG(cv);
2035 PERL_UNUSED_VAR(items);
2036
2037 EXTEND(SP, entries);
2038
2039 PUSHs(sv_2mortal(newSVpv(PL_bincompat_options, 0)));
2040 PUSHs(Perl_newSVpvn_flags(aTHX_ non_bincompat_options,
2041 sizeof(non_bincompat_options) - 1, SVs_TEMP));
2042
2043#ifndef PERL_BUILD_DATE
2044# ifdef __DATE__
2045# ifdef __TIME__
2046# define PERL_BUILD_DATE __DATE__ " " __TIME__
2047# else
2048# define PERL_BUILD_DATE __DATE__
2049# endif
2050# endif
2051#endif
2052
2053#ifdef PERL_BUILD_DATE
2054 PUSHs(Perl_newSVpvn_flags(aTHX_
2055 STR_WITH_LEN("Compiled at " PERL_BUILD_DATE),
2056 SVs_TEMP));
2057#else
2058 PUSHs(&PL_sv_undef);
2059#endif
2060
2061 for (i = 1; i <= local_patch_count; i++) {
2062 /* This will be an undef, if PL_localpatches[i] is NULL. */
2063 PUSHs(sv_2mortal(newSVpv(PL_localpatches[i], 0)));
2064 }
2065
2066 XSRETURN(entries);
2067}
2068
2069#define INCPUSH_UNSHIFT 0x01
2070#define INCPUSH_ADD_OLD_VERS 0x02
2071#define INCPUSH_ADD_VERSIONED_SUB_DIRS 0x04
2072#define INCPUSH_ADD_ARCHONLY_SUB_DIRS 0x08
2073#define INCPUSH_NOT_BASEDIR 0x10
2074#define INCPUSH_CAN_RELOCATE 0x20
2075#define INCPUSH_ADD_SUB_DIRS \
2076 (INCPUSH_ADD_VERSIONED_SUB_DIRS|INCPUSH_ADD_ARCHONLY_SUB_DIRS)
2077
2078STATIC void *
2079S_parse_body(pTHX_ char **env, XSINIT_t xsinit)
2080{
2081 PerlIO *rsfp;
2082 int argc = PL_origargc;
2083 char **argv = PL_origargv;
2084 const char *scriptname = NULL;
2085 bool dosearch = FALSE;
2086 char c;
2087 bool doextract = FALSE;
2088 const char *cddir = NULL;
2089 bool minus_e = FALSE; /* both -e and -E */
2090#ifdef USE_SITECUSTOMIZE
2091 bool minus_f = FALSE;
2092#endif
2093 SV *linestr_sv = NULL;
2094 bool add_read_e_script = FALSE;
2095 U32 lex_start_flags = 0;
2096
2097 PERL_SET_PHASE(PERL_PHASE_START);
2098
2099 init_main_stash();
2100
2101 {
2102 const char *s;
2103 for (argc--,argv++; argc > 0; argc--,argv++) {
2104 if (argv[0][0] != '-' || !argv[0][1])
2105 break;
2106 s = argv[0]+1;
2107 reswitch:
2108 switch ((c = *s)) {
2109 case 'C':
2110#ifndef PERL_STRICT_CR
2111 case '\r':
2112#endif
2113 case ' ':
2114 case '0':
2115 case 'F':
2116 case 'a':
2117 case 'c':
2118 case 'd':
2119 case 'D':
2120 case 'h':
2121 case 'i':
2122 case 'l':
2123 case 'M':
2124 case 'm':
2125 case 'n':
2126 case 'p':
2127 case 's':
2128 case 'u':
2129 case 'U':
2130 case 'v':
2131 case 'W':
2132 case 'X':
2133 case 'w':
2134 if ((s = moreswitches(s)))
2135 goto reswitch;
2136 break;
2137
2138 case 't':
2139#if defined(SILENT_NO_TAINT_SUPPORT)
2140 /* silently ignore */
2141#elif defined(NO_TAINT_SUPPORT)
2142 Perl_croak_nocontext("This perl was compiled without taint support. "
2143 "Cowardly refusing to run with -t or -T flags");
2144#else
2145 CHECK_MALLOC_TOO_LATE_FOR('t');
2146 if( !TAINTING_get ) {
2147 TAINT_WARN_set(TRUE);
2148 TAINTING_set(TRUE);
2149 }
2150#endif
2151 s++;
2152 goto reswitch;
2153 case 'T':
2154#if defined(SILENT_NO_TAINT_SUPPORT)
2155 /* silently ignore */
2156#elif defined(NO_TAINT_SUPPORT)
2157 Perl_croak_nocontext("This perl was compiled without taint support. "
2158 "Cowardly refusing to run with -t or -T flags");
2159#else
2160 CHECK_MALLOC_TOO_LATE_FOR('T');
2161 TAINTING_set(TRUE);
2162 TAINT_WARN_set(FALSE);
2163#endif
2164 s++;
2165 goto reswitch;
2166
2167 case 'E':
2168 PL_minus_E = TRUE;
2169 /* FALLTHROUGH */
2170 case 'e':
2171 forbid_setid('e', FALSE);
2172 minus_e = TRUE;
2173 if (!PL_e_script) {
2174 PL_e_script = newSVpvs("");
2175 add_read_e_script = TRUE;
2176 }
2177 if (*++s)
2178 sv_catpv(PL_e_script, s);
2179 else if (argv[1]) {
2180 sv_catpv(PL_e_script, argv[1]);
2181 argc--,argv++;
2182 }
2183 else
2184 Perl_croak(aTHX_ "No code specified for -%c", c);
2185 sv_catpvs(PL_e_script, "\n");
2186 break;
2187
2188 case 'f':
2189#ifdef USE_SITECUSTOMIZE
2190 minus_f = TRUE;
2191#endif
2192 s++;
2193 goto reswitch;
2194
2195 case 'I': /* -I handled both here and in moreswitches() */
2196 forbid_setid('I', FALSE);
2197 if (!*++s && (s=argv[1]) != NULL) {
2198 argc--,argv++;
2199 }
2200 if (s && *s) {
2201 STRLEN len = strlen(s);
2202 incpush(s, len, INCPUSH_ADD_SUB_DIRS|INCPUSH_ADD_OLD_VERS);
2203 }
2204 else
2205 Perl_croak(aTHX_ "No directory specified for -I");
2206 break;
2207 case 'S':
2208 forbid_setid('S', FALSE);
2209 dosearch = TRUE;
2210 s++;
2211 goto reswitch;
2212 case 'V':
2213 {
2214 SV *opts_prog;
2215
2216 if (*++s != ':') {
2217 opts_prog = newSVpvs("use Config; Config::_V()");
2218 }
2219 else {
2220 ++s;
2221 opts_prog = Perl_newSVpvf(aTHX_
2222 "use Config; Config::config_vars(qw%c%s%c)",
2223 0, s, 0);
2224 s += strlen(s);
2225 }
2226 Perl_av_create_and_push(aTHX_ &PL_preambleav, opts_prog);
2227 /* don't look for script or read stdin */
2228 scriptname = BIT_BUCKET;
2229 goto reswitch;
2230 }
2231 case 'x':
2232 doextract = TRUE;
2233 s++;
2234 if (*s)
2235 cddir = s;
2236 break;
2237 case 0:
2238 break;
2239 case '-':
2240 if (!*++s || isSPACE(*s)) {
2241 argc--,argv++;
2242 goto switch_end;
2243 }
2244 /* catch use of gnu style long options.
2245 Both of these exit immediately. */
2246 if (strEQ(s, "version"))
2247 minus_v();
2248 if (strEQ(s, "help"))
2249 usage();
2250 s--;
2251 /* FALLTHROUGH */
2252 default:
2253 Perl_croak(aTHX_ "Unrecognized switch: -%s (-h will show valid options)",s);
2254 }
2255 }
2256 }
2257
2258 switch_end:
2259
2260 {
2261 char *s;
2262
2263 if (
2264#ifndef SECURE_INTERNAL_GETENV
2265 !TAINTING_get &&
2266#endif
2267 (s = PerlEnv_getenv("PERL5OPT")))
2268 {
2269 while (isSPACE(*s))
2270 s++;
2271 if (*s == '-' && *(s+1) == 'T') {
2272#if defined(SILENT_NO_TAINT_SUPPORT)
2273 /* silently ignore */
2274#elif defined(NO_TAINT_SUPPORT)
2275 Perl_croak_nocontext("This perl was compiled without taint support. "
2276 "Cowardly refusing to run with -t or -T flags");
2277#else
2278 CHECK_MALLOC_TOO_LATE_FOR('T');
2279 TAINTING_set(TRUE);
2280 TAINT_WARN_set(FALSE);
2281#endif
2282 }
2283 else {
2284 char *popt_copy = NULL;
2285 while (s && *s) {
2286 const char *d;
2287 while (isSPACE(*s))
2288 s++;
2289 if (*s == '-') {
2290 s++;
2291 if (isSPACE(*s))
2292 continue;
2293 }
2294 d = s;
2295 if (!*s)
2296 break;
2297 if (!memCHRs("CDIMUdmtwW", *s))
2298 Perl_croak(aTHX_ "Illegal switch in PERL5OPT: -%c", *s);
2299 while (++s && *s) {
2300 if (isSPACE(*s)) {
2301 if (!popt_copy) {
2302 popt_copy = SvPVX(sv_2mortal(newSVpv(d,0)));
2303 s = popt_copy + (s - d);
2304 d = popt_copy;
2305 }
2306 *s++ = '\0';
2307 break;
2308 }
2309 }
2310 if (*d == 't') {
2311#if defined(SILENT_NO_TAINT_SUPPORT)
2312 /* silently ignore */
2313#elif defined(NO_TAINT_SUPPORT)
2314 Perl_croak_nocontext("This perl was compiled without taint support. "
2315 "Cowardly refusing to run with -t or -T flags");
2316#else
2317 if( !TAINTING_get) {
2318 TAINT_WARN_set(TRUE);
2319 TAINTING_set(TRUE);
2320 }
2321#endif
2322 } else {
2323 moreswitches(d);
2324 }
2325 }
2326 }
2327 }
2328 }
2329
2330#ifndef NO_PERL_INTERNAL_RAND_SEED
2331 /* If we're not set[ug]id, we might have honored
2332 PERL_INTERNAL_RAND_SEED in perl_construct().
2333 At this point command-line options have been parsed, so if
2334 we're now tainting and not set[ug]id re-seed.
2335 This could possibly be wasteful if PERL_INTERNAL_RAND_SEED is invalid,
2336 but avoids duplicating the logic from perl_construct().
2337 */
2338 if (TAINT_get &&
2339 PerlProc_getuid() == PerlProc_geteuid() &&
2340 PerlProc_getgid() == PerlProc_getegid()) {
2341 Perl_drand48_init_r(&PL_internal_random_state, seed());
2342 }
2343#endif
2344
2345 /* Set $^X early so that it can be used for relocatable paths in @INC */
2346 /* and for SITELIB_EXP in USE_SITECUSTOMIZE */
2347 assert (!TAINT_get);
2348 TAINT;
2349 set_caret_X();
2350 TAINT_NOT;
2351
2352#if defined(USE_SITECUSTOMIZE)
2353 if (!minus_f) {
2354 /* The games with local $! are to avoid setting errno if there is no
2355 sitecustomize script. "q%c...%c", 0, ..., 0 becomes "q\0...\0",
2356 ie a q() operator with a NUL byte as a the delimiter. This avoids
2357 problems with pathnames containing (say) ' */
2358# ifdef PERL_IS_MINIPERL
2359 AV *const inc = GvAV(PL_incgv);
2360 SV **const inc0 = inc ? av_fetch(inc, 0, FALSE) : NULL;
2361
2362 if (inc0) {
2363 /* if lib/buildcustomize.pl exists, it should not fail. If it does,
2364 it should be reported immediately as a build failure. */
2365 (void)Perl_av_create_and_unshift_one(aTHX_ &PL_preambleav,
2366 Perl_newSVpvf(aTHX_
2367 "BEGIN { my $f = q%c%s%" SVf "/buildcustomize.pl%c; "
2368 "do {local $!; -f $f }"
2369 " and do $f || die $@ || qq '$f: $!' }",
2370 0, (TAINTING_get ? "./" : ""), SVfARG(*inc0), 0));
2371 }
2372# else
2373 /* SITELIB_EXP is a function call on Win32. */
2374 const char *const raw_sitelib = SITELIB_EXP;
2375 if (raw_sitelib) {
2376 /* process .../.. if PERL_RELOCATABLE_INC is defined */
2377 SV *sitelib_sv = mayberelocate(raw_sitelib, strlen(raw_sitelib),
2378 INCPUSH_CAN_RELOCATE);
2379 const char *const sitelib = SvPVX(sitelib_sv);
2380 (void)Perl_av_create_and_unshift_one(aTHX_ &PL_preambleav,
2381 Perl_newSVpvf(aTHX_
2382 "BEGIN { do {local $!; -f q%c%s/sitecustomize.pl%c} && do q%c%s/sitecustomize.pl%c }",
2383 0, SVfARG(sitelib), 0,
2384 0, SVfARG(sitelib), 0));
2385 assert (SvREFCNT(sitelib_sv) == 1);
2386 SvREFCNT_dec(sitelib_sv);
2387 }
2388# endif
2389 }
2390#endif
2391
2392 if (!scriptname)
2393 scriptname = argv[0];
2394 if (PL_e_script) {
2395 argc++,argv--;
2396 scriptname = BIT_BUCKET; /* don't look for script or read stdin */
2397 }
2398 else if (scriptname == NULL) {
2399#ifdef MSDOS
2400 if ( PerlLIO_isatty(PerlIO_fileno(PerlIO_stdin())) )
2401 moreswitches("h");
2402#endif
2403 scriptname = "-";
2404 }
2405
2406 assert (!TAINT_get);
2407 init_perllib();
2408
2409 {
2410 bool suidscript = FALSE;
2411
2412 rsfp = open_script(scriptname, dosearch, &suidscript);
2413 if (!rsfp) {
2414 rsfp = PerlIO_stdin();
2415 lex_start_flags = LEX_DONT_CLOSE_RSFP;
2416 }
2417
2418 validate_suid(rsfp);
2419
2420#ifndef PERL_MICRO
2421# if defined(SIGCHLD) || defined(SIGCLD)
2422 {
2423# ifndef SIGCHLD
2424# define SIGCHLD SIGCLD
2425# endif
2426 Sighandler_t sigstate = rsignal_state(SIGCHLD);
2427 if (sigstate == (Sighandler_t) SIG_IGN) {
2428 Perl_ck_warner(aTHX_ packWARN(WARN_SIGNAL),
2429 "Can't ignore signal CHLD, forcing to default");
2430 (void)rsignal(SIGCHLD, (Sighandler_t)SIG_DFL);
2431 }
2432 }
2433# endif
2434#endif
2435
2436 if (doextract) {
2437
2438 /* This will croak if suidscript is true, as -x cannot be used with
2439 setuid scripts. */
2440 forbid_setid('x', suidscript);
2441 /* Hence you can't get here if suidscript is true */
2442
2443 linestr_sv = newSV_type(SVt_PV);
2444 lex_start_flags |= LEX_START_COPIED;
2445 find_beginning(linestr_sv, rsfp);
2446 if (cddir && PerlDir_chdir( (char *)cddir ) < 0)
2447 Perl_croak(aTHX_ "Can't chdir to %s",cddir);
2448 }
2449 }
2450
2451 PL_main_cv = PL_compcv = MUTABLE_CV(newSV_type(SVt_PVCV));
2452 CvUNIQUE_on(PL_compcv);
2453
2454 CvPADLIST_set(PL_compcv, pad_new(0));
2455
2456 PL_isarev = newHV();
2457
2458 boot_core_PerlIO();
2459 boot_core_UNIVERSAL();
2460 boot_core_mro();
2461 newXS("Internals::V", S_Internals_V, __FILE__);
2462
2463 if (xsinit)
2464 (*xsinit)(aTHX); /* in case linked C routines want magical variables */
2465#ifndef PERL_MICRO
2466#if defined(VMS) || defined(WIN32) || defined(DJGPP) || defined(__CYGWIN__)
2467 init_os_extras();
2468#endif
2469#endif
2470
2471#ifdef USE_SOCKS
2472# ifdef HAS_SOCKS5_INIT
2473 socks5_init(argv[0]);
2474# else
2475 SOCKSinit(argv[0]);
2476# endif
2477#endif
2478
2479 init_predump_symbols();
2480 /* init_postdump_symbols not currently designed to be called */
2481 /* more than once (ENV isn't cleared first, for example) */
2482 /* But running with -u leaves %ENV & @ARGV undefined! XXX */
2483 if (!PL_do_undump)
2484 init_postdump_symbols(argc,argv,env);
2485
2486 /* PL_unicode is turned on by -C, or by $ENV{PERL_UNICODE},
2487 * or explicitly in some platforms.
2488 * PL_utf8locale is conditionally turned on by
2489 * locale.c:Perl_init_i18nl10n() if the environment
2490 * look like the user wants to use UTF-8. */
2491# ifndef PERL_IS_MINIPERL
2492 if (PL_unicode) {
2493 /* Requires init_predump_symbols(). */
2494 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
2495 IO* io;
2496 PerlIO* fp;
2497 SV* sv;
2498
2499 /* Turn on UTF-8-ness on STDIN, STDOUT, STDERR
2500 * and the default open disciplines. */
2501 if ((PL_unicode & PERL_UNICODE_STDIN_FLAG) &&
2502 PL_stdingv && (io = GvIO(PL_stdingv)) &&
2503 (fp = IoIFP(io)))
2504 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2505 if ((PL_unicode & PERL_UNICODE_STDOUT_FLAG) &&
2506 PL_defoutgv && (io = GvIO(PL_defoutgv)) &&
2507 (fp = IoOFP(io)))
2508 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2509 if ((PL_unicode & PERL_UNICODE_STDERR_FLAG) &&
2510 PL_stderrgv && (io = GvIO(PL_stderrgv)) &&
2511 (fp = IoOFP(io)))
2512 PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2513 if ((PL_unicode & PERL_UNICODE_INOUT_FLAG) &&
2514 (sv = GvSV(gv_fetchpvs("\017PEN", GV_ADD|GV_NOTQUAL,
2515 SVt_PV)))) {
2516 U32 in = PL_unicode & PERL_UNICODE_IN_FLAG;
2517 U32 out = PL_unicode & PERL_UNICODE_OUT_FLAG;
2518 if (in) {
2519 if (out)
2520 sv_setpvs(sv, ":utf8\0:utf8");
2521 else
2522 sv_setpvs(sv, ":utf8\0");
2523 }
2524 else if (out)
2525 sv_setpvs(sv, "\0:utf8");
2526 SvSETMAGIC(sv);
2527 }
2528 }
2529 }
2530#endif
2531
2532 {
2533 const char *s;
2534 if ((s = PerlEnv_getenv("PERL_SIGNALS"))) {
2535 if (strEQ(s, "unsafe"))
2536 PL_signals |= PERL_SIGNALS_UNSAFE_FLAG;
2537 else if (strEQ(s, "safe"))
2538 PL_signals &= ~PERL_SIGNALS_UNSAFE_FLAG;
2539 else
2540 Perl_croak(aTHX_ "PERL_SIGNALS illegal: \"%s\"", s);
2541 }
2542 }
2543
2544
2545 lex_start(linestr_sv, rsfp, lex_start_flags);
2546 SvREFCNT_dec(linestr_sv);
2547
2548 PL_subname = newSVpvs("main");
2549
2550 if (add_read_e_script)
2551 filter_add(read_e_script, NULL);
2552
2553 /* now parse the script */
2554 if (minus_e == FALSE)
2555 PL_hints |= HINTS_DEFAULT; /* after init_main_stash ; need to be after init_predump_symbols */
2556
2557 SETERRNO(0,SS_NORMAL);
2558 if (yyparse(GRAMPROG) || PL_parser->error_count) {
2559 abort_execution("", PL_origfilename);
2560 }
2561 CopLINE_set(PL_curcop, 0);
2562 SET_CURSTASH(PL_defstash);
2563 if (PL_e_script) {
2564 SvREFCNT_dec(PL_e_script);
2565 PL_e_script = NULL;
2566 }
2567
2568 if (PL_do_undump)
2569 my_unexec();
2570
2571 if (isWARN_ONCE) {
2572 SAVECOPFILE(PL_curcop);
2573 SAVECOPLINE(PL_curcop);
2574 gv_check(PL_defstash);
2575 }
2576
2577 LEAVE;
2578 FREETMPS;
2579
2580#ifdef MYMALLOC
2581 {
2582 const char *s;
2583 UV uv;
2584 s = PerlEnv_getenv("PERL_DEBUG_MSTATS");
2585 if (s && grok_atoUV(s, &uv, NULL) && uv >= 2)
2586 dump_mstats("after compilation:");
2587 }
2588#endif
2589
2590 ENTER;
2591 PL_restartjmpenv = NULL;
2592 PL_restartop = 0;
2593 return NULL;
2594}
2595
2596/*
2597=for apidoc perl_run
2598
2599Tells a Perl interpreter to run its main program. See L<perlembed>
2600for a tutorial.
2601
2602C<my_perl> points to the Perl interpreter. It must have been previously
2603created through the use of L</perl_alloc> and L</perl_construct>, and
2604initialised through L</perl_parse>. This function should not be called
2605if L</perl_parse> returned a non-zero value, indicating a failure in
2606initialisation or compilation.
2607
2608This function executes code in C<INIT> blocks, and then executes the
2609main program. The code to be executed is that established by the prior
2610call to L</perl_parse>. If the interpreter's C<PL_exit_flags> word
2611does not have the C<PERL_EXIT_DESTRUCT_END> flag set, then this function
2612will also execute code in C<END> blocks. If it is desired to make any
2613further use of the interpreter after calling this function, then C<END>
2614blocks should be postponed to L</perl_destruct> time by setting that flag.
2615
2616Returns an integer of slightly tricky interpretation. The correct use
2617of the return value is as a truth value indicating whether the program
2618terminated non-locally. If zero is returned, this indicates that
2619the program ran to completion, and it is safe to make other use of the
2620interpreter (provided that the C<PERL_EXIT_DESTRUCT_END> flag was set as
2621described above). If a non-zero value is returned, this indicates that
2622the interpreter wants to terminate early. The interpreter should not be
2623just abandoned because of this desire to terminate; the caller should
2624proceed to shut the interpreter down cleanly with L</perl_destruct>
2625and free it with L</perl_free>.
2626
2627For historical reasons, the non-zero return value also attempts to
2628be a suitable value to pass to the C library function C<exit> (or to
2629return from C<main>), to serve as an exit code indicating the nature of
2630the way the program terminated. However, this isn't portable, due to
2631differing exit code conventions. An attempt is made to return an exit
2632code of the type required by the host operating system, but because
2633it is constrained to be non-zero, it is not necessarily possible to
2634indicate every type of exit. It is only reliable on Unix, where a zero
2635exit code can be augmented with a set bit that will be ignored. In any
2636case, this function is not the correct place to acquire an exit code:
2637one should get that from L</perl_destruct>.
2638
2639=cut
2640*/
2641
2642int
2643perl_run(pTHXx)
2644{
2645 I32 oldscope;
2646 int ret = 0;
2647 dJMPENV;
2648
2649 PERL_ARGS_ASSERT_PERL_RUN;
2650#ifndef MULTIPLICITY
2651 PERL_UNUSED_ARG(my_perl);
2652#endif
2653
2654 oldscope = PL_scopestack_ix;
2655#ifdef VMS
2656 VMSISH_HUSHED = 0;
2657#endif
2658
2659 JMPENV_PUSH(ret);
2660 switch (ret) {
2661 case 1:
2662 cxstack_ix = -1; /* start context stack again */
2663 goto redo_body;
2664 case 0: /* normal completion */
2665 redo_body:
2666 run_body(oldscope);
2667 /* FALLTHROUGH */
2668 case 2: /* my_exit() */
2669 while (PL_scopestack_ix > oldscope)
2670 LEAVE;
2671 FREETMPS;
2672 SET_CURSTASH(PL_defstash);
2673 if (!(PL_exit_flags & PERL_EXIT_DESTRUCT_END) &&
2674 PL_endav && !PL_minus_c) {
2675 PERL_SET_PHASE(PERL_PHASE_END);
2676 call_list(oldscope, PL_endav);
2677 }
2678#ifdef MYMALLOC
2679 if (PerlEnv_getenv("PERL_DEBUG_MSTATS"))
2680 dump_mstats("after execution: ");
2681#endif
2682 ret = STATUS_EXIT;
2683 break;
2684 case 3:
2685 if (PL_restartop) {
2686 POPSTACK_TO(PL_mainstack);
2687 goto redo_body;
2688 }
2689 PerlIO_printf(Perl_error_log, "panic: restartop in perl_run\n");
2690 FREETMPS;
2691 ret = 1;
2692 break;
2693 }
2694
2695 JMPENV_POP;
2696 return ret;
2697}
2698
2699STATIC void
2700S_run_body(pTHX_ I32 oldscope)
2701{
2702 DEBUG_r(PerlIO_printf(Perl_debug_log, "%s $` $& $' support (0x%x).\n",
2703 PL_sawampersand ? "Enabling" : "Omitting",
2704 (unsigned int)(PL_sawampersand)));
2705
2706 if (!PL_restartop) {
2707#ifdef DEBUGGING
2708 if (DEBUG_x_TEST || DEBUG_B_TEST)
2709 dump_all_perl(!DEBUG_B_TEST);
2710 if (!DEBUG_q_TEST)
2711 PERL_DEBUG(PerlIO_printf(Perl_debug_log, "\nEXECUTING...\n\n"));
2712#endif
2713
2714 if (PL_minus_c) {
2715 PerlIO_printf(Perl_error_log, "%s syntax OK\n", PL_origfilename);
2716 my_exit(0);
2717 }
2718 if (PERLDB_SINGLE && PL_DBsingle)
2719 PL_DBsingle_iv = 1;
2720 if (PL_initav) {
2721 PERL_SET_PHASE(PERL_PHASE_INIT);
2722 call_list(oldscope, PL_initav);
2723 }
2724#ifdef PERL_DEBUG_READONLY_OPS
2725 if (PL_main_root && PL_main_root->op_slabbed)
2726 Slab_to_ro(OpSLAB(PL_main_root));
2727#endif
2728 }
2729
2730 /* do it */
2731
2732 PERL_SET_PHASE(PERL_PHASE_RUN);
2733
2734 if (PL_restartop) {
2735 PL_restartjmpenv = NULL;
2736 PL_op = PL_restartop;
2737 PL_restartop = 0;
2738 CALLRUNOPS(aTHX);
2739 }
2740 else if (PL_main_start) {
2741 CvDEPTH(PL_main_cv) = 1;
2742 PL_op = PL_main_start;
2743 CALLRUNOPS(aTHX);
2744 }
2745 my_exit(0);
2746 NOT_REACHED; /* NOTREACHED */
2747}
2748
2749/*
2750=for apidoc_section $SV
2751
2752=for apidoc get_sv
2753
2754Returns the SV of the specified Perl scalar. C<flags> are passed to
2755C<gv_fetchpv>. If C<GV_ADD> is set and the
2756Perl variable does not exist then it will be created. If C<flags> is zero
2757and the variable does not exist then NULL is returned.
2758
2759=cut
2760*/
2761
2762SV*
2763Perl_get_sv(pTHX_ const char *name, I32 flags)
2764{
2765 GV *gv;
2766
2767 PERL_ARGS_ASSERT_GET_SV;
2768
2769 gv = gv_fetchpv(name, flags, SVt_PV);
2770 if (gv)
2771 return GvSV(gv);
2772 return NULL;
2773}
2774
2775/*
2776=for apidoc_section $AV
2777
2778=for apidoc get_av
2779
2780Returns the AV of the specified Perl global or package array with the given
2781name (so it won't work on lexical variables). C<flags> are passed
2782to C<gv_fetchpv>. If C<GV_ADD> is set and the
2783Perl variable does not exist then it will be created. If C<flags> is zero
2784and the variable does not exist then NULL is returned.
2785
2786Perl equivalent: C<@{"$name"}>.
2787
2788=cut
2789*/
2790
2791AV*
2792Perl_get_av(pTHX_ const char *name, I32 flags)
2793{
2794 GV* const gv = gv_fetchpv(name, flags, SVt_PVAV);
2795
2796 PERL_ARGS_ASSERT_GET_AV;
2797
2798 if (flags)
2799 return GvAVn(gv);
2800 if (gv)
2801 return GvAV(gv);
2802 return NULL;
2803}
2804
2805/*
2806=for apidoc_section $HV
2807
2808=for apidoc get_hv
2809
2810Returns the HV of the specified Perl hash. C<flags> are passed to
2811C<gv_fetchpv>. If C<GV_ADD> is set and the
2812Perl variable does not exist then it will be created. If C<flags> is zero
2813and the variable does not exist then C<NULL> is returned.
2814
2815=cut
2816*/
2817
2818HV*
2819Perl_get_hv(pTHX_ const char *name, I32 flags)
2820{
2821 GV* const gv = gv_fetchpv(name, flags, SVt_PVHV);
2822
2823 PERL_ARGS_ASSERT_GET_HV;
2824
2825 if (flags)
2826 return GvHVn(gv);
2827 if (gv)
2828 return GvHV(gv);
2829 return NULL;
2830}
2831
2832/*
2833=for apidoc_section $CV
2834
2835=for apidoc get_cv
2836=for apidoc_item |CV *|get_cvs|"string"|I32 flags
2837=for apidoc_item get_cvn_flags
2838
2839These return the CV of the specified Perl subroutine. C<flags> are passed to
2840C<gv_fetchpvn_flags>. If C<GV_ADD> is set and the Perl subroutine does not
2841exist then it will be declared (which has the same effect as saying
2842C<sub name;>). If C<GV_ADD> is not set and the subroutine does not exist,
2843then NULL is returned.
2844
2845The forms differ only in how the subroutine is specified.. With C<get_cvs>,
2846the name is a literal C string, enclosed in double quotes. With C<get_cv>, the
2847name is given by the C<name> parameter, which must be a NUL-terminated C
2848string. With C<get_cvn_flags>, the name is also given by the C<name>
2849parameter, but it is a Perl string (possibly containing embedded NUL bytes),
2850and its length in bytes is contained in the C<len> parameter.
2851
2852=for apidoc Amnh||GV_ADD
2853
2854=cut
2855*/
2856
2857CV*
2858Perl_get_cvn_flags(pTHX_ const char *name, STRLEN len, I32 flags)
2859{
2860 GV* const gv = gv_fetchpvn_flags(name, len, flags, SVt_PVCV);
2861
2862 PERL_ARGS_ASSERT_GET_CVN_FLAGS;
2863
2864 if (gv && UNLIKELY(SvROK(gv)) && SvTYPE(SvRV((SV *)gv)) == SVt_PVCV)
2865 return (CV*)SvRV((SV *)gv);
2866
2867 /* XXX this is probably not what they think they're getting.
2868 * It has the same effect as "sub name;", i.e. just a forward
2869 * declaration! */
2870 if ((flags & ~GV_NOADD_MASK) && !GvCVu(gv)) {
2871 return newSTUB(gv,0);
2872 }
2873 if (gv)
2874 return GvCVu(gv);
2875 return NULL;
2876}
2877
2878/* Nothing in core calls this now, but we can't replace it with a macro and
2879 move it to mathoms.c as a macro would evaluate name twice. */
2880CV*
2881Perl_get_cv(pTHX_ const char *name, I32 flags)
2882{
2883 PERL_ARGS_ASSERT_GET_CV;
2884
2885 return get_cvn_flags(name, strlen(name), flags);
2886}
2887
2888/* Be sure to refetch the stack pointer after calling these routines. */
2889
2890/*
2891
2892=for apidoc_section $callback
2893
2894=for apidoc call_argv
2895
2896Performs a callback to the specified named and package-scoped Perl subroutine
2897with C<argv> (a C<NULL>-terminated array of strings) as arguments. See
2898L<perlcall>.
2899
2900Approximate Perl equivalent: C<&{"$sub_name"}(@$argv)>.
2901
2902=cut
2903*/
2904
2905I32
2906Perl_call_argv(pTHX_ const char *sub_name, I32 flags, char **argv)
2907
2908 /* See G_* flags in cop.h */
2909 /* null terminated arg list */
2910{
2911 dSP;
2912
2913 PERL_ARGS_ASSERT_CALL_ARGV;
2914
2915 PUSHMARK(SP);
2916 while (*argv) {
2917 mXPUSHs(newSVpv(*argv,0));
2918 argv++;
2919 }
2920 PUTBACK;
2921 return call_pv(sub_name, flags);
2922}
2923
2924/*
2925=for apidoc call_pv
2926
2927Performs a callback to the specified Perl sub. See L<perlcall>.
2928
2929=cut
2930*/
2931
2932I32
2933Perl_call_pv(pTHX_ const char *sub_name, I32 flags)
2934 /* name of the subroutine */
2935 /* See G_* flags in cop.h */
2936{
2937 PERL_ARGS_ASSERT_CALL_PV;
2938
2939 return call_sv(MUTABLE_SV(get_cv(sub_name, GV_ADD)), flags);
2940}
2941
2942/*
2943=for apidoc call_method
2944
2945Performs a callback to the specified Perl method. The blessed object must
2946be on the stack. See L<perlcall>.
2947
2948=cut
2949*/
2950
2951I32
2952Perl_call_method(pTHX_ const char *methname, I32 flags)
2953 /* name of the subroutine */
2954 /* See G_* flags in cop.h */
2955{
2956 STRLEN len;
2957 SV* sv;
2958 PERL_ARGS_ASSERT_CALL_METHOD;
2959
2960 len = strlen(methname);
2961 sv = flags & G_METHOD_NAMED
2962 ? sv_2mortal(newSVpvn_share(methname, len,0))
2963 : newSVpvn_flags(methname, len, SVs_TEMP);
2964
2965 return call_sv(sv, flags | G_METHOD);
2966}
2967
2968/* May be called with any of a CV, a GV, or an SV containing the name. */
2969/*
2970=for apidoc call_sv
2971
2972Performs a callback to the Perl sub specified by the SV.
2973
2974If neither the C<G_METHOD> nor C<G_METHOD_NAMED> flag is supplied, the
2975SV may be any of a CV, a GV, a reference to a CV, a reference to a GV
2976or C<SvPV(sv)> will be used as the name of the sub to call.
2977
2978If the C<G_METHOD> flag is supplied, the SV may be a reference to a CV or
2979C<SvPV(sv)> will be used as the name of the method to call.
2980
2981If the C<G_METHOD_NAMED> flag is supplied, C<SvPV(sv)> will be used as
2982the name of the method to call.
2983
2984Some other values are treated specially for internal use and should
2985not be depended on.
2986
2987See L<perlcall>.
2988
2989=for apidoc Amnh||G_METHOD
2990=for apidoc Amnh||G_METHOD_NAMED
2991
2992=cut
2993*/
2994
2995I32
2996Perl_call_sv(pTHX_ SV *sv, volatile I32 flags)
2997 /* See G_* flags in cop.h */
2998{
2999 LOGOP myop; /* fake syntax tree node */
3000 METHOP method_op;
3001 I32 oldmark;
3002 volatile I32 retval = 0;
3003 bool oldcatch = CATCH_GET;
3004 int ret;
3005 OP* const oldop = PL_op;
3006 dJMPENV;
3007
3008 PERL_ARGS_ASSERT_CALL_SV;
3009
3010 if (flags & G_DISCARD) {
3011 ENTER;
3012 SAVETMPS;
3013 }
3014 if (!(flags & G_WANT)) {
3015 /* Backwards compatibility - as G_SCALAR was 0, it could be omitted.
3016 */
3017 flags |= G_SCALAR;
3018 }
3019
3020 Zero(&myop, 1, LOGOP);
3021 if (!(flags & G_NOARGS))
3022 myop.op_flags |= OPf_STACKED;
3023 myop.op_flags |= OP_GIMME_REVERSE(flags);
3024 SAVEOP();
3025 PL_op = (OP*)&myop;
3026
3027 if (!(flags & G_METHOD_NAMED)) {
3028 dSP;
3029 EXTEND(SP, 1);
3030 PUSHs(sv);
3031 PUTBACK;
3032 }
3033 oldmark = TOPMARK;
3034
3035 if (PERLDB_SUB && PL_curstash != PL_debstash
3036 /* Handle first BEGIN of -d. */
3037 && (PL_DBcv || (PL_DBcv = GvCV(PL_DBsub)))
3038 /* Try harder, since this may have been a sighandler, thus
3039 * curstash may be meaningless. */
3040 && (SvTYPE(sv) != SVt_PVCV || CvSTASH((const CV *)sv) != PL_debstash)
3041 && !(flags & G_NODEBUG))
3042 myop.op_private |= OPpENTERSUB_DB;
3043
3044 if (flags & (G_METHOD|G_METHOD_NAMED)) {
3045 Zero(&method_op, 1, METHOP);
3046 method_op.op_next = (OP*)&myop;
3047 PL_op = (OP*)&method_op;
3048 if ( flags & G_METHOD_NAMED ) {
3049 method_op.op_ppaddr = PL_ppaddr[OP_METHOD_NAMED];
3050 method_op.op_type = OP_METHOD_NAMED;
3051 method_op.op_u.op_meth_sv = sv;
3052 } else {
3053 method_op.op_ppaddr = PL_ppaddr[OP_METHOD];
3054 method_op.op_type = OP_METHOD;
3055 }
3056 myop.op_ppaddr = PL_ppaddr[OP_ENTERSUB];
3057 myop.op_type = OP_ENTERSUB;
3058 }
3059
3060 if (!(flags & G_EVAL)) {
3061 CATCH_SET(TRUE);
3062 CALL_BODY_SUB((OP*)&myop);
3063 retval = PL_stack_sp - (PL_stack_base + oldmark);
3064 CATCH_SET(oldcatch);
3065 }
3066 else {
3067 I32 old_cxix;
3068 myop.op_other = (OP*)&myop;
3069 (void)POPMARK;
3070 old_cxix = cxstack_ix;
3071 create_eval_scope(NULL, flags|G_FAKINGEVAL);
3072 INCMARK;
3073
3074 JMPENV_PUSH(ret);
3075
3076 switch (ret) {
3077 case 0:
3078 redo_body:
3079 CALL_BODY_SUB((OP*)&myop);
3080 retval = PL_stack_sp - (PL_stack_base + oldmark);
3081 if (!(flags & G_KEEPERR)) {
3082 CLEAR_ERRSV();
3083 }
3084 break;
3085 case 1:
3086 STATUS_ALL_FAILURE;
3087 /* FALLTHROUGH */
3088 case 2:
3089 /* my_exit() was called */
3090 SET_CURSTASH(PL_defstash);
3091 FREETMPS;
3092 JMPENV_POP;
3093 my_exit_jump();
3094 NOT_REACHED; /* NOTREACHED */
3095 case 3:
3096 if (PL_restartop) {
3097 PL_restartjmpenv = NULL;
3098 PL_op = PL_restartop;
3099 PL_restartop = 0;
3100 goto redo_body;
3101 }
3102 PL_stack_sp = PL_stack_base + oldmark;
3103 if ((flags & G_WANT) == G_ARRAY)
3104 retval = 0;
3105 else {
3106 retval = 1;
3107 *++PL_stack_sp = &PL_sv_undef;
3108 }
3109 break;
3110 }
3111
3112 /* if we croaked, depending on how we croaked the eval scope
3113 * may or may not have already been popped */
3114 if (cxstack_ix > old_cxix) {
3115 assert(cxstack_ix == old_cxix + 1);
3116 assert(CxTYPE(CX_CUR()) == CXt_EVAL);
3117 delete_eval_scope();
3118 }
3119 JMPENV_POP;
3120 }
3121
3122 if (flags & G_DISCARD) {
3123 PL_stack_sp = PL_stack_base + oldmark;
3124 retval = 0;
3125 FREETMPS;
3126 LEAVE;
3127 }
3128 PL_op = oldop;
3129 return retval;
3130}
3131
3132/* Eval a string. The G_EVAL flag is always assumed. */
3133
3134/*
3135=for apidoc eval_sv
3136
3137Tells Perl to C<eval> the string in the SV. It supports the same flags
3138as C<call_sv>, with the obvious exception of C<G_EVAL>. See L<perlcall>.
3139
3140The C<G_RETHROW> flag can be used if you only need eval_sv() to
3141execute code specified by a string, but not catch any errors.
3142
3143=for apidoc Amnh||G_RETHROW
3144=cut
3145*/
3146
3147I32
3148Perl_eval_sv(pTHX_ SV *sv, I32 flags)
3149
3150 /* See G_* flags in cop.h */
3151{
3152 UNOP myop; /* fake syntax tree node */
3153 volatile I32 oldmark;
3154 volatile I32 retval = 0;
3155 int ret;
3156 OP* const oldop = PL_op;
3157 dJMPENV;
3158
3159 PERL_ARGS_ASSERT_EVAL_SV;
3160
3161 if (flags & G_DISCARD) {
3162 ENTER;
3163 SAVETMPS;
3164 }
3165
3166 SAVEOP();
3167 PL_op = (OP*)&myop;
3168 Zero(&myop, 1, UNOP);
3169 {
3170 dSP;
3171 oldmark = SP - PL_stack_base;
3172 EXTEND(SP, 1);
3173 PUSHs(sv);
3174 PUTBACK;
3175 }
3176
3177 if (!(flags & G_NOARGS))
3178 myop.op_flags = OPf_STACKED;
3179 myop.op_type = OP_ENTEREVAL;
3180 myop.op_flags |= OP_GIMME_REVERSE(flags);
3181 if (flags & G_KEEPERR)
3182 myop.op_flags |= OPf_SPECIAL;
3183
3184 if (flags & G_RE_REPARSING)
3185 myop.op_private = (OPpEVAL_COPHH | OPpEVAL_RE_REPARSING);
3186
3187 /* fail now; otherwise we could fail after the JMPENV_PUSH but
3188 * before a cx_pusheval(), which corrupts the stack after a croak */
3189 TAINT_PROPER("eval_sv()");
3190
3191 JMPENV_PUSH(ret);
3192 switch (ret) {
3193 case 0:
3194 redo_body:
3195 if (PL_op == (OP*)(&myop)) {
3196 PL_op = PL_ppaddr[OP_ENTEREVAL](aTHX);
3197 if (!PL_op)
3198 goto fail; /* failed in compilation */
3199 }
3200 CALLRUNOPS(aTHX);
3201 retval = PL_stack_sp - (PL_stack_base + oldmark);
3202 if (!(flags & G_KEEPERR)) {
3203 CLEAR_ERRSV();
3204 }
3205 break;
3206 case 1:
3207 STATUS_ALL_FAILURE;
3208 /* FALLTHROUGH */
3209 case 2:
3210 /* my_exit() was called */
3211 SET_CURSTASH(PL_defstash);
3212 FREETMPS;
3213 JMPENV_POP;
3214 my_exit_jump();
3215 NOT_REACHED; /* NOTREACHED */
3216 case 3:
3217 if (PL_restartop) {
3218 PL_restartjmpenv = NULL;
3219 PL_op = PL_restartop;
3220 PL_restartop = 0;
3221 goto redo_body;
3222 }
3223 fail:
3224 if (flags & G_RETHROW) {
3225 JMPENV_POP;
3226 croak_sv(ERRSV);
3227 }
3228
3229 PL_stack_sp = PL_stack_base + oldmark;
3230 if ((flags & G_WANT) == G_ARRAY)
3231 retval = 0;
3232 else {
3233 retval = 1;
3234 *++PL_stack_sp = &PL_sv_undef;
3235 }
3236 break;
3237 }
3238
3239 JMPENV_POP;
3240 if (flags & G_DISCARD) {
3241 PL_stack_sp = PL_stack_base + oldmark;
3242 retval = 0;
3243 FREETMPS;
3244 LEAVE;
3245 }
3246 PL_op = oldop;
3247 return retval;
3248}
3249
3250/*
3251=for apidoc eval_pv
3252
3253Tells Perl to C<eval> the given string in scalar context and return an SV* result.
3254
3255=cut
3256*/
3257
3258SV*
3259Perl_eval_pv(pTHX_ const char *p, I32 croak_on_error)
3260{
3261 SV* sv = newSVpv(p, 0);
3262
3263 PERL_ARGS_ASSERT_EVAL_PV;
3264
3265 if (croak_on_error) {
3266 sv_2mortal(sv);
3267 eval_sv(sv, G_SCALAR | G_RETHROW);
3268 }
3269 else {
3270 eval_sv(sv, G_SCALAR);
3271 SvREFCNT_dec(sv);
3272 }
3273
3274 {
3275 dSP;
3276 sv = POPs;
3277 PUTBACK;
3278 }
3279
3280 return sv;
3281}
3282
3283/* Require a module. */
3284
3285/*
3286=for apidoc_section $embedding
3287
3288=for apidoc require_pv
3289
3290Tells Perl to C<require> the file named by the string argument. It is
3291analogous to the Perl code C<eval "require '$file'">. It's even
3292implemented that way; consider using load_module instead.
3293
3294=cut */
3295
3296void
3297Perl_require_pv(pTHX_ const char *pv)
3298{
3299 dSP;
3300 SV* sv;
3301
3302 PERL_ARGS_ASSERT_REQUIRE_PV;
3303
3304 PUSHSTACKi(PERLSI_REQUIRE);
3305 sv = Perl_newSVpvf(aTHX_ "require q%c%s%c", 0, pv, 0);
3306 eval_sv(sv_2mortal(sv), G_DISCARD);
3307 POPSTACK;
3308}
3309
3310STATIC void
3311S_usage(pTHX) /* XXX move this out into a module ? */
3312{
3313 /* This message really ought to be max 23 lines.
3314 * Removed -h because the user already knows that option. Others? */
3315
3316 /* Grouped as 6 lines per C string literal, to keep under the ANSI C 89
3317 minimum of 509 character string literals. */
3318 static const char * const usage_msg[] = {
3319" -0[octal/hexadecimal] specify record separator (\\0, if no argument)\n"
3320" -a autosplit mode with -n or -p (splits $_ into @F)\n"
3321" -C[number/list] enables the listed Unicode features\n"
3322" -c check syntax only (runs BEGIN and CHECK blocks)\n"
3323" -d[t][:MOD] run program under debugger or module Devel::MOD\n"
3324" -D[number/letters] set debugging flags (argument is a bit mask or alphabets)\n",
3325" -e commandline one line of program (several -e's allowed, omit programfile)\n"
3326" -E commandline like -e, but enables all optional features\n"
3327" -f don't do $sitelib/sitecustomize.pl at startup\n"
3328" -F/pattern/ split() pattern for -a switch (//'s are optional)\n"
3329" -i[extension] edit <> files in place (makes backup if extension supplied)\n"
3330" -Idirectory specify @INC/#include directory (several -I's allowed)\n",
3331" -l[octnum] enable line ending processing, specifies line terminator\n"
3332" -[mM][-]module execute \"use/no module...\" before executing program\n"
3333" -n assume \"while (<>) { ... }\" loop around program\n"
3334" -p assume loop like -n but print line also, like sed\n"
3335" -s enable rudimentary parsing for switches after programfile\n"
3336" -S look for programfile using PATH environment variable\n",
3337" -t enable tainting warnings\n"
3338" -T enable tainting checks\n"
3339" -u dump core after parsing program\n"
3340" -U allow unsafe operations\n"
3341" -v print version, patchlevel and license\n"
3342" -V[:configvar] print configuration summary (or a single Config.pm variable)\n",
3343" -w enable many useful warnings\n"
3344" -W enable all warnings\n"
3345" -x[directory] ignore text before #!perl line (optionally cd to directory)\n"
3346" -X disable all warnings\n"
3347" \n"
3348"Run 'perldoc perl' for more help with Perl.\n\n",
3349NULL
3350};
3351 const char * const *p = usage_msg;
3352 PerlIO *out = PerlIO_stdout();
3353
3354 PerlIO_printf(out,
3355 "\nUsage: %s [switches] [--] [programfile] [arguments]\n",
3356 PL_origargv[0]);
3357 while (*p)
3358 PerlIO_puts(out, *p++);
3359 my_exit(0);
3360}
3361
3362/* convert a string of -D options (or digits) into an int.
3363 * sets *s to point to the char after the options */
3364
3365#ifdef DEBUGGING
3366int
3367Perl_get_debug_opts(pTHX_ const char **s, bool givehelp)
3368{
3369 static const char * const usage_msgd[] = {
3370 " Debugging flag values: (see also -d)\n"
3371 " p Tokenizing and parsing (with v, displays parse stack)\n"
3372 " s Stack snapshots (with v, displays all stacks)\n"
3373 " l Context (loop) stack processing\n"
3374 " t Trace execution\n"
3375 " o Method and overloading resolution\n",
3376 " c String/numeric conversions\n"
3377 " P Print profiling info, source file input state\n"
3378 " m Memory and SV allocation\n"
3379 " f Format processing\n"
3380 " r Regular expression parsing and execution\n"
3381 " x Syntax tree dump\n",
3382 " u Tainting checks\n"
3383 " H Hash dump -- usurps values()\n"
3384 " X Scratchpad allocation\n"
3385 " D Cleaning up\n"
3386 " S Op slab allocation\n"
3387 " T Tokenising\n"
3388 " R Include reference counts of dumped variables (eg when using -Ds)\n",
3389 " J Do not s,t,P-debug (Jump over) opcodes within package DB\n"
3390 " v Verbose: use in conjunction with other flags\n"
3391 " C Copy On Write\n"
3392 " A Consistency checks on internal structures\n"
3393 " q quiet - currently only suppresses the 'EXECUTING' message\n"
3394 " M trace smart match resolution\n"
3395 " B dump suBroutine definitions, including special Blocks like BEGIN\n",
3396 " L trace some locale setting information--for Perl core development\n",
3397 " i trace PerlIO layer processing\n",
3398 " y trace y///, tr/// compilation and execution\n",
3399 NULL
3400 };
3401 UV uv = 0;
3402
3403 PERL_ARGS_ASSERT_GET_DEBUG_OPTS;
3404
3405 if (isALPHA(**s)) {
3406 /* if adding extra options, remember to update DEBUG_MASK */
3407 static const char debopts[] = "psltocPmfrxuUHXDSTRJvCAqMBLiy";
3408
3409 for (; isWORDCHAR(**s); (*s)++) {
3410 const char * const d = strchr(debopts,**s);
3411 if (d)
3412 uv |= 1 << (d - debopts);
3413 else if (ckWARN_d(WARN_DEBUGGING))
3414 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3415 "invalid option -D%c, use -D'' to see choices\n", **s);
3416 }
3417 }
3418 else if (isDIGIT(**s)) {
3419 const char* e = *s + strlen(*s);
3420 if (grok_atoUV(*s, &uv, &e))
3421 *s = e;
3422 for (; isWORDCHAR(**s); (*s)++) ;
3423 }
3424 else if (givehelp) {
3425 const char *const *p = usage_msgd;
3426 while (*p) PerlIO_puts(PerlIO_stdout(), *p++);
3427 }
3428 return (int)uv; /* ignore any UV->int conversion loss */
3429}
3430#endif
3431
3432/* This routine handles any switches that can be given during run */
3433
3434const char *
3435Perl_moreswitches(pTHX_ const char *s)
3436{
3437 UV rschar;
3438 const char option = *s; /* used to remember option in -m/-M code */
3439
3440 PERL_ARGS_ASSERT_MORESWITCHES;
3441
3442 switch (*s) {
3443 case '0':
3444 {
3445 I32 flags = 0;
3446 STRLEN numlen;
3447
3448 SvREFCNT_dec(PL_rs);
3449 if (s[1] == 'x' && s[2]) {
3450 const char *e = s+=2;
3451 U8 *tmps;
3452
3453 while (*e)
3454 e++;
3455 numlen = e - s;
3456 flags = PERL_SCAN_SILENT_ILLDIGIT;
3457 rschar = (U32)grok_hex(s, &numlen, &flags, NULL);
3458 if (s + numlen < e) {
3459 rschar = 0; /* Grandfather -0xFOO as -0 -xFOO. */
3460 numlen = 0;
3461 s--;
3462 }
3463 PL_rs = newSVpvs("");
3464 tmps = (U8*) SvGROW(PL_rs, (STRLEN)(UVCHR_SKIP(rschar) + 1));
3465 uvchr_to_utf8(tmps, rschar);
3466 SvCUR_set(PL_rs, UVCHR_SKIP(rschar));
3467 SvUTF8_on(PL_rs);
3468 }
3469 else {
3470 numlen = 4;
3471 rschar = (U32)grok_oct(s, &numlen, &flags, NULL);
3472 if (rschar & ~((U8)~0))
3473 PL_rs = &PL_sv_undef;
3474 else if (!rschar && numlen >= 2)
3475 PL_rs = newSVpvs("");
3476 else {
3477 char ch = (char)rschar;
3478 PL_rs = newSVpvn(&ch, 1);
3479 }
3480 }
3481 sv_setsv(get_sv("/", GV_ADD), PL_rs);
3482 return s + numlen;
3483 }
3484 case 'C':
3485 s++;
3486 PL_unicode = parse_unicode_opts( (const char **)&s );
3487 if (PL_unicode & PERL_UNICODE_UTF8CACHEASSERT_FLAG)
3488 PL_utf8cache = -1;
3489 return s;
3490 case 'F':
3491 PL_minus_a = TRUE;
3492 PL_minus_F = TRUE;
3493 PL_minus_n = TRUE;
3494 PL_splitstr = ++s;
3495 while (*s && !isSPACE(*s)) ++s;
3496 PL_splitstr = savepvn(PL_splitstr, s - PL_splitstr);
3497 return s;
3498 case 'a':
3499 PL_minus_a = TRUE;
3500 PL_minus_n = TRUE;
3501 s++;
3502 return s;
3503 case 'c':
3504 PL_minus_c = TRUE;
3505 s++;
3506 return s;
3507 case 'd':
3508 forbid_setid('d', FALSE);
3509 s++;
3510
3511 /* -dt indicates to the debugger that threads will be used */
3512 if (*s == 't' && !isWORDCHAR(s[1])) {
3513 ++s;
3514 my_setenv("PERL5DB_THREADED", "1");
3515 }
3516
3517 /* The following permits -d:Mod to accepts arguments following an =
3518 in the fashion that -MSome::Mod does. */
3519 if (*s == ':' || *s == '=') {
3520 const char *start;
3521 const char *end;
3522 SV *sv;
3523
3524 if (*++s == '-') {
3525 ++s;
3526 sv = newSVpvs("no Devel::");
3527 } else {
3528 sv = newSVpvs("use Devel::");
3529 }
3530
3531 start = s;
3532 end = s + strlen(s);
3533
3534 /* We now allow -d:Module=Foo,Bar and -d:-Module */
3535 while(isWORDCHAR(*s) || *s==':') ++s;
3536 if (*s != '=')
3537 sv_catpvn(sv, start, end - start);
3538 else {
3539 sv_catpvn(sv, start, s-start);
3540 /* Don't use NUL as q// delimiter here, this string goes in the
3541 * environment. */
3542 Perl_sv_catpvf(aTHX_ sv, " split(/,/,q{%s});", ++s);
3543 }
3544 s = end;
3545 my_setenv("PERL5DB", SvPV_nolen_const(sv));
3546 SvREFCNT_dec(sv);
3547 }
3548 if (!PL_perldb) {
3549 PL_perldb = PERLDB_ALL;
3550 init_debugger();
3551 }
3552 return s;
3553 case 'D':
3554 {
3555#ifdef DEBUGGING
3556 forbid_setid('D', FALSE);
3557 s++;
3558 PL_debug = get_debug_opts( (const char **)&s, 1) | DEBUG_TOP_FLAG;
3559#else /* !DEBUGGING */
3560 if (ckWARN_d(WARN_DEBUGGING))
3561 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3562 "Recompile perl with -DDEBUGGING to use -D switch (did you mean -d ?)\n");
3563 for (s++; isWORDCHAR(*s); s++) ;
3564#endif
3565 return s;
3566 NOT_REACHED; /* NOTREACHED */
3567 }
3568 case 'h':
3569 usage();
3570 NOT_REACHED; /* NOTREACHED */
3571
3572 case 'i':
3573 Safefree(PL_inplace);
3574 {
3575 const char * const start = ++s;
3576 while (*s && !isSPACE(*s))
3577 ++s;
3578
3579 PL_inplace = savepvn(start, s - start);
3580 }
3581 return s;
3582 case 'I': /* -I handled both here and in parse_body() */
3583 forbid_setid('I', FALSE);
3584 ++s;
3585 while (*s && isSPACE(*s))
3586 ++s;
3587 if (*s) {
3588 const char *e, *p;
3589 p = s;
3590 /* ignore trailing spaces (possibly followed by other switches) */
3591 do {
3592 for (e = p; *e && !isSPACE(*e); e++) ;
3593 p = e;
3594 while (isSPACE(*p))
3595 p++;
3596 } while (*p && *p != '-');
3597 incpush(s, e-s,
3598 INCPUSH_ADD_SUB_DIRS|INCPUSH_ADD_OLD_VERS|INCPUSH_UNSHIFT);
3599 s = p;
3600 if (*s == '-')
3601 s++;
3602 }
3603 else
3604 Perl_croak(aTHX_ "No directory specified for -I");
3605 return s;
3606 case 'l':
3607 PL_minus_l = TRUE;
3608 s++;
3609 if (PL_ors_sv) {
3610 SvREFCNT_dec(PL_ors_sv);
3611 PL_ors_sv = NULL;
3612 }
3613 if (isDIGIT(*s)) {
3614 I32 flags = 0;
3615 STRLEN numlen;
3616 PL_ors_sv = newSVpvs("\n");
3617 numlen = 3 + (*s == '0');
3618 *SvPVX(PL_ors_sv) = (char)grok_oct(s, &numlen, &flags, NULL);
3619 s += numlen;
3620 }
3621 else {
3622 if (RsPARA(PL_rs)) {
3623 PL_ors_sv = newSVpvs("\n\n");
3624 }
3625 else {
3626 PL_ors_sv = newSVsv(PL_rs);
3627 }
3628 }
3629 return s;
3630 case 'M':
3631 forbid_setid('M', FALSE); /* XXX ? */
3632 /* FALLTHROUGH */
3633 case 'm':
3634 forbid_setid('m', FALSE); /* XXX ? */
3635 if (*++s) {
3636 const char *start;
3637 const char *end;
3638 SV *sv;
3639 const char *use = "use ";
3640 bool colon = FALSE;
3641 /* -M-foo == 'no foo' */
3642 /* Leading space on " no " is deliberate, to make both
3643 possibilities the same length. */
3644 if (*s == '-') { use = " no "; ++s; }
3645 sv = newSVpvn(use,4);
3646 start = s;
3647 /* We allow -M'Module qw(Foo Bar)' */
3648 while(isWORDCHAR(*s) || *s==':') {
3649 if( *s++ == ':' ) {
3650 if( *s == ':' )
3651 s++;
3652 else
3653 colon = TRUE;
3654 }
3655 }
3656 if (s == start)
3657 Perl_croak(aTHX_ "Module name required with -%c option",
3658 option);
3659 if (colon)
3660 Perl_croak(aTHX_ "Invalid module name %.*s with -%c option: "
3661 "contains single ':'",
3662 (int)(s - start), start, option);
3663 end = s + strlen(s);
3664 if (*s != '=') {
3665 sv_catpvn(sv, start, end - start);
3666 if (option == 'm') {
3667 if (*s != '\0')
3668 Perl_croak(aTHX_ "Can't use '%c' after -mname", *s);
3669 sv_catpvs( sv, " ()");
3670 }
3671 } else {
3672 sv_catpvn(sv, start, s-start);
3673 /* Use NUL as q''-delimiter. */
3674 sv_catpvs(sv, " split(/,/,q\0");
3675 ++s;
3676 sv_catpvn(sv, s, end - s);
3677 sv_catpvs(sv, "\0)");
3678 }
3679 s = end;
3680 Perl_av_create_and_push(aTHX_ &PL_preambleav, sv);
3681 }
3682 else
3683 Perl_croak(aTHX_ "Missing argument to -%c", option);
3684 return s;
3685 case 'n':
3686 PL_minus_n = TRUE;
3687 s++;
3688 return s;
3689 case 'p':
3690 PL_minus_p = TRUE;
3691 s++;
3692 return s;
3693 case 's':
3694 forbid_setid('s', FALSE);
3695 PL_doswitches = TRUE;
3696 s++;
3697 return s;
3698 case 't':
3699 case 'T':
3700#if defined(SILENT_NO_TAINT_SUPPORT)
3701 /* silently ignore */
3702#elif defined(NO_TAINT_SUPPORT)
3703 Perl_croak_nocontext("This perl was compiled without taint support. "
3704 "Cowardly refusing to run with -t or -T flags");
3705#else
3706 if (!TAINTING_get)
3707 TOO_LATE_FOR(*s);
3708#endif
3709 s++;
3710 return s;
3711 case 'u':
3712 PL_do_undump = TRUE;
3713 s++;
3714 return s;
3715 case 'U':
3716 PL_unsafe = TRUE;
3717 s++;
3718 return s;
3719 case 'v':
3720 minus_v();
3721 case 'w':
3722 if (! (PL_dowarn & G_WARN_ALL_MASK)) {
3723 PL_dowarn |= G_WARN_ON;
3724 }
3725 s++;
3726 return s;
3727 case 'W':
3728 PL_dowarn = G_WARN_ALL_ON|G_WARN_ON;
3729 free_and_set_cop_warnings(&PL_compiling, pWARN_ALL);
3730 s++;
3731 return s;
3732 case 'X':
3733 PL_dowarn = G_WARN_ALL_OFF;
3734 free_and_set_cop_warnings(&PL_compiling, pWARN_NONE);
3735 s++;
3736 return s;
3737 case '*':
3738 case ' ':
3739 while( *s == ' ' )
3740 ++s;
3741 if (s[0] == '-') /* Additional switches on #! line. */
3742 return s+1;
3743 break;
3744 case '-':
3745 case 0:
3746#if defined(WIN32) || !defined(PERL_STRICT_CR)
3747 case '\r':
3748#endif
3749 case '\n':
3750 case '\t':
3751 break;
3752#ifdef ALTERNATE_SHEBANG
3753 case 'S': /* OS/2 needs -S on "extproc" line. */
3754 break;
3755#endif
3756 case 'e': case 'f': case 'x': case 'E':
3757#ifndef ALTERNATE_SHEBANG
3758 case 'S':
3759#endif
3760 case 'V':
3761 Perl_croak(aTHX_ "Can't emulate -%.1s on #! line",s);
3762 default:
3763 Perl_croak(aTHX_
3764 "Unrecognized switch: -%.1s (-h will show valid options)",s
3765 );
3766 }
3767 return NULL;
3768}
3769
3770
3771STATIC void
3772S_minus_v(pTHX)
3773{
3774 PerlIO * PIO_stdout;
3775 {
3776 const char * const level_str = "v" PERL_VERSION_STRING;
3777 const STRLEN level_len = sizeof("v" PERL_VERSION_STRING)-1;
3778#ifdef PERL_PATCHNUM
3779 SV* level;
3780# ifdef PERL_GIT_UNCOMMITTED_CHANGES
3781 static const char num [] = PERL_PATCHNUM "*";
3782# else
3783 static const char num [] = PERL_PATCHNUM;
3784# endif
3785 {
3786 const STRLEN num_len = sizeof(num)-1;
3787 /* A very advanced compiler would fold away the strnEQ
3788 and this whole conditional, but most (all?) won't do it.
3789 SV level could also be replaced by with preprocessor
3790 catenation.
3791 */
3792 if (num_len >= level_len && strnEQ(num,level_str,level_len)) {
3793 /* per 46807d8e80, PERL_PATCHNUM is outside of the control
3794 of the interp so it might contain format characters
3795 */
3796 level = newSVpvn(num, num_len);
3797 } else {
3798 level = Perl_newSVpvf_nocontext("%s (%s)", level_str, num);
3799 }
3800 }
3801#else
3802 SV* level = newSVpvn(level_str, level_len);
3803#endif /* #ifdef PERL_PATCHNUM */
3804 PIO_stdout = PerlIO_stdout();
3805 PerlIO_printf(PIO_stdout,
3806 "\nThis is perl " STRINGIFY(PERL_REVISION)
3807 ", version " STRINGIFY(PERL_VERSION)
3808 ", subversion " STRINGIFY(PERL_SUBVERSION)
3809 " (%" SVf ") built for " ARCHNAME, SVfARG(level)
3810 );
3811 SvREFCNT_dec_NN(level);
3812 }
3813#if defined(LOCAL_PATCH_COUNT)
3814 if (LOCAL_PATCH_COUNT > 0)
3815 PerlIO_printf(PIO_stdout,
3816 "\n(with %d registered patch%s, "
3817 "see perl -V for more detail)",
3818 LOCAL_PATCH_COUNT,
3819 (LOCAL_PATCH_COUNT!=1) ? "es" : "");
3820#endif
3821
3822 PerlIO_printf(PIO_stdout,
3823 "\n\nCopyright 1987-2021, Larry Wall\n");
3824#ifdef MSDOS
3825 PerlIO_printf(PIO_stdout,
3826 "\nMS-DOS port Copyright (c) 1989, 1990, Diomidis Spinellis\n");
3827#endif
3828#ifdef DJGPP
3829 PerlIO_printf(PIO_stdout,
3830 "djgpp v2 port (jpl5003c) by Hirofumi Watanabe, 1996\n"
3831 "djgpp v2 port (perl5004+) by Laszlo Molnar, 1997-1999\n");
3832#endif
3833#ifdef OS2
3834 PerlIO_printf(PIO_stdout,
3835 "\n\nOS/2 port Copyright (c) 1990, 1991, Raymond Chen, Kai Uwe Rommel\n"
3836 "Version 5 port Copyright (c) 1994-2002, Andreas Kaiser, Ilya Zakharevich\n");
3837#endif
3838#ifdef OEMVS
3839 PerlIO_printf(PIO_stdout,
3840 "MVS (OS390) port by Mortice Kern Systems, 1997-1999\n");
3841#endif
3842#ifdef __VOS__
3843 PerlIO_printf(PIO_stdout,
3844 "Stratus OpenVOS port by Paul.Green@stratus.com, 1997-2013\n");
3845#endif
3846#ifdef POSIX_BC
3847 PerlIO_printf(PIO_stdout,
3848 "BS2000 (POSIX) port by Start Amadeus GmbH, 1998-1999\n");
3849#endif
3850#ifdef BINARY_BUILD_NOTICE
3851 BINARY_BUILD_NOTICE;
3852#endif
3853 PerlIO_printf(PIO_stdout,
3854 "\n\
3855Perl may be copied only under the terms of either the Artistic License or the\n\
3856GNU General Public License, which may be found in the Perl 5 source kit.\n\n\
3857Complete documentation for Perl, including FAQ lists, should be found on\n\
3858this system using \"man perl\" or \"perldoc perl\". If you have access to the\n\
3859Internet, point your browser at http://www.perl.org/, the Perl Home Page.\n\n");
3860 my_exit(0);
3861}
3862
3863/* compliments of Tom Christiansen */
3864
3865/* unexec() can be found in the Gnu emacs distribution */
3866/* Known to work with -DUNEXEC and using unexelf.c from GNU emacs-20.2 */
3867
3868#ifdef VMS
3869#include <lib$routines.h>
3870#endif
3871
3872void
3873Perl_my_unexec(pTHX)
3874{
3875#ifdef UNEXEC
3876 SV * prog = newSVpv(BIN_EXP, 0);
3877 SV * file = newSVpv(PL_origfilename, 0);
3878 int status = 1;
3879 extern int etext;
3880
3881 sv_catpvs(prog, "/perl");
3882 sv_catpvs(file, ".perldump");
3883
3884 unexec(SvPVX(file), SvPVX(prog), &etext, sbrk(0), 0);
3885 /* unexec prints msg to stderr in case of failure */
3886 PerlProc_exit(status);
3887#else
3888 PERL_UNUSED_CONTEXT;
3889# ifdef VMS
3890 lib$signal(SS$_DEBUG); /* ssdef.h #included from vmsish.h */
3891# elif defined(WIN32) || defined(__CYGWIN__)
3892 Perl_croak_nocontext("dump is not supported");
3893# else
3894 ABORT(); /* for use with undump */
3895# endif
3896#endif
3897}
3898
3899/* initialize curinterp */
3900STATIC void
3901S_init_interp(pTHX)
3902{
3903#ifdef MULTIPLICITY
3904# define PERLVAR(prefix,var,type)
3905# define PERLVARA(prefix,var,n,type)
3906# if defined(PERL_IMPLICIT_CONTEXT)
3907# define PERLVARI(prefix,var,type,init) aTHX->prefix##var = init;
3908# define PERLVARIC(prefix,var,type,init) aTHX->prefix##var = init;
3909# else
3910# define PERLVARI(prefix,var,type,init) PERL_GET_INTERP->var = init;
3911# define PERLVARIC(prefix,var,type,init) PERL_GET_INTERP->var = init;
3912# endif
3913# include "intrpvar.h"
3914# undef PERLVAR
3915# undef PERLVARA
3916# undef PERLVARI
3917# undef PERLVARIC
3918#else
3919# define PERLVAR(prefix,var,type)
3920# define PERLVARA(prefix,var,n,type)
3921# define PERLVARI(prefix,var,type,init) PL_##var = init;
3922# define PERLVARIC(prefix,var,type,init) PL_##var = init;
3923# include "intrpvar.h"
3924# undef PERLVAR
3925# undef PERLVARA
3926# undef PERLVARI
3927# undef PERLVARIC
3928#endif
3929
3930}
3931
3932STATIC void
3933S_init_main_stash(pTHX)
3934{
3935 GV *gv;
3936 HV *hv = newHV();
3937
3938 PL_curstash = PL_defstash = (HV *)SvREFCNT_inc_simple_NN(hv);
3939 /* We know that the string "main" will be in the global shared string
3940 table, so it's a small saving to use it rather than allocate another
3941 8 bytes. */
3942 PL_curstname = newSVpvs_share("main");
3943 gv = gv_fetchpvs("main::", GV_ADD|GV_NOTQUAL, SVt_PVHV);
3944 /* If we hadn't caused another reference to "main" to be in the shared
3945 string table above, then it would be worth reordering these two,
3946 because otherwise all we do is delete "main" from it as a consequence
3947 of the SvREFCNT_dec, only to add it again with hv_name_set */
3948 SvREFCNT_dec(GvHV(gv));
3949 hv_name_sets(PL_defstash, "main", 0);
3950 GvHV(gv) = MUTABLE_HV(SvREFCNT_inc_simple(PL_defstash));
3951 SvREADONLY_on(gv);
3952 PL_incgv = gv_HVadd(gv_AVadd(gv_fetchpvs("INC", GV_ADD|GV_NOTQUAL,
3953 SVt_PVAV)));
3954 SvREFCNT_inc_simple_void(PL_incgv); /* Don't allow it to be freed */
3955 GvMULTI_on(PL_incgv);
3956 PL_hintgv = gv_fetchpvs("\010", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^H */
3957 SvREFCNT_inc_simple_void(PL_hintgv);
3958 GvMULTI_on(PL_hintgv);
3959 PL_defgv = gv_fetchpvs("_", GV_ADD|GV_NOTQUAL, SVt_PVAV);
3960 SvREFCNT_inc_simple_void(PL_defgv);
3961 PL_errgv = gv_fetchpvs("@", GV_ADD|GV_NOTQUAL, SVt_PV);
3962 SvREFCNT_inc_simple_void(PL_errgv);
3963 GvMULTI_on(PL_errgv);
3964 PL_replgv = gv_fetchpvs("\022", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^R */
3965 SvREFCNT_inc_simple_void(PL_replgv);
3966 GvMULTI_on(PL_replgv);
3967 (void)Perl_form(aTHX_ "%240s",""); /* Preallocate temp - for immediate signals. */
3968#ifdef PERL_DONT_CREATE_GVSV
3969 (void)gv_SVadd(PL_errgv);
3970#endif
3971 sv_grow(ERRSV, 240); /* Preallocate - for immediate signals. */
3972 CLEAR_ERRSV();
3973 CopSTASH_set(&PL_compiling, PL_defstash);
3974 PL_debstash = GvHV(gv_fetchpvs("DB::", GV_ADDMULTI, SVt_PVHV));
3975 PL_globalstash = GvHV(gv_fetchpvs("CORE::GLOBAL::", GV_ADDMULTI,
3976 SVt_PVHV));
3977 /* We must init $/ before switches are processed. */
3978 sv_setpvs(get_sv("/", GV_ADD), "\n");
3979}
3980
3981STATIC PerlIO *
3982S_open_script(pTHX_ const char *scriptname, bool dosearch, bool *suidscript)
3983{
3984 int fdscript = -1;
3985 PerlIO *rsfp = NULL;
3986 Stat_t tmpstatbuf;
3987 int fd;
3988
3989 PERL_ARGS_ASSERT_OPEN_SCRIPT;
3990
3991 if (PL_e_script) {
3992 PL_origfilename = savepvs("-e");
3993 }
3994 else {
3995 const char *s;
3996 UV uv;
3997 /* if find_script() returns, it returns a malloc()-ed value */
3998 scriptname = PL_origfilename = find_script(scriptname, dosearch, NULL, 1);
3999 s = scriptname + strlen(scriptname);
4000
4001 if (strBEGINs(scriptname, "/dev/fd/")
4002 && isDIGIT(scriptname[8])
4003 && grok_atoUV(scriptname + 8, &uv, &s)
4004 && uv <= PERL_INT_MAX
4005 ) {
4006 fdscript = (int)uv;
4007 if (*s) {
4008 /* PSz 18 Feb 04
4009 * Tell apart "normal" usage of fdscript, e.g.
4010 * with bash on FreeBSD:
4011 * perl <( echo '#!perl -DA'; echo 'print "$0\n"')
4012 * from usage in suidperl.
4013 * Does any "normal" usage leave garbage after the number???
4014 * Is it a mistake to use a similar /dev/fd/ construct for
4015 * suidperl?
4016 */
4017 *suidscript = TRUE;
4018 /* PSz 20 Feb 04
4019 * Be supersafe and do some sanity-checks.
4020 * Still, can we be sure we got the right thing?
4021 */
4022 if (*s != '/') {
4023 Perl_croak(aTHX_ "Wrong syntax (suid) fd script name \"%s\"\n", s);
4024 }
4025 if (! *(s+1)) {
4026 Perl_croak(aTHX_ "Missing (suid) fd script name\n");
4027 }
4028 scriptname = savepv(s + 1);
4029 Safefree(PL_origfilename);
4030 PL_origfilename = (char *)scriptname;
4031 }
4032 }
4033 }
4034
4035 CopFILE_free(PL_curcop);
4036 CopFILE_set(PL_curcop, PL_origfilename);
4037 if (*PL_origfilename == '-' && PL_origfilename[1] == '\0')
4038 scriptname = (char *)"";
4039 if (fdscript >= 0) {
4040 rsfp = PerlIO_fdopen(fdscript,PERL_SCRIPT_MODE);
4041 }
4042 else if (!*scriptname) {
4043 forbid_setid(0, *suidscript);
4044 return NULL;
4045 }
4046 else {
4047#ifdef FAKE_BIT_BUCKET
4048 /* This hack allows one not to have /dev/null (or BIT_BUCKET as it
4049 * is called) and still have the "-e" work. (Believe it or not,
4050 * a /dev/null is required for the "-e" to work because source
4051 * filter magic is used to implement it. ) This is *not* a general
4052 * replacement for a /dev/null. What we do here is create a temp
4053 * file (an empty file), open up that as the script, and then
4054 * immediately close and unlink it. Close enough for jazz. */
4055#define FAKE_BIT_BUCKET_PREFIX "/tmp/perlnull-"
4056#define FAKE_BIT_BUCKET_SUFFIX "XXXXXXXX"
4057#define FAKE_BIT_BUCKET_TEMPLATE FAKE_BIT_BUCKET_PREFIX FAKE_BIT_BUCKET_SUFFIX
4058 char tmpname[sizeof(FAKE_BIT_BUCKET_TEMPLATE)] = {
4059 FAKE_BIT_BUCKET_TEMPLATE
4060 };
4061 const char * const err = "Failed to create a fake bit bucket";
4062 if (strEQ(scriptname, BIT_BUCKET)) {
4063 int tmpfd = Perl_my_mkstemp_cloexec(tmpname);
4064 if (tmpfd > -1) {
4065 scriptname = tmpname;
4066 close(tmpfd);
4067 } else
4068 Perl_croak(aTHX_ err);
4069 }
4070#endif
4071 rsfp = PerlIO_open(scriptname,PERL_SCRIPT_MODE);
4072#ifdef FAKE_BIT_BUCKET
4073 if ( strBEGINs(scriptname, FAKE_BIT_BUCKET_PREFIX)
4074 && strlen(scriptname) == sizeof(tmpname) - 1)
4075 {
4076 unlink(scriptname);
4077 }
4078 scriptname = BIT_BUCKET;
4079#endif
4080 }
4081 if (!rsfp) {
4082 /* PSz 16 Sep 03 Keep neat error message */
4083 if (PL_e_script)
4084 Perl_croak(aTHX_ "Can't open " BIT_BUCKET ": %s\n", Strerror(errno));
4085 else
4086 Perl_croak(aTHX_ "Can't open perl script \"%s\": %s\n",
4087 CopFILE(PL_curcop), Strerror(errno));
4088 }
4089 fd = PerlIO_fileno(rsfp);
4090
4091 if (fd < 0 ||
4092 (PerlLIO_fstat(fd, &tmpstatbuf) >= 0
4093 && S_ISDIR(tmpstatbuf.st_mode)))
4094 Perl_croak(aTHX_ "Can't open perl script \"%s\": %s\n",
4095 CopFILE(PL_curcop),
4096 Strerror(EISDIR));
4097
4098 return rsfp;
4099}
4100
4101/* In the days of suidperl, we refused to execute a setuid script stored on
4102 * a filesystem mounted nosuid and/or noexec. This meant that we probed for the
4103 * existence of the appropriate filesystem-statting function, and behaved
4104 * accordingly. But even though suidperl is long gone, we must still include
4105 * those probes for the benefit of modules like Filesys::Df, which expect the
4106 * results of those probes to be stored in %Config; see RT#126368. So mention
4107 * the relevant cpp symbols here, to ensure that metaconfig will include their
4108 * probes in the generated Configure:
4109 *
4110 * I_SYSSTATVFS HAS_FSTATVFS
4111 * I_SYSMOUNT
4112 * I_STATFS HAS_FSTATFS HAS_GETFSSTAT
4113 * I_MNTENT HAS_GETMNTENT HAS_HASMNTOPT
4114 */
4115
4116
4117#ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
4118/* Don't even need this function. */
4119#else
4120STATIC void
4121S_validate_suid(pTHX_ PerlIO *rsfp)
4122{
4123 const Uid_t my_uid = PerlProc_getuid();
4124 const Uid_t my_euid = PerlProc_geteuid();
4125 const Gid_t my_gid = PerlProc_getgid();
4126 const Gid_t my_egid = PerlProc_getegid();
4127
4128 PERL_ARGS_ASSERT_VALIDATE_SUID;
4129
4130 if (my_euid != my_uid || my_egid != my_gid) { /* (suidperl doesn't exist, in fact) */
4131 int fd = PerlIO_fileno(rsfp);
4132 Stat_t statbuf;
4133 if (fd < 0 || PerlLIO_fstat(fd, &statbuf) < 0) { /* may be either wrapped or real suid */
4134 Perl_croak_nocontext( "Illegal suidscript");
4135 }
4136 if ((my_euid != my_uid && my_euid == statbuf.st_uid && statbuf.st_mode & S_ISUID)
4137 ||
4138 (my_egid != my_gid && my_egid == statbuf.st_gid && statbuf.st_mode & S_ISGID)
4139 )
4140 if (!PL_do_undump)
4141 Perl_croak(aTHX_ "YOU HAVEN'T DISABLED SET-ID SCRIPTS IN THE KERNEL YET!\n\
4142FIX YOUR KERNEL, PUT A C WRAPPER AROUND THIS SCRIPT, OR USE -u AND UNDUMP!\n");
4143 /* not set-id, must be wrapped */
4144 }
4145}
4146#endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4147
4148STATIC void
4149S_find_beginning(pTHX_ SV* linestr_sv, PerlIO *rsfp)
4150{
4151 const char *s;
4152 const char *s2;
4153
4154 PERL_ARGS_ASSERT_FIND_BEGINNING;
4155
4156 /* skip forward in input to the real script? */
4157
4158 do {
4159 if ((s = sv_gets(linestr_sv, rsfp, 0)) == NULL)
4160 Perl_croak(aTHX_ "No Perl script found in input\n");
4161 s2 = s;
4162 } while (!(*s == '#' && s[1] == '!' && ((s = instr(s,"perl")) || (s = instr(s2,"PERL")))));
4163 PerlIO_ungetc(rsfp, '\n'); /* to keep line count right */
4164 while (*s && !(isSPACE (*s) || *s == '#')) s++;
4165 s2 = s;
4166 while (*s == ' ' || *s == '\t') s++;
4167 if (*s++ == '-') {
4168 while (isDIGIT(s2[-1]) || s2[-1] == '-' || s2[-1] == '.'
4169 || s2[-1] == '_') s2--;
4170 if (strBEGINs(s2-4,"perl"))
4171 while ((s = moreswitches(s)))
4172 ;
4173 }
4174}
4175
4176
4177STATIC void
4178S_init_ids(pTHX)
4179{
4180 /* no need to do anything here any more if we don't
4181 * do tainting. */
4182#ifndef NO_TAINT_SUPPORT
4183 const Uid_t my_uid = PerlProc_getuid();
4184 const Uid_t my_euid = PerlProc_geteuid();
4185 const Gid_t my_gid = PerlProc_getgid();
4186 const Gid_t my_egid = PerlProc_getegid();
4187
4188 PERL_UNUSED_CONTEXT;
4189
4190 /* Should not happen: */
4191 CHECK_MALLOC_TAINT(my_uid && (my_euid != my_uid || my_egid != my_gid));
4192 TAINTING_set( TAINTING_get | (my_uid && (my_euid != my_uid || my_egid != my_gid)) );
4193#endif
4194 /* BUG */
4195 /* PSz 27 Feb 04
4196 * Should go by suidscript, not uid!=euid: why disallow
4197 * system("ls") in scripts run from setuid things?
4198 * Or, is this run before we check arguments and set suidscript?
4199 * What about SETUID_SCRIPTS_ARE_SECURE_NOW: could we use fdscript then?
4200 * (We never have suidscript, can we be sure to have fdscript?)
4201 * Or must then go by UID checks? See comments in forbid_setid also.
4202 */
4203}
4204
4205/* This is used very early in the lifetime of the program,
4206 * before even the options are parsed, so PL_tainting has
4207 * not been initialized properly. */
4208bool
4209Perl_doing_taint(int argc, char *argv[], char *envp[])
4210{
4211#ifndef PERL_IMPLICIT_SYS
4212 /* If we have PERL_IMPLICIT_SYS we can't call getuid() et alia
4213 * before we have an interpreter-- and the whole point of this
4214 * function is to be called at such an early stage. If you are on
4215 * a system with PERL_IMPLICIT_SYS but you do have a concept of
4216 * "tainted because running with altered effective ids', you'll
4217 * have to add your own checks somewhere in here. The two most
4218 * known samples of 'implicitness' are Win32 and NetWare, neither
4219 * of which has much of concept of 'uids'. */
4220 Uid_t uid = PerlProc_getuid();
4221 Uid_t euid = PerlProc_geteuid();
4222 Gid_t gid = PerlProc_getgid();
4223 Gid_t egid = PerlProc_getegid();
4224 (void)envp;
4225
4226#ifdef VMS
4227 uid |= gid << 16;
4228 euid |= egid << 16;
4229#endif
4230 if (uid && (euid != uid || egid != gid))
4231 return 1;
4232#endif /* !PERL_IMPLICIT_SYS */
4233 /* This is a really primitive check; environment gets ignored only
4234 * if -T are the first chars together; otherwise one gets
4235 * "Too late" message. */
4236 if ( argc > 1 && argv[1][0] == '-'
4237 && isALPHA_FOLD_EQ(argv[1][1], 't'))
4238 return 1;
4239 return 0;
4240}
4241
4242/* Passing the flag as a single char rather than a string is a slight space
4243 optimisation. The only message that isn't /^-.$/ is
4244 "program input from stdin", which is substituted in place of '\0', which
4245 could never be a command line flag. */
4246STATIC void
4247S_forbid_setid(pTHX_ const char flag, const bool suidscript) /* g */
4248{
4249 char string[3] = "-x";
4250 const char *message = "program input from stdin";
4251
4252 PERL_UNUSED_CONTEXT;
4253 if (flag) {
4254 string[1] = flag;
4255 message = string;
4256 }
4257
4258#ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
4259 if (PerlProc_getuid() != PerlProc_geteuid())
4260 Perl_croak(aTHX_ "No %s allowed while running setuid", message);
4261 if (PerlProc_getgid() != PerlProc_getegid())
4262 Perl_croak(aTHX_ "No %s allowed while running setgid", message);
4263#endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4264 if (suidscript)
4265 Perl_croak(aTHX_ "No %s allowed with (suid) fdscript", message);
4266}
4267
4268void
4269Perl_init_dbargs(pTHX)
4270{
4271 AV *const args = PL_dbargs = GvAV(gv_AVadd((gv_fetchpvs("DB::args",
4272 GV_ADDMULTI,
4273 SVt_PVAV))));
4274
4275 if (AvREAL(args)) {
4276 /* Someone has already created it.
4277 It might have entries, and if we just turn off AvREAL(), they will
4278 "leak" until global destruction. */
4279 av_clear(args);
4280 if (SvTIED_mg((const SV *)args, PERL_MAGIC_tied))
4281 Perl_croak(aTHX_ "Cannot set tied @DB::args");
4282 }
4283 AvREIFY_only(PL_dbargs);
4284}
4285
4286void
4287Perl_init_debugger(pTHX)
4288{
4289 HV * const ostash = PL_curstash;
4290 MAGIC *mg;
4291
4292 PL_curstash = (HV *)SvREFCNT_inc_simple(PL_debstash);
4293
4294 Perl_init_dbargs(aTHX);
4295 PL_DBgv = MUTABLE_GV(
4296 SvREFCNT_inc(gv_fetchpvs("DB::DB", GV_ADDMULTI, SVt_PVGV))
4297 );
4298 PL_DBline = MUTABLE_GV(
4299 SvREFCNT_inc(gv_fetchpvs("DB::dbline", GV_ADDMULTI, SVt_PVAV))
4300 );
4301 PL_DBsub = MUTABLE_GV(SvREFCNT_inc(
4302 gv_HVadd(gv_fetchpvs("DB::sub", GV_ADDMULTI, SVt_PVHV))
4303 ));
4304 PL_DBsingle = GvSV((gv_fetchpvs("DB::single", GV_ADDMULTI, SVt_PV)));
4305 if (!SvIOK(PL_DBsingle))
4306 sv_setiv(PL_DBsingle, 0);
4307 mg = sv_magicext(PL_DBsingle, NULL, PERL_MAGIC_debugvar, &PL_vtbl_debugvar, 0, 0);
4308 mg->mg_private = DBVARMG_SINGLE;
4309 SvSETMAGIC(PL_DBsingle);
4310
4311 PL_DBtrace = GvSV((gv_fetchpvs("DB::trace", GV_ADDMULTI, SVt_PV)));
4312 if (!SvIOK(PL_DBtrace))
4313 sv_setiv(PL_DBtrace, 0);
4314 mg = sv_magicext(PL_DBtrace, NULL, PERL_MAGIC_debugvar, &PL_vtbl_debugvar, 0, 0);
4315 mg->mg_private = DBVARMG_TRACE;
4316 SvSETMAGIC(PL_DBtrace);
4317
4318 PL_DBsignal = GvSV((gv_fetchpvs("DB::signal", GV_ADDMULTI, SVt_PV)));
4319 if (!SvIOK(PL_DBsignal))
4320 sv_setiv(PL_DBsignal, 0);
4321 mg = sv_magicext(PL_DBsignal, NULL, PERL_MAGIC_debugvar, &PL_vtbl_debugvar, 0, 0);
4322 mg->mg_private = DBVARMG_SIGNAL;
4323 SvSETMAGIC(PL_DBsignal);
4324
4325 SvREFCNT_dec(PL_curstash);
4326 PL_curstash = ostash;
4327}
4328
4329#ifndef STRESS_REALLOC
4330#define REASONABLE(size) (size)
4331#define REASONABLE_but_at_least(size,min) (size)
4332#else
4333#define REASONABLE(size) (1) /* unreasonable */
4334#define REASONABLE_but_at_least(size,min) (min)
4335#endif
4336
4337void
4338Perl_init_stacks(pTHX)
4339{
4340 SSize_t size;
4341
4342 /* start with 128-item stack and 8K cxstack */
4343 PL_curstackinfo = new_stackinfo(REASONABLE(128),
4344 REASONABLE(8192/sizeof(PERL_CONTEXT) - 1));
4345 PL_curstackinfo->si_type = PERLSI_MAIN;
4346#if defined DEBUGGING && !defined DEBUGGING_RE_ONLY
4347 PL_curstackinfo->si_stack_hwm = 0;
4348#endif
4349 PL_curstack = PL_curstackinfo->si_stack;
4350 PL_mainstack = PL_curstack; /* remember in case we switch stacks */
4351
4352 PL_stack_base = AvARRAY(PL_curstack);
4353 PL_stack_sp = PL_stack_base;
4354 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
4355
4356 Newx(PL_tmps_stack,REASONABLE(128),SV*);
4357 PL_tmps_floor = -1;
4358 PL_tmps_ix = -1;
4359 PL_tmps_max = REASONABLE(128);
4360
4361 Newx(PL_markstack,REASONABLE(32),I32);
4362 PL_markstack_ptr = PL_markstack;
4363 PL_markstack_max = PL_markstack + REASONABLE(32);
4364
4365 SET_MARK_OFFSET;
4366
4367 Newx(PL_scopestack,REASONABLE(32),I32);
4368#ifdef DEBUGGING
4369 Newx(PL_scopestack_name,REASONABLE(32),const char*);
4370#endif
4371 PL_scopestack_ix = 0;
4372 PL_scopestack_max = REASONABLE(32);
4373
4374 size = REASONABLE_but_at_least(128,SS_MAXPUSH);
4375 Newx(PL_savestack, size, ANY);
4376 PL_savestack_ix = 0;
4377 /*PL_savestack_max lies: it always has SS_MAXPUSH more than it claims */
4378 PL_savestack_max = size - SS_MAXPUSH;
4379}
4380
4381#undef REASONABLE
4382
4383STATIC void
4384S_nuke_stacks(pTHX)
4385{
4386 while (PL_curstackinfo->si_next)
4387 PL_curstackinfo = PL_curstackinfo->si_next;
4388 while (PL_curstackinfo) {
4389 PERL_SI *p = PL_curstackinfo->si_prev;
4390 /* curstackinfo->si_stack got nuked by sv_free_arenas() */
4391 Safefree(PL_curstackinfo->si_cxstack);
4392 Safefree(PL_curstackinfo);
4393 PL_curstackinfo = p;
4394 }
4395 Safefree(PL_tmps_stack);
4396 Safefree(PL_markstack);
4397 Safefree(PL_scopestack);
4398#ifdef DEBUGGING
4399 Safefree(PL_scopestack_name);
4400#endif
4401 Safefree(PL_savestack);
4402}
4403
4404void
4405Perl_populate_isa(pTHX_ const char *name, STRLEN len, ...)
4406{
4407 GV *const gv = gv_fetchpvn(name, len, GV_ADD | GV_ADDMULTI, SVt_PVAV);
4408 AV *const isa = GvAVn(gv);
4409 va_list args;
4410
4411 PERL_ARGS_ASSERT_POPULATE_ISA;
4412
4413 if(AvFILLp(isa) != -1)
4414 return;
4415
4416 /* NOTE: No support for tied ISA */
4417
4418 va_start(args, len);
4419 do {
4420 const char *const parent = va_arg(args, const char*);
4421 size_t parent_len;
4422
4423 if (!parent)
4424 break;
4425 parent_len = va_arg(args, size_t);
4426
4427 /* Arguments are supplied with a trailing :: */
4428 assert(parent_len > 2);
4429 assert(parent[parent_len - 1] == ':');
4430 assert(parent[parent_len - 2] == ':');
4431 av_push(isa, newSVpvn(parent, parent_len - 2));
4432 (void) gv_fetchpvn(parent, parent_len, GV_ADD, SVt_PVGV);
4433 } while (1);
4434 va_end(args);
4435}
4436
4437
4438STATIC void
4439S_init_predump_symbols(pTHX)
4440{
4441 GV *tmpgv;
4442 IO *io;
4443
4444 sv_setpvs(get_sv("\"", GV_ADD), " ");
4445 PL_ofsgv = (GV*)SvREFCNT_inc(gv_fetchpvs(",", GV_ADD|GV_NOTQUAL, SVt_PV));
4446
4447
4448 /* Historically, PVIOs were blessed into IO::Handle, unless
4449 FileHandle was loaded, in which case they were blessed into
4450 that. Action at a distance.
4451 However, if we simply bless into IO::Handle, we break code
4452 that assumes that PVIOs will have (among others) a seek
4453 method. IO::File inherits from IO::Handle and IO::Seekable,
4454 and provides the needed methods. But if we simply bless into
4455 it, then we break code that assumed that by loading
4456 IO::Handle, *it* would work.
4457 So a compromise is to set up the correct @IO::File::ISA,
4458 so that code that does C<use IO::Handle>; will still work.
4459 */
4460
4461 Perl_populate_isa(aTHX_ STR_WITH_LEN("IO::File::ISA"),
4462 STR_WITH_LEN("IO::Handle::"),
4463 STR_WITH_LEN("IO::Seekable::"),
4464 STR_WITH_LEN("Exporter::"),
4465 NULL);
4466
4467 PL_stdingv = gv_fetchpvs("STDIN", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4468 GvMULTI_on(PL_stdingv);
4469 io = GvIOp(PL_stdingv);
4470 IoTYPE(io) = IoTYPE_RDONLY;
4471 IoIFP(io) = PerlIO_stdin();
4472 tmpgv = gv_fetchpvs("stdin", GV_ADD|GV_NOTQUAL, SVt_PV);
4473 GvMULTI_on(tmpgv);
4474 GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4475
4476 tmpgv = gv_fetchpvs("STDOUT", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4477 GvMULTI_on(tmpgv);
4478 io = GvIOp(tmpgv);
4479 IoTYPE(io) = IoTYPE_WRONLY;
4480 IoOFP(io) = IoIFP(io) = PerlIO_stdout();
4481 setdefout(tmpgv);
4482 tmpgv = gv_fetchpvs("stdout", GV_ADD|GV_NOTQUAL, SVt_PV);
4483 GvMULTI_on(tmpgv);
4484 GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4485
4486 PL_stderrgv = gv_fetchpvs("STDERR", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4487 GvMULTI_on(PL_stderrgv);
4488 io = GvIOp(PL_stderrgv);
4489 IoTYPE(io) = IoTYPE_WRONLY;
4490 IoOFP(io) = IoIFP(io) = PerlIO_stderr();
4491 tmpgv = gv_fetchpvs("stderr", GV_ADD|GV_NOTQUAL, SVt_PV);
4492 GvMULTI_on(tmpgv);
4493 GvIOp(tmpgv) = MUTABLE_IO(SvREFCNT_inc_simple(io));
4494
4495 PL_statname = newSVpvs(""); /* last filename we did stat on */
4496}
4497
4498void
4499Perl_init_argv_symbols(pTHX_ int argc, char **argv)
4500{
4501 PERL_ARGS_ASSERT_INIT_ARGV_SYMBOLS;
4502
4503 argc--,argv++; /* skip name of script */
4504 if (PL_doswitches) {
4505 for (; argc > 0 && **argv == '-'; argc--,argv++) {
4506 char *s;
4507 if (!argv[0][1])
4508 break;
4509 if (argv[0][1] == '-' && !argv[0][2]) {
4510 argc--,argv++;
4511 break;
4512 }
4513 if ((s = strchr(argv[0], '='))) {
4514 const char *const start_name = argv[0] + 1;
4515 sv_setpv(GvSV(gv_fetchpvn_flags(start_name, s - start_name,
4516 TRUE, SVt_PV)), s + 1);
4517 }
4518 else
4519 sv_setiv(GvSV(gv_fetchpv(argv[0]+1, GV_ADD, SVt_PV)),1);
4520 }
4521 }
4522 if ((PL_argvgv = gv_fetchpvs("ARGV", GV_ADD|GV_NOTQUAL, SVt_PVAV))) {
4523 SvREFCNT_inc_simple_void_NN(PL_argvgv);
4524 GvMULTI_on(PL_argvgv);
4525 av_clear(GvAVn(PL_argvgv));
4526 for (; argc > 0; argc--,argv++) {
4527 SV * const sv = newSVpv(argv[0],0);
4528 av_push(GvAV(PL_argvgv),sv);
4529 if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
4530 if (PL_unicode & PERL_UNICODE_ARGV_FLAG)
4531 SvUTF8_on(sv);
4532 }
4533 if (PL_unicode & PERL_UNICODE_WIDESYSCALLS_FLAG) /* Sarathy? */
4534 (void)sv_utf8_decode(sv);
4535 }
4536 }
4537
4538 if (PL_inplace && (!PL_argvgv || AvFILL(GvAV(PL_argvgv)) == -1))
4539 Perl_ck_warner_d(aTHX_ packWARN(WARN_INPLACE),
4540 "-i used with no filenames on the command line, "
4541 "reading from STDIN");
4542}
4543
4544STATIC void
4545S_init_postdump_symbols(pTHX_ int argc, char **argv, char **env)
4546{
4547 GV* tmpgv;
4548
4549 PERL_ARGS_ASSERT_INIT_POSTDUMP_SYMBOLS;
4550
4551 PL_toptarget = newSV_type(SVt_PVIV);
4552 SvPVCLEAR(PL_toptarget);
4553 PL_bodytarget = newSV_type(SVt_PVIV);
4554 SvPVCLEAR(PL_bodytarget);
4555 PL_formtarget = PL_bodytarget;
4556
4557 TAINT;
4558
4559 init_argv_symbols(argc,argv);
4560
4561 if ((tmpgv = gv_fetchpvs("0", GV_ADD|GV_NOTQUAL, SVt_PV))) {
4562 sv_setpv(GvSV(tmpgv),PL_origfilename);
4563 }
4564 if ((PL_envgv = gv_fetchpvs("ENV", GV_ADD|GV_NOTQUAL, SVt_PVHV))) {
4565 HV *hv;
4566 bool env_is_not_environ;
4567 SvREFCNT_inc_simple_void_NN(PL_envgv);
4568 GvMULTI_on(PL_envgv);
4569 hv = GvHVn(PL_envgv);
4570 hv_magic(hv, NULL, PERL_MAGIC_env);
4571#ifndef PERL_MICRO
4572#ifdef USE_ENVIRON_ARRAY
4573 /* Note that if the supplied env parameter is actually a copy
4574 of the global environ then it may now point to free'd memory
4575 if the environment has been modified since. To avoid this
4576 problem we treat env==NULL as meaning 'use the default'
4577 */
4578 if (!env)
4579 env = environ;
4580 env_is_not_environ = env != environ;
4581 if (env_is_not_environ
4582# ifdef USE_ITHREADS
4583 && PL_curinterp == aTHX
4584# endif
4585 )
4586 {
4587 environ[0] = NULL;
4588 }
4589 if (env) {
4590 char *s, *old_var;
4591 STRLEN nlen;
4592 SV *sv;
4593 HV *dups = newHV();
4594
4595 for (; *env; env++) {
4596 old_var = *env;
4597
4598 if (!(s = strchr(old_var,'=')) || s == old_var)
4599 continue;
4600 nlen = s - old_var;
4601
4602#if defined(MSDOS) && !defined(DJGPP)
4603 *s = '\0';
4604 (void)strupr(old_var);
4605 *s = '=';
4606#endif
4607 if (hv_exists(hv, old_var, nlen)) {
4608 const char *name = savepvn(old_var, nlen);
4609
4610 /* make sure we use the same value as getenv(), otherwise code that
4611 uses getenv() (like setlocale()) might see a different value to %ENV
4612 */
4613 sv = newSVpv(PerlEnv_getenv(name), 0);
4614
4615 /* keep a count of the dups of this name so we can de-dup environ later */
4616 if (hv_exists(dups, name, nlen))
4617 ++SvIVX(*hv_fetch(dups, name, nlen, 0));
4618 else
4619 (void)hv_store(dups, name, nlen, newSViv(1), 0);
4620
4621 Safefree(name);
4622 }
4623 else {
4624 sv = newSVpv(s+1, 0);
4625 }
4626 (void)hv_store(hv, old_var, nlen, sv, 0);
4627 if (env_is_not_environ)
4628 mg_set(sv);
4629 }
4630 if (HvKEYS(dups)) {
4631 /* environ has some duplicate definitions, remove them */
4632 HE *entry;
4633 hv_iterinit(dups);
4634 while ((entry = hv_iternext_flags(dups, 0))) {
4635 STRLEN nlen;
4636 const char *name = HePV(entry, nlen);
4637 IV count = SvIV(HeVAL(entry));
4638 IV i;
4639 SV **valp = hv_fetch(hv, name, nlen, 0);
4640
4641 assert(valp);
4642
4643 /* try to remove any duplicate names, depending on the
4644 * implementation used in my_setenv() the iteration might
4645 * not be necessary, but let's be safe.
4646 */
4647 for (i = 0; i < count; ++i)
4648 my_setenv(name, 0);
4649
4650 /* and set it back to the value we set $ENV{name} to */
4651 my_setenv(name, SvPV_nolen(*valp));
4652 }
4653 }
4654 SvREFCNT_dec_NN(dups);
4655 }
4656#endif /* USE_ENVIRON_ARRAY */
4657#endif /* !PERL_MICRO */
4658 }
4659 TAINT_NOT;
4660
4661 /* touch @F array to prevent spurious warnings 20020415 MJD */
4662 if (PL_minus_a) {
4663 (void) get_av("main::F", GV_ADD | GV_ADDMULTI);
4664 }
4665}
4666
4667STATIC void
4668S_init_perllib(pTHX)
4669{
4670#ifndef VMS
4671 const char *perl5lib = NULL;
4672#endif
4673 const char *s;
4674#if defined(WIN32) && !defined(PERL_IS_MINIPERL)
4675 STRLEN len;
4676#endif
4677
4678 if (!TAINTING_get) {
4679#ifndef VMS
4680 perl5lib = PerlEnv_getenv("PERL5LIB");
4681/*
4682 * It isn't possible to delete an environment variable with
4683 * PERL_USE_SAFE_PUTENV set unless unsetenv() is also available, so in that
4684 * case we treat PERL5LIB as undefined if it has a zero-length value.
4685 */
4686#if defined(PERL_USE_SAFE_PUTENV) && ! defined(HAS_UNSETENV)
4687 if (perl5lib && *perl5lib != '\0')
4688#else
4689 if (perl5lib)
4690#endif
4691 incpush_use_sep(perl5lib, 0, INCPUSH_ADD_SUB_DIRS);
4692 else {
4693 s = PerlEnv_getenv("PERLLIB");
4694 if (s)
4695 incpush_use_sep(s, 0, 0);
4696 }
4697#else /* VMS */
4698 /* Treat PERL5?LIB as a possible search list logical name -- the
4699 * "natural" VMS idiom for a Unix path string. We allow each
4700 * element to be a set of |-separated directories for compatibility.
4701 */
4702 char buf[256];
4703 int idx = 0;
4704 if (vmstrnenv("PERL5LIB",buf,0,NULL,0))
4705 do {
4706 incpush_use_sep(buf, 0, INCPUSH_ADD_SUB_DIRS);
4707 } while (vmstrnenv("PERL5LIB",buf,++idx,NULL,0));
4708 else {
4709 while (vmstrnenv("PERLLIB",buf,idx++,NULL,0))
4710 incpush_use_sep(buf, 0, 0);
4711 }
4712#endif /* VMS */
4713 }
4714
4715#ifndef PERL_IS_MINIPERL
4716 /* miniperl gets just -I..., the split of $ENV{PERL5LIB}, and "." in @INC
4717 (and not the architecture specific directories from $ENV{PERL5LIB}) */
4718
4719#include "perl_inc_macro.h"
4720/* Use the ~-expanded versions of APPLLIB (undocumented),
4721 SITEARCH, SITELIB, VENDORARCH, VENDORLIB, ARCHLIB and PRIVLIB
4722*/
4723 INCPUSH_APPLLIB_EXP
4724 INCPUSH_SITEARCH_EXP
4725 INCPUSH_SITELIB_EXP
4726 INCPUSH_PERL_VENDORARCH_EXP
4727 INCPUSH_PERL_VENDORLIB_EXP
4728 INCPUSH_ARCHLIB_EXP
4729 INCPUSH_PRIVLIB_EXP
4730 INCPUSH_PERL_OTHERLIBDIRS
4731 INCPUSH_PERL5LIB
4732 INCPUSH_APPLLIB_OLD_EXP
4733 INCPUSH_SITELIB_STEM
4734 INCPUSH_PERL_VENDORLIB_STEM
4735 INCPUSH_PERL_OTHERLIBDIRS_ARCHONLY
4736
4737#endif /* !PERL_IS_MINIPERL */
4738
4739 if (!TAINTING_get) {
4740#if !defined(PERL_IS_MINIPERL) && defined(DEFAULT_INC_EXCLUDES_DOT)
4741 const char * const unsafe = PerlEnv_getenv("PERL_USE_UNSAFE_INC");
4742 if (unsafe && strEQ(unsafe, "1"))
4743#endif
4744 S_incpush(aTHX_ STR_WITH_LEN("."), 0);
4745 }
4746}
4747
4748#if defined(DOSISH)
4749# define PERLLIB_SEP ';'
4750#elif defined(__VMS)
4751# define PERLLIB_SEP PL_perllib_sep
4752#else
4753# define PERLLIB_SEP ':'
4754#endif
4755#ifndef PERLLIB_MANGLE
4756# define PERLLIB_MANGLE(s,n) (s)
4757#endif
4758
4759#ifndef PERL_IS_MINIPERL
4760/* Push a directory onto @INC if it exists.
4761 Generate a new SV if we do this, to save needing to copy the SV we push
4762 onto @INC */
4763STATIC SV *
4764S_incpush_if_exists(pTHX_ AV *const av, SV *dir, SV *const stem)
4765{
4766 Stat_t tmpstatbuf;
4767
4768 PERL_ARGS_ASSERT_INCPUSH_IF_EXISTS;
4769
4770 if (PerlLIO_stat(SvPVX_const(dir), &tmpstatbuf) >= 0 &&
4771 S_ISDIR(tmpstatbuf.st_mode)) {
4772 av_push(av, dir);
4773 dir = newSVsv(stem);
4774 } else {
4775 /* Truncate dir back to stem. */
4776 SvCUR_set(dir, SvCUR(stem));
4777 }
4778 return dir;
4779}
4780#endif
4781
4782STATIC SV *
4783S_mayberelocate(pTHX_ const char *const dir, STRLEN len, U32 flags)
4784{
4785 const U8 canrelocate = (U8)flags & INCPUSH_CAN_RELOCATE;
4786 SV *libdir;
4787
4788 PERL_ARGS_ASSERT_MAYBERELOCATE;
4789 assert(len > 0);
4790
4791 /* I am not convinced that this is valid when PERLLIB_MANGLE is
4792 defined to so something (in os2/os2.c), but the code has been
4793 this way, ignoring any possible changed of length, since
4794 760ac839baf413929cd31cc32ffd6dba6b781a81 (5.003_02) so I'll leave
4795 it be. */
4796 libdir = newSVpvn(PERLLIB_MANGLE(dir, len), len);
4797
4798#ifdef VMS
4799 {
4800 char *unix;
4801
4802 if ((unix = tounixspec_ts(SvPV(libdir,len),NULL)) != NULL) {
4803 len = strlen(unix);
4804 while (len > 1 && unix[len-1] == '/') len--; /* Cosmetic */
4805 sv_usepvn(libdir,unix,len);
4806 }
4807 else
4808 PerlIO_printf(Perl_error_log,
4809 "Failed to unixify @INC element \"%s\"\n",
4810 SvPV_nolen_const(libdir));
4811 }
4812#endif
4813
4814 /* Do the if() outside the #ifdef to avoid warnings about an unused
4815 parameter. */
4816 if (canrelocate) {
4817#ifdef PERL_RELOCATABLE_INC
4818 /*
4819 * Relocatable include entries are marked with a leading .../
4820 *
4821 * The algorithm is
4822 * 0: Remove that leading ".../"
4823 * 1: Remove trailing executable name (anything after the last '/')
4824 * from the perl path to give a perl prefix
4825 * Then
4826 * While the @INC element starts "../" and the prefix ends with a real
4827 * directory (ie not . or ..) chop that real directory off the prefix
4828 * and the leading "../" from the @INC element. ie a logical "../"
4829 * cleanup
4830 * Finally concatenate the prefix and the remainder of the @INC element
4831 * The intent is that /usr/local/bin/perl and .../../lib/perl5
4832 * generates /usr/local/lib/perl5
4833 */
4834 const char *libpath = SvPVX(libdir);
4835 STRLEN libpath_len = SvCUR(libdir);
4836 if (memBEGINs(libpath, libpath_len, ".../")) {
4837 /* Game on! */
4838 SV * const caret_X = get_sv("\030", 0);
4839 /* Going to use the SV just as a scratch buffer holding a C
4840 string: */
4841 SV *prefix_sv;
4842 char *prefix;
4843 char *lastslash;
4844
4845 /* $^X is *the* source of taint if tainting is on, hence
4846 SvPOK() won't be true. */
4847 assert(caret_X);
4848 assert(SvPOKp(caret_X));
4849 prefix_sv = newSVpvn_flags(SvPVX(caret_X), SvCUR(caret_X),
4850 SvUTF8(caret_X));
4851 /* Firstly take off the leading .../
4852 If all else fail we'll do the paths relative to the current
4853 directory. */
4854 sv_chop(libdir, libpath + 4);
4855 /* Don't use SvPV as we're intentionally bypassing taining,
4856 mortal copies that the mg_get of tainting creates, and
4857 corruption that seems to come via the save stack.
4858 I guess that the save stack isn't correctly set up yet. */
4859 libpath = SvPVX(libdir);
4860 libpath_len = SvCUR(libdir);
4861
4862 prefix = SvPVX(prefix_sv);
4863 lastslash = (char *) my_memrchr(prefix, '/',
4864 SvEND(prefix_sv) - prefix);
4865
4866 /* First time in with the *lastslash = '\0' we just wipe off
4867 the trailing /perl from (say) /usr/foo/bin/perl
4868 */
4869 if (lastslash) {
4870 SV *tempsv;
4871 while ((*lastslash = '\0'), /* Do that, come what may. */
4872 ( memBEGINs(libpath, libpath_len, "../")
4873 && (lastslash =
4874 (char *) my_memrchr(prefix, '/',
4875 SvEND(prefix_sv) - prefix))))
4876 {
4877 if (lastslash[1] == '\0'
4878 || (lastslash[1] == '.'
4879 && (lastslash[2] == '/' /* ends "/." */
4880 || (lastslash[2] == '/'
4881 && lastslash[3] == '/' /* or "/.." */
4882 )))) {
4883 /* Prefix ends "/" or "/." or "/..", any of which
4884 are fishy, so don't do any more logical cleanup.
4885 */
4886 break;
4887 }
4888 /* Remove leading "../" from path */
4889 libpath += 3;
4890 libpath_len -= 3;
4891 /* Next iteration round the loop removes the last
4892 directory name from prefix by writing a '\0' in
4893 the while clause. */
4894 }
4895 /* prefix has been terminated with a '\0' to the correct
4896 length. libpath points somewhere into the libdir SV.
4897 We need to join the 2 with '/' and drop the result into
4898 libdir. */
4899 tempsv = Perl_newSVpvf(aTHX_ "%s/%s", prefix, libpath);
4900 SvREFCNT_dec(libdir);
4901 /* And this is the new libdir. */
4902 libdir = tempsv;
4903 if (TAINTING_get &&
4904 (PerlProc_getuid() != PerlProc_geteuid() ||
4905 PerlProc_getgid() != PerlProc_getegid())) {
4906 /* Need to taint relocated paths if running set ID */
4907 SvTAINTED_on(libdir);
4908 }
4909 }
4910 SvREFCNT_dec(prefix_sv);
4911 }
4912#endif
4913 }
4914 return libdir;
4915}
4916
4917STATIC void
4918S_incpush(pTHX_ const char *const dir, STRLEN len, U32 flags)
4919{
4920#ifndef PERL_IS_MINIPERL
4921 const U8 using_sub_dirs
4922 = (U8)flags & (INCPUSH_ADD_VERSIONED_SUB_DIRS
4923 |INCPUSH_ADD_ARCHONLY_SUB_DIRS|INCPUSH_ADD_OLD_VERS);
4924 const U8 add_versioned_sub_dirs
4925 = (U8)flags & INCPUSH_ADD_VERSIONED_SUB_DIRS;
4926 const U8 add_archonly_sub_dirs
4927 = (U8)flags & INCPUSH_ADD_ARCHONLY_SUB_DIRS;
4928#ifdef PERL_INC_VERSION_LIST
4929 const U8 addoldvers = (U8)flags & INCPUSH_ADD_OLD_VERS;
4930#endif
4931#endif
4932 const U8 unshift = (U8)flags & INCPUSH_UNSHIFT;
4933 const U8 push_basedir = (flags & INCPUSH_NOT_BASEDIR) ? 0 : 1;
4934 AV *const inc = GvAVn(PL_incgv);
4935
4936 PERL_ARGS_ASSERT_INCPUSH;
4937 assert(len > 0);
4938
4939 /* Could remove this vestigial extra block, if we don't mind a lot of
4940 re-indenting diff noise. */
4941 {
4942 SV *const libdir = mayberelocate(dir, len, flags);
4943 /* Change 20189146be79a0596543441fa369c6bf7f85103f, to fix RT#6665,
4944 arranged to unshift #! line -I onto the front of @INC. However,
4945 -I can add version and architecture specific libraries, and they
4946 need to go first. The old code assumed that it was always
4947 pushing. Hence to make it work, need to push the architecture
4948 (etc) libraries onto a temporary array, then "unshift" that onto
4949 the front of @INC. */
4950#ifndef PERL_IS_MINIPERL
4951 AV *const av = (using_sub_dirs) ? (unshift ? newAV() : inc) : NULL;
4952
4953 /*
4954 * BEFORE pushing libdir onto @INC we may first push version- and
4955 * archname-specific sub-directories.
4956 */
4957 if (using_sub_dirs) {
4958 SV *subdir = newSVsv(libdir);
4959#ifdef PERL_INC_VERSION_LIST
4960 /* Configure terminates PERL_INC_VERSION_LIST with a NULL */
4961 const char * const incverlist[] = { PERL_INC_VERSION_LIST };
4962 const char * const *incver;
4963#endif
4964
4965 if (add_versioned_sub_dirs) {
4966 /* .../version/archname if -d .../version/archname */
4967 sv_catpvs(subdir, "/" PERL_FS_VERSION "/" ARCHNAME);
4968 subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
4969
4970 /* .../version if -d .../version */
4971 sv_catpvs(subdir, "/" PERL_FS_VERSION);
4972 subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
4973 }
4974
4975#ifdef PERL_INC_VERSION_LIST
4976 if (addoldvers) {
4977 for (incver = incverlist; *incver; incver++) {
4978 /* .../xxx if -d .../xxx */
4979 Perl_sv_catpvf(aTHX_ subdir, "/%s", *incver);
4980 subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
4981 }
4982 }
4983#endif
4984
4985 if (add_archonly_sub_dirs) {
4986 /* .../archname if -d .../archname */
4987 sv_catpvs(subdir, "/" ARCHNAME);
4988 subdir = S_incpush_if_exists(aTHX_ av, subdir, libdir);
4989
4990 }
4991
4992 assert (SvREFCNT(subdir) == 1);
4993 SvREFCNT_dec(subdir);
4994 }
4995#endif /* !PERL_IS_MINIPERL */
4996 /* finally add this lib directory at the end of @INC */
4997 if (unshift) {
4998#ifdef PERL_IS_MINIPERL
4999 const Size_t extra = 0;
5000#else
5001 Size_t extra = av_count(av);
5002#endif
5003 av_unshift(inc, extra + push_basedir);
5004 if (push_basedir)
5005 av_store(inc, extra, libdir);
5006#ifndef PERL_IS_MINIPERL
5007 while (extra--) {
5008 /* av owns a reference, av_store() expects to be donated a
5009 reference, and av expects to be sane when it's cleared.
5010 If I wanted to be naughty and wrong, I could peek inside the
5011 implementation of av_clear(), realise that it uses
5012 SvREFCNT_dec() too, so av's array could be a run of NULLs,
5013 and so directly steal from it (with a memcpy() to inc, and
5014 then memset() to NULL them out. But people copy code from the
5015 core expecting it to be best practise, so let's use the API.
5016 Although studious readers will note that I'm not checking any
5017 return codes. */
5018 av_store(inc, extra, SvREFCNT_inc(*av_fetch(av, extra, FALSE)));
5019 }
5020 SvREFCNT_dec(av);
5021#endif
5022 }
5023 else if (push_basedir) {
5024 av_push(inc, libdir);
5025 }
5026
5027 if (!push_basedir) {
5028 assert (SvREFCNT(libdir) == 1);
5029 SvREFCNT_dec(libdir);
5030 }
5031 }
5032}
5033
5034STATIC void
5035S_incpush_use_sep(pTHX_ const char *p, STRLEN len, U32 flags)
5036{
5037 const char *s;
5038 const char *end;
5039 /* This logic has been broken out from S_incpush(). It may be possible to
5040 simplify it. */
5041
5042 PERL_ARGS_ASSERT_INCPUSH_USE_SEP;
5043
5044 /* perl compiled with -DPERL_RELOCATABLE_INCPUSH will ignore the len
5045 * argument to incpush_use_sep. This allows creation of relocatable
5046 * Perl distributions that patch the binary at install time. Those
5047 * distributions will have to provide their own relocation tools; this
5048 * is not a feature otherwise supported by core Perl.
5049 */
5050#ifndef PERL_RELOCATABLE_INCPUSH
5051 if (!len)
5052#endif
5053 len = strlen(p);
5054
5055 end = p + len;
5056
5057 /* Break at all separators */
5058 while ((s = (const char*)memchr(p, PERLLIB_SEP, end - p))) {
5059 if (s == p) {
5060 /* skip any consecutive separators */
5061
5062 /* Uncomment the next line for PATH semantics */
5063 /* But you'll need to write tests */
5064 /* av_push(GvAVn(PL_incgv), newSVpvs(".")); */
5065 } else {
5066 incpush(p, (STRLEN)(s - p), flags);
5067 }
5068 p = s + 1;
5069 }
5070 if (p != end)
5071 incpush(p, (STRLEN)(end - p), flags);
5072
5073}
5074
5075void
5076Perl_call_list(pTHX_ I32 oldscope, AV *paramList)
5077{
5078 SV *atsv;
5079 volatile const line_t oldline = PL_curcop ? CopLINE(PL_curcop) : 0;
5080 CV *cv;
5081 STRLEN len;
5082 int ret;
5083 dJMPENV;
5084
5085 PERL_ARGS_ASSERT_CALL_LIST;
5086
5087 while (av_count(paramList) > 0) {
5088 cv = MUTABLE_CV(av_shift(paramList));
5089 if (PL_savebegin) {
5090 if (paramList == PL_beginav) {
5091 /* save PL_beginav for compiler */
5092 Perl_av_create_and_push(aTHX_ &PL_beginav_save, MUTABLE_SV(cv));
5093 }
5094 else if (paramList == PL_checkav) {
5095 /* save PL_checkav for compiler */
5096 Perl_av_create_and_push(aTHX_ &PL_checkav_save, MUTABLE_SV(cv));
5097 }
5098 else if (paramList == PL_unitcheckav) {
5099 /* save PL_unitcheckav for compiler */
5100 Perl_av_create_and_push(aTHX_ &PL_unitcheckav_save, MUTABLE_SV(cv));
5101 }
5102 } else {
5103 SAVEFREESV(cv);
5104 }
5105 JMPENV_PUSH(ret);
5106 switch (ret) {
5107 case 0:
5108 CALL_LIST_BODY(cv);
5109 atsv = ERRSV;
5110 (void)SvPV_const(atsv, len);
5111 if (len) {
5112 PL_curcop = &PL_compiling;
5113 CopLINE_set(PL_curcop, oldline);
5114 if (paramList == PL_beginav)
5115 sv_catpvs(atsv, "BEGIN failed--compilation aborted");
5116 else
5117 Perl_sv_catpvf(aTHX_ atsv,
5118 "%s failed--call queue aborted",
5119 paramList == PL_checkav ? "CHECK"
5120 : paramList == PL_initav ? "INIT"
5121 : paramList == PL_unitcheckav ? "UNITCHECK"
5122 : "END");
5123 while (PL_scopestack_ix > oldscope)
5124 LEAVE;
5125 JMPENV_POP;
5126 Perl_croak(aTHX_ "%" SVf, SVfARG(atsv));
5127 }
5128 break;
5129 case 1:
5130 STATUS_ALL_FAILURE;
5131 /* FALLTHROUGH */
5132 case 2:
5133 /* my_exit() was called */
5134 while (PL_scopestack_ix > oldscope)
5135 LEAVE;
5136 FREETMPS;
5137 SET_CURSTASH(PL_defstash);
5138 PL_curcop = &PL_compiling;
5139 CopLINE_set(PL_curcop, oldline);
5140 JMPENV_POP;
5141 my_exit_jump();
5142 NOT_REACHED; /* NOTREACHED */
5143 case 3:
5144 if (PL_restartop) {
5145 PL_curcop = &PL_compiling;
5146 CopLINE_set(PL_curcop, oldline);
5147 JMPENV_JUMP(3);
5148 }
5149 PerlIO_printf(Perl_error_log, "panic: restartop in call_list\n");
5150 FREETMPS;
5151 break;
5152 }
5153 JMPENV_POP;
5154 }
5155}
5156
5157/*
5158=for apidoc my_exit
5159
5160A wrapper for the C library L<exit(3)>, honoring what L<perlapi/PL_exit_flags>
5161say to do.
5162
5163=cut
5164*/
5165
5166void
5167Perl_my_exit(pTHX_ U32 status)
5168{
5169 if (PL_exit_flags & PERL_EXIT_ABORT) {
5170 abort();
5171 }
5172 if (PL_exit_flags & PERL_EXIT_WARN) {
5173 PL_exit_flags |= PERL_EXIT_ABORT; /* Protect against reentrant calls */
5174 Perl_warn(aTHX_ "Unexpected exit %lu", (unsigned long)status);
5175 PL_exit_flags &= ~PERL_EXIT_ABORT;
5176 }
5177 switch (status) {
5178 case 0:
5179 STATUS_ALL_SUCCESS;
5180 break;
5181 case 1:
5182 STATUS_ALL_FAILURE;
5183 break;
5184 default:
5185 STATUS_EXIT_SET(status);
5186 break;
5187 }
5188 my_exit_jump();
5189}
5190
5191void
5192Perl_my_failure_exit(pTHX)
5193{
5194#ifdef VMS
5195 /* We have been called to fall on our sword. The desired exit code
5196 * should be already set in STATUS_UNIX, but could be shifted over
5197 * by 8 bits. STATUS_UNIX_EXIT_SET will handle the cases where a
5198 * that code is set.
5199 *
5200 * If an error code has not been set, then force the issue.
5201 */
5202 if (MY_POSIX_EXIT) {
5203
5204 /* According to the die_exit.t tests, if errno is non-zero */
5205 /* It should be used for the error status. */
5206
5207 if (errno == EVMSERR) {
5208 STATUS_NATIVE = vaxc$errno;
5209 } else {
5210
5211 /* According to die_exit.t tests, if the child_exit code is */
5212 /* also zero, then we need to exit with a code of 255 */
5213 if ((errno != 0) && (errno < 256))
5214 STATUS_UNIX_EXIT_SET(errno);
5215 else if (STATUS_UNIX < 255) {
5216 STATUS_UNIX_EXIT_SET(255);
5217 }
5218
5219 }
5220
5221 /* The exit code could have been set by $? or vmsish which
5222 * means that it may not have fatal set. So convert
5223 * success/warning codes to fatal with out changing
5224 * the POSIX status code. The severity makes VMS native
5225 * status handling work, while UNIX mode programs use the
5226 * POSIX exit codes.
5227 */
5228 if ((STATUS_NATIVE & (STS$K_SEVERE|STS$K_ERROR)) == 0) {
5229 STATUS_NATIVE &= STS$M_COND_ID;
5230 STATUS_NATIVE |= STS$K_ERROR | STS$M_INHIB_MSG;
5231 }
5232 }
5233 else {
5234 /* Traditionally Perl on VMS always expects a Fatal Error. */
5235 if (vaxc$errno & 1) {
5236
5237 /* So force success status to failure */
5238 if (STATUS_NATIVE & 1)
5239 STATUS_ALL_FAILURE;
5240 }
5241 else {
5242 if (!vaxc$errno) {
5243 STATUS_UNIX = EINTR; /* In case something cares */
5244 STATUS_ALL_FAILURE;
5245 }
5246 else {
5247 int severity;
5248 STATUS_NATIVE = vaxc$errno; /* Should already be this */
5249
5250 /* Encode the severity code */
5251 severity = STATUS_NATIVE & STS$M_SEVERITY;
5252 STATUS_UNIX = (severity ? severity : 1) << 8;
5253
5254 /* Perl expects this to be a fatal error */
5255 if (severity != STS$K_SEVERE)
5256 STATUS_ALL_FAILURE;
5257 }
5258 }
5259 }
5260
5261#else
5262 int exitstatus;
5263 int eno = errno;
5264 if (eno & 255)
5265 STATUS_UNIX_SET(eno);
5266 else {
5267 exitstatus = STATUS_UNIX >> 8;
5268 if (exitstatus & 255)
5269 STATUS_UNIX_SET(exitstatus);
5270 else
5271 STATUS_UNIX_SET(255);
5272 }
5273#endif
5274 if (PL_exit_flags & PERL_EXIT_ABORT) {
5275 abort();
5276 }
5277 if (PL_exit_flags & PERL_EXIT_WARN) {
5278 PL_exit_flags |= PERL_EXIT_ABORT; /* Protect against reentrant calls */
5279 Perl_warn(aTHX_ "Unexpected exit failure %ld", (long)PL_statusvalue);
5280 PL_exit_flags &= ~PERL_EXIT_ABORT;
5281 }
5282 my_exit_jump();
5283}
5284
5285STATIC void
5286S_my_exit_jump(pTHX)
5287{
5288 if (PL_e_script) {
5289 SvREFCNT_dec(PL_e_script);
5290 PL_e_script = NULL;
5291 }
5292
5293 POPSTACK_TO(PL_mainstack);
5294 if (cxstack_ix >= 0) {
5295 dounwind(-1);
5296 cx_popblock(cxstack);
5297 }
5298 LEAVE_SCOPE(0);
5299
5300 JMPENV_JUMP(2);
5301}
5302
5303static I32
5304read_e_script(pTHX_ int idx, SV *buf_sv, int maxlen)
5305{
5306 const char * const p = SvPVX_const(PL_e_script);
5307 const char * const e = SvEND(PL_e_script);
5308 const char *nl = (char *) memchr(p, '\n', e - p);
5309
5310 PERL_UNUSED_ARG(idx);
5311 PERL_UNUSED_ARG(maxlen);
5312
5313 nl = (nl) ? nl+1 : e;
5314 if (nl-p == 0) {
5315 filter_del(read_e_script);
5316 return 0;
5317 }
5318 sv_catpvn(buf_sv, p, nl-p);
5319 sv_chop(PL_e_script, nl);
5320 return 1;
5321}
5322
5323/* removes boilerplate code at the end of each boot_Module xsub */
5324void
5325Perl_xs_boot_epilog(pTHX_ const I32 ax)
5326{
5327 if (PL_unitcheckav)
5328 call_list(PL_scopestack_ix, PL_unitcheckav);
5329 XSRETURN_YES;
5330}
5331
5332/*
5333 * ex: set ts=8 sts=4 sw=4 et:
5334 */