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