270ae00157949e202cf35d78f4bf32d90f3a4457
[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 union _xhvnameu {
76     HEK *xhvnameu_name;         /* When xhv_name_count is 0 */
77     HEK **xhvnameu_names;       /* When xhv_name_count is non-0 */
78 };
79
80 struct xpvhv_aux {
81     union _xhvnameu xhv_name_u; /* name, if a symbol table */
82     AV          *xhv_backreferences; /* back references for weak references */
83     HE          *xhv_eiter;     /* current entry of iterator */
84     I32         xhv_riter;      /* current root of iterator */
85
86 /* Concerning xhv_name_count: When non-zero, xhv_name_u contains a pointer 
87  * to an array of HEK pointers, this being the length. The first element is
88  * the name of the stash, which may be NULL. If xhv_name_count is positive,
89  * then *xhv_name is one of the effective names. If xhv_name_count is nega-
90  * tive, then xhv_name_u.xhvnameu_names[1] is the first effective name.
91  */
92     I32         xhv_name_count;
93     struct mro_meta *xhv_mro_meta;
94     HV *        xhv_super;      /* SUPER method cache */
95     U32         xhv_rand;       /* random value for hash traversal */
96     U32         xhv_last_rand;  /* last random value for hash traversal,
97                                    used to detect each() after insert for warnings */
98 };
99
100 /* hash structure: */
101 /* This structure must match the beginning of struct xpvmg in sv.h. */
102 struct xpvhv {
103     HV*         xmg_stash;      /* class package */
104     union _xmgu xmg_u;
105     STRLEN      xhv_keys;       /* total keys, including placeholders */
106     STRLEN      xhv_max;        /* subscript of last element of xhv_array */
107 };
108
109 /*
110 =head1 Hash Manipulation Functions
111
112 =for apidoc AmU||HEf_SVKEY
113 This flag, used in the length slot of hash entries and magic structures,
114 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
115 is to be expected. (For information only--not to be used).
116
117 =head1 Handy Values
118
119 =for apidoc AmU||Nullhv
120 Null HV pointer.
121
122 (deprecated - use C<(HV *)NULL> instead)
123
124 =head1 Hash Manipulation Functions
125
126 =for apidoc Am|char*|HvNAME|HV* stash
127 Returns the package name of a stash, or NULL if C<stash> isn't a stash.
128 See C<SvSTASH>, C<CvSTASH>.
129
130 =for apidoc Am|STRLEN|HvNAMELEN|HV *stash
131 Returns the length of the stash's name.
132
133 =for apidoc Am|unsigned char|HvNAMEUTF8|HV *stash
134 Returns true if the name is in UTF8 encoding.
135
136 =for apidoc Am|char*|HvENAME|HV* stash
137 Returns the effective name of a stash, or NULL if there is none. The
138 effective name represents a location in the symbol table where this stash
139 resides. It is updated automatically when packages are aliased or deleted.
140 A stash that is no longer in the symbol table has no effective name. This
141 name is preferable to C<HvNAME> for use in MRO linearisations and isa
142 caches.
143
144 =for apidoc Am|STRLEN|HvENAMELEN|HV *stash
145 Returns the length of the stash's effective name.
146
147 =for apidoc Am|unsigned char|HvENAMEUTF8|HV *stash
148 Returns true if the effective name is in UTF8 encoding.
149
150 =for apidoc Am|void*|HeKEY|HE* he
151 Returns the actual pointer stored in the key slot of the hash entry. The
152 pointer may be either C<char*> or C<SV*>, depending on the value of
153 C<HeKLEN()>.  Can be assigned to.  The C<HePV()> or C<HeSVKEY()> macros are
154 usually preferable for finding the value of a key.
155
156 =for apidoc Am|STRLEN|HeKLEN|HE* he
157 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
158 holds an C<SV*> key.  Otherwise, holds the actual length of the key.  Can
159 be assigned to. The C<HePV()> macro is usually preferable for finding key
160 lengths.
161
162 =for apidoc Am|SV*|HeVAL|HE* he
163 Returns the value slot (type C<SV*>) stored in the hash entry. Can be assigned
164 to.
165
166   SV *foo= HeVAL(hv);
167   HeVAL(hv)= sv;
168
169
170 =for apidoc Am|U32|HeHASH|HE* he
171 Returns the computed hash stored in the hash entry.
172
173 =for apidoc Am|char*|HePV|HE* he|STRLEN len
174 Returns the key slot of the hash entry as a C<char*> value, doing any
175 necessary dereferencing of possibly C<SV*> keys.  The length of the string
176 is placed in C<len> (this is a macro, so do I<not> use C<&len>).  If you do
177 not care about what the length of the key is, you may use the global
178 variable C<PL_na>, though this is rather less efficient than using a local
179 variable.  Remember though, that hash keys in perl are free to contain
180 embedded nulls, so using C<strlen()> or similar is not a good way to find
181 the length of hash keys. This is very similar to the C<SvPV()> macro
182 described elsewhere in this document. See also C<HeUTF8>.
183
184 If you are using C<HePV> to get values to pass to C<newSVpvn()> to create a
185 new SV, you should consider using C<newSVhek(HeKEY_hek(he))> as it is more
186 efficient.
187
188 =for apidoc Am|char*|HeUTF8|HE* he
189 Returns whether the C<char *> value returned by C<HePV> is encoded in UTF-8,
190 doing any necessary dereferencing of possibly C<SV*> keys.  The value returned
191 will be 0 or non-0, not necessarily 1 (or even a value with any low bits set),
192 so B<do not> blindly assign this to a C<bool> variable, as C<bool> may be a
193 typedef for C<char>.
194
195 =for apidoc Am|SV*|HeSVKEY|HE* he
196 Returns the key as an C<SV*>, or C<NULL> if the hash entry does not
197 contain an C<SV*> key.
198
199 =for apidoc Am|SV*|HeSVKEY_force|HE* he
200 Returns the key as an C<SV*>.  Will create and return a temporary mortal
201 C<SV*> if the hash entry contains only a C<char*> key.
202
203 =for apidoc Am|SV*|HeSVKEY_set|HE* he|SV* sv
204 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
205 indicate the presence of an C<SV*> key, and returns the same
206 C<SV*>.
207
208 =cut
209 */
210
211 #define PERL_HASH_DEFAULT_HvMAX 7
212
213 /* these hash entry flags ride on hent_klen (for use only in magic/tied HVs) */
214 #define HEf_SVKEY       -2      /* hent_key is an SV* */
215
216 #ifndef PERL_CORE
217 #  define Nullhv Null(HV*)
218 #endif
219 #define HvARRAY(hv)     ((hv)->sv_u.svu_hash)
220 #define HvFILL(hv)      Perl_hv_fill(aTHX_ (const HV *)(hv))
221 #define HvMAX(hv)       ((XPVHV*)  SvANY(hv))->xhv_max
222 /* This quite intentionally does no flag checking first. That's your
223    responsibility.  */
224 #define HvAUX(hv)       ((struct xpvhv_aux*)&(HvARRAY(hv)[HvMAX(hv)+1]))
225 #define HvRITER(hv)     (*Perl_hv_riter_p(aTHX_ MUTABLE_HV(hv)))
226 #define HvEITER(hv)     (*Perl_hv_eiter_p(aTHX_ MUTABLE_HV(hv)))
227 #define HvRITER_set(hv,r)       Perl_hv_riter_set(aTHX_ MUTABLE_HV(hv), r)
228 #define HvEITER_set(hv,e)       Perl_hv_eiter_set(aTHX_ MUTABLE_HV(hv), e)
229 #define HvRITER_get(hv) (SvOOK(hv) ? HvAUX(hv)->xhv_riter : -1)
230 #define HvEITER_get(hv) (SvOOK(hv) ? HvAUX(hv)->xhv_eiter : NULL)
231 #define HvRAND_get(hv)  (SvOOK(hv) ? HvAUX(hv)->xhv_rand : 0)
232 #define HvLASTRAND_get(hv)      (SvOOK(hv) ? HvAUX(hv)->xhv_last_rand : 0)
233
234 #define HvNAME(hv)      HvNAME_get(hv)
235 #define HvNAMELEN(hv)   HvNAMELEN_get(hv)
236 #define HvENAME(hv)     HvENAME_get(hv)
237 #define HvENAMELEN(hv)  HvENAMELEN_get(hv)
238
239 /* Checking that hv is a valid package stash is the
240    caller's responsibility */
241 #define HvMROMETA(hv) (HvAUX(hv)->xhv_mro_meta \
242                        ? HvAUX(hv)->xhv_mro_meta \
243                        : Perl_mro_meta_init(aTHX_ hv))
244
245 #define HvNAME_HEK_NN(hv)                         \
246  (                                                \
247   HvAUX(hv)->xhv_name_count                       \
248   ? *HvAUX(hv)->xhv_name_u.xhvnameu_names         \
249   : HvAUX(hv)->xhv_name_u.xhvnameu_name           \
250  )
251 /* This macro may go away without notice.  */
252 #define HvNAME_HEK(hv) \
253         (SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name ? HvNAME_HEK_NN(hv) : NULL)
254 #define HvNAME_get(hv) \
255         ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvNAME_HEK_NN(hv)) \
256                          ? HEK_KEY(HvNAME_HEK_NN(hv)) : NULL)
257 #define HvNAMELEN_get(hv) \
258         ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvNAME_HEK_NN(hv)) \
259                                  ? HEK_LEN(HvNAME_HEK_NN(hv)) : 0)
260 #define HvNAMEUTF8(hv) \
261         ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvNAME_HEK_NN(hv)) \
262                                  ? HEK_UTF8(HvNAME_HEK_NN(hv)) : 0)
263 #define HvENAME_HEK_NN(hv)                                             \
264  (                                                                      \
265   HvAUX(hv)->xhv_name_count > 0   ? HvAUX(hv)->xhv_name_u.xhvnameu_names[0] : \
266   HvAUX(hv)->xhv_name_count < -1  ? HvAUX(hv)->xhv_name_u.xhvnameu_names[1] : \
267   HvAUX(hv)->xhv_name_count == -1 ? NULL                              : \
268                                     HvAUX(hv)->xhv_name_u.xhvnameu_name \
269  )
270 #define HvENAME_HEK(hv) \
271         (SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name ? HvENAME_HEK_NN(hv) : NULL)
272 #define HvENAME_get(hv) \
273    ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvAUX(hv)->xhv_name_count != -1) \
274                          ? HEK_KEY(HvENAME_HEK_NN(hv)) : NULL)
275 #define HvENAMELEN_get(hv) \
276    ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvAUX(hv)->xhv_name_count != -1) \
277                                  ? HEK_LEN(HvENAME_HEK_NN(hv)) : 0)
278 #define HvENAMEUTF8(hv) \
279    ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvAUX(hv)->xhv_name_count != -1) \
280                                  ? HEK_UTF8(HvENAME_HEK_NN(hv)) : 0)
281
282 /* the number of keys (including any placeholders) */
283 #define XHvTOTALKEYS(xhv)       ((xhv)->xhv_keys)
284
285 /*
286  * HvKEYS gets the number of keys that actually exist(), and is provided
287  * for backwards compatibility with old XS code. The core uses HvUSEDKEYS
288  * (keys, excluding placeholders) and HvTOTALKEYS (including placeholders)
289  */
290 #define HvKEYS(hv)              HvUSEDKEYS(hv)
291 #define HvUSEDKEYS(hv)          (HvTOTALKEYS(hv) - HvPLACEHOLDERS_get(hv))
292 #define HvTOTALKEYS(hv)         XHvTOTALKEYS((XPVHV*)  SvANY(hv))
293 #define HvPLACEHOLDERS(hv)      (*Perl_hv_placeholders_p(aTHX_ MUTABLE_HV(hv)))
294 #define HvPLACEHOLDERS_get(hv)  (SvMAGIC(hv) ? Perl_hv_placeholders_get(aTHX_ (const HV *)hv) : 0)
295 #define HvPLACEHOLDERS_set(hv,p)        Perl_hv_placeholders_set(aTHX_ MUTABLE_HV(hv), p)
296
297 #define HvSHAREKEYS(hv)         (SvFLAGS(hv) & SVphv_SHAREKEYS)
298 #define HvSHAREKEYS_on(hv)      (SvFLAGS(hv) |= SVphv_SHAREKEYS)
299 #define HvSHAREKEYS_off(hv)     (SvFLAGS(hv) &= ~SVphv_SHAREKEYS)
300
301 /* This is an optimisation flag. It won't be set if all hash keys have a 0
302  * flag. Currently the only flags relate to utf8.
303  * Hence it won't be set if all keys are 8 bit only. It will be set if any key
304  * is utf8 (including 8 bit keys that were entered as utf8, and need upgrading
305  * when retrieved during iteration. It may still be set when there are no longer
306  * any utf8 keys.
307  * See HVhek_ENABLEHVKFLAGS for the trigger.
308  */
309 #define HvHASKFLAGS(hv)         (SvFLAGS(hv) & SVphv_HASKFLAGS)
310 #define HvHASKFLAGS_on(hv)      (SvFLAGS(hv) |= SVphv_HASKFLAGS)
311 #define HvHASKFLAGS_off(hv)     (SvFLAGS(hv) &= ~SVphv_HASKFLAGS)
312
313 #define HvLAZYDEL(hv)           (SvFLAGS(hv) & SVphv_LAZYDEL)
314 #define HvLAZYDEL_on(hv)        (SvFLAGS(hv) |= SVphv_LAZYDEL)
315 #define HvLAZYDEL_off(hv)       (SvFLAGS(hv) &= ~SVphv_LAZYDEL)
316
317 #ifndef PERL_CORE
318 #  define Nullhe Null(HE*)
319 #endif
320 #define HeNEXT(he)              (he)->hent_next
321 #define HeKEY_hek(he)           (he)->hent_hek
322 #define HeKEY(he)               HEK_KEY(HeKEY_hek(he))
323 #define HeKEY_sv(he)            (*(SV**)HeKEY(he))
324 #define HeKLEN(he)              HEK_LEN(HeKEY_hek(he))
325 #define HeKUTF8(he)  HEK_UTF8(HeKEY_hek(he))
326 #define HeKWASUTF8(he)  HEK_WASUTF8(HeKEY_hek(he))
327 #define HeKLEN_UTF8(he)  (HeKUTF8(he) ? -HeKLEN(he) : HeKLEN(he))
328 #define HeKFLAGS(he)  HEK_FLAGS(HeKEY_hek(he))
329 #define HeVAL(he)               (he)->he_valu.hent_val
330 #define HeHASH(he)              HEK_HASH(HeKEY_hek(he))
331 #define HePV(he,lp)             ((HeKLEN(he) == HEf_SVKEY) ?            \
332                                  SvPV(HeKEY_sv(he),lp) :                \
333                                  ((lp = HeKLEN(he)), HeKEY(he)))
334 #define HeUTF8(he)              ((HeKLEN(he) == HEf_SVKEY) ?            \
335                                  SvUTF8(HeKEY_sv(he)) :                 \
336                                  (U32)HeKUTF8(he))
337
338 #define HeSVKEY(he)             ((HeKEY(he) &&                          \
339                                   HeKLEN(he) == HEf_SVKEY) ?            \
340                                  HeKEY_sv(he) : NULL)
341
342 #define HeSVKEY_force(he)       (HeKEY(he) ?                            \
343                                  ((HeKLEN(he) == HEf_SVKEY) ?           \
344                                   HeKEY_sv(he) :                        \
345                                   newSVpvn_flags(HeKEY(he),             \
346                                                  HeKLEN(he), SVs_TEMP)) : \
347                                  &PL_sv_undef)
348 #define HeSVKEY_set(he,sv)      ((HeKLEN(he) = HEf_SVKEY), (HeKEY_sv(he) = sv))
349
350 #ifndef PERL_CORE
351 #  define Nullhek Null(HEK*)
352 #endif
353 #define HEK_BASESIZE            STRUCT_OFFSET(HEK, hek_key[0])
354 #define HEK_HASH(hek)           (hek)->hek_hash
355 #define HEK_LEN(hek)            (hek)->hek_len
356 #define HEK_KEY(hek)            (hek)->hek_key
357 #define HEK_FLAGS(hek)  (*((unsigned char *)(HEK_KEY(hek))+HEK_LEN(hek)+1))
358
359 #define HVhek_UTF8      0x01 /* Key is utf8 encoded. */
360 #define HVhek_WASUTF8   0x02 /* Key is bytes here, but was supplied as utf8. */
361 #define HVhek_UNSHARED  0x08 /* This key isn't a shared hash key. */
362 #define HVhek_FREEKEY   0x100 /* Internal flag to say key is malloc()ed.  */
363 #define HVhek_PLACEHOLD 0x200 /* Internal flag to create placeholder.
364                                * (may change, but Storable is a core module) */
365 #define HVhek_KEYCANONICAL 0x400 /* Internal flag - key is in canonical form.
366                                     If the string is UTF-8, it cannot be
367                                     converted to bytes. */
368 #define HVhek_MASK      0xFF
369
370 #define HVhek_ENABLEHVKFLAGS        (HVhek_MASK & ~(HVhek_UNSHARED))
371
372 #define HEK_UTF8(hek)           (HEK_FLAGS(hek) & HVhek_UTF8)
373 #define HEK_UTF8_on(hek)        (HEK_FLAGS(hek) |= HVhek_UTF8)
374 #define HEK_UTF8_off(hek)       (HEK_FLAGS(hek) &= ~HVhek_UTF8)
375 #define HEK_WASUTF8(hek)        (HEK_FLAGS(hek) & HVhek_WASUTF8)
376 #define HEK_WASUTF8_on(hek)     (HEK_FLAGS(hek) |= HVhek_WASUTF8)
377 #define HEK_WASUTF8_off(hek)    (HEK_FLAGS(hek) &= ~HVhek_WASUTF8)
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 #define hv_undef(hv) Perl_hv_undef_flags(aTHX_ hv, 0)
399
400 #define Perl_sharepvn(pv, len, hash) HEK_KEY(share_hek(pv, len, hash))
401 #define sharepvn(pv, len, hash)      Perl_sharepvn(pv, 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 struct refcounted_he;
454
455 /* flags for the refcounted_he API */
456 #define REFCOUNTED_HE_KEY_UTF8          0x00000001
457 #ifdef PERL_CORE
458 # define REFCOUNTED_HE_EXISTS           0x00000002
459 #endif
460
461 #ifdef PERL_CORE
462
463 /* Gosh. This really isn't a good name any longer.  */
464 struct refcounted_he {
465     struct refcounted_he *refcounted_he_next;   /* next entry in chain */
466 #ifdef USE_ITHREADS
467     U32                   refcounted_he_hash;
468     U32                   refcounted_he_keylen;
469 #else
470     HEK                  *refcounted_he_hek;    /* hint key */
471 #endif
472     union {
473         IV                refcounted_he_u_iv;
474         UV                refcounted_he_u_uv;
475         STRLEN            refcounted_he_u_len;
476         void             *refcounted_he_u_ptr;  /* Might be useful in future */
477     } refcounted_he_val;
478     U32                   refcounted_he_refcnt; /* reference count */
479     /* First byte is flags. Then NUL-terminated value. Then for ithreads,
480        non-NUL terminated key.  */
481     char                  refcounted_he_data[1];
482 };
483
484 /*
485 =for apidoc m|SV *|refcounted_he_fetch_pvs|const struct refcounted_he *chain|const char *key|U32 flags
486
487 Like L</refcounted_he_fetch_pvn>, but takes a literal string instead of
488 a string/length pair, and no precomputed hash.
489
490 =cut
491 */
492
493 #define refcounted_he_fetch_pvs(chain, key, flags) \
494     Perl_refcounted_he_fetch_pvn(aTHX_ chain, STR_WITH_LEN(key), 0, flags)
495
496 /*
497 =for apidoc m|struct refcounted_he *|refcounted_he_new_pvs|struct refcounted_he *parent|const char *key|SV *value|U32 flags
498
499 Like L</refcounted_he_new_pvn>, but takes a literal string instead of
500 a string/length pair, and no precomputed hash.
501
502 =cut
503 */
504
505 #define refcounted_he_new_pvs(parent, key, value, flags) \
506     Perl_refcounted_he_new_pvn(aTHX_ parent, STR_WITH_LEN(key), 0, value, flags)
507
508 /* Flag bits are HVhek_UTF8, HVhek_WASUTF8, then */
509 #define HVrhek_undef    0x00 /* Value is undef. */
510 #define HVrhek_delete   0x10 /* Value is placeholder - signifies delete. */
511 #define HVrhek_IV       0x20 /* Value is IV. */
512 #define HVrhek_UV       0x30 /* Value is UV. */
513 #define HVrhek_PV       0x40 /* Value is a (byte) string. */
514 #define HVrhek_PV_UTF8  0x50 /* Value is a (utf8) string. */
515 /* Two spare. As these have to live in the optree, you can't store anything
516    interpreter specific, such as SVs. :-( */
517 #define HVrhek_typemask 0x70
518
519 #ifdef USE_ITHREADS
520 /* A big expression to find the key offset */
521 #define REF_HE_KEY(chain)                                               \
522         ((((chain->refcounted_he_data[0] & 0x60) == 0x40)               \
523             ? chain->refcounted_he_val.refcounted_he_u_len + 1 : 0)     \
524          + 1 + chain->refcounted_he_data)
525 #endif
526
527 #  ifdef USE_ITHREADS
528 #    define HINTS_REFCNT_LOCK           MUTEX_LOCK(&PL_hints_mutex)
529 #    define HINTS_REFCNT_UNLOCK         MUTEX_UNLOCK(&PL_hints_mutex)
530 #  else
531 #    define HINTS_REFCNT_LOCK           NOOP
532 #    define HINTS_REFCNT_UNLOCK         NOOP
533 #  endif
534 #endif
535
536 #ifdef USE_ITHREADS
537 #  define HINTS_REFCNT_INIT             MUTEX_INIT(&PL_hints_mutex)
538 #  define HINTS_REFCNT_TERM             MUTEX_DESTROY(&PL_hints_mutex)
539 #else
540 #  define HINTS_REFCNT_INIT             NOOP
541 #  define HINTS_REFCNT_TERM             NOOP
542 #endif
543
544 /* Hash actions
545  * Passed in PERL_MAGIC_uvar calls
546  */
547 #define HV_DISABLE_UVAR_XKEY    0x01
548 /* We need to ensure that these don't clash with G_DISCARD, which is 2, as it
549    is documented as being passed to hv_delete().  */
550 #define HV_FETCH_ISSTORE        0x04
551 #define HV_FETCH_ISEXISTS       0x08
552 #define HV_FETCH_LVALUE         0x10
553 #define HV_FETCH_JUST_SV        0x20
554 #define HV_DELETE               0x40
555 #define HV_FETCH_EMPTY_HE       0x80 /* Leave HeVAL null. */
556
557 /* Must not conflict with HVhek_UTF8 */
558 #define HV_NAME_SETALL          0x02
559
560 /*
561 =for apidoc newHV
562
563 Creates a new HV.  The reference count is set to 1.
564
565 =cut
566 */
567
568 #define newHV() MUTABLE_HV(newSV_type(SVt_PVHV))
569
570 #include "hv_func.h"
571
572 /*
573  * Local variables:
574  * c-indentation-style: bsd
575  * c-basic-offset: 4
576  * indent-tabs-mode: nil
577  * End:
578  *
579  * ex: set ts=8 sts=4 sw=4 et:
580  */