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. This means that if
281 there is no value in the hash associated with the given key, then one is
282 created and a pointer to it is returned. The C<SV*> it points to can be
283 assigned to. But always check that the
284 return value is non-null before dereferencing it to an C<SV*>.
286 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
287 information on how to use this function on tied hashes.
289 =for apidoc hv_exists_ent
291 Returns a boolean indicating whether
292 the specified hash key exists. C<hash>
293 can be a valid precomputed hash value, or 0 to ask for it to be
299 /* returns an HE * structure with the all fields set */
300 /* note that hent_val will be a mortal sv for MAGICAL hashes */
302 =for apidoc hv_fetch_ent
304 Returns the hash entry which corresponds to the specified key in the hash.
305 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
306 if you want the function to compute it. IF C<lval> is set then the fetch
307 will be part of a store. Make sure the return value is non-null before
308 accessing it. The return value when C<hv> is a tied hash is a pointer to a
309 static location, so be sure to make a copy of the structure if you need to
312 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
313 information on how to use this function on tied hashes.
318 /* Common code for hv_delete()/hv_exists()/hv_fetch()/hv_store() */
320 Perl_hv_common_key_len(pTHX_ HV *hv, const char *key, I32 klen_i32,
321 const int action, SV *val, const U32 hash)
326 PERL_ARGS_ASSERT_HV_COMMON_KEY_LEN;
335 return hv_common(hv, NULL, key, klen, flags, action, val, hash);
339 Perl_hv_common(pTHX_ HV *hv, SV *keysv, const char *key, STRLEN klen,
340 int flags, int action, SV *val, register U32 hash)
349 const int return_svp = action & HV_FETCH_JUST_SV;
353 if (SvTYPE(hv) == (svtype)SVTYPEMASK)
356 assert(SvTYPE(hv) == SVt_PVHV);
358 if (SvSMAGICAL(hv) && SvGMAGICAL(hv) && !(action & HV_DISABLE_UVAR_XKEY)) {
360 if ((mg = mg_find((const SV *)hv, PERL_MAGIC_uvar))) {
361 struct ufuncs * const uf = (struct ufuncs *)mg->mg_ptr;
362 if (uf->uf_set == NULL) {
363 SV* obj = mg->mg_obj;
366 keysv = newSVpvn_flags(key, klen, SVs_TEMP |
367 ((flags & HVhek_UTF8)
371 mg->mg_obj = keysv; /* pass key */
372 uf->uf_index = action; /* pass action */
373 magic_getuvar(MUTABLE_SV(hv), mg);
374 keysv = mg->mg_obj; /* may have changed */
377 /* If the key may have changed, then we need to invalidate
378 any passed-in computed hash value. */
384 if (flags & HVhek_FREEKEY)
386 key = SvPV_const(keysv, klen);
387 is_utf8 = (SvUTF8(keysv) != 0);
388 if (SvIsCOW_shared_hash(keysv)) {
389 flags = HVhek_KEYCANONICAL | (is_utf8 ? HVhek_UTF8 : 0);
394 is_utf8 = ((flags & HVhek_UTF8) ? TRUE : FALSE);
397 if (action & HV_DELETE) {
398 return (void *) hv_delete_common(hv, keysv, key, klen,
399 flags | (is_utf8 ? HVhek_UTF8 : 0),
403 xhv = (XPVHV*)SvANY(hv);
405 if (SvRMAGICAL(hv) && !(action & (HV_FETCH_ISSTORE|HV_FETCH_ISEXISTS))) {
406 if (mg_find((const SV *)hv, PERL_MAGIC_tied)
407 || SvGMAGICAL((const SV *)hv))
409 /* FIXME should be able to skimp on the HE/HEK here when
410 HV_FETCH_JUST_SV is true. */
412 keysv = newSVpvn_utf8(key, klen, is_utf8);
414 keysv = newSVsv(keysv);
417 mg_copy(MUTABLE_SV(hv), sv, (char *)keysv, HEf_SVKEY);
419 /* grab a fake HE/HEK pair from the pool or make a new one */
420 entry = PL_hv_fetch_ent_mh;
422 PL_hv_fetch_ent_mh = HeNEXT(entry);
426 Newx(k, HEK_BASESIZE + sizeof(const SV *), char);
427 HeKEY_hek(entry) = (HEK*)k;
429 HeNEXT(entry) = NULL;
430 HeSVKEY_set(entry, keysv);
432 sv_upgrade(sv, SVt_PVLV);
434 /* so we can free entry when freeing sv */
435 LvTARG(sv) = MUTABLE_SV(entry);
437 /* XXX remove at some point? */
438 if (flags & HVhek_FREEKEY)
442 return entry ? (void *) &HeVAL(entry) : NULL;
444 return (void *) entry;
446 #ifdef ENV_IS_CASELESS
447 else if (mg_find((const SV *)hv, PERL_MAGIC_env)) {
449 for (i = 0; i < klen; ++i)
450 if (isLOWER(key[i])) {
451 /* Would be nice if we had a routine to do the
452 copy and upercase in a single pass through. */
453 const char * const nkey = strupr(savepvn(key,klen));
454 /* Note that this fetch is for nkey (the uppercased
455 key) whereas the store is for key (the original) */
456 void *result = hv_common(hv, NULL, nkey, klen,
457 HVhek_FREEKEY, /* free nkey */
458 0 /* non-LVAL fetch */
459 | HV_DISABLE_UVAR_XKEY
462 0 /* compute hash */);
463 if (!result && (action & HV_FETCH_LVALUE)) {
464 /* This call will free key if necessary.
465 Do it this way to encourage compiler to tail
467 result = hv_common(hv, keysv, key, klen, flags,
469 | HV_DISABLE_UVAR_XKEY
473 if (flags & HVhek_FREEKEY)
481 else if (SvRMAGICAL(hv) && (action & HV_FETCH_ISEXISTS)) {
482 if (mg_find((const SV *)hv, PERL_MAGIC_tied)
483 || SvGMAGICAL((const SV *)hv)) {
484 /* I don't understand why hv_exists_ent has svret and sv,
485 whereas hv_exists only had one. */
486 SV * const svret = sv_newmortal();
489 if (keysv || is_utf8) {
491 keysv = newSVpvn_utf8(key, klen, TRUE);
493 keysv = newSVsv(keysv);
495 mg_copy(MUTABLE_SV(hv), sv, (char *)sv_2mortal(keysv), HEf_SVKEY);
497 mg_copy(MUTABLE_SV(hv), sv, key, klen);
499 if (flags & HVhek_FREEKEY)
501 magic_existspack(svret, mg_find(sv, PERL_MAGIC_tiedelem));
502 /* This cast somewhat evil, but I'm merely using NULL/
503 not NULL to return the boolean exists.
504 And I know hv is not NULL. */
505 return SvTRUE(svret) ? (void *)hv : NULL;
507 #ifdef ENV_IS_CASELESS
508 else if (mg_find((const SV *)hv, PERL_MAGIC_env)) {
509 /* XXX This code isn't UTF8 clean. */
510 char * const keysave = (char * const)key;
511 /* Will need to free this, so set FREEKEY flag. */
512 key = savepvn(key,klen);
513 key = (const char*)strupr((char*)key);
518 if (flags & HVhek_FREEKEY) {
521 flags |= HVhek_FREEKEY;
525 else if (action & HV_FETCH_ISSTORE) {
528 hv_magic_check (hv, &needs_copy, &needs_store);
530 const bool save_taint = PL_tainted;
531 if (keysv || is_utf8) {
533 keysv = newSVpvn_utf8(key, klen, TRUE);
536 PL_tainted = SvTAINTED(keysv);
537 keysv = sv_2mortal(newSVsv(keysv));
538 mg_copy(MUTABLE_SV(hv), val, (char*)keysv, HEf_SVKEY);
540 mg_copy(MUTABLE_SV(hv), val, key, klen);
543 TAINT_IF(save_taint);
545 if (flags & HVhek_FREEKEY)
549 #ifdef ENV_IS_CASELESS
550 else if (mg_find((const SV *)hv, PERL_MAGIC_env)) {
551 /* XXX This code isn't UTF8 clean. */
552 const char *keysave = key;
553 /* Will need to free this, so set FREEKEY flag. */
554 key = savepvn(key,klen);
555 key = (const char*)strupr((char*)key);
560 if (flags & HVhek_FREEKEY) {
563 flags |= HVhek_FREEKEY;
571 if ((action & (HV_FETCH_LVALUE | HV_FETCH_ISSTORE))
572 #ifdef DYNAMIC_ENV_FETCH /* if it's an %ENV lookup, we may get it on the fly */
573 || (SvRMAGICAL((const SV *)hv)
574 && mg_find((const SV *)hv, PERL_MAGIC_env))
579 PERL_HV_ARRAY_ALLOC_BYTES(xhv->xhv_max+1 /* HvMAX(hv)+1 */),
581 HvARRAY(hv) = (HE**)array;
583 #ifdef DYNAMIC_ENV_FETCH
584 else if (action & HV_FETCH_ISEXISTS) {
585 /* for an %ENV exists, if we do an insert it's by a recursive
586 store call, so avoid creating HvARRAY(hv) right now. */
590 /* XXX remove at some point? */
591 if (flags & HVhek_FREEKEY)
598 if (is_utf8 & !(flags & HVhek_KEYCANONICAL)) {
599 char * const keysave = (char *)key;
600 key = (char*)bytes_from_utf8((U8*)key, &klen, &is_utf8);
604 flags &= ~HVhek_UTF8;
605 if (key != keysave) {
606 if (flags & HVhek_FREEKEY)
608 flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
609 /* If the caller calculated a hash, it was on the sequence of
610 octets that are the UTF-8 form. We've now changed the sequence
611 of octets stored to that of the equivalent byte representation,
612 so the hash we need is different. */
617 if (HvREHASH(hv) || (!hash && !(keysv && (SvIsCOW_shared_hash(keysv)))))
618 PERL_HASH_INTERNAL_(hash, key, klen, HvREHASH(hv));
620 hash = SvSHARED_HASH(keysv);
622 /* We don't have a pointer to the hv, so we have to replicate the
623 flag into every HEK, so that hv_iterkeysv can see it.
624 And yes, you do need this even though you are not "storing" because
625 you can flip the flags below if doing an lval lookup. (And that
626 was put in to give the semantics Andreas was expecting.) */
628 flags |= HVhek_REHASH;
630 masked_flags = (flags & HVhek_MASK);
632 #ifdef DYNAMIC_ENV_FETCH
633 if (!HvARRAY(hv)) entry = NULL;
637 entry = (HvARRAY(hv))[hash & (I32) HvMAX(hv)];
639 for (; entry; entry = HeNEXT(entry)) {
640 if (HeHASH(entry) != hash) /* strings can't be equal */
642 if (HeKLEN(entry) != (I32)klen)
644 if (HeKEY(entry) != key && memNE(HeKEY(entry),key,klen)) /* is this it? */
646 if ((HeKFLAGS(entry) ^ masked_flags) & HVhek_UTF8)
649 if (action & (HV_FETCH_LVALUE|HV_FETCH_ISSTORE)) {
650 if (HeKFLAGS(entry) != masked_flags) {
651 /* We match if HVhek_UTF8 bit in our flags and hash key's
652 match. But if entry was set previously with HVhek_WASUTF8
653 and key now doesn't (or vice versa) then we should change
654 the key's flag, as this is assignment. */
655 if (HvSHAREKEYS(hv)) {
656 /* Need to swap the key we have for a key with the flags we
657 need. As keys are shared we can't just write to the
658 flag, so we share the new one, unshare the old one. */
659 HEK * const new_hek = share_hek_flags(key, klen, hash,
661 unshare_hek (HeKEY_hek(entry));
662 HeKEY_hek(entry) = new_hek;
664 else if (hv == PL_strtab) {
665 /* PL_strtab is usually the only hash without HvSHAREKEYS,
666 so putting this test here is cheap */
667 if (flags & HVhek_FREEKEY)
669 Perl_croak(aTHX_ S_strtab_error,
670 action & HV_FETCH_LVALUE ? "fetch" : "store");
673 HeKFLAGS(entry) = masked_flags;
674 if (masked_flags & HVhek_ENABLEHVKFLAGS)
677 if (HeVAL(entry) == &PL_sv_placeholder) {
678 /* yes, can store into placeholder slot */
679 if (action & HV_FETCH_LVALUE) {
681 /* This preserves behaviour with the old hv_fetch
682 implementation which at this point would bail out
683 with a break; (at "if we find a placeholder, we
684 pretend we haven't found anything")
686 That break mean that if a placeholder were found, it
687 caused a call into hv_store, which in turn would
688 check magic, and if there is no magic end up pretty
689 much back at this point (in hv_store's code). */
692 /* LVAL fetch which actually needs a store. */
694 HvPLACEHOLDERS(hv)--;
697 if (val != &PL_sv_placeholder)
698 HvPLACEHOLDERS(hv)--;
701 } else if (action & HV_FETCH_ISSTORE) {
702 SvREFCNT_dec(HeVAL(entry));
705 } else if (HeVAL(entry) == &PL_sv_placeholder) {
706 /* if we find a placeholder, we pretend we haven't found
710 if (flags & HVhek_FREEKEY)
713 return entry ? (void *) &HeVAL(entry) : NULL;
717 #ifdef DYNAMIC_ENV_FETCH /* %ENV lookup? If so, try to fetch the value now */
718 if (!(action & HV_FETCH_ISSTORE)
719 && SvRMAGICAL((const SV *)hv)
720 && mg_find((const SV *)hv, PERL_MAGIC_env)) {
722 const char * const env = PerlEnv_ENVgetenv_len(key,&len);
724 sv = newSVpvn(env,len);
726 return hv_common(hv, keysv, key, klen, flags,
727 HV_FETCH_ISSTORE|HV_DISABLE_UVAR_XKEY|return_svp,
733 if (!entry && SvREADONLY(hv) && !(action & HV_FETCH_ISEXISTS)) {
734 hv_notallowed(flags, key, klen,
735 "Attempt to access disallowed key '%"SVf"' in"
736 " a restricted hash");
738 if (!(action & (HV_FETCH_LVALUE|HV_FETCH_ISSTORE))) {
739 /* Not doing some form of store, so return failure. */
740 if (flags & HVhek_FREEKEY)
744 if (action & HV_FETCH_LVALUE) {
745 val = action & HV_FETCH_EMPTY_HE ? NULL : newSV(0);
747 /* At this point the old hv_fetch code would call to hv_store,
748 which in turn might do some tied magic. So we need to make that
749 magic check happen. */
750 /* gonna assign to this, so it better be there */
751 /* If a fetch-as-store fails on the fetch, then the action is to
752 recurse once into "hv_store". If we didn't do this, then that
753 recursive call would call the key conversion routine again.
754 However, as we replace the original key with the converted
755 key, this would result in a double conversion, which would show
756 up as a bug if the conversion routine is not idempotent. */
757 return hv_common(hv, keysv, key, klen, flags,
758 HV_FETCH_ISSTORE|HV_DISABLE_UVAR_XKEY|return_svp,
760 /* XXX Surely that could leak if the fetch-was-store fails?
761 Just like the hv_fetch. */
765 /* Welcome to hv_store... */
768 /* Not sure if we can get here. I think the only case of oentry being
769 NULL is for %ENV with dynamic env fetch. But that should disappear
770 with magic in the previous code. */
773 PERL_HV_ARRAY_ALLOC_BYTES(xhv->xhv_max+1 /* HvMAX(hv)+1 */),
775 HvARRAY(hv) = (HE**)array;
778 oentry = &(HvARRAY(hv))[hash & (I32) xhv->xhv_max];
781 /* share_hek_flags will do the free for us. This might be considered
784 HeKEY_hek(entry) = share_hek_flags(key, klen, hash, flags);
785 else if (hv == PL_strtab) {
786 /* PL_strtab is usually the only hash without HvSHAREKEYS, so putting
787 this test here is cheap */
788 if (flags & HVhek_FREEKEY)
790 Perl_croak(aTHX_ S_strtab_error,
791 action & HV_FETCH_LVALUE ? "fetch" : "store");
793 else /* gotta do the real thing */
794 HeKEY_hek(entry) = save_hek_flags(key, klen, hash, flags);
796 HeNEXT(entry) = *oentry;
799 if (val == &PL_sv_placeholder)
800 HvPLACEHOLDERS(hv)++;
801 if (masked_flags & HVhek_ENABLEHVKFLAGS)
805 const HE *counter = HeNEXT(entry);
807 xhv->xhv_keys++; /* HvTOTALKEYS(hv)++ */
808 if (!counter) { /* initial entry? */
809 } else if (xhv->xhv_keys > xhv->xhv_max) {
810 /* Use only the old HvUSEDKEYS(hv) > HvMAX(hv) condition to limit
811 bucket splits on a rehashed hash, as we're not going to
812 split it again, and if someone is lucky (evil) enough to
813 get all the keys in one list they could exhaust our memory
814 as we repeatedly double the number of buckets on every
815 entry. Linear search feels a less worse thing to do. */
817 } else if(!HvREHASH(hv)) {
820 while ((counter = HeNEXT(counter)))
823 if (n_links > HV_MAX_LENGTH_BEFORE_SPLIT) {
830 return entry ? (void *) &HeVAL(entry) : NULL;
832 return (void *) entry;
836 S_hv_magic_check(HV *hv, bool *needs_copy, bool *needs_store)
838 const MAGIC *mg = SvMAGIC(hv);
840 PERL_ARGS_ASSERT_HV_MAGIC_CHECK;
845 if (isUPPER(mg->mg_type)) {
847 if (mg->mg_type == PERL_MAGIC_tied) {
848 *needs_store = FALSE;
849 return; /* We've set all there is to set. */
852 mg = mg->mg_moremagic;
857 =for apidoc hv_scalar
859 Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
865 Perl_hv_scalar(pTHX_ HV *hv)
869 PERL_ARGS_ASSERT_HV_SCALAR;
871 if (SvRMAGICAL(hv)) {
872 MAGIC * const mg = mg_find((const SV *)hv, PERL_MAGIC_tied);
874 return magic_scalarpack(hv, mg);
878 if (HvTOTALKEYS((const HV *)hv))
879 Perl_sv_setpvf(aTHX_ sv, "%ld/%ld",
880 (long)HvFILL(hv), (long)HvMAX(hv) + 1);
888 =for apidoc hv_delete
890 Deletes a key/value pair in the hash. The value's SV is removed from
891 the hash, made mortal, and returned to the caller. The absolute
892 value of C<klen> is the length of the key. If C<klen> is negative the
893 key is assumed to be in UTF-8-encoded Unicode. The C<flags> value
894 will normally be zero; if set to G_DISCARD then NULL will be returned.
895 NULL will also be returned if the key is not found.
897 =for apidoc hv_delete_ent
899 Deletes a key/value pair in the hash. The value SV is removed from the hash,
900 made mortal, and returned to the caller. The C<flags> value will normally be
901 zero; if set to G_DISCARD then NULL will be returned. NULL will also be
902 returned if the key is not found. C<hash> can be a valid precomputed hash
903 value, or 0 to ask for it to be computed.
909 S_hv_delete_common(pTHX_ HV *hv, SV *keysv, const char *key, STRLEN klen,
910 int k_flags, I32 d_flags, U32 hash)
916 bool is_utf8 = (k_flags & HVhek_UTF8) ? TRUE : FALSE;
919 if (SvRMAGICAL(hv)) {
922 hv_magic_check (hv, &needs_copy, &needs_store);
926 entry = (HE *) hv_common(hv, keysv, key, klen,
927 k_flags & ~HVhek_FREEKEY,
928 HV_FETCH_LVALUE|HV_DISABLE_UVAR_XKEY,
930 sv = entry ? HeVAL(entry) : NULL;
936 if (mg_find(sv, PERL_MAGIC_tiedelem)) {
937 /* No longer an element */
938 sv_unmagic(sv, PERL_MAGIC_tiedelem);
941 return NULL; /* element cannot be deleted */
943 #ifdef ENV_IS_CASELESS
944 else if (mg_find((const SV *)hv, PERL_MAGIC_env)) {
945 /* XXX This code isn't UTF8 clean. */
946 keysv = newSVpvn_flags(key, klen, SVs_TEMP);
947 if (k_flags & HVhek_FREEKEY) {
950 key = strupr(SvPVX(keysv));
959 xhv = (XPVHV*)SvANY(hv);
964 const char * const keysave = key;
965 key = (char*)bytes_from_utf8((U8*)key, &klen, &is_utf8);
968 k_flags |= HVhek_UTF8;
970 k_flags &= ~HVhek_UTF8;
971 if (key != keysave) {
972 if (k_flags & HVhek_FREEKEY) {
973 /* This shouldn't happen if our caller does what we expect,
974 but strictly the API allows it. */
977 k_flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
979 HvHASKFLAGS_on(MUTABLE_SV(hv));
982 if (HvREHASH(hv) || (!hash && !(keysv && (SvIsCOW_shared_hash(keysv)))))
983 PERL_HASH_INTERNAL_(hash, key, klen, HvREHASH(hv));
985 hash = SvSHARED_HASH(keysv);
987 masked_flags = (k_flags & HVhek_MASK);
989 oentry = &(HvARRAY(hv))[hash & (I32) HvMAX(hv)];
991 for (; entry; oentry = &HeNEXT(entry), entry = *oentry) {
993 U8 mro_changes = 0; /* 1 = isa; 2 = package moved */
997 if (HeHASH(entry) != hash) /* strings can't be equal */
999 if (HeKLEN(entry) != (I32)klen)
1001 if (HeKEY(entry) != key && memNE(HeKEY(entry),key,klen)) /* is this it? */
1003 if ((HeKFLAGS(entry) ^ masked_flags) & HVhek_UTF8)
1006 if (hv == PL_strtab) {
1007 if (k_flags & HVhek_FREEKEY)
1009 Perl_croak(aTHX_ S_strtab_error, "delete");
1012 /* if placeholder is here, it's already been deleted.... */
1013 if (HeVAL(entry) == &PL_sv_placeholder) {
1014 if (k_flags & HVhek_FREEKEY)
1018 if (SvREADONLY(hv) && HeVAL(entry) && SvREADONLY(HeVAL(entry))
1019 && !SvIsCOW(HeVAL(entry))) {
1020 hv_notallowed(k_flags, key, klen,
1021 "Attempt to delete readonly key '%"SVf"' from"
1022 " a restricted hash");
1024 if (k_flags & HVhek_FREEKEY)
1027 /* If this is a stash and the key ends with ::, then someone is
1028 * deleting a package.
1030 if (HeVAL(entry) && HvENAME_get(hv)) {
1031 gv = (GV *)HeVAL(entry);
1032 if (keysv) key = SvPV(keysv, klen);
1034 (klen > 1 && key[klen-2] == ':' && key[klen-1] == ':')
1036 (klen == 1 && key[0] == ':')
1038 && (klen != 6 || hv!=PL_defstash || memNE(key,"main::",6))
1039 && SvTYPE(gv) == SVt_PVGV && (stash = GvHV((GV *)gv))
1040 && HvENAME_get(stash)) {
1041 /* A previous version of this code checked that the
1042 * GV was still in the symbol table by fetching the
1043 * GV with its name. That is not necessary (and
1044 * sometimes incorrect), as HvENAME cannot be set
1045 * on hv if it is not in the symtab. */
1047 /* Hang on to it for a bit. */
1048 SvREFCNT_inc_simple_void_NN(
1049 sv_2mortal((SV *)gv)
1052 else if (klen == 3 && strnEQ(key, "ISA", 3))
1056 sv = d_flags & G_DISCARD ? HeVAL(entry) : sv_2mortal(HeVAL(entry));
1057 HeVAL(entry) = &PL_sv_placeholder;
1059 /* deletion of method from stash */
1060 if (isGV(sv) && isGV_with_GP(sv) && GvCVu(sv)
1062 mro_method_changed_in(hv);
1066 * If a restricted hash, rather than really deleting the entry, put
1067 * a placeholder there. This marks the key as being "approved", so
1068 * we can still access via not-really-existing key without raising
1072 /* We'll be saving this slot, so the number of allocated keys
1073 * doesn't go down, but the number placeholders goes up */
1074 HvPLACEHOLDERS(hv)++;
1076 *oentry = HeNEXT(entry);
1077 if (SvOOK(hv) && entry == HvAUX(hv)->xhv_eiter /* HvEITER(hv) */)
1080 if (SvOOK(hv) && HvLAZYDEL(hv) &&
1081 entry == HeNEXT(HvAUX(hv)->xhv_eiter))
1082 HeNEXT(HvAUX(hv)->xhv_eiter) = HeNEXT(entry);
1083 hv_free_ent(hv, entry);
1085 xhv->xhv_keys--; /* HvTOTALKEYS(hv)-- */
1086 if (xhv->xhv_keys == 0)
1087 HvHASKFLAGS_off(hv);
1090 if (d_flags & G_DISCARD) {
1095 if (mro_changes == 1) mro_isa_changed_in(hv);
1096 else if (mro_changes == 2)
1097 mro_package_moved(NULL, stash, gv, 1);
1101 if (SvREADONLY(hv)) {
1102 hv_notallowed(k_flags, key, klen,
1103 "Attempt to delete disallowed key '%"SVf"' from"
1104 " a restricted hash");
1107 if (k_flags & HVhek_FREEKEY)
1113 S_hsplit(pTHX_ HV *hv)
1116 XPVHV* const xhv = (XPVHV*)SvANY(hv);
1117 const I32 oldsize = (I32) xhv->xhv_max+1; /* HvMAX(hv)+1 (sick) */
1118 I32 newsize = oldsize * 2;
1120 char *a = (char*) HvARRAY(hv);
1122 int longest_chain = 0;
1125 PERL_ARGS_ASSERT_HSPLIT;
1127 /*PerlIO_printf(PerlIO_stderr(), "hsplit called for %p which had %d\n",
1128 (void*)hv, (int) oldsize);*/
1130 if (HvPLACEHOLDERS_get(hv) && !SvREADONLY(hv)) {
1131 /* Can make this clear any placeholders first for non-restricted hashes,
1132 even though Storable rebuilds restricted hashes by putting in all the
1133 placeholders (first) before turning on the readonly flag, because
1134 Storable always pre-splits the hash. */
1135 hv_clear_placeholders(hv);
1139 #if defined(STRANGE_MALLOC) || defined(MYMALLOC)
1140 Renew(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1141 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
1147 Move(&a[oldsize * sizeof(HE*)], &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
1150 Newx(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1151 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
1156 Copy(HvARRAY(hv), a, oldsize * sizeof(HE*), char);
1158 Copy(HvAUX(hv), &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
1160 Safefree(HvARRAY(hv));
1164 Zero(&a[oldsize * sizeof(HE*)], (newsize-oldsize) * sizeof(HE*), char); /* zero 2nd half*/
1165 xhv->xhv_max = --newsize; /* HvMAX(hv) = --newsize */
1166 HvARRAY(hv) = (HE**) a;
1169 for (i=0; i<oldsize; i++,aep++) {
1170 int left_length = 0;
1171 int right_length = 0;
1176 if (!entry) /* non-existent */
1180 if ((HeHASH(entry) & newsize) != (U32)i) {
1181 *oentry = HeNEXT(entry);
1182 HeNEXT(entry) = *bep;
1187 oentry = &HeNEXT(entry);
1192 /* I think we don't actually need to keep track of the longest length,
1193 merely flag if anything is too long. But for the moment while
1194 developing this code I'll track it. */
1195 if (left_length > longest_chain)
1196 longest_chain = left_length;
1197 if (right_length > longest_chain)
1198 longest_chain = right_length;
1202 /* Pick your policy for "hashing isn't working" here: */
1203 if (longest_chain <= HV_MAX_LENGTH_BEFORE_SPLIT /* split worked? */
1208 if (hv == PL_strtab) {
1209 /* Urg. Someone is doing something nasty to the string table.
1214 /* Awooga. Awooga. Pathological data. */
1215 /*PerlIO_printf(PerlIO_stderr(), "%p %d of %d with %d/%d buckets\n", (void*)hv,
1216 longest_chain, HvTOTALKEYS(hv), HvFILL(hv), 1+HvMAX(hv));*/
1219 Newxz(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1220 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
1222 Copy(HvAUX(hv), &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
1225 was_shared = HvSHAREKEYS(hv);
1227 HvSHAREKEYS_off(hv);
1232 for (i=0; i<newsize; i++,aep++) {
1235 /* We're going to trash this HE's next pointer when we chain it
1236 into the new hash below, so store where we go next. */
1237 HE * const next = HeNEXT(entry);
1242 PERL_HASH_INTERNAL(hash, HeKEY(entry), HeKLEN(entry));
1247 = save_hek_flags(HeKEY(entry), HeKLEN(entry),
1248 hash, HeKFLAGS(entry));
1249 unshare_hek (HeKEY_hek(entry));
1250 HeKEY_hek(entry) = new_hek;
1252 /* Not shared, so simply write the new hash in. */
1253 HeHASH(entry) = hash;
1255 /*PerlIO_printf(PerlIO_stderr(), "%d ", HeKFLAGS(entry));*/
1256 HEK_REHASH_on(HeKEY_hek(entry));
1257 /*PerlIO_printf(PerlIO_stderr(), "%d\n", HeKFLAGS(entry));*/
1259 /* Copy oentry to the correct new chain. */
1260 bep = ((HE**)a) + (hash & (I32) xhv->xhv_max);
1261 HeNEXT(entry) = *bep;
1267 Safefree (HvARRAY(hv));
1268 HvARRAY(hv) = (HE **)a;
1272 Perl_hv_ksplit(pTHX_ HV *hv, IV newmax)
1275 XPVHV* xhv = (XPVHV*)SvANY(hv);
1276 const I32 oldsize = (I32) xhv->xhv_max+1; /* HvMAX(hv)+1 (sick) */
1282 PERL_ARGS_ASSERT_HV_KSPLIT;
1284 newsize = (I32) newmax; /* possible truncation here */
1285 if (newsize != newmax || newmax <= oldsize)
1287 while ((newsize & (1 + ~newsize)) != newsize) {
1288 newsize &= ~(newsize & (1 + ~newsize)); /* get proper power of 2 */
1290 if (newsize < newmax)
1292 if (newsize < newmax)
1293 return; /* overflow detection */
1295 a = (char *) HvARRAY(hv);
1298 #if defined(STRANGE_MALLOC) || defined(MYMALLOC)
1299 Renew(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1300 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
1306 Copy(&a[oldsize * sizeof(HE*)], &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
1309 Newx(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1310 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
1315 Copy(HvARRAY(hv), a, oldsize * sizeof(HE*), char);
1317 Copy(HvAUX(hv), &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
1319 Safefree(HvARRAY(hv));
1322 Zero(&a[oldsize * sizeof(HE*)], (newsize-oldsize) * sizeof(HE*), char); /* zero 2nd half*/
1325 Newxz(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize), char);
1327 xhv->xhv_max = --newsize; /* HvMAX(hv) = --newsize */
1328 HvARRAY(hv) = (HE **) a;
1329 if (!xhv->xhv_keys /* !HvTOTALKEYS(hv) */) /* skip rest if no entries */
1333 for (i=0; i<oldsize; i++,aep++) {
1337 if (!entry) /* non-existent */
1340 I32 j = (HeHASH(entry) & newsize);
1344 *oentry = HeNEXT(entry);
1345 HeNEXT(entry) = aep[j];
1349 oentry = &HeNEXT(entry);
1356 Perl_newHVhv(pTHX_ HV *ohv)
1359 HV * const hv = newHV();
1362 if (!ohv || (!HvTOTALKEYS(ohv) && !SvMAGICAL((const SV *)ohv)))
1364 hv_max = HvMAX(ohv);
1366 if (!SvMAGICAL((const SV *)ohv)) {
1367 /* It's an ordinary hash, so copy it fast. AMS 20010804 */
1369 const bool shared = !!HvSHAREKEYS(ohv);
1370 HE **ents, ** const oents = (HE **)HvARRAY(ohv);
1372 Newx(a, PERL_HV_ARRAY_ALLOC_BYTES(hv_max+1), char);
1375 /* In each bucket... */
1376 for (i = 0; i <= hv_max; i++) {
1378 HE *oent = oents[i];
1385 /* Copy the linked list of entries. */
1386 for (; oent; oent = HeNEXT(oent)) {
1387 const U32 hash = HeHASH(oent);
1388 const char * const key = HeKEY(oent);
1389 const STRLEN len = HeKLEN(oent);
1390 const int flags = HeKFLAGS(oent);
1391 HE * const ent = new_HE();
1392 SV *const val = HeVAL(oent);
1394 HeVAL(ent) = SvIMMORTAL(val) ? val : newSVsv(val);
1396 = shared ? share_hek_flags(key, len, hash, flags)
1397 : save_hek_flags(key, len, hash, flags);
1408 HvTOTALKEYS(hv) = HvTOTALKEYS(ohv);
1412 /* Iterate over ohv, copying keys and values one at a time. */
1414 const I32 riter = HvRITER_get(ohv);
1415 HE * const eiter = HvEITER_get(ohv);
1416 STRLEN hv_fill = HvFILL(ohv);
1418 /* Can we use fewer buckets? (hv_max is always 2^n-1) */
1419 while (hv_max && hv_max + 1 >= hv_fill * 2)
1420 hv_max = hv_max / 2;
1424 while ((entry = hv_iternext_flags(ohv, 0))) {
1425 SV *val = hv_iterval(ohv,entry);
1426 SV * const keysv = HeSVKEY(entry);
1427 val = SvIMMORTAL(val) ? val : newSVsv(val);
1429 (void)hv_store_ent(hv, keysv, val, 0);
1431 (void)hv_store_flags(hv, HeKEY(entry), HeKLEN(entry), val,
1432 HeHASH(entry), HeKFLAGS(entry));
1434 HvRITER_set(ohv, riter);
1435 HvEITER_set(ohv, eiter);
1442 =for apidoc Am|HV *|hv_copy_hints_hv|HV *ohv
1444 A specialised version of L</newHVhv> for copying C<%^H>. I<ohv> must be
1445 a pointer to a hash (which may have C<%^H> magic, but should be generally
1446 non-magical), or C<NULL> (interpreted as an empty hash). The content
1447 of I<ohv> is copied to a new hash, which has the C<%^H>-specific magic
1448 added to it. A pointer to the new hash is returned.
1454 Perl_hv_copy_hints_hv(pTHX_ HV *const ohv)
1456 HV * const hv = newHV();
1459 STRLEN hv_max = HvMAX(ohv);
1460 STRLEN hv_fill = HvFILL(ohv);
1462 const I32 riter = HvRITER_get(ohv);
1463 HE * const eiter = HvEITER_get(ohv);
1468 while (hv_max && hv_max + 1 >= hv_fill * 2)
1469 hv_max = hv_max / 2;
1473 while ((entry = hv_iternext_flags(ohv, 0))) {
1474 SV *const sv = newSVsv(hv_iterval(ohv,entry));
1475 SV *heksv = HeSVKEY(entry);
1476 if (!heksv && sv) heksv = newSVhek(HeKEY_hek(entry));
1477 if (sv) sv_magic(sv, NULL, PERL_MAGIC_hintselem,
1478 (char *)heksv, HEf_SVKEY);
1479 if (heksv == HeSVKEY(entry))
1480 (void)hv_store_ent(hv, heksv, sv, 0);
1482 (void)hv_common(hv, heksv, HeKEY(entry), HeKLEN(entry),
1483 HeKFLAGS(entry), HV_FETCH_ISSTORE|HV_FETCH_JUST_SV, sv, HeHASH(entry));
1484 SvREFCNT_dec(heksv);
1487 HvRITER_set(ohv, riter);
1488 HvEITER_set(ohv, eiter);
1490 SvREFCNT_inc_simple_void_NN(hv);
1493 hv_magic(hv, NULL, PERL_MAGIC_hints);
1497 /* like hv_free_ent, but returns the SV rather than freeing it */
1499 S_hv_free_ent_ret(pTHX_ HV *hv, register HE *entry)
1504 PERL_ARGS_ASSERT_HV_FREE_ENT_RET;
1509 if (HeKLEN(entry) == HEf_SVKEY) {
1510 SvREFCNT_dec(HeKEY_sv(entry));
1511 Safefree(HeKEY_hek(entry));
1513 else if (HvSHAREKEYS(hv))
1514 unshare_hek(HeKEY_hek(entry));
1516 Safefree(HeKEY_hek(entry));
1523 Perl_hv_free_ent(pTHX_ HV *hv, register HE *entry)
1528 PERL_ARGS_ASSERT_HV_FREE_ENT;
1532 val = hv_free_ent_ret(hv, entry);
1538 Perl_hv_delayfree_ent(pTHX_ HV *hv, register HE *entry)
1542 PERL_ARGS_ASSERT_HV_DELAYFREE_ENT;
1546 /* SvREFCNT_inc to counter the SvREFCNT_dec in hv_free_ent */
1547 sv_2mortal(SvREFCNT_inc(HeVAL(entry))); /* free between statements */
1548 if (HeKLEN(entry) == HEf_SVKEY) {
1549 sv_2mortal(SvREFCNT_inc(HeKEY_sv(entry)));
1551 hv_free_ent(hv, entry);
1555 =for apidoc hv_clear
1557 Frees the all the elements of a hash, leaving it empty.
1558 The XS equivalent of C<%hash = ()>. See also L</hv_undef>.
1560 If any destructors are triggered as a result, the hv itself may
1567 Perl_hv_clear(pTHX_ HV *hv)
1574 DEBUG_A(Perl_hv_assert(aTHX_ hv));
1576 xhv = (XPVHV*)SvANY(hv);
1579 SAVEFREESV(SvREFCNT_inc_simple_NN(hv));
1580 if (SvREADONLY(hv) && HvARRAY(hv) != NULL) {
1581 /* restricted hash: convert all keys to placeholders */
1583 for (i = 0; i <= xhv->xhv_max; i++) {
1584 HE *entry = (HvARRAY(hv))[i];
1585 for (; entry; entry = HeNEXT(entry)) {
1586 /* not already placeholder */
1587 if (HeVAL(entry) != &PL_sv_placeholder) {
1588 if (HeVAL(entry) && SvREADONLY(HeVAL(entry))
1589 && !SvIsCOW(HeVAL(entry))) {
1590 SV* const keysv = hv_iterkeysv(entry);
1592 "Attempt to delete readonly key '%"SVf"' from a restricted hash",
1595 SvREFCNT_dec(HeVAL(entry));
1596 HeVAL(entry) = &PL_sv_placeholder;
1597 HvPLACEHOLDERS(hv)++;
1604 HvPLACEHOLDERS_set(hv, 0);
1607 mg_clear(MUTABLE_SV(hv));
1609 HvHASKFLAGS_off(hv);
1614 mro_isa_changed_in(hv);
1615 HvEITER_set(hv, NULL);
1621 =for apidoc hv_clear_placeholders
1623 Clears any placeholders from a hash. If a restricted hash has any of its keys
1624 marked as readonly and the key is subsequently deleted, the key is not actually
1625 deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
1626 it so it will be ignored by future operations such as iterating over the hash,
1627 but will still allow the hash to have a value reassigned to the key at some
1628 future point. This function clears any such placeholder keys from the hash.
1629 See Hash::Util::lock_keys() for an example of its use.
1635 Perl_hv_clear_placeholders(pTHX_ HV *hv)
1638 const U32 items = (U32)HvPLACEHOLDERS_get(hv);
1640 PERL_ARGS_ASSERT_HV_CLEAR_PLACEHOLDERS;
1643 clear_placeholders(hv, items);
1647 S_clear_placeholders(pTHX_ HV *hv, U32 items)
1652 PERL_ARGS_ASSERT_CLEAR_PLACEHOLDERS;
1659 /* Loop down the linked list heads */
1660 HE **oentry = &(HvARRAY(hv))[i];
1663 while ((entry = *oentry)) {
1664 if (HeVAL(entry) == &PL_sv_placeholder) {
1665 *oentry = HeNEXT(entry);
1666 if (entry == HvEITER_get(hv))
1669 if (SvOOK(hv) && HvLAZYDEL(hv) &&
1670 entry == HeNEXT(HvAUX(hv)->xhv_eiter))
1671 HeNEXT(HvAUX(hv)->xhv_eiter) = HeNEXT(entry);
1672 hv_free_ent(hv, entry);
1677 HvTOTALKEYS(hv) -= (IV)HvPLACEHOLDERS_get(hv);
1678 if (HvUSEDKEYS(hv) == 0)
1679 HvHASKFLAGS_off(hv);
1680 HvPLACEHOLDERS_set(hv, 0);
1684 oentry = &HeNEXT(entry);
1688 /* You can't get here, hence assertion should always fail. */
1689 assert (items == 0);
1694 S_hfreeentries(pTHX_ HV *hv)
1697 XPVHV * const xhv = (XPVHV*)SvANY(hv);
1700 PERL_ARGS_ASSERT_HFREEENTRIES;
1702 while ((sv = Perl_hfree_next_entry(aTHX_ hv, &index))||xhv->xhv_keys) {
1708 /* hfree_next_entry()
1709 * For use only by S_hfreeentries() and sv_clear().
1710 * Delete the next available HE from hv and return the associated SV.
1711 * Returns null on empty hash. Nevertheless null is not a reliable
1712 * indicator that the hash is empty, as the deleted entry may have a
1714 * indexp is a pointer to the current index into HvARRAY. The index should
1715 * initially be set to 0. hfree_next_entry() may update it. */
1718 Perl_hfree_next_entry(pTHX_ HV *hv, STRLEN *indexp)
1720 struct xpvhv_aux *iter;
1724 STRLEN orig_index = *indexp;
1727 PERL_ARGS_ASSERT_HFREE_NEXT_ENTRY;
1729 if (SvOOK(hv) && ((iter = HvAUX(hv)))
1730 && ((entry = iter->xhv_eiter)) )
1732 /* the iterator may get resurrected after each
1733 * destructor call, so check each time */
1734 if (entry && HvLAZYDEL(hv)) { /* was deleted earlier? */
1736 hv_free_ent(hv, entry);
1737 /* warning: at this point HvARRAY may have been
1738 * re-allocated, HvMAX changed etc */
1740 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
1741 iter->xhv_eiter = NULL; /* HvEITER(hv) = NULL */
1744 if (!((XPVHV*)SvANY(hv))->xhv_keys)
1747 array = HvARRAY(hv);
1749 while ( ! ((entry = array[*indexp])) ) {
1750 if ((*indexp)++ >= HvMAX(hv))
1752 assert(*indexp != orig_index);
1754 array[*indexp] = HeNEXT(entry);
1755 ((XPVHV*) SvANY(hv))->xhv_keys--;
1757 if ( PL_phase != PERL_PHASE_DESTRUCT && HvENAME(hv)
1758 && HeVAL(entry) && isGV(HeVAL(entry))
1759 && GvHV(HeVAL(entry)) && HvENAME(GvHV(HeVAL(entry)))
1762 const char * const key = HePV(entry,klen);
1763 if ((klen > 1 && key[klen-1]==':' && key[klen-2]==':')
1764 || (klen == 1 && key[0] == ':')) {
1766 NULL, GvHV(HeVAL(entry)),
1767 (GV *)HeVAL(entry), 0
1771 return hv_free_ent_ret(hv, entry);
1776 =for apidoc hv_undef
1778 Undefines the hash. The XS equivalent of C<undef(%hash)>.
1780 As well as freeing all the elements of the hash (like hv_clear()), this
1781 also frees any auxiliary data and storage associated with the hash.
1783 If any destructors are triggered as a result, the hv itself may
1786 See also L</hv_clear>.
1792 Perl_hv_undef_flags(pTHX_ HV *hv, U32 flags)
1797 const bool save = !!SvREFCNT(hv);
1801 DEBUG_A(Perl_hv_assert(aTHX_ hv));
1802 xhv = (XPVHV*)SvANY(hv);
1804 /* The name must be deleted before the call to hfreeeeentries so that
1805 CVs are anonymised properly. But the effective name must be pre-
1806 served until after that call (and only deleted afterwards if the
1807 call originated from sv_clear). For stashes with one name that is
1808 both the canonical name and the effective name, hv_name_set has to
1809 allocate an array for storing the effective name. We can skip that
1810 during global destruction, as it does not matter where the CVs point
1811 if they will be freed anyway. */
1812 /* note that the code following prior to hfreeentries is duplicated
1813 * in sv_clear(), and changes here should be done there too */
1814 if (PL_phase != PERL_PHASE_DESTRUCT && (name = HvNAME(hv))) {
1815 if (PL_stashcache) {
1816 DEBUG_o(Perl_deb(aTHX_ "hv_undef_flags clearing PL_stashcache for '%"
1817 HEKf"'\n", HvNAME_HEK(hv)));
1818 (void)hv_delete(PL_stashcache, name,
1819 HEK_UTF8(HvNAME_HEK(hv)) ? -HvNAMELEN_get(hv) : HvNAMELEN_get(hv),
1823 hv_name_set(hv, NULL, 0, 0);
1827 SAVEFREESV(SvREFCNT_inc_simple_NN(hv));
1831 struct xpvhv_aux * const aux = HvAUX(hv);
1832 struct mro_meta *meta;
1834 if ((name = HvENAME_get(hv))) {
1835 if (PL_phase != PERL_PHASE_DESTRUCT)
1836 mro_isa_changed_in(hv);
1837 if (PL_stashcache) {
1838 DEBUG_o(Perl_deb(aTHX_ "hv_undef_flags clearing PL_stashcache for effective name '%"
1839 HEKf"'\n", HvENAME_HEK(hv)));
1841 PL_stashcache, name,
1842 HEK_UTF8(HvENAME_HEK(hv)) ? -HvENAMELEN_get(hv) : HvENAMELEN_get(hv),
1848 /* If this call originated from sv_clear, then we must check for
1849 * effective names that need freeing, as well as the usual name. */
1851 if (flags & HV_NAME_SETALL ? !!aux->xhv_name_u.xhvnameu_name : !!name) {
1852 if (name && PL_stashcache) {
1853 DEBUG_o(Perl_deb(aTHX_ "hv_undef_flags clearing PL_stashcache for name '%"
1854 HEKf"'\n", HvNAME_HEK(hv)));
1855 (void)hv_delete(PL_stashcache, name, (HEK_UTF8(HvNAME_HEK(hv)) ? -HvNAMELEN_get(hv) : HvNAMELEN_get(hv)), G_DISCARD);
1857 hv_name_set(hv, NULL, 0, flags);
1859 if((meta = aux->xhv_mro_meta)) {
1860 if (meta->mro_linear_all) {
1861 SvREFCNT_dec(MUTABLE_SV(meta->mro_linear_all));
1862 meta->mro_linear_all = NULL;
1863 /* This is just acting as a shortcut pointer. */
1864 meta->mro_linear_current = NULL;
1865 } else if (meta->mro_linear_current) {
1866 /* Only the current MRO is stored, so this owns the data.
1868 SvREFCNT_dec(meta->mro_linear_current);
1869 meta->mro_linear_current = NULL;
1871 SvREFCNT_dec(meta->mro_nextmethod);
1872 SvREFCNT_dec(meta->isa);
1874 aux->xhv_mro_meta = NULL;
1876 SvREFCNT_dec(aux->xhv_super);
1877 if (!aux->xhv_name_u.xhvnameu_name && ! aux->xhv_backreferences)
1878 SvFLAGS(hv) &= ~SVf_OOK;
1881 Safefree(HvARRAY(hv));
1882 xhv->xhv_max = 7; /* HvMAX(hv) = 7 (it's a normal hash) */
1885 /* if we're freeing the HV, the SvMAGIC field has been reused for
1886 * other purposes, and so there can't be any placeholder magic */
1888 HvPLACEHOLDERS_set(hv, 0);
1891 mg_clear(MUTABLE_SV(hv));
1898 Returns the number of hash buckets that happen to be in use. This function is
1899 wrapped by the macro C<HvFILL>.
1901 Previously this value was stored in the HV structure, rather than being
1902 calculated on demand.
1908 Perl_hv_fill(pTHX_ HV const *const hv)
1911 HE **ents = HvARRAY(hv);
1913 PERL_ARGS_ASSERT_HV_FILL;
1916 HE *const *const last = ents + HvMAX(hv);
1917 count = last + 1 - ents;
1922 } while (++ents <= last);
1927 static struct xpvhv_aux*
1928 S_hv_auxinit(HV *hv) {
1929 struct xpvhv_aux *iter;
1932 PERL_ARGS_ASSERT_HV_AUXINIT;
1935 Newxz(array, PERL_HV_ARRAY_ALLOC_BYTES(HvMAX(hv) + 1)
1936 + sizeof(struct xpvhv_aux), char);
1938 array = (char *) HvARRAY(hv);
1939 Renew(array, PERL_HV_ARRAY_ALLOC_BYTES(HvMAX(hv) + 1)
1940 + sizeof(struct xpvhv_aux), char);
1942 HvARRAY(hv) = (HE**) array;
1946 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
1947 iter->xhv_eiter = NULL; /* HvEITER(hv) = NULL */
1948 iter->xhv_name_u.xhvnameu_name = 0;
1949 iter->xhv_name_count = 0;
1950 iter->xhv_backreferences = 0;
1951 iter->xhv_mro_meta = NULL;
1952 iter->xhv_super = NULL;
1957 =for apidoc hv_iterinit
1959 Prepares a starting point to traverse a hash table. Returns the number of
1960 keys in the hash (i.e. the same as C<HvUSEDKEYS(hv)>). The return value is
1961 currently only meaningful for hashes without tie magic.
1963 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1964 hash buckets that happen to be in use. If you still need that esoteric
1965 value, you can get it through the macro C<HvFILL(hv)>.
1972 Perl_hv_iterinit(pTHX_ HV *hv)
1974 PERL_ARGS_ASSERT_HV_ITERINIT;
1976 /* FIXME: Are we not NULL, or do we croak? Place bets now! */
1979 Perl_croak(aTHX_ "Bad hash");
1982 struct xpvhv_aux * const iter = HvAUX(hv);
1983 HE * const entry = iter->xhv_eiter; /* HvEITER(hv) */
1984 if (entry && HvLAZYDEL(hv)) { /* was deleted earlier? */
1986 hv_free_ent(hv, entry);
1988 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
1989 iter->xhv_eiter = NULL; /* HvEITER(hv) = NULL */
1994 /* used to be xhv->xhv_fill before 5.004_65 */
1995 return HvTOTALKEYS(hv);
1999 Perl_hv_riter_p(pTHX_ HV *hv) {
2000 struct xpvhv_aux *iter;
2002 PERL_ARGS_ASSERT_HV_RITER_P;
2005 Perl_croak(aTHX_ "Bad hash");
2007 iter = SvOOK(hv) ? HvAUX(hv) : hv_auxinit(hv);
2008 return &(iter->xhv_riter);
2012 Perl_hv_eiter_p(pTHX_ HV *hv) {
2013 struct xpvhv_aux *iter;
2015 PERL_ARGS_ASSERT_HV_EITER_P;
2018 Perl_croak(aTHX_ "Bad hash");
2020 iter = SvOOK(hv) ? HvAUX(hv) : hv_auxinit(hv);
2021 return &(iter->xhv_eiter);
2025 Perl_hv_riter_set(pTHX_ HV *hv, I32 riter) {
2026 struct xpvhv_aux *iter;
2028 PERL_ARGS_ASSERT_HV_RITER_SET;
2031 Perl_croak(aTHX_ "Bad hash");
2039 iter = hv_auxinit(hv);
2041 iter->xhv_riter = riter;
2045 Perl_hv_eiter_set(pTHX_ HV *hv, HE *eiter) {
2046 struct xpvhv_aux *iter;
2048 PERL_ARGS_ASSERT_HV_EITER_SET;
2051 Perl_croak(aTHX_ "Bad hash");
2056 /* 0 is the default so don't go malloc()ing a new structure just to
2061 iter = hv_auxinit(hv);
2063 iter->xhv_eiter = eiter;
2067 Perl_hv_name_set(pTHX_ HV *hv, const char *name, U32 len, U32 flags)
2070 struct xpvhv_aux *iter;
2074 PERL_ARGS_ASSERT_HV_NAME_SET;
2077 Perl_croak(aTHX_ "panic: hv name too long (%"UVuf")", (UV) len);
2081 if (iter->xhv_name_u.xhvnameu_name) {
2082 if(iter->xhv_name_count) {
2083 if(flags & HV_NAME_SETALL) {
2084 HEK ** const name = HvAUX(hv)->xhv_name_u.xhvnameu_names;
2085 HEK **hekp = name + (
2086 iter->xhv_name_count < 0
2087 ? -iter->xhv_name_count
2088 : iter->xhv_name_count
2090 while(hekp-- > name+1)
2091 unshare_hek_or_pvn(*hekp, 0, 0, 0);
2092 /* The first elem may be null. */
2093 if(*name) unshare_hek_or_pvn(*name, 0, 0, 0);
2095 spot = &iter->xhv_name_u.xhvnameu_name;
2096 iter->xhv_name_count = 0;
2099 if(iter->xhv_name_count > 0) {
2100 /* shift some things over */
2102 iter->xhv_name_u.xhvnameu_names, iter->xhv_name_count + 1, HEK *
2104 spot = iter->xhv_name_u.xhvnameu_names;
2105 spot[iter->xhv_name_count] = spot[1];
2107 iter->xhv_name_count = -(iter->xhv_name_count + 1);
2109 else if(*(spot = iter->xhv_name_u.xhvnameu_names)) {
2110 unshare_hek_or_pvn(*spot, 0, 0, 0);
2114 else if (flags & HV_NAME_SETALL) {
2115 unshare_hek_or_pvn(iter->xhv_name_u.xhvnameu_name, 0, 0, 0);
2116 spot = &iter->xhv_name_u.xhvnameu_name;
2119 HEK * const existing_name = iter->xhv_name_u.xhvnameu_name;
2120 Newx(iter->xhv_name_u.xhvnameu_names, 2, HEK *);
2121 iter->xhv_name_count = -2;
2122 spot = iter->xhv_name_u.xhvnameu_names;
2123 spot[1] = existing_name;
2126 else { spot = &iter->xhv_name_u.xhvnameu_name; iter->xhv_name_count = 0; }
2131 iter = hv_auxinit(hv);
2132 spot = &iter->xhv_name_u.xhvnameu_name;
2134 PERL_HASH(hash, name, len);
2135 *spot = name ? share_hek(name, flags & SVf_UTF8 ? -(I32)len : (I32)len, hash) : NULL;
2139 This is basically sv_eq_flags() in sv.c, but we avoid the magic
2144 hek_eq_pvn_flags(pTHX_ const HEK *hek, const char* pv, const I32 pvlen, const U32 flags) {
2145 if ( (HEK_UTF8(hek) ? 1 : 0) != (flags & SVf_UTF8 ? 1 : 0) ) {
2146 if (flags & SVf_UTF8)
2147 return (bytes_cmp_utf8(
2148 (const U8*)HEK_KEY(hek), HEK_LEN(hek),
2149 (const U8*)pv, pvlen) == 0);
2151 return (bytes_cmp_utf8(
2152 (const U8*)pv, pvlen,
2153 (const U8*)HEK_KEY(hek), HEK_LEN(hek)) == 0);
2156 return HEK_LEN(hek) == pvlen && ((HEK_KEY(hek) == pv)
2157 || memEQ(HEK_KEY(hek), pv, pvlen));
2161 =for apidoc hv_ename_add
2163 Adds a name to a stash's internal list of effective names. See
2166 This is called when a stash is assigned to a new location in the symbol
2173 Perl_hv_ename_add(pTHX_ HV *hv, const char *name, U32 len, U32 flags)
2176 struct xpvhv_aux *aux = SvOOK(hv) ? HvAUX(hv) : hv_auxinit(hv);
2179 PERL_ARGS_ASSERT_HV_ENAME_ADD;
2182 Perl_croak(aTHX_ "panic: hv name too long (%"UVuf")", (UV) len);
2184 PERL_HASH(hash, name, len);
2186 if (aux->xhv_name_count) {
2187 HEK ** const xhv_name = aux->xhv_name_u.xhvnameu_names;
2188 I32 count = aux->xhv_name_count;
2189 HEK **hekp = xhv_name + (count < 0 ? -count : count);
2190 while (hekp-- > xhv_name)
2192 (HEK_UTF8(*hekp) || (flags & SVf_UTF8))
2193 ? hek_eq_pvn_flags(aTHX_ *hekp, name, (I32)len, flags)
2194 : (HEK_LEN(*hekp) == (I32)len && memEQ(HEK_KEY(*hekp), name, len))
2196 if (hekp == xhv_name && count < 0)
2197 aux->xhv_name_count = -count;
2200 if (count < 0) aux->xhv_name_count--, count = -count;
2201 else aux->xhv_name_count++;
2202 Renew(aux->xhv_name_u.xhvnameu_names, count + 1, HEK *);
2203 (aux->xhv_name_u.xhvnameu_names)[count] = share_hek(name, (flags & SVf_UTF8 ? -(I32)len : (I32)len), hash);
2206 HEK *existing_name = aux->xhv_name_u.xhvnameu_name;
2209 (HEK_UTF8(existing_name) || (flags & SVf_UTF8))
2210 ? hek_eq_pvn_flags(aTHX_ existing_name, name, (I32)len, flags)
2211 : (HEK_LEN(existing_name) == (I32)len && memEQ(HEK_KEY(existing_name), name, len))
2214 Newx(aux->xhv_name_u.xhvnameu_names, 2, HEK *);
2215 aux->xhv_name_count = existing_name ? 2 : -2;
2216 *aux->xhv_name_u.xhvnameu_names = existing_name;
2217 (aux->xhv_name_u.xhvnameu_names)[1] = share_hek(name, (flags & SVf_UTF8 ? -(I32)len : (I32)len), hash);
2222 =for apidoc hv_ename_delete
2224 Removes a name from a stash's internal list of effective names. If this is
2225 the name returned by C<HvENAME>, then another name in the list will take
2226 its place (C<HvENAME> will use it).
2228 This is called when a stash is deleted from the symbol table.
2234 Perl_hv_ename_delete(pTHX_ HV *hv, const char *name, U32 len, U32 flags)
2237 struct xpvhv_aux *aux;
2239 PERL_ARGS_ASSERT_HV_ENAME_DELETE;
2242 Perl_croak(aTHX_ "panic: hv name too long (%"UVuf")", (UV) len);
2244 if (!SvOOK(hv)) return;
2247 if (!aux->xhv_name_u.xhvnameu_name) return;
2249 if (aux->xhv_name_count) {
2250 HEK ** const namep = aux->xhv_name_u.xhvnameu_names;
2251 I32 const count = aux->xhv_name_count;
2252 HEK **victim = namep + (count < 0 ? -count : count);
2253 while (victim-- > namep + 1)
2255 (HEK_UTF8(*victim) || (flags & SVf_UTF8))
2256 ? hek_eq_pvn_flags(aTHX_ *victim, name, (I32)len, flags)
2257 : (HEK_LEN(*victim) == (I32)len && memEQ(HEK_KEY(*victim), name, len))
2259 unshare_hek_or_pvn(*victim, 0, 0, 0);
2260 if (count < 0) ++aux->xhv_name_count;
2261 else --aux->xhv_name_count;
2263 (aux->xhv_name_count == 1 || aux->xhv_name_count == -1)
2265 ) { /* if there are none left */
2267 aux->xhv_name_u.xhvnameu_names = NULL;
2268 aux->xhv_name_count = 0;
2271 /* Move the last one back to fill the empty slot. It
2272 does not matter what order they are in. */
2273 *victim = *(namep + (count < 0 ? -count : count) - 1);
2278 count > 0 && (HEK_UTF8(*namep) || (flags & SVf_UTF8))
2279 ? hek_eq_pvn_flags(aTHX_ *namep, name, (I32)len, flags)
2280 : (HEK_LEN(*namep) == (I32)len && memEQ(HEK_KEY(*namep), name, len))
2282 aux->xhv_name_count = -count;
2286 (HEK_UTF8(aux->xhv_name_u.xhvnameu_name) || (flags & SVf_UTF8))
2287 ? hek_eq_pvn_flags(aTHX_ aux->xhv_name_u.xhvnameu_name, name, (I32)len, flags)
2288 : (HEK_LEN(aux->xhv_name_u.xhvnameu_name) == (I32)len &&
2289 memEQ(HEK_KEY(aux->xhv_name_u.xhvnameu_name), name, len))
2291 HEK * const namehek = aux->xhv_name_u.xhvnameu_name;
2292 Newx(aux->xhv_name_u.xhvnameu_names, 1, HEK *);
2293 *aux->xhv_name_u.xhvnameu_names = namehek;
2294 aux->xhv_name_count = -1;
2299 Perl_hv_backreferences_p(pTHX_ HV *hv) {
2300 struct xpvhv_aux * const iter = SvOOK(hv) ? HvAUX(hv) : hv_auxinit(hv);
2302 PERL_ARGS_ASSERT_HV_BACKREFERENCES_P;
2303 PERL_UNUSED_CONTEXT;
2305 return &(iter->xhv_backreferences);
2309 Perl_hv_kill_backrefs(pTHX_ HV *hv) {
2312 PERL_ARGS_ASSERT_HV_KILL_BACKREFS;
2317 av = HvAUX(hv)->xhv_backreferences;
2320 HvAUX(hv)->xhv_backreferences = 0;
2321 Perl_sv_kill_backrefs(aTHX_ MUTABLE_SV(hv), av);
2322 if (SvTYPE(av) == SVt_PVAV)
2328 hv_iternext is implemented as a macro in hv.h
2330 =for apidoc hv_iternext
2332 Returns entries from a hash iterator. See C<hv_iterinit>.
2334 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
2335 iterator currently points to, without losing your place or invalidating your
2336 iterator. Note that in this case the current entry is deleted from the hash
2337 with your iterator holding the last reference to it. Your iterator is flagged
2338 to free the entry on the next call to C<hv_iternext>, so you must not discard
2339 your iterator immediately else the entry will leak - call C<hv_iternext> to
2340 trigger the resource deallocation.
2342 =for apidoc hv_iternext_flags
2344 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
2345 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
2346 set the placeholders keys (for restricted hashes) will be returned in addition
2347 to normal keys. By default placeholders are automatically skipped over.
2348 Currently a placeholder is implemented with a value that is
2349 C<&PL_sv_placeholder>. Note that the implementation of placeholders and
2350 restricted hashes may change, and the implementation currently is
2351 insufficiently abstracted for any change to be tidy.
2357 Perl_hv_iternext_flags(pTHX_ HV *hv, I32 flags)
2364 struct xpvhv_aux *iter;
2366 PERL_ARGS_ASSERT_HV_ITERNEXT_FLAGS;
2369 Perl_croak(aTHX_ "Bad hash");
2371 xhv = (XPVHV*)SvANY(hv);
2374 /* Too many things (well, pp_each at least) merrily assume that you can
2375 call hv_iternext without calling hv_iterinit, so we'll have to deal
2381 oldentry = entry = iter->xhv_eiter; /* HvEITER(hv) */
2382 if (SvMAGICAL(hv) && SvRMAGICAL(hv)) {
2383 if ( ( mg = mg_find((const SV *)hv, PERL_MAGIC_tied) ) ) {
2384 SV * const key = sv_newmortal();
2386 sv_setsv(key, HeSVKEY_force(entry));
2387 SvREFCNT_dec(HeSVKEY(entry)); /* get rid of previous key */
2388 HeSVKEY_set(entry, NULL);
2394 /* one HE per MAGICAL hash */
2395 iter->xhv_eiter = entry = new_HE(); /* HvEITER(hv) = new_HE() */
2396 HvLAZYDEL_on(hv); /* make sure entry gets freed */
2398 Newxz(k, HEK_BASESIZE + sizeof(const SV *), char);
2400 HeKEY_hek(entry) = hek;
2401 HeKLEN(entry) = HEf_SVKEY;
2403 magic_nextpack(MUTABLE_SV(hv),mg,key);
2405 /* force key to stay around until next time */
2406 HeSVKEY_set(entry, SvREFCNT_inc_simple_NN(key));
2407 return entry; /* beware, hent_val is not set */
2409 SvREFCNT_dec(HeVAL(entry));
2410 Safefree(HeKEY_hek(entry));
2412 iter->xhv_eiter = NULL; /* HvEITER(hv) = NULL */
2417 #if defined(DYNAMIC_ENV_FETCH) && !defined(__riscos__) /* set up %ENV for iteration */
2418 if (!entry && SvRMAGICAL((const SV *)hv)
2419 && mg_find((const SV *)hv, PERL_MAGIC_env)) {
2422 /* The prime_env_iter() on VMS just loaded up new hash values
2423 * so the iteration count needs to be reset back to the beginning
2427 oldentry = entry = iter->xhv_eiter; /* HvEITER(hv) */
2432 /* hv_iterinit now ensures this. */
2433 assert (HvARRAY(hv));
2435 /* At start of hash, entry is NULL. */
2438 entry = HeNEXT(entry);
2439 if (!(flags & HV_ITERNEXT_WANTPLACEHOLDERS)) {
2441 * Skip past any placeholders -- don't want to include them in
2444 while (entry && HeVAL(entry) == &PL_sv_placeholder) {
2445 entry = HeNEXT(entry);
2450 /* Skip the entire loop if the hash is empty. */
2451 if ((flags & HV_ITERNEXT_WANTPLACEHOLDERS)
2452 ? HvTOTALKEYS(hv) : HvUSEDKEYS(hv)) {
2454 /* OK. Come to the end of the current list. Grab the next one. */
2456 iter->xhv_riter++; /* HvRITER(hv)++ */
2457 if (iter->xhv_riter > (I32)xhv->xhv_max /* HvRITER(hv) > HvMAX(hv) */) {
2458 /* There is no next one. End of the hash. */
2459 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
2462 entry = (HvARRAY(hv))[iter->xhv_riter];
2464 if (!(flags & HV_ITERNEXT_WANTPLACEHOLDERS)) {
2465 /* If we have an entry, but it's a placeholder, don't count it.
2467 while (entry && HeVAL(entry) == &PL_sv_placeholder)
2468 entry = HeNEXT(entry);
2470 /* Will loop again if this linked list starts NULL
2471 (for HV_ITERNEXT_WANTPLACEHOLDERS)
2472 or if we run through it and find only placeholders. */
2475 else iter->xhv_riter = -1;
2477 if (oldentry && HvLAZYDEL(hv)) { /* was deleted earlier? */
2479 hv_free_ent(hv, oldentry);
2482 /*if (HvREHASH(hv) && entry && !HeKREHASH(entry))
2483 PerlIO_printf(PerlIO_stderr(), "Awooga %p %p\n", (void*)hv, (void*)entry);*/
2485 iter->xhv_eiter = entry; /* HvEITER(hv) = entry */
2490 =for apidoc hv_iterkey
2492 Returns the key from the current position of the hash iterator. See
2499 Perl_hv_iterkey(pTHX_ register HE *entry, I32 *retlen)
2501 PERL_ARGS_ASSERT_HV_ITERKEY;
2503 if (HeKLEN(entry) == HEf_SVKEY) {
2505 char * const p = SvPV(HeKEY_sv(entry), len);
2510 *retlen = HeKLEN(entry);
2511 return HeKEY(entry);
2515 /* unlike hv_iterval(), this always returns a mortal copy of the key */
2517 =for apidoc hv_iterkeysv
2519 Returns the key as an C<SV*> from the current position of the hash
2520 iterator. The return value will always be a mortal copy of the key. Also
2527 Perl_hv_iterkeysv(pTHX_ register HE *entry)
2529 PERL_ARGS_ASSERT_HV_ITERKEYSV;
2531 return sv_2mortal(newSVhek(HeKEY_hek(entry)));
2535 =for apidoc hv_iterval
2537 Returns the value from the current position of the hash iterator. See
2544 Perl_hv_iterval(pTHX_ HV *hv, register HE *entry)
2546 PERL_ARGS_ASSERT_HV_ITERVAL;
2548 if (SvRMAGICAL(hv)) {
2549 if (mg_find((const SV *)hv, PERL_MAGIC_tied)) {
2550 SV* const sv = sv_newmortal();
2551 if (HeKLEN(entry) == HEf_SVKEY)
2552 mg_copy(MUTABLE_SV(hv), sv, (char*)HeKEY_sv(entry), HEf_SVKEY);
2554 mg_copy(MUTABLE_SV(hv), sv, HeKEY(entry), HeKLEN(entry));
2558 return HeVAL(entry);
2562 =for apidoc hv_iternextsv
2564 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
2571 Perl_hv_iternextsv(pTHX_ HV *hv, char **key, I32 *retlen)
2573 HE * const he = hv_iternext_flags(hv, 0);
2575 PERL_ARGS_ASSERT_HV_ITERNEXTSV;
2579 *key = hv_iterkey(he, retlen);
2580 return hv_iterval(hv, he);
2587 =for apidoc hv_magic
2589 Adds magic to a hash. See C<sv_magic>.
2594 /* possibly free a shared string if no one has access to it
2595 * len and hash must both be valid for str.
2598 Perl_unsharepvn(pTHX_ const char *str, I32 len, U32 hash)
2600 unshare_hek_or_pvn (NULL, str, len, hash);
2605 Perl_unshare_hek(pTHX_ HEK *hek)
2608 unshare_hek_or_pvn(hek, NULL, 0, 0);
2611 /* possibly free a shared string if no one has access to it
2612 hek if non-NULL takes priority over the other 3, else str, len and hash
2613 are used. If so, len and hash must both be valid for str.
2616 S_unshare_hek_or_pvn(pTHX_ const HEK *hek, const char *str, I32 len, U32 hash)
2622 bool is_utf8 = FALSE;
2624 const char * const save = str;
2625 struct shared_he *he = NULL;
2628 /* Find the shared he which is just before us in memory. */
2629 he = (struct shared_he *)(((char *)hek)
2630 - STRUCT_OFFSET(struct shared_he,
2633 /* Assert that the caller passed us a genuine (or at least consistent)
2635 assert (he->shared_he_he.hent_hek == hek);
2637 if (he->shared_he_he.he_valu.hent_refcount - 1) {
2638 --he->shared_he_he.he_valu.hent_refcount;
2642 hash = HEK_HASH(hek);
2643 } else if (len < 0) {
2644 STRLEN tmplen = -len;
2646 /* See the note in hv_fetch(). --jhi */
2647 str = (char*)bytes_from_utf8((U8*)str, &tmplen, &is_utf8);
2650 k_flags = HVhek_UTF8;
2652 k_flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
2655 /* what follows was the moral equivalent of:
2656 if ((Svp = hv_fetch(PL_strtab, tmpsv, FALSE, hash))) {
2658 hv_delete(PL_strtab, str, len, G_DISCARD, hash);
2660 xhv = (XPVHV*)SvANY(PL_strtab);
2661 /* assert(xhv_array != 0) */
2662 oentry = &(HvARRAY(PL_strtab))[hash & (I32) HvMAX(PL_strtab)];
2664 const HE *const he_he = &(he->shared_he_he);
2665 for (entry = *oentry; entry; oentry = &HeNEXT(entry), entry = *oentry) {
2670 const int flags_masked = k_flags & HVhek_MASK;
2671 for (entry = *oentry; entry; oentry = &HeNEXT(entry), entry = *oentry) {
2672 if (HeHASH(entry) != hash) /* strings can't be equal */
2674 if (HeKLEN(entry) != len)
2676 if (HeKEY(entry) != str && memNE(HeKEY(entry),str,len)) /* is this it? */
2678 if (HeKFLAGS(entry) != flags_masked)
2685 if (--entry->he_valu.hent_refcount == 0) {
2686 *oentry = HeNEXT(entry);
2688 xhv->xhv_keys--; /* HvTOTALKEYS(hv)-- */
2693 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
2694 "Attempt to free nonexistent shared string '%s'%s"
2696 hek ? HEK_KEY(hek) : str,
2697 ((k_flags & HVhek_UTF8) ? " (utf8)" : "") pTHX__VALUE);
2698 if (k_flags & HVhek_FREEKEY)
2702 /* get a (constant) string ptr from the global string table
2703 * string will get added if it is not already there.
2704 * len and hash must both be valid for str.
2707 Perl_share_hek(pTHX_ const char *str, I32 len, register U32 hash)
2709 bool is_utf8 = FALSE;
2711 const char * const save = str;
2713 PERL_ARGS_ASSERT_SHARE_HEK;
2716 STRLEN tmplen = -len;
2718 /* See the note in hv_fetch(). --jhi */
2719 str = (char*)bytes_from_utf8((U8*)str, &tmplen, &is_utf8);
2721 /* If we were able to downgrade here, then than means that we were passed
2722 in a key which only had chars 0-255, but was utf8 encoded. */
2725 /* If we found we were able to downgrade the string to bytes, then
2726 we should flag that it needs upgrading on keys or each. Also flag
2727 that we need share_hek_flags to free the string. */
2729 PERL_HASH(hash, str, len);
2730 flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
2734 return share_hek_flags (str, len, hash, flags);
2738 S_share_hek_flags(pTHX_ const char *str, I32 len, register U32 hash, int flags)
2742 const int flags_masked = flags & HVhek_MASK;
2743 const U32 hindex = hash & (I32) HvMAX(PL_strtab);
2744 XPVHV * const xhv = (XPVHV*)SvANY(PL_strtab);
2746 PERL_ARGS_ASSERT_SHARE_HEK_FLAGS;
2748 /* what follows is the moral equivalent of:
2750 if (!(Svp = hv_fetch(PL_strtab, str, len, FALSE)))
2751 hv_store(PL_strtab, str, len, NULL, hash);
2753 Can't rehash the shared string table, so not sure if it's worth
2754 counting the number of entries in the linked list
2757 /* assert(xhv_array != 0) */
2758 entry = (HvARRAY(PL_strtab))[hindex];
2759 for (;entry; entry = HeNEXT(entry)) {
2760 if (HeHASH(entry) != hash) /* strings can't be equal */
2762 if (HeKLEN(entry) != len)
2764 if (HeKEY(entry) != str && memNE(HeKEY(entry),str,len)) /* is this it? */
2766 if (HeKFLAGS(entry) != flags_masked)
2772 /* What used to be head of the list.
2773 If this is NULL, then we're the first entry for this slot, which
2774 means we need to increate fill. */
2775 struct shared_he *new_entry;
2778 HE **const head = &HvARRAY(PL_strtab)[hindex];
2779 HE *const next = *head;
2781 /* We don't actually store a HE from the arena and a regular HEK.
2782 Instead we allocate one chunk of memory big enough for both,
2783 and put the HEK straight after the HE. This way we can find the
2784 HE directly from the HEK.
2787 Newx(k, STRUCT_OFFSET(struct shared_he,
2788 shared_he_hek.hek_key[0]) + len + 2, char);
2789 new_entry = (struct shared_he *)k;
2790 entry = &(new_entry->shared_he_he);
2791 hek = &(new_entry->shared_he_hek);
2793 Copy(str, HEK_KEY(hek), len, char);
2794 HEK_KEY(hek)[len] = 0;
2796 HEK_HASH(hek) = hash;
2797 HEK_FLAGS(hek) = (unsigned char)flags_masked;
2799 /* Still "point" to the HEK, so that other code need not know what
2801 HeKEY_hek(entry) = hek;
2802 entry->he_valu.hent_refcount = 0;
2803 HeNEXT(entry) = next;
2806 xhv->xhv_keys++; /* HvTOTALKEYS(hv)++ */
2807 if (!next) { /* initial entry? */
2808 } else if (xhv->xhv_keys > xhv->xhv_max /* HvUSEDKEYS(hv) > HvMAX(hv) */) {
2813 ++entry->he_valu.hent_refcount;
2815 if (flags & HVhek_FREEKEY)
2818 return HeKEY_hek(entry);
2822 Perl_hv_placeholders_p(pTHX_ HV *hv)
2825 MAGIC *mg = mg_find((const SV *)hv, PERL_MAGIC_rhash);
2827 PERL_ARGS_ASSERT_HV_PLACEHOLDERS_P;
2830 mg = sv_magicext(MUTABLE_SV(hv), 0, PERL_MAGIC_rhash, 0, 0, 0);
2833 Perl_die(aTHX_ "panic: hv_placeholders_p");
2836 return &(mg->mg_len);
2841 Perl_hv_placeholders_get(pTHX_ const HV *hv)
2844 MAGIC * const mg = mg_find((const SV *)hv, PERL_MAGIC_rhash);
2846 PERL_ARGS_ASSERT_HV_PLACEHOLDERS_GET;
2848 return mg ? mg->mg_len : 0;
2852 Perl_hv_placeholders_set(pTHX_ HV *hv, I32 ph)
2855 MAGIC * const mg = mg_find((const SV *)hv, PERL_MAGIC_rhash);
2857 PERL_ARGS_ASSERT_HV_PLACEHOLDERS_SET;
2862 if (!sv_magicext(MUTABLE_SV(hv), 0, PERL_MAGIC_rhash, 0, 0, ph))
2863 Perl_die(aTHX_ "panic: hv_placeholders_set");
2865 /* else we don't need to add magic to record 0 placeholders. */
2869 S_refcounted_he_value(pTHX_ const struct refcounted_he *he)
2874 PERL_ARGS_ASSERT_REFCOUNTED_HE_VALUE;
2876 switch(he->refcounted_he_data[0] & HVrhek_typemask) {
2881 value = &PL_sv_placeholder;
2884 value = newSViv(he->refcounted_he_val.refcounted_he_u_iv);
2887 value = newSVuv(he->refcounted_he_val.refcounted_he_u_uv);
2890 case HVrhek_PV_UTF8:
2891 /* Create a string SV that directly points to the bytes in our
2893 value = newSV_type(SVt_PV);
2894 SvPV_set(value, (char *) he->refcounted_he_data + 1);
2895 SvCUR_set(value, he->refcounted_he_val.refcounted_he_u_len);
2896 /* This stops anything trying to free it */
2897 SvLEN_set(value, 0);
2899 SvREADONLY_on(value);
2900 if ((he->refcounted_he_data[0] & HVrhek_typemask) == HVrhek_PV_UTF8)
2904 Perl_croak(aTHX_ "panic: refcounted_he_value bad flags %"UVxf,
2905 (UV)he->refcounted_he_data[0]);
2911 =for apidoc m|HV *|refcounted_he_chain_2hv|const struct refcounted_he *c|U32 flags
2913 Generates and returns a C<HV *> representing the content of a
2914 C<refcounted_he> chain.
2915 I<flags> is currently unused and must be zero.
2920 Perl_refcounted_he_chain_2hv(pTHX_ const struct refcounted_he *chain, U32 flags)
2924 U32 placeholders, max;
2927 Perl_croak(aTHX_ "panic: refcounted_he_chain_2hv bad flags %"UVxf,
2930 /* We could chase the chain once to get an idea of the number of keys,
2931 and call ksplit. But for now we'll make a potentially inefficient
2932 hash with only 8 entries in its array. */
2937 Newxz(array, PERL_HV_ARRAY_ALLOC_BYTES(max + 1), char);
2938 HvARRAY(hv) = (HE**)array;
2944 U32 hash = chain->refcounted_he_hash;
2946 U32 hash = HEK_HASH(chain->refcounted_he_hek);
2948 HE **oentry = &((HvARRAY(hv))[hash & max]);
2949 HE *entry = *oentry;
2952 for (; entry; entry = HeNEXT(entry)) {
2953 if (HeHASH(entry) == hash) {
2954 /* We might have a duplicate key here. If so, entry is older
2955 than the key we've already put in the hash, so if they are
2956 the same, skip adding entry. */
2958 const STRLEN klen = HeKLEN(entry);
2959 const char *const key = HeKEY(entry);
2960 if (klen == chain->refcounted_he_keylen
2961 && (!!HeKUTF8(entry)
2962 == !!(chain->refcounted_he_data[0] & HVhek_UTF8))
2963 && memEQ(key, REF_HE_KEY(chain), klen))
2966 if (HeKEY_hek(entry) == chain->refcounted_he_hek)
2968 if (HeKLEN(entry) == HEK_LEN(chain->refcounted_he_hek)
2969 && HeKUTF8(entry) == HEK_UTF8(chain->refcounted_he_hek)
2970 && memEQ(HeKEY(entry), HEK_KEY(chain->refcounted_he_hek),
2981 = share_hek_flags(REF_HE_KEY(chain),
2982 chain->refcounted_he_keylen,
2983 chain->refcounted_he_hash,
2984 (chain->refcounted_he_data[0]
2985 & (HVhek_UTF8|HVhek_WASUTF8)));
2987 HeKEY_hek(entry) = share_hek_hek(chain->refcounted_he_hek);
2989 value = refcounted_he_value(chain);
2990 if (value == &PL_sv_placeholder)
2992 HeVAL(entry) = value;
2994 /* Link it into the chain. */
2995 HeNEXT(entry) = *oentry;
3001 chain = chain->refcounted_he_next;
3005 clear_placeholders(hv, placeholders);
3006 HvTOTALKEYS(hv) -= placeholders;
3009 /* We could check in the loop to see if we encounter any keys with key
3010 flags, but it's probably not worth it, as this per-hash flag is only
3011 really meant as an optimisation for things like Storable. */
3013 DEBUG_A(Perl_hv_assert(aTHX_ hv));
3019 =for apidoc m|SV *|refcounted_he_fetch_pvn|const struct refcounted_he *chain|const char *keypv|STRLEN keylen|U32 hash|U32 flags
3021 Search along a C<refcounted_he> chain for an entry with the key specified
3022 by I<keypv> and I<keylen>. If I<flags> has the C<REFCOUNTED_HE_KEY_UTF8>
3023 bit set, the key octets are interpreted as UTF-8, otherwise they
3024 are interpreted as Latin-1. I<hash> is a precomputed hash of the key
3025 string, or zero if it has not been precomputed. Returns a mortal scalar
3026 representing the value associated with the key, or C<&PL_sv_placeholder>
3027 if there is no value associated with the key.
3033 Perl_refcounted_he_fetch_pvn(pTHX_ const struct refcounted_he *chain,
3034 const char *keypv, STRLEN keylen, U32 hash, U32 flags)
3038 PERL_ARGS_ASSERT_REFCOUNTED_HE_FETCH_PVN;
3040 if (flags & ~(REFCOUNTED_HE_KEY_UTF8|REFCOUNTED_HE_EXISTS))
3041 Perl_croak(aTHX_ "panic: refcounted_he_fetch_pvn bad flags %"UVxf,
3044 return &PL_sv_placeholder;
3045 if (flags & REFCOUNTED_HE_KEY_UTF8) {
3046 /* For searching purposes, canonicalise to Latin-1 where possible. */
3047 const char *keyend = keypv + keylen, *p;
3048 STRLEN nonascii_count = 0;
3049 for (p = keypv; p != keyend; p++) {
3052 if (!((c & 0xfe) == 0xc2 && ++p != keyend &&
3053 (((U8)*p) & 0xc0) == 0x80))
3054 goto canonicalised_key;
3058 if (nonascii_count) {
3060 const char *p = keypv, *keyend = keypv + keylen;
3061 keylen -= nonascii_count;
3062 Newx(q, keylen, char);
3065 for (; p != keyend; p++, q++) {
3068 ((c & 0x80) ? ((c & 0x03) << 6) | (((U8)*++p) & 0x3f) : c);
3071 flags &= ~REFCOUNTED_HE_KEY_UTF8;
3072 canonicalised_key: ;
3074 utf8_flag = (flags & REFCOUNTED_HE_KEY_UTF8) ? HVhek_UTF8 : 0;
3076 PERL_HASH(hash, keypv, keylen);
3078 for (; chain; chain = chain->refcounted_he_next) {
3081 hash == chain->refcounted_he_hash &&
3082 keylen == chain->refcounted_he_keylen &&
3083 memEQ(REF_HE_KEY(chain), keypv, keylen) &&
3084 utf8_flag == (chain->refcounted_he_data[0] & HVhek_UTF8)
3086 hash == HEK_HASH(chain->refcounted_he_hek) &&
3087 keylen == (STRLEN)HEK_LEN(chain->refcounted_he_hek) &&
3088 memEQ(HEK_KEY(chain->refcounted_he_hek), keypv, keylen) &&
3089 utf8_flag == (HEK_FLAGS(chain->refcounted_he_hek) & HVhek_UTF8)
3092 if (flags & REFCOUNTED_HE_EXISTS)
3093 return (chain->refcounted_he_data[0] & HVrhek_typemask)
3095 ? NULL : &PL_sv_yes;
3096 return sv_2mortal(refcounted_he_value(chain));
3099 return flags & REFCOUNTED_HE_EXISTS ? NULL : &PL_sv_placeholder;
3103 =for apidoc m|SV *|refcounted_he_fetch_pv|const struct refcounted_he *chain|const char *key|U32 hash|U32 flags
3105 Like L</refcounted_he_fetch_pvn>, but takes a nul-terminated string
3106 instead of a string/length pair.
3112 Perl_refcounted_he_fetch_pv(pTHX_ const struct refcounted_he *chain,
3113 const char *key, U32 hash, U32 flags)
3115 PERL_ARGS_ASSERT_REFCOUNTED_HE_FETCH_PV;
3116 return refcounted_he_fetch_pvn(chain, key, strlen(key), hash, flags);
3120 =for apidoc m|SV *|refcounted_he_fetch_sv|const struct refcounted_he *chain|SV *key|U32 hash|U32 flags
3122 Like L</refcounted_he_fetch_pvn>, but takes a Perl scalar instead of a
3129 Perl_refcounted_he_fetch_sv(pTHX_ const struct refcounted_he *chain,
3130 SV *key, U32 hash, U32 flags)
3134 PERL_ARGS_ASSERT_REFCOUNTED_HE_FETCH_SV;
3135 if (flags & REFCOUNTED_HE_KEY_UTF8)
3136 Perl_croak(aTHX_ "panic: refcounted_he_fetch_sv bad flags %"UVxf,
3138 keypv = SvPV_const(key, keylen);
3140 flags |= REFCOUNTED_HE_KEY_UTF8;
3141 if (!hash && SvIsCOW_shared_hash(key))
3142 hash = SvSHARED_HASH(key);
3143 return refcounted_he_fetch_pvn(chain, keypv, keylen, hash, flags);
3147 =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
3149 Creates a new C<refcounted_he>. This consists of a single key/value
3150 pair and a reference to an existing C<refcounted_he> chain (which may
3151 be empty), and thus forms a longer chain. When using the longer chain,
3152 the new key/value pair takes precedence over any entry for the same key
3153 further along the chain.
3155 The new key is specified by I<keypv> and I<keylen>. If I<flags> has
3156 the C<REFCOUNTED_HE_KEY_UTF8> bit set, the key octets are interpreted
3157 as UTF-8, otherwise they are interpreted as Latin-1. I<hash> is
3158 a precomputed hash of the key string, or zero if it has not been
3161 I<value> is the scalar value to store for this key. I<value> is copied
3162 by this function, which thus does not take ownership of any reference
3163 to it, and later changes to the scalar will not be reflected in the
3164 value visible in the C<refcounted_he>. Complex types of scalar will not
3165 be stored with referential integrity, but will be coerced to strings.
3166 I<value> may be either null or C<&PL_sv_placeholder> to indicate that no
3167 value is to be associated with the key; this, as with any non-null value,
3168 takes precedence over the existence of a value for the key further along
3171 I<parent> points to the rest of the C<refcounted_he> chain to be
3172 attached to the new C<refcounted_he>. This function takes ownership
3173 of one reference to I<parent>, and returns one reference to the new
3179 struct refcounted_he *
3180 Perl_refcounted_he_new_pvn(pTHX_ struct refcounted_he *parent,
3181 const char *keypv, STRLEN keylen, U32 hash, SV *value, U32 flags)
3184 STRLEN value_len = 0;
3185 const char *value_p = NULL;
3189 STRLEN key_offset = 1;
3190 struct refcounted_he *he;
3191 PERL_ARGS_ASSERT_REFCOUNTED_HE_NEW_PVN;
3193 if (!value || value == &PL_sv_placeholder) {
3194 value_type = HVrhek_delete;
3195 } else if (SvPOK(value)) {
3196 value_type = HVrhek_PV;
3197 } else if (SvIOK(value)) {
3198 value_type = SvUOK((const SV *)value) ? HVrhek_UV : HVrhek_IV;
3199 } else if (!SvOK(value)) {
3200 value_type = HVrhek_undef;
3202 value_type = HVrhek_PV;
3204 is_pv = value_type == HVrhek_PV;
3206 /* Do it this way so that the SvUTF8() test is after the SvPV, in case
3207 the value is overloaded, and doesn't yet have the UTF-8flag set. */
3208 value_p = SvPV_const(value, value_len);
3210 value_type = HVrhek_PV_UTF8;
3211 key_offset = value_len + 2;
3213 hekflags = value_type;
3215 if (flags & REFCOUNTED_HE_KEY_UTF8) {
3216 /* Canonicalise to Latin-1 where possible. */
3217 const char *keyend = keypv + keylen, *p;
3218 STRLEN nonascii_count = 0;
3219 for (p = keypv; p != keyend; p++) {
3222 if (!((c & 0xfe) == 0xc2 && ++p != keyend &&
3223 (((U8)*p) & 0xc0) == 0x80))
3224 goto canonicalised_key;
3228 if (nonascii_count) {
3230 const char *p = keypv, *keyend = keypv + keylen;
3231 keylen -= nonascii_count;
3232 Newx(q, keylen, char);
3235 for (; p != keyend; p++, q++) {
3238 ((c & 0x80) ? ((c & 0x03) << 6) | (((U8)*++p) & 0x3f) : c);
3241 flags &= ~REFCOUNTED_HE_KEY_UTF8;
3242 canonicalised_key: ;
3244 if (flags & REFCOUNTED_HE_KEY_UTF8)
3245 hekflags |= HVhek_UTF8;
3247 PERL_HASH(hash, keypv, keylen);
3250 he = (struct refcounted_he*)
3251 PerlMemShared_malloc(sizeof(struct refcounted_he) - 1
3255 he = (struct refcounted_he*)
3256 PerlMemShared_malloc(sizeof(struct refcounted_he) - 1
3260 he->refcounted_he_next = parent;
3263 Copy(value_p, he->refcounted_he_data + 1, value_len + 1, char);
3264 he->refcounted_he_val.refcounted_he_u_len = value_len;
3265 } else if (value_type == HVrhek_IV) {
3266 he->refcounted_he_val.refcounted_he_u_iv = SvIVX(value);
3267 } else if (value_type == HVrhek_UV) {
3268 he->refcounted_he_val.refcounted_he_u_uv = SvUVX(value);
3272 he->refcounted_he_hash = hash;
3273 he->refcounted_he_keylen = keylen;
3274 Copy(keypv, he->refcounted_he_data + key_offset, keylen, char);
3276 he->refcounted_he_hek = share_hek_flags(keypv, keylen, hash, hekflags);
3279 he->refcounted_he_data[0] = hekflags;
3280 he->refcounted_he_refcnt = 1;
3286 =for apidoc m|struct refcounted_he *|refcounted_he_new_pv|struct refcounted_he *parent|const char *key|U32 hash|SV *value|U32 flags
3288 Like L</refcounted_he_new_pvn>, but takes a nul-terminated string instead
3289 of a string/length pair.
3294 struct refcounted_he *
3295 Perl_refcounted_he_new_pv(pTHX_ struct refcounted_he *parent,
3296 const char *key, U32 hash, SV *value, U32 flags)
3298 PERL_ARGS_ASSERT_REFCOUNTED_HE_NEW_PV;
3299 return refcounted_he_new_pvn(parent, key, strlen(key), hash, value, flags);
3303 =for apidoc m|struct refcounted_he *|refcounted_he_new_sv|struct refcounted_he *parent|SV *key|U32 hash|SV *value|U32 flags
3305 Like L</refcounted_he_new_pvn>, but takes a Perl scalar instead of a
3311 struct refcounted_he *
3312 Perl_refcounted_he_new_sv(pTHX_ struct refcounted_he *parent,
3313 SV *key, U32 hash, SV *value, U32 flags)
3317 PERL_ARGS_ASSERT_REFCOUNTED_HE_NEW_SV;
3318 if (flags & REFCOUNTED_HE_KEY_UTF8)
3319 Perl_croak(aTHX_ "panic: refcounted_he_new_sv bad flags %"UVxf,
3321 keypv = SvPV_const(key, keylen);
3323 flags |= REFCOUNTED_HE_KEY_UTF8;
3324 if (!hash && SvIsCOW_shared_hash(key))
3325 hash = SvSHARED_HASH(key);
3326 return refcounted_he_new_pvn(parent, keypv, keylen, hash, value, flags);
3330 =for apidoc m|void|refcounted_he_free|struct refcounted_he *he
3332 Decrements the reference count of a C<refcounted_he> by one. If the
3333 reference count reaches zero the structure's memory is freed, which
3334 (recursively) causes a reduction of its parent C<refcounted_he>'s
3335 reference count. It is safe to pass a null pointer to this function:
3336 no action occurs in this case.
3342 Perl_refcounted_he_free(pTHX_ struct refcounted_he *he) {
3344 PERL_UNUSED_CONTEXT;
3347 struct refcounted_he *copy;
3351 new_count = --he->refcounted_he_refcnt;
3352 HINTS_REFCNT_UNLOCK;
3358 #ifndef USE_ITHREADS
3359 unshare_hek_or_pvn (he->refcounted_he_hek, 0, 0, 0);
3362 he = he->refcounted_he_next;
3363 PerlMemShared_free(copy);
3368 =for apidoc m|struct refcounted_he *|refcounted_he_inc|struct refcounted_he *he
3370 Increment the reference count of a C<refcounted_he>. The pointer to the
3371 C<refcounted_he> is also returned. It is safe to pass a null pointer
3372 to this function: no action occurs and a null pointer is returned.
3377 struct refcounted_he *
3378 Perl_refcounted_he_inc(pTHX_ struct refcounted_he *he)
3383 he->refcounted_he_refcnt++;
3384 HINTS_REFCNT_UNLOCK;
3390 =for apidoc cop_fetch_label
3392 Returns the label attached to a cop.
3393 The flags pointer may be set to C<SVf_UTF8> or 0.
3398 /* pp_entereval is aware that labels are stored with a key ':' at the top of
3401 Perl_cop_fetch_label(pTHX_ COP *const cop, STRLEN *len, U32 *flags) {
3402 struct refcounted_he *const chain = cop->cop_hints_hash;
3404 PERL_ARGS_ASSERT_COP_FETCH_LABEL;
3409 if (chain->refcounted_he_keylen != 1)
3411 if (*REF_HE_KEY(chain) != ':')
3414 if ((STRLEN)HEK_LEN(chain->refcounted_he_hek) != 1)
3416 if (*HEK_KEY(chain->refcounted_he_hek) != ':')
3419 /* Stop anyone trying to really mess us up by adding their own value for
3421 if ((chain->refcounted_he_data[0] & HVrhek_typemask) != HVrhek_PV
3422 && (chain->refcounted_he_data[0] & HVrhek_typemask) != HVrhek_PV_UTF8)
3426 *len = chain->refcounted_he_val.refcounted_he_u_len;
3428 *flags = ((chain->refcounted_he_data[0] & HVrhek_typemask)
3429 == HVrhek_PV_UTF8) ? SVf_UTF8 : 0;
3431 return chain->refcounted_he_data + 1;
3435 =for apidoc cop_store_label
3437 Save a label into a C<cop_hints_hash>. You need to set flags to C<SVf_UTF8>
3444 Perl_cop_store_label(pTHX_ COP *const cop, const char *label, STRLEN len,
3448 PERL_ARGS_ASSERT_COP_STORE_LABEL;
3450 if (flags & ~(SVf_UTF8))
3451 Perl_croak(aTHX_ "panic: cop_store_label illegal flag bits 0x%" UVxf,
3453 labelsv = newSVpvn_flags(label, len, SVs_TEMP);
3454 if (flags & SVf_UTF8)
3457 = refcounted_he_new_pvs(cop->cop_hints_hash, ":", labelsv, 0);
3461 =for apidoc hv_assert
3463 Check that a hash is in an internally consistent state.
3471 Perl_hv_assert(pTHX_ HV *hv)
3476 int placeholders = 0;
3479 const I32 riter = HvRITER_get(hv);
3480 HE *eiter = HvEITER_get(hv);
3482 PERL_ARGS_ASSERT_HV_ASSERT;
3484 (void)hv_iterinit(hv);
3486 while ((entry = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS))) {
3487 /* sanity check the values */
3488 if (HeVAL(entry) == &PL_sv_placeholder)
3492 /* sanity check the keys */
3493 if (HeSVKEY(entry)) {
3494 NOOP; /* Don't know what to check on SV keys. */
3495 } else if (HeKUTF8(entry)) {
3497 if (HeKWASUTF8(entry)) {
3498 PerlIO_printf(Perl_debug_log,
3499 "hash key has both WASUTF8 and UTF8: '%.*s'\n",
3500 (int) HeKLEN(entry), HeKEY(entry));
3503 } else if (HeKWASUTF8(entry))
3506 if (!SvTIED_mg((const SV *)hv, PERL_MAGIC_tied)) {
3507 static const char bad_count[] = "Count %d %s(s), but hash reports %d\n";
3508 const int nhashkeys = HvUSEDKEYS(hv);
3509 const int nhashplaceholders = HvPLACEHOLDERS_get(hv);
3511 if (nhashkeys != real) {
3512 PerlIO_printf(Perl_debug_log, bad_count, real, "keys", nhashkeys );
3515 if (nhashplaceholders != placeholders) {
3516 PerlIO_printf(Perl_debug_log, bad_count, placeholders, "placeholder", nhashplaceholders );
3520 if (withflags && ! HvHASKFLAGS(hv)) {
3521 PerlIO_printf(Perl_debug_log,
3522 "Hash has HASKFLAGS off but I count %d key(s) with flags\n",
3527 sv_dump(MUTABLE_SV(hv));
3529 HvRITER_set(hv, riter); /* Restore hash iterator state */
3530 HvEITER_set(hv, eiter);
3537 * c-indentation-style: bsd
3539 * indent-tabs-mode: nil
3542 * ex: set ts=8 sts=4 sw=4 et: