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