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