This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
[perl #123788] update isa magic stash records when *ISA is deleted
[perl5.git] / hv.c
CommitLineData
a0d0e21e 1/* hv.c
79072805 2 *
1129b882
NC
3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4 * 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 by Larry Wall and others
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/*
4ac71550
TC
12 * I sit beside the fire and think
13 * of all that I have seen.
14 * --Bilbo
15 *
16 * [p.278 of _The Lord of the Rings_, II/iii: "The Ring Goes South"]
79072805
LW
17 */
18
d5afce77
RB
19/*
20=head1 Hash Manipulation Functions
db4fbf16
FC
21A HV structure represents a Perl hash. It consists mainly of an array
22of pointers, each of which points to a linked list of HE structures. The
166f8a29 23array is indexed by the hash function of the key, so each linked list
db4fbf16 24represents all the hash entries with the same hash value. Each HE contains
166f8a29
DM
25a pointer to the actual value, plus a pointer to a HEK structure which
26holds the key and hash value.
27
28=cut
29
d5afce77
RB
30*/
31
79072805 32#include "EXTERN.h"
864dbfa3 33#define PERL_IN_HV_C
3d78eb94 34#define PERL_HASH_INTERNAL_ACCESS
79072805
LW
35#include "perl.h"
36
8e317198 37#define DO_HSPLIT(xhv) ((xhv)->xhv_keys > (xhv)->xhv_max) /* HvTOTALKEYS(hv) > HvMAX(hv) */
9faf471a 38#define HV_FILL_THRESHOLD 31
fdcd69b6 39
d75ce684 40static const char S_strtab_error[]
5d2b1485
NC
41 = "Cannot modify shared string table in hv_%s";
42
c941fb51
NC
43#ifdef PURIFY
44
45#define new_HE() (HE*)safemalloc(sizeof(HE))
46#define del_HE(p) safefree((char*)p)
47
48#else
49
76e3520e 50STATIC HE*
cea2e8a9 51S_new_he(pTHX)
4633a7c4
LW
52{
53 HE* he;
0bd48802 54 void ** const root = &PL_body_roots[HE_SVSLOT];
6a93a7e5 55
6a93a7e5 56 if (!*root)
1e30fcd5 57 Perl_more_bodies(aTHX_ HE_SVSLOT, sizeof(HE), PERL_ARENA_SIZE);
10edeb5d 58 he = (HE*) *root;
ce3e5c45 59 assert(he);
6a93a7e5 60 *root = HeNEXT(he);
333f433b 61 return he;
4633a7c4
LW
62}
63
c941fb51
NC
64#define new_HE() new_he()
65#define del_HE(p) \
66 STMT_START { \
6a93a7e5
NC
67 HeNEXT(p) = (HE*)(PL_body_roots[HE_SVSLOT]); \
68 PL_body_roots[HE_SVSLOT] = p; \
c941fb51 69 } STMT_END
d33b2eba 70
d33b2eba 71
d33b2eba
GS
72
73#endif
74
76e3520e 75STATIC HEK *
5f66b61c 76S_save_hek_flags(const char *str, I32 len, U32 hash, int flags)
bbce6d69 77{
35a4481c 78 const int flags_masked = flags & HVhek_MASK;
bbce6d69 79 char *k;
eb578fdb 80 HEK *hek;
1c846c1f 81
7918f24d
NC
82 PERL_ARGS_ASSERT_SAVE_HEK_FLAGS;
83
a02a5408 84 Newx(k, HEK_BASESIZE + len + 2, char);
bbce6d69 85 hek = (HEK*)k;
ff68c719 86 Copy(str, HEK_KEY(hek), len, char);
e05949c7 87 HEK_KEY(hek)[len] = 0;
ff68c719
PP
88 HEK_LEN(hek) = len;
89 HEK_HASH(hek) = hash;
45e34800 90 HEK_FLAGS(hek) = (unsigned char)flags_masked | HVhek_UNSHARED;
dcf933a4
NC
91
92 if (flags & HVhek_FREEKEY)
93 Safefree(str);
bbce6d69
PP
94 return hek;
95}
96
4a31713e 97/* free the pool of temporary HE/HEK pairs returned by hv_fetch_ent
dd28f7bb
DM
98 * for tied hashes */
99
100void
101Perl_free_tied_hv_pool(pTHX)
102{
dd28f7bb
DM
103 HE *he = PL_hv_fetch_ent_mh;
104 while (he) {
9d4ba2ae 105 HE * const ohe = he;
dd28f7bb 106 Safefree(HeKEY_hek(he));
dd28f7bb
DM
107 he = HeNEXT(he);
108 del_HE(ohe);
109 }
4608196e 110 PL_hv_fetch_ent_mh = NULL;
dd28f7bb
DM
111}
112
d18c6117 113#if defined(USE_ITHREADS)
0bff533c
NC
114HEK *
115Perl_hek_dup(pTHX_ HEK *source, CLONE_PARAMS* param)
116{
566771cc 117 HEK *shared;
9d4ba2ae 118
7918f24d 119 PERL_ARGS_ASSERT_HEK_DUP;
9d4ba2ae 120 PERL_UNUSED_ARG(param);
0bff533c 121
566771cc
NC
122 if (!source)
123 return NULL;
124
125 shared = (HEK*)ptr_table_fetch(PL_ptr_table, source);
0bff533c
NC
126 if (shared) {
127 /* We already shared this hash key. */
454f1e26 128 (void)share_hek_hek(shared);
0bff533c
NC
129 }
130 else {
658b4a4a 131 shared
6e838c70
NC
132 = share_hek_flags(HEK_KEY(source), HEK_LEN(source),
133 HEK_HASH(source), HEK_FLAGS(source));
658b4a4a 134 ptr_table_store(PL_ptr_table, source, shared);
0bff533c 135 }
658b4a4a 136 return shared;
0bff533c
NC
137}
138
d18c6117 139HE *
5c4138a0 140Perl_he_dup(pTHX_ const HE *e, bool shared, CLONE_PARAMS* param)
d18c6117
GS
141{
142 HE *ret;
143
7918f24d
NC
144 PERL_ARGS_ASSERT_HE_DUP;
145
d18c6117 146 if (!e)
4608196e 147 return NULL;
7766f137
GS
148 /* look for it in the table first */
149 ret = (HE*)ptr_table_fetch(PL_ptr_table, e);
150 if (ret)
151 return ret;
152
153 /* create anew and remember what it is */
d33b2eba 154 ret = new_HE();
7766f137
GS
155 ptr_table_store(PL_ptr_table, e, ret);
156
d2d73c3e 157 HeNEXT(ret) = he_dup(HeNEXT(e),shared, param);
dd28f7bb
DM
158 if (HeKLEN(e) == HEf_SVKEY) {
159 char *k;
ad64d0ec 160 Newx(k, HEK_BASESIZE + sizeof(const SV *), char);
dd28f7bb 161 HeKEY_hek(ret) = (HEK*)k;
a09252eb 162 HeKEY_sv(ret) = sv_dup_inc(HeKEY_sv(e), param);
dd28f7bb 163 }
c21d1a0f 164 else if (shared) {
0bff533c
NC
165 /* This is hek_dup inlined, which seems to be important for speed
166 reasons. */
1b6737cc 167 HEK * const source = HeKEY_hek(e);
658b4a4a 168 HEK *shared = (HEK*)ptr_table_fetch(PL_ptr_table, source);
c21d1a0f
NC
169
170 if (shared) {
171 /* We already shared this hash key. */
454f1e26 172 (void)share_hek_hek(shared);
c21d1a0f
NC
173 }
174 else {
658b4a4a 175 shared
6e838c70
NC
176 = share_hek_flags(HEK_KEY(source), HEK_LEN(source),
177 HEK_HASH(source), HEK_FLAGS(source));
658b4a4a 178 ptr_table_store(PL_ptr_table, source, shared);
c21d1a0f 179 }
658b4a4a 180 HeKEY_hek(ret) = shared;
c21d1a0f 181 }
d18c6117 182 else
19692e8d
NC
183 HeKEY_hek(ret) = save_hek_flags(HeKEY(e), HeKLEN(e), HeHASH(e),
184 HeKFLAGS(e));
a09252eb 185 HeVAL(ret) = sv_dup_inc(HeVAL(e), param);
d18c6117
GS
186 return ret;
187}
188#endif /* USE_ITHREADS */
189
1b1f1335 190static void
2393f1b9
JH
191S_hv_notallowed(pTHX_ int flags, const char *key, I32 klen,
192 const char *msg)
1b1f1335 193{
1b6737cc 194 SV * const sv = sv_newmortal();
7918f24d
NC
195
196 PERL_ARGS_ASSERT_HV_NOTALLOWED;
197
19692e8d 198 if (!(flags & HVhek_FREEKEY)) {
1b1f1335
NIS
199 sv_setpvn(sv, key, klen);
200 }
201 else {
202 /* Need to free saved eventually assign to mortal SV */
34c3c4e3 203 /* XXX is this line an error ???: SV *sv = sv_newmortal(); */
1b1f1335
NIS
204 sv_usepvn(sv, (char *) key, klen);
205 }
19692e8d 206 if (flags & HVhek_UTF8) {
1b1f1335
NIS
207 SvUTF8_on(sv);
208 }
be2597df 209 Perl_croak(aTHX_ msg, SVfARG(sv));
1b1f1335
NIS
210}
211
fde52b5c
PP
212/* (klen == HEf_SVKEY) is special for MAGICAL hv entries, meaning key slot
213 * contains an SV* */
214
34a6f7b4
NC
215/*
216=for apidoc hv_store
217
a05d6c5d
TC
218Stores an SV in a hash. The hash key is specified as C<key> and the
219absolute value of C<klen> is the length of the key. If C<klen> is
220negative the key is assumed to be in UTF-8-encoded Unicode. The
221C<hash> parameter is the precomputed hash value; if it is zero then
222Perl will compute it.
223
224The return value will be
796b6530 225C<NULL> if the operation failed or if the value did not need to be actually
34a6f7b4
NC
226stored within the hash (as in the case of tied hashes). Otherwise it can
227be dereferenced to get the original C<SV*>. Note that the caller is
228responsible for suitably incrementing the reference count of C<val> before
796b6530
KW
229the call, and decrementing it if the function returned C<NULL>. Effectively
230a successful C<hv_store> takes ownership of one reference to C<val>. This is
34a6f7b4 231usually what you want; a newly created SV has a reference count of one, so
796b6530 232if all your code does is create SVs then store them in a hash, C<hv_store>
34a6f7b4 233will own the only reference to the new SV, and your code doesn't need to do
796b6530
KW
234anything further to tidy up. C<hv_store> is not implemented as a call to
235C<hv_store_ent>, and does not create a temporary SV for the key, so if your
236key data is not already in SV form then use C<hv_store> in preference to
237C<hv_store_ent>.
34a6f7b4
NC
238
239See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
240information on how to use this function on tied hashes.
241
34a6f7b4
NC
242=for apidoc hv_store_ent
243
244Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
245parameter is the precomputed hash value; if it is zero then Perl will
246compute it. The return value is the new hash entry so created. It will be
796b6530 247C<NULL> if the operation failed or if the value did not need to be actually
34a6f7b4
NC
248stored within the hash (as in the case of tied hashes). Otherwise the
249contents of the return value can be accessed using the C<He?> macros
250described here. Note that the caller is responsible for suitably
251incrementing the reference count of C<val> before the call, and
252decrementing it if the function returned NULL. Effectively a successful
796b6530 253C<hv_store_ent> takes ownership of one reference to C<val>. This is
34a6f7b4 254usually what you want; a newly created SV has a reference count of one, so
796b6530 255if all your code does is create SVs then store them in a hash, C<hv_store>
34a6f7b4 256will own the only reference to the new SV, and your code doesn't need to do
796b6530 257anything further to tidy up. Note that C<hv_store_ent> only reads the C<key>;
34a6f7b4 258unlike C<val> it does not take ownership of it, so maintaining the correct
796b6530
KW
259reference count on C<key> is entirely the caller's responsibility. C<hv_store>
260is not implemented as a call to C<hv_store_ent>, and does not create a temporary
34a6f7b4 261SV for the key, so if your key data is not already in SV form then use
796b6530 262C<hv_store> in preference to C<hv_store_ent>.
34a6f7b4
NC
263
264See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
265information on how to use this function on tied hashes.
266
34a6f7b4
NC
267=for apidoc hv_exists
268
269Returns a boolean indicating whether the specified hash key exists. The
a05d6c5d
TC
270absolute value of C<klen> is the length of the key. If C<klen> is
271negative the key is assumed to be in UTF-8-encoded Unicode.
34a6f7b4 272
954c1994
GS
273=for apidoc hv_fetch
274
a05d6c5d
TC
275Returns the SV which corresponds to the specified key in the hash.
276The absolute value of C<klen> is the length of the key. If C<klen> is
277negative the key is assumed to be in UTF-8-encoded Unicode. If
43d3b06a
KW
278C<lval> is set then the fetch will be part of a store. This means that if
279there is no value in the hash associated with the given key, then one is
280created and a pointer to it is returned. The C<SV*> it points to can be
281assigned to. But always check that the
a05d6c5d 282return value is non-null before dereferencing it to an C<SV*>.
954c1994 283
96f1132b 284See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
954c1994
GS
285information on how to use this function on tied hashes.
286
34a6f7b4
NC
287=for apidoc hv_exists_ent
288
db4fbf16
FC
289Returns a boolean indicating whether
290the specified hash key exists. C<hash>
34a6f7b4
NC
291can be a valid precomputed hash value, or 0 to ask for it to be
292computed.
293
294=cut
295*/
296
d1be9408 297/* returns an HE * structure with the all fields set */
fde52b5c 298/* note that hent_val will be a mortal sv for MAGICAL hashes */
954c1994
GS
299/*
300=for apidoc hv_fetch_ent
301
302Returns the hash entry which corresponds to the specified key in the hash.
303C<hash> must be a valid precomputed hash number for the given C<key>, or 0
304if you want the function to compute it. IF C<lval> is set then the fetch
305will be part of a store. Make sure the return value is non-null before
b24b84ef 306accessing it. The return value when C<hv> is a tied hash is a pointer to a
954c1994 307static location, so be sure to make a copy of the structure if you need to
1c846c1f 308store it somewhere.
954c1994 309
96f1132b 310See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
954c1994
GS
311information on how to use this function on tied hashes.
312
313=cut
314*/
315
a038e571
NC
316/* Common code for hv_delete()/hv_exists()/hv_fetch()/hv_store() */
317void *
318Perl_hv_common_key_len(pTHX_ HV *hv, const char *key, I32 klen_i32,
319 const int action, SV *val, const U32 hash)
320{
321 STRLEN klen;
322 int flags;
323
7918f24d
NC
324 PERL_ARGS_ASSERT_HV_COMMON_KEY_LEN;
325
a038e571
NC
326 if (klen_i32 < 0) {
327 klen = -klen_i32;
328 flags = HVhek_UTF8;
329 } else {
330 klen = klen_i32;
331 flags = 0;
332 }
333 return hv_common(hv, NULL, key, klen, flags, action, val, hash);
334}
335
63c89345 336void *
d3ba3f5c 337Perl_hv_common(pTHX_ HV *hv, SV *keysv, const char *key, STRLEN klen,
5aaab254 338 int flags, int action, SV *val, U32 hash)
113738bb 339{
27da23d5 340 dVAR;
b2c64049 341 XPVHV* xhv;
b2c64049
NC
342 HE *entry;
343 HE **oentry;
fde52b5c 344 SV *sv;
da58a35d 345 bool is_utf8;
113738bb 346 int masked_flags;
3c84c864 347 const int return_svp = action & HV_FETCH_JUST_SV;
34dadc62 348 HEK *keysv_hek = NULL;
fde52b5c
PP
349
350 if (!hv)
a4fc7abc 351 return NULL;
e4787c0c 352 if (SvTYPE(hv) == (svtype)SVTYPEMASK)
8265e3d1
NC
353 return NULL;
354
355 assert(SvTYPE(hv) == SVt_PVHV);
fde52b5c 356
bdee33e4 357 if (SvSMAGICAL(hv) && SvGMAGICAL(hv) && !(action & HV_DISABLE_UVAR_XKEY)) {
fda2d18a 358 MAGIC* mg;
ad64d0ec 359 if ((mg = mg_find((const SV *)hv, PERL_MAGIC_uvar))) {
fda2d18a
NC
360 struct ufuncs * const uf = (struct ufuncs *)mg->mg_ptr;
361 if (uf->uf_set == NULL) {
362 SV* obj = mg->mg_obj;
363
364 if (!keysv) {
59cd0e26
NC
365 keysv = newSVpvn_flags(key, klen, SVs_TEMP |
366 ((flags & HVhek_UTF8)
367 ? SVf_UTF8 : 0));
fda2d18a
NC
368 }
369
370 mg->mg_obj = keysv; /* pass key */
371 uf->uf_index = action; /* pass action */
ad64d0ec 372 magic_getuvar(MUTABLE_SV(hv), mg);
fda2d18a
NC
373 keysv = mg->mg_obj; /* may have changed */
374 mg->mg_obj = obj;
375
376 /* If the key may have changed, then we need to invalidate
377 any passed-in computed hash value. */
378 hash = 0;
379 }
380 }
bdee33e4 381 }
113738bb 382 if (keysv) {
e593d2fe
AE
383 if (flags & HVhek_FREEKEY)
384 Safefree(key);
5c144d81 385 key = SvPV_const(keysv, klen);
113738bb 386 is_utf8 = (SvUTF8(keysv) != 0);
44b87b50
NC
387 if (SvIsCOW_shared_hash(keysv)) {
388 flags = HVhek_KEYCANONICAL | (is_utf8 ? HVhek_UTF8 : 0);
389 } else {
0ddecb91 390 flags = is_utf8 ? HVhek_UTF8 : 0;
44b87b50 391 }
113738bb 392 } else {
c1fe5510 393 is_utf8 = ((flags & HVhek_UTF8) ? TRUE : FALSE);
113738bb 394 }
113738bb 395
9dbc5603 396 if (action & HV_DELETE) {
3c84c864 397 return (void *) hv_delete_common(hv, keysv, key, klen,
0ddecb91 398 flags, action, hash);
9dbc5603
NC
399 }
400
b2c64049 401 xhv = (XPVHV*)SvANY(hv);
7f66fda2 402 if (SvMAGICAL(hv)) {
6136c704 403 if (SvRMAGICAL(hv) && !(action & (HV_FETCH_ISSTORE|HV_FETCH_ISEXISTS))) {
ad64d0ec
NC
404 if (mg_find((const SV *)hv, PERL_MAGIC_tied)
405 || SvGMAGICAL((const SV *)hv))
e62cc96a 406 {
3c84c864 407 /* FIXME should be able to skimp on the HE/HEK here when
7f66fda2 408 HV_FETCH_JUST_SV is true. */
7f66fda2 409 if (!keysv) {
740cce10
NC
410 keysv = newSVpvn_utf8(key, klen, is_utf8);
411 } else {
7f66fda2 412 keysv = newSVsv(keysv);
113738bb 413 }
44a2ac75 414 sv = sv_newmortal();
ad64d0ec 415 mg_copy(MUTABLE_SV(hv), sv, (char *)keysv, HEf_SVKEY);
7f66fda2
NC
416
417 /* grab a fake HE/HEK pair from the pool or make a new one */
418 entry = PL_hv_fetch_ent_mh;
419 if (entry)
420 PL_hv_fetch_ent_mh = HeNEXT(entry);
421 else {
422 char *k;
423 entry = new_HE();
ad64d0ec 424 Newx(k, HEK_BASESIZE + sizeof(const SV *), char);
7f66fda2
NC
425 HeKEY_hek(entry) = (HEK*)k;
426 }
4608196e 427 HeNEXT(entry) = NULL;
7f66fda2
NC
428 HeSVKEY_set(entry, keysv);
429 HeVAL(entry) = sv;
430 sv_upgrade(sv, SVt_PVLV);
431 LvTYPE(sv) = 'T';
432 /* so we can free entry when freeing sv */
ad64d0ec 433 LvTARG(sv) = MUTABLE_SV(entry);
7f66fda2
NC
434
435 /* XXX remove at some point? */
436 if (flags & HVhek_FREEKEY)
437 Safefree(key);
438
3c84c864
NC
439 if (return_svp) {
440 return entry ? (void *) &HeVAL(entry) : NULL;
441 }
442 return (void *) entry;
113738bb 443 }
7f66fda2 444#ifdef ENV_IS_CASELESS
ad64d0ec 445 else if (mg_find((const SV *)hv, PERL_MAGIC_env)) {
7f66fda2
NC
446 U32 i;
447 for (i = 0; i < klen; ++i)
448 if (isLOWER(key[i])) {
086cb327
NC
449 /* Would be nice if we had a routine to do the
450 copy and upercase in a single pass through. */
0bd48802 451 const char * const nkey = strupr(savepvn(key,klen));
086cb327
NC
452 /* Note that this fetch is for nkey (the uppercased
453 key) whereas the store is for key (the original) */
63c89345
NC
454 void *result = hv_common(hv, NULL, nkey, klen,
455 HVhek_FREEKEY, /* free nkey */
456 0 /* non-LVAL fetch */
3c84c864
NC
457 | HV_DISABLE_UVAR_XKEY
458 | return_svp,
63c89345
NC
459 NULL /* no value */,
460 0 /* compute hash */);
26488bcf 461 if (!result && (action & HV_FETCH_LVALUE)) {
086cb327
NC
462 /* This call will free key if necessary.
463 Do it this way to encourage compiler to tail
464 call optimise. */
63c89345
NC
465 result = hv_common(hv, keysv, key, klen, flags,
466 HV_FETCH_ISSTORE
3c84c864
NC
467 | HV_DISABLE_UVAR_XKEY
468 | return_svp,
63c89345 469 newSV(0), hash);
086cb327
NC
470 } else {
471 if (flags & HVhek_FREEKEY)
472 Safefree(key);
473 }
63c89345 474 return result;
7f66fda2 475 }
902173a3 476 }
7f66fda2
NC
477#endif
478 } /* ISFETCH */
479 else if (SvRMAGICAL(hv) && (action & HV_FETCH_ISEXISTS)) {
ad64d0ec
NC
480 if (mg_find((const SV *)hv, PERL_MAGIC_tied)
481 || SvGMAGICAL((const SV *)hv)) {
b2c64049
NC
482 /* I don't understand why hv_exists_ent has svret and sv,
483 whereas hv_exists only had one. */
9d4ba2ae 484 SV * const svret = sv_newmortal();
b2c64049 485 sv = sv_newmortal();
7f66fda2
NC
486
487 if (keysv || is_utf8) {
488 if (!keysv) {
740cce10 489 keysv = newSVpvn_utf8(key, klen, TRUE);
7f66fda2
NC
490 } else {
491 keysv = newSVsv(keysv);
492 }
ad64d0ec 493 mg_copy(MUTABLE_SV(hv), sv, (char *)sv_2mortal(keysv), HEf_SVKEY);
b2c64049 494 } else {
ad64d0ec 495 mg_copy(MUTABLE_SV(hv), sv, key, klen);
7f66fda2 496 }
b2c64049
NC
497 if (flags & HVhek_FREEKEY)
498 Safefree(key);
c818886e
JH
499 {
500 MAGIC * const mg = mg_find(sv, PERL_MAGIC_tiedelem);
501 if (mg)
502 magic_existspack(svret, mg);
503 }
7f66fda2
NC
504 /* This cast somewhat evil, but I'm merely using NULL/
505 not NULL to return the boolean exists.
506 And I know hv is not NULL. */
3c84c864 507 return SvTRUE(svret) ? (void *)hv : NULL;
e7152ba2 508 }
7f66fda2 509#ifdef ENV_IS_CASELESS
ad64d0ec 510 else if (mg_find((const SV *)hv, PERL_MAGIC_env)) {
7f66fda2 511 /* XXX This code isn't UTF8 clean. */
a15d23f8 512 char * const keysave = (char * const)key;
b2c64049
NC
513 /* Will need to free this, so set FREEKEY flag. */
514 key = savepvn(key,klen);
515 key = (const char*)strupr((char*)key);
6136c704 516 is_utf8 = FALSE;
7f66fda2 517 hash = 0;
8b4f7dd5 518 keysv = 0;
b2c64049
NC
519
520 if (flags & HVhek_FREEKEY) {
521 Safefree(keysave);
522 }
523 flags |= HVhek_FREEKEY;
7f66fda2 524 }
902173a3 525#endif
7f66fda2 526 } /* ISEXISTS */
b2c64049
NC
527 else if (action & HV_FETCH_ISSTORE) {
528 bool needs_copy;
529 bool needs_store;
530 hv_magic_check (hv, &needs_copy, &needs_store);
531 if (needs_copy) {
9a9b5ec9 532 const bool save_taint = TAINT_get;
b2c64049
NC
533 if (keysv || is_utf8) {
534 if (!keysv) {
740cce10 535 keysv = newSVpvn_utf8(key, klen, TRUE);
b2c64049 536 }
284167a5
SM
537 if (TAINTING_get)
538 TAINT_set(SvTAINTED(keysv));
b2c64049 539 keysv = sv_2mortal(newSVsv(keysv));
ad64d0ec 540 mg_copy(MUTABLE_SV(hv), val, (char*)keysv, HEf_SVKEY);
b2c64049 541 } else {
ad64d0ec 542 mg_copy(MUTABLE_SV(hv), val, key, klen);
b2c64049
NC
543 }
544
545 TAINT_IF(save_taint);
9a9b5ec9
DM
546#ifdef NO_TAINT_SUPPORT
547 PERL_UNUSED_VAR(save_taint);
548#endif
1baaf5d7 549 if (!needs_store) {
b2c64049
NC
550 if (flags & HVhek_FREEKEY)
551 Safefree(key);
4608196e 552 return NULL;
b2c64049
NC
553 }
554#ifdef ENV_IS_CASELESS
ad64d0ec 555 else if (mg_find((const SV *)hv, PERL_MAGIC_env)) {
b2c64049
NC
556 /* XXX This code isn't UTF8 clean. */
557 const char *keysave = key;
558 /* Will need to free this, so set FREEKEY flag. */
559 key = savepvn(key,klen);
560 key = (const char*)strupr((char*)key);
6136c704 561 is_utf8 = FALSE;
b2c64049 562 hash = 0;
8b4f7dd5 563 keysv = 0;
b2c64049
NC
564
565 if (flags & HVhek_FREEKEY) {
566 Safefree(keysave);
567 }
568 flags |= HVhek_FREEKEY;
569 }
570#endif
571 }
572 } /* ISSTORE */
7f66fda2 573 } /* SvMAGICAL */
fde52b5c 574
7b2c381c 575 if (!HvARRAY(hv)) {
b2c64049 576 if ((action & (HV_FETCH_LVALUE | HV_FETCH_ISSTORE))
fde52b5c 577#ifdef DYNAMIC_ENV_FETCH /* if it's an %ENV lookup, we may get it on the fly */
ad64d0ec
NC
578 || (SvRMAGICAL((const SV *)hv)
579 && mg_find((const SV *)hv, PERL_MAGIC_env))
fde52b5c 580#endif
d58e6666
NC
581 ) {
582 char *array;
a02a5408 583 Newxz(array,
cbec9347 584 PERL_HV_ARRAY_ALLOC_BYTES(xhv->xhv_max+1 /* HvMAX(hv)+1 */),
d58e6666
NC
585 char);
586 HvARRAY(hv) = (HE**)array;
587 }
7f66fda2
NC
588#ifdef DYNAMIC_ENV_FETCH
589 else if (action & HV_FETCH_ISEXISTS) {
590 /* for an %ENV exists, if we do an insert it's by a recursive
591 store call, so avoid creating HvARRAY(hv) right now. */
592 }
593#endif
113738bb
NC
594 else {
595 /* XXX remove at some point? */
596 if (flags & HVhek_FREEKEY)
597 Safefree(key);
598
3c84c864 599 return NULL;
113738bb 600 }
fde52b5c
PP
601 }
602
37ae23ff 603 if (is_utf8 && !(flags & HVhek_KEYCANONICAL)) {
41d88b63 604 char * const keysave = (char *)key;
f9a63242 605 key = (char*)bytes_from_utf8((U8*)key, &klen, &is_utf8);
19692e8d 606 if (is_utf8)
c1fe5510
NC
607 flags |= HVhek_UTF8;
608 else
609 flags &= ~HVhek_UTF8;
7f66fda2
NC
610 if (key != keysave) {
611 if (flags & HVhek_FREEKEY)
612 Safefree(keysave);
19692e8d 613 flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
527df579
NC
614 /* If the caller calculated a hash, it was on the sequence of
615 octets that are the UTF-8 form. We've now changed the sequence
616 of octets stored to that of the equivalent byte representation,
617 so the hash we need is different. */
618 hash = 0;
7f66fda2 619 }
19692e8d 620 }
f9a63242 621
34dadc62
DM
622 if (keysv && (SvIsCOW_shared_hash(keysv))) {
623 if (HvSHAREKEYS(hv))
624 keysv_hek = SvSHARED_HEK_FROM_PV(SvPVX_const(keysv));
625 hash = SvSHARED_HASH(keysv);
7dc86639 626 }
34dadc62
DM
627 else if (!hash)
628 PERL_HASH(hash, key, klen);
effa1e2d 629
113738bb
NC
630 masked_flags = (flags & HVhek_MASK);
631
7f66fda2 632#ifdef DYNAMIC_ENV_FETCH
4608196e 633 if (!HvARRAY(hv)) entry = NULL;
7f66fda2
NC
634 else
635#endif
b2c64049 636 {
7b2c381c 637 entry = (HvARRAY(hv))[hash & (I32) HvMAX(hv)];
b2c64049 638 }
34dadc62
DM
639
640 if (!entry)
641 goto not_found;
642
643 if (keysv_hek) {
644 /* keysv is actually a HEK in disguise, so we can match just by
645 * comparing the HEK pointers in the HE chain. There is a slight
646 * caveat: on something like "\x80", which has both plain and utf8
647 * representations, perl's hashes do encoding-insensitive lookups,
648 * but preserve the encoding of the stored key. Thus a particular
649 * key could map to two different HEKs in PL_strtab. We only
650 * conclude 'not found' if all the flags are the same; otherwise
651 * we fall back to a full search (this should only happen in rare
652 * cases).
653 */
654 int keysv_flags = HEK_FLAGS(keysv_hek);
655 HE *orig_entry = entry;
656
657 for (; entry; entry = HeNEXT(entry)) {
658 HEK *hek = HeKEY_hek(entry);
659 if (hek == keysv_hek)
660 goto found;
661 if (HEK_FLAGS(hek) != keysv_flags)
662 break; /* need to do full match */
663 }
664 if (!entry)
665 goto not_found;
666 /* failed on shortcut - do full search loop */
667 entry = orig_entry;
668 }
669
0298d7b9 670 for (; entry; entry = HeNEXT(entry)) {
fde52b5c
PP
671 if (HeHASH(entry) != hash) /* strings can't be equal */
672 continue;
eb160463 673 if (HeKLEN(entry) != (I32)klen)
fde52b5c 674 continue;
34dadc62 675 if (memNE(HeKEY(entry),key,klen)) /* is this it? */
fde52b5c 676 continue;
113738bb 677 if ((HeKFLAGS(entry) ^ masked_flags) & HVhek_UTF8)
c3654f1a 678 continue;
b2c64049 679
34dadc62 680 found:
b2c64049
NC
681 if (action & (HV_FETCH_LVALUE|HV_FETCH_ISSTORE)) {
682 if (HeKFLAGS(entry) != masked_flags) {
683 /* We match if HVhek_UTF8 bit in our flags and hash key's
684 match. But if entry was set previously with HVhek_WASUTF8
685 and key now doesn't (or vice versa) then we should change
686 the key's flag, as this is assignment. */
687 if (HvSHAREKEYS(hv)) {
688 /* Need to swap the key we have for a key with the flags we
689 need. As keys are shared we can't just write to the
690 flag, so we share the new one, unshare the old one. */
6136c704 691 HEK * const new_hek = share_hek_flags(key, klen, hash,
6e838c70 692 masked_flags);
b2c64049
NC
693 unshare_hek (HeKEY_hek(entry));
694 HeKEY_hek(entry) = new_hek;
695 }
5d2b1485
NC
696 else if (hv == PL_strtab) {
697 /* PL_strtab is usually the only hash without HvSHAREKEYS,
698 so putting this test here is cheap */
699 if (flags & HVhek_FREEKEY)
700 Safefree(key);
701 Perl_croak(aTHX_ S_strtab_error,
702 action & HV_FETCH_LVALUE ? "fetch" : "store");
703 }
b2c64049
NC
704 else
705 HeKFLAGS(entry) = masked_flags;
706 if (masked_flags & HVhek_ENABLEHVKFLAGS)
707 HvHASKFLAGS_on(hv);
708 }
709 if (HeVAL(entry) == &PL_sv_placeholder) {
710 /* yes, can store into placeholder slot */
711 if (action & HV_FETCH_LVALUE) {
712 if (SvMAGICAL(hv)) {
713 /* This preserves behaviour with the old hv_fetch
714 implementation which at this point would bail out
715 with a break; (at "if we find a placeholder, we
716 pretend we haven't found anything")
717
718 That break mean that if a placeholder were found, it
719 caused a call into hv_store, which in turn would
720 check magic, and if there is no magic end up pretty
721 much back at this point (in hv_store's code). */
722 break;
723 }
486ec47a 724 /* LVAL fetch which actually needs a store. */
561b68a9 725 val = newSV(0);
ca732855 726 HvPLACEHOLDERS(hv)--;
b2c64049
NC
727 } else {
728 /* store */
729 if (val != &PL_sv_placeholder)
ca732855 730 HvPLACEHOLDERS(hv)--;
b2c64049
NC
731 }
732 HeVAL(entry) = val;
733 } else if (action & HV_FETCH_ISSTORE) {
cefd5c7c 734 SvREFCNT_dec(HeVAL(entry));
b2c64049
NC
735 HeVAL(entry) = val;
736 }
27bcc0a7 737 } else if (HeVAL(entry) == &PL_sv_placeholder) {
b2c64049
NC
738 /* if we find a placeholder, we pretend we haven't found
739 anything */
8aacddc1 740 break;
b2c64049 741 }
113738bb
NC
742 if (flags & HVhek_FREEKEY)
743 Safefree(key);
3c84c864 744 if (return_svp) {
b66176f0 745 return (void *) &HeVAL(entry);
3c84c864 746 }
fde52b5c
PP
747 return entry;
748 }
34dadc62
DM
749
750 not_found:
fde52b5c 751#ifdef DYNAMIC_ENV_FETCH /* %ENV lookup? If so, try to fetch the value now */
0ed29950 752 if (!(action & HV_FETCH_ISSTORE)
ad64d0ec
NC
753 && SvRMAGICAL((const SV *)hv)
754 && mg_find((const SV *)hv, PERL_MAGIC_env)) {
a6c40364 755 unsigned long len;
9d4ba2ae 756 const char * const env = PerlEnv_ENVgetenv_len(key,&len);
a6c40364
GS
757 if (env) {
758 sv = newSVpvn(env,len);
759 SvTAINTED_on(sv);
d3ba3f5c 760 return hv_common(hv, keysv, key, klen, flags,
3c84c864
NC
761 HV_FETCH_ISSTORE|HV_DISABLE_UVAR_XKEY|return_svp,
762 sv, hash);
a6c40364 763 }
fde52b5c
PP
764 }
765#endif
7f66fda2
NC
766
767 if (!entry && SvREADONLY(hv) && !(action & HV_FETCH_ISEXISTS)) {
c445ea15 768 hv_notallowed(flags, key, klen,
c8cd6465
NC
769 "Attempt to access disallowed key '%"SVf"' in"
770 " a restricted hash");
1b1f1335 771 }
b2c64049
NC
772 if (!(action & (HV_FETCH_LVALUE|HV_FETCH_ISSTORE))) {
773 /* Not doing some form of store, so return failure. */
774 if (flags & HVhek_FREEKEY)
775 Safefree(key);
3c84c864 776 return NULL;
b2c64049 777 }
113738bb 778 if (action & HV_FETCH_LVALUE) {
df5f182b 779 val = action & HV_FETCH_EMPTY_HE ? NULL : newSV(0);
b2c64049
NC
780 if (SvMAGICAL(hv)) {
781 /* At this point the old hv_fetch code would call to hv_store,
782 which in turn might do some tied magic. So we need to make that
783 magic check happen. */
784 /* gonna assign to this, so it better be there */
fda2d18a
NC
785 /* If a fetch-as-store fails on the fetch, then the action is to
786 recurse once into "hv_store". If we didn't do this, then that
787 recursive call would call the key conversion routine again.
788 However, as we replace the original key with the converted
789 key, this would result in a double conversion, which would show
e987ad1c
FC
790 up as a bug if the conversion routine is not idempotent.
791 Hence the use of HV_DISABLE_UVAR_XKEY. */
d3ba3f5c 792 return hv_common(hv, keysv, key, klen, flags,
3c84c864
NC
793 HV_FETCH_ISSTORE|HV_DISABLE_UVAR_XKEY|return_svp,
794 val, hash);
b2c64049
NC
795 /* XXX Surely that could leak if the fetch-was-store fails?
796 Just like the hv_fetch. */
113738bb
NC
797 }
798 }
799
b2c64049
NC
800 /* Welcome to hv_store... */
801
7b2c381c 802 if (!HvARRAY(hv)) {
b2c64049
NC
803 /* Not sure if we can get here. I think the only case of oentry being
804 NULL is for %ENV with dynamic env fetch. But that should disappear
805 with magic in the previous code. */
d58e6666 806 char *array;
a02a5408 807 Newxz(array,
b2c64049 808 PERL_HV_ARRAY_ALLOC_BYTES(xhv->xhv_max+1 /* HvMAX(hv)+1 */),
d58e6666
NC
809 char);
810 HvARRAY(hv) = (HE**)array;
b2c64049
NC
811 }
812
7b2c381c 813 oentry = &(HvARRAY(hv))[hash & (I32) xhv->xhv_max];
ab4af705 814
b2c64049
NC
815 entry = new_HE();
816 /* share_hek_flags will do the free for us. This might be considered
817 bad API design. */
818 if (HvSHAREKEYS(hv))
6e838c70 819 HeKEY_hek(entry) = share_hek_flags(key, klen, hash, flags);
5d2b1485
NC
820 else if (hv == PL_strtab) {
821 /* PL_strtab is usually the only hash without HvSHAREKEYS, so putting
822 this test here is cheap */
823 if (flags & HVhek_FREEKEY)
824 Safefree(key);
825 Perl_croak(aTHX_ S_strtab_error,
826 action & HV_FETCH_LVALUE ? "fetch" : "store");
827 }
b2c64049
NC
828 else /* gotta do the real thing */
829 HeKEY_hek(entry) = save_hek_flags(key, klen, hash, flags);
830 HeVAL(entry) = val;
3078e109 831
9faf471a
NC
832 if (!*oentry && SvOOK(hv)) {
833 /* initial entry, and aux struct present. */
834 struct xpvhv_aux *const aux = HvAUX(hv);
835 if (aux->xhv_fill_lazy)
836 ++aux->xhv_fill_lazy;
837 }
838
6a5b4183 839#ifdef PERL_HASH_RANDOMIZE_KEYS
3078e109
YO
840 /* This logic semi-randomizes the insert order in a bucket.
841 * Either we insert into the top, or the slot below the top,
d5fc06cb
YO
842 * making it harder to see if there is a collision. We also
843 * reset the iterator randomizer if there is one.
3078e109 844 */
6a5b4183
YO
845 if ( *oentry && PL_HASH_RAND_BITS_ENABLED) {
846 PL_hash_rand_bits++;
847 PL_hash_rand_bits= ROTL_UV(PL_hash_rand_bits,1);
848 if ( PL_hash_rand_bits & 1 ) {
849 HeNEXT(entry) = HeNEXT(*oentry);
850 HeNEXT(*oentry) = entry;
851 } else {
852 HeNEXT(entry) = *oentry;
853 *oentry = entry;
854 }
855 } else
856#endif
857 {
3078e109
YO
858 HeNEXT(entry) = *oentry;
859 *oentry = entry;
3078e109 860 }
6a5b4183 861#ifdef PERL_HASH_RANDOMIZE_KEYS
3a714294 862 if (SvOOK(hv)) {
ff20b672
YO
863 /* Currently this makes various tests warn in annoying ways.
864 * So Silenced for now. - Yves | bogus end of comment =>* /
865 if (HvAUX(hv)->xhv_riter != -1) {
866 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
867 "[TESTING] Inserting into a hash during each() traversal results in undefined behavior"
868 pTHX__FORMAT
869 pTHX__VALUE);
870 }
871 */
6a5b4183
YO
872 if (PL_HASH_RAND_BITS_ENABLED) {
873 if (PL_HASH_RAND_BITS_ENABLED == 1)
874 PL_hash_rand_bits += (PTRV)entry + 1; /* we don't bother to use ptr_hash here */
875 PL_hash_rand_bits= ROTL_UV(PL_hash_rand_bits,1);
876 }
3a714294
YO
877 HvAUX(hv)->xhv_rand= (U32)PL_hash_rand_bits;
878 }
6a5b4183 879#endif
b2c64049
NC
880
881 if (val == &PL_sv_placeholder)
ca732855 882 HvPLACEHOLDERS(hv)++;
b2c64049
NC
883 if (masked_flags & HVhek_ENABLEHVKFLAGS)
884 HvHASKFLAGS_on(hv);
885
8e317198
YO
886 xhv->xhv_keys++; /* HvTOTALKEYS(hv)++ */
887 if ( DO_HSPLIT(xhv) ) {
adf6906b 888 const STRLEN oldsize = xhv->xhv_max + 1;
81a3ba35 889 const U32 items = (U32)HvPLACEHOLDERS_get(hv);
adf6906b 890
81a3ba35 891 if (items /* hash has placeholders */
1eaee784
NC
892 && !SvREADONLY(hv) /* but is not a restricted hash */) {
893 /* If this hash previously was a "restricted hash" and had
894 placeholders, but the "restricted" flag has been turned off,
895 then the placeholders no longer serve any useful purpose.
896 However, they have the downsides of taking up RAM, and adding
897 extra steps when finding used values. It's safe to clear them
898 at this point, even though Storable rebuilds restricted hashes by
0ca1b5c3 899 putting in all the placeholders (first) before turning on the
1eaee784
NC
900 readonly flag, because Storable always pre-splits the hash.
901 If we're lucky, then we may clear sufficient placeholders to
902 avoid needing to split the hash at all. */
81a3ba35 903 clear_placeholders(hv, items);
1eaee784
NC
904 if (DO_HSPLIT(xhv))
905 hsplit(hv, oldsize, oldsize * 2);
906 } else
907 hsplit(hv, oldsize, oldsize * 2);
fde52b5c 908 }
b2c64049 909
3c84c864
NC
910 if (return_svp) {
911 return entry ? (void *) &HeVAL(entry) : NULL;
912 }
913 return (void *) entry;
fde52b5c
PP
914}
915
864dbfa3 916STATIC void
b0e6ae5b 917S_hv_magic_check(HV *hv, bool *needs_copy, bool *needs_store)
d0066dc7 918{
a3b680e6 919 const MAGIC *mg = SvMAGIC(hv);
7918f24d
NC
920
921 PERL_ARGS_ASSERT_HV_MAGIC_CHECK;
922
d0066dc7
OT
923 *needs_copy = FALSE;
924 *needs_store = TRUE;
925 while (mg) {
926 if (isUPPER(mg->mg_type)) {
927 *needs_copy = TRUE;
d60c5a05 928 if (mg->mg_type == PERL_MAGIC_tied) {
d0066dc7 929 *needs_store = FALSE;
4ab2a30b 930 return; /* We've set all there is to set. */
d0066dc7
OT
931 }
932 }
933 mg = mg->mg_moremagic;
934 }
935}
936
954c1994 937/*
a3bcc51e
TP
938=for apidoc hv_scalar
939
72d33970
FC
940Evaluates the hash in scalar context and returns the result. Handles magic
941when the hash is tied.
a3bcc51e
TP
942
943=cut
944*/
945
946SV *
947Perl_hv_scalar(pTHX_ HV *hv)
948{
a3bcc51e 949 SV *sv;
823a54a3 950
7918f24d
NC
951 PERL_ARGS_ASSERT_HV_SCALAR;
952
823a54a3 953 if (SvRMAGICAL(hv)) {
ad64d0ec 954 MAGIC * const mg = mg_find((const SV *)hv, PERL_MAGIC_tied);
823a54a3
AL
955 if (mg)
956 return magic_scalarpack(hv, mg);
957 }
a3bcc51e
TP
958
959 sv = sv_newmortal();
f4431c56 960 if (HvTOTALKEYS((const HV *)hv))
a3bcc51e
TP
961 Perl_sv_setpvf(aTHX_ sv, "%ld/%ld",
962 (long)HvFILL(hv), (long)HvMAX(hv) + 1);
963 else
964 sv_setiv(sv, 0);
965
966 return sv;
967}
968
969/*
954c1994
GS
970=for apidoc hv_delete
971
a05d6c5d
TC
972Deletes a key/value pair in the hash. The value's SV is removed from
973the hash, made mortal, and returned to the caller. The absolute
974value of C<klen> is the length of the key. If C<klen> is negative the
975key is assumed to be in UTF-8-encoded Unicode. The C<flags> value
796b6530
KW
976will normally be zero; if set to C<G_DISCARD> then C<NULL> will be returned.
977C<NULL> will also be returned if the key is not found.
954c1994 978
954c1994
GS
979=for apidoc hv_delete_ent
980
3025a2e4
CS
981Deletes a key/value pair in the hash. The value SV is removed from the hash,
982made mortal, and returned to the caller. The C<flags> value will normally be
796b6530
KW
983zero; if set to C<G_DISCARD> then C<NULL> will be returned. C<NULL> will also
984be returned if the key is not found. C<hash> can be a valid precomputed hash
3025a2e4 985value, or 0 to ask for it to be computed.
954c1994
GS
986
987=cut
988*/
989
8f8d40ab 990STATIC SV *
cd6d36ac
NC
991S_hv_delete_common(pTHX_ HV *hv, SV *keysv, const char *key, STRLEN klen,
992 int k_flags, I32 d_flags, U32 hash)
f1317c8d 993{
27da23d5 994 dVAR;
eb578fdb
KW
995 XPVHV* xhv;
996 HE *entry;
997 HE **oentry;
34dadc62 998 HE **first_entry;
9dbc5603 999 bool is_utf8 = (k_flags & HVhek_UTF8) ? TRUE : FALSE;
7a9669ca 1000 int masked_flags;
34dadc62
DM
1001 HEK *keysv_hek = NULL;
1002 U8 mro_changes = 0; /* 1 = isa; 2 = package moved */
1003 SV *sv;
1004 GV *gv = NULL;
1005 HV *stash = NULL;
1c846c1f 1006
fde52b5c 1007 if (SvRMAGICAL(hv)) {
0a0bb7c7
OT
1008 bool needs_copy;
1009 bool needs_store;
1010 hv_magic_check (hv, &needs_copy, &needs_store);
1011
f1317c8d 1012 if (needs_copy) {
6136c704 1013 SV *sv;
63c89345
NC
1014 entry = (HE *) hv_common(hv, keysv, key, klen,
1015 k_flags & ~HVhek_FREEKEY,
1016 HV_FETCH_LVALUE|HV_DISABLE_UVAR_XKEY,
1017 NULL, hash);
7a9669ca 1018 sv = entry ? HeVAL(entry) : NULL;
f1317c8d
NC
1019 if (sv) {
1020 if (SvMAGICAL(sv)) {
1021 mg_clear(sv);
1022 }
1023 if (!needs_store) {
1024 if (mg_find(sv, PERL_MAGIC_tiedelem)) {
1025 /* No longer an element */
1026 sv_unmagic(sv, PERL_MAGIC_tiedelem);
1027 return sv;
1028 }
a0714e2c 1029 return NULL; /* element cannot be deleted */
f1317c8d 1030 }
902173a3 1031#ifdef ENV_IS_CASELESS
ad64d0ec 1032 else if (mg_find((const SV *)hv, PERL_MAGIC_env)) {
8167a60a 1033 /* XXX This code isn't UTF8 clean. */
59cd0e26 1034 keysv = newSVpvn_flags(key, klen, SVs_TEMP);
8167a60a
NC
1035 if (k_flags & HVhek_FREEKEY) {
1036 Safefree(key);
1037 }
1038 key = strupr(SvPVX(keysv));
1039 is_utf8 = 0;
1040 k_flags = 0;
1041 hash = 0;
7f66fda2 1042 }
510ac311 1043#endif
2fd1c6b8 1044 }
2fd1c6b8 1045 }
fde52b5c 1046 }
cbec9347 1047 xhv = (XPVHV*)SvANY(hv);
7b2c381c 1048 if (!HvARRAY(hv))
a0714e2c 1049 return NULL;
fde52b5c 1050
6b230254 1051 if (is_utf8 && !(k_flags & HVhek_KEYCANONICAL)) {
c445ea15 1052 const char * const keysave = key;
b464bac0 1053 key = (char*)bytes_from_utf8((U8*)key, &klen, &is_utf8);
cd6d36ac 1054
19692e8d 1055 if (is_utf8)
cd6d36ac
NC
1056 k_flags |= HVhek_UTF8;
1057 else
1058 k_flags &= ~HVhek_UTF8;
7f66fda2
NC
1059 if (key != keysave) {
1060 if (k_flags & HVhek_FREEKEY) {
1061 /* This shouldn't happen if our caller does what we expect,
1062 but strictly the API allows it. */
1063 Safefree(keysave);
1064 }
1065 k_flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
1066 }
ad64d0ec 1067 HvHASKFLAGS_on(MUTABLE_SV(hv));
19692e8d 1068 }
f9a63242 1069
34dadc62
DM
1070 if (keysv && (SvIsCOW_shared_hash(keysv))) {
1071 if (HvSHAREKEYS(hv))
1072 keysv_hek = SvSHARED_HEK_FROM_PV(SvPVX_const(keysv));
1073 hash = SvSHARED_HASH(keysv);
7dc86639 1074 }
34dadc62
DM
1075 else if (!hash)
1076 PERL_HASH(hash, key, klen);
fde52b5c 1077
7a9669ca
NC
1078 masked_flags = (k_flags & HVhek_MASK);
1079
9faf471a 1080 first_entry = oentry = &(HvARRAY(hv))[hash & (I32) HvMAX(hv)];
fde52b5c 1081 entry = *oentry;
0c3bb3c2 1082
34dadc62
DM
1083 if (!entry)
1084 goto not_found;
1085
1086 if (keysv_hek) {
1087 /* keysv is actually a HEK in disguise, so we can match just by
1088 * comparing the HEK pointers in the HE chain. There is a slight
1089 * caveat: on something like "\x80", which has both plain and utf8
1090 * representations, perl's hashes do encoding-insensitive lookups,
1091 * but preserve the encoding of the stored key. Thus a particular
1092 * key could map to two different HEKs in PL_strtab. We only
1093 * conclude 'not found' if all the flags are the same; otherwise
1094 * we fall back to a full search (this should only happen in rare
1095 * cases).
1096 */
1097 int keysv_flags = HEK_FLAGS(keysv_hek);
1098
1099 for (; entry; oentry = &HeNEXT(entry), entry = *oentry) {
1100 HEK *hek = HeKEY_hek(entry);
1101 if (hek == keysv_hek)
1102 goto found;
1103 if (HEK_FLAGS(hek) != keysv_flags)
1104 break; /* need to do full match */
1105 }
1106 if (!entry)
1107 goto not_found;
1108 /* failed on shortcut - do full search loop */
1109 oentry = first_entry;
1110 entry = *oentry;
1111 }
1112
1113 for (; entry; oentry = &HeNEXT(entry), entry = *oentry) {
fde52b5c
PP
1114 if (HeHASH(entry) != hash) /* strings can't be equal */
1115 continue;
eb160463 1116 if (HeKLEN(entry) != (I32)klen)
fde52b5c 1117 continue;
34dadc62 1118 if (memNE(HeKEY(entry),key,klen)) /* is this it? */
fde52b5c 1119 continue;
7a9669ca 1120 if ((HeKFLAGS(entry) ^ masked_flags) & HVhek_UTF8)
c3654f1a 1121 continue;
8aacddc1 1122
34dadc62 1123 found:
5d2b1485
NC
1124 if (hv == PL_strtab) {
1125 if (k_flags & HVhek_FREEKEY)
1126 Safefree(key);
1127 Perl_croak(aTHX_ S_strtab_error, "delete");
1128 }
1129
8aacddc1 1130 /* if placeholder is here, it's already been deleted.... */
6136c704
AL
1131 if (HeVAL(entry) == &PL_sv_placeholder) {
1132 if (k_flags & HVhek_FREEKEY)
1133 Safefree(key);
1134 return NULL;
8aacddc1 1135 }
0ffdaf1a 1136 if (SvREADONLY(hv) && HeVAL(entry) && SvREADONLY(HeVAL(entry))) {
d4c19fe8 1137 hv_notallowed(k_flags, key, klen,
c8cd6465
NC
1138 "Attempt to delete readonly key '%"SVf"' from"
1139 " a restricted hash");
8aacddc1 1140 }
b84d0860
NC
1141 if (k_flags & HVhek_FREEKEY)
1142 Safefree(key);
8aacddc1 1143
35759254 1144 /* If this is a stash and the key ends with ::, then someone is
0c3bb3c2 1145 * deleting a package.
0c3bb3c2 1146 */
78b79c77 1147 if (HeVAL(entry) && HvENAME_get(hv)) {
0290c710 1148 gv = (GV *)HeVAL(entry);
35759254 1149 if (keysv) key = SvPV(keysv, klen);
1f656fcf
FC
1150 if ((
1151 (klen > 1 && key[klen-2] == ':' && key[klen-1] == ':')
1152 ||
1153 (klen == 1 && key[0] == ':')
1154 )
e0a52395 1155 && (klen != 6 || hv!=PL_defstash || memNE(key,"main::",6))
0290c710 1156 && SvTYPE(gv) == SVt_PVGV && (stash = GvHV((GV *)gv))
0c3bb3c2 1157 && HvENAME_get(stash)) {
0290c710
FC
1158 /* A previous version of this code checked that the
1159 * GV was still in the symbol table by fetching the
1160 * GV with its name. That is not necessary (and
1161 * sometimes incorrect), as HvENAME cannot be set
1162 * on hv if it is not in the symtab. */
f3d2f32d 1163 mro_changes = 2;
0c3bb3c2
FC
1164 /* Hang on to it for a bit. */
1165 SvREFCNT_inc_simple_void_NN(
0290c710 1166 sv_2mortal((SV *)gv)
35759254
FC
1167 );
1168 }
6146d9e1
TC
1169 else if (klen == 3 && strnEQ(key, "ISA", 3) && GvAV(gv)) {
1170 AV *isa = GvAV(gv);
1171 MAGIC *mg = mg_find((SV*)isa, PERL_MAGIC_isa);
1172
f3d2f32d 1173 mro_changes = 1;
6146d9e1
TC
1174 if (mg) {
1175 if (mg->mg_obj == (SV*)gv) {
1176 /* This is the only stash this ISA was used for.
1177 * The isaelem magic asserts if there's no
1178 * isa magic on the array, so explicitly
1179 * remove the magic on both the array and its
1180 * elements. @ISA shouldn't be /too/ large.
1181 */
1182 SV **svp, **end;
1183 strip_magic:
1184 svp = AvARRAY(isa);
1185 end = svp + AvFILLp(isa)+1;
1186 while (svp < end) {
1187 if (*svp)
1188 mg_free_type(*svp, PERL_MAGIC_isaelem);
1189 ++svp;
1190 }
1191 mg_free_type((SV*)GvAV(gv), PERL_MAGIC_isa);
1192 }
1193 else {
1194 /* mg_obj is an array of stashes
1195 Note that the array doesn't keep a reference
1196 count on the stashes.
1197 */
1198 AV *av = (AV*)mg->mg_obj;
1199 SV **svp, **arrayp;
1200 SSize_t index;
1201 SSize_t items;
1202
1203 assert(SvTYPE(mg->mg_obj) == SVt_PVAV);
1204
1205 /* remove the stash from the magic array */
1206 arrayp = svp = AvARRAY(av);
1207 items = AvFILLp(av) + 1;
1208 if (items == 1) {
1209 assert(*arrayp == (SV *)gv);
1210 mg->mg_obj = NULL;
1211 /* avoid a double free on the last stash */
1212 AvFILLp(av) = -1;
1213 /* The magic isn't MGf_REFCOUNTED, so release
1214 * the array manually.
1215 */
1216 SvREFCNT_dec_NN(av);
1217 goto strip_magic;
1218 }
1219 else {
1220 while (items--) {
1221 if (*svp == (SV*)gv)
1222 break;
1223 ++svp;
1224 }
1225 index = svp - arrayp;
1226 assert(index >= 0 && index <= AvFILLp(av));
1227 if (index < AvFILLp(av)) {
1228 arrayp[index] = arrayp[AvFILLp(av)];
1229 }
1230 arrayp[AvFILLp(av)] = NULL;
1231 --AvFILLp(av);
1232 }
1233 }
1234 }
1235 }
35759254
FC
1236 }
1237
8571a3cc
FC
1238 sv = d_flags & G_DISCARD ? HeVAL(entry) : sv_2mortal(HeVAL(entry));
1239 HeVAL(entry) = &PL_sv_placeholder;
5743f2a3
FC
1240 if (sv) {
1241 /* deletion of method from stash */
1242 if (isGV(sv) && isGV_with_GP(sv) && GvCVu(sv)
1243 && HvENAME_get(hv))
1244 mro_method_changed_in(hv);
5743f2a3 1245 }
8aacddc1
NIS
1246
1247 /*
1248 * If a restricted hash, rather than really deleting the entry, put
1249 * a placeholder there. This marks the key as being "approved", so
1250 * we can still access via not-really-existing key without raising
1251 * an error.
1252 */
f50383f5 1253 if (SvREADONLY(hv))
8aacddc1
NIS
1254 /* We'll be saving this slot, so the number of allocated keys
1255 * doesn't go down, but the number placeholders goes up */
ca732855 1256 HvPLACEHOLDERS(hv)++;
f50383f5 1257 else {
a26e96df 1258 *oentry = HeNEXT(entry);
9faf471a
NC
1259 if(!*first_entry && SvOOK(hv)) {
1260 /* removed last entry, and aux struct present. */
1261 struct xpvhv_aux *const aux = HvAUX(hv);
1262 if (aux->xhv_fill_lazy)
1263 --aux->xhv_fill_lazy;
1264 }
b79f7545 1265 if (SvOOK(hv) && entry == HvAUX(hv)->xhv_eiter /* HvEITER(hv) */)
8aacddc1 1266 HvLAZYDEL_on(hv);
ae199939
TH
1267 else {
1268 if (SvOOK(hv) && HvLAZYDEL(hv) &&
1269 entry == HeNEXT(HvAUX(hv)->xhv_eiter))
1270 HeNEXT(HvAUX(hv)->xhv_eiter) = HeNEXT(entry);
8aacddc1 1271 hv_free_ent(hv, entry);
ae199939 1272 }
4c7185a0 1273 xhv->xhv_keys--; /* HvTOTALKEYS(hv)-- */
574c8022 1274 if (xhv->xhv_keys == 0)
19692e8d 1275 HvHASKFLAGS_off(hv);
8aacddc1 1276 }
0c3bb3c2 1277
3b2cd809
FC
1278 if (d_flags & G_DISCARD) {
1279 SvREFCNT_dec(sv);
1280 sv = NULL;
1281 }
1282
f3d2f32d
FC
1283 if (mro_changes == 1) mro_isa_changed_in(hv);
1284 else if (mro_changes == 2)
afdbe55d 1285 mro_package_moved(NULL, stash, gv, 1);
0c3bb3c2 1286
79072805
LW
1287 return sv;
1288 }
34dadc62
DM
1289
1290 not_found:
8aacddc1 1291 if (SvREADONLY(hv)) {
d4c19fe8 1292 hv_notallowed(k_flags, key, klen,
c8cd6465
NC
1293 "Attempt to delete disallowed key '%"SVf"' from"
1294 " a restricted hash");
8aacddc1
NIS
1295 }
1296
19692e8d 1297 if (k_flags & HVhek_FREEKEY)
f9a63242 1298 Safefree(key);
a0714e2c 1299 return NULL;
79072805
LW
1300}
1301
32dfa2a7 1302
76e3520e 1303STATIC void
adf6906b 1304S_hsplit(pTHX_ HV *hv, STRLEN const oldsize, STRLEN newsize)
79072805 1305{
7663aa67 1306 STRLEN i = 0;
7b2c381c 1307 char *a = (char*) HvARRAY(hv);
eb578fdb 1308 HE **aep;
79072805 1309
32dfa2a7
YO
1310 bool do_aux= (
1311 /* already have an HvAUX(hv) so we have to move it */
1312 SvOOK(hv) ||
1313 /* no HvAUX() but array we are going to allocate is large enough
1314 * there is no point in saving the space for the iterator, and
1315 * speeds up later traversals. */
1316 ( ( hv != PL_strtab ) && ( newsize >= PERL_HV_ALLOC_AUX_SIZE ) )
1317 );
7918f24d 1318
32dfa2a7 1319 PERL_ARGS_ASSERT_HSPLIT;
18026298 1320
3280af22 1321 PL_nomemok = TRUE;
b79f7545 1322 Renew(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
32dfa2a7
YO
1323 + (do_aux ? sizeof(struct xpvhv_aux) : 0), char);
1324 PL_nomemok = FALSE;
422a93e5 1325 if (!a) {
422a93e5
GA
1326 return;
1327 }
32dfa2a7 1328
6a5b4183 1329#ifdef PERL_HASH_RANDOMIZE_KEYS
3078e109
YO
1330 /* the idea of this is that we create a "random" value by hashing the address of
1331 * the array, we then use the low bit to decide if we insert at the top, or insert
1332 * second from top. After each such insert we rotate the hashed value. So we can
1333 * use the same hashed value over and over, and in normal build environments use
1334 * very few ops to do so. ROTL32() should produce a single machine operation. */
6a5b4183
YO
1335 if (PL_HASH_RAND_BITS_ENABLED) {
1336 if (PL_HASH_RAND_BITS_ENABLED == 1)
1337 PL_hash_rand_bits += ptr_hash((PTRV)a);
1338 PL_hash_rand_bits = ROTL_UV(PL_hash_rand_bits,1);
1339 }
1340#endif
32dfa2a7
YO
1341 HvARRAY(hv) = (HE**) a;
1342 HvMAX(hv) = newsize - 1;
1343 /* before we zero the newly added memory, we
1344 * need to deal with the aux struct that may be there
1345 * or have been allocated by us*/
1346 if (do_aux) {
3078e109
YO
1347 struct xpvhv_aux *const dest
1348 = (struct xpvhv_aux*) &a[newsize * sizeof(HE*)];
32dfa2a7
YO
1349 if (SvOOK(hv)) {
1350 /* alread have an aux, copy the old one in place. */
1351 Move(&a[oldsize * sizeof(HE*)], dest, 1, struct xpvhv_aux);
1352 /* we reset the iterator's xhv_rand as well, so they get a totally new ordering */
6a5b4183 1353#ifdef PERL_HASH_RANDOMIZE_KEYS
32dfa2a7 1354 dest->xhv_rand = (U32)PL_hash_rand_bits;
6a5b4183 1355#endif
32dfa2a7
YO
1356 /* For now, just reset the lazy fill counter.
1357 It would be possible to update the counter in the code below
1358 instead. */
1359 dest->xhv_fill_lazy = 0;
1360 } else {
1361 /* no existing aux structure, but we allocated space for one
f6bab5f6 1362 * so initialize it properly. This unrolls hv_auxinit() a bit,
32dfa2a7
YO
1363 * since we have to do the realloc anyway. */
1364 /* first we set the iterator's xhv_rand so it can be copied into lastrand below */
1365#ifdef PERL_HASH_RANDOMIZE_KEYS
1366 dest->xhv_rand = (U32)PL_hash_rand_bits;
1367#endif
1368 /* this is the "non realloc" part of the hv_auxinit() */
1369 (void)hv_auxinit_internal(dest);
1370 /* Turn on the OOK flag */
1371 SvOOK_on(hv);
1372 }
b79f7545 1373 }
32dfa2a7 1374 /* now we can safely clear the second half */
72311751 1375 Zero(&a[oldsize * sizeof(HE*)], (newsize-oldsize) * sizeof(HE*), char); /* zero 2nd half*/
79072805 1376
68303b5c
NC
1377 if (!HvTOTALKEYS(hv)) /* skip rest if no entries */
1378 return;
1379
32dfa2a7 1380 newsize--;
68303b5c 1381 aep = (HE**)a;
7663aa67 1382 do {
c23dc12b
NC
1383 HE **oentry = aep + i;
1384 HE *entry = aep[i];
4b5190b5 1385
a50a3493 1386 if (!entry) /* non-existent */
79072805 1387 continue;
4c9d89c5 1388 do {
c23dc12b
NC
1389 U32 j = (HeHASH(entry) & newsize);
1390 if (j != (U32)i) {
fde52b5c 1391 *oentry = HeNEXT(entry);
6a5b4183
YO
1392#ifdef PERL_HASH_RANDOMIZE_KEYS
1393 /* if the target cell is empty or PL_HASH_RAND_BITS_ENABLED is false
1394 * insert to top, otherwise rotate the bucket rand 1 bit,
1395 * and use the new low bit to decide if we insert at top,
1396 * or next from top. IOW, we only rotate on a collision.*/
1397 if (aep[j] && PL_HASH_RAND_BITS_ENABLED) {
3f49e765 1398 PL_hash_rand_bits+= ROTL32(HeHASH(entry), 17);
6a5b4183
YO
1399 PL_hash_rand_bits= ROTL_UV(PL_hash_rand_bits,1);
1400 if (PL_hash_rand_bits & 1) {
1401 HeNEXT(entry)= HeNEXT(aep[j]);
1402 HeNEXT(aep[j])= entry;
1403 } else {
1404 /* Note, this is structured in such a way as the optimizer
1405 * should eliminate the duplicated code here and below without
1406 * us needing to explicitly use a goto. */
1407 HeNEXT(entry) = aep[j];
1408 aep[j] = entry;
1409 }
1410 } else
1411#endif
1412 {
1413 /* see comment above about duplicated code */
3078e109
YO
1414 HeNEXT(entry) = aep[j];
1415 aep[j] = entry;
3078e109 1416 }
79072805 1417 }
4b5190b5 1418 else {
fde52b5c 1419 oentry = &HeNEXT(entry);
4b5190b5 1420 }
4c9d89c5
NC
1421 entry = *oentry;
1422 } while (entry);
7663aa67 1423 } while (i++ < oldsize);
79072805
LW
1424}
1425
72940dca 1426void
864dbfa3 1427Perl_hv_ksplit(pTHX_ HV *hv, IV newmax)
72940dca 1428{
eb578fdb 1429 XPVHV* xhv = (XPVHV*)SvANY(hv);
a3b680e6 1430 const I32 oldsize = (I32) xhv->xhv_max+1; /* HvMAX(hv)+1 (sick) */
eb578fdb 1431 I32 newsize;
eb578fdb 1432 char *a;
72940dca 1433
7918f24d
NC
1434 PERL_ARGS_ASSERT_HV_KSPLIT;
1435
72940dca
PP
1436 newsize = (I32) newmax; /* possible truncation here */
1437 if (newsize != newmax || newmax <= oldsize)
1438 return;
1439 while ((newsize & (1 + ~newsize)) != newsize) {
1440 newsize &= ~(newsize & (1 + ~newsize)); /* get proper power of 2 */
1441 }
1442 if (newsize < newmax)
1443 newsize *= 2;
1444 if (newsize < newmax)
1445 return; /* overflow detection */
1446
7b2c381c 1447 a = (char *) HvARRAY(hv);
e8c10cf3
NC
1448 if (a) {
1449 hsplit(hv, oldsize, newsize);
1450 } else {
0df05616
NC
1451 Newxz(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize), char);
1452 xhv->xhv_max = --newsize;
1453 HvARRAY(hv) = (HE **) a;
72940dca
PP
1454 }
1455}
1456
f6bb1c88
YO
1457/* IMO this should also handle cases where hv_max is smaller than hv_keys
1458 * as tied hashes could play silly buggers and mess us around. We will
1459 * do the right thing during hv_store() afterwards, but still - Yves */
1460#define HV_SET_MAX_ADJUSTED_FOR_KEYS(hv,hv_max,hv_keys) STMT_START {\
1461 /* Can we use fewer buckets? (hv_max is always 2^n-1) */ \
1462 if (hv_max < PERL_HASH_DEFAULT_HvMAX) { \
1463 hv_max = PERL_HASH_DEFAULT_HvMAX; \
1464 } else { \
1465 while (hv_max > PERL_HASH_DEFAULT_HvMAX && hv_max + 1 >= hv_keys * 2) \
1466 hv_max = hv_max / 2; \
1467 } \
1468 HvMAX(hv) = hv_max; \
1469} STMT_END
1470
1471
b3ac6de7 1472HV *
864dbfa3 1473Perl_newHVhv(pTHX_ HV *ohv)
b3ac6de7 1474{
749123ff 1475 dVAR;
9d4ba2ae 1476 HV * const hv = newHV();
f4431c56 1477 STRLEN hv_max;
4beac62f 1478
3f4d1d78 1479 if (!ohv || (!HvTOTALKEYS(ohv) && !SvMAGICAL((const SV *)ohv)))
4beac62f 1480 return hv;
4beac62f 1481 hv_max = HvMAX(ohv);
b3ac6de7 1482
ad64d0ec 1483 if (!SvMAGICAL((const SV *)ohv)) {
b56ba0bf 1484 /* It's an ordinary hash, so copy it fast. AMS 20010804 */
eb160463 1485 STRLEN i;
a3b680e6 1486 const bool shared = !!HvSHAREKEYS(ohv);
aec46f14 1487 HE **ents, ** const oents = (HE **)HvARRAY(ohv);
ff875642 1488 char *a;
a02a5408 1489 Newx(a, PERL_HV_ARRAY_ALLOC_BYTES(hv_max+1), char);
ff875642 1490 ents = (HE**)a;
b56ba0bf
AMS
1491
1492 /* In each bucket... */
1493 for (i = 0; i <= hv_max; i++) {
6136c704 1494 HE *prev = NULL;
aec46f14 1495 HE *oent = oents[i];
b56ba0bf
AMS
1496
1497 if (!oent) {
1498 ents[i] = NULL;
1499 continue;
1500 }
1501
1502 /* Copy the linked list of entries. */
aec46f14 1503 for (; oent; oent = HeNEXT(oent)) {
a3b680e6
AL
1504 const U32 hash = HeHASH(oent);
1505 const char * const key = HeKEY(oent);
1506 const STRLEN len = HeKLEN(oent);
1507 const int flags = HeKFLAGS(oent);
6136c704 1508 HE * const ent = new_HE();
c3acb9e0 1509 SV *const val = HeVAL(oent);
b56ba0bf 1510
c3acb9e0 1511 HeVAL(ent) = SvIMMORTAL(val) ? val : newSVsv(val);
19692e8d 1512 HeKEY_hek(ent)
6e838c70 1513 = shared ? share_hek_flags(key, len, hash, flags)
19692e8d 1514 : save_hek_flags(key, len, hash, flags);
b56ba0bf
AMS
1515 if (prev)
1516 HeNEXT(prev) = ent;
1517 else
1518 ents[i] = ent;
1519 prev = ent;
1520 HeNEXT(ent) = NULL;
1521 }
1522 }
1523
1524 HvMAX(hv) = hv_max;
8aacddc1 1525 HvTOTALKEYS(hv) = HvTOTALKEYS(ohv);
b56ba0bf 1526 HvARRAY(hv) = ents;
aec46f14 1527 } /* not magical */
b56ba0bf
AMS
1528 else {
1529 /* Iterate over ohv, copying keys and values one at a time. */
b3ac6de7 1530 HE *entry;
bfcb3514
NC
1531 const I32 riter = HvRITER_get(ohv);
1532 HE * const eiter = HvEITER_get(ohv);
f6bb1c88 1533 STRLEN hv_keys = HvTOTALKEYS(ohv);
b56ba0bf 1534
f6bb1c88 1535 HV_SET_MAX_ADJUSTED_FOR_KEYS(hv,hv_max,hv_keys);
b56ba0bf 1536
4a76a316 1537 hv_iterinit(ohv);
e16e2ff8 1538 while ((entry = hv_iternext_flags(ohv, 0))) {
3f4d1d78
FC
1539 SV *val = hv_iterval(ohv,entry);
1540 SV * const keysv = HeSVKEY(entry);
1541 val = SvIMMORTAL(val) ? val : newSVsv(val);
1542 if (keysv)
1543 (void)hv_store_ent(hv, keysv, val, 0);
1544 else
1545 (void)hv_store_flags(hv, HeKEY(entry), HeKLEN(entry), val,
c3acb9e0 1546 HeHASH(entry), HeKFLAGS(entry));
b3ac6de7 1547 }
bfcb3514
NC
1548 HvRITER_set(ohv, riter);
1549 HvEITER_set(ohv, eiter);
b3ac6de7 1550 }
1c846c1f 1551
b3ac6de7
IZ
1552 return hv;
1553}
1554
defdfed5
Z
1555/*
1556=for apidoc Am|HV *|hv_copy_hints_hv|HV *ohv
1557
2d7f6611 1558A specialised version of L</newHVhv> for copying C<%^H>. C<ohv> must be
defdfed5
Z
1559a pointer to a hash (which may have C<%^H> magic, but should be generally
1560non-magical), or C<NULL> (interpreted as an empty hash). The content
2d7f6611 1561of C<ohv> is copied to a new hash, which has the C<%^H>-specific magic
defdfed5
Z
1562added to it. A pointer to the new hash is returned.
1563
1564=cut
1565*/
1566
5b9c0671
NC
1567HV *
1568Perl_hv_copy_hints_hv(pTHX_ HV *const ohv)
1569{
1570 HV * const hv = newHV();
5b9c0671 1571
cb1f05e8 1572 if (ohv) {
5b9c0671 1573 STRLEN hv_max = HvMAX(ohv);
f6bb1c88 1574 STRLEN hv_keys = HvTOTALKEYS(ohv);
5b9c0671
NC
1575 HE *entry;
1576 const I32 riter = HvRITER_get(ohv);
1577 HE * const eiter = HvEITER_get(ohv);
1578
0db511c0
FC
1579 ENTER;
1580 SAVEFREESV(hv);
1581
f6bb1c88 1582 HV_SET_MAX_ADJUSTED_FOR_KEYS(hv,hv_max,hv_keys);
5b9c0671
NC
1583
1584 hv_iterinit(ohv);
1585 while ((entry = hv_iternext_flags(ohv, 0))) {
cb1f05e8 1586 SV *const sv = newSVsv(hv_iterval(ohv,entry));
7ef9d42c
FC
1587 SV *heksv = HeSVKEY(entry);
1588 if (!heksv && sv) heksv = newSVhek(HeKEY_hek(entry));
95cf2368 1589 if (sv) sv_magic(sv, NULL, PERL_MAGIC_hintselem,
e3b1b6b1 1590 (char *)heksv, HEf_SVKEY);
7ef9d42c
FC
1591 if (heksv == HeSVKEY(entry))
1592 (void)hv_store_ent(hv, heksv, sv, 0);
1593 else {
1594 (void)hv_common(hv, heksv, HeKEY(entry), HeKLEN(entry),
1595 HeKFLAGS(entry), HV_FETCH_ISSTORE|HV_FETCH_JUST_SV, sv, HeHASH(entry));
a03199ea 1596 SvREFCNT_dec_NN(heksv);
7ef9d42c 1597 }
5b9c0671
NC
1598 }
1599 HvRITER_set(ohv, riter);
1600 HvEITER_set(ohv, eiter);
0db511c0
FC
1601
1602 SvREFCNT_inc_simple_void_NN(hv);
1603 LEAVE;
5b9c0671
NC
1604 }
1605 hv_magic(hv, NULL, PERL_MAGIC_hints);
1606 return hv;
1607}
f6bb1c88 1608#undef HV_SET_MAX_ADJUSTED_FOR_KEYS
5b9c0671 1609
e0171a1a
DM
1610/* like hv_free_ent, but returns the SV rather than freeing it */
1611STATIC SV*
5aaab254 1612S_hv_free_ent_ret(pTHX_ HV *hv, HE *entry)
79072805 1613{
16bdeea2
GS
1614 SV *val;
1615
e0171a1a 1616 PERL_ARGS_ASSERT_HV_FREE_ENT_RET;
7918f24d 1617
16bdeea2 1618 val = HeVAL(entry);
68dc0745
PP
1619 if (HeKLEN(entry) == HEf_SVKEY) {
1620 SvREFCNT_dec(HeKEY_sv(entry));
8aacddc1 1621 Safefree(HeKEY_hek(entry));
44a8e56a
PP
1622 }
1623 else if (HvSHAREKEYS(hv))
68dc0745 1624 unshare_hek(HeKEY_hek(entry));
fde52b5c 1625 else
68dc0745 1626 Safefree(HeKEY_hek(entry));
d33b2eba 1627 del_HE(entry);
e0171a1a
DM
1628 return val;
1629}
1630
1631
1632void
5aaab254 1633Perl_hv_free_ent(pTHX_ HV *hv, HE *entry)
e0171a1a 1634{
e0171a1a
DM
1635 SV *val;
1636
1637 PERL_ARGS_ASSERT_HV_FREE_ENT;
1638
1639 if (!entry)
1640 return;
1641 val = hv_free_ent_ret(hv, entry);
272e8453 1642 SvREFCNT_dec(val);
79072805
LW
1643}
1644
f1c32fec 1645
79072805 1646void
5aaab254 1647Perl_hv_delayfree_ent(pTHX_ HV *hv, HE *entry)
79072805 1648{
7918f24d
NC
1649 PERL_ARGS_ASSERT_HV_DELAYFREE_ENT;
1650
68dc0745 1651 if (!entry)
79072805 1652 return;
bc4947fc
NC
1653 /* SvREFCNT_inc to counter the SvREFCNT_dec in hv_free_ent */
1654 sv_2mortal(SvREFCNT_inc(HeVAL(entry))); /* free between statements */
68dc0745 1655 if (HeKLEN(entry) == HEf_SVKEY) {
bc4947fc 1656 sv_2mortal(SvREFCNT_inc(HeKEY_sv(entry)));
44a8e56a 1657 }
bc4947fc 1658 hv_free_ent(hv, entry);
79072805
LW
1659}
1660
954c1994
GS
1661/*
1662=for apidoc hv_clear
1663
c2217cd3 1664Frees the all the elements of a hash, leaving it empty.
8b9a1153
FC
1665The XS equivalent of C<%hash = ()>. See also L</hv_undef>.
1666
a4395eba
DM
1667See L</av_clear> for a note about the hash possibly being invalid on
1668return.
954c1994
GS
1669
1670=cut
1671*/
1672
79072805 1673void
864dbfa3 1674Perl_hv_clear(pTHX_ HV *hv)
79072805 1675{
27da23d5 1676 dVAR;
eb578fdb 1677 XPVHV* xhv;
79072805
LW
1678 if (!hv)
1679 return;
49293501 1680
ecae49c0
NC
1681 DEBUG_A(Perl_hv_assert(aTHX_ hv));
1682
34c3c4e3
DM
1683 xhv = (XPVHV*)SvANY(hv);
1684
8505eec0
FC
1685 ENTER;
1686 SAVEFREESV(SvREFCNT_inc_simple_NN(hv));
7b2c381c 1687 if (SvREADONLY(hv) && HvARRAY(hv) != NULL) {
34c3c4e3 1688 /* restricted hash: convert all keys to placeholders */
b464bac0
AL
1689 STRLEN i;
1690 for (i = 0; i <= xhv->xhv_max; i++) {
7b2c381c 1691 HE *entry = (HvARRAY(hv))[i];
3a676441
JH
1692 for (; entry; entry = HeNEXT(entry)) {
1693 /* not already placeholder */
7996736c 1694 if (HeVAL(entry) != &PL_sv_placeholder) {
a03199ea 1695 if (HeVAL(entry)) {
0ffdaf1a 1696 if (SvREADONLY(HeVAL(entry))) {
a03199ea
R
1697 SV* const keysv = hv_iterkeysv(entry);
1698 Perl_croak_nocontext(
1699 "Attempt to delete readonly key '%"SVf"' from a restricted hash",
1700 (void*)keysv);
1701 }
1702 SvREFCNT_dec_NN(HeVAL(entry));
3a676441 1703 }
7996736c 1704 HeVAL(entry) = &PL_sv_placeholder;
ca732855 1705 HvPLACEHOLDERS(hv)++;
3a676441 1706 }
34c3c4e3
DM
1707 }
1708 }
49293501 1709 }
afbbf215
DM
1710 else {
1711 hfreeentries(hv);
1712 HvPLACEHOLDERS_set(hv, 0);
49293501 1713
afbbf215
DM
1714 if (SvRMAGICAL(hv))
1715 mg_clear(MUTABLE_SV(hv));
574c8022 1716
afbbf215 1717 HvHASKFLAGS_off(hv);
afbbf215 1718 }
b79f7545 1719 if (SvOOK(hv)) {
00169e2c 1720 if(HvENAME_get(hv))
dd69841b 1721 mro_isa_changed_in(hv);
bfcb3514
NC
1722 HvEITER_set(hv, NULL);
1723 }
8505eec0 1724 LEAVE;
79072805
LW
1725}
1726
3540d4ce
AB
1727/*
1728=for apidoc hv_clear_placeholders
1729
1730Clears any placeholders from a hash. If a restricted hash has any of its keys
1731marked as readonly and the key is subsequently deleted, the key is not actually
796b6530 1732deleted but is marked by assigning it a value of C<&PL_sv_placeholder>. This tags
3540d4ce 1733it so it will be ignored by future operations such as iterating over the hash,
4cdaeff7 1734but will still allow the hash to have a value reassigned to the key at some
3540d4ce 1735future point. This function clears any such placeholder keys from the hash.
796b6530
KW
1736See C<L<Hash::Util::lock_keys()|Hash::Util/lock_keys>> for an example of its
1737use.
3540d4ce
AB
1738
1739=cut
1740*/
1741
1742void
1743Perl_hv_clear_placeholders(pTHX_ HV *hv)
1744{
b3ca2e83
NC
1745 const U32 items = (U32)HvPLACEHOLDERS_get(hv);
1746
7918f24d
NC
1747 PERL_ARGS_ASSERT_HV_CLEAR_PLACEHOLDERS;
1748
b3ca2e83
NC
1749 if (items)
1750 clear_placeholders(hv, items);
1751}
1752
1753static void
1754S_clear_placeholders(pTHX_ HV *hv, U32 items)
1755{
1756 dVAR;
b464bac0 1757 I32 i;
d3677389 1758
7918f24d
NC
1759 PERL_ARGS_ASSERT_CLEAR_PLACEHOLDERS;
1760
d3677389
NC
1761 if (items == 0)
1762 return;
1763
b464bac0 1764 i = HvMAX(hv);
d3677389
NC
1765 do {
1766 /* Loop down the linked list heads */
d3677389 1767 HE **oentry = &(HvARRAY(hv))[i];
cf6db12b 1768 HE *entry;
d3677389 1769
cf6db12b 1770 while ((entry = *oentry)) {
d3677389
NC
1771 if (HeVAL(entry) == &PL_sv_placeholder) {
1772 *oentry = HeNEXT(entry);
2e58978b 1773 if (entry == HvEITER_get(hv))
d3677389 1774 HvLAZYDEL_on(hv);
ae199939
TH
1775 else {
1776 if (SvOOK(hv) && HvLAZYDEL(hv) &&
1777 entry == HeNEXT(HvAUX(hv)->xhv_eiter))
1778 HeNEXT(HvAUX(hv)->xhv_eiter) = HeNEXT(entry);
d3677389 1779 hv_free_ent(hv, entry);
ae199939 1780 }
d3677389
NC
1781
1782 if (--items == 0) {
1783 /* Finished. */
5d27ee4a
DD
1784 I32 placeholders = HvPLACEHOLDERS_get(hv);
1785 HvTOTALKEYS(hv) -= (IV)placeholders;
1786 /* HvUSEDKEYS expanded */
1787 if ((HvTOTALKEYS(hv) - placeholders) == 0)
d3677389 1788 HvHASKFLAGS_off(hv);
5d88ecd7 1789 HvPLACEHOLDERS_set(hv, 0);
d3677389
NC
1790 return;
1791 }
213ce8b3
NC
1792 } else {
1793 oentry = &HeNEXT(entry);
d3677389
NC
1794 }
1795 }
1796 } while (--i >= 0);
1797 /* You can't get here, hence assertion should always fail. */
1798 assert (items == 0);
661d43c4 1799 NOT_REACHED; /* NOTREACHED */
3540d4ce
AB
1800}
1801
76e3520e 1802STATIC void
cea2e8a9 1803S_hfreeentries(pTHX_ HV *hv)
79072805 1804{
e0171a1a 1805 STRLEN index = 0;
7d6175ef 1806 XPVHV * const xhv = (XPVHV*)SvANY(hv);
6d1c68e6 1807 SV *sv;
3abe233e 1808
7918f24d
NC
1809 PERL_ARGS_ASSERT_HFREEENTRIES;
1810
6d1c68e6
FC
1811 while ((sv = Perl_hfree_next_entry(aTHX_ hv, &index))||xhv->xhv_keys) {
1812 SvREFCNT_dec(sv);
e0171a1a
DM
1813 }
1814}
23976bdd 1815
b79f7545 1816
e0171a1a
DM
1817/* hfree_next_entry()
1818 * For use only by S_hfreeentries() and sv_clear().
1819 * Delete the next available HE from hv and return the associated SV.
7d6175ef
FC
1820 * Returns null on empty hash. Nevertheless null is not a reliable
1821 * indicator that the hash is empty, as the deleted entry may have a
1822 * null value.
e0171a1a
DM
1823 * indexp is a pointer to the current index into HvARRAY. The index should
1824 * initially be set to 0. hfree_next_entry() may update it. */
1825
1826SV*
1827Perl_hfree_next_entry(pTHX_ HV *hv, STRLEN *indexp)
1828{
1829 struct xpvhv_aux *iter;
1830 HE *entry;
1831 HE ** array;
1832#ifdef DEBUGGING
1833 STRLEN orig_index = *indexp;
1834#endif
1835
1836 PERL_ARGS_ASSERT_HFREE_NEXT_ENTRY;
1837
9faf471a
NC
1838 if (SvOOK(hv) && ((iter = HvAUX(hv)))) {
1839 if ((entry = iter->xhv_eiter)) {
1840 /* the iterator may get resurrected after each
1841 * destructor call, so check each time */
1842 if (entry && HvLAZYDEL(hv)) { /* was deleted earlier? */
1843 HvLAZYDEL_off(hv);
1844 hv_free_ent(hv, entry);
1845 /* warning: at this point HvARRAY may have been
1846 * re-allocated, HvMAX changed etc */
1847 }
339441ef 1848 iter = HvAUX(hv); /* may have been realloced */
9faf471a
NC
1849 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
1850 iter->xhv_eiter = NULL; /* HvEITER(hv) = NULL */
6a5b4183 1851#ifdef PERL_HASH_RANDOMIZE_KEYS
9faf471a 1852 iter->xhv_last_rand = iter->xhv_rand;
6a5b4183 1853#endif
9faf471a
NC
1854 }
1855 /* Reset any cached HvFILL() to "unknown". It's unlikely that anyone
1856 will actually call HvFILL() on a hash under destruction, so it
1857 seems pointless attempting to track the number of keys remaining.
1858 But if they do, we want to reset it again. */
1859 if (iter->xhv_fill_lazy)
1860 iter->xhv_fill_lazy = 0;
e0171a1a
DM
1861 }
1862
00a1a643
DM
1863 if (!((XPVHV*)SvANY(hv))->xhv_keys)
1864 return NULL;
1865
e0171a1a
DM
1866 array = HvARRAY(hv);
1867 assert(array);
1868 while ( ! ((entry = array[*indexp])) ) {
1869 if ((*indexp)++ >= HvMAX(hv))
1870 *indexp = 0;
1871 assert(*indexp != orig_index);
1872 }
1873 array[*indexp] = HeNEXT(entry);
1874 ((XPVHV*) SvANY(hv))->xhv_keys--;
1875
1876 if ( PL_phase != PERL_PHASE_DESTRUCT && HvENAME(hv)
1877 && HeVAL(entry) && isGV(HeVAL(entry))
1878 && GvHV(HeVAL(entry)) && HvENAME(GvHV(HeVAL(entry)))
1879 ) {
1880 STRLEN klen;
1881 const char * const key = HePV(entry,klen);
1882 if ((klen > 1 && key[klen-1]==':' && key[klen-2]==':')
1883 || (klen == 1 && key[0] == ':')) {
1884 mro_package_moved(
1885 NULL, GvHV(HeVAL(entry)),
1886 (GV *)HeVAL(entry), 0
1887 );
1888 }
1889 }
1890 return hv_free_ent_ret(hv, entry);
79072805
LW
1891}
1892
e0171a1a 1893
954c1994
GS
1894/*
1895=for apidoc hv_undef
1896
8b9a1153 1897Undefines the hash. The XS equivalent of C<undef(%hash)>.
c2217cd3 1898
796b6530 1899As well as freeing all the elements of the hash (like C<hv_clear()>), this
c2217cd3 1900also frees any auxiliary data and storage associated with the hash.
8b9a1153 1901
a4395eba
DM
1902See L</av_clear> for a note about the hash possibly being invalid on
1903return.
954c1994
GS
1904
1905=cut
1906*/
1907
79072805 1908void
8581adba 1909Perl_hv_undef_flags(pTHX_ HV *hv, U32 flags)
79072805 1910{
eb578fdb 1911 XPVHV* xhv;
8a50cd03 1912 bool save;
86f55936 1913
79072805
LW
1914 if (!hv)
1915 return;
8a50cd03 1916 save = !!SvREFCNT(hv);
ecae49c0 1917 DEBUG_A(Perl_hv_assert(aTHX_ hv));
cbec9347 1918 xhv = (XPVHV*)SvANY(hv);
dd69841b 1919
745edda6
FC
1920 /* The name must be deleted before the call to hfreeeeentries so that
1921 CVs are anonymised properly. But the effective name must be pre-
1922 served until after that call (and only deleted afterwards if the
1923 call originated from sv_clear). For stashes with one name that is
1924 both the canonical name and the effective name, hv_name_set has to
1925 allocate an array for storing the effective name. We can skip that
1926 during global destruction, as it does not matter where the CVs point
1927 if they will be freed anyway. */
104d7b69
DM
1928 /* note that the code following prior to hfreeentries is duplicated
1929 * in sv_clear(), and changes here should be done there too */
0ca9877d 1930 if (PL_phase != PERL_PHASE_DESTRUCT && HvNAME(hv)) {
103f5a36
NC
1931 if (PL_stashcache) {
1932 DEBUG_o(Perl_deb(aTHX_ "hv_undef_flags clearing PL_stashcache for '%"
10bafe90 1933 HEKf"'\n", HEKfARG(HvNAME_HEK(hv))));
0ca9877d 1934 (void)hv_deletehek(PL_stashcache, HvNAME_HEK(hv), G_DISCARD);
103f5a36 1935 }
bd61b366 1936 hv_name_set(hv, NULL, 0, 0);
85e6fe83 1937 }
8505eec0
FC
1938 if (save) {
1939 ENTER;
1940 SAVEFREESV(SvREFCNT_inc_simple_NN(hv));
1941 }
2d0d1ecc 1942 hfreeentries(hv);
47f1cf77 1943 if (SvOOK(hv)) {
47f1cf77 1944 struct mro_meta *meta;
0ca9877d 1945 const char *name;
745edda6 1946
0ca9877d 1947 if (HvENAME_get(hv)) {
5f243b5f 1948 if (PL_phase != PERL_PHASE_DESTRUCT)
745edda6 1949 mro_isa_changed_in(hv);
103f5a36
NC
1950 if (PL_stashcache) {
1951 DEBUG_o(Perl_deb(aTHX_ "hv_undef_flags clearing PL_stashcache for effective name '%"
10bafe90 1952 HEKf"'\n", HEKfARG(HvENAME_HEK(hv))));
0ca9877d 1953 (void)hv_deletehek(PL_stashcache, HvENAME_HEK(hv), G_DISCARD);
103f5a36 1954 }
745edda6
FC
1955 }
1956
1957 /* If this call originated from sv_clear, then we must check for
1958 * effective names that need freeing, as well as the usual name. */
1959 name = HvNAME(hv);
339441ef 1960 if (flags & HV_NAME_SETALL ? !!HvAUX(hv)->xhv_name_u.xhvnameu_name : !!name) {
103f5a36
NC
1961 if (name && PL_stashcache) {
1962 DEBUG_o(Perl_deb(aTHX_ "hv_undef_flags clearing PL_stashcache for name '%"
10bafe90 1963 HEKf"'\n", HEKfARG(HvNAME_HEK(hv))));
0ca9877d 1964 (void)hv_deletehek(PL_stashcache, HvNAME_HEK(hv), G_DISCARD);
103f5a36 1965 }
745edda6 1966 hv_name_set(hv, NULL, 0, flags);
47f1cf77 1967 }
339441ef 1968 if((meta = HvAUX(hv)->xhv_mro_meta)) {
47f1cf77 1969 if (meta->mro_linear_all) {
d4f87935
FC
1970 SvREFCNT_dec_NN(meta->mro_linear_all);
1971 /* mro_linear_current is just acting as a shortcut pointer,
1972 hence the else. */
1973 }
1974 else
47f1cf77
FC
1975 /* Only the current MRO is stored, so this owns the data.
1976 */
1977 SvREFCNT_dec(meta->mro_linear_current);
9bfbb681 1978 SvREFCNT_dec(meta->mro_nextmethod);
47f1cf77 1979 SvREFCNT_dec(meta->isa);
1a33a059 1980 SvREFCNT_dec(meta->super);
47f1cf77 1981 Safefree(meta);
339441ef 1982 HvAUX(hv)->xhv_mro_meta = NULL;
47f1cf77 1983 }
339441ef 1984 if (!HvAUX(hv)->xhv_name_u.xhvnameu_name && ! HvAUX(hv)->xhv_backreferences)
745edda6 1985 SvFLAGS(hv) &= ~SVf_OOK;
745edda6
FC
1986 }
1987 if (!SvOOK(hv)) {
1988 Safefree(HvARRAY(hv));
f6bb1c88 1989 xhv->xhv_max = PERL_HASH_DEFAULT_HvMAX; /* HvMAX(hv) = 7 (it's a normal hash) */
745edda6 1990 HvARRAY(hv) = 0;
2d0d1ecc 1991 }
5bec93be
DM
1992 /* if we're freeing the HV, the SvMAGIC field has been reused for
1993 * other purposes, and so there can't be any placeholder magic */
1994 if (SvREFCNT(hv))
1995 HvPLACEHOLDERS_set(hv, 0);
a0d0e21e
LW
1996
1997 if (SvRMAGICAL(hv))
ad64d0ec 1998 mg_clear(MUTABLE_SV(hv));
8505eec0 1999 if (save) LEAVE;
79072805
LW
2000}
2001
4d0fbddd
NC
2002/*
2003=for apidoc hv_fill
2004
72d33970
FC
2005Returns the number of hash buckets that
2006happen to be in use. This function is
4d0fbddd
NC
2007wrapped by the macro C<HvFILL>.
2008
9faf471a
NC
2009Previously this value was always stored in the HV structure, which created an
2010overhead on every hash (and pretty much every object) for something that was
72d33970
FC
2011rarely used. Now we calculate it on demand the first
2012time that it is needed, and cache it if that calculation
2013is going to be costly to repeat. The cached
9faf471a
NC
2014value is updated by insertions and deletions, but (currently) discarded if
2015the hash is split.
4d0fbddd
NC
2016
2017=cut
2018*/
2019
2020STRLEN
9faf471a 2021Perl_hv_fill(pTHX_ HV *const hv)
4d0fbddd
NC
2022{
2023 STRLEN count = 0;
2024 HE **ents = HvARRAY(hv);
9faf471a 2025 struct xpvhv_aux *aux = SvOOK(hv) ? HvAUX(hv) : NULL;
4d0fbddd
NC
2026
2027 PERL_ARGS_ASSERT_HV_FILL;
2028
553215cc
NC
2029 /* No keys implies no buckets used.
2030 One key can only possibly mean one bucket used. */
2031 if (HvTOTALKEYS(hv) < 2)
2032 return HvTOTALKEYS(hv);
2033
9faf471a
NC
2034#ifndef DEBUGGING
2035 if (aux && aux->xhv_fill_lazy)
2036 return aux->xhv_fill_lazy;
2037#endif
2038
4d0fbddd 2039 if (ents) {
fcd24582
NC
2040 HE *const *const last = ents + HvMAX(hv);
2041 count = last + 1 - ents;
4d0fbddd
NC
2042
2043 do {
fcd24582
NC
2044 if (!*ents)
2045 --count;
2046 } while (++ents <= last);
4d0fbddd 2047 }
9faf471a
NC
2048 if (aux) {
2049#ifdef DEBUGGING
2050 if (aux->xhv_fill_lazy)
2051 assert(aux->xhv_fill_lazy == count);
2052#endif
2053 aux->xhv_fill_lazy = count;
2054 } else if (HvMAX(hv) >= HV_FILL_THRESHOLD) {
2055 aux = hv_auxinit(hv);
2056 aux->xhv_fill_lazy = count;
2057 }
4d0fbddd
NC
2058 return count;
2059}
2060
0e0ab621
YO
2061/* hash a pointer to a U32 - Used in the hash traversal randomization
2062 * and bucket order randomization code
2063 *
2064 * this code was derived from Sereal, which was derived from autobox.
2065 */
2066
2067PERL_STATIC_INLINE U32 S_ptr_hash(PTRV u) {
2068#if PTRSIZE == 8
2069 /*
2070 * This is one of Thomas Wang's hash functions for 64-bit integers from:
2071 * http://www.concentric.net/~Ttwang/tech/inthash.htm
2072 */
2073 u = (~u) + (u << 18);
2074 u = u ^ (u >> 31);
2075 u = u * 21;
2076 u = u ^ (u >> 11);
2077 u = u + (u << 6);
2078 u = u ^ (u >> 22);
2079#else
2080 /*
2081 * This is one of Bob Jenkins' hash functions for 32-bit integers
2082 * from: http://burtleburtle.net/bob/hash/integer.html
2083 */
2084 u = (u + 0x7ed55d16) + (u << 12);
2085 u = (u ^ 0xc761c23c) ^ (u >> 19);
2086 u = (u + 0x165667b1) + (u << 5);
2087 u = (u + 0xd3a2646c) ^ (u << 9);
2088 u = (u + 0xfd7046c5) + (u << 3);
2089 u = (u ^ 0xb55a4f09) ^ (u >> 16);
2090#endif
2091 return (U32)u;
2092}
2093
bea177f3
YO
2094static struct xpvhv_aux*
2095S_hv_auxinit_internal(struct xpvhv_aux *iter) {
2096 PERL_ARGS_ASSERT_HV_AUXINIT_INTERNAL;
2097 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
2098 iter->xhv_eiter = NULL; /* HvEITER(hv) = NULL */
2099#ifdef PERL_HASH_RANDOMIZE_KEYS
2100 iter->xhv_last_rand = iter->xhv_rand;
2101#endif
2102 iter->xhv_fill_lazy = 0;
2103 iter->xhv_name_u.xhvnameu_name = 0;
2104 iter->xhv_name_count = 0;
2105 iter->xhv_backreferences = 0;
2106 iter->xhv_mro_meta = NULL;
2107 iter->xhv_aux_flags = 0;
2108 return iter;
2109}
2110
0e0ab621 2111
b464bac0 2112static struct xpvhv_aux*
0e0ab621 2113S_hv_auxinit(pTHX_ HV *hv) {
bfcb3514 2114 struct xpvhv_aux *iter;
b79f7545 2115 char *array;
bfcb3514 2116
7918f24d
NC
2117 PERL_ARGS_ASSERT_HV_AUXINIT;
2118
0e0ab621
YO
2119 if (!SvOOK(hv)) {
2120 if (!HvARRAY(hv)) {
2121 Newxz(array, PERL_HV_ARRAY_ALLOC_BYTES(HvMAX(hv) + 1)
2122 + sizeof(struct xpvhv_aux), char);
2123 } else {
2124 array = (char *) HvARRAY(hv);
2125 Renew(array, PERL_HV_ARRAY_ALLOC_BYTES(HvMAX(hv) + 1)
2126 + sizeof(struct xpvhv_aux), char);
2127 }
2128 HvARRAY(hv) = (HE**)array;
2129 SvOOK_on(hv);
a7b39f85 2130 iter = HvAUX(hv);
6a5b4183
YO
2131#ifdef PERL_HASH_RANDOMIZE_KEYS
2132 if (PL_HASH_RAND_BITS_ENABLED) {
2133 /* mix in some new state to PL_hash_rand_bits to "randomize" the traversal order*/
2134 if (PL_HASH_RAND_BITS_ENABLED == 1)
2135 PL_hash_rand_bits += ptr_hash((PTRV)array);
2136 PL_hash_rand_bits = ROTL_UV(PL_hash_rand_bits,1);
2137 }
a7b39f85 2138 iter->xhv_rand = (U32)PL_hash_rand_bits;
6a5b4183 2139#endif
a7b39f85
YO
2140 } else {
2141 iter = HvAUX(hv);
b79f7545 2142 }
bfcb3514 2143
bea177f3 2144 return hv_auxinit_internal(iter);
bfcb3514
NC
2145}
2146
954c1994
GS
2147/*
2148=for apidoc hv_iterinit
2149
2150Prepares a starting point to traverse a hash table. Returns the number of
1b95d04f 2151keys in the hash (i.e. the same as C<HvUSEDKEYS(hv)>). The return value is
1c846c1f 2152currently only meaningful for hashes without tie magic.
954c1994
GS
2153
2154NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
2155hash buckets that happen to be in use. If you still need that esoteric
b24b84ef 2156value, you can get it through the macro C<HvFILL(hv)>.
954c1994 2157
e16e2ff8 2158
954c1994
GS
2159=cut
2160*/
2161
79072805 2162I32
864dbfa3 2163Perl_hv_iterinit(pTHX_ HV *hv)
79072805 2164{
7918f24d
NC
2165 PERL_ARGS_ASSERT_HV_ITERINIT;
2166
b79f7545 2167 if (SvOOK(hv)) {
339441ef 2168 struct xpvhv_aux * iter = HvAUX(hv);
0bd48802 2169 HE * const entry = iter->xhv_eiter; /* HvEITER(hv) */
bfcb3514
NC
2170 if (entry && HvLAZYDEL(hv)) { /* was deleted earlier? */
2171 HvLAZYDEL_off(hv);
2172 hv_free_ent(hv, entry);
2173 }
339441ef 2174 iter = HvAUX(hv); /* may have been reallocated */
bfcb3514 2175 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
4608196e 2176 iter->xhv_eiter = NULL; /* HvEITER(hv) = NULL */
6a5b4183 2177#ifdef PERL_HASH_RANDOMIZE_KEYS
a7b39f85 2178 iter->xhv_last_rand = iter->xhv_rand;
6a5b4183 2179#endif
bfcb3514 2180 } else {
6136c704 2181 hv_auxinit(hv);
72940dca 2182 }
44a2ac75 2183
cbec9347 2184 /* used to be xhv->xhv_fill before 5.004_65 */
5d88ecd7 2185 return HvTOTALKEYS(hv);
79072805 2186}
bfcb3514
NC
2187
2188I32 *
2189Perl_hv_riter_p(pTHX_ HV *hv) {
2190 struct xpvhv_aux *iter;
2191
7918f24d
NC
2192 PERL_ARGS_ASSERT_HV_RITER_P;
2193
6136c704 2194 iter = SvOOK(hv) ? HvAUX(hv) : hv_auxinit(hv);
bfcb3514
NC
2195 return &(iter->xhv_riter);
2196}
2197
2198HE **
2199Perl_hv_eiter_p(pTHX_ HV *hv) {
2200 struct xpvhv_aux *iter;
2201
7918f24d
NC
2202 PERL_ARGS_ASSERT_HV_EITER_P;
2203
6136c704 2204 iter = SvOOK(hv) ? HvAUX(hv) : hv_auxinit(hv);
bfcb3514
NC
2205 return &(iter->xhv_eiter);
2206}
2207
2208void
2209Perl_hv_riter_set(pTHX_ HV *hv, I32 riter) {
2210 struct xpvhv_aux *iter;
2211
7918f24d
NC
2212 PERL_ARGS_ASSERT_HV_RITER_SET;
2213
b79f7545
NC
2214 if (SvOOK(hv)) {
2215 iter = HvAUX(hv);
2216 } else {
bfcb3514
NC
2217 if (riter == -1)
2218 return;
2219
6136c704 2220 iter = hv_auxinit(hv);
bfcb3514
NC
2221 }
2222 iter->xhv_riter = riter;
2223}
2224
2225void
6a5b4183
YO
2226Perl_hv_rand_set(pTHX_ HV *hv, U32 new_xhv_rand) {
2227 struct xpvhv_aux *iter;
2228
2229 PERL_ARGS_ASSERT_HV_RAND_SET;
2230
2231#ifdef PERL_HASH_RANDOMIZE_KEYS
6a5b4183
YO
2232 if (SvOOK(hv)) {
2233 iter = HvAUX(hv);
2234 } else {
2235 iter = hv_auxinit(hv);
2236 }
2237 iter->xhv_rand = new_xhv_rand;
2238#else
2239 Perl_croak(aTHX_ "This Perl has not been built with support for randomized hash key traversal but something called Perl_hv_rand_set().");
2240#endif
2241}
2242
2243void
bfcb3514
NC
2244Perl_hv_eiter_set(pTHX_ HV *hv, HE *eiter) {
2245 struct xpvhv_aux *iter;
2246
7918f24d
NC
2247 PERL_ARGS_ASSERT_HV_EITER_SET;
2248
b79f7545
NC
2249 if (SvOOK(hv)) {
2250 iter = HvAUX(hv);
2251 } else {
bfcb3514
NC
2252 /* 0 is the default so don't go malloc()ing a new structure just to
2253 hold 0. */
2254 if (!eiter)
2255 return;
2256
6136c704 2257 iter = hv_auxinit(hv);
bfcb3514
NC
2258 }
2259 iter->xhv_eiter = eiter;
2260}
2261
bfcb3514 2262void
4164be69 2263Perl_hv_name_set(pTHX_ HV *hv, const char *name, U32 len, U32 flags)
bfcb3514 2264{
97aff369 2265 dVAR;
b79f7545 2266 struct xpvhv_aux *iter;
7423f6db 2267 U32 hash;
78b79c77 2268 HEK **spot;
46c461b5 2269
7918f24d 2270 PERL_ARGS_ASSERT_HV_NAME_SET;
bfcb3514 2271
4164be69
NC
2272 if (len > I32_MAX)
2273 Perl_croak(aTHX_ "panic: hv name too long (%"UVuf")", (UV) len);
2274
b79f7545
NC
2275 if (SvOOK(hv)) {
2276 iter = HvAUX(hv);
15d9236d 2277 if (iter->xhv_name_u.xhvnameu_name) {
b7247a80 2278 if(iter->xhv_name_count) {
745edda6 2279 if(flags & HV_NAME_SETALL) {
15d9236d 2280 HEK ** const name = HvAUX(hv)->xhv_name_u.xhvnameu_names;
78b79c77
FC
2281 HEK **hekp = name + (
2282 iter->xhv_name_count < 0
2283 ? -iter->xhv_name_count
2284 : iter->xhv_name_count
2285 );
2286 while(hekp-- > name+1)
b7247a80 2287 unshare_hek_or_pvn(*hekp, 0, 0, 0);
78b79c77
FC
2288 /* The first elem may be null. */
2289 if(*name) unshare_hek_or_pvn(*name, 0, 0, 0);
b7247a80 2290 Safefree(name);
339441ef 2291 iter = HvAUX(hv); /* may been realloced */
15d9236d 2292 spot = &iter->xhv_name_u.xhvnameu_name;
78b79c77
FC
2293 iter->xhv_name_count = 0;
2294 }
2295 else {
78b79c77
FC
2296 if(iter->xhv_name_count > 0) {
2297 /* shift some things over */
15d9236d
NC
2298 Renew(
2299 iter->xhv_name_u.xhvnameu_names, iter->xhv_name_count + 1, HEK *
4c2bfb4f 2300 );
15d9236d 2301 spot = iter->xhv_name_u.xhvnameu_names;
4c2bfb4f 2302 spot[iter->xhv_name_count] = spot[1];
78b79c77 2303 spot[1] = spot[0];
4c2bfb4f 2304 iter->xhv_name_count = -(iter->xhv_name_count + 1);
78b79c77 2305 }
15d9236d 2306 else if(*(spot = iter->xhv_name_u.xhvnameu_names)) {
78b79c77
FC
2307 unshare_hek_or_pvn(*spot, 0, 0, 0);
2308 }
2309 }
2310 }
745edda6 2311 else if (flags & HV_NAME_SETALL) {
15d9236d 2312 unshare_hek_or_pvn(iter->xhv_name_u.xhvnameu_name, 0, 0, 0);
339441ef 2313 iter = HvAUX(hv); /* may been realloced */
15d9236d 2314 spot = &iter->xhv_name_u.xhvnameu_name;
b7247a80 2315 }
745edda6 2316 else {
15d9236d
NC
2317 HEK * const existing_name = iter->xhv_name_u.xhvnameu_name;
2318 Newx(iter->xhv_name_u.xhvnameu_names, 2, HEK *);
745edda6 2319 iter->xhv_name_count = -2;
15d9236d 2320 spot = iter->xhv_name_u.xhvnameu_names;
745edda6
FC
2321 spot[1] = existing_name;
2322 }
7423f6db 2323 }
15d9236d 2324 else { spot = &iter->xhv_name_u.xhvnameu_name; iter->xhv_name_count = 0; }
16580ff5 2325 } else {
bfcb3514
NC
2326 if (name == 0)
2327 return;
2328
6136c704 2329 iter = hv_auxinit(hv);
15d9236d 2330 spot = &iter->xhv_name_u.xhvnameu_name;
bfcb3514 2331 }
7423f6db 2332 PERL_HASH(hash, name, len);
c60dbbc3 2333 *spot = name ? share_hek(name, flags & SVf_UTF8 ? -(I32)len : (I32)len, hash) : NULL;
4643eb69
BF
2334}
2335
2336/*
2337This is basically sv_eq_flags() in sv.c, but we avoid the magic
2338and bytes checking.
2339*/
2340
2341STATIC I32
2342hek_eq_pvn_flags(pTHX_ const HEK *hek, const char* pv, const I32 pvlen, const U32 flags) {
2343 if ( (HEK_UTF8(hek) ? 1 : 0) != (flags & SVf_UTF8 ? 1 : 0) ) {
2344 if (flags & SVf_UTF8)
2345 return (bytes_cmp_utf8(
2346 (const U8*)HEK_KEY(hek), HEK_LEN(hek),
2347 (const U8*)pv, pvlen) == 0);
2348 else
2349 return (bytes_cmp_utf8(
2350 (const U8*)pv, pvlen,
2351 (const U8*)HEK_KEY(hek), HEK_LEN(hek)) == 0);
2352 }
2353 else
d35fec6c 2354 return HEK_LEN(hek) == pvlen && ((HEK_KEY(hek) == pv)
4643eb69 2355 || memEQ(HEK_KEY(hek), pv, pvlen));
bfcb3514
NC
2356}
2357
99206677
FC
2358/*
2359=for apidoc hv_ename_add
2360
db4fbf16 2361Adds a name to a stash's internal list of effective names. See
fbe13c60 2362C<L</hv_ename_delete>>.
99206677
FC
2363
2364This is called when a stash is assigned to a new location in the symbol
2365table.
2366
2367=cut
2368*/
2369
ee72b38d 2370void
27a1175b 2371Perl_hv_ename_add(pTHX_ HV *hv, const char *name, U32 len, U32 flags)
ee72b38d
FC
2372{
2373 dVAR;
2374 struct xpvhv_aux *aux = SvOOK(hv) ? HvAUX(hv) : hv_auxinit(hv);
2375 U32 hash;
2376
78b79c77 2377 PERL_ARGS_ASSERT_HV_ENAME_ADD;
ee72b38d
FC
2378
2379 if (len > I32_MAX)
2380 Perl_croak(aTHX_ "panic: hv name too long (%"UVuf")", (UV) len);
2381
2382 PERL_HASH(hash, name, len);
2383
ee72b38d 2384 if (aux->xhv_name_count) {
78b79c77 2385 I32 count = aux->xhv_name_count;
3d50185d
FC
2386 HEK ** const xhv_name = aux->xhv_name_u.xhvnameu_names + (count<0);
2387 HEK **hekp = xhv_name + (count < 0 ? -count - 1 : count);
ee72b38d 2388 while (hekp-- > xhv_name)
3d50185d
FC
2389 {
2390 assert(*hekp);
ee72b38d 2391 if (
4643eb69
BF
2392 (HEK_UTF8(*hekp) || (flags & SVf_UTF8))
2393 ? hek_eq_pvn_flags(aTHX_ *hekp, name, (I32)len, flags)
2394 : (HEK_LEN(*hekp) == (I32)len && memEQ(HEK_KEY(*hekp), name, len))
2395 ) {
78b79c77
FC
2396 if (hekp == xhv_name && count < 0)
2397 aux->xhv_name_count = -count;
2398 return;
2399 }
3d50185d 2400 }
78b79c77
FC
2401 if (count < 0) aux->xhv_name_count--, count = -count;
2402 else aux->xhv_name_count++;
15d9236d 2403 Renew(aux->xhv_name_u.xhvnameu_names, count + 1, HEK *);
c60dbbc3 2404 (aux->xhv_name_u.xhvnameu_names)[count] = share_hek(name, (flags & SVf_UTF8 ? -(I32)len : (I32)len), hash);
ee72b38d
FC
2405 }
2406 else {
15d9236d 2407 HEK *existing_name = aux->xhv_name_u.xhvnameu_name;
ee72b38d 2408 if (
4643eb69
BF
2409 existing_name && (
2410 (HEK_UTF8(existing_name) || (flags & SVf_UTF8))
2411 ? hek_eq_pvn_flags(aTHX_ existing_name, name, (I32)len, flags)
2412 : (HEK_LEN(existing_name) == (I32)len && memEQ(HEK_KEY(existing_name), name, len))
2413 )
ee72b38d 2414 ) return;
15d9236d 2415 Newx(aux->xhv_name_u.xhvnameu_names, 2, HEK *);
78b79c77 2416 aux->xhv_name_count = existing_name ? 2 : -2;
15d9236d 2417 *aux->xhv_name_u.xhvnameu_names = existing_name;
c60dbbc3 2418 (aux->xhv_name_u.xhvnameu_names)[1] = share_hek(name, (flags & SVf_UTF8 ? -(I32)len : (I32)len), hash);
ee72b38d
FC
2419 }
2420}
2421
99206677
FC
2422/*
2423=for apidoc hv_ename_delete
2424
db4fbf16 2425Removes a name from a stash's internal list of effective names. If this is
99206677
FC
2426the name returned by C<HvENAME>, then another name in the list will take
2427its place (C<HvENAME> will use it).
2428
2429This is called when a stash is deleted from the symbol table.
2430
2431=cut
2432*/
2433
ee72b38d 2434void
27a1175b 2435Perl_hv_ename_delete(pTHX_ HV *hv, const char *name, U32 len, U32 flags)
ee72b38d 2436{
ee72b38d
FC
2437 struct xpvhv_aux *aux;
2438
78b79c77 2439 PERL_ARGS_ASSERT_HV_ENAME_DELETE;
ee72b38d
FC
2440
2441 if (len > I32_MAX)
2442 Perl_croak(aTHX_ "panic: hv name too long (%"UVuf")", (UV) len);
2443
2444 if (!SvOOK(hv)) return;
2445
2446 aux = HvAUX(hv);
15d9236d 2447 if (!aux->xhv_name_u.xhvnameu_name) return;
ee72b38d
FC
2448
2449 if (aux->xhv_name_count) {
15d9236d 2450 HEK ** const namep = aux->xhv_name_u.xhvnameu_names;
78b79c77
FC
2451 I32 const count = aux->xhv_name_count;
2452 HEK **victim = namep + (count < 0 ? -count : count);
2453 while (victim-- > namep + 1)
ee72b38d 2454 if (
4643eb69
BF
2455 (HEK_UTF8(*victim) || (flags & SVf_UTF8))
2456 ? hek_eq_pvn_flags(aTHX_ *victim, name, (I32)len, flags)
2457 : (HEK_LEN(*victim) == (I32)len && memEQ(HEK_KEY(*victim), name, len))
ee72b38d
FC
2458 ) {
2459 unshare_hek_or_pvn(*victim, 0, 0, 0);
339441ef 2460 aux = HvAUX(hv); /* may been realloced */
78b79c77
FC
2461 if (count < 0) ++aux->xhv_name_count;
2462 else --aux->xhv_name_count;
2463 if (
2464 (aux->xhv_name_count == 1 || aux->xhv_name_count == -1)
2465 && !*namep
2466 ) { /* if there are none left */
ee72b38d 2467 Safefree(namep);
15d9236d 2468 aux->xhv_name_u.xhvnameu_names = NULL;
78b79c77 2469 aux->xhv_name_count = 0;
ee72b38d
FC
2470 }
2471 else {
2472 /* Move the last one back to fill the empty slot. It
2473 does not matter what order they are in. */
78b79c77 2474 *victim = *(namep + (count < 0 ? -count : count) - 1);
ee72b38d
FC
2475 }
2476 return;
2477 }
78b79c77 2478 if (
4643eb69
BF
2479 count > 0 && (HEK_UTF8(*namep) || (flags & SVf_UTF8))
2480 ? hek_eq_pvn_flags(aTHX_ *namep, name, (I32)len, flags)
2481 : (HEK_LEN(*namep) == (I32)len && memEQ(HEK_KEY(*namep), name, len))
78b79c77
FC
2482 ) {
2483 aux->xhv_name_count = -count;
2484 }
ee72b38d
FC
2485 }
2486 else if(
4643eb69
BF
2487 (HEK_UTF8(aux->xhv_name_u.xhvnameu_name) || (flags & SVf_UTF8))
2488 ? hek_eq_pvn_flags(aTHX_ aux->xhv_name_u.xhvnameu_name, name, (I32)len, flags)
2489 : (HEK_LEN(aux->xhv_name_u.xhvnameu_name) == (I32)len &&
2490 memEQ(HEK_KEY(aux->xhv_name_u.xhvnameu_name), name, len))
ee72b38d 2491 ) {
15d9236d
NC
2492 HEK * const namehek = aux->xhv_name_u.xhvnameu_name;
2493 Newx(aux->xhv_name_u.xhvnameu_names, 1, HEK *);
2494 *aux->xhv_name_u.xhvnameu_names = namehek;
3f783763 2495 aux->xhv_name_count = -1;
ee72b38d
FC
2496 }
2497}
2498
86f55936
NC
2499AV **
2500Perl_hv_backreferences_p(pTHX_ HV *hv) {
7918f24d 2501 PERL_ARGS_ASSERT_HV_BACKREFERENCES_P;
8fbcb657 2502 /* See also Perl_sv_get_backrefs in sv.c where this logic is unrolled */
34f2dd85
YO
2503 {
2504 struct xpvhv_aux * const iter = SvOOK(hv) ? HvAUX(hv) : hv_auxinit(hv);
2505 return &(iter->xhv_backreferences);
2506 }
86f55936
NC
2507}
2508
09aad8f0
DM
2509void
2510Perl_hv_kill_backrefs(pTHX_ HV *hv) {
2511 AV *av;
2512
2513 PERL_ARGS_ASSERT_HV_KILL_BACKREFS;
2514
2515 if (!SvOOK(hv))
2516 return;
2517
2518 av = HvAUX(hv)->xhv_backreferences;
2519
2520 if (av) {
2521 HvAUX(hv)->xhv_backreferences = 0;
2522 Perl_sv_kill_backrefs(aTHX_ MUTABLE_SV(hv), av);
5648c0ae 2523 if (SvTYPE(av) == SVt_PVAV)
0c920c9b 2524 SvREFCNT_dec_NN(av);
09aad8f0
DM
2525 }
2526}
2527
954c1994 2528/*
7a7b9979
NC
2529hv_iternext is implemented as a macro in hv.h
2530
954c1994
GS
2531=for apidoc hv_iternext
2532
fbe13c60 2533Returns entries from a hash iterator. See C<L</hv_iterinit>>.
954c1994 2534
fe7bca90
NC
2535You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
2536iterator currently points to, without losing your place or invalidating your
2537iterator. Note that in this case the current entry is deleted from the hash
2538with your iterator holding the last reference to it. Your iterator is flagged
2539to free the entry on the next call to C<hv_iternext>, so you must not discard
2540your iterator immediately else the entry will leak - call C<hv_iternext> to
2541trigger the resource deallocation.
2542
fe7bca90
NC
2543=for apidoc hv_iternext_flags
2544
fbe13c60
KW
2545Returns entries from a hash iterator. See C<L</hv_iterinit>> and
2546C<L</hv_iternext>>.
796b6530 2547The C<flags> value will normally be zero; if C<HV_ITERNEXT_WANTPLACEHOLDERS> is
fe7bca90 2548set the placeholders keys (for restricted hashes) will be returned in addition
72d33970 2549to normal keys. By default placeholders are automatically skipped over.
7996736c 2550Currently a placeholder is implemented with a value that is
990c89d7 2551C<&PL_sv_placeholder>. Note that the implementation of placeholders and
fe7bca90
NC
2552restricted hashes may change, and the implementation currently is
2553insufficiently abstracted for any change to be tidy.
e16e2ff8 2554
fe7bca90 2555=cut
e16e2ff8
NC
2556*/
2557
2558HE *
2559Perl_hv_iternext_flags(pTHX_ HV *hv, I32 flags)
2560{
27da23d5 2561 dVAR;
eb578fdb
KW
2562 XPVHV* xhv;
2563 HE *entry;
a0d0e21e 2564 HE *oldentry;
463ee0b2 2565 MAGIC* mg;
bfcb3514 2566 struct xpvhv_aux *iter;
79072805 2567
7918f24d
NC
2568 PERL_ARGS_ASSERT_HV_ITERNEXT_FLAGS;
2569
cbec9347 2570 xhv = (XPVHV*)SvANY(hv);
bfcb3514 2571
b79f7545 2572 if (!SvOOK(hv)) {
bfcb3514 2573 /* Too many things (well, pp_each at least) merrily assume that you can
caee4c53 2574 call hv_iternext without calling hv_iterinit, so we'll have to deal
bfcb3514
NC
2575 with it. */
2576 hv_iterinit(hv);
bfcb3514 2577 }
b79f7545 2578 iter = HvAUX(hv);
bfcb3514
NC
2579
2580 oldentry = entry = iter->xhv_eiter; /* HvEITER(hv) */
e62cc96a 2581 if (SvMAGICAL(hv) && SvRMAGICAL(hv)) {
ad64d0ec 2582 if ( ( mg = mg_find((const SV *)hv, PERL_MAGIC_tied) ) ) {
e62cc96a
YO
2583 SV * const key = sv_newmortal();
2584 if (entry) {
2585 sv_setsv(key, HeSVKEY_force(entry));
2586 SvREFCNT_dec(HeSVKEY(entry)); /* get rid of previous key */
895cdc83 2587 HeSVKEY_set(entry, NULL);
e62cc96a
YO
2588 }
2589 else {
2590 char *k;
2591 HEK *hek;
2592
2593 /* one HE per MAGICAL hash */
2594 iter->xhv_eiter = entry = new_HE(); /* HvEITER(hv) = new_HE() */
895cdc83 2595 HvLAZYDEL_on(hv); /* make sure entry gets freed */
e62cc96a 2596 Zero(entry, 1, HE);
ad64d0ec 2597 Newxz(k, HEK_BASESIZE + sizeof(const SV *), char);
e62cc96a
YO
2598 hek = (HEK*)k;
2599 HeKEY_hek(entry) = hek;
2600 HeKLEN(entry) = HEf_SVKEY;
2601 }
ad64d0ec 2602 magic_nextpack(MUTABLE_SV(hv),mg,key);
e62cc96a
YO
2603 if (SvOK(key)) {
2604 /* force key to stay around until next time */
2605 HeSVKEY_set(entry, SvREFCNT_inc_simple_NN(key));
2606 return entry; /* beware, hent_val is not set */
2607 }
ef8d46e8 2608 SvREFCNT_dec(HeVAL(entry));
e62cc96a
YO
2609 Safefree(HeKEY_hek(entry));
2610 del_HE(entry);
339441ef 2611 iter = HvAUX(hv); /* may been realloced */
e62cc96a 2612 iter->xhv_eiter = NULL; /* HvEITER(hv) = NULL */
895cdc83 2613 HvLAZYDEL_off(hv);
e62cc96a 2614 return NULL;
81714fb9 2615 }
79072805 2616 }
7ee146b1 2617#if defined(DYNAMIC_ENV_FETCH) && !defined(__riscos__) /* set up %ENV for iteration */
ad64d0ec
NC
2618 if (!entry && SvRMAGICAL((const SV *)hv)
2619 && mg_find((const SV *)hv, PERL_MAGIC_env)) {
f675dbe5 2620 prime_env_iter();
03026e68
JM
2621#ifdef VMS
2622 /* The prime_env_iter() on VMS just loaded up new hash values
2623 * so the iteration count needs to be reset back to the beginning
2624 */
2625 hv_iterinit(hv);
2626 iter = HvAUX(hv);
2627 oldentry = entry = iter->xhv_eiter; /* HvEITER(hv) */
2628#endif
2629 }
f675dbe5 2630#endif
463ee0b2 2631
bfaf5b52 2632 /* hv_iterinit now ensures this. */
b79f7545
NC
2633 assert (HvARRAY(hv));
2634
015a5f36 2635 /* At start of hash, entry is NULL. */
fde52b5c 2636 if (entry)
8aacddc1 2637 {
fde52b5c 2638 entry = HeNEXT(entry);
e16e2ff8
NC
2639 if (!(flags & HV_ITERNEXT_WANTPLACEHOLDERS)) {
2640 /*
2641 * Skip past any placeholders -- don't want to include them in
2642 * any iteration.
2643 */
7996736c 2644 while (entry && HeVAL(entry) == &PL_sv_placeholder) {
e16e2ff8
NC
2645 entry = HeNEXT(entry);
2646 }
8aacddc1
NIS
2647 }
2648 }
6a5b4183
YO
2649
2650#ifdef PERL_HASH_RANDOMIZE_KEYS
a7b39f85
YO
2651 if (iter->xhv_last_rand != iter->xhv_rand) {
2652 if (iter->xhv_riter != -1) {
2653 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
2654 "Use of each() on hash after insertion without resetting hash iterator results in undefined behavior"
2655 pTHX__FORMAT
2656 pTHX__VALUE);
2657 }
339441ef 2658 iter = HvAUX(hv); /* may been realloced */
a7b39f85
YO
2659 iter->xhv_last_rand = iter->xhv_rand;
2660 }
6a5b4183 2661#endif
015a5f36 2662
9eb4ebd1
NC
2663 /* Skip the entire loop if the hash is empty. */
2664 if ((flags & HV_ITERNEXT_WANTPLACEHOLDERS)
2665 ? HvTOTALKEYS(hv) : HvUSEDKEYS(hv)) {
900ac051
MM
2666 while (!entry) {
2667 /* OK. Come to the end of the current list. Grab the next one. */
2668
2669 iter->xhv_riter++; /* HvRITER(hv)++ */
2670 if (iter->xhv_riter > (I32)xhv->xhv_max /* HvRITER(hv) > HvMAX(hv) */) {
2671 /* There is no next one. End of the hash. */
2672 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
6a5b4183
YO
2673#ifdef PERL_HASH_RANDOMIZE_KEYS
2674 iter->xhv_last_rand = iter->xhv_rand; /* reset xhv_last_rand so we can detect inserts during traversal */
2675#endif
900ac051
MM
2676 break;
2677 }
6a5b4183 2678 entry = (HvARRAY(hv))[ PERL_HASH_ITER_BUCKET(iter) & xhv->xhv_max ];
8aacddc1 2679
900ac051
MM
2680 if (!(flags & HV_ITERNEXT_WANTPLACEHOLDERS)) {
2681 /* If we have an entry, but it's a placeholder, don't count it.
2682 Try the next. */
2683 while (entry && HeVAL(entry) == &PL_sv_placeholder)
2684 entry = HeNEXT(entry);
2685 }
2686 /* Will loop again if this linked list starts NULL
2687 (for HV_ITERNEXT_WANTPLACEHOLDERS)
2688 or if we run through it and find only placeholders. */
015a5f36 2689 }
fde52b5c 2690 }
a7b39f85
YO
2691 else {
2692 iter->xhv_riter = -1;
6a5b4183 2693#ifdef PERL_HASH_RANDOMIZE_KEYS
a7b39f85 2694 iter->xhv_last_rand = iter->xhv_rand;
6a5b4183 2695#endif
a7b39f85 2696 }
79072805 2697
72940dca
PP
2698 if (oldentry && HvLAZYDEL(hv)) { /* was deleted earlier? */
2699 HvLAZYDEL_off(hv);
68dc0745 2700 hv_free_ent(hv, oldentry);
72940dca 2701 }
a0d0e21e 2702
339441ef 2703 iter = HvAUX(hv); /* may been realloced */
bfcb3514 2704 iter->xhv_eiter = entry; /* HvEITER(hv) = entry */
79072805
LW
2705 return entry;
2706}
2707
954c1994
GS
2708/*
2709=for apidoc hv_iterkey
2710
2711Returns the key from the current position of the hash iterator. See
fbe13c60 2712C<L</hv_iterinit>>.
954c1994
GS
2713
2714=cut
2715*/
2716
79072805 2717char *
5aaab254 2718Perl_hv_iterkey(pTHX_ HE *entry, I32 *retlen)
79072805 2719{
7918f24d
NC
2720 PERL_ARGS_ASSERT_HV_ITERKEY;
2721
fde52b5c 2722 if (HeKLEN(entry) == HEf_SVKEY) {
fb73857a 2723 STRLEN len;
0bd48802 2724 char * const p = SvPV(HeKEY_sv(entry), len);
fb73857a
PP
2725 *retlen = len;
2726 return p;
fde52b5c
PP
2727 }
2728 else {
2729 *retlen = HeKLEN(entry);
2730 return HeKEY(entry);
2731 }
2732}
2733
2734/* unlike hv_iterval(), this always returns a mortal copy of the key */
954c1994
GS
2735/*
2736=for apidoc hv_iterkeysv
2737
2738Returns the key as an C<SV*> from the current position of the hash
2739iterator. The return value will always be a mortal copy of the key. Also
fbe13c60 2740see C<L</hv_iterinit>>.
954c1994
GS
2741
2742=cut
2743*/
2744
fde52b5c 2745SV *
5aaab254 2746Perl_hv_iterkeysv(pTHX_ HE *entry)
fde52b5c 2747{
7918f24d
NC
2748 PERL_ARGS_ASSERT_HV_ITERKEYSV;
2749
c1b02ed8 2750 return sv_2mortal(newSVhek(HeKEY_hek(entry)));
79072805
LW
2751}
2752
954c1994
GS
2753/*
2754=for apidoc hv_iterval
2755
2756Returns the value from the current position of the hash iterator. See
fbe13c60 2757C<L</hv_iterkey>>.
954c1994
GS
2758
2759=cut
2760*/
2761
79072805 2762SV *
5aaab254 2763Perl_hv_iterval(pTHX_ HV *hv, HE *entry)
79072805 2764{
7918f24d
NC
2765 PERL_ARGS_ASSERT_HV_ITERVAL;
2766
8990e307 2767 if (SvRMAGICAL(hv)) {
ad64d0ec 2768 if (mg_find((const SV *)hv, PERL_MAGIC_tied)) {
c4420975 2769 SV* const sv = sv_newmortal();
bbce6d69 2770 if (HeKLEN(entry) == HEf_SVKEY)
ad64d0ec 2771 mg_copy(MUTABLE_SV(hv), sv, (char*)HeKEY_sv(entry), HEf_SVKEY);
a3b680e6 2772 else
ad64d0ec 2773 mg_copy(MUTABLE_SV(hv), sv, HeKEY(entry), HeKLEN(entry));
463ee0b2
LW
2774 return sv;
2775 }
79072805 2776 }
fde52b5c 2777 return HeVAL(entry);
79072805
LW
2778}
2779
954c1994
GS
2780/*
2781=for apidoc hv_iternextsv
2782
2783Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
2784operation.
2785
2786=cut
2787*/
2788
a0d0e21e 2789SV *
864dbfa3 2790Perl_hv_iternextsv(pTHX_ HV *hv, char **key, I32 *retlen)
a0d0e21e 2791{
0bd48802
AL
2792 HE * const he = hv_iternext_flags(hv, 0);
2793
7918f24d
NC
2794 PERL_ARGS_ASSERT_HV_ITERNEXTSV;
2795
0bd48802 2796 if (!he)
a0d0e21e
LW
2797 return NULL;
2798 *key = hv_iterkey(he, retlen);
2799 return hv_iterval(hv, he);
2800}
2801
954c1994 2802/*
bc5cdc23
NC
2803
2804Now a macro in hv.h
2805
954c1994
GS
2806=for apidoc hv_magic
2807
fbe13c60 2808Adds magic to a hash. See C<L</sv_magic>>.
954c1994
GS
2809
2810=cut
2811*/
2812
bbce6d69 2813/* possibly free a shared string if no one has access to it
fde52b5c
PP
2814 * len and hash must both be valid for str.
2815 */
bbce6d69 2816void
864dbfa3 2817Perl_unsharepvn(pTHX_ const char *str, I32 len, U32 hash)
fde52b5c 2818{
19692e8d
NC
2819 unshare_hek_or_pvn (NULL, str, len, hash);
2820}
2821
2822
2823void
2824Perl_unshare_hek(pTHX_ HEK *hek)
2825{
bf11fd37 2826 assert(hek);
19692e8d
NC
2827 unshare_hek_or_pvn(hek, NULL, 0, 0);
2828}
2829
2830/* possibly free a shared string if no one has access to it
2831 hek if non-NULL takes priority over the other 3, else str, len and hash
2832 are used. If so, len and hash must both be valid for str.
2833 */
df132699 2834STATIC void
97ddebaf 2835S_unshare_hek_or_pvn(pTHX_ const HEK *hek, const char *str, I32 len, U32 hash)
19692e8d 2836{
eb578fdb 2837 XPVHV* xhv;
20454177 2838 HE *entry;
eb578fdb 2839 HE **oentry;
c3654f1a 2840 bool is_utf8 = FALSE;
19692e8d 2841 int k_flags = 0;
aec46f14 2842 const char * const save = str;
cbbf8932 2843 struct shared_he *he = NULL;
c3654f1a 2844
19692e8d 2845 if (hek) {
cbae3960
NC
2846 /* Find the shared he which is just before us in memory. */
2847 he = (struct shared_he *)(((char *)hek)
2848 - STRUCT_OFFSET(struct shared_he,
2849 shared_he_hek));
2850
2851 /* Assert that the caller passed us a genuine (or at least consistent)
2852 shared hek */
2853 assert (he->shared_he_he.hent_hek == hek);
29404ae0 2854
de616631
NC
2855 if (he->shared_he_he.he_valu.hent_refcount - 1) {
2856 --he->shared_he_he.he_valu.hent_refcount;
29404ae0
NC
2857 return;
2858 }
29404ae0 2859
19692e8d
NC
2860 hash = HEK_HASH(hek);
2861 } else if (len < 0) {
2862 STRLEN tmplen = -len;
2863 is_utf8 = TRUE;
2864 /* See the note in hv_fetch(). --jhi */
2865 str = (char*)bytes_from_utf8((U8*)str, &tmplen, &is_utf8);
2866 len = tmplen;
2867 if (is_utf8)
2868 k_flags = HVhek_UTF8;
2869 if (str != save)
2870 k_flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
c3654f1a 2871 }
1c846c1f 2872
de616631 2873 /* what follows was the moral equivalent of:
6b88bc9c 2874 if ((Svp = hv_fetch(PL_strtab, tmpsv, FALSE, hash))) {
a0714e2c 2875 if (--*Svp == NULL)
6b88bc9c 2876 hv_delete(PL_strtab, str, len, G_DISCARD, hash);
bbce6d69 2877 } */
cbec9347 2878 xhv = (XPVHV*)SvANY(PL_strtab);
fde52b5c 2879 /* assert(xhv_array != 0) */
9de10d5c 2880 oentry = &(HvARRAY(PL_strtab))[hash & (I32) HvMAX(PL_strtab)];
6c1b96a1
NC
2881 if (he) {
2882 const HE *const he_he = &(he->shared_he_he);
45d1cc86 2883 for (entry = *oentry; entry; oentry = &HeNEXT(entry), entry = *oentry) {
35ab5632
NC
2884 if (entry == he_he)
2885 break;
19692e8d
NC
2886 }
2887 } else {
35a4481c 2888 const int flags_masked = k_flags & HVhek_MASK;
45d1cc86 2889 for (entry = *oentry; entry; oentry = &HeNEXT(entry), entry = *oentry) {
19692e8d
NC
2890 if (HeHASH(entry) != hash) /* strings can't be equal */
2891 continue;
2892 if (HeKLEN(entry) != len)
2893 continue;
2894 if (HeKEY(entry) != str && memNE(HeKEY(entry),str,len)) /* is this it? */
2895 continue;
2896 if (HeKFLAGS(entry) != flags_masked)
2897 continue;
19692e8d
NC
2898 break;
2899 }
2900 }
2901
35ab5632
NC
2902 if (entry) {
2903 if (--entry->he_valu.hent_refcount == 0) {
19692e8d 2904 *oentry = HeNEXT(entry);
cbae3960 2905 Safefree(entry);
4c7185a0 2906 xhv->xhv_keys--; /* HvTOTALKEYS(hv)-- */
19692e8d 2907 }
fde52b5c 2908 }
19692e8d 2909
9b387841
NC
2910 if (!entry)
2911 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
12578ffb 2912 "Attempt to free nonexistent shared string '%s'%s"
9b387841
NC
2913 pTHX__FORMAT,
2914 hek ? HEK_KEY(hek) : str,
2915 ((k_flags & HVhek_UTF8) ? " (utf8)" : "") pTHX__VALUE);
19692e8d
NC
2916 if (k_flags & HVhek_FREEKEY)
2917 Safefree(str);
fde52b5c
PP
2918}
2919
bbce6d69
PP
2920/* get a (constant) string ptr from the global string table
2921 * string will get added if it is not already there.
fde52b5c
PP
2922 * len and hash must both be valid for str.
2923 */
bbce6d69 2924HEK *
5aaab254 2925Perl_share_hek(pTHX_ const char *str, I32 len, U32 hash)
fde52b5c 2926{
da58a35d 2927 bool is_utf8 = FALSE;
19692e8d 2928 int flags = 0;
aec46f14 2929 const char * const save = str;
da58a35d 2930
7918f24d
NC
2931 PERL_ARGS_ASSERT_SHARE_HEK;
2932
da58a35d 2933 if (len < 0) {
77caf834 2934 STRLEN tmplen = -len;
da58a35d 2935 is_utf8 = TRUE;
77caf834
JH
2936 /* See the note in hv_fetch(). --jhi */
2937 str = (char*)bytes_from_utf8((U8*)str, &tmplen, &is_utf8);
2938 len = tmplen;
19692e8d
NC
2939 /* If we were able to downgrade here, then than means that we were passed
2940 in a key which only had chars 0-255, but was utf8 encoded. */
2941 if (is_utf8)
2942 flags = HVhek_UTF8;
2943 /* If we found we were able to downgrade the string to bytes, then
2944 we should flag that it needs upgrading on keys or each. Also flag
2945 that we need share_hek_flags to free the string. */
4643eb69 2946 if (str != save) {
c2587955 2947 dVAR;
4643eb69 2948 PERL_HASH(hash, str, len);
19692e8d 2949 flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
4643eb69 2950 }
19692e8d
NC
2951 }
2952
6e838c70 2953 return share_hek_flags (str, len, hash, flags);
19692e8d
NC
2954}
2955
6e838c70 2956STATIC HEK *
5aaab254 2957S_share_hek_flags(pTHX_ const char *str, I32 len, U32 hash, int flags)
19692e8d 2958{
eb578fdb 2959 HE *entry;
35a4481c 2960 const int flags_masked = flags & HVhek_MASK;
263cb4a6 2961 const U32 hindex = hash & (I32) HvMAX(PL_strtab);
eb578fdb 2962 XPVHV * const xhv = (XPVHV*)SvANY(PL_strtab);
7918f24d
NC
2963
2964 PERL_ARGS_ASSERT_SHARE_HEK_FLAGS;
bbce6d69 2965
fde52b5c 2966 /* what follows is the moral equivalent of:
1c846c1f 2967
6b88bc9c 2968 if (!(Svp = hv_fetch(PL_strtab, str, len, FALSE)))
a0714e2c 2969 hv_store(PL_strtab, str, len, NULL, hash);
fdcd69b6
NC
2970
2971 Can't rehash the shared string table, so not sure if it's worth
2972 counting the number of entries in the linked list
bbce6d69 2973 */
7918f24d 2974
fde52b5c 2975 /* assert(xhv_array != 0) */
263cb4a6
NC
2976 entry = (HvARRAY(PL_strtab))[hindex];
2977 for (;entry; entry = HeNEXT(entry)) {
fde52b5c
PP
2978 if (HeHASH(entry) != hash) /* strings can't be equal */
2979 continue;
2980 if (HeKLEN(entry) != len)
2981 continue;
1c846c1f 2982 if (HeKEY(entry) != str && memNE(HeKEY(entry),str,len)) /* is this it? */
fde52b5c 2983 continue;
19692e8d 2984 if (HeKFLAGS(entry) != flags_masked)
c3654f1a 2985 continue;
fde52b5c
PP
2986 break;
2987 }
263cb4a6
NC
2988
2989 if (!entry) {
45d1cc86
NC
2990 /* What used to be head of the list.
2991 If this is NULL, then we're the first entry for this slot, which
2992 means we need to increate fill. */
cbae3960
NC
2993 struct shared_he *new_entry;
2994 HEK *hek;
2995 char *k;
263cb4a6
NC
2996 HE **const head = &HvARRAY(PL_strtab)[hindex];
2997 HE *const next = *head;
cbae3960
NC
2998
2999 /* We don't actually store a HE from the arena and a regular HEK.
3000 Instead we allocate one chunk of memory big enough for both,
3001 and put the HEK straight after the HE. This way we can find the
f52337cf 3002 HE directly from the HEK.
cbae3960
NC
3003 */
3004
a02a5408 3005 Newx(k, STRUCT_OFFSET(struct shared_he,
cbae3960
NC
3006 shared_he_hek.hek_key[0]) + len + 2, char);
3007 new_entry = (struct shared_he *)k;
3008 entry = &(new_entry->shared_he_he);
3009 hek = &(new_entry->shared_he_hek);
3010
3011 Copy(str, HEK_KEY(hek), len, char);
3012 HEK_KEY(hek)[len] = 0;
3013 HEK_LEN(hek) = len;
3014 HEK_HASH(hek) = hash;
3015 HEK_FLAGS(hek) = (unsigned char)flags_masked;
3016
3017 /* Still "point" to the HEK, so that other code need not know what
3018 we're up to. */
3019 HeKEY_hek(entry) = hek;
de616631 3020 entry->he_valu.hent_refcount = 0;
263cb4a6
NC
3021 HeNEXT(entry) = next;
3022 *head = entry;
cbae3960 3023
4c7185a0 3024 xhv->xhv_keys++; /* HvTOTALKEYS(hv)++ */
263cb4a6 3025 if (!next) { /* initial entry? */
8e317198 3026 } else if ( DO_HSPLIT(xhv) ) {
adf6906b
NC
3027 const STRLEN oldsize = xhv->xhv_max + 1;
3028 hsplit(PL_strtab, oldsize, oldsize * 2);
bbce6d69
PP
3029 }
3030 }
3031
de616631 3032 ++entry->he_valu.hent_refcount;
19692e8d
NC
3033
3034 if (flags & HVhek_FREEKEY)
f9a63242 3035 Safefree(str);
19692e8d 3036
6e838c70 3037 return HeKEY_hek(entry);
fde52b5c 3038}
ecae49c0 3039
6174b39a 3040SSize_t *
ca732855
NC
3041Perl_hv_placeholders_p(pTHX_ HV *hv)
3042{
ad64d0ec 3043 MAGIC *mg = mg_find((const SV *)hv, PERL_MAGIC_rhash);
ca732855 3044
7918f24d
NC
3045 PERL_ARGS_ASSERT_HV_PLACEHOLDERS_P;
3046
ca732855 3047 if (!mg) {
ad64d0ec 3048 mg = sv_magicext(MUTABLE_SV(hv), 0, PERL_MAGIC_rhash, 0, 0, 0);
ca732855
NC
3049
3050 if (!mg) {
3051 Perl_die(aTHX_ "panic: hv_placeholders_p");
3052 }
3053 }
3054 return &(mg->mg_len);
3055}
3056
3057
3058I32
0c289d13 3059Perl_hv_placeholders_get(pTHX_ const HV *hv)
ca732855 3060{
0c289d13 3061 MAGIC * const mg = mg_find((const SV *)hv, PERL_MAGIC_rhash);
ca732855 3062
7918f24d 3063 PERL_ARGS_ASSERT_HV_PLACEHOLDERS_GET;
23491f1d 3064 PERL_UNUSED_CONTEXT;
7918f24d 3065
ca732855
NC
3066 return mg ? mg->mg_len : 0;
3067}
3068
3069void
ac1e784a 3070Perl_hv_placeholders_set(pTHX_ HV *hv, I32 ph)
ca732855 3071{
ad64d0ec 3072 MAGIC * const mg = mg_find((const SV *)hv, PERL_MAGIC_rhash);
ca732855 3073
7918f24d
NC
3074 PERL_ARGS_ASSERT_HV_PLACEHOLDERS_SET;
3075
ca732855
NC
3076 if (mg) {
3077 mg->mg_len = ph;
3078 } else if (ph) {
ad64d0ec 3079 if (!sv_magicext(MUTABLE_SV(hv), 0, PERL_MAGIC_rhash, 0, 0, ph))
ca732855
NC
3080 Perl_die(aTHX_ "panic: hv_placeholders_set");
3081 }
3082 /* else we don't need to add magic to record 0 placeholders. */
3083}
ecae49c0 3084
2a49f0f5 3085STATIC SV *
7b0bddfa
NC
3086S_refcounted_he_value(pTHX_ const struct refcounted_he *he)
3087{
0b2d3faa 3088 dVAR;
7b0bddfa 3089 SV *value;
7918f24d
NC
3090
3091 PERL_ARGS_ASSERT_REFCOUNTED_HE_VALUE;
3092
7b0bddfa
NC
3093 switch(he->refcounted_he_data[0] & HVrhek_typemask) {
3094 case HVrhek_undef:
3095 value = newSV(0);
3096 break;
3097 case HVrhek_delete:
3098 value = &PL_sv_placeholder;
3099 break;
3100 case HVrhek_IV:
44ebaf21
NC
3101 value = newSViv(he->refcounted_he_val.refcounted_he_u_iv);
3102 break;
3103 case HVrhek_UV:
3104 value = newSVuv(he->refcounted_he_val.refcounted_he_u_uv);
7b0bddfa
NC
3105 break;
3106 case HVrhek_PV:
44ebaf21 3107 case HVrhek_PV_UTF8:
7b0bddfa
NC
3108 /* Create a string SV that directly points to the bytes in our
3109 structure. */
b9f83d2f 3110 value = newSV_type(SVt_PV);
7b0bddfa
NC
3111 SvPV_set(value, (char *) he->refcounted_he_data + 1);
3112 SvCUR_set(value, he->refcounted_he_val.refcounted_he_u_len);
3113 /* This stops anything trying to free it */
3114 SvLEN_set(value, 0);
3115 SvPOK_on(value);
3116 SvREADONLY_on(value);
44ebaf21 3117 if ((he->refcounted_he_data[0] & HVrhek_typemask) == HVrhek_PV_UTF8)
7b0bddfa
NC
3118 SvUTF8_on(value);
3119 break;
3120 default:
20439bc7
Z
3121 Perl_croak(aTHX_ "panic: refcounted_he_value bad flags %"UVxf,
3122 (UV)he->refcounted_he_data[0]);
7b0bddfa
NC
3123 }
3124 return value;
3125}
3126
ecae49c0 3127/*
20439bc7 3128=for apidoc m|HV *|refcounted_he_chain_2hv|const struct refcounted_he *c|U32 flags
8dff4fc5 3129
20439bc7
Z
3130Generates and returns a C<HV *> representing the content of a
3131C<refcounted_he> chain.
2d7f6611 3132C<flags> is currently unused and must be zero.
8dff4fc5
BM
3133
3134=cut
3135*/
3136HV *
20439bc7 3137Perl_refcounted_he_chain_2hv(pTHX_ const struct refcounted_he *chain, U32 flags)
8dff4fc5 3138{
20439bc7
Z
3139 dVAR;
3140 HV *hv;
3141 U32 placeholders, max;
b3ca2e83 3142
20439bc7
Z
3143 if (flags)
3144 Perl_croak(aTHX_ "panic: refcounted_he_chain_2hv bad flags %"UVxf,
3145 (UV)flags);
b3ca2e83 3146
b3ca2e83
NC
3147 /* We could chase the chain once to get an idea of the number of keys,
3148 and call ksplit. But for now we'll make a potentially inefficient
3149 hash with only 8 entries in its array. */
20439bc7
Z
3150 hv = newHV();
3151 max = HvMAX(hv);
b3ca2e83
NC
3152 if (!HvARRAY(hv)) {
3153 char *array;
3154 Newxz(array, PERL_HV_ARRAY_ALLOC_BYTES(max + 1), char);
3155 HvARRAY(hv) = (HE**)array;
3156 }
3157
20439bc7 3158 placeholders = 0;
b3ca2e83 3159 while (chain) {
cbb1fbea 3160#ifdef USE_ITHREADS
b6bbf3fa 3161 U32 hash = chain->refcounted_he_hash;
cbb1fbea
NC
3162#else
3163 U32 hash = HEK_HASH(chain->refcounted_he_hek);
3164#endif
b3ca2e83
NC
3165 HE **oentry = &((HvARRAY(hv))[hash & max]);
3166 HE *entry = *oentry;
b6bbf3fa 3167 SV *value;
cbb1fbea 3168
b3ca2e83
NC
3169 for (; entry; entry = HeNEXT(entry)) {
3170 if (HeHASH(entry) == hash) {
9f769845
NC
3171 /* We might have a duplicate key here. If so, entry is older
3172 than the key we've already put in the hash, so if they are
3173 the same, skip adding entry. */
3174#ifdef USE_ITHREADS
3175 const STRLEN klen = HeKLEN(entry);
3176 const char *const key = HeKEY(entry);
3177 if (klen == chain->refcounted_he_keylen
3178 && (!!HeKUTF8(entry)
3179 == !!(chain->refcounted_he_data[0] & HVhek_UTF8))
3180 && memEQ(key, REF_HE_KEY(chain), klen))
3181 goto next_please;
3182#else
3183 if (HeKEY_hek(entry) == chain->refcounted_he_hek)
3184 goto next_please;
3185 if (HeKLEN(entry) == HEK_LEN(chain->refcounted_he_hek)
3186 && HeKUTF8(entry) == HEK_UTF8(chain->refcounted_he_hek)
3187 && memEQ(HeKEY(entry), HEK_KEY(chain->refcounted_he_hek),
3188 HeKLEN(entry)))
3189 goto next_please;
3190#endif
b3ca2e83
NC
3191 }
3192 }
3193 assert (!entry);
3194 entry = new_HE();
3195
cbb1fbea
NC
3196#ifdef USE_ITHREADS
3197 HeKEY_hek(entry)
7b0bddfa 3198 = share_hek_flags(REF_HE_KEY(chain),
b6bbf3fa
NC
3199 chain->refcounted_he_keylen,
3200 chain->refcounted_he_hash,
3201 (chain->refcounted_he_data[0]
3202 & (HVhek_UTF8|HVhek_WASUTF8)));
cbb1fbea 3203#else
71ad1b0c 3204 HeKEY_hek(entry) = share_hek_hek(chain->refcounted_he_hek);
cbb1fbea 3205#endif
7b0bddfa
NC
3206 value = refcounted_he_value(chain);
3207 if (value == &PL_sv_placeholder)
b3ca2e83 3208 placeholders++;
b6bbf3fa 3209 HeVAL(entry) = value;
b3ca2e83
NC
3210
3211 /* Link it into the chain. */
3212 HeNEXT(entry) = *oentry;
b3ca2e83
NC
3213 *oentry = entry;
3214
3215 HvTOTALKEYS(hv)++;
3216
3217 next_please:
71ad1b0c 3218 chain = chain->refcounted_he_next;
b3ca2e83
NC
3219 }
3220
3221 if (placeholders) {
3222 clear_placeholders(hv, placeholders);
3223 HvTOTALKEYS(hv) -= placeholders;
3224 }
3225
3226 /* We could check in the loop to see if we encounter any keys with key
3227 flags, but it's probably not worth it, as this per-hash flag is only
3228 really meant as an optimisation for things like Storable. */
3229 HvHASKFLAGS_on(hv);
def9038f 3230 DEBUG_A(Perl_hv_assert(aTHX_ hv));
b3ca2e83
NC
3231
3232 return hv;
3233}
3234
20439bc7
Z
3235/*
3236=for apidoc m|SV *|refcounted_he_fetch_pvn|const struct refcounted_he *chain|const char *keypv|STRLEN keylen|U32 hash|U32 flags
3237
3238Search along a C<refcounted_he> chain for an entry with the key specified
2d7f6611 3239by C<keypv> and C<keylen>. If C<flags> has the C<REFCOUNTED_HE_KEY_UTF8>
20439bc7 3240bit set, the key octets are interpreted as UTF-8, otherwise they
2d7f6611 3241are interpreted as Latin-1. C<hash> is a precomputed hash of the key
20439bc7
Z
3242string, or zero if it has not been precomputed. Returns a mortal scalar
3243representing the value associated with the key, or C<&PL_sv_placeholder>
3244if there is no value associated with the key.
3245
3246=cut
3247*/
3248
7b0bddfa 3249SV *
20439bc7
Z
3250Perl_refcounted_he_fetch_pvn(pTHX_ const struct refcounted_he *chain,
3251 const char *keypv, STRLEN keylen, U32 hash, U32 flags)
7b0bddfa 3252{
0b2d3faa 3253 dVAR;
20439bc7
Z
3254 U8 utf8_flag;
3255 PERL_ARGS_ASSERT_REFCOUNTED_HE_FETCH_PVN;
7b0bddfa 3256
94250aee 3257 if (flags & ~(REFCOUNTED_HE_KEY_UTF8|REFCOUNTED_HE_EXISTS))
20439bc7
Z
3258 Perl_croak(aTHX_ "panic: refcounted_he_fetch_pvn bad flags %"UVxf,
3259 (UV)flags);
3260 if (!chain)
71622e40 3261 goto ret;
20439bc7
Z
3262 if (flags & REFCOUNTED_HE_KEY_UTF8) {
3263 /* For searching purposes, canonicalise to Latin-1 where possible. */
3264 const char *keyend = keypv + keylen, *p;
3265 STRLEN nonascii_count = 0;
3266 for (p = keypv; p != keyend; p++) {
e8e5e5b3
KW
3267 if (! UTF8_IS_INVARIANT(*p)) {
3268 if (! UTF8_IS_NEXT_CHAR_DOWNGRADEABLE(p, keyend)) {
20439bc7 3269 goto canonicalised_key;
e8e5e5b3 3270 }
20439bc7 3271 nonascii_count++;
e8e5e5b3 3272 p++;
20439bc7 3273 }
cd1d2f8a 3274 }
20439bc7
Z
3275 if (nonascii_count) {
3276 char *q;
3277 const char *p = keypv, *keyend = keypv + keylen;
3278 keylen -= nonascii_count;
3279 Newx(q, keylen, char);
3280 SAVEFREEPV(q);
3281 keypv = q;
3282 for (; p != keyend; p++, q++) {
3283 U8 c = (U8)*p;
e8e5e5b3
KW
3284 if (UTF8_IS_INVARIANT(c)) {
3285 *q = (char) c;
3286 }
3287 else {
3288 p++;
a62b247b 3289 *q = (char) EIGHT_BIT_UTF8_TO_NATIVE(c, *p);
e8e5e5b3 3290 }
cd1d2f8a
NC
3291 }
3292 }
20439bc7
Z
3293 flags &= ~REFCOUNTED_HE_KEY_UTF8;
3294 canonicalised_key: ;
3295 }
3296 utf8_flag = (flags & REFCOUNTED_HE_KEY_UTF8) ? HVhek_UTF8 : 0;
3297 if (!hash)
3298 PERL_HASH(hash, keypv, keylen);
7b0bddfa 3299
20439bc7
Z
3300 for (; chain; chain = chain->refcounted_he_next) {
3301 if (
7b0bddfa 3302#ifdef USE_ITHREADS
20439bc7
Z
3303 hash == chain->refcounted_he_hash &&
3304 keylen == chain->refcounted_he_keylen &&
3305 memEQ(REF_HE_KEY(chain), keypv, keylen) &&
3306 utf8_flag == (chain->refcounted_he_data[0] & HVhek_UTF8)
7b0bddfa 3307#else
20439bc7
Z
3308 hash == HEK_HASH(chain->refcounted_he_hek) &&
3309 keylen == (STRLEN)HEK_LEN(chain->refcounted_he_hek) &&
3310 memEQ(HEK_KEY(chain->refcounted_he_hek), keypv, keylen) &&
3311 utf8_flag == (HEK_FLAGS(chain->refcounted_he_hek) & HVhek_UTF8)
7b0bddfa 3312#endif
ef8156f5
NC
3313 ) {
3314 if (flags & REFCOUNTED_HE_EXISTS)
3315 return (chain->refcounted_he_data[0] & HVrhek_typemask)
3316 == HVrhek_delete
3317 ? NULL : &PL_sv_yes;
3318 return sv_2mortal(refcounted_he_value(chain));
3319 }
94250aee 3320 }
71622e40 3321 ret:
94250aee 3322 return flags & REFCOUNTED_HE_EXISTS ? NULL : &PL_sv_placeholder;
20439bc7 3323}
7b0bddfa 3324
20439bc7
Z
3325/*
3326=for apidoc m|SV *|refcounted_he_fetch_pv|const struct refcounted_he *chain|const char *key|U32 hash|U32 flags
7b0bddfa 3327
20439bc7
Z
3328Like L</refcounted_he_fetch_pvn>, but takes a nul-terminated string
3329instead of a string/length pair.
3330
3331=cut
3332*/
3333
3334SV *
3335Perl_refcounted_he_fetch_pv(pTHX_ const struct refcounted_he *chain,
3336 const char *key, U32 hash, U32 flags)
3337{
3338 PERL_ARGS_ASSERT_REFCOUNTED_HE_FETCH_PV;
3339 return refcounted_he_fetch_pvn(chain, key, strlen(key), hash, flags);
7b0bddfa
NC
3340}
3341
b3ca2e83 3342/*
20439bc7
Z
3343=for apidoc m|SV *|refcounted_he_fetch_sv|const struct refcounted_he *chain|SV *key|U32 hash|U32 flags
3344
3345Like L</refcounted_he_fetch_pvn>, but takes a Perl scalar instead of a
3346string/length pair.
3347
3348=cut
3349*/
b3ca2e83 3350
20439bc7
Z
3351SV *
3352Perl_refcounted_he_fetch_sv(pTHX_ const struct refcounted_he *chain,
3353 SV *key, U32 hash, U32 flags)
3354{
3355 const char *keypv;
3356 STRLEN keylen;
3357 PERL_ARGS_ASSERT_REFCOUNTED_HE_FETCH_SV;
3358 if (flags & REFCOUNTED_HE_KEY_UTF8)
3359 Perl_croak(aTHX_ "panic: refcounted_he_fetch_sv bad flags %"UVxf,
3360 (UV)flags);
3361 keypv = SvPV_const(key, keylen);
3362 if (SvUTF8(key))
3363 flags |= REFCOUNTED_HE_KEY_UTF8;
3364 if (!hash && SvIsCOW_shared_hash(key))
3365 hash = SvSHARED_HASH(key);
3366 return refcounted_he_fetch_pvn(chain, keypv, keylen, hash, flags);
3367}
3368
3369/*
3370=for apidoc m|struct refcounted_he *|refcounted_he_new_pvn|struct refcounted_he *parent|const char *keypv|STRLEN keylen|U32 hash|SV *value|U32 flags
3371
3372Creates a new C<refcounted_he>. This consists of a single key/value
3373pair and a reference to an existing C<refcounted_he> chain (which may
3374be empty), and thus forms a longer chain. When using the longer chain,
3375the new key/value pair takes precedence over any entry for the same key
3376further along the chain.
3377
2d7f6611 3378The new key is specified by C<keypv> and C<keylen>. If C<flags> has
20439bc7 3379the C<REFCOUNTED_HE_KEY_UTF8> bit set, the key octets are interpreted
2d7f6611 3380as UTF-8, otherwise they are interpreted as Latin-1. C<hash> is
20439bc7
Z
3381a precomputed hash of the key string, or zero if it has not been
3382precomputed.
3383
2d7f6611 3384C<value> is the scalar value to store for this key. C<value> is copied
20439bc7
Z
3385by this function, which thus does not take ownership of any reference
3386to it, and later changes to the scalar will not be reflected in the
3387value visible in the C<refcounted_he>. Complex types of scalar will not
3388be stored with referential integrity, but will be coerced to strings.
2d7f6611 3389C<value> may be either null or C<&PL_sv_placeholder> to indicate that no
20439bc7
Z
3390value is to be associated with the key; this, as with any non-null value,
3391takes precedence over the existence of a value for the key further along
3392the chain.
3393
2d7f6611 3394C<parent> points to the rest of the C<refcounted_he> chain to be
20439bc7 3395attached to the new C<refcounted_he>. This function takes ownership
2d7f6611 3396of one reference to C<parent>, and returns one reference to the new
20439bc7 3397C<refcounted_he>.
b3ca2e83
NC
3398
3399=cut
3400*/
3401
3402struct refcounted_he *
20439bc7
Z
3403Perl_refcounted_he_new_pvn(pTHX_ struct refcounted_he *parent,
3404 const char *keypv, STRLEN keylen, U32 hash, SV *value, U32 flags)
3405{
7a89be66 3406 dVAR;
b6bbf3fa 3407 STRLEN value_len = 0;
95b63a38 3408 const char *value_p = NULL;
20439bc7 3409 bool is_pv;
b6bbf3fa 3410 char value_type;
20439bc7
Z
3411 char hekflags;
3412 STRLEN key_offset = 1;
3413 struct refcounted_he *he;
3414 PERL_ARGS_ASSERT_REFCOUNTED_HE_NEW_PVN;
b6bbf3fa 3415
20439bc7
Z
3416 if (!value || value == &PL_sv_placeholder) {
3417 value_type = HVrhek_delete;
3418 } else if (SvPOK(value)) {
b6bbf3fa
NC
3419 value_type = HVrhek_PV;
3420 } else if (SvIOK(value)) {
ad64d0ec 3421 value_type = SvUOK((const SV *)value) ? HVrhek_UV : HVrhek_IV;
b6bbf3fa
NC
3422 } else if (!SvOK(value)) {
3423 value_type = HVrhek_undef;
3424 } else {
3425 value_type = HVrhek_PV;
3426 }
20439bc7
Z
3427 is_pv = value_type == HVrhek_PV;
3428 if (is_pv) {
012da8e5
NC
3429 /* Do it this way so that the SvUTF8() test is after the SvPV, in case
3430 the value is overloaded, and doesn't yet have the UTF-8flag set. */
b6bbf3fa 3431 value_p = SvPV_const(value, value_len);
012da8e5
NC
3432 if (SvUTF8(value))
3433 value_type = HVrhek_PV_UTF8;
20439bc7
Z
3434 key_offset = value_len + 2;
3435 }
3436 hekflags = value_type;
3437
3438 if (flags & REFCOUNTED_HE_KEY_UTF8) {
3439 /* Canonicalise to Latin-1 where possible. */
3440 const char *keyend = keypv + keylen, *p;
3441 STRLEN nonascii_count = 0;
3442 for (p = keypv; p != keyend; p++) {
e8e5e5b3
KW
3443 if (! UTF8_IS_INVARIANT(*p)) {
3444 if (! UTF8_IS_NEXT_CHAR_DOWNGRADEABLE(p, keyend)) {
20439bc7 3445 goto canonicalised_key;
e8e5e5b3 3446 }
20439bc7 3447 nonascii_count++;
e8e5e5b3 3448 p++;
20439bc7
Z
3449 }
3450 }
3451 if (nonascii_count) {
3452 char *q;
3453 const char *p = keypv, *keyend = keypv + keylen;
3454 keylen -= nonascii_count;
3455 Newx(q, keylen, char);
3456 SAVEFREEPV(q);
3457 keypv = q;
3458 for (; p != keyend; p++, q++) {
3459 U8 c = (U8)*p;
e8e5e5b3
KW
3460 if (UTF8_IS_INVARIANT(c)) {
3461 *q = (char) c;
3462 }
3463 else {
3464 p++;
a62b247b 3465 *q = (char) EIGHT_BIT_UTF8_TO_NATIVE(c, *p);
e8e5e5b3 3466 }
20439bc7
Z
3467 }
3468 }
3469 flags &= ~REFCOUNTED_HE_KEY_UTF8;
3470 canonicalised_key: ;
b6bbf3fa 3471 }
20439bc7
Z
3472 if (flags & REFCOUNTED_HE_KEY_UTF8)
3473 hekflags |= HVhek_UTF8;
3474 if (!hash)
3475 PERL_HASH(hash, keypv, keylen);
012da8e5 3476
0de694c5 3477#ifdef USE_ITHREADS
10edeb5d
JH
3478 he = (struct refcounted_he*)
3479 PerlMemShared_malloc(sizeof(struct refcounted_he) - 1
20439bc7 3480 + keylen
20439bc7 3481 + key_offset);
0de694c5
NC
3482#else
3483 he = (struct refcounted_he*)
3484 PerlMemShared_malloc(sizeof(struct refcounted_he) - 1
3485 + key_offset);
3486#endif
b3ca2e83 3487
71ad1b0c 3488 he->refcounted_he_next = parent;
b6bbf3fa 3489
012da8e5 3490 if (is_pv) {
20439bc7 3491 Copy(value_p, he->refcounted_he_data + 1, value_len + 1, char);
b6bbf3fa 3492 he->refcounted_he_val.refcounted_he_u_len = value_len;
b6bbf3fa 3493 } else if (value_type == HVrhek_IV) {
20439bc7 3494 he->refcounted_he_val.refcounted_he_u_iv = SvIVX(value);
012da8e5 3495 } else if (value_type == HVrhek_UV) {
20439bc7 3496 he->refcounted_he_val.refcounted_he_u_uv = SvUVX(value);
b6bbf3fa
NC
3497 }
3498
cbb1fbea 3499#ifdef USE_ITHREADS
b6bbf3fa 3500 he->refcounted_he_hash = hash;
20439bc7
Z
3501 he->refcounted_he_keylen = keylen;
3502 Copy(keypv, he->refcounted_he_data + key_offset, keylen, char);
cbb1fbea 3503#else
20439bc7 3504 he->refcounted_he_hek = share_hek_flags(keypv, keylen, hash, hekflags);
cbb1fbea 3505#endif
b6bbf3fa 3506
20439bc7 3507 he->refcounted_he_data[0] = hekflags;
b3ca2e83
NC
3508 he->refcounted_he_refcnt = 1;
3509
3510 return he;
3511}
3512
3513/*
20439bc7 3514=for apidoc m|struct refcounted_he *|refcounted_he_new_pv|struct refcounted_he *parent|const char *key|U32 hash|SV *value|U32 flags
b3ca2e83 3515
20439bc7
Z
3516Like L</refcounted_he_new_pvn>, but takes a nul-terminated string instead
3517of a string/length pair.
3518
3519=cut
3520*/
3521
3522struct refcounted_he *
3523Perl_refcounted_he_new_pv(pTHX_ struct refcounted_he *parent,
3524 const char *key, U32 hash, SV *value, U32 flags)
3525{
3526 PERL_ARGS_ASSERT_REFCOUNTED_HE_NEW_PV;
3527 return refcounted_he_new_pvn(parent, key, strlen(key), hash, value, flags);
3528}
3529
3530/*
3531=for apidoc m|struct refcounted_he *|refcounted_he_new_sv|struct refcounted_he *parent|SV *key|U32 hash|SV *value|U32 flags
3532
3533Like L</refcounted_he_new_pvn>, but takes a Perl scalar instead of a
3534string/length pair.
3535
3536=cut
3537*/
3538
3539struct refcounted_he *
3540Perl_refcounted_he_new_sv(pTHX_ struct refcounted_he *parent,
3541 SV *key, U32 hash, SV *value, U32 flags)
3542{
3543 const char *keypv;
3544 STRLEN keylen;
3545 PERL_ARGS_ASSERT_REFCOUNTED_HE_NEW_SV;
3546 if (flags & REFCOUNTED_HE_KEY_UTF8)
3547 Perl_croak(aTHX_ "panic: refcounted_he_new_sv bad flags %"UVxf,
3548 (UV)flags);
3549 keypv = SvPV_const(key, keylen);
3550 if (SvUTF8(key))
3551 flags |= REFCOUNTED_HE_KEY_UTF8;
3552 if (!hash && SvIsCOW_shared_hash(key))
3553 hash = SvSHARED_HASH(key);
3554 return refcounted_he_new_pvn(parent, keypv, keylen, hash, value, flags);
3555}
3556
3557/*
3558=for apidoc m|void|refcounted_he_free|struct refcounted_he *he
3559
3560Decrements the reference count of a C<refcounted_he> by one. If the
3561reference count reaches zero the structure's memory is freed, which
3562(recursively) causes a reduction of its parent C<refcounted_he>'s
3563reference count. It is safe to pass a null pointer to this function:
3564no action occurs in this case.
b3ca2e83
NC
3565
3566=cut
3567*/
3568
3569void
3570Perl_refcounted_he_free(pTHX_ struct refcounted_he *he) {
20b7effb 3571#ifdef USE_ITHREADS
53d44271 3572 dVAR;
20b7effb 3573#endif
57ca3b03
AL
3574 PERL_UNUSED_CONTEXT;
3575
b3ca2e83
NC
3576 while (he) {
3577 struct refcounted_he *copy;
cbb1fbea 3578