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 C<klen> is
221 the length of the key. The C<hash> parameter is the precomputed hash
222 value; if it is zero then Perl will compute it. The return value will be
223 NULL if the operation failed or if the value did not need to be actually
224 stored within the hash (as in the case of tied hashes). Otherwise it can
225 be dereferenced to get the original C<SV*>. Note that the caller is
226 responsible for suitably incrementing the reference count of C<val> before
227 the call, and decrementing it if the function returned NULL. Effectively
228 a successful hv_store takes ownership of one reference to C<val>. This is
229 usually what you want; a newly created SV has a reference count of one, so
230 if all your code does is create SVs then store them in a hash, hv_store
231 will own the only reference to the new SV, and your code doesn't need to do
232 anything further to tidy up. hv_store is not implemented as a call to
233 hv_store_ent, and does not create a temporary SV for the key, so if your
234 key data is not already in SV form then use hv_store in preference to
237 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
238 information on how to use this function on tied hashes.
240 =for apidoc hv_store_ent
242 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
243 parameter is the precomputed hash value; if it is zero then Perl will
244 compute it. The return value is the new hash entry so created. It will be
245 NULL if the operation failed or if the value did not need to be actually
246 stored within the hash (as in the case of tied hashes). Otherwise the
247 contents of the return value can be accessed using the C<He?> macros
248 described here. Note that the caller is responsible for suitably
249 incrementing the reference count of C<val> before the call, and
250 decrementing it if the function returned NULL. Effectively a successful
251 hv_store_ent takes ownership of one reference to C<val>. This is
252 usually what you want; a newly created SV has a reference count of one, so
253 if all your code does is create SVs then store them in a hash, hv_store
254 will own the only reference to the new SV, and your code doesn't need to do
255 anything further to tidy up. Note that hv_store_ent only reads the C<key>;
256 unlike C<val> it does not take ownership of it, so maintaining the correct
257 reference count on C<key> is entirely the caller's responsibility. hv_store
258 is not implemented as a call to hv_store_ent, and does not create a temporary
259 SV for the key, so if your key data is not already in SV form then use
260 hv_store in preference to hv_store_ent.
262 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
263 information on how to use this function on tied hashes.
265 =for apidoc hv_exists
267 Returns a boolean indicating whether the specified hash key exists. The
268 C<klen> is the length of the key.
272 Returns the SV which corresponds to the specified key in the hash. The
273 C<klen> is the length of the key. If C<lval> is set then the fetch will be
274 part of a store. Check that the return value is non-null before
275 dereferencing it to an C<SV*>.
277 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
278 information on how to use this function on tied hashes.
280 =for apidoc hv_exists_ent
282 Returns a boolean indicating whether the specified hash key exists. C<hash>
283 can be a valid precomputed hash value, or 0 to ask for it to be
289 /* returns an HE * structure with the all fields set */
290 /* note that hent_val will be a mortal sv for MAGICAL hashes */
292 =for apidoc hv_fetch_ent
294 Returns the hash entry which corresponds to the specified key in the hash.
295 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
296 if you want the function to compute it. IF C<lval> is set then the fetch
297 will be part of a store. Make sure the return value is non-null before
298 accessing it. The return value when C<hv> is a tied hash is a pointer to a
299 static location, so be sure to make a copy of the structure if you need to
302 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
303 information on how to use this function on tied hashes.
308 /* Common code for hv_delete()/hv_exists()/hv_fetch()/hv_store() */
310 Perl_hv_common_key_len(pTHX_ HV *hv, const char *key, I32 klen_i32,
311 const int action, SV *val, const U32 hash)
316 PERL_ARGS_ASSERT_HV_COMMON_KEY_LEN;
325 return hv_common(hv, NULL, key, klen, flags, action, val, hash);
329 Perl_hv_common(pTHX_ HV *hv, SV *keysv, const char *key, STRLEN klen,
330 int flags, int action, SV *val, register U32 hash)
339 const int return_svp = action & HV_FETCH_JUST_SV;
343 if (SvTYPE(hv) == SVTYPEMASK)
346 assert(SvTYPE(hv) == SVt_PVHV);
348 if (SvSMAGICAL(hv) && SvGMAGICAL(hv) && !(action & HV_DISABLE_UVAR_XKEY)) {
350 if ((mg = mg_find((const SV *)hv, PERL_MAGIC_uvar))) {
351 struct ufuncs * const uf = (struct ufuncs *)mg->mg_ptr;
352 if (uf->uf_set == NULL) {
353 SV* obj = mg->mg_obj;
356 keysv = newSVpvn_flags(key, klen, SVs_TEMP |
357 ((flags & HVhek_UTF8)
361 mg->mg_obj = keysv; /* pass key */
362 uf->uf_index = action; /* pass action */
363 magic_getuvar(MUTABLE_SV(hv), mg);
364 keysv = mg->mg_obj; /* may have changed */
367 /* If the key may have changed, then we need to invalidate
368 any passed-in computed hash value. */
374 if (flags & HVhek_FREEKEY)
376 key = SvPV_const(keysv, klen);
377 is_utf8 = (SvUTF8(keysv) != 0);
378 if (SvIsCOW_shared_hash(keysv)) {
379 flags = HVhek_KEYCANONICAL | (is_utf8 ? HVhek_UTF8 : 0);
384 is_utf8 = ((flags & HVhek_UTF8) ? TRUE : FALSE);
387 if (action & HV_DELETE) {
388 return (void *) hv_delete_common(hv, keysv, key, klen,
389 flags | (is_utf8 ? HVhek_UTF8 : 0),
393 xhv = (XPVHV*)SvANY(hv);
395 if (SvRMAGICAL(hv) && !(action & (HV_FETCH_ISSTORE|HV_FETCH_ISEXISTS))) {
396 if (mg_find((const SV *)hv, PERL_MAGIC_tied)
397 || SvGMAGICAL((const SV *)hv))
399 /* FIXME should be able to skimp on the HE/HEK here when
400 HV_FETCH_JUST_SV is true. */
402 keysv = newSVpvn_utf8(key, klen, is_utf8);
404 keysv = newSVsv(keysv);
407 mg_copy(MUTABLE_SV(hv), sv, (char *)keysv, HEf_SVKEY);
409 /* grab a fake HE/HEK pair from the pool or make a new one */
410 entry = PL_hv_fetch_ent_mh;
412 PL_hv_fetch_ent_mh = HeNEXT(entry);
416 Newx(k, HEK_BASESIZE + sizeof(const SV *), char);
417 HeKEY_hek(entry) = (HEK*)k;
419 HeNEXT(entry) = NULL;
420 HeSVKEY_set(entry, keysv);
422 sv_upgrade(sv, SVt_PVLV);
424 /* so we can free entry when freeing sv */
425 LvTARG(sv) = MUTABLE_SV(entry);
427 /* XXX remove at some point? */
428 if (flags & HVhek_FREEKEY)
432 return entry ? (void *) &HeVAL(entry) : NULL;
434 return (void *) entry;
436 #ifdef ENV_IS_CASELESS
437 else if (mg_find((const SV *)hv, PERL_MAGIC_env)) {
439 for (i = 0; i < klen; ++i)
440 if (isLOWER(key[i])) {
441 /* Would be nice if we had a routine to do the
442 copy and upercase in a single pass through. */
443 const char * const nkey = strupr(savepvn(key,klen));
444 /* Note that this fetch is for nkey (the uppercased
445 key) whereas the store is for key (the original) */
446 void *result = hv_common(hv, NULL, nkey, klen,
447 HVhek_FREEKEY, /* free nkey */
448 0 /* non-LVAL fetch */
449 | HV_DISABLE_UVAR_XKEY
452 0 /* compute hash */);
453 if (!result && (action & HV_FETCH_LVALUE)) {
454 /* This call will free key if necessary.
455 Do it this way to encourage compiler to tail
457 result = hv_common(hv, keysv, key, klen, flags,
459 | HV_DISABLE_UVAR_XKEY
463 if (flags & HVhek_FREEKEY)
471 else if (SvRMAGICAL(hv) && (action & HV_FETCH_ISEXISTS)) {
472 if (mg_find((const SV *)hv, PERL_MAGIC_tied)
473 || SvGMAGICAL((const SV *)hv)) {
474 /* I don't understand why hv_exists_ent has svret and sv,
475 whereas hv_exists only had one. */
476 SV * const svret = sv_newmortal();
479 if (keysv || is_utf8) {
481 keysv = newSVpvn_utf8(key, klen, TRUE);
483 keysv = newSVsv(keysv);
485 mg_copy(MUTABLE_SV(hv), sv, (char *)sv_2mortal(keysv), HEf_SVKEY);
487 mg_copy(MUTABLE_SV(hv), sv, key, klen);
489 if (flags & HVhek_FREEKEY)
491 magic_existspack(svret, mg_find(sv, PERL_MAGIC_tiedelem));
492 /* This cast somewhat evil, but I'm merely using NULL/
493 not NULL to return the boolean exists.
494 And I know hv is not NULL. */
495 return SvTRUE(svret) ? (void *)hv : NULL;
497 #ifdef ENV_IS_CASELESS
498 else if (mg_find((const SV *)hv, PERL_MAGIC_env)) {
499 /* XXX This code isn't UTF8 clean. */
500 char * const keysave = (char * const)key;
501 /* Will need to free this, so set FREEKEY flag. */
502 key = savepvn(key,klen);
503 key = (const char*)strupr((char*)key);
508 if (flags & HVhek_FREEKEY) {
511 flags |= HVhek_FREEKEY;
515 else if (action & HV_FETCH_ISSTORE) {
518 hv_magic_check (hv, &needs_copy, &needs_store);
520 const bool save_taint = PL_tainted;
521 if (keysv || is_utf8) {
523 keysv = newSVpvn_utf8(key, klen, TRUE);
526 PL_tainted = SvTAINTED(keysv);
527 keysv = sv_2mortal(newSVsv(keysv));
528 mg_copy(MUTABLE_SV(hv), val, (char*)keysv, HEf_SVKEY);
530 mg_copy(MUTABLE_SV(hv), val, key, klen);
533 TAINT_IF(save_taint);
535 if (flags & HVhek_FREEKEY)
539 #ifdef ENV_IS_CASELESS
540 else if (mg_find((const SV *)hv, PERL_MAGIC_env)) {
541 /* XXX This code isn't UTF8 clean. */
542 const char *keysave = key;
543 /* Will need to free this, so set FREEKEY flag. */
544 key = savepvn(key,klen);
545 key = (const char*)strupr((char*)key);
550 if (flags & HVhek_FREEKEY) {
553 flags |= HVhek_FREEKEY;
561 if ((action & (HV_FETCH_LVALUE | HV_FETCH_ISSTORE))
562 #ifdef DYNAMIC_ENV_FETCH /* if it's an %ENV lookup, we may get it on the fly */
563 || (SvRMAGICAL((const SV *)hv)
564 && mg_find((const SV *)hv, PERL_MAGIC_env))
569 PERL_HV_ARRAY_ALLOC_BYTES(xhv->xhv_max+1 /* HvMAX(hv)+1 */),
571 HvARRAY(hv) = (HE**)array;
573 #ifdef DYNAMIC_ENV_FETCH
574 else if (action & HV_FETCH_ISEXISTS) {
575 /* for an %ENV exists, if we do an insert it's by a recursive
576 store call, so avoid creating HvARRAY(hv) right now. */
580 /* XXX remove at some point? */
581 if (flags & HVhek_FREEKEY)
588 if (is_utf8 & !(flags & HVhek_KEYCANONICAL)) {
589 char * const keysave = (char *)key;
590 key = (char*)bytes_from_utf8((U8*)key, &klen, &is_utf8);
594 flags &= ~HVhek_UTF8;
595 if (key != keysave) {
596 if (flags & HVhek_FREEKEY)
598 flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
599 /* If the caller calculated a hash, it was on the sequence of
600 octets that are the UTF-8 form. We've now changed the sequence
601 of octets stored to that of the equivalent byte representation,
602 so the hash we need is different. */
607 if (HvREHASH(hv) || (!hash && !(keysv && (SvIsCOW_shared_hash(keysv)))))
608 PERL_HASH_INTERNAL_(hash, key, klen, HvREHASH(hv));
610 hash = SvSHARED_HASH(keysv);
612 /* We don't have a pointer to the hv, so we have to replicate the
613 flag into every HEK, so that hv_iterkeysv can see it.
614 And yes, you do need this even though you are not "storing" because
615 you can flip the flags below if doing an lval lookup. (And that
616 was put in to give the semantics Andreas was expecting.) */
618 flags |= HVhek_REHASH;
620 masked_flags = (flags & HVhek_MASK);
622 #ifdef DYNAMIC_ENV_FETCH
623 if (!HvARRAY(hv)) entry = NULL;
627 entry = (HvARRAY(hv))[hash & (I32) HvMAX(hv)];
629 for (; entry; entry = HeNEXT(entry)) {
630 if (HeHASH(entry) != hash) /* strings can't be equal */
632 if (HeKLEN(entry) != (I32)klen)
634 if (HeKEY(entry) != key && memNE(HeKEY(entry),key,klen)) /* is this it? */
636 if ((HeKFLAGS(entry) ^ masked_flags) & HVhek_UTF8)
639 if (action & (HV_FETCH_LVALUE|HV_FETCH_ISSTORE)) {
640 if (HeKFLAGS(entry) != masked_flags) {
641 /* We match if HVhek_UTF8 bit in our flags and hash key's
642 match. But if entry was set previously with HVhek_WASUTF8
643 and key now doesn't (or vice versa) then we should change
644 the key's flag, as this is assignment. */
645 if (HvSHAREKEYS(hv)) {
646 /* Need to swap the key we have for a key with the flags we
647 need. As keys are shared we can't just write to the
648 flag, so we share the new one, unshare the old one. */
649 HEK * const new_hek = share_hek_flags(key, klen, hash,
651 unshare_hek (HeKEY_hek(entry));
652 HeKEY_hek(entry) = new_hek;
654 else if (hv == PL_strtab) {
655 /* PL_strtab is usually the only hash without HvSHAREKEYS,
656 so putting this test here is cheap */
657 if (flags & HVhek_FREEKEY)
659 Perl_croak(aTHX_ S_strtab_error,
660 action & HV_FETCH_LVALUE ? "fetch" : "store");
663 HeKFLAGS(entry) = masked_flags;
664 if (masked_flags & HVhek_ENABLEHVKFLAGS)
667 if (HeVAL(entry) == &PL_sv_placeholder) {
668 /* yes, can store into placeholder slot */
669 if (action & HV_FETCH_LVALUE) {
671 /* This preserves behaviour with the old hv_fetch
672 implementation which at this point would bail out
673 with a break; (at "if we find a placeholder, we
674 pretend we haven't found anything")
676 That break mean that if a placeholder were found, it
677 caused a call into hv_store, which in turn would
678 check magic, and if there is no magic end up pretty
679 much back at this point (in hv_store's code). */
682 /* LVAL fetch which actually needs a store. */
684 HvPLACEHOLDERS(hv)--;
687 if (val != &PL_sv_placeholder)
688 HvPLACEHOLDERS(hv)--;
691 } else if (action & HV_FETCH_ISSTORE) {
692 SvREFCNT_dec(HeVAL(entry));
695 } else if (HeVAL(entry) == &PL_sv_placeholder) {
696 /* if we find a placeholder, we pretend we haven't found
700 if (flags & HVhek_FREEKEY)
703 return entry ? (void *) &HeVAL(entry) : NULL;
707 #ifdef DYNAMIC_ENV_FETCH /* %ENV lookup? If so, try to fetch the value now */
708 if (!(action & HV_FETCH_ISSTORE)
709 && SvRMAGICAL((const SV *)hv)
710 && mg_find((const SV *)hv, PERL_MAGIC_env)) {
712 const char * const env = PerlEnv_ENVgetenv_len(key,&len);
714 sv = newSVpvn(env,len);
716 return hv_common(hv, keysv, key, klen, flags,
717 HV_FETCH_ISSTORE|HV_DISABLE_UVAR_XKEY|return_svp,
723 if (!entry && SvREADONLY(hv) && !(action & HV_FETCH_ISEXISTS)) {
724 hv_notallowed(flags, key, klen,
725 "Attempt to access disallowed key '%"SVf"' in"
726 " a restricted hash");
728 if (!(action & (HV_FETCH_LVALUE|HV_FETCH_ISSTORE))) {
729 /* Not doing some form of store, so return failure. */
730 if (flags & HVhek_FREEKEY)
734 if (action & HV_FETCH_LVALUE) {
735 val = action & HV_FETCH_EMPTY_HE ? NULL : newSV(0);
737 /* At this point the old hv_fetch code would call to hv_store,
738 which in turn might do some tied magic. So we need to make that
739 magic check happen. */
740 /* gonna assign to this, so it better be there */
741 /* If a fetch-as-store fails on the fetch, then the action is to
742 recurse once into "hv_store". If we didn't do this, then that
743 recursive call would call the key conversion routine again.
744 However, as we replace the original key with the converted
745 key, this would result in a double conversion, which would show
746 up as a bug if the conversion routine is not idempotent. */
747 return hv_common(hv, keysv, key, klen, flags,
748 HV_FETCH_ISSTORE|HV_DISABLE_UVAR_XKEY|return_svp,
750 /* XXX Surely that could leak if the fetch-was-store fails?
751 Just like the hv_fetch. */
755 /* Welcome to hv_store... */
758 /* Not sure if we can get here. I think the only case of oentry being
759 NULL is for %ENV with dynamic env fetch. But that should disappear
760 with magic in the previous code. */
763 PERL_HV_ARRAY_ALLOC_BYTES(xhv->xhv_max+1 /* HvMAX(hv)+1 */),
765 HvARRAY(hv) = (HE**)array;
768 oentry = &(HvARRAY(hv))[hash & (I32) xhv->xhv_max];
771 /* share_hek_flags will do the free for us. This might be considered
774 HeKEY_hek(entry) = share_hek_flags(key, klen, hash, flags);
775 else if (hv == PL_strtab) {
776 /* PL_strtab is usually the only hash without HvSHAREKEYS, so putting
777 this test here is cheap */
778 if (flags & HVhek_FREEKEY)
780 Perl_croak(aTHX_ S_strtab_error,
781 action & HV_FETCH_LVALUE ? "fetch" : "store");
783 else /* gotta do the real thing */
784 HeKEY_hek(entry) = save_hek_flags(key, klen, hash, flags);
786 HeNEXT(entry) = *oentry;
789 if (val == &PL_sv_placeholder)
790 HvPLACEHOLDERS(hv)++;
791 if (masked_flags & HVhek_ENABLEHVKFLAGS)
795 const HE *counter = HeNEXT(entry);
797 xhv->xhv_keys++; /* HvTOTALKEYS(hv)++ */
798 if (!counter) { /* initial entry? */
799 } else if (xhv->xhv_keys > xhv->xhv_max) {
800 /* Use only the old HvUSEDKEYS(hv) > HvMAX(hv) condition to limit
801 bucket splits on a rehashed hash, as we're not going to
802 split it again, and if someone is lucky (evil) enough to
803 get all the keys in one list they could exhaust our memory
804 as we repeatedly double the number of buckets on every
805 entry. Linear search feels a less worse thing to do. */
807 } else if(!HvREHASH(hv)) {
810 while ((counter = HeNEXT(counter)))
813 if (n_links > HV_MAX_LENGTH_BEFORE_SPLIT) {
820 return entry ? (void *) &HeVAL(entry) : NULL;
822 return (void *) entry;
826 S_hv_magic_check(HV *hv, bool *needs_copy, bool *needs_store)
828 const MAGIC *mg = SvMAGIC(hv);
830 PERL_ARGS_ASSERT_HV_MAGIC_CHECK;
835 if (isUPPER(mg->mg_type)) {
837 if (mg->mg_type == PERL_MAGIC_tied) {
838 *needs_store = FALSE;
839 return; /* We've set all there is to set. */
842 mg = mg->mg_moremagic;
847 =for apidoc hv_scalar
849 Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
855 Perl_hv_scalar(pTHX_ HV *hv)
859 PERL_ARGS_ASSERT_HV_SCALAR;
861 if (SvRMAGICAL(hv)) {
862 MAGIC * const mg = mg_find((const SV *)hv, PERL_MAGIC_tied);
864 return magic_scalarpack(hv, mg);
868 if (HvTOTALKEYS((const HV *)hv))
869 Perl_sv_setpvf(aTHX_ sv, "%ld/%ld",
870 (long)HvFILL(hv), (long)HvMAX(hv) + 1);
878 =for apidoc hv_delete
880 Deletes a key/value pair in the hash. The value's SV is removed from the
881 hash, made mortal, and returned to the caller. The C<klen> is the length of
882 the key. The C<flags> value will normally be zero; if set to G_DISCARD then
883 NULL will be returned. NULL will also be returned if the key is not found.
885 =for apidoc hv_delete_ent
887 Deletes a key/value pair in the hash. The value SV is removed from the hash,
888 made mortal, and returned to the caller. The C<flags> value will normally be
889 zero; if set to G_DISCARD then NULL will be returned. NULL will also be
890 returned if the key is not found. C<hash> can be a valid precomputed hash
891 value, or 0 to ask for it to be computed.
897 S_hv_delete_common(pTHX_ HV *hv, SV *keysv, const char *key, STRLEN klen,
898 int k_flags, I32 d_flags, U32 hash)
903 register HE **oentry;
904 bool is_utf8 = (k_flags & HVhek_UTF8) ? TRUE : FALSE;
907 if (SvRMAGICAL(hv)) {
910 hv_magic_check (hv, &needs_copy, &needs_store);
914 entry = (HE *) hv_common(hv, keysv, key, klen,
915 k_flags & ~HVhek_FREEKEY,
916 HV_FETCH_LVALUE|HV_DISABLE_UVAR_XKEY,
918 sv = entry ? HeVAL(entry) : NULL;
924 if (mg_find(sv, PERL_MAGIC_tiedelem)) {
925 /* No longer an element */
926 sv_unmagic(sv, PERL_MAGIC_tiedelem);
929 return NULL; /* element cannot be deleted */
931 #ifdef ENV_IS_CASELESS
932 else if (mg_find((const SV *)hv, PERL_MAGIC_env)) {
933 /* XXX This code isn't UTF8 clean. */
934 keysv = newSVpvn_flags(key, klen, SVs_TEMP);
935 if (k_flags & HVhek_FREEKEY) {
938 key = strupr(SvPVX(keysv));
947 xhv = (XPVHV*)SvANY(hv);
952 const char * const keysave = key;
953 key = (char*)bytes_from_utf8((U8*)key, &klen, &is_utf8);
956 k_flags |= HVhek_UTF8;
958 k_flags &= ~HVhek_UTF8;
959 if (key != keysave) {
960 if (k_flags & HVhek_FREEKEY) {
961 /* This shouldn't happen if our caller does what we expect,
962 but strictly the API allows it. */
965 k_flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
967 HvHASKFLAGS_on(MUTABLE_SV(hv));
970 if (HvREHASH(hv) || (!hash && !(keysv && (SvIsCOW_shared_hash(keysv)))))
971 PERL_HASH_INTERNAL_(hash, key, klen, HvREHASH(hv));
973 hash = SvSHARED_HASH(keysv);
975 masked_flags = (k_flags & HVhek_MASK);
977 oentry = &(HvARRAY(hv))[hash & (I32) HvMAX(hv)];
979 for (; entry; oentry = &HeNEXT(entry), entry = *oentry) {
981 U8 mro_changes = 0; /* 1 = isa; 2 = package moved */
985 if (HeHASH(entry) != hash) /* strings can't be equal */
987 if (HeKLEN(entry) != (I32)klen)
989 if (HeKEY(entry) != key && memNE(HeKEY(entry),key,klen)) /* is this it? */
991 if ((HeKFLAGS(entry) ^ masked_flags) & HVhek_UTF8)
994 if (hv == PL_strtab) {
995 if (k_flags & HVhek_FREEKEY)
997 Perl_croak(aTHX_ S_strtab_error, "delete");
1000 /* if placeholder is here, it's already been deleted.... */
1001 if (HeVAL(entry) == &PL_sv_placeholder) {
1002 if (k_flags & HVhek_FREEKEY)
1006 if (SvREADONLY(hv) && HeVAL(entry) && SvREADONLY(HeVAL(entry))
1007 && !SvIsCOW(HeVAL(entry))) {
1008 hv_notallowed(k_flags, key, klen,
1009 "Attempt to delete readonly key '%"SVf"' from"
1010 " a restricted hash");
1012 if (k_flags & HVhek_FREEKEY)
1015 /* If this is a stash and the key ends with ::, then someone is
1016 * deleting a package.
1018 if (HeVAL(entry) && HvENAME_get(hv)) {
1019 gv = (GV *)HeVAL(entry);
1020 if (keysv) key = SvPV(keysv, klen);
1022 (klen > 1 && key[klen-2] == ':' && key[klen-1] == ':')
1024 (klen == 1 && key[0] == ':')
1026 && (klen != 6 || hv!=PL_defstash || memNE(key,"main::",6))
1027 && SvTYPE(gv) == SVt_PVGV && (stash = GvHV((GV *)gv))
1028 && HvENAME_get(stash)) {
1029 /* A previous version of this code checked that the
1030 * GV was still in the symbol table by fetching the
1031 * GV with its name. That is not necessary (and
1032 * sometimes incorrect), as HvENAME cannot be set
1033 * on hv if it is not in the symtab. */
1035 /* Hang on to it for a bit. */
1036 SvREFCNT_inc_simple_void_NN(
1037 sv_2mortal((SV *)gv)
1040 else if (klen == 3 && strnEQ(key, "ISA", 3))
1044 if (d_flags & G_DISCARD) {
1047 /* deletion of method from stash */
1048 if (isGV(sv) && isGV_with_GP(sv) && GvCVu(sv)
1050 mro_method_changed_in(hv);
1054 } else sv = sv_2mortal(HeVAL(entry));
1055 HeVAL(entry) = &PL_sv_placeholder;
1058 * If a restricted hash, rather than really deleting the entry, put
1059 * a placeholder there. This marks the key as being "approved", so
1060 * we can still access via not-really-existing key without raising
1064 /* We'll be saving this slot, so the number of allocated keys
1065 * doesn't go down, but the number placeholders goes up */
1066 HvPLACEHOLDERS(hv)++;
1068 *oentry = HeNEXT(entry);
1069 if (SvOOK(hv) && entry == HvAUX(hv)->xhv_eiter /* HvEITER(hv) */)
1072 if (SvOOK(hv) && HvLAZYDEL(hv) &&
1073 entry == HeNEXT(HvAUX(hv)->xhv_eiter))
1074 HeNEXT(HvAUX(hv)->xhv_eiter) = HeNEXT(entry);
1075 hv_free_ent(hv, entry);
1077 xhv->xhv_keys--; /* HvTOTALKEYS(hv)-- */
1078 if (xhv->xhv_keys == 0)
1079 HvHASKFLAGS_off(hv);
1082 if (mro_changes == 1) mro_isa_changed_in(hv);
1083 else if (mro_changes == 2)
1084 mro_package_moved(NULL, stash, gv, 1);
1088 if (SvREADONLY(hv)) {
1089 hv_notallowed(k_flags, key, klen,
1090 "Attempt to delete disallowed key '%"SVf"' from"
1091 " a restricted hash");
1094 if (k_flags & HVhek_FREEKEY)
1100 S_hsplit(pTHX_ HV *hv)
1103 register XPVHV* const xhv = (XPVHV*)SvANY(hv);
1104 const I32 oldsize = (I32) xhv->xhv_max+1; /* HvMAX(hv)+1 (sick) */
1105 register I32 newsize = oldsize * 2;
1107 char *a = (char*) HvARRAY(hv);
1109 int longest_chain = 0;
1112 PERL_ARGS_ASSERT_HSPLIT;
1114 /*PerlIO_printf(PerlIO_stderr(), "hsplit called for %p which had %d\n",
1115 (void*)hv, (int) oldsize);*/
1117 if (HvPLACEHOLDERS_get(hv) && !SvREADONLY(hv)) {
1118 /* Can make this clear any placeholders first for non-restricted hashes,
1119 even though Storable rebuilds restricted hashes by putting in all the
1120 placeholders (first) before turning on the readonly flag, because
1121 Storable always pre-splits the hash. */
1122 hv_clear_placeholders(hv);
1126 #if defined(STRANGE_MALLOC) || defined(MYMALLOC)
1127 Renew(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1128 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
1134 Move(&a[oldsize * sizeof(HE*)], &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
1137 Newx(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1138 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
1143 Copy(HvARRAY(hv), a, oldsize * sizeof(HE*), char);
1145 Copy(HvAUX(hv), &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
1147 Safefree(HvARRAY(hv));
1151 Zero(&a[oldsize * sizeof(HE*)], (newsize-oldsize) * sizeof(HE*), char); /* zero 2nd half*/
1152 xhv->xhv_max = --newsize; /* HvMAX(hv) = --newsize */
1153 HvARRAY(hv) = (HE**) a;
1156 for (i=0; i<oldsize; i++,aep++) {
1157 int left_length = 0;
1158 int right_length = 0;
1163 if (!entry) /* non-existent */
1167 if ((HeHASH(entry) & newsize) != (U32)i) {
1168 *oentry = HeNEXT(entry);
1169 HeNEXT(entry) = *bep;
1174 oentry = &HeNEXT(entry);
1179 /* I think we don't actually need to keep track of the longest length,
1180 merely flag if anything is too long. But for the moment while
1181 developing this code I'll track it. */
1182 if (left_length > longest_chain)
1183 longest_chain = left_length;
1184 if (right_length > longest_chain)
1185 longest_chain = right_length;
1189 /* Pick your policy for "hashing isn't working" here: */
1190 if (longest_chain <= HV_MAX_LENGTH_BEFORE_SPLIT /* split worked? */
1195 if (hv == PL_strtab) {
1196 /* Urg. Someone is doing something nasty to the string table.
1201 /* Awooga. Awooga. Pathological data. */
1202 /*PerlIO_printf(PerlIO_stderr(), "%p %d of %d with %d/%d buckets\n", (void*)hv,
1203 longest_chain, HvTOTALKEYS(hv), HvFILL(hv), 1+HvMAX(hv));*/
1206 Newxz(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1207 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
1209 Copy(HvAUX(hv), &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
1212 was_shared = HvSHAREKEYS(hv);
1214 HvSHAREKEYS_off(hv);
1219 for (i=0; i<newsize; i++,aep++) {
1220 register HE *entry = *aep;
1222 /* We're going to trash this HE's next pointer when we chain it
1223 into the new hash below, so store where we go next. */
1224 HE * const next = HeNEXT(entry);
1229 PERL_HASH_INTERNAL(hash, HeKEY(entry), HeKLEN(entry));
1234 = save_hek_flags(HeKEY(entry), HeKLEN(entry),
1235 hash, HeKFLAGS(entry));
1236 unshare_hek (HeKEY_hek(entry));
1237 HeKEY_hek(entry) = new_hek;
1239 /* Not shared, so simply write the new hash in. */
1240 HeHASH(entry) = hash;
1242 /*PerlIO_printf(PerlIO_stderr(), "%d ", HeKFLAGS(entry));*/
1243 HEK_REHASH_on(HeKEY_hek(entry));
1244 /*PerlIO_printf(PerlIO_stderr(), "%d\n", HeKFLAGS(entry));*/
1246 /* Copy oentry to the correct new chain. */
1247 bep = ((HE**)a) + (hash & (I32) xhv->xhv_max);
1248 HeNEXT(entry) = *bep;
1254 Safefree (HvARRAY(hv));
1255 HvARRAY(hv) = (HE **)a;
1259 Perl_hv_ksplit(pTHX_ HV *hv, IV newmax)
1262 register XPVHV* xhv = (XPVHV*)SvANY(hv);
1263 const I32 oldsize = (I32) xhv->xhv_max+1; /* HvMAX(hv)+1 (sick) */
1264 register I32 newsize;
1269 PERL_ARGS_ASSERT_HV_KSPLIT;
1271 newsize = (I32) newmax; /* possible truncation here */
1272 if (newsize != newmax || newmax <= oldsize)
1274 while ((newsize & (1 + ~newsize)) != newsize) {
1275 newsize &= ~(newsize & (1 + ~newsize)); /* get proper power of 2 */
1277 if (newsize < newmax)
1279 if (newsize < newmax)
1280 return; /* overflow detection */
1282 a = (char *) HvARRAY(hv);
1285 #if defined(STRANGE_MALLOC) || defined(MYMALLOC)
1286 Renew(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1287 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
1293 Copy(&a[oldsize * sizeof(HE*)], &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
1296 Newx(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1297 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
1302 Copy(HvARRAY(hv), a, oldsize * sizeof(HE*), char);
1304 Copy(HvAUX(hv), &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
1306 Safefree(HvARRAY(hv));
1309 Zero(&a[oldsize * sizeof(HE*)], (newsize-oldsize) * sizeof(HE*), char); /* zero 2nd half*/
1312 Newxz(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize), char);
1314 xhv->xhv_max = --newsize; /* HvMAX(hv) = --newsize */
1315 HvARRAY(hv) = (HE **) a;
1316 if (!xhv->xhv_keys /* !HvTOTALKEYS(hv) */) /* skip rest if no entries */
1320 for (i=0; i<oldsize; i++,aep++) {
1324 if (!entry) /* non-existent */
1327 register I32 j = (HeHASH(entry) & newsize);
1331 *oentry = HeNEXT(entry);
1332 HeNEXT(entry) = aep[j];
1336 oentry = &HeNEXT(entry);
1343 Perl_newHVhv(pTHX_ HV *ohv)
1346 HV * const hv = newHV();
1349 if (!ohv || !HvTOTALKEYS(ohv))
1351 hv_max = HvMAX(ohv);
1353 if (!SvMAGICAL((const SV *)ohv)) {
1354 /* It's an ordinary hash, so copy it fast. AMS 20010804 */
1356 const bool shared = !!HvSHAREKEYS(ohv);
1357 HE **ents, ** const oents = (HE **)HvARRAY(ohv);
1359 Newx(a, PERL_HV_ARRAY_ALLOC_BYTES(hv_max+1), char);
1362 /* In each bucket... */
1363 for (i = 0; i <= hv_max; i++) {
1365 HE *oent = oents[i];
1372 /* Copy the linked list of entries. */
1373 for (; oent; oent = HeNEXT(oent)) {
1374 const U32 hash = HeHASH(oent);
1375 const char * const key = HeKEY(oent);
1376 const STRLEN len = HeKLEN(oent);
1377 const int flags = HeKFLAGS(oent);
1378 HE * const ent = new_HE();
1379 SV *const val = HeVAL(oent);
1381 HeVAL(ent) = SvIMMORTAL(val) ? val : newSVsv(val);
1383 = shared ? share_hek_flags(key, len, hash, flags)
1384 : save_hek_flags(key, len, hash, flags);
1395 HvTOTALKEYS(hv) = HvTOTALKEYS(ohv);
1399 /* Iterate over ohv, copying keys and values one at a time. */
1401 const I32 riter = HvRITER_get(ohv);
1402 HE * const eiter = HvEITER_get(ohv);
1403 STRLEN hv_fill = HvFILL(ohv);
1405 /* Can we use fewer buckets? (hv_max is always 2^n-1) */
1406 while (hv_max && hv_max + 1 >= hv_fill * 2)
1407 hv_max = hv_max / 2;
1411 while ((entry = hv_iternext_flags(ohv, 0))) {
1412 SV *const val = HeVAL(entry);
1413 (void)hv_store_flags(hv, HeKEY(entry), HeKLEN(entry),
1414 SvIMMORTAL(val) ? val : newSVsv(val),
1415 HeHASH(entry), HeKFLAGS(entry));
1417 HvRITER_set(ohv, riter);
1418 HvEITER_set(ohv, eiter);
1425 =for apidoc Am|HV *|hv_copy_hints_hv|HV *ohv
1427 A specialised version of L</newHVhv> for copying C<%^H>. I<ohv> must be
1428 a pointer to a hash (which may have C<%^H> magic, but should be generally
1429 non-magical), or C<NULL> (interpreted as an empty hash). The content
1430 of I<ohv> is copied to a new hash, which has the C<%^H>-specific magic
1431 added to it. A pointer to the new hash is returned.
1437 Perl_hv_copy_hints_hv(pTHX_ HV *const ohv)
1439 HV * const hv = newHV();
1441 if (ohv && HvTOTALKEYS(ohv)) {
1442 STRLEN hv_max = HvMAX(ohv);
1443 STRLEN hv_fill = HvFILL(ohv);
1445 const I32 riter = HvRITER_get(ohv);
1446 HE * const eiter = HvEITER_get(ohv);
1448 while (hv_max && hv_max + 1 >= hv_fill * 2)
1449 hv_max = hv_max / 2;
1453 while ((entry = hv_iternext_flags(ohv, 0))) {
1454 SV *const sv = newSVsv(HeVAL(entry));
1455 SV *heksv = newSVhek(HeKEY_hek(entry));
1456 sv_magic(sv, NULL, PERL_MAGIC_hintselem,
1457 (char *)heksv, HEf_SVKEY);
1458 SvREFCNT_dec(heksv);
1459 (void)hv_store_flags(hv, HeKEY(entry), HeKLEN(entry),
1460 sv, HeHASH(entry), HeKFLAGS(entry));
1462 HvRITER_set(ohv, riter);
1463 HvEITER_set(ohv, eiter);
1465 hv_magic(hv, NULL, PERL_MAGIC_hints);
1469 /* like hv_free_ent, but returns the SV rather than freeing it */
1471 S_hv_free_ent_ret(pTHX_ HV *hv, register HE *entry)
1476 PERL_ARGS_ASSERT_HV_FREE_ENT_RET;
1481 if (val && isGV(val) && isGV_with_GP(val) && GvCVu(val) && HvENAME(hv))
1482 mro_method_changed_in(hv); /* deletion of method from stash */
1483 if (HeKLEN(entry) == HEf_SVKEY) {
1484 SvREFCNT_dec(HeKEY_sv(entry));
1485 Safefree(HeKEY_hek(entry));
1487 else if (HvSHAREKEYS(hv))
1488 unshare_hek(HeKEY_hek(entry));
1490 Safefree(HeKEY_hek(entry));
1497 Perl_hv_free_ent(pTHX_ HV *hv, register HE *entry)
1502 PERL_ARGS_ASSERT_HV_FREE_ENT;
1506 val = hv_free_ent_ret(hv, entry);
1512 Perl_hv_delayfree_ent(pTHX_ HV *hv, register HE *entry)
1516 PERL_ARGS_ASSERT_HV_DELAYFREE_ENT;
1520 /* SvREFCNT_inc to counter the SvREFCNT_dec in hv_free_ent */
1521 sv_2mortal(SvREFCNT_inc(HeVAL(entry))); /* free between statements */
1522 if (HeKLEN(entry) == HEf_SVKEY) {
1523 sv_2mortal(SvREFCNT_inc(HeKEY_sv(entry)));
1525 hv_free_ent(hv, entry);
1529 =for apidoc hv_clear
1531 Frees the all the elements of a hash, leaving it empty.
1532 The XS equivalent of %hash = (). See also L</hv_undef>.
1538 Perl_hv_clear(pTHX_ HV *hv)
1541 register XPVHV* xhv;
1545 DEBUG_A(Perl_hv_assert(aTHX_ hv));
1547 xhv = (XPVHV*)SvANY(hv);
1549 if (SvREADONLY(hv) && HvARRAY(hv) != NULL) {
1550 /* restricted hash: convert all keys to placeholders */
1552 for (i = 0; i <= xhv->xhv_max; i++) {
1553 HE *entry = (HvARRAY(hv))[i];
1554 for (; entry; entry = HeNEXT(entry)) {
1555 /* not already placeholder */
1556 if (HeVAL(entry) != &PL_sv_placeholder) {
1557 if (HeVAL(entry) && SvREADONLY(HeVAL(entry))
1558 && !SvIsCOW(HeVAL(entry))) {
1559 SV* const keysv = hv_iterkeysv(entry);
1561 "Attempt to delete readonly key '%"SVf"' from a restricted hash",
1564 SvREFCNT_dec(HeVAL(entry));
1565 HeVAL(entry) = &PL_sv_placeholder;
1566 HvPLACEHOLDERS(hv)++;
1573 HvPLACEHOLDERS_set(hv, 0);
1576 mg_clear(MUTABLE_SV(hv));
1578 HvHASKFLAGS_off(hv);
1583 mro_isa_changed_in(hv);
1584 HvEITER_set(hv, NULL);
1589 =for apidoc hv_clear_placeholders
1591 Clears any placeholders from a hash. If a restricted hash has any of its keys
1592 marked as readonly and the key is subsequently deleted, the key is not actually
1593 deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
1594 it so it will be ignored by future operations such as iterating over the hash,
1595 but will still allow the hash to have a value reassigned to the key at some
1596 future point. This function clears any such placeholder keys from the hash.
1597 See Hash::Util::lock_keys() for an example of its use.
1603 Perl_hv_clear_placeholders(pTHX_ HV *hv)
1606 const U32 items = (U32)HvPLACEHOLDERS_get(hv);
1608 PERL_ARGS_ASSERT_HV_CLEAR_PLACEHOLDERS;
1611 clear_placeholders(hv, items);
1615 S_clear_placeholders(pTHX_ HV *hv, U32 items)
1620 PERL_ARGS_ASSERT_CLEAR_PLACEHOLDERS;
1627 /* Loop down the linked list heads */
1628 HE **oentry = &(HvARRAY(hv))[i];
1631 while ((entry = *oentry)) {
1632 if (HeVAL(entry) == &PL_sv_placeholder) {
1633 *oentry = HeNEXT(entry);
1634 if (entry == HvEITER_get(hv))
1637 if (SvOOK(hv) && HvLAZYDEL(hv) &&
1638 entry == HeNEXT(HvAUX(hv)->xhv_eiter))
1639 HeNEXT(HvAUX(hv)->xhv_eiter) = HeNEXT(entry);
1640 hv_free_ent(hv, entry);
1645 HvTOTALKEYS(hv) -= (IV)HvPLACEHOLDERS_get(hv);
1646 if (HvUSEDKEYS(hv) == 0)
1647 HvHASKFLAGS_off(hv);
1648 HvPLACEHOLDERS_set(hv, 0);
1652 oentry = &HeNEXT(entry);
1656 /* You can't get here, hence assertion should always fail. */
1657 assert (items == 0);
1662 S_hfreeentries(pTHX_ HV *hv)
1665 XPVHV * const xhv = (XPVHV*)SvANY(hv);
1667 PERL_ARGS_ASSERT_HFREEENTRIES;
1669 while (xhv->xhv_keys) {
1670 SvREFCNT_dec(Perl_hfree_next_entry(aTHX_ hv, &index));
1675 /* hfree_next_entry()
1676 * For use only by S_hfreeentries() and sv_clear().
1677 * Delete the next available HE from hv and return the associated SV.
1678 * Returns null on empty hash. Nevertheless null is not a reliable
1679 * indicator that the hash is empty, as the deleted entry may have a
1681 * indexp is a pointer to the current index into HvARRAY. The index should
1682 * initially be set to 0. hfree_next_entry() may update it. */
1685 Perl_hfree_next_entry(pTHX_ HV *hv, STRLEN *indexp)
1687 struct xpvhv_aux *iter;
1691 STRLEN orig_index = *indexp;
1694 PERL_ARGS_ASSERT_HFREE_NEXT_ENTRY;
1696 if (SvOOK(hv) && ((iter = HvAUX(hv)))
1697 && ((entry = iter->xhv_eiter)) )
1699 /* the iterator may get resurrected after each
1700 * destructor call, so check each time */
1701 if (entry && HvLAZYDEL(hv)) { /* was deleted earlier? */
1703 hv_free_ent(hv, entry);
1704 /* warning: at this point HvARRAY may have been
1705 * re-allocated, HvMAX changed etc */
1707 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
1708 iter->xhv_eiter = NULL; /* HvEITER(hv) = NULL */
1711 if (!((XPVHV*)SvANY(hv))->xhv_keys)
1714 array = HvARRAY(hv);
1716 while ( ! ((entry = array[*indexp])) ) {
1717 if ((*indexp)++ >= HvMAX(hv))
1719 assert(*indexp != orig_index);
1721 array[*indexp] = HeNEXT(entry);
1722 ((XPVHV*) SvANY(hv))->xhv_keys--;
1724 if ( PL_phase != PERL_PHASE_DESTRUCT && HvENAME(hv)
1725 && HeVAL(entry) && isGV(HeVAL(entry))
1726 && GvHV(HeVAL(entry)) && HvENAME(GvHV(HeVAL(entry)))
1729 const char * const key = HePV(entry,klen);
1730 if ((klen > 1 && key[klen-1]==':' && key[klen-2]==':')
1731 || (klen == 1 && key[0] == ':')) {
1733 NULL, GvHV(HeVAL(entry)),
1734 (GV *)HeVAL(entry), 0
1738 return hv_free_ent_ret(hv, entry);
1743 =for apidoc hv_undef
1745 Undefines the hash. The XS equivalent of undef(%hash).
1747 As well as freeing all the elements of the hash (like hv_clear()), this
1748 also frees any auxiliary data and storage associated with the hash.
1749 See also L</hv_clear>.
1755 Perl_hv_undef_flags(pTHX_ HV *hv, U32 flags)
1758 register XPVHV* xhv;
1763 DEBUG_A(Perl_hv_assert(aTHX_ hv));
1764 xhv = (XPVHV*)SvANY(hv);
1766 /* The name must be deleted before the call to hfreeeeentries so that
1767 CVs are anonymised properly. But the effective name must be pre-
1768 served until after that call (and only deleted afterwards if the
1769 call originated from sv_clear). For stashes with one name that is
1770 both the canonical name and the effective name, hv_name_set has to
1771 allocate an array for storing the effective name. We can skip that
1772 during global destruction, as it does not matter where the CVs point
1773 if they will be freed anyway. */
1774 /* note that the code following prior to hfreeentries is duplicated
1775 * in sv_clear(), and changes here should be done there too */
1776 if (PL_phase != PERL_PHASE_DESTRUCT && (name = HvNAME(hv))) {
1778 (void)hv_delete(PL_stashcache, name, HvNAMELEN_get(hv), G_DISCARD);
1779 hv_name_set(hv, NULL, 0, 0);
1783 struct xpvhv_aux * const aux = HvAUX(hv);
1784 struct mro_meta *meta;
1786 if ((name = HvENAME_get(hv))) {
1787 if (PL_phase != PERL_PHASE_DESTRUCT)
1788 mro_isa_changed_in(hv);
1791 PL_stashcache, name, HvENAMELEN_get(hv), G_DISCARD
1795 /* If this call originated from sv_clear, then we must check for
1796 * effective names that need freeing, as well as the usual name. */
1798 if (flags & HV_NAME_SETALL ? !!aux->xhv_name_u.xhvnameu_name : !!name) {
1799 if (name && PL_stashcache)
1800 (void)hv_delete(PL_stashcache, name, HvNAMELEN_get(hv), G_DISCARD);
1801 hv_name_set(hv, NULL, 0, flags);
1803 if((meta = aux->xhv_mro_meta)) {
1804 if (meta->mro_linear_all) {
1805 SvREFCNT_dec(MUTABLE_SV(meta->mro_linear_all));
1806 meta->mro_linear_all = NULL;
1807 /* This is just acting as a shortcut pointer. */
1808 meta->mro_linear_current = NULL;
1809 } else if (meta->mro_linear_current) {
1810 /* Only the current MRO is stored, so this owns the data.
1812 SvREFCNT_dec(meta->mro_linear_current);
1813 meta->mro_linear_current = NULL;
1815 if(meta->mro_nextmethod) SvREFCNT_dec(meta->mro_nextmethod);
1816 SvREFCNT_dec(meta->isa);
1818 aux->xhv_mro_meta = NULL;
1820 if (!aux->xhv_name_u.xhvnameu_name && ! aux->xhv_backreferences)
1821 SvFLAGS(hv) &= ~SVf_OOK;
1824 Safefree(HvARRAY(hv));
1825 xhv->xhv_max = 7; /* HvMAX(hv) = 7 (it's a normal hash) */
1828 HvPLACEHOLDERS_set(hv, 0);
1831 mg_clear(MUTABLE_SV(hv));
1837 Returns the number of hash buckets that happen to be in use. This function is
1838 wrapped by the macro C<HvFILL>.
1840 Previously this value was stored in the HV structure, rather than being
1841 calculated on demand.
1847 Perl_hv_fill(pTHX_ HV const *const hv)
1850 HE **ents = HvARRAY(hv);
1852 PERL_ARGS_ASSERT_HV_FILL;
1855 HE *const *const last = ents + HvMAX(hv);
1856 count = last + 1 - ents;
1861 } while (++ents <= last);
1866 static struct xpvhv_aux*
1867 S_hv_auxinit(HV *hv) {
1868 struct xpvhv_aux *iter;
1871 PERL_ARGS_ASSERT_HV_AUXINIT;
1874 Newxz(array, PERL_HV_ARRAY_ALLOC_BYTES(HvMAX(hv) + 1)
1875 + sizeof(struct xpvhv_aux), char);
1877 array = (char *) HvARRAY(hv);
1878 Renew(array, PERL_HV_ARRAY_ALLOC_BYTES(HvMAX(hv) + 1)
1879 + sizeof(struct xpvhv_aux), char);
1881 HvARRAY(hv) = (HE**) array;
1882 /* SvOOK_on(hv) attacks the IV flags. */
1883 SvFLAGS(hv) |= SVf_OOK;
1886 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
1887 iter->xhv_eiter = NULL; /* HvEITER(hv) = NULL */
1888 iter->xhv_name_u.xhvnameu_name = 0;
1889 iter->xhv_name_count = 0;
1890 iter->xhv_backreferences = 0;
1891 iter->xhv_mro_meta = NULL;
1896 =for apidoc hv_iterinit
1898 Prepares a starting point to traverse a hash table. Returns the number of
1899 keys in the hash (i.e. the same as C<HvUSEDKEYS(hv)>). The return value is
1900 currently only meaningful for hashes without tie magic.
1902 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1903 hash buckets that happen to be in use. If you still need that esoteric
1904 value, you can get it through the macro C<HvFILL(hv)>.
1911 Perl_hv_iterinit(pTHX_ HV *hv)
1913 PERL_ARGS_ASSERT_HV_ITERINIT;
1915 /* FIXME: Are we not NULL, or do we croak? Place bets now! */
1918 Perl_croak(aTHX_ "Bad hash");
1921 struct xpvhv_aux * const iter = HvAUX(hv);
1922 HE * const entry = iter->xhv_eiter; /* HvEITER(hv) */
1923 if (entry && HvLAZYDEL(hv)) { /* was deleted earlier? */
1925 hv_free_ent(hv, entry);
1927 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
1928 iter->xhv_eiter = NULL; /* HvEITER(hv) = NULL */
1933 /* used to be xhv->xhv_fill before 5.004_65 */
1934 return HvTOTALKEYS(hv);
1938 Perl_hv_riter_p(pTHX_ HV *hv) {
1939 struct xpvhv_aux *iter;
1941 PERL_ARGS_ASSERT_HV_RITER_P;
1944 Perl_croak(aTHX_ "Bad hash");
1946 iter = SvOOK(hv) ? HvAUX(hv) : hv_auxinit(hv);
1947 return &(iter->xhv_riter);
1951 Perl_hv_eiter_p(pTHX_ HV *hv) {
1952 struct xpvhv_aux *iter;
1954 PERL_ARGS_ASSERT_HV_EITER_P;
1957 Perl_croak(aTHX_ "Bad hash");
1959 iter = SvOOK(hv) ? HvAUX(hv) : hv_auxinit(hv);
1960 return &(iter->xhv_eiter);
1964 Perl_hv_riter_set(pTHX_ HV *hv, I32 riter) {
1965 struct xpvhv_aux *iter;
1967 PERL_ARGS_ASSERT_HV_RITER_SET;
1970 Perl_croak(aTHX_ "Bad hash");
1978 iter = hv_auxinit(hv);
1980 iter->xhv_riter = riter;
1984 Perl_hv_eiter_set(pTHX_ HV *hv, HE *eiter) {
1985 struct xpvhv_aux *iter;
1987 PERL_ARGS_ASSERT_HV_EITER_SET;
1990 Perl_croak(aTHX_ "Bad hash");
1995 /* 0 is the default so don't go malloc()ing a new structure just to
2000 iter = hv_auxinit(hv);
2002 iter->xhv_eiter = eiter;
2006 Perl_hv_name_set(pTHX_ HV *hv, const char *name, U32 len, U32 flags)
2009 struct xpvhv_aux *iter;
2013 PERL_ARGS_ASSERT_HV_NAME_SET;
2014 PERL_UNUSED_ARG(flags);
2017 Perl_croak(aTHX_ "panic: hv name too long (%"UVuf")", (UV) len);
2021 if (iter->xhv_name_u.xhvnameu_name) {
2022 if(iter->xhv_name_count) {
2023 if(flags & HV_NAME_SETALL) {
2024 HEK ** const name = HvAUX(hv)->xhv_name_u.xhvnameu_names;
2025 HEK **hekp = name + (
2026 iter->xhv_name_count < 0
2027 ? -iter->xhv_name_count
2028 : iter->xhv_name_count
2030 while(hekp-- > name+1)
2031 unshare_hek_or_pvn(*hekp, 0, 0, 0);
2032 /* The first elem may be null. */
2033 if(*name) unshare_hek_or_pvn(*name, 0, 0, 0);
2035 spot = &iter->xhv_name_u.xhvnameu_name;
2036 iter->xhv_name_count = 0;
2039 if(iter->xhv_name_count > 0) {
2040 /* shift some things over */
2042 iter->xhv_name_u.xhvnameu_names, iter->xhv_name_count + 1, HEK *
2044 spot = iter->xhv_name_u.xhvnameu_names;
2045 spot[iter->xhv_name_count] = spot[1];
2047 iter->xhv_name_count = -(iter->xhv_name_count + 1);
2049 else if(*(spot = iter->xhv_name_u.xhvnameu_names)) {
2050 unshare_hek_or_pvn(*spot, 0, 0, 0);
2054 else if (flags & HV_NAME_SETALL) {
2055 unshare_hek_or_pvn(iter->xhv_name_u.xhvnameu_name, 0, 0, 0);
2056 spot = &iter->xhv_name_u.xhvnameu_name;
2059 HEK * const existing_name = iter->xhv_name_u.xhvnameu_name;
2060 Newx(iter->xhv_name_u.xhvnameu_names, 2, HEK *);
2061 iter->xhv_name_count = -2;
2062 spot = iter->xhv_name_u.xhvnameu_names;
2063 spot[1] = existing_name;
2066 else { spot = &iter->xhv_name_u.xhvnameu_name; iter->xhv_name_count = 0; }
2071 iter = hv_auxinit(hv);
2072 spot = &iter->xhv_name_u.xhvnameu_name;
2074 PERL_HASH(hash, name, len);
2075 *spot = name ? share_hek(name, len, hash) : NULL;
2079 =for apidoc hv_ename_add
2081 Adds a name to a stash's internal list of effective names. See
2084 This is called when a stash is assigned to a new location in the symbol
2091 Perl_hv_ename_add(pTHX_ HV *hv, const char *name, U32 len, U32 flags)
2094 struct xpvhv_aux *aux = SvOOK(hv) ? HvAUX(hv) : hv_auxinit(hv);
2097 PERL_ARGS_ASSERT_HV_ENAME_ADD;
2098 PERL_UNUSED_ARG(flags);
2101 Perl_croak(aTHX_ "panic: hv name too long (%"UVuf")", (UV) len);
2103 PERL_HASH(hash, name, len);
2105 if (aux->xhv_name_count) {
2106 HEK ** const xhv_name = aux->xhv_name_u.xhvnameu_names;
2107 I32 count = aux->xhv_name_count;
2108 HEK **hekp = xhv_name + (count < 0 ? -count : count);
2109 while (hekp-- > xhv_name)
2111 HEK_LEN(*hekp) == (I32)len && memEQ(HEK_KEY(*hekp), name, len)
2113 if (hekp == xhv_name && count < 0)
2114 aux->xhv_name_count = -count;
2117 if (count < 0) aux->xhv_name_count--, count = -count;
2118 else aux->xhv_name_count++;
2119 Renew(aux->xhv_name_u.xhvnameu_names, count + 1, HEK *);
2120 (aux->xhv_name_u.xhvnameu_names)[count] = share_hek(name, len, hash);
2123 HEK *existing_name = aux->xhv_name_u.xhvnameu_name;
2125 existing_name && HEK_LEN(existing_name) == (I32)len
2126 && memEQ(HEK_KEY(existing_name), name, len)
2128 Newx(aux->xhv_name_u.xhvnameu_names, 2, HEK *);
2129 aux->xhv_name_count = existing_name ? 2 : -2;
2130 *aux->xhv_name_u.xhvnameu_names = existing_name;
2131 (aux->xhv_name_u.xhvnameu_names)[1] = share_hek(name, len, hash);
2136 =for apidoc hv_ename_delete
2138 Removes a name from a stash's internal list of effective names. If this is
2139 the name returned by C<HvENAME>, then another name in the list will take
2140 its place (C<HvENAME> will use it).
2142 This is called when a stash is deleted from the symbol table.
2148 Perl_hv_ename_delete(pTHX_ HV *hv, const char *name, U32 len, U32 flags)
2151 struct xpvhv_aux *aux;
2153 PERL_ARGS_ASSERT_HV_ENAME_DELETE;
2154 PERL_UNUSED_ARG(flags);
2157 Perl_croak(aTHX_ "panic: hv name too long (%"UVuf")", (UV) len);
2159 if (!SvOOK(hv)) return;
2162 if (!aux->xhv_name_u.xhvnameu_name) return;
2164 if (aux->xhv_name_count) {
2165 HEK ** const namep = aux->xhv_name_u.xhvnameu_names;
2166 I32 const count = aux->xhv_name_count;
2167 HEK **victim = namep + (count < 0 ? -count : count);
2168 while (victim-- > namep + 1)
2170 HEK_LEN(*victim) == (I32)len
2171 && memEQ(HEK_KEY(*victim), name, len)
2173 unshare_hek_or_pvn(*victim, 0, 0, 0);
2174 if (count < 0) ++aux->xhv_name_count;
2175 else --aux->xhv_name_count;
2177 (aux->xhv_name_count == 1 || aux->xhv_name_count == -1)
2179 ) { /* if there are none left */
2181 aux->xhv_name_u.xhvnameu_names = NULL;
2182 aux->xhv_name_count = 0;
2185 /* Move the last one back to fill the empty slot. It
2186 does not matter what order they are in. */
2187 *victim = *(namep + (count < 0 ? -count : count) - 1);
2192 count > 0 && HEK_LEN(*namep) == (I32)len
2193 && memEQ(HEK_KEY(*namep),name,len)
2195 aux->xhv_name_count = -count;
2199 HEK_LEN(aux->xhv_name_u.xhvnameu_name) == (I32)len
2200 && memEQ(HEK_KEY(aux->xhv_name_u.xhvnameu_name), name, len)
2202 HEK * const namehek = aux->xhv_name_u.xhvnameu_name;
2203 Newx(aux->xhv_name_u.xhvnameu_names, 1, HEK *);
2204 *aux->xhv_name_u.xhvnameu_names = namehek;
2205 aux->xhv_name_count = -1;
2210 Perl_hv_backreferences_p(pTHX_ HV *hv) {
2211 struct xpvhv_aux * const iter = SvOOK(hv) ? HvAUX(hv) : hv_auxinit(hv);
2213 PERL_ARGS_ASSERT_HV_BACKREFERENCES_P;
2214 PERL_UNUSED_CONTEXT;
2216 return &(iter->xhv_backreferences);
2220 Perl_hv_kill_backrefs(pTHX_ HV *hv) {
2223 PERL_ARGS_ASSERT_HV_KILL_BACKREFS;
2228 av = HvAUX(hv)->xhv_backreferences;
2231 HvAUX(hv)->xhv_backreferences = 0;
2232 Perl_sv_kill_backrefs(aTHX_ MUTABLE_SV(hv), av);
2233 if (SvTYPE(av) == SVt_PVAV)
2239 hv_iternext is implemented as a macro in hv.h
2241 =for apidoc hv_iternext
2243 Returns entries from a hash iterator. See C<hv_iterinit>.
2245 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
2246 iterator currently points to, without losing your place or invalidating your
2247 iterator. Note that in this case the current entry is deleted from the hash
2248 with your iterator holding the last reference to it. Your iterator is flagged
2249 to free the entry on the next call to C<hv_iternext>, so you must not discard
2250 your iterator immediately else the entry will leak - call C<hv_iternext> to
2251 trigger the resource deallocation.
2253 =for apidoc hv_iternext_flags
2255 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
2256 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
2257 set the placeholders keys (for restricted hashes) will be returned in addition
2258 to normal keys. By default placeholders are automatically skipped over.
2259 Currently a placeholder is implemented with a value that is
2260 C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
2261 restricted hashes may change, and the implementation currently is
2262 insufficiently abstracted for any change to be tidy.
2268 Perl_hv_iternext_flags(pTHX_ HV *hv, I32 flags)
2271 register XPVHV* xhv;
2275 struct xpvhv_aux *iter;
2277 PERL_ARGS_ASSERT_HV_ITERNEXT_FLAGS;
2280 Perl_croak(aTHX_ "Bad hash");
2282 xhv = (XPVHV*)SvANY(hv);
2285 /* Too many things (well, pp_each at least) merrily assume that you can
2286 call iv_iternext without calling hv_iterinit, so we'll have to deal
2292 oldentry = entry = iter->xhv_eiter; /* HvEITER(hv) */
2293 if (SvMAGICAL(hv) && SvRMAGICAL(hv)) {
2294 if ( ( mg = mg_find((const SV *)hv, PERL_MAGIC_tied) ) ) {
2295 SV * const key = sv_newmortal();
2297 sv_setsv(key, HeSVKEY_force(entry));
2298 SvREFCNT_dec(HeSVKEY(entry)); /* get rid of previous key */
2304 /* one HE per MAGICAL hash */
2305 iter->xhv_eiter = entry = new_HE(); /* HvEITER(hv) = new_HE() */
2307 Newxz(k, HEK_BASESIZE + sizeof(const SV *), char);
2309 HeKEY_hek(entry) = hek;
2310 HeKLEN(entry) = HEf_SVKEY;
2312 magic_nextpack(MUTABLE_SV(hv),mg,key);
2314 /* force key to stay around until next time */
2315 HeSVKEY_set(entry, SvREFCNT_inc_simple_NN(key));
2316 return entry; /* beware, hent_val is not set */
2318 SvREFCNT_dec(HeVAL(entry));
2319 Safefree(HeKEY_hek(entry));
2321 iter->xhv_eiter = NULL; /* HvEITER(hv) = NULL */
2325 #if defined(DYNAMIC_ENV_FETCH) && !defined(__riscos__) /* set up %ENV for iteration */
2326 if (!entry && SvRMAGICAL((const SV *)hv)
2327 && mg_find((const SV *)hv, PERL_MAGIC_env)) {
2330 /* The prime_env_iter() on VMS just loaded up new hash values
2331 * so the iteration count needs to be reset back to the beginning
2335 oldentry = entry = iter->xhv_eiter; /* HvEITER(hv) */
2340 /* hv_iterint now ensures this. */
2341 assert (HvARRAY(hv));
2343 /* At start of hash, entry is NULL. */
2346 entry = HeNEXT(entry);
2347 if (!(flags & HV_ITERNEXT_WANTPLACEHOLDERS)) {
2349 * Skip past any placeholders -- don't want to include them in
2352 while (entry && HeVAL(entry) == &PL_sv_placeholder) {
2353 entry = HeNEXT(entry);
2358 /* Skip the entire loop if the hash is empty. */
2359 if ((flags & HV_ITERNEXT_WANTPLACEHOLDERS)
2360 ? HvTOTALKEYS(hv) : HvUSEDKEYS(hv)) {
2362 /* OK. Come to the end of the current list. Grab the next one. */
2364 iter->xhv_riter++; /* HvRITER(hv)++ */
2365 if (iter->xhv_riter > (I32)xhv->xhv_max /* HvRITER(hv) > HvMAX(hv) */) {
2366 /* There is no next one. End of the hash. */
2367 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
2370 entry = (HvARRAY(hv))[iter->xhv_riter];
2372 if (!(flags & HV_ITERNEXT_WANTPLACEHOLDERS)) {
2373 /* If we have an entry, but it's a placeholder, don't count it.
2375 while (entry && HeVAL(entry) == &PL_sv_placeholder)
2376 entry = HeNEXT(entry);
2378 /* Will loop again if this linked list starts NULL
2379 (for HV_ITERNEXT_WANTPLACEHOLDERS)
2380 or if we run through it and find only placeholders. */
2384 if (oldentry && HvLAZYDEL(hv)) { /* was deleted earlier? */
2386 hv_free_ent(hv, oldentry);
2389 /*if (HvREHASH(hv) && entry && !HeKREHASH(entry))
2390 PerlIO_printf(PerlIO_stderr(), "Awooga %p %p\n", (void*)hv, (void*)entry);*/
2392 iter->xhv_eiter = entry; /* HvEITER(hv) = entry */
2397 =for apidoc hv_iterkey
2399 Returns the key from the current position of the hash iterator. See
2406 Perl_hv_iterkey(pTHX_ register HE *entry, I32 *retlen)
2408 PERL_ARGS_ASSERT_HV_ITERKEY;
2410 if (HeKLEN(entry) == HEf_SVKEY) {
2412 char * const p = SvPV(HeKEY_sv(entry), len);
2417 *retlen = HeKLEN(entry);
2418 return HeKEY(entry);
2422 /* unlike hv_iterval(), this always returns a mortal copy of the key */
2424 =for apidoc hv_iterkeysv
2426 Returns the key as an C<SV*> from the current position of the hash
2427 iterator. The return value will always be a mortal copy of the key. Also
2434 Perl_hv_iterkeysv(pTHX_ register HE *entry)
2436 PERL_ARGS_ASSERT_HV_ITERKEYSV;
2438 return sv_2mortal(newSVhek(HeKEY_hek(entry)));
2442 =for apidoc hv_iterval
2444 Returns the value from the current position of the hash iterator. See
2451 Perl_hv_iterval(pTHX_ HV *hv, register HE *entry)
2453 PERL_ARGS_ASSERT_HV_ITERVAL;
2455 if (SvRMAGICAL(hv)) {
2456 if (mg_find((const SV *)hv, PERL_MAGIC_tied)) {
2457 SV* const sv = sv_newmortal();
2458 if (HeKLEN(entry) == HEf_SVKEY)
2459 mg_copy(MUTABLE_SV(hv), sv, (char*)HeKEY_sv(entry), HEf_SVKEY);
2461 mg_copy(MUTABLE_SV(hv), sv, HeKEY(entry), HeKLEN(entry));
2465 return HeVAL(entry);
2469 =for apidoc hv_iternextsv
2471 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
2478 Perl_hv_iternextsv(pTHX_ HV *hv, char **key, I32 *retlen)
2480 HE * const he = hv_iternext_flags(hv, 0);
2482 PERL_ARGS_ASSERT_HV_ITERNEXTSV;
2486 *key = hv_iterkey(he, retlen);
2487 return hv_iterval(hv, he);
2494 =for apidoc hv_magic
2496 Adds magic to a hash. See C<sv_magic>.
2501 /* possibly free a shared string if no one has access to it
2502 * len and hash must both be valid for str.
2505 Perl_unsharepvn(pTHX_ const char *str, I32 len, U32 hash)
2507 unshare_hek_or_pvn (NULL, str, len, hash);
2512 Perl_unshare_hek(pTHX_ HEK *hek)
2515 unshare_hek_or_pvn(hek, NULL, 0, 0);
2518 /* possibly free a shared string if no one has access to it
2519 hek if non-NULL takes priority over the other 3, else str, len and hash
2520 are used. If so, len and hash must both be valid for str.
2523 S_unshare_hek_or_pvn(pTHX_ const HEK *hek, const char *str, I32 len, U32 hash)
2526 register XPVHV* xhv;
2528 register HE **oentry;
2529 bool is_utf8 = FALSE;
2531 const char * const save = str;
2532 struct shared_he *he = NULL;
2535 /* Find the shared he which is just before us in memory. */
2536 he = (struct shared_he *)(((char *)hek)
2537 - STRUCT_OFFSET(struct shared_he,
2540 /* Assert that the caller passed us a genuine (or at least consistent)
2542 assert (he->shared_he_he.hent_hek == hek);
2544 if (he->shared_he_he.he_valu.hent_refcount - 1) {
2545 --he->shared_he_he.he_valu.hent_refcount;
2549 hash = HEK_HASH(hek);
2550 } else if (len < 0) {
2551 STRLEN tmplen = -len;
2553 /* See the note in hv_fetch(). --jhi */
2554 str = (char*)bytes_from_utf8((U8*)str, &tmplen, &is_utf8);
2557 k_flags = HVhek_UTF8;
2559 k_flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
2562 /* what follows was the moral equivalent of:
2563 if ((Svp = hv_fetch(PL_strtab, tmpsv, FALSE, hash))) {
2565 hv_delete(PL_strtab, str, len, G_DISCARD, hash);
2567 xhv = (XPVHV*)SvANY(PL_strtab);
2568 /* assert(xhv_array != 0) */
2569 oentry = &(HvARRAY(PL_strtab))[hash & (I32) HvMAX(PL_strtab)];
2571 const HE *const he_he = &(he->shared_he_he);
2572 for (entry = *oentry; entry; oentry = &HeNEXT(entry), entry = *oentry) {
2577 const int flags_masked = k_flags & HVhek_MASK;
2578 for (entry = *oentry; entry; oentry = &HeNEXT(entry), entry = *oentry) {
2579 if (HeHASH(entry) != hash) /* strings can't be equal */
2581 if (HeKLEN(entry) != len)
2583 if (HeKEY(entry) != str && memNE(HeKEY(entry),str,len)) /* is this it? */
2585 if (HeKFLAGS(entry) != flags_masked)
2592 if (--entry->he_valu.hent_refcount == 0) {
2593 *oentry = HeNEXT(entry);
2595 xhv->xhv_keys--; /* HvTOTALKEYS(hv)-- */
2600 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
2601 "Attempt to free non-existent shared string '%s'%s"
2603 hek ? HEK_KEY(hek) : str,
2604 ((k_flags & HVhek_UTF8) ? " (utf8)" : "") pTHX__VALUE);
2605 if (k_flags & HVhek_FREEKEY)
2609 /* get a (constant) string ptr from the global string table
2610 * string will get added if it is not already there.
2611 * len and hash must both be valid for str.
2614 Perl_share_hek(pTHX_ const char *str, I32 len, register U32 hash)
2616 bool is_utf8 = FALSE;
2618 const char * const save = str;
2620 PERL_ARGS_ASSERT_SHARE_HEK;
2623 STRLEN tmplen = -len;
2625 /* See the note in hv_fetch(). --jhi */
2626 str = (char*)bytes_from_utf8((U8*)str, &tmplen, &is_utf8);
2628 /* If we were able to downgrade here, then than means that we were passed
2629 in a key which only had chars 0-255, but was utf8 encoded. */
2632 /* If we found we were able to downgrade the string to bytes, then
2633 we should flag that it needs upgrading on keys or each. Also flag
2634 that we need share_hek_flags to free the string. */
2636 flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
2639 return share_hek_flags (str, len, hash, flags);
2643 S_share_hek_flags(pTHX_ const char *str, I32 len, register U32 hash, int flags)
2647 const int flags_masked = flags & HVhek_MASK;
2648 const U32 hindex = hash & (I32) HvMAX(PL_strtab);
2649 register XPVHV * const xhv = (XPVHV*)SvANY(PL_strtab);
2651 PERL_ARGS_ASSERT_SHARE_HEK_FLAGS;
2653 /* what follows is the moral equivalent of:
2655 if (!(Svp = hv_fetch(PL_strtab, str, len, FALSE)))
2656 hv_store(PL_strtab, str, len, NULL, hash);
2658 Can't rehash the shared string table, so not sure if it's worth
2659 counting the number of entries in the linked list
2662 /* assert(xhv_array != 0) */
2663 entry = (HvARRAY(PL_strtab))[hindex];
2664 for (;entry; entry = HeNEXT(entry)) {
2665 if (HeHASH(entry) != hash) /* strings can't be equal */
2667 if (HeKLEN(entry) != len)
2669 if (HeKEY(entry) != str && memNE(HeKEY(entry),str,len)) /* is this it? */
2671 if (HeKFLAGS(entry) != flags_masked)
2677 /* What used to be head of the list.
2678 If this is NULL, then we're the first entry for this slot, which
2679 means we need to increate fill. */
2680 struct shared_he *new_entry;
2683 HE **const head = &HvARRAY(PL_strtab)[hindex];
2684 HE *const next = *head;
2686 /* We don't actually store a HE from the arena and a regular HEK.
2687 Instead we allocate one chunk of memory big enough for both,
2688 and put the HEK straight after the HE. This way we can find the
2689 HEK directly from the HE.
2692 Newx(k, STRUCT_OFFSET(struct shared_he,
2693 shared_he_hek.hek_key[0]) + len + 2, char);
2694 new_entry = (struct shared_he *)k;
2695 entry = &(new_entry->shared_he_he);
2696 hek = &(new_entry->shared_he_hek);
2698 Copy(str, HEK_KEY(hek), len, char);
2699 HEK_KEY(hek)[len] = 0;
2701 HEK_HASH(hek) = hash;
2702 HEK_FLAGS(hek) = (unsigned char)flags_masked;
2704 /* Still "point" to the HEK, so that other code need not know what
2706 HeKEY_hek(entry) = hek;
2707 entry->he_valu.hent_refcount = 0;
2708 HeNEXT(entry) = next;
2711 xhv->xhv_keys++; /* HvTOTALKEYS(hv)++ */
2712 if (!next) { /* initial entry? */
2713 } else if (xhv->xhv_keys > xhv->xhv_max /* HvUSEDKEYS(hv) > HvMAX(hv) */) {
2718 ++entry->he_valu.hent_refcount;
2720 if (flags & HVhek_FREEKEY)
2723 return HeKEY_hek(entry);
2727 Perl_hv_placeholders_p(pTHX_ HV *hv)
2730 MAGIC *mg = mg_find((const SV *)hv, PERL_MAGIC_rhash);
2732 PERL_ARGS_ASSERT_HV_PLACEHOLDERS_P;
2735 mg = sv_magicext(MUTABLE_SV(hv), 0, PERL_MAGIC_rhash, 0, 0, 0);
2738 Perl_die(aTHX_ "panic: hv_placeholders_p");
2741 return &(mg->mg_len);
2746 Perl_hv_placeholders_get(pTHX_ const HV *hv)
2749 MAGIC * const mg = mg_find((const SV *)hv, PERL_MAGIC_rhash);
2751 PERL_ARGS_ASSERT_HV_PLACEHOLDERS_GET;
2753 return mg ? mg->mg_len : 0;
2757 Perl_hv_placeholders_set(pTHX_ HV *hv, I32 ph)
2760 MAGIC * const mg = mg_find((const SV *)hv, PERL_MAGIC_rhash);
2762 PERL_ARGS_ASSERT_HV_PLACEHOLDERS_SET;
2767 if (!sv_magicext(MUTABLE_SV(hv), 0, PERL_MAGIC_rhash, 0, 0, ph))
2768 Perl_die(aTHX_ "panic: hv_placeholders_set");
2770 /* else we don't need to add magic to record 0 placeholders. */
2774 S_refcounted_he_value(pTHX_ const struct refcounted_he *he)
2779 PERL_ARGS_ASSERT_REFCOUNTED_HE_VALUE;
2781 switch(he->refcounted_he_data[0] & HVrhek_typemask) {
2786 value = &PL_sv_placeholder;
2789 value = newSViv(he->refcounted_he_val.refcounted_he_u_iv);
2792 value = newSVuv(he->refcounted_he_val.refcounted_he_u_uv);
2795 case HVrhek_PV_UTF8:
2796 /* Create a string SV that directly points to the bytes in our
2798 value = newSV_type(SVt_PV);
2799 SvPV_set(value, (char *) he->refcounted_he_data + 1);
2800 SvCUR_set(value, he->refcounted_he_val.refcounted_he_u_len);
2801 /* This stops anything trying to free it */
2802 SvLEN_set(value, 0);
2804 SvREADONLY_on(value);
2805 if ((he->refcounted_he_data[0] & HVrhek_typemask) == HVrhek_PV_UTF8)
2809 Perl_croak(aTHX_ "panic: refcounted_he_value bad flags %"UVxf,
2810 (UV)he->refcounted_he_data[0]);
2816 =for apidoc m|HV *|refcounted_he_chain_2hv|const struct refcounted_he *c|U32 flags
2818 Generates and returns a C<HV *> representing the content of a
2819 C<refcounted_he> chain.
2820 I<flags> is currently unused and must be zero.
2825 Perl_refcounted_he_chain_2hv(pTHX_ const struct refcounted_he *chain, U32 flags)
2829 U32 placeholders, max;
2832 Perl_croak(aTHX_ "panic: refcounted_he_chain_2hv bad flags %"UVxf,
2835 /* We could chase the chain once to get an idea of the number of keys,
2836 and call ksplit. But for now we'll make a potentially inefficient
2837 hash with only 8 entries in its array. */
2842 Newxz(array, PERL_HV_ARRAY_ALLOC_BYTES(max + 1), char);
2843 HvARRAY(hv) = (HE**)array;
2849 U32 hash = chain->refcounted_he_hash;
2851 U32 hash = HEK_HASH(chain->refcounted_he_hek);
2853 HE **oentry = &((HvARRAY(hv))[hash & max]);
2854 HE *entry = *oentry;
2857 for (; entry; entry = HeNEXT(entry)) {
2858 if (HeHASH(entry) == hash) {
2859 /* We might have a duplicate key here. If so, entry is older
2860 than the key we've already put in the hash, so if they are
2861 the same, skip adding entry. */
2863 const STRLEN klen = HeKLEN(entry);
2864 const char *const key = HeKEY(entry);
2865 if (klen == chain->refcounted_he_keylen
2866 && (!!HeKUTF8(entry)
2867 == !!(chain->refcounted_he_data[0] & HVhek_UTF8))
2868 && memEQ(key, REF_HE_KEY(chain), klen))
2871 if (HeKEY_hek(entry) == chain->refcounted_he_hek)
2873 if (HeKLEN(entry) == HEK_LEN(chain->refcounted_he_hek)
2874 && HeKUTF8(entry) == HEK_UTF8(chain->refcounted_he_hek)
2875 && memEQ(HeKEY(entry), HEK_KEY(chain->refcounted_he_hek),
2886 = share_hek_flags(REF_HE_KEY(chain),
2887 chain->refcounted_he_keylen,
2888 chain->refcounted_he_hash,
2889 (chain->refcounted_he_data[0]
2890 & (HVhek_UTF8|HVhek_WASUTF8)));
2892 HeKEY_hek(entry) = share_hek_hek(chain->refcounted_he_hek);
2894 value = refcounted_he_value(chain);
2895 if (value == &PL_sv_placeholder)
2897 HeVAL(entry) = value;
2899 /* Link it into the chain. */
2900 HeNEXT(entry) = *oentry;
2906 chain = chain->refcounted_he_next;
2910 clear_placeholders(hv, placeholders);
2911 HvTOTALKEYS(hv) -= placeholders;
2914 /* We could check in the loop to see if we encounter any keys with key
2915 flags, but it's probably not worth it, as this per-hash flag is only
2916 really meant as an optimisation for things like Storable. */
2918 DEBUG_A(Perl_hv_assert(aTHX_ hv));
2924 =for apidoc m|SV *|refcounted_he_fetch_pvn|const struct refcounted_he *chain|const char *keypv|STRLEN keylen|U32 hash|U32 flags
2926 Search along a C<refcounted_he> chain for an entry with the key specified
2927 by I<keypv> and I<keylen>. If I<flags> has the C<REFCOUNTED_HE_KEY_UTF8>
2928 bit set, the key octets are interpreted as UTF-8, otherwise they
2929 are interpreted as Latin-1. I<hash> is a precomputed hash of the key
2930 string, or zero if it has not been precomputed. Returns a mortal scalar
2931 representing the value associated with the key, or C<&PL_sv_placeholder>
2932 if there is no value associated with the key.
2938 Perl_refcounted_he_fetch_pvn(pTHX_ const struct refcounted_he *chain,
2939 const char *keypv, STRLEN keylen, U32 hash, U32 flags)
2943 PERL_ARGS_ASSERT_REFCOUNTED_HE_FETCH_PVN;
2945 if (flags & ~REFCOUNTED_HE_KEY_UTF8)
2946 Perl_croak(aTHX_ "panic: refcounted_he_fetch_pvn bad flags %"UVxf,
2949 return &PL_sv_placeholder;
2950 if (flags & REFCOUNTED_HE_KEY_UTF8) {
2951 /* For searching purposes, canonicalise to Latin-1 where possible. */
2952 const char *keyend = keypv + keylen, *p;
2953 STRLEN nonascii_count = 0;
2954 for (p = keypv; p != keyend; p++) {
2957 if (!((c & 0xfe) == 0xc2 && ++p != keyend &&
2958 (((U8)*p) & 0xc0) == 0x80))
2959 goto canonicalised_key;
2963 if (nonascii_count) {
2965 const char *p = keypv, *keyend = keypv + keylen;
2966 keylen -= nonascii_count;
2967 Newx(q, keylen, char);
2970 for (; p != keyend; p++, q++) {
2973 ((c & 0x80) ? ((c & 0x03) << 6) | (((U8)*++p) & 0x3f) : c);
2976 flags &= ~REFCOUNTED_HE_KEY_UTF8;
2977 canonicalised_key: ;
2979 utf8_flag = (flags & REFCOUNTED_HE_KEY_UTF8) ? HVhek_UTF8 : 0;
2981 PERL_HASH(hash, keypv, keylen);
2983 for (; chain; chain = chain->refcounted_he_next) {
2986 hash == chain->refcounted_he_hash &&
2987 keylen == chain->refcounted_he_keylen &&
2988 memEQ(REF_HE_KEY(chain), keypv, keylen) &&
2989 utf8_flag == (chain->refcounted_he_data[0] & HVhek_UTF8)
2991 hash == HEK_HASH(chain->refcounted_he_hek) &&
2992 keylen == (STRLEN)HEK_LEN(chain->refcounted_he_hek) &&
2993 memEQ(HEK_KEY(chain->refcounted_he_hek), keypv, keylen) &&
2994 utf8_flag == (HEK_FLAGS(chain->refcounted_he_hek) & HVhek_UTF8)
2997 return sv_2mortal(refcounted_he_value(chain));
2999 return &PL_sv_placeholder;
3003 =for apidoc m|SV *|refcounted_he_fetch_pv|const struct refcounted_he *chain|const char *key|U32 hash|U32 flags
3005 Like L</refcounted_he_fetch_pvn>, but takes a nul-terminated string
3006 instead of a string/length pair.
3012 Perl_refcounted_he_fetch_pv(pTHX_ const struct refcounted_he *chain,
3013 const char *key, U32 hash, U32 flags)
3015 PERL_ARGS_ASSERT_REFCOUNTED_HE_FETCH_PV;
3016 return refcounted_he_fetch_pvn(chain, key, strlen(key), hash, flags);
3020 =for apidoc m|SV *|refcounted_he_fetch_sv|const struct refcounted_he *chain|SV *key|U32 hash|U32 flags
3022 Like L</refcounted_he_fetch_pvn>, but takes a Perl scalar instead of a
3029 Perl_refcounted_he_fetch_sv(pTHX_ const struct refcounted_he *chain,
3030 SV *key, U32 hash, U32 flags)
3034 PERL_ARGS_ASSERT_REFCOUNTED_HE_FETCH_SV;
3035 if (flags & REFCOUNTED_HE_KEY_UTF8)
3036 Perl_croak(aTHX_ "panic: refcounted_he_fetch_sv bad flags %"UVxf,
3038 keypv = SvPV_const(key, keylen);
3040 flags |= REFCOUNTED_HE_KEY_UTF8;
3041 if (!hash && SvIsCOW_shared_hash(key))
3042 hash = SvSHARED_HASH(key);
3043 return refcounted_he_fetch_pvn(chain, keypv, keylen, hash, flags);
3047 =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
3049 Creates a new C<refcounted_he>. This consists of a single key/value
3050 pair and a reference to an existing C<refcounted_he> chain (which may
3051 be empty), and thus forms a longer chain. When using the longer chain,
3052 the new key/value pair takes precedence over any entry for the same key
3053 further along the chain.
3055 The new key is specified by I<keypv> and I<keylen>. If I<flags> has
3056 the C<REFCOUNTED_HE_KEY_UTF8> bit set, the key octets are interpreted
3057 as UTF-8, otherwise they are interpreted as Latin-1. I<hash> is
3058 a precomputed hash of the key string, or zero if it has not been
3061 I<value> is the scalar value to store for this key. I<value> is copied
3062 by this function, which thus does not take ownership of any reference
3063 to it, and later changes to the scalar will not be reflected in the
3064 value visible in the C<refcounted_he>. Complex types of scalar will not
3065 be stored with referential integrity, but will be coerced to strings.
3066 I<value> may be either null or C<&PL_sv_placeholder> to indicate that no
3067 value is to be associated with the key; this, as with any non-null value,
3068 takes precedence over the existence of a value for the key further along
3071 I<parent> points to the rest of the C<refcounted_he> chain to be
3072 attached to the new C<refcounted_he>. This function takes ownership
3073 of one reference to I<parent>, and returns one reference to the new
3079 struct refcounted_he *
3080 Perl_refcounted_he_new_pvn(pTHX_ struct refcounted_he *parent,
3081 const char *keypv, STRLEN keylen, U32 hash, SV *value, U32 flags)
3084 STRLEN value_len = 0;
3085 const char *value_p = NULL;
3089 STRLEN key_offset = 1;
3090 struct refcounted_he *he;
3091 PERL_ARGS_ASSERT_REFCOUNTED_HE_NEW_PVN;
3093 if (!value || value == &PL_sv_placeholder) {
3094 value_type = HVrhek_delete;
3095 } else if (SvPOK(value)) {
3096 value_type = HVrhek_PV;
3097 } else if (SvIOK(value)) {
3098 value_type = SvUOK((const SV *)value) ? HVrhek_UV : HVrhek_IV;
3099 } else if (!SvOK(value)) {
3100 value_type = HVrhek_undef;
3102 value_type = HVrhek_PV;
3104 is_pv = value_type == HVrhek_PV;
3106 /* Do it this way so that the SvUTF8() test is after the SvPV, in case
3107 the value is overloaded, and doesn't yet have the UTF-8flag set. */
3108 value_p = SvPV_const(value, value_len);
3110 value_type = HVrhek_PV_UTF8;
3111 key_offset = value_len + 2;
3113 hekflags = value_type;
3115 if (flags & REFCOUNTED_HE_KEY_UTF8) {
3116 /* Canonicalise to Latin-1 where possible. */
3117 const char *keyend = keypv + keylen, *p;
3118 STRLEN nonascii_count = 0;
3119 for (p = keypv; p != keyend; p++) {
3122 if (!((c & 0xfe) == 0xc2 && ++p != keyend &&
3123 (((U8)*p) & 0xc0) == 0x80))
3124 goto canonicalised_key;
3128 if (nonascii_count) {
3130 const char *p = keypv, *keyend = keypv + keylen;
3131 keylen -= nonascii_count;
3132 Newx(q, keylen, char);
3135 for (; p != keyend; p++, q++) {
3138 ((c & 0x80) ? ((c & 0x03) << 6) | (((U8)*++p) & 0x3f) : c);
3141 flags &= ~REFCOUNTED_HE_KEY_UTF8;
3142 canonicalised_key: ;
3144 if (flags & REFCOUNTED_HE_KEY_UTF8)
3145 hekflags |= HVhek_UTF8;
3147 PERL_HASH(hash, keypv, keylen);
3150 he = (struct refcounted_he*)
3151 PerlMemShared_malloc(sizeof(struct refcounted_he) - 1
3155 he = (struct refcounted_he*)
3156 PerlMemShared_malloc(sizeof(struct refcounted_he) - 1
3160 he->refcounted_he_next = parent;
3163 Copy(value_p, he->refcounted_he_data + 1, value_len + 1, char);
3164 he->refcounted_he_val.refcounted_he_u_len = value_len;
3165 } else if (value_type == HVrhek_IV) {
3166 he->refcounted_he_val.refcounted_he_u_iv = SvIVX(value);
3167 } else if (value_type == HVrhek_UV) {
3168 he->refcounted_he_val.refcounted_he_u_uv = SvUVX(value);
3172 he->refcounted_he_hash = hash;
3173 he->refcounted_he_keylen = keylen;
3174 Copy(keypv, he->refcounted_he_data + key_offset, keylen, char);
3176 he->refcounted_he_hek = share_hek_flags(keypv, keylen, hash, hekflags);
3179 he->refcounted_he_data[0] = hekflags;
3180 he->refcounted_he_refcnt = 1;
3186 =for apidoc m|struct refcounted_he *|refcounted_he_new_pv|struct refcounted_he *parent|const char *key|U32 hash|SV *value|U32 flags
3188 Like L</refcounted_he_new_pvn>, but takes a nul-terminated string instead
3189 of a string/length pair.
3194 struct refcounted_he *
3195 Perl_refcounted_he_new_pv(pTHX_ struct refcounted_he *parent,
3196 const char *key, U32 hash, SV *value, U32 flags)
3198 PERL_ARGS_ASSERT_REFCOUNTED_HE_NEW_PV;
3199 return refcounted_he_new_pvn(parent, key, strlen(key), hash, value, flags);
3203 =for apidoc m|struct refcounted_he *|refcounted_he_new_sv|struct refcounted_he *parent|SV *key|U32 hash|SV *value|U32 flags
3205 Like L</refcounted_he_new_pvn>, but takes a Perl scalar instead of a
3211 struct refcounted_he *
3212 Perl_refcounted_he_new_sv(pTHX_ struct refcounted_he *parent,
3213 SV *key, U32 hash, SV *value, U32 flags)
3217 PERL_ARGS_ASSERT_REFCOUNTED_HE_NEW_SV;
3218 if (flags & REFCOUNTED_HE_KEY_UTF8)
3219 Perl_croak(aTHX_ "panic: refcounted_he_new_sv bad flags %"UVxf,
3221 keypv = SvPV_const(key, keylen);
3223 flags |= REFCOUNTED_HE_KEY_UTF8;
3224 if (!hash && SvIsCOW_shared_hash(key))
3225 hash = SvSHARED_HASH(key);
3226 return refcounted_he_new_pvn(parent, keypv, keylen, hash, value, flags);
3230 =for apidoc m|void|refcounted_he_free|struct refcounted_he *he
3232 Decrements the reference count of a C<refcounted_he> by one. If the
3233 reference count reaches zero the structure's memory is freed, which
3234 (recursively) causes a reduction of its parent C<refcounted_he>'s
3235 reference count. It is safe to pass a null pointer to this function:
3236 no action occurs in this case.
3242 Perl_refcounted_he_free(pTHX_ struct refcounted_he *he) {
3244 PERL_UNUSED_CONTEXT;
3247 struct refcounted_he *copy;
3251 new_count = --he->refcounted_he_refcnt;
3252 HINTS_REFCNT_UNLOCK;
3258 #ifndef USE_ITHREADS
3259 unshare_hek_or_pvn (he->refcounted_he_hek, 0, 0, 0);
3262 he = he->refcounted_he_next;
3263 PerlMemShared_free(copy);
3268 =for apidoc m|struct refcounted_he *|refcounted_he_inc|struct refcounted_he *he
3270 Increment the reference count of a C<refcounted_he>. The pointer to the
3271 C<refcounted_he> is also returned. It is safe to pass a null pointer
3272 to this function: no action occurs and a null pointer is returned.
3277 struct refcounted_he *
3278 Perl_refcounted_he_inc(pTHX_ struct refcounted_he *he)
3283 he->refcounted_he_refcnt++;
3284 HINTS_REFCNT_UNLOCK;
3289 /* pp_entereval is aware that labels are stored with a key ':' at the top of
3292 Perl_fetch_cop_label(pTHX_ COP *const cop, STRLEN *len, U32 *flags) {
3293 struct refcounted_he *const chain = cop->cop_hints_hash;
3295 PERL_ARGS_ASSERT_FETCH_COP_LABEL;
3300 if (chain->refcounted_he_keylen != 1)
3302 if (*REF_HE_KEY(chain) != ':')
3305 if ((STRLEN)HEK_LEN(chain->refcounted_he_hek) != 1)
3307 if (*HEK_KEY(chain->refcounted_he_hek) != ':')
3310 /* Stop anyone trying to really mess us up by adding their own value for
3312 if ((chain->refcounted_he_data[0] & HVrhek_typemask) != HVrhek_PV
3313 && (chain->refcounted_he_data[0] & HVrhek_typemask) != HVrhek_PV_UTF8)
3317 *len = chain->refcounted_he_val.refcounted_he_u_len;
3319 *flags = ((chain->refcounted_he_data[0] & HVrhek_typemask)
3320 == HVrhek_PV_UTF8) ? SVf_UTF8 : 0;
3322 return chain->refcounted_he_data + 1;
3326 Perl_store_cop_label(pTHX_ COP *const cop, const char *label, STRLEN len,
3330 PERL_ARGS_ASSERT_STORE_COP_LABEL;
3332 if (flags & ~(SVf_UTF8))
3333 Perl_croak(aTHX_ "panic: store_cop_label illegal flag bits 0x%" UVxf,
3335 labelsv = newSVpvn_flags(label, len, SVs_TEMP);
3336 if (flags & SVf_UTF8)
3339 = refcounted_he_new_pvs(cop->cop_hints_hash, ":", labelsv, 0);
3343 =for apidoc hv_assert
3345 Check that a hash is in an internally consistent state.
3353 Perl_hv_assert(pTHX_ HV *hv)
3358 int placeholders = 0;
3361 const I32 riter = HvRITER_get(hv);
3362 HE *eiter = HvEITER_get(hv);
3364 PERL_ARGS_ASSERT_HV_ASSERT;
3366 (void)hv_iterinit(hv);
3368 while ((entry = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS))) {
3369 /* sanity check the values */
3370 if (HeVAL(entry) == &PL_sv_placeholder)
3374 /* sanity check the keys */
3375 if (HeSVKEY(entry)) {
3376 NOOP; /* Don't know what to check on SV keys. */
3377 } else if (HeKUTF8(entry)) {
3379 if (HeKWASUTF8(entry)) {
3380 PerlIO_printf(Perl_debug_log,
3381 "hash key has both WASUTF8 and UTF8: '%.*s'\n",
3382 (int) HeKLEN(entry), HeKEY(entry));
3385 } else if (HeKWASUTF8(entry))
3388 if (!SvTIED_mg((const SV *)hv, PERL_MAGIC_tied)) {
3389 static const char bad_count[] = "Count %d %s(s), but hash reports %d\n";
3390 const int nhashkeys = HvUSEDKEYS(hv);
3391 const int nhashplaceholders = HvPLACEHOLDERS_get(hv);
3393 if (nhashkeys != real) {
3394 PerlIO_printf(Perl_debug_log, bad_count, real, "keys", nhashkeys );
3397 if (nhashplaceholders != placeholders) {
3398 PerlIO_printf(Perl_debug_log, bad_count, placeholders, "placeholder", nhashplaceholders );
3402 if (withflags && ! HvHASKFLAGS(hv)) {
3403 PerlIO_printf(Perl_debug_log,
3404 "Hash has HASKFLAGS off but I count %d key(s) with flags\n",
3409 sv_dump(MUTABLE_SV(hv));
3411 HvRITER_set(hv, riter); /* Restore hash iterator state */
3412 HvEITER_set(hv, eiter);
3419 * c-indentation-style: bsd
3421 * indent-tabs-mode: t
3424 * ex: set ts=8 sts=4 sw=4 noet: