This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
eliminate cx->blk_sub.oldcomppad
[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 */
8e663997
NC
553 /* Above here is the same for sub, format and eval. */
554 CV * cv;
f9c764c5 555 /* Above here is the same for sub and format. */
79072805
LW
556 AV * savearray;
557 AV * argarray;
bb172083 558 I32 olddepth;
3b21fb5d 559 PAD *prevcomppad; /* the caller's PL_comppad */
f9c764c5
NC
560};
561
562
563/* format context */
564struct block_format {
f39bc417 565 OP * retop; /* op to execute on exit from sub */
8e663997
NC
566 /* Above here is the same for sub, format and eval. */
567 CV * cv;
f9c764c5
NC
568 /* Above here is the same for sub and format. */
569 GV * gv;
570 GV * dfoutgv;
3b21fb5d 571 PAD *prevcomppad; /* the caller's PL_comppad */
79072805
LW
572};
573
b36bdeca 574/* base for the next two macros. Don't use directly.
d6911e1b
DM
575 * The context frame holds a reference to the CV so that it can't be
576 * freed while we're executing it */
b36bdeca 577
ee98a1d6 578#define PUSHSUB_BASE(cx) \
88dbe4af
FC
579 ENTRY_PROBE(CvNAMED(cv) \
580 ? HEK_KEY(CvNAME_HEK(cv)) \
581 : GvENAME(CvGV(cv)), \
c6903450 582 CopFILE((const COP *)CvSTART(cv)), \
3e2413e5
DL
583 CopLINE((const COP *)CvSTART(cv)), \
584 CopSTASHPV((const COP *)CvSTART(cv))); \
5ac1e9b2 585 \
79072805 586 cx->blk_sub.cv = cv; \
b8f55b69 587 cx->blk_sub.olddepth = CvDEPTH(cv); \
3b21fb5d 588 cx->blk_sub.prevcomppad = PL_comppad; \
ae423868 589 cx->cx_type |= (hasargs) ? CXp_HASARGS : 0; \
5f66b61c 590 cx->blk_sub.retop = NULL; \
2c50b7ed 591 SvREFCNT_inc_simple_void_NN(cv);
b36bdeca 592
4587c532 593#define PUSHSUB_GET_LVALUE_MASK(func) \
777d9014
FC
594 /* If the context is indeterminate, then only the lvalue */ \
595 /* flags that the caller also has are applicable. */ \
4587c532 596 ( \
777d9014
FC
597 (PL_op->op_flags & OPf_WANT) \
598 ? OPpENTERSUB_LVAL_MASK \
599 : !(PL_op->op_private & OPpENTERSUB_LVAL_MASK) \
4587c532
FC
600 ? 0 : (U8)func(aTHX) \
601 )
602
603#define PUSHSUB(cx) \
604 { \
605 U8 phlags = PUSHSUB_GET_LVALUE_MASK(Perl_was_lvalue_sub); \
ee98a1d6 606 PUSHSUB_BASE(cx) \
446d0787 607 cx->blk_u16 = PL_op->op_private & \
0e9700df 608 (phlags|OPpDEREF); \
777d9014 609 }
79072805 610
ee98a1d6
DM
611/* variant for use by OP_DBSTATE, where op_private holds hint bits */
612#define PUSHSUB_DB(cx) \
613 PUSHSUB_BASE(cx) \
446d0787 614 cx->blk_u16 = 0;
ee98a1d6
DM
615
616
10067d9a 617#define PUSHFORMAT(cx, retop) \
f9c764c5
NC
618 cx->blk_format.cv = cv; \
619 cx->blk_format.gv = gv; \
620 cx->blk_format.retop = (retop); \
f9c764c5 621 cx->blk_format.dfoutgv = PL_defoutgv; \
3b21fb5d 622 cx->blk_format.prevcomppad = PL_comppad; \
1956db7e 623 cx->blk_u16 = 0; \
2c50b7ed 624 SvREFCNT_inc_simple_void_NN(cv); \
f32c7e86 625 CvDEPTH(cv)++; \
f9c764c5 626 SvREFCNT_inc_void(cx->blk_format.dfoutgv)
79072805 627
3db8f154 628#define POP_SAVEARRAY() \
6d4ff0d2 629 STMT_START { \
3280af22 630 SvREFCNT_dec(GvAV(PL_defgv)); \
a8bba7fa 631 GvAV(PL_defgv) = cx->blk_sub.savearray; \
6d4ff0d2 632 } STMT_END
6d4ff0d2 633
ecf8e9dd 634/* junk in @_ spells trouble when cloning CVs and in pp_caller(), so don't
8e09340b
GS
635 * leave any (a fast av_clear(ary), basically) */
636#define CLEAR_ARGARRAY(ary) \
637 STMT_START { \
638 AvMAX(ary) += AvARRAY(ary) - AvALLOC(ary); \
9c6bc640 639 AvARRAY(ary) = AvALLOC(ary); \
8e09340b
GS
640 AvFILLp(ary) = -1; \
641 } STMT_END
7766f137 642
b0d9ce38
GS
643#define POPSUB(cx,sv) \
644 STMT_START { \
25375124 645 const I32 olddepth = cx->blk_sub.olddepth; \
1956db7e
DM
646 if (!(cx->blk_u16 & CxPOPSUB_DONE)) { \
647 cx->blk_u16 |= CxPOPSUB_DONE; \
88dbe4af
FC
648 RETURN_PROBE(CvNAMED(cx->blk_sub.cv) \
649 ? HEK_KEY(CvNAME_HEK(cx->blk_sub.cv)) \
650 : GvENAME(CvGV(cx->blk_sub.cv)), \
8f629a87 651 CopFILE((COP*)CvSTART((const CV*)cx->blk_sub.cv)), \
3e2413e5
DL
652 CopLINE((COP*)CvSTART((const CV*)cx->blk_sub.cv)), \
653 CopSTASHPV((COP*)CvSTART((const CV*)cx->blk_sub.cv))); \
5ac1e9b2 654 \
bafb2adc 655 if (CxHASARGS(cx)) { \
7766f137 656 POP_SAVEARRAY(); \
d8b46c1b 657 /* abandon @_ if it got reified */ \
a8bba7fa 658 if (AvREAL(cx->blk_sub.argarray)) { \
e2d306cb 659 const SSize_t fill = AvFILLp(cx->blk_sub.argarray); \
2f995715 660 SvREFCNT_dec_NN(cx->blk_sub.argarray); \
a8bba7fa
GS
661 cx->blk_sub.argarray = newAV(); \
662 av_extend(cx->blk_sub.argarray, fill); \
11ca45c0 663 AvREIFY_only(cx->blk_sub.argarray); \
41f96e1a
DM
664 (AvARRAY(MUTABLE_AV( \
665 PadlistARRAY(CvPADLIST(cx->blk_sub.cv))[ \
666 CvDEPTH(cx->blk_sub.cv)])))[0] = \
667 MUTABLE_SV(cx->blk_sub.argarray); \
d8b46c1b 668 } \
7766f137 669 else { \
8e09340b 670 CLEAR_ARGARRAY(cx->blk_sub.argarray); \
7766f137 671 } \
79072805 672 } \
1956db7e 673 } \
b1bc3f34 674 sv = MUTABLE_SV(cx->blk_sub.cv); \
25375124 675 LEAVE_SCOPE(PL_scopestack[cx->blk_oldscopesp-1]); \
3b21fb5d
DM
676 PL_comppad = cx->blk_sub.prevcomppad; \
677 PL_curpad = LIKELY(PL_comppad) ? AvARRAY(PL_comppad) : NULL; \
2c50b7ed 678 CvDEPTH((const CV*)sv) = olddepth; \
b0d9ce38
GS
679 } STMT_END
680
681#define LEAVESUB(sv) \
682 STMT_START { \
d2687c98 683 SvREFCNT_dec(sv); \
b0d9ce38 684 } STMT_END
79072805
LW
685
686#define POPFORMAT(cx) \
25375124 687 STMT_START { \
1956db7e 688 if (!(cx->blk_u16 & CxPOPSUB_DONE)) { \
25375124
FC
689 CV * const cv = cx->blk_format.cv; \
690 GV * const dfuot = cx->blk_format.dfoutgv; \
1956db7e 691 cx->blk_u16 |= CxPOPSUB_DONE; \
25375124
FC
692 setdefout(dfuot); \
693 LEAVE_SCOPE(PL_scopestack[cx->blk_oldscopesp-1]); \
3b21fb5d
DM
694 PL_comppad = cx->blk_format.prevcomppad; \
695 PL_curpad = LIKELY(PL_comppad) ? AvARRAY(PL_comppad) : NULL; \
2c50b7ed
DM
696 --CvDEPTH(cv); \
697 SvREFCNT_dec_NN(cx->blk_format.cv); \
25375124 698 SvREFCNT_dec_NN(dfuot); \
1956db7e 699 } \
25375124 700 } STMT_END
79072805
LW
701
702/* eval context */
703struct block_eval {
8e663997
NC
704 OP * retop; /* op to execute on exit from eval */
705 /* Above here is the same for sub, format and eval. */
0f79a09d 706 SV * old_namesv;
79072805 707 OP * old_eval_root;
748a9306 708 SV * cur_text;
2090ab20 709 CV * cv;
abd70938 710 JMPENV * cur_top_env; /* value of PL_top_env when eval CX created */
79072805
LW
711};
712
17347a51
NC
713/* If we ever need more than 512 op types, change the shift from 7.
714 blku_gimme is actually also only 2 bits, so could be merged with something.
715*/
716
717#define CxOLD_IN_EVAL(cx) (((cx)->blk_u16) & 0x7F)
718#define CxOLD_OP_TYPE(cx) (((cx)->blk_u16) >> 7)
85a64632 719
6b75f042 720#define PUSHEVAL(cx,n) \
0f79a09d 721 STMT_START { \
17347a51
NC
722 assert(!(PL_in_eval & ~0x7F)); \
723 assert(!(PL_op->op_type & ~0x1FF)); \
724 cx->blk_u16 = (PL_in_eval & 0x7F) | ((U16)PL_op->op_type << 7); \
a0714e2c 725 cx->blk_eval.old_namesv = (n ? newSVpv(n,0) : NULL); \
a8bba7fa 726 cx->blk_eval.old_eval_root = PL_eval_root; \
bdc0bf6f 727 cx->blk_eval.cur_text = PL_parser ? PL_parser->linestr : NULL; \
601f1833 728 cx->blk_eval.cv = NULL; /* set by doeval(), as applicable */ \
5f66b61c 729 cx->blk_eval.retop = NULL; \
abd70938 730 cx->blk_eval.cur_top_env = PL_top_env; \
0f79a09d 731 } STMT_END
79072805
LW
732
733#define POPEVAL(cx) \
0f79a09d 734 STMT_START { \
85a64632
NC
735 PL_in_eval = CxOLD_IN_EVAL(cx); \
736 optype = CxOLD_OP_TYPE(cx); \
7766f137 737 PL_eval_root = cx->blk_eval.old_eval_root; \
d37427bc 738 if (cx->blk_eval.cur_text && SvSCREAM(cx->blk_eval.cur_text)) \
2f995715 739 SvREFCNT_dec_NN(cx->blk_eval.cur_text); \
0f79a09d
GS
740 if (cx->blk_eval.old_namesv) \
741 sv_2mortal(cx->blk_eval.old_namesv); \
742 } STMT_END
79072805
LW
743
744/* loop context */
745struct block_loop {
79072805 746 I32 resetsp;
022eaa24 747 LOOP * my_op; /* My op, that contains redo, next and last ops. */
df530c37
DM
748 union { /* different ways of locating the iteration variable */
749 SV **svp;
750 GV *gv;
751 PAD *oldcomppad; /* only used in ITHREADS */
752 } itervar_u;
493b0a3c 753 union {
d01136d6
BS
754 struct { /* valid if type is LOOP_FOR or LOOP_PLAIN (but {NULL,0})*/
755 AV * ary; /* use the stack if this is NULL */
756 IV ix;
757 } ary;
758 struct { /* valid if type is LOOP_LAZYIV */
759 IV cur;
760 IV end;
761 } lazyiv;
762 struct { /* valid if type if LOOP_LAZYSV */
763 SV * cur;
764 SV * end; /* maxiumum value (or minimum in reverse) */
765 } lazysv;
766 } state_u;
79072805
LW
767};
768
7766f137 769#ifdef USE_ITHREADS
f83b46a0
DM
770# define CxITERVAR_PADSV(c) \
771 &CX_CURPAD_SV( (c)->blk_loop.itervar_u, (c)->blk_loop.my_op->op_targ)
772#else
773# define CxITERVAR_PADSV(c) ((c)->blk_loop.itervar_u.svp)
774#endif
775
776#define CxITERVAR(c) \
df530c37 777 ((c)->blk_loop.itervar_u.oldcomppad \
e846cb92 778 ? (CxPADLOOP(c) \
f83b46a0 779 ? CxITERVAR_PADSV(c) \
d39c26a6
FC
780 : isGV((c)->blk_loop.itervar_u.gv) \
781 ? &GvSV((c)->blk_loop.itervar_u.gv) \
782 : (SV **)&(c)->blk_loop.itervar_u.gv) \
7766f137 783 : (SV**)NULL)
f83b46a0 784
b1cf8b36 785#define CxLABEL(c) (0 + CopLABEL((c)->blk_oldcop))
5db1eb8d
BF
786#define CxLABEL_len(c,len) (0 + CopLABEL_len((c)->blk_oldcop, len))
787#define CxLABEL_len_flags(c,len,flags) (0 + CopLABEL_len_flags((c)->blk_oldcop, len, flags))
ae423868 788#define CxHASARGS(c) (((c)->cx_type & CXp_HASARGS) == CXp_HASARGS)
1956db7e
DM
789#define CxLVAL(c) (0 + ((c)->blk_u16 & 0xff))
790/* POPSUB has already been performed on this context frame */
791#define CxPOPSUB_DONE 0x100
792
7766f137 793
3b719c58
NC
794#define PUSHLOOP_PLAIN(cx, s) \
795 cx->blk_loop.resetsp = s - PL_stack_base; \
796 cx->blk_loop.my_op = cLOOP; \
d01136d6
BS
797 cx->blk_loop.state_u.ary.ary = NULL; \
798 cx->blk_loop.state_u.ary.ix = 0; \
df530c37 799 cx->blk_loop.itervar_u.svp = NULL;
3b719c58 800
df530c37 801#define PUSHLOOP_FOR(cx, ivar, s) \
38a230cb 802 cx->blk_loop.resetsp = s - PL_stack_base; \
022eaa24 803 cx->blk_loop.my_op = cLOOP; \
d01136d6
BS
804 cx->blk_loop.state_u.ary.ary = NULL; \
805 cx->blk_loop.state_u.ary.ix = 0; \
df530c37 806 cx->blk_loop.itervar_u.svp = (SV**)(ivar);
79072805
LW
807
808#define POPLOOP(cx) \
d01136d6 809 if (CxTYPE(cx) == CXt_LOOP_LAZYSV) { \
2f995715
FC
810 SvREFCNT_dec_NN(cx->blk_loop.state_u.lazysv.cur); \
811 SvREFCNT_dec_NN(cx->blk_loop.state_u.lazysv.end); \
d01136d6 812 } \
d01136d6
BS
813 if (CxTYPE(cx) == CXt_LOOP_FOR) \
814 SvREFCNT_dec(cx->blk_loop.state_u.ary.ary);
79072805 815
0d863452
RH
816/* given/when context */
817struct block_givwhen {
818 OP *leave_op;
819};
820
821#define PUSHGIVEN(cx) \
822 cx->blk_givwhen.leave_op = cLOGOP->op_other;
823
824#define PUSHWHEN PUSHGIVEN
825
79072805
LW
826/* context common to subroutines, evals and loops */
827struct block {
446d0787 828 U8 blku_type; /* what kind of context this is */
2e0df0e8 829 U8 blku_gimme; /* is this block running in list context? */
17347a51 830 U16 blku_u16; /* used by block_sub and block_eval (so far) */
79072805
LW
831 I32 blku_oldsp; /* stack pointer to copy stuff down to */
832 COP * blku_oldcop; /* old curcop pointer */
79072805
LW
833 I32 blku_oldmarksp; /* mark stack index */
834 I32 blku_oldscopesp; /* scope stack index */
835 PMOP * blku_oldpm; /* values of pattern match vars */
79072805
LW
836
837 union {
838 struct block_sub blku_sub;
f9c764c5 839 struct block_format blku_format;
79072805
LW
840 struct block_eval blku_eval;
841 struct block_loop blku_loop;
0d863452 842 struct block_givwhen blku_givwhen;
79072805
LW
843 } blk_u;
844};
845#define blk_oldsp cx_u.cx_blk.blku_oldsp
846#define blk_oldcop cx_u.cx_blk.blku_oldcop
79072805
LW
847#define blk_oldmarksp cx_u.cx_blk.blku_oldmarksp
848#define blk_oldscopesp cx_u.cx_blk.blku_oldscopesp
849#define blk_oldpm cx_u.cx_blk.blku_oldpm
850#define blk_gimme cx_u.cx_blk.blku_gimme
446d0787 851#define blk_u16 cx_u.cx_blk.blku_u16
79072805 852#define blk_sub cx_u.cx_blk.blk_u.blku_sub
f9c764c5 853#define blk_format cx_u.cx_blk.blk_u.blku_format
79072805
LW
854#define blk_eval cx_u.cx_blk.blk_u.blku_eval
855#define blk_loop cx_u.cx_blk.blk_u.blku_loop
0d863452 856#define blk_givwhen cx_u.cx_blk.blk_u.blku_givwhen
79072805 857
1c98cc53 858#define DEBUG_CX(action) \
d9f81b50 859 DEBUG_l( \
1c98cc53
DM
860 Perl_deb(aTHX_ "CX %ld %s %s (scope %ld,%ld) at %s:%d\n", \
861 (long)cxstack_ix, \
862 action, \
863 PL_block_type[CxTYPE(&cxstack[cxstack_ix])], \
864 (long)PL_scopestack_ix, \
865 (long)(cxstack[cxstack_ix].blk_oldscopesp), \
d9f81b50 866 __FILE__, __LINE__));
1c98cc53 867
79072805 868/* Enter a block. */
8990e307 869#define PUSHBLOCK(cx,t,sp) CXINC, cx = &cxstack[cxstack_ix], \
79072805 870 cx->cx_type = t, \
3280af22
NIS
871 cx->blk_oldsp = sp - PL_stack_base, \
872 cx->blk_oldcop = PL_curcop, \
1aff0e91 873 cx->blk_oldmarksp = PL_markstack_ptr - PL_markstack, \
3280af22 874 cx->blk_oldscopesp = PL_scopestack_ix, \
3280af22 875 cx->blk_oldpm = PL_curpm, \
eb160463 876 cx->blk_gimme = (U8)gimme; \
1c98cc53 877 DEBUG_CX("PUSH");
79072805
LW
878
879/* Exit a block (RETURN and LAST). */
1c98cc53
DM
880#define POPBLOCK(cx,pm) \
881 DEBUG_CX("POP"); \
882 cx = &cxstack[cxstack_ix--], \
1aff0e91 883 newsp = PL_stack_base + cx->blk_oldsp, \
3280af22
NIS
884 PL_curcop = cx->blk_oldcop, \
885 PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp, \
886 PL_scopestack_ix = cx->blk_oldscopesp, \
3280af22 887 pm = cx->blk_oldpm, \
1c98cc53 888 gimme = cx->blk_gimme;
79072805
LW
889
890/* Continue a block elsewhere (NEXT and REDO). */
1c98cc53
DM
891#define TOPBLOCK(cx) \
892 DEBUG_CX("TOP"); \
893 cx = &cxstack[cxstack_ix], \
1aff0e91 894 PL_stack_sp = PL_stack_base + cx->blk_oldsp, \
3280af22
NIS
895 PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp, \
896 PL_scopestack_ix = cx->blk_oldscopesp, \
1c98cc53 897 PL_curpm = cx->blk_oldpm;
79072805
LW
898
899/* substitution context */
900struct subst {
446d0787 901 U8 sbu_type; /* what kind of context this is */
1ed74d04 902 U8 sbu_rflags;
446d0787 903 U16 sbu_rxtainted; /* matches struct block */
4633a7c4 904 I32 sbu_oldsave;
3c6ef0a5
FC
905 SSize_t sbu_iters;
906 SSize_t sbu_maxiters;
79072805
LW
907 char * sbu_orig;
908 SV * sbu_dstr;
909 SV * sbu_targ;
910 char * sbu_s;
911 char * sbu_m;
912 char * sbu_strend;
c90c0ff4 913 void * sbu_rxres;
c07a80fd 914 REGEXP * sbu_rx;
79072805
LW
915};
916#define sb_iters cx_u.cx_subst.sbu_iters
917#define sb_maxiters cx_u.cx_subst.sbu_maxiters
22e551b9 918#define sb_rflags cx_u.cx_subst.sbu_rflags
4633a7c4 919#define sb_oldsave cx_u.cx_subst.sbu_oldsave
71be2cbc 920#define sb_rxtainted cx_u.cx_subst.sbu_rxtainted
79072805
LW
921#define sb_orig cx_u.cx_subst.sbu_orig
922#define sb_dstr cx_u.cx_subst.sbu_dstr
923#define sb_targ cx_u.cx_subst.sbu_targ
924#define sb_s cx_u.cx_subst.sbu_s
925#define sb_m cx_u.cx_subst.sbu_m
926#define sb_strend cx_u.cx_subst.sbu_strend
c90c0ff4 927#define sb_rxres cx_u.cx_subst.sbu_rxres
c07a80fd 928#define sb_rx cx_u.cx_subst.sbu_rx
79072805 929
9c105995
NC
930#ifdef PERL_CORE
931# define PUSHSUBST(cx) CXINC, cx = &cxstack[cxstack_ix], \
79072805
LW
932 cx->sb_iters = iters, \
933 cx->sb_maxiters = maxiters, \
22e551b9 934 cx->sb_rflags = r_flags, \
4633a7c4 935 cx->sb_oldsave = oldsave, \
71be2cbc 936 cx->sb_rxtainted = rxtainted, \
79072805
LW
937 cx->sb_orig = orig, \
938 cx->sb_dstr = dstr, \
939 cx->sb_targ = targ, \
940 cx->sb_s = s, \
941 cx->sb_m = m, \
942 cx->sb_strend = strend, \
4608196e 943 cx->sb_rxres = NULL, \
c07a80fd 944 cx->sb_rx = rx, \
1ed74d04 945 cx->cx_type = CXt_SUBST | (once ? CXp_ONCE : 0); \
e22ae1e2 946 rxres_save(&cx->sb_rxres, rx); \
cf69025f
TC
947 (void)ReREFCNT_inc(rx); \
948 SvREFCNT_inc_void_NN(targ)
79072805 949
9c105995 950# define POPSUBST(cx) cx = &cxstack[cxstack_ix--]; \
e22ae1e2 951 rxres_free(&cx->sb_rxres); \
cf69025f
TC
952 ReREFCNT_dec(cx->sb_rx); \
953 SvREFCNT_dec_NN(cx->sb_targ)
9c105995
NC
954#endif
955
956#define CxONCE(cx) ((cx)->cx_type & CXp_ONCE)
79072805
LW
957
958struct context {
79072805
LW
959 union {
960 struct block cx_blk;
961 struct subst cx_subst;
962 } cx_u;
963};
2e0df0e8 964#define cx_type cx_u.cx_subst.sbu_type
6b35e009 965
76753e7f
NC
966/* If you re-order these, there is also an array of uppercase names in perl.h
967 and a static array of context names in pp_ctl.c */
3701055e 968#define CXTYPEMASK 0xf
79072805 969#define CXt_NULL 0
76753e7f
NC
970#define CXt_WHEN 1
971#define CXt_BLOCK 2
972/* When micro-optimising :-) keep GIVEN next to the LOOPs, as these 5 share a
973 jump table in pp_ctl.c
974 The first 4 don't have a 'case' in at least one switch statement in pp_ctl.c
975*/
976#define CXt_GIVEN 3
c6fdafd0 977/* This is first so that CXt_LOOP_FOR|CXt_LOOP_LAZYIV is CXt_LOOP_LAZYIV */
76753e7f
NC
978#define CXt_LOOP_FOR 4
979#define CXt_LOOP_PLAIN 5
980#define CXt_LOOP_LAZYSV 6
981#define CXt_LOOP_LAZYIV 7
982#define CXt_SUB 8
983#define CXt_FORMAT 9
984#define CXt_EVAL 10
985#define CXt_SUBST 11
986/* SUBST doesn't feature in all switch statements. */
79072805 987
3701055e
NC
988/* private flags for CXt_SUB and CXt_NULL
989 However, this is checked in many places which do not check the type, so
990 this bit needs to be kept clear for most everything else. For reasons I
991 haven't investigated, it can coexist with CXp_FOR_DEF */
1f27d788
NC
992#define CXp_MULTICALL 0x10 /* part of a multicall (so don't
993 tear down context on exit). */
9850bf21 994
ae423868 995/* private flags for CXt_SUB and CXt_FORMAT */
1f27d788 996#define CXp_HASARGS 0x20
b0065247
DM
997#define CXp_SUB_RE 0x40 /* code called within regex, i.e. (?{}) */
998#define CXp_SUB_RE_FAKE 0x80 /* fake sub CX for (?{}) in current scope */
ae423868 999
6b35e009 1000/* private flags for CXt_EVAL */
1f27d788
NC
1001#define CXp_REAL 0x20 /* truly eval'', not a lookalike */
1002#define CXp_TRYBLOCK 0x40 /* eval{}, not eval'' or similar */
6b35e009 1003
7766f137 1004/* private flags for CXt_LOOP */
1f27d788 1005#define CXp_FOR_DEF 0x10 /* foreach using $_ */
d39c26a6 1006#define CXp_FOR_LVREF 0x20 /* foreach using \$var */
56b98d0f 1007#define CxPADLOOP(c) ((c)->blk_loop.my_op->op_targ)
e846cb92 1008
1ed74d04
NC
1009/* private flags for CXt_SUBST */
1010#define CXp_ONCE 0x10 /* What was sbu_once in struct subst */
7766f137 1011
6b35e009 1012#define CxTYPE(c) ((c)->cx_type & CXTYPEMASK)
76753e7f 1013#define CxTYPE_is_LOOP(c) (((c)->cx_type & 0xC) == 0x4)
9850bf21
RH
1014#define CxMULTICALL(c) (((c)->cx_type & CXp_MULTICALL) \
1015 == CXp_MULTICALL)
0588a150 1016#define CxREALEVAL(c) (((c)->cx_type & (CXTYPEMASK|CXp_REAL)) \
7766f137 1017 == (CXt_EVAL|CXp_REAL))
0588a150 1018#define CxTRYBLOCK(c) (((c)->cx_type & (CXTYPEMASK|CXp_TRYBLOCK)) \
1d76a5c3 1019 == (CXt_EVAL|CXp_TRYBLOCK))
3b719c58
NC
1020#define CxFOREACH(c) (CxTYPE_is_LOOP(c) && CxTYPE(c) != CXt_LOOP_PLAIN)
1021#define CxFOREACHDEF(c) ((CxTYPE_is_LOOP(c) && CxTYPE(c) != CXt_LOOP_PLAIN) \
1022 && ((c)->cx_type & CXp_FOR_DEF))
6b35e009 1023
109bf713 1024#define CXINC (cxstack_ix < cxstack_max ? ++cxstack_ix : (cxstack_ix = cxinc()))
79072805 1025
ccfc67b7
JH
1026/*
1027=head1 "Gimme" Values
1028*/
954c1994
GS
1029
1030/*
1031=for apidoc AmU||G_SCALAR
fbe13c60 1032Used to indicate scalar context. See C<L</GIMME_V>>, C<L</GIMME>>, and
954c1994
GS
1033L<perlcall>.
1034
1035=for apidoc AmU||G_ARRAY
fbe13c60 1036Used to indicate list context. See C<L</GIMME_V>>, C<L</GIMME>> and
954c1994
GS
1037L<perlcall>.
1038
1039=for apidoc AmU||G_VOID
fbe13c60 1040Used to indicate void context. See C<L</GIMME_V>> and L<perlcall>.
954c1994
GS
1041
1042=for apidoc AmU||G_DISCARD
1043Indicates that arguments returned from a callback should be discarded. See
1044L<perlcall>.
1045
1046=for apidoc AmU||G_EVAL
1047
1048Used to force a Perl C<eval> wrapper around a callback. See
1049L<perlcall>.
1050
1051=for apidoc AmU||G_NOARGS
1052
1053Indicates that no arguments are being sent to a callback. See
1054L<perlcall>.
1055
1056=cut
1057*/
1058
2f8edad0
NC
1059#define G_SCALAR 2
1060#define G_ARRAY 3
1061#define G_VOID 1
1062#define G_WANT 3
79072805 1063
864dbfa3 1064/* extra flags for Perl_call_* routines */
2f8edad0 1065#define G_DISCARD 4 /* Call FREETMPS.
b54b4831
NC
1066 Don't change this without consulting the
1067 hash actions codes defined in hv.h */
2f8edad0
NC
1068#define G_EVAL 8 /* Assume eval {} around subroutine call. */
1069#define G_NOARGS 16 /* Don't construct a @_ array. */
7ce09284 1070#define G_KEEPERR 32 /* Warn for errors, don't overwrite $@ */
2f8edad0
NC
1071#define G_NODEBUG 64 /* Disable debugging at toplevel. */
1072#define G_METHOD 128 /* Calling method. */
c40f1585 1073#define G_FAKINGEVAL 256 /* Faking an eval context for call_sv or
edb2152a 1074 fold_constants. */
67549bd2
NC
1075#define G_UNDEF_FILL 512 /* Fill the stack with &PL_sv_undef
1076 A special case for UNSHIFT in
1077 Perl_magic_methcall(). */
d1d7a15d
NC
1078#define G_WRITING_TO_STDERR 1024 /* Perl_write_to_stderr() is calling
1079 Perl_magic_methcall(). */
a1941760 1080#define G_RE_REPARSING 0x800 /* compiling a run-time /(?{..})/ */
c106c2be 1081#define G_METHOD_NAMED 4096 /* calling named method, eg without :: or ' */
e336de0d 1082
faef0170
HS
1083/* flag bits for PL_in_eval */
1084#define EVAL_NULL 0 /* not in an eval */
1085#define EVAL_INEVAL 1 /* some enclosing scope is an eval */
1086#define EVAL_WARNONLY 2 /* used by yywarn() when calling yyerror() */
864dbfa3 1087#define EVAL_KEEPERR 4 /* set by Perl_call_sv if G_KEEPERR */
6dc8a9e4 1088#define EVAL_INREQUIRE 8 /* The code is being required. */
a1941760 1089#define EVAL_RE_REPARSING 0x10 /* eval_sv() called with G_RE_REPARSING */
faef0170 1090
e336de0d
GS
1091/* Support for switching (stack and block) contexts.
1092 * This ensures magic doesn't invalidate local stack and cx pointers.
1093 */
1094
e788e7d3
GS
1095#define PERLSI_UNKNOWN -1
1096#define PERLSI_UNDEF 0
1097#define PERLSI_MAIN 1
1098#define PERLSI_MAGIC 2
1099#define PERLSI_SORT 3
1100#define PERLSI_SIGNAL 4
1101#define PERLSI_OVERLOAD 5
1102#define PERLSI_DESTROY 6
1103#define PERLSI_WARNHOOK 7
1104#define PERLSI_DIEHOOK 8
1105#define PERLSI_REQUIRE 9
e1a10f35 1106#define PERLSI_MULTICALL 10
e336de0d
GS
1107
1108struct stackinfo {
1109 AV * si_stack; /* stack for current runlevel */
1110 PERL_CONTEXT * si_cxstack; /* context stack for runlevel */
9bd87817
NC
1111 struct stackinfo * si_prev;
1112 struct stackinfo * si_next;
e336de0d
GS
1113 I32 si_cxix; /* current context index */
1114 I32 si_cxmax; /* maximum allocated index */
1115 I32 si_type; /* type of runlevel */
ce2f7c3b 1116 I32 si_markoff; /* offset where markstack begins for us.
e336de0d
GS
1117 * currently used only with DEBUGGING,
1118 * but not #ifdef-ed for bincompat */
1119};
1120
1121typedef struct stackinfo PERL_SI;
1122
3280af22
NIS
1123#define cxstack (PL_curstackinfo->si_cxstack)
1124#define cxstack_ix (PL_curstackinfo->si_cxix)
1125#define cxstack_max (PL_curstackinfo->si_cxmax)
e336de0d
GS
1126
1127#ifdef DEBUGGING
ce2f7c3b
GS
1128# define SET_MARK_OFFSET \
1129 PL_curstackinfo->si_markoff = PL_markstack_ptr - PL_markstack
e336de0d 1130#else
ce2f7c3b 1131# define SET_MARK_OFFSET NOOP
e336de0d
GS
1132#endif
1133
d3acc0f7 1134#define PUSHSTACKi(type) \
e336de0d 1135 STMT_START { \
3280af22 1136 PERL_SI *next = PL_curstackinfo->si_next; \
1c98cc53
DM
1137 DEBUG_l({ \
1138 int i = 0; PERL_SI *p = PL_curstackinfo; \
1139 while (p) { i++; p = p->si_prev; } \
1140 Perl_deb(aTHX_ "push STACKINFO %d at %s:%d\n", \
1141 i, __FILE__, __LINE__);}) \
e336de0d
GS
1142 if (!next) { \
1143 next = new_stackinfo(32, 2048/sizeof(PERL_CONTEXT) - 1); \
3280af22
NIS
1144 next->si_prev = PL_curstackinfo; \
1145 PL_curstackinfo->si_next = next; \
e336de0d
GS
1146 } \
1147 next->si_type = type; \
1148 next->si_cxix = -1; \
1149 AvFILLp(next->si_stack) = 0; \
3280af22
NIS
1150 SWITCHSTACK(PL_curstack,next->si_stack); \
1151 PL_curstackinfo = next; \
ce2f7c3b 1152 SET_MARK_OFFSET; \
e336de0d
GS
1153 } STMT_END
1154
e788e7d3 1155#define PUSHSTACK PUSHSTACKi(PERLSI_UNKNOWN)
d3acc0f7 1156
3095d977
GS
1157/* POPSTACK works with PL_stack_sp, so it may need to be bracketed by
1158 * PUTBACK/SPAGAIN to flush/refresh any local SP that may be active */
d3acc0f7 1159#define POPSTACK \
e336de0d 1160 STMT_START { \
39644a26 1161 dSP; \
c4420975 1162 PERL_SI * const prev = PL_curstackinfo->si_prev; \
1c98cc53
DM
1163 DEBUG_l({ \
1164 int i = -1; PERL_SI *p = PL_curstackinfo; \
1165 while (p) { i++; p = p->si_prev; } \
1166 Perl_deb(aTHX_ "pop STACKINFO %d at %s:%d\n", \
1167 i, __FILE__, __LINE__);}) \
e336de0d 1168 if (!prev) { \
3d04513d 1169 Perl_croak_popstack(); \
e336de0d 1170 } \
3280af22 1171 SWITCHSTACK(PL_curstack,prev->si_stack); \
e336de0d 1172 /* don't free prev here, free them all at the END{} */ \
3280af22 1173 PL_curstackinfo = prev; \
e336de0d
GS
1174 } STMT_END
1175
1176#define POPSTACK_TO(s) \
1177 STMT_START { \
3280af22 1178 while (PL_curstack != s) { \
bac4b2ad 1179 dounwind(-1); \
d3acc0f7 1180 POPSTACK; \
bac4b2ad 1181 } \
e336de0d 1182 } STMT_END
923e4eb5
JH
1183
1184#define IN_PERL_COMPILETIME (PL_curcop == &PL_compiling)
1185#define IN_PERL_RUNTIME (PL_curcop != &PL_compiling)
1186
9850bf21
RH
1187/*
1188=head1 Multicall Functions
1189
1190=for apidoc Ams||dMULTICALL
72d33970 1191Declare local variables for a multicall. See L<perlcall/LIGHTWEIGHT CALLBACKS>.
9850bf21
RH
1192
1193=for apidoc Ams||PUSH_MULTICALL
1194Opening bracket for a lightweight callback.
0eda4409 1195See L<perlcall/LIGHTWEIGHT CALLBACKS>.
9850bf21
RH
1196
1197=for apidoc Ams||MULTICALL
72d33970 1198Make a lightweight callback. See L<perlcall/LIGHTWEIGHT CALLBACKS>.
9850bf21
RH
1199
1200=for apidoc Ams||POP_MULTICALL
1201Closing bracket for a lightweight callback.
0eda4409 1202See L<perlcall/LIGHTWEIGHT CALLBACKS>.
9850bf21
RH
1203
1204=cut
1205*/
1206
1207#define dMULTICALL \
1208 SV **newsp; /* set by POPBLOCK */ \
1209 PERL_CONTEXT *cx; \
82f35e8b 1210 CV *multicall_cv; \
9850bf21
RH
1211 OP *multicall_cop; \
1212 bool multicall_oldcatch; \
1213 U8 hasargs = 0 /* used by PUSHSUB */
1214
82f35e8b 1215#define PUSH_MULTICALL(the_cv) \
b0065247 1216 PUSH_MULTICALL_FLAGS(the_cv, 0)
81ed78b2 1217
b0065247
DM
1218/* Like PUSH_MULTICALL, but allows you to specify extra flags
1219 * for the CX stack entry (this isn't part of the public API) */
81ed78b2 1220
b0065247 1221#define PUSH_MULTICALL_FLAGS(the_cv, flags) \
9850bf21 1222 STMT_START { \
0bcc34c2
AL
1223 CV * const _nOnclAshIngNamE_ = the_cv; \
1224 CV * const cv = _nOnclAshIngNamE_; \
b70d5558 1225 PADLIST * const padlist = CvPADLIST(cv); \
9850bf21
RH
1226 ENTER; \
1227 multicall_oldcatch = CATCH_GET; \
1228 SAVETMPS; SAVEVPTR(PL_op); \
1229 CATCH_SET(TRUE); \
e1a10f35 1230 PUSHSTACKi(PERLSI_MULTICALL); \
b0065247 1231 PUSHBLOCK(cx, (CXt_SUB|CXp_MULTICALL|flags), PL_stack_sp); \
9850bf21 1232 PUSHSUB(cx); \
b0065247
DM
1233 if (!(flags & CXp_SUB_RE_FAKE)) \
1234 CvDEPTH(cv)++; \
81ed78b2 1235 if (CvDEPTH(cv) >= 2) { \
9850bf21
RH
1236 PERL_STACK_OVERFLOW_CHECK(); \
1237 Perl_pad_push(aTHX_ padlist, CvDEPTH(cv)); \
1238 } \
9850bf21 1239 PAD_SET_CUR_NOSAVE(padlist, CvDEPTH(cv)); \
82f35e8b 1240 multicall_cv = cv; \
9850bf21
RH
1241 multicall_cop = CvSTART(cv); \
1242 } STMT_END
1243
1244#define MULTICALL \
1245 STMT_START { \
1246 PL_op = multicall_cop; \
1247 CALLRUNOPS(aTHX); \
1248 } STMT_END
1249
1250#define POP_MULTICALL \
1251 STMT_START { \
3d26b81e 1252 cx = &cxstack[cxstack_ix]; \
2c50b7ed
DM
1253 CvDEPTH(multicall_cv) = cx->blk_sub.olddepth; \
1254 LEAVESUB(multicall_cv); \
9850bf21 1255 POPBLOCK(cx,PL_curpm); \
39de75fd 1256 /* includes partial unrolled POPSUB(): */ \
3b21fb5d
DM
1257 LEAVE_SCOPE(PL_scopestack[cx->blk_oldscopesp-1]); \
1258 PL_comppad = cx->blk_sub.prevcomppad; \
1259 PL_curpad = LIKELY(PL_comppad) ? AvARRAY(PL_comppad) : NULL; \
1bbbfc50 1260 POPSTACK; \
9850bf21
RH
1261 CATCH_SET(multicall_oldcatch); \
1262 LEAVE; \
1bbbfc50 1263 SPAGAIN; \
9850bf21 1264 } STMT_END
b3ca2e83 1265
81ed78b2
DM
1266/* Change the CV of an already-pushed MULTICALL CxSUB block.
1267 * (this isn't part of the public API) */
1268
b0065247 1269#define CHANGE_MULTICALL_FLAGS(the_cv, flags) \
81ed78b2
DM
1270 STMT_START { \
1271 CV * const _nOnclAshIngNamE_ = the_cv; \
1272 CV * const cv = _nOnclAshIngNamE_; \
b70d5558 1273 PADLIST * const padlist = CvPADLIST(cv); \
3b21fb5d 1274 PAD * const prevcomppad = cx->blk_sub.prevcomppad; \
81ed78b2
DM
1275 cx = &cxstack[cxstack_ix]; \
1276 assert(cx->cx_type & CXp_MULTICALL); \
2c50b7ed
DM
1277 CvDEPTH(multicall_cv) = cx->blk_sub.olddepth; \
1278 LEAVESUB(multicall_cv); \
b0065247 1279 cx->cx_type = (CXt_SUB|CXp_MULTICALL|flags); \
81ed78b2 1280 PUSHSUB(cx); \
3b21fb5d 1281 cx->blk_sub.prevcomppad = prevcomppad ; /* undo PUSHSUB */ \
b0065247
DM
1282 if (!(flags & CXp_SUB_RE_FAKE)) \
1283 CvDEPTH(cv)++; \
81ed78b2
DM
1284 if (CvDEPTH(cv) >= 2) { \
1285 PERL_STACK_OVERFLOW_CHECK(); \
1286 Perl_pad_push(aTHX_ padlist, CvDEPTH(cv)); \
1287 } \
81ed78b2
DM
1288 PAD_SET_CUR_NOSAVE(padlist, CvDEPTH(cv)); \
1289 multicall_cv = cv; \
1290 multicall_cop = CvSTART(cv); \
1291 } STMT_END
b3ca2e83 1292/*
14d04a33 1293 * ex: set ts=8 sts=4 sw=4 et:
b3ca2e83 1294 */