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