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