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                          &cur_env, 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                          PL_top_env, 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_seq;        /* parse sequence number */
 147     I32         cop_arybase;    /* array base this line was compiled with */
 148     line_t      cop_line;       /* line # of this command */
 149     SV *        cop_warnings;   /* lexical warnings bitmask */
 150     SV *        cop_io;         /* lexical IO defaults */
 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;
 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 /* CopARYBASE is likely to be removed soon.  */
 233 #define CopARYBASE(c)           ((c)->cop_arybase)
 234 #define CopARYBASE_get(c)       ((c)->cop_arybase + 0)
 235 #define CopARYBASE_set(c, b)    STMT_START { (c)->cop_arybase = (b); } STMT_END
 236
 237 /* FIXME NATIVE_HINTS if this is changed from op_private (see perl.h)  */
 238 #define CopHINTS_get(c)         ((c)->op_private + 0)
 239 #define CopHINTS_set(c, h)      STMT_START {                            \
 240                                     (c)->op_private                     \
 241                                          = (U8)((h) & HINT_PRIVATE_MASK); \
 242                                 } STMT_END
 243
 244 /*
 245  * Here we have some enormously heavy (or at least ponderous) wizardry.
 246  */
 247
 248 /* subroutine context */
 249 struct block_sub {
 250     CV *        cv;
 251     GV *        gv;
 252     GV *        dfoutgv;
 253     AV *        savearray;
 254     AV *        argarray;
 255     I32         olddepth;
 256     U8          hasargs;
 257     U8          lval;           /* XXX merge lval and hasargs? */
 258     PAD         *oldcomppad;
 259     OP *        retop;  /* op to execute on exit from sub */
 260 };
 261
 262 /* base for the next two macros. Don't use directly.
 263  * Note that the refcnt of the cv is incremented twice;  The CX one is
 264  * decremented by LEAVESUB, the other by LEAVE. */
 265
 266 #define PUSHSUB_BASE(cx)                                                \
 267         cx->blk_sub.cv = cv;                                            \
 268         cx->blk_sub.olddepth = CvDEPTH(cv);                             \
 269         cx->blk_sub.hasargs = hasargs;                                  \
 270         cx->blk_sub.retop = NULL;                                       \
 271         if (!CvDEPTH(cv)) {                                             \
 272             SvREFCNT_inc_void(cv);                                      \
 273             SvREFCNT_inc_void(cv);                                      \
 274             SAVEFREESV(cv);                                             \
 275         }
 276
 277
 278 #define PUSHSUB(cx)                                                     \
 279         PUSHSUB_BASE(cx)                                                \
 280         cx->blk_sub.lval = PL_op->op_private &                          \
 281                               (OPpLVAL_INTRO|OPpENTERSUB_INARGS);
 282
 283 /* variant for use by OP_DBSTATE, where op_private holds hint bits */
 284 #define PUSHSUB_DB(cx)                                                  \
 285         PUSHSUB_BASE(cx)                                                \
 286         cx->blk_sub.lval = 0;
 287
 288
 289 #define PUSHFORMAT(cx)                                                  \
 290         cx->blk_sub.cv = cv;                                            \
 291         cx->blk_sub.gv = gv;                                            \
 292         cx->blk_sub.retop = NULL;                                       \
 293         cx->blk_sub.hasargs = 0;                                        \
 294         cx->blk_sub.dfoutgv = PL_defoutgv;                              \
 295         SvREFCNT_inc_void(cx->blk_sub.dfoutgv)
 296
 297 #define POP_SAVEARRAY()                                         \
 298     STMT_START {                                                        \
 299         SvREFCNT_dec(GvAV(PL_defgv));                                   \
 300         GvAV(PL_defgv) = cx->blk_sub.savearray;                         \
 301     } STMT_END
 302
 303 /* junk in @_ spells trouble when cloning CVs and in pp_caller(), so don't
 304  * leave any (a fast av_clear(ary), basically) */
 305 #define CLEAR_ARGARRAY(ary) \
 306     STMT_START {                                                        \
 307         AvMAX(ary) += AvARRAY(ary) - AvALLOC(ary);                      \
 308         SvPV_set(ary, (char*)AvALLOC(ary));                             \
 309         AvFILLp(ary) = -1;                                              \
 310     } STMT_END
 311
 312 #define POPSUB(cx,sv)                                                   \
 313     STMT_START {                                                        \
 314         if (cx->blk_sub.hasargs) {                                      \
 315             POP_SAVEARRAY();                                            \
 316             /* abandon @_ if it got reified */                          \
 317             if (AvREAL(cx->blk_sub.argarray)) {                         \
 318                 SSize_t fill = AvFILLp(cx->blk_sub.argarray);           \
 319                 SvREFCNT_dec(cx->blk_sub.argarray);                     \
 320                 cx->blk_sub.argarray = newAV();                         \
 321                 av_extend(cx->blk_sub.argarray, fill);                  \
 322                 AvREIFY_only(cx->blk_sub.argarray);                     \
 323                 CX_CURPAD_SV(cx->blk_sub, 0) = (SV*)cx->blk_sub.argarray;       \
 324             }                                                           \
 325             else {                                                      \
 326                 CLEAR_ARGARRAY(cx->blk_sub.argarray);                   \
 327             }                                                           \
 328         }                                                               \
 329         sv = (SV*)cx->blk_sub.cv;                                       \
 330         if (sv && (CvDEPTH((CV*)sv) = cx->blk_sub.olddepth))            \
 331             sv = NULL;                                          \
 332     } STMT_END
 333
 334 #define LEAVESUB(sv)                                                    \
 335     STMT_START {                                                        \
 336         if (sv)                                                         \
 337             SvREFCNT_dec(sv);                                           \
 338     } STMT_END
 339
 340 #define POPFORMAT(cx)                                                   \
 341         setdefout(cx->blk_sub.dfoutgv);                                 \
 342         SvREFCNT_dec(cx->blk_sub.dfoutgv);
 343
 344 /* eval context */
 345 struct block_eval {
 346     I32         old_in_eval;
 347     I32         old_op_type;
 348     SV *        old_namesv;
 349     OP *        old_eval_root;
 350     SV *        cur_text;
 351     CV *        cv;
 352     OP *        retop;  /* op to execute on exit from eval */
 353     JMPENV *    cur_top_env; /* value of PL_top_env when eval CX created */
 354 };
 355
 356 #define PUSHEVAL(cx,n,fgv)                                              \
 357     STMT_START {                                                        \
 358         cx->blk_eval.old_in_eval = PL_in_eval;                          \
 359         cx->blk_eval.old_op_type = PL_op->op_type;                      \
 360         cx->blk_eval.old_namesv = (n ? newSVpv(n,0) : NULL);            \
 361         cx->blk_eval.old_eval_root = PL_eval_root;                      \
 362         cx->blk_eval.cur_text = PL_linestr;                             \
 363         cx->blk_eval.cv = NULL; /* set by doeval(), as applicable */    \
 364         cx->blk_eval.retop = NULL;                                      \
 365         cx->blk_eval.cur_top_env = PL_top_env;                          \
 366     } STMT_END
 367
 368 #define POPEVAL(cx)                                                     \
 369     STMT_START {                                                        \
 370         PL_in_eval = cx->blk_eval.old_in_eval;                          \
 371         optype = cx->blk_eval.old_op_type;                              \
 372         PL_eval_root = cx->blk_eval.old_eval_root;                      \
 373         if (cx->blk_eval.old_namesv)                                    \
 374             sv_2mortal(cx->blk_eval.old_namesv);                        \
 375     } STMT_END
 376
 377 /* loop context */
 378 struct block_loop {
 379     char *      label;
 380     I32         resetsp;
 381     OP *        redo_op;
 382     OP *        next_op;
 383     OP *        last_op;
 384 #ifdef USE_ITHREADS
 385     void *      iterdata;
 386     PAD         *oldcomppad;
 387 #else
 388     SV **       itervar;
 389 #endif
 390     SV *        itersave;
 391     SV *        iterlval;
 392     AV *        iterary;
 393     IV          iterix;
 394     IV          itermax;
 395 };
 396
 397 #ifdef USE_ITHREADS
 398 #  define CxITERVAR(c)                                                  \
 399         ((c)->blk_loop.iterdata                                         \
 400          ? (CxPADLOOP(cx)                                               \
 401             ? &CX_CURPAD_SV( (c)->blk_loop,                             \
 402                     INT2PTR(PADOFFSET, (c)->blk_loop.iterdata))         \
 403             : &GvSV((GV*)(c)->blk_loop.iterdata))                       \
 404          : (SV**)NULL)
 405 #  define CX_ITERDATA_SET(cx,idata)                                     \
 406         CX_CURPAD_SAVE(cx->blk_loop);                                   \
 407         if ((cx->blk_loop.iterdata = (idata)))                          \
 408             cx->blk_loop.itersave = SvREFCNT_inc(*CxITERVAR(cx));       \
 409         else                                                            \
 410             cx->blk_loop.itersave = NULL;
 411 #else
 412 #  define CxITERVAR(c)          ((c)->blk_loop.itervar)
 413 #  define CX_ITERDATA_SET(cx,ivar)                                      \
 414         if ((cx->blk_loop.itervar = (SV**)(ivar)))                      \
 415             cx->blk_loop.itersave = SvREFCNT_inc(*CxITERVAR(cx));       \
 416         else                                                            \
 417             cx->blk_loop.itersave = NULL;
 418 #endif
 419
 420 #define PUSHLOOP(cx, dat, s)                                            \
 421         cx->blk_loop.label = PL_curcop->cop_label;                      \
 422         cx->blk_loop.resetsp = s - PL_stack_base;                       \
 423         cx->blk_loop.redo_op = cLOOP->op_redoop;                        \
 424         cx->blk_loop.next_op = cLOOP->op_nextop;                        \
 425         cx->blk_loop.last_op = cLOOP->op_lastop;                        \
 426         cx->blk_loop.iterlval = NULL;                                   \
 427         cx->blk_loop.iterary = NULL;                                    \
 428         cx->blk_loop.iterix = -1;                                       \
 429         CX_ITERDATA_SET(cx,dat);
 430
 431 #define POPLOOP(cx)                                                     \
 432         SvREFCNT_dec(cx->blk_loop.iterlval);                            \
 433         if (CxITERVAR(cx)) {                                            \
 434             if (SvPADMY(cx->blk_loop.itersave)) {                       \
 435                 SV ** const s_v_p = CxITERVAR(cx);                      \
 436                 sv_2mortal(*s_v_p);                                     \
 437                 *s_v_p = cx->blk_loop.itersave;                         \
 438             }                                                           \
 439             else {                                                      \
 440                 SvREFCNT_dec(cx->blk_loop.itersave);                    \
 441             }                                                           \
 442         }                                                               \
 443         if (cx->blk_loop.iterary && cx->blk_loop.iterary != PL_curstack)\
 444             SvREFCNT_dec(cx->blk_loop.iterary);
 445
 446 /* given/when context */
 447 struct block_givwhen {
 448         OP *leave_op;
 449 };
 450
 451 #define PUSHGIVEN(cx)                                                   \
 452         cx->blk_givwhen.leave_op = cLOGOP->op_other;
 453
 454 #define PUSHWHEN PUSHGIVEN
 455
 456 /* context common to subroutines, evals and loops */
 457 struct block {
 458     I32         blku_oldsp;     /* stack pointer to copy stuff down to */
 459     COP *       blku_oldcop;    /* old curcop pointer */
 460     I32         blku_oldmarksp; /* mark stack index */
 461     I32         blku_oldscopesp;        /* scope stack index */
 462     PMOP *      blku_oldpm;     /* values of pattern match vars */
 463     U8          blku_gimme;     /* is this block running in list context? */
 464
 465     union {
 466         struct block_sub        blku_sub;
 467         struct block_eval       blku_eval;
 468         struct block_loop       blku_loop;
 469         struct block_givwhen    blku_givwhen;
 470     } blk_u;
 471 };
 472 #define blk_oldsp       cx_u.cx_blk.blku_oldsp
 473 #define blk_oldcop      cx_u.cx_blk.blku_oldcop
 474 #define blk_oldmarksp   cx_u.cx_blk.blku_oldmarksp
 475 #define blk_oldscopesp  cx_u.cx_blk.blku_oldscopesp
 476 #define blk_oldpm       cx_u.cx_blk.blku_oldpm
 477 #define blk_gimme       cx_u.cx_blk.blku_gimme
 478 #define blk_sub         cx_u.cx_blk.blk_u.blku_sub
 479 #define blk_eval        cx_u.cx_blk.blk_u.blku_eval
 480 #define blk_loop        cx_u.cx_blk.blk_u.blku_loop
 481 #define blk_givwhen     cx_u.cx_blk.blk_u.blku_givwhen
 482
 483 /* Enter a block. */
 484 #define PUSHBLOCK(cx,t,sp) CXINC, cx = &cxstack[cxstack_ix],            \
 485         cx->cx_type             = t,                                    \
 486         cx->blk_oldsp           = sp - PL_stack_base,                   \
 487         cx->blk_oldcop          = PL_curcop,                            \
 488         cx->blk_oldmarksp       = PL_markstack_ptr - PL_markstack,      \
 489         cx->blk_oldscopesp      = PL_scopestack_ix,                     \
 490         cx->blk_oldpm           = PL_curpm,                             \
 491         cx->blk_gimme           = (U8)gimme;                            \
 492         DEBUG_l( PerlIO_printf(Perl_debug_log, "Entering block %ld, type %s\n", \
 493                     (long)cxstack_ix, PL_block_type[CxTYPE(cx)]); )
 494
 495 /* Exit a block (RETURN and LAST). */
 496 #define POPBLOCK(cx,pm) cx = &cxstack[cxstack_ix--],                    \
 497         newsp            = PL_stack_base + cx->blk_oldsp,               \
 498         PL_curcop        = cx->blk_oldcop,                              \
 499         PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp,            \
 500         PL_scopestack_ix = cx->blk_oldscopesp,                          \
 501         pm               = cx->blk_oldpm,                               \
 502         gimme            = cx->blk_gimme;                               \
 503         DEBUG_SCOPE("POPBLOCK");                                        \
 504         DEBUG_l( PerlIO_printf(Perl_debug_log, "Leaving block %ld, type %s\n",          \
 505                     (long)cxstack_ix+1,PL_block_type[CxTYPE(cx)]); )
 506
 507 /* Continue a block elsewhere (NEXT and REDO). */
 508 #define TOPBLOCK(cx) cx  = &cxstack[cxstack_ix],                        \
 509         PL_stack_sp      = PL_stack_base + cx->blk_oldsp,               \
 510         PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp,            \
 511         PL_scopestack_ix = cx->blk_oldscopesp,                          \
 512         PL_curpm         = cx->blk_oldpm;                               \
 513         DEBUG_SCOPE("TOPBLOCK");
 514
 515 /* substitution context */
 516 struct subst {
 517     I32         sbu_iters;
 518     I32         sbu_maxiters;
 519     I32         sbu_rflags;
 520     I32         sbu_oldsave;
 521     bool        sbu_once;
 522     bool        sbu_rxtainted;
 523     char *      sbu_orig;
 524     SV *        sbu_dstr;
 525     SV *        sbu_targ;
 526     char *      sbu_s;
 527     char *      sbu_m;
 528     char *      sbu_strend;
 529     void *      sbu_rxres;
 530     REGEXP *    sbu_rx;
 531 };
 532 #define sb_iters        cx_u.cx_subst.sbu_iters
 533 #define sb_maxiters     cx_u.cx_subst.sbu_maxiters
 534 #define sb_rflags       cx_u.cx_subst.sbu_rflags
 535 #define sb_oldsave      cx_u.cx_subst.sbu_oldsave
 536 #define sb_once         cx_u.cx_subst.sbu_once
 537 #define sb_rxtainted    cx_u.cx_subst.sbu_rxtainted
 538 #define sb_orig         cx_u.cx_subst.sbu_orig
 539 #define sb_dstr         cx_u.cx_subst.sbu_dstr
 540 #define sb_targ         cx_u.cx_subst.sbu_targ
 541 #define sb_s            cx_u.cx_subst.sbu_s
 542 #define sb_m            cx_u.cx_subst.sbu_m
 543 #define sb_strend       cx_u.cx_subst.sbu_strend
 544 #define sb_rxres        cx_u.cx_subst.sbu_rxres
 545 #define sb_rx           cx_u.cx_subst.sbu_rx
 546
 547 #define PUSHSUBST(cx) CXINC, cx = &cxstack[cxstack_ix],                 \
 548         cx->sb_iters            = iters,                                \
 549         cx->sb_maxiters         = maxiters,                             \
 550         cx->sb_rflags           = r_flags,                              \
 551         cx->sb_oldsave          = oldsave,                              \
 552         cx->sb_once             = once,                                 \
 553         cx->sb_rxtainted        = rxtainted,                            \
 554         cx->sb_orig             = orig,                                 \
 555         cx->sb_dstr             = dstr,                                 \
 556         cx->sb_targ             = targ,                                 \
 557         cx->sb_s                = s,                                    \
 558         cx->sb_m                = m,                                    \
 559         cx->sb_strend           = strend,                               \
 560         cx->sb_rxres            = NULL,                                 \
 561         cx->sb_rx               = rx,                                   \
 562         cx->cx_type             = CXt_SUBST;                            \
 563         rxres_save(&cx->sb_rxres, rx)
 564
 565 #define POPSUBST(cx) cx = &cxstack[cxstack_ix--];                       \
 566         rxres_free(&cx->sb_rxres)
 567
 568 struct context {
 569     U32         cx_type;        /* what kind of context this is */
 570     union {
 571         struct block    cx_blk;
 572         struct subst    cx_subst;
 573     } cx_u;
 574 };
 575
 576 #define CXTYPEMASK      0xff
 577 #define CXt_NULL        0
 578 #define CXt_SUB         1
 579 #define CXt_EVAL        2
 580 #define CXt_LOOP        3
 581 #define CXt_SUBST       4
 582 #define CXt_BLOCK       5
 583 #define CXt_FORMAT      6
 584 #define CXt_GIVEN       7
 585 #define CXt_WHEN        8
 586
 587 /* private flags for CXt_SUB and CXt_NULL */
 588 #define CXp_MULTICALL   0x00000400      /* part of a multicall (so don't
 589                                            tear down context on exit). */
 590
 591 /* private flags for CXt_EVAL */
 592 #define CXp_REAL        0x00000100      /* truly eval'', not a lookalike */
 593 #define CXp_TRYBLOCK    0x00000200      /* eval{}, not eval'' or similar */
 594
 595 /* private flags for CXt_LOOP */
 596 #define CXp_FOREACH     0x00000200      /* a foreach loop */
 597 #define CXp_FOR_DEF     0x00000400      /* foreach using $_ */
 598 #ifdef USE_ITHREADS
 599 #  define CXp_PADVAR    0x00000100      /* itervar lives on pad, iterdata
 600                                            has pad offset; if not set,
 601                                            iterdata holds GV* */
 602 #  define CxPADLOOP(c)  (((c)->cx_type & (CXt_LOOP|CXp_PADVAR))         \
 603                          == (CXt_LOOP|CXp_PADVAR))
 604 #endif
 605
 606 #define CxTYPE(c)       ((c)->cx_type & CXTYPEMASK)
 607 #define CxMULTICALL(c)  (((c)->cx_type & CXp_MULTICALL)                 \
 608                          == CXp_MULTICALL)
 609 #define CxREALEVAL(c)   (((c)->cx_type & (CXt_EVAL|CXp_REAL))           \
 610                          == (CXt_EVAL|CXp_REAL))
 611 #define CxTRYBLOCK(c)   (((c)->cx_type & (CXt_EVAL|CXp_TRYBLOCK))       \
 612                          == (CXt_EVAL|CXp_TRYBLOCK))
 613 #define CxFOREACH(c)    (((c)->cx_type & (CXt_LOOP|CXp_FOREACH))        \
 614                          == (CXt_LOOP|CXp_FOREACH))
 615 #define CxFOREACHDEF(c) (((c)->cx_type & (CXt_LOOP|CXp_FOREACH|CXp_FOR_DEF))\
 616                          == (CXt_LOOP|CXp_FOREACH|CXp_FOR_DEF))
 617
 618 #define CXINC (cxstack_ix < cxstack_max ? ++cxstack_ix : (cxstack_ix = cxinc()))
 619
 620 /*
 621 =head1 "Gimme" Values
 622 */
 623
 624 /*
 625 =for apidoc AmU||G_SCALAR
 626 Used to indicate scalar context.  See C<GIMME_V>, C<GIMME>, and
 627 L<perlcall>.
 628
 629 =for apidoc AmU||G_ARRAY
 630 Used to indicate list context.  See C<GIMME_V>, C<GIMME> and
 631 L<perlcall>.
 632
 633 =for apidoc AmU||G_VOID
 634 Used to indicate void context.  See C<GIMME_V> and L<perlcall>.
 635
 636 =for apidoc AmU||G_DISCARD
 637 Indicates that arguments returned from a callback should be discarded.  See
 638 L<perlcall>.
 639
 640 =for apidoc AmU||G_EVAL
 641
 642 Used to force a Perl C<eval> wrapper around a callback.  See
 643 L<perlcall>.
 644
 645 =for apidoc AmU||G_NOARGS
 646
 647 Indicates that no arguments are being sent to a callback.  See
 648 L<perlcall>.
 649
 650 =cut
 651 */
 652
 653 #define G_SCALAR        0
 654 #define G_ARRAY         1
 655 #define G_VOID          128     /* skip this bit when adding flags below */
 656
 657 /* extra flags for Perl_call_* routines */
 658 #define G_DISCARD       2       /* Call FREETMPS. */
 659 #define G_EVAL          4       /* Assume eval {} around subroutine call. */
 660 #define G_NOARGS        8       /* Don't construct a @_ array. */
 661 #define G_KEEPERR      16       /* Append errors to $@, don't overwrite it */
 662 #define G_NODEBUG      32       /* Disable debugging at toplevel.  */
 663 #define G_METHOD       64       /* Calling method. */
 664 #define G_FAKINGEVAL  256       /* Faking en eval context for call_sv or
 665                                    fold_constants. */
 666
 667 /* flag bits for PL_in_eval */
 668 #define EVAL_NULL       0       /* not in an eval */
 669 #define EVAL_INEVAL     1       /* some enclosing scope is an eval */
 670 #define EVAL_WARNONLY   2       /* used by yywarn() when calling yyerror() */
 671 #define EVAL_KEEPERR    4       /* set by Perl_call_sv if G_KEEPERR */
 672 #define EVAL_INREQUIRE  8       /* The code is being required. */
 673
 674 /* Support for switching (stack and block) contexts.
 675  * This ensures magic doesn't invalidate local stack and cx pointers.
 676  */
 677
 678 #define PERLSI_UNKNOWN          -1
 679 #define PERLSI_UNDEF            0
 680 #define PERLSI_MAIN             1
 681 #define PERLSI_MAGIC            2
 682 #define PERLSI_SORT             3
 683 #define PERLSI_SIGNAL           4
 684 #define PERLSI_OVERLOAD         5
 685 #define PERLSI_DESTROY          6
 686 #define PERLSI_WARNHOOK         7
 687 #define PERLSI_DIEHOOK          8
 688 #define PERLSI_REQUIRE          9
 689
 690 struct stackinfo {
 691     AV *                si_stack;       /* stack for current runlevel */
 692     PERL_CONTEXT *      si_cxstack;     /* context stack for runlevel */
 693     I32                 si_cxix;        /* current context index */
 694     I32                 si_cxmax;       /* maximum allocated index */
 695     I32                 si_type;        /* type of runlevel */
 696     struct stackinfo *  si_prev;
 697     struct stackinfo *  si_next;
 698     I32                 si_markoff;     /* offset where markstack begins for us.
 699                                          * currently used only with DEBUGGING,
 700                                          * but not #ifdef-ed for bincompat */
 701 };
 702
 703 typedef struct stackinfo PERL_SI;
 704
 705 #define cxstack         (PL_curstackinfo->si_cxstack)
 706 #define cxstack_ix      (PL_curstackinfo->si_cxix)
 707 #define cxstack_max     (PL_curstackinfo->si_cxmax)
 708
 709 #ifdef DEBUGGING
 710 #  define       SET_MARK_OFFSET \
 711     PL_curstackinfo->si_markoff = PL_markstack_ptr - PL_markstack
 712 #else
 713 #  define       SET_MARK_OFFSET NOOP
 714 #endif
 715
 716 #define PUSHSTACKi(type) \
 717     STMT_START {                                                        \
 718         PERL_SI *next = PL_curstackinfo->si_next;                       \
 719         if (!next) {                                                    \
 720             next = new_stackinfo(32, 2048/sizeof(PERL_CONTEXT) - 1);    \
 721             next->si_prev = PL_curstackinfo;                            \
 722             PL_curstackinfo->si_next = next;                            \
 723         }                                                               \
 724         next->si_type = type;                                           \
 725         next->si_cxix = -1;                                             \
 726         AvFILLp(next->si_stack) = 0;                                    \
 727         SWITCHSTACK(PL_curstack,next->si_stack);                        \
 728         PL_curstackinfo = next;                                         \
 729         SET_MARK_OFFSET;                                                \
 730     } STMT_END
 731
 732 #define PUSHSTACK PUSHSTACKi(PERLSI_UNKNOWN)
 733
 734 /* POPSTACK works with PL_stack_sp, so it may need to be bracketed by
 735  * PUTBACK/SPAGAIN to flush/refresh any local SP that may be active */
 736 #define POPSTACK \
 737     STMT_START {                                                        \
 738         dSP;                                                            \
 739         PERL_SI * const prev = PL_curstackinfo->si_prev;                \
 740         if (!prev) {                                                    \
 741             PerlIO_printf(Perl_error_log, "panic: POPSTACK\n");         \
 742             my_exit(1);                                                 \
 743         }                                                               \
 744         SWITCHSTACK(PL_curstack,prev->si_stack);                        \
 745         /* don't free prev here, free them all at the END{} */          \
 746         PL_curstackinfo = prev;                                         \
 747     } STMT_END
 748
 749 #define POPSTACK_TO(s) \
 750     STMT_START {                                                        \
 751         while (PL_curstack != s) {                                      \
 752             dounwind(-1);                                               \
 753             POPSTACK;                                                   \
 754         }                                                               \
 755     } STMT_END
 756
 757 #define IN_PERL_COMPILETIME     (PL_curcop == &PL_compiling)
 758 #define IN_PERL_RUNTIME         (PL_curcop != &PL_compiling)
 759
 760 /*
 761 =head1 Multicall Functions
 762
 763 =for apidoc Ams||dMULTICALL
 764 Declare local variables for a multicall. See L<perlcall/Lightweight Callbacks>.
 765
 766 =for apidoc Ams||PUSH_MULTICALL
 767 Opening bracket for a lightweight callback.
 768 See L<perlcall/Lightweight Callbacks>.
 769
 770 =for apidoc Ams||MULTICALL
 771 Make a lightweight callback. See L<perlcall/Lightweight Callbacks>.
 772
 773 =for apidoc Ams||POP_MULTICALL
 774 Closing bracket for a lightweight callback.
 775 See L<perlcall/Lightweight Callbacks>.
 776
 777 =cut
 778 */
 779
 780 #define dMULTICALL \
 781     SV **newsp;                 /* set by POPBLOCK */                   \
 782     PERL_CONTEXT *cx;                                                   \
 783     CV *multicall_cv;                                                   \
 784     OP *multicall_cop;                                                  \
 785     bool multicall_oldcatch;                                            \
 786     U8 hasargs = 0              /* used by PUSHSUB */
 787
 788 #define PUSH_MULTICALL(the_cv) \
 789     STMT_START {                                                        \
 790         CV * const _nOnclAshIngNamE_ = the_cv;                          \
 791         CV * const cv = _nOnclAshIngNamE_;                              \
 792         AV * const padlist = CvPADLIST(cv);                             \
 793         ENTER;                                                          \
 794         multicall_oldcatch = CATCH_GET;                                 \
 795         SAVETMPS; SAVEVPTR(PL_op);                                      \
 796         CATCH_SET(TRUE);                                                \
 797         PUSHBLOCK(cx, CXt_SUB|CXp_MULTICALL, PL_stack_sp);              \
 798         PUSHSUB(cx);                                                    \
 799         if (++CvDEPTH(cv) >= 2) {                                       \
 800             PERL_STACK_OVERFLOW_CHECK();                                \
 801             Perl_pad_push(aTHX_ padlist, CvDEPTH(cv));                  \
 802         }                                                               \
 803         SAVECOMPPAD();                                                  \
 804         PAD_SET_CUR_NOSAVE(padlist, CvDEPTH(cv));                       \
 805         multicall_cv = cv;                                              \
 806         multicall_cop = CvSTART(cv);                                    \
 807     } STMT_END
 808
 809 #define MULTICALL \
 810     STMT_START {                                                        \
 811         PL_op = multicall_cop;                                          \
 812         CALLRUNOPS(aTHX);                                               \
 813     } STMT_END
 814
 815 #define POP_MULTICALL \
 816     STMT_START {                                                        \
 817         LEAVESUB(multicall_cv);                                         \
 818         CvDEPTH(multicall_cv)--;                                        \
 819         POPBLOCK(cx,PL_curpm);                                          \
 820         CATCH_SET(multicall_oldcatch);                                  \
 821         LEAVE;                                                          \
 822     } STMT_END
 823
 824 /*
 825  * Local variables:
 826  * c-indentation-style: bsd
 827  * c-basic-offset: 4
 828  * indent-tabs-mode: t
 829  * End:
 830  *
 831  * ex: set ts=8 sts=4 sw=4 noet:
 832  */