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
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.
9 * Control ops (cops) are one of the three ops OP_NEXTSTATE, OP_DBSTATE,
10 * and OP_SETSTATE that (loosely speaking) are separate statements.
11 * They hold information important for lexical state and error reporting.
12 * At run time, PL_curcop is set to point to the most recently executed cop,
13 * and thus can be used to determine our current state.
16 /* A jmpenv packages the state required to perform a proper non-local jump.
17 * Note that there is a start_env initialized when perl starts, and top_env
18 * points to this initially, so top_env should always be non-null.
20 * Existence of a non-null top_env->je_prev implies it is valid to call
21 * longjmp() at that runlevel (we make sure start_env.je_prev is always
22 * null to ensure this).
24 * je_mustcatch, when set at any runlevel to TRUE, means eval ops must
25 * establish a local jmpenv to handle exception traps. Care must be taken
26 * to restore the previous value of je_mustcatch before exiting the
27 * stack frame iff JMPENV_PUSH was not called in that stack frame.
32 struct jmpenv * je_prev;
33 Sigjmp_buf je_buf; /* only for use if !je_throw */
34 int je_ret; /* last exception thrown */
35 bool je_mustcatch; /* need to call longjmp()? */
38 typedef struct jmpenv JMPENV;
41 #define OP_REG_TO_MEM PL_opsave = op
42 #define OP_MEM_TO_REG op = PL_opsave
44 #define OP_REG_TO_MEM NOOP
45 #define OP_MEM_TO_REG NOOP
49 * How to build the first jmpenv.
51 * top_env needs to be non-zero. It points to an area
52 * in which longjmp() stuff is stored, as C callstack
53 * info there at least is thread specific this has to
54 * be per-thread. Otherwise a 'die' in a thread gives
55 * that thread the C stack of last thread to do an eval {}!
58 #define JMPENV_BOOTSTRAP \
60 Zero(&PL_start_env, 1, JMPENV); \
61 PL_start_env.je_ret = -1; \
62 PL_start_env.je_mustcatch = TRUE; \
63 PL_top_env = &PL_start_env; \
67 * PERL_FLEXIBLE_EXCEPTIONS
69 * All the flexible exceptions code has been removed.
70 * See the following threads for details:
72 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2004-07/msg00378.html
74 * Joshua's original patches (which weren't applied) and discussion:
76 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg01396.html
77 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg01489.html
78 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg01491.html
79 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg01608.html
80 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg02144.html
81 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg02998.html
83 * Chip's reworked patch and discussion:
85 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1999-03/msg00520.html
87 * The flaw in these patches (which went unnoticed at the time) was
88 * that they moved some code that could potentially die() out of the
89 * region protected by the setjmp()s. This caused exceptions within
90 * END blocks and such to not be handled by the correct setjmp().
92 * The original patches that introduces flexible exceptions were:
94 * http://public.activestate.com/cgi-bin/perlbrowse?patch=3386
95 * http://public.activestate.com/cgi-bin/perlbrowse?patch=5162
98 #define dJMPENV JMPENV cur_env
100 #define JMPENV_PUSH(v) \
102 DEBUG_l(Perl_deb(aTHX_ "Setting up jumplevel %p, was %p\n", \
103 (void*)&cur_env, (void*)PL_top_env)); \
104 cur_env.je_prev = PL_top_env; \
106 cur_env.je_ret = PerlProc_setjmp(cur_env.je_buf, SCOPE_SAVES_SIGNAL_MASK); \
108 PL_top_env = &cur_env; \
109 cur_env.je_mustcatch = FALSE; \
110 (v) = cur_env.je_ret; \
115 DEBUG_l(Perl_deb(aTHX_ "popping jumplevel was %p, now %p\n", \
116 (void*)PL_top_env, (void*)cur_env.je_prev)); \
117 assert(PL_top_env == &cur_env); \
118 PL_top_env = cur_env.je_prev; \
121 #define JMPENV_JUMP(v) \
124 if (PL_top_env->je_prev) \
125 PerlProc_longjmp(PL_top_env->je_buf, (v)); \
127 PerlProc_exit(STATUS_EXIT); \
128 PerlIO_printf(PerlIO_stderr(), "panic: top_env\n"); \
132 #define CATCH_GET (PL_top_env->je_mustcatch)
133 #define CATCH_SET(v) (PL_top_env->je_mustcatch = (v))
136 #include "mydtrace.h"
140 /* On LP64 putting this here takes advantage of the fact that BASEOP isn't
141 an exact multiple of 8 bytes to save structure padding. */
142 line_t cop_line; /* line # of this command */
143 /* label for this construct is now stored in cop_hints_hash */
145 char * cop_stashpv; /* package line was compiled in */
146 char * cop_file; /* file name the following line # is from */
148 HV * cop_stash; /* package line was compiled in */
149 GV * cop_filegv; /* file the following line # is from */
151 U32 cop_hints; /* hints bits from pragmata */
152 U32 cop_seq; /* parse sequence number */
153 /* Beware. mg.c and warnings.pl assume the type of this is STRLEN *: */
154 STRLEN * cop_warnings; /* lexical warnings bitmask */
155 /* compile time state of %^H. See the comment in op.c for how this is
156 used to recreate a hash to return from caller. */
157 struct refcounted_he * cop_hints_hash;
161 # define CopFILE(c) ((c)->cop_file)
162 # define CopFILEGV(c) (CopFILE(c) \
163 ? gv_fetchfile(CopFILE(c)) : NULL)
166 # define CopFILE_set(c,pv) ((c)->cop_file = savepv(pv))
167 # define CopFILE_setn(c,pv,l) ((c)->cop_file = savepv((pv),(l)))
169 # define CopFILE_set(c,pv) ((c)->cop_file = savesharedpv(pv))
170 # define CopFILE_setn(c,pv,l) ((c)->cop_file = savesharedpvn((pv),(l)))
173 # define CopFILESV(c) (CopFILE(c) \
174 ? GvSV(gv_fetchfile(CopFILE(c))) : NULL)
175 # define CopFILEAV(c) (CopFILE(c) \
176 ? GvAV(gv_fetchfile(CopFILE(c))) : NULL)
178 # define CopFILEAVx(c) (assert(CopFILE(c)), \
179 GvAV(gv_fetchfile(CopFILE(c))))
181 # define CopFILEAVx(c) (GvAV(gv_fetchfile(CopFILE(c))))
183 # define CopSTASHPV(c) ((c)->cop_stashpv)
186 # define CopSTASHPV_set(c,pv) ((c)->cop_stashpv = ((pv) ? savepv(pv) : NULL))
188 # define CopSTASHPV_set(c,pv) ((c)->cop_stashpv = savesharedpv(pv))
191 # define CopSTASH(c) (CopSTASHPV(c) \
192 ? gv_stashpv(CopSTASHPV(c),GV_ADD) : NULL)
193 # define CopSTASH_set(c,hv) CopSTASHPV_set(c, (hv) ? HvNAME_get(hv) : NULL)
194 # define CopSTASH_eq(c,hv) ((hv) && stashpv_hvname_match(c,hv))
196 # define CopSTASH_free(c) SAVECOPSTASH_FREE(c)
197 # define CopFILE_free(c) SAVECOPFILE_FREE(c)
199 # define CopSTASH_free(c) PerlMemShared_free(CopSTASHPV(c))
200 # define CopFILE_free(c) (PerlMemShared_free(CopFILE(c)),(CopFILE(c) = NULL))
203 # define CopFILEGV(c) ((c)->cop_filegv)
204 # define CopFILEGV_set(c,gv) ((c)->cop_filegv = (GV*)SvREFCNT_inc(gv))
205 # define CopFILE_set(c,pv) CopFILEGV_set((c), gv_fetchfile(pv))
206 # define CopFILE_setn(c,pv,l) CopFILEGV_set((c), gv_fetchfile_flags((pv),(l),0))
207 # define CopFILESV(c) (CopFILEGV(c) ? GvSV(CopFILEGV(c)) : NULL)
208 # define CopFILEAV(c) (CopFILEGV(c) ? GvAV(CopFILEGV(c)) : NULL)
210 # define CopFILEAVx(c) (assert(CopFILEGV(c)), GvAV(CopFILEGV(c)))
212 # define CopFILEAVx(c) (GvAV(CopFILEGV(c)))
214 # define CopFILE(c) (CopFILEGV(c) && GvSV(CopFILEGV(c)) \
215 ? SvPVX(GvSV(CopFILEGV(c))) : NULL)
216 # define CopSTASH(c) ((c)->cop_stash)
217 # define CopSTASH_set(c,hv) ((c)->cop_stash = (hv))
218 # define CopSTASHPV(c) (CopSTASH(c) ? HvNAME_get(CopSTASH(c)) : NULL)
219 /* cop_stash is not refcounted */
220 # define CopSTASHPV_set(c,pv) CopSTASH_set((c), gv_stashpv(pv,GV_ADD))
221 # define CopSTASH_eq(c,hv) (CopSTASH(c) == (hv))
222 # define CopSTASH_free(c)
223 # define CopFILE_free(c) (SvREFCNT_dec(CopFILEGV(c)),(CopFILEGV(c) = NULL))
225 #endif /* USE_ITHREADS */
226 #define CopLABEL(c) Perl_fetch_cop_label(aTHX_ (c)->cop_hints_hash, NULL, NULL)
227 #define CopLABEL_alloc(pv) ((pv)?savepv(pv):NULL)
229 #define CopSTASH_ne(c,hv) (!CopSTASH_eq(c,hv))
230 #define CopLINE(c) ((c)->cop_line)
231 #define CopLINE_inc(c) (++CopLINE(c))
232 #define CopLINE_dec(c) (--CopLINE(c))
233 #define CopLINE_set(c,l) (CopLINE(c) = (l))
235 /* OutCopFILE() is CopFILE for output (caller, die, warn, etc.) */
236 #define OutCopFILE(c) CopFILE(c)
238 /* If $[ is non-zero, it's stored in cop_hints under the key "$[", and
239 HINT_ARYBASE is set to indicate this.
240 Setting it is ineficient due to the need to create 2 mortal SVs, but as
241 using $[ is highly discouraged, no sane Perl code will be using it. */
242 #define CopARYBASE_get(c) \
243 ((CopHINTS_get(c) & HINT_ARYBASE) \
244 ? SvIV(Perl_refcounted_he_fetch(aTHX_ (c)->cop_hints_hash, 0, \
247 #define CopARYBASE_set(c, b) STMT_START { \
248 if (b || ((c)->cop_hints & HINT_ARYBASE)) { \
249 (c)->cop_hints |= HINT_ARYBASE; \
250 if ((c) == &PL_compiling) { \
251 SV *val = newSViv(b); \
252 (void)hv_stores(GvHV(PL_hintgv), "$[", val); \
254 PL_hints |= HINT_ARYBASE; \
256 (c)->cop_hints_hash \
257 = Perl_refcounted_he_new(aTHX_ (c)->cop_hints_hash, \
258 newSVpvs_flags("$[", SVs_TEMP), \
259 sv_2mortal(newSViv(b))); \
264 /* FIXME NATIVE_HINTS if this is changed from op_private (see perl.h) */
265 #define CopHINTS_get(c) ((c)->cop_hints + 0)
266 #define CopHINTS_set(c, h) STMT_START { \
267 (c)->cop_hints = (h); \
271 * Here we have some enormously heavy (or at least ponderous) wizardry.
274 /* subroutine context */
276 OP * retop; /* op to execute on exit from sub */
277 /* Above here is the same for sub, format and eval. */
279 /* Above here is the same for sub and format. */
288 struct block_format {
289 OP * retop; /* op to execute on exit from sub */
290 /* Above here is the same for sub, format and eval. */
292 /* Above here is the same for sub and format. */
297 /* base for the next two macros. Don't use directly.
298 * Note that the refcnt of the cv is incremented twice; The CX one is
299 * decremented by LEAVESUB, the other by LEAVE. */
301 #define PUSHSUB_BASE(cx) \
302 ENTRY_PROBE(GvENAME(CvGV(cv)), \
303 CopFILE((const COP *)CvSTART(cv)), \
304 CopLINE((const COP *)CvSTART(cv))); \
306 cx->blk_sub.cv = cv; \
307 cx->blk_sub.olddepth = CvDEPTH(cv); \
308 cx->cx_type |= (hasargs) ? CXp_HASARGS : 0; \
309 cx->blk_sub.retop = NULL; \
310 if (!CvDEPTH(cv)) { \
311 SvREFCNT_inc_simple_void_NN(cv); \
312 SvREFCNT_inc_simple_void_NN(cv); \
317 #define PUSHSUB(cx) \
319 cx->blk_u16 = PL_op->op_private & \
320 (OPpLVAL_INTRO|OPpENTERSUB_INARGS);
322 /* variant for use by OP_DBSTATE, where op_private holds hint bits */
323 #define PUSHSUB_DB(cx) \
328 #define PUSHFORMAT(cx, retop) \
329 cx->blk_format.cv = cv; \
330 cx->blk_format.gv = gv; \
331 cx->blk_format.retop = (retop); \
332 cx->blk_format.dfoutgv = PL_defoutgv; \
333 SvREFCNT_inc_void(cx->blk_format.dfoutgv)
335 #define POP_SAVEARRAY() \
337 SvREFCNT_dec(GvAV(PL_defgv)); \
338 GvAV(PL_defgv) = cx->blk_sub.savearray; \
341 /* junk in @_ spells trouble when cloning CVs and in pp_caller(), so don't
342 * leave any (a fast av_clear(ary), basically) */
343 #define CLEAR_ARGARRAY(ary) \
345 AvMAX(ary) += AvARRAY(ary) - AvALLOC(ary); \
346 AvARRAY(ary) = AvALLOC(ary); \
350 #define POPSUB(cx,sv) \
352 RETURN_PROBE(GvENAME(CvGV((const CV*)cx->blk_sub.cv)), \
353 CopFILE((COP*)CvSTART((const CV*)cx->blk_sub.cv)), \
354 CopLINE((COP*)CvSTART((const CV*)cx->blk_sub.cv))); \
356 if (CxHASARGS(cx)) { \
358 /* abandon @_ if it got reified */ \
359 if (AvREAL(cx->blk_sub.argarray)) { \
360 const SSize_t fill = AvFILLp(cx->blk_sub.argarray); \
361 SvREFCNT_dec(cx->blk_sub.argarray); \
362 cx->blk_sub.argarray = newAV(); \
363 av_extend(cx->blk_sub.argarray, fill); \
364 AvREIFY_only(cx->blk_sub.argarray); \
365 CX_CURPAD_SV(cx->blk_sub, 0) = MUTABLE_SV(cx->blk_sub.argarray); \
368 CLEAR_ARGARRAY(cx->blk_sub.argarray); \
371 sv = MUTABLE_SV(cx->blk_sub.cv); \
372 if (sv && (CvDEPTH((const CV*)sv) = cx->blk_sub.olddepth)) \
376 #define LEAVESUB(sv) \
382 #define POPFORMAT(cx) \
383 setdefout(cx->blk_format.dfoutgv); \
384 SvREFCNT_dec(cx->blk_format.dfoutgv);
388 OP * retop; /* op to execute on exit from eval */
389 /* Above here is the same for sub, format and eval. */
394 JMPENV * cur_top_env; /* value of PL_top_env when eval CX created */
397 /* If we ever need more than 512 op types, change the shift from 7.
398 blku_gimme is actually also only 2 bits, so could be merged with something.
401 #define CxOLD_IN_EVAL(cx) (((cx)->blk_u16) & 0x7F)
402 #define CxOLD_OP_TYPE(cx) (((cx)->blk_u16) >> 7)
404 #define PUSHEVAL(cx,n) \
406 assert(!(PL_in_eval & ~0x7F)); \
407 assert(!(PL_op->op_type & ~0x1FF)); \
408 cx->blk_u16 = (PL_in_eval & 0x7F) | ((U16)PL_op->op_type << 7); \
409 cx->blk_eval.old_namesv = (n ? newSVpv(n,0) : NULL); \
410 cx->blk_eval.old_eval_root = PL_eval_root; \
411 cx->blk_eval.cur_text = PL_parser ? PL_parser->linestr : NULL; \
412 cx->blk_eval.cv = NULL; /* set by doeval(), as applicable */ \
413 cx->blk_eval.retop = NULL; \
414 cx->blk_eval.cur_top_env = PL_top_env; \
417 #define POPEVAL(cx) \
419 PL_in_eval = CxOLD_IN_EVAL(cx); \
420 optype = CxOLD_OP_TYPE(cx); \
421 PL_eval_root = cx->blk_eval.old_eval_root; \
422 if (cx->blk_eval.old_namesv) \
423 sv_2mortal(cx->blk_eval.old_namesv); \
429 LOOP * my_op; /* My op, that contains redo, next and last ops. */
430 /* (except for non_ithreads we need to modify next_op in pp_ctl.c, hence
431 why next_op is conditionally defined below.) */
433 PAD *oldcomppad; /* Also used for the GV, if targoffset is 0 */
434 /* This is also accesible via cx->blk_loop.my_op->op_targ */
435 PADOFFSET targoffset;
441 struct { /* valid if type is LOOP_FOR or LOOP_PLAIN (but {NULL,0})*/
442 AV * ary; /* use the stack if this is NULL */
445 struct { /* valid if type is LOOP_LAZYIV */
449 struct { /* valid if type if LOOP_LAZYSV */
451 SV * end; /* maxiumum value (or minimum in reverse) */
457 # define CxITERVAR(c) \
458 ((c)->blk_loop.oldcomppad \
460 ? &CX_CURPAD_SV( (c)->blk_loop, (c)->blk_loop.targoffset ) \
461 : &GvSV((GV*)(c)->blk_loop.oldcomppad)) \
463 # define CX_ITERDATA_SET(cx,idata,o) \
464 if ((cx->blk_loop.targoffset = (o))) \
465 CX_CURPAD_SAVE(cx->blk_loop); \
467 cx->blk_loop.oldcomppad = (idata);
469 # define CxITERVAR(c) ((c)->blk_loop.itervar)
470 # define CX_ITERDATA_SET(cx,ivar,o) \
471 cx->blk_loop.itervar = (SV**)(ivar);
473 #define CxLABEL(c) (0 + CopLABEL((c)->blk_oldcop))
474 #define CxHASARGS(c) (((c)->cx_type & CXp_HASARGS) == CXp_HASARGS)
475 #define CxLVAL(c) (0 + (c)->blk_u16)
478 # define PUSHLOOP_OP_NEXT /* No need to do anything. */
479 # define CX_LOOP_NEXTOP_GET(cx) ((cx)->blk_loop.my_op->op_nextop + 0)
481 # define PUSHLOOP_OP_NEXT cx->blk_loop.next_op = cLOOP->op_nextop
482 # define CX_LOOP_NEXTOP_GET(cx) ((cx)->blk_loop.next_op + 0)
485 #define PUSHLOOP_PLAIN(cx, s) \
486 cx->blk_loop.resetsp = s - PL_stack_base; \
487 cx->blk_loop.my_op = cLOOP; \
489 cx->blk_loop.state_u.ary.ary = NULL; \
490 cx->blk_loop.state_u.ary.ix = 0; \
491 CX_ITERDATA_SET(cx, NULL, 0);
493 #define PUSHLOOP_FOR(cx, dat, s, offset) \
494 cx->blk_loop.resetsp = s - PL_stack_base; \
495 cx->blk_loop.my_op = cLOOP; \
497 cx->blk_loop.state_u.ary.ary = NULL; \
498 cx->blk_loop.state_u.ary.ix = 0; \
499 CX_ITERDATA_SET(cx, dat, offset);
501 #define POPLOOP(cx) \
502 if (CxTYPE(cx) == CXt_LOOP_LAZYSV) { \
503 SvREFCNT_dec(cx->blk_loop.state_u.lazysv.cur); \
504 SvREFCNT_dec(cx->blk_loop.state_u.lazysv.end); \
506 if (CxTYPE(cx) == CXt_LOOP_FOR) \
507 SvREFCNT_dec(cx->blk_loop.state_u.ary.ary);
509 /* given/when context */
510 struct block_givwhen {
514 #define PUSHGIVEN(cx) \
515 cx->blk_givwhen.leave_op = cLOGOP->op_other;
517 #define PUSHWHEN PUSHGIVEN
519 /* context common to subroutines, evals and loops */
521 U8 blku_type; /* what kind of context this is */
522 U8 blku_gimme; /* is this block running in list context? */
523 U16 blku_u16; /* used by block_sub and block_eval (so far) */
524 I32 blku_oldsp; /* stack pointer to copy stuff down to */
525 COP * blku_oldcop; /* old curcop pointer */
526 I32 blku_oldmarksp; /* mark stack index */
527 I32 blku_oldscopesp; /* scope stack index */
528 PMOP * blku_oldpm; /* values of pattern match vars */
531 struct block_sub blku_sub;
532 struct block_format blku_format;
533 struct block_eval blku_eval;
534 struct block_loop blku_loop;
535 struct block_givwhen blku_givwhen;
538 #define blk_oldsp cx_u.cx_blk.blku_oldsp
539 #define blk_oldcop cx_u.cx_blk.blku_oldcop
540 #define blk_oldmarksp cx_u.cx_blk.blku_oldmarksp
541 #define blk_oldscopesp cx_u.cx_blk.blku_oldscopesp
542 #define blk_oldpm cx_u.cx_blk.blku_oldpm
543 #define blk_gimme cx_u.cx_blk.blku_gimme
544 #define blk_u16 cx_u.cx_blk.blku_u16
545 #define blk_sub cx_u.cx_blk.blk_u.blku_sub
546 #define blk_format cx_u.cx_blk.blk_u.blku_format
547 #define blk_eval cx_u.cx_blk.blk_u.blku_eval
548 #define blk_loop cx_u.cx_blk.blk_u.blku_loop
549 #define blk_givwhen cx_u.cx_blk.blk_u.blku_givwhen
552 #define PUSHBLOCK(cx,t,sp) CXINC, cx = &cxstack[cxstack_ix], \
554 cx->blk_oldsp = sp - PL_stack_base, \
555 cx->blk_oldcop = PL_curcop, \
556 cx->blk_oldmarksp = PL_markstack_ptr - PL_markstack, \
557 cx->blk_oldscopesp = PL_scopestack_ix, \
558 cx->blk_oldpm = PL_curpm, \
559 cx->blk_gimme = (U8)gimme; \
560 DEBUG_l( PerlIO_printf(Perl_debug_log, "Entering block %ld, type %s\n", \
561 (long)cxstack_ix, PL_block_type[CxTYPE(cx)]); )
563 /* Exit a block (RETURN and LAST). */
564 #define POPBLOCK(cx,pm) cx = &cxstack[cxstack_ix--], \
565 newsp = PL_stack_base + cx->blk_oldsp, \
566 PL_curcop = cx->blk_oldcop, \
567 PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp, \
568 PL_scopestack_ix = cx->blk_oldscopesp, \
569 pm = cx->blk_oldpm, \
570 gimme = cx->blk_gimme; \
571 DEBUG_SCOPE("POPBLOCK"); \
572 DEBUG_l( PerlIO_printf(Perl_debug_log, "Leaving block %ld, type %s\n", \
573 (long)cxstack_ix+1,PL_block_type[CxTYPE(cx)]); )
575 /* Continue a block elsewhere (NEXT and REDO). */
576 #define TOPBLOCK(cx) cx = &cxstack[cxstack_ix], \
577 PL_stack_sp = PL_stack_base + cx->blk_oldsp, \
578 PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp, \
579 PL_scopestack_ix = cx->blk_oldscopesp, \
580 PL_curpm = cx->blk_oldpm; \
581 DEBUG_SCOPE("TOPBLOCK");
583 /* substitution context */
585 U8 sbu_type; /* what kind of context this is */
587 U16 sbu_rxtainted; /* matches struct block */
600 #define sb_iters cx_u.cx_subst.sbu_iters
601 #define sb_maxiters cx_u.cx_subst.sbu_maxiters
602 #define sb_rflags cx_u.cx_subst.sbu_rflags
603 #define sb_oldsave cx_u.cx_subst.sbu_oldsave
604 #define sb_once cx_u.cx_subst.sbu_once
605 #define sb_rxtainted cx_u.cx_subst.sbu_rxtainted
606 #define sb_orig cx_u.cx_subst.sbu_orig
607 #define sb_dstr cx_u.cx_subst.sbu_dstr
608 #define sb_targ cx_u.cx_subst.sbu_targ
609 #define sb_s cx_u.cx_subst.sbu_s
610 #define sb_m cx_u.cx_subst.sbu_m
611 #define sb_strend cx_u.cx_subst.sbu_strend
612 #define sb_rxres cx_u.cx_subst.sbu_rxres
613 #define sb_rx cx_u.cx_subst.sbu_rx
616 # define PUSHSUBST(cx) CXINC, cx = &cxstack[cxstack_ix], \
617 cx->sb_iters = iters, \
618 cx->sb_maxiters = maxiters, \
619 cx->sb_rflags = r_flags, \
620 cx->sb_oldsave = oldsave, \
621 cx->sb_rxtainted = rxtainted, \
622 cx->sb_orig = orig, \
623 cx->sb_dstr = dstr, \
624 cx->sb_targ = targ, \
627 cx->sb_strend = strend, \
628 cx->sb_rxres = NULL, \
630 cx->cx_type = CXt_SUBST | (once ? CXp_ONCE : 0); \
631 rxres_save(&cx->sb_rxres, rx); \
632 (void)ReREFCNT_inc(rx)
634 # define POPSUBST(cx) cx = &cxstack[cxstack_ix--]; \
635 rxres_free(&cx->sb_rxres); \
636 ReREFCNT_dec(cx->sb_rx)
639 #define CxONCE(cx) ((cx)->cx_type & CXp_ONCE)
644 struct subst cx_subst;
647 #define cx_type cx_u.cx_subst.sbu_type
649 /* If you re-order these, there is also an array of uppercase names in perl.h
650 and a static array of context names in pp_ctl.c */
651 #define CXTYPEMASK 0xf
655 /* When micro-optimising :-) keep GIVEN next to the LOOPs, as these 5 share a
656 jump table in pp_ctl.c
657 The first 4 don't have a 'case' in at least one switch statement in pp_ctl.c
660 /* This is first so that CXt_LOOP_FOR|CXt_LOOP_LAZYIV is CXt_LOOP_LAZYIV */
661 #define CXt_LOOP_FOR 4
662 #define CXt_LOOP_PLAIN 5
663 #define CXt_LOOP_LAZYSV 6
664 #define CXt_LOOP_LAZYIV 7
669 /* SUBST doesn't feature in all switch statements. */
671 /* private flags for CXt_SUB and CXt_NULL
672 However, this is checked in many places which do not check the type, so
673 this bit needs to be kept clear for most everything else. For reasons I
674 haven't investigated, it can coexist with CXp_FOR_DEF */
675 #define CXp_MULTICALL 0x10 /* part of a multicall (so don't
676 tear down context on exit). */
678 /* private flags for CXt_SUB and CXt_FORMAT */
679 #define CXp_HASARGS 0x20
681 /* private flags for CXt_EVAL */
682 #define CXp_REAL 0x20 /* truly eval'', not a lookalike */
683 #define CXp_TRYBLOCK 0x40 /* eval{}, not eval'' or similar */
685 /* private flags for CXt_LOOP */
686 #define CXp_FOR_DEF 0x10 /* foreach using $_ */
688 # define CxPADLOOP(c) ((c)->blk_loop.targoffset)
691 /* private flags for CXt_SUBST */
692 #define CXp_ONCE 0x10 /* What was sbu_once in struct subst */
694 #define CxTYPE(c) ((c)->cx_type & CXTYPEMASK)
695 #define CxTYPE_is_LOOP(c) (((c)->cx_type & 0xC) == 0x4)
696 #define CxMULTICALL(c) (((c)->cx_type & CXp_MULTICALL) \
698 #define CxREALEVAL(c) (((c)->cx_type & (CXTYPEMASK|CXp_REAL)) \
699 == (CXt_EVAL|CXp_REAL))
700 #define CxTRYBLOCK(c) (((c)->cx_type & (CXTYPEMASK|CXp_TRYBLOCK)) \
701 == (CXt_EVAL|CXp_TRYBLOCK))
702 #define CxFOREACH(c) (CxTYPE_is_LOOP(c) && CxTYPE(c) != CXt_LOOP_PLAIN)
703 #define CxFOREACHDEF(c) ((CxTYPE_is_LOOP(c) && CxTYPE(c) != CXt_LOOP_PLAIN) \
704 && ((c)->cx_type & CXp_FOR_DEF))
706 #define CXINC (cxstack_ix < cxstack_max ? ++cxstack_ix : (cxstack_ix = cxinc()))
709 =head1 "Gimme" Values
713 =for apidoc AmU||G_SCALAR
714 Used to indicate scalar context. See C<GIMME_V>, C<GIMME>, and
717 =for apidoc AmU||G_ARRAY
718 Used to indicate list context. See C<GIMME_V>, C<GIMME> and
721 =for apidoc AmU||G_VOID
722 Used to indicate void context. See C<GIMME_V> and L<perlcall>.
724 =for apidoc AmU||G_DISCARD
725 Indicates that arguments returned from a callback should be discarded. See
728 =for apidoc AmU||G_EVAL
730 Used to force a Perl C<eval> wrapper around a callback. See
733 =for apidoc AmU||G_NOARGS
735 Indicates that no arguments are being sent to a callback. See
746 /* extra flags for Perl_call_* routines */
747 #define G_DISCARD 4 /* Call FREETMPS.
748 Don't change this without consulting the
749 hash actions codes defined in hv.h */
750 #define G_EVAL 8 /* Assume eval {} around subroutine call. */
751 #define G_NOARGS 16 /* Don't construct a @_ array. */
752 #define G_KEEPERR 32 /* Append errors to $@, don't overwrite it */
753 #define G_NODEBUG 64 /* Disable debugging at toplevel. */
754 #define G_METHOD 128 /* Calling method. */
755 #define G_FAKINGEVAL 256 /* Faking an eval context for call_sv or
758 /* flag bits for PL_in_eval */
759 #define EVAL_NULL 0 /* not in an eval */
760 #define EVAL_INEVAL 1 /* some enclosing scope is an eval */
761 #define EVAL_WARNONLY 2 /* used by yywarn() when calling yyerror() */
762 #define EVAL_KEEPERR 4 /* set by Perl_call_sv if G_KEEPERR */
763 #define EVAL_INREQUIRE 8 /* The code is being required. */
765 /* Support for switching (stack and block) contexts.
766 * This ensures magic doesn't invalidate local stack and cx pointers.
769 #define PERLSI_UNKNOWN -1
770 #define PERLSI_UNDEF 0
771 #define PERLSI_MAIN 1
772 #define PERLSI_MAGIC 2
773 #define PERLSI_SORT 3
774 #define PERLSI_SIGNAL 4
775 #define PERLSI_OVERLOAD 5
776 #define PERLSI_DESTROY 6
777 #define PERLSI_WARNHOOK 7
778 #define PERLSI_DIEHOOK 8
779 #define PERLSI_REQUIRE 9
782 AV * si_stack; /* stack for current runlevel */
783 PERL_CONTEXT * si_cxstack; /* context stack for runlevel */
784 struct stackinfo * si_prev;
785 struct stackinfo * si_next;
786 I32 si_cxix; /* current context index */
787 I32 si_cxmax; /* maximum allocated index */
788 I32 si_type; /* type of runlevel */
789 I32 si_markoff; /* offset where markstack begins for us.
790 * currently used only with DEBUGGING,
791 * but not #ifdef-ed for bincompat */
794 typedef struct stackinfo PERL_SI;
796 #define cxstack (PL_curstackinfo->si_cxstack)
797 #define cxstack_ix (PL_curstackinfo->si_cxix)
798 #define cxstack_max (PL_curstackinfo->si_cxmax)
801 # define SET_MARK_OFFSET \
802 PL_curstackinfo->si_markoff = PL_markstack_ptr - PL_markstack
804 # define SET_MARK_OFFSET NOOP
807 #define PUSHSTACKi(type) \
809 PERL_SI *next = PL_curstackinfo->si_next; \
811 next = new_stackinfo(32, 2048/sizeof(PERL_CONTEXT) - 1); \
812 next->si_prev = PL_curstackinfo; \
813 PL_curstackinfo->si_next = next; \
815 next->si_type = type; \
816 next->si_cxix = -1; \
817 AvFILLp(next->si_stack) = 0; \
818 SWITCHSTACK(PL_curstack,next->si_stack); \
819 PL_curstackinfo = next; \
823 #define PUSHSTACK PUSHSTACKi(PERLSI_UNKNOWN)
825 /* POPSTACK works with PL_stack_sp, so it may need to be bracketed by
826 * PUTBACK/SPAGAIN to flush/refresh any local SP that may be active */
830 PERL_SI * const prev = PL_curstackinfo->si_prev; \
832 PerlIO_printf(Perl_error_log, "panic: POPSTACK\n"); \
835 SWITCHSTACK(PL_curstack,prev->si_stack); \
836 /* don't free prev here, free them all at the END{} */ \
837 PL_curstackinfo = prev; \
840 #define POPSTACK_TO(s) \
842 while (PL_curstack != s) { \
848 #define IN_PERL_COMPILETIME (PL_curcop == &PL_compiling)
849 #define IN_PERL_RUNTIME (PL_curcop != &PL_compiling)
852 =head1 Multicall Functions
854 =for apidoc Ams||dMULTICALL
855 Declare local variables for a multicall. See L<perlcall/Lightweight Callbacks>.
857 =for apidoc Ams||PUSH_MULTICALL
858 Opening bracket for a lightweight callback.
859 See L<perlcall/Lightweight Callbacks>.
861 =for apidoc Ams||MULTICALL
862 Make a lightweight callback. See L<perlcall/Lightweight Callbacks>.
864 =for apidoc Ams||POP_MULTICALL
865 Closing bracket for a lightweight callback.
866 See L<perlcall/Lightweight Callbacks>.
872 SV **newsp; /* set by POPBLOCK */ \
876 bool multicall_oldcatch; \
877 U8 hasargs = 0 /* used by PUSHSUB */
879 #define PUSH_MULTICALL(the_cv) \
881 CV * const _nOnclAshIngNamE_ = the_cv; \
882 CV * const cv = _nOnclAshIngNamE_; \
883 AV * const padlist = CvPADLIST(cv); \
885 multicall_oldcatch = CATCH_GET; \
886 SAVETMPS; SAVEVPTR(PL_op); \
888 PUSHSTACKi(PERLSI_SORT); \
889 PUSHBLOCK(cx, CXt_SUB|CXp_MULTICALL, PL_stack_sp); \
891 if (++CvDEPTH(cv) >= 2) { \
892 PERL_STACK_OVERFLOW_CHECK(); \
893 Perl_pad_push(aTHX_ padlist, CvDEPTH(cv)); \
896 PAD_SET_CUR_NOSAVE(padlist, CvDEPTH(cv)); \
898 multicall_cop = CvSTART(cv); \
903 PL_op = multicall_cop; \
907 #define POP_MULTICALL \
909 LEAVESUB(multicall_cv); \
910 CvDEPTH(multicall_cv)--; \
911 POPBLOCK(cx,PL_curpm); \
913 CATCH_SET(multicall_oldcatch); \
920 * c-indentation-style: bsd
922 * indent-tabs-mode: t
925 * ex: set ts=8 sts=4 sw=4 noet: