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