This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Move all the FBM data fields from the table into a struct xbm_s which
[perl5.git] / hv.h
CommitLineData
a0d0e21e 1/* hv.h
79072805 2 *
4bb101f2 3 * Copyright (C) 1991, 1992, 1993, 1996, 1997, 1998, 1999,
1d325971 4 * 2000, 2001, 2002, 2005, 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.
41*/
42struct xpvhv_aux {
7423f6db 43 HEK *xhv_name; /* name, if a symbol table */
86f55936 44 AV *xhv_backreferences; /* back references for weak references */
bfcb3514
NC
45 HE *xhv_eiter; /* current entry of iterator */
46 I32 xhv_riter; /* current root of iterator */
47};
48
5cbe4eec 49/* hash structure: */
6ee623d5 50/* This structure must match the beginning of struct xpvmg in sv.h. */
79072805 51struct xpvhv {
58430790
NC
52 union {
53 NV xnv_nv; /* numeric value, if any */
54 HV * xgv_stash;
3441fb63
NC
55 struct {
56 U32 xlow;
57 U32 xhigh;
58 } xpad_cop_seq; /* used by pad.c for cop_sequence */
8eeaf79a
NC
59 struct {
60 U32 xbm_previous; /* how many characters in string before rare? */
61 U8 xbm_flags;
62 U8 xbm_rare; /* rarest character in string */
63 } xbm_s; /* fields from PVBM */
58430790 64 } xnv_u;
463ee0b2
LW
65 STRLEN xhv_fill; /* how full xhv_array currently is */
66 STRLEN xhv_max; /* subscript of last element of xhv_array */
e4305a63 67 union {
311a25d9
NC
68 IV xivu_iv; /* integer value or pv offset */
69 UV xivu_uv;
70 void * xivu_p1;
69ecfd12
NC
71 I32 xivu_i32;
72 HEK * xivu_namehek;
311a25d9 73 } xiv_u;
e736a858
NC
74 union {
75 MAGIC* xmg_magic; /* linked list of magicalness */
76 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
77 } xmg_u;
79072805 78 HV* xmg_stash; /* class package */
79072805
LW
79};
80
311a25d9 81#define xhv_keys xiv_u.xivu_iv
e4305a63 82
c5f87f51 83#if 0
59813432 84typedef struct xpvhv xpvhv_allocated;
9f1501b2
NC
85#else
86typedef struct {
87 STRLEN xhv_fill; /* how full xhv_array currently is */
88 STRLEN xhv_max; /* subscript of last element of xhv_array */
89 union {
311a25d9
NC
90 IV xivu_iv; /* integer value or pv offset */
91 UV xivu_uv;
92 void * xivu_p1;
69ecfd12
NC
93 I32 xivu_i32;
94 HEK * xivu_namehek;
311a25d9 95 } xiv_u;
e736a858
NC
96 union {
97 MAGIC* xmg_magic; /* linked list of magicalness */
98 HV* xmg_ourstash; /* Stash for our (when SvPAD_OUR is true) */
99 } xmg_u;
9f1501b2
NC
100 HV* xmg_stash; /* class package */
101} xpvhv_allocated;
102#endif
e4305a63 103
5cbe4eec 104/* hash a key */
5afd6d42
JH
105/* FYI: This is the "One-at-a-Time" algorithm by Bob Jenkins
106 * from requirements by Colin Plumb.
107 * (http://burtleburtle.net/bob/hash/doobs.html) */
108/* The use of a temporary pointer and the casting games
109 * is needed to serve the dual purposes of
110 * (a) the hashed data being interpreted as "unsigned char" (new since 5.8,
df805c3e 111 * a "char" can be either signed or unsigned, depending on the compiler)
5afd6d42 112 * (b) catering for old code that uses a "char"
830b38bd 113 *
504f80c1
JH
114 * The "hash seed" feature was added in Perl 5.8.1 to perturb the results
115 * to avoid "algorithmic complexity attacks".
830b38bd
JH
116 *
117 * If USE_HASH_SEED is defined, hash randomisation is done by default
118 * If USE_HASH_SEED_EXPLICIT is defined, hash randomisation is done
119 * only if the environment variable PERL_HASH_SEED is set.
120 * For maximal control, one can define PERL_HASH_SEED.
90ce55a1 121 * (see also perl.c:perl_parse()).
5afd6d42 122 */
830b38bd
JH
123#ifndef PERL_HASH_SEED
124# if defined(USE_HASH_SEED) || defined(USE_HASH_SEED_EXPLICIT)
125# define PERL_HASH_SEED PL_hash_seed
126# else
127# define PERL_HASH_SEED 0
128# endif
504f80c1 129#endif
bf6bd887
PP
130#define PERL_HASH(hash,str,len) \
131 STMT_START { \
0bd48802 132 register const char * const s_PeRlHaSh_tmp = str; \
5afd6d42 133 register const unsigned char *s_PeRlHaSh = (const unsigned char *)s_PeRlHaSh_tmp; \
bf6bd887 134 register I32 i_PeRlHaSh = len; \
504f80c1 135 register U32 hash_PeRlHaSh = PERL_HASH_SEED; \
a6fe520e
MF
136 while (i_PeRlHaSh--) { \
137 hash_PeRlHaSh += *s_PeRlHaSh++; \
138 hash_PeRlHaSh += (hash_PeRlHaSh << 10); \
139 hash_PeRlHaSh ^= (hash_PeRlHaSh >> 6); \
140 } \
141 hash_PeRlHaSh += (hash_PeRlHaSh << 3); \
142 hash_PeRlHaSh ^= (hash_PeRlHaSh >> 11); \
4fee5c71 143 (hash) = (hash_PeRlHaSh + (hash_PeRlHaSh << 15)); \
bf6bd887
PP
144 } STMT_END
145
3d78eb94
NC
146/* Only hv.c and mod_perl should be doing this. */
147#ifdef PERL_HASH_INTERNAL_ACCESS
4b5190b5
NC
148#define PERL_HASH_INTERNAL(hash,str,len) \
149 STMT_START { \
0bd48802 150 register const char * const s_PeRlHaSh_tmp = str; \
4b5190b5
NC
151 register const unsigned char *s_PeRlHaSh = (const unsigned char *)s_PeRlHaSh_tmp; \
152 register I32 i_PeRlHaSh = len; \
008fb0c0 153 register U32 hash_PeRlHaSh = PL_rehash_seed; \
4b5190b5
NC
154 while (i_PeRlHaSh--) { \
155 hash_PeRlHaSh += *s_PeRlHaSh++; \
156 hash_PeRlHaSh += (hash_PeRlHaSh << 10); \
157 hash_PeRlHaSh ^= (hash_PeRlHaSh >> 6); \
158 } \
159 hash_PeRlHaSh += (hash_PeRlHaSh << 3); \
160 hash_PeRlHaSh ^= (hash_PeRlHaSh >> 11); \
161 (hash) = (hash_PeRlHaSh + (hash_PeRlHaSh << 15)); \
162 } STMT_END
163#endif
164
954c1994 165/*
ccfc67b7
JH
166=head1 Hash Manipulation Functions
167
954c1994
GS
168=for apidoc AmU||HEf_SVKEY
169This flag, used in the length slot of hash entries and magic structures,
d1be9408 170specifies the structure contains an C<SV*> pointer where a C<char*> pointer
954c1994
GS
171is to be expected. (For information only--not to be used).
172
ccfc67b7
JH
173=head1 Handy Values
174
954c1994
GS
175=for apidoc AmU||Nullhv
176Null HV pointer.
177
ccfc67b7
JH
178=head1 Hash Manipulation Functions
179
954c1994 180=for apidoc Am|char*|HvNAME|HV* stash
9282b5fd
SH
181Returns the package name of a stash, or NULL if C<stash> isn't a stash.
182See C<SvSTASH>, C<CvSTASH>.
954c1994
GS
183
184=for apidoc Am|void*|HeKEY|HE* he
185Returns the actual pointer stored in the key slot of the hash entry. The
186pointer may be either C<char*> or C<SV*>, depending on the value of
187C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
188usually preferable for finding the value of a key.
189
190=for apidoc Am|STRLEN|HeKLEN|HE* he
191If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
192holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
193be assigned to. The C<HePV()> macro is usually preferable for finding key
194lengths.
195
196=for apidoc Am|SV*|HeVAL|HE* he
197Returns the value slot (type C<SV*>) stored in the hash entry.
198
199=for apidoc Am|U32|HeHASH|HE* he
200Returns the computed hash stored in the hash entry.
201
202=for apidoc Am|char*|HePV|HE* he|STRLEN len
203Returns the key slot of the hash entry as a C<char*> value, doing any
204necessary dereferencing of possibly C<SV*> keys. The length of the string
205is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
206not care about what the length of the key is, you may use the global
207variable C<PL_na>, though this is rather less efficient than using a local
208variable. Remember though, that hash keys in perl are free to contain
209embedded nulls, so using C<strlen()> or similar is not a good way to find
210the length of hash keys. This is very similar to the C<SvPV()> macro
211described elsewhere in this document.
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
bf5b86ae 229/* these hash entry flags ride on hent_klen (for use only in magic/tied HVs) */
d1be9408 230#define HEf_SVKEY -2 /* hent_key is an SV* */
bf6bd887
PP
231
232
79072805 233#define Nullhv Null(HV*)
43e6e717 234#define HvARRAY(hv) ((hv)->sv_u.svu_hash)
79072805 235#define HvFILL(hv) ((XPVHV*) SvANY(hv))->xhv_fill
463ee0b2 236#define HvMAX(hv) ((XPVHV*) SvANY(hv))->xhv_max
b79f7545
NC
237/* This quite intentionally does no flag checking first. That's your
238 responsibility. */
239#define HvAUX(hv) ((struct xpvhv_aux*)&(HvARRAY(hv)[HvMAX(hv)+1]))
bfcb3514
NC
240#define HvRITER(hv) (*Perl_hv_riter_p(aTHX_ (HV*)(hv)))
241#define HvEITER(hv) (*Perl_hv_eiter_p(aTHX_ (HV*)(hv)))
242#define HvRITER_set(hv,r) Perl_hv_riter_set(aTHX_ (HV*)(hv), r)
243#define HvEITER_set(hv,e) Perl_hv_eiter_set(aTHX_ (HV*)(hv), e)
b79f7545
NC
244#define HvRITER_get(hv) (SvOOK(hv) ? HvAUX(hv)->xhv_riter : -1)
245#define HvEITER_get(hv) (SvOOK(hv) ? HvAUX(hv)->xhv_eiter : 0)
7423f6db 246#define HvNAME(hv) HvNAME_get(hv)
bfcb3514
NC
247/* FIXME - all of these should use a UTF8 aware API, which should also involve
248 getting the length. */
9b9d0b15 249/* This macro may go away without notice. */
b79f7545
NC
250#define HvNAME_HEK(hv) (SvOOK(hv) ? HvAUX(hv)->xhv_name : 0)
251#define HvNAME_get(hv) ((SvOOK(hv) && (HvAUX(hv)->xhv_name)) \
252 ? HEK_KEY(HvAUX(hv)->xhv_name) : 0)
253#define HvNAMELEN_get(hv) ((SvOOK(hv) && (HvAUX(hv)->xhv_name)) \
254 ? HEK_LEN(HvAUX(hv)->xhv_name) : 0)
a0d0e21e 255
8aacddc1
NIS
256/* the number of keys (including any placeholers) */
257#define XHvTOTALKEYS(xhv) ((xhv)->xhv_keys)
258
8aacddc1
NIS
259/*
260 * HvKEYS gets the number of keys that actually exist(), and is provided
261 * for backwards compatibility with old XS code. The core uses HvUSEDKEYS
262 * (keys, excluding placeholdes) and HvTOTALKEYS (including placeholders)
263 */
ca732855
NC
264#define HvKEYS(hv) HvUSEDKEYS(hv)
265#define HvUSEDKEYS(hv) (HvTOTALKEYS(hv) - HvPLACEHOLDERS_get(hv))
8aacddc1 266#define HvTOTALKEYS(hv) XHvTOTALKEYS((XPVHV*) SvANY(hv))
ca732855
NC
267#define HvPLACEHOLDERS(hv) (*Perl_hv_placeholders_p(aTHX_ (HV*)hv))
268#define HvPLACEHOLDERS_get(hv) (SvMAGIC(hv) ? Perl_hv_placeholders_get(aTHX_ (HV*)hv) : 0)
269#define HvPLACEHOLDERS_set(hv,p) Perl_hv_placeholders_set(aTHX_ (HV*)hv, p)
8aacddc1 270
bf6bd887
PP
271#define HvSHAREKEYS(hv) (SvFLAGS(hv) & SVphv_SHAREKEYS)
272#define HvSHAREKEYS_on(hv) (SvFLAGS(hv) |= SVphv_SHAREKEYS)
273#define HvSHAREKEYS_off(hv) (SvFLAGS(hv) &= ~SVphv_SHAREKEYS)
274
19692e8d
NC
275/* This is an optimisation flag. It won't be set if all hash keys have a 0
276 * flag. Currently the only flags relate to utf8.
277 * Hence it won't be set if all keys are 8 bit only. It will be set if any key
278 * is utf8 (including 8 bit keys that were entered as utf8, and need upgrading
279 * when retrieved during iteration. It may still be set when there are no longer
280 * any utf8 keys.
fdcd69b6 281 * See HVhek_ENABLEHVKFLAGS for the trigger.
19692e8d
NC
282 */
283#define HvHASKFLAGS(hv) (SvFLAGS(hv) & SVphv_HASKFLAGS)
284#define HvHASKFLAGS_on(hv) (SvFLAGS(hv) |= SVphv_HASKFLAGS)
285#define HvHASKFLAGS_off(hv) (SvFLAGS(hv) &= ~SVphv_HASKFLAGS)
574c8022 286
bf5b86ae
GS
287#define HvLAZYDEL(hv) (SvFLAGS(hv) & SVphv_LAZYDEL)
288#define HvLAZYDEL_on(hv) (SvFLAGS(hv) |= SVphv_LAZYDEL)
289#define HvLAZYDEL_off(hv) (SvFLAGS(hv) &= ~SVphv_LAZYDEL)
290
4b5190b5
NC
291#define HvREHASH(hv) (SvFLAGS(hv) & SVphv_REHASH)
292#define HvREHASH_on(hv) (SvFLAGS(hv) |= SVphv_REHASH)
293#define HvREHASH_off(hv) (SvFLAGS(hv) &= ~SVphv_REHASH)
294
bf6bd887
PP
295#define Nullhe Null(HE*)
296#define HeNEXT(he) (he)->hent_next
ff68c719
PP
297#define HeKEY_hek(he) (he)->hent_hek
298#define HeKEY(he) HEK_KEY(HeKEY_hek(he))
bbce6d69 299#define HeKEY_sv(he) (*(SV**)HeKEY(he))
ff68c719 300#define HeKLEN(he) HEK_LEN(HeKEY_hek(he))
da58a35d 301#define HeKUTF8(he) HEK_UTF8(HeKEY_hek(he))
19692e8d 302#define HeKWASUTF8(he) HEK_WASUTF8(HeKEY_hek(he))
4b5190b5 303#define HeKREHASH(he) HEK_REHASH(HeKEY_hek(he))
da58a35d 304#define HeKLEN_UTF8(he) (HeKUTF8(he) ? -HeKLEN(he) : HeKLEN(he))
19692e8d 305#define HeKFLAGS(he) HEK_FLAGS(HeKEY_hek(he))
de616631 306#define HeVAL(he) (he)->he_valu.hent_val
ff68c719 307#define HeHASH(he) HEK_HASH(HeKEY_hek(he))
1e422769
PP
308#define HePV(he,lp) ((HeKLEN(he) == HEf_SVKEY) ? \
309 SvPV(HeKEY_sv(he),lp) : \
310 (((lp = HeKLEN(he)) >= 0) ? \
bd61b366 311 HeKEY(he) : NULL))
1e422769 312
bbce6d69
PP
313#define HeSVKEY(he) ((HeKEY(he) && \
314 HeKLEN(he) == HEf_SVKEY) ? \
a0714e2c 315 HeKEY_sv(he) : NULL)
bbce6d69
PP
316
317#define HeSVKEY_force(he) (HeKEY(he) ? \
318 ((HeKLEN(he) == HEf_SVKEY) ? \
319 HeKEY_sv(he) : \
79cb57f6 320 sv_2mortal(newSVpvn(HeKEY(he), \
bbce6d69 321 HeKLEN(he)))) : \
3280af22 322 &PL_sv_undef)
1e422769 323#define HeSVKEY_set(he,sv) ((HeKLEN(he) = HEf_SVKEY), (HeKEY_sv(he) = sv))
bbce6d69 324
ff68c719 325#define Nullhek Null(HEK*)
71be2cbc 326#define HEK_BASESIZE STRUCT_OFFSET(HEK, hek_key[0])
ff68c719
PP
327#define HEK_HASH(hek) (hek)->hek_hash
328#define HEK_LEN(hek) (hek)->hek_len
329#define HEK_KEY(hek) (hek)->hek_key
19692e8d
NC
330#define HEK_FLAGS(hek) (*((unsigned char *)(HEK_KEY(hek))+HEK_LEN(hek)+1))
331
332#define HVhek_UTF8 0x01 /* Key is utf8 encoded. */
333#define HVhek_WASUTF8 0x02 /* Key is bytes here, but was supplied as utf8. */
4b5190b5 334#define HVhek_REHASH 0x04 /* This key is in an hv using a custom HASH . */
45e34800 335#define HVhek_UNSHARED 0x08 /* This key isn't a shared hash key. */
19692e8d 336#define HVhek_FREEKEY 0x100 /* Internal flag to say key is malloc()ed. */
e16e2ff8
NC
337#define HVhek_PLACEHOLD 0x200 /* Internal flag to create placeholder.
338 * (may change, but Storable is a core module) */
19692e8d
NC
339#define HVhek_MASK 0xFF
340
fdcd69b6
NC
341/* Which flags enable HvHASKFLAGS? Somewhat a hack on a hack, as
342 HVhek_REHASH is only needed because the rehash flag has to be duplicated
343 into all keys as hv_iternext has no access to the hash flags. At this
344 point Storable's tests get upset, because sometimes hashes are "keyed"
345 and sometimes not, depending on the order of data insertion, and whether
45e34800
NC
346 it triggered rehashing. So currently HVhek_REHASH is exempt.
347 Similarly UNSHARED
fdcd69b6
NC
348*/
349
45e34800 350#define HVhek_ENABLEHVKFLAGS (HVhek_MASK & ~(HVhek_REHASH|HVhek_UNSHARED))
fdcd69b6 351
19692e8d
NC
352#define HEK_UTF8(hek) (HEK_FLAGS(hek) & HVhek_UTF8)
353#define HEK_UTF8_on(hek) (HEK_FLAGS(hek) |= HVhek_UTF8)
354#define HEK_UTF8_off(hek) (HEK_FLAGS(hek) &= ~HVhek_UTF8)
355#define HEK_WASUTF8(hek) (HEK_FLAGS(hek) & HVhek_WASUTF8)
356#define HEK_WASUTF8_on(hek) (HEK_FLAGS(hek) |= HVhek_WASUTF8)
357#define HEK_WASUTF8_off(hek) (HEK_FLAGS(hek) &= ~HVhek_WASUTF8)
4b5190b5
NC
358#define HEK_REHASH(hek) (HEK_FLAGS(hek) & HVhek_REHASH)
359#define HEK_REHASH_on(hek) (HEK_FLAGS(hek) |= HVhek_REHASH)
d18c6117 360
5cbe4eec 361/* calculate HV array allocation */
36768cf4
NC
362#ifndef PERL_USE_LARGE_HV_ALLOC
363/* Default to allocating the correct size - default to assuming that malloc()
364 is not broken and is efficient at allocating blocks sized at powers-of-two.
365*/
d18c6117
GS
366# define PERL_HV_ARRAY_ALLOC_BYTES(size) ((size) * sizeof(HE*))
367#else
368# define MALLOC_OVERHEAD 16
369# define PERL_HV_ARRAY_ALLOC_BYTES(size) \
370 (((size) < 64) \
371 ? (size) * sizeof(HE*) \
372 : (size) * sizeof(HE*) * 2 - MALLOC_OVERHEAD)
373#endif
37d85e3a 374
e16e2ff8
NC
375/* Flags for hv_iternext_flags. */
376#define HV_ITERNEXT_WANTPLACEHOLDERS 0x01 /* Don't skip placeholders. */
377
7a7b9979 378#define hv_iternext(hv) hv_iternext_flags(hv, 0)
bd61b366 379#define hv_magic(hv, gv, how) sv_magic((SV*)(hv), (SV*)(gv), how, NULL, 0)
7a7b9979 380
37d85e3a
JH
381/* available as a function in hv.c */
382#define Perl_sharepvn(sv, len, hash) HEK_KEY(share_hek(sv, len, hash))
383#define sharepvn(sv, len, hash) Perl_sharepvn(sv, len, hash)
bfcb3514 384
d1db91c6
NC
385#define share_hek_hek(hek) \
386 (++(((struct shared_he *)(((char *)hek) \
387 - STRUCT_OFFSET(struct shared_he, \
388 shared_he_hek))) \
de616631 389 ->shared_he_he.he_valu.hent_refcount), \
d1db91c6
NC
390 hek)
391
71ad1b0c
NC
392/* This refcounted he structure is used for storing the hints used for lexical
393 pragmas. Without threads, it's basically struct he + refcount.
394 With threads, life gets more complex as the structure needs to be shared
395 between threads (because it hangs from OPs, which are shared), hence the
396 alternate definition and mutex. */
397
398#ifdef PERL_CORE
399
b6bbf3fa 400/* Gosh. This really isn't a good name any longer. */
71ad1b0c
NC
401struct refcounted_he {
402 struct refcounted_he *refcounted_he_next; /* next entry in chain */
cbb1fbea 403#ifdef USE_ITHREADS
b6bbf3fa
NC
404 U32 refcounted_he_hash;
405 U32 refcounted_he_keylen;
cbb1fbea 406#else
71ad1b0c 407 HEK *refcounted_he_hek; /* hint key */
cbb1fbea 408#endif
71ad1b0c 409 U32 refcounted_he_refcnt; /* reference count */
b6bbf3fa
NC
410 union {
411 IV refcounted_he_u_iv;
412 UV refcounted_he_u_uv;
413 STRLEN refcounted_he_u_len;
414 } refcounted_he_val;
415 /* First byte is flags. Then NUL-terminated value. Then for ithreads,
416 non-NUL terminated key. */
417 char refcounted_he_data[1];
71ad1b0c
NC
418};
419
b6bbf3fa
NC
420/* Flag bits are HVhek_UTF8, HVhek_WASUTF8, then */
421#define HVrhek_undef 0x00 /* Value is undef. */
422#define HVrhek_PV 0x10 /* Value is a string. */
423#define HVrhek_IV 0x20 /* Value is IV/UV. */
424#define HVrhek_delete 0x30 /* Value is placeholder - signifies delete. */
425#define HVrhek_typemask 0x30
426#define HVrhek_UTF8 0x40 /* string value is utf8. */
427#define HVrhek_UV 0x40 /* integer value is UV. */
428
71ad1b0c
NC
429# ifdef USE_ITHREADS
430# define HINTS_REFCNT_LOCK MUTEX_LOCK(&PL_hints_mutex)
431# define HINTS_REFCNT_UNLOCK MUTEX_UNLOCK(&PL_hints_mutex)
432# else
433# define HINTS_REFCNT_LOCK NOOP
434# define HINTS_REFCNT_UNLOCK NOOP
435# endif
436#endif
437
438#ifdef USE_ITHREADS
439# define HINTS_REFCNT_INIT MUTEX_INIT(&PL_hints_mutex)
440# define HINTS_REFCNT_TERM MUTEX_DESTROY(&PL_hints_mutex)
441#else
442# define HINTS_REFCNT_INIT NOOP
443# define HINTS_REFCNT_TERM NOOP
444#endif
445
bfcb3514
NC
446/*
447 * Local variables:
448 * c-indentation-style: bsd
449 * c-basic-offset: 4
450 * indent-tabs-mode: t
451 * End:
452 *
453 * ex: set ts=8 sts=4 sw=4 noet:
454 */