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