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     mro_alg mro_which;       /* which mro alg is in use? */
  55 };
  56
  57 /* Subject to change.
  58    Don't access this directly.
  59 */
  60
  61 struct xpvhv_aux {
  62     HEK         *xhv_name;      /* name, if a symbol table */
  63     AV          *xhv_backreferences; /* back references for weak references */
  64     HE          *xhv_eiter;     /* current entry of iterator */
  65     I32         xhv_riter;      /* current root of iterator */
  66     struct mro_meta *xhv_mro_meta;
  67 };
  68
  69 /* hash structure: */
  70 /* This structure must match the beginning of struct xpvmg in sv.h. */
  71 struct xpvhv {
  72     union {
  73         NV      xnv_nv;         /* numeric value, if any */
  74         HV *    xgv_stash;
  75         struct {
  76             U32 xlow;
  77             U32 xhigh;
  78         }       xpad_cop_seq;   /* used by pad.c for cop_sequence */
  79         struct {
  80             U32 xbm_previous;   /* how many characters in string before rare? */
  81             U8  xbm_flags;
  82             U8  xbm_rare;       /* rarest character in string */
  83         }       xbm_s;          /* fields from PVBM */
  84     }           xnv_u;
  85     STRLEN      xhv_fill;       /* how full xhv_array currently is */
  86     STRLEN      xhv_max;        /* subscript of last element of xhv_array */
  87     union {
  88         IV      xivu_iv;        /* integer value or pv offset */
  89         UV      xivu_uv;
  90         void *  xivu_p1;
  91         I32     xivu_i32;
  92         HEK *   xivu_namehek;
  93     }           xiv_u;
  94     union {
  95         MAGIC*  xmg_magic;      /* linked list of magicalness */
  96         HV*     xmg_ourstash;   /* Stash for our (when SvPAD_OUR is true) */
  97     } xmg_u;
  98     HV*         xmg_stash;      /* class package */
  99 };
 100
 101 #define xhv_keys xiv_u.xivu_iv
 102
 103 typedef struct {
 104     STRLEN      xhv_fill;       /* how full xhv_array currently is */
 105     STRLEN      xhv_max;        /* subscript of last element of xhv_array */
 106     union {
 107         IV      xivu_iv;        /* integer value or pv offset */
 108         UV      xivu_uv;
 109         void *  xivu_p1;
 110         I32     xivu_i32;
 111         HEK *   xivu_namehek;
 112     }           xiv_u;
 113     union {
 114         MAGIC*  xmg_magic;      /* linked list of magicalness */
 115         HV*     xmg_ourstash;   /* Stash for our (when SvPAD_OUR is true) */
 116     } xmg_u;
 117     HV*         xmg_stash;      /* class package */
 118 } xpvhv_allocated;
 119
 120 /* hash a key */
 121 /* FYI: This is the "One-at-a-Time" algorithm by Bob Jenkins
 122  * from requirements by Colin Plumb.
 123  * (http://burtleburtle.net/bob/hash/doobs.html) */
 124 /* The use of a temporary pointer and the casting games
 125  * is needed to serve the dual purposes of
 126  * (a) the hashed data being interpreted as "unsigned char" (new since 5.8,
 127  *     a "char" can be either signed or unsigned, depending on the compiler)
 128  * (b) catering for old code that uses a "char"
 129  *
 130  * The "hash seed" feature was added in Perl 5.8.1 to perturb the results
 131  * to avoid "algorithmic complexity attacks".
 132  *
 133  * If USE_HASH_SEED is defined, hash randomisation is done by default
 134  * If USE_HASH_SEED_EXPLICIT is defined, hash randomisation is done
 135  * only if the environment variable PERL_HASH_SEED is set.
 136  * For maximal control, one can define PERL_HASH_SEED.
 137  * (see also perl.c:perl_parse()).
 138  */
 139 #ifndef PERL_HASH_SEED
 140 #   if defined(USE_HASH_SEED) || defined(USE_HASH_SEED_EXPLICIT)
 141 #       define PERL_HASH_SEED   PL_hash_seed
 142 #   else
 143 #       define PERL_HASH_SEED   0
 144 #   endif
 145 #endif
 146 #define PERL_HASH(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 = PERL_HASH_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
 162 /* Only hv.c and mod_perl should be doing this.  */
 163 #ifdef PERL_HASH_INTERNAL_ACCESS
 164 #define PERL_HASH_INTERNAL(hash,str,len) \
 165      STMT_START { \
 166         register const char * const s_PeRlHaSh_tmp = str; \
 167         register const unsigned char *s_PeRlHaSh = (const unsigned char *)s_PeRlHaSh_tmp; \
 168         register I32 i_PeRlHaSh = len; \
 169         register U32 hash_PeRlHaSh = PL_rehash_seed; \
 170         while (i_PeRlHaSh--) { \
 171             hash_PeRlHaSh += *s_PeRlHaSh++; \
 172             hash_PeRlHaSh += (hash_PeRlHaSh << 10); \
 173             hash_PeRlHaSh ^= (hash_PeRlHaSh >> 6); \
 174         } \
 175         hash_PeRlHaSh += (hash_PeRlHaSh << 3); \
 176         hash_PeRlHaSh ^= (hash_PeRlHaSh >> 11); \
 177         (hash) = (hash_PeRlHaSh + (hash_PeRlHaSh << 15)); \
 178     } STMT_END
 179 #endif
 180
 181 /*
 182 =head1 Hash Manipulation Functions
 183
 184 =for apidoc AmU||HEf_SVKEY
 185 This flag, used in the length slot of hash entries and magic structures,
 186 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
 187 is to be expected. (For information only--not to be used).
 188
 189 =head1 Handy Values
 190
 191 =for apidoc AmU||Nullhv
 192 Null HV pointer.
 193
 194 =head1 Hash Manipulation Functions
 195
 196 =for apidoc Am|char*|HvNAME|HV* stash
 197 Returns the package name of a stash, or NULL if C<stash> isn't a stash.
 198 See C<SvSTASH>, C<CvSTASH>.
 199
 200 =for apidoc Am|void*|HeKEY|HE* he
 201 Returns the actual pointer stored in the key slot of the hash entry. The
 202 pointer may be either C<char*> or C<SV*>, depending on the value of
 203 C<HeKLEN()>.  Can be assigned to.  The C<HePV()> or C<HeSVKEY()> macros are
 204 usually preferable for finding the value of a key.
 205
 206 =for apidoc Am|STRLEN|HeKLEN|HE* he
 207 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
 208 holds an C<SV*> key.  Otherwise, holds the actual length of the key.  Can
 209 be assigned to. The C<HePV()> macro is usually preferable for finding key
 210 lengths.
 211
 212 =for apidoc Am|SV*|HeVAL|HE* he
 213 Returns the value slot (type C<SV*>) stored in the hash entry.
 214
 215 =for apidoc Am|U32|HeHASH|HE* he
 216 Returns the computed hash stored in the hash entry.
 217
 218 =for apidoc Am|char*|HePV|HE* he|STRLEN len
 219 Returns the key slot of the hash entry as a C<char*> value, doing any
 220 necessary dereferencing of possibly C<SV*> keys.  The length of the string
 221 is placed in C<len> (this is a macro, so do I<not> use C<&len>).  If you do
 222 not care about what the length of the key is, you may use the global
 223 variable C<PL_na>, though this is rather less efficient than using a local
 224 variable.  Remember though, that hash keys in perl are free to contain
 225 embedded nulls, so using C<strlen()> or similar is not a good way to find
 226 the length of hash keys. This is very similar to the C<SvPV()> macro
 227 described elsewhere in this document.
 228
 229 =for apidoc Am|SV*|HeSVKEY|HE* he
 230 Returns the key as an C<SV*>, or C<NULL> if the hash entry does not
 231 contain an C<SV*> key.
 232
 233 =for apidoc Am|SV*|HeSVKEY_force|HE* he
 234 Returns the key as an C<SV*>.  Will create and return a temporary mortal
 235 C<SV*> if the hash entry contains only a C<char*> key.
 236
 237 =for apidoc Am|SV*|HeSVKEY_set|HE* he|SV* sv
 238 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
 239 indicate the presence of an C<SV*> key, and returns the same
 240 C<SV*>.
 241
 242 =cut
 243 */
 244
 245 /* these hash entry flags ride on hent_klen (for use only in magic/tied HVs) */
 246 #define HEf_SVKEY       -2      /* hent_key is an SV* */
 247
 248
 249 #define Nullhv Null(HV*)
 250 #define HvARRAY(hv)     ((hv)->sv_u.svu_hash)
 251 #define HvFILL(hv)      ((XPVHV*)  SvANY(hv))->xhv_fill
 252 #define HvMAX(hv)       ((XPVHV*)  SvANY(hv))->xhv_max
 253 /* This quite intentionally does no flag checking first. That's your
 254    responsibility.  */
 255 #define HvAUX(hv)       ((struct xpvhv_aux*)&(HvARRAY(hv)[HvMAX(hv)+1]))
 256 #define HvRITER(hv)     (*Perl_hv_riter_p(aTHX_ (HV*)(hv)))
 257 #define HvEITER(hv)     (*Perl_hv_eiter_p(aTHX_ (HV*)(hv)))
 258 #define HvRITER_set(hv,r)       Perl_hv_riter_set(aTHX_ (HV*)(hv), r)
 259 #define HvEITER_set(hv,e)       Perl_hv_eiter_set(aTHX_ (HV*)(hv), e)
 260 #define HvRITER_get(hv) (SvOOK(hv) ? HvAUX(hv)->xhv_riter : -1)
 261 #define HvEITER_get(hv) (SvOOK(hv) ? HvAUX(hv)->xhv_eiter : 0)
 262 #define HvNAME(hv)      HvNAME_get(hv)
 263 #define HvMROMETA(hv)   (SvOOK(hv) \
 264                         ? (HvAUX(hv)->xhv_mro_meta ? HvAUX(hv)->xhv_mro_meta : mro_meta_init(hv)) \
 265                         : NULL)
 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 : 0)
 270 #define HvNAME_get(hv)  ((SvOOK(hv) && (HvAUX(hv)->xhv_name)) \
 271                          ? HEK_KEY(HvAUX(hv)->xhv_name) : 0)
 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_ (HV*)hv))
 287 #define HvPLACEHOLDERS_get(hv)  (SvMAGIC(hv) ? Perl_hv_placeholders_get(aTHX_ (HV*)hv) : 0)
 288 #define HvPLACEHOLDERS_set(hv,p)        Perl_hv_placeholders_set(aTHX_ (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 #define Nullhe Null(HE*)
 315 #define HeNEXT(he)              (he)->hent_next
 316 #define HeKEY_hek(he)           (he)->hent_hek
 317 #define HeKEY(he)               HEK_KEY(HeKEY_hek(he))
 318 #define HeKEY_sv(he)            (*(SV**)HeKEY(he))
 319 #define HeKLEN(he)              HEK_LEN(HeKEY_hek(he))
 320 #define HeKUTF8(he)  HEK_UTF8(HeKEY_hek(he))
 321 #define HeKWASUTF8(he)  HEK_WASUTF8(HeKEY_hek(he))
 322 #define HeKREHASH(he)  HEK_REHASH(HeKEY_hek(he))
 323 #define HeKLEN_UTF8(he)  (HeKUTF8(he) ? -HeKLEN(he) : HeKLEN(he))
 324 #define HeKFLAGS(he)  HEK_FLAGS(HeKEY_hek(he))
 325 #define HeVAL(he)               (he)->he_valu.hent_val
 326 #define HeHASH(he)              HEK_HASH(HeKEY_hek(he))
 327 #define HePV(he,lp)             ((HeKLEN(he) == HEf_SVKEY) ?            \
 328                                  SvPV(HeKEY_sv(he),lp) :                \
 329                                  ((lp = HeKLEN(he)), HeKEY(he)))
 330
 331 #define HeSVKEY(he)             ((HeKEY(he) &&                          \
 332                                   HeKLEN(he) == HEf_SVKEY) ?            \
 333                                  HeKEY_sv(he) : NULL)
 334
 335 #define HeSVKEY_force(he)       (HeKEY(he) ?                            \
 336                                  ((HeKLEN(he) == HEf_SVKEY) ?           \
 337                                   HeKEY_sv(he) :                        \
 338                                   sv_2mortal(newSVpvn(HeKEY(he),        \
 339                                                      HeKLEN(he)))) :    \
 340                                  &PL_sv_undef)
 341 #define HeSVKEY_set(he,sv)      ((HeKLEN(he) = HEf_SVKEY), (HeKEY_sv(he) = sv))
 342
 343 #define Nullhek Null(HEK*)
 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_MASK      0xFF
 358
 359 /* Which flags enable HvHASKFLAGS? Somewhat a hack on a hack, as
 360    HVhek_REHASH is only needed because the rehash flag has to be duplicated
 361    into all keys as hv_iternext has no access to the hash flags. At this
 362    point Storable's tests get upset, because sometimes hashes are "keyed"
 363    and sometimes not, depending on the order of data insertion, and whether
 364    it triggered rehashing. So currently HVhek_REHASH is exempt.
 365    Similarly UNSHARED
 366 */
 367
 368 #define HVhek_ENABLEHVKFLAGS    (HVhek_MASK & ~(HVhek_REHASH|HVhek_UNSHARED))
 369
 370 #define HEK_UTF8(hek)           (HEK_FLAGS(hek) & HVhek_UTF8)
 371 #define HEK_UTF8_on(hek)        (HEK_FLAGS(hek) |= HVhek_UTF8)
 372 #define HEK_UTF8_off(hek)       (HEK_FLAGS(hek) &= ~HVhek_UTF8)
 373 #define HEK_WASUTF8(hek)        (HEK_FLAGS(hek) & HVhek_WASUTF8)
 374 #define HEK_WASUTF8_on(hek)     (HEK_FLAGS(hek) |= HVhek_WASUTF8)
 375 #define HEK_WASUTF8_off(hek)    (HEK_FLAGS(hek) &= ~HVhek_WASUTF8)
 376 #define HEK_REHASH(hek)         (HEK_FLAGS(hek) & HVhek_REHASH)
 377 #define HEK_REHASH_on(hek)      (HEK_FLAGS(hek) |= HVhek_REHASH)
 378
 379 /* calculate HV array allocation */
 380 #ifndef PERL_USE_LARGE_HV_ALLOC
 381 /* Default to allocating the correct size - default to assuming that malloc()
 382    is not broken and is efficient at allocating blocks sized at powers-of-two.
 383 */
 384 #  define PERL_HV_ARRAY_ALLOC_BYTES(size) ((size) * sizeof(HE*))
 385 #else
 386 #  define MALLOC_OVERHEAD 16
 387 #  define PERL_HV_ARRAY_ALLOC_BYTES(size) \
 388                         (((size) < 64)                                  \
 389                          ? (size) * sizeof(HE*)                         \
 390                          : (size) * sizeof(HE*) * 2 - MALLOC_OVERHEAD)
 391 #endif
 392
 393 /* Flags for hv_iternext_flags.  */
 394 #define HV_ITERNEXT_WANTPLACEHOLDERS    0x01    /* Don't skip placeholders.  */
 395
 396 #define hv_iternext(hv) hv_iternext_flags(hv, 0)
 397 #define hv_magic(hv, gv, how) sv_magic((SV*)(hv), (SV*)(gv), how, NULL, 0)
 398
 399 /* available as a function in hv.c */
 400 #define Perl_sharepvn(sv, len, hash) HEK_KEY(share_hek(sv, len, hash))
 401 #define sharepvn(sv, len, hash)      Perl_sharepvn(sv, len, hash)
 402
 403 #define share_hek_hek(hek)                                              \
 404     (++(((struct shared_he *)(((char *)hek)                             \
 405                               - STRUCT_OFFSET(struct shared_he,         \
 406                                               shared_he_hek)))          \
 407         ->shared_he_he.he_valu.hent_refcount),                          \
 408      hek)
 409
 410 /* This refcounted he structure is used for storing the hints used for lexical
 411    pragmas. Without threads, it's basically struct he + refcount.
 412    With threads, life gets more complex as the structure needs to be shared
 413    between threads (because it hangs from OPs, which are shared), hence the
 414    alternate definition and mutex.  */
 415
 416 struct refcounted_he;
 417
 418 #ifdef PERL_CORE
 419
 420 /* Gosh. This really isn't a good name any longer.  */
 421 struct refcounted_he {
 422     struct refcounted_he *refcounted_he_next;   /* next entry in chain */
 423 #ifdef USE_ITHREADS
 424     U32                   refcounted_he_hash;
 425     U32                   refcounted_he_keylen;
 426 #else
 427     HEK                  *refcounted_he_hek;    /* hint key */
 428 #endif
 429     union {
 430         IV                refcounted_he_u_iv;
 431         UV                refcounted_he_u_uv;
 432         STRLEN            refcounted_he_u_len;
 433         void             *refcounted_he_u_ptr;  /* Might be useful in future */
 434     } refcounted_he_val;
 435     U32                   refcounted_he_refcnt; /* reference count */
 436     /* First byte is flags. Then NUL-terminated value. Then for ithreads,
 437        non-NUL terminated key.  */
 438     char                  refcounted_he_data[1];
 439 };
 440
 441 /* Flag bits are HVhek_UTF8, HVhek_WASUTF8, then */
 442 #define HVrhek_undef    0x00 /* Value is undef. */
 443 #define HVrhek_delete   0x10 /* Value is placeholder - signifies delete. */
 444 #define HVrhek_IV       0x20 /* Value is IV. */
 445 #define HVrhek_UV       0x30 /* Value is UV. */
 446 #define HVrhek_PV       0x40 /* Value is a (byte) string. */
 447 #define HVrhek_PV_UTF8  0x50 /* Value is a (utf8) string. */
 448 /* Two spare. As these have to live in the optree, you can't store anything
 449    interpreter specific, such as SVs. :-( */
 450 #define HVrhek_typemask 0x70
 451
 452 #ifdef USE_ITHREADS
 453 /* A big expression to find the key offset */
 454 #define REF_HE_KEY(chain)                                               \
 455         ((((chain->refcounted_he_data[0] & 0x60) == 0x40)               \
 456             ? chain->refcounted_he_val.refcounted_he_u_len + 1 : 0)     \
 457          + 1 + chain->refcounted_he_data)
 458 #endif
 459
 460 #  ifdef USE_ITHREADS
 461 #    define HINTS_REFCNT_LOCK           MUTEX_LOCK(&PL_hints_mutex)
 462 #    define HINTS_REFCNT_UNLOCK         MUTEX_UNLOCK(&PL_hints_mutex)
 463 #  else
 464 #    define HINTS_REFCNT_LOCK           NOOP
 465 #    define HINTS_REFCNT_UNLOCK         NOOP
 466 #  endif
 467 #endif
 468
 469 #ifdef USE_ITHREADS
 470 #  define HINTS_REFCNT_INIT             MUTEX_INIT(&PL_hints_mutex)
 471 #  define HINTS_REFCNT_TERM             MUTEX_DESTROY(&PL_hints_mutex)
 472 #else
 473 #  define HINTS_REFCNT_INIT             NOOP
 474 #  define HINTS_REFCNT_TERM             NOOP
 475 #endif
 476
 477 /* Hash actions
 478  * Passed in PERL_MAGIC_uvar calls
 479  */
 480 #define HV_DELETE          -1
 481 #define HV_FETCH_ISSTORE   0x01
 482 #define HV_FETCH_ISEXISTS  0x02
 483 #define HV_FETCH_LVALUE    0x04
 484 #define HV_FETCH_JUST_SV   0x08
 485
 486 /*
 487  * Local variables:
 488  * c-indentation-style: bsd
 489  * c-basic-offset: 4
 490  * indent-tabs-mode: t
 491  * End:
 492  *
 493  * ex: set ts=8 sts=4 sw=4 noet:
 494  */