dfb4a0045e358f743543d38a3fe4eeb0f70fb05e
[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 *av = GvAV(PL_defgv);                                        \
613         GvAV(PL_defgv) = cx->blk_sub.savearray;                         \
614         cx->blk_sub.savearray = NULL;                                   \
615         SvREFCNT_dec(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 #define CxOLD_IN_EVAL(cx)       (((cx)->blk_u16) & 0x7F)
644 #define CxOLD_OP_TYPE(cx)       (((cx)->blk_u16) >> 7)
645
646 /* loop context */
647 struct block_loop {
648     LOOP *      my_op;  /* My op, that contains redo, next and last ops.  */
649     union {     /* different ways of locating the iteration variable */
650         SV      **svp; /* for lexicals: address of pad slot */
651         GV      *gv;   /* for package vars */
652     } itervar_u;
653     SV          *itersave; /* the original iteration var */
654     union {
655         struct { /* CXt_LOOP_ARY, C<for (@ary)>  */
656             AV *ary; /* array being iterated over */
657             IV  ix;   /* index relative to base of array */
658         } ary;
659         struct { /* CXt_LOOP_LIST, C<for (list)> */
660             I32 basesp; /* first element of list on stack */
661             IV  ix;      /* index relative to basesp */
662         } stack;
663         struct { /* CXt_LOOP_LAZYIV, C<for (1..9)> */
664             IV cur;
665             IV end;
666         } lazyiv;
667         struct { /* CXt_LOOP_LAZYSV C<for ('a'..'z')> */
668             SV * cur;
669             SV * end; /* maxiumum value (or minimum in reverse) */
670         } lazysv;
671     } state_u;
672 #ifdef USE_ITHREADS
673     PAD *oldcomppad; /* needed to map itervar_u.svp during thread clone */
674 #endif
675 };
676
677 #define CxITERVAR(c)                                    \
678         (CxPADLOOP(c)                                   \
679             ? (c)->blk_loop.itervar_u.svp               \
680             : ((c)->cx_type & CXp_FOR_GV)               \
681                 ? &GvSV((c)->blk_loop.itervar_u.gv)     \
682                 : (SV **)&(c)->blk_loop.itervar_u.gv)
683
684 #define CxLABEL(c)      (0 + CopLABEL((c)->blk_oldcop))
685 #define CxLABEL_len(c,len)      (0 + CopLABEL_len((c)->blk_oldcop, len))
686 #define CxLABEL_len_flags(c,len,flags)  (0 + CopLABEL_len_flags((c)->blk_oldcop, len, flags))
687 #define CxHASARGS(c)    (((c)->cx_type & CXp_HASARGS) == CXp_HASARGS)
688
689 /* CxLVAL(): the lval flags of the call site: the relevant flag bits from
690  * the op_private field of the calling pp_entersub (or its caller's caller
691  * if the caller's lvalue context isn't known):
692  *  OPpLVAL_INTRO:  sub used in lvalue context, e.g. f() = 1;
693  *  OPpENTERSUB_INARGS (in conjunction with OPpLVAL_INTRO): the
694  *      function is being used as a sub arg or as a referent, e.g.
695  *      g(...,f(),...)  or $r = \f()
696  *  OPpDEREF: 2-bit mask indicating e.g. f()->[0].
697  *  Note the contrast with CvLVALUE(), which is a property of the sub
698  *  rather than the call site.
699  */
700 #define CxLVAL(c)       (0 + ((c)->blk_u16 & 0xff))
701
702
703
704 /* given/when context */
705 struct block_givwhen {
706         OP *leave_op;
707         SV *defsv_save; /* the original $_ */
708 };
709
710
711
712 /* context common to subroutines, evals and loops */
713 struct block {
714     U8          blku_type;      /* what kind of context this is */
715     U8          blku_gimme;     /* is this block running in list context? */
716     U16         blku_u16;       /* used by block_sub and block_eval (so far) */
717     I32         blku_oldsaveix; /* saved PL_savestack_ix */
718     /* all the fields above must be aligned with same-sized fields as sbu */
719     I32         blku_oldsp;     /* current sp floor: where nextstate pops to */
720     I32         blku_oldmarksp; /* mark stack index */
721     COP *       blku_oldcop;    /* old curcop pointer */
722     PMOP *      blku_oldpm;     /* values of pattern match vars */
723     SSize_t     blku_old_tmpsfloor;     /* saved PL_tmps_floor */
724     I32         blku_oldscopesp;        /* scope stack index */
725
726     union {
727         struct block_sub        blku_sub;
728         struct block_format     blku_format;
729         struct block_eval       blku_eval;
730         struct block_loop       blku_loop;
731         struct block_givwhen    blku_givwhen;
732     } blk_u;
733 };
734 #define blk_oldsp       cx_u.cx_blk.blku_oldsp
735 #define blk_oldcop      cx_u.cx_blk.blku_oldcop
736 #define blk_oldmarksp   cx_u.cx_blk.blku_oldmarksp
737 #define blk_oldscopesp  cx_u.cx_blk.blku_oldscopesp
738 #define blk_oldpm       cx_u.cx_blk.blku_oldpm
739 #define blk_gimme       cx_u.cx_blk.blku_gimme
740 #define blk_u16         cx_u.cx_blk.blku_u16
741 #define blk_oldsaveix   cx_u.cx_blk.blku_oldsaveix
742 #define blk_old_tmpsfloor cx_u.cx_blk.blku_old_tmpsfloor
743 #define blk_sub         cx_u.cx_blk.blk_u.blku_sub
744 #define blk_format      cx_u.cx_blk.blk_u.blku_format
745 #define blk_eval        cx_u.cx_blk.blk_u.blku_eval
746 #define blk_loop        cx_u.cx_blk.blk_u.blku_loop
747 #define blk_givwhen     cx_u.cx_blk.blk_u.blku_givwhen
748
749 #define CX_DEBUG(cx, action)                                            \
750     DEBUG_l(                                                            \
751         Perl_deb(aTHX_ "CX %ld %s %s (scope %ld,%ld) (save %ld,%ld) at %s:%d\n",\
752                     (long)cxstack_ix,                                   \
753                     action,                                             \
754                     PL_block_type[CxTYPE(cx)],                          \
755                     (long)PL_scopestack_ix,                             \
756                     (long)(cx->blk_oldscopesp),                         \
757                     (long)PL_savestack_ix,                              \
758                     (long)(cx->blk_oldsaveix),                          \
759                     __FILE__, __LINE__));
760
761
762
763 /* substitution context */
764 struct subst {
765     U8          sbu_type;       /* same as blku_type */
766     U8          sbu_rflags;
767     U16         sbu_rxtainted;
768     I32         sbu_oldsaveix; /* same as blku_oldsaveix */
769     /* all the fields above must be aligned with same-sized fields as blk_u */
770     SSize_t     sbu_iters;
771     SSize_t     sbu_maxiters;
772     char *      sbu_orig;
773     SV *        sbu_dstr;
774     SV *        sbu_targ;
775     char *      sbu_s;
776     char *      sbu_m;
777     char *      sbu_strend;
778     void *      sbu_rxres;
779     REGEXP *    sbu_rx;
780 };
781 #define sb_iters        cx_u.cx_subst.sbu_iters
782 #define sb_maxiters     cx_u.cx_subst.sbu_maxiters
783 #define sb_rflags       cx_u.cx_subst.sbu_rflags
784 #define sb_rxtainted    cx_u.cx_subst.sbu_rxtainted
785 #define sb_orig         cx_u.cx_subst.sbu_orig
786 #define sb_dstr         cx_u.cx_subst.sbu_dstr
787 #define sb_targ         cx_u.cx_subst.sbu_targ
788 #define sb_s            cx_u.cx_subst.sbu_s
789 #define sb_m            cx_u.cx_subst.sbu_m
790 #define sb_strend       cx_u.cx_subst.sbu_strend
791 #define sb_rxres        cx_u.cx_subst.sbu_rxres
792 #define sb_rx           cx_u.cx_subst.sbu_rx
793
794 #ifdef PERL_CORE
795 #  define CX_PUSHSUBST(cx) CXINC, cx = CX_CUR(),                        \
796         cx->blk_oldsaveix = oldsave,                                    \
797         cx->sb_iters            = iters,                                \
798         cx->sb_maxiters         = maxiters,                             \
799         cx->sb_rflags           = r_flags,                              \
800         cx->sb_rxtainted        = rxtainted,                            \
801         cx->sb_orig             = orig,                                 \
802         cx->sb_dstr             = dstr,                                 \
803         cx->sb_targ             = targ,                                 \
804         cx->sb_s                = s,                                    \
805         cx->sb_m                = m,                                    \
806         cx->sb_strend           = strend,                               \
807         cx->sb_rxres            = NULL,                                 \
808         cx->sb_rx               = rx,                                   \
809         cx->cx_type             = CXt_SUBST | (once ? CXp_ONCE : 0);    \
810         rxres_save(&cx->sb_rxres, rx);                                  \
811         (void)ReREFCNT_inc(rx);                                         \
812         SvREFCNT_inc_void_NN(targ)
813
814 #  define CX_POPSUBST(cx) \
815     STMT_START {                                                        \
816         REGEXP *re;                                                     \
817         assert(CxTYPE(cx) == CXt_SUBST);                                \
818         rxres_free(&cx->sb_rxres);                                      \
819         re = cx->sb_rx;                                                 \
820         cx->sb_rx = NULL;                                               \
821         ReREFCNT_dec(re);                                               \
822         SvREFCNT_dec_NN(cx->sb_targ);                                   \
823     } STMT_END
824 #endif
825
826 #define CxONCE(cx)              ((cx)->cx_type & CXp_ONCE)
827
828 struct context {
829     union {
830         struct block    cx_blk;
831         struct subst    cx_subst;
832     } cx_u;
833 };
834 #define cx_type cx_u.cx_subst.sbu_type
835
836 /* If you re-order these, there is also an array of uppercase names in perl.h
837    and a static array of context names in pp_ctl.c  */
838 #define CXTYPEMASK      0xf
839 #define CXt_NULL        0 /* currently only used for sort BLOCK */
840 #define CXt_WHEN        1
841 #define CXt_BLOCK       2
842 /* When micro-optimising :-) keep GIVEN next to the LOOPs, as these 5 share a
843    jump table in pp_ctl.c
844    The first 4 don't have a 'case' in at least one switch statement in pp_ctl.c
845 */
846 #define CXt_GIVEN       3
847
848 /* be careful of the ordering of these five. Macros like CxTYPE_is_LOOP,
849  * CxFOREACH compare ranges */
850 #define CXt_LOOP_ARY    4 /* for (@ary)     {} */
851 #define CXt_LOOP_LAZYSV 5 /* for ('a'..'z') {} */
852 #define CXt_LOOP_LAZYIV 6 /* for (1..9)     {} */
853 #define CXt_LOOP_LIST   7 /* for (1,2,3)    {} */
854 #define CXt_LOOP_PLAIN  8 /*                {} */
855
856 #define CXt_SUB         9
857 #define CXt_FORMAT     10
858 #define CXt_EVAL       11
859 #define CXt_SUBST      12
860 /* SUBST doesn't feature in all switch statements.  */
861
862 /* private flags for CXt_SUB and CXt_FORMAT */
863 #define CXp_MULTICALL   0x10    /* part of a multicall (so don't tear down
864                                    context on exit). (not CXt_FORMAT) */
865 #define CXp_HASARGS     0x20
866 #define CXp_SUB_RE      0x40    /* code called within regex, i.e. (?{}) */
867 #define CXp_SUB_RE_FAKE 0x80    /* fake sub CX for (?{}) in current scope */
868
869 /* private flags for CXt_EVAL */
870 #define CXp_REAL        0x20    /* truly eval'', not a lookalike */
871 #define CXp_TRYBLOCK    0x40    /* eval{}, not eval'' or similar */
872
873 /* private flags for CXt_LOOP */
874
875 /* this is only set in conjunction with CXp_FOR_GV */
876 #define CXp_FOR_DEF     0x10    /* foreach using $_ */
877 /* these 3 are mutually exclusive */
878 #define CXp_FOR_LVREF   0x20    /* foreach using \$var */
879 #define CXp_FOR_GV      0x40    /* foreach using package var */
880 #define CXp_FOR_PAD     0x80    /* foreach using lexical var */
881
882 #define CxPADLOOP(c)    ((c)->cx_type & CXp_FOR_PAD)
883
884 /* private flags for CXt_SUBST */
885 #define CXp_ONCE        0x10    /* What was sbu_once in struct subst */
886
887 #define CxTYPE(c)       ((c)->cx_type & CXTYPEMASK)
888 #define CxTYPE_is_LOOP(c) (   CxTYPE(cx) >= CXt_LOOP_ARY                \
889                            && CxTYPE(cx) <= CXt_LOOP_PLAIN)
890 #define CxMULTICALL(c)  ((c)->cx_type & CXp_MULTICALL)
891 #define CxREALEVAL(c)   (((c)->cx_type & (CXTYPEMASK|CXp_REAL))         \
892                          == (CXt_EVAL|CXp_REAL))
893 #define CxTRYBLOCK(c)   (((c)->cx_type & (CXTYPEMASK|CXp_TRYBLOCK))     \
894                          == (CXt_EVAL|CXp_TRYBLOCK))
895 #define CxFOREACH(c)    (   CxTYPE(cx) >= CXt_LOOP_ARY                  \
896                          && CxTYPE(cx) <= CXt_LOOP_LIST)
897
898 #define CXINC (cxstack_ix < cxstack_max ? ++cxstack_ix : (cxstack_ix = cxinc()))
899
900 /* 
901 =head1 "Gimme" Values
902 */
903
904 /*
905 =for apidoc AmU||G_SCALAR
906 Used to indicate scalar context.  See C<L</GIMME_V>>, C<L</GIMME>>, and
907 L<perlcall>.
908
909 =for apidoc AmU||G_ARRAY
910 Used to indicate list context.  See C<L</GIMME_V>>, C<L</GIMME>> and
911 L<perlcall>.
912
913 =for apidoc AmU||G_VOID
914 Used to indicate void context.  See C<L</GIMME_V>> and L<perlcall>.
915
916 =for apidoc AmU||G_DISCARD
917 Indicates that arguments returned from a callback should be discarded.  See
918 L<perlcall>.
919
920 =for apidoc AmU||G_EVAL
921
922 Used to force a Perl C<eval> wrapper around a callback.  See
923 L<perlcall>.
924
925 =for apidoc AmU||G_NOARGS
926
927 Indicates that no arguments are being sent to a callback.  See
928 L<perlcall>.
929
930 =cut
931 */
932
933 #define G_SCALAR        2
934 #define G_ARRAY         3
935 #define G_VOID          1
936 #define G_WANT          3
937
938 /* extra flags for Perl_call_* routines */
939 #define G_DISCARD       4       /* Call FREETMPS.
940                                    Don't change this without consulting the
941                                    hash actions codes defined in hv.h */
942 #define G_EVAL          8       /* Assume eval {} around subroutine call. */
943 #define G_NOARGS       16       /* Don't construct a @_ array. */
944 #define G_KEEPERR      32       /* Warn for errors, don't overwrite $@ */
945 #define G_NODEBUG      64       /* Disable debugging at toplevel.  */
946 #define G_METHOD      128       /* Calling method. */
947 #define G_FAKINGEVAL  256       /* Faking an eval context for call_sv or
948                                    fold_constants. */
949 #define G_UNDEF_FILL  512       /* Fill the stack with &PL_sv_undef
950                                    A special case for UNSHIFT in
951                                    Perl_magic_methcall().  */
952 #define G_WRITING_TO_STDERR 1024 /* Perl_write_to_stderr() is calling
953                                     Perl_magic_methcall().  */
954 #define G_RE_REPARSING 0x800     /* compiling a run-time /(?{..})/ */
955 #define G_METHOD_NAMED 4096     /* calling named method, eg without :: or ' */
956
957 /* flag bits for PL_in_eval */
958 #define EVAL_NULL       0       /* not in an eval */
959 #define EVAL_INEVAL     1       /* some enclosing scope is an eval */
960 #define EVAL_WARNONLY   2       /* used by yywarn() when calling yyerror() */
961 #define EVAL_KEEPERR    4       /* set by Perl_call_sv if G_KEEPERR */
962 #define EVAL_INREQUIRE  8       /* The code is being required. */
963 #define EVAL_RE_REPARSING 0x10  /* eval_sv() called with G_RE_REPARSING */
964
965 /* Support for switching (stack and block) contexts.
966  * This ensures magic doesn't invalidate local stack and cx pointers.
967  */
968
969 #define PERLSI_UNKNOWN          -1
970 #define PERLSI_UNDEF            0
971 #define PERLSI_MAIN             1
972 #define PERLSI_MAGIC            2
973 #define PERLSI_SORT             3
974 #define PERLSI_SIGNAL           4
975 #define PERLSI_OVERLOAD         5
976 #define PERLSI_DESTROY          6
977 #define PERLSI_WARNHOOK         7
978 #define PERLSI_DIEHOOK          8
979 #define PERLSI_REQUIRE          9
980 #define PERLSI_MULTICALL       10
981
982 struct stackinfo {
983     AV *                si_stack;       /* stack for current runlevel */
984     PERL_CONTEXT *      si_cxstack;     /* context stack for runlevel */
985     struct stackinfo *  si_prev;
986     struct stackinfo *  si_next;
987     I32                 si_cxix;        /* current context index */
988     I32                 si_cxmax;       /* maximum allocated index */
989     I32                 si_type;        /* type of runlevel */
990     I32                 si_markoff;     /* offset where markstack begins for us.
991                                          * currently used only with DEBUGGING,
992                                          * but not #ifdef-ed for bincompat */
993 };
994
995 typedef struct stackinfo PERL_SI;
996
997 #define cxstack         (PL_curstackinfo->si_cxstack)
998 #define cxstack_ix      (PL_curstackinfo->si_cxix)
999 #define cxstack_max     (PL_curstackinfo->si_cxmax)
1000
1001 #ifdef DEBUGGING
1002 #  define       SET_MARK_OFFSET \
1003     PL_curstackinfo->si_markoff = PL_markstack_ptr - PL_markstack
1004 #else
1005 #  define       SET_MARK_OFFSET NOOP
1006 #endif
1007
1008 #define PUSHSTACKi(type) \
1009     STMT_START {                                                        \
1010         PERL_SI *next = PL_curstackinfo->si_next;                       \
1011         DEBUG_l({                                                       \
1012             int i = 0; PERL_SI *p = PL_curstackinfo;                    \
1013             while (p) { i++; p = p->si_prev; }                          \
1014             Perl_deb(aTHX_ "push STACKINFO %d at %s:%d\n",              \
1015                          i, __FILE__, __LINE__);})                      \
1016         if (!next) {                                                    \
1017             next = new_stackinfo(32, 2048/sizeof(PERL_CONTEXT) - 1);    \
1018             next->si_prev = PL_curstackinfo;                            \
1019             PL_curstackinfo->si_next = next;                            \
1020         }                                                               \
1021         next->si_type = type;                                           \
1022         next->si_cxix = -1;                                             \
1023         AvFILLp(next->si_stack) = 0;                                    \
1024         SWITCHSTACK(PL_curstack,next->si_stack);                        \
1025         PL_curstackinfo = next;                                         \
1026         SET_MARK_OFFSET;                                                \
1027     } STMT_END
1028
1029 #define PUSHSTACK PUSHSTACKi(PERLSI_UNKNOWN)
1030
1031 /* POPSTACK works with PL_stack_sp, so it may need to be bracketed by
1032  * PUTBACK/SPAGAIN to flush/refresh any local SP that may be active */
1033 #define POPSTACK \
1034     STMT_START {                                                        \
1035         dSP;                                                            \
1036         PERL_SI * const prev = PL_curstackinfo->si_prev;                \
1037         DEBUG_l({                                                       \
1038             int i = -1; PERL_SI *p = PL_curstackinfo;                   \
1039             while (p) { i++; p = p->si_prev; }                          \
1040             Perl_deb(aTHX_ "pop  STACKINFO %d at %s:%d\n",              \
1041                          i, __FILE__, __LINE__);})                      \
1042         if (!prev) {                                                    \
1043             Perl_croak_popstack();                                      \
1044         }                                                               \
1045         SWITCHSTACK(PL_curstack,prev->si_stack);                        \
1046         /* don't free prev here, free them all at the END{} */          \
1047         PL_curstackinfo = prev;                                         \
1048     } STMT_END
1049
1050 #define POPSTACK_TO(s) \
1051     STMT_START {                                                        \
1052         while (PL_curstack != s) {                                      \
1053             dounwind(-1);                                               \
1054             POPSTACK;                                                   \
1055         }                                                               \
1056     } STMT_END
1057
1058 #define IN_PERL_COMPILETIME     (PL_curcop == &PL_compiling)
1059 #define IN_PERL_RUNTIME         (PL_curcop != &PL_compiling)
1060
1061
1062
1063
1064 /*
1065 =head1 Multicall Functions
1066
1067 =for apidoc Ams||dMULTICALL
1068 Declare local variables for a multicall.  See L<perlcall/LIGHTWEIGHT CALLBACKS>.
1069
1070 =for apidoc Ams||PUSH_MULTICALL
1071 Opening bracket for a lightweight callback.
1072 See L<perlcall/LIGHTWEIGHT CALLBACKS>.
1073
1074 =for apidoc Ams||MULTICALL
1075 Make a lightweight callback.  See L<perlcall/LIGHTWEIGHT CALLBACKS>.
1076
1077 =for apidoc Ams||POP_MULTICALL
1078 Closing bracket for a lightweight callback.
1079 See L<perlcall/LIGHTWEIGHT CALLBACKS>.
1080
1081 =cut
1082 */
1083
1084 #define dMULTICALL \
1085     OP  *multicall_cop;                                                 \
1086     bool multicall_oldcatch
1087
1088 #define PUSH_MULTICALL(the_cv) \
1089     PUSH_MULTICALL_FLAGS(the_cv, 0)
1090
1091 /* Like PUSH_MULTICALL, but allows you to specify extra flags
1092  * for the CX stack entry (this isn't part of the public API) */
1093
1094 #define PUSH_MULTICALL_FLAGS(the_cv, flags) \
1095     STMT_START {                                                        \
1096         PERL_CONTEXT *cx;                                               \
1097         CV * const _nOnclAshIngNamE_ = the_cv;                          \
1098         CV * const cv = _nOnclAshIngNamE_;                              \
1099         PADLIST * const padlist = CvPADLIST(cv);                        \
1100         multicall_oldcatch = CATCH_GET;                                 \
1101         CATCH_SET(TRUE);                                                \
1102         PUSHSTACKi(PERLSI_MULTICALL);                                   \
1103         cx = cx_pushblock((CXt_SUB|CXp_MULTICALL|flags), (U8)gimme,     \
1104                   PL_stack_sp, PL_savestack_ix);                        \
1105         cx_pushsub(cx, cv, NULL, 0);                                    \
1106         SAVEOP();                                                       \
1107         if (!(flags & CXp_SUB_RE_FAKE))                                 \
1108             CvDEPTH(cv)++;                                              \
1109         if (CvDEPTH(cv) >= 2)                                           \
1110             Perl_pad_push(aTHX_ padlist, CvDEPTH(cv));                  \
1111         PAD_SET_CUR_NOSAVE(padlist, CvDEPTH(cv));                       \
1112         multicall_cop = CvSTART(cv);                                    \
1113     } STMT_END
1114
1115 #define MULTICALL \
1116     STMT_START {                                                        \
1117         PL_op = multicall_cop;                                          \
1118         CALLRUNOPS(aTHX);                                               \
1119     } STMT_END
1120
1121 #define POP_MULTICALL \
1122     STMT_START {                                                        \
1123         PERL_CONTEXT *cx;                                               \
1124         cx = CX_CUR();                                                  \
1125         CX_LEAVE_SCOPE(cx);                                             \
1126         cx_popsub_common(cx);                                           \
1127         gimme = cx->blk_gimme;                                          \
1128         PERL_UNUSED_VAR(gimme); /* for API */                           \
1129         cx_popblock(cx);                                                \
1130         CX_POP(cx);                                                     \
1131         POPSTACK;                                                       \
1132         CATCH_SET(multicall_oldcatch);                                  \
1133         SPAGAIN;                                                        \
1134     } STMT_END
1135
1136 /* Change the CV of an already-pushed MULTICALL CxSUB block.
1137  * (this isn't part of the public API) */
1138
1139 #define CHANGE_MULTICALL_FLAGS(the_cv, flags) \
1140     STMT_START {                                                        \
1141         CV * const _nOnclAshIngNamE_ = the_cv;                          \
1142         CV * const cv = _nOnclAshIngNamE_;                              \
1143         PADLIST * const padlist = CvPADLIST(cv);                        \
1144         PERL_CONTEXT *cx = CX_CUR();                                    \
1145         assert(CxMULTICALL(cx));                                        \
1146         cx_popsub_common(cx);                                           \
1147         cx->cx_type = (CXt_SUB|CXp_MULTICALL|flags);                    \
1148         cx_pushsub(cx, cv, NULL, 0);                                    \
1149         if (!(flags & CXp_SUB_RE_FAKE))                                 \
1150             CvDEPTH(cv)++;                                              \
1151         if (CvDEPTH(cv) >= 2)                                           \
1152             Perl_pad_push(aTHX_ padlist, CvDEPTH(cv));                  \
1153         PAD_SET_CUR_NOSAVE(padlist, CvDEPTH(cv));                       \
1154         multicall_cop = CvSTART(cv);                                    \
1155     } STMT_END
1156 /*
1157  * ex: set ts=8 sts=4 sw=4 et:
1158  */