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