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