This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
pad.h: Parameters to many functions are ptrs
[perl5.git] / pad.h
diff --git a/pad.h b/pad.h
index 5be78c0..1c15d58 100644 (file)
--- a/pad.h
+++ b/pad.h
 
 /* offsets within a pad */
 
-#if PTRSIZE == 4
-typedef U32TYPE PADOFFSET;
-#else
-#   if PTRSIZE == 8
-typedef U64TYPE PADOFFSET;
-#   endif
-#endif
+typedef SSize_t PADOFFSET; /* signed so that -1 is a valid value */
 #define NOT_IN_PAD ((PADOFFSET) -1)
 
 /* B.xs expects the first members of these two structs to line up
@@ -33,8 +27,17 @@ typedef U64TYPE PADOFFSET;
 
 struct padlist {
     SSize_t    xpadl_max;      /* max index for which array has space */
-    PAD **     xpadl_alloc;    /* pointer to beginning of array of AVs */
-    PADNAMELIST*xpadl_outid;   /* Padnamelist of outer pad; used as ID */
+    union {
+       PAD **  xpadlarr_alloc; /* Pointer to beginning of array of AVs.
+                                  index 0 is a padnamelist *          */
+       struct {
+           PADNAMELIST * padnl;
+           PAD * pad_1;        /* this slice of PAD * array always alloced */
+           PAD * pad_2;        /* maybe unalloced */
+       } * xpadlarr_dbg;       /* for use with a C debugger only */
+    } xpadl_arr;
+    U32                xpadl_id;       /* Semi-unique ID, shared between clones */
+    U32                xpadl_outid;    /* ID of outer pad */
 };
 
 struct padnamelist {
@@ -45,6 +48,49 @@ struct padnamelist {
     U32                xpadnl_refcnt;
 };
 
+/* PERL_PADNAME_MINIMAL uses less memory, but on some platforms
+   PERL_PADNAME_ALIGNED may be faster, so platform-specific hints can
+   define one or the other.  */
+#if defined(PERL_PADNAME_MINIMAL) && defined (PERL_PADNAME_ALIGNED)
+#  error PERL_PADNAME_MINIMAL and PERL_PADNAME_ALIGNED are exclusive
+#endif
+
+#if !defined(PERL_PADNAME_MINIMAL) && !defined(PERL_PADNAME_ALIGNED)
+#  define PERL_PADNAME_MINIMAL
+#endif
+
+#define _PADNAME_BASE \
+    char *     xpadn_pv;               \
+    HV *       xpadn_ourstash;         \
+    union {                            \
+       HV *    xpadn_typestash;        \
+       CV *    xpadn_protocv;          \
+    } xpadn_type_u;                    \
+    U32                xpadn_low;              \
+    U32                xpadn_high;             \
+    U32                xpadn_refcnt;           \
+    int                xpadn_gen;              \
+    U8         xpadn_len;              \
+    U8         xpadn_flags
+
+struct padname {
+    _PADNAME_BASE;
+};
+
+struct padname_with_str {
+#ifdef PERL_PADNAME_MINIMAL
+    _PADNAME_BASE;
+#else
+    struct padname     xpadn_padname;
+#endif
+    char               xpadn_str[1];
+};
+
+#undef _PADNAME_BASE
+
+#define PADNAME_FROM_PV(s) \
+    ((PADNAME *)((s) - STRUCT_OFFSET(struct padname_with_str, xpadn_str)))
+
 
 /* a value that PL_cop_seqmax is guaranteed never to be,
  * flagging that a lexical is being introduced, or has not yet left scope
@@ -59,63 +105,10 @@ struct padnamelist {
 /* Low range end is exclusive (valid from the cop seq after this one) */
 /* High range end is inclusive (valid up to this cop seq) */
 
-#if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
-#  define COP_SEQ_RANGE_LOW(sv)                                                \
-       (({ const SV *const _sv_cop_seq_range_low = (const SV *) (sv);  \
-         assert(SvTYPE(_sv_cop_seq_range_low) == SVt_NV                \
-                || SvTYPE(_sv_cop_seq_range_low) >= SVt_PVNV);         \
-         assert(SvTYPE(_sv_cop_seq_range_low) != SVt_PVAV);            \
-         assert(SvTYPE(_sv_cop_seq_range_low) != SVt_PVHV);            \
-         assert(SvTYPE(_sv_cop_seq_range_low) != SVt_PVCV);            \
-         assert(SvTYPE(_sv_cop_seq_range_low) != SVt_PVFM);            \
-         assert(!isGV_with_GP(_sv_cop_seq_range_low));                 \
-         ((XPVNV*) MUTABLE_PTR(SvANY(_sv_cop_seq_range_low)))->xnv_u.xpad_cop_seq.xlow; \
-        }))
-#  define COP_SEQ_RANGE_HIGH(sv)                                       \
-       (({ const SV *const _sv_cop_seq_range_high = (const SV *) (sv); \
-         assert(SvTYPE(_sv_cop_seq_range_high) == SVt_NV               \
-                 || SvTYPE(_sv_cop_seq_range_high) >= SVt_PVNV);       \
-         assert(SvTYPE(_sv_cop_seq_range_high) != SVt_PVAV);           \
-         assert(SvTYPE(_sv_cop_seq_range_high) != SVt_PVHV);           \
-         assert(SvTYPE(_sv_cop_seq_range_high) != SVt_PVCV);           \
-         assert(SvTYPE(_sv_cop_seq_range_high) != SVt_PVFM);           \
-         assert(!isGV_with_GP(_sv_cop_seq_range_high));                \
-         ((XPVNV*) MUTABLE_PTR(SvANY(_sv_cop_seq_range_high)))->xnv_u.xpad_cop_seq.xhigh; \
-        }))
-#  define PARENT_PAD_INDEX(sv)                                         \
-       (({ const SV *const _sv_parent_pad_index = (const SV *) (sv);   \
-         assert(SvTYPE(_sv_parent_pad_index) == SVt_NV                 \
-                || SvTYPE(_sv_parent_pad_index) >= SVt_PVNV);          \
-         assert(SvTYPE(_sv_parent_pad_index) != SVt_PVAV);             \
-         assert(SvTYPE(_sv_parent_pad_index) != SVt_PVHV);             \
-         assert(SvTYPE(_sv_parent_pad_index) != SVt_PVCV);             \
-         assert(SvTYPE(_sv_parent_pad_index) != SVt_PVFM);             \
-         assert(!isGV_with_GP(_sv_parent_pad_index));                  \
-         ((XPVNV*) MUTABLE_PTR(SvANY(_sv_parent_pad_index)))->xnv_u.xpad_cop_seq.xlow; \
-        }))
-#  define PARENT_FAKELEX_FLAGS(sv)                                     \
-       (({ const SV *const _sv_parent_fakelex_flags = (const SV *) (sv); \
-         assert(SvTYPE(_sv_parent_fakelex_flags) == SVt_NV             \
-                || SvTYPE(_sv_parent_fakelex_flags) >= SVt_PVNV);      \
-         assert(SvTYPE(_sv_parent_fakelex_flags) != SVt_PVAV);         \
-         assert(SvTYPE(_sv_parent_fakelex_flags) != SVt_PVHV);         \
-         assert(SvTYPE(_sv_parent_fakelex_flags) != SVt_PVCV);         \
-         assert(SvTYPE(_sv_parent_fakelex_flags) != SVt_PVFM);         \
-         assert(!isGV_with_GP(_sv_parent_fakelex_flags));              \
-         ((XPVNV*) MUTABLE_PTR(SvANY(_sv_parent_fakelex_flags)))->xnv_u.xpad_cop_seq.xhigh; \
-        }))
-#else
-#  define COP_SEQ_RANGE_LOW(sv)                \
-       (0 + (((XPVNV*) SvANY(sv))->xnv_u.xpad_cop_seq.xlow))
-#  define COP_SEQ_RANGE_HIGH(sv)       \
-       (0 + (((XPVNV*) SvANY(sv))->xnv_u.xpad_cop_seq.xhigh))
-
-
-#  define PARENT_PAD_INDEX(sv)         \
-       (0 + (((XPVNV*) SvANY(sv))->xnv_u.xpad_cop_seq.xlow))
-#  define PARENT_FAKELEX_FLAGS(sv)     \
-       (0 + (((XPVNV*) SvANY(sv))->xnv_u.xpad_cop_seq.xhigh))
-#endif
+#define COP_SEQ_RANGE_LOW(pn)          (pn)->xpadn_low
+#define COP_SEQ_RANGE_HIGH(pn)         (pn)->xpadn_high
+#define PARENT_PAD_INDEX(pn)           (pn)->xpadn_low
+#define PARENT_FAKELEX_FLAGS(pn)       (pn)->xpadn_high
 
 /* Flags set in the SvIVX field of FAKE namesvs */
 
@@ -180,81 +173,87 @@ Save a pad slot (used to restore after an iteration)
 XXX DAPM it would make more sense to make the arg a PADOFFSET
 =for apidoc m|void|SAVECLEARSV |SV **svp
 Clear the pointed to pad value on scope exit.  (i.e. the runtime action of
-'my')
+C<my>)
 
 =for apidoc m|void|SAVECOMPPAD
-save PL_comppad and PL_curpad
+save C<PL_comppad> and C<PL_curpad>
 
 
-=for apidoc Amx|PAD **|PadlistARRAY|PADLIST padlist
+=for apidoc Amx|PAD **|PadlistARRAY|PADLIST padlist
 The C array of a padlist, containing the pads.  Only subscript it with
 numbers >= 1, as the 0th entry is not guaranteed to remain usable.
 
-=for apidoc Amx|SSize_t|PadlistMAX|PADLIST padlist
+=for apidoc Amx|SSize_t|PadlistMAX|PADLIST padlist
 The index of the last allocated space in the padlist.  Note that the last
-pad may be in an earlier slot.  Any entries following it will be NULL in
+pad may be in an earlier slot.  Any entries following it will be C<NULL> in
 that case.
 
-=for apidoc Amx|PADNAMELIST *|PadlistNAMES|PADLIST padlist
+=for apidoc Amx|PADNAMELIST *|PadlistNAMES|PADLIST padlist
 The names associated with pad entries.
 
-=for apidoc Amx|PADNAME **|PadlistNAMESARRAY|PADLIST padlist
+=for apidoc Amx|PADNAME **|PadlistNAMESARRAY|PADLIST padlist
 The C array of pad names.
 
-=for apidoc Amx|SSize_t|PadlistNAMESMAX|PADLIST padlist
+=for apidoc Amx|SSize_t|PadlistNAMESMAX|PADLIST padlist
 The index of the last pad name.
 
-=for apidoc Amx|U32|PadlistREFCNT|PADLIST padlist
+=for apidoc Amx|U32|PadlistREFCNT|PADLIST padlist
 The reference count of the padlist.  Currently this is always 1.
 
-=for apidoc Amx|PADNAME **|PadnamelistARRAY|PADNAMELIST pnl
+=for apidoc Amx|PADNAME **|PadnamelistARRAY|PADNAMELIST pnl
 The C array of pad names.
 
-=for apidoc Amx|SSize_t|PadnamelistMAX|PADNAMELIST pnl
+=for apidoc Amx|SSize_t|PadnamelistMAX|PADNAMELIST pnl
 The index of the last pad name.
 
-=for apidoc Amx|SSize_t|PadnamelistREFCNT|PADNAMELIST pnl
+=for apidoc Amx|SSize_t|PadnamelistREFCNT|PADNAMELIST pnl
 The reference count of the pad name list.
 
-=for apidoc Amx|void|PadnamelistREFCNT_dec|PADNAMELIST pnl
+=for apidoc Amx|void|PadnamelistREFCNT_dec|PADNAMELIST pnl
 Lowers the reference count of the pad name list.
 
-=for apidoc Amx|SV **|PadARRAY|PAD pad
+=for apidoc Amx|SV **|PadARRAY|PAD pad
 The C array of pad entries.
 
-=for apidoc Amx|SSize_t|PadMAX|PAD pad
+=for apidoc Amx|SSize_t|PadMAX|PAD pad
 The index of the last pad entry.
 
-=for apidoc Amx|char *|PadnamePV|PADNAME pn    
-The name stored in the pad name struct.  This returns NULL for a target
+=for apidoc Amx|char *|PadnamePV|PADNAME * pn
+The name stored in the pad name struct.  This returns C<NULL> for a target
 slot.
 
-=for apidoc Amx|STRLEN|PadnameLEN|PADNAME pn   
+=for apidoc Amx|STRLEN|PadnameLEN|PADNAME * pn
 The length of the name.
 
-=for apidoc Amx|bool|PadnameUTF8|PADNAME pn
-Whether PadnamePV is in UTF8.  Currently, this is always true.
+=for apidoc Amx|bool|PadnameUTF8|PADNAME pn
+Whether PadnamePV is in UTF-8.  Currently, this is always true.
 
-=for apidoc Amx|SV *|PadnameSV|PADNAME pn
-Returns the pad name as an SV.  This is currently just C<pn>.  It will
-begin returning a new mortal SV if pad names ever stop being SVs.
+=for apidoc Amx|SV *|PadnameSV|PADNAME * pn
+Returns the pad name as a mortal SV.
 
-=for apidoc m|bool|PadnameIsOUR|PADNAME pn
+=for apidoc m|bool|PadnameIsOUR|PADNAME pn
 Whether this is an "our" variable.
 
 =for apidoc m|HV *|PadnameOURSTASH
 The stash in which this "our" variable was declared.
 
-=for apidoc m|bool|PadnameOUTER|PADNAME pn
-Whether this entry belongs to an outer pad.
+=for apidoc m|bool|PadnameOUTER|PADNAME * pn
+Whether this entry belongs to an outer pad.  Entries for which this is true
+are often referred to as 'fake'.
 
-=for apidoc m|bool|PadnameIsSTATE|PADNAME pn
+=for apidoc m|bool|PadnameIsSTATE|PADNAME pn
 Whether this is a "state" variable.
 
-=for apidoc m|HV *|PadnameTYPE|PADNAME pn
-The stash associated with a typed lexical.  This returns the %Foo:: hash
+=for apidoc m|HV *|PadnameTYPE|PADNAME pn
+The stash associated with a typed lexical.  This returns the C<%Foo::> hash
 for C<my Foo $bar>.
 
+=for apidoc Amx|SSize_t|PadnameREFCNT|PADNAME * pn
+The reference count of the pad name.
+
+=for apidoc Amx|void|PadnameREFCNT_dec|PADNAME * pn
+Lowers the reference count of the pad name.
+
 
 =for apidoc m|SV *|PAD_SETSV   |PADOFFSET po|SV* sv
 Set the slot at offset C<po> in the current pad to C<sv>
@@ -287,18 +286,18 @@ like PAD_SET_CUR, but without the save
 Save the current pad then set it to null.
 
 =for apidoc m|void|PAD_SAVE_LOCAL|PAD *opad|PAD *npad
-Save the current pad to the local variable opad, then make the
-current pad equal to npad
+Save the current pad to the local variable C<opad>, then make the
+current pad equal to C<npad>
 
 =for apidoc m|void|PAD_RESTORE_LOCAL|PAD *opad
-Restore the old pad saved into the local variable opad by PAD_SAVE_LOCAL()
+Restore the old pad saved into the local variable C<opad> by C<PAD_SAVE_LOCAL()>
 
 =cut
 */
 
-#define PadlistARRAY(pl)       (pl)->xpadl_alloc
+#define PadlistARRAY(pl)       (pl)->xpadl_arr.xpadlarr_alloc
 #define PadlistMAX(pl)         (pl)->xpadl_max
-#define PadlistNAMES(pl)       ((PADNAMELIST *)*PadlistARRAY(pl))
+#define PadlistNAMES(pl)       *((PADNAMELIST **)PadlistARRAY(pl))
 #define PadlistNAMESARRAY(pl)  PadnamelistARRAY(PadlistNAMES(pl))
 #define PadlistNAMESMAX(pl)    PadnamelistMAX(PadlistNAMES(pl))
 #define PadlistREFCNT(pl)      1       /* reserved for future use */
@@ -312,19 +311,45 @@ Restore the old pad saved into the local variable opad by PAD_SAVE_LOCAL()
 #define PadARRAY(pad)          AvARRAY(pad)
 #define PadMAX(pad)            AvFILLp(pad)
 
-#define PadnamePV(pn)          (SvPOKp(pn) ? SvPVX_const(pn) : NULL)
-#define PadnameLEN(pn)         ((SV*)(pn) == &PL_sv_undef ? 0 : SvCUR(pn))
-#define PadnameUTF8(pn)                (assert_(SvUTF8(pn)) 1)
-#define PadnameSV(pn)          pn
-#define PadnameIsOUR(pn)       !!SvPAD_OUR(pn)
-#define PadnameOURSTASH(pn)    SvOURSTASH(pn)
-#define PadnameOUTER(pn)       !!SvFAKE(pn)
-#define PadnameIsSTATE(pn)     !!SvPAD_STATE(pn)
-#define PadnameTYPE(pn)                (SvPAD_TYPED(pn) ? SvSTASH(pn) : NULL)
-#define PadnameLVALUE(pn) \
-    ((SvFLAGS(pn) & (SVpad_NAME|SVpad_LVALUE))==(SVpad_NAME|SVpad_LVALUE))
-
-#define PadnameLVALUE_on(pn)   (SvFLAGS(pn) |= SVpad_NAME|SVpad_LVALUE)
+#define PadnamePV(pn)          (pn)->xpadn_pv
+#define PadnameLEN(pn)         (pn)->xpadn_len
+#define PadnameUTF8(pn)                1
+#define PadnameSV(pn) \
+       newSVpvn_flags(PadnamePV(pn), PadnameLEN(pn), SVs_TEMP|SVf_UTF8)
+#define PadnameFLAGS(pn)       (pn)->xpadn_flags
+#define PadnameIsOUR(pn)       (!!(pn)->xpadn_ourstash)
+#define PadnameOURSTASH(pn)    (pn)->xpadn_ourstash
+#define PadnameTYPE(pn)                (pn)->xpadn_type_u.xpadn_typestash
+#define PadnamePROTOCV(pn)     (pn)->xpadn_type_u.xpadn_protocv
+#define PadnameREFCNT(pn)      (pn)->xpadn_refcnt
+#define PadnameREFCNT_dec(pn)  Perl_padname_free(aTHX_ pn)
+#define PadnameOURSTASH_set(pn,s) (PadnameOURSTASH(pn) = (s))
+#define PadnameTYPE_set(pn,s)    (PadnameTYPE(pn) = (s))
+#define PadnameOUTER(pn)       (PadnameFLAGS(pn) & PADNAMEt_OUTER)
+#define PadnameIsSTATE(pn)     (PadnameFLAGS(pn) & PADNAMEt_STATE)
+#define PadnameLVALUE(pn)      (PadnameFLAGS(pn) & PADNAMEt_LVALUE)
+
+#define PadnameLVALUE_on(pn)   (PadnameFLAGS(pn) |= PADNAMEt_LVALUE)
+#define PadnameIsSTATE_on(pn)  (PadnameFLAGS(pn) |= PADNAMEt_STATE)
+
+#define PADNAMEt_OUTER 1       /* outer lexical var */
+#define PADNAMEt_STATE 2       /* state var */
+#define PADNAMEt_LVALUE        4       /* used as lvalue */
+#define PADNAMEt_TYPED 8       /* for B; unused by core */
+#define PADNAMEt_OUR   16      /* for B; unused by core */
+
+/* backward compatibility */
+#define SvPAD_STATE            PadnameIsSTATE
+#define SvPAD_TYPED(pn)                (!!PadnameTYPE(pn))
+#define SvPAD_OUR(pn)          (!!PadnameOURSTASH(pn))
+#define SvPAD_STATE_on         PadnameIsSTATE_on
+#define SvPAD_TYPED_on(pn)     (PadnameFLAGS(pn) |= PADNAMEt_TYPED)
+#define SvPAD_OUR_on(pn)       (PadnameFLAGS(pn) |= PADNAMEt_OUR)
+#define SvOURSTASH             PadnameOURSTASH
+#define SvOURSTASH_set         PadnameOURSTASH_set
+#define SVpad_STATE            PADNAMEt_STATE
+#define SVpad_TYPED            PADNAMEt_TYPED
+#define SVpad_OUR              PADNAMEt_OUR
 
 #ifdef DEBUGGING
 #  define PAD_SV(po)      pad_sv(po)
