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