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