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