cop.h

   1 /*    cop.h
   2  *
   3  *    Copyright (c) 1991-1999, Larry Wall
   4  *
   5  *    You may distribute under the terms of either the GNU General Public
   6  *    License or the Artistic License, as specified in the README file.
   7  *
   8  */
   9
  10 struct cop {
  11     BASEOP
  12     char *      cop_label;      /* label for this construct */
  13 #ifdef USE_ITHREADS
  14     char *      cop_stashpv;    /* package line was compiled in */
  15     char *      cop_file;       /* file name the following line # is from */
  16 #else
  17     HV *        cop_stash;      /* package line was compiled in */
  18     GV *        cop_filegv;     /* file the following line # is from */
  19 #endif
  20     U32         cop_seq;        /* parse sequence number */
  21     I32         cop_arybase;    /* array base this line was compiled with */
  22     line_t      cop_line;       /* line # of this command */
  23     SV *        cop_warnings;   /* lexical warnings bitmask */
  24 };
  25
  26 #define Nullcop Null(COP*)
  27
  28 #ifdef USE_ITHREADS
  29 #  define CopFILE(c)            ((c)->cop_file)
  30 #  define CopFILEGV(c)          (CopFILE(c) \
  31                                  ? gv_fetchfile(CopFILE(c)) : Nullgv)
  32 #  define CopFILE_set(c,pv)     ((c)->cop_file = savepv(pv))    /* XXX */
  33 #  define CopFILESV(c)          (CopFILE(c) \
  34                                  ? GvSV(gv_fetchfile(CopFILE(c))) : Nullsv)
  35 #  define CopFILEAV(c)          (CopFILE(c) \
  36                                  ? GvAV(gv_fetchfile(CopFILE(c))) : Nullav)
  37 #  define CopSTASHPV(c)         ((c)->cop_stashpv)
  38 #  define CopSTASHPV_set(c,pv)  ((c)->cop_stashpv = savepv(pv)) /* XXX */
  39 #  define CopSTASH(c)           (CopSTASHPV(c) \
  40                                  ? gv_stashpv(CopSTASHPV(c),GV_ADD) : Nullhv)
  41 #  define CopSTASH_set(c,hv)    CopSTASHPV_set(c, HvNAME(hv))
  42 #  define CopSTASH_eq(c,hv)     (hv                                     \
  43                                  && (CopSTASHPV(c) == HvNAME(hv)        \
  44                                      || (CopSTASHPV(c) && HvNAME(hv)    \
  45                                          && strEQ(CopSTASHPV(c), HvNAME(hv)))))
  46 #else
  47 #  define CopFILEGV(c)          ((c)->cop_filegv)
  48 #  define CopFILEGV_set(c,gv)   ((c)->cop_filegv = gv)
  49 #  define CopFILE_set(c,pv)     ((c)->cop_filegv = gv_fetchfile(pv))
  50 #  define CopFILESV(c)          (CopFILEGV(c) ? GvSV(CopFILEGV(c)) : Nullsv)
  51 #  define CopFILEAV(c)          (CopFILEGV(c) ? GvAV(CopFILEGV(c)) : Nullav)
  52 #  define CopFILE(c)            (CopFILESV(c) ? SvPVX(CopFILESV(c)) : Nullch)
  53 #  define CopSTASH(c)           ((c)->cop_stash)
  54 #  define CopSTASH_set(c,hv)    ((c)->cop_stash = hv)
  55 #  define CopSTASHPV(c)         (CopSTASH(c) ? HvNAME(CopSTASH(c)) : Nullch)
  56 #  define CopSTASHPV_set(c,pv)  CopSTASH_set(c, gv_stashpv(pv,GV_ADD))
  57 #  define CopSTASH_eq(c,hv)     (CopSTASH(c) == hv)
  58 #endif /* USE_ITHREADS */
  59
  60 #define CopSTASH_ne(c,hv)       (!CopSTASH_eq(c,hv))
  61 #define CopLINE(c)              ((c)->cop_line)
  62 #define CopLINE_inc(c)          (++CopLINE(c))
  63 #define CopLINE_dec(c)          (--CopLINE(c))
  64 #define CopLINE_set(c,l)        (CopLINE(c) = (l))
  65
  66 /*
  67  * Here we have some enormously heavy (or at least ponderous) wizardry.
  68  */
  69
  70 /* subroutine context */
  71 struct block_sub {
  72     CV *        cv;
  73     GV *        gv;
  74     GV *        dfoutgv;
  75 #ifndef USE_THREADS
  76     AV *        savearray;
  77 #endif /* USE_THREADS */
  78     AV *        argarray;
  79     U16         olddepth;
  80     U8          hasargs;
  81     U8          lval;           /* XXX merge lval and hasargs? */
  82 };
  83
  84 #define PUSHSUB(cx)                                                     \
  85         cx->blk_sub.cv = cv;                                            \
  86         cx->blk_sub.olddepth = CvDEPTH(cv);                             \
  87         cx->blk_sub.hasargs = hasargs;                                  \
  88         cx->blk_sub.lval = PL_op->op_private &                          \
  89                               (OPpLVAL_INTRO|OPpENTERSUB_INARGS);
  90
  91 #define PUSHFORMAT(cx)                                                  \
  92         cx->blk_sub.cv = cv;                                            \
  93         cx->blk_sub.gv = gv;                                            \
  94         cx->blk_sub.hasargs = 0;                                        \
  95         cx->blk_sub.dfoutgv = PL_defoutgv;                              \
  96         (void)SvREFCNT_inc(cx->blk_sub.dfoutgv)
  97
  98 #ifdef USE_THREADS
  99 #  define POP_SAVEARRAY() NOOP
 100 #else
 101 #  define POP_SAVEARRAY()                                               \
 102     STMT_START {                                                        \
 103         SvREFCNT_dec(GvAV(PL_defgv));                                   \
 104         GvAV(PL_defgv) = cx->blk_sub.savearray;                         \
 105     } STMT_END
 106 #endif /* USE_THREADS */
 107
 108 #ifdef USE_ITHREADS
 109    /* junk in @_ spells trouble when cloning CVs, so don't leave any */
 110 #  define CLEAR_ARGARRAY()      av_clear(cx->blk_sub.argarray)
 111 #else
 112 #  define CLEAR_ARGARRAY()      NOOP
 113 #endif /* USE_ITHREADS */
 114
 115
 116 #define POPSUB(cx,sv)                                                   \
 117     STMT_START {                                                        \
 118         if (cx->blk_sub.hasargs) {                                      \
 119             POP_SAVEARRAY();                                            \
 120             /* abandon @_ if it got reified */                          \
 121             if (AvREAL(cx->blk_sub.argarray)) {                         \
 122                 SSize_t fill = AvFILLp(cx->blk_sub.argarray);           \
 123                 SvREFCNT_dec(cx->blk_sub.argarray);                     \
 124                 cx->blk_sub.argarray = newAV();                         \
 125                 av_extend(cx->blk_sub.argarray, fill);                  \
 126                 AvFLAGS(cx->blk_sub.argarray) = AVf_REIFY;              \
 127                 PL_curpad[0] = (SV*)cx->blk_sub.argarray;               \
 128             }                                                           \
 129             else {                                                      \
 130                 CLEAR_ARGARRAY();                                       \
 131             }                                                           \
 132         }                                                               \
 133         sv = (SV*)cx->blk_sub.cv;                                       \
 134         if (sv && (CvDEPTH((CV*)sv) = cx->blk_sub.olddepth))            \
 135             sv = Nullsv;                                                \
 136     } STMT_END
 137
 138 #define LEAVESUB(sv)                                                    \
 139     STMT_START {                                                        \
 140         if (sv)                                                         \
 141             SvREFCNT_dec(sv);                                           \
 142     } STMT_END
 143
 144 #define POPFORMAT(cx)                                                   \
 145         setdefout(cx->blk_sub.dfoutgv);                                 \
 146         SvREFCNT_dec(cx->blk_sub.dfoutgv);
 147
 148 /* eval context */
 149 struct block_eval {
 150     I32         old_in_eval;
 151     I32         old_op_type;
 152     char *      old_name;
 153     OP *        old_eval_root;
 154     SV *        cur_text;
 155 };
 156
 157 #define PUSHEVAL(cx,n,fgv)                                              \
 158         cx->blk_eval.old_in_eval = PL_in_eval;                          \
 159         cx->blk_eval.old_op_type = PL_op->op_type;                      \
 160         cx->blk_eval.old_name = (n ? savepv(n) : Nullch);               \
 161         cx->blk_eval.old_eval_root = PL_eval_root;                      \
 162         cx->blk_eval.cur_text = PL_linestr;
 163
 164 #define POPEVAL(cx)                                                     \
 165         PL_in_eval = cx->blk_eval.old_in_eval;                          \
 166         optype = cx->blk_eval.old_op_type;                              \
 167         PL_eval_root = cx->blk_eval.old_eval_root;                      \
 168         Safefree(cx->blk_eval.old_name);
 169
 170 /* loop context */
 171 struct block_loop {
 172     char *      label;
 173     I32         resetsp;
 174     OP *        redo_op;
 175     OP *        next_op;
 176     OP *        last_op;
 177 #ifdef USE_ITHREADS
 178     void *      iterdata;
 179 #else
 180     SV **       itervar;
 181 #endif
 182     SV *        itersave;
 183     SV *        iterlval;
 184     AV *        iterary;
 185     IV          iterix;
 186     IV          itermax;
 187 };
 188
 189 #ifdef USE_ITHREADS
 190 #  define CxITERVAR(c)                                                  \
 191         ((c)->blk_loop.iterdata                                         \
 192          ? (CxPADLOOP(cx)                                               \
 193             ? &PL_curpad[(PADOFFSET)(c)->blk_loop.iterdata]             \
 194             : &GvSV((GV*)(c)->blk_loop.iterdata))                       \
 195          : (SV**)NULL)
 196 #  define CX_ITERDATA_SET(cx,idata)                                     \
 197         if (cx->blk_loop.iterdata = (idata))                            \
 198             cx->blk_loop.itersave = SvREFCNT_inc(*CxITERVAR(cx));
 199 #else
 200 #  define CxITERVAR(c)          ((c)->blk_loop.itervar)
 201 #  define CX_ITERDATA_SET(cx,ivar)                                      \
 202         if (cx->blk_loop.itervar = (SV**)(ivar))                        \
 203             cx->blk_loop.itersave = SvREFCNT_inc(*CxITERVAR(cx));
 204 #endif
 205
 206 #define PUSHLOOP(cx, dat, s)                                            \
 207         cx->blk_loop.label = PL_curcop->cop_label;                      \
 208         cx->blk_loop.resetsp = s - PL_stack_base;                       \
 209         cx->blk_loop.redo_op = cLOOP->op_redoop;                        \
 210         cx->blk_loop.next_op = cLOOP->op_nextop;                        \
 211         cx->blk_loop.last_op = cLOOP->op_lastop;                        \
 212         cx->blk_loop.iterlval = Nullsv;                                 \
 213         cx->blk_loop.iterary = Nullav;                                  \
 214         cx->blk_loop.iterix = -1;                                       \
 215         CX_ITERDATA_SET(cx,dat);
 216
 217 #define POPLOOP(cx)                                                     \
 218         SvREFCNT_dec(cx->blk_loop.iterlval);                            \
 219         if (CxITERVAR(cx)) {                                            \
 220             SV **s_v_p = CxITERVAR(cx);                                 \
 221             sv_2mortal(*s_v_p);                                         \
 222             *s_v_p = cx->blk_loop.itersave;                             \
 223         }                                                               \
 224         if (cx->blk_loop.iterary && cx->blk_loop.iterary != PL_curstack)\
 225             SvREFCNT_dec(cx->blk_loop.iterary);
 226
 227 /* context common to subroutines, evals and loops */
 228 struct block {
 229     I32         blku_oldsp;     /* stack pointer to copy stuff down to */
 230     COP *       blku_oldcop;    /* old curcop pointer */
 231     I32         blku_oldretsp;  /* return stack index */
 232     I32         blku_oldmarksp; /* mark stack index */
 233     I32         blku_oldscopesp;        /* scope stack index */
 234     PMOP *      blku_oldpm;     /* values of pattern match vars */
 235     U8          blku_gimme;     /* is this block running in list context? */
 236
 237     union {
 238         struct block_sub        blku_sub;
 239         struct block_eval       blku_eval;
 240         struct block_loop       blku_loop;
 241     } blk_u;
 242 };
 243 #define blk_oldsp       cx_u.cx_blk.blku_oldsp
 244 #define blk_oldcop      cx_u.cx_blk.blku_oldcop
 245 #define blk_oldretsp    cx_u.cx_blk.blku_oldretsp
 246 #define blk_oldmarksp   cx_u.cx_blk.blku_oldmarksp
 247 #define blk_oldscopesp  cx_u.cx_blk.blku_oldscopesp
 248 #define blk_oldpm       cx_u.cx_blk.blku_oldpm
 249 #define blk_gimme       cx_u.cx_blk.blku_gimme
 250 #define blk_sub         cx_u.cx_blk.blk_u.blku_sub
 251 #define blk_eval        cx_u.cx_blk.blk_u.blku_eval
 252 #define blk_loop        cx_u.cx_blk.blk_u.blku_loop
 253
 254 /* Enter a block. */
 255 #define PUSHBLOCK(cx,t,sp) CXINC, cx = &cxstack[cxstack_ix],            \
 256         cx->cx_type             = t,                                    \
 257         cx->blk_oldsp           = sp - PL_stack_base,                   \
 258         cx->blk_oldcop          = PL_curcop,                            \
 259         cx->blk_oldmarksp       = PL_markstack_ptr - PL_markstack,      \
 260         cx->blk_oldscopesp      = PL_scopestack_ix,                     \
 261         cx->blk_oldretsp        = PL_retstack_ix,                       \
 262         cx->blk_oldpm           = PL_curpm,                             \
 263         cx->blk_gimme           = gimme;                                \
 264         DEBUG_l( PerlIO_printf(Perl_debug_log, "Entering block %ld, type %s\n", \
 265                     (long)cxstack_ix, PL_block_type[CxTYPE(cx)]); )
 266
 267 /* Exit a block (RETURN and LAST). */
 268 #define POPBLOCK(cx,pm) cx = &cxstack[cxstack_ix--],                    \
 269         newsp            = PL_stack_base + cx->blk_oldsp,               \
 270         PL_curcop        = cx->blk_oldcop,                              \
 271         PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp,            \
 272         PL_scopestack_ix = cx->blk_oldscopesp,                          \
 273         PL_retstack_ix   = cx->blk_oldretsp,                            \
 274         pm               = cx->blk_oldpm,                               \
 275         gimme            = cx->blk_gimme;                               \
 276         DEBUG_l( PerlIO_printf(Perl_debug_log, "Leaving block %ld, type %s\n",          \
 277                     (long)cxstack_ix+1,PL_block_type[CxTYPE(cx)]); )
 278
 279 /* Continue a block elsewhere (NEXT and REDO). */
 280 #define TOPBLOCK(cx) cx  = &cxstack[cxstack_ix],                        \
 281         PL_stack_sp      = PL_stack_base + cx->blk_oldsp,               \
 282         PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp,            \
 283         PL_scopestack_ix = cx->blk_oldscopesp,                          \
 284         PL_retstack_ix   = cx->blk_oldretsp,                            \
 285         PL_curpm         = cx->blk_oldpm
 286
 287 /* substitution context */
 288 struct subst {
 289     I32         sbu_iters;
 290     I32         sbu_maxiters;
 291     I32         sbu_rflags;
 292     I32         sbu_oldsave;
 293     bool        sbu_once;
 294     bool        sbu_rxtainted;
 295     char *      sbu_orig;
 296     SV *        sbu_dstr;
 297     SV *        sbu_targ;
 298     char *      sbu_s;
 299     char *      sbu_m;
 300     char *      sbu_strend;
 301     void *      sbu_rxres;
 302     REGEXP *    sbu_rx;
 303 };
 304 #define sb_iters        cx_u.cx_subst.sbu_iters
 305 #define sb_maxiters     cx_u.cx_subst.sbu_maxiters
 306 #define sb_rflags       cx_u.cx_subst.sbu_rflags
 307 #define sb_oldsave      cx_u.cx_subst.sbu_oldsave
 308 #define sb_once         cx_u.cx_subst.sbu_once
 309 #define sb_rxtainted    cx_u.cx_subst.sbu_rxtainted
 310 #define sb_orig         cx_u.cx_subst.sbu_orig
 311 #define sb_dstr         cx_u.cx_subst.sbu_dstr
 312 #define sb_targ         cx_u.cx_subst.sbu_targ
 313 #define sb_s            cx_u.cx_subst.sbu_s
 314 #define sb_m            cx_u.cx_subst.sbu_m
 315 #define sb_strend       cx_u.cx_subst.sbu_strend
 316 #define sb_rxres        cx_u.cx_subst.sbu_rxres
 317 #define sb_rx           cx_u.cx_subst.sbu_rx
 318
 319 #define PUSHSUBST(cx) CXINC, cx = &cxstack[cxstack_ix],                 \
 320         cx->sb_iters            = iters,                                \
 321         cx->sb_maxiters         = maxiters,                             \
 322         cx->sb_rflags           = r_flags,                              \
 323         cx->sb_oldsave          = oldsave,                              \
 324         cx->sb_once             = once,                                 \
 325         cx->sb_rxtainted        = rxtainted,                            \
 326         cx->sb_orig             = orig,                                 \
 327         cx->sb_dstr             = dstr,                                 \
 328         cx->sb_targ             = targ,                                 \
 329         cx->sb_s                = s,                                    \
 330         cx->sb_m                = m,                                    \
 331         cx->sb_strend           = strend,                               \
 332         cx->sb_rxres            = Null(void*),                          \
 333         cx->sb_rx               = rx,                                   \
 334         cx->cx_type             = CXt_SUBST;                            \
 335         rxres_save(&cx->sb_rxres, rx)
 336
 337 #define POPSUBST(cx) cx = &cxstack[cxstack_ix--];                       \
 338         rxres_free(&cx->sb_rxres)
 339
 340 struct context {
 341     U32         cx_type;        /* what kind of context this is */
 342     union {
 343         struct block    cx_blk;
 344         struct subst    cx_subst;
 345     } cx_u;
 346 };
 347
 348 #define CXTYPEMASK      0xff
 349 #define CXt_NULL        0
 350 #define CXt_SUB         1
 351 #define CXt_EVAL        2
 352 #define CXt_LOOP        3
 353 #define CXt_SUBST       4
 354 #define CXt_BLOCK       5
 355 #define CXt_FORMAT      6
 356
 357 /* private flags for CXt_EVAL */
 358 #define CXp_REAL        0x00000100      /* truly eval'', not a lookalike */
 359
 360 #ifdef USE_ITHREADS
 361 /* private flags for CXt_LOOP */
 362 #  define CXp_PADVAR    0x00000100      /* itervar lives on pad, iterdata
 363                                            has pad offset; if not set,
 364                                            iterdata holds GV* */
 365 #  define CxPADLOOP(c)  (((c)->cx_type & (CXt_LOOP|CXp_PADVAR))         \
 366                          == (CXt_LOOP|CXp_PADVAR))
 367 #endif
 368
 369 #define CxTYPE(c)       ((c)->cx_type & CXTYPEMASK)
 370 #define CxREALEVAL(c)   (((c)->cx_type & (CXt_EVAL|CXp_REAL))           \
 371                          == (CXt_EVAL|CXp_REAL))
 372
 373 #define CXINC (cxstack_ix < cxstack_max ? ++cxstack_ix : (cxstack_ix = cxinc()))
 374
 375 /* "gimme" values */
 376 #define G_SCALAR        0
 377 #define G_ARRAY         1
 378 #define G_VOID          128     /* skip this bit when adding flags below */
 379
 380 /* extra flags for Perl_call_* routines */
 381 #define G_DISCARD       2       /* Call FREETMPS. */
 382 #define G_EVAL          4       /* Assume eval {} around subroutine call. */
 383 #define G_NOARGS        8       /* Don't construct a @_ array. */
 384 #define G_KEEPERR      16       /* Append errors to $@, don't overwrite it */
 385 #define G_NODEBUG      32       /* Disable debugging at toplevel.  */
 386
 387 /* flag bits for PL_in_eval */
 388 #define EVAL_NULL       0       /* not in an eval */
 389 #define EVAL_INEVAL     1       /* some enclosing scope is an eval */
 390 #define EVAL_WARNONLY   2       /* used by yywarn() when calling yyerror() */
 391 #define EVAL_KEEPERR    4       /* set by Perl_call_sv if G_KEEPERR */
 392
 393 /* Support for switching (stack and block) contexts.
 394  * This ensures magic doesn't invalidate local stack and cx pointers.
 395  */
 396
 397 #define PERLSI_UNKNOWN          -1
 398 #define PERLSI_UNDEF            0
 399 #define PERLSI_MAIN             1
 400 #define PERLSI_MAGIC            2
 401 #define PERLSI_SORT             3
 402 #define PERLSI_SIGNAL           4
 403 #define PERLSI_OVERLOAD         5
 404 #define PERLSI_DESTROY          6
 405 #define PERLSI_WARNHOOK         7
 406 #define PERLSI_DIEHOOK          8
 407 #define PERLSI_REQUIRE          9
 408
 409 struct stackinfo {
 410     AV *                si_stack;       /* stack for current runlevel */
 411     PERL_CONTEXT *      si_cxstack;     /* context stack for runlevel */
 412     I32                 si_cxix;        /* current context index */
 413     I32                 si_cxmax;       /* maximum allocated index */
 414     I32                 si_type;        /* type of runlevel */
 415     struct stackinfo *  si_prev;
 416     struct stackinfo *  si_next;
 417     I32                 si_markoff;     /* offset where markstack begins for us.
 418                                          * currently used only with DEBUGGING,
 419                                          * but not #ifdef-ed for bincompat */
 420 };
 421
 422 typedef struct stackinfo PERL_SI;
 423
 424 #define cxstack         (PL_curstackinfo->si_cxstack)
 425 #define cxstack_ix      (PL_curstackinfo->si_cxix)
 426 #define cxstack_max     (PL_curstackinfo->si_cxmax)
 427
 428 #ifdef DEBUGGING
 429 #  define       SET_MARK_OFFSET \
 430     PL_curstackinfo->si_markoff = PL_markstack_ptr - PL_markstack
 431 #else
 432 #  define       SET_MARK_OFFSET NOOP
 433 #endif
 434
 435 #define PUSHSTACKi(type) \
 436     STMT_START {                                                        \
 437         PERL_SI *next = PL_curstackinfo->si_next;                       \
 438         if (!next) {                                                    \
 439             next = new_stackinfo(32, 2048/sizeof(PERL_CONTEXT) - 1);    \
 440             next->si_prev = PL_curstackinfo;                            \
 441             PL_curstackinfo->si_next = next;                            \
 442         }                                                               \
 443         next->si_type = type;                                           \
 444         next->si_cxix = -1;                                             \
 445         AvFILLp(next->si_stack) = 0;                                    \
 446         SWITCHSTACK(PL_curstack,next->si_stack);                        \
 447         PL_curstackinfo = next;                                         \
 448         SET_MARK_OFFSET;                                                \
 449     } STMT_END
 450
 451 #define PUSHSTACK PUSHSTACKi(PERLSI_UNKNOWN)
 452
 453 /* POPSTACK works with PL_stack_sp, so it may need to be bracketed by
 454  * PUTBACK/SPAGAIN to flush/refresh any local SP that may be active */
 455 #define POPSTACK \
 456     STMT_START {                                                        \
 457         djSP;                                                           \
 458         PERL_SI *prev = PL_curstackinfo->si_prev;                       \
 459         if (!prev) {                                                    \
 460             PerlIO_printf(Perl_error_log, "panic: POPSTACK\n");         \
 461             my_exit(1);                                                 \
 462         }                                                               \
 463         SWITCHSTACK(PL_curstack,prev->si_stack);                        \
 464         /* don't free prev here, free them all at the END{} */          \
 465         PL_curstackinfo = prev;                                         \
 466     } STMT_END
 467
 468 #define POPSTACK_TO(s) \
 469     STMT_START {                                                        \
 470         while (PL_curstack != s) {                                      \
 471             dounwind(-1);                                               \
 472             POPSTACK;                                                   \
 473         }                                                               \
 474     } STMT_END