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