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