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