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