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