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