This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
op.c:newMETHOP: Remove op_next check
[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     if (TAINTING_get && TAINT_get) {
169         SvTAINTED_on((SV*)new_re);
170         RX_TAINT_on(new_re);
171     }
172
173 #if !defined(USE_ITHREADS)
174     /* can't change the optree at runtime either */
175     /* PMf_KEEP is handled differently under threads to avoid these problems */
176     if (!RX_PRELEN(PM_GETRE(pm)) && PL_curpm)
177         pm = PL_curpm;
178     if (pm->op_pmflags & PMf_KEEP) {
179         pm->op_private &= ~OPpRUNTIME;  /* no point compiling again */
180         cLOGOP->op_first->op_next = PL_op->op_next;
181     }
182 #endif
183
184     SP = args-1;
185     RETURN;
186 }
187
188
189 PP(pp_substcont)
190 {
191     dSP;
192     PERL_CONTEXT *cx = &cxstack[cxstack_ix];
193     PMOP * const pm = (PMOP*) cLOGOP->op_other;
194     SV * const dstr = cx->sb_dstr;
195     char *s = cx->sb_s;
196     char *m = cx->sb_m;
197     char *orig = cx->sb_orig;
198     REGEXP * const rx = cx->sb_rx;
199     SV *nsv = NULL;
200     REGEXP *old = PM_GETRE(pm);
201
202     PERL_ASYNC_CHECK();
203
204     if(old != rx) {
205         if(old)
206             ReREFCNT_dec(old);
207         PM_SETRE(pm,ReREFCNT_inc(rx));
208     }
209
210     rxres_restore(&cx->sb_rxres, rx);
211
212     if (cx->sb_iters++) {
213         const I32 saviters = cx->sb_iters;
214         if (cx->sb_iters > cx->sb_maxiters)
215             DIE(aTHX_ "Substitution loop");
216
217         SvGETMAGIC(TOPs); /* possibly clear taint on $1 etc: #67962 */
218
219         /* See "how taint works" above pp_subst() */
220         if (SvTAINTED(TOPs))
221             cx->sb_rxtainted |= SUBST_TAINT_REPL;
222         sv_catsv_nomg(dstr, POPs);
223         if (CxONCE(cx) || s < orig ||
224                 !CALLREGEXEC(rx, s, cx->sb_strend, orig,
225                              (s == m), cx->sb_targ, NULL,
226                     (REXEC_IGNOREPOS|REXEC_NOT_FIRST|REXEC_FAIL_ON_UNDERFLOW)))
227         {
228             SV *targ = cx->sb_targ;
229
230             assert(cx->sb_strend >= s);
231             if(cx->sb_strend > s) {
232                  if (DO_UTF8(dstr) && !SvUTF8(targ))
233                       sv_catpvn_nomg_utf8_upgrade(dstr, s, cx->sb_strend - s, nsv);
234                  else
235                       sv_catpvn_nomg(dstr, s, cx->sb_strend - s);
236             }
237             if (RX_MATCH_TAINTED(rx)) /* run time pattern taint, eg locale */
238                 cx->sb_rxtainted |= SUBST_TAINT_PAT;
239
240             if (pm->op_pmflags & PMf_NONDESTRUCT) {
241                 PUSHs(dstr);
242                 /* From here on down we're using the copy, and leaving the
243                    original untouched.  */
244                 targ = dstr;
245             }
246             else {
247                 SV_CHECK_THINKFIRST_COW_DROP(targ);
248                 if (isGV(targ)) Perl_croak_no_modify();
249                 SvPV_free(targ);
250                 SvPV_set(targ, SvPVX(dstr));
251                 SvCUR_set(targ, SvCUR(dstr));
252                 SvLEN_set(targ, SvLEN(dstr));
253                 if (DO_UTF8(dstr))
254                     SvUTF8_on(targ);
255                 SvPV_set(dstr, NULL);
256
257                 PL_tainted = 0;
258                 mPUSHi(saviters - 1);
259
260                 (void)SvPOK_only_UTF8(targ);
261             }
262
263             /* update the taint state of various various variables in
264              * preparation for final exit.
265              * See "how taint works" above pp_subst() */
266             if (TAINTING_get) {
267                 if ((cx->sb_rxtainted & SUBST_TAINT_PAT) ||
268                     ((cx->sb_rxtainted & (SUBST_TAINT_STR|SUBST_TAINT_RETAINT))
269                                     == (SUBST_TAINT_STR|SUBST_TAINT_RETAINT))
270                 )
271                     (RX_MATCH_TAINTED_on(rx)); /* taint $1 et al */
272
273                 if (!(cx->sb_rxtainted & SUBST_TAINT_BOOLRET)
274                     && (cx->sb_rxtainted & (SUBST_TAINT_STR|SUBST_TAINT_PAT))
275                 )
276                     SvTAINTED_on(TOPs);  /* taint return value */
277                 /* needed for mg_set below */
278                 TAINT_set(
279                     cBOOL(cx->sb_rxtainted &
280                           (SUBST_TAINT_STR|SUBST_TAINT_PAT|SUBST_TAINT_REPL))
281                 );
282                 SvTAINT(TARG);
283             }
284             /* PL_tainted must be correctly set for this mg_set */
285             SvSETMAGIC(TARG);
286             TAINT_NOT;
287             LEAVE_SCOPE(cx->sb_oldsave);
288             POPSUBST(cx);
289             PERL_ASYNC_CHECK();
290             RETURNOP(pm->op_next);
291             NOT_REACHED; /* NOTREACHED */
292         }
293         cx->sb_iters = saviters;
294     }
295     if (RX_MATCH_COPIED(rx) && RX_SUBBEG(rx) != orig) {
296         m = s;
297         s = orig;
298         assert(!RX_SUBOFFSET(rx));
299         cx->sb_orig = orig = RX_SUBBEG(rx);
300         s = orig + (m - s);
301         cx->sb_strend = s + (cx->sb_strend - m);
302     }
303     cx->sb_m = m = RX_OFFS(rx)[0].start + orig;
304     if (m > s) {
305         if (DO_UTF8(dstr) && !SvUTF8(cx->sb_targ))
306             sv_catpvn_nomg_utf8_upgrade(dstr, s, m - s, nsv);
307         else
308             sv_catpvn_nomg(dstr, s, m-s);
309     }
310     cx->sb_s = RX_OFFS(rx)[0].end + orig;
311     { /* Update the pos() information. */
312         SV * const sv
313             = (pm->op_pmflags & PMf_NONDESTRUCT) ? cx->sb_dstr : cx->sb_targ;
314         MAGIC *mg;
315         if (!(mg = mg_find_mglob(sv))) {
316             mg = sv_magicext_mglob(sv);
317         }
318         assert(SvPOK(sv));
319         MgBYTEPOS_set(mg, sv, SvPVX(sv), m - orig);
320     }
321     if (old != rx)
322         (void)ReREFCNT_inc(rx);
323     /* update the taint state of various various variables in preparation
324      * for calling the code block.
325      * See "how taint works" above pp_subst() */
326     if (TAINTING_get) {
327         if (RX_MATCH_TAINTED(rx)) /* run time pattern taint, eg locale */
328             cx->sb_rxtainted |= SUBST_TAINT_PAT;
329
330         if ((cx->sb_rxtainted & SUBST_TAINT_PAT) ||
331             ((cx->sb_rxtainted & (SUBST_TAINT_STR|SUBST_TAINT_RETAINT))
332                             == (SUBST_TAINT_STR|SUBST_TAINT_RETAINT))
333         )
334             (RX_MATCH_TAINTED_on(rx)); /* taint $1 et al */
335
336         if (cx->sb_iters > 1 && (cx->sb_rxtainted & 
337                         (SUBST_TAINT_STR|SUBST_TAINT_PAT|SUBST_TAINT_REPL)))
338             SvTAINTED_on((pm->op_pmflags & PMf_NONDESTRUCT)
339                          ? cx->sb_dstr : cx->sb_targ);
340         TAINT_NOT;
341     }
342     rxres_save(&cx->sb_rxres, rx);
343     PL_curpm = pm;
344     RETURNOP(pm->op_pmstashstartu.op_pmreplstart);
345 }
346
347 void
348 Perl_rxres_save(pTHX_ void **rsp, REGEXP *rx)
349 {
350     UV *p = (UV*)*rsp;
351     U32 i;
352
353     PERL_ARGS_ASSERT_RXRES_SAVE;
354     PERL_UNUSED_CONTEXT;
355
356     if (!p || p[1] < RX_NPARENS(rx)) {
357 #ifdef PERL_ANY_COW
358         i = 7 + (RX_NPARENS(rx)+1) * 2;
359 #else
360         i = 6 + (RX_NPARENS(rx)+1) * 2;
361 #endif
362         if (!p)
363             Newx(p, i, UV);
364         else
365             Renew(p, i, UV);
366         *rsp = (void*)p;
367     }
368
369     /* what (if anything) to free on croak */
370     *p++ = PTR2UV(RX_MATCH_COPIED(rx) ? RX_SUBBEG(rx) : NULL);
371     RX_MATCH_COPIED_off(rx);
372     *p++ = RX_NPARENS(rx);
373
374 #ifdef PERL_ANY_COW
375     *p++ = PTR2UV(RX_SAVED_COPY(rx));
376     RX_SAVED_COPY(rx) = NULL;
377 #endif
378
379     *p++ = PTR2UV(RX_SUBBEG(rx));
380     *p++ = (UV)RX_SUBLEN(rx);
381     *p++ = (UV)RX_SUBOFFSET(rx);
382     *p++ = (UV)RX_SUBCOFFSET(rx);
383     for (i = 0; i <= RX_NPARENS(rx); ++i) {
384         *p++ = (UV)RX_OFFS(rx)[i].start;
385         *p++ = (UV)RX_OFFS(rx)[i].end;
386     }
387 }
388
389 static void
390 S_rxres_restore(pTHX_ void **rsp, REGEXP *rx)
391 {
392     UV *p = (UV*)*rsp;
393     U32 i;
394
395     PERL_ARGS_ASSERT_RXRES_RESTORE;
396     PERL_UNUSED_CONTEXT;
397
398     RX_MATCH_COPY_FREE(rx);
399     RX_MATCH_COPIED_set(rx, *p);
400     *p++ = 0;
401     RX_NPARENS(rx) = *p++;
402
403 #ifdef PERL_ANY_COW
404     if (RX_SAVED_COPY(rx))
405         SvREFCNT_dec (RX_SAVED_COPY(rx));
406     RX_SAVED_COPY(rx) = INT2PTR(SV*,*p);
407     *p++ = 0;
408 #endif
409
410     RX_SUBBEG(rx) = INT2PTR(char*,*p++);
411     RX_SUBLEN(rx) = (I32)(*p++);
412     RX_SUBOFFSET(rx) = (I32)*p++;
413     RX_SUBCOFFSET(rx) = (I32)*p++;
414     for (i = 0; i <= RX_NPARENS(rx); ++i) {
415         RX_OFFS(rx)[i].start = (I32)(*p++);
416         RX_OFFS(rx)[i].end = (I32)(*p++);
417     }
418 }
419
420 static void
421 S_rxres_free(pTHX_ void **rsp)
422 {
423     UV * const p = (UV*)*rsp;
424
425     PERL_ARGS_ASSERT_RXRES_FREE;
426     PERL_UNUSED_CONTEXT;
427
428     if (p) {
429         void *tmp = INT2PTR(char*,*p);
430 #ifdef PERL_POISON
431 #ifdef PERL_ANY_COW
432         U32 i = 9 + p[1] * 2;
433 #else
434         U32 i = 8 + p[1] * 2;
435 #endif
436 #endif
437
438 #ifdef PERL_ANY_COW
439         SvREFCNT_dec (INT2PTR(SV*,p[2]));
440 #endif
441 #ifdef PERL_POISON
442         PoisonFree(p, i, sizeof(UV));
443 #endif
444
445         Safefree(tmp);
446         Safefree(p);
447         *rsp = NULL;
448     }
449 }
450
451 #define FORM_NUM_BLANK (1<<30)
452 #define FORM_NUM_POINT (1<<29)
453
454 PP(pp_formline)
455 {
456     dSP; dMARK; dORIGMARK;
457     SV * const tmpForm = *++MARK;
458     SV *formsv;             /* contains text of original format */
459     U32 *fpc;       /* format ops program counter */
460     char *t;        /* current append position in target string */
461     const char *f;          /* current position in format string */
462     I32 arg;
463     SV *sv = NULL; /* current item */
464     const char *item = NULL;/* string value of current item */
465     I32 itemsize  = 0;      /* length (chars) of item, possibly truncated */
466     I32 itembytes = 0;      /* as itemsize, but length in bytes */
467     I32 fieldsize = 0;      /* width of current field */
468     I32 lines = 0;          /* number of lines that have been output */
469     bool chopspace = (strchr(PL_chopset, ' ') != NULL); /* does $: have space */
470     const char *chophere = NULL; /* where to chop current item */
471     STRLEN linemark = 0;    /* pos of start of line in output */
472     NV value;
473     bool gotsome = FALSE;   /* seen at least one non-blank item on this line */
474     STRLEN len;             /* length of current sv */
475     STRLEN linemax;         /* estimate of output size in bytes */
476     bool item_is_utf8 = FALSE;
477     bool targ_is_utf8 = FALSE;
478     const char *fmt;
479     MAGIC *mg = NULL;
480     U8 *source;             /* source of bytes to append */
481     STRLEN to_copy;         /* how may bytes to append */
482     char trans;             /* what chars to translate */
483
484     mg = doparseform(tmpForm);
485
486     fpc = (U32*)mg->mg_ptr;
487     /* the actual string the format was compiled from.
488      * with overload etc, this may not match tmpForm */
489     formsv = mg->mg_obj;
490
491
492     SvPV_force(PL_formtarget, len);
493     if (SvTAINTED(tmpForm) || SvTAINTED(formsv))
494         SvTAINTED_on(PL_formtarget);
495     if (DO_UTF8(PL_formtarget))
496         targ_is_utf8 = TRUE;
497     linemax = (SvCUR(formsv) * (IN_BYTES ? 1 : 3) + 1);
498     t = SvGROW(PL_formtarget, len + linemax + 1);
499     /* XXX from now onwards, SvCUR(PL_formtarget) is invalid */
500     t += len;
501     f = SvPV_const(formsv, len);
502
503     for (;;) {
504         DEBUG_f( {
505             const char *name = "???";
506             arg = -1;
507             switch (*fpc) {
508             case FF_LITERAL:    arg = fpc[1]; name = "LITERAL"; break;
509             case FF_BLANK:      arg = fpc[1]; name = "BLANK";   break;
510             case FF_SKIP:       arg = fpc[1]; name = "SKIP";    break;
511             case FF_FETCH:      arg = fpc[1]; name = "FETCH";   break;
512             case FF_DECIMAL:    arg = fpc[1]; name = "DECIMAL"; break;
513
514             case FF_CHECKNL:    name = "CHECKNL";       break;
515             case FF_CHECKCHOP:  name = "CHECKCHOP";     break;
516             case FF_SPACE:      name = "SPACE";         break;
517             case FF_HALFSPACE:  name = "HALFSPACE";     break;
518             case FF_ITEM:       name = "ITEM";          break;
519             case FF_CHOP:       name = "CHOP";          break;
520             case FF_LINEGLOB:   name = "LINEGLOB";      break;
521             case FF_NEWLINE:    name = "NEWLINE";       break;
522             case FF_MORE:       name = "MORE";          break;
523             case FF_LINEMARK:   name = "LINEMARK";      break;
524             case FF_END:        name = "END";           break;
525             case FF_0DECIMAL:   name = "0DECIMAL";      break;
526             case FF_LINESNGL:   name = "LINESNGL";      break;
527             }
528             if (arg >= 0)
529                 PerlIO_printf(Perl_debug_log, "%-16s%ld\n", name, (long) arg);
530             else
531                 PerlIO_printf(Perl_debug_log, "%-16s\n", name);
532         } );
533         switch (*fpc++) {
534         case FF_LINEMARK: /* start (or end) of a line */
535             linemark = t - SvPVX(PL_formtarget);
536             lines++;
537             gotsome = FALSE;
538             break;
539
540         case FF_LITERAL: /* append <arg> literal chars */
541             to_copy = *fpc++;
542             source = (U8 *)f;
543             f += to_copy;
544             trans = '~';
545             item_is_utf8 = targ_is_utf8 ? !!DO_UTF8(formsv) : !!SvUTF8(formsv);
546             goto append;
547
548         case FF_SKIP: /* skip <arg> chars in format */
549             f += *fpc++;
550             break;
551
552         case FF_FETCH: /* get next item and set field size to <arg> */
553             arg = *fpc++;
554             f += arg;
555             fieldsize = arg;
556
557             if (MARK < SP)
558                 sv = *++MARK;
559             else {
560                 sv = &PL_sv_no;
561                 Perl_ck_warner(aTHX_ packWARN(WARN_SYNTAX), "Not enough format arguments");
562             }
563             if (SvTAINTED(sv))
564                 SvTAINTED_on(PL_formtarget);
565             break;
566
567         case FF_CHECKNL: /* find max len of item (up to \n) that fits field */
568             {
569                 const char *s = item = SvPV_const(sv, len);
570                 const char *send = s + len;
571
572                 itemsize = 0;
573                 item_is_utf8 = DO_UTF8(sv);
574                 while (s < send) {
575                     if (!isCNTRL(*s))
576                         gotsome = TRUE;
577                     else if (*s == '\n')
578                         break;
579
580                     if (item_is_utf8)
581                         s += UTF8SKIP(s);
582                     else
583                         s++;
584                     itemsize++;
585                     if (itemsize == fieldsize)
586                         break;
587                 }
588                 itembytes = s - item;
589                 break;
590             }
591
592         case FF_CHECKCHOP: /* like CHECKNL, but up to highest split point */
593             {
594                 const char *s = item = SvPV_const(sv, len);
595                 const char *send = s + len;
596                 I32 size = 0;
597
598                 chophere = NULL;
599                 item_is_utf8 = DO_UTF8(sv);
600                 while (s < send) {
601                     /* look for a legal split position */
602                     if (isSPACE(*s)) {
603                         if (*s == '\r') {
604                             chophere = s;
605                             itemsize = size;
606                             break;
607                         }
608                         if (chopspace) {
609                             /* provisional split point */
610                             chophere = s;
611                             itemsize = size;
612                         }
613                         /* we delay testing fieldsize until after we've
614                          * processed the possible split char directly
615                          * following the last field char; so if fieldsize=3
616                          * and item="a b cdef", we consume "a b", not "a".
617                          * Ditto further down.
618                          */
619                         if (size == fieldsize)
620                             break;
621                     }
622                     else {
623                         if (strchr(PL_chopset, *s)) {
624                             /* provisional split point */
625                             /* for a non-space split char, we include
626                              * the split char; hence the '+1' */
627                             chophere = s + 1;
628                             itemsize = size;
629                         }
630                         if (size == fieldsize)
631                             break;
632                         if (!isCNTRL(*s))
633                             gotsome = TRUE;
634                     }
635
636                     if (item_is_utf8)
637                         s += UTF8SKIP(s);
638                     else
639                         s++;
640                     size++;
641                 }
642                 if (!chophere || s == send) {
643                     chophere = s;
644                     itemsize = size;
645                 }
646                 itembytes = chophere - item;
647
648                 break;
649             }
650
651         case FF_SPACE: /* append padding space (diff of field, item size) */
652             arg = fieldsize - itemsize;
653             if (arg) {
654                 fieldsize -= arg;
655                 while (arg-- > 0)
656                     *t++ = ' ';
657             }
658             break;
659
660         case FF_HALFSPACE: /* like FF_SPACE, but only append half as many */
661             arg = fieldsize - itemsize;
662             if (arg) {
663                 arg /= 2;
664                 fieldsize -= arg;
665                 while (arg-- > 0)
666                     *t++ = ' ';
667             }
668             break;
669
670         case FF_ITEM: /* append a text item, while blanking ctrl chars */
671             to_copy = itembytes;
672             source = (U8 *)item;
673             trans = 1;
674             goto append;
675
676         case FF_CHOP: /* (for ^*) chop the current item */
677             {
678                 const char *s = chophere;
679                 if (chopspace) {
680                     while (isSPACE(*s))
681                         s++;
682                 }
683                 if (SvPOKp(sv))
684                     sv_chop(sv,s);
685                 else
686                     /* tied, overloaded or similar strangeness.
687                      * Do it the hard way */
688                     sv_setpvn(sv, s, len - (s-item));
689                 SvSETMAGIC(sv);
690                 break;
691             }
692
693         case FF_LINESNGL: /* process ^*  */
694             chopspace = 0;
695             /* FALLTHROUGH */
696
697         case FF_LINEGLOB: /* process @*  */
698             {
699                 const bool oneline = fpc[-1] == FF_LINESNGL;
700                 const char *s = item = SvPV_const(sv, len);
701                 const char *const send = s + len;
702
703                 item_is_utf8 = DO_UTF8(sv);
704                 if (!len)
705                     break;
706                 trans = 0;
707                 gotsome = TRUE;
708                 chophere = s + len;
709                 source = (U8 *) s;
710                 to_copy = len;
711                 while (s < send) {
712                     if (*s++ == '\n') {
713                         if (oneline) {
714                             to_copy = s - item - 1;
715                             chophere = s;
716                             break;
717                         } else {
718                             if (s == send) {
719                                 to_copy--;
720                             } else
721                                 lines++;
722                         }
723                     }
724                 }
725             }
726
727         append:
728             /* append to_copy bytes from source to PL_formstring.
729              * item_is_utf8 implies source is utf8.
730              * if trans, translate certain characters during the copy */
731             {
732                 U8 *tmp = NULL;
733                 STRLEN grow = 0;
734
735                 SvCUR_set(PL_formtarget,
736                           t - SvPVX_const(PL_formtarget));
737
738                 if (targ_is_utf8 && !item_is_utf8) {
739                     source = tmp = bytes_to_utf8(source, &to_copy);
740                 } else {
741                     if (item_is_utf8 && !targ_is_utf8) {
742                         U8 *s;
743                         /* Upgrade targ to UTF8, and then we reduce it to
744                            a problem we have a simple solution for.
745                            Don't need get magic.  */
746                         sv_utf8_upgrade_nomg(PL_formtarget);
747                         targ_is_utf8 = TRUE;
748                         /* re-calculate linemark */
749                         s = (U8*)SvPVX(PL_formtarget);
750                         /* the bytes we initially allocated to append the
751                          * whole line may have been gobbled up during the
752                          * upgrade, so allocate a whole new line's worth
753                          * for safety */
754                         grow = linemax;
755                         while (linemark--)
756                             s += UTF8SKIP(s);
757                         linemark = s - (U8*)SvPVX(PL_formtarget);
758                     }
759                     /* Easy. They agree.  */
760                     assert (item_is_utf8 == targ_is_utf8);
761                 }
762                 if (!trans)
763                     /* @* and ^* are the only things that can exceed
764                      * the linemax, so grow by the output size, plus
765                      * a whole new form's worth in case of any further
766                      * output */
767                     grow = linemax + to_copy;
768                 if (grow)
769                     SvGROW(PL_formtarget, SvCUR(PL_formtarget) + grow + 1);
770                 t = SvPVX(PL_formtarget) + SvCUR(PL_formtarget);
771
772                 Copy(source, t, to_copy, char);
773                 if (trans) {
774                     /* blank out ~ or control chars, depending on trans.
775                      * works on bytes not chars, so relies on not
776                      * matching utf8 continuation bytes */
777                     U8 *s = (U8*)t;
778                     U8 *send = s + to_copy;
779                     while (s < send) {
780                         const int ch = *s;
781                         if (trans == '~' ? (ch == '~') : isCNTRL(ch))
782                             *s = ' ';
783                         s++;
784                     }
785                 }
786
787                 t += to_copy;
788                 SvCUR_set(PL_formtarget, SvCUR(PL_formtarget) + to_copy);
789                 if (tmp)
790                     Safefree(tmp);
791                 break;
792             }
793
794         case FF_0DECIMAL: /* like FF_DECIMAL but for 0### */
795             arg = *fpc++;
796             fmt = (const char *)
797                 ((arg & FORM_NUM_POINT) ? "%#0*.*" NVff : "%0*.*" NVff);
798             goto ff_dec;
799
800         case FF_DECIMAL: /* do @##, ^##, where <arg>=(precision|flags) */
801             arg = *fpc++;
802             fmt = (const char *)
803                 ((arg & FORM_NUM_POINT) ? "%#*.*" NVff : "%*.*" NVff);
804         ff_dec:
805             /* If the field is marked with ^ and the value is undefined,
806                blank it out. */
807             if ((arg & FORM_NUM_BLANK) && !SvOK(sv)) {
808                 arg = fieldsize;
809                 while (arg--)
810                     *t++ = ' ';
811                 break;
812             }
813             gotsome = TRUE;
814             value = SvNV(sv);
815             /* overflow evidence */
816             if (num_overflow(value, fieldsize, arg)) {
817                 arg = fieldsize;
818                 while (arg--)
819                     *t++ = '#';
820                 break;
821             }
822             /* Formats aren't yet marked for locales, so assume "yes". */
823             {
824                 Size_t max = SvLEN(PL_formtarget) - (t - SvPVX(PL_formtarget));
825                 int len;
826                 DECLARE_STORE_LC_NUMERIC_SET_TO_NEEDED();
827                 arg &= ~(FORM_NUM_POINT|FORM_NUM_BLANK);
828 #ifdef USE_QUADMATH
829                 {
830                     const char* qfmt = quadmath_format_single(fmt);
831                     int len;
832                     if (!qfmt)
833                         Perl_croak_nocontext("panic: quadmath invalid format \"%s\"", fmt);
834                     len = quadmath_snprintf(t, max, qfmt, (int) fieldsize, (int) arg, value);
835                     if (len == -1)
836                         Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", qfmt);
837                     if (qfmt != fmt)
838                         Safefree(fmt);
839                 }
840 #else
841                 /* we generate fmt ourselves so it is safe */
842                 GCC_DIAG_IGNORE(-Wformat-nonliteral);
843                 len = my_snprintf(t, max, fmt, (int) fieldsize, (int) arg, value);
844                 GCC_DIAG_RESTORE;
845 #endif
846                 PERL_MY_SNPRINTF_POST_GUARD(len, max);
847                 RESTORE_LC_NUMERIC();
848             }
849             t += fieldsize;
850             break;
851
852         case FF_NEWLINE: /* delete trailing spaces, then append \n */
853             f++;
854             while (t-- > (SvPVX(PL_formtarget) + linemark) && *t == ' ') ;
855             t++;
856             *t++ = '\n';
857             break;
858
859         case FF_BLANK: /* for arg==0: do '~'; for arg>0 : do '~~' */
860             arg = *fpc++;
861             if (gotsome) {
862                 if (arg) {              /* repeat until fields exhausted? */
863                     fpc--;
864                     goto end;
865                 }
866             }
867             else {
868                 t = SvPVX(PL_formtarget) + linemark;
869                 lines--;
870             }
871             break;
872
873         case FF_MORE: /* replace long end of string with '...' */
874             {
875                 const char *s = chophere;
876                 const char *send = item + len;
877                 if (chopspace) {
878                     while (isSPACE(*s) && (s < send))
879                         s++;
880                 }
881                 if (s < send) {
882                     char *s1;
883                     arg = fieldsize - itemsize;
884                     if (arg) {
885                         fieldsize -= arg;
886                         while (arg-- > 0)
887                             *t++ = ' ';
888                     }
889                     s1 = t - 3;
890                     if (strnEQ(s1,"   ",3)) {
891                         while (s1 > SvPVX_const(PL_formtarget) && isSPACE(s1[-1]))
892                             s1--;
893                     }
894                     *s1++ = '.';
895                     *s1++ = '.';
896                     *s1++ = '.';
897                 }
898                 break;
899             }
900
901         case FF_END: /* tidy up, then return */
902         end:
903             assert(t < SvPVX_const(PL_formtarget) + SvLEN(PL_formtarget));
904             *t = '\0';
905             SvCUR_set(PL_formtarget, t - SvPVX_const(PL_formtarget));
906             if (targ_is_utf8)
907                 SvUTF8_on(PL_formtarget);
908             FmLINES(PL_formtarget) += lines;
909             SP = ORIGMARK;
910             if (fpc[-1] == FF_BLANK)
911                 RETURNOP(cLISTOP->op_first);
912             else
913                 RETPUSHYES;
914         }
915     }
916 }
917
918 PP(pp_grepstart)
919 {
920     dSP;
921     SV *src;
922
923     if (PL_stack_base + *PL_markstack_ptr == SP) {
924         (void)POPMARK;
925         if (GIMME_V == G_SCALAR)
926             mXPUSHi(0);
927         RETURNOP(PL_op->op_next->op_next);
928     }
929     PL_stack_sp = PL_stack_base + *PL_markstack_ptr + 1;
930     Perl_pp_pushmark(aTHX);                             /* push dst */
931     Perl_pp_pushmark(aTHX);                             /* push src */
932     ENTER_with_name("grep");                                    /* enter outer scope */
933
934     SAVETMPS;
935     if (PL_op->op_private & OPpGREP_LEX)
936         SAVESPTR(PAD_SVl(PL_op->op_targ));
937     else
938         SAVE_DEFSV;
939     ENTER_with_name("grep_item");                                       /* enter inner scope */
940     SAVEVPTR(PL_curpm);
941
942     src = PL_stack_base[*PL_markstack_ptr];
943     if (SvPADTMP(src)) {
944         src = PL_stack_base[*PL_markstack_ptr] = sv_mortalcopy(src);
945         PL_tmps_floor++;
946     }
947     SvTEMP_off(src);
948     if (PL_op->op_private & OPpGREP_LEX)
949         PAD_SVl(PL_op->op_targ) = src;
950     else
951         DEFSV_set(src);
952
953     PUTBACK;
954     if (PL_op->op_type == OP_MAPSTART)
955         Perl_pp_pushmark(aTHX);                 /* push top */
956     return ((LOGOP*)PL_op->op_next)->op_other;
957 }
958
959 PP(pp_mapwhile)
960 {
961     dSP;
962     const I32 gimme = GIMME_V;
963     I32 items = (SP - PL_stack_base) - *PL_markstack_ptr; /* how many new items */
964     I32 count;
965     I32 shift;
966     SV** src;
967     SV** dst;
968
969     /* first, move source pointer to the next item in the source list */
970     ++PL_markstack_ptr[-1];
971
972     /* if there are new items, push them into the destination list */
973     if (items && gimme != G_VOID) {
974         /* might need to make room back there first */
975         if (items > PL_markstack_ptr[-1] - PL_markstack_ptr[-2]) {
976             /* XXX this implementation is very pessimal because the stack
977              * is repeatedly extended for every set of items.  Is possible
978              * to do this without any stack extension or copying at all
979              * by maintaining a separate list over which the map iterates
980              * (like foreach does). --gsar */
981
982             /* everything in the stack after the destination list moves
983              * towards the end the stack by the amount of room needed */
984             shift = items - (PL_markstack_ptr[-1] - PL_markstack_ptr[-2]);
985
986             /* items to shift up (accounting for the moved source pointer) */
987             count = (SP - PL_stack_base) - (PL_markstack_ptr[-1] - 1);
988
989             /* This optimization is by Ben Tilly and it does
990              * things differently from what Sarathy (gsar)
991              * is describing.  The downside of this optimization is
992              * that leaves "holes" (uninitialized and hopefully unused areas)
993              * to the Perl stack, but on the other hand this
994              * shouldn't be a problem.  If Sarathy's idea gets
995              * implemented, this optimization should become
996              * irrelevant.  --jhi */
997             if (shift < count)
998                 shift = count; /* Avoid shifting too often --Ben Tilly */
999
1000             EXTEND(SP,shift);
1001             src = SP;
1002             dst = (SP += shift);
1003             PL_markstack_ptr[-1] += shift;
1004             *PL_markstack_ptr += shift;
1005             while (count--)
1006                 *dst-- = *src--;
1007         }
1008         /* copy the new items down to the destination list */
1009         dst = PL_stack_base + (PL_markstack_ptr[-2] += items) - 1;
1010         if (gimme == G_ARRAY) {
1011             /* add returned items to the collection (making mortal copies
1012              * if necessary), then clear the current temps stack frame
1013              * *except* for those items. We do this splicing the items
1014              * into the start of the tmps frame (so some items may be on
1015              * the tmps stack twice), then moving PL_tmps_floor above
1016              * them, then freeing the frame. That way, the only tmps that
1017              * accumulate over iterations are the return values for map.
1018              * We have to do to this way so that everything gets correctly
1019              * freed if we die during the map.
1020              */
1021             I32 tmpsbase;
1022             I32 i = items;
1023             /* make space for the slice */
1024             EXTEND_MORTAL(items);
1025             tmpsbase = PL_tmps_floor + 1;
1026             Move(PL_tmps_stack + tmpsbase,
1027                  PL_tmps_stack + tmpsbase + items,
1028                  PL_tmps_ix - PL_tmps_floor,
1029                  SV*);
1030             PL_tmps_ix += items;
1031
1032             while (i-- > 0) {
1033                 SV *sv = POPs;
1034                 if (!SvTEMP(sv))
1035                     sv = sv_mortalcopy(sv);
1036                 *dst-- = sv;
1037                 PL_tmps_stack[tmpsbase++] = SvREFCNT_inc_simple(sv);
1038             }
1039             /* clear the stack frame except for the items */
1040             PL_tmps_floor += items;
1041             FREETMPS;
1042             /* FREETMPS may have cleared the TEMP flag on some of the items */
1043             i = items;
1044             while (i-- > 0)
1045                 SvTEMP_on(PL_tmps_stack[--tmpsbase]);
1046         }
1047         else {
1048             /* scalar context: we don't care about which values map returns
1049              * (we use undef here). And so we certainly don't want to do mortal
1050              * copies of meaningless values. */
1051             while (items-- > 0) {
1052                 (void)POPs;
1053                 *dst-- = &PL_sv_undef;
1054             }
1055             FREETMPS;
1056         }
1057     }
1058     else {
1059         FREETMPS;
1060     }
1061     LEAVE_with_name("grep_item");                                       /* exit inner scope */
1062
1063     /* All done yet? */
1064     if (PL_markstack_ptr[-1] > *PL_markstack_ptr) {
1065
1066         (void)POPMARK;                          /* pop top */
1067         LEAVE_with_name("grep");                                        /* exit outer scope */
1068         (void)POPMARK;                          /* pop src */
1069         items = --*PL_markstack_ptr - PL_markstack_ptr[-1];
1070         (void)POPMARK;                          /* pop dst */
1071         SP = PL_stack_base + POPMARK;           /* pop original mark */
1072         if (gimme == G_SCALAR) {
1073             if (PL_op->op_private & OPpGREP_LEX) {
1074                 SV* sv = sv_newmortal();
1075                 sv_setiv(sv, items);
1076                 PUSHs(sv);
1077             }
1078             else {
1079                 dTARGET;
1080                 XPUSHi(items);
1081             }
1082         }
1083         else if (gimme == G_ARRAY)
1084             SP += items;
1085         RETURN;
1086     }
1087     else {
1088         SV *src;
1089
1090         ENTER_with_name("grep_item");                                   /* enter inner scope */
1091         SAVEVPTR(PL_curpm);
1092
1093         /* set $_ to the new source item */
1094         src = PL_stack_base[PL_markstack_ptr[-1]];
1095         if (SvPADTMP(src)) {
1096             src = sv_mortalcopy(src);
1097         }
1098         SvTEMP_off(src);
1099         if (PL_op->op_private & OPpGREP_LEX)
1100             PAD_SVl(PL_op->op_targ) = src;
1101         else
1102             DEFSV_set(src);
1103
1104         RETURNOP(cLOGOP->op_other);
1105     }
1106 }
1107
1108 /* Range stuff. */
1109
1110 PP(pp_range)
1111 {
1112     if (GIMME == G_ARRAY)
1113         return NORMAL;
1114     if (SvTRUEx(PAD_SV(PL_op->op_targ)))
1115         return cLOGOP->op_other;
1116     else
1117         return NORMAL;
1118 }
1119
1120 PP(pp_flip)
1121 {
1122     dSP;
1123
1124     if (GIMME == G_ARRAY) {
1125         RETURNOP(((LOGOP*)cUNOP->op_first)->op_other);
1126     }
1127     else {
1128         dTOPss;
1129         SV * const targ = PAD_SV(PL_op->op_targ);
1130         int flip = 0;
1131
1132         if (PL_op->op_private & OPpFLIP_LINENUM) {
1133             if (GvIO(PL_last_in_gv)) {
1134                 flip = SvIV(sv) == (IV)IoLINES(GvIOp(PL_last_in_gv));
1135             }
1136             else {
1137                 GV * const gv = gv_fetchpvs(".", GV_ADD|GV_NOTQUAL, SVt_PV);
1138                 if (gv && GvSV(gv))
1139                     flip = SvIV(sv) == SvIV(GvSV(gv));
1140             }
1141         } else {
1142             flip = SvTRUE(sv);
1143         }
1144         if (flip) {
1145             sv_setiv(PAD_SV(cUNOP->op_first->op_targ), 1);
1146             if (PL_op->op_flags & OPf_SPECIAL) {
1147                 sv_setiv(targ, 1);
1148                 SETs(targ);
1149                 RETURN;
1150             }
1151             else {
1152                 sv_setiv(targ, 0);
1153                 SP--;
1154                 RETURNOP(((LOGOP*)cUNOP->op_first)->op_other);
1155             }
1156         }
1157         sv_setpvs(TARG, "");
1158         SETs(targ);
1159         RETURN;
1160     }
1161 }
1162
1163 /* This code tries to decide if "$left .. $right" should use the
1164    magical string increment, or if the range is numeric (we make
1165    an exception for .."0" [#18165]). AMS 20021031. */
1166
1167 #define RANGE_IS_NUMERIC(left,right) ( \
1168         SvNIOKp(left)  || (SvOK(left)  && !SvPOKp(left))  || \
1169         SvNIOKp(right) || (SvOK(right) && !SvPOKp(right)) || \
1170         (((!SvOK(left) && SvOK(right)) || ((!SvOK(left) || \
1171           looks_like_number(left)) && SvPOKp(left) && *SvPVX_const(left) != '0')) \
1172          && (!SvOK(right) || looks_like_number(right))))
1173
1174 PP(pp_flop)
1175 {
1176     dSP;
1177
1178     if (GIMME == G_ARRAY) {
1179         dPOPPOPssrl;
1180
1181         SvGETMAGIC(left);
1182         SvGETMAGIC(right);
1183
1184         if (RANGE_IS_NUMERIC(left,right)) {
1185             IV i, j, n;
1186             if ((SvOK(left) && !SvIOK(left) && SvNV_nomg(left) < IV_MIN) ||
1187                 (SvOK(right) && (SvIOK(right)
1188                                  ? SvIsUV(right) && SvUV(right) > IV_MAX
1189                                  : SvNV_nomg(right) > IV_MAX)))
1190                 DIE(aTHX_ "Range iterator outside integer range");
1191             i = SvIV_nomg(left);
1192             j = SvIV_nomg(right);
1193             if (j >= i) {
1194                 /* Dance carefully around signed max. */
1195                 bool overflow = (i <= 0 && j > SSize_t_MAX + i - 1);
1196                 if (!overflow) {
1197                     n = j - i + 1;
1198                     /* The wraparound of signed integers is undefined
1199                      * behavior, but here we aim for count >=1, and
1200                      * negative count is just wrong. */
1201                     if (n < 1)
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             }
1215         }
1216         else {
1217             STRLEN len, llen;
1218             const char * const lpv = SvPV_nomg_const(left, llen);
1219             const char * const tmps = SvPV_nomg_const(right, len);
1220
1221             SV *sv = newSVpvn_flags(lpv, llen, SvUTF8(left)|SVs_TEMP);
1222             while (!SvNIOKp(sv) && SvCUR(sv) <= len) {
1223                 XPUSHs(sv);
1224                 if (strEQ(SvPVX_const(sv),tmps))
1225                     break;
1226                 sv = sv_2mortal(newSVsv(sv));
1227                 sv_inc(sv);
1228             }
1229         }
1230     }
1231     else {
1232         dTOPss;
1233         SV * const targ = PAD_SV(cUNOP->op_first->op_targ);
1234         int flop = 0;
1235         sv_inc(targ);
1236
1237         if (PL_op->op_private & OPpFLIP_LINENUM) {
1238             if (GvIO(PL_last_in_gv)) {
1239                 flop = SvIV(sv) == (IV)IoLINES(GvIOp(PL_last_in_gv));
1240             }
1241             else {
1242                 GV * const gv = gv_fetchpvs(".", GV_ADD|GV_NOTQUAL, SVt_PV);
1243                 if (gv && GvSV(gv)) flop = SvIV(sv) == SvIV(GvSV(gv));
1244             }
1245         }
1246         else {
1247             flop = SvTRUE(sv);
1248         }
1249
1250         if (flop) {
1251             sv_setiv(PAD_SV(((UNOP*)cUNOP->op_first)->op_first->op_targ), 0);
1252             sv_catpvs(targ, "E0");
1253         }
1254         SETs(targ);
1255     }
1256
1257     RETURN;
1258 }
1259
1260 /* Control. */
1261
1262 static const char * const context_name[] = {
1263     "pseudo-block",
1264     NULL, /* CXt_WHEN never actually needs "block" */
1265     NULL, /* CXt_BLOCK never actually needs "block" */
1266     NULL, /* CXt_GIVEN never actually needs "block" */
1267     NULL, /* CXt_LOOP_FOR never actually needs "loop" */
1268     NULL, /* CXt_LOOP_PLAIN never actually needs "loop" */
1269     NULL, /* CXt_LOOP_LAZYSV never actually needs "loop" */
1270     NULL, /* CXt_LOOP_LAZYIV never actually needs "loop" */
1271     "subroutine",
1272     "format",
1273     "eval",
1274     "substitution",
1275 };
1276
1277 STATIC I32
1278 S_dopoptolabel(pTHX_ const char *label, STRLEN len, U32 flags)
1279 {
1280     I32 i;
1281
1282     PERL_ARGS_ASSERT_DOPOPTOLABEL;
1283
1284     for (i = cxstack_ix; i >= 0; i--) {
1285         const PERL_CONTEXT * const cx = &cxstack[i];
1286         switch (CxTYPE(cx)) {
1287         case CXt_SUBST:
1288         case CXt_SUB:
1289         case CXt_FORMAT:
1290         case CXt_EVAL:
1291         case CXt_NULL:
1292             /* diag_listed_as: Exiting subroutine via %s */
1293             Perl_ck_warner(aTHX_ packWARN(WARN_EXITING), "Exiting %s via %s",
1294                            context_name[CxTYPE(cx)], OP_NAME(PL_op));
1295             if (CxTYPE(cx) == CXt_NULL)
1296                 return -1;
1297             break;
1298         case CXt_LOOP_LAZYIV:
1299         case CXt_LOOP_LAZYSV:
1300         case CXt_LOOP_FOR:
1301         case CXt_LOOP_PLAIN:
1302           {
1303             STRLEN cx_label_len = 0;
1304             U32 cx_label_flags = 0;
1305             const char *cx_label = CxLABEL_len_flags(cx, &cx_label_len, &cx_label_flags);
1306             if (!cx_label || !(
1307                     ( (cx_label_flags & SVf_UTF8) != (flags & SVf_UTF8) ) ?
1308                         (flags & SVf_UTF8)
1309                             ? (bytes_cmp_utf8(
1310                                         (const U8*)cx_label, cx_label_len,
1311                                         (const U8*)label, len) == 0)
1312                             : (bytes_cmp_utf8(
1313                                         (const U8*)label, len,
1314                                         (const U8*)cx_label, cx_label_len) == 0)
1315                     : (len == cx_label_len && ((cx_label == label)
1316                                     || memEQ(cx_label, label, len))) )) {
1317                 DEBUG_l(Perl_deb(aTHX_ "(poptolabel(): skipping label at cx=%ld %s)\n",
1318                         (long)i, cx_label));
1319                 continue;
1320             }
1321             DEBUG_l( Perl_deb(aTHX_ "(poptolabel(): found label at cx=%ld %s)\n", (long)i, label));
1322             return i;
1323           }
1324         }
1325     }
1326     return i;
1327 }
1328
1329
1330
1331 I32
1332 Perl_dowantarray(pTHX)
1333 {
1334     const I32 gimme = block_gimme();
1335     return (gimme == G_VOID) ? G_SCALAR : gimme;
1336 }
1337
1338 I32
1339 Perl_block_gimme(pTHX)
1340 {
1341     const I32 cxix = dopoptosub(cxstack_ix);
1342     if (cxix < 0)
1343         return G_VOID;
1344
1345     switch (cxstack[cxix].blk_gimme) {
1346     case G_VOID:
1347         return G_VOID;
1348     case G_SCALAR:
1349         return G_SCALAR;
1350     case G_ARRAY:
1351         return G_ARRAY;
1352     default:
1353         Perl_croak(aTHX_ "panic: bad gimme: %d\n", cxstack[cxix].blk_gimme);
1354     }
1355     NOT_REACHED; /* NOTREACHED */
1356 }
1357
1358 I32
1359 Perl_is_lvalue_sub(pTHX)
1360 {
1361     const I32 cxix = dopoptosub(cxstack_ix);
1362     assert(cxix >= 0);  /* We should only be called from inside subs */
1363
1364     if (CxLVAL(cxstack + cxix) && CvLVALUE(cxstack[cxix].blk_sub.cv))
1365         return CxLVAL(cxstack + cxix);
1366     else
1367         return 0;
1368 }
1369
1370 /* only used by PUSHSUB */
1371 I32
1372 Perl_was_lvalue_sub(pTHX)
1373 {
1374     const I32 cxix = dopoptosub(cxstack_ix-1);
1375     assert(cxix >= 0);  /* We should only be called from inside subs */
1376
1377     if (CxLVAL(cxstack + cxix) && CvLVALUE(cxstack[cxix].blk_sub.cv))
1378         return CxLVAL(cxstack + cxix);
1379     else
1380         return 0;
1381 }
1382
1383 STATIC I32
1384 S_dopoptosub_at(pTHX_ const PERL_CONTEXT *cxstk, I32 startingblock)
1385 {
1386     I32 i;
1387
1388     PERL_ARGS_ASSERT_DOPOPTOSUB_AT;
1389 #ifndef DEBUGGING
1390     PERL_UNUSED_CONTEXT;
1391 #endif
1392
1393     for (i = startingblock; i >= 0; i--) {
1394         const PERL_CONTEXT * const cx = &cxstk[i];
1395         switch (CxTYPE(cx)) {
1396         default:
1397             continue;
1398         case CXt_SUB:
1399             /* in sub foo { /(?{...})/ }, foo ends up on the CX stack
1400              * twice; the first for the normal foo() call, and the second
1401              * for a faked up re-entry into the sub to execute the
1402              * code block. Hide this faked entry from the world. */
1403             if (cx->cx_type & CXp_SUB_RE_FAKE)
1404                 continue;
1405             /* FALLTHROUGH */
1406         case CXt_EVAL:
1407         case CXt_FORMAT:
1408             DEBUG_l( Perl_deb(aTHX_ "(dopoptosub_at(): found sub at cx=%ld)\n", (long)i));
1409             return i;
1410         }
1411     }
1412     return i;
1413 }
1414
1415 STATIC I32
1416 S_dopoptoeval(pTHX_ I32 startingblock)
1417 {
1418     I32 i;
1419     for (i = startingblock; i >= 0; i--) {
1420         const PERL_CONTEXT *cx = &cxstack[i];
1421         switch (CxTYPE(cx)) {
1422         default:
1423             continue;
1424         case CXt_EVAL:
1425             DEBUG_l( Perl_deb(aTHX_ "(dopoptoeval(): found eval at cx=%ld)\n", (long)i));
1426             return i;
1427         }
1428     }
1429     return i;
1430 }
1431
1432 STATIC I32
1433 S_dopoptoloop(pTHX_ I32 startingblock)
1434 {
1435     I32 i;
1436     for (i = startingblock; i >= 0; i--) {
1437         const PERL_CONTEXT * const cx = &cxstack[i];
1438         switch (CxTYPE(cx)) {
1439         case CXt_SUBST:
1440         case CXt_SUB:
1441         case CXt_FORMAT:
1442         case CXt_EVAL:
1443         case CXt_NULL:
1444             /* diag_listed_as: Exiting subroutine via %s */
1445             Perl_ck_warner(aTHX_ packWARN(WARN_EXITING), "Exiting %s via %s",
1446                            context_name[CxTYPE(cx)], OP_NAME(PL_op));
1447             if ((CxTYPE(cx)) == CXt_NULL)
1448                 return -1;
1449             break;
1450         case CXt_LOOP_LAZYIV:
1451         case CXt_LOOP_LAZYSV:
1452         case CXt_LOOP_FOR:
1453         case CXt_LOOP_PLAIN:
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 STATIC I32
1462 S_dopoptogiven(pTHX_ I32 startingblock)
1463 {
1464     I32 i;
1465     for (i = startingblock; i >= 0; i--) {
1466         const PERL_CONTEXT *cx = &cxstack[i];
1467         switch (CxTYPE(cx)) {
1468         default:
1469             continue;
1470         case CXt_GIVEN:
1471             DEBUG_l( Perl_deb(aTHX_ "(dopoptogiven(): found given at cx=%ld)\n", (long)i));
1472             return i;
1473         case CXt_LOOP_PLAIN:
1474             assert(!CxFOREACHDEF(cx));
1475             break;
1476         case CXt_LOOP_LAZYIV:
1477         case CXt_LOOP_LAZYSV:
1478         case CXt_LOOP_FOR:
1479             if (CxFOREACHDEF(cx)) {
1480                 DEBUG_l( Perl_deb(aTHX_ "(dopoptogiven(): found foreach at cx=%ld)\n", (long)i));
1481                 return i;
1482             }
1483         }
1484     }
1485     return i;
1486 }
1487
1488 STATIC I32
1489 S_dopoptowhen(pTHX_ I32 startingblock)
1490 {
1491     I32 i;
1492     for (i = startingblock; i >= 0; i--) {
1493         const PERL_CONTEXT *cx = &cxstack[i];
1494         switch (CxTYPE(cx)) {
1495         default:
1496             continue;
1497         case CXt_WHEN:
1498             DEBUG_l( Perl_deb(aTHX_ "(dopoptowhen(): found when at cx=%ld)\n", (long)i));
1499             return i;
1500         }
1501     }
1502     return i;
1503 }
1504
1505 void
1506 Perl_dounwind(pTHX_ I32 cxix)
1507 {
1508     I32 optype;
1509
1510     if (!PL_curstackinfo) /* can happen if die during thread cloning */
1511         return;
1512
1513     while (cxstack_ix > cxix) {
1514         SV *sv;
1515         PERL_CONTEXT *cx = &cxstack[cxstack_ix];
1516         DEBUG_CX("UNWIND");                                             \
1517         /* Note: we don't need to restore the base context info till the end. */
1518         switch (CxTYPE(cx)) {
1519         case CXt_SUBST:
1520             POPSUBST(cx);
1521             continue;  /* not break */
1522         case CXt_SUB:
1523             POPSUB(cx,sv);
1524             LEAVESUB(sv);
1525             break;
1526         case CXt_EVAL:
1527             POPEVAL(cx);
1528             break;
1529         case CXt_LOOP_LAZYIV:
1530         case CXt_LOOP_LAZYSV:
1531         case CXt_LOOP_FOR:
1532         case CXt_LOOP_PLAIN:
1533             POPLOOP(cx);
1534             break;
1535         case CXt_NULL:
1536             break;
1537         case CXt_FORMAT:
1538             POPFORMAT(cx);
1539             break;
1540         }
1541         cxstack_ix--;
1542     }
1543     PERL_UNUSED_VAR(optype);
1544 }
1545
1546 void
1547 Perl_qerror(pTHX_ SV *err)
1548 {
1549     PERL_ARGS_ASSERT_QERROR;
1550
1551     if (PL_in_eval) {
1552         if (PL_in_eval & EVAL_KEEPERR) {
1553                 Perl_ck_warner(aTHX_ packWARN(WARN_MISC), "\t(in cleanup) %"SVf,
1554                                                     SVfARG(err));
1555         }
1556         else
1557             sv_catsv(ERRSV, err);
1558     }
1559     else if (PL_errors)
1560         sv_catsv(PL_errors, err);
1561     else
1562         Perl_warn(aTHX_ "%"SVf, SVfARG(err));
1563     if (PL_parser)
1564         ++PL_parser->error_count;
1565 }
1566
1567 void
1568 Perl_die_unwind(pTHX_ SV *msv)
1569 {
1570     SV *exceptsv = sv_mortalcopy(msv);
1571     U8 in_eval = PL_in_eval;
1572     PERL_ARGS_ASSERT_DIE_UNWIND;
1573
1574     if (in_eval) {
1575         I32 cxix;
1576         I32 gimme;
1577
1578         /*
1579          * Historically, perl used to set ERRSV ($@) early in the die
1580          * process and rely on it not getting clobbered during unwinding.
1581          * That sucked, because it was liable to get clobbered, so the
1582          * setting of ERRSV used to emit the exception from eval{} has
1583          * been moved to much later, after unwinding (see just before
1584          * JMPENV_JUMP below).  However, some modules were relying on the
1585          * early setting, by examining $@ during unwinding to use it as
1586          * a flag indicating whether the current unwinding was caused by
1587          * an exception.  It was never a reliable flag for that purpose,
1588          * being totally open to false positives even without actual
1589          * clobberage, but was useful enough for production code to
1590          * semantically rely on it.
1591          *
1592          * We'd like to have a proper introspective interface that
1593          * explicitly describes the reason for whatever unwinding
1594          * operations are currently in progress, so that those modules
1595          * work reliably and $@ isn't further overloaded.  But we don't
1596          * have one yet.  In its absence, as a stopgap measure, ERRSV is
1597          * now *additionally* set here, before unwinding, to serve as the
1598          * (unreliable) flag that it used to.
1599          *
1600          * This behaviour is temporary, and should be removed when a
1601          * proper way to detect exceptional unwinding has been developed.
1602          * As of 2010-12, the authors of modules relying on the hack
1603          * are aware of the issue, because the modules failed on
1604          * perls 5.13.{1..7} which had late setting of $@ without this
1605          * early-setting hack.
1606          */
1607         if (!(in_eval & EVAL_KEEPERR)) {
1608             SvTEMP_off(exceptsv);
1609             sv_setsv(ERRSV, exceptsv);
1610         }
1611
1612         if (in_eval & EVAL_KEEPERR) {
1613             Perl_ck_warner(aTHX_ packWARN(WARN_MISC), "\t(in cleanup) %"SVf,
1614                            SVfARG(exceptsv));
1615         }
1616
1617         while ((cxix = dopoptoeval(cxstack_ix)) < 0
1618                && PL_curstackinfo->si_prev)
1619         {
1620             dounwind(-1);
1621             POPSTACK;
1622         }
1623
1624         if (cxix >= 0) {
1625             I32 optype;
1626             SV *namesv;
1627             PERL_CONTEXT *cx;
1628             SV **newsp;
1629 #ifdef DEBUGGING
1630             COP *oldcop;
1631 #endif
1632             JMPENV *restartjmpenv;
1633             OP *restartop;
1634
1635             if (cxix < cxstack_ix)
1636                 dounwind(cxix);
1637
1638             POPBLOCK(cx,PL_curpm);
1639             if (CxTYPE(cx) != CXt_EVAL) {
1640                 STRLEN msglen;
1641                 const char* message = SvPVx_const(exceptsv, msglen);
1642                 PerlIO_write(Perl_error_log, (const char *)"panic: die ", 11);
1643                 PerlIO_write(Perl_error_log, message, msglen);
1644                 my_exit(1);
1645             }
1646             POPEVAL(cx);
1647             namesv = cx->blk_eval.old_namesv;
1648 #ifdef DEBUGGING
1649             oldcop = cx->blk_oldcop;
1650 #endif
1651             restartjmpenv = cx->blk_eval.cur_top_env;
1652             restartop = cx->blk_eval.retop;
1653
1654             if (gimme == G_SCALAR)
1655                 *++newsp = &PL_sv_undef;
1656             PL_stack_sp = newsp;
1657
1658             LEAVE;
1659
1660             if (optype == OP_REQUIRE) {
1661                 assert (PL_curcop == oldcop);
1662                 (void)hv_store(GvHVn(PL_incgv),
1663                                SvPVX_const(namesv),
1664                                SvUTF8(namesv) ? -(I32)SvCUR(namesv) : (I32)SvCUR(namesv),
1665                                &PL_sv_undef, 0);
1666                 /* note that unlike pp_entereval, pp_require isn't
1667                  * supposed to trap errors. So now that we've popped the
1668                  * EVAL that pp_require pushed, and processed the error
1669                  * message, rethrow the error */
1670                 Perl_croak(aTHX_ "%"SVf"Compilation failed in require",
1671                            SVfARG(exceptsv ? exceptsv : newSVpvs_flags("Unknown error\n",
1672                                                                     SVs_TEMP)));
1673             }
1674             if (!(in_eval & EVAL_KEEPERR))
1675                 sv_setsv(ERRSV, exceptsv);
1676             PL_restartjmpenv = restartjmpenv;
1677             PL_restartop = restartop;
1678             JMPENV_JUMP(3);
1679             NOT_REACHED; /* NOTREACHED */
1680         }
1681     }
1682
1683     write_to_stderr(exceptsv);
1684     my_failure_exit();
1685     NOT_REACHED; /* NOTREACHED */
1686 }
1687
1688 PP(pp_xor)
1689 {
1690     dSP; dPOPTOPssrl;
1691     if (SvTRUE(left) != SvTRUE(right))
1692         RETSETYES;
1693     else
1694         RETSETNO;
1695 }
1696
1697 /*
1698
1699 =head1 CV Manipulation Functions
1700
1701 =for apidoc caller_cx
1702
1703 The XSUB-writer's equivalent of L<caller()|perlfunc/caller>.  The
1704 returned C<PERL_CONTEXT> structure can be interrogated to find all the
1705 information returned to Perl by C<caller>.  Note that XSUBs don't get a
1706 stack frame, so C<caller_cx(0, NULL)> will return information for the
1707 immediately-surrounding Perl code.
1708
1709 This function skips over the automatic calls to C<&DB::sub> made on the
1710 behalf of the debugger.  If the stack frame requested was a sub called by
1711 C<DB::sub>, the return value will be the frame for the call to
1712 C<DB::sub>, since that has the correct line number/etc. for the call
1713 site.  If I<dbcxp> is non-C<NULL>, it will be set to a pointer to the
1714 frame for the sub call itself.
1715
1716 =cut
1717 */
1718
1719 const PERL_CONTEXT *
1720 Perl_caller_cx(pTHX_ I32 count, const PERL_CONTEXT **dbcxp)
1721 {
1722     I32 cxix = dopoptosub(cxstack_ix);
1723     const PERL_CONTEXT *cx;
1724     const PERL_CONTEXT *ccstack = cxstack;
1725     const PERL_SI *top_si = PL_curstackinfo;
1726
1727     for (;;) {
1728         /* we may be in a higher stacklevel, so dig down deeper */
1729         while (cxix < 0 && top_si->si_type != PERLSI_MAIN) {
1730             top_si = top_si->si_prev;
1731             ccstack = top_si->si_cxstack;
1732             cxix = dopoptosub_at(ccstack, top_si->si_cxix);
1733         }
1734         if (cxix < 0)
1735             return NULL;
1736         /* caller() should not report the automatic calls to &DB::sub */
1737         if (PL_DBsub && GvCV(PL_DBsub) && cxix >= 0 &&
1738                 ccstack[cxix].blk_sub.cv == GvCV(PL_DBsub))
1739             count++;
1740         if (!count--)
1741             break;
1742         cxix = dopoptosub_at(ccstack, cxix - 1);
1743     }
1744
1745     cx = &ccstack[cxix];
1746     if (dbcxp) *dbcxp = cx;
1747
1748     if (CxTYPE(cx) == CXt_SUB || CxTYPE(cx) == CXt_FORMAT) {
1749         const I32 dbcxix = dopoptosub_at(ccstack, cxix - 1);
1750         /* We expect that ccstack[dbcxix] is CXt_SUB, anyway, the
1751            field below is defined for any cx. */
1752         /* caller() should not report the automatic calls to &DB::sub */
1753         if (PL_DBsub && GvCV(PL_DBsub) && dbcxix >= 0 && ccstack[dbcxix].blk_sub.cv == GvCV(PL_DBsub))
1754             cx = &ccstack[dbcxix];
1755     }
1756
1757     return cx;
1758 }
1759
1760 PP(pp_caller)
1761 {
1762     dSP;
1763     const PERL_CONTEXT *cx;
1764     const PERL_CONTEXT *dbcx;
1765     I32 gimme;
1766     const HEK *stash_hek;
1767     I32 count = 0;
1768     bool has_arg = MAXARG && TOPs;
1769     const COP *lcop;
1770
1771     if (MAXARG) {
1772       if (has_arg)
1773         count = POPi;
1774       else (void)POPs;
1775     }
1776
1777     cx = caller_cx(count + !!(PL_op->op_private & OPpOFFBYONE), &dbcx);
1778     if (!cx) {
1779         if (GIMME != G_ARRAY) {
1780             EXTEND(SP, 1);
1781             RETPUSHUNDEF;
1782         }
1783         RETURN;
1784     }
1785
1786     DEBUG_CX("CALLER");
1787     assert(CopSTASH(cx->blk_oldcop));
1788     stash_hek = SvTYPE(CopSTASH(cx->blk_oldcop)) == SVt_PVHV
1789       ? HvNAME_HEK((HV*)CopSTASH(cx->blk_oldcop))
1790       : NULL;
1791     if (GIMME != G_ARRAY) {
1792         EXTEND(SP, 1);
1793         if (!stash_hek)
1794             PUSHs(&PL_sv_undef);
1795         else {
1796             dTARGET;
1797             sv_sethek(TARG, stash_hek);
1798             PUSHs(TARG);
1799         }
1800         RETURN;
1801     }
1802
1803     EXTEND(SP, 11);
1804
1805     if (!stash_hek)
1806         PUSHs(&PL_sv_undef);
1807     else {
1808         dTARGET;
1809         sv_sethek(TARG, stash_hek);
1810         PUSHTARG;
1811     }
1812     mPUSHs(newSVpv(OutCopFILE(cx->blk_oldcop), 0));
1813     lcop = closest_cop(cx->blk_oldcop, OP_SIBLING(cx->blk_oldcop),
1814                        cx->blk_sub.retop, TRUE);
1815     if (!lcop)
1816         lcop = cx->blk_oldcop;
1817     mPUSHi((I32)CopLINE(lcop));
1818     if (!has_arg)
1819         RETURN;
1820     if (CxTYPE(cx) == CXt_SUB || CxTYPE(cx) == CXt_FORMAT) {
1821         /* So is ccstack[dbcxix]. */
1822         if (CvHASGV(dbcx->blk_sub.cv)) {
1823             PUSHs(cv_name(dbcx->blk_sub.cv, 0, 0));
1824             PUSHs(boolSV(CxHASARGS(cx)));
1825         }
1826         else {
1827             PUSHs(newSVpvs_flags("(unknown)", SVs_TEMP));
1828             PUSHs(boolSV(CxHASARGS(cx)));
1829         }
1830     }
1831     else {
1832         PUSHs(newSVpvs_flags("(eval)", SVs_TEMP));
1833         mPUSHi(0);
1834     }
1835     gimme = (I32)cx->blk_gimme;
1836     if (gimme == G_VOID)
1837         PUSHs(&PL_sv_undef);
1838     else
1839         PUSHs(boolSV((gimme & G_WANT) == G_ARRAY));
1840     if (CxTYPE(cx) == CXt_EVAL) {
1841         /* eval STRING */
1842         if (CxOLD_OP_TYPE(cx) == OP_ENTEREVAL) {
1843             SV *cur_text = cx->blk_eval.cur_text;
1844             if (SvCUR(cur_text) >= 2) {
1845                 PUSHs(newSVpvn_flags(SvPVX(cur_text), SvCUR(cur_text)-2,
1846                                      SvUTF8(cur_text)|SVs_TEMP));
1847             }
1848             else {
1849                 /* I think this is will always be "", but be sure */
1850                 PUSHs(sv_2mortal(newSVsv(cur_text)));
1851             }
1852
1853             PUSHs(&PL_sv_no);
1854         }
1855         /* require */
1856         else if (cx->blk_eval.old_namesv) {
1857             mPUSHs(newSVsv(cx->blk_eval.old_namesv));
1858             PUSHs(&PL_sv_yes);
1859         }
1860         /* eval BLOCK (try blocks have old_namesv == 0) */
1861         else {
1862             PUSHs(&PL_sv_undef);
1863             PUSHs(&PL_sv_undef);
1864         }
1865     }
1866     else {
1867         PUSHs(&PL_sv_undef);
1868         PUSHs(&PL_sv_undef);
1869     }
1870     if (CxTYPE(cx) == CXt_SUB && CxHASARGS(cx)
1871         && CopSTASH_eq(PL_curcop, PL_debstash))
1872     {
1873         AV * const ary = cx->blk_sub.argarray;
1874         const SSize_t off = AvARRAY(ary) - AvALLOC(ary);
1875
1876         Perl_init_dbargs(aTHX);
1877
1878         if (AvMAX(PL_dbargs) < AvFILLp(ary) + off)
1879             av_extend(PL_dbargs, AvFILLp(ary) + off);
1880         Copy(AvALLOC(ary), AvARRAY(PL_dbargs), AvFILLp(ary) + 1 + off, SV*);
1881         AvFILLp(PL_dbargs) = AvFILLp(ary) + off;
1882     }
1883     mPUSHi(CopHINTS_get(cx->blk_oldcop));
1884     {
1885         SV * mask ;
1886         STRLEN * const old_warnings = cx->blk_oldcop->cop_warnings ;
1887
1888         if  (old_warnings == pWARN_NONE)
1889             mask = newSVpvn(WARN_NONEstring, WARNsize) ;
1890         else if (old_warnings == pWARN_STD && (PL_dowarn & G_WARN_ON) == 0)
1891             mask = &PL_sv_undef ;
1892         else if (old_warnings == pWARN_ALL ||
1893                   (old_warnings == pWARN_STD && PL_dowarn & G_WARN_ON)) {
1894             /* Get the bit mask for $warnings::Bits{all}, because
1895              * it could have been extended by warnings::register */
1896             SV **bits_all;
1897             HV * const bits = get_hv("warnings::Bits", 0);
1898             if (bits && (bits_all=hv_fetchs(bits, "all", FALSE))) {
1899                 mask = newSVsv(*bits_all);
1900             }
1901             else {
1902                 mask = newSVpvn(WARN_ALLstring, WARNsize) ;
1903             }
1904         }
1905         else
1906             mask = newSVpvn((char *) (old_warnings + 1), old_warnings[0]);
1907         mPUSHs(mask);
1908     }
1909
1910     PUSHs(cx->blk_oldcop->cop_hints_hash ?
1911           sv_2mortal(newRV_noinc(MUTABLE_SV(cop_hints_2hv(cx->blk_oldcop, 0))))
1912           : &PL_sv_undef);
1913     RETURN;
1914 }
1915
1916 PP(pp_reset)
1917 {
1918     dSP;
1919     const char * tmps;
1920     STRLEN len = 0;
1921     if (MAXARG < 1 || (!TOPs && !POPs))
1922         tmps = NULL, len = 0;
1923     else
1924         tmps = SvPVx_const(POPs, len);
1925     sv_resetpvn(tmps, len, CopSTASH(PL_curcop));
1926     PUSHs(&PL_sv_yes);
1927     RETURN;
1928 }
1929
1930 /* like pp_nextstate, but used instead when the debugger is active */
1931
1932 PP(pp_dbstate)
1933 {
1934     PL_curcop = (COP*)PL_op;
1935     TAINT_NOT;          /* Each statement is presumed innocent */
1936     PL_stack_sp = PL_stack_base + cxstack[cxstack_ix].blk_oldsp;
1937     FREETMPS;
1938
1939     PERL_ASYNC_CHECK();
1940
1941     if (PL_op->op_flags & OPf_SPECIAL /* breakpoint */
1942             || PL_DBsingle_iv || PL_DBsignal_iv || PL_DBtrace_iv)
1943     {
1944         dSP;
1945         PERL_CONTEXT *cx;
1946         const I32 gimme = G_ARRAY;
1947         U8 hasargs;
1948         GV * const gv = PL_DBgv;
1949         CV * cv = NULL;
1950
1951         if (gv && isGV_with_GP(gv))
1952             cv = GvCV(gv);
1953
1954         if (!cv || (!CvROOT(cv) && !CvXSUB(cv)))
1955             DIE(aTHX_ "No DB::DB routine defined");
1956
1957         if (CvDEPTH(cv) >= 1 && !(PL_debug & DEBUG_DB_RECURSE_FLAG))
1958             /* don't do recursive DB::DB call */
1959             return NORMAL;
1960
1961         ENTER;
1962         SAVETMPS;
1963
1964         SAVEI32(PL_debug);
1965         SAVESTACK_POS();
1966         PL_debug = 0;
1967         hasargs = 0;
1968         SPAGAIN;
1969
1970         if (CvISXSUB(cv)) {
1971             PUSHMARK(SP);
1972             (void)(*CvXSUB(cv))(aTHX_ cv);
1973             FREETMPS;
1974             LEAVE;
1975             return NORMAL;
1976         }
1977         else {
1978             PUSHBLOCK(cx, CXt_SUB, SP);
1979             PUSHSUB_DB(cx);
1980             cx->blk_sub.retop = PL_op->op_next;
1981             CvDEPTH(cv)++;
1982             if (CvDEPTH(cv) >= 2) {
1983                 PERL_STACK_OVERFLOW_CHECK();
1984                 pad_push(CvPADLIST(cv), CvDEPTH(cv));
1985             }
1986             SAVECOMPPAD();
1987             PAD_SET_CUR_NOSAVE(CvPADLIST(cv), CvDEPTH(cv));
1988             RETURNOP(CvSTART(cv));
1989         }
1990     }
1991     else
1992         return NORMAL;
1993 }
1994
1995 /* S_leave_common: Common code that many functions in this file use on
1996                    scope exit.  */
1997
1998 /* SVs on the stack that have any of the flags passed in are left as is.
1999    Other SVs are protected via the mortals stack if lvalue is true, and
2000    copied otherwise.
2001
2002    Also, taintedness is cleared.
2003 */
2004
2005 STATIC SV **
2006 S_leave_common(pTHX_ SV **newsp, SV **sp, SV **mark, I32 gimme,
2007                               U32 flags, bool lvalue)
2008 {
2009     bool padtmp = 0;
2010     PERL_ARGS_ASSERT_LEAVE_COMMON;
2011
2012     TAINT_NOT;
2013     if (flags & SVs_PADTMP) {
2014         flags &= ~SVs_PADTMP;
2015         padtmp = 1;
2016     }
2017     if (gimme == G_SCALAR) {
2018         if (MARK < SP)
2019             *++newsp = ((SvFLAGS(*SP) & flags) || (padtmp && SvPADTMP(*SP)))
2020                             ? *SP
2021                             : lvalue
2022                                 ? sv_2mortal(SvREFCNT_inc_simple_NN(*SP))
2023                                 : sv_mortalcopy(*SP);
2024         else {
2025             /* MEXTEND() only updates MARK, so reuse it instead of newsp. */
2026             MARK = newsp;
2027             MEXTEND(MARK, 1);
2028             *++MARK = &PL_sv_undef;
2029             return MARK;
2030         }
2031     }
2032     else if (gimme == G_ARRAY) {
2033         /* in case LEAVE wipes old return values */
2034         while (++MARK <= SP) {
2035             if ((SvFLAGS(*MARK) & flags) || (padtmp && SvPADTMP(*MARK)))
2036                 *++newsp = *MARK;
2037             else {
2038                 *++newsp = lvalue
2039                             ? sv_2mortal(SvREFCNT_inc_simple_NN(*MARK))
2040                             : sv_mortalcopy(*MARK);
2041                 TAINT_NOT;      /* Each item is independent */
2042             }
2043         }
2044         /* When this function was called with MARK == newsp, we reach this
2045          * point with SP == newsp. */
2046     }
2047
2048     return newsp;
2049 }
2050
2051 PP(pp_enter)
2052 {
2053     dSP;
2054     PERL_CONTEXT *cx;
2055     I32 gimme = GIMME_V;
2056
2057     ENTER_with_name("block");
2058
2059     SAVETMPS;
2060     PUSHBLOCK(cx, CXt_BLOCK, SP);
2061
2062     RETURN;
2063 }
2064
2065 PP(pp_leave)
2066 {
2067     dSP;
2068     PERL_CONTEXT *cx;
2069     SV **newsp;
2070     PMOP *newpm;
2071     I32 gimme;
2072
2073     if (PL_op->op_flags & OPf_SPECIAL) {
2074         cx = &cxstack[cxstack_ix];
2075         cx->blk_oldpm = PL_curpm;       /* fake block should preserve $1 et al */
2076     }
2077
2078     POPBLOCK(cx,newpm);
2079
2080     gimme = OP_GIMME(PL_op, (cxstack_ix >= 0) ? gimme : G_SCALAR);
2081
2082     SP = leave_common(newsp, SP, newsp, gimme, SVs_PADTMP|SVs_TEMP,
2083                                PL_op->op_private & OPpLVALUE);
2084     PL_curpm = newpm;   /* Don't pop $1 et al till now */
2085
2086     LEAVE_with_name("block");
2087
2088     RETURN;
2089 }
2090
2091 PP(pp_enteriter)
2092 {
2093     dSP; dMARK;
2094     PERL_CONTEXT *cx;
2095     const I32 gimme = GIMME_V;
2096     void *itervar; /* location of the iteration variable */
2097     U8 cxtype = CXt_LOOP_FOR;
2098
2099     ENTER_with_name("loop1");
2100     SAVETMPS;
2101
2102     if (PL_op->op_targ) {                        /* "my" variable */
2103         if (PL_op->op_private & OPpLVAL_INTRO) {        /* for my $x (...) */
2104             SvPADSTALE_off(PAD_SVl(PL_op->op_targ));
2105             SAVESETSVFLAGS(PAD_SVl(PL_op->op_targ),
2106                     SVs_PADSTALE, SVs_PADSTALE);
2107         }
2108         SAVEPADSVANDMORTALIZE(PL_op->op_targ);
2109 #ifdef USE_ITHREADS
2110         itervar = PL_comppad;
2111 #else
2112         itervar = &PAD_SVl(PL_op->op_targ);
2113 #endif
2114     }
2115     else if (LIKELY(isGV(TOPs))) {              /* symbol table variable */
2116         GV * const gv = MUTABLE_GV(POPs);
2117         SV** svp = &GvSV(gv);
2118         save_pushptrptr(gv, SvREFCNT_inc(*svp), SAVEt_GVSV);
2119         *svp = newSV(0);
2120         itervar = (void *)gv;
2121         save_aliased_sv(gv);
2122     }
2123     else {
2124         SV * const sv = POPs;
2125         assert(SvTYPE(sv) == SVt_PVMG);
2126         assert(SvMAGIC(sv));
2127         assert(SvMAGIC(sv)->mg_type == PERL_MAGIC_lvref);
2128         itervar = (void *)sv;
2129         cxtype |= CXp_FOR_LVREF;
2130     }
2131
2132     if (PL_op->op_private & OPpITER_DEF)
2133         cxtype |= CXp_FOR_DEF;
2134
2135     ENTER_with_name("loop2");
2136
2137     PUSHBLOCK(cx, cxtype, SP);
2138     PUSHLOOP_FOR(cx, itervar, MARK);
2139     if (PL_op->op_flags & OPf_STACKED) {
2140         SV *maybe_ary = POPs;
2141         if (SvTYPE(maybe_ary) != SVt_PVAV) {
2142             dPOPss;
2143             SV * const right = maybe_ary;
2144             if (UNLIKELY(cxtype & CXp_FOR_LVREF))
2145                 DIE(aTHX_ "Assigned value is not a reference");
2146             SvGETMAGIC(sv);
2147             SvGETMAGIC(right);
2148             if (RANGE_IS_NUMERIC(sv,right)) {
2149                 NV nv;
2150                 cx->cx_type &= ~CXTYPEMASK;
2151                 cx->cx_type |= CXt_LOOP_LAZYIV;
2152                 /* Make sure that no-one re-orders cop.h and breaks our
2153                    assumptions */
2154                 assert(CxTYPE(cx) == CXt_LOOP_LAZYIV);
2155 #ifdef NV_PRESERVES_UV
2156                 if ((SvOK(sv) && (((nv = SvNV_nomg(sv)) < (NV)IV_MIN) ||
2157                                   (nv > (NV)IV_MAX)))
2158                         ||
2159                     (SvOK(right) && (((nv = SvNV_nomg(right)) > (NV)IV_MAX) ||
2160                                      (nv < (NV)IV_MIN))))
2161 #else
2162                 if ((SvOK(sv) && (((nv = SvNV_nomg(sv)) <= (NV)IV_MIN)
2163                                   ||
2164                                   ((nv > 0) &&
2165                                         ((nv > (NV)UV_MAX) ||
2166                                          (SvUV_nomg(sv) > (UV)IV_MAX)))))
2167                         ||
2168                     (SvOK(right) && (((nv = SvNV_nomg(right)) <= (NV)IV_MIN)
2169                                      ||
2170                                      ((nv > 0) &&
2171                                         ((nv > (NV)UV_MAX) ||
2172                                          (SvUV_nomg(right) > (UV)IV_MAX))
2173                                      ))))
2174 #endif
2175                     DIE(aTHX_ "Range iterator outside integer range");
2176                 cx->blk_loop.state_u.lazyiv.cur = SvIV_nomg(sv);
2177                 cx->blk_loop.state_u.lazyiv.end = SvIV_nomg(right);
2178 #ifdef DEBUGGING
2179                 /* for correct -Dstv display */
2180                 cx->blk_oldsp = sp - PL_stack_base;
2181 #endif
2182             }
2183             else {
2184                 cx->cx_type &= ~CXTYPEMASK;
2185                 cx->cx_type |= CXt_LOOP_LAZYSV;
2186                 /* Make sure that no-one re-orders cop.h and breaks our
2187                    assumptions */
2188                 assert(CxTYPE(cx) == CXt_LOOP_LAZYSV);
2189                 cx->blk_loop.state_u.lazysv.cur = newSVsv(sv);
2190                 cx->blk_loop.state_u.lazysv.end = right;
2191                 SvREFCNT_inc(right);
2192                 (void) SvPV_force_nolen(cx->blk_loop.state_u.lazysv.cur);
2193                 /* This will do the upgrade to SVt_PV, and warn if the value
2194                    is uninitialised.  */
2195                 (void) SvPV_nolen_const(right);
2196                 /* Doing this avoids a check every time in pp_iter in pp_hot.c
2197                    to replace !SvOK() with a pointer to "".  */
2198                 if (!SvOK(right)) {
2199                     SvREFCNT_dec(right);
2200                     cx->blk_loop.state_u.lazysv.end = &PL_sv_no;
2201                 }
2202             }
2203         }
2204         else /* SvTYPE(maybe_ary) == SVt_PVAV */ {
2205             cx->blk_loop.state_u.ary.ary = MUTABLE_AV(maybe_ary);
2206             SvREFCNT_inc(maybe_ary);
2207             cx->blk_loop.state_u.ary.ix =
2208                 (PL_op->op_private & OPpITER_REVERSED) ?
2209                 AvFILL(cx->blk_loop.state_u.ary.ary) + 1 :
2210                 -1;
2211         }
2212     }
2213     else { /* iterating over items on the stack */
2214         cx->blk_loop.state_u.ary.ary = NULL; /* means to use the stack */
2215         if (PL_op->op_private & OPpITER_REVERSED) {
2216             cx->blk_loop.state_u.ary.ix = cx->blk_oldsp + 1;
2217         }
2218         else {
2219             cx->blk_loop.state_u.ary.ix = MARK - PL_stack_base;
2220         }
2221     }
2222
2223     RETURN;
2224 }
2225
2226 PP(pp_enterloop)
2227 {
2228     dSP;
2229     PERL_CONTEXT *cx;
2230     const I32 gimme = GIMME_V;
2231
2232     ENTER_with_name("loop1");
2233     SAVETMPS;
2234     ENTER_with_name("loop2");
2235
2236     PUSHBLOCK(cx, CXt_LOOP_PLAIN, SP);
2237     PUSHLOOP_PLAIN(cx, SP);
2238
2239     RETURN;
2240 }
2241
2242 PP(pp_leaveloop)
2243 {
2244     dSP;
2245     PERL_CONTEXT *cx;
2246     I32 gimme;
2247     SV **newsp;
2248     PMOP *newpm;
2249     SV **mark;
2250
2251     POPBLOCK(cx,newpm);
2252     assert(CxTYPE_is_LOOP(cx));
2253     mark = newsp;
2254     newsp = PL_stack_base + cx->blk_loop.resetsp;
2255
2256     SP = leave_common(newsp, SP, MARK, gimme, 0,
2257                                PL_op->op_private & OPpLVALUE);
2258     PUTBACK;
2259
2260     POPLOOP(cx);        /* Stack values are safe: release loop vars ... */
2261     PL_curpm = newpm;   /* ... and pop $1 et al */
2262
2263     LEAVE_with_name("loop2");
2264     LEAVE_with_name("loop1");
2265
2266     return NORMAL;
2267 }
2268
2269 STATIC void
2270 S_return_lvalues(pTHX_ SV **mark, SV **sp, SV **newsp, I32 gimme,
2271                        PERL_CONTEXT *cx, PMOP *newpm)
2272 {
2273     const bool ref = !!(CxLVAL(cx) & OPpENTERSUB_INARGS);
2274     if (gimme == G_SCALAR) {
2275         if (CxLVAL(cx) && !ref) {     /* Leave it as it is if we can. */
2276             SV *sv;
2277             const char *what = NULL;
2278             if (MARK < SP) {
2279                 assert(MARK+1 == SP);
2280                 if ((SvPADTMP(TOPs) || SvREADONLY(TOPs)) &&
2281                     !SvSMAGICAL(TOPs)) {
2282                     what =
2283                         SvREADONLY(TOPs) ? (TOPs == &PL_sv_undef) ? "undef"
2284                         : "a readonly value" : "a temporary";
2285                 }
2286                 else goto copy_sv;
2287             }
2288             else {
2289                 /* sub:lvalue{} will take us here. */
2290                 what = "undef";
2291             }
2292             LEAVE;
2293             cxstack_ix--;
2294             POPSUB(cx,sv);
2295             PL_curpm = newpm;
2296             LEAVESUB(sv);
2297             Perl_croak(aTHX_
2298                       "Can't return %s from lvalue subroutine", what
2299             );
2300         }
2301         if (MARK < SP) {
2302               copy_sv:
2303                 if (cx->blk_sub.cv && CvDEPTH(cx->blk_sub.cv) > 1) {
2304                     if (!SvPADTMP(*SP)) {
2305                         *++newsp = SvREFCNT_inc(*SP);
2306                         FREETMPS;
2307                         sv_2mortal(*newsp);
2308                     }
2309                     else {
2310                         /* FREETMPS could clobber it */
2311                         SV *sv = SvREFCNT_inc(*SP);
2312                         FREETMPS;
2313                         *++newsp = sv_mortalcopy(sv);
2314                         SvREFCNT_dec(sv);
2315                     }
2316                 }
2317                 else
2318                     *++newsp =
2319                       SvPADTMP(*SP)
2320                        ? sv_mortalcopy(*SP)
2321                        : !SvTEMP(*SP)
2322                           ? sv_2mortal(SvREFCNT_inc_simple_NN(*SP))
2323                           : *SP;
2324         }
2325         else {
2326             EXTEND(newsp,1);
2327             *++newsp = &PL_sv_undef;
2328         }
2329         if (CxLVAL(cx) & OPpDEREF) {
2330             SvGETMAGIC(TOPs);
2331             if (!SvOK(TOPs)) {
2332                 TOPs = vivify_ref(TOPs, CxLVAL(cx) & OPpDEREF);
2333             }
2334         }
2335     }
2336     else if (gimme == G_ARRAY) {
2337         assert (!(CxLVAL(cx) & OPpDEREF));
2338         if (ref || !CxLVAL(cx))
2339             while (++MARK <= SP)
2340                 *++newsp =
2341                        SvFLAGS(*MARK) & SVs_PADTMP
2342                            ? sv_mortalcopy(*MARK)
2343                      : SvTEMP(*MARK)
2344                            ? *MARK
2345                            : sv_2mortal(SvREFCNT_inc_simple_NN(*MARK));
2346         else while (++MARK <= SP) {
2347             if (*MARK != &PL_sv_undef
2348                     && (SvPADTMP(*MARK) || SvREADONLY(*MARK))
2349             ) {
2350                     const bool ro = cBOOL( SvREADONLY(*MARK) );
2351                     SV *sv;
2352                     /* Might be flattened array after $#array =  */
2353                     PUTBACK;
2354                     LEAVE;
2355                     cxstack_ix--;
2356                     POPSUB(cx,sv);
2357                     PL_curpm = newpm;
2358                     LEAVESUB(sv);
2359                /* diag_listed_as: Can't return %s from lvalue subroutine */
2360                     Perl_croak(aTHX_
2361                         "Can't return a %s from lvalue subroutine",
2362                          ro ? "readonly value" : "temporary");
2363             }
2364             else
2365                 *++newsp =
2366                     SvTEMP(*MARK)
2367                        ? *MARK
2368                        : sv_2mortal(SvREFCNT_inc_simple_NN(*MARK));
2369         }
2370     }
2371     PL_stack_sp = newsp;
2372 }
2373
2374 PP(pp_return)
2375 {
2376     dSP; dMARK;
2377     PERL_CONTEXT *cx;
2378     bool popsub2 = FALSE;
2379     bool clear_errsv = FALSE;
2380     bool lval = FALSE;
2381     I32 gimme;
2382     SV **newsp;
2383     PMOP *newpm;
2384     I32 optype = 0;
2385     SV *namesv;
2386     SV *sv;
2387     OP *retop = NULL;
2388
2389     const I32 cxix = dopoptosub(cxstack_ix);
2390
2391     if (cxix < 0) {
2392         if (CxMULTICALL(cxstack)) { /* In this case we must be in a
2393                                      * sort block, which is a CXt_NULL
2394                                      * not a CXt_SUB */
2395             dounwind(0);
2396             PL_stack_base[1] = *PL_stack_sp;
2397             PL_stack_sp = PL_stack_base + 1;
2398             return 0;
2399         }
2400         else
2401             DIE(aTHX_ "Can't return outside a subroutine");
2402     }
2403     if (cxix < cxstack_ix)
2404         dounwind(cxix);
2405
2406     if (CxMULTICALL(&cxstack[cxix])) {
2407         gimme = cxstack[cxix].blk_gimme;
2408         if (gimme == G_VOID)
2409             PL_stack_sp = PL_stack_base;
2410         else if (gimme == G_SCALAR) {
2411             PL_stack_base[1] = *PL_stack_sp;
2412             PL_stack_sp = PL_stack_base + 1;
2413         }
2414         return 0;
2415     }
2416
2417     POPBLOCK(cx,newpm);
2418     switch (CxTYPE(cx)) {
2419     case CXt_SUB:
2420         popsub2 = TRUE;
2421         lval = !!CvLVALUE(cx->blk_sub.cv);
2422         retop = cx->blk_sub.retop;
2423         cxstack_ix++; /* preserve cx entry on stack for use by POPSUB */
2424         break;
2425     case CXt_EVAL:
2426         if (!(PL_in_eval & EVAL_KEEPERR))
2427             clear_errsv = TRUE;
2428         POPEVAL(cx);
2429         namesv = cx->blk_eval.old_namesv;
2430         retop = cx->blk_eval.retop;
2431         if (CxTRYBLOCK(cx))
2432             break;
2433         if (optype == OP_REQUIRE &&
2434             (MARK == SP || (gimme == G_SCALAR && !SvTRUE(*SP))) )
2435         {
2436             /* Unassume the success we assumed earlier. */
2437             (void)hv_delete(GvHVn(PL_incgv),
2438                             SvPVX_const(namesv),
2439                             SvUTF8(namesv) ? -(I32)SvCUR(namesv) : (I32)SvCUR(namesv),
2440                             G_DISCARD);
2441             DIE(aTHX_ "%"SVf" did not return a true value", SVfARG(namesv));
2442         }
2443         break;
2444     case CXt_FORMAT:
2445         retop = cx->blk_sub.retop;
2446         POPFORMAT(cx);
2447         break;
2448     default:
2449         DIE(aTHX_ "panic: return, type=%u", (unsigned) CxTYPE(cx));
2450     }
2451
2452     TAINT_NOT;
2453     if (lval) S_return_lvalues(aTHX_ MARK, SP, newsp, gimme, cx, newpm);
2454     else {
2455       if (gimme == G_SCALAR) {
2456         if (MARK < SP) {
2457             if (popsub2) {
2458                 if (cx->blk_sub.cv && CvDEPTH(cx->blk_sub.cv) > 1) {
2459                     if (SvTEMP(TOPs) && SvREFCNT(TOPs) == 1
2460                          && !SvMAGICAL(TOPs)) {
2461                         *++newsp = SvREFCNT_inc(*SP);
2462                         FREETMPS;
2463                         sv_2mortal(*newsp);
2464                     }
2465                     else {
2466                         sv = SvREFCNT_inc(*SP); /* FREETMPS could clobber it */
2467                         FREETMPS;
2468                         *++newsp = sv_mortalcopy(sv);
2469                         SvREFCNT_dec(sv);
2470                     }
2471                 }
2472                 else if (SvTEMP(*SP) && SvREFCNT(*SP) == 1
2473                           && !SvMAGICAL(*SP)) {
2474                     *++newsp = *SP;
2475                 }
2476                 else
2477                     *++newsp = sv_mortalcopy(*SP);
2478             }
2479             else
2480                 *++newsp = sv_mortalcopy(*SP);
2481         }
2482         else
2483             *++newsp = &PL_sv_undef;
2484       }
2485       else if (gimme == G_ARRAY) {
2486         while (++MARK <= SP) {
2487             *++newsp = popsub2 && SvTEMP(*MARK) && SvREFCNT(*MARK) == 1
2488                                && !SvGMAGICAL(*MARK)
2489                         ? *MARK : sv_mortalcopy(*MARK);
2490             TAINT_NOT;          /* Each item is independent */
2491         }
2492       }
2493       PL_stack_sp = newsp;
2494     }
2495
2496     LEAVE;
2497     /* Stack values are safe: */
2498     if (popsub2) {
2499         cxstack_ix--;
2500         POPSUB(cx,sv);  /* release CV and @_ ... */
2501     }
2502     else
2503         sv = NULL;
2504     PL_curpm = newpm;   /* ... and pop $1 et al */
2505
2506     LEAVESUB(sv);
2507     if (clear_errsv) {
2508         CLEAR_ERRSV();
2509     }
2510     return retop;
2511 }
2512
2513 /* This duplicates parts of pp_leavesub, so that it can share code with
2514  * pp_return */
2515 PP(pp_leavesublv)
2516 {
2517     dSP;
2518     SV **newsp;
2519     PMOP *newpm;
2520     I32 gimme;
2521     PERL_CONTEXT *cx;
2522     SV *sv;
2523
2524     if (CxMULTICALL(&cxstack[cxstack_ix]))
2525         return 0;
2526
2527     POPBLOCK(cx,newpm);
2528     cxstack_ix++; /* temporarily protect top context */
2529
2530     TAINT_NOT;
2531
2532     S_return_lvalues(aTHX_ newsp, SP, newsp, gimme, cx, newpm);
2533
2534     LEAVE;
2535     POPSUB(cx,sv);      /* Stack values are safe: release CV and @_ ... */
2536     cxstack_ix--;
2537     PL_curpm = newpm;   /* ... and pop $1 et al */
2538
2539     LEAVESUB(sv);
2540     return cx->blk_sub.retop;
2541 }
2542
2543 static I32
2544 S_unwind_loop(pTHX_ const char * const opname)
2545 {
2546     I32 cxix;
2547     if (PL_op->op_flags & OPf_SPECIAL) {
2548         cxix = dopoptoloop(cxstack_ix);
2549         if (cxix < 0)
2550             /* diag_listed_as: Can't "last" outside a loop block */
2551             Perl_croak(aTHX_ "Can't \"%s\" outside a loop block", opname);
2552     }
2553     else {
2554         dSP;
2555         STRLEN label_len;
2556         const char * const label =
2557             PL_op->op_flags & OPf_STACKED
2558                 ? SvPV(TOPs,label_len)
2559                 : (label_len = strlen(cPVOP->op_pv), cPVOP->op_pv);
2560         const U32 label_flags =
2561             PL_op->op_flags & OPf_STACKED
2562                 ? SvUTF8(POPs)
2563                 : (cPVOP->op_private & OPpPV_IS_UTF8) ? SVf_UTF8 : 0;
2564         PUTBACK;
2565         cxix = dopoptolabel(label, label_len, label_flags);
2566         if (cxix < 0)
2567             /* diag_listed_as: Label not found for "last %s" */
2568             Perl_croak(aTHX_ "Label not found for \"%s %"SVf"\"",
2569                                        opname,
2570                                        SVfARG(PL_op->op_flags & OPf_STACKED
2571                                               && !SvGMAGICAL(TOPp1s)
2572                                               ? TOPp1s
2573                                               : newSVpvn_flags(label,
2574                                                     label_len,
2575                                                     label_flags | SVs_TEMP)));
2576     }
2577     if (cxix < cxstack_ix)
2578         dounwind(cxix);
2579     return cxix;
2580 }
2581
2582 PP(pp_last)
2583 {
2584     PERL_CONTEXT *cx;
2585     I32 pop2 = 0;
2586     I32 gimme;
2587     I32 optype;
2588     OP *nextop = NULL;
2589     SV **newsp;
2590     PMOP *newpm;
2591     SV *sv = NULL;
2592
2593     S_unwind_loop(aTHX_ "last");
2594
2595     POPBLOCK(cx,newpm);
2596     cxstack_ix++; /* temporarily protect top context */
2597     switch (CxTYPE(cx)) {
2598     case CXt_LOOP_LAZYIV:
2599     case CXt_LOOP_LAZYSV:
2600     case CXt_LOOP_FOR:
2601     case CXt_LOOP_PLAIN:
2602         pop2 = CxTYPE(cx);
2603         newsp = PL_stack_base + cx->blk_loop.resetsp;
2604         nextop = cx->blk_loop.my_op->op_lastop->op_next;
2605         break;
2606     case CXt_SUB:
2607         pop2 = CXt_SUB;
2608         nextop = cx->blk_sub.retop;
2609         break;
2610     case CXt_EVAL:
2611         POPEVAL(cx);
2612         nextop = cx->blk_eval.retop;
2613         break;
2614     case CXt_FORMAT:
2615         POPFORMAT(cx);
2616         nextop = cx->blk_sub.retop;
2617         break;
2618     default:
2619         DIE(aTHX_ "panic: last, type=%u", (unsigned) CxTYPE(cx));
2620     }
2621
2622     TAINT_NOT;
2623     PL_stack_sp = newsp;
2624
2625     LEAVE;
2626     cxstack_ix--;
2627     /* Stack values are safe: */
2628     switch (pop2) {
2629     case CXt_LOOP_LAZYIV:
2630     case CXt_LOOP_PLAIN:
2631     case CXt_LOOP_LAZYSV:
2632     case CXt_LOOP_FOR:
2633         POPLOOP(cx);    /* release loop vars ... */
2634         LEAVE;
2635         break;
2636     case CXt_SUB:
2637         POPSUB(cx,sv);  /* release CV and @_ ... */
2638         break;
2639     }
2640     PL_curpm = newpm;   /* ... and pop $1 et al */
2641
2642     LEAVESUB(sv);
2643     PERL_UNUSED_VAR(optype);
2644     PERL_UNUSED_VAR(gimme);
2645     return nextop;
2646 }
2647
2648 PP(pp_next)
2649 {
2650     PERL_CONTEXT *cx;
2651     const I32 inner = PL_scopestack_ix;
2652
2653     S_unwind_loop(aTHX_ "next");
2654
2655     /* clear off anything above the scope we're re-entering, but
2656      * save the rest until after a possible continue block */
2657     TOPBLOCK(cx);
2658     if (PL_scopestack_ix < inner)
2659         leave_scope(PL_scopestack[PL_scopestack_ix]);
2660     PL_curcop = cx->blk_oldcop;
2661     PERL_ASYNC_CHECK();
2662     return (cx)->blk_loop.my_op->op_nextop;
2663 }
2664
2665 PP(pp_redo)
2666 {
2667     const I32 cxix = S_unwind_loop(aTHX_ "redo");
2668     PERL_CONTEXT *cx;
2669     I32 oldsave;
2670     OP* redo_op = cxstack[cxix].blk_loop.my_op->op_redoop;
2671
2672     if (redo_op->op_type == OP_ENTER) {
2673         /* pop one less context to avoid $x being freed in while (my $x..) */
2674         cxstack_ix++;
2675         assert(CxTYPE(&cxstack[cxstack_ix]) == CXt_BLOCK);
2676         redo_op = redo_op->op_next;
2677     }
2678
2679     TOPBLOCK(cx);
2680     oldsave = PL_scopestack[PL_scopestack_ix - 1];
2681     LEAVE_SCOPE(oldsave);
2682     FREETMPS;
2683     PL_curcop = cx->blk_oldcop;
2684     PERL_ASYNC_CHECK();
2685     return redo_op;
2686 }
2687
2688 STATIC OP *
2689 S_dofindlabel(pTHX_ OP *o, const char *label, STRLEN len, U32 flags, OP **opstack, OP **oplimit)
2690 {
2691     OP **ops = opstack;
2692     static const char* const too_deep = "Target of goto is too deeply nested";
2693
2694     PERL_ARGS_ASSERT_DOFINDLABEL;
2695
2696     if (ops >= oplimit)
2697         Perl_croak(aTHX_ "%s", too_deep);
2698     if (o->op_type == OP_LEAVE ||
2699         o->op_type == OP_SCOPE ||
2700         o->op_type == OP_LEAVELOOP ||
2701         o->op_type == OP_LEAVESUB ||
2702         o->op_type == OP_LEAVETRY)
2703     {
2704         *ops++ = cUNOPo->op_first;
2705         if (ops >= oplimit)
2706             Perl_croak(aTHX_ "%s", too_deep);
2707     }
2708     *ops = 0;
2709     if (o->op_flags & OPf_KIDS) {
2710         OP *kid;
2711         /* First try all the kids at this level, since that's likeliest. */
2712         for (kid = cUNOPo->op_first; kid; kid = OP_SIBLING(kid)) {
2713             if (kid->op_type == OP_NEXTSTATE || kid->op_type == OP_DBSTATE) {
2714                 STRLEN kid_label_len;
2715                 U32 kid_label_flags;
2716                 const char *kid_label = CopLABEL_len_flags(kCOP,
2717                                                     &kid_label_len, &kid_label_flags);
2718                 if (kid_label && (
2719                     ( (kid_label_flags & SVf_UTF8) != (flags & SVf_UTF8) ) ?
2720                         (flags & SVf_UTF8)
2721                             ? (bytes_cmp_utf8(
2722                                         (const U8*)kid_label, kid_label_len,
2723                                         (const U8*)label, len) == 0)
2724                             : (bytes_cmp_utf8(
2725                                         (const U8*)label, len,
2726                                         (const U8*)kid_label, kid_label_len) == 0)
2727                     : ( len == kid_label_len && ((kid_label == label)
2728                                     || memEQ(kid_label, label, len)))))
2729                     return kid;
2730             }
2731         }
2732         for (kid = cUNOPo->op_first; kid; kid = OP_SIBLING(kid)) {
2733             if (kid == PL_lastgotoprobe)
2734                 continue;
2735             if (kid->op_type == OP_NEXTSTATE || kid->op_type == OP_DBSTATE) {
2736                 if (ops == opstack)
2737                     *ops++ = kid;
2738                 else if (ops[-1]->op_type == OP_NEXTSTATE ||
2739                          ops[-1]->op_type == OP_DBSTATE)
2740                     ops[-1] = kid;
2741                 else
2742                     *ops++ = kid;
2743             }
2744             if ((o = dofindlabel(kid, label, len, flags, ops, oplimit)))
2745                 return o;
2746         }
2747     }
2748     *ops = 0;
2749     return 0;
2750 }
2751
2752
2753 /* also used for: pp_dump() */
2754
2755 PP(pp_goto)
2756 {
2757     dVAR; dSP;
2758     OP *retop = NULL;
2759     I32 ix;
2760     PERL_CONTEXT *cx;
2761 #define GOTO_DEPTH 64
2762     OP *enterops[GOTO_DEPTH];
2763     const char *label = NULL;
2764     STRLEN label_len = 0;
2765     U32 label_flags = 0;
2766     const bool do_dump = (PL_op->op_type == OP_DUMP);
2767     static const char* const must_have_label = "goto must have label";
2768
2769     if (PL_op->op_flags & OPf_STACKED) {
2770         /* goto EXPR  or  goto &foo */
2771
2772         SV * const sv = POPs;
2773         SvGETMAGIC(sv);
2774
2775         /* This egregious kludge implements goto &subroutine */
2776         if (SvROK(sv) && SvTYPE(SvRV(sv)) == SVt_PVCV) {
2777             I32 cxix;
2778             PERL_CONTEXT *cx;
2779             CV *cv = MUTABLE_CV(SvRV(sv));
2780             AV *arg = GvAV(PL_defgv);
2781             I32 oldsave;
2782
2783         retry:
2784             if (!CvROOT(cv) && !CvXSUB(cv)) {
2785                 const GV * const gv = CvGV(cv);
2786                 if (gv) {
2787                     GV *autogv;
2788                     SV *tmpstr;
2789                     /* autoloaded stub? */
2790                     if (cv != GvCV(gv) && (cv = GvCV(gv)))
2791                         goto retry;
2792                     autogv = gv_autoload_pvn(GvSTASH(gv), GvNAME(gv),
2793                                           GvNAMELEN(gv),
2794                                           GvNAMEUTF8(gv) ? SVf_UTF8 : 0);
2795                     if (autogv && (cv = GvCV(autogv)))
2796                         goto retry;
2797                     tmpstr = sv_newmortal();
2798                     gv_efullname3(tmpstr, gv, NULL);
2799                     DIE(aTHX_ "Goto undefined subroutine &%"SVf"", SVfARG(tmpstr));
2800                 }
2801                 DIE(aTHX_ "Goto undefined subroutine");
2802             }
2803
2804             /* First do some returnish stuff. */
2805             SvREFCNT_inc_simple_void(cv); /* avoid premature free during unwind */
2806             FREETMPS;
2807             cxix = dopoptosub(cxstack_ix);
2808             if (cxix < cxstack_ix) {
2809                 if (cxix < 0) {
2810                     SvREFCNT_dec(cv);
2811                     DIE(aTHX_ "Can't goto subroutine outside a subroutine");
2812                 }
2813                 dounwind(cxix);
2814             }
2815             TOPBLOCK(cx);
2816             SPAGAIN;
2817             /* ban goto in eval: see <20050521150056.GC20213@iabyn.com> */
2818             if (CxTYPE(cx) == CXt_EVAL) {
2819                 SvREFCNT_dec(cv);
2820                 if (CxREALEVAL(cx))
2821                 /* diag_listed_as: Can't goto subroutine from an eval-%s */
2822                     DIE(aTHX_ "Can't goto subroutine from an eval-string");
2823                 else
2824                 /* diag_listed_as: Can't goto subroutine from an eval-%s */
2825                     DIE(aTHX_ "Can't goto subroutine from an eval-block");
2826             }
2827             else if (CxMULTICALL(cx))
2828             {
2829                 SvREFCNT_dec(cv);
2830                 DIE(aTHX_ "Can't goto subroutine from a sort sub (or similar callback)");
2831             }
2832             if (CxTYPE(cx) == CXt_SUB && CxHASARGS(cx)) {
2833                 AV* av = cx->blk_sub.argarray;
2834
2835                 /* abandon the original @_ if it got reified or if it is
2836                    the same as the current @_ */
2837                 if (AvREAL(av) || av == arg) {
2838                     SvREFCNT_dec(av);
2839                     av = newAV();
2840                     AvREIFY_only(av);
2841                     PAD_SVl(0) = MUTABLE_SV(cx->blk_sub.argarray = av);
2842                 }
2843                 else CLEAR_ARGARRAY(av);
2844             }
2845             /* We donate this refcount later to the callee’s pad. */
2846             SvREFCNT_inc_simple_void(arg);
2847             if (CxTYPE(cx) == CXt_SUB &&
2848                 !(CvDEPTH(cx->blk_sub.cv) = cx->blk_sub.olddepth))
2849                 SvREFCNT_dec(cx->blk_sub.cv);
2850             oldsave = PL_scopestack[PL_scopestack_ix - 1];
2851             LEAVE_SCOPE(oldsave);
2852
2853             /* A destructor called during LEAVE_SCOPE could have undefined
2854              * our precious cv.  See bug #99850. */
2855             if (!CvROOT(cv) && !CvXSUB(cv)) {
2856                 const GV * const gv = CvGV(cv);
2857                 SvREFCNT_dec(arg);
2858                 if (gv) {
2859                     SV * const tmpstr = sv_newmortal();
2860                     gv_efullname3(tmpstr, gv, NULL);
2861                     DIE(aTHX_ "Goto undefined subroutine &%"SVf"",
2862                                SVfARG(tmpstr));
2863                 }
2864                 DIE(aTHX_ "Goto undefined subroutine");
2865             }
2866
2867             /* Now do some callish stuff. */
2868             SAVETMPS;
2869             SAVEFREESV(cv); /* later, undo the 'avoid premature free' hack */
2870             if (CvISXSUB(cv)) {
2871                 SV **newsp;
2872                 I32 gimme;
2873                 const SSize_t items = arg ? AvFILL(arg) + 1 : 0;
2874                 const bool m = arg ? cBOOL(SvRMAGICAL(arg)) : 0;
2875                 SV** mark;
2876
2877                 PERL_UNUSED_VAR(newsp);
2878                 PERL_UNUSED_VAR(gimme);
2879
2880                 /* put GvAV(defgv) back onto stack */
2881                 if (items) {
2882                     EXTEND(SP, items+1); /* @_ could have been extended. */
2883                 }
2884                 mark = SP;
2885                 if (items) {
2886                     SSize_t index;
2887                     bool r = cBOOL(AvREAL(arg));
2888                     for (index=0; index<items; index++)
2889                     {
2890                         SV *sv;
2891                         if (m) {
2892                             SV ** const svp = av_fetch(arg, index, 0);
2893                             sv = svp ? *svp : NULL;
2894                         }
2895                         else sv = AvARRAY(arg)[index];
2896                         SP[index+1] = sv
2897                             ? r ? SvREFCNT_inc_NN(sv_2mortal(sv)) : sv
2898                             : sv_2mortal(newSVavdefelem(arg, index, 1));
2899                     }
2900                 }
2901                 SP += items;
2902                 SvREFCNT_dec(arg);
2903                 if (CxTYPE(cx) == CXt_SUB && CxHASARGS(cx)) {
2904                     /* Restore old @_ */
2905                     arg = GvAV(PL_defgv);
2906                     GvAV(PL_defgv) = cx->blk_sub.savearray;
2907                     SvREFCNT_dec(arg);
2908                 }
2909
2910                 retop = cx->blk_sub.retop;
2911                 /* XS subs don't have a CxSUB, so pop it */
2912                 POPBLOCK(cx, PL_curpm);
2913                 /* Push a mark for the start of arglist */
2914                 PUSHMARK(mark);
2915                 PUTBACK;
2916                 (void)(*CvXSUB(cv))(aTHX_ cv);
2917                 LEAVE;
2918                 goto _return;
2919             }
2920             else {
2921                 PADLIST * const padlist = CvPADLIST(cv);
2922                 cx->blk_sub.cv = cv;
2923                 cx->blk_sub.olddepth = CvDEPTH(cv);
2924
2925                 CvDEPTH(cv)++;
2926                 if (CvDEPTH(cv) < 2)
2927                     SvREFCNT_inc_simple_void_NN(cv);
2928                 else {
2929                     if (CvDEPTH(cv) == PERL_SUB_DEPTH_WARN && ckWARN(WARN_RECURSION))
2930                         sub_crush_depth(cv);
2931                     pad_push(padlist, CvDEPTH(cv));
2932                 }
2933                 PL_curcop = cx->blk_oldcop;
2934                 SAVECOMPPAD();
2935                 PAD_SET_CUR_NOSAVE(padlist, CvDEPTH(cv));
2936                 if (CxHASARGS(cx))
2937                 {
2938                     CX_CURPAD_SAVE(cx->blk_sub);
2939
2940                     /* cx->blk_sub.argarray has no reference count, so we
2941                        need something to hang on to our argument array so
2942                        that cx->blk_sub.argarray does not end up pointing
2943                        to freed memory as the result of undef *_.  So put
2944                        it in the callee’s pad, donating our refer-
2945                        ence count. */
2946                     if (arg) {
2947                         SvREFCNT_dec(PAD_SVl(0));
2948                         PAD_SVl(0) = (SV *)(cx->blk_sub.argarray = arg);
2949                     }
2950
2951                     /* GvAV(PL_defgv) might have been modified on scope
2952                        exit, so restore it. */
2953                     if (arg != GvAV(PL_defgv)) {
2954                         AV * const av = GvAV(PL_defgv);
2955                         GvAV(PL_defgv) = (AV *)SvREFCNT_inc_simple(arg);
2956                         SvREFCNT_dec(av);
2957                     }
2958                 }
2959                 else SvREFCNT_dec(arg);
2960                 if (PERLDB_SUB) {       /* Checking curstash breaks DProf. */
2961                     Perl_get_db_sub(aTHX_ NULL, cv);
2962                     if (PERLDB_GOTO) {
2963                         CV * const gotocv = get_cvs("DB::goto", 0);
2964                         if (gotocv) {
2965                             PUSHMARK( PL_stack_sp );
2966                             call_sv(MUTABLE_SV(gotocv), G_SCALAR | G_NODEBUG);
2967                             PL_stack_sp--;
2968                         }
2969                     }
2970                 }
2971                 retop = CvSTART(cv);
2972                 goto putback_return;
2973             }
2974         }
2975         else {
2976             /* goto EXPR */
2977             label       = SvPV_nomg_const(sv, label_len);
2978             label_flags = SvUTF8(sv);
2979         }
2980     }
2981     else if (!(PL_op->op_flags & OPf_SPECIAL)) {
2982         /* goto LABEL  or  dump LABEL */
2983         label       = cPVOP->op_pv;
2984         label_flags = (cPVOP->op_private & OPpPV_IS_UTF8) ? SVf_UTF8 : 0;
2985         label_len   = strlen(label);
2986     }
2987     if (!(do_dump || label_len)) DIE(aTHX_ "%s", must_have_label);
2988
2989     PERL_ASYNC_CHECK();
2990
2991     if (label_len) {
2992         OP *gotoprobe = NULL;
2993         bool leaving_eval = FALSE;
2994         bool in_block = FALSE;
2995         PERL_CONTEXT *last_eval_cx = NULL;
2996
2997         /* find label */
2998
2999         PL_lastgotoprobe = NULL;
3000         *enterops = 0;
3001         for (ix = cxstack_ix; ix >= 0; ix--) {
3002             cx = &cxstack[ix];
3003             switch (CxTYPE(cx)) {
3004             case CXt_EVAL:
3005                 leaving_eval = TRUE;
3006                 if (!CxTRYBLOCK(cx)) {
3007                     gotoprobe = (last_eval_cx ?
3008                                 last_eval_cx->blk_eval.old_eval_root :
3009                                 PL_eval_root);
3010                     last_eval_cx = cx;
3011                     break;
3012                 }
3013                 /* else fall through */
3014             case CXt_LOOP_LAZYIV:
3015             case CXt_LOOP_LAZYSV:
3016             case CXt_LOOP_FOR:
3017             case CXt_LOOP_PLAIN:
3018             case CXt_GIVEN:
3019             case CXt_WHEN:
3020                 gotoprobe = OP_SIBLING(cx->blk_oldcop);
3021                 break;
3022             case CXt_SUBST:
3023                 continue;
3024             case CXt_BLOCK:
3025                 if (ix) {
3026                     gotoprobe = OP_SIBLING(cx->blk_oldcop);
3027                     in_block = TRUE;
3028                 } else
3029                     gotoprobe = PL_main_root;
3030                 break;
3031             case CXt_SUB:
3032                 if (CvDEPTH(cx->blk_sub.cv) && !CxMULTICALL(cx)) {
3033                     gotoprobe = CvROOT(cx->blk_sub.cv);
3034                     break;
3035                 }
3036                 /* FALLTHROUGH */
3037             case CXt_FORMAT:
3038             case CXt_NULL:
3039                 DIE(aTHX_ "Can't \"goto\" out of a pseudo block");
3040             default:
3041                 if (ix)
3042                     DIE(aTHX_ "panic: goto, type=%u, ix=%ld",
3043                         CxTYPE(cx), (long) ix);
3044                 gotoprobe = PL_main_root;
3045                 break;
3046             }
3047             if (gotoprobe) {
3048                 OP *sibl1, *sibl2;
3049
3050                 retop = dofindlabel(gotoprobe, label, label_len, label_flags,
3051                                     enterops, enterops + GOTO_DEPTH);
3052                 if (retop)
3053                     break;
3054                 if ( (sibl1 = OP_SIBLING(gotoprobe)) &&
3055                      sibl1->op_type == OP_UNSTACK &&
3056                      (sibl2 = OP_SIBLING(sibl1)))
3057                 {
3058                     retop = dofindlabel(sibl2,
3059                                         label, label_len, label_flags, enterops,
3060                                         enterops + GOTO_DEPTH);
3061                     if (retop)
3062                         break;
3063                 }
3064             }
3065             PL_lastgotoprobe = gotoprobe;
3066         }
3067         if (!retop)
3068             DIE(aTHX_ "Can't find label %"UTF8f, 
3069                        UTF8fARG(label_flags, label_len, label));
3070
3071         /* if we're leaving an eval, check before we pop any frames
3072            that we're not going to punt, otherwise the error
3073            won't be caught */
3074
3075         if (leaving_eval && *enterops && enterops[1]) {
3076             I32 i;
3077             for (i = 1; enterops[i]; i++)
3078                 if (enterops[i]->op_type == OP_ENTERITER)
3079                     DIE(aTHX_ "Can't \"goto\" into the middle of a foreach loop");
3080         }
3081
3082         if (*enterops && enterops[1]) {
3083             I32 i = enterops[1]->op_type == OP_ENTER && in_block ? 2 : 1;
3084             if (enterops[i])
3085                 deprecate("\"goto\" to jump into a construct");
3086         }
3087
3088         /* pop unwanted frames */
3089
3090         if (ix < cxstack_ix) {
3091             I32 oldsave;
3092
3093             if (ix < 0)
3094                 DIE(aTHX_ "panic: docatch: illegal ix=%ld", (long)ix);
3095             dounwind(ix);
3096             TOPBLOCK(cx);
3097             oldsave = PL_scopestack[PL_scopestack_ix];
3098             LEAVE_SCOPE(oldsave);
3099         }
3100
3101         /* push wanted frames */
3102
3103         if (*enterops && enterops[1]) {
3104             OP * const oldop = PL_op;
3105             ix = enterops[1]->op_type == OP_ENTER && in_block ? 2 : 1;
3106             for (; enterops[ix]; ix++) {
3107                 PL_op = enterops[ix];
3108                 /* Eventually we may want to stack the needed arguments
3109                  * for each op.  For now, we punt on the hard ones. */
3110                 if (PL_op->op_type == OP_ENTERITER)
3111                     DIE(aTHX_ "Can't \"goto\" into the middle of a foreach loop");
3112                 PL_op->op_ppaddr(aTHX);
3113             }
3114             PL_op = oldop;
3115         }
3116     }
3117
3118     else {
3119         assert(do_dump);
3120 #ifdef VMS
3121         if (!retop) retop = PL_main_start;
3122 #endif
3123         PL_restartop = retop;
3124         PL_do_undump = TRUE;
3125
3126         my_unexec();
3127
3128         PL_restartop = 0;               /* hmm, must be GNU unexec().. */
3129         PL_do_undump = FALSE;
3130     }
3131
3132     putback_return:
3133     PL_stack_sp = sp;
3134     _return:
3135     PERL_ASYNC_CHECK();
3136     return retop;
3137 }
3138
3139 PP(pp_exit)
3140 {
3141     dSP;
3142     I32 anum;
3143
3144     if (MAXARG < 1)
3145         anum = 0;
3146     else if (!TOPs) {
3147         anum = 0; (void)POPs;
3148     }
3149     else {
3150         anum = SvIVx(POPs);
3151 #ifdef VMS
3152         if (anum == 1
3153          && SvTRUE(cop_hints_fetch_pvs(PL_curcop, "vmsish_exit", 0)))
3154             anum = 0;
3155         VMSISH_HUSHED  =
3156             VMSISH_HUSHED || (PL_curcop->op_private & OPpHUSH_VMSISH);
3157 #endif
3158     }
3159     PL_exit_flags |= PERL_EXIT_EXPECTED;
3160     my_exit(anum);
3161     PUSHs(&PL_sv_undef);
3162     RETURN;
3163 }
3164
3165 /* Eval. */
3166
3167 STATIC void
3168 S_save_lines(pTHX_ AV *array, SV *sv)
3169 {
3170     const char *s = SvPVX_const(sv);
3171     const char * const send = SvPVX_const(sv) + SvCUR(sv);
3172     I32 line = 1;
3173
3174     PERL_ARGS_ASSERT_SAVE_LINES;
3175
3176     while (s && s < send) {
3177         const char *t;
3178         SV * const tmpstr = newSV_type(SVt_PVMG);
3179
3180         t = (const char *)memchr(s, '\n', send - s);
3181         if (t)
3182             t++;
3183         else
3184             t = send;
3185
3186         sv_setpvn(tmpstr, s, t - s);
3187         av_store(array, line++, tmpstr);
3188         s = t;
3189     }
3190 }
3191
3192 /*
3193 =for apidoc docatch
3194
3195 Check for the cases 0 or 3 of cur_env.je_ret, only used inside an eval context.
3196
3197 0 is used as continue inside eval,
3198
3199 3 is used for a die caught by an inner eval - continue inner loop
3200
3201 See cop.h: je_mustcatch, when set at any runlevel to TRUE, means eval ops must
3202 establish a local jmpenv to handle exception traps.
3203
3204 =cut
3205 */
3206 STATIC OP *
3207 S_docatch(pTHX_ OP *o)
3208 {
3209     int ret;
3210     OP * const oldop = PL_op;
3211     dJMPENV;
3212
3213 #ifdef DEBUGGING
3214     assert(CATCH_GET == TRUE);
3215 #endif
3216     PL_op = o;
3217
3218     JMPENV_PUSH(ret);
3219     switch (ret) {
3220     case 0:
3221         assert(cxstack_ix >= 0);
3222         assert(CxTYPE(&cxstack[cxstack_ix]) == CXt_EVAL);
3223         cxstack[cxstack_ix].blk_eval.cur_top_env = PL_top_env;
3224  redo_body:
3225         CALLRUNOPS(aTHX);
3226         break;
3227     case 3:
3228         /* die caught by an inner eval - continue inner loop */
3229         if (PL_restartop && PL_restartjmpenv == PL_top_env) {
3230             PL_restartjmpenv = NULL;
3231             PL_op = PL_restartop;
3232             PL_restartop = 0;
3233             goto redo_body;
3234         }
3235         /* FALLTHROUGH */
3236     default:
3237         JMPENV_POP;
3238         PL_op = oldop;
3239         JMPENV_JUMP(ret);
3240         NOT_REACHED; /* NOTREACHED */
3241     }
3242     JMPENV_POP;
3243     PL_op = oldop;
3244     return NULL;
3245 }
3246
3247
3248 /*
3249 =for apidoc find_runcv
3250
3251 Locate the CV corresponding to the currently executing sub or eval.
3252 If db_seqp is non_null, skip CVs that are in the DB package and populate
3253 *db_seqp with the cop sequence number at the point that the DB:: code was
3254 entered.  (This allows debuggers to eval in the scope of the breakpoint
3255 rather than in the scope of the debugger itself.)
3256
3257 =cut
3258 */
3259
3260 CV*
3261 Perl_find_runcv(pTHX_ U32 *db_seqp)
3262 {
3263     return Perl_find_runcv_where(aTHX_ 0, 0, db_seqp);
3264 }
3265
3266 /* If this becomes part of the API, it might need a better name. */
3267 CV *
3268 Perl_find_runcv_where(pTHX_ U8 cond, IV arg, U32 *db_seqp)
3269 {
3270     PERL_SI      *si;
3271     int          level = 0;
3272
3273     if (db_seqp)
3274         *db_seqp =
3275             PL_curcop == &PL_compiling
3276                 ? PL_cop_seqmax
3277                 : PL_curcop->cop_seq;
3278
3279     for (si = PL_curstackinfo; si; si = si->si_prev) {
3280         I32 ix;
3281         for (ix = si->si_cxix; ix >= 0; ix--) {
3282             const PERL_CONTEXT *cx = &(si->si_cxstack[ix]);
3283             CV *cv = NULL;
3284             if (CxTYPE(cx) == CXt_SUB || CxTYPE(cx) == CXt_FORMAT) {
3285                 cv = cx->blk_sub.cv;
3286                 /* skip DB:: code */
3287                 if (db_seqp && PL_debstash && CvSTASH(cv) == PL_debstash) {
3288                     *db_seqp = cx->blk_oldcop->cop_seq;
3289                     continue;
3290                 }
3291                 if (cx->cx_type & CXp_SUB_RE)
3292                     continue;
3293             }
3294             else if (CxTYPE(cx) == CXt_EVAL && !CxTRYBLOCK(cx))
3295                 cv = cx->blk_eval.cv;
3296             if (cv) {
3297                 switch (cond) {
3298                 case FIND_RUNCV_padid_eq:
3299                     if (!CvPADLIST(cv)
3300                      || CvPADLIST(cv)->xpadl_id != (U32)arg)
3301                         continue;
3302                     return cv;
3303                 case FIND_RUNCV_level_eq:
3304                     if (level++ != arg) continue;
3305                     /* GERONIMO! */
3306                 default:
3307                     return cv;
3308                 }
3309             }
3310         }
3311     }
3312     return cond == FIND_RUNCV_padid_eq ? NULL : PL_main_cv;
3313 }
3314
3315
3316 /* Run yyparse() in a setjmp wrapper. Returns:
3317  *   0: yyparse() successful
3318  *   1: yyparse() failed
3319  *   3: yyparse() died
3320  */
3321 STATIC int
3322 S_try_yyparse(pTHX_ int gramtype)
3323 {
3324     int ret;
3325     dJMPENV;
3326
3327     assert(CxTYPE(&cxstack[cxstack_ix]) == CXt_EVAL);
3328     JMPENV_PUSH(ret);
3329     switch (ret) {
3330     case 0:
3331         ret = yyparse(gramtype) ? 1 : 0;
3332         break;
3333     case 3:
3334         break;
3335     default:
3336         JMPENV_POP;
3337         JMPENV_JUMP(ret);
3338         NOT_REACHED; /* NOTREACHED */
3339     }
3340     JMPENV_POP;
3341     return ret;
3342 }
3343
3344
3345 /* Compile a require/do or an eval ''.
3346  *
3347  * outside is the lexically enclosing CV (if any) that invoked us.
3348  * seq     is the current COP scope value.
3349  * hh      is the saved hints hash, if any.
3350  *
3351  * Returns a bool indicating whether the compile was successful; if so,
3352  * PL_eval_start contains the first op of the compiled code; otherwise,
3353  * pushes undef.
3354  *
3355  * This function is called from two places: pp_require and pp_entereval.
3356  * These can be distinguished by whether PL_op is entereval.
3357  */
3358
3359 STATIC bool
3360 S_doeval(pTHX_ int gimme, CV* outside, U32 seq, HV *hh)
3361 {
3362     dSP;
3363     OP * const saveop = PL_op;
3364     bool clear_hints = saveop->op_type != OP_ENTEREVAL;
3365     COP * const oldcurcop = PL_curcop;
3366     bool in_require = (saveop->op_type == OP_REQUIRE);
3367     int yystatus;
3368     CV *evalcv;
3369
3370     PL_in_eval = (in_require
3371                   ? (EVAL_INREQUIRE | (PL_in_eval & EVAL_INEVAL))
3372                   : (EVAL_INEVAL |
3373                         ((PL_op->op_private & OPpEVAL_RE_REPARSING)
3374                             ? EVAL_RE_REPARSING : 0)));
3375
3376     PUSHMARK(SP);
3377
3378     evalcv = MUTABLE_CV(newSV_type(SVt_PVCV));
3379     CvEVAL_on(evalcv);
3380     assert(CxTYPE(&cxstack[cxstack_ix]) == CXt_EVAL);
3381     cxstack[cxstack_ix].blk_eval.cv = evalcv;
3382     cxstack[cxstack_ix].blk_gimme = gimme;
3383
3384     CvOUTSIDE_SEQ(evalcv) = seq;
3385     CvOUTSIDE(evalcv) = MUTABLE_CV(SvREFCNT_inc_simple(outside));
3386
3387     /* set up a scratch pad */
3388
3389     CvPADLIST_set(evalcv, pad_new(padnew_SAVE));
3390     PL_op = NULL; /* avoid PL_op and PL_curpad referring to different CVs */
3391
3392
3393     SAVEMORTALIZESV(evalcv);    /* must remain until end of current statement */
3394
3395     /* make sure we compile in the right package */
3396
3397     if (CopSTASH_ne(PL_curcop, PL_curstash)) {
3398         SAVEGENERICSV(PL_curstash);
3399         PL_curstash = (HV *)CopSTASH(PL_curcop);
3400         if (SvTYPE(PL_curstash) != SVt_PVHV) PL_curstash = NULL;
3401         else SvREFCNT_inc_simple_void(PL_curstash);
3402     }
3403     /* XXX:ajgo do we really need to alloc an AV for begin/checkunit */
3404     SAVESPTR(PL_beginav);
3405     PL_beginav = newAV();
3406     SAVEFREESV(PL_beginav);
3407     SAVESPTR(PL_unitcheckav);
3408     PL_unitcheckav = newAV();
3409     SAVEFREESV(PL_unitcheckav);
3410
3411
3412     ENTER_with_name("evalcomp");
3413     SAVESPTR(PL_compcv);
3414     PL_compcv = evalcv;
3415
3416     /* try to compile it */
3417
3418     PL_eval_root = NULL;
3419     PL_curcop = &PL_compiling;
3420     if ((saveop->op_type != OP_REQUIRE) && (saveop->op_flags & OPf_SPECIAL))
3421         PL_in_eval |= EVAL_KEEPERR;
3422     else
3423         CLEAR_ERRSV();
3424
3425     SAVEHINTS();
3426     if (clear_hints) {
3427         PL_hints = 0;
3428         hv_clear(GvHV(PL_hintgv));
3429     }
3430     else {
3431         PL_hints = saveop->op_private & OPpEVAL_COPHH
3432                      ? oldcurcop->cop_hints : saveop->op_targ;
3433
3434         /* making 'use re eval' not be in scope when compiling the
3435          * qr/mabye_has_runtime_code_block/ ensures that we don't get
3436          * infinite recursion when S_has_runtime_code() gives a false
3437          * positive: the second time round, HINT_RE_EVAL isn't set so we
3438          * don't bother calling S_has_runtime_code() */
3439         if (PL_in_eval & EVAL_RE_REPARSING)
3440             PL_hints &= ~HINT_RE_EVAL;
3441
3442         if (hh) {
3443             /* SAVEHINTS created a new HV in PL_hintgv, which we need to GC */
3444             SvREFCNT_dec(GvHV(PL_hintgv));
3445             GvHV(PL_hintgv) = hh;
3446         }
3447     }
3448     SAVECOMPILEWARNINGS();
3449     if (clear_hints) {
3450         if (PL_dowarn & G_WARN_ALL_ON)
3451             PL_compiling.cop_warnings = pWARN_ALL ;
3452         else if (PL_dowarn & G_WARN_ALL_OFF)
3453             PL_compiling.cop_warnings = pWARN_NONE ;
3454         else
3455             PL_compiling.cop_warnings = pWARN_STD ;
3456     }
3457     else {
3458         PL_compiling.cop_warnings =
3459             DUP_WARNINGS(oldcurcop->cop_warnings);
3460         cophh_free(CopHINTHASH_get(&PL_compiling));
3461         if (Perl_cop_fetch_label(aTHX_ oldcurcop, NULL, NULL)) {
3462             /* The label, if present, is the first entry on the chain. So rather
3463                than writing a blank label in front of it (which involves an
3464                allocation), just use the next entry in the chain.  */
3465             PL_compiling.cop_hints_hash
3466                 = cophh_copy(oldcurcop->cop_hints_hash->refcounted_he_next);
3467             /* Check the assumption that this removed the label.  */
3468             assert(Perl_cop_fetch_label(aTHX_ &PL_compiling, NULL, NULL) == NULL);
3469         }
3470         else
3471             PL_compiling.cop_hints_hash = cophh_copy(oldcurcop->cop_hints_hash);
3472     }
3473
3474     CALL_BLOCK_HOOKS(bhk_eval, saveop);
3475
3476     /* note that yyparse() may raise an exception, e.g. C<BEGIN{die}>,
3477      * so honour CATCH_GET and trap it here if necessary */
3478
3479     yystatus = (!in_require && CATCH_GET) ? S_try_yyparse(aTHX_ GRAMPROG) : yyparse(GRAMPROG);
3480
3481     if (yystatus || PL_parser->error_count || !PL_eval_root) {
3482         SV **newsp;                     /* Used by POPBLOCK. */
3483         PERL_CONTEXT *cx;
3484         I32 optype;                     /* Used by POPEVAL. */
3485         SV *namesv;
3486         SV *errsv = NULL;
3487
3488         cx = NULL;
3489         namesv = NULL;
3490         PERL_UNUSED_VAR(newsp);
3491         PERL_UNUSED_VAR(optype);
3492
3493         /* note that if yystatus == 3, then the EVAL CX block has already
3494          * been popped, and various vars restored */
3495         PL_op = saveop;
3496         if (yystatus != 3) {
3497             if (PL_eval_root) {
3498                 op_free(PL_eval_root);
3499                 PL_eval_root = NULL;
3500             }
3501             SP = PL_stack_base + POPMARK;       /* pop original mark */
3502             POPBLOCK(cx,PL_curpm);
3503             POPEVAL(cx);
3504             namesv = cx->blk_eval.old_namesv;
3505             /* POPBLOCK renders LEAVE_with_name("evalcomp") unnecessary. */
3506             LEAVE_with_name("eval"); /* pp_entereval knows about this LEAVE.  */
3507         }
3508
3509         errsv = ERRSV;
3510         if (in_require) {
3511             if (!cx) {
3512                 /* If cx is still NULL, it means that we didn't go in the
3513                  * POPEVAL branch. */
3514                 cx = &cxstack[cxstack_ix];
3515                 assert(CxTYPE(cx) == CXt_EVAL);
3516                 namesv = cx->blk_eval.old_namesv;
3517             }
3518             (void)hv_store(GvHVn(PL_incgv),
3519                            SvPVX_const(namesv),
3520                            SvUTF8(namesv) ? -(I32)SvCUR(namesv) : (I32)SvCUR(namesv),
3521                            &PL_sv_undef, 0);
3522             Perl_croak(aTHX_ "%"SVf"Compilation failed in require",
3523                        SVfARG(errsv
3524                                 ? errsv
3525                                 : newSVpvs_flags("Unknown error\n", SVs_TEMP)));
3526         }
3527         else {
3528             if (!*(SvPV_nolen_const(errsv))) {
3529                 sv_setpvs(errsv, "Compilation error");
3530             }
3531         }
3532         if (gimme != G_ARRAY) PUSHs(&PL_sv_undef);
3533         PUTBACK;
3534         return FALSE;
3535     }
3536     else
3537         LEAVE_with_name("evalcomp");
3538
3539     CopLINE_set(&PL_compiling, 0);
3540     SAVEFREEOP(PL_eval_root);
3541     cv_forget_slab(evalcv);
3542
3543     DEBUG_x(dump_eval());
3544
3545     /* Register with debugger: */
3546     if (PERLDB_INTER && saveop->op_type == OP_REQUIRE) {
3547         CV * const cv = get_cvs("DB::postponed", 0);
3548         if (cv) {
3549             dSP;
3550             PUSHMARK(SP);
3551             XPUSHs(MUTABLE_SV(CopFILEGV(&PL_compiling)));
3552             PUTBACK;
3553             call_sv(MUTABLE_SV(cv), G_DISCARD);
3554         }
3555     }
3556
3557     if (PL_unitcheckav) {
3558         OP *es = PL_eval_start;
3559         call_list(PL_scopestack_ix, PL_unitcheckav);
3560         PL_eval_start = es;
3561     }
3562
3563     /* compiled okay, so do it */
3564
3565     CvDEPTH(evalcv) = 1;
3566     SP = PL_stack_base + POPMARK;               /* pop original mark */
3567     PL_op = saveop;                     /* The caller may need it. */
3568     PL_parser->lex_state = LEX_NOTPARSING;      /* $^S needs this. */
3569
3570     PUTBACK;
3571     return TRUE;
3572 }
3573
3574 STATIC PerlIO *
3575 S_check_type_and_open(pTHX_ SV *name)
3576 {
3577     Stat_t st;
3578     STRLEN len;
3579     const char *p = SvPV_const(name, len);
3580     int st_rc;
3581
3582     PERL_ARGS_ASSERT_CHECK_TYPE_AND_OPEN;
3583
3584     /* checking here captures a reasonable error message when
3585      * PERL_DISABLE_PMC is true, but when PMC checks are enabled, the
3586      * user gets a confusing message about looking for the .pmc file
3587      * rather than for the .pm file.
3588      * This check prevents a \0 in @INC causing problems.
3589      */
3590     if (!IS_SAFE_PATHNAME(p, len, "require"))
3591         return NULL;
3592
3593     /* we use the value of errno later to see how stat() or open() failed.
3594      * We don't want it set if the stat succeeded but we still failed,
3595      * such as if the name exists, but is a directory */
3596     errno = 0;
3597
3598     st_rc = PerlLIO_stat(p, &st);
3599
3600     if (st_rc < 0 || S_ISDIR(st.st_mode) || S_ISBLK(st.st_mode)) {
3601         return NULL;
3602     }
3603
3604 #if !defined(PERLIO_IS_STDIO)
3605     return PerlIO_openn(aTHX_ ":", PERL_SCRIPT_MODE, -1, 0, 0, NULL, 1, &name);
3606 #else
3607     return PerlIO_open(p, PERL_SCRIPT_MODE);
3608 #endif
3609 }
3610
3611 #ifndef PERL_DISABLE_PMC
3612 STATIC PerlIO *
3613 S_doopen_pm(pTHX_ SV *name)
3614 {
3615     STRLEN namelen;
3616     const char *p = SvPV_const(name, namelen);
3617
3618     PERL_ARGS_ASSERT_DOOPEN_PM;
3619
3620     /* check the name before trying for the .pmc name to avoid the
3621      * warning referring to the .pmc which the user probably doesn't
3622      * know or care about
3623      */
3624     if (!IS_SAFE_PATHNAME(p, namelen, "require"))
3625         return NULL;
3626
3627     if (namelen > 3 && memEQs(p + namelen - 3, 3, ".pm")) {
3628         SV *const pmcsv = sv_newmortal();
3629         Stat_t pmcstat;
3630
3631         SvSetSV_nosteal(pmcsv,name);
3632         sv_catpvs(pmcsv, "c");
3633
3634         if (PerlLIO_stat(SvPV_nolen_const(pmcsv), &pmcstat) >= 0)
3635             return check_type_and_open(pmcsv);
3636     }
3637     return check_type_and_open(name);
3638 }
3639 #else
3640 #  define doopen_pm(name) check_type_and_open(name)
3641 #endif /* !PERL_DISABLE_PMC */
3642
3643 /* require doesn't search for absolute names, or when the name is
3644    explicity relative the current directory */
3645 PERL_STATIC_INLINE bool
3646 S_path_is_searchable(const char *name)
3647 {
3648     PERL_ARGS_ASSERT_PATH_IS_SEARCHABLE;
3649
3650     if (PERL_FILE_IS_ABSOLUTE(name)
3651 #ifdef WIN32
3652         || (*name == '.' && ((name[1] == '/' ||
3653                              (name[1] == '.' && name[2] == '/'))
3654                          || (name[1] == '\\' ||
3655                              ( name[1] == '.' && name[2] == '\\')))
3656             )
3657 #else
3658         || (*name == '.' && (name[1] == '/' ||
3659                              (name[1] == '.' && name[2] == '/')))
3660 #endif
3661          )
3662     {
3663         return FALSE;
3664     }
3665     else
3666         return TRUE;
3667 }
3668
3669
3670 /* also used for: pp_dofile() */
3671
3672 PP(pp_require)
3673 {
3674     dSP;
3675     PERL_CONTEXT *cx;
3676     SV *sv;
3677     const char *name;
3678     STRLEN len;
3679     char * unixname;
3680     STRLEN unixlen;
3681 #ifdef VMS
3682     int vms_unixname = 0;
3683     char *unixdir;
3684 #endif
3685     const char *tryname = NULL;
3686     SV *namesv = NULL;
3687     const I32 gimme = GIMME_V;
3688     int filter_has_file = 0;
3689     PerlIO *tryrsfp = NULL;
3690     SV *filter_cache = NULL;
3691     SV *filter_state = NULL;
3692     SV *filter_sub = NULL;
3693     SV *hook_sv = NULL;
3694     OP *op;
3695     int saved_errno;
3696     bool path_searchable;
3697
3698     sv = POPs;
3699     SvGETMAGIC(sv);
3700     if ( (SvNIOKp(sv) || SvVOK(sv)) && PL_op->op_type != OP_DOFILE) {
3701         sv = sv_2mortal(new_version(sv));
3702         if (!Perl_sv_derived_from_pvn(aTHX_ PL_patchlevel, STR_WITH_LEN("version"), 0))
3703             upg_version(PL_patchlevel, TRUE);
3704         if (cUNOP->op_first->op_type == OP_CONST && cUNOP->op_first->op_private & OPpCONST_NOVER) {
3705             if ( vcmp(sv,PL_patchlevel) <= 0 )
3706                 DIE(aTHX_ "Perls since %"SVf" too modern--this is %"SVf", stopped",
3707                     SVfARG(sv_2mortal(vnormal(sv))),
3708                     SVfARG(sv_2mortal(vnormal(PL_patchlevel)))
3709                 );
3710         }
3711         else {
3712             if ( vcmp(sv,PL_patchlevel) > 0 ) {
3713                 I32 first = 0;
3714                 AV *lav;
3715                 SV * const req = SvRV(sv);
3716                 SV * const pv = *hv_fetchs(MUTABLE_HV(req), "original", FALSE);
3717
3718                 /* get the left hand term */
3719                 lav = MUTABLE_AV(SvRV(*hv_fetchs(MUTABLE_HV(req), "version", FALSE)));
3720
3721                 first  = SvIV(*av_fetch(lav,0,0));
3722                 if (   first > (int)PERL_REVISION    /* probably 'use 6.0' */
3723                     || hv_exists(MUTABLE_HV(req), "qv", 2 ) /* qv style */
3724                     || av_tindex(lav) > 1            /* FP with > 3 digits */
3725                     || strstr(SvPVX(pv),".0")        /* FP with leading 0 */
3726                    ) {
3727                     DIE(aTHX_ "Perl %"SVf" required--this is only "
3728                         "%"SVf", stopped",
3729                         SVfARG(sv_2mortal(vnormal(req))),
3730                         SVfARG(sv_2mortal(vnormal(PL_patchlevel)))
3731                     );
3732                 }
3733                 else { /* probably 'use 5.10' or 'use 5.8' */
3734                     SV *hintsv;
3735                     I32 second = 0;
3736
3737                     if (av_tindex(lav)>=1)
3738                         second = SvIV(*av_fetch(lav,1,0));
3739
3740                     second /= second >= 600  ? 100 : 10;
3741                     hintsv = Perl_newSVpvf(aTHX_ "v%d.%d.0",
3742                                            (int)first, (int)second);
3743                     upg_version(hintsv, TRUE);
3744
3745                     DIE(aTHX_ "Perl %"SVf" required (did you mean %"SVf"?)"
3746                         "--this is only %"SVf", stopped",
3747                         SVfARG(sv_2mortal(vnormal(req))),
3748                         SVfARG(sv_2mortal(vnormal(sv_2mortal(hintsv)))),
3749                         SVfARG(sv_2mortal(vnormal(PL_patchlevel)))
3750                     );
3751                 }
3752             }
3753         }
3754
3755         RETPUSHYES;
3756     }
3757     if (!SvOK(sv))
3758         DIE(aTHX_ "Missing or undefined argument to require");
3759     name = SvPV_nomg_const(sv, len);
3760     if (!(name && len > 0 && *name))
3761         DIE(aTHX_ "Missing or undefined argument to require");
3762
3763     if (!IS_SAFE_PATHNAME(name, len, "require")) {
3764         DIE(aTHX_ "Can't locate %s:   %s",
3765             pv_escape(newSVpvs_flags("",SVs_TEMP),SvPVX(sv),SvCUR(sv),
3766                       SvCUR(sv)*2,NULL, SvUTF8(sv)?PERL_PV_ESCAPE_UNI:0),
3767             Strerror(ENOENT));
3768     }
3769     TAINT_PROPER("require");
3770
3771     path_searchable = path_is_searchable(name);
3772
3773 #ifdef VMS
3774     /* The key in the %ENV hash is in the syntax of file passed as the argument
3775      * usually this is in UNIX format, but sometimes in VMS format, which
3776      * can result in a module being pulled in more than once.
3777      * To prevent this, the key must be stored in UNIX format if the VMS
3778      * name can be translated to UNIX.
3779      */
3780     
3781     if ((unixname =
3782           tounixspec(name, SvPVX(sv_2mortal(newSVpv("", VMS_MAXRSS-1)))))
3783          != NULL) {
3784         unixlen = strlen(unixname);
3785         vms_unixname = 1;
3786     }
3787     else
3788 #endif
3789     {
3790         /* if not VMS or VMS name can not be translated to UNIX, pass it
3791          * through.
3792          */
3793         unixname = (char *) name;
3794         unixlen = len;
3795     }
3796     if (PL_op->op_type == OP_REQUIRE) {
3797         SV * const * const svp = hv_fetch(GvHVn(PL_incgv),
3798                                           unixname, unixlen, 0);
3799         if ( svp ) {
3800             if (*svp != &PL_sv_undef)
3801                 RETPUSHYES;
3802             else
3803                 DIE(aTHX_ "Attempt to reload %s aborted.\n"
3804                             "Compilation failed in require", unixname);
3805         }
3806     }
3807
3808     LOADING_FILE_PROBE(unixname);
3809
3810     /* prepare to compile file */
3811
3812     if (!path_searchable) {
3813         /* At this point, name is SvPVX(sv)  */
3814         tryname = name;
3815         tryrsfp = doopen_pm(sv);
3816     }
3817     if (!tryrsfp && !(errno == EACCES && !path_searchable)) {
3818         AV * const ar = GvAVn(PL_incgv);
3819         SSize_t i;
3820 #ifdef VMS
3821         if (vms_unixname)
3822 #endif
3823         {
3824             SV *nsv = sv;
3825             namesv = newSV_type(SVt_PV);
3826             for (i = 0; i <= AvFILL(ar); i++) {
3827                 SV * const dirsv = *av_fetch(ar, i, TRUE);
3828
3829                 SvGETMAGIC(dirsv);
3830                 if (SvROK(dirsv)) {
3831                     int count;
3832                     SV **svp;
3833                     SV *loader = dirsv;
3834
3835                     if (SvTYPE(SvRV(loader)) == SVt_PVAV
3836                         && !SvOBJECT(SvRV(loader)))
3837                     {
3838                         loader = *av_fetch(MUTABLE_AV(SvRV(loader)), 0, TRUE);
3839                         SvGETMAGIC(loader);
3840                     }
3841
3842                     Perl_sv_setpvf(aTHX_ namesv, "/loader/0x%"UVxf"/%s",
3843                                    PTR2UV(SvRV(dirsv)), name);
3844                     tryname = SvPVX_const(namesv);
3845                     tryrsfp = NULL;
3846
3847                     if (SvPADTMP(nsv)) {
3848                         nsv = sv_newmortal();
3849                         SvSetSV_nosteal(nsv,sv);
3850                     }
3851
3852                     ENTER_with_name("call_INC");
3853                     SAVETMPS;
3854                     EXTEND(SP, 2);
3855
3856                     PUSHMARK(SP);
3857                     PUSHs(dirsv);
3858                     PUSHs(nsv);
3859                     PUTBACK;
3860                     if (SvGMAGICAL(loader)) {
3861                         SV *l = sv_newmortal();
3862                         sv_setsv_nomg(l, loader);
3863                         loader = l;
3864                     }
3865                     if (sv_isobject(loader))
3866                         count = call_method("INC", G_ARRAY);
3867                     else
3868                         count = call_sv(loader, G_ARRAY);
3869                     SPAGAIN;
3870
3871                     if (count > 0) {
3872                         int i = 0;
3873                         SV *arg;
3874
3875                         SP -= count - 1;
3876                         arg = SP[i++];
3877
3878                         if (SvROK(arg) && (SvTYPE(SvRV(arg)) <= SVt_PVLV)
3879                             && !isGV_with_GP(SvRV(arg))) {
3880                             filter_cache = SvRV(arg);
3881
3882                             if (i < count) {
3883                                 arg = SP[i++];
3884                             }
3885                         }
3886
3887                         if (SvROK(arg) && isGV_with_GP(SvRV(arg))) {
3888                             arg = SvRV(arg);
3889                         }
3890
3891                         if (isGV_with_GP(arg)) {
3892                             IO * const io = GvIO((const GV *)arg);
3893
3894                             ++filter_has_file;
3895
3896                             if (io) {
3897                                 tryrsfp = IoIFP(io);
3898                                 if (IoOFP(io) && IoOFP(io) != IoIFP(io)) {
3899                                     PerlIO_close(IoOFP(io));
3900                                 }
3901                                 IoIFP(io) = NULL;
3902                                 IoOFP(io) = NULL;
3903                             }
3904
3905                             if (i < count) {
3906                                 arg = SP[i++];
3907                             }
3908                         }
3909
3910                         if (SvROK(arg) && SvTYPE(SvRV(arg)) == SVt_PVCV) {
3911                             filter_sub = arg;
3912                             SvREFCNT_inc_simple_void_NN(filter_sub);
3913
3914                             if (i < count) {
3915                                 filter_state = SP[i];
3916                                 SvREFCNT_inc_simple_void(filter_state);
3917                             }
3918                         }
3919
3920                         if (!tryrsfp && (filter_cache || filter_sub)) {
3921                             tryrsfp = PerlIO_open(BIT_BUCKET,
3922                                                   PERL_SCRIPT_MODE);
3923                         }
3924                         SP--;
3925                     }
3926
3927                     /* FREETMPS may free our filter_cache */
3928                     SvREFCNT_inc_simple_void(filter_cache);
3929
3930                     PUTBACK;
3931                     FREETMPS;
3932                     LEAVE_with_name("call_INC");
3933
3934                     /* Now re-mortalize it. */
3935                     sv_2mortal(filter_cache);
3936
3937                     /* Adjust file name if the hook has set an %INC entry.
3938                        This needs to happen after the FREETMPS above.  */
3939                     svp = hv_fetch(GvHVn(PL_incgv), name, len, 0);
3940                     if (svp)
3941                         tryname = SvPV_nolen_const(*svp);
3942
3943                     if (tryrsfp) {
3944                         hook_sv = dirsv;
3945                         break;
3946                     }
3947
3948                     filter_has_file = 0;
3949                     filter_cache = NULL;
3950                     if (filter_state) {
3951                         SvREFCNT_dec_NN(filter_state);
3952                         filter_state = NULL;
3953                     }
3954                     if (filter_sub) {
3955                         SvREFCNT_dec_NN(filter_sub);
3956                         filter_sub = NULL;
3957                     }
3958                 }
3959                 else {
3960                   if (path_searchable) {
3961                     const char *dir;
3962                     STRLEN dirlen;
3963
3964                     if (SvOK(dirsv)) {
3965                         dir = SvPV_nomg_const(dirsv, dirlen);
3966                     } else {
3967                         dir = "";
3968                         dirlen = 0;
3969                     }
3970
3971                     if (!IS_SAFE_SYSCALL(dir, dirlen, "@INC entry", "require"))
3972                         continue;
3973 #ifdef VMS
3974                     if ((unixdir =
3975                           tounixpath(dir, SvPVX(sv_2mortal(newSVpv("", VMS_MAXRSS-1)))))
3976                          == NULL)
3977                         continue;
3978                     sv_setpv(namesv, unixdir);
3979                     sv_catpv(namesv, unixname);
3980 #else
3981 #  ifdef __SYMBIAN32__
3982                     if (PL_origfilename[0] &&
3983                         PL_origfilename[1] == ':' &&
3984                         !(dir[0] && dir[1] == ':'))
3985                         Perl_sv_setpvf(aTHX_ namesv,
3986                                        "%c:%s\\%s",
3987                                        PL_origfilename[0],
3988                                        dir, name);
3989                     else
3990                         Perl_sv_setpvf(aTHX_ namesv,
3991                                        "%s\\%s",
3992                                        dir, name);
3993 #  else
3994                     /* The equivalent of                    
3995                        Perl_sv_setpvf(aTHX_ namesv, "%s/%s", dir, name);
3996                        but without the need to parse the format string, or
3997                        call strlen on either pointer, and with the correct
3998                        allocation up front.  */
3999                     {
4000                         char *tmp = SvGROW(namesv, dirlen + len + 2);
4001
4002                         memcpy(tmp, dir, dirlen);
4003                         tmp +=dirlen;
4004
4005                         /* Avoid '<dir>//<file>' */
4006                         if (!dirlen || *(tmp-1) != '/') {
4007                             *tmp++ = '/';
4008                         } else {
4009                             /* So SvCUR_set reports the correct length below */
4010                             dirlen--;
4011                         }
4012
4013                         /* name came from an SV, so it will have a '\0' at the
4014                            end that we can copy as part of this memcpy().  */
4015                         memcpy(tmp, name, len + 1);
4016
4017                         SvCUR_set(namesv, dirlen + len + 1);
4018                         SvPOK_on(namesv);
4019                     }
4020 #  endif
4021 #endif
4022                     TAINT_PROPER("require");
4023                     tryname = SvPVX_const(namesv);
4024                     tryrsfp = doopen_pm(namesv);
4025                     if (tryrsfp) {
4026                         if (tryname[0] == '.' && tryname[1] == '/') {
4027                             ++tryname;
4028                             while (*++tryname == '/') {}
4029                         }
4030                         break;
4031                     }
4032                     else if (errno == EMFILE || errno == EACCES) {
4033                         /* no point in trying other paths if out of handles;
4034                          * on the other hand, if we couldn't open one of the
4035                          * files, then going on with the search could lead to
4036                          * unexpected results; see perl #113422
4037                          */
4038                         break;
4039                     }
4040                   }
4041                 }
4042             }
4043         }
4044     }
4045     saved_errno = errno; /* sv_2mortal can realloc things */
4046     sv_2mortal(namesv);
4047     if (!tryrsfp) {
4048         if (PL_op->op_type == OP_REQUIRE) {
4049             if(saved_errno == EMFILE || saved_errno == EACCES) {
4050                 /* diag_listed_as: Can't locate %s */
4051                 DIE(aTHX_ "Can't locate %s:   %s: %s",
4052                     name, tryname, Strerror(saved_errno));
4053             } else {
4054                 if (namesv) {                   /* did we lookup @INC? */
4055                     AV * const ar = GvAVn(PL_incgv);
4056                     SSize_t i;
4057                     SV *const msg = newSVpvs_flags("", SVs_TEMP);
4058                     SV *const inc = newSVpvs_flags("", SVs_TEMP);
4059                     for (i = 0; i <= AvFILL(ar); i++) {
4060                         sv_catpvs(inc, " ");
4061                         sv_catsv(inc, *av_fetch(ar, i, TRUE));
4062                     }
4063                     if (len >= 4 && memEQ(name + len - 3, ".pm", 4)) {
4064                         const char *c, *e = name + len - 3;
4065                         sv_catpv(msg, " (you may need to install the ");
4066                         for (c = name; c < e; c++) {
4067                             if (*c == '/') {
4068                                 sv_catpvs(msg, "::");
4069                             }
4070                             else {
4071                                 sv_catpvn(msg, c, 1);
4072                             }
4073                         }
4074                         sv_catpv(msg, " module)");
4075                     }
4076                     else if (len >= 2 && memEQ(name + len - 2, ".h", 3)) {
4077                         sv_catpv(msg, " (change .h to .ph maybe?) (did you run h2ph?)");
4078                     }
4079                     else if (len >= 3 && memEQ(name + len - 3, ".ph", 4)) {
4080                         sv_catpv(msg, " (did you run h2ph?)");
4081                     }
4082
4083                     /* diag_listed_as: Can't locate %s */
4084                     DIE(aTHX_
4085                         "Can't locate %s in @INC%" SVf " (@INC contains:%" SVf ")",
4086                         name, msg, inc);
4087                 }
4088             }
4089             DIE(aTHX_ "Can't locate %s", name);
4090         }
4091
4092         CLEAR_ERRSV();
4093         RETPUSHUNDEF;
4094     }
4095     else
4096         SETERRNO(0, SS_NORMAL);
4097
4098     /* Assume success here to prevent recursive requirement. */
4099     /* name is never assigned to again, so len is still strlen(name)  */
4100     /* Check whether a hook in @INC has already filled %INC */
4101     if (!hook_sv) {
4102         (void)hv_store(GvHVn(PL_incgv),
4103                        unixname, unixlen, newSVpv(tryname,0),0);
4104     } else {
4105         SV** const svp = hv_fetch(GvHVn(PL_incgv), unixname, unixlen, 0);
4106         if (!svp)
4107             (void)hv_store(GvHVn(PL_incgv),
4108                            unixname, unixlen, SvREFCNT_inc_simple(hook_sv), 0 );
4109     }
4110
4111     ENTER_with_name("eval");
4112     SAVETMPS;
4113     SAVECOPFILE_FREE(&PL_compiling);
4114     CopFILE_set(&PL_compiling, tryname);
4115     lex_start(NULL, tryrsfp, 0);
4116
4117     if (filter_sub || filter_cache) {
4118         /* We can use the SvPV of the filter PVIO itself as our cache, rather
4119            than hanging another SV from it. In turn, filter_add() optionally
4120            takes the SV to use as the filter (or creates a new SV if passed
4121            NULL), so simply pass in whatever value filter_cache has.  */
4122         SV * const fc = filter_cache ? newSV(0) : NULL;
4123         SV *datasv;
4124         if (fc) sv_copypv(fc, filter_cache);
4125         datasv = filter_add(S_run_user_filter, fc);
4126         IoLINES(datasv) = filter_has_file;
4127         IoTOP_GV(datasv) = MUTABLE_GV(filter_state);
4128         IoBOTTOM_GV(datasv) = MUTABLE_GV(filter_sub);
4129     }
4130
4131     /* switch to eval mode */
4132     PUSHBLOCK(cx, CXt_EVAL, SP);
4133     PUSHEVAL(cx, name);
4134     cx->blk_eval.retop = PL_op->op_next;
4135
4136     SAVECOPLINE(&PL_compiling);
4137     CopLINE_set(&PL_compiling, 0);
4138
4139     PUTBACK;
4140
4141     if (doeval(gimme, NULL, PL_curcop->cop_seq, NULL))
4142         op = DOCATCH(PL_eval_start);
4143     else
4144         op = PL_op->op_next;
4145
4146     LOADED_FILE_PROBE(unixname);
4147
4148     return op;
4149 }
4150
4151 /* This is a op added to hold the hints hash for
4152    pp_entereval. The hash can be modified by the code
4153    being eval'ed, so we return a copy instead. */
4154
4155 PP(pp_hintseval)
4156 {
4157     dSP;
4158     mXPUSHs(MUTABLE_SV(hv_copy_hints_hv(MUTABLE_HV(cSVOP_sv))));
4159     RETURN;
4160 }
4161
4162
4163 PP(pp_entereval)
4164 {
4165     dSP;
4166     PERL_CONTEXT *cx;
4167     SV *sv;
4168     const I32 gimme = GIMME_V;
4169     const U32 was = PL_breakable_sub_gen;
4170     char tbuf[TYPE_DIGITS(long) + 12];
4171     bool saved_delete = FALSE;
4172     char *tmpbuf = tbuf;
4173     STRLEN len;
4174     CV* runcv;
4175     U32 seq, lex_flags = 0;
4176     HV *saved_hh = NULL;
4177     const bool bytes = PL_op->op_private & OPpEVAL_BYTES;
4178
4179     if (PL_op->op_private & OPpEVAL_HAS_HH) {
4180         saved_hh = MUTABLE_HV(SvREFCNT_inc(POPs));
4181     }
4182     else if (PL_hints & HINT_LOCALIZE_HH || (
4183                 PL_op->op_private & OPpEVAL_COPHH
4184              && PL_curcop->cop_hints & HINT_LOCALIZE_HH
4185             )) {
4186         saved_hh = cop_hints_2hv(PL_curcop, 0);
4187         hv_magic(saved_hh, NULL, PERL_MAGIC_hints);
4188     }
4189     sv = POPs;
4190     if (!SvPOK(sv)) {
4191         /* make sure we've got a plain PV (no overload etc) before testing
4192          * for taint. Making a copy here is probably overkill, but better
4193          * safe than sorry */
4194         STRLEN len;
4195         const char * const p = SvPV_const(sv, len);
4196
4197         sv = newSVpvn_flags(p, len, SVs_TEMP | SvUTF8(sv));
4198         lex_flags |= LEX_START_COPIED;
4199
4200         if (bytes && SvUTF8(sv))
4201             SvPVbyte_force(sv, len);
4202     }
4203     else if (bytes && SvUTF8(sv)) {
4204         /* Don't modify someone else's scalar */
4205         STRLEN len;
4206         sv = newSVsv(sv);
4207         (void)sv_2mortal(sv);
4208         SvPVbyte_force(sv,len);
4209         lex_flags |= LEX_START_COPIED;
4210     }
4211
4212     TAINT_IF(SvTAINTED(sv));
4213     TAINT_PROPER("eval");
4214
4215     ENTER_with_name("eval");
4216     lex_start(sv, NULL, lex_flags | (PL_op->op_private & OPpEVAL_UNICODE
4217                            ? LEX_IGNORE_UTF8_HINTS
4218                            : bytes ? LEX_EVALBYTES : LEX_START_SAME_FILTER
4219                         )
4220              );
4221     SAVETMPS;
4222
4223     /* switch to eval mode */
4224
4225     if (PERLDB_NAMEEVAL && CopLINE(PL_curcop)) {
4226         SV * const temp_sv = sv_newmortal();
4227         Perl_sv_setpvf(aTHX_ temp_sv, "_<(eval %lu)[%s:%"IVdf"]",
4228                        (unsigned long)++PL_evalseq,
4229                        CopFILE(PL_curcop), (IV)CopLINE(PL_curcop));
4230         tmpbuf = SvPVX(temp_sv);
4231         len = SvCUR(temp_sv);
4232     }
4233     else
4234         len = my_snprintf(tmpbuf, sizeof(tbuf), "_<(eval %lu)", (unsigned long)++PL_evalseq);
4235     SAVECOPFILE_FREE(&PL_compiling);
4236     CopFILE_set(&PL_compiling, tmpbuf+2);
4237     SAVECOPLINE(&PL_compiling);
4238     CopLINE_set(&PL_compiling, 1);
4239     /* special case: an eval '' executed within the DB package gets lexically
4240      * placed in the first non-DB CV rather than the current CV - this
4241      * allows the debugger to execute code, find lexicals etc, in the
4242      * scope of the code being debugged. Passing &seq gets find_runcv
4243      * to do the dirty work for us */
4244     runcv = find_runcv(&seq);
4245
4246     PUSHBLOCK(cx, (CXt_EVAL|CXp_REAL), SP);
4247     PUSHEVAL(cx, 0);
4248     cx->blk_eval.retop = PL_op->op_next;
4249
4250     /* prepare to compile string */
4251
4252     if ((PERLDB_LINE || PERLDB_SAVESRC) && PL_curstash != PL_debstash)
4253         save_lines(CopFILEAV(&PL_compiling), PL_parser->linestr);
4254     else {
4255         /* XXX For C<eval "...">s within BEGIN {} blocks, this ends up
4256            deleting the eval's FILEGV from the stash before gv_check() runs
4257            (i.e. before run-time proper). To work around the coredump that
4258            ensues, we always turn GvMULTI_on for any globals that were
4259            introduced within evals. See force_ident(). GSAR 96-10-12 */
4260         char *const safestr = savepvn(tmpbuf, len);
4261         SAVEDELETE(PL_defstash, safestr, len);
4262         saved_delete = TRUE;
4263     }
4264     
4265     PUTBACK;
4266
4267     if (doeval(gimme, runcv, seq, saved_hh)) {
4268         if (was != PL_breakable_sub_gen /* Some subs defined here. */
4269             ? (PERLDB_LINE || PERLDB_SAVESRC)
4270             :  PERLDB_SAVESRC_NOSUBS) {
4271             /* Retain the filegv we created.  */
4272         } else if (!saved_delete) {
4273             char *const safestr = savepvn(tmpbuf, len);
4274             SAVEDELETE(PL_defstash, safestr, len);
4275         }
4276         return DOCATCH(PL_eval_start);
4277     } else {
4278         /* We have already left the scope set up earlier thanks to the LEAVE
4279            in doeval().  */
4280         if (was != PL_breakable_sub_gen /* Some subs defined here. */
4281             ? (PERLDB_LINE || PERLDB_SAVESRC)
4282             :  PERLDB_SAVESRC_INVALID) {
4283             /* Retain the filegv we created.  */
4284         } else if (!saved_delete) {
4285             (void)hv_delete(PL_defstash, tmpbuf, len, G_DISCARD);
4286         }
4287         return PL_op->op_next;
4288     }
4289 }
4290
4291 PP(pp_leaveeval)
4292 {
4293     dSP;
4294     SV **newsp;
4295     PMOP *newpm;
4296     I32 gimme;
4297     PERL_CONTEXT *cx;
4298     OP *retop;
4299     const U8 save_flags = PL_op -> op_flags;
4300     I32 optype;
4301     SV *namesv;
4302     CV *evalcv;
4303
4304     PERL_ASYNC_CHECK();
4305     POPBLOCK(cx,newpm);
4306     POPEVAL(cx);
4307     namesv = cx->blk_eval.old_namesv;
4308     retop = cx->blk_eval.retop;
4309     evalcv = cx->blk_eval.cv;
4310
4311     SP = leave_common((gimme == G_VOID) ? SP : newsp, SP, newsp,
4312                                 gimme, SVs_TEMP, FALSE);
4313     PL_curpm = newpm;   /* Don't pop $1 et al till now */
4314
4315 #ifdef DEBUGGING
4316     assert(CvDEPTH(evalcv) == 1);
4317 #endif
4318     CvDEPTH(evalcv) = 0;
4319
4320     if (optype == OP_REQUIRE &&
4321         !(gimme == G_SCALAR ? SvTRUE(*SP) : SP > newsp))
4322     {
4323         /* Unassume the success we assumed earlier. */
4324         (void)hv_delete(GvHVn(PL_incgv),
4325                         SvPVX_const(namesv),
4326                         SvUTF8(namesv) ? -(I32)SvCUR(namesv) : (I32)SvCUR(namesv),
4327                         G_DISCARD);
4328         Perl_die(aTHX_ "%"SVf" did not return a true value", SVfARG(namesv));
4329         NOT_REACHED; /* NOTREACHED */
4330         /* die_unwind() did LEAVE, or we won't be here */
4331     }
4332     else {
4333         LEAVE_with_name("eval");
4334         if (!(save_flags & OPf_SPECIAL)) {
4335             CLEAR_ERRSV();
4336         }
4337     }
4338
4339     RETURNOP(retop);
4340 }
4341
4342 /* Common code for Perl_call_sv and Perl_fold_constants, put here to keep it
4343    close to the related Perl_create_eval_scope.  */
4344 void
4345 Perl_delete_eval_scope(pTHX)
4346 {
4347     SV **newsp;
4348     PMOP *newpm;
4349     I32 gimme;
4350     PERL_CONTEXT *cx;
4351     I32 optype;
4352         
4353     POPBLOCK(cx,newpm);
4354     POPEVAL(cx);
4355     PL_curpm = newpm;
4356     LEAVE_with_name("eval_scope");
4357     PERL_UNUSED_VAR(newsp);
4358     PERL_UNUSED_VAR(gimme);
4359     PERL_UNUSED_VAR(optype);
4360 }
4361
4362 /* Common-ish code salvaged from Perl_call_sv and pp_entertry, because it was
4363    also needed by Perl_fold_constants.  */
4364 PERL_CONTEXT *
4365 Perl_create_eval_scope(pTHX_ U32 flags)
4366 {
4367     PERL_CONTEXT *cx;
4368     const I32 gimme = GIMME_V;
4369         
4370     ENTER_with_name("eval_scope");
4371     SAVETMPS;
4372
4373     PUSHBLOCK(cx, (CXt_EVAL|CXp_TRYBLOCK), PL_stack_sp);
4374     PUSHEVAL(cx, 0);
4375
4376     PL_in_eval = EVAL_INEVAL;
4377     if (flags & G_KEEPERR)
4378         PL_in_eval |= EVAL_KEEPERR;
4379     else
4380         CLEAR_ERRSV();
4381     if (flags & G_FAKINGEVAL) {
4382         PL_eval_root = PL_op; /* Only needed so that goto works right. */
4383     }
4384     return cx;
4385 }
4386     
4387 PP(pp_entertry)
4388 {
4389     PERL_CONTEXT * const cx = create_eval_scope(0);
4390     cx->blk_eval.retop = cLOGOP->op_other->op_next;
4391     return DOCATCH(PL_op->op_next);
4392 }
4393
4394 PP(pp_leavetry)
4395 {
4396     dSP;
4397     SV **newsp;
4398     PMOP *newpm;
4399     I32 gimme;
4400     PERL_CONTEXT *cx;
4401     I32 optype;
4402
4403     PERL_ASYNC_CHECK();
4404     POPBLOCK(cx,newpm);
4405     POPEVAL(cx);
4406     PERL_UNUSED_VAR(optype);
4407
4408     SP = leave_common(newsp, SP, newsp, gimme,
4409                                SVs_PADTMP|SVs_TEMP, FALSE);
4410     PL_curpm = newpm;   /* Don't pop $1 et al till now */
4411
4412     LEAVE_with_name("eval_scope");
4413     CLEAR_ERRSV();
4414     RETURN;
4415 }
4416
4417 PP(pp_entergiven)
4418 {
4419     dSP;
4420     PERL_CONTEXT *cx;
4421     const I32 gimme = GIMME_V;
4422     
4423     ENTER_with_name("given");
4424     SAVETMPS;
4425
4426     if (PL_op->op_targ) {
4427         SAVEPADSVANDMORTALIZE(PL_op->op_targ);
4428         SvREFCNT_dec(PAD_SVl(PL_op->op_targ));
4429         PAD_SVl(PL_op->op_targ) = SvREFCNT_inc_NN(POPs);
4430     }
4431     else {
4432         SAVE_DEFSV;
4433         DEFSV_set(POPs);
4434     }
4435
4436     PUSHBLOCK(cx, CXt_GIVEN, SP);
4437     PUSHGIVEN(cx);
4438
4439     RETURN;
4440 }
4441
4442 PP(pp_leavegiven)
4443 {
4444     dSP;
4445     PERL_CONTEXT *cx;
4446     I32 gimme;
4447     SV **newsp;
4448     PMOP *newpm;
4449     PERL_UNUSED_CONTEXT;
4450
4451     POPBLOCK(cx,newpm);
4452     assert(CxTYPE(cx) == CXt_GIVEN);
4453
4454     SP = leave_common(newsp, SP, newsp, gimme,
4455                                SVs_PADTMP|SVs_TEMP, FALSE);
4456     PL_curpm = newpm;   /* Don't pop $1 et al till now */
4457
4458     LEAVE_with_name("given");
4459     RETURN;
4460 }
4461
4462 /* Helper routines used by pp_smartmatch */
4463 STATIC PMOP *
4464 S_make_matcher(pTHX_ REGEXP *re)
4465 {
4466     PMOP *matcher = (PMOP *) newPMOP(OP_MATCH, OPf_WANT_SCALAR | OPf_STACKED);
4467
4468     PERL_ARGS_ASSERT_MAKE_MATCHER;
4469
4470     PM_SETRE(matcher, ReREFCNT_inc(re));
4471
4472     SAVEFREEOP((OP *) matcher);
4473     ENTER_with_name("matcher"); SAVETMPS;
4474     SAVEOP();
4475     return matcher;
4476 }
4477
4478 STATIC bool
4479 S_matcher_matches_sv(pTHX_ PMOP *matcher, SV *sv)
4480 {
4481     dSP;
4482
4483     PERL_ARGS_ASSERT_MATCHER_MATCHES_SV;
4484     
4485     PL_op = (OP *) matcher;
4486     XPUSHs(sv);
4487     PUTBACK;
4488     (void) Perl_pp_match(aTHX);
4489     SPAGAIN;
4490     return (SvTRUEx(POPs));
4491 }
4492
4493 STATIC void
4494 S_destroy_matcher(pTHX_ PMOP *matcher)
4495 {
4496     PERL_ARGS_ASSERT_DESTROY_MATCHER;
4497     PERL_UNUSED_ARG(matcher);
4498
4499     FREETMPS;
4500     LEAVE_with_name("matcher");
4501 }
4502
4503 /* Do a smart match */
4504 PP(pp_smartmatch)
4505 {
4506     DEBUG_M(Perl_deb(aTHX_ "Starting smart match resolution\n"));
4507     return do_smartmatch(NULL, NULL, 0);
4508 }
4509
4510 /* This version of do_smartmatch() implements the
4511  * table of smart matches that is found in perlsyn.
4512  */
4513 STATIC OP *
4514 S_do_smartmatch(pTHX_ HV *seen_this, HV *seen_other, const bool copied)
4515 {
4516     dSP;
4517     
4518     bool object_on_left = FALSE;
4519     SV *e = TOPs;       /* e is for 'expression' */
4520     SV *d = TOPm1s;     /* d is for 'default', as in PL_defgv */
4521
4522     /* Take care only to invoke mg_get() once for each argument.
4523      * Currently we do this by copying the SV if it's magical. */
4524     if (d) {
4525         if (!copied && SvGMAGICAL(d))
4526             d = sv_mortalcopy(d);
4527     }
4528     else
4529         d = &PL_sv_undef;
4530
4531     assert(e);
4532     if (SvGMAGICAL(e))
4533         e = sv_mortalcopy(e);
4534
4535     /* First of all, handle overload magic of the rightmost argument */
4536     if (SvAMAGIC(e)) {
4537         SV * tmpsv;
4538         DEBUG_M(Perl_deb(aTHX_ "    applying rule Any-Object\n"));
4539         DEBUG_M(Perl_deb(aTHX_ "        attempting overload\n"));
4540
4541         tmpsv = amagic_call(d, e, smart_amg, AMGf_noleft);
4542         if (tmpsv) {
4543             SPAGAIN;
4544             (void)POPs;
4545             SETs(tmpsv);
4546             RETURN;
4547         }
4548         DEBUG_M(Perl_deb(aTHX_ "        failed to run overload method; continuing...\n"));
4549     }
4550
4551     SP -= 2;    /* Pop the values */
4552
4553
4554     /* ~~ undef */
4555     if (!SvOK(e)) {
4556         DEBUG_M(Perl_deb(aTHX_ "    applying rule Any-undef\n"));
4557         if (SvOK(d))
4558             RETPUSHNO;
4559         else
4560             RETPUSHYES;
4561     }
4562
4563     if (sv_isobject(e) && (SvTYPE(SvRV(e)) != SVt_REGEXP)) {
4564         DEBUG_M(Perl_deb(aTHX_ "    applying rule Any-Object\n"));
4565         Perl_croak(aTHX_ "Smart matching a non-overloaded object breaks encapsulation");
4566     }
4567     if (sv_isobject(d) && (SvTYPE(SvRV(d)) != SVt_REGEXP))
4568         object_on_left = TRUE;
4569
4570     /* ~~ sub */
4571     if (SvROK(e) && SvTYPE(SvRV(e)) == SVt_PVCV) {
4572         I32 c;
4573         if (object_on_left) {
4574             goto sm_any_sub; /* Treat objects like scalars */
4575         }
4576         else if (SvROK(d) && SvTYPE(SvRV(d)) == SVt_PVHV) {
4577             /* Test sub truth for each key */
4578             HE *he;
4579             bool andedresults = TRUE;
4580             HV *hv = (HV*) SvRV(d);
4581             I32 numkeys = hv_iterinit(hv);
4582             DEBUG_M(Perl_deb(aTHX_ "    applying rule Hash-CodeRef\n"));
4583             if (numkeys == 0)
4584                 RETPUSHYES;
4585             while ( (he = hv_iternext(hv)) ) {
4586                 DEBUG_M(Perl_deb(aTHX_ "        testing hash key...\n"));
4587                 ENTER_with_name("smartmatch_hash_key_test");
4588                 SAVETMPS;
4589                 PUSHMARK(SP);
4590                 PUSHs(hv_iterkeysv(he));
4591                 PUTBACK;
4592                 c = call_sv(e, G_SCALAR);
4593                 SPAGAIN;
4594                 if (c == 0)
4595                     andedresults = FALSE;
4596                 else
4597                     andedresults = SvTRUEx(POPs) && andedresults;
4598                 FREETMPS;
4599                 LEAVE_with_name("smartmatch_hash_key_test");
4600             }
4601             if (andedresults)
4602                 RETPUSHYES;
4603             else
4604                 RETPUSHNO;
4605         }
4606         else if (SvROK(d) && SvTYPE(SvRV(d)) == SVt_PVAV) {
4607             /* Test sub truth for each element */
4608             SSize_t i;
4609             bool andedresults = TRUE;
4610             AV *av = (AV*) SvRV(d);
4611             const I32 len = av_tindex(av);
4612             DEBUG_M(Perl_deb(aTHX_ "    applying rule Array-CodeRef\n"));
4613             if (len == -1)
4614                 RETPUSHYES;
4615             for (i = 0; i <= len; ++i) {
4616                 SV * const * const svp = av_fetch(av, i, FALSE);
4617                 DEBUG_M(Perl_deb(aTHX_ "        testing array element...\n"));
4618                 ENTER_with_name("smartmatch_array_elem_test");
4619                 SAVETMPS;
4620                 PUSHMARK(SP);
4621                 if (svp)
4622                     PUSHs(*svp);
4623                 PUTBACK;
4624                 c = call_sv(e, G_SCALAR);
4625                 SPAGAIN;
4626                 if (c == 0)
4627                     andedresults = FALSE;
4628                 else
4629                     andedresults = SvTRUEx(POPs) && andedresults;
4630                 FREETMPS;
4631                 LEAVE_with_name("smartmatch_array_elem_test");
4632             }
4633             if (andedresults)
4634                 RETPUSHYES;
4635             else
4636                 RETPUSHNO;
4637         }
4638         else {
4639           sm_any_sub:
4640             DEBUG_M(Perl_deb(aTHX_ "    applying rule Any-CodeRef\n"));
4641             ENTER_with_name("smartmatch_coderef");
4642             SAVETMPS;
4643             PUSHMARK(SP);
4644             PUSHs(d);
4645             PUTBACK;
4646             c = call_sv(e, G_SCALAR);
4647             SPAGAIN;
4648             if (c == 0)
4649                 PUSHs(&PL_sv_no);
4650             else if (SvTEMP(TOPs))
4651                 SvREFCNT_inc_void(TOPs);
4652             FREETMPS;
4653             LEAVE_with_name("smartmatch_coderef");
4654             RETURN;
4655         }
4656     }
4657     /* ~~ %hash */
4658     else if (SvROK(e) && SvTYPE(SvRV(e)) == SVt_PVHV) {
4659         if (object_on_left) {
4660             goto sm_any_hash; /* Treat objects like scalars */
4661         }
4662         else if (!SvOK(d)) {
4663             DEBUG_M(Perl_deb(aTHX_ "    applying rule Any-Hash ($a undef)\n"));
4664             RETPUSHNO;
4665         }
4666         else if (SvROK(d) && SvTYPE(SvRV(d)) == SVt_PVHV) {
4667             /* Check that the key-sets are identical */
4668             HE *he;
4669             HV *other_hv = MUTABLE_HV(SvRV(d));
4670             bool tied;
4671             bool other_tied;
4672             U32 this_key_count  = 0,
4673                 other_key_count = 0;
4674             HV *hv = MUTABLE_HV(SvRV(e));
4675
4676             DEBUG_M(Perl_deb(aTHX_ "    applying rule Hash-Hash\n"));
4677             /* Tied hashes don't know how many keys they have. */
4678             tied = cBOOL(SvTIED_mg((SV*)hv, PERL_MAGIC_tied));
4679             other_tied = cBOOL(SvTIED_mg((const SV *)other_hv, PERL_MAGIC_tied));
4680             if (!tied ) {
4681                 if(other_tied) {
4682                     /* swap HV sides */
4683                     HV * const temp = other_hv;
4684                     other_hv = hv;
4685                     hv = temp;
4686                     tied = TRUE;
4687                     other_tied = FALSE;
4688                 }
4689                 else if(HvUSEDKEYS((const HV *) hv) != HvUSEDKEYS(other_hv))
4690                     RETPUSHNO;
4691             }
4692
4693             /* The hashes have the same number of keys, so it suffices
4694                to check that one is a subset of the other. */
4695             (void) hv_iterinit(hv);
4696             while ( (he = hv_iternext(hv)) ) {
4697                 SV *key = hv_iterkeysv(he);
4698
4699                 DEBUG_M(Perl_deb(aTHX_ "        comparing hash key...\n"));
4700                 ++ this_key_count;
4701                 
4702                 if(!hv_exists_ent(other_hv, key, 0)) {
4703                     (void) hv_iterinit(hv);     /* reset iterator */
4704                     RETPUSHNO;
4705                 }
4706             }
4707             
4708             if (other_tied) {
4709                 (void) hv_iterinit(other_hv);
4710                 while ( hv_iternext(other_hv) )
4711                     ++other_key_count;
4712             }
4713             else
4714                 other_key_count = HvUSEDKEYS(other_hv);
4715             
4716             if (this_key_count != other_key_count)
4717                 RETPUSHNO;
4718             else
4719                 RETPUSHYES;
4720         }
4721         else if (SvROK(d) && SvTYPE(SvRV(d)) == SVt_PVAV) {
4722             AV * const other_av = MUTABLE_AV(SvRV(d));
4723             const SSize_t other_len = av_tindex(other_av) + 1;
4724             SSize_t i;
4725             HV *hv = MUTABLE_HV(SvRV(e));
4726
4727             DEBUG_M(Perl_deb(aTHX_ "    applying rule Array-Hash\n"));
4728             for (i = 0; i < other_len; ++i) {
4729                 SV ** const svp = av_fetch(other_av, i, FALSE);
4730                 DEBUG_M(Perl_deb(aTHX_ "        checking for key existence...\n"));
4731                 if (svp) {      /* ??? When can this not happen? */
4732                     if (hv_exists_ent(hv, *svp, 0))
4733                         RETPUSHYES;
4734                 }
4735             }
4736             RETPUSHNO;
4737         }
4738         else if (SvROK(d) && SvTYPE(SvRV(d)) == SVt_REGEXP) {
4739             DEBUG_M(Perl_deb(aTHX_ "    applying rule Regex-Hash\n"));
4740           sm_regex_hash:
4741             {
4742                 PMOP * const matcher = make_matcher((REGEXP*) SvRV(d));
4743                 HE *he;
4744                 HV *hv = MUTABLE_HV(SvRV(e));
4745
4746                 (void) hv_iterinit(hv);
4747                 while ( (he = hv_iternext(hv)) ) {
4748                     DEBUG_M(Perl_deb(aTHX_ "        testing key against pattern...\n"));
4749                     if (matcher_matches_sv(matcher, hv_iterkeysv(he))) {
4750                         (void) hv_iterinit(hv);
4751                         destroy_matcher(matcher);
4752                         RETPUSHYES;
4753                     }
4754                 }
4755                 destroy_matcher(matcher);
4756                 RETPUSHNO;
4757             }
4758         }
4759         else {
4760           sm_any_hash:
4761             DEBUG_M(Perl_deb(aTHX_ "    applying rule Any-Hash\n"));
4762             if (hv_exists_ent(MUTABLE_HV(SvRV(e)), d, 0))
4763                 RETPUSHYES;
4764             else
4765                 RETPUSHNO;
4766         }
4767     }
4768     /* ~~ @array */
4769     else if (SvROK(e) && SvTYPE(SvRV(e)) == SVt_PVAV) {
4770         if (object_on_left) {
4771             goto sm_any_array; /* Treat objects like scalars */
4772         }
4773         else if (SvROK(d) && SvTYPE(SvRV(d)) == SVt_PVHV) {
4774             AV * const other_av = MUTABLE_AV(SvRV(e));
4775             const SSize_t other_len = av_tindex(other_av) + 1;
4776             SSize_t i;
4777
4778             DEBUG_M(Perl_deb(aTHX_ "    applying rule Hash-Array\n"));
4779             for (i = 0; i < other_len; ++i) {
4780                 SV ** const svp = av_fetch(other_av, i, FALSE);
4781
4782                 DEBUG_M(Perl_deb(aTHX_ "        testing for key existence...\n"));
4783                 if (svp) {      /* ??? When can this not happen? */
4784                     if (hv_exists_ent(MUTABLE_HV(SvRV(d)), *svp, 0))
4785                         RETPUSHYES;
4786                 }
4787             }
4788             RETPUSHNO;
4789         }
4790         if (SvROK(d) && SvTYPE(SvRV(d)) == SVt_PVAV) {
4791             AV *other_av = MUTABLE_AV(SvRV(d));
4792             DEBUG_M(Perl_deb(aTHX_ "    applying rule Array-Array\n"));
4793             if (av_tindex(MUTABLE_AV(SvRV(e))) != av_tindex(other_av))
4794                 RETPUSHNO;
4795             else {
4796                 SSize_t i;
4797                 const SSize_t other_len = av_tindex(other_av);
4798
4799                 if (NULL == seen_this) {
4800                     seen_this = newHV();
4801                     (void) sv_2mortal(MUTABLE_SV(seen_this));
4802                 }
4803                 if (NULL == seen_other) {
4804                     seen_other = newHV();
4805                     (void) sv_2mortal(MUTABLE_SV(seen_other));
4806                 }
4807                 for(i = 0; i <= other_len; ++i) {
4808                     SV * const * const this_elem = av_fetch(MUTABLE_AV(SvRV(e)), i, FALSE);
4809                     SV * const * const other_elem = av_fetch(other_av, i, FALSE);
4810
4811                     if (!this_elem || !other_elem) {
4812                         if ((this_elem && SvOK(*this_elem))
4813                                 || (other_elem && SvOK(*other_elem)))
4814                             RETPUSHNO;
4815                     }
4816                     else if (hv_exists_ent(seen_this,
4817                                 sv_2mortal(newSViv(PTR2IV(*this_elem))), 0) ||
4818                             hv_exists_ent(seen_other,
4819                                 sv_2mortal(newSViv(PTR2IV(*other_elem))), 0))
4820                     {
4821                         if (*this_elem != *other_elem)
4822                             RETPUSHNO;
4823                     }
4824                     else {
4825                         (void)hv_store_ent(seen_this,
4826                                 sv_2mortal(newSViv(PTR2IV(*this_elem))),
4827                                 &PL_sv_undef, 0);
4828                         (void)hv_store_ent(seen_other,
4829                                 sv_2mortal(newSViv(PTR2IV(*other_elem))),
4830                                 &PL_sv_undef, 0);
4831                         PUSHs(*other_elem);
4832                         PUSHs(*this_elem);
4833                         
4834                         PUTBACK;
4835                         DEBUG_M(Perl_deb(aTHX_ "        recursively comparing array element...\n"));
4836                         (void) do_smartmatch(seen_this, seen_other, 0);
4837                         SPAGAIN;
4838                         DEBUG_M(Perl_deb(aTHX_ "        recursion finished\n"));
4839                         
4840                         if (!SvTRUEx(POPs))
4841                             RETPUSHNO;
4842                     }
4843                 }
4844                 RETPUSHYES;
4845             }
4846         }
4847         else if (SvROK(d) && SvTYPE(SvRV(d)) == SVt_REGEXP) {
4848             DEBUG_M(Perl_deb(aTHX_ "    applying rule Regex-Array\n"));
4849           sm_regex_array:
4850             {
4851                 PMOP * const matcher = make_matcher((REGEXP*) SvRV(d));
4852                 const SSize_t this_len = av_tindex(MUTABLE_AV(SvRV(e)));
4853                 SSize_t i;
4854
4855                 for(i = 0; i <= this_len; ++i) {
4856                     SV * const * const svp = av_fetch(MUTABLE_AV(SvRV(e)), i, FALSE);
4857                     DEBUG_M(Perl_deb(aTHX_ "        testing element against pattern...\n"));
4858                     if (svp && matcher_matches_sv(matcher, *svp)) {
4859                         destroy_matcher(matcher);
4860                         RETPUSHYES;
4861                     }
4862                 }
4863                 destroy_matcher(matcher);
4864                 RETPUSHNO;
4865             }
4866         }
4867         else if (!SvOK(d)) {
4868             /* undef ~~ array */
4869             const SSize_t this_len = av_tindex(MUTABLE_AV(SvRV(e)));
4870             SSize_t i;
4871
4872             DEBUG_M(Perl_deb(aTHX_ "    applying rule Undef-Array\n"));
4873             for (i = 0; i <= this_len; ++i) {
4874                 SV * const * const svp = av_fetch(MUTABLE_AV(SvRV(e)), i, FALSE);
4875                 DEBUG_M(Perl_deb(aTHX_ "        testing for undef element...\n"));
4876                 if (!svp || !SvOK(*svp))
4877                     RETPUSHYES;
4878             }
4879             RETPUSHNO;
4880         }
4881         else {
4882           sm_any_array:
4883             {
4884                 SSize_t i;
4885                 const SSize_t this_len = av_tindex(MUTABLE_AV(SvRV(e)));
4886
4887                 DEBUG_M(Perl_deb(aTHX_ "    applying rule Any-Array\n"));
4888                 for (i = 0; i <= this_len; ++i) {
4889                     SV * const * const svp = av_fetch(MUTABLE_AV(SvRV(e)), i, FALSE);
4890                     if (!svp)
4891                         continue;
4892
4893                     PUSHs(d);
4894                     PUSHs(*svp);
4895                     PUTBACK;
4896                     /* infinite recursion isn't supposed to happen here */
4897                     DEBUG_M(Perl_deb(aTHX_ "        recursively testing array element...\n"));
4898                     (void) do_smartmatch(NULL, NULL, 1);
4899                     SPAGAIN;
4900                     DEBUG_M(Perl_deb(aTHX_ "        recursion finished\n"));
4901                     if (SvTRUEx(POPs))
4902                         RETPUSHYES;
4903                 }
4904                 RETPUSHNO;
4905             }
4906         }
4907     }
4908     /* ~~ qr// */
4909     else if (SvROK(e) && SvTYPE(SvRV(e)) == SVt_REGEXP) {
4910         if (!object_on_left && SvROK(d) && SvTYPE(SvRV(d)) == SVt_PVHV) {
4911             SV *t = d; d = e; e = t;
4912             DEBUG_M(Perl_deb(aTHX_ "    applying rule Hash-Regex\n"));
4913             goto sm_regex_hash;
4914         }
4915         else if (!object_on_left && SvROK(d) && SvTYPE(SvRV(d)) == SVt_PVAV) {
4916             SV *t = d; d = e; e = t;
4917             DEBUG_M(Perl_deb(aTHX_ "    applying rule Array-Regex\n"));
4918             goto sm_regex_array;
4919         }
4920         else {
4921             PMOP * const matcher = make_matcher((REGEXP*) SvRV(e));
4922
4923             DEBUG_M(Perl_deb(aTHX_ "    applying rule Any-Regex\n"));
4924             PUTBACK;
4925             PUSHs(matcher_matches_sv(matcher, d)
4926                     ? &PL_sv_yes
4927                     : &PL_sv_no);
4928             destroy_matcher(matcher);
4929             RETURN;
4930         }
4931     }
4932     /* ~~ scalar */
4933     /* See if there is overload magic on left */
4934     else if (object_on_left && SvAMAGIC(d)) {
4935         SV *tmpsv;
4936         DEBUG_M(Perl_deb(aTHX_ "    applying rule Object-Any\n"));
4937         DEBUG_M(Perl_deb(aTHX_ "        attempting overload\n"));
4938         PUSHs(d); PUSHs(e);
4939         PUTBACK;
4940         tmpsv = amagic_call(d, e, smart_amg, AMGf_noright);
4941         if (tmpsv) {
4942             SPAGAIN;
4943             (void)POPs;
4944             SETs(tmpsv);
4945             RETURN;
4946         }
4947         SP -= 2;
4948         DEBUG_M(Perl_deb(aTHX_ "        failed to run overload method; falling back...\n"));
4949         goto sm_any_scalar;
4950     }
4951     else if (!SvOK(d)) {
4952         /* undef ~~ scalar ; we already know that the scalar is SvOK */
4953         DEBUG_M(Perl_deb(aTHX_ "    applying rule undef-Any\n"));
4954         RETPUSHNO;
4955     }
4956     else
4957   sm_any_scalar:
4958     if (SvNIOK(e) || (SvPOK(e) && looks_like_number(e) && SvNIOK(d))) {
4959         DEBUG_M(if (SvNIOK(e))
4960                     Perl_deb(aTHX_ "    applying rule Any-Num\n");
4961                 else
4962                     Perl_deb(aTHX_ "    applying rule Num-numish\n");
4963         );
4964         /* numeric comparison */
4965         PUSHs(d); PUSHs(e);
4966         PUTBACK;
4967         if (CopHINTS_get(PL_curcop) & HINT_INTEGER)
4968             (void) Perl_pp_i_eq(aTHX);
4969         else
4970             (void) Perl_pp_eq(aTHX);
4971         SPAGAIN;
4972         if (SvTRUEx(POPs))
4973             RETPUSHYES;
4974         else
4975             RETPUSHNO;
4976     }
4977     
4978     /* As a last resort, use string comparison */
4979     DEBUG_M(Perl_deb(aTHX_ "    applying rule Any-Any\n"));
4980     PUSHs(d); PUSHs(e);
4981     PUTBACK;
4982     return Perl_pp_seq(aTHX);
4983 }
4984
4985 PP(pp_enterwhen)
4986 {
4987     dSP;
4988     PERL_CONTEXT *cx;
4989     const I32 gimme = GIMME_V;
4990
4991     /* This is essentially an optimization: if the match
4992        fails, we don't want to push a context and then
4993        pop it again right away, so we skip straight
4994        to the op that follows the leavewhen.
4995        RETURNOP calls PUTBACK which restores the stack pointer after the POPs.
4996     */
4997     if ((0 == (PL_op->op_flags & OPf_SPECIAL)) && !SvTRUEx(POPs))
4998         RETURNOP(cLOGOP->op_other->op_next);
4999
5000     ENTER_with_name("when");
5001     SAVETMPS;
5002
5003     PUSHBLOCK(cx, CXt_WHEN, SP);
5004     PUSHWHEN(cx);
5005
5006     RETURN;
5007 }
5008
5009 PP(pp_leavewhen)
5010 {
5011     dSP;
5012     I32 cxix;
5013     PERL_CONTEXT *cx;
5014     I32 gimme;
5015     SV **newsp;
5016     PMOP *newpm;
5017
5018     cxix = dopoptogiven(cxstack_ix);
5019     if (cxix < 0)
5020         /* diag_listed_as: Can't "when" outside a topicalizer */
5021         DIE(aTHX_ "Can't \"%s\" outside a topicalizer",
5022                    PL_op->op_flags & OPf_SPECIAL ? "default" : "when");
5023
5024     POPBLOCK(cx,newpm);
5025     assert(CxTYPE(cx) == CXt_WHEN);
5026
5027     SP = leave_common(newsp, SP, newsp, gimme,
5028                                SVs_PADTMP|SVs_TEMP, FALSE);
5029     PL_curpm = newpm;   /* pop $1 et al */
5030
5031     LEAVE_with_name("when");
5032
5033     if (cxix < cxstack_ix)
5034         dounwind(cxix);
5035
5036     cx = &cxstack[cxix];
5037
5038     if (CxFOREACH(cx)) {
5039         /* clear off anything above the scope we're re-entering */
5040         I32 inner = PL_scopestack_ix;
5041
5042         TOPBLOCK(cx);
5043         if (PL_scopestack_ix < inner)
5044             leave_scope(PL_scopestack[PL_scopestack_ix]);
5045         PL_curcop = cx->blk_oldcop;
5046
5047         PERL_ASYNC_CHECK();
5048         return cx->blk_loop.my_op->op_nextop;
5049     }
5050     else {
5051         PERL_ASYNC_CHECK();
5052         RETURNOP(cx->blk_givwhen.leave_op);
5053     }
5054 }
5055
5056 PP(pp_continue)
5057 {
5058     dSP;
5059     I32 cxix;
5060     PERL_CONTEXT *cx;
5061     I32 gimme;
5062     SV **newsp;
5063     PMOP *newpm;
5064
5065     PERL_UNUSED_VAR(gimme);
5066     
5067     cxix = dopoptowhen(cxstack_ix); 
5068     if (cxix < 0)   
5069         DIE(aTHX_ "Can't \"continue\" outside a when block");
5070
5071     if (cxix < cxstack_ix)
5072         dounwind(cxix);
5073     
5074     POPBLOCK(cx,newpm);
5075     assert(CxTYPE(cx) == CXt_WHEN);
5076
5077     SP = newsp;
5078     PL_curpm = newpm;   /* pop $1 et al */
5079
5080     LEAVE_with_name("when");
5081     RETURNOP(cx->blk_givwhen.leave_op->op_next);
5082 }
5083
5084 PP(pp_break)
5085 {
5086     I32 cxix;
5087     PERL_CONTEXT *cx;
5088
5089     cxix = dopoptogiven(cxstack_ix); 
5090     if (cxix < 0)
5091         DIE(aTHX_ "Can't \"break\" outside a given block");
5092
5093     cx = &cxstack[cxix];
5094     if (CxFOREACH(cx))
5095         DIE(aTHX_ "Can't \"break\" in a loop topicalizer");
5096
5097     if (cxix < cxstack_ix)
5098         dounwind(cxix);
5099
5100     /* Restore the sp at the time we entered the given block */
5101     TOPBLOCK(cx);
5102
5103     return cx->blk_givwhen.leave_op;
5104 }
5105
5106 static MAGIC *
5107 S_doparseform(pTHX_ SV *sv)
5108 {
5109     STRLEN len;
5110     char *s = SvPV(sv, len);
5111     char *send;
5112     char *base = NULL; /* start of current field */
5113     I32 skipspaces = 0; /* number of contiguous spaces seen */
5114     bool noblank   = FALSE; /* ~ or ~~ seen on this line */
5115     bool repeat    = FALSE; /* ~~ seen on this line */
5116     bool postspace = FALSE; /* a text field may need right padding */
5117     U32 *fops;
5118     U32 *fpc;
5119     U32 *linepc = NULL;     /* position of last FF_LINEMARK */
5120     I32 arg;
5121     bool ischop;            /* it's a ^ rather than a @ */
5122     bool unchopnum = FALSE; /* at least one @ (i.e. non-chop) num field seen */
5123     int maxops = 12; /* FF_LINEMARK + FF_END + 10 (\0 without preceding \n) */
5124     MAGIC *mg = NULL;
5125     SV *sv_copy;
5126
5127     PERL_ARGS_ASSERT_DOPARSEFORM;
5128
5129     if (len == 0)
5130         Perl_croak(aTHX_ "Null picture in formline");
5131
5132     if (SvTYPE(sv) >= SVt_PVMG) {
5133         /* This might, of course, still return NULL.  */
5134         mg = mg_find(sv, PERL_MAGIC_fm);
5135     } else {
5136         sv_upgrade(sv, SVt_PVMG);
5137     }
5138
5139     if (mg) {
5140         /* still the same as previously-compiled string? */
5141         SV *old = mg->mg_obj;
5142         if ( !(!!SvUTF8(old) ^ !!SvUTF8(sv))
5143               && len == SvCUR(old)
5144               && strnEQ(SvPVX(old), SvPVX(sv), len)
5145         ) {
5146             DEBUG_f(PerlIO_printf(Perl_debug_log,"Re-using compiled format\n"));
5147             return mg;
5148         }
5149
5150         DEBUG_f(PerlIO_printf(Perl_debug_log, "Re-compiling format\n"));
5151         Safefree(mg->mg_ptr);
5152         mg->mg_ptr = NULL;
5153         SvREFCNT_dec(old);
5154         mg->mg_obj = NULL;
5155     }
5156     else {
5157         DEBUG_f(PerlIO_printf(Perl_debug_log, "Compiling format\n"));
5158         mg = sv_magicext(sv, NULL, PERL_MAGIC_fm, &PL_vtbl_fm, NULL, 0);
5159     }
5160
5161     sv_copy = newSVpvn_utf8(s, len, SvUTF8(sv));
5162     s = SvPV(sv_copy, len); /* work on the copy, not the original */
5163     send = s + len;
5164
5165
5166     /* estimate the buffer size needed */
5167     for (base = s; s <= send; s++) {
5168         if (*s == '\n' || *s == '@' || *s == '^')
5169             maxops += 10;
5170     }
5171     s = base;
5172     base = NULL;
5173
5174     Newx(fops, maxops, U32);
5175     fpc = fops;
5176
5177     if (s < send) {
5178         linepc = fpc;
5179         *fpc++ = FF_LINEMARK;
5180         noblank = repeat = FALSE;
5181         base = s;
5182     }
5183
5184     while (s <= send) {
5185         switch (*s++) {
5186         default:
5187             skipspaces = 0;
5188             continue;
5189
5190         case '~':
5191             if (*s == '~') {
5192                 repeat = TRUE;
5193                 skipspaces++;
5194                 s++;
5195             }
5196             noblank = TRUE;
5197             /* FALLTHROUGH */
5198         case ' ': case '\t':
5199             skipspaces++;
5200             continue;
5201         case 0:
5202             if (s < send) {
5203                 skipspaces = 0;
5204                 continue;
5205             } /* else FALL THROUGH */
5206         case '\n':
5207             arg = s - base;
5208             skipspaces++;
5209             arg -= skipspaces;
5210             if (arg) {
5211                 if (postspace)
5212                     *fpc++ = FF_SPACE;
5213                 *fpc++ = FF_LITERAL;
5214                 *fpc++ = (U32)arg;
5215             }
5216             postspace = FALSE;
5217             if (s <= send)
5218                 skipspaces--;
5219             if (skipspaces) {
5220                 *fpc++ = FF_SKIP;
5221                 *fpc++ = (U32)skipspaces;
5222             }
5223             skipspaces = 0;
5224             if (s <= send)
5225                 *fpc++ = FF_NEWLINE;
5226             if (noblank) {
5227                 *fpc++ = FF_BLANK;
5228                 if (repeat)
5229                     arg = fpc - linepc + 1;
5230                 else
5231                     arg = 0;
5232                 *fpc++ = (U32)arg;
5233             }
5234             if (s < send) {
5235                 linepc = fpc;
5236                 *fpc++ = FF_LINEMARK;
5237                 noblank = repeat = FALSE;
5238                 base = s;
5239             }
5240             else
5241                 s++;
5242             continue;
5243
5244         case '@':
5245         case '^':
5246             ischop = s[-1] == '^';
5247
5248             if (postspace) {
5249                 *fpc++ = FF_SPACE;
5250                 postspace = FALSE;
5251             }
5252             arg = (s - base) - 1;
5253             if (arg) {
5254                 *fpc++ = FF_LITERAL;
5255                 *fpc++ = (U32)arg;
5256             }
5257
5258             base = s - 1;
5259             *fpc++ = FF_FETCH;
5260             if (*s == '*') { /*  @* or ^*  */
5261                 s++;
5262                 *fpc++ = 2;  /* skip the @* or ^* */
5263                 if (ischop) {
5264                     *fpc++ = FF_LINESNGL;
5265                     *fpc++ = FF_CHOP;
5266                 } else
5267                     *fpc++ = FF_LINEGLOB;
5268             }
5269             else if (*s == '#' || (*s == '.' && s[1] == '#')) { /* @###, ^### */
5270                 arg = ischop ? FORM_NUM_BLANK : 0;
5271                 base = s - 1;
5272                 while (*s == '#')
5273                     s++;
5274                 if (*s == '.') {
5275                     const char * const f = ++s;
5276                     while (*s == '#')
5277                         s++;
5278                     arg |= FORM_NUM_POINT + (s - f);
5279                 }
5280                 *fpc++ = s - base;              /* fieldsize for FETCH */
5281                 *fpc++ = FF_DECIMAL;
5282                 *fpc++ = (U32)arg;
5283                 unchopnum |= ! ischop;
5284             }
5285             else if (*s == '0' && s[1] == '#') {  /* Zero padded decimals */
5286                 arg = ischop ? FORM_NUM_BLANK : 0;
5287                 base = s - 1;
5288                 s++;                                /* skip the '0' first */
5289                 while (*s == '#')
5290                     s++;
5291                 if (*s == '.') {
5292                     const char * const f = ++s;
5293                     while (*s == '#')
5294                         s++;
5295                     arg |= FORM_NUM_POINT + (s - f);
5296                 }
5297                 *fpc++ = s - base;                /* fieldsize for FETCH */
5298                 *fpc++ = FF_0DECIMAL;
5299                 *fpc++ = (U32)arg;
5300                 unchopnum |= ! ischop;
5301             }
5302             else {                              /* text field */
5303                 I32 prespace = 0;
5304                 bool ismore = FALSE;
5305
5306                 if (*s == '>') {
5307                     while (*++s == '>') ;
5308                     prespace = FF_SPACE;
5309                 }
5310                 else if (*s == '|') {
5311                     while (*++s == '|') ;
5312                     prespace = FF_HALFSPACE;
5313                     postspace = TRUE;
5314                 }
5315                 else {
5316                     if (*s == '<')
5317                         while (*++s == '<') ;
5318                     postspace = TRUE;
5319                 }
5320                 if (*s == '.' && s[1] == '.' && s[2] == '.') {
5321                     s += 3;
5322                     ismore = TRUE;
5323                 }
5324                 *fpc++ = s - base;              /* fieldsize for FETCH */
5325
5326                 *fpc++ = ischop ? FF_CHECKCHOP : FF_CHECKNL;
5327
5328                 if (prespace)
5329                     *fpc++ = (U32)prespace; /* add SPACE or HALFSPACE */
5330                 *fpc++ = FF_ITEM;
5331                 if (ismore)
5332                     *fpc++ = FF_MORE;
5333                 if (ischop)
5334                     *fpc++ = FF_CHOP;
5335             }
5336             base = s;
5337             skipspaces = 0;
5338             continue;
5339         }
5340     }
5341     *fpc++ = FF_END;
5342
5343     assert (fpc <= fops + maxops); /* ensure our buffer estimate was valid */
5344     arg = fpc - fops;
5345
5346     mg->mg_ptr = (char *) fops;
5347     mg->mg_len = arg * sizeof(U32);
5348     mg->mg_obj = sv_copy;
5349     mg->mg_flags |= MGf_REFCOUNTED;
5350
5351     if (unchopnum && repeat)
5352         Perl_die(aTHX_ "Repeated format line will never terminate (~~ and @#)");
5353
5354     return mg;
5355 }
5356
5357
5358 STATIC bool
5359 S_num_overflow(NV value, I32 fldsize, I32 frcsize)
5360 {
5361     /* Can value be printed in fldsize chars, using %*.*f ? */
5362     NV pwr = 1;
5363     NV eps = 0.5;
5364     bool res = FALSE;
5365     int intsize = fldsize - (value < 0 ? 1 : 0);
5366
5367     if (frcsize & FORM_NUM_POINT)
5368         intsize--;
5369     frcsize &= ~(FORM_NUM_POINT|FORM_NUM_BLANK);
5370     intsize -= frcsize;
5371
5372     while (intsize--) pwr *= 10.0;
5373     while (frcsize--) eps /= 10.0;
5374
5375     if( value >= 0 ){
5376         if (value + eps >= pwr)
5377             res = TRUE;
5378     } else {
5379         if (value - eps <= -pwr)
5380             res = TRUE;
5381     }
5382     return res;
5383 }
5384
5385 static I32
5386 S_run_user_filter(pTHX_ int idx, SV *buf_sv, int maxlen)
5387 {
5388     SV * const datasv = FILTER_DATA(idx);
5389     const int filter_has_file = IoLINES(datasv);
5390     SV * const filter_state = MUTABLE_SV(IoTOP_GV(datasv));
5391     SV * const filter_sub = MUTABLE_SV(IoBOTTOM_GV(datasv));
5392     int status = 0;
5393     SV *upstream;
5394     STRLEN got_len;
5395     char *got_p = NULL;
5396     char *prune_from = NULL;
5397     bool read_from_cache = FALSE;
5398     STRLEN umaxlen;
5399     SV *err = NULL;
5400
5401     PERL_ARGS_ASSERT_RUN_USER_FILTER;
5402
5403     assert(maxlen >= 0);
5404     umaxlen = maxlen;
5405
5406     /* I was having segfault trouble under Linux 2.2.5 after a
5407        parse error occured.  (Had to hack around it with a test
5408        for PL_parser->error_count == 0.)  Solaris doesn't segfault --
5409        not sure where the trouble is yet.  XXX */
5410
5411     {
5412         SV *const cache = datasv;
5413         if (SvOK(cache)) {
5414             STRLEN cache_len;
5415             const char *cache_p = SvPV(cache, cache_len);
5416             STRLEN take = 0;
5417
5418             if (umaxlen) {
5419                 /* Running in block mode and we have some cached data already.
5420                  */
5421                 if (cache_len >= umaxlen) {
5422                     /* In fact, so much data we don't even need to call
5423                        filter_read.  */
5424                     take = umaxlen;
5425                 }
5426             } else {
5427                 const char *const first_nl =
5428                     (const char *)memchr(cache_p, '\n', cache_len);
5429                 if (first_nl) {
5430                     take = first_nl + 1 - cache_p;
5431                 }
5432             }
5433             if (take) {
5434                 sv_catpvn(buf_sv, cache_p, take);
5435                 sv_chop(cache, cache_p + take);
5436                 /* Definitely not EOF  */
5437                 return 1;
5438             }
5439
5440             sv_catsv(buf_sv, cache);
5441             if (umaxlen) {
5442                 umaxlen -= cache_len;
5443             }
5444             SvOK_off(cache);
5445             read_from_cache = TRUE;
5446         }
5447     }
5448
5449     /* Filter API says that the filter appends to the contents of the buffer.
5450        Usually the buffer is "", so the details don't matter. But if it's not,
5451        then clearly what it contains is already filtered by this filter, so we
5452        don't want to pass it in a second time.
5453        I'm going to use a mortal in case the upstream filter croaks.  */
5454     upstream = ((SvOK(buf_sv) && sv_len(buf_sv)) || SvGMAGICAL(buf_sv))
5455         ? sv_newmortal() : buf_sv;
5456     SvUPGRADE(upstream, SVt_PV);
5457         
5458     if (filter_has_file) {
5459         status = FILTER_READ(idx+1, upstream, 0);
5460     }
5461
5462     if (filter_sub && status >= 0) {
5463         dSP;
5464         int count;
5465
5466         ENTER_with_name("call_filter_sub");
5467         SAVE_DEFSV;
5468         SAVETMPS;
5469         EXTEND(SP, 2);
5470
5471         DEFSV_set(upstream);
5472         PUSHMARK(SP);
5473         mPUSHi(0);
5474         if (filter_state) {
5475             PUSHs(filter_state);
5476         }
5477         PUTBACK;
5478         count = call_sv(filter_sub, G_SCALAR|G_EVAL);
5479         SPAGAIN;
5480
5481         if (count > 0) {
5482             SV *out = POPs;
5483             SvGETMAGIC(out);
5484             if (SvOK(out)) {
5485                 status = SvIV(out);
5486             }
5487             else {
5488                 SV * const errsv = ERRSV;
5489                 if (SvTRUE_NN(errsv))
5490                     err = newSVsv(errsv);
5491             }
5492         }
5493
5494         PUTBACK;
5495         FREETMPS;
5496         LEAVE_with_name("call_filter_sub");
5497     }
5498
5499     if (SvGMAGICAL(upstream)) {
5500         mg_get(upstream);
5501         if (upstream == buf_sv) mg_free(buf_sv);
5502     }
5503     if (SvIsCOW(upstream)) sv_force_normal(upstream);
5504     if(!err && SvOK(upstream)) {
5505         got_p = SvPV_nomg(upstream, got_len);
5506         if (umaxlen) {
5507             if (got_len > umaxlen) {
5508                 prune_from = got_p + umaxlen;
5509             }
5510         } else {
5511             char *const first_nl = (char *)memchr(got_p, '\n', got_len);
5512             if (first_nl && first_nl + 1 < got_p + got_len) {
5513                 /* There's a second line here... */
5514                 prune_from = first_nl + 1;
5515             }
5516         }
5517     }
5518     if (!err && prune_from) {
5519         /* Oh. Too long. Stuff some in our cache.  */
5520         STRLEN cached_len = got_p + got_len - prune_from;
5521         SV *const cache = datasv;
5522
5523         if (SvOK(cache)) {
5524             /* Cache should be empty.  */
5525             assert(!SvCUR(cache));
5526         }
5527
5528         sv_setpvn(cache, prune_from, cached_len);
5529         /* If you ask for block mode, you may well split UTF-8 characters.
5530            "If it breaks, you get to keep both parts"
5531            (Your code is broken if you  don't put them back together again
5532            before something notices.) */
5533         if (SvUTF8(upstream)) {
5534             SvUTF8_on(cache);
5535         }
5536         if (SvPOK(upstream)) SvCUR_set(upstream, got_len - cached_len);
5537         else
5538             /* Cannot just use sv_setpvn, as that could free the buffer
5539                before we have a chance to assign it. */
5540             sv_usepvn(upstream, savepvn(got_p, got_len - cached_len),
5541                       got_len - cached_len);
5542         *prune_from = 0;
5543         /* Can't yet be EOF  */
5544         if (status == 0)
5545             status = 1;
5546     }
5547
5548     /* If they are at EOF but buf_sv has something in it, then they may never
5549        have touched the SV upstream, so it may be undefined.  If we naively
5550        concatenate it then we get a warning about use of uninitialised value.
5551     */
5552     if (!err && upstream != buf_sv &&
5553         SvOK(upstream)) {
5554         sv_catsv_nomg(buf_sv, upstream);
5555     }
5556     else if (SvOK(upstream)) (void)SvPV_force_nolen(buf_sv);
5557
5558     if (status <= 0) {
5559         IoLINES(datasv) = 0;
5560         if (filter_state) {
5561             SvREFCNT_dec(filter_state);
5562             IoTOP_GV(datasv) = NULL;
5563         }
5564         if (filter_sub) {
5565             SvREFCNT_dec(filter_sub);
5566             IoBOTTOM_GV(datasv) = NULL;
5567         }
5568         filter_del(S_run_user_filter);
5569     }
5570
5571     if (err)
5572         croak_sv(err);
5573
5574     if (status == 0 && read_from_cache) {
5575         /* If we read some data from the cache (and by getting here it implies
5576            that we emptied the cache) then we aren't yet at EOF, and mustn't
5577            report that to our caller.  */
5578         return 1;
5579     }
5580     return status;
5581 }
5582
5583 /*
5584  * Local variables:
5585  * c-indentation-style: bsd
5586  * c-basic-offset: 4
5587  * indent-tabs-mode: nil
5588  * End:
5589  *
5590  * ex: set ts=8 sts=4 sw=4 et:
5591  */