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) ) {
803 return entry ? (void *) &HeVAL(entry) : NULL;
805 return (void *) entry;
809 S_hv_magic_check(HV *hv, bool *needs_copy, bool *needs_store)
811 const MAGIC *mg = SvMAGIC(hv);
813 PERL_ARGS_ASSERT_HV_MAGIC_CHECK;
818 if (isUPPER(mg->mg_type)) {
820 if (mg->mg_type == PERL_MAGIC_tied) {
821 *needs_store = FALSE;
822 return; /* We've set all there is to set. */
825 mg = mg->mg_moremagic;
830 =for apidoc hv_scalar
832 Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
838 Perl_hv_scalar(pTHX_ HV *hv)
842 PERL_ARGS_ASSERT_HV_SCALAR;
844 if (SvRMAGICAL(hv)) {
845 MAGIC * const mg = mg_find((const SV *)hv, PERL_MAGIC_tied);
847 return magic_scalarpack(hv, mg);
851 if (HvTOTALKEYS((const HV *)hv))
852 Perl_sv_setpvf(aTHX_ sv, "%ld/%ld",
853 (long)HvFILL(hv), (long)HvMAX(hv) + 1);
861 =for apidoc hv_delete
863 Deletes a key/value pair in the hash. The value's SV is removed from
864 the hash, made mortal, and returned to the caller. The absolute
865 value of C<klen> is the length of the key. If C<klen> is negative the
866 key is assumed to be in UTF-8-encoded Unicode. The C<flags> value
867 will normally be zero; if set to G_DISCARD then NULL will be returned.
868 NULL will also be returned if the key is not found.
870 =for apidoc hv_delete_ent
872 Deletes a key/value pair in the hash. The value SV is removed from the hash,
873 made mortal, and returned to the caller. The C<flags> value will normally be
874 zero; if set to G_DISCARD then NULL will be returned. NULL will also be
875 returned if the key is not found. C<hash> can be a valid precomputed hash
876 value, or 0 to ask for it to be computed.
882 S_hv_delete_common(pTHX_ HV *hv, SV *keysv, const char *key, STRLEN klen,
883 int k_flags, I32 d_flags, U32 hash)
889 bool is_utf8 = (k_flags & HVhek_UTF8) ? TRUE : FALSE;
892 if (SvRMAGICAL(hv)) {
895 hv_magic_check (hv, &needs_copy, &needs_store);
899 entry = (HE *) hv_common(hv, keysv, key, klen,
900 k_flags & ~HVhek_FREEKEY,
901 HV_FETCH_LVALUE|HV_DISABLE_UVAR_XKEY,
903 sv = entry ? HeVAL(entry) : NULL;
909 if (mg_find(sv, PERL_MAGIC_tiedelem)) {
910 /* No longer an element */
911 sv_unmagic(sv, PERL_MAGIC_tiedelem);
914 return NULL; /* element cannot be deleted */
916 #ifdef ENV_IS_CASELESS
917 else if (mg_find((const SV *)hv, PERL_MAGIC_env)) {
918 /* XXX This code isn't UTF8 clean. */
919 keysv = newSVpvn_flags(key, klen, SVs_TEMP);
920 if (k_flags & HVhek_FREEKEY) {
923 key = strupr(SvPVX(keysv));
932 xhv = (XPVHV*)SvANY(hv);
936 if (is_utf8 && !(k_flags & HVhek_KEYCANONICAL)) {
937 const char * const keysave = key;
938 key = (char*)bytes_from_utf8((U8*)key, &klen, &is_utf8);
941 k_flags |= HVhek_UTF8;
943 k_flags &= ~HVhek_UTF8;
944 if (key != keysave) {
945 if (k_flags & HVhek_FREEKEY) {
946 /* This shouldn't happen if our caller does what we expect,
947 but strictly the API allows it. */
950 k_flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
952 HvHASKFLAGS_on(MUTABLE_SV(hv));
956 if (keysv && (SvIsCOW_shared_hash(keysv)))
957 hash = SvSHARED_HASH(keysv);
959 PERL_HASH(hash, key, klen);
962 masked_flags = (k_flags & HVhek_MASK);
964 oentry = &(HvARRAY(hv))[hash & (I32) HvMAX(hv)];
966 for (; entry; oentry = &HeNEXT(entry), entry = *oentry) {
968 U8 mro_changes = 0; /* 1 = isa; 2 = package moved */
972 if (HeHASH(entry) != hash) /* strings can't be equal */
974 if (HeKLEN(entry) != (I32)klen)
976 if (HeKEY(entry) != key && memNE(HeKEY(entry),key,klen)) /* is this it? */
978 if ((HeKFLAGS(entry) ^ masked_flags) & HVhek_UTF8)
981 if (hv == PL_strtab) {
982 if (k_flags & HVhek_FREEKEY)
984 Perl_croak(aTHX_ S_strtab_error, "delete");
987 /* if placeholder is here, it's already been deleted.... */
988 if (HeVAL(entry) == &PL_sv_placeholder) {
989 if (k_flags & HVhek_FREEKEY)
993 if (SvREADONLY(hv) && HeVAL(entry) && SvREADONLY(HeVAL(entry))
994 && !SvIsCOW(HeVAL(entry))) {
995 hv_notallowed(k_flags, key, klen,
996 "Attempt to delete readonly key '%"SVf"' from"
997 " a restricted hash");
999 if (k_flags & HVhek_FREEKEY)
1002 /* If this is a stash and the key ends with ::, then someone is
1003 * deleting a package.
1005 if (HeVAL(entry) && HvENAME_get(hv)) {
1006 gv = (GV *)HeVAL(entry);
1007 if (keysv) key = SvPV(keysv, klen);
1009 (klen > 1 && key[klen-2] == ':' && key[klen-1] == ':')
1011 (klen == 1 && key[0] == ':')
1013 && (klen != 6 || hv!=PL_defstash || memNE(key,"main::",6))
1014 && SvTYPE(gv) == SVt_PVGV && (stash = GvHV((GV *)gv))
1015 && HvENAME_get(stash)) {
1016 /* A previous version of this code checked that the
1017 * GV was still in the symbol table by fetching the
1018 * GV with its name. That is not necessary (and
1019 * sometimes incorrect), as HvENAME cannot be set
1020 * on hv if it is not in the symtab. */
1022 /* Hang on to it for a bit. */
1023 SvREFCNT_inc_simple_void_NN(
1024 sv_2mortal((SV *)gv)
1027 else if (klen == 3 && strnEQ(key, "ISA", 3))
1031 sv = d_flags & G_DISCARD ? HeVAL(entry) : sv_2mortal(HeVAL(entry));
1032 HeVAL(entry) = &PL_sv_placeholder;
1034 /* deletion of method from stash */
1035 if (isGV(sv) && isGV_with_GP(sv) && GvCVu(sv)
1037 mro_method_changed_in(hv);
1041 * If a restricted hash, rather than really deleting the entry, put
1042 * a placeholder there. This marks the key as being "approved", so
1043 * we can still access via not-really-existing key without raising
1047 /* We'll be saving this slot, so the number of allocated keys
1048 * doesn't go down, but the number placeholders goes up */
1049 HvPLACEHOLDERS(hv)++;
1051 *oentry = HeNEXT(entry);
1052 if (SvOOK(hv) && entry == HvAUX(hv)->xhv_eiter /* HvEITER(hv) */)
1055 if (SvOOK(hv) && HvLAZYDEL(hv) &&
1056 entry == HeNEXT(HvAUX(hv)->xhv_eiter))
1057 HeNEXT(HvAUX(hv)->xhv_eiter) = HeNEXT(entry);
1058 hv_free_ent(hv, entry);
1060 xhv->xhv_keys--; /* HvTOTALKEYS(hv)-- */
1061 if (xhv->xhv_keys == 0)
1062 HvHASKFLAGS_off(hv);
1065 if (d_flags & G_DISCARD) {
1070 if (mro_changes == 1) mro_isa_changed_in(hv);
1071 else if (mro_changes == 2)
1072 mro_package_moved(NULL, stash, gv, 1);
1076 if (SvREADONLY(hv)) {
1077 hv_notallowed(k_flags, key, klen,
1078 "Attempt to delete disallowed key '%"SVf"' from"
1079 " a restricted hash");
1082 if (k_flags & HVhek_FREEKEY)
1088 S_hsplit(pTHX_ HV *hv)
1091 XPVHV* const xhv = (XPVHV*)SvANY(hv);
1092 const I32 oldsize = (I32) xhv->xhv_max+1; /* HvMAX(hv)+1 (sick) */
1093 I32 newsize = oldsize * 2;
1095 char *a = (char*) HvARRAY(hv);
1098 PERL_ARGS_ASSERT_HSPLIT;
1100 /*PerlIO_printf(PerlIO_stderr(), "hsplit called for %p which had %d\n",
1101 (void*)hv, (int) oldsize);*/
1103 if (HvPLACEHOLDERS_get(hv) && !SvREADONLY(hv)) {
1104 /* Can make this clear any placeholders first for non-restricted hashes,
1105 even though Storable rebuilds restricted hashes by putting in all the
1106 placeholders (first) before turning on the readonly flag, because
1107 Storable always pre-splits the hash. */
1108 hv_clear_placeholders(hv);
1112 #if defined(STRANGE_MALLOC) || defined(MYMALLOC)
1113 Renew(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1114 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
1120 Move(&a[oldsize * sizeof(HE*)], &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
1123 Newx(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1124 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
1129 Copy(HvARRAY(hv), a, oldsize * sizeof(HE*), char);
1131 Copy(HvAUX(hv), &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
1133 Safefree(HvARRAY(hv));
1137 Zero(&a[oldsize * sizeof(HE*)], (newsize-oldsize) * sizeof(HE*), char); /* zero 2nd half*/
1138 xhv->xhv_max = --newsize; /* HvMAX(hv) = --newsize */
1139 HvARRAY(hv) = (HE**) a;
1142 for (i=0; i<oldsize; i++,aep++) {
1147 if (!entry) /* non-existent */
1151 if ((HeHASH(entry) & newsize) != (U32)i) {
1152 *oentry = HeNEXT(entry);
1153 HeNEXT(entry) = *bep;
1157 oentry = &HeNEXT(entry);
1161 /* I think we don't actually need to keep track of the longest length,
1162 merely flag if anything is too long. But for the moment while
1163 developing this code I'll track it. */
1168 Perl_hv_ksplit(pTHX_ HV *hv, IV newmax)
1171 XPVHV* xhv = (XPVHV*)SvANY(hv);
1172 const I32 oldsize = (I32) xhv->xhv_max+1; /* HvMAX(hv)+1 (sick) */
1178 PERL_ARGS_ASSERT_HV_KSPLIT;
1180 newsize = (I32) newmax; /* possible truncation here */
1181 if (newsize != newmax || newmax <= oldsize)
1183 while ((newsize & (1 + ~newsize)) != newsize) {
1184 newsize &= ~(newsize & (1 + ~newsize)); /* get proper power of 2 */
1186 if (newsize < newmax)
1188 if (newsize < newmax)
1189 return; /* overflow detection */
1191 a = (char *) HvARRAY(hv);
1194 #if defined(STRANGE_MALLOC) || defined(MYMALLOC)
1195 Renew(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1196 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
1202 Copy(&a[oldsize * sizeof(HE*)], &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
1205 Newx(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1206 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
1211 Copy(HvARRAY(hv), a, oldsize * sizeof(HE*), char);
1213 Copy(HvAUX(hv), &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
1215 Safefree(HvARRAY(hv));
1218 Zero(&a[oldsize * sizeof(HE*)], (newsize-oldsize) * sizeof(HE*), char); /* zero 2nd half*/
1221 Newxz(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize), char);
1223 xhv->xhv_max = --newsize; /* HvMAX(hv) = --newsize */
1224 HvARRAY(hv) = (HE **) a;
1225 if (!xhv->xhv_keys /* !HvTOTALKEYS(hv) */) /* skip rest if no entries */
1229 for (i=0; i<oldsize; i++,aep++) {
1233 if (!entry) /* non-existent */
1236 I32 j = (HeHASH(entry) & newsize);
1240 *oentry = HeNEXT(entry);
1241 HeNEXT(entry) = aep[j];
1245 oentry = &HeNEXT(entry);
1252 Perl_newHVhv(pTHX_ HV *ohv)
1255 HV * const hv = newHV();
1258 if (!ohv || (!HvTOTALKEYS(ohv) && !SvMAGICAL((const SV *)ohv)))
1260 hv_max = HvMAX(ohv);
1262 if (!SvMAGICAL((const SV *)ohv)) {
1263 /* It's an ordinary hash, so copy it fast. AMS 20010804 */
1265 const bool shared = !!HvSHAREKEYS(ohv);
1266 HE **ents, ** const oents = (HE **)HvARRAY(ohv);
1268 Newx(a, PERL_HV_ARRAY_ALLOC_BYTES(hv_max+1), char);
1271 /* In each bucket... */
1272 for (i = 0; i <= hv_max; i++) {
1274 HE *oent = oents[i];
1281 /* Copy the linked list of entries. */
1282 for (; oent; oent = HeNEXT(oent)) {
1283 const U32 hash = HeHASH(oent);
1284 const char * const key = HeKEY(oent);
1285 const STRLEN len = HeKLEN(oent);
1286 const int flags = HeKFLAGS(oent);
1287 HE * const ent = new_HE();
1288 SV *const val = HeVAL(oent);
1290 HeVAL(ent) = SvIMMORTAL(val) ? val : newSVsv(val);
1292 = shared ? share_hek_flags(key, len, hash, flags)
1293 : save_hek_flags(key, len, hash, flags);
1304 HvTOTALKEYS(hv) = HvTOTALKEYS(ohv);
1308 /* Iterate over ohv, copying keys and values one at a time. */
1310 const I32 riter = HvRITER_get(ohv);
1311 HE * const eiter = HvEITER_get(ohv);
1312 STRLEN hv_fill = HvFILL(ohv);
1314 /* Can we use fewer buckets? (hv_max is always 2^n-1) */
1315 while (hv_max && hv_max + 1 >= hv_fill * 2)
1316 hv_max = hv_max / 2;
1320 while ((entry = hv_iternext_flags(ohv, 0))) {
1321 SV *val = hv_iterval(ohv,entry);
1322 SV * const keysv = HeSVKEY(entry);
1323 val = SvIMMORTAL(val) ? val : newSVsv(val);
1325 (void)hv_store_ent(hv, keysv, val, 0);
1327 (void)hv_store_flags(hv, HeKEY(entry), HeKLEN(entry), val,
1328 HeHASH(entry), HeKFLAGS(entry));
1330 HvRITER_set(ohv, riter);
1331 HvEITER_set(ohv, eiter);
1338 =for apidoc Am|HV *|hv_copy_hints_hv|HV *ohv
1340 A specialised version of L</newHVhv> for copying C<%^H>. I<ohv> must be
1341 a pointer to a hash (which may have C<%^H> magic, but should be generally
1342 non-magical), or C<NULL> (interpreted as an empty hash). The content
1343 of I<ohv> is copied to a new hash, which has the C<%^H>-specific magic
1344 added to it. A pointer to the new hash is returned.
1350 Perl_hv_copy_hints_hv(pTHX_ HV *const ohv)
1352 HV * const hv = newHV();
1355 STRLEN hv_max = HvMAX(ohv);
1356 STRLEN hv_fill = HvFILL(ohv);
1358 const I32 riter = HvRITER_get(ohv);
1359 HE * const eiter = HvEITER_get(ohv);
1364 while (hv_max && hv_max + 1 >= hv_fill * 2)
1365 hv_max = hv_max / 2;
1369 while ((entry = hv_iternext_flags(ohv, 0))) {
1370 SV *const sv = newSVsv(hv_iterval(ohv,entry));
1371 SV *heksv = HeSVKEY(entry);
1372 if (!heksv && sv) heksv = newSVhek(HeKEY_hek(entry));
1373 if (sv) sv_magic(sv, NULL, PERL_MAGIC_hintselem,
1374 (char *)heksv, HEf_SVKEY);
1375 if (heksv == HeSVKEY(entry))
1376 (void)hv_store_ent(hv, heksv, sv, 0);
1378 (void)hv_common(hv, heksv, HeKEY(entry), HeKLEN(entry),
1379 HeKFLAGS(entry), HV_FETCH_ISSTORE|HV_FETCH_JUST_SV, sv, HeHASH(entry));
1380 SvREFCNT_dec(heksv);
1383 HvRITER_set(ohv, riter);
1384 HvEITER_set(ohv, eiter);
1386 SvREFCNT_inc_simple_void_NN(hv);
1389 hv_magic(hv, NULL, PERL_MAGIC_hints);
1393 /* like hv_free_ent, but returns the SV rather than freeing it */
1395 S_hv_free_ent_ret(pTHX_ HV *hv, HE *entry)
1400 PERL_ARGS_ASSERT_HV_FREE_ENT_RET;
1405 if (HeKLEN(entry) == HEf_SVKEY) {
1406 SvREFCNT_dec(HeKEY_sv(entry));
1407 Safefree(HeKEY_hek(entry));
1409 else if (HvSHAREKEYS(hv))
1410 unshare_hek(HeKEY_hek(entry));
1412 Safefree(HeKEY_hek(entry));
1419 Perl_hv_free_ent(pTHX_ HV *hv, HE *entry)
1424 PERL_ARGS_ASSERT_HV_FREE_ENT;
1428 val = hv_free_ent_ret(hv, entry);
1434 Perl_hv_delayfree_ent(pTHX_ HV *hv, HE *entry)
1438 PERL_ARGS_ASSERT_HV_DELAYFREE_ENT;
1442 /* SvREFCNT_inc to counter the SvREFCNT_dec in hv_free_ent */
1443 sv_2mortal(SvREFCNT_inc(HeVAL(entry))); /* free between statements */
1444 if (HeKLEN(entry) == HEf_SVKEY) {
1445 sv_2mortal(SvREFCNT_inc(HeKEY_sv(entry)));
1447 hv_free_ent(hv, entry);
1451 =for apidoc hv_clear
1453 Frees the all the elements of a hash, leaving it empty.
1454 The XS equivalent of C<%hash = ()>. See also L</hv_undef>.
1456 If any destructors are triggered as a result, the hv itself may
1463 Perl_hv_clear(pTHX_ HV *hv)
1470 DEBUG_A(Perl_hv_assert(aTHX_ hv));
1472 xhv = (XPVHV*)SvANY(hv);
1475 SAVEFREESV(SvREFCNT_inc_simple_NN(hv));
1476 if (SvREADONLY(hv) && HvARRAY(hv) != NULL) {
1477 /* restricted hash: convert all keys to placeholders */
1479 for (i = 0; i <= xhv->xhv_max; i++) {
1480 HE *entry = (HvARRAY(hv))[i];
1481 for (; entry; entry = HeNEXT(entry)) {
1482 /* not already placeholder */
1483 if (HeVAL(entry) != &PL_sv_placeholder) {
1484 if (HeVAL(entry) && SvREADONLY(HeVAL(entry))
1485 && !SvIsCOW(HeVAL(entry))) {
1486 SV* const keysv = hv_iterkeysv(entry);
1488 "Attempt to delete readonly key '%"SVf"' from a restricted hash",
1491 SvREFCNT_dec(HeVAL(entry));
1492 HeVAL(entry) = &PL_sv_placeholder;
1493 HvPLACEHOLDERS(hv)++;
1500 HvPLACEHOLDERS_set(hv, 0);
1503 mg_clear(MUTABLE_SV(hv));
1505 HvHASKFLAGS_off(hv);
1509 mro_isa_changed_in(hv);
1510 HvEITER_set(hv, NULL);
1516 =for apidoc hv_clear_placeholders
1518 Clears any placeholders from a hash. If a restricted hash has any of its keys
1519 marked as readonly and the key is subsequently deleted, the key is not actually
1520 deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
1521 it so it will be ignored by future operations such as iterating over the hash,
1522 but will still allow the hash to have a value reassigned to the key at some
1523 future point. This function clears any such placeholder keys from the hash.
1524 See Hash::Util::lock_keys() for an example of its use.
1530 Perl_hv_clear_placeholders(pTHX_ HV *hv)
1533 const U32 items = (U32)HvPLACEHOLDERS_get(hv);
1535 PERL_ARGS_ASSERT_HV_CLEAR_PLACEHOLDERS;
1538 clear_placeholders(hv, items);
1542 S_clear_placeholders(pTHX_ HV *hv, U32 items)
1547 PERL_ARGS_ASSERT_CLEAR_PLACEHOLDERS;
1554 /* Loop down the linked list heads */
1555 HE **oentry = &(HvARRAY(hv))[i];
1558 while ((entry = *oentry)) {
1559 if (HeVAL(entry) == &PL_sv_placeholder) {
1560 *oentry = HeNEXT(entry);
1561 if (entry == HvEITER_get(hv))
1564 if (SvOOK(hv) && HvLAZYDEL(hv) &&
1565 entry == HeNEXT(HvAUX(hv)->xhv_eiter))
1566 HeNEXT(HvAUX(hv)->xhv_eiter) = HeNEXT(entry);
1567 hv_free_ent(hv, entry);
1572 HvTOTALKEYS(hv) -= (IV)HvPLACEHOLDERS_get(hv);
1573 if (HvUSEDKEYS(hv) == 0)
1574 HvHASKFLAGS_off(hv);
1575 HvPLACEHOLDERS_set(hv, 0);
1579 oentry = &HeNEXT(entry);
1583 /* You can't get here, hence assertion should always fail. */
1584 assert (items == 0);
1589 S_hfreeentries(pTHX_ HV *hv)
1592 XPVHV * const xhv = (XPVHV*)SvANY(hv);
1595 PERL_ARGS_ASSERT_HFREEENTRIES;
1597 while ((sv = Perl_hfree_next_entry(aTHX_ hv, &index))||xhv->xhv_keys) {
1603 /* hfree_next_entry()
1604 * For use only by S_hfreeentries() and sv_clear().
1605 * Delete the next available HE from hv and return the associated SV.
1606 * Returns null on empty hash. Nevertheless null is not a reliable
1607 * indicator that the hash is empty, as the deleted entry may have a
1609 * indexp is a pointer to the current index into HvARRAY. The index should
1610 * initially be set to 0. hfree_next_entry() may update it. */
1613 Perl_hfree_next_entry(pTHX_ HV *hv, STRLEN *indexp)
1615 struct xpvhv_aux *iter;
1619 STRLEN orig_index = *indexp;
1622 PERL_ARGS_ASSERT_HFREE_NEXT_ENTRY;
1624 if (SvOOK(hv) && ((iter = HvAUX(hv)))
1625 && ((entry = iter->xhv_eiter)) )
1627 /* the iterator may get resurrected after each
1628 * destructor call, so check each time */
1629 if (entry && HvLAZYDEL(hv)) { /* was deleted earlier? */
1631 hv_free_ent(hv, entry);
1632 /* warning: at this point HvARRAY may have been
1633 * re-allocated, HvMAX changed etc */
1635 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
1636 iter->xhv_eiter = NULL; /* HvEITER(hv) = NULL */
1639 if (!((XPVHV*)SvANY(hv))->xhv_keys)
1642 array = HvARRAY(hv);
1644 while ( ! ((entry = array[*indexp])) ) {
1645 if ((*indexp)++ >= HvMAX(hv))
1647 assert(*indexp != orig_index);
1649 array[*indexp] = HeNEXT(entry);
1650 ((XPVHV*) SvANY(hv))->xhv_keys--;
1652 if ( PL_phase != PERL_PHASE_DESTRUCT && HvENAME(hv)
1653 && HeVAL(entry) && isGV(HeVAL(entry))
1654 && GvHV(HeVAL(entry)) && HvENAME(GvHV(HeVAL(entry)))
1657 const char * const key = HePV(entry,klen);
1658 if ((klen > 1 && key[klen-1]==':' && key[klen-2]==':')
1659 || (klen == 1 && key[0] == ':')) {
1661 NULL, GvHV(HeVAL(entry)),
1662 (GV *)HeVAL(entry), 0
1666 return hv_free_ent_ret(hv, entry);
1671 =for apidoc hv_undef
1673 Undefines the hash. The XS equivalent of C<undef(%hash)>.
1675 As well as freeing all the elements of the hash (like hv_clear()), this
1676 also frees any auxiliary data and storage associated with the hash.
1678 If any destructors are triggered as a result, the hv itself may
1681 See also L</hv_clear>.
1687 Perl_hv_undef_flags(pTHX_ HV *hv, U32 flags)
1692 const bool save = !!SvREFCNT(hv);
1696 DEBUG_A(Perl_hv_assert(aTHX_ hv));
1697 xhv = (XPVHV*)SvANY(hv);
1699 /* The name must be deleted before the call to hfreeeeentries so that
1700 CVs are anonymised properly. But the effective name must be pre-
1701 served until after that call (and only deleted afterwards if the
1702 call originated from sv_clear). For stashes with one name that is
1703 both the canonical name and the effective name, hv_name_set has to
1704 allocate an array for storing the effective name. We can skip that
1705 during global destruction, as it does not matter where the CVs point
1706 if they will be freed anyway. */
1707 /* note that the code following prior to hfreeentries is duplicated
1708 * in sv_clear(), and changes here should be done there too */
1709 if (PL_phase != PERL_PHASE_DESTRUCT && (name = HvNAME(hv))) {
1710 if (PL_stashcache) {
1711 DEBUG_o(Perl_deb(aTHX_ "hv_undef_flags clearing PL_stashcache for '%"
1712 HEKf"'\n", HvNAME_HEK(hv)));
1713 (void)hv_delete(PL_stashcache, name,
1714 HEK_UTF8(HvNAME_HEK(hv)) ? -HvNAMELEN_get(hv) : HvNAMELEN_get(hv),
1718 hv_name_set(hv, NULL, 0, 0);
1722 SAVEFREESV(SvREFCNT_inc_simple_NN(hv));
1726 struct xpvhv_aux * const aux = HvAUX(hv);
1727 struct mro_meta *meta;
1729 if ((name = HvENAME_get(hv))) {
1730 if (PL_phase != PERL_PHASE_DESTRUCT)
1731 mro_isa_changed_in(hv);
1732 if (PL_stashcache) {
1733 DEBUG_o(Perl_deb(aTHX_ "hv_undef_flags clearing PL_stashcache for effective name '%"
1734 HEKf"'\n", HvENAME_HEK(hv)));
1736 PL_stashcache, name,
1737 HEK_UTF8(HvENAME_HEK(hv)) ? -HvENAMELEN_get(hv) : HvENAMELEN_get(hv),
1743 /* If this call originated from sv_clear, then we must check for
1744 * effective names that need freeing, as well as the usual name. */
1746 if (flags & HV_NAME_SETALL ? !!aux->xhv_name_u.xhvnameu_name : !!name) {
1747 if (name && PL_stashcache) {
1748 DEBUG_o(Perl_deb(aTHX_ "hv_undef_flags clearing PL_stashcache for name '%"
1749 HEKf"'\n", HvNAME_HEK(hv)));
1750 (void)hv_delete(PL_stashcache, name, (HEK_UTF8(HvNAME_HEK(hv)) ? -HvNAMELEN_get(hv) : HvNAMELEN_get(hv)), G_DISCARD);
1752 hv_name_set(hv, NULL, 0, flags);
1754 if((meta = aux->xhv_mro_meta)) {
1755 if (meta->mro_linear_all) {
1756 SvREFCNT_dec(MUTABLE_SV(meta->mro_linear_all));
1757 meta->mro_linear_all = NULL;
1758 /* This is just acting as a shortcut pointer. */
1759 meta->mro_linear_current = NULL;
1760 } else if (meta->mro_linear_current) {
1761 /* Only the current MRO is stored, so this owns the data.
1763 SvREFCNT_dec(meta->mro_linear_current);
1764 meta->mro_linear_current = NULL;
1766 SvREFCNT_dec(meta->mro_nextmethod);
1767 SvREFCNT_dec(meta->isa);
1769 aux->xhv_mro_meta = NULL;
1771 SvREFCNT_dec(aux->xhv_super);
1772 if (!aux->xhv_name_u.xhvnameu_name && ! aux->xhv_backreferences)
1773 SvFLAGS(hv) &= ~SVf_OOK;
1776 Safefree(HvARRAY(hv));
1777 xhv->xhv_max = 7; /* HvMAX(hv) = 7 (it's a normal hash) */
1780 /* if we're freeing the HV, the SvMAGIC field has been reused for
1781 * other purposes, and so there can't be any placeholder magic */
1783 HvPLACEHOLDERS_set(hv, 0);
1786 mg_clear(MUTABLE_SV(hv));
1793 Returns the number of hash buckets that happen to be in use. This function is
1794 wrapped by the macro C<HvFILL>.
1796 Previously this value was stored in the HV structure, rather than being
1797 calculated on demand.
1803 Perl_hv_fill(pTHX_ HV const *const hv)
1806 HE **ents = HvARRAY(hv);
1808 PERL_ARGS_ASSERT_HV_FILL;
1811 HE *const *const last = ents + HvMAX(hv);
1812 count = last + 1 - ents;
1817 } while (++ents <= last);
1822 static struct xpvhv_aux*
1823 S_hv_auxinit(HV *hv) {
1824 struct xpvhv_aux *iter;
1827 PERL_ARGS_ASSERT_HV_AUXINIT;
1830 Newxz(array, PERL_HV_ARRAY_ALLOC_BYTES(HvMAX(hv) + 1)
1831 + sizeof(struct xpvhv_aux), char);
1833 array = (char *) HvARRAY(hv);
1834 Renew(array, PERL_HV_ARRAY_ALLOC_BYTES(HvMAX(hv) + 1)
1835 + sizeof(struct xpvhv_aux), char);
1837 HvARRAY(hv) = (HE**) array;
1841 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
1842 iter->xhv_eiter = NULL; /* HvEITER(hv) = NULL */
1843 iter->xhv_name_u.xhvnameu_name = 0;
1844 iter->xhv_name_count = 0;
1845 iter->xhv_backreferences = 0;
1846 iter->xhv_mro_meta = NULL;
1847 iter->xhv_super = NULL;
1852 =for apidoc hv_iterinit
1854 Prepares a starting point to traverse a hash table. Returns the number of
1855 keys in the hash (i.e. the same as C<HvUSEDKEYS(hv)>). The return value is
1856 currently only meaningful for hashes without tie magic.
1858 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1859 hash buckets that happen to be in use. If you still need that esoteric
1860 value, you can get it through the macro C<HvFILL(hv)>.
1867 Perl_hv_iterinit(pTHX_ HV *hv)
1869 PERL_ARGS_ASSERT_HV_ITERINIT;
1871 /* FIXME: Are we not NULL, or do we croak? Place bets now! */
1874 Perl_croak(aTHX_ "Bad hash");
1877 struct xpvhv_aux * const iter = HvAUX(hv);
1878 HE * const entry = iter->xhv_eiter; /* HvEITER(hv) */
1879 if (entry && HvLAZYDEL(hv)) { /* was deleted earlier? */
1881 hv_free_ent(hv, entry);
1883 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
1884 iter->xhv_eiter = NULL; /* HvEITER(hv) = NULL */
1889 /* used to be xhv->xhv_fill before 5.004_65 */
1890 return HvTOTALKEYS(hv);
1894 Perl_hv_riter_p(pTHX_ HV *hv) {
1895 struct xpvhv_aux *iter;
1897 PERL_ARGS_ASSERT_HV_RITER_P;
1900 Perl_croak(aTHX_ "Bad hash");
1902 iter = SvOOK(hv) ? HvAUX(hv) : hv_auxinit(hv);
1903 return &(iter->xhv_riter);
1907 Perl_hv_eiter_p(pTHX_ HV *hv) {
1908 struct xpvhv_aux *iter;
1910 PERL_ARGS_ASSERT_HV_EITER_P;
1913 Perl_croak(aTHX_ "Bad hash");
1915 iter = SvOOK(hv) ? HvAUX(hv) : hv_auxinit(hv);
1916 return &(iter->xhv_eiter);
1920 Perl_hv_riter_set(pTHX_ HV *hv, I32 riter) {
1921 struct xpvhv_aux *iter;
1923 PERL_ARGS_ASSERT_HV_RITER_SET;
1926 Perl_croak(aTHX_ "Bad hash");
1934 iter = hv_auxinit(hv);
1936 iter->xhv_riter = riter;
1940 Perl_hv_eiter_set(pTHX_ HV *hv, HE *eiter) {
1941 struct xpvhv_aux *iter;
1943 PERL_ARGS_ASSERT_HV_EITER_SET;
1946 Perl_croak(aTHX_ "Bad hash");
1951 /* 0 is the default so don't go malloc()ing a new structure just to
1956 iter = hv_auxinit(hv);
1958 iter->xhv_eiter = eiter;
1962 Perl_hv_name_set(pTHX_ HV *hv, const char *name, U32 len, U32 flags)
1965 struct xpvhv_aux *iter;
1969 PERL_ARGS_ASSERT_HV_NAME_SET;
1972 Perl_croak(aTHX_ "panic: hv name too long (%"UVuf")", (UV) len);
1976 if (iter->xhv_name_u.xhvnameu_name) {
1977 if(iter->xhv_name_count) {
1978 if(flags & HV_NAME_SETALL) {
1979 HEK ** const name = HvAUX(hv)->xhv_name_u.xhvnameu_names;
1980 HEK **hekp = name + (
1981 iter->xhv_name_count < 0
1982 ? -iter->xhv_name_count
1983 : iter->xhv_name_count
1985 while(hekp-- > name+1)
1986 unshare_hek_or_pvn(*hekp, 0, 0, 0);
1987 /* The first elem may be null. */
1988 if(*name) unshare_hek_or_pvn(*name, 0, 0, 0);
1990 spot = &iter->xhv_name_u.xhvnameu_name;
1991 iter->xhv_name_count = 0;
1994 if(iter->xhv_name_count > 0) {
1995 /* shift some things over */
1997 iter->xhv_name_u.xhvnameu_names, iter->xhv_name_count + 1, HEK *
1999 spot = iter->xhv_name_u.xhvnameu_names;
2000 spot[iter->xhv_name_count] = spot[1];
2002 iter->xhv_name_count = -(iter->xhv_name_count + 1);
2004 else if(*(spot = iter->xhv_name_u.xhvnameu_names)) {
2005 unshare_hek_or_pvn(*spot, 0, 0, 0);
2009 else if (flags & HV_NAME_SETALL) {
2010 unshare_hek_or_pvn(iter->xhv_name_u.xhvnameu_name, 0, 0, 0);
2011 spot = &iter->xhv_name_u.xhvnameu_name;
2014 HEK * const existing_name = iter->xhv_name_u.xhvnameu_name;
2015 Newx(iter->xhv_name_u.xhvnameu_names, 2, HEK *);
2016 iter->xhv_name_count = -2;
2017 spot = iter->xhv_name_u.xhvnameu_names;
2018 spot[1] = existing_name;
2021 else { spot = &iter->xhv_name_u.xhvnameu_name; iter->xhv_name_count = 0; }
2026 iter = hv_auxinit(hv);
2027 spot = &iter->xhv_name_u.xhvnameu_name;
2029 PERL_HASH(hash, name, len);
2030 *spot = name ? share_hek(name, flags & SVf_UTF8 ? -(I32)len : (I32)len, hash) : NULL;
2034 This is basically sv_eq_flags() in sv.c, but we avoid the magic
2039 hek_eq_pvn_flags(pTHX_ const HEK *hek, const char* pv, const I32 pvlen, const U32 flags) {
2040 if ( (HEK_UTF8(hek) ? 1 : 0) != (flags & SVf_UTF8 ? 1 : 0) ) {
2041 if (flags & SVf_UTF8)
2042 return (bytes_cmp_utf8(
2043 (const U8*)HEK_KEY(hek), HEK_LEN(hek),
2044 (const U8*)pv, pvlen) == 0);
2046 return (bytes_cmp_utf8(
2047 (const U8*)pv, pvlen,
2048 (const U8*)HEK_KEY(hek), HEK_LEN(hek)) == 0);
2051 return HEK_LEN(hek) == pvlen && ((HEK_KEY(hek) == pv)
2052 || memEQ(HEK_KEY(hek), pv, pvlen));
2056 =for apidoc hv_ename_add
2058 Adds a name to a stash's internal list of effective names. See
2061 This is called when a stash is assigned to a new location in the symbol
2068 Perl_hv_ename_add(pTHX_ HV *hv, const char *name, U32 len, U32 flags)
2071 struct xpvhv_aux *aux = SvOOK(hv) ? HvAUX(hv) : hv_auxinit(hv);
2074 PERL_ARGS_ASSERT_HV_ENAME_ADD;
2077 Perl_croak(aTHX_ "panic: hv name too long (%"UVuf")", (UV) len);
2079 PERL_HASH(hash, name, len);
2081 if (aux->xhv_name_count) {
2082 HEK ** const xhv_name = aux->xhv_name_u.xhvnameu_names;
2083 I32 count = aux->xhv_name_count;
2084 HEK **hekp = xhv_name + (count < 0 ? -count : count);
2085 while (hekp-- > xhv_name)
2087 (HEK_UTF8(*hekp) || (flags & SVf_UTF8))
2088 ? hek_eq_pvn_flags(aTHX_ *hekp, name, (I32)len, flags)
2089 : (HEK_LEN(*hekp) == (I32)len && memEQ(HEK_KEY(*hekp), name, len))
2091 if (hekp == xhv_name && count < 0)
2092 aux->xhv_name_count = -count;
2095 if (count < 0) aux->xhv_name_count--, count = -count;
2096 else aux->xhv_name_count++;
2097 Renew(aux->xhv_name_u.xhvnameu_names, count + 1, HEK *);
2098 (aux->xhv_name_u.xhvnameu_names)[count] = share_hek(name, (flags & SVf_UTF8 ? -(I32)len : (I32)len), hash);
2101 HEK *existing_name = aux->xhv_name_u.xhvnameu_name;
2104 (HEK_UTF8(existing_name) || (flags & SVf_UTF8))
2105 ? hek_eq_pvn_flags(aTHX_ existing_name, name, (I32)len, flags)
2106 : (HEK_LEN(existing_name) == (I32)len && memEQ(HEK_KEY(existing_name), name, len))
2109 Newx(aux->xhv_name_u.xhvnameu_names, 2, HEK *);
2110 aux->xhv_name_count = existing_name ? 2 : -2;
2111 *aux->xhv_name_u.xhvnameu_names = existing_name;
2112 (aux->xhv_name_u.xhvnameu_names)[1] = share_hek(name, (flags & SVf_UTF8 ? -(I32)len : (I32)len), hash);
2117 =for apidoc hv_ename_delete
2119 Removes a name from a stash's internal list of effective names. If this is
2120 the name returned by C<HvENAME>, then another name in the list will take
2121 its place (C<HvENAME> will use it).
2123 This is called when a stash is deleted from the symbol table.
2129 Perl_hv_ename_delete(pTHX_ HV *hv, const char *name, U32 len, U32 flags)
2132 struct xpvhv_aux *aux;
2134 PERL_ARGS_ASSERT_HV_ENAME_DELETE;
2137 Perl_croak(aTHX_ "panic: hv name too long (%"UVuf")", (UV) len);
2139 if (!SvOOK(hv)) return;
2142 if (!aux->xhv_name_u.xhvnameu_name) return;
2144 if (aux->xhv_name_count) {
2145 HEK ** const namep = aux->xhv_name_u.xhvnameu_names;
2146 I32 const count = aux->xhv_name_count;
2147 HEK **victim = namep + (count < 0 ? -count : count);
2148 while (victim-- > namep + 1)
2150 (HEK_UTF8(*victim) || (flags & SVf_UTF8))
2151 ? hek_eq_pvn_flags(aTHX_ *victim, name, (I32)len, flags)
2152 : (HEK_LEN(*victim) == (I32)len && memEQ(HEK_KEY(*victim), name, len))
2154 unshare_hek_or_pvn(*victim, 0, 0, 0);
2155 if (count < 0) ++aux->xhv_name_count;
2156 else --aux->xhv_name_count;
2158 (aux->xhv_name_count == 1 || aux->xhv_name_count == -1)
2160 ) { /* if there are none left */
2162 aux->xhv_name_u.xhvnameu_names = NULL;
2163 aux->xhv_name_count = 0;
2166 /* Move the last one back to fill the empty slot. It
2167 does not matter what order they are in. */
2168 *victim = *(namep + (count < 0 ? -count : count) - 1);
2173 count > 0 && (HEK_UTF8(*namep) || (flags & SVf_UTF8))
2174 ? hek_eq_pvn_flags(aTHX_ *namep, name, (I32)len, flags)
2175 : (HEK_LEN(*namep) == (I32)len && memEQ(HEK_KEY(*namep), name, len))
2177 aux->xhv_name_count = -count;
2181 (HEK_UTF8(aux->xhv_name_u.xhvnameu_name) || (flags & SVf_UTF8))
2182 ? hek_eq_pvn_flags(aTHX_ aux->xhv_name_u.xhvnameu_name, name, (I32)len, flags)
2183 : (HEK_LEN(aux->xhv_name_u.xhvnameu_name) == (I32)len &&
2184 memEQ(HEK_KEY(aux->xhv_name_u.xhvnameu_name), name, len))
2186 HEK * const namehek = aux->xhv_name_u.xhvnameu_name;
2187 Newx(aux->xhv_name_u.xhvnameu_names, 1, HEK *);
2188 *aux->xhv_name_u.xhvnameu_names = namehek;
2189 aux->xhv_name_count = -1;
2194 Perl_hv_backreferences_p(pTHX_ HV *hv) {
2195 struct xpvhv_aux * const iter = SvOOK(hv) ? HvAUX(hv) : hv_auxinit(hv);
2197 PERL_ARGS_ASSERT_HV_BACKREFERENCES_P;
2198 PERL_UNUSED_CONTEXT;
2200 return &(iter->xhv_backreferences);
2204 Perl_hv_kill_backrefs(pTHX_ HV *hv) {
2207 PERL_ARGS_ASSERT_HV_KILL_BACKREFS;
2212 av = HvAUX(hv)->xhv_backreferences;
2215 HvAUX(hv)->xhv_backreferences = 0;
2216 Perl_sv_kill_backrefs(aTHX_ MUTABLE_SV(hv), av);
2217 if (SvTYPE(av) == SVt_PVAV)
2223 hv_iternext is implemented as a macro in hv.h
2225 =for apidoc hv_iternext
2227 Returns entries from a hash iterator. See C<hv_iterinit>.
2229 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
2230 iterator currently points to, without losing your place or invalidating your
2231 iterator. Note that in this case the current entry is deleted from the hash
2232 with your iterator holding the last reference to it. Your iterator is flagged
2233 to free the entry on the next call to C<hv_iternext>, so you must not discard
2234 your iterator immediately else the entry will leak - call C<hv_iternext> to
2235 trigger the resource deallocation.
2237 =for apidoc hv_iternext_flags
2239 Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
2240 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
2241 set the placeholders keys (for restricted hashes) will be returned in addition
2242 to normal keys. By default placeholders are automatically skipped over.
2243 Currently a placeholder is implemented with a value that is
2244 C<&PL_sv_placeholder>. Note that the implementation of placeholders and
2245 restricted hashes may change, and the implementation currently is
2246 insufficiently abstracted for any change to be tidy.
2252 Perl_hv_iternext_flags(pTHX_ HV *hv, I32 flags)
2259 struct xpvhv_aux *iter;
2261 PERL_ARGS_ASSERT_HV_ITERNEXT_FLAGS;
2264 Perl_croak(aTHX_ "Bad hash");
2266 xhv = (XPVHV*)SvANY(hv);
2269 /* Too many things (well, pp_each at least) merrily assume that you can
2270 call hv_iternext without calling hv_iterinit, so we'll have to deal
2276 oldentry = entry = iter->xhv_eiter; /* HvEITER(hv) */
2277 if (SvMAGICAL(hv) && SvRMAGICAL(hv)) {
2278 if ( ( mg = mg_find((const SV *)hv, PERL_MAGIC_tied) ) ) {
2279 SV * const key = sv_newmortal();
2281 sv_setsv(key, HeSVKEY_force(entry));
2282 SvREFCNT_dec(HeSVKEY(entry)); /* get rid of previous key */
2283 HeSVKEY_set(entry, NULL);
2289 /* one HE per MAGICAL hash */
2290 iter->xhv_eiter = entry = new_HE(); /* HvEITER(hv) = new_HE() */
2291 HvLAZYDEL_on(hv); /* make sure entry gets freed */
2293 Newxz(k, HEK_BASESIZE + sizeof(const SV *), char);
2295 HeKEY_hek(entry) = hek;
2296 HeKLEN(entry) = HEf_SVKEY;
2298 magic_nextpack(MUTABLE_SV(hv),mg,key);
2300 /* force key to stay around until next time */
2301 HeSVKEY_set(entry, SvREFCNT_inc_simple_NN(key));
2302 return entry; /* beware, hent_val is not set */
2304 SvREFCNT_dec(HeVAL(entry));
2305 Safefree(HeKEY_hek(entry));
2307 iter->xhv_eiter = NULL; /* HvEITER(hv) = NULL */
2312 #if defined(DYNAMIC_ENV_FETCH) && !defined(__riscos__) /* set up %ENV for iteration */
2313 if (!entry && SvRMAGICAL((const SV *)hv)
2314 && mg_find((const SV *)hv, PERL_MAGIC_env)) {
2317 /* The prime_env_iter() on VMS just loaded up new hash values
2318 * so the iteration count needs to be reset back to the beginning
2322 oldentry = entry = iter->xhv_eiter; /* HvEITER(hv) */
2327 /* hv_iterinit now ensures this. */
2328 assert (HvARRAY(hv));
2330 /* At start of hash, entry is NULL. */
2333 entry = HeNEXT(entry);
2334 if (!(flags & HV_ITERNEXT_WANTPLACEHOLDERS)) {
2336 * Skip past any placeholders -- don't want to include them in
2339 while (entry && HeVAL(entry) == &PL_sv_placeholder) {
2340 entry = HeNEXT(entry);
2345 /* Skip the entire loop if the hash is empty. */
2346 if ((flags & HV_ITERNEXT_WANTPLACEHOLDERS)
2347 ? HvTOTALKEYS(hv) : HvUSEDKEYS(hv)) {
2349 /* OK. Come to the end of the current list. Grab the next one. */
2351 iter->xhv_riter++; /* HvRITER(hv)++ */
2352 if (iter->xhv_riter > (I32)xhv->xhv_max /* HvRITER(hv) > HvMAX(hv) */) {
2353 /* There is no next one. End of the hash. */
2354 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
2357 entry = (HvARRAY(hv))[iter->xhv_riter];
2359 if (!(flags & HV_ITERNEXT_WANTPLACEHOLDERS)) {
2360 /* If we have an entry, but it's a placeholder, don't count it.
2362 while (entry && HeVAL(entry) == &PL_sv_placeholder)
2363 entry = HeNEXT(entry);
2365 /* Will loop again if this linked list starts NULL
2366 (for HV_ITERNEXT_WANTPLACEHOLDERS)
2367 or if we run through it and find only placeholders. */
2370 else iter->xhv_riter = -1;
2372 if (oldentry && HvLAZYDEL(hv)) { /* was deleted earlier? */
2374 hv_free_ent(hv, oldentry);
2377 iter->xhv_eiter = entry; /* HvEITER(hv) = entry */
2382 =for apidoc hv_iterkey
2384 Returns the key from the current position of the hash iterator. See
2391 Perl_hv_iterkey(pTHX_ HE *entry, I32 *retlen)
2393 PERL_ARGS_ASSERT_HV_ITERKEY;
2395 if (HeKLEN(entry) == HEf_SVKEY) {
2397 char * const p = SvPV(HeKEY_sv(entry), len);
2402 *retlen = HeKLEN(entry);
2403 return HeKEY(entry);
2407 /* unlike hv_iterval(), this always returns a mortal copy of the key */
2409 =for apidoc hv_iterkeysv
2411 Returns the key as an C<SV*> from the current position of the hash
2412 iterator. The return value will always be a mortal copy of the key. Also
2419 Perl_hv_iterkeysv(pTHX_ HE *entry)
2421 PERL_ARGS_ASSERT_HV_ITERKEYSV;
2423 return sv_2mortal(newSVhek(HeKEY_hek(entry)));
2427 =for apidoc hv_iterval
2429 Returns the value from the current position of the hash iterator. See
2436 Perl_hv_iterval(pTHX_ HV *hv, HE *entry)
2438 PERL_ARGS_ASSERT_HV_ITERVAL;
2440 if (SvRMAGICAL(hv)) {
2441 if (mg_find((const SV *)hv, PERL_MAGIC_tied)) {
2442 SV* const sv = sv_newmortal();
2443 if (HeKLEN(entry) == HEf_SVKEY)
2444 mg_copy(MUTABLE_SV(hv), sv, (char*)HeKEY_sv(entry), HEf_SVKEY);
2446 mg_copy(MUTABLE_SV(hv), sv, HeKEY(entry), HeKLEN(entry));
2450 return HeVAL(entry);
2454 =for apidoc hv_iternextsv
2456 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
2463 Perl_hv_iternextsv(pTHX_ HV *hv, char **key, I32 *retlen)
2465 HE * const he = hv_iternext_flags(hv, 0);
2467 PERL_ARGS_ASSERT_HV_ITERNEXTSV;
2471 *key = hv_iterkey(he, retlen);
2472 return hv_iterval(hv, he);
2479 =for apidoc hv_magic
2481 Adds magic to a hash. See C<sv_magic>.
2486 /* possibly free a shared string if no one has access to it
2487 * len and hash must both be valid for str.
2490 Perl_unsharepvn(pTHX_ const char *str, I32 len, U32 hash)
2492 unshare_hek_or_pvn (NULL, str, len, hash);
2497 Perl_unshare_hek(pTHX_ HEK *hek)
2500 unshare_hek_or_pvn(hek, NULL, 0, 0);
2503 /* possibly free a shared string if no one has access to it
2504 hek if non-NULL takes priority over the other 3, else str, len and hash
2505 are used. If so, len and hash must both be valid for str.
2508 S_unshare_hek_or_pvn(pTHX_ const HEK *hek, const char *str, I32 len, U32 hash)
2514 bool is_utf8 = FALSE;
2516 const char * const save = str;
2517 struct shared_he *he = NULL;
2520 /* Find the shared he which is just before us in memory. */
2521 he = (struct shared_he *)(((char *)hek)
2522 - STRUCT_OFFSET(struct shared_he,
2525 /* Assert that the caller passed us a genuine (or at least consistent)
2527 assert (he->shared_he_he.hent_hek == hek);
2529 if (he->shared_he_he.he_valu.hent_refcount - 1) {
2530 --he->shared_he_he.he_valu.hent_refcount;
2534 hash = HEK_HASH(hek);
2535 } else if (len < 0) {
2536 STRLEN tmplen = -len;
2538 /* See the note in hv_fetch(). --jhi */
2539 str = (char*)bytes_from_utf8((U8*)str, &tmplen, &is_utf8);
2542 k_flags = HVhek_UTF8;
2544 k_flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
2547 /* what follows was the moral equivalent of:
2548 if ((Svp = hv_fetch(PL_strtab, tmpsv, FALSE, hash))) {
2550 hv_delete(PL_strtab, str, len, G_DISCARD, hash);
2552 xhv = (XPVHV*)SvANY(PL_strtab);
2553 /* assert(xhv_array != 0) */
2554 oentry = &(HvARRAY(PL_strtab))[hash & (I32) HvMAX(PL_strtab)];
2556 const HE *const he_he = &(he->shared_he_he);
2557 for (entry = *oentry; entry; oentry = &HeNEXT(entry), entry = *oentry) {
2562 const int flags_masked = k_flags & HVhek_MASK;
2563 for (entry = *oentry; entry; oentry = &HeNEXT(entry), entry = *oentry) {
2564 if (HeHASH(entry) != hash) /* strings can't be equal */
2566 if (HeKLEN(entry) != len)
2568 if (HeKEY(entry) != str && memNE(HeKEY(entry),str,len)) /* is this it? */
2570 if (HeKFLAGS(entry) != flags_masked)
2577 if (--entry->he_valu.hent_refcount == 0) {
2578 *oentry = HeNEXT(entry);
2580 xhv->xhv_keys--; /* HvTOTALKEYS(hv)-- */
2585 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
2586 "Attempt to free nonexistent shared string '%s'%s"
2588 hek ? HEK_KEY(hek) : str,
2589 ((k_flags & HVhek_UTF8) ? " (utf8)" : "") pTHX__VALUE);
2590 if (k_flags & HVhek_FREEKEY)
2594 /* get a (constant) string ptr from the global string table
2595 * string will get added if it is not already there.
2596 * len and hash must both be valid for str.
2599 Perl_share_hek(pTHX_ const char *str, I32 len, U32 hash)
2601 bool is_utf8 = FALSE;
2603 const char * const save = str;
2605 PERL_ARGS_ASSERT_SHARE_HEK;
2608 STRLEN tmplen = -len;
2610 /* See the note in hv_fetch(). --jhi */
2611 str = (char*)bytes_from_utf8((U8*)str, &tmplen, &is_utf8);
2613 /* If we were able to downgrade here, then than means that we were passed
2614 in a key which only had chars 0-255, but was utf8 encoded. */
2617 /* If we found we were able to downgrade the string to bytes, then
2618 we should flag that it needs upgrading on keys or each. Also flag
2619 that we need share_hek_flags to free the string. */
2622 PERL_HASH(hash, str, len);
2623 flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
2627 return share_hek_flags (str, len, hash, flags);
2631 S_share_hek_flags(pTHX_ const char *str, I32 len, U32 hash, int flags)
2635 const int flags_masked = flags & HVhek_MASK;
2636 const U32 hindex = hash & (I32) HvMAX(PL_strtab);
2637 XPVHV * const xhv = (XPVHV*)SvANY(PL_strtab);
2639 PERL_ARGS_ASSERT_SHARE_HEK_FLAGS;
2641 /* what follows is the moral equivalent of:
2643 if (!(Svp = hv_fetch(PL_strtab, str, len, FALSE)))
2644 hv_store(PL_strtab, str, len, NULL, hash);
2646 Can't rehash the shared string table, so not sure if it's worth
2647 counting the number of entries in the linked list
2650 /* assert(xhv_array != 0) */
2651 entry = (HvARRAY(PL_strtab))[hindex];
2652 for (;entry; entry = HeNEXT(entry)) {
2653 if (HeHASH(entry) != hash) /* strings can't be equal */
2655 if (HeKLEN(entry) != len)
2657 if (HeKEY(entry) != str && memNE(HeKEY(entry),str,len)) /* is this it? */
2659 if (HeKFLAGS(entry) != flags_masked)
2665 /* What used to be head of the list.
2666 If this is NULL, then we're the first entry for this slot, which
2667 means we need to increate fill. */
2668 struct shared_he *new_entry;
2671 HE **const head = &HvARRAY(PL_strtab)[hindex];
2672 HE *const next = *head;
2674 /* We don't actually store a HE from the arena and a regular HEK.
2675 Instead we allocate one chunk of memory big enough for both,
2676 and put the HEK straight after the HE. This way we can find the
2677 HE directly from the HEK.
2680 Newx(k, STRUCT_OFFSET(struct shared_he,
2681 shared_he_hek.hek_key[0]) + len + 2, char);
2682 new_entry = (struct shared_he *)k;
2683 entry = &(new_entry->shared_he_he);
2684 hek = &(new_entry->shared_he_hek);
2686 Copy(str, HEK_KEY(hek), len, char);
2687 HEK_KEY(hek)[len] = 0;
2689 HEK_HASH(hek) = hash;
2690 HEK_FLAGS(hek) = (unsigned char)flags_masked;
2692 /* Still "point" to the HEK, so that other code need not know what
2694 HeKEY_hek(entry) = hek;
2695 entry->he_valu.hent_refcount = 0;
2696 HeNEXT(entry) = next;
2699 xhv->xhv_keys++; /* HvTOTALKEYS(hv)++ */
2700 if (!next) { /* initial entry? */
2701 } else if ( DO_HSPLIT(xhv) ) {
2706 ++entry->he_valu.hent_refcount;
2708 if (flags & HVhek_FREEKEY)
2711 return HeKEY_hek(entry);
2715 Perl_hv_placeholders_p(pTHX_ HV *hv)
2718 MAGIC *mg = mg_find((const SV *)hv, PERL_MAGIC_rhash);
2720 PERL_ARGS_ASSERT_HV_PLACEHOLDERS_P;
2723 mg = sv_magicext(MUTABLE_SV(hv), 0, PERL_MAGIC_rhash, 0, 0, 0);
2726 Perl_die(aTHX_ "panic: hv_placeholders_p");
2729 return &(mg->mg_len);
2734 Perl_hv_placeholders_get(pTHX_ const HV *hv)
2737 MAGIC * const mg = mg_find((const SV *)hv, PERL_MAGIC_rhash);
2739 PERL_ARGS_ASSERT_HV_PLACEHOLDERS_GET;
2741 return mg ? mg->mg_len : 0;
2745 Perl_hv_placeholders_set(pTHX_ HV *hv, I32 ph)
2748 MAGIC * const mg = mg_find((const SV *)hv, PERL_MAGIC_rhash);
2750 PERL_ARGS_ASSERT_HV_PLACEHOLDERS_SET;
2755 if (!sv_magicext(MUTABLE_SV(hv), 0, PERL_MAGIC_rhash, 0, 0, ph))
2756 Perl_die(aTHX_ "panic: hv_placeholders_set");
2758 /* else we don't need to add magic to record 0 placeholders. */
2762 S_refcounted_he_value(pTHX_ const struct refcounted_he *he)
2767 PERL_ARGS_ASSERT_REFCOUNTED_HE_VALUE;
2769 switch(he->refcounted_he_data[0] & HVrhek_typemask) {
2774 value = &PL_sv_placeholder;
2777 value = newSViv(he->refcounted_he_val.refcounted_he_u_iv);
2780 value = newSVuv(he->refcounted_he_val.refcounted_he_u_uv);
2783 case HVrhek_PV_UTF8:
2784 /* Create a string SV that directly points to the bytes in our
2786 value = newSV_type(SVt_PV);
2787 SvPV_set(value, (char *) he->refcounted_he_data + 1);
2788 SvCUR_set(value, he->refcounted_he_val.refcounted_he_u_len);
2789 /* This stops anything trying to free it */
2790 SvLEN_set(value, 0);
2792 SvREADONLY_on(value);
2793 if ((he->refcounted_he_data[0] & HVrhek_typemask) == HVrhek_PV_UTF8)
2797 Perl_croak(aTHX_ "panic: refcounted_he_value bad flags %"UVxf,
2798 (UV)he->refcounted_he_data[0]);
2804 =for apidoc m|HV *|refcounted_he_chain_2hv|const struct refcounted_he *c|U32 flags
2806 Generates and returns a C<HV *> representing the content of a
2807 C<refcounted_he> chain.
2808 I<flags> is currently unused and must be zero.
2813 Perl_refcounted_he_chain_2hv(pTHX_ const struct refcounted_he *chain, U32 flags)
2817 U32 placeholders, max;
2820 Perl_croak(aTHX_ "panic: refcounted_he_chain_2hv bad flags %"UVxf,
2823 /* We could chase the chain once to get an idea of the number of keys,
2824 and call ksplit. But for now we'll make a potentially inefficient
2825 hash with only 8 entries in its array. */
2830 Newxz(array, PERL_HV_ARRAY_ALLOC_BYTES(max + 1), char);
2831 HvARRAY(hv) = (HE**)array;
2837 U32 hash = chain->refcounted_he_hash;
2839 U32 hash = HEK_HASH(chain->refcounted_he_hek);
2841 HE **oentry = &((HvARRAY(hv))[hash & max]);
2842 HE *entry = *oentry;
2845 for (; entry; entry = HeNEXT(entry)) {
2846 if (HeHASH(entry) == hash) {
2847 /* We might have a duplicate key here. If so, entry is older
2848 than the key we've already put in the hash, so if they are
2849 the same, skip adding entry. */
2851 const STRLEN klen = HeKLEN(entry);
2852 const char *const key = HeKEY(entry);
2853 if (klen == chain->refcounted_he_keylen
2854 && (!!HeKUTF8(entry)
2855 == !!(chain->refcounted_he_data[0] & HVhek_UTF8))
2856 && memEQ(key, REF_HE_KEY(chain), klen))
2859 if (HeKEY_hek(entry) == chain->refcounted_he_hek)
2861 if (HeKLEN(entry) == HEK_LEN(chain->refcounted_he_hek)
2862 && HeKUTF8(entry) == HEK_UTF8(chain->refcounted_he_hek)
2863 && memEQ(HeKEY(entry), HEK_KEY(chain->refcounted_he_hek),
2874 = share_hek_flags(REF_HE_KEY(chain),
2875 chain->refcounted_he_keylen,
2876 chain->refcounted_he_hash,
2877 (chain->refcounted_he_data[0]
2878 & (HVhek_UTF8|HVhek_WASUTF8)));
2880 HeKEY_hek(entry) = share_hek_hek(chain->refcounted_he_hek);
2882 value = refcounted_he_value(chain);
2883 if (value == &PL_sv_placeholder)
2885 HeVAL(entry) = value;
2887 /* Link it into the chain. */
2888 HeNEXT(entry) = *oentry;
2894 chain = chain->refcounted_he_next;
2898 clear_placeholders(hv, placeholders);
2899 HvTOTALKEYS(hv) -= placeholders;
2902 /* We could check in the loop to see if we encounter any keys with key
2903 flags, but it's probably not worth it, as this per-hash flag is only
2904 really meant as an optimisation for things like Storable. */
2906 DEBUG_A(Perl_hv_assert(aTHX_ hv));
2912 =for apidoc m|SV *|refcounted_he_fetch_pvn|const struct refcounted_he *chain|const char *keypv|STRLEN keylen|U32 hash|U32 flags
2914 Search along a C<refcounted_he> chain for an entry with the key specified
2915 by I<keypv> and I<keylen>. If I<flags> has the C<REFCOUNTED_HE_KEY_UTF8>
2916 bit set, the key octets are interpreted as UTF-8, otherwise they
2917 are interpreted as Latin-1. I<hash> is a precomputed hash of the key
2918 string, or zero if it has not been precomputed. Returns a mortal scalar
2919 representing the value associated with the key, or C<&PL_sv_placeholder>
2920 if there is no value associated with the key.
2926 Perl_refcounted_he_fetch_pvn(pTHX_ const struct refcounted_he *chain,
2927 const char *keypv, STRLEN keylen, U32 hash, U32 flags)
2931 PERL_ARGS_ASSERT_REFCOUNTED_HE_FETCH_PVN;
2933 if (flags & ~(REFCOUNTED_HE_KEY_UTF8|REFCOUNTED_HE_EXISTS))
2934 Perl_croak(aTHX_ "panic: refcounted_he_fetch_pvn bad flags %"UVxf,
2937 return &PL_sv_placeholder;
2938 if (flags & REFCOUNTED_HE_KEY_UTF8) {
2939 /* For searching purposes, canonicalise to Latin-1 where possible. */
2940 const char *keyend = keypv + keylen, *p;
2941 STRLEN nonascii_count = 0;
2942 for (p = keypv; p != keyend; p++) {
2945 if (!((c & 0xfe) == 0xc2 && ++p != keyend &&
2946 (((U8)*p) & 0xc0) == 0x80))
2947 goto canonicalised_key;
2951 if (nonascii_count) {
2953 const char *p = keypv, *keyend = keypv + keylen;
2954 keylen -= nonascii_count;
2955 Newx(q, keylen, char);
2958 for (; p != keyend; p++, q++) {
2961 ((c & 0x80) ? ((c & 0x03) << 6) | (((U8)*++p) & 0x3f) : c);
2964 flags &= ~REFCOUNTED_HE_KEY_UTF8;
2965 canonicalised_key: ;
2967 utf8_flag = (flags & REFCOUNTED_HE_KEY_UTF8) ? HVhek_UTF8 : 0;
2969 PERL_HASH(hash, keypv, keylen);
2971 for (; chain; chain = chain->refcounted_he_next) {
2974 hash == chain->refcounted_he_hash &&
2975 keylen == chain->refcounted_he_keylen &&
2976 memEQ(REF_HE_KEY(chain), keypv, keylen) &&
2977 utf8_flag == (chain->refcounted_he_data[0] & HVhek_UTF8)
2979 hash == HEK_HASH(chain->refcounted_he_hek) &&
2980 keylen == (STRLEN)HEK_LEN(chain->refcounted_he_hek) &&
2981 memEQ(HEK_KEY(chain->refcounted_he_hek), keypv, keylen) &&
2982 utf8_flag == (HEK_FLAGS(chain->refcounted_he_hek) & HVhek_UTF8)
2985 if (flags & REFCOUNTED_HE_EXISTS)
2986 return (chain->refcounted_he_data[0] & HVrhek_typemask)
2988 ? NULL : &PL_sv_yes;
2989 return sv_2mortal(refcounted_he_value(chain));
2992 return flags & REFCOUNTED_HE_EXISTS ? NULL : &PL_sv_placeholder;
2996 =for apidoc m|SV *|refcounted_he_fetch_pv|const struct refcounted_he *chain|const char *key|U32 hash|U32 flags
2998 Like L</refcounted_he_fetch_pvn>, but takes a nul-terminated string
2999 instead of a string/length pair.
3005 Perl_refcounted_he_fetch_pv(pTHX_ const struct refcounted_he *chain,
3006 const char *key, U32 hash, U32 flags)
3008 PERL_ARGS_ASSERT_REFCOUNTED_HE_FETCH_PV;
3009 return refcounted_he_fetch_pvn(chain, key, strlen(key), hash, flags);
3013 =for apidoc m|SV *|refcounted_he_fetch_sv|const struct refcounted_he *chain|SV *key|U32 hash|U32 flags
3015 Like L</refcounted_he_fetch_pvn>, but takes a Perl scalar instead of a
3022 Perl_refcounted_he_fetch_sv(pTHX_ const struct refcounted_he *chain,
3023 SV *key, U32 hash, U32 flags)
3027 PERL_ARGS_ASSERT_REFCOUNTED_HE_FETCH_SV;
3028 if (flags & REFCOUNTED_HE_KEY_UTF8)
3029 Perl_croak(aTHX_ "panic: refcounted_he_fetch_sv bad flags %"UVxf,
3031 keypv = SvPV_const(key, keylen);
3033 flags |= REFCOUNTED_HE_KEY_UTF8;
3034 if (!hash && SvIsCOW_shared_hash(key))
3035 hash = SvSHARED_HASH(key);
3036 return refcounted_he_fetch_pvn(chain, keypv, keylen, hash, flags);
3040 =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
3042 Creates a new C<refcounted_he>. This consists of a single key/value
3043 pair and a reference to an existing C<refcounted_he> chain (which may
3044 be empty), and thus forms a longer chain. When using the longer chain,
3045 the new key/value pair takes precedence over any entry for the same key
3046 further along the chain.
3048 The new key is specified by I<keypv> and I<keylen>. If I<flags> has
3049 the C<REFCOUNTED_HE_KEY_UTF8> bit set, the key octets are interpreted
3050 as UTF-8, otherwise they are interpreted as Latin-1. I<hash> is
3051 a precomputed hash of the key string, or zero if it has not been
3054 I<value> is the scalar value to store for this key. I<value> is copied
3055 by this function, which thus does not take ownership of any reference
3056 to it, and later changes to the scalar will not be reflected in the
3057 value visible in the C<refcounted_he>. Complex types of scalar will not
3058 be stored with referential integrity, but will be coerced to strings.
3059 I<value> may be either null or C<&PL_sv_placeholder> to indicate that no
3060 value is to be associated with the key; this, as with any non-null value,
3061 takes precedence over the existence of a value for the key further along
3064 I<parent> points to the rest of the C<refcounted_he> chain to be
3065 attached to the new C<refcounted_he>. This function takes ownership
3066 of one reference to I<parent>, and returns one reference to the new
3072 struct refcounted_he *
3073 Perl_refcounted_he_new_pvn(pTHX_ struct refcounted_he *parent,
3074 const char *keypv, STRLEN keylen, U32 hash, SV *value, U32 flags)
3077 STRLEN value_len = 0;
3078 const char *value_p = NULL;
3082 STRLEN key_offset = 1;
3083 struct refcounted_he *he;
3084 PERL_ARGS_ASSERT_REFCOUNTED_HE_NEW_PVN;
3086 if (!value || value == &PL_sv_placeholder) {
3087 value_type = HVrhek_delete;
3088 } else if (SvPOK(value)) {
3089 value_type = HVrhek_PV;
3090 } else if (SvIOK(value)) {
3091 value_type = SvUOK((const SV *)value) ? HVrhek_UV : HVrhek_IV;
3092 } else if (!SvOK(value)) {
3093 value_type = HVrhek_undef;
3095 value_type = HVrhek_PV;
3097 is_pv = value_type == HVrhek_PV;
3099 /* Do it this way so that the SvUTF8() test is after the SvPV, in case
3100 the value is overloaded, and doesn't yet have the UTF-8flag set. */
3101 value_p = SvPV_const(value, value_len);
3103 value_type = HVrhek_PV_UTF8;
3104 key_offset = value_len + 2;
3106 hekflags = value_type;
3108 if (flags & REFCOUNTED_HE_KEY_UTF8) {
3109 /* Canonicalise to Latin-1 where possible. */
3110 const char *keyend = keypv + keylen, *p;
3111 STRLEN nonascii_count = 0;
3112 for (p = keypv; p != keyend; p++) {
3115 if (!((c & 0xfe) == 0xc2 && ++p != keyend &&
3116 (((U8)*p) & 0xc0) == 0x80))
3117 goto canonicalised_key;
3121 if (nonascii_count) {
3123 const char *p = keypv, *keyend = keypv + keylen;
3124 keylen -= nonascii_count;
3125 Newx(q, keylen, char);
3128 for (; p != keyend; p++, q++) {
3131 ((c & 0x80) ? ((c & 0x03) << 6) | (((U8)*++p) & 0x3f) : c);
3134 flags &= ~REFCOUNTED_HE_KEY_UTF8;
3135 canonicalised_key: ;
3137 if (flags & REFCOUNTED_HE_KEY_UTF8)
3138 hekflags |= HVhek_UTF8;
3140 PERL_HASH(hash, keypv, keylen);
3143 he = (struct refcounted_he*)
3144 PerlMemShared_malloc(sizeof(struct refcounted_he) - 1
3148 he = (struct refcounted_he*)
3149 PerlMemShared_malloc(sizeof(struct refcounted_he) - 1
3153 he->refcounted_he_next = parent;
3156 Copy(value_p, he->refcounted_he_data + 1, value_len + 1, char);
3157 he->refcounted_he_val.refcounted_he_u_len = value_len;
3158 } else if (value_type == HVrhek_IV) {
3159 he->refcounted_he_val.refcounted_he_u_iv = SvIVX(value);
3160 } else if (value_type == HVrhek_UV) {
3161 he->refcounted_he_val.refcounted_he_u_uv = SvUVX(value);
3165 he->refcounted_he_hash = hash;
3166 he->refcounted_he_keylen = keylen;
3167 Copy(keypv, he->refcounted_he_data + key_offset, keylen, char);
3169 he->refcounted_he_hek = share_hek_flags(keypv, keylen, hash, hekflags);
3172 he->refcounted_he_data[0] = hekflags;
3173 he->refcounted_he_refcnt = 1;
3179 =for apidoc m|struct refcounted_he *|refcounted_he_new_pv|struct refcounted_he *parent|const char *key|U32 hash|SV *value|U32 flags
3181 Like L</refcounted_he_new_pvn>, but takes a nul-terminated string instead
3182 of a string/length pair.
3187 struct refcounted_he *
3188 Perl_refcounted_he_new_pv(pTHX_ struct refcounted_he *parent,
3189 const char *key, U32 hash, SV *value, U32 flags)
3191 PERL_ARGS_ASSERT_REFCOUNTED_HE_NEW_PV;
3192 return refcounted_he_new_pvn(parent, key, strlen(key), hash, value, flags);
3196 =for apidoc m|struct refcounted_he *|refcounted_he_new_sv|struct refcounted_he *parent|SV *key|U32 hash|SV *value|U32 flags
3198 Like L</refcounted_he_new_pvn>, but takes a Perl scalar instead of a
3204 struct refcounted_he *
3205 Perl_refcounted_he_new_sv(pTHX_ struct refcounted_he *parent,
3206 SV *key, U32 hash, SV *value, U32 flags)
3210 PERL_ARGS_ASSERT_REFCOUNTED_HE_NEW_SV;
3211 if (flags & REFCOUNTED_HE_KEY_UTF8)
3212 Perl_croak(aTHX_ "panic: refcounted_he_new_sv bad flags %"UVxf,
3214 keypv = SvPV_const(key, keylen);
3216 flags |= REFCOUNTED_HE_KEY_UTF8;
3217 if (!hash && SvIsCOW_shared_hash(key))
3218 hash = SvSHARED_HASH(key);
3219 return refcounted_he_new_pvn(parent, keypv, keylen, hash, value, flags);
3223 =for apidoc m|void|refcounted_he_free|struct refcounted_he *he
3225 Decrements the reference count of a C<refcounted_he> by one. If the
3226 reference count reaches zero the structure's memory is freed, which
3227 (recursively) causes a reduction of its parent C<refcounted_he>'s
3228 reference count. It is safe to pass a null pointer to this function:
3229 no action occurs in this case.
3235 Perl_refcounted_he_free(pTHX_ struct refcounted_he *he) {
3237 PERL_UNUSED_CONTEXT;
3240 struct refcounted_he *copy;
3244 new_count = --he->refcounted_he_refcnt;
3245 HINTS_REFCNT_UNLOCK;
3251 #ifndef USE_ITHREADS
3252 unshare_hek_or_pvn (he->refcounted_he_hek, 0, 0, 0);
3255 he = he->refcounted_he_next;
3256 PerlMemShared_free(copy);
3261 =for apidoc m|struct refcounted_he *|refcounted_he_inc|struct refcounted_he *he
3263 Increment the reference count of a C<refcounted_he>. The pointer to the
3264 C<refcounted_he> is also returned. It is safe to pass a null pointer
3265 to this function: no action occurs and a null pointer is returned.
3270 struct refcounted_he *
3271 Perl_refcounted_he_inc(pTHX_ struct refcounted_he *he)
3276 he->refcounted_he_refcnt++;
3277 HINTS_REFCNT_UNLOCK;
3283 =for apidoc cop_fetch_label
3285 Returns the label attached to a cop.
3286 The flags pointer may be set to C<SVf_UTF8> or 0.
3291 /* pp_entereval is aware that labels are stored with a key ':' at the top of
3294 Perl_cop_fetch_label(pTHX_ COP *const cop, STRLEN *len, U32 *flags) {
3295 struct refcounted_he *const chain = cop->cop_hints_hash;
3297 PERL_ARGS_ASSERT_COP_FETCH_LABEL;
3302 if (chain->refcounted_he_keylen != 1)
3304 if (*REF_HE_KEY(chain) != ':')
3307 if ((STRLEN)HEK_LEN(chain->refcounted_he_hek) != 1)
3309 if (*HEK_KEY(chain->refcounted_he_hek) != ':')
3312 /* Stop anyone trying to really mess us up by adding their own value for
3314 if ((chain->refcounted_he_data[0] & HVrhek_typemask) != HVrhek_PV
3315 && (chain->refcounted_he_data[0] & HVrhek_typemask) != HVrhek_PV_UTF8)
3319 *len = chain->refcounted_he_val.refcounted_he_u_len;
3321 *flags = ((chain->refcounted_he_data[0] & HVrhek_typemask)
3322 == HVrhek_PV_UTF8) ? SVf_UTF8 : 0;
3324 return chain->refcounted_he_data + 1;
3328 =for apidoc cop_store_label
3330 Save a label into a C<cop_hints_hash>. You need to set flags to C<SVf_UTF8>
3337 Perl_cop_store_label(pTHX_ COP *const cop, const char *label, STRLEN len,
3341 PERL_ARGS_ASSERT_COP_STORE_LABEL;
3343 if (flags & ~(SVf_UTF8))
3344 Perl_croak(aTHX_ "panic: cop_store_label illegal flag bits 0x%" UVxf,
3346 labelsv = newSVpvn_flags(label, len, SVs_TEMP);
3347 if (flags & SVf_UTF8)
3350 = refcounted_he_new_pvs(cop->cop_hints_hash, ":", labelsv, 0);
3354 =for apidoc hv_assert
3356 Check that a hash is in an internally consistent state.
3364 Perl_hv_assert(pTHX_ HV *hv)
3369 int placeholders = 0;
3372 const I32 riter = HvRITER_get(hv);
3373 HE *eiter = HvEITER_get(hv);
3375 PERL_ARGS_ASSERT_HV_ASSERT;
3377 (void)hv_iterinit(hv);
3379 while ((entry = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS))) {
3380 /* sanity check the values */
3381 if (HeVAL(entry) == &PL_sv_placeholder)
3385 /* sanity check the keys */
3386 if (HeSVKEY(entry)) {
3387 NOOP; /* Don't know what to check on SV keys. */
3388 } else if (HeKUTF8(entry)) {
3390 if (HeKWASUTF8(entry)) {
3391 PerlIO_printf(Perl_debug_log,
3392 "hash key has both WASUTF8 and UTF8: '%.*s'\n",
3393 (int) HeKLEN(entry), HeKEY(entry));
3396 } else if (HeKWASUTF8(entry))
3399 if (!SvTIED_mg((const SV *)hv, PERL_MAGIC_tied)) {
3400 static const char bad_count[] = "Count %d %s(s), but hash reports %d\n";
3401 const int nhashkeys = HvUSEDKEYS(hv);
3402 const int nhashplaceholders = HvPLACEHOLDERS_get(hv);
3404 if (nhashkeys != real) {
3405 PerlIO_printf(Perl_debug_log, bad_count, real, "keys", nhashkeys );
3408 if (nhashplaceholders != placeholders) {
3409 PerlIO_printf(Perl_debug_log, bad_count, placeholders, "placeholder", nhashplaceholders );
3413 if (withflags && ! HvHASKFLAGS(hv)) {
3414 PerlIO_printf(Perl_debug_log,
3415 "Hash has HASKFLAGS off but I count %d key(s) with flags\n",
3420 sv_dump(MUTABLE_SV(hv));
3422 HvRITER_set(hv, riter); /* Restore hash iterator state */
3423 HvEITER_set(hv, eiter);
3430 * c-indentation-style: bsd
3432 * indent-tabs-mode: nil
3435 * ex: set ts=8 sts=4 sw=4 et: