This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
In struct block change blku_type from U8 to U16, and the "spare" U8 to
[perl5.git] / cop.h
diff --git a/cop.h b/cop.h
index c59a7d6..fafa441 100644 (file)
--- a/cop.h
+++ b/cop.h
@@ -1,7 +1,7 @@
 /*    cop.h
  *
  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
- *    2000, 2001, 2002, 2003, 2004, 2005, 2006 by Larry Wall and others
+ *    2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, by Larry Wall and others
  *
  *    You may distribute under the terms of either the GNU General Public
  *    License or the Artistic License, as specified in the README file.
@@ -132,9 +132,13 @@ typedef struct jmpenv JMPENV;
 #define CATCH_SET(v)           (PL_top_env->je_mustcatch = (v))
 
 
+#include "mydtrace.h"
 
 struct cop {
     BASEOP
+    /* On LP64 putting this here takes advantage of the fact that BASEOP isn't
+       an exact multiple of 8 bytes to save structure padding.  */
+    line_t      cop_line;       /* line # of this command */
     char *     cop_label;      /* label for this construct */
 #ifdef USE_ITHREADS
     char *     cop_stashpv;    /* package line was compiled in */
@@ -145,7 +149,6 @@ struct cop {
 #endif
     U32                cop_hints;      /* hints bits from pragmata */
     U32                cop_seq;        /* parse sequence number */
-    line_t      cop_line;       /* line # of this command */
     /* Beware. mg.c and warnings.pl assume the type of this is STRLEN *:  */
     STRLEN *   cop_warnings;   /* lexical warnings bitmask */
     /* compile time state of %^H.  See the comment in op.c for how this is
@@ -213,7 +216,8 @@ struct cop {
 #  else
 #    define CopFILEAVx(c)      (GvAV(CopFILEGV(c)))
 # endif
-#  define CopFILE(c)           (CopFILESV(c) ? SvPVX(CopFILESV(c)) : NULL)
+#  define CopFILE(c)           (CopFILEGV(c) && GvSV(CopFILEGV(c)) \
+                                   ? SvPVX(GvSV(CopFILEGV(c))) : NULL)
 #  define CopSTASH(c)          ((c)->cop_stash)
 #  define CopLABEL(c)          ((c)->cop_label)
 #  define CopSTASH_set(c,hv)   ((c)->cop_stash = (hv))
@@ -258,7 +262,7 @@ struct cop {
                PL_hints |= HINT_LOCALIZE_HH | HINT_ARYBASE;            \
            (c)->cop_hints_hash                                         \
               = Perl_refcounted_he_new(aTHX_ (c)->cop_hints_hash,      \
-                                       sv_2mortal(newSVpvs("$[")),     \
+                                       newSVpvs_flags("$[", SVs_TEMP), \
                                        sv_2mortal(newSViv(b)));        \
        }                                                               \
     } STMT_END
@@ -275,16 +279,25 @@ struct cop {
 
 /* subroutine context */
 struct block_sub {
+    OP *       retop;  /* op to execute on exit from sub */
+    /* Above here is the same for sub, format and eval.  */
     CV *       cv;
-    GV *       gv;
-    GV *       dfoutgv;
+    /* Above here is the same for sub and format.  */
     AV *       savearray;
     AV *       argarray;
     I32                olddepth;
-    U8         hasargs;
-    U8         lval;           /* XXX merge lval and hasargs? */
     PAD                *oldcomppad;
+};
+
+
+/* format context */
+struct block_format {
     OP *       retop;  /* op to execute on exit from sub */
+    /* Above here is the same for sub, format and eval.  */
+    CV *       cv;
+    /* Above here is the same for sub and format.  */
+    GV *       gv;
+    GV *       dfoutgv;
 };
 
 /* base for the next two macros. Don't use directly.
@@ -292,9 +305,13 @@ struct block_sub {
  * decremented by LEAVESUB, the other by LEAVE. */
 
 #define PUSHSUB_BASE(cx)                                               \
+       ENTRY_PROBE(GvENAME(CvGV(cv)),                                  \
+               CopFILE((COP*)CvSTART(cv)),                             \
+               CopLINE((COP*)CvSTART(cv)));                            \
+                                                                       \
        cx->blk_sub.cv = cv;                                            \
        cx->blk_sub.olddepth = CvDEPTH(cv);                             \
-       cx->blk_sub.hasargs = hasargs;                                  \
+       cx->cx_type |= (hasargs) ? CXp_HASARGS : 0;                     \
        cx->blk_sub.retop = NULL;                                       \
        if (!CvDEPTH(cv)) {                                             \
            SvREFCNT_inc_simple_void_NN(cv);                            \
@@ -305,22 +322,21 @@ struct block_sub {
 
 #define PUSHSUB(cx)                                                    \
        PUSHSUB_BASE(cx)                                                \
-       cx->blk_sub.lval = PL_op->op_private &                          \
+       cx->blk_u16 = PL_op->op_private &                               \
                              (OPpLVAL_INTRO|OPpENTERSUB_INARGS);
 
 /* variant for use by OP_DBSTATE, where op_private holds hint bits */
 #define PUSHSUB_DB(cx)                                                 \
        PUSHSUB_BASE(cx)                                                \
-       cx->blk_sub.lval = 0;
+       cx->blk_u16 = 0;
 
 
-#define PUSHFORMAT(cx)                                                 \
-       cx->blk_sub.cv = cv;                                            \
-       cx->blk_sub.gv = gv;                                            \
-       cx->blk_sub.retop = NULL;                                       \
-       cx->blk_sub.hasargs = 0;                                        \
-       cx->blk_sub.dfoutgv = PL_defoutgv;                              \
-       SvREFCNT_inc_void(cx->blk_sub.dfoutgv)
+#define PUSHFORMAT(cx, retop)                                          \
+       cx->blk_format.cv = cv;                                         \
+       cx->blk_format.gv = gv;                                         \
+       cx->blk_format.retop = (retop);                                 \
+       cx->blk_format.dfoutgv = PL_defoutgv;                           \
+       SvREFCNT_inc_void(cx->blk_format.dfoutgv)
 
 #define POP_SAVEARRAY()                                                \
     STMT_START {                                                       \
@@ -339,7 +355,11 @@ struct block_sub {
 
 #define POPSUB(cx,sv)                                                  \
     STMT_START {                                                       \
-       if (cx->blk_sub.hasargs) {                                      \
+       RETURN_PROBE(GvENAME(CvGV((CV*)cx->blk_sub.cv)),                \
+               CopFILE((COP*)CvSTART((CV*)cx->blk_sub.cv)),            \
+               CopLINE((COP*)CvSTART((CV*)cx->blk_sub.cv)));           \
+                                                                       \
+       if (CxHASARGS(cx)) {                                            \
            POP_SAVEARRAY();                                            \
            /* abandon @_ if it got reified */                          \
            if (AvREAL(cx->blk_sub.argarray)) {                         \
@@ -366,18 +386,19 @@ struct block_sub {
     } STMT_END
 
 #define POPFORMAT(cx)                                                  \
-       setdefout(cx->blk_sub.dfoutgv);                                 \
-       SvREFCNT_dec(cx->blk_sub.dfoutgv);
+       setdefout(cx->blk_format.dfoutgv);                              \
+       SvREFCNT_dec(cx->blk_format.dfoutgv);
 
 /* eval context */
 struct block_eval {
+    OP *       retop;  /* op to execute on exit from eval */
+    /* Above here is the same for sub, format and eval.  */
     U8         old_in_eval;
     U16                old_op_type;
     SV *       old_namesv;
     OP *       old_eval_root;
     SV *       cur_text;
     CV *       cv;
-    OP *       retop;  /* op to execute on exit from eval */
     JMPENV *   cur_top_env; /* value of PL_top_env when eval CX created */
 };
 
@@ -387,7 +408,7 @@ struct block_eval {
        cx->blk_eval.old_op_type = PL_op->op_type;                      \
        cx->blk_eval.old_namesv = (n ? newSVpv(n,0) : NULL);            \
        cx->blk_eval.old_eval_root = PL_eval_root;                      \
-       cx->blk_eval.cur_text = PL_linestr;                             \
+       cx->blk_eval.cur_text = PL_parser ? PL_parser->linestr : NULL;  \
        cx->blk_eval.cv = NULL; /* set by doeval(), as applicable */    \
        cx->blk_eval.retop = NULL;                                      \
        cx->blk_eval.cur_top_env = PL_top_env;                          \
@@ -404,7 +425,6 @@ struct block_eval {
 
 /* loop context */
 struct block_loop {
-    char *     label;
     I32                resetsp;
     LOOP *     my_op;  /* My op, that contains redo, next and last ops.  */
     /* (except for non_ithreads we need to modify next_op in pp_ctl.c, hence
@@ -462,6 +482,9 @@ struct block_loop {
        else                                                            \
            cx->blk_loop.itersave = NULL;
 #endif
+#define CxLABEL(c)     (0 + (c)->blk_oldcop->cop_label)
+#define CxHASARGS(c)   (((c)->cx_type & CXp_HASARGS) == CXp_HASARGS)
+#define CxLVAL(c)      (0 + (c)->blk_u16)
 
 #ifdef USE_ITHREADS
 #  define PUSHLOOP_OP_NEXT             /* No need to do anything.  */
@@ -472,7 +495,6 @@ struct block_loop {
 #endif
 
 #define PUSHLOOP(cx, dat, s)                                           \
-       cx->blk_loop.label = PL_curcop->cop_label;                      \
        cx->blk_loop.resetsp = s - PL_stack_base;                       \
        cx->blk_loop.my_op = cLOOP;                                     \
        PUSHLOOP_OP_NEXT;                                               \
@@ -508,9 +530,9 @@ struct block_givwhen {
 
 /* context common to subroutines, evals and loops */
 struct block {
-    U16                blku_type;      /* what kind of context this is */
+    U8         blku_type;      /* what kind of context this is */
     U8         blku_gimme;     /* is this block running in list context? */
-    U8         blku_spare;     /* Padding to match with struct subst */
+    U16                blku_u16;       /* U16 of space used by block_sub */
     I32                blku_oldsp;     /* stack pointer to copy stuff down to */
     COP *      blku_oldcop;    /* old curcop pointer */
     I32                blku_oldmarksp; /* mark stack index */
@@ -519,6 +541,7 @@ struct block {
 
     union {
        struct block_sub        blku_sub;
+       struct block_format     blku_format;
        struct block_eval       blku_eval;
        struct block_loop       blku_loop;
        struct block_givwhen    blku_givwhen;
@@ -530,7 +553,9 @@ struct block {
 #define blk_oldscopesp cx_u.cx_blk.blku_oldscopesp
 #define blk_oldpm      cx_u.cx_blk.blku_oldpm
 #define blk_gimme      cx_u.cx_blk.blku_gimme
+#define blk_u16                cx_u.cx_blk.blku_u16
 #define blk_sub                cx_u.cx_blk.blk_u.blku_sub
+#define blk_format     cx_u.cx_blk.blk_u.blku_format
 #define blk_eval       cx_u.cx_blk.blk_u.blku_eval
 #define blk_loop       cx_u.cx_blk.blk_u.blku_loop
 #define blk_givwhen    cx_u.cx_blk.blk_u.blku_givwhen
@@ -569,9 +594,9 @@ struct block {
 
 /* substitution context */
 struct subst {
-    U16                sbu_type;       /* what kind of context this is */
-    U8         sbu_once;       /* Actually both booleans, but U8 to matches */
-    U8         sbu_rxtainted;  /* struct block */
+    U8         sbu_type;       /* what kind of context this is */
+    U8         sbu_once;       /* Actually both booleans, but U8/U16 */
+    U16                sbu_rxtainted;  /* matches struct block */
     I32                sbu_iters;
     I32                sbu_maxiters;
     I32                sbu_rflags;
@@ -631,7 +656,7 @@ struct context {
 };
 #define cx_type cx_u.cx_subst.sbu_type
 
-#define CXTYPEMASK     0xff
+#define CXTYPEMASK     0xf
 #define CXt_NULL       0
 #define CXt_SUB                1
 #define CXt_EVAL       2
@@ -642,19 +667,25 @@ struct context {
 #define CXt_GIVEN      7
 #define CXt_WHEN       8
 
-/* private flags for CXt_SUB and CXt_NULL */
-#define CXp_MULTICALL  0x00000400      /* part of a multicall (so don't
+/* private flags for CXt_SUB and CXt_NULL
+   However, this is checked in many places which do not check the type, so
+   this bit needs to be kept clear for most everything else. For reasons I
+   haven't investigated, it can coexist with CXp_FOR_DEF */
+#define CXp_MULTICALL  0x0000040       /* part of a multicall (so don't
                                           tear down context on exit). */ 
 
+/* private flags for CXt_SUB and CXt_FORMAT */
+#define CXp_HASARGS    0x00000020
+
 /* private flags for CXt_EVAL */
-#define CXp_REAL       0x00000100      /* truly eval'', not a lookalike */
-#define CXp_TRYBLOCK   0x00000200      /* eval{}, not eval'' or similar */
+#define CXp_REAL       0x00000010      /* truly eval'', not a lookalike */
+#define CXp_TRYBLOCK   0x00000020      /* eval{}, not eval'' or similar */
 
 /* private flags for CXt_LOOP */
-#define CXp_FOREACH    0x00000200      /* a foreach loop */
-#define CXp_FOR_DEF    0x00000400      /* foreach using $_ */
+#define CXp_FOREACH    0x00000020      /* a foreach loop */
+#define CXp_FOR_DEF    0x00000040      /* foreach using $_ */
 #ifdef USE_ITHREADS
-#  define CXp_PADVAR   0x00000100      /* itervar lives on pad, iterdata
+#  define CXp_PADVAR   0x00000010      /* itervar lives on pad, iterdata
                                           has pad offset; if not set,
                                           iterdata holds GV* */
 #  define CxPADLOOP(c) (((c)->cx_type & (CXt_LOOP|CXp_PADVAR))         \
@@ -664,13 +695,13 @@ struct context {
 #define CxTYPE(c)      ((c)->cx_type & CXTYPEMASK)
 #define CxMULTICALL(c) (((c)->cx_type & CXp_MULTICALL)                 \
                         == CXp_MULTICALL)
-#define CxREALEVAL(c)  (((c)->cx_type & (CXt_EVAL|CXp_REAL))           \
+#define CxREALEVAL(c)  (((c)->cx_type & (CXTYPEMASK|CXp_REAL))         \
                         == (CXt_EVAL|CXp_REAL))
-#define CxTRYBLOCK(c)  (((c)->cx_type & (CXt_EVAL|CXp_TRYBLOCK))       \
+#define CxTRYBLOCK(c)  (((c)->cx_type & (CXTYPEMASK|CXp_TRYBLOCK))     \
                         == (CXt_EVAL|CXp_TRYBLOCK))
-#define CxFOREACH(c)   (((c)->cx_type & (CXt_LOOP|CXp_FOREACH))        \
+#define CxFOREACH(c)   (((c)->cx_type & (CXTYPEMASK|CXp_FOREACH))      \
                          == (CXt_LOOP|CXp_FOREACH))
-#define CxFOREACHDEF(c)        (((c)->cx_type & (CXt_LOOP|CXp_FOREACH|CXp_FOR_DEF))\
+#define CxFOREACHDEF(c)        (((c)->cx_type & (CXTYPEMASK|CXp_FOREACH|CXp_FOR_DEF))\
                         == (CXt_LOOP|CXp_FOREACH|CXp_FOR_DEF))
 
 #define CXINC (cxstack_ix < cxstack_max ? ++cxstack_ix : (cxstack_ix = cxinc()))
@@ -708,17 +739,20 @@ L<perlcall>.
 =cut
 */
 
-#define G_SCALAR       0
-#define G_ARRAY                1
-#define G_VOID         128     /* skip this bit when adding flags below */
+#define G_SCALAR       2
+#define G_ARRAY                3
+#define G_VOID         1
+#define G_WANT         3
 
 /* 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.  */
-#define G_METHOD       64       /* Calling method. */
+#define G_DISCARD      4       /* Call FREETMPS.
+                                  Don't change this without consulting the
+                                  hash actions codes defined in hv.h */
+#define G_EVAL         8       /* Assume eval {} around subroutine call. */
+#define G_NOARGS       16      /* Don't construct a @_ array. */
+#define G_KEEPERR      32      /* Append errors to $@, don't overwrite it */
+#define G_NODEBUG      64      /* Disable debugging at toplevel.  */
+#define G_METHOD      128       /* Calling method. */
 #define G_FAKINGEVAL  256      /* Faking an eval context for call_sv or
                                   fold_constants. */