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