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