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