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