This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
move the SETJMP exception-handing definitions from scope.h to cop.h
[perl5.git] / cop.h
CommitLineData
a0d0e21e 1/* cop.h
79072805 2 *
4bb101f2 3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
b5f8cc5c 4 * 2000, 2001, 2002, 2003, 2004, by Larry Wall and others
79072805
LW
5 *
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.
8 *
a3985cdc 9 * Control ops (cops) are one of the three ops OP_NEXTSTATE, OP_DBSTATE,
3ffa1527
JH
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,
a3985cdc 13 * and thus can be used to determine our current state.
79072805
LW
14 */
15
0d2925a6
DM
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.
19 *
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).
23 *
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.
28 * GSAR 97-03-27
29 */
30
31struct jmpenv {
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()? */
36};
37
38typedef struct jmpenv JMPENV;
39
40#ifdef OP_IN_REGISTER
41#define OP_REG_TO_MEM PL_opsave = op
42#define OP_MEM_TO_REG op = PL_opsave
43#else
44#define OP_REG_TO_MEM NOOP
45#define OP_MEM_TO_REG NOOP
46#endif
47
48/*
49 * How to build the first jmpenv.
50 *
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 {}!
56 */
57
58#define JMPENV_BOOTSTRAP \
59 STMT_START { \
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; \
64 } STMT_END
65
66/*
67 * PERL_FLEXIBLE_EXCEPTIONS
68 *
69 * All the flexible exceptions code has been removed.
70 * See the following threads for details:
71 *
72 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2004-07/msg00378.html
73 *
74 * Joshua's original patches (which weren't applied) and discussion:
75 *
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
82 *
83 * Chip's reworked patch and discussion:
84 *
85 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1999-03/msg00520.html
86 *
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().
91 *
92 * The original patches that introduces flexible exceptions were:
93 *
94 * http://public.activestate.com/cgi-bin/perlbrowse?patch=3386
95 * http://public.activestate.com/cgi-bin/perlbrowse?patch=5162
96 */
97
98#define dJMPENV JMPENV cur_env
99
100#define JMPENV_PUSH(v) \
101 STMT_START { \
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; \
105 OP_REG_TO_MEM; \
106 cur_env.je_ret = PerlProc_setjmp(cur_env.je_buf, SCOPE_SAVES_SIGNAL_MASK); \
107 OP_MEM_TO_REG; \
108 PL_top_env = &cur_env; \
109 cur_env.je_mustcatch = FALSE; \
110 (v) = cur_env.je_ret; \
111 } STMT_END
112
113#define JMPENV_POP \
114 STMT_START { \
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; \
118 } STMT_END
119
120#define JMPENV_JUMP(v) \
121 STMT_START { \
122 OP_REG_TO_MEM; \
123 if (PL_top_env->je_prev) \
124 PerlProc_longjmp(PL_top_env->je_buf, (v)); \
125 if ((v) == 2) \
126 PerlProc_exit(STATUS_NATIVE_EXPORT); \
127 PerlIO_printf(PerlIO_stderr(), "panic: top_env\n"); \
128 PerlProc_exit(1); \
129 } STMT_END
130
131#define CATCH_GET (PL_top_env->je_mustcatch)
132#define CATCH_SET(v) (PL_top_env->je_mustcatch = (v))
133
134
135
79072805
LW
136struct cop {
137 BASEOP
a0d0e21e 138 char * cop_label; /* label for this construct */
57843af0 139#ifdef USE_ITHREADS
11faa288 140 char * cop_stashpv; /* package line was compiled in */
57843af0
GS
141 char * cop_file; /* file name the following line # is from */
142#else
11faa288 143 HV * cop_stash; /* package line was compiled in */
79072805 144 GV * cop_filegv; /* file the following line # is from */
57843af0 145#endif
a0d0e21e
LW
146 U32 cop_seq; /* parse sequence number */
147 I32 cop_arybase; /* array base this line was compiled with */
79072805 148 line_t cop_line; /* line # of this command */
599cee73 149 SV * cop_warnings; /* lexical warnings bitmask */
ac27b0f5 150 SV * cop_io; /* lexical IO defaults */
79072805
LW
151};
152
153#define Nullcop Null(COP*)
154
57843af0
GS
155#ifdef USE_ITHREADS
156# define CopFILE(c) ((c)->cop_file)
157# define CopFILEGV(c) (CopFILE(c) \
158 ? gv_fetchfile(CopFILE(c)) : Nullgv)
083fcd59 159
7e4e8c89
NC
160# ifdef NETWARE
161# define CopFILE_set(c,pv) ((c)->cop_file = savepv(pv))
162# else
163# define CopFILE_set(c,pv) ((c)->cop_file = savesharedpv(pv))
164# endif
083fcd59 165
57843af0
GS
166# define CopFILESV(c) (CopFILE(c) \
167 ? GvSV(gv_fetchfile(CopFILE(c))) : Nullsv)
168# define CopFILEAV(c) (CopFILE(c) \
169 ? GvAV(gv_fetchfile(CopFILE(c))) : Nullav)
57843af0 170# define CopSTASHPV(c) ((c)->cop_stashpv)
083fcd59 171
7e4e8c89
NC
172# ifdef NETWARE
173# define CopSTASHPV_set(c,pv) ((c)->cop_stashpv = ((pv) ? savepv(pv) : Nullch))
174# else
175# define CopSTASHPV_set(c,pv) ((c)->cop_stashpv = savesharedpv(pv))
176# endif
083fcd59 177
11faa288
GS
178# define CopSTASH(c) (CopSTASHPV(c) \
179 ? gv_stashpv(CopSTASHPV(c),GV_ADD) : Nullhv)
7b910cb8 180# define CopSTASH_set(c,hv) CopSTASHPV_set(c, (hv) ? HvNAME(hv) : Nullch)
f4dd75d9 181# define CopSTASH_eq(c,hv) ((hv) \
ed094faf
GS
182 && (CopSTASHPV(c) == HvNAME(hv) \
183 || (CopSTASHPV(c) && HvNAME(hv) \
184 && strEQ(CopSTASHPV(c), HvNAME(hv)))))
7e4e8c89
NC
185# ifdef NETWARE
186# define CopSTASH_free(c) SAVECOPSTASH_FREE(c)
187# else
188# define CopSTASH_free(c) PerlMemShared_free(CopSTASHPV(c))
189# endif
083fcd59 190
7e4e8c89
NC
191# ifdef NETWARE
192# define CopFILE_free(c) SAVECOPFILE_FREE(c)
193# else
194# define CopFILE_free(c) (PerlMemShared_free(CopFILE(c)),(CopFILE(c) = Nullch))
195# endif
57843af0
GS
196#else
197# define CopFILEGV(c) ((c)->cop_filegv)
f4dd75d9
GS
198# define CopFILEGV_set(c,gv) ((c)->cop_filegv = (GV*)SvREFCNT_inc(gv))
199# define CopFILE_set(c,pv) CopFILEGV_set((c), gv_fetchfile(pv))
57843af0
GS
200# define CopFILESV(c) (CopFILEGV(c) ? GvSV(CopFILEGV(c)) : Nullsv)
201# define CopFILEAV(c) (CopFILEGV(c) ? GvAV(CopFILEGV(c)) : Nullav)
202# define CopFILE(c) (CopFILESV(c) ? SvPVX(CopFILESV(c)) : Nullch)
203# define CopSTASH(c) ((c)->cop_stash)
f4dd75d9 204# define CopSTASH_set(c,hv) ((c)->cop_stash = (hv))
57843af0 205# define CopSTASHPV(c) (CopSTASH(c) ? HvNAME(CopSTASH(c)) : Nullch)
f4dd75d9
GS
206 /* cop_stash is not refcounted */
207# define CopSTASHPV_set(c,pv) CopSTASH_set((c), gv_stashpv(pv,GV_ADD))
208# define CopSTASH_eq(c,hv) (CopSTASH(c) == (hv))
05ec9bb3
NIS
209# define CopSTASH_free(c)
210# define CopFILE_free(c) (SvREFCNT_dec(CopFILEGV(c)),(CopFILEGV(c) = Nullgv))
211
57843af0
GS
212#endif /* USE_ITHREADS */
213
ed094faf 214#define CopSTASH_ne(c,hv) (!CopSTASH_eq(c,hv))
cc49e20b 215#define CopLINE(c) ((c)->cop_line)
57843af0
GS
216#define CopLINE_inc(c) (++CopLINE(c))
217#define CopLINE_dec(c) (--CopLINE(c))
218#define CopLINE_set(c,l) (CopLINE(c) = (l))
cc49e20b 219
248c2a4d
CN
220/* OutCopFILE() is CopFILE for output (caller, die, warn, etc.) */
221#ifdef MACOS_TRADITIONAL
222# define OutCopFILE(c) MacPerl_MPWFileName(CopFILE(c))
223#else
224# define OutCopFILE(c) CopFILE(c)
225#endif
226
79072805
LW
227/*
228 * Here we have some enormously heavy (or at least ponderous) wizardry.
229 */
230
231/* subroutine context */
232struct block_sub {
233 CV * cv;
234 GV * gv;
463ee0b2 235 GV * dfoutgv;
79072805
LW
236 AV * savearray;
237 AV * argarray;
b8f55b69 238 long olddepth;
79072805 239 U8 hasargs;
cd06dffe 240 U8 lval; /* XXX merge lval and hasargs? */
f3548bdc 241 PAD *oldcomppad;
f39bc417 242 OP * retop; /* op to execute on exit from sub */
79072805
LW
243};
244
b36bdeca
DM
245/* base for the next two macros. Don't use directly.
246 * Note that the refcnt of the cv is incremented twice; The CX one is
247 * decremented by LEAVESUB, the other by LEAVE. */
248
ee98a1d6 249#define PUSHSUB_BASE(cx) \
79072805 250 cx->blk_sub.cv = cv; \
b8f55b69 251 cx->blk_sub.olddepth = CvDEPTH(cv); \
b36bdeca 252 cx->blk_sub.hasargs = hasargs; \
f39bc417 253 cx->blk_sub.retop = Nullop; \
b36bdeca
DM
254 if (!CvDEPTH(cv)) { \
255 (void)SvREFCNT_inc(cv); \
256 (void)SvREFCNT_inc(cv); \
257 SAVEFREESV(cv); \
258 }
259
ee98a1d6
DM
260
261#define PUSHSUB(cx) \
262 PUSHSUB_BASE(cx) \
cd06dffe
GS
263 cx->blk_sub.lval = PL_op->op_private & \
264 (OPpLVAL_INTRO|OPpENTERSUB_INARGS);
79072805 265
ee98a1d6
DM
266/* variant for use by OP_DBSTATE, where op_private holds hint bits */
267#define PUSHSUB_DB(cx) \
268 PUSHSUB_BASE(cx) \
269 cx->blk_sub.lval = 0;
270
271
79072805
LW
272#define PUSHFORMAT(cx) \
273 cx->blk_sub.cv = cv; \
274 cx->blk_sub.gv = gv; \
f39bc417 275 cx->blk_sub.retop = Nullop; \
4633a7c4 276 cx->blk_sub.hasargs = 0; \
3280af22 277 cx->blk_sub.dfoutgv = PL_defoutgv; \
4633a7c4 278 (void)SvREFCNT_inc(cx->blk_sub.dfoutgv)
79072805 279
3db8f154 280#define POP_SAVEARRAY() \
6d4ff0d2 281 STMT_START { \
3280af22 282 SvREFCNT_dec(GvAV(PL_defgv)); \
a8bba7fa 283 GvAV(PL_defgv) = cx->blk_sub.savearray; \
6d4ff0d2 284 } STMT_END
6d4ff0d2 285
ecf8e9dd 286/* junk in @_ spells trouble when cloning CVs and in pp_caller(), so don't
8e09340b
GS
287 * leave any (a fast av_clear(ary), basically) */
288#define CLEAR_ARGARRAY(ary) \
289 STMT_START { \
290 AvMAX(ary) += AvARRAY(ary) - AvALLOC(ary); \
f880fe2f 291 SvPV_set(ary, (char*)AvALLOC(ary)); \
8e09340b
GS
292 AvFILLp(ary) = -1; \
293 } STMT_END
7766f137 294
b0d9ce38
GS
295#define POPSUB(cx,sv) \
296 STMT_START { \
a8bba7fa 297 if (cx->blk_sub.hasargs) { \
7766f137 298 POP_SAVEARRAY(); \
d8b46c1b 299 /* abandon @_ if it got reified */ \
a8bba7fa
GS
300 if (AvREAL(cx->blk_sub.argarray)) { \
301 SSize_t fill = AvFILLp(cx->blk_sub.argarray); \
302 SvREFCNT_dec(cx->blk_sub.argarray); \
303 cx->blk_sub.argarray = newAV(); \
304 av_extend(cx->blk_sub.argarray, fill); \
305 AvFLAGS(cx->blk_sub.argarray) = AVf_REIFY; \
dd2155a4 306 CX_CURPAD_SV(cx->blk_sub, 0) = (SV*)cx->blk_sub.argarray; \
d8b46c1b 307 } \
7766f137 308 else { \
8e09340b 309 CLEAR_ARGARRAY(cx->blk_sub.argarray); \
7766f137 310 } \
79072805 311 } \
b0d9ce38
GS
312 sv = (SV*)cx->blk_sub.cv; \
313 if (sv && (CvDEPTH((CV*)sv) = cx->blk_sub.olddepth)) \
314 sv = Nullsv; \
315 } STMT_END
316
317#define LEAVESUB(sv) \
318 STMT_START { \
319 if (sv) \
320 SvREFCNT_dec(sv); \
321 } STMT_END
79072805
LW
322
323#define POPFORMAT(cx) \
4633a7c4
LW
324 setdefout(cx->blk_sub.dfoutgv); \
325 SvREFCNT_dec(cx->blk_sub.dfoutgv);
79072805
LW
326
327/* eval context */
328struct block_eval {
329 I32 old_in_eval;
330 I32 old_op_type;
0f79a09d 331 SV * old_namesv;
79072805 332 OP * old_eval_root;
748a9306 333 SV * cur_text;
2090ab20 334 CV * cv;
f39bc417 335 OP * retop; /* op to execute on exit from eval */
79072805
LW
336};
337
8990e307 338#define PUSHEVAL(cx,n,fgv) \
0f79a09d 339 STMT_START { \
3280af22 340 cx->blk_eval.old_in_eval = PL_in_eval; \
a8bba7fa 341 cx->blk_eval.old_op_type = PL_op->op_type; \
0f79a09d 342 cx->blk_eval.old_namesv = (n ? newSVpv(n,0) : Nullsv); \
a8bba7fa 343 cx->blk_eval.old_eval_root = PL_eval_root; \
0f79a09d 344 cx->blk_eval.cur_text = PL_linestr; \
2090ab20 345 cx->blk_eval.cv = Nullcv; /* set by doeval(), as applicable */ \
f39bc417 346 cx->blk_eval.retop = Nullop; \
0f79a09d 347 } STMT_END
79072805
LW
348
349#define POPEVAL(cx) \
0f79a09d 350 STMT_START { \
3280af22 351 PL_in_eval = cx->blk_eval.old_in_eval; \
79072805 352 optype = cx->blk_eval.old_op_type; \
7766f137 353 PL_eval_root = cx->blk_eval.old_eval_root; \
0f79a09d
GS
354 if (cx->blk_eval.old_namesv) \
355 sv_2mortal(cx->blk_eval.old_namesv); \
356 } STMT_END
79072805
LW
357
358/* loop context */
359struct block_loop {
360 char * label;
361 I32 resetsp;
362 OP * redo_op;
363 OP * next_op;
364 OP * last_op;
7766f137
GS
365#ifdef USE_ITHREADS
366 void * iterdata;
f3548bdc 367 PAD *oldcomppad;
7766f137 368#else
79072805 369 SV ** itervar;
7766f137 370#endif
79072805 371 SV * itersave;
5f05dabc 372 SV * iterlval;
79072805 373 AV * iterary;
89ea2908
GA
374 IV iterix;
375 IV itermax;
79072805
LW
376};
377
7766f137
GS
378#ifdef USE_ITHREADS
379# define CxITERVAR(c) \
380 ((c)->blk_loop.iterdata \
381 ? (CxPADLOOP(cx) \
dd2155a4
DM
382 ? &CX_CURPAD_SV( (c)->blk_loop, \
383 INT2PTR(PADOFFSET, (c)->blk_loop.iterdata)) \
7766f137
GS
384 : &GvSV((GV*)(c)->blk_loop.iterdata)) \
385 : (SV**)NULL)
386# define CX_ITERDATA_SET(cx,idata) \
dd2155a4 387 CX_CURPAD_SAVE(cx->blk_loop); \
155aba94 388 if ((cx->blk_loop.iterdata = (idata))) \
d10edb75
KC
389 cx->blk_loop.itersave = SvREFCNT_inc(*CxITERVAR(cx)); \
390 else \
391 cx->blk_loop.itersave = Nullsv;
7766f137
GS
392#else
393# define CxITERVAR(c) ((c)->blk_loop.itervar)
394# define CX_ITERDATA_SET(cx,ivar) \
155aba94 395 if ((cx->blk_loop.itervar = (SV**)(ivar))) \
d10edb75
KC
396 cx->blk_loop.itersave = SvREFCNT_inc(*CxITERVAR(cx)); \
397 else \
398 cx->blk_loop.itersave = Nullsv;
7766f137
GS
399#endif
400
401#define PUSHLOOP(cx, dat, s) \
38a230cb
GS
402 cx->blk_loop.label = PL_curcop->cop_label; \
403 cx->blk_loop.resetsp = s - PL_stack_base; \
79072805
LW
404 cx->blk_loop.redo_op = cLOOP->op_redoop; \
405 cx->blk_loop.next_op = cLOOP->op_nextop; \
406 cx->blk_loop.last_op = cLOOP->op_lastop; \
44a8e56a
PP
407 cx->blk_loop.iterlval = Nullsv; \
408 cx->blk_loop.iterary = Nullav; \
7766f137
GS
409 cx->blk_loop.iterix = -1; \
410 CX_ITERDATA_SET(cx,dat);
79072805
LW
411
412#define POPLOOP(cx) \
a8bba7fa 413 SvREFCNT_dec(cx->blk_loop.iterlval); \
7766f137
GS
414 if (CxITERVAR(cx)) { \
415 SV **s_v_p = CxITERVAR(cx); \
416 sv_2mortal(*s_v_p); \
417 *s_v_p = cx->blk_loop.itersave; \
44a8e56a 418 } \
a8bba7fa
GS
419 if (cx->blk_loop.iterary && cx->blk_loop.iterary != PL_curstack)\
420 SvREFCNT_dec(cx->blk_loop.iterary);
79072805
LW
421
422/* context common to subroutines, evals and loops */
423struct block {
424 I32 blku_oldsp; /* stack pointer to copy stuff down to */
425 COP * blku_oldcop; /* old curcop pointer */
79072805
LW
426 I32 blku_oldmarksp; /* mark stack index */
427 I32 blku_oldscopesp; /* scope stack index */
428 PMOP * blku_oldpm; /* values of pattern match vars */
429 U8 blku_gimme; /* is this block running in list context? */
430
431 union {
432 struct block_sub blku_sub;
433 struct block_eval blku_eval;
434 struct block_loop blku_loop;
435 } blk_u;
436};
437#define blk_oldsp cx_u.cx_blk.blku_oldsp
438#define blk_oldcop cx_u.cx_blk.blku_oldcop
79072805
LW
439#define blk_oldmarksp cx_u.cx_blk.blku_oldmarksp
440#define blk_oldscopesp cx_u.cx_blk.blku_oldscopesp
441#define blk_oldpm cx_u.cx_blk.blku_oldpm
442#define blk_gimme cx_u.cx_blk.blku_gimme
443#define blk_sub cx_u.cx_blk.blk_u.blku_sub
444#define blk_eval cx_u.cx_blk.blk_u.blku_eval
445#define blk_loop cx_u.cx_blk.blk_u.blku_loop
446
447/* Enter a block. */
8990e307 448#define PUSHBLOCK(cx,t,sp) CXINC, cx = &cxstack[cxstack_ix], \
79072805 449 cx->cx_type = t, \
3280af22
NIS
450 cx->blk_oldsp = sp - PL_stack_base, \
451 cx->blk_oldcop = PL_curcop, \
1aff0e91 452 cx->blk_oldmarksp = PL_markstack_ptr - PL_markstack, \
3280af22 453 cx->blk_oldscopesp = PL_scopestack_ix, \
3280af22 454 cx->blk_oldpm = PL_curpm, \
eb160463 455 cx->blk_gimme = (U8)gimme; \
bf49b057 456 DEBUG_l( PerlIO_printf(Perl_debug_log, "Entering block %ld, type %s\n", \
1aff0e91 457 (long)cxstack_ix, PL_block_type[CxTYPE(cx)]); )
79072805
LW
458
459/* Exit a block (RETURN and LAST). */
a0d0e21e 460#define POPBLOCK(cx,pm) cx = &cxstack[cxstack_ix--], \
1aff0e91 461 newsp = PL_stack_base + cx->blk_oldsp, \
3280af22
NIS
462 PL_curcop = cx->blk_oldcop, \
463 PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp, \
464 PL_scopestack_ix = cx->blk_oldscopesp, \
3280af22
NIS
465 pm = cx->blk_oldpm, \
466 gimme = cx->blk_gimme; \
b4ab917c 467 DEBUG_SCOPE("POPBLOCK"); \
bf49b057 468 DEBUG_l( PerlIO_printf(Perl_debug_log, "Leaving block %ld, type %s\n", \
22c35a8c 469 (long)cxstack_ix+1,PL_block_type[CxTYPE(cx)]); )
79072805
LW
470
471/* Continue a block elsewhere (NEXT and REDO). */
3280af22 472#define TOPBLOCK(cx) cx = &cxstack[cxstack_ix], \
1aff0e91 473 PL_stack_sp = PL_stack_base + cx->blk_oldsp, \
3280af22
NIS
474 PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp, \
475 PL_scopestack_ix = cx->blk_oldscopesp, \
b4ab917c
DM
476 PL_curpm = cx->blk_oldpm; \
477 DEBUG_SCOPE("TOPBLOCK");
79072805
LW
478
479/* substitution context */
480struct subst {
481 I32 sbu_iters;
482 I32 sbu_maxiters;
22e551b9 483 I32 sbu_rflags;
4633a7c4 484 I32 sbu_oldsave;
71be2cbc
PP
485 bool sbu_once;
486 bool sbu_rxtainted;
79072805
LW
487 char * sbu_orig;
488 SV * sbu_dstr;
489 SV * sbu_targ;
490 char * sbu_s;
491 char * sbu_m;
492 char * sbu_strend;
c90c0ff4 493 void * sbu_rxres;
c07a80fd 494 REGEXP * sbu_rx;
79072805
LW
495};
496#define sb_iters cx_u.cx_subst.sbu_iters
497#define sb_maxiters cx_u.cx_subst.sbu_maxiters
22e551b9 498#define sb_rflags cx_u.cx_subst.sbu_rflags
4633a7c4 499#define sb_oldsave cx_u.cx_subst.sbu_oldsave
71be2cbc
PP
500#define sb_once cx_u.cx_subst.sbu_once
501#define sb_rxtainted cx_u.cx_subst.sbu_rxtainted
79072805
LW
502#define sb_orig cx_u.cx_subst.sbu_orig
503#define sb_dstr cx_u.cx_subst.sbu_dstr
504#define sb_targ cx_u.cx_subst.sbu_targ
505#define sb_s cx_u.cx_subst.sbu_s
506#define sb_m cx_u.cx_subst.sbu_m
507#define sb_strend cx_u.cx_subst.sbu_strend
c90c0ff4 508#define sb_rxres cx_u.cx_subst.sbu_rxres
c07a80fd 509#define sb_rx cx_u.cx_subst.sbu_rx
79072805
LW
510
511#define PUSHSUBST(cx) CXINC, cx = &cxstack[cxstack_ix], \
512 cx->sb_iters = iters, \
513 cx->sb_maxiters = maxiters, \
22e551b9 514 cx->sb_rflags = r_flags, \
4633a7c4 515 cx->sb_oldsave = oldsave, \
71be2cbc
PP
516 cx->sb_once = once, \
517 cx->sb_rxtainted = rxtainted, \
79072805
LW
518 cx->sb_orig = orig, \
519 cx->sb_dstr = dstr, \
520 cx->sb_targ = targ, \
521 cx->sb_s = s, \
522 cx->sb_m = m, \
523 cx->sb_strend = strend, \
c90c0ff4 524 cx->sb_rxres = Null(void*), \
c07a80fd 525 cx->sb_rx = rx, \
c90c0ff4
PP
526 cx->cx_type = CXt_SUBST; \
527 rxres_save(&cx->sb_rxres, rx)
79072805 528
c90c0ff4
PP
529#define POPSUBST(cx) cx = &cxstack[cxstack_ix--]; \
530 rxres_free(&cx->sb_rxres)
79072805
LW
531
532struct context {
6b35e009 533 U32 cx_type; /* what kind of context this is */
79072805
LW
534 union {
535 struct block cx_blk;
536 struct subst cx_subst;
537 } cx_u;
538};
6b35e009
GS
539
540#define CXTYPEMASK 0xff
79072805
LW
541#define CXt_NULL 0
542#define CXt_SUB 1
543#define CXt_EVAL 2
544#define CXt_LOOP 3
545#define CXt_SUBST 4
546#define CXt_BLOCK 5
7766f137 547#define CXt_FORMAT 6
79072805 548
6b35e009
GS
549/* private flags for CXt_EVAL */
550#define CXp_REAL 0x00000100 /* truly eval'', not a lookalike */
1d76a5c3 551#define CXp_TRYBLOCK 0x00000200 /* eval{}, not eval'' or similar */
6b35e009 552
7766f137
GS
553#ifdef USE_ITHREADS
554/* private flags for CXt_LOOP */
555# define CXp_PADVAR 0x00000100 /* itervar lives on pad, iterdata
556 has pad offset; if not set,
557 iterdata holds GV* */
558# define CxPADLOOP(c) (((c)->cx_type & (CXt_LOOP|CXp_PADVAR)) \
559 == (CXt_LOOP|CXp_PADVAR))
560#endif
561
6b35e009 562#define CxTYPE(c) ((c)->cx_type & CXTYPEMASK)
7766f137
GS
563#define CxREALEVAL(c) (((c)->cx_type & (CXt_EVAL|CXp_REAL)) \
564 == (CXt_EVAL|CXp_REAL))
1d76a5c3
GS
565#define CxTRYBLOCK(c) (((c)->cx_type & (CXt_EVAL|CXp_TRYBLOCK)) \
566 == (CXt_EVAL|CXp_TRYBLOCK))
6b35e009 567
79072805
LW
568#define CXINC (cxstack_ix < cxstack_max ? ++cxstack_ix : (cxstack_ix = cxinc()))
569
ccfc67b7
JH
570/*
571=head1 "Gimme" Values
572*/
954c1994
GS
573
574/*
575=for apidoc AmU||G_SCALAR
576Used to indicate scalar context. See C<GIMME_V>, C<GIMME>, and
577L<perlcall>.
578
579=for apidoc AmU||G_ARRAY
91e74348 580Used to indicate list context. See C<GIMME_V>, C<GIMME> and
954c1994
GS
581L<perlcall>.
582
583=for apidoc AmU||G_VOID
584Used to indicate void context. See C<GIMME_V> and L<perlcall>.
585
586=for apidoc AmU||G_DISCARD
587Indicates that arguments returned from a callback should be discarded. See
588L<perlcall>.
589
590=for apidoc AmU||G_EVAL
591
592Used to force a Perl C<eval> wrapper around a callback. See
593L<perlcall>.
594
595=for apidoc AmU||G_NOARGS
596
597Indicates that no arguments are being sent to a callback. See
598L<perlcall>.
599
600=cut
601*/
602
a0d0e21e
LW
603#define G_SCALAR 0
604#define G_ARRAY 1
54310121 605#define G_VOID 128 /* skip this bit when adding flags below */
79072805 606
864dbfa3 607/* extra flags for Perl_call_* routines */
a0d0e21e
LW
608#define G_DISCARD 2 /* Call FREETMPS. */
609#define G_EVAL 4 /* Assume eval {} around subroutine call. */
610#define G_NOARGS 8 /* Don't construct a @_ array. */
54310121 611#define G_KEEPERR 16 /* Append errors to $@, don't overwrite it */
491527d0 612#define G_NODEBUG 32 /* Disable debugging at toplevel. */
968b3946 613#define G_METHOD 64 /* Calling method. */
e336de0d 614
faef0170
HS
615/* flag bits for PL_in_eval */
616#define EVAL_NULL 0 /* not in an eval */
617#define EVAL_INEVAL 1 /* some enclosing scope is an eval */
618#define EVAL_WARNONLY 2 /* used by yywarn() when calling yyerror() */
864dbfa3 619#define EVAL_KEEPERR 4 /* set by Perl_call_sv if G_KEEPERR */
6dc8a9e4 620#define EVAL_INREQUIRE 8 /* The code is being required. */
faef0170 621
e336de0d
GS
622/* Support for switching (stack and block) contexts.
623 * This ensures magic doesn't invalidate local stack and cx pointers.
624 */
625
e788e7d3
GS
626#define PERLSI_UNKNOWN -1
627#define PERLSI_UNDEF 0
628#define PERLSI_MAIN 1
629#define PERLSI_MAGIC 2
630#define PERLSI_SORT 3
631#define PERLSI_SIGNAL 4
632#define PERLSI_OVERLOAD 5
633#define PERLSI_DESTROY 6
634#define PERLSI_WARNHOOK 7
635#define PERLSI_DIEHOOK 8
636#define PERLSI_REQUIRE 9
e336de0d
GS
637
638struct stackinfo {
639 AV * si_stack; /* stack for current runlevel */
640 PERL_CONTEXT * si_cxstack; /* context stack for runlevel */
641 I32 si_cxix; /* current context index */
642 I32 si_cxmax; /* maximum allocated index */
643 I32 si_type; /* type of runlevel */
644 struct stackinfo * si_prev;
645 struct stackinfo * si_next;
ce2f7c3b 646 I32 si_markoff; /* offset where markstack begins for us.
e336de0d
GS
647 * currently used only with DEBUGGING,
648 * but not #ifdef-ed for bincompat */
649};
650
651typedef struct stackinfo PERL_SI;
652
3280af22
NIS
653#define cxstack (PL_curstackinfo->si_cxstack)
654#define cxstack_ix (PL_curstackinfo->si_cxix)
655#define cxstack_max (PL_curstackinfo->si_cxmax)
e336de0d
GS
656
657#ifdef DEBUGGING
ce2f7c3b
GS
658# define SET_MARK_OFFSET \
659 PL_curstackinfo->si_markoff = PL_markstack_ptr - PL_markstack
e336de0d 660#else
ce2f7c3b 661# define SET_MARK_OFFSET NOOP
e336de0d
GS
662#endif
663
d3acc0f7 664#define PUSHSTACKi(type) \
e336de0d 665 STMT_START { \
3280af22 666 PERL_SI *next = PL_curstackinfo->si_next; \
e336de0d
GS
667 if (!next) { \
668 next = new_stackinfo(32, 2048/sizeof(PERL_CONTEXT) - 1); \
3280af22
NIS
669 next->si_prev = PL_curstackinfo; \
670 PL_curstackinfo->si_next = next; \
e336de0d
GS
671 } \
672 next->si_type = type; \
673 next->si_cxix = -1; \
674 AvFILLp(next->si_stack) = 0; \
3280af22
NIS
675 SWITCHSTACK(PL_curstack,next->si_stack); \
676 PL_curstackinfo = next; \
ce2f7c3b 677 SET_MARK_OFFSET; \
e336de0d
GS
678 } STMT_END
679
e788e7d3 680#define PUSHSTACK PUSHSTACKi(PERLSI_UNKNOWN)
d3acc0f7 681
3095d977
GS
682/* POPSTACK works with PL_stack_sp, so it may need to be bracketed by
683 * PUTBACK/SPAGAIN to flush/refresh any local SP that may be active */
d3acc0f7 684#define POPSTACK \
e336de0d 685 STMT_START { \
39644a26 686 dSP; \
3280af22 687 PERL_SI *prev = PL_curstackinfo->si_prev; \
e336de0d 688 if (!prev) { \
bf49b057 689 PerlIO_printf(Perl_error_log, "panic: POPSTACK\n"); \
e336de0d
GS
690 my_exit(1); \
691 } \
3280af22 692 SWITCHSTACK(PL_curstack,prev->si_stack); \
e336de0d 693 /* don't free prev here, free them all at the END{} */ \
3280af22 694 PL_curstackinfo = prev; \
e336de0d
GS
695 } STMT_END
696
697#define POPSTACK_TO(s) \
698 STMT_START { \
3280af22 699 while (PL_curstack != s) { \
bac4b2ad 700 dounwind(-1); \
d3acc0f7 701 POPSTACK; \
bac4b2ad 702 } \
e336de0d 703 } STMT_END
923e4eb5
JH
704
705#define IN_PERL_COMPILETIME (PL_curcop == &PL_compiling)
706#define IN_PERL_RUNTIME (PL_curcop != &PL_compiling)
707