[perl5.git] / cv.h

/*    cv.h
 *
 *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1999, 2000, 2001,
 *    2002, 2003, 2004, 2005, 2006, 2007, 2008 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.
 *
 */

/* This structure must match the beginning of XPVFM in sv.h  */

struct xpvcv {
    _XPV_HEAD;
    _XPVCV_COMMON;
};

/*
=for apidoc Ayh||CV

=for apidoc ADmnU||Nullcv
Null CV pointer.

(deprecated - use C<(CV *)NULL> instead)

=for apidoc Am|HV*|CvSTASH|CV* cv
Returns the stash of the CV.  A stash is the symbol table hash, containing
the package-scoped variables in the package where the subroutine was defined.
For more information, see L<perlguts>.

This also has a special use with XS AUTOLOAD subs.
See L<perlguts/Autoloading with XSUBs>.

=cut
*/

#ifndef PERL_CORE
#  define Nullcv Null(CV*)
#endif

#define CvSTASH(sv)	(MUTABLE_HV(((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_stash))
#define CvSTASH_set(cv,st) Perl_cvstash_set(aTHX_ cv, st)
#define CvSTART(sv)	((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_start_u.xcv_start
#define CvROOT(sv)	((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_root_u.xcv_root
#define CvXSUB(sv)	((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_root_u.xcv_xsub
#define CvXSUBANY(sv)	((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_start_u.xcv_xsubany
#define CvGV(sv)	Perl_CvGV(aTHX_ (CV *)(sv))
#define CvGV_set(cv,gv)	Perl_cvgv_set(aTHX_ cv, gv)
#define CvHASGV(cv)	cBOOL(SvANY(cv)->xcv_gv_u.xcv_gv)
#define CvFILE(sv)	((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_file
#ifdef USE_ITHREADS
#  define CvFILE_set_from_cop(sv, cop)	\
    (CvFILE(sv) = savepv(CopFILE(cop)), CvDYNFILE_on(sv))
#else
#  define CvFILE_set_from_cop(sv, cop)	\
    (CvFILE(sv) = CopFILE(cop), CvDYNFILE_off(sv))
#endif
#define CvFILEGV(sv)	(gv_fetchfile(CvFILE(sv)))
#define CvDEPTH(sv)	(*Perl_CvDEPTH((const CV *)sv))
/* For use when you only have a XPVCV*, not a real CV*.
   Must be assert protected as in Perl_CvDEPTH before use. */
#define CvDEPTHunsafe(sv) ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_depth

/* these CvPADLIST/CvRESERVED asserts can be reverted one day, once stabilized */
#define CvPADLIST(sv)	  (*(assert_(!CvISXSUB((CV*)(sv))) \
        &(((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_padlist_u.xcv_padlist)))
