3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 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 of all that I have seen." --Bilbo
16 =head1 Hash Manipulation Functions
18 A HV structure represents a Perl hash. It consists mainly of an array
19 of pointers, each of which points to a linked list of HE structures. The
20 array is indexed by the hash function of the key, so each linked list
21 represents all the hash entries with the same hash value. Each HE contains
22 a pointer to the actual value, plus a pointer to a HEK structure which
23 holds the key and hash value.
31 #define PERL_HASH_INTERNAL_ACCESS
34 #define HV_MAX_LENGTH_BEFORE_SPLIT 14
36 static const char S_strtab_error[]
37 = "Cannot modify shared string table in hv_%s";
43 HE* he = (HE*) Perl_get_arena(aTHX_ PERL_ARENA_SIZE, HE_SVSLOT);
44 HE * const heend = &he[PERL_ARENA_SIZE / sizeof(HE) - 1];
46 PL_body_roots[HE_SVSLOT] = he;
48 HeNEXT(he) = (HE*)(he + 1);
56 #define new_HE() (HE*)safemalloc(sizeof(HE))
57 #define del_HE(p) safefree((char*)p)
66 void ** const root = &PL_body_roots[HE_SVSLOT];
76 #define new_HE() new_he()
79 HeNEXT(p) = (HE*)(PL_body_roots[HE_SVSLOT]); \
80 PL_body_roots[HE_SVSLOT] = p; \
88 S_save_hek_flags(const char *str, I32 len, U32 hash, int flags)
90 const int flags_masked = flags & HVhek_MASK;
94 Newx(k, HEK_BASESIZE + len + 2, char);
96 Copy(str, HEK_KEY(hek), len, char);
97 HEK_KEY(hek)[len] = 0;
100 HEK_FLAGS(hek) = (unsigned char)flags_masked | HVhek_UNSHARED;
102 if (flags & HVhek_FREEKEY)
107 /* free the pool of temporary HE/HEK pairs returned by hv_fetch_ent
111 Perl_free_tied_hv_pool(pTHX)
114 HE *he = PL_hv_fetch_ent_mh;
117 Safefree(HeKEY_hek(he));
121 PL_hv_fetch_ent_mh = NULL;
124 #if defined(USE_ITHREADS)
126 Perl_hek_dup(pTHX_ HEK *source, CLONE_PARAMS* param)
128 HEK *shared = (HEK*)ptr_table_fetch(PL_ptr_table, source);
130 PERL_UNUSED_ARG(param);
133 /* We already shared this hash key. */
134 (void)share_hek_hek(shared);
138 = share_hek_flags(HEK_KEY(source), HEK_LEN(source),
139 HEK_HASH(source), HEK_FLAGS(source));
140 ptr_table_store(PL_ptr_table, source, shared);
146 Perl_he_dup(pTHX_ const HE *e, bool shared, CLONE_PARAMS* param)
152 /* look for it in the table first */
153 ret = (HE*)ptr_table_fetch(PL_ptr_table, e);
157 /* create anew and remember what it is */
159 ptr_table_store(PL_ptr_table, e, ret);
161 HeNEXT(ret) = he_dup(HeNEXT(e),shared, param);
162 if (HeKLEN(e) == HEf_SVKEY) {
164 Newx(k, HEK_BASESIZE + sizeof(SV*), char);
165 HeKEY_hek(ret) = (HEK*)k;
166 HeKEY_sv(ret) = SvREFCNT_inc(sv_dup(HeKEY_sv(e), param));
169 /* This is hek_dup inlined, which seems to be important for speed
171 HEK * const source = HeKEY_hek(e);
172 HEK *shared = (HEK*)ptr_table_fetch(PL_ptr_table, source);
175 /* We already shared this hash key. */
176 (void)share_hek_hek(shared);
180 = share_hek_flags(HEK_KEY(source), HEK_LEN(source),
181 HEK_HASH(source), HEK_FLAGS(source));
182 ptr_table_store(PL_ptr_table, source, shared);
184 HeKEY_hek(ret) = shared;
187 HeKEY_hek(ret) = save_hek_flags(HeKEY(e), HeKLEN(e), HeHASH(e),
189 HeVAL(ret) = SvREFCNT_inc(sv_dup(HeVAL(e), param));
192 #endif /* USE_ITHREADS */
195 S_hv_notallowed(pTHX_ int flags, const char *key, I32 klen,
198 SV * const sv = sv_newmortal();
199 if (!(flags & HVhek_FREEKEY)) {
200 sv_setpvn(sv, key, klen);
203 /* Need to free saved eventually assign to mortal SV */
204 /* XXX is this line an error ???: SV *sv = sv_newmortal(); */
205 sv_usepvn(sv, (char *) key, klen);
207 if (flags & HVhek_UTF8) {
210 Perl_croak(aTHX_ msg, SVfARG(sv));
213 /* (klen == HEf_SVKEY) is special for MAGICAL hv entries, meaning key slot
219 Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
220 the length of the key. The C<hash> parameter is the precomputed hash
221 value; if it is zero then Perl will compute it. The return value will be
222 NULL if the operation failed or if the value did not need to be actually
223 stored within the hash (as in the case of tied hashes). Otherwise it can
224 be dereferenced to get the original C<SV*>. Note that the caller is
225 responsible for suitably incrementing the reference count of C<val> before
226 the call, and decrementing it if the function returned NULL. Effectively
227 a successful hv_store takes ownership of one reference to C<val>. This is
228 usually what you want; a newly created SV has a reference count of one, so
229 if all your code does is create SVs then store them in a hash, hv_store
230 will own the only reference to the new SV, and your code doesn't need to do
231 anything further to tidy up. hv_store is not implemented as a call to
232 hv_store_ent, and does not create a temporary SV for the key, so if your
233 key data is not already in SV form then use hv_store in preference to
236 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
237 information on how to use this function on tied hashes.
243 =for apidoc hv_store_ent
245 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
246 parameter is the precomputed hash value; if it is zero then Perl will
247 compute it. The return value is the new hash entry so created. It will be
248 NULL if the operation failed or if the value did not need to be actually
249 stored within the hash (as in the case of tied hashes). Otherwise the
250 contents of the return value can be accessed using the C<He?> macros
251 described here. Note that the caller is responsible for suitably
252 incrementing the reference count of C<val> before the call, and
253 decrementing it if the function returned NULL. Effectively a successful
254 hv_store_ent takes ownership of one reference to C<val>. This is
255 usually what you want; a newly created SV has a reference count of one, so
256 if all your code does is create SVs then store them in a hash, hv_store
257 will own the only reference to the new SV, and your code doesn't need to do
258 anything further to tidy up. Note that hv_store_ent only reads the C<key>;
259 unlike C<val> it does not take ownership of it, so maintaining the correct
260 reference count on C<key> is entirely the caller's responsibility. hv_store
261 is not implemented as a call to hv_store_ent, and does not create a temporary
262 SV for the key, so if your key data is not already in SV form then use
263 hv_store in preference to hv_store_ent.
265 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
266 information on how to use this function on tied hashes.
272 =for apidoc hv_exists
274 Returns a boolean indicating whether the specified hash key exists. The
275 C<klen> is the length of the key.
283 Returns the SV which corresponds to the specified key in the hash. The
284 C<klen> is the length of the key. If C<lval> is set then the fetch will be
285 part of a store. Check that the return value is non-null before
286 dereferencing it to an C<SV*>.
288 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
289 information on how to use this function on tied hashes.
295 =for apidoc hv_exists_ent
297 Returns a boolean indicating whether the specified hash key exists. C<hash>
298 can be a valid precomputed hash value, or 0 to ask for it to be
304 /* returns an HE * structure with the all fields set */
305 /* note that hent_val will be a mortal sv for MAGICAL hashes */
307 =for apidoc hv_fetch_ent
309 Returns the hash entry which corresponds to the specified key in the hash.
310 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
311 if you want the function to compute it. IF C<lval> is set then the fetch
312 will be part of a store. Make sure the return value is non-null before
313 accessing it. The return value when C<tb> is a tied hash is a pointer to a
314 static location, so be sure to make a copy of the structure if you need to
317 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
318 information on how to use this function on tied hashes.
323 /* Common code for hv_delete()/hv_exists()/hv_fetch()/hv_store() */
325 Perl_hv_common_key_len(pTHX_ HV *hv, const char *key, I32 klen_i32,
326 const int action, SV *val, const U32 hash)
338 return hv_common(hv, NULL, key, klen, flags, action, val, hash);
342 Perl_hv_common(pTHX_ HV *hv, SV *keysv, const char *key, STRLEN klen,
343 int flags, int action, SV *val, register U32 hash)
352 const int return_svp = action & HV_FETCH_JUST_SV;
356 if (SvTYPE(hv) == SVTYPEMASK)
359 assert(SvTYPE(hv) == SVt_PVHV);
361 if (SvSMAGICAL(hv) && SvGMAGICAL(hv) && !(action & HV_DISABLE_UVAR_XKEY)) {
363 if ((mg = mg_find((SV*)hv, PERL_MAGIC_uvar))) {
364 struct ufuncs * const uf = (struct ufuncs *)mg->mg_ptr;
365 if (uf->uf_set == NULL) {
366 SV* obj = mg->mg_obj;
369 keysv = sv_2mortal(newSVpvn(key, klen));
370 if (flags & HVhek_UTF8)
374 mg->mg_obj = keysv; /* pass key */
375 uf->uf_index = action; /* pass action */
376 magic_getuvar((SV*)hv, mg);
377 keysv = mg->mg_obj; /* may have changed */
380 /* If the key may have changed, then we need to invalidate
381 any passed-in computed hash value. */
387 if (flags & HVhek_FREEKEY)
389 key = SvPV_const(keysv, klen);
391 is_utf8 = (SvUTF8(keysv) != 0);
393 is_utf8 = ((flags & HVhek_UTF8) ? TRUE : FALSE);
396 if (action & HV_DELETE) {
397 return (void *) hv_delete_common(hv, keysv, key, klen,
398 flags | (is_utf8 ? HVhek_UTF8 : 0),
402 xhv = (XPVHV*)SvANY(hv);
404 if (SvRMAGICAL(hv) && !(action & (HV_FETCH_ISSTORE|HV_FETCH_ISEXISTS))) {
405 if ( mg_find((SV*)hv, PERL_MAGIC_tied) || SvGMAGICAL((SV*)hv))
407 /* FIXME should be able to skimp on the HE/HEK here when
408 HV_FETCH_JUST_SV is true. */
410 keysv = newSVpvn(key, klen);
415 keysv = newSVsv(keysv);
418 mg_copy((SV*)hv, sv, (char *)keysv, HEf_SVKEY);
420 /* grab a fake HE/HEK pair from the pool or make a new one */
421 entry = PL_hv_fetch_ent_mh;
423 PL_hv_fetch_ent_mh = HeNEXT(entry);
427 Newx(k, HEK_BASESIZE + sizeof(SV*), char);
428 HeKEY_hek(entry) = (HEK*)k;
430 HeNEXT(entry) = NULL;
431 HeSVKEY_set(entry, keysv);
433 sv_upgrade(sv, SVt_PVLV);
435 /* so we can free entry when freeing sv */
436 LvTARG(sv) = (SV*)entry;
438 /* XXX remove at some point? */
439 if (flags & HVhek_FREEKEY)
443 return entry ? (void *) &HeVAL(entry) : NULL;
445 return (void *) entry;
447 #ifdef ENV_IS_CASELESS
448 else if (mg_find((SV*)hv, PERL_MAGIC_env)) {
450 for (i = 0; i < klen; ++i)
451 if (isLOWER(key[i])) {
452 /* Would be nice if we had a routine to do the
453 copy and upercase in a single pass through. */
454 const char * const nkey = strupr(savepvn(key,klen));
455 /* Note that this fetch is for nkey (the uppercased
456 key) whereas the store is for key (the original) */
457 void *result = hv_common(hv, NULL, nkey, klen,
458 HVhek_FREEKEY, /* free nkey */
459 0 /* non-LVAL fetch */
460 | HV_DISABLE_UVAR_XKEY
463 0 /* compute hash */);
464 if (!entry && (action & HV_FETCH_LVALUE)) {
465 /* This call will free key if necessary.
466 Do it this way to encourage compiler to tail
468 result = hv_common(hv, keysv, key, klen, flags,
470 | HV_DISABLE_UVAR_XKEY
474 if (flags & HVhek_FREEKEY)
482 else if (SvRMAGICAL(hv) && (action & HV_FETCH_ISEXISTS)) {
483 if (mg_find((SV*)hv, PERL_MAGIC_tied) || SvGMAGICAL((SV*)hv)) {
484 /* I don't understand why hv_exists_ent has svret and sv,
485 whereas hv_exists only had one. */
486 SV * const svret = sv_newmortal();
489 if (keysv || is_utf8) {
491 keysv = newSVpvn(key, klen);
494 keysv = newSVsv(keysv);
496 mg_copy((SV*)hv, sv, (char *)sv_2mortal(keysv), HEf_SVKEY);
498 mg_copy((SV*)hv, sv, key, klen);
500 if (flags & HVhek_FREEKEY)
502 magic_existspack(svret, mg_find(sv, PERL_MAGIC_tiedelem));
503 /* This cast somewhat evil, but I'm merely using NULL/
504 not NULL to return the boolean exists.
505 And I know hv is not NULL. */
506 return SvTRUE(svret) ? (void *)hv : NULL;
508 #ifdef ENV_IS_CASELESS
509 else if (mg_find((SV*)hv, PERL_MAGIC_env)) {
510 /* XXX This code isn't UTF8 clean. */
511 char * const keysave = (char * const)key;
512 /* Will need to free this, so set FREEKEY flag. */
513 key = savepvn(key,klen);
514 key = (const char*)strupr((char*)key);
519 if (flags & HVhek_FREEKEY) {
522 flags |= HVhek_FREEKEY;
526 else if (action & HV_FETCH_ISSTORE) {
529 hv_magic_check (hv, &needs_copy, &needs_store);
531 const bool save_taint = PL_tainted;
532 if (keysv || is_utf8) {
534 keysv = newSVpvn(key, klen);
538 PL_tainted = SvTAINTED(keysv);
539 keysv = sv_2mortal(newSVsv(keysv));
540 mg_copy((SV*)hv, val, (char*)keysv, HEf_SVKEY);
542 mg_copy((SV*)hv, val, key, klen);
545 TAINT_IF(save_taint);
547 if (flags & HVhek_FREEKEY)
551 #ifdef ENV_IS_CASELESS
552 else if (mg_find((SV*)hv, PERL_MAGIC_env)) {
553 /* XXX This code isn't UTF8 clean. */
554 const char *keysave = key;
555 /* Will need to free this, so set FREEKEY flag. */
556 key = savepvn(key,klen);
557 key = (const char*)strupr((char*)key);
562 if (flags & HVhek_FREEKEY) {
565 flags |= HVhek_FREEKEY;
573 if ((action & (HV_FETCH_LVALUE | HV_FETCH_ISSTORE))
574 #ifdef DYNAMIC_ENV_FETCH /* if it's an %ENV lookup, we may get it on the fly */
575 || (SvRMAGICAL((SV*)hv) && mg_find((SV*)hv, PERL_MAGIC_env))
580 PERL_HV_ARRAY_ALLOC_BYTES(xhv->xhv_max+1 /* HvMAX(hv)+1 */),
582 HvARRAY(hv) = (HE**)array;
584 #ifdef DYNAMIC_ENV_FETCH
585 else if (action & HV_FETCH_ISEXISTS) {
586 /* for an %ENV exists, if we do an insert it's by a recursive
587 store call, so avoid creating HvARRAY(hv) right now. */
591 /* XXX remove at some point? */
592 if (flags & HVhek_FREEKEY)
600 char * const keysave = (char *)key;
601 key = (char*)bytes_from_utf8((U8*)key, &klen, &is_utf8);
605 flags &= ~HVhek_UTF8;
606 if (key != keysave) {
607 if (flags & HVhek_FREEKEY)
609 flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
614 PERL_HASH_INTERNAL(hash, key, klen);
615 /* We don't have a pointer to the hv, so we have to replicate the
616 flag into every HEK, so that hv_iterkeysv can see it. */
617 /* And yes, you do need this even though you are not "storing" because
618 you can flip the flags below if doing an lval lookup. (And that
619 was put in to give the semantics Andreas was expecting.) */
620 flags |= HVhek_REHASH;
622 if (keysv && (SvIsCOW_shared_hash(keysv))) {
623 hash = SvSHARED_HASH(keysv);
625 PERL_HASH(hash, key, klen);
629 masked_flags = (flags & HVhek_MASK);
631 #ifdef DYNAMIC_ENV_FETCH
632 if (!HvARRAY(hv)) entry = NULL;
636 entry = (HvARRAY(hv))[hash & (I32) HvMAX(hv)];
638 for (; entry; entry = HeNEXT(entry)) {
639 if (HeHASH(entry) != hash) /* strings can't be equal */
641 if (HeKLEN(entry) != (I32)klen)
643 if (HeKEY(entry) != key && memNE(HeKEY(entry),key,klen)) /* is this it? */
645 if ((HeKFLAGS(entry) ^ masked_flags) & HVhek_UTF8)
648 if (action & (HV_FETCH_LVALUE|HV_FETCH_ISSTORE)) {
649 if (HeKFLAGS(entry) != masked_flags) {
650 /* We match if HVhek_UTF8 bit in our flags and hash key's
651 match. But if entry was set previously with HVhek_WASUTF8
652 and key now doesn't (or vice versa) then we should change
653 the key's flag, as this is assignment. */
654 if (HvSHAREKEYS(hv)) {
655 /* Need to swap the key we have for a key with the flags we
656 need. As keys are shared we can't just write to the
657 flag, so we share the new one, unshare the old one. */
658 HEK * const new_hek = share_hek_flags(key, klen, hash,
660 unshare_hek (HeKEY_hek(entry));
661 HeKEY_hek(entry) = new_hek;
663 else if (hv == PL_strtab) {
664 /* PL_strtab is usually the only hash without HvSHAREKEYS,
665 so putting this test here is cheap */
666 if (flags & HVhek_FREEKEY)
668 Perl_croak(aTHX_ S_strtab_error,
669 action & HV_FETCH_LVALUE ? "fetch" : "store");
672 HeKFLAGS(entry) = masked_flags;
673 if (masked_flags & HVhek_ENABLEHVKFLAGS)
676 if (HeVAL(entry) == &PL_sv_placeholder) {
677 /* yes, can store into placeholder slot */
678 if (action & HV_FETCH_LVALUE) {
680 /* This preserves behaviour with the old hv_fetch
681 implementation which at this point would bail out
682 with a break; (at "if we find a placeholder, we
683 pretend we haven't found anything")
685 That break mean that if a placeholder were found, it
686 caused a call into hv_store, which in turn would
687 check magic, and if there is no magic end up pretty
688 much back at this point (in hv_store's code). */
691 /* LVAL fetch which actaully needs a store. */
693 HvPLACEHOLDERS(hv)--;
696 if (val != &PL_sv_placeholder)
697 HvPLACEHOLDERS(hv)--;
700 } else if (action & HV_FETCH_ISSTORE) {
701 SvREFCNT_dec(HeVAL(entry));
704 } else if (HeVAL(entry) == &PL_sv_placeholder) {
705 /* if we find a placeholder, we pretend we haven't found
709 if (flags & HVhek_FREEKEY)
712 return entry ? (void *) &HeVAL(entry) : NULL;
716 #ifdef DYNAMIC_ENV_FETCH /* %ENV lookup? If so, try to fetch the value now */
717 if (!(action & HV_FETCH_ISSTORE)
718 && SvRMAGICAL((SV*)hv) && mg_find((SV*)hv, PERL_MAGIC_env)) {
720 const char * const env = PerlEnv_ENVgetenv_len(key,&len);
722 sv = newSVpvn(env,len);
724 return hv_common(hv, keysv, key, klen, flags,
725 HV_FETCH_ISSTORE|HV_DISABLE_UVAR_XKEY|return_svp,
731 if (!entry && SvREADONLY(hv) && !(action & HV_FETCH_ISEXISTS)) {
732 hv_notallowed(flags, key, klen,
733 "Attempt to access disallowed key '%"SVf"' in"
734 " a restricted hash");
736 if (!(action & (HV_FETCH_LVALUE|HV_FETCH_ISSTORE))) {
737 /* Not doing some form of store, so return failure. */
738 if (flags & HVhek_FREEKEY)
742 if (action & HV_FETCH_LVALUE) {
745 /* At this point the old hv_fetch code would call to hv_store,
746 which in turn might do some tied magic. So we need to make that
747 magic check happen. */
748 /* gonna assign to this, so it better be there */
749 /* If a fetch-as-store fails on the fetch, then the action is to
750 recurse once into "hv_store". If we didn't do this, then that
751 recursive call would call the key conversion routine again.
752 However, as we replace the original key with the converted
753 key, this would result in a double conversion, which would show
754 up as a bug if the conversion routine is not idempotent. */
755 return hv_common(hv, keysv, key, klen, flags,
756 HV_FETCH_ISSTORE|HV_DISABLE_UVAR_XKEY|return_svp,
758 /* XXX Surely that could leak if the fetch-was-store fails?
759 Just like the hv_fetch. */
763 /* Welcome to hv_store... */
766 /* Not sure if we can get here. I think the only case of oentry being
767 NULL is for %ENV with dynamic env fetch. But that should disappear
768 with magic in the previous code. */
771 PERL_HV_ARRAY_ALLOC_BYTES(xhv->xhv_max+1 /* HvMAX(hv)+1 */),
773 HvARRAY(hv) = (HE**)array;
776 oentry = &(HvARRAY(hv))[hash & (I32) xhv->xhv_max];
779 /* share_hek_flags will do the free for us. This might be considered
782 HeKEY_hek(entry) = share_hek_flags(key, klen, hash, flags);
783 else if (hv == PL_strtab) {
784 /* PL_strtab is usually the only hash without HvSHAREKEYS, so putting
785 this test here is cheap */
786 if (flags & HVhek_FREEKEY)
788 Perl_croak(aTHX_ S_strtab_error,
789 action & HV_FETCH_LVALUE ? "fetch" : "store");
791 else /* gotta do the real thing */
792 HeKEY_hek(entry) = save_hek_flags(key, klen, hash, flags);
794 HeNEXT(entry) = *oentry;
797 if (val == &PL_sv_placeholder)
798 HvPLACEHOLDERS(hv)++;
799 if (masked_flags & HVhek_ENABLEHVKFLAGS)
803 const HE *counter = HeNEXT(entry);
805 xhv->xhv_keys++; /* HvTOTALKEYS(hv)++ */
806 if (!counter) { /* initial entry? */
807 xhv->xhv_fill++; /* HvFILL(hv)++ */
808 } else if (xhv->xhv_keys > (IV)xhv->xhv_max) {
810 } else if(!HvREHASH(hv)) {
813 while ((counter = HeNEXT(counter)))
816 if (n_links > HV_MAX_LENGTH_BEFORE_SPLIT) {
817 /* Use only the old HvKEYS(hv) > HvMAX(hv) condition to limit
818 bucket splits on a rehashed hash, as we're not going to
819 split it again, and if someone is lucky (evil) enough to
820 get all the keys in one list they could exhaust our memory
821 as we repeatedly double the number of buckets on every
822 entry. Linear search feels a less worse thing to do. */
829 return entry ? (void *) &HeVAL(entry) : NULL;
831 return (void *) entry;
835 S_hv_magic_check(HV *hv, bool *needs_copy, bool *needs_store)
837 const MAGIC *mg = SvMAGIC(hv);
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 if (SvRMAGICAL(hv)) {
866 MAGIC * const mg = mg_find((SV*)hv, PERL_MAGIC_tied);
868 return magic_scalarpack(hv, mg);
873 Perl_sv_setpvf(aTHX_ sv, "%ld/%ld",
874 (long)HvFILL(hv), (long)HvMAX(hv) + 1);
882 =for apidoc hv_delete
884 Deletes a key/value pair in the hash. The value SV is removed from the
885 hash and returned to the caller. The C<klen> is the length of the key.
886 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
893 =for apidoc hv_delete_ent
895 Deletes a key/value pair in the hash. The value SV is removed from the
896 hash and returned to the caller. The C<flags> value will normally be zero;
897 if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
898 precomputed hash value, or 0 to ask for it to be computed.
904 S_hv_delete_common(pTHX_ HV *hv, SV *keysv, const char *key, STRLEN klen,
905 int k_flags, I32 d_flags, U32 hash)
910 register HE **oentry;
911 HE *const *first_entry;
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((SV*)hv, PERL_MAGIC_env)) {
941 /* XXX This code isn't UTF8 clean. */
942 keysv = sv_2mortal(newSVpvn(key,klen));
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((SV*)hv);
979 PERL_HASH_INTERNAL(hash, key, klen);
981 if (keysv && (SvIsCOW_shared_hash(keysv))) {
982 hash = SvSHARED_HASH(keysv);
984 PERL_HASH(hash, key, klen);
988 masked_flags = (k_flags & HVhek_MASK);
990 first_entry = oentry = &(HvARRAY(hv))[hash & (I32) HvMAX(hv)];
992 for (; entry; oentry = &HeNEXT(entry), entry = *oentry) {
994 if (HeHASH(entry) != hash) /* strings can't be equal */
996 if (HeKLEN(entry) != (I32)klen)
998 if (HeKEY(entry) != key && memNE(HeKEY(entry),key,klen)) /* is this it? */
1000 if ((HeKFLAGS(entry) ^ masked_flags) & HVhek_UTF8)
1003 if (hv == PL_strtab) {
1004 if (k_flags & HVhek_FREEKEY)
1006 Perl_croak(aTHX_ S_strtab_error, "delete");
1009 /* if placeholder is here, it's already been deleted.... */
1010 if (HeVAL(entry) == &PL_sv_placeholder) {
1011 if (k_flags & HVhek_FREEKEY)
1015 if (SvREADONLY(hv) && HeVAL(entry) && SvREADONLY(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 (d_flags & G_DISCARD)
1026 sv = sv_2mortal(HeVAL(entry));
1027 HeVAL(entry) = &PL_sv_placeholder;
1031 * If a restricted hash, rather than really deleting the entry, put
1032 * a placeholder there. This marks the key as being "approved", so
1033 * we can still access via not-really-existing key without raising
1036 if (SvREADONLY(hv)) {
1037 SvREFCNT_dec(HeVAL(entry));
1038 HeVAL(entry) = &PL_sv_placeholder;
1039 /* We'll be saving this slot, so the number of allocated keys
1040 * doesn't go down, but the number placeholders goes up */
1041 HvPLACEHOLDERS(hv)++;
1043 *oentry = HeNEXT(entry);
1045 xhv->xhv_fill--; /* HvFILL(hv)-- */
1047 if (SvOOK(hv) && entry == HvAUX(hv)->xhv_eiter /* HvEITER(hv) */)
1050 hv_free_ent(hv, entry);
1051 xhv->xhv_keys--; /* HvTOTALKEYS(hv)-- */
1052 if (xhv->xhv_keys == 0)
1053 HvHASKFLAGS_off(hv);
1057 if (SvREADONLY(hv)) {
1058 hv_notallowed(k_flags, key, klen,
1059 "Attempt to delete disallowed key '%"SVf"' from"
1060 " a restricted hash");
1063 if (k_flags & HVhek_FREEKEY)
1069 S_hsplit(pTHX_ HV *hv)
1072 register XPVHV* const xhv = (XPVHV*)SvANY(hv);
1073 const I32 oldsize = (I32) xhv->xhv_max+1; /* HvMAX(hv)+1 (sick) */
1074 register I32 newsize = oldsize * 2;
1076 char *a = (char*) HvARRAY(hv);
1078 register HE **oentry;
1079 int longest_chain = 0;
1082 /*PerlIO_printf(PerlIO_stderr(), "hsplit called for %p which had %d\n",
1083 (void*)hv, (int) oldsize);*/
1085 if (HvPLACEHOLDERS_get(hv) && !SvREADONLY(hv)) {
1086 /* Can make this clear any placeholders first for non-restricted hashes,
1087 even though Storable rebuilds restricted hashes by putting in all the
1088 placeholders (first) before turning on the readonly flag, because
1089 Storable always pre-splits the hash. */
1090 hv_clear_placeholders(hv);
1094 #if defined(STRANGE_MALLOC) || defined(MYMALLOC)
1095 Renew(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1096 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
1102 Copy(&a[oldsize * sizeof(HE*)], &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
1105 Newx(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1106 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
1111 Copy(HvARRAY(hv), a, oldsize * sizeof(HE*), char);
1113 Copy(HvAUX(hv), &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
1115 if (oldsize >= 64) {
1116 offer_nice_chunk(HvARRAY(hv),
1117 PERL_HV_ARRAY_ALLOC_BYTES(oldsize)
1118 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0));
1121 Safefree(HvARRAY(hv));
1125 Zero(&a[oldsize * sizeof(HE*)], (newsize-oldsize) * sizeof(HE*), char); /* zero 2nd half*/
1126 xhv->xhv_max = --newsize; /* HvMAX(hv) = --newsize */
1127 HvARRAY(hv) = (HE**) a;
1130 for (i=0; i<oldsize; i++,aep++) {
1131 int left_length = 0;
1132 int right_length = 0;
1136 if (!*aep) /* non-existent */
1139 for (oentry = aep, entry = *aep; entry; entry = *oentry) {
1140 if ((HeHASH(entry) & newsize) != (U32)i) {
1141 *oentry = HeNEXT(entry);
1142 HeNEXT(entry) = *bep;
1144 xhv->xhv_fill++; /* HvFILL(hv)++ */
1150 oentry = &HeNEXT(entry);
1154 if (!*aep) /* everything moved */
1155 xhv->xhv_fill--; /* HvFILL(hv)-- */
1156 /* I think we don't actually need to keep track of the longest length,
1157 merely flag if anything is too long. But for the moment while
1158 developing this code I'll track it. */
1159 if (left_length > longest_chain)
1160 longest_chain = left_length;
1161 if (right_length > longest_chain)
1162 longest_chain = right_length;
1166 /* Pick your policy for "hashing isn't working" here: */
1167 if (longest_chain <= HV_MAX_LENGTH_BEFORE_SPLIT /* split worked? */
1172 if (hv == PL_strtab) {
1173 /* Urg. Someone is doing something nasty to the string table.
1178 /* Awooga. Awooga. Pathological data. */
1179 /*PerlIO_printf(PerlIO_stderr(), "%p %d of %d with %d/%d buckets\n", (void*)hv,
1180 longest_chain, HvTOTALKEYS(hv), HvFILL(hv), 1+HvMAX(hv));*/
1183 Newxz(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1184 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
1186 Copy(HvAUX(hv), &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
1189 was_shared = HvSHAREKEYS(hv);
1192 HvSHAREKEYS_off(hv);
1197 for (i=0; i<newsize; i++,aep++) {
1198 register HE *entry = *aep;
1200 /* We're going to trash this HE's next pointer when we chain it
1201 into the new hash below, so store where we go next. */
1202 HE * const next = HeNEXT(entry);
1207 PERL_HASH_INTERNAL(hash, HeKEY(entry), HeKLEN(entry));
1212 = save_hek_flags(HeKEY(entry), HeKLEN(entry),
1213 hash, HeKFLAGS(entry));
1214 unshare_hek (HeKEY_hek(entry));
1215 HeKEY_hek(entry) = new_hek;
1217 /* Not shared, so simply write the new hash in. */
1218 HeHASH(entry) = hash;
1220 /*PerlIO_printf(PerlIO_stderr(), "%d ", HeKFLAGS(entry));*/
1221 HEK_REHASH_on(HeKEY_hek(entry));
1222 /*PerlIO_printf(PerlIO_stderr(), "%d\n", HeKFLAGS(entry));*/
1224 /* Copy oentry to the correct new chain. */
1225 bep = ((HE**)a) + (hash & (I32) xhv->xhv_max);
1227 xhv->xhv_fill++; /* HvFILL(hv)++ */
1228 HeNEXT(entry) = *bep;
1234 Safefree (HvARRAY(hv));
1235 HvARRAY(hv) = (HE **)a;
1239 Perl_hv_ksplit(pTHX_ HV *hv, IV newmax)
1242 register XPVHV* xhv = (XPVHV*)SvANY(hv);
1243 const I32 oldsize = (I32) xhv->xhv_max+1; /* HvMAX(hv)+1 (sick) */
1244 register I32 newsize;
1249 register HE **oentry;
1251 newsize = (I32) newmax; /* possible truncation here */
1252 if (newsize != newmax || newmax <= oldsize)
1254 while ((newsize & (1 + ~newsize)) != newsize) {
1255 newsize &= ~(newsize & (1 + ~newsize)); /* get proper power of 2 */
1257 if (newsize < newmax)
1259 if (newsize < newmax)
1260 return; /* overflow detection */
1262 a = (char *) HvARRAY(hv);
1265 #if defined(STRANGE_MALLOC) || defined(MYMALLOC)
1266 Renew(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1267 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
1273 Copy(&a[oldsize * sizeof(HE*)], &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
1276 Newx(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1277 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
1282 Copy(HvARRAY(hv), a, oldsize * sizeof(HE*), char);
1284 Copy(HvAUX(hv), &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
1286 if (oldsize >= 64) {
1287 offer_nice_chunk(HvARRAY(hv),
1288 PERL_HV_ARRAY_ALLOC_BYTES(oldsize)
1289 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0));
1292 Safefree(HvARRAY(hv));
1295 Zero(&a[oldsize * sizeof(HE*)], (newsize-oldsize) * sizeof(HE*), char); /* zero 2nd half*/
1298 Newxz(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize), char);
1300 xhv->xhv_max = --newsize; /* HvMAX(hv) = --newsize */
1301 HvARRAY(hv) = (HE **) a;
1302 if (!xhv->xhv_fill /* !HvFILL(hv) */) /* skip rest if no entries */
1306 for (i=0; i<oldsize; i++,aep++) {
1307 if (!*aep) /* non-existent */
1309 for (oentry = aep, entry = *aep; entry; entry = *oentry) {
1310 register I32 j = (HeHASH(entry) & newsize);
1314 *oentry = HeNEXT(entry);
1315 if (!(HeNEXT(entry) = aep[j]))
1316 xhv->xhv_fill++; /* HvFILL(hv)++ */
1321 oentry = &HeNEXT(entry);
1323 if (!*aep) /* everything moved */
1324 xhv->xhv_fill--; /* HvFILL(hv)-- */
1331 Creates a new HV. The reference count is set to 1.
1339 register XPVHV* xhv;
1340 HV * const hv = (HV*)newSV_type(SVt_PVHV);
1341 xhv = (XPVHV*)SvANY(hv);
1343 #ifndef NODEFAULT_SHAREKEYS
1344 HvSHAREKEYS_on(hv); /* key-sharing on by default */
1347 xhv->xhv_max = 7; /* HvMAX(hv) = 7 (start with 8 buckets) */
1348 xhv->xhv_fill = 0; /* HvFILL(hv) = 0 */
1353 Perl_newHVhv(pTHX_ HV *ohv)
1355 HV * const hv = newHV();
1356 STRLEN hv_max, hv_fill;
1358 if (!ohv || (hv_fill = HvFILL(ohv)) == 0)
1360 hv_max = HvMAX(ohv);
1362 if (!SvMAGICAL((SV *)ohv)) {
1363 /* It's an ordinary hash, so copy it fast. AMS 20010804 */
1365 const bool shared = !!HvSHAREKEYS(ohv);
1366 HE **ents, ** const oents = (HE **)HvARRAY(ohv);
1368 Newx(a, PERL_HV_ARRAY_ALLOC_BYTES(hv_max+1), char);
1371 /* In each bucket... */
1372 for (i = 0; i <= hv_max; i++) {
1374 HE *oent = oents[i];
1381 /* Copy the linked list of entries. */
1382 for (; oent; oent = HeNEXT(oent)) {
1383 const U32 hash = HeHASH(oent);
1384 const char * const key = HeKEY(oent);
1385 const STRLEN len = HeKLEN(oent);
1386 const int flags = HeKFLAGS(oent);
1387 HE * const ent = new_HE();
1389 HeVAL(ent) = newSVsv(HeVAL(oent));
1391 = shared ? share_hek_flags(key, len, hash, flags)
1392 : save_hek_flags(key, len, hash, flags);
1403 HvFILL(hv) = hv_fill;
1404 HvTOTALKEYS(hv) = HvTOTALKEYS(ohv);
1408 /* Iterate over ohv, copying keys and values one at a time. */
1410 const I32 riter = HvRITER_get(ohv);
1411 HE * const eiter = HvEITER_get(ohv);
1413 /* Can we use fewer buckets? (hv_max is always 2^n-1) */
1414 while (hv_max && hv_max + 1 >= hv_fill * 2)
1415 hv_max = hv_max / 2;
1419 while ((entry = hv_iternext_flags(ohv, 0))) {
1420 hv_store_flags(hv, HeKEY(entry), HeKLEN(entry),
1421 newSVsv(HeVAL(entry)), HeHASH(entry),
1424 HvRITER_set(ohv, riter);
1425 HvEITER_set(ohv, eiter);
1431 /* A rather specialised version of newHVhv for copying %^H, ensuring all the
1432 magic stays on it. */
1434 Perl_hv_copy_hints_hv(pTHX_ HV *const ohv)
1436 HV * const hv = newHV();
1439 if (ohv && (hv_fill = HvFILL(ohv))) {
1440 STRLEN hv_max = HvMAX(ohv);
1442 const I32 riter = HvRITER_get(ohv);
1443 HE * const eiter = HvEITER_get(ohv);
1445 while (hv_max && hv_max + 1 >= hv_fill * 2)
1446 hv_max = hv_max / 2;
1450 while ((entry = hv_iternext_flags(ohv, 0))) {
1451 SV *const sv = newSVsv(HeVAL(entry));
1452 sv_magic(sv, NULL, PERL_MAGIC_hintselem,
1453 (char *)newSVhek (HeKEY_hek(entry)), HEf_SVKEY);
1454 hv_store_flags(hv, HeKEY(entry), HeKLEN(entry),
1455 sv, HeHASH(entry), HeKFLAGS(entry));
1457 HvRITER_set(ohv, riter);
1458 HvEITER_set(ohv, eiter);
1460 hv_magic(hv, NULL, PERL_MAGIC_hints);
1465 Perl_hv_free_ent(pTHX_ HV *hv, register HE *entry)
1473 if (val && isGV(val) && GvCVu(val) && HvNAME_get(hv))
1474 mro_method_changed_in(hv); /* deletion of method from stash */
1476 if (HeKLEN(entry) == HEf_SVKEY) {
1477 SvREFCNT_dec(HeKEY_sv(entry));
1478 Safefree(HeKEY_hek(entry));
1480 else if (HvSHAREKEYS(hv))
1481 unshare_hek(HeKEY_hek(entry));
1483 Safefree(HeKEY_hek(entry));
1488 Perl_hv_delayfree_ent(pTHX_ HV *hv, register HE *entry)
1493 /* SvREFCNT_inc to counter the SvREFCNT_dec in hv_free_ent */
1494 sv_2mortal(SvREFCNT_inc(HeVAL(entry))); /* free between statements */
1495 if (HeKLEN(entry) == HEf_SVKEY) {
1496 sv_2mortal(SvREFCNT_inc(HeKEY_sv(entry)));
1498 hv_free_ent(hv, entry);
1502 =for apidoc hv_clear
1504 Clears a hash, making it empty.
1510 Perl_hv_clear(pTHX_ HV *hv)
1513 register XPVHV* xhv;
1517 DEBUG_A(Perl_hv_assert(aTHX_ hv));
1519 xhv = (XPVHV*)SvANY(hv);
1521 if (SvREADONLY(hv) && HvARRAY(hv) != NULL) {
1522 /* restricted hash: convert all keys to placeholders */
1524 for (i = 0; i <= xhv->xhv_max; i++) {
1525 HE *entry = (HvARRAY(hv))[i];
1526 for (; entry; entry = HeNEXT(entry)) {
1527 /* not already placeholder */
1528 if (HeVAL(entry) != &PL_sv_placeholder) {
1529 if (HeVAL(entry) && SvREADONLY(HeVAL(entry))) {
1530 SV* const keysv = hv_iterkeysv(entry);
1532 "Attempt to delete readonly key '%"SVf"' from a restricted hash",
1535 SvREFCNT_dec(HeVAL(entry));
1536 HeVAL(entry) = &PL_sv_placeholder;
1537 HvPLACEHOLDERS(hv)++;
1545 HvPLACEHOLDERS_set(hv, 0);
1547 Zero(HvARRAY(hv), xhv->xhv_max+1 /* HvMAX(hv)+1 */, HE*);
1552 HvHASKFLAGS_off(hv);
1557 mro_isa_changed_in(hv);
1558 HvEITER_set(hv, NULL);
1563 =for apidoc hv_clear_placeholders
1565 Clears any placeholders from a hash. If a restricted hash has any of its keys
1566 marked as readonly and the key is subsequently deleted, the key is not actually
1567 deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
1568 it so it will be ignored by future operations such as iterating over the hash,
1569 but will still allow the hash to have a value reassigned to the key at some
1570 future point. This function clears any such placeholder keys from the hash.
1571 See Hash::Util::lock_keys() for an example of its use.
1577 Perl_hv_clear_placeholders(pTHX_ HV *hv)
1580 const U32 items = (U32)HvPLACEHOLDERS_get(hv);
1583 clear_placeholders(hv, items);
1587 S_clear_placeholders(pTHX_ HV *hv, U32 items)
1597 /* Loop down the linked list heads */
1599 HE **oentry = &(HvARRAY(hv))[i];
1602 while ((entry = *oentry)) {
1603 if (HeVAL(entry) == &PL_sv_placeholder) {
1604 *oentry = HeNEXT(entry);
1605 if (first && !*oentry)
1606 HvFILL(hv)--; /* This linked list is now empty. */
1607 if (entry == HvEITER_get(hv))
1610 hv_free_ent(hv, entry);
1614 HvTOTALKEYS(hv) -= (IV)HvPLACEHOLDERS_get(hv);
1615 if (HvKEYS(hv) == 0)
1616 HvHASKFLAGS_off(hv);
1617 HvPLACEHOLDERS_set(hv, 0);
1621 oentry = &HeNEXT(entry);
1626 /* You can't get here, hence assertion should always fail. */
1627 assert (items == 0);
1632 S_hfreeentries(pTHX_ HV *hv)
1634 /* This is the array that we're going to restore */
1635 HE **const orig_array = HvARRAY(hv);
1643 /* If the hash is actually a symbol table with a name, look after the
1645 struct xpvhv_aux *iter = HvAUX(hv);
1647 name = iter->xhv_name;
1648 iter->xhv_name = NULL;
1653 /* orig_array remains unchanged throughout the loop. If after freeing all
1654 the entries it turns out that one of the little blighters has triggered
1655 an action that has caused HvARRAY to be re-allocated, then we set
1656 array to the new HvARRAY, and try again. */
1659 /* This is the one we're going to try to empty. First time round
1660 it's the original array. (Hopefully there will only be 1 time
1662 HE ** const array = HvARRAY(hv);
1665 /* Because we have taken xhv_name out, the only allocated pointer
1666 in the aux structure that might exist is the backreference array.
1671 struct mro_meta *meta;
1672 struct xpvhv_aux *iter = HvAUX(hv);
1673 /* If there are weak references to this HV, we need to avoid
1674 freeing them up here. In particular we need to keep the AV
1675 visible as what we're deleting might well have weak references
1676 back to this HV, so the for loop below may well trigger
1677 the removal of backreferences from this array. */
1679 if (iter->xhv_backreferences) {
1680 /* So donate them to regular backref magic to keep them safe.
1681 The sv_magic will increase the reference count of the AV,
1682 so we need to drop it first. */
1683 SvREFCNT_dec(iter->xhv_backreferences);
1684 if (AvFILLp(iter->xhv_backreferences) == -1) {
1685 /* Turns out that the array is empty. Just free it. */
1686 SvREFCNT_dec(iter->xhv_backreferences);
1689 sv_magic((SV*)hv, (SV*)iter->xhv_backreferences,
1690 PERL_MAGIC_backref, NULL, 0);
1692 iter->xhv_backreferences = NULL;
1695 entry = iter->xhv_eiter; /* HvEITER(hv) */
1696 if (entry && HvLAZYDEL(hv)) { /* was deleted earlier? */
1698 hv_free_ent(hv, entry);
1700 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
1701 iter->xhv_eiter = NULL; /* HvEITER(hv) = NULL */
1703 if((meta = iter->xhv_mro_meta)) {
1704 if(meta->mro_linear_dfs) SvREFCNT_dec(meta->mro_linear_dfs);
1705 if(meta->mro_linear_c3) SvREFCNT_dec(meta->mro_linear_c3);
1706 if(meta->mro_nextmethod) SvREFCNT_dec(meta->mro_nextmethod);
1708 iter->xhv_mro_meta = NULL;
1711 /* There are now no allocated pointers in the aux structure. */
1713 SvFLAGS(hv) &= ~SVf_OOK; /* Goodbye, aux structure. */
1714 /* What aux structure? */
1717 /* make everyone else think the array is empty, so that the destructors
1718 * called for freed entries can't recusively mess with us */
1721 ((XPVHV*) SvANY(hv))->xhv_keys = 0;
1725 /* Loop down the linked list heads */
1726 HE *entry = array[i];
1729 register HE * const oentry = entry;
1730 entry = HeNEXT(entry);
1731 hv_free_ent(hv, oentry);
1735 /* As there are no allocated pointers in the aux structure, it's now
1736 safe to free the array we just cleaned up, if it's not the one we're
1737 going to put back. */
1738 if (array != orig_array) {
1743 /* Good. No-one added anything this time round. */
1748 /* Someone attempted to iterate or set the hash name while we had
1749 the array set to 0. We'll catch backferences on the next time
1750 round the while loop. */
1751 assert(HvARRAY(hv));
1753 if (HvAUX(hv)->xhv_name) {
1754 unshare_hek_or_pvn(HvAUX(hv)->xhv_name, 0, 0, 0);
1758 if (--attempts == 0) {
1759 Perl_die(aTHX_ "panic: hfreeentries failed to free hash - something is repeatedly re-creating entries");
1763 HvARRAY(hv) = orig_array;
1765 /* If the hash was actually a symbol table, put the name back. */
1767 /* We have restored the original array. If name is non-NULL, then
1768 the original array had an aux structure at the end. So this is
1770 SvFLAGS(hv) |= SVf_OOK;
1771 HvAUX(hv)->xhv_name = name;
1776 =for apidoc hv_undef
1784 Perl_hv_undef(pTHX_ HV *hv)
1787 register XPVHV* xhv;
1792 DEBUG_A(Perl_hv_assert(aTHX_ hv));
1793 xhv = (XPVHV*)SvANY(hv);
1795 if ((name = HvNAME_get(hv)) && !PL_dirty)
1796 mro_isa_changed_in(hv);
1801 hv_delete(PL_stashcache, name, HvNAMELEN_get(hv), G_DISCARD);
1802 hv_name_set(hv, NULL, 0, 0);
1804 SvFLAGS(hv) &= ~SVf_OOK;
1805 Safefree(HvARRAY(hv));
1806 xhv->xhv_max = 7; /* HvMAX(hv) = 7 (it's a normal hash) */
1808 HvPLACEHOLDERS_set(hv, 0);
1814 static struct xpvhv_aux*
1815 S_hv_auxinit(HV *hv) {
1816 struct xpvhv_aux *iter;
1820 Newxz(array, PERL_HV_ARRAY_ALLOC_BYTES(HvMAX(hv) + 1)
1821 + sizeof(struct xpvhv_aux), char);
1823 array = (char *) HvARRAY(hv);
1824 Renew(array, PERL_HV_ARRAY_ALLOC_BYTES(HvMAX(hv) + 1)
1825 + sizeof(struct xpvhv_aux), char);
1827 HvARRAY(hv) = (HE**) array;
1828 /* SvOOK_on(hv) attacks the IV flags. */
1829 SvFLAGS(hv) |= SVf_OOK;
1832 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
1833 iter->xhv_eiter = NULL; /* HvEITER(hv) = NULL */
1835 iter->xhv_backreferences = 0;
1836 iter->xhv_mro_meta = NULL;
1841 =for apidoc hv_iterinit
1843 Prepares a starting point to traverse a hash table. Returns the number of
1844 keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1845 currently only meaningful for hashes without tie magic.
1847 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1848 hash buckets that happen to be in use. If you still need that esoteric
1849 value, you can get it through the macro C<HvFILL(tb)>.
1856 Perl_hv_iterinit(pTHX_ HV *hv)
1859 Perl_croak(aTHX_ "Bad hash");
1862 struct xpvhv_aux * const iter = HvAUX(hv);
1863 HE * const entry = iter->xhv_eiter; /* HvEITER(hv) */
1864 if (entry && HvLAZYDEL(hv)) { /* was deleted earlier? */
1866 hv_free_ent(hv, entry);
1868 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
1869 iter->xhv_eiter = NULL; /* HvEITER(hv) = NULL */
1874 /* used to be xhv->xhv_fill before 5.004_65 */
1875 return HvTOTALKEYS(hv);
1879 Perl_hv_riter_p(pTHX_ HV *hv) {
1880 struct xpvhv_aux *iter;
1883 Perl_croak(aTHX_ "Bad hash");
1885 iter = SvOOK(hv) ? HvAUX(hv) : hv_auxinit(hv);
1886 return &(iter->xhv_riter);
1890 Perl_hv_eiter_p(pTHX_ HV *hv) {
1891 struct xpvhv_aux *iter;
1894 Perl_croak(aTHX_ "Bad hash");
1896 iter = SvOOK(hv) ? HvAUX(hv) : hv_auxinit(hv);
1897 return &(iter->xhv_eiter);
1901 Perl_hv_riter_set(pTHX_ HV *hv, I32 riter) {
1902 struct xpvhv_aux *iter;
1905 Perl_croak(aTHX_ "Bad hash");
1913 iter = hv_auxinit(hv);
1915 iter->xhv_riter = riter;
1919 Perl_hv_eiter_set(pTHX_ HV *hv, HE *eiter) {
1920 struct xpvhv_aux *iter;
1923 Perl_croak(aTHX_ "Bad hash");
1928 /* 0 is the default so don't go malloc()ing a new structure just to
1933 iter = hv_auxinit(hv);
1935 iter->xhv_eiter = eiter;
1939 Perl_hv_name_set(pTHX_ HV *hv, const char *name, U32 len, U32 flags)
1942 struct xpvhv_aux *iter;
1945 PERL_UNUSED_ARG(flags);
1948 Perl_croak(aTHX_ "panic: hv name too long (%"UVuf")", (UV) len);
1952 if (iter->xhv_name) {
1953 unshare_hek_or_pvn(iter->xhv_name, 0, 0, 0);
1959 iter = hv_auxinit(hv);
1961 PERL_HASH(hash, name, len);
1962 iter->xhv_name = name ? share_hek(name, len, hash) : NULL;
1966 Perl_hv_backreferences_p(pTHX_ HV *hv) {
1967 struct xpvhv_aux * const iter = SvOOK(hv) ? HvAUX(hv) : hv_auxinit(hv);
1968 PERL_UNUSED_CONTEXT;
1969 return &(iter->xhv_backreferences);
1973 Perl_hv_kill_backrefs(pTHX_ HV *hv) {
1979 av = HvAUX(hv)->xhv_backreferences;
1982 HvAUX(hv)->xhv_backreferences = 0;
1983 Perl_sv_kill_backrefs(aTHX_ (SV*) hv, av);
1988 hv_iternext is implemented as a macro in hv.h
1990 =for apidoc hv_iternext
1992 Returns entries from a hash iterator. See C<hv_iterinit>.
1994 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
1995 iterator currently points to, without losing your place or invalidating your
1996 iterator. Note that in this case the current entry is deleted from the hash
1997 with your iterator holding the last reference to it. Your iterator is flagged
1998 to free the entry on the next call to C<hv_iternext>, so you must not discard
1999 your iterator immediately else the entry will leak - call C<hv_iternext> to
2000 trigger the resource deallocation.
2002 =for apidoc hv_iternext_flags
2004 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
2005 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
2006 set the placeholders keys (for restricted hashes) will be returned in addition
2007 to normal keys. By default placeholders are automatically skipped over.
2008 Currently a placeholder is implemented with a value that is
2009 C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
2010 restricted hashes may change, and the implementation currently is
2011 insufficiently abstracted for any change to be tidy.
2017 Perl_hv_iternext_flags(pTHX_ HV *hv, I32 flags)
2020 register XPVHV* xhv;
2024 struct xpvhv_aux *iter;
2027 Perl_croak(aTHX_ "Bad hash");
2029 xhv = (XPVHV*)SvANY(hv);
2032 /* Too many things (well, pp_each at least) merrily assume that you can
2033 call iv_iternext without calling hv_iterinit, so we'll have to deal
2039 oldentry = entry = iter->xhv_eiter; /* HvEITER(hv) */
2040 if (SvMAGICAL(hv) && SvRMAGICAL(hv)) {
2041 if ( ( mg = mg_find((SV*)hv, PERL_MAGIC_tied) ) ) {
2042 SV * const key = sv_newmortal();
2044 sv_setsv(key, HeSVKEY_force(entry));
2045 SvREFCNT_dec(HeSVKEY(entry)); /* get rid of previous key */
2051 /* one HE per MAGICAL hash */
2052 iter->xhv_eiter = entry = new_HE(); /* HvEITER(hv) = new_HE() */
2054 Newxz(k, HEK_BASESIZE + sizeof(SV*), char);
2056 HeKEY_hek(entry) = hek;
2057 HeKLEN(entry) = HEf_SVKEY;
2059 magic_nextpack((SV*) hv,mg,key);
2061 /* force key to stay around until next time */
2062 HeSVKEY_set(entry, SvREFCNT_inc_simple_NN(key));
2063 return entry; /* beware, hent_val is not set */
2066 SvREFCNT_dec(HeVAL(entry));
2067 Safefree(HeKEY_hek(entry));
2069 iter->xhv_eiter = NULL; /* HvEITER(hv) = NULL */
2073 #if defined(DYNAMIC_ENV_FETCH) && !defined(__riscos__) /* set up %ENV for iteration */
2074 if (!entry && SvRMAGICAL((SV*)hv) && mg_find((SV*)hv, PERL_MAGIC_env)) {
2077 /* The prime_env_iter() on VMS just loaded up new hash values
2078 * so the iteration count needs to be reset back to the beginning
2082 oldentry = entry = iter->xhv_eiter; /* HvEITER(hv) */
2087 /* hv_iterint now ensures this. */
2088 assert (HvARRAY(hv));
2090 /* At start of hash, entry is NULL. */
2093 entry = HeNEXT(entry);
2094 if (!(flags & HV_ITERNEXT_WANTPLACEHOLDERS)) {
2096 * Skip past any placeholders -- don't want to include them in
2099 while (entry && HeVAL(entry) == &PL_sv_placeholder) {
2100 entry = HeNEXT(entry);
2105 /* OK. Come to the end of the current list. Grab the next one. */
2107 iter->xhv_riter++; /* HvRITER(hv)++ */
2108 if (iter->xhv_riter > (I32)xhv->xhv_max /* HvRITER(hv) > HvMAX(hv) */) {
2109 /* There is no next one. End of the hash. */
2110 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
2113 entry = (HvARRAY(hv))[iter->xhv_riter];
2115 if (!(flags & HV_ITERNEXT_WANTPLACEHOLDERS)) {
2116 /* If we have an entry, but it's a placeholder, don't count it.
2118 while (entry && HeVAL(entry) == &PL_sv_placeholder)
2119 entry = HeNEXT(entry);
2121 /* Will loop again if this linked list starts NULL
2122 (for HV_ITERNEXT_WANTPLACEHOLDERS)
2123 or if we run through it and find only placeholders. */
2126 if (oldentry && HvLAZYDEL(hv)) { /* was deleted earlier? */
2128 hv_free_ent(hv, oldentry);
2131 /*if (HvREHASH(hv) && entry && !HeKREHASH(entry))
2132 PerlIO_printf(PerlIO_stderr(), "Awooga %p %p\n", (void*)hv, (void*)entry);*/
2134 iter->xhv_eiter = entry; /* HvEITER(hv) = entry */
2139 =for apidoc hv_iterkey
2141 Returns the key from the current position of the hash iterator. See
2148 Perl_hv_iterkey(pTHX_ register HE *entry, I32 *retlen)
2150 if (HeKLEN(entry) == HEf_SVKEY) {
2152 char * const p = SvPV(HeKEY_sv(entry), len);
2157 *retlen = HeKLEN(entry);
2158 return HeKEY(entry);
2162 /* unlike hv_iterval(), this always returns a mortal copy of the key */
2164 =for apidoc hv_iterkeysv
2166 Returns the key as an C<SV*> from the current position of the hash
2167 iterator. The return value will always be a mortal copy of the key. Also
2174 Perl_hv_iterkeysv(pTHX_ register HE *entry)
2176 return sv_2mortal(newSVhek(HeKEY_hek(entry)));
2180 =for apidoc hv_iterval
2182 Returns the value from the current position of the hash iterator. See
2189 Perl_hv_iterval(pTHX_ HV *hv, register HE *entry)
2191 if (SvRMAGICAL(hv)) {
2192 if (mg_find((SV*)hv, PERL_MAGIC_tied)) {
2193 SV* const sv = sv_newmortal();
2194 if (HeKLEN(entry) == HEf_SVKEY)
2195 mg_copy((SV*)hv, sv, (char*)HeKEY_sv(entry), HEf_SVKEY);
2197 mg_copy((SV*)hv, sv, HeKEY(entry), HeKLEN(entry));
2201 return HeVAL(entry);
2205 =for apidoc hv_iternextsv
2207 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
2214 Perl_hv_iternextsv(pTHX_ HV *hv, char **key, I32 *retlen)
2216 HE * const he = hv_iternext_flags(hv, 0);
2220 *key = hv_iterkey(he, retlen);
2221 return hv_iterval(hv, he);
2228 =for apidoc hv_magic
2230 Adds magic to a hash. See C<sv_magic>.
2235 /* possibly free a shared string if no one has access to it
2236 * len and hash must both be valid for str.
2239 Perl_unsharepvn(pTHX_ const char *str, I32 len, U32 hash)
2241 unshare_hek_or_pvn (NULL, str, len, hash);
2246 Perl_unshare_hek(pTHX_ HEK *hek)
2249 unshare_hek_or_pvn(hek, NULL, 0, 0);
2252 /* possibly free a shared string if no one has access to it
2253 hek if non-NULL takes priority over the other 3, else str, len and hash
2254 are used. If so, len and hash must both be valid for str.
2257 S_unshare_hek_or_pvn(pTHX_ const HEK *hek, const char *str, I32 len, U32 hash)
2260 register XPVHV* xhv;
2262 register HE **oentry;
2264 bool is_utf8 = FALSE;
2266 const char * const save = str;
2267 struct shared_he *he = NULL;
2270 /* Find the shared he which is just before us in memory. */
2271 he = (struct shared_he *)(((char *)hek)
2272 - STRUCT_OFFSET(struct shared_he,
2275 /* Assert that the caller passed us a genuine (or at least consistent)
2277 assert (he->shared_he_he.hent_hek == hek);
2280 if (he->shared_he_he.he_valu.hent_refcount - 1) {
2281 --he->shared_he_he.he_valu.hent_refcount;
2282 UNLOCK_STRTAB_MUTEX;
2285 UNLOCK_STRTAB_MUTEX;
2287 hash = HEK_HASH(hek);
2288 } else if (len < 0) {
2289 STRLEN tmplen = -len;
2291 /* See the note in hv_fetch(). --jhi */
2292 str = (char*)bytes_from_utf8((U8*)str, &tmplen, &is_utf8);
2295 k_flags = HVhek_UTF8;
2297 k_flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
2300 /* what follows was the moral equivalent of:
2301 if ((Svp = hv_fetch(PL_strtab, tmpsv, FALSE, hash))) {
2303 hv_delete(PL_strtab, str, len, G_DISCARD, hash);
2305 xhv = (XPVHV*)SvANY(PL_strtab);
2306 /* assert(xhv_array != 0) */
2308 first = oentry = &(HvARRAY(PL_strtab))[hash & (I32) HvMAX(PL_strtab)];
2310 const HE *const he_he = &(he->shared_he_he);
2311 for (entry = *oentry; entry; oentry = &HeNEXT(entry), entry = *oentry) {
2316 const int flags_masked = k_flags & HVhek_MASK;
2317 for (entry = *oentry; entry; oentry = &HeNEXT(entry), entry = *oentry) {
2318 if (HeHASH(entry) != hash) /* strings can't be equal */
2320 if (HeKLEN(entry) != len)
2322 if (HeKEY(entry) != str && memNE(HeKEY(entry),str,len)) /* is this it? */
2324 if (HeKFLAGS(entry) != flags_masked)
2331 if (--entry->he_valu.hent_refcount == 0) {
2332 *oentry = HeNEXT(entry);
2334 /* There are now no entries in our slot. */
2335 xhv->xhv_fill--; /* HvFILL(hv)-- */
2338 xhv->xhv_keys--; /* HvTOTALKEYS(hv)-- */
2342 UNLOCK_STRTAB_MUTEX;
2343 if (!entry && ckWARN_d(WARN_INTERNAL))
2344 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
2345 "Attempt to free non-existent shared string '%s'%s"
2347 hek ? HEK_KEY(hek) : str,
2348 ((k_flags & HVhek_UTF8) ? " (utf8)" : "") pTHX__VALUE);
2349 if (k_flags & HVhek_FREEKEY)
2353 /* get a (constant) string ptr from the global string table
2354 * string will get added if it is not already there.
2355 * len and hash must both be valid for str.
2358 Perl_share_hek(pTHX_ const char *str, I32 len, register U32 hash)
2360 bool is_utf8 = FALSE;
2362 const char * const save = str;
2365 STRLEN tmplen = -len;
2367 /* See the note in hv_fetch(). --jhi */
2368 str = (char*)bytes_from_utf8((U8*)str, &tmplen, &is_utf8);
2370 /* If we were able to downgrade here, then than means that we were passed
2371 in a key which only had chars 0-255, but was utf8 encoded. */
2374 /* If we found we were able to downgrade the string to bytes, then
2375 we should flag that it needs upgrading on keys or each. Also flag
2376 that we need share_hek_flags to free the string. */
2378 flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
2381 return share_hek_flags (str, len, hash, flags);
2385 S_share_hek_flags(pTHX_ const char *str, I32 len, register U32 hash, int flags)
2389 const int flags_masked = flags & HVhek_MASK;
2390 const U32 hindex = hash & (I32) HvMAX(PL_strtab);
2392 /* what follows is the moral equivalent of:
2394 if (!(Svp = hv_fetch(PL_strtab, str, len, FALSE)))
2395 hv_store(PL_strtab, str, len, NULL, hash);
2397 Can't rehash the shared string table, so not sure if it's worth
2398 counting the number of entries in the linked list
2400 register XPVHV * const xhv = (XPVHV*)SvANY(PL_strtab);
2401 /* assert(xhv_array != 0) */
2403 entry = (HvARRAY(PL_strtab))[hindex];
2404 for (;entry; entry = HeNEXT(entry)) {
2405 if (HeHASH(entry) != hash) /* strings can't be equal */
2407 if (HeKLEN(entry) != len)
2409 if (HeKEY(entry) != str && memNE(HeKEY(entry),str,len)) /* is this it? */
2411 if (HeKFLAGS(entry) != flags_masked)
2417 /* What used to be head of the list.
2418 If this is NULL, then we're the first entry for this slot, which
2419 means we need to increate fill. */
2420 struct shared_he *new_entry;
2423 HE **const head = &HvARRAY(PL_strtab)[hindex];
2424 HE *const next = *head;
2426 /* We don't actually store a HE from the arena and a regular HEK.
2427 Instead we allocate one chunk of memory big enough for both,
2428 and put the HEK straight after the HE. This way we can find the
2429 HEK directly from the HE.
2432 Newx(k, STRUCT_OFFSET(struct shared_he,
2433 shared_he_hek.hek_key[0]) + len + 2, char);
2434 new_entry = (struct shared_he *)k;
2435 entry = &(new_entry->shared_he_he);
2436 hek = &(new_entry->shared_he_hek);
2438 Copy(str, HEK_KEY(hek), len, char);
2439 HEK_KEY(hek)[len] = 0;
2441 HEK_HASH(hek) = hash;
2442 HEK_FLAGS(hek) = (unsigned char)flags_masked;
2444 /* Still "point" to the HEK, so that other code need not know what
2446 HeKEY_hek(entry) = hek;
2447 entry->he_valu.hent_refcount = 0;
2448 HeNEXT(entry) = next;
2451 xhv->xhv_keys++; /* HvTOTALKEYS(hv)++ */
2452 if (!next) { /* initial entry? */
2453 xhv->xhv_fill++; /* HvFILL(hv)++ */
2454 } else if (xhv->xhv_keys > (IV)xhv->xhv_max /* HvKEYS(hv) > HvMAX(hv) */) {
2459 ++entry->he_valu.hent_refcount;
2460 UNLOCK_STRTAB_MUTEX;
2462 if (flags & HVhek_FREEKEY)
2465 return HeKEY_hek(entry);
2469 Perl_hv_placeholders_p(pTHX_ HV *hv)
2472 MAGIC *mg = mg_find((SV*)hv, PERL_MAGIC_rhash);
2475 mg = sv_magicext((SV*)hv, 0, PERL_MAGIC_rhash, 0, 0, 0);
2478 Perl_die(aTHX_ "panic: hv_placeholders_p");
2481 return &(mg->mg_len);
2486 Perl_hv_placeholders_get(pTHX_ HV *hv)
2489 MAGIC * const mg = mg_find((SV*)hv, PERL_MAGIC_rhash);
2491 return mg ? mg->mg_len : 0;
2495 Perl_hv_placeholders_set(pTHX_ HV *hv, I32 ph)
2498 MAGIC * const mg = mg_find((SV*)hv, PERL_MAGIC_rhash);
2503 if (!sv_magicext((SV*)hv, 0, PERL_MAGIC_rhash, 0, 0, ph))
2504 Perl_die(aTHX_ "panic: hv_placeholders_set");
2506 /* else we don't need to add magic to record 0 placeholders. */
2510 S_refcounted_he_value(pTHX_ const struct refcounted_he *he)
2514 switch(he->refcounted_he_data[0] & HVrhek_typemask) {
2519 value = &PL_sv_placeholder;
2522 value = newSViv(he->refcounted_he_val.refcounted_he_u_iv);
2525 value = newSVuv(he->refcounted_he_val.refcounted_he_u_uv);
2528 case HVrhek_PV_UTF8:
2529 /* Create a string SV that directly points to the bytes in our
2531 value = newSV_type(SVt_PV);
2532 SvPV_set(value, (char *) he->refcounted_he_data + 1);
2533 SvCUR_set(value, he->refcounted_he_val.refcounted_he_u_len);
2534 /* This stops anything trying to free it */
2535 SvLEN_set(value, 0);
2537 SvREADONLY_on(value);
2538 if ((he->refcounted_he_data[0] & HVrhek_typemask) == HVrhek_PV_UTF8)
2542 Perl_croak(aTHX_ "panic: refcounted_he_value bad flags %x",
2543 he->refcounted_he_data[0]);
2549 =for apidoc refcounted_he_chain_2hv
2551 Generates and returns a C<HV *> by walking up the tree starting at the passed
2552 in C<struct refcounted_he *>.
2557 Perl_refcounted_he_chain_2hv(pTHX_ const struct refcounted_he *chain)
2561 U32 placeholders = 0;
2562 /* We could chase the chain once to get an idea of the number of keys,
2563 and call ksplit. But for now we'll make a potentially inefficient
2564 hash with only 8 entries in its array. */
2565 const U32 max = HvMAX(hv);
2569 Newxz(array, PERL_HV_ARRAY_ALLOC_BYTES(max + 1), char);
2570 HvARRAY(hv) = (HE**)array;
2575 U32 hash = chain->refcounted_he_hash;
2577 U32 hash = HEK_HASH(chain->refcounted_he_hek);
2579 HE **oentry = &((HvARRAY(hv))[hash & max]);
2580 HE *entry = *oentry;
2583 for (; entry; entry = HeNEXT(entry)) {
2584 if (HeHASH(entry) == hash) {
2585 /* We might have a duplicate key here. If so, entry is older
2586 than the key we've already put in the hash, so if they are
2587 the same, skip adding entry. */
2589 const STRLEN klen = HeKLEN(entry);
2590 const char *const key = HeKEY(entry);
2591 if (klen == chain->refcounted_he_keylen
2592 && (!!HeKUTF8(entry)
2593 == !!(chain->refcounted_he_data[0] & HVhek_UTF8))
2594 && memEQ(key, REF_HE_KEY(chain), klen))
2597 if (HeKEY_hek(entry) == chain->refcounted_he_hek)
2599 if (HeKLEN(entry) == HEK_LEN(chain->refcounted_he_hek)
2600 && HeKUTF8(entry) == HEK_UTF8(chain->refcounted_he_hek)
2601 && memEQ(HeKEY(entry), HEK_KEY(chain->refcounted_he_hek),
2612 = share_hek_flags(REF_HE_KEY(chain),
2613 chain->refcounted_he_keylen,
2614 chain->refcounted_he_hash,
2615 (chain->refcounted_he_data[0]
2616 & (HVhek_UTF8|HVhek_WASUTF8)));
2618 HeKEY_hek(entry) = share_hek_hek(chain->refcounted_he_hek);
2620 value = refcounted_he_value(chain);
2621 if (value == &PL_sv_placeholder)
2623 HeVAL(entry) = value;
2625 /* Link it into the chain. */
2626 HeNEXT(entry) = *oentry;
2627 if (!HeNEXT(entry)) {
2628 /* initial entry. */
2636 chain = chain->refcounted_he_next;
2640 clear_placeholders(hv, placeholders);
2641 HvTOTALKEYS(hv) -= placeholders;
2644 /* We could check in the loop to see if we encounter any keys with key
2645 flags, but it's probably not worth it, as this per-hash flag is only
2646 really meant as an optimisation for things like Storable. */
2648 DEBUG_A(Perl_hv_assert(aTHX_ hv));
2654 Perl_refcounted_he_fetch(pTHX_ const struct refcounted_he *chain, SV *keysv,
2655 const char *key, STRLEN klen, int flags, U32 hash)
2658 /* Just to be awkward, if you're using this interface the UTF-8-or-not-ness
2659 of your key has to exactly match that which is stored. */
2660 SV *value = &PL_sv_placeholder;
2664 if (flags & HVhek_FREEKEY)
2666 key = SvPV_const(keysv, klen);
2668 is_utf8 = (SvUTF8(keysv) != 0);
2670 is_utf8 = ((flags & HVhek_UTF8) ? TRUE : FALSE);
2674 if (keysv && (SvIsCOW_shared_hash(keysv))) {
2675 hash = SvSHARED_HASH(keysv);
2677 PERL_HASH(hash, key, klen);
2681 for (; chain; chain = chain->refcounted_he_next) {
2683 if (hash != chain->refcounted_he_hash)
2685 if (klen != chain->refcounted_he_keylen)
2687 if (memNE(REF_HE_KEY(chain),key,klen))
2689 if (!!is_utf8 != !!(chain->refcounted_he_data[0] & HVhek_UTF8))
2692 if (hash != HEK_HASH(chain->refcounted_he_hek))
2694 if (klen != (STRLEN)HEK_LEN(chain->refcounted_he_hek))
2696 if (memNE(HEK_KEY(chain->refcounted_he_hek),key,klen))
2698 if (!!is_utf8 != !!HEK_UTF8(chain->refcounted_he_hek))
2702 value = sv_2mortal(refcounted_he_value(chain));
2706 if (flags & HVhek_FREEKEY)
2713 =for apidoc refcounted_he_new
2715 Creates a new C<struct refcounted_he>. As S<key> is copied, and value is
2716 stored in a compact form, all references remain the property of the caller.
2717 The C<struct refcounted_he> is returned with a reference count of 1.
2722 struct refcounted_he *
2723 Perl_refcounted_he_new(pTHX_ struct refcounted_he *const parent,
2724 SV *const key, SV *const value) {
2726 struct refcounted_he *he;
2728 const char *key_p = SvPV_const(key, key_len);
2729 STRLEN value_len = 0;
2730 const char *value_p = NULL;
2735 bool is_utf8 = SvUTF8(key) ? TRUE : FALSE;
2738 value_type = HVrhek_PV;
2739 } else if (SvIOK(value)) {
2740 value_type = HVrhek_IV;
2741 } else if (value == &PL_sv_placeholder) {
2742 value_type = HVrhek_delete;
2743 } else if (!SvOK(value)) {
2744 value_type = HVrhek_undef;
2746 value_type = HVrhek_PV;
2749 if (value_type == HVrhek_PV) {
2750 value_p = SvPV_const(value, value_len);
2751 key_offset = value_len + 2;
2758 he = (struct refcounted_he*)
2759 PerlMemShared_malloc(sizeof(struct refcounted_he) - 1
2763 he = (struct refcounted_he*)
2764 PerlMemShared_malloc(sizeof(struct refcounted_he) - 1
2769 he->refcounted_he_next = parent;
2771 if (value_type == HVrhek_PV) {
2772 Copy(value_p, he->refcounted_he_data + 1, value_len + 1, char);
2773 he->refcounted_he_val.refcounted_he_u_len = value_len;
2774 /* Do it this way so that the SvUTF8() test is after the SvPV, in case
2775 the value is overloaded, and doesn't yet have the UTF-8flag set. */
2777 value_type = HVrhek_PV_UTF8;
2778 } else if (value_type == HVrhek_IV) {
2780 he->refcounted_he_val.refcounted_he_u_uv = SvUVX(value);
2781 value_type = HVrhek_UV;
2783 he->refcounted_he_val.refcounted_he_u_iv = SvIVX(value);
2789 /* Hash keys are always stored normalised to (yes) ISO-8859-1.
2790 As we're going to be building hash keys from this value in future,
2791 normalise it now. */
2792 key_p = (char*)bytes_from_utf8((const U8*)key_p, &key_len, &is_utf8);
2793 flags |= is_utf8 ? HVhek_UTF8 : HVhek_WASUTF8;
2795 PERL_HASH(hash, key_p, key_len);
2798 he->refcounted_he_hash = hash;
2799 he->refcounted_he_keylen = key_len;
2800 Copy(key_p, he->refcounted_he_data + key_offset, key_len, char);
2802 he->refcounted_he_hek = share_hek_flags(key_p, key_len, hash, flags);
2805 if (flags & HVhek_WASUTF8) {
2806 /* If it was downgraded from UTF-8, then the pointer returned from
2807 bytes_from_utf8 is an allocated pointer that we must free. */
2811 he->refcounted_he_data[0] = flags;
2812 he->refcounted_he_refcnt = 1;
2818 =for apidoc refcounted_he_free
2820 Decrements the reference count of the passed in C<struct refcounted_he *>
2821 by one. If the reference count reaches zero the structure's memory is freed,
2822 and C<refcounted_he_free> iterates onto the parent node.
2828 Perl_refcounted_he_free(pTHX_ struct refcounted_he *he) {
2830 PERL_UNUSED_CONTEXT;
2833 struct refcounted_he *copy;
2837 new_count = --he->refcounted_he_refcnt;
2838 HINTS_REFCNT_UNLOCK;
2844 #ifndef USE_ITHREADS
2845 unshare_hek_or_pvn (he->refcounted_he_hek, 0, 0, 0);
2848 he = he->refcounted_he_next;
2849 PerlMemShared_free(copy);
2854 =for apidoc hv_assert
2856 Check that a hash is in an internally consistent state.
2864 Perl_hv_assert(pTHX_ HV *hv)
2869 int placeholders = 0;
2872 const I32 riter = HvRITER_get(hv);
2873 HE *eiter = HvEITER_get(hv);
2875 (void)hv_iterinit(hv);
2877 while ((entry = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS))) {
2878 /* sanity check the values */
2879 if (HeVAL(entry) == &PL_sv_placeholder)
2883 /* sanity check the keys */
2884 if (HeSVKEY(entry)) {
2885 NOOP; /* Don't know what to check on SV keys. */
2886 } else if (HeKUTF8(entry)) {
2888 if (HeKWASUTF8(entry)) {
2889 PerlIO_printf(Perl_debug_log,
2890 "hash key has both WASUTF8 and UTF8: '%.*s'\n",
2891 (int) HeKLEN(entry), HeKEY(entry));
2894 } else if (HeKWASUTF8(entry))
2897 if (!SvTIED_mg((SV*)hv, PERL_MAGIC_tied)) {
2898 static const char bad_count[] = "Count %d %s(s), but hash reports %d\n";
2899 const int nhashkeys = HvUSEDKEYS(hv);
2900 const int nhashplaceholders = HvPLACEHOLDERS_get(hv);
2902 if (nhashkeys != real) {
2903 PerlIO_printf(Perl_debug_log, bad_count, real, "keys", nhashkeys );
2906 if (nhashplaceholders != placeholders) {
2907 PerlIO_printf(Perl_debug_log, bad_count, placeholders, "placeholder", nhashplaceholders );
2911 if (withflags && ! HvHASKFLAGS(hv)) {
2912 PerlIO_printf(Perl_debug_log,
2913 "Hash has HASKFLAGS off but I count %d key(s) with flags\n",
2920 HvRITER_set(hv, riter); /* Restore hash iterator state */
2921 HvEITER_set(hv, eiter);
2928 * c-indentation-style: bsd
2930 * indent-tabs-mode: t
2933 * ex: set ts=8 sts=4 sw=4 noet: