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