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