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