This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
factor out common actions in TOPBLOCK and POPBLOCK
[perl5.git] / cop.h
CommitLineData
a0d0e21e 1/* cop.h
79072805 2 *
1129b882 3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
8622e0e2 4 * 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 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 *
8622e0e2 9 * Control ops (cops) are one of the two ops OP_NEXTSTATE and OP_DBSTATE,
775e5718 10 * that (loosely speaking) are statement separators.
3ffa1527
JH
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 16/* A jmpenv packages the state required to perform a proper non-local jump.
1c98cc53
DM
17 * Note that there is a PL_start_env initialized when perl starts, and
18 * PL_top_env points to this initially, so PL_top_env should always be
19 * non-null.
0d2925a6 20 *
1c98cc53
DM
21 * Existence of a non-null PL_top_env->je_prev implies it is valid to call
22 * longjmp() at that runlevel (we make sure PL_start_env.je_prev is always
0d2925a6
DM
23 * null to ensure this).
24 *
25 * je_mustcatch, when set at any runlevel to TRUE, means eval ops must
26 * establish a local jmpenv to handle exception traps. Care must be taken
27 * to restore the previous value of je_mustcatch before exiting the
28 * stack frame iff JMPENV_PUSH was not called in that stack frame.
29 * GSAR 97-03-27
30 */
31
32struct jmpenv {
33 struct jmpenv * je_prev;
caa674f3 34 Sigjmp_buf je_buf; /* uninit if je_prev is NULL */
0d2925a6
DM
35 int je_ret; /* last exception thrown */
36 bool je_mustcatch; /* need to call longjmp()? */
a68090fe 37 U16 je_old_delaymagic; /* saved PL_delaymagic */
0d2925a6
DM
38};
39
40typedef struct jmpenv JMPENV;
41
0d2925a6
DM
42/*
43 * How to build the first jmpenv.
44 *
45 * top_env needs to be non-zero. It points to an area
46 * in which longjmp() stuff is stored, as C callstack
47 * info there at least is thread specific this has to
48 * be per-thread. Otherwise a 'die' in a thread gives
49 * that thread the C stack of last thread to do an eval {}!
50 */
51
52#define JMPENV_BOOTSTRAP \
53 STMT_START { \
caa674f3
DD
54 PERL_POISON_EXPR(PoisonNew(&PL_start_env, 1, JMPENV));\
55 PL_top_env = &PL_start_env; \
56 PL_start_env.je_prev = NULL; \
0d2925a6
DM
57 PL_start_env.je_ret = -1; \
58 PL_start_env.je_mustcatch = TRUE; \
a68090fe 59 PL_start_env.je_old_delaymagic = 0; \
0d2925a6
DM
60 } STMT_END
61
62/*
63 * PERL_FLEXIBLE_EXCEPTIONS
64 *
65 * All the flexible exceptions code has been removed.
66 * See the following threads for details:
67 *
68 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2004-07/msg00378.html
69 *
70 * Joshua's original patches (which weren't applied) and discussion:
71 *
72 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg01396.html
73 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg01489.html
74 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg01491.html
75 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg01608.html
76 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg02144.html
77 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg02998.html
78 *
79 * Chip's reworked patch and discussion:
80 *
81 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1999-03/msg00520.html
82 *
83 * The flaw in these patches (which went unnoticed at the time) was
84 * that they moved some code that could potentially die() out of the
85 * region protected by the setjmp()s. This caused exceptions within
86 * END blocks and such to not be handled by the correct setjmp().
87 *
88 * The original patches that introduces flexible exceptions were:
89 *
ff7e9008
MS
90 * http://perl5.git.perl.org/perl.git/commit/312caa8e97f1c7ee342a9895c2f0e749625b4929
91 * http://perl5.git.perl.org/perl.git/commit/14dd3ad8c9bf82cf09798a22cc89a9862dfd6d1a
92 *
0d2925a6
DM
93 */
94
95#define dJMPENV JMPENV cur_env
96
97#define JMPENV_PUSH(v) \
98 STMT_START { \
1c98cc53
DM
99 DEBUG_l({ \
100 int i = 0; JMPENV *p = PL_top_env; \
101 while (p) { i++; p = p->je_prev; } \
91e35ba1
DM
102 Perl_deb(aTHX_ "JUMPENV_PUSH level=%d at %s:%d\n", \
103 i, __FILE__, __LINE__);}) \
0d2925a6 104 cur_env.je_prev = PL_top_env; \
0d2925a6 105 cur_env.je_ret = PerlProc_setjmp(cur_env.je_buf, SCOPE_SAVES_SIGNAL_MASK); \
0d2925a6
DM
106 PL_top_env = &cur_env; \
107 cur_env.je_mustcatch = FALSE; \
a68090fe 108 cur_env.je_old_delaymagic = PL_delaymagic; \
0d2925a6
DM
109 (v) = cur_env.je_ret; \
110 } STMT_END
111
112#define JMPENV_POP \
113 STMT_START { \
1c98cc53
DM
114 DEBUG_l({ \
115 int i = -1; JMPENV *p = PL_top_env; \
116 while (p) { i++; p = p->je_prev; } \
91e35ba1
DM
117 Perl_deb(aTHX_ "JUMPENV_POP level=%d at %s:%d\n", \
118 i, __FILE__, __LINE__);}) \
d3ab86be 119 assert(PL_top_env == &cur_env); \
a68090fe 120 PL_delaymagic = cur_env.je_old_delaymagic; \
0d2925a6
DM
121 PL_top_env = cur_env.je_prev; \
122 } STMT_END
123
124#define JMPENV_JUMP(v) \
125 STMT_START { \
1c98cc53
DM
126 DEBUG_l({ \
127 int i = -1; JMPENV *p = PL_top_env; \
128 while (p) { i++; p = p->je_prev; } \
91e35ba1
DM
129 Perl_deb(aTHX_ "JUMPENV_JUMP(%d) level=%d at %s:%d\n", \
130 (int)v, i, __FILE__, __LINE__);}) \
0d2925a6
DM
131 if (PL_top_env->je_prev) \
132 PerlProc_longjmp(PL_top_env->je_buf, (v)); \
133 if ((v) == 2) \
37038d91 134 PerlProc_exit(STATUS_EXIT); \
5637ef5b 135 PerlIO_printf(PerlIO_stderr(), "panic: top_env, v=%d\n", (int)v); \
0d2925a6
DM
136 PerlProc_exit(1); \
137 } STMT_END
138
139#define CATCH_GET (PL_top_env->je_mustcatch)
1c98cc53
DM
140#define CATCH_SET(v) \
141 STMT_START { \
142 DEBUG_l( \
143 Perl_deb(aTHX_ \
144 "JUMPLEVEL set catch %d => %d (for %p) at %s:%d\n", \
145 PL_top_env->je_mustcatch, v, (void*)PL_top_env, \
146 __FILE__, __LINE__);) \
147 PL_top_env->je_mustcatch = (v); \
148 } STMT_END
0d2925a6 149
20439bc7
Z
150/*
151=head1 COP Hint Hashes
152*/
153
154typedef struct refcounted_he COPHH;
155
156#define COPHH_KEY_UTF8 REFCOUNTED_HE_KEY_UTF8
157
158/*
ffd08bbf 159=for apidoc Amx|SV *|cophh_fetch_pvn|const COPHH *cophh|const char *keypv|STRLEN keylen|U32 hash|U32 flags
20439bc7 160
2d7f6611
KW
161Look up the entry in the cop hints hash C<cophh> with the key specified by
162C<keypv> and C<keylen>. If C<flags> has the C<COPHH_KEY_UTF8> bit set,
20439bc7 163the key octets are interpreted as UTF-8, otherwise they are interpreted
2d7f6611 164as Latin-1. C<hash> is a precomputed hash of the key string, or zero if
20439bc7
Z
165it has not been precomputed. Returns a mortal scalar copy of the value
166associated with the key, or C<&PL_sv_placeholder> if there is no value
167associated with the key.
168
169=cut
170*/
171
172#define cophh_fetch_pvn(cophh, keypv, keylen, hash, flags) \
173 Perl_refcounted_he_fetch_pvn(aTHX_ cophh, keypv, keylen, hash, flags)
174
175/*
ffd08bbf 176=for apidoc Amx|SV *|cophh_fetch_pvs|const COPHH *cophh|const char *key|U32 flags
20439bc7
Z
177
178Like L</cophh_fetch_pvn>, but takes a literal string instead of a
179string/length pair, and no precomputed hash.
180
181=cut
182*/
183
184#define cophh_fetch_pvs(cophh, key, flags) \
185 Perl_refcounted_he_fetch_pvn(aTHX_ cophh, STR_WITH_LEN(key), 0, flags)
186
187/*
ffd08bbf 188=for apidoc Amx|SV *|cophh_fetch_pv|const COPHH *cophh|const char *key|U32 hash|U32 flags
20439bc7
Z
189
190Like L</cophh_fetch_pvn>, but takes a nul-terminated string instead of
191a string/length pair.
192
193=cut
194*/
195
196#define cophh_fetch_pv(cophh, key, hash, flags) \
197 Perl_refcounted_he_fetch_pv(aTHX_ cophh, key, hash, flags)
198
199/*
ffd08bbf 200=for apidoc Amx|SV *|cophh_fetch_sv|const COPHH *cophh|SV *key|U32 hash|U32 flags
20439bc7
Z
201
202Like L</cophh_fetch_pvn>, but takes a Perl scalar instead of a
203string/length pair.
204
205=cut
206*/
207
208#define cophh_fetch_sv(cophh, key, hash, flags) \
209 Perl_refcounted_he_fetch_sv(aTHX_ cophh, key, hash, flags)
210
211/*
ffd08bbf 212=for apidoc Amx|HV *|cophh_2hv|const COPHH *cophh|U32 flags
20439bc7
Z
213
214Generates and returns a standard Perl hash representing the full set of
2d7f6611 215key/value pairs in the cop hints hash C<cophh>. C<flags> is currently
20439bc7
Z
216unused and must be zero.
217
218=cut
219*/
220
221#define cophh_2hv(cophh, flags) \
222 Perl_refcounted_he_chain_2hv(aTHX_ cophh, flags)
223
224/*
ffd08bbf 225=for apidoc Amx|COPHH *|cophh_copy|COPHH *cophh
20439bc7 226
2d7f6611 227Make and return a complete copy of the cop hints hash C<cophh>.
20439bc7
Z
228
229=cut
230*/
231
232#define cophh_copy(cophh) Perl_refcounted_he_inc(aTHX_ cophh)
233
234/*
ffd08bbf 235=for apidoc Amx|void|cophh_free|COPHH *cophh
20439bc7 236
2d7f6611 237Discard the cop hints hash C<cophh>, freeing all resources associated
20439bc7
Z
238with it.
239
240=cut
241*/
242
243#define cophh_free(cophh) Perl_refcounted_he_free(aTHX_ cophh)
244
245/*
ffd08bbf 246=for apidoc Amx|COPHH *|cophh_new_empty
20439bc7
Z
247
248Generate and return a fresh cop hints hash containing no entries.
249
250=cut
251*/
252
253#define cophh_new_empty() ((COPHH *)NULL)
254
255/*
ffd08bbf 256=for apidoc Amx|COPHH *|cophh_store_pvn|COPHH *cophh|const char *keypv|STRLEN keylen|U32 hash|SV *value|U32 flags
20439bc7 257
2d7f6611 258Stores a value, associated with a key, in the cop hints hash C<cophh>,
20439bc7
Z
259and returns the modified hash. The returned hash pointer is in general
260not the same as the hash pointer that was passed in. The input hash is
261consumed by the function, and the pointer to it must not be subsequently
262used. Use L</cophh_copy> if you need both hashes.
263
2d7f6611 264The key is specified by C<keypv> and C<keylen>. If C<flags> has the
20439bc7 265C<COPHH_KEY_UTF8> bit set, the key octets are interpreted as UTF-8,
2d7f6611 266otherwise they are interpreted as Latin-1. C<hash> is a precomputed
20439bc7
Z
267hash of the key string, or zero if it has not been precomputed.
268
2d7f6611 269C<value> is the scalar value to store for this key. C<value> is copied
20439bc7
Z
270by this function, which thus does not take ownership of any reference
271to it, and later changes to the scalar will not be reflected in the
272value visible in the cop hints hash. Complex types of scalar will not
273be stored with referential integrity, but will be coerced to strings.
274
275=cut
276*/
277
278#define cophh_store_pvn(cophh, keypv, keylen, hash, value, flags) \
279 Perl_refcounted_he_new_pvn(aTHX_ cophh, keypv, keylen, hash, value, flags)
280
281/*
ffd08bbf 282=for apidoc Amx|COPHH *|cophh_store_pvs|const COPHH *cophh|const char *key|SV *value|U32 flags
20439bc7
Z
283
284Like L</cophh_store_pvn>, but takes a literal string instead of a
285string/length pair, and no precomputed hash.
286
287=cut
288*/
289
290#define cophh_store_pvs(cophh, key, value, flags) \
291 Perl_refcounted_he_new_pvn(aTHX_ cophh, STR_WITH_LEN(key), 0, value, flags)
292
293/*
ffd08bbf 294=for apidoc Amx|COPHH *|cophh_store_pv|const COPHH *cophh|const char *key|U32 hash|SV *value|U32 flags
20439bc7
Z
295
296Like L</cophh_store_pvn>, but takes a nul-terminated string instead of
297a string/length pair.
298
299=cut
300*/
301
302#define cophh_store_pv(cophh, key, hash, value, flags) \
303 Perl_refcounted_he_new_pv(aTHX_ cophh, key, hash, value, flags)
304
305/*
ffd08bbf 306=for apidoc Amx|COPHH *|cophh_store_sv|const COPHH *cophh|SV *key|U32 hash|SV *value|U32 flags
20439bc7
Z
307
308Like L</cophh_store_pvn>, but takes a Perl scalar instead of a
309string/length pair.
310
311=cut
312*/
313
314#define cophh_store_sv(cophh, key, hash, value, flags) \
315 Perl_refcounted_he_new_sv(aTHX_ cophh, key, hash, value, flags)
316
317/*
ffd08bbf 318=for apidoc Amx|COPHH *|cophh_delete_pvn|COPHH *cophh|const char *keypv|STRLEN keylen|U32 hash|U32 flags
20439bc7 319
2d7f6611 320Delete a key and its associated value from the cop hints hash C<cophh>,
20439bc7
Z
321and returns the modified hash. The returned hash pointer is in general
322not the same as the hash pointer that was passed in. The input hash is
323consumed by the function, and the pointer to it must not be subsequently
324used. Use L</cophh_copy> if you need both hashes.
325
2d7f6611 326The key is specified by C<keypv> and C<keylen>. If C<flags> has the
20439bc7 327C<COPHH_KEY_UTF8> bit set, the key octets are interpreted as UTF-8,
2d7f6611 328otherwise they are interpreted as Latin-1. C<hash> is a precomputed
20439bc7
Z
329hash of the key string, or zero if it has not been precomputed.
330
331=cut
332*/
333
334#define cophh_delete_pvn(cophh, keypv, keylen, hash, flags) \
335 Perl_refcounted_he_new_pvn(aTHX_ cophh, keypv, keylen, hash, \
336 (SV *)NULL, flags)
337
338/*
ffd08bbf 339=for apidoc Amx|COPHH *|cophh_delete_pvs|const COPHH *cophh|const char *key|U32 flags
20439bc7
Z
340
341Like L</cophh_delete_pvn>, but takes a literal string instead of a
342string/length pair, and no precomputed hash.
343
344=cut
345*/
346
347#define cophh_delete_pvs(cophh, key, flags) \
348 Perl_refcounted_he_new_pvn(aTHX_ cophh, STR_WITH_LEN(key), 0, \
349 (SV *)NULL, flags)
350
351/*
ffd08bbf 352=for apidoc Amx|COPHH *|cophh_delete_pv|const COPHH *cophh|const char *key|U32 hash|U32 flags
20439bc7
Z
353
354Like L</cophh_delete_pvn>, but takes a nul-terminated string instead of
355a string/length pair.
356
357=cut
358*/
359
360#define cophh_delete_pv(cophh, key, hash, flags) \
361 Perl_refcounted_he_new_pv(aTHX_ cophh, key, hash, (SV *)NULL, flags)
362
363/*
ffd08bbf 364=for apidoc Amx|COPHH *|cophh_delete_sv|const COPHH *cophh|SV *key|U32 hash|U32 flags
20439bc7
Z
365
366Like L</cophh_delete_pvn>, but takes a Perl scalar instead of a
367string/length pair.
368
369=cut
370*/
371
372#define cophh_delete_sv(cophh, key, hash, flags) \
373 Perl_refcounted_he_new_sv(aTHX_ cophh, key, hash, (SV *)NULL, flags)
0d2925a6 374
5ac1e9b2 375#include "mydtrace.h"
0d2925a6 376
88df5f01
FC
377struct cop {
378 BASEOP
379 /* On LP64 putting this here takes advantage of the fact that BASEOP isn't
380 an exact multiple of 8 bytes to save structure padding. */
381 line_t cop_line; /* line # of this command */
382 /* label for this construct is now stored in cop_hints_hash */
57843af0 383#ifdef USE_ITHREADS
88df5f01
FC
384 PADOFFSET cop_stashoff; /* offset into PL_stashpad, for the
385 package the line was compiled in */
1dc74fdb 386 char * cop_file; /* file name the following line # is from */
57843af0 387#else
88df5f01 388 HV * cop_stash; /* package line was compiled in */
79072805 389 GV * cop_filegv; /* file the following line # is from */
57843af0 390#endif
88df5f01
FC
391 U32 cop_hints; /* hints bits from pragmata */
392 U32 cop_seq; /* parse sequence number */
393 /* Beware. mg.c and warnings.pl assume the type of this is STRLEN *: */
394 STRLEN * cop_warnings; /* lexical warnings bitmask */
395 /* compile time state of %^H. See the comment in op.c for how this is
396 used to recreate a hash to return from caller. */
20439bc7 397 COPHH * cop_hints_hash;
79072805
LW
398};
399
57843af0 400#ifdef USE_ITHREADS
1dc74fdb
FC
401# define CopFILE(c) ((c)->cop_file)
402# define CopFILEGV(c) (CopFILE(c) \
403 ? gv_fetchfile(CopFILE(c)) : NULL)
404
405# ifdef NETWARE
406# define CopFILE_set(c,pv) ((c)->cop_file = savepv(pv))
d166b3ad 407# define CopFILE_setn(c,pv,l) ((c)->cop_file = savepvn((pv),(l)))
1dc74fdb
FC
408# else
409# define CopFILE_set(c,pv) ((c)->cop_file = savesharedpv(pv))
410# define CopFILE_setn(c,pv,l) ((c)->cop_file = savesharedpvn((pv),(l)))
411# endif
412
413# define CopFILESV(c) (CopFILE(c) \
414 ? GvSV(gv_fetchfile(CopFILE(c))) : NULL)
415# define CopFILEAV(c) (CopFILE(c) \
416 ? GvAV(gv_fetchfile(CopFILE(c))) : NULL)
417# define CopFILEAVx(c) (assert_(CopFILE(c)) \
418 GvAV(gv_fetchfile(CopFILE(c))))
083fcd59 419
d4d03940
FC
420# define CopSTASH(c) PL_stashpad[(c)->cop_stashoff]
421# define CopSTASH_set(c,hv) ((c)->cop_stashoff = (hv) \
422 ? alloccopstash(hv) \
423 : 0)
1dc74fdb
FC
424# ifdef NETWARE
425# define CopFILE_free(c) SAVECOPFILE_FREE(c)
426# else
427# define CopFILE_free(c) (PerlMemShared_free(CopFILE(c)),(CopFILE(c) = NULL))
428# endif
57843af0
GS
429#else
430# define CopFILEGV(c) ((c)->cop_filegv)
f4dd75d9 431# define CopFILEGV_set(c,gv) ((c)->cop_filegv = (GV*)SvREFCNT_inc(gv))
1dc74fdb
FC
432# define CopFILE_set(c,pv) CopFILEGV_set((c), gv_fetchfile(pv))
433# define CopFILE_setn(c,pv,l) CopFILEGV_set((c), gv_fetchfile_flags((pv),(l),0))
434# define CopFILESV(c) (CopFILEGV(c) ? GvSV(CopFILEGV(c)) : NULL)
435# define CopFILEAV(c) (CopFILEGV(c) ? GvAV(CopFILEGV(c)) : NULL)
436# ifdef DEBUGGING
437# define CopFILEAVx(c) (assert(CopFILEGV(c)), GvAV(CopFILEGV(c)))
438# else
439# define CopFILEAVx(c) (GvAV(CopFILEGV(c)))
440# endif
441# define CopFILE(c) (CopFILEGV(c) \
442 ? GvNAME(CopFILEGV(c))+2 : NULL)
57843af0 443# define CopSTASH(c) ((c)->cop_stash)
f4dd75d9 444# define CopSTASH_set(c,hv) ((c)->cop_stash = (hv))
a0714e2c 445# define CopFILE_free(c) (SvREFCNT_dec(CopFILEGV(c)),(CopFILEGV(c) = NULL))
05ec9bb3 446
57843af0 447#endif /* USE_ITHREADS */
20439bc7 448
d4d03940
FC
449#define CopSTASHPV(c) (CopSTASH(c) ? HvNAME_get(CopSTASH(c)) : NULL)
450 /* cop_stash is not refcounted */
451#define CopSTASHPV_set(c,pv) CopSTASH_set((c), gv_stashpv(pv,GV_ADD))
452#define CopSTASH_eq(c,hv) (CopSTASH(c) == (hv))
d4d03940 453
20439bc7
Z
454#define CopHINTHASH_get(c) ((COPHH*)((c)->cop_hints_hash))
455#define CopHINTHASH_set(c,h) ((c)->cop_hints_hash = (h))
456
457/*
458=head1 COP Hint Reading
459*/
460
461/*
462=for apidoc Am|SV *|cop_hints_fetch_pvn|const COP *cop|const char *keypv|STRLEN keylen|U32 hash|U32 flags
463
2d7f6611
KW
464Look up the hint entry in the cop C<cop> with the key specified by
465C<keypv> and C<keylen>. If C<flags> has the C<COPHH_KEY_UTF8> bit set,
20439bc7 466the key octets are interpreted as UTF-8, otherwise they are interpreted
2d7f6611 467as Latin-1. C<hash> is a precomputed hash of the key string, or zero if
20439bc7
Z
468it has not been precomputed. Returns a mortal scalar copy of the value
469associated with the key, or C<&PL_sv_placeholder> if there is no value
470associated with the key.
471
472=cut
473*/
474
475#define cop_hints_fetch_pvn(cop, keypv, keylen, hash, flags) \
476 cophh_fetch_pvn(CopHINTHASH_get(cop), keypv, keylen, hash, flags)
477
478/*
479=for apidoc Am|SV *|cop_hints_fetch_pvs|const COP *cop|const char *key|U32 flags
480
481Like L</cop_hints_fetch_pvn>, but takes a literal string instead of a
482string/length pair, and no precomputed hash.
483
484=cut
485*/
486
487#define cop_hints_fetch_pvs(cop, key, flags) \
488 cophh_fetch_pvs(CopHINTHASH_get(cop), key, flags)
489
490/*
491=for apidoc Am|SV *|cop_hints_fetch_pv|const COP *cop|const char *key|U32 hash|U32 flags
492
493Like L</cop_hints_fetch_pvn>, but takes a nul-terminated string instead
494of a string/length pair.
495
496=cut
497*/
498
499#define cop_hints_fetch_pv(cop, key, hash, flags) \
500 cophh_fetch_pv(CopHINTHASH_get(cop), key, hash, flags)
501
502/*
503=for apidoc Am|SV *|cop_hints_fetch_sv|const COP *cop|SV *key|U32 hash|U32 flags
504
505Like L</cop_hints_fetch_pvn>, but takes a Perl scalar instead of a
506string/length pair.
507
508=cut
509*/
510
511#define cop_hints_fetch_sv(cop, key, hash, flags) \
512 cophh_fetch_sv(CopHINTHASH_get(cop), key, hash, flags)
513
514/*
515=for apidoc Am|HV *|cop_hints_2hv|const COP *cop|U32 flags
516
517Generates and returns a standard Perl hash representing the full set of
2d7f6611 518hint entries in the cop C<cop>. C<flags> is currently unused and must
20439bc7
Z
519be zero.
520
521=cut
522*/
523
524#define cop_hints_2hv(cop, flags) \
525 cophh_2hv(CopHINTHASH_get(cop), flags)
526
aebc0cbe 527#define CopLABEL(c) Perl_cop_fetch_label(aTHX_ (c), NULL, NULL)
5db1eb8d
BF
528#define CopLABEL_len(c,len) Perl_cop_fetch_label(aTHX_ (c), len, NULL)
529#define CopLABEL_len_flags(c,len,flags) Perl_cop_fetch_label(aTHX_ (c), len, flags)
dca6062a 530#define CopLABEL_alloc(pv) ((pv)?savepv(pv):NULL)
57843af0 531
ed094faf 532#define CopSTASH_ne(c,hv) (!CopSTASH_eq(c,hv))
cc49e20b 533#define CopLINE(c) ((c)->cop_line)
57843af0
GS
534#define CopLINE_inc(c) (++CopLINE(c))
535#define CopLINE_dec(c) (--CopLINE(c))
536#define CopLINE_set(c,l) (CopLINE(c) = (l))
cc49e20b 537
248c2a4d 538/* OutCopFILE() is CopFILE for output (caller, die, warn, etc.) */
e37778c2 539#define OutCopFILE(c) CopFILE(c)
248c2a4d 540
d5ec2987 541#define CopHINTS_get(c) ((c)->cop_hints + 0)
623e6609 542#define CopHINTS_set(c, h) STMT_START { \
d5ec2987 543 (c)->cop_hints = (h); \
623e6609
NC
544 } STMT_END
545
79072805
LW
546/*
547 * Here we have some enormously heavy (or at least ponderous) wizardry.
548 */
549
550/* subroutine context */
551struct block_sub {
f9c764c5 552 OP * retop; /* op to execute on exit from sub */
adcbf118 553 /* Above here is the same for sub, format and eval. */
9aa350eb 554 PAD *prevcomppad; /* the caller's PL_comppad */
8e663997 555 CV * cv;
f9c764c5 556 /* Above here is the same for sub and format. */
bb172083 557 I32 olddepth;
3073d04f 558 AV *savearray;
f9c764c5
NC
559};
560
561
562/* format context */
563struct block_format {
f39bc417 564 OP * retop; /* op to execute on exit from sub */
adcbf118 565 /* Above here is the same for sub, format and eval. */
9aa350eb 566 PAD *prevcomppad; /* the caller's PL_comppad */
8e663997 567 CV * cv;
f9c764c5
NC
568 /* Above here is the same for sub and format. */
569 GV * gv;
570 GV * dfoutgv;
79072805
LW
571};
572
4ebe6e95
DM
573/* return a pointer to the current context */
574
575#define CX_CUR() (&cxstack[cxstack_ix])
576
dfe0f39b
DM
577/* free all savestack items back to the watermark of the specified context */
578
e992140c 579#define CX_LEAVE_SCOPE(cx) LEAVE_SCOPE(cx->blk_oldsaveix)
dfe0f39b 580
5da525e9
DM
581#ifdef DEBUGGING
582/* on debugging builds, poison cx afterwards so we know no code
583 * uses it - because after doing cxstack_ix--, any ties, exceptions etc
584 * may overwrite the current stack frame */
585# define CX_POP(cx) \
4ebe6e95 586 assert(CX_CUR() == cx); \
5da525e9
DM
587 cxstack_ix--; \
588 cx = NULL;
589#else
590# define CX_POP(cx) cxstack_ix--;
591#endif
592
593
b36bdeca 594/* base for the next two macros. Don't use directly.
d6911e1b
DM
595 * The context frame holds a reference to the CV so that it can't be
596 * freed while we're executing it */
b36bdeca 597
ee98a1d6 598#define PUSHSUB_BASE(cx) \
88dbe4af
FC
599 ENTRY_PROBE(CvNAMED(cv) \
600 ? HEK_KEY(CvNAME_HEK(cv)) \
601 : GvENAME(CvGV(cv)), \
c6903450 602 CopFILE((const COP *)CvSTART(cv)), \
3e2413e5
DL
603 CopLINE((const COP *)CvSTART(cv)), \
604 CopSTASHPV((const COP *)CvSTART(cv))); \
5ac1e9b2 605 \
79072805 606 cx->blk_sub.cv = cv; \
b8f55b69 607 cx->blk_sub.olddepth = CvDEPTH(cv); \
3b21fb5d 608 cx->blk_sub.prevcomppad = PL_comppad; \
ae423868 609 cx->cx_type |= (hasargs) ? CXp_HASARGS : 0; \
5f66b61c 610 cx->blk_sub.retop = NULL; \
94a11f7c 611 SvREFCNT_inc_simple_void_NN(cv);
b36bdeca 612
4587c532 613#define PUSHSUB_GET_LVALUE_MASK(func) \
777d9014
FC
614 /* If the context is indeterminate, then only the lvalue */ \
615 /* flags that the caller also has are applicable. */ \
4587c532 616 ( \
777d9014
FC
617 (PL_op->op_flags & OPf_WANT) \
618 ? OPpENTERSUB_LVAL_MASK \
619 : !(PL_op->op_private & OPpENTERSUB_LVAL_MASK) \
4587c532
FC
620 ? 0 : (U8)func(aTHX) \
621 )
622
623#define PUSHSUB(cx) \
624 { \
625 U8 phlags = PUSHSUB_GET_LVALUE_MASK(Perl_was_lvalue_sub); \
ee98a1d6 626 PUSHSUB_BASE(cx) \
446d0787 627 cx->blk_u16 = PL_op->op_private & \
0e9700df 628 (phlags|OPpDEREF); \
777d9014 629 }
79072805 630
ee98a1d6
DM
631/* variant for use by OP_DBSTATE, where op_private holds hint bits */
632#define PUSHSUB_DB(cx) \
633 PUSHSUB_BASE(cx) \
446d0787 634 cx->blk_u16 = 0;
ee98a1d6
DM
635
636
10067d9a 637#define PUSHFORMAT(cx, retop) \
f9c764c5
NC
638 cx->blk_format.cv = cv; \
639 cx->blk_format.gv = gv; \
640 cx->blk_format.retop = (retop); \
f9c764c5 641 cx->blk_format.dfoutgv = PL_defoutgv; \
3b21fb5d 642 cx->blk_format.prevcomppad = PL_comppad; \
1956db7e 643 cx->blk_u16 = 0; \
e992140c 644 cx->blk_oldsaveix = PL_savestack_ix; \
2c50b7ed 645 SvREFCNT_inc_simple_void_NN(cv); \
f32c7e86 646 CvDEPTH(cv)++; \
f9c764c5 647 SvREFCNT_inc_void(cx->blk_format.dfoutgv)
79072805 648
fad386cb 649/* Restore old @_ */
6fb05a88 650#define POP_SAVEARRAY(cx) \
6d4ff0d2 651 STMT_START { \
fad386cb 652 AV *av = GvAV(PL_defgv); \
a8bba7fa 653 GvAV(PL_defgv) = cx->blk_sub.savearray; \
656457d0 654 cx->blk_sub.savearray = NULL; \
fad386cb 655 SvREFCNT_dec(av); \
6d4ff0d2 656 } STMT_END
6d4ff0d2 657
ecf8e9dd 658/* junk in @_ spells trouble when cloning CVs and in pp_caller(), so don't
8e09340b
GS
659 * leave any (a fast av_clear(ary), basically) */
660#define CLEAR_ARGARRAY(ary) \
661 STMT_START { \
662 AvMAX(ary) += AvARRAY(ary) - AvALLOC(ary); \
9c6bc640 663 AvARRAY(ary) = AvALLOC(ary); \
8e09340b
GS
664 AvFILLp(ary) = -1; \
665 } STMT_END
7766f137 666
7e27c4a5
DM
667
668/* subsets of POPSUB */
669
670#define POPSUB_COMMON(cx) \
656457d0
DM
671 STMT_START { \
672 CV *cv; \
673 PL_comppad = cx->blk_sub.prevcomppad; \
674 PL_curpad = LIKELY(PL_comppad) ? AvARRAY(PL_comppad) : NULL; \
675 cv = cx->blk_sub.cv; \
676 CvDEPTH(cv) = cx->blk_sub.olddepth; \
677 cx->blk_sub.cv = NULL; \
678 SvREFCNT_dec(cv); \
679 } STMT_END
7e27c4a5 680
04e686b8
DM
681/* handle the @_ part of leaving a sub */
682
683#define POPSUB_ARGS(cx) \
684 STMT_START { \
685 AV *av; \
686 assert(AvARRAY(MUTABLE_AV( \
687 PadlistARRAY(CvPADLIST(cx->blk_sub.cv))[ \
688 CvDEPTH(cx->blk_sub.cv)])) == PL_curpad); \
6fb05a88 689 POP_SAVEARRAY(cx); \
04e686b8
DM
690 av = MUTABLE_AV(PAD_SVl(0)); \
691 if (UNLIKELY(AvREAL(av))) \
e2b78548 692 /* abandon @_ if it got reified */ \
04e686b8
DM
693 clear_defarray(av, 0); \
694 else { \
695 CLEAR_ARGARRAY(av); \
696 } \
697 } STMT_END
7e27c4a5 698
88c90157 699#define POPSUB(cx) \
b0d9ce38 700 STMT_START { \
88dbe4af
FC
701 RETURN_PROBE(CvNAMED(cx->blk_sub.cv) \
702 ? HEK_KEY(CvNAME_HEK(cx->blk_sub.cv)) \
703 : GvENAME(CvGV(cx->blk_sub.cv)), \
8f629a87 704 CopFILE((COP*)CvSTART((const CV*)cx->blk_sub.cv)), \
3e2413e5
DL
705 CopLINE((COP*)CvSTART((const CV*)cx->blk_sub.cv)), \
706 CopSTASHPV((COP*)CvSTART((const CV*)cx->blk_sub.cv))); \
5ac1e9b2 707 \
bafb2adc 708 if (CxHASARGS(cx)) { \
04e686b8 709 POPSUB_ARGS(cx); \
79072805 710 } \
7e27c4a5 711 POPSUB_COMMON(cx); \
b0d9ce38 712 } STMT_END
79072805
LW
713
714#define POPFORMAT(cx) \
25375124 715 STMT_START { \
656457d0
DM
716 CV *cv; \
717 GV * const dfout = cx->blk_format.dfoutgv; \
718 setdefout(dfout); \
719 cx->blk_format.dfoutgv = NULL; \
720 SvREFCNT_dec_NN(dfout); /* the cx->defoutgv ref */ \
3b21fb5d
DM
721 PL_comppad = cx->blk_format.prevcomppad; \
722 PL_curpad = LIKELY(PL_comppad) ? AvARRAY(PL_comppad) : NULL; \
656457d0
DM
723 cv = cx->blk_format.cv; \
724 cx->blk_format.cv = NULL;; \
2c50b7ed 725 --CvDEPTH(cv); \
656457d0 726 SvREFCNT_dec_NN(cv); \
25375124 727 } STMT_END
79072805
LW
728
729/* eval context */
730struct block_eval {
8e663997
NC
731 OP * retop; /* op to execute on exit from eval */
732 /* Above here is the same for sub, format and eval. */
0f79a09d 733 SV * old_namesv;
79072805 734 OP * old_eval_root;
748a9306 735 SV * cur_text;
2090ab20 736 CV * cv;
abd70938 737 JMPENV * cur_top_env; /* value of PL_top_env when eval CX created */
79072805
LW
738};
739
17347a51
NC
740/* If we ever need more than 512 op types, change the shift from 7.
741 blku_gimme is actually also only 2 bits, so could be merged with something.
742*/
743
744#define CxOLD_IN_EVAL(cx) (((cx)->blk_u16) & 0x7F)
745#define CxOLD_OP_TYPE(cx) (((cx)->blk_u16) >> 7)
85a64632 746
6b75f042 747#define PUSHEVAL(cx,n) \
0f79a09d 748 STMT_START { \
17347a51
NC
749 assert(!(PL_in_eval & ~0x7F)); \
750 assert(!(PL_op->op_type & ~0x1FF)); \
751 cx->blk_u16 = (PL_in_eval & 0x7F) | ((U16)PL_op->op_type << 7); \
a0714e2c 752 cx->blk_eval.old_namesv = (n ? newSVpv(n,0) : NULL); \
a8bba7fa 753 cx->blk_eval.old_eval_root = PL_eval_root; \
bdc0bf6f 754 cx->blk_eval.cur_text = PL_parser ? PL_parser->linestr : NULL; \
9aba0c93 755 cx->blk_eval.cv = NULL; /* set by doeval_compile() as applicable */ \
5f66b61c 756 cx->blk_eval.retop = NULL; \
abd70938 757 cx->blk_eval.cur_top_env = PL_top_env; \
0f79a09d 758 } STMT_END
79072805
LW
759
760#define POPEVAL(cx) \
0f79a09d 761 STMT_START { \
f09cca8c 762 SV *sv; \
85a64632 763 PL_in_eval = CxOLD_IN_EVAL(cx); \
7766f137 764 PL_eval_root = cx->blk_eval.old_eval_root; \
f09cca8c
DM
765 sv = cx->blk_eval.cur_text; \
766 if (sv && SvSCREAM(sv)) { \
767 cx->blk_eval.cur_text = NULL; \
768 SvREFCNT_dec_NN(sv); \
769 } \
770 sv = cx->blk_eval.old_namesv; \
771 if (sv && !SvTEMP(sv))/* TEMP => POPEVAL re-entrantly called */ \
772 sv_2mortal(sv); \
0f79a09d 773 } STMT_END
79072805
LW
774
775/* loop context */
776struct block_loop {
022eaa24 777 LOOP * my_op; /* My op, that contains redo, next and last ops. */
df530c37 778 union { /* different ways of locating the iteration variable */
b52de964
DM
779 SV **svp; /* for lexicals: address of pad slot */
780 GV *gv; /* for package vars */
df530c37 781 } itervar_u;
f0bb9bf7 782 SV *itersave; /* the original iteration var */
493b0a3c 783 union {
93661e56
DM
784 struct { /* CXt_LOOP_ARY, C<for (@ary)> */
785 AV *ary; /* array being iterated over */
786 IV ix; /* index relative to base of array */
d01136d6 787 } ary;
93661e56
DM
788 struct { /* CXt_LOOP_LIST, C<for (list)> */
789 I32 basesp; /* first element of list on stack */
790 IV ix; /* index relative to basesp */
791 } stack;
792 struct { /* CXt_LOOP_LAZYIV, C<for (1..9)> */
d01136d6
BS
793 IV cur;
794 IV end;
795 } lazyiv;
93661e56 796 struct { /* CXt_LOOP_LAZYSV C<for ('a'..'z')> */
d01136d6
BS
797 SV * cur;
798 SV * end; /* maxiumum value (or minimum in reverse) */
799 } lazysv;
800 } state_u;
7766f137 801#ifdef USE_ITHREADS
b52de964 802 PAD *oldcomppad; /* needed to map itervar_u.svp during thread clone */
f83b46a0 803#endif
b52de964 804};
f83b46a0 805
9af0df0b
DM
806#define CxITERVAR(c) \
807 (CxPADLOOP(c) \
808 ? (c)->blk_loop.itervar_u.svp \
809 : ((c)->cx_type & CXp_FOR_GV) \
810 ? &GvSV((c)->blk_loop.itervar_u.gv) \
811 : (SV **)&(c)->blk_loop.itervar_u.gv)
f83b46a0 812
b1cf8b36 813#define CxLABEL(c) (0 + CopLABEL((c)->blk_oldcop))
5db1eb8d
BF
814#define CxLABEL_len(c,len) (0 + CopLABEL_len((c)->blk_oldcop, len))
815#define CxLABEL_len_flags(c,len,flags) (0 + CopLABEL_len_flags((c)->blk_oldcop, len, flags))
ae423868 816#define CxHASARGS(c) (((c)->cx_type & CXp_HASARGS) == CXp_HASARGS)
1956db7e 817#define CxLVAL(c) (0 + ((c)->blk_u16 & 0xff))
1956db7e 818
7766f137 819
1bef65a2 820#define PUSHLOOP_PLAIN(cx) \
3b719c58 821 cx->blk_loop.my_op = cLOOP; \
e992140c 822 cx->blk_oldsaveix = PL_savestack_ix;
3b719c58 823
b52de964
DM
824#ifdef USE_ITHREADS
825# define PUSHLOOP_FOR_setpad(c) (c)->blk_loop.oldcomppad = PL_comppad
826#else
827# define PUSHLOOP_FOR_setpad(c) NOOP
828#endif
829
1bef65a2 830#define PUSHLOOP_FOR(cx, ivar, isave) \
022eaa24 831 cx->blk_loop.my_op = cLOOP; \
b52de964 832 cx->blk_loop.itervar_u.svp = (SV**)(ivar); \
e992140c 833 cx->blk_oldsaveix = PL_savestack_ix; \
f0bb9bf7 834 cx->blk_loop.itersave = isave; \
b52de964 835 PUSHLOOP_FOR_setpad(cx);
79072805
LW
836
837#define POPLOOP(cx) \
113ebcf5
DM
838 if ( CxTYPE(cx) == CXt_LOOP_ARY \
839 || CxTYPE(cx) == CXt_LOOP_LAZYSV) \
840 { \
841 /* Free ary or cur. This assumes that state_u.ary.ary \
842 * aligns with state_u.lazysv.cur. See cx_dup() */ \
a7db2e35
DM
843 SV *sv = cx->blk_loop.state_u.lazysv.cur; \
844 cx->blk_loop.state_u.lazysv.cur = NULL; \
845 SvREFCNT_dec_NN(sv); \
113ebcf5
DM
846 if (CxTYPE(cx) == CXt_LOOP_LAZYSV) { \
847 sv = cx->blk_loop.state_u.lazysv.end; \
848 cx->blk_loop.state_u.lazysv.end = NULL; \
849 SvREFCNT_dec_NN(sv); \
850 } \
d01136d6 851 } \
9af0df0b 852 if (cx->cx_type & (CXp_FOR_PAD|CXp_FOR_GV)) { \
f0bb9bf7 853 SV *cursv; \
d4e2b4d6
DM
854 SV **svp = (cx)->blk_loop.itervar_u.svp; \
855 if ((cx->cx_type & CXp_FOR_GV)) \
f0bb9bf7 856 svp = &GvSV((GV*)svp); \
d4e2b4d6
DM
857 cursv = *svp; \
858 *svp = cx->blk_loop.itersave; \
a7db2e35 859 cx->blk_loop.itersave = NULL; \
385bbb12 860 SvREFCNT_dec(cursv); \
b042e328 861 }
79072805 862
0d863452
RH
863/* given/when context */
864struct block_givwhen {
865 OP *leave_op;
b95eccd3 866 SV *defsv_save; /* the original $_ */
0d863452
RH
867};
868
b95eccd3 869#define PUSHWHEN(cx) \
e992140c 870 cx->blk_oldsaveix = PL_savestack_ix; \
0d863452
RH
871 cx->blk_givwhen.leave_op = cLOGOP->op_other;
872
b95eccd3
DM
873#define PUSHGIVEN(cx, orig_var) \
874 PUSHWHEN(cx); \
875 cx->blk_givwhen.defsv_save = orig_var;
876
877#define POPWHEN(cx) \
2f450c1b 878 NOOP;
b95eccd3
DM
879
880#define POPGIVEN(cx) \
33e0807a
DM
881 STMT_START { \
882 SV *sv = GvSV(PL_defgv); \
883 GvSV(PL_defgv) = cx->blk_givwhen.defsv_save; \
884 cx->blk_givwhen.defsv_save = NULL; \
885 SvREFCNT_dec(sv); \
886 } STMT_END
b95eccd3 887
0d863452 888
c5369ccc
DM
889/* basic block, i.e. pp_enter/leave */
890
dfe0f39b 891#define PUSHBASICBLK(cx) \
e992140c 892 cx->blk_oldsaveix = PL_savestack_ix;
c5369ccc 893
dfe0f39b 894#define POPBASICBLK(cx) \
2f450c1b 895 NOOP;
c5369ccc
DM
896
897
79072805
LW
898/* context common to subroutines, evals and loops */
899struct block {
446d0787 900 U8 blku_type; /* what kind of context this is */
2e0df0e8 901 U8 blku_gimme; /* is this block running in list context? */
17347a51 902 U16 blku_u16; /* used by block_sub and block_eval (so far) */
e992140c
DM
903 I32 blku_oldsaveix; /* saved PL_savestack_ix */
904 /* all the fields above must be aligned with same-sized fields as sbu */
1bef65a2 905 I32 blku_oldsp; /* current sp floor: where nextstate pops to */
79072805 906 I32 blku_oldmarksp; /* mark stack index */
f284fecd 907 COP * blku_oldcop; /* old curcop pointer */
79072805 908 PMOP * blku_oldpm; /* values of pattern match vars */
bb3300d1 909 SSize_t blku_old_tmpsfloor; /* saved PL_tmps_floor */
f284fecd 910 I32 blku_oldscopesp; /* scope stack index */
79072805
LW
911
912 union {
913 struct block_sub blku_sub;
f9c764c5 914 struct block_format blku_format;
79072805
LW
915 struct block_eval blku_eval;
916 struct block_loop blku_loop;
0d863452 917 struct block_givwhen blku_givwhen;
79072805
LW
918 } blk_u;
919};
920#define blk_oldsp cx_u.cx_blk.blku_oldsp
921#define blk_oldcop cx_u.cx_blk.blku_oldcop
79072805
LW
922#define blk_oldmarksp cx_u.cx_blk.blku_oldmarksp
923#define blk_oldscopesp cx_u.cx_blk.blku_oldscopesp
924#define blk_oldpm cx_u.cx_blk.blku_oldpm
925#define blk_gimme cx_u.cx_blk.blku_gimme
446d0787 926#define blk_u16 cx_u.cx_blk.blku_u16
e992140c 927#define blk_oldsaveix cx_u.cx_blk.blku_oldsaveix
79072805 928#define blk_sub cx_u.cx_blk.blk_u.blku_sub
f9c764c5 929#define blk_format cx_u.cx_blk.blk_u.blku_format
79072805
LW
930#define blk_eval cx_u.cx_blk.blk_u.blku_eval
931#define blk_loop cx_u.cx_blk.blk_u.blku_loop
0d863452 932#define blk_givwhen cx_u.cx_blk.blk_u.blku_givwhen
79072805 933
5e691bc6 934#define CX_DEBUG(cx, action) \
d9f81b50 935 DEBUG_l( \
bb3300d1 936 Perl_deb(aTHX_ "CX %ld %s %s (scope %ld,%ld) (save %ld,%ld) at %s:%d\n",\
1c98cc53
DM
937 (long)cxstack_ix, \
938 action, \
5e691bc6 939 PL_block_type[CxTYPE(cx)], \
1c98cc53 940 (long)PL_scopestack_ix, \
5e691bc6 941 (long)(cx->blk_oldscopesp), \
bb3300d1 942 (long)PL_savestack_ix, \
5e691bc6 943 (long)(cx->blk_oldsaveix), \
d9f81b50 944 __FILE__, __LINE__));
1c98cc53 945
79072805 946/* Enter a block. */
4ebe6e95 947#define PUSHBLOCK(cx,t,sp) CXINC, cx = CX_CUR(), \
79072805 948 cx->cx_type = t, \
3280af22
NIS
949 cx->blk_oldsp = sp - PL_stack_base, \
950 cx->blk_oldcop = PL_curcop, \
1aff0e91 951 cx->blk_oldmarksp = PL_markstack_ptr - PL_markstack, \
3280af22 952 cx->blk_oldscopesp = PL_scopestack_ix, \
3280af22 953 cx->blk_oldpm = PL_curpm, \
eb160463 954 cx->blk_gimme = (U8)gimme; \
94a11f7c
DM
955 cx->cx_u.cx_blk.blku_old_tmpsfloor = PL_tmps_floor; \
956 PL_tmps_floor = PL_tmps_ix; \
5e691bc6 957 CX_DEBUG(cx, "PUSH");
79072805 958
2e17e9ad
DM
959#define _POPBLOCK_COMMON(cx) \
960 PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp, \
961 PL_scopestack_ix = cx->blk_oldscopesp, \
962 PL_curpm = cx->blk_oldpm,
963
79072805 964/* Exit a block (RETURN and LAST). */
dd748f45 965#define POPBLOCK(cx) \
5e691bc6 966 CX_DEBUG(cx, "POP"); \
2e17e9ad 967 _POPBLOCK_COMMON(cx) \
72c5b62d
DM
968 /* LEAVE_SCOPE() should have made this true. /(?{})/ cheats
969 * and leaves a CX entry lying around for repeated use, so
970 * skip for multicall */ \
8e7e33ef 971 assert( (CxTYPE(cx) == CXt_SUB && CxMULTICALL(cx)) \
e992140c 972 || PL_savestack_ix == cx->blk_oldsaveix); \
2e17e9ad 973 PL_curcop = cx->blk_oldcop, \
b042e328 974 PL_tmps_floor = cx->cx_u.cx_blk.blku_old_tmpsfloor; \
79072805 975
2e17e9ad
DM
976/* Continue a block elsewhere (e.g. NEXT, REDO, GOTO).
977 * Whereas POPBLOCK restores the state to the point just before PUSHBLOCK
978 * was called, TOPBLOCK restores it to the point just *after* PUSHBLOCK
979 * was called. */
1c98cc53 980#define TOPBLOCK(cx) \
5e691bc6 981 CX_DEBUG(cx, "TOP"); \
2e17e9ad
DM
982 _POPBLOCK_COMMON(cx) \
983 PL_stack_sp = PL_stack_base + cx->blk_oldsp;
79072805
LW
984
985/* substitution context */
986struct subst {
e992140c 987 U8 sbu_type; /* same as blku_type */
1ed74d04 988 U8 sbu_rflags;
e992140c
DM
989 U16 sbu_rxtainted;
990 I32 sbu_oldsaveix; /* same as blku_oldsaveix */
a7f94955 991 /* all the fields above must be aligned with same-sized fields as blk_u */
3c6ef0a5
FC
992 SSize_t sbu_iters;
993 SSize_t sbu_maxiters;
79072805
LW
994 char * sbu_orig;
995 SV * sbu_dstr;
996 SV * sbu_targ;
997 char * sbu_s;
998 char * sbu_m;
999 char * sbu_strend;
c90c0ff4 1000 void * sbu_rxres;
c07a80fd 1001 REGEXP * sbu_rx;
79072805
LW
1002};
1003#define sb_iters cx_u.cx_subst.sbu_iters
1004#define sb_maxiters cx_u.cx_subst.sbu_maxiters
22e551b9 1005#define sb_rflags cx_u.cx_subst.sbu_rflags
71be2cbc 1006#define sb_rxtainted cx_u.cx_subst.sbu_rxtainted
79072805
LW
1007#define sb_orig cx_u.cx_subst.sbu_orig
1008#define sb_dstr cx_u.cx_subst.sbu_dstr
1009#define sb_targ cx_u.cx_subst.sbu_targ
1010#define sb_s cx_u.cx_subst.sbu_s
1011#define sb_m cx_u.cx_subst.sbu_m
1012#define sb_strend cx_u.cx_subst.sbu_strend
c90c0ff4 1013#define sb_rxres cx_u.cx_subst.sbu_rxres
c07a80fd 1014#define sb_rx cx_u.cx_subst.sbu_rx
79072805 1015
9c105995 1016#ifdef PERL_CORE
4ebe6e95 1017# define PUSHSUBST(cx) CXINC, cx = CX_CUR(), \
e992140c 1018 cx->blk_oldsaveix = oldsave, \
79072805
LW
1019 cx->sb_iters = iters, \
1020 cx->sb_maxiters = maxiters, \
22e551b9 1021 cx->sb_rflags = r_flags, \
71be2cbc 1022 cx->sb_rxtainted = rxtainted, \
79072805
LW
1023 cx->sb_orig = orig, \
1024 cx->sb_dstr = dstr, \
1025 cx->sb_targ = targ, \
1026 cx->sb_s = s, \
1027 cx->sb_m = m, \
1028 cx->sb_strend = strend, \
4608196e 1029 cx->sb_rxres = NULL, \
c07a80fd 1030 cx->sb_rx = rx, \
1ed74d04 1031 cx->cx_type = CXt_SUBST | (once ? CXp_ONCE : 0); \
e22ae1e2 1032 rxres_save(&cx->sb_rxres, rx); \
cf69025f
TC
1033 (void)ReREFCNT_inc(rx); \
1034 SvREFCNT_inc_void_NN(targ)
79072805 1035
80d88db0 1036# define POPSUBST(cx) \
77189b8c
DM
1037 STMT_START { \
1038 REGEXP *re; \
e22ae1e2 1039 rxres_free(&cx->sb_rxres); \
77189b8c
DM
1040 re = cx->sb_rx; \
1041 cx->sb_rx = NULL; \
1042 ReREFCNT_dec(re); \
1043 SvREFCNT_dec_NN(cx->sb_targ); \
1044 } STMT_END
9c105995
NC
1045#endif
1046
1047#define CxONCE(cx) ((cx)->cx_type & CXp_ONCE)
79072805
LW
1048
1049struct context {
79072805
LW
1050 union {
1051 struct block cx_blk;
1052 struct subst cx_subst;
1053 } cx_u;
1054};
2e0df0e8 1055#define cx_type cx_u.cx_subst.sbu_type
6b35e009 1056
76753e7f
NC
1057/* If you re-order these, there is also an array of uppercase names in perl.h
1058 and a static array of context names in pp_ctl.c */
3701055e 1059#define CXTYPEMASK 0xf
79646418 1060#define CXt_NULL 0 /* currently only used for sort BLOCK */
76753e7f
NC
1061#define CXt_WHEN 1
1062#define CXt_BLOCK 2
1063/* When micro-optimising :-) keep GIVEN next to the LOOPs, as these 5 share a
1064 jump table in pp_ctl.c
1065 The first 4 don't have a 'case' in at least one switch statement in pp_ctl.c
1066*/
1067#define CXt_GIVEN 3
93661e56
DM
1068
1069/* be careful of the ordering of these five. Macros like CxTYPE_is_LOOP,
1070 * CxFOREACH compare ranges */
113ebcf5
DM
1071#define CXt_LOOP_ARY 4 /* for (@ary) {} */
1072#define CXt_LOOP_LAZYSV 5 /* for ('a'..'z') {} */
1073#define CXt_LOOP_LAZYIV 6 /* for (1..9) {} */
93661e56 1074#define CXt_LOOP_LIST 7 /* for (1,2,3) {} */
113ebcf5 1075#define CXt_LOOP_PLAIN 8 /* {} */
93661e56
DM
1076
1077#define CXt_SUB 9
1078#define CXt_FORMAT 10
1079#define CXt_EVAL 11
1080#define CXt_SUBST 12
76753e7f 1081/* SUBST doesn't feature in all switch statements. */
79072805 1082
ae423868 1083/* private flags for CXt_SUB and CXt_FORMAT */
79646418
DM
1084#define CXp_MULTICALL 0x10 /* part of a multicall (so don't tear down
1085 context on exit). (not CXt_FORMAT) */
1f27d788 1086#define CXp_HASARGS 0x20
b0065247
DM
1087#define CXp_SUB_RE 0x40 /* code called within regex, i.e. (?{}) */
1088#define CXp_SUB_RE_FAKE 0x80 /* fake sub CX for (?{}) in current scope */
ae423868 1089
6b35e009 1090/* private flags for CXt_EVAL */
1f27d788
NC
1091#define CXp_REAL 0x20 /* truly eval'', not a lookalike */
1092#define CXp_TRYBLOCK 0x40 /* eval{}, not eval'' or similar */
6b35e009 1093
7766f137 1094/* private flags for CXt_LOOP */
28e0cf42
DM
1095
1096/* this is only set in conjunction with CXp_FOR_GV */
1f27d788 1097#define CXp_FOR_DEF 0x10 /* foreach using $_ */
28e0cf42 1098/* these 3 are mutually exclusive */
d39c26a6 1099#define CXp_FOR_LVREF 0x20 /* foreach using \$var */
9af0df0b
DM
1100#define CXp_FOR_GV 0x40 /* foreach using package var */
1101#define CXp_FOR_PAD 0x80 /* foreach using lexical var */
28e0cf42 1102
9af0df0b 1103#define CxPADLOOP(c) ((c)->cx_type & CXp_FOR_PAD)
e846cb92 1104
1ed74d04
NC
1105/* private flags for CXt_SUBST */
1106#define CXp_ONCE 0x10 /* What was sbu_once in struct subst */
7766f137 1107
6b35e009 1108#define CxTYPE(c) ((c)->cx_type & CXTYPEMASK)
113ebcf5
DM
1109#define CxTYPE_is_LOOP(c) ( CxTYPE(cx) >= CXt_LOOP_ARY \
1110 && CxTYPE(cx) <= CXt_LOOP_PLAIN)
79646418 1111#define CxMULTICALL(c) ((c)->cx_type & CXp_MULTICALL)
0588a150 1112#define CxREALEVAL(c) (((c)->cx_type & (CXTYPEMASK|CXp_REAL)) \
7766f137 1113 == (CXt_EVAL|CXp_REAL))
0588a150 1114#define CxTRYBLOCK(c) (((c)->cx_type & (CXTYPEMASK|CXp_TRYBLOCK)) \
1d76a5c3 1115 == (CXt_EVAL|CXp_TRYBLOCK))
113ebcf5
DM
1116#define CxFOREACH(c) ( CxTYPE(cx) >= CXt_LOOP_ARY \
1117 && CxTYPE(cx) <= CXt_LOOP_LIST)
6b35e009 1118
109bf713 1119#define CXINC (cxstack_ix < cxstack_max ? ++cxstack_ix : (cxstack_ix = cxinc()))
79072805 1120
ccfc67b7
JH
1121/*
1122=head1 "Gimme" Values
1123*/
954c1994
GS
1124
1125/*
1126=for apidoc AmU||G_SCALAR
fbe13c60 1127Used to indicate scalar context. See C<L</GIMME_V>>, C<L</GIMME>>, and
954c1994
GS
1128L<perlcall>.
1129
1130=for apidoc AmU||G_ARRAY
fbe13c60 1131Used to indicate list context. See C<L</GIMME_V>>, C<L</GIMME>> and
954c1994
GS
1132L<perlcall>.
1133
1134=for apidoc AmU||G_VOID
fbe13c60 1135Used to indicate void context. See C<L</GIMME_V>> and L<perlcall>.
954c1994
GS
1136
1137=for apidoc AmU||G_DISCARD
1138Indicates that arguments returned from a callback should be discarded. See
1139L<perlcall>.
1140
1141=for apidoc AmU||G_EVAL
1142
1143Used to force a Perl C<eval> wrapper around a callback. See
1144L<perlcall>.
1145
1146=for apidoc AmU||G_NOARGS
1147
1148Indicates that no arguments are being sent to a callback. See
1149L<perlcall>.
1150
1151=cut
1152*/
1153
2f8edad0
NC
1154#define G_SCALAR 2
1155#define G_ARRAY 3
1156#define G_VOID 1
1157#define G_WANT 3
79072805 1158
864dbfa3 1159/* extra flags for Perl_call_* routines */
2f8edad0 1160#define G_DISCARD 4 /* Call FREETMPS.
b54b4831
NC
1161 Don't change this without consulting the
1162 hash actions codes defined in hv.h */
2f8edad0
NC
1163#define G_EVAL 8 /* Assume eval {} around subroutine call. */
1164#define G_NOARGS 16 /* Don't construct a @_ array. */
7ce09284 1165#define G_KEEPERR 32 /* Warn for errors, don't overwrite $@ */
2f8edad0
NC
1166#define G_NODEBUG 64 /* Disable debugging at toplevel. */
1167#define G_METHOD 128 /* Calling method. */
c40f1585 1168#define G_FAKINGEVAL 256 /* Faking an eval context for call_sv or
edb2152a 1169 fold_constants. */
67549bd2
NC
1170#define G_UNDEF_FILL 512 /* Fill the stack with &PL_sv_undef
1171 A special case for UNSHIFT in
1172 Perl_magic_methcall(). */
d1d7a15d
NC
1173#define G_WRITING_TO_STDERR 1024 /* Perl_write_to_stderr() is calling
1174 Perl_magic_methcall(). */
a1941760 1175#define G_RE_REPARSING 0x800 /* compiling a run-time /(?{..})/ */
c106c2be 1176#define G_METHOD_NAMED 4096 /* calling named method, eg without :: or ' */
e336de0d 1177
faef0170
HS
1178/* flag bits for PL_in_eval */
1179#define EVAL_NULL 0 /* not in an eval */
1180#define EVAL_INEVAL 1 /* some enclosing scope is an eval */
1181#define EVAL_WARNONLY 2 /* used by yywarn() when calling yyerror() */
864dbfa3 1182#define EVAL_KEEPERR 4 /* set by Perl_call_sv if G_KEEPERR */
6dc8a9e4 1183#define EVAL_INREQUIRE 8 /* The code is being required. */
a1941760 1184#define EVAL_RE_REPARSING 0x10 /* eval_sv() called with G_RE_REPARSING */
faef0170 1185
e336de0d
GS
1186/* Support for switching (stack and block) contexts.
1187 * This ensures magic doesn't invalidate local stack and cx pointers.
1188 */
1189
e788e7d3
GS
1190#define PERLSI_UNKNOWN -1
1191#define PERLSI_UNDEF 0
1192#define PERLSI_MAIN 1
1193#define PERLSI_MAGIC 2
1194#define PERLSI_SORT 3
1195#define PERLSI_SIGNAL 4
1196#define PERLSI_OVERLOAD 5
1197#define PERLSI_DESTROY 6
1198#define PERLSI_WARNHOOK 7
1199#define PERLSI_DIEHOOK 8
1200#define PERLSI_REQUIRE 9
e1a10f35 1201#define PERLSI_MULTICALL 10
e336de0d
GS
1202
1203struct stackinfo {
1204 AV * si_stack; /* stack for current runlevel */
1205 PERL_CONTEXT * si_cxstack; /* context stack for runlevel */
9bd87817
NC
1206 struct stackinfo * si_prev;
1207 struct stackinfo * si_next;
e336de0d
GS
1208 I32 si_cxix; /* current context index */
1209 I32 si_cxmax; /* maximum allocated index */
1210 I32 si_type; /* type of runlevel */
ce2f7c3b 1211 I32 si_markoff; /* offset where markstack begins for us.
e336de0d
GS
1212 * currently used only with DEBUGGING,
1213 * but not #ifdef-ed for bincompat */
1214};
1215
1216typedef struct stackinfo PERL_SI;
1217
3280af22
NIS
1218#define cxstack (PL_curstackinfo->si_cxstack)
1219#define cxstack_ix (PL_curstackinfo->si_cxix)
1220#define cxstack_max (PL_curstackinfo->si_cxmax)
e336de0d
GS
1221
1222#ifdef DEBUGGING
ce2f7c3b
GS
1223# define SET_MARK_OFFSET \
1224 PL_curstackinfo->si_markoff = PL_markstack_ptr - PL_markstack
e336de0d 1225#else
ce2f7c3b 1226# define SET_MARK_OFFSET NOOP
e336de0d
GS
1227#endif
1228
d3acc0f7 1229#define PUSHSTACKi(type) \
e336de0d 1230 STMT_START { \
3280af22 1231 PERL_SI *next = PL_curstackinfo->si_next; \
1c98cc53
DM
1232 DEBUG_l({ \
1233 int i = 0; PERL_SI *p = PL_curstackinfo; \
1234 while (p) { i++; p = p->si_prev; } \
1235 Perl_deb(aTHX_ "push STACKINFO %d at %s:%d\n", \
1236 i, __FILE__, __LINE__);}) \
e336de0d
GS
1237 if (!next) { \
1238 next = new_stackinfo(32, 2048/sizeof(PERL_CONTEXT) - 1); \
3280af22
NIS
1239 next->si_prev = PL_curstackinfo; \
1240 PL_curstackinfo->si_next = next; \
e336de0d
GS
1241 } \
1242 next->si_type = type; \
1243 next->si_cxix = -1; \
1244 AvFILLp(next->si_stack) = 0; \
3280af22
NIS
1245 SWITCHSTACK(PL_curstack,next->si_stack); \
1246 PL_curstackinfo = next; \
ce2f7c3b 1247 SET_MARK_OFFSET; \
e336de0d
GS
1248 } STMT_END
1249
e788e7d3 1250#define PUSHSTACK PUSHSTACKi(PERLSI_UNKNOWN)
d3acc0f7 1251
3095d977
GS
1252/* POPSTACK works with PL_stack_sp, so it may need to be bracketed by
1253 * PUTBACK/SPAGAIN to flush/refresh any local SP that may be active */
d3acc0f7 1254#define POPSTACK \
e336de0d 1255 STMT_START { \
39644a26 1256 dSP; \
c4420975 1257 PERL_SI * const prev = PL_curstackinfo->si_prev; \
1c98cc53
DM
1258 DEBUG_l({ \
1259 int i = -1; PERL_SI *p = PL_curstackinfo; \
1260 while (p) { i++; p = p->si_prev; } \
1261 Perl_deb(aTHX_ "pop STACKINFO %d at %s:%d\n", \
1262 i, __FILE__, __LINE__);}) \
e336de0d 1263 if (!prev) { \
3d04513d 1264 Perl_croak_popstack(); \
e336de0d 1265 } \
3280af22 1266 SWITCHSTACK(PL_curstack,prev->si_stack); \
e336de0d 1267 /* don't free prev here, free them all at the END{} */ \
3280af22 1268 PL_curstackinfo = prev; \
e336de0d
GS
1269 } STMT_END
1270
1271#define POPSTACK_TO(s) \
1272 STMT_START { \
3280af22 1273 while (PL_curstack != s) { \
bac4b2ad 1274 dounwind(-1); \
d3acc0f7 1275 POPSTACK; \
bac4b2ad 1276 } \
e336de0d 1277 } STMT_END
923e4eb5
JH
1278
1279#define IN_PERL_COMPILETIME (PL_curcop == &PL_compiling)
1280#define IN_PERL_RUNTIME (PL_curcop != &PL_compiling)
1281
9850bf21
RH
1282/*
1283=head1 Multicall Functions
1284
1285=for apidoc Ams||dMULTICALL
72d33970 1286Declare local variables for a multicall. See L<perlcall/LIGHTWEIGHT CALLBACKS>.
9850bf21
RH
1287
1288=for apidoc Ams||PUSH_MULTICALL
1289Opening bracket for a lightweight callback.
0eda4409 1290See L<perlcall/LIGHTWEIGHT CALLBACKS>.
9850bf21
RH
1291
1292=for apidoc Ams||MULTICALL
72d33970 1293Make a lightweight callback. See L<perlcall/LIGHTWEIGHT CALLBACKS>.
9850bf21
RH
1294
1295=for apidoc Ams||POP_MULTICALL
1296Closing bracket for a lightweight callback.
0eda4409 1297See L<perlcall/LIGHTWEIGHT CALLBACKS>.
9850bf21
RH
1298
1299=cut
1300*/
1301
1302#define dMULTICALL \
1303 SV **newsp; /* set by POPBLOCK */ \
1304 PERL_CONTEXT *cx; \
82f35e8b 1305 CV *multicall_cv; \
9850bf21
RH
1306 OP *multicall_cop; \
1307 bool multicall_oldcatch; \
1308 U8 hasargs = 0 /* used by PUSHSUB */
1309
82f35e8b 1310#define PUSH_MULTICALL(the_cv) \
b0065247 1311 PUSH_MULTICALL_FLAGS(the_cv, 0)
81ed78b2 1312
b0065247
DM
1313/* Like PUSH_MULTICALL, but allows you to specify extra flags
1314 * for the CX stack entry (this isn't part of the public API) */
81ed78b2 1315
b0065247 1316#define PUSH_MULTICALL_FLAGS(the_cv, flags) \
9850bf21 1317 STMT_START { \
0bcc34c2
AL
1318 CV * const _nOnclAshIngNamE_ = the_cv; \
1319 CV * const cv = _nOnclAshIngNamE_; \
b70d5558 1320 PADLIST * const padlist = CvPADLIST(cv); \
9850bf21 1321 multicall_oldcatch = CATCH_GET; \
9850bf21 1322 CATCH_SET(TRUE); \
e1a10f35 1323 PUSHSTACKi(PERLSI_MULTICALL); \
b0065247 1324 PUSHBLOCK(cx, (CXt_SUB|CXp_MULTICALL|flags), PL_stack_sp); \
9850bf21 1325 PUSHSUB(cx); \
e992140c 1326 cx->blk_oldsaveix = PL_savestack_ix; \
8ae997c5 1327 SAVEVPTR(PL_op); \
b0065247
DM
1328 if (!(flags & CXp_SUB_RE_FAKE)) \
1329 CvDEPTH(cv)++; \
81ed78b2 1330 if (CvDEPTH(cv) >= 2) { \
9850bf21
RH
1331 PERL_STACK_OVERFLOW_CHECK(); \
1332 Perl_pad_push(aTHX_ padlist, CvDEPTH(cv)); \
1333 } \
9850bf21 1334 PAD_SET_CUR_NOSAVE(padlist, CvDEPTH(cv)); \
82f35e8b 1335 multicall_cv = cv; \
7e27c4a5 1336 PERL_UNUSED_VAR(multicall_cv); /* for API */ \
9850bf21
RH
1337 multicall_cop = CvSTART(cv); \
1338 } STMT_END
1339
1340#define MULTICALL \
1341 STMT_START { \
1342 PL_op = multicall_cop; \
1343 CALLRUNOPS(aTHX); \
1344 } STMT_END
1345
1346#define POP_MULTICALL \
1347 STMT_START { \
4ebe6e95 1348 cx = CX_CUR(); \
dfe0f39b 1349 CX_LEAVE_SCOPE(cx); \
7e27c4a5 1350 POPSUB_COMMON(cx); \
4df352a8
DM
1351 newsp = PL_stack_base + cx->blk_oldsp; \
1352 gimme = cx->blk_gimme; \
7e27c4a5
DM
1353 PERL_UNUSED_VAR(newsp); /* for API */ \
1354 PERL_UNUSED_VAR(gimme); /* for API */ \
5da525e9
DM
1355 POPBLOCK(cx); \
1356 CX_POP(cx); \
1bbbfc50 1357 POPSTACK; \
9850bf21 1358 CATCH_SET(multicall_oldcatch); \
1bbbfc50 1359 SPAGAIN; \
9850bf21 1360 } STMT_END
b3ca2e83 1361
81ed78b2
DM
1362/* Change the CV of an already-pushed MULTICALL CxSUB block.
1363 * (this isn't part of the public API) */
1364
b0065247 1365#define CHANGE_MULTICALL_FLAGS(the_cv, flags) \
81ed78b2
DM
1366 STMT_START { \
1367 CV * const _nOnclAshIngNamE_ = the_cv; \
1368 CV * const cv = _nOnclAshIngNamE_; \
b70d5558 1369 PADLIST * const padlist = CvPADLIST(cv); \
4ebe6e95 1370 cx = CX_CUR(); \
79646418 1371 assert(CxMULTICALL(cx)); \
5ee28f95 1372 POPSUB_COMMON(cx); \
b0065247 1373 cx->cx_type = (CXt_SUB|CXp_MULTICALL|flags); \
5ee28f95 1374 PUSHSUB(cx); \
b0065247
DM
1375 if (!(flags & CXp_SUB_RE_FAKE)) \
1376 CvDEPTH(cv)++; \
81ed78b2
DM
1377 if (CvDEPTH(cv) >= 2) { \
1378 PERL_STACK_OVERFLOW_CHECK(); \
1379 Perl_pad_push(aTHX_ padlist, CvDEPTH(cv)); \
1380 } \
81ed78b2
DM
1381 PAD_SET_CUR_NOSAVE(padlist, CvDEPTH(cv)); \
1382 multicall_cv = cv; \
1383 multicall_cop = CvSTART(cv); \
1384 } STMT_END
b3ca2e83 1385/*
14d04a33 1386 * ex: set ts=8 sts=4 sw=4 et:
b3ca2e83 1387 */