cop.h

   1 /*    cop.h
   2  *
   3  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
   4  *    2000, 2001, 2002, 2003, 2004, 2005, 2006 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 three ops OP_NEXTSTATE, OP_DBSTATE,
  10  * and OP_SETSTATE that (loosely speaking) are separate statements.
  11  * They hold information important for lexical state and error reporting.
  12  * At run time, PL_curcop is set to point to the most recently executed cop,
  13  * and thus can be used to determine our current state.
  14  */
  15
  16 /* A jmpenv packages the state required to perform a proper non-local jump.
  17  * Note that there is a start_env initialized when perl starts, and top_env
  18  * points to this initially, so top_env should always be non-null.
  19  *
  20  * Existence of a non-null top_env->je_prev implies it is valid to call
  21  * longjmp() at that runlevel (we make sure start_env.je_prev is always
  22  * null to ensure this).
  23  *
  24  * je_mustcatch, when set at any runlevel to TRUE, means eval ops must
  25  * establish a local jmpenv to handle exception traps.  Care must be taken
  26  * to restore the previous value of je_mustcatch before exiting the
  27  * stack frame iff JMPENV_PUSH was not called in that stack frame.
  28  * GSAR 97-03-27
  29  */
  30
  31 struct jmpenv {
  32     struct jmpenv *     je_prev;
  33     Sigjmp_buf          je_buf;         /* only for use if !je_throw */
  34     int                 je_ret;         /* last exception thrown */
  35     bool                je_mustcatch;   /* need to call longjmp()? */
  36 };
  37
  38 typedef struct jmpenv JMPENV;
  39
  40 #ifdef OP_IN_REGISTER
  41 #define OP_REG_TO_MEM   PL_opsave = op
  42 #define OP_MEM_TO_REG   op = PL_opsave
  43 #else
  44 #define OP_REG_TO_MEM   NOOP
  45 #define OP_MEM_TO_REG   NOOP
  46 #endif
  47
  48 /*
  49  * How to build the first jmpenv.
  50  *
  51  * top_env needs to be non-zero. It points to an area
  52  * in which longjmp() stuff is stored, as C callstack
  53  * info there at least is thread specific this has to
  54  * be per-thread. Otherwise a 'die' in a thread gives
  55  * that thread the C stack of last thread to do an eval {}!
  56  */
  57
  58 #define JMPENV_BOOTSTRAP \
  59     STMT_START {                                \
  60         Zero(&PL_start_env, 1, JMPENV);         \
  61         PL_start_env.je_ret = -1;               \
  62         PL_start_env.je_mustcatch = TRUE;       \
  63         PL_top_env = &PL_start_env;             \
  64     } STMT_END
  65
  66 /*
  67  *   PERL_FLEXIBLE_EXCEPTIONS
  68  *
  69  * All the flexible exceptions code has been removed.
  70  * See the following threads for details:
  71  *
  72  *   http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2004-07/msg00378.html
  73  *
  74  * Joshua's original patches (which weren't applied) and discussion:
  75  *
  76  *   http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg01396.html
  77  *   http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg01489.html
  78  *   http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg01491.html
  79  *   http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg01608.html
  80  *   http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg02144.html
  81  *   http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1998-02/msg02998.html
  82  *
  83  * Chip's reworked patch and discussion:
  84  *
  85  *   http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/1999-03/msg00520.html
  86  *
  87  * The flaw in these patches (which went unnoticed at the time) was
  88  * that they moved some code that could potentially die() out of the
  89  * region protected by the setjmp()s.  This caused exceptions within
  90  * END blocks and such to not be handled by the correct setjmp().
  91  *
  92  * The original patches that introduces flexible exceptions were:
  93  *
  94  *   http://public.activestate.com/cgi-bin/perlbrowse?patch=3386
  95  *   http://public.activestate.com/cgi-bin/perlbrowse?patch=5162
  96  */
  97
  98 #define dJMPENV         JMPENV cur_env
  99
 100 #define JMPENV_PUSH(v) \
 101     STMT_START {                                                        \
 102         DEBUG_l(Perl_deb(aTHX_ "Setting up jumplevel %p, was %p\n",     \
 103                          (void*)&cur_env, (void*)PL_top_env));                  \
 104         cur_env.je_prev = PL_top_env;                                   \
 105         OP_REG_TO_MEM;                                                  \
 106         cur_env.je_ret = PerlProc_setjmp(cur_env.je_buf, SCOPE_SAVES_SIGNAL_MASK);              \
 107         OP_MEM_TO_REG;                                                  \
 108         PL_top_env = &cur_env;                                          \
 109         cur_env.je_mustcatch = FALSE;                                   \
 110         (v) = cur_env.je_ret;                                           \
 111     } STMT_END
 112
 113 #define JMPENV_POP \
 114     STMT_START {                                                        \
 115         DEBUG_l(Perl_deb(aTHX_ "popping jumplevel was %p, now %p\n",    \
 116                          (void*)PL_top_env, (void*)cur_env.je_prev));                   \
 117         PL_top_env = cur_env.je_prev;                                   \
 118     } STMT_END
 119
 120 #define JMPENV_JUMP(v) \
 121     STMT_START {                                                \
 122         OP_REG_TO_MEM;                                          \
 123         if (PL_top_env->je_prev)                                \
 124             PerlProc_longjmp(PL_top_env->je_buf, (v));          \
 125         if ((v) == 2)                                           \
 126             PerlProc_exit(STATUS_EXIT);                         \
 127         PerlIO_printf(PerlIO_stderr(), "panic: top_env\n");     \
 128         PerlProc_exit(1);                                       \
 129     } STMT_END
 130
 131 #define CATCH_GET               (PL_top_env->je_mustcatch)
 132 #define CATCH_SET(v)            (PL_top_env->je_mustcatch = (v))
 133
 134
 135
 136 struct cop {
 137     BASEOP
 138     char *      cop_label;      /* label for this construct */
 139 #ifdef USE_ITHREADS
 140     char *      cop_stashpv;    /* package line was compiled in */
 141     char *      cop_file;       /* file name the following line # is from */
 142 #else
 143     HV *        cop_stash;      /* package line was compiled in */
 144     GV *        cop_filegv;     /* file the following line # is from */
 145 #endif
 146     U32         cop_hints;      /* hints bits from pragmata */
 147     U32         cop_seq;        /* parse sequence number */
 148     line_t      cop_line;       /* line # of this command */
 149     /* Beware. mg.c and warnings.pl assume the type of this is STRLEN *:  */
 150     STRLEN *    cop_warnings;   /* lexical warnings bitmask */
 151     /* compile time state of %^H.  See the comment in op.c for how this is
 152        used to recreate a hash to return from caller.  */
 153     struct refcounted_he * cop_hints_hash;
 154 };
 155
 156 #ifdef USE_ITHREADS
 157 #  define CopFILE(c)            ((c)->cop_file)
 158 #  define CopFILEGV(c)          (CopFILE(c) \
 159                                  ? gv_fetchfile(CopFILE(c)) : NULL)
 160
 161 #  ifdef NETWARE
 162 #    define CopFILE_set(c,pv)   ((c)->cop_file = savepv(pv))
 163 #  else
 164 #    define CopFILE_set(c,pv)   ((c)->cop_file = savesharedpv(pv))
 165 #  endif
 166
 167 #  define CopFILESV(c)          (CopFILE(c) \
 168                                  ? GvSV(gv_fetchfile(CopFILE(c))) : NULL)
 169 #  define CopFILEAV(c)          (CopFILE(c) \
 170                                  ? GvAV(gv_fetchfile(CopFILE(c))) : NULL)
 171 #  ifdef DEBUGGING
 172 #    define CopFILEAVx(c)       (assert(CopFILE(c)), \
 173                                    GvAV(gv_fetchfile(CopFILE(c))))
 174 #  else
 175 #    define CopFILEAVx(c)       (GvAV(gv_fetchfile(CopFILE(c))))
 176 #  endif
 177 #  define CopSTASHPV(c)         ((c)->cop_stashpv)
 178
 179 #  ifdef NETWARE
 180 #    define CopSTASHPV_set(c,pv)        ((c)->cop_stashpv = ((pv) ? savepv(pv) : NULL))
 181 #  else
 182 #    define CopSTASHPV_set(c,pv)        ((c)->cop_stashpv = savesharedpv(pv))
 183 #  endif
 184
 185 #  define CopSTASH(c)           (CopSTASHPV(c) \
 186                                  ? gv_stashpv(CopSTASHPV(c),GV_ADD) : NULL)
 187 #  define CopSTASH_set(c,hv)    CopSTASHPV_set(c, (hv) ? HvNAME_get(hv) : NULL)
 188 #  define CopSTASH_eq(c,hv)     ((hv) && stashpv_hvname_match(c,hv))
 189 #  ifdef NETWARE
 190 #    define CopSTASH_free(c) SAVECOPSTASH_FREE(c)
 191 #    define CopFILE_free(c) SAVECOPFILE_FREE(c)
 192 #  else
 193 #    define CopSTASH_free(c)    PerlMemShared_free(CopSTASHPV(c))
 194 #    define CopFILE_free(c)     (PerlMemShared_free(CopFILE(c)),(CopFILE(c) = NULL))
 195 #  endif
 196 #else
 197 #  define CopFILEGV(c)          ((c)->cop_filegv)
 198 #  define CopFILEGV_set(c,gv)   ((c)->cop_filegv = (GV*)SvREFCNT_inc(gv))
 199 #  define CopFILE_set(c,pv)     CopFILEGV_set((c), gv_fetchfile(pv))
 200 #  define CopFILESV(c)          (CopFILEGV(c) ? GvSV(CopFILEGV(c)) : NULL)
 201 #  define CopFILEAV(c)          (CopFILEGV(c) ? GvAV(CopFILEGV(c)) : NULL)
 202 #  ifdef DEBUGGING
 203 #    define CopFILEAVx(c)       (assert(CopFILEGV(c)), GvAV(CopFILEGV(c)))
 204 #  else
 205 #    define CopFILEAVx(c)       (GvAV(CopFILEGV(c)))
 206 # endif
 207 #  define CopFILE(c)            (CopFILESV(c) ? SvPVX(CopFILESV(c)) : NULL)
 208 #  define CopSTASH(c)           ((c)->cop_stash)
 209 #  define CopSTASH_set(c,hv)    ((c)->cop_stash = (hv))
 210 #  define CopSTASHPV(c)         (CopSTASH(c) ? HvNAME_get(CopSTASH(c)) : NULL)
 211    /* cop_stash is not refcounted */
 212 #  define CopSTASHPV_set(c,pv)  CopSTASH_set((c), gv_stashpv(pv,GV_ADD))
 213 #  define CopSTASH_eq(c,hv)     (CopSTASH(c) == (hv))
 214 #  define CopSTASH_free(c)
 215 #  define CopFILE_free(c)       (SvREFCNT_dec(CopFILEGV(c)),(CopFILEGV(c) = NULL))
 216
 217 #endif /* USE_ITHREADS */
 218
 219 #define CopSTASH_ne(c,hv)       (!CopSTASH_eq(c,hv))
 220 #define CopLINE(c)              ((c)->cop_line)
 221 #define CopLINE_inc(c)          (++CopLINE(c))
 222 #define CopLINE_dec(c)          (--CopLINE(c))
 223 #define CopLINE_set(c,l)        (CopLINE(c) = (l))
 224
 225 /* OutCopFILE() is CopFILE for output (caller, die, warn, etc.) */
 226 #ifdef MACOS_TRADITIONAL
 227 #  define OutCopFILE(c) MacPerl_MPWFileName(CopFILE(c))
 228 #else
 229 #  define OutCopFILE(c) CopFILE(c)
 230 #endif
 231
 232 /* If $[ is non-zero, it's stored in cop_hints under the key "$[", and
 233    HINT_ARYBASE is set to indicate this.
 234    Setting it is ineficient due to the need to create 2 mortal SVs, but as
 235    using $[ is highly discouraged, no sane Perl code will be using it.  */
 236 #define CopARYBASE_get(c)       \
 237         ((CopHINTS_get(c) & HINT_ARYBASE)                               \
 238          ? SvIV(Perl_refcounted_he_fetch(aTHX_ (c)->cop_hints_hash, 0,  \
 239                                          "$[", 2, 0, 0))                \
 240          : 0)
 241 #define CopARYBASE_set(c, b) STMT_START { \
 242         if (b || ((c)->cop_hints & HINT_ARYBASE)) {                     \
 243             (c)->cop_hints |= HINT_ARYBASE;                             \
 244             if ((c) == &PL_compiling)                                   \
 245                 PL_hints |= HINT_LOCALIZE_HH | HINT_ARYBASE;            \
 246             (c)->cop_hints_hash                                         \
 247                = Perl_refcounted_he_new(aTHX_ (c)->cop_hints_hash,      \
 248                                         sv_2mortal(newSVpvs("$[")),     \
 249                                         sv_2mortal(newSViv(b)));        \
 250         }                                                               \
 251     } STMT_END
 252
 253 /* FIXME NATIVE_HINTS if this is changed from op_private (see perl.h)  */
 254 #define CopHINTS_get(c)         ((c)->cop_hints + 0)
 255 #define CopHINTS_set(c, h)      STMT_START {                            \
 256                                     (c)->cop_hints = (h);               \
 257                                 } STMT_END
 258
 259 /*
 260  * Here we have some enormously heavy (or at least ponderous) wizardry.
 261  */
 262
 263 /* subroutine context */
 264 struct block_sub {
 265     CV *        cv;
 266     GV *        gv;
 267     GV *        dfoutgv;
 268     AV *        savearray;
 269     AV *        argarray;
 270     I32         olddepth;
 271     U8          hasargs;
 272     U8          lval;           /* XXX merge lval and hasargs? */
 273     PAD         *oldcomppad;
 274     OP *        retop;  /* op to execute on exit from sub */
 275 };
 276
 277 #define CX_SUB_HASARGS_SET(cx, v)       ((cx)->blk_sub.hasargs = (v))
 278 #define CX_SUB_HASARGS_GET(cx)          ((cx)->blk_sub.hasargs + 0)
 279
 280 #define CX_SUB_LVAL_SET(cx, v)          ((cx)->blk_sub.lval = (v) &     \
 281                                          (OPpLVAL_INTRO|OPpENTERSUB_INARGS))
 282 #define CX_SUB_LVAL(cx)                 ((cx)->blk_sub.lval + 0)
 283 #define CX_SUB_LVAL_INARGS(cx)          ((cx)->blk_sub.lval &           \
 284                                          OPpENTERSUB_INARGS)
 285
 286 /* base for the next two macros. Don't use directly.
 287  * Note that the refcnt of the cv is incremented twice;  The CX one is
 288  * decremented by LEAVESUB, the other by LEAVE. */
 289
 290 #define PUSHSUB_BASE(cx)                                                \
 291         cx->blk_sub.cv = cv;                                            \
 292         cx->blk_sub.olddepth = CvDEPTH(cv);                             \
 293         CX_SUB_HASARGS_SET(cx, hasargs);                                \
 294         cx->blk_sub.retop = NULL;                                       \
 295         if (!CvDEPTH(cv)) {                                             \
 296             SvREFCNT_inc_simple_void_NN(cv);                            \
 297             SvREFCNT_inc_simple_void_NN(cv);                            \
 298             SAVEFREESV(cv);                                             \
 299         }
 300
 301
 302 #define PUSHSUB(cx)                                                     \
 303         PUSHSUB_BASE(cx)                                                \
 304         CX_SUB_LVAL_SET(cx, PL_op->op_private)
 305
 306 /* variant for use by OP_DBSTATE, where op_private holds hint bits */
 307 #define PUSHSUB_DB(cx)                                                  \
 308         PUSHSUB_BASE(cx)                                                \
 309         CX_SUB_LVAL_SET(cx, 0)
 310
 311
 312 #define PUSHFORMAT(cx)                                                  \
 313         cx->blk_sub.cv = cv;                                            \
 314         cx->blk_sub.gv = gv;                                            \
 315         cx->blk_sub.retop = NULL;                                       \
 316         CX_SUB_HASARGS_SET(cx, 0);                                      \
 317         cx->blk_sub.dfoutgv = PL_defoutgv;                              \
 318         SvREFCNT_inc_void(cx->blk_sub.dfoutgv)
 319
 320 #define POP_SAVEARRAY()                                         \
 321     STMT_START {                                                        \
 322         SvREFCNT_dec(GvAV(PL_defgv));                                   \
 323         GvAV(PL_defgv) = cx->blk_sub.savearray;                         \
 324     } STMT_END
 325
 326 /* junk in @_ spells trouble when cloning CVs and in pp_caller(), so don't
 327  * leave any (a fast av_clear(ary), basically) */
 328 #define CLEAR_ARGARRAY(ary) \
 329     STMT_START {                                                        \
 330         AvMAX(ary) += AvARRAY(ary) - AvALLOC(ary);                      \
 331         SvPV_set(ary, (char*)AvALLOC(ary));                             \
 332         AvFILLp(ary) = -1;                                              \
 333     } STMT_END
 334
 335 #define POPSUB(cx,sv)                                                   \
 336     STMT_START {                                                        \
 337         if (CX_SUB_HASARGS_GET(cx)) {                                   \
 338             POP_SAVEARRAY();                                            \
 339             /* abandon @_ if it got reified */                          \
 340             if (AvREAL(cx->blk_sub.argarray)) {                         \
 341                 const SSize_t fill = AvFILLp(cx->blk_sub.argarray);     \
 342                 SvREFCNT_dec(cx->blk_sub.argarray);                     \
 343                 cx->blk_sub.argarray = newAV();                         \
 344                 av_extend(cx->blk_sub.argarray, fill);                  \
 345                 AvREIFY_only(cx->blk_sub.argarray);                     \
 346                 CX_CURPAD_SV(cx->blk_sub, 0) = (SV*)cx->blk_sub.argarray;       \
 347             }                                                           \
 348             else {                                                      \
 349                 CLEAR_ARGARRAY(cx->blk_sub.argarray);                   \
 350             }                                                           \
 351         }                                                               \
 352         sv = (SV*)cx->blk_sub.cv;                                       \
 353         if (sv && (CvDEPTH((CV*)sv) = cx->blk_sub.olddepth))            \
 354             sv = NULL;                                          \
 355     } STMT_END
 356
 357 #define LEAVESUB(sv)                                                    \
 358     STMT_START {                                                        \
 359         if (sv)                                                         \
 360             SvREFCNT_dec(sv);                                           \
 361     } STMT_END
 362
 363 #define POPFORMAT(cx)                                                   \
 364         setdefout(cx->blk_sub.dfoutgv);                                 \
 365         SvREFCNT_dec(cx->blk_sub.dfoutgv);
 366
 367 /* eval context */
 368 struct block_eval {
 369     I32         old_in_eval;
 370     I32         old_op_type;
 371     SV *        old_namesv;
 372     OP *        old_eval_root;
 373     SV *        cur_text;
 374     CV *        cv;
 375     OP *        retop;  /* op to execute on exit from eval */
 376     JMPENV *    cur_top_env; /* value of PL_top_env when eval CX created */
 377 };
 378
 379 #define PUSHEVAL(cx,n,fgv)                                              \
 380     STMT_START {                                                        \
 381         cx->blk_eval.old_in_eval = PL_in_eval;                          \
 382         cx->blk_eval.old_op_type = PL_op->op_type;                      \
 383         cx->blk_eval.old_namesv = (n ? newSVpv(n,0) : NULL);            \
 384         cx->blk_eval.old_eval_root = PL_eval_root;                      \
 385         cx->blk_eval.cur_text = PL_linestr;                             \
 386         cx->blk_eval.cv = NULL; /* set by doeval(), as applicable */    \
 387         cx->blk_eval.retop = NULL;                                      \
 388         cx->blk_eval.cur_top_env = PL_top_env;                          \
 389     } STMT_END
 390
 391 #define POPEVAL(cx)                                                     \
 392     STMT_START {                                                        \
 393         PL_in_eval = cx->blk_eval.old_in_eval;                          \
 394         optype = cx->blk_eval.old_op_type;                              \
 395         PL_eval_root = cx->blk_eval.old_eval_root;                      \
 396         if (cx->blk_eval.old_namesv)                                    \
 397             sv_2mortal(cx->blk_eval.old_namesv);                        \
 398     } STMT_END
 399
 400 /* loop context */
 401 struct block_loop {
 402     char *      label;
 403     I32         resetsp;
 404     OP *        redo_op;
 405     OP *        next_op;
 406     OP *        last_op;
 407 #ifdef USE_ITHREADS
 408     void *      iterdata;
 409     PAD         *oldcomppad;
 410 #else
 411     SV **       itervar;
 412 #endif
 413     SV *        itersave;
 414     SV *        iterlval;
 415     AV *        iterary;
 416     IV          iterix;
 417     IV          itermax;
 418 };
 419
 420 #ifdef USE_ITHREADS
 421 #  define CxITERVAR(c)                                                  \
 422         ((c)->blk_loop.iterdata                                         \
 423          ? (CxPADLOOP(cx)                                               \
 424             ? &CX_CURPAD_SV( (c)->blk_loop,                             \
 425                     INT2PTR(PADOFFSET, (c)->blk_loop.iterdata))         \
 426             : &GvSV((GV*)(c)->blk_loop.iterdata))                       \
 427          : (SV**)NULL)
 428 #  define CX_ITERDATA_SET(cx,idata)                                     \
 429         CX_CURPAD_SAVE(cx->blk_loop);                                   \
 430         if ((cx->blk_loop.iterdata = (idata)))                          \
 431             cx->blk_loop.itersave = SvREFCNT_inc(*CxITERVAR(cx));       \
 432         else                                                            \
 433             cx->blk_loop.itersave = NULL;
 434 #else
 435 #  define CxITERVAR(c)          ((c)->blk_loop.itervar)
 436 #  define CX_ITERDATA_SET(cx,ivar)                                      \
 437         if ((cx->blk_loop.itervar = (SV**)(ivar)))                      \
 438             cx->blk_loop.itersave = SvREFCNT_inc(*CxITERVAR(cx));       \
 439         else                                                            \
 440             cx->blk_loop.itersave = NULL;
 441 #endif
 442
 443 #define PUSHLOOP(cx, dat, s)                                            \
 444         cx->blk_loop.label = PL_curcop->cop_label;                      \
 445         cx->blk_loop.resetsp = s - PL_stack_base;                       \
 446         cx->blk_loop.redo_op = cLOOP->op_redoop;                        \
 447         cx->blk_loop.next_op = cLOOP->op_nextop;                        \
 448         cx->blk_loop.last_op = cLOOP->op_lastop;                        \
 449         cx->blk_loop.iterlval = NULL;                                   \
 450         cx->blk_loop.iterary = NULL;                                    \
 451         cx->blk_loop.iterix = -1;                                       \
 452         CX_ITERDATA_SET(cx,dat);
 453
 454 #define POPLOOP(cx)                                                     \
 455         SvREFCNT_dec(cx->blk_loop.iterlval);                            \
 456         if (CxITERVAR(cx)) {                                            \
 457             if (SvPADMY(cx->blk_loop.itersave)) {                       \
 458                 SV ** const s_v_p = CxITERVAR(cx);                      \
 459                 sv_2mortal(*s_v_p);                                     \
 460                 *s_v_p = cx->blk_loop.itersave;                         \
 461             }                                                           \
 462             else {                                                      \
 463                 SvREFCNT_dec(cx->blk_loop.itersave);                    \
 464             }                                                           \
 465         }                                                               \
 466         if (cx->blk_loop.iterary && cx->blk_loop.iterary != PL_curstack)\
 467             SvREFCNT_dec(cx->blk_loop.iterary);
 468
 469 /* given/when context */
 470 struct block_givwhen {
 471         OP *leave_op;
 472 };
 473
 474 #define PUSHGIVEN(cx)                                                   \
 475         cx->blk_givwhen.leave_op = cLOGOP->op_other;
 476
 477 #define PUSHWHEN PUSHGIVEN
 478
 479 /* context common to subroutines, evals and loops */
 480 struct block {
 481     U16         blku_type;      /* what kind of context this is */
 482     U8          blku_gimme;     /* is this block running in list context? */
 483     I32         blku_oldsp;     /* stack pointer to copy stuff down to */
 484     COP *       blku_oldcop;    /* old curcop pointer */
 485     I32         blku_oldmarksp; /* mark stack index */
 486     I32         blku_oldscopesp;        /* scope stack index */
 487     PMOP *      blku_oldpm;     /* values of pattern match vars */
 488
 489     union {
 490         struct block_sub        blku_sub;
 491         struct block_eval       blku_eval;
 492         struct block_loop       blku_loop;
 493         struct block_givwhen    blku_givwhen;
 494     } blk_u;
 495 };
 496 #define blk_oldsp       cx_u.cx_blk.blku_oldsp
 497 #define blk_oldcop      cx_u.cx_blk.blku_oldcop
 498 #define blk_oldmarksp   cx_u.cx_blk.blku_oldmarksp
 499 #define blk_oldscopesp  cx_u.cx_blk.blku_oldscopesp
 500 #define blk_oldpm       cx_u.cx_blk.blku_oldpm
 501 #define blk_gimme       cx_u.cx_blk.blku_gimme
 502 #define blk_sub         cx_u.cx_blk.blk_u.blku_sub
 503 #define blk_eval        cx_u.cx_blk.blk_u.blku_eval
 504 #define blk_loop        cx_u.cx_blk.blk_u.blku_loop
 505 #define blk_givwhen     cx_u.cx_blk.blk_u.blku_givwhen
 506
 507 /* Enter a block. */
 508 #define PUSHBLOCK(cx,t,sp) CXINC, cx = &cxstack[cxstack_ix],            \
 509         cx->cx_type             = t,                                    \
 510         cx->blk_oldsp           = sp - PL_stack_base,                   \
 511         cx->blk_oldcop          = PL_curcop,                            \
 512         cx->blk_oldmarksp       = PL_markstack_ptr - PL_markstack,      \
 513         cx->blk_oldscopesp      = PL_scopestack_ix,                     \
 514         cx->blk_oldpm           = PL_curpm,                             \
 515         cx->blk_gimme           = (U8)gimme;                            \
 516         DEBUG_l( PerlIO_printf(Perl_debug_log, "Entering block %ld, type %s\n", \
 517                     (long)cxstack_ix, PL_block_type[CxTYPE(cx)]); )
 518
 519 /* Exit a block (RETURN and LAST). */
 520 #define POPBLOCK(cx,pm) cx = &cxstack[cxstack_ix--],                    \
 521         newsp            = PL_stack_base + cx->blk_oldsp,               \
 522         PL_curcop        = cx->blk_oldcop,                              \
 523         PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp,            \
 524         PL_scopestack_ix = cx->blk_oldscopesp,                          \
 525         pm               = cx->blk_oldpm,                               \
 526         gimme            = cx->blk_gimme;                               \
 527         DEBUG_SCOPE("POPBLOCK");                                        \
 528         DEBUG_l( PerlIO_printf(Perl_debug_log, "Leaving block %ld, type %s\n",          \
 529                     (long)cxstack_ix+1,PL_block_type[CxTYPE(cx)]); )
 530
 531 /* Continue a block elsewhere (NEXT and REDO). */
 532 #define TOPBLOCK(cx) cx  = &cxstack[cxstack_ix],                        \
 533         PL_stack_sp      = PL_stack_base + cx->blk_oldsp,               \
 534         PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp,            \
 535         PL_scopestack_ix = cx->blk_oldscopesp,                          \
 536         PL_curpm         = cx->blk_oldpm;                               \
 537         DEBUG_SCOPE("TOPBLOCK");
 538
 539 /* substitution context */
 540 struct subst {
 541     U16         sbu_type;       /* what kind of context this is */
 542     bool        sbu_once;
 543     bool        sbu_rxtainted;
 544     I32         sbu_iters;
 545     I32         sbu_maxiters;
 546     I32         sbu_rflags;
 547     I32         sbu_oldsave;
 548     char *      sbu_orig;
 549     SV *        sbu_dstr;
 550     SV *        sbu_targ;
 551     char *      sbu_s;
 552     char *      sbu_m;
 553     char *      sbu_strend;
 554     void *      sbu_rxres;
 555     REGEXP *    sbu_rx;
 556 };
 557 #define sb_iters        cx_u.cx_subst.sbu_iters
 558 #define sb_maxiters     cx_u.cx_subst.sbu_maxiters
 559 #define sb_rflags       cx_u.cx_subst.sbu_rflags
 560 #define sb_oldsave      cx_u.cx_subst.sbu_oldsave
 561 #define sb_once         cx_u.cx_subst.sbu_once
 562 #define sb_rxtainted    cx_u.cx_subst.sbu_rxtainted
 563 #define sb_orig         cx_u.cx_subst.sbu_orig
 564 #define sb_dstr         cx_u.cx_subst.sbu_dstr
 565 #define sb_targ         cx_u.cx_subst.sbu_targ
 566 #define sb_s            cx_u.cx_subst.sbu_s
 567 #define sb_m            cx_u.cx_subst.sbu_m
 568 #define sb_strend       cx_u.cx_subst.sbu_strend
 569 #define sb_rxres        cx_u.cx_subst.sbu_rxres
 570 #define sb_rx           cx_u.cx_subst.sbu_rx
 571
 572 #define PUSHSUBST(cx) CXINC, cx = &cxstack[cxstack_ix],                 \
 573         cx->sb_iters            = iters,                                \
 574         cx->sb_maxiters         = maxiters,                             \
 575         cx->sb_rflags           = r_flags,                              \
 576         cx->sb_oldsave          = oldsave,                              \
 577         cx->sb_once             = once,                                 \
 578         cx->sb_rxtainted        = rxtainted,                            \
 579         cx->sb_orig             = orig,                                 \
 580         cx->sb_dstr             = dstr,                                 \
 581         cx->sb_targ             = targ,                                 \
 582         cx->sb_s                = s,                                    \
 583         cx->sb_m                = m,                                    \
 584         cx->sb_strend           = strend,                               \
 585         cx->sb_rxres            = NULL,                                 \
 586         cx->sb_rx               = rx,                                   \
 587         cx->cx_type             = CXt_SUBST;                            \
 588         rxres_save(&cx->sb_rxres, rx);                                  \
 589         (void)ReREFCNT_inc(rx)
 590
 591 #define POPSUBST(cx) cx = &cxstack[cxstack_ix--];                       \
 592         rxres_free(&cx->sb_rxres);                                      \
 593         ReREFCNT_dec(cx->sb_rx)
 594
 595 struct context {
 596     union {
 597         struct block    cx_blk;
 598         struct subst    cx_subst;
 599     } cx_u;
 600 };
 601 #define cx_type cx_u.cx_subst.sbu_type
 602
 603 #define CXTYPEMASK      0xff
 604 #define CXt_NULL        0
 605 #define CXt_SUB         1
 606 #define CXt_EVAL        2
 607 #define CXt_LOOP        3
 608 #define CXt_SUBST       4
 609 #define CXt_BLOCK       5
 610 #define CXt_FORMAT      6
 611 #define CXt_GIVEN       7
 612 #define CXt_WHEN        8
 613
 614 /* private flags for CXt_SUB and CXt_NULL */
 615 #define CXp_MULTICALL   0x00000400      /* part of a multicall (so don't
 616                                            tear down context on exit). */
 617
 618 /* private flags for CXt_EVAL */
 619 #define CXp_REAL        0x00000100      /* truly eval'', not a lookalike */
 620 #define CXp_TRYBLOCK    0x00000200      /* eval{}, not eval'' or similar */
 621
 622 /* private flags for CXt_LOOP */
 623 #define CXp_FOREACH     0x00000200      /* a foreach loop */
 624 #define CXp_FOR_DEF     0x00000400      /* foreach using $_ */
 625 #ifdef USE_ITHREADS
 626 #  define CXp_PADVAR    0x00000100      /* itervar lives on pad, iterdata
 627                                            has pad offset; if not set,
 628                                            iterdata holds GV* */
 629 #  define CxPADLOOP(c)  (((c)->cx_type & (CXt_LOOP|CXp_PADVAR))         \
 630                          == (CXt_LOOP|CXp_PADVAR))
 631 #endif
 632
 633 #define CxTYPE(c)       ((c)->cx_type & CXTYPEMASK)
 634 #define CxMULTICALL(c)  (((c)->cx_type & CXp_MULTICALL)                 \
 635                          == CXp_MULTICALL)
 636 #define CxREALEVAL(c)   (((c)->cx_type & (CXt_EVAL|CXp_REAL))           \
 637                          == (CXt_EVAL|CXp_REAL))
 638 #define CxTRYBLOCK(c)   (((c)->cx_type & (CXt_EVAL|CXp_TRYBLOCK))       \
 639                          == (CXt_EVAL|CXp_TRYBLOCK))
 640 #define CxFOREACH(c)    (((c)->cx_type & (CXt_LOOP|CXp_FOREACH))        \
 641                          == (CXt_LOOP|CXp_FOREACH))
 642 #define CxFOREACHDEF(c) (((c)->cx_type & (CXt_LOOP|CXp_FOREACH|CXp_FOR_DEF))\
 643                          == (CXt_LOOP|CXp_FOREACH|CXp_FOR_DEF))
 644
 645 #define CXINC (cxstack_ix < cxstack_max ? ++cxstack_ix : (cxstack_ix = cxinc()))
 646
 647 /*
 648 =head1 "Gimme" Values
 649 */
 650
 651 /*
 652 =for apidoc AmU||G_SCALAR
 653 Used to indicate scalar context.  See C<GIMME_V>, C<GIMME>, and
 654 L<perlcall>.
 655
 656 =for apidoc AmU||G_ARRAY
 657 Used to indicate list context.  See C<GIMME_V>, C<GIMME> and
 658 L<perlcall>.
 659
 660 =for apidoc AmU||G_VOID
 661 Used to indicate void context.  See C<GIMME_V> and L<perlcall>.
 662
 663 =for apidoc AmU||G_DISCARD
 664 Indicates that arguments returned from a callback should be discarded.  See
 665 L<perlcall>.
 666
 667 =for apidoc AmU||G_EVAL
 668
 669 Used to force a Perl C<eval> wrapper around a callback.  See
 670 L<perlcall>.
 671
 672 =for apidoc AmU||G_NOARGS
 673
 674 Indicates that no arguments are being sent to a callback.  See
 675 L<perlcall>.
 676
 677 =cut
 678 */
 679
 680 #define G_SCALAR        0
 681 #define G_ARRAY         1
 682 #define G_VOID          128     /* skip this bit when adding flags below */
 683
 684 /* extra flags for Perl_call_* routines */
 685 #define G_DISCARD       2       /* Call FREETMPS. */
 686 #define G_EVAL          4       /* Assume eval {} around subroutine call. */
 687 #define G_NOARGS        8       /* Don't construct a @_ array. */
 688 #define G_KEEPERR      16       /* Append errors to $@, don't overwrite it */
 689 #define G_NODEBUG      32       /* Disable debugging at toplevel.  */
 690 #define G_METHOD       64       /* Calling method. */
 691 #define G_FAKINGEVAL  256       /* Faking en eval context for call_sv or
 692                                    fold_constants. */
 693
 694 /* flag bits for PL_in_eval */
 695 #define EVAL_NULL       0       /* not in an eval */
 696 #define EVAL_INEVAL     1       /* some enclosing scope is an eval */
 697 #define EVAL_WARNONLY   2       /* used by yywarn() when calling yyerror() */
 698 #define EVAL_KEEPERR    4       /* set by Perl_call_sv if G_KEEPERR */
 699 #define EVAL_INREQUIRE  8       /* The code is being required. */
 700
 701 /* Support for switching (stack and block) contexts.
 702  * This ensures magic doesn't invalidate local stack and cx pointers.
 703  */
 704
 705 #define PERLSI_UNKNOWN          -1
 706 #define PERLSI_UNDEF            0
 707 #define PERLSI_MAIN             1
 708 #define PERLSI_MAGIC            2
 709 #define PERLSI_SORT             3
 710 #define PERLSI_SIGNAL           4
 711 #define PERLSI_OVERLOAD         5
 712 #define PERLSI_DESTROY          6
 713 #define PERLSI_WARNHOOK         7
 714 #define PERLSI_DIEHOOK          8
 715 #define PERLSI_REQUIRE          9
 716
 717 struct stackinfo {
 718     AV *                si_stack;       /* stack for current runlevel */
 719     PERL_CONTEXT *      si_cxstack;     /* context stack for runlevel */
 720     I32                 si_cxix;        /* current context index */
 721     I32                 si_cxmax;       /* maximum allocated index */
 722     I32                 si_type;        /* type of runlevel */
 723     struct stackinfo *  si_prev;
 724     struct stackinfo *  si_next;
 725     I32                 si_markoff;     /* offset where markstack begins for us.
 726                                          * currently used only with DEBUGGING,
 727                                          * but not #ifdef-ed for bincompat */
 728 };
 729
 730 typedef struct stackinfo PERL_SI;
 731
 732 #define cxstack         (PL_curstackinfo->si_cxstack)
 733 #define cxstack_ix      (PL_curstackinfo->si_cxix)
 734 #define cxstack_max     (PL_curstackinfo->si_cxmax)
 735
 736 #ifdef DEBUGGING
 737 #  define       SET_MARK_OFFSET \
 738     PL_curstackinfo->si_markoff = PL_markstack_ptr - PL_markstack
 739 #else
 740 #  define       SET_MARK_OFFSET NOOP
 741 #endif
 742
 743 #define PUSHSTACKi(type) \
 744     STMT_START {                                                        \
 745         PERL_SI *next = PL_curstackinfo->si_next;                       \
 746         if (!next) {                                                    \
 747             next = new_stackinfo(32, 2048/sizeof(PERL_CONTEXT) - 1);    \
 748             next->si_prev = PL_curstackinfo;                            \
 749             PL_curstackinfo->si_next = next;                            \
 750         }                                                               \
 751         next->si_type = type;                                           \
 752         next->si_cxix = -1;                                             \
 753         AvFILLp(next->si_stack) = 0;                                    \
 754         SWITCHSTACK(PL_curstack,next->si_stack);                        \
 755         PL_curstackinfo = next;                                         \
 756         SET_MARK_OFFSET;                                                \
 757     } STMT_END
 758
 759 #define PUSHSTACK PUSHSTACKi(PERLSI_UNKNOWN)
 760
 761 /* POPSTACK works with PL_stack_sp, so it may need to be bracketed by
 762  * PUTBACK/SPAGAIN to flush/refresh any local SP that may be active */
 763 #define POPSTACK \
 764     STMT_START {                                                        \
 765         dSP;                                                            \
 766         PERL_SI * const prev = PL_curstackinfo->si_prev;                \
 767         if (!prev) {                                                    \
 768             PerlIO_printf(Perl_error_log, "panic: POPSTACK\n");         \
 769             my_exit(1);                                                 \
 770         }                                                               \
 771         SWITCHSTACK(PL_curstack,prev->si_stack);                        \
 772         /* don't free prev here, free them all at the END{} */          \
 773         PL_curstackinfo = prev;                                         \
 774     } STMT_END
 775
 776 #define POPSTACK_TO(s) \
 777     STMT_START {                                                        \
 778         while (PL_curstack != s) {                                      \
 779             dounwind(-1);                                               \
 780             POPSTACK;                                                   \
 781         }                                                               \
 782     } STMT_END
 783
 784 #define IN_PERL_COMPILETIME     (PL_curcop == &PL_compiling)
 785 #define IN_PERL_RUNTIME         (PL_curcop != &PL_compiling)
 786
 787 /*
 788 =head1 Multicall Functions
 789
 790 =for apidoc Ams||dMULTICALL
 791 Declare local variables for a multicall. See L<perlcall/Lightweight Callbacks>.
 792
 793 =for apidoc Ams||PUSH_MULTICALL
 794 Opening bracket for a lightweight callback.
 795 See L<perlcall/Lightweight Callbacks>.
 796
 797 =for apidoc Ams||MULTICALL
 798 Make a lightweight callback. See L<perlcall/Lightweight Callbacks>.
 799
 800 =for apidoc Ams||POP_MULTICALL
 801 Closing bracket for a lightweight callback.
 802 See L<perlcall/Lightweight Callbacks>.
 803
 804 =cut
 805 */
 806
 807 #define dMULTICALL \
 808     SV **newsp;                 /* set by POPBLOCK */                   \
 809     PERL_CONTEXT *cx;                                                   \
 810     CV *multicall_cv;                                                   \
 811     OP *multicall_cop;                                                  \
 812     bool multicall_oldcatch;                                            \
 813     U8 hasargs = 0              /* used by PUSHSUB */
 814
 815 #define PUSH_MULTICALL(the_cv) \
 816     STMT_START {                                                        \
 817         CV * const _nOnclAshIngNamE_ = the_cv;                          \
 818         CV * const cv = _nOnclAshIngNamE_;                              \
 819         AV * const padlist = CvPADLIST(cv);                             \
 820         ENTER;                                                          \
 821         multicall_oldcatch = CATCH_GET;                                 \
 822         SAVETMPS; SAVEVPTR(PL_op);                                      \
 823         CATCH_SET(TRUE);                                                \
 824         PUSHBLOCK(cx, CXt_SUB|CXp_MULTICALL, PL_stack_sp);              \
 825         PUSHSUB(cx);                                                    \
 826         if (++CvDEPTH(cv) >= 2) {                                       \
 827             PERL_STACK_OVERFLOW_CHECK();                                \
 828             Perl_pad_push(aTHX_ padlist, CvDEPTH(cv));                  \
 829         }                                                               \
 830         SAVECOMPPAD();                                                  \
 831         PAD_SET_CUR_NOSAVE(padlist, CvDEPTH(cv));                       \
 832         multicall_cv = cv;                                              \
 833         multicall_cop = CvSTART(cv);                                    \
 834     } STMT_END
 835
 836 #define MULTICALL \
 837     STMT_START {                                                        \
 838         PL_op = multicall_cop;                                          \
 839         CALLRUNOPS(aTHX);                                               \
 840     } STMT_END
 841
 842 #define POP_MULTICALL \
 843     STMT_START {                                                        \
 844         LEAVESUB(multicall_cv);                                         \
 845         CvDEPTH(multicall_cv)--;                                        \
 846         POPBLOCK(cx,PL_curpm);                                          \
 847         CATCH_SET(multicall_oldcatch);                                  \
 848         LEAVE;                                                          \
 849     } STMT_END
 850
 851 /*
 852  * Local variables:
 853  * c-indentation-style: bsd
 854  * c-basic-offset: 4
 855  * indent-tabs-mode: t
 856  * End:
 857  *
 858  * ex: set ts=8 sts=4 sw=4 noet:
 859  */