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