cv.h

   1 /*    cv.h
   2  *
   3  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1999, 2000, 2001,
   4  *    2002, 2003, 2004, 2005, 2006, 2007, 2008 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  */
  10
  11 /* This structure must match the beginning of XPVFM in sv.h  */
  12
  13 struct xpvcv {
  14     _XPV_HEAD;
  15     _XPVCV_COMMON;
  16     I32 xcv_depth;      /* >= 2 indicates recursive call */
  17 };
  18
  19 /*
  20 =head1 Handy Values
  21
  22 =for apidoc AmU||Nullcv
  23 Null CV pointer.
  24
  25 (deprecated - use C<(CV *)NULL> instead)
  26
  27 =head1 CV Manipulation Functions
  28
  29 This section documents functions to manipulate CVs which are code-values,
  30 or subroutines. For more information, see L<perlguts>.
  31
  32 =for apidoc Am|HV*|CvSTASH|CV* cv
  33 Returns the stash of the CV. A stash is the symbol table hash, containing
  34 the package-scoped variables in the package where the subroutine was defined.
  35 For more information, see L<perlguts>.
  36
  37 This also has a special use with XS AUTOLOAD subs.
  38 See L<perlguts/Autoloading with XSUBs>.
  39
  40 =cut
  41 */
  42
  43 #ifndef PERL_CORE
  44 #  define Nullcv Null(CV*)
  45 #endif
  46
  47 #define CvSTASH(sv)     (0+((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_stash)
  48 #define CvSTASH_set(cv,st) Perl_cvstash_set(aTHX_ cv, st)
  49 #define CvSTART(sv)     ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_start_u.xcv_start
  50 #define CvROOT(sv)      ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_root_u.xcv_root
  51 #define CvXSUB(sv)      ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_root_u.xcv_xsub
  52 #define CvXSUBANY(sv)   ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_start_u.xcv_xsubany
  53 #define CvGV(sv)        (0+((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_gv)
  54 #define CvGV_set(cv,gv) Perl_cvgv_set(aTHX_ cv, gv)
  55 #define CvFILE(sv)      ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_file
  56 #ifdef USE_ITHREADS
  57 #  define CvFILE_set_from_cop(sv, cop)  \
  58     (CvFILE(sv) = savepv(CopFILE(cop)), CvDYNFILE_on(sv))
  59 #else
  60 #  define CvFILE_set_from_cop(sv, cop)  \
  61     (CvFILE(sv) = CopFILE(cop), CvDYNFILE_off(sv))
  62 #endif
  63 #define CvFILEGV(sv)    (gv_fetchfile(CvFILE(sv)))
  64 PERL_STATIC_INLINE I32 *
  65 S_CvDEPTHp(const CV * const sv)
  66 {
  67     return SvTYPE(sv) == SVt_PVCV
  68         ? &((XPVCV*)SvANY(sv))->xcv_depth
  69 #if defined(_MSC_VER) && _MSC_VER < 1300
  70         : &((XPVCV*)SvANY(sv))->xpvcuru_fmdepth;
  71 #else
  72         : &((XPVCV*)SvANY(sv))->xpv_cur_u.xpvcuru_fmdepth;
  73 #endif
  74 }
  75 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
  76 #  define CvDEPTH(sv) (*({const CV *const _cvdepth = (const CV *)sv; \
  77                           assert(SvTYPE(_cvdepth) == SVt_PVCV         \
  78                               || SvTYPE(_cvdepth) == SVt_PVFM);        \
  79                           S_CvDEPTHp(_cvdepth);                         \
  80                         }))
  81 #else
  82 #  define CvDEPTH(sv)   (*S_CvDEPTHp((const CV *)sv))
  83 #endif
  84 #define CvPADLIST(sv)   ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_padlist
  85 #define CvOUTSIDE(sv)   ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_outside
  86 #define CvFLAGS(sv)     ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_flags
  87 #define CvOUTSIDE_SEQ(sv) ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_outside_seq
  88
  89 /* These two are sometimes called on non-CVs */
  90 #define CvPROTO(sv)                               \
  91         (                                          \
  92          SvPOK(sv)                                  \
  93           ? SvTYPE(sv) == SVt_PVCV && CvAUTOLOAD(sv) \
  94              ? SvEND(sv)+1 : SvPVX_const(sv)          \
  95           : NULL                                       \
  96         )
  97 #define CvPROTOLEN(sv)                            \
  98         (                                          \
  99          SvPOK(sv)                                  \
 100           ? SvTYPE(sv) == SVt_PVCV && CvAUTOLOAD(sv) \
 101              ? SvLEN(sv)-SvCUR(sv)-2                  \
 102              : SvCUR(sv)                               \
 103           : 0                                           \
 104         )
 105
 106 #define CVf_METHOD      0x0001  /* CV is explicitly marked as a method */
 107 #define CVf_LVALUE      0x0002  /* CV return value can be used as lvalue */
 108 #define CVf_CONST       0x0004  /* inlinable sub */
 109 #define CVf_ISXSUB      0x0008  /* CV is an XSUB, not pure perl.  */
 110
 111 #define CVf_WEAKOUTSIDE 0x0010  /* CvOUTSIDE isn't ref counted */
 112 #define CVf_CLONE       0x0020  /* anon CV uses external lexicals */
 113 #define CVf_CLONED      0x0040  /* a clone of one of those */
 114 #define CVf_ANON        0x0080  /* CV is not pointed to by a GV */
 115 #define CVf_UNIQUE      0x0100  /* sub is only called once (eg PL_main_cv,
 116                                  * require, eval). */
 117 #define CVf_NODEBUG     0x0200  /* no DB::sub indirection for this CV
 118                                    (esp. useful for special XSUBs) */
 119 #define CVf_CVGV_RC     0x0400  /* CvGV is reference counted */
 120 #ifdef PERL_CORE
 121 # define CVf_SLABBED    0x0800  /* Holds refcount on op slab  */
 122 #endif
 123 #define CVf_DYNFILE     0x1000  /* The filename isn't static  */
 124 #define CVf_AUTOLOAD    0x2000  /* SvPVX contains AUTOLOADed sub name  */
 125 #define CVf_HASEVAL     0x4000  /* contains string eval  */
 126
 127 /* This symbol for optimised communication between toke.c and op.c: */
 128 #define CVf_BUILTIN_ATTRS       (CVf_METHOD|CVf_LVALUE)
 129
 130 #define CvCLONE(cv)             (CvFLAGS(cv) & CVf_CLONE)
 131 #define CvCLONE_on(cv)          (CvFLAGS(cv) |= CVf_CLONE)
 132 #define CvCLONE_off(cv)         (CvFLAGS(cv) &= ~CVf_CLONE)
 133
 134 #define CvCLONED(cv)            (CvFLAGS(cv) & CVf_CLONED)
 135 #define CvCLONED_on(cv)         (CvFLAGS(cv) |= CVf_CLONED)
 136 #define CvCLONED_off(cv)        (CvFLAGS(cv) &= ~CVf_CLONED)
 137
 138 #define CvANON(cv)              (CvFLAGS(cv) & CVf_ANON)
 139 #define CvANON_on(cv)           (CvFLAGS(cv) |= CVf_ANON)
 140 #define CvANON_off(cv)          (CvFLAGS(cv) &= ~CVf_ANON)
 141
 142 /* CvEVAL or CvSPECIAL */
 143 #define CvUNIQUE(cv)            (CvFLAGS(cv) & CVf_UNIQUE)
 144 #define CvUNIQUE_on(cv)         (CvFLAGS(cv) |= CVf_UNIQUE)
 145 #define CvUNIQUE_off(cv)        (CvFLAGS(cv) &= ~CVf_UNIQUE)
 146
 147 #define CvNODEBUG(cv)           (CvFLAGS(cv) & CVf_NODEBUG)
 148 #define CvNODEBUG_on(cv)        (CvFLAGS(cv) |= CVf_NODEBUG)
 149 #define CvNODEBUG_off(cv)       (CvFLAGS(cv) &= ~CVf_NODEBUG)
 150
 151 #define CvMETHOD(cv)            (CvFLAGS(cv) & CVf_METHOD)
 152 #define CvMETHOD_on(cv)         (CvFLAGS(cv) |= CVf_METHOD)
 153 #define CvMETHOD_off(cv)        (CvFLAGS(cv) &= ~CVf_METHOD)
 154
 155 #define CvLVALUE(cv)            (CvFLAGS(cv) & CVf_LVALUE)
 156 #define CvLVALUE_on(cv)         (CvFLAGS(cv) |= CVf_LVALUE)
 157 #define CvLVALUE_off(cv)        (CvFLAGS(cv) &= ~CVf_LVALUE)
 158
 159 /* eval or PL_main_cv */
 160 #define CvEVAL(cv)              (CvUNIQUE(cv) && !SvFAKE(cv))
 161 #define CvEVAL_on(cv)           (CvUNIQUE_on(cv),SvFAKE_off(cv))
 162 #define CvEVAL_off(cv)          CvUNIQUE_off(cv)
 163
 164 /* BEGIN|CHECK|INIT|UNITCHECK|END */
 165 #define CvSPECIAL(cv)           (CvUNIQUE(cv) && SvFAKE(cv))
 166 #define CvSPECIAL_on(cv)        (CvUNIQUE_on(cv),SvFAKE_on(cv))
 167 #define CvSPECIAL_off(cv)       (CvUNIQUE_off(cv),SvFAKE_off(cv))
 168
 169 #define CvCONST(cv)             (CvFLAGS(cv) & CVf_CONST)
 170 #define CvCONST_on(cv)          (CvFLAGS(cv) |= CVf_CONST)
 171 #define CvCONST_off(cv)         (CvFLAGS(cv) &= ~CVf_CONST)
 172
 173 #define CvWEAKOUTSIDE(cv)       (CvFLAGS(cv) & CVf_WEAKOUTSIDE)
 174 #define CvWEAKOUTSIDE_on(cv)    (CvFLAGS(cv) |= CVf_WEAKOUTSIDE)
 175 #define CvWEAKOUTSIDE_off(cv)   (CvFLAGS(cv) &= ~CVf_WEAKOUTSIDE)
 176
 177 #define CvISXSUB(cv)            (CvFLAGS(cv) & CVf_ISXSUB)
 178 #define CvISXSUB_on(cv)         (CvFLAGS(cv) |= CVf_ISXSUB)
 179 #define CvISXSUB_off(cv)        (CvFLAGS(cv) &= ~CVf_ISXSUB)
 180
 181 #define CvCVGV_RC(cv)           (CvFLAGS(cv) & CVf_CVGV_RC)
 182 #define CvCVGV_RC_on(cv)        (CvFLAGS(cv) |= CVf_CVGV_RC)
 183 #define CvCVGV_RC_off(cv)       (CvFLAGS(cv) &= ~CVf_CVGV_RC)
 184
 185 #ifdef PERL_CORE
 186 # define CvSLABBED(cv)          (CvFLAGS(cv) & CVf_SLABBED)
 187 # define CvSLABBED_on(cv)       (CvFLAGS(cv) |= CVf_SLABBED)
 188 # define CvSLABBED_off(cv)      (CvFLAGS(cv) &= ~CVf_SLABBED)
 189 #endif
 190
 191 #define CvDYNFILE(cv)           (CvFLAGS(cv) & CVf_DYNFILE)
 192 #define CvDYNFILE_on(cv)        (CvFLAGS(cv) |= CVf_DYNFILE)
 193 #define CvDYNFILE_off(cv)       (CvFLAGS(cv) &= ~CVf_DYNFILE)
 194
 195 #define CvAUTOLOAD(cv)          (CvFLAGS(cv) & CVf_AUTOLOAD)
 196 #define CvAUTOLOAD_on(cv)       (CvFLAGS(cv) |= CVf_AUTOLOAD)
 197 #define CvAUTOLOAD_off(cv)      (CvFLAGS(cv) &= ~CVf_AUTOLOAD)
 198
 199 #define CvHASEVAL(cv)           (CvFLAGS(cv) & CVf_HASEVAL)
 200 #define CvHASEVAL_on(cv)        (CvFLAGS(cv) |= CVf_HASEVAL)
 201 #define CvHASEVAL_off(cv)       (CvFLAGS(cv) &= ~CVf_HASEVAL)
 202
 203 /* Flags for newXS_flags  */
 204 #define XS_DYNAMIC_FILENAME     0x01    /* The filename isn't static  */
 205
 206 /*
 207 =head1 CV reference counts and CvOUTSIDE
 208
 209 =for apidoc m|bool|CvWEAKOUTSIDE|CV *cv
 210
 211 Each CV has a pointer, C<CvOUTSIDE()>, to its lexically enclosing
 212 CV (if any). Because pointers to anonymous sub prototypes are
 213 stored in C<&> pad slots, it is a possible to get a circular reference,
 214 with the parent pointing to the child and vice-versa. To avoid the
 215 ensuing memory leak, we do not increment the reference count of the CV
 216 pointed to by C<CvOUTSIDE> in the I<one specific instance> that the parent
 217 has a C<&> pad slot pointing back to us. In this case, we set the
 218 C<CvWEAKOUTSIDE> flag in the child. This allows us to determine under what
 219 circumstances we should decrement the refcount of the parent when freeing
 220 the child.
 221
 222 There is a further complication with non-closure anonymous subs (i.e. those
 223 that do not refer to any lexicals outside that sub). In this case, the
 224 anonymous prototype is shared rather than being cloned. This has the
 225 consequence that the parent may be freed while there are still active
 226 children, eg
 227
 228     BEGIN { $a = sub { eval '$x' } }
 229
 230 In this case, the BEGIN is freed immediately after execution since there
 231 are no active references to it: the anon sub prototype has
 232 C<CvWEAKOUTSIDE> set since it's not a closure, and $a points to the same
 233 CV, so it doesn't contribute to BEGIN's refcount either.  When $a is
 234 executed, the C<eval '$x'> causes the chain of C<CvOUTSIDE>s to be followed,
 235 and the freed BEGIN is accessed.
 236
 237 To avoid this, whenever a CV and its associated pad is freed, any
 238 C<&> entries in the pad are explicitly removed from the pad, and if the
 239 refcount of the pointed-to anon sub is still positive, then that
 240 child's C<CvOUTSIDE> is set to point to its grandparent. This will only
 241 occur in the single specific case of a non-closure anon prototype
 242 having one or more active references (such as C<$a> above).
 243
 244 One other thing to consider is that a CV may be merely undefined
 245 rather than freed, eg C<undef &foo>. In this case, its refcount may
 246 not have reached zero, but we still delete its pad and its C<CvROOT> etc.
 247 Since various children may still have their C<CvOUTSIDE> pointing at this
 248 undefined CV, we keep its own C<CvOUTSIDE> for the time being, so that
 249 the chain of lexical scopes is unbroken. For example, the following
 250 should print 123:
 251
 252     my $x = 123;
 253     sub tmp { sub { eval '$x' } }
 254     my $a = tmp();
 255     undef &tmp;
 256     print  $a->();
 257
 258 =cut
 259 */
 260
 261 typedef OP *(*Perl_call_checker)(pTHX_ OP *, GV *, SV *);
 262
 263 /*
 264  * Local variables:
 265  * c-indentation-style: bsd
 266  * c-basic-offset: 4
 267  * indent-tabs-mode: nil
 268  * End:
 269  *
 270  * ex: set ts=8 sts=4 sw=4 et:
 271  */