3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006 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 &cur_env, 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 PL_top_env, cur_env.je_prev)); \
117 PL_top_env = cur_env.je_prev; \
120 #define JMPENV_JUMP(v) \
123 if (PL_top_env->je_prev) \
124 PerlProc_longjmp(PL_top_env->je_buf, (v)); \
126 PerlProc_exit(STATUS_EXIT); \
127 PerlIO_printf(PerlIO_stderr(), "panic: top_env\n"); \
131 #define CATCH_GET (PL_top_env->je_mustcatch)
132 #define CATCH_SET(v) (PL_top_env->je_mustcatch = (v))
138 char * cop_label; /* label for this construct */
140 char * cop_stashpv; /* package line was compiled in */
141 char * cop_file; /* file name the following line # is from */
143 HV * cop_stash; /* package line was compiled in */
144 GV * cop_filegv; /* file the following line # is from */
146 U32 cop_seq; /* parse sequence number */
147 I32 cop_arybase; /* array base this line was compiled with */
148 line_t cop_line; /* line # of this command */
149 /* Beware. mg.c and warnings.pl assume the type of this is STRLEN *: */
150 STRLEN * cop_warnings; /* lexical warnings bitmask */
151 SV * cop_io; /* lexical IO defaults */
152 /* compile time state of %^H. See the comment in op.c for how this is
153 used to recreate a hash to return from caller. */
154 struct refcounted_he * cop_hints;
158 # define CopFILE(c) ((c)->cop_file)
159 # define CopFILEGV(c) (CopFILE(c) \
160 ? gv_fetchfile(CopFILE(c)) : NULL)
163 # define CopFILE_set(c,pv) ((c)->cop_file = savepv(pv))
165 # define CopFILE_set(c,pv) ((c)->cop_file = savesharedpv(pv))
168 # define CopFILESV(c) (CopFILE(c) \
169 ? GvSV(gv_fetchfile(CopFILE(c))) : NULL)
170 # define CopFILEAV(c) (CopFILE(c) \
171 ? GvAV(gv_fetchfile(CopFILE(c))) : NULL)
173 # define CopFILEAVx(c) (assert(CopFILE(c)), \
174 GvAV(gv_fetchfile(CopFILE(c))))
176 # define CopFILEAVx(c) (GvAV(gv_fetchfile(CopFILE(c))))
178 # define CopSTASHPV(c) ((c)->cop_stashpv)
181 # define CopSTASHPV_set(c,pv) ((c)->cop_stashpv = ((pv) ? savepv(pv) : NULL))
183 # define CopSTASHPV_set(c,pv) ((c)->cop_stashpv = savesharedpv(pv))
186 # define CopSTASH(c) (CopSTASHPV(c) \
187 ? gv_stashpv(CopSTASHPV(c),GV_ADD) : NULL)
188 # define CopSTASH_set(c,hv) CopSTASHPV_set(c, (hv) ? HvNAME_get(hv) : NULL)
189 # define CopSTASH_eq(c,hv) ((hv) && stashpv_hvname_match(c,hv))
191 # define CopSTASH_free(c) SAVECOPSTASH_FREE(c)
192 # define CopFILE_free(c) SAVECOPFILE_FREE(c)
194 # define CopSTASH_free(c) PerlMemShared_free(CopSTASHPV(c))
195 # define CopFILE_free(c) (PerlMemShared_free(CopFILE(c)),(CopFILE(c) = NULL))
198 # define CopFILEGV(c) ((c)->cop_filegv)
199 # define CopFILEGV_set(c,gv) ((c)->cop_filegv = (GV*)SvREFCNT_inc(gv))
200 # define CopFILE_set(c,pv) CopFILEGV_set((c), gv_fetchfile(pv))
201 # define CopFILESV(c) (CopFILEGV(c) ? GvSV(CopFILEGV(c)) : NULL)
202 # define CopFILEAV(c) (CopFILEGV(c) ? GvAV(CopFILEGV(c)) : NULL)
204 # define CopFILEAVx(c) (assert(CopFILEGV(c)), GvAV(CopFILEGV(c)))
206 # define CopFILEAVx(c) (GvAV(CopFILEGV(c)))
208 # define CopFILE(c) (CopFILESV(c) ? SvPVX(CopFILESV(c)) : NULL)
209 # define CopSTASH(c) ((c)->cop_stash)
210 # define CopSTASH_set(c,hv) ((c)->cop_stash = (hv))
211 # define CopSTASHPV(c) (CopSTASH(c) ? HvNAME_get(CopSTASH(c)) : NULL)
212 /* cop_stash is not refcounted */
213 # define CopSTASHPV_set(c,pv) CopSTASH_set((c), gv_stashpv(pv,GV_ADD))
214 # define CopSTASH_eq(c,hv) (CopSTASH(c) == (hv))
215 # define CopSTASH_free(c)
216 # define CopFILE_free(c) (SvREFCNT_dec(CopFILEGV(c)),(CopFILEGV(c) = NULL))
218 #endif /* USE_ITHREADS */
220 #define CopSTASH_ne(c,hv) (!CopSTASH_eq(c,hv))
221 #define CopLINE(c) ((c)->cop_line)
222 #define CopLINE_inc(c) (++CopLINE(c))
223 #define CopLINE_dec(c) (--CopLINE(c))
224 #define CopLINE_set(c,l) (CopLINE(c) = (l))
226 /* OutCopFILE() is CopFILE for output (caller, die, warn, etc.) */
227 #ifdef MACOS_TRADITIONAL
228 # define OutCopFILE(c) MacPerl_MPWFileName(CopFILE(c))
230 # define OutCopFILE(c) CopFILE(c)
233 /* CopARYBASE is likely to be removed soon. */
234 #define CopARYBASE(c) ((c)->cop_arybase)
235 #define CopARYBASE_get(c) ((c)->cop_arybase + 0)
236 #define CopARYBASE_set(c, b) STMT_START { (c)->cop_arybase = (b); } STMT_END
238 /* FIXME NATIVE_HINTS if this is changed from op_private (see perl.h) */
239 #define CopHINTS_get(c) ((c)->op_private + 0)
240 #define CopHINTS_set(c, h) STMT_START { \
242 = (U8)((h) & HINT_PRIVATE_MASK); \
246 * Here we have some enormously heavy (or at least ponderous) wizardry.
249 /* subroutine context */
258 U8 lval; /* XXX merge lval and hasargs? */
260 OP * retop; /* op to execute on exit from sub */
263 /* base for the next two macros. Don't use directly.
264 * Note that the refcnt of the cv is incremented twice; The CX one is
265 * decremented by LEAVESUB, the other by LEAVE. */
267 #define PUSHSUB_BASE(cx) \
268 cx->blk_sub.cv = cv; \
269 cx->blk_sub.olddepth = CvDEPTH(cv); \
270 cx->blk_sub.hasargs = hasargs; \
271 cx->blk_sub.retop = NULL; \
272 if (!CvDEPTH(cv)) { \
273 SvREFCNT_inc_void(cv); \
274 SvREFCNT_inc_void(cv); \
279 #define PUSHSUB(cx) \
281 cx->blk_sub.lval = PL_op->op_private & \
282 (OPpLVAL_INTRO|OPpENTERSUB_INARGS);
284 /* variant for use by OP_DBSTATE, where op_private holds hint bits */
285 #define PUSHSUB_DB(cx) \
287 cx->blk_sub.lval = 0;
290 #define PUSHFORMAT(cx) \
291 cx->blk_sub.cv = cv; \
292 cx->blk_sub.gv = gv; \
293 cx->blk_sub.retop = NULL; \
294 cx->blk_sub.hasargs = 0; \
295 cx->blk_sub.dfoutgv = PL_defoutgv; \
296 SvREFCNT_inc_void(cx->blk_sub.dfoutgv)
298 #define POP_SAVEARRAY() \
300 SvREFCNT_dec(GvAV(PL_defgv)); \
301 GvAV(PL_defgv) = cx->blk_sub.savearray; \
304 /* junk in @_ spells trouble when cloning CVs and in pp_caller(), so don't
305 * leave any (a fast av_clear(ary), basically) */
306 #define CLEAR_ARGARRAY(ary) \
308 AvMAX(ary) += AvARRAY(ary) - AvALLOC(ary); \
309 SvPV_set(ary, (char*)AvALLOC(ary)); \
313 #define POPSUB(cx,sv) \
315 if (cx->blk_sub.hasargs) { \
317 /* abandon @_ if it got reified */ \
318 if (AvREAL(cx->blk_sub.argarray)) { \
319 SSize_t fill = AvFILLp(cx->blk_sub.argarray); \
320 SvREFCNT_dec(cx->blk_sub.argarray); \
321 cx->blk_sub.argarray = newAV(); \
322 av_extend(cx->blk_sub.argarray, fill); \
323 AvREIFY_only(cx->blk_sub.argarray); \
324 CX_CURPAD_SV(cx->blk_sub, 0) = (SV*)cx->blk_sub.argarray; \
327 CLEAR_ARGARRAY(cx->blk_sub.argarray); \
330 sv = (SV*)cx->blk_sub.cv; \
331 if (sv && (CvDEPTH((CV*)sv) = cx->blk_sub.olddepth)) \
335 #define LEAVESUB(sv) \
341 #define POPFORMAT(cx) \
342 setdefout(cx->blk_sub.dfoutgv); \
343 SvREFCNT_dec(cx->blk_sub.dfoutgv);
353 OP * retop; /* op to execute on exit from eval */
354 JMPENV * cur_top_env; /* value of PL_top_env when eval CX created */
357 #define PUSHEVAL(cx,n,fgv) \
359 cx->blk_eval.old_in_eval = PL_in_eval; \
360 cx->blk_eval.old_op_type = PL_op->op_type; \
361 cx->blk_eval.old_namesv = (n ? newSVpv(n,0) : NULL); \
362 cx->blk_eval.old_eval_root = PL_eval_root; \
363 cx->blk_eval.cur_text = PL_linestr; \
364 cx->blk_eval.cv = NULL; /* set by doeval(), as applicable */ \
365 cx->blk_eval.retop = NULL; \
366 cx->blk_eval.cur_top_env = PL_top_env; \
369 #define POPEVAL(cx) \
371 PL_in_eval = cx->blk_eval.old_in_eval; \
372 optype = cx->blk_eval.old_op_type; \
373 PL_eval_root = cx->blk_eval.old_eval_root; \
374 if (cx->blk_eval.old_namesv) \
375 sv_2mortal(cx->blk_eval.old_namesv); \
399 # define CxITERVAR(c) \
400 ((c)->blk_loop.iterdata \
402 ? &CX_CURPAD_SV( (c)->blk_loop, \
403 INT2PTR(PADOFFSET, (c)->blk_loop.iterdata)) \
404 : &GvSV((GV*)(c)->blk_loop.iterdata)) \
406 # define CX_ITERDATA_SET(cx,idata) \
407 CX_CURPAD_SAVE(cx->blk_loop); \
408 if ((cx->blk_loop.iterdata = (idata))) \
409 cx->blk_loop.itersave = SvREFCNT_inc(*CxITERVAR(cx)); \
411 cx->blk_loop.itersave = NULL;
413 # define CxITERVAR(c) ((c)->blk_loop.itervar)
414 # define CX_ITERDATA_SET(cx,ivar) \
415 if ((cx->blk_loop.itervar = (SV**)(ivar))) \
416 cx->blk_loop.itersave = SvREFCNT_inc(*CxITERVAR(cx)); \
418 cx->blk_loop.itersave = NULL;
421 #define PUSHLOOP(cx, dat, s) \
422 cx->blk_loop.label = PL_curcop->cop_label; \
423 cx->blk_loop.resetsp = s - PL_stack_base; \
424 cx->blk_loop.redo_op = cLOOP->op_redoop; \
425 cx->blk_loop.next_op = cLOOP->op_nextop; \
426 cx->blk_loop.last_op = cLOOP->op_lastop; \
427 cx->blk_loop.iterlval = NULL; \
428 cx->blk_loop.iterary = NULL; \
429 cx->blk_loop.iterix = -1; \
430 CX_ITERDATA_SET(cx,dat);
432 #define POPLOOP(cx) \
433 SvREFCNT_dec(cx->blk_loop.iterlval); \
434 if (CxITERVAR(cx)) { \
435 if (SvPADMY(cx->blk_loop.itersave)) { \
436 SV ** const s_v_p = CxITERVAR(cx); \
437 sv_2mortal(*s_v_p); \
438 *s_v_p = cx->blk_loop.itersave; \
441 SvREFCNT_dec(cx->blk_loop.itersave); \
444 if (cx->blk_loop.iterary && cx->blk_loop.iterary != PL_curstack)\
445 SvREFCNT_dec(cx->blk_loop.iterary);
447 /* given/when context */
448 struct block_givwhen {
452 #define PUSHGIVEN(cx) \
453 cx->blk_givwhen.leave_op = cLOGOP->op_other;
455 #define PUSHWHEN PUSHGIVEN
457 /* context common to subroutines, evals and loops */
459 I32 blku_oldsp; /* stack pointer to copy stuff down to */
460 COP * blku_oldcop; /* old curcop pointer */
461 I32 blku_oldmarksp; /* mark stack index */
462 I32 blku_oldscopesp; /* scope stack index */
463 PMOP * blku_oldpm; /* values of pattern match vars */
464 U8 blku_gimme; /* is this block running in list context? */
467 struct block_sub blku_sub;
468 struct block_eval blku_eval;
469 struct block_loop blku_loop;
470 struct block_givwhen blku_givwhen;
473 #define blk_oldsp cx_u.cx_blk.blku_oldsp
474 #define blk_oldcop cx_u.cx_blk.blku_oldcop
475 #define blk_oldmarksp cx_u.cx_blk.blku_oldmarksp
476 #define blk_oldscopesp cx_u.cx_blk.blku_oldscopesp
477 #define blk_oldpm cx_u.cx_blk.blku_oldpm
478 #define blk_gimme cx_u.cx_blk.blku_gimme
479 #define blk_sub cx_u.cx_blk.blk_u.blku_sub
480 #define blk_eval cx_u.cx_blk.blk_u.blku_eval
481 #define blk_loop cx_u.cx_blk.blk_u.blku_loop
482 #define blk_givwhen cx_u.cx_blk.blk_u.blku_givwhen
485 #define PUSHBLOCK(cx,t,sp) CXINC, cx = &cxstack[cxstack_ix], \
487 cx->blk_oldsp = sp - PL_stack_base, \
488 cx->blk_oldcop = PL_curcop, \
489 cx->blk_oldmarksp = PL_markstack_ptr - PL_markstack, \
490 cx->blk_oldscopesp = PL_scopestack_ix, \
491 cx->blk_oldpm = PL_curpm, \
492 cx->blk_gimme = (U8)gimme; \
493 DEBUG_l( PerlIO_printf(Perl_debug_log, "Entering block %ld, type %s\n", \
494 (long)cxstack_ix, PL_block_type[CxTYPE(cx)]); )
496 /* Exit a block (RETURN and LAST). */
497 #define POPBLOCK(cx,pm) cx = &cxstack[cxstack_ix--], \
498 newsp = PL_stack_base + cx->blk_oldsp, \
499 PL_curcop = cx->blk_oldcop, \
500 PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp, \
501 PL_scopestack_ix = cx->blk_oldscopesp, \
502 pm = cx->blk_oldpm, \
503 gimme = cx->blk_gimme; \
504 DEBUG_SCOPE("POPBLOCK"); \
505 DEBUG_l( PerlIO_printf(Perl_debug_log, "Leaving block %ld, type %s\n", \
506 (long)cxstack_ix+1,PL_block_type[CxTYPE(cx)]); )
508 /* Continue a block elsewhere (NEXT and REDO). */
509 #define TOPBLOCK(cx) cx = &cxstack[cxstack_ix], \
510 PL_stack_sp = PL_stack_base + cx->blk_oldsp, \
511 PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp, \
512 PL_scopestack_ix = cx->blk_oldscopesp, \
513 PL_curpm = cx->blk_oldpm; \
514 DEBUG_SCOPE("TOPBLOCK");
516 /* substitution context */
533 #define sb_iters cx_u.cx_subst.sbu_iters
534 #define sb_maxiters cx_u.cx_subst.sbu_maxiters
535 #define sb_rflags cx_u.cx_subst.sbu_rflags
536 #define sb_oldsave cx_u.cx_subst.sbu_oldsave
537 #define sb_once cx_u.cx_subst.sbu_once
538 #define sb_rxtainted cx_u.cx_subst.sbu_rxtainted
539 #define sb_orig cx_u.cx_subst.sbu_orig
540 #define sb_dstr cx_u.cx_subst.sbu_dstr
541 #define sb_targ cx_u.cx_subst.sbu_targ
542 #define sb_s cx_u.cx_subst.sbu_s
543 #define sb_m cx_u.cx_subst.sbu_m
544 #define sb_strend cx_u.cx_subst.sbu_strend
545 #define sb_rxres cx_u.cx_subst.sbu_rxres
546 #define sb_rx cx_u.cx_subst.sbu_rx
548 #define PUSHSUBST(cx) CXINC, cx = &cxstack[cxstack_ix], \
549 cx->sb_iters = iters, \
550 cx->sb_maxiters = maxiters, \
551 cx->sb_rflags = r_flags, \
552 cx->sb_oldsave = oldsave, \
553 cx->sb_once = once, \
554 cx->sb_rxtainted = rxtainted, \
555 cx->sb_orig = orig, \
556 cx->sb_dstr = dstr, \
557 cx->sb_targ = targ, \
560 cx->sb_strend = strend, \
561 cx->sb_rxres = NULL, \
563 cx->cx_type = CXt_SUBST; \
564 rxres_save(&cx->sb_rxres, rx)
566 #define POPSUBST(cx) cx = &cxstack[cxstack_ix--]; \
567 rxres_free(&cx->sb_rxres)
570 U32 cx_type; /* what kind of context this is */
573 struct subst cx_subst;
577 #define CXTYPEMASK 0xff
588 /* private flags for CXt_SUB and CXt_NULL */
589 #define CXp_MULTICALL 0x00000400 /* part of a multicall (so don't
590 tear down context on exit). */
592 /* private flags for CXt_EVAL */
593 #define CXp_REAL 0x00000100 /* truly eval'', not a lookalike */
594 #define CXp_TRYBLOCK 0x00000200 /* eval{}, not eval'' or similar */
596 /* private flags for CXt_LOOP */
597 #define CXp_FOREACH 0x00000200 /* a foreach loop */
598 #define CXp_FOR_DEF 0x00000400 /* foreach using $_ */
600 # define CXp_PADVAR 0x00000100 /* itervar lives on pad, iterdata
601 has pad offset; if not set,
602 iterdata holds GV* */
603 # define CxPADLOOP(c) (((c)->cx_type & (CXt_LOOP|CXp_PADVAR)) \
604 == (CXt_LOOP|CXp_PADVAR))
607 #define CxTYPE(c) ((c)->cx_type & CXTYPEMASK)
608 #define CxMULTICALL(c) (((c)->cx_type & CXp_MULTICALL) \
610 #define CxREALEVAL(c) (((c)->cx_type & (CXt_EVAL|CXp_REAL)) \
611 == (CXt_EVAL|CXp_REAL))
612 #define CxTRYBLOCK(c) (((c)->cx_type & (CXt_EVAL|CXp_TRYBLOCK)) \
613 == (CXt_EVAL|CXp_TRYBLOCK))
614 #define CxFOREACH(c) (((c)->cx_type & (CXt_LOOP|CXp_FOREACH)) \
615 == (CXt_LOOP|CXp_FOREACH))
616 #define CxFOREACHDEF(c) (((c)->cx_type & (CXt_LOOP|CXp_FOREACH|CXp_FOR_DEF))\
617 == (CXt_LOOP|CXp_FOREACH|CXp_FOR_DEF))
619 #define CXINC (cxstack_ix < cxstack_max ? ++cxstack_ix : (cxstack_ix = cxinc()))
622 =head1 "Gimme" Values
626 =for apidoc AmU||G_SCALAR
627 Used to indicate scalar context. See C<GIMME_V>, C<GIMME>, and
630 =for apidoc AmU||G_ARRAY
631 Used to indicate list context. See C<GIMME_V>, C<GIMME> and
634 =for apidoc AmU||G_VOID
635 Used to indicate void context. See C<GIMME_V> and L<perlcall>.
637 =for apidoc AmU||G_DISCARD
638 Indicates that arguments returned from a callback should be discarded. See
641 =for apidoc AmU||G_EVAL
643 Used to force a Perl C<eval> wrapper around a callback. See
646 =for apidoc AmU||G_NOARGS
648 Indicates that no arguments are being sent to a callback. See
656 #define G_VOID 128 /* skip this bit when adding flags below */
658 /* extra flags for Perl_call_* routines */
659 #define G_DISCARD 2 /* Call FREETMPS. */
660 #define G_EVAL 4 /* Assume eval {} around subroutine call. */
661 #define G_NOARGS 8 /* Don't construct a @_ array. */
662 #define G_KEEPERR 16 /* Append errors to $@, don't overwrite it */
663 #define G_NODEBUG 32 /* Disable debugging at toplevel. */
664 #define G_METHOD 64 /* Calling method. */
665 #define G_FAKINGEVAL 256 /* Faking en eval context for call_sv or
668 /* flag bits for PL_in_eval */
669 #define EVAL_NULL 0 /* not in an eval */
670 #define EVAL_INEVAL 1 /* some enclosing scope is an eval */
671 #define EVAL_WARNONLY 2 /* used by yywarn() when calling yyerror() */
672 #define EVAL_KEEPERR 4 /* set by Perl_call_sv if G_KEEPERR */
673 #define EVAL_INREQUIRE 8 /* The code is being required. */
675 /* Support for switching (stack and block) contexts.
676 * This ensures magic doesn't invalidate local stack and cx pointers.
679 #define PERLSI_UNKNOWN -1
680 #define PERLSI_UNDEF 0
681 #define PERLSI_MAIN 1
682 #define PERLSI_MAGIC 2
683 #define PERLSI_SORT 3
684 #define PERLSI_SIGNAL 4
685 #define PERLSI_OVERLOAD 5
686 #define PERLSI_DESTROY 6
687 #define PERLSI_WARNHOOK 7
688 #define PERLSI_DIEHOOK 8
689 #define PERLSI_REQUIRE 9
692 AV * si_stack; /* stack for current runlevel */
693 PERL_CONTEXT * si_cxstack; /* context stack for runlevel */
694 I32 si_cxix; /* current context index */
695 I32 si_cxmax; /* maximum allocated index */
696 I32 si_type; /* type of runlevel */
697 struct stackinfo * si_prev;
698 struct stackinfo * si_next;
699 I32 si_markoff; /* offset where markstack begins for us.
700 * currently used only with DEBUGGING,
701 * but not #ifdef-ed for bincompat */
704 typedef struct stackinfo PERL_SI;
706 #define cxstack (PL_curstackinfo->si_cxstack)
707 #define cxstack_ix (PL_curstackinfo->si_cxix)
708 #define cxstack_max (PL_curstackinfo->si_cxmax)
711 # define SET_MARK_OFFSET \
712 PL_curstackinfo->si_markoff = PL_markstack_ptr - PL_markstack
714 # define SET_MARK_OFFSET NOOP
717 #define PUSHSTACKi(type) \
719 PERL_SI *next = PL_curstackinfo->si_next; \
721 next = new_stackinfo(32, 2048/sizeof(PERL_CONTEXT) - 1); \
722 next->si_prev = PL_curstackinfo; \
723 PL_curstackinfo->si_next = next; \
725 next->si_type = type; \
726 next->si_cxix = -1; \
727 AvFILLp(next->si_stack) = 0; \
728 SWITCHSTACK(PL_curstack,next->si_stack); \
729 PL_curstackinfo = next; \
733 #define PUSHSTACK PUSHSTACKi(PERLSI_UNKNOWN)
735 /* POPSTACK works with PL_stack_sp, so it may need to be bracketed by
736 * PUTBACK/SPAGAIN to flush/refresh any local SP that may be active */
740 PERL_SI * const prev = PL_curstackinfo->si_prev; \
742 PerlIO_printf(Perl_error_log, "panic: POPSTACK\n"); \
745 SWITCHSTACK(PL_curstack,prev->si_stack); \
746 /* don't free prev here, free them all at the END{} */ \
747 PL_curstackinfo = prev; \
750 #define POPSTACK_TO(s) \
752 while (PL_curstack != s) { \
758 #define IN_PERL_COMPILETIME (PL_curcop == &PL_compiling)
759 #define IN_PERL_RUNTIME (PL_curcop != &PL_compiling)
762 =head1 Multicall Functions
764 =for apidoc Ams||dMULTICALL
765 Declare local variables for a multicall. See L<perlcall/Lightweight Callbacks>.
767 =for apidoc Ams||PUSH_MULTICALL
768 Opening bracket for a lightweight callback.
769 See L<perlcall/Lightweight Callbacks>.
771 =for apidoc Ams||MULTICALL
772 Make a lightweight callback. See L<perlcall/Lightweight Callbacks>.
774 =for apidoc Ams||POP_MULTICALL
775 Closing bracket for a lightweight callback.
776 See L<perlcall/Lightweight Callbacks>.
782 SV **newsp; /* set by POPBLOCK */ \
786 bool multicall_oldcatch; \
787 U8 hasargs = 0 /* used by PUSHSUB */
789 #define PUSH_MULTICALL(the_cv) \
791 CV * const _nOnclAshIngNamE_ = the_cv; \
792 CV * const cv = _nOnclAshIngNamE_; \
793 AV * const padlist = CvPADLIST(cv); \
795 multicall_oldcatch = CATCH_GET; \
796 SAVETMPS; SAVEVPTR(PL_op); \
798 PUSHBLOCK(cx, CXt_SUB|CXp_MULTICALL, PL_stack_sp); \
800 if (++CvDEPTH(cv) >= 2) { \
801 PERL_STACK_OVERFLOW_CHECK(); \
802 Perl_pad_push(aTHX_ padlist, CvDEPTH(cv)); \
805 PAD_SET_CUR_NOSAVE(padlist, CvDEPTH(cv)); \
807 multicall_cop = CvSTART(cv); \
812 PL_op = multicall_cop; \
816 #define POP_MULTICALL \
818 LEAVESUB(multicall_cv); \
819 CvDEPTH(multicall_cv)--; \
820 POPBLOCK(cx,PL_curpm); \
821 CATCH_SET(multicall_oldcatch); \
827 * c-indentation-style: bsd
829 * indent-tabs-mode: t
832 * ex: set ts=8 sts=4 sw=4 noet: