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