3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4 * 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 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 two ops OP_NEXTSTATE and OP_DBSTATE,
10 * 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 PL_start_env initialized when perl starts, and
18 * PL_top_env points to this initially, so PL_top_env should always be
21 * Existence of a non-null PL_top_env->je_prev implies it is valid to call
22 * longjmp() at that runlevel (we make sure PL_start_env.je_prev is always
23 * null to ensure this).
25 * je_mustcatch, when set at any runlevel to TRUE, means eval ops must
26 * establish a local jmpenv to handle exception traps. Care must be taken
27 * to restore the previous value of je_mustcatch before exiting the
28 * stack frame iff JMPENV_PUSH was not called in that stack frame.
33 struct jmpenv * je_prev;
34 Sigjmp_buf je_buf; /* only for use if !je_throw */
35 int je_ret; /* last exception thrown */
36 bool je_mustcatch; /* need to call longjmp()? */
39 typedef struct jmpenv JMPENV;
42 #define OP_REG_TO_MEM PL_opsave = op
43 #define OP_MEM_TO_REG op = PL_opsave
45 #define OP_REG_TO_MEM NOOP
46 #define OP_MEM_TO_REG NOOP
50 * How to build the first jmpenv.
52 * top_env needs to be non-zero. It points to an area
53 * in which longjmp() stuff is stored, as C callstack
54 * info there at least is thread specific this has to
55 * be per-thread. Otherwise a 'die' in a thread gives
56 * that thread the C stack of last thread to do an eval {}!
59 #define JMPENV_BOOTSTRAP \
61 Zero(&PL_start_env, 1, JMPENV); \
62 PL_start_env.je_ret = -1; \
63 PL_start_env.je_mustcatch = TRUE; \
64 PL_top_env = &PL_start_env; \
68 * PERL_FLEXIBLE_EXCEPTIONS
70 * All the flexible exceptions code has been removed.
71 * See the following threads for details:
73 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2004-07/msg00378.html
75 * Joshua's original patches (which weren't applied) and discussion:
77 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg01396.html
78 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg01489.html
79 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg01491.html
80 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg01608.html
81 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg02144.html
82 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg02998.html
84 * Chip's reworked patch and discussion:
86 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1999-03/msg00520.html
88 * The flaw in these patches (which went unnoticed at the time) was
89 * that they moved some code that could potentially die() out of the
90 * region protected by the setjmp()s. This caused exceptions within
91 * END blocks and such to not be handled by the correct setjmp().
93 * The original patches that introduces flexible exceptions were:
95 * http://public.activestate.com/cgi-bin/perlbrowse?patch=3386
96 * http://public.activestate.com/cgi-bin/perlbrowse?patch=5162
99 #define dJMPENV JMPENV cur_env
101 #define JMPENV_PUSH(v) \
104 int i = 0; JMPENV *p = PL_top_env; \
105 while (p) { i++; p = p->je_prev; } \
106 Perl_deb(aTHX_ "push JUMPLEVEL %d (now %p, was %p) at %s:%d\n",\
107 i, (void*)&cur_env, (void*)PL_top_env, \
108 __FILE__, __LINE__);}) \
109 cur_env.je_prev = PL_top_env; \
111 cur_env.je_ret = PerlProc_setjmp(cur_env.je_buf, SCOPE_SAVES_SIGNAL_MASK); \
113 PL_top_env = &cur_env; \
114 cur_env.je_mustcatch = FALSE; \
115 (v) = cur_env.je_ret; \
121 int i = -1; JMPENV *p = PL_top_env; \
122 while (p) { i++; p = p->je_prev; } \
123 Perl_deb(aTHX_ "pop JUMPLEVEL %d (now %p, was %p) at %s:%d\n",\
124 i, (void*)cur_env.je_prev, (void*)PL_top_env, \
125 __FILE__, __LINE__);}) \
126 assert(PL_top_env == &cur_env); \
127 PL_top_env = cur_env.je_prev; \
130 #define JMPENV_JUMP(v) \
133 int i = -1; JMPENV *p = PL_top_env; \
134 while (p) { i++; p = p->je_prev; } \
135 Perl_deb(aTHX_ "JUMP JUMPLEVEL %d (%p) at %s:%d\n", \
136 i, (void*)PL_top_env, \
137 __FILE__, __LINE__);}) \
139 if (PL_top_env->je_prev) \
140 PerlProc_longjmp(PL_top_env->je_buf, (v)); \
142 PerlProc_exit(STATUS_EXIT); \
143 PerlIO_printf(PerlIO_stderr(), "panic: top_env\n"); \
147 #define CATCH_GET (PL_top_env->je_mustcatch)
148 #define CATCH_SET(v) \
152 "JUMPLEVEL set catch %d => %d (for %p) at %s:%d\n", \
153 PL_top_env->je_mustcatch, v, (void*)PL_top_env, \
154 __FILE__, __LINE__);) \
155 PL_top_env->je_mustcatch = (v); \
159 #include "mydtrace.h"
163 /* On LP64 putting this here takes advantage of the fact that BASEOP isn't
164 an exact multiple of 8 bytes to save structure padding. */
165 line_t cop_line; /* line # of this command */
166 /* label for this construct is now stored in cop_hints_hash */
168 char * cop_stashpv; /* package line was compiled in */
169 char * cop_file; /* file name the following line # is from */
171 HV * cop_stash; /* package line was compiled in */
172 GV * cop_filegv; /* file the following line # is from */
174 U32 cop_hints; /* hints bits from pragmata */
175 U32 cop_seq; /* parse sequence number */
176 /* Beware. mg.c and warnings.pl assume the type of this is STRLEN *: */
177 STRLEN * cop_warnings; /* lexical warnings bitmask */
178 /* compile time state of %^H. See the comment in op.c for how this is
179 used to recreate a hash to return from caller. */
180 struct refcounted_he * cop_hints_hash;
184 # define CopFILE(c) ((c)->cop_file)
185 # define CopFILEGV(c) (CopFILE(c) \
186 ? gv_fetchfile(CopFILE(c)) : NULL)
189 # define CopFILE_set(c,pv) ((c)->cop_file = savepv(pv))
190 # define CopFILE_setn(c,pv,l) ((c)->cop_file = savepv((pv),(l)))
192 # define CopFILE_set(c,pv) ((c)->cop_file = savesharedpv(pv))
193 # define CopFILE_setn(c,pv,l) ((c)->cop_file = savesharedpvn((pv),(l)))
196 # define CopFILESV(c) (CopFILE(c) \
197 ? GvSV(gv_fetchfile(CopFILE(c))) : NULL)
198 # define CopFILEAV(c) (CopFILE(c) \
199 ? GvAV(gv_fetchfile(CopFILE(c))) : NULL)
201 # define CopFILEAVx(c) (assert(CopFILE(c)), \
202 GvAV(gv_fetchfile(CopFILE(c))))
204 # define CopFILEAVx(c) (GvAV(gv_fetchfile(CopFILE(c))))
206 # define CopSTASHPV(c) ((c)->cop_stashpv)
209 # define CopSTASHPV_set(c,pv) ((c)->cop_stashpv = ((pv) ? savepv(pv) : NULL))
211 # define CopSTASHPV_set(c,pv) ((c)->cop_stashpv = savesharedpv(pv))
214 # define CopSTASH(c) (CopSTASHPV(c) \
215 ? gv_stashpv(CopSTASHPV(c),GV_ADD) : NULL)
216 # define CopSTASH_set(c,hv) CopSTASHPV_set(c, (hv) ? HvNAME_get(hv) : NULL)
217 # define CopSTASH_eq(c,hv) ((hv) && stashpv_hvname_match(c,hv))
219 # define CopSTASH_free(c) SAVECOPSTASH_FREE(c)
220 # define CopFILE_free(c) SAVECOPFILE_FREE(c)
222 # define CopSTASH_free(c) PerlMemShared_free(CopSTASHPV(c))
223 # define CopFILE_free(c) (PerlMemShared_free(CopFILE(c)),(CopFILE(c) = NULL))
226 # define CopFILEGV(c) ((c)->cop_filegv)
227 # define CopFILEGV_set(c,gv) ((c)->cop_filegv = (GV*)SvREFCNT_inc(gv))
228 # define CopFILE_set(c,pv) CopFILEGV_set((c), gv_fetchfile(pv))
229 # define CopFILE_setn(c,pv,l) CopFILEGV_set((c), gv_fetchfile_flags((pv),(l),0))
230 # define CopFILESV(c) (CopFILEGV(c) ? GvSV(CopFILEGV(c)) : NULL)
231 # define CopFILEAV(c) (CopFILEGV(c) ? GvAV(CopFILEGV(c)) : NULL)
233 # define CopFILEAVx(c) (assert(CopFILEGV(c)), GvAV(CopFILEGV(c)))
235 # define CopFILEAVx(c) (GvAV(CopFILEGV(c)))
237 # define CopFILE(c) (CopFILEGV(c) && GvSV(CopFILEGV(c)) \
238 ? SvPVX(GvSV(CopFILEGV(c))) : NULL)
239 # define CopSTASH(c) ((c)->cop_stash)
240 # define CopSTASH_set(c,hv) ((c)->cop_stash = (hv))
241 # define CopSTASHPV(c) (CopSTASH(c) ? HvNAME_get(CopSTASH(c)) : NULL)
242 /* cop_stash is not refcounted */
243 # define CopSTASHPV_set(c,pv) CopSTASH_set((c), gv_stashpv(pv,GV_ADD))
244 # define CopSTASH_eq(c,hv) (CopSTASH(c) == (hv))
245 # define CopSTASH_free(c)
246 # define CopFILE_free(c) (SvREFCNT_dec(CopFILEGV(c)),(CopFILEGV(c) = NULL))
248 #endif /* USE_ITHREADS */
249 #define CopLABEL(c) Perl_fetch_cop_label(aTHX_ (c)->cop_hints_hash, NULL, NULL)
250 #define CopLABEL_alloc(pv) ((pv)?savepv(pv):NULL)
252 #define CopSTASH_ne(c,hv) (!CopSTASH_eq(c,hv))
253 #define CopLINE(c) ((c)->cop_line)
254 #define CopLINE_inc(c) (++CopLINE(c))
255 #define CopLINE_dec(c) (--CopLINE(c))
256 #define CopLINE_set(c,l) (CopLINE(c) = (l))
258 /* OutCopFILE() is CopFILE for output (caller, die, warn, etc.) */
259 #define OutCopFILE(c) CopFILE(c)
261 /* If $[ is non-zero, it's stored in cop_hints under the key "$[", and
262 HINT_ARYBASE is set to indicate this.
263 Setting it is ineficient due to the need to create 2 mortal SVs, but as
264 using $[ is highly discouraged, no sane Perl code will be using it. */
265 #define CopARYBASE_get(c) \
266 ((CopHINTS_get(c) & HINT_ARYBASE) \
267 ? SvIV(Perl_refcounted_he_fetch(aTHX_ (c)->cop_hints_hash, 0, \
270 #define CopARYBASE_set(c, b) STMT_START { \
271 if (b || ((c)->cop_hints & HINT_ARYBASE)) { \
272 (c)->cop_hints |= HINT_ARYBASE; \
273 if ((c) == &PL_compiling) { \
274 SV *val = newSViv(b); \
275 (void)hv_stores(GvHV(PL_hintgv), "$[", val); \
277 PL_hints |= HINT_ARYBASE; \
279 (c)->cop_hints_hash \
280 = Perl_refcounted_he_new(aTHX_ (c)->cop_hints_hash, \
281 newSVpvs_flags("$[", SVs_TEMP), \
282 sv_2mortal(newSViv(b))); \
287 /* FIXME NATIVE_HINTS if this is changed from op_private (see perl.h) */
288 #define CopHINTS_get(c) ((c)->cop_hints + 0)
289 #define CopHINTS_set(c, h) STMT_START { \
290 (c)->cop_hints = (h); \
294 * Here we have some enormously heavy (or at least ponderous) wizardry.
297 /* subroutine context */
299 OP * retop; /* op to execute on exit from sub */
300 /* Above here is the same for sub, format and eval. */
302 /* Above here is the same for sub and format. */
311 struct block_format {
312 OP * retop; /* op to execute on exit from sub */
313 /* Above here is the same for sub, format and eval. */
315 /* Above here is the same for sub and format. */
320 /* base for the next two macros. Don't use directly.
321 * Note that the refcnt of the cv is incremented twice; The CX one is
322 * decremented by LEAVESUB, the other by LEAVE. */
324 #define PUSHSUB_BASE(cx) \
325 ENTRY_PROBE(GvENAME(CvGV(cv)), \
326 CopFILE((const COP *)CvSTART(cv)), \
327 CopLINE((const COP *)CvSTART(cv))); \
329 cx->blk_sub.cv = cv; \
330 cx->blk_sub.olddepth = CvDEPTH(cv); \
331 cx->cx_type |= (hasargs) ? CXp_HASARGS : 0; \
332 cx->blk_sub.retop = NULL; \
333 if (!CvDEPTH(cv)) { \
334 SvREFCNT_inc_simple_void_NN(cv); \
335 SvREFCNT_inc_simple_void_NN(cv); \
340 #define PUSHSUB(cx) \
342 cx->blk_u16 = PL_op->op_private & \
343 (OPpLVAL_INTRO|OPpENTERSUB_INARGS);
345 /* variant for use by OP_DBSTATE, where op_private holds hint bits */
346 #define PUSHSUB_DB(cx) \
351 #define PUSHFORMAT(cx, retop) \
352 cx->blk_format.cv = cv; \
353 cx->blk_format.gv = gv; \
354 cx->blk_format.retop = (retop); \
355 cx->blk_format.dfoutgv = PL_defoutgv; \
356 SvREFCNT_inc_void(cx->blk_format.dfoutgv)
358 #define POP_SAVEARRAY() \
360 SvREFCNT_dec(GvAV(PL_defgv)); \
361 GvAV(PL_defgv) = cx->blk_sub.savearray; \
364 /* junk in @_ spells trouble when cloning CVs and in pp_caller(), so don't
365 * leave any (a fast av_clear(ary), basically) */
366 #define CLEAR_ARGARRAY(ary) \
368 AvMAX(ary) += AvARRAY(ary) - AvALLOC(ary); \
369 AvARRAY(ary) = AvALLOC(ary); \
373 #define POPSUB(cx,sv) \
375 RETURN_PROBE(GvENAME(CvGV((const CV*)cx->blk_sub.cv)), \
376 CopFILE((COP*)CvSTART((const CV*)cx->blk_sub.cv)), \
377 CopLINE((COP*)CvSTART((const CV*)cx->blk_sub.cv))); \
379 if (CxHASARGS(cx)) { \
381 /* abandon @_ if it got reified */ \
382 if (AvREAL(cx->blk_sub.argarray)) { \
383 const SSize_t fill = AvFILLp(cx->blk_sub.argarray); \
384 SvREFCNT_dec(cx->blk_sub.argarray); \
385 cx->blk_sub.argarray = newAV(); \
386 av_extend(cx->blk_sub.argarray, fill); \
387 AvREIFY_only(cx->blk_sub.argarray); \
388 CX_CURPAD_SV(cx->blk_sub, 0) = MUTABLE_SV(cx->blk_sub.argarray); \
391 CLEAR_ARGARRAY(cx->blk_sub.argarray); \
394 sv = MUTABLE_SV(cx->blk_sub.cv); \
395 if (sv && (CvDEPTH((const CV*)sv) = cx->blk_sub.olddepth)) \
399 #define LEAVESUB(sv) \
405 #define POPFORMAT(cx) \
406 setdefout(cx->blk_format.dfoutgv); \
407 SvREFCNT_dec(cx->blk_format.dfoutgv);
411 OP * retop; /* op to execute on exit from eval */
412 /* Above here is the same for sub, format and eval. */
417 JMPENV * cur_top_env; /* value of PL_top_env when eval CX created */
420 /* If we ever need more than 512 op types, change the shift from 7.
421 blku_gimme is actually also only 2 bits, so could be merged with something.
424 #define CxOLD_IN_EVAL(cx) (((cx)->blk_u16) & 0x7F)
425 #define CxOLD_OP_TYPE(cx) (((cx)->blk_u16) >> 7)
427 #define PUSHEVAL(cx,n) \
429 assert(!(PL_in_eval & ~0x7F)); \
430 assert(!(PL_op->op_type & ~0x1FF)); \
431 cx->blk_u16 = (PL_in_eval & 0x7F) | ((U16)PL_op->op_type << 7); \
432 cx->blk_eval.old_namesv = (n ? newSVpv(n,0) : NULL); \
433 cx->blk_eval.old_eval_root = PL_eval_root; \
434 cx->blk_eval.cur_text = PL_parser ? PL_parser->linestr : NULL; \
435 cx->blk_eval.cv = NULL; /* set by doeval(), as applicable */ \
436 cx->blk_eval.retop = NULL; \
437 cx->blk_eval.cur_top_env = PL_top_env; \
440 #define POPEVAL(cx) \
442 PL_in_eval = CxOLD_IN_EVAL(cx); \
443 optype = CxOLD_OP_TYPE(cx); \
444 PL_eval_root = cx->blk_eval.old_eval_root; \
445 if (cx->blk_eval.old_namesv) \
446 sv_2mortal(cx->blk_eval.old_namesv); \
452 LOOP * my_op; /* My op, that contains redo, next and last ops. */
453 /* (except for non_ithreads we need to modify next_op in pp_ctl.c, hence
454 why next_op is conditionally defined below.) */
456 PAD *oldcomppad; /* Also used for the GV, if targoffset is 0 */
457 /* This is also accesible via cx->blk_loop.my_op->op_targ */
458 PADOFFSET targoffset;
464 struct { /* valid if type is LOOP_FOR or LOOP_PLAIN (but {NULL,0})*/
465 AV * ary; /* use the stack if this is NULL */
468 struct { /* valid if type is LOOP_LAZYIV */
472 struct { /* valid if type if LOOP_LAZYSV */
474 SV * end; /* maxiumum value (or minimum in reverse) */
480 # define CxITERVAR(c) \
481 ((c)->blk_loop.oldcomppad \
483 ? &CX_CURPAD_SV( (c)->blk_loop, (c)->blk_loop.targoffset ) \
484 : &GvSV((GV*)(c)->blk_loop.oldcomppad)) \
486 # define CX_ITERDATA_SET(cx,idata,o) \
487 if ((cx->blk_loop.targoffset = (o))) \
488 CX_CURPAD_SAVE(cx->blk_loop); \
490 cx->blk_loop.oldcomppad = (idata);
492 # define CxITERVAR(c) ((c)->blk_loop.itervar)
493 # define CX_ITERDATA_SET(cx,ivar,o) \
494 cx->blk_loop.itervar = (SV**)(ivar);
496 #define CxLABEL(c) (0 + CopLABEL((c)->blk_oldcop))
497 #define CxHASARGS(c) (((c)->cx_type & CXp_HASARGS) == CXp_HASARGS)
498 #define CxLVAL(c) (0 + (c)->blk_u16)
501 # define PUSHLOOP_OP_NEXT /* No need to do anything. */
502 # define CX_LOOP_NEXTOP_GET(cx) ((cx)->blk_loop.my_op->op_nextop + 0)
504 # define PUSHLOOP_OP_NEXT cx->blk_loop.next_op = cLOOP->op_nextop
505 # define CX_LOOP_NEXTOP_GET(cx) ((cx)->blk_loop.next_op + 0)
508 #define PUSHLOOP_PLAIN(cx, s) \
509 cx->blk_loop.resetsp = s - PL_stack_base; \
510 cx->blk_loop.my_op = cLOOP; \
512 cx->blk_loop.state_u.ary.ary = NULL; \
513 cx->blk_loop.state_u.ary.ix = 0; \
514 CX_ITERDATA_SET(cx, NULL, 0);
516 #define PUSHLOOP_FOR(cx, dat, s, offset) \
517 cx->blk_loop.resetsp = s - PL_stack_base; \
518 cx->blk_loop.my_op = cLOOP; \
520 cx->blk_loop.state_u.ary.ary = NULL; \
521 cx->blk_loop.state_u.ary.ix = 0; \
522 CX_ITERDATA_SET(cx, dat, offset);
524 #define POPLOOP(cx) \
525 if (CxTYPE(cx) == CXt_LOOP_LAZYSV) { \
526 SvREFCNT_dec(cx->blk_loop.state_u.lazysv.cur); \
527 SvREFCNT_dec(cx->blk_loop.state_u.lazysv.end); \
529 if (CxTYPE(cx) == CXt_LOOP_FOR) \
530 SvREFCNT_dec(cx->blk_loop.state_u.ary.ary);
532 /* given/when context */
533 struct block_givwhen {
537 #define PUSHGIVEN(cx) \
538 cx->blk_givwhen.leave_op = cLOGOP->op_other;
540 #define PUSHWHEN PUSHGIVEN
542 /* context common to subroutines, evals and loops */
544 U8 blku_type; /* what kind of context this is */
545 U8 blku_gimme; /* is this block running in list context? */
546 U16 blku_u16; /* used by block_sub and block_eval (so far) */
547 I32 blku_oldsp; /* stack pointer to copy stuff down to */
548 COP * blku_oldcop; /* old curcop pointer */
549 I32 blku_oldmarksp; /* mark stack index */
550 I32 blku_oldscopesp; /* scope stack index */
551 PMOP * blku_oldpm; /* values of pattern match vars */
554 struct block_sub blku_sub;
555 struct block_format blku_format;
556 struct block_eval blku_eval;
557 struct block_loop blku_loop;
558 struct block_givwhen blku_givwhen;
561 #define blk_oldsp cx_u.cx_blk.blku_oldsp
562 #define blk_oldcop cx_u.cx_blk.blku_oldcop
563 #define blk_oldmarksp cx_u.cx_blk.blku_oldmarksp
564 #define blk_oldscopesp cx_u.cx_blk.blku_oldscopesp
565 #define blk_oldpm cx_u.cx_blk.blku_oldpm
566 #define blk_gimme cx_u.cx_blk.blku_gimme
567 #define blk_u16 cx_u.cx_blk.blku_u16
568 #define blk_sub cx_u.cx_blk.blk_u.blku_sub
569 #define blk_format cx_u.cx_blk.blk_u.blku_format
570 #define blk_eval cx_u.cx_blk.blk_u.blku_eval
571 #define blk_loop cx_u.cx_blk.blk_u.blku_loop
572 #define blk_givwhen cx_u.cx_blk.blk_u.blku_givwhen
574 #define DEBUG_CX(action) \
576 Perl_deb(aTHX_ "CX %ld %s %s (scope %ld,%ld) at %s:%d\n", \
579 PL_block_type[CxTYPE(&cxstack[cxstack_ix])], \
580 (long)PL_scopestack_ix, \
581 (long)(cxstack[cxstack_ix].blk_oldscopesp), \
582 __FILE__, __LINE__)));
585 #define PUSHBLOCK(cx,t,sp) CXINC, cx = &cxstack[cxstack_ix], \
587 cx->blk_oldsp = sp - PL_stack_base, \
588 cx->blk_oldcop = PL_curcop, \
589 cx->blk_oldmarksp = PL_markstack_ptr - PL_markstack, \
590 cx->blk_oldscopesp = PL_scopestack_ix, \
591 cx->blk_oldpm = PL_curpm, \
592 cx->blk_gimme = (U8)gimme; \
595 /* Exit a block (RETURN and LAST). */
596 #define POPBLOCK(cx,pm) \
598 cx = &cxstack[cxstack_ix--], \
599 newsp = PL_stack_base + cx->blk_oldsp, \
600 PL_curcop = cx->blk_oldcop, \
601 PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp, \
602 PL_scopestack_ix = cx->blk_oldscopesp, \
603 pm = cx->blk_oldpm, \
604 gimme = cx->blk_gimme;
606 /* Continue a block elsewhere (NEXT and REDO). */
607 #define TOPBLOCK(cx) \
609 cx = &cxstack[cxstack_ix], \
610 PL_stack_sp = PL_stack_base + cx->blk_oldsp, \
611 PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp, \
612 PL_scopestack_ix = cx->blk_oldscopesp, \
613 PL_curpm = cx->blk_oldpm;
615 /* substitution context */
617 U8 sbu_type; /* what kind of context this is */
619 U16 sbu_rxtainted; /* matches struct block */
632 #define sb_iters cx_u.cx_subst.sbu_iters
633 #define sb_maxiters cx_u.cx_subst.sbu_maxiters
634 #define sb_rflags cx_u.cx_subst.sbu_rflags
635 #define sb_oldsave cx_u.cx_subst.sbu_oldsave
636 #define sb_once cx_u.cx_subst.sbu_once
637 #define sb_rxtainted cx_u.cx_subst.sbu_rxtainted
638 #define sb_orig cx_u.cx_subst.sbu_orig
639 #define sb_dstr cx_u.cx_subst.sbu_dstr
640 #define sb_targ cx_u.cx_subst.sbu_targ
641 #define sb_s cx_u.cx_subst.sbu_s
642 #define sb_m cx_u.cx_subst.sbu_m
643 #define sb_strend cx_u.cx_subst.sbu_strend
644 #define sb_rxres cx_u.cx_subst.sbu_rxres
645 #define sb_rx cx_u.cx_subst.sbu_rx
648 # define PUSHSUBST(cx) CXINC, cx = &cxstack[cxstack_ix], \
649 cx->sb_iters = iters, \
650 cx->sb_maxiters = maxiters, \
651 cx->sb_rflags = r_flags, \
652 cx->sb_oldsave = oldsave, \
653 cx->sb_rxtainted = rxtainted, \
654 cx->sb_orig = orig, \
655 cx->sb_dstr = dstr, \
656 cx->sb_targ = targ, \
659 cx->sb_strend = strend, \
660 cx->sb_rxres = NULL, \
662 cx->cx_type = CXt_SUBST | (once ? CXp_ONCE : 0); \
663 rxres_save(&cx->sb_rxres, rx); \
664 (void)ReREFCNT_inc(rx)
666 # define POPSUBST(cx) cx = &cxstack[cxstack_ix--]; \
667 rxres_free(&cx->sb_rxres); \
668 ReREFCNT_dec(cx->sb_rx)
671 #define CxONCE(cx) ((cx)->cx_type & CXp_ONCE)
676 struct subst cx_subst;
679 #define cx_type cx_u.cx_subst.sbu_type
681 /* If you re-order these, there is also an array of uppercase names in perl.h
682 and a static array of context names in pp_ctl.c */
683 #define CXTYPEMASK 0xf
687 /* When micro-optimising :-) keep GIVEN next to the LOOPs, as these 5 share a
688 jump table in pp_ctl.c
689 The first 4 don't have a 'case' in at least one switch statement in pp_ctl.c
692 /* This is first so that CXt_LOOP_FOR|CXt_LOOP_LAZYIV is CXt_LOOP_LAZYIV */
693 #define CXt_LOOP_FOR 4
694 #define CXt_LOOP_PLAIN 5
695 #define CXt_LOOP_LAZYSV 6
696 #define CXt_LOOP_LAZYIV 7
701 /* SUBST doesn't feature in all switch statements. */
703 /* private flags for CXt_SUB and CXt_NULL
704 However, this is checked in many places which do not check the type, so
705 this bit needs to be kept clear for most everything else. For reasons I
706 haven't investigated, it can coexist with CXp_FOR_DEF */
707 #define CXp_MULTICALL 0x10 /* part of a multicall (so don't
708 tear down context on exit). */
710 /* private flags for CXt_SUB and CXt_FORMAT */
711 #define CXp_HASARGS 0x20
713 /* private flags for CXt_EVAL */
714 #define CXp_REAL 0x20 /* truly eval'', not a lookalike */
715 #define CXp_TRYBLOCK 0x40 /* eval{}, not eval'' or similar */
717 /* private flags for CXt_LOOP */
718 #define CXp_FOR_DEF 0x10 /* foreach using $_ */
720 # define CxPADLOOP(c) ((c)->blk_loop.targoffset)
723 /* private flags for CXt_SUBST */
724 #define CXp_ONCE 0x10 /* What was sbu_once in struct subst */
726 #define CxTYPE(c) ((c)->cx_type & CXTYPEMASK)
727 #define CxTYPE_is_LOOP(c) (((c)->cx_type & 0xC) == 0x4)
728 #define CxMULTICALL(c) (((c)->cx_type & CXp_MULTICALL) \
730 #define CxREALEVAL(c) (((c)->cx_type & (CXTYPEMASK|CXp_REAL)) \
731 == (CXt_EVAL|CXp_REAL))
732 #define CxTRYBLOCK(c) (((c)->cx_type & (CXTYPEMASK|CXp_TRYBLOCK)) \
733 == (CXt_EVAL|CXp_TRYBLOCK))
734 #define CxFOREACH(c) (CxTYPE_is_LOOP(c) && CxTYPE(c) != CXt_LOOP_PLAIN)
735 #define CxFOREACHDEF(c) ((CxTYPE_is_LOOP(c) && CxTYPE(c) != CXt_LOOP_PLAIN) \
736 && ((c)->cx_type & CXp_FOR_DEF))
738 #define CXINC (cxstack_ix < cxstack_max ? ++cxstack_ix : (cxstack_ix = cxinc()))
741 =head1 "Gimme" Values
745 =for apidoc AmU||G_SCALAR
746 Used to indicate scalar context. See C<GIMME_V>, C<GIMME>, and
749 =for apidoc AmU||G_ARRAY
750 Used to indicate list context. See C<GIMME_V>, C<GIMME> and
753 =for apidoc AmU||G_VOID
754 Used to indicate void context. See C<GIMME_V> and L<perlcall>.
756 =for apidoc AmU||G_DISCARD
757 Indicates that arguments returned from a callback should be discarded. See
760 =for apidoc AmU||G_EVAL
762 Used to force a Perl C<eval> wrapper around a callback. See
765 =for apidoc AmU||G_NOARGS
767 Indicates that no arguments are being sent to a callback. See
778 /* extra flags for Perl_call_* routines */
779 #define G_DISCARD 4 /* Call FREETMPS.
780 Don't change this without consulting the
781 hash actions codes defined in hv.h */
782 #define G_EVAL 8 /* Assume eval {} around subroutine call. */
783 #define G_NOARGS 16 /* Don't construct a @_ array. */
784 #define G_KEEPERR 32 /* Append errors to $@, don't overwrite it */
785 #define G_NODEBUG 64 /* Disable debugging at toplevel. */
786 #define G_METHOD 128 /* Calling method. */
787 #define G_FAKINGEVAL 256 /* Faking an eval context for call_sv or
790 /* flag bits for PL_in_eval */
791 #define EVAL_NULL 0 /* not in an eval */
792 #define EVAL_INEVAL 1 /* some enclosing scope is an eval */
793 #define EVAL_WARNONLY 2 /* used by yywarn() when calling yyerror() */
794 #define EVAL_KEEPERR 4 /* set by Perl_call_sv if G_KEEPERR */
795 #define EVAL_INREQUIRE 8 /* The code is being required. */
797 /* Support for switching (stack and block) contexts.
798 * This ensures magic doesn't invalidate local stack and cx pointers.
801 #define PERLSI_UNKNOWN -1
802 #define PERLSI_UNDEF 0
803 #define PERLSI_MAIN 1
804 #define PERLSI_MAGIC 2
805 #define PERLSI_SORT 3
806 #define PERLSI_SIGNAL 4
807 #define PERLSI_OVERLOAD 5
808 #define PERLSI_DESTROY 6
809 #define PERLSI_WARNHOOK 7
810 #define PERLSI_DIEHOOK 8
811 #define PERLSI_REQUIRE 9
814 AV * si_stack; /* stack for current runlevel */
815 PERL_CONTEXT * si_cxstack; /* context stack for runlevel */
816 struct stackinfo * si_prev;
817 struct stackinfo * si_next;
818 I32 si_cxix; /* current context index */
819 I32 si_cxmax; /* maximum allocated index */
820 I32 si_type; /* type of runlevel */
821 I32 si_markoff; /* offset where markstack begins for us.
822 * currently used only with DEBUGGING,
823 * but not #ifdef-ed for bincompat */
826 typedef struct stackinfo PERL_SI;
828 #define cxstack (PL_curstackinfo->si_cxstack)
829 #define cxstack_ix (PL_curstackinfo->si_cxix)
830 #define cxstack_max (PL_curstackinfo->si_cxmax)
833 # define SET_MARK_OFFSET \
834 PL_curstackinfo->si_markoff = PL_markstack_ptr - PL_markstack
836 # define SET_MARK_OFFSET NOOP
839 #define PUSHSTACKi(type) \
841 PERL_SI *next = PL_curstackinfo->si_next; \
843 int i = 0; PERL_SI *p = PL_curstackinfo; \
844 while (p) { i++; p = p->si_prev; } \
845 Perl_deb(aTHX_ "push STACKINFO %d at %s:%d\n", \
846 i, __FILE__, __LINE__);}) \
848 next = new_stackinfo(32, 2048/sizeof(PERL_CONTEXT) - 1); \
849 next->si_prev = PL_curstackinfo; \
850 PL_curstackinfo->si_next = next; \
852 next->si_type = type; \
853 next->si_cxix = -1; \
854 AvFILLp(next->si_stack) = 0; \
855 SWITCHSTACK(PL_curstack,next->si_stack); \
856 PL_curstackinfo = next; \
860 #define PUSHSTACK PUSHSTACKi(PERLSI_UNKNOWN)
862 /* POPSTACK works with PL_stack_sp, so it may need to be bracketed by
863 * PUTBACK/SPAGAIN to flush/refresh any local SP that may be active */
867 PERL_SI * const prev = PL_curstackinfo->si_prev; \
869 int i = -1; PERL_SI *p = PL_curstackinfo; \
870 while (p) { i++; p = p->si_prev; } \
871 Perl_deb(aTHX_ "pop STACKINFO %d at %s:%d\n", \
872 i, __FILE__, __LINE__);}) \
874 PerlIO_printf(Perl_error_log, "panic: POPSTACK\n"); \
877 SWITCHSTACK(PL_curstack,prev->si_stack); \
878 /* don't free prev here, free them all at the END{} */ \
879 PL_curstackinfo = prev; \
882 #define POPSTACK_TO(s) \
884 while (PL_curstack != s) { \
890 #define IN_PERL_COMPILETIME (PL_curcop == &PL_compiling)
891 #define IN_PERL_RUNTIME (PL_curcop != &PL_compiling)
894 =head1 Multicall Functions
896 =for apidoc Ams||dMULTICALL
897 Declare local variables for a multicall. See L<perlcall/Lightweight Callbacks>.
899 =for apidoc Ams||PUSH_MULTICALL
900 Opening bracket for a lightweight callback.
901 See L<perlcall/Lightweight Callbacks>.
903 =for apidoc Ams||MULTICALL
904 Make a lightweight callback. See L<perlcall/Lightweight Callbacks>.
906 =for apidoc Ams||POP_MULTICALL
907 Closing bracket for a lightweight callback.
908 See L<perlcall/Lightweight Callbacks>.
914 SV **newsp; /* set by POPBLOCK */ \
918 bool multicall_oldcatch; \
919 U8 hasargs = 0 /* used by PUSHSUB */
921 #define PUSH_MULTICALL(the_cv) \
923 CV * const _nOnclAshIngNamE_ = the_cv; \
924 CV * const cv = _nOnclAshIngNamE_; \
925 AV * const padlist = CvPADLIST(cv); \
927 multicall_oldcatch = CATCH_GET; \
928 SAVETMPS; SAVEVPTR(PL_op); \
930 PUSHSTACKi(PERLSI_SORT); \
931 PUSHBLOCK(cx, CXt_SUB|CXp_MULTICALL, PL_stack_sp); \
933 if (++CvDEPTH(cv) >= 2) { \
934 PERL_STACK_OVERFLOW_CHECK(); \
935 Perl_pad_push(aTHX_ padlist, CvDEPTH(cv)); \
938 PAD_SET_CUR_NOSAVE(padlist, CvDEPTH(cv)); \
940 multicall_cop = CvSTART(cv); \
945 PL_op = multicall_cop; \
949 #define POP_MULTICALL \
951 LEAVESUB(multicall_cv); \
952 CvDEPTH(multicall_cv)--; \
953 POPBLOCK(cx,PL_curpm); \
955 CATCH_SET(multicall_oldcatch); \
962 * c-indentation-style: bsd
964 * indent-tabs-mode: t
967 * ex: set ts=8 sts=4 sw=4 noet: