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 #define mro_isa_changed_in(stash) mro_isa_changed_in3(stash, NULL, 0)
  71
  72 /* Subject to change.
  73    Don't access this directly.
  74 */
  75
  76 struct xpvhv_aux {
  77     HEK         *xhv_name;      /* name, if a symbol table */
  78     AV          *xhv_backreferences; /* back references for weak references */
  79     HE          *xhv_eiter;     /* current entry of iterator */
  80     I32         xhv_riter;      /* current root of iterator */
  81     struct mro_meta *xhv_mro_meta;
  82     U32         xhv_name_count; /* When non-zero, xhv_name is actually */
  83                                 /* a pointer to an array of HEKs, this */
  84 };                              /* being the length. */
  85
  86 /* hash structure: */
  87 /* This structure must match the beginning of struct xpvmg in sv.h. */
  88 struct xpvhv {
  89     HV*         xmg_stash;      /* class package */
  90     union _xmgu xmg_u;
  91     STRLEN      xhv_keys;       /* total keys, including placeholders */
  92     STRLEN      xhv_max;        /* subscript of last element of xhv_array */
  93 };
  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)      Perl_hv_fill(aTHX_ (const HV *)(hv))
 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 #define HvNAME_HEK_NN(hv)      \
 262  (                              \
 263   HvAUX(hv)->xhv_name_count      \
 264    ? *(HEK **)HvAUX(hv)->xhv_name \
 265    : HvAUX(hv)->xhv_name           \
 266  )
 267 /* This macro may go away without notice.  */
 268 #define HvNAME_HEK(hv) \
 269         (SvOOK(hv) && HvAUX(hv)->xhv_name ? HvNAME_HEK_NN(hv) : NULL)
 270 #define HvNAME_get(hv)  ((SvOOK(hv) && (HvAUX(hv)->xhv_name)) \
 271                          ? HEK_KEY(HvNAME_HEK_NN(hv)) : NULL)
 272 #define HvNAMELEN_get(hv)       ((SvOOK(hv) && (HvAUX(hv)->xhv_name)) \
 273                                  ? HEK_LEN(HvNAME_HEK_NN(hv)) : 0)
 274
 275 /* the number of keys (including any placeholers) */
 276 #define XHvTOTALKEYS(xhv)       ((xhv)->xhv_keys)
 277
 278 /*
 279  * HvKEYS gets the number of keys that actually exist(), and is provided
 280  * for backwards compatibility with old XS code. The core uses HvUSEDKEYS
 281  * (keys, excluding placeholdes) and HvTOTALKEYS (including placeholders)
 282  */
 283 #define HvKEYS(hv)              HvUSEDKEYS(hv)
 284 #define HvUSEDKEYS(hv)          (HvTOTALKEYS(hv) - HvPLACEHOLDERS_get(hv))
 285 #define HvTOTALKEYS(hv)         XHvTOTALKEYS((XPVHV*)  SvANY(hv))
 286 #define HvPLACEHOLDERS(hv)      (*Perl_hv_placeholders_p(aTHX_ MUTABLE_HV(hv)))
 287 #define HvPLACEHOLDERS_get(hv)  (SvMAGIC(hv) ? Perl_hv_placeholders_get(aTHX_ (const HV *)hv) : 0)
 288 #define HvPLACEHOLDERS_set(hv,p)        Perl_hv_placeholders_set(aTHX_ MUTABLE_HV(hv), p)
 289
 290 #define HvSHAREKEYS(hv)         (SvFLAGS(hv) & SVphv_SHAREKEYS)
 291 #define HvSHAREKEYS_on(hv)      (SvFLAGS(hv) |= SVphv_SHAREKEYS)
 292 #define HvSHAREKEYS_off(hv)     (SvFLAGS(hv) &= ~SVphv_SHAREKEYS)
 293
 294 /* This is an optimisation flag. It won't be set if all hash keys have a 0
 295  * flag. Currently the only flags relate to utf8.
 296  * Hence it won't be set if all keys are 8 bit only. It will be set if any key
 297  * is utf8 (including 8 bit keys that were entered as utf8, and need upgrading
 298  * when retrieved during iteration. It may still be set when there are no longer
 299  * any utf8 keys.
 300  * See HVhek_ENABLEHVKFLAGS for the trigger.
 301  */
 302 #define HvHASKFLAGS(hv)         (SvFLAGS(hv) & SVphv_HASKFLAGS)
 303 #define HvHASKFLAGS_on(hv)      (SvFLAGS(hv) |= SVphv_HASKFLAGS)
 304 #define HvHASKFLAGS_off(hv)     (SvFLAGS(hv) &= ~SVphv_HASKFLAGS)
 305
 306 #define HvLAZYDEL(hv)           (SvFLAGS(hv) & SVphv_LAZYDEL)
 307 #define HvLAZYDEL_on(hv)        (SvFLAGS(hv) |= SVphv_LAZYDEL)
 308 #define HvLAZYDEL_off(hv)       (SvFLAGS(hv) &= ~SVphv_LAZYDEL)
 309
 310 #define HvREHASH(hv)            (SvFLAGS(hv) & SVphv_REHASH)
 311 #define HvREHASH_on(hv)         (SvFLAGS(hv) |= SVphv_REHASH)
 312 #define HvREHASH_off(hv)        (SvFLAGS(hv) &= ~SVphv_REHASH)
 313
 314 #ifndef PERL_CORE
 315 #  define Nullhe Null(HE*)
 316 #endif
 317 #define HeNEXT(he)              (he)->hent_next
 318 #define HeKEY_hek(he)           (he)->hent_hek
 319 #define HeKEY(he)               HEK_KEY(HeKEY_hek(he))
 320 #define HeKEY_sv(he)            (*(SV**)HeKEY(he))
 321 #define HeKLEN(he)              HEK_LEN(HeKEY_hek(he))
 322 #define HeKUTF8(he)  HEK_UTF8(HeKEY_hek(he))
 323 #define HeKWASUTF8(he)  HEK_WASUTF8(HeKEY_hek(he))
 324 #define HeKREHASH(he)  HEK_REHASH(HeKEY_hek(he))
 325 #define HeKLEN_UTF8(he)  (HeKUTF8(he) ? -HeKLEN(he) : HeKLEN(he))
 326 #define HeKFLAGS(he)  HEK_FLAGS(HeKEY_hek(he))
 327 #define HeVAL(he)               (he)->he_valu.hent_val
 328 #define HeHASH(he)              HEK_HASH(HeKEY_hek(he))
 329 #define HePV(he,lp)             ((HeKLEN(he) == HEf_SVKEY) ?            \
 330                                  SvPV(HeKEY_sv(he),lp) :                \
 331                                  ((lp = HeKLEN(he)), HeKEY(he)))
 332 #define HeUTF8(he)              ((HeKLEN(he) == HEf_SVKEY) ?            \
 333                                  SvUTF8(HeKEY_sv(he)) :                 \
 334                                  (U32)HeKUTF8(he))
 335
 336 #define HeSVKEY(he)             ((HeKEY(he) &&                          \
 337                                   HeKLEN(he) == HEf_SVKEY) ?            \
 338                                  HeKEY_sv(he) : NULL)
 339
 340 #define HeSVKEY_force(he)       (HeKEY(he) ?                            \
 341                                  ((HeKLEN(he) == HEf_SVKEY) ?           \
 342                                   HeKEY_sv(he) :                        \
 343                                   newSVpvn_flags(HeKEY(he),             \
 344                                                  HeKLEN(he), SVs_TEMP)) : \
 345                                  &PL_sv_undef)
 346 #define HeSVKEY_set(he,sv)      ((HeKLEN(he) = HEf_SVKEY), (HeKEY_sv(he) = sv))
 347
 348 #ifndef PERL_CORE
 349 #  define Nullhek Null(HEK*)
 350 #endif
 351 #define HEK_BASESIZE            STRUCT_OFFSET(HEK, hek_key[0])
 352 #define HEK_HASH(hek)           (hek)->hek_hash
 353 #define HEK_LEN(hek)            (hek)->hek_len
 354 #define HEK_KEY(hek)            (hek)->hek_key
 355 #define HEK_FLAGS(hek)  (*((unsigned char *)(HEK_KEY(hek))+HEK_LEN(hek)+1))
 356
 357 #define HVhek_UTF8      0x01 /* Key is utf8 encoded. */
 358 #define HVhek_WASUTF8   0x02 /* Key is bytes here, but was supplied as utf8. */
 359 #define HVhek_REHASH    0x04 /* This key is in an hv using a custom HASH . */
 360 #define HVhek_UNSHARED  0x08 /* This key isn't a shared hash key. */
 361 #define HVhek_FREEKEY   0x100 /* Internal flag to say key is malloc()ed.  */
 362 #define HVhek_PLACEHOLD 0x200 /* Internal flag to create placeholder.
 363                                * (may change, but Storable is a core module) */
 364 #define HVhek_KEYCANONICAL 0x400 /* Internal flag - key is in canonical form.
 365                                     If the string is UTF-8, it cannot be
 366                                     converted to bytes. */
 367 #define HVhek_MASK      0xFF
 368
 369 /* Which flags enable HvHASKFLAGS? Somewhat a hack on a hack, as
 370    HVhek_REHASH is only needed because the rehash flag has to be duplicated
 371    into all keys as hv_iternext has no access to the hash flags. At this
 372    point Storable's tests get upset, because sometimes hashes are "keyed"
 373    and sometimes not, depending on the order of data insertion, and whether
 374    it triggered rehashing. So currently HVhek_REHASH is exempt.
 375    Similarly UNSHARED
 376 */
 377
 378 #define HVhek_ENABLEHVKFLAGS    (HVhek_MASK & ~(HVhek_REHASH|HVhek_UNSHARED))
 379
 380 #define HEK_UTF8(hek)           (HEK_FLAGS(hek) & HVhek_UTF8)
 381 #define HEK_UTF8_on(hek)        (HEK_FLAGS(hek) |= HVhek_UTF8)
 382 #define HEK_UTF8_off(hek)       (HEK_FLAGS(hek) &= ~HVhek_UTF8)
 383 #define HEK_WASUTF8(hek)        (HEK_FLAGS(hek) & HVhek_WASUTF8)
 384 #define HEK_WASUTF8_on(hek)     (HEK_FLAGS(hek) |= HVhek_WASUTF8)
 385 #define HEK_WASUTF8_off(hek)    (HEK_FLAGS(hek) &= ~HVhek_WASUTF8)
 386 #define HEK_REHASH(hek)         (HEK_FLAGS(hek) & HVhek_REHASH)
 387 #define HEK_REHASH_on(hek)      (HEK_FLAGS(hek) |= HVhek_REHASH)
 388
 389 /* calculate HV array allocation */
 390 #ifndef PERL_USE_LARGE_HV_ALLOC
 391 /* Default to allocating the correct size - default to assuming that malloc()
 392    is not broken and is efficient at allocating blocks sized at powers-of-two.
 393 */
 394 #  define PERL_HV_ARRAY_ALLOC_BYTES(size) ((size) * sizeof(HE*))
 395 #else
 396 #  define MALLOC_OVERHEAD 16
 397 #  define PERL_HV_ARRAY_ALLOC_BYTES(size) \
 398                         (((size) < 64)                                  \
 399                          ? (size) * sizeof(HE*)                         \
 400                          : (size) * sizeof(HE*) * 2 - MALLOC_OVERHEAD)
 401 #endif
 402
 403 /* Flags for hv_iternext_flags.  */
 404 #define HV_ITERNEXT_WANTPLACEHOLDERS    0x01    /* Don't skip placeholders.  */
 405
 406 #define hv_iternext(hv) hv_iternext_flags(hv, 0)
 407 #define hv_magic(hv, gv, how) sv_magic(MUTABLE_SV(hv), MUTABLE_SV(gv), how, NULL, 0)
 408
 409 /* available as a function in hv.c */
 410 #define Perl_sharepvn(sv, len, hash) HEK_KEY(share_hek(sv, len, hash))
 411 #define sharepvn(sv, len, hash)      Perl_sharepvn(sv, len, hash)
 412
 413 #define share_hek_hek(hek)                                              \
 414     (++(((struct shared_he *)(((char *)hek)                             \
 415                               - STRUCT_OFFSET(struct shared_he,         \
 416                                               shared_he_hek)))          \
 417         ->shared_he_he.he_valu.hent_refcount),                          \
 418      hek)
 419
 420 #define hv_store_ent(hv, keysv, val, hash)                              \
 421     ((HE *) hv_common((hv), (keysv), NULL, 0, 0, HV_FETCH_ISSTORE,      \
 422                       (val), (hash)))
 423
 424 #define hv_exists_ent(hv, keysv, hash)                                  \
 425     (hv_common((hv), (keysv), NULL, 0, 0, HV_FETCH_ISEXISTS, 0, (hash)) \
 426      ? TRUE : FALSE)
 427 #define hv_fetch_ent(hv, keysv, lval, hash)                             \
 428     ((HE *) hv_common((hv), (keysv), NULL, 0, 0,                        \
 429                       ((lval) ? HV_FETCH_LVALUE : 0), NULL, (hash)))
 430 #define hv_delete_ent(hv, key, flags, hash)                             \
 431     (MUTABLE_SV(hv_common((hv), (key), NULL, 0, 0, (flags) | HV_DELETE, \
 432                           NULL, (hash))))
 433
 434 #define hv_store_flags(hv, key, klen, val, hash, flags)                 \
 435     ((SV**) hv_common((hv), NULL, (key), (klen), (flags),               \
 436                       (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV), (val),       \
 437                       (hash)))
 438
 439 #define hv_store(hv, key, klen, val, hash)                              \
 440     ((SV**) hv_common_key_len((hv), (key), (klen),                      \
 441                               (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV),      \
 442                               (val), (hash)))
 443
 444 #define hv_exists(hv, key, klen)                                        \
 445     (hv_common_key_len((hv), (key), (klen), HV_FETCH_ISEXISTS, NULL, 0) \
 446      ? TRUE : FALSE)
 447
 448 #define hv_fetch(hv, key, klen, lval)                                   \
 449     ((SV**) hv_common_key_len((hv), (key), (klen), (lval)               \
 450                               ? (HV_FETCH_JUST_SV | HV_FETCH_LVALUE)    \
 451                               : HV_FETCH_JUST_SV, NULL, 0))
 452
 453 #define hv_delete(hv, key, klen, flags)                                 \
 454     (MUTABLE_SV(hv_common_key_len((hv), (key), (klen),                  \
 455                                   (flags) | HV_DELETE, NULL, 0)))
 456
 457 /* This refcounted he structure is used for storing the hints used for lexical
 458    pragmas. Without threads, it's basically struct he + refcount.
 459    With threads, life gets more complex as the structure needs to be shared
 460    between threads (because it hangs from OPs, which are shared), hence the
 461    alternate definition and mutex.  */
 462
 463 struct refcounted_he;
 464
 465 /* flags for the refcounted_he API */
 466 #define REFCOUNTED_HE_KEY_UTF8          0x00000001
 467
 468 #ifdef PERL_CORE
 469
 470 /* Gosh. This really isn't a good name any longer.  */
 471 struct refcounted_he {
 472     struct refcounted_he *refcounted_he_next;   /* next entry in chain */
 473 #ifdef USE_ITHREADS
 474     U32                   refcounted_he_hash;
 475     U32                   refcounted_he_keylen;
 476 #else
 477     HEK                  *refcounted_he_hek;    /* hint key */
 478 #endif
 479     union {
 480         IV                refcounted_he_u_iv;
 481         UV                refcounted_he_u_uv;
 482         STRLEN            refcounted_he_u_len;
 483         void             *refcounted_he_u_ptr;  /* Might be useful in future */
 484     } refcounted_he_val;
 485     U32                   refcounted_he_refcnt; /* reference count */
 486     /* First byte is flags. Then NUL-terminated value. Then for ithreads,
 487        non-NUL terminated key.  */
 488     char                  refcounted_he_data[1];
 489 };
 490
 491 /*
 492 =for apidoc m|SV *|refcounted_he_fetch_pvs|const struct refcounted_he *chain|const char *key|U32 flags
 493
 494 Like L</refcounted_he_fetch_pvn>, but takes a literal string instead of
 495 a string/length pair, and no precomputed hash.
 496
 497 =cut
 498 */
 499
 500 #define refcounted_he_fetch_pvs(chain, key, flags) \
 501     Perl_refcounted_he_fetch_pvn(aTHX_ chain, STR_WITH_LEN(key), 0, flags)
 502
 503 /*
 504 =for apidoc m|struct refcounted_he *|refcounted_he_new_pvs|struct refcounted_he *parent|const char *key|SV *value|U32 flags
 505
 506 Like L</refcounted_he_new_pvn>, but takes a literal string instead of
 507 a string/length pair, and no precomputed hash.
 508
 509 =cut
 510 */
 511
 512 #define refcounted_he_new_pvs(parent, key, value, flags) \
 513     Perl_refcounted_he_new_pvn(aTHX_ parent, STR_WITH_LEN(key), 0, value, flags)
 514
 515 /* Flag bits are HVhek_UTF8, HVhek_WASUTF8, then */
 516 #define HVrhek_undef    0x00 /* Value is undef. */
 517 #define HVrhek_delete   0x10 /* Value is placeholder - signifies delete. */
 518 #define HVrhek_IV       0x20 /* Value is IV. */
 519 #define HVrhek_UV       0x30 /* Value is UV. */
 520 #define HVrhek_PV       0x40 /* Value is a (byte) string. */
 521 #define HVrhek_PV_UTF8  0x50 /* Value is a (utf8) string. */
 522 /* Two spare. As these have to live in the optree, you can't store anything
 523    interpreter specific, such as SVs. :-( */
 524 #define HVrhek_typemask 0x70
 525
 526 #ifdef USE_ITHREADS
 527 /* A big expression to find the key offset */
 528 #define REF_HE_KEY(chain)                                               \
 529         ((((chain->refcounted_he_data[0] & 0x60) == 0x40)               \
 530             ? chain->refcounted_he_val.refcounted_he_u_len + 1 : 0)     \
 531          + 1 + chain->refcounted_he_data)
 532 #endif
 533
 534 #  ifdef USE_ITHREADS
 535 #    define HINTS_REFCNT_LOCK           MUTEX_LOCK(&PL_hints_mutex)
 536 #    define HINTS_REFCNT_UNLOCK         MUTEX_UNLOCK(&PL_hints_mutex)
 537 #  else
 538 #    define HINTS_REFCNT_LOCK           NOOP
 539 #    define HINTS_REFCNT_UNLOCK         NOOP
 540 #  endif
 541 #endif
 542
 543 #ifdef USE_ITHREADS
 544 #  define HINTS_REFCNT_INIT             MUTEX_INIT(&PL_hints_mutex)
 545 #  define HINTS_REFCNT_TERM             MUTEX_DESTROY(&PL_hints_mutex)
 546 #else
 547 #  define HINTS_REFCNT_INIT             NOOP
 548 #  define HINTS_REFCNT_TERM             NOOP
 549 #endif
 550
 551 /* Hash actions
 552  * Passed in PERL_MAGIC_uvar calls
 553  */
 554 #define HV_DISABLE_UVAR_XKEY    0x01
 555 /* We need to ensure that these don't clash with G_DISCARD, which is 2, as it
 556    is documented as being passed to hv_delete().  */
 557 #define HV_FETCH_ISSTORE        0x04
 558 #define HV_FETCH_ISEXISTS       0x08
 559 #define HV_FETCH_LVALUE         0x10
 560 #define HV_FETCH_JUST_SV        0x20
 561 #define HV_DELETE               0x40
 562
 563 /*
 564 =for apidoc newHV
 565
 566 Creates a new HV.  The reference count is set to 1.
 567
 568 =cut
 569 */
 570
 571 #define newHV() MUTABLE_HV(newSV_type(SVt_PVHV))
 572
 573 /*
 574  * Local variables:
 575  * c-indentation-style: bsd
 576  * c-basic-offset: 4
 577  * indent-tabs-mode: t
 578  * End:
 579  *
 580  * ex: set ts=8 sts=4 sw=4 noet:
 581  */