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