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