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
  45 /* structure may change, so not public yet */
  46 struct mro_alg;
  47
  48 struct mro_meta {
  49     /* repurposed as a hash holding the different MROs private data. */
  50     AV      *mro_linear_dfs; /* cached dfs @ISA linearization */
  51     /* repurposed as a pointer directly to the current MROs private data.  */
  52     AV      *mro_linear_c3;  /* cached c3 @ISA linearization */
  53     HV      *mro_nextmethod; /* next::method caching */
  54     U32     cache_gen;       /* Bumping this invalidates our method cache */
  55     U32     pkg_gen;         /* Bumps when local methods/@ISA change */
  56     const struct mro_alg *mro_which; /* which mro alg is in use? */
  57     HV      *isa;            /* Everything this class @ISA */
  58 };
  59
  60 #define MRO_GET_PRIVATE_DATA(smeta, which)                 \
  61     (((smeta)->mro_which && (which) == (smeta)->mro_which) \
  62      ? MUTABLE_SV((smeta)->mro_linear_c3)                  \
  63      : Perl_mro_get_private_data(aTHX_ (smeta), (which)))
  64
  65 /* Subject to change.
  66    Don't access this directly.
  67 */
  68
  69 struct xpvhv_aux {
  70     HEK         *xhv_name;      /* name, if a symbol table */
  71     AV          *xhv_backreferences; /* back references for weak references */
  72     HE          *xhv_eiter;     /* current entry of iterator */
  73     I32         xhv_riter;      /* current root of iterator */
  74     struct mro_meta *xhv_mro_meta;
  75 };
  76
  77 #define _XPVHV_ALLOCATED_HEAD                                               \
  78     STRLEN      xhv_fill;       /* how full xhv_array currently is */       \
  79     STRLEN      xhv_max         /* subscript of last element of xhv_array */
  80
  81 #define _XPVHV_HEAD     \
  82     union _xnvu xnv_u;  \
  83     _XPVHV_ALLOCATED_HEAD
  84
  85 /* hash structure: */
  86 /* This structure must match the beginning of struct xpvmg in sv.h. */
  87 struct xpvhv {
  88     _XPVHV_HEAD;
  89     _XPVMG_HEAD;
  90 };
  91
  92 #define xhv_keys xiv_u.xivu_iv
  93
  94 typedef struct {
  95     _XPVHV_ALLOCATED_HEAD;
  96     _XPVMG_HEAD;
  97 } xpvhv_allocated;
  98
  99 #undef _XPVHV_ALLOCATED_HEAD
 100 #undef _XPVHV_HEAD
 101
 102 /* hash a key */
 103 /* FYI: This is the "One-at-a-Time" algorithm by Bob Jenkins
 104  * from requirements by Colin Plumb.
 105  * (http://burtleburtle.net/bob/hash/doobs.html) */
 106 /* The use of a temporary pointer and the casting games
 107  * is needed to serve the dual purposes of
 108  * (a) the hashed data being interpreted as "unsigned char" (new since 5.8,
 109  *     a "char" can be either signed or unsigned, depending on the compiler)
 110  * (b) catering for old code that uses a "char"
 111  *
 112  * The "hash seed" feature was added in Perl 5.8.1 to perturb the results
 113  * to avoid "algorithmic complexity attacks".
 114  *
 115  * If USE_HASH_SEED is defined, hash randomisation is done by default
 116  * If USE_HASH_SEED_EXPLICIT is defined, hash randomisation is done
 117  * only if the environment variable PERL_HASH_SEED is set.
 118  * For maximal control, one can define PERL_HASH_SEED.
 119  * (see also perl.c:perl_parse()).
 120  */
 121 #ifndef PERL_HASH_SEED
 122 #   if defined(USE_HASH_SEED) || defined(USE_HASH_SEED_EXPLICIT)
 123 #       define PERL_HASH_SEED   PL_hash_seed
 124 #   else
 125 #       define PERL_HASH_SEED   0
 126 #   endif
 127 #endif
 128 #define PERL_HASH(hash,str,len) \
 129      STMT_START { \
 130         register const char * const s_PeRlHaSh_tmp = str; \
 131         register const unsigned char *s_PeRlHaSh = (const unsigned char *)s_PeRlHaSh_tmp; \
 132         register I32 i_PeRlHaSh = len; \
 133         register U32 hash_PeRlHaSh = PERL_HASH_SEED; \
 134         while (i_PeRlHaSh--) { \
 135             hash_PeRlHaSh += *s_PeRlHaSh++; \
 136             hash_PeRlHaSh += (hash_PeRlHaSh << 10); \
 137             hash_PeRlHaSh ^= (hash_PeRlHaSh >> 6); \
 138         } \
 139         hash_PeRlHaSh += (hash_PeRlHaSh << 3); \
 140         hash_PeRlHaSh ^= (hash_PeRlHaSh >> 11); \
 141         (hash) = (hash_PeRlHaSh + (hash_PeRlHaSh << 15)); \
 142     } STMT_END
 143
 144 /* Only hv.c and mod_perl should be doing this.  */
 145 #ifdef PERL_HASH_INTERNAL_ACCESS
 146 #define PERL_HASH_INTERNAL(hash,str,len) \
 147      STMT_START { \
 148         register const char * const s_PeRlHaSh_tmp = str; \
 149         register const unsigned char *s_PeRlHaSh = (const unsigned char *)s_PeRlHaSh_tmp; \
 150         register I32 i_PeRlHaSh = len; \
 151         register U32 hash_PeRlHaSh = PL_rehash_seed; \
 152         while (i_PeRlHaSh--) { \
 153             hash_PeRlHaSh += *s_PeRlHaSh++; \
 154             hash_PeRlHaSh += (hash_PeRlHaSh << 10); \
 155             hash_PeRlHaSh ^= (hash_PeRlHaSh >> 6); \
 156         } \
 157         hash_PeRlHaSh += (hash_PeRlHaSh << 3); \
 158         hash_PeRlHaSh ^= (hash_PeRlHaSh >> 11); \
 159         (hash) = (hash_PeRlHaSh + (hash_PeRlHaSh << 15)); \
 160     } STMT_END
 161 #endif
 162
 163 /*
 164 =head1 Hash Manipulation Functions
 165
 166 =for apidoc AmU||HEf_SVKEY
 167 This flag, used in the length slot of hash entries and magic structures,
 168 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
 169 is to be expected. (For information only--not to be used).
 170
 171 =head1 Handy Values
 172
 173 =for apidoc AmU||Nullhv
 174 Null HV pointer.
 175
 176 (deprecated - use C<(HV *)NULL> instead)
 177
 178 =head1 Hash Manipulation Functions
 179
 180 =for apidoc Am|char*|HvNAME|HV* stash
 181 Returns the package name of a stash, or NULL if C<stash> isn't a stash.
 182 See C<SvSTASH>, C<CvSTASH>.
 183
 184 =for apidoc Am|void*|HeKEY|HE* he
 185 Returns the actual pointer stored in the key slot of the hash entry. The
 186 pointer may be either C<char*> or C<SV*>, depending on the value of
 187 C<HeKLEN()>.  Can be assigned to.  The C<HePV()> or C<HeSVKEY()> macros are
 188 usually preferable for finding the value of a key.
 189
 190 =for apidoc Am|STRLEN|HeKLEN|HE* he
 191 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
 192 holds an C<SV*> key.  Otherwise, holds the actual length of the key.  Can
 193 be assigned to. The C<HePV()> macro is usually preferable for finding key
 194 lengths.
 195
 196 =for apidoc Am|SV*|HeVAL|HE* he
 197 Returns the value slot (type C<SV*>) stored in the hash entry.
 198
 199 =for apidoc Am|U32|HeHASH|HE* he
 200 Returns the computed hash stored in the hash entry.
 201
 202 =for apidoc Am|char*|HePV|HE* he|STRLEN len
 203 Returns the key slot of the hash entry as a C<char*> value, doing any
 204 necessary dereferencing of possibly C<SV*> keys.  The length of the string
 205 is placed in C<len> (this is a macro, so do I<not> use C<&len>).  If you do
 206 not care about what the length of the key is, you may use the global
 207 variable C<PL_na>, though this is rather less efficient than using a local
 208 variable.  Remember though, that hash keys in perl are free to contain
 209 embedded nulls, so using C<strlen()> or similar is not a good way to find
 210 the length of hash keys. This is very similar to the C<SvPV()> macro
 211 described elsewhere in this document. See also C<HeUTF8>.
 212
 213 If you are using C<HePV> to get values to pass to C<newSVpvn()> to create a
 214 new SV, you should consider using C<newSVhek(HeKEY_hek(he))> as it is more
 215 efficient.
 216
 217 =for apidoc Am|char*|HeUTF8|HE* he|STRLEN len
 218 Returns whether the C<char *> value returned by C<HePV> is encoded in UTF-8,
 219 doing any necessary dereferencing of possibly C<SV*> keys.  The value returned
 220 will be 0 or non-0, not necessarily 1 (or even a value with any low bits set),
 221 so B<do not> blindly assign this to a C<bool> variable, as C<bool> may be a
 222 typedef for C<char>.
 223
 224 =for apidoc Am|SV*|HeSVKEY|HE* he
 225 Returns the key as an C<SV*>, or C<NULL> if the hash entry does not
 226 contain an C<SV*> key.
 227
 228 =for apidoc Am|SV*|HeSVKEY_force|HE* he
 229 Returns the key as an C<SV*>.  Will create and return a temporary mortal
 230 C<SV*> if the hash entry contains only a C<char*> key.
 231
 232 =for apidoc Am|SV*|HeSVKEY_set|HE* he|SV* sv
 233 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
 234 indicate the presence of an C<SV*> key, and returns the same
 235 C<SV*>.
 236
 237 =cut
 238 */
 239
 240 /* these hash entry flags ride on hent_klen (for use only in magic/tied HVs) */
 241 #define HEf_SVKEY       -2      /* hent_key is an SV* */
 242
 243 #ifndef PERL_CORE
 244 #  define Nullhv Null(HV*)
 245 #endif
 246 #define HvARRAY(hv)     ((hv)->sv_u.svu_hash)
 247 #define HvFILL(hv)      ((XPVHV*)  SvANY(hv))->xhv_fill
 248 #define HvMAX(hv)       ((XPVHV*)  SvANY(hv))->xhv_max
 249 /* This quite intentionally does no flag checking first. That's your
 250    responsibility.  */
 251 #define HvAUX(hv)       ((struct xpvhv_aux*)&(HvARRAY(hv)[HvMAX(hv)+1]))
 252 #define HvRITER(hv)     (*Perl_hv_riter_p(aTHX_ MUTABLE_HV(hv)))
 253 #define HvEITER(hv)     (*Perl_hv_eiter_p(aTHX_ MUTABLE_HV(hv)))
 254 #define HvRITER_set(hv,r)       Perl_hv_riter_set(aTHX_ MUTABLE_HV(hv), r)
 255 #define HvEITER_set(hv,e)       Perl_hv_eiter_set(aTHX_ MUTABLE_HV(hv), e)
 256 #define HvRITER_get(hv) (SvOOK(hv) ? HvAUX(hv)->xhv_riter : -1)
 257 #define HvEITER_get(hv) (SvOOK(hv) ? HvAUX(hv)->xhv_eiter : NULL)
 258 #define HvNAME(hv)      HvNAME_get(hv)
 259
 260 /* Checking that hv is a valid package stash is the
 261    caller's responsibility */
 262 #define HvMROMETA(hv) (HvAUX(hv)->xhv_mro_meta \
 263                        ? HvAUX(hv)->xhv_mro_meta \
 264                        : mro_meta_init(hv))
 265
 266 /* FIXME - all of these should use a UTF8 aware API, which should also involve
 267    getting the length. */
 268 /* This macro may go away without notice.  */
 269 #define HvNAME_HEK(hv) (SvOOK(hv) ? HvAUX(hv)->xhv_name : NULL)
 270 #define HvNAME_get(hv)  ((SvOOK(hv) && (HvAUX(hv)->xhv_name)) \
 271                          ? HEK_KEY(HvAUX(hv)->xhv_name) : NULL)
 272 #define HvNAMELEN_get(hv)       ((SvOOK(hv) && (HvAUX(hv)->xhv_name)) \
 273                                  ? HEK_LEN(HvAUX(hv)->xhv_name) : 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_MASK      0xFF
 365
 366 /* Which flags enable HvHASKFLAGS? Somewhat a hack on a hack, as
 367    HVhek_REHASH is only needed because the rehash flag has to be duplicated
 368    into all keys as hv_iternext has no access to the hash flags. At this
 369    point Storable's tests get upset, because sometimes hashes are "keyed"
 370    and sometimes not, depending on the order of data insertion, and whether
 371    it triggered rehashing. So currently HVhek_REHASH is exempt.
 372    Similarly UNSHARED
 373 */
 374
 375 #define HVhek_ENABLEHVKFLAGS    (HVhek_MASK & ~(HVhek_REHASH|HVhek_UNSHARED))
 376
 377 #define HEK_UTF8(hek)           (HEK_FLAGS(hek) & HVhek_UTF8)
 378 #define HEK_UTF8_on(hek)        (HEK_FLAGS(hek) |= HVhek_UTF8)
 379 #define HEK_UTF8_off(hek)       (HEK_FLAGS(hek) &= ~HVhek_UTF8)
 380 #define HEK_WASUTF8(hek)        (HEK_FLAGS(hek) & HVhek_WASUTF8)
 381 #define HEK_WASUTF8_on(hek)     (HEK_FLAGS(hek) |= HVhek_WASUTF8)
 382 #define HEK_WASUTF8_off(hek)    (HEK_FLAGS(hek) &= ~HVhek_WASUTF8)
 383 #define HEK_REHASH(hek)         (HEK_FLAGS(hek) & HVhek_REHASH)
 384 #define HEK_REHASH_on(hek)      (HEK_FLAGS(hek) |= HVhek_REHASH)
 385
 386 /* calculate HV array allocation */
 387 #ifndef PERL_USE_LARGE_HV_ALLOC
 388 /* Default to allocating the correct size - default to assuming that malloc()
 389    is not broken and is efficient at allocating blocks sized at powers-of-two.
 390 */
 391 #  define PERL_HV_ARRAY_ALLOC_BYTES(size) ((size) * sizeof(HE*))
 392 #else
 393 #  define MALLOC_OVERHEAD 16
 394 #  define PERL_HV_ARRAY_ALLOC_BYTES(size) \
 395                         (((size) < 64)                                  \
 396                          ? (size) * sizeof(HE*)                         \
 397                          : (size) * sizeof(HE*) * 2 - MALLOC_OVERHEAD)
 398 #endif
 399
 400 /* Flags for hv_iternext_flags.  */
 401 #define HV_ITERNEXT_WANTPLACEHOLDERS    0x01    /* Don't skip placeholders.  */
 402
 403 #define hv_iternext(hv) hv_iternext_flags(hv, 0)
 404 #define hv_magic(hv, gv, how) sv_magic(MUTABLE_SV(hv), MUTABLE_SV(gv), how, NULL, 0)
 405
 406 /* available as a function in hv.c */
 407 #define Perl_sharepvn(sv, len, hash) HEK_KEY(share_hek(sv, len, hash))
 408 #define sharepvn(sv, len, hash)      Perl_sharepvn(sv, len, hash)
 409
 410 #define share_hek_hek(hek)                                              \
 411     (++(((struct shared_he *)(((char *)hek)                             \
 412                               - STRUCT_OFFSET(struct shared_he,         \
 413                                               shared_he_hek)))          \
 414         ->shared_he_he.he_valu.hent_refcount),                          \
 415      hek)
 416
 417 #define hv_store_ent(hv, keysv, val, hash)                              \
 418     ((HE *) hv_common((hv), (keysv), NULL, 0, 0, HV_FETCH_ISSTORE,      \
 419                       (val), (hash)))
 420
 421 #define hv_exists_ent(hv, keysv, hash)                                  \
 422     (hv_common((hv), (keysv), NULL, 0, 0, HV_FETCH_ISEXISTS, 0, (hash)) \
 423      ? TRUE : FALSE)
 424 #define hv_fetch_ent(hv, keysv, lval, hash)                             \
 425     ((HE *) hv_common((hv), (keysv), NULL, 0, 0,                        \
 426                       ((lval) ? HV_FETCH_LVALUE : 0), NULL, (hash)))
 427 #define hv_delete_ent(hv, key, flags, hash)                             \
 428     (MUTABLE_SV(hv_common((hv), (key), NULL, 0, 0, (flags) | HV_DELETE, \
 429                           NULL, (hash))))
 430
 431 #define hv_store_flags(hv, key, klen, val, hash, flags)                 \
 432     ((SV**) hv_common((hv), NULL, (key), (klen), (flags),               \
 433                       (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV), (val),       \
 434                       (hash)))
 435
 436 #define hv_store(hv, key, klen, val, hash)                              \
 437     ((SV**) hv_common_key_len((hv), (key), (klen),                      \
 438                               (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV),      \
 439                               (val), (hash)))
 440
 441 #define hv_exists(hv, key, klen)                                        \
 442     (hv_common_key_len((hv), (key), (klen), HV_FETCH_ISEXISTS, NULL, 0) \
 443      ? TRUE : FALSE)
 444
 445 #define hv_fetch(hv, key, klen, lval)                                   \
 446     ((SV**) hv_common_key_len((hv), (key), (klen), (lval)               \
 447                               ? (HV_FETCH_JUST_SV | HV_FETCH_LVALUE)    \
 448                               : HV_FETCH_JUST_SV, NULL, 0))
 449
 450 #define hv_delete(hv, key, klen, flags)                                 \
 451     (MUTABLE_SV(hv_common_key_len((hv), (key), (klen),                  \
 452                                   (flags) | HV_DELETE, NULL, 0)))
 453
 454 /* This refcounted he structure is used for storing the hints used for lexical
 455    pragmas. Without threads, it's basically struct he + refcount.
 456    With threads, life gets more complex as the structure needs to be shared
 457    between threads (because it hangs from OPs, which are shared), hence the
 458    alternate definition and mutex.  */
 459
 460 struct refcounted_he;
 461
 462 #ifdef PERL_CORE
 463
 464 /* Gosh. This really isn't a good name any longer.  */
 465 struct refcounted_he {
 466     struct refcounted_he *refcounted_he_next;   /* next entry in chain */
 467 #ifdef USE_ITHREADS
 468     U32                   refcounted_he_hash;
 469     U32                   refcounted_he_keylen;
 470 #else
 471     HEK                  *refcounted_he_hek;    /* hint key */
 472 #endif
 473     union {
 474         IV                refcounted_he_u_iv;
 475         UV                refcounted_he_u_uv;
 476         STRLEN            refcounted_he_u_len;
 477         void             *refcounted_he_u_ptr;  /* Might be useful in future */
 478     } refcounted_he_val;
 479     U32                   refcounted_he_refcnt; /* reference count */
 480     /* First byte is flags. Then NUL-terminated value. Then for ithreads,
 481        non-NUL terminated key.  */
 482     char                  refcounted_he_data[1];
 483 };
 484
 485 /* Flag bits are HVhek_UTF8, HVhek_WASUTF8, then */
 486 #define HVrhek_undef    0x00 /* Value is undef. */
 487 #define HVrhek_delete   0x10 /* Value is placeholder - signifies delete. */
 488 #define HVrhek_IV       0x20 /* Value is IV. */
 489 #define HVrhek_UV       0x30 /* Value is UV. */
 490 #define HVrhek_PV       0x40 /* Value is a (byte) string. */
 491 #define HVrhek_PV_UTF8  0x50 /* Value is a (utf8) string. */
 492 /* Two spare. As these have to live in the optree, you can't store anything
 493    interpreter specific, such as SVs. :-( */
 494 #define HVrhek_typemask 0x70
 495
 496 #ifdef USE_ITHREADS
 497 /* A big expression to find the key offset */
 498 #define REF_HE_KEY(chain)                                               \
 499         ((((chain->refcounted_he_data[0] & 0x60) == 0x40)               \
 500             ? chain->refcounted_he_val.refcounted_he_u_len + 1 : 0)     \
 501          + 1 + chain->refcounted_he_data)
 502 #endif
 503
 504 #  ifdef USE_ITHREADS
 505 #    define HINTS_REFCNT_LOCK           MUTEX_LOCK(&PL_hints_mutex)
 506 #    define HINTS_REFCNT_UNLOCK         MUTEX_UNLOCK(&PL_hints_mutex)
 507 #  else
 508 #    define HINTS_REFCNT_LOCK           NOOP
 509 #    define HINTS_REFCNT_UNLOCK         NOOP
 510 #  endif
 511 #endif
 512
 513 #ifdef USE_ITHREADS
 514 #  define HINTS_REFCNT_INIT             MUTEX_INIT(&PL_hints_mutex)
 515 #  define HINTS_REFCNT_TERM             MUTEX_DESTROY(&PL_hints_mutex)
 516 #else
 517 #  define HINTS_REFCNT_INIT             NOOP
 518 #  define HINTS_REFCNT_TERM             NOOP
 519 #endif
 520
 521 /* Hash actions
 522  * Passed in PERL_MAGIC_uvar calls
 523  */
 524 #define HV_DISABLE_UVAR_XKEY    0x01
 525 /* We need to ensure that these don't clash with G_DISCARD, which is 2, as it
 526    is documented as being passed to hv_delete().  */
 527 #define HV_FETCH_ISSTORE        0x04
 528 #define HV_FETCH_ISEXISTS       0x08
 529 #define HV_FETCH_LVALUE         0x10
 530 #define HV_FETCH_JUST_SV        0x20
 531 #define HV_DELETE               0x40
 532
 533 /*
 534 =for apidoc newHV
 535
 536 Creates a new HV.  The reference count is set to 1.
 537
 538 =cut
 539 */
 540
 541 #define newHV() MUTABLE_HV(newSV_type(SVt_PVHV))
 542
 543 /*
 544  * Local variables:
 545  * c-indentation-style: bsd
 546  * c-basic-offset: 4
 547  * indent-tabs-mode: t
 548  * End:
 549  *
 550  * ex: set ts=8 sts=4 sw=4 noet:
 551  */