3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4 * 2001, 2002, 2003, 2004, 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.
12 * I sit beside the fire and think
13 * of all that I have seen.
16 * [p.278 of _The Lord of the Rings_, II/iii: "The Ring Goes South"]
20 =head1 Hash Manipulation Functions
22 A HV structure represents a Perl hash. It consists mainly of an array
23 of pointers, each of which points to a linked list of HE structures. The
24 array is indexed by the hash function of the key, so each linked list
25 represents all the hash entries with the same hash value. Each HE contains
26 a pointer to the actual value, plus a pointer to a HEK structure which
27 holds the key and hash value.
35 #define PERL_HASH_INTERNAL_ACCESS
38 #define HV_MAX_LENGTH_BEFORE_SPLIT 14
40 static const char S_strtab_error[]
41 = "Cannot modify shared string table in hv_%s";
45 #define new_HE() (HE*)safemalloc(sizeof(HE))
46 #define del_HE(p) safefree((char*)p)
55 void ** const root = &PL_body_roots[HE_SVSLOT];
58 Perl_more_bodies(aTHX_ HE_SVSLOT, sizeof(HE), PERL_ARENA_SIZE);
65 #define new_HE() new_he()
68 HeNEXT(p) = (HE*)(PL_body_roots[HE_SVSLOT]); \
69 PL_body_roots[HE_SVSLOT] = p; \
77 S_save_hek_flags(const char *str, I32 len, U32 hash, int flags)
79 const int flags_masked = flags & HVhek_MASK;
83 PERL_ARGS_ASSERT_SAVE_HEK_FLAGS;
85 Newx(k, HEK_BASESIZE + len + 2, char);
87 Copy(str, HEK_KEY(hek), len, char);
88 HEK_KEY(hek)[len] = 0;
91 HEK_FLAGS(hek) = (unsigned char)flags_masked | HVhek_UNSHARED;
93 if (flags & HVhek_FREEKEY)
98 /* free the pool of temporary HE/HEK pairs returned by hv_fetch_ent
102 Perl_free_tied_hv_pool(pTHX)
105 HE *he = PL_hv_fetch_ent_mh;
108 Safefree(HeKEY_hek(he));
112 PL_hv_fetch_ent_mh = NULL;
115 #if defined(USE_ITHREADS)
117 Perl_hek_dup(pTHX_ HEK *source, CLONE_PARAMS* param)
121 PERL_ARGS_ASSERT_HEK_DUP;
122 PERL_UNUSED_ARG(param);
127 shared = (HEK*)ptr_table_fetch(PL_ptr_table, source);
129 /* We already shared this hash key. */
130 (void)share_hek_hek(shared);
134 = share_hek_flags(HEK_KEY(source), HEK_LEN(source),
135 HEK_HASH(source), HEK_FLAGS(source));
136 ptr_table_store(PL_ptr_table, source, shared);
142 Perl_he_dup(pTHX_ const HE *e, bool shared, CLONE_PARAMS* param)
146 PERL_ARGS_ASSERT_HE_DUP;
150 /* look for it in the table first */
151 ret = (HE*)ptr_table_fetch(PL_ptr_table, e);
155 /* create anew and remember what it is */
157 ptr_table_store(PL_ptr_table, e, ret);
159 HeNEXT(ret) = he_dup(HeNEXT(e),shared, param);
160 if (HeKLEN(e) == HEf_SVKEY) {
162 Newx(k, HEK_BASESIZE + sizeof(const SV *), char);
163 HeKEY_hek(ret) = (HEK*)k;
164 HeKEY_sv(ret) = sv_dup_inc(HeKEY_sv(e), param);
167 /* This is hek_dup inlined, which seems to be important for speed
169 HEK * const source = HeKEY_hek(e);
170 HEK *shared = (HEK*)ptr_table_fetch(PL_ptr_table, source);
173 /* We already shared this hash key. */
174 (void)share_hek_hek(shared);
178 = share_hek_flags(HEK_KEY(source), HEK_LEN(source),
179 HEK_HASH(source), HEK_FLAGS(source));
180 ptr_table_store(PL_ptr_table, source, shared);
182 HeKEY_hek(ret) = shared;
185 HeKEY_hek(ret) = save_hek_flags(HeKEY(e), HeKLEN(e), HeHASH(e),
187 HeVAL(ret) = sv_dup_inc(HeVAL(e), param);
190 #endif /* USE_ITHREADS */
193 S_hv_notallowed(pTHX_ int flags, const char *key, I32 klen,
196 SV * const sv = sv_newmortal();
198 PERL_ARGS_ASSERT_HV_NOTALLOWED;
200 if (!(flags & HVhek_FREEKEY)) {
201 sv_setpvn(sv, key, klen);
204 /* Need to free saved eventually assign to mortal SV */
205 /* XXX is this line an error ???: SV *sv = sv_newmortal(); */
206 sv_usepvn(sv, (char *) key, klen);
208 if (flags & HVhek_UTF8) {
211 Perl_croak(aTHX_ msg, SVfARG(sv));
214 /* (klen == HEf_SVKEY) is special for MAGICAL hv entries, meaning key slot
220 Stores an SV in a hash. The hash key is specified as C<key> and the
221 absolute value of C<klen> is the length of the key. If C<klen> is
222 negative the key is assumed to be in UTF-8-encoded Unicode. The
223 C<hash> parameter is the precomputed hash value; if it is zero then
224 Perl will compute it.
226 The return value will be
227 NULL if the operation failed or if the value did not need to be actually
228 stored within the hash (as in the case of tied hashes). Otherwise it can
229 be dereferenced to get the original C<SV*>. Note that the caller is
230 responsible for suitably incrementing the reference count of C<val> before
231 the call, and decrementing it if the function returned NULL. Effectively
232 a successful hv_store takes ownership of one reference to C<val>. This is
233 usually what you want; a newly created SV has a reference count of one, so
234 if all your code does is create SVs then store them in a hash, hv_store
235 will own the only reference to the new SV, and your code doesn't need to do
236 anything further to tidy up. hv_store is not implemented as a call to
237 hv_store_ent, and does not create a temporary SV for the key, so if your
238 key data is not already in SV form then use hv_store in preference to
241 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
242 information on how to use this function on tied hashes.
244 =for apidoc hv_store_ent
246 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
247 parameter is the precomputed hash value; if it is zero then Perl will
248 compute it. The return value is the new hash entry so created. It will be
249 NULL if the operation failed or if the value did not need to be actually
250 stored within the hash (as in the case of tied hashes). Otherwise the
251 contents of the return value can be accessed using the C<He?> macros
252 described here. Note that the caller is responsible for suitably
253 incrementing the reference count of C<val> before the call, and
254 decrementing it if the function returned NULL. Effectively a successful
255 hv_store_ent takes ownership of one reference to C<val>. This is
256 usually what you want; a newly created SV has a reference count of one, so
257 if all your code does is create SVs then store them in a hash, hv_store
258 will own the only reference to the new SV, and your code doesn't need to do
259 anything further to tidy up. Note that hv_store_ent only reads the C<key>;
260 unlike C<val> it does not take ownership of it, so maintaining the correct
261 reference count on C<key> is entirely the caller's responsibility. hv_store
262 is not implemented as a call to hv_store_ent, and does not create a temporary
263 SV for the key, so if your key data is not already in SV form then use
264 hv_store in preference to hv_store_ent.
266 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
267 information on how to use this function on tied hashes.
269 =for apidoc hv_exists
271 Returns a boolean indicating whether the specified hash key exists. The
272 absolute value of C<klen> is the length of the key. If C<klen> is
273 negative the key is assumed to be in UTF-8-encoded Unicode.
277 Returns the SV which corresponds to the specified key in the hash.
278 The absolute value of C<klen> is the length of the key. If C<klen> is
279 negative the key is assumed to be in UTF-8-encoded Unicode. If
280 C<lval> is set then the fetch will be part of a store. Check that the
281 return value is non-null before dereferencing it to an C<SV*>.
283 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
284 information on how to use this function on tied hashes.
286 =for apidoc hv_exists_ent
288 Returns a boolean indicating whether the specified hash key exists. C<hash>
289 can be a valid precomputed hash value, or 0 to ask for it to be
295 /* returns an HE * structure with the all fields set */
296 /* note that hent_val will be a mortal sv for MAGICAL hashes */
298 =for apidoc hv_fetch_ent
300 Returns the hash entry which corresponds to the specified key in the hash.
301 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
302 if you want the function to compute it. IF C<lval> is set then the fetch
303 will be part of a store. Make sure the return value is non-null before
304 accessing it. The return value when C<hv> is a tied hash is a pointer to a
305 static location, so be sure to make a copy of the structure if you need to
308 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
309 information on how to use this function on tied hashes.
314 /* Common code for hv_delete()/hv_exists()/hv_fetch()/hv_store() */
316 Perl_hv_common_key_len(pTHX_ HV *hv, const char *key, I32 klen_i32,
317 const int action, SV *val, const U32 hash)
322 PERL_ARGS_ASSERT_HV_COMMON_KEY_LEN;
331 return hv_common(hv, NULL, key, klen, flags, action, val, hash);
335 Perl_hv_common(pTHX_ HV *hv, SV *keysv, const char *key, STRLEN klen,
336 int flags, int action, SV *val, register U32 hash)
345 const int return_svp = action & HV_FETCH_JUST_SV;
349 if (SvTYPE(hv) == (svtype)SVTYPEMASK)
352 assert(SvTYPE(hv) == SVt_PVHV);
354 if (SvSMAGICAL(hv) && SvGMAGICAL(hv) && !(action & HV_DISABLE_UVAR_XKEY)) {
356 if ((mg = mg_find((const SV *)hv, PERL_MAGIC_uvar))) {
357 struct ufuncs * const uf = (struct ufuncs *)mg->mg_ptr;
358 if (uf->uf_set == NULL) {
359 SV* obj = mg->mg_obj;
362 keysv = newSVpvn_flags(key, klen, SVs_TEMP |
363 ((flags & HVhek_UTF8)
367 mg->mg_obj = keysv; /* pass key */
368 uf->uf_index = action; /* pass action */
369 magic_getuvar(MUTABLE_SV(hv), mg);
370 keysv = mg->mg_obj; /* may have changed */
373 /* If the key may have changed, then we need to invalidate
374 any passed-in computed hash value. */
380 if (flags & HVhek_FREEKEY)
382 key = SvPV_const(keysv, klen);
383 is_utf8 = (SvUTF8(keysv) != 0);
384 if (SvIsCOW_shared_hash(keysv)) {
385 flags = HVhek_KEYCANONICAL | (is_utf8 ? HVhek_UTF8 : 0);
390 is_utf8 = ((flags & HVhek_UTF8) ? TRUE : FALSE);
393 if (action & HV_DELETE) {
394 return (void *) hv_delete_common(hv, keysv, key, klen,
395 flags | (is_utf8 ? HVhek_UTF8 : 0),
399 xhv = (XPVHV*)SvANY(hv);
401 if (SvRMAGICAL(hv) && !(action & (HV_FETCH_ISSTORE|HV_FETCH_ISEXISTS))) {
402 if (mg_find((const SV *)hv, PERL_MAGIC_tied)
403 || SvGMAGICAL((const SV *)hv))
405 /* FIXME should be able to skimp on the HE/HEK here when
406 HV_FETCH_JUST_SV is true. */
408 keysv = newSVpvn_utf8(key, klen, is_utf8);
410 keysv = newSVsv(keysv);
413 mg_copy(MUTABLE_SV(hv), sv, (char *)keysv, HEf_SVKEY);
415 /* grab a fake HE/HEK pair from the pool or make a new one */
416 entry = PL_hv_fetch_ent_mh;
418 PL_hv_fetch_ent_mh = HeNEXT(entry);
422 Newx(k, HEK_BASESIZE + sizeof(const SV *), char);
423 HeKEY_hek(entry) = (HEK*)k;
425 HeNEXT(entry) = NULL;
426 HeSVKEY_set(entry, keysv);
428 sv_upgrade(sv, SVt_PVLV);
430 /* so we can free entry when freeing sv */
431 LvTARG(sv) = MUTABLE_SV(entry);
433 /* XXX remove at some point? */
434 if (flags & HVhek_FREEKEY)
438 return entry ? (void *) &HeVAL(entry) : NULL;
440 return (void *) entry;
442 #ifdef ENV_IS_CASELESS
443 else if (mg_find((const SV *)hv, PERL_MAGIC_env)) {
445 for (i = 0; i < klen; ++i)
446 if (isLOWER(key[i])) {
447 /* Would be nice if we had a routine to do the
448 copy and upercase in a single pass through. */
449 const char * const nkey = strupr(savepvn(key,klen));
450 /* Note that this fetch is for nkey (the uppercased
451 key) whereas the store is for key (the original) */
452 void *result = hv_common(hv, NULL, nkey, klen,
453 HVhek_FREEKEY, /* free nkey */
454 0 /* non-LVAL fetch */
455 | HV_DISABLE_UVAR_XKEY
458 0 /* compute hash */);
459 if (!result && (action & HV_FETCH_LVALUE)) {
460 /* This call will free key if necessary.
461 Do it this way to encourage compiler to tail
463 result = hv_common(hv, keysv, key, klen, flags,
465 | HV_DISABLE_UVAR_XKEY
469 if (flags & HVhek_FREEKEY)
477 else if (SvRMAGICAL(hv) && (action & HV_FETCH_ISEXISTS)) {
478 if (mg_find((const SV *)hv, PERL_MAGIC_tied)
479 || SvGMAGICAL((const SV *)hv)) {
480 /* I don't understand why hv_exists_ent has svret and sv,
481 whereas hv_exists only had one. */
482 SV * const svret = sv_newmortal();
485 if (keysv || is_utf8) {
487 keysv = newSVpvn_utf8(key, klen, TRUE);
489 keysv = newSVsv(keysv);
491 mg_copy(MUTABLE_SV(hv), sv, (char *)sv_2mortal(keysv), HEf_SVKEY);
493 mg_copy(MUTABLE_SV(hv), sv, key, klen);
495 if (flags & HVhek_FREEKEY)
497 magic_existspack(svret, mg_find(sv, PERL_MAGIC_tiedelem));
498 /* This cast somewhat evil, but I'm merely using NULL/
499 not NULL to return the boolean exists.
500 And I know hv is not NULL. */
501 return SvTRUE(svret) ? (void *)hv : NULL;
503 #ifdef ENV_IS_CASELESS
504 else if (mg_find((const SV *)hv, PERL_MAGIC_env)) {
505 /* XXX This code isn't UTF8 clean. */
506 char * const keysave = (char * const)key;
507 /* Will need to free this, so set FREEKEY flag. */
508 key = savepvn(key,klen);
509 key = (const char*)strupr((char*)key);
514 if (flags & HVhek_FREEKEY) {
517 flags |= HVhek_FREEKEY;
521 else if (action & HV_FETCH_ISSTORE) {
524 hv_magic_check (hv, &needs_copy, &needs_store);
526 const bool save_taint = PL_tainted;
527 if (keysv || is_utf8) {
529 keysv = newSVpvn_utf8(key, klen, TRUE);
532 PL_tainted = SvTAINTED(keysv);
533 keysv = sv_2mortal(newSVsv(keysv));
534 mg_copy(MUTABLE_SV(hv), val, (char*)keysv, HEf_SVKEY);
536 mg_copy(MUTABLE_SV(hv), val, key, klen);
539 TAINT_IF(save_taint);
541 if (flags & HVhek_FREEKEY)
545 #ifdef ENV_IS_CASELESS
546 else if (mg_find((const SV *)hv, PERL_MAGIC_env)) {
547 /* XXX This code isn't UTF8 clean. */
548 const char *keysave = key;
549 /* Will need to free this, so set FREEKEY flag. */
550 key = savepvn(key,klen);
551 key = (const char*)strupr((char*)key);
556 if (flags & HVhek_FREEKEY) {
559 flags |= HVhek_FREEKEY;
567 if ((action & (HV_FETCH_LVALUE | HV_FETCH_ISSTORE))
568 #ifdef DYNAMIC_ENV_FETCH /* if it's an %ENV lookup, we may get it on the fly */
569 || (SvRMAGICAL((const SV *)hv)
570 && mg_find((const SV *)hv, PERL_MAGIC_env))
575 PERL_HV_ARRAY_ALLOC_BYTES(xhv->xhv_max+1 /* HvMAX(hv)+1 */),
577 HvARRAY(hv) = (HE**)array;
579 #ifdef DYNAMIC_ENV_FETCH
580 else if (action & HV_FETCH_ISEXISTS) {
581 /* for an %ENV exists, if we do an insert it's by a recursive
582 store call, so avoid creating HvARRAY(hv) right now. */
586 /* XXX remove at some point? */
587 if (flags & HVhek_FREEKEY)
594 if (is_utf8 & !(flags & HVhek_KEYCANONICAL)) {
595 char * const keysave = (char *)key;
596 key = (char*)bytes_from_utf8((U8*)key, &klen, &is_utf8);
600 flags &= ~HVhek_UTF8;
601 if (key != keysave) {
602 if (flags & HVhek_FREEKEY)
604 flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
605 /* If the caller calculated a hash, it was on the sequence of
606 octets that are the UTF-8 form. We've now changed the sequence
607 of octets stored to that of the equivalent byte representation,
608 so the hash we need is different. */
613 if (HvREHASH(hv) || (!hash && !(keysv && (SvIsCOW_shared_hash(keysv)))))
614 PERL_HASH_INTERNAL_(hash, key, klen, HvREHASH(hv));
616 hash = SvSHARED_HASH(keysv);
618 /* We don't have a pointer to the hv, so we have to replicate the
619 flag into every HEK, so that hv_iterkeysv can see it.
620 And yes, you do need this even though you are not "storing" because
621 you can flip the flags below if doing an lval lookup. (And that
622 was put in to give the semantics Andreas was expecting.) */
624 flags |= HVhek_REHASH;
626 masked_flags = (flags & HVhek_MASK);
628 #ifdef DYNAMIC_ENV_FETCH
629 if (!HvARRAY(hv)) entry = NULL;
633 entry = (HvARRAY(hv))[hash & (I32) HvMAX(hv)];
635 for (; entry; entry = HeNEXT(entry)) {
636 if (HeHASH(entry) != hash) /* strings can't be equal */
638 if (HeKLEN(entry) != (I32)klen)
640 if (HeKEY(entry) != key && memNE(HeKEY(entry),key,klen)) /* is this it? */
642 if ((HeKFLAGS(entry) ^ masked_flags) & HVhek_UTF8)
645 if (action & (HV_FETCH_LVALUE|HV_FETCH_ISSTORE)) {
646 if (HeKFLAGS(entry) != masked_flags) {
647 /* We match if HVhek_UTF8 bit in our flags and hash key's
648 match. But if entry was set previously with HVhek_WASUTF8
649 and key now doesn't (or vice versa) then we should change
650 the key's flag, as this is assignment. */
651 if (HvSHAREKEYS(hv)) {
652 /* Need to swap the key we have for a key with the flags we
653 need. As keys are shared we can't just write to the
654 flag, so we share the new one, unshare the old one. */
655 HEK * const new_hek = share_hek_flags(key, klen, hash,
657 unshare_hek (HeKEY_hek(entry));
658 HeKEY_hek(entry) = new_hek;
660 else if (hv == PL_strtab) {
661 /* PL_strtab is usually the only hash without HvSHAREKEYS,
662 so putting this test here is cheap */
663 if (flags & HVhek_FREEKEY)
665 Perl_croak(aTHX_ S_strtab_error,
666 action & HV_FETCH_LVALUE ? "fetch" : "store");
669 HeKFLAGS(entry) = masked_flags;
670 if (masked_flags & HVhek_ENABLEHVKFLAGS)
673 if (HeVAL(entry) == &PL_sv_placeholder) {
674 /* yes, can store into placeholder slot */
675 if (action & HV_FETCH_LVALUE) {
677 /* This preserves behaviour with the old hv_fetch
678 implementation which at this point would bail out
679 with a break; (at "if we find a placeholder, we
680 pretend we haven't found anything")
682 That break mean that if a placeholder were found, it
683 caused a call into hv_store, which in turn would
684 check magic, and if there is no magic end up pretty
685 much back at this point (in hv_store's code). */
688 /* LVAL fetch which actually needs a store. */
690 HvPLACEHOLDERS(hv)--;
693 if (val != &PL_sv_placeholder)
694 HvPLACEHOLDERS(hv)--;
697 } else if (action & HV_FETCH_ISSTORE) {
698 SvREFCNT_dec(HeVAL(entry));
701 } else if (HeVAL(entry) == &PL_sv_placeholder) {
702 /* if we find a placeholder, we pretend we haven't found
706 if (flags & HVhek_FREEKEY)
709 return entry ? (void *) &HeVAL(entry) : NULL;
713 #ifdef DYNAMIC_ENV_FETCH /* %ENV lookup? If so, try to fetch the value now */
714 if (!(action & HV_FETCH_ISSTORE)
715 && SvRMAGICAL((const SV *)hv)
716 && mg_find((const SV *)hv, PERL_MAGIC_env)) {
718 const char * const env = PerlEnv_ENVgetenv_len(key,&len);
720 sv = newSVpvn(env,len);
722 return hv_common(hv, keysv, key, klen, flags,
723 HV_FETCH_ISSTORE|HV_DISABLE_UVAR_XKEY|return_svp,
729 if (!entry && SvREADONLY(hv) && !(action & HV_FETCH_ISEXISTS)) {
730 hv_notallowed(flags, key, klen,
731 "Attempt to access disallowed key '%"SVf"' in"
732 " a restricted hash");
734 if (!(action & (HV_FETCH_LVALUE|HV_FETCH_ISSTORE))) {
735 /* Not doing some form of store, so return failure. */
736 if (flags & HVhek_FREEKEY)
740 if (action & HV_FETCH_LVALUE) {
741 val = action & HV_FETCH_EMPTY_HE ? NULL : newSV(0);
743 /* At this point the old hv_fetch code would call to hv_store,
744 which in turn might do some tied magic. So we need to make that
745 magic check happen. */
746 /* gonna assign to this, so it better be there */
747 /* If a fetch-as-store fails on the fetch, then the action is to
748 recurse once into "hv_store". If we didn't do this, then that
749 recursive call would call the key conversion routine again.
750 However, as we replace the original key with the converted
751 key, this would result in a double conversion, which would show
752 up as a bug if the conversion routine is not idempotent. */
753 return hv_common(hv, keysv, key, klen, flags,
754 HV_FETCH_ISSTORE|HV_DISABLE_UVAR_XKEY|return_svp,
756 /* XXX Surely that could leak if the fetch-was-store fails?
757 Just like the hv_fetch. */
761 /* Welcome to hv_store... */
764 /* Not sure if we can get here. I think the only case of oentry being
765 NULL is for %ENV with dynamic env fetch. But that should disappear
766 with magic in the previous code. */
769 PERL_HV_ARRAY_ALLOC_BYTES(xhv->xhv_max+1 /* HvMAX(hv)+1 */),
771 HvARRAY(hv) = (HE**)array;
774 oentry = &(HvARRAY(hv))[hash & (I32) xhv->xhv_max];
777 /* share_hek_flags will do the free for us. This might be considered
780 HeKEY_hek(entry) = share_hek_flags(key, klen, hash, flags);
781 else if (hv == PL_strtab) {
782 /* PL_strtab is usually the only hash without HvSHAREKEYS, so putting
783 this test here is cheap */
784 if (flags & HVhek_FREEKEY)
786 Perl_croak(aTHX_ S_strtab_error,
787 action & HV_FETCH_LVALUE ? "fetch" : "store");
789 else /* gotta do the real thing */
790 HeKEY_hek(entry) = save_hek_flags(key, klen, hash, flags);
792 HeNEXT(entry) = *oentry;
795 if (val == &PL_sv_placeholder)
796 HvPLACEHOLDERS(hv)++;
797 if (masked_flags & HVhek_ENABLEHVKFLAGS)
801 const HE *counter = HeNEXT(entry);
803 xhv->xhv_keys++; /* HvTOTALKEYS(hv)++ */
804 if (!counter) { /* initial entry? */
805 } else if (xhv->xhv_keys > xhv->xhv_max) {
806 /* Use only the old HvUSEDKEYS(hv) > HvMAX(hv) condition to limit
807 bucket splits on a rehashed hash, as we're not going to
808 split it again, and if someone is lucky (evil) enough to
809 get all the keys in one list they could exhaust our memory
810 as we repeatedly double the number of buckets on every
811 entry. Linear search feels a less worse thing to do. */
813 } else if(!HvREHASH(hv)) {
816 while ((counter = HeNEXT(counter)))
819 if (n_links > HV_MAX_LENGTH_BEFORE_SPLIT) {
826 return entry ? (void *) &HeVAL(entry) : NULL;
828 return (void *) entry;
832 S_hv_magic_check(HV *hv, bool *needs_copy, bool *needs_store)
834 const MAGIC *mg = SvMAGIC(hv);
836 PERL_ARGS_ASSERT_HV_MAGIC_CHECK;
841 if (isUPPER(mg->mg_type)) {
843 if (mg->mg_type == PERL_MAGIC_tied) {
844 *needs_store = FALSE;
845 return; /* We've set all there is to set. */
848 mg = mg->mg_moremagic;
853 =for apidoc hv_scalar
855 Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
861 Perl_hv_scalar(pTHX_ HV *hv)
865 PERL_ARGS_ASSERT_HV_SCALAR;
867 if (SvRMAGICAL(hv)) {
868 MAGIC * const mg = mg_find((const SV *)hv, PERL_MAGIC_tied);
870 return magic_scalarpack(hv, mg);
874 if (HvTOTALKEYS((const HV *)hv))
875 Perl_sv_setpvf(aTHX_ sv, "%ld/%ld",
876 (long)HvFILL(hv), (long)HvMAX(hv) + 1);
884 =for apidoc hv_delete
886 Deletes a key/value pair in the hash. The value's SV is removed from
887 the hash, made mortal, and returned to the caller. The absolute
888 value of C<klen> is the length of the key. If C<klen> is negative the
889 key is assumed to be in UTF-8-encoded Unicode. The C<flags> value
890 will normally be zero; if set to G_DISCARD then NULL will be returned.
891 NULL will also be returned if the key is not found.
893 =for apidoc hv_delete_ent
895 Deletes a key/value pair in the hash. The value SV is removed from the hash,
896 made mortal, and returned to the caller. The C<flags> value will normally be
897 zero; if set to G_DISCARD then NULL will be returned. NULL will also be
898 returned if the key is not found. C<hash> can be a valid precomputed hash
899 value, or 0 to ask for it to be computed.
905 S_hv_delete_common(pTHX_ HV *hv, SV *keysv, const char *key, STRLEN klen,
906 int k_flags, I32 d_flags, U32 hash)
911 register HE **oentry;
912 bool is_utf8 = (k_flags & HVhek_UTF8) ? TRUE : FALSE;
915 if (SvRMAGICAL(hv)) {
918 hv_magic_check (hv, &needs_copy, &needs_store);
922 entry = (HE *) hv_common(hv, keysv, key, klen,
923 k_flags & ~HVhek_FREEKEY,
924 HV_FETCH_LVALUE|HV_DISABLE_UVAR_XKEY,
926 sv = entry ? HeVAL(entry) : NULL;
932 if (mg_find(sv, PERL_MAGIC_tiedelem)) {
933 /* No longer an element */
934 sv_unmagic(sv, PERL_MAGIC_tiedelem);
937 return NULL; /* element cannot be deleted */
939 #ifdef ENV_IS_CASELESS
940 else if (mg_find((const SV *)hv, PERL_MAGIC_env)) {
941 /* XXX This code isn't UTF8 clean. */
942 keysv = newSVpvn_flags(key, klen, SVs_TEMP);
943 if (k_flags & HVhek_FREEKEY) {
946 key = strupr(SvPVX(keysv));
955 xhv = (XPVHV*)SvANY(hv);
960 const char * const keysave = key;
961 key = (char*)bytes_from_utf8((U8*)key, &klen, &is_utf8);
964 k_flags |= HVhek_UTF8;
966 k_flags &= ~HVhek_UTF8;
967 if (key != keysave) {
968 if (k_flags & HVhek_FREEKEY) {
969 /* This shouldn't happen if our caller does what we expect,
970 but strictly the API allows it. */
973 k_flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
975 HvHASKFLAGS_on(MUTABLE_SV(hv));
978 if (HvREHASH(hv) || (!hash && !(keysv && (SvIsCOW_shared_hash(keysv)))))
979 PERL_HASH_INTERNAL_(hash, key, klen, HvREHASH(hv));
981 hash = SvSHARED_HASH(keysv);
983 masked_flags = (k_flags & HVhek_MASK);
985 oentry = &(HvARRAY(hv))[hash & (I32) HvMAX(hv)];
987 for (; entry; oentry = &HeNEXT(entry), entry = *oentry) {
989 U8 mro_changes = 0; /* 1 = isa; 2 = package moved */
993 if (HeHASH(entry) != hash) /* strings can't be equal */
995 if (HeKLEN(entry) != (I32)klen)
997 if (HeKEY(entry) != key && memNE(HeKEY(entry),key,klen)) /* is this it? */
999 if ((HeKFLAGS(entry) ^ masked_flags) & HVhek_UTF8)
1002 if (hv == PL_strtab) {
1003 if (k_flags & HVhek_FREEKEY)
1005 Perl_croak(aTHX_ S_strtab_error, "delete");
1008 /* if placeholder is here, it's already been deleted.... */
1009 if (HeVAL(entry) == &PL_sv_placeholder) {
1010 if (k_flags & HVhek_FREEKEY)
1014 if (SvREADONLY(hv) && HeVAL(entry) && SvREADONLY(HeVAL(entry))
1015 && !SvIsCOW(HeVAL(entry))) {
1016 hv_notallowed(k_flags, key, klen,
1017 "Attempt to delete readonly key '%"SVf"' from"
1018 " a restricted hash");
1020 if (k_flags & HVhek_FREEKEY)
1023 /* If this is a stash and the key ends with ::, then someone is
1024 * deleting a package.
1026 if (HeVAL(entry) && HvENAME_get(hv)) {
1027 gv = (GV *)HeVAL(entry);
1028 if (keysv) key = SvPV(keysv, klen);
1030 (klen > 1 && key[klen-2] == ':' && key[klen-1] == ':')
1032 (klen == 1 && key[0] == ':')
1034 && (klen != 6 || hv!=PL_defstash || memNE(key,"main::",6))
1035 && SvTYPE(gv) == SVt_PVGV && (stash = GvHV((GV *)gv))
1036 && HvENAME_get(stash)) {
1037 /* A previous version of this code checked that the
1038 * GV was still in the symbol table by fetching the
1039 * GV with its name. That is not necessary (and
1040 * sometimes incorrect), as HvENAME cannot be set
1041 * on hv if it is not in the symtab. */
1043 /* Hang on to it for a bit. */
1044 SvREFCNT_inc_simple_void_NN(
1045 sv_2mortal((SV *)gv)
1048 else if (klen == 3 && strnEQ(key, "ISA", 3))
1052 if (d_flags & G_DISCARD) {
1054 HeVAL(entry) = &PL_sv_placeholder;
1056 /* deletion of method from stash */
1057 if (isGV(sv) && isGV_with_GP(sv) && GvCVu(sv)
1059 mro_method_changed_in(hv);
1065 sv = sv_2mortal(HeVAL(entry));
1066 HeVAL(entry) = &PL_sv_placeholder;
1070 * If a restricted hash, rather than really deleting the entry, put
1071 * a placeholder there. This marks the key as being "approved", so
1072 * we can still access via not-really-existing key without raising
1076 /* We'll be saving this slot, so the number of allocated keys
1077 * doesn't go down, but the number placeholders goes up */
1078 HvPLACEHOLDERS(hv)++;
1080 *oentry = HeNEXT(entry);
1081 if (SvOOK(hv) && entry == HvAUX(hv)->xhv_eiter /* HvEITER(hv) */)
1084 if (SvOOK(hv) && HvLAZYDEL(hv) &&
1085 entry == HeNEXT(HvAUX(hv)->xhv_eiter))
1086 HeNEXT(HvAUX(hv)->xhv_eiter) = HeNEXT(entry);
1087 hv_free_ent(hv, entry);
1089 xhv->xhv_keys--; /* HvTOTALKEYS(hv)-- */
1090 if (xhv->xhv_keys == 0)
1091 HvHASKFLAGS_off(hv);
1094 if (mro_changes == 1) mro_isa_changed_in(hv);
1095 else if (mro_changes == 2)
1096 mro_package_moved(NULL, stash, gv, 1);
1100 if (SvREADONLY(hv)) {
1101 hv_notallowed(k_flags, key, klen,
1102 "Attempt to delete disallowed key '%"SVf"' from"
1103 " a restricted hash");
1106 if (k_flags & HVhek_FREEKEY)
1112 S_hsplit(pTHX_ HV *hv)
1115 register XPVHV* const xhv = (XPVHV*)SvANY(hv);
1116 const I32 oldsize = (I32) xhv->xhv_max+1; /* HvMAX(hv)+1 (sick) */
1117 register I32 newsize = oldsize * 2;
1119 char *a = (char*) HvARRAY(hv);
1121 int longest_chain = 0;
1124 PERL_ARGS_ASSERT_HSPLIT;
1126 /*PerlIO_printf(PerlIO_stderr(), "hsplit called for %p which had %d\n",
1127 (void*)hv, (int) oldsize);*/
1129 if (HvPLACEHOLDERS_get(hv) && !SvREADONLY(hv)) {
1130 /* Can make this clear any placeholders first for non-restricted hashes,
1131 even though Storable rebuilds restricted hashes by putting in all the
1132 placeholders (first) before turning on the readonly flag, because
1133 Storable always pre-splits the hash. */
1134 hv_clear_placeholders(hv);
1138 #if defined(STRANGE_MALLOC) || defined(MYMALLOC)
1139 Renew(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1140 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
1146 Move(&a[oldsize * sizeof(HE*)], &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
1149 Newx(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1150 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
1155 Copy(HvARRAY(hv), a, oldsize * sizeof(HE*), char);
1157 Copy(HvAUX(hv), &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
1159 Safefree(HvARRAY(hv));
1163 Zero(&a[oldsize * sizeof(HE*)], (newsize-oldsize) * sizeof(HE*), char); /* zero 2nd half*/
1164 xhv->xhv_max = --newsize; /* HvMAX(hv) = --newsize */
1165 HvARRAY(hv) = (HE**) a;
1168 for (i=0; i<oldsize; i++,aep++) {
1169 int left_length = 0;
1170 int right_length = 0;
1175 if (!entry) /* non-existent */
1179 if ((HeHASH(entry) & newsize) != (U32)i) {
1180 *oentry = HeNEXT(entry);
1181 HeNEXT(entry) = *bep;
1186 oentry = &HeNEXT(entry);
1191 /* I think we don't actually need to keep track of the longest length,
1192 merely flag if anything is too long. But for the moment while
1193 developing this code I'll track it. */
1194 if (left_length > longest_chain)
1195 longest_chain = left_length;
1196 if (right_length > longest_chain)
1197 longest_chain = right_length;
1201 /* Pick your policy for "hashing isn't working" here: */
1202 if (longest_chain <= HV_MAX_LENGTH_BEFORE_SPLIT /* split worked? */
1207 if (hv == PL_strtab) {
1208 /* Urg. Someone is doing something nasty to the string table.
1213 /* Awooga. Awooga. Pathological data. */
1214 /*PerlIO_printf(PerlIO_stderr(), "%p %d of %d with %d/%d buckets\n", (void*)hv,
1215 longest_chain, HvTOTALKEYS(hv), HvFILL(hv), 1+HvMAX(hv));*/
1218 Newxz(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1219 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
1221 Copy(HvAUX(hv), &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
1224 was_shared = HvSHAREKEYS(hv);
1226 HvSHAREKEYS_off(hv);
1231 for (i=0; i<newsize; i++,aep++) {
1232 register HE *entry = *aep;
1234 /* We're going to trash this HE's next pointer when we chain it
1235 into the new hash below, so store where we go next. */
1236 HE * const next = HeNEXT(entry);
1241 PERL_HASH_INTERNAL(hash, HeKEY(entry), HeKLEN(entry));
1246 = save_hek_flags(HeKEY(entry), HeKLEN(entry),
1247 hash, HeKFLAGS(entry));
1248 unshare_hek (HeKEY_hek(entry));
1249 HeKEY_hek(entry) = new_hek;
1251 /* Not shared, so simply write the new hash in. */
1252 HeHASH(entry) = hash;
1254 /*PerlIO_printf(PerlIO_stderr(), "%d ", HeKFLAGS(entry));*/
1255 HEK_REHASH_on(HeKEY_hek(entry));
1256 /*PerlIO_printf(PerlIO_stderr(), "%d\n", HeKFLAGS(entry));*/
1258 /* Copy oentry to the correct new chain. */
1259 bep = ((HE**)a) + (hash & (I32) xhv->xhv_max);
1260 HeNEXT(entry) = *bep;
1266 Safefree (HvARRAY(hv));
1267 HvARRAY(hv) = (HE **)a;
1271 Perl_hv_ksplit(pTHX_ HV *hv, IV newmax)
1274 register XPVHV* xhv = (XPVHV*)SvANY(hv);
1275 const I32 oldsize = (I32) xhv->xhv_max+1; /* HvMAX(hv)+1 (sick) */
1276 register I32 newsize;
1281 PERL_ARGS_ASSERT_HV_KSPLIT;
1283 newsize = (I32) newmax; /* possible truncation here */
1284 if (newsize != newmax || newmax <= oldsize)
1286 while ((newsize & (1 + ~newsize)) != newsize) {
1287 newsize &= ~(newsize & (1 + ~newsize)); /* get proper power of 2 */
1289 if (newsize < newmax)
1291 if (newsize < newmax)
1292 return; /* overflow detection */
1294 a = (char *) HvARRAY(hv);
1297 #if defined(STRANGE_MALLOC) || defined(MYMALLOC)
1298 Renew(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1299 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
1305 Copy(&a[oldsize * sizeof(HE*)], &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
1308 Newx(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1309 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
1314 Copy(HvARRAY(hv), a, oldsize * sizeof(HE*), char);
1316 Copy(HvAUX(hv), &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
1318 Safefree(HvARRAY(hv));
1321 Zero(&a[oldsize * sizeof(HE*)], (newsize-oldsize) * sizeof(HE*), char); /* zero 2nd half*/
1324 Newxz(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize), char);
1326 xhv->xhv_max = --newsize; /* HvMAX(hv) = --newsize */
1327 HvARRAY(hv) = (HE **) a;
1328 if (!xhv->xhv_keys /* !HvTOTALKEYS(hv) */) /* skip rest if no entries */
1332 for (i=0; i<oldsize; i++,aep++) {
1336 if (!entry) /* non-existent */
1339 register I32 j = (HeHASH(entry) & newsize);
1343 *oentry = HeNEXT(entry);
1344 HeNEXT(entry) = aep[j];
1348 oentry = &HeNEXT(entry);
1355 Perl_newHVhv(pTHX_ HV *ohv)
1358 HV * const hv = newHV();
1361 if (!ohv || !HvTOTALKEYS(ohv))
1363 hv_max = HvMAX(ohv);
1365 if (!SvMAGICAL((const SV *)ohv)) {
1366 /* It's an ordinary hash, so copy it fast. AMS 20010804 */
1368 const bool shared = !!HvSHAREKEYS(ohv);
1369 HE **ents, ** const oents = (HE **)HvARRAY(ohv);
1371 Newx(a, PERL_HV_ARRAY_ALLOC_BYTES(hv_max+1), char);
1374 /* In each bucket... */
1375 for (i = 0; i <= hv_max; i++) {
1377 HE *oent = oents[i];
1384 /* Copy the linked list of entries. */
1385 for (; oent; oent = HeNEXT(oent)) {
1386 const U32 hash = HeHASH(oent);
1387 const char * const key = HeKEY(oent);
1388 const STRLEN len = HeKLEN(oent);
1389 const int flags = HeKFLAGS(oent);
1390 HE * const ent = new_HE();
1391 SV *const val = HeVAL(oent);
1393 HeVAL(ent) = SvIMMORTAL(val) ? val : newSVsv(val);
1395 = shared ? share_hek_flags(key, len, hash, flags)
1396 : save_hek_flags(key, len, hash, flags);
1407 HvTOTALKEYS(hv) = HvTOTALKEYS(ohv);
1411 /* Iterate over ohv, copying keys and values one at a time. */
1413 const I32 riter = HvRITER_get(ohv);
1414 HE * const eiter = HvEITER_get(ohv);
1415 STRLEN hv_fill = HvFILL(ohv);
1417 /* Can we use fewer buckets? (hv_max is always 2^n-1) */
1418 while (hv_max && hv_max + 1 >= hv_fill * 2)
1419 hv_max = hv_max / 2;
1423 while ((entry = hv_iternext_flags(ohv, 0))) {
1424 SV *const val = HeVAL(entry);
1425 (void)hv_store_flags(hv, HeKEY(entry), HeKLEN(entry),
1426 SvIMMORTAL(val) ? val : newSVsv(val),
1427 HeHASH(entry), HeKFLAGS(entry));
1429 HvRITER_set(ohv, riter);
1430 HvEITER_set(ohv, eiter);
1437 =for apidoc Am|HV *|hv_copy_hints_hv|HV *ohv
1439 A specialised version of L</newHVhv> for copying C<%^H>. I<ohv> must be
1440 a pointer to a hash (which may have C<%^H> magic, but should be generally
1441 non-magical), or C<NULL> (interpreted as an empty hash). The content
1442 of I<ohv> is copied to a new hash, which has the C<%^H>-specific magic
1443 added to it. A pointer to the new hash is returned.
1449 Perl_hv_copy_hints_hv(pTHX_ HV *const ohv)
1451 HV * const hv = newHV();
1453 if (ohv && HvTOTALKEYS(ohv)) {
1454 STRLEN hv_max = HvMAX(ohv);
1455 STRLEN hv_fill = HvFILL(ohv);
1457 const I32 riter = HvRITER_get(ohv);
1458 HE * const eiter = HvEITER_get(ohv);
1460 while (hv_max && hv_max + 1 >= hv_fill * 2)
1461 hv_max = hv_max / 2;
1465 while ((entry = hv_iternext_flags(ohv, 0))) {
1466 SV *const sv = newSVsv(HeVAL(entry));
1467 SV *heksv = newSVhek(HeKEY_hek(entry));
1468 sv_magic(sv, NULL, PERL_MAGIC_hintselem,
1469 (char *)heksv, HEf_SVKEY);
1470 SvREFCNT_dec(heksv);
1471 (void)hv_store_flags(hv, HeKEY(entry), HeKLEN(entry),
1472 sv, HeHASH(entry), HeKFLAGS(entry));
1474 HvRITER_set(ohv, riter);
1475 HvEITER_set(ohv, eiter);
1477 hv_magic(hv, NULL, PERL_MAGIC_hints);
1481 /* like hv_free_ent, but returns the SV rather than freeing it */
1483 S_hv_free_ent_ret(pTHX_ HV *hv, register HE *entry)
1488 PERL_ARGS_ASSERT_HV_FREE_ENT_RET;
1493 if (val && isGV(val) && isGV_with_GP(val) && GvCVu(val) && HvENAME(hv))
1494 mro_method_changed_in(hv); /* deletion of method from stash */
1495 if (HeKLEN(entry) == HEf_SVKEY) {
1496 SvREFCNT_dec(HeKEY_sv(entry));
1497 Safefree(HeKEY_hek(entry));
1499 else if (HvSHAREKEYS(hv))
1500 unshare_hek(HeKEY_hek(entry));
1502 Safefree(HeKEY_hek(entry));
1509 Perl_hv_free_ent(pTHX_ HV *hv, register HE *entry)
1514 PERL_ARGS_ASSERT_HV_FREE_ENT;
1518 val = hv_free_ent_ret(hv, entry);
1524 Perl_hv_delayfree_ent(pTHX_ HV *hv, register HE *entry)
1528 PERL_ARGS_ASSERT_HV_DELAYFREE_ENT;
1532 /* SvREFCNT_inc to counter the SvREFCNT_dec in hv_free_ent */
1533 sv_2mortal(SvREFCNT_inc(HeVAL(entry))); /* free between statements */
1534 if (HeKLEN(entry) == HEf_SVKEY) {
1535 sv_2mortal(SvREFCNT_inc(HeKEY_sv(entry)));
1537 hv_free_ent(hv, entry);
1541 =for apidoc hv_clear
1543 Frees the all the elements of a hash, leaving it empty.
1544 The XS equivalent of %hash = (). See also L</hv_undef>.
1550 Perl_hv_clear(pTHX_ HV *hv)
1553 register XPVHV* xhv;
1557 DEBUG_A(Perl_hv_assert(aTHX_ hv));
1559 xhv = (XPVHV*)SvANY(hv);
1561 if (SvREADONLY(hv) && HvARRAY(hv) != NULL) {
1562 /* restricted hash: convert all keys to placeholders */
1564 for (i = 0; i <= xhv->xhv_max; i++) {
1565 HE *entry = (HvARRAY(hv))[i];
1566 for (; entry; entry = HeNEXT(entry)) {
1567 /* not already placeholder */
1568 if (HeVAL(entry) != &PL_sv_placeholder) {
1569 if (HeVAL(entry) && SvREADONLY(HeVAL(entry))
1570 && !SvIsCOW(HeVAL(entry))) {
1571 SV* const keysv = hv_iterkeysv(entry);
1573 "Attempt to delete readonly key '%"SVf"' from a restricted hash",
1576 SvREFCNT_dec(HeVAL(entry));
1577 HeVAL(entry) = &PL_sv_placeholder;
1578 HvPLACEHOLDERS(hv)++;
1585 HvPLACEHOLDERS_set(hv, 0);
1588 mg_clear(MUTABLE_SV(hv));
1590 HvHASKFLAGS_off(hv);
1595 mro_isa_changed_in(hv);
1596 HvEITER_set(hv, NULL);
1601 =for apidoc hv_clear_placeholders
1603 Clears any placeholders from a hash. If a restricted hash has any of its keys
1604 marked as readonly and the key is subsequently deleted, the key is not actually
1605 deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
1606 it so it will be ignored by future operations such as iterating over the hash,
1607 but will still allow the hash to have a value reassigned to the key at some
1608 future point. This function clears any such placeholder keys from the hash.
1609 See Hash::Util::lock_keys() for an example of its use.
1615 Perl_hv_clear_placeholders(pTHX_ HV *hv)
1618 const U32 items = (U32)HvPLACEHOLDERS_get(hv);
1620 PERL_ARGS_ASSERT_HV_CLEAR_PLACEHOLDERS;
1623 clear_placeholders(hv, items);
1627 S_clear_placeholders(pTHX_ HV *hv, U32 items)
1632 PERL_ARGS_ASSERT_CLEAR_PLACEHOLDERS;
1639 /* Loop down the linked list heads */
1640 HE **oentry = &(HvARRAY(hv))[i];
1643 while ((entry = *oentry)) {
1644 if (HeVAL(entry) == &PL_sv_placeholder) {
1645 *oentry = HeNEXT(entry);
1646 if (entry == HvEITER_get(hv))
1649 if (SvOOK(hv) && HvLAZYDEL(hv) &&
1650 entry == HeNEXT(HvAUX(hv)->xhv_eiter))
1651 HeNEXT(HvAUX(hv)->xhv_eiter) = HeNEXT(entry);
1652 hv_free_ent(hv, entry);
1657 HvTOTALKEYS(hv) -= (IV)HvPLACEHOLDERS_get(hv);
1658 if (HvUSEDKEYS(hv) == 0)
1659 HvHASKFLAGS_off(hv);
1660 HvPLACEHOLDERS_set(hv, 0);
1664 oentry = &HeNEXT(entry);
1668 /* You can't get here, hence assertion should always fail. */
1669 assert (items == 0);
1674 S_hfreeentries(pTHX_ HV *hv)
1677 XPVHV * const xhv = (XPVHV*)SvANY(hv);
1680 PERL_ARGS_ASSERT_HFREEENTRIES;
1682 while ((sv = Perl_hfree_next_entry(aTHX_ hv, &index))||xhv->xhv_keys) {
1688 /* hfree_next_entry()
1689 * For use only by S_hfreeentries() and sv_clear().
1690 * Delete the next available HE from hv and return the associated SV.
1691 * Returns null on empty hash. Nevertheless null is not a reliable
1692 * indicator that the hash is empty, as the deleted entry may have a
1694 * indexp is a pointer to the current index into HvARRAY. The index should
1695 * initially be set to 0. hfree_next_entry() may update it. */
1698 Perl_hfree_next_entry(pTHX_ HV *hv, STRLEN *indexp)
1700 struct xpvhv_aux *iter;
1704 STRLEN orig_index = *indexp;
1707 PERL_ARGS_ASSERT_HFREE_NEXT_ENTRY;
1709 if (SvOOK(hv) && ((iter = HvAUX(hv)))
1710 && ((entry = iter->xhv_eiter)) )
1712 /* the iterator may get resurrected after each
1713 * destructor call, so check each time */
1714 if (entry && HvLAZYDEL(hv)) { /* was deleted earlier? */
1716 hv_free_ent(hv, entry);
1717 /* warning: at this point HvARRAY may have been
1718 * re-allocated, HvMAX changed etc */
1720 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
1721 iter->xhv_eiter = NULL; /* HvEITER(hv) = NULL */
1724 if (!((XPVHV*)SvANY(hv))->xhv_keys)
1727 array = HvARRAY(hv);
1729 while ( ! ((entry = array[*indexp])) ) {
1730 if ((*indexp)++ >= HvMAX(hv))
1732 assert(*indexp != orig_index);
1734 array[*indexp] = HeNEXT(entry);
1735 ((XPVHV*) SvANY(hv))->xhv_keys--;
1737 if ( PL_phase != PERL_PHASE_DESTRUCT && HvENAME(hv)
1738 && HeVAL(entry) && isGV(HeVAL(entry))
1739 && GvHV(HeVAL(entry)) && HvENAME(GvHV(HeVAL(entry)))
1742 const char * const key = HePV(entry,klen);
1743 if ((klen > 1 && key[klen-1]==':' && key[klen-2]==':')
1744 || (klen == 1 && key[0] == ':')) {
1746 NULL, GvHV(HeVAL(entry)),
1747 (GV *)HeVAL(entry), 0
1751 return hv_free_ent_ret(hv, entry);
1756 =for apidoc hv_undef
1758 Undefines the hash. The XS equivalent of undef(%hash).
1760 As well as freeing all the elements of the hash (like hv_clear()), this
1761 also frees any auxiliary data and storage associated with the hash.
1762 See also L</hv_clear>.
1768 Perl_hv_undef_flags(pTHX_ HV *hv, U32 flags)
1771 register XPVHV* xhv;
1776 DEBUG_A(Perl_hv_assert(aTHX_ hv));
1777 xhv = (XPVHV*)SvANY(hv);
1779 /* The name must be deleted before the call to hfreeeeentries so that
1780 CVs are anonymised properly. But the effective name must be pre-
1781 served until after that call (and only deleted afterwards if the
1782 call originated from sv_clear). For stashes with one name that is
1783 both the canonical name and the effective name, hv_name_set has to
1784 allocate an array for storing the effective name. We can skip that
1785 during global destruction, as it does not matter where the CVs point
1786 if they will be freed anyway. */
1787 /* note that the code following prior to hfreeentries is duplicated
1788 * in sv_clear(), and changes here should be done there too */
1789 if (PL_phase != PERL_PHASE_DESTRUCT && (name = HvNAME(hv))) {
1791 (void)hv_delete(PL_stashcache, name,
1792 HEK_UTF8(HvNAME_HEK(hv)) ? -HvNAMELEN_get(hv) : HvNAMELEN_get(hv),
1795 hv_name_set(hv, NULL, 0, 0);
1799 struct xpvhv_aux * const aux = HvAUX(hv);
1800 struct mro_meta *meta;
1802 if ((name = HvENAME_get(hv))) {
1803 if (PL_phase != PERL_PHASE_DESTRUCT)
1804 mro_isa_changed_in(hv);
1807 PL_stashcache, name,
1808 HEK_UTF8(HvENAME_HEK(hv)) ? -HvENAMELEN_get(hv) : HvENAMELEN_get(hv),
1813 /* If this call originated from sv_clear, then we must check for
1814 * effective names that need freeing, as well as the usual name. */
1816 if (flags & HV_NAME_SETALL ? !!aux->xhv_name_u.xhvnameu_name : !!name) {
1817 if (name && PL_stashcache)
1818 (void)hv_delete(PL_stashcache, name, (HEK_UTF8(HvNAME_HEK(hv)) ? -HvNAMELEN_get(hv) : HvNAMELEN_get(hv)), G_DISCARD);
1819 hv_name_set(hv, NULL, 0, flags);
1821 if((meta = aux->xhv_mro_meta)) {
1822 if (meta->mro_linear_all) {
1823 SvREFCNT_dec(MUTABLE_SV(meta->mro_linear_all));
1824 meta->mro_linear_all = NULL;
1825 /* This is just acting as a shortcut pointer. */
1826 meta->mro_linear_current = NULL;
1827 } else if (meta->mro_linear_current) {
1828 /* Only the current MRO is stored, so this owns the data.
1830 SvREFCNT_dec(meta->mro_linear_current);
1831 meta->mro_linear_current = NULL;
1833 SvREFCNT_dec(meta->mro_nextmethod);
1834 SvREFCNT_dec(meta->isa);
1836 aux->xhv_mro_meta = NULL;
1838 if (!aux->xhv_name_u.xhvnameu_name && ! aux->xhv_backreferences)
1839 SvFLAGS(hv) &= ~SVf_OOK;
1842 Safefree(HvARRAY(hv));
1843 xhv->xhv_max = 7; /* HvMAX(hv) = 7 (it's a normal hash) */
1846 HvPLACEHOLDERS_set(hv, 0);
1849 mg_clear(MUTABLE_SV(hv));
1855 Returns the number of hash buckets that happen to be in use. This function is
1856 wrapped by the macro C<HvFILL>.
1858 Previously this value was stored in the HV structure, rather than being
1859 calculated on demand.
1865 Perl_hv_fill(pTHX_ HV const *const hv)
1868 HE **ents = HvARRAY(hv);
1870 PERL_ARGS_ASSERT_HV_FILL;
1873 HE *const *const last = ents + HvMAX(hv);
1874 count = last + 1 - ents;
1879 } while (++ents <= last);
1884 static struct xpvhv_aux*
1885 S_hv_auxinit(HV *hv) {
1886 struct xpvhv_aux *iter;
1889 PERL_ARGS_ASSERT_HV_AUXINIT;
1892 Newxz(array, PERL_HV_ARRAY_ALLOC_BYTES(HvMAX(hv) + 1)
1893 + sizeof(struct xpvhv_aux), char);
1895 array = (char *) HvARRAY(hv);
1896 Renew(array, PERL_HV_ARRAY_ALLOC_BYTES(HvMAX(hv) + 1)
1897 + sizeof(struct xpvhv_aux), char);
1899 HvARRAY(hv) = (HE**) array;
1900 /* SvOOK_on(hv) attacks the IV flags. */
1901 SvFLAGS(hv) |= SVf_OOK;
1904 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
1905 iter->xhv_eiter = NULL; /* HvEITER(hv) = NULL */
1906 iter->xhv_name_u.xhvnameu_name = 0;
1907 iter->xhv_name_count = 0;
1908 iter->xhv_backreferences = 0;
1909 iter->xhv_mro_meta = NULL;
1914 =for apidoc hv_iterinit
1916 Prepares a starting point to traverse a hash table. Returns the number of
1917 keys in the hash (i.e. the same as C<HvUSEDKEYS(hv)>). The return value is
1918 currently only meaningful for hashes without tie magic.
1920 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1921 hash buckets that happen to be in use. If you still need that esoteric
1922 value, you can get it through the macro C<HvFILL(hv)>.
1929 Perl_hv_iterinit(pTHX_ HV *hv)
1931 PERL_ARGS_ASSERT_HV_ITERINIT;
1933 /* FIXME: Are we not NULL, or do we croak? Place bets now! */
1936 Perl_croak(aTHX_ "Bad hash");
1939 struct xpvhv_aux * const iter = HvAUX(hv);
1940 HE * const entry = iter->xhv_eiter; /* HvEITER(hv) */
1941 if (entry && HvLAZYDEL(hv)) { /* was deleted earlier? */
1943 hv_free_ent(hv, entry);
1945 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
1946 iter->xhv_eiter = NULL; /* HvEITER(hv) = NULL */
1951 /* used to be xhv->xhv_fill before 5.004_65 */
1952 return HvTOTALKEYS(hv);
1956 Perl_hv_riter_p(pTHX_ HV *hv) {
1957 struct xpvhv_aux *iter;
1959 PERL_ARGS_ASSERT_HV_RITER_P;
1962 Perl_croak(aTHX_ "Bad hash");
1964 iter = SvOOK(hv) ? HvAUX(hv) : hv_auxinit(hv);
1965 return &(iter->xhv_riter);
1969 Perl_hv_eiter_p(pTHX_ HV *hv) {
1970 struct xpvhv_aux *iter;
1972 PERL_ARGS_ASSERT_HV_EITER_P;
1975 Perl_croak(aTHX_ "Bad hash");
1977 iter = SvOOK(hv) ? HvAUX(hv) : hv_auxinit(hv);
1978 return &(iter->xhv_eiter);
1982 Perl_hv_riter_set(pTHX_ HV *hv, I32 riter) {
1983 struct xpvhv_aux *iter;
1985 PERL_ARGS_ASSERT_HV_RITER_SET;
1988 Perl_croak(aTHX_ "Bad hash");
1996 iter = hv_auxinit(hv);
1998 iter->xhv_riter = riter;
2002 Perl_hv_eiter_set(pTHX_ HV *hv, HE *eiter) {
2003 struct xpvhv_aux *iter;
2005 PERL_ARGS_ASSERT_HV_EITER_SET;
2008 Perl_croak(aTHX_ "Bad hash");
2013 /* 0 is the default so don't go malloc()ing a new structure just to
2018 iter = hv_auxinit(hv);
2020 iter->xhv_eiter = eiter;
2024 Perl_hv_name_set(pTHX_ HV *hv, const char *name, U32 len, U32 flags)
2027 struct xpvhv_aux *iter;
2031 PERL_ARGS_ASSERT_HV_NAME_SET;
2034 Perl_croak(aTHX_ "panic: hv name too long (%"UVuf")", (UV) len);
2038 if (iter->xhv_name_u.xhvnameu_name) {
2039 if(iter->xhv_name_count) {
2040 if(flags & HV_NAME_SETALL) {
2041 HEK ** const name = HvAUX(hv)->xhv_name_u.xhvnameu_names;
2042 HEK **hekp = name + (
2043 iter->xhv_name_count < 0
2044 ? -iter->xhv_name_count
2045 : iter->xhv_name_count
2047 while(hekp-- > name+1)
2048 unshare_hek_or_pvn(*hekp, 0, 0, 0);
2049 /* The first elem may be null. */
2050 if(*name) unshare_hek_or_pvn(*name, 0, 0, 0);
2052 spot = &iter->xhv_name_u.xhvnameu_name;
2053 iter->xhv_name_count = 0;
2056 if(iter->xhv_name_count > 0) {
2057 /* shift some things over */
2059 iter->xhv_name_u.xhvnameu_names, iter->xhv_name_count + 1, HEK *
2061 spot = iter->xhv_name_u.xhvnameu_names;
2062 spot[iter->xhv_name_count] = spot[1];
2064 iter->xhv_name_count = -(iter->xhv_name_count + 1);
2066 else if(*(spot = iter->xhv_name_u.xhvnameu_names)) {
2067 unshare_hek_or_pvn(*spot, 0, 0, 0);
2071 else if (flags & HV_NAME_SETALL) {
2072 unshare_hek_or_pvn(iter->xhv_name_u.xhvnameu_name, 0, 0, 0);
2073 spot = &iter->xhv_name_u.xhvnameu_name;
2076 HEK * const existing_name = iter->xhv_name_u.xhvnameu_name;
2077 Newx(iter->xhv_name_u.xhvnameu_names, 2, HEK *);
2078 iter->xhv_name_count = -2;
2079 spot = iter->xhv_name_u.xhvnameu_names;
2080 spot[1] = existing_name;
2083 else { spot = &iter->xhv_name_u.xhvnameu_name; iter->xhv_name_count = 0; }
2088 iter = hv_auxinit(hv);
2089 spot = &iter->xhv_name_u.xhvnameu_name;
2091 PERL_HASH(hash, name, len);
2092 *spot = name ? share_hek(name, flags & SVf_UTF8 ? -(I32)len : (I32)len, hash) : NULL;
2096 This is basically sv_eq_flags() in sv.c, but we avoid the magic
2101 hek_eq_pvn_flags(pTHX_ const HEK *hek, const char* pv, const I32 pvlen, const U32 flags) {
2102 if ( (HEK_UTF8(hek) ? 1 : 0) != (flags & SVf_UTF8 ? 1 : 0) ) {
2103 if (flags & SVf_UTF8)
2104 return (bytes_cmp_utf8(
2105 (const U8*)HEK_KEY(hek), HEK_LEN(hek),
2106 (const U8*)pv, pvlen) == 0);
2108 return (bytes_cmp_utf8(
2109 (const U8*)pv, pvlen,
2110 (const U8*)HEK_KEY(hek), HEK_LEN(hek)) == 0);
2113 return HEK_LEN(hek) == pvlen && ((HEK_KEY(hek) == pv)
2114 || memEQ(HEK_KEY(hek), pv, pvlen));
2118 =for apidoc hv_ename_add
2120 Adds a name to a stash's internal list of effective names. See
2123 This is called when a stash is assigned to a new location in the symbol
2130 Perl_hv_ename_add(pTHX_ HV *hv, const char *name, U32 len, U32 flags)
2133 struct xpvhv_aux *aux = SvOOK(hv) ? HvAUX(hv) : hv_auxinit(hv);
2136 PERL_ARGS_ASSERT_HV_ENAME_ADD;
2139 Perl_croak(aTHX_ "panic: hv name too long (%"UVuf")", (UV) len);
2141 PERL_HASH(hash, name, len);
2143 if (aux->xhv_name_count) {
2144 HEK ** const xhv_name = aux->xhv_name_u.xhvnameu_names;
2145 I32 count = aux->xhv_name_count;
2146 HEK **hekp = xhv_name + (count < 0 ? -count : count);
2147 while (hekp-- > xhv_name)
2149 (HEK_UTF8(*hekp) || (flags & SVf_UTF8))
2150 ? hek_eq_pvn_flags(aTHX_ *hekp, name, (I32)len, flags)
2151 : (HEK_LEN(*hekp) == (I32)len && memEQ(HEK_KEY(*hekp), name, len))
2153 if (hekp == xhv_name && count < 0)
2154 aux->xhv_name_count = -count;
2157 if (count < 0) aux->xhv_name_count--, count = -count;
2158 else aux->xhv_name_count++;
2159 Renew(aux->xhv_name_u.xhvnameu_names, count + 1, HEK *);
2160 (aux->xhv_name_u.xhvnameu_names)[count] = share_hek(name, (flags & SVf_UTF8 ? -(I32)len : (I32)len), hash);
2163 HEK *existing_name = aux->xhv_name_u.xhvnameu_name;
2166 (HEK_UTF8(existing_name) || (flags & SVf_UTF8))
2167 ? hek_eq_pvn_flags(aTHX_ existing_name, name, (I32)len, flags)
2168 : (HEK_LEN(existing_name) == (I32)len && memEQ(HEK_KEY(existing_name), name, len))
2171 Newx(aux->xhv_name_u.xhvnameu_names, 2, HEK *);
2172 aux->xhv_name_count = existing_name ? 2 : -2;
2173 *aux->xhv_name_u.xhvnameu_names = existing_name;
2174 (aux->xhv_name_u.xhvnameu_names)[1] = share_hek(name, (flags & SVf_UTF8 ? -(I32)len : (I32)len), hash);
2179 =for apidoc hv_ename_delete
2181 Removes a name from a stash's internal list of effective names. If this is
2182 the name returned by C<HvENAME>, then another name in the list will take
2183 its place (C<HvENAME> will use it).
2185 This is called when a stash is deleted from the symbol table.
2191 Perl_hv_ename_delete(pTHX_ HV *hv, const char *name, U32 len, U32 flags)
2194 struct xpvhv_aux *aux;
2196 PERL_ARGS_ASSERT_HV_ENAME_DELETE;
2199 Perl_croak(aTHX_ "panic: hv name too long (%"UVuf")", (UV) len);
2201 if (!SvOOK(hv)) return;
2204 if (!aux->xhv_name_u.xhvnameu_name) return;
2206 if (aux->xhv_name_count) {
2207 HEK ** const namep = aux->xhv_name_u.xhvnameu_names;
2208 I32 const count = aux->xhv_name_count;
2209 HEK **victim = namep + (count < 0 ? -count : count);
2210 while (victim-- > namep + 1)
2212 (HEK_UTF8(*victim) || (flags & SVf_UTF8))
2213 ? hek_eq_pvn_flags(aTHX_ *victim, name, (I32)len, flags)
2214 : (HEK_LEN(*victim) == (I32)len && memEQ(HEK_KEY(*victim), name, len))
2216 unshare_hek_or_pvn(*victim, 0, 0, 0);
2217 if (count < 0) ++aux->xhv_name_count;
2218 else --aux->xhv_name_count;
2220 (aux->xhv_name_count == 1 || aux->xhv_name_count == -1)
2222 ) { /* if there are none left */
2224 aux->xhv_name_u.xhvnameu_names = NULL;
2225 aux->xhv_name_count = 0;
2228 /* Move the last one back to fill the empty slot. It
2229 does not matter what order they are in. */
2230 *victim = *(namep + (count < 0 ? -count : count) - 1);
2235 count > 0 && (HEK_UTF8(*namep) || (flags & SVf_UTF8))
2236 ? hek_eq_pvn_flags(aTHX_ *namep, name, (I32)len, flags)
2237 : (HEK_LEN(*namep) == (I32)len && memEQ(HEK_KEY(*namep), name, len))
2239 aux->xhv_name_count = -count;
2243 (HEK_UTF8(aux->xhv_name_u.xhvnameu_name) || (flags & SVf_UTF8))
2244 ? hek_eq_pvn_flags(aTHX_ aux->xhv_name_u.xhvnameu_name, name, (I32)len, flags)
2245 : (HEK_LEN(aux->xhv_name_u.xhvnameu_name) == (I32)len &&
2246 memEQ(HEK_KEY(aux->xhv_name_u.xhvnameu_name), name, len))
2248 HEK * const namehek = aux->xhv_name_u.xhvnameu_name;
2249 Newx(aux->xhv_name_u.xhvnameu_names, 1, HEK *);
2250 *aux->xhv_name_u.xhvnameu_names = namehek;
2251 aux->xhv_name_count = -1;
2256 Perl_hv_backreferences_p(pTHX_ HV *hv) {
2257 struct xpvhv_aux * const iter = SvOOK(hv) ? HvAUX(hv) : hv_auxinit(hv);
2259 PERL_ARGS_ASSERT_HV_BACKREFERENCES_P;
2260 PERL_UNUSED_CONTEXT;
2262 return &(iter->xhv_backreferences);
2266 Perl_hv_kill_backrefs(pTHX_ HV *hv) {
2269 PERL_ARGS_ASSERT_HV_KILL_BACKREFS;
2274 av = HvAUX(hv)->xhv_backreferences;
2277 HvAUX(hv)->xhv_backreferences = 0;
2278 Perl_sv_kill_backrefs(aTHX_ MUTABLE_SV(hv), av);
2279 if (SvTYPE(av) == SVt_PVAV)
2285 hv_iternext is implemented as a macro in hv.h
2287 =for apidoc hv_iternext
2289 Returns entries from a hash iterator. See C<hv_iterinit>.
2291 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
2292 iterator currently points to, without losing your place or invalidating your
2293 iterator. Note that in this case the current entry is deleted from the hash
2294 with your iterator holding the last reference to it. Your iterator is flagged
2295 to free the entry on the next call to C<hv_iternext>, so you must not discard
2296 your iterator immediately else the entry will leak - call C<hv_iternext> to
2297 trigger the resource deallocation.
2299 =for apidoc hv_iternext_flags
2301 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
2302 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
2303 set the placeholders keys (for restricted hashes) will be returned in addition
2304 to normal keys. By default placeholders are automatically skipped over.
2305 Currently a placeholder is implemented with a value that is
2306 C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
2307 restricted hashes may change, and the implementation currently is
2308 insufficiently abstracted for any change to be tidy.
2314 Perl_hv_iternext_flags(pTHX_ HV *hv, I32 flags)
2317 register XPVHV* xhv;
2321 struct xpvhv_aux *iter;
2323 PERL_ARGS_ASSERT_HV_ITERNEXT_FLAGS;
2326 Perl_croak(aTHX_ "Bad hash");
2328 xhv = (XPVHV*)SvANY(hv);
2331 /* Too many things (well, pp_each at least) merrily assume that you can
2332 call iv_iternext without calling hv_iterinit, so we'll have to deal
2338 oldentry = entry = iter->xhv_eiter; /* HvEITER(hv) */
2339 if (SvMAGICAL(hv) && SvRMAGICAL(hv)) {
2340 if ( ( mg = mg_find((const SV *)hv, PERL_MAGIC_tied) ) ) {
2341 SV * const key = sv_newmortal();
2343 sv_setsv(key, HeSVKEY_force(entry));
2344 SvREFCNT_dec(HeSVKEY(entry)); /* get rid of previous key */
2350 /* one HE per MAGICAL hash */
2351 iter->xhv_eiter = entry = new_HE(); /* HvEITER(hv) = new_HE() */
2353 Newxz(k, HEK_BASESIZE + sizeof(const SV *), char);
2355 HeKEY_hek(entry) = hek;
2356 HeKLEN(entry) = HEf_SVKEY;
2358 magic_nextpack(MUTABLE_SV(hv),mg,key);
2360 /* force key to stay around until next time */
2361 HeSVKEY_set(entry, SvREFCNT_inc_simple_NN(key));
2362 return entry; /* beware, hent_val is not set */
2364 SvREFCNT_dec(HeVAL(entry));
2365 Safefree(HeKEY_hek(entry));
2367 iter->xhv_eiter = NULL; /* HvEITER(hv) = NULL */
2371 #if defined(DYNAMIC_ENV_FETCH) && !defined(__riscos__) /* set up %ENV for iteration */
2372 if (!entry && SvRMAGICAL((const SV *)hv)
2373 && mg_find((const SV *)hv, PERL_MAGIC_env)) {
2376 /* The prime_env_iter() on VMS just loaded up new hash values
2377 * so the iteration count needs to be reset back to the beginning
2381 oldentry = entry = iter->xhv_eiter; /* HvEITER(hv) */
2386 /* hv_iterinit now ensures this. */
2387 assert (HvARRAY(hv));
2389 /* At start of hash, entry is NULL. */
2392 entry = HeNEXT(entry);
2393 if (!(flags & HV_ITERNEXT_WANTPLACEHOLDERS)) {
2395 * Skip past any placeholders -- don't want to include them in
2398 while (entry && HeVAL(entry) == &PL_sv_placeholder) {
2399 entry = HeNEXT(entry);
2404 /* Skip the entire loop if the hash is empty. */
2405 if ((flags & HV_ITERNEXT_WANTPLACEHOLDERS)
2406 ? HvTOTALKEYS(hv) : HvUSEDKEYS(hv)) {
2408 /* OK. Come to the end of the current list. Grab the next one. */
2410 iter->xhv_riter++; /* HvRITER(hv)++ */
2411 if (iter->xhv_riter > (I32)xhv->xhv_max /* HvRITER(hv) > HvMAX(hv) */) {
2412 /* There is no next one. End of the hash. */
2413 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
2416 entry = (HvARRAY(hv))[iter->xhv_riter];
2418 if (!(flags & HV_ITERNEXT_WANTPLACEHOLDERS)) {
2419 /* If we have an entry, but it's a placeholder, don't count it.
2421 while (entry && HeVAL(entry) == &PL_sv_placeholder)
2422 entry = HeNEXT(entry);
2424 /* Will loop again if this linked list starts NULL
2425 (for HV_ITERNEXT_WANTPLACEHOLDERS)
2426 or if we run through it and find only placeholders. */
2429 else iter->xhv_riter = -1;
2431 if (oldentry && HvLAZYDEL(hv)) { /* was deleted earlier? */
2433 hv_free_ent(hv, oldentry);
2436 /*if (HvREHASH(hv) && entry && !HeKREHASH(entry))
2437 PerlIO_printf(PerlIO_stderr(), "Awooga %p %p\n", (void*)hv, (void*)entry);*/
2439 iter->xhv_eiter = entry; /* HvEITER(hv) = entry */
2444 =for apidoc hv_iterkey
2446 Returns the key from the current position of the hash iterator. See
2453 Perl_hv_iterkey(pTHX_ register HE *entry, I32 *retlen)
2455 PERL_ARGS_ASSERT_HV_ITERKEY;
2457 if (HeKLEN(entry) == HEf_SVKEY) {
2459 char * const p = SvPV(HeKEY_sv(entry), len);
2464 *retlen = HeKLEN(entry);
2465 return HeKEY(entry);
2469 /* unlike hv_iterval(), this always returns a mortal copy of the key */
2471 =for apidoc hv_iterkeysv
2473 Returns the key as an C<SV*> from the current position of the hash
2474 iterator. The return value will always be a mortal copy of the key. Also
2481 Perl_hv_iterkeysv(pTHX_ register HE *entry)
2483 PERL_ARGS_ASSERT_HV_ITERKEYSV;
2485 return sv_2mortal(newSVhek(HeKEY_hek(entry)));
2489 =for apidoc hv_iterval
2491 Returns the value from the current position of the hash iterator. See
2498 Perl_hv_iterval(pTHX_ HV *hv, register HE *entry)
2500 PERL_ARGS_ASSERT_HV_ITERVAL;
2502 if (SvRMAGICAL(hv)) {
2503 if (mg_find((const SV *)hv, PERL_MAGIC_tied)) {
2504 SV* const sv = sv_newmortal();
2505 if (HeKLEN(entry) == HEf_SVKEY)
2506 mg_copy(MUTABLE_SV(hv), sv, (char*)HeKEY_sv(entry), HEf_SVKEY);
2508 mg_copy(MUTABLE_SV(hv), sv, HeKEY(entry), HeKLEN(entry));
2512 return HeVAL(entry);
2516 =for apidoc hv_iternextsv
2518 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
2525 Perl_hv_iternextsv(pTHX_ HV *hv, char **key, I32 *retlen)
2527 HE * const he = hv_iternext_flags(hv, 0);
2529 PERL_ARGS_ASSERT_HV_ITERNEXTSV;
2533 *key = hv_iterkey(he, retlen);
2534 return hv_iterval(hv, he);
2541 =for apidoc hv_magic
2543 Adds magic to a hash. See C<sv_magic>.
2548 /* possibly free a shared string if no one has access to it
2549 * len and hash must both be valid for str.
2552 Perl_unsharepvn(pTHX_ const char *str, I32 len, U32 hash)
2554 unshare_hek_or_pvn (NULL, str, len, hash);
2559 Perl_unshare_hek(pTHX_ HEK *hek)
2562 unshare_hek_or_pvn(hek, NULL, 0, 0);
2565 /* possibly free a shared string if no one has access to it
2566 hek if non-NULL takes priority over the other 3, else str, len and hash
2567 are used. If so, len and hash must both be valid for str.
2570 S_unshare_hek_or_pvn(pTHX_ const HEK *hek, const char *str, I32 len, U32 hash)
2573 register XPVHV* xhv;
2575 register HE **oentry;
2576 bool is_utf8 = FALSE;
2578 const char * const save = str;
2579 struct shared_he *he = NULL;
2582 /* Find the shared he which is just before us in memory. */
2583 he = (struct shared_he *)(((char *)hek)
2584 - STRUCT_OFFSET(struct shared_he,
2587 /* Assert that the caller passed us a genuine (or at least consistent)
2589 assert (he->shared_he_he.hent_hek == hek);
2591 if (he->shared_he_he.he_valu.hent_refcount - 1) {
2592 --he->shared_he_he.he_valu.hent_refcount;
2596 hash = HEK_HASH(hek);
2597 } else if (len < 0) {
2598 STRLEN tmplen = -len;
2600 /* See the note in hv_fetch(). --jhi */
2601 str = (char*)bytes_from_utf8((U8*)str, &tmplen, &is_utf8);
2604 k_flags = HVhek_UTF8;
2606 k_flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
2609 /* what follows was the moral equivalent of:
2610 if ((Svp = hv_fetch(PL_strtab, tmpsv, FALSE, hash))) {
2612 hv_delete(PL_strtab, str, len, G_DISCARD, hash);
2614 xhv = (XPVHV*)SvANY(PL_strtab);
2615 /* assert(xhv_array != 0) */
2616 oentry = &(HvARRAY(PL_strtab))[hash & (I32) HvMAX(PL_strtab)];
2618 const HE *const he_he = &(he->shared_he_he);
2619 for (entry = *oentry; entry; oentry = &HeNEXT(entry), entry = *oentry) {
2624 const int flags_masked = k_flags & HVhek_MASK;
2625 for (entry = *oentry; entry; oentry = &HeNEXT(entry), entry = *oentry) {
2626 if (HeHASH(entry) != hash) /* strings can't be equal */
2628 if (HeKLEN(entry) != len)
2630 if (HeKEY(entry) != str && memNE(HeKEY(entry),str,len)) /* is this it? */
2632 if (HeKFLAGS(entry) != flags_masked)
2639 if (--entry->he_valu.hent_refcount == 0) {
2640 *oentry = HeNEXT(entry);
2642 xhv->xhv_keys--; /* HvTOTALKEYS(hv)-- */
2647 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
2648 "Attempt to free nonexistent shared string '%s'%s"
2650 hek ? HEK_KEY(hek) : str,
2651 ((k_flags & HVhek_UTF8) ? " (utf8)" : "") pTHX__VALUE);
2652 if (k_flags & HVhek_FREEKEY)
2656 /* get a (constant) string ptr from the global string table
2657 * string will get added if it is not already there.
2658 * len and hash must both be valid for str.
2661 Perl_share_hek(pTHX_ const char *str, I32 len, register U32 hash)
2663 bool is_utf8 = FALSE;
2665 const char * const save = str;
2667 PERL_ARGS_ASSERT_SHARE_HEK;
2670 STRLEN tmplen = -len;
2672 /* See the note in hv_fetch(). --jhi */
2673 str = (char*)bytes_from_utf8((U8*)str, &tmplen, &is_utf8);
2675 /* If we were able to downgrade here, then than means that we were passed
2676 in a key which only had chars 0-255, but was utf8 encoded. */
2679 /* If we found we were able to downgrade the string to bytes, then
2680 we should flag that it needs upgrading on keys or each. Also flag
2681 that we need share_hek_flags to free the string. */
2683 PERL_HASH(hash, str, len);
2684 flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
2688 return share_hek_flags (str, len, hash, flags);
2692 S_share_hek_flags(pTHX_ const char *str, I32 len, register U32 hash, int flags)
2696 const int flags_masked = flags & HVhek_MASK;
2697 const U32 hindex = hash & (I32) HvMAX(PL_strtab);
2698 register XPVHV * const xhv = (XPVHV*)SvANY(PL_strtab);
2700 PERL_ARGS_ASSERT_SHARE_HEK_FLAGS;
2702 /* what follows is the moral equivalent of:
2704 if (!(Svp = hv_fetch(PL_strtab, str, len, FALSE)))
2705 hv_store(PL_strtab, str, len, NULL, hash);
2707 Can't rehash the shared string table, so not sure if it's worth
2708 counting the number of entries in the linked list
2711 /* assert(xhv_array != 0) */
2712 entry = (HvARRAY(PL_strtab))[hindex];
2713 for (;entry; entry = HeNEXT(entry)) {
2714 if (HeHASH(entry) != hash) /* strings can't be equal */
2716 if (HeKLEN(entry) != len)
2718 if (HeKEY(entry) != str && memNE(HeKEY(entry),str,len)) /* is this it? */
2720 if (HeKFLAGS(entry) != flags_masked)
2726 /* What used to be head of the list.
2727 If this is NULL, then we're the first entry for this slot, which
2728 means we need to increate fill. */
2729 struct shared_he *new_entry;
2732 HE **const head = &HvARRAY(PL_strtab)[hindex];
2733 HE *const next = *head;
2735 /* We don't actually store a HE from the arena and a regular HEK.
2736 Instead we allocate one chunk of memory big enough for both,
2737 and put the HEK straight after the HE. This way we can find the
2738 HEK directly from the HE.
2741 Newx(k, STRUCT_OFFSET(struct shared_he,
2742 shared_he_hek.hek_key[0]) + len + 2, char);
2743 new_entry = (struct shared_he *)k;
2744 entry = &(new_entry->shared_he_he);
2745 hek = &(new_entry->shared_he_hek);
2747 Copy(str, HEK_KEY(hek), len, char);
2748 HEK_KEY(hek)[len] = 0;
2750 HEK_HASH(hek) = hash;
2751 HEK_FLAGS(hek) = (unsigned char)flags_masked;
2753 /* Still "point" to the HEK, so that other code need not know what
2755 HeKEY_hek(entry) = hek;
2756 entry->he_valu.hent_refcount = 0;
2757 HeNEXT(entry) = next;
2760 xhv->xhv_keys++; /* HvTOTALKEYS(hv)++ */
2761 if (!next) { /* initial entry? */
2762 } else if (xhv->xhv_keys > xhv->xhv_max /* HvUSEDKEYS(hv) > HvMAX(hv) */) {
2767 ++entry->he_valu.hent_refcount;
2769 if (flags & HVhek_FREEKEY)
2772 return HeKEY_hek(entry);
2776 Perl_hv_placeholders_p(pTHX_ HV *hv)
2779 MAGIC *mg = mg_find((const SV *)hv, PERL_MAGIC_rhash);
2781 PERL_ARGS_ASSERT_HV_PLACEHOLDERS_P;
2784 mg = sv_magicext(MUTABLE_SV(hv), 0, PERL_MAGIC_rhash, 0, 0, 0);
2787 Perl_die(aTHX_ "panic: hv_placeholders_p");
2790 return &(mg->mg_len);
2795 Perl_hv_placeholders_get(pTHX_ const HV *hv)
2798 MAGIC * const mg = mg_find((const SV *)hv, PERL_MAGIC_rhash);
2800 PERL_ARGS_ASSERT_HV_PLACEHOLDERS_GET;
2802 return mg ? mg->mg_len : 0;
2806 Perl_hv_placeholders_set(pTHX_ HV *hv, I32 ph)
2809 MAGIC * const mg = mg_find((const SV *)hv, PERL_MAGIC_rhash);
2811 PERL_ARGS_ASSERT_HV_PLACEHOLDERS_SET;
2816 if (!sv_magicext(MUTABLE_SV(hv), 0, PERL_MAGIC_rhash, 0, 0, ph))
2817 Perl_die(aTHX_ "panic: hv_placeholders_set");
2819 /* else we don't need to add magic to record 0 placeholders. */
2823 S_refcounted_he_value(pTHX_ const struct refcounted_he *he)
2828 PERL_ARGS_ASSERT_REFCOUNTED_HE_VALUE;
2830 switch(he->refcounted_he_data[0] & HVrhek_typemask) {
2835 value = &PL_sv_placeholder;
2838 value = newSViv(he->refcounted_he_val.refcounted_he_u_iv);
2841 value = newSVuv(he->refcounted_he_val.refcounted_he_u_uv);
2844 case HVrhek_PV_UTF8:
2845 /* Create a string SV that directly points to the bytes in our
2847 value = newSV_type(SVt_PV);
2848 SvPV_set(value, (char *) he->refcounted_he_data + 1);
2849 SvCUR_set(value, he->refcounted_he_val.refcounted_he_u_len);
2850 /* This stops anything trying to free it */
2851 SvLEN_set(value, 0);
2853 SvREADONLY_on(value);
2854 if ((he->refcounted_he_data[0] & HVrhek_typemask) == HVrhek_PV_UTF8)
2858 Perl_croak(aTHX_ "panic: refcounted_he_value bad flags %"UVxf,
2859 (UV)he->refcounted_he_data[0]);
2865 =for apidoc m|HV *|refcounted_he_chain_2hv|const struct refcounted_he *c|U32 flags
2867 Generates and returns a C<HV *> representing the content of a
2868 C<refcounted_he> chain.
2869 I<flags> is currently unused and must be zero.
2874 Perl_refcounted_he_chain_2hv(pTHX_ const struct refcounted_he *chain, U32 flags)
2878 U32 placeholders, max;
2881 Perl_croak(aTHX_ "panic: refcounted_he_chain_2hv bad flags %"UVxf,
2884 /* We could chase the chain once to get an idea of the number of keys,
2885 and call ksplit. But for now we'll make a potentially inefficient
2886 hash with only 8 entries in its array. */
2891 Newxz(array, PERL_HV_ARRAY_ALLOC_BYTES(max + 1), char);
2892 HvARRAY(hv) = (HE**)array;
2898 U32 hash = chain->refcounted_he_hash;
2900 U32 hash = HEK_HASH(chain->refcounted_he_hek);
2902 HE **oentry = &((HvARRAY(hv))[hash & max]);
2903 HE *entry = *oentry;
2906 for (; entry; entry = HeNEXT(entry)) {
2907 if (HeHASH(entry) == hash) {
2908 /* We might have a duplicate key here. If so, entry is older
2909 than the key we've already put in the hash, so if they are
2910 the same, skip adding entry. */
2912 const STRLEN klen = HeKLEN(entry);
2913 const char *const key = HeKEY(entry);
2914 if (klen == chain->refcounted_he_keylen
2915 && (!!HeKUTF8(entry)
2916 == !!(chain->refcounted_he_data[0] & HVhek_UTF8))
2917 && memEQ(key, REF_HE_KEY(chain), klen))
2920 if (HeKEY_hek(entry) == chain->refcounted_he_hek)
2922 if (HeKLEN(entry) == HEK_LEN(chain->refcounted_he_hek)
2923 && HeKUTF8(entry) == HEK_UTF8(chain->refcounted_he_hek)
2924 && memEQ(HeKEY(entry), HEK_KEY(chain->refcounted_he_hek),
2935 = share_hek_flags(REF_HE_KEY(chain),
2936 chain->refcounted_he_keylen,
2937 chain->refcounted_he_hash,
2938 (chain->refcounted_he_data[0]
2939 & (HVhek_UTF8|HVhek_WASUTF8)));
2941 HeKEY_hek(entry) = share_hek_hek(chain->refcounted_he_hek);
2943 value = refcounted_he_value(chain);
2944 if (value == &PL_sv_placeholder)
2946 HeVAL(entry) = value;
2948 /* Link it into the chain. */
2949 HeNEXT(entry) = *oentry;
2955 chain = chain->refcounted_he_next;
2959 clear_placeholders(hv, placeholders);
2960 HvTOTALKEYS(hv) -= placeholders;
2963 /* We could check in the loop to see if we encounter any keys with key
2964 flags, but it's probably not worth it, as this per-hash flag is only
2965 really meant as an optimisation for things like Storable. */
2967 DEBUG_A(Perl_hv_assert(aTHX_ hv));
2973 =for apidoc m|SV *|refcounted_he_fetch_pvn|const struct refcounted_he *chain|const char *keypv|STRLEN keylen|U32 hash|U32 flags
2975 Search along a C<refcounted_he> chain for an entry with the key specified
2976 by I<keypv> and I<keylen>. If I<flags> has the C<REFCOUNTED_HE_KEY_UTF8>
2977 bit set, the key octets are interpreted as UTF-8, otherwise they
2978 are interpreted as Latin-1. I<hash> is a precomputed hash of the key
2979 string, or zero if it has not been precomputed. Returns a mortal scalar
2980 representing the value associated with the key, or C<&PL_sv_placeholder>
2981 if there is no value associated with the key.
2987 Perl_refcounted_he_fetch_pvn(pTHX_ const struct refcounted_he *chain,
2988 const char *keypv, STRLEN keylen, U32 hash, U32 flags)
2992 PERL_ARGS_ASSERT_REFCOUNTED_HE_FETCH_PVN;
2994 if (flags & ~REFCOUNTED_HE_KEY_UTF8)
2995 Perl_croak(aTHX_ "panic: refcounted_he_fetch_pvn bad flags %"UVxf,
2998 return &PL_sv_placeholder;
2999 if (flags & REFCOUNTED_HE_KEY_UTF8) {
3000 /* For searching purposes, canonicalise to Latin-1 where possible. */
3001 const char *keyend = keypv + keylen, *p;
3002 STRLEN nonascii_count = 0;
3003 for (p = keypv; p != keyend; p++) {
3006 if (!((c & 0xfe) == 0xc2 && ++p != keyend &&
3007 (((U8)*p) & 0xc0) == 0x80))
3008 goto canonicalised_key;
3012 if (nonascii_count) {
3014 const char *p = keypv, *keyend = keypv + keylen;
3015 keylen -= nonascii_count;
3016 Newx(q, keylen, char);
3019 for (; p != keyend; p++, q++) {
3022 ((c & 0x80) ? ((c & 0x03) << 6) | (((U8)*++p) & 0x3f) : c);
3025 flags &= ~REFCOUNTED_HE_KEY_UTF8;
3026 canonicalised_key: ;
3028 utf8_flag = (flags & REFCOUNTED_HE_KEY_UTF8) ? HVhek_UTF8 : 0;
3030 PERL_HASH(hash, keypv, keylen);
3032 for (; chain; chain = chain->refcounted_he_next) {
3035 hash == chain->refcounted_he_hash &&
3036 keylen == chain->refcounted_he_keylen &&
3037 memEQ(REF_HE_KEY(chain), keypv, keylen) &&
3038 utf8_flag == (chain->refcounted_he_data[0] & HVhek_UTF8)
3040 hash == HEK_HASH(chain->refcounted_he_hek) &&
3041 keylen == (STRLEN)HEK_LEN(chain->refcounted_he_hek) &&
3042 memEQ(HEK_KEY(chain->refcounted_he_hek), keypv, keylen) &&
3043 utf8_flag == (HEK_FLAGS(chain->refcounted_he_hek) & HVhek_UTF8)
3046 return sv_2mortal(refcounted_he_value(chain));
3048 return &PL_sv_placeholder;
3052 =for apidoc m|SV *|refcounted_he_fetch_pv|const struct refcounted_he *chain|const char *key|U32 hash|U32 flags
3054 Like L</refcounted_he_fetch_pvn>, but takes a nul-terminated string
3055 instead of a string/length pair.
3061 Perl_refcounted_he_fetch_pv(pTHX_ const struct refcounted_he *chain,
3062 const char *key, U32 hash, U32 flags)
3064 PERL_ARGS_ASSERT_REFCOUNTED_HE_FETCH_PV;
3065 return refcounted_he_fetch_pvn(chain, key, strlen(key), hash, flags);
3069 =for apidoc m|SV *|refcounted_he_fetch_sv|const struct refcounted_he *chain|SV *key|U32 hash|U32 flags
3071 Like L</refcounted_he_fetch_pvn>, but takes a Perl scalar instead of a
3078 Perl_refcounted_he_fetch_sv(pTHX_ const struct refcounted_he *chain,
3079 SV *key, U32 hash, U32 flags)
3083 PERL_ARGS_ASSERT_REFCOUNTED_HE_FETCH_SV;
3084 if (flags & REFCOUNTED_HE_KEY_UTF8)
3085 Perl_croak(aTHX_ "panic: refcounted_he_fetch_sv bad flags %"UVxf,
3087 keypv = SvPV_const(key, keylen);
3089 flags |= REFCOUNTED_HE_KEY_UTF8;
3090 if (!hash && SvIsCOW_shared_hash(key))
3091 hash = SvSHARED_HASH(key);
3092 return refcounted_he_fetch_pvn(chain, keypv, keylen, hash, flags);
3096 =for apidoc m|struct refcounted_he *|refcounted_he_new_pvn|struct refcounted_he *parent|const char *keypv|STRLEN keylen|U32 hash|SV *value|U32 flags
3098 Creates a new C<refcounted_he>. This consists of a single key/value
3099 pair and a reference to an existing C<refcounted_he> chain (which may
3100 be empty), and thus forms a longer chain. When using the longer chain,
3101 the new key/value pair takes precedence over any entry for the same key
3102 further along the chain.
3104 The new key is specified by I<keypv> and I<keylen>. If I<flags> has
3105 the C<REFCOUNTED_HE_KEY_UTF8> bit set, the key octets are interpreted
3106 as UTF-8, otherwise they are interpreted as Latin-1. I<hash> is
3107 a precomputed hash of the key string, or zero if it has not been
3110 I<value> is the scalar value to store for this key. I<value> is copied
3111 by this function, which thus does not take ownership of any reference
3112 to it, and later changes to the scalar will not be reflected in the
3113 value visible in the C<refcounted_he>. Complex types of scalar will not
3114 be stored with referential integrity, but will be coerced to strings.
3115 I<value> may be either null or C<&PL_sv_placeholder> to indicate that no
3116 value is to be associated with the key; this, as with any non-null value,
3117 takes precedence over the existence of a value for the key further along
3120 I<parent> points to the rest of the C<refcounted_he> chain to be
3121 attached to the new C<refcounted_he>. This function takes ownership
3122 of one reference to I<parent>, and returns one reference to the new
3128 struct refcounted_he *
3129 Perl_refcounted_he_new_pvn(pTHX_ struct refcounted_he *parent,
3130 const char *keypv, STRLEN keylen, U32 hash, SV *value, U32 flags)
3133 STRLEN value_len = 0;
3134 const char *value_p = NULL;
3138 STRLEN key_offset = 1;
3139 struct refcounted_he *he;
3140 PERL_ARGS_ASSERT_REFCOUNTED_HE_NEW_PVN;
3142 if (!value || value == &PL_sv_placeholder) {
3143 value_type = HVrhek_delete;
3144 } else if (SvPOK(value)) {
3145 value_type = HVrhek_PV;
3146 } else if (SvIOK(value)) {
3147 value_type = SvUOK((const SV *)value) ? HVrhek_UV : HVrhek_IV;
3148 } else if (!SvOK(value)) {
3149 value_type = HVrhek_undef;
3151 value_type = HVrhek_PV;
3153 is_pv = value_type == HVrhek_PV;
3155 /* Do it this way so that the SvUTF8() test is after the SvPV, in case
3156 the value is overloaded, and doesn't yet have the UTF-8flag set. */
3157 value_p = SvPV_const(value, value_len);
3159 value_type = HVrhek_PV_UTF8;
3160 key_offset = value_len + 2;
3162 hekflags = value_type;
3164 if (flags & REFCOUNTED_HE_KEY_UTF8) {
3165 /* Canonicalise to Latin-1 where possible. */
3166 const char *keyend = keypv + keylen, *p;
3167 STRLEN nonascii_count = 0;
3168 for (p = keypv; p != keyend; p++) {
3171 if (!((c & 0xfe) == 0xc2 && ++p != keyend &&
3172 (((U8)*p) & 0xc0) == 0x80))
3173 goto canonicalised_key;
3177 if (nonascii_count) {
3179 const char *p = keypv, *keyend = keypv + keylen;
3180 keylen -= nonascii_count;
3181 Newx(q, keylen, char);
3184 for (; p != keyend; p++, q++) {
3187 ((c & 0x80) ? ((c & 0x03) << 6) | (((U8)*++p) & 0x3f) : c);
3190 flags &= ~REFCOUNTED_HE_KEY_UTF8;
3191 canonicalised_key: ;
3193 if (flags & REFCOUNTED_HE_KEY_UTF8)
3194 hekflags |= HVhek_UTF8;
3196 PERL_HASH(hash, keypv, keylen);
3199 he = (struct refcounted_he*)
3200 PerlMemShared_malloc(sizeof(struct refcounted_he) - 1
3204 he = (struct refcounted_he*)
3205 PerlMemShared_malloc(sizeof(struct refcounted_he) - 1
3209 he->refcounted_he_next = parent;
3212 Copy(value_p, he->refcounted_he_data + 1, value_len + 1, char);
3213 he->refcounted_he_val.refcounted_he_u_len = value_len;
3214 } else if (value_type == HVrhek_IV) {
3215 he->refcounted_he_val.refcounted_he_u_iv = SvIVX(value);
3216 } else if (value_type == HVrhek_UV) {
3217 he->refcounted_he_val.refcounted_he_u_uv = SvUVX(value);
3221 he->refcounted_he_hash = hash;
3222 he->refcounted_he_keylen = keylen;
3223 Copy(keypv, he->refcounted_he_data + key_offset, keylen, char);
3225 he->refcounted_he_hek = share_hek_flags(keypv, keylen, hash, hekflags);
3228 he->refcounted_he_data[0] = hekflags;
3229 he->refcounted_he_refcnt = 1;
3235 =for apidoc m|struct refcounted_he *|refcounted_he_new_pv|struct refcounted_he *parent|const char *key|U32 hash|SV *value|U32 flags
3237 Like L</refcounted_he_new_pvn>, but takes a nul-terminated string instead
3238 of a string/length pair.
3243 struct refcounted_he *
3244 Perl_refcounted_he_new_pv(pTHX_ struct refcounted_he *parent,
3245 const char *key, U32 hash, SV *value, U32 flags)
3247 PERL_ARGS_ASSERT_REFCOUNTED_HE_NEW_PV;
3248 return refcounted_he_new_pvn(parent, key, strlen(key), hash, value, flags);
3252 =for apidoc m|struct refcounted_he *|refcounted_he_new_sv|struct refcounted_he *parent|SV *key|U32 hash|SV *value|U32 flags
3254 Like L</refcounted_he_new_pvn>, but takes a Perl scalar instead of a
3260 struct refcounted_he *
3261 Perl_refcounted_he_new_sv(pTHX_ struct refcounted_he *parent,
3262 SV *key, U32 hash, SV *value, U32 flags)
3266 PERL_ARGS_ASSERT_REFCOUNTED_HE_NEW_SV;
3267 if (flags & REFCOUNTED_HE_KEY_UTF8)
3268 Perl_croak(aTHX_ "panic: refcounted_he_new_sv bad flags %"UVxf,
3270 keypv = SvPV_const(key, keylen);
3272 flags |= REFCOUNTED_HE_KEY_UTF8;
3273 if (!hash && SvIsCOW_shared_hash(key))
3274 hash = SvSHARED_HASH(key);
3275 return refcounted_he_new_pvn(parent, keypv, keylen, hash, value, flags);
3279 =for apidoc m|void|refcounted_he_free|struct refcounted_he *he
3281 Decrements the reference count of a C<refcounted_he> by one. If the
3282 reference count reaches zero the structure's memory is freed, which
3283 (recursively) causes a reduction of its parent C<refcounted_he>'s
3284 reference count. It is safe to pass a null pointer to this function:
3285 no action occurs in this case.
3291 Perl_refcounted_he_free(pTHX_ struct refcounted_he *he) {
3293 PERL_UNUSED_CONTEXT;
3296 struct refcounted_he *copy;
3300 new_count = --he->refcounted_he_refcnt;
3301 HINTS_REFCNT_UNLOCK;
3307 #ifndef USE_ITHREADS
3308 unshare_hek_or_pvn (he->refcounted_he_hek, 0, 0, 0);
3311 he = he->refcounted_he_next;
3312 PerlMemShared_free(copy);
3317 =for apidoc m|struct refcounted_he *|refcounted_he_inc|struct refcounted_he *he
3319 Increment the reference count of a C<refcounted_he>. The pointer to the
3320 C<refcounted_he> is also returned. It is safe to pass a null pointer
3321 to this function: no action occurs and a null pointer is returned.
3326 struct refcounted_he *
3327 Perl_refcounted_he_inc(pTHX_ struct refcounted_he *he)
3332 he->refcounted_he_refcnt++;
3333 HINTS_REFCNT_UNLOCK;
3339 =for apidoc cop_fetch_label
3341 Returns the label attached to a cop.
3342 The flags pointer may be set to C<SVf_UTF8> or 0.
3347 /* pp_entereval is aware that labels are stored with a key ':' at the top of
3350 Perl_cop_fetch_label(pTHX_ COP *const cop, STRLEN *len, U32 *flags) {
3351 struct refcounted_he *const chain = cop->cop_hints_hash;
3353 PERL_ARGS_ASSERT_COP_FETCH_LABEL;
3358 if (chain->refcounted_he_keylen != 1)
3360 if (*REF_HE_KEY(chain) != ':')
3363 if ((STRLEN)HEK_LEN(chain->refcounted_he_hek) != 1)
3365 if (*HEK_KEY(chain->refcounted_he_hek) != ':')
3368 /* Stop anyone trying to really mess us up by adding their own value for
3370 if ((chain->refcounted_he_data[0] & HVrhek_typemask) != HVrhek_PV
3371 && (chain->refcounted_he_data[0] & HVrhek_typemask) != HVrhek_PV_UTF8)
3375 *len = chain->refcounted_he_val.refcounted_he_u_len;
3377 *flags = ((chain->refcounted_he_data[0] & HVrhek_typemask)
3378 == HVrhek_PV_UTF8) ? SVf_UTF8 : 0;
3380 return chain->refcounted_he_data + 1;
3384 =for apidoc cop_store_label
3386 Save a label into a C<cop_hints_hash>. You need to set flags to C<SVf_UTF8>
3393 Perl_cop_store_label(pTHX_ COP *const cop, const char *label, STRLEN len,
3397 PERL_ARGS_ASSERT_COP_STORE_LABEL;
3399 if (flags & ~(SVf_UTF8))
3400 Perl_croak(aTHX_ "panic: cop_store_label illegal flag bits 0x%" UVxf,
3402 labelsv = newSVpvn_flags(label, len, SVs_TEMP);
3403 if (flags & SVf_UTF8)
3406 = refcounted_he_new_pvs(cop->cop_hints_hash, ":", labelsv, 0);
3410 =for apidoc hv_assert
3412 Check that a hash is in an internally consistent state.
3420 Perl_hv_assert(pTHX_ HV *hv)
3425 int placeholders = 0;
3428 const I32 riter = HvRITER_get(hv);
3429 HE *eiter = HvEITER_get(hv);
3431 PERL_ARGS_ASSERT_HV_ASSERT;
3433 (void)hv_iterinit(hv);
3435 while ((entry = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS))) {
3436 /* sanity check the values */
3437 if (HeVAL(entry) == &PL_sv_placeholder)
3441 /* sanity check the keys */
3442 if (HeSVKEY(entry)) {
3443 NOOP; /* Don't know what to check on SV keys. */
3444 } else if (HeKUTF8(entry)) {
3446 if (HeKWASUTF8(entry)) {
3447 PerlIO_printf(Perl_debug_log,
3448 "hash key has both WASUTF8 and UTF8: '%.*s'\n",
3449 (int) HeKLEN(entry), HeKEY(entry));
3452 } else if (HeKWASUTF8(entry))
3455 if (!SvTIED_mg((const SV *)hv, PERL_MAGIC_tied)) {
3456 static const char bad_count[] = "Count %d %s(s), but hash reports %d\n";
3457 const int nhashkeys = HvUSEDKEYS(hv);
3458 const int nhashplaceholders = HvPLACEHOLDERS_get(hv);
3460 if (nhashkeys != real) {
3461 PerlIO_printf(Perl_debug_log, bad_count, real, "keys", nhashkeys );
3464 if (nhashplaceholders != placeholders) {
3465 PerlIO_printf(Perl_debug_log, bad_count, placeholders, "placeholder", nhashplaceholders );
3469 if (withflags && ! HvHASKFLAGS(hv)) {
3470 PerlIO_printf(Perl_debug_log,
3471 "Hash has HASKFLAGS off but I count %d key(s) with flags\n",
3476 sv_dump(MUTABLE_SV(hv));
3478 HvRITER_set(hv, riter); /* Restore hash iterator state */
3479 HvEITER_set(hv, eiter);
3486 * c-indentation-style: bsd
3488 * indent-tabs-mode: t
3491 * ex: set ts=8 sts=4 sw=4 noet: