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