/* CvPADLIST_set is not public API, it can be removed one day, once stabilized */
#ifdef DEBUGGING
#  define CvPADLIST_set(sv, padlist) Perl_set_padlist((CV*)sv, padlist)
#else
#  define CvPADLIST_set(sv, padlist) (CvPADLIST(sv) = (padlist))
#endif
#define CvHSCXT(sv)	  *(assert_(CvISXSUB((CV*)(sv))) \
        &(((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_padlist_u.xcv_hscxt))
#ifdef DEBUGGING
#  if PTRSIZE == 8
#    define PoisonPADLIST(sv) \
        (((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_padlist_u.xcv_padlist = (PADLIST *)UINT64_C(0xEFEFEFEFEFEFEFEF))
#  elif PTRSIZE == 4
#    define PoisonPADLIST(sv) \
        (((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_padlist_u.xcv_padlist = (PADLIST *)0xEFEFEFEF)
#  else
#    error unknown pointer size
#  endif
#else
#  define PoisonPADLIST(sv) NOOP
#endif

#define CvOUTSIDE(sv)	  ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_outside
#define CvOUTSIDE_SEQ(sv) ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_outside_seq
#define CvFLAGS(sv)	  ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_flags

/* These two are sometimes called on non-CVs */
#define CvPROTO(sv)                               \
        (                                          \
         SvPOK(sv)                                  \
          ? SvTYPE(sv) == SVt_PVCV && CvAUTOLOAD(sv) \
             ? SvEND(sv)+1 : SvPVX_const(sv)          \
          : NULL                                       \
        )
#define CvPROTOLEN(sv)	                          \
        (                                          \
         SvPOK(sv)                                  \
          ? SvTYPE(sv) == SVt_PVCV && CvAUTOLOAD(sv) \
             ? SvLEN(sv)-SvCUR(sv)-2                  \
             : SvCUR(sv)                               \
          : 0                                           \
        )

/* CV has the `:method` attribute. This used to be called CVf_METHOD but is
 * renamed to avoid collision with CVf_IsMETHOD */
#define CVf_NOWARN_AMBIGUOUS	0x0001

#define CVf_LVALUE	0x0002  /* CV return value can be used as lvalue */
#define CVf_CONST	0x0004  /* inlinable sub */
#define CVf_ISXSUB	0x0008	/* CV is an XSUB, not pure perl.  */

#define CVf_WEAKOUTSIDE	0x0010  /* CvOUTSIDE isn't ref counted */
#define CVf_CLONE	0x0020	/* anon CV uses external lexicals */
#define CVf_CLONED	0x0040	/* a clone of one of those */
#define CVf_ANON	0x0080	/* CV is not pointed to by a GV */
#define CVf_UNIQUE	0x0100	/* sub is only called once (eg PL_main_cv,
                                   require, eval). */
#define CVf_NODEBUG	0x0200	/* no DB::sub indirection for this CV
                                   (esp. useful for special XSUBs) */
#define CVf_CVGV_RC	0x0400	/* CvGV is reference counted */
#if defined(PERL_CORE) || defined(PERL_EXT)
# define CVf_SLABBED	0x0800	/* Holds refcount on op slab  */
#endif
#define CVf_DYNFILE	0x1000	/* The filename is malloced  */
#define CVf_AUTOLOAD	0x2000	/* SvPVX contains AUTOLOADed sub name  */
/* 0x4000 previously CVf_HASEVAL  */
#define CVf_NAMED	0x8000  /* Has a name HEK */
#define CVf_LEXICAL	0x10000 /* Omit package from name */
#define CVf_ANONCONST	0x20000 /* :const - create anonconst op */
#define CVf_SIGNATURE   0x40000 /* CV uses a signature */
#define CVf_REFCOUNTED_ANYSV 0x80000 /* CvXSUBANY().any_sv is refcounted */
#define CVf_IsMETHOD    0x100000 /* CV is a (real) method of a real class. Not
                                   to be confused with what used to be called
                                   CVf_METHOD; now CVf_NOWARN_AMBIGUOUS */
#define CVf_XS_RCSTACK  0x200000 /* the XS function understands a
                                    reference-counted stack */

/* This symbol for optimised communication between toke.c and op.c: */
#define CVf_BUILTIN_ATTRS	(CVf_NOWARN_AMBIGUOUS|CVf_LVALUE|CVf_ANONCONST)

#define CvCLONE(cv)		(CvFLAGS(cv) & CVf_CLONE)
#define CvCLONE_on(cv)		(CvFLAGS(cv) |= CVf_CLONE)
#define CvCLONE_off(cv)		(CvFLAGS(cv) &= ~CVf_CLONE)

#define CvCLONED(cv)		(CvFLAGS(cv) & CVf_CLONED)
#define CvCLONED_on(cv)		(CvFLAGS(cv) |= CVf_CLONED)
#define CvCLONED_off(cv)	(CvFLAGS(cv) &= ~CVf_CLONED)

#define CvANON(cv)		(CvFLAGS(cv) & CVf_ANON)
#define CvANON_on(cv)		(CvFLAGS(cv) |= CVf_ANON)
#define CvANON_off(cv)		(CvFLAGS(cv) &= ~CVf_ANON)

/* CvEVAL or CvSPECIAL */
#define CvUNIQUE(cv)		(CvFLAGS(cv) & CVf_UNIQUE)
#define CvUNIQUE_on(cv)		(CvFLAGS(cv) |= CVf_UNIQUE)
#define CvUNIQUE_off(cv)	(CvFLAGS(cv) &= ~CVf_UNIQUE)

#define CvNODEBUG(cv)		(CvFLAGS(cv) & CVf_NODEBUG)
#define CvNODEBUG_on(cv)	(CvFLAGS(cv) |= CVf_NODEBUG)
#define CvNODEBUG_off(cv)	(CvFLAGS(cv) &= ~CVf_NODEBUG)

#define CvNOWARN_AMBIGUOUS(cv)		(CvFLAGS(cv) & CVf_NOWARN_AMBIGUOUS)
#define CvNOWARN_AMBIGUOUS_on(cv)	(CvFLAGS(cv) |= CVf_NOWARN_AMBIGUOUS)
#define CvNOWARN_AMBIGUOUS_off(cv)	(CvFLAGS(cv) &= ~CVf_NOWARN_AMBIGUOUS)

#define CvLVALUE(cv)		(CvFLAGS(cv) & CVf_LVALUE)
#define CvLVALUE_on(cv)		(CvFLAGS(cv) |= CVf_LVALUE)
#define CvLVALUE_off(cv)	(CvFLAGS(cv) &= ~CVf_LVALUE)

/* eval or PL_main_cv */
#define CvEVAL(cv)		(CvUNIQUE(cv) && !SvFAKE(cv))
#define CvEVAL_on(cv)		(CvUNIQUE_on(cv),SvFAKE_off(cv))
#define CvEVAL_off(cv)		CvUNIQUE_off(cv)

/* BEGIN|CHECK|INIT|UNITCHECK|END */
#define CvSPECIAL(cv)		(CvUNIQUE(cv) && SvFAKE(cv))
#define CvSPECIAL_on(cv)	(CvUNIQUE_on(cv),SvFAKE_on(cv))
#define CvSPECIAL_off(cv)	(CvUNIQUE_off(cv),SvFAKE_off(cv))

#define CvCONST(cv)		(CvFLAGS(cv) & CVf_CONST)
#define CvCONST_on(cv)		(CvFLAGS(cv) |= CVf_CONST)
#define CvCONST_off(cv)		(CvFLAGS(cv) &= ~CVf_CONST)

#define CvWEAKOUTSIDE(cv)	(CvFLAGS(cv) & CVf_WEAKOUTSIDE)
#define CvWEAKOUTSIDE_on(cv)	(CvFLAGS(cv) |= CVf_WEAKOUTSIDE)
#define CvWEAKOUTSIDE_off(cv)	(CvFLAGS(cv) &= ~CVf_WEAKOUTSIDE)

#define CvISXSUB(cv)		(CvFLAGS(cv) & CVf_ISXSUB)
#define CvISXSUB_on(cv)		(CvFLAGS(cv) |= CVf_ISXSUB)
#define CvISXSUB_off(cv)	(CvFLAGS(cv) &= ~CVf_ISXSUB)

#define CvCVGV_RC(cv)		(CvFLAGS(cv) & CVf_CVGV_RC)
#define CvCVGV_RC_on(cv)	(CvFLAGS(cv) |= CVf_CVGV_RC)
#define CvCVGV_RC_off(cv)	(CvFLAGS(cv) &= ~CVf_CVGV_RC)

#ifdef PERL_CORE
# define CvSLABBED(cv)		(CvFLAGS(cv) & CVf_SLABBED)
# define CvSLABBED_on(cv)	(CvFLAGS(cv) |= CVf_SLABBED)
# define CvSLABBED_off(cv)	(CvFLAGS(cv) &= ~CVf_SLABBED)
#endif

#define CvDYNFILE(cv)		(CvFLAGS(cv) & CVf_DYNFILE)
#define CvDYNFILE_on(cv)	(CvFLAGS(cv) |= CVf_DYNFILE)
#define CvDYNFILE_off(cv)	(CvFLAGS(cv) &= ~CVf_DYNFILE)

#define CvAUTOLOAD(cv)		(CvFLAGS(cv) & CVf_AUTOLOAD)
#define CvAUTOLOAD_on(cv)	(CvFLAGS(cv) |= CVf_AUTOLOAD)
#define CvAUTOLOAD_off(cv)	(CvFLAGS(cv) &= ~CVf_AUTOLOAD)

#define CvNAMED(cv)		(CvFLAGS(cv) & CVf_NAMED)
#define CvNAMED_on(cv)		(CvFLAGS(cv) |= CVf_NAMED)
#define CvNAMED_off(cv)		(CvFLAGS(cv) &= ~CVf_NAMED)

#define CvLEXICAL(cv)		(CvFLAGS(cv) & CVf_LEXICAL)
#define CvLEXICAL_on(cv)	(CvFLAGS(cv) |= CVf_LEXICAL)
#define CvLEXICAL_off(cv)	(CvFLAGS(cv) &= ~CVf_LEXICAL)

#define CvANONCONST(cv)		(CvFLAGS(cv) & CVf_ANONCONST)
#define CvANONCONST_on(cv)	(CvFLAGS(cv) |= CVf_ANONCONST)
#define CvANONCONST_off(cv)	(CvFLAGS(cv) &= ~CVf_ANONCONST)

#define CvSIGNATURE(cv)		(CvFLAGS(cv) & CVf_SIGNATURE)
#define CvSIGNATURE_on(cv)	(CvFLAGS(cv) |= CVf_SIGNATURE)
#define CvSIGNATURE_off(cv)	(CvFLAGS(cv) &= ~CVf_SIGNATURE)

/*

=for apidoc m|bool|CvREFCOUNTED_ANYSV|CV *cv

If true, indicates that the C<CvXSUBANY(cv).any_sv> member contains an SV
pointer whose reference count should be decremented when the CV itself is
freed.  In addition, C<cv_clone()> will increment the reference count, and
C<sv_dup()> will duplicate the entire pointed-to SV if this flag is set.

Any CV that wraps an XSUB has an C<ANY> union that the XSUB function is free
to use for its own purposes.  It may be the case that the code wishes to store
an SV in the C<any_sv> member of this union.  By setting this flag, this SV
reference will be properly reclaimed or duplicated when the CV itself is.

=for apidoc m|void|CvREFCOUNTED_ANYSV_on|CV *cv

Helper macro to turn on the C<CvREFCOUNTED_ANYSV> flag.

=for apidoc m|void|CvREFCOUNTED_ANYSV_off|CV *cv

Helper macro to turn off the C<CvREFCOUNTED_ANYSV> flag.

=cut
*/

#define CvREFCOUNTED_ANYSV(cv)          (CvFLAGS(cv) & CVf_REFCOUNTED_ANYSV)
#define CvREFCOUNTED_ANYSV_on(cv)       (CvFLAGS(cv) |= CVf_REFCOUNTED_ANYSV)
#define CvREFCOUNTED_ANYSV_off(cv)      (CvFLAGS(cv) &= ~CVf_REFCOUNTED_ANYSV)

#define CvIsMETHOD(cv)		(CvFLAGS(cv) & CVf_IsMETHOD)
#define CvIsMETHOD_on(cv)	(CvFLAGS(cv) |= CVf_IsMETHOD)
#define CvIsMETHOD_off(cv)	(CvFLAGS(cv) &= ~CVf_IsMETHOD)

#define CvXS_RCSTACK(cv)        (CvFLAGS(cv) & CVf_XS_RCSTACK)
#define CvXS_RCSTACK_on(cv)     (CvFLAGS(cv) |= CVf_XS_RCSTACK)
#define CvXS_RCSTACK_off(cv)    (CvFLAGS(cv) &= ~CVf_XS_RCSTACK)

/* Back-compat */
#ifndef PERL_CORE
#  define CVf_METHOD            CVf_NOWARN_AMBIGUOUS
#  define CvMETHOD(cv)          CvNOWARN_AMBIGUOUS(cv)
#  define CvMETHOD_on(cv)       CvNOWARN_AMBIGUOUS_on(cv)
#  define CvMETHOD_off(cv)      CvNOWARN_AMBIGUOUS_off(cv)
#endif

/* Flags for newXS_flags  */
#define XS_DYNAMIC_FILENAME	0x01	/* The filename isn't static  */

PERL_STATIC_INLINE HEK *
CvNAME_HEK(CV *sv)
{
    return CvNAMED(sv)
        ? ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_gv_u.xcv_hek
        : 0;
}

/* helper for the common pattern:
   CvNAMED(sv) ? CvNAME_HEK((CV *)sv) : GvNAME_HEK(CvGV(sv))
*/
#define CvGvNAME_HEK(sv) ( \
        CvNAMED((CV*)sv) ? \
            ((XPVCV*)MUTABLE_PTR(SvANY((SV*)sv)))->xcv_gv_u.xcv_hek\
            : GvNAME_HEK(CvGV( (SV*) sv)) \
        )

/* This lowers the reference count of the previous value, but does *not*
   increment the reference count of the new value. */
#define CvNAME_HEK_set(cv, hek) ( \
        CvNAME_HEK((CV *)(cv))						 \
            ? unshare_hek(SvANY((CV *)(cv))->xcv_gv_u.xcv_hek)	  \
            : (void)0,						   \
        ((XPVCV*)MUTABLE_PTR(SvANY(cv)))->xcv_gv_u.xcv_hek = (hek), \
        CvNAMED_on(cv)						     \
    )

/*

=for apidoc m|bool|CvWEAKOUTSIDE|CV *cv

Each CV has a pointer, C<CvOUTSIDE()>, to its lexically enclosing
CV (if any).  Because pointers to anonymous sub prototypes are
stored in C<&> pad slots, it is a possible to get a circular reference,
with the parent pointing to the child and vice-versa.  To avoid the
ensuing memory leak, we do not increment the reference count of the CV
pointed to by C<CvOUTSIDE> in the I<one specific instance> that the parent
has a C<&> pad slot pointing back to us.  In this case, we set the
C<CvWEAKOUTSIDE> flag in the child.  This allows us to determine under what
circumstances we should decrement the refcount of the parent when freeing
the child.

There is a further complication with non-closure anonymous subs (i.e. those
that do not refer to any lexicals outside that sub).  In this case, the
anonymous prototype is shared rather than being cloned.  This has the
consequence that the parent may be freed while there are still active
children, I<e.g.>,

    BEGIN { $a = sub { eval '$x' } }

In this case, the BEGIN is freed immediately after execution since there
are no active references to it: the anon sub prototype has
C<CvWEAKOUTSIDE> set since it's not a closure, and $a points to the same
CV, so it doesn't contribute to BEGIN's refcount either.  When $a is
executed, the C<eval '$x'> causes the chain of C<CvOUTSIDE>s to be followed,
and the freed BEGIN is accessed.

To avoid this, whenever a CV and its associated pad is freed, any
C<&> entries in the pad are explicitly removed from the pad, and if the
refcount of the pointed-to anon sub is still positive, then that
child's C<CvOUTSIDE> is set to point to its grandparent.  This will only
occur in the single specific case of a non-closure anon prototype
having one or more active references (such as C<$a> above).

One other thing to consider is that a CV may be merely undefined
rather than freed, eg C<undef &foo>.  In this case, its refcount may
not have reached zero, but we still delete its pad and its C<CvROOT> etc.
Since various children may still have their C<CvOUTSIDE> pointing at this
undefined CV, we keep its own C<CvOUTSIDE> for the time being, so that
the chain of lexical scopes is unbroken.  For example, the following
should print 123:

    my $x = 123;
    sub tmp { sub { eval '$x' } }
    my $a = tmp();
    undef &tmp;
    print  $a->();

=cut
*/

typedef OP *(*Perl_call_checker)(pTHX_ OP *, GV *, SV *);

#define CALL_CHECKER_REQUIRE_GV	MGf_REQUIRE_GV

#define CV_NAME_NOTQUAL		1

#ifdef PERL_CORE
# define CV_UNDEF_KEEP_NAME	1
#endif

/*
 * ex: set ts=8 sts=4 sw=4 et:
 */
Commit	Line	Data
a0d0e21e	1	/* cv.h
79072805	2	*
1129b882 NC	3	* Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1999, 2000, 2001,
1129b882 NC	4	* 2002, 2003, 2004, 2005, 2006, 2007, 2008 by Larry Wall and others
79072805 LW	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	*
79072805 LW	9	*/
79072805 LW	10
f653aab7	11	/* This structure must match the beginning of XPVFM in sv.h */
44a8e56a	12
79072805	13	struct xpvcv {
20f4945e	14	_XPV_HEAD;
20f4945e	15	_XPVCV_COMMON;
79072805	16	};
748a9306	17
954c1994	18	/*
f204f8ac KW	19	=for apidoc Ayh\|\|CV
f204f8ac KW	20
78342678	21	=for apidoc ADmnU\|\|Nullcv
954c1994 GS	22	Null CV pointer.
954c1994 GS	23
3ae1b226 NC	24	(deprecated - use C<(CV *)NULL> instead)
3ae1b226 NC	25
954c1994	26	=for apidoc Am\|HV\|CvSTASH\|CV cv
72d33970	27	Returns the stash of the CV. A stash is the symbol table hash, containing
f0b90de1 SF	28	the package-scoped variables in the package where the subroutine was defined.
f0b90de1 SF	29	For more information, see L<perlguts>.
954c1994	30
5b36e945 FC	31	This also has a special use with XS AUTOLOAD subs.
	32	See L<perlguts/Autoloading with XSUBs>.
	33
954c1994 GS	34	=cut
	35	*/
	36
3ae1b226 NC	37	#ifndef PERL_CORE
	38	# define Nullcv Null(CV*)
	39	#endif
a5f75d66	40
a8b89476	41	#define CvSTASH(sv) (MUTABLE_HV(((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_stash))
c68d9564	42	#define CvSTASH_set(cv,st) Perl_cvstash_set(aTHX_ cv, st)
8f629a87 NC	43	#define CvSTART(sv) ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_start_u.xcv_start
	44	#define CvROOT(sv) ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_root_u.xcv_root
	45	#define CvXSUB(sv) ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_root_u.xcv_xsub
	46	#define CvXSUBANY(sv) ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_start_u.xcv_xsubany
c9182d9c	47	#define CvGV(sv) Perl_CvGV(aTHX_ (CV *)(sv))
b3f91e91	48	#define CvGV_set(cv,gv) Perl_cvgv_set(aTHX_ cv, gv)
ae77754a	49	#define CvHASGV(cv) cBOOL(SvANY(cv)->xcv_gv_u.xcv_gv)
8f629a87	50	#define CvFILE(sv) ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_file
a636914a	51	#ifdef USE_ITHREADS
bad4ae38 FC	52	# define CvFILE_set_from_cop(sv, cop) \
bad4ae38 FC	53	(CvFILE(sv) = savepv(CopFILE(cop)), CvDYNFILE_on(sv))
a636914a	54	#else
bad4ae38 FC	55	# define CvFILE_set_from_cop(sv, cop) \
bad4ae38 FC	56	(CvFILE(sv) = CopFILE(cop), CvDYNFILE_off(sv))
a636914a	57	#endif
9ec2a764	58	#define CvFILEGV(sv) (gv_fetchfile(CvFILE(sv)))
74804ad1	59	#define CvDEPTH(sv) (Perl_CvDEPTH((const CV )sv))
52ec28d5	60	/* For use when you only have a XPVCV, not a real CV.
74804ad1	61	Must be assert protected as in Perl_CvDEPTH before use. */
52ec28d5	62	#define CvDEPTHunsafe(sv) ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_depth
eacbb379 DD	63
	64	/* these CvPADLIST/CvRESERVED asserts can be reverted one day, once stabilized */
	65	#define CvPADLIST(sv) ((assert_(!CvISXSUB((CV)(sv))) \
1604cfb0	66	&(((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_padlist_u.xcv_padlist)))
eacbb379 DD	67	/* CvPADLIST_set is not public API, it can be removed one day, once stabilized */
eacbb379 DD	68	#ifdef DEBUGGING
e69651e7	69	# define CvPADLIST_set(sv, padlist) Perl_set_padlist((CV*)sv, padlist)
eacbb379 DD	70	#else
	71	# define CvPADLIST_set(sv, padlist) (CvPADLIST(sv) = (padlist))
	72	#endif
db6e00bd	73	#define CvHSCXT(sv) (assert_(CvISXSUB((CV)(sv))) \
1604cfb0	74	&(((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_padlist_u.xcv_hscxt))
eacbb379 DD	75	#ifdef DEBUGGING
	76	# if PTRSIZE == 8
	77	# define PoisonPADLIST(sv) \
	78	(((XPVCV)MUTABLE_PTR(SvANY(sv)))->xcv_padlist_u.xcv_padlist = (PADLIST )UINT64_C(0xEFEFEFEFEFEFEFEF))
	79	# elif PTRSIZE == 4
	80	# define PoisonPADLIST(sv) \
	81	(((XPVCV)MUTABLE_PTR(SvANY(sv)))->xcv_padlist_u.xcv_padlist = (PADLIST )0xEFEFEFEF)
	82	# else
	83	# error unknown pointer size
	84	# endif
	85	#else
eba7d13f	86	# define PoisonPADLIST(sv) NOOP
eacbb379 DD	87	#endif
eacbb379 DD	88
52ec28d5	89	#define CvOUTSIDE(sv) ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_outside
8f629a87	90	#define CvOUTSIDE_SEQ(sv) ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_outside_seq
52ec28d5	91	#define CvFLAGS(sv) ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_flags
a5f75d66	92
8fa6a409 FC	93	/* These two are sometimes called on non-CVs */
8fa6a409 FC	94	#define CvPROTO(sv) \
1604cfb0 MS	95	( \
	96	SvPOK(sv) \
	97	? SvTYPE(sv) == SVt_PVCV && CvAUTOLOAD(sv) \
	98	? SvEND(sv)+1 : SvPVX_const(sv) \
	99	: NULL \
	100	)
8fa6a409	101	#define CvPROTOLEN(sv) \
1604cfb0 MS	102	( \
	103	SvPOK(sv) \
	104	? SvTYPE(sv) == SVt_PVCV && CvAUTOLOAD(sv) \
	105	? SvLEN(sv)-SvCUR(sv)-2 \
	106	: SvCUR(sv) \
	107	: 0 \
	108	)
8fa6a409	109
ec11e338	110	/* CV has the `:method` attribute. This used to be called CVf_METHOD but is
99b497aa	111	* renamed to avoid collision with CVf_IsMETHOD */
ec11e338 PE	112	#define CVf_NOWARN_AMBIGUOUS 0x0001
ec11e338 PE	113
c2485e0c NC	114	#define CVf_LVALUE 0x0002 /* CV return value can be used as lvalue */
	115	#define CVf_CONST 0x0004 /* inlinable sub */
	116	#define CVf_ISXSUB 0x0008 /* CV is an XSUB, not pure perl. */
5b4563c8 NC	117
	118	#define CVf_WEAKOUTSIDE 0x0010 /* CvOUTSIDE isn't ref counted */
	119	#define CVf_CLONE 0x0020 /* anon CV uses external lexicals */
	120	#define CVf_CLONED 0x0040 /* a clone of one of those */
cfc1e951	121	#define CVf_ANON 0x0080 /* CV is not pointed to by a GV */
5b4563c8	122	#define CVf_UNIQUE 0x0100 /* sub is only called once (eg PL_main_cv,
034ae829	123	require, eval). */
5b4563c8	124	#define CVf_NODEBUG 0x0200 /* no DB::sub indirection for this CV
1604cfb0	125	(esp. useful for special XSUBs) */
cfc1e951	126	#define CVf_CVGV_RC 0x0400 /* CvGV is reference counted */
c6565d4b	127	#if defined(PERL_CORE) \|\| defined(PERL_EXT)
58aef2b3 FC	128	# define CVf_SLABBED 0x0800 /* Holds refcount on op slab */
58aef2b3 FC	129	#endif
f60d17f5	130	#define CVf_DYNFILE 0x1000 /* The filename is malloced */
8fa6a409	131	#define CVf_AUTOLOAD 0x2000 /* SvPVX contains AUTOLOADed sub name */
386907f0	132	/* 0x4000 previously CVf_HASEVAL */
b290562e	133	#define CVf_NAMED 0x8000 /* Has a name HEK */
5bb151a5	134	#define CVf_LEXICAL 0x10000 /* Omit package from name */
956dfca8	135	#define CVf_ANONCONST 0x20000 /* :const - create anonconst op */
36e6814d	136	#define CVf_SIGNATURE 0x40000 /* CV uses a signature */
b234f9dc	137	#define CVf_REFCOUNTED_ANYSV 0x80000 /* CvXSUBANY().any_sv is refcounted */
99b497aa PE	138	#define CVf_IsMETHOD 0x100000 /* CV is a (real) method of a real class. Not
	139	to be confused with what used to be called
	140	CVf_METHOD; now CVf_NOWARN_AMBIGUOUS */
8d69e95b DM	141	#define CVf_XS_RCSTACK 0x200000 /* the XS function understands a
8d69e95b DM	142	reference-counted stack */
7dafbf52	143
d3cea301	144	/* This symbol for optimised communication between toke.c and op.c: */
ec11e338	145	#define CVf_BUILTIN_ATTRS (CVf_NOWARN_AMBIGUOUS\|CVf_LVALUE\|CVf_ANONCONST)
a5f75d66 AD	146
	147	#define CvCLONE(cv) (CvFLAGS(cv) & CVf_CLONE)
	148	#define CvCLONE_on(cv) (CvFLAGS(cv) \|= CVf_CLONE)
	149	#define CvCLONE_off(cv) (CvFLAGS(cv) &= ~CVf_CLONE)
	150
	151	#define CvCLONED(cv) (CvFLAGS(cv) & CVf_CLONED)
	152	#define CvCLONED_on(cv) (CvFLAGS(cv) \|= CVf_CLONED)
	153	#define CvCLONED_off(cv) (CvFLAGS(cv) &= ~CVf_CLONED)
	154
	155	#define CvANON(cv) (CvFLAGS(cv) & CVf_ANON)
	156	#define CvANON_on(cv) (CvFLAGS(cv) \|= CVf_ANON)
	157	#define CvANON_off(cv) (CvFLAGS(cv) &= ~CVf_ANON)
79072805	158
a2278b6a	159	/* CvEVAL or CvSPECIAL */
07055b4c CS	160	#define CvUNIQUE(cv) (CvFLAGS(cv) & CVf_UNIQUE)
	161	#define CvUNIQUE_on(cv) (CvFLAGS(cv) \|= CVf_UNIQUE)
	162	#define CvUNIQUE_off(cv) (CvFLAGS(cv) &= ~CVf_UNIQUE)
8ebc5c01	163
	164	#define CvNODEBUG(cv) (CvFLAGS(cv) & CVf_NODEBUG)
	165	#define CvNODEBUG_on(cv) (CvFLAGS(cv) \|= CVf_NODEBUG)
	166	#define CvNODEBUG_off(cv) (CvFLAGS(cv) &= ~CVf_NODEBUG)
77a005ab	167
ec11e338 PE	168	#define CvNOWARN_AMBIGUOUS(cv) (CvFLAGS(cv) & CVf_NOWARN_AMBIGUOUS)
	169	#define CvNOWARN_AMBIGUOUS_on(cv) (CvFLAGS(cv) \|= CVf_NOWARN_AMBIGUOUS)
	170	#define CvNOWARN_AMBIGUOUS_off(cv) (CvFLAGS(cv) &= ~CVf_NOWARN_AMBIGUOUS)
77a005ab	171
cd06dffe GS	172	#define CvLVALUE(cv) (CvFLAGS(cv) & CVf_LVALUE)
	173	#define CvLVALUE_on(cv) (CvFLAGS(cv) \|= CVf_LVALUE)
	174	#define CvLVALUE_off(cv) (CvFLAGS(cv) &= ~CVf_LVALUE)
	175
a2278b6a	176	/* eval or PL_main_cv */
1aff0e91 GS	177	#define CvEVAL(cv) (CvUNIQUE(cv) && !SvFAKE(cv))
	178	#define CvEVAL_on(cv) (CvUNIQUE_on(cv),SvFAKE_off(cv))
	179	#define CvEVAL_off(cv) CvUNIQUE_off(cv)
	180
3c10abe3	181	/* BEGIN\|CHECK\|INIT\|UNITCHECK\|END */
1aff0e91 GS	182	#define CvSPECIAL(cv) (CvUNIQUE(cv) && SvFAKE(cv))
	183	#define CvSPECIAL_on(cv) (CvUNIQUE_on(cv),SvFAKE_on(cv))
	184	#define CvSPECIAL_off(cv) (CvUNIQUE_off(cv),SvFAKE_off(cv))
beab0874 JT	185
	186	#define CvCONST(cv) (CvFLAGS(cv) & CVf_CONST)
	187	#define CvCONST_on(cv) (CvFLAGS(cv) \|= CVf_CONST)
	188	#define CvCONST_off(cv) (CvFLAGS(cv) &= ~CVf_CONST)
a4f1a029	189
7dafbf52 DM	190	#define CvWEAKOUTSIDE(cv) (CvFLAGS(cv) & CVf_WEAKOUTSIDE)
	191	#define CvWEAKOUTSIDE_on(cv) (CvFLAGS(cv) \|= CVf_WEAKOUTSIDE)
	192	#define CvWEAKOUTSIDE_off(cv) (CvFLAGS(cv) &= ~CVf_WEAKOUTSIDE)
	193
d04ba589 NC	194	#define CvISXSUB(cv) (CvFLAGS(cv) & CVf_ISXSUB)
	195	#define CvISXSUB_on(cv) (CvFLAGS(cv) \|= CVf_ISXSUB)
	196	#define CvISXSUB_off(cv) (CvFLAGS(cv) &= ~CVf_ISXSUB)
	197
cfc1e951 DM	198	#define CvCVGV_RC(cv) (CvFLAGS(cv) & CVf_CVGV_RC)
	199	#define CvCVGV_RC_on(cv) (CvFLAGS(cv) \|= CVf_CVGV_RC)
	200	#define CvCVGV_RC_off(cv) (CvFLAGS(cv) &= ~CVf_CVGV_RC)
	201
58aef2b3 FC	202	#ifdef PERL_CORE
	203	# define CvSLABBED(cv) (CvFLAGS(cv) & CVf_SLABBED)
	204	# define CvSLABBED_on(cv) (CvFLAGS(cv) \|= CVf_SLABBED)
	205	# define CvSLABBED_off(cv) (CvFLAGS(cv) &= ~CVf_SLABBED)
	206	#endif
	207
bad4ae38 FC	208	#define CvDYNFILE(cv) (CvFLAGS(cv) & CVf_DYNFILE)
	209	#define CvDYNFILE_on(cv) (CvFLAGS(cv) \|= CVf_DYNFILE)
	210	#define CvDYNFILE_off(cv) (CvFLAGS(cv) &= ~CVf_DYNFILE)
	211
8fa6a409 FC	212	#define CvAUTOLOAD(cv) (CvFLAGS(cv) & CVf_AUTOLOAD)
	213	#define CvAUTOLOAD_on(cv) (CvFLAGS(cv) \|= CVf_AUTOLOAD)
	214	#define CvAUTOLOAD_off(cv) (CvFLAGS(cv) &= ~CVf_AUTOLOAD)
	215
b290562e FC	216	#define CvNAMED(cv) (CvFLAGS(cv) & CVf_NAMED)
	217	#define CvNAMED_on(cv) (CvFLAGS(cv) \|= CVf_NAMED)
	218	#define CvNAMED_off(cv) (CvFLAGS(cv) &= ~CVf_NAMED)
	219
5bb151a5 FC	220	#define CvLEXICAL(cv) (CvFLAGS(cv) & CVf_LEXICAL)
	221	#define CvLEXICAL_on(cv) (CvFLAGS(cv) \|= CVf_LEXICAL)
	222	#define CvLEXICAL_off(cv) (CvFLAGS(cv) &= ~CVf_LEXICAL)
	223
956dfca8 FC	224	#define CvANONCONST(cv) (CvFLAGS(cv) & CVf_ANONCONST)
	225	#define CvANONCONST_on(cv) (CvFLAGS(cv) \|= CVf_ANONCONST)
	226	#define CvANONCONST_off(cv) (CvFLAGS(cv) &= ~CVf_ANONCONST)
	227
36e6814d PE	228	#define CvSIGNATURE(cv) (CvFLAGS(cv) & CVf_SIGNATURE)
	229	#define CvSIGNATURE_on(cv) (CvFLAGS(cv) \|= CVf_SIGNATURE)
	230	#define CvSIGNATURE_off(cv) (CvFLAGS(cv) &= ~CVf_SIGNATURE)
	231
b234f9dc PE	232	/*
	233
	234	=for apidoc m\|bool\|CvREFCOUNTED_ANYSV\|CV *cv
	235
	236	If true, indicates that the C<CvXSUBANY(cv).any_sv> member contains an SV
	237	pointer whose reference count should be decremented when the CV itself is
	238	freed. In addition, C<cv_clone()> will increment the reference count, and
	239	C<sv_dup()> will duplicate the entire pointed-to SV if this flag is set.
	240
	241	Any CV that wraps an XSUB has an C<ANY> union that the XSUB function is free
	242	to use for its own purposes. It may be the case that the code wishes to store
	243	an SV in the C<any_sv> member of this union. By setting this flag, this SV
	244	reference will be properly reclaimed or duplicated when the CV itself is.
	245
	246	=for apidoc m\|void\|CvREFCOUNTED_ANYSV_on\|CV *cv
	247
	248	Helper macro to turn on the C<CvREFCOUNTED_ANYSV> flag.
	249
	250	=for apidoc m\|void\|CvREFCOUNTED_ANYSV_off\|CV *cv
	251
	252	Helper macro to turn off the C<CvREFCOUNTED_ANYSV> flag.
434ccf36 DM	253
434ccf36 DM	254	=cut
b234f9dc PE	255	*/
	256
	257	#define CvREFCOUNTED_ANYSV(cv) (CvFLAGS(cv) & CVf_REFCOUNTED_ANYSV)
	258	#define CvREFCOUNTED_ANYSV_on(cv) (CvFLAGS(cv) \|= CVf_REFCOUNTED_ANYSV)
	259	#define CvREFCOUNTED_ANYSV_off(cv) (CvFLAGS(cv) &= ~CVf_REFCOUNTED_ANYSV)
	260
99b497aa PE	261	#define CvIsMETHOD(cv) (CvFLAGS(cv) & CVf_IsMETHOD)
	262	#define CvIsMETHOD_on(cv) (CvFLAGS(cv) \|= CVf_IsMETHOD)
	263	#define CvIsMETHOD_off(cv) (CvFLAGS(cv) &= ~CVf_IsMETHOD)
	264
8d69e95b DM	265	#define CvXS_RCSTACK(cv) (CvFLAGS(cv) & CVf_XS_RCSTACK)
	266	#define CvXS_RCSTACK_on(cv) (CvFLAGS(cv) \|= CVf_XS_RCSTACK)
	267	#define CvXS_RCSTACK_off(cv) (CvFLAGS(cv) &= ~CVf_XS_RCSTACK)
	268
3a276a13 PE	269	/* Back-compat */
	270	#ifndef PERL_CORE
	271	# define CVf_METHOD CVf_NOWARN_AMBIGUOUS
	272	# define CvMETHOD(cv) CvNOWARN_AMBIGUOUS(cv)
	273	# define CvMETHOD_on(cv) CvNOWARN_AMBIGUOUS_on(cv)
ff5bbe67	274	# define CvMETHOD_off(cv) CvNOWARN_AMBIGUOUS_off(cv)
3a276a13 PE	275	#endif
3a276a13 PE	276
77004dee NC	277	/* Flags for newXS_flags */
	278	#define XS_DYNAMIC_FILENAME 0x01 /* The filename isn't static */
	279
b290562e FC	280	PERL_STATIC_INLINE HEK *
	281	CvNAME_HEK(CV *sv)
	282	{
	283	return CvNAMED(sv)
1604cfb0 MS	284	? ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_gv_u.xcv_hek
1604cfb0 MS	285	: 0;
b290562e	286	}
79656330 N	287
	288	/* helper for the common pattern:
	289	CvNAMED(sv) ? CvNAME_HEK((CV *)sv) : GvNAME_HEK(CvGV(sv))
	290	*/
	291	#define CvGvNAME_HEK(sv) ( \
	292	CvNAMED((CV*)sv) ? \
	293	((XPVCV)MUTABLE_PTR(SvANY((SV)sv)))->xcv_gv_u.xcv_hek\
	294	: GvNAME_HEK(CvGV( (SV*) sv)) \
	295	)
	296
	297	/* This lowers the reference count of the previous value, but does not
2e800d79 FC	298	increment the reference count of the new value. */
2e800d79 FC	299	#define CvNAME_HEK_set(cv, hek) ( \
1604cfb0 MS	300	CvNAME_HEK((CV *)(cv)) \
	301	? unshare_hek(SvANY((CV *)(cv))->xcv_gv_u.xcv_hek) \
	302	: (void)0, \
	303	((XPVCV*)MUTABLE_PTR(SvANY(cv)))->xcv_gv_u.xcv_hek = (hek), \
	304	CvNAMED_on(cv) \
2e800d79	305	)
b290562e	306
7dafbf52	307	/*
7dafbf52 DM	308
	309	=for apidoc m\|bool\|CvWEAKOUTSIDE\|CV *cv
	310
	311	Each CV has a pointer, C<CvOUTSIDE()>, to its lexically enclosing
154e47c8	312	CV (if any). Because pointers to anonymous sub prototypes are
7dafbf52	313	stored in C<&> pad slots, it is a possible to get a circular reference,
154e47c8	314	with the parent pointing to the child and vice-versa. To avoid the
7dafbf52 DM	315	ensuing memory leak, we do not increment the reference count of the CV
7dafbf52 DM	316	pointed to by C<CvOUTSIDE> in the I<one specific instance> that the parent
154e47c8 FC	317	has a C<&> pad slot pointing back to us. In this case, we set the
154e47c8 FC	318	C<CvWEAKOUTSIDE> flag in the child. This allows us to determine under what
7dafbf52 DM	319	circumstances we should decrement the refcount of the parent when freeing
	320	the child.
	321
eeb8d49e	322	There is a further complication with non-closure anonymous subs (i.e. those
154e47c8 FC	323	that do not refer to any lexicals outside that sub). In this case, the
154e47c8 FC	324	anonymous prototype is shared rather than being cloned. This has the
7dafbf52	325	consequence that the parent may be freed while there are still active
dfcfced8	326	children, I<e.g.>,
7dafbf52 DM	327
	328	BEGIN { $a = sub { eval '$x' } }
	329
	330	In this case, the BEGIN is freed immediately after execution since there
	331	are no active references to it: the anon sub prototype has
	332	C<CvWEAKOUTSIDE> set since it's not a closure, and $a points to the same
	333	CV, so it doesn't contribute to BEGIN's refcount either. When $a is
	334	executed, the C<eval '$x'> causes the chain of C<CvOUTSIDE>s to be followed,
	335	and the freed BEGIN is accessed.
	336
	337	To avoid this, whenever a CV and its associated pad is freed, any
	338	C<&> entries in the pad are explicitly removed from the pad, and if the
	339	refcount of the pointed-to anon sub is still positive, then that
154e47c8	340	child's C<CvOUTSIDE> is set to point to its grandparent. This will only
7dafbf52 DM	341	occur in the single specific case of a non-closure anon prototype
	342	having one or more active references (such as C<$a> above).
	343
	344	One other thing to consider is that a CV may be merely undefined
154e47c8	345	rather than freed, eg C<undef &foo>. In this case, its refcount may
7dafbf52 DM	346	not have reached zero, but we still delete its pad and its C<CvROOT> etc.
	347	Since various children may still have their C<CvOUTSIDE> pointing at this
	348	undefined CV, we keep its own C<CvOUTSIDE> for the time being, so that
154e47c8	349	the chain of lexical scopes is unbroken. For example, the following
7dafbf52 DM	350	should print 123:
	351
	352	my $x = 123;
	353	sub tmp { sub { eval '$x' } }
	354	my $a = tmp();
	355	undef &tmp;
	356	print $a->();
	357
	358	=cut
	359	*/
102d3b8a	360
d9088386 Z	361	typedef OP (Perl_call_checker)(pTHX_ OP , GV , SV *);
d9088386 Z	362
aa38f4b1 FC	363	#define CALL_CHECKER_REQUIRE_GV MGf_REQUIRE_GV
aa38f4b1 FC	364
5e881495 FC	365	#define CV_NAME_NOTQUAL 1
5e881495 FC	366
b7acb0a3 FC	367	#ifdef PERL_CORE
	368	# define CV_UNDEF_KEEP_NAME 1
	369	#endif
	370
102d3b8a	371	/*
14d04a33	372	* ex: set ts=8 sts=4 sw=4 et:
102d3b8a	373	*/