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