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