This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
fix POPSTACK panics that ensued from bad interaction between
[perl5.git] / cop.h
diff --git a/cop.h b/cop.h
index acf0fda..ea846ab 100644 (file)
--- a/cop.h
+++ b/cop.h
@@ -1,61 +1,21 @@
-/* $RCSfile: cmd.h,v $$Revision: 4.1 $$Date: 92/08/07 17:19:19 $
+/*    cop.h
  *
- *    Copyright (c) 1991, Larry Wall
+ *    Copyright (c) 1991-1999, Larry Wall
  *
  *    You may distribute under the terms of either the GNU General Public
  *    License or the Artistic License, as specified in the README file.
  *
- * $Log:       cmd.h,v $
- * Revision 4.1  92/08/07  17:19:19  lwall
- * Stage 6 Snapshot
- * 
- * Revision 4.0.1.2  92/06/08  12:01:02  lwall
- * patch20: removed implicit int declarations on funcions
- * 
- * Revision 4.0.1.1  91/06/07  10:28:50  lwall
- * patch4: new copyright notice
- * patch4: length($`), length($&), length($') now optimized to avoid string copy
- * 
- * Revision 4.0  91/03/20  01:04:34  lwall
- * 4.0 baseline.
- * 
  */
 
-struct acop {
-    GV         *acop_gv;       /* a symbol table entry */
-    OP         *acop_expr;     /* any associated expression */
-};
-
-struct ccop {
-    OP         *ccop_true;     /* normal code to do on if and while */
-    OP         *ccop_alt;      /* else cmd ptr or continue code */
-};
-
-struct scop {
-    OP         **scop_next;    /* array of pointers to commands */
-    short      scop_offset;    /* first value - 1 */
-    short      scop_max;       /* last value + 1 */
-};
-
 struct cop {
     BASEOP
-    OP         *cop_expr;      /* conditional expression */
-    OP         *cop_head;      /* head of this command list */
-    SV         *cop_short;     /* string to match as shortcut */
-    GV         *cop_gv;        /* a symbol table entry, mostly for fp */
-    char       *cop_label;     /* label for this construct */
-    union uop {
-       struct acop acop;       /* normal command */
-       struct ccop ccop;       /* compound command */
-       struct scop scop;       /* switch command */
-    } uop;
-    U32                cop_seq;        /* parse sequence number */
-    short      cop_slen;       /* len of cop_short, if not null */
-    VOL short  cop_flags;      /* optimization flags--see above */
+    char *     cop_label;      /* label for this construct */
     HV *       cop_stash;      /* package line was compiled in */
     GV *       cop_filegv;     /* file the following line # is from */
+    U32                cop_seq;        /* parse sequence number */
+    I32                cop_arybase;    /* array base this line was compiled with */
     line_t      cop_line;       /* line # of this command */
-    char       cop_type;       /* what this command does */
+    SV *       cop_warnings;   /* lexical warnings bitmask */
 };
 
 #define Nullcop Null(COP*)
@@ -69,36 +29,67 @@ struct block_sub {
     CV *       cv;
     GV *       gv;
     GV *       dfoutgv;
+#ifndef USE_THREADS
     AV *       savearray;
+#endif /* USE_THREADS */
     AV *       argarray;
     U16                olddepth;
     U8         hasargs;
+    U8         lval;           /* XXX merge lval and hasargs? */
 };
 
 #define PUSHSUB(cx)                                                    \
        cx->blk_sub.cv = cv;                                            \
        cx->blk_sub.olddepth = CvDEPTH(cv);                             \
-       cx->blk_sub.hasargs = hasargs;
+       cx->blk_sub.hasargs = hasargs;                                  \
+       cx->blk_sub.lval = PL_op->op_private &                          \
+                             (OPpLVAL_INTRO|OPpENTERSUB_INARGS);
 
 #define PUSHFORMAT(cx)                                                 \
        cx->blk_sub.cv = cv;                                            \
        cx->blk_sub.gv = gv;                                            \
-       cx->blk_sub.dfoutgv = defoutgv;                                 \
-       cx->blk_sub.hasargs = 0;
+       cx->blk_sub.hasargs = 0;                                        \
+       cx->blk_sub.dfoutgv = PL_defoutgv;                              \
+       (void)SvREFCNT_inc(cx->blk_sub.dfoutgv)
 
