cop.h

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