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