This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Use PerlMemShared for CopSTASHPV and CopFILE. MUCH harder than it sounds!
[perl5.git] / cop.h
CommitLineData
a0d0e21e 1/* cop.h
79072805 2 *
bc89e66f 3 * Copyright (c) 1991-2001, Larry Wall
79072805
LW
4 *
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.
7 *
79072805
LW
8 */
9
79072805
LW
10struct cop {
11 BASEOP
a0d0e21e 12 char * cop_label; /* label for this construct */
57843af0 13#ifdef USE_ITHREADS
11faa288 14 char * cop_stashpv; /* package line was compiled in */
57843af0
GS
15 char * cop_file; /* file name the following line # is from */
16#else
11faa288 17 HV * cop_stash; /* package line was compiled in */
79072805 18 GV * cop_filegv; /* file the following line # is from */
57843af0 19#endif
a0d0e21e
LW
20 U32 cop_seq; /* parse sequence number */
21 I32 cop_arybase; /* array base this line was compiled with */
79072805 22 line_t cop_line; /* line # of this command */
599cee73 23 SV * cop_warnings; /* lexical warnings bitmask */
ac27b0f5 24 SV * cop_io; /* lexical IO defaults */
79072805
LW
25};
26
27#define Nullcop Null(COP*)
28
57843af0
GS
29#ifdef USE_ITHREADS
30# define CopFILE(c) ((c)->cop_file)
31# define CopFILEGV(c) (CopFILE(c) \
32 ? gv_fetchfile(CopFILE(c)) : Nullgv)
05ec9bb3 33# define CopFILE_set(c,pv) ((c)->cop_file = savesharedpv(pv))
57843af0
GS
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)
57843af0 38# define CopSTASHPV(c) ((c)->cop_stashpv)
05ec9bb3 39# define CopSTASHPV_set(c,pv) ((c)->cop_stashpv = savesharedpv(pv))
11faa288
GS
40# define CopSTASH(c) (CopSTASHPV(c) \
41 ? gv_stashpv(CopSTASHPV(c),GV_ADD) : Nullhv)
7b910cb8 42# define CopSTASH_set(c,hv) CopSTASHPV_set(c, (hv) ? HvNAME(hv) : Nullch)
f4dd75d9 43# define CopSTASH_eq(c,hv) ((hv) \
ed094faf
GS
44 && (CopSTASHPV(c) == HvNAME(hv) \
45 || (CopSTASHPV(c) && HvNAME(hv) \
46 && strEQ(CopSTASHPV(c), HvNAME(hv)))))
05ec9bb3
NIS
47# define CopSTASH_free(c) PerlMemShared_free(CopSTASHPV(c))
48# define CopFILE_free(c) (PerlMemShared_free(CopFILE(c)),(CopFILE(c) = Nullch))
57843af0
GS
49#else
50# define CopFILEGV(c) ((c)->cop_filegv)
f4dd75d9
GS
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))
57843af0
GS
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)
f4dd75d9 57# define CopSTASH_set(c,hv) ((c)->cop_stash = (hv))
57843af0 58# define CopSTASHPV(c) (CopSTASH(c) ? HvNAME(CopSTASH(c)) : Nullch)
f4dd75d9
GS
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))
05ec9bb3
NIS
62# define CopSTASH_free(c)
63# define CopFILE_free(c) (SvREFCNT_dec(CopFILEGV(c)),(CopFILEGV(c) = Nullgv))
64
57843af0
GS
65#endif /* USE_ITHREADS */
66
ed094faf 67#define CopSTASH_ne(c,hv) (!CopSTASH_eq(c,hv))
cc49e20b 68#define CopLINE(c) ((c)->cop_line)
57843af0
GS
69#define CopLINE_inc(c) (++CopLINE(c))
70#define CopLINE_dec(c) (--CopLINE(c))
71#define CopLINE_set(c,l) (CopLINE(c) = (l))
cc49e20b 72
79072805
LW
73/*
74 * Here we have some enormously heavy (or at least ponderous) wizardry.
75 */
76
77/* subroutine context */
78struct block_sub {
79 CV * cv;
80 GV * gv;
463ee0b2 81 GV * dfoutgv;
4d1ff10f 82#ifndef USE_5005THREADS
79072805 83 AV * savearray;
4d1ff10f 84#endif /* USE_5005THREADS */
79072805
LW
85 AV * argarray;
86 U16 olddepth;
87 U8 hasargs;
cd06dffe 88 U8 lval; /* XXX merge lval and hasargs? */
7032098e 89 SV ** oldcurpad;
79072805
LW
90};
91
92#define PUSHSUB(cx) \
93 cx->blk_sub.cv = cv; \
79072805 94 cx->blk_sub.olddepth = CvDEPTH(cv); \
cd06dffe
GS
95 cx->blk_sub.hasargs = hasargs; \
96 cx->blk_sub.lval = PL_op->op_private & \
97 (OPpLVAL_INTRO|OPpENTERSUB_INARGS);
79072805
LW
98
99#define PUSHFORMAT(cx) \
100 cx->blk_sub.cv = cv; \
101 cx->blk_sub.gv = gv; \
4633a7c4 102 cx->blk_sub.hasargs = 0; \
3280af22 103 cx->blk_sub.dfoutgv = PL_defoutgv; \
4633a7c4 104 (void)SvREFCNT_inc(cx->blk_sub.dfoutgv)
79072805 105
4d1ff10f 106#ifdef USE_5005THREADS
7766f137 107# define POP_SAVEARRAY() NOOP
6d4ff0d2 108#else
7766f137 109# define POP_SAVEARRAY() \
6d4ff0d2 110 STMT_START { \
3280af22 111 SvREFCNT_dec(GvAV(PL_defgv)); \
a8bba7fa 112 GvAV(PL_defgv) = cx->blk_sub.savearray; \
6d4ff0d2 113 } STMT_END
4d1ff10f 114#endif /* USE_5005THREADS */
6d4ff0d2 115
ecf8e9dd 116/* junk in @_ spells trouble when cloning CVs and in pp_caller(), so don't
8e09340b
GS
117 * leave any (a fast av_clear(ary), basically) */
118#define CLEAR_ARGARRAY(ary) \
119 STMT_START { \
120 AvMAX(ary) += AvARRAY(ary) - AvALLOC(ary); \
121 SvPVX(ary) = (char*)AvALLOC(ary); \
122 AvFILLp(ary) = -1; \
123 } STMT_END
7766f137 124
b0d9ce38
GS
125#define POPSUB(cx,sv) \
126 STMT_START { \
a8bba7fa 127 if (cx->blk_sub.hasargs) { \
7766f137 128 POP_SAVEARRAY(); \
d8b46c1b 129 /* abandon @_ if it got reified */ \
a8bba7fa
GS
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; \
7032098e 136 cx->blk_sub.oldcurpad[0] = (SV*)cx->blk_sub.argarray; \
d8b46c1b 137 } \
7766f137 138 else { \
8e09340b 139 CLEAR_ARGARRAY(cx->blk_sub.argarray); \
7766f137 140 } \
79072805 141 } \
b0d9ce38
GS
142 sv = (SV*)cx->blk_sub.cv; \
143 if (sv && (CvDEPTH((CV*)sv) = cx->blk_sub.olddepth)) \
144 sv = Nullsv; \
145 } STMT_END
146
147#define LEAVESUB(sv) \
148 STMT_START { \
149 if (sv) \
150 SvREFCNT_dec(sv); \
151 } STMT_END
79072805
LW
152
153#define POPFORMAT(cx) \
4633a7c4
LW
154 setdefout(cx->blk_sub.dfoutgv); \
155 SvREFCNT_dec(cx->blk_sub.dfoutgv);
79072805
LW
156
157/* eval context */
158struct block_eval {
159 I32 old_in_eval;
160 I32 old_op_type;
0f79a09d 161 SV * old_namesv;
79072805 162 OP * old_eval_root;
748a9306 163 SV * cur_text;
2090ab20 164 CV * cv;
79072805
LW
165};
166
8990e307 167#define PUSHEVAL(cx,n,fgv) \
0f79a09d 168 STMT_START { \
3280af22 169 cx->blk_eval.old_in_eval = PL_in_eval; \
a8bba7fa 170 cx->blk_eval.old_op_type = PL_op->op_type; \
0f79a09d 171 cx->blk_eval.old_namesv = (n ? newSVpv(n,0) : Nullsv); \
a8bba7fa 172 cx->blk_eval.old_eval_root = PL_eval_root; \
0f79a09d 173 cx->blk_eval.cur_text = PL_linestr; \
2090ab20 174 cx->blk_eval.cv = Nullcv; /* set by doeval(), as applicable */ \
0f79a09d 175 } STMT_END
79072805
LW
176
177#define POPEVAL(cx) \
0f79a09d 178 STMT_START { \
3280af22 179 PL_in_eval = cx->blk_eval.old_in_eval; \
79072805 180 optype = cx->blk_eval.old_op_type; \
7766f137 181 PL_eval_root = cx->blk_eval.old_eval_root; \
0f79a09d
GS
182 if (cx->blk_eval.old_namesv) \
183 sv_2mortal(cx->blk_eval.old_namesv); \
184 } STMT_END
79072805
LW
185
186/* loop context */
187struct block_loop {
188 char * label;
189 I32 resetsp;
190 OP * redo_op;
191 OP * next_op;
192 OP * last_op;
7766f137
GS
193#ifdef USE_ITHREADS
194 void * iterdata;
9e509370 195 SV ** oldcurpad;
7766f137 196#else
79072805 197 SV ** itervar;
7766f137 198#endif
79072805 199 SV * itersave;
5f05dabc 200 SV * iterlval;
79072805 201 AV * iterary;
89ea2908
GA
202 IV iterix;
203 IV itermax;
79072805
LW
204};
205
7766f137
GS
206#ifdef USE_ITHREADS
207# define CxITERVAR(c) \
208 ((c)->blk_loop.iterdata \
209 ? (CxPADLOOP(cx) \
e830ead6 210 ? &((c)->blk_loop.oldcurpad)[INT2PTR(PADOFFSET, (c)->blk_loop.iterdata)] \
7766f137
GS
211 : &GvSV((GV*)(c)->blk_loop.iterdata)) \
212 : (SV**)NULL)
213# define CX_ITERDATA_SET(cx,idata) \
9e509370 214 cx->blk_loop.oldcurpad = PL_curpad; \
155aba94 215 if ((cx->blk_loop.iterdata = (idata))) \
7766f137
GS
216 cx->blk_loop.itersave = SvREFCNT_inc(*CxITERVAR(cx));
217#else
218# define CxITERVAR(c) ((c)->blk_loop.itervar)
219# define CX_ITERDATA_SET(cx,ivar) \
155aba94 220 if ((cx->blk_loop.itervar = (SV**)(ivar))) \
7766f137
GS
221 cx->blk_loop.itersave = SvREFCNT_inc(*CxITERVAR(cx));
222#endif
223
224#define PUSHLOOP(cx, dat, s) \
38a230cb
GS
225 cx->blk_loop.label = PL_curcop->cop_label; \
226 cx->blk_loop.resetsp = s - PL_stack_base; \
79072805
LW
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; \
44a8e56a
PP
230 cx->blk_loop.iterlval = Nullsv; \
231 cx->blk_loop.iterary = Nullav; \
7766f137
GS
232 cx->blk_loop.iterix = -1; \
233 CX_ITERDATA_SET(cx,dat);
79072805
LW
234
235#define POPLOOP(cx) \
a8bba7fa 236 SvREFCNT_dec(cx->blk_loop.iterlval); \
7766f137
GS
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; \
44a8e56a 241 } \
a8bba7fa
GS
242 if (cx->blk_loop.iterary && cx->blk_loop.iterary != PL_curstack)\
243 SvREFCNT_dec(cx->blk_loop.iterary);
79072805
LW
244
245/* context common to subroutines, evals and loops */
246struct block {
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? */
254
255 union {
256 struct block_sub blku_sub;
257 struct block_eval blku_eval;
258 struct block_loop blku_loop;
259 } blk_u;
260};
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
271
272/* Enter a block. */
8990e307 273#define PUSHBLOCK(cx,t,sp) CXINC, cx = &cxstack[cxstack_ix], \
79072805 274 cx->cx_type = t, \
3280af22
NIS
275 cx->blk_oldsp = sp - PL_stack_base, \
276 cx->blk_oldcop = PL_curcop, \
1aff0e91 277 cx->blk_oldmarksp = PL_markstack_ptr - PL_markstack, \
3280af22 278 cx->blk_oldscopesp = PL_scopestack_ix, \
1aff0e91 279 cx->blk_oldretsp = PL_retstack_ix, \
3280af22 280 cx->blk_oldpm = PL_curpm, \
79072805 281 cx->blk_gimme = gimme; \
bf49b057 282 DEBUG_l( PerlIO_printf(Perl_debug_log, "Entering block %ld, type %s\n", \
1aff0e91 283 (long)cxstack_ix, PL_block_type[CxTYPE(cx)]); )
79072805
LW
284
285/* Exit a block (RETURN and LAST). */
a0d0e21e 286#define POPBLOCK(cx,pm) cx = &cxstack[cxstack_ix--], \
1aff0e91 287 newsp = PL_stack_base + cx->blk_oldsp, \
3280af22
NIS
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; \
bf49b057 294 DEBUG_l( PerlIO_printf(Perl_debug_log, "Leaving block %ld, type %s\n", \
22c35a8c 295 (long)cxstack_ix+1,PL_block_type[CxTYPE(cx)]); )
79072805
LW
296
297/* Continue a block elsewhere (NEXT and REDO). */
3280af22 298#define TOPBLOCK(cx) cx = &cxstack[cxstack_ix], \
1aff0e91 299 PL_stack_sp = PL_stack_base + cx->blk_oldsp, \
3280af22
NIS
300 PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp, \
301 PL_scopestack_ix = cx->blk_oldscopesp, \
2158dd9b
GS
302 PL_retstack_ix = cx->blk_oldretsp, \
303 PL_curpm = cx->blk_oldpm
79072805
LW
304
305/* substitution context */
306struct subst {
307 I32 sbu_iters;
308 I32 sbu_maxiters;
22e551b9 309 I32 sbu_rflags;
4633a7c4 310 I32 sbu_oldsave;
71be2cbc
PP
311 bool sbu_once;
312 bool sbu_rxtainted;
79072805
LW
313 char * sbu_orig;
314 SV * sbu_dstr;
315 SV * sbu_targ;
316 char * sbu_s;
317 char * sbu_m;
318 char * sbu_strend;
c90c0ff4 319 void * sbu_rxres;
c07a80fd 320 REGEXP * sbu_rx;
79072805
LW
321};
322#define sb_iters cx_u.cx_subst.sbu_iters
323#define sb_maxiters cx_u.cx_subst.sbu_maxiters
22e551b9 324#define sb_rflags cx_u.cx_subst.sbu_rflags
4633a7c4 325#define sb_oldsave cx_u.cx_subst.sbu_oldsave
71be2cbc
PP
326#define sb_once cx_u.cx_subst.sbu_once
327#define sb_rxtainted cx_u.cx_subst.sbu_rxtainted
79072805
LW
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
c90c0ff4 334#define sb_rxres cx_u.cx_subst.sbu_rxres
c07a80fd 335#define sb_rx cx_u.cx_subst.sbu_rx
79072805
LW
336
337#define PUSHSUBST(cx) CXINC, cx = &cxstack[cxstack_ix], \
338 cx->sb_iters = iters, \
339 cx->sb_maxiters = maxiters, \
22e551b9 340 cx->sb_rflags = r_flags, \
4633a7c4 341 cx->sb_oldsave = oldsave, \
71be2cbc
PP
342 cx->sb_once = once, \
343 cx->sb_rxtainted = rxtainted, \
79072805
LW
344 cx->sb_orig = orig, \
345 cx->sb_dstr = dstr, \
346 cx->sb_targ = targ, \
347 cx->sb_s = s, \
348 cx->sb_m = m, \
349 cx->sb_strend = strend, \
c90c0ff4 350 cx->sb_rxres = Null(void*), \
c07a80fd 351 cx->sb_rx = rx, \
c90c0ff4
PP
352 cx->cx_type = CXt_SUBST; \
353 rxres_save(&cx->sb_rxres, rx)
79072805 354
c90c0ff4
PP
355#define POPSUBST(cx) cx = &cxstack[cxstack_ix--]; \
356 rxres_free(&cx->sb_rxres)
79072805
LW
357
358struct context {
6b35e009 359 U32 cx_type; /* what kind of context this is */
79072805
LW
360 union {
361 struct block cx_blk;
362 struct subst cx_subst;
363 } cx_u;
364};
6b35e009
GS
365
366#define CXTYPEMASK 0xff
79072805
LW
367#define CXt_NULL 0
368#define CXt_SUB 1
369#define CXt_EVAL 2
370#define CXt_LOOP 3
371#define CXt_SUBST 4
372#define CXt_BLOCK 5
7766f137 373#define CXt_FORMAT 6
79072805 374
6b35e009
GS
375/* private flags for CXt_EVAL */
376#define CXp_REAL 0x00000100 /* truly eval'', not a lookalike */
1d76a5c3 377#define CXp_TRYBLOCK 0x00000200 /* eval{}, not eval'' or similar */
6b35e009 378
7766f137
GS
379#ifdef USE_ITHREADS
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))
386#endif
387
6b35e009 388#define CxTYPE(c) ((c)->cx_type & CXTYPEMASK)
7766f137
GS
389#define CxREALEVAL(c) (((c)->cx_type & (CXt_EVAL|CXp_REAL)) \
390 == (CXt_EVAL|CXp_REAL))
1d76a5c3
GS
391#define CxTRYBLOCK(c) (((c)->cx_type & (CXt_EVAL|CXp_TRYBLOCK)) \
392 == (CXt_EVAL|CXp_TRYBLOCK))
6b35e009 393
79072805
LW
394#define CXINC (cxstack_ix < cxstack_max ? ++cxstack_ix : (cxstack_ix = cxinc()))
395
ccfc67b7
JH
396/*
397=head1 "Gimme" Values
398*/
954c1994
GS
399
400/*
401=for apidoc AmU||G_SCALAR
402Used to indicate scalar context. See C<GIMME_V>, C<GIMME>, and
403L<perlcall>.
404
405=for apidoc AmU||G_ARRAY
91e74348 406Used to indicate list context. See C<GIMME_V>, C<GIMME> and
954c1994
GS
407L<perlcall>.
408
409=for apidoc AmU||G_VOID
410Used to indicate void context. See C<GIMME_V> and L<perlcall>.
411
412=for apidoc AmU||G_DISCARD
413Indicates that arguments returned from a callback should be discarded. See
414L<perlcall>.
415
416=for apidoc AmU||G_EVAL
417
418Used to force a Perl C<eval> wrapper around a callback. See
419L<perlcall>.
420
421=for apidoc AmU||G_NOARGS
422
423Indicates that no arguments are being sent to a callback. See
424L<perlcall>.
425
426=cut
427*/
428
a0d0e21e
LW
429#define G_SCALAR 0
430#define G_ARRAY 1
54310121 431#define G_VOID 128 /* skip this bit when adding flags below */
79072805 432
864dbfa3 433/* extra flags for Perl_call_* routines */
a0d0e21e
LW
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. */
54310121 437#define G_KEEPERR 16 /* Append errors to $@, don't overwrite it */
491527d0 438#define G_NODEBUG 32 /* Disable debugging at toplevel. */
968b3946 439#define G_METHOD 64 /* Calling method. */
e336de0d 440
faef0170
HS
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() */
864dbfa3 445#define EVAL_KEEPERR 4 /* set by Perl_call_sv if G_KEEPERR */
6dc8a9e4 446#define EVAL_INREQUIRE 8 /* The code is being required. */
faef0170 447
e336de0d
GS
448/* Support for switching (stack and block) contexts.
449 * This ensures magic doesn't invalidate local stack and cx pointers.
450 */
451
e788e7d3
GS
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
e336de0d
GS
463
464struct stackinfo {
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;
ce2f7c3b 472 I32 si_markoff; /* offset where markstack begins for us.
e336de0d
GS
473 * currently used only with DEBUGGING,
474 * but not #ifdef-ed for bincompat */
475};
476
477typedef struct stackinfo PERL_SI;
478
3280af22
NIS
479#define cxstack (PL_curstackinfo->si_cxstack)
480#define cxstack_ix (PL_curstackinfo->si_cxix)
481#define cxstack_max (PL_curstackinfo->si_cxmax)
e336de0d
GS
482
483#ifdef DEBUGGING
ce2f7c3b
GS
484# define SET_MARK_OFFSET \
485 PL_curstackinfo->si_markoff = PL_markstack_ptr - PL_markstack
e336de0d 486#else
ce2f7c3b 487# define SET_MARK_OFFSET NOOP
e336de0d
GS
488#endif
489
d3acc0f7 490#define PUSHSTACKi(type) \
e336de0d 491 STMT_START { \
3280af22 492 PERL_SI *next = PL_curstackinfo->si_next; \
e336de0d
GS
493 if (!next) { \
494 next = new_stackinfo(32, 2048/sizeof(PERL_CONTEXT) - 1); \
3280af22
NIS
495 next->si_prev = PL_curstackinfo; \
496 PL_curstackinfo->si_next = next; \
e336de0d
GS
497 } \
498 next->si_type = type; \
499 next->si_cxix = -1; \
500 AvFILLp(next->si_stack) = 0; \
3280af22
NIS
501 SWITCHSTACK(PL_curstack,next->si_stack); \
502 PL_curstackinfo = next; \
ce2f7c3b 503 SET_MARK_OFFSET; \
e336de0d
GS
504 } STMT_END
505
e788e7d3 506#define PUSHSTACK PUSHSTACKi(PERLSI_UNKNOWN)
d3acc0f7 507
3095d977
GS
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 */
d3acc0f7 510#define POPSTACK \
e336de0d 511 STMT_START { \
39644a26 512 dSP; \
3280af22 513 PERL_SI *prev = PL_curstackinfo->si_prev; \
e336de0d 514 if (!prev) { \
bf49b057 515 PerlIO_printf(Perl_error_log, "panic: POPSTACK\n"); \
e336de0d
GS
516 my_exit(1); \
517 } \
3280af22 518 SWITCHSTACK(PL_curstack,prev->si_stack); \
e336de0d 519 /* don't free prev here, free them all at the END{} */ \
3280af22 520 PL_curstackinfo = prev; \
e336de0d
GS
521 } STMT_END
522
523#define POPSTACK_TO(s) \
524 STMT_START { \
3280af22 525 while (PL_curstack != s) { \
bac4b2ad 526 dounwind(-1); \
d3acc0f7 527 POPSTACK; \
bac4b2ad 528 } \
e336de0d 529 } STMT_END