This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
remove 'hfreeentries failed to free hash' panic
[perl5.git] / hv.c
1 /*    hv.c
2  *
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
5  *
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.
8  *
9  */
10
11 /*
12  *      I sit beside the fire and think
13  *          of all that I have seen.
14  *                         --Bilbo
15  *
16  *     [p.278 of _The Lord of the Rings_, II/iii: "The Ring Goes South"]
17  */
18
19 /* 
20 =head1 Hash Manipulation Functions
21
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.
28
29 =cut
30
31 */
32
33 #include "EXTERN.h"
34 #define PERL_IN_HV_C
35 #define PERL_HASH_INTERNAL_ACCESS
36 #include "perl.h"
37
38 #define HV_MAX_LENGTH_BEFORE_SPLIT 14
39
40 static const char S_strtab_error[]
41     = "Cannot modify shared string table in hv_%s";
42
43 #ifdef PURIFY
44
45 #define new_HE() (HE*)safemalloc(sizeof(HE))
46 #define del_HE(p) safefree((char*)p)
47
48 #else
49
50 STATIC HE*
51 S_new_he(pTHX)
52 {
53     dVAR;
54     HE* he;
55     void ** const root = &PL_body_roots[HE_SVSLOT];
56
57     if (!*root)
58         Perl_more_bodies(aTHX_ HE_SVSLOT, sizeof(HE), PERL_ARENA_SIZE);
59     he = (HE*) *root;
60     assert(he);
61     *root = HeNEXT(he);
62     return he;
63 }
64
65 #define new_HE() new_he()
66 #define del_HE(p) \
67     STMT_START { \
68         HeNEXT(p) = (HE*)(PL_body_roots[HE_SVSLOT]);    \
69         PL_body_roots[HE_SVSLOT] = p; \
70     } STMT_END
71
72
73
74 #endif
75
76 STATIC HEK *
77 S_save_hek_flags(const char *str, I32 len, U32 hash, int flags)
78 {
79     const int flags_masked = flags & HVhek_MASK;
80     char *k;
81     register HEK *hek;
82
83     PERL_ARGS_ASSERT_SAVE_HEK_FLAGS;
84
85     Newx(k, HEK_BASESIZE + len + 2, char);
86     hek = (HEK*)k;
87     Copy(str, HEK_KEY(hek), len, char);
88     HEK_KEY(hek)[len] = 0;
89     HEK_LEN(hek) = len;
90     HEK_HASH(hek) = hash;
91     HEK_FLAGS(hek) = (unsigned char)flags_masked | HVhek_UNSHARED;
92
93     if (flags & HVhek_FREEKEY)
94         Safefree(str);
95     return hek;
96 }
97
98 /* free the pool of temporary HE/HEK pairs returned by hv_fetch_ent
99  * for tied hashes */
100
101 void
102 Perl_free_tied_hv_pool(pTHX)
103 {
104     dVAR;
105     HE *he = PL_hv_fetch_ent_mh;
106     while (he) {
107         HE * const ohe = he;
108         Safefree(HeKEY_hek(he));
109         he = HeNEXT(he);
110         del_HE(ohe);
111     }
112     PL_hv_fetch_ent_mh = NULL;
113 }
114
115 #if defined(USE_ITHREADS)
116 HEK *
117 Perl_hek_dup(pTHX_ HEK *source, CLONE_PARAMS* param)
118 {
119     HEK *shared;
120
121     PERL_ARGS_ASSERT_HEK_DUP;
122     PERL_UNUSED_ARG(param);
123
124     if (!source)
125         return NULL;
126
127     shared = (HEK*)ptr_table_fetch(PL_ptr_table, source);
128     if (shared) {
129         /* We already shared this hash key.  */
130         (void)share_hek_hek(shared);
131     }
132     else {
133         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);
137     }
138     return shared;
139 }
140
141 HE *
142 Perl_he_dup(pTHX_ const HE *e, bool shared, CLONE_PARAMS* param)
143 {
144     HE *ret;
145
146     PERL_ARGS_ASSERT_HE_DUP;
147
148     if (!e)
149         return NULL;
150     /* look for it in the table first */
151     ret = (HE*)ptr_table_fetch(PL_ptr_table, e);
152     if (ret)
153         return ret;
154
155     /* create anew and remember what it is */
156     ret = new_HE();
157     ptr_table_store(PL_ptr_table, e, ret);
158
159     HeNEXT(ret) = he_dup(HeNEXT(e),shared, param);
160     if (HeKLEN(e) == HEf_SVKEY) {
161         char *k;
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);
165     }
166     else if (shared) {
167         /* This is hek_dup inlined, which seems to be important for speed
168            reasons.  */
169         HEK * const source = HeKEY_hek(e);
170         HEK *shared = (HEK*)ptr_table_fetch(PL_ptr_table, source);
171
172         if (shared) {
173             /* We already shared this hash key.  */
174             (void)share_hek_hek(shared);
175         }
176         else {
177             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);
181         }
182         HeKEY_hek(ret) = shared;
183     }
184     else
185         HeKEY_hek(ret) = save_hek_flags(HeKEY(e), HeKLEN(e), HeHASH(e),
186                                         HeKFLAGS(e));
187     HeVAL(ret) = sv_dup_inc(HeVAL(e), param);
188     return ret;
189 }
190 #endif  /* USE_ITHREADS */
191
192 static void
193 S_hv_notallowed(pTHX_ int flags, const char *key, I32 klen,
194                 const char *msg)
195 {
196     SV * const sv = sv_newmortal();
197
198     PERL_ARGS_ASSERT_HV_NOTALLOWED;
199
200     if (!(flags & HVhek_FREEKEY)) {
201         sv_setpvn(sv, key, klen);
202     }
203     else {
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);
207     }
208     if (flags & HVhek_UTF8) {
209         SvUTF8_on(sv);
210     }
211     Perl_croak(aTHX_ msg, SVfARG(sv));
212 }
213
214 /* (klen == HEf_SVKEY) is special for MAGICAL hv entries, meaning key slot
215  * contains an SV* */
216
217 /*
218 =for apidoc hv_store
219
220 Stores an SV in a hash.  The hash key is specified as C<key> and C<klen> is
221 the length of the key.  The C<hash> parameter is the precomputed hash
222 value; if it is zero then Perl will compute it.  The return value will be
223 NULL if the operation failed or if the value did not need to be actually
224 stored within the hash (as in the case of tied hashes).  Otherwise it can
225 be dereferenced to get the original C<SV*>.  Note that the caller is
226 responsible for suitably incrementing the reference count of C<val> before
227 the call, and decrementing it if the function returned NULL.  Effectively
228 a successful hv_store takes ownership of one reference to C<val>.  This is
229 usually what you want; a newly created SV has a reference count of one, so
230 if all your code does is create SVs then store them in a hash, hv_store
231 will own the only reference to the new SV, and your code doesn't need to do
232 anything further to tidy up.  hv_store is not implemented as a call to
233 hv_store_ent, and does not create a temporary SV for the key, so if your
234 key data is not already in SV form then use hv_store in preference to
235 hv_store_ent.
236
237 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
238 information on how to use this function on tied hashes.
239
240 =for apidoc hv_store_ent
241
242 Stores C<val> in a hash.  The hash key is specified as C<key>.  The C<hash>
243 parameter is the precomputed hash value; if it is zero then Perl will
244 compute it.  The return value is the new hash entry so created.  It will be
245 NULL if the operation failed or if the value did not need to be actually
246 stored within the hash (as in the case of tied hashes).  Otherwise the
247 contents of the return value can be accessed using the C<He?> macros
248 described here.  Note that the caller is responsible for suitably
249 incrementing the reference count of C<val> before the call, and
250 decrementing it if the function returned NULL.  Effectively a successful
251 hv_store_ent takes ownership of one reference to C<val>.  This is
252 usually what you want; a newly created SV has a reference count of one, so
253 if all your code does is create SVs then store them in a hash, hv_store
254 will own the only reference to the new SV, and your code doesn't need to do
255 anything further to tidy up.  Note that hv_store_ent only reads the C<key>;
256 unlike C<val> it does not take ownership of it, so maintaining the correct
257 reference count on C<key> is entirely the caller's responsibility.  hv_store
258 is not implemented as a call to hv_store_ent, and does not create a temporary
259 SV for the key, so if your key data is not already in SV form then use
260 hv_store in preference to hv_store_ent.
261
262 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
263 information on how to use this function on tied hashes.
264
265 =for apidoc hv_exists
266
267 Returns a boolean indicating whether the specified hash key exists.  The
268 C<klen> is the length of the key.
269
270 =for apidoc hv_fetch
271
272 Returns the SV which corresponds to the specified key in the hash.  The
273 C<klen> is the length of the key.  If C<lval> is set then the fetch will be
274 part of a store.  Check that the return value is non-null before
275 dereferencing it to an C<SV*>.
276
277 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
278 information on how to use this function on tied hashes.
279
280 =for apidoc hv_exists_ent
281
282 Returns a boolean indicating whether the specified hash key exists. C<hash>
283 can be a valid precomputed hash value, or 0 to ask for it to be
284 computed.
285
286 =cut
287 */
288
289 /* returns an HE * structure with the all fields set */
290 /* note that hent_val will be a mortal sv for MAGICAL hashes */
291 /*
292 =for apidoc hv_fetch_ent
293
294 Returns the hash entry which corresponds to the specified key in the hash.
295 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
296 if you want the function to compute it.  IF C<lval> is set then the fetch
297 will be part of a store.  Make sure the return value is non-null before
298 accessing it.  The return value when C<hv> is a tied hash is a pointer to a
299 static location, so be sure to make a copy of the structure if you need to
300 store it somewhere.
301
302 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
303 information on how to use this function on tied hashes.
304
305 =cut
306 */
307
308 /* Common code for hv_delete()/hv_exists()/hv_fetch()/hv_store()  */
309 void *
310 Perl_hv_common_key_len(pTHX_ HV *hv, const char *key, I32 klen_i32,
311                        const int action, SV *val, const U32 hash)
312 {
313     STRLEN klen;
314     int flags;
315
316     PERL_ARGS_ASSERT_HV_COMMON_KEY_LEN;
317
318     if (klen_i32 < 0) {
319         klen = -klen_i32;
320         flags = HVhek_UTF8;
321     } else {
322         klen = klen_i32;
323         flags = 0;
324     }
325     return hv_common(hv, NULL, key, klen, flags, action, val, hash);
326 }
327
328 void *
329 Perl_hv_common(pTHX_ HV *hv, SV *keysv, const char *key, STRLEN klen,
330                int flags, int action, SV *val, register U32 hash)
331 {
332     dVAR;
333     XPVHV* xhv;
334     HE *entry;
335     HE **oentry;
336     SV *sv;
337     bool is_utf8;
338     int masked_flags;
339     const int return_svp = action & HV_FETCH_JUST_SV;
340
341     if (!hv)
342         return NULL;
343     if (SvTYPE(hv) == SVTYPEMASK)
344         return NULL;
345
346     assert(SvTYPE(hv) == SVt_PVHV);
347
348     if (SvSMAGICAL(hv) && SvGMAGICAL(hv) && !(action & HV_DISABLE_UVAR_XKEY)) {
349         MAGIC* mg;
350         if ((mg = mg_find((const SV *)hv, PERL_MAGIC_uvar))) {
351             struct ufuncs * const uf = (struct ufuncs *)mg->mg_ptr;
352             if (uf->uf_set == NULL) {
353                 SV* obj = mg->mg_obj;
354
355                 if (!keysv) {
356                     keysv = newSVpvn_flags(key, klen, SVs_TEMP |
357                                            ((flags & HVhek_UTF8)
358                                             ? SVf_UTF8 : 0));
359                 }
360                 
361                 mg->mg_obj = keysv;         /* pass key */
362                 uf->uf_index = action;      /* pass action */
363                 magic_getuvar(MUTABLE_SV(hv), mg);
364                 keysv = mg->mg_obj;         /* may have changed */
365                 mg->mg_obj = obj;
366
367                 /* If the key may have changed, then we need to invalidate
368                    any passed-in computed hash value.  */
369                 hash = 0;
370             }
371         }
372     }
373     if (keysv) {
374         if (flags & HVhek_FREEKEY)
375             Safefree(key);
376         key = SvPV_const(keysv, klen);
377         is_utf8 = (SvUTF8(keysv) != 0);
378         if (SvIsCOW_shared_hash(keysv)) {
379             flags = HVhek_KEYCANONICAL | (is_utf8 ? HVhek_UTF8 : 0);
380         } else {
381             flags = 0;
382         }
383     } else {
384         is_utf8 = ((flags & HVhek_UTF8) ? TRUE : FALSE);
385     }
386
387     if (action & HV_DELETE) {
388         return (void *) hv_delete_common(hv, keysv, key, klen,
389                                          flags | (is_utf8 ? HVhek_UTF8 : 0),
390                                          action, hash);
391     }
392
393     xhv = (XPVHV*)SvANY(hv);
394     if (SvMAGICAL(hv)) {
395         if (SvRMAGICAL(hv) && !(action & (HV_FETCH_ISSTORE|HV_FETCH_ISEXISTS))) {
396             if (mg_find((const SV *)hv, PERL_MAGIC_tied)
397                 || SvGMAGICAL((const SV *)hv))
398             {
399                 /* FIXME should be able to skimp on the HE/HEK here when
400                    HV_FETCH_JUST_SV is true.  */
401                 if (!keysv) {
402                     keysv = newSVpvn_utf8(key, klen, is_utf8);
403                 } else {
404                     keysv = newSVsv(keysv);
405                 }
406                 sv = sv_newmortal();
407                 mg_copy(MUTABLE_SV(hv), sv, (char *)keysv, HEf_SVKEY);
408
409                 /* grab a fake HE/HEK pair from the pool or make a new one */
410                 entry = PL_hv_fetch_ent_mh;
411                 if (entry)
412                     PL_hv_fetch_ent_mh = HeNEXT(entry);
413                 else {
414                     char *k;
415                     entry = new_HE();
416                     Newx(k, HEK_BASESIZE + sizeof(const SV *), char);
417                     HeKEY_hek(entry) = (HEK*)k;
418                 }
419                 HeNEXT(entry) = NULL;
420                 HeSVKEY_set(entry, keysv);
421                 HeVAL(entry) = sv;
422                 sv_upgrade(sv, SVt_PVLV);
423                 LvTYPE(sv) = 'T';
424                  /* so we can free entry when freeing sv */
425                 LvTARG(sv) = MUTABLE_SV(entry);
426
427                 /* XXX remove at some point? */
428                 if (flags & HVhek_FREEKEY)
429                     Safefree(key);
430
431                 if (return_svp) {
432                     return entry ? (void *) &HeVAL(entry) : NULL;
433                 }
434                 return (void *) entry;
435             }
436 #ifdef ENV_IS_CASELESS
437             else if (mg_find((const SV *)hv, PERL_MAGIC_env)) {
438                 U32 i;
439                 for (i = 0; i < klen; ++i)
440                     if (isLOWER(key[i])) {
441                         /* Would be nice if we had a routine to do the
442                            copy and upercase in a single pass through.  */
443                         const char * const nkey = strupr(savepvn(key,klen));
444                         /* Note that this fetch is for nkey (the uppercased
445                            key) whereas the store is for key (the original)  */
446                         void *result = hv_common(hv, NULL, nkey, klen,
447                                                  HVhek_FREEKEY, /* free nkey */
448                                                  0 /* non-LVAL fetch */
449                                                  | HV_DISABLE_UVAR_XKEY
450                                                  | return_svp,
451                                                  NULL /* no value */,
452                                                  0 /* compute hash */);
453                         if (!result && (action & HV_FETCH_LVALUE)) {
454                             /* This call will free key if necessary.
455                                Do it this way to encourage compiler to tail
456                                call optimise.  */
457                             result = hv_common(hv, keysv, key, klen, flags,
458                                                HV_FETCH_ISSTORE
459                                                | HV_DISABLE_UVAR_XKEY
460                                                | return_svp,
461                                                newSV(0), hash);
462                         } else {
463                             if (flags & HVhek_FREEKEY)
464                                 Safefree(key);
465                         }
466                         return result;
467                     }
468             }
469 #endif
470         } /* ISFETCH */
471         else if (SvRMAGICAL(hv) && (action & HV_FETCH_ISEXISTS)) {
472             if (mg_find((const SV *)hv, PERL_MAGIC_tied)
473                 || SvGMAGICAL((const SV *)hv)) {
474                 /* I don't understand why hv_exists_ent has svret and sv,
475                    whereas hv_exists only had one.  */
476                 SV * const svret = sv_newmortal();
477                 sv = sv_newmortal();
478
479                 if (keysv || is_utf8) {
480                     if (!keysv) {
481                         keysv = newSVpvn_utf8(key, klen, TRUE);
482                     } else {
483                         keysv = newSVsv(keysv);
484                     }
485                     mg_copy(MUTABLE_SV(hv), sv, (char *)sv_2mortal(keysv), HEf_SVKEY);
486                 } else {
487                     mg_copy(MUTABLE_SV(hv), sv, key, klen);
488                 }
489                 if (flags & HVhek_FREEKEY)
490                     Safefree(key);
491                 magic_existspack(svret, mg_find(sv, PERL_MAGIC_tiedelem));
492                 /* This cast somewhat evil, but I'm merely using NULL/
493                    not NULL to return the boolean exists.
494                    And I know hv is not NULL.  */
495                 return SvTRUE(svret) ? (void *)hv : NULL;
496                 }
497 #ifdef ENV_IS_CASELESS
498             else if (mg_find((const SV *)hv, PERL_MAGIC_env)) {
499                 /* XXX This code isn't UTF8 clean.  */
500                 char * const keysave = (char * const)key;
501                 /* Will need to free this, so set FREEKEY flag.  */
502                 key = savepvn(key,klen);
503                 key = (const char*)strupr((char*)key);
504                 is_utf8 = FALSE;
505                 hash = 0;
506                 keysv = 0;
507
508                 if (flags & HVhek_FREEKEY) {
509                     Safefree(keysave);
510                 }
511                 flags |= HVhek_FREEKEY;
512             }
513 #endif
514         } /* ISEXISTS */
515         else if (action & HV_FETCH_ISSTORE) {
516             bool needs_copy;
517             bool needs_store;
518             hv_magic_check (hv, &needs_copy, &needs_store);
519             if (needs_copy) {
520                 const bool save_taint = PL_tainted;
521                 if (keysv || is_utf8) {
522                     if (!keysv) {
523                         keysv = newSVpvn_utf8(key, klen, TRUE);
524                     }
525                     if (PL_tainting)
526                         PL_tainted = SvTAINTED(keysv);
527                     keysv = sv_2mortal(newSVsv(keysv));
528                     mg_copy(MUTABLE_SV(hv), val, (char*)keysv, HEf_SVKEY);
529                 } else {
530                     mg_copy(MUTABLE_SV(hv), val, key, klen);
531                 }
532
533                 TAINT_IF(save_taint);
534                 if (!needs_store) {
535                     if (flags & HVhek_FREEKEY)
536                         Safefree(key);
537                     return NULL;
538                 }
539 #ifdef ENV_IS_CASELESS
540                 else if (mg_find((const SV *)hv, PERL_MAGIC_env)) {
541                     /* XXX This code isn't UTF8 clean.  */
542                     const char *keysave = key;
543                     /* Will need to free this, so set FREEKEY flag.  */
544                     key = savepvn(key,klen);
545                     key = (const char*)strupr((char*)key);
546                     is_utf8 = FALSE;
547                     hash = 0;
548                     keysv = 0;
549
550                     if (flags & HVhek_FREEKEY) {
551                         Safefree(keysave);
552                     }
553                     flags |= HVhek_FREEKEY;
554                 }
555 #endif
556             }
557         } /* ISSTORE */
558     } /* SvMAGICAL */
559
560     if (!HvARRAY(hv)) {
561         if ((action & (HV_FETCH_LVALUE | HV_FETCH_ISSTORE))
562 #ifdef DYNAMIC_ENV_FETCH  /* if it's an %ENV lookup, we may get it on the fly */
563                  || (SvRMAGICAL((const SV *)hv)
564                      && mg_find((const SV *)hv, PERL_MAGIC_env))
565 #endif
566                                                                   ) {
567             char *array;
568             Newxz(array,
569                  PERL_HV_ARRAY_ALLOC_BYTES(xhv->xhv_max+1 /* HvMAX(hv)+1 */),
570                  char);
571             HvARRAY(hv) = (HE**)array;
572         }
573 #ifdef DYNAMIC_ENV_FETCH
574         else if (action & HV_FETCH_ISEXISTS) {
575             /* for an %ENV exists, if we do an insert it's by a recursive
576                store call, so avoid creating HvARRAY(hv) right now.  */
577         }
578 #endif
579         else {
580             /* XXX remove at some point? */
581             if (flags & HVhek_FREEKEY)
582                 Safefree(key);
583
584             return NULL;
585         }
586     }
587
588     if (is_utf8 & !(flags & HVhek_KEYCANONICAL)) {
589         char * const keysave = (char *)key;
590         key = (char*)bytes_from_utf8((U8*)key, &klen, &is_utf8);
591         if (is_utf8)
592             flags |= HVhek_UTF8;
593         else
594             flags &= ~HVhek_UTF8;
595         if (key != keysave) {
596             if (flags & HVhek_FREEKEY)
597                 Safefree(keysave);
598             flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
599             /* If the caller calculated a hash, it was on the sequence of
600                octets that are the UTF-8 form. We've now changed the sequence
601                of octets stored to that of the equivalent byte representation,
602                so the hash we need is different.  */
603             hash = 0;
604         }
605     }
606
607     if (HvREHASH(hv) || (!hash && !(keysv && (SvIsCOW_shared_hash(keysv)))))
608         PERL_HASH_INTERNAL_(hash, key, klen, HvREHASH(hv));
609     else if (!hash)
610         hash = SvSHARED_HASH(keysv);
611
612     /* We don't have a pointer to the hv, so we have to replicate the
613        flag into every HEK, so that hv_iterkeysv can see it.
614        And yes, you do need this even though you are not "storing" because
615        you can flip the flags below if doing an lval lookup.  (And that
616        was put in to give the semantics Andreas was expecting.)  */
617     if (HvREHASH(hv))
618         flags |= HVhek_REHASH;
619
620     masked_flags = (flags & HVhek_MASK);
621
622 #ifdef DYNAMIC_ENV_FETCH
623     if (!HvARRAY(hv)) entry = NULL;
624     else
625 #endif
626     {
627         entry = (HvARRAY(hv))[hash & (I32) HvMAX(hv)];
628     }
629     for (; entry; entry = HeNEXT(entry)) {
630         if (HeHASH(entry) != hash)              /* strings can't be equal */
631             continue;
632         if (HeKLEN(entry) != (I32)klen)
633             continue;
634         if (HeKEY(entry) != key && memNE(HeKEY(entry),key,klen))        /* is this it? */
635             continue;
636         if ((HeKFLAGS(entry) ^ masked_flags) & HVhek_UTF8)
637             continue;
638
639         if (action & (HV_FETCH_LVALUE|HV_FETCH_ISSTORE)) {
640             if (HeKFLAGS(entry) != masked_flags) {
641                 /* We match if HVhek_UTF8 bit in our flags and hash key's
642                    match.  But if entry was set previously with HVhek_WASUTF8
643                    and key now doesn't (or vice versa) then we should change
644                    the key's flag, as this is assignment.  */
645                 if (HvSHAREKEYS(hv)) {
646                     /* Need to swap the key we have for a key with the flags we
647                        need. As keys are shared we can't just write to the
648                        flag, so we share the new one, unshare the old one.  */
649                     HEK * const new_hek = share_hek_flags(key, klen, hash,
650                                                    masked_flags);
651                     unshare_hek (HeKEY_hek(entry));
652                     HeKEY_hek(entry) = new_hek;
653                 }
654                 else if (hv == PL_strtab) {
655                     /* PL_strtab is usually the only hash without HvSHAREKEYS,
656                        so putting this test here is cheap  */
657                     if (flags & HVhek_FREEKEY)
658                         Safefree(key);
659                     Perl_croak(aTHX_ S_strtab_error,
660                                action & HV_FETCH_LVALUE ? "fetch" : "store");
661                 }
662                 else
663                     HeKFLAGS(entry) = masked_flags;
664                 if (masked_flags & HVhek_ENABLEHVKFLAGS)
665                     HvHASKFLAGS_on(hv);
666             }
667             if (HeVAL(entry) == &PL_sv_placeholder) {
668                 /* yes, can store into placeholder slot */
669                 if (action & HV_FETCH_LVALUE) {
670                     if (SvMAGICAL(hv)) {
671                         /* This preserves behaviour with the old hv_fetch
672                            implementation which at this point would bail out
673                            with a break; (at "if we find a placeholder, we
674                            pretend we haven't found anything")
675
676                            That break mean that if a placeholder were found, it
677                            caused a call into hv_store, which in turn would
678                            check magic, and if there is no magic end up pretty
679                            much back at this point (in hv_store's code).  */
680                         break;
681                     }
682                     /* LVAL fetch which actually needs a store.  */
683                     val = newSV(0);
684                     HvPLACEHOLDERS(hv)--;
685                 } else {
686                     /* store */
687                     if (val != &PL_sv_placeholder)
688                         HvPLACEHOLDERS(hv)--;
689                 }
690                 HeVAL(entry) = val;
691             } else if (action & HV_FETCH_ISSTORE) {
692                 SvREFCNT_dec(HeVAL(entry));
693                 HeVAL(entry) = val;
694             }
695         } else if (HeVAL(entry) == &PL_sv_placeholder) {
696             /* if we find a placeholder, we pretend we haven't found
697                anything */
698             break;
699         }
700         if (flags & HVhek_FREEKEY)
701             Safefree(key);
702         if (return_svp) {
703             return entry ? (void *) &HeVAL(entry) : NULL;
704         }
705         return entry;
706     }
707 #ifdef DYNAMIC_ENV_FETCH  /* %ENV lookup?  If so, try to fetch the value now */
708     if (!(action & HV_FETCH_ISSTORE) 
709         && SvRMAGICAL((const SV *)hv)
710         && mg_find((const SV *)hv, PERL_MAGIC_env)) {
711         unsigned long len;
712         const char * const env = PerlEnv_ENVgetenv_len(key,&len);
713         if (env) {
714             sv = newSVpvn(env,len);
715             SvTAINTED_on(sv);
716             return hv_common(hv, keysv, key, klen, flags,
717                              HV_FETCH_ISSTORE|HV_DISABLE_UVAR_XKEY|return_svp,
718                              sv, hash);
719         }
720     }
721 #endif
722
723     if (!entry && SvREADONLY(hv) && !(action & HV_FETCH_ISEXISTS)) {
724         hv_notallowed(flags, key, klen,
725                         "Attempt to access disallowed key '%"SVf"' in"
726                         " a restricted hash");
727     }
728     if (!(action & (HV_FETCH_LVALUE|HV_FETCH_ISSTORE))) {
729         /* Not doing some form of store, so return failure.  */
730         if (flags & HVhek_FREEKEY)
731             Safefree(key);
732         return NULL;
733     }
734     if (action & HV_FETCH_LVALUE) {
735         val = action & HV_FETCH_EMPTY_HE ? NULL : newSV(0);
736         if (SvMAGICAL(hv)) {
737             /* At this point the old hv_fetch code would call to hv_store,
738                which in turn might do some tied magic. So we need to make that
739                magic check happen.  */
740             /* gonna assign to this, so it better be there */
741             /* If a fetch-as-store fails on the fetch, then the action is to
742                recurse once into "hv_store". If we didn't do this, then that
743                recursive call would call the key conversion routine again.
744                However, as we replace the original key with the converted
745                key, this would result in a double conversion, which would show
746                up as a bug if the conversion routine is not idempotent.  */
747             return hv_common(hv, keysv, key, klen, flags,
748                              HV_FETCH_ISSTORE|HV_DISABLE_UVAR_XKEY|return_svp,
749                              val, hash);
750             /* XXX Surely that could leak if the fetch-was-store fails?
751                Just like the hv_fetch.  */
752         }
753     }
754
755     /* Welcome to hv_store...  */
756
757     if (!HvARRAY(hv)) {
758         /* Not sure if we can get here.  I think the only case of oentry being
759            NULL is for %ENV with dynamic env fetch.  But that should disappear
760            with magic in the previous code.  */
761         char *array;
762         Newxz(array,
763              PERL_HV_ARRAY_ALLOC_BYTES(xhv->xhv_max+1 /* HvMAX(hv)+1 */),
764              char);
765         HvARRAY(hv) = (HE**)array;
766     }
767
768     oentry = &(HvARRAY(hv))[hash & (I32) xhv->xhv_max];
769
770     entry = new_HE();
771     /* share_hek_flags will do the free for us.  This might be considered
772        bad API design.  */
773     if (HvSHAREKEYS(hv))
774         HeKEY_hek(entry) = share_hek_flags(key, klen, hash, flags);
775     else if (hv == PL_strtab) {
776         /* PL_strtab is usually the only hash without HvSHAREKEYS, so putting
777            this test here is cheap  */
778         if (flags & HVhek_FREEKEY)
779             Safefree(key);
780         Perl_croak(aTHX_ S_strtab_error,
781                    action & HV_FETCH_LVALUE ? "fetch" : "store");
782     }
783     else                                       /* gotta do the real thing */
784         HeKEY_hek(entry) = save_hek_flags(key, klen, hash, flags);
785     HeVAL(entry) = val;
786     HeNEXT(entry) = *oentry;
787     *oentry = entry;
788
789     if (val == &PL_sv_placeholder)
790         HvPLACEHOLDERS(hv)++;
791     if (masked_flags & HVhek_ENABLEHVKFLAGS)
792         HvHASKFLAGS_on(hv);
793
794     {
795         const HE *counter = HeNEXT(entry);
796
797         xhv->xhv_keys++; /* HvTOTALKEYS(hv)++ */
798         if (!counter) {                         /* initial entry? */
799         } else if (xhv->xhv_keys > xhv->xhv_max) {
800                 /* Use only the old HvUSEDKEYS(hv) > HvMAX(hv) condition to limit
801                    bucket splits on a rehashed hash, as we're not going to
802                    split it again, and if someone is lucky (evil) enough to
803                    get all the keys in one list they could exhaust our memory
804                    as we repeatedly double the number of buckets on every
805                    entry. Linear search feels a less worse thing to do.  */
806             hsplit(hv);
807         } else if(!HvREHASH(hv)) {
808             U32 n_links = 1;
809
810             while ((counter = HeNEXT(counter)))
811                 n_links++;
812
813             if (n_links > HV_MAX_LENGTH_BEFORE_SPLIT) {
814                 hsplit(hv);
815             }
816         }
817     }
818
819     if (return_svp) {
820         return entry ? (void *) &HeVAL(entry) : NULL;
821     }
822     return (void *) entry;
823 }
824
825 STATIC void
826 S_hv_magic_check(HV *hv, bool *needs_copy, bool *needs_store)
827 {
828     const MAGIC *mg = SvMAGIC(hv);
829
830     PERL_ARGS_ASSERT_HV_MAGIC_CHECK;
831
832     *needs_copy = FALSE;
833     *needs_store = TRUE;
834     while (mg) {
835         if (isUPPER(mg->mg_type)) {
836             *needs_copy = TRUE;
837             if (mg->mg_type == PERL_MAGIC_tied) {
838                 *needs_store = FALSE;
839                 return; /* We've set all there is to set. */
840             }
841         }
842         mg = mg->mg_moremagic;
843     }
844 }
845
846 /*
847 =for apidoc hv_scalar
848
849 Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
850
851 =cut
852 */
853
854 SV *
855 Perl_hv_scalar(pTHX_ HV *hv)
856 {
857     SV *sv;
858
859     PERL_ARGS_ASSERT_HV_SCALAR;
860
861     if (SvRMAGICAL(hv)) {
862         MAGIC * const mg = mg_find((const SV *)hv, PERL_MAGIC_tied);
863         if (mg)
864             return magic_scalarpack(hv, mg);
865     }
866
867     sv = sv_newmortal();
868     if (HvTOTALKEYS((const HV *)hv)) 
869         Perl_sv_setpvf(aTHX_ sv, "%ld/%ld",
870                 (long)HvFILL(hv), (long)HvMAX(hv) + 1);
871     else
872         sv_setiv(sv, 0);
873     
874     return sv;
875 }
876
877 /*
878 =for apidoc hv_delete
879
880 Deletes a key/value pair in the hash.  The value's SV is removed from the
881 hash, made mortal, and returned to the caller.  The C<klen> is the length of
882 the key.  The C<flags> value will normally be zero; if set to G_DISCARD then
883 NULL will be returned.  NULL will also be returned if the key is not found.
884
885 =for apidoc hv_delete_ent
886
887 Deletes a key/value pair in the hash.  The value SV is removed from the hash,
888 made mortal, and returned to the caller.  The C<flags> value will normally be
889 zero; if set to G_DISCARD then NULL will be returned.  NULL will also be
890 returned if the key is not found.  C<hash> can be a valid precomputed hash
891 value, or 0 to ask for it to be computed.
892
893 =cut
894 */
895
896 STATIC SV *
897 S_hv_delete_common(pTHX_ HV *hv, SV *keysv, const char *key, STRLEN klen,
898                    int k_flags, I32 d_flags, U32 hash)
899 {
900     dVAR;
901     register XPVHV* xhv;
902     register HE *entry;
903     register HE **oentry;
904     bool is_utf8 = (k_flags & HVhek_UTF8) ? TRUE : FALSE;
905     int masked_flags;
906
907     if (SvRMAGICAL(hv)) {
908         bool needs_copy;
909         bool needs_store;
910         hv_magic_check (hv, &needs_copy, &needs_store);
911
912         if (needs_copy) {
913             SV *sv;
914             entry = (HE *) hv_common(hv, keysv, key, klen,
915                                      k_flags & ~HVhek_FREEKEY,
916                                      HV_FETCH_LVALUE|HV_DISABLE_UVAR_XKEY,
917                                      NULL, hash);
918             sv = entry ? HeVAL(entry) : NULL;
919             if (sv) {
920                 if (SvMAGICAL(sv)) {
921                     mg_clear(sv);
922                 }
923                 if (!needs_store) {
924                     if (mg_find(sv, PERL_MAGIC_tiedelem)) {
925                         /* No longer an element */
926                         sv_unmagic(sv, PERL_MAGIC_tiedelem);
927                         return sv;
928                     }           
929                     return NULL;                /* element cannot be deleted */
930                 }
931 #ifdef ENV_IS_CASELESS
932                 else if (mg_find((const SV *)hv, PERL_MAGIC_env)) {
933                     /* XXX This code isn't UTF8 clean.  */
934                     keysv = newSVpvn_flags(key, klen, SVs_TEMP);
935                     if (k_flags & HVhek_FREEKEY) {
936                         Safefree(key);
937                     }
938                     key = strupr(SvPVX(keysv));
939                     is_utf8 = 0;
940                     k_flags = 0;
941                     hash = 0;
942                 }
943 #endif
944             }
945         }
946     }
947     xhv = (XPVHV*)SvANY(hv);
948     if (!HvARRAY(hv))
949         return NULL;
950
951     if (is_utf8) {
952         const char * const keysave = key;
953         key = (char*)bytes_from_utf8((U8*)key, &klen, &is_utf8);
954
955         if (is_utf8)
956             k_flags |= HVhek_UTF8;
957         else
958             k_flags &= ~HVhek_UTF8;
959         if (key != keysave) {
960             if (k_flags & HVhek_FREEKEY) {
961                 /* This shouldn't happen if our caller does what we expect,
962                    but strictly the API allows it.  */
963                 Safefree(keysave);
964             }
965             k_flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
966         }
967         HvHASKFLAGS_on(MUTABLE_SV(hv));
968     }
969
970     if (HvREHASH(hv) || (!hash && !(keysv && (SvIsCOW_shared_hash(keysv)))))
971         PERL_HASH_INTERNAL_(hash, key, klen, HvREHASH(hv));
972     else if (!hash)
973         hash = SvSHARED_HASH(keysv);
974
975     masked_flags = (k_flags & HVhek_MASK);
976
977     oentry = &(HvARRAY(hv))[hash & (I32) HvMAX(hv)];
978     entry = *oentry;
979     for (; entry; oentry = &HeNEXT(entry), entry = *oentry) {
980         SV *sv;
981         U8 mro_changes = 0; /* 1 = isa; 2 = package moved */
982         GV *gv = NULL;
983         HV *stash = NULL;
984
985         if (HeHASH(entry) != hash)              /* strings can't be equal */
986             continue;
987         if (HeKLEN(entry) != (I32)klen)
988             continue;
989         if (HeKEY(entry) != key && memNE(HeKEY(entry),key,klen))        /* is this it? */
990             continue;
991         if ((HeKFLAGS(entry) ^ masked_flags) & HVhek_UTF8)
992             continue;
993
994         if (hv == PL_strtab) {
995             if (k_flags & HVhek_FREEKEY)
996                 Safefree(key);
997             Perl_croak(aTHX_ S_strtab_error, "delete");
998         }
999
1000         /* if placeholder is here, it's already been deleted.... */
1001         if (HeVAL(entry) == &PL_sv_placeholder) {
1002             if (k_flags & HVhek_FREEKEY)
1003                 Safefree(key);
1004             return NULL;
1005         }
1006         if (SvREADONLY(hv) && HeVAL(entry) && SvREADONLY(HeVAL(entry))) {
1007             hv_notallowed(k_flags, key, klen,
1008                             "Attempt to delete readonly key '%"SVf"' from"
1009                             " a restricted hash");
1010         }
1011         if (k_flags & HVhek_FREEKEY)
1012             Safefree(key);
1013
1014         /* If this is a stash and the key ends with ::, then someone is 
1015          * deleting a package.
1016          */
1017         if (HeVAL(entry) && HvENAME_get(hv)) {
1018                 gv = (GV *)HeVAL(entry);
1019                 if (keysv) key = SvPV(keysv, klen);
1020                 if ((
1021                      (klen > 1 && key[klen-2] == ':' && key[klen-1] == ':')
1022                       ||
1023                      (klen == 1 && key[0] == ':')
1024                     )
1025                  && (klen != 6 || hv!=PL_defstash || memNE(key,"main::",6))
1026                  && SvTYPE(gv) == SVt_PVGV && (stash = GvHV((GV *)gv))
1027                  && HvENAME_get(stash)) {
1028                         /* A previous version of this code checked that the
1029                          * GV was still in the symbol table by fetching the
1030                          * GV with its name. That is not necessary (and
1031                          * sometimes incorrect), as HvENAME cannot be set
1032                          * on hv if it is not in the symtab. */
1033                         mro_changes = 2;
1034                         /* Hang on to it for a bit. */
1035                         SvREFCNT_inc_simple_void_NN(
1036                          sv_2mortal((SV *)gv)
1037                         );
1038                 }
1039                 else if (klen == 3 && strnEQ(key, "ISA", 3))
1040                     mro_changes = 1;
1041         }
1042
1043         if (d_flags & G_DISCARD)
1044             sv = NULL;
1045         else {
1046             sv = sv_2mortal(HeVAL(entry));
1047             HeVAL(entry) = &PL_sv_placeholder;
1048         }
1049
1050         /*
1051          * If a restricted hash, rather than really deleting the entry, put
1052          * a placeholder there. This marks the key as being "approved", so
1053          * we can still access via not-really-existing key without raising
1054          * an error.
1055          */
1056         if (SvREADONLY(hv)) {
1057             SvREFCNT_dec(HeVAL(entry));
1058             HeVAL(entry) = &PL_sv_placeholder;
1059             /* We'll be saving this slot, so the number of allocated keys
1060              * doesn't go down, but the number placeholders goes up */
1061             HvPLACEHOLDERS(hv)++;
1062         } else {
1063             *oentry = HeNEXT(entry);
1064             if (SvOOK(hv) && entry == HvAUX(hv)->xhv_eiter /* HvEITER(hv) */)
1065                 HvLAZYDEL_on(hv);
1066             else
1067                 hv_free_ent(hv, entry);
1068             xhv->xhv_keys--; /* HvTOTALKEYS(hv)-- */
1069             if (xhv->xhv_keys == 0)
1070                 HvHASKFLAGS_off(hv);
1071         }
1072
1073         if (mro_changes == 1) mro_isa_changed_in(hv);
1074         else if (mro_changes == 2)
1075             mro_package_moved(NULL, stash, gv, 1);
1076
1077         return sv;
1078     }
1079     if (SvREADONLY(hv)) {
1080         hv_notallowed(k_flags, key, klen,
1081                         "Attempt to delete disallowed key '%"SVf"' from"
1082                         " a restricted hash");
1083     }
1084
1085     if (k_flags & HVhek_FREEKEY)
1086         Safefree(key);
1087     return NULL;
1088 }
1089
1090 STATIC void
1091 S_hsplit(pTHX_ HV *hv)
1092 {
1093     dVAR;
1094     register XPVHV* const xhv = (XPVHV*)SvANY(hv);
1095     const I32 oldsize = (I32) xhv->xhv_max+1; /* HvMAX(hv)+1 (sick) */
1096     register I32 newsize = oldsize * 2;
1097     register I32 i;
1098     char *a = (char*) HvARRAY(hv);
1099     register HE **aep;
1100     int longest_chain = 0;
1101     int was_shared;
1102
1103     PERL_ARGS_ASSERT_HSPLIT;
1104
1105     /*PerlIO_printf(PerlIO_stderr(), "hsplit called for %p which had %d\n",
1106       (void*)hv, (int) oldsize);*/
1107
1108     if (HvPLACEHOLDERS_get(hv) && !SvREADONLY(hv)) {
1109       /* Can make this clear any placeholders first for non-restricted hashes,
1110          even though Storable rebuilds restricted hashes by putting in all the
1111          placeholders (first) before turning on the readonly flag, because
1112          Storable always pre-splits the hash.  */
1113       hv_clear_placeholders(hv);
1114     }
1115                
1116     PL_nomemok = TRUE;
1117 #if defined(STRANGE_MALLOC) || defined(MYMALLOC)
1118     Renew(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1119           + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
1120     if (!a) {
1121       PL_nomemok = FALSE;
1122       return;
1123     }
1124     if (SvOOK(hv)) {
1125         Move(&a[oldsize * sizeof(HE*)], &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
1126     }
1127 #else
1128     Newx(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1129         + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
1130     if (!a) {
1131       PL_nomemok = FALSE;
1132       return;
1133     }
1134     Copy(HvARRAY(hv), a, oldsize * sizeof(HE*), char);
1135     if (SvOOK(hv)) {
1136         Copy(HvAUX(hv), &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
1137     }
1138     Safefree(HvARRAY(hv));
1139 #endif
1140
1141     PL_nomemok = FALSE;
1142     Zero(&a[oldsize * sizeof(HE*)], (newsize-oldsize) * sizeof(HE*), char);     /* zero 2nd half*/
1143     xhv->xhv_max = --newsize;   /* HvMAX(hv) = --newsize */
1144     HvARRAY(hv) = (HE**) a;
1145     aep = (HE**)a;
1146
1147     for (i=0; i<oldsize; i++,aep++) {
1148         int left_length = 0;
1149         int right_length = 0;
1150         HE **oentry = aep;
1151         HE *entry = *aep;
1152         register HE **bep;
1153
1154         if (!entry)                             /* non-existent */
1155             continue;
1156         bep = aep+oldsize;
1157         do {
1158             if ((HeHASH(entry) & newsize) != (U32)i) {
1159                 *oentry = HeNEXT(entry);
1160                 HeNEXT(entry) = *bep;
1161                 *bep = entry;
1162                 right_length++;
1163             }
1164             else {
1165                 oentry = &HeNEXT(entry);
1166                 left_length++;
1167             }
1168             entry = *oentry;
1169         } while (entry);
1170         /* I think we don't actually need to keep track of the longest length,
1171            merely flag if anything is too long. But for the moment while
1172            developing this code I'll track it.  */
1173         if (left_length > longest_chain)
1174             longest_chain = left_length;
1175         if (right_length > longest_chain)
1176             longest_chain = right_length;
1177     }
1178
1179
1180     /* Pick your policy for "hashing isn't working" here:  */
1181     if (longest_chain <= HV_MAX_LENGTH_BEFORE_SPLIT /* split worked?  */
1182         || HvREHASH(hv)) {
1183         return;
1184     }
1185
1186     if (hv == PL_strtab) {
1187         /* Urg. Someone is doing something nasty to the string table.
1188            Can't win.  */
1189         return;
1190     }
1191
1192     /* Awooga. Awooga. Pathological data.  */
1193     /*PerlIO_printf(PerlIO_stderr(), "%p %d of %d with %d/%d buckets\n", (void*)hv,
1194       longest_chain, HvTOTALKEYS(hv), HvFILL(hv),  1+HvMAX(hv));*/
1195
1196     ++newsize;
1197     Newxz(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1198          + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
1199     if (SvOOK(hv)) {
1200         Copy(HvAUX(hv), &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
1201     }
1202
1203     was_shared = HvSHAREKEYS(hv);
1204
1205     HvSHAREKEYS_off(hv);
1206     HvREHASH_on(hv);
1207
1208     aep = HvARRAY(hv);
1209
1210     for (i=0; i<newsize; i++,aep++) {
1211         register HE *entry = *aep;
1212         while (entry) {
1213             /* We're going to trash this HE's next pointer when we chain it
1214                into the new hash below, so store where we go next.  */
1215             HE * const next = HeNEXT(entry);
1216             UV hash;
1217             HE **bep;
1218
1219             /* Rehash it */
1220             PERL_HASH_INTERNAL(hash, HeKEY(entry), HeKLEN(entry));
1221
1222             if (was_shared) {
1223                 /* Unshare it.  */
1224                 HEK * const new_hek
1225                     = save_hek_flags(HeKEY(entry), HeKLEN(entry),
1226                                      hash, HeKFLAGS(entry));
1227                 unshare_hek (HeKEY_hek(entry));
1228                 HeKEY_hek(entry) = new_hek;
1229             } else {
1230                 /* Not shared, so simply write the new hash in. */
1231                 HeHASH(entry) = hash;
1232             }
1233             /*PerlIO_printf(PerlIO_stderr(), "%d ", HeKFLAGS(entry));*/
1234             HEK_REHASH_on(HeKEY_hek(entry));
1235             /*PerlIO_printf(PerlIO_stderr(), "%d\n", HeKFLAGS(entry));*/
1236
1237             /* Copy oentry to the correct new chain.  */
1238             bep = ((HE**)a) + (hash & (I32) xhv->xhv_max);
1239             HeNEXT(entry) = *bep;
1240             *bep = entry;
1241
1242             entry = next;
1243         }
1244     }
1245     Safefree (HvARRAY(hv));
1246     HvARRAY(hv) = (HE **)a;
1247 }
1248
1249 void
1250 Perl_hv_ksplit(pTHX_ HV *hv, IV newmax)
1251 {
1252     dVAR;
1253     register XPVHV* xhv = (XPVHV*)SvANY(hv);
1254     const I32 oldsize = (I32) xhv->xhv_max+1; /* HvMAX(hv)+1 (sick) */
1255     register I32 newsize;
1256     register I32 i;
1257     register char *a;
1258     register HE **aep;
1259
1260     PERL_ARGS_ASSERT_HV_KSPLIT;
1261
1262     newsize = (I32) newmax;                     /* possible truncation here */
1263     if (newsize != newmax || newmax <= oldsize)
1264         return;
1265     while ((newsize & (1 + ~newsize)) != newsize) {
1266         newsize &= ~(newsize & (1 + ~newsize)); /* get proper power of 2 */
1267     }
1268     if (newsize < newmax)
1269         newsize *= 2;
1270     if (newsize < newmax)
1271         return;                                 /* overflow detection */
1272
1273     a = (char *) HvARRAY(hv);
1274     if (a) {
1275         PL_nomemok = TRUE;
1276 #if defined(STRANGE_MALLOC) || defined(MYMALLOC)
1277         Renew(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1278               + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
1279         if (!a) {
1280           PL_nomemok = FALSE;
1281           return;
1282         }
1283         if (SvOOK(hv)) {
1284             Copy(&a[oldsize * sizeof(HE*)], &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
1285         }
1286 #else
1287         Newx(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1288             + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
1289         if (!a) {
1290           PL_nomemok = FALSE;
1291           return;
1292         }
1293         Copy(HvARRAY(hv), a, oldsize * sizeof(HE*), char);
1294         if (SvOOK(hv)) {
1295             Copy(HvAUX(hv), &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
1296         }
1297         Safefree(HvARRAY(hv));
1298 #endif
1299         PL_nomemok = FALSE;
1300         Zero(&a[oldsize * sizeof(HE*)], (newsize-oldsize) * sizeof(HE*), char); /* zero 2nd half*/
1301     }
1302     else {
1303         Newxz(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize), char);
1304     }
1305     xhv->xhv_max = --newsize;   /* HvMAX(hv) = --newsize */
1306     HvARRAY(hv) = (HE **) a;
1307     if (!xhv->xhv_keys /* !HvTOTALKEYS(hv) */)  /* skip rest if no entries */
1308         return;
1309
1310     aep = (HE**)a;
1311     for (i=0; i<oldsize; i++,aep++) {
1312         HE **oentry = aep;
1313         HE *entry = *aep;
1314
1315         if (!entry)                             /* non-existent */
1316             continue;
1317         do {
1318             register I32 j = (HeHASH(entry) & newsize);
1319
1320             if (j != i) {
1321                 j -= i;
1322                 *oentry = HeNEXT(entry);
1323                 HeNEXT(entry) = aep[j];
1324                 aep[j] = entry;
1325             }
1326             else
1327                 oentry = &HeNEXT(entry);
1328             entry = *oentry;
1329         } while (entry);
1330     }
1331 }
1332
1333 HV *
1334 Perl_newHVhv(pTHX_ HV *ohv)
1335 {
1336     dVAR;
1337     HV * const hv = newHV();
1338     STRLEN hv_max;
1339
1340     if (!ohv || !HvTOTALKEYS(ohv))
1341         return hv;
1342     hv_max = HvMAX(ohv);
1343
1344     if (!SvMAGICAL((const SV *)ohv)) {
1345         /* It's an ordinary hash, so copy it fast. AMS 20010804 */
1346         STRLEN i;
1347         const bool shared = !!HvSHAREKEYS(ohv);
1348         HE **ents, ** const oents = (HE **)HvARRAY(ohv);
1349         char *a;
1350         Newx(a, PERL_HV_ARRAY_ALLOC_BYTES(hv_max+1), char);
1351         ents = (HE**)a;
1352
1353         /* In each bucket... */
1354         for (i = 0; i <= hv_max; i++) {
1355             HE *prev = NULL;
1356             HE *oent = oents[i];
1357
1358             if (!oent) {
1359                 ents[i] = NULL;
1360                 continue;
1361             }
1362
1363             /* Copy the linked list of entries. */
1364             for (; oent; oent = HeNEXT(oent)) {
1365                 const U32 hash   = HeHASH(oent);
1366                 const char * const key = HeKEY(oent);
1367                 const STRLEN len = HeKLEN(oent);
1368                 const int flags  = HeKFLAGS(oent);
1369                 HE * const ent   = new_HE();
1370                 SV *const val    = HeVAL(oent);
1371
1372                 HeVAL(ent) = SvIMMORTAL(val) ? val : newSVsv(val);
1373                 HeKEY_hek(ent)
1374                     = shared ? share_hek_flags(key, len, hash, flags)
1375                              :  save_hek_flags(key, len, hash, flags);
1376                 if (prev)
1377                     HeNEXT(prev) = ent;
1378                 else
1379                     ents[i] = ent;
1380                 prev = ent;
1381                 HeNEXT(ent) = NULL;
1382             }
1383         }
1384
1385         HvMAX(hv)   = hv_max;
1386         HvTOTALKEYS(hv)  = HvTOTALKEYS(ohv);
1387         HvARRAY(hv) = ents;
1388     } /* not magical */
1389     else {
1390         /* Iterate over ohv, copying keys and values one at a time. */
1391         HE *entry;
1392         const I32 riter = HvRITER_get(ohv);
1393         HE * const eiter = HvEITER_get(ohv);
1394         STRLEN hv_fill = HvFILL(ohv);
1395
1396         /* Can we use fewer buckets? (hv_max is always 2^n-1) */
1397         while (hv_max && hv_max + 1 >= hv_fill * 2)
1398             hv_max = hv_max / 2;
1399         HvMAX(hv) = hv_max;
1400
1401         hv_iterinit(ohv);
1402         while ((entry = hv_iternext_flags(ohv, 0))) {
1403             SV *const val = HeVAL(entry);
1404             (void)hv_store_flags(hv, HeKEY(entry), HeKLEN(entry),
1405                                  SvIMMORTAL(val) ? val : newSVsv(val),
1406                                  HeHASH(entry), HeKFLAGS(entry));
1407         }
1408         HvRITER_set(ohv, riter);
1409         HvEITER_set(ohv, eiter);
1410     }
1411
1412     return hv;
1413 }
1414
1415 /*
1416 =for apidoc Am|HV *|hv_copy_hints_hv|HV *ohv
1417
1418 A specialised version of L</newHVhv> for copying C<%^H>.  I<ohv> must be
1419 a pointer to a hash (which may have C<%^H> magic, but should be generally
1420 non-magical), or C<NULL> (interpreted as an empty hash).  The content
1421 of I<ohv> is copied to a new hash, which has the C<%^H>-specific magic
1422 added to it.  A pointer to the new hash is returned.
1423
1424 =cut
1425 */
1426
1427 HV *
1428 Perl_hv_copy_hints_hv(pTHX_ HV *const ohv)
1429 {
1430     HV * const hv = newHV();
1431
1432     if (ohv && HvTOTALKEYS(ohv)) {
1433         STRLEN hv_max = HvMAX(ohv);
1434         STRLEN hv_fill = HvFILL(ohv);
1435         HE *entry;
1436         const I32 riter = HvRITER_get(ohv);
1437         HE * const eiter = HvEITER_get(ohv);
1438
1439         while (hv_max && hv_max + 1 >= hv_fill * 2)
1440             hv_max = hv_max / 2;
1441         HvMAX(hv) = hv_max;
1442
1443         hv_iterinit(ohv);
1444         while ((entry = hv_iternext_flags(ohv, 0))) {
1445             SV *const sv = newSVsv(HeVAL(entry));
1446             SV *heksv = newSVhek(HeKEY_hek(entry));
1447             sv_magic(sv, NULL, PERL_MAGIC_hintselem,
1448                      (char *)heksv, HEf_SVKEY);
1449             SvREFCNT_dec(heksv);
1450             (void)hv_store_flags(hv, HeKEY(entry), HeKLEN(entry),
1451                                  sv, HeHASH(entry), HeKFLAGS(entry));
1452         }
1453         HvRITER_set(ohv, riter);
1454         HvEITER_set(ohv, eiter);
1455     }
1456     hv_magic(hv, NULL, PERL_MAGIC_hints);
1457     return hv;
1458 }
1459
1460 void
1461 Perl_hv_free_ent(pTHX_ HV *hv, register HE *entry)
1462 {
1463     dVAR;
1464     SV *val;
1465
1466     PERL_ARGS_ASSERT_HV_FREE_ENT;
1467
1468     if (!entry)
1469         return;
1470     val = HeVAL(entry);
1471     if (val && isGV(val) && isGV_with_GP(val) && GvCVu(val) && HvENAME(hv))
1472         mro_method_changed_in(hv);      /* deletion of method from stash */
1473     if (HeKLEN(entry) == HEf_SVKEY) {
1474         SvREFCNT_dec(HeKEY_sv(entry));
1475         Safefree(HeKEY_hek(entry));
1476     }
1477     else if (HvSHAREKEYS(hv))
1478         unshare_hek(HeKEY_hek(entry));
1479     else
1480         Safefree(HeKEY_hek(entry));
1481     del_HE(entry);
1482     SvREFCNT_dec(val);
1483 }
1484
1485
1486 void
1487 Perl_hv_delayfree_ent(pTHX_ HV *hv, register HE *entry)
1488 {
1489     dVAR;
1490
1491     PERL_ARGS_ASSERT_HV_DELAYFREE_ENT;
1492
1493     if (!entry)
1494         return;
1495     /* SvREFCNT_inc to counter the SvREFCNT_dec in hv_free_ent  */
1496     sv_2mortal(SvREFCNT_inc(HeVAL(entry)));     /* free between statements */
1497     if (HeKLEN(entry) == HEf_SVKEY) {
1498         sv_2mortal(SvREFCNT_inc(HeKEY_sv(entry)));
1499     }
1500     hv_free_ent(hv, entry);
1501 }
1502
1503 /*
1504 =for apidoc hv_clear
1505
1506 Clears a hash, making it empty.
1507
1508 =cut
1509 */
1510
1511 void
1512 Perl_hv_clear(pTHX_ HV *hv)
1513 {
1514     dVAR;
1515     register XPVHV* xhv;
1516     if (!hv)
1517         return;
1518
1519     DEBUG_A(Perl_hv_assert(aTHX_ hv));
1520
1521     xhv = (XPVHV*)SvANY(hv);
1522
1523     if (SvREADONLY(hv) && HvARRAY(hv) != NULL) {
1524         /* restricted hash: convert all keys to placeholders */
1525         STRLEN i;
1526         for (i = 0; i <= xhv->xhv_max; i++) {
1527             HE *entry = (HvARRAY(hv))[i];
1528             for (; entry; entry = HeNEXT(entry)) {
1529                 /* not already placeholder */
1530                 if (HeVAL(entry) != &PL_sv_placeholder) {
1531                     if (HeVAL(entry) && SvREADONLY(HeVAL(entry))) {
1532                         SV* const keysv = hv_iterkeysv(entry);
1533                         Perl_croak(aTHX_
1534                                    "Attempt to delete readonly key '%"SVf"' from a restricted hash",
1535                                    (void*)keysv);
1536                     }
1537                     SvREFCNT_dec(HeVAL(entry));
1538                     HeVAL(entry) = &PL_sv_placeholder;
1539                     HvPLACEHOLDERS(hv)++;
1540                 }
1541             }
1542         }
1543     }
1544     else {
1545         hfreeentries(hv);
1546         HvPLACEHOLDERS_set(hv, 0);
1547
1548         if (SvRMAGICAL(hv))
1549             mg_clear(MUTABLE_SV(hv));
1550
1551         HvHASKFLAGS_off(hv);
1552         HvREHASH_off(hv);
1553     }
1554     if (SvOOK(hv)) {
1555         if(HvENAME_get(hv))
1556             mro_isa_changed_in(hv);
1557         HvEITER_set(hv, NULL);
1558     }
1559 }
1560
1561 /*
1562 =for apidoc hv_clear_placeholders
1563
1564 Clears any placeholders from a hash.  If a restricted hash has any of its keys
1565 marked as readonly and the key is subsequently deleted, the key is not actually
1566 deleted but is marked by assigning it a value of &PL_sv_placeholder.  This tags
1567 it so it will be ignored by future operations such as iterating over the hash,
1568 but will still allow the hash to have a value reassigned to the key at some
1569 future point.  This function clears any such placeholder keys from the hash.
1570 See Hash::Util::lock_keys() for an example of its use.
1571
1572 =cut
1573 */
1574
1575 void
1576 Perl_hv_clear_placeholders(pTHX_ HV *hv)
1577 {
1578     dVAR;
1579     const U32 items = (U32)HvPLACEHOLDERS_get(hv);
1580
1581     PERL_ARGS_ASSERT_HV_CLEAR_PLACEHOLDERS;
1582
1583     if (items)
1584         clear_placeholders(hv, items);
1585 }
1586
1587 static void
1588 S_clear_placeholders(pTHX_ HV *hv, U32 items)
1589 {
1590     dVAR;
1591     I32 i;
1592
1593     PERL_ARGS_ASSERT_CLEAR_PLACEHOLDERS;
1594
1595     if (items == 0)
1596         return;
1597
1598     i = HvMAX(hv);
1599     do {
1600         /* Loop down the linked list heads  */
1601         HE **oentry = &(HvARRAY(hv))[i];
1602         HE *entry;
1603
1604         while ((entry = *oentry)) {
1605             if (HeVAL(entry) == &PL_sv_placeholder) {
1606                 *oentry = HeNEXT(entry);
1607                 if (entry == HvEITER_get(hv))
1608                     HvLAZYDEL_on(hv);
1609                 else
1610                     hv_free_ent(hv, entry);
1611
1612                 if (--items == 0) {
1613                     /* Finished.  */
1614                     HvTOTALKEYS(hv) -= (IV)HvPLACEHOLDERS_get(hv);
1615                     if (HvUSEDKEYS(hv) == 0)
1616                         HvHASKFLAGS_off(hv);
1617                     HvPLACEHOLDERS_set(hv, 0);
1618                     return;
1619                 }
1620             } else {
1621                 oentry = &HeNEXT(entry);
1622             }
1623         }
1624     } while (--i >= 0);
1625     /* You can't get here, hence assertion should always fail.  */
1626     assert (items == 0);
1627     assert (0);
1628 }
1629
1630 STATIC void
1631 S_hfreeentries(pTHX_ HV *hv)
1632 {
1633     STRLEN i = 0;
1634     const bool mpm = PL_phase != PERL_PHASE_DESTRUCT && HvENAME(hv);
1635
1636     PERL_ARGS_ASSERT_HFREEENTRIES;
1637
1638     if (!HvARRAY(hv))
1639         return;
1640
1641     /* keep looping until all keys are removed. This may take multiple
1642      * passes through the array, since destructors may add things back. */
1643
1644     while (((XPVHV*)SvANY(hv))->xhv_keys) {
1645         struct xpvhv_aux *iter;
1646         HE *entry;
1647         HE ** array;
1648
1649         if (SvOOK(hv) && ((iter = HvAUX(hv)))
1650             && ((entry = iter->xhv_eiter)) )
1651         {
1652             /* the iterator may get resurrected after each
1653              * destructor call, so check each time */
1654             if (entry && HvLAZYDEL(hv)) {       /* was deleted earlier? */
1655                 HvLAZYDEL_off(hv);
1656                 hv_free_ent(hv, entry);
1657                 /* warning: at this point HvARRAY may have been
1658                  * re-allocated, HvMAX changed etc */
1659             }
1660             iter->xhv_riter = -1;       /* HvRITER(hv) = -1 */
1661             iter->xhv_eiter = NULL;     /* HvEITER(hv) = NULL */
1662         }
1663
1664         array = HvARRAY(hv);
1665         entry = array[i];
1666         if (entry) {
1667             /* Detach and free this entry. Note that destructors may be
1668              * called which will manipulate this hash, so make sure
1669              * its internal structure remains consistent throughout */
1670             array[i] = HeNEXT(entry);
1671             ((XPVHV*) SvANY(hv))->xhv_keys--;
1672
1673             if (   mpm && HeVAL(entry) && isGV(HeVAL(entry))
1674                 && GvHV(HeVAL(entry)) && HvENAME(GvHV(HeVAL(entry)))
1675             ) {
1676                 STRLEN klen;
1677                 const char * const key = HePV(entry,klen);
1678                 if ((klen > 1 && key[klen-1]==':' && key[klen-2]==':')
1679                  || (klen == 1 && key[0] == ':')) {
1680                     mro_package_moved(
1681                      NULL, GvHV(HeVAL(entry)),
1682                      (GV *)HeVAL(entry), 0
1683                     );
1684                 }
1685             }
1686             hv_free_ent(hv, entry);
1687             /* warning: at this point HvARRAY may have been
1688              * re-allocated, HvMAX changed etc */
1689             continue;
1690         }
1691         if (i++ >= HvMAX(hv))
1692             i = 0;
1693     } /* while */
1694 }
1695
1696 /*
1697 =for apidoc hv_undef
1698
1699 Undefines the hash.
1700
1701 =cut
1702 */
1703
1704 void
1705 Perl_hv_undef_flags(pTHX_ HV *hv, U32 flags)
1706 {
1707     dVAR;
1708     register XPVHV* xhv;
1709     const char *name;
1710
1711     if (!hv)
1712         return;
1713     DEBUG_A(Perl_hv_assert(aTHX_ hv));
1714     xhv = (XPVHV*)SvANY(hv);
1715
1716     /* The name must be deleted before the call to hfreeeeentries so that
1717        CVs are anonymised properly. But the effective name must be pre-
1718        served until after that call (and only deleted afterwards if the
1719        call originated from sv_clear). For stashes with one name that is
1720        both the canonical name and the effective name, hv_name_set has to
1721        allocate an array for storing the effective name. We can skip that
1722        during global destruction, as it does not matter where the CVs point
1723        if they will be freed anyway. */
1724     if (PL_phase != PERL_PHASE_DESTRUCT && (name = HvNAME(hv))) {
1725         if (PL_stashcache)
1726             (void)hv_delete(PL_stashcache, name, HvNAMELEN_get(hv), G_DISCARD);
1727         hv_name_set(hv, NULL, 0, 0);
1728     }
1729     hfreeentries(hv);
1730     if (SvOOK(hv)) {
1731       struct xpvhv_aux * const aux = HvAUX(hv);
1732       struct mro_meta *meta;
1733
1734       if ((name = HvENAME_get(hv))) {
1735         if (PL_phase != PERL_PHASE_DESTRUCT)
1736             mro_isa_changed_in(hv);
1737         if (PL_stashcache)
1738             (void)hv_delete(
1739                     PL_stashcache, name, HvENAMELEN_get(hv), G_DISCARD
1740                   );
1741       }
1742
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. */
1745       name = HvNAME(hv);
1746       if (flags & HV_NAME_SETALL ? !!aux->xhv_name_u.xhvnameu_name : !!name) {
1747         if (name && PL_stashcache)
1748             (void)hv_delete(PL_stashcache, name, HvNAMELEN_get(hv), G_DISCARD);
1749         hv_name_set(hv, NULL, 0, flags);
1750       }
1751       if((meta = aux->xhv_mro_meta)) {
1752         if (meta->mro_linear_all) {
1753             SvREFCNT_dec(MUTABLE_SV(meta->mro_linear_all));
1754             meta->mro_linear_all = NULL;
1755             /* This is just acting as a shortcut pointer.  */
1756             meta->mro_linear_current = NULL;
1757         } else if (meta->mro_linear_current) {
1758             /* Only the current MRO is stored, so this owns the data.
1759              */
1760             SvREFCNT_dec(meta->mro_linear_current);
1761             meta->mro_linear_current = NULL;
1762         }
1763         if(meta->mro_nextmethod) SvREFCNT_dec(meta->mro_nextmethod);
1764         SvREFCNT_dec(meta->isa);
1765         Safefree(meta);
1766         aux->xhv_mro_meta = NULL;
1767       }
1768       if (!aux->xhv_name_u.xhvnameu_name && ! aux->xhv_backreferences)
1769         SvFLAGS(hv) &= ~SVf_OOK;
1770     }
1771     if (!SvOOK(hv)) {
1772         Safefree(HvARRAY(hv));
1773         xhv->xhv_max   = 7;     /* HvMAX(hv) = 7 (it's a normal hash) */
1774         HvARRAY(hv) = 0;
1775     }
1776     HvPLACEHOLDERS_set(hv, 0);
1777
1778     if (SvRMAGICAL(hv))
1779         mg_clear(MUTABLE_SV(hv));
1780 }
1781
1782 /*
1783 =for apidoc hv_fill
1784
1785 Returns the number of hash buckets that happen to be in use. This function is
1786 wrapped by the macro C<HvFILL>.
1787
1788 Previously this value was stored in the HV structure, rather than being
1789 calculated on demand.
1790
1791 =cut
1792 */
1793
1794 STRLEN
1795 Perl_hv_fill(pTHX_ HV const *const hv)
1796 {
1797     STRLEN count = 0;
1798     HE **ents = HvARRAY(hv);
1799
1800     PERL_ARGS_ASSERT_HV_FILL;
1801
1802     if (ents) {
1803         HE *const *const last = ents + HvMAX(hv);
1804         count = last + 1 - ents;
1805
1806         do {
1807             if (!*ents)
1808                 --count;
1809         } while (++ents <= last);
1810     }
1811     return count;
1812 }
1813
1814 static struct xpvhv_aux*
1815 S_hv_auxinit(HV *hv) {
1816     struct xpvhv_aux *iter;
1817     char *array;
1818
1819     PERL_ARGS_ASSERT_HV_AUXINIT;
1820
1821     if (!HvARRAY(hv)) {
1822         Newxz(array, PERL_HV_ARRAY_ALLOC_BYTES(HvMAX(hv) + 1)
1823             + sizeof(struct xpvhv_aux), char);
1824     } else {
1825         array = (char *) HvARRAY(hv);
1826         Renew(array, PERL_HV_ARRAY_ALLOC_BYTES(HvMAX(hv) + 1)
1827               + sizeof(struct xpvhv_aux), char);
1828     }
1829     HvARRAY(hv) = (HE**) array;
1830     /* SvOOK_on(hv) attacks the IV flags.  */
1831     SvFLAGS(hv) |= SVf_OOK;
1832     iter = HvAUX(hv);
1833
1834     iter->xhv_riter = -1;       /* HvRITER(hv) = -1 */
1835     iter->xhv_eiter = NULL;     /* HvEITER(hv) = NULL */
1836     iter->xhv_name_u.xhvnameu_name = 0;
1837     iter->xhv_name_count = 0;
1838     iter->xhv_backreferences = 0;
1839     iter->xhv_mro_meta = NULL;
1840     return iter;
1841 }
1842
1843 /*
1844 =for apidoc hv_iterinit
1845
1846 Prepares a starting point to traverse a hash table.  Returns the number of
1847 keys in the hash (i.e. the same as C<HvUSEDKEYS(hv)>).  The return value is
1848 currently only meaningful for hashes without tie magic.
1849
1850 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1851 hash buckets that happen to be in use.  If you still need that esoteric
1852 value, you can get it through the macro C<HvFILL(hv)>.
1853
1854
1855 =cut
1856 */
1857
1858 I32
1859 Perl_hv_iterinit(pTHX_ HV *hv)
1860 {
1861     PERL_ARGS_ASSERT_HV_ITERINIT;
1862
1863     /* FIXME: Are we not NULL, or do we croak? Place bets now! */
1864
1865     if (!hv)
1866         Perl_croak(aTHX_ "Bad hash");
1867
1868     if (SvOOK(hv)) {
1869         struct xpvhv_aux * const iter = HvAUX(hv);
1870         HE * const entry = iter->xhv_eiter; /* HvEITER(hv) */
1871         if (entry && HvLAZYDEL(hv)) {   /* was deleted earlier? */
1872             HvLAZYDEL_off(hv);
1873             hv_free_ent(hv, entry);
1874         }
1875         iter->xhv_riter = -1;   /* HvRITER(hv) = -1 */
1876         iter->xhv_eiter = NULL; /* HvEITER(hv) = NULL */
1877     } else {
1878         hv_auxinit(hv);
1879     }
1880
1881     /* used to be xhv->xhv_fill before 5.004_65 */
1882     return HvTOTALKEYS(hv);
1883 }
1884
1885 I32 *
1886 Perl_hv_riter_p(pTHX_ HV *hv) {
1887     struct xpvhv_aux *iter;
1888
1889     PERL_ARGS_ASSERT_HV_RITER_P;
1890
1891     if (!hv)
1892         Perl_croak(aTHX_ "Bad hash");
1893
1894     iter = SvOOK(hv) ? HvAUX(hv) : hv_auxinit(hv);
1895     return &(iter->xhv_riter);
1896 }
1897
1898 HE **
1899 Perl_hv_eiter_p(pTHX_ HV *hv) {
1900     struct xpvhv_aux *iter;
1901
1902     PERL_ARGS_ASSERT_HV_EITER_P;
1903
1904     if (!hv)
1905         Perl_croak(aTHX_ "Bad hash");
1906
1907     iter = SvOOK(hv) ? HvAUX(hv) : hv_auxinit(hv);
1908     return &(iter->xhv_eiter);
1909 }
1910
1911 void
1912 Perl_hv_riter_set(pTHX_ HV *hv, I32 riter) {
1913     struct xpvhv_aux *iter;
1914
1915     PERL_ARGS_ASSERT_HV_RITER_SET;
1916
1917     if (!hv)
1918         Perl_croak(aTHX_ "Bad hash");
1919
1920     if (SvOOK(hv)) {
1921         iter = HvAUX(hv);
1922     } else {
1923         if (riter == -1)
1924             return;
1925
1926         iter = hv_auxinit(hv);
1927     }
1928     iter->xhv_riter = riter;
1929 }
1930
1931 void
1932 Perl_hv_eiter_set(pTHX_ HV *hv, HE *eiter) {
1933     struct xpvhv_aux *iter;
1934
1935     PERL_ARGS_ASSERT_HV_EITER_SET;
1936
1937     if (!hv)
1938         Perl_croak(aTHX_ "Bad hash");
1939
1940     if (SvOOK(hv)) {
1941         iter = HvAUX(hv);
1942     } else {
1943         /* 0 is the default so don't go malloc()ing a new structure just to
1944            hold 0.  */
1945         if (!eiter)
1946             return;
1947
1948         iter = hv_auxinit(hv);
1949     }
1950     iter->xhv_eiter = eiter;
1951 }
1952
1953 void
1954 Perl_hv_name_set(pTHX_ HV *hv, const char *name, U32 len, U32 flags)
1955 {
1956     dVAR;
1957     struct xpvhv_aux *iter;
1958     U32 hash;
1959     HEK **spot;
1960
1961     PERL_ARGS_ASSERT_HV_NAME_SET;
1962     PERL_UNUSED_ARG(flags);
1963
1964     if (len > I32_MAX)
1965         Perl_croak(aTHX_ "panic: hv name too long (%"UVuf")", (UV) len);
1966
1967     if (SvOOK(hv)) {
1968         iter = HvAUX(hv);
1969         if (iter->xhv_name_u.xhvnameu_name) {
1970             if(iter->xhv_name_count) {
1971               if(flags & HV_NAME_SETALL) {
1972                 HEK ** const name = HvAUX(hv)->xhv_name_u.xhvnameu_names;
1973                 HEK **hekp = name + (
1974                     iter->xhv_name_count < 0
1975                      ? -iter->xhv_name_count
1976                      :  iter->xhv_name_count
1977                    );
1978                 while(hekp-- > name+1) 
1979                     unshare_hek_or_pvn(*hekp, 0, 0, 0);
1980                 /* The first elem may be null. */
1981                 if(*name) unshare_hek_or_pvn(*name, 0, 0, 0);
1982                 Safefree(name);
1983                 spot = &iter->xhv_name_u.xhvnameu_name;
1984                 iter->xhv_name_count = 0;
1985               }
1986               else {
1987                 if(iter->xhv_name_count > 0) {
1988                     /* shift some things over */
1989                     Renew(
1990                      iter->xhv_name_u.xhvnameu_names, iter->xhv_name_count + 1, HEK *
1991                     );
1992                     spot = iter->xhv_name_u.xhvnameu_names;
1993                     spot[iter->xhv_name_count] = spot[1];
1994                     spot[1] = spot[0];
1995                     iter->xhv_name_count = -(iter->xhv_name_count + 1);
1996                 }
1997                 else if(*(spot = iter->xhv_name_u.xhvnameu_names)) {
1998                     unshare_hek_or_pvn(*spot, 0, 0, 0);
1999                 }
2000               }
2001             }
2002             else if (flags & HV_NAME_SETALL) {
2003                 unshare_hek_or_pvn(iter->xhv_name_u.xhvnameu_name, 0, 0, 0);
2004                 spot = &iter->xhv_name_u.xhvnameu_name;
2005             }
2006             else {
2007                 HEK * const existing_name = iter->xhv_name_u.xhvnameu_name;
2008                 Newx(iter->xhv_name_u.xhvnameu_names, 2, HEK *);
2009                 iter->xhv_name_count = -2;
2010                 spot = iter->xhv_name_u.xhvnameu_names;
2011                 spot[1] = existing_name;
2012             }
2013         }
2014         else { spot = &iter->xhv_name_u.xhvnameu_name; iter->xhv_name_count = 0; }
2015     } else {
2016         if (name == 0)
2017             return;
2018
2019         iter = hv_auxinit(hv);
2020         spot = &iter->xhv_name_u.xhvnameu_name;
2021     }
2022     PERL_HASH(hash, name, len);
2023     *spot = name ? share_hek(name, len, hash) : NULL;
2024 }
2025
2026 /*
2027 =for apidoc hv_ename_add
2028
2029 Adds a name to a stash's internal list of effective names. See
2030 C<hv_ename_delete>.
2031
2032 This is called when a stash is assigned to a new location in the symbol
2033 table.
2034
2035 =cut
2036 */
2037
2038 void
2039 Perl_hv_ename_add(pTHX_ HV *hv, const char *name, U32 len, U32 flags)
2040 {
2041     dVAR;
2042     struct xpvhv_aux *aux = SvOOK(hv) ? HvAUX(hv) : hv_auxinit(hv);
2043     U32 hash;
2044
2045     PERL_ARGS_ASSERT_HV_ENAME_ADD;
2046     PERL_UNUSED_ARG(flags);
2047
2048     if (len > I32_MAX)
2049         Perl_croak(aTHX_ "panic: hv name too long (%"UVuf")", (UV) len);
2050
2051     PERL_HASH(hash, name, len);
2052
2053     if (aux->xhv_name_count) {
2054         HEK ** const xhv_name = aux->xhv_name_u.xhvnameu_names;
2055         I32 count = aux->xhv_name_count;
2056         HEK **hekp = xhv_name + (count < 0 ? -count : count);
2057         while (hekp-- > xhv_name)
2058             if (
2059              HEK_LEN(*hekp) == (I32)len && memEQ(HEK_KEY(*hekp), name, len)
2060             ) {
2061                 if (hekp == xhv_name && count < 0)
2062                     aux->xhv_name_count = -count;
2063                 return;
2064             }
2065         if (count < 0) aux->xhv_name_count--, count = -count;
2066         else aux->xhv_name_count++;
2067         Renew(aux->xhv_name_u.xhvnameu_names, count + 1, HEK *);
2068         (aux->xhv_name_u.xhvnameu_names)[count] = share_hek(name, len, hash);
2069     }
2070     else {
2071         HEK *existing_name = aux->xhv_name_u.xhvnameu_name;
2072         if (
2073             existing_name && HEK_LEN(existing_name) == (I32)len
2074          && memEQ(HEK_KEY(existing_name), name, len)
2075         ) return;
2076         Newx(aux->xhv_name_u.xhvnameu_names, 2, HEK *);
2077         aux->xhv_name_count = existing_name ? 2 : -2;
2078         *aux->xhv_name_u.xhvnameu_names = existing_name;
2079         (aux->xhv_name_u.xhvnameu_names)[1] = share_hek(name, len, hash);
2080     }
2081 }
2082
2083 /*
2084 =for apidoc hv_ename_delete
2085
2086 Removes a name from a stash's internal list of effective names. If this is
2087 the name returned by C<HvENAME>, then another name in the list will take
2088 its place (C<HvENAME> will use it).
2089
2090 This is called when a stash is deleted from the symbol table.
2091
2092 =cut
2093 */
2094
2095 void
2096 Perl_hv_ename_delete(pTHX_ HV *hv, const char *name, U32 len, U32 flags)
2097 {
2098     dVAR;
2099     struct xpvhv_aux *aux;
2100
2101     PERL_ARGS_ASSERT_HV_ENAME_DELETE;
2102     PERL_UNUSED_ARG(flags);
2103
2104     if (len > I32_MAX)
2105         Perl_croak(aTHX_ "panic: hv name too long (%"UVuf")", (UV) len);
2106
2107     if (!SvOOK(hv)) return;
2108
2109     aux = HvAUX(hv);
2110     if (!aux->xhv_name_u.xhvnameu_name) return;
2111
2112     if (aux->xhv_name_count) {
2113         HEK ** const namep = aux->xhv_name_u.xhvnameu_names;
2114         I32 const count = aux->xhv_name_count;
2115         HEK **victim = namep + (count < 0 ? -count : count);
2116         while (victim-- > namep + 1)
2117             if (
2118                 HEK_LEN(*victim) == (I32)len
2119              && memEQ(HEK_KEY(*victim), name, len)
2120             ) {
2121                 unshare_hek_or_pvn(*victim, 0, 0, 0);
2122                 if (count < 0) ++aux->xhv_name_count;
2123                 else --aux->xhv_name_count;
2124                 if (
2125                     (aux->xhv_name_count == 1 || aux->xhv_name_count == -1)
2126                  && !*namep
2127                 ) {  /* if there are none left */
2128                     Safefree(namep);
2129                     aux->xhv_name_u.xhvnameu_names = NULL;
2130                     aux->xhv_name_count = 0;
2131                 }
2132                 else {
2133                     /* Move the last one back to fill the empty slot. It
2134                        does not matter what order they are in. */
2135                     *victim = *(namep + (count < 0 ? -count : count) - 1);
2136                 }
2137                 return;
2138             }
2139         if (
2140             count > 0 && HEK_LEN(*namep) == (I32)len
2141          && memEQ(HEK_KEY(*namep),name,len)
2142         ) {
2143             aux->xhv_name_count = -count;
2144         }
2145     }
2146     else if(
2147         HEK_LEN(aux->xhv_name_u.xhvnameu_name) == (I32)len
2148      && memEQ(HEK_KEY(aux->xhv_name_u.xhvnameu_name), name, len)
2149     ) {
2150         HEK * const namehek = aux->xhv_name_u.xhvnameu_name;
2151         Newx(aux->xhv_name_u.xhvnameu_names, 1, HEK *);
2152         *aux->xhv_name_u.xhvnameu_names = namehek;
2153         aux->xhv_name_count = -1;
2154     }
2155 }
2156
2157 AV **
2158 Perl_hv_backreferences_p(pTHX_ HV *hv) {
2159     struct xpvhv_aux * const iter = SvOOK(hv) ? HvAUX(hv) : hv_auxinit(hv);
2160
2161     PERL_ARGS_ASSERT_HV_BACKREFERENCES_P;
2162     PERL_UNUSED_CONTEXT;
2163
2164     return &(iter->xhv_backreferences);
2165 }
2166
2167 void
2168 Perl_hv_kill_backrefs(pTHX_ HV *hv) {
2169     AV *av;
2170
2171     PERL_ARGS_ASSERT_HV_KILL_BACKREFS;
2172
2173     if (!SvOOK(hv))
2174         return;
2175
2176     av = HvAUX(hv)->xhv_backreferences;
2177
2178     if (av) {
2179         HvAUX(hv)->xhv_backreferences = 0;
2180         Perl_sv_kill_backrefs(aTHX_ MUTABLE_SV(hv), av);
2181         if (SvTYPE(av) == SVt_PVAV)
2182             SvREFCNT_dec(av);
2183     }
2184 }
2185
2186 /*
2187 hv_iternext is implemented as a macro in hv.h
2188
2189 =for apidoc hv_iternext
2190
2191 Returns entries from a hash iterator.  See C<hv_iterinit>.
2192
2193 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
2194 iterator currently points to, without losing your place or invalidating your
2195 iterator.  Note that in this case the current entry is deleted from the hash
2196 with your iterator holding the last reference to it.  Your iterator is flagged
2197 to free the entry on the next call to C<hv_iternext>, so you must not discard
2198 your iterator immediately else the entry will leak - call C<hv_iternext> to
2199 trigger the resource deallocation.
2200
2201 =for apidoc hv_iternext_flags
2202
2203 Returns entries from a hash iterator.  See C<hv_iterinit> and C<hv_iternext>.
2204 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
2205 set the placeholders keys (for restricted hashes) will be returned in addition
2206 to normal keys. By default placeholders are automatically skipped over.
2207 Currently a placeholder is implemented with a value that is
2208 C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
2209 restricted hashes may change, and the implementation currently is
2210 insufficiently abstracted for any change to be tidy.
2211
2212 =cut
2213 */
2214
2215 HE *
2216 Perl_hv_iternext_flags(pTHX_ HV *hv, I32 flags)
2217 {
2218     dVAR;
2219     register XPVHV* xhv;
2220     register HE *entry;
2221     HE *oldentry;
2222     MAGIC* mg;
2223     struct xpvhv_aux *iter;
2224
2225     PERL_ARGS_ASSERT_HV_ITERNEXT_FLAGS;
2226
2227     if (!hv)
2228         Perl_croak(aTHX_ "Bad hash");
2229
2230     xhv = (XPVHV*)SvANY(hv);
2231
2232     if (!SvOOK(hv)) {
2233         /* Too many things (well, pp_each at least) merrily assume that you can
2234            call iv_iternext without calling hv_iterinit, so we'll have to deal
2235            with it.  */
2236         hv_iterinit(hv);
2237     }
2238     iter = HvAUX(hv);
2239
2240     oldentry = entry = iter->xhv_eiter; /* HvEITER(hv) */
2241     if (SvMAGICAL(hv) && SvRMAGICAL(hv)) {
2242         if ( ( mg = mg_find((const SV *)hv, PERL_MAGIC_tied) ) ) {
2243             SV * const key = sv_newmortal();
2244             if (entry) {
2245                 sv_setsv(key, HeSVKEY_force(entry));
2246                 SvREFCNT_dec(HeSVKEY(entry));       /* get rid of previous key */
2247             }
2248             else {
2249                 char *k;
2250                 HEK *hek;
2251
2252                 /* one HE per MAGICAL hash */
2253                 iter->xhv_eiter = entry = new_HE(); /* HvEITER(hv) = new_HE() */
2254                 Zero(entry, 1, HE);
2255                 Newxz(k, HEK_BASESIZE + sizeof(const SV *), char);
2256                 hek = (HEK*)k;
2257                 HeKEY_hek(entry) = hek;
2258                 HeKLEN(entry) = HEf_SVKEY;
2259             }
2260             magic_nextpack(MUTABLE_SV(hv),mg,key);
2261             if (SvOK(key)) {
2262                 /* force key to stay around until next time */
2263                 HeSVKEY_set(entry, SvREFCNT_inc_simple_NN(key));
2264                 return entry;               /* beware, hent_val is not set */
2265             }
2266             SvREFCNT_dec(HeVAL(entry));
2267             Safefree(HeKEY_hek(entry));
2268             del_HE(entry);
2269             iter->xhv_eiter = NULL; /* HvEITER(hv) = NULL */
2270             return NULL;
2271         }
2272     }
2273 #if defined(DYNAMIC_ENV_FETCH) && !defined(__riscos__)  /* set up %ENV for iteration */
2274     if (!entry && SvRMAGICAL((const SV *)hv)
2275         && mg_find((const SV *)hv, PERL_MAGIC_env)) {
2276         prime_env_iter();
2277 #ifdef VMS
2278         /* The prime_env_iter() on VMS just loaded up new hash values
2279          * so the iteration count needs to be reset back to the beginning
2280          */
2281         hv_iterinit(hv);
2282         iter = HvAUX(hv);
2283         oldentry = entry = iter->xhv_eiter; /* HvEITER(hv) */
2284 #endif
2285     }
2286 #endif
2287
2288     /* hv_iterint now ensures this.  */
2289     assert (HvARRAY(hv));
2290
2291     /* At start of hash, entry is NULL.  */
2292     if (entry)
2293     {
2294         entry = HeNEXT(entry);
2295         if (!(flags & HV_ITERNEXT_WANTPLACEHOLDERS)) {
2296             /*
2297              * Skip past any placeholders -- don't want to include them in
2298              * any iteration.
2299              */
2300             while (entry && HeVAL(entry) == &PL_sv_placeholder) {
2301                 entry = HeNEXT(entry);
2302             }
2303         }
2304     }
2305
2306     /* Skip the entire loop if the hash is empty.   */
2307     if ((flags & HV_ITERNEXT_WANTPLACEHOLDERS)
2308         ? HvTOTALKEYS(hv) : HvUSEDKEYS(hv)) {
2309         while (!entry) {
2310             /* OK. Come to the end of the current list.  Grab the next one.  */
2311
2312             iter->xhv_riter++; /* HvRITER(hv)++ */
2313             if (iter->xhv_riter > (I32)xhv->xhv_max /* HvRITER(hv) > HvMAX(hv) */) {
2314                 /* There is no next one.  End of the hash.  */
2315                 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
2316                 break;
2317             }
2318             entry = (HvARRAY(hv))[iter->xhv_riter];
2319
2320             if (!(flags & HV_ITERNEXT_WANTPLACEHOLDERS)) {
2321                 /* If we have an entry, but it's a placeholder, don't count it.
2322                    Try the next.  */
2323                 while (entry && HeVAL(entry) == &PL_sv_placeholder)
2324                     entry = HeNEXT(entry);
2325             }
2326             /* Will loop again if this linked list starts NULL
2327                (for HV_ITERNEXT_WANTPLACEHOLDERS)
2328                or if we run through it and find only placeholders.  */
2329         }
2330     }
2331
2332     if (oldentry && HvLAZYDEL(hv)) {            /* was deleted earlier? */
2333         HvLAZYDEL_off(hv);
2334         hv_free_ent(hv, oldentry);
2335     }
2336
2337     /*if (HvREHASH(hv) && entry && !HeKREHASH(entry))
2338       PerlIO_printf(PerlIO_stderr(), "Awooga %p %p\n", (void*)hv, (void*)entry);*/
2339
2340     iter->xhv_eiter = entry; /* HvEITER(hv) = entry */
2341     return entry;
2342 }
2343
2344 /*
2345 =for apidoc hv_iterkey
2346
2347 Returns the key from the current position of the hash iterator.  See
2348 C<hv_iterinit>.
2349
2350 =cut
2351 */
2352
2353 char *
2354 Perl_hv_iterkey(pTHX_ register HE *entry, I32 *retlen)
2355 {
2356     PERL_ARGS_ASSERT_HV_ITERKEY;
2357
2358     if (HeKLEN(entry) == HEf_SVKEY) {
2359         STRLEN len;
2360         char * const p = SvPV(HeKEY_sv(entry), len);
2361         *retlen = len;
2362         return p;
2363     }
2364     else {
2365         *retlen = HeKLEN(entry);
2366         return HeKEY(entry);
2367     }
2368 }
2369
2370 /* unlike hv_iterval(), this always returns a mortal copy of the key */
2371 /*
2372 =for apidoc hv_iterkeysv
2373
2374 Returns the key as an C<SV*> from the current position of the hash
2375 iterator.  The return value will always be a mortal copy of the key.  Also
2376 see C<hv_iterinit>.
2377
2378 =cut
2379 */
2380
2381 SV *
2382 Perl_hv_iterkeysv(pTHX_ register HE *entry)
2383 {
2384     PERL_ARGS_ASSERT_HV_ITERKEYSV;
2385
2386     return sv_2mortal(newSVhek(HeKEY_hek(entry)));
2387 }
2388
2389 /*
2390 =for apidoc hv_iterval
2391
2392 Returns the value from the current position of the hash iterator.  See
2393 C<hv_iterkey>.
2394
2395 =cut
2396 */
2397
2398 SV *
2399 Perl_hv_iterval(pTHX_ HV *hv, register HE *entry)
2400 {
2401     PERL_ARGS_ASSERT_HV_ITERVAL;
2402
2403     if (SvRMAGICAL(hv)) {
2404         if (mg_find((const SV *)hv, PERL_MAGIC_tied)) {
2405             SV* const sv = sv_newmortal();
2406             if (HeKLEN(entry) == HEf_SVKEY)
2407                 mg_copy(MUTABLE_SV(hv), sv, (char*)HeKEY_sv(entry), HEf_SVKEY);
2408             else
2409                 mg_copy(MUTABLE_SV(hv), sv, HeKEY(entry), HeKLEN(entry));
2410             return sv;
2411         }
2412     }
2413     return HeVAL(entry);
2414 }
2415
2416 /*
2417 =for apidoc hv_iternextsv
2418
2419 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
2420 operation.
2421
2422 =cut
2423 */
2424
2425 SV *
2426 Perl_hv_iternextsv(pTHX_ HV *hv, char **key, I32 *retlen)
2427 {
2428     HE * const he = hv_iternext_flags(hv, 0);
2429
2430     PERL_ARGS_ASSERT_HV_ITERNEXTSV;
2431
2432     if (!he)
2433         return NULL;
2434     *key = hv_iterkey(he, retlen);
2435     return hv_iterval(hv, he);
2436 }
2437
2438 /*
2439
2440 Now a macro in hv.h
2441
2442 =for apidoc hv_magic
2443
2444 Adds magic to a hash.  See C<sv_magic>.
2445
2446 =cut
2447 */
2448
2449 /* possibly free a shared string if no one has access to it
2450  * len and hash must both be valid for str.
2451  */
2452 void
2453 Perl_unsharepvn(pTHX_ const char *str, I32 len, U32 hash)
2454 {
2455     unshare_hek_or_pvn (NULL, str, len, hash);
2456 }
2457
2458
2459 void
2460 Perl_unshare_hek(pTHX_ HEK *hek)
2461 {
2462     assert(hek);
2463     unshare_hek_or_pvn(hek, NULL, 0, 0);
2464 }
2465
2466 /* possibly free a shared string if no one has access to it
2467    hek if non-NULL takes priority over the other 3, else str, len and hash
2468    are used.  If so, len and hash must both be valid for str.
2469  */
2470 STATIC void
2471 S_unshare_hek_or_pvn(pTHX_ const HEK *hek, const char *str, I32 len, U32 hash)
2472 {
2473     dVAR;
2474     register XPVHV* xhv;
2475     HE *entry;
2476     register HE **oentry;
2477     bool is_utf8 = FALSE;
2478     int k_flags = 0;
2479     const char * const save = str;
2480     struct shared_he *he = NULL;
2481
2482     if (hek) {
2483         /* Find the shared he which is just before us in memory.  */
2484         he = (struct shared_he *)(((char *)hek)
2485                                   - STRUCT_OFFSET(struct shared_he,
2486                                                   shared_he_hek));
2487
2488         /* Assert that the caller passed us a genuine (or at least consistent)
2489            shared hek  */
2490         assert (he->shared_he_he.hent_hek == hek);
2491
2492         if (he->shared_he_he.he_valu.hent_refcount - 1) {
2493             --he->shared_he_he.he_valu.hent_refcount;
2494             return;
2495         }
2496
2497         hash = HEK_HASH(hek);
2498     } else if (len < 0) {
2499         STRLEN tmplen = -len;
2500         is_utf8 = TRUE;
2501         /* See the note in hv_fetch(). --jhi */
2502         str = (char*)bytes_from_utf8((U8*)str, &tmplen, &is_utf8);
2503         len = tmplen;
2504         if (is_utf8)
2505             k_flags = HVhek_UTF8;
2506         if (str != save)
2507             k_flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
2508     }
2509
2510     /* what follows was the moral equivalent of:
2511     if ((Svp = hv_fetch(PL_strtab, tmpsv, FALSE, hash))) {
2512         if (--*Svp == NULL)
2513             hv_delete(PL_strtab, str, len, G_DISCARD, hash);
2514     } */
2515     xhv = (XPVHV*)SvANY(PL_strtab);
2516     /* assert(xhv_array != 0) */
2517     oentry = &(HvARRAY(PL_strtab))[hash & (I32) HvMAX(PL_strtab)];
2518     if (he) {
2519         const HE *const he_he = &(he->shared_he_he);
2520         for (entry = *oentry; entry; oentry = &HeNEXT(entry), entry = *oentry) {
2521             if (entry == he_he)
2522                 break;
2523         }
2524     } else {
2525         const int flags_masked = k_flags & HVhek_MASK;
2526         for (entry = *oentry; entry; oentry = &HeNEXT(entry), entry = *oentry) {
2527             if (HeHASH(entry) != hash)          /* strings can't be equal */
2528                 continue;
2529             if (HeKLEN(entry) != len)
2530                 continue;
2531             if (HeKEY(entry) != str && memNE(HeKEY(entry),str,len))     /* is this it? */
2532                 continue;
2533             if (HeKFLAGS(entry) != flags_masked)
2534                 continue;
2535             break;
2536         }
2537     }
2538
2539     if (entry) {
2540         if (--entry->he_valu.hent_refcount == 0) {
2541             *oentry = HeNEXT(entry);
2542             Safefree(entry);
2543             xhv->xhv_keys--; /* HvTOTALKEYS(hv)-- */
2544         }
2545     }
2546
2547     if (!entry)
2548         Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
2549                          "Attempt to free non-existent shared string '%s'%s"
2550                          pTHX__FORMAT,
2551                          hek ? HEK_KEY(hek) : str,
2552                          ((k_flags & HVhek_UTF8) ? " (utf8)" : "") pTHX__VALUE);
2553     if (k_flags & HVhek_FREEKEY)
2554         Safefree(str);
2555 }
2556
2557 /* get a (constant) string ptr from the global string table
2558  * string will get added if it is not already there.
2559  * len and hash must both be valid for str.
2560  */
2561 HEK *
2562 Perl_share_hek(pTHX_ const char *str, I32 len, register U32 hash)
2563 {
2564     bool is_utf8 = FALSE;
2565     int flags = 0;
2566     const char * const save = str;
2567
2568     PERL_ARGS_ASSERT_SHARE_HEK;
2569
2570     if (len < 0) {
2571       STRLEN tmplen = -len;
2572       is_utf8 = TRUE;
2573       /* See the note in hv_fetch(). --jhi */
2574       str = (char*)bytes_from_utf8((U8*)str, &tmplen, &is_utf8);
2575       len = tmplen;
2576       /* If we were able to downgrade here, then than means that we were passed
2577          in a key which only had chars 0-255, but was utf8 encoded.  */
2578       if (is_utf8)
2579           flags = HVhek_UTF8;
2580       /* If we found we were able to downgrade the string to bytes, then
2581          we should flag that it needs upgrading on keys or each.  Also flag
2582          that we need share_hek_flags to free the string.  */
2583       if (str != save)
2584           flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
2585     }
2586
2587     return share_hek_flags (str, len, hash, flags);
2588 }
2589
2590 STATIC HEK *
2591 S_share_hek_flags(pTHX_ const char *str, I32 len, register U32 hash, int flags)
2592 {
2593     dVAR;
2594     register HE *entry;
2595     const int flags_masked = flags & HVhek_MASK;
2596     const U32 hindex = hash & (I32) HvMAX(PL_strtab);
2597     register XPVHV * const xhv = (XPVHV*)SvANY(PL_strtab);
2598
2599     PERL_ARGS_ASSERT_SHARE_HEK_FLAGS;
2600
2601     /* what follows is the moral equivalent of:
2602
2603     if (!(Svp = hv_fetch(PL_strtab, str, len, FALSE)))
2604         hv_store(PL_strtab, str, len, NULL, hash);
2605
2606         Can't rehash the shared string table, so not sure if it's worth
2607         counting the number of entries in the linked list
2608     */
2609
2610     /* assert(xhv_array != 0) */
2611     entry = (HvARRAY(PL_strtab))[hindex];
2612     for (;entry; entry = HeNEXT(entry)) {
2613         if (HeHASH(entry) != hash)              /* strings can't be equal */
2614             continue;
2615         if (HeKLEN(entry) != len)
2616             continue;
2617         if (HeKEY(entry) != str && memNE(HeKEY(entry),str,len)) /* is this it? */
2618             continue;
2619         if (HeKFLAGS(entry) != flags_masked)
2620             continue;
2621         break;
2622     }
2623
2624     if (!entry) {
2625         /* What used to be head of the list.
2626            If this is NULL, then we're the first entry for this slot, which
2627            means we need to increate fill.  */
2628         struct shared_he *new_entry;
2629         HEK *hek;
2630         char *k;
2631         HE **const head = &HvARRAY(PL_strtab)[hindex];
2632         HE *const next = *head;
2633
2634         /* We don't actually store a HE from the arena and a regular HEK.
2635            Instead we allocate one chunk of memory big enough for both,
2636            and put the HEK straight after the HE. This way we can find the
2637            HEK directly from the HE.
2638         */
2639
2640         Newx(k, STRUCT_OFFSET(struct shared_he,
2641                                 shared_he_hek.hek_key[0]) + len + 2, char);
2642         new_entry = (struct shared_he *)k;
2643         entry = &(new_entry->shared_he_he);
2644         hek = &(new_entry->shared_he_hek);
2645
2646         Copy(str, HEK_KEY(hek), len, char);
2647         HEK_KEY(hek)[len] = 0;
2648         HEK_LEN(hek) = len;
2649         HEK_HASH(hek) = hash;
2650         HEK_FLAGS(hek) = (unsigned char)flags_masked;
2651
2652         /* Still "point" to the HEK, so that other code need not know what
2653            we're up to.  */
2654         HeKEY_hek(entry) = hek;
2655         entry->he_valu.hent_refcount = 0;
2656         HeNEXT(entry) = next;
2657         *head = entry;
2658
2659         xhv->xhv_keys++; /* HvTOTALKEYS(hv)++ */
2660         if (!next) {                    /* initial entry? */
2661         } else if (xhv->xhv_keys > xhv->xhv_max /* HvUSEDKEYS(hv) > HvMAX(hv) */) {
2662                 hsplit(PL_strtab);
2663         }
2664     }
2665
2666     ++entry->he_valu.hent_refcount;
2667
2668     if (flags & HVhek_FREEKEY)
2669         Safefree(str);
2670
2671     return HeKEY_hek(entry);
2672 }
2673
2674 I32 *
2675 Perl_hv_placeholders_p(pTHX_ HV *hv)
2676 {
2677     dVAR;
2678     MAGIC *mg = mg_find((const SV *)hv, PERL_MAGIC_rhash);
2679
2680     PERL_ARGS_ASSERT_HV_PLACEHOLDERS_P;
2681
2682     if (!mg) {
2683         mg = sv_magicext(MUTABLE_SV(hv), 0, PERL_MAGIC_rhash, 0, 0, 0);
2684
2685         if (!mg) {
2686             Perl_die(aTHX_ "panic: hv_placeholders_p");
2687         }
2688     }
2689     return &(mg->mg_len);
2690 }
2691
2692
2693 I32
2694 Perl_hv_placeholders_get(pTHX_ const HV *hv)
2695 {
2696     dVAR;
2697     MAGIC * const mg = mg_find((const SV *)hv, PERL_MAGIC_rhash);
2698
2699     PERL_ARGS_ASSERT_HV_PLACEHOLDERS_GET;
2700
2701     return mg ? mg->mg_len : 0;
2702 }
2703
2704 void
2705 Perl_hv_placeholders_set(pTHX_ HV *hv, I32 ph)
2706 {
2707     dVAR;
2708     MAGIC * const mg = mg_find((const SV *)hv, PERL_MAGIC_rhash);
2709
2710     PERL_ARGS_ASSERT_HV_PLACEHOLDERS_SET;
2711
2712     if (mg) {
2713         mg->mg_len = ph;
2714     } else if (ph) {
2715         if (!sv_magicext(MUTABLE_SV(hv), 0, PERL_MAGIC_rhash, 0, 0, ph))
2716             Perl_die(aTHX_ "panic: hv_placeholders_set");
2717     }
2718     /* else we don't need to add magic to record 0 placeholders.  */
2719 }
2720
2721 STATIC SV *
2722 S_refcounted_he_value(pTHX_ const struct refcounted_he *he)
2723 {
2724     dVAR;
2725     SV *value;
2726
2727     PERL_ARGS_ASSERT_REFCOUNTED_HE_VALUE;
2728
2729     switch(he->refcounted_he_data[0] & HVrhek_typemask) {
2730     case HVrhek_undef:
2731         value = newSV(0);
2732         break;
2733     case HVrhek_delete:
2734         value = &PL_sv_placeholder;
2735         break;
2736     case HVrhek_IV:
2737         value = newSViv(he->refcounted_he_val.refcounted_he_u_iv);
2738         break;
2739     case HVrhek_UV:
2740         value = newSVuv(he->refcounted_he_val.refcounted_he_u_uv);
2741         break;
2742     case HVrhek_PV:
2743     case HVrhek_PV_UTF8:
2744         /* Create a string SV that directly points to the bytes in our
2745            structure.  */
2746         value = newSV_type(SVt_PV);
2747         SvPV_set(value, (char *) he->refcounted_he_data + 1);
2748         SvCUR_set(value, he->refcounted_he_val.refcounted_he_u_len);
2749         /* This stops anything trying to free it  */
2750         SvLEN_set(value, 0);
2751         SvPOK_on(value);
2752         SvREADONLY_on(value);
2753         if ((he->refcounted_he_data[0] & HVrhek_typemask) == HVrhek_PV_UTF8)
2754             SvUTF8_on(value);
2755         break;
2756     default:
2757         Perl_croak(aTHX_ "panic: refcounted_he_value bad flags %"UVxf,
2758                    (UV)he->refcounted_he_data[0]);
2759     }
2760     return value;
2761 }
2762
2763 /*
2764 =for apidoc m|HV *|refcounted_he_chain_2hv|const struct refcounted_he *c|U32 flags
2765
2766 Generates and returns a C<HV *> representing the content of a
2767 C<refcounted_he> chain.
2768 I<flags> is currently unused and must be zero.
2769
2770 =cut
2771 */
2772 HV *
2773 Perl_refcounted_he_chain_2hv(pTHX_ const struct refcounted_he *chain, U32 flags)
2774 {
2775     dVAR;
2776     HV *hv;
2777     U32 placeholders, max;
2778
2779     if (flags)
2780         Perl_croak(aTHX_ "panic: refcounted_he_chain_2hv bad flags %"UVxf,
2781             (UV)flags);
2782
2783     /* We could chase the chain once to get an idea of the number of keys,
2784        and call ksplit.  But for now we'll make a potentially inefficient
2785        hash with only 8 entries in its array.  */
2786     hv = newHV();
2787     max = HvMAX(hv);
2788     if (!HvARRAY(hv)) {
2789         char *array;
2790         Newxz(array, PERL_HV_ARRAY_ALLOC_BYTES(max + 1), char);
2791         HvARRAY(hv) = (HE**)array;
2792     }
2793
2794     placeholders = 0;
2795     while (chain) {
2796 #ifdef USE_ITHREADS
2797         U32 hash = chain->refcounted_he_hash;
2798 #else
2799         U32 hash = HEK_HASH(chain->refcounted_he_hek);
2800 #endif
2801         HE **oentry = &((HvARRAY(hv))[hash & max]);
2802         HE *entry = *oentry;
2803         SV *value;
2804
2805         for (; entry; entry = HeNEXT(entry)) {
2806             if (HeHASH(entry) == hash) {
2807                 /* We might have a duplicate key here.  If so, entry is older
2808                    than the key we've already put in the hash, so if they are
2809                    the same, skip adding entry.  */
2810 #ifdef USE_ITHREADS
2811                 const STRLEN klen = HeKLEN(entry);
2812                 const char *const key = HeKEY(entry);
2813                 if (klen == chain->refcounted_he_keylen
2814                     && (!!HeKUTF8(entry)
2815                         == !!(chain->refcounted_he_data[0] & HVhek_UTF8))
2816                     && memEQ(key, REF_HE_KEY(chain), klen))
2817                     goto next_please;
2818 #else
2819                 if (HeKEY_hek(entry) == chain->refcounted_he_hek)
2820                     goto next_please;
2821                 if (HeKLEN(entry) == HEK_LEN(chain->refcounted_he_hek)
2822                     && HeKUTF8(entry) == HEK_UTF8(chain->refcounted_he_hek)
2823                     && memEQ(HeKEY(entry), HEK_KEY(chain->refcounted_he_hek),
2824                              HeKLEN(entry)))
2825                     goto next_please;
2826 #endif
2827             }
2828         }
2829         assert (!entry);
2830         entry = new_HE();
2831
2832 #ifdef USE_ITHREADS
2833         HeKEY_hek(entry)
2834             = share_hek_flags(REF_HE_KEY(chain),
2835                               chain->refcounted_he_keylen,
2836                               chain->refcounted_he_hash,
2837                               (chain->refcounted_he_data[0]
2838                                & (HVhek_UTF8|HVhek_WASUTF8)));
2839 #else
2840         HeKEY_hek(entry) = share_hek_hek(chain->refcounted_he_hek);
2841 #endif
2842         value = refcounted_he_value(chain);
2843         if (value == &PL_sv_placeholder)
2844             placeholders++;
2845         HeVAL(entry) = value;
2846
2847         /* Link it into the chain.  */
2848         HeNEXT(entry) = *oentry;
2849         *oentry = entry;
2850
2851         HvTOTALKEYS(hv)++;
2852
2853     next_please:
2854         chain = chain->refcounted_he_next;
2855     }
2856
2857     if (placeholders) {
2858         clear_placeholders(hv, placeholders);
2859         HvTOTALKEYS(hv) -= placeholders;
2860     }
2861
2862     /* We could check in the loop to see if we encounter any keys with key
2863        flags, but it's probably not worth it, as this per-hash flag is only
2864        really meant as an optimisation for things like Storable.  */
2865     HvHASKFLAGS_on(hv);
2866     DEBUG_A(Perl_hv_assert(aTHX_ hv));
2867
2868     return hv;
2869 }
2870
2871 /*
2872 =for apidoc m|SV *|refcounted_he_fetch_pvn|const struct refcounted_he *chain|const char *keypv|STRLEN keylen|U32 hash|U32 flags
2873
2874 Search along a C<refcounted_he> chain for an entry with the key specified
2875 by I<keypv> and I<keylen>.  If I<flags> has the C<REFCOUNTED_HE_KEY_UTF8>
2876 bit set, the key octets are interpreted as UTF-8, otherwise they
2877 are interpreted as Latin-1.  I<hash> is a precomputed hash of the key
2878 string, or zero if it has not been precomputed.  Returns a mortal scalar
2879 representing the value associated with the key, or C<&PL_sv_placeholder>
2880 if there is no value associated with the key.
2881
2882 =cut
2883 */
2884
2885 SV *
2886 Perl_refcounted_he_fetch_pvn(pTHX_ const struct refcounted_he *chain,
2887                          const char *keypv, STRLEN keylen, U32 hash, U32 flags)
2888 {
2889     dVAR;
2890     U8 utf8_flag;
2891     PERL_ARGS_ASSERT_REFCOUNTED_HE_FETCH_PVN;
2892
2893     if (flags & ~REFCOUNTED_HE_KEY_UTF8)
2894         Perl_croak(aTHX_ "panic: refcounted_he_fetch_pvn bad flags %"UVxf,
2895             (UV)flags);
2896     if (!chain)
2897         return &PL_sv_placeholder;
2898     if (flags & REFCOUNTED_HE_KEY_UTF8) {
2899         /* For searching purposes, canonicalise to Latin-1 where possible. */
2900         const char *keyend = keypv + keylen, *p;
2901         STRLEN nonascii_count = 0;
2902         for (p = keypv; p != keyend; p++) {
2903             U8 c = (U8)*p;
2904             if (c & 0x80) {
2905                 if (!((c & 0xfe) == 0xc2 && ++p != keyend &&
2906                             (((U8)*p) & 0xc0) == 0x80))
2907                     goto canonicalised_key;
2908                 nonascii_count++;
2909             }
2910         }
2911         if (nonascii_count) {
2912             char *q;
2913             const char *p = keypv, *keyend = keypv + keylen;
2914             keylen -= nonascii_count;
2915             Newx(q, keylen, char);
2916             SAVEFREEPV(q);
2917             keypv = q;
2918             for (; p != keyend; p++, q++) {
2919                 U8 c = (U8)*p;
2920                 *q = (char)
2921                     ((c & 0x80) ? ((c & 0x03) << 6) | (((U8)*++p) & 0x3f) : c);
2922             }
2923         }
2924         flags &= ~REFCOUNTED_HE_KEY_UTF8;
2925         canonicalised_key: ;
2926     }
2927     utf8_flag = (flags & REFCOUNTED_HE_KEY_UTF8) ? HVhek_UTF8 : 0;
2928     if (!hash)
2929         PERL_HASH(hash, keypv, keylen);
2930
2931     for (; chain; chain = chain->refcounted_he_next) {
2932         if (
2933 #ifdef USE_ITHREADS
2934             hash == chain->refcounted_he_hash &&
2935             keylen == chain->refcounted_he_keylen &&
2936             memEQ(REF_HE_KEY(chain), keypv, keylen) &&
2937             utf8_flag == (chain->refcounted_he_data[0] & HVhek_UTF8)
2938 #else
2939             hash == HEK_HASH(chain->refcounted_he_hek) &&
2940             keylen == (STRLEN)HEK_LEN(chain->refcounted_he_hek) &&
2941             memEQ(HEK_KEY(chain->refcounted_he_hek), keypv, keylen) &&
2942             utf8_flag == (HEK_FLAGS(chain->refcounted_he_hek) & HVhek_UTF8)
2943 #endif
2944         )
2945             return sv_2mortal(refcounted_he_value(chain));
2946     }
2947     return &PL_sv_placeholder;
2948 }
2949
2950 /*
2951 =for apidoc m|SV *|refcounted_he_fetch_pv|const struct refcounted_he *chain|const char *key|U32 hash|U32 flags
2952
2953 Like L</refcounted_he_fetch_pvn>, but takes a nul-terminated string
2954 instead of a string/length pair.
2955
2956 =cut
2957 */
2958
2959 SV *
2960 Perl_refcounted_he_fetch_pv(pTHX_ const struct refcounted_he *chain,
2961                          const char *key, U32 hash, U32 flags)
2962 {
2963     PERL_ARGS_ASSERT_REFCOUNTED_HE_FETCH_PV;
2964     return refcounted_he_fetch_pvn(chain, key, strlen(key), hash, flags);
2965 }
2966
2967 /*
2968 =for apidoc m|SV *|refcounted_he_fetch_sv|const struct refcounted_he *chain|SV *key|U32 hash|U32 flags
2969
2970 Like L</refcounted_he_fetch_pvn>, but takes a Perl scalar instead of a
2971 string/length pair.
2972
2973 =cut
2974 */
2975
2976 SV *
2977 Perl_refcounted_he_fetch_sv(pTHX_ const struct refcounted_he *chain,
2978                          SV *key, U32 hash, U32 flags)
2979 {
2980     const char *keypv;
2981     STRLEN keylen;
2982     PERL_ARGS_ASSERT_REFCOUNTED_HE_FETCH_SV;
2983     if (flags & REFCOUNTED_HE_KEY_UTF8)
2984         Perl_croak(aTHX_ "panic: refcounted_he_fetch_sv bad flags %"UVxf,
2985             (UV)flags);
2986     keypv = SvPV_const(key, keylen);
2987     if (SvUTF8(key))
2988         flags |= REFCOUNTED_HE_KEY_UTF8;
2989     if (!hash && SvIsCOW_shared_hash(key))
2990         hash = SvSHARED_HASH(key);
2991     return refcounted_he_fetch_pvn(chain, keypv, keylen, hash, flags);
2992 }
2993
2994 /*
2995 =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
2996
2997 Creates a new C<refcounted_he>.  This consists of a single key/value
2998 pair and a reference to an existing C<refcounted_he> chain (which may
2999 be empty), and thus forms a longer chain.  When using the longer chain,
3000 the new key/value pair takes precedence over any entry for the same key
3001 further along the chain.
3002
3003 The new key is specified by I<keypv> and I<keylen>.  If I<flags> has
3004 the C<REFCOUNTED_HE_KEY_UTF8> bit set, the key octets are interpreted
3005 as UTF-8, otherwise they are interpreted as Latin-1.  I<hash> is
3006 a precomputed hash of the key string, or zero if it has not been
3007 precomputed.
3008
3009 I<value> is the scalar value to store for this key.  I<value> is copied
3010 by this function, which thus does not take ownership of any reference
3011 to it, and later changes to the scalar will not be reflected in the
3012 value visible in the C<refcounted_he>.  Complex types of scalar will not
3013 be stored with referential integrity, but will be coerced to strings.
3014 I<value> may be either null or C<&PL_sv_placeholder> to indicate that no
3015 value is to be associated with the key; this, as with any non-null value,
3016 takes precedence over the existence of a value for the key further along
3017 the chain.
3018
3019 I<parent> points to the rest of the C<refcounted_he> chain to be
3020 attached to the new C<refcounted_he>.  This function takes ownership
3021 of one reference to I<parent>, and returns one reference to the new
3022 C<refcounted_he>.
3023
3024 =cut
3025 */
3026
3027 struct refcounted_he *
3028 Perl_refcounted_he_new_pvn(pTHX_ struct refcounted_he *parent,
3029         const char *keypv, STRLEN keylen, U32 hash, SV *value, U32 flags)
3030 {
3031     dVAR;
3032     STRLEN value_len = 0;
3033     const char *value_p = NULL;
3034     bool is_pv;
3035     char value_type;
3036     char hekflags;
3037     STRLEN key_offset = 1;
3038     struct refcounted_he *he;
3039     PERL_ARGS_ASSERT_REFCOUNTED_HE_NEW_PVN;
3040
3041     if (!value || value == &PL_sv_placeholder) {
3042         value_type = HVrhek_delete;
3043     } else if (SvPOK(value)) {
3044         value_type = HVrhek_PV;
3045     } else if (SvIOK(value)) {
3046         value_type = SvUOK((const SV *)value) ? HVrhek_UV : HVrhek_IV;
3047     } else if (!SvOK(value)) {
3048         value_type = HVrhek_undef;
3049     } else {
3050         value_type = HVrhek_PV;
3051     }
3052     is_pv = value_type == HVrhek_PV;
3053     if (is_pv) {
3054         /* Do it this way so that the SvUTF8() test is after the SvPV, in case
3055            the value is overloaded, and doesn't yet have the UTF-8flag set.  */
3056         value_p = SvPV_const(value, value_len);
3057         if (SvUTF8(value))
3058             value_type = HVrhek_PV_UTF8;
3059         key_offset = value_len + 2;
3060     }
3061     hekflags = value_type;
3062
3063     if (flags & REFCOUNTED_HE_KEY_UTF8) {
3064         /* Canonicalise to Latin-1 where possible. */
3065         const char *keyend = keypv + keylen, *p;
3066         STRLEN nonascii_count = 0;
3067         for (p = keypv; p != keyend; p++) {
3068             U8 c = (U8)*p;
3069             if (c & 0x80) {
3070                 if (!((c & 0xfe) == 0xc2 && ++p != keyend &&
3071                             (((U8)*p) & 0xc0) == 0x80))
3072                     goto canonicalised_key;
3073                 nonascii_count++;
3074             }
3075         }
3076         if (nonascii_count) {
3077             char *q;
3078             const char *p = keypv, *keyend = keypv + keylen;
3079             keylen -= nonascii_count;
3080             Newx(q, keylen, char);
3081             SAVEFREEPV(q);
3082             keypv = q;
3083             for (; p != keyend; p++, q++) {
3084                 U8 c = (U8)*p;
3085                 *q = (char)
3086                     ((c & 0x80) ? ((c & 0x03) << 6) | (((U8)*++p) & 0x3f) : c);
3087             }
3088         }
3089         flags &= ~REFCOUNTED_HE_KEY_UTF8;
3090         canonicalised_key: ;
3091     }
3092     if (flags & REFCOUNTED_HE_KEY_UTF8)
3093         hekflags |= HVhek_UTF8;
3094     if (!hash)
3095         PERL_HASH(hash, keypv, keylen);
3096
3097 #ifdef USE_ITHREADS
3098     he = (struct refcounted_he*)
3099         PerlMemShared_malloc(sizeof(struct refcounted_he) - 1
3100                              + keylen
3101                              + key_offset);
3102 #else
3103     he = (struct refcounted_he*)
3104         PerlMemShared_malloc(sizeof(struct refcounted_he) - 1
3105                              + key_offset);
3106 #endif
3107
3108     he->refcounted_he_next = parent;
3109
3110     if (is_pv) {
3111         Copy(value_p, he->refcounted_he_data + 1, value_len + 1, char);
3112         he->refcounted_he_val.refcounted_he_u_len = value_len;
3113     } else if (value_type == HVrhek_IV) {
3114         he->refcounted_he_val.refcounted_he_u_iv = SvIVX(value);
3115     } else if (value_type == HVrhek_UV) {
3116         he->refcounted_he_val.refcounted_he_u_uv = SvUVX(value);
3117     }
3118
3119 #ifdef USE_ITHREADS
3120     he->refcounted_he_hash = hash;
3121     he->refcounted_he_keylen = keylen;
3122     Copy(keypv, he->refcounted_he_data + key_offset, keylen, char);
3123 #else
3124     he->refcounted_he_hek = share_hek_flags(keypv, keylen, hash, hekflags);
3125 #endif
3126
3127     he->refcounted_he_data[0] = hekflags;
3128     he->refcounted_he_refcnt = 1;
3129
3130     return he;
3131 }
3132
3133 /*
3134 =for apidoc m|struct refcounted_he *|refcounted_he_new_pv|struct refcounted_he *parent|const char *key|U32 hash|SV *value|U32 flags
3135
3136 Like L</refcounted_he_new_pvn>, but takes a nul-terminated string instead
3137 of a string/length pair.
3138
3139 =cut
3140 */
3141
3142 struct refcounted_he *
3143 Perl_refcounted_he_new_pv(pTHX_ struct refcounted_he *parent,
3144         const char *key, U32 hash, SV *value, U32 flags)
3145 {
3146     PERL_ARGS_ASSERT_REFCOUNTED_HE_NEW_PV;
3147     return refcounted_he_new_pvn(parent, key, strlen(key), hash, value, flags);
3148 }
3149
3150 /*
3151 =for apidoc m|struct refcounted_he *|refcounted_he_new_sv|struct refcounted_he *parent|SV *key|U32 hash|SV *value|U32 flags
3152
3153 Like L</refcounted_he_new_pvn>, but takes a Perl scalar instead of a
3154 string/length pair.
3155
3156 =cut
3157 */
3158
3159 struct refcounted_he *
3160 Perl_refcounted_he_new_sv(pTHX_ struct refcounted_he *parent,
3161         SV *key, U32 hash, SV *value, U32 flags)
3162 {
3163     const char *keypv;
3164     STRLEN keylen;
3165     PERL_ARGS_ASSERT_REFCOUNTED_HE_NEW_SV;
3166     if (flags & REFCOUNTED_HE_KEY_UTF8)
3167         Perl_croak(aTHX_ "panic: refcounted_he_new_sv bad flags %"UVxf,
3168             (UV)flags);
3169     keypv = SvPV_const(key, keylen);
3170     if (SvUTF8(key))
3171         flags |= REFCOUNTED_HE_KEY_UTF8;
3172     if (!hash && SvIsCOW_shared_hash(key))
3173         hash = SvSHARED_HASH(key);
3174     return refcounted_he_new_pvn(parent, keypv, keylen, hash, value, flags);
3175 }
3176
3177 /*
3178 =for apidoc m|void|refcounted_he_free|struct refcounted_he *he
3179
3180 Decrements the reference count of a C<refcounted_he> by one.  If the
3181 reference count reaches zero the structure's memory is freed, which
3182 (recursively) causes a reduction of its parent C<refcounted_he>'s
3183 reference count.  It is safe to pass a null pointer to this function:
3184 no action occurs in this case.
3185
3186 =cut
3187 */
3188
3189 void
3190 Perl_refcounted_he_free(pTHX_ struct refcounted_he *he) {
3191     dVAR;
3192     PERL_UNUSED_CONTEXT;
3193
3194     while (he) {
3195         struct refcounted_he *copy;
3196         U32 new_count;
3197
3198         HINTS_REFCNT_LOCK;
3199         new_count = --he->refcounted_he_refcnt;
3200         HINTS_REFCNT_UNLOCK;
3201         
3202         if (new_count) {
3203             return;
3204         }
3205
3206 #ifndef USE_ITHREADS
3207         unshare_hek_or_pvn (he->refcounted_he_hek, 0, 0, 0);
3208 #endif
3209         copy = he;
3210         he = he->refcounted_he_next;
3211         PerlMemShared_free(copy);
3212     }
3213 }
3214
3215 /*
3216 =for apidoc m|struct refcounted_he *|refcounted_he_inc|struct refcounted_he *he
3217
3218 Increment the reference count of a C<refcounted_he>.  The pointer to the
3219 C<refcounted_he> is also returned.  It is safe to pass a null pointer
3220 to this function: no action occurs and a null pointer is returned.
3221
3222 =cut
3223 */
3224
3225 struct refcounted_he *
3226 Perl_refcounted_he_inc(pTHX_ struct refcounted_he *he)
3227 {
3228     if (he) {
3229         HINTS_REFCNT_LOCK;
3230         he->refcounted_he_refcnt++;
3231         HINTS_REFCNT_UNLOCK;
3232     }
3233     return he;
3234 }
3235
3236 /* pp_entereval is aware that labels are stored with a key ':' at the top of
3237    the linked list.  */
3238 const char *
3239 Perl_fetch_cop_label(pTHX_ COP *const cop, STRLEN *len, U32 *flags) {
3240     struct refcounted_he *const chain = cop->cop_hints_hash;
3241
3242     PERL_ARGS_ASSERT_FETCH_COP_LABEL;
3243
3244     if (!chain)
3245         return NULL;
3246 #ifdef USE_ITHREADS
3247     if (chain->refcounted_he_keylen != 1)
3248         return NULL;
3249     if (*REF_HE_KEY(chain) != ':')
3250         return NULL;
3251 #else
3252     if ((STRLEN)HEK_LEN(chain->refcounted_he_hek) != 1)
3253         return NULL;
3254     if (*HEK_KEY(chain->refcounted_he_hek) != ':')
3255         return NULL;
3256 #endif
3257     /* Stop anyone trying to really mess us up by adding their own value for
3258        ':' into %^H  */
3259     if ((chain->refcounted_he_data[0] & HVrhek_typemask) != HVrhek_PV
3260         && (chain->refcounted_he_data[0] & HVrhek_typemask) != HVrhek_PV_UTF8)
3261         return NULL;
3262
3263     if (len)
3264         *len = chain->refcounted_he_val.refcounted_he_u_len;
3265     if (flags) {
3266         *flags = ((chain->refcounted_he_data[0] & HVrhek_typemask)
3267                   == HVrhek_PV_UTF8) ? SVf_UTF8 : 0;
3268     }
3269     return chain->refcounted_he_data + 1;
3270 }
3271
3272 void
3273 Perl_store_cop_label(pTHX_ COP *const cop, const char *label, STRLEN len,
3274                      U32 flags)
3275 {
3276     SV *labelsv;
3277     PERL_ARGS_ASSERT_STORE_COP_LABEL;
3278
3279     if (flags & ~(SVf_UTF8))
3280         Perl_croak(aTHX_ "panic: store_cop_label illegal flag bits 0x%" UVxf,
3281                    (UV)flags);
3282     labelsv = newSVpvn_flags(label, len, SVs_TEMP);
3283     if (flags & SVf_UTF8)
3284         SvUTF8_on(labelsv);
3285     cop->cop_hints_hash
3286         = refcounted_he_new_pvs(cop->cop_hints_hash, ":", labelsv, 0);
3287 }
3288
3289 /*
3290 =for apidoc hv_assert
3291
3292 Check that a hash is in an internally consistent state.
3293
3294 =cut
3295 */
3296
3297 #ifdef DEBUGGING
3298
3299 void
3300 Perl_hv_assert(pTHX_ HV *hv)
3301 {
3302     dVAR;
3303     HE* entry;
3304     int withflags = 0;
3305     int placeholders = 0;
3306     int real = 0;
3307     int bad = 0;
3308     const I32 riter = HvRITER_get(hv);
3309     HE *eiter = HvEITER_get(hv);
3310
3311     PERL_ARGS_ASSERT_HV_ASSERT;
3312
3313     (void)hv_iterinit(hv);
3314
3315     while ((entry = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS))) {
3316         /* sanity check the values */
3317         if (HeVAL(entry) == &PL_sv_placeholder)
3318             placeholders++;
3319         else
3320             real++;
3321         /* sanity check the keys */
3322         if (HeSVKEY(entry)) {
3323             NOOP;   /* Don't know what to check on SV keys.  */
3324         } else if (HeKUTF8(entry)) {
3325             withflags++;
3326             if (HeKWASUTF8(entry)) {
3327                 PerlIO_printf(Perl_debug_log,
3328                             "hash key has both WASUTF8 and UTF8: '%.*s'\n",
3329                             (int) HeKLEN(entry),  HeKEY(entry));
3330                 bad = 1;
3331             }
3332         } else if (HeKWASUTF8(entry))
3333             withflags++;
3334     }
3335     if (!SvTIED_mg((const SV *)hv, PERL_MAGIC_tied)) {
3336         static const char bad_count[] = "Count %d %s(s), but hash reports %d\n";
3337         const int nhashkeys = HvUSEDKEYS(hv);
3338         const int nhashplaceholders = HvPLACEHOLDERS_get(hv);
3339
3340         if (nhashkeys != real) {
3341             PerlIO_printf(Perl_debug_log, bad_count, real, "keys", nhashkeys );
3342             bad = 1;
3343         }
3344         if (nhashplaceholders != placeholders) {
3345             PerlIO_printf(Perl_debug_log, bad_count, placeholders, "placeholder", nhashplaceholders );
3346             bad = 1;
3347         }
3348     }
3349     if (withflags && ! HvHASKFLAGS(hv)) {
3350         PerlIO_printf(Perl_debug_log,
3351                     "Hash has HASKFLAGS off but I count %d key(s) with flags\n",
3352                     withflags);
3353         bad = 1;
3354     }
3355     if (bad) {
3356         sv_dump(MUTABLE_SV(hv));
3357     }
3358     HvRITER_set(hv, riter);             /* Restore hash iterator state */
3359     HvEITER_set(hv, eiter);
3360 }
3361
3362 #endif
3363
3364 /*
3365  * Local variables:
3366  * c-indentation-style: bsd
3367  * c-basic-offset: 4
3368  * indent-tabs-mode: t
3369  * End:
3370  *
3371  * ex: set ts=8 sts=4 sw=4 noet:
3372  */