cop.h

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