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