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