hv.h

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