3 * Copyright (C) 1991, 1992, 1993, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2005, 2006, 2007, 2008, by Larry Wall and others
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.
11 /* entry in hash value chain */
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
16 HE *hent_next; /* next entry in chain */
17 HEK *hent_hek; /* hash key */
19 SV *hent_val; /* scalar value that was hashed */
20 Size_t hent_refcount; /* references for this shared hash key */
24 /* hash key -- defined separately for use as shared pointer */
26 U32 hek_hash; /* hash of key */
27 I32 hek_len; /* length of hash key */
28 char hek_key[1]; /* variable-length hash key */
29 /* the hash-key is \0-terminated */
30 /* after the \0 there is a byte for flags, such as whether the key
35 struct he shared_he_he;
36 struct hek shared_he_hek;
40 Don't access this directly.
41 Use the funcs in mro.c
45 AV *(*resolve)(pTHX_ HV* stash, U32 level);
48 U16 kflags; /* For the hash API - set HVhek_UTF8 if name is UTF-8 */
53 /* a hash holding the different MROs private data. */
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;
59 HV *mro_nextmethod; /* next::method caching */
60 U32 cache_gen; /* Bumping this invalidates our method cache */
61 U32 pkg_gen; /* Bumps when local methods/@ISA change */
62 const struct mro_alg *mro_which; /* which mro alg is in use? */
63 HV *isa; /* Everything this class @ISA */
66 #define MRO_GET_PRIVATE_DATA(smeta, which) \
67 (((smeta)->mro_which && (which) == (smeta)->mro_which) \
68 ? (smeta)->mro_linear_current \
69 : Perl_mro_get_private_data(aTHX_ (smeta), (which)))
72 Don't access this directly.
76 HEK *xhvnameu_name; /* When xhv_name_count is 0 */
77 HEK **xhvnameu_names; /* When xhv_name_count is non-0 */
81 union _xhvnameu xhv_name_u; /* name, if a symbol table */
82 AV *xhv_backreferences; /* back references for weak references */
83 HE *xhv_eiter; /* current entry of iterator */
84 I32 xhv_riter; /* current root of iterator */
85 /* Concerning xhv_name_count: When non-zero, xhv_name_u contains a pointer
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-
89 * tive, then xhv_name_u.xhvnameu_names[1] is the first effective name.
92 struct mro_meta *xhv_mro_meta;
93 HV * xhv_super; /* SUPER method cache */
97 /* This structure must match the beginning of struct xpvmg in sv.h. */
99 HV* xmg_stash; /* class package */
101 STRLEN xhv_keys; /* total keys, including placeholders */
102 STRLEN xhv_max; /* subscript of last element of xhv_array */
106 /* FYI: This is the "One-at-a-Time" algorithm by Bob Jenkins
107 * from requirements by Colin Plumb.
108 * (http://burtleburtle.net/bob/hash/doobs.html) */
109 /* The use of a temporary pointer and the casting games
110 * is needed to serve the dual purposes of
111 * (a) the hashed data being interpreted as "unsigned char" (new since 5.8,
112 * a "char" can be either signed or unsigned, depending on the compiler)
113 * (b) catering for old code that uses a "char"
115 * The "hash seed" feature was added in Perl 5.8.1 to perturb the results
116 * to avoid "algorithmic complexity attacks".
118 * If USE_HASH_SEED is defined, hash randomisation is done by default
119 * If USE_HASH_SEED_EXPLICIT is defined, hash randomisation is done
120 * only if the environment variable PERL_HASH_SEED is set.
121 * For maximal control, one can define PERL_HASH_SEED.
122 * (see also perl.c:perl_parse()).
124 #ifndef PERL_HASH_SEED
125 # if defined(USE_HASH_SEED) || defined(USE_HASH_SEED_EXPLICIT)
126 # define PERL_HASH_SEED PL_hash_seed
128 # define PERL_HASH_SEED 0
132 #define PERL_HASH(hash,str,len) PERL_HASH_INTERNAL_(hash,str,len,0)
134 /* Only hv.c and mod_perl should be doing this. */
135 #ifdef PERL_HASH_INTERNAL_ACCESS
136 #define PERL_HASH_INTERNAL(hash,str,len) PERL_HASH_INTERNAL_(hash,str,len,1)
139 /* Common base for PERL_HASH and PERL_HASH_INTERNAL that parameterises
140 * the source of the seed. Not for direct use outside of hv.c. */
142 #define PERL_HASH_INTERNAL_(hash,str,len,internal) \
144 const char * const s_PeRlHaSh_tmp = str; \
145 const unsigned char *s_PeRlHaSh = (const unsigned char *)s_PeRlHaSh_tmp; \
146 I32 i_PeRlHaSh = len; \
147 U32 hash_PeRlHaSh = (internal ? PL_rehash_seed : PERL_HASH_SEED); \
148 while (i_PeRlHaSh--) { \
149 hash_PeRlHaSh += *s_PeRlHaSh++; \
150 hash_PeRlHaSh += (hash_PeRlHaSh << 10); \
151 hash_PeRlHaSh ^= (hash_PeRlHaSh >> 6); \
153 hash_PeRlHaSh += (hash_PeRlHaSh << 3); \
154 hash_PeRlHaSh ^= (hash_PeRlHaSh >> 11); \
155 (hash) = (hash_PeRlHaSh + (hash_PeRlHaSh << 15)); \
159 =head1 Hash Manipulation Functions
161 =for apidoc AmU||HEf_SVKEY
162 This flag, used in the length slot of hash entries and magic structures,
163 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
164 is to be expected. (For information only--not to be used).
168 =for apidoc AmU||Nullhv
171 (deprecated - use C<(HV *)NULL> instead)
173 =head1 Hash Manipulation Functions
175 =for apidoc Am|char*|HvNAME|HV* stash
176 Returns the package name of a stash, or NULL if C<stash> isn't a stash.
177 See C<SvSTASH>, C<CvSTASH>.
179 =for apidoc Am|STRLEN|HvNAMELEN|HV *stash
180 Returns the length of the stash's name.
182 =for apidoc Am|unsigned char|HvNAMEUTF8|HV *stash
183 Returns true if the name is in UTF8 encoding.
185 =for apidoc Am|char*|HvENAME|HV* stash
186 Returns the effective name of a stash, or NULL if there is none. The
187 effective name represents a location in the symbol table where this stash
188 resides. It is updated automatically when packages are aliased or deleted.
189 A stash that is no longer in the symbol table has no effective name. This
190 name is preferable to C<HvNAME> for use in MRO linearisations and isa
193 =for apidoc Am|STRLEN|HvENAMELEN|HV *stash
194 Returns the length of the stash's effective name.
196 =for apidoc Am|unsigned char|HvENAMEUTF8|HV *stash
197 Returns true if the effective name is in UTF8 encoding.
199 =for apidoc Am|void*|HeKEY|HE* he
200 Returns the actual pointer stored in the key slot of the hash entry. The
201 pointer may be either C<char*> or C<SV*>, depending on the value of
202 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
203 usually preferable for finding the value of a key.
205 =for apidoc Am|STRLEN|HeKLEN|HE* he
206 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
207 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
208 be assigned to. The C<HePV()> macro is usually preferable for finding key
211 =for apidoc Am|SV*|HeVAL|HE* he
212 Returns the value slot (type C<SV*>) stored in the hash entry. Can be assigned
219 =for apidoc Am|U32|HeHASH|HE* he
220 Returns the computed hash stored in the hash entry.
222 =for apidoc Am|char*|HePV|HE* he|STRLEN len
223 Returns the key slot of the hash entry as a C<char*> value, doing any
224 necessary dereferencing of possibly C<SV*> keys. The length of the string
225 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
226 not care about what the length of the key is, you may use the global
227 variable C<PL_na>, though this is rather less efficient than using a local
228 variable. Remember though, that hash keys in perl are free to contain
229 embedded nulls, so using C<strlen()> or similar is not a good way to find
230 the length of hash keys. This is very similar to the C<SvPV()> macro
231 described elsewhere in this document. See also C<HeUTF8>.
233 If you are using C<HePV> to get values to pass to C<newSVpvn()> to create a
234 new SV, you should consider using C<newSVhek(HeKEY_hek(he))> as it is more
237 =for apidoc Am|char*|HeUTF8|HE* he
238 Returns whether the C<char *> value returned by C<HePV> is encoded in UTF-8,
239 doing any necessary dereferencing of possibly C<SV*> keys. The value returned
240 will be 0 or non-0, not necessarily 1 (or even a value with any low bits set),
241 so B<do not> blindly assign this to a C<bool> variable, as C<bool> may be a
244 =for apidoc Am|SV*|HeSVKEY|HE* he
245 Returns the key as an C<SV*>, or C<NULL> if the hash entry does not
246 contain an C<SV*> key.
248 =for apidoc Am|SV*|HeSVKEY_force|HE* he
249 Returns the key as an C<SV*>. Will create and return a temporary mortal
250 C<SV*> if the hash entry contains only a C<char*> key.
252 =for apidoc Am|SV*|HeSVKEY_set|HE* he|SV* sv
253 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
254 indicate the presence of an C<SV*> key, and returns the same
260 /* these hash entry flags ride on hent_klen (for use only in magic/tied HVs) */
261 #define HEf_SVKEY -2 /* hent_key is an SV* */
264 # define Nullhv Null(HV*)
266 #define HvARRAY(hv) ((hv)->sv_u.svu_hash)
267 #define HvFILL(hv) Perl_hv_fill(aTHX_ (const HV *)(hv))
268 #define HvMAX(hv) ((XPVHV*) SvANY(hv))->xhv_max
269 /* This quite intentionally does no flag checking first. That's your
271 #define HvAUX(hv) ((struct xpvhv_aux*)&(HvARRAY(hv)[HvMAX(hv)+1]))
272 #define HvRITER(hv) (*Perl_hv_riter_p(aTHX_ MUTABLE_HV(hv)))
273 #define HvEITER(hv) (*Perl_hv_eiter_p(aTHX_ MUTABLE_HV(hv)))
274 #define HvRITER_set(hv,r) Perl_hv_riter_set(aTHX_ MUTABLE_HV(hv), r)
275 #define HvEITER_set(hv,e) Perl_hv_eiter_set(aTHX_ MUTABLE_HV(hv), e)
276 #define HvRITER_get(hv) (SvOOK(hv) ? HvAUX(hv)->xhv_riter : -1)
277 #define HvEITER_get(hv) (SvOOK(hv) ? HvAUX(hv)->xhv_eiter : NULL)
278 #define HvNAME(hv) HvNAME_get(hv)
279 #define HvNAMELEN(hv) HvNAMELEN_get(hv)
280 #define HvENAME(hv) HvENAME_get(hv)
281 #define HvENAMELEN(hv) HvENAMELEN_get(hv)
283 /* Checking that hv is a valid package stash is the
284 caller's responsibility */
285 #define HvMROMETA(hv) (HvAUX(hv)->xhv_mro_meta \
286 ? HvAUX(hv)->xhv_mro_meta \
287 : Perl_mro_meta_init(aTHX_ hv))
289 #define HvNAME_HEK_NN(hv) \
291 HvAUX(hv)->xhv_name_count \
292 ? *HvAUX(hv)->xhv_name_u.xhvnameu_names \
293 : HvAUX(hv)->xhv_name_u.xhvnameu_name \
295 /* This macro may go away without notice. */
296 #define HvNAME_HEK(hv) \
297 (SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name ? HvNAME_HEK_NN(hv) : NULL)
298 #define HvNAME_get(hv) \
299 ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvNAME_HEK_NN(hv)) \
300 ? HEK_KEY(HvNAME_HEK_NN(hv)) : NULL)
301 #define HvNAMELEN_get(hv) \
302 ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvNAME_HEK_NN(hv)) \
303 ? HEK_LEN(HvNAME_HEK_NN(hv)) : 0)
304 #define HvNAMEUTF8(hv) \
305 ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvNAME_HEK_NN(hv)) \
306 ? HEK_UTF8(HvNAME_HEK_NN(hv)) : 0)
307 #define HvENAME_HEK_NN(hv) \
309 HvAUX(hv)->xhv_name_count > 0 ? HvAUX(hv)->xhv_name_u.xhvnameu_names[0] : \
310 HvAUX(hv)->xhv_name_count < -1 ? HvAUX(hv)->xhv_name_u.xhvnameu_names[1] : \
311 HvAUX(hv)->xhv_name_count == -1 ? NULL : \
312 HvAUX(hv)->xhv_name_u.xhvnameu_name \
314 #define HvENAME_HEK(hv) \
315 (SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name ? HvENAME_HEK_NN(hv) : NULL)
316 #define HvENAME_get(hv) \
317 ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvAUX(hv)->xhv_name_count != -1) \
318 ? HEK_KEY(HvENAME_HEK_NN(hv)) : NULL)
319 #define HvENAMELEN_get(hv) \
320 ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvAUX(hv)->xhv_name_count != -1) \
321 ? HEK_LEN(HvENAME_HEK_NN(hv)) : 0)
322 #define HvENAMEUTF8(hv) \
323 ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvAUX(hv)->xhv_name_count != -1) \
324 ? HEK_UTF8(HvENAME_HEK_NN(hv)) : 0)
326 /* the number of keys (including any placeholders) */
327 #define XHvTOTALKEYS(xhv) ((xhv)->xhv_keys)
330 * HvKEYS gets the number of keys that actually exist(), and is provided
331 * for backwards compatibility with old XS code. The core uses HvUSEDKEYS
332 * (keys, excluding placeholders) and HvTOTALKEYS (including placeholders)
334 #define HvKEYS(hv) HvUSEDKEYS(hv)
335 #define HvUSEDKEYS(hv) (HvTOTALKEYS(hv) - HvPLACEHOLDERS_get(hv))
336 #define HvTOTALKEYS(hv) XHvTOTALKEYS((XPVHV*) SvANY(hv))
337 #define HvPLACEHOLDERS(hv) (*Perl_hv_placeholders_p(aTHX_ MUTABLE_HV(hv)))
338 #define HvPLACEHOLDERS_get(hv) (SvMAGIC(hv) ? Perl_hv_placeholders_get(aTHX_ (const HV *)hv) : 0)
339 #define HvPLACEHOLDERS_set(hv,p) Perl_hv_placeholders_set(aTHX_ MUTABLE_HV(hv), p)
341 #define HvSHAREKEYS(hv) (SvFLAGS(hv) & SVphv_SHAREKEYS)
342 #define HvSHAREKEYS_on(hv) (SvFLAGS(hv) |= SVphv_SHAREKEYS)
343 #define HvSHAREKEYS_off(hv) (SvFLAGS(hv) &= ~SVphv_SHAREKEYS)
345 /* This is an optimisation flag. It won't be set if all hash keys have a 0
346 * flag. Currently the only flags relate to utf8.
347 * Hence it won't be set if all keys are 8 bit only. It will be set if any key
348 * is utf8 (including 8 bit keys that were entered as utf8, and need upgrading
349 * when retrieved during iteration. It may still be set when there are no longer
351 * See HVhek_ENABLEHVKFLAGS for the trigger.
353 #define HvHASKFLAGS(hv) (SvFLAGS(hv) & SVphv_HASKFLAGS)
354 #define HvHASKFLAGS_on(hv) (SvFLAGS(hv) |= SVphv_HASKFLAGS)
355 #define HvHASKFLAGS_off(hv) (SvFLAGS(hv) &= ~SVphv_HASKFLAGS)
357 #define HvLAZYDEL(hv) (SvFLAGS(hv) & SVphv_LAZYDEL)
358 #define HvLAZYDEL_on(hv) (SvFLAGS(hv) |= SVphv_LAZYDEL)
359 #define HvLAZYDEL_off(hv) (SvFLAGS(hv) &= ~SVphv_LAZYDEL)
361 #define HvREHASH(hv) (SvFLAGS(hv) & SVphv_REHASH)
362 #define HvREHASH_on(hv) (SvFLAGS(hv) |= SVphv_REHASH)
363 #define HvREHASH_off(hv) (SvFLAGS(hv) &= ~SVphv_REHASH)
366 # define Nullhe Null(HE*)
368 #define HeNEXT(he) (he)->hent_next
369 #define HeKEY_hek(he) (he)->hent_hek
370 #define HeKEY(he) HEK_KEY(HeKEY_hek(he))
371 #define HeKEY_sv(he) (*(SV**)HeKEY(he))
372 #define HeKLEN(he) HEK_LEN(HeKEY_hek(he))
373 #define HeKUTF8(he) HEK_UTF8(HeKEY_hek(he))
374 #define HeKWASUTF8(he) HEK_WASUTF8(HeKEY_hek(he))
375 #define HeKREHASH(he) HEK_REHASH(HeKEY_hek(he))
376 #define HeKLEN_UTF8(he) (HeKUTF8(he) ? -HeKLEN(he) : HeKLEN(he))
377 #define HeKFLAGS(he) HEK_FLAGS(HeKEY_hek(he))
378 #define HeVAL(he) (he)->he_valu.hent_val
379 #define HeHASH(he) HEK_HASH(HeKEY_hek(he))
380 #define HePV(he,lp) ((HeKLEN(he) == HEf_SVKEY) ? \
381 SvPV(HeKEY_sv(he),lp) : \
382 ((lp = HeKLEN(he)), HeKEY(he)))
383 #define HeUTF8(he) ((HeKLEN(he) == HEf_SVKEY) ? \
384 SvUTF8(HeKEY_sv(he)) : \
387 #define HeSVKEY(he) ((HeKEY(he) && \
388 HeKLEN(he) == HEf_SVKEY) ? \
391 #define HeSVKEY_force(he) (HeKEY(he) ? \
392 ((HeKLEN(he) == HEf_SVKEY) ? \
394 newSVpvn_flags(HeKEY(he), \
395 HeKLEN(he), SVs_TEMP)) : \
397 #define HeSVKEY_set(he,sv) ((HeKLEN(he) = HEf_SVKEY), (HeKEY_sv(he) = sv))
400 # define Nullhek Null(HEK*)
402 #define HEK_BASESIZE STRUCT_OFFSET(HEK, hek_key[0])
403 #define HEK_HASH(hek) (hek)->hek_hash
404 #define HEK_LEN(hek) (hek)->hek_len
405 #define HEK_KEY(hek) (hek)->hek_key
406 #define HEK_FLAGS(hek) (*((unsigned char *)(HEK_KEY(hek))+HEK_LEN(hek)+1))
408 #define HVhek_UTF8 0x01 /* Key is utf8 encoded. */
409 #define HVhek_WASUTF8 0x02 /* Key is bytes here, but was supplied as utf8. */
410 #define HVhek_REHASH 0x04 /* This key is in an hv using a custom HASH . */
411 #define HVhek_UNSHARED 0x08 /* This key isn't a shared hash key. */
412 #define HVhek_FREEKEY 0x100 /* Internal flag to say key is malloc()ed. */
413 #define HVhek_PLACEHOLD 0x200 /* Internal flag to create placeholder.
414 * (may change, but Storable is a core module) */
415 #define HVhek_KEYCANONICAL 0x400 /* Internal flag - key is in canonical form.
416 If the string is UTF-8, it cannot be
417 converted to bytes. */
418 #define HVhek_MASK 0xFF
420 /* Which flags enable HvHASKFLAGS? Somewhat a hack on a hack, as
421 HVhek_REHASH is only needed because the rehash flag has to be duplicated
422 into all keys as hv_iternext has no access to the hash flags. At this
423 point Storable's tests get upset, because sometimes hashes are "keyed"
424 and sometimes not, depending on the order of data insertion, and whether
425 it triggered rehashing. So currently HVhek_REHASH is exempt.
429 #define HVhek_ENABLEHVKFLAGS (HVhek_MASK & ~(HVhek_REHASH|HVhek_UNSHARED))
431 #define HEK_UTF8(hek) (HEK_FLAGS(hek) & HVhek_UTF8)
432 #define HEK_UTF8_on(hek) (HEK_FLAGS(hek) |= HVhek_UTF8)
433 #define HEK_UTF8_off(hek) (HEK_FLAGS(hek) &= ~HVhek_UTF8)
434 #define HEK_WASUTF8(hek) (HEK_FLAGS(hek) & HVhek_WASUTF8)
435 #define HEK_WASUTF8_on(hek) (HEK_FLAGS(hek) |= HVhek_WASUTF8)
436 #define HEK_WASUTF8_off(hek) (HEK_FLAGS(hek) &= ~HVhek_WASUTF8)
437 #define HEK_REHASH(hek) (HEK_FLAGS(hek) & HVhek_REHASH)
438 #define HEK_REHASH_on(hek) (HEK_FLAGS(hek) |= HVhek_REHASH)
440 /* calculate HV array allocation */
441 #ifndef PERL_USE_LARGE_HV_ALLOC
442 /* Default to allocating the correct size - default to assuming that malloc()
443 is not broken and is efficient at allocating blocks sized at powers-of-two.
445 # define PERL_HV_ARRAY_ALLOC_BYTES(size) ((size) * sizeof(HE*))
447 # define MALLOC_OVERHEAD 16
448 # define PERL_HV_ARRAY_ALLOC_BYTES(size) \
450 ? (size) * sizeof(HE*) \
451 : (size) * sizeof(HE*) * 2 - MALLOC_OVERHEAD)
454 /* Flags for hv_iternext_flags. */
455 #define HV_ITERNEXT_WANTPLACEHOLDERS 0x01 /* Don't skip placeholders. */
457 #define hv_iternext(hv) hv_iternext_flags(hv, 0)
458 #define hv_magic(hv, gv, how) sv_magic(MUTABLE_SV(hv), MUTABLE_SV(gv), how, NULL, 0)
459 #define hv_undef(hv) Perl_hv_undef_flags(aTHX_ hv, 0)
461 #define Perl_sharepvn(pv, len, hash) HEK_KEY(share_hek(pv, len, hash))
462 #define sharepvn(pv, len, hash) Perl_sharepvn(pv, len, hash)
464 #define share_hek_hek(hek) \
465 (++(((struct shared_he *)(((char *)hek) \
466 - STRUCT_OFFSET(struct shared_he, \
468 ->shared_he_he.he_valu.hent_refcount), \
471 #define hv_store_ent(hv, keysv, val, hash) \
472 ((HE *) hv_common((hv), (keysv), NULL, 0, 0, HV_FETCH_ISSTORE, \
475 #define hv_exists_ent(hv, keysv, hash) \
476 (hv_common((hv), (keysv), NULL, 0, 0, HV_FETCH_ISEXISTS, 0, (hash)) \
478 #define hv_fetch_ent(hv, keysv, lval, hash) \
479 ((HE *) hv_common((hv), (keysv), NULL, 0, 0, \
480 ((lval) ? HV_FETCH_LVALUE : 0), NULL, (hash)))
481 #define hv_delete_ent(hv, key, flags, hash) \
482 (MUTABLE_SV(hv_common((hv), (key), NULL, 0, 0, (flags) | HV_DELETE, \
485 #define hv_store_flags(hv, key, klen, val, hash, flags) \
486 ((SV**) hv_common((hv), NULL, (key), (klen), (flags), \
487 (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV), (val), \
490 #define hv_store(hv, key, klen, val, hash) \
491 ((SV**) hv_common_key_len((hv), (key), (klen), \
492 (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV), \
495 #define hv_exists(hv, key, klen) \
496 (hv_common_key_len((hv), (key), (klen), HV_FETCH_ISEXISTS, NULL, 0) \
499 #define hv_fetch(hv, key, klen, lval) \
500 ((SV**) hv_common_key_len((hv), (key), (klen), (lval) \
501 ? (HV_FETCH_JUST_SV | HV_FETCH_LVALUE) \
502 : HV_FETCH_JUST_SV, NULL, 0))
504 #define hv_delete(hv, key, klen, flags) \
505 (MUTABLE_SV(hv_common_key_len((hv), (key), (klen), \
506 (flags) | HV_DELETE, NULL, 0)))
508 /* This refcounted he structure is used for storing the hints used for lexical
509 pragmas. Without threads, it's basically struct he + refcount.
510 With threads, life gets more complex as the structure needs to be shared
511 between threads (because it hangs from OPs, which are shared), hence the
512 alternate definition and mutex. */
514 struct refcounted_he;
516 /* flags for the refcounted_he API */
517 #define REFCOUNTED_HE_KEY_UTF8 0x00000001
519 # define REFCOUNTED_HE_EXISTS 0x00000002
524 /* Gosh. This really isn't a good name any longer. */
525 struct refcounted_he {
526 struct refcounted_he *refcounted_he_next; /* next entry in chain */
528 U32 refcounted_he_hash;
529 U32 refcounted_he_keylen;
531 HEK *refcounted_he_hek; /* hint key */
534 IV refcounted_he_u_iv;
535 UV refcounted_he_u_uv;
536 STRLEN refcounted_he_u_len;
537 void *refcounted_he_u_ptr; /* Might be useful in future */
539 U32 refcounted_he_refcnt; /* reference count */
540 /* First byte is flags. Then NUL-terminated value. Then for ithreads,
541 non-NUL terminated key. */
542 char refcounted_he_data[1];
546 =for apidoc m|SV *|refcounted_he_fetch_pvs|const struct refcounted_he *chain|const char *key|U32 flags
548 Like L</refcounted_he_fetch_pvn>, but takes a literal string instead of
549 a string/length pair, and no precomputed hash.
554 #define refcounted_he_fetch_pvs(chain, key, flags) \
555 Perl_refcounted_he_fetch_pvn(aTHX_ chain, STR_WITH_LEN(key), 0, flags)
558 =for apidoc m|struct refcounted_he *|refcounted_he_new_pvs|struct refcounted_he *parent|const char *key|SV *value|U32 flags
560 Like L</refcounted_he_new_pvn>, but takes a literal string instead of
561 a string/length pair, and no precomputed hash.
566 #define refcounted_he_new_pvs(parent, key, value, flags) \
567 Perl_refcounted_he_new_pvn(aTHX_ parent, STR_WITH_LEN(key), 0, value, flags)
569 /* Flag bits are HVhek_UTF8, HVhek_WASUTF8, then */
570 #define HVrhek_undef 0x00 /* Value is undef. */
571 #define HVrhek_delete 0x10 /* Value is placeholder - signifies delete. */
572 #define HVrhek_IV 0x20 /* Value is IV. */
573 #define HVrhek_UV 0x30 /* Value is UV. */
574 #define HVrhek_PV 0x40 /* Value is a (byte) string. */
575 #define HVrhek_PV_UTF8 0x50 /* Value is a (utf8) string. */
576 /* Two spare. As these have to live in the optree, you can't store anything
577 interpreter specific, such as SVs. :-( */
578 #define HVrhek_typemask 0x70
581 /* A big expression to find the key offset */
582 #define REF_HE_KEY(chain) \
583 ((((chain->refcounted_he_data[0] & 0x60) == 0x40) \
584 ? chain->refcounted_he_val.refcounted_he_u_len + 1 : 0) \
585 + 1 + chain->refcounted_he_data)
589 # define HINTS_REFCNT_LOCK MUTEX_LOCK(&PL_hints_mutex)
590 # define HINTS_REFCNT_UNLOCK MUTEX_UNLOCK(&PL_hints_mutex)
592 # define HINTS_REFCNT_LOCK NOOP
593 # define HINTS_REFCNT_UNLOCK NOOP
598 # define HINTS_REFCNT_INIT MUTEX_INIT(&PL_hints_mutex)
599 # define HINTS_REFCNT_TERM MUTEX_DESTROY(&PL_hints_mutex)
601 # define HINTS_REFCNT_INIT NOOP
602 # define HINTS_REFCNT_TERM NOOP
606 * Passed in PERL_MAGIC_uvar calls
608 #define HV_DISABLE_UVAR_XKEY 0x01
609 /* We need to ensure that these don't clash with G_DISCARD, which is 2, as it
610 is documented as being passed to hv_delete(). */
611 #define HV_FETCH_ISSTORE 0x04
612 #define HV_FETCH_ISEXISTS 0x08
613 #define HV_FETCH_LVALUE 0x10
614 #define HV_FETCH_JUST_SV 0x20
615 #define HV_DELETE 0x40
616 #define HV_FETCH_EMPTY_HE 0x80 /* Leave HeVAL null. */
618 /* Must not conflict with HVhek_UTF8 */
619 #define HV_NAME_SETALL 0x02
624 Creates a new HV. The reference count is set to 1.
629 #define newHV() MUTABLE_HV(newSV_type(SVt_PVHV))
633 * c-indentation-style: bsd
635 * indent-tabs-mode: nil
638 * ex: set ts=8 sts=4 sw=4 et: