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