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);
391 flags = 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, action, hash);
402 xhv = (XPVHV*)SvANY(hv);
404 if (SvRMAGICAL(hv) && !(action & (HV_FETCH_ISSTORE|HV_FETCH_ISEXISTS))) {
405 if (mg_find((const SV *)hv, PERL_MAGIC_tied)
406 || SvGMAGICAL((const SV *)hv))
408 /* FIXME should be able to skimp on the HE/HEK here when
409 HV_FETCH_JUST_SV is true. */
411 keysv = newSVpvn_utf8(key, klen, is_utf8);
413 keysv = newSVsv(keysv);
416 mg_copy(MUTABLE_SV(hv), sv, (char *)keysv, HEf_SVKEY);
418 /* grab a fake HE/HEK pair from the pool or make a new one */
419 entry = PL_hv_fetch_ent_mh;
421 PL_hv_fetch_ent_mh = HeNEXT(entry);
425 Newx(k, HEK_BASESIZE + sizeof(const SV *), char);
426 HeKEY_hek(entry) = (HEK*)k;
428 HeNEXT(entry) = NULL;
429 HeSVKEY_set(entry, keysv);
431 sv_upgrade(sv, SVt_PVLV);
433 /* so we can free entry when freeing sv */
434 LvTARG(sv) = MUTABLE_SV(entry);
436 /* XXX remove at some point? */
437 if (flags & HVhek_FREEKEY)
441 return entry ? (void *) &HeVAL(entry) : NULL;
443 return (void *) entry;
445 #ifdef ENV_IS_CASELESS
446 else if (mg_find((const SV *)hv, PERL_MAGIC_env)) {
448 for (i = 0; i < klen; ++i)
449 if (isLOWER(key[i])) {
450 /* Would be nice if we had a routine to do the
451 copy and upercase in a single pass through. */
452 const char * const nkey = strupr(savepvn(key,klen));
453 /* Note that this fetch is for nkey (the uppercased
454 key) whereas the store is for key (the original) */
455 void *result = hv_common(hv, NULL, nkey, klen,
456 HVhek_FREEKEY, /* free nkey */
457 0 /* non-LVAL fetch */
458 | HV_DISABLE_UVAR_XKEY
461 0 /* compute hash */);
462 if (!result && (action & HV_FETCH_LVALUE)) {
463 /* This call will free key if necessary.
464 Do it this way to encourage compiler to tail
466 result = hv_common(hv, keysv, key, klen, flags,
468 | HV_DISABLE_UVAR_XKEY
472 if (flags & HVhek_FREEKEY)
480 else if (SvRMAGICAL(hv) && (action & HV_FETCH_ISEXISTS)) {
481 if (mg_find((const SV *)hv, PERL_MAGIC_tied)
482 || SvGMAGICAL((const SV *)hv)) {
483 /* I don't understand why hv_exists_ent has svret and sv,
484 whereas hv_exists only had one. */
485 SV * const svret = sv_newmortal();
488 if (keysv || is_utf8) {
490 keysv = newSVpvn_utf8(key, klen, TRUE);
492 keysv = newSVsv(keysv);
494 mg_copy(MUTABLE_SV(hv), sv, (char *)sv_2mortal(keysv), HEf_SVKEY);
496 mg_copy(MUTABLE_SV(hv), sv, key, klen);
498 if (flags & HVhek_FREEKEY)
500 magic_existspack(svret, mg_find(sv, PERL_MAGIC_tiedelem));
501 /* This cast somewhat evil, but I'm merely using NULL/
502 not NULL to return the boolean exists.
503 And I know hv is not NULL. */
504 return SvTRUE(svret) ? (void *)hv : NULL;
506 #ifdef ENV_IS_CASELESS
507 else if (mg_find((const SV *)hv, PERL_MAGIC_env)) {
508 /* XXX This code isn't UTF8 clean. */
509 char * const keysave = (char * const)key;
510 /* Will need to free this, so set FREEKEY flag. */
511 key = savepvn(key,klen);
512 key = (const char*)strupr((char*)key);
517 if (flags & HVhek_FREEKEY) {
520 flags |= HVhek_FREEKEY;
524 else if (action & HV_FETCH_ISSTORE) {
527 hv_magic_check (hv, &needs_copy, &needs_store);
529 const bool save_taint = TAINT_get; /* Unused var warning under NO_TAINT_SUPPORT */
530 if (keysv || is_utf8) {
532 keysv = newSVpvn_utf8(key, klen, TRUE);
535 TAINT_set(SvTAINTED(keysv));
536 keysv = sv_2mortal(newSVsv(keysv));
537 mg_copy(MUTABLE_SV(hv), val, (char*)keysv, HEf_SVKEY);
539 mg_copy(MUTABLE_SV(hv), val, key, klen);
542 TAINT_IF(save_taint);
544 if (flags & HVhek_FREEKEY)
548 #ifdef ENV_IS_CASELESS
549 else if (mg_find((const SV *)hv, PERL_MAGIC_env)) {
550 /* XXX This code isn't UTF8 clean. */
551 const char *keysave = key;
552 /* Will need to free this, so set FREEKEY flag. */
553 key = savepvn(key,klen);
554 key = (const char*)strupr((char*)key);
559 if (flags & HVhek_FREEKEY) {
562 flags |= HVhek_FREEKEY;
570 if ((action & (HV_FETCH_LVALUE | HV_FETCH_ISSTORE))
571 #ifdef DYNAMIC_ENV_FETCH /* if it's an %ENV lookup, we may get it on the fly */
572 || (SvRMAGICAL((const SV *)hv)
573 && mg_find((const SV *)hv, PERL_MAGIC_env))
578 PERL_HV_ARRAY_ALLOC_BYTES(xhv->xhv_max+1 /* HvMAX(hv)+1 */),
580 HvARRAY(hv) = (HE**)array;
582 #ifdef DYNAMIC_ENV_FETCH
583 else if (action & HV_FETCH_ISEXISTS) {
584 /* for an %ENV exists, if we do an insert it's by a recursive
585 store call, so avoid creating HvARRAY(hv) right now. */
589 /* XXX remove at some point? */
590 if (flags & HVhek_FREEKEY)
597 if (is_utf8 && !(flags & HVhek_KEYCANONICAL)) {
598 char * const keysave = (char *)key;
599 key = (char*)bytes_from_utf8((U8*)key, &klen, &is_utf8);
603 flags &= ~HVhek_UTF8;
604 if (key != keysave) {
605 if (flags & HVhek_FREEKEY)
607 flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
608 /* If the caller calculated a hash, it was on the sequence of
609 octets that are the UTF-8 form. We've now changed the sequence
610 of octets stored to that of the equivalent byte representation,
611 so the hash we need is different. */
616 if (HvREHASH(hv) || (!hash && !(keysv && (SvIsCOW_shared_hash(keysv)))))
617 PERL_HASH_INTERNAL_(hash, key, klen, HvREHASH(hv));
619 hash = SvSHARED_HASH(keysv);
621 /* We don't have a pointer to the hv, so we have to replicate the
622 flag into every HEK, so that hv_iterkeysv can see it.
623 And yes, you do need this even though you are not "storing" because
624 you can flip the flags below if doing an lval lookup. (And that
625 was put in to give the semantics Andreas was expecting.) */
627 flags |= HVhek_REHASH;
629 masked_flags = (flags & HVhek_MASK);
631 #ifdef DYNAMIC_ENV_FETCH
632 if (!HvARRAY(hv)) entry = NULL;
636 entry = (HvARRAY(hv))[hash & (I32) HvMAX(hv)];
638 for (; entry; entry = HeNEXT(entry)) {
639 if (HeHASH(entry) != hash) /* strings can't be equal */
641 if (HeKLEN(entry) != (I32)klen)
643 if (HeKEY(entry) != key && memNE(HeKEY(entry),key,klen)) /* is this it? */
645 if ((HeKFLAGS(entry) ^ masked_flags) & HVhek_UTF8)
648 if (action & (HV_FETCH_LVALUE|HV_FETCH_ISSTORE)) {
649 if (HeKFLAGS(entry) != masked_flags) {
650 /* We match if HVhek_UTF8 bit in our flags and hash key's
651 match. But if entry was set previously with HVhek_WASUTF8
652 and key now doesn't (or vice versa) then we should change
653 the key's flag, as this is assignment. */
654 if (HvSHAREKEYS(hv)) {
655 /* Need to swap the key we have for a key with the flags we
656 need. As keys are shared we can't just write to the
657 flag, so we share the new one, unshare the old one. */
658 HEK * const new_hek = share_hek_flags(key, klen, hash,
660 unshare_hek (HeKEY_hek(entry));
661 HeKEY_hek(entry) = new_hek;
663 else if (hv == PL_strtab) {
664 /* PL_strtab is usually the only hash without HvSHAREKEYS,
665 so putting this test here is cheap */
666 if (flags & HVhek_FREEKEY)
668 Perl_croak(aTHX_ S_strtab_error,
669 action & HV_FETCH_LVALUE ? "fetch" : "store");
672 HeKFLAGS(entry) = masked_flags;
673 if (masked_flags & HVhek_ENABLEHVKFLAGS)
676 if (HeVAL(entry) == &PL_sv_placeholder) {
677 /* yes, can store into placeholder slot */
678 if (action & HV_FETCH_LVALUE) {
680 /* This preserves behaviour with the old hv_fetch
681 implementation which at this point would bail out
682 with a break; (at "if we find a placeholder, we
683 pretend we haven't found anything")
685 That break mean that if a placeholder were found, it
686 caused a call into hv_store, which in turn would
687 check magic, and if there is no magic end up pretty
688 much back at this point (in hv_store's code). */
691 /* LVAL fetch which actually needs a store. */
693 HvPLACEHOLDERS(hv)--;
696 if (val != &PL_sv_placeholder)
697 HvPLACEHOLDERS(hv)--;
700 } else if (action & HV_FETCH_ISSTORE) {
701 SvREFCNT_dec(HeVAL(entry));
704 } else if (HeVAL(entry) == &PL_sv_placeholder) {
705 /* if we find a placeholder, we pretend we haven't found
709 if (flags & HVhek_FREEKEY)
712 return entry ? (void *) &HeVAL(entry) : NULL;
716 #ifdef DYNAMIC_ENV_FETCH /* %ENV lookup? If so, try to fetch the value now */
717 if (!(action & HV_FETCH_ISSTORE)
718 && SvRMAGICAL((const SV *)hv)
719 && mg_find((const SV *)hv, PERL_MAGIC_env)) {
721 const char * const env = PerlEnv_ENVgetenv_len(key,&len);
723 sv = newSVpvn(env,len);
725 return hv_common(hv, keysv, key, klen, flags,
726 HV_FETCH_ISSTORE|HV_DISABLE_UVAR_XKEY|return_svp,
732 if (!entry && SvREADONLY(hv) && !(action & HV_FETCH_ISEXISTS)) {
733 hv_notallowed(flags, key, klen,
734 "Attempt to access disallowed key '%"SVf"' in"
735 " a restricted hash");
737 if (!(action & (HV_FETCH_LVALUE|HV_FETCH_ISSTORE))) {
738 /* Not doing some form of store, so return failure. */
739 if (flags & HVhek_FREEKEY)
743 if (action & HV_FETCH_LVALUE) {
744 val = action & HV_FETCH_EMPTY_HE ? NULL : newSV(0);
746 /* At this point the old hv_fetch code would call to hv_store,
747 which in turn might do some tied magic. So we need to make that
748 magic check happen. */
749 /* gonna assign to this, so it better be there */
750 /* If a fetch-as-store fails on the fetch, then the action is to
751 recurse once into "hv_store". If we didn't do this, then that
752 recursive call would call the key conversion routine again.
753 However, as we replace the original key with the converted
754 key, this would result in a double conversion, which would show
755 up as a bug if the conversion routine is not idempotent. */
756 return hv_common(hv, keysv, key, klen, flags,
757 HV_FETCH_ISSTORE|HV_DISABLE_UVAR_XKEY|return_svp,
759 /* XXX Surely that could leak if the fetch-was-store fails?
760 Just like the hv_fetch. */
764 /* Welcome to hv_store... */
767 /* Not sure if we can get here. I think the only case of oentry being
768 NULL is for %ENV with dynamic env fetch. But that should disappear
769 with magic in the previous code. */
772 PERL_HV_ARRAY_ALLOC_BYTES(xhv->xhv_max+1 /* HvMAX(hv)+1 */),
774 HvARRAY(hv) = (HE**)array;
777 oentry = &(HvARRAY(hv))[hash & (I32) xhv->xhv_max];
780 /* share_hek_flags will do the free for us. This might be considered
783 HeKEY_hek(entry) = share_hek_flags(key, klen, hash, flags);
784 else if (hv == PL_strtab) {
785 /* PL_strtab is usually the only hash without HvSHAREKEYS, so putting
786 this test here is cheap */
787 if (flags & HVhek_FREEKEY)
789 Perl_croak(aTHX_ S_strtab_error,
790 action & HV_FETCH_LVALUE ? "fetch" : "store");
792 else /* gotta do the real thing */
793 HeKEY_hek(entry) = save_hek_flags(key, klen, hash, flags);
795 HeNEXT(entry) = *oentry;
798 if (val == &PL_sv_placeholder)
799 HvPLACEHOLDERS(hv)++;
800 if (masked_flags & HVhek_ENABLEHVKFLAGS)
804 const HE *counter = HeNEXT(entry);
806 xhv->xhv_keys++; /* HvTOTALKEYS(hv)++ */
807 if (!counter) { /* initial entry? */
808 } else if (xhv->xhv_keys > xhv->xhv_max) {
809 /* Use only the old HvUSEDKEYS(hv) > HvMAX(hv) condition to limit
810 bucket splits on a rehashed hash, as we're not going to
811 split it again, and if someone is lucky (evil) enough to
812 get all the keys in one list they could exhaust our memory
813 as we repeatedly double the number of buckets on every
814 entry. Linear search feels a less worse thing to do. */
816 } else if(!HvREHASH(hv)) {
819 while ((counter = HeNEXT(counter)))
822 if (n_links > HV_MAX_LENGTH_BEFORE_SPLIT) {
829 return entry ? (void *) &HeVAL(entry) : NULL;
831 return (void *) entry;
835 S_hv_magic_check(HV *hv, bool *needs_copy, bool *needs_store)
837 const MAGIC *mg = SvMAGIC(hv);
839 PERL_ARGS_ASSERT_HV_MAGIC_CHECK;
844 if (isUPPER(mg->mg_type)) {
846 if (mg->mg_type == PERL_MAGIC_tied) {
847 *needs_store = FALSE;
848 return; /* We've set all there is to set. */
851 mg = mg->mg_moremagic;
856 =for apidoc hv_scalar
858 Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
864 Perl_hv_scalar(pTHX_ HV *hv)
868 PERL_ARGS_ASSERT_HV_SCALAR;
870 if (SvRMAGICAL(hv)) {
871 MAGIC * const mg = mg_find((const SV *)hv, PERL_MAGIC_tied);
873 return magic_scalarpack(hv, mg);
877 if (HvTOTALKEYS((const HV *)hv))
878 Perl_sv_setpvf(aTHX_ sv, "%ld/%ld",
879 (long)HvFILL(hv), (long)HvMAX(hv) + 1);
887 =for apidoc hv_delete
889 Deletes a key/value pair in the hash. The value's SV is removed from
890 the hash, made mortal, and returned to the caller. The absolute
891 value of C<klen> is the length of the key. If C<klen> is negative the
892 key is assumed to be in UTF-8-encoded Unicode. The C<flags> value
893 will normally be zero; if set to G_DISCARD then NULL will be returned.
894 NULL will also be returned if the key is not found.
896 =for apidoc hv_delete_ent
898 Deletes a key/value pair in the hash. The value SV is removed from the hash,
899 made mortal, and returned to the caller. The C<flags> value will normally be
900 zero; if set to G_DISCARD then NULL will be returned. NULL will also be
901 returned if the key is not found. C<hash> can be a valid precomputed hash
902 value, or 0 to ask for it to be computed.
908 S_hv_delete_common(pTHX_ HV *hv, SV *keysv, const char *key, STRLEN klen,
909 int k_flags, I32 d_flags, U32 hash)
915 bool is_utf8 = (k_flags & HVhek_UTF8) ? TRUE : FALSE;
918 if (SvRMAGICAL(hv)) {
921 hv_magic_check (hv, &needs_copy, &needs_store);
925 entry = (HE *) hv_common(hv, keysv, key, klen,
926 k_flags & ~HVhek_FREEKEY,
927 HV_FETCH_LVALUE|HV_DISABLE_UVAR_XKEY,
929 sv = entry ? HeVAL(entry) : NULL;
935 if (mg_find(sv, PERL_MAGIC_tiedelem)) {
936 /* No longer an element */
937 sv_unmagic(sv, PERL_MAGIC_tiedelem);
940 return NULL; /* element cannot be deleted */
942 #ifdef ENV_IS_CASELESS
943 else if (mg_find((const SV *)hv, PERL_MAGIC_env)) {
944 /* XXX This code isn't UTF8 clean. */
945 keysv = newSVpvn_flags(key, klen, SVs_TEMP);
946 if (k_flags & HVhek_FREEKEY) {
949 key = strupr(SvPVX(keysv));
958 xhv = (XPVHV*)SvANY(hv);
962 if (is_utf8 && !(k_flags & HVhek_KEYCANONICAL)) {
963 const char * const keysave = key;
964 key = (char*)bytes_from_utf8((U8*)key, &klen, &is_utf8);
967 k_flags |= HVhek_UTF8;
969 k_flags &= ~HVhek_UTF8;
970 if (key != keysave) {
971 if (k_flags & HVhek_FREEKEY) {
972 /* This shouldn't happen if our caller does what we expect,
973 but strictly the API allows it. */
976 k_flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
978 HvHASKFLAGS_on(MUTABLE_SV(hv));
981 if (HvREHASH(hv) || (!hash && !(keysv && (SvIsCOW_shared_hash(keysv)))))
982 PERL_HASH_INTERNAL_(hash, key, klen, HvREHASH(hv));
984 hash = SvSHARED_HASH(keysv);
986 masked_flags = (k_flags & HVhek_MASK);
988 oentry = &(HvARRAY(hv))[hash & (I32) HvMAX(hv)];
990 for (; entry; oentry = &HeNEXT(entry), entry = *oentry) {
992 U8 mro_changes = 0; /* 1 = isa; 2 = package moved */
996 if (HeHASH(entry) != hash) /* strings can't be equal */
998 if (HeKLEN(entry) != (I32)klen)
1000 if (HeKEY(entry) != key && memNE(HeKEY(entry),key,klen)) /* is this it? */
1002 if ((HeKFLAGS(entry) ^ masked_flags) & HVhek_UTF8)
1005 if (hv == PL_strtab) {
1006 if (k_flags & HVhek_FREEKEY)
1008 Perl_croak(aTHX_ S_strtab_error, "delete");
1011 /* if placeholder is here, it's already been deleted.... */
1012 if (HeVAL(entry) == &PL_sv_placeholder) {
1013 if (k_flags & HVhek_FREEKEY)
1017 if (SvREADONLY(hv) && HeVAL(entry) && SvREADONLY(HeVAL(entry))
1018 && !SvIsCOW(HeVAL(entry))) {
1019 hv_notallowed(k_flags, key, klen,
1020 "Attempt to delete readonly key '%"SVf"' from"
1021 " a restricted hash");
1023 if (k_flags & HVhek_FREEKEY)
1026 /* If this is a stash and the key ends with ::, then someone is
1027 * deleting a package.
1029 if (HeVAL(entry) && HvENAME_get(hv)) {
1030 gv = (GV *)HeVAL(entry);
1031 if (keysv) key = SvPV(keysv, klen);
1033 (klen > 1 && key[klen-2] == ':' && key[klen-1] == ':')
1035 (klen == 1 && key[0] == ':')
1037 && (klen != 6 || hv!=PL_defstash || memNE(key,"main::",6))
1038 && SvTYPE(gv) == SVt_PVGV && (stash = GvHV((GV *)gv))
1039 && HvENAME_get(stash)) {
1040 /* A previous version of this code checked that the
1041 * GV was still in the symbol table by fetching the
1042 * GV with its name. That is not necessary (and
1043 * sometimes incorrect), as HvENAME cannot be set
1044 * on hv if it is not in the symtab. */
1046 /* Hang on to it for a bit. */
1047 SvREFCNT_inc_simple_void_NN(
1048 sv_2mortal((SV *)gv)
1051 else if (klen == 3 && strnEQ(key, "ISA", 3))
1055 sv = d_flags & G_DISCARD ? HeVAL(entry) : sv_2mortal(HeVAL(entry));
1056 HeVAL(entry) = &PL_sv_placeholder;
1058 /* deletion of method from stash */
1059 if (isGV(sv) && isGV_with_GP(sv) && GvCVu(sv)
1061 mro_method_changed_in(hv);
1065 * If a restricted hash, rather than really deleting the entry, put
1066 * a placeholder there. This marks the key as being "approved", so
1067 * we can still access via not-really-existing key without raising
1071 /* We'll be saving this slot, so the number of allocated keys
1072 * doesn't go down, but the number placeholders goes up */
1073 HvPLACEHOLDERS(hv)++;
1075 *oentry = HeNEXT(entry);
1076 if (SvOOK(hv) && entry == HvAUX(hv)->xhv_eiter /* HvEITER(hv) */)
1079 if (SvOOK(hv) && HvLAZYDEL(hv) &&
1080 entry == HeNEXT(HvAUX(hv)->xhv_eiter))
1081 HeNEXT(HvAUX(hv)->xhv_eiter) = HeNEXT(entry);
1082 hv_free_ent(hv, entry);
1084 xhv->xhv_keys--; /* HvTOTALKEYS(hv)-- */
1085 if (xhv->xhv_keys == 0)
1086 HvHASKFLAGS_off(hv);
1089 if (d_flags & G_DISCARD) {
1094 if (mro_changes == 1) mro_isa_changed_in(hv);
1095 else if (mro_changes == 2)
1096 mro_package_moved(NULL, stash, gv, 1);
1100 if (SvREADONLY(hv)) {
1101 hv_notallowed(k_flags, key, klen,
1102 "Attempt to delete disallowed key '%"SVf"' from"
1103 " a restricted hash");
1106 if (k_flags & HVhek_FREEKEY)
1112 S_hsplit(pTHX_ HV *hv)
1115 XPVHV* const xhv = (XPVHV*)SvANY(hv);
1116 const I32 oldsize = (I32) xhv->xhv_max+1; /* HvMAX(hv)+1 (sick) */
1117 I32 newsize = oldsize * 2;
1119 char *a = (char*) HvARRAY(hv);
1121 int longest_chain = 0;
1124 PERL_ARGS_ASSERT_HSPLIT;
1126 /*PerlIO_printf(PerlIO_stderr(), "hsplit called for %p which had %d\n",
1127 (void*)hv, (int) oldsize);*/
1129 if (HvPLACEHOLDERS_get(hv) && !SvREADONLY(hv)) {
1130 /* Can make this clear any placeholders first for non-restricted hashes,
1131 even though Storable rebuilds restricted hashes by putting in all the
1132 placeholders (first) before turning on the readonly flag, because
1133 Storable always pre-splits the hash. */
1134 hv_clear_placeholders(hv);
1138 #if defined(STRANGE_MALLOC) || defined(MYMALLOC)
1139 Renew(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1140 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
1146 Move(&a[oldsize * sizeof(HE*)], &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
1149 Newx(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1150 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
1155 Copy(HvARRAY(hv), a, oldsize * sizeof(HE*), char);
1157 Copy(HvAUX(hv), &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
1159 Safefree(HvARRAY(hv));
1163 Zero(&a[oldsize * sizeof(HE*)], (newsize-oldsize) * sizeof(HE*), char); /* zero 2nd half*/
1164 xhv->xhv_max = --newsize; /* HvMAX(hv) = --newsize */
1165 HvARRAY(hv) = (HE**) a;
1168 for (i=0; i<oldsize; i++,aep++) {
1169 int left_length = 0;
1170 int right_length = 0;
1175 if (!entry) /* non-existent */
1179 if ((HeHASH(entry) & newsize) != (U32)i) {
1180 *oentry = HeNEXT(entry);
1181 HeNEXT(entry) = *bep;
1186 oentry = &HeNEXT(entry);
1191 /* I think we don't actually need to keep track of the longest length,
1192 merely flag if anything is too long. But for the moment while
1193 developing this code I'll track it. */
1194 if (left_length > longest_chain)
1195 longest_chain = left_length;
1196 if (right_length > longest_chain)
1197 longest_chain = right_length;
1201 /* Pick your policy for "hashing isn't working" here: */
1202 if (longest_chain <= HV_MAX_LENGTH_BEFORE_SPLIT /* split worked? */
1207 if (hv == PL_strtab) {
1208 /* Urg. Someone is doing something nasty to the string table.
1213 /* Awooga. Awooga. Pathological data. */
1214 /*PerlIO_printf(PerlIO_stderr(), "%p %d of %d with %d/%d buckets\n", (void*)hv,
1215 longest_chain, HvTOTALKEYS(hv), HvFILL(hv), 1+HvMAX(hv));*/
1218 Newxz(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1219 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
1221 Copy(HvAUX(hv), &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
1224 was_shared = HvSHAREKEYS(hv);
1226 HvSHAREKEYS_off(hv);
1231 for (i=0; i<newsize; i++,aep++) {
1234 /* We're going to trash this HE's next pointer when we chain it
1235 into the new hash below, so store where we go next. */
1236 HE * const next = HeNEXT(entry);
1241 PERL_HASH_INTERNAL(hash, HeKEY(entry), HeKLEN(entry));
1246 = save_hek_flags(HeKEY(entry), HeKLEN(entry),
1247 hash, HeKFLAGS(entry));
1248 unshare_hek (HeKEY_hek(entry));
1249 HeKEY_hek(entry) = new_hek;
1251 /* Not shared, so simply write the new hash in. */
1252 HeHASH(entry) = hash;
1254 /*PerlIO_printf(PerlIO_stderr(), "%d ", HeKFLAGS(entry));*/
1255 HEK_REHASH_on(HeKEY_hek(entry));
1256 /*PerlIO_printf(PerlIO_stderr(), "%d\n", HeKFLAGS(entry));*/
1258 /* Copy oentry to the correct new chain. */
1259 bep = ((HE**)a) + (hash & (I32) xhv->xhv_max);
1260 HeNEXT(entry) = *bep;
1266 Safefree (HvARRAY(hv));
1267 HvARRAY(hv) = (HE **)a;
1271 Perl_hv_ksplit(pTHX_ HV *hv, IV newmax)
1274 XPVHV* xhv = (XPVHV*)SvANY(hv);
1275 const I32 oldsize = (I32) xhv->xhv_max+1; /* HvMAX(hv)+1 (sick) */
1281 PERL_ARGS_ASSERT_HV_KSPLIT;
1283 newsize = (I32) newmax; /* possible truncation here */
1284 if (newsize != newmax || newmax <= oldsize)
1286 while ((newsize & (1 + ~newsize)) != newsize) {
1287 newsize &= ~(newsize & (1 + ~newsize)); /* get proper power of 2 */
1289 if (newsize < newmax)
1291 if (newsize < newmax)
1292 return; /* overflow detection */
1294 a = (char *) HvARRAY(hv);
1297 #if defined(STRANGE_MALLOC) || defined(MYMALLOC)
1298 Renew(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1299 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
1305 Copy(&a[oldsize * sizeof(HE*)], &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
1308 Newx(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1309 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
1314 Copy(HvARRAY(hv), a, oldsize * sizeof(HE*), char);
1316 Copy(HvAUX(hv), &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
1318 Safefree(HvARRAY(hv));
1321 Zero(&a[oldsize * sizeof(HE*)], (newsize-oldsize) * sizeof(HE*), char); /* zero 2nd half*/
1324 Newxz(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize), char);
1326 xhv->xhv_max = --newsize; /* HvMAX(hv) = --newsize */
1327 HvARRAY(hv) = (HE **) a;
1328 if (!xhv->xhv_keys /* !HvTOTALKEYS(hv) */) /* skip rest if no entries */
1332 for (i=0; i<oldsize; i++,aep++) {
1336 if (!entry) /* non-existent */
1339 I32 j = (HeHASH(entry) & newsize);
1343 *oentry = HeNEXT(entry);
1344 HeNEXT(entry) = aep[j];
1348 oentry = &HeNEXT(entry);
1355 Perl_newHVhv(pTHX_ HV *ohv)
1358 HV * const hv = newHV();
1361 if (!ohv || (!HvTOTALKEYS(ohv) && !SvMAGICAL((const SV *)ohv)))
1363 hv_max = HvMAX(ohv);
1365 if (!SvMAGICAL((const SV *)ohv)) {
1366 /* It's an ordinary hash, so copy it fast. AMS 20010804 */
1368 const bool shared = !!HvSHAREKEYS(ohv);
1369 HE **ents, ** const oents = (HE **)HvARRAY(ohv);
1371 Newx(a, PERL_HV_ARRAY_ALLOC_BYTES(hv_max+1), char);
1374 /* In each bucket... */
1375 for (i = 0; i <= hv_max; i++) {
1377 HE *oent = oents[i];
1384 /* Copy the linked list of entries. */
1385 for (; oent; oent = HeNEXT(oent)) {
1386 const U32 hash = HeHASH(oent);
1387 const char * const key = HeKEY(oent);
1388 const STRLEN len = HeKLEN(oent);
1389 const int flags = HeKFLAGS(oent);
1390 HE * const ent = new_HE();
1391 SV *const val = HeVAL(oent);
1393 HeVAL(ent) = SvIMMORTAL(val) ? val : newSVsv(val);
1395 = shared ? share_hek_flags(key, len, hash, flags)
1396 : save_hek_flags(key, len, hash, flags);
1407 HvTOTALKEYS(hv) = HvTOTALKEYS(ohv);
1411 /* Iterate over ohv, copying keys and values one at a time. */
1413 const I32 riter = HvRITER_get(ohv);
1414 HE * const eiter = HvEITER_get(ohv);
1415 STRLEN hv_fill = HvFILL(ohv);
1417 /* Can we use fewer buckets? (hv_max is always 2^n-1) */
1418 while (hv_max && hv_max + 1 >= hv_fill * 2)
1419 hv_max = hv_max / 2;
1423 while ((entry = hv_iternext_flags(ohv, 0))) {
1424 SV *val = hv_iterval(ohv,entry);
1425 SV * const keysv = HeSVKEY(entry);
1426 val = SvIMMORTAL(val) ? val : newSVsv(val);
1428 (void)hv_store_ent(hv, keysv, val, 0);
1430 (void)hv_store_flags(hv, HeKEY(entry), HeKLEN(entry), val,
1431 HeHASH(entry), HeKFLAGS(entry));
1433 HvRITER_set(ohv, riter);
1434 HvEITER_set(ohv, eiter);
1441 =for apidoc Am|HV *|hv_copy_hints_hv|HV *ohv
1443 A specialised version of L</newHVhv> for copying C<%^H>. I<ohv> must be
1444 a pointer to a hash (which may have C<%^H> magic, but should be generally
1445 non-magical), or C<NULL> (interpreted as an empty hash). The content
1446 of I<ohv> is copied to a new hash, which has the C<%^H>-specific magic
1447 added to it. A pointer to the new hash is returned.
1453 Perl_hv_copy_hints_hv(pTHX_ HV *const ohv)
1455 HV * const hv = newHV();
1458 STRLEN hv_max = HvMAX(ohv);
1459 STRLEN hv_fill = HvFILL(ohv);
1461 const I32 riter = HvRITER_get(ohv);
1462 HE * const eiter = HvEITER_get(ohv);
1467 while (hv_max && hv_max + 1 >= hv_fill * 2)
1468 hv_max = hv_max / 2;
1472 while ((entry = hv_iternext_flags(ohv, 0))) {
1473 SV *const sv = newSVsv(hv_iterval(ohv,entry));
1474 SV *heksv = HeSVKEY(entry);
1475 if (!heksv && sv) heksv = newSVhek(HeKEY_hek(entry));
1476 if (sv) sv_magic(sv, NULL, PERL_MAGIC_hintselem,
1477 (char *)heksv, HEf_SVKEY);
1478 if (heksv == HeSVKEY(entry))
1479 (void)hv_store_ent(hv, heksv, sv, 0);
1481 (void)hv_common(hv, heksv, HeKEY(entry), HeKLEN(entry),
1482 HeKFLAGS(entry), HV_FETCH_ISSTORE|HV_FETCH_JUST_SV, sv, HeHASH(entry));
1483 SvREFCNT_dec(heksv);
1486 HvRITER_set(ohv, riter);
1487 HvEITER_set(ohv, eiter);
1489 SvREFCNT_inc_simple_void_NN(hv);
1492 hv_magic(hv, NULL, PERL_MAGIC_hints);
1496 /* like hv_free_ent, but returns the SV rather than freeing it */
1498 S_hv_free_ent_ret(pTHX_ HV *hv, register HE *entry)
1503 PERL_ARGS_ASSERT_HV_FREE_ENT_RET;
1508 if (HeKLEN(entry) == HEf_SVKEY) {
1509 SvREFCNT_dec(HeKEY_sv(entry));
1510 Safefree(HeKEY_hek(entry));
1512 else if (HvSHAREKEYS(hv))
1513 unshare_hek(HeKEY_hek(entry));
1515 Safefree(HeKEY_hek(entry));
1522 Perl_hv_free_ent(pTHX_ HV *hv, register HE *entry)
1527 PERL_ARGS_ASSERT_HV_FREE_ENT;
1531 val = hv_free_ent_ret(hv, entry);
1537 Perl_hv_delayfree_ent(pTHX_ HV *hv, register HE *entry)
1541 PERL_ARGS_ASSERT_HV_DELAYFREE_ENT;
1545 /* SvREFCNT_inc to counter the SvREFCNT_dec in hv_free_ent */
1546 sv_2mortal(SvREFCNT_inc(HeVAL(entry))); /* free between statements */
1547 if (HeKLEN(entry) == HEf_SVKEY) {
1548 sv_2mortal(SvREFCNT_inc(HeKEY_sv(entry)));
1550 hv_free_ent(hv, entry);
1554 =for apidoc hv_clear
1556 Frees the all the elements of a hash, leaving it empty.
1557 The XS equivalent of C<%hash = ()>. See also L</hv_undef>.
1559 If any destructors are triggered as a result, the hv itself may
1566 Perl_hv_clear(pTHX_ HV *hv)
1573 DEBUG_A(Perl_hv_assert(aTHX_ hv));
1575 xhv = (XPVHV*)SvANY(hv);
1578 SAVEFREESV(SvREFCNT_inc_simple_NN(hv));
1579 if (SvREADONLY(hv) && HvARRAY(hv) != NULL) {
1580 /* restricted hash: convert all keys to placeholders */
1582 for (i = 0; i <= xhv->xhv_max; i++) {
1583 HE *entry = (HvARRAY(hv))[i];
1584 for (; entry; entry = HeNEXT(entry)) {
1585 /* not already placeholder */
1586 if (HeVAL(entry) != &PL_sv_placeholder) {
1587 if (HeVAL(entry) && SvREADONLY(HeVAL(entry))
1588 && !SvIsCOW(HeVAL(entry))) {
1589 SV* const keysv = hv_iterkeysv(entry);
1591 "Attempt to delete readonly key '%"SVf"' from a restricted hash",
1594 SvREFCNT_dec(HeVAL(entry));
1595 HeVAL(entry) = &PL_sv_placeholder;
1596 HvPLACEHOLDERS(hv)++;
1603 HvPLACEHOLDERS_set(hv, 0);
1606 mg_clear(MUTABLE_SV(hv));
1608 HvHASKFLAGS_off(hv);
1613 mro_isa_changed_in(hv);
1614 HvEITER_set(hv, NULL);
1620 =for apidoc hv_clear_placeholders
1622 Clears any placeholders from a hash. If a restricted hash has any of its keys
1623 marked as readonly and the key is subsequently deleted, the key is not actually
1624 deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
1625 it so it will be ignored by future operations such as iterating over the hash,
1626 but will still allow the hash to have a value reassigned to the key at some
1627 future point. This function clears any such placeholder keys from the hash.
1628 See Hash::Util::lock_keys() for an example of its use.
1634 Perl_hv_clear_placeholders(pTHX_ HV *hv)
1637 const U32 items = (U32)HvPLACEHOLDERS_get(hv);
1639 PERL_ARGS_ASSERT_HV_CLEAR_PLACEHOLDERS;
1642 clear_placeholders(hv, items);
1646 S_clear_placeholders(pTHX_ HV *hv, U32 items)
1651 PERL_ARGS_ASSERT_CLEAR_PLACEHOLDERS;
1658 /* Loop down the linked list heads */
1659 HE **oentry = &(HvARRAY(hv))[i];
1662 while ((entry = *oentry)) {
1663 if (HeVAL(entry) == &PL_sv_placeholder) {
1664 *oentry = HeNEXT(entry);
1665 if (entry == HvEITER_get(hv))
1668 if (SvOOK(hv) && HvLAZYDEL(hv) &&
1669 entry == HeNEXT(HvAUX(hv)->xhv_eiter))
1670 HeNEXT(HvAUX(hv)->xhv_eiter) = HeNEXT(entry);
1671 hv_free_ent(hv, entry);
1676 HvTOTALKEYS(hv) -= (IV)HvPLACEHOLDERS_get(hv);
1677 if (HvUSEDKEYS(hv) == 0)
1678 HvHASKFLAGS_off(hv);
1679 HvPLACEHOLDERS_set(hv, 0);
1683 oentry = &HeNEXT(entry);
1687 /* You can't get here, hence assertion should always fail. */
1688 assert (items == 0);
1693 S_hfreeentries(pTHX_ HV *hv)
1696 XPVHV * const xhv = (XPVHV*)SvANY(hv);
1699 PERL_ARGS_ASSERT_HFREEENTRIES;
1701 while ((sv = Perl_hfree_next_entry(aTHX_ hv, &index))||xhv->xhv_keys) {
1707 /* hfree_next_entry()
1708 * For use only by S_hfreeentries() and sv_clear().
1709 * Delete the next available HE from hv and return the associated SV.
1710 * Returns null on empty hash. Nevertheless null is not a reliable
1711 * indicator that the hash is empty, as the deleted entry may have a
1713 * indexp is a pointer to the current index into HvARRAY. The index should
1714 * initially be set to 0. hfree_next_entry() may update it. */
1717 Perl_hfree_next_entry(pTHX_ HV *hv, STRLEN *indexp)
1719 struct xpvhv_aux *iter;
1723 STRLEN orig_index = *indexp;
1726 PERL_ARGS_ASSERT_HFREE_NEXT_ENTRY;
1728 if (SvOOK(hv) && ((iter = HvAUX(hv)))
1729 && ((entry = iter->xhv_eiter)) )
1731 /* the iterator may get resurrected after each
1732 * destructor call, so check each time */
1733 if (entry && HvLAZYDEL(hv)) { /* was deleted earlier? */
1735 hv_free_ent(hv, entry);
1736 /* warning: at this point HvARRAY may have been
1737 * re-allocated, HvMAX changed etc */
1739 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
1740 iter->xhv_eiter = NULL; /* HvEITER(hv) = NULL */
1743 if (!((XPVHV*)SvANY(hv))->xhv_keys)
1746 array = HvARRAY(hv);
1748 while ( ! ((entry = array[*indexp])) ) {
1749 if ((*indexp)++ >= HvMAX(hv))
1751 assert(*indexp != orig_index);
1753 array[*indexp] = HeNEXT(entry);
1754 ((XPVHV*) SvANY(hv))->xhv_keys--;
1756 if ( PL_phase != PERL_PHASE_DESTRUCT && HvENAME(hv)
1757 && HeVAL(entry) && isGV(HeVAL(entry))
1758 && GvHV(HeVAL(entry)) && HvENAME(GvHV(HeVAL(entry)))
1761 const char * const key = HePV(entry,klen);
1762 if ((klen > 1 && key[klen-1]==':' && key[klen-2]==':')
1763 || (klen == 1 && key[0] == ':')) {
1765 NULL, GvHV(HeVAL(entry)),
1766 (GV *)HeVAL(entry), 0
1770 return hv_free_ent_ret(hv, entry);
1775 =for apidoc hv_undef
1777 Undefines the hash. The XS equivalent of C<undef(%hash)>.
1779 As well as freeing all the elements of the hash (like hv_clear()), this
1780 also frees any auxiliary data and storage associated with the hash.
1782 If any destructors are triggered as a result, the hv itself may
1785 See also L</hv_clear>.
1791 Perl_hv_undef_flags(pTHX_ HV *hv, U32 flags)
1796 const bool save = !!SvREFCNT(hv);
1800 DEBUG_A(Perl_hv_assert(aTHX_ hv));
1801 xhv = (XPVHV*)SvANY(hv);
1803 /* The name must be deleted before the call to hfreeeeentries so that
1804 CVs are anonymised properly. But the effective name must be pre-
1805 served until after that call (and only deleted afterwards if the
1806 call originated from sv_clear). For stashes with one name that is
1807 both the canonical name and the effective name, hv_name_set has to
1808 allocate an array for storing the effective name. We can skip that
1809 during global destruction, as it does not matter where the CVs point
1810 if they will be freed anyway. */
1811 /* note that the code following prior to hfreeentries is duplicated
1812 * in sv_clear(), and changes here should be done there too */
1813 if (PL_phase != PERL_PHASE_DESTRUCT && (name = HvNAME(hv))) {
1814 if (PL_stashcache) {
1815 DEBUG_o(Perl_deb(aTHX_ "hv_undef_flags clearing PL_stashcache for '%"
1816 HEKf"'\n", HvNAME_HEK(hv)));
1817 (void)hv_delete(PL_stashcache, name,
1818 HEK_UTF8(HvNAME_HEK(hv)) ? -HvNAMELEN_get(hv) : HvNAMELEN_get(hv),
1822 hv_name_set(hv, NULL, 0, 0);
1826 SAVEFREESV(SvREFCNT_inc_simple_NN(hv));
1830 struct xpvhv_aux * const aux = HvAUX(hv);
1831 struct mro_meta *meta;
1833 if ((name = HvENAME_get(hv))) {
1834 if (PL_phase != PERL_PHASE_DESTRUCT)
1835 mro_isa_changed_in(hv);
1836 if (PL_stashcache) {
1837 DEBUG_o(Perl_deb(aTHX_ "hv_undef_flags clearing PL_stashcache for effective name '%"
1838 HEKf"'\n", HvENAME_HEK(hv)));
1840 PL_stashcache, name,
1841 HEK_UTF8(HvENAME_HEK(hv)) ? -HvENAMELEN_get(hv) : HvENAMELEN_get(hv),
1847 /* If this call originated from sv_clear, then we must check for
1848 * effective names that need freeing, as well as the usual name. */
1850 if (flags & HV_NAME_SETALL ? !!aux->xhv_name_u.xhvnameu_name : !!name) {
1851 if (name && PL_stashcache) {
1852 DEBUG_o(Perl_deb(aTHX_ "hv_undef_flags clearing PL_stashcache for name '%"
1853 HEKf"'\n", HvNAME_HEK(hv)));
1854 (void)hv_delete(PL_stashcache, name, (HEK_UTF8(HvNAME_HEK(hv)) ? -HvNAMELEN_get(hv) : HvNAMELEN_get(hv)), G_DISCARD);
1856 hv_name_set(hv, NULL, 0, flags);
1858 if((meta = aux->xhv_mro_meta)) {
1859 if (meta->mro_linear_all) {
1860 SvREFCNT_dec(MUTABLE_SV(meta->mro_linear_all));
1861 meta->mro_linear_all = NULL;
1862 /* This is just acting as a shortcut pointer. */
1863 meta->mro_linear_current = NULL;
1864 } else if (meta->mro_linear_current) {
1865 /* Only the current MRO is stored, so this owns the data.
1867 SvREFCNT_dec(meta->mro_linear_current);
1868 meta->mro_linear_current = NULL;
1870 SvREFCNT_dec(meta->mro_nextmethod);
1871 SvREFCNT_dec(meta->isa);
1873 aux->xhv_mro_meta = NULL;
1875 SvREFCNT_dec(aux->xhv_super);
1876 if (!aux->xhv_name_u.xhvnameu_name && ! aux->xhv_backreferences)
1877 SvFLAGS(hv) &= ~SVf_OOK;
1880 Safefree(HvARRAY(hv));
1881 xhv->xhv_max = 7; /* HvMAX(hv) = 7 (it's a normal hash) */
1884 /* if we're freeing the HV, the SvMAGIC field has been reused for
1885 * other purposes, and so there can't be any placeholder magic */
1887 HvPLACEHOLDERS_set(hv, 0);
1890 mg_clear(MUTABLE_SV(hv));
1897 Returns the number of hash buckets that happen to be in use. This function is
1898 wrapped by the macro C<HvFILL>.
1900 Previously this value was stored in the HV structure, rather than being
1901 calculated on demand.
1907 Perl_hv_fill(pTHX_ HV const *const hv)
1910 HE **ents = HvARRAY(hv);
1912 PERL_ARGS_ASSERT_HV_FILL;
1915 HE *const *const last = ents + HvMAX(hv);
1916 count = last + 1 - ents;
1921 } while (++ents <= last);
1926 static struct xpvhv_aux*
1927 S_hv_auxinit(HV *hv) {
1928 struct xpvhv_aux *iter;
1931 PERL_ARGS_ASSERT_HV_AUXINIT;
1934 Newxz(array, PERL_HV_ARRAY_ALLOC_BYTES(HvMAX(hv) + 1)
1935 + sizeof(struct xpvhv_aux), char);
1937 array = (char *) HvARRAY(hv);
1938 Renew(array, PERL_HV_ARRAY_ALLOC_BYTES(HvMAX(hv) + 1)
1939 + sizeof(struct xpvhv_aux), char);
1941 HvARRAY(hv) = (HE**) array;
1945 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
1946 iter->xhv_eiter = NULL; /* HvEITER(hv) = NULL */
1947 iter->xhv_name_u.xhvnameu_name = 0;
1948 iter->xhv_name_count = 0;
1949 iter->xhv_backreferences = 0;
1950 iter->xhv_mro_meta = NULL;
1951 iter->xhv_super = NULL;
1956 =for apidoc hv_iterinit
1958 Prepares a starting point to traverse a hash table. Returns the number of
1959 keys in the hash (i.e. the same as C<HvUSEDKEYS(hv)>). The return value is
1960 currently only meaningful for hashes without tie magic.
1962 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1963 hash buckets that happen to be in use. If you still need that esoteric
1964 value, you can get it through the macro C<HvFILL(hv)>.
1971 Perl_hv_iterinit(pTHX_ HV *hv)
1973 PERL_ARGS_ASSERT_HV_ITERINIT;
1975 /* FIXME: Are we not NULL, or do we croak? Place bets now! */
1978 Perl_croak(aTHX_ "Bad hash");
1981 struct xpvhv_aux * const iter = HvAUX(hv);
1982 HE * const entry = iter->xhv_eiter; /* HvEITER(hv) */
1983 if (entry && HvLAZYDEL(hv)) { /* was deleted earlier? */
1985 hv_free_ent(hv, entry);
1987 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
1988 iter->xhv_eiter = NULL; /* HvEITER(hv) = NULL */
1993 /* used to be xhv->xhv_fill before 5.004_65 */
1994 return HvTOTALKEYS(hv);
1998 Perl_hv_riter_p(pTHX_ HV *hv) {
1999 struct xpvhv_aux *iter;
2001 PERL_ARGS_ASSERT_HV_RITER_P;
2004 Perl_croak(aTHX_ "Bad hash");
2006 iter = SvOOK(hv) ? HvAUX(hv) : hv_auxinit(hv);
2007 return &(iter->xhv_riter);
2011 Perl_hv_eiter_p(pTHX_ HV *hv) {
2012 struct xpvhv_aux *iter;
2014 PERL_ARGS_ASSERT_HV_EITER_P;
2017 Perl_croak(aTHX_ "Bad hash");
2019 iter = SvOOK(hv) ? HvAUX(hv) : hv_auxinit(hv);
2020 return &(iter->xhv_eiter);
2024 Perl_hv_riter_set(pTHX_ HV *hv, I32 riter) {
2025 struct xpvhv_aux *iter;
2027 PERL_ARGS_ASSERT_HV_RITER_SET;
2030 Perl_croak(aTHX_ "Bad hash");
2038 iter = hv_auxinit(hv);
2040 iter->xhv_riter = riter;
2044 Perl_hv_eiter_set(pTHX_ HV *hv, HE *eiter) {
2045 struct xpvhv_aux *iter;
2047 PERL_ARGS_ASSERT_HV_EITER_SET;
2050 Perl_croak(aTHX_ "Bad hash");
2055 /* 0 is the default so don't go malloc()ing a new structure just to
2060 iter = hv_auxinit(hv);
2062 iter->xhv_eiter = eiter;
2066 Perl_hv_name_set(pTHX_ HV *hv, const char *name, U32 len, U32 flags)
2069 struct xpvhv_aux *iter;
2073 PERL_ARGS_ASSERT_HV_NAME_SET;
2076 Perl_croak(aTHX_ "panic: hv name too long (%"UVuf")", (UV) len);
2080 if (iter->xhv_name_u.xhvnameu_name) {
2081 if(iter->xhv_name_count) {
2082 if(flags & HV_NAME_SETALL) {
2083 HEK ** const name = HvAUX(hv)->xhv_name_u.xhvnameu_names;
2084 HEK **hekp = name + (
2085 iter->xhv_name_count < 0
2086 ? -iter->xhv_name_count
2087 : iter->xhv_name_count
2089 while(hekp-- > name+1)
2090 unshare_hek_or_pvn(*hekp, 0, 0, 0);
2091 /* The first elem may be null. */
2092 if(*name) unshare_hek_or_pvn(*name, 0, 0, 0);
2094 spot = &iter->xhv_name_u.xhvnameu_name;
2095 iter->xhv_name_count = 0;
2098 if(iter->xhv_name_count > 0) {
2099 /* shift some things over */
2101 iter->xhv_name_u.xhvnameu_names, iter->xhv_name_count + 1, HEK *
2103 spot = iter->xhv_name_u.xhvnameu_names;
2104 spot[iter->xhv_name_count] = spot[1];
2106 iter->xhv_name_count = -(iter->xhv_name_count + 1);
2108 else if(*(spot = iter->xhv_name_u.xhvnameu_names)) {
2109 unshare_hek_or_pvn(*spot, 0, 0, 0);
2113 else if (flags & HV_NAME_SETALL) {
2114 unshare_hek_or_pvn(iter->xhv_name_u.xhvnameu_name, 0, 0, 0);
2115 spot = &iter->xhv_name_u.xhvnameu_name;
2118 HEK * const existing_name = iter->xhv_name_u.xhvnameu_name;
2119 Newx(iter->xhv_name_u.xhvnameu_names, 2, HEK *);
2120 iter->xhv_name_count = -2;
2121 spot = iter->xhv_name_u.xhvnameu_names;
2122 spot[1] = existing_name;
2125 else { spot = &iter->xhv_name_u.xhvnameu_name; iter->xhv_name_count = 0; }
2130 iter = hv_auxinit(hv);
2131 spot = &iter->xhv_name_u.xhvnameu_name;
2133 PERL_HASH(hash, name, len);
2134 *spot = name ? share_hek(name, flags & SVf_UTF8 ? -(I32)len : (I32)len, hash) : NULL;
2138 This is basically sv_eq_flags() in sv.c, but we avoid the magic
2143 hek_eq_pvn_flags(pTHX_ const HEK *hek, const char* pv, const I32 pvlen, const U32 flags) {
2144 if ( (HEK_UTF8(hek) ? 1 : 0) != (flags & SVf_UTF8 ? 1 : 0) ) {
2145 if (flags & SVf_UTF8)
2146 return (bytes_cmp_utf8(
2147 (const U8*)HEK_KEY(hek), HEK_LEN(hek),
2148 (const U8*)pv, pvlen) == 0);
2150 return (bytes_cmp_utf8(
2151 (const U8*)pv, pvlen,
2152 (const U8*)HEK_KEY(hek), HEK_LEN(hek)) == 0);
2155 return HEK_LEN(hek) == pvlen && ((HEK_KEY(hek) == pv)
2156 || memEQ(HEK_KEY(hek), pv, pvlen));
2160 =for apidoc hv_ename_add
2162 Adds a name to a stash's internal list of effective names. See
2165 This is called when a stash is assigned to a new location in the symbol
2172 Perl_hv_ename_add(pTHX_ HV *hv, const char *name, U32 len, U32 flags)
2175 struct xpvhv_aux *aux = SvOOK(hv) ? HvAUX(hv) : hv_auxinit(hv);
2178 PERL_ARGS_ASSERT_HV_ENAME_ADD;
2181 Perl_croak(aTHX_ "panic: hv name too long (%"UVuf")", (UV) len);
2183 PERL_HASH(hash, name, len);
2185 if (aux->xhv_name_count) {
2186 HEK ** const xhv_name = aux->xhv_name_u.xhvnameu_names;
2187 I32 count = aux->xhv_name_count;
2188 HEK **hekp = xhv_name + (count < 0 ? -count : count);
2189 while (hekp-- > xhv_name)
2191 (HEK_UTF8(*hekp) || (flags & SVf_UTF8))
2192 ? hek_eq_pvn_flags(aTHX_ *hekp, name, (I32)len, flags)
2193 : (HEK_LEN(*hekp) == (I32)len && memEQ(HEK_KEY(*hekp), name, len))
2195 if (hekp == xhv_name && count < 0)
2196 aux->xhv_name_count = -count;
2199 if (count < 0) aux->xhv_name_count--, count = -count;
2200 else aux->xhv_name_count++;
2201 Renew(aux->xhv_name_u.xhvnameu_names, count + 1, HEK *);
2202 (aux->xhv_name_u.xhvnameu_names)[count] = share_hek(name, (flags & SVf_UTF8 ? -(I32)len : (I32)len), hash);
2205 HEK *existing_name = aux->xhv_name_u.xhvnameu_name;
2208 (HEK_UTF8(existing_name) || (flags & SVf_UTF8))
2209 ? hek_eq_pvn_flags(aTHX_ existing_name, name, (I32)len, flags)
2210 : (HEK_LEN(existing_name) == (I32)len && memEQ(HEK_KEY(existing_name), name, len))
2213 Newx(aux->xhv_name_u.xhvnameu_names, 2, HEK *);
2214 aux->xhv_name_count = existing_name ? 2 : -2;
2215 *aux->xhv_name_u.xhvnameu_names = existing_name;
2216 (aux->xhv_name_u.xhvnameu_names)[1] = share_hek(name, (flags & SVf_UTF8 ? -(I32)len : (I32)len), hash);
2221 =for apidoc hv_ename_delete
2223 Removes a name from a stash's internal list of effective names. If this is
2224 the name returned by C<HvENAME>, then another name in the list will take
2225 its place (C<HvENAME> will use it).
2227 This is called when a stash is deleted from the symbol table.
2233 Perl_hv_ename_delete(pTHX_ HV *hv, const char *name, U32 len, U32 flags)
2236 struct xpvhv_aux *aux;
2238 PERL_ARGS_ASSERT_HV_ENAME_DELETE;
2241 Perl_croak(aTHX_ "panic: hv name too long (%"UVuf")", (UV) len);
2243 if (!SvOOK(hv)) return;
2246 if (!aux->xhv_name_u.xhvnameu_name) return;
2248 if (aux->xhv_name_count) {
2249 HEK ** const namep = aux->xhv_name_u.xhvnameu_names;
2250 I32 const count = aux->xhv_name_count;
2251 HEK **victim = namep + (count < 0 ? -count : count);
2252 while (victim-- > namep + 1)
2254 (HEK_UTF8(*victim) || (flags & SVf_UTF8))
2255 ? hek_eq_pvn_flags(aTHX_ *victim, name, (I32)len, flags)
2256 : (HEK_LEN(*victim) == (I32)len && memEQ(HEK_KEY(*victim), name, len))
2258 unshare_hek_or_pvn(*victim, 0, 0, 0);
2259 if (count < 0) ++aux->xhv_name_count;
2260 else --aux->xhv_name_count;
2262 (aux->xhv_name_count == 1 || aux->xhv_name_count == -1)
2264 ) { /* if there are none left */
2266 aux->xhv_name_u.xhvnameu_names = NULL;
2267 aux->xhv_name_count = 0;
2270 /* Move the last one back to fill the empty slot. It
2271 does not matter what order they are in. */
2272 *victim = *(namep + (count < 0 ? -count : count) - 1);
2277 count > 0 && (HEK_UTF8(*namep) || (flags & SVf_UTF8))
2278 ? hek_eq_pvn_flags(aTHX_ *namep, name, (I32)len, flags)
2279 : (HEK_LEN(*namep) == (I32)len && memEQ(HEK_KEY(*namep), name, len))
2281 aux->xhv_name_count = -count;
2285 (HEK_UTF8(aux->xhv_name_u.xhvnameu_name) || (flags & SVf_UTF8))
2286 ? hek_eq_pvn_flags(aTHX_ aux->xhv_name_u.xhvnameu_name, name, (I32)len, flags)
2287 : (HEK_LEN(aux->xhv_name_u.xhvnameu_name) == (I32)len &&
2288 memEQ(HEK_KEY(aux->xhv_name_u.xhvnameu_name), name, len))
2290 HEK * const namehek = aux->xhv_name_u.xhvnameu_name;
2291 Newx(aux->xhv_name_u.xhvnameu_names, 1, HEK *);
2292 *aux->xhv_name_u.xhvnameu_names = namehek;
2293 aux->xhv_name_count = -1;
2298 Perl_hv_backreferences_p(pTHX_ HV *hv) {
2299 struct xpvhv_aux * const iter = SvOOK(hv) ? HvAUX(hv) : hv_auxinit(hv);
2301 PERL_ARGS_ASSERT_HV_BACKREFERENCES_P;
2302 PERL_UNUSED_CONTEXT;
2304 return &(iter->xhv_backreferences);
2308 Perl_hv_kill_backrefs(pTHX_ HV *hv) {
2311 PERL_ARGS_ASSERT_HV_KILL_BACKREFS;
2316 av = HvAUX(hv)->xhv_backreferences;
2319 HvAUX(hv)->xhv_backreferences = 0;
2320 Perl_sv_kill_backrefs(aTHX_ MUTABLE_SV(hv), av);
2321 if (SvTYPE(av) == SVt_PVAV)
2327 hv_iternext is implemented as a macro in hv.h
2329 =for apidoc hv_iternext
2331 Returns entries from a hash iterator. See C<hv_iterinit>.
2333 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
2334 iterator currently points to, without losing your place or invalidating your
2335 iterator. Note that in this case the current entry is deleted from the hash
2336 with your iterator holding the last reference to it. Your iterator is flagged
2337 to free the entry on the next call to C<hv_iternext>, so you must not discard
2338 your iterator immediately else the entry will leak - call C<hv_iternext> to
2339 trigger the resource deallocation.
2341 =for apidoc hv_iternext_flags
2343 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
2344 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
2345 set the placeholders keys (for restricted hashes) will be returned in addition
2346 to normal keys. By default placeholders are automatically skipped over.
2347 Currently a placeholder is implemented with a value that is
2348 C<&PL_sv_placeholder>. Note that the implementation of placeholders and
2349 restricted hashes may change, and the implementation currently is
2350 insufficiently abstracted for any change to be tidy.
2356 Perl_hv_iternext_flags(pTHX_ HV *hv, I32 flags)
2363 struct xpvhv_aux *iter;
2365 PERL_ARGS_ASSERT_HV_ITERNEXT_FLAGS;
2368 Perl_croak(aTHX_ "Bad hash");
2370 xhv = (XPVHV*)SvANY(hv);
2373 /* Too many things (well, pp_each at least) merrily assume that you can
2374 call hv_iternext without calling hv_iterinit, so we'll have to deal
2380 oldentry = entry = iter->xhv_eiter; /* HvEITER(hv) */
2381 if (SvMAGICAL(hv) && SvRMAGICAL(hv)) {
2382 if ( ( mg = mg_find((const SV *)hv, PERL_MAGIC_tied) ) ) {
2383 SV * const key = sv_newmortal();
2385 sv_setsv(key, HeSVKEY_force(entry));
2386 SvREFCNT_dec(HeSVKEY(entry)); /* get rid of previous key */
2387 HeSVKEY_set(entry, NULL);
2393 /* one HE per MAGICAL hash */
2394 iter->xhv_eiter = entry = new_HE(); /* HvEITER(hv) = new_HE() */
2395 HvLAZYDEL_on(hv); /* make sure entry gets freed */
2397 Newxz(k, HEK_BASESIZE + sizeof(const SV *), char);
2399 HeKEY_hek(entry) = hek;
2400 HeKLEN(entry) = HEf_SVKEY;
2402 magic_nextpack(MUTABLE_SV(hv),mg,key);
2404 /* force key to stay around until next time */
2405 HeSVKEY_set(entry, SvREFCNT_inc_simple_NN(key));
2406 return entry; /* beware, hent_val is not set */
2408 SvREFCNT_dec(HeVAL(entry));
2409 Safefree(HeKEY_hek(entry));
2411 iter->xhv_eiter = NULL; /* HvEITER(hv) = NULL */
2416 #if defined(DYNAMIC_ENV_FETCH) && !defined(__riscos__) /* set up %ENV for iteration */
2417 if (!entry && SvRMAGICAL((const SV *)hv)
2418 && mg_find((const SV *)hv, PERL_MAGIC_env)) {
2421 /* The prime_env_iter() on VMS just loaded up new hash values
2422 * so the iteration count needs to be reset back to the beginning
2426 oldentry = entry = iter->xhv_eiter; /* HvEITER(hv) */
2431 /* hv_iterinit now ensures this. */
2432 assert (HvARRAY(hv));
2434 /* At start of hash, entry is NULL. */
2437 entry = HeNEXT(entry);
2438 if (!(flags & HV_ITERNEXT_WANTPLACEHOLDERS)) {
2440 * Skip past any placeholders -- don't want to include them in
2443 while (entry && HeVAL(entry) == &PL_sv_placeholder) {
2444 entry = HeNEXT(entry);
2449 /* Skip the entire loop if the hash is empty. */
2450 if ((flags & HV_ITERNEXT_WANTPLACEHOLDERS)
2451 ? HvTOTALKEYS(hv) : HvUSEDKEYS(hv)) {
2453 /* OK. Come to the end of the current list. Grab the next one. */
2455 iter->xhv_riter++; /* HvRITER(hv)++ */
2456 if (iter->xhv_riter > (I32)xhv->xhv_max /* HvRITER(hv) > HvMAX(hv) */) {
2457 /* There is no next one. End of the hash. */
2458 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
2461 entry = (HvARRAY(hv))[iter->xhv_riter];
2463 if (!(flags & HV_ITERNEXT_WANTPLACEHOLDERS)) {
2464 /* If we have an entry, but it's a placeholder, don't count it.
2466 while (entry && HeVAL(entry) == &PL_sv_placeholder)
2467 entry = HeNEXT(entry);
2469 /* Will loop again if this linked list starts NULL
2470 (for HV_ITERNEXT_WANTPLACEHOLDERS)
2471 or if we run through it and find only placeholders. */
2474 else iter->xhv_riter = -1;
2476 if (oldentry && HvLAZYDEL(hv)) { /* was deleted earlier? */
2478 hv_free_ent(hv, oldentry);
2481 /*if (HvREHASH(hv) && entry && !HeKREHASH(entry))
2482 PerlIO_printf(PerlIO_stderr(), "Awooga %p %p\n", (void*)hv, (void*)entry);*/
2484 iter->xhv_eiter = entry; /* HvEITER(hv) = entry */
2489 =for apidoc hv_iterkey
2491 Returns the key from the current position of the hash iterator. See
2498 Perl_hv_iterkey(pTHX_ register HE *entry, I32 *retlen)
2500 PERL_ARGS_ASSERT_HV_ITERKEY;
2502 if (HeKLEN(entry) == HEf_SVKEY) {
2504 char * const p = SvPV(HeKEY_sv(entry), len);
2509 *retlen = HeKLEN(entry);
2510 return HeKEY(entry);
2514 /* unlike hv_iterval(), this always returns a mortal copy of the key */
2516 =for apidoc hv_iterkeysv
2518 Returns the key as an C<SV*> from the current position of the hash
2519 iterator. The return value will always be a mortal copy of the key. Also
2526 Perl_hv_iterkeysv(pTHX_ register HE *entry)
2528 PERL_ARGS_ASSERT_HV_ITERKEYSV;
2530 return sv_2mortal(newSVhek(HeKEY_hek(entry)));
2534 =for apidoc hv_iterval
2536 Returns the value from the current position of the hash iterator. See
2543 Perl_hv_iterval(pTHX_ HV *hv, register HE *entry)
2545 PERL_ARGS_ASSERT_HV_ITERVAL;
2547 if (SvRMAGICAL(hv)) {
2548 if (mg_find((const SV *)hv, PERL_MAGIC_tied)) {
2549 SV* const sv = sv_newmortal();
2550 if (HeKLEN(entry) == HEf_SVKEY)
2551 mg_copy(MUTABLE_SV(hv), sv, (char*)HeKEY_sv(entry), HEf_SVKEY);
2553 mg_copy(MUTABLE_SV(hv), sv, HeKEY(entry), HeKLEN(entry));
2557 return HeVAL(entry);
2561 =for apidoc hv_iternextsv
2563 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
2570 Perl_hv_iternextsv(pTHX_ HV *hv, char **key, I32 *retlen)
2572 HE * const he = hv_iternext_flags(hv, 0);
2574 PERL_ARGS_ASSERT_HV_ITERNEXTSV;
2578 *key = hv_iterkey(he, retlen);
2579 return hv_iterval(hv, he);
2586 =for apidoc hv_magic
2588 Adds magic to a hash. See C<sv_magic>.
2593 /* possibly free a shared string if no one has access to it
2594 * len and hash must both be valid for str.
2597 Perl_unsharepvn(pTHX_ const char *str, I32 len, U32 hash)
2599 unshare_hek_or_pvn (NULL, str, len, hash);
2604 Perl_unshare_hek(pTHX_ HEK *hek)
2607 unshare_hek_or_pvn(hek, NULL, 0, 0);
2610 /* possibly free a shared string if no one has access to it
2611 hek if non-NULL takes priority over the other 3, else str, len and hash
2612 are used. If so, len and hash must both be valid for str.
2615 S_unshare_hek_or_pvn(pTHX_ const HEK *hek, const char *str, I32 len, U32 hash)
2621 bool is_utf8 = FALSE;
2623 const char * const save = str;
2624 struct shared_he *he = NULL;
2627 /* Find the shared he which is just before us in memory. */
2628 he = (struct shared_he *)(((char *)hek)
2629 - STRUCT_OFFSET(struct shared_he,
2632 /* Assert that the caller passed us a genuine (or at least consistent)
2634 assert (he->shared_he_he.hent_hek == hek);
2636 if (he->shared_he_he.he_valu.hent_refcount - 1) {
2637 --he->shared_he_he.he_valu.hent_refcount;
2641 hash = HEK_HASH(hek);
2642 } else if (len < 0) {
2643 STRLEN tmplen = -len;
2645 /* See the note in hv_fetch(). --jhi */
2646 str = (char*)bytes_from_utf8((U8*)str, &tmplen, &is_utf8);
2649 k_flags = HVhek_UTF8;
2651 k_flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
2654 /* what follows was the moral equivalent of:
2655 if ((Svp = hv_fetch(PL_strtab, tmpsv, FALSE, hash))) {
2657 hv_delete(PL_strtab, str, len, G_DISCARD, hash);
2659 xhv = (XPVHV*)SvANY(PL_strtab);
2660 /* assert(xhv_array != 0) */
2661 oentry = &(HvARRAY(PL_strtab))[hash & (I32) HvMAX(PL_strtab)];
2663 const HE *const he_he = &(he->shared_he_he);
2664 for (entry = *oentry; entry; oentry = &HeNEXT(entry), entry = *oentry) {
2669 const int flags_masked = k_flags & HVhek_MASK;
2670 for (entry = *oentry; entry; oentry = &HeNEXT(entry), entry = *oentry) {
2671 if (HeHASH(entry) != hash) /* strings can't be equal */
2673 if (HeKLEN(entry) != len)
2675 if (HeKEY(entry) != str && memNE(HeKEY(entry),str,len)) /* is this it? */
2677 if (HeKFLAGS(entry) != flags_masked)
2684 if (--entry->he_valu.hent_refcount == 0) {
2685 *oentry = HeNEXT(entry);
2687 xhv->xhv_keys--; /* HvTOTALKEYS(hv)-- */
2692 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
2693 "Attempt to free nonexistent shared string '%s'%s"
2695 hek ? HEK_KEY(hek) : str,
2696 ((k_flags & HVhek_UTF8) ? " (utf8)" : "") pTHX__VALUE);
2697 if (k_flags & HVhek_FREEKEY)
2701 /* get a (constant) string ptr from the global string table
2702 * string will get added if it is not already there.
2703 * len and hash must both be valid for str.
2706 Perl_share_hek(pTHX_ const char *str, I32 len, register U32 hash)
2708 bool is_utf8 = FALSE;
2710 const char * const save = str;
2712 PERL_ARGS_ASSERT_SHARE_HEK;
2715 STRLEN tmplen = -len;
2717 /* See the note in hv_fetch(). --jhi */
2718 str = (char*)bytes_from_utf8((U8*)str, &tmplen, &is_utf8);
2720 /* If we were able to downgrade here, then than means that we were passed
2721 in a key which only had chars 0-255, but was utf8 encoded. */
2724 /* If we found we were able to downgrade the string to bytes, then
2725 we should flag that it needs upgrading on keys or each. Also flag
2726 that we need share_hek_flags to free the string. */
2728 PERL_HASH(hash, str, len);
2729 flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
2733 return share_hek_flags (str, len, hash, flags);
2737 S_share_hek_flags(pTHX_ const char *str, I32 len, register U32 hash, int flags)
2741 const int flags_masked = flags & HVhek_MASK;
2742 const U32 hindex = hash & (I32) HvMAX(PL_strtab);
2743 XPVHV * const xhv = (XPVHV*)SvANY(PL_strtab);
2745 PERL_ARGS_ASSERT_SHARE_HEK_FLAGS;
2747 /* what follows is the moral equivalent of:
2749 if (!(Svp = hv_fetch(PL_strtab, str, len, FALSE)))
2750 hv_store(PL_strtab, str, len, NULL, hash);
2752 Can't rehash the shared string table, so not sure if it's worth
2753 counting the number of entries in the linked list
2756 /* assert(xhv_array != 0) */
2757 entry = (HvARRAY(PL_strtab))[hindex];
2758 for (;entry; entry = HeNEXT(entry)) {
2759 if (HeHASH(entry) != hash) /* strings can't be equal */
2761 if (HeKLEN(entry) != len)
2763 if (HeKEY(entry) != str && memNE(HeKEY(entry),str,len)) /* is this it? */
2765 if (HeKFLAGS(entry) != flags_masked)
2771 /* What used to be head of the list.
2772 If this is NULL, then we're the first entry for this slot, which
2773 means we need to increate fill. */
2774 struct shared_he *new_entry;
2777 HE **const head = &HvARRAY(PL_strtab)[hindex];
2778 HE *const next = *head;
2780 /* We don't actually store a HE from the arena and a regular HEK.
2781 Instead we allocate one chunk of memory big enough for both,
2782 and put the HEK straight after the HE. This way we can find the
2783 HE directly from the HEK.
2786 Newx(k, STRUCT_OFFSET(struct shared_he,
2787 shared_he_hek.hek_key[0]) + len + 2, char);
2788 new_entry = (struct shared_he *)k;
2789 entry = &(new_entry->shared_he_he);
2790 hek = &(new_entry->shared_he_hek);
2792 Copy(str, HEK_KEY(hek), len, char);
2793 HEK_KEY(hek)[len] = 0;
2795 HEK_HASH(hek) = hash;
2796 HEK_FLAGS(hek) = (unsigned char)flags_masked;
2798 /* Still "point" to the HEK, so that other code need not know what
2800 HeKEY_hek(entry) = hek;
2801 entry->he_valu.hent_refcount = 0;
2802 HeNEXT(entry) = next;
2805 xhv->xhv_keys++; /* HvTOTALKEYS(hv)++ */
2806 if (!next) { /* initial entry? */
2807 } else if (xhv->xhv_keys > xhv->xhv_max /* HvUSEDKEYS(hv) > HvMAX(hv) */) {
2812 ++entry->he_valu.hent_refcount;
2814 if (flags & HVhek_FREEKEY)
2817 return HeKEY_hek(entry);
2821 Perl_hv_placeholders_p(pTHX_ HV *hv)
2824 MAGIC *mg = mg_find((const SV *)hv, PERL_MAGIC_rhash);
2826 PERL_ARGS_ASSERT_HV_PLACEHOLDERS_P;
2829 mg = sv_magicext(MUTABLE_SV(hv), 0, PERL_MAGIC_rhash, 0, 0, 0);
2832 Perl_die(aTHX_ "panic: hv_placeholders_p");
2835 return &(mg->mg_len);
2840 Perl_hv_placeholders_get(pTHX_ const HV *hv)
2843 MAGIC * const mg = mg_find((const SV *)hv, PERL_MAGIC_rhash);
2845 PERL_ARGS_ASSERT_HV_PLACEHOLDERS_GET;
2847 return mg ? mg->mg_len : 0;
2851 Perl_hv_placeholders_set(pTHX_ HV *hv, I32 ph)
2854 MAGIC * const mg = mg_find((const SV *)hv, PERL_MAGIC_rhash);
2856 PERL_ARGS_ASSERT_HV_PLACEHOLDERS_SET;
2861 if (!sv_magicext(MUTABLE_SV(hv), 0, PERL_MAGIC_rhash, 0, 0, ph))
2862 Perl_die(aTHX_ "panic: hv_placeholders_set");
2864 /* else we don't need to add magic to record 0 placeholders. */
2868 S_refcounted_he_value(pTHX_ const struct refcounted_he *he)
2873 PERL_ARGS_ASSERT_REFCOUNTED_HE_VALUE;
2875 switch(he->refcounted_he_data[0] & HVrhek_typemask) {
2880 value = &PL_sv_placeholder;
2883 value = newSViv(he->refcounted_he_val.refcounted_he_u_iv);
2886 value = newSVuv(he->refcounted_he_val.refcounted_he_u_uv);
2889 case HVrhek_PV_UTF8:
2890 /* Create a string SV that directly points to the bytes in our
2892 value = newSV_type(SVt_PV);
2893 SvPV_set(value, (char *) he->refcounted_he_data + 1);
2894 SvCUR_set(value, he->refcounted_he_val.refcounted_he_u_len);
2895 /* This stops anything trying to free it */
2896 SvLEN_set(value, 0);
2898 SvREADONLY_on(value);
2899 if ((he->refcounted_he_data[0] & HVrhek_typemask) == HVrhek_PV_UTF8)
2903 Perl_croak(aTHX_ "panic: refcounted_he_value bad flags %"UVxf,
2904 (UV)he->refcounted_he_data[0]);
2910 =for apidoc m|HV *|refcounted_he_chain_2hv|const struct refcounted_he *c|U32 flags
2912 Generates and returns a C<HV *> representing the content of a
2913 C<refcounted_he> chain.
2914 I<flags> is currently unused and must be zero.
2919 Perl_refcounted_he_chain_2hv(pTHX_ const struct refcounted_he *chain, U32 flags)
2923 U32 placeholders, max;
2926 Perl_croak(aTHX_ "panic: refcounted_he_chain_2hv bad flags %"UVxf,
2929 /* We could chase the chain once to get an idea of the number of keys,
2930 and call ksplit. But for now we'll make a potentially inefficient
2931 hash with only 8 entries in its array. */
2936 Newxz(array, PERL_HV_ARRAY_ALLOC_BYTES(max + 1), char);
2937 HvARRAY(hv) = (HE**)array;
2943 U32 hash = chain->refcounted_he_hash;
2945 U32 hash = HEK_HASH(chain->refcounted_he_hek);
2947 HE **oentry = &((HvARRAY(hv))[hash & max]);
2948 HE *entry = *oentry;
2951 for (; entry; entry = HeNEXT(entry)) {
2952 if (HeHASH(entry) == hash) {
2953 /* We might have a duplicate key here. If so, entry is older
2954 than the key we've already put in the hash, so if they are
2955 the same, skip adding entry. */
2957 const STRLEN klen = HeKLEN(entry);
2958 const char *const key = HeKEY(entry);
2959 if (klen == chain->refcounted_he_keylen
2960 && (!!HeKUTF8(entry)
2961 == !!(chain->refcounted_he_data[0] & HVhek_UTF8))
2962 && memEQ(key, REF_HE_KEY(chain), klen))
2965 if (HeKEY_hek(entry) == chain->refcounted_he_hek)
2967 if (HeKLEN(entry) == HEK_LEN(chain->refcounted_he_hek)
2968 && HeKUTF8(entry) == HEK_UTF8(chain->refcounted_he_hek)
2969 && memEQ(HeKEY(entry), HEK_KEY(chain->refcounted_he_hek),
2980 = share_hek_flags(REF_HE_KEY(chain),
2981 chain->refcounted_he_keylen,
2982 chain->refcounted_he_hash,
2983 (chain->refcounted_he_data[0]
2984 & (HVhek_UTF8|HVhek_WASUTF8)));
2986 HeKEY_hek(entry) = share_hek_hek(chain->refcounted_he_hek);
2988 value = refcounted_he_value(chain);
2989 if (value == &PL_sv_placeholder)
2991 HeVAL(entry) = value;
2993 /* Link it into the chain. */
2994 HeNEXT(entry) = *oentry;
3000 chain = chain->refcounted_he_next;
3004 clear_placeholders(hv, placeholders);
3005 HvTOTALKEYS(hv) -= placeholders;
3008 /* We could check in the loop to see if we encounter any keys with key
3009 flags, but it's probably not worth it, as this per-hash flag is only
3010 really meant as an optimisation for things like Storable. */
3012 DEBUG_A(Perl_hv_assert(aTHX_ hv));
3018 =for apidoc m|SV *|refcounted_he_fetch_pvn|const struct refcounted_he *chain|const char *keypv|STRLEN keylen|U32 hash|U32 flags
3020 Search along a C<refcounted_he> chain for an entry with the key specified
3021 by I<keypv> and I<keylen>. If I<flags> has the C<REFCOUNTED_HE_KEY_UTF8>
3022 bit set, the key octets are interpreted as UTF-8, otherwise they
3023 are interpreted as Latin-1. I<hash> is a precomputed hash of the key
3024 string, or zero if it has not been precomputed. Returns a mortal scalar
3025 representing the value associated with the key, or C<&PL_sv_placeholder>
3026 if there is no value associated with the key.
3032 Perl_refcounted_he_fetch_pvn(pTHX_ const struct refcounted_he *chain,
3033 const char *keypv, STRLEN keylen, U32 hash, U32 flags)
3037 PERL_ARGS_ASSERT_REFCOUNTED_HE_FETCH_PVN;
3039 if (flags & ~(REFCOUNTED_HE_KEY_UTF8|REFCOUNTED_HE_EXISTS))
3040 Perl_croak(aTHX_ "panic: refcounted_he_fetch_pvn bad flags %"UVxf,
3043 return &PL_sv_placeholder;
3044 if (flags & REFCOUNTED_HE_KEY_UTF8) {
3045 /* For searching purposes, canonicalise to Latin-1 where possible. */
3046 const char *keyend = keypv + keylen, *p;
3047 STRLEN nonascii_count = 0;
3048 for (p = keypv; p != keyend; p++) {
3051 if (!((c & 0xfe) == 0xc2 && ++p != keyend &&
3052 (((U8)*p) & 0xc0) == 0x80))
3053 goto canonicalised_key;
3057 if (nonascii_count) {
3059 const char *p = keypv, *keyend = keypv + keylen;
3060 keylen -= nonascii_count;
3061 Newx(q, keylen, char);
3064 for (; p != keyend; p++, q++) {
3067 ((c & 0x80) ? ((c & 0x03) << 6) | (((U8)*++p) & 0x3f) : c);
3070 flags &= ~REFCOUNTED_HE_KEY_UTF8;
3071 canonicalised_key: ;
3073 utf8_flag = (flags & REFCOUNTED_HE_KEY_UTF8) ? HVhek_UTF8 : 0;
3075 PERL_HASH(hash, keypv, keylen);
3077 for (; chain; chain = chain->refcounted_he_next) {
3080 hash == chain->refcounted_he_hash &&
3081 keylen == chain->refcounted_he_keylen &&
3082 memEQ(REF_HE_KEY(chain), keypv, keylen) &&
3083 utf8_flag == (chain->refcounted_he_data[0] & HVhek_UTF8)
3085 hash == HEK_HASH(chain->refcounted_he_hek) &&
3086 keylen == (STRLEN)HEK_LEN(chain->refcounted_he_hek) &&
3087 memEQ(HEK_KEY(chain->refcounted_he_hek), keypv, keylen) &&
3088 utf8_flag == (HEK_FLAGS(chain->refcounted_he_hek) & HVhek_UTF8)
3091 if (flags & REFCOUNTED_HE_EXISTS)
3092 return (chain->refcounted_he_data[0] & HVrhek_typemask)
3094 ? NULL : &PL_sv_yes;
3095 return sv_2mortal(refcounted_he_value(chain));
3098 return flags & REFCOUNTED_HE_EXISTS ? NULL : &PL_sv_placeholder;
3102 =for apidoc m|SV *|refcounted_he_fetch_pv|const struct refcounted_he *chain|const char *key|U32 hash|U32 flags
3104 Like L</refcounted_he_fetch_pvn>, but takes a nul-terminated string
3105 instead of a string/length pair.
3111 Perl_refcounted_he_fetch_pv(pTHX_ const struct refcounted_he *chain,
3112 const char *key, U32 hash, U32 flags)
3114 PERL_ARGS_ASSERT_REFCOUNTED_HE_FETCH_PV;
3115 return refcounted_he_fetch_pvn(chain, key, strlen(key), hash, flags);
3119 =for apidoc m|SV *|refcounted_he_fetch_sv|const struct refcounted_he *chain|SV *key|U32 hash|U32 flags
3121 Like L</refcounted_he_fetch_pvn>, but takes a Perl scalar instead of a
3128 Perl_refcounted_he_fetch_sv(pTHX_ const struct refcounted_he *chain,
3129 SV *key, U32 hash, U32 flags)
3133 PERL_ARGS_ASSERT_REFCOUNTED_HE_FETCH_SV;
3134 if (flags & REFCOUNTED_HE_KEY_UTF8)
3135 Perl_croak(aTHX_ "panic: refcounted_he_fetch_sv bad flags %"UVxf,
3137 keypv = SvPV_const(key, keylen);
3139 flags |= REFCOUNTED_HE_KEY_UTF8;
3140 if (!hash && SvIsCOW_shared_hash(key))
3141 hash = SvSHARED_HASH(key);
3142 return refcounted_he_fetch_pvn(chain, keypv, keylen, hash, flags);
3146 =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
3148 Creates a new C<refcounted_he>. This consists of a single key/value
3149 pair and a reference to an existing C<refcounted_he> chain (which may
3150 be empty), and thus forms a longer chain. When using the longer chain,
3151 the new key/value pair takes precedence over any entry for the same key
3152 further along the chain.
3154 The new key is specified by I<keypv> and I<keylen>. If I<flags> has
3155 the C<REFCOUNTED_HE_KEY_UTF8> bit set, the key octets are interpreted
3156 as UTF-8, otherwise they are interpreted as Latin-1. I<hash> is
3157 a precomputed hash of the key string, or zero if it has not been
3160 I<value> is the scalar value to store for this key. I<value> is copied
3161 by this function, which thus does not take ownership of any reference
3162 to it, and later changes to the scalar will not be reflected in the
3163 value visible in the C<refcounted_he>. Complex types of scalar will not
3164 be stored with referential integrity, but will be coerced to strings.
3165 I<value> may be either null or C<&PL_sv_placeholder> to indicate that no
3166 value is to be associated with the key; this, as with any non-null value,
3167 takes precedence over the existence of a value for the key further along
3170 I<parent> points to the rest of the C<refcounted_he> chain to be
3171 attached to the new C<refcounted_he>. This function takes ownership
3172 of one reference to I<parent>, and returns one reference to the new
3178 struct refcounted_he *
3179 Perl_refcounted_he_new_pvn(pTHX_ struct refcounted_he *parent,
3180 const char *keypv, STRLEN keylen, U32 hash, SV *value, U32 flags)
3183 STRLEN value_len = 0;
3184 const char *value_p = NULL;
3188 STRLEN key_offset = 1;
3189 struct refcounted_he *he;
3190 PERL_ARGS_ASSERT_REFCOUNTED_HE_NEW_PVN;
3192 if (!value || value == &PL_sv_placeholder) {
3193 value_type = HVrhek_delete;
3194 } else if (SvPOK(value)) {
3195 value_type = HVrhek_PV;
3196 } else if (SvIOK(value)) {
3197 value_type = SvUOK((const SV *)value) ? HVrhek_UV : HVrhek_IV;
3198 } else if (!SvOK(value)) {
3199 value_type = HVrhek_undef;
3201 value_type = HVrhek_PV;
3203 is_pv = value_type == HVrhek_PV;
3205 /* Do it this way so that the SvUTF8() test is after the SvPV, in case
3206 the value is overloaded, and doesn't yet have the UTF-8flag set. */
3207 value_p = SvPV_const(value, value_len);
3209 value_type = HVrhek_PV_UTF8;
3210 key_offset = value_len + 2;
3212 hekflags = value_type;
3214 if (flags & REFCOUNTED_HE_KEY_UTF8) {
3215 /* Canonicalise to Latin-1 where possible. */
3216 const char *keyend = keypv + keylen, *p;
3217 STRLEN nonascii_count = 0;
3218 for (p = keypv; p != keyend; p++) {
3221 if (!((c & 0xfe) == 0xc2 && ++p != keyend &&
3222 (((U8)*p) & 0xc0) == 0x80))
3223 goto canonicalised_key;
3227 if (nonascii_count) {
3229 const char *p = keypv, *keyend = keypv + keylen;
3230 keylen -= nonascii_count;
3231 Newx(q, keylen, char);
3234 for (; p != keyend; p++, q++) {
3237 ((c & 0x80) ? ((c & 0x03) << 6) | (((U8)*++p) & 0x3f) : c);
3240 flags &= ~REFCOUNTED_HE_KEY_UTF8;
3241 canonicalised_key: ;
3243 if (flags & REFCOUNTED_HE_KEY_UTF8)
3244 hekflags |= HVhek_UTF8;
3246 PERL_HASH(hash, keypv, keylen);
3249 he = (struct refcounted_he*)
3250 PerlMemShared_malloc(sizeof(struct refcounted_he) - 1
3254 he = (struct refcounted_he*)
3255 PerlMemShared_malloc(sizeof(struct refcounted_he) - 1
3259 he->refcounted_he_next = parent;
3262 Copy(value_p, he->refcounted_he_data + 1, value_len + 1, char);
3263 he->refcounted_he_val.refcounted_he_u_len = value_len;
3264 } else if (value_type == HVrhek_IV) {
3265 he->refcounted_he_val.refcounted_he_u_iv = SvIVX(value);
3266 } else if (value_type == HVrhek_UV) {
3267 he->refcounted_he_val.refcounted_he_u_uv = SvUVX(value);
3271 he->refcounted_he_hash = hash;
3272 he->refcounted_he_keylen = keylen;
3273 Copy(keypv, he->refcounted_he_data + key_offset, keylen, char);
3275 he->refcounted_he_hek = share_hek_flags(keypv, keylen, hash, hekflags);
3278 he->refcounted_he_data[0] = hekflags;
3279 he->refcounted_he_refcnt = 1;
3285 =for apidoc m|struct refcounted_he *|refcounted_he_new_pv|struct refcounted_he *parent|const char *key|U32 hash|SV *value|U32 flags
3287 Like L</refcounted_he_new_pvn>, but takes a nul-terminated string instead
3288 of a string/length pair.
3293 struct refcounted_he *
3294 Perl_refcounted_he_new_pv(pTHX_ struct refcounted_he *parent,
3295 const char *key, U32 hash, SV *value, U32 flags)
3297 PERL_ARGS_ASSERT_REFCOUNTED_HE_NEW_PV;
3298 return refcounted_he_new_pvn(parent, key, strlen(key), hash, value, flags);
3302 =for apidoc m|struct refcounted_he *|refcounted_he_new_sv|struct refcounted_he *parent|SV *key|U32 hash|SV *value|U32 flags
3304 Like L</refcounted_he_new_pvn>, but takes a Perl scalar instead of a
3310 struct refcounted_he *
3311 Perl_refcounted_he_new_sv(pTHX_ struct refcounted_he *parent,
3312 SV *key, U32 hash, SV *value, U32 flags)
3316 PERL_ARGS_ASSERT_REFCOUNTED_HE_NEW_SV;
3317 if (flags & REFCOUNTED_HE_KEY_UTF8)
3318 Perl_croak(aTHX_ "panic: refcounted_he_new_sv bad flags %"UVxf,
3320 keypv = SvPV_const(key, keylen);
3322 flags |= REFCOUNTED_HE_KEY_UTF8;
3323 if (!hash && SvIsCOW_shared_hash(key))
3324 hash = SvSHARED_HASH(key);
3325 return refcounted_he_new_pvn(parent, keypv, keylen, hash, value, flags);
3329 =for apidoc m|void|refcounted_he_free|struct refcounted_he *he
3331 Decrements the reference count of a C<refcounted_he> by one. If the
3332 reference count reaches zero the structure's memory is freed, which
3333 (recursively) causes a reduction of its parent C<refcounted_he>'s
3334 reference count. It is safe to pass a null pointer to this function:
3335 no action occurs in this case.
3341 Perl_refcounted_he_free(pTHX_ struct refcounted_he *he) {
3343 PERL_UNUSED_CONTEXT;
3346 struct refcounted_he *copy;
3350 new_count = --he->refcounted_he_refcnt;
3351 HINTS_REFCNT_UNLOCK;
3357 #ifndef USE_ITHREADS
3358 unshare_hek_or_pvn (he->refcounted_he_hek, 0, 0, 0);
3361 he = he->refcounted_he_next;
3362 PerlMemShared_free(copy);
3367 =for apidoc m|struct refcounted_he *|refcounted_he_inc|struct refcounted_he *he
3369 Increment the reference count of a C<refcounted_he>. The pointer to the
3370 C<refcounted_he> is also returned. It is safe to pass a null pointer
3371 to this function: no action occurs and a null pointer is returned.
3376 struct refcounted_he *
3377 Perl_refcounted_he_inc(pTHX_ struct refcounted_he *he)
3382 he->refcounted_he_refcnt++;
3383 HINTS_REFCNT_UNLOCK;
3389 =for apidoc cop_fetch_label
3391 Returns the label attached to a cop.
3392 The flags pointer may be set to C<SVf_UTF8> or 0.
3397 /* pp_entereval is aware that labels are stored with a key ':' at the top of
3400 Perl_cop_fetch_label(pTHX_ COP *const cop, STRLEN *len, U32 *flags) {
3401 struct refcounted_he *const chain = cop->cop_hints_hash;
3403 PERL_ARGS_ASSERT_COP_FETCH_LABEL;
3408 if (chain->refcounted_he_keylen != 1)
3410 if (*REF_HE_KEY(chain) != ':')
3413 if ((STRLEN)HEK_LEN(chain->refcounted_he_hek) != 1)
3415 if (*HEK_KEY(chain->refcounted_he_hek) != ':')
3418 /* Stop anyone trying to really mess us up by adding their own value for
3420 if ((chain->refcounted_he_data[0] & HVrhek_typemask) != HVrhek_PV
3421 && (chain->refcounted_he_data[0] & HVrhek_typemask) != HVrhek_PV_UTF8)
3425 *len = chain->refcounted_he_val.refcounted_he_u_len;
3427 *flags = ((chain->refcounted_he_data[0] & HVrhek_typemask)
3428 == HVrhek_PV_UTF8) ? SVf_UTF8 : 0;
3430 return chain->refcounted_he_data + 1;
3434 =for apidoc cop_store_label
3436 Save a label into a C<cop_hints_hash>. You need to set flags to C<SVf_UTF8>
3443 Perl_cop_store_label(pTHX_ COP *const cop, const char *label, STRLEN len,
3447 PERL_ARGS_ASSERT_COP_STORE_LABEL;
3449 if (flags & ~(SVf_UTF8))
3450 Perl_croak(aTHX_ "panic: cop_store_label illegal flag bits 0x%" UVxf,
3452 labelsv = newSVpvn_flags(label, len, SVs_TEMP);
3453 if (flags & SVf_UTF8)
3456 = refcounted_he_new_pvs(cop->cop_hints_hash, ":", labelsv, 0);
3460 =for apidoc hv_assert
3462 Check that a hash is in an internally consistent state.
3470 Perl_hv_assert(pTHX_ HV *hv)
3475 int placeholders = 0;
3478 const I32 riter = HvRITER_get(hv);
3479 HE *eiter = HvEITER_get(hv);
3481 PERL_ARGS_ASSERT_HV_ASSERT;
3483 (void)hv_iterinit(hv);
3485 while ((entry = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS))) {
3486 /* sanity check the values */
3487 if (HeVAL(entry) == &PL_sv_placeholder)
3491 /* sanity check the keys */
3492 if (HeSVKEY(entry)) {
3493 NOOP; /* Don't know what to check on SV keys. */
3494 } else if (HeKUTF8(entry)) {
3496 if (HeKWASUTF8(entry)) {
3497 PerlIO_printf(Perl_debug_log,
3498 "hash key has both WASUTF8 and UTF8: '%.*s'\n",
3499 (int) HeKLEN(entry), HeKEY(entry));
3502 } else if (HeKWASUTF8(entry))
3505 if (!SvTIED_mg((const SV *)hv, PERL_MAGIC_tied)) {
3506 static const char bad_count[] = "Count %d %s(s), but hash reports %d\n";
3507 const int nhashkeys = HvUSEDKEYS(hv);
3508 const int nhashplaceholders = HvPLACEHOLDERS_get(hv);
3510 if (nhashkeys != real) {
3511 PerlIO_printf(Perl_debug_log, bad_count, real, "keys", nhashkeys );
3514 if (nhashplaceholders != placeholders) {
3515 PerlIO_printf(Perl_debug_log, bad_count, placeholders, "placeholder", nhashplaceholders );
3519 if (withflags && ! HvHASKFLAGS(hv)) {
3520 PerlIO_printf(Perl_debug_log,
3521 "Hash has HASKFLAGS off but I count %d key(s) with flags\n",
3526 sv_dump(MUTABLE_SV(hv));
3528 HvRITER_set(hv, riter); /* Restore hash iterator state */
3529 HvEITER_set(hv, eiter);
3536 * c-indentation-style: bsd
3538 * indent-tabs-mode: nil
3541 * ex: set ts=8 sts=4 sw=4 et: