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