This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
1758448d0bb24f9553287b349a250cfb366b8390
[perl5.git] / pp_ctl.c
1 /*    pp_ctl.c
2  *
3  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4  *    2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 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  *      Now far ahead the Road has gone,
13  *          And I must follow, if I can,
14  *      Pursuing it with eager feet,
15  *          Until it joins some larger way
16  *      Where many paths and errands meet.
17  *          And whither then?  I cannot say.
18  *
19  *     [Bilbo on p.35 of _The Lord of the Rings_, I/i: "A Long-Expected Party"]
20  */
21
22 /* This file contains control-oriented pp ("push/pop") functions that
23  * execute the opcodes that make up a perl program. A typical pp function
24  * expects to find its arguments on the stack, and usually pushes its
25  * results onto the stack, hence the 'pp' terminology. Each OP structure
26  * contains a pointer to the relevant pp_foo() function.
27  *
28  * Control-oriented means things like pp_enteriter() and pp_next(), which
29  * alter the flow of control of the program.
30  */
31
32
33 #include "EXTERN.h"
34 #define PERL_IN_PP_CTL_C
35 #include "perl.h"
36
37 #define DOCATCH(o) ((CATCH_GET == TRUE) ? docatch(o) : (o))
38
39 #define dopoptosub(plop)        dopoptosub_at(cxstack, (plop))
40
41 PP(pp_wantarray)
42 {
43     dSP;
44     I32 cxix;
45     const PERL_CONTEXT *cx;
46     EXTEND(SP, 1);
47
48     if (PL_op->op_private & OPpOFFBYONE) {
49         if (!(cx = caller_cx(1,NULL))) RETPUSHUNDEF;
50     }
51     else {
52       cxix = dopoptosub(cxstack_ix);
53       if (cxix < 0)
54         RETPUSHUNDEF;
55       cx = &cxstack[cxix];
56     }
57
58     switch (cx->blk_gimme) {
59     case G_ARRAY:
60         RETPUSHYES;
61     case G_SCALAR:
62         RETPUSHNO;
63     default:
64         RETPUSHUNDEF;
65     }
66 }
67
68 PP(pp_regcreset)
69 {
70     TAINT_NOT;
71     return NORMAL;
72 }
73
74 PP(pp_regcomp)
75 {
76     dSP;
77     PMOP *pm = (PMOP*)cLOGOP->op_other;
78     SV **args;
79     int nargs;
80     REGEXP *re = NULL;
81     REGEXP *new_re;
82     const regexp_engine *eng;
83     bool is_bare_re= FALSE;
84
85     if (PL_op->op_flags & OPf_STACKED) {
86         dMARK;
87         nargs = SP - MARK;
88         args  = ++MARK;
89     }
90     else {
91         nargs = 1;
92         args  = SP;
93     }
94
95     /* prevent recompiling under /o and ithreads. */
96 #if defined(USE_ITHREADS)
97     if (pm->op_pmflags & PMf_KEEP && PM_GETRE(pm)) {
98         SP = args-1;
99         RETURN;
100     }
101 #endif
102
103     re = PM_GETRE(pm);
104     assert (re != (REGEXP*) &PL_sv_undef);
105     eng = re ? RX_ENGINE(re) : current_re_engine();
106
107     /*
108      In the below logic: these are basically the same - check if this regcomp is part of a split.
109
110     (PL_op->op_pmflags & PMf_split )
111     (PL_op->op_next->op_type == OP_PUSHRE)
112
113     We could add a new mask for this and copy the PMf_split, if we did
114     some bit definition fiddling first.
115
116     For now we leave this
117     */
118
119     new_re = (eng->op_comp
120                     ? eng->op_comp
121                     : &Perl_re_op_compile
122             )(aTHX_ args, nargs, pm->op_code_list, eng, re,
123                 &is_bare_re,
124                 (pm->op_pmflags & RXf_PMf_FLAGCOPYMASK),
125                 pm->op_pmflags |
126                     (PL_op->op_flags & OPf_SPECIAL ? PMf_USE_RE_EVAL : 0));
127
128     if (pm->op_pmflags & PMf_HAS_CV)
129         ReANY(new_re)->qr_anoncv
130                         = (CV*) SvREFCNT_inc(PAD_SV(PL_op->op_targ));
131
132     if (is_bare_re) {
133         REGEXP *tmp;
134         /* The match's LHS's get-magic might need to access this op's regexp
135            (e.g. $' =~ /$re/ while foo; see bug 70764).  So we must call
136            get-magic now before we replace the regexp. Hopefully this hack can
137            be replaced with the approach described at
138            http://www.nntp.perl.org/group/perl.perl5.porters/2007/03/msg122415.html
139            some day. */
140         if (pm->op_type == OP_MATCH) {
141             SV *lhs;
142             const bool was_tainted = TAINT_get;
143             if (pm->op_flags & OPf_STACKED)
144                 lhs = args[-1];
145             else if (pm->op_targ)
146                 lhs = PAD_SV(pm->op_targ);
147             else lhs = DEFSV;
148             SvGETMAGIC(lhs);
149             /* Restore the previous value of PL_tainted (which may have been
150                modified by get-magic), to avoid incorrectly setting the
151                RXf_TAINTED flag with RX_TAINT_on further down. */
152             TAINT_set(was_tainted);
153 #ifdef NO_TAINT_SUPPORT
154             PERL_UNUSED_VAR(was_tainted);
155 #endif
156         }
157         tmp = reg_temp_copy(NULL, new_re);
158         ReREFCNT_dec(new_re);
159         new_re = tmp;
160     }
161
162     if (re != new_re) {
163         ReREFCNT_dec(re);
164         PM_SETRE(pm, new_re);
165     }
166
167
168     assert(TAINTING_get || !TAINT_get);
169     if (TAINT_get) {
170         SvTAINTED_on((SV*)new_re);
171         RX_TAINT_on(new_re);
172     }
173
174 #if !defined(USE_ITHREADS)
175     /* can't change the optree at runtime either */
176     /* PMf_KEEP is handled differently under threads to avoid these problems */
177     if (!RX_PRELEN(PM_GETRE(pm)) && PL_curpm)
178         pm = PL_curpm;
179     if (pm->op_pmflags & PMf_KEEP) {
180         pm->op_private &= ~OPpRUNTIME;  /* no point compiling again */
181         cLOGOP->op_first->op_next = PL_op->op_next;
182     }
183 #endif
184
185     SP = args-1;
186     RETURN;
187 }
188
189
190 PP(pp_substcont)
191 {
192     dSP;
193     PERL_CONTEXT *cx = CX_CUR();
194     PMOP * const pm = (PMOP*) cLOGOP->op_other;
195     SV * const dstr = cx->sb_dstr;
196     char *s = cx->sb_s;
197     char *m = cx->sb_m;
198     char *orig = cx->sb_orig;
199     REGEXP * const rx = cx->sb_rx;
200     SV *nsv = NULL;
201     REGEXP *old = PM_GETRE(pm);
202
203     PERL_ASYNC_CHECK();
204
205     if(old != rx) {
206         if(old)
207             ReREFCNT_dec(old);
208         PM_SETRE(pm,ReREFCNT_inc(rx));
209     }
210
211     rxres_restore(&cx->sb_rxres, rx);
212
213     if (cx->sb_iters++) {
214         const SSize_t saviters = cx->sb_iters;
215         if (cx->sb_iters > cx->sb_maxiters)
216             DIE(aTHX_ "Substitution loop");
217
218         SvGETMAGIC(TOPs); /* possibly clear taint on $1 etc: #67962 */
219
220         /* See "how taint works" above pp_subst() */
221         if (SvTAINTED(TOPs))
222             cx->sb_rxtainted |= SUBST_TAINT_REPL;
223         sv_catsv_nomg(dstr, POPs);
224         if (CxONCE(cx) || s < orig ||
225                 !CALLREGEXEC(rx, s, cx->sb_strend, orig,
226                              (s == m), cx->sb_targ, NULL,
227                     (REXEC_IGNOREPOS|REXEC_NOT_FIRST|REXEC_FAIL_ON_UNDERFLOW)))
228         {
229             SV *targ = cx->sb_targ;
230
231             assert(cx->sb_strend >= s);
232             if(cx->sb_strend > s) {
233                  if (DO_UTF8(dstr) && !SvUTF8(targ))
234                       sv_catpvn_nomg_utf8_upgrade(dstr, s, cx->sb_strend - s, nsv);
235                  else
236                       sv_catpvn_nomg(dstr, s, cx->sb_strend - s);
237             }
238             if (RX_MATCH_TAINTED(rx)) /* run time pattern taint, eg locale */
239                 cx->sb_rxtainted |= SUBST_TAINT_PAT;
240
241             if (pm->op_pmflags & PMf_NONDESTRUCT) {
242                 PUSHs(dstr);
243                 /* From here on down we're using the copy, and leaving the
244                    original untouched.  */
245                 targ = dstr;
246             }
247             else {
248                 SV_CHECK_THINKFIRST_COW_DROP(targ);
249                 if (isGV(targ)) Perl_croak_no_modify();
250                 SvPV_free(targ);
251                 SvPV_set(targ, SvPVX(dstr));
252                 SvCUR_set(targ, SvCUR(dstr));
253                 SvLEN_set(targ, SvLEN(dstr));
254                 if (DO_UTF8(dstr))
255                     SvUTF8_on(targ);
256                 SvPV_set(dstr, NULL);
257
258                 PL_tainted = 0;
259                 mPUSHi(saviters - 1);
260
261                 (void)SvPOK_only_UTF8(targ);
262             }
263
264             /* update the taint state of various various variables in
265              * preparation for final exit.
266              * See "how taint works" above pp_subst() */
267             if (TAINTING_get) {
268                 if ((cx->sb_rxtainted & SUBST_TAINT_PAT) ||
269                     ((cx->sb_rxtainted & (SUBST_TAINT_STR|SUBST_TAINT_RETAINT))
270                                     == (SUBST_TAINT_STR|SUBST_TAINT_RETAINT))
271                 )
272                     (RX_MATCH_TAINTED_on(rx)); /* taint $1 et al */
273
274                 if (!(cx->sb_rxtainted & SUBST_TAINT_BOOLRET)
275                     && (cx->sb_rxtainted & (SUBST_TAINT_STR|SUBST_TAINT_PAT))
276                 )
277                     SvTAINTED_on(TOPs);  /* taint return value */
278                 /* needed for mg_set below */
279                 TAINT_set(
280                     cBOOL(cx->sb_rxtainted &
281                           (SUBST_TAINT_STR|SUBST_TAINT_PAT|SUBST_TAINT_REPL))
282                 );
283                 SvTAINT(TARG);
284             }
285             /* PL_tainted must be correctly set for this mg_set */
286             SvSETMAGIC(TARG);
287             TAINT_NOT;
288
289             CX_LEAVE_SCOPE(cx);
290             POPSUBST(cx);
291             CX_POP(cx);
292
293             PERL_ASYNC_CHECK();
294             RETURNOP(pm->op_next);
295             NOT_REACHED; /* NOTREACHED */
296         }
297         cx->sb_iters = saviters;
298     }
299     if (RX_MATCH_COPIED(rx) && RX_SUBBEG(rx) != orig) {
300         m = s;
301         s = orig;
302         assert(!RX_SUBOFFSET(rx));
303         cx->sb_orig = orig = RX_SUBBEG(rx);
304         s = orig + (m - s);
305         cx->sb_strend = s + (cx->sb_strend - m);
306     }
307     cx->sb_m = m = RX_OFFS(rx)[0].start + orig;
308     if (m > s) {
309         if (DO_UTF8(dstr) && !SvUTF8(cx->sb_targ))
310             sv_catpvn_nomg_utf8_upgrade(dstr, s, m - s, nsv);
311         else
312             sv_catpvn_nomg(dstr, s, m-s);
313     }
314     cx->sb_s = RX_OFFS(rx)[0].end + orig;
315     { /* Update the pos() information. */
316         SV * const sv
317             = (pm->op_pmflags & PMf_NONDESTRUCT) ? cx->sb_dstr : cx->sb_targ;
318         MAGIC *mg;
319
320         /* the string being matched against may no longer be a string,
321          * e.g. $_=0; s/.../$_++/ge */
322
323         if (!SvPOK(sv))
324             SvPV_force_nomg_nolen(sv);
325
326         if (!(mg = mg_find_mglob(sv))) {
327             mg = sv_magicext_mglob(sv);
328         }
329         MgBYTEPOS_set(mg, sv, SvPVX(sv), m - orig);
330     }
331     if (old != rx)
332         (void)ReREFCNT_inc(rx);
333     /* update the taint state of various various variables in preparation
334      * for calling the code block.
335      * See "how taint works" above pp_subst() */
336     if (TAINTING_get) {
337         if (RX_MATCH_TAINTED(rx)) /* run time pattern taint, eg locale */
338             cx->sb_rxtainted |= SUBST_TAINT_PAT;
339
340         if ((cx->sb_rxtainted & SUBST_TAINT_PAT) ||
341             ((cx->sb_rxtainted & (SUBST_TAINT_STR|SUBST_TAINT_RETAINT))
342                             == (SUBST_TAINT_STR|SUBST_TAINT_RETAINT))
343         )
344             (RX_MATCH_TAINTED_on(rx)); /* taint $1 et al */
345
346         if (cx->sb_iters > 1 && (cx->sb_rxtainted & 
347                         (SUBST_TAINT_STR|SUBST_TAINT_PAT|SUBST_TAINT_REPL)))
348             SvTAINTED_on((pm->op_pmflags & PMf_NONDESTRUCT)
349                          ? cx->sb_dstr : cx->sb_targ);
350         TAINT_NOT;
351     }
352     rxres_save(&cx->sb_rxres, rx);
353     PL_curpm = pm;
354     RETURNOP(pm->op_pmstashstartu.op_pmreplstart);
355 }
356
357 void
358 Perl_rxres_save(pTHX_ void **rsp, REGEXP *rx)
359 {
360     UV *p = (UV*)*rsp;
361     U32 i;
362
363     PERL_ARGS_ASSERT_RXRES_SAVE;
364     PERL_UNUSED_CONTEXT;
365
366     if (!p || p[1] < RX_NPARENS(rx)) {
367 #ifdef PERL_ANY_COW
368         i = 7 + (RX_NPARENS(rx)+1) * 2;
369 #else
370         i = 6 + (RX_NPARENS(rx)+1) * 2;
371 #endif
372         if (!p)
373             Newx(p, i, UV);
374         else
375             Renew(p, i, UV);
376         *rsp = (void*)p;
377     }
378
379     /* what (if anything) to free on croak */
380     *p++ = PTR2UV(RX_MATCH_COPIED(rx) ? RX_SUBBEG(rx) : NULL);
381     RX_MATCH_COPIED_off(rx);
382     *p++ = RX_NPARENS(rx);
383
384 #ifdef PERL_ANY_COW
385     *p++ = PTR2UV(RX_SAVED_COPY(rx));
386     RX_SAVED_COPY(rx) = NULL;
387 #endif
388
389     *p++ = PTR2UV(RX_SUBBEG(rx));
390     *p++ = (UV)RX_SUBLEN(rx);
391     *p++ = (UV)RX_SUBOFFSET(rx);
392     *p++ = (UV)RX_SUBCOFFSET(rx);
393     for (i = 0; i <= RX_NPARENS(rx); ++i) {
394         *p++ = (UV)RX_OFFS(rx)[i].start;
395         *p++ = (UV)RX_OFFS(rx)[i].end;
396     }
397 }
398
399 static void
400 S_rxres_restore(pTHX_ void **rsp, REGEXP *rx)
401 {
402     UV *p = (UV*)*rsp;
403     U32 i;
404
405     PERL_ARGS_ASSERT_RXRES_RESTORE;
406     PERL_UNUSED_CONTEXT;
407
408     RX_MATCH_COPY_FREE(rx);
409     RX_MATCH_COPIED_set(rx, *p);
410     *p++ = 0;
411     RX_NPARENS(rx) = *p++;
412
413 #ifdef PERL_ANY_COW
414     if (RX_SAVED_COPY(rx))
415         SvREFCNT_dec (RX_SAVED_COPY(rx));
416     RX_SAVED_COPY(rx) = INT2PTR(SV*,*p);
417     *p++ = 0;
418 #endif
419
420     RX_SUBBEG(rx) = INT2PTR(char*,*p++);
421     RX_SUBLEN(rx) = (I32)(*p++);
422     RX_SUBOFFSET(rx) = (I32)*p++;
423     RX_SUBCOFFSET(rx) = (I32)*p++;
424     for (i = 0; i <= RX_NPARENS(rx); ++i) {
425         RX_OFFS(rx)[i].start = (I32)(*p++);
426         RX_OFFS(rx)[i].end = (I32)(*p++);
427     }
428 }
429
430 static void
431 S_rxres_free(pTHX_ void **rsp)
432 {
433     UV * const p = (UV*)*rsp;
434
435     PERL_ARGS_ASSERT_RXRES_FREE;
436     PERL_UNUSED_CONTEXT;
437
438     if (p) {
439         void *tmp = INT2PTR(char*,*p);
440 #ifdef PERL_POISON
441 #ifdef PERL_ANY_COW
442         U32 i = 9 + p[1] * 2;
443 #else
444         U32 i = 8 + p[1] * 2;
445 #endif
446 #endif
447
448 #ifdef PERL_ANY_COW
449         SvREFCNT_dec (INT2PTR(SV*,p[2]));
450 #endif
451 #ifdef PERL_POISON
452         PoisonFree(p, i, sizeof(UV));
453 #endif
454
455         Safefree(tmp);
456         Safefree(p);
457         *rsp = NULL;
458     }
459 }
460
461 #define FORM_NUM_BLANK (1<<30)
462 #define FORM_NUM_POINT (1<<29)
463
464 PP(pp_formline)
465 {
466     dSP; dMARK; dORIGMARK;
467     SV * const tmpForm = *++MARK;
468     SV *formsv;             /* contains text of original format */
469     U32 *fpc;       /* format ops program counter */
470     char *t;        /* current append position in target string */
471     const char *f;          /* current position in format string */
472     I32 arg;
473     SV *sv = NULL; /* current item */
474     const char *item = NULL;/* string value of current item */
475     I32 itemsize  = 0;      /* length (chars) of item, possibly truncated */
476     I32 itembytes = 0;      /* as itemsize, but length in bytes */
477     I32 fieldsize = 0;      /* width of current field */
478     I32 lines = 0;          /* number of lines that have been output */
479     bool chopspace = (strchr(PL_chopset, ' ') != NULL); /* does $: have space */
480     const char *chophere = NULL; /* where to chop current item */
481     STRLEN linemark = 0;    /* pos of start of line in output */
482     NV value;
483     bool gotsome = FALSE;   /* seen at least one non-blank item on this line */
484     STRLEN len;             /* length of current sv */
485     STRLEN linemax;         /* estimate of output size in bytes */
486     bool item_is_utf8 = FALSE;
487     bool targ_is_utf8 = FALSE;
488     const char *fmt;
489     MAGIC *mg = NULL;
490     U8 *source;             /* source of bytes to append */
491     STRLEN to_copy;         /* how may bytes to append */
492     char trans;             /* what chars to translate */
493
494     mg = doparseform(tmpForm);
495
496     fpc = (U32*)mg->mg_ptr;
497     /* the actual string the format was compiled from.
498      * with overload etc, this may not match tmpForm */
499     formsv = mg->mg_obj;
500
501
502     SvPV_force(PL_formtarget, len);
503     if (SvTAINTED(tmpForm) || SvTAINTED(formsv))
504         SvTAINTED_on(PL_formtarget);
505     if (DO_UTF8(PL_formtarget))
506         targ_is_utf8 = TRUE;
507     linemax = (SvCUR(formsv) * (IN_BYTES ? 1 : 3) + 1);
508     t = SvGROW(PL_formtarget, len + linemax + 1);
509     /* XXX from now onwards, SvCUR(PL_formtarget) is invalid */
510     t += len;
511     f = SvPV_const(formsv, len);
512
513     for (;;) {
514         DEBUG_f( {
515             const char *name = "???";
516             arg = -1;
517             switch (*fpc) {
518             case FF_LITERAL:    arg = fpc[1]; name = "LITERAL"; break;
519             case FF_BLANK:      arg = fpc[1]; name = "BLANK";   break;
520             case FF_SKIP:       arg = fpc[1]; name = "SKIP";    break;
521             case FF_FETCH:      arg = fpc[1]; name = "FETCH";   break;
522             case FF_DECIMAL:    arg = fpc[1]; name = "DECIMAL"; break;
523
524             case FF_CHECKNL:    name = "CHECKNL";       break;
525             case FF_CHECKCHOP:  name = "CHECKCHOP";     break;
526             case FF_SPACE:      name = "SPACE";         break;
527             case FF_HALFSPACE:  name = "HALFSPACE";     break;
528             case FF_ITEM:       name = "ITEM";          break;
529             case FF_CHOP:       name = "CHOP";          break;
530             case FF_LINEGLOB:   name = "LINEGLOB";      break;
531             case FF_NEWLINE:    name = "NEWLINE";       break;
532             case FF_MORE:       name = "MORE";          break;
533             case FF_LINEMARK:   name = "LINEMARK";      break;
534             case FF_END:        name = "END";           break;
535             case FF_0DECIMAL:   name = "0DECIMAL";      break;
536             case FF_LINESNGL:   name = "LINESNGL";      break;
537             }
538             if (arg >= 0)
539                 PerlIO_printf(Perl_debug_log, "%-16s%ld\n", name, (long) arg);
540             else
541                 PerlIO_printf(Perl_debug_log, "%-16s\n", name);
542         } );
543         switch (*fpc++) {
544         case FF_LINEMARK: /* start (or end) of a line */
545             linemark = t - SvPVX(PL_formtarget);
546             lines++;
547             gotsome = FALSE;
548             break;
549
550         case FF_LITERAL: /* append <arg> literal chars */
551             to_copy = *fpc++;
552             source = (U8 *)f;
553             f += to_copy;
554             trans = '~';
555             item_is_utf8 = targ_is_utf8 ? !!DO_UTF8(formsv) : !!SvUTF8(formsv);
556             goto append;
557
558         case FF_SKIP: /* skip <arg> chars in format */
559             f += *fpc++;
560             break;
561
562         case FF_FETCH: /* get next item and set field size to <arg> */
563             arg = *fpc++;
564             f += arg;
565             fieldsize = arg;
566
567             if (MARK < SP)
568                 sv = *++MARK;
569             else {
570                 sv = &PL_sv_no;
571                 Perl_ck_warner(aTHX_ packWARN(WARN_SYNTAX), "Not enough format arguments");
572             }
573             if (SvTAINTED(sv))
574                 SvTAINTED_on(PL_formtarget);
575             break;
576
577         case FF_CHECKNL: /* find max len of item (up to \n) that fits field */
578             {
579                 const char *s = item = SvPV_const(sv, len);
580                 const char *send = s + len;
581
582                 itemsize = 0;
583                 item_is_utf8 = DO_UTF8(sv);
584                 while (s < send) {
585                     if (!isCNTRL(*s))
586                         gotsome = TRUE;
587                     else if (*s == '\n')
588                         break;
589
590                     if (item_is_utf8)
591                         s += UTF8SKIP(s);
592                     else
593                         s++;
594                     itemsize++;
595                     if (itemsize == fieldsize)
596                         break;
597                 }
598                 itembytes = s - item;
599                 chophere = s;
600                 break;
601             }
602
603         case FF_CHECKCHOP: /* like CHECKNL, but up to highest split point */
604             {
605                 const char *s = item = SvPV_const(sv, len);
606                 const char *send = s + len;
607                 I32 size = 0;
608
609                 chophere = NULL;
610                 item_is_utf8 = DO_UTF8(sv);
611                 while (s < send) {
612                     /* look for a legal split position */
613                     if (isSPACE(*s)) {
614                         if (*s == '\r') {
615                             chophere = s;
616                             itemsize = size;
617                             break;
618                         }
619                         if (chopspace) {
620                             /* provisional split point */
621                             chophere = s;
622                             itemsize = size;
623                         }
624                         /* we delay testing fieldsize until after we've
625                          * processed the possible split char directly
626                          * following the last field char; so if fieldsize=3
627                          * and item="a b cdef", we consume "a b", not "a".
628                          * Ditto further down.
629                          */
630                         if (size == fieldsize)
631                             break;
632                     }
633                     else {
634                         if (strchr(PL_chopset, *s)) {
635                             /* provisional split point */
636                             /* for a non-space split char, we include
637                              * the split char; hence the '+1' */
638                             chophere = s + 1;
639                             itemsize = size;
640                         }
641                         if (size == fieldsize)
642                             break;
643                         if (!isCNTRL(*s))
644                             gotsome = TRUE;
645                     }
646
647                     if (item_is_utf8)
648                         s += UTF8SKIP(s);
649                     else
650                         s++;
651                     size++;
652                 }
653                 if (!chophere || s == send) {
654                     chophere = s;
655                     itemsize = size;
656                 }
657                 itembytes = chophere - item;
658
659                 break;
660             }
661
662         case FF_SPACE: /* append padding space (diff of field, item size) */
663             arg = fieldsize - itemsize;
664             if (arg) {
665                 fieldsize -= arg;
666                 while (arg-- > 0)
667                     *t++ = ' ';
668             }
669             break;
670
671         case FF_HALFSPACE: /* like FF_SPACE, but only append half as many */
672             arg = fieldsize - itemsize;
673             if (arg) {
674                 arg /= 2;
675                 fieldsize -= arg;
676                 while (arg-- > 0)
677                     *t++ = ' ';
678             }
679             break;
680
681         case FF_ITEM: /* append a text item, while blanking ctrl chars */
682             to_copy = itembytes;
683             source = (U8 *)item;
684             trans = 1;
685             goto append;
686
687         case FF_CHOP: /* (for ^*) chop the current item */
688             if (sv != &PL_sv_no) {
689                 const char *s = chophere;
690                 if (chopspace) {
691                     while (isSPACE(*s))
692                         s++;
693                 }
694                 if (SvPOKp(sv))
695                     sv_chop(sv,s);
696                 else
697                     /* tied, overloaded or similar strangeness.
698                      * Do it the hard way */
699                     sv_setpvn(sv, s, len - (s-item));
700                 SvSETMAGIC(sv);
701                 break;
702             }
703
704         case FF_LINESNGL: /* process ^*  */
705             chopspace = 0;
706             /* FALLTHROUGH */
707
708         case FF_LINEGLOB: /* process @*  */
709             {
710                 const bool oneline = fpc[-1] == FF_LINESNGL;
711                 const char *s = item = SvPV_const(sv, len);
712                 const char *const send = s + len;
713
714                 item_is_utf8 = DO_UTF8(sv);
715                 chophere = s + len;
716                 if (!len)
717                     break;
718                 trans = 0;
719                 gotsome = TRUE;
720                 source = (U8 *) s;
721                 to_copy = len;
722                 while (s < send) {
723                     if (*s++ == '\n') {
724                         if (oneline) {
725                             to_copy = s - item - 1;
726                             chophere = s;
727                             break;
728                         } else {
729                             if (s == send) {
730                                 to_copy--;
731                             } else
732                                 lines++;
733                         }
734                     }
735                 }
736             }
737
738         append:
739             /* append to_copy bytes from source to PL_formstring.
740              * item_is_utf8 implies source is utf8.
741              * if trans, translate certain characters during the copy */
742             {
743                 U8 *tmp = NULL;
744                 STRLEN grow = 0;
745
746                 SvCUR_set(PL_formtarget,
747                           t - SvPVX_const(PL_formtarget));
748
749                 if (targ_is_utf8 && !item_is_utf8) {
750                     source = tmp = bytes_to_utf8(source, &to_copy);
751                 } else {
752                     if (item_is_utf8 && !targ_is_utf8) {
753                         U8 *s;
754                         /* Upgrade targ to UTF8, and then we reduce it to
755                            a problem we have a simple solution for.
756                            Don't need get magic.  */
757                         sv_utf8_upgrade_nomg(PL_formtarget);
758                         targ_is_utf8 = TRUE;
759                         /* re-calculate linemark */
760                         s = (U8*)SvPVX(PL_formtarget);
761                         /* the bytes we initially allocated to append the
762                          * whole line may have been gobbled up during the
763                          * upgrade, so allocate a whole new line's worth
764                          * for safety */
765                         grow = linemax;
766                         while (linemark--)
767                             s += UTF8SKIP(s);
768                         linemark = s - (U8*)SvPVX(PL_formtarget);
769                     }
770                     /* Easy. They agree.  */
771                     assert (item_is_utf8 == targ_is_utf8);
772                 }
773                 if (!trans)
774                     /* @* and ^* are the only things that can exceed
775                      * the linemax, so grow by the output size, plus
776                      * a whole new form's worth in case of any further
777                      * output */
778                     grow = linemax + to_copy;
779                 if (grow)
780                     SvGROW(PL_formtarget, SvCUR(PL_formtarget) + grow + 1);
781                 t = SvPVX(PL_formtarget) + SvCUR(PL_formtarget);
782
783                 Copy(source, t, to_copy, char);
784                 if (trans) {
785                     /* blank out ~ or control chars, depending on trans.
786                      * works on bytes not chars, so relies on not
787                      * matching utf8 continuation bytes */
788                     U8 *s = (U8*)t;
789                     U8 *send = s + to_copy;
790                     while (s < send) {
791                         const int ch = *s;
792                         if (trans == '~' ? (ch == '~') : isCNTRL(ch))
793                             *s = ' ';
794                         s++;
795                     }
796                 }
797
798                 t += to_copy;
799                 SvCUR_set(PL_formtarget, SvCUR(PL_formtarget) + to_copy);
800                 if (tmp)
801                     Safefree(tmp);
802                 break;
803             }
804
805         case FF_0DECIMAL: /* like FF_DECIMAL but for 0### */
806             arg = *fpc++;
807             fmt = (const char *)
808                 ((arg & FORM_NUM_POINT) ? "%#0*.*" NVff : "%0*.*" NVff);
809             goto ff_dec;
810
811         case FF_DECIMAL: /* do @##, ^##, where <arg>=(precision|flags) */
812             arg = *fpc++;
813             fmt = (const char *)
814                 ((arg & FORM_NUM_POINT) ? "%#*.*" NVff : "%*.*" NVff);
815         ff_dec:
816             /* If the field is marked with ^ and the value is undefined,
817                blank it out. */
818             if ((arg & FORM_NUM_BLANK) && !SvOK(sv)) {
819                 arg = fieldsize;
820                 while (arg--)
821                     *t++ = ' ';
822                 break;
823             }
824             gotsome = TRUE;
825             value = SvNV(sv);
826             /* overflow evidence */
827             if (num_overflow(value, fieldsize, arg)) {
828                 arg = fieldsize;
829                 while (arg--)
830                     *t++ = '#';
831                 break;
832             }
833             /* Formats aren't yet marked for locales, so assume "yes". */
834             {
835                 Size_t max = SvLEN(PL_formtarget) - (t - SvPVX(PL_formtarget));
836                 int len;
837                 DECLARATION_FOR_LC_NUMERIC_MANIPULATION;
838                 STORE_LC_NUMERIC_SET_TO_NEEDED();
839                 arg &= ~(FORM_NUM_POINT|FORM_NUM_BLANK);
840 #ifdef USE_QUADMATH
841                 {
842                     const char* qfmt = quadmath_format_single(fmt);
843                     int len;
844                     if (!qfmt)
845                         Perl_croak_nocontext("panic: quadmath invalid format \"%s\"", fmt);
846                     len = quadmath_snprintf(t, max, qfmt, (int) fieldsize, (int) arg, value);
847                     if (len == -1)
848                         Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", qfmt);
849                     if (qfmt != fmt)
850                         Safefree(fmt);
851                 }
852 #else
853                 /* we generate fmt ourselves so it is safe */
854                 GCC_DIAG_IGNORE(-Wformat-nonliteral);
855                 len = my_snprintf(t, max, fmt, (int) fieldsize, (int) arg, value);
856                 GCC_DIAG_RESTORE;
857 #endif
858                 PERL_MY_SNPRINTF_POST_GUARD(len, max);
859                 RESTORE_LC_NUMERIC();
860             }
861             t += fieldsize;
862             break;
863
864         case FF_NEWLINE: /* delete trailing spaces, then append \n */
865             f++;
866             while (t-- > (SvPVX(PL_formtarget) + linemark) && *t == ' ') ;
867             t++;
868             *t++ = '\n';
869             break;
870
871         case FF_BLANK: /* for arg==0: do '~'; for arg>0 : do '~~' */
872             arg = *fpc++;
873             if (gotsome) {
874                 if (arg) {              /* repeat until fields exhausted? */
875                     fpc--;
876                     goto end;
877                 }
878             }
879             else {
880                 t = SvPVX(PL_formtarget) + linemark;
881                 lines--;
882             }
883             break;
884
885         case FF_MORE: /* replace long end of string with '...' */
886             {
887                 const char *s = chophere;
888                 const char *send = item + len;
889                 if (chopspace) {
890                     while (isSPACE(*s) && (s < send))
891                         s++;
892                 }
893                 if (s < send) {
894                     char *s1;
895                     arg = fieldsize - itemsize;
896                     if (arg) {
897                         fieldsize -= arg;
898                         while (arg-- > 0)
899                             *t++ = ' ';
900                     }
901                     s1 = t - 3;
902                     if (strnEQ(s1,"   ",3)) {
903                         while (s1 > SvPVX_const(PL_formtarget) && isSPACE(s1[-1]))
904                             s1--;
905                     }
906                     *s1++ = '.';
907                     *s1++ = '.';
908                     *s1++ = '.';
909                 }
910                 break;
911             }
912
913         case FF_END: /* tidy up, then return */
914         end:
915             assert(t < SvPVX_const(PL_formtarget) + SvLEN(PL_formtarget));
916             *t = '\0';
917             SvCUR_set(PL_formtarget, t - SvPVX_const(PL_formtarget));
918             if (targ_is_utf8)
919                 SvUTF8_on(PL_formtarget);
920             FmLINES(PL_formtarget) += lines;
921             SP = ORIGMARK;
922             if (fpc[-1] == FF_BLANK)
923                 RETURNOP(cLISTOP->op_first);
924             else
925                 RETPUSHYES;
926         }
927     }
928 }
929
930 PP(pp_grepstart)
931 {
932     dSP;
933     SV *src;
934
935     if (PL_stack_base + TOPMARK == SP) {
936         (void)POPMARK;
937         if (GIMME_V == G_SCALAR)
938             mXPUSHi(0);
939         RETURNOP(PL_op->op_next->op_next);
940     }
941     PL_stack_sp = PL_stack_base + TOPMARK + 1;
942     Perl_pp_pushmark(aTHX);                             /* push dst */
943     Perl_pp_pushmark(aTHX);                             /* push src */
944     ENTER_with_name("grep");                                    /* enter outer scope */
945
946     SAVETMPS;
947     SAVE_DEFSV;
948     ENTER_with_name("grep_item");                                       /* enter inner scope */
949     SAVEVPTR(PL_curpm);
950
951     src = PL_stack_base[TOPMARK];
952     if (SvPADTMP(src)) {
953         src = PL_stack_base[TOPMARK] = sv_mortalcopy(src);
954         PL_tmps_floor++;
955     }
956     SvTEMP_off(src);
957     DEFSV_set(src);
958
959     PUTBACK;
960     if (PL_op->op_type == OP_MAPSTART)
961         Perl_pp_pushmark(aTHX);                 /* push top */
962     return ((LOGOP*)PL_op->op_next)->op_other;
963 }
964
965 PP(pp_mapwhile)
966 {
967     dSP;
968     const I32 gimme = GIMME_V;
969     I32 items = (SP - PL_stack_base) - TOPMARK; /* how many new items */
970     I32 count;
971     I32 shift;
972     SV** src;
973     SV** dst;
974
975     /* first, move source pointer to the next item in the source list */
976     ++PL_markstack_ptr[-1];
977
978     /* if there are new items, push them into the destination list */
979     if (items && gimme != G_VOID) {
980         /* might need to make room back there first */
981         if (items > PL_markstack_ptr[-1] - PL_markstack_ptr[-2]) {
982             /* XXX this implementation is very pessimal because the stack
983              * is repeatedly extended for every set of items.  Is possible
984              * to do this without any stack extension or copying at all
985              * by maintaining a separate list over which the map iterates
986              * (like foreach does). --gsar */
987
988             /* everything in the stack after the destination list moves
989              * towards the end the stack by the amount of room needed */
990             shift = items - (PL_markstack_ptr[-1] - PL_markstack_ptr[-2]);
991
992             /* items to shift up (accounting for the moved source pointer) */
993             count = (SP - PL_stack_base) - (PL_markstack_ptr[-1] - 1);
994
995             /* This optimization is by Ben Tilly and it does
996              * things differently from what Sarathy (gsar)
997              * is describing.  The downside of this optimization is
998              * that leaves "holes" (uninitialized and hopefully unused areas)
999              * to the Perl stack, but on the other hand this
1000              * shouldn't be a problem.  If Sarathy's idea gets
1001              * implemented, this optimization should become
1002              * irrelevant.  --jhi */
1003             if (shift < count)
1004                 shift = count; /* Avoid shifting too often --Ben Tilly */
1005
1006             EXTEND(SP,shift);
1007             src = SP;
1008             dst = (SP += shift);
1009             PL_markstack_ptr[-1] += shift;
1010             *PL_markstack_ptr += shift;
1011             while (count--)
1012                 *dst-- = *src--;
1013         }
1014         /* copy the new items down to the destination list */
1015         dst = PL_stack_base + (PL_markstack_ptr[-2] += items) - 1;
1016         if (gimme == G_ARRAY) {
1017             /* add returned items to the collection (making mortal copies
1018              * if necessary), then clear the current temps stack frame
1019              * *except* for those items. We do this splicing the items
1020              * into the start of the tmps frame (so some items may be on
1021              * the tmps stack twice), then moving PL_tmps_floor above
1022              * them, then freeing the frame. That way, the only tmps that
1023              * accumulate over iterations are the return values for map.
1024              * We have to do to this way so that everything gets correctly
1025              * freed if we die during the map.
1026              */
1027             I32 tmpsbase;
1028             I32 i = items;
1029             /* make space for the slice */
1030             EXTEND_MORTAL(items);
1031             tmpsbase = PL_tmps_floor + 1;
1032             Move(PL_tmps_stack + tmpsbase,
1033                  PL_tmps_stack + tmpsbase + items,
1034                  PL_tmps_ix - PL_tmps_floor,
1035                  SV*);
1036             PL_tmps_ix += items;
1037
1038             while (i-- > 0) {
1039                 SV *sv = POPs;
1040                 if (!SvTEMP(sv))
1041                     sv = sv_mortalcopy(sv);
1042                 *dst-- = sv;
1043                 PL_tmps_stack[tmpsbase++] = SvREFCNT_inc_simple(sv);
1044             }
1045             /* clear the stack frame except for the items */
1046             PL_tmps_floor += items;
1047             FREETMPS;
1048             /* FREETMPS may have cleared the TEMP flag on some of the items */
1049             i = items;
1050             while (i-- > 0)
1051                 SvTEMP_on(PL_tmps_stack[--tmpsbase]);
1052         }
1053         else {
1054             /* scalar context: we don't care about which values map returns
1055              * (we use undef here). And so we certainly don't want to do mortal
1056              * copies of meaningless values. */
1057             while (items-- > 0) {
1058                 (void)POPs;
1059                 *dst-- = &PL_sv_undef;
1060             }
1061             FREETMPS;
1062         }
1063     }
1064     else {
1065         FREETMPS;
1066     }
1067     LEAVE_with_name("grep_item");                                       /* exit inner scope */
1068
1069     /* All done yet? */
1070     if (PL_markstack_ptr[-1] > TOPMARK) {
1071
1072         (void)POPMARK;                          /* pop top */
1073         LEAVE_with_name("grep");                                        /* exit outer scope */
1074         (void)POPMARK;                          /* pop src */
1075         items = --*PL_markstack_ptr - PL_markstack_ptr[-1];
1076         (void)POPMARK;                          /* pop dst */
1077         SP = PL_stack_base + POPMARK;           /* pop original mark */
1078         if (gimme == G_SCALAR) {
1079                 dTARGET;
1080                 XPUSHi(items);
1081         }
1082         else if (gimme == G_ARRAY)
1083             SP += items;
1084         RETURN;
1085     }
1086     else {
1087         SV *src;
1088
1089         ENTER_with_name("grep_item");                                   /* enter inner scope */
1090         SAVEVPTR(PL_curpm);
1091
1092         /* set $_ to the new source item */
1093         src = PL_stack_base[PL_markstack_ptr[-1]];
1094         if (SvPADTMP(src)) {
1095             src = sv_mortalcopy(src);
1096         }
1097         SvTEMP_off(src);
1098         DEFSV_set(src);
1099
1100         RETURNOP(cLOGOP->op_other);
1101     }
1102 }
1103
1104 /* Range stuff. */
1105
1106 PP(pp_range)
1107 {
1108     if (GIMME_V == G_ARRAY)
1109         return NORMAL;
1110     if (SvTRUEx(PAD_SV(PL_op->op_targ)))
1111         return cLOGOP->op_other;
1112     else
1113         return NORMAL;
1114 }
1115
1116 PP(pp_flip)
1117 {
1118     dSP;
1119
1120     if (GIMME_V == G_ARRAY) {
1121         RETURNOP(((LOGOP*)cUNOP->op_first)->op_other);
1122     }
1123     else {
1124         dTOPss;
1125         SV * const targ = PAD_SV(PL_op->op_targ);
1126         int flip = 0;
1127
1128         if (PL_op->op_private & OPpFLIP_LINENUM) {
1129             if (GvIO(PL_last_in_gv)) {
1130                 flip = SvIV(sv) == (IV)IoLINES(GvIOp(PL_last_in_gv));
1131             }
1132             else {
1133                 GV * const gv = gv_fetchpvs(".", GV_ADD|GV_NOTQUAL, SVt_PV);
1134                 if (gv && GvSV(gv))
1135                     flip = SvIV(sv) == SvIV(GvSV(gv));
1136             }
1137         } else {
1138             flip = SvTRUE(sv);
1139         }
1140         if (flip) {
1141             sv_setiv(PAD_SV(cUNOP->op_first->op_targ), 1);
1142             if (PL_op->op_flags & OPf_SPECIAL) {
1143                 sv_setiv(targ, 1);
1144                 SETs(targ);
1145                 RETURN;
1146             }
1147             else {
1148                 sv_setiv(targ, 0);
1149                 SP--;
1150                 RETURNOP(((LOGOP*)cUNOP->op_first)->op_other);
1151             }
1152         }
1153         sv_setpvs(TARG, "");
1154         SETs(targ);
1155         RETURN;
1156     }
1157 }
1158
1159 /* This code tries to decide if "$left .. $right" should use the
1160    magical string increment, or if the range is numeric (we make
1161    an exception for .."0" [#18165]). AMS 20021031. */
1162
1163 #define RANGE_IS_NUMERIC(left,right) ( \
1164         SvNIOKp(left)  || (SvOK(left)  && !SvPOKp(left))  || \
1165         SvNIOKp(right) || (SvOK(right) && !SvPOKp(right)) || \
1166         (((!SvOK(left) && SvOK(right)) || ((!SvOK(left) || \
1167           looks_like_number(left)) && SvPOKp(left) && *SvPVX_const(left) != '0')) \
1168          && (!SvOK(right) || looks_like_number(right))))
1169
1170 PP(pp_flop)
1171 {
1172     dSP;
1173
1174     if (GIMME_V == G_ARRAY) {
1175         dPOPPOPssrl;
1176
1177         SvGETMAGIC(left);
1178         SvGETMAGIC(right);
1179
1180         if (RANGE_IS_NUMERIC(left,right)) {
1181             IV i, j, n;
1182             if ((SvOK(left) && !SvIOK(left) && SvNV_nomg(left) < IV_MIN) ||
1183                 (SvOK(right) && (SvIOK(right)
1184                                  ? SvIsUV(right) && SvUV(right) > IV_MAX
1185                                  : SvNV_nomg(right) > IV_MAX)))
1186                 DIE(aTHX_ "Range iterator outside integer range");
1187             i = SvIV_nomg(left);
1188             j = SvIV_nomg(right);
1189             if (j >= i) {
1190                 /* Dance carefully around signed max. */
1191                 bool overflow = (i <= 0 && j > SSize_t_MAX + i - 1);
1192                 if (!overflow) {
1193                     n = j - i + 1;
1194                     /* The wraparound of signed integers is undefined
1195                      * behavior, but here we aim for count >=1, and
1196                      * negative count is just wrong. */
1197                     if (n < 1
1198 #if IVSIZE > Size_t_size
1199                         || n > SSize_t_MAX
1200 #endif
1201                         )
1202                         overflow = TRUE;
1203                 }
1204                 if (overflow)
1205                     Perl_croak(aTHX_ "Out of memory during list extend");
1206                 EXTEND_MORTAL(n);
1207                 EXTEND(SP, n);
1208             }
1209             else
1210                 n = 0;
1211             while (n--) {
1212                 SV * const sv = sv_2mortal(newSViv(i));
1213                 PUSHs(sv);
1214                 if (n) /* avoid incrementing above IV_MAX */
1215                     i++;
1216             }
1217         }
1218         else {
1219             STRLEN len, llen;
1220             const char * const lpv = SvPV_nomg_const(left, llen);
1221             const char * const tmps = SvPV_nomg_const(right, len);
1222
1223             SV *sv = newSVpvn_flags(lpv, llen, SvUTF8(left)|SVs_TEMP);
1224             while (!SvNIOKp(sv) && SvCUR(sv) <= len) {
1225                 XPUSHs(sv);
1226                 if (strEQ(SvPVX_const(sv),tmps))
1227                     break;
1228                 sv = sv_2mortal(newSVsv(sv));
1229                 sv_inc(sv);
1230             }
1231         }
1232     }
1233     else {
1234         dTOPss;
1235         SV * const targ = PAD_SV(cUNOP->op_first->op_targ);
1236         int flop = 0;
1237         sv_inc(targ);
1238
1239         if (PL_op->op_private & OPpFLIP_LINENUM) {
1240             if (GvIO(PL_last_in_gv)) {
1241                 flop = SvIV(sv) == (IV)IoLINES(GvIOp(PL_last_in_gv));
1242             }
1243             else {
1244                 GV * const gv = gv_fetchpvs(".", GV_ADD|GV_NOTQUAL, SVt_PV);
1245                 if (gv && GvSV(gv)) flop = SvIV(sv) == SvIV(GvSV(gv));
1246             }
1247         }
1248         else {
1249             flop = SvTRUE(sv);
1250         }
1251
1252         if (flop) {
1253             sv_setiv(PAD_SV(((UNOP*)cUNOP->op_first)->op_first->op_targ), 0);
1254             sv_catpvs(targ, "E0");
1255         }
1256         SETs(targ);
1257     }
1258
1259     RETURN;
1260 }
1261
1262 /* Control. */
1263
1264 static const char * const context_name[] = {
1265     "pseudo-block",
1266     NULL, /* CXt_WHEN never actually needs "block" */
1267     NULL, /* CXt_BLOCK never actually needs "block" */
1268     NULL, /* CXt_GIVEN never actually needs "block" */
1269     NULL, /* CXt_LOOP_PLAIN never actually needs "loop" */
1270     NULL, /* CXt_LOOP_LAZYIV never actually needs "loop" */
1271     NULL, /* CXt_LOOP_LAZYSV never actually needs "loop" */
1272     NULL, /* CXt_LOOP_LIST never actually needs "loop" */
1273     NULL, /* CXt_LOOP_ARY never actually needs "loop" */
1274     "subroutine",
1275     "format",
1276     "eval",
1277     "substitution",
1278 };
1279
1280 STATIC I32
1281 S_dopoptolabel(pTHX_ const char *label, STRLEN len, U32 flags)
1282 {
1283     I32 i;
1284
1285     PERL_ARGS_ASSERT_DOPOPTOLABEL;
1286
1287     for (i = cxstack_ix; i >= 0; i--) {
1288         const PERL_CONTEXT * const cx = &cxstack[i];
1289         switch (CxTYPE(cx)) {
1290         case CXt_SUBST:
1291         case CXt_SUB:
1292         case CXt_FORMAT:
1293         case CXt_EVAL:
1294         case CXt_NULL:
1295             /* diag_listed_as: Exiting subroutine via %s */
1296             Perl_ck_warner(aTHX_ packWARN(WARN_EXITING), "Exiting %s via %s",
1297                            context_name[CxTYPE(cx)], OP_NAME(PL_op));
1298             if (CxTYPE(cx) == CXt_NULL) /* sort BLOCK */
1299                 return -1;
1300             break;
1301         case CXt_LOOP_PLAIN:
1302         case CXt_LOOP_LAZYIV:
1303         case CXt_LOOP_LAZYSV:
1304         case CXt_LOOP_LIST:
1305         case CXt_LOOP_ARY:
1306           {
1307             STRLEN cx_label_len = 0;
1308             U32 cx_label_flags = 0;
1309             const char *cx_label = CxLABEL_len_flags(cx, &cx_label_len, &cx_label_flags);
1310             if (!cx_label || !(
1311                     ( (cx_label_flags & SVf_UTF8) != (flags & SVf_UTF8) ) ?
1312                         (flags & SVf_UTF8)
1313                             ? (bytes_cmp_utf8(
1314                                         (const U8*)cx_label, cx_label_len,
1315                                         (const U8*)label, len) == 0)
1316                             : (bytes_cmp_utf8(
1317                                         (const U8*)label, len,
1318                                         (const U8*)cx_label, cx_label_len) == 0)
1319                     : (len == cx_label_len && ((cx_label == label)
1320                                     || memEQ(cx_label, label, len))) )) {
1321                 DEBUG_l(Perl_deb(aTHX_ "(poptolabel(): skipping label at cx=%ld %s)\n",
1322                         (long)i, cx_label));
1323                 continue;
1324             }
1325             DEBUG_l( Perl_deb(aTHX_ "(poptolabel(): found label at cx=%ld %s)\n", (long)i, label));
1326             return i;
1327           }
1328         }
1329     }
1330     return i;
1331 }
1332
1333
1334
1335 I32
1336 Perl_dowantarray(pTHX)
1337 {
1338     const I32 gimme = block_gimme();
1339     return (gimme == G_VOID) ? G_SCALAR : gimme;
1340 }
1341
1342 I32
1343 Perl_block_gimme(pTHX)
1344 {
1345     const I32 cxix = dopoptosub(cxstack_ix);
1346     U8 gimme;
1347     if (cxix < 0)
1348         return G_VOID;
1349
1350     gimme = (cxstack[cxix].blk_gimme & G_WANT);
1351     if (!gimme)
1352         Perl_croak(aTHX_ "panic: bad gimme: %d\n", gimme);
1353     return gimme;
1354 }
1355
1356
1357 I32
1358 Perl_is_lvalue_sub(pTHX)
1359 {
1360     const I32 cxix = dopoptosub(cxstack_ix);
1361     assert(cxix >= 0);  /* We should only be called from inside subs */
1362
1363     if (CxLVAL(cxstack + cxix) && CvLVALUE(cxstack[cxix].blk_sub.cv))
1364         return CxLVAL(cxstack + cxix);
1365     else
1366         return 0;
1367 }
1368
1369 /* only used by PUSHSUB */
1370 I32
1371 Perl_was_lvalue_sub(pTHX)
1372 {
1373     const I32 cxix = dopoptosub(cxstack_ix-1);
1374     assert(cxix >= 0);  /* We should only be called from inside subs */
1375
1376     if (CxLVAL(cxstack + cxix) && CvLVALUE(cxstack[cxix].blk_sub.cv))
1377         return CxLVAL(cxstack + cxix);
1378     else
1379         return 0;
1380 }
1381
1382 STATIC I32
1383 S_dopoptosub_at(pTHX_ const PERL_CONTEXT *cxstk, I32 startingblock)
1384 {
1385     I32 i;
1386
1387     PERL_ARGS_ASSERT_DOPOPTOSUB_AT;
1388 #ifndef DEBUGGING
1389     PERL_UNUSED_CONTEXT;
1390 #endif
1391
1392     for (i = startingblock; i >= 0; i--) {
1393         const PERL_CONTEXT * const cx = &cxstk[i];
1394         switch (CxTYPE(cx)) {
1395         default:
1396             continue;
1397         case CXt_SUB:
1398             /* in sub foo { /(?{...})/ }, foo ends up on the CX stack
1399              * twice; the first for the normal foo() call, and the second
1400              * for a faked up re-entry into the sub to execute the
1401              * code block. Hide this faked entry from the world. */
1402             if (cx->cx_type & CXp_SUB_RE_FAKE)
1403                 continue;
1404             /* FALLTHROUGH */
1405         case CXt_EVAL:
1406         case CXt_FORMAT:
1407             DEBUG_l( Perl_deb(aTHX_ "(dopoptosub_at(): found sub at cx=%ld)\n", (long)i));
1408             return i;
1409         }
1410     }
1411     return i;
1412 }
1413
1414 STATIC I32
1415 S_dopoptoeval(pTHX_ I32 startingblock)
1416 {
1417     I32 i;
1418     for (i = startingblock; i >= 0; i--) {
1419         const PERL_CONTEXT *cx = &cxstack[i];
1420         switch (CxTYPE(cx)) {
1421         default:
1422             continue;
1423         case CXt_EVAL:
1424             DEBUG_l( Perl_deb(aTHX_ "(dopoptoeval(): found eval at cx=%ld)\n", (long)i));
1425             return i;
1426         }
1427     }
1428     return i;
1429 }
1430
1431 STATIC I32
1432 S_dopoptoloop(pTHX_ I32 startingblock)
1433 {
1434     I32 i;
1435     for (i = startingblock; i >= 0; i--) {
1436         const PERL_CONTEXT * const cx = &cxstack[i];
1437         switch (CxTYPE(cx)) {
1438         case CXt_SUBST:
1439         case CXt_SUB:
1440         case CXt_FORMAT:
1441         case CXt_EVAL:
1442         case CXt_NULL:
1443             /* diag_listed_as: Exiting subroutine via %s */
1444             Perl_ck_warner(aTHX_ packWARN(WARN_EXITING), "Exiting %s via %s",
1445                            context_name[CxTYPE(cx)], OP_NAME(PL_op));
1446             if ((CxTYPE(cx)) == CXt_NULL) /* sort BLOCK */
1447                 return -1;
1448             break;
1449         case CXt_LOOP_PLAIN:
1450         case CXt_LOOP_LAZYIV:
1451         case CXt_LOOP_LAZYSV:
1452         case CXt_LOOP_LIST:
1453         case CXt_LOOP_ARY:
1454             DEBUG_l( Perl_deb(aTHX_ "(dopoptoloop(): found loop at cx=%ld)\n", (long)i));
1455             return i;
1456         }
1457     }
1458     return i;
1459 }
1460
1461 /* find the next GIVEN or FOR loop context block */
1462
1463 STATIC I32
1464 S_dopoptogivenfor(pTHX_ I32 startingblock)
1465 {
1466     I32 i;
1467     for (i = startingblock; i >= 0; i--) {
1468         const PERL_CONTEXT *cx = &cxstack[i];
1469         switch (CxTYPE(cx)) {
1470         default:
1471             continue;
1472         case CXt_GIVEN:
1473             DEBUG_l( Perl_deb(aTHX_ "(dopoptogivenfor(): found given at cx=%ld)\n", (long)i));
1474             return i;
1475         case CXt_LOOP_PLAIN:
1476             assert(!(cx->cx_type & CXp_FOR_DEF));
1477             break;
1478         case CXt_LOOP_LAZYIV:
1479         case CXt_LOOP_LAZYSV:
1480         case CXt_LOOP_LIST:
1481         case CXt_LOOP_ARY:
1482             if (cx->cx_type & CXp_FOR_DEF) {
1483                 DEBUG_l( Perl_deb(aTHX_ "(dopoptogivenfor(): found foreach at cx=%ld)\n", (long)i));
1484                 return i;
1485             }
1486         }
1487     }
1488     return i;
1489 }
1490
1491 STATIC I32
1492 S_dopoptowhen(pTHX_ I32 startingblock)
1493 {
1494     I32 i;
1495     for (i = startingblock; i >= 0; i--) {
1496         const PERL_CONTEXT *cx = &cxstack[i];
1497         switch (CxTYPE(cx)) {
1498         default:
1499             continue;
1500         case CXt_WHEN:
1501             DEBUG_l( Perl_deb(aTHX_ "(dopoptowhen(): found when at cx=%ld)\n", (long)i));
1502             return i;
1503         }
1504     }
1505     return i;
1506 }
1507
1508 /* dounwind(): pop all contexts above (but not including) cxix.
1509  * Leaves cxstack_ix equal to cxix. Note that for efficiency, it doesn't
1510  * call POPBLOCK at all; the caller should do
1511  *     CX_LEAVE_SCOPE; POPFOO; POPBLOCK
1512  * or
1513  *     TOPBLOCK
1514  * as appropriate.
1515  */
1516
1517 void
1518 Perl_dounwind(pTHX_ I32 cxix)
1519 {
1520     if (!PL_curstackinfo) /* can happen if die during thread cloning */
1521         return;
1522
1523     while (cxstack_ix > cxix) {
1524         PERL_CONTEXT *cx = CX_CUR();
1525
1526         CX_DEBUG(cx, "UNWIND");
1527         /* Note: we don't need to restore the base context info till the end. */
1528
1529         CX_LEAVE_SCOPE(cx);
1530
1531         switch (CxTYPE(cx)) {
1532         case CXt_SUBST:
1533             POPSUBST(cx);
1534             break;
1535         case CXt_SUB:
1536             POPSUB(cx);
1537             break;
1538         case CXt_EVAL:
1539             POPEVAL(cx);
1540             break;
1541         case CXt_BLOCK:
1542             POPBASICBLK(cx);
1543             break;
1544         case CXt_LOOP_PLAIN:
1545         case CXt_LOOP_LAZYIV:
1546         case CXt_LOOP_LAZYSV:
1547         case CXt_LOOP_LIST:
1548         case CXt_LOOP_ARY:
1549             POPLOOP(cx);
1550             break;
1551         case CXt_WHEN:
1552             POPWHEN(cx);
1553             break;
1554         case CXt_GIVEN:
1555             POPGIVEN(cx);
1556             break;
1557         case CXt_NULL:
1558             /* there isn't a POPNULL ! */
1559             break;
1560         case CXt_FORMAT:
1561             POPFORMAT(cx);
1562             break;
1563         }
1564         cxstack_ix--;
1565     }
1566 }
1567
1568 void
1569 Perl_qerror(pTHX_ SV *err)
1570 {
1571     PERL_ARGS_ASSERT_QERROR;
1572
1573     if (PL_in_eval) {
1574         if (PL_in_eval & EVAL_KEEPERR) {
1575                 Perl_ck_warner(aTHX_ packWARN(WARN_MISC), "\t(in cleanup) %"SVf,
1576                                                     SVfARG(err));
1577         }
1578         else
1579             sv_catsv(ERRSV, err);
1580     }
1581     else if (PL_errors)
1582         sv_catsv(PL_errors, err);
1583     else
1584         Perl_warn(aTHX_ "%"SVf, SVfARG(err));
1585     if (PL_parser)
1586         ++PL_parser->error_count;
1587 }
1588
1589
1590
1591 /* undef or delete the $INC{namesv} entry, then croak.
1592  * require0 indicates that the require didn't return a true value */
1593
1594 static void
1595 S_undo_inc_then_croak(pTHX_ SV *namesv, SV *err, bool require0)
1596 {
1597     const char *fmt;
1598     HV *inc_hv = GvHVn(PL_incgv);
1599     I32  klen  = SvUTF8(namesv) ? -(I32)SvCUR(namesv) : (I32)SvCUR(namesv);
1600     const char *key = SvPVX_const(namesv);
1601
1602     if (require0) {
1603         (void)hv_delete(inc_hv, key, klen, G_DISCARD);
1604         fmt = "%"SVf" did not return a true value";
1605         err = namesv;
1606     }
1607     else {
1608         (void)hv_store(inc_hv, key, klen, &PL_sv_undef, 0);
1609         fmt = "%"SVf"Compilation failed in require";
1610         err = err ? err : newSVpvs_flags("Unknown error\n", SVs_TEMP);
1611     }
1612
1613     Perl_croak(aTHX_ fmt, SVfARG(err));
1614 }
1615
1616
1617 void
1618 Perl_die_unwind(pTHX_ SV *msv)
1619 {
1620     SV *exceptsv = sv_mortalcopy(msv);
1621     U8 in_eval = PL_in_eval;
1622     PERL_ARGS_ASSERT_DIE_UNWIND;
1623
1624     if (in_eval) {
1625         I32 cxix;
1626
1627         /*
1628          * Historically, perl used to set ERRSV ($@) early in the die
1629          * process and rely on it not getting clobbered during unwinding.
1630          * That sucked, because it was liable to get clobbered, so the
1631          * setting of ERRSV used to emit the exception from eval{} has
1632          * been moved to much later, after unwinding (see just before
1633          * JMPENV_JUMP below).  However, some modules were relying on the
1634          * early setting, by examining $@ during unwinding to use it as
1635          * a flag indicating whether the current unwinding was caused by
1636          * an exception.  It was never a reliable flag for that purpose,
1637          * being totally open to false positives even without actual
1638          * clobberage, but was useful enough for production code to
1639          * semantically rely on it.
1640          *
1641          * We'd like to have a proper introspective interface that
1642          * explicitly describes the reason for whatever unwinding
1643          * operations are currently in progress, so that those modules
1644          * work reliably and $@ isn't further overloaded.  But we don't
1645          * have one yet.  In its absence, as a stopgap measure, ERRSV is
1646          * now *additionally* set here, before unwinding, to serve as the
1647          * (unreliable) flag that it used to.
1648          *
1649          * This behaviour is temporary, and should be removed when a
1650          * proper way to detect exceptional unwinding has been developed.
1651          * As of 2010-12, the authors of modules relying on the hack
1652          * are aware of the issue, because the modules failed on
1653          * perls 5.13.{1..7} which had late setting of $@ without this
1654          * early-setting hack.
1655          */
1656         if (!(in_eval & EVAL_KEEPERR)) {
1657             SvTEMP_off(exceptsv);
1658             sv_setsv(ERRSV, exceptsv);
1659         }
1660
1661         if (in_eval & EVAL_KEEPERR) {
1662             Perl_ck_warner(aTHX_ packWARN(WARN_MISC), "\t(in cleanup) %"SVf,
1663                            SVfARG(exceptsv));
1664         }
1665
1666         while ((cxix = dopoptoeval(cxstack_ix)) < 0
1667                && PL_curstackinfo->si_prev)
1668         {
1669             dounwind(-1);
1670             POPSTACK;
1671         }
1672
1673         if (cxix >= 0) {
1674             SV *namesv = NULL;
1675             PERL_CONTEXT *cx;
1676             SV **oldsp;
1677             I32 gimme;
1678             JMPENV *restartjmpenv;
1679             OP *restartop;
1680
1681             if (cxix < cxstack_ix)
1682                 dounwind(cxix);
1683
1684             cx = CX_CUR();
1685             assert(CxTYPE(cx) == CXt_EVAL);
1686
1687             /* return false to the caller of eval */
1688             oldsp = PL_stack_base + cx->blk_oldsp;
1689             gimme = cx->blk_gimme;
1690             if (gimme == G_SCALAR)
1691                 *++oldsp = &PL_sv_undef;
1692             PL_stack_sp = oldsp;
1693
1694             CX_LEAVE_SCOPE(cx);
1695             POPEVAL(cx);
1696             POPBLOCK(cx);
1697             restartjmpenv = cx->blk_eval.cur_top_env;
1698             restartop = cx->blk_eval.retop;
1699             if (CxOLD_OP_TYPE(cx) == OP_REQUIRE)
1700                 namesv = cx->blk_eval.old_namesv;
1701             CX_POP(cx);
1702
1703             if (namesv) {
1704                 /* note that unlike pp_entereval, pp_require isn't
1705                  * supposed to trap errors. So now that we've popped the
1706                  * EVAL that pp_require pushed, process the error message
1707                  * and rethrow the error */
1708                 S_undo_inc_then_croak(aTHX_ namesv, exceptsv, FALSE);
1709                 NOT_REACHED; /* NOTREACHED */
1710             }
1711
1712             if (!(in_eval & EVAL_KEEPERR))
1713                 sv_setsv(ERRSV, exceptsv);
1714             PL_restartjmpenv = restartjmpenv;
1715             PL_restartop = restartop;
1716             JMPENV_JUMP(3);
1717             NOT_REACHED; /* NOTREACHED */
1718         }
1719     }
1720
1721     write_to_stderr(exceptsv);
1722     my_failure_exit();
1723     NOT_REACHED; /* NOTREACHED */
1724 }
1725
1726 PP(pp_xor)
1727 {
1728     dSP; dPOPTOPssrl;
1729     if (SvTRUE(left) != SvTRUE(right))
1730         RETSETYES;
1731     else
1732         RETSETNO;
1733 }
1734
1735 /*
1736
1737 =head1 CV Manipulation Functions
1738
1739 =for apidoc caller_cx
1740
1741 The XSUB-writer's equivalent of L<caller()|perlfunc/caller>.  The
1742 returned C<PERL_CONTEXT> structure can be interrogated to find all the
1743 information returned to Perl by C<caller>.  Note that XSUBs don't get a
1744 stack frame, so C<caller_cx(0, NULL)> will return information for the
1745 immediately-surrounding Perl code.
1746
1747 This function skips over the automatic calls to C<&DB::sub> made on the
1748 behalf of the debugger.  If the stack frame requested was a sub called by
1749 C<DB::sub>, the return value will be the frame for the call to
1750 C<DB::sub>, since that has the correct line number/etc. for the call
1751 site.  If I<dbcxp> is non-C<NULL>, it will be set to a pointer to the
1752 frame for the sub call itself.
1753
1754 =cut
1755 */
1756
1757 const PERL_CONTEXT *
1758 Perl_caller_cx(pTHX_ I32 count, const PERL_CONTEXT **dbcxp)
1759 {
1760     I32 cxix = dopoptosub(cxstack_ix);
1761     const PERL_CONTEXT *cx;
1762     const PERL_CONTEXT *ccstack = cxstack;
1763     const PERL_SI *top_si = PL_curstackinfo;
1764
1765     for (;;) {
1766         /* we may be in a higher stacklevel, so dig down deeper */
1767         while (cxix < 0 && top_si->si_type != PERLSI_MAIN) {
1768             top_si = top_si->si_prev;
1769             ccstack = top_si->si_cxstack;
1770             cxix = dopoptosub_at(ccstack, top_si->si_cxix);
1771         }
1772         if (cxix < 0)
1773             return NULL;
1774         /* caller() should not report the automatic calls to &DB::sub */
1775         if (PL_DBsub && GvCV(PL_DBsub) && cxix >= 0 &&
1776                 ccstack[cxix].blk_sub.cv == GvCV(PL_DBsub))
1777             count++;
1778         if (!count--)
1779             break;
1780         cxix = dopoptosub_at(ccstack, cxix - 1);
1781     }
1782
1783     cx = &ccstack[cxix];
1784     if (dbcxp) *dbcxp = cx;
1785
1786     if (CxTYPE(cx) == CXt_SUB || CxTYPE(cx) == CXt_FORMAT) {
1787         const I32 dbcxix = dopoptosub_at(ccstack, cxix - 1);
1788         /* We expect that ccstack[dbcxix] is CXt_SUB, anyway, the
1789            field below is defined for any cx. */
1790         /* caller() should not report the automatic calls to &DB::sub */
1791         if (PL_DBsub && GvCV(PL_DBsub) && dbcxix >= 0 && ccstack[dbcxix].blk_sub.cv == GvCV(PL_DBsub))
1792             cx = &ccstack[dbcxix];
1793     }
1794
1795     return cx;
1796 }
1797
1798 PP(pp_caller)
1799 {
1800     dSP;
1801     const PERL_CONTEXT *cx;
1802     const PERL_CONTEXT *dbcx;
1803     I32 gimme = GIMME_V;
1804     const HEK *stash_hek;
1805     I32 count = 0;
1806     bool has_arg = MAXARG && TOPs;
1807     const COP *lcop;
1808
1809     if (MAXARG) {
1810       if (has_arg)
1811         count = POPi;
1812       else (void)POPs;
1813     }
1814
1815     cx = caller_cx(count + !!(PL_op->op_private & OPpOFFBYONE), &dbcx);
1816     if (!cx) {
1817         if (gimme != G_ARRAY) {
1818             EXTEND(SP, 1);
1819             RETPUSHUNDEF;
1820         }
1821         RETURN;
1822     }
1823
1824     CX_DEBUG(cx, "CALLER");
1825     assert(CopSTASH(cx->blk_oldcop));
1826     stash_hek = SvTYPE(CopSTASH(cx->blk_oldcop)) == SVt_PVHV
1827       ? HvNAME_HEK((HV*)CopSTASH(cx->blk_oldcop))
1828       : NULL;
1829     if (gimme != G_ARRAY) {
1830         EXTEND(SP, 1);
1831         if (!stash_hek)
1832             PUSHs(&PL_sv_undef);
1833         else {
1834             dTARGET;
1835             sv_sethek(TARG, stash_hek);
1836             PUSHs(TARG);
1837         }
1838         RETURN;
1839     }
1840
1841     EXTEND(SP, 11);
1842
1843     if (!stash_hek)
1844         PUSHs(&PL_sv_undef);
1845     else {
1846         dTARGET;
1847         sv_sethek(TARG, stash_hek);
1848         PUSHTARG;
1849     }
1850     mPUSHs(newSVpv(OutCopFILE(cx->blk_oldcop), 0));
1851     lcop = closest_cop(cx->blk_oldcop, OpSIBLING(cx->blk_oldcop),
1852                        cx->blk_sub.retop, TRUE);
1853     if (!lcop)
1854         lcop = cx->blk_oldcop;
1855     mPUSHu(CopLINE(lcop));
1856     if (!has_arg)
1857         RETURN;
1858     if (CxTYPE(cx) == CXt_SUB || CxTYPE(cx) == CXt_FORMAT) {
1859         /* So is ccstack[dbcxix]. */
1860         if (CvHASGV(dbcx->blk_sub.cv)) {
1861             PUSHs(cv_name(dbcx->blk_sub.cv, 0, 0));
1862             PUSHs(boolSV(CxHASARGS(cx)));
1863         }
1864         else {
1865             PUSHs(newSVpvs_flags("(unknown)", SVs_TEMP));
1866             PUSHs(boolSV(CxHASARGS(cx)));
1867         }
1868     }
1869     else {
1870         PUSHs(newSVpvs_flags("(eval)", SVs_TEMP));
1871         mPUSHi(0);
1872     }
1873     gimme = (I32)cx->blk_gimme;
1874     if (gimme == G_VOID)
1875         PUSHs(&PL_sv_undef);
1876     else
1877         PUSHs(boolSV((gimme & G_WANT) == G_ARRAY));
1878     if (CxTYPE(cx) == CXt_EVAL) {
1879         /* eval STRING */
1880         if (CxOLD_OP_TYPE(cx) == OP_ENTEREVAL) {
1881             SV *cur_text = cx->blk_eval.cur_text;
1882             if (SvCUR(cur_text) >= 2) {
1883                 PUSHs(newSVpvn_flags(SvPVX(cur_text), SvCUR(cur_text)-2,
1884                                      SvUTF8(cur_text)|SVs_TEMP));
1885             }
1886             else {
1887                 /* I think this is will always be "", but be sure */
1888                 PUSHs(sv_2mortal(newSVsv(cur_text)));
1889             }
1890
1891             PUSHs(&PL_sv_no);
1892         }
1893         /* require */
1894         else if (cx->blk_eval.old_namesv) {
1895             mPUSHs(newSVsv(cx->blk_eval.old_namesv));
1896             PUSHs(&PL_sv_yes);
1897         }
1898         /* eval BLOCK (try blocks have old_namesv == 0) */
1899         else {
1900             PUSHs(&PL_sv_undef);
1901             PUSHs(&PL_sv_undef);
1902         }
1903     }
1904     else {
1905         PUSHs(&PL_sv_undef);
1906         PUSHs(&PL_sv_undef);
1907     }
1908     if (CxTYPE(cx) == CXt_SUB && CxHASARGS(cx)
1909         && CopSTASH_eq(PL_curcop, PL_debstash))
1910     {
1911         /* slot 0 of the pad contains the original @_ */
1912         AV * const ary = MUTABLE_AV(AvARRAY(MUTABLE_AV(
1913                             PadlistARRAY(CvPADLIST(cx->blk_sub.cv))[
1914                                 cx->blk_sub.olddepth+1]))[0]);
1915         const SSize_t off = AvARRAY(ary) - AvALLOC(ary);
1916
1917         Perl_init_dbargs(aTHX);
1918
1919         if (AvMAX(PL_dbargs) < AvFILLp(ary) + off)
1920             av_extend(PL_dbargs, AvFILLp(ary) + off);
1921         Copy(AvALLOC(ary), AvARRAY(PL_dbargs), AvFILLp(ary) + 1 + off, SV*);
1922         AvFILLp(PL_dbargs) = AvFILLp(ary) + off;
1923     }
1924     mPUSHi(CopHINTS_get(cx->blk_oldcop));
1925     {
1926         SV * mask ;
1927         STRLEN * const old_warnings = cx->blk_oldcop->cop_warnings ;
1928
1929         if  (old_warnings == pWARN_NONE)
1930             mask = newSVpvn(WARN_NONEstring, WARNsize) ;
1931         else if (old_warnings == pWARN_STD && (PL_dowarn & G_WARN_ON) == 0)
1932             mask = &PL_sv_undef ;
1933         else if (old_warnings == pWARN_ALL ||
1934                   (old_warnings == pWARN_STD && PL_dowarn & G_WARN_ON)) {
1935             /* Get the bit mask for $warnings::Bits{all}, because
1936              * it could have been extended by warnings::register */
1937             SV **bits_all;
1938             HV * const bits = get_hv("warnings::Bits", 0);
1939             if (bits && (bits_all=hv_fetchs(bits, "all", FALSE))) {
1940                 mask = newSVsv(*bits_all);
1941             }
1942             else {
1943                 mask = newSVpvn(WARN_ALLstring, WARNsize) ;
1944             }
1945         }
1946         else
1947             mask = newSVpvn((char *) (old_warnings + 1), old_warnings[0]);
1948         mPUSHs(mask);
1949     }
1950
1951     PUSHs(cx->blk_oldcop->cop_hints_hash ?
1952           sv_2mortal(newRV_noinc(MUTABLE_SV(cop_hints_2hv(cx->blk_oldcop, 0))))
1953           : &PL_sv_undef);
1954     RETURN;
1955 }
1956
1957 PP(pp_reset)
1958 {
1959     dSP;
1960     const char * tmps;
1961     STRLEN len = 0;
1962     if (MAXARG < 1 || (!TOPs && !POPs))
1963         tmps = NULL, len = 0;
1964     else
1965         tmps = SvPVx_const(POPs, len);
1966     sv_resetpvn(tmps, len, CopSTASH(PL_curcop));
1967     PUSHs(&PL_sv_yes);
1968     RETURN;
1969 }
1970
1971 /* like pp_nextstate, but used instead when the debugger is active */
1972
1973 PP(pp_dbstate)
1974 {
1975     PL_curcop = (COP*)PL_op;
1976     TAINT_NOT;          /* Each statement is presumed innocent */
1977     PL_stack_sp = PL_stack_base + CX_CUR()->blk_oldsp;
1978     FREETMPS;
1979
1980     PERL_ASYNC_CHECK();
1981
1982     if (PL_op->op_flags & OPf_SPECIAL /* breakpoint */
1983             || PL_DBsingle_iv || PL_DBsignal_iv || PL_DBtrace_iv)
1984     {
1985         dSP;
1986         PERL_CONTEXT *cx;
1987         const I32 gimme = G_ARRAY;
1988         GV * const gv = PL_DBgv;
1989         CV * cv = NULL;
1990
1991         if (gv && isGV_with_GP(gv))
1992             cv = GvCV(gv);
1993
1994         if (!cv || (!CvROOT(cv) && !CvXSUB(cv)))
1995             DIE(aTHX_ "No DB::DB routine defined");
1996
1997         if (CvDEPTH(cv) >= 1 && !(PL_debug & DEBUG_DB_RECURSE_FLAG))
1998             /* don't do recursive DB::DB call */
1999             return NORMAL;
2000
2001         if (CvISXSUB(cv)) {
2002             ENTER;
2003             SAVEI32(PL_debug);
2004             PL_debug = 0;
2005             SAVESTACK_POS();
2006             SAVETMPS;
2007             PUSHMARK(SP);
2008             (void)(*CvXSUB(cv))(aTHX_ cv);
2009             FREETMPS;
2010             LEAVE;
2011             return NORMAL;
2012         }
2013         else {
2014             U8 hasargs = 0;
2015             PUSHBLOCK(cx, CXt_SUB, SP);
2016             PUSHSUB_DB(cx);
2017             cx->blk_sub.retop = PL_op->op_next;
2018             cx->blk_oldsaveix = PL_savestack_ix;
2019
2020             SAVEI32(PL_debug);
2021             PL_debug = 0;
2022             SAVESTACK_POS();
2023             CvDEPTH(cv)++;
2024             if (CvDEPTH(cv) >= 2) {
2025                 PERL_STACK_OVERFLOW_CHECK();
2026                 pad_push(CvPADLIST(cv), CvDEPTH(cv));
2027             }
2028             PAD_SET_CUR_NOSAVE(CvPADLIST(cv), CvDEPTH(cv));
2029             RETURNOP(CvSTART(cv));
2030         }
2031     }
2032     else
2033         return NORMAL;
2034 }
2035
2036
2037 PP(pp_enter)
2038 {
2039     dSP;
2040     PERL_CONTEXT *cx;
2041     I32 gimme = GIMME_V;
2042
2043     PUSHBLOCK(cx, CXt_BLOCK, SP);
2044     PUSHBASICBLK(cx);
2045
2046     RETURN;
2047 }
2048
2049 PP(pp_leave)
2050 {
2051     PERL_CONTEXT *cx;
2052     SV **oldsp;
2053     I32 gimme;
2054
2055     cx = CX_CUR();
2056     assert(CxTYPE(cx) == CXt_BLOCK);
2057
2058     if (PL_op->op_flags & OPf_SPECIAL)
2059         cx->blk_oldpm = PL_curpm; /* fake block should preserve $1 et al */
2060
2061     oldsp = PL_stack_base + cx->blk_oldsp;
2062     gimme = cx->blk_gimme;
2063
2064     if (gimme == G_VOID)
2065         PL_stack_sp = oldsp;
2066     else
2067         leave_adjust_stacks(oldsp, oldsp, gimme,
2068                                 PL_op->op_private & OPpLVALUE ? 3 : 1);
2069
2070     CX_LEAVE_SCOPE(cx);
2071     POPBASICBLK(cx);
2072     POPBLOCK(cx);
2073     CX_POP(cx);
2074
2075     return NORMAL;
2076 }
2077
2078 static bool
2079 S_outside_integer(pTHX_ SV *sv)
2080 {
2081   if (SvOK(sv)) {
2082     const NV nv = SvNV_nomg(sv);
2083     if (Perl_isinfnan(nv))
2084       return TRUE;
2085 #ifdef NV_PRESERVES_UV
2086     if (nv < (NV)IV_MIN || nv > (NV)IV_MAX)
2087       return TRUE;
2088 #else
2089     if (nv <= (NV)IV_MIN)
2090       return TRUE;
2091     if ((nv > 0) &&
2092         ((nv > (NV)UV_MAX ||
2093           SvUV_nomg(sv) > (UV)IV_MAX)))
2094       return TRUE;
2095 #endif
2096   }
2097   return FALSE;
2098 }
2099
2100 PP(pp_enteriter)
2101 {
2102     dSP; dMARK;
2103     PERL_CONTEXT *cx;
2104     const I32 gimme = GIMME_V;
2105     void *itervarp; /* GV or pad slot of the iteration variable */
2106     SV   *itersave; /* the old var in the iterator var slot */
2107     U8 cxflags = 0;
2108
2109     if (PL_op->op_targ) {                        /* "my" variable */
2110         itervarp = &PAD_SVl(PL_op->op_targ);
2111         itersave = *(SV**)itervarp;
2112         assert(itersave);
2113         if (PL_op->op_private & OPpLVAL_INTRO) {        /* for my $x (...) */
2114             /* the SV currently in the pad slot is never live during
2115              * iteration (the slot is always aliased to one of the items)
2116              * so it's always stale */
2117             SvPADSTALE_on(itersave);
2118         }
2119         SvREFCNT_inc_simple_void_NN(itersave);
2120         cxflags = CXp_FOR_PAD;
2121     }
2122     else {
2123         SV * const sv = POPs;
2124         itervarp = (void *)sv;
2125         if (LIKELY(isGV(sv))) {         /* symbol table variable */
2126             SV** svp = &GvSV(sv);
2127             itersave = *svp;
2128             if (LIKELY(itersave))
2129                 SvREFCNT_inc_simple_void_NN(itersave);
2130             else
2131                 *svp = newSV(0);
2132             cxflags = CXp_FOR_GV;
2133         }
2134         else {                          /* LV ref: for \$foo (...) */
2135             assert(SvTYPE(sv) == SVt_PVMG);
2136             assert(SvMAGIC(sv));
2137             assert(SvMAGIC(sv)->mg_type == PERL_MAGIC_lvref);
2138             itersave = NULL;
2139             cxflags = CXp_FOR_LVREF;
2140         }
2141     }
2142
2143     if (PL_op->op_private & OPpITER_DEF)
2144         cxflags |= CXp_FOR_DEF;
2145
2146     PUSHBLOCK(cx, cxflags, MARK);
2147     PUSHLOOP_FOR(cx, itervarp, itersave);
2148     if (PL_op->op_flags & OPf_STACKED) {
2149         SV *maybe_ary = POPs;
2150         if (SvTYPE(maybe_ary) != SVt_PVAV) {
2151             dPOPss;
2152             SV * const right = maybe_ary;
2153             if (UNLIKELY(cxflags & CXp_FOR_LVREF))
2154                 DIE(aTHX_ "Assigned value is not a reference");
2155             SvGETMAGIC(sv);
2156             SvGETMAGIC(right);
2157             if (RANGE_IS_NUMERIC(sv,right)) {
2158                 cx->cx_type |= CXt_LOOP_LAZYIV;
2159                 if (S_outside_integer(aTHX_ sv) ||
2160                     S_outside_integer(aTHX_ right))
2161                     DIE(aTHX_ "Range iterator outside integer range");
2162                 cx->blk_loop.state_u.lazyiv.cur = SvIV_nomg(sv);
2163                 cx->blk_loop.state_u.lazyiv.end = SvIV_nomg(right);
2164             }
2165             else {
2166                 cx->cx_type |= CXt_LOOP_LAZYSV;
2167                 cx->blk_loop.state_u.lazysv.cur = newSVsv(sv);
2168                 cx->blk_loop.state_u.lazysv.end = right;
2169                 SvREFCNT_inc(right);
2170                 (void) SvPV_force_nolen(cx->blk_loop.state_u.lazysv.cur);
2171                 /* This will do the upgrade to SVt_PV, and warn if the value
2172                    is uninitialised.  */
2173                 (void) SvPV_nolen_const(right);
2174                 /* Doing this avoids a check every time in pp_iter in pp_hot.c
2175                    to replace !SvOK() with a pointer to "".  */
2176                 if (!SvOK(right)) {
2177                     SvREFCNT_dec(right);
2178                     cx->blk_loop.state_u.lazysv.end = &PL_sv_no;
2179                 }
2180             }
2181         }
2182         else /* SvTYPE(maybe_ary) == SVt_PVAV */ {
2183             cx->cx_type |= CXt_LOOP_ARY;
2184             cx->blk_loop.state_u.ary.ary = MUTABLE_AV(maybe_ary);
2185             SvREFCNT_inc(maybe_ary);
2186             cx->blk_loop.state_u.ary.ix =
2187                 (PL_op->op_private & OPpITER_REVERSED) ?
2188                 AvFILL(cx->blk_loop.state_u.ary.ary) + 1 :
2189                 -1;
2190         }
2191         /* EXTEND(SP, 1) not needed in this branch because we just did POPs */
2192     }
2193     else { /* iterating over items on the stack */
2194         cx->cx_type |= CXt_LOOP_LIST;
2195         cx->blk_oldsp = SP - PL_stack_base;
2196         cx->blk_loop.state_u.stack.basesp = MARK - PL_stack_base;
2197         cx->blk_loop.state_u.stack.ix =
2198             (PL_op->op_private & OPpITER_REVERSED)
2199                 ? cx->blk_oldsp + 1
2200                 : cx->blk_loop.state_u.stack.basesp;
2201         /* pre-extend stack so pp_iter doesn't have to check every time
2202          * it pushes yes/no */
2203         EXTEND(SP, 1);
2204     }
2205
2206     RETURN;
2207 }
2208
2209 PP(pp_enterloop)
2210 {
2211     dSP;
2212     PERL_CONTEXT *cx;
2213     const I32 gimme = GIMME_V;
2214
2215     PUSHBLOCK(cx, CXt_LOOP_PLAIN, SP);
2216     PUSHLOOP_PLAIN(cx);
2217
2218     RETURN;
2219 }
2220
2221 PP(pp_leaveloop)
2222 {
2223     PERL_CONTEXT *cx;
2224     I32 gimme;
2225     SV **oldsp;
2226     SV **mark;
2227
2228     cx = CX_CUR();
2229     assert(CxTYPE_is_LOOP(cx));
2230     mark = PL_stack_base + cx->blk_oldsp;
2231     oldsp = CxTYPE(cx) == CXt_LOOP_LIST
2232                 ? PL_stack_base + cx->blk_loop.state_u.stack.basesp
2233                 : mark;
2234     gimme = cx->blk_gimme;
2235
2236     if (gimme == G_VOID)
2237         PL_stack_sp = oldsp;
2238     else
2239         leave_adjust_stacks(MARK, oldsp, gimme,
2240                                 PL_op->op_private & OPpLVALUE ? 3 : 1);
2241
2242     CX_LEAVE_SCOPE(cx);
2243     POPLOOP(cx);        /* Stack values are safe: release loop vars ... */
2244     POPBLOCK(cx);
2245     CX_POP(cx);
2246
2247     return NORMAL;
2248 }
2249
2250
2251 /* This duplicates most of pp_leavesub, but with additional code to handle
2252  * return args in lvalue context. It was forked from pp_leavesub to
2253  * avoid slowing down that function any further.
2254  *
2255  * Any changes made to this function may need to be copied to pp_leavesub
2256  * and vice-versa.
2257  */
2258
2259 PP(pp_leavesublv)
2260 {
2261     I32 gimme;
2262     PERL_CONTEXT *cx;
2263     SV **oldsp;
2264     OP *retop;
2265
2266     cx = CX_CUR();
2267     assert(CxTYPE(cx) == CXt_SUB);
2268
2269     if (CxMULTICALL(cx)) {
2270         /* entry zero of a stack is always PL_sv_undef, which
2271          * simplifies converting a '()' return into undef in scalar context */
2272         assert(PL_stack_sp > PL_stack_base || *PL_stack_base == &PL_sv_undef);
2273         return 0;
2274     }
2275
2276     gimme = cx->blk_gimme;
2277     oldsp = PL_stack_base + cx->blk_oldsp; /* last arg of previous frame */
2278
2279     if (gimme == G_VOID)
2280         PL_stack_sp = oldsp;
2281     else {
2282         U8   lval    = CxLVAL(cx);
2283         bool is_lval = (lval && !(lval & OPpENTERSUB_INARGS));
2284         const char *what = NULL;
2285
2286         if (gimme == G_SCALAR) {
2287             if (is_lval) {
2288                 /* check for bad return arg */
2289                 if (oldsp < PL_stack_sp) {
2290                     SV *sv = *PL_stack_sp;
2291                     if ((SvPADTMP(sv) || SvREADONLY(sv))) {
2292                         what =
2293                             SvREADONLY(sv) ? (sv == &PL_sv_undef) ? "undef"
2294                             : "a readonly value" : "a temporary";
2295                     }
2296                     else goto ok;
2297                 }
2298                 else {
2299                     /* sub:lvalue{} will take us here. */
2300                     what = "undef";
2301                 }
2302               croak:
2303                 Perl_croak(aTHX_
2304                           "Can't return %s from lvalue subroutine", what);
2305             }
2306
2307           ok:
2308             leave_adjust_stacks(oldsp, oldsp, gimme, is_lval ? 3 : 2);
2309
2310             if (lval & OPpDEREF) {
2311                 /* lval_sub()->{...} and similar */
2312                 dSP;
2313                 SvGETMAGIC(TOPs);
2314                 if (!SvOK(TOPs)) {
2315                     TOPs = vivify_ref(TOPs, CxLVAL(cx) & OPpDEREF);
2316                 }
2317                 PUTBACK;
2318             }
2319         }
2320         else {
2321             assert(gimme == G_ARRAY);
2322             assert (!(lval & OPpDEREF));
2323
2324             if (is_lval) {
2325                 /* scan for bad return args */
2326                 SV **p;
2327                 for (p = PL_stack_sp; p > oldsp; p--) {
2328                     SV *sv = *p;
2329                     /* the PL_sv_undef exception is to allow things like
2330                      * this to work, where PL_sv_undef acts as 'skip'
2331                      * placeholder on the LHS of list assigns:
2332                      *    sub foo :lvalue { undef }
2333                      *    ($a, undef, foo(), $b) = 1..4;
2334                      */
2335                     if (sv != &PL_sv_undef && (SvPADTMP(sv) || SvREADONLY(sv)))
2336                     {
2337                         /* Might be flattened array after $#array =  */
2338                         what = SvREADONLY(sv)
2339                                 ? "a readonly value" : "a temporary";
2340                         goto croak;
2341                     }
2342                 }
2343             }
2344
2345             leave_adjust_stacks(oldsp, oldsp, gimme, is_lval ? 3 : 2);
2346         }
2347     }
2348
2349     CX_LEAVE_SCOPE(cx);
2350     POPSUB(cx); /* Stack values are safe: release CV and @_ ... */
2351     POPBLOCK(cx);
2352     retop =  cx->blk_sub.retop;
2353     CX_POP(cx);
2354
2355     return retop;
2356 }
2357
2358
2359 PP(pp_return)
2360 {
2361     dSP; dMARK;
2362     PERL_CONTEXT *cx;
2363     const I32 cxix = dopoptosub(cxstack_ix);
2364
2365     assert(cxstack_ix >= 0);
2366     if (cxix < cxstack_ix) {
2367         if (cxix < 0) {
2368             if (!(       PL_curstackinfo->si_type == PERLSI_SORT
2369                   || (   PL_curstackinfo->si_type == PERLSI_MULTICALL
2370                       && (cxstack[0].cx_type & CXp_SUB_RE_FAKE))
2371                  )
2372             )
2373                 DIE(aTHX_ "Can't return outside a subroutine");
2374             /* We must be in:
2375              *  a sort block, which is a CXt_NULL not a CXt_SUB;
2376              *  or a /(?{...})/ block.
2377              * Handle specially. */
2378             assert(CxTYPE(&cxstack[0]) == CXt_NULL
2379                     || (   CxTYPE(&cxstack[0]) == CXt_SUB
2380                         && (cxstack[0].cx_type & CXp_SUB_RE_FAKE)));
2381             if (cxstack_ix > 0) {
2382                 /* See comment below about context popping. Since we know
2383                  * we're scalar and not lvalue, we can preserve the return
2384                  * value in a simpler fashion than there. */
2385                 SV *sv = *SP;
2386                 assert(cxstack[0].blk_gimme == G_SCALAR);
2387                 if (   (sp != PL_stack_base)
2388                     && !(SvFLAGS(sv) & (SVs_TEMP|SVs_PADTMP))
2389                 )
2390                     *SP = sv_mortalcopy(sv);
2391                 dounwind(0);
2392             }
2393             /* caller responsible for popping cxstack[0] */
2394             return 0;
2395         }
2396
2397         /* There are contexts that need popping. Doing this may free the
2398          * return value(s), so preserve them first, e.g. popping the plain
2399          * loop here would free $x:
2400          *     sub f {  { my $x = 1; return $x } }
2401          * We may also need to shift the args down; for example,
2402          *    for (1,2) { return 3,4 }
2403          * leaves 1,2,3,4 on the stack. Both these actions can be done by
2404          * leave_adjust_stacks().  By calling it with and lvalue "pass
2405          * all" action, we just bump the ref count and mortalise the args
2406          * that need it, do a FREETMPS.  The "scan the args and maybe copy
2407          * them" process will be repeated by whoever we tail-call (e.g.
2408          * pp_leaveeval), where any copying etc will be done. That is to
2409          * say, in this code path two scans of the args will be done; the
2410          * first just shifts and preserves; the second is the "real" arg
2411          * processing, based on the type of return.
2412          */
2413         cx = &cxstack[cxix];
2414         PUTBACK;
2415         if (cx->blk_gimme != G_VOID)
2416             leave_adjust_stacks(MARK, PL_stack_base + cx->blk_oldsp,
2417                                 cx->blk_gimme, 3);
2418         SPAGAIN;
2419         dounwind(cxix);
2420         cx = &cxstack[cxix]; /* CX stack may have been realloced */
2421     }
2422     else {
2423         /* Like in the branch above, we need to handle any extra junk on
2424          * the stack. But because we're not also popping extra contexts, we
2425          * don't have to worry about prematurely freeing args. So we just
2426          * need to do the bare minimum to handle junk, and leave the main
2427          * arg processing in the function we tail call, e.g. pp_leavesub.
2428          * In list context we have to splice out the junk; in scalar
2429          * context we can leave as-is (pp_leavesub will later return the
2430          * top stack element). But for an  empty arg list, e.g.
2431          *    for (1,2) { return }
2432          * we need to set sp = oldsp so that pp_leavesub knows to push
2433          * &PL_sv_undef onto the stack.
2434          */
2435         SV **oldsp;
2436         cx = &cxstack[cxix];
2437         oldsp = PL_stack_base + cx->blk_oldsp;
2438         if (oldsp != MARK) {
2439             SSize_t nargs = SP - MARK;
2440             if (nargs) {
2441                 if (cx->blk_gimme == G_ARRAY) {
2442                     /* shift return args to base of call stack frame */
2443                     Move(MARK + 1, oldsp + 1, nargs, SV*);
2444                     PL_stack_sp  = oldsp + nargs;
2445                 }
2446             }
2447             else
2448                 PL_stack_sp  = oldsp;
2449         }
2450     }
2451
2452     /* fall through to a normal exit */
2453     switch (CxTYPE(cx)) {
2454     case CXt_EVAL:
2455         return CxTRYBLOCK(cx)
2456             ? Perl_pp_leavetry(aTHX)
2457             : Perl_pp_leaveeval(aTHX);
2458     case CXt_SUB:
2459         return CvLVALUE(cx->blk_sub.cv)
2460             ? Perl_pp_leavesublv(aTHX)
2461             : Perl_pp_leavesub(aTHX);
2462     case CXt_FORMAT:
2463         return Perl_pp_leavewrite(aTHX);
2464     default:
2465         DIE(aTHX_ "panic: return, type=%u", (unsigned) CxTYPE(cx));
2466     }
2467 }
2468
2469
2470 static I32
2471 S_unwind_loop(pTHX_ const char * const opname)
2472 {
2473     I32 cxix;
2474     if (PL_op->op_flags & OPf_SPECIAL) {
2475         cxix = dopoptoloop(cxstack_ix);
2476         if (cxix < 0)
2477             /* diag_listed_as: Can't "last" outside a loop block */
2478             Perl_croak(aTHX_ "Can't \"%s\" outside a loop block", opname);
2479     }
2480     else {
2481         dSP;
2482         STRLEN label_len;
2483         const char * const label =
2484             PL_op->op_flags & OPf_STACKED
2485                 ? SvPV(TOPs,label_len)
2486                 : (label_len = strlen(cPVOP->op_pv), cPVOP->op_pv);
2487         const U32 label_flags =
2488             PL_op->op_flags & OPf_STACKED
2489                 ? SvUTF8(POPs)
2490                 : (cPVOP->op_private & OPpPV_IS_UTF8) ? SVf_UTF8 : 0;
2491         PUTBACK;
2492         cxix = dopoptolabel(label, label_len, label_flags);
2493         if (cxix < 0)
2494             /* diag_listed_as: Label not found for "last %s" */
2495             Perl_croak(aTHX_ "Label not found for \"%s %"SVf"\"",
2496                                        opname,
2497                                        SVfARG(PL_op->op_flags & OPf_STACKED
2498                                               && !SvGMAGICAL(TOPp1s)
2499                                               ? TOPp1s
2500                                               : newSVpvn_flags(label,
2501                                                     label_len,
2502                                                     label_flags | SVs_TEMP)));
2503     }
2504     if (cxix < cxstack_ix)
2505         dounwind(cxix);
2506     return cxix;
2507 }
2508
2509 PP(pp_last)
2510 {
2511     PERL_CONTEXT *cx;
2512     OP* nextop;
2513
2514     S_unwind_loop(aTHX_ "last");
2515
2516     cx = CX_CUR();
2517
2518     assert(CxTYPE_is_LOOP(cx));
2519     PL_stack_sp = PL_stack_base
2520                 + (CxTYPE(cx) == CXt_LOOP_LIST
2521                     ?  cx->blk_loop.state_u.stack.basesp
2522                     : cx->blk_oldsp
2523                 );
2524
2525     TAINT_NOT;
2526
2527     /* Stack values are safe: */
2528     CX_LEAVE_SCOPE(cx);
2529     POPLOOP(cx);        /* release loop vars ... */
2530     POPBLOCK(cx);
2531     nextop = cx->blk_loop.my_op->op_lastop->op_next;
2532     CX_POP(cx);
2533
2534     return nextop;
2535 }
2536
2537 PP(pp_next)
2538 {
2539     PERL_CONTEXT *cx;
2540
2541     S_unwind_loop(aTHX_ "next");
2542
2543     cx = CX_CUR();
2544     TOPBLOCK(cx);
2545     PL_curcop = cx->blk_oldcop;
2546     PERL_ASYNC_CHECK();
2547     return (cx)->blk_loop.my_op->op_nextop;
2548 }
2549
2550 PP(pp_redo)
2551 {
2552     const I32 cxix = S_unwind_loop(aTHX_ "redo");
2553     PERL_CONTEXT *cx;
2554     OP* redo_op = cxstack[cxix].blk_loop.my_op->op_redoop;
2555
2556     if (redo_op->op_type == OP_ENTER) {
2557         /* pop one less context to avoid $x being freed in while (my $x..) */
2558         cxstack_ix++;
2559         assert(CxTYPE(CX_CUR()) == CXt_BLOCK);
2560         redo_op = redo_op->op_next;
2561     }
2562
2563     cx = CX_CUR();
2564     TOPBLOCK(cx);
2565     CX_LEAVE_SCOPE(cx);
2566     FREETMPS;
2567     PL_curcop = cx->blk_oldcop;
2568     PERL_ASYNC_CHECK();
2569     return redo_op;
2570 }
2571
2572 STATIC OP *
2573 S_dofindlabel(pTHX_ OP *o, const char *label, STRLEN len, U32 flags, OP **opstack, OP **oplimit)
2574 {
2575     OP **ops = opstack;
2576     static const char* const too_deep = "Target of goto is too deeply nested";
2577
2578     PERL_ARGS_ASSERT_DOFINDLABEL;
2579
2580     if (ops >= oplimit)
2581         Perl_croak(aTHX_ "%s", too_deep);
2582     if (o->op_type == OP_LEAVE ||
2583         o->op_type == OP_SCOPE ||
2584         o->op_type == OP_LEAVELOOP ||
2585         o->op_type == OP_LEAVESUB ||
2586         o->op_type == OP_LEAVETRY)
2587     {
2588         *ops++ = cUNOPo->op_first;
2589         if (ops >= oplimit)
2590             Perl_croak(aTHX_ "%s", too_deep);
2591     }
2592     *ops = 0;
2593     if (o->op_flags & OPf_KIDS) {
2594         OP *kid;
2595         /* First try all the kids at this level, since that's likeliest. */
2596         for (kid = cUNOPo->op_first; kid; kid = OpSIBLING(kid)) {
2597             if (kid->op_type == OP_NEXTSTATE || kid->op_type == OP_DBSTATE) {
2598                 STRLEN kid_label_len;
2599                 U32 kid_label_flags;
2600                 const char *kid_label = CopLABEL_len_flags(kCOP,
2601                                                     &kid_label_len, &kid_label_flags);
2602                 if (kid_label && (
2603                     ( (kid_label_flags & SVf_UTF8) != (flags & SVf_UTF8) ) ?
2604                         (flags & SVf_UTF8)
2605                             ? (bytes_cmp_utf8(
2606                                         (const U8*)kid_label, kid_label_len,
2607                                         (const U8*)label, len) == 0)
2608                             : (bytes_cmp_utf8(
2609                                         (const U8*)label, len,
2610                                         (const U8*)kid_label, kid_label_len) == 0)
2611                     : ( len == kid_label_len && ((kid_label == label)
2612                                     || memEQ(kid_label, label, len)))))
2613                     return kid;
2614             }
2615         }
2616         for (kid = cUNOPo->op_first; kid; kid = OpSIBLING(kid)) {
2617             if (kid == PL_lastgotoprobe)
2618                 continue;
2619             if (kid->op_type == OP_NEXTSTATE || kid->op_type == OP_DBSTATE) {
2620                 if (ops == opstack)
2621                     *ops++ = kid;
2622                 else if (ops[-1]->op_type == OP_NEXTSTATE ||
2623                          ops[-1]->op_type == OP_DBSTATE)
2624                     ops[-1] = kid;
2625                 else
2626                     *ops++ = kid;
2627             }
2628             if ((o = dofindlabel(kid, label, len, flags, ops, oplimit)))
2629                 return o;
2630         }
2631     }
2632     *ops = 0;
2633     return 0;
2634 }
2635
2636
2637 /* also used for: pp_dump() */
2638
2639 PP(pp_goto)
2640 {
2641     dVAR; dSP;
2642     OP *retop = NULL;
2643     I32 ix;
2644     PERL_CONTEXT *cx;
2645 #define GOTO_DEPTH 64
2646     OP *enterops[GOTO_DEPTH];
2647     const char *label = NULL;
2648     STRLEN label_len = 0;
2649     U32 label_flags = 0;
2650     const bool do_dump = (PL_op->op_type == OP_DUMP);
2651     static const char* const must_have_label = "goto must have label";
2652
2653     if (PL_op->op_flags & OPf_STACKED) {
2654         /* goto EXPR  or  goto &foo */
2655
2656         SV * const sv = POPs;
2657         SvGETMAGIC(sv);
2658
2659         if (SvROK(sv) && SvTYPE(SvRV(sv)) == SVt_PVCV) {
2660             /* This egregious kludge implements goto &subroutine */
2661             I32 cxix;
2662             PERL_CONTEXT *cx;
2663             CV *cv = MUTABLE_CV(SvRV(sv));
2664             AV *arg = GvAV(PL_defgv);
2665
2666             while (!CvROOT(cv) && !CvXSUB(cv)) {
2667                 const GV * const gv = CvGV(cv);
2668                 if (gv) {
2669                     GV *autogv;
2670                     SV *tmpstr;
2671                     /* autoloaded stub? */
2672                     if (cv != GvCV(gv) && (cv = GvCV(gv)))
2673                         continue;
2674                     autogv = gv_autoload_pvn(GvSTASH(gv), GvNAME(gv),
2675                                           GvNAMELEN(gv),
2676                                           GvNAMEUTF8(gv) ? SVf_UTF8 : 0);
2677                     if (autogv && (cv = GvCV(autogv)))
2678                         continue;
2679                     tmpstr = sv_newmortal();
2680                     gv_efullname3(tmpstr, gv, NULL);
2681                     DIE(aTHX_ "Goto undefined subroutine &%"SVf"", SVfARG(tmpstr));
2682                 }
2683                 DIE(aTHX_ "Goto undefined subroutine");
2684             }
2685
2686             cxix = dopoptosub(cxstack_ix);
2687             if (cxix < 0) {
2688                 DIE(aTHX_ "Can't goto subroutine outside a subroutine");
2689             }
2690             cx  = &cxstack[cxix];
2691             /* ban goto in eval: see <20050521150056.GC20213@iabyn.com> */
2692             if (CxTYPE(cx) == CXt_EVAL) {
2693                 if (CxREALEVAL(cx))
2694                 /* diag_listed_as: Can't goto subroutine from an eval-%s */
2695                     DIE(aTHX_ "Can't goto subroutine from an eval-string");
2696                 else
2697                 /* diag_listed_as: Can't goto subroutine from an eval-%s */
2698                     DIE(aTHX_ "Can't goto subroutine from an eval-block");
2699             }
2700             else if (CxMULTICALL(cx))
2701                 DIE(aTHX_ "Can't goto subroutine from a sort sub (or similar callback)");
2702
2703             /* First do some returnish stuff. */
2704
2705             SvREFCNT_inc_simple_void(cv); /* avoid premature free during unwind */
2706             FREETMPS;
2707             if (cxix < cxstack_ix) {
2708                 dounwind(cxix);
2709             }
2710             cx = CX_CUR();
2711             TOPBLOCK(cx);
2712             SPAGAIN;
2713
2714             /* protect @_ during save stack unwind. */
2715             if (arg)
2716                 SvREFCNT_inc_NN(sv_2mortal(MUTABLE_SV(arg)));
2717
2718             assert(PL_scopestack_ix == cx->blk_oldscopesp);
2719             CX_LEAVE_SCOPE(cx);
2720
2721             if (CxTYPE(cx) == CXt_SUB && CxHASARGS(cx)) {
2722                 /* this is POPSUB_ARGS() with minor variations */
2723                 AV* av = MUTABLE_AV(PAD_SVl(0));
2724                 assert(AvARRAY(MUTABLE_AV(
2725                     PadlistARRAY(CvPADLIST(cx->blk_sub.cv))[
2726                             CvDEPTH(cx->blk_sub.cv)])) == PL_curpad);
2727
2728                 /* we are going to donate the current @_ from the old sub
2729                  * to the new sub. This first part of the donation puts a
2730                  * new empty AV in the pad[0] slot of the old sub,
2731                  * unless pad[0] and @_ differ (e.g. if the old sub did
2732                  * local *_ = []); in which case clear the old pad[0]
2733                  * array in the usual way */
2734                 if (av == arg || AvREAL(av))
2735                     clear_defarray(av, av == arg);
2736                 else CLEAR_ARGARRAY(av);
2737             }
2738
2739             /* don't restore PL_comppad here. It won't be needed if the
2740              * sub we're going to is non-XS, but restoring it early then
2741              * croaking (e.g. the "Goto undefined subroutine" below)
2742              * means the CX block gets processed again in dounwind,
2743              * but this time with the wrong PL_comppad */
2744
2745             /* A destructor called during LEAVE_SCOPE could have undefined
2746              * our precious cv.  See bug #99850. */
2747             if (!CvROOT(cv) && !CvXSUB(cv)) {
2748                 const GV * const gv = CvGV(cv);
2749                 if (gv) {
2750                     SV * const tmpstr = sv_newmortal();
2751                     gv_efullname3(tmpstr, gv, NULL);
2752                     DIE(aTHX_ "Goto undefined subroutine &%"SVf"",
2753                                SVfARG(tmpstr));
2754                 }
2755                 DIE(aTHX_ "Goto undefined subroutine");
2756             }
2757
2758             if (CxTYPE(cx) == CXt_SUB) {
2759                 CvDEPTH(cx->blk_sub.cv) = cx->blk_sub.olddepth;
2760                 SvREFCNT_dec_NN(cx->blk_sub.cv);
2761             }
2762
2763             /* Now do some callish stuff. */
2764             if (CvISXSUB(cv)) {
2765                 const SSize_t items = arg ? AvFILL(arg) + 1 : 0;
2766                 const bool m = arg ? cBOOL(SvRMAGICAL(arg)) : 0;
2767                 SV** mark;
2768
2769                 ENTER;
2770                 SAVETMPS;
2771                 SAVEFREESV(cv); /* later, undo the 'avoid premature free' hack */
2772
2773                 /* put GvAV(defgv) back onto stack */
2774                 if (items) {
2775                     EXTEND(SP, items+1); /* @_ could have been extended. */
2776                 }
2777                 mark = SP;
2778                 if (items) {
2779                     SSize_t index;
2780                     bool r = cBOOL(AvREAL(arg));
2781                     for (index=0; index<items; index++)
2782                     {
2783                         SV *sv;
2784                         if (m) {
2785                             SV ** const svp = av_fetch(arg, index, 0);
2786                             sv = svp ? *svp : NULL;
2787                         }
2788                         else sv = AvARRAY(arg)[index];
2789                         SP[index+1] = sv
2790                             ? r ? SvREFCNT_inc_NN(sv_2mortal(sv)) : sv
2791                             : sv_2mortal(newSVavdefelem(arg, index, 1));
2792                     }
2793                 }
2794                 SP += items;
2795                 if (CxTYPE(cx) == CXt_SUB && CxHASARGS(cx)) {
2796                     /* Restore old @_ */
2797                     POP_SAVEARRAY();
2798                 }
2799
2800                 retop = cx->blk_sub.retop;
2801                 PL_comppad = cx->blk_sub.prevcomppad;
2802                 PL_curpad = LIKELY(PL_comppad) ? AvARRAY(PL_comppad) : NULL;
2803
2804                 /* XS subs don't have a CXt_SUB, so pop it;
2805                  * this is a POPBLOCK(), less all the stuff we already did
2806                  * for TOPBLOCK() earlier */
2807                 PL_curcop = cx->blk_oldcop;
2808                 CX_POP(cx);
2809
2810                 /* Push a mark for the start of arglist */
2811                 PUSHMARK(mark);
2812                 PUTBACK;
2813                 (void)(*CvXSUB(cv))(aTHX_ cv);
2814                 LEAVE;
2815                 goto _return;
2816             }
2817             else {
2818                 PADLIST * const padlist = CvPADLIST(cv);
2819
2820                 SAVEFREESV(cv); /* later, undo the 'avoid premature free' hack */
2821
2822                 /* partial unrolled PUSHSUB(): */
2823
2824                 cx->blk_sub.cv = cv;
2825                 cx->blk_sub.olddepth = CvDEPTH(cv);
2826
2827                 CvDEPTH(cv)++;
2828                 SvREFCNT_inc_simple_void_NN(cv);
2829                 if (CvDEPTH(cv) > 1) {
2830                     if (CvDEPTH(cv) == PERL_SUB_DEPTH_WARN && ckWARN(WARN_RECURSION))
2831                         sub_crush_depth(cv);
2832                     pad_push(padlist, CvDEPTH(cv));
2833                 }
2834                 PL_curcop = cx->blk_oldcop;
2835                 PAD_SET_CUR_NOSAVE(padlist, CvDEPTH(cv));
2836                 if (CxHASARGS(cx))
2837                 {
2838                     /* second half of donating @_ from the old sub to the
2839                      * new sub: abandon the original pad[0] AV in the
2840                      * new sub, and replace it with the donated @_.
2841                      * pad[0] takes ownership of the extra refcount
2842                      * we gave arg earlier */
2843                     if (arg) {
2844                         SvREFCNT_dec(PAD_SVl(0));
2845                         PAD_SVl(0) = (SV *)arg;
2846                         SvREFCNT_inc_simple_void_NN(arg);
2847                     }
2848
2849                     /* GvAV(PL_defgv) might have been modified on scope
2850                        exit, so point it at arg again. */
2851                     if (arg != GvAV(PL_defgv)) {
2852                         AV * const av = GvAV(PL_defgv);
2853                         GvAV(PL_defgv) = (AV *)SvREFCNT_inc_simple(arg);
2854                         SvREFCNT_dec(av);
2855                     }
2856                 }
2857
2858                 if (PERLDB_SUB) {       /* Checking curstash breaks DProf. */
2859                     Perl_get_db_sub(aTHX_ NULL, cv);
2860                     if (PERLDB_GOTO) {
2861                         CV * const gotocv = get_cvs("DB::goto", 0);
2862                         if (gotocv) {
2863                             PUSHMARK( PL_stack_sp );
2864                             call_sv(MUTABLE_SV(gotocv), G_SCALAR | G_NODEBUG);
2865                             PL_stack_sp--;
2866                         }
2867                     }
2868                 }
2869                 retop = CvSTART(cv);
2870                 goto putback_return;
2871             }
2872         }
2873         else {
2874             /* goto EXPR */
2875             label       = SvPV_nomg_const(sv, label_len);
2876             label_flags = SvUTF8(sv);
2877         }
2878     }
2879     else if (!(PL_op->op_flags & OPf_SPECIAL)) {
2880         /* goto LABEL  or  dump LABEL */
2881         label       = cPVOP->op_pv;
2882         label_flags = (cPVOP->op_private & OPpPV_IS_UTF8) ? SVf_UTF8 : 0;
2883         label_len   = strlen(label);
2884     }
2885     if (!(do_dump || label_len)) DIE(aTHX_ "%s", must_have_label);
2886
2887     PERL_ASYNC_CHECK();
2888
2889     if (label_len) {
2890         OP *gotoprobe = NULL;
2891         bool leaving_eval = FALSE;
2892         bool in_block = FALSE;
2893         PERL_CONTEXT *last_eval_cx = NULL;
2894
2895         /* find label */
2896
2897         PL_lastgotoprobe = NULL;
2898         *enterops = 0;
2899         for (ix = cxstack_ix; ix >= 0; ix--) {
2900             cx = &cxstack[ix];
2901             switch (CxTYPE(cx)) {
2902             case CXt_EVAL:
2903                 leaving_eval = TRUE;
2904                 if (!CxTRYBLOCK(cx)) {
2905                     gotoprobe = (last_eval_cx ?
2906                                 last_eval_cx->blk_eval.old_eval_root :
2907                                 PL_eval_root);
2908                     last_eval_cx = cx;
2909                     break;
2910                 }
2911                 /* else fall through */
2912             case CXt_LOOP_PLAIN:
2913             case CXt_LOOP_LAZYIV:
2914             case CXt_LOOP_LAZYSV:
2915             case CXt_LOOP_LIST:
2916             case CXt_LOOP_ARY:
2917             case CXt_GIVEN:
2918             case CXt_WHEN:
2919                 gotoprobe = OpSIBLING(cx->blk_oldcop);
2920                 break;
2921             case CXt_SUBST:
2922                 continue;
2923             case CXt_BLOCK:
2924                 if (ix) {
2925                     gotoprobe = OpSIBLING(cx->blk_oldcop);
2926                     in_block = TRUE;
2927                 } else
2928                     gotoprobe = PL_main_root;
2929                 break;
2930             case CXt_SUB:
2931                 if (CvDEPTH(cx->blk_sub.cv) && !CxMULTICALL(cx)) {
2932                     gotoprobe = CvROOT(cx->blk_sub.cv);
2933                     break;
2934                 }
2935                 /* FALLTHROUGH */
2936             case CXt_FORMAT:
2937             case CXt_NULL:
2938                 DIE(aTHX_ "Can't \"goto\" out of a pseudo block");
2939             default:
2940                 if (ix)
2941                     DIE(aTHX_ "panic: goto, type=%u, ix=%ld",
2942                         CxTYPE(cx), (long) ix);
2943                 gotoprobe = PL_main_root;
2944                 break;
2945             }
2946             if (gotoprobe) {
2947                 OP *sibl1, *sibl2;
2948
2949                 retop = dofindlabel(gotoprobe, label, label_len, label_flags,
2950                                     enterops, enterops + GOTO_DEPTH);
2951                 if (retop)
2952                     break;
2953                 if ( (sibl1 = OpSIBLING(gotoprobe)) &&
2954                      sibl1->op_type == OP_UNSTACK &&
2955                      (sibl2 = OpSIBLING(sibl1)))
2956                 {
2957                     retop = dofindlabel(sibl2,
2958                                         label, label_len, label_flags, enterops,
2959                                         enterops + GOTO_DEPTH);
2960                     if (retop)
2961                         break;
2962                 }
2963             }
2964             PL_lastgotoprobe = gotoprobe;
2965         }
2966         if (!retop)
2967             DIE(aTHX_ "Can't find label %"UTF8f, 
2968                        UTF8fARG(label_flags, label_len, label));
2969
2970         /* if we're leaving an eval, check before we pop any frames
2971            that we're not going to punt, otherwise the error
2972            won't be caught */
2973
2974         if (leaving_eval && *enterops && enterops[1]) {
2975             I32 i;
2976             for (i = 1; enterops[i]; i++)
2977                 if (enterops[i]->op_type == OP_ENTERITER)
2978                     DIE(aTHX_ "Can't \"goto\" into the middle of a foreach loop");
2979         }
2980
2981         if (*enterops && enterops[1]) {
2982             I32 i = enterops[1]->op_type == OP_ENTER && in_block ? 2 : 1;
2983             if (enterops[i])
2984                 deprecate("\"goto\" to jump into a construct");
2985         }
2986
2987         /* pop unwanted frames */
2988
2989         if (ix < cxstack_ix) {
2990             if (ix < 0)
2991                 DIE(aTHX_ "panic: docatch: illegal ix=%ld", (long)ix);
2992             dounwind(ix);
2993             cx = CX_CUR();
2994             TOPBLOCK(cx);
2995         }
2996
2997         /* push wanted frames */
2998
2999         if (*enterops && enterops[1]) {
3000             OP * const oldop = PL_op;
3001             ix = enterops[1]->op_type == OP_ENTER && in_block ? 2 : 1;
3002             for (; enterops[ix]; ix++) {
3003                 PL_op = enterops[ix];
3004                 /* Eventually we may want to stack the needed arguments
3005                  * for each op.  For now, we punt on the hard ones. */
3006                 if (PL_op->op_type == OP_ENTERITER)
3007                     DIE(aTHX_ "Can't \"goto\" into the middle of a foreach loop");
3008                 PL_op->op_ppaddr(aTHX);
3009             }
3010             PL_op = oldop;
3011         }
3012     }
3013
3014     if (do_dump) {
3015 #ifdef VMS
3016         if (!retop) retop = PL_main_start;
3017 #endif
3018         PL_restartop = retop;
3019         PL_do_undump = TRUE;
3020
3021         my_unexec();
3022
3023         PL_restartop = 0;               /* hmm, must be GNU unexec().. */
3024         PL_do_undump = FALSE;
3025     }
3026
3027     putback_return:
3028     PL_stack_sp = sp;
3029     _return:
3030     PERL_ASYNC_CHECK();
3031     return retop;
3032 }
3033
3034 PP(pp_exit)
3035 {
3036     dSP;
3037     I32 anum;
3038
3039     if (MAXARG < 1)
3040         anum = 0;
3041     else if (!TOPs) {
3042         anum = 0; (void)POPs;
3043     }
3044     else {
3045         anum = SvIVx(POPs);
3046 #ifdef VMS
3047         if (anum == 1
3048          && SvTRUE(cop_hints_fetch_pvs(PL_curcop, "vmsish_exit", 0)))
3049             anum = 0;
3050         VMSISH_HUSHED  =
3051             VMSISH_HUSHED || (PL_curcop->op_private & OPpHUSH_VMSISH);
3052 #endif
3053     }
3054     PL_exit_flags |= PERL_EXIT_EXPECTED;
3055     my_exit(anum);
3056     PUSHs(&PL_sv_undef);
3057     RETURN;
3058 }
3059
3060 /* Eval. */
3061
3062 STATIC void
3063 S_save_lines(pTHX_ AV *array, SV *sv)
3064 {
3065     const char *s = SvPVX_const(sv);
3066     const char * const send = SvPVX_const(sv) + SvCUR(sv);
3067     I32 line = 1;
3068
3069     PERL_ARGS_ASSERT_SAVE_LINES;
3070
3071     while (s && s < send) {
3072         const char *t;
3073         SV * const tmpstr = newSV_type(SVt_PVMG);
3074
3075         t = (const char *)memchr(s, '\n', send - s);
3076         if (t)
3077             t++;
3078         else
3079             t = send;
3080
3081         sv_setpvn(tmpstr, s, t - s);
3082         av_store(array, line++, tmpstr);
3083         s = t;
3084     }
3085 }
3086
3087 /*
3088 =for apidoc docatch
3089
3090 Check for the cases 0 or 3 of cur_env.je_ret, only used inside an eval context.
3091
3092 0 is used as continue inside eval,
3093
3094 3 is used for a die caught by an inner eval - continue inner loop
3095
3096 See F<cop.h>: je_mustcatch, when set at any runlevel to TRUE, means eval ops must
3097 establish a local jmpenv to handle exception traps.
3098
3099 =cut
3100 */
3101 STATIC OP *
3102 S_docatch(pTHX_ OP *o)
3103 {
3104     int ret;
3105     OP * const oldop = PL_op;
3106     dJMPENV;
3107
3108 #ifdef DEBUGGING
3109     assert(CATCH_GET == TRUE);
3110 #endif
3111     PL_op = o;
3112
3113     JMPENV_PUSH(ret);
3114     switch (ret) {
3115     case 0:
3116         assert(cxstack_ix >= 0);
3117         assert(CxTYPE(CX_CUR()) == CXt_EVAL);
3118         CX_CUR()->blk_eval.cur_top_env = PL_top_env;
3119  redo_body:
3120         CALLRUNOPS(aTHX);
3121         break;
3122     case 3:
3123         /* die caught by an inner eval - continue inner loop */
3124         if (PL_restartop && PL_restartjmpenv == PL_top_env) {
3125             PL_restartjmpenv = NULL;
3126             PL_op = PL_restartop;
3127             PL_restartop = 0;
3128             goto redo_body;
3129         }
3130         /* FALLTHROUGH */
3131     default:
3132         JMPENV_POP;
3133         PL_op = oldop;
3134         JMPENV_JUMP(ret);
3135         NOT_REACHED; /* NOTREACHED */
3136     }
3137     JMPENV_POP;
3138     PL_op = oldop;
3139     return NULL;
3140 }
3141
3142
3143 /*
3144 =for apidoc find_runcv
3145
3146 Locate the CV corresponding to the currently executing sub or eval.
3147 If C<db_seqp> is non_null, skip CVs that are in the DB package and populate
3148 C<*db_seqp> with the cop sequence number at the point that the DB:: code was
3149 entered.  (This allows debuggers to eval in the scope of the breakpoint
3150 rather than in the scope of the debugger itself.)
3151
3152 =cut
3153 */
3154
3155 CV*
3156 Perl_find_runcv(pTHX_ U32 *db_seqp)
3157 {
3158     return Perl_find_runcv_where(aTHX_ 0, 0, db_seqp);
3159 }
3160
3161 /* If this becomes part of the API, it might need a better name. */
3162 CV *
3163 Perl_find_runcv_where(pTHX_ U8 cond, IV arg, U32 *db_seqp)
3164 {
3165     PERL_SI      *si;
3166     int          level = 0;
3167
3168     if (db_seqp)
3169         *db_seqp =
3170             PL_curcop == &PL_compiling
3171                 ? PL_cop_seqmax
3172                 : PL_curcop->cop_seq;
3173
3174     for (si = PL_curstackinfo; si; si = si->si_prev) {
3175         I32 ix;
3176         for (ix = si->si_cxix; ix >= 0; ix--) {
3177             const PERL_CONTEXT *cx = &(si->si_cxstack[ix]);
3178             CV *cv = NULL;
3179             if (CxTYPE(cx) == CXt_SUB || CxTYPE(cx) == CXt_FORMAT) {
3180                 cv = cx->blk_sub.cv;
3181                 /* skip DB:: code */
3182                 if (db_seqp && PL_debstash && CvSTASH(cv) == PL_debstash) {
3183                     *db_seqp = cx->blk_oldcop->cop_seq;
3184                     continue;
3185                 }
3186                 if (cx->cx_type & CXp_SUB_RE)
3187                     continue;
3188             }
3189             else if (CxTYPE(cx) == CXt_EVAL && !CxTRYBLOCK(cx))
3190                 cv = cx->blk_eval.cv;
3191             if (cv) {
3192                 switch (cond) {
3193                 case FIND_RUNCV_padid_eq:
3194                     if (!CvPADLIST(cv)
3195                      || CvPADLIST(cv)->xpadl_id != (U32)arg)
3196                         continue;
3197                     return cv;
3198                 case FIND_RUNCV_level_eq:
3199                     if (level++ != arg) continue;
3200                     /* GERONIMO! */
3201                 default:
3202                     return cv;
3203                 }
3204             }
3205         }
3206     }
3207     return cond == FIND_RUNCV_padid_eq ? NULL : PL_main_cv;
3208 }
3209
3210
3211 /* Run yyparse() in a setjmp wrapper. Returns:
3212  *   0: yyparse() successful
3213  *   1: yyparse() failed
3214  *   3: yyparse() died
3215  */
3216 STATIC int
3217 S_try_yyparse(pTHX_ int gramtype)
3218 {
3219     int ret;
3220     dJMPENV;
3221
3222     assert(CxTYPE(CX_CUR()) == CXt_EVAL);
3223     JMPENV_PUSH(ret);
3224     switch (ret) {
3225     case 0:
3226         ret = yyparse(gramtype) ? 1 : 0;
3227         break;
3228     case 3:
3229         break;
3230     default:
3231         JMPENV_POP;
3232         JMPENV_JUMP(ret);
3233         NOT_REACHED; /* NOTREACHED */
3234     }
3235     JMPENV_POP;
3236     return ret;
3237 }
3238
3239
3240 /* Compile a require/do or an eval ''.
3241  *
3242  * outside is the lexically enclosing CV (if any) that invoked us.
3243  * seq     is the current COP scope value.
3244  * hh      is the saved hints hash, if any.
3245  *
3246  * Returns a bool indicating whether the compile was successful; if so,
3247  * PL_eval_start contains the first op of the compiled code; otherwise,
3248  * pushes undef.
3249  *
3250  * This function is called from two places: pp_require and pp_entereval.
3251  * These can be distinguished by whether PL_op is entereval.
3252  */
3253
3254 STATIC bool
3255 S_doeval_compile(pTHX_ int gimme, CV* outside, U32 seq, HV *hh)
3256 {
3257     dSP;
3258     OP * const saveop = PL_op;
3259     bool clear_hints = saveop->op_type != OP_ENTEREVAL;
3260     COP * const oldcurcop = PL_curcop;
3261     bool in_require = (saveop->op_type == OP_REQUIRE);
3262     int yystatus;
3263     CV *evalcv;
3264
3265     PL_in_eval = (in_require
3266                   ? (EVAL_INREQUIRE | (PL_in_eval & EVAL_INEVAL))
3267                   : (EVAL_INEVAL |
3268                         ((PL_op->op_private & OPpEVAL_RE_REPARSING)
3269                             ? EVAL_RE_REPARSING : 0)));
3270
3271     PUSHMARK(SP);
3272
3273     evalcv = MUTABLE_CV(newSV_type(SVt_PVCV));
3274     CvEVAL_on(evalcv);
3275     assert(CxTYPE(CX_CUR()) == CXt_EVAL);
3276     CX_CUR()->blk_eval.cv = evalcv;
3277     CX_CUR()->blk_gimme = gimme;
3278
3279     CvOUTSIDE_SEQ(evalcv) = seq;
3280     CvOUTSIDE(evalcv) = MUTABLE_CV(SvREFCNT_inc_simple(outside));
3281
3282     /* set up a scratch pad */
3283
3284     CvPADLIST_set(evalcv, pad_new(padnew_SAVE));
3285     PL_op = NULL; /* avoid PL_op and PL_curpad referring to different CVs */
3286
3287
3288     SAVEMORTALIZESV(evalcv);    /* must remain until end of current statement */
3289
3290     /* make sure we compile in the right package */
3291
3292     if (CopSTASH_ne(PL_curcop, PL_curstash)) {
3293         SAVEGENERICSV(PL_curstash);
3294         PL_curstash = (HV *)CopSTASH(PL_curcop);
3295         if (SvTYPE(PL_curstash) != SVt_PVHV) PL_curstash = NULL;
3296         else SvREFCNT_inc_simple_void(PL_curstash);
3297     }
3298     /* XXX:ajgo do we really need to alloc an AV for begin/checkunit */
3299     SAVESPTR(PL_beginav);
3300     PL_beginav = newAV();
3301     SAVEFREESV(PL_beginav);
3302     SAVESPTR(PL_unitcheckav);
3303     PL_unitcheckav = newAV();
3304     SAVEFREESV(PL_unitcheckav);
3305
3306
3307     ENTER_with_name("evalcomp");
3308     SAVESPTR(PL_compcv);
3309     PL_compcv = evalcv;
3310
3311     /* try to compile it */
3312
3313     PL_eval_root = NULL;
3314     PL_curcop = &PL_compiling;
3315     if ((saveop->op_type != OP_REQUIRE) && (saveop->op_flags & OPf_SPECIAL))
3316         PL_in_eval |= EVAL_KEEPERR;
3317     else
3318         CLEAR_ERRSV();
3319
3320     SAVEHINTS();
3321     if (clear_hints) {
3322         PL_hints = 0;
3323         hv_clear(GvHV(PL_hintgv));
3324     }
3325     else {
3326         PL_hints = saveop->op_private & OPpEVAL_COPHH
3327                      ? oldcurcop->cop_hints : saveop->op_targ;
3328
3329         /* making 'use re eval' not be in scope when compiling the
3330          * qr/mabye_has_runtime_code_block/ ensures that we don't get
3331          * infinite recursion when S_has_runtime_code() gives a false
3332          * positive: the second time round, HINT_RE_EVAL isn't set so we
3333          * don't bother calling S_has_runtime_code() */
3334         if (PL_in_eval & EVAL_RE_REPARSING)
3335             PL_hints &= ~HINT_RE_EVAL;
3336
3337         if (hh) {
3338             /* SAVEHINTS created a new HV in PL_hintgv, which we need to GC */
3339             SvREFCNT_dec(GvHV(PL_hintgv));
3340             GvHV(PL_hintgv) = hh;
3341         }
3342     }
3343     SAVECOMPILEWARNINGS();
3344     if (clear_hints) {
3345         if (PL_dowarn & G_WARN_ALL_ON)
3346             PL_compiling.cop_warnings = pWARN_ALL ;
3347         else if (PL_dowarn & G_WARN_ALL_OFF)
3348             PL_compiling.cop_warnings = pWARN_NONE ;
3349         else
3350             PL_compiling.cop_warnings = pWARN_STD ;
3351     }
3352     else {
3353         PL_compiling.cop_warnings =
3354             DUP_WARNINGS(oldcurcop->cop_warnings);
3355         cophh_free(CopHINTHASH_get(&PL_compiling));
3356         if (Perl_cop_fetch_label(aTHX_ oldcurcop, NULL, NULL)) {
3357             /* The label, if present, is the first entry on the chain. So rather
3358                than writing a blank label in front of it (which involves an
3359                allocation), just use the next entry in the chain.  */
3360             PL_compiling.cop_hints_hash
3361                 = cophh_copy(oldcurcop->cop_hints_hash->refcounted_he_next);
3362             /* Check the assumption that this removed the label.  */
3363             assert(Perl_cop_fetch_label(aTHX_ &PL_compiling, NULL, NULL) == NULL);
3364         }
3365         else
3366             PL_compiling.cop_hints_hash = cophh_copy(oldcurcop->cop_hints_hash);
3367     }
3368
3369     CALL_BLOCK_HOOKS(bhk_eval, saveop);
3370
3371     /* note that yyparse() may raise an exception, e.g. C<BEGIN{die}>,
3372      * so honour CATCH_GET and trap it here if necessary */
3373
3374
3375     /* compile the code */
3376     yystatus = (!in_require && CATCH_GET) ? S_try_yyparse(aTHX_ GRAMPROG) : yyparse(GRAMPROG);
3377
3378     if (yystatus || PL_parser->error_count || !PL_eval_root) {
3379         SV *namesv = NULL; /* initialise  to avoid compiler warning */
3380         PERL_CONTEXT *cx;
3381         SV *errsv;
3382
3383         PL_op = saveop;
3384         /* note that if yystatus == 3, then the require/eval died during
3385          * compilation, so the EVAL CX block has already been popped, and
3386          * various vars restored */
3387         if (yystatus != 3) {
3388             if (PL_eval_root) {
3389                 op_free(PL_eval_root);
3390                 PL_eval_root = NULL;
3391             }
3392             SP = PL_stack_base + POPMARK;       /* pop original mark */
3393             cx = CX_CUR();
3394             CX_LEAVE_SCOPE(cx);
3395             POPEVAL(cx);
3396             POPBLOCK(cx);
3397             if (in_require)
3398                 namesv = cx->blk_eval.old_namesv;
3399             CX_POP(cx);
3400         }
3401
3402         errsv = ERRSV;
3403         if (in_require) {
3404             if (yystatus == 3) {
3405                 cx = CX_CUR();
3406                 assert(CxTYPE(cx) == CXt_EVAL);
3407                 namesv = cx->blk_eval.old_namesv;
3408             }
3409             S_undo_inc_then_croak(aTHX_ namesv, errsv, FALSE);
3410             NOT_REACHED; /* NOTREACHED */
3411         }
3412
3413         if (!*(SvPV_nolen_const(errsv)))
3414             sv_setpvs(errsv, "Compilation error");
3415
3416         if (gimme != G_ARRAY) PUSHs(&PL_sv_undef);
3417         PUTBACK;
3418         return FALSE;
3419     }
3420
3421     /* Compilation successful. Now clean up */
3422
3423     LEAVE_with_name("evalcomp");
3424
3425     CopLINE_set(&PL_compiling, 0);
3426     SAVEFREEOP(PL_eval_root);
3427     cv_forget_slab(evalcv);
3428
3429     DEBUG_x(dump_eval());
3430
3431     /* Register with debugger: */
3432     if (PERLDB_INTER && saveop->op_type == OP_REQUIRE) {
3433         CV * const cv = get_cvs("DB::postponed", 0);
3434         if (cv) {
3435             dSP;
3436             PUSHMARK(SP);
3437             XPUSHs(MUTABLE_SV(CopFILEGV(&PL_compiling)));
3438             PUTBACK;
3439             call_sv(MUTABLE_SV(cv), G_DISCARD);
3440         }
3441     }
3442
3443     if (PL_unitcheckav) {
3444         OP *es = PL_eval_start;
3445         call_list(PL_scopestack_ix, PL_unitcheckav);
3446         PL_eval_start = es;
3447     }
3448
3449     CvDEPTH(evalcv) = 1;
3450     SP = PL_stack_base + POPMARK;               /* pop original mark */
3451     PL_op = saveop;                     /* The caller may need it. */
3452     PL_parser->lex_state = LEX_NOTPARSING;      /* $^S needs this. */
3453
3454     PUTBACK;
3455     return TRUE;
3456 }
3457
3458
3459 STATIC PerlIO *
3460 S_check_type_and_open(pTHX_ SV *name)
3461 {
3462     Stat_t st;
3463     STRLEN len;
3464     PerlIO * retio;
3465     const char *p = SvPV_const(name, len);
3466     int st_rc;
3467
3468     PERL_ARGS_ASSERT_CHECK_TYPE_AND_OPEN;
3469
3470     /* checking here captures a reasonable error message when
3471      * PERL_DISABLE_PMC is true, but when PMC checks are enabled, the
3472      * user gets a confusing message about looking for the .pmc file
3473      * rather than for the .pm file so do the check in S_doopen_pm when
3474      * PMC is on instead of here. S_doopen_pm calls this func.
3475      * This check prevents a \0 in @INC causing problems.
3476      */
3477 #ifdef PERL_DISABLE_PMC
3478     if (!IS_SAFE_PATHNAME(p, len, "require"))
3479         return NULL;
3480 #endif
3481
3482     /* on Win32 stat is expensive (it does an open() and close() twice and
3483        a couple other IO calls), the open will fail with a dir on its own with
3484        errno EACCES, so only do a stat to separate a dir from a real EACCES
3485        caused by user perms */
3486 #ifndef WIN32
3487     /* we use the value of errno later to see how stat() or open() failed.
3488      * We don't want it set if the stat succeeded but we still failed,
3489      * such as if the name exists, but is a directory */
3490     errno = 0;
3491
3492     st_rc = PerlLIO_stat(p, &st);
3493
3494     if (st_rc < 0 || S_ISDIR(st.st_mode) || S_ISBLK(st.st_mode)) {
3495         return NULL;
3496     }
3497 #endif
3498
3499     retio = PerlIO_openn(aTHX_ ":", PERL_SCRIPT_MODE, -1, 0, 0, NULL, 1, &name);
3500 #ifdef WIN32
3501     /* EACCES stops the INC search early in pp_require to implement
3502        feature RT #113422 */
3503     if(!retio && errno == EACCES) { /* exists but probably a directory */
3504         int eno;
3505         st_rc = PerlLIO_stat(p, &st);
3506         if (st_rc >= 0) {
3507             if(S_ISDIR(st.st_mode) || S_ISBLK(st.st_mode))
3508                 eno = 0;
3509             else
3510                 eno = EACCES;
3511             errno = eno;
3512         }
3513     }
3514 #endif
3515     return retio;
3516 }
3517
3518 #ifndef PERL_DISABLE_PMC
3519 STATIC PerlIO *
3520 S_doopen_pm(pTHX_ SV *name)
3521 {
3522     STRLEN namelen;
3523     const char *p = SvPV_const(name, namelen);
3524
3525     PERL_ARGS_ASSERT_DOOPEN_PM;
3526
3527     /* check the name before trying for the .pmc name to avoid the
3528      * warning referring to the .pmc which the user probably doesn't
3529      * know or care about
3530      */
3531     if (!IS_SAFE_PATHNAME(p, namelen, "require"))
3532         return NULL;
3533
3534     if (namelen > 3 && memEQs(p + namelen - 3, 3, ".pm")) {
3535         SV *const pmcsv = sv_newmortal();
3536         PerlIO * pmcio;
3537
3538         SvSetSV_nosteal(pmcsv,name);
3539         sv_catpvs(pmcsv, "c");
3540
3541         pmcio = check_type_and_open(pmcsv);
3542         if (pmcio)
3543             return pmcio;
3544     }
3545     return check_type_and_open(name);
3546 }
3547 #else
3548 #  define doopen_pm(name) check_type_and_open(name)
3549 #endif /* !PERL_DISABLE_PMC */
3550
3551 /* require doesn't search for absolute names, or when the name is
3552    explicitly relative the current directory */
3553 PERL_STATIC_INLINE bool
3554 S_path_is_searchable(const char *name)
3555 {
3556     PERL_ARGS_ASSERT_PATH_IS_SEARCHABLE;
3557
3558     if (PERL_FILE_IS_ABSOLUTE(name)
3559 #ifdef WIN32
3560         || (*name == '.' && ((name[1] == '/' ||
3561                              (name[1] == '.' && name[2] == '/'))
3562                          || (name[1] == '\\' ||
3563                              ( name[1] == '.' && name[2] == '\\')))
3564             )
3565 #else
3566         || (*name == '.' && (name[1] == '/' ||
3567                              (name[1] == '.' && name[2] == '/')))
3568 #endif
3569          )
3570     {
3571         return FALSE;
3572     }
3573     else
3574         return TRUE;
3575 }
3576
3577
3578 /* also used for: pp_dofile() */
3579
3580 PP(pp_require)
3581 {
3582     dSP;
3583     PERL_CONTEXT *cx;
3584     SV *sv;
3585     const char *name;
3586     STRLEN len;
3587     char * unixname;
3588     STRLEN unixlen;
3589 #ifdef VMS
3590     int vms_unixname = 0;
3591     char *unixdir;
3592 #endif
3593     const char *tryname = NULL;
3594     SV *namesv = NULL;
3595     const I32 gimme = GIMME_V;
3596     int filter_has_file = 0;
3597     PerlIO *tryrsfp = NULL;
3598     SV *filter_cache = NULL;
3599     SV *filter_state = NULL;
3600     SV *filter_sub = NULL;
3601     SV *hook_sv = NULL;
3602     OP *op;
3603     int saved_errno;
3604     bool path_searchable;
3605     I32 old_savestack_ix;
3606
3607     sv = POPs;
3608     SvGETMAGIC(sv);
3609     if ( (SvNIOKp(sv) || SvVOK(sv)) && PL_op->op_type != OP_DOFILE) {
3610         sv = sv_2mortal(new_version(sv));
3611         if (!Perl_sv_derived_from_pvn(aTHX_ PL_patchlevel, STR_WITH_LEN("version"), 0))
3612             upg_version(PL_patchlevel, TRUE);
3613         if (cUNOP->op_first->op_type == OP_CONST && cUNOP->op_first->op_private & OPpCONST_NOVER) {
3614             if ( vcmp(sv,PL_patchlevel) <= 0 )
3615                 DIE(aTHX_ "Perls since %"SVf" too modern--this is %"SVf", stopped",
3616                     SVfARG(sv_2mortal(vnormal(sv))),
3617                     SVfARG(sv_2mortal(vnormal(PL_patchlevel)))
3618                 );
3619         }
3620         else {
3621             if ( vcmp(sv,PL_patchlevel) > 0 ) {
3622                 I32 first = 0;
3623                 AV *lav;
3624                 SV * const req = SvRV(sv);
3625                 SV * const pv = *hv_fetchs(MUTABLE_HV(req), "original", FALSE);
3626
3627                 /* get the left hand term */
3628                 lav = MUTABLE_AV(SvRV(*hv_fetchs(MUTABLE_HV(req), "version", FALSE)));
3629
3630                 first  = SvIV(*av_fetch(lav,0,0));
3631                 if (   first > (int)PERL_REVISION    /* probably 'use 6.0' */
3632                     || hv_exists(MUTABLE_HV(req), "qv", 2 ) /* qv style */
3633                     || av_tindex(lav) > 1            /* FP with > 3 digits */
3634                     || strstr(SvPVX(pv),".0")        /* FP with leading 0 */
3635                    ) {
3636                     DIE(aTHX_ "Perl %"SVf" required--this is only "
3637                         "%"SVf", stopped",
3638                         SVfARG(sv_2mortal(vnormal(req))),
3639                         SVfARG(sv_2mortal(vnormal(PL_patchlevel)))
3640                     );
3641                 }
3642                 else { /* probably 'use 5.10' or 'use 5.8' */
3643                     SV *hintsv;
3644                     I32 second = 0;
3645
3646                     if (av_tindex(lav)>=1)
3647                         second = SvIV(*av_fetch(lav,1,0));
3648
3649                     second /= second >= 600  ? 100 : 10;
3650                     hintsv = Perl_newSVpvf(aTHX_ "v%d.%d.0",
3651                                            (int)first, (int)second);
3652                     upg_version(hintsv, TRUE);
3653
3654                     DIE(aTHX_ "Perl %"SVf" required (did you mean %"SVf"?)"
3655                         "--this is only %"SVf", stopped",
3656                         SVfARG(sv_2mortal(vnormal(req))),
3657                         SVfARG(sv_2mortal(vnormal(sv_2mortal(hintsv)))),
3658                         SVfARG(sv_2mortal(vnormal(PL_patchlevel)))
3659                     );
3660                 }
3661             }
3662         }
3663
3664         RETPUSHYES;
3665     }
3666     if (!SvOK(sv))
3667         DIE(aTHX_ "Missing or undefined argument to require");
3668     name = SvPV_nomg_const(sv, len);
3669     if (!(name && len > 0 && *name))
3670         DIE(aTHX_ "Missing or undefined argument to require");
3671
3672     if (!IS_SAFE_PATHNAME(name, len, "require")) {
3673         DIE(aTHX_ "Can't locate %s:   %s",
3674             pv_escape(newSVpvs_flags("",SVs_TEMP),SvPVX(sv),SvCUR(sv),
3675                       SvCUR(sv)*2,NULL, SvUTF8(sv)?PERL_PV_ESCAPE_UNI:0),
3676             Strerror(ENOENT));
3677     }
3678     TAINT_PROPER("require");
3679
3680     path_searchable = path_is_searchable(name);
3681
3682 #ifdef VMS
3683     /* The key in the %ENV hash is in the syntax of file passed as the argument
3684      * usually this is in UNIX format, but sometimes in VMS format, which
3685      * can result in a module being pulled in more than once.
3686      * To prevent this, the key must be stored in UNIX format if the VMS
3687      * name can be translated to UNIX.
3688      */
3689     
3690     if ((unixname =
3691           tounixspec(name, SvPVX(sv_2mortal(newSVpv("", VMS_MAXRSS-1)))))
3692          != NULL) {
3693         unixlen = strlen(unixname);
3694         vms_unixname = 1;
3695     }
3696     else
3697 #endif
3698     {
3699         /* if not VMS or VMS name can not be translated to UNIX, pass it
3700          * through.
3701          */
3702         unixname = (char *) name;
3703         unixlen = len;
3704     }
3705     if (PL_op->op_type == OP_REQUIRE) {
3706         SV * const * const svp = hv_fetch(GvHVn(PL_incgv),
3707                                           unixname, unixlen, 0);
3708         if ( svp ) {
3709             if (*svp != &PL_sv_undef)
3710                 RETPUSHYES;
3711             else
3712                 DIE(aTHX_ "Attempt to reload %s aborted.\n"
3713                             "Compilation failed in require", unixname);
3714         }
3715     }
3716
3717     LOADING_FILE_PROBE(unixname);
3718
3719     /* prepare to compile file */
3720
3721     if (!path_searchable) {
3722         /* At this point, name is SvPVX(sv)  */
3723         tryname = name;
3724         tryrsfp = doopen_pm(sv);
3725     }
3726     if (!tryrsfp && !(errno == EACCES && !path_searchable)) {
3727         AV * const ar = GvAVn(PL_incgv);
3728         SSize_t i;
3729 #ifdef VMS
3730         if (vms_unixname)
3731 #endif
3732         {
3733             SV *nsv = sv;
3734             namesv = newSV_type(SVt_PV);
3735             for (i = 0; i <= AvFILL(ar); i++) {
3736                 SV * const dirsv = *av_fetch(ar, i, TRUE);
3737
3738                 SvGETMAGIC(dirsv);
3739                 if (SvROK(dirsv)) {
3740                     int count;
3741                     SV **svp;
3742                     SV *loader = dirsv;
3743
3744                     if (SvTYPE(SvRV(loader)) == SVt_PVAV
3745                         && !SvOBJECT(SvRV(loader)))
3746                     {
3747                         loader = *av_fetch(MUTABLE_AV(SvRV(loader)), 0, TRUE);
3748                         SvGETMAGIC(loader);
3749                     }
3750
3751                     Perl_sv_setpvf(aTHX_ namesv, "/loader/0x%"UVxf"/%s",
3752                                    PTR2UV(SvRV(dirsv)), name);
3753                     tryname = SvPVX_const(namesv);
3754                     tryrsfp = NULL;
3755
3756                     if (SvPADTMP(nsv)) {
3757                         nsv = sv_newmortal();
3758                         SvSetSV_nosteal(nsv,sv);
3759                     }
3760
3761                     ENTER_with_name("call_INC");
3762                     SAVETMPS;
3763                     EXTEND(SP, 2);
3764
3765                     PUSHMARK(SP);
3766                     PUSHs(dirsv);
3767                     PUSHs(nsv);
3768                     PUTBACK;
3769                     if (SvGMAGICAL(loader)) {
3770                         SV *l = sv_newmortal();
3771                         sv_setsv_nomg(l, loader);
3772                         loader = l;
3773                     }
3774                     if (sv_isobject(loader))
3775                         count = call_method("INC", G_ARRAY);
3776                     else
3777                         count = call_sv(loader, G_ARRAY);
3778                     SPAGAIN;
3779
3780                     if (count > 0) {
3781                         int i = 0;
3782                         SV *arg;
3783
3784                         SP -= count - 1;
3785                         arg = SP[i++];
3786
3787                         if (SvROK(arg) && (SvTYPE(SvRV(arg)) <= SVt_PVLV)
3788                             && !isGV_with_GP(SvRV(arg))) {
3789                             filter_cache = SvRV(arg);
3790
3791                             if (i < count) {
3792                                 arg = SP[i++];
3793                             }
3794                         }
3795
3796                         if (SvROK(arg) && isGV_with_GP(SvRV(arg))) {
3797                             arg = SvRV(arg);
3798                         }
3799
3800                         if (isGV_with_GP(arg)) {
3801                             IO * const io = GvIO((const GV *)arg);
3802
3803                             ++filter_has_file;
3804
3805                             if (io) {
3806                                 tryrsfp = IoIFP(io);
3807                                 if (IoOFP(io) && IoOFP(io) != IoIFP(io)) {
3808                                     PerlIO_close(IoOFP(io));
3809                                 }
3810                                 IoIFP(io) = NULL;
3811                                 IoOFP(io) = NULL;
3812                             }
3813
3814                             if (i < count) {
3815                                 arg = SP[i++];
3816                             }
3817                         }
3818
3819                         if (SvROK(arg) && SvTYPE(SvRV(arg)) == SVt_PVCV) {
3820                             filter_sub = arg;
3821                             SvREFCNT_inc_simple_void_NN(filter_sub);
3822
3823                             if (i < count) {
3824                                 filter_state = SP[i];
3825                                 SvREFCNT_inc_simple_void(filter_state);
3826                             }
3827                         }
3828
3829                         if (!tryrsfp && (filter_cache || filter_sub)) {
3830                             tryrsfp = PerlIO_open(BIT_BUCKET,
3831                                                   PERL_SCRIPT_MODE);
3832                         }
3833                         SP--;
3834                     }
3835
3836                     /* FREETMPS may free our filter_cache */
3837                     SvREFCNT_inc_simple_void(filter_cache);
3838
3839                     PUTBACK;
3840                     FREETMPS;
3841                     LEAVE_with_name("call_INC");
3842
3843                     /* Now re-mortalize it. */
3844                     sv_2mortal(filter_cache);
3845
3846                     /* Adjust file name if the hook has set an %INC entry.
3847                        This needs to happen after the FREETMPS above.  */
3848                     svp = hv_fetch(GvHVn(PL_incgv), name, len, 0);
3849                     if (svp)
3850                         tryname = SvPV_nolen_const(*svp);
3851
3852                     if (tryrsfp) {
3853                         hook_sv = dirsv;
3854                         break;
3855                     }
3856
3857                     filter_has_file = 0;
3858                     filter_cache = NULL;
3859                     if (filter_state) {
3860                         SvREFCNT_dec_NN(filter_state);
3861                         filter_state = NULL;
3862                     }
3863                     if (filter_sub) {
3864                         SvREFCNT_dec_NN(filter_sub);
3865                         filter_sub = NULL;
3866                     }
3867                 }
3868                 else {
3869                   if (path_searchable) {
3870                     const char *dir;
3871                     STRLEN dirlen;
3872
3873                     if (SvOK(dirsv)) {
3874                         dir = SvPV_nomg_const(dirsv, dirlen);
3875                     } else {
3876                         dir = "";
3877                         dirlen = 0;
3878                     }
3879
3880                     if (!IS_SAFE_SYSCALL(dir, dirlen, "@INC entry", "require"))
3881                         continue;
3882 #ifdef VMS
3883                     if ((unixdir =
3884                           tounixpath(dir, SvPVX(sv_2mortal(newSVpv("", VMS_MAXRSS-1)))))
3885                          == NULL)
3886                         continue;
3887                     sv_setpv(namesv, unixdir);
3888                     sv_catpv(namesv, unixname);
3889 #else
3890 #  ifdef __SYMBIAN32__
3891                     if (PL_origfilename[0] &&
3892                         PL_origfilename[1] == ':' &&
3893                         !(dir[0] && dir[1] == ':'))
3894                         Perl_sv_setpvf(aTHX_ namesv,
3895                                        "%c:%s\\%s",
3896                                        PL_origfilename[0],
3897                                        dir, name);
3898                     else
3899                         Perl_sv_setpvf(aTHX_ namesv,
3900                                        "%s\\%s",
3901                                        dir, name);
3902 #  else
3903                     /* The equivalent of                    
3904                        Perl_sv_setpvf(aTHX_ namesv, "%s/%s", dir, name);
3905                        but without the need to parse the format string, or
3906                        call strlen on either pointer, and with the correct
3907                        allocation up front.  */
3908                     {
3909                         char *tmp = SvGROW(namesv, dirlen + len + 2);
3910
3911                         memcpy(tmp, dir, dirlen);
3912                         tmp +=dirlen;
3913
3914                         /* Avoid '<dir>//<file>' */
3915                         if (!dirlen || *(tmp-1) != '/') {
3916                             *tmp++ = '/';
3917                         } else {
3918                             /* So SvCUR_set reports the correct length below */
3919                             dirlen--;
3920                         }
3921
3922                         /* name came from an SV, so it will have a '\0' at the
3923                            end that we can copy as part of this memcpy().  */
3924                         memcpy(tmp, name, len + 1);
3925
3926                         SvCUR_set(namesv, dirlen + len + 1);
3927                         SvPOK_on(namesv);
3928                     }
3929 #  endif
3930 #endif
3931                     TAINT_PROPER("require");
3932                     tryname = SvPVX_const(namesv);
3933                     tryrsfp = doopen_pm(namesv);
3934                     if (tryrsfp) {
3935                         if (tryname[0] == '.' && tryname[1] == '/') {
3936                             ++tryname;
3937                             while (*++tryname == '/') {}
3938                         }
3939                         break;
3940                     }
3941                     else if (errno == EMFILE || errno == EACCES) {
3942                         /* no point in trying other paths if out of handles;
3943                          * on the other hand, if we couldn't open one of the
3944                          * files, then going on with the search could lead to
3945                          * unexpected results; see perl #113422
3946                          */
3947                         break;
3948                     }
3949                   }
3950                 }
3951             }
3952         }
3953     }
3954     saved_errno = errno; /* sv_2mortal can realloc things */
3955     sv_2mortal(namesv);
3956     if (!tryrsfp) {
3957         if (PL_op->op_type == OP_REQUIRE) {
3958             if(saved_errno == EMFILE || saved_errno == EACCES) {
3959                 /* diag_listed_as: Can't locate %s */
3960                 DIE(aTHX_ "Can't locate %s:   %s: %s",
3961                     name, tryname, Strerror(saved_errno));
3962             } else {
3963                 if (namesv) {                   /* did we lookup @INC? */
3964                     AV * const ar = GvAVn(PL_incgv);
3965                     SSize_t i;
3966                     SV *const msg = newSVpvs_flags("", SVs_TEMP);
3967                     SV *const inc = newSVpvs_flags("", SVs_TEMP);
3968                     for (i = 0; i <= AvFILL(ar); i++) {
3969                         sv_catpvs(inc, " ");
3970                         sv_catsv(inc, *av_fetch(ar, i, TRUE));
3971                     }
3972                     if (len >= 4 && memEQ(name + len - 3, ".pm", 4)) {
3973                         const char *c, *e = name + len - 3;
3974                         sv_catpv(msg, " (you may need to install the ");
3975                         for (c = name; c < e; c++) {
3976                             if (*c == '/') {
3977                                 sv_catpvs(msg, "::");
3978                             }
3979                             else {
3980                                 sv_catpvn(msg, c, 1);
3981                             }
3982                         }
3983                         sv_catpv(msg, " module)");
3984                     }
3985                     else if (len >= 2 && memEQ(name + len - 2, ".h", 3)) {
3986                         sv_catpv(msg, " (change .h to .ph maybe?) (did you run h2ph?)");
3987                     }
3988                     else if (len >= 3 && memEQ(name + len - 3, ".ph", 4)) {
3989                         sv_catpv(msg, " (did you run h2ph?)");
3990                     }
3991
3992                     /* diag_listed_as: Can't locate %s */
3993                     DIE(aTHX_
3994                         "Can't locate %s in @INC%" SVf " (@INC contains:%" SVf ")",
3995                         name, msg, inc);
3996                 }
3997             }
3998             DIE(aTHX_ "Can't locate %s", name);
3999         }
4000
4001         CLEAR_ERRSV();
4002         RETPUSHUNDEF;
4003     }
4004     else
4005         SETERRNO(0, SS_NORMAL);
4006
4007     /* Assume success here to prevent recursive requirement. */
4008     /* name is never assigned to again, so len is still strlen(name)  */
4009     /* Check whether a hook in @INC has already filled %INC */
4010     if (!hook_sv) {
4011         (void)hv_store(GvHVn(PL_incgv),
4012                        unixname, unixlen, newSVpv(tryname,0),0);
4013     } else {
4014         SV** const svp = hv_fetch(GvHVn(PL_incgv), unixname, unixlen, 0);
4015         if (!svp)
4016             (void)hv_store(GvHVn(PL_incgv),
4017                            unixname, unixlen, SvREFCNT_inc_simple(hook_sv), 0 );
4018     }
4019
4020     old_savestack_ix = PL_savestack_ix;
4021     SAVECOPFILE_FREE(&PL_compiling);
4022     CopFILE_set(&PL_compiling, tryname);
4023     lex_start(NULL, tryrsfp, 0);
4024
4025     if (filter_sub || filter_cache) {
4026         /* We can use the SvPV of the filter PVIO itself as our cache, rather
4027            than hanging another SV from it. In turn, filter_add() optionally
4028            takes the SV to use as the filter (or creates a new SV if passed
4029            NULL), so simply pass in whatever value filter_cache has.  */
4030         SV * const fc = filter_cache ? newSV(0) : NULL;
4031         SV *datasv;
4032         if (fc) sv_copypv(fc, filter_cache);
4033         datasv = filter_add(S_run_user_filter, fc);
4034         IoLINES(datasv) = filter_has_file;
4035         IoTOP_GV(datasv) = MUTABLE_GV(filter_state);
4036         IoBOTTOM_GV(datasv) = MUTABLE_GV(filter_sub);
4037     }
4038
4039     /* switch to eval mode */
4040     PUSHBLOCK(cx, CXt_EVAL, SP);
4041     PUSHEVAL(cx, name);
4042     cx->blk_oldsaveix = old_savestack_ix;
4043     cx->blk_eval.retop = PL_op->op_next;
4044
4045     SAVECOPLINE(&PL_compiling);
4046     CopLINE_set(&PL_compiling, 0);
4047
4048     PUTBACK;
4049
4050     if (doeval_compile(gimme, NULL, PL_curcop->cop_seq, NULL))
4051         op = DOCATCH(PL_eval_start);
4052     else
4053         op = PL_op->op_next;
4054
4055     LOADED_FILE_PROBE(unixname);
4056
4057     return op;
4058 }
4059
4060 /* This is a op added to hold the hints hash for
4061    pp_entereval. The hash can be modified by the code
4062    being eval'ed, so we return a copy instead. */
4063
4064 PP(pp_hintseval)
4065 {
4066     dSP;
4067     mXPUSHs(MUTABLE_SV(hv_copy_hints_hv(MUTABLE_HV(cSVOP_sv))));
4068     RETURN;
4069 }
4070
4071
4072 PP(pp_entereval)
4073 {
4074     dSP;
4075     PERL_CONTEXT *cx;
4076     SV *sv;
4077     const I32 gimme = GIMME_V;
4078     const U32 was = PL_breakable_sub_gen;
4079     char tbuf[TYPE_DIGITS(long) + 12];
4080     bool saved_delete = FALSE;
4081     char *tmpbuf = tbuf;
4082     STRLEN len;
4083     CV* runcv;
4084     U32 seq, lex_flags = 0;
4085     HV *saved_hh = NULL;
4086     const bool bytes = PL_op->op_private & OPpEVAL_BYTES;
4087     I32 old_savestack_ix;
4088
4089     if (PL_op->op_private & OPpEVAL_HAS_HH) {
4090         saved_hh = MUTABLE_HV(SvREFCNT_inc(POPs));
4091     }
4092     else if (PL_hints & HINT_LOCALIZE_HH || (
4093                 PL_op->op_private & OPpEVAL_COPHH
4094              && PL_curcop->cop_hints & HINT_LOCALIZE_HH
4095             )) {
4096         saved_hh = cop_hints_2hv(PL_curcop, 0);
4097         hv_magic(saved_hh, NULL, PERL_MAGIC_hints);
4098     }
4099     sv = POPs;
4100     if (!SvPOK(sv)) {
4101         /* make sure we've got a plain PV (no overload etc) before testing
4102          * for taint. Making a copy here is probably overkill, but better
4103          * safe than sorry */
4104         STRLEN len;
4105         const char * const p = SvPV_const(sv, len);
4106
4107         sv = newSVpvn_flags(p, len, SVs_TEMP | SvUTF8(sv));
4108         lex_flags |= LEX_START_COPIED;
4109
4110         if (bytes && SvUTF8(sv))
4111             SvPVbyte_force(sv, len);
4112     }
4113     else if (bytes && SvUTF8(sv)) {
4114         /* Don't modify someone else's scalar */
4115         STRLEN len;
4116         sv = newSVsv(sv);
4117         (void)sv_2mortal(sv);
4118         SvPVbyte_force(sv,len);
4119         lex_flags |= LEX_START_COPIED;
4120     }
4121
4122     TAINT_IF(SvTAINTED(sv));
4123     TAINT_PROPER("eval");
4124
4125     old_savestack_ix = PL_savestack_ix;
4126
4127     lex_start(sv, NULL, lex_flags | (PL_op->op_private & OPpEVAL_UNICODE
4128                            ? LEX_IGNORE_UTF8_HINTS
4129                            : bytes ? LEX_EVALBYTES : LEX_START_SAME_FILTER
4130                         )
4131              );
4132
4133     /* switch to eval mode */
4134
4135     if (PERLDB_NAMEEVAL && CopLINE(PL_curcop)) {
4136         SV * const temp_sv = sv_newmortal();
4137         Perl_sv_setpvf(aTHX_ temp_sv, "_<(eval %lu)[%s:%"IVdf"]",
4138                        (unsigned long)++PL_evalseq,
4139                        CopFILE(PL_curcop), (IV)CopLINE(PL_curcop));
4140         tmpbuf = SvPVX(temp_sv);
4141         len = SvCUR(temp_sv);
4142     }
4143     else
4144         len = my_snprintf(tmpbuf, sizeof(tbuf), "_<(eval %lu)", (unsigned long)++PL_evalseq);
4145     SAVECOPFILE_FREE(&PL_compiling);
4146     CopFILE_set(&PL_compiling, tmpbuf+2);
4147     SAVECOPLINE(&PL_compiling);
4148     CopLINE_set(&PL_compiling, 1);
4149     /* special case: an eval '' executed within the DB package gets lexically
4150      * placed in the first non-DB CV rather than the current CV - this
4151      * allows the debugger to execute code, find lexicals etc, in the
4152      * scope of the code being debugged. Passing &seq gets find_runcv
4153      * to do the dirty work for us */
4154     runcv = find_runcv(&seq);
4155
4156     PUSHBLOCK(cx, (CXt_EVAL|CXp_REAL), SP);
4157     PUSHEVAL(cx, 0);
4158     cx->blk_oldsaveix = old_savestack_ix;
4159     cx->blk_eval.retop = PL_op->op_next;
4160
4161     /* prepare to compile string */
4162
4163     if (PERLDB_LINE_OR_SAVESRC && PL_curstash != PL_debstash)
4164         save_lines(CopFILEAV(&PL_compiling), PL_parser->linestr);
4165     else {
4166         /* XXX For C<eval "...">s within BEGIN {} blocks, this ends up
4167            deleting the eval's FILEGV from the stash before gv_check() runs
4168            (i.e. before run-time proper). To work around the coredump that
4169            ensues, we always turn GvMULTI_on for any globals that were
4170            introduced within evals. See force_ident(). GSAR 96-10-12 */
4171         char *const safestr = savepvn(tmpbuf, len);
4172         SAVEDELETE(PL_defstash, safestr, len);
4173         saved_delete = TRUE;
4174     }
4175     
4176     PUTBACK;
4177
4178     if (doeval_compile(gimme, runcv, seq, saved_hh)) {
4179         if (was != PL_breakable_sub_gen /* Some subs defined here. */
4180             ?  PERLDB_LINE_OR_SAVESRC
4181             :  PERLDB_SAVESRC_NOSUBS) {
4182             /* Retain the filegv we created.  */
4183         } else if (!saved_delete) {
4184             char *const safestr = savepvn(tmpbuf, len);
4185             SAVEDELETE(PL_defstash, safestr, len);
4186         }
4187         return DOCATCH(PL_eval_start);
4188     } else {
4189         /* We have already left the scope set up earlier thanks to the LEAVE
4190            in doeval_compile().  */
4191         if (was != PL_breakable_sub_gen /* Some subs defined here. */
4192             ?  PERLDB_LINE_OR_SAVESRC
4193             :  PERLDB_SAVESRC_INVALID) {
4194             /* Retain the filegv we created.  */
4195         } else if (!saved_delete) {
4196             (void)hv_delete(PL_defstash, tmpbuf, len, G_DISCARD);
4197         }
4198         return PL_op->op_next;
4199     }
4200 }
4201
4202 PP(pp_leaveeval)
4203 {
4204     SV **oldsp;
4205     I32 gimme;
4206     PERL_CONTEXT *cx;
4207     OP *retop;
4208     SV *namesv = NULL;
4209     CV *evalcv;
4210     /* grab this value before POPEVAL restores old PL_in_eval */
4211     bool keep = cBOOL(PL_in_eval & EVAL_KEEPERR);
4212
4213     PERL_ASYNC_CHECK();
4214
4215     cx = CX_CUR();
4216     assert(CxTYPE(cx) == CXt_EVAL);
4217
4218     oldsp = PL_stack_base + cx->blk_oldsp;
4219     gimme = cx->blk_gimme;
4220
4221     /* did require return a false value? */
4222     if (       CxOLD_OP_TYPE(cx) == OP_REQUIRE
4223             && !(gimme == G_SCALAR
4224                     ? SvTRUE(*PL_stack_sp)
4225                 : PL_stack_sp > oldsp)
4226     )
4227         namesv = cx->blk_eval.old_namesv;
4228
4229     if (gimme == G_VOID)
4230         PL_stack_sp = oldsp;
4231     else
4232         leave_adjust_stacks(oldsp, oldsp, gimme, 0);
4233
4234     /* the POPEVAL does a leavescope, which frees the optree associated
4235      * with eval, which if it frees the nextstate associated with
4236      * PL_curcop, sets PL_curcop to NULL. Which can mess up freeing a
4237      * regex when running under 'use re Debug' because it needs PL_curcop
4238      * to get the current hints. So restore it early.
4239      */
4240     PL_curcop = cx->blk_oldcop;
4241
4242     CX_LEAVE_SCOPE(cx);
4243     POPEVAL(cx);
4244     POPBLOCK(cx);
4245     retop = cx->blk_eval.retop;
4246     evalcv = cx->blk_eval.cv;
4247     CX_POP(cx);
4248
4249 #ifdef DEBUGGING
4250     assert(CvDEPTH(evalcv) == 1);
4251 #endif
4252     CvDEPTH(evalcv) = 0;
4253
4254     if (namesv) { /* require returned false */
4255         /* Unassume the success we assumed earlier. */
4256         S_undo_inc_then_croak(aTHX_ namesv, NULL, TRUE);
4257         NOT_REACHED; /* NOTREACHED */
4258     }
4259
4260     if (!keep)
4261         CLEAR_ERRSV();
4262
4263     return retop;
4264 }
4265
4266 /* Common code for Perl_call_sv and Perl_fold_constants, put here to keep it
4267    close to the related Perl_create_eval_scope.  */
4268 void
4269 Perl_delete_eval_scope(pTHX)
4270 {
4271     PERL_CONTEXT *cx;
4272         
4273     cx = CX_CUR();
4274     CX_LEAVE_SCOPE(cx);
4275     POPEVAL(cx);
4276     POPBLOCK(cx);
4277     CX_POP(cx);
4278 }
4279
4280 /* Common-ish code salvaged from Perl_call_sv and pp_entertry, because it was
4281    also needed by Perl_fold_constants.  */
4282 PERL_CONTEXT *
4283 Perl_create_eval_scope(pTHX_ U32 flags)
4284 {
4285     PERL_CONTEXT *cx;
4286     const I32 gimme = GIMME_V;
4287         
4288     PUSHBLOCK(cx, (CXt_EVAL|CXp_TRYBLOCK), PL_stack_sp);
4289     PUSHEVAL(cx, 0);
4290     cx->blk_oldsaveix = PL_savestack_ix;
4291
4292     PL_in_eval = EVAL_INEVAL;
4293     if (flags & G_KEEPERR)
4294         PL_in_eval |= EVAL_KEEPERR;
4295     else
4296         CLEAR_ERRSV();
4297     if (flags & G_FAKINGEVAL) {
4298         PL_eval_root = PL_op; /* Only needed so that goto works right. */
4299     }
4300     return cx;
4301 }
4302     
4303 PP(pp_entertry)
4304 {
4305     PERL_CONTEXT * const cx = create_eval_scope(0);
4306     cx->blk_eval.retop = cLOGOP->op_other->op_next;
4307     return DOCATCH(PL_op->op_next);
4308 }
4309
4310 PP(pp_leavetry)
4311 {
4312     SV **oldsp;
4313     I32 gimme;
4314     PERL_CONTEXT *cx;
4315     OP *retop;
4316
4317     PERL_ASYNC_CHECK();
4318
4319     cx = CX_CUR();
4320     assert(CxTYPE(cx) == CXt_EVAL);
4321     oldsp = PL_stack_base + cx->blk_oldsp;
4322     gimme = cx->blk_gimme;
4323
4324     if (gimme == G_VOID)
4325         PL_stack_sp = oldsp;
4326     else
4327         leave_adjust_stacks(oldsp, oldsp, gimme, 1);
4328     CX_LEAVE_SCOPE(cx);
4329     POPEVAL(cx);
4330     POPBLOCK(cx);
4331     retop = cx->blk_eval.retop;
4332     CX_POP(cx);
4333
4334     CLEAR_ERRSV();
4335     return retop;
4336 }
4337
4338 PP(pp_entergiven)
4339 {
4340     dSP;
4341     PERL_CONTEXT *cx;
4342     const I32 gimme = GIMME_V;
4343     SV *origsv = DEFSV;
4344     SV *newsv = POPs;
4345     
4346     assert(!PL_op->op_targ); /* used to be set for lexical $_ */
4347     GvSV(PL_defgv) = SvREFCNT_inc(newsv);
4348
4349     PUSHBLOCK(cx, CXt_GIVEN, SP);
4350     PUSHGIVEN(cx, origsv);
4351
4352     RETURN;
4353 }
4354
4355 PP(pp_leavegiven)
4356 {
4357     PERL_CONTEXT *cx;
4358     I32 gimme;
4359     SV **oldsp;
4360     PERL_UNUSED_CONTEXT;
4361
4362     cx = CX_CUR();
4363     assert(CxTYPE(cx) == CXt_GIVEN);
4364     oldsp = PL_stack_base + cx->blk_oldsp;
4365     gimme = cx->blk_gimme;
4366
4367     if (gimme == G_VOID)
4368         PL_stack_sp = oldsp;
4369     else
4370         leave_adjust_stacks(oldsp, oldsp, gimme, 1);
4371
4372     CX_LEAVE_SCOPE(cx);
4373     POPGIVEN(cx);
4374     POPBLOCK(cx);
4375     CX_POP(cx);
4376
4377     return NORMAL;
4378 }
4379
4380 /* Helper routines used by pp_smartmatch */
4381 STATIC PMOP *
4382 S_make_matcher(pTHX_ REGEXP *re)
4383 {
4384     PMOP *matcher = (PMOP *) newPMOP(OP_MATCH, OPf_WANT_SCALAR | OPf_STACKED);
4385
4386     PERL_ARGS_ASSERT_MAKE_MATCHER;
4387
4388     PM_SETRE(matcher, ReREFCNT_inc(re));
4389
4390     SAVEFREEOP((OP *) matcher);
4391     ENTER_with_name("matcher"); SAVETMPS;
4392     SAVEOP();
4393     return matcher;
4394 }
4395
4396 STATIC bool
4397 S_matcher_matches_sv(pTHX_ PMOP *matcher, SV *sv)
4398 {
4399     dSP;
4400     bool result;
4401
4402     PERL_ARGS_ASSERT_MATCHER_MATCHES_SV;
4403     
4404     PL_op = (OP *) matcher;
4405     XPUSHs(sv);
4406     PUTBACK;
4407     (void) Perl_pp_match(aTHX);
4408     SPAGAIN;
4409     result = SvTRUEx(POPs);
4410     PUTBACK;
4411
4412     return result;
4413 }
4414
4415 STATIC void
4416 S_destroy_matcher(pTHX_ PMOP *matcher)
4417 {
4418     PERL_ARGS_ASSERT_DESTROY_MATCHER;
4419     PERL_UNUSED_ARG(matcher);
4420
4421     FREETMPS;
4422     LEAVE_with_name("matcher");
4423 }
4424
4425 /* Do a smart match */
4426 PP(pp_smartmatch)
4427 {
4428     DEBUG_M(Perl_deb(aTHX_ "Starting smart match resolution\n"));
4429     return do_smartmatch(NULL, NULL, 0);
4430 }
4431
4432 /* This version of do_smartmatch() implements the
4433  * table of smart matches that is found in perlsyn.
4434  */
4435 STATIC OP *
4436 S_do_smartmatch(pTHX_ HV *seen_this, HV *seen_other, const bool copied)
4437 {
4438     dSP;
4439     
4440     bool object_on_left = FALSE;
4441     SV *e = TOPs;       /* e is for 'expression' */
4442     SV *d = TOPm1s;     /* d is for 'default', as in PL_defgv */
4443
4444     /* Take care only to invoke mg_get() once for each argument.
4445      * Currently we do this by copying the SV if it's magical. */
4446     if (d) {
4447         if (!copied && SvGMAGICAL(d))
4448             d = sv_mortalcopy(d);
4449     }
4450     else
4451         d = &PL_sv_undef;
4452
4453     assert(e);
4454     if (SvGMAGICAL(e))
4455         e = sv_mortalcopy(e);
4456
4457     /* First of all, handle overload magic of the rightmost argument */
4458     if (SvAMAGIC(e)) {
4459         SV * tmpsv;
4460         DEBUG_M(Perl_deb(aTHX_ "    applying rule Any-Object\n"));
4461         DEBUG_M(Perl_deb(aTHX_ "        attempting overload\n"));
4462
4463         tmpsv = amagic_call(d, e, smart_amg, AMGf_noleft);
4464         if (tmpsv) {
4465             SPAGAIN;
4466             (void)POPs;
4467             SETs(tmpsv);
4468             RETURN;
4469         }
4470         DEBUG_M(Perl_deb(aTHX_ "        failed to run overload method; continuing...\n"));
4471     }
4472
4473     SP -= 2;    /* Pop the values */
4474     PUTBACK;
4475
4476     /* ~~ undef */
4477     if (!SvOK(e)) {
4478         DEBUG_M(Perl_deb(aTHX_ "    applying rule Any-undef\n"));
4479         if (SvOK(d))
4480             RETPUSHNO;
4481         else
4482             RETPUSHYES;
4483     }
4484
4485     if (SvROK(e) && SvOBJECT(SvRV(e)) && (SvTYPE(SvRV(e)) != SVt_REGEXP)) {
4486         DEBUG_M(Perl_deb(aTHX_ "    applying rule Any-Object\n"));
4487         Perl_croak(aTHX_ "Smart matching a non-overloaded object breaks encapsulation");
4488     }