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