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