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