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