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
289 the specified hash key exists. C<hash>
290 can be a valid precomputed hash value, or 0 to ask for it to be
296 /* returns an HE * structure with the all fields set */
297 /* note that hent_val will be a mortal sv for MAGICAL hashes */
299 =for apidoc hv_fetch_ent
301 Returns the hash entry which corresponds to the specified key in the hash.
302 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
303 if you want the function to compute it. IF C<lval> is set then the fetch
304 will be part of a store. Make sure the return value is non-null before
305 accessing it. The return value when C<hv> is a tied hash is a pointer to a
306 static location, so be sure to make a copy of the structure if you need to
309 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
310 information on how to use this function on tied hashes.
315 /* Common code for hv_delete()/hv_exists()/hv_fetch()/hv_store() */
317 Perl_hv_common_key_len(pTHX_ HV *hv, const char *key, I32 klen_i32,
318 const int action, SV *val, const U32 hash)
323 PERL_ARGS_ASSERT_HV_COMMON_KEY_LEN;
332 return hv_common(hv, NULL, key, klen, flags, action, val, hash);
336 Perl_hv_common(pTHX_ HV *hv, SV *keysv, const char *key, STRLEN klen,
337 int flags, int action, SV *val, register U32 hash)
346 const int return_svp = action & HV_FETCH_JUST_SV;
350 if (SvTYPE(hv) == (svtype)SVTYPEMASK)
353 assert(SvTYPE(hv) == SVt_PVHV);
355 if (SvSMAGICAL(hv) && SvGMAGICAL(hv) && !(action & HV_DISABLE_UVAR_XKEY)) {
357 if ((mg = mg_find((const SV *)hv, PERL_MAGIC_uvar))) {
358 struct ufuncs * const uf = (struct ufuncs *)mg->mg_ptr;
359 if (uf->uf_set == NULL) {
360 SV* obj = mg->mg_obj;
363 keysv = newSVpvn_flags(key, klen, SVs_TEMP |
364 ((flags & HVhek_UTF8)
368 mg->mg_obj = keysv; /* pass key */
369 uf->uf_index = action; /* pass action */
370 magic_getuvar(MUTABLE_SV(hv), mg);
371 keysv = mg->mg_obj; /* may have changed */
374 /* If the key may have changed, then we need to invalidate
375 any passed-in computed hash value. */
381 if (flags & HVhek_FREEKEY)
383 key = SvPV_const(keysv, klen);
384 is_utf8 = (SvUTF8(keysv) != 0);
385 if (SvIsCOW_shared_hash(keysv)) {
386 flags = HVhek_KEYCANONICAL | (is_utf8 ? HVhek_UTF8 : 0);
391 is_utf8 = ((flags & HVhek_UTF8) ? TRUE : FALSE);
394 if (action & HV_DELETE) {
395 return (void *) hv_delete_common(hv, keysv, key, klen,
396 flags | (is_utf8 ? HVhek_UTF8 : 0),
400 xhv = (XPVHV*)SvANY(hv);
402 if (SvRMAGICAL(hv) && !(action & (HV_FETCH_ISSTORE|HV_FETCH_ISEXISTS))) {
403 if (mg_find((const SV *)hv, PERL_MAGIC_tied)
404 || SvGMAGICAL((const SV *)hv))
406 /* FIXME should be able to skimp on the HE/HEK here when
407 HV_FETCH_JUST_SV is true. */
409 keysv = newSVpvn_utf8(key, klen, is_utf8);
411 keysv = newSVsv(keysv);
414 mg_copy(MUTABLE_SV(hv), sv, (char *)keysv, HEf_SVKEY);
416 /* grab a fake HE/HEK pair from the pool or make a new one */
417 entry = PL_hv_fetch_ent_mh;
419 PL_hv_fetch_ent_mh = HeNEXT(entry);
423 Newx(k, HEK_BASESIZE + sizeof(const SV *), char);
424 HeKEY_hek(entry) = (HEK*)k;
426 HeNEXT(entry) = NULL;
427 HeSVKEY_set(entry, keysv);
429 sv_upgrade(sv, SVt_PVLV);
431 /* so we can free entry when freeing sv */
432 LvTARG(sv) = MUTABLE_SV(entry);
434 /* XXX remove at some point? */
435 if (flags & HVhek_FREEKEY)
439 return entry ? (void *) &HeVAL(entry) : NULL;
441 return (void *) entry;
443 #ifdef ENV_IS_CASELESS
444 else if (mg_find((const SV *)hv, PERL_MAGIC_env)) {
446 for (i = 0; i < klen; ++i)
447 if (isLOWER(key[i])) {
448 /* Would be nice if we had a routine to do the
449 copy and upercase in a single pass through. */
450 const char * const nkey = strupr(savepvn(key,klen));
451 /* Note that this fetch is for nkey (the uppercased
452 key) whereas the store is for key (the original) */
453 void *result = hv_common(hv, NULL, nkey, klen,
454 HVhek_FREEKEY, /* free nkey */
455 0 /* non-LVAL fetch */
456 | HV_DISABLE_UVAR_XKEY
459 0 /* compute hash */);
460 if (!result && (action & HV_FETCH_LVALUE)) {
461 /* This call will free key if necessary.
462 Do it this way to encourage compiler to tail
464 result = hv_common(hv, keysv, key, klen, flags,
466 | HV_DISABLE_UVAR_XKEY
470 if (flags & HVhek_FREEKEY)
478 else if (SvRMAGICAL(hv) && (action & HV_FETCH_ISEXISTS)) {
479 if (mg_find((const SV *)hv, PERL_MAGIC_tied)
480 || SvGMAGICAL((const SV *)hv)) {
481 /* I don't understand why hv_exists_ent has svret and sv,
482 whereas hv_exists only had one. */
483 SV * const svret = sv_newmortal();
486 if (keysv || is_utf8) {
488 keysv = newSVpvn_utf8(key, klen, TRUE);
490 keysv = newSVsv(keysv);
492 mg_copy(MUTABLE_SV(hv), sv, (char *)sv_2mortal(keysv), HEf_SVKEY);
494 mg_copy(MUTABLE_SV(hv), sv, key, klen);
496 if (flags & HVhek_FREEKEY)
498 magic_existspack(svret, mg_find(sv, PERL_MAGIC_tiedelem));
499 /* This cast somewhat evil, but I'm merely using NULL/
500 not NULL to return the boolean exists.
501 And I know hv is not NULL. */
502 return SvTRUE(svret) ? (void *)hv : NULL;
504 #ifdef ENV_IS_CASELESS
505 else if (mg_find((const SV *)hv, PERL_MAGIC_env)) {
506 /* XXX This code isn't UTF8 clean. */
507 char * const keysave = (char * const)key;
508 /* Will need to free this, so set FREEKEY flag. */
509 key = savepvn(key,klen);
510 key = (const char*)strupr((char*)key);
515 if (flags & HVhek_FREEKEY) {
518 flags |= HVhek_FREEKEY;
522 else if (action & HV_FETCH_ISSTORE) {
525 hv_magic_check (hv, &needs_copy, &needs_store);
527 const bool save_taint = PL_tainted;
528 if (keysv || is_utf8) {
530 keysv = newSVpvn_utf8(key, klen, TRUE);
533 PL_tainted = SvTAINTED(keysv);
534 keysv = sv_2mortal(newSVsv(keysv));
535 mg_copy(MUTABLE_SV(hv), val, (char*)keysv, HEf_SVKEY);
537 mg_copy(MUTABLE_SV(hv), val, key, klen);
540 TAINT_IF(save_taint);
542 if (flags & HVhek_FREEKEY)
546 #ifdef ENV_IS_CASELESS
547 else if (mg_find((const SV *)hv, PERL_MAGIC_env)) {
548 /* XXX This code isn't UTF8 clean. */
549 const char *keysave = key;
550 /* Will need to free this, so set FREEKEY flag. */
551 key = savepvn(key,klen);
552 key = (const char*)strupr((char*)key);
557 if (flags & HVhek_FREEKEY) {
560 flags |= HVhek_FREEKEY;
568 if ((action & (HV_FETCH_LVALUE | HV_FETCH_ISSTORE))
569 #ifdef DYNAMIC_ENV_FETCH /* if it's an %ENV lookup, we may get it on the fly */
570 || (SvRMAGICAL((const SV *)hv)
571 && mg_find((const SV *)hv, PERL_MAGIC_env))
576 PERL_HV_ARRAY_ALLOC_BYTES(xhv->xhv_max+1 /* HvMAX(hv)+1 */),
578 HvARRAY(hv) = (HE**)array;
580 #ifdef DYNAMIC_ENV_FETCH
581 else if (action & HV_FETCH_ISEXISTS) {
582 /* for an %ENV exists, if we do an insert it's by a recursive
583 store call, so avoid creating HvARRAY(hv) right now. */
587 /* XXX remove at some point? */
588 if (flags & HVhek_FREEKEY)
595 if (is_utf8 & !(flags & HVhek_KEYCANONICAL)) {
596 char * const keysave = (char *)key;
597 key = (char*)bytes_from_utf8((U8*)key, &klen, &is_utf8);
601 flags &= ~HVhek_UTF8;
602 if (key != keysave) {
603 if (flags & HVhek_FREEKEY)
605 flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
606 /* If the caller calculated a hash, it was on the sequence of
607 octets that are the UTF-8 form. We've now changed the sequence
608 of octets stored to that of the equivalent byte representation,
609 so the hash we need is different. */
614 if (HvREHASH(hv) || (!hash && !(keysv && (SvIsCOW_shared_hash(keysv)))))
615 PERL_HASH_INTERNAL_(hash, key, klen, HvREHASH(hv));
617 hash = SvSHARED_HASH(keysv);
619 /* We don't have a pointer to the hv, so we have to replicate the
620 flag into every HEK, so that hv_iterkeysv can see it.
621 And yes, you do need this even though you are not "storing" because
622 you can flip the flags below if doing an lval lookup. (And that
623 was put in to give the semantics Andreas was expecting.) */
625 flags |= HVhek_REHASH;
627 masked_flags = (flags & HVhek_MASK);
629 #ifdef DYNAMIC_ENV_FETCH
630 if (!HvARRAY(hv)) entry = NULL;
634 entry = (HvARRAY(hv))[hash & (I32) HvMAX(hv)];
636 for (; entry; entry = HeNEXT(entry)) {
637 if (HeHASH(entry) != hash) /* strings can't be equal */
639 if (HeKLEN(entry) != (I32)klen)
641 if (HeKEY(entry) != key && memNE(HeKEY(entry),key,klen)) /* is this it? */
643 if ((HeKFLAGS(entry) ^ masked_flags) & HVhek_UTF8)
646 if (action & (HV_FETCH_LVALUE|HV_FETCH_ISSTORE)) {
647 if (HeKFLAGS(entry) != masked_flags) {
648 /* We match if HVhek_UTF8 bit in our flags and hash key's
649 match. But if entry was set previously with HVhek_WASUTF8
650 and key now doesn't (or vice versa) then we should change
651 the key's flag, as this is assignment. */
652 if (HvSHAREKEYS(hv)) {
653 /* Need to swap the key we have for a key with the flags we
654 need. As keys are shared we can't just write to the
655 flag, so we share the new one, unshare the old one. */
656 HEK * const new_hek = share_hek_flags(key, klen, hash,
658 unshare_hek (HeKEY_hek(entry));
659 HeKEY_hek(entry) = new_hek;
661 else if (hv == PL_strtab) {
662 /* PL_strtab is usually the only hash without HvSHAREKEYS,
663 so putting this test here is cheap */
664 if (flags & HVhek_FREEKEY)
666 Perl_croak(aTHX_ S_strtab_error,
667 action & HV_FETCH_LVALUE ? "fetch" : "store");
670 HeKFLAGS(entry) = masked_flags;
671 if (masked_flags & HVhek_ENABLEHVKFLAGS)
674 if (HeVAL(entry) == &PL_sv_placeholder) {
675 /* yes, can store into placeholder slot */
676 if (action & HV_FETCH_LVALUE) {
678 /* This preserves behaviour with the old hv_fetch
679 implementation which at this point would bail out
680 with a break; (at "if we find a placeholder, we
681 pretend we haven't found anything")
683 That break mean that if a placeholder were found, it
684 caused a call into hv_store, which in turn would
685 check magic, and if there is no magic end up pretty
686 much back at this point (in hv_store's code). */
689 /* LVAL fetch which actually needs a store. */
691 HvPLACEHOLDERS(hv)--;
694 if (val != &PL_sv_placeholder)
695 HvPLACEHOLDERS(hv)--;
698 } else if (action & HV_FETCH_ISSTORE) {
699 SvREFCNT_dec(HeVAL(entry));
702 } else if (HeVAL(entry) == &PL_sv_placeholder) {
703 /* if we find a placeholder, we pretend we haven't found
707 if (flags & HVhek_FREEKEY)
710 return entry ? (void *) &HeVAL(entry) : NULL;
714 #ifdef DYNAMIC_ENV_FETCH /* %ENV lookup? If so, try to fetch the value now */
715 if (!(action & HV_FETCH_ISSTORE)
716 && SvRMAGICAL((const SV *)hv)
717 && mg_find((const SV *)hv, PERL_MAGIC_env)) {
719 const char * const env = PerlEnv_ENVgetenv_len(key,&len);
721 sv = newSVpvn(env,len);
723 return hv_common(hv, keysv, key, klen, flags,
724 HV_FETCH_ISSTORE|HV_DISABLE_UVAR_XKEY|return_svp,
730 if (!entry && SvREADONLY(hv) && !(action & HV_FETCH_ISEXISTS)) {
731 hv_notallowed(flags, key, klen,
732 "Attempt to access disallowed key '%"SVf"' in"
733 " a restricted hash");
735 if (!(action & (HV_FETCH_LVALUE|HV_FETCH_ISSTORE))) {
736 /* Not doing some form of store, so return failure. */
737 if (flags & HVhek_FREEKEY)
741 if (action & HV_FETCH_LVALUE) {
742 val = action & HV_FETCH_EMPTY_HE ? NULL : newSV(0);
744 /* At this point the old hv_fetch code would call to hv_store,
745 which in turn might do some tied magic. So we need to make that
746 magic check happen. */
747 /* gonna assign to this, so it better be there */
748 /* If a fetch-as-store fails on the fetch, then the action is to
749 recurse once into "hv_store". If we didn't do this, then that
750 recursive call would call the key conversion routine again.
751 However, as we replace the original key with the converted
752 key, this would result in a double conversion, which would show
753 up as a bug if the conversion routine is not idempotent. */
754 return hv_common(hv, keysv, key, klen, flags,
755 HV_FETCH_ISSTORE|HV_DISABLE_UVAR_XKEY|return_svp,
757 /* XXX Surely that could leak if the fetch-was-store fails?
758 Just like the hv_fetch. */
762 /* Welcome to hv_store... */
765 /* Not sure if we can get here. I think the only case of oentry being
766 NULL is for %ENV with dynamic env fetch. But that should disappear
767 with magic in the previous code. */
770 PERL_HV_ARRAY_ALLOC_BYTES(xhv->xhv_max+1 /* HvMAX(hv)+1 */),
772 HvARRAY(hv) = (HE**)array;
775 oentry = &(HvARRAY(hv))[hash & (I32) xhv->xhv_max];
778 /* share_hek_flags will do the free for us. This might be considered
781 HeKEY_hek(entry) = share_hek_flags(key, klen, hash, flags);
782 else if (hv == PL_strtab) {
783 /* PL_strtab is usually the only hash without HvSHAREKEYS, so putting
784 this test here is cheap */
785 if (flags & HVhek_FREEKEY)
787 Perl_croak(aTHX_ S_strtab_error,
788 action & HV_FETCH_LVALUE ? "fetch" : "store");
790 else /* gotta do the real thing */
791 HeKEY_hek(entry) = save_hek_flags(key, klen, hash, flags);
793 HeNEXT(entry) = *oentry;
796 if (val == &PL_sv_placeholder)
797 HvPLACEHOLDERS(hv)++;
798 if (masked_flags & HVhek_ENABLEHVKFLAGS)
802 const HE *counter = HeNEXT(entry);
804 xhv->xhv_keys++; /* HvTOTALKEYS(hv)++ */
805 if (!counter) { /* initial entry? */
806 } else if (xhv->xhv_keys > xhv->xhv_max) {
807 /* Use only the old HvUSEDKEYS(hv) > HvMAX(hv) condition to limit
808 bucket splits on a rehashed hash, as we're not going to
809 split it again, and if someone is lucky (evil) enough to
810 get all the keys in one list they could exhaust our memory
811 as we repeatedly double the number of buckets on every
812 entry. Linear search feels a less worse thing to do. */
814 } else if(!HvREHASH(hv)) {
817 while ((counter = HeNEXT(counter)))
820 if (n_links > HV_MAX_LENGTH_BEFORE_SPLIT) {
827 return entry ? (void *) &HeVAL(entry) : NULL;
829 return (void *) entry;
833 S_hv_magic_check(HV *hv, bool *needs_copy, bool *needs_store)
835 const MAGIC *mg = SvMAGIC(hv);
837 PERL_ARGS_ASSERT_HV_MAGIC_CHECK;
842 if (isUPPER(mg->mg_type)) {
844 if (mg->mg_type == PERL_MAGIC_tied) {
845 *needs_store = FALSE;
846 return; /* We've set all there is to set. */
849 mg = mg->mg_moremagic;
854 =for apidoc hv_scalar
856 Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
862 Perl_hv_scalar(pTHX_ HV *hv)
866 PERL_ARGS_ASSERT_HV_SCALAR;
868 if (SvRMAGICAL(hv)) {
869 MAGIC * const mg = mg_find((const SV *)hv, PERL_MAGIC_tied);
871 return magic_scalarpack(hv, mg);
875 if (HvTOTALKEYS((const HV *)hv))
876 Perl_sv_setpvf(aTHX_ sv, "%ld/%ld",
877 (long)HvFILL(hv), (long)HvMAX(hv) + 1);
885 =for apidoc hv_delete
887 Deletes a key/value pair in the hash. The value's SV is removed from
888 the hash, made mortal, and returned to the caller. The absolute
889 value of C<klen> is the length of the key. If C<klen> is negative the
890 key is assumed to be in UTF-8-encoded Unicode. The C<flags> value
891 will normally be zero; if set to G_DISCARD then NULL will be returned.
892 NULL will also be returned if the key is not found.
894 =for apidoc hv_delete_ent
896 Deletes a key/value pair in the hash. The value SV is removed from the hash,
897 made mortal, and returned to the caller. The C<flags> value will normally be
898 zero; if set to G_DISCARD then NULL will be returned. NULL will also be
899 returned if the key is not found. C<hash> can be a valid precomputed hash
900 value, or 0 to ask for it to be computed.
906 S_hv_delete_common(pTHX_ HV *hv, SV *keysv, const char *key, STRLEN klen,
907 int k_flags, I32 d_flags, U32 hash)
912 register HE **oentry;
913 bool is_utf8 = (k_flags & HVhek_UTF8) ? TRUE : FALSE;
916 if (SvRMAGICAL(hv)) {
919 hv_magic_check (hv, &needs_copy, &needs_store);
923 entry = (HE *) hv_common(hv, keysv, key, klen,
924 k_flags & ~HVhek_FREEKEY,
925 HV_FETCH_LVALUE|HV_DISABLE_UVAR_XKEY,
927 sv = entry ? HeVAL(entry) : NULL;
933 if (mg_find(sv, PERL_MAGIC_tiedelem)) {
934 /* No longer an element */
935 sv_unmagic(sv, PERL_MAGIC_tiedelem);
938 return NULL; /* element cannot be deleted */
940 #ifdef ENV_IS_CASELESS
941 else if (mg_find((const SV *)hv, PERL_MAGIC_env)) {
942 /* XXX This code isn't UTF8 clean. */
943 keysv = newSVpvn_flags(key, klen, SVs_TEMP);
944 if (k_flags & HVhek_FREEKEY) {
947 key = strupr(SvPVX(keysv));
956 xhv = (XPVHV*)SvANY(hv);
961 const char * const keysave = key;
962 key = (char*)bytes_from_utf8((U8*)key, &klen, &is_utf8);
965 k_flags |= HVhek_UTF8;
967 k_flags &= ~HVhek_UTF8;
968 if (key != keysave) {
969 if (k_flags & HVhek_FREEKEY) {
970 /* This shouldn't happen if our caller does what we expect,
971 but strictly the API allows it. */
974 k_flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
976 HvHASKFLAGS_on(MUTABLE_SV(hv));
979 if (HvREHASH(hv) || (!hash && !(keysv && (SvIsCOW_shared_hash(keysv)))))
980 PERL_HASH_INTERNAL_(hash, key, klen, HvREHASH(hv));
982 hash = SvSHARED_HASH(keysv);
984 masked_flags = (k_flags & HVhek_MASK);
986 oentry = &(HvARRAY(hv))[hash & (I32) HvMAX(hv)];
988 for (; entry; oentry = &HeNEXT(entry), entry = *oentry) {
990 U8 mro_changes = 0; /* 1 = isa; 2 = package moved */
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 && !SvIsCOW(HeVAL(entry))) {
1017 hv_notallowed(k_flags, key, klen,
1018 "Attempt to delete readonly key '%"SVf"' from"
1019 " a restricted hash");
1021 if (k_flags & HVhek_FREEKEY)
1024 /* If this is a stash and the key ends with ::, then someone is
1025 * deleting a package.
1027 if (HeVAL(entry) && HvENAME_get(hv)) {
1028 gv = (GV *)HeVAL(entry);
1029 if (keysv) key = SvPV(keysv, klen);
1031 (klen > 1 && key[klen-2] == ':' && key[klen-1] == ':')
1033 (klen == 1 && key[0] == ':')
1035 && (klen != 6 || hv!=PL_defstash || memNE(key,"main::",6))
1036 && SvTYPE(gv) == SVt_PVGV && (stash = GvHV((GV *)gv))
1037 && HvENAME_get(stash)) {
1038 /* A previous version of this code checked that the
1039 * GV was still in the symbol table by fetching the
1040 * GV with its name. That is not necessary (and
1041 * sometimes incorrect), as HvENAME cannot be set
1042 * on hv if it is not in the symtab. */
1044 /* Hang on to it for a bit. */
1045 SvREFCNT_inc_simple_void_NN(
1046 sv_2mortal((SV *)gv)
1049 else if (klen == 3 && strnEQ(key, "ISA", 3))
1053 sv = d_flags & G_DISCARD ? HeVAL(entry) : sv_2mortal(HeVAL(entry));
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);
1063 * If a restricted hash, rather than really deleting the entry, put
1064 * a placeholder there. This marks the key as being "approved", so
1065 * we can still access via not-really-existing key without raising
1069 /* We'll be saving this slot, so the number of allocated keys
1070 * doesn't go down, but the number placeholders goes up */
1071 HvPLACEHOLDERS(hv)++;
1073 *oentry = HeNEXT(entry);
1074 if (SvOOK(hv) && entry == HvAUX(hv)->xhv_eiter /* HvEITER(hv) */)
1077 if (SvOOK(hv) && HvLAZYDEL(hv) &&
1078 entry == HeNEXT(HvAUX(hv)->xhv_eiter))
1079 HeNEXT(HvAUX(hv)->xhv_eiter) = HeNEXT(entry);
1080 hv_free_ent(hv, entry);
1082 xhv->xhv_keys--; /* HvTOTALKEYS(hv)-- */
1083 if (xhv->xhv_keys == 0)
1084 HvHASKFLAGS_off(hv);
1087 if (d_flags & G_DISCARD) {
1092 if (mro_changes == 1) mro_isa_changed_in(hv);
1093 else if (mro_changes == 2)
1094 mro_package_moved(NULL, stash, gv, 1);
1098 if (SvREADONLY(hv)) {
1099 hv_notallowed(k_flags, key, klen,
1100 "Attempt to delete disallowed key '%"SVf"' from"
1101 " a restricted hash");
1104 if (k_flags & HVhek_FREEKEY)
1110 S_hsplit(pTHX_ HV *hv)
1113 register XPVHV* const xhv = (XPVHV*)SvANY(hv);
1114 const I32 oldsize = (I32) xhv->xhv_max+1; /* HvMAX(hv)+1 (sick) */
1115 register I32 newsize = oldsize * 2;
1117 char *a = (char*) HvARRAY(hv);
1119 int longest_chain = 0;
1122 PERL_ARGS_ASSERT_HSPLIT;
1124 /*PerlIO_printf(PerlIO_stderr(), "hsplit called for %p which had %d\n",
1125 (void*)hv, (int) oldsize);*/
1127 if (HvPLACEHOLDERS_get(hv) && !SvREADONLY(hv)) {
1128 /* Can make this clear any placeholders first for non-restricted hashes,
1129 even though Storable rebuilds restricted hashes by putting in all the
1130 placeholders (first) before turning on the readonly flag, because
1131 Storable always pre-splits the hash. */
1132 hv_clear_placeholders(hv);
1136 #if defined(STRANGE_MALLOC) || defined(MYMALLOC)
1137 Renew(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1138 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
1144 Move(&a[oldsize * sizeof(HE*)], &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
1147 Newx(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1148 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
1153 Copy(HvARRAY(hv), a, oldsize * sizeof(HE*), char);
1155 Copy(HvAUX(hv), &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
1157 Safefree(HvARRAY(hv));
1161 Zero(&a[oldsize * sizeof(HE*)], (newsize-oldsize) * sizeof(HE*), char); /* zero 2nd half*/
1162 xhv->xhv_max = --newsize; /* HvMAX(hv) = --newsize */
1163 HvARRAY(hv) = (HE**) a;
1166 for (i=0; i<oldsize; i++,aep++) {
1167 int left_length = 0;
1168 int right_length = 0;
1173 if (!entry) /* non-existent */
1177 if ((HeHASH(entry) & newsize) != (U32)i) {
1178 *oentry = HeNEXT(entry);
1179 HeNEXT(entry) = *bep;
1184 oentry = &HeNEXT(entry);
1189 /* I think we don't actually need to keep track of the longest length,
1190 merely flag if anything is too long. But for the moment while
1191 developing this code I'll track it. */
1192 if (left_length > longest_chain)
1193 longest_chain = left_length;
1194 if (right_length > longest_chain)
1195 longest_chain = right_length;
1199 /* Pick your policy for "hashing isn't working" here: */
1200 if (longest_chain <= HV_MAX_LENGTH_BEFORE_SPLIT /* split worked? */
1205 if (hv == PL_strtab) {
1206 /* Urg. Someone is doing something nasty to the string table.
1211 /* Awooga. Awooga. Pathological data. */
1212 /*PerlIO_printf(PerlIO_stderr(), "%p %d of %d with %d/%d buckets\n", (void*)hv,
1213 longest_chain, HvTOTALKEYS(hv), HvFILL(hv), 1+HvMAX(hv));*/
1216 Newxz(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1217 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
1219 Copy(HvAUX(hv), &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
1222 was_shared = HvSHAREKEYS(hv);
1224 HvSHAREKEYS_off(hv);
1229 for (i=0; i<newsize; i++,aep++) {
1230 register HE *entry = *aep;
1232 /* We're going to trash this HE's next pointer when we chain it
1233 into the new hash below, so store where we go next. */
1234 HE * const next = HeNEXT(entry);
1239 PERL_HASH_INTERNAL(hash, HeKEY(entry), HeKLEN(entry));
1244 = save_hek_flags(HeKEY(entry), HeKLEN(entry),
1245 hash, HeKFLAGS(entry));
1246 unshare_hek (HeKEY_hek(entry));
1247 HeKEY_hek(entry) = new_hek;
1249 /* Not shared, so simply write the new hash in. */
1250 HeHASH(entry) = hash;
1252 /*PerlIO_printf(PerlIO_stderr(), "%d ", HeKFLAGS(entry));*/
1253 HEK_REHASH_on(HeKEY_hek(entry));
1254 /*PerlIO_printf(PerlIO_stderr(), "%d\n", HeKFLAGS(entry));*/
1256 /* Copy oentry to the correct new chain. */
1257 bep = ((HE**)a) + (hash & (I32) xhv->xhv_max);
1258 HeNEXT(entry) = *bep;
1264 Safefree (HvARRAY(hv));
1265 HvARRAY(hv) = (HE **)a;
1269 Perl_hv_ksplit(pTHX_ HV *hv, IV newmax)
1272 register XPVHV* xhv = (XPVHV*)SvANY(hv);
1273 const I32 oldsize = (I32) xhv->xhv_max+1; /* HvMAX(hv)+1 (sick) */
1274 register I32 newsize;
1279 PERL_ARGS_ASSERT_HV_KSPLIT;
1281 newsize = (I32) newmax; /* possible truncation here */
1282 if (newsize != newmax || newmax <= oldsize)
1284 while ((newsize & (1 + ~newsize)) != newsize) {
1285 newsize &= ~(newsize & (1 + ~newsize)); /* get proper power of 2 */
1287 if (newsize < newmax)
1289 if (newsize < newmax)
1290 return; /* overflow detection */
1292 a = (char *) HvARRAY(hv);
1295 #if defined(STRANGE_MALLOC) || defined(MYMALLOC)
1296 Renew(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1297 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
1303 Copy(&a[oldsize * sizeof(HE*)], &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
1306 Newx(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1307 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
1312 Copy(HvARRAY(hv), a, oldsize * sizeof(HE*), char);
1314 Copy(HvAUX(hv), &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
1316 Safefree(HvARRAY(hv));
1319 Zero(&a[oldsize * sizeof(HE*)], (newsize-oldsize) * sizeof(HE*), char); /* zero 2nd half*/
1322 Newxz(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize), char);
1324 xhv->xhv_max = --newsize; /* HvMAX(hv) = --newsize */
1325 HvARRAY(hv) = (HE **) a;
1326 if (!xhv->xhv_keys /* !HvTOTALKEYS(hv) */) /* skip rest if no entries */
1330 for (i=0; i<oldsize; i++,aep++) {
1334 if (!entry) /* non-existent */
1337 register I32 j = (HeHASH(entry) & newsize);
1341 *oentry = HeNEXT(entry);
1342 HeNEXT(entry) = aep[j];
1346 oentry = &HeNEXT(entry);
1353 Perl_newHVhv(pTHX_ HV *ohv)
1356 HV * const hv = newHV();
1359 if (!ohv || (!HvTOTALKEYS(ohv) && !SvMAGICAL((const SV *)ohv)))
1361 hv_max = HvMAX(ohv);
1363 if (!SvMAGICAL((const SV *)ohv)) {
1364 /* It's an ordinary hash, so copy it fast. AMS 20010804 */
1366 const bool shared = !!HvSHAREKEYS(ohv);
1367 HE **ents, ** const oents = (HE **)HvARRAY(ohv);
1369 Newx(a, PERL_HV_ARRAY_ALLOC_BYTES(hv_max+1), char);
1372 /* In each bucket... */
1373 for (i = 0; i <= hv_max; i++) {
1375 HE *oent = oents[i];
1382 /* Copy the linked list of entries. */
1383 for (; oent; oent = HeNEXT(oent)) {
1384 const U32 hash = HeHASH(oent);
1385 const char * const key = HeKEY(oent);
1386 const STRLEN len = HeKLEN(oent);
1387 const int flags = HeKFLAGS(oent);
1388 HE * const ent = new_HE();
1389 SV *const val = HeVAL(oent);
1391 HeVAL(ent) = SvIMMORTAL(val) ? val : newSVsv(val);
1393 = shared ? share_hek_flags(key, len, hash, flags)
1394 : save_hek_flags(key, len, hash, flags);
1405 HvTOTALKEYS(hv) = HvTOTALKEYS(ohv);
1409 /* Iterate over ohv, copying keys and values one at a time. */
1411 const I32 riter = HvRITER_get(ohv);
1412 HE * const eiter = HvEITER_get(ohv);
1413 STRLEN hv_fill = HvFILL(ohv);
1415 /* Can we use fewer buckets? (hv_max is always 2^n-1) */
1416 while (hv_max && hv_max + 1 >= hv_fill * 2)
1417 hv_max = hv_max / 2;
1421 while ((entry = hv_iternext_flags(ohv, 0))) {
1422 SV *val = hv_iterval(ohv,entry);
1423 SV * const keysv = HeSVKEY(entry);
1424 val = SvIMMORTAL(val) ? val : newSVsv(val);
1426 (void)hv_store_ent(hv, keysv, val, 0);
1428 (void)hv_store_flags(hv, HeKEY(entry), HeKLEN(entry), val,
1429 HeHASH(entry), HeKFLAGS(entry));
1431 HvRITER_set(ohv, riter);
1432 HvEITER_set(ohv, eiter);
1439 =for apidoc Am|HV *|hv_copy_hints_hv|HV *ohv
1441 A specialised version of L</newHVhv> for copying C<%^H>. I<ohv> must be
1442 a pointer to a hash (which may have C<%^H> magic, but should be generally
1443 non-magical), or C<NULL> (interpreted as an empty hash). The content
1444 of I<ohv> is copied to a new hash, which has the C<%^H>-specific magic
1445 added to it. A pointer to the new hash is returned.
1451 Perl_hv_copy_hints_hv(pTHX_ HV *const ohv)
1453 HV * const hv = newHV();
1456 STRLEN hv_max = HvMAX(ohv);
1457 STRLEN hv_fill = HvFILL(ohv);
1459 const I32 riter = HvRITER_get(ohv);
1460 HE * const eiter = HvEITER_get(ohv);
1462 while (hv_max && hv_max + 1 >= hv_fill * 2)
1463 hv_max = hv_max / 2;
1467 while ((entry = hv_iternext_flags(ohv, 0))) {
1468 SV *const sv = newSVsv(hv_iterval(ohv,entry));
1469 SV *heksv = HeSVKEY(entry);
1470 if (!heksv && sv) heksv = newSVhek(HeKEY_hek(entry));
1471 if (sv) sv_magic(sv, NULL, PERL_MAGIC_hintselem,
1472 (char *)heksv, HEf_SVKEY);
1473 if (heksv == HeSVKEY(entry))
1474 (void)hv_store_ent(hv, heksv, sv, 0);
1476 (void)hv_common(hv, heksv, HeKEY(entry), HeKLEN(entry),
1477 HeKFLAGS(entry), HV_FETCH_ISSTORE|HV_FETCH_JUST_SV, sv, HeHASH(entry));
1478 SvREFCNT_dec(heksv);
1481 HvRITER_set(ohv, riter);
1482 HvEITER_set(ohv, eiter);
1484 hv_magic(hv, NULL, PERL_MAGIC_hints);
1488 /* like hv_free_ent, but returns the SV rather than freeing it */
1490 S_hv_free_ent_ret(pTHX_ HV *hv, register HE *entry)
1495 PERL_ARGS_ASSERT_HV_FREE_ENT_RET;
1500 if (HeKLEN(entry) == HEf_SVKEY) {
1501 SvREFCNT_dec(HeKEY_sv(entry));
1502 Safefree(HeKEY_hek(entry));
1504 else if (HvSHAREKEYS(hv))
1505 unshare_hek(HeKEY_hek(entry));
1507 Safefree(HeKEY_hek(entry));
1514 Perl_hv_free_ent(pTHX_ HV *hv, register HE *entry)
1519 PERL_ARGS_ASSERT_HV_FREE_ENT;
1523 val = hv_free_ent_ret(hv, entry);
1529 Perl_hv_delayfree_ent(pTHX_ HV *hv, register HE *entry)
1533 PERL_ARGS_ASSERT_HV_DELAYFREE_ENT;
1537 /* SvREFCNT_inc to counter the SvREFCNT_dec in hv_free_ent */
1538 sv_2mortal(SvREFCNT_inc(HeVAL(entry))); /* free between statements */
1539 if (HeKLEN(entry) == HEf_SVKEY) {
1540 sv_2mortal(SvREFCNT_inc(HeKEY_sv(entry)));
1542 hv_free_ent(hv, entry);
1546 =for apidoc hv_clear
1548 Frees the all the elements of a hash, leaving it empty.
1549 The XS equivalent of C<%hash = ()>. See also L</hv_undef>.
1551 If any destructors are triggered as a result, the hv itself may
1558 Perl_hv_clear(pTHX_ HV *hv)
1561 register XPVHV* xhv;
1565 DEBUG_A(Perl_hv_assert(aTHX_ hv));
1567 xhv = (XPVHV*)SvANY(hv);
1570 SAVEFREESV(SvREFCNT_inc_simple_NN(hv));
1571 if (SvREADONLY(hv) && HvARRAY(hv) != NULL) {
1572 /* restricted hash: convert all keys to placeholders */
1574 for (i = 0; i <= xhv->xhv_max; i++) {
1575 HE *entry = (HvARRAY(hv))[i];
1576 for (; entry; entry = HeNEXT(entry)) {
1577 /* not already placeholder */
1578 if (HeVAL(entry) != &PL_sv_placeholder) {
1579 if (HeVAL(entry) && SvREADONLY(HeVAL(entry))
1580 && !SvIsCOW(HeVAL(entry))) {
1581 SV* const keysv = hv_iterkeysv(entry);
1583 "Attempt to delete readonly key '%"SVf"' from a restricted hash",
1586 SvREFCNT_dec(HeVAL(entry));
1587 HeVAL(entry) = &PL_sv_placeholder;
1588 HvPLACEHOLDERS(hv)++;
1595 HvPLACEHOLDERS_set(hv, 0);
1598 mg_clear(MUTABLE_SV(hv));
1600 HvHASKFLAGS_off(hv);
1605 mro_isa_changed_in(hv);
1606 HvEITER_set(hv, NULL);
1612 =for apidoc hv_clear_placeholders
1614 Clears any placeholders from a hash. If a restricted hash has any of its keys
1615 marked as readonly and the key is subsequently deleted, the key is not actually
1616 deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
1617 it so it will be ignored by future operations such as iterating over the hash,
1618 but will still allow the hash to have a value reassigned to the key at some
1619 future point. This function clears any such placeholder keys from the hash.
1620 See Hash::Util::lock_keys() for an example of its use.
1626 Perl_hv_clear_placeholders(pTHX_ HV *hv)
1629 const U32 items = (U32)HvPLACEHOLDERS_get(hv);
1631 PERL_ARGS_ASSERT_HV_CLEAR_PLACEHOLDERS;
1634 clear_placeholders(hv, items);
1638 S_clear_placeholders(pTHX_ HV *hv, U32 items)
1643 PERL_ARGS_ASSERT_CLEAR_PLACEHOLDERS;
1650 /* Loop down the linked list heads */
1651 HE **oentry = &(HvARRAY(hv))[i];
1654 while ((entry = *oentry)) {
1655 if (HeVAL(entry) == &PL_sv_placeholder) {
1656 *oentry = HeNEXT(entry);
1657 if (entry == HvEITER_get(hv))
1660 if (SvOOK(hv) && HvLAZYDEL(hv) &&
1661 entry == HeNEXT(HvAUX(hv)->xhv_eiter))
1662 HeNEXT(HvAUX(hv)->xhv_eiter) = HeNEXT(entry);
1663 hv_free_ent(hv, entry);
1668 HvTOTALKEYS(hv) -= (IV)HvPLACEHOLDERS_get(hv);
1669 if (HvUSEDKEYS(hv) == 0)
1670 HvHASKFLAGS_off(hv);
1671 HvPLACEHOLDERS_set(hv, 0);
1675 oentry = &HeNEXT(entry);
1679 /* You can't get here, hence assertion should always fail. */
1680 assert (items == 0);
1685 S_hfreeentries(pTHX_ HV *hv)
1688 XPVHV * const xhv = (XPVHV*)SvANY(hv);
1691 PERL_ARGS_ASSERT_HFREEENTRIES;
1693 while ((sv = Perl_hfree_next_entry(aTHX_ hv, &index))||xhv->xhv_keys) {
1699 /* hfree_next_entry()
1700 * For use only by S_hfreeentries() and sv_clear().
1701 * Delete the next available HE from hv and return the associated SV.
1702 * Returns null on empty hash. Nevertheless null is not a reliable
1703 * indicator that the hash is empty, as the deleted entry may have a
1705 * indexp is a pointer to the current index into HvARRAY. The index should
1706 * initially be set to 0. hfree_next_entry() may update it. */
1709 Perl_hfree_next_entry(pTHX_ HV *hv, STRLEN *indexp)
1711 struct xpvhv_aux *iter;
1715 STRLEN orig_index = *indexp;
1718 PERL_ARGS_ASSERT_HFREE_NEXT_ENTRY;
1720 if (SvOOK(hv) && ((iter = HvAUX(hv)))
1721 && ((entry = iter->xhv_eiter)) )
1723 /* the iterator may get resurrected after each
1724 * destructor call, so check each time */
1725 if (entry && HvLAZYDEL(hv)) { /* was deleted earlier? */
1727 hv_free_ent(hv, entry);
1728 /* warning: at this point HvARRAY may have been
1729 * re-allocated, HvMAX changed etc */
1731 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
1732 iter->xhv_eiter = NULL; /* HvEITER(hv) = NULL */
1735 if (!((XPVHV*)SvANY(hv))->xhv_keys)
1738 array = HvARRAY(hv);
1740 while ( ! ((entry = array[*indexp])) ) {
1741 if ((*indexp)++ >= HvMAX(hv))
1743 assert(*indexp != orig_index);
1745 array[*indexp] = HeNEXT(entry);
1746 ((XPVHV*) SvANY(hv))->xhv_keys--;
1748 if ( PL_phase != PERL_PHASE_DESTRUCT && HvENAME(hv)
1749 && HeVAL(entry) && isGV(HeVAL(entry))
1750 && GvHV(HeVAL(entry)) && HvENAME(GvHV(HeVAL(entry)))
1753 const char * const key = HePV(entry,klen);
1754 if ((klen > 1 && key[klen-1]==':' && key[klen-2]==':')
1755 || (klen == 1 && key[0] == ':')) {
1757 NULL, GvHV(HeVAL(entry)),
1758 (GV *)HeVAL(entry), 0
1762 return hv_free_ent_ret(hv, entry);
1767 =for apidoc hv_undef
1769 Undefines the hash. The XS equivalent of C<undef(%hash)>.
1771 As well as freeing all the elements of the hash (like hv_clear()), this
1772 also frees any auxiliary data and storage associated with the hash.
1774 If any destructors are triggered as a result, the hv itself may
1777 See also L</hv_clear>.
1783 Perl_hv_undef_flags(pTHX_ HV *hv, U32 flags)
1786 register XPVHV* xhv;
1788 const bool save = !!SvREFCNT(hv);
1792 DEBUG_A(Perl_hv_assert(aTHX_ hv));
1793 xhv = (XPVHV*)SvANY(hv);
1795 /* The name must be deleted before the call to hfreeeeentries so that
1796 CVs are anonymised properly. But the effective name must be pre-
1797 served until after that call (and only deleted afterwards if the
1798 call originated from sv_clear). For stashes with one name that is
1799 both the canonical name and the effective name, hv_name_set has to
1800 allocate an array for storing the effective name. We can skip that
1801 during global destruction, as it does not matter where the CVs point
1802 if they will be freed anyway. */
1803 /* note that the code following prior to hfreeentries is duplicated
1804 * in sv_clear(), and changes here should be done there too */
1805 if (PL_phase != PERL_PHASE_DESTRUCT && (name = HvNAME(hv))) {
1807 (void)hv_delete(PL_stashcache, name,
1808 HEK_UTF8(HvNAME_HEK(hv)) ? -HvNAMELEN_get(hv) : HvNAMELEN_get(hv),
1811 hv_name_set(hv, NULL, 0, 0);
1815 SAVEFREESV(SvREFCNT_inc_simple_NN(hv));
1819 struct xpvhv_aux * const aux = HvAUX(hv);
1820 struct mro_meta *meta;
1822 if ((name = HvENAME_get(hv))) {
1823 if (PL_phase != PERL_PHASE_DESTRUCT)
1824 mro_isa_changed_in(hv);
1827 PL_stashcache, name,
1828 HEK_UTF8(HvENAME_HEK(hv)) ? -HvENAMELEN_get(hv) : HvENAMELEN_get(hv),
1833 /* If this call originated from sv_clear, then we must check for
1834 * effective names that need freeing, as well as the usual name. */
1836 if (flags & HV_NAME_SETALL ? !!aux->xhv_name_u.xhvnameu_name : !!name) {
1837 if (name && PL_stashcache)
1838 (void)hv_delete(PL_stashcache, name, (HEK_UTF8(HvNAME_HEK(hv)) ? -HvNAMELEN_get(hv) : HvNAMELEN_get(hv)), G_DISCARD);
1839 hv_name_set(hv, NULL, 0, flags);
1841 if((meta = aux->xhv_mro_meta)) {
1842 if (meta->mro_linear_all) {
1843 SvREFCNT_dec(MUTABLE_SV(meta->mro_linear_all));
1844 meta->mro_linear_all = NULL;
1845 /* This is just acting as a shortcut pointer. */
1846 meta->mro_linear_current = NULL;
1847 } else if (meta->mro_linear_current) {
1848 /* Only the current MRO is stored, so this owns the data.
1850 SvREFCNT_dec(meta->mro_linear_current);
1851 meta->mro_linear_current = NULL;
1853 SvREFCNT_dec(meta->mro_nextmethod);
1854 SvREFCNT_dec(meta->isa);
1856 aux->xhv_mro_meta = NULL;
1858 if (!aux->xhv_name_u.xhvnameu_name && ! aux->xhv_backreferences)
1859 SvFLAGS(hv) &= ~SVf_OOK;
1862 Safefree(HvARRAY(hv));
1863 xhv->xhv_max = 7; /* HvMAX(hv) = 7 (it's a normal hash) */
1866 HvPLACEHOLDERS_set(hv, 0);
1869 mg_clear(MUTABLE_SV(hv));
1876 Returns the number of hash buckets that happen to be in use. This function is
1877 wrapped by the macro C<HvFILL>.
1879 Previously this value was stored in the HV structure, rather than being
1880 calculated on demand.
1886 Perl_hv_fill(pTHX_ HV const *const hv)
1889 HE **ents = HvARRAY(hv);
1891 PERL_ARGS_ASSERT_HV_FILL;
1894 HE *const *const last = ents + HvMAX(hv);
1895 count = last + 1 - ents;
1900 } while (++ents <= last);
1905 static struct xpvhv_aux*
1906 S_hv_auxinit(HV *hv) {
1907 struct xpvhv_aux *iter;
1910 PERL_ARGS_ASSERT_HV_AUXINIT;
1913 Newxz(array, PERL_HV_ARRAY_ALLOC_BYTES(HvMAX(hv) + 1)
1914 + sizeof(struct xpvhv_aux), char);
1916 array = (char *) HvARRAY(hv);
1917 Renew(array, PERL_HV_ARRAY_ALLOC_BYTES(HvMAX(hv) + 1)
1918 + sizeof(struct xpvhv_aux), char);
1920 HvARRAY(hv) = (HE**) array;
1924 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
1925 iter->xhv_eiter = NULL; /* HvEITER(hv) = NULL */
1926 iter->xhv_name_u.xhvnameu_name = 0;
1927 iter->xhv_name_count = 0;
1928 iter->xhv_backreferences = 0;
1929 iter->xhv_mro_meta = NULL;
1934 =for apidoc hv_iterinit
1936 Prepares a starting point to traverse a hash table. Returns the number of
1937 keys in the hash (i.e. the same as C<HvUSEDKEYS(hv)>). The return value is
1938 currently only meaningful for hashes without tie magic.
1940 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1941 hash buckets that happen to be in use. If you still need that esoteric
1942 value, you can get it through the macro C<HvFILL(hv)>.
1949 Perl_hv_iterinit(pTHX_ HV *hv)
1951 PERL_ARGS_ASSERT_HV_ITERINIT;
1953 /* FIXME: Are we not NULL, or do we croak? Place bets now! */
1956 Perl_croak(aTHX_ "Bad hash");
1959 struct xpvhv_aux * const iter = HvAUX(hv);
1960 HE * const entry = iter->xhv_eiter; /* HvEITER(hv) */
1961 if (entry && HvLAZYDEL(hv)) { /* was deleted earlier? */
1963 hv_free_ent(hv, entry);
1965 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
1966 iter->xhv_eiter = NULL; /* HvEITER(hv) = NULL */
1971 /* used to be xhv->xhv_fill before 5.004_65 */
1972 return HvTOTALKEYS(hv);
1976 Perl_hv_riter_p(pTHX_ HV *hv) {
1977 struct xpvhv_aux *iter;
1979 PERL_ARGS_ASSERT_HV_RITER_P;
1982 Perl_croak(aTHX_ "Bad hash");
1984 iter = SvOOK(hv) ? HvAUX(hv) : hv_auxinit(hv);
1985 return &(iter->xhv_riter);
1989 Perl_hv_eiter_p(pTHX_ HV *hv) {
1990 struct xpvhv_aux *iter;
1992 PERL_ARGS_ASSERT_HV_EITER_P;
1995 Perl_croak(aTHX_ "Bad hash");
1997 iter = SvOOK(hv) ? HvAUX(hv) : hv_auxinit(hv);
1998 return &(iter->xhv_eiter);
2002 Perl_hv_riter_set(pTHX_ HV *hv, I32 riter) {
2003 struct xpvhv_aux *iter;
2005 PERL_ARGS_ASSERT_HV_RITER_SET;
2008 Perl_croak(aTHX_ "Bad hash");
2016 iter = hv_auxinit(hv);
2018 iter->xhv_riter = riter;
2022 Perl_hv_eiter_set(pTHX_ HV *hv, HE *eiter) {
2023 struct xpvhv_aux *iter;
2025 PERL_ARGS_ASSERT_HV_EITER_SET;
2028 Perl_croak(aTHX_ "Bad hash");
2033 /* 0 is the default so don't go malloc()ing a new structure just to
2038 iter = hv_auxinit(hv);
2040 iter->xhv_eiter = eiter;
2044 Perl_hv_name_set(pTHX_ HV *hv, const char *name, U32 len, U32 flags)
2047 struct xpvhv_aux *iter;
2051 PERL_ARGS_ASSERT_HV_NAME_SET;
2054 Perl_croak(aTHX_ "panic: hv name too long (%"UVuf")", (UV) len);
2058 if (iter->xhv_name_u.xhvnameu_name) {
2059 if(iter->xhv_name_count) {
2060 if(flags & HV_NAME_SETALL) {
2061 HEK ** const name = HvAUX(hv)->xhv_name_u.xhvnameu_names;
2062 HEK **hekp = name + (
2063 iter->xhv_name_count < 0
2064 ? -iter->xhv_name_count
2065 : iter->xhv_name_count
2067 while(hekp-- > name+1)
2068 unshare_hek_or_pvn(*hekp, 0, 0, 0);
2069 /* The first elem may be null. */
2070 if(*name) unshare_hek_or_pvn(*name, 0, 0, 0);
2072 spot = &iter->xhv_name_u.xhvnameu_name;
2073 iter->xhv_name_count = 0;
2076 if(iter->xhv_name_count > 0) {
2077 /* shift some things over */
2079 iter->xhv_name_u.xhvnameu_names, iter->xhv_name_count + 1, HEK *
2081 spot = iter->xhv_name_u.xhvnameu_names;
2082 spot[iter->xhv_name_count] = spot[1];
2084 iter->xhv_name_count = -(iter->xhv_name_count + 1);
2086 else if(*(spot = iter->xhv_name_u.xhvnameu_names)) {
2087 unshare_hek_or_pvn(*spot, 0, 0, 0);
2091 else if (flags & HV_NAME_SETALL) {
2092 unshare_hek_or_pvn(iter->xhv_name_u.xhvnameu_name, 0, 0, 0);
2093 spot = &iter->xhv_name_u.xhvnameu_name;
2096 HEK * const existing_name = iter->xhv_name_u.xhvnameu_name;
2097 Newx(iter->xhv_name_u.xhvnameu_names, 2, HEK *);
2098 iter->xhv_name_count = -2;
2099 spot = iter->xhv_name_u.xhvnameu_names;
2100 spot[1] = existing_name;
2103 else { spot = &iter->xhv_name_u.xhvnameu_name; iter->xhv_name_count = 0; }
2108 iter = hv_auxinit(hv);
2109 spot = &iter->xhv_name_u.xhvnameu_name;
2111 PERL_HASH(hash, name, len);
2112 *spot = name ? share_hek(name, flags & SVf_UTF8 ? -(I32)len : (I32)len, hash) : NULL;
2116 This is basically sv_eq_flags() in sv.c, but we avoid the magic
2121 hek_eq_pvn_flags(pTHX_ const HEK *hek, const char* pv, const I32 pvlen, const U32 flags) {
2122 if ( (HEK_UTF8(hek) ? 1 : 0) != (flags & SVf_UTF8 ? 1 : 0) ) {
2123 if (flags & SVf_UTF8)
2124 return (bytes_cmp_utf8(
2125 (const U8*)HEK_KEY(hek), HEK_LEN(hek),
2126 (const U8*)pv, pvlen) == 0);
2128 return (bytes_cmp_utf8(
2129 (const U8*)pv, pvlen,
2130 (const U8*)HEK_KEY(hek), HEK_LEN(hek)) == 0);
2133 return HEK_LEN(hek) == pvlen && ((HEK_KEY(hek) == pv)
2134 || memEQ(HEK_KEY(hek), pv, pvlen));
2138 =for apidoc hv_ename_add
2140 Adds a name to a stash's internal list of effective names. See
2143 This is called when a stash is assigned to a new location in the symbol
2150 Perl_hv_ename_add(pTHX_ HV *hv, const char *name, U32 len, U32 flags)
2153 struct xpvhv_aux *aux = SvOOK(hv) ? HvAUX(hv) : hv_auxinit(hv);
2156 PERL_ARGS_ASSERT_HV_ENAME_ADD;
2159 Perl_croak(aTHX_ "panic: hv name too long (%"UVuf")", (UV) len);
2161 PERL_HASH(hash, name, len);
2163 if (aux->xhv_name_count) {
2164 HEK ** const xhv_name = aux->xhv_name_u.xhvnameu_names;
2165 I32 count = aux->xhv_name_count;
2166 HEK **hekp = xhv_name + (count < 0 ? -count : count);
2167 while (hekp-- > xhv_name)
2169 (HEK_UTF8(*hekp) || (flags & SVf_UTF8))
2170 ? hek_eq_pvn_flags(aTHX_ *hekp, name, (I32)len, flags)
2171 : (HEK_LEN(*hekp) == (I32)len && memEQ(HEK_KEY(*hekp), name, len))
2173 if (hekp == xhv_name && count < 0)
2174 aux->xhv_name_count = -count;
2177 if (count < 0) aux->xhv_name_count--, count = -count;
2178 else aux->xhv_name_count++;
2179 Renew(aux->xhv_name_u.xhvnameu_names, count + 1, HEK *);
2180 (aux->xhv_name_u.xhvnameu_names)[count] = share_hek(name, (flags & SVf_UTF8 ? -(I32)len : (I32)len), hash);
2183 HEK *existing_name = aux->xhv_name_u.xhvnameu_name;
2186 (HEK_UTF8(existing_name) || (flags & SVf_UTF8))
2187 ? hek_eq_pvn_flags(aTHX_ existing_name, name, (I32)len, flags)
2188 : (HEK_LEN(existing_name) == (I32)len && memEQ(HEK_KEY(existing_name), name, len))
2191 Newx(aux->xhv_name_u.xhvnameu_names, 2, HEK *);
2192 aux->xhv_name_count = existing_name ? 2 : -2;
2193 *aux->xhv_name_u.xhvnameu_names = existing_name;
2194 (aux->xhv_name_u.xhvnameu_names)[1] = share_hek(name, (flags & SVf_UTF8 ? -(I32)len : (I32)len), hash);
2199 =for apidoc hv_ename_delete
2201 Removes a name from a stash's internal list of effective names. If this is
2202 the name returned by C<HvENAME>, then another name in the list will take
2203 its place (C<HvENAME> will use it).
2205 This is called when a stash is deleted from the symbol table.
2211 Perl_hv_ename_delete(pTHX_ HV *hv, const char *name, U32 len, U32 flags)
2214 struct xpvhv_aux *aux;
2216 PERL_ARGS_ASSERT_HV_ENAME_DELETE;
2219 Perl_croak(aTHX_ "panic: hv name too long (%"UVuf")", (UV) len);
2221 if (!SvOOK(hv)) return;
2224 if (!aux->xhv_name_u.xhvnameu_name) return;
2226 if (aux->xhv_name_count) {
2227 HEK ** const namep = aux->xhv_name_u.xhvnameu_names;
2228 I32 const count = aux->xhv_name_count;
2229 HEK **victim = namep + (count < 0 ? -count : count);
2230 while (victim-- > namep + 1)
2232 (HEK_UTF8(*victim) || (flags & SVf_UTF8))
2233 ? hek_eq_pvn_flags(aTHX_ *victim, name, (I32)len, flags)
2234 : (HEK_LEN(*victim) == (I32)len && memEQ(HEK_KEY(*victim), name, len))
2236 unshare_hek_or_pvn(*victim, 0, 0, 0);
2237 if (count < 0) ++aux->xhv_name_count;
2238 else --aux->xhv_name_count;
2240 (aux->xhv_name_count == 1 || aux->xhv_name_count == -1)
2242 ) { /* if there are none left */
2244 aux->xhv_name_u.xhvnameu_names = NULL;
2245 aux->xhv_name_count = 0;
2248 /* Move the last one back to fill the empty slot. It
2249 does not matter what order they are in. */
2250 *victim = *(namep + (count < 0 ? -count : count) - 1);
2255 count > 0 && (HEK_UTF8(*namep) || (flags & SVf_UTF8))
2256 ? hek_eq_pvn_flags(aTHX_ *namep, name, (I32)len, flags)
2257 : (HEK_LEN(*namep) == (I32)len && memEQ(HEK_KEY(*namep), name, len))
2259 aux->xhv_name_count = -count;
2263 (HEK_UTF8(aux->xhv_name_u.xhvnameu_name) || (flags & SVf_UTF8))
2264 ? hek_eq_pvn_flags(aTHX_ aux->xhv_name_u.xhvnameu_name, name, (I32)len, flags)
2265 : (HEK_LEN(aux->xhv_name_u.xhvnameu_name) == (I32)len &&
2266 memEQ(HEK_KEY(aux->xhv_name_u.xhvnameu_name), name, len))
2268 HEK * const namehek = aux->xhv_name_u.xhvnameu_name;
2269 Newx(aux->xhv_name_u.xhvnameu_names, 1, HEK *);
2270 *aux->xhv_name_u.xhvnameu_names = namehek;
2271 aux->xhv_name_count = -1;
2276 Perl_hv_backreferences_p(pTHX_ HV *hv) {
2277 struct xpvhv_aux * const iter = SvOOK(hv) ? HvAUX(hv) : hv_auxinit(hv);
2279 PERL_ARGS_ASSERT_HV_BACKREFERENCES_P;
2280 PERL_UNUSED_CONTEXT;
2282 return &(iter->xhv_backreferences);
2286 Perl_hv_kill_backrefs(pTHX_ HV *hv) {
2289 PERL_ARGS_ASSERT_HV_KILL_BACKREFS;
2294 av = HvAUX(hv)->xhv_backreferences;
2297 HvAUX(hv)->xhv_backreferences = 0;
2298 Perl_sv_kill_backrefs(aTHX_ MUTABLE_SV(hv), av);
2299 if (SvTYPE(av) == SVt_PVAV)
2305 hv_iternext is implemented as a macro in hv.h
2307 =for apidoc hv_iternext
2309 Returns entries from a hash iterator. See C<hv_iterinit>.
2311 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
2312 iterator currently points to, without losing your place or invalidating your
2313 iterator. Note that in this case the current entry is deleted from the hash
2314 with your iterator holding the last reference to it. Your iterator is flagged
2315 to free the entry on the next call to C<hv_iternext>, so you must not discard
2316 your iterator immediately else the entry will leak - call C<hv_iternext> to
2317 trigger the resource deallocation.
2319 =for apidoc hv_iternext_flags
2321 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
2322 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
2323 set the placeholders keys (for restricted hashes) will be returned in addition
2324 to normal keys. By default placeholders are automatically skipped over.
2325 Currently a placeholder is implemented with a value that is
2326 C<&PL_sv_placeholder>. Note that the implementation of placeholders and
2327 restricted hashes may change, and the implementation currently is
2328 insufficiently abstracted for any change to be tidy.
2334 Perl_hv_iternext_flags(pTHX_ HV *hv, I32 flags)
2337 register XPVHV* xhv;
2341 struct xpvhv_aux *iter;
2343 PERL_ARGS_ASSERT_HV_ITERNEXT_FLAGS;
2346 Perl_croak(aTHX_ "Bad hash");
2348 xhv = (XPVHV*)SvANY(hv);
2351 /* Too many things (well, pp_each at least) merrily assume that you can
2352 call iv_iternext without calling hv_iterinit, so we'll have to deal
2358 oldentry = entry = iter->xhv_eiter; /* HvEITER(hv) */
2359 if (SvMAGICAL(hv) && SvRMAGICAL(hv)) {
2360 if ( ( mg = mg_find((const SV *)hv, PERL_MAGIC_tied) ) ) {
2361 SV * const key = sv_newmortal();
2363 sv_setsv(key, HeSVKEY_force(entry));
2364 SvREFCNT_dec(HeSVKEY(entry)); /* get rid of previous key */
2370 /* one HE per MAGICAL hash */
2371 iter->xhv_eiter = entry = new_HE(); /* HvEITER(hv) = new_HE() */
2373 Newxz(k, HEK_BASESIZE + sizeof(const SV *), char);
2375 HeKEY_hek(entry) = hek;
2376 HeKLEN(entry) = HEf_SVKEY;
2378 magic_nextpack(MUTABLE_SV(hv),mg,key);
2380 /* force key to stay around until next time */
2381 HeSVKEY_set(entry, SvREFCNT_inc_simple_NN(key));
2382 return entry; /* beware, hent_val is not set */
2384 SvREFCNT_dec(HeVAL(entry));
2385 Safefree(HeKEY_hek(entry));
2387 iter->xhv_eiter = NULL; /* HvEITER(hv) = NULL */
2391 #if defined(DYNAMIC_ENV_FETCH) && !defined(__riscos__) /* set up %ENV for iteration */
2392 if (!entry && SvRMAGICAL((const SV *)hv)
2393 && mg_find((const SV *)hv, PERL_MAGIC_env)) {
2396 /* The prime_env_iter() on VMS just loaded up new hash values
2397 * so the iteration count needs to be reset back to the beginning
2401 oldentry = entry = iter->xhv_eiter; /* HvEITER(hv) */
2406 /* hv_iterinit now ensures this. */
2407 assert (HvARRAY(hv));
2409 /* At start of hash, entry is NULL. */
2412 entry = HeNEXT(entry);
2413 if (!(flags & HV_ITERNEXT_WANTPLACEHOLDERS)) {
2415 * Skip past any placeholders -- don't want to include them in
2418 while (entry && HeVAL(entry) == &PL_sv_placeholder) {
2419 entry = HeNEXT(entry);
2424 /* Skip the entire loop if the hash is empty. */
2425 if ((flags & HV_ITERNEXT_WANTPLACEHOLDERS)
2426 ? HvTOTALKEYS(hv) : HvUSEDKEYS(hv)) {
2428 /* OK. Come to the end of the current list. Grab the next one. */
2430 iter->xhv_riter++; /* HvRITER(hv)++ */
2431 if (iter->xhv_riter > (I32)xhv->xhv_max /* HvRITER(hv) > HvMAX(hv) */) {
2432 /* There is no next one. End of the hash. */
2433 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
2436 entry = (HvARRAY(hv))[iter->xhv_riter];
2438 if (!(flags & HV_ITERNEXT_WANTPLACEHOLDERS)) {
2439 /* If we have an entry, but it's a placeholder, don't count it.
2441 while (entry && HeVAL(entry) == &PL_sv_placeholder)
2442 entry = HeNEXT(entry);
2444 /* Will loop again if this linked list starts NULL
2445 (for HV_ITERNEXT_WANTPLACEHOLDERS)
2446 or if we run through it and find only placeholders. */
2449 else iter->xhv_riter = -1;
2451 if (oldentry && HvLAZYDEL(hv)) { /* was deleted earlier? */
2453 hv_free_ent(hv, oldentry);
2456 /*if (HvREHASH(hv) && entry && !HeKREHASH(entry))
2457 PerlIO_printf(PerlIO_stderr(), "Awooga %p %p\n", (void*)hv, (void*)entry);*/
2459 iter->xhv_eiter = entry; /* HvEITER(hv) = entry */
2464 =for apidoc hv_iterkey
2466 Returns the key from the current position of the hash iterator. See
2473 Perl_hv_iterkey(pTHX_ register HE *entry, I32 *retlen)
2475 PERL_ARGS_ASSERT_HV_ITERKEY;
2477 if (HeKLEN(entry) == HEf_SVKEY) {
2479 char * const p = SvPV(HeKEY_sv(entry), len);
2484 *retlen = HeKLEN(entry);
2485 return HeKEY(entry);
2489 /* unlike hv_iterval(), this always returns a mortal copy of the key */
2491 =for apidoc hv_iterkeysv
2493 Returns the key as an C<SV*> from the current position of the hash
2494 iterator. The return value will always be a mortal copy of the key. Also
2501 Perl_hv_iterkeysv(pTHX_ register HE *entry)
2503 PERL_ARGS_ASSERT_HV_ITERKEYSV;
2505 return sv_2mortal(newSVhek(HeKEY_hek(entry)));
2509 =for apidoc hv_iterval
2511 Returns the value from the current position of the hash iterator. See
2518 Perl_hv_iterval(pTHX_ HV *hv, register HE *entry)
2520 PERL_ARGS_ASSERT_HV_ITERVAL;
2522 if (SvRMAGICAL(hv)) {
2523 if (mg_find((const SV *)hv, PERL_MAGIC_tied)) {
2524 SV* const sv = sv_newmortal();
2525 if (HeKLEN(entry) == HEf_SVKEY)
2526 mg_copy(MUTABLE_SV(hv), sv, (char*)HeKEY_sv(entry), HEf_SVKEY);
2528 mg_copy(MUTABLE_SV(hv), sv, HeKEY(entry), HeKLEN(entry));
2532 return HeVAL(entry);
2536 =for apidoc hv_iternextsv
2538 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
2545 Perl_hv_iternextsv(pTHX_ HV *hv, char **key, I32 *retlen)
2547 HE * const he = hv_iternext_flags(hv, 0);
2549 PERL_ARGS_ASSERT_HV_ITERNEXTSV;
2553 *key = hv_iterkey(he, retlen);
2554 return hv_iterval(hv, he);
2561 =for apidoc hv_magic
2563 Adds magic to a hash. See C<sv_magic>.
2568 /* possibly free a shared string if no one has access to it
2569 * len and hash must both be valid for str.
2572 Perl_unsharepvn(pTHX_ const char *str, I32 len, U32 hash)
2574 unshare_hek_or_pvn (NULL, str, len, hash);
2579 Perl_unshare_hek(pTHX_ HEK *hek)
2582 unshare_hek_or_pvn(hek, NULL, 0, 0);
2585 /* possibly free a shared string if no one has access to it
2586 hek if non-NULL takes priority over the other 3, else str, len and hash
2587 are used. If so, len and hash must both be valid for str.
2590 S_unshare_hek_or_pvn(pTHX_ const HEK *hek, const char *str, I32 len, U32 hash)
2593 register XPVHV* xhv;
2595 register HE **oentry;
2596 bool is_utf8 = FALSE;
2598 const char * const save = str;
2599 struct shared_he *he = NULL;
2602 /* Find the shared he which is just before us in memory. */
2603 he = (struct shared_he *)(((char *)hek)
2604 - STRUCT_OFFSET(struct shared_he,
2607 /* Assert that the caller passed us a genuine (or at least consistent)
2609 assert (he->shared_he_he.hent_hek == hek);
2611 if (he->shared_he_he.he_valu.hent_refcount - 1) {
2612 --he->shared_he_he.he_valu.hent_refcount;
2616 hash = HEK_HASH(hek);
2617 } else if (len < 0) {
2618 STRLEN tmplen = -len;
2620 /* See the note in hv_fetch(). --jhi */
2621 str = (char*)bytes_from_utf8((U8*)str, &tmplen, &is_utf8);
2624 k_flags = HVhek_UTF8;
2626 k_flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
2629 /* what follows was the moral equivalent of:
2630 if ((Svp = hv_fetch(PL_strtab, tmpsv, FALSE, hash))) {
2632 hv_delete(PL_strtab, str, len, G_DISCARD, hash);
2634 xhv = (XPVHV*)SvANY(PL_strtab);
2635 /* assert(xhv_array != 0) */
2636 oentry = &(HvARRAY(PL_strtab))[hash & (I32) HvMAX(PL_strtab)];
2638 const HE *const he_he = &(he->shared_he_he);
2639 for (entry = *oentry; entry; oentry = &HeNEXT(entry), entry = *oentry) {
2644 const int flags_masked = k_flags & HVhek_MASK;
2645 for (entry = *oentry; entry; oentry = &HeNEXT(entry), entry = *oentry) {
2646 if (HeHASH(entry) != hash) /* strings can't be equal */
2648 if (HeKLEN(entry) != len)
2650 if (HeKEY(entry) != str && memNE(HeKEY(entry),str,len)) /* is this it? */
2652 if (HeKFLAGS(entry) != flags_masked)
2659 if (--entry->he_valu.hent_refcount == 0) {
2660 *oentry = HeNEXT(entry);
2662 xhv->xhv_keys--; /* HvTOTALKEYS(hv)-- */
2667 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
2668 "Attempt to free nonexistent shared string '%s'%s"
2670 hek ? HEK_KEY(hek) : str,
2671 ((k_flags & HVhek_UTF8) ? " (utf8)" : "") pTHX__VALUE);
2672 if (k_flags & HVhek_FREEKEY)
2676 /* get a (constant) string ptr from the global string table
2677 * string will get added if it is not already there.
2678 * len and hash must both be valid for str.
2681 Perl_share_hek(pTHX_ const char *str, I32 len, register U32 hash)
2683 bool is_utf8 = FALSE;
2685 const char * const save = str;
2687 PERL_ARGS_ASSERT_SHARE_HEK;
2690 STRLEN tmplen = -len;
2692 /* See the note in hv_fetch(). --jhi */
2693 str = (char*)bytes_from_utf8((U8*)str, &tmplen, &is_utf8);
2695 /* If we were able to downgrade here, then than means that we were passed
2696 in a key which only had chars 0-255, but was utf8 encoded. */
2699 /* If we found we were able to downgrade the string to bytes, then
2700 we should flag that it needs upgrading on keys or each. Also flag
2701 that we need share_hek_flags to free the string. */
2703 PERL_HASH(hash, str, len);
2704 flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
2708 return share_hek_flags (str, len, hash, flags);
2712 S_share_hek_flags(pTHX_ const char *str, I32 len, register U32 hash, int flags)
2716 const int flags_masked = flags & HVhek_MASK;
2717 const U32 hindex = hash & (I32) HvMAX(PL_strtab);
2718 register XPVHV * const xhv = (XPVHV*)SvANY(PL_strtab);
2720 PERL_ARGS_ASSERT_SHARE_HEK_FLAGS;
2722 /* what follows is the moral equivalent of:
2724 if (!(Svp = hv_fetch(PL_strtab, str, len, FALSE)))
2725 hv_store(PL_strtab, str, len, NULL, hash);
2727 Can't rehash the shared string table, so not sure if it's worth
2728 counting the number of entries in the linked list
2731 /* assert(xhv_array != 0) */
2732 entry = (HvARRAY(PL_strtab))[hindex];
2733 for (;entry; entry = HeNEXT(entry)) {
2734 if (HeHASH(entry) != hash) /* strings can't be equal */
2736 if (HeKLEN(entry) != len)
2738 if (HeKEY(entry) != str && memNE(HeKEY(entry),str,len)) /* is this it? */
2740 if (HeKFLAGS(entry) != flags_masked)
2746 /* What used to be head of the list.
2747 If this is NULL, then we're the first entry for this slot, which
2748 means we need to increate fill. */
2749 struct shared_he *new_entry;
2752 HE **const head = &HvARRAY(PL_strtab)[hindex];
2753 HE *const next = *head;
2755 /* We don't actually store a HE from the arena and a regular HEK.
2756 Instead we allocate one chunk of memory big enough for both,
2757 and put the HEK straight after the HE. This way we can find the
2758 HE directly from the HEK.
2761 Newx(k, STRUCT_OFFSET(struct shared_he,
2762 shared_he_hek.hek_key[0]) + len + 2, char);
2763 new_entry = (struct shared_he *)k;
2764 entry = &(new_entry->shared_he_he);
2765 hek = &(new_entry->shared_he_hek);
2767 Copy(str, HEK_KEY(hek), len, char);
2768 HEK_KEY(hek)[len] = 0;
2770 HEK_HASH(hek) = hash;
2771 HEK_FLAGS(hek) = (unsigned char)flags_masked;
2773 /* Still "point" to the HEK, so that other code need not know what
2775 HeKEY_hek(entry) = hek;
2776 entry->he_valu.hent_refcount = 0;
2777 HeNEXT(entry) = next;
2780 xhv->xhv_keys++; /* HvTOTALKEYS(hv)++ */
2781 if (!next) { /* initial entry? */
2782 } else if (xhv->xhv_keys > xhv->xhv_max /* HvUSEDKEYS(hv) > HvMAX(hv) */) {
2787 ++entry->he_valu.hent_refcount;
2789 if (flags & HVhek_FREEKEY)
2792 return HeKEY_hek(entry);
2796 Perl_hv_placeholders_p(pTHX_ HV *hv)
2799 MAGIC *mg = mg_find((const SV *)hv, PERL_MAGIC_rhash);
2801 PERL_ARGS_ASSERT_HV_PLACEHOLDERS_P;
2804 mg = sv_magicext(MUTABLE_SV(hv), 0, PERL_MAGIC_rhash, 0, 0, 0);
2807 Perl_die(aTHX_ "panic: hv_placeholders_p");
2810 return &(mg->mg_len);
2815 Perl_hv_placeholders_get(pTHX_ const HV *hv)
2818 MAGIC * const mg = mg_find((const SV *)hv, PERL_MAGIC_rhash);
2820 PERL_ARGS_ASSERT_HV_PLACEHOLDERS_GET;
2822 return mg ? mg->mg_len : 0;
2826 Perl_hv_placeholders_set(pTHX_ HV *hv, I32 ph)
2829 MAGIC * const mg = mg_find((const SV *)hv, PERL_MAGIC_rhash);
2831 PERL_ARGS_ASSERT_HV_PLACEHOLDERS_SET;
2836 if (!sv_magicext(MUTABLE_SV(hv), 0, PERL_MAGIC_rhash, 0, 0, ph))
2837 Perl_die(aTHX_ "panic: hv_placeholders_set");
2839 /* else we don't need to add magic to record 0 placeholders. */
2843 S_refcounted_he_value(pTHX_ const struct refcounted_he *he)
2848 PERL_ARGS_ASSERT_REFCOUNTED_HE_VALUE;
2850 switch(he->refcounted_he_data[0] & HVrhek_typemask) {
2855 value = &PL_sv_placeholder;
2858 value = newSViv(he->refcounted_he_val.refcounted_he_u_iv);
2861 value = newSVuv(he->refcounted_he_val.refcounted_he_u_uv);
2864 case HVrhek_PV_UTF8:
2865 /* Create a string SV that directly points to the bytes in our
2867 value = newSV_type(SVt_PV);
2868 SvPV_set(value, (char *) he->refcounted_he_data + 1);
2869 SvCUR_set(value, he->refcounted_he_val.refcounted_he_u_len);
2870 /* This stops anything trying to free it */
2871 SvLEN_set(value, 0);
2873 SvREADONLY_on(value);
2874 if ((he->refcounted_he_data[0] & HVrhek_typemask) == HVrhek_PV_UTF8)
2878 Perl_croak(aTHX_ "panic: refcounted_he_value bad flags %"UVxf,
2879 (UV)he->refcounted_he_data[0]);
2885 =for apidoc m|HV *|refcounted_he_chain_2hv|const struct refcounted_he *c|U32 flags
2887 Generates and returns a C<HV *> representing the content of a
2888 C<refcounted_he> chain.
2889 I<flags> is currently unused and must be zero.
2894 Perl_refcounted_he_chain_2hv(pTHX_ const struct refcounted_he *chain, U32 flags)
2898 U32 placeholders, max;
2901 Perl_croak(aTHX_ "panic: refcounted_he_chain_2hv bad flags %"UVxf,
2904 /* We could chase the chain once to get an idea of the number of keys,
2905 and call ksplit. But for now we'll make a potentially inefficient
2906 hash with only 8 entries in its array. */
2911 Newxz(array, PERL_HV_ARRAY_ALLOC_BYTES(max + 1), char);
2912 HvARRAY(hv) = (HE**)array;
2918 U32 hash = chain->refcounted_he_hash;
2920 U32 hash = HEK_HASH(chain->refcounted_he_hek);
2922 HE **oentry = &((HvARRAY(hv))[hash & max]);
2923 HE *entry = *oentry;
2926 for (; entry; entry = HeNEXT(entry)) {
2927 if (HeHASH(entry) == hash) {
2928 /* We might have a duplicate key here. If so, entry is older
2929 than the key we've already put in the hash, so if they are
2930 the same, skip adding entry. */
2932 const STRLEN klen = HeKLEN(entry);
2933 const char *const key = HeKEY(entry);
2934 if (klen == chain->refcounted_he_keylen
2935 && (!!HeKUTF8(entry)
2936 == !!(chain->refcounted_he_data[0] & HVhek_UTF8))
2937 && memEQ(key, REF_HE_KEY(chain), klen))
2940 if (HeKEY_hek(entry) == chain->refcounted_he_hek)
2942 if (HeKLEN(entry) == HEK_LEN(chain->refcounted_he_hek)
2943 && HeKUTF8(entry) == HEK_UTF8(chain->refcounted_he_hek)
2944 && memEQ(HeKEY(entry), HEK_KEY(chain->refcounted_he_hek),
2955 = share_hek_flags(REF_HE_KEY(chain),
2956 chain->refcounted_he_keylen,
2957 chain->refcounted_he_hash,
2958 (chain->refcounted_he_data[0]
2959 & (HVhek_UTF8|HVhek_WASUTF8)));
2961 HeKEY_hek(entry) = share_hek_hek(chain->refcounted_he_hek);
2963 value = refcounted_he_value(chain);
2964 if (value == &PL_sv_placeholder)
2966 HeVAL(entry) = value;
2968 /* Link it into the chain. */
2969 HeNEXT(entry) = *oentry;
2975 chain = chain->refcounted_he_next;
2979 clear_placeholders(hv, placeholders);
2980 HvTOTALKEYS(hv) -= placeholders;
2983 /* We could check in the loop to see if we encounter any keys with key
2984 flags, but it's probably not worth it, as this per-hash flag is only
2985 really meant as an optimisation for things like Storable. */
2987 DEBUG_A(Perl_hv_assert(aTHX_ hv));
2993 =for apidoc m|SV *|refcounted_he_fetch_pvn|const struct refcounted_he *chain|const char *keypv|STRLEN keylen|U32 hash|U32 flags
2995 Search along a C<refcounted_he> chain for an entry with the key specified
2996 by I<keypv> and I<keylen>. If I<flags> has the C<REFCOUNTED_HE_KEY_UTF8>
2997 bit set, the key octets are interpreted as UTF-8, otherwise they
2998 are interpreted as Latin-1. I<hash> is a precomputed hash of the key
2999 string, or zero if it has not been precomputed. Returns a mortal scalar
3000 representing the value associated with the key, or C<&PL_sv_placeholder>
3001 if there is no value associated with the key.
3007 Perl_refcounted_he_fetch_pvn(pTHX_ const struct refcounted_he *chain,
3008 const char *keypv, STRLEN keylen, U32 hash, U32 flags)
3012 PERL_ARGS_ASSERT_REFCOUNTED_HE_FETCH_PVN;
3014 if (flags & ~(REFCOUNTED_HE_KEY_UTF8|REFCOUNTED_HE_EXISTS))
3015 Perl_croak(aTHX_ "panic: refcounted_he_fetch_pvn bad flags %"UVxf,
3018 return &PL_sv_placeholder;
3019 if (flags & REFCOUNTED_HE_KEY_UTF8) {
3020 /* For searching purposes, canonicalise to Latin-1 where possible. */
3021 const char *keyend = keypv + keylen, *p;
3022 STRLEN nonascii_count = 0;
3023 for (p = keypv; p != keyend; p++) {
3026 if (!((c & 0xfe) == 0xc2 && ++p != keyend &&
3027 (((U8)*p) & 0xc0) == 0x80))
3028 goto canonicalised_key;
3032 if (nonascii_count) {
3034 const char *p = keypv, *keyend = keypv + keylen;
3035 keylen -= nonascii_count;
3036 Newx(q, keylen, char);
3039 for (; p != keyend; p++, q++) {
3042 ((c & 0x80) ? ((c & 0x03) << 6) | (((U8)*++p) & 0x3f) : c);
3045 flags &= ~REFCOUNTED_HE_KEY_UTF8;
3046 canonicalised_key: ;
3048 utf8_flag = (flags & REFCOUNTED_HE_KEY_UTF8) ? HVhek_UTF8 : 0;
3050 PERL_HASH(hash, keypv, keylen);
3052 for (; chain; chain = chain->refcounted_he_next) {
3055 hash == chain->refcounted_he_hash &&
3056 keylen == chain->refcounted_he_keylen &&
3057 memEQ(REF_HE_KEY(chain), keypv, keylen) &&
3058 utf8_flag == (chain->refcounted_he_data[0] & HVhek_UTF8)
3060 hash == HEK_HASH(chain->refcounted_he_hek) &&
3061 keylen == (STRLEN)HEK_LEN(chain->refcounted_he_hek) &&
3062 memEQ(HEK_KEY(chain->refcounted_he_hek), keypv, keylen) &&
3063 utf8_flag == (HEK_FLAGS(chain->refcounted_he_hek) & HVhek_UTF8)
3067 flags & REFCOUNTED_HE_EXISTS
3068 ? (chain->refcounted_he_data[0] & HVrhek_typemask)
3072 : sv_2mortal(refcounted_he_value(chain));
3074 return flags & REFCOUNTED_HE_EXISTS ? NULL : &PL_sv_placeholder;
3078 =for apidoc m|SV *|refcounted_he_fetch_pv|const struct refcounted_he *chain|const char *key|U32 hash|U32 flags
3080 Like L</refcounted_he_fetch_pvn>, but takes a nul-terminated string
3081 instead of a string/length pair.
3087 Perl_refcounted_he_fetch_pv(pTHX_ const struct refcounted_he *chain,
3088 const char *key, U32 hash, U32 flags)
3090 PERL_ARGS_ASSERT_REFCOUNTED_HE_FETCH_PV;
3091 return refcounted_he_fetch_pvn(chain, key, strlen(key), hash, flags);
3095 =for apidoc m|SV *|refcounted_he_fetch_sv|const struct refcounted_he *chain|SV *key|U32 hash|U32 flags
3097 Like L</refcounted_he_fetch_pvn>, but takes a Perl scalar instead of a
3104 Perl_refcounted_he_fetch_sv(pTHX_ const struct refcounted_he *chain,
3105 SV *key, U32 hash, U32 flags)
3109 PERL_ARGS_ASSERT_REFCOUNTED_HE_FETCH_SV;
3110 if (flags & REFCOUNTED_HE_KEY_UTF8)
3111 Perl_croak(aTHX_ "panic: refcounted_he_fetch_sv bad flags %"UVxf,
3113 keypv = SvPV_const(key, keylen);
3115 flags |= REFCOUNTED_HE_KEY_UTF8;
3116 if (!hash && SvIsCOW_shared_hash(key))
3117 hash = SvSHARED_HASH(key);
3118 return refcounted_he_fetch_pvn(chain, keypv, keylen, hash, flags);
3122 =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
3124 Creates a new C<refcounted_he>. This consists of a single key/value
3125 pair and a reference to an existing C<refcounted_he> chain (which may
3126 be empty), and thus forms a longer chain. When using the longer chain,
3127 the new key/value pair takes precedence over any entry for the same key
3128 further along the chain.
3130 The new key is specified by I<keypv> and I<keylen>. If I<flags> has
3131 the C<REFCOUNTED_HE_KEY_UTF8> bit set, the key octets are interpreted
3132 as UTF-8, otherwise they are interpreted as Latin-1. I<hash> is
3133 a precomputed hash of the key string, or zero if it has not been
3136 I<value> is the scalar value to store for this key. I<value> is copied
3137 by this function, which thus does not take ownership of any reference
3138 to it, and later changes to the scalar will not be reflected in the
3139 value visible in the C<refcounted_he>. Complex types of scalar will not
3140 be stored with referential integrity, but will be coerced to strings.
3141 I<value> may be either null or C<&PL_sv_placeholder> to indicate that no
3142 value is to be associated with the key; this, as with any non-null value,
3143 takes precedence over the existence of a value for the key further along
3146 I<parent> points to the rest of the C<refcounted_he> chain to be
3147 attached to the new C<refcounted_he>. This function takes ownership
3148 of one reference to I<parent>, and returns one reference to the new
3154 struct refcounted_he *
3155 Perl_refcounted_he_new_pvn(pTHX_ struct refcounted_he *parent,
3156 const char *keypv, STRLEN keylen, U32 hash, SV *value, U32 flags)
3159 STRLEN value_len = 0;
3160 const char *value_p = NULL;
3164 STRLEN key_offset = 1;
3165 struct refcounted_he *he;
3166 PERL_ARGS_ASSERT_REFCOUNTED_HE_NEW_PVN;
3168 if (!value || value == &PL_sv_placeholder) {
3169 value_type = HVrhek_delete;
3170 } else if (SvPOK(value)) {
3171 value_type = HVrhek_PV;
3172 } else if (SvIOK(value)) {
3173 value_type = SvUOK((const SV *)value) ? HVrhek_UV : HVrhek_IV;
3174 } else if (!SvOK(value)) {
3175 value_type = HVrhek_undef;
3177 value_type = HVrhek_PV;
3179 is_pv = value_type == HVrhek_PV;
3181 /* Do it this way so that the SvUTF8() test is after the SvPV, in case
3182 the value is overloaded, and doesn't yet have the UTF-8flag set. */
3183 value_p = SvPV_const(value, value_len);
3185 value_type = HVrhek_PV_UTF8;
3186 key_offset = value_len + 2;
3188 hekflags = value_type;
3190 if (flags & REFCOUNTED_HE_KEY_UTF8) {
3191 /* Canonicalise to Latin-1 where possible. */
3192 const char *keyend = keypv + keylen, *p;
3193 STRLEN nonascii_count = 0;
3194 for (p = keypv; p != keyend; p++) {
3197 if (!((c & 0xfe) == 0xc2 && ++p != keyend &&
3198 (((U8)*p) & 0xc0) == 0x80))
3199 goto canonicalised_key;
3203 if (nonascii_count) {
3205 const char *p = keypv, *keyend = keypv + keylen;
3206 keylen -= nonascii_count;
3207 Newx(q, keylen, char);
3210 for (; p != keyend; p++, q++) {
3213 ((c & 0x80) ? ((c & 0x03) << 6) | (((U8)*++p) & 0x3f) : c);
3216 flags &= ~REFCOUNTED_HE_KEY_UTF8;
3217 canonicalised_key: ;
3219 if (flags & REFCOUNTED_HE_KEY_UTF8)
3220 hekflags |= HVhek_UTF8;
3222 PERL_HASH(hash, keypv, keylen);
3225 he = (struct refcounted_he*)
3226 PerlMemShared_malloc(sizeof(struct refcounted_he) - 1
3230 he = (struct refcounted_he*)
3231 PerlMemShared_malloc(sizeof(struct refcounted_he) - 1
3235 he->refcounted_he_next = parent;
3238 Copy(value_p, he->refcounted_he_data + 1, value_len + 1, char);
3239 he->refcounted_he_val.refcounted_he_u_len = value_len;
3240 } else if (value_type == HVrhek_IV) {
3241 he->refcounted_he_val.refcounted_he_u_iv = SvIVX(value);
3242 } else if (value_type == HVrhek_UV) {
3243 he->refcounted_he_val.refcounted_he_u_uv = SvUVX(value);
3247 he->refcounted_he_hash = hash;
3248 he->refcounted_he_keylen = keylen;
3249 Copy(keypv, he->refcounted_he_data + key_offset, keylen, char);
3251 he->refcounted_he_hek = share_hek_flags(keypv, keylen, hash, hekflags);
3254 he->refcounted_he_data[0] = hekflags;
3255 he->refcounted_he_refcnt = 1;
3261 =for apidoc m|struct refcounted_he *|refcounted_he_new_pv|struct refcounted_he *parent|const char *key|U32 hash|SV *value|U32 flags
3263 Like L</refcounted_he_new_pvn>, but takes a nul-terminated string instead
3264 of a string/length pair.
3269 struct refcounted_he *
3270 Perl_refcounted_he_new_pv(pTHX_ struct refcounted_he *parent,
3271 const char *key, U32 hash, SV *value, U32 flags)
3273 PERL_ARGS_ASSERT_REFCOUNTED_HE_NEW_PV;
3274 return refcounted_he_new_pvn(parent, key, strlen(key), hash, value, flags);
3278 =for apidoc m|struct refcounted_he *|refcounted_he_new_sv|struct refcounted_he *parent|SV *key|U32 hash|SV *value|U32 flags
3280 Like L</refcounted_he_new_pvn>, but takes a Perl scalar instead of a
3286 struct refcounted_he *
3287 Perl_refcounted_he_new_sv(pTHX_ struct refcounted_he *parent,
3288 SV *key, U32 hash, SV *value, U32 flags)
3292 PERL_ARGS_ASSERT_REFCOUNTED_HE_NEW_SV;
3293 if (flags & REFCOUNTED_HE_KEY_UTF8)
3294 Perl_croak(aTHX_ "panic: refcounted_he_new_sv bad flags %"UVxf,
3296 keypv = SvPV_const(key, keylen);
3298 flags |= REFCOUNTED_HE_KEY_UTF8;
3299 if (!hash && SvIsCOW_shared_hash(key))
3300 hash = SvSHARED_HASH(key);
3301 return refcounted_he_new_pvn(parent, keypv, keylen, hash, value, flags);
3305 =for apidoc m|void|refcounted_he_free|struct refcounted_he *he
3307 Decrements the reference count of a C<refcounted_he> by one. If the
3308 reference count reaches zero the structure's memory is freed, which
3309 (recursively) causes a reduction of its parent C<refcounted_he>'s
3310 reference count. It is safe to pass a null pointer to this function:
3311 no action occurs in this case.
3317 Perl_refcounted_he_free(pTHX_ struct refcounted_he *he) {
3319 PERL_UNUSED_CONTEXT;
3322 struct refcounted_he *copy;
3326 new_count = --he->refcounted_he_refcnt;
3327 HINTS_REFCNT_UNLOCK;
3333 #ifndef USE_ITHREADS
3334 unshare_hek_or_pvn (he->refcounted_he_hek, 0, 0, 0);
3337 he = he->refcounted_he_next;
3338 PerlMemShared_free(copy);
3343 =for apidoc m|struct refcounted_he *|refcounted_he_inc|struct refcounted_he *he
3345 Increment the reference count of a C<refcounted_he>. The pointer to the
3346 C<refcounted_he> is also returned. It is safe to pass a null pointer
3347 to this function: no action occurs and a null pointer is returned.
3352 struct refcounted_he *
3353 Perl_refcounted_he_inc(pTHX_ struct refcounted_he *he)
3358 he->refcounted_he_refcnt++;
3359 HINTS_REFCNT_UNLOCK;
3365 =for apidoc cop_fetch_label
3367 Returns the label attached to a cop.
3368 The flags pointer may be set to C<SVf_UTF8> or 0.
3373 /* pp_entereval is aware that labels are stored with a key ':' at the top of
3376 Perl_cop_fetch_label(pTHX_ COP *const cop, STRLEN *len, U32 *flags) {
3377 struct refcounted_he *const chain = cop->cop_hints_hash;
3379 PERL_ARGS_ASSERT_COP_FETCH_LABEL;
3384 if (chain->refcounted_he_keylen != 1)
3386 if (*REF_HE_KEY(chain) != ':')
3389 if ((STRLEN)HEK_LEN(chain->refcounted_he_hek) != 1)
3391 if (*HEK_KEY(chain->refcounted_he_hek) != ':')
3394 /* Stop anyone trying to really mess us up by adding their own value for
3396 if ((chain->refcounted_he_data[0] & HVrhek_typemask) != HVrhek_PV
3397 && (chain->refcounted_he_data[0] & HVrhek_typemask) != HVrhek_PV_UTF8)
3401 *len = chain->refcounted_he_val.refcounted_he_u_len;
3403 *flags = ((chain->refcounted_he_data[0] & HVrhek_typemask)
3404 == HVrhek_PV_UTF8) ? SVf_UTF8 : 0;
3406 return chain->refcounted_he_data + 1;
3410 =for apidoc cop_store_label
3412 Save a label into a C<cop_hints_hash>. You need to set flags to C<SVf_UTF8>
3419 Perl_cop_store_label(pTHX_ COP *const cop, const char *label, STRLEN len,
3423 PERL_ARGS_ASSERT_COP_STORE_LABEL;
3425 if (flags & ~(SVf_UTF8))
3426 Perl_croak(aTHX_ "panic: cop_store_label illegal flag bits 0x%" UVxf,
3428 labelsv = newSVpvn_flags(label, len, SVs_TEMP);
3429 if (flags & SVf_UTF8)
3432 = refcounted_he_new_pvs(cop->cop_hints_hash, ":", labelsv, 0);
3436 =for apidoc hv_assert
3438 Check that a hash is in an internally consistent state.
3446 Perl_hv_assert(pTHX_ HV *hv)
3451 int placeholders = 0;
3454 const I32 riter = HvRITER_get(hv);
3455 HE *eiter = HvEITER_get(hv);
3457 PERL_ARGS_ASSERT_HV_ASSERT;
3459 (void)hv_iterinit(hv);
3461 while ((entry = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS))) {
3462 /* sanity check the values */
3463 if (HeVAL(entry) == &PL_sv_placeholder)
3467 /* sanity check the keys */
3468 if (HeSVKEY(entry)) {
3469 NOOP; /* Don't know what to check on SV keys. */
3470 } else if (HeKUTF8(entry)) {
3472 if (HeKWASUTF8(entry)) {
3473 PerlIO_printf(Perl_debug_log,
3474 "hash key has both WASUTF8 and UTF8: '%.*s'\n",
3475 (int) HeKLEN(entry), HeKEY(entry));
3478 } else if (HeKWASUTF8(entry))
3481 if (!SvTIED_mg((const SV *)hv, PERL_MAGIC_tied)) {
3482 static const char bad_count[] = "Count %d %s(s), but hash reports %d\n";
3483 const int nhashkeys = HvUSEDKEYS(hv);
3484 const int nhashplaceholders = HvPLACEHOLDERS_get(hv);
3486 if (nhashkeys != real) {
3487 PerlIO_printf(Perl_debug_log, bad_count, real, "keys", nhashkeys );
3490 if (nhashplaceholders != placeholders) {
3491 PerlIO_printf(Perl_debug_log, bad_count, placeholders, "placeholder", nhashplaceholders );
3495 if (withflags && ! HvHASKFLAGS(hv)) {
3496 PerlIO_printf(Perl_debug_log,
3497 "Hash has HASKFLAGS off but I count %d key(s) with flags\n",
3502 sv_dump(MUTABLE_SV(hv));
3504 HvRITER_set(hv, riter); /* Restore hash iterator state */
3505 HvEITER_set(hv, eiter);
3512 * c-indentation-style: bsd
3514 * indent-tabs-mode: t
3517 * ex: set ts=8 sts=4 sw=4 noet: