hv.h

   1 /*    hv.h
   2  *
   3  *    Copyright (C) 1991, 1992, 1993, 1996, 1997, 1998, 1999,
   4  *    2000, 2001, 2002, 2003, 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 /* entry in hash value chain */
  12 struct he {
  13     /* Keep hent_next first in this structure, because sv_free_arenas take
  14        advantage of this to share code between the he arenas and the SV
  15        body arenas  */
  16     HE          *hent_next;     /* next entry in chain */
  17     HEK         *hent_hek;      /* hash key */
  18     union {
  19         SV      *hent_val;      /* scalar value that was hashed */
  20         Size_t  hent_refcount;  /* references for this shared hash key */
  21     } he_valu;
  22 };
  23
  24 /* hash key -- defined separately for use as shared pointer */
  25 struct hek {
  26     U32         hek_hash;       /* hash of key */
  27     I32         hek_len;        /* length of hash key */
  28     char        hek_key[1];     /* variable-length hash key */
  29     /* the hash-key is \0-terminated */
  30     /* after the \0 there is a byte for flags, such as whether the key
  31        is UTF-8 */
  32 };
  33
  34 struct shared_he {
  35     struct he shared_he_he;
  36     struct hek shared_he_hek;
  37 };
  38
  39 /* Subject to change.
  40    Don't access this directly.
  41    Use the funcs in mro.c
  42 */
  43
  44 struct mro_alg {
  45     AV *(*resolve)(pTHX_ HV* stash, U32 level);
  46     const char *name;
  47     U16 length;
  48     U16 kflags; /* For the hash API - set HVhek_UTF8 if name is UTF-8 */
  49     U32 hash; /* or 0 */
  50 };
  51
  52 struct mro_meta {
  53     /* a hash holding the different MROs private data.  */
  54     HV      *mro_linear_all;
  55     /* a pointer directly to the current MROs private data.  If mro_linear_all
  56        is NULL, this owns the SV reference, else it is just a pointer to a
  57        value stored in and owned by mro_linear_all.  */
  58     SV      *mro_linear_current;
  59     HV      *mro_nextmethod; /* next::method caching */
  60     U32     cache_gen;       /* Bumping this invalidates our method cache */
  61     U32     pkg_gen;         /* Bumps when local methods/@ISA change */
  62     const struct mro_alg *mro_which; /* which mro alg is in use? */
  63     HV      *isa;            /* Everything this class @ISA */
  64 };
  65
  66 #define MRO_GET_PRIVATE_DATA(smeta, which)                 \
  67     (((smeta)->mro_which && (which) == (smeta)->mro_which) \
  68      ? (smeta)->mro_linear_current                         \
  69      : Perl_mro_get_private_data(aTHX_ (smeta), (which)))
  70
  71 /* Subject to change.
  72    Don't access this directly.
  73 */
  74
  75 struct xpvhv_aux {
  76     HEK         *xhv_name;      /* name, if a symbol table */
  77     AV          *xhv_backreferences; /* back references for weak references */
  78     HE          *xhv_eiter;     /* current entry of iterator */
  79     I32         xhv_riter;      /* current root of iterator */
  80 /* Concerning xhv_name_count: When non-zero, xhv_name is actually a pointer
  81  * to an array of HEK pointers, this being the length. The first element is
  82  * the name of the stash, which may be NULL. If xhv_name_count is positive,
  83  * then *xhv_name is one of the effective names. If xhv_name_count is nega-
  84  * tive, then xhv_name[1] is the first effective name.
  85  */
  86     I32         xhv_name_count;
  87     struct mro_meta *xhv_mro_meta;
  88 };
  89
  90 /* hash structure: */
  91 /* This structure must match the beginning of struct xpvmg in sv.h. */
  92 struct xpvhv {
  93     HV*         xmg_stash;      /* class package */
  94     union _xmgu xmg_u;
  95     STRLEN      xhv_keys;       /* total keys, including placeholders */
  96     STRLEN      xhv_max;        /* subscript of last element of xhv_array */
  97 };
  98
  99 /* hash a key */
 100 /* FYI: This is the "One-at-a-Time" algorithm by Bob Jenkins
 101  * from requirements by Colin Plumb.
 102  * (http://burtleburtle.net/bob/hash/doobs.html) */
 103 /* The use of a temporary pointer and the casting games
 104  * is needed to serve the dual purposes of
 105  * (a) the hashed data being interpreted as "unsigned char" (new since 5.8,
 106  *     a "char" can be either signed or unsigned, depending on the compiler)
 107  * (b) catering for old code that uses a "char"
 108  *
 109  * The "hash seed" feature was added in Perl 5.8.1 to perturb the results
 110  * to avoid "algorithmic complexity attacks".
 111  *
 112  * If USE_HASH_SEED is defined, hash randomisation is done by default
 113  * If USE_HASH_SEED_EXPLICIT is defined, hash randomisation is done
 114  * only if the environment variable PERL_HASH_SEED is set.
 115  * For maximal control, one can define PERL_HASH_SEED.
 116  * (see also perl.c:perl_parse()).
 117  */
 118 #ifndef PERL_HASH_SEED
 119 #   if defined(USE_HASH_SEED) || defined(USE_HASH_SEED_EXPLICIT)
 120 #       define PERL_HASH_SEED   PL_hash_seed
 121 #   else
 122 #       define PERL_HASH_SEED   0
 123 #   endif
 124 #endif
 125 #define PERL_HASH(hash,str,len) \
 126      STMT_START { \
 127         register const char * const s_PeRlHaSh_tmp = str; \
 128         register const unsigned char *s_PeRlHaSh = (const unsigned char *)s_PeRlHaSh_tmp; \
 129         register I32 i_PeRlHaSh = len; \
 130         register U32 hash_PeRlHaSh = PERL_HASH_SEED; \
 131         while (i_PeRlHaSh--) { \
 132             hash_PeRlHaSh += *s_PeRlHaSh++; \
 133             hash_PeRlHaSh += (hash_PeRlHaSh << 10); \
 134             hash_PeRlHaSh ^= (hash_PeRlHaSh >> 6); \
 135         } \
 136         hash_PeRlHaSh += (hash_PeRlHaSh << 3); \
 137         hash_PeRlHaSh ^= (hash_PeRlHaSh >> 11); \
 138         (hash) = (hash_PeRlHaSh + (hash_PeRlHaSh << 15)); \
 139     } STMT_END
 140
 141 /* Only hv.c and mod_perl should be doing this.  */
 142 #ifdef PERL_HASH_INTERNAL_ACCESS
 143 #define PERL_HASH_INTERNAL(hash,str,len) \
 144      STMT_START { \
 145         register const char * const s_PeRlHaSh_tmp = str; \
 146         register const unsigned char *s_PeRlHaSh = (const unsigned char *)s_PeRlHaSh_tmp; \
 147         register I32 i_PeRlHaSh = len; \
 148         register U32 hash_PeRlHaSh = PL_rehash_seed; \
 149         while (i_PeRlHaSh--) { \
 150             hash_PeRlHaSh += *s_PeRlHaSh++; \
 151             hash_PeRlHaSh += (hash_PeRlHaSh << 10); \
 152             hash_PeRlHaSh ^= (hash_PeRlHaSh >> 6); \
 153         } \
 154         hash_PeRlHaSh += (hash_PeRlHaSh << 3); \
 155         hash_PeRlHaSh ^= (hash_PeRlHaSh >> 11); \
 156         (hash) = (hash_PeRlHaSh + (hash_PeRlHaSh << 15)); \
 157     } STMT_END
 158 #endif
 159
 160 /*
 161 =head1 Hash Manipulation Functions
 162
 163 =for apidoc AmU||HEf_SVKEY
 164 This flag, used in the length slot of hash entries and magic structures,
 165 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
 166 is to be expected. (For information only--not to be used).
 167
 168 =head1 Handy Values
 169
 170 =for apidoc AmU||Nullhv
 171 Null HV pointer.
 172
 173 (deprecated - use C<(HV *)NULL> instead)
 174
 175 =head1 Hash Manipulation Functions
 176
 177 =for apidoc Am|char*|HvNAME|HV* stash
 178 Returns the package name of a stash, or NULL if C<stash> isn't a stash.
 179 See C<SvSTASH>, C<CvSTASH>.
 180
 181 =for apidoc Am|char*|HvENAME|HV* stash
 182 Returns the effective name of a stash, or NULL if there is none. The
 183 effective name represents a location in the symbol table where this stash
 184 resides. It is updated automatically when packages are aliased or deleted.
 185 A stash that is no longer in the symbol table has no effective name. This
 186 name is preferable to C<HvNAME> for use in MRO linearisations and isa
 187 caches.
 188
 189 =for apidoc Am|void*|HeKEY|HE* he
 190 Returns the actual pointer stored in the key slot of the hash entry. The
 191 pointer may be either C<char*> or C<SV*>, depending on the value of
 192 C<HeKLEN()>.  Can be assigned to.  The C<HePV()> or C<HeSVKEY()> macros are
 193 usually preferable for finding the value of a key.
 194
 195 =for apidoc Am|STRLEN|HeKLEN|HE* he
 196 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
 197 holds an C<SV*> key.  Otherwise, holds the actual length of the key.  Can
 198 be assigned to. The C<HePV()> macro is usually preferable for finding key
 199 lengths.
 200
 201 =for apidoc Am|SV*|HeVAL|HE* he
 202 Returns the value slot (type C<SV*>) stored in the hash entry.
 203
 204 =for apidoc Am|U32|HeHASH|HE* he
 205 Returns the computed hash stored in the hash entry.
 206
 207 =for apidoc Am|char*|HePV|HE* he|STRLEN len
 208 Returns the key slot of the hash entry as a C<char*> value, doing any
 209 necessary dereferencing of possibly C<SV*> keys.  The length of the string
 210 is placed in C<len> (this is a macro, so do I<not> use C<&len>).  If you do
 211 not care about what the length of the key is, you may use the global
 212 variable C<PL_na>, though this is rather less efficient than using a local
 213 variable.  Remember though, that hash keys in perl are free to contain
 214 embedded nulls, so using C<strlen()> or similar is not a good way to find
 215 the length of hash keys. This is very similar to the C<SvPV()> macro
 216 described elsewhere in this document. See also C<HeUTF8>.
 217
 218 If you are using C<HePV> to get values to pass to C<newSVpvn()> to create a
 219 new SV, you should consider using C<newSVhek(HeKEY_hek(he))> as it is more
 220 efficient.
 221
 222 =for apidoc Am|char*|HeUTF8|HE* he
 223 Returns whether the C<char *> value returned by C<HePV> is encoded in UTF-8,
 224 doing any necessary dereferencing of possibly C<SV*> keys.  The value returned
 225 will be 0 or non-0, not necessarily 1 (or even a value with any low bits set),
 226 so B<do not> blindly assign this to a C<bool> variable, as C<bool> may be a
 227 typedef for C<char>.
 228
 229 =for apidoc Am|SV*|HeSVKEY|HE* he
 230 Returns the key as an C<SV*>, or C<NULL> if the hash entry does not
 231 contain an C<SV*> key.
 232
 233 =for apidoc Am|SV*|HeSVKEY_force|HE* he
 234 Returns the key as an C<SV*>.  Will create and return a temporary mortal
 235 C<SV*> if the hash entry contains only a C<char*> key.
 236
 237 =for apidoc Am|SV*|HeSVKEY_set|HE* he|SV* sv
 238 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
 239 indicate the presence of an C<SV*> key, and returns the same
 240 C<SV*>.
 241
 242 =cut
 243 */
 244
 245 /* these hash entry flags ride on hent_klen (for use only in magic/tied HVs) */
 246 #define HEf_SVKEY       -2      /* hent_key is an SV* */
 247
 248 #ifndef PERL_CORE
 249 #  define Nullhv Null(HV*)
 250 #endif
 251 #define HvARRAY(hv)     ((hv)->sv_u.svu_hash)
 252 #define HvFILL(hv)      Perl_hv_fill(aTHX_ (const HV *)(hv))
 253 #define HvMAX(hv)       ((XPVHV*)  SvANY(hv))->xhv_max
 254 /* This quite intentionally does no flag checking first. That's your
 255    responsibility.  */
 256 #define HvAUX(hv)       ((struct xpvhv_aux*)&(HvARRAY(hv)[HvMAX(hv)+1]))
 257 #define HvRITER(hv)     (*Perl_hv_riter_p(aTHX_ MUTABLE_HV(hv)))
 258 #define HvEITER(hv)     (*Perl_hv_eiter_p(aTHX_ MUTABLE_HV(hv)))
 259 #define HvRITER_set(hv,r)       Perl_hv_riter_set(aTHX_ MUTABLE_HV(hv), r)
 260 #define HvEITER_set(hv,e)       Perl_hv_eiter_set(aTHX_ MUTABLE_HV(hv), e)
 261 #define HvRITER_get(hv) (SvOOK(hv) ? HvAUX(hv)->xhv_riter : -1)
 262 #define HvEITER_get(hv) (SvOOK(hv) ? HvAUX(hv)->xhv_eiter : NULL)
 263 #define HvNAME(hv)      HvNAME_get(hv)
 264 #define HvENAME(hv)     HvENAME_get(hv)
 265
 266 /* Checking that hv is a valid package stash is the
 267    caller's responsibility */
 268 #define HvMROMETA(hv) (HvAUX(hv)->xhv_mro_meta \
 269                        ? HvAUX(hv)->xhv_mro_meta \
 270                        : Perl_mro_meta_init(aTHX_ hv))
 271
 272 /* FIXME - all of these should use a UTF8 aware API, which should also involve
 273    getting the length. */
 274 #define HvNAME_HEK_NN(hv)      \
 275  (                              \
 276   HvAUX(hv)->xhv_name_count      \
 277    ? *(HEK **)HvAUX(hv)->xhv_name \
 278    : HvAUX(hv)->xhv_name           \
 279  )
 280 /* This macro may go away without notice.  */
 281 #define HvNAME_HEK(hv) \
 282         (SvOOK(hv) && HvAUX(hv)->xhv_name ? HvNAME_HEK_NN(hv) : NULL)
 283 #define HvNAME_get(hv) \
 284         ((SvOOK(hv) && (HvAUX(hv)->xhv_name) && HvNAME_HEK_NN(hv)) \
 285                          ? HEK_KEY(HvNAME_HEK_NN(hv)) : NULL)
 286 #define HvNAMELEN_get(hv) \
 287         ((SvOOK(hv) && (HvAUX(hv)->xhv_name) && HvNAME_HEK_NN(hv)) \
 288                                  ? HEK_LEN(HvNAME_HEK_NN(hv)) : 0)
 289 #define HvENAME_HEK_NN(hv)                                             \
 290  (                                                                      \
 291   HvAUX(hv)->xhv_name_count > 0   ? *(HEK **)HvAUX(hv)->xhv_name      : \
 292   HvAUX(hv)->xhv_name_count < -1  ? ((HEK **)HvAUX(hv)->xhv_name)[1] : \
 293   HvAUX(hv)->xhv_name_count == -1 ? NULL                              : \
 294                                     HvAUX(hv)->xhv_name                 \
 295  )
 296 #define HvENAME_HEK(hv) \
 297         (SvOOK(hv) && HvAUX(hv)->xhv_name ? HvENAME_HEK_NN(hv) : NULL)
 298 #define HvENAME_get(hv) \
 299         ((SvOOK(hv) && (HvAUX(hv)->xhv_name) && HvENAME_HEK_NN(hv)) \
 300                          ? HEK_KEY(HvENAME_HEK_NN(hv)) : NULL)
 301 #define HvENAMELEN_get(hv) \
 302         ((SvOOK(hv) && (HvAUX(hv)->xhv_name) && HvENAME_HEK_NN(hv)) \
 303                                  ? HEK_LEN(HvENAME_HEK_NN(hv)) : 0)
 304
 305 /* the number of keys (including any placeholers) */
 306 #define XHvTOTALKEYS(xhv)       ((xhv)->xhv_keys)
 307
 308 /*
 309  * HvKEYS gets the number of keys that actually exist(), and is provided
 310  * for backwards compatibility with old XS code. The core uses HvUSEDKEYS
 311  * (keys, excluding placeholdes) and HvTOTALKEYS (including placeholders)
 312  */
 313 #define HvKEYS(hv)              HvUSEDKEYS(hv)
 314 #define HvUSEDKEYS(hv)          (HvTOTALKEYS(hv) - HvPLACEHOLDERS_get(hv))
 315 #define HvTOTALKEYS(hv)         XHvTOTALKEYS((XPVHV*)  SvANY(hv))
 316 #define HvPLACEHOLDERS(hv)      (*Perl_hv_placeholders_p(aTHX_ MUTABLE_HV(hv)))
 317 #define HvPLACEHOLDERS_get(hv)  (SvMAGIC(hv) ? Perl_hv_placeholders_get(aTHX_ (const HV *)hv) : 0)
 318 #define HvPLACEHOLDERS_set(hv,p)        Perl_hv_placeholders_set(aTHX_ MUTABLE_HV(hv), p)
 319
 320 #define HvSHAREKEYS(hv)         (SvFLAGS(hv) & SVphv_SHAREKEYS)
 321 #define HvSHAREKEYS_on(hv)      (SvFLAGS(hv) |= SVphv_SHAREKEYS)
 322 #define HvSHAREKEYS_off(hv)     (SvFLAGS(hv) &= ~SVphv_SHAREKEYS)
 323
 324 /* This is an optimisation flag. It won't be set if all hash keys have a 0
 325  * flag. Currently the only flags relate to utf8.
 326  * Hence it won't be set if all keys are 8 bit only. It will be set if any key
 327  * is utf8 (including 8 bit keys that were entered as utf8, and need upgrading
 328  * when retrieved during iteration. It may still be set when there are no longer
 329  * any utf8 keys.
 330  * See HVhek_ENABLEHVKFLAGS for the trigger.
 331  */
 332 #define HvHASKFLAGS(hv)         (SvFLAGS(hv) & SVphv_HASKFLAGS)
 333 #define HvHASKFLAGS_on(hv)      (SvFLAGS(hv) |= SVphv_HASKFLAGS)
 334 #define HvHASKFLAGS_off(hv)     (SvFLAGS(hv) &= ~SVphv_HASKFLAGS)
 335
 336 #define HvLAZYDEL(hv)           (SvFLAGS(hv) & SVphv_LAZYDEL)
 337 #define HvLAZYDEL_on(hv)        (SvFLAGS(hv) |= SVphv_LAZYDEL)
 338 #define HvLAZYDEL_off(hv)       (SvFLAGS(hv) &= ~SVphv_LAZYDEL)
 339
 340 #define HvREHASH(hv)            (SvFLAGS(hv) & SVphv_REHASH)
 341 #define HvREHASH_on(hv)         (SvFLAGS(hv) |= SVphv_REHASH)
 342 #define HvREHASH_off(hv)        (SvFLAGS(hv) &= ~SVphv_REHASH)
 343
 344 #ifndef PERL_CORE
 345 #  define Nullhe Null(HE*)
 346 #endif
 347 #define HeNEXT(he)              (he)->hent_next
 348 #define HeKEY_hek(he)           (he)->hent_hek
 349 #define HeKEY(he)               HEK_KEY(HeKEY_hek(he))
 350 #define HeKEY_sv(he)            (*(SV**)HeKEY(he))
 351 #define HeKLEN(he)              HEK_LEN(HeKEY_hek(he))
 352 #define HeKUTF8(he)  HEK_UTF8(HeKEY_hek(he))
 353 #define HeKWASUTF8(he)  HEK_WASUTF8(HeKEY_hek(he))
 354 #define HeKREHASH(he)  HEK_REHASH(HeKEY_hek(he))
 355 #define HeKLEN_UTF8(he)  (HeKUTF8(he) ? -HeKLEN(he) : HeKLEN(he))
 356 #define HeKFLAGS(he)  HEK_FLAGS(HeKEY_hek(he))
 357 #define HeVAL(he)               (he)->he_valu.hent_val
 358 #define HeHASH(he)              HEK_HASH(HeKEY_hek(he))
 359 #define HePV(he,lp)             ((HeKLEN(he) == HEf_SVKEY) ?            \
 360                                  SvPV(HeKEY_sv(he),lp) :                \
 361                                  ((lp = HeKLEN(he)), HeKEY(he)))
 362 #define HeUTF8(he)              ((HeKLEN(he) == HEf_SVKEY) ?            \
 363                                  SvUTF8(HeKEY_sv(he)) :                 \
 364                                  (U32)HeKUTF8(he))
 365
 366 #define HeSVKEY(he)             ((HeKEY(he) &&                          \
 367                                   HeKLEN(he) == HEf_SVKEY) ?            \
 368                                  HeKEY_sv(he) : NULL)
 369
 370 #define HeSVKEY_force(he)       (HeKEY(he) ?                            \
 371                                  ((HeKLEN(he) == HEf_SVKEY) ?           \
 372                                   HeKEY_sv(he) :                        \
 373                                   newSVpvn_flags(HeKEY(he),             \
 374                                                  HeKLEN(he), SVs_TEMP)) : \
 375                                  &PL_sv_undef)
 376 #define HeSVKEY_set(he,sv)      ((HeKLEN(he) = HEf_SVKEY), (HeKEY_sv(he) = sv))
 377
 378 #ifndef PERL_CORE
 379 #  define Nullhek Null(HEK*)
 380 #endif
 381 #define HEK_BASESIZE            STRUCT_OFFSET(HEK, hek_key[0])
 382 #define HEK_HASH(hek)           (hek)->hek_hash
 383 #define HEK_LEN(hek)            (hek)->hek_len
 384 #define HEK_KEY(hek)            (hek)->hek_key
 385 #define HEK_FLAGS(hek)  (*((unsigned char *)(HEK_KEY(hek))+HEK_LEN(hek)+1))
 386
 387 #define HVhek_UTF8      0x01 /* Key is utf8 encoded. */
 388 #define HVhek_WASUTF8   0x02 /* Key is bytes here, but was supplied as utf8. */
 389 #define HVhek_REHASH    0x04 /* This key is in an hv using a custom HASH . */
 390 #define HVhek_UNSHARED  0x08 /* This key isn't a shared hash key. */
 391 #define HVhek_FREEKEY   0x100 /* Internal flag to say key is malloc()ed.  */
 392 #define HVhek_PLACEHOLD 0x200 /* Internal flag to create placeholder.
 393                                * (may change, but Storable is a core module) */
 394 #define HVhek_KEYCANONICAL 0x400 /* Internal flag - key is in canonical form.
 395                                     If the string is UTF-8, it cannot be
 396                                     converted to bytes. */
 397 #define HVhek_MASK      0xFF
 398
 399 /* Which flags enable HvHASKFLAGS? Somewhat a hack on a hack, as
 400    HVhek_REHASH is only needed because the rehash flag has to be duplicated
 401    into all keys as hv_iternext has no access to the hash flags. At this
 402    point Storable's tests get upset, because sometimes hashes are "keyed"
 403    and sometimes not, depending on the order of data insertion, and whether
 404    it triggered rehashing. So currently HVhek_REHASH is exempt.
 405    Similarly UNSHARED
 406 */
 407
 408 #define HVhek_ENABLEHVKFLAGS    (HVhek_MASK & ~(HVhek_REHASH|HVhek_UNSHARED))
 409
 410 #define HEK_UTF8(hek)           (HEK_FLAGS(hek) & HVhek_UTF8)
 411 #define HEK_UTF8_on(hek)        (HEK_FLAGS(hek) |= HVhek_UTF8)
 412 #define HEK_UTF8_off(hek)       (HEK_FLAGS(hek) &= ~HVhek_UTF8)
 413 #define HEK_WASUTF8(hek)        (HEK_FLAGS(hek) & HVhek_WASUTF8)
 414 #define HEK_WASUTF8_on(hek)     (HEK_FLAGS(hek) |= HVhek_WASUTF8)
 415 #define HEK_WASUTF8_off(hek)    (HEK_FLAGS(hek) &= ~HVhek_WASUTF8)
 416 #define HEK_REHASH(hek)         (HEK_FLAGS(hek) & HVhek_REHASH)
 417 #define HEK_REHASH_on(hek)      (HEK_FLAGS(hek) |= HVhek_REHASH)
 418
 419 /* calculate HV array allocation */
 420 #ifndef PERL_USE_LARGE_HV_ALLOC
 421 /* Default to allocating the correct size - default to assuming that malloc()
 422    is not broken and is efficient at allocating blocks sized at powers-of-two.
 423 */
 424 #  define PERL_HV_ARRAY_ALLOC_BYTES(size) ((size) * sizeof(HE*))
 425 #else
 426 #  define MALLOC_OVERHEAD 16
 427 #  define PERL_HV_ARRAY_ALLOC_BYTES(size) \
 428                         (((size) < 64)                                  \
 429                          ? (size) * sizeof(HE*)                         \
 430                          : (size) * sizeof(HE*) * 2 - MALLOC_OVERHEAD)
 431 #endif
 432
 433 /* Flags for hv_iternext_flags.  */
 434 #define HV_ITERNEXT_WANTPLACEHOLDERS    0x01    /* Don't skip placeholders.  */
 435
 436 #define hv_iternext(hv) hv_iternext_flags(hv, 0)
 437 #define hv_magic(hv, gv, how) sv_magic(MUTABLE_SV(hv), MUTABLE_SV(gv), how, NULL, 0)
 438 #define hv_undef(hv) Perl_hv_undef_flags(aTHX_ hv, 0)
 439
 440 /* available as a function in hv.c */
 441 #define Perl_sharepvn(sv, len, hash) HEK_KEY(share_hek(sv, len, hash))
 442 #define sharepvn(sv, len, hash)      Perl_sharepvn(sv, len, hash)
 443
 444 #define share_hek_hek(hek)                                              \
 445     (++(((struct shared_he *)(((char *)hek)                             \
 446                               - STRUCT_OFFSET(struct shared_he,         \
 447                                               shared_he_hek)))          \
 448         ->shared_he_he.he_valu.hent_refcount),                          \
 449      hek)
 450
 451 #define hv_store_ent(hv, keysv, val, hash)                              \
 452     ((HE *) hv_common((hv), (keysv), NULL, 0, 0, HV_FETCH_ISSTORE,      \
 453                       (val), (hash)))
 454
 455 #define hv_exists_ent(hv, keysv, hash)                                  \
 456     (hv_common((hv), (keysv), NULL, 0, 0, HV_FETCH_ISEXISTS, 0, (hash)) \
 457      ? TRUE : FALSE)
 458 #define hv_fetch_ent(hv, keysv, lval, hash)                             \
 459     ((HE *) hv_common((hv), (keysv), NULL, 0, 0,                        \
 460                       ((lval) ? HV_FETCH_LVALUE : 0), NULL, (hash)))
 461 #define hv_delete_ent(hv, key, flags, hash)                             \
 462     (MUTABLE_SV(hv_common((hv), (key), NULL, 0, 0, (flags) | HV_DELETE, \
 463                           NULL, (hash))))
 464
 465 #define hv_store_flags(hv, key, klen, val, hash, flags)                 \
 466     ((SV**) hv_common((hv), NULL, (key), (klen), (flags),               \
 467                       (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV), (val),       \
 468                       (hash)))
 469
 470 #define hv_store(hv, key, klen, val, hash)                              \
 471     ((SV**) hv_common_key_len((hv), (key), (klen),                      \
 472                               (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV),      \
 473                               (val), (hash)))
 474
 475 #define hv_exists(hv, key, klen)                                        \
 476     (hv_common_key_len((hv), (key), (klen), HV_FETCH_ISEXISTS, NULL, 0) \
 477      ? TRUE : FALSE)
 478
 479 #define hv_fetch(hv, key, klen, lval)                                   \
 480     ((SV**) hv_common_key_len((hv), (key), (klen), (lval)               \
 481                               ? (HV_FETCH_JUST_SV | HV_FETCH_LVALUE)    \
 482                               : HV_FETCH_JUST_SV, NULL, 0))
 483
 484 #define hv_delete(hv, key, klen, flags)                                 \
 485     (MUTABLE_SV(hv_common_key_len((hv), (key), (klen),                  \
 486                                   (flags) | HV_DELETE, NULL, 0)))
 487
 488 /* This refcounted he structure is used for storing the hints used for lexical
 489    pragmas. Without threads, it's basically struct he + refcount.
 490    With threads, life gets more complex as the structure needs to be shared
 491    between threads (because it hangs from OPs, which are shared), hence the
 492    alternate definition and mutex.  */
 493
 494 struct refcounted_he;
 495
 496 /* flags for the refcounted_he API */
 497 #define REFCOUNTED_HE_KEY_UTF8          0x00000001
 498
 499 #ifdef PERL_CORE
 500
 501 /* Gosh. This really isn't a good name any longer.  */
 502 struct refcounted_he {
 503     struct refcounted_he *refcounted_he_next;   /* next entry in chain */
 504 #ifdef USE_ITHREADS
 505     U32                   refcounted_he_hash;
 506     U32                   refcounted_he_keylen;
 507 #else
 508     HEK                  *refcounted_he_hek;    /* hint key */
 509 #endif
 510     union {
 511         IV                refcounted_he_u_iv;
 512         UV                refcounted_he_u_uv;
 513         STRLEN            refcounted_he_u_len;
 514         void             *refcounted_he_u_ptr;  /* Might be useful in future */
 515     } refcounted_he_val;
 516     U32                   refcounted_he_refcnt; /* reference count */
 517     /* First byte is flags. Then NUL-terminated value. Then for ithreads,
 518        non-NUL terminated key.  */
 519     char                  refcounted_he_data[1];
 520 };
 521
 522 /*
 523 =for apidoc m|SV *|refcounted_he_fetch_pvs|const struct refcounted_he *chain|const char *key|U32 flags
 524
 525 Like L</refcounted_he_fetch_pvn>, but takes a literal string instead of
 526 a string/length pair, and no precomputed hash.
 527
 528 =cut
 529 */
 530
 531 #define refcounted_he_fetch_pvs(chain, key, flags) \
 532     Perl_refcounted_he_fetch_pvn(aTHX_ chain, STR_WITH_LEN(key), 0, flags)
 533
 534 /*
 535 =for apidoc m|struct refcounted_he *|refcounted_he_new_pvs|struct refcounted_he *parent|const char *key|SV *value|U32 flags
 536
 537 Like L</refcounted_he_new_pvn>, but takes a literal string instead of
 538 a string/length pair, and no precomputed hash.
 539
 540 =cut
 541 */
 542
 543 #define refcounted_he_new_pvs(parent, key, value, flags) \
 544     Perl_refcounted_he_new_pvn(aTHX_ parent, STR_WITH_LEN(key), 0, value, flags)
 545
 546 /* Flag bits are HVhek_UTF8, HVhek_WASUTF8, then */
 547 #define HVrhek_undef    0x00 /* Value is undef. */
 548 #define HVrhek_delete   0x10 /* Value is placeholder - signifies delete. */
 549 #define HVrhek_IV       0x20 /* Value is IV. */
 550 #define HVrhek_UV       0x30 /* Value is UV. */
 551 #define HVrhek_PV       0x40 /* Value is a (byte) string. */
 552 #define HVrhek_PV_UTF8  0x50 /* Value is a (utf8) string. */
 553 /* Two spare. As these have to live in the optree, you can't store anything
 554    interpreter specific, such as SVs. :-( */
 555 #define HVrhek_typemask 0x70
 556
 557 #ifdef USE_ITHREADS
 558 /* A big expression to find the key offset */
 559 #define REF_HE_KEY(chain)                                               \
 560         ((((chain->refcounted_he_data[0] & 0x60) == 0x40)               \
 561             ? chain->refcounted_he_val.refcounted_he_u_len + 1 : 0)     \
 562          + 1 + chain->refcounted_he_data)
 563 #endif
 564
 565 #  ifdef USE_ITHREADS
 566 #    define HINTS_REFCNT_LOCK           MUTEX_LOCK(&PL_hints_mutex)
 567 #    define HINTS_REFCNT_UNLOCK         MUTEX_UNLOCK(&PL_hints_mutex)
 568 #  else
 569 #    define HINTS_REFCNT_LOCK           NOOP
 570 #    define HINTS_REFCNT_UNLOCK         NOOP
 571 #  endif
 572 #endif
 573
 574 #ifdef USE_ITHREADS
 575 #  define HINTS_REFCNT_INIT             MUTEX_INIT(&PL_hints_mutex)
 576 #  define HINTS_REFCNT_TERM             MUTEX_DESTROY(&PL_hints_mutex)
 577 #else
 578 #  define HINTS_REFCNT_INIT             NOOP
 579 #  define HINTS_REFCNT_TERM             NOOP
 580 #endif
 581
 582 /* Hash actions
 583  * Passed in PERL_MAGIC_uvar calls
 584  */
 585 #define HV_DISABLE_UVAR_XKEY    0x01
 586 /* We need to ensure that these don't clash with G_DISCARD, which is 2, as it
 587    is documented as being passed to hv_delete().  */
 588 #define HV_FETCH_ISSTORE        0x04
 589 #define HV_FETCH_ISEXISTS       0x08
 590 #define HV_FETCH_LVALUE         0x10
 591 #define HV_FETCH_JUST_SV        0x20
 592 #define HV_DELETE               0x40
 593 #define HV_FETCH_EMPTY_HE       0x80 /* Leave HeVAL null. */
 594
 595 /* Must not conflict with HVhek_UTF8 */
 596 #define HV_NAME_SETALL          0x02
 597
 598 /*
 599 =for apidoc newHV
 600
 601 Creates a new HV.  The reference count is set to 1.
 602
 603 =cut
 604 */
 605
 606 #define newHV() MUTABLE_HV(newSV_type(SVt_PVHV))
 607
 608 /*
 609  * Local variables:
 610  * c-indentation-style: bsd
 611  * c-basic-offset: 4
 612  * indent-tabs-mode: t
 613  * End:
 614  *
 615  * ex: set ts=8 sts=4 sw=4 noet:
 616  */