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 /* These control hash traversal randomization and the environment variable PERL_PERTURB_KEYS.
  12  * Currently disabling this functionality will break a few tests, but should otherwise work fine.
  13  * See perlrun for more details. */
  14
  15 #if defined(PERL_PERTURB_KEYS_DISABLED)
  16 #   define PL_HASH_RAND_BITS_ENABLED        0
  17 #   define PERL_HASH_ITER_BUCKET(iter)      ((iter)->xhv_riter)
  18 #else
  19 #   define PERL_HASH_RANDOMIZE_KEYS         1
  20 #   if defined(PERL_PERTURB_KEYS_RANDOM)
  21 #       define PL_HASH_RAND_BITS_ENABLED    1
  22 #   elif defined(PERL_PERTURB_KEYS_DETERMINISTIC)
  23 #       define PL_HASH_RAND_BITS_ENABLED    2
  24 #   else
  25 #       define USE_PERL_PERTURB_KEYS        1
  26 #       define PL_HASH_RAND_BITS_ENABLED    PL_hash_rand_bits_enabled
  27 #   endif
  28 #   define PERL_HASH_ITER_BUCKET(iter)      (((iter)->xhv_riter) ^ ((iter)->xhv_rand))
  29 #endif
  30
  31 /* entry in hash value chain */
  32 struct he {
  33     /* Keep hent_next first in this structure, because sv_free_arenas take
  34        advantage of this to share code between the he arenas and the SV
  35        body arenas  */
  36     HE          *hent_next;     /* next entry in chain */
  37     HEK         *hent_hek;      /* hash key */
  38     union {
  39         SV      *hent_val;      /* scalar value that was hashed */
  40         Size_t  hent_refcount;  /* references for this shared hash key */
  41     } he_valu;
  42 };
  43
  44 /* hash key -- defined separately for use as shared pointer */
  45 struct hek {
  46     U32         hek_hash;       /* hash of key */
  47     I32         hek_len;        /* length of hash key */
  48     char        hek_key[1];     /* variable-length hash key */
  49     /* the hash-key is \0-terminated */
  50     /* after the \0 there is a byte for flags, such as whether the key
  51        is UTF-8 */
  52 };
  53
  54 struct shared_he {
  55     struct he shared_he_he;
  56     struct hek shared_he_hek;
  57 };
  58
  59 /* Subject to change.
  60    Don't access this directly.
  61    Use the funcs in mro.c
  62 */
  63
  64 struct mro_alg {
  65     AV *(*resolve)(pTHX_ HV* stash, U32 level);
  66     const char *name;
  67     U16 length;
  68     U16 kflags; /* For the hash API - set HVhek_UTF8 if name is UTF-8 */
  69     U32 hash; /* or 0 */
  70 };
  71
  72 struct mro_meta {
  73     /* a hash holding the different MROs private data.  */
  74     HV      *mro_linear_all;
  75     /* a pointer directly to the current MROs private data.  If mro_linear_all
  76        is NULL, this owns the SV reference, else it is just a pointer to a
  77        value stored in and owned by mro_linear_all.  */
  78     SV      *mro_linear_current;
  79     HV      *mro_nextmethod; /* next::method caching */
  80     U32     cache_gen;       /* Bumping this invalidates our method cache */
  81     U32     pkg_gen;         /* Bumps when local methods/@ISA change */
  82     const struct mro_alg *mro_which; /* which mro alg is in use? */
  83     HV      *isa;            /* Everything this class @ISA */
  84 };
  85
  86 #define MRO_GET_PRIVATE_DATA(smeta, which)                 \
  87     (((smeta)->mro_which && (which) == (smeta)->mro_which) \
  88      ? (smeta)->mro_linear_current                         \
  89      : Perl_mro_get_private_data(aTHX_ (smeta), (which)))
  90
  91 /* Subject to change.
  92    Don't access this directly.
  93 */
  94
  95 union _xhvnameu {
  96     HEK *xhvnameu_name;         /* When xhv_name_count is 0 */
  97     HEK **xhvnameu_names;       /* When xhv_name_count is non-0 */
  98 };
  99
 100 struct xpvhv_aux {
 101     union _xhvnameu xhv_name_u; /* name, if a symbol table */
 102     AV          *xhv_backreferences; /* back references for weak references */
 103     HE          *xhv_eiter;     /* current entry of iterator */
 104     I32         xhv_riter;      /* current root of iterator */
 105
 106 /* Concerning xhv_name_count: When non-zero, xhv_name_u contains a pointer
 107  * to an array of HEK pointers, this being the length. The first element is
 108  * the name of the stash, which may be NULL. If xhv_name_count is positive,
 109  * then *xhv_name is one of the effective names. If xhv_name_count is nega-
 110  * tive, then xhv_name_u.xhvnameu_names[1] is the first effective name.
 111  */
 112     I32         xhv_name_count;
 113     struct mro_meta *xhv_mro_meta;
 114     HV *        xhv_super;      /* SUPER method cache */
 115 #ifdef PERL_HASH_RANDOMIZE_KEYS
 116     U32         xhv_rand;       /* random value for hash traversal */
 117     U32         xhv_last_rand;  /* last random value for hash traversal,
 118                                    used to detect each() after insert for warnings */
 119 #endif
 120 };
 121
 122 /* hash structure: */
 123 /* This structure must match the beginning of struct xpvmg in sv.h. */
 124 struct xpvhv {
 125     HV*         xmg_stash;      /* class package */
 126     union _xmgu xmg_u;
 127     STRLEN      xhv_keys;       /* total keys, including placeholders */
 128     STRLEN      xhv_max;        /* subscript of last element of xhv_array */
 129 };
 130
 131 /*
 132 =head1 Hash Manipulation Functions
 133
 134 =for apidoc AmU||HEf_SVKEY
 135 This flag, used in the length slot of hash entries and magic structures,
 136 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
 137 is to be expected. (For information only--not to be used).
 138
 139 =head1 Handy Values
 140
 141 =for apidoc AmU||Nullhv
 142 Null HV pointer.
 143
 144 (deprecated - use C<(HV *)NULL> instead)
 145
 146 =head1 Hash Manipulation Functions
 147
 148 =for apidoc Am|char*|HvNAME|HV* stash
 149 Returns the package name of a stash, or NULL if C<stash> isn't a stash.
 150 See C<SvSTASH>, C<CvSTASH>.
 151
 152 =for apidoc Am|STRLEN|HvNAMELEN|HV *stash
 153 Returns the length of the stash's name.
 154
 155 =for apidoc Am|unsigned char|HvNAMEUTF8|HV *stash
 156 Returns true if the name is in UTF8 encoding.
 157
 158 =for apidoc Am|char*|HvENAME|HV* stash
 159 Returns the effective name of a stash, or NULL if there is none. The
 160 effective name represents a location in the symbol table where this stash
 161 resides. It is updated automatically when packages are aliased or deleted.
 162 A stash that is no longer in the symbol table has no effective name. This
 163 name is preferable to C<HvNAME> for use in MRO linearisations and isa
 164 caches.
 165
 166 =for apidoc Am|STRLEN|HvENAMELEN|HV *stash
 167 Returns the length of the stash's effective name.
 168
 169 =for apidoc Am|unsigned char|HvENAMEUTF8|HV *stash
 170 Returns true if the effective name is in UTF8 encoding.
 171
 172 =for apidoc Am|void*|HeKEY|HE* he
 173 Returns the actual pointer stored in the key slot of the hash entry. The
 174 pointer may be either C<char*> or C<SV*>, depending on the value of
 175 C<HeKLEN()>.  Can be assigned to.  The C<HePV()> or C<HeSVKEY()> macros are
 176 usually preferable for finding the value of a key.
 177
 178 =for apidoc Am|STRLEN|HeKLEN|HE* he
 179 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
 180 holds an C<SV*> key.  Otherwise, holds the actual length of the key.  Can
 181 be assigned to. The C<HePV()> macro is usually preferable for finding key
 182 lengths.
 183
 184 =for apidoc Am|SV*|HeVAL|HE* he
 185 Returns the value slot (type C<SV*>) stored in the hash entry. Can be assigned
 186 to.
 187
 188   SV *foo= HeVAL(hv);
 189   HeVAL(hv)= sv;
 190
 191
 192 =for apidoc Am|U32|HeHASH|HE* he
 193 Returns the computed hash stored in the hash entry.
 194
 195 =for apidoc Am|char*|HePV|HE* he|STRLEN len
 196 Returns the key slot of the hash entry as a C<char*> value, doing any
 197 necessary dereferencing of possibly C<SV*> keys.  The length of the string
 198 is placed in C<len> (this is a macro, so do I<not> use C<&len>).  If you do
 199 not care about what the length of the key is, you may use the global
 200 variable C<PL_na>, though this is rather less efficient than using a local
 201 variable.  Remember though, that hash keys in perl are free to contain
 202 embedded nulls, so using C<strlen()> or similar is not a good way to find
 203 the length of hash keys. This is very similar to the C<SvPV()> macro
 204 described elsewhere in this document. See also C<HeUTF8>.
 205
 206 If you are using C<HePV> to get values to pass to C<newSVpvn()> to create a
 207 new SV, you should consider using C<newSVhek(HeKEY_hek(he))> as it is more
 208 efficient.
 209
 210 =for apidoc Am|char*|HeUTF8|HE* he
 211 Returns whether the C<char *> value returned by C<HePV> is encoded in UTF-8,
 212 doing any necessary dereferencing of possibly C<SV*> keys.  The value returned
 213 will be 0 or non-0, not necessarily 1 (or even a value with any low bits set),
 214 so B<do not> blindly assign this to a C<bool> variable, as C<bool> may be a
 215 typedef for C<char>.
 216
 217 =for apidoc Am|SV*|HeSVKEY|HE* he
 218 Returns the key as an C<SV*>, or C<NULL> if the hash entry does not
 219 contain an C<SV*> key.
 220
 221 =for apidoc Am|SV*|HeSVKEY_force|HE* he
 222 Returns the key as an C<SV*>.  Will create and return a temporary mortal
 223 C<SV*> if the hash entry contains only a C<char*> key.
 224
 225 =for apidoc Am|SV*|HeSVKEY_set|HE* he|SV* sv
 226 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
 227 indicate the presence of an C<SV*> key, and returns the same
 228 C<SV*>.
 229
 230 =cut
 231 */
 232
 233 #define PERL_HASH_DEFAULT_HvMAX 7
 234
 235 /* these hash entry flags ride on hent_klen (for use only in magic/tied HVs) */
 236 #define HEf_SVKEY       -2      /* hent_key is an SV* */
 237
 238 #ifndef PERL_CORE
 239 #  define Nullhv Null(HV*)
 240 #endif
 241 #define HvARRAY(hv)     ((hv)->sv_u.svu_hash)
 242 #define HvFILL(hv)      Perl_hv_fill(aTHX_ (const HV *)(hv))
 243 #define HvMAX(hv)       ((XPVHV*)  SvANY(hv))->xhv_max
 244 /* This quite intentionally does no flag checking first. That's your
 245    responsibility.  */
 246 #define HvAUX(hv)       ((struct xpvhv_aux*)&(HvARRAY(hv)[HvMAX(hv)+1]))
 247 #define HvRITER(hv)     (*Perl_hv_riter_p(aTHX_ MUTABLE_HV(hv)))
 248 #define HvEITER(hv)     (*Perl_hv_eiter_p(aTHX_ MUTABLE_HV(hv)))
 249 #define HvRITER_set(hv,r)       Perl_hv_riter_set(aTHX_ MUTABLE_HV(hv), r)
 250 #define HvEITER_set(hv,e)       Perl_hv_eiter_set(aTHX_ MUTABLE_HV(hv), e)
 251 #define HvRITER_get(hv) (SvOOK(hv) ? HvAUX(hv)->xhv_riter : -1)
 252 #define HvEITER_get(hv) (SvOOK(hv) ? HvAUX(hv)->xhv_eiter : NULL)
 253 #define HvRAND_get(hv)  (SvOOK(hv) ? HvAUX(hv)->xhv_rand : 0)
 254 #define HvLASTRAND_get(hv)      (SvOOK(hv) ? HvAUX(hv)->xhv_last_rand : 0)
 255
 256 #define HvNAME(hv)      HvNAME_get(hv)
 257 #define HvNAMELEN(hv)   HvNAMELEN_get(hv)
 258 #define HvENAME(hv)     HvENAME_get(hv)
 259 #define HvENAMELEN(hv)  HvENAMELEN_get(hv)
 260
 261 /* Checking that hv is a valid package stash is the
 262    caller's responsibility */
 263 #define HvMROMETA(hv) (HvAUX(hv)->xhv_mro_meta \
 264                        ? HvAUX(hv)->xhv_mro_meta \
 265                        : Perl_mro_meta_init(aTHX_ hv))
 266
 267 #define HvNAME_HEK_NN(hv)                         \
 268  (                                                \
 269   HvAUX(hv)->xhv_name_count                       \
 270   ? *HvAUX(hv)->xhv_name_u.xhvnameu_names         \
 271   : HvAUX(hv)->xhv_name_u.xhvnameu_name           \
 272  )
 273 /* This macro may go away without notice.  */
 274 #define HvNAME_HEK(hv) \
 275         (SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name ? HvNAME_HEK_NN(hv) : NULL)
 276 #define HvNAME_get(hv) \
 277         ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvNAME_HEK_NN(hv)) \
 278                          ? HEK_KEY(HvNAME_HEK_NN(hv)) : NULL)
 279 #define HvNAMELEN_get(hv) \
 280         ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvNAME_HEK_NN(hv)) \
 281                                  ? HEK_LEN(HvNAME_HEK_NN(hv)) : 0)
 282 #define HvNAMEUTF8(hv) \
 283         ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvNAME_HEK_NN(hv)) \
 284                                  ? HEK_UTF8(HvNAME_HEK_NN(hv)) : 0)
 285 #define HvENAME_HEK_NN(hv)                                             \
 286  (                                                                      \
 287   HvAUX(hv)->xhv_name_count > 0   ? HvAUX(hv)->xhv_name_u.xhvnameu_names[0] : \
 288   HvAUX(hv)->xhv_name_count < -1  ? HvAUX(hv)->xhv_name_u.xhvnameu_names[1] : \
 289   HvAUX(hv)->xhv_name_count == -1 ? NULL                              : \
 290                                     HvAUX(hv)->xhv_name_u.xhvnameu_name \
 291  )
 292 #define HvENAME_HEK(hv) \
 293         (SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name ? HvENAME_HEK_NN(hv) : NULL)
 294 #define HvENAME_get(hv) \
 295    ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvAUX(hv)->xhv_name_count != -1) \
 296                          ? HEK_KEY(HvENAME_HEK_NN(hv)) : NULL)
 297 #define HvENAMELEN_get(hv) \
 298    ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvAUX(hv)->xhv_name_count != -1) \
 299                                  ? HEK_LEN(HvENAME_HEK_NN(hv)) : 0)
 300 #define HvENAMEUTF8(hv) \
 301    ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvAUX(hv)->xhv_name_count != -1) \
 302                                  ? HEK_UTF8(HvENAME_HEK_NN(hv)) : 0)
 303
 304 /* the number of keys (including any placeholders) */
 305 #define XHvTOTALKEYS(xhv)       ((xhv)->xhv_keys)
 306
 307 /*
 308  * HvKEYS gets the number of keys that actually exist(), and is provided
 309  * for backwards compatibility with old XS code. The core uses HvUSEDKEYS
 310  * (keys, excluding placeholders) and HvTOTALKEYS (including placeholders)
 311  */
 312 #define HvKEYS(hv)              HvUSEDKEYS(hv)
 313 #define HvUSEDKEYS(hv)          (HvTOTALKEYS(hv) - HvPLACEHOLDERS_get(hv))
 314 #define HvTOTALKEYS(hv)         XHvTOTALKEYS((XPVHV*)  SvANY(hv))
 315 #define HvPLACEHOLDERS(hv)      (*Perl_hv_placeholders_p(aTHX_ MUTABLE_HV(hv)))
 316 #define HvPLACEHOLDERS_get(hv)  (SvMAGIC(hv) ? Perl_hv_placeholders_get(aTHX_ (const HV *)hv) : 0)
 317 #define HvPLACEHOLDERS_set(hv,p)        Perl_hv_placeholders_set(aTHX_ MUTABLE_HV(hv), p)
 318
 319 #define HvSHAREKEYS(hv)         (SvFLAGS(hv) & SVphv_SHAREKEYS)
 320 #define HvSHAREKEYS_on(hv)      (SvFLAGS(hv) |= SVphv_SHAREKEYS)
 321 #define HvSHAREKEYS_off(hv)     (SvFLAGS(hv) &= ~SVphv_SHAREKEYS)
 322
 323 /* This is an optimisation flag. It won't be set if all hash keys have a 0
 324  * flag. Currently the only flags relate to utf8.
 325  * Hence it won't be set if all keys are 8 bit only. It will be set if any key
 326  * is utf8 (including 8 bit keys that were entered as utf8, and need upgrading
 327  * when retrieved during iteration. It may still be set when there are no longer
 328  * any utf8 keys.
 329  * See HVhek_ENABLEHVKFLAGS for the trigger.
 330  */
 331 #define HvHASKFLAGS(hv)         (SvFLAGS(hv) & SVphv_HASKFLAGS)
 332 #define HvHASKFLAGS_on(hv)      (SvFLAGS(hv) |= SVphv_HASKFLAGS)
 333 #define HvHASKFLAGS_off(hv)     (SvFLAGS(hv) &= ~SVphv_HASKFLAGS)
 334
 335 #define HvLAZYDEL(hv)           (SvFLAGS(hv) & SVphv_LAZYDEL)
 336 #define HvLAZYDEL_on(hv)        (SvFLAGS(hv) |= SVphv_LAZYDEL)
 337 #define HvLAZYDEL_off(hv)       (SvFLAGS(hv) &= ~SVphv_LAZYDEL)
 338
 339 #ifndef PERL_CORE
 340 #  define Nullhe Null(HE*)
 341 #endif
 342 #define HeNEXT(he)              (he)->hent_next
 343 #define HeKEY_hek(he)           (he)->hent_hek
 344 #define HeKEY(he)               HEK_KEY(HeKEY_hek(he))
 345 #define HeKEY_sv(he)            (*(SV**)HeKEY(he))
 346 #define HeKLEN(he)              HEK_LEN(HeKEY_hek(he))
 347 #define HeKUTF8(he)  HEK_UTF8(HeKEY_hek(he))
 348 #define HeKWASUTF8(he)  HEK_WASUTF8(HeKEY_hek(he))
 349 #define HeKLEN_UTF8(he)  (HeKUTF8(he) ? -HeKLEN(he) : HeKLEN(he))
 350 #define HeKFLAGS(he)  HEK_FLAGS(HeKEY_hek(he))
 351 #define HeVAL(he)               (he)->he_valu.hent_val
 352 #define HeHASH(he)              HEK_HASH(HeKEY_hek(he))
 353 #define HePV(he,lp)             ((HeKLEN(he) == HEf_SVKEY) ?            \
 354                                  SvPV(HeKEY_sv(he),lp) :                \
 355                                  ((lp = HeKLEN(he)), HeKEY(he)))
 356 #define HeUTF8(he)              ((HeKLEN(he) == HEf_SVKEY) ?            \
 357                                  SvUTF8(HeKEY_sv(he)) :                 \
 358                                  (U32)HeKUTF8(he))
 359
 360 #define HeSVKEY(he)             ((HeKEY(he) &&                          \
 361                                   HeKLEN(he) == HEf_SVKEY) ?            \
 362                                  HeKEY_sv(he) : NULL)
 363
 364 #define HeSVKEY_force(he)       (HeKEY(he) ?                            \
 365                                  ((HeKLEN(he) == HEf_SVKEY) ?           \
 366                                   HeKEY_sv(he) :                        \
 367                                   newSVpvn_flags(HeKEY(he),             \
 368                                                  HeKLEN(he), SVs_TEMP)) : \
 369                                  &PL_sv_undef)
 370 #define HeSVKEY_set(he,sv)      ((HeKLEN(he) = HEf_SVKEY), (HeKEY_sv(he) = sv))
 371
 372 #ifndef PERL_CORE
 373 #  define Nullhek Null(HEK*)
 374 #endif
 375 #define HEK_BASESIZE            STRUCT_OFFSET(HEK, hek_key[0])
 376 #define HEK_HASH(hek)           (hek)->hek_hash
 377 #define HEK_LEN(hek)            (hek)->hek_len
 378 #define HEK_KEY(hek)            (hek)->hek_key
 379 #define HEK_FLAGS(hek)  (*((unsigned char *)(HEK_KEY(hek))+HEK_LEN(hek)+1))
 380
 381 #define HVhek_UTF8      0x01 /* Key is utf8 encoded. */
 382 #define HVhek_WASUTF8   0x02 /* Key is bytes here, but was supplied as utf8. */
 383 #define HVhek_UNSHARED  0x08 /* This key isn't a shared hash key. */
 384 #define HVhek_FREEKEY   0x100 /* Internal flag to say key is malloc()ed.  */
 385 #define HVhek_PLACEHOLD 0x200 /* Internal flag to create placeholder.
 386                                * (may change, but Storable is a core module) */
 387 #define HVhek_KEYCANONICAL 0x400 /* Internal flag - key is in canonical form.
 388                                     If the string is UTF-8, it cannot be
 389                                     converted to bytes. */
 390 #define HVhek_MASK      0xFF
 391
 392 #define HVhek_ENABLEHVKFLAGS        (HVhek_MASK & ~(HVhek_UNSHARED))
 393
 394 #define HEK_UTF8(hek)           (HEK_FLAGS(hek) & HVhek_UTF8)
 395 #define HEK_UTF8_on(hek)        (HEK_FLAGS(hek) |= HVhek_UTF8)
 396 #define HEK_UTF8_off(hek)       (HEK_FLAGS(hek) &= ~HVhek_UTF8)
 397 #define HEK_WASUTF8(hek)        (HEK_FLAGS(hek) & HVhek_WASUTF8)
 398 #define HEK_WASUTF8_on(hek)     (HEK_FLAGS(hek) |= HVhek_WASUTF8)
 399 #define HEK_WASUTF8_off(hek)    (HEK_FLAGS(hek) &= ~HVhek_WASUTF8)
 400
 401 /* calculate HV array allocation */
 402 #ifndef PERL_USE_LARGE_HV_ALLOC
 403 /* Default to allocating the correct size - default to assuming that malloc()
 404    is not broken and is efficient at allocating blocks sized at powers-of-two.
 405 */
 406 #  define PERL_HV_ARRAY_ALLOC_BYTES(size) ((size) * sizeof(HE*))
 407 #else
 408 #  define MALLOC_OVERHEAD 16
 409 #  define PERL_HV_ARRAY_ALLOC_BYTES(size) \
 410                         (((size) < 64)                                  \
 411                          ? (size) * sizeof(HE*)                         \
 412                          : (size) * sizeof(HE*) * 2 - MALLOC_OVERHEAD)
 413 #endif
 414
 415 /* Flags for hv_iternext_flags.  */
 416 #define HV_ITERNEXT_WANTPLACEHOLDERS    0x01    /* Don't skip placeholders.  */
 417
 418 #define hv_iternext(hv) hv_iternext_flags(hv, 0)
 419 #define hv_magic(hv, gv, how) sv_magic(MUTABLE_SV(hv), MUTABLE_SV(gv), how, NULL, 0)
 420 #define hv_undef(hv) Perl_hv_undef_flags(aTHX_ hv, 0)
 421
 422 #define Perl_sharepvn(pv, len, hash) HEK_KEY(share_hek(pv, len, hash))
 423 #define sharepvn(pv, len, hash)      Perl_sharepvn(pv, len, hash)
 424
 425 #define share_hek_hek(hek)                                              \
 426     (++(((struct shared_he *)(((char *)hek)                             \
 427                               - STRUCT_OFFSET(struct shared_he,         \
 428                                               shared_he_hek)))          \
 429         ->shared_he_he.he_valu.hent_refcount),                          \
 430      hek)
 431
 432 #define hv_store_ent(hv, keysv, val, hash)                              \
 433     ((HE *) hv_common((hv), (keysv), NULL, 0, 0, HV_FETCH_ISSTORE,      \
 434                       (val), (hash)))
 435
 436 #define hv_exists_ent(hv, keysv, hash)                                  \
 437     (hv_common((hv), (keysv), NULL, 0, 0, HV_FETCH_ISEXISTS, 0, (hash)) \
 438      ? TRUE : FALSE)
 439 #define hv_fetch_ent(hv, keysv, lval, hash)                             \
 440     ((HE *) hv_common((hv), (keysv), NULL, 0, 0,                        \
 441                       ((lval) ? HV_FETCH_LVALUE : 0), NULL, (hash)))
 442 #define hv_delete_ent(hv, key, flags, hash)                             \
 443     (MUTABLE_SV(hv_common((hv), (key), NULL, 0, 0, (flags) | HV_DELETE, \
 444                           NULL, (hash))))
 445
 446 #define hv_store_flags(hv, key, klen, val, hash, flags)                 \
 447     ((SV**) hv_common((hv), NULL, (key), (klen), (flags),               \
 448                       (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV), (val),       \
 449                       (hash)))
 450
 451 #define hv_store(hv, key, klen, val, hash)                              \
 452     ((SV**) hv_common_key_len((hv), (key), (klen),                      \
 453                               (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV),      \
 454                               (val), (hash)))
 455
 456 #define hv_exists(hv, key, klen)                                        \
 457     (hv_common_key_len((hv), (key), (klen), HV_FETCH_ISEXISTS, NULL, 0) \
 458      ? TRUE : FALSE)
 459
 460 #define hv_fetch(hv, key, klen, lval)                                   \
 461     ((SV**) hv_common_key_len((hv), (key), (klen), (lval)               \
 462                               ? (HV_FETCH_JUST_SV | HV_FETCH_LVALUE)    \
 463                               : HV_FETCH_JUST_SV, NULL, 0))
 464
 465 #define hv_delete(hv, key, klen, flags)                                 \
 466     (MUTABLE_SV(hv_common_key_len((hv), (key), (klen),                  \
 467                                   (flags) | HV_DELETE, NULL, 0)))
 468
 469 /* This refcounted he structure is used for storing the hints used for lexical
 470    pragmas. Without threads, it's basically struct he + refcount.
 471    With threads, life gets more complex as the structure needs to be shared
 472    between threads (because it hangs from OPs, which are shared), hence the
 473    alternate definition and mutex.  */
 474
 475 struct refcounted_he;
 476
 477 /* flags for the refcounted_he API */
 478 #define REFCOUNTED_HE_KEY_UTF8          0x00000001
 479 #ifdef PERL_CORE
 480 # define REFCOUNTED_HE_EXISTS           0x00000002
 481 #endif
 482
 483 #ifdef PERL_CORE
 484
 485 /* Gosh. This really isn't a good name any longer.  */
 486 struct refcounted_he {
 487     struct refcounted_he *refcounted_he_next;   /* next entry in chain */
 488 #ifdef USE_ITHREADS
 489     U32                   refcounted_he_hash;
 490     U32                   refcounted_he_keylen;
 491 #else
 492     HEK                  *refcounted_he_hek;    /* hint key */
 493 #endif
 494     union {
 495         IV                refcounted_he_u_iv;
 496         UV                refcounted_he_u_uv;
 497         STRLEN            refcounted_he_u_len;
 498         void             *refcounted_he_u_ptr;  /* Might be useful in future */
 499     } refcounted_he_val;
 500     U32                   refcounted_he_refcnt; /* reference count */
 501     /* First byte is flags. Then NUL-terminated value. Then for ithreads,
 502        non-NUL terminated key.  */
 503     char                  refcounted_he_data[1];
 504 };
 505
 506 /*
 507 =for apidoc m|SV *|refcounted_he_fetch_pvs|const struct refcounted_he *chain|const char *key|U32 flags
 508
 509 Like L</refcounted_he_fetch_pvn>, but takes a literal string instead of
 510 a string/length pair, and no precomputed hash.
 511
 512 =cut
 513 */
 514
 515 #define refcounted_he_fetch_pvs(chain, key, flags) \
 516     Perl_refcounted_he_fetch_pvn(aTHX_ chain, STR_WITH_LEN(key), 0, flags)
 517
 518 /*
 519 =for apidoc m|struct refcounted_he *|refcounted_he_new_pvs|struct refcounted_he *parent|const char *key|SV *value|U32 flags
 520
 521 Like L</refcounted_he_new_pvn>, but takes a literal string instead of
 522 a string/length pair, and no precomputed hash.
 523
 524 =cut
 525 */
 526
 527 #define refcounted_he_new_pvs(parent, key, value, flags) \
 528     Perl_refcounted_he_new_pvn(aTHX_ parent, STR_WITH_LEN(key), 0, value, flags)
 529
 530 /* Flag bits are HVhek_UTF8, HVhek_WASUTF8, then */
 531 #define HVrhek_undef    0x00 /* Value is undef. */
 532 #define HVrhek_delete   0x10 /* Value is placeholder - signifies delete. */
 533 #define HVrhek_IV       0x20 /* Value is IV. */
 534 #define HVrhek_UV       0x30 /* Value is UV. */
 535 #define HVrhek_PV       0x40 /* Value is a (byte) string. */
 536 #define HVrhek_PV_UTF8  0x50 /* Value is a (utf8) string. */
 537 /* Two spare. As these have to live in the optree, you can't store anything
 538    interpreter specific, such as SVs. :-( */
 539 #define HVrhek_typemask 0x70
 540
 541 #ifdef USE_ITHREADS
 542 /* A big expression to find the key offset */
 543 #define REF_HE_KEY(chain)                                               \
 544         ((((chain->refcounted_he_data[0] & 0x60) == 0x40)               \
 545             ? chain->refcounted_he_val.refcounted_he_u_len + 1 : 0)     \
 546          + 1 + chain->refcounted_he_data)
 547 #endif
 548
 549 #  ifdef USE_ITHREADS
 550 #    define HINTS_REFCNT_LOCK           MUTEX_LOCK(&PL_hints_mutex)
 551 #    define HINTS_REFCNT_UNLOCK         MUTEX_UNLOCK(&PL_hints_mutex)
 552 #  else
 553 #    define HINTS_REFCNT_LOCK           NOOP
 554 #    define HINTS_REFCNT_UNLOCK         NOOP
 555 #  endif
 556 #endif
 557
 558 #ifdef USE_ITHREADS
 559 #  define HINTS_REFCNT_INIT             MUTEX_INIT(&PL_hints_mutex)
 560 #  define HINTS_REFCNT_TERM             MUTEX_DESTROY(&PL_hints_mutex)
 561 #else
 562 #  define HINTS_REFCNT_INIT             NOOP
 563 #  define HINTS_REFCNT_TERM             NOOP
 564 #endif
 565
 566 /* Hash actions
 567  * Passed in PERL_MAGIC_uvar calls
 568  */
 569 #define HV_DISABLE_UVAR_XKEY    0x01
 570 /* We need to ensure that these don't clash with G_DISCARD, which is 2, as it
 571    is documented as being passed to hv_delete().  */
 572 #define HV_FETCH_ISSTORE        0x04
 573 #define HV_FETCH_ISEXISTS       0x08
 574 #define HV_FETCH_LVALUE         0x10
 575 #define HV_FETCH_JUST_SV        0x20
 576 #define HV_DELETE               0x40
 577 #define HV_FETCH_EMPTY_HE       0x80 /* Leave HeVAL null. */
 578
 579 /* Must not conflict with HVhek_UTF8 */
 580 #define HV_NAME_SETALL          0x02
 581
 582 /*
 583 =for apidoc newHV
 584
 585 Creates a new HV.  The reference count is set to 1.
 586
 587 =cut
 588 */
 589
 590 #define newHV() MUTABLE_HV(newSV_type(SVt_PVHV))
 591
 592 #include "hv_func.h"
 593
 594 /*
 595  * Local variables:
 596  * c-indentation-style: bsd
 597  * c-basic-offset: 4
 598  * indent-tabs-mode: nil
 599  * End:
 600  *
 601  * ex: set ts=8 sts=4 sw=4 et:
 602  */