This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
move blku_old_savestack_ix to base of cxt struct
[perl5.git] / cop.h
1 /*    cop.h
2  *
3  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4  *    2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 by Larry Wall and others
5  *
6  *    You may distribute under the terms of either the GNU General Public
7  *    License or the Artistic License, as specified in the README file.
8  *
9  * Control ops (cops) are one of the two ops OP_NEXTSTATE and OP_DBSTATE,
10  * that (loosely speaking) are statement separators.
11  * They hold information important for lexical state and error reporting.
12  * At run time, PL_curcop is set to point to the most recently executed cop,
13  * and thus can be used to determine our current state.
14  */
15
16 /* A jmpenv packages the state required to perform a proper non-local jump.
17  * Note that there is a PL_start_env initialized when perl starts, and
18  * PL_top_env points to this initially, so PL_top_env should always be
19  * non-null.
20  *
21  * Existence of a non-null PL_top_env->je_prev implies it is valid to call
22  * longjmp() at that runlevel (we make sure PL_start_env.je_prev is always
23  * null to ensure this).
24  *
25  * je_mustcatch, when set at any runlevel to TRUE, means eval ops must
26  * establish a local jmpenv to handle exception traps.  Care must be taken
27  * to restore the previous value of je_mustcatch before exiting the
28  * stack frame iff JMPENV_PUSH was not called in that stack frame.
29  * GSAR 97-03-27
30  */
31
32 struct jmpenv {
33     struct jmpenv *     je_prev;
34     Sigjmp_buf          je_buf;         /* uninit if je_prev is NULL */
35     int                 je_ret;         /* last exception thrown */
36     bool                je_mustcatch;   /* need to call longjmp()? */
37     U16                 je_old_delaymagic; /* saved PL_delaymagic */
38 };
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 literal string instead of a
179 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 literal string instead of a
285 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 literal string instead of a
342 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 literal string instead of a
482 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 /* free all savestack items back to the watermark of the specified context */
574
575 #define CX_LEAVE_SCOPE(cx) LEAVE_SCOPE(cx->cx_old_savestack_ix)
576
577 /* base for the next two macros. Don't use directly.
578  * The context frame holds a reference to the CV so that it can't be
579  * freed while we're executing it */
580
581 #define PUSHSUB_BASE(cx)                                                \
582         ENTRY_PROBE(CvNAMED(cv)                                         \
583                         ? HEK_KEY(CvNAME_HEK(cv))                       \
584                         : GvENAME(CvGV(cv)),                            \
585                 CopFILE((const COP *)CvSTART(cv)),                      \
586                 CopLINE((const COP *)CvSTART(cv)),                      \
587                 CopSTASHPV((const COP *)CvSTART(cv)));                  \
588                                                                         \
589         cx->blk_sub.cv = cv;                                            \
590         cx->blk_sub.olddepth = CvDEPTH(cv);                             \
591         cx->blk_sub.prevcomppad = PL_comppad;                           \
592         cx->cx_type |= (hasargs) ? CXp_HASARGS : 0;                     \
593         cx->blk_sub.retop = NULL;                                       \
594         SvREFCNT_inc_simple_void_NN(cv);
595
596 #define PUSHSUB_GET_LVALUE_MASK(func) \
597         /* If the context is indeterminate, then only the lvalue */     \
598         /* flags that the caller also has are applicable.        */     \
599         (                                                               \
600            (PL_op->op_flags & OPf_WANT)                                 \
601                ? OPpENTERSUB_LVAL_MASK                                  \
602                : !(PL_op->op_private & OPpENTERSUB_LVAL_MASK)           \
603                    ? 0 : (U8)func(aTHX)                                 \
604         )
605
606 #define PUSHSUB(cx)                                                     \
607     {                                                                   \
608         U8 phlags = PUSHSUB_GET_LVALUE_MASK(Perl_was_lvalue_sub);       \
609         PUSHSUB_BASE(cx)                                                \
610         cx->blk_u16 = PL_op->op_private &                               \
611                           (phlags|OPpDEREF);                            \
612     }
613
614 /* variant for use by OP_DBSTATE, where op_private holds hint bits */
615 #define PUSHSUB_DB(cx)                                                  \
616         PUSHSUB_BASE(cx)                                                \
617         cx->blk_u16 = 0;
618
619
620 #define PUSHFORMAT(cx, retop)                                           \
621         cx->blk_format.cv = cv;                                         \
622         cx->blk_format.gv = gv;                                         \
623         cx->blk_format.retop = (retop);                                 \
624         cx->blk_format.dfoutgv = PL_defoutgv;                           \
625         cx->blk_format.prevcomppad = PL_comppad;                        \
626         cx->blk_u16 = 0;                                                \
627         cx->cx_old_savestack_ix = PL_savestack_ix;                      \
628         SvREFCNT_inc_simple_void_NN(cv);                                \
629         CvDEPTH(cv)++;                                                  \
630         SvREFCNT_inc_void(cx->blk_format.dfoutgv)
631
632 /* Restore old @_ */
633 #define POP_SAVEARRAY()                                         \
634     STMT_START {                                                        \
635         AV *av = GvAV(PL_defgv);                                        \
636         GvAV(PL_defgv) = cx->blk_sub.savearray;                         \
637         SvREFCNT_dec(av);                                               \
638     } STMT_END
639
640 /* junk in @_ spells trouble when cloning CVs and in pp_caller(), so don't
641  * leave any (a fast av_clear(ary), basically) */
642 #define CLEAR_ARGARRAY(ary) \
643     STMT_START {                                                        \
644         AvMAX(ary) += AvARRAY(ary) - AvALLOC(ary);                      \
645         AvARRAY(ary) = AvALLOC(ary);                                    \
646         AvFILLp(ary) = -1;                                              \
647     } STMT_END
648
649 #define POPSUB(cx)                                                      \
650     STMT_START {                                                        \
651         if (!(cx->blk_u16 & CxPOPSUB_DONE)) {                           \
652         cx->blk_u16 |= CxPOPSUB_DONE;                                   \
653         RETURN_PROBE(CvNAMED(cx->blk_sub.cv)                            \
654                         ? HEK_KEY(CvNAME_HEK(cx->blk_sub.cv))           \
655                         : GvENAME(CvGV(cx->blk_sub.cv)),                \
656                 CopFILE((COP*)CvSTART((const CV*)cx->blk_sub.cv)),      \
657                 CopLINE((COP*)CvSTART((const CV*)cx->blk_sub.cv)),      \
658                 CopSTASHPV((COP*)CvSTART((const CV*)cx->blk_sub.cv)));  \
659                                                                         \
660         if (CxHASARGS(cx)) {                                            \
661             AV *av;                                                     \
662             assert(AvARRAY(MUTABLE_AV(                                  \
663                 PadlistARRAY(CvPADLIST(cx->blk_sub.cv))[                \
664                         CvDEPTH(cx->blk_sub.cv)])) == PL_curpad);       \
665             POP_SAVEARRAY();                                            \
666             /* abandon @_ if it got reified */                          \
667             av = MUTABLE_AV(PAD_SVl(0));                                \
668             if (UNLIKELY(AvREAL(av)))                                   \
669                 clear_defarray(av, 0);                                  \
670             else {                                                      \
671                 CLEAR_ARGARRAY(av);                                     \
672             }                                                           \
673         }                                                               \
674         }                                                               \
675         PL_comppad = cx->blk_sub.prevcomppad;                           \
676         PL_curpad = LIKELY(PL_comppad) ? AvARRAY(PL_comppad) : NULL;    \
677         CvDEPTH((const CV*)cx->blk_sub.cv) = cx->blk_sub.olddepth;      \
678         SvREFCNT_dec_NN(cx->blk_sub.cv);                                \
679     } STMT_END
680
681 #define POPFORMAT(cx)                                                   \
682     STMT_START {                                                        \
683         if (!(cx->blk_u16 & CxPOPSUB_DONE)) {                           \
684         CV * const cv = cx->blk_format.cv;                              \
685         GV * const dfuot = cx->blk_format.dfoutgv;                      \
686         cx->blk_u16 |= CxPOPSUB_DONE;                                   \
687         setdefout(dfuot);                                               \
688         PL_comppad = cx->blk_format.prevcomppad;                        \
689         PL_curpad = LIKELY(PL_comppad) ? AvARRAY(PL_comppad) : NULL;    \
690         --CvDEPTH(cv);                                                  \
691         SvREFCNT_dec_NN(cx->blk_format.cv);                             \
692         SvREFCNT_dec_NN(dfuot);                                         \
693         }                                                               \
694     } STMT_END
695
696 /* eval context */
697 struct block_eval {
698     OP *        retop;  /* op to execute on exit from eval */
699     /* Above here is the same for sub, format and eval.  */
700     SV *        old_namesv;
701     OP *        old_eval_root;
702     SV *        cur_text;
703     CV *        cv;
704     JMPENV *    cur_top_env; /* value of PL_top_env when eval CX created */
705 };
706
707 /* If we ever need more than 512 op types, change the shift from 7.
708    blku_gimme is actually also only 2 bits, so could be merged with something.
709 */
710
711 #define CxOLD_IN_EVAL(cx)       (((cx)->blk_u16) & 0x7F)
712 #define CxOLD_OP_TYPE(cx)       (((cx)->blk_u16) >> 7)
713
714 #define PUSHEVAL(cx,n)                                                  \
715     STMT_START {                                                        \
716         assert(!(PL_in_eval & ~0x7F));                                  \
717         assert(!(PL_op->op_type & ~0x1FF));                             \
718         cx->blk_u16 = (PL_in_eval & 0x7F) | ((U16)PL_op->op_type << 7); \
719         cx->blk_eval.old_namesv = (n ? newSVpv(n,0) : NULL);            \
720         cx->blk_eval.old_eval_root = PL_eval_root;                      \
721         cx->blk_eval.cur_text = PL_parser ? PL_parser->linestr : NULL;  \
722         cx->blk_eval.cv = NULL; /* set by doeval(), as applicable */    \
723         cx->blk_eval.retop = NULL;                                      \
724         cx->blk_eval.cur_top_env = PL_top_env;                          \
725     } STMT_END
726
727 #define POPEVAL(cx)                                                     \
728     STMT_START {                                                        \
729         PL_in_eval = CxOLD_IN_EVAL(cx);                                 \
730         optype = CxOLD_OP_TYPE(cx);                                     \
731         PL_eval_root = cx->blk_eval.old_eval_root;                      \
732         if (cx->blk_eval.cur_text && SvSCREAM(cx->blk_eval.cur_text))   \
733             SvREFCNT_dec_NN(cx->blk_eval.cur_text);                     \
734         if (cx->blk_eval.old_namesv)                                    \
735             sv_2mortal(cx->blk_eval.old_namesv);                        \
736     } STMT_END
737
738 /* loop context */
739 struct block_loop {
740     I32         resetsp;
741     LOOP *      my_op;  /* My op, that contains redo, next and last ops.  */
742     union {     /* different ways of locating the iteration variable */
743         SV      **svp; /* for lexicals: address of pad slot */
744         GV      *gv;   /* for package vars */
745     } itervar_u;
746     SV          *itersave; /* the original iteration var */
747     union {
748         struct { /* valid if type is LOOP_FOR or LOOP_PLAIN (but {NULL,0})*/
749             AV * ary; /* use the stack if this is NULL */
750             IV ix;
751         } ary;
752         struct { /* valid if type is LOOP_LAZYIV */
753             IV cur;
754             IV end;
755         } lazyiv;
756         struct { /* valid if type if LOOP_LAZYSV */
757             SV * cur;
758             SV * end; /* maxiumum value (or minimum in reverse) */
759         } lazysv;
760     } state_u;
761 #ifdef USE_ITHREADS
762     PAD *oldcomppad; /* needed to map itervar_u.svp during thread clone */
763 #endif
764 };
765
766 #define CxITERVAR(c)                                    \
767         (CxPADLOOP(c)                                   \
768             ? (c)->blk_loop.itervar_u.svp               \
769             : ((c)->cx_type & CXp_FOR_GV)               \
770                 ? &GvSV((c)->blk_loop.itervar_u.gv)     \
771                 : (SV **)&(c)->blk_loop.itervar_u.gv)
772
773 #define CxLABEL(c)      (0 + CopLABEL((c)->blk_oldcop))
774 #define CxLABEL_len(c,len)      (0 + CopLABEL_len((c)->blk_oldcop, len))
775 #define CxLABEL_len_flags(c,len,flags)  (0 + CopLABEL_len_flags((c)->blk_oldcop, len, flags))
776 #define CxHASARGS(c)    (((c)->cx_type & CXp_HASARGS) == CXp_HASARGS)
777 #define CxLVAL(c)       (0 + ((c)->blk_u16 & 0xff))
778 /* POPSUB has already been performed on this context frame */
779 #define CxPOPSUB_DONE 0x100
780
781
782 #define PUSHLOOP_PLAIN(cx, s)                                           \
783         cx->blk_loop.resetsp = s - PL_stack_base;                       \
784         cx->blk_loop.my_op = cLOOP;                                     \
785         cx->blk_loop.state_u.ary.ary = NULL;                            \
786         cx->blk_loop.state_u.ary.ix = 0;                                \
787         cx->cx_old_savestack_ix = PL_savestack_ix;                      \
788         cx->blk_loop.itervar_u.svp = NULL;                              \
789         cx->blk_loop.itersave = NULL;
790
791 #ifdef USE_ITHREADS
792 #  define PUSHLOOP_FOR_setpad(c) (c)->blk_loop.oldcomppad = PL_comppad
793 #else
794 #  define PUSHLOOP_FOR_setpad(c) NOOP
795 #endif
796
797 #define PUSHLOOP_FOR(cx, ivar, isave, s)                                \
798         cx->blk_loop.resetsp = s - PL_stack_base;                       \
799         cx->blk_loop.my_op = cLOOP;                                     \
800         cx->blk_loop.state_u.ary.ary = NULL;                            \
801         cx->blk_loop.state_u.ary.ix = 0;                                \
802         cx->blk_loop.itervar_u.svp = (SV**)(ivar);                      \
803         cx->cx_old_savestack_ix = PL_savestack_ix;                      \
804         cx->blk_loop.itersave = isave;                                  \
805         PUSHLOOP_FOR_setpad(cx);
806
807 #define POPLOOP(cx)                                                     \
808         if (CxTYPE(cx) == CXt_LOOP_LAZYSV) {                            \
809             SvREFCNT_dec_NN(cx->blk_loop.state_u.lazysv.cur);           \
810             SvREFCNT_dec_NN(cx->blk_loop.state_u.lazysv.end);           \
811         }                                                               \
812         else if (CxTYPE(cx) == CXt_LOOP_FOR)                            \
813             SvREFCNT_dec(cx->blk_loop.state_u.ary.ary);                 \
814         if (cx->cx_type & (CXp_FOR_PAD|CXp_FOR_GV)) {                   \
815             SV *cursv;                                                  \
816             SV **svp = (cx)->blk_loop.itervar_u.svp;                    \
817             if ((cx->cx_type & CXp_FOR_GV))                             \
818                 svp = &GvSV((GV*)svp);                                  \
819             cursv = *svp;                                               \
820             *svp = cx->blk_loop.itersave;                               \
821             SvREFCNT_dec(cursv);                                        \
822         }
823
824 /* given/when context */
825 struct block_givwhen {
826         OP *leave_op;
827         SV *defsv_save; /* the original $_ */
828 };
829
830 #define PUSHWHEN(cx)                                                    \
831         cx->cx_old_savestack_ix = PL_savestack_ix;                      \
832         cx->blk_givwhen.leave_op = cLOGOP->op_other;
833
834 #define PUSHGIVEN(cx, orig_var)                                         \
835         PUSHWHEN(cx);                                                   \
836         cx->blk_givwhen.defsv_save = orig_var;
837
838 #define POPWHEN(cx)                                                     \
839         NOOP;
840
841 #define POPGIVEN(cx)                                                    \
842         SvREFCNT_dec(GvSV(PL_defgv));                                   \
843         GvSV(PL_defgv) = cx->blk_givwhen.defsv_save;
844
845
846 /* basic block, i.e. pp_enter/leave */
847
848 #define PUSHBASICBLK(cx)                                                \
849         cx->cx_old_savestack_ix = PL_savestack_ix;
850
851 #define POPBASICBLK(cx)                                                 \
852         NOOP;
853
854
855 /* context common to subroutines, evals and loops */
856 struct block {
857     U8          blku_type;      /* what kind of context this is */
858     U8          blku_gimme;     /* is this block running in list context? */
859     U16         blku_u16;       /* used by block_sub and block_eval (so far) */
860     I32         blku_oldsp;     /* stack pointer to copy stuff down to */
861     COP *       blku_oldcop;    /* old curcop pointer */
862     I32         blku_oldmarksp; /* mark stack index */
863     I32         blku_oldscopesp;        /* scope stack index */
864     PMOP *      blku_oldpm;     /* values of pattern match vars */
865     SSize_t     blku_old_tmpsfloor;     /* saved PL_tmps_floor */
866
867     union {
868         struct block_sub        blku_sub;
869         struct block_format     blku_format;
870         struct block_eval       blku_eval;
871         struct block_loop       blku_loop;
872         struct block_givwhen    blku_givwhen;
873     } blk_u;
874 };
875 #define blk_oldsp       cx_u.cx_blk.blku_oldsp
876 #define blk_oldcop      cx_u.cx_blk.blku_oldcop
877 #define blk_oldmarksp   cx_u.cx_blk.blku_oldmarksp
878 #define blk_oldscopesp  cx_u.cx_blk.blku_oldscopesp
879 #define blk_oldpm       cx_u.cx_blk.blku_oldpm
880 #define blk_gimme       cx_u.cx_blk.blku_gimme
881 #define blk_u16         cx_u.cx_blk.blku_u16
882 #define blk_sub         cx_u.cx_blk.blk_u.blku_sub
883 #define blk_format      cx_u.cx_blk.blk_u.blku_format
884 #define blk_eval        cx_u.cx_blk.blk_u.blku_eval
885 #define blk_loop        cx_u.cx_blk.blk_u.blku_loop
886 #define blk_givwhen     cx_u.cx_blk.blk_u.blku_givwhen
887
888 #define DEBUG_CX(action)                                                \
889     DEBUG_l(                                                            \
890         Perl_deb(aTHX_ "CX %ld %s %s (scope %ld,%ld) (save %ld,%ld) at %s:%d\n",\
891                     (long)cxstack_ix,                                   \
892                     action,                                             \
893                     PL_block_type[CxTYPE(&cxstack[cxstack_ix])],        \
894                     (long)PL_scopestack_ix,                             \
895                     (long)(cxstack[cxstack_ix].blk_oldscopesp),         \
896                     (long)PL_savestack_ix,                              \
897                     (long)(cxstack[cxstack_ix].cx_old_savestack_ix),    \
898                     __FILE__, __LINE__));
899
900 /* Enter a block. */
901 #define PUSHBLOCK(cx,t,sp) CXINC, cx = &cxstack[cxstack_ix],            \
902         cx->cx_type             = t,                                    \
903         cx->blk_oldsp           = sp - PL_stack_base,                   \
904         cx->blk_oldcop          = PL_curcop,                            \
905         cx->blk_oldmarksp       = PL_markstack_ptr - PL_markstack,      \
906         cx->blk_oldscopesp      = PL_scopestack_ix,                     \
907         cx->blk_oldpm           = PL_curpm,                             \
908         cx->blk_gimme           = (U8)gimme;                            \
909         cx->cx_u.cx_blk.blku_old_tmpsfloor = PL_tmps_floor;             \
910         PL_tmps_floor           = PL_tmps_ix;                           \
911         DEBUG_CX("PUSH");
912
913 /* Exit a block (RETURN and LAST). */
914 #define POPBLOCK(cx)                                                    \
915         DEBUG_CX("POP");                                                \
916         PL_curcop        = cx->blk_oldcop,                              \
917         PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp,            \
918         PL_scopestack_ix = cx->blk_oldscopesp,                          \
919         /* LEAVE_SCOPE() should have made this true. /(?{})/ cheats
920          * and leaves a CX entry lying around for repeated use, so
921          * skip for multicall */                  \
922         assert(   (CxTYPE(cx) == CXt_SUB && CxMULTICALL(cx))            \
923                 || PL_savestack_ix == cx->cx_old_savestack_ix);         \
924         PL_tmps_floor = cx->cx_u.cx_blk.blku_old_tmpsfloor;             \
925         PL_curpm         = cx->blk_oldpm;
926
927 /* Continue a block elsewhere (NEXT and REDO). */
928 #define TOPBLOCK(cx)                                                    \
929         DEBUG_CX("TOP");                                                \
930         cx  = &cxstack[cxstack_ix],                                     \
931         PL_stack_sp      = PL_stack_base + cx->blk_oldsp,               \
932         PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp,            \
933         PL_scopestack_ix = cx->blk_oldscopesp,                          \
934         PL_curpm         = cx->blk_oldpm;
935
936 /* substitution context */
937 struct subst {
938     U8          sbu_type;       /* what kind of context this is */
939     U8          sbu_rflags;
940     U16         sbu_rxtainted;  /* matches struct block */
941     SSize_t     sbu_iters;
942     SSize_t     sbu_maxiters;
943     char *      sbu_orig;
944     SV *        sbu_dstr;
945     SV *        sbu_targ;
946     char *      sbu_s;
947     char *      sbu_m;
948     char *      sbu_strend;
949     void *      sbu_rxres;
950     REGEXP *    sbu_rx;
951 };
952 #define sb_iters        cx_u.cx_subst.sbu_iters
953 #define sb_maxiters     cx_u.cx_subst.sbu_maxiters
954 #define sb_rflags       cx_u.cx_subst.sbu_rflags
955 #define sb_rxtainted    cx_u.cx_subst.sbu_rxtainted
956 #define sb_orig         cx_u.cx_subst.sbu_orig
957 #define sb_dstr         cx_u.cx_subst.sbu_dstr
958 #define sb_targ         cx_u.cx_subst.sbu_targ
959 #define sb_s            cx_u.cx_subst.sbu_s
960 #define sb_m            cx_u.cx_subst.sbu_m
961 #define sb_strend       cx_u.cx_subst.sbu_strend
962 #define sb_rxres        cx_u.cx_subst.sbu_rxres
963 #define sb_rx           cx_u.cx_subst.sbu_rx
964
965 #ifdef PERL_CORE
966 #  define PUSHSUBST(cx) CXINC, cx = &cxstack[cxstack_ix],               \
967         cx->cx_old_savestack_ix = oldsave,                              \
968         cx->sb_iters            = iters,                                \
969         cx->sb_maxiters         = maxiters,                             \
970         cx->sb_rflags           = r_flags,                              \
971         cx->sb_rxtainted        = rxtainted,                            \
972         cx->sb_orig             = orig,                                 \
973         cx->sb_dstr             = dstr,                                 \
974         cx->sb_targ             = targ,                                 \
975         cx->sb_s                = s,                                    \
976         cx->sb_m                = m,                                    \
977         cx->sb_strend           = strend,                               \
978         cx->sb_rxres            = NULL,                                 \
979         cx->sb_rx               = rx,                                   \
980         cx->cx_type             = CXt_SUBST | (once ? CXp_ONCE : 0);    \
981         rxres_save(&cx->sb_rxres, rx);                                  \
982         (void)ReREFCNT_inc(rx);                                         \
983         SvREFCNT_inc_void_NN(targ)
984
985 #  define POPSUBST(cx) cx = &cxstack[cxstack_ix--];                     \
986         rxres_free(&cx->sb_rxres);                                      \
987         ReREFCNT_dec(cx->sb_rx);                                        \
988         SvREFCNT_dec_NN(cx->sb_targ)
989 #endif
990
991 #define CxONCE(cx)              ((cx)->cx_type & CXp_ONCE)
992
993 struct context {
994     I32                 cx_old_savestack_ix;   /* saved PL_savestack_ix */
995     union {
996         struct block    cx_blk;
997         struct subst    cx_subst;
998     } cx_u;
999 };
1000 #define cx_type cx_u.cx_subst.sbu_type
1001
1002 /* If you re-order these, there is also an array of uppercase names in perl.h
1003    and a static array of context names in pp_ctl.c  */
1004 #define CXTYPEMASK      0xf
1005 #define CXt_NULL        0 /* currently only used for sort BLOCK */
1006 #define CXt_WHEN        1
1007 #define CXt_BLOCK       2
1008 /* When micro-optimising :-) keep GIVEN next to the LOOPs, as these 5 share a
1009    jump table in pp_ctl.c
1010    The first 4 don't have a 'case' in at least one switch statement in pp_ctl.c
1011 */
1012 #define CXt_GIVEN       3
1013 /* This is first so that CXt_LOOP_FOR|CXt_LOOP_LAZYIV is CXt_LOOP_LAZYIV */
1014 #define CXt_LOOP_FOR    4
1015 #define CXt_LOOP_PLAIN  5
1016 #define CXt_LOOP_LAZYSV 6
1017 #define CXt_LOOP_LAZYIV 7
1018 #define CXt_SUB         8
1019 #define CXt_FORMAT      9
1020 #define CXt_EVAL       10
1021 #define CXt_SUBST      11
1022 /* SUBST doesn't feature in all switch statements.  */
1023
1024 /* private flags for CXt_SUB and CXt_FORMAT */
1025 #define CXp_MULTICALL   0x10    /* part of a multicall (so don't tear down
1026                                    context on exit). (not CXt_FORMAT) */
1027 #define CXp_HASARGS     0x20
1028 #define CXp_SUB_RE      0x40    /* code called within regex, i.e. (?{}) */
1029 #define CXp_SUB_RE_FAKE 0x80    /* fake sub CX for (?{}) in current scope */
1030
1031 /* private flags for CXt_EVAL */
1032 #define CXp_REAL        0x20    /* truly eval'', not a lookalike */
1033 #define CXp_TRYBLOCK    0x40    /* eval{}, not eval'' or similar */
1034
1035 /* private flags for CXt_LOOP */
1036 #define CXp_FOR_DEF     0x10    /* foreach using $_ */
1037 #define CXp_FOR_LVREF   0x20    /* foreach using \$var */
1038 #define CXp_FOR_GV      0x40    /* foreach using package var */
1039 #define CXp_FOR_PAD     0x80    /* foreach using lexical var */
1040 #define CxPADLOOP(c)    ((c)->cx_type & CXp_FOR_PAD)
1041
1042 /* private flags for CXt_SUBST */
1043 #define CXp_ONCE        0x10    /* What was sbu_once in struct subst */
1044
1045 #define CxTYPE(c)       ((c)->cx_type & CXTYPEMASK)
1046 #define CxTYPE_is_LOOP(c)       (((c)->cx_type & 0xC) == 0x4)
1047 #define CxMULTICALL(c)  ((c)->cx_type & CXp_MULTICALL)
1048 #define CxREALEVAL(c)   (((c)->cx_type & (CXTYPEMASK|CXp_REAL))         \
1049                          == (CXt_EVAL|CXp_REAL))
1050 #define CxTRYBLOCK(c)   (((c)->cx_type & (CXTYPEMASK|CXp_TRYBLOCK))     \
1051                          == (CXt_EVAL|CXp_TRYBLOCK))
1052 #define CxFOREACH(c)    (CxTYPE_is_LOOP(c) && CxTYPE(c) != CXt_LOOP_PLAIN)
1053 #define CxFOREACHDEF(c) ((CxTYPE_is_LOOP(c) && CxTYPE(c) != CXt_LOOP_PLAIN) \
1054                          && ((c)->cx_type & CXp_FOR_DEF))
1055
1056 #define CXINC (cxstack_ix < cxstack_max ? ++cxstack_ix : (cxstack_ix = cxinc()))
1057
1058 /* 
1059 =head1 "Gimme" Values
1060 */
1061
1062 /*
1063 =for apidoc AmU||G_SCALAR
1064 Used to indicate scalar context.  See C<L</GIMME_V>>, C<L</GIMME>>, and
1065 L<perlcall>.
1066
1067 =for apidoc AmU||G_ARRAY
1068 Used to indicate list context.  See C<L</GIMME_V>>, C<L</GIMME>> and
1069 L<perlcall>.
1070
1071 =for apidoc AmU||G_VOID
1072 Used to indicate void context.  See C<L</GIMME_V>> and L<perlcall>.
1073
1074 =for apidoc AmU||G_DISCARD
1075 Indicates that arguments returned from a callback should be discarded.  See
1076 L<perlcall>.
1077
1078 =for apidoc AmU||G_EVAL
1079
1080 Used to force a Perl C<eval> wrapper around a callback.  See
1081 L<perlcall>.
1082
1083 =for apidoc AmU||G_NOARGS
1084
1085 Indicates that no arguments are being sent to a callback.  See
1086 L<perlcall>.
1087
1088 =cut
1089 */
1090
1091 #define G_SCALAR        2
1092 #define G_ARRAY         3
1093 #define G_VOID          1
1094 #define G_WANT          3
1095
1096 /* extra flags for Perl_call_* routines */
1097 #define G_DISCARD       4       /* Call FREETMPS.
1098                                    Don't change this without consulting the
1099                                    hash actions codes defined in hv.h */
1100 #define G_EVAL          8       /* Assume eval {} around subroutine call. */
1101 #define G_NOARGS       16       /* Don't construct a @_ array. */
1102 #define G_KEEPERR      32       /* Warn for errors, don't overwrite $@ */
1103 #define G_NODEBUG      64       /* Disable debugging at toplevel.  */
1104 #define G_METHOD      128       /* Calling method. */
1105 #define G_FAKINGEVAL  256       /* Faking an eval context for call_sv or
1106                                    fold_constants. */
1107 #define G_UNDEF_FILL  512       /* Fill the stack with &PL_sv_undef
1108                                    A special case for UNSHIFT in
1109                                    Perl_magic_methcall().  */
1110 #define G_WRITING_TO_STDERR 1024 /* Perl_write_to_stderr() is calling
1111                                     Perl_magic_methcall().  */
1112 #define G_RE_REPARSING 0x800     /* compiling a run-time /(?{..})/ */
1113 #define G_METHOD_NAMED 4096     /* calling named method, eg without :: or ' */
1114
1115 /* flag bits for PL_in_eval */
1116 #define EVAL_NULL       0       /* not in an eval */
1117 #define EVAL_INEVAL     1       /* some enclosing scope is an eval */
1118 #define EVAL_WARNONLY   2       /* used by yywarn() when calling yyerror() */
1119 #define EVAL_KEEPERR    4       /* set by Perl_call_sv if G_KEEPERR */
1120 #define EVAL_INREQUIRE  8       /* The code is being required. */
1121 #define EVAL_RE_REPARSING 0x10  /* eval_sv() called with G_RE_REPARSING */
1122
1123 /* Support for switching (stack and block) contexts.
1124  * This ensures magic doesn't invalidate local stack and cx pointers.
1125  */
1126
1127 #define PERLSI_UNKNOWN          -1
1128 #define PERLSI_UNDEF            0
1129 #define PERLSI_MAIN             1
1130 #define PERLSI_MAGIC            2
1131 #define PERLSI_SORT             3
1132 #define PERLSI_SIGNAL           4
1133 #define PERLSI_OVERLOAD         5
1134 #define PERLSI_DESTROY          6
1135 #define PERLSI_WARNHOOK         7
1136 #define PERLSI_DIEHOOK          8
1137 #define PERLSI_REQUIRE          9
1138 #define PERLSI_MULTICALL       10
1139
1140 struct stackinfo {
1141     AV *                si_stack;       /* stack for current runlevel */
1142     PERL_CONTEXT *      si_cxstack;     /* context stack for runlevel */
1143     struct stackinfo *  si_prev;
1144     struct stackinfo *  si_next;
1145     I32                 si_cxix;        /* current context index */
1146     I32                 si_cxmax;       /* maximum allocated index */
1147     I32                 si_type;        /* type of runlevel */
1148     I32                 si_markoff;     /* offset where markstack begins for us.
1149                                          * currently used only with DEBUGGING,
1150                                          * but not #ifdef-ed for bincompat */
1151 };
1152
1153 typedef struct stackinfo PERL_SI;
1154
1155 #define cxstack         (PL_curstackinfo->si_cxstack)
1156 #define cxstack_ix      (PL_curstackinfo->si_cxix)
1157 #define cxstack_max     (PL_curstackinfo->si_cxmax)
1158
1159 #ifdef DEBUGGING
1160 #  define       SET_MARK_OFFSET \
1161     PL_curstackinfo->si_markoff = PL_markstack_ptr - PL_markstack
1162 #else
1163 #  define       SET_MARK_OFFSET NOOP
1164 #endif
1165
1166 #define PUSHSTACKi(type) \
1167     STMT_START {                                                        \
1168         PERL_SI *next = PL_curstackinfo->si_next;                       \
1169         DEBUG_l({                                                       \
1170             int i = 0; PERL_SI *p = PL_curstackinfo;                    \
1171             while (p) { i++; p = p->si_prev; }                          \
1172             Perl_deb(aTHX_ "push STACKINFO %d at %s:%d\n",              \
1173                          i, __FILE__, __LINE__);})                      \
1174         if (!next) {                                                    \
1175             next = new_stackinfo(32, 2048/sizeof(PERL_CONTEXT) - 1);    \
1176             next->si_prev = PL_curstackinfo;                            \
1177             PL_curstackinfo->si_next = next;                            \
1178         }                                                               \
1179         next->si_type = type;                                           \
1180         next->si_cxix = -1;                                             \
1181         AvFILLp(next->si_stack) = 0;                                    \
1182         SWITCHSTACK(PL_curstack,next->si_stack);                        \
1183         PL_curstackinfo = next;                                         \
1184         SET_MARK_OFFSET;                                                \
1185     } STMT_END
1186
1187 #define PUSHSTACK PUSHSTACKi(PERLSI_UNKNOWN)
1188
1189 /* POPSTACK works with PL_stack_sp, so it may need to be bracketed by
1190  * PUTBACK/SPAGAIN to flush/refresh any local SP that may be active */
1191 #define POPSTACK \
1192     STMT_START {                                                        \
1193         dSP;                                                            \
1194         PERL_SI * const prev = PL_curstackinfo->si_prev;                \
1195         DEBUG_l({                                                       \
1196             int i = -1; PERL_SI *p = PL_curstackinfo;                   \
1197             while (p) { i++; p = p->si_prev; }                          \
1198             Perl_deb(aTHX_ "pop  STACKINFO %d at %s:%d\n",              \
1199                          i, __FILE__, __LINE__);})                      \
1200         if (!prev) {                                                    \
1201             Perl_croak_popstack();                                      \
1202         }                                                               \
1203         SWITCHSTACK(PL_curstack,prev->si_stack);                        \
1204         /* don't free prev here, free them all at the END{} */          \
1205         PL_curstackinfo = prev;                                         \
1206     } STMT_END
1207
1208 #define POPSTACK_TO(s) \
1209     STMT_START {                                                        \
1210         while (PL_curstack != s) {                                      \
1211             dounwind(-1);                                               \
1212             POPSTACK;                                                   \
1213         }                                                               \
1214     } STMT_END
1215
1216 #define IN_PERL_COMPILETIME     (PL_curcop == &PL_compiling)
1217 #define IN_PERL_RUNTIME         (PL_curcop != &PL_compiling)
1218
1219 /*
1220 =head1 Multicall Functions
1221
1222 =for apidoc Ams||dMULTICALL
1223 Declare local variables for a multicall.  See L<perlcall/LIGHTWEIGHT CALLBACKS>.
1224
1225 =for apidoc Ams||PUSH_MULTICALL
1226 Opening bracket for a lightweight callback.
1227 See L<perlcall/LIGHTWEIGHT CALLBACKS>.
1228
1229 =for apidoc Ams||MULTICALL
1230 Make a lightweight callback.  See L<perlcall/LIGHTWEIGHT CALLBACKS>.
1231
1232 =for apidoc Ams||POP_MULTICALL
1233 Closing bracket for a lightweight callback.
1234 See L<perlcall/LIGHTWEIGHT CALLBACKS>.
1235
1236 =cut
1237 */
1238
1239 #define dMULTICALL \
1240     SV **newsp;                 /* set by POPBLOCK */                   \
1241     PERL_CONTEXT *cx;                                                   \
1242     CV *multicall_cv;                                                   \
1243     OP *multicall_cop;                                                  \
1244     bool multicall_oldcatch;                                            \
1245     U8 hasargs = 0              /* used by PUSHSUB */
1246
1247 #define PUSH_MULTICALL(the_cv) \
1248     PUSH_MULTICALL_FLAGS(the_cv, 0)
1249
1250 /* Like PUSH_MULTICALL, but allows you to specify extra flags
1251  * for the CX stack entry (this isn't part of the public API) */
1252
1253 #define PUSH_MULTICALL_FLAGS(the_cv, flags) \
1254     STMT_START {                                                        \
1255         CV * const _nOnclAshIngNamE_ = the_cv;                          \
1256         CV * const cv = _nOnclAshIngNamE_;                              \
1257         PADLIST * const padlist = CvPADLIST(cv);                        \
1258         multicall_oldcatch = CATCH_GET;                                 \
1259         CATCH_SET(TRUE);                                                \
1260         PUSHSTACKi(PERLSI_MULTICALL);                                   \
1261         PUSHBLOCK(cx, (CXt_SUB|CXp_MULTICALL|flags), PL_stack_sp);      \
1262         PUSHSUB(cx);                                                    \
1263         cx->cx_old_savestack_ix = PL_savestack_ix;                      \
1264         SAVEVPTR(PL_op);                                                \
1265         if (!(flags & CXp_SUB_RE_FAKE))                                 \
1266             CvDEPTH(cv)++;                                              \
1267         if (CvDEPTH(cv) >= 2) {                                         \
1268             PERL_STACK_OVERFLOW_CHECK();                                \
1269             Perl_pad_push(aTHX_ padlist, CvDEPTH(cv));                  \
1270         }                                                               \
1271         PAD_SET_CUR_NOSAVE(padlist, CvDEPTH(cv));                       \
1272         multicall_cv = cv;                                              \
1273         multicall_cop = CvSTART(cv);                                    \
1274     } STMT_END
1275
1276 #define MULTICALL \
1277     STMT_START {                                                        \
1278         PL_op = multicall_cop;                                          \
1279         CALLRUNOPS(aTHX);                                               \
1280     } STMT_END
1281
1282 #define POP_MULTICALL \
1283     STMT_START {                                                        \
1284         cx = &cxstack[cxstack_ix];                                      \
1285         CvDEPTH(multicall_cv) = cx->blk_sub.olddepth;                   \
1286         CX_LEAVE_SCOPE(cx);                                             \
1287         /* includes partial unrolled POPSUB(): */                       \
1288         PL_comppad = cx->blk_sub.prevcomppad;                           \
1289         PL_curpad = LIKELY(PL_comppad) ? AvARRAY(PL_comppad) : NULL;    \
1290         SvREFCNT_dec_NN(multicall_cv);                                  \
1291         /* these two set for backcompat by callers */                   \
1292         newsp = PL_stack_base + cx->blk_oldsp;                          \
1293         gimme = cx->blk_gimme;                                          \
1294         POPBLOCK(cx);                                           \
1295         cxstack_ix--;                                                   \
1296         POPSTACK;                                                       \
1297         CATCH_SET(multicall_oldcatch);                                  \
1298         SPAGAIN;                                                        \
1299     } STMT_END
1300
1301 /* Change the CV of an already-pushed MULTICALL CxSUB block.
1302  * (this isn't part of the public API) */
1303
1304 #define CHANGE_MULTICALL_FLAGS(the_cv, flags) \
1305     STMT_START {                                                        \
1306         CV * const _nOnclAshIngNamE_ = the_cv;                          \
1307         CV * const cv = _nOnclAshIngNamE_;                              \
1308         PADLIST * const padlist = CvPADLIST(cv);                        \
1309         cx = &cxstack[cxstack_ix];                                      \
1310         assert(CxMULTICALL(cx));                                        \
1311         CvDEPTH(multicall_cv) = cx->blk_sub.olddepth;                   \
1312         SvREFCNT_dec_NN(multicall_cv);                                  \
1313         cx->cx_type = (CXt_SUB|CXp_MULTICALL|flags);                    \
1314         {                                                               \
1315             /* save a few things that we don't want PUSHSUB to zap */   \
1316             PAD * const prevcomppad = cx->blk_sub.prevcomppad;          \
1317             PUSHSUB(cx);                                                \
1318             /* undo the stuff that PUSHSUB zapped */                    \
1319             cx->blk_sub.prevcomppad = prevcomppad ;                     \
1320         }                                                               \
1321         if (!(flags & CXp_SUB_RE_FAKE))                                 \
1322             CvDEPTH(cv)++;                                              \
1323         if (CvDEPTH(cv) >= 2) {                                         \
1324             PERL_STACK_OVERFLOW_CHECK();                                \
1325             Perl_pad_push(aTHX_ padlist, CvDEPTH(cv));                  \
1326         }                                                               \
1327         PAD_SET_CUR_NOSAVE(padlist, CvDEPTH(cv));                       \
1328         multicall_cv = cv;                                              \
1329         multicall_cop = CvSTART(cv);                                    \
1330     } STMT_END
1331 /*
1332  * ex: set ts=8 sts=4 sw=4 et:
1333  */