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