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