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