This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
3f100e60a011675e3c0757664dc43ed8614f366c
[perl5.git] / hv.c
1 /*    hv.c
2  *
3  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4  *    2000, 2001, 2002, 2003, 2004, 2005, 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 of all that I have seen."  --Bilbo
13  */
14
15 /* 
16 =head1 Hash Manipulation Functions
17
18 A HV structure represents a Perl hash. It consists mainly of an array
19 of pointers, each of which points to a linked list of HE structures. The
20 array is indexed by the hash function of the key, so each linked list
21 represents all the hash entries with the same hash value. Each HE contains
22 a pointer to the actual value, plus a pointer to a HEK structure which
23 holds the key and hash value.
24
25 =cut
26
27 */
28
29 #include "EXTERN.h"
30 #define PERL_IN_HV_C
31 #define PERL_HASH_INTERNAL_ACCESS
32 #include "perl.h"
33
34 #define HV_MAX_LENGTH_BEFORE_SPLIT 14
35
36 STATIC void
37 S_more_he(pTHX)
38 {
39     HE* he;
40     HE* heend;
41     New(54, he, PERL_ARENA_SIZE/sizeof(HE), HE);
42     HeNEXT(he) = PL_he_arenaroot;
43     PL_he_arenaroot = he;
44
45     heend = &he[PERL_ARENA_SIZE / sizeof(HE) - 1];
46     PL_he_root = ++he;
47     while (he < heend) {
48         HeNEXT(he) = (HE*)(he + 1);
49         he++;
50     }
51     HeNEXT(he) = 0;
52 }
53
54 STATIC HE*
55 S_new_he(pTHX)
56 {
57     HE* he;
58     LOCK_SV_MUTEX;
59     if (!PL_he_root)
60         S_more_he(aTHX);
61     he = PL_he_root;
62     PL_he_root = HeNEXT(he);
63     UNLOCK_SV_MUTEX;
64     return he;
65 }
66
67 STATIC void
68 S_del_he(pTHX_ HE *p)
69 {
70     LOCK_SV_MUTEX;
71     HeNEXT(p) = (HE*)PL_he_root;
72     PL_he_root = p;
73     UNLOCK_SV_MUTEX;
74 }
75
76 #ifdef PURIFY
77
78 #define new_HE() (HE*)safemalloc(sizeof(HE))
79 #define del_HE(p) safefree((char*)p)
80
81 #else
82
83 #define new_HE() new_he()
84 #define del_HE(p) del_he(p)
85
86 #endif
87
88 STATIC HEK *
89 S_save_hek_flags(pTHX_ const char *str, I32 len, U32 hash, int flags)
90 {
91     const int flags_masked = flags & HVhek_MASK;
92     char *k;
93     register HEK *hek;
94
95     New(54, k, HEK_BASESIZE + len + 2, char);
96     hek = (HEK*)k;
97     Copy(str, HEK_KEY(hek), len, char);
98     HEK_KEY(hek)[len] = 0;
99     HEK_LEN(hek) = len;
100     HEK_HASH(hek) = hash;
101     HEK_FLAGS(hek) = (unsigned char)flags_masked;
102
103     if (flags & HVhek_FREEKEY)
104         Safefree(str);
105     return hek;
106 }
107
108 /* free the pool of temporary HE/HEK pairs retunrned by hv_fetch_ent
109  * for tied hashes */
110
111 void
112 Perl_free_tied_hv_pool(pTHX)
113 {
114     HE *ohe;
115     HE *he = PL_hv_fetch_ent_mh;
116     while (he) {
117         Safefree(HeKEY_hek(he));
118         ohe = he;
119         he = HeNEXT(he);
120         del_HE(ohe);
121     }
122     PL_hv_fetch_ent_mh = Nullhe;
123 }
124
125 #if defined(USE_ITHREADS)
126 HE *
127 Perl_he_dup(pTHX_ HE *e, bool shared, CLONE_PARAMS* param)
128 {
129     HE *ret;
130
131     if (!e)
132         return Nullhe;
133     /* look for it in the table first */
134     ret = (HE*)ptr_table_fetch(PL_ptr_table, e);
135     if (ret)
136         return ret;
137
138     /* create anew and remember what it is */
139     ret = new_HE();
140     ptr_table_store(PL_ptr_table, e, ret);
141
142     HeNEXT(ret) = he_dup(HeNEXT(e),shared, param);
143     if (HeKLEN(e) == HEf_SVKEY) {
144         char *k;
145         New(54, k, HEK_BASESIZE + sizeof(SV*), char);
146         HeKEY_hek(ret) = (HEK*)k;
147         HeKEY_sv(ret) = SvREFCNT_inc(sv_dup(HeKEY_sv(e), param));
148     }
149     else if (shared)
150         HeKEY_hek(ret) = share_hek_flags(HeKEY(e), HeKLEN(e), HeHASH(e),
151                                          HeKFLAGS(e));
152     else
153         HeKEY_hek(ret) = save_hek_flags(HeKEY(e), HeKLEN(e), HeHASH(e),
154                                         HeKFLAGS(e));
155     HeVAL(ret) = SvREFCNT_inc(sv_dup(HeVAL(e), param));
156     return ret;
157 }
158 #endif  /* USE_ITHREADS */
159
160 static void
161 S_hv_notallowed(pTHX_ int flags, const char *key, I32 klen,
162                 const char *msg)
163 {
164     SV *sv = sv_newmortal();
165     if (!(flags & HVhek_FREEKEY)) {
166         sv_setpvn(sv, key, klen);
167     }
168     else {
169         /* Need to free saved eventually assign to mortal SV */
170         /* XXX is this line an error ???:  SV *sv = sv_newmortal(); */
171         sv_usepvn(sv, (char *) key, klen);
172     }
173     if (flags & HVhek_UTF8) {
174         SvUTF8_on(sv);
175     }
176     Perl_croak(aTHX_ msg, sv);
177 }
178
179 /* (klen == HEf_SVKEY) is special for MAGICAL hv entries, meaning key slot
180  * contains an SV* */
181
182 #define HV_FETCH_ISSTORE   0x01
183 #define HV_FETCH_ISEXISTS  0x02
184 #define HV_FETCH_LVALUE    0x04
185 #define HV_FETCH_JUST_SV   0x08
186
187 /*
188 =for apidoc hv_store
189
190 Stores an SV in a hash.  The hash key is specified as C<key> and C<klen> is
191 the length of the key.  The C<hash> parameter is the precomputed hash
192 value; if it is zero then Perl will compute it.  The return value will be
193 NULL if the operation failed or if the value did not need to be actually
194 stored within the hash (as in the case of tied hashes).  Otherwise it can
195 be dereferenced to get the original C<SV*>.  Note that the caller is
196 responsible for suitably incrementing the reference count of C<val> before
197 the call, and decrementing it if the function returned NULL.  Effectively
198 a successful hv_store takes ownership of one reference to C<val>.  This is
199 usually what you want; a newly created SV has a reference count of one, so
200 if all your code does is create SVs then store them in a hash, hv_store
201 will own the only reference to the new SV, and your code doesn't need to do
202 anything further to tidy up.  hv_store is not implemented as a call to
203 hv_store_ent, and does not create a temporary SV for the key, so if your
204 key data is not already in SV form then use hv_store in preference to
205 hv_store_ent.
206
207 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
208 information on how to use this function on tied hashes.
209
210 =cut
211 */
212
213 SV**
214 Perl_hv_store(pTHX_ HV *hv, const char *key, I32 klen_i32, SV *val, U32 hash)
215 {
216     HE *hek;
217     STRLEN klen;
218     int flags;
219
220     if (klen_i32 < 0) {
221         klen = -klen_i32;
222         flags = HVhek_UTF8;
223     } else {
224         klen = klen_i32;
225         flags = 0;
226     }
227     hek = hv_fetch_common (hv, NULL, key, klen, flags,
228                            (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV), val, hash);
229     return hek ? &HeVAL(hek) : NULL;
230 }
231
232 SV**
233 Perl_hv_store_flags(pTHX_ HV *hv, const char *key, I32 klen, SV *val,
234                  register U32 hash, int flags)
235 {
236     HE *hek = hv_fetch_common (hv, NULL, key, klen, flags,
237                                (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV), val, hash);
238     return hek ? &HeVAL(hek) : NULL;
239 }
240
241 /*
242 =for apidoc hv_store_ent
243
244 Stores C<val> in a hash.  The hash key is specified as C<key>.  The C<hash>
245 parameter is the precomputed hash value; if it is zero then Perl will
246 compute it.  The return value is the new hash entry so created.  It will be
247 NULL if the operation failed or if the value did not need to be actually
248 stored within the hash (as in the case of tied hashes).  Otherwise the
249 contents of the return value can be accessed using the C<He?> macros
250 described here.  Note that the caller is responsible for suitably
251 incrementing the reference count of C<val> before the call, and
252 decrementing it if the function returned NULL.  Effectively a successful
253 hv_store_ent takes ownership of one reference to C<val>.  This is
254 usually what you want; a newly created SV has a reference count of one, so
255 if all your code does is create SVs then store them in a hash, hv_store
256 will own the only reference to the new SV, and your code doesn't need to do
257 anything further to tidy up.  Note that hv_store_ent only reads the C<key>;
258 unlike C<val> it does not take ownership of it, so maintaining the correct
259 reference count on C<key> is entirely the caller's responsibility.  hv_store
260 is not implemented as a call to hv_store_ent, and does not create a temporary
261 SV for the key, so if your key data is not already in SV form then use
262 hv_store in preference to hv_store_ent.
263
264 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
265 information on how to use this function on tied hashes.
266
267 =cut
268 */
269
270 HE *
271 Perl_hv_store_ent(pTHX_ HV *hv, SV *keysv, SV *val, U32 hash)
272 {
273   return hv_fetch_common(hv, keysv, NULL, 0, 0, HV_FETCH_ISSTORE, val, hash);
274 }
275
276 /*
277 =for apidoc hv_exists
278
279 Returns a boolean indicating whether the specified hash key exists.  The
280 C<klen> is the length of the key.
281
282 =cut
283 */
284
285 bool
286 Perl_hv_exists(pTHX_ HV *hv, const char *key, I32 klen_i32)
287 {
288     STRLEN klen;
289     int flags;
290
291     if (klen_i32 < 0) {
292         klen = -klen_i32;
293         flags = HVhek_UTF8;
294     } else {
295         klen = klen_i32;
296         flags = 0;
297     }
298     return hv_fetch_common(hv, NULL, key, klen, flags, HV_FETCH_ISEXISTS, 0, 0)
299         ? TRUE : FALSE;
300 }
301
302 /*
303 =for apidoc hv_fetch
304
305 Returns the SV which corresponds to the specified key in the hash.  The
306 C<klen> is the length of the key.  If C<lval> is set then the fetch will be
307 part of a store.  Check that the return value is non-null before
308 dereferencing it to an C<SV*>.
309
310 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
311 information on how to use this function on tied hashes.
312
313 =cut
314 */
315
316 SV**
317 Perl_hv_fetch(pTHX_ HV *hv, const char *key, I32 klen_i32, I32 lval)
318 {
319     HE *hek;
320     STRLEN klen;
321     int flags;
322
323     if (klen_i32 < 0) {
324         klen = -klen_i32;
325         flags = HVhek_UTF8;
326     } else {
327         klen = klen_i32;
328         flags = 0;
329     }
330     hek = hv_fetch_common (hv, NULL, key, klen, flags,
331                            HV_FETCH_JUST_SV | (lval ? HV_FETCH_LVALUE : 0),
332                            Nullsv, 0);
333     return hek ? &HeVAL(hek) : NULL;
334 }
335
336 /*
337 =for apidoc hv_exists_ent
338
339 Returns a boolean indicating whether the specified hash key exists. C<hash>
340 can be a valid precomputed hash value, or 0 to ask for it to be
341 computed.
342
343 =cut
344 */
345
346 bool
347 Perl_hv_exists_ent(pTHX_ HV *hv, SV *keysv, U32 hash)
348 {
349     return hv_fetch_common(hv, keysv, NULL, 0, 0, HV_FETCH_ISEXISTS, 0, hash)
350         ? TRUE : FALSE;
351 }
352
353 /* returns an HE * structure with the all fields set */
354 /* note that hent_val will be a mortal sv for MAGICAL hashes */
355 /*
356 =for apidoc hv_fetch_ent
357
358 Returns the hash entry which corresponds to the specified key in the hash.
359 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
360 if you want the function to compute it.  IF C<lval> is set then the fetch
361 will be part of a store.  Make sure the return value is non-null before
362 accessing it.  The return value when C<tb> is a tied hash is a pointer to a
363 static location, so be sure to make a copy of the structure if you need to
364 store it somewhere.
365
366 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
367 information on how to use this function on tied hashes.
368
369 =cut
370 */
371
372 HE *
373 Perl_hv_fetch_ent(pTHX_ HV *hv, SV *keysv, I32 lval, register U32 hash)
374 {
375     return hv_fetch_common(hv, keysv, NULL, 0, 0, 
376                            (lval ? HV_FETCH_LVALUE : 0), Nullsv, hash);
377 }
378
379 STATIC HE *
380 S_hv_fetch_common(pTHX_ HV *hv, SV *keysv, const char *key, STRLEN klen,
381                   int flags, int action, SV *val, register U32 hash)
382 {
383     dVAR;
384     XPVHV* xhv;
385     U32 n_links;
386     HE *entry;
387     HE **oentry;
388     SV *sv;
389     bool is_utf8;
390     int masked_flags;
391
392     if (!hv)
393         return 0;
394
395     if (keysv) {
396         if (flags & HVhek_FREEKEY)
397             Safefree(key);
398         key = SvPV(keysv, klen);
399         flags = 0;
400         is_utf8 = (SvUTF8(keysv) != 0);
401     } else {
402         is_utf8 = ((flags & HVhek_UTF8) ? TRUE : FALSE);
403     }
404
405     xhv = (XPVHV*)SvANY(hv);
406     if (SvMAGICAL(hv)) {
407         if (SvRMAGICAL(hv) && !(action & (HV_FETCH_ISSTORE|HV_FETCH_ISEXISTS)))
408           {
409             if (mg_find((SV*)hv, PERL_MAGIC_tied) || SvGMAGICAL((SV*)hv)) {
410                 sv = sv_newmortal();
411
412                 /* XXX should be able to skimp on the HE/HEK here when
413                    HV_FETCH_JUST_SV is true.  */
414
415                 if (!keysv) {
416                     keysv = newSVpvn(key, klen);
417                     if (is_utf8) {
418                         SvUTF8_on(keysv);
419                     }
420                 } else {
421                     keysv = newSVsv(keysv);
422                 }
423                 mg_copy((SV*)hv, sv, (char *)keysv, HEf_SVKEY);
424
425                 /* grab a fake HE/HEK pair from the pool or make a new one */
426                 entry = PL_hv_fetch_ent_mh;
427                 if (entry)
428                     PL_hv_fetch_ent_mh = HeNEXT(entry);
429                 else {
430                     char *k;
431                     entry = new_HE();
432                     New(54, k, HEK_BASESIZE + sizeof(SV*), char);
433                     HeKEY_hek(entry) = (HEK*)k;
434                 }
435                 HeNEXT(entry) = Nullhe;
436                 HeSVKEY_set(entry, keysv);
437                 HeVAL(entry) = sv;
438                 sv_upgrade(sv, SVt_PVLV);
439                 LvTYPE(sv) = 'T';
440                  /* so we can free entry when freeing sv */
441                 LvTARG(sv) = (SV*)entry;
442
443                 /* XXX remove at some point? */
444                 if (flags & HVhek_FREEKEY)
445                     Safefree(key);
446
447                 return entry;
448             }
449 #ifdef ENV_IS_CASELESS
450             else if (mg_find((SV*)hv, PERL_MAGIC_env)) {
451                 U32 i;
452                 for (i = 0; i < klen; ++i)
453                     if (isLOWER(key[i])) {
454                         /* Would be nice if we had a routine to do the
455                            copy and upercase in a single pass through.  */
456                         const char *nkey = strupr(savepvn(key,klen));
457                         /* Note that this fetch is for nkey (the uppercased
458                            key) whereas the store is for key (the original)  */
459                         entry = hv_fetch_common(hv, Nullsv, nkey, klen,
460                                                 HVhek_FREEKEY, /* free nkey */
461                                                 0 /* non-LVAL fetch */,
462                                                 Nullsv /* no value */,
463                                                 0 /* compute hash */);
464                         if (!entry && (action & HV_FETCH_LVALUE)) {
465                             /* This call will free key if necessary.
466                                Do it this way to encourage compiler to tail
467                                call optimise.  */
468                             entry = hv_fetch_common(hv, keysv, key, klen,
469                                                     flags, HV_FETCH_ISSTORE,
470                                                     NEWSV(61,0), hash);
471                         } else {
472                             if (flags & HVhek_FREEKEY)
473                                 Safefree(key);
474                         }
475                         return entry;
476                     }
477             }
478 #endif
479         } /* ISFETCH */
480         else if (SvRMAGICAL(hv) && (action & HV_FETCH_ISEXISTS)) {
481             if (mg_find((SV*)hv, PERL_MAGIC_tied) || SvGMAGICAL((SV*)hv)) {
482                 SV* svret;
483                 /* I don't understand why hv_exists_ent has svret and sv,
484                    whereas hv_exists only had one.  */
485                 svret = sv_newmortal();
486                 sv = sv_newmortal();
487
488                 if (keysv || is_utf8) {
489                     if (!keysv) {
490                         keysv = newSVpvn(key, klen);
491                         SvUTF8_on(keysv);
492                     } else {
493                         keysv = newSVsv(keysv);
494                     }
495                     mg_copy((SV*)hv, sv, (char *)sv_2mortal(keysv), HEf_SVKEY);
496                 } else {
497                     mg_copy((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) ? (HE *)hv : NULL;
506                 }
507 #ifdef ENV_IS_CASELESS
508             else if (mg_find((SV*)hv, PERL_MAGIC_env)) {
509                 /* XXX This code isn't UTF8 clean.  */
510                 const char *keysave = 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 = 0;
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(key, klen);
534                         SvUTF8_on(keysv);
535                     }
536                     if (PL_tainting)
537                         PL_tainted = SvTAINTED(keysv);
538                     keysv = sv_2mortal(newSVsv(keysv));
539                     mg_copy((SV*)hv, val, (char*)keysv, HEf_SVKEY);
540                 } else {
541                     mg_copy((SV*)hv, val, key, klen);
542                 }
543
544                 TAINT_IF(save_taint);
545                 if (!xhv->xhv_array /* !HvARRAY(hv) */ && !needs_store) {
546                     if (flags & HVhek_FREEKEY)
547                         Safefree(key);
548                     return Nullhe;
549                 }
550 #ifdef ENV_IS_CASELESS
551                 else if (mg_find((SV*)hv, PERL_MAGIC_env)) {
552                     /* XXX This code isn't UTF8 clean.  */
553                     const char *keysave = key;
554                     /* Will need to free this, so set FREEKEY flag.  */
555                     key = savepvn(key,klen);
556                     key = (const char*)strupr((char*)key);
557                     is_utf8 = 0;
558                     hash = 0;
559                     keysv = 0;
560
561                     if (flags & HVhek_FREEKEY) {
562                         Safefree(keysave);
563                     }
564                     flags |= HVhek_FREEKEY;
565                 }
566 #endif
567             }
568         } /* ISSTORE */
569     } /* SvMAGICAL */
570
571     if (!xhv->xhv_array /* !HvARRAY(hv) */) {
572         if ((action & (HV_FETCH_LVALUE | HV_FETCH_ISSTORE))
573 #ifdef DYNAMIC_ENV_FETCH  /* if it's an %ENV lookup, we may get it on the fly */
574                  || (SvRMAGICAL((SV*)hv) && mg_find((SV*)hv, PERL_MAGIC_env))
575 #endif
576                                                                   )
577             Newz(503, xhv->xhv_array /* HvARRAY(hv) */,
578                  PERL_HV_ARRAY_ALLOC_BYTES(xhv->xhv_max+1 /* HvMAX(hv)+1 */),
579                  char);
580 #ifdef DYNAMIC_ENV_FETCH
581         else if (action & HV_FETCH_ISEXISTS) {
582             /* for an %ENV exists, if we do an insert it's by a recursive
583                store call, so avoid creating HvARRAY(hv) right now.  */
584         }
585 #endif
586         else {
587             /* XXX remove at some point? */
588             if (flags & HVhek_FREEKEY)
589                 Safefree(key);
590
591             return 0;
592         }
593     }
594
595     if (is_utf8) {
596         const char *keysave = key;
597         key = (char*)bytes_from_utf8((U8*)key, &klen, &is_utf8);
598         if (is_utf8)
599             flags |= HVhek_UTF8;
600         else
601             flags &= ~HVhek_UTF8;
602         if (key != keysave) {
603             if (flags & HVhek_FREEKEY)
604                 Safefree(keysave);
605             flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
606         }
607     }
608
609     if (HvREHASH(hv)) {
610         PERL_HASH_INTERNAL(hash, key, klen);
611         /* We don't have a pointer to the hv, so we have to replicate the
612            flag into every HEK, so that hv_iterkeysv can see it.  */
613         /* And yes, you do need this even though you are not "storing" because
614            you can flip the flags below if doing an lval lookup.  (And that
615            was put in to give the semantics Andreas was expecting.)  */
616         flags |= HVhek_REHASH;
617     } else if (!hash) {
618         if (keysv && (SvIsCOW_shared_hash(keysv))) {
619             hash = SvUVX(keysv);
620         } else {
621             PERL_HASH(hash, key, klen);
622         }
623     }
624
625     masked_flags = (flags & HVhek_MASK);
626     n_links = 0;
627
628 #ifdef DYNAMIC_ENV_FETCH
629     if (!xhv->xhv_array /* !HvARRAY(hv) */) entry = Null(HE*);
630     else
631 #endif
632     {
633         /* entry = (HvARRAY(hv))[hash & (I32) HvMAX(hv)]; */
634         entry = ((HE**)xhv->xhv_array)[hash & (I32) xhv->xhv_max];
635     }
636     for (; entry; ++n_links, entry = HeNEXT(entry)) {
637         if (HeHASH(entry) != hash)              /* strings can't be equal */
638             continue;
639         if (HeKLEN(entry) != (I32)klen)
640             continue;
641         if (HeKEY(entry) != key && memNE(HeKEY(entry),key,klen))        /* is this it? */
642             continue;
643         if ((HeKFLAGS(entry) ^ masked_flags) & HVhek_UTF8)
644             continue;
645
646         if (action & (HV_FETCH_LVALUE|HV_FETCH_ISSTORE)) {
647             if (HeKFLAGS(entry) != masked_flags) {
648                 /* We match if HVhek_UTF8 bit in our flags and hash key's
649                    match.  But if entry was set previously with HVhek_WASUTF8
650                    and key now doesn't (or vice versa) then we should change
651                    the key's flag, as this is assignment.  */
652                 if (HvSHAREKEYS(hv)) {
653                     /* Need to swap the key we have for a key with the flags we
654                        need. As keys are shared we can't just write to the
655                        flag, so we share the new one, unshare the old one.  */
656                     HEK *new_hek = share_hek_flags(key, klen, hash,
657                                                    masked_flags);
658                     unshare_hek (HeKEY_hek(entry));
659                     HeKEY_hek(entry) = new_hek;
660                 }
661                 else
662                     HeKFLAGS(entry) = masked_flags;
663                 if (masked_flags & HVhek_ENABLEHVKFLAGS)
664                     HvHASKFLAGS_on(hv);
665             }
666             if (HeVAL(entry) == &PL_sv_placeholder) {
667                 /* yes, can store into placeholder slot */
668                 if (action & HV_FETCH_LVALUE) {
669                     if (SvMAGICAL(hv)) {
670                         /* This preserves behaviour with the old hv_fetch
671                            implementation which at this point would bail out
672                            with a break; (at "if we find a placeholder, we
673                            pretend we haven't found anything")
674
675                            That break mean that if a placeholder were found, it
676                            caused a call into hv_store, which in turn would
677                            check magic, and if there is no magic end up pretty
678                            much back at this point (in hv_store's code).  */
679                         break;
680                     }
681                     /* LVAL fetch which actaully needs a store.  */
682                     val = NEWSV(61,0);
683                     xhv->xhv_placeholders--;
684                 } else {
685                     /* store */
686                     if (val != &PL_sv_placeholder)
687                         xhv->xhv_placeholders--;
688                 }
689                 HeVAL(entry) = val;
690             } else if (action & HV_FETCH_ISSTORE) {
691                 SvREFCNT_dec(HeVAL(entry));
692                 HeVAL(entry) = val;
693             }
694         } else if (HeVAL(entry) == &PL_sv_placeholder) {
695             /* if we find a placeholder, we pretend we haven't found
696                anything */
697             break;
698         }
699         if (flags & HVhek_FREEKEY)
700             Safefree(key);
701         return entry;
702     }
703 #ifdef DYNAMIC_ENV_FETCH  /* %ENV lookup?  If so, try to fetch the value now */
704     if (!(action & HV_FETCH_ISSTORE) 
705         && SvRMAGICAL((SV*)hv) && mg_find((SV*)hv, PERL_MAGIC_env)) {
706         unsigned long len;
707         char *env = PerlEnv_ENVgetenv_len(key,&len);
708         if (env) {
709             sv = newSVpvn(env,len);
710             SvTAINTED_on(sv);
711             return hv_fetch_common(hv,keysv,key,klen,flags,HV_FETCH_ISSTORE,sv,
712                                    hash);
713         }
714     }
715 #endif
716
717     if (!entry && SvREADONLY(hv) && !(action & HV_FETCH_ISEXISTS)) {
718         S_hv_notallowed(aTHX_ flags, key, klen,
719                         "Attempt to access disallowed key '%"SVf"' in"
720                         " a restricted hash");
721     }
722     if (!(action & (HV_FETCH_LVALUE|HV_FETCH_ISSTORE))) {
723         /* Not doing some form of store, so return failure.  */
724         if (flags & HVhek_FREEKEY)
725             Safefree(key);
726         return 0;
727     }
728     if (action & HV_FETCH_LVALUE) {
729         val = NEWSV(61,0);
730         if (SvMAGICAL(hv)) {
731             /* At this point the old hv_fetch code would call to hv_store,
732                which in turn might do some tied magic. So we need to make that
733                magic check happen.  */
734             /* gonna assign to this, so it better be there */
735             return hv_fetch_common(hv, keysv, key, klen, flags,
736                                    HV_FETCH_ISSTORE, val, hash);
737             /* XXX Surely that could leak if the fetch-was-store fails?
738                Just like the hv_fetch.  */
739         }
740     }
741
742     /* Welcome to hv_store...  */
743
744     if (!xhv->xhv_array) {
745         /* Not sure if we can get here.  I think the only case of oentry being
746            NULL is for %ENV with dynamic env fetch.  But that should disappear
747            with magic in the previous code.  */
748         Newz(503, xhv->xhv_array /* HvARRAY(hv) */,
749              PERL_HV_ARRAY_ALLOC_BYTES(xhv->xhv_max+1 /* HvMAX(hv)+1 */),
750              char);
751     }
752
753     oentry = &((HE**)xhv->xhv_array)[hash & (I32) xhv->xhv_max];
754
755     entry = new_HE();
756     /* share_hek_flags will do the free for us.  This might be considered
757        bad API design.  */
758     if (HvSHAREKEYS(hv))
759         HeKEY_hek(entry) = share_hek_flags(key, klen, hash, flags);
760     else                                       /* gotta do the real thing */
761         HeKEY_hek(entry) = save_hek_flags(key, klen, hash, flags);
762     HeVAL(entry) = val;
763     HeNEXT(entry) = *oentry;
764     *oentry = entry;
765
766     if (val == &PL_sv_placeholder)
767         xhv->xhv_placeholders++;
768     if (masked_flags & HVhek_ENABLEHVKFLAGS)
769         HvHASKFLAGS_on(hv);
770
771     xhv->xhv_keys++; /* HvKEYS(hv)++ */
772     if (!n_links) {                             /* initial entry? */
773         xhv->xhv_fill++; /* HvFILL(hv)++ */
774     } else if ((xhv->xhv_keys > (IV)xhv->xhv_max)
775                || ((n_links > HV_MAX_LENGTH_BEFORE_SPLIT) && !HvREHASH(hv))) {
776         /* Use only the old HvKEYS(hv) > HvMAX(hv) condition to limit bucket
777            splits on a rehashed hash, as we're not going to split it again,
778            and if someone is lucky (evil) enough to get all the keys in one
779            list they could exhaust our memory as we repeatedly double the
780            number of buckets on every entry. Linear search feels a less worse
781            thing to do.  */
782         hsplit(hv);
783     }
784
785     return entry;
786 }
787
788 STATIC void
789 S_hv_magic_check(pTHX_ HV *hv, bool *needs_copy, bool *needs_store)
790 {
791     const MAGIC *mg = SvMAGIC(hv);
792     *needs_copy = FALSE;
793     *needs_store = TRUE;
794     while (mg) {
795         if (isUPPER(mg->mg_type)) {
796             *needs_copy = TRUE;
797             switch (mg->mg_type) {
798             case PERL_MAGIC_tied:
799             case PERL_MAGIC_sig:
800                 *needs_store = FALSE;
801             }
802         }
803         mg = mg->mg_moremagic;
804     }
805 }
806
807 /*
808 =for apidoc hv_scalar
809
810 Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
811
812 =cut
813 */
814
815 SV *
816 Perl_hv_scalar(pTHX_ HV *hv)
817 {
818     MAGIC *mg;
819     SV *sv;
820     
821     if ((SvRMAGICAL(hv) && (mg = mg_find((SV*)hv, PERL_MAGIC_tied)))) {
822         sv = magic_scalarpack(hv, mg);
823         return sv;
824     } 
825
826     sv = sv_newmortal();
827     if (HvFILL((HV*)hv)) 
828         Perl_sv_setpvf(aTHX_ sv, "%ld/%ld",
829                 (long)HvFILL(hv), (long)HvMAX(hv) + 1);
830     else
831         sv_setiv(sv, 0);
832     
833     return sv;
834 }
835
836 /*
837 =for apidoc hv_delete
838
839 Deletes a key/value pair in the hash.  The value SV is removed from the
840 hash and returned to the caller.  The C<klen> is the length of the key.
841 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
842 will be returned.
843
844 =cut
845 */
846
847 SV *
848 Perl_hv_delete(pTHX_ HV *hv, const char *key, I32 klen_i32, I32 flags)
849 {
850     STRLEN klen;
851     int k_flags = 0;
852
853     if (klen_i32 < 0) {
854         klen = -klen_i32;
855         k_flags |= HVhek_UTF8;
856     } else {
857         klen = klen_i32;
858     }
859     return hv_delete_common(hv, NULL, key, klen, k_flags, flags, 0);
860 }
861
862 /*
863 =for apidoc hv_delete_ent
864
865 Deletes a key/value pair in the hash.  The value SV is removed from the
866 hash and returned to the caller.  The C<flags> value will normally be zero;
867 if set to G_DISCARD then NULL will be returned.  C<hash> can be a valid
868 precomputed hash value, or 0 to ask for it to be computed.
869
870 =cut
871 */
872
873 SV *
874 Perl_hv_delete_ent(pTHX_ HV *hv, SV *keysv, I32 flags, U32 hash)
875 {
876     return hv_delete_common(hv, keysv, NULL, 0, 0, flags, hash);
877 }
878
879 STATIC SV *
880 S_hv_delete_common(pTHX_ HV *hv, SV *keysv, const char *key, STRLEN klen,
881                    int k_flags, I32 d_flags, U32 hash)
882 {
883     dVAR;
884     register XPVHV* xhv;
885     register I32 i;
886     register HE *entry;
887     register HE **oentry;
888     SV *sv;
889     bool is_utf8;
890     int masked_flags;
891
892     if (!hv)
893         return Nullsv;
894
895     if (keysv) {
896         if (k_flags & HVhek_FREEKEY)
897             Safefree(key);
898         key = SvPV(keysv, klen);
899         k_flags = 0;
900         is_utf8 = (SvUTF8(keysv) != 0);
901     } else {
902         is_utf8 = ((k_flags & HVhek_UTF8) ? TRUE : FALSE);
903     }
904
905     if (SvRMAGICAL(hv)) {
906         bool needs_copy;
907         bool needs_store;
908         hv_magic_check (hv, &needs_copy, &needs_store);
909
910         if (needs_copy) {
911             entry = hv_fetch_common(hv, keysv, key, klen,
912                                     k_flags & ~HVhek_FREEKEY, HV_FETCH_LVALUE,
913                                     Nullsv, hash);
914             sv = entry ? HeVAL(entry) : NULL;
915             if (sv) {
916                 if (SvMAGICAL(sv)) {
917                     mg_clear(sv);
918                 }
919                 if (!needs_store) {
920                     if (mg_find(sv, PERL_MAGIC_tiedelem)) {
921                         /* No longer an element */
922                         sv_unmagic(sv, PERL_MAGIC_tiedelem);
923                         return sv;
924                     }           
925                     return Nullsv;              /* element cannot be deleted */
926                 }
927 #ifdef ENV_IS_CASELESS
928                 else if (mg_find((SV*)hv, PERL_MAGIC_env)) {
929                     /* XXX This code isn't UTF8 clean.  */
930                     keysv = sv_2mortal(newSVpvn(key,klen));
931                     if (k_flags & HVhek_FREEKEY) {
932                         Safefree(key);
933                     }
934                     key = strupr(SvPVX(keysv));
935                     is_utf8 = 0;
936                     k_flags = 0;
937                     hash = 0;
938                 }
939 #endif
940             }
941         }
942     }
943     xhv = (XPVHV*)SvANY(hv);
944     if (!xhv->xhv_array /* !HvARRAY(hv) */)
945         return Nullsv;
946
947     if (is_utf8) {
948     const char *keysave = key;
949     key = (char*)bytes_from_utf8((U8*)key, &klen, &is_utf8);
950
951         if (is_utf8)
952             k_flags |= HVhek_UTF8;
953         else
954             k_flags &= ~HVhek_UTF8;
955         if (key != keysave) {
956             if (k_flags & HVhek_FREEKEY) {
957                 /* This shouldn't happen if our caller does what we expect,
958                    but strictly the API allows it.  */
959                 Safefree(keysave);
960             }
961             k_flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
962         }
963         HvHASKFLAGS_on((SV*)hv);
964     }
965
966     if (HvREHASH(hv)) {
967         PERL_HASH_INTERNAL(hash, key, klen);
968     } else if (!hash) {
969         if (keysv && (SvIsCOW_shared_hash(keysv))) {
970             hash = SvUVX(keysv);
971         } else {
972             PERL_HASH(hash, key, klen);
973         }
974     }
975
976     masked_flags = (k_flags & HVhek_MASK);
977
978     /* oentry = &(HvARRAY(hv))[hash & (I32) HvMAX(hv)]; */
979     oentry = &((HE**)xhv->xhv_array)[hash & (I32) xhv->xhv_max];
980     entry = *oentry;
981     i = 1;
982     for (; entry; i=0, oentry = &HeNEXT(entry), entry = *oentry) {
983         if (HeHASH(entry) != hash)              /* strings can't be equal */
984             continue;
985         if (HeKLEN(entry) != (I32)klen)
986             continue;
987         if (HeKEY(entry) != key && memNE(HeKEY(entry),key,klen))        /* is this it? */
988             continue;
989         if ((HeKFLAGS(entry) ^ masked_flags) & HVhek_UTF8)
990             continue;
991
992         /* if placeholder is here, it's already been deleted.... */
993         if (HeVAL(entry) == &PL_sv_placeholder)
994         {
995           if (k_flags & HVhek_FREEKEY)
996             Safefree(key);
997           return Nullsv;
998         }
999         else if (SvREADONLY(hv) && HeVAL(entry) && SvREADONLY(HeVAL(entry))) {
1000             S_hv_notallowed(aTHX_ k_flags, key, klen,
1001                             "Attempt to delete readonly key '%"SVf"' from"
1002                             " a restricted hash");
1003         }
1004         if (k_flags & HVhek_FREEKEY)
1005             Safefree(key);
1006
1007         if (d_flags & G_DISCARD)
1008             sv = Nullsv;
1009         else {
1010             sv = sv_2mortal(HeVAL(entry));
1011             HeVAL(entry) = &PL_sv_placeholder;
1012         }
1013
1014         /*
1015          * If a restricted hash, rather than really deleting the entry, put
1016          * a placeholder there. This marks the key as being "approved", so
1017          * we can still access via not-really-existing key without raising
1018          * an error.
1019          */
1020         if (SvREADONLY(hv)) {
1021             SvREFCNT_dec(HeVAL(entry));
1022             HeVAL(entry) = &PL_sv_placeholder;
1023             /* We'll be saving this slot, so the number of allocated keys
1024              * doesn't go down, but the number placeholders goes up */
1025             xhv->xhv_placeholders++; /* HvPLACEHOLDERS(hv)++ */
1026         } else {
1027             *oentry = HeNEXT(entry);
1028             if (i && !*oentry)
1029                 xhv->xhv_fill--; /* HvFILL(hv)-- */
1030             if (entry == xhv->xhv_eiter /* HvEITER(hv) */)
1031                 HvLAZYDEL_on(hv);
1032             else
1033                 hv_free_ent(hv, entry);
1034             xhv->xhv_keys--; /* HvKEYS(hv)-- */
1035             if (xhv->xhv_keys == 0)
1036                 HvHASKFLAGS_off(hv);
1037         }
1038         return sv;
1039     }
1040     if (SvREADONLY(hv)) {
1041         S_hv_notallowed(aTHX_ k_flags, key, klen,
1042                         "Attempt to delete disallowed key '%"SVf"' from"
1043                         " a restricted hash");
1044     }
1045
1046     if (k_flags & HVhek_FREEKEY)
1047         Safefree(key);
1048     return Nullsv;
1049 }
1050
1051 STATIC void
1052 S_hsplit(pTHX_ HV *hv)
1053 {
1054     register XPVHV* xhv = (XPVHV*)SvANY(hv);
1055     const I32 oldsize = (I32) xhv->xhv_max+1; /* HvMAX(hv)+1 (sick) */
1056     register I32 newsize = oldsize * 2;
1057     register I32 i;
1058     register char *a = xhv->xhv_array; /* HvARRAY(hv) */
1059     register HE **aep;
1060     register HE **oentry;
1061     int longest_chain = 0;
1062     int was_shared;
1063
1064     /*PerlIO_printf(PerlIO_stderr(), "hsplit called for %p which had %d\n",
1065       hv, (int) oldsize);*/
1066
1067     if (HvPLACEHOLDERS(hv) && !SvREADONLY(hv)) {
1068       /* Can make this clear any placeholders first for non-restricted hashes,
1069          even though Storable rebuilds restricted hashes by putting in all the
1070          placeholders (first) before turning on the readonly flag, because
1071          Storable always pre-splits the hash.  */
1072       hv_clear_placeholders(hv);
1073     }
1074                
1075     PL_nomemok = TRUE;
1076 #if defined(STRANGE_MALLOC) || defined(MYMALLOC)
1077     Renew(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize), char);
1078     if (!a) {
1079       PL_nomemok = FALSE;
1080       return;
1081     }
1082 #else
1083     New(2, a, PERL_HV_ARRAY_ALLOC_BYTES(newsize), char);
1084     if (!a) {
1085       PL_nomemok = FALSE;
1086       return;
1087     }
1088     Copy(xhv->xhv_array /* HvARRAY(hv) */, a, oldsize * sizeof(HE*), char);
1089     if (oldsize >= 64) {
1090         offer_nice_chunk(xhv->xhv_array /* HvARRAY(hv) */,
1091                         PERL_HV_ARRAY_ALLOC_BYTES(oldsize));
1092     }
1093     else
1094         Safefree(xhv->xhv_array /* HvARRAY(hv) */);
1095 #endif
1096
1097     PL_nomemok = FALSE;
1098     Zero(&a[oldsize * sizeof(HE*)], (newsize-oldsize) * sizeof(HE*), char);     /* zero 2nd half*/
1099     xhv->xhv_max = --newsize;   /* HvMAX(hv) = --newsize */
1100     xhv->xhv_array = a;         /* HvARRAY(hv) = a */
1101     aep = (HE**)a;
1102
1103     for (i=0; i<oldsize; i++,aep++) {
1104         int left_length = 0;
1105         int right_length = 0;
1106         register HE *entry;
1107         register HE **bep;
1108
1109         if (!*aep)                              /* non-existent */
1110             continue;
1111         bep = aep+oldsize;
1112         for (oentry = aep, entry = *aep; entry; entry = *oentry) {
1113             if ((HeHASH(entry) & newsize) != (U32)i) {
1114                 *oentry = HeNEXT(entry);
1115                 HeNEXT(entry) = *bep;
1116                 if (!*bep)
1117                     xhv->xhv_fill++; /* HvFILL(hv)++ */
1118                 *bep = entry;
1119                 right_length++;
1120                 continue;
1121             }
1122             else {
1123                 oentry = &HeNEXT(entry);
1124                 left_length++;
1125             }
1126         }
1127         if (!*aep)                              /* everything moved */
1128             xhv->xhv_fill--; /* HvFILL(hv)-- */
1129         /* I think we don't actually need to keep track of the longest length,
1130            merely flag if anything is too long. But for the moment while
1131            developing this code I'll track it.  */
1132         if (left_length > longest_chain)
1133             longest_chain = left_length;
1134         if (right_length > longest_chain)
1135             longest_chain = right_length;
1136     }
1137
1138
1139     /* Pick your policy for "hashing isn't working" here:  */
1140     if (longest_chain <= HV_MAX_LENGTH_BEFORE_SPLIT /* split worked?  */
1141         || HvREHASH(hv)) {
1142         return;
1143     }
1144
1145     if (hv == PL_strtab) {
1146         /* Urg. Someone is doing something nasty to the string table.
1147            Can't win.  */
1148         return;
1149     }
1150
1151     /* Awooga. Awooga. Pathological data.  */
1152     /*PerlIO_printf(PerlIO_stderr(), "%p %d of %d with %d/%d buckets\n", hv,
1153       longest_chain, HvTOTALKEYS(hv), HvFILL(hv),  1+HvMAX(hv));*/
1154
1155     ++newsize;
1156     Newz(2, a, PERL_HV_ARRAY_ALLOC_BYTES(newsize), char);
1157     was_shared = HvSHAREKEYS(hv);
1158
1159     xhv->xhv_fill = 0;
1160     HvSHAREKEYS_off(hv);
1161     HvREHASH_on(hv);
1162
1163     aep = (HE **) xhv->xhv_array;
1164
1165     for (i=0; i<newsize; i++,aep++) {
1166         register HE *entry = *aep;
1167         while (entry) {
1168             /* We're going to trash this HE's next pointer when we chain it
1169                into the new hash below, so store where we go next.  */
1170             HE *next = HeNEXT(entry);
1171             UV hash;
1172             HE **bep;
1173
1174             /* Rehash it */
1175             PERL_HASH_INTERNAL(hash, HeKEY(entry), HeKLEN(entry));
1176
1177             if (was_shared) {
1178                 /* Unshare it.  */
1179                 HEK *new_hek
1180                     = save_hek_flags(HeKEY(entry), HeKLEN(entry),
1181                                      hash, HeKFLAGS(entry));
1182                 unshare_hek (HeKEY_hek(entry));
1183                 HeKEY_hek(entry) = new_hek;
1184             } else {
1185                 /* Not shared, so simply write the new hash in. */
1186                 HeHASH(entry) = hash;
1187             }
1188             /*PerlIO_printf(PerlIO_stderr(), "%d ", HeKFLAGS(entry));*/
1189             HEK_REHASH_on(HeKEY_hek(entry));
1190             /*PerlIO_printf(PerlIO_stderr(), "%d\n", HeKFLAGS(entry));*/
1191
1192             /* Copy oentry to the correct new chain.  */
1193             bep = ((HE**)a) + (hash & (I32) xhv->xhv_max);
1194             if (!*bep)
1195                     xhv->xhv_fill++; /* HvFILL(hv)++ */
1196             HeNEXT(entry) = *bep;
1197             *bep = entry;
1198
1199             entry = next;
1200         }
1201     }
1202     Safefree (xhv->xhv_array);
1203     xhv->xhv_array = a;         /* HvARRAY(hv) = a */
1204 }
1205
1206 void
1207 Perl_hv_ksplit(pTHX_ HV *hv, IV newmax)
1208 {
1209     register XPVHV* xhv = (XPVHV*)SvANY(hv);
1210     const I32 oldsize = (I32) xhv->xhv_max+1; /* HvMAX(hv)+1 (sick) */
1211     register I32 newsize;
1212     register I32 i;
1213     register char *a;
1214     register HE **aep;
1215     register HE *entry;
1216     register HE **oentry;
1217
1218     newsize = (I32) newmax;                     /* possible truncation here */
1219     if (newsize != newmax || newmax <= oldsize)
1220         return;
1221     while ((newsize & (1 + ~newsize)) != newsize) {
1222         newsize &= ~(newsize & (1 + ~newsize)); /* get proper power of 2 */
1223     }
1224     if (newsize < newmax)
1225         newsize *= 2;
1226     if (newsize < newmax)
1227         return;                                 /* overflow detection */
1228
1229     a = xhv->xhv_array; /* HvARRAY(hv) */
1230     if (a) {
1231         PL_nomemok = TRUE;
1232 #if defined(STRANGE_MALLOC) || defined(MYMALLOC)
1233         Renew(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize), char);
1234         if (!a) {
1235           PL_nomemok = FALSE;
1236           return;
1237         }
1238 #else
1239         New(2, a, PERL_HV_ARRAY_ALLOC_BYTES(newsize), char);
1240         if (!a) {
1241           PL_nomemok = FALSE;
1242           return;
1243         }
1244         Copy(xhv->xhv_array /* HvARRAY(hv) */, a, oldsize * sizeof(HE*), char);
1245         if (oldsize >= 64) {
1246             offer_nice_chunk(xhv->xhv_array /* HvARRAY(hv) */,
1247                             PERL_HV_ARRAY_ALLOC_BYTES(oldsize));
1248         }
1249         else
1250             Safefree(xhv->xhv_array /* HvARRAY(hv) */);
1251 #endif
1252         PL_nomemok = FALSE;
1253         Zero(&a[oldsize * sizeof(HE*)], (newsize-oldsize) * sizeof(HE*), char); /* zero 2nd half*/
1254     }
1255     else {
1256         Newz(0, a, PERL_HV_ARRAY_ALLOC_BYTES(newsize), char);
1257     }
1258     xhv->xhv_max = --newsize;   /* HvMAX(hv) = --newsize */
1259     xhv->xhv_array = a;         /* HvARRAY(hv) = a */
1260     if (!xhv->xhv_fill /* !HvFILL(hv) */)       /* skip rest if no entries */
1261         return;
1262
1263     aep = (HE**)a;
1264     for (i=0; i<oldsize; i++,aep++) {
1265         if (!*aep)                              /* non-existent */
1266             continue;
1267         for (oentry = aep, entry = *aep; entry; entry = *oentry) {
1268             register I32 j;
1269             if ((j = (HeHASH(entry) & newsize)) != i) {
1270                 j -= i;
1271                 *oentry = HeNEXT(entry);
1272                 if (!(HeNEXT(entry) = aep[j]))
1273                     xhv->xhv_fill++; /* HvFILL(hv)++ */
1274                 aep[j] = entry;
1275                 continue;
1276             }
1277             else
1278                 oentry = &HeNEXT(entry);
1279         }
1280         if (!*aep)                              /* everything moved */
1281             xhv->xhv_fill--; /* HvFILL(hv)-- */
1282     }
1283 }
1284
1285 /*
1286 =for apidoc newHV
1287
1288 Creates a new HV.  The reference count is set to 1.
1289
1290 =cut
1291 */
1292
1293 HV *
1294 Perl_newHV(pTHX)
1295 {
1296     register HV *hv;
1297     register XPVHV* xhv;
1298
1299     hv = (HV*)NEWSV(502,0);
1300     sv_upgrade((SV *)hv, SVt_PVHV);
1301     xhv = (XPVHV*)SvANY(hv);
1302     SvPOK_off(hv);
1303     SvNOK_off(hv);
1304 #ifndef NODEFAULT_SHAREKEYS
1305     HvSHAREKEYS_on(hv);         /* key-sharing on by default */
1306 #endif
1307
1308     xhv->xhv_max    = 7;        /* HvMAX(hv) = 7 (start with 8 buckets) */
1309     xhv->xhv_fill   = 0;        /* HvFILL(hv) = 0 */
1310     (void)hv_iterinit(hv);      /* so each() will start off right */
1311     return hv;
1312 }
1313
1314 HV *
1315 Perl_newHVhv(pTHX_ HV *ohv)
1316 {
1317     HV *hv = newHV();
1318     STRLEN hv_max, hv_fill;
1319
1320     if (!ohv || (hv_fill = HvFILL(ohv)) == 0)
1321         return hv;
1322     hv_max = HvMAX(ohv);
1323
1324     if (!SvMAGICAL((SV *)ohv)) {
1325         /* It's an ordinary hash, so copy it fast. AMS 20010804 */
1326         STRLEN i;
1327         const bool shared = !!HvSHAREKEYS(ohv);
1328         HE **ents, **oents = (HE **)HvARRAY(ohv);
1329         char *a;
1330         New(0, a, PERL_HV_ARRAY_ALLOC_BYTES(hv_max+1), char);
1331         ents = (HE**)a;
1332
1333         /* In each bucket... */
1334         for (i = 0; i <= hv_max; i++) {
1335             HE *prev = NULL, *ent = NULL, *oent = oents[i];
1336
1337             if (!oent) {
1338                 ents[i] = NULL;
1339                 continue;
1340             }
1341
1342             /* Copy the linked list of entries. */
1343             for (oent = oents[i]; oent; oent = HeNEXT(oent)) {
1344                 const U32 hash   = HeHASH(oent);
1345                 const char * const key = HeKEY(oent);
1346                 const STRLEN len = HeKLEN(oent);
1347                 const int flags  = HeKFLAGS(oent);
1348
1349                 ent = new_HE();
1350                 HeVAL(ent)     = newSVsv(HeVAL(oent));
1351                 HeKEY_hek(ent)
1352                     = shared ? share_hek_flags(key, len, hash, flags)
1353                              :  save_hek_flags(key, len, hash, flags);
1354                 if (prev)
1355                     HeNEXT(prev) = ent;
1356                 else
1357                     ents[i] = ent;
1358                 prev = ent;
1359                 HeNEXT(ent) = NULL;
1360             }
1361         }
1362
1363         HvMAX(hv)   = hv_max;
1364         HvFILL(hv)  = hv_fill;
1365         HvTOTALKEYS(hv)  = HvTOTALKEYS(ohv);
1366         HvARRAY(hv) = ents;
1367     }
1368     else {
1369         /* Iterate over ohv, copying keys and values one at a time. */
1370         HE *entry;
1371         const I32 riter = HvRITER(ohv);
1372         HE * const eiter = HvEITER(ohv);
1373
1374         /* Can we use fewer buckets? (hv_max is always 2^n-1) */
1375         while (hv_max && hv_max + 1 >= hv_fill * 2)
1376             hv_max = hv_max / 2;
1377         HvMAX(hv) = hv_max;
1378
1379         hv_iterinit(ohv);
1380         while ((entry = hv_iternext_flags(ohv, 0))) {
1381             hv_store_flags(hv, HeKEY(entry), HeKLEN(entry),
1382                            newSVsv(HeVAL(entry)), HeHASH(entry),
1383                            HeKFLAGS(entry));
1384         }
1385         HvRITER(ohv) = riter;
1386         HvEITER(ohv) = eiter;
1387     }
1388
1389     return hv;
1390 }
1391
1392 void
1393 Perl_hv_free_ent(pTHX_ HV *hv, register HE *entry)
1394 {
1395     SV *val;
1396
1397     if (!entry)
1398         return;
1399     val = HeVAL(entry);
1400     if (val && isGV(val) && GvCVu(val) && HvNAME(hv))
1401         PL_sub_generation++;    /* may be deletion of method from stash */
1402     SvREFCNT_dec(val);
1403     if (HeKLEN(entry) == HEf_SVKEY) {
1404         SvREFCNT_dec(HeKEY_sv(entry));
1405         Safefree(HeKEY_hek(entry));
1406     }
1407     else if (HvSHAREKEYS(hv))
1408         unshare_hek(HeKEY_hek(entry));
1409     else
1410         Safefree(HeKEY_hek(entry));
1411     del_HE(entry);
1412 }
1413
1414 void
1415 Perl_hv_delayfree_ent(pTHX_ HV *hv, register HE *entry)
1416 {
1417     if (!entry)
1418         return;
1419     if (isGV(HeVAL(entry)) && GvCVu(HeVAL(entry)) && HvNAME(hv))
1420         PL_sub_generation++;    /* may be deletion of method from stash */
1421     sv_2mortal(HeVAL(entry));   /* free between statements */
1422     if (HeKLEN(entry) == HEf_SVKEY) {
1423         sv_2mortal(HeKEY_sv(entry));
1424         Safefree(HeKEY_hek(entry));
1425     }
1426     else if (HvSHAREKEYS(hv))
1427         unshare_hek(HeKEY_hek(entry));
1428     else
1429         Safefree(HeKEY_hek(entry));
1430     del_HE(entry);
1431 }
1432
1433 /*
1434 =for apidoc hv_clear
1435
1436 Clears a hash, making it empty.
1437
1438 =cut
1439 */
1440
1441 void
1442 Perl_hv_clear(pTHX_ HV *hv)
1443 {
1444     dVAR;
1445     register XPVHV* xhv;
1446     if (!hv)
1447         return;
1448
1449     DEBUG_A(Perl_hv_assert(aTHX_ hv));
1450
1451     xhv = (XPVHV*)SvANY(hv);
1452
1453     if (SvREADONLY(hv) && xhv->xhv_array != NULL) {
1454         /* restricted hash: convert all keys to placeholders */
1455         I32 i;
1456         for (i = 0; i <= (I32) xhv->xhv_max; i++) {
1457             HE *entry = ((HE**)xhv->xhv_array)[i];
1458             for (; entry; entry = HeNEXT(entry)) {
1459                 /* not already placeholder */
1460                 if (HeVAL(entry) != &PL_sv_placeholder) {
1461                     if (HeVAL(entry) && SvREADONLY(HeVAL(entry))) {
1462                         SV* keysv = hv_iterkeysv(entry);
1463                         Perl_croak(aTHX_
1464         "Attempt to delete readonly key '%"SVf"' from a restricted hash",
1465                                    keysv);
1466                     }
1467                     SvREFCNT_dec(HeVAL(entry));
1468                     HeVAL(entry) = &PL_sv_placeholder;
1469                     xhv->xhv_placeholders++; /* HvPLACEHOLDERS(hv)++ */
1470                 }
1471             }
1472         }
1473         goto reset;
1474     }
1475
1476     hfreeentries(hv);
1477     xhv->xhv_placeholders = 0; /* HvPLACEHOLDERS(hv) = 0 */
1478     if (xhv->xhv_array /* HvARRAY(hv) */)
1479         (void)memzero(xhv->xhv_array /* HvARRAY(hv) */,
1480                       (xhv->xhv_max+1 /* HvMAX(hv)+1 */) * sizeof(HE*));
1481
1482     if (SvRMAGICAL(hv))
1483         mg_clear((SV*)hv);
1484
1485     HvHASKFLAGS_off(hv);
1486     HvREHASH_off(hv);
1487     reset:
1488     HvEITER(hv) = NULL;
1489 }
1490
1491 /*
1492 =for apidoc hv_clear_placeholders
1493
1494 Clears any placeholders from a hash.  If a restricted hash has any of its keys
1495 marked as readonly and the key is subsequently deleted, the key is not actually
1496 deleted but is marked by assigning it a value of &PL_sv_placeholder.  This tags
1497 it so it will be ignored by future operations such as iterating over the hash,
1498 but will still allow the hash to have a value reassigned to the key at some
1499 future point.  This function clears any such placeholder keys from the hash.
1500 See Hash::Util::lock_keys() for an example of its use.
1501
1502 =cut
1503 */
1504
1505 void
1506 Perl_hv_clear_placeholders(pTHX_ HV *hv)
1507 {
1508     dVAR;
1509     I32 items = (I32)HvPLACEHOLDERS(hv);
1510     I32 i = HvMAX(hv);
1511
1512     if (items == 0)
1513         return;
1514
1515     do {
1516         /* Loop down the linked list heads  */
1517         bool first = 1;
1518         HE **oentry = &(HvARRAY(hv))[i];
1519         HE *entry = *oentry;
1520
1521         if (!entry)
1522             continue;
1523
1524         for (; entry; entry = *oentry) {
1525             if (HeVAL(entry) == &PL_sv_placeholder) {
1526                 *oentry = HeNEXT(entry);
1527                 if (first && !*oentry)
1528                     HvFILL(hv)--; /* This linked list is now empty.  */
1529                 if (HvEITER(hv))
1530                     HvLAZYDEL_on(hv);
1531                 else
1532                     hv_free_ent(hv, entry);
1533
1534                 if (--items == 0) {
1535                     /* Finished.  */
1536                     HvTOTALKEYS(hv) -= (IV)HvPLACEHOLDERS(hv);
1537                     if (HvKEYS(hv) == 0)
1538                         HvHASKFLAGS_off(hv);
1539                     HvPLACEHOLDERS(hv) = 0;
1540                     return;
1541                 }
1542             } else {
1543                 oentry = &HeNEXT(entry);
1544                 first = 0;
1545             }
1546         }
1547     } while (--i >= 0);
1548     /* You can't get here, hence assertion should always fail.  */
1549     assert (items == 0);
1550     assert (0);
1551 }
1552
1553 STATIC void
1554 S_hfreeentries(pTHX_ HV *hv)
1555 {
1556     register HE **array;
1557     register HE *entry;
1558     I32 riter;
1559     I32 max;
1560
1561     if (!hv)
1562         return;
1563     if (!HvARRAY(hv))
1564         return;
1565
1566     riter = 0;
1567     max = HvMAX(hv);
1568     array = HvARRAY(hv);
1569     /* make everyone else think the array is empty, so that the destructors
1570      * called for freed entries can't recusively mess with us */
1571     HvARRAY(hv) = Null(HE**); 
1572     HvFILL(hv) = 0;
1573     ((XPVHV*) SvANY(hv))->xhv_keys = 0;
1574
1575     entry = array[0];
1576     for (;;) {
1577         if (entry) {
1578             register HE *oentry = entry;
1579             entry = HeNEXT(entry);
1580             hv_free_ent(hv, oentry);
1581         }
1582         if (!entry) {
1583             if (++riter > max)
1584                 break;
1585             entry = array[riter];
1586         }
1587     }
1588     HvARRAY(hv) = array;
1589     (void)hv_iterinit(hv);
1590 }
1591
1592 /*
1593 =for apidoc hv_undef
1594
1595 Undefines the hash.
1596
1597 =cut
1598 */
1599
1600 void
1601 Perl_hv_undef(pTHX_ HV *hv)
1602 {
1603     register XPVHV* xhv;
1604     if (!hv)
1605         return;
1606     DEBUG_A(Perl_hv_assert(aTHX_ hv));
1607     xhv = (XPVHV*)SvANY(hv);
1608     hfreeentries(hv);
1609     Safefree(xhv->xhv_array /* HvARRAY(hv) */);
1610     if (HvNAME(hv)) {
1611         if(PL_stashcache)
1612             hv_delete(PL_stashcache, HvNAME(hv), strlen(HvNAME(hv)), G_DISCARD);
1613         Safefree(HvNAME(hv));
1614         HvNAME(hv) = 0;
1615     }
1616     xhv->xhv_max   = 7; /* HvMAX(hv) = 7 (it's a normal hash) */
1617     xhv->xhv_array = 0; /* HvARRAY(hv) = 0 */
1618     xhv->xhv_placeholders = 0; /* HvPLACEHOLDERS(hv) = 0 */
1619
1620     if (SvRMAGICAL(hv))
1621         mg_clear((SV*)hv);
1622 }
1623
1624 /*
1625 =for apidoc hv_iterinit
1626
1627 Prepares a starting point to traverse a hash table.  Returns the number of
1628 keys in the hash (i.e. the same as C<HvKEYS(tb)>).  The return value is
1629 currently only meaningful for hashes without tie magic.
1630
1631 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1632 hash buckets that happen to be in use.  If you still need that esoteric
1633 value, you can get it through the macro C<HvFILL(tb)>.
1634
1635
1636 =cut
1637 */
1638
1639 I32
1640 Perl_hv_iterinit(pTHX_ HV *hv)
1641 {
1642     register XPVHV* xhv;
1643     HE *entry;
1644
1645     if (!hv)
1646         Perl_croak(aTHX_ "Bad hash");
1647     xhv = (XPVHV*)SvANY(hv);
1648     entry = xhv->xhv_eiter; /* HvEITER(hv) */
1649     if (entry && HvLAZYDEL(hv)) {       /* was deleted earlier? */
1650         HvLAZYDEL_off(hv);
1651         hv_free_ent(hv, entry);
1652     }
1653     xhv->xhv_riter = -1;        /* HvRITER(hv) = -1 */
1654     xhv->xhv_eiter = Null(HE*); /* HvEITER(hv) = Null(HE*) */
1655     /* used to be xhv->xhv_fill before 5.004_65 */
1656     return XHvTOTALKEYS(xhv);
1657 }
1658 /*
1659 =for apidoc hv_iternext
1660
1661 Returns entries from a hash iterator.  See C<hv_iterinit>.
1662
1663 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
1664 iterator currently points to, without losing your place or invalidating your
1665 iterator.  Note that in this case the current entry is deleted from the hash
1666 with your iterator holding the last reference to it.  Your iterator is flagged
1667 to free the entry on the next call to C<hv_iternext>, so you must not discard
1668 your iterator immediately else the entry will leak - call C<hv_iternext> to
1669 trigger the resource deallocation.
1670
1671 =cut
1672 */
1673
1674 HE *
1675 Perl_hv_iternext(pTHX_ HV *hv)
1676 {
1677     return hv_iternext_flags(hv, 0);
1678 }
1679
1680 /*
1681 =for apidoc hv_iternext_flags
1682
1683 Returns entries from a hash iterator.  See C<hv_iterinit> and C<hv_iternext>.
1684 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
1685 set the placeholders keys (for restricted hashes) will be returned in addition
1686 to normal keys. By default placeholders are automatically skipped over.
1687 Currently a placeholder is implemented with a value that is
1688 C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
1689 restricted hashes may change, and the implementation currently is
1690 insufficiently abstracted for any change to be tidy.
1691
1692 =cut
1693 */
1694
1695 HE *
1696 Perl_hv_iternext_flags(pTHX_ HV *hv, I32 flags)
1697 {
1698     dVAR;
1699     register XPVHV* xhv;
1700     register HE *entry;
1701     HE *oldentry;
1702     MAGIC* mg;
1703
1704     if (!hv)
1705         Perl_croak(aTHX_ "Bad hash");
1706     xhv = (XPVHV*)SvANY(hv);
1707     oldentry = entry = xhv->xhv_eiter; /* HvEITER(hv) */
1708
1709     if ((mg = SvTIED_mg((SV*)hv, PERL_MAGIC_tied))) {
1710         SV *key = sv_newmortal();
1711         if (entry) {
1712             sv_setsv(key, HeSVKEY_force(entry));
1713             SvREFCNT_dec(HeSVKEY(entry));       /* get rid of previous key */
1714         }
1715         else {
1716             char *k;
1717             HEK *hek;
1718
1719             /* one HE per MAGICAL hash */
1720             xhv->xhv_eiter = entry = new_HE(); /* HvEITER(hv) = new_HE() */
1721             Zero(entry, 1, HE);
1722             Newz(54, k, HEK_BASESIZE + sizeof(SV*), char);
1723             hek = (HEK*)k;
1724             HeKEY_hek(entry) = hek;
1725             HeKLEN(entry) = HEf_SVKEY;
1726         }
1727         magic_nextpack((SV*) hv,mg,key);
1728         if (SvOK(key)) {
1729             /* force key to stay around until next time */
1730             HeSVKEY_set(entry, SvREFCNT_inc(key));
1731             return entry;               /* beware, hent_val is not set */
1732         }
1733         if (HeVAL(entry))
1734             SvREFCNT_dec(HeVAL(entry));
1735         Safefree(HeKEY_hek(entry));
1736         del_HE(entry);
1737         xhv->xhv_eiter = Null(HE*); /* HvEITER(hv) = Null(HE*) */
1738         return Null(HE*);
1739     }
1740 #ifdef DYNAMIC_ENV_FETCH  /* set up %ENV for iteration */
1741     if (!entry && SvRMAGICAL((SV*)hv) && mg_find((SV*)hv, PERL_MAGIC_env))
1742         prime_env_iter();
1743 #endif
1744
1745     if (!xhv->xhv_array /* !HvARRAY(hv) */)
1746         Newz(506, xhv->xhv_array /* HvARRAY(hv) */,
1747              PERL_HV_ARRAY_ALLOC_BYTES(xhv->xhv_max+1 /* HvMAX(hv)+1 */),
1748              char);
1749     /* At start of hash, entry is NULL.  */
1750     if (entry)
1751     {
1752         entry = HeNEXT(entry);
1753         if (!(flags & HV_ITERNEXT_WANTPLACEHOLDERS)) {
1754             /*
1755              * Skip past any placeholders -- don't want to include them in
1756              * any iteration.
1757              */
1758             while (entry && HeVAL(entry) == &PL_sv_placeholder) {
1759                 entry = HeNEXT(entry);
1760             }
1761         }
1762     }
1763     while (!entry) {
1764         /* OK. Come to the end of the current list.  Grab the next one.  */
1765
1766         xhv->xhv_riter++; /* HvRITER(hv)++ */
1767         if (xhv->xhv_riter > (I32)xhv->xhv_max /* HvRITER(hv) > HvMAX(hv) */) {
1768             /* There is no next one.  End of the hash.  */
1769             xhv->xhv_riter = -1; /* HvRITER(hv) = -1 */
1770             break;
1771         }
1772         /* entry = (HvARRAY(hv))[HvRITER(hv)]; */
1773         entry = ((HE**)xhv->xhv_array)[xhv->xhv_riter];
1774
1775         if (!(flags & HV_ITERNEXT_WANTPLACEHOLDERS)) {
1776             /* If we have an entry, but it's a placeholder, don't count it.
1777                Try the next.  */
1778             while (entry && HeVAL(entry) == &PL_sv_placeholder)
1779                 entry = HeNEXT(entry);
1780         }
1781         /* Will loop again if this linked list starts NULL
1782            (for HV_ITERNEXT_WANTPLACEHOLDERS)
1783            or if we run through it and find only placeholders.  */
1784     }
1785
1786     if (oldentry && HvLAZYDEL(hv)) {            /* was deleted earlier? */
1787         HvLAZYDEL_off(hv);
1788         hv_free_ent(hv, oldentry);
1789     }
1790
1791     /*if (HvREHASH(hv) && entry && !HeKREHASH(entry))
1792       PerlIO_printf(PerlIO_stderr(), "Awooga %p %p\n", hv, entry);*/
1793
1794     xhv->xhv_eiter = entry; /* HvEITER(hv) = entry */
1795     return entry;
1796 }
1797
1798 /*
1799 =for apidoc hv_iterkey
1800
1801 Returns the key from the current position of the hash iterator.  See
1802 C<hv_iterinit>.
1803
1804 =cut
1805 */
1806
1807 char *
1808 Perl_hv_iterkey(pTHX_ register HE *entry, I32 *retlen)
1809 {
1810     if (HeKLEN(entry) == HEf_SVKEY) {
1811         STRLEN len;
1812         char *p = SvPV(HeKEY_sv(entry), len);
1813         *retlen = len;
1814         return p;
1815     }
1816     else {
1817         *retlen = HeKLEN(entry);
1818         return HeKEY(entry);
1819     }
1820 }
1821
1822 /* unlike hv_iterval(), this always returns a mortal copy of the key */
1823 /*
1824 =for apidoc hv_iterkeysv
1825
1826 Returns the key as an C<SV*> from the current position of the hash
1827 iterator.  The return value will always be a mortal copy of the key.  Also
1828 see C<hv_iterinit>.
1829
1830 =cut
1831 */
1832
1833 SV *
1834 Perl_hv_iterkeysv(pTHX_ register HE *entry)
1835 {
1836     if (HeKLEN(entry) != HEf_SVKEY) {
1837         HEK *hek = HeKEY_hek(entry);
1838         const int flags = HEK_FLAGS(hek);
1839         SV *sv;
1840
1841         if (flags & HVhek_WASUTF8) {
1842             /* Trouble :-)
1843                Andreas would like keys he put in as utf8 to come back as utf8
1844             */
1845             STRLEN utf8_len = HEK_LEN(hek);
1846             U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
1847
1848             sv = newSVpvn ((char*)as_utf8, utf8_len);
1849             SvUTF8_on (sv);
1850             Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
1851         } else if (flags & HVhek_REHASH) {
1852             /* We don't have a pointer to the hv, so we have to replicate the
1853                flag into every HEK. This hv is using custom a hasing
1854                algorithm. Hence we can't return a shared string scalar, as
1855                that would contain the (wrong) hash value, and might get passed
1856                into an hv routine with a regular hash  */
1857
1858             sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
1859             if (HEK_UTF8(hek))
1860                 SvUTF8_on (sv);
1861         } else {
1862             sv = newSVpvn_share(HEK_KEY(hek),
1863                                 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
1864                                 HEK_HASH(hek));
1865         }
1866         return sv_2mortal(sv);
1867     }
1868     return sv_mortalcopy(HeKEY_sv(entry));
1869 }
1870
1871 /*
1872 =for apidoc hv_iterval
1873
1874 Returns the value from the current position of the hash iterator.  See
1875 C<hv_iterkey>.
1876
1877 =cut
1878 */
1879
1880 SV *
1881 Perl_hv_iterval(pTHX_ HV *hv, register HE *entry)
1882 {
1883     if (SvRMAGICAL(hv)) {
1884         if (mg_find((SV*)hv, PERL_MAGIC_tied)) {
1885             SV* sv = sv_newmortal();
1886             if (HeKLEN(entry) == HEf_SVKEY)
1887                 mg_copy((SV*)hv, sv, (char*)HeKEY_sv(entry), HEf_SVKEY);
1888             else
1889                 mg_copy((SV*)hv, sv, HeKEY(entry), HeKLEN(entry));
1890             return sv;
1891         }
1892     }
1893     return HeVAL(entry);
1894 }
1895
1896 /*
1897 =for apidoc hv_iternextsv
1898
1899 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1900 operation.
1901
1902 =cut
1903 */
1904
1905 SV *
1906 Perl_hv_iternextsv(pTHX_ HV *hv, char **key, I32 *retlen)
1907 {
1908     HE *he;
1909     if ( (he = hv_iternext_flags(hv, 0)) == NULL)
1910         return NULL;
1911     *key = hv_iterkey(he, retlen);
1912     return hv_iterval(hv, he);
1913 }
1914
1915 /*
1916 =for apidoc hv_magic
1917
1918 Adds magic to a hash.  See C<sv_magic>.
1919
1920 =cut
1921 */
1922
1923 void
1924 Perl_hv_magic(pTHX_ HV *hv, GV *gv, int how)
1925 {
1926     sv_magic((SV*)hv, (SV*)gv, how, Nullch, 0);
1927 }
1928
1929 #if 0 /* use the macro from hv.h instead */
1930
1931 char*   
1932 Perl_sharepvn(pTHX_ const char *sv, I32 len, U32 hash)
1933 {
1934     return HEK_KEY(share_hek(sv, len, hash));
1935 }
1936
1937 #endif
1938
1939 /* possibly free a shared string if no one has access to it
1940  * len and hash must both be valid for str.
1941  */
1942 void
1943 Perl_unsharepvn(pTHX_ const char *str, I32 len, U32 hash)
1944 {
1945     unshare_hek_or_pvn (NULL, str, len, hash);
1946 }
1947
1948
1949 void
1950 Perl_unshare_hek(pTHX_ HEK *hek)
1951 {
1952     unshare_hek_or_pvn(hek, NULL, 0, 0);
1953 }
1954
1955 /* possibly free a shared string if no one has access to it
1956    hek if non-NULL takes priority over the other 3, else str, len and hash
1957    are used.  If so, len and hash must both be valid for str.
1958  */
1959 STATIC void
1960 S_unshare_hek_or_pvn(pTHX_ HEK *hek, const char *str, I32 len, U32 hash)
1961 {
1962     register XPVHV* xhv;
1963     register HE *entry;
1964     register HE **oentry;
1965     register I32 i = 1;
1966     bool found = 0;
1967     bool is_utf8 = FALSE;
1968     int k_flags = 0;
1969     const char *save = str;
1970
1971     if (hek) {
1972         hash = HEK_HASH(hek);
1973     } else if (len < 0) {
1974         STRLEN tmplen = -len;
1975         is_utf8 = TRUE;
1976         /* See the note in hv_fetch(). --jhi */
1977         str = (char*)bytes_from_utf8((U8*)str, &tmplen, &is_utf8);
1978         len = tmplen;
1979         if (is_utf8)
1980             k_flags = HVhek_UTF8;
1981         if (str != save)
1982             k_flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
1983     }
1984
1985     /* what follows is the moral equivalent of:
1986     if ((Svp = hv_fetch(PL_strtab, tmpsv, FALSE, hash))) {
1987         if (--*Svp == Nullsv)
1988             hv_delete(PL_strtab, str, len, G_DISCARD, hash);
1989     } */
1990     xhv = (XPVHV*)SvANY(PL_strtab);
1991     /* assert(xhv_array != 0) */
1992     LOCK_STRTAB_MUTEX;
1993     /* oentry = &(HvARRAY(hv))[hash & (I32) HvMAX(hv)]; */
1994     oentry = &((HE**)xhv->xhv_array)[hash & (I32) xhv->xhv_max];
1995     if (hek) {
1996         for (entry = *oentry; entry; i=0, oentry = &HeNEXT(entry), entry = *oentry) {
1997             if (HeKEY_hek(entry) != hek)
1998                 continue;
1999             found = 1;
2000             break;
2001         }
2002     } else {
2003         const int flags_masked = k_flags & HVhek_MASK;
2004         for (entry = *oentry; entry; i=0, oentry = &HeNEXT(entry), entry = *oentry) {
2005             if (HeHASH(entry) != hash)          /* strings can't be equal */
2006                 continue;
2007             if (HeKLEN(entry) != len)
2008                 continue;
2009             if (HeKEY(entry) != str && memNE(HeKEY(entry),str,len))     /* is this it? */
2010                 continue;
2011             if (HeKFLAGS(entry) != flags_masked)
2012                 continue;
2013             found = 1;
2014             break;
2015         }
2016     }
2017
2018     if (found) {
2019         if (--HeVAL(entry) == Nullsv) {
2020             *oentry = HeNEXT(entry);
2021             if (i && !*oentry)
2022                 xhv->xhv_fill--; /* HvFILL(hv)-- */
2023             Safefree(HeKEY_hek(entry));
2024             del_HE(entry);
2025             xhv->xhv_keys--; /* HvKEYS(hv)-- */
2026         }
2027     }
2028
2029     UNLOCK_STRTAB_MUTEX;
2030     if (!found && ckWARN_d(WARN_INTERNAL))
2031         Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
2032                     "Attempt to free non-existent shared string '%s'%s"
2033                     pTHX__FORMAT,
2034                     hek ? HEK_KEY(hek) : str,
2035                     ((k_flags & HVhek_UTF8) ? " (utf8)" : "") pTHX__VALUE);
2036     if (k_flags & HVhek_FREEKEY)
2037         Safefree(str);
2038 }
2039
2040 /* get a (constant) string ptr from the global string table
2041  * string will get added if it is not already there.
2042  * len and hash must both be valid for str.
2043  */
2044 HEK *
2045 Perl_share_hek(pTHX_ const char *str, I32 len, register U32 hash)
2046 {
2047     bool is_utf8 = FALSE;
2048     int flags = 0;
2049     const char *save = str;
2050
2051     if (len < 0) {
2052       STRLEN tmplen = -len;
2053       is_utf8 = TRUE;
2054       /* See the note in hv_fetch(). --jhi */
2055       str = (char*)bytes_from_utf8((U8*)str, &tmplen, &is_utf8);
2056       len = tmplen;
2057       /* If we were able to downgrade here, then than means that we were passed
2058          in a key which only had chars 0-255, but was utf8 encoded.  */
2059       if (is_utf8)
2060           flags = HVhek_UTF8;
2061       /* If we found we were able to downgrade the string to bytes, then
2062          we should flag that it needs upgrading on keys or each.  Also flag
2063          that we need share_hek_flags to free the string.  */
2064       if (str != save)
2065           flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
2066     }
2067
2068     return share_hek_flags (str, len, hash, flags);
2069 }
2070
2071 STATIC HEK *
2072 S_share_hek_flags(pTHX_ const char *str, I32 len, register U32 hash, int flags)
2073 {
2074     register XPVHV* xhv;
2075     register HE *entry;
2076     register HE **oentry;
2077     register I32 i = 1;
2078     I32 found = 0;
2079     const int flags_masked = flags & HVhek_MASK;
2080
2081     /* what follows is the moral equivalent of:
2082
2083     if (!(Svp = hv_fetch(PL_strtab, str, len, FALSE)))
2084         hv_store(PL_strtab, str, len, Nullsv, hash);
2085
2086         Can't rehash the shared string table, so not sure if it's worth
2087         counting the number of entries in the linked list
2088     */
2089     xhv = (XPVHV*)SvANY(PL_strtab);
2090     /* assert(xhv_array != 0) */
2091     LOCK_STRTAB_MUTEX;
2092     /* oentry = &(HvARRAY(hv))[hash & (I32) HvMAX(hv)]; */
2093     oentry = &((HE**)xhv->xhv_array)[hash & (I32) xhv->xhv_max];
2094     for (entry = *oentry; entry; i=0, entry = HeNEXT(entry)) {
2095         if (HeHASH(entry) != hash)              /* strings can't be equal */
2096             continue;
2097         if (HeKLEN(entry) != len)
2098             continue;
2099         if (HeKEY(entry) != str && memNE(HeKEY(entry),str,len)) /* is this it? */
2100             continue;
2101         if (HeKFLAGS(entry) != flags_masked)
2102             continue;
2103         found = 1;
2104         break;
2105     }
2106     if (!found) {
2107         entry = new_HE();
2108         HeKEY_hek(entry) = save_hek_flags(str, len, hash, flags_masked);
2109         HeVAL(entry) = Nullsv;
2110         HeNEXT(entry) = *oentry;
2111         *oentry = entry;
2112         xhv->xhv_keys++; /* HvKEYS(hv)++ */
2113         if (i) {                                /* initial entry? */
2114             xhv->xhv_fill++; /* HvFILL(hv)++ */
2115         } else if (xhv->xhv_keys > (IV)xhv->xhv_max /* HvKEYS(hv) > HvMAX(hv) */) {
2116                 hsplit(PL_strtab);
2117         }
2118     }
2119
2120     ++HeVAL(entry);                             /* use value slot as REFCNT */
2121     UNLOCK_STRTAB_MUTEX;
2122
2123     if (flags & HVhek_FREEKEY)
2124         Safefree(str);
2125
2126     return HeKEY_hek(entry);
2127 }
2128
2129
2130 /*
2131 =for apidoc hv_assert
2132
2133 Check that a hash is in an internally consistent state.
2134
2135 =cut
2136 */
2137
2138 void
2139 Perl_hv_assert(pTHX_ HV *hv)
2140 {
2141   dVAR;
2142   HE* entry;
2143   int withflags = 0;
2144   int placeholders = 0;
2145   int real = 0;
2146   int bad = 0;
2147   const I32 riter = HvRITER(hv);
2148   HE *eiter = HvEITER(hv);
2149
2150   (void)hv_iterinit(hv);
2151
2152   while ((entry = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS))) {
2153     /* sanity check the values */
2154     if (HeVAL(entry) == &PL_sv_placeholder) {
2155       placeholders++;
2156     } else {
2157       real++;
2158     }
2159     /* sanity check the keys */
2160     if (HeSVKEY(entry)) {
2161       /* Don't know what to check on SV keys.  */
2162     } else if (HeKUTF8(entry)) {
2163       withflags++;
2164        if (HeKWASUTF8(entry)) {
2165          PerlIO_printf(Perl_debug_log,
2166                        "hash key has both WASUFT8 and UTF8: '%.*s'\n",
2167                        (int) HeKLEN(entry),  HeKEY(entry));
2168          bad = 1;
2169        }
2170     } else if (HeKWASUTF8(entry)) {
2171       withflags++;
2172     }
2173   }
2174   if (!SvTIED_mg((SV*)hv, PERL_MAGIC_tied)) {
2175     if (HvUSEDKEYS(hv) != real) {
2176       PerlIO_printf(Perl_debug_log, "Count %d key(s), but hash reports %d\n",
2177                     (int) real, (int) HvUSEDKEYS(hv));
2178       bad = 1;
2179     }
2180     if (HvPLACEHOLDERS(hv) != placeholders) {
2181       PerlIO_printf(Perl_debug_log,
2182                     "Count %d placeholder(s), but hash reports %d\n",
2183                     (int) placeholders, (int) HvPLACEHOLDERS(hv));
2184       bad = 1;
2185     }
2186   }
2187   if (withflags && ! HvHASKFLAGS(hv)) {
2188     PerlIO_printf(Perl_debug_log,
2189                   "Hash has HASKFLAGS off but I count %d key(s) with flags\n",
2190                   withflags);
2191     bad = 1;
2192   }
2193   if (bad) {
2194     sv_dump((SV *)hv);
2195   }
2196   HvRITER(hv) = riter;          /* Restore hash iterator state */
2197   HvEITER(hv) = eiter;
2198 }
2199
2200 /*
2201  * Local variables:
2202  * c-indentation-style: bsd
2203  * c-basic-offset: 4
2204  * indent-tabs-mode: t
2205  * End:
2206  *
2207  * ex: set ts=8 sts=4 sw=4 noet:
2208  */