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