This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Clean up unused 'popt' variable in perl.c
[perl5.git] / perl.c
1 /*    perl.c
2  *
3  *    Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4  *    2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007 by Larry Wall and others
5  *
6  *    You may distribute under the terms of either the GNU General Public
7  *    License or the Artistic License, as specified in the README file.
8  *
9  */
10
11 /*
12  * "A ship then new they built for him/of mithril and of elven glass" --Bilbo
13  */
14
15 /* This file contains the top-level functions that are used to create, use
16  * and destroy a perl interpreter, plus the functions used by XS code to
17  * call back into perl. Note that it does not contain the actual main()
18  * function of the interpreter; that can be found in perlmain.c
19  */
20
21 /* PSz 12 Nov 03
22  * 
23  * Be proud that perl(1) may proclaim:
24  *   Setuid Perl scripts are safer than C programs ...
25  * Do not abandon (deprecate) suidperl. Do not advocate C wrappers.
26  * 
27  * The flow was: perl starts, notices script is suid, execs suidperl with same
28  * arguments; suidperl opens script, checks many things, sets itself with
29  * right UID, execs perl with similar arguments but with script pre-opened on
30  * /dev/fd/xxx; perl checks script is as should be and does work. This was
31  * insecure: see perlsec(1) for many problems with this approach.
32  * 
33  * The "correct" flow should be: perl starts, opens script and notices it is
34  * suid, checks many things, execs suidperl with similar arguments but with
35  * script on /dev/fd/xxx; suidperl checks script and /dev/fd/xxx object are
36  * same, checks arguments match #! line, sets itself with right UID, execs
37  * perl with same arguments; perl checks many things and does work.
38  * 
39  * (Opening the script in perl instead of suidperl, we "lose" scripts that
40  * are readable to the target UID but not to the invoker. Where did
41  * unreadable scripts work anyway?)
42  * 
43  * For now, suidperl and perl are pretty much the same large and cumbersome
44  * program, so suidperl can check its argument list (see comments elsewhere).
45  * 
46  * References:
47  * Original bug report:
48  *   http://bugs.perl.org/index.html?req=bug_id&bug_id=20010322.218
49  *   http://rt.perl.org/rt2/Ticket/Display.html?id=6511
50  * Comments and discussion with Debian:
51  *   http://bugs.debian.org/203426
52  *   http://bugs.debian.org/220486
53  * Debian Security Advisory DSA 431-1 (does not fully fix problem):
54  *   http://www.debian.org/security/2004/dsa-431
55  * CVE candidate:
56  *   http://cve.mitre.org/cgi-bin/cvename.cgi?name=CAN-2003-0618
57  * Previous versions of this patch sent to perl5-porters:
58  *   http://www.mail-archive.com/perl5-porters@perl.org/msg71953.html
59  *   http://www.mail-archive.com/perl5-porters@perl.org/msg75245.html
60  *   http://www.mail-archive.com/perl5-porters@perl.org/msg75563.html
61  *   http://www.mail-archive.com/perl5-porters@perl.org/msg75635.html
62  * 
63 Paul Szabo - psz@maths.usyd.edu.au  http://www.maths.usyd.edu.au:8000/u/psz/
64 School of Mathematics and Statistics  University of Sydney   2006  Australia
65  * 
66  */
67 /* PSz 13 Nov 03
68  * Use truthful, neat, specific error messages.
69  * Cannot always hide the truth; security must not depend on doing so.
70  */
71
72 /* PSz 18 Feb 04
73  * Use global(?), thread-local fdscript for easier checks.
74  * (I do not understand how we could possibly get a thread race:
75  * do not all threads go through the same initialization? Or in
76  * fact, are not threads started only after we get the script and
77  * so know what to do? Oh well, make things super-safe...)
78  */
79
80 #include "EXTERN.h"
81 #define PERL_IN_PERL_C
82 #include "perl.h"
83 #include "patchlevel.h"                 /* for local_patches */
84
85 #ifdef NETWARE
86 #include "nwutil.h"     
87 char *nw_get_sitelib(const char *pl);
88 #endif
89
90 /* XXX If this causes problems, set i_unistd=undef in the hint file.  */
91 #ifdef I_UNISTD
92 #include <unistd.h>
93 #endif
94
95 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
96 #  ifdef I_SYS_WAIT
97 #   include <sys/wait.h>
98 #  endif
99 #  ifdef I_SYSUIO
100 #    include <sys/uio.h>
101 #  endif
102
103 union control_un {
104   struct cmsghdr cm;
105   char control[CMSG_SPACE(sizeof(int))];
106 };
107
108 #endif
109
110 #ifdef __BEOS__
111 #  define HZ 1000000
112 #endif
113
114 #ifndef HZ
115 #  ifdef CLK_TCK
116 #    define HZ CLK_TCK
117 #  else
118 #    define HZ 60
119 #  endif
120 #endif
121
122 #if !defined(STANDARD_C) && !defined(HAS_GETENV_PROTOTYPE) && !defined(PERL_MICRO)
123 char *getenv (char *); /* Usually in <stdlib.h> */
124 #endif
125
126 static I32 read_e_script(pTHX_ int idx, SV *buf_sv, int maxlen);
127
128 #ifdef DOSUID
129 #  ifdef IAMSUID
130 /* Drop scriptname */
131 #    define validate_suid(validarg, scriptname, fdscript, suidscript, linestr_sv, rsfp) S_validate_suid(aTHX_ validarg, fdscript, suidscript, linestr_sv, rsfp)
132 #  else
133 /* Drop suidscript */
134 #    define validate_suid(validarg, scriptname, fdscript, suidscript, linestr_sv, rsfp) S_validate_suid(aTHX_ validarg, scriptname, fdscript, linestr_sv, rsfp)
135 #  endif
136 #else
137 #  ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
138 /* Drop everything. Heck, don't even try to call it */
139 #    define validate_suid(validarg, scriptname, fdscript, suidscript, linestr_sv, rsfp) NOOP
140 #  else
141 /* Drop almost everything */
142 #    define validate_suid(validarg, scriptname, fdscript, suidscript, linestr_sv, rsfp) S_validate_suid(aTHX_ rsfp)
143 #  endif
144 #endif
145
146 #define CALL_BODY_EVAL(myop) \
147     if (PL_op == (myop)) \
148         PL_op = Perl_pp_entereval(aTHX); \
149     if (PL_op) \
150         CALLRUNOPS(aTHX);
151
152 #define CALL_BODY_SUB(myop) \
153     if (PL_op == (myop)) \
154         PL_op = Perl_pp_entersub(aTHX); \
155     if (PL_op) \
156         CALLRUNOPS(aTHX);
157
158 #define CALL_LIST_BODY(cv) \
159     PUSHMARK(PL_stack_sp); \
160     call_sv((SV*)(cv), G_EVAL|G_DISCARD);
161
162 static void
163 S_init_tls_and_interp(PerlInterpreter *my_perl)
164 {
165     dVAR;
166     if (!PL_curinterp) {                        
167         PERL_SET_INTERP(my_perl);
168 #if defined(USE_ITHREADS)
169         INIT_THREADS;
170         ALLOC_THREAD_KEY;
171         PERL_SET_THX(my_perl);
172         OP_REFCNT_INIT;
173         HINTS_REFCNT_INIT;
174         MUTEX_INIT(&PL_dollarzero_mutex);
175 #  endif
176 #ifdef PERL_IMPLICIT_CONTEXT
177         MUTEX_INIT(&PL_my_ctx_mutex);
178 #  endif
179     }
180 #if defined(USE_ITHREADS)
181     else
182 #else
183     /* This always happens for non-ithreads  */
184 #endif
185     {
186         PERL_SET_THX(my_perl);
187     }
188 }
189
190
191 /* these implement the PERL_SYS_INIT, PERL_SYS_INIT3, PERL_SYS_TERM macros */
192
193 void
194 Perl_sys_init(int* argc, char*** argv)
195 {
196     dVAR;
197
198     PERL_ARGS_ASSERT_SYS_INIT;
199
200     PERL_UNUSED_ARG(argc); /* may not be used depending on _BODY macro */
201     PERL_UNUSED_ARG(argv);
202     PERL_SYS_INIT_BODY(argc, argv);
203 }
204
205 void
206 Perl_sys_init3(int* argc, char*** argv, char*** env)
207 {
208     dVAR;
209
210     PERL_ARGS_ASSERT_SYS_INIT3;
211
212     PERL_UNUSED_ARG(argc); /* may not be used depending on _BODY macro */
213     PERL_UNUSED_ARG(argv);
214     PERL_UNUSED_ARG(env);
215     PERL_SYS_INIT3_BODY(argc, argv, env);
216 }
217
218 void
219 Perl_sys_term()
220 {
221     dVAR;
222     if (!PL_veto_cleanup) {
223         PERL_SYS_TERM_BODY();
224     }
225 }
226
227
228 #ifdef PERL_IMPLICIT_SYS
229 PerlInterpreter *
230 perl_alloc_using(struct IPerlMem* ipM, struct IPerlMem* ipMS,
231                  struct IPerlMem* ipMP, struct IPerlEnv* ipE,
232                  struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
233                  struct IPerlDir* ipD, struct IPerlSock* ipS,
234                  struct IPerlProc* ipP)
235 {
236     PerlInterpreter *my_perl;
237
238     PERL_ARGS_ASSERT_PERL_ALLOC_USING;
239
240     /* Newx() needs interpreter, so call malloc() instead */
241     my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
242     S_init_tls_and_interp(my_perl);
243     Zero(my_perl, 1, PerlInterpreter);
244     PL_Mem = ipM;
245     PL_MemShared = ipMS;
246     PL_MemParse = ipMP;
247     PL_Env = ipE;
248     PL_StdIO = ipStd;
249     PL_LIO = ipLIO;
250     PL_Dir = ipD;
251     PL_Sock = ipS;
252     PL_Proc = ipP;
253     INIT_TRACK_MEMPOOL(PL_memory_debug_header, my_perl);
254
255     return my_perl;
256 }
257 #else
258
259 /*
260 =head1 Embedding Functions
261
262 =for apidoc perl_alloc
263
264 Allocates a new Perl interpreter.  See L<perlembed>.
265
266 =cut
267 */
268
269 PerlInterpreter *
270 perl_alloc(void)
271 {
272     PerlInterpreter *my_perl;
273
274     /* Newx() needs interpreter, so call malloc() instead */
275     my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
276
277     S_init_tls_and_interp(my_perl);
278 #ifndef PERL_TRACK_MEMPOOL
279     return (PerlInterpreter *) ZeroD(my_perl, 1, PerlInterpreter);
280 #else
281     Zero(my_perl, 1, PerlInterpreter);
282     INIT_TRACK_MEMPOOL(PL_memory_debug_header, my_perl);
283     return my_perl;
284 #endif
285 }
286 #endif /* PERL_IMPLICIT_SYS */
287
288 /*
289 =for apidoc perl_construct
290
291 Initializes a new Perl interpreter.  See L<perlembed>.
292
293 =cut
294 */
295
296 void
297 perl_construct(pTHXx)
298 {
299     dVAR;
300
301     PERL_ARGS_ASSERT_PERL_CONSTRUCT;
302
303 #ifdef MULTIPLICITY
304     init_interp();
305     PL_perl_destruct_level = 1;
306 #else
307     PERL_UNUSED_ARG(my_perl);
308    if (PL_perl_destruct_level > 0)
309        init_interp();
310 #endif
311     PL_curcop = &PL_compiling;  /* needed by ckWARN, right away */
312
313     /* set read-only and try to insure than we wont see REFCNT==0
314        very often */
315
316     SvREADONLY_on(&PL_sv_undef);
317     SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
318
319     sv_setpv(&PL_sv_no,PL_No);
320     /* value lookup in void context - happens to have the side effect
321        of caching the numeric forms. However, as &PL_sv_no doesn't contain
322        a string that is a valid numer, we have to turn the public flags by
323        hand:  */
324     SvNV(&PL_sv_no);
325     SvIV(&PL_sv_no);
326     SvIOK_on(&PL_sv_no);
327     SvNOK_on(&PL_sv_no);
328     SvREADONLY_on(&PL_sv_no);
329     SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
330
331     sv_setpv(&PL_sv_yes,PL_Yes);
332     SvNV(&PL_sv_yes);
333     SvIV(&PL_sv_yes);
334     SvREADONLY_on(&PL_sv_yes);
335     SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
336
337     SvREADONLY_on(&PL_sv_placeholder);
338     SvREFCNT(&PL_sv_placeholder) = (~(U32)0)/2;
339
340     PL_sighandlerp = (Sighandler_t) Perl_sighandler;
341 #ifdef PERL_USES_PL_PIDSTATUS
342     PL_pidstatus = newHV();
343 #endif
344
345     PL_rs = newSVpvs("\n");
346
347     init_stacks();
348
349     init_ids();
350
351     JMPENV_BOOTSTRAP;
352     STATUS_ALL_SUCCESS;
353
354     init_i18nl10n(1);
355     SET_NUMERIC_STANDARD();
356
357 #if defined(LOCAL_PATCH_COUNT)
358     PL_localpatches = local_patches;    /* For possible -v */
359 #endif
360
361 #ifdef HAVE_INTERP_INTERN
362     sys_intern_init();
363 #endif
364
365     PerlIO_init(aTHX);                  /* Hook to IO system */
366
367     PL_fdpid = newAV();                 /* for remembering popen pids by fd */
368     PL_modglobal = newHV();             /* pointers to per-interpreter module globals */
369     PL_errors = newSVpvs("");
370     sv_setpvn(PERL_DEBUG_PAD(0), "", 0);        /* For regex debugging. */
371     sv_setpvn(PERL_DEBUG_PAD(1), "", 0);        /* ext/re needs these */
372     sv_setpvn(PERL_DEBUG_PAD(2), "", 0);        /* even without DEBUGGING. */
373 #ifdef USE_ITHREADS
374     /* First entry is a list of empty elements. It needs to be initialised
375        else all hell breaks loose in S_find_uninit_var().  */
376     Perl_av_create_and_push(aTHX_ &PL_regex_padav, newSVpvs(""));
377     PL_regex_pad = AvARRAY(PL_regex_padav);
378 #endif
379 #ifdef USE_REENTRANT_API
380     Perl_reentrant_init(aTHX);
381 #endif
382
383     /* Note that strtab is a rather special HV.  Assumptions are made
384        about not iterating on it, and not adding tie magic to it.
385        It is properly deallocated in perl_destruct() */
386     PL_strtab = newHV();
387
388     HvSHAREKEYS_off(PL_strtab);                 /* mandatory */
389     hv_ksplit(PL_strtab, 512);
390
391 #if defined(__DYNAMIC__) && (defined(NeXT) || defined(__NeXT__))
392     _dyld_lookup_and_bind
393         ("__environ", (unsigned long *) &environ_pointer, NULL);
394 #endif /* environ */
395
396 #ifndef PERL_MICRO
397 #   ifdef  USE_ENVIRON_ARRAY
398     PL_origenviron = environ;
399 #   endif
400 #endif
401
402     /* Use sysconf(_SC_CLK_TCK) if available, if not
403      * available or if the sysconf() fails, use the HZ.
404      * BeOS has those, but returns the wrong value.
405      * The HZ if not originally defined has been by now
406      * been defined as CLK_TCK, if available. */
407 #if defined(HAS_SYSCONF) && defined(_SC_CLK_TCK) && !defined(__BEOS__)
408     PL_clocktick = sysconf(_SC_CLK_TCK);
409     if (PL_clocktick <= 0)
410 #endif
411          PL_clocktick = HZ;
412
413     PL_stashcache = newHV();
414
415     PL_patchlevel = Perl_newSVpvf(aTHX_ "v%d.%d.%d", (int)PERL_REVISION,
416                                   (int)PERL_VERSION, (int)PERL_SUBVERSION);
417
418 #ifdef HAS_MMAP
419     if (!PL_mmap_page_size) {
420 #if defined(HAS_SYSCONF) && (defined(_SC_PAGESIZE) || defined(_SC_MMAP_PAGE_SIZE))
421       {
422         SETERRNO(0, SS_NORMAL);
423 #   ifdef _SC_PAGESIZE
424         PL_mmap_page_size = sysconf(_SC_PAGESIZE);
425 #   else
426         PL_mmap_page_size = sysconf(_SC_MMAP_PAGE_SIZE);
427 #   endif
428         if ((long) PL_mmap_page_size < 0) {
429           if (errno) {
430             SV * const error = ERRSV;
431             SvUPGRADE(error, SVt_PV);
432             Perl_croak(aTHX_ "panic: sysconf: %s", SvPV_nolen_const(error));
433           }
434           else
435             Perl_croak(aTHX_ "panic: sysconf: pagesize unknown");
436         }
437       }
438 #else
439 #   ifdef HAS_GETPAGESIZE
440       PL_mmap_page_size = getpagesize();
441 #   else
442 #       if defined(I_SYS_PARAM) && defined(PAGESIZE)
443       PL_mmap_page_size = PAGESIZE;       /* compiletime, bad */
444 #       endif
445 #   endif
446 #endif
447       if (PL_mmap_page_size <= 0)
448         Perl_croak(aTHX_ "panic: bad pagesize %" IVdf,
449                    (IV) PL_mmap_page_size);
450     }
451 #endif /* HAS_MMAP */
452
453 #if defined(HAS_TIMES) && defined(PERL_NEED_TIMESBASE)
454     PL_timesbase.tms_utime  = 0;
455     PL_timesbase.tms_stime  = 0;
456     PL_timesbase.tms_cutime = 0;
457     PL_timesbase.tms_cstime = 0;
458 #endif
459
460     ENTER;
461 }
462
463 /*
464 =for apidoc nothreadhook
465
466 Stub that provides thread hook for perl_destruct when there are
467 no threads.
468
469 =cut
470 */
471
472 int
473 Perl_nothreadhook(pTHX)
474 {
475     PERL_UNUSED_CONTEXT;
476     return 0;
477 }
478
479 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
480 void
481 Perl_dump_sv_child(pTHX_ SV *sv)
482 {
483     ssize_t got;
484     const int sock = PL_dumper_fd;
485     const int debug_fd = PerlIO_fileno(Perl_debug_log);
486     union control_un control;
487     struct msghdr msg;
488     struct iovec vec[2];
489     struct cmsghdr *cmptr;
490     int returned_errno;
491     unsigned char buffer[256];
492
493     PERL_ARGS_ASSERT_DUMP_SV_CHILD;
494
495     if(sock == -1 || debug_fd == -1)
496         return;
497
498     PerlIO_flush(Perl_debug_log);
499
500     /* All these shenanigans are to pass a file descriptor over to our child for
501        it to dump out to.  We can't let it hold open the file descriptor when it
502        forks, as the file descriptor it will dump to can turn out to be one end
503        of pipe that some other process will wait on for EOF. (So as it would
504        be open, the wait would be forever.)  */
505
506     msg.msg_control = control.control;
507     msg.msg_controllen = sizeof(control.control);
508     /* We're a connected socket so we don't need a destination  */
509     msg.msg_name = NULL;
510     msg.msg_namelen = 0;
511     msg.msg_iov = vec;
512     msg.msg_iovlen = 1;
513
514     cmptr = CMSG_FIRSTHDR(&msg);
515     cmptr->cmsg_len = CMSG_LEN(sizeof(int));
516     cmptr->cmsg_level = SOL_SOCKET;
517     cmptr->cmsg_type = SCM_RIGHTS;
518     *((int *)CMSG_DATA(cmptr)) = 1;
519
520     vec[0].iov_base = (void*)&sv;
521     vec[0].iov_len = sizeof(sv);
522     got = sendmsg(sock, &msg, 0);
523
524     if(got < 0) {
525         perror("Debug leaking scalars parent sendmsg failed");
526         abort();
527     }
528     if(got < sizeof(sv)) {
529         perror("Debug leaking scalars parent short sendmsg");
530         abort();
531     }
532
533     /* Return protocol is
534        int:             errno value
535        unsigned char:   length of location string (0 for empty)
536        unsigned char*:  string (not terminated)
537     */
538     vec[0].iov_base = (void*)&returned_errno;
539     vec[0].iov_len = sizeof(returned_errno);
540     vec[1].iov_base = buffer;
541     vec[1].iov_len = 1;
542
543     got = readv(sock, vec, 2);
544
545     if(got < 0) {
546         perror("Debug leaking scalars parent read failed");
547         PerlIO_flush(PerlIO_stderr());
548         abort();
549     }
550     if(got < sizeof(returned_errno) + 1) {
551         perror("Debug leaking scalars parent short read");
552         PerlIO_flush(PerlIO_stderr());
553         abort();
554     }
555
556     if (*buffer) {
557         got = read(sock, buffer + 1, *buffer);
558         if(got < 0) {
559             perror("Debug leaking scalars parent read 2 failed");
560             PerlIO_flush(PerlIO_stderr());
561             abort();
562         }
563
564         if(got < *buffer) {
565             perror("Debug leaking scalars parent short read 2");
566             PerlIO_flush(PerlIO_stderr());
567             abort();
568         }
569     }
570
571     if (returned_errno || *buffer) {
572         Perl_warn(aTHX_ "Debug leaking scalars child failed%s%.*s with errno"
573                   " %d: %s", (*buffer ? " at " : ""), (int) *buffer, buffer + 1,
574                   returned_errno, strerror(returned_errno));
575     }
576 }
577 #endif
578
579 /*
580 =for apidoc perl_destruct
581
582 Shuts down a Perl interpreter.  See L<perlembed>.
583
584 =cut
585 */
586
587 int
588 perl_destruct(pTHXx)
589 {
590     dVAR;
591     VOL signed char destruct_level;  /* see possible values in intrpvar.h */
592     HV *hv;
593 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
594     pid_t child;
595 #endif
596
597     PERL_ARGS_ASSERT_PERL_DESTRUCT;
598 #ifndef MULTIPLICITY
599     PERL_UNUSED_ARG(my_perl);
600 #endif
601
602     /* wait for all pseudo-forked children to finish */
603     PERL_WAIT_FOR_CHILDREN;
604
605     destruct_level = PL_perl_destruct_level;
606 #ifdef DEBUGGING
607     {
608         const char * const s = PerlEnv_getenv("PERL_DESTRUCT_LEVEL");
609         if (s) {
610             const int i = atoi(s);
611             if (destruct_level < i)
612                 destruct_level = i;
613         }
614     }
615 #endif
616
617     if (PL_exit_flags & PERL_EXIT_DESTRUCT_END) {
618         dJMPENV;
619         int x = 0;
620
621         JMPENV_PUSH(x);
622         PERL_UNUSED_VAR(x);
623         if (PL_endav && !PL_minus_c)
624             call_list(PL_scopestack_ix, PL_endav);
625         JMPENV_POP;
626     }
627     LEAVE;
628     FREETMPS;
629
630     /* Need to flush since END blocks can produce output */
631     my_fflush_all();
632
633     if (CALL_FPTR(PL_threadhook)(aTHX)) {
634         /* Threads hook has vetoed further cleanup */
635         PL_veto_cleanup = TRUE;
636         return STATUS_EXIT;
637     }
638
639 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
640     if (destruct_level != 0) {
641         /* Fork here to create a child. Our child's job is to preserve the
642            state of scalars prior to destruction, so that we can instruct it
643            to dump any scalars that we later find have leaked.
644            There's no subtlety in this code - it assumes POSIX, and it doesn't
645            fail gracefully  */
646         int fd[2];
647
648         if(socketpair(AF_UNIX, SOCK_STREAM, 0, fd)) {
649             perror("Debug leaking scalars socketpair failed");
650             abort();
651         }
652
653         child = fork();
654         if(child == -1) {
655             perror("Debug leaking scalars fork failed");
656             abort();
657         }
658         if (!child) {
659             /* We are the child */
660             const int sock = fd[1];
661             const int debug_fd = PerlIO_fileno(Perl_debug_log);
662             int f;
663             const char *where;
664             /* Our success message is an integer 0, and a char 0  */
665             static const char success[sizeof(int) + 1];
666
667             close(fd[0]);
668
669             /* We need to close all other file descriptors otherwise we end up
670                with interesting hangs, where the parent closes its end of a
671                pipe, and sits waiting for (another) child to terminate. Only
672                that child never terminates, because it never gets EOF, because
673                we also have the far end of the pipe open.  We even need to
674                close the debugging fd, because sometimes it happens to be one
675                end of a pipe, and a process is waiting on the other end for
676                EOF. Normally it would be closed at some point earlier in
677                destruction, but if we happen to cause the pipe to remain open,
678                EOF never occurs, and we get an infinite hang. Hence all the
679                games to pass in a file descriptor if it's actually needed.  */
680
681             f = sysconf(_SC_OPEN_MAX);
682             if(f < 0) {
683                 where = "sysconf failed";
684                 goto abort;
685             }
686             while (f--) {
687                 if (f == sock)
688                     continue;
689                 close(f);
690             }
691
692             while (1) {
693                 SV *target;
694                 union control_un control;
695                 struct msghdr msg;
696                 struct iovec vec[1];
697                 struct cmsghdr *cmptr;
698                 ssize_t got;
699                 int got_fd;
700
701                 msg.msg_control = control.control;
702                 msg.msg_controllen = sizeof(control.control);
703                 /* We're a connected socket so we don't need a source  */
704                 msg.msg_name = NULL;
705                 msg.msg_namelen = 0;
706                 msg.msg_iov = vec;
707                 msg.msg_iovlen = sizeof(vec)/sizeof(vec[0]);
708
709                 vec[0].iov_base = (void*)&target;
710                 vec[0].iov_len = sizeof(target);
711       
712                 got = recvmsg(sock, &msg, 0);
713
714                 if(got == 0)
715                     break;
716                 if(got < 0) {
717                     where = "recv failed";
718                     goto abort;
719                 }
720                 if(got < sizeof(target)) {
721                     where = "short recv";
722                     goto abort;
723                 }
724
725                 if(!(cmptr = CMSG_FIRSTHDR(&msg))) {
726                     where = "no cmsg";
727                     goto abort;
728                 }
729                 if(cmptr->cmsg_len != CMSG_LEN(sizeof(int))) {
730                     where = "wrong cmsg_len";
731                     goto abort;
732                 }
733                 if(cmptr->cmsg_level != SOL_SOCKET) {
734                     where = "wrong cmsg_level";
735                     goto abort;
736                 }
737                 if(cmptr->cmsg_type != SCM_RIGHTS) {
738                     where = "wrong cmsg_type";
739                     goto abort;
740                 }
741
742                 got_fd = *(int*)CMSG_DATA(cmptr);
743                 /* For our last little bit of trickery, put the file descriptor
744                    back into Perl_debug_log, as if we never actually closed it
745                 */
746                 if(got_fd != debug_fd) {
747                     if (dup2(got_fd, debug_fd) == -1) {
748                         where = "dup2";
749                         goto abort;
750                     }
751                 }
752                 sv_dump(target);
753
754                 PerlIO_flush(Perl_debug_log);
755
756                 got = write(sock, &success, sizeof(success));
757
758                 if(got < 0) {
759                     where = "write failed";
760                     goto abort;
761                 }
762                 if(got < sizeof(success)) {
763                     where = "short write";
764                     goto abort;
765                 }
766             }
767             _exit(0);
768         abort:
769             {
770                 int send_errno = errno;
771                 unsigned char length = (unsigned char) strlen(where);
772                 struct iovec failure[3] = {
773                     {(void*)&send_errno, sizeof(send_errno)},
774                     {&length, 1},
775                     {(void*)where, length}
776                 };
777                 int got = writev(sock, failure, 3);
778                 /* Bad news travels fast. Faster than data. We'll get a SIGPIPE
779                    in the parent if we try to read from the socketpair after the
780                    child has exited, even if there was data to read.
781                    So sleep a bit to give the parent a fighting chance of
782                    reading the data.  */
783                 sleep(2);
784                 _exit((got == -1) ? errno : 0);
785             }
786             /* End of child.  */
787         }
788         PL_dumper_fd = fd[0];
789         close(fd[1]);
790     }
791 #endif
792     
793     /* We must account for everything.  */
794
795     /* Destroy the main CV and syntax tree */
796     /* Do this now, because destroying ops can cause new SVs to be generated
797        in Perl_pad_swipe, and when running with -DDEBUG_LEAKING_SCALARS they
798        PL_curcop to point to a valid op from which the filename structure
799        member is copied.  */
800     PL_curcop = &PL_compiling;
801     if (PL_main_root) {
802         /* ensure comppad/curpad to refer to main's pad */
803         if (CvPADLIST(PL_main_cv)) {
804             PAD_SET_CUR_NOSAVE(CvPADLIST(PL_main_cv), 1);
805         }
806         op_free(PL_main_root);
807         PL_main_root = NULL;
808     }
809     PL_main_start = NULL;
810     SvREFCNT_dec(PL_main_cv);
811     PL_main_cv = NULL;
812     PL_dirty = TRUE;
813
814     /* Tell PerlIO we are about to tear things apart in case
815        we have layers which are using resources that should
816        be cleaned up now.
817      */
818
819     PerlIO_destruct(aTHX);
820
821     if (PL_sv_objcount) {
822         /*
823          * Try to destruct global references.  We do this first so that the
824          * destructors and destructees still exist.  Some sv's might remain.
825          * Non-referenced objects are on their own.
826          */
827         sv_clean_objs();
828         PL_sv_objcount = 0;
829         if (PL_defoutgv && !SvREFCNT(PL_defoutgv))
830             PL_defoutgv = NULL; /* may have been freed */
831     }
832
833     /* unhook hooks which will soon be, or use, destroyed data */
834     SvREFCNT_dec(PL_warnhook);
835     PL_warnhook = NULL;
836     SvREFCNT_dec(PL_diehook);
837     PL_diehook = NULL;
838
839     /* call exit list functions */
840     while (PL_exitlistlen-- > 0)
841         PL_exitlist[PL_exitlistlen].fn(aTHX_ PL_exitlist[PL_exitlistlen].ptr);
842
843     Safefree(PL_exitlist);
844
845     PL_exitlist = NULL;
846     PL_exitlistlen = 0;
847
848     /* jettison our possibly duplicated environment */
849     /* if PERL_USE_SAFE_PUTENV is defined environ will not have been copied
850      * so we certainly shouldn't free it here
851      */
852 #ifndef PERL_MICRO
853 #if defined(USE_ENVIRON_ARRAY) && !defined(PERL_USE_SAFE_PUTENV)
854     if (environ != PL_origenviron && !PL_use_safe_putenv
855 #ifdef USE_ITHREADS
856         /* only main thread can free environ[0] contents */
857         && PL_curinterp == aTHX
858 #endif
859         )
860     {
861         I32 i;
862
863         for (i = 0; environ[i]; i++)
864             safesysfree(environ[i]);
865
866         /* Must use safesysfree() when working with environ. */
867         safesysfree(environ);           
868
869         environ = PL_origenviron;
870     }
871 #endif
872 #endif /* !PERL_MICRO */
873
874     if (destruct_level == 0) {
875
876         DEBUG_P(debprofdump());
877
878 #if defined(PERLIO_LAYERS)
879         /* No more IO - including error messages ! */
880         PerlIO_cleanup(aTHX);
881 #endif
882
883         CopFILE_free(&PL_compiling);
884         CopSTASH_free(&PL_compiling);
885
886         /* The exit() function will do everything that needs doing. */
887         return STATUS_EXIT;
888     }
889
890     /* reset so print() ends up where we expect */
891     setdefout(NULL);
892
893 #ifdef USE_ITHREADS
894     /* the syntax tree is shared between clones
895      * so op_free(PL_main_root) only ReREFCNT_dec's
896      * REGEXPs in the parent interpreter
897      * we need to manually ReREFCNT_dec for the clones
898      */
899     SvREFCNT_dec(PL_regex_padav);
900     PL_regex_padav = NULL;
901     PL_regex_pad = NULL;
902 #endif
903
904     SvREFCNT_dec((SV*) PL_stashcache);
905     PL_stashcache = NULL;
906
907     /* loosen bonds of global variables */
908
909     /* XXX can PL_parser still be non-null here? */
910     if(PL_parser && PL_parser->rsfp) {
911         (void)PerlIO_close(PL_parser->rsfp);
912         PL_parser->rsfp = NULL;
913     }
914
915     if (PL_minus_F) {
916         Safefree(PL_splitstr);
917         PL_splitstr = NULL;
918     }
919
920     /* switches */
921     PL_minus_n      = FALSE;
922     PL_minus_p      = FALSE;
923     PL_minus_l      = FALSE;
924     PL_minus_a      = FALSE;
925     PL_minus_F      = FALSE;
926     PL_doswitches   = FALSE;
927     PL_dowarn       = G_WARN_OFF;
928     PL_doextract    = FALSE;
929     PL_sawampersand = FALSE;    /* must save all match strings */
930     PL_unsafe       = FALSE;
931
932     Safefree(PL_inplace);
933     PL_inplace = NULL;
934     SvREFCNT_dec(PL_patchlevel);
935
936     if (PL_e_script) {
937         SvREFCNT_dec(PL_e_script);
938         PL_e_script = NULL;
939     }
940
941     PL_perldb = 0;
942
943     /* magical thingies */
944
945     SvREFCNT_dec(PL_ofs_sv);    /* $, */
946     PL_ofs_sv = NULL;
947
948     SvREFCNT_dec(PL_ors_sv);    /* $\ */
949     PL_ors_sv = NULL;
950
951     SvREFCNT_dec(PL_rs);        /* $/ */
952     PL_rs = NULL;
953
954     Safefree(PL_osname);        /* $^O */
955     PL_osname = NULL;
956
957     SvREFCNT_dec(PL_statname);
958     PL_statname = NULL;
959     PL_statgv = NULL;
960
961     /* defgv, aka *_ should be taken care of elsewhere */
962
963     /* clean up after study() */
964     SvREFCNT_dec(PL_lastscream);
965     PL_lastscream = NULL;
966     Safefree(PL_screamfirst);
967     PL_screamfirst = 0;
968     Safefree(PL_screamnext);
969     PL_screamnext  = 0;
970
971     /* float buffer */
972     Safefree(PL_efloatbuf);
973     PL_efloatbuf = NULL;
974     PL_efloatsize = 0;
975
976     /* startup and shutdown function lists */
977     SvREFCNT_dec(PL_beginav);
978     SvREFCNT_dec(PL_beginav_save);
979     SvREFCNT_dec(PL_endav);
980     SvREFCNT_dec(PL_checkav);
981     SvREFCNT_dec(PL_checkav_save);
982     SvREFCNT_dec(PL_unitcheckav);
983     SvREFCNT_dec(PL_unitcheckav_save);
984     SvREFCNT_dec(PL_initav);
985     PL_beginav = NULL;
986     PL_beginav_save = NULL;
987     PL_endav = NULL;
988     PL_checkav = NULL;
989     PL_checkav_save = NULL;
990     PL_unitcheckav = NULL;
991     PL_unitcheckav_save = NULL;
992     PL_initav = NULL;
993
994     /* shortcuts just get cleared */
995     PL_envgv = NULL;
996     PL_incgv = NULL;
997     PL_hintgv = NULL;
998     PL_errgv = NULL;
999     PL_argvgv = NULL;
1000     PL_argvoutgv = NULL;
1001     PL_stdingv = NULL;
1002     PL_stderrgv = NULL;
1003     PL_last_in_gv = NULL;
1004     PL_replgv = NULL;
1005     PL_DBgv = NULL;
1006     PL_DBline = NULL;
1007     PL_DBsub = NULL;
1008     PL_DBsingle = NULL;
1009     PL_DBtrace = NULL;
1010     PL_DBsignal = NULL;
1011     PL_DBcv = NULL;
1012     PL_dbargs = NULL;
1013     PL_debstash = NULL;
1014
1015     SvREFCNT_dec(PL_argvout_stack);
1016     PL_argvout_stack = NULL;
1017
1018     SvREFCNT_dec(PL_modglobal);
1019     PL_modglobal = NULL;
1020     SvREFCNT_dec(PL_preambleav);
1021     PL_preambleav = NULL;
1022     SvREFCNT_dec(PL_subname);
1023     PL_subname = NULL;
1024 #ifdef PERL_USES_PL_PIDSTATUS
1025     SvREFCNT_dec(PL_pidstatus);
1026     PL_pidstatus = NULL;
1027 #endif
1028     SvREFCNT_dec(PL_toptarget);
1029     PL_toptarget = NULL;
1030     SvREFCNT_dec(PL_bodytarget);
1031     PL_bodytarget = NULL;
1032     PL_formtarget = NULL;
1033
1034     /* free locale stuff */
1035 #ifdef USE_LOCALE_COLLATE
1036     Safefree(PL_collation_name);
1037     PL_collation_name = NULL;
1038 #endif
1039
1040 #ifdef USE_LOCALE_NUMERIC
1041     Safefree(PL_numeric_name);
1042     PL_numeric_name = NULL;
1043     SvREFCNT_dec(PL_numeric_radix_sv);
1044     PL_numeric_radix_sv = NULL;
1045 #endif
1046
1047     /* clear utf8 character classes */
1048     SvREFCNT_dec(PL_utf8_alnum);
1049     SvREFCNT_dec(PL_utf8_alnumc);
1050     SvREFCNT_dec(PL_utf8_ascii);
1051     SvREFCNT_dec(PL_utf8_alpha);
1052     SvREFCNT_dec(PL_utf8_space);
1053     SvREFCNT_dec(PL_utf8_cntrl);
1054     SvREFCNT_dec(PL_utf8_graph);
1055     SvREFCNT_dec(PL_utf8_digit);
1056     SvREFCNT_dec(PL_utf8_upper);
1057     SvREFCNT_dec(PL_utf8_lower);
1058     SvREFCNT_dec(PL_utf8_print);
1059     SvREFCNT_dec(PL_utf8_punct);
1060     SvREFCNT_dec(PL_utf8_xdigit);
1061     SvREFCNT_dec(PL_utf8_mark);
1062     SvREFCNT_dec(PL_utf8_toupper);
1063     SvREFCNT_dec(PL_utf8_totitle);
1064     SvREFCNT_dec(PL_utf8_tolower);
1065     SvREFCNT_dec(PL_utf8_tofold);
1066     SvREFCNT_dec(PL_utf8_idstart);
1067     SvREFCNT_dec(PL_utf8_idcont);
1068     PL_utf8_alnum       = NULL;
1069     PL_utf8_alnumc      = NULL;
1070     PL_utf8_ascii       = NULL;
1071     PL_utf8_alpha       = NULL;
1072     PL_utf8_space       = NULL;
1073     PL_utf8_cntrl       = NULL;
1074     PL_utf8_graph       = NULL;
1075     PL_utf8_digit       = NULL;
1076     PL_utf8_upper       = NULL;
1077     PL_utf8_lower       = NULL;
1078     PL_utf8_print       = NULL;
1079     PL_utf8_punct       = NULL;
1080     PL_utf8_xdigit      = NULL;
1081     PL_utf8_mark        = NULL;
1082     PL_utf8_toupper     = NULL;
1083     PL_utf8_totitle     = NULL;
1084     PL_utf8_tolower     = NULL;
1085     PL_utf8_tofold      = NULL;
1086     PL_utf8_idstart     = NULL;
1087     PL_utf8_idcont      = NULL;
1088
1089     if (!specialWARN(PL_compiling.cop_warnings))
1090         PerlMemShared_free(PL_compiling.cop_warnings);
1091     PL_compiling.cop_warnings = NULL;
1092     Perl_refcounted_he_free(aTHX_ PL_compiling.cop_hints_hash);
1093     PL_compiling.cop_hints_hash = NULL;
1094     CopFILE_free(&PL_compiling);
1095     CopSTASH_free(&PL_compiling);
1096
1097     /* Prepare to destruct main symbol table.  */
1098
1099     hv = PL_defstash;
1100     PL_defstash = 0;
1101     SvREFCNT_dec(hv);
1102     SvREFCNT_dec(PL_curstname);
1103     PL_curstname = NULL;
1104
1105     /* clear queued errors */
1106     SvREFCNT_dec(PL_errors);
1107     PL_errors = NULL;
1108
1109     SvREFCNT_dec(PL_isarev);
1110
1111     FREETMPS;
1112     if (destruct_level >= 2 && ckWARN_d(WARN_INTERNAL)) {
1113         if (PL_scopestack_ix != 0)
1114             Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
1115                  "Unbalanced scopes: %ld more ENTERs than LEAVEs\n",
1116                  (long)PL_scopestack_ix);
1117         if (PL_savestack_ix != 0)
1118             Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
1119                  "Unbalanced saves: %ld more saves than restores\n",
1120                  (long)PL_savestack_ix);
1121         if (PL_tmps_floor != -1)
1122             Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced tmps: %ld more allocs than frees\n",
1123                  (long)PL_tmps_floor + 1);
1124         if (cxstack_ix != -1)
1125             Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Unbalanced context: %ld more PUSHes than POPs\n",
1126                  (long)cxstack_ix + 1);
1127     }
1128
1129     /* Now absolutely destruct everything, somehow or other, loops or no. */
1130
1131     /* the 2 is for PL_fdpid and PL_strtab */
1132     while (sv_clean_all() > 2)
1133         ;
1134
1135     AvREAL_off(PL_fdpid);               /* no surviving entries */
1136     SvREFCNT_dec(PL_fdpid);             /* needed in io_close() */
1137     PL_fdpid = NULL;
1138
1139 #ifdef HAVE_INTERP_INTERN
1140     sys_intern_clear();
1141 #endif
1142
1143     /* Destruct the global string table. */
1144     {
1145         /* Yell and reset the HeVAL() slots that are still holding refcounts,
1146          * so that sv_free() won't fail on them.
1147          * Now that the global string table is using a single hunk of memory
1148          * for both HE and HEK, we either need to explicitly unshare it the
1149          * correct way, or actually free things here.
1150          */
1151         I32 riter = 0;
1152         const I32 max = HvMAX(PL_strtab);
1153         HE * const * const array = HvARRAY(PL_strtab);
1154         HE *hent = array[0];
1155
1156         for (;;) {
1157             if (hent && ckWARN_d(WARN_INTERNAL)) {
1158                 HE * const next = HeNEXT(hent);
1159                 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
1160                      "Unbalanced string table refcount: (%ld) for \"%s\"",
1161                      (long)hent->he_valu.hent_refcount, HeKEY(hent));
1162                 Safefree(hent);
1163                 hent = next;
1164             }
1165             if (!hent) {
1166                 if (++riter > max)
1167                     break;
1168                 hent = array[riter];
1169             }
1170         }
1171
1172         Safefree(array);
1173         HvARRAY(PL_strtab) = 0;
1174         HvTOTALKEYS(PL_strtab) = 0;
1175         HvFILL(PL_strtab) = 0;
1176     }
1177     SvREFCNT_dec(PL_strtab);
1178
1179 #ifdef USE_ITHREADS
1180     /* free the pointer tables used for cloning */
1181     ptr_table_free(PL_ptr_table);
1182     PL_ptr_table = (PTR_TBL_t*)NULL;
1183 #endif
1184
1185     /* free special SVs */
1186
1187     SvREFCNT(&PL_sv_yes) = 0;
1188     sv_clear(&PL_sv_yes);
1189     SvANY(&PL_sv_yes) = NULL;
1190     SvFLAGS(&PL_sv_yes) = 0;
1191
1192     SvREFCNT(&PL_sv_no) = 0;
1193     sv_clear(&PL_sv_no);
1194     SvANY(&PL_sv_no) = NULL;
1195     SvFLAGS(&PL_sv_no) = 0;
1196
1197     {
1198         int i;
1199         for (i=0; i<=2; i++) {
1200             SvREFCNT(PERL_DEBUG_PAD(i)) = 0;
1201             sv_clear(PERL_DEBUG_PAD(i));
1202             SvANY(PERL_DEBUG_PAD(i)) = NULL;
1203             SvFLAGS(PERL_DEBUG_PAD(i)) = 0;
1204         }
1205     }
1206
1207     if (PL_sv_count != 0 && ckWARN_d(WARN_INTERNAL))
1208         Perl_warner(aTHX_ packWARN(WARN_INTERNAL),"Scalars leaked: %ld\n", (long)PL_sv_count);
1209
1210 #ifdef DEBUG_LEAKING_SCALARS
1211     if (PL_sv_count != 0) {
1212         SV* sva;
1213         SV* sv;
1214         register SV* svend;
1215
1216         for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
1217             svend = &sva[SvREFCNT(sva)];
1218             for (sv = sva + 1; sv < svend; ++sv) {
1219                 if (SvTYPE(sv) != SVTYPEMASK) {
1220                     PerlIO_printf(Perl_debug_log, "leaked: sv=0x%p"
1221                         " flags=0x%"UVxf
1222                         " refcnt=%"UVuf pTHX__FORMAT "\n"
1223                         "\tallocated at %s:%d %s %s%s\n",
1224                         (void*)sv, (UV)sv->sv_flags, (UV)sv->sv_refcnt
1225                         pTHX__VALUE,
1226                         sv->sv_debug_file ? sv->sv_debug_file : "(unknown)",
1227                         sv->sv_debug_line,
1228                         sv->sv_debug_inpad ? "for" : "by",
1229                         sv->sv_debug_optype ?
1230                             PL_op_name[sv->sv_debug_optype]: "(none)",
1231                         sv->sv_debug_cloned ? " (cloned)" : ""
1232                     );
1233 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1234                     Perl_dump_sv_child(aTHX_ sv);
1235 #endif
1236                 }
1237             }
1238         }
1239     }
1240 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1241     {
1242         int status;
1243         fd_set rset;
1244         /* Wait for up to 4 seconds for child to terminate.
1245            This seems to be the least effort way of timing out on reaping
1246            its exit status.  */
1247         struct timeval waitfor = {4, 0};
1248         int sock = PL_dumper_fd;
1249
1250         shutdown(sock, 1);
1251         FD_ZERO(&rset);
1252         FD_SET(sock, &rset);
1253         select(sock + 1, &rset, NULL, NULL, &waitfor);
1254         waitpid(child, &status, WNOHANG);
1255         close(sock);
1256     }
1257 #endif
1258 #endif
1259 #ifdef DEBUG_LEAKING_SCALARS_ABORT
1260     if (PL_sv_count)
1261         abort();
1262 #endif
1263     PL_sv_count = 0;
1264
1265 #ifdef PERL_DEBUG_READONLY_OPS
1266     free(PL_slabs);
1267     PL_slabs = NULL;
1268     PL_slab_count = 0;
1269 #endif
1270
1271 #if defined(PERLIO_LAYERS)
1272     /* No more IO - including error messages ! */
1273     PerlIO_cleanup(aTHX);
1274 #endif
1275
1276     /* sv_undef needs to stay immortal until after PerlIO_cleanup
1277        as currently layers use it rather than NULL as a marker
1278        for no arg - and will try and SvREFCNT_dec it.
1279      */
1280     SvREFCNT(&PL_sv_undef) = 0;
1281     SvREADONLY_off(&PL_sv_undef);
1282
1283     Safefree(PL_origfilename);
1284     PL_origfilename = NULL;
1285     Safefree(PL_reg_start_tmp);
1286     PL_reg_start_tmp = (char**)NULL;
1287     PL_reg_start_tmpl = 0;
1288     Safefree(PL_reg_curpm);
1289     Safefree(PL_reg_poscache);
1290     free_tied_hv_pool();
1291     Safefree(PL_op_mask);
1292     Safefree(PL_psig_ptr);
1293     PL_psig_ptr = (SV**)NULL;
1294     Safefree(PL_psig_name);
1295     PL_psig_name = (SV**)NULL;
1296     Safefree(PL_bitcount);
1297     PL_bitcount = NULL;
1298     Safefree(PL_psig_pend);
1299     PL_psig_pend = (int*)NULL;
1300     PL_formfeed = NULL;
1301     nuke_stacks();
1302     PL_tainting = FALSE;
1303     PL_taint_warn = FALSE;
1304     PL_hints = 0;               /* Reset hints. Should hints be per-interpreter ? */
1305     PL_debug = 0;
1306
1307     DEBUG_P(debprofdump());
1308
1309 #ifdef USE_REENTRANT_API
1310     Perl_reentrant_free(aTHX);
1311 #endif
1312
1313     sv_free_arenas();
1314
1315     while (PL_regmatch_slab) {
1316         regmatch_slab  *s = PL_regmatch_slab;
1317         PL_regmatch_slab = PL_regmatch_slab->next;
1318         Safefree(s);
1319     }
1320
1321     /* As the absolutely last thing, free the non-arena SV for mess() */
1322
1323     if (PL_mess_sv) {
1324         /* we know that type == SVt_PVMG */
1325
1326         /* it could have accumulated taint magic */
1327         MAGIC* mg;
1328         MAGIC* moremagic;
1329         for (mg = SvMAGIC(PL_mess_sv); mg; mg = moremagic) {
1330             moremagic = mg->mg_moremagic;
1331             if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global
1332                 && mg->mg_len >= 0)
1333                 Safefree(mg->mg_ptr);
1334             Safefree(mg);
1335         }
1336
1337         /* we know that type >= SVt_PV */
1338         SvPV_free(PL_mess_sv);
1339         Safefree(SvANY(PL_mess_sv));
1340         Safefree(PL_mess_sv);
1341         PL_mess_sv = NULL;
1342     }
1343     return STATUS_EXIT;
1344 }
1345
1346 /*
1347 =for apidoc perl_free
1348
1349 Releases a Perl interpreter.  See L<perlembed>.
1350
1351 =cut
1352 */
1353
1354 void
1355 perl_free(pTHXx)
1356 {
1357     dVAR;
1358
1359     PERL_ARGS_ASSERT_PERL_FREE;
1360
1361     if (PL_veto_cleanup)
1362         return;
1363
1364 #ifdef PERL_TRACK_MEMPOOL
1365     {
1366         /*
1367          * Don't free thread memory if PERL_DESTRUCT_LEVEL is set to a non-zero
1368          * value as we're probably hunting memory leaks then
1369          */
1370         const char * const s = PerlEnv_getenv("PERL_DESTRUCT_LEVEL");
1371         if (!s || atoi(s) == 0) {
1372             const U32 old_debug = PL_debug;
1373             /* Emulate the PerlHost behaviour of free()ing all memory allocated in this
1374                thread at thread exit.  */
1375             if (DEBUG_m_TEST) {
1376                 PerlIO_puts(Perl_debug_log, "Disabling memory debugging as we "
1377                             "free this thread's memory\n");
1378                 PL_debug &= ~ DEBUG_m_FLAG;
1379             }
1380             while(aTHXx->Imemory_debug_header.next != &(aTHXx->Imemory_debug_header))
1381                 safesysfree(sTHX + (char *)(aTHXx->Imemory_debug_header.next));
1382             PL_debug = old_debug;
1383         }
1384     }
1385 #endif
1386
1387 #if defined(WIN32) || defined(NETWARE)
1388 #  if defined(PERL_IMPLICIT_SYS)
1389     {
1390 #    ifdef NETWARE
1391         void *host = nw_internal_host;
1392 #    else
1393         void *host = w32_internal_host;
1394 #    endif
1395         PerlMem_free(aTHXx);
1396 #    ifdef NETWARE
1397         nw_delete_internal_host(host);
1398 #    else
1399         win32_delete_internal_host(host);
1400 #    endif
1401     }
1402 #  else
1403     PerlMem_free(aTHXx);
1404 #  endif
1405 #else
1406     PerlMem_free(aTHXx);
1407 #endif
1408 }
1409
1410 #if defined(USE_ITHREADS)
1411 /* provide destructors to clean up the thread key when libperl is unloaded */
1412 #ifndef WIN32 /* handled during DLL_PROCESS_DETACH in win32/perllib.c */
1413
1414 #if defined(__hpux) && !(defined(__ux_version) && __ux_version <= 1020) && !defined(__GNUC__)
1415 #pragma fini "perl_fini"
1416 #elif defined(__sun) && !defined(__GNUC__)
1417 #pragma fini (perl_fini)
1418 #endif
1419
1420 static void
1421 #if defined(__GNUC__)
1422 __attribute__((destructor))
1423 #endif
1424 perl_fini(void)
1425 {
1426     dVAR;
1427     if (PL_curinterp  && !PL_veto_cleanup)
1428         FREE_THREAD_KEY;
1429 }
1430
1431 #endif /* WIN32 */
1432 #endif /* THREADS */
1433
1434 void
1435 Perl_call_atexit(pTHX_ ATEXIT_t fn, void *ptr)
1436 {
1437     dVAR;
1438     Renew(PL_exitlist, PL_exitlistlen+1, PerlExitListEntry);
1439     PL_exitlist[PL_exitlistlen].fn = fn;
1440     PL_exitlist[PL_exitlistlen].ptr = ptr;
1441     ++PL_exitlistlen;
1442 }
1443
1444 #ifdef HAS_PROCSELFEXE
1445 /* This is a function so that we don't hold on to MAXPATHLEN
1446    bytes of stack longer than necessary
1447  */
1448 STATIC void
1449 S_procself_val(pTHX_ SV *sv, const char *arg0)
1450 {
1451     char buf[MAXPATHLEN];
1452     int len = readlink(PROCSELFEXE_PATH, buf, sizeof(buf) - 1);
1453
1454     /* On Playstation2 Linux V1.0 (kernel 2.2.1) readlink(/proc/self/exe)
1455        includes a spurious NUL which will cause $^X to fail in system
1456        or backticks (this will prevent extensions from being built and
1457        many tests from working). readlink is not meant to add a NUL.
1458        Normal readlink works fine.
1459      */
1460     if (len > 0 && buf[len-1] == '\0') {
1461       len--;
1462     }
1463
1464     /* FreeBSD's implementation is acknowledged to be imperfect, sometimes
1465        returning the text "unknown" from the readlink rather than the path
1466        to the executable (or returning an error from the readlink).  Any valid
1467        path has a '/' in it somewhere, so use that to validate the result.
1468        See http://www.freebsd.org/cgi/query-pr.cgi?pr=35703
1469     */
1470     if (len > 0 && memchr(buf, '/', len)) {
1471         sv_setpvn(sv,buf,len);
1472     }
1473     else {
1474         sv_setpv(sv,arg0);
1475     }
1476 }
1477 #endif /* HAS_PROCSELFEXE */
1478
1479 STATIC void
1480 S_set_caret_X(pTHX) {
1481     dVAR;
1482     GV* tmpgv = gv_fetchpvs("\030", GV_ADD|GV_NOTQUAL, SVt_PV); /* $^X */
1483     if (tmpgv) {
1484 #ifdef HAS_PROCSELFEXE
1485         S_procself_val(aTHX_ GvSV(tmpgv), PL_origargv[0]);
1486 #else
1487 #ifdef OS2
1488         sv_setpv(GvSVn(tmpgv), os2_execname(aTHX));
1489 #else
1490         sv_setpv(GvSVn(tmpgv),PL_origargv[0]);
1491 #endif
1492 #endif
1493     }
1494 }
1495
1496 /*
1497 =for apidoc perl_parse
1498
1499 Tells a Perl interpreter to parse a Perl script.  See L<perlembed>.
1500
1501 =cut
1502 */
1503
1504 int
1505 perl_parse(pTHXx_ XSINIT_t xsinit, int argc, char **argv, char **env)
1506 {
1507     dVAR;
1508     I32 oldscope;
1509     int ret;
1510     dJMPENV;
1511
1512     PERL_ARGS_ASSERT_PERL_PARSE;
1513 #ifndef MULTIPLICITY
1514     PERL_UNUSED_ARG(my_perl);
1515 #endif
1516
1517 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW_AND_IAMSUID
1518     Perl_croak(aTHX_ "suidperl is no longer needed since the kernel can now "
1519                "execute\nsetuid perl scripts securely.\n");
1520 #endif
1521
1522 #if defined(USE_HASH_SEED) || defined(USE_HASH_SEED_EXPLICIT)
1523     /* [perl #22371] Algorimic Complexity Attack on Perl 5.6.1, 5.8.0
1524      * This MUST be done before any hash stores or fetches take place.
1525      * If you set PL_rehash_seed (and assumedly also PL_rehash_seed_set)
1526      * yourself, it is your responsibility to provide a good random seed!
1527      * You can also define PERL_HASH_SEED in compile time, see hv.h. */
1528     if (!PL_rehash_seed_set)
1529          PL_rehash_seed = get_hash_seed();
1530     {
1531         const char * const s = PerlEnv_getenv("PERL_HASH_SEED_DEBUG");
1532
1533         if (s && (atoi(s) == 1))
1534             PerlIO_printf(Perl_debug_log, "HASH_SEED = %"UVuf"\n", PL_rehash_seed);
1535     }
1536 #endif /* #if defined(USE_HASH_SEED) || defined(USE_HASH_SEED_EXPLICIT) */
1537
1538     PL_origargc = argc;
1539     PL_origargv = argv;
1540
1541     if (PL_origalen != 0) {
1542         PL_origalen = 1; /* don't use old PL_origalen if perl_parse() is called again */
1543     }
1544     else {
1545         /* Set PL_origalen be the sum of the contiguous argv[]
1546          * elements plus the size of the env in case that it is
1547          * contiguous with the argv[].  This is used in mg.c:Perl_magic_set()
1548          * as the maximum modifiable length of $0.  In the worst case
1549          * the area we are able to modify is limited to the size of
1550          * the original argv[0].  (See below for 'contiguous', though.)
1551          * --jhi */
1552          const char *s = NULL;
1553          int i;
1554          const UV mask =
1555            ~(UV)(PTRSIZE == 4 ? 3 : PTRSIZE == 8 ? 7 : PTRSIZE == 16 ? 15 : 0);
1556          /* Do the mask check only if the args seem like aligned. */
1557          const UV aligned =
1558            (mask < ~(UV)0) && ((PTR2UV(argv[0]) & mask) == PTR2UV(argv[0]));
1559
1560          /* See if all the arguments are contiguous in memory.  Note
1561           * that 'contiguous' is a loose term because some platforms
1562           * align the argv[] and the envp[].  If the arguments look
1563           * like non-aligned, assume that they are 'strictly' or
1564           * 'traditionally' contiguous.  If the arguments look like
1565           * aligned, we just check that they are within aligned
1566           * PTRSIZE bytes.  As long as no system has something bizarre
1567           * like the argv[] interleaved with some other data, we are
1568           * fine.  (Did I just evoke Murphy's Law?)  --jhi */
1569          if (PL_origargv && PL_origargc >= 1 && (s = PL_origargv[0])) {
1570               while (*s) s++;
1571               for (i = 1; i < PL_origargc; i++) {
1572                    if ((PL_origargv[i] == s + 1
1573 #ifdef OS2
1574                         || PL_origargv[i] == s + 2
1575 #endif 
1576                             )
1577                        ||
1578                        (aligned &&
1579                         (PL_origargv[i] >  s &&
1580                          PL_origargv[i] <=
1581                          INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1582                         )
1583                    {
1584                         s = PL_origargv[i];
1585                         while (*s) s++;
1586                    }
1587                    else
1588                         break;
1589               }
1590          }
1591
1592 #ifndef PERL_USE_SAFE_PUTENV
1593          /* Can we grab env area too to be used as the area for $0? */
1594          if (s && PL_origenviron && !PL_use_safe_putenv) {
1595               if ((PL_origenviron[0] == s + 1)
1596                   ||
1597                   (aligned &&
1598                    (PL_origenviron[0] >  s &&
1599                     PL_origenviron[0] <=
1600                     INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1601                  )
1602               {
1603 #ifndef OS2             /* ENVIRON is read by the kernel too. */
1604                    s = PL_origenviron[0];
1605                    while (*s) s++;
1606 #endif
1607                    my_setenv("NoNe  SuCh", NULL);
1608                    /* Force copy of environment. */
1609                    for (i = 1; PL_origenviron[i]; i++) {
1610                         if (PL_origenviron[i] == s + 1
1611                             ||
1612                             (aligned &&
1613                              (PL_origenviron[i] >  s &&
1614                               PL_origenviron[i] <=
1615                               INT2PTR(char *, PTR2UV(s + PTRSIZE) & mask)))
1616                            )
1617                         {
1618                              s = PL_origenviron[i];
1619                              while (*s) s++;
1620                         }
1621                         else
1622                              break;
1623                    }
1624               }
1625          }
1626 #endif /* !defined(PERL_USE_SAFE_PUTENV) */
1627
1628          PL_origalen = s ? s - PL_origargv[0] + 1 : 0;
1629     }
1630
1631     if (PL_do_undump) {
1632
1633         /* Come here if running an undumped a.out. */
1634
1635         PL_origfilename = savepv(argv[0]);
1636         PL_do_undump = FALSE;
1637         cxstack_ix = -1;                /* start label stack again */
1638         init_ids();
1639         assert (!PL_tainted);
1640         TAINT;
1641         S_set_caret_X(aTHX);
1642         TAINT_NOT;
1643         init_postdump_symbols(argc,argv,env);
1644         return 0;
1645     }
1646
1647     if (PL_main_root) {
1648         op_free(PL_main_root);
1649         PL_main_root = NULL;
1650     }
1651     PL_main_start = NULL;
1652     SvREFCNT_dec(PL_main_cv);
1653     PL_main_cv = NULL;
1654
1655     time(&PL_basetime);
1656     oldscope = PL_scopestack_ix;
1657     PL_dowarn = G_WARN_OFF;
1658
1659     JMPENV_PUSH(ret);
1660     switch (ret) {
1661     case 0:
1662         parse_body(env,xsinit);
1663         if (PL_unitcheckav)
1664             call_list(oldscope, PL_unitcheckav);
1665         if (PL_checkav)
1666             call_list(oldscope, PL_checkav);
1667         ret = 0;
1668         break;
1669     case 1:
1670         STATUS_ALL_FAILURE;
1671         /* FALL THROUGH */
1672     case 2:
1673         /* my_exit() was called */
1674         while (PL_scopestack_ix > oldscope)
1675             LEAVE;
1676         FREETMPS;
1677         PL_curstash = PL_defstash;
1678         if (PL_unitcheckav)
1679             call_list(oldscope, PL_unitcheckav);
1680         if (PL_checkav)
1681             call_list(oldscope, PL_checkav);
1682         ret = STATUS_EXIT;
1683         break;
1684     case 3:
1685         PerlIO_printf(Perl_error_log, "panic: top_env\n");
1686         ret = 1;
1687         break;
1688     }
1689     JMPENV_POP;
1690     return ret;
1691 }
1692
1693 STATIC void *
1694 S_parse_body(pTHX_ char **env, XSINIT_t xsinit)
1695 {
1696     dVAR;
1697     PerlIO *rsfp;
1698     int argc = PL_origargc;
1699     char **argv = PL_origargv;
1700     const char *scriptname = NULL;
1701     VOL bool dosearch = FALSE;
1702 #ifdef DOSUID
1703     const char *validarg = "";
1704 #endif
1705     register SV *sv;
1706     register char c;
1707     const char *cddir = NULL;
1708 #ifdef USE_SITECUSTOMIZE
1709     bool minus_f = FALSE;
1710 #endif
1711     SV *linestr_sv = newSV_type(SVt_PVIV);
1712     bool add_read_e_script = FALSE;
1713
1714     SvGROW(linestr_sv, 80);
1715     sv_setpvn(linestr_sv,"",0);
1716
1717     sv = newSVpvs("");          /* first used for -I flags */
1718     SAVEFREESV(sv);
1719     init_main_stash();
1720
1721     {
1722         const char *s;
1723     for (argc--,argv++; argc > 0; argc--,argv++) {
1724         if (argv[0][0] != '-' || !argv[0][1])
1725             break;
1726 #ifdef DOSUID
1727     if (*validarg)
1728         validarg = " PHOOEY ";
1729     else
1730         validarg = argv[0];
1731     /*
1732      * Can we rely on the kernel to start scripts with argv[1] set to
1733      * contain all #! line switches (the whole line)? (argv[0] is set to
1734      * the interpreter name, argv[2] to the script name; argv[3] and
1735      * above may contain other arguments.)
1736      */
1737 #endif
1738         s = argv[0]+1;
1739       reswitch:
1740         switch ((c = *s)) {
1741         case 'C':
1742 #ifndef PERL_STRICT_CR
1743         case '\r':
1744 #endif
1745         case ' ':
1746         case '0':
1747         case 'F':
1748         case 'a':
1749         case 'c':
1750         case 'd':
1751         case 'D':
1752         case 'h':
1753         case 'i':
1754         case 'l':
1755         case 'M':
1756         case 'm':
1757         case 'n':
1758         case 'p':
1759         case 's':
1760         case 'u':
1761         case 'U':
1762         case 'v':
1763         case 'W':
1764         case 'X':
1765         case 'w':
1766             if ((s = moreswitches(s)))
1767                 goto reswitch;
1768             break;
1769
1770         case 't':
1771             CHECK_MALLOC_TOO_LATE_FOR('t');
1772             if( !PL_tainting ) {
1773                  PL_taint_warn = TRUE;
1774                  PL_tainting = TRUE;
1775             }
1776             s++;
1777             goto reswitch;
1778         case 'T':
1779             CHECK_MALLOC_TOO_LATE_FOR('T');
1780             PL_tainting = TRUE;
1781             PL_taint_warn = FALSE;
1782             s++;
1783             goto reswitch;
1784
1785         case 'E':
1786             PL_minus_E = TRUE;
1787             /* FALL THROUGH */
1788         case 'e':
1789 #ifdef MACOS_TRADITIONAL
1790             /* ignore -e for Dev:Pseudo argument */
1791             if (argv[1] && !strcmp(argv[1], "Dev:Pseudo"))
1792                 break;
1793 #endif
1794             forbid_setid('e', FALSE);
1795             if (!PL_e_script) {
1796                 PL_e_script = newSVpvs("");
1797                 add_read_e_script = TRUE;
1798             }
1799             if (*++s)
1800                 sv_catpv(PL_e_script, s);
1801             else if (argv[1]) {
1802                 sv_catpv(PL_e_script, argv[1]);
1803                 argc--,argv++;
1804             }
1805             else
1806                 Perl_croak(aTHX_ "No code specified for -%c", c);
1807             sv_catpvs(PL_e_script, "\n");
1808             break;
1809
1810         case 'f':
1811 #ifdef USE_SITECUSTOMIZE
1812             minus_f = TRUE;
1813 #endif
1814             s++;
1815             goto reswitch;
1816
1817         case 'I':       /* -I handled both here and in moreswitches() */
1818             forbid_setid('I', FALSE);
1819             if (!*++s && (s=argv[1]) != NULL) {
1820                 argc--,argv++;
1821             }
1822             if (s && *s) {
1823                 STRLEN len = strlen(s);
1824                 const char * const p = savepvn(s, len);
1825                 incpush(p, TRUE, TRUE, FALSE, FALSE);
1826                 sv_catpvs(sv, "-I");
1827                 sv_catpvn(sv, p, len);
1828                 sv_catpvs(sv, " ");
1829                 Safefree(p);
1830             }
1831             else
1832                 Perl_croak(aTHX_ "No directory specified for -I");
1833             break;
1834         case 'S':
1835             forbid_setid('S', FALSE);
1836             dosearch = TRUE;
1837             s++;
1838             goto reswitch;
1839         case 'V':
1840             {
1841                 SV *opts_prog;
1842
1843                 Perl_av_create_and_push(aTHX_ &PL_preambleav, newSVpvs("use Config;"));
1844                 if (*++s != ':')  {
1845                     /* Can't do newSVpvs() as that would involve pre-processor
1846                        condititionals inside a macro expansion.  */
1847                     opts_prog = Perl_newSVpv(aTHX_ "$_ = join ' ', sort qw("
1848 #  ifdef DEBUGGING
1849                              " DEBUGGING"
1850 #  endif
1851 #  ifdef NO_MATHOMS
1852                             " NO_MATHOMS"
1853 #  endif
1854 #  ifdef PERL_DONT_CREATE_GVSV
1855                              " PERL_DONT_CREATE_GVSV"
1856 #  endif
1857 #  ifdef PERL_MALLOC_WRAP
1858                              " PERL_MALLOC_WRAP"
1859 #  endif
1860 #  ifdef PERL_MEM_LOG
1861                              " PERL_MEM_LOG"
1862 #  endif
1863 #  ifdef PERL_MEM_LOG_ENV
1864                              " PERL_MEM_LOG_ENV"
1865 #  endif
1866 #  ifdef PERL_MEM_LOG_ENV_FD
1867                              " PERL_MEM_LOG_ENV_FD"
1868 #  endif
1869 #  ifdef PERL_MEM_LOG_STDERR
1870                              " PERL_MEM_LOG_STDERR"
1871 #  endif
1872 #  ifdef PERL_MEM_LOG_TIMESTAMP
1873                              " PERL_MEM_LOG_TIMESTAMP"
1874 #  endif
1875 #  ifdef PERL_USE_SAFE_PUTENV
1876                              " PERL_USE_SAFE_PUTENV"
1877 #  endif
1878 #  ifdef USE_SITECUSTOMIZE
1879                              " USE_SITECUSTOMIZE"
1880 #  endif               
1881                                              , 0);
1882
1883                     sv_catpv(opts_prog, PL_bincompat_options);
1884                     /* Terminate the qw(, and then wrap at 76 columns.  */
1885                     sv_catpvs(opts_prog, "); s/(?=.{53})(.{1,53}) /$1\\n                        /mg;print Config::myconfig(),");
1886 #ifdef VMS
1887                     sv_catpvs(opts_prog,"\"\\nCharacteristics of this PERLSHR image: \\n");
1888 #else
1889                     sv_catpvs(opts_prog,"\"\\nCharacteristics of this binary (from libperl): \\n");
1890 #endif
1891
1892                     sv_catpvs(opts_prog,"  Compile-time options: $_\\n\",");
1893
1894 #if defined(LOCAL_PATCH_COUNT)
1895                     if (LOCAL_PATCH_COUNT > 0) {
1896                         int i;
1897                         sv_catpvs(opts_prog,
1898                                  "\"  Locally applied patches:\\n\",");
1899                         for (i = 1; i <= LOCAL_PATCH_COUNT; i++) {
1900                             if (PL_localpatches[i])
1901                                 Perl_sv_catpvf(aTHX_ opts_prog,"q%c\t%s\n%c,",
1902                                                0, PL_localpatches[i], 0);
1903                         }
1904                     }
1905 #endif
1906                     Perl_sv_catpvf(aTHX_ opts_prog,
1907                                    "\"  Built under %s\\n",OSNAME);
1908 #ifdef __DATE__
1909 #  ifdef __TIME__
1910                     sv_catpvs(opts_prog,
1911                               "  Compiled at " __DATE__ " " __TIME__ "\\n\"");
1912 #  else
1913                     sv_catpvs(opts_prog, "  Compiled on " __DATE__ "\\n\"");
1914 #  endif
1915 #endif
1916                     sv_catpvs(opts_prog, "; $\"=\"\\n    \"; "
1917                              "@env = map { \"$_=\\\"$ENV{$_}\\\"\" } "
1918                              "sort grep {/^PERL/} keys %ENV; ");
1919 #ifdef __CYGWIN__
1920                     sv_catpvs(opts_prog,
1921                              "push @env, \"CYGWIN=\\\"$ENV{CYGWIN}\\\"\";");
1922 #endif
1923                     sv_catpvs(opts_prog, 
1924                              "print \"  \\%ENV:\\n    @env\\n\" if @env;"
1925                              "print \"  \\@INC:\\n    @INC\\n\";");
1926                 }
1927                 else {
1928                     ++s;
1929                     opts_prog = Perl_newSVpvf(aTHX_
1930                                               "Config::config_vars(qw%c%s%c)",
1931                                               0, s, 0);
1932                     s += strlen(s);
1933                 }
1934                 av_push(PL_preambleav, opts_prog);
1935                 /* don't look for script or read stdin */
1936                 scriptname = BIT_BUCKET;
1937                 goto reswitch;
1938             }
1939         case 'x':
1940             PL_doextract = TRUE;
1941             s++;
1942             if (*s)
1943                 cddir = s;
1944             break;
1945         case 0:
1946             break;
1947         case '-':
1948             if (!*++s || isSPACE(*s)) {
1949                 argc--,argv++;
1950                 goto switch_end;
1951             }
1952             /* catch use of gnu style long options */
1953             if (strEQ(s, "version")) {
1954                 s = (char *)"v";
1955                 goto reswitch;
1956             }
1957             if (strEQ(s, "help")) {
1958                 s = (char *)"h";
1959                 goto reswitch;
1960             }
1961             s--;
1962             /* FALL THROUGH */
1963         default:
1964             Perl_croak(aTHX_ "Unrecognized switch: -%s  (-h will show valid options)",s);
1965         }
1966     }
1967     }
1968
1969   switch_end:
1970
1971     {
1972         char *s;
1973
1974     if (
1975 #ifndef SECURE_INTERNAL_GETENV
1976         !PL_tainting &&
1977 #endif
1978         (s = PerlEnv_getenv("PERL5OPT")))
1979     {
1980         while (isSPACE(*s))
1981             s++;
1982         if (*s == '-' && *(s+1) == 'T') {
1983             CHECK_MALLOC_TOO_LATE_FOR('T');
1984             PL_tainting = TRUE;
1985             PL_taint_warn = FALSE;
1986         }
1987         else {
1988             char *popt_copy = NULL;
1989             while (s && *s) {
1990                 const char *d;
1991                 while (isSPACE(*s))
1992                     s++;
1993                 if (*s == '-') {
1994                     s++;
1995                     if (isSPACE(*s))
1996                         continue;
1997                 }
1998                 d = s;
1999                 if (!*s)
2000                     break;
2001                 if (!strchr("CDIMUdmtw", *s))
2002                     Perl_croak(aTHX_ "Illegal switch in PERL5OPT: -%c", *s);
2003                 while (++s && *s) {
2004                     if (isSPACE(*s)) {
2005                         if (!popt_copy) {
2006                             popt_copy = SvPVX(sv_2mortal(newSVpv(d,0)));
2007                             s = popt_copy + (s - d);
2008                             d = popt_copy;
2009                         }
2010                         *s++ = '\0';
2011                         break;
2012                     }
2013                 }
2014                 if (*d == 't') {
2015                     if( !PL_tainting ) {
2016                         PL_taint_warn = TRUE;
2017                         PL_tainting = TRUE;
2018                     }
2019                 } else {
2020                     moreswitches(d);
2021                 }
2022             }
2023         }
2024     }
2025     }
2026
2027 #ifdef USE_SITECUSTOMIZE
2028     if (!minus_f) {
2029         (void)Perl_av_create_and_unshift_one(aTHX_ &PL_preambleav,
2030                                              Perl_newSVpvf(aTHX_ "BEGIN { do '%s/sitecustomize.pl' }", SITELIB_EXP));
2031     }
2032 #endif
2033
2034     if (!scriptname)
2035         scriptname = argv[0];
2036     if (PL_e_script) {
2037         argc++,argv--;
2038         scriptname = BIT_BUCKET;        /* don't look for script or read stdin */
2039     }
2040     else if (scriptname == NULL) {
2041 #ifdef MSDOS
2042         if ( PerlLIO_isatty(PerlIO_fileno(PerlIO_stdin())) )
2043             moreswitches("h");
2044 #endif
2045         scriptname = "-";
2046     }
2047
2048     /* Set $^X early so that it can be used for relocatable paths in @INC  */
2049     assert (!PL_tainted);
2050     TAINT;
2051     S_set_caret_X(aTHX);
2052     TAINT_NOT;
2053     init_perllib();
2054
2055     {
2056         bool suidscript = FALSE;
2057
2058 #ifdef DOSUID
2059         const int fdscript =
2060 #endif
2061             open_script(scriptname, dosearch, &suidscript, &rsfp);
2062
2063         validate_suid(validarg, scriptname, fdscript, suidscript,
2064                 linestr_sv, rsfp);
2065
2066 #ifndef PERL_MICRO
2067 #  if defined(SIGCHLD) || defined(SIGCLD)
2068         {
2069 #  ifndef SIGCHLD
2070 #    define SIGCHLD SIGCLD
2071 #  endif
2072             Sighandler_t sigstate = rsignal_state(SIGCHLD);
2073             if (sigstate == (Sighandler_t) SIG_IGN) {
2074                 if (ckWARN(WARN_SIGNAL))
2075                     Perl_warner(aTHX_ packWARN(WARN_SIGNAL),
2076                                 "Can't ignore signal CHLD, forcing to default");
2077                 (void)rsignal(SIGCHLD, (Sighandler_t)SIG_DFL);
2078             }
2079         }
2080 #  endif
2081 #endif
2082
2083         if (PL_doextract
2084 #ifdef MACOS_TRADITIONAL
2085             || gMacPerl_AlwaysExtract
2086 #endif
2087             ) {
2088
2089             /* This will croak if suidscript is true, as -x cannot be used with
2090                setuid scripts.  */
2091             forbid_setid('x', suidscript);
2092             /* Hence you can't get here if suidscript is true */
2093
2094             find_beginning(linestr_sv, rsfp);
2095             if (cddir && PerlDir_chdir( (char *)cddir ) < 0)
2096                 Perl_croak(aTHX_ "Can't chdir to %s",cddir);
2097         }
2098     }
2099
2100     PL_main_cv = PL_compcv = (CV*)newSV_type(SVt_PVCV);
2101     CvUNIQUE_on(PL_compcv);
2102
2103     CvPADLIST(PL_compcv) = pad_new(0);
2104
2105     PL_isarev = newHV();
2106
2107     boot_core_PerlIO();
2108     boot_core_UNIVERSAL();
2109     boot_core_xsutils();
2110     boot_core_mro();
2111
2112     if (xsinit)
2113         (*xsinit)(aTHX);        /* in case linked C routines want magical variables */
2114 #ifndef PERL_MICRO
2115 #if defined(VMS) || defined(WIN32) || defined(DJGPP) || defined(__CYGWIN__) || defined(EPOC) || defined(SYMBIAN)
2116     init_os_extras();
2117 #endif
2118 #endif
2119
2120 #ifdef USE_SOCKS
2121 #   ifdef HAS_SOCKS5_INIT
2122     socks5_init(argv[0]);
2123 #   else
2124     SOCKSinit(argv[0]);
2125 #   endif
2126 #endif
2127
2128     init_predump_symbols();
2129     /* init_postdump_symbols not currently designed to be called */
2130     /* more than once (ENV isn't cleared first, for example)     */
2131     /* But running with -u leaves %ENV & @ARGV undefined!    XXX */
2132     if (!PL_do_undump)
2133         init_postdump_symbols(argc,argv,env);
2134
2135     /* PL_unicode is turned on by -C, or by $ENV{PERL_UNICODE},
2136      * or explicitly in some platforms.
2137      * locale.c:Perl_init_i18nl10n() if the environment
2138      * look like the user wants to use UTF-8. */
2139 #if defined(__SYMBIAN32__)
2140     PL_unicode = PERL_UNICODE_STD_FLAG; /* See PERL_SYMBIAN_CONSOLE_UTF8. */
2141 #endif
2142     if (PL_unicode) {
2143          /* Requires init_predump_symbols(). */
2144          if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
2145               IO* io;
2146               PerlIO* fp;
2147               SV* sv;
2148
2149               /* Turn on UTF-8-ness on STDIN, STDOUT, STDERR
2150                * and the default open disciplines. */
2151               if ((PL_unicode & PERL_UNICODE_STDIN_FLAG) &&
2152                   PL_stdingv  && (io = GvIO(PL_stdingv)) &&
2153                   (fp = IoIFP(io)))
2154                    PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2155               if ((PL_unicode & PERL_UNICODE_STDOUT_FLAG) &&
2156                   PL_defoutgv && (io = GvIO(PL_defoutgv)) &&
2157                   (fp = IoOFP(io)))
2158                    PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2159               if ((PL_unicode & PERL_UNICODE_STDERR_FLAG) &&
2160                   PL_stderrgv && (io = GvIO(PL_stderrgv)) &&
2161                   (fp = IoOFP(io)))
2162                    PerlIO_binmode(aTHX_ fp, IoTYPE(io), 0, ":utf8");
2163               if ((PL_unicode & PERL_UNICODE_INOUT_FLAG) &&
2164                   (sv = GvSV(gv_fetchpvs("\017PEN", GV_ADD|GV_NOTQUAL,
2165                                          SVt_PV)))) {
2166                    U32 in  = PL_unicode & PERL_UNICODE_IN_FLAG;
2167                    U32 out = PL_unicode & PERL_UNICODE_OUT_FLAG;
2168                    if (in) {
2169                         if (out)
2170                              sv_setpvn(sv, ":utf8\0:utf8", 11);
2171                         else
2172                              sv_setpvn(sv, ":utf8\0", 6);
2173                    }
2174                    else if (out)
2175                         sv_setpvn(sv, "\0:utf8", 6);
2176                    SvSETMAGIC(sv);
2177               }
2178          }
2179     }
2180
2181     {
2182         const char *s;
2183     if ((s = PerlEnv_getenv("PERL_SIGNALS"))) {
2184          if (strEQ(s, "unsafe"))
2185               PL_signals |=  PERL_SIGNALS_UNSAFE_FLAG;
2186          else if (strEQ(s, "safe"))
2187               PL_signals &= ~PERL_SIGNALS_UNSAFE_FLAG;
2188          else
2189               Perl_croak(aTHX_ "PERL_SIGNALS illegal: \"%s\"", s);
2190     }
2191     }
2192
2193 #ifdef PERL_MAD
2194     {
2195         const char *s;
2196     if ((s = PerlEnv_getenv("PERL_XMLDUMP"))) {
2197         PL_madskills = 1;
2198         PL_minus_c = 1;
2199         if (!s || !s[0])
2200             PL_xmlfp = PerlIO_stdout();
2201         else {
2202             PL_xmlfp = PerlIO_open(s, "w");
2203             if (!PL_xmlfp)
2204                 Perl_croak(aTHX_ "Can't open %s", s);
2205         }
2206         my_setenv("PERL_XMLDUMP", NULL);        /* hide from subprocs */
2207     }
2208     }
2209
2210     {
2211         const char *s;
2212     if ((s = PerlEnv_getenv("PERL_MADSKILLS"))) {
2213         PL_madskills = atoi(s);
2214         my_setenv("PERL_MADSKILLS", NULL);      /* hide from subprocs */
2215     }
2216     }
2217 #endif
2218
2219     lex_start(linestr_sv, rsfp, TRUE);
2220     PL_subname = newSVpvs("main");
2221
2222     if (add_read_e_script)
2223         filter_add(read_e_script, NULL);
2224
2225     /* now parse the script */
2226
2227     SETERRNO(0,SS_NORMAL);
2228 #ifdef MACOS_TRADITIONAL
2229     if (gMacPerl_SyntaxError = (yyparse() || PL_parser->error_count)) {
2230         if (PL_minus_c)
2231             Perl_croak(aTHX_ "%s had compilation errors.\n", MacPerl_MPWFileName(PL_origfilename));
2232         else {
2233             Perl_croak(aTHX_ "Execution of %s aborted due to compilation errors.\n",
2234                        MacPerl_MPWFileName(PL_origfilename));
2235         }
2236     }
2237 #else
2238     if (yyparse() || PL_parser->error_count) {
2239         if (PL_minus_c)
2240             Perl_croak(aTHX_ "%s had compilation errors.\n", PL_origfilename);
2241         else {
2242             Perl_croak(aTHX_ "Execution of %s aborted due to compilation errors.\n",
2243                        PL_origfilename);
2244         }
2245     }
2246 #endif
2247     CopLINE_set(PL_curcop, 0);
2248     PL_curstash = PL_defstash;
2249     if (PL_e_script) {
2250         SvREFCNT_dec(PL_e_script);
2251         PL_e_script = NULL;
2252     }
2253
2254     if (PL_do_undump)
2255         my_unexec();
2256
2257     if (isWARN_ONCE) {
2258         SAVECOPFILE(PL_curcop);
2259         SAVECOPLINE(PL_curcop);
2260         gv_check(PL_defstash);
2261     }
2262
2263     LEAVE;
2264     FREETMPS;
2265
2266 #ifdef MYMALLOC
2267     {
2268         const char *s;
2269     if ((s=PerlEnv_getenv("PERL_DEBUG_MSTATS")) && atoi(s) >= 2)
2270         dump_mstats("after compilation:");
2271     }
2272 #endif
2273
2274     ENTER;
2275     PL_restartop = 0;
2276     return NULL;
2277 }
2278
2279 /*
2280 =for apidoc perl_run
2281
2282 Tells a Perl interpreter to run.  See L<perlembed>.
2283
2284 =cut
2285 */
2286
2287 int
2288 perl_run(pTHXx)
2289 {
2290     dVAR;
2291     I32 oldscope;
2292     int ret = 0;
2293     dJMPENV;
2294
2295     PERL_ARGS_ASSERT_PERL_RUN;
2296 #ifndef MULTIPLICITY
2297     PERL_UNUSED_ARG(my_perl);
2298 #endif
2299
2300     oldscope = PL_scopestack_ix;
2301 #ifdef VMS
2302     VMSISH_HUSHED = 0;
2303 #endif
2304
2305     JMPENV_PUSH(ret);
2306     switch (ret) {
2307     case 1:
2308         cxstack_ix = -1;                /* start context stack again */
2309         goto redo_body;
2310     case 0:                             /* normal completion */
2311  redo_body:
2312         run_body(oldscope);
2313         /* FALL THROUGH */
2314     case 2:                             /* my_exit() */
2315         while (PL_scopestack_ix > oldscope)
2316             LEAVE;
2317         FREETMPS;
2318         PL_curstash = PL_defstash;
2319         if (!(PL_exit_flags & PERL_EXIT_DESTRUCT_END) &&
2320             PL_endav && !PL_minus_c)
2321             call_list(oldscope, PL_endav);
2322 #ifdef MYMALLOC
2323         if (PerlEnv_getenv("PERL_DEBUG_MSTATS"))
2324             dump_mstats("after execution:  ");
2325 #endif
2326         ret = STATUS_EXIT;
2327         break;
2328     case 3:
2329         if (PL_restartop) {
2330             POPSTACK_TO(PL_mainstack);
2331             goto redo_body;
2332         }
2333         PerlIO_printf(Perl_error_log, "panic: restartop\n");
2334         FREETMPS;
2335         ret = 1;
2336         break;
2337     }
2338
2339     JMPENV_POP;
2340     return ret;
2341 }
2342
2343 STATIC void
2344 S_run_body(pTHX_ I32 oldscope)
2345 {
2346     dVAR;
2347     DEBUG_r(PerlIO_printf(Perl_debug_log, "%s $` $& $' support.\n",
2348                     PL_sawampersand ? "Enabling" : "Omitting"));
2349
2350     if (!PL_restartop) {
2351 #ifdef PERL_MAD
2352         if (PL_xmlfp) {
2353             xmldump_all();
2354             exit(0);    /* less likely to core dump than my_exit(0) */
2355         }
2356 #endif
2357         DEBUG_x(dump_all());
2358 #ifdef DEBUGGING
2359         if (!DEBUG_q_TEST)
2360           PERL_DEBUG(PerlIO_printf(Perl_debug_log, "\nEXECUTING...\n\n"));
2361 #endif
2362
2363         if (PL_minus_c) {
2364 #ifdef MACOS_TRADITIONAL
2365             PerlIO_printf(Perl_error_log, "%s%s syntax OK\n",
2366                 (gMacPerl_ErrorFormat ? "# " : ""),
2367                 MacPerl_MPWFileName(PL_origfilename));
2368 #else
2369             PerlIO_printf(Perl_error_log, "%s syntax OK\n", PL_origfilename);
2370 #endif
2371             my_exit(0);
2372         }
2373         if (PERLDB_SINGLE && PL_DBsingle)
2374             sv_setiv(PL_DBsingle, 1);
2375         if (PL_initav)
2376             call_list(oldscope, PL_initav);
2377 #ifdef PERL_DEBUG_READONLY_OPS
2378         Perl_pending_Slabs_to_ro(aTHX);
2379 #endif
2380     }
2381
2382     /* do it */
2383
2384     if (PL_restartop) {
2385         PL_op = PL_restartop;
2386         PL_restartop = 0;
2387         CALLRUNOPS(aTHX);
2388     }
2389     else if (PL_main_start) {
2390         CvDEPTH(PL_main_cv) = 1;
2391         PL_op = PL_main_start;
2392         CALLRUNOPS(aTHX);
2393     }
2394     my_exit(0);
2395     /* NOTREACHED */
2396 }
2397
2398 /*
2399 =head1 SV Manipulation Functions
2400
2401 =for apidoc p||get_sv
2402
2403 Returns the SV of the specified Perl scalar.  If C<create> is set and the
2404 Perl variable does not exist then it will be created.  If C<create> is not
2405 set and the variable does not exist then NULL is returned.
2406
2407 =cut
2408 */
2409
2410 SV*
2411 Perl_get_sv(pTHX_ const char *name, I32 create)
2412 {
2413     GV *gv;
2414
2415     PERL_ARGS_ASSERT_GET_SV;
2416
2417     gv = gv_fetchpv(name, create, SVt_PV);
2418     if (gv)
2419         return GvSV(gv);
2420     return NULL;
2421 }
2422
2423 /*
2424 =head1 Array Manipulation Functions
2425
2426 =for apidoc p||get_av
2427
2428 Returns the AV of the specified Perl array.  If C<create> is set and the
2429 Perl variable does not exist then it will be created.  If C<create> is not
2430 set and the variable does not exist then NULL is returned.
2431
2432 =cut
2433 */
2434
2435 AV*
2436 Perl_get_av(pTHX_ const char *name, I32 create)
2437 {
2438     GV* const gv = gv_fetchpv(name, create, SVt_PVAV);
2439
2440     PERL_ARGS_ASSERT_GET_AV;
2441
2442     if (create)
2443         return GvAVn(gv);
2444     if (gv)
2445         return GvAV(gv);
2446     return NULL;
2447 }
2448
2449 /*
2450 =head1 Hash Manipulation Functions
2451
2452 =for apidoc p||get_hv
2453
2454 Returns the HV of the specified Perl hash.  If C<create> is set and the
2455 Perl variable does not exist then it will be created.  If C<create> is not
2456 set and the variable does not exist then NULL is returned.
2457
2458 =cut
2459 */
2460
2461 HV*
2462 Perl_get_hv(pTHX_ const char *name, I32 create)
2463 {
2464     GV* const gv = gv_fetchpv(name, create, SVt_PVHV);
2465
2466     PERL_ARGS_ASSERT_GET_HV;
2467
2468     if (create)
2469         return GvHVn(gv);
2470     if (gv)
2471         return GvHV(gv);
2472     return NULL;
2473 }
2474
2475 /*
2476 =head1 CV Manipulation Functions
2477
2478 =for apidoc p||get_cvn_flags
2479
2480 Returns the CV of the specified Perl subroutine.  C<flags> are passed to
2481 C<gv_fetchpvn_flags>. If C<GV_ADD> is set and the Perl subroutine does not
2482 exist then it will be declared (which has the same effect as saying
2483 C<sub name;>).  If C<GV_ADD> is not set and the subroutine does not exist
2484 then NULL is returned.
2485
2486 =for apidoc p||get_cv
2487
2488 Uses C<strlen> to get the length of C<name>, then calls C<get_cvn_flags>.
2489
2490 =cut
2491 */
2492
2493 CV*
2494 Perl_get_cvn_flags(pTHX_ const char *name, STRLEN len, I32 flags)
2495 {
2496     GV* const gv = gv_fetchpvn_flags(name, len, flags, SVt_PVCV);
2497     /* XXX this is probably not what they think they're getting.
2498      * It has the same effect as "sub name;", i.e. just a forward
2499      * declaration! */
2500
2501     PERL_ARGS_ASSERT_GET_CVN_FLAGS;
2502
2503     if ((flags & ~GV_NOADD_MASK) && !GvCVu(gv)) {
2504         SV *const sv = newSVpvn_flags(name, len, flags & SVf_UTF8);
2505         return newSUB(start_subparse(FALSE, 0),
2506                       newSVOP(OP_CONST, 0, sv),
2507                       NULL, NULL);
2508     }
2509     if (gv)
2510         return GvCVu(gv);
2511     return NULL;
2512 }
2513
2514 CV*
2515 Perl_get_cv(pTHX_ const char *name, I32 flags)
2516 {
2517     PERL_ARGS_ASSERT_GET_CV;
2518
2519     return get_cvn_flags(name, strlen(name), flags);
2520 }
2521
2522 /* Be sure to refetch the stack pointer after calling these routines. */
2523
2524 /*
2525
2526 =head1 Callback Functions
2527
2528 =for apidoc p||call_argv
2529
2530 Performs a callback to the specified Perl sub.  See L<perlcall>.
2531
2532 =cut
2533 */
2534
2535 I32
2536 Perl_call_argv(pTHX_ const char *sub_name, I32 flags, register char **argv)
2537
2538                         /* See G_* flags in cop.h */
2539                         /* null terminated arg list */
2540 {
2541     dVAR;
2542     dSP;
2543
2544     PERL_ARGS_ASSERT_CALL_ARGV;
2545
2546     PUSHMARK(SP);
2547     if (argv) {
2548         while (*argv) {
2549             mXPUSHs(newSVpv(*argv,0));
2550             argv++;
2551         }
2552         PUTBACK;
2553     }
2554     return call_pv(sub_name, flags);
2555 }
2556
2557 /*
2558 =for apidoc p||call_pv
2559
2560 Performs a callback to the specified Perl sub.  See L<perlcall>.
2561
2562 =cut
2563 */
2564
2565 I32
2566 Perl_call_pv(pTHX_ const char *sub_name, I32 flags)
2567                         /* name of the subroutine */
2568                         /* See G_* flags in cop.h */
2569 {
2570     PERL_ARGS_ASSERT_CALL_PV;
2571
2572     return call_sv((SV*)get_cv(sub_name, TRUE), flags);
2573 }
2574
2575 /*
2576 =for apidoc p||call_method
2577
2578 Performs a callback to the specified Perl method.  The blessed object must
2579 be on the stack.  See L<perlcall>.
2580
2581 =cut
2582 */
2583
2584 I32
2585 Perl_call_method(pTHX_ const char *methname, I32 flags)
2586                         /* name of the subroutine */
2587                         /* See G_* flags in cop.h */
2588 {
2589     PERL_ARGS_ASSERT_CALL_METHOD;
2590
2591     return call_sv(sv_2mortal(newSVpv(methname,0)), flags | G_METHOD);
2592 }
2593
2594 /* May be called with any of a CV, a GV, or an SV containing the name. */
2595 /*
2596 =for apidoc p||call_sv
2597
2598 Performs a callback to the Perl sub whose name is in the SV.  See
2599 L<perlcall>.
2600
2601 =cut
2602 */
2603
2604 I32
2605 Perl_call_sv(pTHX_ SV *sv, VOL I32 flags)
2606                         /* See G_* flags in cop.h */
2607 {
2608     dVAR; dSP;
2609     LOGOP myop;         /* fake syntax tree node */
2610     UNOP method_op;
2611     I32 oldmark;
2612     VOL I32 retval = 0;
2613     I32 oldscope;
2614     bool oldcatch = CATCH_GET;
2615     int ret;
2616     OP* const oldop = PL_op;
2617     dJMPENV;
2618
2619     PERL_ARGS_ASSERT_CALL_SV;
2620
2621     if (flags & G_DISCARD) {
2622         ENTER;
2623         SAVETMPS;
2624     }
2625     if (!(flags & G_WANT)) {
2626         /* Backwards compatibility - as G_SCALAR was 0, it could be omitted.
2627          */
2628         flags |= G_SCALAR;
2629     }
2630
2631     Zero(&myop, 1, LOGOP);
2632     myop.op_next = NULL;
2633     if (!(flags & G_NOARGS))
2634         myop.op_flags |= OPf_STACKED;
2635     myop.op_flags |= OP_GIMME_REVERSE(flags);
2636     SAVEOP();
2637     PL_op = (OP*)&myop;
2638
2639     EXTEND(PL_stack_sp, 1);
2640     *++PL_stack_sp = sv;
2641     oldmark = TOPMARK;
2642     oldscope = PL_scopestack_ix;
2643
2644     if (PERLDB_SUB && PL_curstash != PL_debstash
2645            /* Handle first BEGIN of -d. */
2646           && (PL_DBcv || (PL_DBcv = GvCV(PL_DBsub)))
2647            /* Try harder, since this may have been a sighandler, thus
2648             * curstash may be meaningless. */
2649           && (SvTYPE(sv) != SVt_PVCV || CvSTASH((CV*)sv) != PL_debstash)
2650           && !(flags & G_NODEBUG))
2651         PL_op->op_private |= OPpENTERSUB_DB;
2652
2653     if (flags & G_METHOD) {
2654         Zero(&method_op, 1, UNOP);
2655         method_op.op_next = PL_op;
2656         method_op.op_ppaddr = PL_ppaddr[OP_METHOD];
2657         method_op.op_type = OP_METHOD;
2658         myop.op_ppaddr = PL_ppaddr[OP_ENTERSUB];
2659         myop.op_type = OP_ENTERSUB;
2660         PL_op = (OP*)&method_op;
2661     }
2662
2663     if (!(flags & G_EVAL)) {
2664         CATCH_SET(TRUE);
2665         CALL_BODY_SUB((OP*)&myop);
2666         retval = PL_stack_sp - (PL_stack_base + oldmark);
2667         CATCH_SET(oldcatch);
2668     }
2669     else {
2670         myop.op_other = (OP*)&myop;
2671         PL_markstack_ptr--;
2672         create_eval_scope(flags|G_FAKINGEVAL);
2673         PL_markstack_ptr++;
2674
2675         JMPENV_PUSH(ret);
2676
2677         switch (ret) {
2678         case 0:
2679  redo_body:
2680             CALL_BODY_SUB((OP*)&myop);
2681             retval = PL_stack_sp - (PL_stack_base + oldmark);
2682             if (!(flags & G_KEEPERR))
2683                 sv_setpvn(ERRSV,"",0);
2684             break;
2685         case 1:
2686             STATUS_ALL_FAILURE;
2687             /* FALL THROUGH */
2688         case 2:
2689             /* my_exit() was called */
2690             PL_curstash = PL_defstash;
2691             FREETMPS;
2692             JMPENV_POP;
2693             if (PL_statusvalue && !(PL_exit_flags & PERL_EXIT_EXPECTED))
2694                 Perl_croak(aTHX_ "Callback called exit");
2695             my_exit_jump();
2696             /* NOTREACHED */
2697         case 3:
2698             if (PL_restartop) {
2699                 PL_op = PL_restartop;
2700                 PL_restartop = 0;
2701                 goto redo_body;
2702             }
2703             PL_stack_sp = PL_stack_base + oldmark;
2704             if ((flags & G_WANT) == G_ARRAY)
2705                 retval = 0;
2706             else {
2707                 retval = 1;
2708                 *++PL_stack_sp = &PL_sv_undef;
2709             }
2710             break;
2711         }
2712
2713         if (PL_scopestack_ix > oldscope)
2714             delete_eval_scope();
2715         JMPENV_POP;
2716     }
2717
2718     if (flags & G_DISCARD) {
2719         PL_stack_sp = PL_stack_base + oldmark;
2720         retval = 0;
2721         FREETMPS;
2722         LEAVE;
2723     }
2724     PL_op = oldop;
2725     return retval;
2726 }
2727
2728 /* Eval a string. The G_EVAL flag is always assumed. */
2729
2730 /*
2731 =for apidoc p||eval_sv
2732
2733 Tells Perl to C<eval> the string in the SV.
2734
2735 =cut
2736 */
2737
2738 I32
2739 Perl_eval_sv(pTHX_ SV *sv, I32 flags)
2740
2741                         /* See G_* flags in cop.h */
2742 {
2743     dVAR;
2744     dSP;
2745     UNOP myop;          /* fake syntax tree node */
2746     VOL I32 oldmark = SP - PL_stack_base;
2747     VOL I32 retval = 0;
2748     int ret;
2749     OP* const oldop = PL_op;
2750     dJMPENV;
2751
2752     PERL_ARGS_ASSERT_EVAL_SV;
2753
2754     if (flags & G_DISCARD) {
2755         ENTER;
2756         SAVETMPS;
2757     }
2758
2759     SAVEOP();
2760     PL_op = (OP*)&myop;
2761     Zero(PL_op, 1, UNOP);
2762     EXTEND(PL_stack_sp, 1);
2763     *++PL_stack_sp = sv;
2764
2765     if (!(flags & G_NOARGS))
2766         myop.op_flags = OPf_STACKED;
2767     myop.op_next = NULL;
2768     myop.op_type = OP_ENTEREVAL;
2769     myop.op_flags |= OP_GIMME_REVERSE(flags);
2770     if (flags & G_KEEPERR)
2771         myop.op_flags |= OPf_SPECIAL;
2772
2773     /* fail now; otherwise we could fail after the JMPENV_PUSH but
2774      * before a PUSHEVAL, which corrupts the stack after a croak */
2775     TAINT_PROPER("eval_sv()");
2776
2777     JMPENV_PUSH(ret);
2778     switch (ret) {
2779     case 0:
2780  redo_body:
2781         CALL_BODY_EVAL((OP*)&myop);
2782         retval = PL_stack_sp - (PL_stack_base + oldmark);
2783         if (!(flags & G_KEEPERR))
2784             sv_setpvn(ERRSV,"",0);
2785         break;
2786     case 1:
2787         STATUS_ALL_FAILURE;
2788         /* FALL THROUGH */
2789     case 2:
2790         /* my_exit() was called */
2791         PL_curstash = PL_defstash;
2792         FREETMPS;
2793         JMPENV_POP;
2794         if (PL_statusvalue && !(PL_exit_flags & PERL_EXIT_EXPECTED))
2795             Perl_croak(aTHX_ "Callback called exit");
2796         my_exit_jump();
2797         /* NOTREACHED */
2798     case 3:
2799         if (PL_restartop) {
2800             PL_op = PL_restartop;
2801             PL_restartop = 0;
2802             goto redo_body;
2803         }
2804         PL_stack_sp = PL_stack_base + oldmark;
2805         if ((flags & G_WANT) == G_ARRAY)
2806             retval = 0;
2807         else {
2808             retval = 1;
2809             *++PL_stack_sp = &PL_sv_undef;
2810         }
2811         break;
2812     }
2813
2814     JMPENV_POP;
2815     if (flags & G_DISCARD) {
2816         PL_stack_sp = PL_stack_base + oldmark;
2817         retval = 0;
2818         FREETMPS;
2819         LEAVE;
2820     }
2821     PL_op = oldop;
2822     return retval;
2823 }
2824
2825 /*
2826 =for apidoc p||eval_pv
2827
2828 Tells Perl to C<eval> the given string and return an SV* result.
2829
2830 =cut
2831 */
2832
2833 SV*
2834 Perl_eval_pv(pTHX_ const char *p, I32 croak_on_error)
2835 {
2836     dVAR;
2837     dSP;
2838     SV* sv = newSVpv(p, 0);
2839
2840     PERL_ARGS_ASSERT_EVAL_PV;
2841
2842     eval_sv(sv, G_SCALAR);
2843     SvREFCNT_dec(sv);
2844
2845     SPAGAIN;
2846     sv = POPs;
2847     PUTBACK;
2848
2849     if (croak_on_error && SvTRUE(ERRSV)) {
2850         Perl_croak(aTHX_ SvPVx_nolen_const(ERRSV));
2851     }
2852
2853     return sv;
2854 }
2855
2856 /* Require a module. */
2857
2858 /*
2859 =head1 Embedding Functions
2860
2861 =for apidoc p||require_pv
2862
2863 Tells Perl to C<require> the file named by the string argument.  It is
2864 analogous to the Perl code C<eval "require '$file'">.  It's even
2865 implemented that way; consider using load_module instead.
2866
2867 =cut */
2868
2869 void
2870 Perl_require_pv(pTHX_ const char *pv)
2871 {
2872     dVAR;
2873     dSP;
2874     SV* sv;
2875
2876     PERL_ARGS_ASSERT_REQUIRE_PV;
2877
2878     PUSHSTACKi(PERLSI_REQUIRE);
2879     PUTBACK;
2880     sv = Perl_newSVpvf(aTHX_ "require q%c%s%c", 0, pv, 0);
2881     eval_sv(sv_2mortal(sv), G_DISCARD);
2882     SPAGAIN;
2883     POPSTACK;
2884 }
2885
2886 void
2887 Perl_magicname(pTHX_ const char *sym, const char *name, I32 namlen)
2888 {
2889     register GV * const gv = gv_fetchpv(sym, GV_ADD, SVt_PV);
2890
2891     PERL_ARGS_ASSERT_MAGICNAME;
2892
2893     if (gv)
2894         sv_magic(GvSV(gv), (SV*)gv, PERL_MAGIC_sv, name, namlen);
2895 }
2896
2897 STATIC void
2898 S_usage(pTHX_ const char *name)         /* XXX move this out into a module ? */
2899 {
2900     /* This message really ought to be max 23 lines.
2901      * Removed -h because the user already knows that option. Others? */
2902
2903     static const char * const usage_msg[] = {
2904 "-0[octal]         specify record separator (\\0, if no argument)",
2905 "-a                autosplit mode with -n or -p (splits $_ into @F)",
2906 "-C[number/list]   enables the listed Unicode features",
2907 "-c                check syntax only (runs BEGIN and CHECK blocks)",
2908 "-d[:debugger]     run program under debugger",
2909 "-D[number/list]   set debugging flags (argument is a bit mask or alphabets)",
2910 "-e program        one line of program (several -e's allowed, omit programfile)",
2911 "-E program        like -e, but enables all optional features",
2912 "-f                don't do $sitelib/sitecustomize.pl at startup",
2913 "-F/pattern/       split() pattern for -a switch (//'s are optional)",
2914 "-i[extension]     edit <> files in place (makes backup if extension supplied)",
2915 "-Idirectory       specify @INC/#include directory (several -I's allowed)",
2916 "-l[octal]         enable line ending processing, specifies line terminator",
2917 "-[mM][-]module    execute \"use/no module...\" before executing program",
2918 "-n                assume \"while (<>) { ... }\" loop around program",
2919 "-p                assume loop like -n but print line also, like sed",
2920 "-s                enable rudimentary parsing for switches after programfile",
2921 "-S                look for programfile using PATH environment variable",
2922 "-t                enable tainting warnings",
2923 "-T                enable tainting checks",
2924 "-u                dump core after parsing program",
2925 "-U                allow unsafe operations",
2926 "-v                print version, subversion (includes VERY IMPORTANT perl info)",
2927 "-V[:variable]     print configuration summary (or a single Config.pm variable)",
2928 "-w                enable many useful warnings (RECOMMENDED)",
2929 "-W                enable all warnings",
2930 "-x[directory]     strip off text before #!perl line and perhaps cd to directory",
2931 "-X                disable all warnings",
2932 "\n",
2933 NULL
2934 };
2935     const char * const *p = usage_msg;
2936
2937     PERL_ARGS_ASSERT_USAGE;
2938
2939     PerlIO_printf(PerlIO_stdout(),
2940                   "\nUsage: %s [switches] [--] [programfile] [arguments]",
2941                   name);
2942     while (*p)
2943         PerlIO_printf(PerlIO_stdout(), "\n  %s", *p++);
2944 }
2945
2946 /* convert a string of -D options (or digits) into an int.
2947  * sets *s to point to the char after the options */
2948
2949 #ifdef DEBUGGING
2950 int
2951 Perl_get_debug_opts(pTHX_ const char **s, bool givehelp)
2952 {
2953     static const char * const usage_msgd[] = {
2954       " Debugging flag values: (see also -d)",
2955       "  p  Tokenizing and parsing (with v, displays parse stack)",
2956       "  s  Stack snapshots (with v, displays all stacks)",
2957       "  l  Context (loop) stack processing",
2958       "  t  Trace execution",
2959       "  o  Method and overloading resolution",
2960       "  c  String/numeric conversions",
2961       "  P  Print profiling info, source file input state",
2962       "  m  Memory allocation",
2963       "  f  Format processing",
2964       "  r  Regular expression parsing and execution",
2965       "  x  Syntax tree dump",
2966       "  u  Tainting checks",
2967       "  H  Hash dump -- usurps values()",
2968       "  X  Scratchpad allocation",
2969       "  D  Cleaning up",
2970       "  T  Tokenising",
2971       "  R  Include reference counts of dumped variables (eg when using -Ds)",
2972       "  J  Do not s,t,P-debug (Jump over) opcodes within package DB",
2973       "  v  Verbose: use in conjunction with other flags",
2974       "  C  Copy On Write",
2975       "  A  Consistency checks on internal structures",
2976       "  q  quiet - currently only suppresses the 'EXECUTING' message",
2977       NULL
2978     };
2979     int i = 0;
2980
2981     PERL_ARGS_ASSERT_GET_DEBUG_OPTS;
2982
2983     if (isALPHA(**s)) {
2984         /* if adding extra options, remember to update DEBUG_MASK */
2985         static const char debopts[] = "psltocPmfrxuUHXDSTRJvCAq";
2986
2987         for (; isALNUM(**s); (*s)++) {
2988             const char * const d = strchr(debopts,**s);
2989             if (d)
2990                 i |= 1 << (d - debopts);
2991             else if (ckWARN_d(WARN_DEBUGGING))
2992                 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
2993                     "invalid option -D%c, use -D'' to see choices\n", **s);
2994         }
2995     }
2996     else if (isDIGIT(**s)) {
2997         i = atoi(*s);
2998         for (; isALNUM(**s); (*s)++) ;
2999     }
3000     else if (givehelp) {
3001       const char *const *p = usage_msgd;
3002       while (*p) PerlIO_printf(PerlIO_stdout(), "%s\n", *p++);
3003     }
3004 #  ifdef EBCDIC
3005     if ((i & DEBUG_p_FLAG) && ckWARN_d(WARN_DEBUGGING))
3006         Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3007                 "-Dp not implemented on this platform\n");
3008 #  endif
3009     return i;
3010 }
3011 #endif
3012
3013 /* This routine handles any switches that can be given during run */
3014
3015 const char *
3016 Perl_moreswitches(pTHX_ const char *s)
3017 {
3018     dVAR;
3019     UV rschar;
3020     const char option = *s; /* used to remember option in -m/-M code */
3021
3022     PERL_ARGS_ASSERT_MORESWITCHES;
3023
3024     switch (*s) {
3025     case '0':
3026     {
3027          I32 flags = 0;
3028          STRLEN numlen;
3029
3030          SvREFCNT_dec(PL_rs);
3031          if (s[1] == 'x' && s[2]) {
3032               const char *e = s+=2;
3033               U8 *tmps;
3034
3035               while (*e)
3036                 e++;
3037               numlen = e - s;
3038               flags = PERL_SCAN_SILENT_ILLDIGIT;
3039               rschar = (U32)grok_hex(s, &numlen, &flags, NULL);
3040               if (s + numlen < e) {
3041                    rschar = 0; /* Grandfather -0xFOO as -0 -xFOO. */
3042                    numlen = 0;
3043                    s--;
3044               }
3045               PL_rs = newSVpvs("");
3046               SvGROW(PL_rs, (STRLEN)(UNISKIP(rschar) + 1));
3047               tmps = (U8*)SvPVX(PL_rs);
3048               uvchr_to_utf8(tmps, rschar);
3049               SvCUR_set(PL_rs, UNISKIP(rschar));
3050               SvUTF8_on(PL_rs);
3051          }
3052          else {
3053               numlen = 4;
3054               rschar = (U32)grok_oct(s, &numlen, &flags, NULL);
3055               if (rschar & ~((U8)~0))
3056                    PL_rs = &PL_sv_undef;
3057               else if (!rschar && numlen >= 2)
3058                    PL_rs = newSVpvs("");
3059               else {
3060                    char ch = (char)rschar;
3061                    PL_rs = newSVpvn(&ch, 1);
3062               }
3063          }
3064          sv_setsv(get_sv("/", TRUE), PL_rs);
3065          return s + numlen;
3066     }
3067     case 'C':
3068         s++;
3069         PL_unicode = parse_unicode_opts( (const char **)&s );
3070         if (PL_unicode & PERL_UNICODE_UTF8CACHEASSERT_FLAG)
3071             PL_utf8cache = -1;
3072         return s;
3073     case 'F':
3074         PL_minus_F = TRUE;
3075         PL_splitstr = ++s;
3076         while (*s && !isSPACE(*s)) ++s;
3077         PL_splitstr = savepvn(PL_splitstr, s - PL_splitstr);
3078         return s;
3079     case 'a':
3080         PL_minus_a = TRUE;
3081         s++;
3082         return s;
3083     case 'c':
3084         PL_minus_c = TRUE;
3085         s++;
3086         return s;
3087     case 'd':
3088         forbid_setid('d', FALSE);
3089         s++;
3090
3091         /* -dt indicates to the debugger that threads will be used */
3092         if (*s == 't' && !isALNUM(s[1])) {
3093             ++s;
3094             my_setenv("PERL5DB_THREADED", "1");
3095         }
3096
3097         /* The following permits -d:Mod to accepts arguments following an =
3098            in the fashion that -MSome::Mod does. */
3099         if (*s == ':' || *s == '=') {
3100             const char *start = ++s;
3101             const char *const end = s + strlen(s);
3102             SV * const sv = newSVpvs("use Devel::");
3103
3104             /* We now allow -d:Module=Foo,Bar */
3105             while(isALNUM(*s) || *s==':') ++s;
3106             if (*s != '=')
3107                 sv_catpvn(sv, start, end - start);
3108             else {
3109                 sv_catpvn(sv, start, s-start);
3110                 /* Don't use NUL as q// delimiter here, this string goes in the
3111                  * environment. */
3112                 Perl_sv_catpvf(aTHX_ sv, " split(/,/,q{%s});", ++s);
3113             }
3114             s = end;
3115             my_setenv("PERL5DB", SvPV_nolen_const(sv));
3116             SvREFCNT_dec(sv);
3117         }
3118         if (!PL_perldb) {
3119             PL_perldb = PERLDB_ALL;
3120             init_debugger();
3121         }
3122         return s;
3123     case 'D':
3124     {   
3125 #ifdef DEBUGGING
3126         forbid_setid('D', FALSE);
3127         s++;
3128         PL_debug = get_debug_opts( (const char **)&s, 1) | DEBUG_TOP_FLAG;
3129 #else /* !DEBUGGING */
3130         if (ckWARN_d(WARN_DEBUGGING))
3131             Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
3132                    "Recompile perl with -DDEBUGGING to use -D switch (did you mean -d ?)\n");
3133         for (s++; isALNUM(*s); s++) ;
3134 #endif
3135         return s;
3136     }   
3137     case 'h':
3138         usage(PL_origargv[0]);
3139         my_exit(0);
3140     case 'i':
3141         Safefree(PL_inplace);
3142 #if defined(__CYGWIN__) /* do backup extension automagically */
3143         if (*(s+1) == '\0') {
3144         PL_inplace = savepvs(".bak");
3145         return s+1;
3146         }
3147 #endif /* __CYGWIN__ */
3148         {
3149             const char * const start = ++s;
3150             while (*s && !isSPACE(*s))
3151                 ++s;
3152
3153             PL_inplace = savepvn(start, s - start);
3154         }
3155         if (*s) {
3156             ++s;
3157             if (*s == '-')      /* Additional switches on #! line. */
3158                 s++;
3159         }
3160         return s;
3161     case 'I':   /* -I handled both here and in parse_body() */
3162         forbid_setid('I', FALSE);
3163         ++s;
3164         while (*s && isSPACE(*s))
3165             ++s;
3166         if (*s) {
3167             const char *e, *p;
3168             p = s;
3169             /* ignore trailing spaces (possibly followed by other switches) */
3170             do {
3171                 for (e = p; *e && !isSPACE(*e); e++) ;
3172                 p = e;
3173                 while (isSPACE(*p))
3174                     p++;
3175             } while (*p && *p != '-');
3176             e = savepvn(s, e-s);
3177             incpush(e, TRUE, TRUE, FALSE, FALSE);
3178             Safefree(e);
3179             s = p;
3180             if (*s == '-')
3181                 s++;
3182         }
3183         else
3184             Perl_croak(aTHX_ "No directory specified for -I");
3185         return s;
3186     case 'l':
3187         PL_minus_l = TRUE;
3188         s++;
3189         if (PL_ors_sv) {
3190             SvREFCNT_dec(PL_ors_sv);
3191             PL_ors_sv = NULL;
3192         }
3193         if (isDIGIT(*s)) {
3194             I32 flags = 0;
3195             STRLEN numlen;
3196             PL_ors_sv = newSVpvs("\n");
3197             numlen = 3 + (*s == '0');
3198             *SvPVX(PL_ors_sv) = (char)grok_oct(s, &numlen, &flags, NULL);
3199             s += numlen;
3200         }
3201         else {
3202             if (RsPARA(PL_rs)) {
3203                 PL_ors_sv = newSVpvs("\n\n");
3204             }
3205             else {
3206                 PL_ors_sv = newSVsv(PL_rs);
3207             }
3208         }
3209         return s;
3210     case 'M':
3211         forbid_setid('M', FALSE);       /* XXX ? */
3212         /* FALL THROUGH */
3213     case 'm':
3214         forbid_setid('m', FALSE);       /* XXX ? */
3215         if (*++s) {
3216             const char *start;
3217             const char *end;
3218             SV *sv;
3219             const char *use = "use ";
3220             bool colon = FALSE;
3221             /* -M-foo == 'no foo'       */
3222             /* Leading space on " no " is deliberate, to make both
3223                possibilities the same length.  */
3224             if (*s == '-') { use = " no "; ++s; }
3225             sv = newSVpvn(use,4);
3226             start = s;
3227             /* We allow -M'Module qw(Foo Bar)'  */
3228             while(isALNUM(*s) || *s==':') {
3229                 if( *s++ == ':' ) {
3230                     if( *s == ':' ) 
3231                         s++;
3232                     else
3233                         colon = TRUE;
3234                 }
3235             }
3236             if (s == start)
3237                 Perl_croak(aTHX_ "Module name required with -%c option",
3238                                     option);
3239             if (colon) 
3240                 Perl_croak(aTHX_ "Invalid module name %.*s with -%c option: "
3241                                     "contains single ':'",
3242                                     (int)(s - start), start, option);
3243             end = s + strlen(s);
3244             if (*s != '=') {
3245                 sv_catpvn(sv, start, end - start);
3246                 if (option == 'm') {
3247                     if (*s != '\0')
3248                         Perl_croak(aTHX_ "Can't use '%c' after -mname", *s);
3249                     sv_catpvs( sv, " ()");
3250                 }
3251             } else {
3252                 sv_catpvn(sv, start, s-start);
3253                 /* Use NUL as q''-delimiter.  */
3254                 sv_catpvs(sv, " split(/,/,q\0");
3255                 ++s;
3256                 sv_catpvn(sv, s, end - s);
3257                 sv_catpvs(sv,  "\0)");
3258             }
3259             s = end;
3260             Perl_av_create_and_push(aTHX_ &PL_preambleav, sv);
3261         }
3262         else
3263             Perl_croak(aTHX_ "Missing argument to -%c", option);
3264         return s;
3265     case 'n':
3266         PL_minus_n = TRUE;
3267         s++;
3268         return s;
3269     case 'p':
3270         PL_minus_p = TRUE;
3271         s++;
3272         return s;
3273     case 's':
3274         forbid_setid('s', FALSE);
3275         PL_doswitches = TRUE;
3276         s++;
3277         return s;
3278     case 't':
3279         if (!PL_tainting)
3280             TOO_LATE_FOR('t');
3281         s++;
3282         return s;
3283     case 'T':
3284         if (!PL_tainting)
3285             TOO_LATE_FOR('T');
3286         s++;
3287         return s;
3288     case 'u':
3289 #ifdef MACOS_TRADITIONAL
3290         Perl_croak(aTHX_ "Believe me, you don't want to use \"-u\" on a Macintosh");
3291 #endif
3292         PL_do_undump = TRUE;
3293         s++;
3294         return s;
3295     case 'U':
3296         PL_unsafe = TRUE;
3297         s++;
3298         return s;
3299     case 'v':
3300         if (!sv_derived_from(PL_patchlevel, "version"))
3301             upg_version(PL_patchlevel, TRUE);
3302 #if !defined(DGUX)
3303         PerlIO_printf(PerlIO_stdout(),
3304                 Perl_form(aTHX_ "\nThis is perl, %"SVf
3305 #ifdef PERL_PATCHNUM
3306                           " DEVEL" STRINGIFY(PERL_PATCHNUM)
3307 #endif
3308                           " built for %s",
3309                           SVfARG(vstringify(PL_patchlevel)),
3310                           ARCHNAME));
3311 #else /* DGUX */
3312 /* Adjust verbose output as in the perl that ships with the DG/UX OS from EMC */
3313         PerlIO_printf(PerlIO_stdout(),
3314                 Perl_form(aTHX_ "\nThis is perl, %"SVf"\n",
3315                     SVfARG(vstringify(PL_patchlevel))));
3316         PerlIO_printf(PerlIO_stdout(),
3317                         Perl_form(aTHX_ "        built under %s at %s %s\n",
3318                                         OSNAME, __DATE__, __TIME__));
3319         PerlIO_printf(PerlIO_stdout(),
3320                         Perl_form(aTHX_ "        OS Specific Release: %s\n",
3321                                         OSVERS));
3322 #endif /* !DGUX */
3323
3324 #if defined(LOCAL_PATCH_COUNT)
3325         if (LOCAL_PATCH_COUNT > 0)
3326             PerlIO_printf(PerlIO_stdout(),
3327                           "\n(with %d registered patch%s, "
3328                           "see perl -V for more detail)",
3329                           LOCAL_PATCH_COUNT,
3330                           (LOCAL_PATCH_COUNT!=1) ? "es" : "");
3331 #endif
3332
3333         PerlIO_printf(PerlIO_stdout(),
3334                       "\n\nCopyright 1987-2007, Larry Wall\n");
3335 #ifdef MACOS_TRADITIONAL
3336         PerlIO_printf(PerlIO_stdout(),
3337                       "\nMac OS port Copyright 1991-2002, Matthias Neeracher;\n"
3338                       "maintained by Chris Nandor\n");
3339 #endif
3340 #ifdef MSDOS
3341         PerlIO_printf(PerlIO_stdout(),
3342                       "\nMS-DOS port Copyright (c) 1989, 1990, Diomidis Spinellis\n");
3343 #endif
3344 #ifdef DJGPP
3345         PerlIO_printf(PerlIO_stdout(),
3346                       "djgpp v2 port (jpl5003c) by Hirofumi Watanabe, 1996\n"
3347                       "djgpp v2 port (perl5004+) by Laszlo Molnar, 1997-1999\n");
3348 #endif
3349 #ifdef OS2
3350         PerlIO_printf(PerlIO_stdout(),
3351                       "\n\nOS/2 port Copyright (c) 1990, 1991, Raymond Chen, Kai Uwe Rommel\n"
3352                       "Version 5 port Copyright (c) 1994-2002, Andreas Kaiser, Ilya Zakharevich\n");
3353 #endif
3354 #ifdef atarist
3355         PerlIO_printf(PerlIO_stdout(),
3356                       "atariST series port, ++jrb  bammi@cadence.com\n");
3357 #endif
3358 #ifdef __BEOS__
3359         PerlIO_printf(PerlIO_stdout(),
3360                       "BeOS port Copyright Tom Spindler, 1997-1999\n");
3361 #endif
3362 #ifdef MPE
3363         PerlIO_printf(PerlIO_stdout(),
3364                       "MPE/iX port Copyright by Mark Klein and Mark Bixby, 1996-2003\n");
3365 #endif
3366 #ifdef OEMVS
3367         PerlIO_printf(PerlIO_stdout(),
3368                       "MVS (OS390) port by Mortice Kern Systems, 1997-1999\n");
3369 #endif
3370 #ifdef __VOS__
3371         PerlIO_printf(PerlIO_stdout(),
3372                       "Stratus VOS port by Paul.Green@stratus.com, 1997-2002\n");
3373 #endif
3374 #ifdef __OPEN_VM
3375         PerlIO_printf(PerlIO_stdout(),
3376                       "VM/ESA port by Neale Ferguson, 1998-1999\n");
3377 #endif
3378 #ifdef POSIX_BC
3379         PerlIO_printf(PerlIO_stdout(),
3380                       "BS2000 (POSIX) port by Start Amadeus GmbH, 1998-1999\n");
3381 #endif
3382 #ifdef __MINT__
3383         PerlIO_printf(PerlIO_stdout(),
3384                       "MiNT port by Guido Flohr, 1997-1999\n");
3385 #endif
3386 #ifdef EPOC
3387         PerlIO_printf(PerlIO_stdout(),
3388                       "EPOC port by Olaf Flebbe, 1999-2002\n");
3389 #endif
3390 #ifdef UNDER_CE
3391         PerlIO_printf(PerlIO_stdout(),"WINCE port by Rainer Keuchel, 2001-2002\n");
3392         PerlIO_printf(PerlIO_stdout(),"Built on " __DATE__ " " __TIME__ "\n\n");
3393         wce_hitreturn();
3394 #endif
3395 #ifdef __SYMBIAN32__
3396         PerlIO_printf(PerlIO_stdout(),
3397                       "Symbian port by Nokia, 2004-2005\n");
3398 #endif
3399 #ifdef BINARY_BUILD_NOTICE
3400         BINARY_BUILD_NOTICE;
3401 #endif
3402         PerlIO_printf(PerlIO_stdout(),
3403                       "\n\
3404 Perl may be copied only under the terms of either the Artistic License or the\n\
3405 GNU General Public License, which may be found in the Perl 5 source kit.\n\n\
3406 Complete documentation for Perl, including FAQ lists, should be found on\n\
3407 this system using \"man perl\" or \"perldoc perl\".  If you have access to the\n\
3408 Internet, point your browser at http://www.perl.org/, the Perl Home Page.\n\n");
3409         my_exit(0);
3410     case 'w':
3411         if (! (PL_dowarn & G_WARN_ALL_MASK)) {
3412             PL_dowarn |= G_WARN_ON;
3413         }
3414         s++;
3415         return s;
3416     case 'W':
3417         PL_dowarn = G_WARN_ALL_ON|G_WARN_ON;
3418         if (!specialWARN(PL_compiling.cop_warnings))
3419             PerlMemShared_free(PL_compiling.cop_warnings);
3420         PL_compiling.cop_warnings = pWARN_ALL ;
3421         s++;
3422         return s;
3423     case 'X':
3424         PL_dowarn = G_WARN_ALL_OFF;
3425         if (!specialWARN(PL_compiling.cop_warnings))
3426             PerlMemShared_free(PL_compiling.cop_warnings);
3427         PL_compiling.cop_warnings = pWARN_NONE ;
3428         s++;
3429         return s;
3430     case '*':
3431     case ' ':
3432         if (s[1] == '-')        /* Additional switches on #! line. */
3433             return s+2;
3434         break;
3435     case '-':
3436     case 0:
3437 #if defined(WIN32) || !defined(PERL_STRICT_CR)
3438     case '\r':
3439 #endif
3440     case '\n':
3441     case '\t':
3442         break;
3443 #ifdef ALTERNATE_SHEBANG
3444     case 'S':                   /* OS/2 needs -S on "extproc" line. */
3445         break;
3446 #endif
3447     default:
3448         Perl_croak(aTHX_ "Can't emulate -%.1s on #! line",s);
3449     }
3450     return NULL;
3451 }
3452
3453 /* compliments of Tom Christiansen */
3454
3455 /* unexec() can be found in the Gnu emacs distribution */
3456 /* Known to work with -DUNEXEC and using unexelf.c from GNU emacs-20.2 */
3457
3458 void
3459 Perl_my_unexec(pTHX)
3460 {
3461     PERL_UNUSED_CONTEXT;
3462 #ifdef UNEXEC
3463     SV *    prog = newSVpv(BIN_EXP, 0);
3464     SV *    file = newSVpv(PL_origfilename, 0);
3465     int    status = 1;
3466     extern int etext;
3467
3468     sv_catpvs(prog, "/perl");
3469     sv_catpvs(file, ".perldump");
3470
3471     unexec(SvPVX(file), SvPVX(prog), &etext, sbrk(0), 0);
3472     /* unexec prints msg to stderr in case of failure */
3473     PerlProc_exit(status);
3474 #else
3475 #  ifdef VMS
3476 #    include <lib$routines.h>
3477      lib$signal(SS$_DEBUG);  /* ssdef.h #included from vmsish.h */
3478 #  elif defined(WIN32) || defined(__CYGWIN__)
3479     Perl_croak(aTHX_ "dump is not supported");
3480 #  else
3481     ABORT();            /* for use with undump */
3482 #  endif
3483 #endif
3484 }
3485
3486 /* initialize curinterp */
3487 STATIC void
3488 S_init_interp(pTHX)
3489 {
3490     dVAR;
3491 #ifdef MULTIPLICITY
3492 #  define PERLVAR(var,type)
3493 #  define PERLVARA(var,n,type)
3494 #  if defined(PERL_IMPLICIT_CONTEXT)
3495 #    define PERLVARI(var,type,init)             aTHX->var = init;
3496 #    define PERLVARIC(var,type,init)    aTHX->var = init;
3497 #  else
3498 #    define PERLVARI(var,type,init)     PERL_GET_INTERP->var = init;
3499 #    define PERLVARIC(var,type,init)    PERL_GET_INTERP->var = init;
3500 #  endif
3501 #  include "intrpvar.h"
3502 #  undef PERLVAR
3503 #  undef PERLVARA
3504 #  undef PERLVARI
3505 #  undef PERLVARIC
3506 #else
3507 #  define PERLVAR(var,type)
3508 #  define PERLVARA(var,n,type)
3509 #  define PERLVARI(var,type,init)       PL_##var = init;
3510 #  define PERLVARIC(var,type,init)      PL_##var = init;
3511 #  include "intrpvar.h"
3512 #  undef PERLVAR
3513 #  undef PERLVARA
3514 #  undef PERLVARI
3515 #  undef PERLVARIC
3516 #endif
3517
3518     /* As these are inside a structure, PERLVARI isn't capable of initialising
3519        them  */
3520     PL_reg_oldcurpm = PL_reg_curpm = NULL;
3521     PL_reg_poscache = PL_reg_starttry = NULL;
3522 }
3523
3524 STATIC void
3525 S_init_main_stash(pTHX)
3526 {
3527     dVAR;
3528     GV *gv;
3529
3530     PL_curstash = PL_defstash = newHV();
3531     /* We know that the string "main" will be in the global shared string
3532        table, so it's a small saving to use it rather than allocate another
3533        8 bytes.  */
3534     PL_curstname = newSVpvs_share("main");
3535     gv = gv_fetchpvs("main::", GV_ADD|GV_NOTQUAL, SVt_PVHV);
3536     /* If we hadn't caused another reference to "main" to be in the shared
3537        string table above, then it would be worth reordering these two,
3538        because otherwise all we do is delete "main" from it as a consequence
3539        of the SvREFCNT_dec, only to add it again with hv_name_set */
3540     SvREFCNT_dec(GvHV(gv));
3541     hv_name_set(PL_defstash, "main", 4, 0);
3542     GvHV(gv) = (HV*)SvREFCNT_inc_simple(PL_defstash);
3543     SvREADONLY_on(gv);
3544     PL_incgv = gv_HVadd(gv_AVadd(gv_fetchpvs("INC", GV_ADD|GV_NOTQUAL,
3545                                              SVt_PVAV)));
3546     SvREFCNT_inc_simple_void(PL_incgv); /* Don't allow it to be freed */
3547     GvMULTI_on(PL_incgv);
3548     PL_hintgv = gv_fetchpvs("\010", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^H */
3549     GvMULTI_on(PL_hintgv);
3550     PL_defgv = gv_fetchpvs("_", GV_ADD|GV_NOTQUAL, SVt_PVAV);
3551     SvREFCNT_inc_simple_void(PL_defgv);
3552     PL_errgv = gv_HVadd(gv_fetchpvs("@", GV_ADD|GV_NOTQUAL, SVt_PV));
3553     SvREFCNT_inc_simple_void(PL_errgv);
3554     GvMULTI_on(PL_errgv);
3555     PL_replgv = gv_fetchpvs("\022", GV_ADD|GV_NOTQUAL, SVt_PV); /* ^R */
3556     GvMULTI_on(PL_replgv);
3557     (void)Perl_form(aTHX_ "%240s","");  /* Preallocate temp - for immediate signals. */
3558 #ifdef PERL_DONT_CREATE_GVSV
3559     gv_SVadd(PL_errgv);
3560 #endif
3561     sv_grow(ERRSV, 240);        /* Preallocate - for immediate signals. */
3562     sv_setpvn(ERRSV, "", 0);
3563     PL_curstash = PL_defstash;
3564     CopSTASH_set(&PL_compiling, PL_defstash);
3565     PL_debstash = GvHV(gv_fetchpvs("DB::", GV_ADDMULTI, SVt_PVHV));
3566     PL_globalstash = GvHV(gv_fetchpvs("CORE::GLOBAL::", GV_ADDMULTI,
3567                                       SVt_PVHV));
3568     /* We must init $/ before switches are processed. */
3569     sv_setpvn(get_sv("/", TRUE), "\n", 1);
3570 }
3571
3572 STATIC int
3573 S_open_script(pTHX_ const char *scriptname, bool dosearch,
3574               bool *suidscript, PerlIO **rsfpp)
3575 {
3576     int fdscript = -1;
3577     dVAR;
3578
3579     PERL_ARGS_ASSERT_OPEN_SCRIPT;
3580
3581     if (PL_e_script) {
3582         PL_origfilename = savepvs("-e");
3583     }
3584     else {
3585         /* if find_script() returns, it returns a malloc()-ed value */
3586         scriptname = PL_origfilename = find_script(scriptname, dosearch, NULL, 1);
3587
3588         if (strnEQ(scriptname, "/dev/fd/", 8) && isDIGIT(scriptname[8]) ) {
3589             const char *s = scriptname + 8;
3590             fdscript = atoi(s);
3591             while (isDIGIT(*s))
3592                 s++;
3593             if (*s) {
3594                 /* PSz 18 Feb 04
3595                  * Tell apart "normal" usage of fdscript, e.g.
3596                  * with bash on FreeBSD:
3597                  *   perl <( echo '#!perl -DA'; echo 'print "$0\n"')
3598                  * from usage in suidperl.
3599                  * Does any "normal" usage leave garbage after the number???
3600                  * Is it a mistake to use a similar /dev/fd/ construct for
3601                  * suidperl?
3602                  */
3603                 *suidscript = TRUE;
3604                 /* PSz 20 Feb 04  
3605                  * Be supersafe and do some sanity-checks.
3606                  * Still, can we be sure we got the right thing?
3607                  */
3608                 if (*s != '/') {
3609                     Perl_croak(aTHX_ "Wrong syntax (suid) fd script name \"%s\"\n", s);
3610                 }
3611                 if (! *(s+1)) {
3612                     Perl_croak(aTHX_ "Missing (suid) fd script name\n");
3613                 }
3614                 scriptname = savepv(s + 1);
3615                 Safefree(PL_origfilename);
3616                 PL_origfilename = (char *)scriptname;
3617             }
3618         }
3619     }
3620
3621     CopFILE_free(PL_curcop);
3622     CopFILE_set(PL_curcop, PL_origfilename);
3623     if (*PL_origfilename == '-' && PL_origfilename[1] == '\0')
3624         scriptname = (char *)"";
3625     if (fdscript >= 0) {
3626         *rsfpp = PerlIO_fdopen(fdscript,PERL_SCRIPT_MODE);
3627 #       if defined(HAS_FCNTL) && defined(F_SETFD)
3628             if (*rsfpp)
3629                 /* ensure close-on-exec */
3630                 fcntl(PerlIO_fileno(*rsfpp),F_SETFD,1);
3631 #       endif
3632     }
3633 #ifdef IAMSUID
3634     else {
3635         Perl_croak(aTHX_ "sperl needs fd script\n"
3636                    "You should not call sperl directly; do you need to "
3637                    "change a #! line\nfrom sperl to perl?\n");
3638
3639 /* PSz 11 Nov 03
3640  * Do not open (or do other fancy stuff) while setuid.
3641  * Perl does the open, and hands script to suidperl on a fd;
3642  * suidperl only does some checks, sets up UIDs and re-execs
3643  * perl with that fd as it has always done.
3644  */
3645     }
3646     if (*suidscript) {
3647         Perl_croak(aTHX_ "suidperl needs (suid) fd script\n");
3648     }
3649 #else /* IAMSUID */
3650     else if (!*scriptname) {
3651         forbid_setid(0, *suidscript);
3652         *rsfpp = PerlIO_stdin();
3653     }
3654     else {
3655 #ifdef FAKE_BIT_BUCKET
3656         /* This hack allows one not to have /dev/null (or BIT_BUCKET as it
3657          * is called) and still have the "-e" work.  (Believe it or not,
3658          * a /dev/null is required for the "-e" to work because source
3659          * filter magic is used to implement it. ) This is *not* a general
3660          * replacement for a /dev/null.  What we do here is create a temp
3661          * file (an empty file), open up that as the script, and then
3662          * immediately close and unlink it.  Close enough for jazz. */ 
3663 #define FAKE_BIT_BUCKET_PREFIX "/tmp/perlnull-"
3664 #define FAKE_BIT_BUCKET_SUFFIX "XXXXXXXX"
3665 #define FAKE_BIT_BUCKET_TEMPLATE FAKE_BIT_BUCKET_PREFIX FAKE_BIT_BUCKET_SUFFIX
3666         char tmpname[sizeof(FAKE_BIT_BUCKET_TEMPLATE)] = {
3667             FAKE_BIT_BUCKET_TEMPLATE
3668         };
3669         const char * const err = "Failed to create a fake bit bucket";
3670         if (strEQ(scriptname, BIT_BUCKET)) {
3671 #ifdef HAS_MKSTEMP /* Hopefully mkstemp() is safe here. */
3672             int tmpfd = mkstemp(tmpname);
3673             if (tmpfd > -1) {
3674                 scriptname = tmpname;
3675                 close(tmpfd);
3676             } else
3677                 Perl_croak(aTHX_ err);
3678 #else
3679 #  ifdef HAS_MKTEMP
3680             scriptname = mktemp(tmpname);
3681             if (!scriptname)
3682                 Perl_croak(aTHX_ err);
3683 #  endif
3684 #endif
3685         }
3686 #endif
3687         *rsfpp = PerlIO_open(scriptname,PERL_SCRIPT_MODE);
3688 #ifdef FAKE_BIT_BUCKET
3689         if (memEQ(scriptname, FAKE_BIT_BUCKET_PREFIX,
3690                   sizeof(FAKE_BIT_BUCKET_PREFIX) - 1)
3691             && strlen(scriptname) == sizeof(tmpname) - 1) {
3692             unlink(scriptname);
3693         }
3694         scriptname = BIT_BUCKET;
3695 #endif
3696 #       if defined(HAS_FCNTL) && defined(F_SETFD)
3697             if (*rsfpp)
3698                 /* ensure close-on-exec */
3699                 fcntl(PerlIO_fileno(*rsfpp),F_SETFD,1);
3700 #       endif
3701     }
3702 #endif /* IAMSUID */
3703     if (!*rsfpp) {
3704         /* PSz 16 Sep 03  Keep neat error message */
3705         if (PL_e_script)
3706             Perl_croak(aTHX_ "Can't open "BIT_BUCKET": %s\n", Strerror(errno));
3707         else
3708             Perl_croak(aTHX_ "Can't open perl script \"%s\": %s\n",
3709                     CopFILE(PL_curcop), Strerror(errno));
3710     }
3711     return fdscript;
3712 }
3713
3714 /* Mention
3715  * I_SYSSTATVFS HAS_FSTATVFS
3716  * I_SYSMOUNT
3717  * I_STATFS     HAS_FSTATFS     HAS_GETFSSTAT
3718  * I_MNTENT     HAS_GETMNTENT   HAS_HASMNTOPT
3719  * here so that metaconfig picks them up. */
3720
3721 #ifdef IAMSUID
3722 STATIC int
3723 S_fd_on_nosuid_fs(pTHX_ int fd)
3724 {
3725 /* PSz 27 Feb 04
3726  * We used to do this as "plain" user (after swapping UIDs with setreuid);
3727  * but is needed also on machines without setreuid.
3728  * Seems safe enough to run as root.
3729  */
3730     int check_okay = 0; /* able to do all the required sys/libcalls */
3731     int on_nosuid  = 0; /* the fd is on a nosuid fs */
3732     /* PSz 12 Nov 03
3733      * Need to check noexec also: nosuid might not be set, the average
3734      * sysadmin would say that nosuid is irrelevant once he sets noexec.
3735      */
3736     int on_noexec  = 0; /* the fd is on a noexec fs */
3737
3738 /*
3739  * Preferred order: fstatvfs(), fstatfs(), ustat()+getmnt(), getmntent().
3740  * fstatvfs() is UNIX98.
3741  * fstatfs() is 4.3 BSD.
3742  * ustat()+getmnt() is pre-4.3 BSD.
3743  * getmntent() is O(number-of-mounted-filesystems) and can hang on
3744  * an irrelevant filesystem while trying to reach the right one.
3745  */
3746
3747 #undef FD_ON_NOSUID_CHECK_OKAY  /* found the syscalls to do the check? */
3748
3749 #   if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3750         defined(HAS_FSTATVFS)
3751 #   define FD_ON_NOSUID_CHECK_OKAY
3752     struct statvfs stfs;
3753
3754     check_okay = fstatvfs(fd, &stfs) == 0;
3755     on_nosuid  = check_okay && (stfs.f_flag  & ST_NOSUID);
3756 #ifdef ST_NOEXEC
3757     /* ST_NOEXEC certainly absent on AIX 5.1, and doesn't seem to be documented
3758        on platforms where it is present.  */
3759     on_noexec  = check_okay && (stfs.f_flag  & ST_NOEXEC);
3760 #endif
3761 #   endif /* fstatvfs */
3762
3763 #   if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3764         defined(PERL_MOUNT_NOSUID)      && \
3765         defined(PERL_MOUNT_NOEXEC)      && \
3766         defined(HAS_FSTATFS)            && \
3767         defined(HAS_STRUCT_STATFS)      && \
3768         defined(HAS_STRUCT_STATFS_F_FLAGS)
3769 #   define FD_ON_NOSUID_CHECK_OKAY
3770     struct statfs  stfs;
3771
3772     check_okay = fstatfs(fd, &stfs)  == 0;
3773     on_nosuid  = check_okay && (stfs.f_flags & PERL_MOUNT_NOSUID);
3774     on_noexec  = check_okay && (stfs.f_flags & PERL_MOUNT_NOEXEC);
3775 #   endif /* fstatfs */
3776
3777 #   if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3778         defined(PERL_MOUNT_NOSUID)      && \
3779         defined(PERL_MOUNT_NOEXEC)      && \
3780         defined(HAS_FSTAT)              && \
3781         defined(HAS_USTAT)              && \
3782         defined(HAS_GETMNT)             && \
3783         defined(HAS_STRUCT_FS_DATA)     && \
3784         defined(NOSTAT_ONE)
3785 #   define FD_ON_NOSUID_CHECK_OKAY
3786     Stat_t fdst;
3787
3788     if (fstat(fd, &fdst) == 0) {
3789         struct ustat us;
3790         if (ustat(fdst.st_dev, &us) == 0) {
3791             struct fs_data fsd;
3792             /* NOSTAT_ONE here because we're not examining fields which
3793              * vary between that case and STAT_ONE. */
3794             if (getmnt((int*)0, &fsd, (int)0, NOSTAT_ONE, us.f_fname) == 0) {
3795                 size_t cmplen = sizeof(us.f_fname);
3796                 if (sizeof(fsd.fd_req.path) < cmplen)
3797                     cmplen = sizeof(fsd.fd_req.path);
3798                 if (strnEQ(fsd.fd_req.path, us.f_fname, cmplen) &&
3799                     fdst.st_dev == fsd.fd_req.dev) {
3800                     check_okay = 1;
3801                     on_nosuid = fsd.fd_req.flags & PERL_MOUNT_NOSUID;
3802                     on_noexec = fsd.fd_req.flags & PERL_MOUNT_NOEXEC;
3803                 }
3804             }
3805         }
3806     }
3807 #   endif /* fstat+ustat+getmnt */
3808
3809 #   if !defined(FD_ON_NOSUID_CHECK_OKAY) && \
3810         defined(HAS_GETMNTENT)          && \
3811         defined(HAS_HASMNTOPT)          && \
3812         defined(MNTOPT_NOSUID)          && \
3813         defined(MNTOPT_NOEXEC)
3814 #   define FD_ON_NOSUID_CHECK_OKAY
3815     FILE                *mtab = fopen("/etc/mtab", "r");
3816     struct mntent       *entry;
3817     Stat_t              stb, fsb;
3818
3819     if (mtab && (fstat(fd, &stb) == 0)) {
3820         while (entry = getmntent(mtab)) {
3821             if (stat(entry->mnt_dir, &fsb) == 0
3822                 && fsb.st_dev == stb.st_dev)
3823             {
3824                 /* found the filesystem */
3825                 check_okay = 1;
3826                 if (hasmntopt(entry, MNTOPT_NOSUID))
3827                     on_nosuid = 1;
3828                 if (hasmntopt(entry, MNTOPT_NOEXEC))
3829                     on_noexec = 1;
3830                 break;
3831             } /* A single fs may well fail its stat(). */
3832         }
3833     }
3834     if (mtab)
3835         fclose(mtab);
3836 #   endif /* getmntent+hasmntopt */
3837
3838     if (!check_okay)
3839         Perl_croak(aTHX_ "Can't check filesystem of script \"%s\" for nosuid/noexec", PL_origfilename);
3840     if (on_nosuid)
3841         Perl_croak(aTHX_ "Setuid script \"%s\" on nosuid filesystem", PL_origfilename);
3842     if (on_noexec)
3843         Perl_croak(aTHX_ "Setuid script \"%s\" on noexec filesystem", PL_origfilename);
3844     return ((!check_okay) || on_nosuid || on_noexec);
3845 }
3846 #endif /* IAMSUID */
3847
3848 #ifdef DOSUID
3849 STATIC void
3850 S_validate_suid(pTHX_ const char *validarg,
3851 #  ifndef IAMSUID
3852                 const char *scriptname,
3853 #  endif
3854                 int fdscript,
3855 #  ifdef IAMSUID
3856                 bool suidscript,
3857 #  endif
3858                 SV *linestr_sv, PerlIO *rsfp)
3859 {
3860     dVAR;
3861     const char *s, *s2;
3862
3863     PERL_ARGS_ASSERT_VALIDATE_SUID;
3864
3865     /* do we need to emulate setuid on scripts? */
3866
3867     /* This code is for those BSD systems that have setuid #! scripts disabled
3868      * in the kernel because of a security problem.  Merely defining DOSUID
3869      * in perl will not fix that problem, but if you have disabled setuid
3870      * scripts in the kernel, this will attempt to emulate setuid and setgid
3871      * on scripts that have those now-otherwise-useless bits set.  The setuid
3872      * root version must be called suidperl or sperlN.NNN.  If regular perl
3873      * discovers that it has opened a setuid script, it calls suidperl with
3874      * the same argv that it had.  If suidperl finds that the script it has
3875      * just opened is NOT setuid root, it sets the effective uid back to the
3876      * uid.  We don't just make perl setuid root because that loses the
3877      * effective uid we had before invoking perl, if it was different from the
3878      * uid.
3879      * PSz 27 Feb 04
3880      * Description/comments above do not match current workings:
3881      *   suidperl must be hardlinked to sperlN.NNN (that is what we exec);
3882      *   suidperl called with script open and name changed to /dev/fd/N/X;
3883      *   suidperl croaks if script is not setuid;
3884      *   making perl setuid would be a huge security risk (and yes, that
3885      *     would lose any euid we might have had).
3886      *
3887      * DOSUID must be defined in both perl and suidperl, and IAMSUID must
3888      * be defined in suidperl only.  suidperl must be setuid root.  The
3889      * Configure script will set this up for you if you want it.
3890      */
3891
3892     if (PerlLIO_fstat(PerlIO_fileno(rsfp),&PL_statbuf) < 0)     /* normal stat is insecure */
3893         Perl_croak(aTHX_ "Can't stat script \"%s\"",PL_origfilename);
3894     if (PL_statbuf.st_mode & (S_ISUID|S_ISGID)) {
3895         I32 len;
3896         const char *linestr;
3897         const char *s_end;
3898
3899 #  ifdef IAMSUID
3900         if (fdscript < 0 || !suidscript)
3901             Perl_croak(aTHX_ "Need (suid) fdscript in suidperl\n");     /* We already checked this */
3902         /* PSz 11 Nov 03
3903          * Since the script is opened by perl, not suidperl, some of these
3904          * checks are superfluous. Leaving them in probably does not lower
3905          * security(?!).
3906          */
3907         /* PSz 27 Feb 04
3908          * Do checks even for systems with no HAS_SETREUID.
3909          * We used to swap, then re-swap UIDs with
3910 #    ifdef HAS_SETREUID
3911             if (setreuid(PL_euid,PL_uid) < 0
3912                 || PerlProc_getuid() != PL_euid || PerlProc_geteuid() != PL_uid)
3913                 Perl_croak(aTHX_ "Can't swap uid and euid");
3914 #    endif
3915 #    ifdef HAS_SETREUID
3916             if (setreuid(PL_uid,PL_euid) < 0
3917                 || PerlProc_getuid() != PL_uid || PerlProc_geteuid() != PL_euid)
3918                 Perl_croak(aTHX_ "Can't reswap uid and euid");
3919 #    endif
3920          */
3921
3922         /* On this access check to make sure the directories are readable,
3923          * there is actually a small window that the user could use to make
3924          * filename point to an accessible directory.  So there is a faint
3925          * chance that someone could execute a setuid script down in a
3926          * non-accessible directory.  I don't know what to do about that.
3927          * But I don't think it's too important.  The manual lies when
3928          * it says access() is useful in setuid programs.
3929          * 
3930          * So, access() is pretty useless... but not harmful... do anyway.
3931          */
3932         if (PerlLIO_access(CopFILE(PL_curcop),1)) { /*double check*/
3933             Perl_croak(aTHX_ "Can't access() script\n");
3934         }
3935
3936         /* If we can swap euid and uid, then we can determine access rights
3937          * with a simple stat of the file, and then compare device and
3938          * inode to make sure we did stat() on the same file we opened.
3939          * Then we just have to make sure he or she can execute it.
3940          * 
3941          * PSz 24 Feb 04
3942          * As the script is opened by perl, not suidperl, we do not need to
3943          * care much about access rights.
3944          * 
3945          * The 'script changed' check is needed, or we can get lied to
3946          * about $0 with e.g.
3947          *  suidperl /dev/fd/4//bin/x 4<setuidscript
3948          * Without HAS_SETREUID, is it safe to stat() as root?
3949          * 
3950          * Are there any operating systems that pass /dev/fd/xxx for setuid
3951          * scripts, as suggested/described in perlsec(1)? Surely they do not
3952          * pass the script name as we do, so the "script changed" test would
3953          * fail for them... but we never get here with
3954          * SETUID_SCRIPTS_ARE_SECURE_NOW defined.
3955          * 
3956          * This is one place where we must "lie" about return status: not
3957          * say if the stat() failed. We are doing this as root, and could
3958          * be tricked into reporting existence or not of files that the
3959          * "plain" user cannot even see.
3960          */
3961         {
3962             Stat_t tmpstatbuf;
3963             if (PerlLIO_stat(CopFILE(PL_curcop),&tmpstatbuf) < 0 ||
3964                 tmpstatbuf.st_dev != PL_statbuf.st_dev ||
3965                 tmpstatbuf.st_ino != PL_statbuf.st_ino) {
3966                 Perl_croak(aTHX_ "Setuid script changed\n");
3967             }
3968
3969         }
3970         if (!cando(S_IXUSR,FALSE,&PL_statbuf))          /* can real uid exec? */
3971             Perl_croak(aTHX_ "Real UID cannot exec script\n");
3972
3973         /* PSz 27 Feb 04
3974          * We used to do this check as the "plain" user (after swapping
3975          * UIDs). But the check for nosuid and noexec filesystem is needed,
3976          * and should be done even without HAS_SETREUID. (Maybe those
3977          * operating systems do not have such mount options anyway...)
3978          * Seems safe enough to do as root.
3979          */
3980 #    if !defined(NO_NOSUID_CHECK)
3981         if (fd_on_nosuid_fs(PerlIO_fileno(rsfp))) {
3982             Perl_croak(aTHX_ "Setuid script on nosuid or noexec filesystem\n");
3983         }
3984 #    endif
3985 #  endif /* IAMSUID */
3986
3987         if (!S_ISREG(PL_statbuf.st_mode)) {
3988             Perl_croak(aTHX_ "Setuid script not plain file\n");
3989         }
3990         if (PL_statbuf.st_mode & S_IWOTH)
3991             Perl_croak(aTHX_ "Setuid/gid script is writable by world");
3992         PL_doswitches = FALSE;          /* -s is insecure in suid */
3993         /* PSz 13 Nov 03  But -s was caught elsewhere ... so unsetting it here is useless(?!) */
3994         CopLINE_inc(PL_curcop);
3995         if (sv_gets(linestr_sv, rsfp, 0) == NULL)
3996             Perl_croak(aTHX_ "No #! line");
3997         linestr = SvPV_nolen_const(linestr_sv);
3998         /* required even on Sys V */
3999         if (!*linestr || !linestr[1] || strnNE(linestr,"#!",2))
4000             Perl_croak(aTHX_ "No #! line");
4001         linestr += 2;
4002         s = linestr;
4003         /* PSz 27 Feb 04 */
4004         /* Sanity check on line length */
4005         s_end = s + strlen(s);
4006         if (s_end == s || (s_end - s) > 4000)
4007             Perl_croak(aTHX_ "Very long #! line");
4008         /* Allow more than a single space after #! */
4009         while (isSPACE(*s)) s++;
4010         /* Sanity check on buffer end */
4011         while ((*s) && !isSPACE(*s)) s++;
4012         for (s2 = s;  (s2 > linestr &&
4013                        (isDIGIT(s2[-1]) || s2[-1] == '.' || s2[-1] == '_'
4014                         || s2[-1] == '-'));  s2--) ;
4015         /* Sanity check on buffer start */
4016         if ( (s2-4 < linestr || strnNE(s2-4,"perl",4)) &&
4017               (s-9 < linestr || strnNE(s-9,"perl",4)) )
4018             Perl_croak(aTHX_ "Not a perl script");
4019         while (*s == ' ' || *s == '\t') s++;
4020         /*
4021          * #! arg must be what we saw above.  They can invoke it by
4022          * mentioning suidperl explicitly, but they may not add any strange
4023          * arguments beyond what #! says if they do invoke suidperl that way.
4024          */
4025         /*
4026          * The way validarg was set up, we rely on the kernel to start
4027          * scripts with argv[1] set to contain all #! line switches (the
4028          * whole line).
4029          */
4030         /*
4031          * Check that we got all the arguments listed in the #! line (not
4032          * just that there are no extraneous arguments). Might not matter
4033          * much, as switches from #! line seem to be acted upon (also), and
4034          * so may be checked and trapped in perl. But, security checks must
4035          * be done in suidperl and not deferred to perl. Note that suidperl
4036          * does not get around to parsing (and checking) the switches on
4037          * the #! line (but execs perl sooner).
4038          * Allow (require) a trailing newline (which may be of two
4039          * characters on some architectures?) (but no other trailing
4040          * whitespace).
4041          */
4042         len = strlen(validarg);
4043         if (strEQ(validarg," PHOOEY ") ||
4044             strnNE(s,validarg,len) || !isSPACE(s[len]) ||
4045             !((s_end - s) == len+1
4046               || ((s_end - s) == len+2 && isSPACE(s[len+1]))))
4047             Perl_croak(aTHX_ "Args must match #! line");
4048
4049 #  ifndef IAMSUID
4050         if (fdscript < 0 &&
4051             PL_euid != PL_uid && (PL_statbuf.st_mode & S_ISUID) &&
4052             PL_euid == PL_statbuf.st_uid)
4053             if (!PL_do_undump)
4054                 Perl_croak(aTHX_ "YOU HAVEN'T DISABLED SET-ID SCRIPTS IN THE KERNEL YET!\n\
4055 FIX YOUR KERNEL, OR PUT A C WRAPPER AROUND THIS SCRIPT!\n");
4056 #  endif /* IAMSUID */
4057
4058         if (fdscript < 0 &&
4059             PL_euid) {  /* oops, we're not the setuid root perl */
4060             /* PSz 18 Feb 04
4061              * When root runs a setuid script, we do not go through the same
4062              * steps of execing sperl and then perl with fd scripts, but
4063              * simply set up UIDs within the same perl invocation; so do
4064              * not have the same checks (on options, whatever) that we have
4065              * for plain users. No problem really: would have to be a script
4066              * that does not actually work for plain users; and if root is
4067              * foolish and can be persuaded to run such an unsafe script, he
4068              * might run also non-setuid ones, and deserves what he gets.
4069              * 
4070              * Or, we might drop the PL_euid check above (and rely just on
4071              * fdscript to avoid loops), and do the execs
4072              * even for root.
4073              */
4074 #  ifndef IAMSUID
4075             int which;
4076             /* PSz 11 Nov 03
4077              * Pass fd script to suidperl.
4078              * Exec suidperl, substituting fd script for scriptname.
4079              * Pass script name as "subdir" of fd, which perl will grok;
4080              * in fact will use that to distinguish this from "normal"
4081              * usage, see comments above.
4082              */
4083             PerlIO_rewind(rsfp);
4084             PerlLIO_lseek(PerlIO_fileno(rsfp),(Off_t)0,0);  /* just in case rewind didn't */
4085             /* PSz 27 Feb 04  Sanity checks on scriptname */
4086             if ((!scriptname) || (!*scriptname) ) {
4087                 Perl_croak(aTHX_ "No setuid script name\n");
4088             }
4089             if (*scriptname == '-') {
4090                 Perl_croak(aTHX_ "Setuid script name may not begin with dash\n");
4091                 /* Or we might confuse it with an option when replacing
4092                  * name in argument list, below (though we do pointer, not
4093                  * string, comparisons).
4094                  */
4095             }
4096             for (which = 1; PL_origargv[which] && PL_origargv[which] != scriptname; which++) ;
4097             if (!PL_origargv[which]) {
4098                 Perl_croak(aTHX_ "Can't change argv to have fd script\n");
4099             }
4100             PL_origargv[which] = savepv(Perl_form(aTHX_ "/dev/fd/%d/%s",
4101                                           PerlIO_fileno(rsfp), PL_origargv[which]));
4102 #    if defined(HAS_FCNTL) && defined(F_SETFD)
4103             fcntl(PerlIO_fileno(rsfp),F_SETFD,0);       /* ensure no close-on-exec */
4104 #    endif
4105             PERL_FPU_PRE_EXEC
4106             PerlProc_execv(Perl_form(aTHX_ "%s/sperl"PERL_FS_VER_FMT, BIN_EXP,
4107                                      (int)PERL_REVISION, (int)PERL_VERSION,
4108                                      (int)PERL_SUBVERSION), PL_origargv);
4109             PERL_FPU_POST_EXEC
4110 #  endif /* IAMSUID */
4111             Perl_croak(aTHX_ "Can't do setuid (cannot exec sperl)\n");
4112         }
4113
4114         if (PL_statbuf.st_mode & S_ISGID && PL_statbuf.st_gid != PL_egid) {
4115 /* PSz 26 Feb 04
4116  * This seems back to front: we try HAS_SETEGID first; if not available
4117  * then try HAS_SETREGID; as a last chance we try HAS_SETRESGID. May be OK
4118  * in the sense that we only want to set EGID; but are there any machines
4119  * with either of the latter, but not the former? Same with UID, later.
4120  */
4121 #  ifdef HAS_SETEGID
4122             (void)setegid(PL_statbuf.st_gid);
4123 #  else
4124 #    ifdef HAS_SETREGID
4125            (void)setregid((Gid_t)-1,PL_statbuf.st_gid);
4126 #    else
4127 #      ifdef HAS_SETRESGID
4128            (void)setresgid((Gid_t)-1,PL_statbuf.st_gid,(Gid_t)-1);
4129 #      else
4130             PerlProc_setgid(PL_statbuf.st_gid);
4131 #      endif
4132 #    endif
4133 #  endif
4134             if (PerlProc_getegid() != PL_statbuf.st_gid)
4135                 Perl_croak(aTHX_ "Can't do setegid!\n");
4136         }
4137         if (PL_statbuf.st_mode & S_ISUID) {
4138             if (PL_statbuf.st_uid != PL_euid)
4139 #  ifdef HAS_SETEUID
4140                 (void)seteuid(PL_statbuf.st_uid);       /* all that for this */
4141 #  else
4142 #    ifdef HAS_SETREUID
4143                 (void)setreuid((Uid_t)-1,PL_statbuf.st_uid);
4144 #    else
4145 #      ifdef HAS_SETRESUID
4146                 (void)setresuid((Uid_t)-1,PL_statbuf.st_uid,(Uid_t)-1);
4147 #      else
4148                 PerlProc_setuid(PL_statbuf.st_uid);
4149 #      endif
4150 #    endif
4151 #  endif
4152             if (PerlProc_geteuid() != PL_statbuf.st_uid)
4153                 Perl_croak(aTHX_ "Can't do seteuid!\n");
4154         }
4155         else if (PL_uid) {                      /* oops, mustn't run as root */
4156 #  ifdef HAS_SETEUID
4157           (void)seteuid((Uid_t)PL_uid);
4158 #  else
4159 #    ifdef HAS_SETREUID
4160           (void)setreuid((Uid_t)-1,(Uid_t)PL_uid);
4161 #    else
4162 #      ifdef HAS_SETRESUID
4163           (void)setresuid((Uid_t)-1,(Uid_t)PL_uid,(Uid_t)-1);
4164 #      else
4165           PerlProc_setuid((Uid_t)PL_uid);
4166 #      endif
4167 #    endif
4168 #  endif
4169             if (PerlProc_geteuid() != PL_uid)
4170                 Perl_croak(aTHX_ "Can't do seteuid!\n");
4171         }
4172         init_ids();
4173         if (!cando(S_IXUSR,TRUE,&PL_statbuf))
4174             Perl_croak(aTHX_ "Effective UID cannot exec script\n");     /* they can't do this */
4175     }
4176 #  ifdef IAMSUID
4177     else if (fdscript < 0 || !suidscript)
4178         /* PSz 13 Nov 03  Caught elsewhere, useless(?!) here */
4179         Perl_croak(aTHX_ "(suid) fdscript needed in suidperl\n");
4180     else {
4181 /* PSz 16 Sep 03  Keep neat error message */
4182         Perl_croak(aTHX_ "Script is not setuid/setgid in suidperl\n");
4183     }
4184
4185     /* We absolutely must clear out any saved ids here, so we */
4186     /* exec the real perl, substituting fd script for scriptname. */
4187     /* (We pass script name as "subdir" of fd, which perl will grok.) */
4188     /* 
4189      * It might be thought that using setresgid and/or setresuid (changed to
4190      * set the saved IDs) above might obviate the need to exec, and we could
4191      * go on to "do the perl thing".
4192      * 
4193      * Is there such a thing as "saved GID", and is that set for setuid (but
4194      * not setgid) execution like suidperl? Without exec, it would not be
4195      * cleared for setuid (but not setgid) scripts (or might need a dummy
4196      * setresgid).
4197      * 
4198      * We need suidperl to do the exact same argument checking that perl
4199      * does. Thus it cannot be very small; while it could be significantly
4200      * smaller, it is safer (simpler?) to make it essentially the same
4201      * binary as perl (but they are not identical). - Maybe could defer that
4202      * check to the invoked perl, and suidperl be a tiny wrapper instead;
4203      * but prefer to do thorough checks in suidperl itself. Such deferral
4204      * would make suidperl security rely on perl, a design no-no.
4205      * 
4206      * Setuid things should be short and simple, thus easy to understand and
4207      * verify. They should do their "own thing", without influence by
4208      * attackers. It may help if their internal execution flow is fixed,
4209      * regardless of platform: it may be best to exec anyway.
4210      * 
4211      * Suidperl should at least be conceptually simple: a wrapper only,
4212      * never to do any real perl. Maybe we should put
4213      * #ifdef IAMSUID
4214      *         Perl_croak(aTHX_ "Suidperl should never do real perl\n");
4215      * #endif
4216      * into the perly bits.
4217      */
4218     PerlIO_rewind(rsfp);
4219     PerlLIO_lseek(PerlIO_fileno(rsfp),(Off_t)0,0);  /* just in case rewind didn't */
4220     /* PSz 11 Nov 03
4221      * Keep original arguments: suidperl already has fd script.
4222      */
4223 #  if defined(HAS_FCNTL) && defined(F_SETFD)
4224     fcntl(PerlIO_fileno(rsfp),F_SETFD,0);       /* ensure no close-on-exec */
4225 #  endif
4226     PERL_FPU_PRE_EXEC
4227     PerlProc_execv(Perl_form(aTHX_ "%s/perl"PERL_FS_VER_FMT, BIN_EXP,
4228                              (int)PERL_REVISION, (int)PERL_VERSION,
4229                              (int)PERL_SUBVERSION), PL_origargv);/* try again */
4230     PERL_FPU_POST_EXEC
4231     Perl_croak(aTHX_ "Can't do setuid (suidperl cannot exec perl)\n");
4232 #  endif /* IAMSUID */
4233 }
4234
4235 #else /* !DOSUID */
4236
4237 #  ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
4238 /* Don't even need this function.  */
4239 #  else
4240 STATIC void
4241 S_validate_suid(pTHX_ PerlIO *rsfp)
4242 {
4243     PERL_ARGS_ASSERT_VALIDATE_SUID;
4244
4245     if (PL_euid != PL_uid || PL_egid != PL_gid) {       /* (suidperl doesn't exist, in fact) */
4246 #  ifndef SETUID_SCRIPTS_ARE_SECURE_NOW
4247         dVAR;
4248
4249         PerlLIO_fstat(PerlIO_fileno(rsfp),&PL_statbuf); /* may be either wrapped or real suid */
4250         if ((PL_euid != PL_uid && PL_euid == PL_statbuf.st_uid && PL_statbuf.st_mode & S_ISUID)
4251             ||
4252             (PL_egid != PL_gid && PL_egid == PL_statbuf.st_gid && PL_statbuf.st_mode & S_ISGID)
4253            )
4254             if (!PL_do_undump)
4255                 Perl_croak(aTHX_ "YOU HAVEN'T DISABLED SET-ID SCRIPTS IN THE KERNEL YET!\n\
4256 FIX YOUR KERNEL, PUT A C WRAPPER AROUND THIS SCRIPT, OR USE -u AND UNDUMP!\n");
4257 #  endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4258         /* not set-id, must be wrapped */
4259     }
4260 }
4261 #  endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4262 #endif /* DOSUID */
4263
4264 STATIC void
4265 S_find_beginning(pTHX_ SV* linestr_sv, PerlIO *rsfp)
4266 {
4267     dVAR;
4268     const char *s;
4269     register const char *s2;
4270 #ifdef MACOS_TRADITIONAL
4271     int maclines = 0;
4272 #endif
4273
4274     PERL_ARGS_ASSERT_FIND_BEGINNING;
4275
4276     /* skip forward in input to the real script? */
4277
4278 #ifdef MACOS_TRADITIONAL
4279     /* Since the Mac OS does not honor #! arguments for us, we do it ourselves */
4280
4281     while (PL_doextract || gMacPerl_AlwaysExtract) {
4282         if ((s = sv_gets(linestr_sv, rsfp, 0)) == NULL) {
4283             if (!gMacPerl_AlwaysExtract)
4284                 Perl_croak(aTHX_ "No Perl script found in input\n");
4285
4286             if (PL_doextract)                   /* require explicit override ? */
4287                 if (!OverrideExtract(PL_origfilename))
4288                     Perl_croak(aTHX_ "User aborted script\n");
4289                 else
4290                     PL_doextract = FALSE;
4291
4292             /* Pater peccavi, file does not have #! */
4293             PerlIO_rewind(rsfp);
4294
4295             break;
4296         }
4297 #else
4298     while (PL_doextract) {
4299         if ((s = sv_gets(linestr_sv, rsfp, 0)) == NULL)
4300             Perl_croak(aTHX_ "No Perl script found in input\n");
4301 #endif
4302         s2 = s;
4303         if (*s == '#' && s[1] == '!' && ((s = instr(s,"perl")) || (s = instr(s2,"PERL")))) {
4304             PerlIO_ungetc(rsfp, '\n');          /* to keep line count right */
4305             PL_doextract = FALSE;
4306             while (*s && !(isSPACE (*s) || *s == '#')) s++;
4307             s2 = s;
4308             while (*s == ' ' || *s == '\t') s++;
4309             if (*s++ == '-') {
4310                 while (isDIGIT(s2[-1]) || s2[-1] == '-' || s2[-1] == '.'
4311                        || s2[-1] == '_') s2--;
4312                 if (strnEQ(s2-4,"perl",4))
4313                     while ((s = moreswitches(s)))
4314                         ;
4315             }
4316 #ifdef MACOS_TRADITIONAL
4317             /* We are always searching for the #!perl line in MacPerl,
4318              * so if we find it, still keep the line count correct
4319              * by counting lines we already skipped over
4320              */
4321             for (; maclines > 0 ; maclines--)
4322                 PerlIO_ungetc(rsfp, '\n');
4323
4324             break;
4325
4326         /* gMacPerl_AlwaysExtract is false in MPW tool */
4327         } else if (gMacPerl_AlwaysExtract) {
4328             ++maclines;
4329 #endif
4330         }
4331     }
4332 }
4333
4334
4335 STATIC void
4336 S_init_ids(pTHX)
4337 {
4338     dVAR;
4339     PL_uid = PerlProc_getuid();
4340     PL_euid = PerlProc_geteuid();
4341     PL_gid = PerlProc_getgid();
4342     PL_egid = PerlProc_getegid();
4343 #ifdef VMS
4344     PL_uid |= PL_gid << 16;
4345     PL_euid |= PL_egid << 16;
4346 #endif
4347     /* Should not happen: */
4348     CHECK_MALLOC_TAINT(PL_uid && (PL_euid != PL_uid || PL_egid != PL_gid));
4349     PL_tainting |= (PL_uid && (PL_euid != PL_uid || PL_egid != PL_gid));
4350     /* BUG */
4351     /* PSz 27 Feb 04
4352      * Should go by suidscript, not uid!=euid: why disallow
4353      * system("ls") in scripts run from setuid things?
4354      * Or, is this run before we check arguments and set suidscript?
4355      * What about SETUID_SCRIPTS_ARE_SECURE_NOW: could we use fdscript then?
4356      * (We never have suidscript, can we be sure to have fdscript?)
4357      * Or must then go by UID checks? See comments in forbid_setid also.
4358      */
4359 }
4360
4361 /* This is used very early in the lifetime of the program,
4362  * before even the options are parsed, so PL_tainting has
4363  * not been initialized properly.  */
4364 bool
4365 Perl_doing_taint(int argc, char *argv[], char *envp[])
4366 {
4367 #ifndef PERL_IMPLICIT_SYS
4368     /* If we have PERL_IMPLICIT_SYS we can't call getuid() et alia
4369      * before we have an interpreter-- and the whole point of this
4370      * function is to be called at such an early stage.  If you are on
4371      * a system with PERL_IMPLICIT_SYS but you do have a concept of
4372      * "tainted because running with altered effective ids', you'll
4373      * have to add your own checks somewhere in here.  The two most
4374      * known samples of 'implicitness' are Win32 and NetWare, neither
4375      * of which has much of concept of 'uids'. */
4376     int uid  = PerlProc_getuid();
4377     int euid = PerlProc_geteuid();
4378     int gid  = PerlProc_getgid();
4379     int egid = PerlProc_getegid();
4380     (void)envp;
4381
4382 #ifdef VMS
4383     uid  |=  gid << 16;
4384     euid |= egid << 16;
4385 #endif
4386     if (uid && (euid != uid || egid != gid))
4387         return 1;
4388 #endif /* !PERL_IMPLICIT_SYS */
4389     /* This is a really primitive check; environment gets ignored only
4390      * if -T are the first chars together; otherwise one gets
4391      *  "Too late" message. */
4392     if ( argc > 1 && argv[1][0] == '-'
4393          && (argv[1][1] == 't' || argv[1][1] == 'T') )
4394         return 1;
4395     return 0;
4396 }
4397
4398 /* Passing the flag as a single char rather than a string is a slight space
4399    optimisation.  The only message that isn't /^-.$/ is
4400    "program input from stdin", which is substituted in place of '\0', which
4401    could never be a command line flag.  */
4402 STATIC void
4403 S_forbid_setid(pTHX_ const char flag, const bool suidscript) /* g */
4404 {
4405     dVAR;
4406     char string[3] = "-x";
4407     const char *message = "program input from stdin";
4408
4409     if (flag) {
4410         string[1] = flag;
4411         message = string;
4412     }
4413
4414 #ifdef SETUID_SCRIPTS_ARE_SECURE_NOW
4415     if (PL_euid != PL_uid)
4416         Perl_croak(aTHX_ "No %s allowed while running setuid", message);
4417     if (PL_egid != PL_gid)
4418         Perl_croak(aTHX_ "No %s allowed while running setgid", message);
4419 #endif /* SETUID_SCRIPTS_ARE_SECURE_NOW */
4420     /* PSz 29 Feb 04
4421      * Checks for UID/GID above "wrong": why disallow
4422      *   perl -e 'print "Hello\n"'
4423      * from within setuid things?? Simply drop them: replaced by
4424      * fdscript/suidscript and #ifdef IAMSUID checks below.
4425      * 
4426      * This may be too late for command-line switches. Will catch those on
4427      * the #! line, after finding the script name and setting up
4428      * fdscript/suidscript. Note that suidperl does not get around to
4429      * parsing (and checking) the switches on the #! line, but checks that
4430      * the two sets are identical.
4431      * 
4432      * With SETUID_SCRIPTS_ARE_SECURE_NOW, could we use fdscript, also or
4433      * instead, or would that be "too late"? (We never have suidscript, can
4434      * we be sure to have fdscript?)
4435      * 
4436      * Catch things with suidscript (in descendant of suidperl), even with
4437      * right UID/GID. Was already checked in suidperl, with #ifdef IAMSUID,
4438      * below; but I am paranoid.
4439      * 
4440      * Also see comments about root running a setuid script, elsewhere.
4441      */
4442     if (suidscript)
4443         Perl_croak(aTHX_ "No %s allowed with (suid) fdscript", message);
4444 #ifdef IAMSUID
4445     /* PSz 11 Nov 03  Catch it in suidperl, always! */
4446     Perl_croak(aTHX_ "No %s allowed in suidperl", message);
4447 #endif /* IAMSUID */
4448 }
4449
4450 void
4451 Perl_init_debugger(pTHX)
4452 {
4453     dVAR;
4454     HV * const ostash = PL_curstash;
4455
4456     PL_curstash = PL_debstash;
4457     PL_dbargs = GvAV(gv_AVadd((gv_fetchpvs("DB::args", GV_ADDMULTI,
4458                                            SVt_PVAV))));
4459     AvREAL_off(PL_dbargs);
4460     PL_DBgv = gv_fetchpvs("DB::DB", GV_ADDMULTI, SVt_PVGV);
4461     PL_DBline = gv_fetchpvs("DB::dbline", GV_ADDMULTI, SVt_PVAV);
4462     PL_DBsub = gv_HVadd(gv_fetchpvs("DB::sub", GV_ADDMULTI, SVt_PVHV));
4463     PL_DBsingle = GvSV((gv_fetchpvs("DB::single", GV_ADDMULTI, SVt_PV)));
4464     sv_setiv(PL_DBsingle, 0);
4465     PL_DBtrace = GvSV((gv_fetchpvs("DB::trace", GV_ADDMULTI, SVt_PV)));
4466     sv_setiv(PL_DBtrace, 0);
4467     PL_DBsignal = GvSV((gv_fetchpvs("DB::signal", GV_ADDMULTI, SVt_PV)));
4468     sv_setiv(PL_DBsignal, 0);
4469     PL_curstash = ostash;
4470 }
4471
4472 #ifndef STRESS_REALLOC
4473 #define REASONABLE(size) (size)
4474 #else
4475 #define REASONABLE(size) (1) /* unreasonable */
4476 #endif
4477
4478 void
4479 Perl_init_stacks(pTHX)
4480 {
4481     dVAR;
4482     /* start with 128-item stack and 8K cxstack */
4483     PL_curstackinfo = new_stackinfo(REASONABLE(128),
4484                                  REASONABLE(8192/sizeof(PERL_CONTEXT) - 1));
4485     PL_curstackinfo->si_type = PERLSI_MAIN;
4486     PL_curstack = PL_curstackinfo->si_stack;
4487     PL_mainstack = PL_curstack;         /* remember in case we switch stacks */
4488
4489     PL_stack_base = AvARRAY(PL_curstack);
4490     PL_stack_sp = PL_stack_base;
4491     PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
4492
4493     Newx(PL_tmps_stack,REASONABLE(128),SV*);
4494     PL_tmps_floor = -1;
4495     PL_tmps_ix = -1;
4496     PL_tmps_max = REASONABLE(128);
4497
4498     Newx(PL_markstack,REASONABLE(32),I32);
4499     PL_markstack_ptr = PL_markstack;
4500     PL_markstack_max = PL_markstack + REASONABLE(32);
4501
4502     SET_MARK_OFFSET;
4503
4504     Newx(PL_scopestack,REASONABLE(32),I32);
4505     PL_scopestack_ix = 0;
4506     PL_scopestack_max = REASONABLE(32);
4507
4508     Newx(PL_savestack,REASONABLE(128),ANY);
4509     PL_savestack_ix = 0;
4510     PL_savestack_max = REASONABLE(128);
4511 }
4512
4513 #undef REASONABLE
4514
4515 STATIC void
4516 S_nuke_stacks(pTHX)
4517 {
4518     dVAR;
4519     while (PL_curstackinfo->si_next)
4520         PL_curstackinfo = PL_curstackinfo->si_next;
4521     while (PL_curstackinfo) {
4522         PERL_SI *p = PL_curstackinfo->si_prev;
4523         /* curstackinfo->si_stack got nuked by sv_free_arenas() */
4524         Safefree(PL_curstackinfo->si_cxstack);
4525         Safefree(PL_curstackinfo);
4526         PL_curstackinfo = p;
4527     }
4528     Safefree(PL_tmps_stack);
4529     Safefree(PL_markstack);
4530     Safefree(PL_scopestack);
4531     Safefree(PL_savestack);
4532 }
4533
4534
4535 STATIC void
4536 S_init_predump_symbols(pTHX)
4537 {
4538     dVAR;
4539     GV *tmpgv;
4540     IO *io;
4541
4542     sv_setpvn(get_sv("\"", TRUE), " ", 1);
4543     PL_stdingv = gv_fetchpvs("STDIN", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4544     GvMULTI_on(PL_stdingv);
4545     io = GvIOp(PL_stdingv);
4546     IoTYPE(io) = IoTYPE_RDONLY;
4547     IoIFP(io) = PerlIO_stdin();
4548     tmpgv = gv_fetchpvs("stdin", GV_ADD|GV_NOTQUAL, SVt_PV);
4549     GvMULTI_on(tmpgv);
4550     GvIOp(tmpgv) = (IO*)SvREFCNT_inc_simple(io);
4551
4552     tmpgv = gv_fetchpvs("STDOUT", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4553     GvMULTI_on(tmpgv);
4554     io = GvIOp(tmpgv);
4555     IoTYPE(io) = IoTYPE_WRONLY;
4556     IoOFP(io) = IoIFP(io) = PerlIO_stdout();
4557     setdefout(tmpgv);
4558     tmpgv = gv_fetchpvs("stdout", GV_ADD|GV_NOTQUAL, SVt_PV);
4559     GvMULTI_on(tmpgv);
4560     GvIOp(tmpgv) = (IO*)SvREFCNT_inc_simple(io);
4561
4562     PL_stderrgv = gv_fetchpvs("STDERR", GV_ADD|GV_NOTQUAL, SVt_PVIO);
4563     GvMULTI_on(PL_stderrgv);
4564     io = GvIOp(PL_stderrgv);
4565     IoTYPE(io) = IoTYPE_WRONLY;
4566     IoOFP(io) = IoIFP(io) = PerlIO_stderr();
4567     tmpgv = gv_fetchpvs("stderr", GV_ADD|GV_NOTQUAL, SVt_PV);
4568     GvMULTI_on(tmpgv);
4569     GvIOp(tmpgv) = (IO*)SvREFCNT_inc_simple(io);
4570
4571     PL_statname = newSV(0);             /* last filename we did stat on */
4572
4573     Safefree(PL_osname);
4574     PL_osname = savepv(OSNAME);
4575 }
4576
4577 void
4578 Perl_init_argv_symbols(pTHX_ register int argc, register char **argv)
4579 {
4580     dVAR;
4581
4582     PERL_ARGS_ASSERT_INIT_ARGV_SYMBOLS;
4583
4584     argc--,argv++;      /* skip name of script */
4585     if (PL_doswitches) {
4586         for (; argc > 0 && **argv == '-'; argc--,argv++) {
4587             char *s;
4588             if (!argv[0][1])
4589                 break;
4590             if (argv[0][1] == '-' && !argv[0][2]) {
4591                 argc--,argv++;
4592                 break;
4593             }
4594             if ((s = strchr(argv[0], '='))) {
4595                 const char *const start_name = argv[0] + 1;
4596                 sv_setpv(GvSV(gv_fetchpvn_flags(start_name, s - start_name,
4597                                                 TRUE, SVt_PV)), s + 1);
4598             }
4599             else
4600                 sv_setiv(GvSV(gv_fetchpv(argv[0]+1, GV_ADD, SVt_PV)),1);
4601         }
4602     }
4603     if ((PL_argvgv = gv_fetchpvs("ARGV", GV_ADD|GV_NOTQUAL, SVt_PVAV))) {
4604         GvMULTI_on(PL_argvgv);
4605         (void)gv_AVadd(PL_argvgv);
4606         av_clear(GvAVn(PL_argvgv));
4607         for (; argc > 0; argc--,argv++) {
4608             SV * const sv = newSVpv(argv[0],0);
4609             av_push(GvAVn(PL_argvgv),sv);
4610             if (!(PL_unicode & PERL_UNICODE_LOCALE_FLAG) || PL_utf8locale) {
4611                  if (PL_unicode & PERL_UNICODE_ARGV_FLAG)
4612                       SvUTF8_on(sv);
4613             }
4614             if (PL_unicode & PERL_UNICODE_WIDESYSCALLS_FLAG) /* Sarathy? */
4615                  (void)sv_utf8_decode(sv);
4616         }
4617     }
4618 }
4619
4620 STATIC void
4621 S_init_postdump_symbols(pTHX_ register int argc, register char **argv, register char **env)
4622 {
4623     dVAR;
4624     GV* tmpgv;
4625
4626     PERL_ARGS_ASSERT_INIT_POSTDUMP_SYMBOLS;
4627
4628     PL_toptarget = newSV_type(SVt_PVFM);
4629     sv_setpvn(PL_toptarget, "", 0);
4630     PL_bodytarget = newSV_type(SVt_PVFM);
4631     sv_setpvn(PL_bodytarget, "", 0);
4632     PL_formtarget = PL_bodytarget;
4633
4634     TAINT;
4635
4636     init_argv_symbols(argc,argv);
4637
4638     if ((tmpgv = gv_fetchpvs("0", GV_ADD|GV_NOTQUAL, SVt_PV))) {
4639 #ifdef MACOS_TRADITIONAL
4640         /* $0 is not majick on a Mac */
4641         sv_setpv(GvSV(tmpgv),MacPerl_MPWFileName(PL_origfilename));
4642 #else
4643         sv_setpv(GvSV(tmpgv),PL_origfilename);
4644         magicname("0", "0", 1);
4645 #endif
4646     }
4647     if ((PL_envgv = gv_fetchpvs("ENV", GV_ADD|GV_NOTQUAL, SVt_PVHV))) {
4648         HV *hv;
4649         bool env_is_not_environ;
4650         GvMULTI_on(PL_envgv);
4651         hv = GvHVn(PL_envgv);
4652         hv_magic(hv, NULL, PERL_MAGIC_env);
4653 #ifndef PERL_MICRO
4654 #ifdef USE_ENVIRON_ARRAY
4655         /* Note that if the supplied env parameter is actually a copy
4656            of the global environ then it may now point to free'd memory
4657            if the environment has been modified since. To avoid this
4658            problem we treat env==NULL as meaning 'use the default'
4659         */
4660         if (!env)
4661             env = environ;
4662         env_is_not_environ = env != environ;
4663         if (env_is_not_environ
4664 #  ifdef USE_ITHREADS
4665             && PL_curinterp == aTHX
4666 #  endif
4667            )
4668         {
4669             environ[0] = NULL;
4670         }
4671         if (env) {
4672           char *s;
4673           SV *sv;
4674           for (; *env; env++) {
4675             if (!(s = strchr(*env,'=')) || s == *env)
4676                 continue;
4677 #if defined(MSDOS) && !defined(DJGPP)
4678             *s = '\0';
4679             (void)strupr(*env);
4680             *s = '=';
4681 #endif
4682             sv = newSVpv(s+1, 0);
4683             (void)hv_store(hv, *env, s - *env, sv, 0);
4684             if (env_is_not_environ)
4685                 mg_set(sv);
4686           }
4687       }
4688 #endif /* USE_ENVIRON_ARRAY */
4689 #endif /* !PERL_MICRO */
4690     }
4691     TAINT_NOT;
4692     if ((tmpgv = gv_fetchpvs("$", GV_ADD|GV_NOTQUAL, SVt_PV))) {
4693         SvREADONLY_off(GvSV(tmpgv));
4694         sv_setiv(GvSV(tmpgv), (IV)PerlProc_getpid());
4695         SvREADONLY_on(GvSV(tmpgv));
4696     }
4697 #ifdef THREADS_HAVE_PIDS
4698     PL_ppid = (IV)getppid();
4699 #endif
4700
4701     /* touch @F array to prevent spurious warnings 20020415 MJD */
4702     if (PL_minus_a) {
4703       (void) get_av("main::F", TRUE | GV_ADDMULTI);
4704     }
4705 }
4706
4707 STATIC void
4708 S_init_perllib(pTHX)
4709 {
4710     dVAR;
4711     char *s;
4712     if (!PL_tainting) {
4713 #ifndef VMS
4714         s = PerlEnv_getenv("PERL5LIB");
4715 /*
4716  * It isn't possible to delete an environment variable with
4717  * PERL_USE_SAFE_PUTENV set unless unsetenv() is also available, so in that
4718  * case we treat PERL5LIB as undefined if it has a zero-length value.
4719  */
4720 #if defined(PERL_USE_SAFE_PUTENV) && ! defined(HAS_UNSETENV)
4721         if (s && *s != '\0')
4722 #else
4723         if (s)
4724 #endif
4725             incpush(s, TRUE, TRUE, TRUE, FALSE);
4726         else
4727             incpush(PerlEnv_getenv("PERLLIB"), FALSE, FALSE, TRUE, FALSE);
4728 #else /* VMS */
4729         /* Treat PERL5?LIB as a possible search list logical name -- the
4730          * "natural" VMS idiom for a Unix path string.  We allow each
4731          * element to be a set of |-separated directories for compatibility.
4732          */
4733         char buf[256];
4734         int idx = 0;
4735         if (my_trnlnm("PERL5LIB",buf,0))
4736             do { incpush(buf,TRUE,TRUE,TRUE,FALSE); } while (my_trnlnm("PERL5LIB",buf,++idx));
4737         else
4738             while (my_trnlnm("PERLLIB",buf,idx++)) incpush(buf,FALSE,FALSE,TRUE,FALSE);
4739 #endif /* VMS */
4740     }
4741
4742 /* Use the ~-expanded versions of APPLLIB (undocumented),
4743     ARCHLIB PRIVLIB SITEARCH SITELIB VENDORARCH and VENDORLIB
4744 */
4745 #ifdef APPLLIB_EXP
4746     incpush(APPLLIB_EXP, TRUE, TRUE, TRUE, TRUE);
4747 #endif
4748
4749 #ifdef ARCHLIB_EXP
4750     incpush(ARCHLIB_EXP, FALSE, FALSE, TRUE, TRUE);
4751 #endif
4752 #ifdef MACOS_TRADITIONAL
4753     {
4754         Stat_t tmpstatbuf;
4755         SV * privdir = newSV(0);
4756         char * macperl = PerlEnv_getenv("MACPERL");
4757         
4758         if (!macperl)
4759             macperl = "";
4760         
4761         Perl_sv_setpvf(aTHX_ privdir, "%slib:", macperl);
4762         if (PerlLIO_stat(SvPVX(privdir), &tmpstatbuf) >= 0 && S_ISDIR(tmpstatbuf.st_mode))
4763             incpush(SvPVX(privdir), TRUE, FALSE, TRUE, FALSE);
4764         Perl_sv_setpvf(aTHX_ privdir, "%ssite_perl:", macperl);
4765         if (PerlLIO_stat(SvPVX(privdir), &tmpstatbuf) >= 0 && S_ISDIR(tmpstatbuf.st_mode))
4766             incpush(SvPVX(privdir), TRUE, FALSE, TRUE, FALSE);
4767         
4768         SvREFCNT_dec(privdir);
4769     }
4770     if (!PL_tainting)
4771         incpush(":", FALSE, FALSE, TRUE, FALSE);
4772 #else
4773 #ifndef PRIVLIB_EXP
4774 #  define PRIVLIB_EXP "/usr/local/lib/perl5:/usr/local/lib/perl"
4775 #endif
4776 #if defined(WIN32)
4777     incpush(PRIVLIB_EXP, TRUE, FALSE, TRUE, TRUE);
4778 #else
4779     incpush(PRIVLIB_EXP, FALSE, FALSE, TRUE, TRUE);
4780 #endif
4781
4782 #ifdef SITEARCH_EXP
4783     /* sitearch is always relative to sitelib on Windows for
4784      * DLL-based path intuition to work correctly */
4785 #  if !defined(WIN32)
4786     incpush(SITEARCH_EXP, FALSE, FALSE, TRUE, TRUE);
4787 #  endif
4788 #endif
4789
4790 #ifdef SITELIB_EXP
4791 #  if defined(WIN32)
4792     /* this picks up sitearch as well */
4793     incpush(SITELIB_EXP, TRUE, FALSE, TRUE, TRUE);
4794 #  else
4795     incpush(SITELIB_EXP, FALSE, FALSE, TRUE, TRUE);
4796 #  endif
4797 #endif
4798
4799 #if defined(SITELIB_STEM) && defined(PERL_INC_VERSION_LIST)
4800     /* Search for version-specific dirs below here */
4801     incpush(SITELIB_STEM, FALSE, TRUE, TRUE, TRUE);
4802 #endif
4803
4804 #ifdef PERL_VENDORARCH_EXP
4805     /* vendorarch is always relative to vendorlib on Windows for
4806      * DLL-based path intuition to work correctly */
4807 #  if !defined(WIN32)
4808     incpush(PERL_VENDORARCH_EXP, FALSE, FALSE, TRUE, TRUE);
4809 #  endif
4810 #endif
4811
4812 #ifdef PERL_VENDORLIB_EXP
4813 #  if defined(WIN32)
4814     incpush(PERL_VENDORLIB_EXP, TRUE, FALSE, TRUE, TRUE);       /* this picks up vendorarch as well */
4815 #  else
4816     incpush(PERL_VENDORLIB_EXP, FALSE, FALSE, TRUE, TRUE);
4817 #  endif