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 DO_HSPLIT(xhv) ((xhv)->xhv_keys > (xhv)->xhv_max) /* HvTOTALKEYS(hv) > HvMAX(hv) */
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, 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. */
617 if (keysv && (SvIsCOW_shared_hash(keysv)))
618 hash = SvSHARED_HASH(keysv);
620 PERL_HASH(hash, key, klen);
623 masked_flags = (flags & HVhek_MASK);
625 #ifdef DYNAMIC_ENV_FETCH
626 if (!HvARRAY(hv)) entry = NULL;
630 entry = (HvARRAY(hv))[hash & (I32) HvMAX(hv)];
632 for (; entry; entry = HeNEXT(entry)) {
633 if (HeHASH(entry) != hash) /* strings can't be equal */
635 if (HeKLEN(entry) != (I32)klen)
637 if (HeKEY(entry) != key && memNE(HeKEY(entry),key,klen)) /* is this it? */
639 if ((HeKFLAGS(entry) ^ masked_flags) & HVhek_UTF8)
642 if (action & (HV_FETCH_LVALUE|HV_FETCH_ISSTORE)) {
643 if (HeKFLAGS(entry) != masked_flags) {
644 /* We match if HVhek_UTF8 bit in our flags and hash key's
645 match. But if entry was set previously with HVhek_WASUTF8
646 and key now doesn't (or vice versa) then we should change
647 the key's flag, as this is assignment. */
648 if (HvSHAREKEYS(hv)) {
649 /* Need to swap the key we have for a key with the flags we
650 need. As keys are shared we can't just write to the
651 flag, so we share the new one, unshare the old one. */
652 HEK * const new_hek = share_hek_flags(key, klen, hash,
654 unshare_hek (HeKEY_hek(entry));
655 HeKEY_hek(entry) = new_hek;
657 else if (hv == PL_strtab) {
658 /* PL_strtab is usually the only hash without HvSHAREKEYS,
659 so putting this test here is cheap */
660 if (flags & HVhek_FREEKEY)
662 Perl_croak(aTHX_ S_strtab_error,
663 action & HV_FETCH_LVALUE ? "fetch" : "store");
666 HeKFLAGS(entry) = masked_flags;
667 if (masked_flags & HVhek_ENABLEHVKFLAGS)
670 if (HeVAL(entry) == &PL_sv_placeholder) {
671 /* yes, can store into placeholder slot */
672 if (action & HV_FETCH_LVALUE) {
674 /* This preserves behaviour with the old hv_fetch
675 implementation which at this point would bail out
676 with a break; (at "if we find a placeholder, we
677 pretend we haven't found anything")
679 That break mean that if a placeholder were found, it
680 caused a call into hv_store, which in turn would
681 check magic, and if there is no magic end up pretty
682 much back at this point (in hv_store's code). */
685 /* LVAL fetch which actually needs a store. */
687 HvPLACEHOLDERS(hv)--;
690 if (val != &PL_sv_placeholder)
691 HvPLACEHOLDERS(hv)--;
694 } else if (action & HV_FETCH_ISSTORE) {
695 SvREFCNT_dec(HeVAL(entry));
698 } else if (HeVAL(entry) == &PL_sv_placeholder) {
699 /* if we find a placeholder, we pretend we haven't found
703 if (flags & HVhek_FREEKEY)
706 return entry ? (void *) &HeVAL(entry) : NULL;
710 #ifdef DYNAMIC_ENV_FETCH /* %ENV lookup? If so, try to fetch the value now */
711 if (!(action & HV_FETCH_ISSTORE)
712 && SvRMAGICAL((const SV *)hv)
713 && mg_find((const SV *)hv, PERL_MAGIC_env)) {
715 const char * const env = PerlEnv_ENVgetenv_len(key,&len);
717 sv = newSVpvn(env,len);
719 return hv_common(hv, keysv, key, klen, flags,
720 HV_FETCH_ISSTORE|HV_DISABLE_UVAR_XKEY|return_svp,
726 if (!entry && SvREADONLY(hv) && !(action & HV_FETCH_ISEXISTS)) {
727 hv_notallowed(flags, key, klen,
728 "Attempt to access disallowed key '%"SVf"' in"
729 " a restricted hash");
731 if (!(action & (HV_FETCH_LVALUE|HV_FETCH_ISSTORE))) {
732 /* Not doing some form of store, so return failure. */
733 if (flags & HVhek_FREEKEY)
737 if (action & HV_FETCH_LVALUE) {
738 val = action & HV_FETCH_EMPTY_HE ? NULL : newSV(0);
740 /* At this point the old hv_fetch code would call to hv_store,
741 which in turn might do some tied magic. So we need to make that
742 magic check happen. */
743 /* gonna assign to this, so it better be there */
744 /* If a fetch-as-store fails on the fetch, then the action is to
745 recurse once into "hv_store". If we didn't do this, then that
746 recursive call would call the key conversion routine again.
747 However, as we replace the original key with the converted
748 key, this would result in a double conversion, which would show
749 up as a bug if the conversion routine is not idempotent. */
750 return hv_common(hv, keysv, key, klen, flags,
751 HV_FETCH_ISSTORE|HV_DISABLE_UVAR_XKEY|return_svp,
753 /* XXX Surely that could leak if the fetch-was-store fails?
754 Just like the hv_fetch. */
758 /* Welcome to hv_store... */
761 /* Not sure if we can get here. I think the only case of oentry being
762 NULL is for %ENV with dynamic env fetch. But that should disappear
763 with magic in the previous code. */
766 PERL_HV_ARRAY_ALLOC_BYTES(xhv->xhv_max+1 /* HvMAX(hv)+1 */),
768 HvARRAY(hv) = (HE**)array;
771 oentry = &(HvARRAY(hv))[hash & (I32) xhv->xhv_max];
774 /* share_hek_flags will do the free for us. This might be considered
777 HeKEY_hek(entry) = share_hek_flags(key, klen, hash, flags);
778 else if (hv == PL_strtab) {
779 /* PL_strtab is usually the only hash without HvSHAREKEYS, so putting
780 this test here is cheap */
781 if (flags & HVhek_FREEKEY)
783 Perl_croak(aTHX_ S_strtab_error,
784 action & HV_FETCH_LVALUE ? "fetch" : "store");
786 else /* gotta do the real thing */
787 HeKEY_hek(entry) = save_hek_flags(key, klen, hash, flags);
789 HeNEXT(entry) = *oentry;
792 if (val == &PL_sv_placeholder)
793 HvPLACEHOLDERS(hv)++;
794 if (masked_flags & HVhek_ENABLEHVKFLAGS)
797 xhv->xhv_keys++; /* HvTOTALKEYS(hv)++ */
798 if ( DO_HSPLIT(xhv) ) {
799 const STRLEN oldsize = xhv->xhv_max + 1;
800 const U32 items = (U32)HvPLACEHOLDERS_get(hv);
802 if (items /* hash has placeholders */
803 && !SvREADONLY(hv) /* but is not a restricted hash */) {
804 /* If this hash previously was a "restricted hash" and had
805 placeholders, but the "restricted" flag has been turned off,
806 then the placeholders no longer serve any useful purpose.
807 However, they have the downsides of taking up RAM, and adding
808 extra steps when finding used values. It's safe to clear them
809 at this point, even though Storable rebuilds restricted hashes by
810 putting in all the placeholders (first) before turning on the
811 readonly flag, because Storable always pre-splits the hash.
812 If we're lucky, then we may clear sufficient placeholders to
813 avoid needing to split the hash at all. */
814 clear_placeholders(hv, items);
816 hsplit(hv, oldsize, oldsize * 2);
818 hsplit(hv, oldsize, oldsize * 2);
822 return entry ? (void *) &HeVAL(entry) : NULL;
824 return (void *) entry;
828 S_hv_magic_check(HV *hv, bool *needs_copy, bool *needs_store)
830 const MAGIC *mg = SvMAGIC(hv);
832 PERL_ARGS_ASSERT_HV_MAGIC_CHECK;
837 if (isUPPER(mg->mg_type)) {
839 if (mg->mg_type == PERL_MAGIC_tied) {
840 *needs_store = FALSE;
841 return; /* We've set all there is to set. */
844 mg = mg->mg_moremagic;
849 =for apidoc hv_scalar
851 Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
857 Perl_hv_scalar(pTHX_ HV *hv)
861 PERL_ARGS_ASSERT_HV_SCALAR;
863 if (SvRMAGICAL(hv)) {
864 MAGIC * const mg = mg_find((const SV *)hv, PERL_MAGIC_tied);
866 return magic_scalarpack(hv, mg);
870 if (HvTOTALKEYS((const HV *)hv))
871 Perl_sv_setpvf(aTHX_ sv, "%ld/%ld",
872 (long)HvFILL(hv), (long)HvMAX(hv) + 1);
880 =for apidoc hv_delete
882 Deletes a key/value pair in the hash. The value's SV is removed from
883 the hash, made mortal, and returned to the caller. The absolute
884 value of C<klen> is the length of the key. If C<klen> is negative the
885 key is assumed to be in UTF-8-encoded Unicode. The C<flags> value
886 will normally be zero; if set to G_DISCARD then NULL will be returned.
887 NULL will also be returned if the key is not found.
889 =for apidoc hv_delete_ent
891 Deletes a key/value pair in the hash. The value SV is removed from the hash,
892 made mortal, and returned to the caller. The C<flags> value will normally be
893 zero; if set to G_DISCARD then NULL will be returned. NULL will also be
894 returned if the key is not found. C<hash> can be a valid precomputed hash
895 value, or 0 to ask for it to be computed.
901 S_hv_delete_common(pTHX_ HV *hv, SV *keysv, const char *key, STRLEN klen,
902 int k_flags, I32 d_flags, U32 hash)
908 bool is_utf8 = (k_flags & HVhek_UTF8) ? TRUE : FALSE;
911 if (SvRMAGICAL(hv)) {
914 hv_magic_check (hv, &needs_copy, &needs_store);
918 entry = (HE *) hv_common(hv, keysv, key, klen,
919 k_flags & ~HVhek_FREEKEY,
920 HV_FETCH_LVALUE|HV_DISABLE_UVAR_XKEY,
922 sv = entry ? HeVAL(entry) : NULL;
928 if (mg_find(sv, PERL_MAGIC_tiedelem)) {
929 /* No longer an element */
930 sv_unmagic(sv, PERL_MAGIC_tiedelem);
933 return NULL; /* element cannot be deleted */
935 #ifdef ENV_IS_CASELESS
936 else if (mg_find((const SV *)hv, PERL_MAGIC_env)) {
937 /* XXX This code isn't UTF8 clean. */
938 keysv = newSVpvn_flags(key, klen, SVs_TEMP);
939 if (k_flags & HVhek_FREEKEY) {
942 key = strupr(SvPVX(keysv));
951 xhv = (XPVHV*)SvANY(hv);
955 if (is_utf8 && !(k_flags & HVhek_KEYCANONICAL)) {
956 const char * const keysave = key;
957 key = (char*)bytes_from_utf8((U8*)key, &klen, &is_utf8);
960 k_flags |= HVhek_UTF8;
962 k_flags &= ~HVhek_UTF8;
963 if (key != keysave) {
964 if (k_flags & HVhek_FREEKEY) {
965 /* This shouldn't happen if our caller does what we expect,
966 but strictly the API allows it. */
969 k_flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
971 HvHASKFLAGS_on(MUTABLE_SV(hv));
975 if (keysv && (SvIsCOW_shared_hash(keysv)))
976 hash = SvSHARED_HASH(keysv);
978 PERL_HASH(hash, key, klen);
981 masked_flags = (k_flags & HVhek_MASK);
983 oentry = &(HvARRAY(hv))[hash & (I32) HvMAX(hv)];
985 for (; entry; oentry = &HeNEXT(entry), entry = *oentry) {
987 U8 mro_changes = 0; /* 1 = isa; 2 = package moved */
991 if (HeHASH(entry) != hash) /* strings can't be equal */
993 if (HeKLEN(entry) != (I32)klen)
995 if (HeKEY(entry) != key && memNE(HeKEY(entry),key,klen)) /* is this it? */
997 if ((HeKFLAGS(entry) ^ masked_flags) & HVhek_UTF8)
1000 if (hv == PL_strtab) {
1001 if (k_flags & HVhek_FREEKEY)
1003 Perl_croak(aTHX_ S_strtab_error, "delete");
1006 /* if placeholder is here, it's already been deleted.... */
1007 if (HeVAL(entry) == &PL_sv_placeholder) {
1008 if (k_flags & HVhek_FREEKEY)
1012 if (SvREADONLY(hv) && HeVAL(entry) && SvREADONLY(HeVAL(entry))
1013 && !SvIsCOW(HeVAL(entry))) {
1014 hv_notallowed(k_flags, key, klen,
1015 "Attempt to delete readonly key '%"SVf"' from"
1016 " a restricted hash");
1018 if (k_flags & HVhek_FREEKEY)
1021 /* If this is a stash and the key ends with ::, then someone is
1022 * deleting a package.
1024 if (HeVAL(entry) && HvENAME_get(hv)) {
1025 gv = (GV *)HeVAL(entry);
1026 if (keysv) key = SvPV(keysv, klen);
1028 (klen > 1 && key[klen-2] == ':' && key[klen-1] == ':')
1030 (klen == 1 && key[0] == ':')
1032 && (klen != 6 || hv!=PL_defstash || memNE(key,"main::",6))
1033 && SvTYPE(gv) == SVt_PVGV && (stash = GvHV((GV *)gv))
1034 && HvENAME_get(stash)) {
1035 /* A previous version of this code checked that the
1036 * GV was still in the symbol table by fetching the
1037 * GV with its name. That is not necessary (and
1038 * sometimes incorrect), as HvENAME cannot be set
1039 * on hv if it is not in the symtab. */
1041 /* Hang on to it for a bit. */
1042 SvREFCNT_inc_simple_void_NN(
1043 sv_2mortal((SV *)gv)
1046 else if (klen == 3 && strnEQ(key, "ISA", 3))
1050 sv = d_flags & G_DISCARD ? HeVAL(entry) : sv_2mortal(HeVAL(entry));
1051 HeVAL(entry) = &PL_sv_placeholder;
1053 /* deletion of method from stash */
1054 if (isGV(sv) && isGV_with_GP(sv) && GvCVu(sv)
1056 mro_method_changed_in(hv);
1060 * If a restricted hash, rather than really deleting the entry, put
1061 * a placeholder there. This marks the key as being "approved", so
1062 * we can still access via not-really-existing key without raising
1066 /* We'll be saving this slot, so the number of allocated keys
1067 * doesn't go down, but the number placeholders goes up */
1068 HvPLACEHOLDERS(hv)++;
1070 *oentry = HeNEXT(entry);
1071 if (SvOOK(hv) && entry == HvAUX(hv)->xhv_eiter /* HvEITER(hv) */)
1074 if (SvOOK(hv) && HvLAZYDEL(hv) &&
1075 entry == HeNEXT(HvAUX(hv)->xhv_eiter))
1076 HeNEXT(HvAUX(hv)->xhv_eiter) = HeNEXT(entry);
1077 hv_free_ent(hv, entry);
1079 xhv->xhv_keys--; /* HvTOTALKEYS(hv)-- */
1080 if (xhv->xhv_keys == 0)
1081 HvHASKFLAGS_off(hv);
1084 if (d_flags & G_DISCARD) {
1089 if (mro_changes == 1) mro_isa_changed_in(hv);
1090 else if (mro_changes == 2)
1091 mro_package_moved(NULL, stash, gv, 1);
1095 if (SvREADONLY(hv)) {
1096 hv_notallowed(k_flags, key, klen,
1097 "Attempt to delete disallowed key '%"SVf"' from"
1098 " a restricted hash");
1101 if (k_flags & HVhek_FREEKEY)
1107 S_hsplit(pTHX_ HV *hv, STRLEN const oldsize, STRLEN newsize)
1111 char *a = (char*) HvARRAY(hv);
1114 PERL_ARGS_ASSERT_HSPLIT;
1116 /*PerlIO_printf(PerlIO_stderr(), "hsplit called for %p which had %d\n",
1117 (void*)hv, (int) oldsize);*/
1120 Renew(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1121 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
1127 Move(&a[oldsize * sizeof(HE*)], &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
1131 Zero(&a[oldsize * sizeof(HE*)], (newsize-oldsize) * sizeof(HE*), char); /* zero 2nd half*/
1132 HvMAX(hv) = --newsize;
1133 HvARRAY(hv) = (HE**) a;
1135 if (!HvTOTALKEYS(hv)) /* skip rest if no entries */
1140 HE **oentry = aep + i;
1143 if (!entry) /* non-existent */
1146 U32 j = (HeHASH(entry) & newsize);
1148 *oentry = HeNEXT(entry);
1149 HeNEXT(entry) = aep[j];
1153 oentry = &HeNEXT(entry);
1157 } while (i++ < oldsize);
1161 Perl_hv_ksplit(pTHX_ HV *hv, IV newmax)
1164 XPVHV* xhv = (XPVHV*)SvANY(hv);
1165 const I32 oldsize = (I32) xhv->xhv_max+1; /* HvMAX(hv)+1 (sick) */
1169 PERL_ARGS_ASSERT_HV_KSPLIT;
1171 newsize = (I32) newmax; /* possible truncation here */
1172 if (newsize != newmax || newmax <= oldsize)
1174 while ((newsize & (1 + ~newsize)) != newsize) {
1175 newsize &= ~(newsize & (1 + ~newsize)); /* get proper power of 2 */
1177 if (newsize < newmax)
1179 if (newsize < newmax)
1180 return; /* overflow detection */
1182 a = (char *) HvARRAY(hv);
1184 hsplit(hv, oldsize, newsize);
1186 Newxz(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize), char);
1187 xhv->xhv_max = --newsize;
1188 HvARRAY(hv) = (HE **) a;
1193 Perl_newHVhv(pTHX_ HV *ohv)
1196 HV * const hv = newHV();
1199 if (!ohv || (!HvTOTALKEYS(ohv) && !SvMAGICAL((const SV *)ohv)))
1201 hv_max = HvMAX(ohv);
1203 if (!SvMAGICAL((const SV *)ohv)) {
1204 /* It's an ordinary hash, so copy it fast. AMS 20010804 */
1206 const bool shared = !!HvSHAREKEYS(ohv);
1207 HE **ents, ** const oents = (HE **)HvARRAY(ohv);
1209 Newx(a, PERL_HV_ARRAY_ALLOC_BYTES(hv_max+1), char);
1212 /* In each bucket... */
1213 for (i = 0; i <= hv_max; i++) {
1215 HE *oent = oents[i];
1222 /* Copy the linked list of entries. */
1223 for (; oent; oent = HeNEXT(oent)) {
1224 const U32 hash = HeHASH(oent);
1225 const char * const key = HeKEY(oent);
1226 const STRLEN len = HeKLEN(oent);
1227 const int flags = HeKFLAGS(oent);
1228 HE * const ent = new_HE();
1229 SV *const val = HeVAL(oent);
1231 HeVAL(ent) = SvIMMORTAL(val) ? val : newSVsv(val);
1233 = shared ? share_hek_flags(key, len, hash, flags)
1234 : save_hek_flags(key, len, hash, flags);
1245 HvTOTALKEYS(hv) = HvTOTALKEYS(ohv);
1249 /* Iterate over ohv, copying keys and values one at a time. */
1251 const I32 riter = HvRITER_get(ohv);
1252 HE * const eiter = HvEITER_get(ohv);
1253 STRLEN hv_fill = HvFILL(ohv);
1255 /* Can we use fewer buckets? (hv_max is always 2^n-1) */
1256 while (hv_max && hv_max + 1 >= hv_fill * 2)
1257 hv_max = hv_max / 2;
1261 while ((entry = hv_iternext_flags(ohv, 0))) {
1262 SV *val = hv_iterval(ohv,entry);
1263 SV * const keysv = HeSVKEY(entry);
1264 val = SvIMMORTAL(val) ? val : newSVsv(val);
1266 (void)hv_store_ent(hv, keysv, val, 0);
1268 (void)hv_store_flags(hv, HeKEY(entry), HeKLEN(entry), val,
1269 HeHASH(entry), HeKFLAGS(entry));
1271 HvRITER_set(ohv, riter);
1272 HvEITER_set(ohv, eiter);
1279 =for apidoc Am|HV *|hv_copy_hints_hv|HV *ohv
1281 A specialised version of L</newHVhv> for copying C<%^H>. I<ohv> must be
1282 a pointer to a hash (which may have C<%^H> magic, but should be generally
1283 non-magical), or C<NULL> (interpreted as an empty hash). The content
1284 of I<ohv> is copied to a new hash, which has the C<%^H>-specific magic
1285 added to it. A pointer to the new hash is returned.
1291 Perl_hv_copy_hints_hv(pTHX_ HV *const ohv)
1293 HV * const hv = newHV();
1296 STRLEN hv_max = HvMAX(ohv);
1297 STRLEN hv_fill = HvFILL(ohv);
1299 const I32 riter = HvRITER_get(ohv);
1300 HE * const eiter = HvEITER_get(ohv);
1305 while (hv_max && hv_max + 1 >= hv_fill * 2)
1306 hv_max = hv_max / 2;
1310 while ((entry = hv_iternext_flags(ohv, 0))) {
1311 SV *const sv = newSVsv(hv_iterval(ohv,entry));
1312 SV *heksv = HeSVKEY(entry);
1313 if (!heksv && sv) heksv = newSVhek(HeKEY_hek(entry));
1314 if (sv) sv_magic(sv, NULL, PERL_MAGIC_hintselem,
1315 (char *)heksv, HEf_SVKEY);
1316 if (heksv == HeSVKEY(entry))
1317 (void)hv_store_ent(hv, heksv, sv, 0);
1319 (void)hv_common(hv, heksv, HeKEY(entry), HeKLEN(entry),
1320 HeKFLAGS(entry), HV_FETCH_ISSTORE|HV_FETCH_JUST_SV, sv, HeHASH(entry));
1321 SvREFCNT_dec_NN(heksv);
1324 HvRITER_set(ohv, riter);
1325 HvEITER_set(ohv, eiter);
1327 SvREFCNT_inc_simple_void_NN(hv);
1330 hv_magic(hv, NULL, PERL_MAGIC_hints);
1334 /* like hv_free_ent, but returns the SV rather than freeing it */
1336 S_hv_free_ent_ret(pTHX_ HV *hv, HE *entry)
1341 PERL_ARGS_ASSERT_HV_FREE_ENT_RET;
1344 if (HeKLEN(entry) == HEf_SVKEY) {
1345 SvREFCNT_dec(HeKEY_sv(entry));
1346 Safefree(HeKEY_hek(entry));
1348 else if (HvSHAREKEYS(hv))
1349 unshare_hek(HeKEY_hek(entry));
1351 Safefree(HeKEY_hek(entry));
1358 Perl_hv_free_ent(pTHX_ HV *hv, HE *entry)
1363 PERL_ARGS_ASSERT_HV_FREE_ENT;
1367 val = hv_free_ent_ret(hv, entry);
1373 Perl_hv_delayfree_ent(pTHX_ HV *hv, HE *entry)
1377 PERL_ARGS_ASSERT_HV_DELAYFREE_ENT;
1381 /* SvREFCNT_inc to counter the SvREFCNT_dec in hv_free_ent */
1382 sv_2mortal(SvREFCNT_inc(HeVAL(entry))); /* free between statements */
1383 if (HeKLEN(entry) == HEf_SVKEY) {
1384 sv_2mortal(SvREFCNT_inc(HeKEY_sv(entry)));
1386 hv_free_ent(hv, entry);
1390 =for apidoc hv_clear
1392 Frees the all the elements of a hash, leaving it empty.
1393 The XS equivalent of C<%hash = ()>. See also L</hv_undef>.
1395 If any destructors are triggered as a result, the hv itself may
1402 Perl_hv_clear(pTHX_ HV *hv)
1409 DEBUG_A(Perl_hv_assert(aTHX_ hv));
1411 xhv = (XPVHV*)SvANY(hv);
1414 SAVEFREESV(SvREFCNT_inc_simple_NN(hv));
1415 if (SvREADONLY(hv) && HvARRAY(hv) != NULL) {
1416 /* restricted hash: convert all keys to placeholders */
1418 for (i = 0; i <= xhv->xhv_max; i++) {
1419 HE *entry = (HvARRAY(hv))[i];
1420 for (; entry; entry = HeNEXT(entry)) {
1421 /* not already placeholder */
1422 if (HeVAL(entry) != &PL_sv_placeholder) {
1424 if (SvREADONLY(HeVAL(entry)) && !SvIsCOW(HeVAL(entry))) {
1425 SV* const keysv = hv_iterkeysv(entry);
1426 Perl_croak_nocontext(
1427 "Attempt to delete readonly key '%"SVf"' from a restricted hash",
1430 SvREFCNT_dec_NN(HeVAL(entry));
1432 HeVAL(entry) = &PL_sv_placeholder;
1433 HvPLACEHOLDERS(hv)++;
1440 HvPLACEHOLDERS_set(hv, 0);
1443 mg_clear(MUTABLE_SV(hv));
1445 HvHASKFLAGS_off(hv);
1449 mro_isa_changed_in(hv);
1450 HvEITER_set(hv, NULL);
1456 =for apidoc hv_clear_placeholders
1458 Clears any placeholders from a hash. If a restricted hash has any of its keys
1459 marked as readonly and the key is subsequently deleted, the key is not actually
1460 deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
1461 it so it will be ignored by future operations such as iterating over the hash,
1462 but will still allow the hash to have a value reassigned to the key at some
1463 future point. This function clears any such placeholder keys from the hash.
1464 See Hash::Util::lock_keys() for an example of its use.
1470 Perl_hv_clear_placeholders(pTHX_ HV *hv)
1473 const U32 items = (U32)HvPLACEHOLDERS_get(hv);
1475 PERL_ARGS_ASSERT_HV_CLEAR_PLACEHOLDERS;
1478 clear_placeholders(hv, items);
1482 S_clear_placeholders(pTHX_ HV *hv, U32 items)
1487 PERL_ARGS_ASSERT_CLEAR_PLACEHOLDERS;
1494 /* Loop down the linked list heads */
1495 HE **oentry = &(HvARRAY(hv))[i];
1498 while ((entry = *oentry)) {
1499 if (HeVAL(entry) == &PL_sv_placeholder) {
1500 *oentry = HeNEXT(entry);
1501 if (entry == HvEITER_get(hv))
1504 if (SvOOK(hv) && HvLAZYDEL(hv) &&
1505 entry == HeNEXT(HvAUX(hv)->xhv_eiter))
1506 HeNEXT(HvAUX(hv)->xhv_eiter) = HeNEXT(entry);
1507 hv_free_ent(hv, entry);
1512 HvTOTALKEYS(hv) -= (IV)HvPLACEHOLDERS_get(hv);
1513 if (HvUSEDKEYS(hv) == 0)
1514 HvHASKFLAGS_off(hv);
1515 HvPLACEHOLDERS_set(hv, 0);
1519 oentry = &HeNEXT(entry);
1523 /* You can't get here, hence assertion should always fail. */
1524 assert (items == 0);
1529 S_hfreeentries(pTHX_ HV *hv)
1532 XPVHV * const xhv = (XPVHV*)SvANY(hv);
1535 PERL_ARGS_ASSERT_HFREEENTRIES;
1537 while ((sv = Perl_hfree_next_entry(aTHX_ hv, &index))||xhv->xhv_keys) {
1543 /* hfree_next_entry()
1544 * For use only by S_hfreeentries() and sv_clear().
1545 * Delete the next available HE from hv and return the associated SV.
1546 * Returns null on empty hash. Nevertheless null is not a reliable
1547 * indicator that the hash is empty, as the deleted entry may have a
1549 * indexp is a pointer to the current index into HvARRAY. The index should
1550 * initially be set to 0. hfree_next_entry() may update it. */
1553 Perl_hfree_next_entry(pTHX_ HV *hv, STRLEN *indexp)
1555 struct xpvhv_aux *iter;
1559 STRLEN orig_index = *indexp;
1562 PERL_ARGS_ASSERT_HFREE_NEXT_ENTRY;
1564 if (SvOOK(hv) && ((iter = HvAUX(hv)))
1565 && ((entry = iter->xhv_eiter)) )
1567 /* the iterator may get resurrected after each
1568 * destructor call, so check each time */
1569 if (entry && HvLAZYDEL(hv)) { /* was deleted earlier? */
1571 hv_free_ent(hv, entry);
1572 /* warning: at this point HvARRAY may have been
1573 * re-allocated, HvMAX changed etc */
1575 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
1576 iter->xhv_eiter = NULL; /* HvEITER(hv) = NULL */
1579 if (!((XPVHV*)SvANY(hv))->xhv_keys)
1582 array = HvARRAY(hv);
1584 while ( ! ((entry = array[*indexp])) ) {
1585 if ((*indexp)++ >= HvMAX(hv))
1587 assert(*indexp != orig_index);
1589 array[*indexp] = HeNEXT(entry);
1590 ((XPVHV*) SvANY(hv))->xhv_keys--;
1592 if ( PL_phase != PERL_PHASE_DESTRUCT && HvENAME(hv)
1593 && HeVAL(entry) && isGV(HeVAL(entry))
1594 && GvHV(HeVAL(entry)) && HvENAME(GvHV(HeVAL(entry)))
1597 const char * const key = HePV(entry,klen);
1598 if ((klen > 1 && key[klen-1]==':' && key[klen-2]==':')
1599 || (klen == 1 && key[0] == ':')) {
1601 NULL, GvHV(HeVAL(entry)),
1602 (GV *)HeVAL(entry), 0
1606 return hv_free_ent_ret(hv, entry);
1611 =for apidoc hv_undef
1613 Undefines the hash. The XS equivalent of C<undef(%hash)>.
1615 As well as freeing all the elements of the hash (like hv_clear()), this
1616 also frees any auxiliary data and storage associated with the hash.
1618 If any destructors are triggered as a result, the hv itself may
1621 See also L</hv_clear>.
1627 Perl_hv_undef_flags(pTHX_ HV *hv, U32 flags)
1632 const bool save = !!SvREFCNT(hv);
1636 DEBUG_A(Perl_hv_assert(aTHX_ hv));
1637 xhv = (XPVHV*)SvANY(hv);
1639 /* The name must be deleted before the call to hfreeeeentries so that
1640 CVs are anonymised properly. But the effective name must be pre-
1641 served until after that call (and only deleted afterwards if the
1642 call originated from sv_clear). For stashes with one name that is
1643 both the canonical name and the effective name, hv_name_set has to
1644 allocate an array for storing the effective name. We can skip that
1645 during global destruction, as it does not matter where the CVs point
1646 if they will be freed anyway. */
1647 /* note that the code following prior to hfreeentries is duplicated
1648 * in sv_clear(), and changes here should be done there too */
1649 if (PL_phase != PERL_PHASE_DESTRUCT && (name = HvNAME(hv))) {
1650 if (PL_stashcache) {
1651 DEBUG_o(Perl_deb(aTHX_ "hv_undef_flags clearing PL_stashcache for '%"
1652 HEKf"'\n", HvNAME_HEK(hv)));
1653 (void)hv_delete(PL_stashcache, name,
1654 HEK_UTF8(HvNAME_HEK(hv)) ? -HvNAMELEN_get(hv) : HvNAMELEN_get(hv),
1658 hv_name_set(hv, NULL, 0, 0);
1662 SAVEFREESV(SvREFCNT_inc_simple_NN(hv));
1666 struct xpvhv_aux * const aux = HvAUX(hv);
1667 struct mro_meta *meta;
1669 if ((name = HvENAME_get(hv))) {
1670 if (PL_phase != PERL_PHASE_DESTRUCT)
1671 mro_isa_changed_in(hv);
1672 if (PL_stashcache) {
1673 DEBUG_o(Perl_deb(aTHX_ "hv_undef_flags clearing PL_stashcache for effective name '%"
1674 HEKf"'\n", HvENAME_HEK(hv)));
1676 PL_stashcache, name,
1677 HEK_UTF8(HvENAME_HEK(hv)) ? -HvENAMELEN_get(hv) : HvENAMELEN_get(hv),
1683 /* If this call originated from sv_clear, then we must check for
1684 * effective names that need freeing, as well as the usual name. */
1686 if (flags & HV_NAME_SETALL ? !!aux->xhv_name_u.xhvnameu_name : !!name) {
1687 if (name && PL_stashcache) {
1688 DEBUG_o(Perl_deb(aTHX_ "hv_undef_flags clearing PL_stashcache for name '%"
1689 HEKf"'\n", HvNAME_HEK(hv)));
1690 (void)hv_delete(PL_stashcache, name, (HEK_UTF8(HvNAME_HEK(hv)) ? -HvNAMELEN_get(hv) : HvNAMELEN_get(hv)), G_DISCARD);
1692 hv_name_set(hv, NULL, 0, flags);
1694 if((meta = aux->xhv_mro_meta)) {
1695 if (meta->mro_linear_all) {
1696 SvREFCNT_dec_NN(meta->mro_linear_all);
1697 /* mro_linear_current is just acting as a shortcut pointer,
1701 /* Only the current MRO is stored, so this owns the data.
1703 SvREFCNT_dec(meta->mro_linear_current);
1704 SvREFCNT_dec(meta->mro_nextmethod);
1705 SvREFCNT_dec(meta->isa);
1707 aux->xhv_mro_meta = NULL;
1709 SvREFCNT_dec(aux->xhv_super);
1710 if (!aux->xhv_name_u.xhvnameu_name && ! aux->xhv_backreferences)
1711 SvFLAGS(hv) &= ~SVf_OOK;
1714 Safefree(HvARRAY(hv));
1715 xhv->xhv_max = 7; /* HvMAX(hv) = 7 (it's a normal hash) */
1718 /* if we're freeing the HV, the SvMAGIC field has been reused for
1719 * other purposes, and so there can't be any placeholder magic */
1721 HvPLACEHOLDERS_set(hv, 0);
1724 mg_clear(MUTABLE_SV(hv));
1731 Returns the number of hash buckets that happen to be in use. This function is
1732 wrapped by the macro C<HvFILL>.
1734 Previously this value was stored in the HV structure, rather than being
1735 calculated on demand.
1741 Perl_hv_fill(pTHX_ HV const *const hv)
1744 HE **ents = HvARRAY(hv);
1746 PERL_ARGS_ASSERT_HV_FILL;
1749 HE *const *const last = ents + HvMAX(hv);
1750 count = last + 1 - ents;
1755 } while (++ents <= last);
1760 static struct xpvhv_aux*
1761 S_hv_auxinit(HV *hv) {
1762 struct xpvhv_aux *iter;
1765 PERL_ARGS_ASSERT_HV_AUXINIT;
1768 Newxz(array, PERL_HV_ARRAY_ALLOC_BYTES(HvMAX(hv) + 1)
1769 + sizeof(struct xpvhv_aux), char);
1771 array = (char *) HvARRAY(hv);
1772 Renew(array, PERL_HV_ARRAY_ALLOC_BYTES(HvMAX(hv) + 1)
1773 + sizeof(struct xpvhv_aux), char);
1775 HvARRAY(hv) = (HE**) array;
1779 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
1780 iter->xhv_eiter = NULL; /* HvEITER(hv) = NULL */
1781 iter->xhv_name_u.xhvnameu_name = 0;
1782 iter->xhv_name_count = 0;
1783 iter->xhv_backreferences = 0;
1784 iter->xhv_mro_meta = NULL;
1785 iter->xhv_super = NULL;
1790 =for apidoc hv_iterinit
1792 Prepares a starting point to traverse a hash table. Returns the number of
1793 keys in the hash (i.e. the same as C<HvUSEDKEYS(hv)>). The return value is
1794 currently only meaningful for hashes without tie magic.
1796 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1797 hash buckets that happen to be in use. If you still need that esoteric
1798 value, you can get it through the macro C<HvFILL(hv)>.
1805 Perl_hv_iterinit(pTHX_ HV *hv)
1807 PERL_ARGS_ASSERT_HV_ITERINIT;
1809 /* FIXME: Are we not NULL, or do we croak? Place bets now! */
1812 Perl_croak(aTHX_ "Bad hash");
1815 struct xpvhv_aux * const iter = HvAUX(hv);
1816 HE * const entry = iter->xhv_eiter; /* HvEITER(hv) */
1817 if (entry && HvLAZYDEL(hv)) { /* was deleted earlier? */
1819 hv_free_ent(hv, entry);
1821 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
1822 iter->xhv_eiter = NULL; /* HvEITER(hv) = NULL */
1827 /* used to be xhv->xhv_fill before 5.004_65 */
1828 return HvTOTALKEYS(hv);
1832 Perl_hv_riter_p(pTHX_ HV *hv) {
1833 struct xpvhv_aux *iter;
1835 PERL_ARGS_ASSERT_HV_RITER_P;
1838 Perl_croak(aTHX_ "Bad hash");
1840 iter = SvOOK(hv) ? HvAUX(hv) : hv_auxinit(hv);
1841 return &(iter->xhv_riter);
1845 Perl_hv_eiter_p(pTHX_ HV *hv) {
1846 struct xpvhv_aux *iter;
1848 PERL_ARGS_ASSERT_HV_EITER_P;
1851 Perl_croak(aTHX_ "Bad hash");
1853 iter = SvOOK(hv) ? HvAUX(hv) : hv_auxinit(hv);
1854 return &(iter->xhv_eiter);
1858 Perl_hv_riter_set(pTHX_ HV *hv, I32 riter) {
1859 struct xpvhv_aux *iter;
1861 PERL_ARGS_ASSERT_HV_RITER_SET;
1864 Perl_croak(aTHX_ "Bad hash");
1872 iter = hv_auxinit(hv);
1874 iter->xhv_riter = riter;
1878 Perl_hv_eiter_set(pTHX_ HV *hv, HE *eiter) {
1879 struct xpvhv_aux *iter;
1881 PERL_ARGS_ASSERT_HV_EITER_SET;
1884 Perl_croak(aTHX_ "Bad hash");
1889 /* 0 is the default so don't go malloc()ing a new structure just to
1894 iter = hv_auxinit(hv);
1896 iter->xhv_eiter = eiter;
1900 Perl_hv_name_set(pTHX_ HV *hv, const char *name, U32 len, U32 flags)
1903 struct xpvhv_aux *iter;
1907 PERL_ARGS_ASSERT_HV_NAME_SET;
1910 Perl_croak(aTHX_ "panic: hv name too long (%"UVuf")", (UV) len);
1914 if (iter->xhv_name_u.xhvnameu_name) {
1915 if(iter->xhv_name_count) {
1916 if(flags & HV_NAME_SETALL) {
1917 HEK ** const name = HvAUX(hv)->xhv_name_u.xhvnameu_names;
1918 HEK **hekp = name + (
1919 iter->xhv_name_count < 0
1920 ? -iter->xhv_name_count
1921 : iter->xhv_name_count
1923 while(hekp-- > name+1)
1924 unshare_hek_or_pvn(*hekp, 0, 0, 0);
1925 /* The first elem may be null. */
1926 if(*name) unshare_hek_or_pvn(*name, 0, 0, 0);
1928 spot = &iter->xhv_name_u.xhvnameu_name;
1929 iter->xhv_name_count = 0;
1932 if(iter->xhv_name_count > 0) {
1933 /* shift some things over */
1935 iter->xhv_name_u.xhvnameu_names, iter->xhv_name_count + 1, HEK *
1937 spot = iter->xhv_name_u.xhvnameu_names;
1938 spot[iter->xhv_name_count] = spot[1];
1940 iter->xhv_name_count = -(iter->xhv_name_count + 1);
1942 else if(*(spot = iter->xhv_name_u.xhvnameu_names)) {
1943 unshare_hek_or_pvn(*spot, 0, 0, 0);
1947 else if (flags & HV_NAME_SETALL) {
1948 unshare_hek_or_pvn(iter->xhv_name_u.xhvnameu_name, 0, 0, 0);
1949 spot = &iter->xhv_name_u.xhvnameu_name;
1952 HEK * const existing_name = iter->xhv_name_u.xhvnameu_name;
1953 Newx(iter->xhv_name_u.xhvnameu_names, 2, HEK *);
1954 iter->xhv_name_count = -2;
1955 spot = iter->xhv_name_u.xhvnameu_names;
1956 spot[1] = existing_name;
1959 else { spot = &iter->xhv_name_u.xhvnameu_name; iter->xhv_name_count = 0; }
1964 iter = hv_auxinit(hv);
1965 spot = &iter->xhv_name_u.xhvnameu_name;
1967 PERL_HASH(hash, name, len);
1968 *spot = name ? share_hek(name, flags & SVf_UTF8 ? -(I32)len : (I32)len, hash) : NULL;
1972 This is basically sv_eq_flags() in sv.c, but we avoid the magic
1977 hek_eq_pvn_flags(pTHX_ const HEK *hek, const char* pv, const I32 pvlen, const U32 flags) {
1978 if ( (HEK_UTF8(hek) ? 1 : 0) != (flags & SVf_UTF8 ? 1 : 0) ) {
1979 if (flags & SVf_UTF8)
1980 return (bytes_cmp_utf8(
1981 (const U8*)HEK_KEY(hek), HEK_LEN(hek),
1982 (const U8*)pv, pvlen) == 0);
1984 return (bytes_cmp_utf8(
1985 (const U8*)pv, pvlen,
1986 (const U8*)HEK_KEY(hek), HEK_LEN(hek)) == 0);
1989 return HEK_LEN(hek) == pvlen && ((HEK_KEY(hek) == pv)
1990 || memEQ(HEK_KEY(hek), pv, pvlen));
1994 =for apidoc hv_ename_add
1996 Adds a name to a stash's internal list of effective names. See
1999 This is called when a stash is assigned to a new location in the symbol
2006 Perl_hv_ename_add(pTHX_ HV *hv, const char *name, U32 len, U32 flags)
2009 struct xpvhv_aux *aux = SvOOK(hv) ? HvAUX(hv) : hv_auxinit(hv);
2012 PERL_ARGS_ASSERT_HV_ENAME_ADD;
2015 Perl_croak(aTHX_ "panic: hv name too long (%"UVuf")", (UV) len);
2017 PERL_HASH(hash, name, len);
2019 if (aux->xhv_name_count) {
2020 HEK ** const xhv_name = aux->xhv_name_u.xhvnameu_names;
2021 I32 count = aux->xhv_name_count;
2022 HEK **hekp = xhv_name + (count < 0 ? -count : count);
2023 while (hekp-- > xhv_name)
2025 (HEK_UTF8(*hekp) || (flags & SVf_UTF8))
2026 ? hek_eq_pvn_flags(aTHX_ *hekp, name, (I32)len, flags)
2027 : (HEK_LEN(*hekp) == (I32)len && memEQ(HEK_KEY(*hekp), name, len))
2029 if (hekp == xhv_name && count < 0)
2030 aux->xhv_name_count = -count;
2033 if (count < 0) aux->xhv_name_count--, count = -count;
2034 else aux->xhv_name_count++;
2035 Renew(aux->xhv_name_u.xhvnameu_names, count + 1, HEK *);
2036 (aux->xhv_name_u.xhvnameu_names)[count] = share_hek(name, (flags & SVf_UTF8 ? -(I32)len : (I32)len), hash);
2039 HEK *existing_name = aux->xhv_name_u.xhvnameu_name;
2042 (HEK_UTF8(existing_name) || (flags & SVf_UTF8))
2043 ? hek_eq_pvn_flags(aTHX_ existing_name, name, (I32)len, flags)
2044 : (HEK_LEN(existing_name) == (I32)len && memEQ(HEK_KEY(existing_name), name, len))
2047 Newx(aux->xhv_name_u.xhvnameu_names, 2, HEK *);
2048 aux->xhv_name_count = existing_name ? 2 : -2;
2049 *aux->xhv_name_u.xhvnameu_names = existing_name;
2050 (aux->xhv_name_u.xhvnameu_names)[1] = share_hek(name, (flags & SVf_UTF8 ? -(I32)len : (I32)len), hash);
2055 =for apidoc hv_ename_delete
2057 Removes a name from a stash's internal list of effective names. If this is
2058 the name returned by C<HvENAME>, then another name in the list will take
2059 its place (C<HvENAME> will use it).
2061 This is called when a stash is deleted from the symbol table.
2067 Perl_hv_ename_delete(pTHX_ HV *hv, const char *name, U32 len, U32 flags)
2070 struct xpvhv_aux *aux;
2072 PERL_ARGS_ASSERT_HV_ENAME_DELETE;
2075 Perl_croak(aTHX_ "panic: hv name too long (%"UVuf")", (UV) len);
2077 if (!SvOOK(hv)) return;
2080 if (!aux->xhv_name_u.xhvnameu_name) return;
2082 if (aux->xhv_name_count) {
2083 HEK ** const namep = aux->xhv_name_u.xhvnameu_names;
2084 I32 const count = aux->xhv_name_count;
2085 HEK **victim = namep + (count < 0 ? -count : count);
2086 while (victim-- > namep + 1)
2088 (HEK_UTF8(*victim) || (flags & SVf_UTF8))
2089 ? hek_eq_pvn_flags(aTHX_ *victim, name, (I32)len, flags)
2090 : (HEK_LEN(*victim) == (I32)len && memEQ(HEK_KEY(*victim), name, len))
2092 unshare_hek_or_pvn(*victim, 0, 0, 0);
2093 if (count < 0) ++aux->xhv_name_count;
2094 else --aux->xhv_name_count;
2096 (aux->xhv_name_count == 1 || aux->xhv_name_count == -1)
2098 ) { /* if there are none left */
2100 aux->xhv_name_u.xhvnameu_names = NULL;
2101 aux->xhv_name_count = 0;
2104 /* Move the last one back to fill the empty slot. It
2105 does not matter what order they are in. */
2106 *victim = *(namep + (count < 0 ? -count : count) - 1);
2111 count > 0 && (HEK_UTF8(*namep) || (flags & SVf_UTF8))
2112 ? hek_eq_pvn_flags(aTHX_ *namep, name, (I32)len, flags)
2113 : (HEK_LEN(*namep) == (I32)len && memEQ(HEK_KEY(*namep), name, len))
2115 aux->xhv_name_count = -count;
2119 (HEK_UTF8(aux->xhv_name_u.xhvnameu_name) || (flags & SVf_UTF8))
2120 ? hek_eq_pvn_flags(aTHX_ aux->xhv_name_u.xhvnameu_name, name, (I32)len, flags)
2121 : (HEK_LEN(aux->xhv_name_u.xhvnameu_name) == (I32)len &&
2122 memEQ(HEK_KEY(aux->xhv_name_u.xhvnameu_name), name, len))
2124 HEK * const namehek = aux->xhv_name_u.xhvnameu_name;
2125 Newx(aux->xhv_name_u.xhvnameu_names, 1, HEK *);
2126 *aux->xhv_name_u.xhvnameu_names = namehek;
2127 aux->xhv_name_count = -1;
2132 Perl_hv_backreferences_p(pTHX_ HV *hv) {
2133 struct xpvhv_aux * const iter = SvOOK(hv) ? HvAUX(hv) : hv_auxinit(hv);
2135 PERL_ARGS_ASSERT_HV_BACKREFERENCES_P;
2136 PERL_UNUSED_CONTEXT;
2138 return &(iter->xhv_backreferences);
2142 Perl_hv_kill_backrefs(pTHX_ HV *hv) {
2145 PERL_ARGS_ASSERT_HV_KILL_BACKREFS;
2150 av = HvAUX(hv)->xhv_backreferences;
2153 HvAUX(hv)->xhv_backreferences = 0;
2154 Perl_sv_kill_backrefs(aTHX_ MUTABLE_SV(hv), av);
2155 if (SvTYPE(av) == SVt_PVAV)
2156 SvREFCNT_dec_NN(av);
2161 hv_iternext is implemented as a macro in hv.h
2163 =for apidoc hv_iternext
2165 Returns entries from a hash iterator. See C<hv_iterinit>.
2167 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
2168 iterator currently points to, without losing your place or invalidating your
2169 iterator. Note that in this case the current entry is deleted from the hash
2170 with your iterator holding the last reference to it. Your iterator is flagged
2171 to free the entry on the next call to C<hv_iternext>, so you must not discard
2172 your iterator immediately else the entry will leak - call C<hv_iternext> to
2173 trigger the resource deallocation.
2175 =for apidoc hv_iternext_flags
2177 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
2178 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
2179 set the placeholders keys (for restricted hashes) will be returned in addition
2180 to normal keys. By default placeholders are automatically skipped over.
2181 Currently a placeholder is implemented with a value that is
2182 C<&PL_sv_placeholder>. Note that the implementation of placeholders and
2183 restricted hashes may change, and the implementation currently is
2184 insufficiently abstracted for any change to be tidy.
2190 Perl_hv_iternext_flags(pTHX_ HV *hv, I32 flags)
2197 struct xpvhv_aux *iter;
2199 PERL_ARGS_ASSERT_HV_ITERNEXT_FLAGS;
2202 Perl_croak(aTHX_ "Bad hash");
2204 xhv = (XPVHV*)SvANY(hv);
2207 /* Too many things (well, pp_each at least) merrily assume that you can
2208 call hv_iternext without calling hv_iterinit, so we'll have to deal
2214 oldentry = entry = iter->xhv_eiter; /* HvEITER(hv) */
2215 if (SvMAGICAL(hv) && SvRMAGICAL(hv)) {
2216 if ( ( mg = mg_find((const SV *)hv, PERL_MAGIC_tied) ) ) {
2217 SV * const key = sv_newmortal();
2219 sv_setsv(key, HeSVKEY_force(entry));
2220 SvREFCNT_dec(HeSVKEY(entry)); /* get rid of previous key */
2221 HeSVKEY_set(entry, NULL);
2227 /* one HE per MAGICAL hash */
2228 iter->xhv_eiter = entry = new_HE(); /* HvEITER(hv) = new_HE() */
2229 HvLAZYDEL_on(hv); /* make sure entry gets freed */
2231 Newxz(k, HEK_BASESIZE + sizeof(const SV *), char);
2233 HeKEY_hek(entry) = hek;
2234 HeKLEN(entry) = HEf_SVKEY;
2236 magic_nextpack(MUTABLE_SV(hv),mg,key);
2238 /* force key to stay around until next time */
2239 HeSVKEY_set(entry, SvREFCNT_inc_simple_NN(key));
2240 return entry; /* beware, hent_val is not set */
2242 SvREFCNT_dec(HeVAL(entry));
2243 Safefree(HeKEY_hek(entry));
2245 iter->xhv_eiter = NULL; /* HvEITER(hv) = NULL */
2250 #if defined(DYNAMIC_ENV_FETCH) && !defined(__riscos__) /* set up %ENV for iteration */
2251 if (!entry && SvRMAGICAL((const SV *)hv)
2252 && mg_find((const SV *)hv, PERL_MAGIC_env)) {
2255 /* The prime_env_iter() on VMS just loaded up new hash values
2256 * so the iteration count needs to be reset back to the beginning
2260 oldentry = entry = iter->xhv_eiter; /* HvEITER(hv) */
2265 /* hv_iterinit now ensures this. */
2266 assert (HvARRAY(hv));
2268 /* At start of hash, entry is NULL. */
2271 entry = HeNEXT(entry);
2272 if (!(flags & HV_ITERNEXT_WANTPLACEHOLDERS)) {
2274 * Skip past any placeholders -- don't want to include them in
2277 while (entry && HeVAL(entry) == &PL_sv_placeholder) {
2278 entry = HeNEXT(entry);
2283 /* Skip the entire loop if the hash is empty. */
2284 if ((flags & HV_ITERNEXT_WANTPLACEHOLDERS)
2285 ? HvTOTALKEYS(hv) : HvUSEDKEYS(hv)) {
2287 /* OK. Come to the end of the current list. Grab the next one. */
2289 iter->xhv_riter++; /* HvRITER(hv)++ */
2290 if (iter->xhv_riter > (I32)xhv->xhv_max /* HvRITER(hv) > HvMAX(hv) */) {
2291 /* There is no next one. End of the hash. */
2292 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
2295 entry = (HvARRAY(hv))[iter->xhv_riter];
2297 if (!(flags & HV_ITERNEXT_WANTPLACEHOLDERS)) {
2298 /* If we have an entry, but it's a placeholder, don't count it.
2300 while (entry && HeVAL(entry) == &PL_sv_placeholder)
2301 entry = HeNEXT(entry);
2303 /* Will loop again if this linked list starts NULL
2304 (for HV_ITERNEXT_WANTPLACEHOLDERS)
2305 or if we run through it and find only placeholders. */
2308 else iter->xhv_riter = -1;
2310 if (oldentry && HvLAZYDEL(hv)) { /* was deleted earlier? */
2312 hv_free_ent(hv, oldentry);
2315 iter->xhv_eiter = entry; /* HvEITER(hv) = entry */
2320 =for apidoc hv_iterkey
2322 Returns the key from the current position of the hash iterator. See
2329 Perl_hv_iterkey(pTHX_ HE *entry, I32 *retlen)
2331 PERL_ARGS_ASSERT_HV_ITERKEY;
2333 if (HeKLEN(entry) == HEf_SVKEY) {
2335 char * const p = SvPV(HeKEY_sv(entry), len);
2340 *retlen = HeKLEN(entry);
2341 return HeKEY(entry);
2345 /* unlike hv_iterval(), this always returns a mortal copy of the key */
2347 =for apidoc hv_iterkeysv
2349 Returns the key as an C<SV*> from the current position of the hash
2350 iterator. The return value will always be a mortal copy of the key. Also
2357 Perl_hv_iterkeysv(pTHX_ HE *entry)
2359 PERL_ARGS_ASSERT_HV_ITERKEYSV;
2361 return sv_2mortal(newSVhek(HeKEY_hek(entry)));
2365 =for apidoc hv_iterval
2367 Returns the value from the current position of the hash iterator. See
2374 Perl_hv_iterval(pTHX_ HV *hv, HE *entry)
2376 PERL_ARGS_ASSERT_HV_ITERVAL;
2378 if (SvRMAGICAL(hv)) {
2379 if (mg_find((const SV *)hv, PERL_MAGIC_tied)) {
2380 SV* const sv = sv_newmortal();
2381 if (HeKLEN(entry) == HEf_SVKEY)
2382 mg_copy(MUTABLE_SV(hv), sv, (char*)HeKEY_sv(entry), HEf_SVKEY);
2384 mg_copy(MUTABLE_SV(hv), sv, HeKEY(entry), HeKLEN(entry));
2388 return HeVAL(entry);
2392 =for apidoc hv_iternextsv
2394 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
2401 Perl_hv_iternextsv(pTHX_ HV *hv, char **key, I32 *retlen)
2403 HE * const he = hv_iternext_flags(hv, 0);
2405 PERL_ARGS_ASSERT_HV_ITERNEXTSV;
2409 *key = hv_iterkey(he, retlen);
2410 return hv_iterval(hv, he);
2417 =for apidoc hv_magic
2419 Adds magic to a hash. See C<sv_magic>.
2424 /* possibly free a shared string if no one has access to it
2425 * len and hash must both be valid for str.
2428 Perl_unsharepvn(pTHX_ const char *str, I32 len, U32 hash)
2430 unshare_hek_or_pvn (NULL, str, len, hash);
2435 Perl_unshare_hek(pTHX_ HEK *hek)
2438 unshare_hek_or_pvn(hek, NULL, 0, 0);
2441 /* possibly free a shared string if no one has access to it
2442 hek if non-NULL takes priority over the other 3, else str, len and hash
2443 are used. If so, len and hash must both be valid for str.
2446 S_unshare_hek_or_pvn(pTHX_ const HEK *hek, const char *str, I32 len, U32 hash)
2452 bool is_utf8 = FALSE;
2454 const char * const save = str;
2455 struct shared_he *he = NULL;
2458 /* Find the shared he which is just before us in memory. */
2459 he = (struct shared_he *)(((char *)hek)
2460 - STRUCT_OFFSET(struct shared_he,
2463 /* Assert that the caller passed us a genuine (or at least consistent)
2465 assert (he->shared_he_he.hent_hek == hek);
2467 if (he->shared_he_he.he_valu.hent_refcount - 1) {
2468 --he->shared_he_he.he_valu.hent_refcount;
2472 hash = HEK_HASH(hek);
2473 } else if (len < 0) {
2474 STRLEN tmplen = -len;
2476 /* See the note in hv_fetch(). --jhi */
2477 str = (char*)bytes_from_utf8((U8*)str, &tmplen, &is_utf8);
2480 k_flags = HVhek_UTF8;
2482 k_flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
2485 /* what follows was the moral equivalent of:
2486 if ((Svp = hv_fetch(PL_strtab, tmpsv, FALSE, hash))) {
2488 hv_delete(PL_strtab, str, len, G_DISCARD, hash);
2490 xhv = (XPVHV*)SvANY(PL_strtab);
2491 /* assert(xhv_array != 0) */
2492 oentry = &(HvARRAY(PL_strtab))[hash & (I32) HvMAX(PL_strtab)];
2494 const HE *const he_he = &(he->shared_he_he);
2495 for (entry = *oentry; entry; oentry = &HeNEXT(entry), entry = *oentry) {
2500 const int flags_masked = k_flags & HVhek_MASK;
2501 for (entry = *oentry; entry; oentry = &HeNEXT(entry), entry = *oentry) {
2502 if (HeHASH(entry) != hash) /* strings can't be equal */
2504 if (HeKLEN(entry) != len)
2506 if (HeKEY(entry) != str && memNE(HeKEY(entry),str,len)) /* is this it? */
2508 if (HeKFLAGS(entry) != flags_masked)
2515 if (--entry->he_valu.hent_refcount == 0) {
2516 *oentry = HeNEXT(entry);
2518 xhv->xhv_keys--; /* HvTOTALKEYS(hv)-- */
2523 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
2524 "Attempt to free nonexistent shared string '%s'%s"
2526 hek ? HEK_KEY(hek) : str,
2527 ((k_flags & HVhek_UTF8) ? " (utf8)" : "") pTHX__VALUE);
2528 if (k_flags & HVhek_FREEKEY)
2532 /* get a (constant) string ptr from the global string table
2533 * string will get added if it is not already there.
2534 * len and hash must both be valid for str.
2537 Perl_share_hek(pTHX_ const char *str, I32 len, U32 hash)
2539 bool is_utf8 = FALSE;
2541 const char * const save = str;
2543 PERL_ARGS_ASSERT_SHARE_HEK;
2546 STRLEN tmplen = -len;
2548 /* See the note in hv_fetch(). --jhi */
2549 str = (char*)bytes_from_utf8((U8*)str, &tmplen, &is_utf8);
2551 /* If we were able to downgrade here, then than means that we were passed
2552 in a key which only had chars 0-255, but was utf8 encoded. */
2555 /* If we found we were able to downgrade the string to bytes, then
2556 we should flag that it needs upgrading on keys or each. Also flag
2557 that we need share_hek_flags to free the string. */
2560 PERL_HASH(hash, str, len);
2561 flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
2565 return share_hek_flags (str, len, hash, flags);
2569 S_share_hek_flags(pTHX_ const char *str, I32 len, U32 hash, int flags)
2573 const int flags_masked = flags & HVhek_MASK;
2574 const U32 hindex = hash & (I32) HvMAX(PL_strtab);
2575 XPVHV * const xhv = (XPVHV*)SvANY(PL_strtab);
2577 PERL_ARGS_ASSERT_SHARE_HEK_FLAGS;
2579 /* what follows is the moral equivalent of:
2581 if (!(Svp = hv_fetch(PL_strtab, str, len, FALSE)))
2582 hv_store(PL_strtab, str, len, NULL, hash);
2584 Can't rehash the shared string table, so not sure if it's worth
2585 counting the number of entries in the linked list
2588 /* assert(xhv_array != 0) */
2589 entry = (HvARRAY(PL_strtab))[hindex];
2590 for (;entry; entry = HeNEXT(entry)) {
2591 if (HeHASH(entry) != hash) /* strings can't be equal */
2593 if (HeKLEN(entry) != len)
2595 if (HeKEY(entry) != str && memNE(HeKEY(entry),str,len)) /* is this it? */
2597 if (HeKFLAGS(entry) != flags_masked)
2603 /* What used to be head of the list.
2604 If this is NULL, then we're the first entry for this slot, which
2605 means we need to increate fill. */
2606 struct shared_he *new_entry;
2609 HE **const head = &HvARRAY(PL_strtab)[hindex];
2610 HE *const next = *head;
2612 /* We don't actually store a HE from the arena and a regular HEK.
2613 Instead we allocate one chunk of memory big enough for both,
2614 and put the HEK straight after the HE. This way we can find the
2615 HE directly from the HEK.
2618 Newx(k, STRUCT_OFFSET(struct shared_he,
2619 shared_he_hek.hek_key[0]) + len + 2, char);
2620 new_entry = (struct shared_he *)k;
2621 entry = &(new_entry->shared_he_he);
2622 hek = &(new_entry->shared_he_hek);
2624 Copy(str, HEK_KEY(hek), len, char);
2625 HEK_KEY(hek)[len] = 0;
2627 HEK_HASH(hek) = hash;
2628 HEK_FLAGS(hek) = (unsigned char)flags_masked;
2630 /* Still "point" to the HEK, so that other code need not know what
2632 HeKEY_hek(entry) = hek;
2633 entry->he_valu.hent_refcount = 0;
2634 HeNEXT(entry) = next;
2637 xhv->xhv_keys++; /* HvTOTALKEYS(hv)++ */
2638 if (!next) { /* initial entry? */
2639 } else if ( DO_HSPLIT(xhv) ) {
2640 const STRLEN oldsize = xhv->xhv_max + 1;
2641 hsplit(PL_strtab, oldsize, oldsize * 2);
2645 ++entry->he_valu.hent_refcount;
2647 if (flags & HVhek_FREEKEY)
2650 return HeKEY_hek(entry);
2654 Perl_hv_placeholders_p(pTHX_ HV *hv)
2657 MAGIC *mg = mg_find((const SV *)hv, PERL_MAGIC_rhash);
2659 PERL_ARGS_ASSERT_HV_PLACEHOLDERS_P;
2662 mg = sv_magicext(MUTABLE_SV(hv), 0, PERL_MAGIC_rhash, 0, 0, 0);
2665 Perl_die(aTHX_ "panic: hv_placeholders_p");
2668 return &(mg->mg_len);
2673 Perl_hv_placeholders_get(pTHX_ const HV *hv)
2676 MAGIC * const mg = mg_find((const SV *)hv, PERL_MAGIC_rhash);
2678 PERL_ARGS_ASSERT_HV_PLACEHOLDERS_GET;
2680 return mg ? mg->mg_len : 0;
2684 Perl_hv_placeholders_set(pTHX_ HV *hv, I32 ph)
2687 MAGIC * const mg = mg_find((const SV *)hv, PERL_MAGIC_rhash);
2689 PERL_ARGS_ASSERT_HV_PLACEHOLDERS_SET;
2694 if (!sv_magicext(MUTABLE_SV(hv), 0, PERL_MAGIC_rhash, 0, 0, ph))
2695 Perl_die(aTHX_ "panic: hv_placeholders_set");
2697 /* else we don't need to add magic to record 0 placeholders. */
2701 S_refcounted_he_value(pTHX_ const struct refcounted_he *he)
2706 PERL_ARGS_ASSERT_REFCOUNTED_HE_VALUE;
2708 switch(he->refcounted_he_data[0] & HVrhek_typemask) {
2713 value = &PL_sv_placeholder;
2716 value = newSViv(he->refcounted_he_val.refcounted_he_u_iv);
2719 value = newSVuv(he->refcounted_he_val.refcounted_he_u_uv);
2722 case HVrhek_PV_UTF8:
2723 /* Create a string SV that directly points to the bytes in our
2725 value = newSV_type(SVt_PV);
2726 SvPV_set(value, (char *) he->refcounted_he_data + 1);
2727 SvCUR_set(value, he->refcounted_he_val.refcounted_he_u_len);
2728 /* This stops anything trying to free it */
2729 SvLEN_set(value, 0);
2731 SvREADONLY_on(value);
2732 if ((he->refcounted_he_data[0] & HVrhek_typemask) == HVrhek_PV_UTF8)
2736 Perl_croak(aTHX_ "panic: refcounted_he_value bad flags %"UVxf,
2737 (UV)he->refcounted_he_data[0]);
2743 =for apidoc m|HV *|refcounted_he_chain_2hv|const struct refcounted_he *c|U32 flags
2745 Generates and returns a C<HV *> representing the content of a
2746 C<refcounted_he> chain.
2747 I<flags> is currently unused and must be zero.
2752 Perl_refcounted_he_chain_2hv(pTHX_ const struct refcounted_he *chain, U32 flags)
2756 U32 placeholders, max;
2759 Perl_croak(aTHX_ "panic: refcounted_he_chain_2hv bad flags %"UVxf,
2762 /* We could chase the chain once to get an idea of the number of keys,
2763 and call ksplit. But for now we'll make a potentially inefficient
2764 hash with only 8 entries in its array. */
2769 Newxz(array, PERL_HV_ARRAY_ALLOC_BYTES(max + 1), char);
2770 HvARRAY(hv) = (HE**)array;
2776 U32 hash = chain->refcounted_he_hash;
2778 U32 hash = HEK_HASH(chain->refcounted_he_hek);
2780 HE **oentry = &((HvARRAY(hv))[hash & max]);
2781 HE *entry = *oentry;
2784 for (; entry; entry = HeNEXT(entry)) {
2785 if (HeHASH(entry) == hash) {
2786 /* We might have a duplicate key here. If so, entry is older
2787 than the key we've already put in the hash, so if they are
2788 the same, skip adding entry. */
2790 const STRLEN klen = HeKLEN(entry);
2791 const char *const key = HeKEY(entry);
2792 if (klen == chain->refcounted_he_keylen
2793 && (!!HeKUTF8(entry)
2794 == !!(chain->refcounted_he_data[0] & HVhek_UTF8))
2795 && memEQ(key, REF_HE_KEY(chain), klen))
2798 if (HeKEY_hek(entry) == chain->refcounted_he_hek)
2800 if (HeKLEN(entry) == HEK_LEN(chain->refcounted_he_hek)
2801 && HeKUTF8(entry) == HEK_UTF8(chain->refcounted_he_hek)
2802 && memEQ(HeKEY(entry), HEK_KEY(chain->refcounted_he_hek),
2813 = share_hek_flags(REF_HE_KEY(chain),
2814 chain->refcounted_he_keylen,
2815 chain->refcounted_he_hash,
2816 (chain->refcounted_he_data[0]
2817 & (HVhek_UTF8|HVhek_WASUTF8)));
2819 HeKEY_hek(entry) = share_hek_hek(chain->refcounted_he_hek);
2821 value = refcounted_he_value(chain);
2822 if (value == &PL_sv_placeholder)
2824 HeVAL(entry) = value;
2826 /* Link it into the chain. */
2827 HeNEXT(entry) = *oentry;
2833 chain = chain->refcounted_he_next;
2837 clear_placeholders(hv, placeholders);
2838 HvTOTALKEYS(hv) -= placeholders;
2841 /* We could check in the loop to see if we encounter any keys with key
2842 flags, but it's probably not worth it, as this per-hash flag is only
2843 really meant as an optimisation for things like Storable. */
2845 DEBUG_A(Perl_hv_assert(aTHX_ hv));
2851 =for apidoc m|SV *|refcounted_he_fetch_pvn|const struct refcounted_he *chain|const char *keypv|STRLEN keylen|U32 hash|U32 flags
2853 Search along a C<refcounted_he> chain for an entry with the key specified
2854 by I<keypv> and I<keylen>. If I<flags> has the C<REFCOUNTED_HE_KEY_UTF8>
2855 bit set, the key octets are interpreted as UTF-8, otherwise they
2856 are interpreted as Latin-1. I<hash> is a precomputed hash of the key
2857 string, or zero if it has not been precomputed. Returns a mortal scalar
2858 representing the value associated with the key, or C<&PL_sv_placeholder>
2859 if there is no value associated with the key.
2865 Perl_refcounted_he_fetch_pvn(pTHX_ const struct refcounted_he *chain,
2866 const char *keypv, STRLEN keylen, U32 hash, U32 flags)
2870 PERL_ARGS_ASSERT_REFCOUNTED_HE_FETCH_PVN;
2872 if (flags & ~(REFCOUNTED_HE_KEY_UTF8|REFCOUNTED_HE_EXISTS))
2873 Perl_croak(aTHX_ "panic: refcounted_he_fetch_pvn bad flags %"UVxf,
2876 return &PL_sv_placeholder;
2877 if (flags & REFCOUNTED_HE_KEY_UTF8) {
2878 /* For searching purposes, canonicalise to Latin-1 where possible. */
2879 const char *keyend = keypv + keylen, *p;
2880 STRLEN nonascii_count = 0;
2881 for (p = keypv; p != keyend; p++) {
2884 if (!((c & 0xfe) == 0xc2 && ++p != keyend &&
2885 (((U8)*p) & 0xc0) == 0x80))
2886 goto canonicalised_key;
2890 if (nonascii_count) {
2892 const char *p = keypv, *keyend = keypv + keylen;
2893 keylen -= nonascii_count;
2894 Newx(q, keylen, char);
2897 for (; p != keyend; p++, q++) {
2900 ((c & 0x80) ? ((c & 0x03) << 6) | (((U8)*++p) & 0x3f) : c);
2903 flags &= ~REFCOUNTED_HE_KEY_UTF8;
2904 canonicalised_key: ;
2906 utf8_flag = (flags & REFCOUNTED_HE_KEY_UTF8) ? HVhek_UTF8 : 0;
2908 PERL_HASH(hash, keypv, keylen);
2910 for (; chain; chain = chain->refcounted_he_next) {
2913 hash == chain->refcounted_he_hash &&
2914 keylen == chain->refcounted_he_keylen &&
2915 memEQ(REF_HE_KEY(chain), keypv, keylen) &&
2916 utf8_flag == (chain->refcounted_he_data[0] & HVhek_UTF8)
2918 hash == HEK_HASH(chain->refcounted_he_hek) &&
2919 keylen == (STRLEN)HEK_LEN(chain->refcounted_he_hek) &&
2920 memEQ(HEK_KEY(chain->refcounted_he_hek), keypv, keylen) &&
2921 utf8_flag == (HEK_FLAGS(chain->refcounted_he_hek) & HVhek_UTF8)
2924 if (flags & REFCOUNTED_HE_EXISTS)
2925 return (chain->refcounted_he_data[0] & HVrhek_typemask)
2927 ? NULL : &PL_sv_yes;
2928 return sv_2mortal(refcounted_he_value(chain));
2931 return flags & REFCOUNTED_HE_EXISTS ? NULL : &PL_sv_placeholder;
2935 =for apidoc m|SV *|refcounted_he_fetch_pv|const struct refcounted_he *chain|const char *key|U32 hash|U32 flags
2937 Like L</refcounted_he_fetch_pvn>, but takes a nul-terminated string
2938 instead of a string/length pair.
2944 Perl_refcounted_he_fetch_pv(pTHX_ const struct refcounted_he *chain,
2945 const char *key, U32 hash, U32 flags)
2947 PERL_ARGS_ASSERT_REFCOUNTED_HE_FETCH_PV;
2948 return refcounted_he_fetch_pvn(chain, key, strlen(key), hash, flags);
2952 =for apidoc m|SV *|refcounted_he_fetch_sv|const struct refcounted_he *chain|SV *key|U32 hash|U32 flags
2954 Like L</refcounted_he_fetch_pvn>, but takes a Perl scalar instead of a
2961 Perl_refcounted_he_fetch_sv(pTHX_ const struct refcounted_he *chain,
2962 SV *key, U32 hash, U32 flags)
2966 PERL_ARGS_ASSERT_REFCOUNTED_HE_FETCH_SV;
2967 if (flags & REFCOUNTED_HE_KEY_UTF8)
2968 Perl_croak(aTHX_ "panic: refcounted_he_fetch_sv bad flags %"UVxf,
2970 keypv = SvPV_const(key, keylen);
2972 flags |= REFCOUNTED_HE_KEY_UTF8;
2973 if (!hash && SvIsCOW_shared_hash(key))
2974 hash = SvSHARED_HASH(key);
2975 return refcounted_he_fetch_pvn(chain, keypv, keylen, hash, flags);
2979 =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
2981 Creates a new C<refcounted_he>. This consists of a single key/value
2982 pair and a reference to an existing C<refcounted_he> chain (which may
2983 be empty), and thus forms a longer chain. When using the longer chain,
2984 the new key/value pair takes precedence over any entry for the same key
2985 further along the chain.
2987 The new key is specified by I<keypv> and I<keylen>. If I<flags> has
2988 the C<REFCOUNTED_HE_KEY_UTF8> bit set, the key octets are interpreted
2989 as UTF-8, otherwise they are interpreted as Latin-1. I<hash> is
2990 a precomputed hash of the key string, or zero if it has not been
2993 I<value> is the scalar value to store for this key. I<value> is copied
2994 by this function, which thus does not take ownership of any reference
2995 to it, and later changes to the scalar will not be reflected in the
2996 value visible in the C<refcounted_he>. Complex types of scalar will not
2997 be stored with referential integrity, but will be coerced to strings.
2998 I<value> may be either null or C<&PL_sv_placeholder> to indicate that no
2999 value is to be associated with the key; this, as with any non-null value,
3000 takes precedence over the existence of a value for the key further along
3003 I<parent> points to the rest of the C<refcounted_he> chain to be
3004 attached to the new C<refcounted_he>. This function takes ownership
3005 of one reference to I<parent>, and returns one reference to the new
3011 struct refcounted_he *
3012 Perl_refcounted_he_new_pvn(pTHX_ struct refcounted_he *parent,
3013 const char *keypv, STRLEN keylen, U32 hash, SV *value, U32 flags)
3016 STRLEN value_len = 0;
3017 const char *value_p = NULL;
3021 STRLEN key_offset = 1;
3022 struct refcounted_he *he;
3023 PERL_ARGS_ASSERT_REFCOUNTED_HE_NEW_PVN;
3025 if (!value || value == &PL_sv_placeholder) {
3026 value_type = HVrhek_delete;
3027 } else if (SvPOK(value)) {
3028 value_type = HVrhek_PV;
3029 } else if (SvIOK(value)) {
3030 value_type = SvUOK((const SV *)value) ? HVrhek_UV : HVrhek_IV;
3031 } else if (!SvOK(value)) {
3032 value_type = HVrhek_undef;
3034 value_type = HVrhek_PV;
3036 is_pv = value_type == HVrhek_PV;
3038 /* Do it this way so that the SvUTF8() test is after the SvPV, in case
3039 the value is overloaded, and doesn't yet have the UTF-8flag set. */
3040 value_p = SvPV_const(value, value_len);
3042 value_type = HVrhek_PV_UTF8;
3043 key_offset = value_len + 2;
3045 hekflags = value_type;
3047 if (flags & REFCOUNTED_HE_KEY_UTF8) {
3048 /* Canonicalise to Latin-1 where possible. */
3049 const char *keyend = keypv + keylen, *p;
3050 STRLEN nonascii_count = 0;
3051 for (p = keypv; p != keyend; p++) {
3054 if (!((c & 0xfe) == 0xc2 && ++p != keyend &&
3055 (((U8)*p) & 0xc0) == 0x80))
3056 goto canonicalised_key;
3060 if (nonascii_count) {
3062 const char *p = keypv, *keyend = keypv + keylen;
3063 keylen -= nonascii_count;
3064 Newx(q, keylen, char);
3067 for (; p != keyend; p++, q++) {
3070 ((c & 0x80) ? ((c & 0x03) << 6) | (((U8)*++p) & 0x3f) : c);
3073 flags &= ~REFCOUNTED_HE_KEY_UTF8;
3074 canonicalised_key: ;
3076 if (flags & REFCOUNTED_HE_KEY_UTF8)
3077 hekflags |= HVhek_UTF8;
3079 PERL_HASH(hash, keypv, keylen);
3082 he = (struct refcounted_he*)
3083 PerlMemShared_malloc(sizeof(struct refcounted_he) - 1
3087 he = (struct refcounted_he*)
3088 PerlMemShared_malloc(sizeof(struct refcounted_he) - 1
3092 he->refcounted_he_next = parent;
3095 Copy(value_p, he->refcounted_he_data + 1, value_len + 1, char);
3096 he->refcounted_he_val.refcounted_he_u_len = value_len;
3097 } else if (value_type == HVrhek_IV) {
3098 he->refcounted_he_val.refcounted_he_u_iv = SvIVX(value);
3099 } else if (value_type == HVrhek_UV) {
3100 he->refcounted_he_val.refcounted_he_u_uv = SvUVX(value);
3104 he->refcounted_he_hash = hash;
3105 he->refcounted_he_keylen = keylen;
3106 Copy(keypv, he->refcounted_he_data + key_offset, keylen, char);
3108 he->refcounted_he_hek = share_hek_flags(keypv, keylen, hash, hekflags);
3111 he->refcounted_he_data[0] = hekflags;
3112 he->refcounted_he_refcnt = 1;
3118 =for apidoc m|struct refcounted_he *|refcounted_he_new_pv|struct refcounted_he *parent|const char *key|U32 hash|SV *value|U32 flags
3120 Like L</refcounted_he_new_pvn>, but takes a nul-terminated string instead
3121 of a string/length pair.
3126 struct refcounted_he *
3127 Perl_refcounted_he_new_pv(pTHX_ struct refcounted_he *parent,
3128 const char *key, U32 hash, SV *value, U32 flags)
3130 PERL_ARGS_ASSERT_REFCOUNTED_HE_NEW_PV;
3131 return refcounted_he_new_pvn(parent, key, strlen(key), hash, value, flags);
3135 =for apidoc m|struct refcounted_he *|refcounted_he_new_sv|struct refcounted_he *parent|SV *key|U32 hash|SV *value|U32 flags
3137 Like L</refcounted_he_new_pvn>, but takes a Perl scalar instead of a
3143 struct refcounted_he *
3144 Perl_refcounted_he_new_sv(pTHX_ struct refcounted_he *parent,
3145 SV *key, U32 hash, SV *value, U32 flags)
3149 PERL_ARGS_ASSERT_REFCOUNTED_HE_NEW_SV;
3150 if (flags & REFCOUNTED_HE_KEY_UTF8)
3151 Perl_croak(aTHX_ "panic: refcounted_he_new_sv bad flags %"UVxf,
3153 keypv = SvPV_const(key, keylen);
3155 flags |= REFCOUNTED_HE_KEY_UTF8;
3156 if (!hash && SvIsCOW_shared_hash(key))
3157 hash = SvSHARED_HASH(key);
3158 return refcounted_he_new_pvn(parent, keypv, keylen, hash, value, flags);
3162 =for apidoc m|void|refcounted_he_free|struct refcounted_he *he
3164 Decrements the reference count of a C<refcounted_he> by one. If the
3165 reference count reaches zero the structure's memory is freed, which
3166 (recursively) causes a reduction of its parent C<refcounted_he>'s
3167 reference count. It is safe to pass a null pointer to this function:
3168 no action occurs in this case.
3174 Perl_refcounted_he_free(pTHX_ struct refcounted_he *he) {
3176 PERL_UNUSED_CONTEXT;
3179 struct refcounted_he *copy;
3183 new_count = --he->refcounted_he_refcnt;
3184 HINTS_REFCNT_UNLOCK;
3190 #ifndef USE_ITHREADS
3191 unshare_hek_or_pvn (he->refcounted_he_hek, 0, 0, 0);
3194 he = he->refcounted_he_next;
3195 PerlMemShared_free(copy);
3200 =for apidoc m|struct refcounted_he *|refcounted_he_inc|struct refcounted_he *he
3202 Increment the reference count of a C<refcounted_he>. The pointer to the
3203 C<refcounted_he> is also returned. It is safe to pass a null pointer
3204 to this function: no action occurs and a null pointer is returned.
3209 struct refcounted_he *
3210 Perl_refcounted_he_inc(pTHX_ struct refcounted_he *he)
3215 he->refcounted_he_refcnt++;
3216 HINTS_REFCNT_UNLOCK;
3222 =for apidoc cop_fetch_label
3224 Returns the label attached to a cop.
3225 The flags pointer may be set to C<SVf_UTF8> or 0.
3230 /* pp_entereval is aware that labels are stored with a key ':' at the top of
3233 Perl_cop_fetch_label(pTHX_ COP *const cop, STRLEN *len, U32 *flags) {
3234 struct refcounted_he *const chain = cop->cop_hints_hash;
3236 PERL_ARGS_ASSERT_COP_FETCH_LABEL;
3241 if (chain->refcounted_he_keylen != 1)
3243 if (*REF_HE_KEY(chain) != ':')
3246 if ((STRLEN)HEK_LEN(chain->refcounted_he_hek) != 1)
3248 if (*HEK_KEY(chain->refcounted_he_hek) != ':')
3251 /* Stop anyone trying to really mess us up by adding their own value for
3253 if ((chain->refcounted_he_data[0] & HVrhek_typemask) != HVrhek_PV
3254 && (chain->refcounted_he_data[0] & HVrhek_typemask) != HVrhek_PV_UTF8)
3258 *len = chain->refcounted_he_val.refcounted_he_u_len;
3260 *flags = ((chain->refcounted_he_data[0] & HVrhek_typemask)
3261 == HVrhek_PV_UTF8) ? SVf_UTF8 : 0;
3263 return chain->refcounted_he_data + 1;
3267 =for apidoc cop_store_label
3269 Save a label into a C<cop_hints_hash>. You need to set flags to C<SVf_UTF8>
3276 Perl_cop_store_label(pTHX_ COP *const cop, const char *label, STRLEN len,
3280 PERL_ARGS_ASSERT_COP_STORE_LABEL;
3282 if (flags & ~(SVf_UTF8))
3283 Perl_croak(aTHX_ "panic: cop_store_label illegal flag bits 0x%" UVxf,
3285 labelsv = newSVpvn_flags(label, len, SVs_TEMP);
3286 if (flags & SVf_UTF8)
3289 = refcounted_he_new_pvs(cop->cop_hints_hash, ":", labelsv, 0);
3293 =for apidoc hv_assert
3295 Check that a hash is in an internally consistent state.
3303 Perl_hv_assert(pTHX_ HV *hv)
3308 int placeholders = 0;
3311 const I32 riter = HvRITER_get(hv);
3312 HE *eiter = HvEITER_get(hv);
3314 PERL_ARGS_ASSERT_HV_ASSERT;
3316 (void)hv_iterinit(hv);
3318 while ((entry = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS))) {
3319 /* sanity check the values */
3320 if (HeVAL(entry) == &PL_sv_placeholder)
3324 /* sanity check the keys */
3325 if (HeSVKEY(entry)) {
3326 NOOP; /* Don't know what to check on SV keys. */
3327 } else if (HeKUTF8(entry)) {
3329 if (HeKWASUTF8(entry)) {
3330 PerlIO_printf(Perl_debug_log,
3331 "hash key has both WASUTF8 and UTF8: '%.*s'\n",
3332 (int) HeKLEN(entry), HeKEY(entry));
3335 } else if (HeKWASUTF8(entry))
3338 if (!SvTIED_mg((const SV *)hv, PERL_MAGIC_tied)) {
3339 static const char bad_count[] = "Count %d %s(s), but hash reports %d\n";
3340 const int nhashkeys = HvUSEDKEYS(hv);
3341 const int nhashplaceholders = HvPLACEHOLDERS_get(hv);
3343 if (nhashkeys != real) {
3344 PerlIO_printf(Perl_debug_log, bad_count, real, "keys", nhashkeys );
3347 if (nhashplaceholders != placeholders) {
3348 PerlIO_printf(Perl_debug_log, bad_count, placeholders, "placeholder", nhashplaceholders );
3352 if (withflags && ! HvHASKFLAGS(hv)) {
3353 PerlIO_printf(Perl_debug_log,
3354 "Hash has HASKFLAGS off but I count %d key(s) with flags\n",
3359 sv_dump(MUTABLE_SV(hv));
3361 HvRITER_set(hv, riter); /* Restore hash iterator state */
3362 HvEITER_set(hv, eiter);
3369 * c-indentation-style: bsd
3371 * indent-tabs-mode: nil
3374 * ex: set ts=8 sts=4 sw=4 et: