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