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