-#define POPSUB(cx)                                                     \
-       if (cx->blk_sub.hasargs) {   /* put back old @_ */              \
-           GvAV(defgv) = cx->blk_sub.savearray;                        \
-       }                                                               \
-       if (cx->blk_sub.cv) {                                           \
-           if (!(CvDEPTH(cx->blk_sub.cv) = cx->blk_sub.olddepth)) {    \
-               if (CvDELETED(cx->blk_sub.cv))                          \
-                   SvREFCNT_dec((SV*)cx->blk_sub.cv);                  \
+#ifdef USE_THREADS
+#define POPSAVEARRAY() NOOP
+#else
+#define POPSAVEARRAY()                                                 \
+    STMT_START {                                                       \
+       SvREFCNT_dec(GvAV(PL_defgv));                                   \
+       GvAV(PL_defgv) = cx->blk_sub.savearray;                         \
+    } STMT_END
+#endif /* USE_THREADS */
+
+#define POPSUB(cx,sv)                                                  \
+    STMT_START {                                                       \
+       if (cx->blk_sub.hasargs) {                                      \
+           POPSAVEARRAY();                                             \
+           /* abandon @_ if it got reified */                          \
+           if (AvREAL(cx->blk_sub.argarray)) {                         \
+               SSize_t fill = AvFILLp(cx->blk_sub.argarray);           \
+               SvREFCNT_dec(cx->blk_sub.argarray);                     \
+               cx->blk_sub.argarray = newAV();                         \
+               av_extend(cx->blk_sub.argarray, fill);                  \
+               AvFLAGS(cx->blk_sub.argarray) = AVf_REIFY;              \
+               PL_curpad[0] = (SV*)cx->blk_sub.argarray;               \
            }                                                           \
-       }
+       }                                                               \
+       sv = (SV*)cx->blk_sub.cv;                                       \
+       if (sv && (CvDEPTH((CV*)sv) = cx->blk_sub.olddepth))            \
+           sv = Nullsv;                                                \
+    } STMT_END
+
+#define LEAVESUB(sv)                                                   \
+    STMT_START {                                                       \
+       if (sv)                                                         \
+           SvREFCNT_dec(sv);                                           \
+    } STMT_END
 
 #define POPFORMAT(cx)                                                  \
-       defoutgv = cx->blk_sub.dfoutgv;
+       setdefout(cx->blk_sub.dfoutgv);                                 \
+       SvREFCNT_dec(cx->blk_sub.dfoutgv);
 
 /* eval context */
 struct block_eval {
@@ -106,18 +97,20 @@ struct block_eval {
     I32                old_op_type;
     char *     old_name;
     OP *       old_eval_root;
+    SV *       cur_text;
 };
 
 #define PUSHEVAL(cx,n,fgv)                                             \
-       cx->blk_eval.old_in_eval = in_eval;                             \
-       cx->blk_eval.old_op_type = op->op_type;                         \
+       cx->blk_eval.old_in_eval = PL_in_eval;                          \
+       cx->blk_eval.old_op_type = PL_op->op_type;                      \
        cx->blk_eval.old_name = n;                                      \
-       cx->blk_eval.old_eval_root = eval_root;
+       cx->blk_eval.old_eval_root = PL_eval_root;                      \
+       cx->blk_eval.cur_text = PL_linestr;
 
 #define POPEVAL(cx)                                                    \
-       in_eval = cx->blk_eval.old_in_eval;                             \
+       PL_in_eval = cx->blk_eval.old_in_eval;                          \
        optype = cx->blk_eval.old_op_type;                              \
-       eval_root = cx->blk_eval.old_eval_root;
+       PL_eval_root = cx->blk_eval.old_eval_root;
 
 /* loop context */
 struct block_loop {
@@ -128,24 +121,32 @@ struct block_loop {
     OP *       last_op;
     SV **      itervar;
     SV *       itersave;
+    SV *       iterlval;
     AV *       iterary;
-    I32                iterix;
+    IV         iterix;
+    IV         itermax;
 };
 
 #define PUSHLOOP(cx, ivar, s)                                          \
-       cx->blk_loop.label = curcop->cop_label;                         \
-       cx->blk_loop.resetsp = s - stack_base;                          \
+       cx->blk_loop.label = PL_curcop->cop_label;                      \
+       cx->blk_loop.resetsp = s - PL_stack_base;                       \
        cx->blk_loop.redo_op = cLOOP->op_redoop;                        \
        cx->blk_loop.next_op = cLOOP->op_nextop;                        \
        cx->blk_loop.last_op = cLOOP->op_lastop;                        \
-       cx->blk_loop.itervar = ivar;                                    \
-       if (ivar)                                                       \
-           cx->blk_loop.itersave = *cx->blk_loop.itervar;
+       if (cx->blk_loop.itervar = (ivar))                              \
+           cx->blk_loop.itersave = SvREFCNT_inc(*cx->blk_loop.itervar);\
+       cx->blk_loop.iterlval = Nullsv;                                 \
+       cx->blk_loop.iterary = Nullav;                                  \
+       cx->blk_loop.iterix = -1;
 
 #define POPLOOP(cx)                                                    \
-       newsp           = stack_base + cx->blk_loop.resetsp;            \
-       if (cx->blk_loop.itervar)                                       \
-           *cx->blk_loop.itervar = cx->blk_loop.itersave;
+       SvREFCNT_dec(cx->blk_loop.iterlval);                            \
+       if (cx->blk_loop.itervar) {                                     \
+           sv_2mortal(*(cx->blk_loop.itervar));                        \
+           *(cx->blk_loop.itervar) = cx->blk_loop.itersave;            \
+       }                                                               \
+       if (cx->blk_loop.iterary && cx->blk_loop.iterary != PL_curstack)\
+           SvREFCNT_dec(cx->blk_loop.iterary);
 
 /* context common to subroutines, evals and loops */
 struct block {
@@ -177,83 +178,98 @@ struct block {
 /* Enter a block. */
 #define PUSHBLOCK(cx,t,sp) CXINC, cx = &cxstack[cxstack_ix],           \
        cx->cx_type             = t,                                    \
-       cx->blk_oldsp           = sp - stack_base,                      \
-       cx->blk_oldcop          = curcop,                               \
-       cx->blk_oldmarksp       = markstack_ptr - markstack,            \
-       cx->blk_oldscopesp      = scopestack_ix,                        \
-       cx->blk_oldretsp        = retstack_ix,                          \
-       cx->blk_oldpm           = curpm,                                \
+       cx->blk_oldsp           = sp - PL_stack_base,                   \
+       cx->blk_oldcop          = PL_curcop,                            \
+       cx->blk_oldmarksp       = PL_markstack_ptr - PL_markstack,      \
+       cx->blk_oldscopesp      = PL_scopestack_ix,                     \
+       cx->blk_oldretsp        = PL_retstack_ix,                       \
+       cx->blk_oldpm           = PL_curpm,                             \
        cx->blk_gimme           = gimme;                                \
-       DEBUG_l( fprintf(stderr,"Entering block %d, type %s\n",         \
-                   cxstack_ix, block_type[t]); )
+       DEBUG_l( PerlIO_printf(Perl_debug_log, "Entering block %ld, type %s\n", \
+                   (long)cxstack_ix, PL_block_type[CxTYPE(cx)]); )
 
 /* Exit a block (RETURN and LAST). */
-#define POPBLOCK(cx) cx = &cxstack[cxstack_ix--],                      \
-       newsp           = stack_base + cx->blk_oldsp,                   \
-       curcop          = cx->blk_oldcop,                               \
-       markstack_ptr   = markstack + cx->blk_oldmarksp,                \
-       scopestack_ix   = cx->blk_oldscopesp,                           \
-       retstack_ix     = cx->blk_oldretsp,                             \
-       curpm           = cx->blk_oldpm,                                \
-       gimme           = cx->blk_gimme;                                \
-       DEBUG_l( fprintf(stderr,"Leaving block %d, type %s\n",          \
-                   cxstack_ix+1,block_type[cx->cx_type]); )
+#define POPBLOCK(cx,pm) cx = &cxstack[cxstack_ix--],                   \
+       newsp            = PL_stack_base + cx->blk_oldsp,               \
+       PL_curcop        = cx->blk_oldcop,                              \
+       PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp,            \
+       PL_scopestack_ix = cx->blk_oldscopesp,                          \
+       PL_retstack_ix   = cx->blk_oldretsp,                            \
+       pm               = cx->blk_oldpm,                               \
+       gimme            = cx->blk_gimme;                               \
+       DEBUG_l( PerlIO_printf(Perl_debug_log, "Leaving block %ld, type %s\n",          \
+                   (long)cxstack_ix+1,PL_block_type[CxTYPE(cx)]); )
 
 /* Continue a block elsewhere (NEXT and REDO). */
-#define TOPBLOCK(cx) cx = &cxstack[cxstack_ix],                                \
-       stack_sp        = stack_base + cx->blk_oldsp,                   \
-       markstack_ptr   = markstack + cx->blk_oldmarksp,                \
-       scopestack_ix   = cx->blk_oldscopesp,                           \
-       retstack_ix     = cx->blk_oldretsp
+#define TOPBLOCK(cx) cx  = &cxstack[cxstack_ix],                       \
+       PL_stack_sp      = PL_stack_base + cx->blk_oldsp,               \
+       PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp,            \
+       PL_scopestack_ix = cx->blk_oldscopesp,                          \
+       PL_retstack_ix   = cx->blk_oldretsp,                            \
+       PL_curpm         = cx->blk_oldpm
 
 /* substitution context */
 struct subst {
     I32                sbu_iters;
     I32                sbu_maxiters;
-    I32                sbu_safebase;
-    I32                sbu_once;
+    I32                sbu_rflags;
+    I32                sbu_oldsave;
+    bool       sbu_once;
+    bool       sbu_rxtainted;
     char *     sbu_orig;
     SV *       sbu_dstr;
     SV *       sbu_targ;
     char *     sbu_s;
     char *     sbu_m;
     char *     sbu_strend;
-    char *     sbu_subbase;
+    void *     sbu_rxres;
+    REGEXP *   sbu_rx;
 };
 #define sb_iters       cx_u.cx_subst.sbu_iters
 #define sb_maxiters    cx_u.cx_subst.sbu_maxiters
-#define sb_safebase    cx_u.cx_subst.sbu_safebase
+#define sb_rflags      cx_u.cx_subst.sbu_rflags
+#define sb_oldsave     cx_u.cx_subst.sbu_oldsave
 #define sb_once                cx_u.cx_subst.sbu_once
+#define sb_rxtainted   cx_u.cx_subst.sbu_rxtainted
 #define sb_orig                cx_u.cx_subst.sbu_orig
 #define sb_dstr                cx_u.cx_subst.sbu_dstr
 #define sb_targ                cx_u.cx_subst.sbu_targ
 #define sb_s           cx_u.cx_subst.sbu_s
 #define sb_m           cx_u.cx_subst.sbu_m
 #define sb_strend      cx_u.cx_subst.sbu_strend
-#define sb_subbase     cx_u.cx_subst.sbu_subbase
+#define sb_rxres       cx_u.cx_subst.sbu_rxres
+#define sb_rx          cx_u.cx_subst.sbu_rx
 
 #define PUSHSUBST(cx) CXINC, cx = &cxstack[cxstack_ix],                        \
        cx->sb_iters            = iters,                                \
        cx->sb_maxiters         = maxiters,                             \
-       cx->sb_safebase         = safebase,                             \
+       cx->sb_rflags           = r_flags,                              \
+       cx->sb_oldsave          = oldsave,                              \
        cx->sb_once             = once,                                 \
+       cx->sb_rxtainted        = rxtainted,                            \
        cx->sb_orig             = orig,                                 \
        cx->sb_dstr             = dstr,                                 \
        cx->sb_targ             = targ,                                 \
        cx->sb_s                = s,                                    \
        cx->sb_m                = m,                                    \
        cx->sb_strend           = strend,                               \
-       cx->cx_type             = CXt_SUBST
+       cx->sb_rxres            = Null(void*),                          \
+       cx->sb_rx               = rx,                                   \
+       cx->cx_type             = CXt_SUBST;                            \
+       rxres_save(&cx->sb_rxres, rx)
 
-#define POPSUBST(cx) cxstack_ix--
+#define POPSUBST(cx) cx = &cxstack[cxstack_ix--];                      \
+       rxres_free(&cx->sb_rxres)
 
 struct context {
-    I32                cx_type;        /* what kind of context this is */
+    U32                cx_type;        /* what kind of context this is */
     union {
        struct block    cx_blk;
        struct subst    cx_subst;
     } cx_u;
 };
+
+#define CXTYPEMASK     0xff
 #define CXt_NULL       0
 #define CXt_SUB                1
 #define CXt_EVAL       2
@@ -261,9 +277,110 @@ struct context {
 #define CXt_SUBST      4
 #define CXt_BLOCK      5
 
+/* private flags for CXt_EVAL */
+#define CXp_REAL       0x00000100      /* truly eval'', not a lookalike */
+
+#define CxTYPE(c)      ((c)->cx_type & CXTYPEMASK)
+#define CxREALEVAL(c)  (((c)->cx_type & (CXt_EVAL|CXp_REAL)) == (CXt_EVAL|CXp_REAL))
+
 #define CXINC (cxstack_ix < cxstack_max ? ++cxstack_ix : (cxstack_ix = cxinc()))
 
 /* "gimme" values */
-#define G_SCALAR 0
-#define G_ARRAY 1
+#define G_SCALAR       0
+#define G_ARRAY                1
+#define G_VOID         128     /* skip this bit when adding flags below */
 
+/* extra flags for Perl_call_* routines */
+#define G_DISCARD      2       /* Call FREETMPS. */
+#define G_EVAL         4       /* Assume eval {} around subroutine call. */
+#define G_NOARGS       8       /* Don't construct a @_ array. */
+#define G_KEEPERR      16      /* Append errors to $@, don't overwrite it */
+#define G_NODEBUG      32      /* Disable debugging at toplevel.  */
+
+/* flag bits for PL_in_eval */
+#define EVAL_NULL      0       /* not in an eval */
+#define EVAL_INEVAL    1       /* some enclosing scope is an eval */
+#define EVAL_WARNONLY  2       /* used by yywarn() when calling yyerror() */
+#define EVAL_KEEPERR   4       /* set by Perl_call_sv if G_KEEPERR */
+
+/* Support for switching (stack and block) contexts.
+ * This ensures magic doesn't invalidate local stack and cx pointers.
+ */
+
+#define PERLSI_UNKNOWN         -1
+#define PERLSI_UNDEF           0
+#define PERLSI_MAIN            1
+#define PERLSI_MAGIC           2
+#define PERLSI_SORT            3
+#define PERLSI_SIGNAL          4
+#define PERLSI_OVERLOAD                5
+#define PERLSI_DESTROY         6
+#define PERLSI_WARNHOOK                7
+#define PERLSI_DIEHOOK         8
+#define PERLSI_REQUIRE         9
+
+struct stackinfo {
+    AV *               si_stack;       /* stack for current runlevel */
+    PERL_CONTEXT *     si_cxstack;     /* context stack for runlevel */
+    I32                        si_cxix;        /* current context index */
+    I32                        si_cxmax;       /* maximum allocated index */
+    I32                        si_type;        /* type of runlevel */
+    struct stackinfo * si_prev;
+    struct stackinfo * si_next;
+    I32 *              si_markbase;    /* where markstack begins for us.
+                                        * currently used only with DEBUGGING,
+                                        * but not #ifdef-ed for bincompat */
+};
+
+typedef struct stackinfo PERL_SI;
+
+#define cxstack                (PL_curstackinfo->si_cxstack)
+#define cxstack_ix     (PL_curstackinfo->si_cxix)
+#define cxstack_max    (PL_curstackinfo->si_cxmax)
+
+#ifdef DEBUGGING
+#  define      SET_MARKBASE PL_curstackinfo->si_markbase = PL_markstack_ptr
+#else
+#  define      SET_MARKBASE NOOP
+#endif
+
+#define PUSHSTACKi(type) \
+    STMT_START {                                                       \
+       PERL_SI *next = PL_curstackinfo->si_next;                       \
+       if (!next) {                                                    \
+           next = new_stackinfo(32, 2048/sizeof(PERL_CONTEXT) - 1);    \
+           next->si_prev = PL_curstackinfo;                            \
+           PL_curstackinfo->si_next = next;                            \
+       }                                                               \
+       next->si_type = type;                                           \
+       next->si_cxix = -1;                                             \
+       AvFILLp(next->si_stack) = 0;                                    \
+       SWITCHSTACK(PL_curstack,next->si_stack);                        \
+       PL_curstackinfo = next;                                         \
+       SET_MARKBASE;                                                   \
+    } STMT_END
+
+#define PUSHSTACK PUSHSTACKi(PERLSI_UNKNOWN)
+
+/* POPSTACK works with PL_stack_sp, so it may need to be bracketed by
+ * PUTBACK/SPAGAIN to flush/refresh any local SP that may be active */
+#define POPSTACK \
+    STMT_START {                                                       \
+       djSP;                                                           \
+       PERL_SI *prev = PL_curstackinfo->si_prev;                       \
+       if (!prev) {                                                    \
+           PerlIO_printf(Perl_error_log, "panic: POPSTACK\n");         \
+           my_exit(1);                                                 \
+       }                                                               \
+       SWITCHSTACK(PL_curstack,prev->si_stack);                        \
+       /* don't free prev here, free them all at the END{} */          \
+       PL_curstackinfo = prev;                                         \
+    } STMT_END
+
+#define POPSTACK_TO(s) \
+    STMT_START {                                                       \
+       while (PL_curstack != s) {                                      \
+           dounwind(-1);                                               \
+           POPSTACK;                                                   \
+       }                                                               \
+    } STMT_END