3 * Copyright (c) 1991-2001, Larry Wall
5 * You may distribute under the terms of either the GNU General Public
6 * License or the Artistic License, as specified in the README file.
12 char * cop_label; /* label for this construct */
14 char * cop_stashpv; /* package line was compiled in */
15 char * cop_file; /* file name the following line # is from */
17 HV * cop_stash; /* package line was compiled in */
18 GV * cop_filegv; /* file the following line # is from */
20 U32 cop_seq; /* parse sequence number */
21 I32 cop_arybase; /* array base this line was compiled with */
22 line_t cop_line; /* line # of this command */
23 SV * cop_warnings; /* lexical warnings bitmask */
24 SV * cop_io; /* lexical IO defaults */
27 #define Nullcop Null(COP*)
30 # define CopFILE(c) ((c)->cop_file)
31 # define CopFILEGV(c) (CopFILE(c) \
32 ? gv_fetchfile(CopFILE(c)) : Nullgv)
33 # define CopFILE_set(c,pv) ((c)->cop_file = savesharedpv(pv))
34 # define CopFILESV(c) (CopFILE(c) \
35 ? GvSV(gv_fetchfile(CopFILE(c))) : Nullsv)
36 # define CopFILEAV(c) (CopFILE(c) \
37 ? GvAV(gv_fetchfile(CopFILE(c))) : Nullav)
38 # define CopSTASHPV(c) ((c)->cop_stashpv)
39 # define CopSTASHPV_set(c,pv) ((c)->cop_stashpv = savesharedpv(pv))
40 # define CopSTASH(c) (CopSTASHPV(c) \
41 ? gv_stashpv(CopSTASHPV(c),GV_ADD) : Nullhv)
42 # define CopSTASH_set(c,hv) CopSTASHPV_set(c, (hv) ? HvNAME(hv) : Nullch)
43 # define CopSTASH_eq(c,hv) ((hv) \
44 && (CopSTASHPV(c) == HvNAME(hv) \
45 || (CopSTASHPV(c) && HvNAME(hv) \
46 && strEQ(CopSTASHPV(c), HvNAME(hv)))))
47 # define CopSTASH_free(c) PerlMemShared_free(CopSTASHPV(c))
48 # define CopFILE_free(c) (PerlMemShared_free(CopFILE(c)),(CopFILE(c) = Nullch))
50 # define CopFILEGV(c) ((c)->cop_filegv)
51 # define CopFILEGV_set(c,gv) ((c)->cop_filegv = (GV*)SvREFCNT_inc(gv))
52 # define CopFILE_set(c,pv) CopFILEGV_set((c), gv_fetchfile(pv))
53 # define CopFILESV(c) (CopFILEGV(c) ? GvSV(CopFILEGV(c)) : Nullsv)
54 # define CopFILEAV(c) (CopFILEGV(c) ? GvAV(CopFILEGV(c)) : Nullav)
55 # define CopFILE(c) (CopFILESV(c) ? SvPVX(CopFILESV(c)) : Nullch)
56 # define CopSTASH(c) ((c)->cop_stash)
57 # define CopSTASH_set(c,hv) ((c)->cop_stash = (hv))
58 # define CopSTASHPV(c) (CopSTASH(c) ? HvNAME(CopSTASH(c)) : Nullch)
59 /* cop_stash is not refcounted */
60 # define CopSTASHPV_set(c,pv) CopSTASH_set((c), gv_stashpv(pv,GV_ADD))
61 # define CopSTASH_eq(c,hv) (CopSTASH(c) == (hv))
62 # define CopSTASH_free(c)
63 # define CopFILE_free(c) (SvREFCNT_dec(CopFILEGV(c)),(CopFILEGV(c) = Nullgv))
65 #endif /* USE_ITHREADS */
67 #define CopSTASH_ne(c,hv) (!CopSTASH_eq(c,hv))
68 #define CopLINE(c) ((c)->cop_line)
69 #define CopLINE_inc(c) (++CopLINE(c))
70 #define CopLINE_dec(c) (--CopLINE(c))
71 #define CopLINE_set(c,l) (CopLINE(c) = (l))
74 * Here we have some enormously heavy (or at least ponderous) wizardry.
77 /* subroutine context */
82 #ifndef USE_5005THREADS
84 #endif /* USE_5005THREADS */
88 U8 lval; /* XXX merge lval and hasargs? */
93 cx->blk_sub.cv = cv; \
94 cx->blk_sub.olddepth = CvDEPTH(cv); \
95 cx->blk_sub.hasargs = hasargs; \
96 cx->blk_sub.lval = PL_op->op_private & \
97 (OPpLVAL_INTRO|OPpENTERSUB_INARGS);
99 #define PUSHFORMAT(cx) \
100 cx->blk_sub.cv = cv; \
101 cx->blk_sub.gv = gv; \
102 cx->blk_sub.hasargs = 0; \
103 cx->blk_sub.dfoutgv = PL_defoutgv; \
104 (void)SvREFCNT_inc(cx->blk_sub.dfoutgv)
106 #ifdef USE_5005THREADS
107 # define POP_SAVEARRAY() NOOP
109 # define POP_SAVEARRAY() \
111 SvREFCNT_dec(GvAV(PL_defgv)); \
112 GvAV(PL_defgv) = cx->blk_sub.savearray; \
114 #endif /* USE_5005THREADS */
116 /* junk in @_ spells trouble when cloning CVs and in pp_caller(), so don't
117 * leave any (a fast av_clear(ary), basically) */
118 #define CLEAR_ARGARRAY(ary) \
120 AvMAX(ary) += AvARRAY(ary) - AvALLOC(ary); \
121 SvPVX(ary) = (char*)AvALLOC(ary); \
125 #define POPSUB(cx,sv) \
127 if (cx->blk_sub.hasargs) { \
129 /* abandon @_ if it got reified */ \
130 if (AvREAL(cx->blk_sub.argarray)) { \
131 SSize_t fill = AvFILLp(cx->blk_sub.argarray); \
132 SvREFCNT_dec(cx->blk_sub.argarray); \
133 cx->blk_sub.argarray = newAV(); \
134 av_extend(cx->blk_sub.argarray, fill); \
135 AvFLAGS(cx->blk_sub.argarray) = AVf_REIFY; \
136 cx->blk_sub.oldcurpad[0] = (SV*)cx->blk_sub.argarray; \
139 CLEAR_ARGARRAY(cx->blk_sub.argarray); \
142 sv = (SV*)cx->blk_sub.cv; \
143 if (sv && (CvDEPTH((CV*)sv) = cx->blk_sub.olddepth)) \
147 #define LEAVESUB(sv) \
153 #define POPFORMAT(cx) \
154 setdefout(cx->blk_sub.dfoutgv); \
155 SvREFCNT_dec(cx->blk_sub.dfoutgv);
167 #define PUSHEVAL(cx,n,fgv) \
169 cx->blk_eval.old_in_eval = PL_in_eval; \
170 cx->blk_eval.old_op_type = PL_op->op_type; \
171 cx->blk_eval.old_namesv = (n ? newSVpv(n,0) : Nullsv); \
172 cx->blk_eval.old_eval_root = PL_eval_root; \
173 cx->blk_eval.cur_text = PL_linestr; \
174 cx->blk_eval.cv = Nullcv; /* set by doeval(), as applicable */ \
177 #define POPEVAL(cx) \
179 PL_in_eval = cx->blk_eval.old_in_eval; \
180 optype = cx->blk_eval.old_op_type; \
181 PL_eval_root = cx->blk_eval.old_eval_root; \
182 if (cx->blk_eval.old_namesv) \
183 sv_2mortal(cx->blk_eval.old_namesv); \
207 # define CxITERVAR(c) \
208 ((c)->blk_loop.iterdata \
210 ? &((c)->blk_loop.oldcurpad)[INT2PTR(PADOFFSET, (c)->blk_loop.iterdata)] \
211 : &GvSV((GV*)(c)->blk_loop.iterdata)) \
213 # define CX_ITERDATA_SET(cx,idata) \
214 cx->blk_loop.oldcurpad = PL_curpad; \
215 if ((cx->blk_loop.iterdata = (idata))) \
216 cx->blk_loop.itersave = SvREFCNT_inc(*CxITERVAR(cx));
218 # define CxITERVAR(c) ((c)->blk_loop.itervar)
219 # define CX_ITERDATA_SET(cx,ivar) \
220 if ((cx->blk_loop.itervar = (SV**)(ivar))) \
221 cx->blk_loop.itersave = SvREFCNT_inc(*CxITERVAR(cx));
224 #define PUSHLOOP(cx, dat, s) \
225 cx->blk_loop.label = PL_curcop->cop_label; \
226 cx->blk_loop.resetsp = s - PL_stack_base; \
227 cx->blk_loop.redo_op = cLOOP->op_redoop; \
228 cx->blk_loop.next_op = cLOOP->op_nextop; \
229 cx->blk_loop.last_op = cLOOP->op_lastop; \
230 cx->blk_loop.iterlval = Nullsv; \
231 cx->blk_loop.iterary = Nullav; \
232 cx->blk_loop.iterix = -1; \
233 CX_ITERDATA_SET(cx,dat);
235 #define POPLOOP(cx) \
236 SvREFCNT_dec(cx->blk_loop.iterlval); \
237 if (CxITERVAR(cx)) { \
238 SV **s_v_p = CxITERVAR(cx); \
239 sv_2mortal(*s_v_p); \
240 *s_v_p = cx->blk_loop.itersave; \
242 if (cx->blk_loop.iterary && cx->blk_loop.iterary != PL_curstack)\
243 SvREFCNT_dec(cx->blk_loop.iterary);
245 /* context common to subroutines, evals and loops */
247 I32 blku_oldsp; /* stack pointer to copy stuff down to */
248 COP * blku_oldcop; /* old curcop pointer */
249 I32 blku_oldretsp; /* return stack index */
250 I32 blku_oldmarksp; /* mark stack index */
251 I32 blku_oldscopesp; /* scope stack index */
252 PMOP * blku_oldpm; /* values of pattern match vars */
253 U8 blku_gimme; /* is this block running in list context? */
256 struct block_sub blku_sub;
257 struct block_eval blku_eval;
258 struct block_loop blku_loop;
261 #define blk_oldsp cx_u.cx_blk.blku_oldsp
262 #define blk_oldcop cx_u.cx_blk.blku_oldcop
263 #define blk_oldretsp cx_u.cx_blk.blku_oldretsp
264 #define blk_oldmarksp cx_u.cx_blk.blku_oldmarksp
265 #define blk_oldscopesp cx_u.cx_blk.blku_oldscopesp
266 #define blk_oldpm cx_u.cx_blk.blku_oldpm
267 #define blk_gimme cx_u.cx_blk.blku_gimme
268 #define blk_sub cx_u.cx_blk.blk_u.blku_sub
269 #define blk_eval cx_u.cx_blk.blk_u.blku_eval
270 #define blk_loop cx_u.cx_blk.blk_u.blku_loop
273 #define PUSHBLOCK(cx,t,sp) CXINC, cx = &cxstack[cxstack_ix], \
275 cx->blk_oldsp = sp - PL_stack_base, \
276 cx->blk_oldcop = PL_curcop, \
277 cx->blk_oldmarksp = PL_markstack_ptr - PL_markstack, \
278 cx->blk_oldscopesp = PL_scopestack_ix, \
279 cx->blk_oldretsp = PL_retstack_ix, \
280 cx->blk_oldpm = PL_curpm, \
281 cx->blk_gimme = gimme; \
282 DEBUG_l( PerlIO_printf(Perl_debug_log, "Entering block %ld, type %s\n", \
283 (long)cxstack_ix, PL_block_type[CxTYPE(cx)]); )
285 /* Exit a block (RETURN and LAST). */
286 #define POPBLOCK(cx,pm) cx = &cxstack[cxstack_ix--], \
287 newsp = PL_stack_base + cx->blk_oldsp, \
288 PL_curcop = cx->blk_oldcop, \
289 PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp, \
290 PL_scopestack_ix = cx->blk_oldscopesp, \
291 PL_retstack_ix = cx->blk_oldretsp, \
292 pm = cx->blk_oldpm, \
293 gimme = cx->blk_gimme; \
294 DEBUG_l( PerlIO_printf(Perl_debug_log, "Leaving block %ld, type %s\n", \
295 (long)cxstack_ix+1,PL_block_type[CxTYPE(cx)]); )
297 /* Continue a block elsewhere (NEXT and REDO). */
298 #define TOPBLOCK(cx) cx = &cxstack[cxstack_ix], \
299 PL_stack_sp = PL_stack_base + cx->blk_oldsp, \
300 PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp, \
301 PL_scopestack_ix = cx->blk_oldscopesp, \
302 PL_retstack_ix = cx->blk_oldretsp, \
303 PL_curpm = cx->blk_oldpm
305 /* substitution context */
322 #define sb_iters cx_u.cx_subst.sbu_iters
323 #define sb_maxiters cx_u.cx_subst.sbu_maxiters
324 #define sb_rflags cx_u.cx_subst.sbu_rflags
325 #define sb_oldsave cx_u.cx_subst.sbu_oldsave
326 #define sb_once cx_u.cx_subst.sbu_once
327 #define sb_rxtainted cx_u.cx_subst.sbu_rxtainted
328 #define sb_orig cx_u.cx_subst.sbu_orig
329 #define sb_dstr cx_u.cx_subst.sbu_dstr
330 #define sb_targ cx_u.cx_subst.sbu_targ
331 #define sb_s cx_u.cx_subst.sbu_s
332 #define sb_m cx_u.cx_subst.sbu_m
333 #define sb_strend cx_u.cx_subst.sbu_strend
334 #define sb_rxres cx_u.cx_subst.sbu_rxres
335 #define sb_rx cx_u.cx_subst.sbu_rx
337 #define PUSHSUBST(cx) CXINC, cx = &cxstack[cxstack_ix], \
338 cx->sb_iters = iters, \
339 cx->sb_maxiters = maxiters, \
340 cx->sb_rflags = r_flags, \
341 cx->sb_oldsave = oldsave, \
342 cx->sb_once = once, \
343 cx->sb_rxtainted = rxtainted, \
344 cx->sb_orig = orig, \
345 cx->sb_dstr = dstr, \
346 cx->sb_targ = targ, \
349 cx->sb_strend = strend, \
350 cx->sb_rxres = Null(void*), \
352 cx->cx_type = CXt_SUBST; \
353 rxres_save(&cx->sb_rxres, rx)
355 #define POPSUBST(cx) cx = &cxstack[cxstack_ix--]; \
356 rxres_free(&cx->sb_rxres)
359 U32 cx_type; /* what kind of context this is */
362 struct subst cx_subst;
366 #define CXTYPEMASK 0xff
375 /* private flags for CXt_EVAL */
376 #define CXp_REAL 0x00000100 /* truly eval'', not a lookalike */
377 #define CXp_TRYBLOCK 0x00000200 /* eval{}, not eval'' or similar */
380 /* private flags for CXt_LOOP */
381 # define CXp_PADVAR 0x00000100 /* itervar lives on pad, iterdata
382 has pad offset; if not set,
383 iterdata holds GV* */
384 # define CxPADLOOP(c) (((c)->cx_type & (CXt_LOOP|CXp_PADVAR)) \
385 == (CXt_LOOP|CXp_PADVAR))
388 #define CxTYPE(c) ((c)->cx_type & CXTYPEMASK)
389 #define CxREALEVAL(c) (((c)->cx_type & (CXt_EVAL|CXp_REAL)) \
390 == (CXt_EVAL|CXp_REAL))
391 #define CxTRYBLOCK(c) (((c)->cx_type & (CXt_EVAL|CXp_TRYBLOCK)) \
392 == (CXt_EVAL|CXp_TRYBLOCK))
394 #define CXINC (cxstack_ix < cxstack_max ? ++cxstack_ix : (cxstack_ix = cxinc()))
397 =head1 "Gimme" Values
401 =for apidoc AmU||G_SCALAR
402 Used to indicate scalar context. See C<GIMME_V>, C<GIMME>, and
405 =for apidoc AmU||G_ARRAY
406 Used to indicate list context. See C<GIMME_V>, C<GIMME> and
409 =for apidoc AmU||G_VOID
410 Used to indicate void context. See C<GIMME_V> and L<perlcall>.
412 =for apidoc AmU||G_DISCARD
413 Indicates that arguments returned from a callback should be discarded. See
416 =for apidoc AmU||G_EVAL
418 Used to force a Perl C<eval> wrapper around a callback. See
421 =for apidoc AmU||G_NOARGS
423 Indicates that no arguments are being sent to a callback. See
431 #define G_VOID 128 /* skip this bit when adding flags below */
433 /* extra flags for Perl_call_* routines */
434 #define G_DISCARD 2 /* Call FREETMPS. */
435 #define G_EVAL 4 /* Assume eval {} around subroutine call. */
436 #define G_NOARGS 8 /* Don't construct a @_ array. */
437 #define G_KEEPERR 16 /* Append errors to $@, don't overwrite it */
438 #define G_NODEBUG 32 /* Disable debugging at toplevel. */
439 #define G_METHOD 64 /* Calling method. */
441 /* flag bits for PL_in_eval */
442 #define EVAL_NULL 0 /* not in an eval */
443 #define EVAL_INEVAL 1 /* some enclosing scope is an eval */
444 #define EVAL_WARNONLY 2 /* used by yywarn() when calling yyerror() */
445 #define EVAL_KEEPERR 4 /* set by Perl_call_sv if G_KEEPERR */
446 #define EVAL_INREQUIRE 8 /* The code is being required. */
448 /* Support for switching (stack and block) contexts.
449 * This ensures magic doesn't invalidate local stack and cx pointers.
452 #define PERLSI_UNKNOWN -1
453 #define PERLSI_UNDEF 0
454 #define PERLSI_MAIN 1
455 #define PERLSI_MAGIC 2
456 #define PERLSI_SORT 3
457 #define PERLSI_SIGNAL 4
458 #define PERLSI_OVERLOAD 5
459 #define PERLSI_DESTROY 6
460 #define PERLSI_WARNHOOK 7
461 #define PERLSI_DIEHOOK 8
462 #define PERLSI_REQUIRE 9
465 AV * si_stack; /* stack for current runlevel */
466 PERL_CONTEXT * si_cxstack; /* context stack for runlevel */
467 I32 si_cxix; /* current context index */
468 I32 si_cxmax; /* maximum allocated index */
469 I32 si_type; /* type of runlevel */
470 struct stackinfo * si_prev;
471 struct stackinfo * si_next;
472 I32 si_markoff; /* offset where markstack begins for us.
473 * currently used only with DEBUGGING,
474 * but not #ifdef-ed for bincompat */
477 typedef struct stackinfo PERL_SI;
479 #define cxstack (PL_curstackinfo->si_cxstack)
480 #define cxstack_ix (PL_curstackinfo->si_cxix)
481 #define cxstack_max (PL_curstackinfo->si_cxmax)
484 # define SET_MARK_OFFSET \
485 PL_curstackinfo->si_markoff = PL_markstack_ptr - PL_markstack
487 # define SET_MARK_OFFSET NOOP
490 #define PUSHSTACKi(type) \
492 PERL_SI *next = PL_curstackinfo->si_next; \
494 next = new_stackinfo(32, 2048/sizeof(PERL_CONTEXT) - 1); \
495 next->si_prev = PL_curstackinfo; \
496 PL_curstackinfo->si_next = next; \
498 next->si_type = type; \
499 next->si_cxix = -1; \
500 AvFILLp(next->si_stack) = 0; \
501 SWITCHSTACK(PL_curstack,next->si_stack); \
502 PL_curstackinfo = next; \
506 #define PUSHSTACK PUSHSTACKi(PERLSI_UNKNOWN)
508 /* POPSTACK works with PL_stack_sp, so it may need to be bracketed by
509 * PUTBACK/SPAGAIN to flush/refresh any local SP that may be active */
513 PERL_SI *prev = PL_curstackinfo->si_prev; \
515 PerlIO_printf(Perl_error_log, "panic: POPSTACK\n"); \
518 SWITCHSTACK(PL_curstack,prev->si_stack); \
519 /* don't free prev here, free them all at the END{} */ \
520 PL_curstackinfo = prev; \
523 #define POPSTACK_TO(s) \
525 while (PL_curstack != s) { \