This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
update the links to freenode
[perl5.git] / cop.h
1 /*    cop.h
2  *
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
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  *
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.
14  */
15
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
19  * non-null.
20  *
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).
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
32 struct jmpenv {
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;   /* need to call longjmp()? */
37     U16                 je_old_delaymagic; /* saved PL_delaymagic */
38     SSize_t             je_old_stack_hwm;
39 };
40
41 typedef struct jmpenv JMPENV;
42
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
50 #else
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
54 #endif
55
56 /*
57  * How to build the first jmpenv.
58  *
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 {}!
64  */
65
66 #define JMPENV_BOOTSTRAP \
67     STMT_START {                                \
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;                  \
75     } STMT_END
76
77 /*
78  *   PERL_FLEXIBLE_EXCEPTIONS
79  *
80  * All the flexible exceptions code has been removed.
81  * See the following threads for details:
82  *
83  *   Message-Id: 20040713143217.GB1424@plum.flirble.org
84  *   https://www.nntp.perl.org/group/perl.perl5.porters/2004/07/msg93041.html
85  *
86  * Joshua's original patches (which weren't applied) and discussion:
87  *
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
94  *
95  * Chip's reworked patch and discussion:
96  *
97  *   http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1999-03/msg00520.html
98  *
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().
103  *
104  * The original patches that introduces flexible exceptions were:
105  *
106  * https://github.com/Perl/perl5/commit/312caa8e97f1c7ee342a9895c2f0e749625b4929
107  * https://github.com/Perl/perl5/commit/14dd3ad8c9bf82cf09798a22cc89a9862dfd6d1a
108  *
109  */
110
111 #define dJMPENV         JMPENV cur_env
112
113 #define JMPENV_PUSH(v) \
114     STMT_START {                                                        \
115         DEBUG_l({                                                       \
116             int i = 0; JMPENV *p = PL_top_env;                          \
117             while (p) { i++; p = p->je_prev; }                          \
118             Perl_deb(aTHX_ "JUMPENV_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;                                           \
128     } STMT_END
129
130 #define JMPENV_POP \
131     STMT_START {                                                        \
132         DEBUG_l({                                                       \
133             int i = -1; JMPENV *p = PL_top_env;                         \
134             while (p) { i++; p = p->je_prev; }                          \
135             Perl_deb(aTHX_ "JUMPENV_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;                                   \
140     } STMT_END
141
142 #define JMPENV_JUMP(v) \
143     STMT_START {                                                \
144         DEBUG_l({                                               \
145             int i = -1; JMPENV *p = PL_top_env;                 \
146             while (p) { i++; p = p->je_prev; }                  \
147             Perl_deb(aTHX_ "JUMPENV_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));          \
151         if ((v) == 2)                                           \
152             PerlProc_exit(STATUS_EXIT);                         \
153         PerlIO_printf(PerlIO_stderr(), "panic: top_env, v=%d\n", (int)v); \
154         PerlProc_exit(1);                                       \
155     } STMT_END
156
157 #define CATCH_GET               (PL_top_env->je_mustcatch)
158 #define CATCH_SET(v) \
159     STMT_START {                                                        \
160         DEBUG_l(                                                        \
161             Perl_deb(aTHX_                                              \
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);                                 \
166     } STMT_END
167
168 /*
169 =for apidoc_section $COP
170 */
171
172 typedef struct refcounted_he COPHH;
173
174 #define COPHH_KEY_UTF8 REFCOUNTED_HE_KEY_UTF8
175
176 /*
177 =for apidoc Amx|SV *|cophh_fetch_pvn|const COPHH *cophh|const char *keypv|STRLEN keylen|U32 hash|U32 flags
178
179 Look up the entry in the cop hints hash C<cophh> with the key specified by
180 C<keypv> and C<keylen>.  If C<flags> has the C<COPHH_KEY_UTF8> bit set,
181 the key octets are interpreted as UTF-8, otherwise they are interpreted
182 as Latin-1.  C<hash> is a precomputed hash of the key string, or zero if
183 it has not been precomputed.  Returns a mortal scalar copy of the value
184 associated with the key, or C<&PL_sv_placeholder> if there is no value
185 associated with the key.
186
187 =for apidoc Amnh||COPHH_KEY_UTF8
188
189 =cut
190 */
191
192 #define cophh_fetch_pvn(cophh, keypv, keylen, hash, flags) \
193     Perl_refcounted_he_fetch_pvn(aTHX_ cophh, keypv, keylen, hash, flags)
194
195 /*
196 =for apidoc Amx|SV *|cophh_fetch_pvs|const COPHH *cophh|"key"|U32 flags
197
198 Like L</cophh_fetch_pvn>, but takes a literal string instead
199 of a string/length pair, and no precomputed hash.
200
201 =cut
202 */
203
204 #define cophh_fetch_pvs(cophh, key, flags) \
205     Perl_refcounted_he_fetch_pvn(aTHX_ cophh, STR_WITH_LEN(key), 0, flags)
206
207 /*
208 =for apidoc Amx|SV *|cophh_fetch_pv|const COPHH *cophh|const char *key|U32 hash|U32 flags
209
210 Like L</cophh_fetch_pvn>, but takes a nul-terminated string instead of
211 a string/length pair.
212
213 =cut
214 */
215
216 #define cophh_fetch_pv(cophh, key, hash, flags) \
217     Perl_refcounted_he_fetch_pv(aTHX_ cophh, key, hash, flags)
218
219 /*
220 =for apidoc Amx|SV *|cophh_fetch_sv|const COPHH *cophh|SV *key|U32 hash|U32 flags
221
222 Like L</cophh_fetch_pvn>, but takes a Perl scalar instead of a
223 string/length pair.
224
225 =cut
226 */
227
228 #define cophh_fetch_sv(cophh, key, hash, flags) \
229     Perl_refcounted_he_fetch_sv(aTHX_ cophh, key, hash, flags)
230
231 /*
232 =for apidoc Amx|HV *|cophh_2hv|const COPHH *cophh|U32 flags
233
234 Generates and returns a standard Perl hash representing the full set of
235 key/value pairs in the cop hints hash C<cophh>.  C<flags> is currently
236 unused and must be zero.
237
238 =cut
239 */
240
241 #define cophh_2hv(cophh, flags) \
242     Perl_refcounted_he_chain_2hv(aTHX_ cophh, flags)
243
244 /*
245 =for apidoc Amx|COPHH *|cophh_copy|COPHH *cophh
246
247 Make and return a complete copy of the cop hints hash C<cophh>.
248
249 =cut
250 */
251
252 #define cophh_copy(cophh) Perl_refcounted_he_inc(aTHX_ cophh)
253
254 /*
255 =for apidoc Amx|void|cophh_free|COPHH *cophh
256
257 Discard the cop hints hash C<cophh>, freeing all resources associated
258 with it.
259
260 =cut
261 */
262
263 #define cophh_free(cophh) Perl_refcounted_he_free(aTHX_ cophh)
264
265 /*
266 =for apidoc Amx|COPHH *|cophh_new_empty
267
268 Generate and return a fresh cop hints hash containing no entries.
269
270 =cut
271 */
272
273 #define cophh_new_empty() ((COPHH *)NULL)
274
275 /*
276 =for apidoc Amx|COPHH *|cophh_store_pvn|COPHH *cophh|const char *keypv|STRLEN keylen|U32 hash|SV *value|U32 flags
277
278 Stores a value, associated with a key, in the cop hints hash C<cophh>,
279 and returns the modified hash.  The returned hash pointer is in general
280 not the same as the hash pointer that was passed in.  The input hash is
281 consumed by the function, and the pointer to it must not be subsequently
282 used.  Use L</cophh_copy> if you need both hashes.
283
284 The key is specified by C<keypv> and C<keylen>.  If C<flags> has the
285 C<COPHH_KEY_UTF8> bit set, the key octets are interpreted as UTF-8,
286 otherwise they are interpreted as Latin-1.  C<hash> is a precomputed
287 hash of the key string, or zero if it has not been precomputed.
288
289 C<value> is the scalar value to store for this key.  C<value> is copied
290 by this function, which thus does not take ownership of any reference
291 to it, and later changes to the scalar will not be reflected in the
292 value visible in the cop hints hash.  Complex types of scalar will not
293 be stored with referential integrity, but will be coerced to strings.
294
295 =cut
296 */
297
298 #define cophh_store_pvn(cophh, keypv, keylen, hash, value, flags) \
299     Perl_refcounted_he_new_pvn(aTHX_ cophh, keypv, keylen, hash, value, flags)
300
301 /*
302 =for apidoc Amx|COPHH *|cophh_store_pvs|COPHH *cophh|"key"|SV *value|U32 flags
303
304 Like L</cophh_store_pvn>, but takes a literal string instead
305 of a string/length pair, and no precomputed hash.
306
307 =cut
308 */
309
310 #define cophh_store_pvs(cophh, key, value, flags) \
311     Perl_refcounted_he_new_pvn(aTHX_ cophh, STR_WITH_LEN(key), 0, value, flags)
312
313 /*
314 =for apidoc Amx|COPHH *|cophh_store_pv|COPHH *cophh|const char *key|U32 hash|SV *value|U32 flags
315
316 Like L</cophh_store_pvn>, but takes a nul-terminated string instead of
317 a string/length pair.
318
319 =cut
320 */
321
322 #define cophh_store_pv(cophh, key, hash, value, flags) \
323     Perl_refcounted_he_new_pv(aTHX_ cophh, key, hash, value, flags)
324
325 /*
326 =for apidoc Amx|COPHH *|cophh_store_sv|COPHH *cophh|SV *key|U32 hash|SV *value|U32 flags
327
328 Like L</cophh_store_pvn>, but takes a Perl scalar instead of a
329 string/length pair.
330
331 =cut
332 */
333
334 #define cophh_store_sv(cophh, key, hash, value, flags) \
335     Perl_refcounted_he_new_sv(aTHX_ cophh, key, hash, value, flags)
336
337 /*
338 =for apidoc Amx|COPHH *|cophh_delete_pvn|COPHH *cophh|const char *keypv|STRLEN keylen|U32 hash|U32 flags
339
340 Delete a key and its associated value from the cop hints hash C<cophh>,
341 and returns the modified hash.  The returned hash pointer is in general
342 not the same as the hash pointer that was passed in.  The input hash is
343 consumed by the function, and the pointer to it must not be subsequently
344 used.  Use L</cophh_copy> if you need both hashes.
345
346 The key is specified by C<keypv> and C<keylen>.  If C<flags> has the
347 C<COPHH_KEY_UTF8> bit set, the key octets are interpreted as UTF-8,
348 otherwise they are interpreted as Latin-1.  C<hash> is a precomputed
349 hash of the key string, or zero if it has not been precomputed.
350
351 =cut
352 */
353
354 #define cophh_delete_pvn(cophh, keypv, keylen, hash, flags) \
355     Perl_refcounted_he_new_pvn(aTHX_ cophh, keypv, keylen, hash, \
356         (SV *)NULL, flags)
357
358 /*
359 =for apidoc Amx|COPHH *|cophh_delete_pvs|COPHH *cophh|"key"|U32 flags
360
361 Like L</cophh_delete_pvn>, but takes a literal string instead
362 of a string/length pair, and no precomputed hash.
363
364 =cut
365 */
366
367 #define cophh_delete_pvs(cophh, key, flags) \
368     Perl_refcounted_he_new_pvn(aTHX_ cophh, STR_WITH_LEN(key), 0, \
369         (SV *)NULL, flags)
370
371 /*
372 =for apidoc Amx|COPHH *|cophh_delete_pv|COPHH *cophh|char *key|U32 hash|U32 flags
373
374 Like L</cophh_delete_pvn>, but takes a nul-terminated string instead of
375 a string/length pair.
376
377 =cut
378 */
379
380 #define cophh_delete_pv(cophh, key, hash, flags) \
381     Perl_refcounted_he_new_pv(aTHX_ cophh, key, hash, (SV *)NULL, flags)
382
383 /*
384 =for apidoc Amx|COPHH *|cophh_delete_sv|COPHH *cophh|SV *key|U32 hash|U32 flags
385
386 Like L</cophh_delete_pvn>, but takes a Perl scalar instead of a
387 string/length pair.
388
389 =cut
390 */
391
392 #define cophh_delete_sv(cophh, key, hash, flags) \
393     Perl_refcounted_he_new_sv(aTHX_ cophh, key, hash, (SV *)NULL, flags)
394
395 #include "mydtrace.h"
396
397 struct cop {
398     BASEOP
399     /* On LP64 putting this here takes advantage of the fact that BASEOP isn't
400        an exact multiple of 8 bytes to save structure padding.  */
401     line_t      cop_line;       /* line # of this command */
402     /* label for this construct is now stored in cop_hints_hash */
403 #ifdef USE_ITHREADS
404     PADOFFSET   cop_stashoff;   /* offset into PL_stashpad, for the
405                                    package the line was compiled in */
406     char *      cop_file;       /* name of file this command is from */
407 #else
408     HV *        cop_stash;      /* package line was compiled in */
409     GV *        cop_filegv;     /* name of GV file this command is from */
410 #endif
411     U32         cop_hints;      /* hints bits from pragmata */
412     U32         cop_seq;        /* parse sequence number */
413     /* Beware. mg.c and warnings.pl assume the type of this is STRLEN *:  */
414     STRLEN *    cop_warnings;   /* lexical warnings bitmask */
415     /* compile time state of %^H.  See the comment in op.c for how this is
416        used to recreate a hash to return from caller.  */
417     COPHH *     cop_hints_hash;
418     /* for now just a bitmask stored here.
419        If we get sufficient features this may become a pointer.
420        How these flags are stored is subject to change without
421        notice.  Use the macros to test for features.
422     */
423     U32         cop_features;
424 };
425
426 /*
427 =for apidoc Am|const char *|CopFILE|const COP * c
428 Returns the name of the file associated with the C<COP> C<c>
429
430 =for apidoc Am|STRLEN|CopLINE|const COP * c
431 Returns the line number in the source code associated with the C<COP> C<c>
432
433 =for apidoc Am|AV *|CopFILEAV|const COP * c
434 Returns the AV associated with the C<COP> C<c>
435
436 =for apidoc Am|SV *|CopFILESV|const COP * c
437 Returns the SV associated with the C<COP> C<c>
438
439 =for apidoc Am|void|CopFILE_set|COP * c|const char * pv
440 Makes C<pv> the name of the file associated with the C<COP> C<c>
441
442 =for apidoc Am|GV *|CopFILEGV|const COP * c
443 Returns the GV associated with the C<COP> C<c>
444
445 =for apidoc CopFILEGV_set
446 Available only on unthreaded perls.  Makes C<pv> the name of the file
447 associated with the C<COP> C<c>
448
449 =for apidoc Am|HV *|CopSTASH|const COP * c
450 Returns the stash associated with C<c>.
451
452 =for apidoc Am|bool|CopSTASH_eq|const COP * c|const HV * hv
453 Returns a boolean as to whether or not C<hv> is the stash associated with C<c>.
454
455 =for apidoc Am|bool|CopSTASH_set|COP * c|HV * hv
456 Set the stash associated with C<c> to C<hv>.
457
458 =for apidoc Am|char *|CopSTASHPV|const COP * c
459 Returns the package name of the stash associated with C<c>, or C<NULL> if no
460 associated stash
461
462 =for apidoc Am|void|CopSTASHPV_set|COP * c|const char * pv
463 Set the package name of the stash associated with C<c>, to the NUL-terminated C
464 string C<p>, creating the package if necessary.
465
466 =cut
467 */
468
469 #ifdef USE_ITHREADS
470 #  define CopFILE(c)            ((c)->cop_file)
471 #  define CopFILEGV(c)          (CopFILE(c) \
472                                  ? gv_fetchfile(CopFILE(c)) : NULL)
473
474 #  ifdef NETWARE
475 #    define CopFILE_set(c,pv)   ((c)->cop_file = savepv(pv))
476 #    define CopFILE_setn(c,pv,l)  ((c)->cop_file = savepvn((pv),(l)))
477 #  else
478 #    define CopFILE_set(c,pv)   ((c)->cop_file = savesharedpv(pv))
479 #    define CopFILE_setn(c,pv,l)  ((c)->cop_file = savesharedpvn((pv),(l)))
480 #  endif
481
482 #  define CopFILESV(c)          (CopFILE(c) \
483                                  ? GvSV(gv_fetchfile(CopFILE(c))) : NULL)
484 #  define CopFILEAV(c)          (CopFILE(c) \
485                                  ? GvAV(gv_fetchfile(CopFILE(c))) : NULL)
486 #  define CopFILEAVx(c)         (assert_(CopFILE(c)) \
487                                    GvAV(gv_fetchfile(CopFILE(c))))
488
489 #  define CopSTASH(c)           PL_stashpad[(c)->cop_stashoff]
490 #  define CopSTASH_set(c,hv)    ((c)->cop_stashoff = (hv)               \
491                                     ? alloccopstash(hv)                 \
492                                     : 0)
493 #  ifdef NETWARE
494 #    define CopFILE_free(c) SAVECOPFILE_FREE(c)
495 #  else
496 #    define CopFILE_free(c)     (PerlMemShared_free(CopFILE(c)),(CopFILE(c) = NULL))
497 #  endif
498 #else /* Above: no threads; Below yes threads */
499 #  define CopFILEGV(c)          ((c)->cop_filegv)
500 #  define CopFILEGV_set(c,gv)   ((c)->cop_filegv = (GV*)SvREFCNT_inc(gv))
501 #  define CopFILE_set(c,pv)     CopFILEGV_set((c), gv_fetchfile(pv))
502 #  define CopFILE_setn(c,pv,l)  CopFILEGV_set((c), gv_fetchfile_flags((pv),(l),0))
503 #  define CopFILESV(c)          (CopFILEGV(c) ? GvSV(CopFILEGV(c)) : NULL)
504 #  define CopFILEAV(c)          (CopFILEGV(c) ? GvAV(CopFILEGV(c)) : NULL)
505 #  ifdef DEBUGGING
506 #    define CopFILEAVx(c)       (assert(CopFILEGV(c)), GvAV(CopFILEGV(c)))
507 #  else
508 #    define CopFILEAVx(c)       (GvAV(CopFILEGV(c)))
509 # endif
510 #  define CopFILE(c)            (CopFILEGV(c) /* +2 for '_<' */         \
511                                     ? GvNAME(CopFILEGV(c))+2 : NULL)
512 #  define CopSTASH(c)           ((c)->cop_stash)
513 #  define CopSTASH_set(c,hv)    ((c)->cop_stash = (hv))
514 #  define CopFILE_free(c)       (SvREFCNT_dec(CopFILEGV(c)),(CopFILEGV(c) = NULL))
515
516 #endif /* USE_ITHREADS */
517
518 #define CopSTASHPV(c)           (CopSTASH(c) ? HvNAME_get(CopSTASH(c)) : NULL)
519    /* cop_stash is not refcounted */
520 #define CopSTASHPV_set(c,pv)    CopSTASH_set((c), gv_stashpv(pv,GV_ADD))
521 #define CopSTASH_eq(c,hv)       (CopSTASH(c) == (hv))
522
523 #define CopHINTHASH_get(c)      ((COPHH*)((c)->cop_hints_hash))
524 #define CopHINTHASH_set(c,h)    ((c)->cop_hints_hash = (h))
525
526 /*
527 =for apidoc Am|SV *|cop_hints_fetch_pvn|const COP *cop|const char *keypv|STRLEN keylen|U32 hash|U32 flags
528
529 Look up the hint entry in the cop C<cop> with the key specified by
530 C<keypv> and C<keylen>.  If C<flags> has the C<COPHH_KEY_UTF8> bit set,
531 the key octets are interpreted as UTF-8, otherwise they are interpreted
532 as Latin-1.  C<hash> is a precomputed hash of the key string, or zero if
533 it has not been precomputed.  Returns a mortal scalar copy of the value
534 associated with the key, or C<&PL_sv_placeholder> if there is no value
535 associated with the key.
536
537 =cut
538 */
539
540 #define cop_hints_fetch_pvn(cop, keypv, keylen, hash, flags) \
541     cophh_fetch_pvn(CopHINTHASH_get(cop), keypv, keylen, hash, flags)
542
543 /*
544 =for apidoc Am|SV *|cop_hints_fetch_pvs|const COP *cop|"key"|U32 flags
545
546 Like L</cop_hints_fetch_pvn>, but takes a literal string
547 instead of a string/length pair, and no precomputed hash.
548
549 =cut
550 */
551
552 #define cop_hints_fetch_pvs(cop, key, flags) \
553     cophh_fetch_pvs(CopHINTHASH_get(cop), key, flags)
554
555 /*
556 =for apidoc Am|SV *|cop_hints_fetch_pv|const COP *cop|const char *key|U32 hash|U32 flags
557
558 Like L</cop_hints_fetch_pvn>, but takes a nul-terminated string instead
559 of a string/length pair.
560
561 =cut
562 */
563
564 #define cop_hints_fetch_pv(cop, key, hash, flags) \
565     cophh_fetch_pv(CopHINTHASH_get(cop), key, hash, flags)
566
567 /*
568 =for apidoc Am|SV *|cop_hints_fetch_sv|const COP *cop|SV *key|U32 hash|U32 flags
569
570 Like L</cop_hints_fetch_pvn>, but takes a Perl scalar instead of a
571 string/length pair.
572
573 =cut
574 */
575
576 #define cop_hints_fetch_sv(cop, key, hash, flags) \
577     cophh_fetch_sv(CopHINTHASH_get(cop), key, hash, flags)
578
579 /*
580 =for apidoc Am|HV *|cop_hints_2hv|const COP *cop|U32 flags
581
582 Generates and returns a standard Perl hash representing the full set of
583 hint entries in the cop C<cop>.  C<flags> is currently unused and must
584 be zero.
585
586 =cut
587 */
588
589 #define cop_hints_2hv(cop, flags) \
590     cophh_2hv(CopHINTHASH_get(cop), flags)
591
592 /*
593 =for apidoc Am|const char *|CopLABEL|COP *const cop
594
595 Returns the label attached to a cop.
596
597 =for apidoc Am|const char *|CopLABEL_len|COP *const cop|STRLEN *len
598
599 Returns the label attached to a cop, and stores its length in bytes into
600 C<*len>.
601
602 =for apidoc Am|const char *|CopLABEL_len_flags|COP *const cop|STRLEN *len|U32 *flags
603
604 Returns the label attached to a cop, and stores its length in bytes into
605 C<*len>.  Upon return, C<*flags> will be set to either C<SVf_UTF8> or 0.
606
607 =cut
608 */
609
610 #define CopLABEL(c)  Perl_cop_fetch_label(aTHX_ (c), NULL, NULL)
611 #define CopLABEL_len(c,len)  Perl_cop_fetch_label(aTHX_ (c), len, NULL)
612 #define CopLABEL_len_flags(c,len,flags)  Perl_cop_fetch_label(aTHX_ (c), len, flags)
613 #define CopLABEL_alloc(pv)      ((pv)?savepv(pv):NULL)
614
615 #define CopSTASH_ne(c,hv)       (!CopSTASH_eq(c,hv))
616 #define CopLINE(c)              ((c)->cop_line)
617 #define CopLINE_inc(c)          (++CopLINE(c))
618 #define CopLINE_dec(c)          (--CopLINE(c))
619 #define CopLINE_set(c,l)        (CopLINE(c) = (l))
620
621 /* OutCopFILE() is CopFILE for output (caller, die, warn, etc.) */
622 #define OutCopFILE(c) CopFILE(c)
623
624 #define CopHINTS_get(c)         ((c)->cop_hints + 0)
625 #define CopHINTS_set(c, h)      STMT_START {                            \
626                                     (c)->cop_hints = (h);               \
627                                 } STMT_END
628
629 /*
630  * Here we have some enormously heavy (or at least ponderous) wizardry.
631  */
632
633 /* subroutine context */
634 struct block_sub {
635     OP *        retop;  /* op to execute on exit from sub */
636     I32         old_cxsubix;  /* previous value of si_cxsubix */
637     /* Above here is the same for sub, format and eval.  */
638     PAD         *prevcomppad; /* the caller's PL_comppad */
639     CV *        cv;
640     /* Above here is the same for sub and format.  */
641     I32         olddepth;
642     AV          *savearray;
643 };
644
645
646 /* format context */
647 struct block_format {
648     OP *        retop;  /* op to execute on exit from sub */
649     I32         old_cxsubix;  /* previous value of si_cxsubix */
650     /* Above here is the same for sub, format and eval.  */
651     PAD         *prevcomppad; /* the caller's PL_comppad */
652     CV *        cv;
653     /* Above here is the same for sub and format.  */
654     GV *        gv;
655     GV *        dfoutgv;
656 };
657
658 /* return a pointer to the current context */
659
660 #define CX_CUR() (&cxstack[cxstack_ix])
661
662 /* free all savestack items back to the watermark of the specified context */
663
664 #define CX_LEAVE_SCOPE(cx) LEAVE_SCOPE(cx->blk_oldsaveix)
665
666 #ifdef DEBUGGING
667 /* on debugging builds, poison cx afterwards so we know no code
668  * uses it - because after doing cxstack_ix--, any ties, exceptions etc
669  * may overwrite the current stack frame */
670 #  define CX_POP(cx)                                                   \
671         assert(CX_CUR() == cx);                                        \
672         cxstack_ix--;                                                  \
673         cx = NULL;
674 #else
675 #  define CX_POP(cx) cxstack_ix--;
676 #endif
677
678 #define CX_PUSHSUB_GET_LVALUE_MASK(func) \
679         /* If the context is indeterminate, then only the lvalue */     \
680         /* flags that the caller also has are applicable.        */     \
681         (                                                               \
682            (PL_op->op_flags & OPf_WANT)                                 \
683                ? OPpENTERSUB_LVAL_MASK                                  \
684                : !(PL_op->op_private & OPpENTERSUB_LVAL_MASK)           \
685                    ? 0 : (U8)func(aTHX)                                 \
686         )
687
688 /* Restore old @_ */
689 #define CX_POP_SAVEARRAY(cx)                                            \
690     STMT_START {                                                        \
691         AV *cx_pop_savearray_av = GvAV(PL_defgv);                       \
692         GvAV(PL_defgv) = cx->blk_sub.savearray;                         \
693         cx->blk_sub.savearray = NULL;                                   \
694         SvREFCNT_dec(cx_pop_savearray_av);                              \
695     } STMT_END
696
697 /* junk in @_ spells trouble when cloning CVs and in pp_caller(), so don't
698  * leave any (a fast av_clear(ary), basically) */
699 #define CLEAR_ARGARRAY(ary) \
700     STMT_START {                                                        \
701         AvMAX(ary) += AvARRAY(ary) - AvALLOC(ary);                      \
702         AvARRAY(ary) = AvALLOC(ary);                                    \
703         AvFILLp(ary) = -1;                                              \
704     } STMT_END
705
706
707 /* eval context */
708 struct block_eval {
709     OP *        retop;  /* op to execute on exit from eval */
710     I32         old_cxsubix;  /* previous value of si_cxsubix */
711     /* Above here is the same for sub, format and eval.  */
712     SV *        old_namesv;
713     OP *        old_eval_root;
714     SV *        cur_text;
715     CV *        cv;
716     JMPENV *    cur_top_env; /* value of PL_top_env when eval CX created */
717 };
718
719 /* If we ever need more than 512 op types, change the shift from 7.
720    blku_gimme is actually also only 2 bits, so could be merged with something.
721 */
722
723 /* blk_u16 bit usage for eval contexts: */
724
725 #define CxOLD_IN_EVAL(cx)       (((cx)->blk_u16) & 0x3F) /* saved PL in_eval */
726 #define CxEVAL_TXT_REFCNTED(cx) (((cx)->blk_u16) & 0x40) /* cur_text rc++ */
727 #define CxOLD_OP_TYPE(cx)       (((cx)->blk_u16) >> 7)   /* type of eval op */
728
729 /* loop context */
730 struct block_loop {
731     LOOP *      my_op;  /* My op, that contains redo, next and last ops.  */
732     union {     /* different ways of locating the iteration variable */
733         SV      **svp; /* for lexicals: address of pad slot */
734         GV      *gv;   /* for package vars */
735     } itervar_u;
736     SV          *itersave; /* the original iteration var */
737     union {
738         struct { /* CXt_LOOP_ARY, C<for (@ary)>  */
739             AV *ary; /* array being iterated over */
740             IV  ix;   /* index relative to base of array */
741         } ary;
742         struct { /* CXt_LOOP_LIST, C<for (list)> */
743             I32 basesp; /* first element of list on stack */
744             IV  ix;      /* index relative to basesp */
745         } stack;
746         struct { /* CXt_LOOP_LAZYIV, C<for (1..9)> */
747             IV cur;
748             IV end;
749         } lazyiv;
750         struct { /* CXt_LOOP_LAZYSV C<for ('a'..'z')> */
751             SV * cur;
752             SV * end; /* maxiumum value (or minimum in reverse) */
753         } lazysv;
754     } state_u;
755 #ifdef USE_ITHREADS
756     PAD *oldcomppad; /* needed to map itervar_u.svp during thread clone */
757 #endif
758 };
759
760 #define CxITERVAR(c)                                    \
761         (CxPADLOOP(c)                                   \
762             ? (c)->blk_loop.itervar_u.svp               \
763             : ((c)->cx_type & CXp_FOR_GV)               \
764                 ? &GvSV((c)->blk_loop.itervar_u.gv)     \
765                 : (SV **)&(c)->blk_loop.itervar_u.gv)
766
767 #define CxLABEL(c)      (0 + CopLABEL((c)->blk_oldcop))
768 #define CxLABEL_len(c,len)      (0 + CopLABEL_len((c)->blk_oldcop, len))
769 #define CxLABEL_len_flags(c,len,flags)  (0 + CopLABEL_len_flags((c)->blk_oldcop, len, flags))
770 #define CxHASARGS(c)    (((c)->cx_type & CXp_HASARGS) == CXp_HASARGS)
771
772 /* CxLVAL(): the lval flags of the call site: the relevant flag bits from
773  * the op_private field of the calling pp_entersub (or its caller's caller
774  * if the caller's lvalue context isn't known):
775  *  OPpLVAL_INTRO:  sub used in lvalue context, e.g. f() = 1;
776  *  OPpENTERSUB_INARGS (in conjunction with OPpLVAL_INTRO): the
777  *      function is being used as a sub arg or as a referent, e.g.
778  *      g(...,f(),...)  or $r = \f()
779  *  OPpDEREF: 2-bit mask indicating e.g. f()->[0].
780  *  Note the contrast with CvLVALUE(), which is a property of the sub
781  *  rather than the call site.
782  */
783 #define CxLVAL(c)       (0 + ((c)->blk_u16 & 0xff))
784
785
786
787 /* given/when context */
788 struct block_givwhen {
789         OP *leave_op;
790         SV *defsv_save; /* the original $_ */
791 };
792
793
794
795 /* context common to subroutines, evals and loops */
796 struct block {
797     U8          blku_type;      /* what kind of context this is */
798     U8          blku_gimme;     /* is this block running in list context? */
799     U16         blku_u16;       /* used by block_sub and block_eval (so far) */
800     I32         blku_oldsaveix; /* saved PL_savestack_ix */
801     /* all the fields above must be aligned with same-sized fields as sbu */
802     I32         blku_oldsp;     /* current sp floor: where nextstate pops to */
803     I32         blku_oldmarksp; /* mark stack index */
804     COP *       blku_oldcop;    /* old curcop pointer */
805     PMOP *      blku_oldpm;     /* values of pattern match vars */
806     SSize_t     blku_old_tmpsfloor;     /* saved PL_tmps_floor */
807     I32         blku_oldscopesp;        /* scope stack index */
808
809     union {
810         struct block_sub        blku_sub;
811         struct block_format     blku_format;
812         struct block_eval       blku_eval;
813         struct block_loop       blku_loop;
814         struct block_givwhen    blku_givwhen;
815     } blk_u;
816 };
817 #define blk_oldsp       cx_u.cx_blk.blku_oldsp
818 #define blk_oldcop      cx_u.cx_blk.blku_oldcop
819 #define blk_oldmarksp   cx_u.cx_blk.blku_oldmarksp
820 #define blk_oldscopesp  cx_u.cx_blk.blku_oldscopesp
821 #define blk_oldpm       cx_u.cx_blk.blku_oldpm
822 #define blk_gimme       cx_u.cx_blk.blku_gimme
823 #define blk_u16         cx_u.cx_blk.blku_u16
824 #define blk_oldsaveix   cx_u.cx_blk.blku_oldsaveix
825 #define blk_old_tmpsfloor cx_u.cx_blk.blku_old_tmpsfloor
826 #define blk_sub         cx_u.cx_blk.blk_u.blku_sub
827 #define blk_format      cx_u.cx_blk.blk_u.blku_format
828 #define blk_eval        cx_u.cx_blk.blk_u.blku_eval
829 #define blk_loop        cx_u.cx_blk.blk_u.blku_loop
830 #define blk_givwhen     cx_u.cx_blk.blk_u.blku_givwhen
831
832 #define CX_DEBUG(cx, action)                                            \
833     DEBUG_l(                                                            \
834         Perl_deb(aTHX_ "CX %ld %s %s (scope %ld,%ld) (save %ld,%ld) at %s:%d\n",\
835                     (long)cxstack_ix,                                   \
836                     action,                                             \
837                     PL_block_type[CxTYPE(cx)],                          \
838                     (long)PL_scopestack_ix,                             \
839                     (long)(cx->blk_oldscopesp),                         \
840                     (long)PL_savestack_ix,                              \
841                     (long)(cx->blk_oldsaveix),                          \
842                     __FILE__, __LINE__));
843
844
845
846 /* substitution context */
847 struct subst {
848     U8          sbu_type;       /* same as blku_type */
849     U8          sbu_rflags;
850     U16         sbu_rxtainted;
851     I32         sbu_oldsaveix; /* same as blku_oldsaveix */
852     /* all the fields above must be aligned with same-sized fields as blk_u */
853     SSize_t     sbu_iters;
854     SSize_t     sbu_maxiters;
855     char *      sbu_orig;
856     SV *        sbu_dstr;
857     SV *        sbu_targ;
858     char *      sbu_s;
859     char *      sbu_m;
860     char *      sbu_strend;
861     void *      sbu_rxres;
862     REGEXP *    sbu_rx;
863 };
864
865 #ifdef PERL_CORE
866
867 #define sb_iters        cx_u.cx_subst.sbu_iters
868 #define sb_maxiters     cx_u.cx_subst.sbu_maxiters
869 #define sb_rflags       cx_u.cx_subst.sbu_rflags
870 #define sb_rxtainted    cx_u.cx_subst.sbu_rxtainted
871 #define sb_orig         cx_u.cx_subst.sbu_orig
872 #define sb_dstr         cx_u.cx_subst.sbu_dstr
873 #define sb_targ         cx_u.cx_subst.sbu_targ
874 #define sb_s            cx_u.cx_subst.sbu_s
875 #define sb_m            cx_u.cx_subst.sbu_m
876 #define sb_strend       cx_u.cx_subst.sbu_strend
877 #define sb_rxres        cx_u.cx_subst.sbu_rxres
878 #define sb_rx           cx_u.cx_subst.sbu_rx
879
880 #  define CX_PUSHSUBST(cx) CXINC, cx = CX_CUR(),                        \
881         cx->blk_oldsaveix = oldsave,                                    \
882         cx->sb_iters            = iters,                                \
883         cx->sb_maxiters         = maxiters,                             \
884         cx->sb_rflags           = r_flags,                              \
885         cx->sb_rxtainted        = rxtainted,                            \
886         cx->sb_orig             = orig,                                 \
887         cx->sb_dstr             = dstr,                                 \
888         cx->sb_targ             = targ,                                 \
889         cx->sb_s                = s,                                    \
890         cx->sb_m                = m,                                    \
891         cx->sb_strend           = strend,                               \
892         cx->sb_rxres            = NULL,                                 \
893         cx->sb_rx               = rx,                                   \
894         cx->cx_type             = CXt_SUBST | (once ? CXp_ONCE : 0);    \
895         rxres_save(&cx->sb_rxres, rx);                                  \
896         (void)ReREFCNT_inc(rx);                                         \
897         SvREFCNT_inc_void_NN(targ)
898
899 #  define CX_POPSUBST(cx) \
900     STMT_START {                                                        \
901         REGEXP *re;                                                     \
902         assert(CxTYPE(cx) == CXt_SUBST);                                \
903         rxres_free(&cx->sb_rxres);                                      \
904         re = cx->sb_rx;                                                 \
905         cx->sb_rx = NULL;                                               \
906         ReREFCNT_dec(re);                                               \
907         SvREFCNT_dec_NN(cx->sb_targ);                                   \
908     } STMT_END
909 #endif
910
911 #define CxONCE(cx)              ((cx)->cx_type & CXp_ONCE)
912
913 struct context {
914     union {
915         struct block    cx_blk;
916         struct subst    cx_subst;
917     } cx_u;
918 };
919 #define cx_type cx_u.cx_subst.sbu_type
920
921 /* If you re-order these, there is also an array of uppercase names in perl.h
922    and a static array of context names in pp_ctl.c  */
923 #define CXTYPEMASK      0xf
924 #define CXt_NULL        0 /* currently only used for sort BLOCK */
925 #define CXt_WHEN        1
926 #define CXt_BLOCK       2
927 /* When micro-optimising :-) keep GIVEN next to the LOOPs, as these 5 share a
928    jump table in pp_ctl.c
929    The first 4 don't have a 'case' in at least one switch statement in pp_ctl.c
930 */
931 #define CXt_GIVEN       3
932
933 /* be careful of the ordering of these five. Macros like CxTYPE_is_LOOP,
934  * CxFOREACH compare ranges */
935 #define CXt_LOOP_ARY    4 /* for (@ary)     { ...; } */
936 #define CXt_LOOP_LAZYSV 5 /* for ('a'..'z') { ...; } */
937 #define CXt_LOOP_LAZYIV 6 /* for (1..9)     { ...; } */
938 #define CXt_LOOP_LIST   7 /* for (1,2,3)    { ...; } */
939 #define CXt_LOOP_PLAIN  8 /* while (...)    { ...; }
940                              or plain block { ...; } */
941 #define CXt_SUB         9
942 #define CXt_FORMAT     10
943 #define CXt_EVAL       11
944 #define CXt_SUBST      12
945 /* SUBST doesn't feature in all switch statements.  */
946
947 /* private flags for CXt_SUB and CXt_FORMAT */
948 #define CXp_MULTICALL   0x10    /* part of a multicall (so don't tear down
949                                    context on exit). (not CXt_FORMAT) */
950 #define CXp_HASARGS     0x20
951 #define CXp_SUB_RE      0x40    /* code called within regex, i.e. (?{}) */
952 #define CXp_SUB_RE_FAKE 0x80    /* fake sub CX for (?{}) in current scope */
953
954 /* private flags for CXt_EVAL */
955 #define CXp_REAL        0x20    /* truly eval'', not a lookalike */
956 #define CXp_TRYBLOCK    0x40    /* eval{}, not eval'' or similar */
957
958 /* private flags for CXt_LOOP */
959
960 /* this is only set in conjunction with CXp_FOR_GV */
961 #define CXp_FOR_DEF     0x10    /* foreach using $_ */
962 /* these 3 are mutually exclusive */
963 #define CXp_FOR_LVREF   0x20    /* foreach using \$var */
964 #define CXp_FOR_GV      0x40    /* foreach using package var */
965 #define CXp_FOR_PAD     0x80    /* foreach using lexical var */
966
967 #define CxPADLOOP(c)    ((c)->cx_type & CXp_FOR_PAD)
968
969 /* private flags for CXt_SUBST */
970 #define CXp_ONCE        0x10    /* What was sbu_once in struct subst */
971
972 #define CxTYPE(c)       ((c)->cx_type & CXTYPEMASK)
973 #define CxTYPE_is_LOOP(c) (   CxTYPE(cx) >= CXt_LOOP_ARY                \
974                            && CxTYPE(cx) <= CXt_LOOP_PLAIN)
975 #define CxMULTICALL(c)  ((c)->cx_type & CXp_MULTICALL)
976 #define CxREALEVAL(c)   (((c)->cx_type & (CXTYPEMASK|CXp_REAL))         \
977                          == (CXt_EVAL|CXp_REAL))
978 #define CxTRYBLOCK(c)   (((c)->cx_type & (CXTYPEMASK|CXp_TRYBLOCK))     \
979                          == (CXt_EVAL|CXp_TRYBLOCK))
980 #define CxFOREACH(c)    (   CxTYPE(cx) >= CXt_LOOP_ARY                  \
981                          && CxTYPE(cx) <= CXt_LOOP_LIST)
982
983 #define CXINC (cxstack_ix < cxstack_max ? ++cxstack_ix : (cxstack_ix = cxinc()))
984
985 #define G_SCALAR        2
986 #define G_ARRAY         3
987 #define G_VOID          1
988 #define G_WANT          3
989
990 /* extra flags for Perl_call_* routines */
991 #define G_DISCARD         0x4   /* Call FREETMPS.
992                                    Don't change this without consulting the
993                                    hash actions codes defined in hv.h */
994 #define G_EVAL            0x8   /* Assume eval {} around subroutine call. */
995 #define G_NOARGS         0x10   /* Don't construct a @_ array. */
996 #define G_KEEPERR        0x20   /* Warn for errors, don't overwrite $@ */
997 #define G_NODEBUG        0x40   /* Disable debugging at toplevel.  */
998 #define G_METHOD         0x80   /* Calling method. */
999 #define G_FAKINGEVAL    0x100   /* Faking an eval context for call_sv or
1000                                    fold_constants. */
1001 #define G_UNDEF_FILL    0x200   /* Fill the stack with &PL_sv_undef
1002                                    A special case for UNSHIFT in
1003                                    Perl_magic_methcall().  */
1004 #define G_WRITING_TO_STDERR 0x400 /* Perl_write_to_stderr() is calling
1005                                     Perl_magic_methcall().  */
1006 #define G_RE_REPARSING  0x800   /* compiling a run-time /(?{..})/ */
1007 #define G_METHOD_NAMED 0x1000   /* calling named method, eg without :: or ' */
1008 #define G_RETHROW      0x2000   /* eval_sv(): re-throw any error */
1009
1010 /* flag bits for PL_in_eval */
1011 #define EVAL_NULL       0       /* not in an eval */
1012 #define EVAL_INEVAL     1       /* some enclosing scope is an eval */
1013 #define EVAL_WARNONLY   2       /* used by yywarn() when calling yyerror() */
1014 #define EVAL_KEEPERR    4       /* set by Perl_call_sv if G_KEEPERR */
1015 #define EVAL_INREQUIRE  8       /* The code is being required. */
1016 #define EVAL_RE_REPARSING 0x10  /* eval_sv() called with G_RE_REPARSING */
1017 /* if adding extra bits, make sure they can fit in CxOLD_OP_TYPE() */
1018
1019 /* Support for switching (stack and block) contexts.
1020  * This ensures magic doesn't invalidate local stack and cx pointers.
1021  * Which one to use (or add) is mostly, but not completely arbitrary:  See
1022  * http://nntp.perl.org/group/perl.perl5.porters/257169
1023  */
1024
1025 #define PERLSI_UNKNOWN          -1
1026 #define PERLSI_UNDEF            0
1027 #define PERLSI_MAIN             1
1028 #define PERLSI_MAGIC            2
1029 #define PERLSI_SORT             3
1030 #define PERLSI_SIGNAL           4
1031 #define PERLSI_OVERLOAD         5
1032 #define PERLSI_DESTROY          6
1033 #define PERLSI_WARNHOOK         7
1034 #define PERLSI_DIEHOOK          8
1035 #define PERLSI_REQUIRE          9
1036 #define PERLSI_MULTICALL       10
1037 #define PERLSI_REGCOMP         11
1038
1039 struct stackinfo {
1040     AV *                si_stack;       /* stack for current runlevel */
1041     PERL_CONTEXT *      si_cxstack;     /* context stack for runlevel */
1042     struct stackinfo *  si_prev;
1043     struct stackinfo *  si_next;
1044     I32                 si_cxix;        /* current context index */
1045     I32                 si_cxmax;       /* maximum allocated index */
1046     I32                 si_cxsubix;     /* topmost sub/eval/format */
1047     I32                 si_type;        /* type of runlevel */
1048     I32                 si_markoff;     /* offset where markstack begins for us.
1049                                          * currently used only with DEBUGGING,
1050                                          * but not #ifdef-ed for bincompat */
1051 #if defined DEBUGGING && !defined DEBUGGING_RE_ONLY
1052 /* high water mark: for checking if the stack was correctly extended /
1053  * tested for extension by each pp function */
1054     SSize_t             si_stack_hwm;
1055 #endif
1056
1057 };
1058
1059 /*
1060 =for apidoc Ay||PERL_SI
1061 Use this typedef to declare variables that are to hold C<struct stackinfo>.
1062
1063 =cut
1064 */
1065 typedef struct stackinfo PERL_SI;
1066
1067 #define cxstack         (PL_curstackinfo->si_cxstack)
1068 #define cxstack_ix      (PL_curstackinfo->si_cxix)
1069 #define cxstack_max     (PL_curstackinfo->si_cxmax)
1070
1071 #ifdef DEBUGGING
1072 #  define       SET_MARK_OFFSET \
1073     PL_curstackinfo->si_markoff = PL_markstack_ptr - PL_markstack
1074 #else
1075 #  define       SET_MARK_OFFSET NOOP
1076 #endif
1077
1078 #if defined DEBUGGING && !defined DEBUGGING_RE_ONLY
1079 #  define PUSHSTACK_INIT_HWM(si) ((si)->si_stack_hwm = 0)
1080 #else
1081 #  define PUSHSTACK_INIT_HWM(si) NOOP
1082 #endif
1083
1084 #define PUSHSTACKi(type) \
1085     STMT_START {                                                        \
1086         PERL_SI *next = PL_curstackinfo->si_next;                       \
1087         DEBUG_l({                                                       \
1088             int i = 0; PERL_SI *p = PL_curstackinfo;                    \
1089             while (p) { i++; p = p->si_prev; }                          \
1090             Perl_deb(aTHX_ "push STACKINFO %d at %s:%d\n",              \
1091                          i, __FILE__, __LINE__);})                      \
1092         if (!next) {                                                    \
1093             next = new_stackinfo(32, 2048/sizeof(PERL_CONTEXT) - 1);    \
1094             next->si_prev = PL_curstackinfo;                            \
1095             PL_curstackinfo->si_next = next;                            \
1096         }                                                               \
1097         next->si_type = type;                                           \
1098         next->si_cxix = -1;                                             \
1099         next->si_cxsubix = -1;                                          \
1100         PUSHSTACK_INIT_HWM(next);                                       \
1101         AvFILLp(next->si_stack) = 0;                                    \
1102         SWITCHSTACK(PL_curstack,next->si_stack);                        \
1103         PL_curstackinfo = next;                                         \
1104         SET_MARK_OFFSET;                                                \
1105     } STMT_END
1106
1107 #define PUSHSTACK PUSHSTACKi(PERLSI_UNKNOWN)
1108
1109 /* POPSTACK works with PL_stack_sp, so it may need to be bracketed by
1110  * PUTBACK/SPAGAIN to flush/refresh any local SP that may be active */
1111 #define POPSTACK \
1112     STMT_START {                                                        \
1113         dSP;                                                            \
1114         PERL_SI * const prev = PL_curstackinfo->si_prev;                \
1115         DEBUG_l({                                                       \
1116             int i = -1; PERL_SI *p = PL_curstackinfo;                   \
1117             while (p) { i++; p = p->si_prev; }                          \
1118             Perl_deb(aTHX_ "pop  STACKINFO %d at %s:%d\n",              \
1119                          i, __FILE__, __LINE__);})                      \
1120         if (!prev) {                                                    \
1121             Perl_croak_popstack();                                      \
1122         }                                                               \
1123         SWITCHSTACK(PL_curstack,prev->si_stack);                        \
1124         /* don't free prev here, free them all at the END{} */          \
1125         PL_curstackinfo = prev;                                         \
1126     } STMT_END
1127
1128 #define POPSTACK_TO(s) \
1129     STMT_START {                                                        \
1130         while (PL_curstack != s) {                                      \
1131             dounwind(-1);                                               \
1132             POPSTACK;                                                   \
1133         }                                                               \
1134     } STMT_END
1135
1136 /*
1137 =for apidoc_section $utility
1138 =for apidoc Amn|bool|IN_PERL_COMPILETIME
1139 Returns 1 if this macro is being called during the compilation phase of the
1140 program; otherwise 0;
1141
1142 =for apidoc Amn|bool|IN_PERL_RUNTIME
1143 Returns 1 if this macro is being called during the execution phase of the
1144 program; otherwise 0;
1145
1146 =cut
1147 */
1148 #define IN_PERL_COMPILETIME     cBOOL(PL_curcop == &PL_compiling)
1149 #define IN_PERL_RUNTIME         cBOOL(PL_curcop != &PL_compiling)
1150
1151 /*
1152 =for apidoc_section $multicall
1153
1154 =for apidoc Amns||dMULTICALL
1155 Declare local variables for a multicall.  See L<perlcall/LIGHTWEIGHT CALLBACKS>.
1156
1157 =for apidoc Ams||PUSH_MULTICALL|CV* the_cv
1158 Opening bracket for a lightweight callback.
1159 See L<perlcall/LIGHTWEIGHT CALLBACKS>.
1160
1161 =for apidoc Amns||MULTICALL
1162 Make a lightweight callback.  See L<perlcall/LIGHTWEIGHT CALLBACKS>.
1163
1164 =for apidoc Amns||POP_MULTICALL
1165 Closing bracket for a lightweight callback.
1166 See L<perlcall/LIGHTWEIGHT CALLBACKS>.
1167
1168 =cut
1169 */
1170
1171 #define dMULTICALL \
1172     OP  *multicall_cop;                                                 \
1173     bool multicall_oldcatch
1174
1175 #define PUSH_MULTICALL(the_cv) \
1176     PUSH_MULTICALL_FLAGS(the_cv, 0)
1177
1178 /* Like PUSH_MULTICALL, but allows you to specify extra flags
1179  * for the CX stack entry (this isn't part of the public API) */
1180
1181 #define PUSH_MULTICALL_FLAGS(the_cv, flags) \
1182     STMT_START {                                                        \
1183         PERL_CONTEXT *cx;                                               \
1184         CV * const _nOnclAshIngNamE_ = the_cv;                          \
1185         CV * const cv = _nOnclAshIngNamE_;                              \
1186         PADLIST * const padlist = CvPADLIST(cv);                        \
1187         multicall_oldcatch = CATCH_GET;                                 \
1188         CATCH_SET(TRUE);                                                \
1189         PUSHSTACKi(PERLSI_MULTICALL);                                   \
1190         cx = cx_pushblock((CXt_SUB|CXp_MULTICALL|flags), (U8)gimme,     \
1191                   PL_stack_sp, PL_savestack_ix);                        \
1192         cx_pushsub(cx, cv, NULL, 0);                                    \
1193         SAVEOP();                                                       \
1194         if (!(flags & CXp_SUB_RE_FAKE))                                 \
1195             CvDEPTH(cv)++;                                              \
1196         if (CvDEPTH(cv) >= 2)                                           \
1197             Perl_pad_push(aTHX_ padlist, CvDEPTH(cv));                  \
1198         PAD_SET_CUR_NOSAVE(padlist, CvDEPTH(cv));                       \
1199         multicall_cop = CvSTART(cv);                                    \
1200     } STMT_END
1201
1202 #define MULTICALL \
1203     STMT_START {                                                        \
1204         PL_op = multicall_cop;                                          \
1205         CALLRUNOPS(aTHX);                                               \
1206     } STMT_END
1207
1208 #define POP_MULTICALL \
1209     STMT_START {                                                        \
1210         PERL_CONTEXT *cx;                                               \
1211         cx = CX_CUR();                                                  \
1212         CX_LEAVE_SCOPE(cx);                                             \
1213         cx_popsub_common(cx);                                           \
1214         gimme = cx->blk_gimme;                                          \
1215         PERL_UNUSED_VAR(gimme); /* for API */                           \
1216         cx_popblock(cx);                                                \
1217         CX_POP(cx);                                                     \
1218         POPSTACK;                                                       \
1219         CATCH_SET(multicall_oldcatch);                                  \
1220         SPAGAIN;                                                        \
1221     } STMT_END
1222
1223 /* Change the CV of an already-pushed MULTICALL CxSUB block.
1224  * (this isn't part of the public API) */
1225
1226 #define CHANGE_MULTICALL_FLAGS(the_cv, flags) \
1227     STMT_START {                                                        \
1228         CV * const _nOnclAshIngNamE_ = the_cv;                          \
1229         CV * const cv = _nOnclAshIngNamE_;                              \
1230         PADLIST * const padlist = CvPADLIST(cv);                        \
1231         PERL_CONTEXT *cx = CX_CUR();                                    \
1232         assert(CxMULTICALL(cx));                                        \
1233         cx_popsub_common(cx);                                           \
1234         cx->cx_type = (CXt_SUB|CXp_MULTICALL|flags);                    \
1235         cx_pushsub(cx, cv, NULL, 0);                                    \
1236         if (!(flags & CXp_SUB_RE_FAKE))                                 \
1237             CvDEPTH(cv)++;                                              \
1238         if (CvDEPTH(cv) >= 2)                                           \
1239             Perl_pad_push(aTHX_ padlist, CvDEPTH(cv));                  \
1240         PAD_SET_CUR_NOSAVE(padlist, CvDEPTH(cv));                       \
1241         multicall_cop = CvSTART(cv);                                    \
1242     } STMT_END
1243 /*
1244  * ex: set ts=8 sts=4 sw=4 et:
1245  */