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