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 | ||
5cbe4eec | 11 | /* entry in hash value chain */ |
79072805 | 12 | struct he { |
6f51351d NC |
13 | /* Keep hent_next first in this structure, because sv_free_arenas take |
14 | advantage of this to share code between the he arenas and the SV | |
15 | body arenas */ | |
5cbe4eec MLF |
16 | HE *hent_next; /* next entry in chain */ |
17 | HEK *hent_hek; /* hash key */ | |
de616631 NC |
18 | union { |
19 | SV *hent_val; /* scalar value that was hashed */ | |
20 | Size_t hent_refcount; /* references for this shared hash key */ | |
21 | } he_valu; | |
bbce6d69 | 22 | }; |
23 | ||
5cbe4eec | 24 | /* hash key -- defined separately for use as shared pointer */ |
ff68c719 | 25 | struct hek { |
5cbe4eec MLF |
26 | U32 hek_hash; /* hash of key */ |
27 | I32 hek_len; /* length of hash key */ | |
28 | char hek_key[1]; /* variable-length hash key */ | |
e05949c7 | 29 | /* the hash-key is \0-terminated */ |
1e54db1a JH |
30 | /* after the \0 there is a byte for flags, such as whether the key |
31 | is UTF-8 */ | |
79072805 LW |
32 | }; |
33 | ||
cbae3960 NC |
34 | struct shared_he { |
35 | struct he shared_he_he; | |
36 | struct hek shared_he_hek; | |
37 | }; | |
bfcb3514 NC |
38 | |
39 | /* Subject to change. | |
40 | Don't access this directly. | |
e1a479c5 | 41 | Use the funcs in mro.c |
bfcb3514 | 42 | */ |
e1a479c5 | 43 | |
b2685f0c NC |
44 | struct mro_alg { |
45 | AV *(*resolve)(pTHX_ HV* stash, U32 level); | |
46 | const char *name; | |
47 | U16 length; | |
48 | U16 kflags; /* For the hash API - set HVhek_UTF8 if name is UTF-8 */ | |
49 | U32 hash; /* or 0 */ | |
50 | }; | |
e1a479c5 BB |
51 | |
52 | struct mro_meta { | |
9953ff72 NC |
53 | /* a hash holding the different MROs private data. */ |
54 | HV *mro_linear_all; | |
3a6fa573 NC |
55 | /* a pointer directly to the current MROs private data. If mro_linear_all |
56 | is NULL, this owns the SV reference, else it is just a pointer to a | |
57 | value stored in and owned by mro_linear_all. */ | |
58 | SV *mro_linear_current; | |
dd69841b BB |
59 | HV *mro_nextmethod; /* next::method caching */ |
60 | U32 cache_gen; /* Bumping this invalidates our method cache */ | |
70cd14a1 | 61 | U32 pkg_gen; /* Bumps when local methods/@ISA change */ |
3d76853f | 62 | const struct mro_alg *mro_which; /* which mro alg is in use? */ |
a49ba3fc | 63 | HV *isa; /* Everything this class @ISA */ |
e1a479c5 BB |
64 | }; |
65 | ||
123892d9 NC |
66 | #define MRO_GET_PRIVATE_DATA(smeta, which) \ |
67 | (((smeta)->mro_which && (which) == (smeta)->mro_which) \ | |
3a6fa573 | 68 | ? (smeta)->mro_linear_current \ |
123892d9 NC |
69 | : Perl_mro_get_private_data(aTHX_ (smeta), (which))) |
70 | ||
e1a479c5 BB |
71 | /* Subject to change. |
72 | Don't access this directly. | |
73 | */ | |
74 | ||
15d9236d NC |
75 | union _xhvnameu { |
76 | HEK *xhvnameu_name; /* When xhv_name_count is 0 */ | |
77 | HEK **xhvnameu_names; /* When xhv_name_count is non-0 */ | |
78 | }; | |
79 | ||
bfcb3514 | 80 | struct xpvhv_aux { |
15d9236d | 81 | union _xhvnameu xhv_name_u; /* name, if a symbol table */ |
86f55936 | 82 | AV *xhv_backreferences; /* back references for weak references */ |
bfcb3514 NC |
83 | HE *xhv_eiter; /* current entry of iterator */ |
84 | I32 xhv_riter; /* current root of iterator */ | |
15d9236d | 85 | /* Concerning xhv_name_count: When non-zero, xhv_name_u contains a pointer |
78b79c77 FC |
86 | * to an array of HEK pointers, this being the length. The first element is |
87 | * the name of the stash, which may be NULL. If xhv_name_count is positive, | |
88 | * then *xhv_name is one of the effective names. If xhv_name_count is nega- | |
15d9236d | 89 | * tive, then xhv_name_u.xhvnameu_names[1] is the first effective name. |
78b79c77 FC |
90 | */ |
91 | I32 xhv_name_count; | |
bc85b3a1 | 92 | struct mro_meta *xhv_mro_meta; |
78b79c77 | 93 | }; |
bfcb3514 | 94 | |
5cbe4eec | 95 | /* hash structure: */ |
6ee623d5 | 96 | /* This structure must match the beginning of struct xpvmg in sv.h. */ |
79072805 | 97 | struct xpvhv { |
6e128786 NC |
98 | HV* xmg_stash; /* class package */ |
99 | union _xmgu xmg_u; | |
359164a0 | 100 | STRLEN xhv_keys; /* total keys, including placeholders */ |
c8e503bf | 101 | STRLEN xhv_max; /* subscript of last element of xhv_array */ |
79072805 LW |
102 | }; |
103 | ||
5cbe4eec | 104 | /* hash a key */ |
5afd6d42 JH |
105 | /* FYI: This is the "One-at-a-Time" algorithm by Bob Jenkins |
106 | * from requirements by Colin Plumb. | |
107 | * (http://burtleburtle.net/bob/hash/doobs.html) */ | |
108 | /* The use of a temporary pointer and the casting games | |
109 | * is needed to serve the dual purposes of | |
110 | * (a) the hashed data being interpreted as "unsigned char" (new since 5.8, | |
df805c3e | 111 | * a "char" can be either signed or unsigned, depending on the compiler) |
5afd6d42 | 112 | * (b) catering for old code that uses a "char" |
830b38bd | 113 | * |
504f80c1 JH |
114 | * The "hash seed" feature was added in Perl 5.8.1 to perturb the results |
115 | * to avoid "algorithmic complexity attacks". | |
830b38bd JH |
116 | * |
117 | * If USE_HASH_SEED is defined, hash randomisation is done by default | |
118 | * If USE_HASH_SEED_EXPLICIT is defined, hash randomisation is done | |
119 | * only if the environment variable PERL_HASH_SEED is set. | |
120 | * For maximal control, one can define PERL_HASH_SEED. | |
90ce55a1 | 121 | * (see also perl.c:perl_parse()). |
5afd6d42 | 122 | */ |
830b38bd JH |
123 | #ifndef PERL_HASH_SEED |
124 | # if defined(USE_HASH_SEED) || defined(USE_HASH_SEED_EXPLICIT) | |
125 | # define PERL_HASH_SEED PL_hash_seed | |
126 | # else | |
127 | # define PERL_HASH_SEED 0 | |
128 | # endif | |
504f80c1 | 129 | #endif |
f8d50d94 DM |
130 | |
131 | #define PERL_HASH(hash,str,len) PERL_HASH_INTERNAL_(hash,str,len,0) | |
bf6bd887 | 132 | |
3d78eb94 NC |
133 | /* Only hv.c and mod_perl should be doing this. */ |
134 | #ifdef PERL_HASH_INTERNAL_ACCESS | |
f8d50d94 DM |
135 | #define PERL_HASH_INTERNAL(hash,str,len) PERL_HASH_INTERNAL_(hash,str,len,1) |
136 | #endif | |
137 | ||
138 | /* Common base for PERL_HASH and PERL_HASH_INTERNAL that parameterises | |
139 | * the source of the seed. Not for direct use outside of hv.c. */ | |
140 | ||
141 | #define PERL_HASH_INTERNAL_(hash,str,len,internal) \ | |
4b5190b5 | 142 | STMT_START { \ |
eb578fdb KW |
143 | const char * const s_PeRlHaSh_tmp = str; \ |
144 | const unsigned char *s_PeRlHaSh = (const unsigned char *)s_PeRlHaSh_tmp; \ | |
145 | I32 i_PeRlHaSh = len; \ | |
146 | U32 hash_PeRlHaSh = (internal ? PL_rehash_seed : PERL_HASH_SEED); \ | |
4b5190b5 NC |
147 | while (i_PeRlHaSh--) { \ |
148 | hash_PeRlHaSh += *s_PeRlHaSh++; \ | |
149 | hash_PeRlHaSh += (hash_PeRlHaSh << 10); \ | |
150 | hash_PeRlHaSh ^= (hash_PeRlHaSh >> 6); \ | |
151 | } \ | |
152 | hash_PeRlHaSh += (hash_PeRlHaSh << 3); \ | |
153 | hash_PeRlHaSh ^= (hash_PeRlHaSh >> 11); \ | |
154 | (hash) = (hash_PeRlHaSh + (hash_PeRlHaSh << 15)); \ | |
155 | } STMT_END | |
4b5190b5 | 156 | |
954c1994 | 157 | /* |
ccfc67b7 JH |
158 | =head1 Hash Manipulation Functions |
159 | ||
954c1994 GS |
160 | =for apidoc AmU||HEf_SVKEY |
161 | This flag, used in the length slot of hash entries and magic structures, | |
d1be9408 | 162 | specifies the structure contains an C<SV*> pointer where a C<char*> pointer |
954c1994 GS |
163 | is to be expected. (For information only--not to be used). |
164 | ||
ccfc67b7 JH |
165 | =head1 Handy Values |
166 | ||
954c1994 GS |
167 | =for apidoc AmU||Nullhv |
168 | Null HV pointer. | |
169 | ||
3ae1b226 NC |
170 | (deprecated - use C<(HV *)NULL> instead) |
171 | ||
ccfc67b7 JH |
172 | =head1 Hash Manipulation Functions |
173 | ||
954c1994 | 174 | =for apidoc Am|char*|HvNAME|HV* stash |
9282b5fd SH |
175 | Returns the package name of a stash, or NULL if C<stash> isn't a stash. |
176 | See C<SvSTASH>, C<CvSTASH>. | |
954c1994 | 177 | |
d9021235 FC |
178 | =for apidoc Am|STRLEN|HvNAMELEN|HV *stash |
179 | Returns the length of the stash's name. | |
180 | ||
181 | =for apidoc Am|unsigned char|HvNAMEUTF8|HV *stash | |
182 | Returns true if the name is in UTF8 encoding. | |
183 | ||
bc56db2a FC |
184 | =for apidoc Am|char*|HvENAME|HV* stash |
185 | Returns the effective name of a stash, or NULL if there is none. The | |
186 | effective name represents a location in the symbol table where this stash | |
187 | resides. It is updated automatically when packages are aliased or deleted. | |
188 | A stash that is no longer in the symbol table has no effective name. This | |
189 | name is preferable to C<HvNAME> for use in MRO linearisations and isa | |
190 | caches. | |
191 | ||
d9021235 FC |
192 | =for apidoc Am|STRLEN|HvENAMELEN|HV *stash |
193 | Returns the length of the stash's effective name. | |
194 | ||
195 | =for apidoc Am|unsigned char|HvENAMEUTF8|HV *stash | |
196 | Returns true if the effective name is in UTF8 encoding. | |
197 | ||
954c1994 GS |
198 | =for apidoc Am|void*|HeKEY|HE* he |
199 | Returns the actual pointer stored in the key slot of the hash entry. The | |
200 | pointer may be either C<char*> or C<SV*>, depending on the value of | |
201 | C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are | |
202 | usually preferable for finding the value of a key. | |
203 | ||
204 | =for apidoc Am|STRLEN|HeKLEN|HE* he | |
205 | If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry | |
206 | holds an C<SV*> key. Otherwise, holds the actual length of the key. Can | |
207 | be assigned to. The C<HePV()> macro is usually preferable for finding key | |
208 | lengths. | |
209 | ||
210 | =for apidoc Am|SV*|HeVAL|HE* he | |
566a4718 YO |
211 | Returns the value slot (type C<SV*>) stored in the hash entry. Can be assigned |
212 | to. | |
213 | ||
214 | SV *foo= HeVAL(hv); | |
215 | HeVAL(hv)= sv; | |
216 | ||
954c1994 GS |
217 | |
218 | =for apidoc Am|U32|HeHASH|HE* he | |
219 | Returns the computed hash stored in the hash entry. | |
220 | ||
221 | =for apidoc Am|char*|HePV|HE* he|STRLEN len | |
222 | Returns the key slot of the hash entry as a C<char*> value, doing any | |
223 | necessary dereferencing of possibly C<SV*> keys. The length of the string | |
224 | is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do | |
225 | not care about what the length of the key is, you may use the global | |
226 | variable C<PL_na>, though this is rather less efficient than using a local | |
227 | variable. Remember though, that hash keys in perl are free to contain | |
228 | embedded nulls, so using C<strlen()> or similar is not a good way to find | |
229 | the length of hash keys. This is very similar to the C<SvPV()> macro | |
289d3c6a NC |
230 | described elsewhere in this document. See also C<HeUTF8>. |
231 | ||
232 | If you are using C<HePV> to get values to pass to C<newSVpvn()> to create a | |
233 | new SV, you should consider using C<newSVhek(HeKEY_hek(he))> as it is more | |
234 | efficient. | |
235 | ||
cca4e9fa | 236 | =for apidoc Am|char*|HeUTF8|HE* he |
289d3c6a NC |
237 | Returns whether the C<char *> value returned by C<HePV> is encoded in UTF-8, |
238 | doing any necessary dereferencing of possibly C<SV*> keys. The value returned | |
62a1a1ef | 239 | will be 0 or non-0, not necessarily 1 (or even a value with any low bits set), |
289d3c6a NC |
240 | so B<do not> blindly assign this to a C<bool> variable, as C<bool> may be a |
241 | typedef for C<char>. | |
954c1994 GS |
242 | |
243 | =for apidoc Am|SV*|HeSVKEY|HE* he | |
a0714e2c | 244 | Returns the key as an C<SV*>, or C<NULL> if the hash entry does not |
954c1994 GS |
245 | contain an C<SV*> key. |
246 | ||
247 | =for apidoc Am|SV*|HeSVKEY_force|HE* he | |
248 | Returns the key as an C<SV*>. Will create and return a temporary mortal | |
249 | C<SV*> if the hash entry contains only a C<char*> key. | |
250 | ||
251 | =for apidoc Am|SV*|HeSVKEY_set|HE* he|SV* sv | |
252 | Sets the key to a given C<SV*>, taking care to set the appropriate flags to | |
253 | indicate the presence of an C<SV*> key, and returns the same | |
254 | C<SV*>. | |
255 | ||
256 | =cut | |
257 | */ | |
bf6bd887 | 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) |
4d0fbddd | 266 | #define HvFILL(hv) Perl_hv_fill(aTHX_ (const 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) |
7423f6db | 277 | #define HvNAME(hv) HvNAME_get(hv) |
f2462604 | 278 | #define HvNAMELEN(hv) HvNAMELEN_get(hv) |
bc56db2a | 279 | #define HvENAME(hv) HvENAME_get(hv) |
f2462604 | 280 | #define HvENAMELEN(hv) HvENAMELEN_get(hv) |
2c7f4b87 BB |
281 | |
282 | /* Checking that hv is a valid package stash is the | |
283 | caller's responsibility */ | |
284 | #define HvMROMETA(hv) (HvAUX(hv)->xhv_mro_meta \ | |
285 | ? HvAUX(hv)->xhv_mro_meta \ | |
c60bad7b | 286 | : Perl_mro_meta_init(aTHX_ hv)) |
2c7f4b87 | 287 | |
15d9236d NC |
288 | #define HvNAME_HEK_NN(hv) \ |
289 | ( \ | |
290 | HvAUX(hv)->xhv_name_count \ | |
291 | ? *HvAUX(hv)->xhv_name_u.xhvnameu_names \ | |
292 | : HvAUX(hv)->xhv_name_u.xhvnameu_name \ | |
b7247a80 | 293 | ) |
9b9d0b15 | 294 | /* This macro may go away without notice. */ |
b7247a80 | 295 | #define HvNAME_HEK(hv) \ |
15d9236d | 296 | (SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name ? HvNAME_HEK_NN(hv) : NULL) |
78b79c77 | 297 | #define HvNAME_get(hv) \ |
15d9236d | 298 | ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvNAME_HEK_NN(hv)) \ |
b7247a80 | 299 | ? HEK_KEY(HvNAME_HEK_NN(hv)) : NULL) |
78b79c77 | 300 | #define HvNAMELEN_get(hv) \ |
15d9236d | 301 | ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvNAME_HEK_NN(hv)) \ |
b7247a80 | 302 | ? HEK_LEN(HvNAME_HEK_NN(hv)) : 0) |
b2c03ebd | 303 | #define HvNAMEUTF8(hv) \ |
f2462604 BF |
304 | ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvNAME_HEK_NN(hv)) \ |
305 | ? HEK_UTF8(HvNAME_HEK_NN(hv)) : 0) | |
c4842d1d | 306 | #define HvENAME_HEK_NN(hv) \ |
78b79c77 | 307 | ( \ |
15d9236d NC |
308 | HvAUX(hv)->xhv_name_count > 0 ? HvAUX(hv)->xhv_name_u.xhvnameu_names[0] : \ |
309 | HvAUX(hv)->xhv_name_count < -1 ? HvAUX(hv)->xhv_name_u.xhvnameu_names[1] : \ | |
78b79c77 | 310 | HvAUX(hv)->xhv_name_count == -1 ? NULL : \ |
15d9236d | 311 | HvAUX(hv)->xhv_name_u.xhvnameu_name \ |
78b79c77 | 312 | ) |
c4842d1d | 313 | #define HvENAME_HEK(hv) \ |
15d9236d | 314 | (SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name ? HvENAME_HEK_NN(hv) : NULL) |
c4842d1d | 315 | #define HvENAME_get(hv) \ |
c49a809b | 316 | ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvAUX(hv)->xhv_name_count != -1) \ |
78b79c77 | 317 | ? HEK_KEY(HvENAME_HEK_NN(hv)) : NULL) |
c4842d1d | 318 | #define HvENAMELEN_get(hv) \ |
c49a809b | 319 | ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvAUX(hv)->xhv_name_count != -1) \ |
78b79c77 | 320 | ? HEK_LEN(HvENAME_HEK_NN(hv)) : 0) |
b2c03ebd | 321 | #define HvENAMEUTF8(hv) \ |
c49a809b | 322 | ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvAUX(hv)->xhv_name_count != -1) \ |
f2462604 | 323 | ? HEK_UTF8(HvENAME_HEK_NN(hv)) : 0) |
a0d0e21e | 324 | |
486ec47a | 325 | /* the number of keys (including any placeholders) */ |
8aacddc1 NIS |
326 | #define XHvTOTALKEYS(xhv) ((xhv)->xhv_keys) |
327 | ||
8aacddc1 NIS |
328 | /* |
329 | * HvKEYS gets the number of keys that actually exist(), and is provided | |
330 | * for backwards compatibility with old XS code. The core uses HvUSEDKEYS | |
486ec47a | 331 | * (keys, excluding placeholders) and HvTOTALKEYS (including placeholders) |
8aacddc1 | 332 | */ |
ca732855 NC |
333 | #define HvKEYS(hv) HvUSEDKEYS(hv) |
334 | #define HvUSEDKEYS(hv) (HvTOTALKEYS(hv) - HvPLACEHOLDERS_get(hv)) | |
8aacddc1 | 335 | #define HvTOTALKEYS(hv) XHvTOTALKEYS((XPVHV*) SvANY(hv)) |
dbebbdb4 NC |
336 | #define HvPLACEHOLDERS(hv) (*Perl_hv_placeholders_p(aTHX_ MUTABLE_HV(hv))) |
337 | #define HvPLACEHOLDERS_get(hv) (SvMAGIC(hv) ? Perl_hv_placeholders_get(aTHX_ (const HV *)hv) : 0) | |
338 | #define HvPLACEHOLDERS_set(hv,p) Perl_hv_placeholders_set(aTHX_ MUTABLE_HV(hv), p) | |
8aacddc1 | 339 | |
bf6bd887 | 340 | #define HvSHAREKEYS(hv) (SvFLAGS(hv) & SVphv_SHAREKEYS) |
341 | #define HvSHAREKEYS_on(hv) (SvFLAGS(hv) |= SVphv_SHAREKEYS) | |
342 | #define HvSHAREKEYS_off(hv) (SvFLAGS(hv) &= ~SVphv_SHAREKEYS) | |
343 | ||
19692e8d NC |
344 | /* This is an optimisation flag. It won't be set if all hash keys have a 0 |
345 | * flag. Currently the only flags relate to utf8. | |
346 | * Hence it won't be set if all keys are 8 bit only. It will be set if any key | |
347 | * is utf8 (including 8 bit keys that were entered as utf8, and need upgrading | |
348 | * when retrieved during iteration. It may still be set when there are no longer | |
349 | * any utf8 keys. | |
fdcd69b6 | 350 | * See HVhek_ENABLEHVKFLAGS for the trigger. |
19692e8d NC |
351 | */ |
352 | #define HvHASKFLAGS(hv) (SvFLAGS(hv) & SVphv_HASKFLAGS) | |
353 | #define HvHASKFLAGS_on(hv) (SvFLAGS(hv) |= SVphv_HASKFLAGS) | |
354 | #define HvHASKFLAGS_off(hv) (SvFLAGS(hv) &= ~SVphv_HASKFLAGS) | |
574c8022 | 355 | |
bf5b86ae GS |
356 | #define HvLAZYDEL(hv) (SvFLAGS(hv) & SVphv_LAZYDEL) |
357 | #define HvLAZYDEL_on(hv) (SvFLAGS(hv) |= SVphv_LAZYDEL) | |
358 | #define HvLAZYDEL_off(hv) (SvFLAGS(hv) &= ~SVphv_LAZYDEL) | |
359 | ||
4b5190b5 NC |
360 | #define HvREHASH(hv) (SvFLAGS(hv) & SVphv_REHASH) |
361 | #define HvREHASH_on(hv) (SvFLAGS(hv) |= SVphv_REHASH) | |
362 | #define HvREHASH_off(hv) (SvFLAGS(hv) &= ~SVphv_REHASH) | |
363 | ||
3ae1b226 NC |
364 | #ifndef PERL_CORE |
365 | # define Nullhe Null(HE*) | |
366 | #endif | |
bf6bd887 | 367 | #define HeNEXT(he) (he)->hent_next |
ff68c719 | 368 | #define HeKEY_hek(he) (he)->hent_hek |
369 | #define HeKEY(he) HEK_KEY(HeKEY_hek(he)) | |
bbce6d69 | 370 | #define HeKEY_sv(he) (*(SV**)HeKEY(he)) |
ff68c719 | 371 | #define HeKLEN(he) HEK_LEN(HeKEY_hek(he)) |
da58a35d | 372 | #define HeKUTF8(he) HEK_UTF8(HeKEY_hek(he)) |
19692e8d | 373 | #define HeKWASUTF8(he) HEK_WASUTF8(HeKEY_hek(he)) |
4b5190b5 | 374 | #define HeKREHASH(he) HEK_REHASH(HeKEY_hek(he)) |
da58a35d | 375 | #define HeKLEN_UTF8(he) (HeKUTF8(he) ? -HeKLEN(he) : HeKLEN(he)) |
19692e8d | 376 | #define HeKFLAGS(he) HEK_FLAGS(HeKEY_hek(he)) |
de616631 | 377 | #define HeVAL(he) (he)->he_valu.hent_val |
ff68c719 | 378 | #define HeHASH(he) HEK_HASH(HeKEY_hek(he)) |
1e422769 | 379 | #define HePV(he,lp) ((HeKLEN(he) == HEf_SVKEY) ? \ |
380 | SvPV(HeKEY_sv(he),lp) : \ | |
402f0539 | 381 | ((lp = HeKLEN(he)), HeKEY(he))) |
289d3c6a NC |
382 | #define HeUTF8(he) ((HeKLEN(he) == HEf_SVKEY) ? \ |
383 | SvUTF8(HeKEY_sv(he)) : \ | |
384 | (U32)HeKUTF8(he)) | |
1e422769 | 385 | |
bbce6d69 | 386 | #define HeSVKEY(he) ((HeKEY(he) && \ |
387 | HeKLEN(he) == HEf_SVKEY) ? \ | |
a0714e2c | 388 | HeKEY_sv(he) : NULL) |
bbce6d69 | 389 | |
390 | #define HeSVKEY_force(he) (HeKEY(he) ? \ | |
391 | ((HeKLEN(he) == HEf_SVKEY) ? \ | |
392 | HeKEY_sv(he) : \ | |
ad25789c NC |
393 | newSVpvn_flags(HeKEY(he), \ |
394 | HeKLEN(he), SVs_TEMP)) : \ | |
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 | |
19692e8d NC |
405 | #define HEK_FLAGS(hek) (*((unsigned char *)(HEK_KEY(hek))+HEK_LEN(hek)+1)) |
406 | ||
407 | #define HVhek_UTF8 0x01 /* Key is utf8 encoded. */ | |
408 | #define HVhek_WASUTF8 0x02 /* Key is bytes here, but was supplied as utf8. */ | |
4b5190b5 | 409 | #define HVhek_REHASH 0x04 /* This key is in an hv using a custom HASH . */ |
45e34800 | 410 | #define HVhek_UNSHARED 0x08 /* This key isn't a shared hash key. */ |
19692e8d | 411 | #define HVhek_FREEKEY 0x100 /* Internal flag to say key is malloc()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 | ||
fdcd69b6 NC |
419 | /* Which flags enable HvHASKFLAGS? Somewhat a hack on a hack, as |
420 | HVhek_REHASH is only needed because the rehash flag has to be duplicated | |
421 | into all keys as hv_iternext has no access to the hash flags. At this | |
422 | point Storable's tests get upset, because sometimes hashes are "keyed" | |
423 | and sometimes not, depending on the order of data insertion, and whether | |
45e34800 NC |
424 | it triggered rehashing. So currently HVhek_REHASH is exempt. |
425 | Similarly UNSHARED | |
fdcd69b6 NC |
426 | */ |
427 | ||
45e34800 | 428 | #define HVhek_ENABLEHVKFLAGS (HVhek_MASK & ~(HVhek_REHASH|HVhek_UNSHARED)) |
fdcd69b6 | 429 | |
19692e8d NC |
430 | #define HEK_UTF8(hek) (HEK_FLAGS(hek) & HVhek_UTF8) |
431 | #define HEK_UTF8_on(hek) (HEK_FLAGS(hek) |= HVhek_UTF8) | |
432 | #define HEK_UTF8_off(hek) (HEK_FLAGS(hek) &= ~HVhek_UTF8) | |
433 | #define HEK_WASUTF8(hek) (HEK_FLAGS(hek) & HVhek_WASUTF8) | |
434 | #define HEK_WASUTF8_on(hek) (HEK_FLAGS(hek) |= HVhek_WASUTF8) | |
435 | #define HEK_WASUTF8_off(hek) (HEK_FLAGS(hek) &= ~HVhek_WASUTF8) | |
4b5190b5 NC |
436 | #define HEK_REHASH(hek) (HEK_FLAGS(hek) & HVhek_REHASH) |
437 | #define HEK_REHASH_on(hek) (HEK_FLAGS(hek) |= HVhek_REHASH) | |
d18c6117 | 438 | |
5cbe4eec | 439 | /* calculate HV array allocation */ |
36768cf4 NC |
440 | #ifndef PERL_USE_LARGE_HV_ALLOC |
441 | /* Default to allocating the correct size - default to assuming that malloc() | |
442 | is not broken and is efficient at allocating blocks sized at powers-of-two. | |
443 | */ | |
d18c6117 GS |
444 | # define PERL_HV_ARRAY_ALLOC_BYTES(size) ((size) * sizeof(HE*)) |
445 | #else | |
446 | # define MALLOC_OVERHEAD 16 | |
447 | # define PERL_HV_ARRAY_ALLOC_BYTES(size) \ | |
448 | (((size) < 64) \ | |
449 | ? (size) * sizeof(HE*) \ | |
450 | : (size) * sizeof(HE*) * 2 - MALLOC_OVERHEAD) | |
451 | #endif | |
37d85e3a | 452 | |
e16e2ff8 NC |
453 | /* Flags for hv_iternext_flags. */ |
454 | #define HV_ITERNEXT_WANTPLACEHOLDERS 0x01 /* Don't skip placeholders. */ | |
455 | ||
7a7b9979 | 456 | #define hv_iternext(hv) hv_iternext_flags(hv, 0) |
b1bc3f34 | 457 | #define hv_magic(hv, gv, how) sv_magic(MUTABLE_SV(hv), MUTABLE_SV(gv), how, NULL, 0) |
8581adba | 458 | #define hv_undef(hv) Perl_hv_undef_flags(aTHX_ hv, 0) |
7a7b9979 | 459 | |
bbd42945 FC |
460 | #define Perl_sharepvn(pv, len, hash) HEK_KEY(share_hek(pv, len, hash)) |
461 | #define sharepvn(pv, len, hash) Perl_sharepvn(pv, len, hash) | |
bfcb3514 | 462 | |
d1db91c6 NC |
463 | #define share_hek_hek(hek) \ |
464 | (++(((struct shared_he *)(((char *)hek) \ | |
465 | - STRUCT_OFFSET(struct shared_he, \ | |
466 | shared_he_hek))) \ | |
de616631 | 467 | ->shared_he_he.he_valu.hent_refcount), \ |
d1db91c6 NC |
468 | hek) |
469 | ||
99978bb4 NC |
470 | #define hv_store_ent(hv, keysv, val, hash) \ |
471 | ((HE *) hv_common((hv), (keysv), NULL, 0, 0, HV_FETCH_ISSTORE, \ | |
472 | (val), (hash))) | |
4c2df08c | 473 | |
99978bb4 NC |
474 | #define hv_exists_ent(hv, keysv, hash) \ |
475 | (hv_common((hv), (keysv), NULL, 0, 0, HV_FETCH_ISEXISTS, 0, (hash)) \ | |
4c2df08c | 476 | ? TRUE : FALSE) |
99978bb4 NC |
477 | #define hv_fetch_ent(hv, keysv, lval, hash) \ |
478 | ((HE *) hv_common((hv), (keysv), NULL, 0, 0, \ | |
479 | ((lval) ? HV_FETCH_LVALUE : 0), NULL, (hash))) | |
480 | #define hv_delete_ent(hv, key, flags, hash) \ | |
b1bc3f34 NC |
481 | (MUTABLE_SV(hv_common((hv), (key), NULL, 0, 0, (flags) | HV_DELETE, \ |
482 | NULL, (hash)))) | |
99978bb4 NC |
483 | |
484 | #define hv_store_flags(hv, key, klen, val, hash, flags) \ | |
485 | ((SV**) hv_common((hv), NULL, (key), (klen), (flags), \ | |
486 | (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV), (val), \ | |
487 | (hash))) | |
488 | ||
489 | #define hv_store(hv, key, klen, val, hash) \ | |
490 | ((SV**) hv_common_key_len((hv), (key), (klen), \ | |
a038e571 | 491 | (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV), \ |
99978bb4 | 492 | (val), (hash))) |
a038e571 | 493 | |
99978bb4 NC |
494 | #define hv_exists(hv, key, klen) \ |
495 | (hv_common_key_len((hv), (key), (klen), HV_FETCH_ISEXISTS, NULL, 0) \ | |
a038e571 NC |
496 | ? TRUE : FALSE) |
497 | ||
99978bb4 NC |
498 | #define hv_fetch(hv, key, klen, lval) \ |
499 | ((SV**) hv_common_key_len((hv), (key), (klen), (lval) \ | |
a038e571 NC |
500 | ? (HV_FETCH_JUST_SV | HV_FETCH_LVALUE) \ |
501 | : HV_FETCH_JUST_SV, NULL, 0)) | |
502 | ||
99978bb4 | 503 | #define hv_delete(hv, key, klen, flags) \ |
b1bc3f34 NC |
504 | (MUTABLE_SV(hv_common_key_len((hv), (key), (klen), \ |
505 | (flags) | HV_DELETE, NULL, 0))) | |
a038e571 | 506 | |
71ad1b0c NC |
507 | /* This refcounted he structure is used for storing the hints used for lexical |
508 | pragmas. Without threads, it's basically struct he + refcount. | |
509 | With threads, life gets more complex as the structure needs to be shared | |
510 | between threads (because it hangs from OPs, which are shared), hence the | |
511 | alternate definition and mutex. */ | |
512 | ||
44ebaf21 NC |
513 | struct refcounted_he; |
514 | ||
20439bc7 Z |
515 | /* flags for the refcounted_he API */ |
516 | #define REFCOUNTED_HE_KEY_UTF8 0x00000001 | |
94250aee FC |
517 | #ifdef PERL_CORE |
518 | # define REFCOUNTED_HE_EXISTS 0x00000002 | |
519 | #endif | |
20439bc7 | 520 | |
71ad1b0c NC |
521 | #ifdef PERL_CORE |
522 | ||
b6bbf3fa | 523 | /* Gosh. This really isn't a good name any longer. */ |
71ad1b0c NC |
524 | struct refcounted_he { |
525 | struct refcounted_he *refcounted_he_next; /* next entry in chain */ | |
cbb1fbea | 526 | #ifdef USE_ITHREADS |
b6bbf3fa NC |
527 | U32 refcounted_he_hash; |
528 | U32 refcounted_he_keylen; | |
cbb1fbea | 529 | #else |
71ad1b0c | 530 | HEK *refcounted_he_hek; /* hint key */ |
cbb1fbea | 531 | #endif |
b6bbf3fa NC |
532 | union { |
533 | IV refcounted_he_u_iv; | |
534 | UV refcounted_he_u_uv; | |
535 | STRLEN refcounted_he_u_len; | |
44ebaf21 | 536 | void *refcounted_he_u_ptr; /* Might be useful in future */ |
b6bbf3fa | 537 | } refcounted_he_val; |
9bd87817 | 538 | U32 refcounted_he_refcnt; /* reference count */ |
b6bbf3fa NC |
539 | /* First byte is flags. Then NUL-terminated value. Then for ithreads, |
540 | non-NUL terminated key. */ | |
541 | char refcounted_he_data[1]; | |
71ad1b0c NC |
542 | }; |
543 | ||
20439bc7 Z |
544 | /* |
545 | =for apidoc m|SV *|refcounted_he_fetch_pvs|const struct refcounted_he *chain|const char *key|U32 flags | |
546 | ||
547 | Like L</refcounted_he_fetch_pvn>, but takes a literal string instead of | |
548 | a string/length pair, and no precomputed hash. | |
549 | ||
550 | =cut | |
551 | */ | |
552 | ||
553 | #define refcounted_he_fetch_pvs(chain, key, flags) \ | |
554 | Perl_refcounted_he_fetch_pvn(aTHX_ chain, STR_WITH_LEN(key), 0, flags) | |
555 | ||
556 | /* | |
557 | =for apidoc m|struct refcounted_he *|refcounted_he_new_pvs|struct refcounted_he *parent|const char *key|SV *value|U32 flags | |
558 | ||
559 | Like L</refcounted_he_new_pvn>, but takes a literal string instead of | |
560 | a string/length pair, and no precomputed hash. | |
561 | ||
562 | =cut | |
563 | */ | |
564 | ||
565 | #define refcounted_he_new_pvs(parent, key, value, flags) \ | |
566 | Perl_refcounted_he_new_pvn(aTHX_ parent, STR_WITH_LEN(key), 0, value, flags) | |
567 | ||
b6bbf3fa NC |
568 | /* Flag bits are HVhek_UTF8, HVhek_WASUTF8, then */ |
569 | #define HVrhek_undef 0x00 /* Value is undef. */ | |
44ebaf21 NC |
570 | #define HVrhek_delete 0x10 /* Value is placeholder - signifies delete. */ |
571 | #define HVrhek_IV 0x20 /* Value is IV. */ | |
572 | #define HVrhek_UV 0x30 /* Value is UV. */ | |
573 | #define HVrhek_PV 0x40 /* Value is a (byte) string. */ | |
574 | #define HVrhek_PV_UTF8 0x50 /* Value is a (utf8) string. */ | |
575 | /* Two spare. As these have to live in the optree, you can't store anything | |
576 | interpreter specific, such as SVs. :-( */ | |
577 | #define HVrhek_typemask 0x70 | |
578 | ||
579 | #ifdef USE_ITHREADS | |
580 | /* A big expression to find the key offset */ | |
581 | #define REF_HE_KEY(chain) \ | |
582 | ((((chain->refcounted_he_data[0] & 0x60) == 0x40) \ | |
583 | ? chain->refcounted_he_val.refcounted_he_u_len + 1 : 0) \ | |
584 | + 1 + chain->refcounted_he_data) | |
585 | #endif | |
b6bbf3fa | 586 | |
71ad1b0c NC |
587 | # ifdef USE_ITHREADS |
588 | # define HINTS_REFCNT_LOCK MUTEX_LOCK(&PL_hints_mutex) | |
589 | # define HINTS_REFCNT_UNLOCK MUTEX_UNLOCK(&PL_hints_mutex) | |
590 | # else | |
591 | # define HINTS_REFCNT_LOCK NOOP | |
592 | # define HINTS_REFCNT_UNLOCK NOOP | |
593 | # endif | |
594 | #endif | |
595 | ||
596 | #ifdef USE_ITHREADS | |
597 | # define HINTS_REFCNT_INIT MUTEX_INIT(&PL_hints_mutex) | |
598 | # define HINTS_REFCNT_TERM MUTEX_DESTROY(&PL_hints_mutex) | |
599 | #else | |
600 | # define HINTS_REFCNT_INIT NOOP | |
601 | # define HINTS_REFCNT_TERM NOOP | |
602 | #endif | |
603 | ||
324a0d18 JH |
604 | /* Hash actions |
605 | * Passed in PERL_MAGIC_uvar calls | |
606 | */ | |
b54b4831 NC |
607 | #define HV_DISABLE_UVAR_XKEY 0x01 |
608 | /* We need to ensure that these don't clash with G_DISCARD, which is 2, as it | |
609 | is documented as being passed to hv_delete(). */ | |
610 | #define HV_FETCH_ISSTORE 0x04 | |
611 | #define HV_FETCH_ISEXISTS 0x08 | |
612 | #define HV_FETCH_LVALUE 0x10 | |
613 | #define HV_FETCH_JUST_SV 0x20 | |
9dbc5603 | 614 | #define HV_DELETE 0x40 |
df5f182b | 615 | #define HV_FETCH_EMPTY_HE 0x80 /* Leave HeVAL null. */ |
324a0d18 | 616 | |
745edda6 FC |
617 | /* Must not conflict with HVhek_UTF8 */ |
618 | #define HV_NAME_SETALL 0x02 | |
619 | ||
bfcb3514 | 620 | /* |
78ac7dd9 NC |
621 | =for apidoc newHV |
622 | ||
623 | Creates a new HV. The reference count is set to 1. | |
624 | ||
625 | =cut | |
626 | */ | |
627 | ||
dbebbdb4 | 628 | #define newHV() MUTABLE_HV(newSV_type(SVt_PVHV)) |
78ac7dd9 NC |
629 | |
630 | /* | |
bfcb3514 NC |
631 | * Local variables: |
632 | * c-indentation-style: bsd | |
633 | * c-basic-offset: 4 | |
14d04a33 | 634 | * indent-tabs-mode: nil |
bfcb3514 NC |
635 | * End: |
636 | * | |
14d04a33 | 637 | * ex: set ts=8 sts=4 sw=4 et: |
bfcb3514 | 638 | */ |