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