3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4 * 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 by Larry Wall and others
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.
9 * Control ops (cops) are one of the two ops OP_NEXTSTATE and OP_DBSTATE,
10 * that (loosely speaking) are statement separators.
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,
13 * and thus can be used to determine our current state.
16 /* A jmpenv packages the state required to perform a proper non-local jump.
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
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
23 * null to ensure this).
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.
33 struct jmpenv * je_prev;
34 Sigjmp_buf je_buf; /* uninit if je_prev is NULL */
35 int je_ret; /* last exception thrown */
36 bool je_mustcatch; /* longjmp()s must be caught locally */
37 U16 je_old_delaymagic; /* saved PL_delaymagic */
38 SSize_t je_old_stack_hwm;
41 typedef struct jmpenv JMPENV;
43 #if defined DEBUGGING && !defined DEBUGGING_RE_ONLY
44 # define JE_OLD_STACK_HWM_zero PL_start_env.je_old_stack_hwm = 0
45 # define JE_OLD_STACK_HWM_save(je) \
46 (je).je_old_stack_hwm = PL_curstackinfo->si_stack_hwm
47 # define JE_OLD_STACK_HWM_restore(je) \
48 if (PL_curstackinfo->si_stack_hwm < (je).je_old_stack_hwm) \
49 PL_curstackinfo->si_stack_hwm = (je).je_old_stack_hwm
51 # define JE_OLD_STACK_HWM_zero NOOP
52 # define JE_OLD_STACK_HWM_save(je) NOOP
53 # define JE_OLD_STACK_HWM_restore(je) NOOP
57 * How to build the first jmpenv.
59 * top_env needs to be non-zero. It points to an area
60 * in which longjmp() stuff is stored, as C callstack
61 * info there at least is thread specific this has to
62 * be per-thread. Otherwise a 'die' in a thread gives
63 * that thread the C stack of last thread to do an eval {}!
66 #define JMPENV_BOOTSTRAP \
68 PERL_POISON_EXPR(PoisonNew(&PL_start_env, 1, JMPENV));\
69 PL_top_env = &PL_start_env; \
70 PL_start_env.je_prev = NULL; \
71 PL_start_env.je_ret = -1; \
72 PL_start_env.je_mustcatch = TRUE; \
73 PL_start_env.je_old_delaymagic = 0; \
74 JE_OLD_STACK_HWM_zero; \
78 * PERL_FLEXIBLE_EXCEPTIONS
80 * All the flexible exceptions code has been removed.
81 * See the following threads for details:
83 * Message-Id: 20040713143217.GB1424@plum.flirble.org
84 * https://www.nntp.perl.org/group/perl.perl5.porters/2004/07/msg93041.html
86 * Joshua's original patches (which weren't applied) and discussion:
88 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg01396.html
89 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg01489.html
90 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg01491.html
91 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg01608.html
92 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg02144.html
93 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg02998.html
95 * Chip's reworked patch and discussion:
97 * http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1999-03/msg00520.html
99 * The flaw in these patches (which went unnoticed at the time) was
100 * that they moved some code that could potentially die() out of the
101 * region protected by the setjmp()s. This caused exceptions within
102 * END blocks and such to not be handled by the correct setjmp().
104 * The original patches that introduces flexible exceptions were:
106 * https://github.com/Perl/perl5/commit/312caa8e97f1c7ee342a9895c2f0e749625b4929
107 * https://github.com/Perl/perl5/commit/14dd3ad8c9bf82cf09798a22cc89a9862dfd6d1a
111 #define dJMPENV JMPENV cur_env
113 #define JMPENV_PUSH(v) \
116 int i = 0; JMPENV *p = PL_top_env; \
117 while (p) { i++; p = p->je_prev; } \
118 Perl_deb(aTHX_ "JMPENV_PUSH level=%d at %s:%d\n", \
119 i, __FILE__, __LINE__);}) \
120 cur_env.je_prev = PL_top_env; \
121 JE_OLD_STACK_HWM_save(cur_env); \
122 cur_env.je_ret = PerlProc_setjmp(cur_env.je_buf, SCOPE_SAVES_SIGNAL_MASK); \
123 JE_OLD_STACK_HWM_restore(cur_env); \
124 PL_top_env = &cur_env; \
125 cur_env.je_mustcatch = FALSE; \
126 cur_env.je_old_delaymagic = PL_delaymagic; \
127 (v) = cur_env.je_ret; \
133 int i = -1; JMPENV *p = PL_top_env; \
134 while (p) { i++; p = p->je_prev; } \
135 Perl_deb(aTHX_ "JMPENV_POP level=%d at %s:%d\n", \
136 i, __FILE__, __LINE__);}) \
137 assert(PL_top_env == &cur_env); \
138 PL_delaymagic = cur_env.je_old_delaymagic; \
139 PL_top_env = cur_env.je_prev; \
142 #define JMPENV_JUMP(v) \
145 int i = -1; JMPENV *p = PL_top_env; \
146 while (p) { i++; p = p->je_prev; } \
147 Perl_deb(aTHX_ "JMPENV_JUMP(%d) level=%d at %s:%d\n", \
148 (int)v, i, __FILE__, __LINE__);}) \
149 if (PL_top_env->je_prev) \
150 PerlProc_longjmp(PL_top_env->je_buf, (v)); \
152 PerlProc_exit(STATUS_EXIT); \
153 PerlIO_printf(PerlIO_stderr(), "panic: top_env, v=%d\n", (int)v); \
157 #define CATCH_GET (PL_top_env->je_mustcatch)
158 #define CATCH_SET(v) \
162 "JUMPLEVEL set catch %d => %d (for %p) at %s:%d\n", \
163 PL_top_env->je_mustcatch, v, (void*)PL_top_env, \
164 __FILE__, __LINE__);) \
165 PL_top_env->je_mustcatch = (v); \
169 =for apidoc_section $COP
172 typedef struct refcounted_he COPHH;
174 #define COPHH_KEY_UTF8 REFCOUNTED_HE_KEY_UTF8
175 #define COPHH_EXISTS REFCOUNTED_HE_EXISTS
178 =for apidoc Amx|SV *|cophh_fetch_pv |const COPHH *cophh|const char *key |U32 hash|U32 flags
179 =for apidoc_item|SV *|cophh_fetch_pvn|const COPHH *cophh|const char *key|STRLEN keylen|U32 hash|U32 flags
180 =for apidoc_item|SV *|cophh_fetch_pvs|const COPHH *cophh| "key" |U32 flags
181 =for apidoc_item|SV *|cophh_fetch_sv |const COPHH *cophh| SV *key |U32 hash|U32 flags
183 These look up the entry in the cop hints hash C<cophh> with the key specified by
184 C<key> (and C<keylen> in the C<pvn> form), returning that value as a mortal
185 scalar copy, or C<&PL_sv_placeholder> if there is no value associated with the
188 The forms differ in how the key is specified.
189 In the plain C<pv> form, the key is a C language NUL-terminated string.
190 In the C<pvs> form, the key is a C language string literal.
191 In the C<pvn> form, an additional parameter, C<keylen>, specifies the length of
192 the string, which hence, may contain embedded-NUL characters.
193 In the C<sv> form, C<*key> is an SV, and the key is the PV extracted from that.
194 using C<L</SvPV_const>>.
196 C<hash> is a precomputed hash of the key string, or zero if it has not been
197 precomputed. This parameter is omitted from the C<pvs> form, as it is computed
198 automatically at compile time.
200 The only flag currently used from the C<flags> parameter is C<COPHH_KEY_UTF8>.
201 It is illegal to set this in the C<sv> form. In the C<pv*> forms, it specifies
202 whether the key octets are interpreted as UTF-8 (if set) or as Latin-1 (if
203 cleared). The C<sv> form uses the underlying SV to determine the UTF-8ness of
206 =for apidoc Amnh||COPHH_KEY_UTF8
212 #define cophh_fetch_pvn(cophh, key, keylen, hash, flags) \
213 Perl_refcounted_he_fetch_pvn(aTHX_ cophh, key, keylen, hash, \
214 (flags & COPHH_KEY_UTF8))
216 #define cophh_fetch_pvs(cophh, key, flags) \
217 Perl_refcounted_he_fetch_pvn(aTHX_ cophh, STR_WITH_LEN(key), 0, \
218 (flags & COPHH_KEY_UTF8))
220 #define cophh_fetch_pv(cophh, key, hash, flags) \
221 Perl_refcounted_he_fetch_pv(aTHX_ cophh, key, hash, \
222 (flags & COPHH_KEY_UTF8))
224 #define cophh_fetch_sv(cophh, key, hash, flags) \
225 Perl_refcounted_he_fetch_sv(aTHX_ cophh, key, hash, \
226 (flags & COPHH_KEY_UTF8))
229 =for apidoc Amx|bool|cophh_exists_pvn|const COPHH *cophh|const char *key|STRLEN keylen|U32 hash|U32 flags
231 These look up the hint entry in the cop C<cop> with the key specified by
232 C<key> (and C<keylen> in the C<pvn> form), returning true if a value exists,
235 The forms differ in how the key is specified.
236 In the plain C<pv> form, the key is a C language NUL-terminated string.
237 In the C<pvs> form, the key is a C language string literal.
238 In the C<pvn> form, an additional parameter, C<keylen>, specifies the length of
239 the string, which hence, may contain embedded-NUL characters.
240 In the C<sv> form, C<*key> is an SV, and the key is the PV extracted from that.
241 using C<L</SvPV_const>>.
243 C<hash> is a precomputed hash of the key string, or zero if it has not been
244 precomputed. This parameter is omitted from the C<pvs> form, as it is computed
245 automatically at compile time.
247 The only flag currently used from the C<flags> parameter is C<COPHH_KEY_UTF8>.
248 It is illegal to set this in the C<sv> form. In the C<pv*> forms, it specifies
249 whether the key octets are interpreted as UTF-8 (if set) or as Latin-1 (if
250 cleared). The C<sv> form uses the underlying SV to determine the UTF-8ness of
256 #define cophh_exists_pvn(cophh, key, keylen, hash, flags) \
257 cBOOL(Perl_refcounted_he_fetch_pvn(aTHX_ cophh, key, keylen, hash, flags | COPHH_EXISTS))
259 #define cophh_exists_pvs(cophh, key, flags) \
260 cBOOL(Perl_refcounted_he_fetch_pvn(aTHX_ cophh, STR_WITH_LEN(key), 0, flags | COPHH_EXISTS))
262 #define cophh_exists_pv(cophh, key, hash, flags) \
263 cBOOL(Perl_refcounted_he_fetch_pv(aTHX_ cophh, key, hash, flags | COPHH_EXISTS))
265 #define cophh_exists_sv(cophh, key, hash, flags) \
266 cBOOL(Perl_refcounted_he_fetch_sv(aTHX_ cophh, key, hash, flags | COPHH_EXISTS))
269 =for apidoc Amx|HV *|cophh_2hv|const COPHH *cophh|U32 flags
271 Generates and returns a standard Perl hash representing the full set of
272 key/value pairs in the cop hints hash C<cophh>. C<flags> is currently
273 unused and must be zero.
278 #define cophh_2hv(cophh, flags) \
279 Perl_refcounted_he_chain_2hv(aTHX_ cophh, flags)
282 =for apidoc Amx|COPHH *|cophh_copy|COPHH *cophh
284 Make and return a complete copy of the cop hints hash C<cophh>.
289 #define cophh_copy(cophh) Perl_refcounted_he_inc(aTHX_ cophh)
292 =for apidoc Amx|void|cophh_free|COPHH *cophh
294 Discard the cop hints hash C<cophh>, freeing all resources associated
300 #define cophh_free(cophh) Perl_refcounted_he_free(aTHX_ cophh)
303 =for apidoc Amx|COPHH *|cophh_new_empty
305 Generate and return a fresh cop hints hash containing no entries.
310 #define cophh_new_empty() ((COPHH *)NULL)
313 =for apidoc Amx|COPHH *|cophh_store_pv |COPHH *cophh|const char *key |U32 hash|SV *value|U32 flags
314 =for apidoc_item|COPHH *|cophh_store_pvn|COPHH *cophh|const char *key|STRLEN keylen|U32 hash|SV *value|U32 flags
315 =for apidoc_item|COPHH *|cophh_store_pvs|COPHH *cophh| "key" |SV *value|U32 flags
316 =for apidoc_item|COPHH *|cophh_store_sv |COPHH *cophh| SV *key |U32 hash|SV *value|U32 flags
318 These store a value, associated with a key, in the cop hints hash C<cophh>,
319 and return the modified hash. The returned hash pointer is in general
320 not the same as the hash pointer that was passed in. The input hash is
321 consumed by the function, and the pointer to it must not be subsequently
322 used. Use L</cophh_copy> if you need both hashes.
324 C<value> is the scalar value to store for this key. C<value> is copied
325 by these functions, which thus do not take ownership of any reference
326 to it, and hence later changes to the scalar will not be reflected in the value
327 visible in the cop hints hash. Complex types of scalar will not be stored with
328 referential integrity, but will be coerced to strings.
330 The forms differ in how the key is specified. In all forms, the key is pointed
332 In the plain C<pv> form, the key is a C language NUL-terminated string.
333 In the C<pvs> form, the key is a C language string literal.
334 In the C<pvn> form, an additional parameter, C<keylen>, specifies the length of
335 the string, which hence, may contain embedded-NUL characters.
336 In the C<sv> form, C<*key> is an SV, and the key is the PV extracted from that.
337 using C<L</SvPV_const>>.
339 C<hash> is a precomputed hash of the key string, or zero if it has not been
340 precomputed. This parameter is omitted from the C<pvs> form, as it is computed
341 automatically at compile time.
343 The only flag currently used from the C<flags> parameter is C<COPHH_KEY_UTF8>.
344 It is illegal to set this in the C<sv> form. In the C<pv*> forms, it specifies
345 whether the key octets are interpreted as UTF-8 (if set) or as Latin-1 (if
346 cleared). The C<sv> form uses the underlying SV to determine the UTF-8ness of
352 #define cophh_store_pvn(cophh, key, keylen, hash, value, flags) \
353 Perl_refcounted_he_new_pvn(aTHX_ cophh, key, keylen, hash, value, flags)
355 #define cophh_store_pvs(cophh, key, value, flags) \
356 Perl_refcounted_he_new_pvn(aTHX_ cophh, STR_WITH_LEN(key), 0, value, flags)
358 #define cophh_store_pv(cophh, key, hash, value, flags) \
359 Perl_refcounted_he_new_pv(aTHX_ cophh, key, hash, value, flags)
361 #define cophh_store_sv(cophh, key, hash, value, flags) \
362 Perl_refcounted_he_new_sv(aTHX_ cophh, key, hash, value, flags)
365 =for apidoc Amx|COPHH *|cophh_delete_pv |COPHH *cophh|const char *key |U32 hash|U32 flags
366 =for apidoc_item|COPHH *|cophh_delete_pvn|COPHH *cophh|const char *key|STRLEN keylen|U32 hash|U32 flags
367 =for apidoc_item|COPHH *|cophh_delete_pvs|COPHH *cophh| "key" |U32 flags
368 =for apidoc_item|COPHH *|cophh_delete_sv |COPHH *cophh| SV *key |U32 hash|U32 flags
370 These delete a key and its associated value from the cop hints hash C<cophh>,
371 and return the modified hash. The returned hash pointer is in general
372 not the same as the hash pointer that was passed in. The input hash is
373 consumed by the function, and the pointer to it must not be subsequently
374 used. Use L</cophh_copy> if you need both hashes.
376 The forms differ in how the key is specified. In all forms, the key is pointed
378 In the plain C<pv> form, the key is a C language NUL-terminated string.
379 In the C<pvs> form, the key is a C language string literal.
380 In the C<pvn> form, an additional parameter, C<keylen>, specifies the length of
381 the string, which hence, may contain embedded-NUL characters.
382 In the C<sv> form, C<*key> is an SV, and the key is the PV extracted from that.
383 using C<L</SvPV_const>>.
385 C<hash> is a precomputed hash of the key string, or zero if it has not been
386 precomputed. This parameter is omitted from the C<pvs> form, as it is computed
387 automatically at compile time.
389 The only flag currently used from the C<flags> parameter is C<COPHH_KEY_UTF8>.
390 It is illegal to set this in the C<sv> form. In the C<pv*> forms, it specifies
391 whether the key octets are interpreted as UTF-8 (if set) or as Latin-1 (if
392 cleared). The C<sv> form uses the underlying SV to determine the UTF-8ness of
398 #define cophh_delete_pvn(cophh, key, keylen, hash, flags) \
399 Perl_refcounted_he_new_pvn(aTHX_ cophh, key, keylen, hash, \
402 #define cophh_delete_pvs(cophh, key, flags) \
403 Perl_refcounted_he_new_pvn(aTHX_ cophh, STR_WITH_LEN(key), 0, \
406 #define cophh_delete_pv(cophh, key, hash, flags) \
407 Perl_refcounted_he_new_pv(aTHX_ cophh, key, hash, (SV *)NULL, flags)
409 #define cophh_delete_sv(cophh, key, hash, flags) \
410 Perl_refcounted_he_new_sv(aTHX_ cophh, key, hash, (SV *)NULL, flags)
412 #include "mydtrace.h"
416 /* On LP64 putting this here takes advantage of the fact that BASEOP isn't
417 an exact multiple of 8 bytes to save structure padding. */
418 line_t cop_line; /* line # of this command */
419 /* label for this construct is now stored in cop_hints_hash */
421 PADOFFSET cop_stashoff; /* offset into PL_stashpad, for the
422 package the line was compiled in */
423 char * cop_file; /* name of file this command is from */
425 HV * cop_stash; /* package line was compiled in */
426 GV * cop_filegv; /* name of GV file this command is from */
428 U32 cop_hints; /* hints bits from pragmata */
429 U32 cop_seq; /* parse sequence number */
430 /* Beware. mg.c and warnings.pl assume the type of this is STRLEN *: */
431 STRLEN * cop_warnings; /* lexical warnings bitmask */
432 /* compile time state of %^H. See the comment in op.c for how this is
433 used to recreate a hash to return from caller. */
434 COPHH * cop_hints_hash;
435 /* for now just a bitmask stored here.
436 If we get sufficient features this may become a pointer.
437 How these flags are stored is subject to change without
438 notice. Use the macros to test for features.
444 =for apidoc Am|const char *|CopFILE|const COP * c
445 Returns the name of the file associated with the C<COP> C<c>
447 =for apidoc Am|STRLEN|CopLINE|const COP * c
448 Returns the line number in the source code associated with the C<COP> C<c>
450 =for apidoc Am|AV *|CopFILEAV|const COP * c
451 Returns the AV associated with the C<COP> C<c>, creating it if necessary.
453 =for apidoc Am|AV *|CopFILEAVn|const COP * c
454 Returns the AV associated with the C<COP> C<c>, returning NULL if it
455 doesn't already exist.
457 =for apidoc Am|SV *|CopFILESV|const COP * c
458 Returns the SV associated with the C<COP> C<c>
460 =for apidoc Am|void|CopFILE_set|COP * c|const char * pv
461 Makes C<pv> the name of the file associated with the C<COP> C<c>
463 =for apidoc Am|GV *|CopFILEGV|const COP * c
464 Returns the GV associated with the C<COP> C<c>
466 =for apidoc CopFILEGV_set
467 Available only on unthreaded perls. Makes C<pv> the name of the file
468 associated with the C<COP> C<c>
470 =for apidoc Am|HV *|CopSTASH|const COP * c
471 Returns the stash associated with C<c>.
473 =for apidoc Am|bool|CopSTASH_eq|const COP * c|const HV * hv
474 Returns a boolean as to whether or not C<hv> is the stash associated with C<c>.
476 =for apidoc Am|bool|CopSTASH_set|COP * c|HV * hv
477 Set the stash associated with C<c> to C<hv>.
479 =for apidoc Am|char *|CopSTASHPV|const COP * c
480 Returns the package name of the stash associated with C<c>, or C<NULL> if no
483 =for apidoc Am|void|CopSTASHPV_set|COP * c|const char * pv
484 Set the package name of the stash associated with C<c>, to the NUL-terminated C
485 string C<p>, creating the package if necessary.
492 # define CopFILE(c) ((c)->cop_file)
493 # define CopFILEGV(c) (CopFILE(c) \
494 ? gv_fetchfile(CopFILE(c)) : NULL)
496 # define CopFILE_set(c,pv) ((c)->cop_file = savesharedpv(pv))
497 # define CopFILE_setn(c,pv,l) ((c)->cop_file = savesharedpvn((pv),(l)))
499 # define CopFILESV(c) (CopFILE(c) \
500 ? GvSV(gv_fetchfile(CopFILE(c))) : NULL)
501 # define CopFILEAV(c) (CopFILE(c) \
502 ? GvAV(gv_fetchfile(CopFILE(c))) : NULL)
503 # define CopFILEAVx(c) (assert_(CopFILE(c)) \
504 GvAV(gv_fetchfile(CopFILE(c))))
505 # define CopFILEAVn(c) (cop_file_avn(c))
506 # define CopSTASH(c) PL_stashpad[(c)->cop_stashoff]
507 # define CopSTASH_set(c,hv) ((c)->cop_stashoff = (hv) \
508 ? alloccopstash(hv) \
510 # define CopFILE_free(c) (PerlMemShared_free(CopFILE(c)),(CopFILE(c) = NULL))
512 #else /* Above: yes threads; Below no threads */
514 # define CopFILEGV(c) ((c)->cop_filegv)
515 # define CopFILEGV_set(c,gv) ((c)->cop_filegv = (GV*)SvREFCNT_inc(gv))
516 # define CopFILE_set(c,pv) CopFILEGV_set((c), gv_fetchfile(pv))
517 # define CopFILE_setn(c,pv,l) CopFILEGV_set((c), gv_fetchfile_flags((pv),(l),0))
518 # define CopFILESV(c) (CopFILEGV(c) ? GvSV(CopFILEGV(c)) : NULL)
519 # define CopFILEAV(c) (CopFILEGV(c) ? GvAV(CopFILEGV(c)) : NULL)
521 # define CopFILEAVx(c) (assert(CopFILEGV(c)), GvAV(CopFILEGV(c)))
523 # define CopFILEAVx(c) (GvAV(CopFILEGV(c)))
525 # define CopFILEAVn(c) (CopFILEGV(c) ? GvAVn(CopFILEGV(c)) : NULL)
526 # define CopFILE(c) (CopFILEGV(c) /* +2 for '_<' */ \
527 ? GvNAME(CopFILEGV(c))+2 : NULL)
528 # define CopSTASH(c) ((c)->cop_stash)
529 # define CopSTASH_set(c,hv) ((c)->cop_stash = (hv))
530 # define CopFILE_free(c) (SvREFCNT_dec(CopFILEGV(c)),(CopFILEGV(c) = NULL))
532 #endif /* USE_ITHREADS */
534 #define CopSTASHPV(c) (CopSTASH(c) ? HvNAME_get(CopSTASH(c)) : NULL)
535 /* cop_stash is not refcounted */
536 #define CopSTASHPV_set(c,pv) CopSTASH_set((c), gv_stashpv(pv,GV_ADD))
537 #define CopSTASH_eq(c,hv) (CopSTASH(c) == (hv))
539 #define CopHINTHASH_get(c) ((COPHH*)((c)->cop_hints_hash))
540 #define CopHINTHASH_set(c,h) ((c)->cop_hints_hash = (h))
543 =for apidoc Am|SV *|cop_hints_fetch_pv |const COP *cop|const char *key |U32 hash|U32 flags
544 =for apidoc_item|SV *|cop_hints_fetch_pvn|const COP *cop|const char *key|STRLEN keylen|U32 hash|U32 flags
545 =for apidoc_item|SV *|cop_hints_fetch_pvs|const COP *cop| "key" |U32 flags
546 =for apidoc_item|SV *|cop_hints_fetch_sv |const COP *cop| SV *key |U32 hash|U32 flags
548 These look up the hint entry in the cop C<cop> with the key specified by
549 C<key> (and C<keylen> in the C<pvn> form), returning that value as a mortal
550 scalar copy, or C<&PL_sv_placeholder> if there is no value associated with the
553 The forms differ in how the key is specified.
554 In the plain C<pv> form, the key is a C language NUL-terminated string.
555 In the C<pvs> form, the key is a C language string literal.
556 In the C<pvn> form, an additional parameter, C<keylen>, specifies the length of
557 the string, which hence, may contain embedded-NUL characters.
558 In the C<sv> form, C<*key> is an SV, and the key is the PV extracted from that.
559 using C<L</SvPV_const>>.
561 C<hash> is a precomputed hash of the key string, or zero if it has not been
562 precomputed. This parameter is omitted from the C<pvs> form, as it is computed
563 automatically at compile time.
565 The only flag currently used from the C<flags> parameter is C<COPHH_KEY_UTF8>.
566 It is illegal to set this in the C<sv> form. In the C<pv*> forms, it specifies
567 whether the key octets are interpreted as UTF-8 (if set) or as Latin-1 (if
568 cleared). The C<sv> form uses the underlying SV to determine the UTF-8ness of
574 #define cop_hints_fetch_pvn(cop, key, keylen, hash, flags) \
575 cophh_fetch_pvn(CopHINTHASH_get(cop), key, keylen, hash, flags)
577 #define cop_hints_fetch_pvs(cop, key, flags) \
578 cophh_fetch_pvs(CopHINTHASH_get(cop), key, flags)
580 #define cop_hints_fetch_pv(cop, key, hash, flags) \
581 cophh_fetch_pv(CopHINTHASH_get(cop), key, hash, flags)
583 #define cop_hints_fetch_sv(cop, key, hash, flags) \
584 cophh_fetch_sv(CopHINTHASH_get(cop), key, hash, flags)
587 =for apidoc Am|bool|cop_hints_exists_pv |const COP *cop|const char *key|U32 hash |U32 flags
588 =for apidoc_item|bool|cop_hints_exists_pvn|const COP *cop|const char *key|STRLEN keylen|U32 hash|U32 flags
589 =for apidoc_item|bool|cop_hints_exists_pvs|const COP *cop| "key" |U32 flags
590 =for apidoc_item|bool|cop_hints_exists_sv |const COP *cop| SV *key |U32 hash|U32 flags
592 These look up the hint entry in the cop C<cop> with the key specified by
593 C<key> (and C<keylen> in the C<pvn> form), returning true if a value exists,
596 The forms differ in how the key is specified. In all forms, the key is pointed
598 In the plain C<pv> form, the key is a C language NUL-terminated string.
599 In the C<pvs> form, the key is a C language string literal.
600 In the C<pvn> form, an additional parameter, C<keylen>, specifies the length of
601 the string, which hence, may contain embedded-NUL characters.
602 In the C<sv> form, C<*key> is an SV, and the key is the PV extracted from that.
603 using C<L</SvPV_const>>.
605 C<hash> is a precomputed hash of the key string, or zero if it has not been
606 precomputed. This parameter is omitted from the C<pvs> form, as it is computed
607 automatically at compile time.
609 The only flag currently used from the C<flags> parameter is C<COPHH_KEY_UTF8>.
610 It is illegal to set this in the C<sv> form. In the C<pv*> forms, it specifies
611 whether the key octets are interpreted as UTF-8 (if set) or as Latin-1 (if
612 cleared). The C<sv> form uses the underlying SV to determine the UTF-8ness of
618 #define cop_hints_exists_pvn(cop, key, keylen, hash, flags) \
619 cophh_exists_pvn(CopHINTHASH_get(cop), key, keylen, hash, flags)
621 #define cop_hints_exists_pvs(cop, key, flags) \
622 cophh_exists_pvs(CopHINTHASH_get(cop), key, flags)
624 #define cop_hints_exists_pv(cop, key, hash, flags) \
625 cophh_exists_pv(CopHINTHASH_get(cop), key, hash, flags)
627 #define cop_hints_exists_sv(cop, key, hash, flags) \
628 cophh_exists_sv(CopHINTHASH_get(cop), key, hash, flags)
631 =for apidoc Am|HV *|cop_hints_2hv|const COP *cop|U32 flags
633 Generates and returns a standard Perl hash representing the full set of
634 hint entries in the cop C<cop>. C<flags> is currently unused and must
640 #define cop_hints_2hv(cop, flags) \
641 cophh_2hv(CopHINTHASH_get(cop), flags)
644 =for apidoc Am|const char *|CopLABEL |COP *const cop
645 =for apidoc_item|const char *|CopLABEL_len |COP *const cop|STRLEN *len
646 =for apidoc_item|const char *|CopLABEL_len_flags|COP *const cop|STRLEN *len|U32 *flags
648 These return the label attached to a cop.
650 C<CopLABEL_len> and C<CopLABEL_len_flags> additionally store the number of
651 bytes comprising the returned label into C<*len>.
653 C<CopLABEL_len_flags> additionally returns the UTF-8ness of the returned label,
654 by setting C<*flags> to 0 or C<SVf_UTF8>.
659 #define CopLABEL(c) Perl_cop_fetch_label(aTHX_ (c), NULL, NULL)
660 #define CopLABEL_len(c,len) Perl_cop_fetch_label(aTHX_ (c), len, NULL)
661 #define CopLABEL_len_flags(c,len,flags) Perl_cop_fetch_label(aTHX_ (c), len, flags)
662 #define CopLABEL_alloc(pv) ((pv)?savepv(pv):NULL)
664 #define CopSTASH_ne(c,hv) (!CopSTASH_eq(c,hv))
665 #define CopLINE(c) ((c)->cop_line)
666 #define CopLINE_inc(c) (++CopLINE(c))
667 #define CopLINE_dec(c) (--CopLINE(c))
668 #define CopLINE_set(c,l) (CopLINE(c) = (l))
670 /* OutCopFILE() is CopFILE for output (caller, die, warn, etc.) */
671 #define OutCopFILE(c) CopFILE(c)
673 #define CopHINTS_get(c) ((c)->cop_hints + 0)
674 #define CopHINTS_set(c, h) STMT_START { \
675 (c)->cop_hints = (h); \
679 * Here we have some enormously heavy (or at least ponderous) wizardry.
682 /* subroutine context */
684 OP * retop; /* op to execute on exit from sub */
685 I32 old_cxsubix; /* previous value of si_cxsubix */
686 /* Above here is the same for sub, format and eval. */
687 PAD *prevcomppad; /* the caller's PL_comppad */
689 /* Above here is the same for sub and format. */
696 struct block_format {
697 OP * retop; /* op to execute on exit from sub */
698 I32 old_cxsubix; /* previous value of si_cxsubix */
699 /* Above here is the same for sub, format and eval. */
700 PAD *prevcomppad; /* the caller's PL_comppad */
702 /* Above here is the same for sub and format. */
707 /* return a pointer to the current context */
709 #define CX_CUR() (&cxstack[cxstack_ix])
711 /* free all savestack items back to the watermark of the specified context */
713 #define CX_LEAVE_SCOPE(cx) LEAVE_SCOPE(cx->blk_oldsaveix)
716 /* on debugging builds, poison cx afterwards so we know no code
717 * uses it - because after doing cxstack_ix--, any ties, exceptions etc
718 * may overwrite the current stack frame */
719 # define CX_POP(cx) \
720 assert(CX_CUR() == cx); \
724 # define CX_POP(cx) cxstack_ix--;
727 #define CX_PUSHSUB_GET_LVALUE_MASK(func) \
728 /* If the context is indeterminate, then only the lvalue */ \
729 /* flags that the caller also has are applicable. */ \
731 (PL_op->op_flags & OPf_WANT) \
732 ? OPpENTERSUB_LVAL_MASK \
733 : !(PL_op->op_private & OPpENTERSUB_LVAL_MASK) \
734 ? 0 : (U8)func(aTHX) \
738 #define CX_POP_SAVEARRAY(cx) \
740 AV *cx_pop_savearray_av = GvAV(PL_defgv); \
741 GvAV(PL_defgv) = cx->blk_sub.savearray; \
742 cx->blk_sub.savearray = NULL; \
743 SvREFCNT_dec(cx_pop_savearray_av); \
746 /* junk in @_ spells trouble when cloning CVs and in pp_caller(), so don't
747 * leave any (a fast av_clear(ary), basically) */
748 #define CLEAR_ARGARRAY(ary) \
750 AvMAX(ary) += AvARRAY(ary) - AvALLOC(ary); \
751 AvARRAY(ary) = AvALLOC(ary); \
758 OP * retop; /* op to execute on exit from eval */
759 I32 old_cxsubix; /* previous value of si_cxsubix */
760 /* Above here is the same for sub, format and eval. */
765 JMPENV * cur_top_env; /* value of PL_top_env when eval CX created */
768 /* If we ever need more than 512 op types, change the shift from 7.
769 blku_gimme is actually also only 2 bits, so could be merged with something.
772 /* blk_u16 bit usage for eval contexts: */
774 #define CxOLD_IN_EVAL(cx) (((cx)->blk_u16) & 0x3F) /* saved PL in_eval */
775 #define CxEVAL_TXT_REFCNTED(cx) (((cx)->blk_u16) & 0x40) /* cur_text rc++ */
776 #define CxOLD_OP_TYPE(cx) (((cx)->blk_u16) >> 7) /* type of eval op */
780 LOOP * my_op; /* My op, that contains redo, next and last ops. */
781 union { /* different ways of locating the iteration variable */
782 SV **svp; /* for lexicals: address of pad slot */
783 GV *gv; /* for package vars */
785 SV *itersave; /* the original iteration var */
787 struct { /* CXt_LOOP_ARY, C<for (@ary)> */
788 AV *ary; /* array being iterated over */
789 IV ix; /* index relative to base of array */
791 struct { /* CXt_LOOP_LIST, C<for (list)> */
792 I32 basesp; /* first element of list on stack */
793 IV ix; /* index relative to basesp */
795 struct { /* CXt_LOOP_LAZYIV, C<for (1..9)> */
799 struct { /* CXt_LOOP_LAZYSV C<for ('a'..'z')> */
801 SV * end; /* maxiumum value (or minimum in reverse) */
805 PAD *oldcomppad; /* needed to map itervar_u.svp during thread clone */
809 #define CxITERVAR(c) \
811 ? (c)->blk_loop.itervar_u.svp \
812 : ((c)->cx_type & CXp_FOR_GV) \
813 ? &GvSV((c)->blk_loop.itervar_u.gv) \
814 : (SV **)&(c)->blk_loop.itervar_u.gv)
816 #define CxLABEL(c) (CopLABEL((c)->blk_oldcop))
817 #define CxLABEL_len(c,len) (CopLABEL_len((c)->blk_oldcop, len))
818 #define CxLABEL_len_flags(c,len,flags) ((const char *)CopLABEL_len_flags((c)->blk_oldcop, len, flags))
819 #define CxHASARGS(c) (((c)->cx_type & CXp_HASARGS) == CXp_HASARGS)
821 /* CxLVAL(): the lval flags of the call site: the relevant flag bits from
822 * the op_private field of the calling pp_entersub (or its caller's caller
823 * if the caller's lvalue context isn't known):
824 * OPpLVAL_INTRO: sub used in lvalue context, e.g. f() = 1;
825 * OPpENTERSUB_INARGS (in conjunction with OPpLVAL_INTRO): the
826 * function is being used as a sub arg or as a referent, e.g.
827 * g(...,f(),...) or $r = \f()
828 * OPpDEREF: 2-bit mask indicating e.g. f()->[0].
829 * Note the contrast with CvLVALUE(), which is a property of the sub
830 * rather than the call site.
832 #define CxLVAL(c) (0 + ((U8)((c)->blk_u16)))
836 /* given/when context */
837 struct block_givwhen {
839 SV *defsv_save; /* the original $_ */
844 /* context common to subroutines, evals and loops */
846 U8 blku_type; /* what kind of context this is */
847 U8 blku_gimme; /* is this block running in list context? */
848 U16 blku_u16; /* used by block_sub and block_eval (so far) */
849 I32 blku_oldsaveix; /* saved PL_savestack_ix */
850 /* all the fields above must be aligned with same-sized fields as sbu */
851 I32 blku_oldsp; /* current sp floor: where nextstate pops to */
852 I32 blku_oldmarksp; /* mark stack index */
853 COP * blku_oldcop; /* old curcop pointer */
854 PMOP * blku_oldpm; /* values of pattern match vars */
855 SSize_t blku_old_tmpsfloor; /* saved PL_tmps_floor */
856 I32 blku_oldscopesp; /* scope stack index */
859 struct block_sub blku_sub;
860 struct block_format blku_format;
861 struct block_eval blku_eval;
862 struct block_loop blku_loop;
863 struct block_givwhen blku_givwhen;
866 #define blk_oldsp cx_u.cx_blk.blku_oldsp
867 #define blk_oldcop cx_u.cx_blk.blku_oldcop
868 #define blk_oldmarksp cx_u.cx_blk.blku_oldmarksp
869 #define blk_oldscopesp cx_u.cx_blk.blku_oldscopesp
870 #define blk_oldpm cx_u.cx_blk.blku_oldpm
871 #define blk_gimme cx_u.cx_blk.blku_gimme
872 #define blk_u16 cx_u.cx_blk.blku_u16
873 #define blk_oldsaveix cx_u.cx_blk.blku_oldsaveix
874 #define blk_old_tmpsfloor cx_u.cx_blk.blku_old_tmpsfloor
875 #define blk_sub cx_u.cx_blk.blk_u.blku_sub
876 #define blk_format cx_u.cx_blk.blk_u.blku_format
877 #define blk_eval cx_u.cx_blk.blk_u.blku_eval
878 #define blk_loop cx_u.cx_blk.blk_u.blku_loop
879 #define blk_givwhen cx_u.cx_blk.blk_u.blku_givwhen
881 #define CX_DEBUG(cx, action) \
883 Perl_deb(aTHX_ "CX %ld %s %s (scope %ld,%ld) (save %ld,%ld) at %s:%d\n",\
886 PL_block_type[CxTYPE(cx)], \
887 (long)PL_scopestack_ix, \
888 (long)(cx->blk_oldscopesp), \
889 (long)PL_savestack_ix, \
890 (long)(cx->blk_oldsaveix), \
891 __FILE__, __LINE__));
895 /* substitution context */
897 U8 sbu_type; /* same as blku_type */
900 I32 sbu_oldsaveix; /* same as blku_oldsaveix */
901 /* all the fields above must be aligned with same-sized fields as blk_u */
903 SSize_t sbu_maxiters;
916 #define sb_iters cx_u.cx_subst.sbu_iters
917 #define sb_maxiters cx_u.cx_subst.sbu_maxiters
918 #define sb_rflags cx_u.cx_subst.sbu_rflags
919 #define sb_rxtainted cx_u.cx_subst.sbu_rxtainted
920 #define sb_orig cx_u.cx_subst.sbu_orig
921 #define sb_dstr cx_u.cx_subst.sbu_dstr
922 #define sb_targ cx_u.cx_subst.sbu_targ
923 #define sb_s cx_u.cx_subst.sbu_s
924 #define sb_m cx_u.cx_subst.sbu_m
925 #define sb_strend cx_u.cx_subst.sbu_strend
926 #define sb_rxres cx_u.cx_subst.sbu_rxres
927 #define sb_rx cx_u.cx_subst.sbu_rx
929 # define CX_PUSHSUBST(cx) CXINC, cx = CX_CUR(), \
930 cx->blk_oldsaveix = oldsave, \
931 cx->sb_iters = iters, \
932 cx->sb_maxiters = maxiters, \
933 cx->sb_rflags = r_flags, \
934 cx->sb_rxtainted = rxtainted, \
935 cx->sb_orig = orig, \
936 cx->sb_dstr = dstr, \
937 cx->sb_targ = targ, \
940 cx->sb_strend = strend, \
941 cx->sb_rxres = NULL, \
943 cx->cx_type = CXt_SUBST | (once ? CXp_ONCE : 0); \
944 rxres_save(&cx->sb_rxres, rx); \
945 (void)ReREFCNT_inc(rx); \
946 SvREFCNT_inc_void_NN(targ)
948 # define CX_POPSUBST(cx) \
951 assert(CxTYPE(cx) == CXt_SUBST); \
952 rxres_free(&cx->sb_rxres); \
956 SvREFCNT_dec_NN(cx->sb_targ); \
960 #define CxONCE(cx) ((cx)->cx_type & CXp_ONCE)
965 struct subst cx_subst;
968 #define cx_type cx_u.cx_subst.sbu_type
970 /* If you re-order these, there is also an array of uppercase names in perl.h
971 and a static array of context names in pp_ctl.c */
972 #define CXTYPEMASK 0xf
973 #define CXt_NULL 0 /* currently only used for sort BLOCK */
976 /* When micro-optimising :-) keep GIVEN next to the LOOPs, as these 5 share a
977 jump table in pp_ctl.c
978 The first 4 don't have a 'case' in at least one switch statement in pp_ctl.c
982 /* be careful of the ordering of these five. Macros like CxTYPE_is_LOOP,
983 * CxFOREACH compare ranges */
984 #define CXt_LOOP_ARY 4 /* for (@ary) { ...; } */
985 #define CXt_LOOP_LAZYSV 5 /* for ('a'..'z') { ...; } */
986 #define CXt_LOOP_LAZYIV 6 /* for (1..9) { ...; } */
987 #define CXt_LOOP_LIST 7 /* for (1,2,3) { ...; } */
988 #define CXt_LOOP_PLAIN 8 /* while (...) { ...; }
989 or plain block { ...; } */
991 #define CXt_FORMAT 10
992 #define CXt_EVAL 11 /* eval'', eval{}, try{} */
995 /* SUBST doesn't feature in all switch statements. */
997 /* private flags for CXt_SUB and CXt_FORMAT */
998 #define CXp_MULTICALL 0x10 /* part of a multicall (so don't tear down
999 context on exit). (not CXt_FORMAT) */
1000 #define CXp_HASARGS 0x20
1001 #define CXp_SUB_RE 0x40 /* code called within regex, i.e. (?{}) */
1002 #define CXp_SUB_RE_FAKE 0x80 /* fake sub CX for (?{}) in current scope */
1004 /* private flags for CXt_EVAL */
1005 #define CXp_REAL 0x20 /* truly eval'', not a lookalike */
1006 #define CXp_EVALBLOCK 0x40 /* eval{}, not eval'' or similar */
1007 #define CXp_TRY 0x80 /* try {} block */
1009 /* private flags for CXt_LOOP */
1011 /* this is only set in conjunction with CXp_FOR_GV */
1012 #define CXp_FOR_DEF 0x10 /* foreach using $_ */
1013 /* these 3 are mutually exclusive */
1014 #define CXp_FOR_LVREF 0x20 /* foreach using \$var */
1015 #define CXp_FOR_GV 0x40 /* foreach using package var */
1016 #define CXp_FOR_PAD 0x80 /* foreach using lexical var */
1018 #define CxPADLOOP(c) ((c)->cx_type & CXp_FOR_PAD)
1020 /* private flags for CXt_SUBST */
1021 #define CXp_ONCE 0x10 /* What was sbu_once in struct subst */
1023 #define CxTYPE(c) ((c)->cx_type & CXTYPEMASK)
1024 #define CxTYPE_is_LOOP(c) ( CxTYPE(cx) >= CXt_LOOP_ARY \
1025 && CxTYPE(cx) <= CXt_LOOP_PLAIN)
1026 #define CxMULTICALL(c) ((c)->cx_type & CXp_MULTICALL)
1027 #define CxREALEVAL(c) (((c)->cx_type & (CXTYPEMASK|CXp_REAL)) \
1028 == (CXt_EVAL|CXp_REAL))
1029 #define CxEVALBLOCK(c) (((c)->cx_type & (CXTYPEMASK|CXp_EVALBLOCK)) \
1030 == (CXt_EVAL|CXp_EVALBLOCK))
1031 #define CxTRY(c) (((c)->cx_type & (CXTYPEMASK|CXp_TRY)) \
1032 == (CXt_EVAL|CXp_TRY))
1033 #define CxFOREACH(c) ( CxTYPE(cx) >= CXt_LOOP_ARY \
1034 && CxTYPE(cx) <= CXt_LOOP_LIST)
1036 /* private flags for CXt_DEFER */
1037 #define CXp_FINALLY 0x20 /* `finally` block; semantically identical
1038 * but matters for diagnostic messages */
1040 /* deprecated old name before real try/catch was added */
1041 #define CXp_TRYBLOCK CXp_EVALBLOCK
1042 #define CxTRYBLOCK(c) CxEVALBLOCK(c)
1044 #define CXINC (cxstack_ix < cxstack_max ? ++cxstack_ix : (cxstack_ix = cxinc()))
1052 /* name prior to 5.31.1 */
1053 # define G_ARRAY G_LIST
1056 /* extra flags for Perl_call_* routines */
1057 #define G_DISCARD 0x4 /* Call FREETMPS.
1058 Don't change this without consulting the
1059 hash actions codes defined in hv.h */
1060 #define G_EVAL 0x8 /* Assume eval {} around subroutine call. */
1061 #define G_NOARGS 0x10 /* Don't construct a @_ array. */
1062 #define G_KEEPERR 0x20 /* Warn for errors, don't overwrite $@ */
1063 #define G_NODEBUG 0x40 /* Disable debugging at toplevel. */
1064 #define G_METHOD 0x80 /* Calling method. */
1065 #define G_FAKINGEVAL 0x100 /* Faking an eval context for call_sv or
1067 #define G_UNDEF_FILL 0x200 /* Fill the stack with &PL_sv_undef
1068 A special case for UNSHIFT in
1069 Perl_magic_methcall(). */
1070 #define G_WRITING_TO_STDERR 0x400 /* Perl_write_to_stderr() is calling
1071 Perl_magic_methcall(). */
1072 #define G_RE_REPARSING 0x800 /* compiling a run-time /(?{..})/ */
1073 #define G_METHOD_NAMED 0x1000 /* calling named method, eg without :: or ' */
1074 #define G_RETHROW 0x2000 /* eval_sv(): re-throw any error */
1076 /* flag bits for PL_in_eval */
1077 #define EVAL_NULL 0 /* not in an eval */
1078 #define EVAL_INEVAL 1 /* some enclosing scope is an eval */
1079 #define EVAL_WARNONLY 2 /* used by yywarn() when calling yyerror() */
1080 #define EVAL_KEEPERR 4 /* set by Perl_call_sv if G_KEEPERR */
1081 #define EVAL_INREQUIRE 8 /* The code is being required. */
1082 #define EVAL_RE_REPARSING 0x10 /* eval_sv() called with G_RE_REPARSING */
1083 /* if adding extra bits, make sure they can fit in CxOLD_OP_TYPE() */
1085 /* Support for switching (stack and block) contexts.
1086 * This ensures magic doesn't invalidate local stack and cx pointers.
1087 * Which one to use (or add) is mostly, but not completely arbitrary: See
1088 * http://nntp.perl.org/group/perl.perl5.porters/257169
1091 #define PERLSI_UNKNOWN -1
1092 #define PERLSI_UNDEF 0
1093 #define PERLSI_MAIN 1
1094 #define PERLSI_MAGIC 2
1095 #define PERLSI_SORT 3
1096 #define PERLSI_SIGNAL 4
1097 #define PERLSI_OVERLOAD 5
1098 #define PERLSI_DESTROY 6
1099 #define PERLSI_WARNHOOK 7
1100 #define PERLSI_DIEHOOK 8
1101 #define PERLSI_REQUIRE 9
1102 #define PERLSI_MULTICALL 10
1103 #define PERLSI_REGCOMP 11
1106 AV * si_stack; /* stack for current runlevel */
1107 PERL_CONTEXT * si_cxstack; /* context stack for runlevel */
1108 struct stackinfo * si_prev;
1109 struct stackinfo * si_next;
1110 I32 si_cxix; /* current context index */
1111 I32 si_cxmax; /* maximum allocated index */
1112 I32 si_cxsubix; /* topmost sub/eval/format */
1113 I32 si_type; /* type of runlevel */
1114 I32 si_markoff; /* offset where markstack begins for us.
1115 * currently used only with DEBUGGING,
1116 * but not #ifdef-ed for bincompat */
1117 #if defined DEBUGGING && !defined DEBUGGING_RE_ONLY
1118 /* high water mark: for checking if the stack was correctly extended /
1119 * tested for extension by each pp function */
1120 SSize_t si_stack_hwm;
1126 =for apidoc Ay||PERL_SI
1127 Use this typedef to declare variables that are to hold C<struct stackinfo>.
1131 typedef struct stackinfo PERL_SI;
1133 #define cxstack (PL_curstackinfo->si_cxstack)
1134 #define cxstack_ix (PL_curstackinfo->si_cxix)
1135 #define cxstack_max (PL_curstackinfo->si_cxmax)
1138 # define SET_MARK_OFFSET \
1139 PL_curstackinfo->si_markoff = PL_markstack_ptr - PL_markstack
1141 # define SET_MARK_OFFSET NOOP
1144 #if defined DEBUGGING && !defined DEBUGGING_RE_ONLY
1145 # define PUSHSTACK_INIT_HWM(si) ((si)->si_stack_hwm = 0)
1147 # define PUSHSTACK_INIT_HWM(si) NOOP
1150 #define PUSHSTACKi(type) \
1152 PERL_SI *next = PL_curstackinfo->si_next; \
1154 int i = 0; PERL_SI *p = PL_curstackinfo; \
1155 while (p) { i++; p = p->si_prev; } \
1156 Perl_deb(aTHX_ "push STACKINFO %d at %s:%d\n", \
1157 i, __FILE__, __LINE__);}) \
1159 next = new_stackinfo(32, 2048/sizeof(PERL_CONTEXT) - 1); \
1160 next->si_prev = PL_curstackinfo; \
1161 PL_curstackinfo->si_next = next; \
1163 next->si_type = type; \
1164 next->si_cxix = -1; \
1165 next->si_cxsubix = -1; \
1166 PUSHSTACK_INIT_HWM(next); \
1167 AvFILLp(next->si_stack) = 0; \
1168 SWITCHSTACK(PL_curstack,next->si_stack); \
1169 PL_curstackinfo = next; \
1173 #define PUSHSTACK PUSHSTACKi(PERLSI_UNKNOWN)
1175 /* POPSTACK works with PL_stack_sp, so it may need to be bracketed by
1176 * PUTBACK/SPAGAIN to flush/refresh any local SP that may be active */
1180 PERL_SI * const prev = PL_curstackinfo->si_prev; \
1182 int i = -1; PERL_SI *p = PL_curstackinfo; \
1183 while (p) { i++; p = p->si_prev; } \
1184 Perl_deb(aTHX_ "pop STACKINFO %d at %s:%d\n", \
1185 i, __FILE__, __LINE__);}) \
1187 Perl_croak_popstack(); \
1189 SWITCHSTACK(PL_curstack,prev->si_stack); \
1190 /* don't free prev here, free them all at the END{} */ \
1191 PL_curstackinfo = prev; \
1194 #define POPSTACK_TO(s) \
1196 while (PL_curstack != s) { \
1203 =for apidoc_section $utility
1204 =for apidoc Amn|bool|IN_PERL_COMPILETIME
1205 Returns 1 if this macro is being called during the compilation phase of the
1206 program; otherwise 0;
1208 =for apidoc Amn|bool|IN_PERL_RUNTIME
1209 Returns 1 if this macro is being called during the execution phase of the
1210 program; otherwise 0;
1214 #define IN_PERL_COMPILETIME cBOOL(PL_curcop == &PL_compiling)
1215 #define IN_PERL_RUNTIME cBOOL(PL_curcop != &PL_compiling)
1218 =for apidoc_section $multicall
1220 =for apidoc Amn;||dMULTICALL
1221 Declare local variables for a multicall. See L<perlcall/LIGHTWEIGHT CALLBACKS>.
1223 =for apidoc Am;||PUSH_MULTICALL|CV* the_cv
1224 Opening bracket for a lightweight callback.
1225 See L<perlcall/LIGHTWEIGHT CALLBACKS>.
1227 =for apidoc Amn;||MULTICALL
1228 Make a lightweight callback. See L<perlcall/LIGHTWEIGHT CALLBACKS>.
1230 =for apidoc Amn;||POP_MULTICALL
1231 Closing bracket for a lightweight callback.
1232 See L<perlcall/LIGHTWEIGHT CALLBACKS>.
1237 #define dMULTICALL \
1238 OP *multicall_cop; \
1239 bool multicall_oldcatch
1241 #define PUSH_MULTICALL(the_cv) \
1242 PUSH_MULTICALL_FLAGS(the_cv, 0)
1244 /* Like PUSH_MULTICALL, but allows you to specify extra flags
1245 * for the CX stack entry (this isn't part of the public API) */
1247 #define PUSH_MULTICALL_FLAGS(the_cv, flags) \
1250 CV * const _nOnclAshIngNamE_ = the_cv; \
1251 CV * const cv = _nOnclAshIngNamE_; \
1252 PADLIST * const padlist = CvPADLIST(cv); \
1253 multicall_oldcatch = CATCH_GET; \
1255 PUSHSTACKi(PERLSI_MULTICALL); \
1256 cx = cx_pushblock((CXt_SUB|CXp_MULTICALL|flags), (U8)gimme, \
1257 PL_stack_sp, PL_savestack_ix); \
1258 cx_pushsub(cx, cv, NULL, 0); \
1260 if (!(flags & CXp_SUB_RE_FAKE)) \
1262 if (CvDEPTH(cv) >= 2) \
1263 Perl_pad_push(aTHX_ padlist, CvDEPTH(cv)); \
1264 PAD_SET_CUR_NOSAVE(padlist, CvDEPTH(cv)); \
1265 multicall_cop = CvSTART(cv); \
1270 PL_op = multicall_cop; \
1274 #define POP_MULTICALL \
1278 CX_LEAVE_SCOPE(cx); \
1279 cx_popsub_common(cx); \
1280 gimme = cx->blk_gimme; \
1281 PERL_UNUSED_VAR(gimme); /* for API */ \
1285 CATCH_SET(multicall_oldcatch); \
1289 /* Change the CV of an already-pushed MULTICALL CxSUB block.
1290 * (this isn't part of the public API) */
1292 #define CHANGE_MULTICALL_FLAGS(the_cv, flags) \
1294 CV * const _nOnclAshIngNamE_ = the_cv; \
1295 CV * const cv = _nOnclAshIngNamE_; \
1296 PADLIST * const padlist = CvPADLIST(cv); \
1297 PERL_CONTEXT *cx = CX_CUR(); \
1298 assert(CxMULTICALL(cx)); \
1299 cx_popsub_common(cx); \
1300 cx->cx_type = (CXt_SUB|CXp_MULTICALL|flags); \
1301 cx_pushsub(cx, cv, NULL, 0); \
1302 if (!(flags & CXp_SUB_RE_FAKE)) \
1304 if (CvDEPTH(cv) >= 2) \
1305 Perl_pad_push(aTHX_ padlist, CvDEPTH(cv)); \
1306 PAD_SET_CUR_NOSAVE(padlist, CvDEPTH(cv)); \
1307 multicall_cop = CvSTART(cv); \
1310 * ex: set ts=8 sts=4 sw=4 et: