This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
PVFMs don't need CvDEPTH, and PVCVs don't use SvIVX, so moving
[perl5.git] / cop.h
CommitLineData
a0d0e21e 1/* cop.h
79072805 2 *
4bb101f2 3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
acde74e1 4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006 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) \
37038d91 126 PerlProc_exit(STATUS_EXIT); \
0d2925a6
DM
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
57843af0
GS
153#ifdef USE_ITHREADS
154# define CopFILE(c) ((c)->cop_file)
155# define CopFILEGV(c) (CopFILE(c) \
a0714e2c 156 ? gv_fetchfile(CopFILE(c)) : NULL)
083fcd59 157
7e4e8c89
NC
158# ifdef NETWARE
159# define CopFILE_set(c,pv) ((c)->cop_file = savepv(pv))
160# else
161# define CopFILE_set(c,pv) ((c)->cop_file = savesharedpv(pv))
162# endif
083fcd59 163
57843af0 164# define CopFILESV(c) (CopFILE(c) \
a0714e2c 165 ? GvSV(gv_fetchfile(CopFILE(c))) : NULL)
57843af0 166# define CopFILEAV(c) (CopFILE(c) \
7d49f689 167 ? GvAV(gv_fetchfile(CopFILE(c))) : NULL)
8688788e
SH
168# ifdef DEBUGGING
169# define CopFILEAVx(c) (assert(CopFILE(c)), \
36c7798d 170 GvAV(gv_fetchfile(CopFILE(c))))
8688788e
SH
171# else
172# define CopFILEAVx(c) (GvAV(gv_fetchfile(CopFILE(c))))
173# endif
57843af0 174# define CopSTASHPV(c) ((c)->cop_stashpv)
083fcd59 175
7e4e8c89 176# ifdef NETWARE
bd61b366 177# define CopSTASHPV_set(c,pv) ((c)->cop_stashpv = ((pv) ? savepv(pv) : NULL))
7e4e8c89
NC
178# else
179# define CopSTASHPV_set(c,pv) ((c)->cop_stashpv = savesharedpv(pv))
180# endif
083fcd59 181
11faa288 182# define CopSTASH(c) (CopSTASHPV(c) \
5c284bb0 183 ? gv_stashpv(CopSTASHPV(c),GV_ADD) : NULL)
bd61b366 184# define CopSTASH_set(c,hv) CopSTASHPV_set(c, (hv) ? HvNAME_get(hv) : NULL)
ed221c57 185# define CopSTASH_eq(c,hv) ((hv) && stashpv_hvname_match(c,hv))
7e4e8c89
NC
186# ifdef NETWARE
187# define CopSTASH_free(c) SAVECOPSTASH_FREE(c)
7e4e8c89
NC
188# define CopFILE_free(c) SAVECOPFILE_FREE(c)
189# else
ed221c57 190# define CopSTASH_free(c) PerlMemShared_free(CopSTASHPV(c))
bd61b366 191# define CopFILE_free(c) (PerlMemShared_free(CopFILE(c)),(CopFILE(c) = NULL))
7e4e8c89 192# endif
57843af0
GS
193#else
194# define CopFILEGV(c) ((c)->cop_filegv)
f4dd75d9
GS
195# define CopFILEGV_set(c,gv) ((c)->cop_filegv = (GV*)SvREFCNT_inc(gv))
196# define CopFILE_set(c,pv) CopFILEGV_set((c), gv_fetchfile(pv))
a0714e2c 197# define CopFILESV(c) (CopFILEGV(c) ? GvSV(CopFILEGV(c)) : NULL)
7d49f689 198# define CopFILEAV(c) (CopFILEGV(c) ? GvAV(CopFILEGV(c)) : NULL)
8688788e
SH
199# ifdef DEBUGGING
200# define CopFILEAVx(c) (assert(CopFILEGV(c)), GvAV(CopFILEGV(c)))
201# else
202# define CopFILEAVx(c) (GvAV(CopFILEGV(c)))
203# endif
bd61b366 204# define CopFILE(c) (CopFILESV(c) ? SvPVX(CopFILESV(c)) : NULL)
57843af0 205# define CopSTASH(c) ((c)->cop_stash)
f4dd75d9 206# define CopSTASH_set(c,hv) ((c)->cop_stash = (hv))
bd61b366 207# define CopSTASHPV(c) (CopSTASH(c) ? HvNAME_get(CopSTASH(c)) : NULL)
f4dd75d9
GS
208 /* cop_stash is not refcounted */
209# define CopSTASHPV_set(c,pv) CopSTASH_set((c), gv_stashpv(pv,GV_ADD))
210# define CopSTASH_eq(c,hv) (CopSTASH(c) == (hv))
05ec9bb3 211# define CopSTASH_free(c)
a0714e2c 212# define CopFILE_free(c) (SvREFCNT_dec(CopFILEGV(c)),(CopFILEGV(c) = NULL))
05ec9bb3 213
57843af0
GS
214#endif /* USE_ITHREADS */
215
ed094faf 216#define CopSTASH_ne(c,hv) (!CopSTASH_eq(c,hv))
cc49e20b 217#define CopLINE(c) ((c)->cop_line)
57843af0
GS
218#define CopLINE_inc(c) (++CopLINE(c))
219#define CopLINE_dec(c) (--CopLINE(c))
220#define CopLINE_set(c,l) (CopLINE(c) = (l))
cc49e20b 221
248c2a4d
CN
222/* OutCopFILE() is CopFILE for output (caller, die, warn, etc.) */
223#ifdef MACOS_TRADITIONAL
224# define OutCopFILE(c) MacPerl_MPWFileName(CopFILE(c))
225#else
226# define OutCopFILE(c) CopFILE(c)
227#endif
228
79072805
LW
229/*
230 * Here we have some enormously heavy (or at least ponderous) wizardry.
231 */
232
233/* subroutine context */
234struct block_sub {
235 CV * cv;
236 GV * gv;
463ee0b2 237 GV * dfoutgv;
79072805
LW
238 AV * savearray;
239 AV * argarray;
bb172083 240 I32 olddepth;
79072805 241 U8 hasargs;
cd06dffe 242 U8 lval; /* XXX merge lval and hasargs? */
f3548bdc 243 PAD *oldcomppad;
f39bc417 244 OP * retop; /* op to execute on exit from sub */
79072805
LW
245};
246
b36bdeca
DM
247/* base for the next two macros. Don't use directly.
248 * Note that the refcnt of the cv is incremented twice; The CX one is
249 * decremented by LEAVESUB, the other by LEAVE. */
250
ee98a1d6 251#define PUSHSUB_BASE(cx) \
79072805 252 cx->blk_sub.cv = cv; \
b8f55b69 253 cx->blk_sub.olddepth = CvDEPTH(cv); \
b36bdeca 254 cx->blk_sub.hasargs = hasargs; \
5f66b61c 255 cx->blk_sub.retop = NULL; \
b36bdeca
DM
256 if (!CvDEPTH(cv)) { \
257 (void)SvREFCNT_inc(cv); \
258 (void)SvREFCNT_inc(cv); \
259 SAVEFREESV(cv); \
260 }
261
ee98a1d6
DM
262
263#define PUSHSUB(cx) \
264 PUSHSUB_BASE(cx) \
cd06dffe
GS
265 cx->blk_sub.lval = PL_op->op_private & \
266 (OPpLVAL_INTRO|OPpENTERSUB_INARGS);
79072805 267
ee98a1d6
DM
268/* variant for use by OP_DBSTATE, where op_private holds hint bits */
269#define PUSHSUB_DB(cx) \
270 PUSHSUB_BASE(cx) \
271 cx->blk_sub.lval = 0;
272
273
79072805
LW
274#define PUSHFORMAT(cx) \
275 cx->blk_sub.cv = cv; \
276 cx->blk_sub.gv = gv; \
5f66b61c 277 cx->blk_sub.retop = NULL; \
4633a7c4 278 cx->blk_sub.hasargs = 0; \
3280af22 279 cx->blk_sub.dfoutgv = PL_defoutgv; \
4633a7c4 280 (void)SvREFCNT_inc(cx->blk_sub.dfoutgv)
79072805 281
3db8f154 282#define POP_SAVEARRAY() \
6d4ff0d2 283 STMT_START { \
3280af22 284 SvREFCNT_dec(GvAV(PL_defgv)); \
a8bba7fa 285 GvAV(PL_defgv) = cx->blk_sub.savearray; \
6d4ff0d2 286 } STMT_END
6d4ff0d2 287
ecf8e9dd 288/* junk in @_ spells trouble when cloning CVs and in pp_caller(), so don't
8e09340b
GS
289 * leave any (a fast av_clear(ary), basically) */
290#define CLEAR_ARGARRAY(ary) \
291 STMT_START { \
292 AvMAX(ary) += AvARRAY(ary) - AvALLOC(ary); \
f880fe2f 293 SvPV_set(ary, (char*)AvALLOC(ary)); \
8e09340b
GS
294 AvFILLp(ary) = -1; \
295 } STMT_END
7766f137 296
b0d9ce38
GS
297#define POPSUB(cx,sv) \
298 STMT_START { \
a8bba7fa 299 if (cx->blk_sub.hasargs) { \
7766f137 300 POP_SAVEARRAY(); \
d8b46c1b 301 /* abandon @_ if it got reified */ \
a8bba7fa
GS
302 if (AvREAL(cx->blk_sub.argarray)) { \
303 SSize_t fill = AvFILLp(cx->blk_sub.argarray); \
304 SvREFCNT_dec(cx->blk_sub.argarray); \
305 cx->blk_sub.argarray = newAV(); \
306 av_extend(cx->blk_sub.argarray, fill); \
11ca45c0 307 AvREIFY_only(cx->blk_sub.argarray); \
dd2155a4 308 CX_CURPAD_SV(cx->blk_sub, 0) = (SV*)cx->blk_sub.argarray; \
d8b46c1b 309 } \
7766f137 310 else { \
8e09340b 311 CLEAR_ARGARRAY(cx->blk_sub.argarray); \
7766f137 312 } \
79072805 313 } \
b0d9ce38
GS
314 sv = (SV*)cx->blk_sub.cv; \
315 if (sv && (CvDEPTH((CV*)sv) = cx->blk_sub.olddepth)) \
a0714e2c 316 sv = NULL; \
b0d9ce38
GS
317 } STMT_END
318
319#define LEAVESUB(sv) \
320 STMT_START { \
321 if (sv) \
322 SvREFCNT_dec(sv); \
323 } STMT_END
79072805
LW
324
325#define POPFORMAT(cx) \
4633a7c4
LW
326 setdefout(cx->blk_sub.dfoutgv); \
327 SvREFCNT_dec(cx->blk_sub.dfoutgv);
79072805
LW
328
329/* eval context */
330struct block_eval {
331 I32 old_in_eval;
332 I32 old_op_type;
0f79a09d 333 SV * old_namesv;
79072805 334 OP * old_eval_root;
748a9306 335 SV * cur_text;
2090ab20 336 CV * cv;
f39bc417 337 OP * retop; /* op to execute on exit from eval */
abd70938 338 JMPENV * cur_top_env; /* value of PL_top_env when eval CX created */
79072805
LW
339};
340
8990e307 341#define PUSHEVAL(cx,n,fgv) \
0f79a09d 342 STMT_START { \
3280af22 343 cx->blk_eval.old_in_eval = PL_in_eval; \
a8bba7fa 344 cx->blk_eval.old_op_type = PL_op->op_type; \
a0714e2c 345 cx->blk_eval.old_namesv = (n ? newSVpv(n,0) : NULL); \
a8bba7fa 346 cx->blk_eval.old_eval_root = PL_eval_root; \
0f79a09d 347 cx->blk_eval.cur_text = PL_linestr; \
601f1833 348 cx->blk_eval.cv = NULL; /* set by doeval(), as applicable */ \
5f66b61c 349 cx->blk_eval.retop = NULL; \
abd70938 350 cx->blk_eval.cur_top_env = PL_top_env; \
0f79a09d 351 } STMT_END
79072805
LW
352
353#define POPEVAL(cx) \
0f79a09d 354 STMT_START { \
3280af22 355 PL_in_eval = cx->blk_eval.old_in_eval; \
79072805 356 optype = cx->blk_eval.old_op_type; \
7766f137 357 PL_eval_root = cx->blk_eval.old_eval_root; \
0f79a09d
GS
358 if (cx->blk_eval.old_namesv) \
359 sv_2mortal(cx->blk_eval.old_namesv); \
360 } STMT_END
79072805
LW
361
362/* loop context */
363struct block_loop {
364 char * label;
365 I32 resetsp;
366 OP * redo_op;
367 OP * next_op;
368 OP * last_op;
7766f137
GS
369#ifdef USE_ITHREADS
370 void * iterdata;
f3548bdc 371 PAD *oldcomppad;
7766f137 372#else
79072805 373 SV ** itervar;
7766f137 374#endif
79072805 375 SV * itersave;
5f05dabc 376 SV * iterlval;
79072805 377 AV * iterary;
89ea2908
GA
378 IV iterix;
379 IV itermax;
79072805
LW
380};
381
7766f137
GS
382#ifdef USE_ITHREADS
383# define CxITERVAR(c) \
384 ((c)->blk_loop.iterdata \
385 ? (CxPADLOOP(cx) \
dd2155a4
DM
386 ? &CX_CURPAD_SV( (c)->blk_loop, \
387 INT2PTR(PADOFFSET, (c)->blk_loop.iterdata)) \
7766f137
GS
388 : &GvSV((GV*)(c)->blk_loop.iterdata)) \
389 : (SV**)NULL)
390# define CX_ITERDATA_SET(cx,idata) \
dd2155a4 391 CX_CURPAD_SAVE(cx->blk_loop); \
155aba94 392 if ((cx->blk_loop.iterdata = (idata))) \
d10edb75
KC
393 cx->blk_loop.itersave = SvREFCNT_inc(*CxITERVAR(cx)); \
394 else \
a0714e2c 395 cx->blk_loop.itersave = NULL;
7766f137
GS
396#else
397# define CxITERVAR(c) ((c)->blk_loop.itervar)
398# define CX_ITERDATA_SET(cx,ivar) \
155aba94 399 if ((cx->blk_loop.itervar = (SV**)(ivar))) \
d10edb75
KC
400 cx->blk_loop.itersave = SvREFCNT_inc(*CxITERVAR(cx)); \
401 else \
a0714e2c 402 cx->blk_loop.itersave = NULL;
7766f137
GS
403#endif
404
405#define PUSHLOOP(cx, dat, s) \
38a230cb
GS
406 cx->blk_loop.label = PL_curcop->cop_label; \
407 cx->blk_loop.resetsp = s - PL_stack_base; \
79072805
LW
408 cx->blk_loop.redo_op = cLOOP->op_redoop; \
409 cx->blk_loop.next_op = cLOOP->op_nextop; \
410 cx->blk_loop.last_op = cLOOP->op_lastop; \
a0714e2c 411 cx->blk_loop.iterlval = NULL; \
7d49f689 412 cx->blk_loop.iterary = NULL; \
7766f137
GS
413 cx->blk_loop.iterix = -1; \
414 CX_ITERDATA_SET(cx,dat);
79072805
LW
415
416#define POPLOOP(cx) \
a8bba7fa 417 SvREFCNT_dec(cx->blk_loop.iterlval); \
7766f137 418 if (CxITERVAR(cx)) { \
21401c75
CH
419 if (SvPADMY(cx->blk_loop.itersave)) { \
420 SV **s_v_p = CxITERVAR(cx); \
421 sv_2mortal(*s_v_p); \
422 *s_v_p = cx->blk_loop.itersave; \
423 } \
424 else { \
425 SvREFCNT_dec(cx->blk_loop.itersave); \
426 } \
44a8e56a 427 } \
a8bba7fa
GS
428 if (cx->blk_loop.iterary && cx->blk_loop.iterary != PL_curstack)\
429 SvREFCNT_dec(cx->blk_loop.iterary);
79072805 430
0d863452
RH
431/* given/when context */
432struct block_givwhen {
433 OP *leave_op;
434};
435
436#define PUSHGIVEN(cx) \
437 cx->blk_givwhen.leave_op = cLOGOP->op_other;
438
439#define PUSHWHEN PUSHGIVEN
440
79072805
LW
441/* context common to subroutines, evals and loops */
442struct block {
443 I32 blku_oldsp; /* stack pointer to copy stuff down to */
444 COP * blku_oldcop; /* old curcop pointer */
79072805
LW
445 I32 blku_oldmarksp; /* mark stack index */
446 I32 blku_oldscopesp; /* scope stack index */
447 PMOP * blku_oldpm; /* values of pattern match vars */
448 U8 blku_gimme; /* is this block running in list context? */
449
450 union {
451 struct block_sub blku_sub;
452 struct block_eval blku_eval;
453 struct block_loop blku_loop;
0d863452 454 struct block_givwhen blku_givwhen;
79072805
LW
455 } blk_u;
456};
457#define blk_oldsp cx_u.cx_blk.blku_oldsp
458#define blk_oldcop cx_u.cx_blk.blku_oldcop
79072805
LW
459#define blk_oldmarksp cx_u.cx_blk.blku_oldmarksp
460#define blk_oldscopesp cx_u.cx_blk.blku_oldscopesp
461#define blk_oldpm cx_u.cx_blk.blku_oldpm
462#define blk_gimme cx_u.cx_blk.blku_gimme
463#define blk_sub cx_u.cx_blk.blk_u.blku_sub
464#define blk_eval cx_u.cx_blk.blk_u.blku_eval
465#define blk_loop cx_u.cx_blk.blk_u.blku_loop
0d863452 466#define blk_givwhen cx_u.cx_blk.blk_u.blku_givwhen
79072805
LW
467
468/* Enter a block. */
8990e307 469#define PUSHBLOCK(cx,t,sp) CXINC, cx = &cxstack[cxstack_ix], \
79072805 470 cx->cx_type = t, \
3280af22
NIS
471 cx->blk_oldsp = sp - PL_stack_base, \
472 cx->blk_oldcop = PL_curcop, \
1aff0e91 473 cx->blk_oldmarksp = PL_markstack_ptr - PL_markstack, \
3280af22 474 cx->blk_oldscopesp = PL_scopestack_ix, \
3280af22 475 cx->blk_oldpm = PL_curpm, \
eb160463 476 cx->blk_gimme = (U8)gimme; \
bf49b057 477 DEBUG_l( PerlIO_printf(Perl_debug_log, "Entering block %ld, type %s\n", \
1aff0e91 478 (long)cxstack_ix, PL_block_type[CxTYPE(cx)]); )
79072805
LW
479
480/* Exit a block (RETURN and LAST). */
a0d0e21e 481#define POPBLOCK(cx,pm) cx = &cxstack[cxstack_ix--], \
1aff0e91 482 newsp = PL_stack_base + cx->blk_oldsp, \
3280af22
NIS
483 PL_curcop = cx->blk_oldcop, \
484 PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp, \
485 PL_scopestack_ix = cx->blk_oldscopesp, \
3280af22
NIS
486 pm = cx->blk_oldpm, \
487 gimme = cx->blk_gimme; \
b4ab917c 488 DEBUG_SCOPE("POPBLOCK"); \
bf49b057 489 DEBUG_l( PerlIO_printf(Perl_debug_log, "Leaving block %ld, type %s\n", \
22c35a8c 490 (long)cxstack_ix+1,PL_block_type[CxTYPE(cx)]); )
79072805
LW
491
492/* Continue a block elsewhere (NEXT and REDO). */
3280af22 493#define TOPBLOCK(cx) cx = &cxstack[cxstack_ix], \
1aff0e91 494 PL_stack_sp = PL_stack_base + cx->blk_oldsp, \
3280af22
NIS
495 PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp, \
496 PL_scopestack_ix = cx->blk_oldscopesp, \
b4ab917c
DM
497 PL_curpm = cx->blk_oldpm; \
498 DEBUG_SCOPE("TOPBLOCK");
79072805
LW
499
500/* substitution context */
501struct subst {
502 I32 sbu_iters;
503 I32 sbu_maxiters;
22e551b9 504 I32 sbu_rflags;
4633a7c4 505 I32 sbu_oldsave;
71be2cbc
PP
506 bool sbu_once;
507 bool sbu_rxtainted;
79072805
LW
508 char * sbu_orig;
509 SV * sbu_dstr;
510 SV * sbu_targ;
511 char * sbu_s;
512 char * sbu_m;
513 char * sbu_strend;
c90c0ff4 514 void * sbu_rxres;
c07a80fd 515 REGEXP * sbu_rx;
79072805
LW
516};
517#define sb_iters cx_u.cx_subst.sbu_iters
518#define sb_maxiters cx_u.cx_subst.sbu_maxiters
22e551b9 519#define sb_rflags cx_u.cx_subst.sbu_rflags
4633a7c4 520#define sb_oldsave cx_u.cx_subst.sbu_oldsave
71be2cbc
PP
521#define sb_once cx_u.cx_subst.sbu_once
522#define sb_rxtainted cx_u.cx_subst.sbu_rxtainted
79072805
LW
523#define sb_orig cx_u.cx_subst.sbu_orig
524#define sb_dstr cx_u.cx_subst.sbu_dstr
525#define sb_targ cx_u.cx_subst.sbu_targ
526#define sb_s cx_u.cx_subst.sbu_s
527#define sb_m cx_u.cx_subst.sbu_m
528#define sb_strend cx_u.cx_subst.sbu_strend
c90c0ff4 529#define sb_rxres cx_u.cx_subst.sbu_rxres
c07a80fd 530#define sb_rx cx_u.cx_subst.sbu_rx
79072805
LW
531
532#define PUSHSUBST(cx) CXINC, cx = &cxstack[cxstack_ix], \
533 cx->sb_iters = iters, \
534 cx->sb_maxiters = maxiters, \
22e551b9 535 cx->sb_rflags = r_flags, \
4633a7c4 536 cx->sb_oldsave = oldsave, \
71be2cbc
PP
537 cx->sb_once = once, \
538 cx->sb_rxtainted = rxtainted, \
79072805
LW
539 cx->sb_orig = orig, \
540 cx->sb_dstr = dstr, \
541 cx->sb_targ = targ, \
542 cx->sb_s = s, \
543 cx->sb_m = m, \
544 cx->sb_strend = strend, \
4608196e 545 cx->sb_rxres = NULL, \
c07a80fd 546 cx->sb_rx = rx, \
c90c0ff4
PP
547 cx->cx_type = CXt_SUBST; \
548 rxres_save(&cx->sb_rxres, rx)
79072805 549
c90c0ff4
PP
550#define POPSUBST(cx) cx = &cxstack[cxstack_ix--]; \
551 rxres_free(&cx->sb_rxres)
79072805
LW
552
553struct context {
6b35e009 554 U32 cx_type; /* what kind of context this is */
79072805
LW
555 union {
556 struct block cx_blk;
557 struct subst cx_subst;
558 } cx_u;
559};
6b35e009
GS
560
561#define CXTYPEMASK 0xff
79072805
LW
562#define CXt_NULL 0
563#define CXt_SUB 1
564#define CXt_EVAL 2
565#define CXt_LOOP 3
566#define CXt_SUBST 4
567#define CXt_BLOCK 5
7766f137 568#define CXt_FORMAT 6
0d863452
RH
569#define CXt_GIVEN 7
570#define CXt_WHEN 8
79072805 571
9850bf21
RH
572/* private flags for CXt_SUB and CXt_NULL */
573#define CXp_MULTICALL 0x00000400 /* part of a multicall (so don't
574 tear down context on exit). */
575
6b35e009
GS
576/* private flags for CXt_EVAL */
577#define CXp_REAL 0x00000100 /* truly eval'', not a lookalike */
1d76a5c3 578#define CXp_TRYBLOCK 0x00000200 /* eval{}, not eval'' or similar */
6b35e009 579
7766f137 580/* private flags for CXt_LOOP */
0d863452
RH
581#define CXp_FOREACH 0x00000200 /* a foreach loop */
582#define CXp_FOR_DEF 0x00000400 /* foreach using $_ */
583#ifdef USE_ITHREADS
7766f137
GS
584# define CXp_PADVAR 0x00000100 /* itervar lives on pad, iterdata
585 has pad offset; if not set,
586 iterdata holds GV* */
587# define CxPADLOOP(c) (((c)->cx_type & (CXt_LOOP|CXp_PADVAR)) \
588 == (CXt_LOOP|CXp_PADVAR))
589#endif
590
6b35e009 591#define CxTYPE(c) ((c)->cx_type & CXTYPEMASK)
9850bf21
RH
592#define CxMULTICALL(c) (((c)->cx_type & CXp_MULTICALL) \
593 == CXp_MULTICALL)
7766f137
GS
594#define CxREALEVAL(c) (((c)->cx_type & (CXt_EVAL|CXp_REAL)) \
595 == (CXt_EVAL|CXp_REAL))
1d76a5c3
GS
596#define CxTRYBLOCK(c) (((c)->cx_type & (CXt_EVAL|CXp_TRYBLOCK)) \
597 == (CXt_EVAL|CXp_TRYBLOCK))
0d863452
RH
598#define CxFOREACH(c) (((c)->cx_type & (CXt_LOOP|CXp_FOREACH)) \
599 == (CXt_LOOP|CXp_FOREACH))
600#define CxFOREACHDEF(c) (((c)->cx_type & (CXt_LOOP|CXp_FOREACH|CXp_FOR_DEF))\
601 == (CXt_LOOP|CXp_FOREACH|CXp_FOR_DEF))
6b35e009 602
79072805
LW
603#define CXINC (cxstack_ix < cxstack_max ? ++cxstack_ix : (cxstack_ix = cxinc()))
604
ccfc67b7
JH
605/*
606=head1 "Gimme" Values
607*/
954c1994
GS
608
609/*
610=for apidoc AmU||G_SCALAR
611Used to indicate scalar context. See C<GIMME_V>, C<GIMME>, and
612L<perlcall>.
613
614=for apidoc AmU||G_ARRAY
91e74348 615Used to indicate list context. See C<GIMME_V>, C<GIMME> and
954c1994
GS
616L<perlcall>.
617
618=for apidoc AmU||G_VOID
619Used to indicate void context. See C<GIMME_V> and L<perlcall>.
620
621=for apidoc AmU||G_DISCARD
622Indicates that arguments returned from a callback should be discarded. See
623L<perlcall>.
624
625=for apidoc AmU||G_EVAL
626
627Used to force a Perl C<eval> wrapper around a callback. See
628L<perlcall>.
629
630=for apidoc AmU||G_NOARGS
631
632Indicates that no arguments are being sent to a callback. See
633L<perlcall>.
634
635=cut
636*/
637
a0d0e21e
LW
638#define G_SCALAR 0
639#define G_ARRAY 1
54310121 640#define G_VOID 128 /* skip this bit when adding flags below */
79072805 641
864dbfa3 642/* extra flags for Perl_call_* routines */
a0d0e21e
LW
643#define G_DISCARD 2 /* Call FREETMPS. */
644#define G_EVAL 4 /* Assume eval {} around subroutine call. */
645#define G_NOARGS 8 /* Don't construct a @_ array. */
54310121 646#define G_KEEPERR 16 /* Append errors to $@, don't overwrite it */
491527d0 647#define G_NODEBUG 32 /* Disable debugging at toplevel. */
968b3946 648#define G_METHOD 64 /* Calling method. */
e336de0d 649
faef0170
HS
650/* flag bits for PL_in_eval */
651#define EVAL_NULL 0 /* not in an eval */
652#define EVAL_INEVAL 1 /* some enclosing scope is an eval */
653#define EVAL_WARNONLY 2 /* used by yywarn() when calling yyerror() */
864dbfa3 654#define EVAL_KEEPERR 4 /* set by Perl_call_sv if G_KEEPERR */
6dc8a9e4 655#define EVAL_INREQUIRE 8 /* The code is being required. */
faef0170 656
e336de0d
GS
657/* Support for switching (stack and block) contexts.
658 * This ensures magic doesn't invalidate local stack and cx pointers.
659 */
660
e788e7d3
GS
661#define PERLSI_UNKNOWN -1
662#define PERLSI_UNDEF 0
663#define PERLSI_MAIN 1
664#define PERLSI_MAGIC 2
665#define PERLSI_SORT 3
666#define PERLSI_SIGNAL 4
667#define PERLSI_OVERLOAD 5
668#define PERLSI_DESTROY 6
669#define PERLSI_WARNHOOK 7
670#define PERLSI_DIEHOOK 8
671#define PERLSI_REQUIRE 9
e336de0d
GS
672
673struct stackinfo {
674 AV * si_stack; /* stack for current runlevel */
675 PERL_CONTEXT * si_cxstack; /* context stack for runlevel */
676 I32 si_cxix; /* current context index */
677 I32 si_cxmax; /* maximum allocated index */
678 I32 si_type; /* type of runlevel */
679 struct stackinfo * si_prev;
680 struct stackinfo * si_next;
ce2f7c3b 681 I32 si_markoff; /* offset where markstack begins for us.
e336de0d
GS
682 * currently used only with DEBUGGING,
683 * but not #ifdef-ed for bincompat */
684};
685
686typedef struct stackinfo PERL_SI;
687
3280af22
NIS
688#define cxstack (PL_curstackinfo->si_cxstack)
689#define cxstack_ix (PL_curstackinfo->si_cxix)
690#define cxstack_max (PL_curstackinfo->si_cxmax)
e336de0d
GS
691
692#ifdef DEBUGGING
ce2f7c3b
GS
693# define SET_MARK_OFFSET \
694 PL_curstackinfo->si_markoff = PL_markstack_ptr - PL_markstack
e336de0d 695#else
ce2f7c3b 696# define SET_MARK_OFFSET NOOP
e336de0d
GS
697#endif
698
d3acc0f7 699#define PUSHSTACKi(type) \
e336de0d 700 STMT_START { \
3280af22 701 PERL_SI *next = PL_curstackinfo->si_next; \
e336de0d
GS
702 if (!next) { \
703 next = new_stackinfo(32, 2048/sizeof(PERL_CONTEXT) - 1); \
3280af22
NIS
704 next->si_prev = PL_curstackinfo; \
705 PL_curstackinfo->si_next = next; \
e336de0d
GS
706 } \
707 next->si_type = type; \
708 next->si_cxix = -1; \
709 AvFILLp(next->si_stack) = 0; \
3280af22
NIS
710 SWITCHSTACK(PL_curstack,next->si_stack); \
711 PL_curstackinfo = next; \
ce2f7c3b 712 SET_MARK_OFFSET; \
e336de0d
GS
713 } STMT_END
714
e788e7d3 715#define PUSHSTACK PUSHSTACKi(PERLSI_UNKNOWN)
d3acc0f7 716
3095d977
GS
717/* POPSTACK works with PL_stack_sp, so it may need to be bracketed by
718 * PUTBACK/SPAGAIN to flush/refresh any local SP that may be active */
d3acc0f7 719#define POPSTACK \
e336de0d 720 STMT_START { \
39644a26 721 dSP; \
c4420975 722 PERL_SI * const prev = PL_curstackinfo->si_prev; \
e336de0d 723 if (!prev) { \
bf49b057 724 PerlIO_printf(Perl_error_log, "panic: POPSTACK\n"); \
e336de0d
GS
725 my_exit(1); \
726 } \
3280af22 727 SWITCHSTACK(PL_curstack,prev->si_stack); \
e336de0d 728 /* don't free prev here, free them all at the END{} */ \
3280af22 729 PL_curstackinfo = prev; \
e336de0d
GS
730 } STMT_END
731
732#define POPSTACK_TO(s) \
733 STMT_START { \
3280af22 734 while (PL_curstack != s) { \
bac4b2ad 735 dounwind(-1); \
d3acc0f7 736 POPSTACK; \
bac4b2ad 737 } \
e336de0d 738 } STMT_END
923e4eb5
JH
739
740#define IN_PERL_COMPILETIME (PL_curcop == &PL_compiling)
741#define IN_PERL_RUNTIME (PL_curcop != &PL_compiling)
742
9850bf21
RH
743/*
744=head1 Multicall Functions
745
746=for apidoc Ams||dMULTICALL
747Declare local variables for a multicall. See L<perlcall/Lightweight Callbacks>.
748
749=for apidoc Ams||PUSH_MULTICALL
750Opening bracket for a lightweight callback.
751See L<perlcall/Lightweight Callbacks>.
752
753=for apidoc Ams||MULTICALL
754Make a lightweight callback. See L<perlcall/Lightweight Callbacks>.
755
756=for apidoc Ams||POP_MULTICALL
757Closing bracket for a lightweight callback.
758See L<perlcall/Lightweight Callbacks>.
759
760=cut
761*/
762
763#define dMULTICALL \
764 SV **newsp; /* set by POPBLOCK */ \
765 PERL_CONTEXT *cx; \
82f35e8b 766 CV *multicall_cv; \
9850bf21
RH
767 OP *multicall_cop; \
768 bool multicall_oldcatch; \
769 U8 hasargs = 0 /* used by PUSHSUB */
770
82f35e8b 771#define PUSH_MULTICALL(the_cv) \
9850bf21 772 STMT_START { \
0bcc34c2
AL
773 CV * const _nOnclAshIngNamE_ = the_cv; \
774 CV * const cv = _nOnclAshIngNamE_; \
775 AV * const padlist = CvPADLIST(cv); \
9850bf21
RH
776 ENTER; \
777 multicall_oldcatch = CATCH_GET; \
778 SAVETMPS; SAVEVPTR(PL_op); \
779 CATCH_SET(TRUE); \
780 PUSHBLOCK(cx, CXt_SUB|CXp_MULTICALL, PL_stack_sp); \
781 PUSHSUB(cx); \
782 if (++CvDEPTH(cv) >= 2) { \
783 PERL_STACK_OVERFLOW_CHECK(); \
784 Perl_pad_push(aTHX_ padlist, CvDEPTH(cv)); \
785 } \
786 SAVECOMPPAD(); \
787 PAD_SET_CUR_NOSAVE(padlist, CvDEPTH(cv)); \
82f35e8b 788 multicall_cv = cv; \
9850bf21
RH
789 multicall_cop = CvSTART(cv); \
790 } STMT_END
791
792#define MULTICALL \
793 STMT_START { \
794 PL_op = multicall_cop; \
795 CALLRUNOPS(aTHX); \
796 } STMT_END
797
798#define POP_MULTICALL \
799 STMT_START { \
82f35e8b
RH
800 LEAVESUB(multicall_cv); \
801 CvDEPTH(multicall_cv)--; \
9850bf21
RH
802 POPBLOCK(cx,PL_curpm); \
803 CATCH_SET(multicall_oldcatch); \
804 LEAVE; \
805 } STMT_END