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