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