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