@@ -381,7 +406,7 @@ Restore the old pad saved into the local variable opad by PAD_SAVE_LOCAL()
 Save the current pad in the given context block structure.
 
 =for apidoc m|SV *|CX_CURPAD_SV|struct context|PADOFFSET po
-Access the SV at offset po in the saved current pad in the given
+Access the SV at offset C<po> in the saved current pad in the given
 context block structure (can be used as an lvalue).
 
 =cut
@@ -410,19 +435,18 @@ Assumes the slot entry is a valid C<our> lexical.
 
 =for apidoc m|STRLEN|PAD_COMPNAME_GEN|PADOFFSET po
 The generation number of the name at offset C<po> in the current
-compiling pad (lvalue).  Note that C<SvUVX> is hijacked for this purpose.
+compiling pad (lvalue).
 
 =for apidoc m|STRLEN|PAD_COMPNAME_GEN_set|PADOFFSET po|int gen
 Sets the generation number of the name at offset C<po> in the current
-ling pad (lvalue) to C<gen>.  Note that C<SvUV_set> is hijacked for this purpose.
-
+ling pad (lvalue) to C<gen>.
 =cut
 
 */
 
 #define PAD_COMPNAME(po)       PAD_COMPNAME_SV(po)
 #define PAD_COMPNAME_SV(po)    (PadnamelistARRAY(PL_comppad_name)[(po)])
-#define PAD_COMPNAME_FLAGS(po) SvFLAGS(PAD_COMPNAME_SV(po))
+#define PAD_COMPNAME_FLAGS(po) PadnameFLAGS(PAD_COMPNAME(po))
 #define PAD_COMPNAME_FLAGS_isOUR(po) SvPAD_OUR(PAD_COMPNAME_SV(po))
 #define PAD_COMPNAME_PV(po)    PadnamePV(PAD_COMPNAME(po))
 
@@ -432,10 +456,10 @@ ling pad (lvalue) to C<gen>.  Note that C<SvUV_set> is hijacked for this purpose
     (SvOURSTASH(PAD_COMPNAME_SV(po)))
 
 #define PAD_COMPNAME_GEN(po) \
-    ((STRLEN)SvUVX(PadnamelistARRAY(PL_comppad_name)[po]))
+    ((STRLEN)PadnamelistARRAY(PL_comppad_name)[po]->xpadn_gen)
 
 #define PAD_COMPNAME_GEN_set(po, gen) \
-    SvUV_set(PadnamelistARRAY(PL_comppad_name)[po], (UV)(gen))
+    (PadnamelistARRAY(PL_comppad_name)[po]->xpadn_gen = (gen))
 
 
 /*
@@ -468,10 +492,10 @@ Clone the state variables associated with running and compiling pads.
     PL_cop_seqmax              = proto_perl->Icop_seqmax;
 
 /*
-=for apidoc Am|PADOFFSET|pad_add_name_pvs|const char *name|U32 flags|HV *typestash|HV *ourstash
+=for apidoc Am|PADOFFSET|pad_add_name_pvs|"literal string" name|U32 flags|HV *typestash|HV *ourstash
 
-Exactly like L</pad_add_name_pvn>, but takes a literal string instead
-of a string/length pair.
+Exactly like L</pad_add_name_pvn>, but takes a literal string
+instead of a string/length pair.
 
 =cut
 */
@@ -480,10 +504,10 @@ of a string/length pair.
     Perl_pad_add_name_pvn(aTHX_ STR_WITH_LEN(name), flags, typestash, ourstash)
 
 /*
-=for apidoc Am|PADOFFSET|pad_findmy_pvs|const char *name|U32 flags
+=for apidoc Am|PADOFFSET|pad_findmy_pvs|"literal string" name|U32 flags
 
-Exactly like L</pad_findmy_pvn>, but takes a literal string instead
-of a string/length pair.
+Exactly like L</pad_findmy_pvn>, but takes a literal string
+instead of a string/length pair.
 
 =cut
 */
@@ -492,11 +516,5 @@ of a string/length pair.
     Perl_pad_findmy_pvn(aTHX_ STR_WITH_LEN(name), flags)
 
 /*
- * Local variables:
- * c-indentation-style: bsd
- * c-basic-offset: 4
- * indent-tabs-mode: nil
- * End:
- *
  * ex: set ts=8 sts=4 sw=4 et:
  */