This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Allow COW values to be deleted from restricted hashes
[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 }
e5accad2
FC
1006 if (SvREADONLY(hv) && HeVAL(entry) && SvREADONLY(HeVAL(entry))
1007 && !SvIsCOW(HeVAL(entry))) {
d4c19fe8 1008 hv_notallowed(k_flags, key, klen,
c8cd6465
NC
1009 "Attempt to delete readonly key '%"SVf"' from"
1010 " a restricted hash");
8aacddc1 1011 }
b84d0860
NC
1012 if (k_flags & HVhek_FREEKEY)
1013 Safefree(key);
8aacddc1 1014
35759254 1015 /* If this is a stash and the key ends with ::, then someone is
0c3bb3c2 1016 * deleting a package.
0c3bb3c2 1017 */
78b79c77 1018 if (HeVAL(entry) && HvENAME_get(hv)) {
0290c710 1019 gv = (GV *)HeVAL(entry);
35759254 1020 if (keysv) key = SvPV(keysv, klen);
1f656fcf
FC
1021 if ((
1022 (klen > 1 && key[klen-2] == ':' && key[klen-1] == ':')
1023 ||
1024 (klen == 1 && key[0] == ':')
1025 )
e0a52395 1026 && (klen != 6 || hv!=PL_defstash || memNE(key,"main::",6))
0290c710 1027 && SvTYPE(gv) == SVt_PVGV && (stash = GvHV((GV *)gv))
0c3bb3c2 1028 && HvENAME_get(stash)) {
0290c710
FC
1029 /* A previous version of this code checked that the
1030 * GV was still in the symbol table by fetching the
1031 * GV with its name. That is not necessary (and
1032 * sometimes incorrect), as HvENAME cannot be set
1033 * on hv if it is not in the symtab. */
f3d2f32d 1034 mro_changes = 2;
0c3bb3c2
FC
1035 /* Hang on to it for a bit. */
1036 SvREFCNT_inc_simple_void_NN(
0290c710 1037 sv_2mortal((SV *)gv)
35759254
FC
1038 );
1039 }
f3d2f32d
FC
1040 else if (klen == 3 && strnEQ(key, "ISA", 3))
1041 mro_changes = 1;
35759254
FC
1042 }
1043
f50383f5
TH
1044 if (d_flags & G_DISCARD) {
1045 sv = HeVAL(entry);
1046 if (sv) {
1047 /* deletion of method from stash */
1048 if (isGV(sv) && isGV_with_GP(sv) && GvCVu(sv)
1049 && HvENAME_get(hv))
1050 mro_method_changed_in(hv);
1051 SvREFCNT_dec(sv);
1052 sv = NULL;
1053 }
1054 } else sv = sv_2mortal(HeVAL(entry));
1055 HeVAL(entry) = &PL_sv_placeholder;
8aacddc1
NIS
1056
1057 /*
1058 * If a restricted hash, rather than really deleting the entry, put
1059 * a placeholder there. This marks the key as being "approved", so
1060 * we can still access via not-really-existing key without raising
1061 * an error.
1062 */
f50383f5 1063 if (SvREADONLY(hv))
8aacddc1
NIS
1064 /* We'll be saving this slot, so the number of allocated keys
1065 * doesn't go down, but the number placeholders goes up */
ca732855 1066 HvPLACEHOLDERS(hv)++;
f50383f5 1067 else {
a26e96df 1068 *oentry = HeNEXT(entry);
b79f7545 1069 if (SvOOK(hv) && entry == HvAUX(hv)->xhv_eiter /* HvEITER(hv) */)
8aacddc1 1070 HvLAZYDEL_on(hv);
ae199939
TH
1071 else {
1072 if (SvOOK(hv) && HvLAZYDEL(hv) &&
1073 entry == HeNEXT(HvAUX(hv)->xhv_eiter))
1074 HeNEXT(HvAUX(hv)->xhv_eiter) = HeNEXT(entry);
8aacddc1 1075 hv_free_ent(hv, entry);
ae199939 1076 }
4c7185a0 1077 xhv->xhv_keys--; /* HvTOTALKEYS(hv)-- */
574c8022 1078 if (xhv->xhv_keys == 0)
19692e8d 1079 HvHASKFLAGS_off(hv);
8aacddc1 1080 }
0c3bb3c2 1081
f3d2f32d
FC
1082 if (mro_changes == 1) mro_isa_changed_in(hv);
1083 else if (mro_changes == 2)
afdbe55d 1084 mro_package_moved(NULL, stash, gv, 1);
0c3bb3c2 1085
79072805
LW
1086 return sv;
1087 }
8aacddc1 1088 if (SvREADONLY(hv)) {
d4c19fe8 1089 hv_notallowed(k_flags, key, klen,
c8cd6465
NC
1090 "Attempt to delete disallowed key '%"SVf"' from"
1091 " a restricted hash");
8aacddc1
NIS
1092 }
1093
19692e8d 1094 if (k_flags & HVhek_FREEKEY)
f9a63242 1095 Safefree(key);
a0714e2c 1096 return NULL;
79072805
LW
1097}
1098
76e3520e 1099STATIC void
cea2e8a9 1100S_hsplit(pTHX_ HV *hv)
79072805 1101{
97aff369 1102 dVAR;
1e05feb3 1103 register XPVHV* const xhv = (XPVHV*)SvANY(hv);
a3b680e6 1104 const I32 oldsize = (I32) xhv->xhv_max+1; /* HvMAX(hv)+1 (sick) */
79072805
LW
1105 register I32 newsize = oldsize * 2;
1106 register I32 i;
7b2c381c 1107 char *a = (char*) HvARRAY(hv);
72311751 1108 register HE **aep;
4b5190b5
NC
1109 int longest_chain = 0;
1110 int was_shared;
79072805 1111
7918f24d
NC
1112 PERL_ARGS_ASSERT_HSPLIT;
1113
18026298 1114 /*PerlIO_printf(PerlIO_stderr(), "hsplit called for %p which had %d\n",
6c9570dc 1115 (void*)hv, (int) oldsize);*/
18026298 1116
5d88ecd7 1117 if (HvPLACEHOLDERS_get(hv) && !SvREADONLY(hv)) {
18026298
NC
1118 /* Can make this clear any placeholders first for non-restricted hashes,
1119 even though Storable rebuilds restricted hashes by putting in all the
1120 placeholders (first) before turning on the readonly flag, because
1121 Storable always pre-splits the hash. */
1122 hv_clear_placeholders(hv);
1123 }
1124
3280af22 1125 PL_nomemok = TRUE;
8d6dde3e 1126#if defined(STRANGE_MALLOC) || defined(MYMALLOC)
b79f7545
NC
1127 Renew(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1128 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
422a93e5 1129 if (!a) {
4a33f861 1130 PL_nomemok = FALSE;
422a93e5
GA
1131 return;
1132 }
b79f7545 1133 if (SvOOK(hv)) {
31f0e52e 1134 Move(&a[oldsize * sizeof(HE*)], &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
b79f7545 1135 }
4633a7c4 1136#else
a02a5408 1137 Newx(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
b79f7545 1138 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
422a93e5 1139 if (!a) {
3280af22 1140 PL_nomemok = FALSE;
422a93e5
GA
1141 return;
1142 }
7b2c381c 1143 Copy(HvARRAY(hv), a, oldsize * sizeof(HE*), char);
b79f7545
NC
1144 if (SvOOK(hv)) {
1145 Copy(HvAUX(hv), &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
1146 }
9a87bd09 1147 Safefree(HvARRAY(hv));
4633a7c4
LW
1148#endif
1149
3280af22 1150 PL_nomemok = FALSE;
72311751 1151 Zero(&a[oldsize * sizeof(HE*)], (newsize-oldsize) * sizeof(HE*), char); /* zero 2nd half*/
cbec9347 1152 xhv->xhv_max = --newsize; /* HvMAX(hv) = --newsize */
7b2c381c 1153 HvARRAY(hv) = (HE**) a;
72311751 1154 aep = (HE**)a;
79072805 1155
72311751 1156 for (i=0; i<oldsize; i++,aep++) {
4b5190b5
NC
1157 int left_length = 0;
1158 int right_length = 0;
a50a3493
NC
1159 HE **oentry = aep;
1160 HE *entry = *aep;
a3b680e6 1161 register HE **bep;
4b5190b5 1162
a50a3493 1163 if (!entry) /* non-existent */
79072805 1164 continue;
72311751 1165 bep = aep+oldsize;
4c9d89c5 1166 do {
eb160463 1167 if ((HeHASH(entry) & newsize) != (U32)i) {
fde52b5c 1168 *oentry = HeNEXT(entry);
72311751 1169 HeNEXT(entry) = *bep;
72311751 1170 *bep = entry;
4b5190b5 1171 right_length++;
79072805 1172 }
4b5190b5 1173 else {
fde52b5c 1174 oentry = &HeNEXT(entry);
4b5190b5
NC
1175 left_length++;
1176 }
4c9d89c5
NC
1177 entry = *oentry;
1178 } while (entry);
4b5190b5
NC
1179 /* I think we don't actually need to keep track of the longest length,
1180 merely flag if anything is too long. But for the moment while
1181 developing this code I'll track it. */
1182 if (left_length > longest_chain)
1183 longest_chain = left_length;
1184 if (right_length > longest_chain)
1185 longest_chain = right_length;
1186 }
1187
1188
1189 /* Pick your policy for "hashing isn't working" here: */
fdcd69b6 1190 if (longest_chain <= HV_MAX_LENGTH_BEFORE_SPLIT /* split worked? */
4b5190b5
NC
1191 || HvREHASH(hv)) {
1192 return;
79072805 1193 }
4b5190b5
NC
1194
1195 if (hv == PL_strtab) {
1196 /* Urg. Someone is doing something nasty to the string table.
1197 Can't win. */
1198 return;
1199 }
1200
1201 /* Awooga. Awooga. Pathological data. */
6c9570dc 1202 /*PerlIO_printf(PerlIO_stderr(), "%p %d of %d with %d/%d buckets\n", (void*)hv,
4b5190b5
NC
1203 longest_chain, HvTOTALKEYS(hv), HvFILL(hv), 1+HvMAX(hv));*/
1204
1205 ++newsize;
a02a5408 1206 Newxz(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
b79f7545
NC
1207 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
1208 if (SvOOK(hv)) {
1209 Copy(HvAUX(hv), &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
1210 }
1211
4b5190b5
NC
1212 was_shared = HvSHAREKEYS(hv);
1213
4b5190b5
NC
1214 HvSHAREKEYS_off(hv);
1215 HvREHASH_on(hv);
1216
7b2c381c 1217 aep = HvARRAY(hv);
4b5190b5
NC
1218
1219 for (i=0; i<newsize; i++,aep++) {
a3b680e6 1220 register HE *entry = *aep;
4b5190b5
NC
1221 while (entry) {
1222 /* We're going to trash this HE's next pointer when we chain it
1223 into the new hash below, so store where we go next. */
9d4ba2ae 1224 HE * const next = HeNEXT(entry);
4b5190b5 1225 UV hash;
a3b680e6 1226 HE **bep;
4b5190b5
NC
1227
1228 /* Rehash it */
1229 PERL_HASH_INTERNAL(hash, HeKEY(entry), HeKLEN(entry));
1230
1231 if (was_shared) {
1232 /* Unshare it. */
aec46f14 1233 HEK * const new_hek
4b5190b5
NC
1234 = save_hek_flags(HeKEY(entry), HeKLEN(entry),
1235 hash, HeKFLAGS(entry));
1236 unshare_hek (HeKEY_hek(entry));
1237 HeKEY_hek(entry) = new_hek;
1238 } else {
1239 /* Not shared, so simply write the new hash in. */
1240 HeHASH(entry) = hash;
1241 }
1242 /*PerlIO_printf(PerlIO_stderr(), "%d ", HeKFLAGS(entry));*/
1243 HEK_REHASH_on(HeKEY_hek(entry));
1244 /*PerlIO_printf(PerlIO_stderr(), "%d\n", HeKFLAGS(entry));*/
1245
1246 /* Copy oentry to the correct new chain. */
1247 bep = ((HE**)a) + (hash & (I32) xhv->xhv_max);
4b5190b5
NC
1248 HeNEXT(entry) = *bep;
1249 *bep = entry;
1250
1251 entry = next;
1252 }
1253 }
7b2c381c
NC
1254 Safefree (HvARRAY(hv));
1255 HvARRAY(hv) = (HE **)a;
79072805
LW
1256}
1257
72940dca 1258void
864dbfa3 1259Perl_hv_ksplit(pTHX_ HV *hv, IV newmax)
72940dca 1260{
97aff369 1261 dVAR;
cbec9347 1262 register XPVHV* xhv = (XPVHV*)SvANY(hv);
a3b680e6 1263 const I32 oldsize = (I32) xhv->xhv_max+1; /* HvMAX(hv)+1 (sick) */
72940dca
PP
1264 register I32 newsize;
1265 register I32 i;
72311751
GS
1266 register char *a;
1267 register HE **aep;
72940dca 1268
7918f24d
NC
1269 PERL_ARGS_ASSERT_HV_KSPLIT;
1270
72940dca
PP
1271 newsize = (I32) newmax; /* possible truncation here */
1272 if (newsize != newmax || newmax <= oldsize)
1273 return;
1274 while ((newsize & (1 + ~newsize)) != newsize) {
1275 newsize &= ~(newsize & (1 + ~newsize)); /* get proper power of 2 */
1276 }
1277 if (newsize < newmax)
1278 newsize *= 2;
1279 if (newsize < newmax)
1280 return; /* overflow detection */
1281
7b2c381c 1282 a = (char *) HvARRAY(hv);
72940dca 1283 if (a) {
3280af22 1284 PL_nomemok = TRUE;
8d6dde3e 1285#if defined(STRANGE_MALLOC) || defined(MYMALLOC)
b79f7545
NC
1286 Renew(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1287 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
8aacddc1 1288 if (!a) {
4a33f861 1289 PL_nomemok = FALSE;
422a93e5
GA
1290 return;
1291 }
b79f7545 1292 if (SvOOK(hv)) {
7a9b70e9 1293 Copy(&a[oldsize * sizeof(HE*)], &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
b79f7545 1294 }
72940dca 1295#else
a02a5408 1296 Newx(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
b79f7545 1297 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
8aacddc1 1298 if (!a) {
3280af22 1299 PL_nomemok = FALSE;
422a93e5
GA
1300 return;
1301 }
7b2c381c 1302 Copy(HvARRAY(hv), a, oldsize * sizeof(HE*), char);
b79f7545
NC
1303 if (SvOOK(hv)) {
1304 Copy(HvAUX(hv), &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
1305 }
9a87bd09 1306 Safefree(HvARRAY(hv));
72940dca 1307#endif
3280af22 1308 PL_nomemok = FALSE;
72311751 1309 Zero(&a[oldsize * sizeof(HE*)], (newsize-oldsize) * sizeof(HE*), char); /* zero 2nd half*/
72940dca
PP
1310 }
1311 else {
a02a5408 1312 Newxz(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize), char);
72940dca 1313 }
cbec9347 1314 xhv->xhv_max = --newsize; /* HvMAX(hv) = --newsize */
7b2c381c 1315 HvARRAY(hv) = (HE **) a;
f4431c56 1316 if (!xhv->xhv_keys /* !HvTOTALKEYS(hv) */) /* skip rest if no entries */
72940dca
PP
1317 return;
1318
72311751
GS
1319 aep = (HE**)a;
1320 for (i=0; i<oldsize; i++,aep++) {
a50a3493
NC
1321 HE **oentry = aep;
1322 HE *entry = *aep;
1323
1324 if (!entry) /* non-existent */
72940dca 1325 continue;
4c9d89c5 1326 do {
6136c704
AL
1327 register I32 j = (HeHASH(entry) & newsize);
1328
1329 if (j != i) {
72940dca
PP
1330 j -= i;
1331 *oentry = HeNEXT(entry);
4d0fbddd 1332 HeNEXT(entry) = aep[j];
72311751 1333 aep[j] = entry;
72940dca
PP
1334 }
1335 else
1336 oentry = &HeNEXT(entry);
4c9d89c5
NC
1337 entry = *oentry;
1338 } while (entry);
72940dca
PP
1339 }
1340}
1341
b3ac6de7 1342HV *
864dbfa3 1343Perl_newHVhv(pTHX_ HV *ohv)
b3ac6de7 1344{
749123ff 1345 dVAR;
9d4ba2ae 1346 HV * const hv = newHV();
f4431c56 1347 STRLEN hv_max;
4beac62f 1348
f4431c56 1349 if (!ohv || !HvTOTALKEYS(ohv))
4beac62f 1350 return hv;
4beac62f 1351 hv_max = HvMAX(ohv);
b3ac6de7 1352
ad64d0ec 1353 if (!SvMAGICAL((const SV *)ohv)) {
b56ba0bf 1354 /* It's an ordinary hash, so copy it fast. AMS 20010804 */
eb160463 1355 STRLEN i;
a3b680e6 1356 const bool shared = !!HvSHAREKEYS(ohv);
aec46f14 1357 HE **ents, ** const oents = (HE **)HvARRAY(ohv);
ff875642 1358 char *a;
a02a5408 1359 Newx(a, PERL_HV_ARRAY_ALLOC_BYTES(hv_max+1), char);
ff875642 1360 ents = (HE**)a;
b56ba0bf
AMS
1361
1362 /* In each bucket... */
1363 for (i = 0; i <= hv_max; i++) {
6136c704 1364 HE *prev = NULL;
aec46f14 1365 HE *oent = oents[i];
b56ba0bf
AMS
1366
1367 if (!oent) {
1368 ents[i] = NULL;
1369 continue;
1370 }
1371
1372 /* Copy the linked list of entries. */
aec46f14 1373 for (; oent; oent = HeNEXT(oent)) {
a3b680e6
AL
1374 const U32 hash = HeHASH(oent);
1375 const char * const key = HeKEY(oent);
1376 const STRLEN len = HeKLEN(oent);
1377 const int flags = HeKFLAGS(oent);
6136c704 1378 HE * const ent = new_HE();
c3acb9e0 1379 SV *const val = HeVAL(oent);
b56ba0bf 1380
c3acb9e0 1381 HeVAL(ent) = SvIMMORTAL(val) ? val : newSVsv(val);
19692e8d 1382 HeKEY_hek(ent)
6e838c70 1383 = shared ? share_hek_flags(key, len, hash, flags)
19692e8d 1384 : save_hek_flags(key, len, hash, flags);
b56ba0bf
AMS
1385 if (prev)
1386 HeNEXT(prev) = ent;
1387 else
1388 ents[i] = ent;
1389 prev = ent;
1390 HeNEXT(ent) = NULL;
1391 }
1392 }
1393
1394 HvMAX(hv) = hv_max;
8aacddc1 1395 HvTOTALKEYS(hv) = HvTOTALKEYS(ohv);
b56ba0bf 1396 HvARRAY(hv) = ents;
aec46f14 1397 } /* not magical */
b56ba0bf
AMS
1398 else {
1399 /* Iterate over ohv, copying keys and values one at a time. */
b3ac6de7 1400 HE *entry;
bfcb3514
NC
1401 const I32 riter = HvRITER_get(ohv);
1402 HE * const eiter = HvEITER_get(ohv);
f4431c56 1403 STRLEN hv_fill = HvFILL(ohv);
b56ba0bf
AMS
1404
1405 /* Can we use fewer buckets? (hv_max is always 2^n-1) */
1406 while (hv_max && hv_max + 1 >= hv_fill * 2)
1407 hv_max = hv_max / 2;
1408 HvMAX(hv) = hv_max;
1409
4a76a316 1410 hv_iterinit(ohv);
e16e2ff8 1411 while ((entry = hv_iternext_flags(ohv, 0))) {
c3acb9e0 1412 SV *const val = HeVAL(entry);
04fe65b0 1413 (void)hv_store_flags(hv, HeKEY(entry), HeKLEN(entry),
c3acb9e0
NC
1414 SvIMMORTAL(val) ? val : newSVsv(val),
1415 HeHASH(entry), HeKFLAGS(entry));
b3ac6de7 1416 }
bfcb3514
NC
1417 HvRITER_set(ohv, riter);
1418 HvEITER_set(ohv, eiter);
b3ac6de7 1419 }
1c846c1f 1420
b3ac6de7
IZ
1421 return hv;
1422}
1423
defdfed5
Z
1424/*
1425=for apidoc Am|HV *|hv_copy_hints_hv|HV *ohv
1426
1427A specialised version of L</newHVhv> for copying C<%^H>. I<ohv> must be
1428a pointer to a hash (which may have C<%^H> magic, but should be generally
1429non-magical), or C<NULL> (interpreted as an empty hash). The content
1430of I<ohv> is copied to a new hash, which has the C<%^H>-specific magic
1431added to it. A pointer to the new hash is returned.
1432
1433=cut
1434*/
1435
5b9c0671
NC
1436HV *
1437Perl_hv_copy_hints_hv(pTHX_ HV *const ohv)
1438{
1439 HV * const hv = newHV();
5b9c0671 1440
f4431c56 1441 if (ohv && HvTOTALKEYS(ohv)) {
5b9c0671 1442 STRLEN hv_max = HvMAX(ohv);
f4431c56 1443 STRLEN hv_fill = HvFILL(ohv);
5b9c0671
NC
1444 HE *entry;
1445 const I32 riter = HvRITER_get(ohv);
1446 HE * const eiter = HvEITER_get(ohv);
1447
1448 while (hv_max && hv_max + 1 >= hv_fill * 2)
1449 hv_max = hv_max / 2;
1450 HvMAX(hv) = hv_max;
1451
1452 hv_iterinit(ohv);
1453 while ((entry = hv_iternext_flags(ohv, 0))) {
1454 SV *const sv = newSVsv(HeVAL(entry));
e3b1b6b1 1455 SV *heksv = newSVhek(HeKEY_hek(entry));
5b9c0671 1456 sv_magic(sv, NULL, PERL_MAGIC_hintselem,
e3b1b6b1
RGS
1457 (char *)heksv, HEf_SVKEY);
1458 SvREFCNT_dec(heksv);
04fe65b0
RGS
1459 (void)hv_store_flags(hv, HeKEY(entry), HeKLEN(entry),
1460 sv, HeHASH(entry), HeKFLAGS(entry));
5b9c0671
NC
1461 }
1462 HvRITER_set(ohv, riter);
1463 HvEITER_set(ohv, eiter);
1464 }
1465 hv_magic(hv, NULL, PERL_MAGIC_hints);
1466 return hv;
1467}
1468
e0171a1a
DM
1469/* like hv_free_ent, but returns the SV rather than freeing it */
1470STATIC SV*
1471S_hv_free_ent_ret(pTHX_ HV *hv, register HE *entry)
79072805 1472{
97aff369 1473 dVAR;
16bdeea2
GS
1474 SV *val;
1475
e0171a1a 1476 PERL_ARGS_ASSERT_HV_FREE_ENT_RET;
7918f24d 1477
68dc0745 1478 if (!entry)
e0171a1a 1479 return NULL;
16bdeea2 1480 val = HeVAL(entry);
00169e2c 1481 if (val && isGV(val) && isGV_with_GP(val) && GvCVu(val) && HvENAME(hv))
803f2748 1482 mro_method_changed_in(hv); /* deletion of method from stash */
68dc0745
PP
1483 if (HeKLEN(entry) == HEf_SVKEY) {
1484 SvREFCNT_dec(HeKEY_sv(entry));
8aacddc1 1485 Safefree(HeKEY_hek(entry));
44a8e56a
PP
1486 }
1487 else if (HvSHAREKEYS(hv))
68dc0745 1488 unshare_hek(HeKEY_hek(entry));
fde52b5c 1489 else
68dc0745 1490 Safefree(HeKEY_hek(entry));
d33b2eba 1491 del_HE(entry);
e0171a1a
DM
1492 return val;
1493}
1494
1495
1496void
1497Perl_hv_free_ent(pTHX_ HV *hv, register HE *entry)
1498{
1499 dVAR;
1500 SV *val;
1501
1502 PERL_ARGS_ASSERT_HV_FREE_ENT;
1503
1504 if (!entry)
1505 return;
1506 val = hv_free_ent_ret(hv, entry);
272e8453 1507 SvREFCNT_dec(val);
79072805
LW
1508}
1509
f1c32fec 1510
79072805 1511void
864dbfa3 1512Perl_hv_delayfree_ent(pTHX_ HV *hv, register HE *entry)
79072805 1513{
97aff369 1514 dVAR;
7918f24d
NC
1515
1516 PERL_ARGS_ASSERT_HV_DELAYFREE_ENT;
1517
68dc0745 1518 if (!entry)
79072805 1519 return;
bc4947fc
NC
1520 /* SvREFCNT_inc to counter the SvREFCNT_dec in hv_free_ent */
1521 sv_2mortal(SvREFCNT_inc(HeVAL(entry))); /* free between statements */
68dc0745 1522 if (HeKLEN(entry) == HEf_SVKEY) {
bc4947fc 1523 sv_2mortal(SvREFCNT_inc(HeKEY_sv(entry)));
44a8e56a 1524 }
bc4947fc 1525 hv_free_ent(hv, entry);
79072805
LW
1526}
1527
954c1994
GS
1528/*
1529=for apidoc hv_clear
1530
c2217cd3
DM
1531Frees the all the elements of a hash, leaving it empty.
1532The XS equivalent of %hash = (). See also L</hv_undef>.
954c1994
GS
1533
1534=cut
1535*/
1536
79072805 1537void
864dbfa3 1538Perl_hv_clear(pTHX_ HV *hv)
79072805 1539{
27da23d5 1540 dVAR;
cbec9347 1541 register XPVHV* xhv;
79072805
LW
1542 if (!hv)
1543 return;
49293501 1544
ecae49c0
NC
1545 DEBUG_A(Perl_hv_assert(aTHX_ hv));
1546
34c3c4e3
DM
1547 xhv = (XPVHV*)SvANY(hv);
1548
7b2c381c 1549 if (SvREADONLY(hv) && HvARRAY(hv) != NULL) {
34c3c4e3 1550 /* restricted hash: convert all keys to placeholders */
b464bac0
AL
1551 STRLEN i;
1552 for (i = 0; i <= xhv->xhv_max; i++) {
7b2c381c 1553 HE *entry = (HvARRAY(hv))[i];
3a676441
JH
1554 for (; entry; entry = HeNEXT(entry)) {
1555 /* not already placeholder */
7996736c 1556 if (HeVAL(entry) != &PL_sv_placeholder) {
3a676441 1557 if (HeVAL(entry) && SvREADONLY(HeVAL(entry))) {
6136c704 1558 SV* const keysv = hv_iterkeysv(entry);
3a676441 1559 Perl_croak(aTHX_
95b63a38
JH
1560 "Attempt to delete readonly key '%"SVf"' from a restricted hash",
1561 (void*)keysv);
3a676441
JH
1562 }
1563 SvREFCNT_dec(HeVAL(entry));
7996736c 1564 HeVAL(entry) = &PL_sv_placeholder;
ca732855 1565 HvPLACEHOLDERS(hv)++;
3a676441 1566 }
34c3c4e3
DM
1567 }
1568 }
49293501 1569 }
afbbf215
DM
1570 else {
1571 hfreeentries(hv);
1572 HvPLACEHOLDERS_set(hv, 0);
49293501 1573
afbbf215
DM
1574 if (SvRMAGICAL(hv))
1575 mg_clear(MUTABLE_SV(hv));
574c8022 1576
afbbf215
DM
1577 HvHASKFLAGS_off(hv);
1578 HvREHASH_off(hv);
1579 }
b79f7545 1580 if (SvOOK(hv)) {
00169e2c 1581 if(HvENAME_get(hv))
dd69841b 1582 mro_isa_changed_in(hv);
bfcb3514
NC
1583 HvEITER_set(hv, NULL);
1584 }
79072805
LW
1585}
1586
3540d4ce
AB
1587/*
1588=for apidoc hv_clear_placeholders
1589
1590Clears any placeholders from a hash. If a restricted hash has any of its keys
1591marked as readonly and the key is subsequently deleted, the key is not actually
1592deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
1593it so it will be ignored by future operations such as iterating over the hash,
4cdaeff7 1594but will still allow the hash to have a value reassigned to the key at some
3540d4ce
AB
1595future point. This function clears any such placeholder keys from the hash.
1596See Hash::Util::lock_keys() for an example of its use.
1597
1598=cut
1599*/
1600
1601void
1602Perl_hv_clear_placeholders(pTHX_ HV *hv)
1603{
27da23d5 1604 dVAR;
b3ca2e83
NC
1605 const U32 items = (U32)HvPLACEHOLDERS_get(hv);
1606
7918f24d
NC
1607 PERL_ARGS_ASSERT_HV_CLEAR_PLACEHOLDERS;
1608
b3ca2e83
NC
1609 if (items)
1610 clear_placeholders(hv, items);
1611}
1612
1613static void
1614S_clear_placeholders(pTHX_ HV *hv, U32 items)
1615{
1616 dVAR;
b464bac0 1617 I32 i;
d3677389 1618
7918f24d
NC
1619 PERL_ARGS_ASSERT_CLEAR_PLACEHOLDERS;
1620
d3677389
NC
1621 if (items == 0)
1622 return;
1623
b464bac0 1624 i = HvMAX(hv);
d3677389
NC
1625 do {
1626 /* Loop down the linked list heads */
d3677389 1627 HE **oentry = &(HvARRAY(hv))[i];
cf6db12b 1628 HE *entry;
d3677389 1629
cf6db12b 1630 while ((entry = *oentry)) {
d3677389
NC
1631 if (HeVAL(entry) == &PL_sv_placeholder) {
1632 *oentry = HeNEXT(entry);
2e58978b 1633 if (entry == HvEITER_get(hv))
d3677389 1634 HvLAZYDEL_on(hv);
ae199939
TH
1635 else {
1636 if (SvOOK(hv) && HvLAZYDEL(hv) &&
1637 entry == HeNEXT(HvAUX(hv)->xhv_eiter))
1638 HeNEXT(HvAUX(hv)->xhv_eiter) = HeNEXT(entry);
d3677389 1639 hv_free_ent(hv, entry);
ae199939 1640 }
d3677389
NC
1641
1642 if (--items == 0) {
1643 /* Finished. */
5d88ecd7 1644 HvTOTALKEYS(hv) -= (IV)HvPLACEHOLDERS_get(hv);
1b95d04f 1645 if (HvUSEDKEYS(hv) == 0)
d3677389 1646 HvHASKFLAGS_off(hv);
5d88ecd7 1647 HvPLACEHOLDERS_set(hv, 0);
d3677389
NC
1648 return;
1649 }
213ce8b3
NC
1650 } else {
1651 oentry = &HeNEXT(entry);
d3677389
NC
1652 }
1653 }
1654 } while (--i >= 0);
1655 /* You can't get here, hence assertion should always fail. */
1656 assert (items == 0);
1657 assert (0);
3540d4ce
AB
1658}
1659
76e3520e 1660STATIC void
cea2e8a9 1661S_hfreeentries(pTHX_ HV *hv)
79072805 1662{
e0171a1a
DM
1663 STRLEN index = 0;
1664 SV* sv;
3abe233e 1665
7918f24d
NC
1666 PERL_ARGS_ASSERT_HFREEENTRIES;
1667
e0171a1a
DM
1668 while ( ((sv = Perl_hfree_next_entry(aTHX_ hv, &index))) ) {
1669 SvREFCNT_dec(sv);
1670 }
1671}
23976bdd 1672
b79f7545 1673
e0171a1a
DM
1674/* hfree_next_entry()
1675 * For use only by S_hfreeentries() and sv_clear().
1676 * Delete the next available HE from hv and return the associated SV.
1677 * Returns null on empty hash.
1678 * indexp is a pointer to the current index into HvARRAY. The index should
1679 * initially be set to 0. hfree_next_entry() may update it. */
1680
1681SV*
1682Perl_hfree_next_entry(pTHX_ HV *hv, STRLEN *indexp)
1683{
1684 struct xpvhv_aux *iter;
1685 HE *entry;
1686 HE ** array;
1687#ifdef DEBUGGING
1688 STRLEN orig_index = *indexp;
1689#endif
1690
1691 PERL_ARGS_ASSERT_HFREE_NEXT_ENTRY;
1692
e0171a1a
DM
1693 if (SvOOK(hv) && ((iter = HvAUX(hv)))
1694 && ((entry = iter->xhv_eiter)) )
1695 {
1696 /* the iterator may get resurrected after each
1697 * destructor call, so check each time */
1698 if (entry && HvLAZYDEL(hv)) { /* was deleted earlier? */
1699 HvLAZYDEL_off(hv);
922090f4
DM
1700 hv_free_ent(hv, entry);
1701 /* warning: at this point HvARRAY may have been
1702 * re-allocated, HvMAX changed etc */
23976bdd 1703 }
e0171a1a
DM
1704 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
1705 iter->xhv_eiter = NULL; /* HvEITER(hv) = NULL */
1706 }
1707
00a1a643
DM
1708 if (!((XPVHV*)SvANY(hv))->xhv_keys)
1709 return NULL;
1710
e0171a1a
DM
1711 array = HvARRAY(hv);
1712 assert(array);
1713 while ( ! ((entry = array[*indexp])) ) {
1714 if ((*indexp)++ >= HvMAX(hv))
1715 *indexp = 0;
1716 assert(*indexp != orig_index);
1717 }
1718 array[*indexp] = HeNEXT(entry);
1719 ((XPVHV*) SvANY(hv))->xhv_keys--;
1720
1721 if ( PL_phase != PERL_PHASE_DESTRUCT && HvENAME(hv)
1722 && HeVAL(entry) && isGV(HeVAL(entry))
1723 && GvHV(HeVAL(entry)) && HvENAME(GvHV(HeVAL(entry)))
1724 ) {
1725 STRLEN klen;
1726 const char * const key = HePV(entry,klen);
1727 if ((klen > 1 && key[klen-1]==':' && key[klen-2]==':')
1728 || (klen == 1 && key[0] == ':')) {
1729 mro_package_moved(
1730 NULL, GvHV(HeVAL(entry)),
1731 (GV *)HeVAL(entry), 0
1732 );
1733 }
1734 }
1735 return hv_free_ent_ret(hv, entry);
79072805
LW
1736}
1737
e0171a1a 1738
954c1994
GS
1739/*
1740=for apidoc hv_undef
1741
c2217cd3
DM
1742Undefines the hash. The XS equivalent of undef(%hash).
1743
1744As well as freeing all the elements of the hash (like hv_clear()), this
1745also frees any auxiliary data and storage associated with the hash.
1746See also L</hv_clear>.
954c1994
GS
1747
1748=cut
1749*/
1750
79072805 1751void
8581adba 1752Perl_hv_undef_flags(pTHX_ HV *hv, U32 flags)
79072805 1753{
97aff369 1754 dVAR;
cbec9347 1755 register XPVHV* xhv;
bfcb3514 1756 const char *name;
86f55936 1757
79072805
LW
1758 if (!hv)
1759 return;
ecae49c0 1760 DEBUG_A(Perl_hv_assert(aTHX_ hv));
cbec9347 1761 xhv = (XPVHV*)SvANY(hv);
dd69841b 1762
745edda6
FC
1763 /* The name must be deleted before the call to hfreeeeentries so that
1764 CVs are anonymised properly. But the effective name must be pre-
1765 served until after that call (and only deleted afterwards if the
1766 call originated from sv_clear). For stashes with one name that is
1767 both the canonical name and the effective name, hv_name_set has to
1768 allocate an array for storing the effective name. We can skip that
1769 during global destruction, as it does not matter where the CVs point
1770 if they will be freed anyway. */
104d7b69
DM
1771 /* note that the code following prior to hfreeentries is duplicated
1772 * in sv_clear(), and changes here should be done there too */
745edda6 1773 if (PL_phase != PERL_PHASE_DESTRUCT && (name = HvNAME(hv))) {
04fe65b0
RGS
1774 if (PL_stashcache)
1775 (void)hv_delete(PL_stashcache, name, HvNAMELEN_get(hv), G_DISCARD);
bd61b366 1776 hv_name_set(hv, NULL, 0, 0);
85e6fe83 1777 }
2d0d1ecc 1778 hfreeentries(hv);
47f1cf77
FC
1779 if (SvOOK(hv)) {
1780 struct xpvhv_aux * const aux = HvAUX(hv);
1781 struct mro_meta *meta;
745edda6
FC
1782
1783 if ((name = HvENAME_get(hv))) {
5f243b5f 1784 if (PL_phase != PERL_PHASE_DESTRUCT)
745edda6 1785 mro_isa_changed_in(hv);
745edda6
FC
1786 if (PL_stashcache)
1787 (void)hv_delete(
1788 PL_stashcache, name, HvENAMELEN_get(hv), G_DISCARD
1789 );
1790 }
1791
1792 /* If this call originated from sv_clear, then we must check for
1793 * effective names that need freeing, as well as the usual name. */
1794 name = HvNAME(hv);
15d9236d 1795 if (flags & HV_NAME_SETALL ? !!aux->xhv_name_u.xhvnameu_name : !!name) {
745edda6 1796 if (name && PL_stashcache)
2d0d1ecc 1797 (void)hv_delete(PL_stashcache, name, HvNAMELEN_get(hv), G_DISCARD);
745edda6 1798 hv_name_set(hv, NULL, 0, flags);
47f1cf77
FC
1799 }
1800 if((meta = aux->xhv_mro_meta)) {
1801 if (meta->mro_linear_all) {
1802 SvREFCNT_dec(MUTABLE_SV(meta->mro_linear_all));
1803 meta->mro_linear_all = NULL;
1804 /* This is just acting as a shortcut pointer. */
1805 meta->mro_linear_current = NULL;
1806 } else if (meta->mro_linear_current) {
1807 /* Only the current MRO is stored, so this owns the data.
1808 */
1809 SvREFCNT_dec(meta->mro_linear_current);
1810 meta->mro_linear_current = NULL;
1811 }
1812 if(meta->mro_nextmethod) SvREFCNT_dec(meta->mro_nextmethod);
1813 SvREFCNT_dec(meta->isa);
1814 Safefree(meta);
1815 aux->xhv_mro_meta = NULL;
1816 }
3b37eb24 1817 if (!aux->xhv_name_u.xhvnameu_name && ! aux->xhv_backreferences)
745edda6 1818 SvFLAGS(hv) &= ~SVf_OOK;
745edda6
FC
1819 }
1820 if (!SvOOK(hv)) {
1821 Safefree(HvARRAY(hv));
1822 xhv->xhv_max = 7; /* HvMAX(hv) = 7 (it's a normal hash) */
1823 HvARRAY(hv) = 0;
2d0d1ecc 1824 }
ca732855 1825 HvPLACEHOLDERS_set(hv, 0);
a0d0e21e
LW
1826
1827 if (SvRMAGICAL(hv))
ad64d0ec 1828 mg_clear(MUTABLE_SV(hv));
79072805
LW
1829}
1830
4d0fbddd
NC
1831/*
1832=for apidoc hv_fill
1833
1834Returns the number of hash buckets that happen to be in use. This function is
1835wrapped by the macro C<HvFILL>.
1836
1837Previously this value was stored in the HV structure, rather than being
1838calculated on demand.
1839
1840=cut
1841*/
1842
1843STRLEN
1844Perl_hv_fill(pTHX_ HV const *const hv)
1845{
1846 STRLEN count = 0;
1847 HE **ents = HvARRAY(hv);
1848
1849 PERL_ARGS_ASSERT_HV_FILL;
1850
1851 if (ents) {
fcd24582
NC
1852 HE *const *const last = ents + HvMAX(hv);
1853 count = last + 1 - ents;
4d0fbddd
NC
1854
1855 do {
fcd24582
NC
1856 if (!*ents)
1857 --count;
1858 } while (++ents <= last);
4d0fbddd
NC
1859 }
1860 return count;
1861}
1862
b464bac0 1863static struct xpvhv_aux*
5f66b61c 1864S_hv_auxinit(HV *hv) {
bfcb3514 1865 struct xpvhv_aux *iter;
b79f7545 1866 char *array;
bfcb3514 1867
7918f24d
NC
1868 PERL_ARGS_ASSERT_HV_AUXINIT;
1869
b79f7545 1870 if (!HvARRAY(hv)) {
a02a5408 1871 Newxz(array, PERL_HV_ARRAY_ALLOC_BYTES(HvMAX(hv) + 1)
b79f7545
NC
1872 + sizeof(struct xpvhv_aux), char);
1873 } else {
1874 array = (char *) HvARRAY(hv);
1875 Renew(array, PERL_HV_ARRAY_ALLOC_BYTES(HvMAX(hv) + 1)
1876 + sizeof(struct xpvhv_aux), char);
1877 }
1878 HvARRAY(hv) = (HE**) array;
1879 /* SvOOK_on(hv) attacks the IV flags. */
1880 SvFLAGS(hv) |= SVf_OOK;
1881 iter = HvAUX(hv);
bfcb3514
NC
1882
1883 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
4608196e 1884 iter->xhv_eiter = NULL; /* HvEITER(hv) = NULL */
15d9236d 1885 iter->xhv_name_u.xhvnameu_name = 0;
b7247a80 1886 iter->xhv_name_count = 0;
86f55936 1887 iter->xhv_backreferences = 0;
e1a479c5 1888 iter->xhv_mro_meta = NULL;
bfcb3514
NC
1889 return iter;
1890}
1891
954c1994
GS
1892/*
1893=for apidoc hv_iterinit
1894
1895Prepares a starting point to traverse a hash table. Returns the number of
1b95d04f 1896keys in the hash (i.e. the same as C<HvUSEDKEYS(hv)>). The return value is
1c846c1f 1897currently only meaningful for hashes without tie magic.
954c1994
GS
1898
1899NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1900hash buckets that happen to be in use. If you still need that esoteric
b24b84ef 1901value, you can get it through the macro C<HvFILL(hv)>.
954c1994 1902
e16e2ff8 1903
954c1994
GS
1904=cut
1905*/
1906
79072805 1907I32
864dbfa3 1908Perl_hv_iterinit(pTHX_ HV *hv)
79072805 1909{
7918f24d
NC
1910 PERL_ARGS_ASSERT_HV_ITERINIT;
1911
1912 /* FIXME: Are we not NULL, or do we croak? Place bets now! */
1913
aa689395 1914 if (!hv)
cea2e8a9 1915 Perl_croak(aTHX_ "Bad hash");
bfcb3514 1916
b79f7545 1917 if (SvOOK(hv)) {
6136c704 1918 struct xpvhv_aux * const iter = HvAUX(hv);
0bd48802 1919 HE * const entry = iter->xhv_eiter; /* HvEITER(hv) */
bfcb3514
NC
1920 if (entry && HvLAZYDEL(hv)) { /* was deleted earlier? */
1921 HvLAZYDEL_off(hv);
1922 hv_free_ent(hv, entry);
1923 }
1924 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
4608196e 1925 iter->xhv_eiter = NULL; /* HvEITER(hv) = NULL */
bfcb3514 1926 } else {
6136c704 1927 hv_auxinit(hv);
72940dca 1928 }
44a2ac75 1929
cbec9347 1930 /* used to be xhv->xhv_fill before 5.004_65 */
5d88ecd7 1931 return HvTOTALKEYS(hv);
79072805 1932}
bfcb3514
NC
1933
1934I32 *
1935Perl_hv_riter_p(pTHX_ HV *hv) {
1936 struct xpvhv_aux *iter;
1937
7918f24d
NC
1938 PERL_ARGS_ASSERT_HV_RITER_P;
1939
bfcb3514
NC
1940 if (!hv)
1941 Perl_croak(aTHX_ "Bad hash");
1942
6136c704 1943 iter = SvOOK(hv) ? HvAUX(hv) : hv_auxinit(hv);
bfcb3514
NC
1944 return &(iter->xhv_riter);
1945}
1946
1947HE **
1948Perl_hv_eiter_p(pTHX_ HV *hv) {
1949 struct xpvhv_aux *iter;
1950
7918f24d
NC
1951 PERL_ARGS_ASSERT_HV_EITER_P;
1952
bfcb3514
NC
1953 if (!hv)
1954 Perl_croak(aTHX_ "Bad hash");
1955
6136c704 1956 iter = SvOOK(hv) ? HvAUX(hv) : hv_auxinit(hv);
bfcb3514
NC
1957 return &(iter->xhv_eiter);
1958}
1959
1960void
1961Perl_hv_riter_set(pTHX_ HV *hv, I32 riter) {
1962 struct xpvhv_aux *iter;
1963
7918f24d
NC
1964 PERL_ARGS_ASSERT_HV_RITER_SET;
1965
bfcb3514
NC
1966 if (!hv)
1967 Perl_croak(aTHX_ "Bad hash");
1968
b79f7545
NC
1969 if (SvOOK(hv)) {
1970 iter = HvAUX(hv);
1971 } else {
bfcb3514
NC
1972 if (riter == -1)
1973 return;
1974
6136c704 1975 iter = hv_auxinit(hv);
bfcb3514
NC
1976 }
1977 iter->xhv_riter = riter;
1978}
1979
1980void
1981Perl_hv_eiter_set(pTHX_ HV *hv, HE *eiter) {
1982 struct xpvhv_aux *iter;
1983
7918f24d
NC
1984 PERL_ARGS_ASSERT_HV_EITER_SET;
1985
bfcb3514
NC
1986 if (!hv)
1987 Perl_croak(aTHX_ "Bad hash");
1988
b79f7545
NC
1989 if (SvOOK(hv)) {
1990 iter = HvAUX(hv);
1991 } else {
bfcb3514
NC
1992 /* 0 is the default so don't go malloc()ing a new structure just to
1993 hold 0. */
1994 if (!eiter)
1995 return;
1996
6136c704 1997 iter = hv_auxinit(hv);
bfcb3514
NC
1998 }
1999 iter->xhv_eiter = eiter;
2000}
2001
bfcb3514 2002void
4164be69 2003Perl_hv_name_set(pTHX_ HV *hv, const char *name, U32 len, U32 flags)
bfcb3514 2004{
97aff369 2005 dVAR;
b79f7545 2006 struct xpvhv_aux *iter;
7423f6db 2007 U32 hash;
78b79c77 2008 HEK **spot;
46c461b5 2009
7918f24d 2010 PERL_ARGS_ASSERT_HV_NAME_SET;
46c461b5 2011 PERL_UNUSED_ARG(flags);
bfcb3514 2012
4164be69
NC
2013 if (len > I32_MAX)
2014 Perl_croak(aTHX_ "panic: hv name too long (%"UVuf")", (UV) len);
2015
b79f7545
NC
2016 if (SvOOK(hv)) {
2017 iter = HvAUX(hv);
15d9236d 2018 if (iter->xhv_name_u.xhvnameu_name) {
b7247a80 2019 if(iter->xhv_name_count) {
745edda6 2020 if(flags & HV_NAME_SETALL) {
15d9236d 2021 HEK ** const name = HvAUX(hv)->xhv_name_u.xhvnameu_names;
78b79c77
FC
2022 HEK **hekp = name + (
2023 iter->xhv_name_count < 0
2024 ? -iter->xhv_name_count
2025 : iter->xhv_name_count
2026 );
2027 while(hekp-- > name+1)
b7247a80 2028 unshare_hek_or_pvn(*hekp, 0, 0, 0);
78b79c77
FC
2029 /* The first elem may be null. */
2030 if(*name) unshare_hek_or_pvn(*name, 0, 0, 0);
b7247a80 2031 Safefree(name);
15d9236d 2032 spot = &iter->xhv_name_u.xhvnameu_name;
78b79c77
FC
2033 iter->xhv_name_count = 0;
2034 }
2035 else {
78b79c77
FC
2036 if(iter->xhv_name_count > 0) {
2037 /* shift some things over */
15d9236d
NC
2038 Renew(
2039 iter->xhv_name_u.xhvnameu_names, iter->xhv_name_count + 1, HEK *
4c2bfb4f 2040 );
15d9236d 2041 spot = iter->xhv_name_u.xhvnameu_names;
4c2bfb4f 2042 spot[iter->xhv_name_count] = spot[1];
78b79c77 2043 spot[1] = spot[0];
4c2bfb4f 2044 iter->xhv_name_count = -(iter->xhv_name_count + 1);
78b79c77 2045 }
15d9236d 2046 else if(*(spot = iter->xhv_name_u.xhvnameu_names)) {
78b79c77
FC
2047 unshare_hek_or_pvn(*spot, 0, 0, 0);
2048 }
2049 }
2050 }
745edda6 2051 else if (flags & HV_NAME_SETALL) {
15d9236d
NC
2052 unshare_hek_or_pvn(iter->xhv_name_u.xhvnameu_name, 0, 0, 0);
2053 spot = &iter->xhv_name_u.xhvnameu_name;
b7247a80 2054 }
745edda6 2055 else {
15d9236d
NC
2056 HEK * const existing_name = iter->xhv_name_u.xhvnameu_name;
2057 Newx(iter->xhv_name_u.xhvnameu_names, 2, HEK *);
745edda6 2058 iter->xhv_name_count = -2;
15d9236d 2059 spot = iter->xhv_name_u.xhvnameu_names;
745edda6
FC
2060 spot[1] = existing_name;
2061 }
7423f6db 2062 }
15d9236d 2063 else { spot = &iter->xhv_name_u.xhvnameu_name; iter->xhv_name_count = 0; }
16580ff5 2064 } else {
bfcb3514
NC
2065 if (name == 0)
2066 return;
2067
6136c704 2068 iter = hv_auxinit(hv);
15d9236d 2069 spot = &iter->xhv_name_u.xhvnameu_name;
bfcb3514 2070 }
7423f6db 2071 PERL_HASH(hash, name, len);
78b79c77 2072 *spot = name ? share_hek(name, len, hash) : NULL;
bfcb3514
NC
2073}
2074
99206677
FC
2075/*
2076=for apidoc hv_ename_add
2077
2078Adds a name to a stash's internal list of effective names. See
2079C<hv_ename_delete>.
2080
2081This is called when a stash is assigned to a new location in the symbol
2082table.
2083
2084=cut
2085*/
2086
ee72b38d 2087void
27a1175b 2088Perl_hv_ename_add(pTHX_ HV *hv, const char *name, U32 len, U32 flags)
ee72b38d
FC
2089{
2090 dVAR;
2091 struct xpvhv_aux *aux = SvOOK(hv) ? HvAUX(hv) : hv_auxinit(hv);
2092 U32 hash;
2093
78b79c77 2094 PERL_ARGS_ASSERT_HV_ENAME_ADD;
27a1175b 2095 PERL_UNUSED_ARG(flags);
ee72b38d
FC
2096
2097 if (len > I32_MAX)
2098 Perl_croak(aTHX_ "panic: hv name too long (%"UVuf")", (UV) len);
2099
2100 PERL_HASH(hash, name, len);
2101
ee72b38d 2102 if (aux->xhv_name_count) {
15d9236d 2103 HEK ** const xhv_name = aux->xhv_name_u.xhvnameu_names;
78b79c77
FC
2104 I32 count = aux->xhv_name_count;
2105 HEK **hekp = xhv_name + (count < 0 ? -count : count);
ee72b38d
FC
2106 while (hekp-- > xhv_name)
2107 if (
2108 HEK_LEN(*hekp) == (I32)len && memEQ(HEK_KEY(*hekp), name, len)
78b79c77
FC
2109 ) {
2110 if (hekp == xhv_name && count < 0)
2111 aux->xhv_name_count = -count;
2112 return;
2113 }
2114 if (count < 0) aux->xhv_name_count--, count = -count;
2115 else aux->xhv_name_count++;
15d9236d
NC
2116 Renew(aux->xhv_name_u.xhvnameu_names, count + 1, HEK *);
2117 (aux->xhv_name_u.xhvnameu_names)[count] = share_hek(name, len, hash);
ee72b38d
FC
2118 }
2119 else {
15d9236d 2120 HEK *existing_name = aux->xhv_name_u.xhvnameu_name;
ee72b38d 2121 if (
78b79c77 2122 existing_name && HEK_LEN(existing_name) == (I32)len
ee72b38d
FC
2123 && memEQ(HEK_KEY(existing_name), name, len)
2124 ) return;
15d9236d 2125 Newx(aux->xhv_name_u.xhvnameu_names, 2, HEK *);
78b79c77 2126 aux->xhv_name_count = existing_name ? 2 : -2;
15d9236d
NC
2127 *aux->xhv_name_u.xhvnameu_names = existing_name;
2128 (aux->xhv_name_u.xhvnameu_names)[1] = share_hek(name, len, hash);
ee72b38d
FC
2129 }
2130}
2131
99206677
FC
2132/*
2133=for apidoc hv_ename_delete
2134
2135Removes a name from a stash's internal list of effective names. If this is
2136the name returned by C<HvENAME>, then another name in the list will take
2137its place (C<HvENAME> will use it).
2138
2139This is called when a stash is deleted from the symbol table.
2140
2141=cut
2142*/
2143
ee72b38d 2144void
27a1175b 2145Perl_hv_ename_delete(pTHX_ HV *hv, const char *name, U32 len, U32 flags)
ee72b38d
FC
2146{
2147 dVAR;
2148 struct xpvhv_aux *aux;
2149
78b79c77 2150 PERL_ARGS_ASSERT_HV_ENAME_DELETE;
27a1175b 2151 PERL_UNUSED_ARG(flags);
ee72b38d
FC
2152
2153 if (len > I32_MAX)
2154 Perl_croak(aTHX_ "panic: hv name too long (%"UVuf")", (UV) len);
2155
2156 if (!SvOOK(hv)) return;
2157
2158 aux = HvAUX(hv);
15d9236d 2159 if (!aux->xhv_name_u.xhvnameu_name) return;
ee72b38d
FC
2160
2161 if (aux->xhv_name_count) {
15d9236d 2162 HEK ** const namep = aux->xhv_name_u.xhvnameu_names;
78b79c77
FC
2163 I32 const count = aux->xhv_name_count;
2164 HEK **victim = namep + (count < 0 ? -count : count);
2165 while (victim-- > namep + 1)
ee72b38d
FC
2166 if (
2167 HEK_LEN(*victim) == (I32)len
2168 && memEQ(HEK_KEY(*victim), name, len)
2169 ) {
2170 unshare_hek_or_pvn(*victim, 0, 0, 0);
78b79c77
FC
2171 if (count < 0) ++aux->xhv_name_count;
2172 else --aux->xhv_name_count;
2173 if (
2174 (aux->xhv_name_count == 1 || aux->xhv_name_count == -1)
2175 && !*namep
2176 ) { /* if there are none left */
ee72b38d 2177 Safefree(namep);
15d9236d 2178 aux->xhv_name_u.xhvnameu_names = NULL;
78b79c77 2179 aux->xhv_name_count = 0;
ee72b38d
FC
2180 }
2181 else {
2182 /* Move the last one back to fill the empty slot. It
2183 does not matter what order they are in. */
78b79c77 2184 *victim = *(namep + (count < 0 ? -count : count) - 1);
ee72b38d
FC
2185 }
2186 return;
2187 }
78b79c77
FC
2188 if (
2189 count > 0 && HEK_LEN(*namep) == (I32)len
2190 && memEQ(HEK_KEY(*namep),name,len)
2191 ) {
2192 aux->xhv_name_count = -count;
2193 }
ee72b38d
FC
2194 }
2195 else if(
15d9236d
NC
2196 HEK_LEN(aux->xhv_name_u.xhvnameu_name) == (I32)len
2197 && memEQ(HEK_KEY(aux->xhv_name_u.xhvnameu_name), name, len)
ee72b38d 2198 ) {
15d9236d
NC
2199 HEK * const namehek = aux->xhv_name_u.xhvnameu_name;
2200 Newx(aux->xhv_name_u.xhvnameu_names, 1, HEK *);
2201 *aux->xhv_name_u.xhvnameu_names = namehek;
3f783763 2202 aux->xhv_name_count = -1;
ee72b38d
FC
2203 }
2204}
2205
86f55936
NC
2206AV **
2207Perl_hv_backreferences_p(pTHX_ HV *hv) {
6136c704 2208 struct xpvhv_aux * const iter = SvOOK(hv) ? HvAUX(hv) : hv_auxinit(hv);
7918f24d
NC
2209
2210 PERL_ARGS_ASSERT_HV_BACKREFERENCES_P;
96a5add6 2211 PERL_UNUSED_CONTEXT;
7918f24d 2212
86f55936
NC
2213 return &(iter->xhv_backreferences);
2214}
2215
09aad8f0
DM
2216void
2217Perl_hv_kill_backrefs(pTHX_ HV *hv) {
2218 AV *av;
2219
2220 PERL_ARGS_ASSERT_HV_KILL_BACKREFS;
2221
2222 if (!SvOOK(hv))
2223 return;
2224
2225 av = HvAUX(hv)->xhv_backreferences;
2226
2227 if (av) {
2228 HvAUX(hv)->xhv_backreferences = 0;
2229 Perl_sv_kill_backrefs(aTHX_ MUTABLE_SV(hv), av);
5648c0ae
DM
2230 if (SvTYPE(av) == SVt_PVAV)
2231 SvREFCNT_dec(av);
09aad8f0
DM
2232 }
2233}
2234
954c1994 2235/*
7a7b9979
NC
2236hv_iternext is implemented as a macro in hv.h
2237
954c1994
GS
2238=for apidoc hv_iternext
2239
2240Returns entries from a hash iterator. See C<hv_iterinit>.
2241
fe7bca90
NC
2242You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
2243iterator currently points to, without losing your place or invalidating your
2244iterator. Note that in this case the current entry is deleted from the hash
2245with your iterator holding the last reference to it. Your iterator is flagged
2246to free the entry on the next call to C<hv_iternext>, so you must not discard
2247your iterator immediately else the entry will leak - call C<hv_iternext> to
2248trigger the resource deallocation.
2249
fe7bca90
NC
2250=for apidoc hv_iternext_flags
2251
2252Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
2253The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
2254set the placeholders keys (for restricted hashes) will be returned in addition
2255to normal keys. By default placeholders are automatically skipped over.
7996736c
MHM
2256Currently a placeholder is implemented with a value that is
2257C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
fe7bca90
NC
2258restricted hashes may change, and the implementation currently is
2259insufficiently abstracted for any change to be tidy.
e16e2ff8 2260
fe7bca90 2261=cut
e16e2ff8
NC
2262*/
2263
2264HE *
2265Perl_hv_iternext_flags(pTHX_ HV *hv, I32 flags)
2266{
27da23d5 2267 dVAR;
cbec9347 2268 register XPVHV* xhv;
79072805 2269 register HE *entry;
a0d0e21e 2270 HE *oldentry;
463ee0b2 2271 MAGIC* mg;
bfcb3514 2272 struct xpvhv_aux *iter;
79072805 2273
7918f24d
NC
2274 PERL_ARGS_ASSERT_HV_ITERNEXT_FLAGS;
2275
79072805 2276 if (!hv)
cea2e8a9 2277 Perl_croak(aTHX_ "Bad hash");
81714fb9 2278
cbec9347 2279 xhv = (XPVHV*)SvANY(hv);
bfcb3514 2280
b79f7545 2281 if (!SvOOK(hv)) {
bfcb3514
NC
2282 /* Too many things (well, pp_each at least) merrily assume that you can
2283 call iv_iternext without calling hv_iterinit, so we'll have to deal
2284 with it. */
2285 hv_iterinit(hv);
bfcb3514 2286 }
b79f7545 2287 iter = HvAUX(hv);
bfcb3514
NC
2288
2289 oldentry = entry = iter->xhv_eiter; /* HvEITER(hv) */
e62cc96a 2290 if (SvMAGICAL(hv) && SvRMAGICAL(hv)) {
ad64d0ec 2291 if ( ( mg = mg_find((const SV *)hv, PERL_MAGIC_tied) ) ) {
e62cc96a
YO
2292 SV * const key = sv_newmortal();
2293 if (entry) {
2294 sv_setsv(key, HeSVKEY_force(entry));
2295 SvREFCNT_dec(HeSVKEY(entry)); /* get rid of previous key */
2296 }
2297 else {
2298 char *k;
2299 HEK *hek;
2300
2301 /* one HE per MAGICAL hash */
2302 iter->xhv_eiter = entry = new_HE(); /* HvEITER(hv) = new_HE() */
2303 Zero(entry, 1, HE);
ad64d0ec 2304 Newxz(k, HEK_BASESIZE + sizeof(const SV *), char);
e62cc96a
YO
2305 hek = (HEK*)k;
2306 HeKEY_hek(entry) = hek;
2307 HeKLEN(entry) = HEf_SVKEY;
2308 }
ad64d0ec 2309 magic_nextpack(MUTABLE_SV(hv),mg,key);
e62cc96a
YO
2310 if (SvOK(key)) {
2311 /* force key to stay around until next time */
2312 HeSVKEY_set(entry, SvREFCNT_inc_simple_NN(key));
2313 return entry; /* beware, hent_val is not set */
2314 }
ef8d46e8 2315 SvREFCNT_dec(HeVAL(entry));
e62cc96a
YO
2316 Safefree(HeKEY_hek(entry));
2317 del_HE(entry);
2318 iter->xhv_eiter = NULL; /* HvEITER(hv) = NULL */
2319 return NULL;
81714fb9 2320 }
79072805 2321 }
7ee146b1 2322#if defined(DYNAMIC_ENV_FETCH) && !defined(__riscos__) /* set up %ENV for iteration */
ad64d0ec
NC
2323 if (!entry && SvRMAGICAL((const SV *)hv)
2324 && mg_find((const SV *)hv, PERL_MAGIC_env)) {
f675dbe5 2325 prime_env_iter();
03026e68
JM
2326#ifdef VMS
2327 /* The prime_env_iter() on VMS just loaded up new hash values
2328 * so the iteration count needs to be reset back to the beginning
2329 */
2330 hv_iterinit(hv);
2331 iter = HvAUX(hv);
2332 oldentry = entry = iter->xhv_eiter; /* HvEITER(hv) */
2333#endif
2334 }
f675dbe5 2335#endif
463ee0b2 2336
b79f7545
NC
2337 /* hv_iterint now ensures this. */
2338 assert (HvARRAY(hv));
2339
015a5f36 2340 /* At start of hash, entry is NULL. */
fde52b5c 2341 if (entry)
8aacddc1 2342 {
fde52b5c 2343 entry = HeNEXT(entry);
e16e2ff8
NC
2344 if (!(flags & HV_ITERNEXT_WANTPLACEHOLDERS)) {
2345 /*
2346 * Skip past any placeholders -- don't want to include them in
2347 * any iteration.
2348 */
7996736c 2349 while (entry && HeVAL(entry) == &PL_sv_placeholder) {
e16e2ff8
NC
2350 entry = HeNEXT(entry);
2351 }
8aacddc1
NIS
2352 }
2353 }
015a5f36 2354
9eb4ebd1
NC
2355 /* Skip the entire loop if the hash is empty. */
2356 if ((flags & HV_ITERNEXT_WANTPLACEHOLDERS)
2357 ? HvTOTALKEYS(hv) : HvUSEDKEYS(hv)) {
900ac051
MM
2358 while (!entry) {
2359 /* OK. Come to the end of the current list. Grab the next one. */
2360
2361 iter->xhv_riter++; /* HvRITER(hv)++ */
2362 if (iter->xhv_riter > (I32)xhv->xhv_max /* HvRITER(hv) > HvMAX(hv) */) {
2363 /* There is no next one. End of the hash. */
2364 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
2365 break;
2366 }
2367 entry = (HvARRAY(hv))[iter->xhv_riter];
8aacddc1 2368
900ac051
MM
2369 if (!(flags & HV_ITERNEXT_WANTPLACEHOLDERS)) {
2370 /* If we have an entry, but it's a placeholder, don't count it.
2371 Try the next. */
2372 while (entry && HeVAL(entry) == &PL_sv_placeholder)
2373 entry = HeNEXT(entry);
2374 }
2375 /* Will loop again if this linked list starts NULL
2376 (for HV_ITERNEXT_WANTPLACEHOLDERS)
2377 or if we run through it and find only placeholders. */
015a5f36 2378 }
fde52b5c 2379 }
79072805 2380
72940dca
PP
2381 if (oldentry && HvLAZYDEL(hv)) { /* was deleted earlier? */
2382 HvLAZYDEL_off(hv);
68dc0745 2383 hv_free_ent(hv, oldentry);
72940dca 2384 }
a0d0e21e 2385
fdcd69b6 2386 /*if (HvREHASH(hv) && entry && !HeKREHASH(entry))
6c9570dc 2387 PerlIO_printf(PerlIO_stderr(), "Awooga %p %p\n", (void*)hv, (void*)entry);*/
fdcd69b6 2388
bfcb3514 2389 iter->xhv_eiter = entry; /* HvEITER(hv) = entry */
79072805
LW
2390 return entry;
2391}
2392
954c1994
GS
2393/*
2394=for apidoc hv_iterkey
2395
2396Returns the key from the current position of the hash iterator. See
2397C<hv_iterinit>.
2398
2399=cut
2400*/
2401
79072805 2402char *
864dbfa3 2403Perl_hv_iterkey(pTHX_ register HE *entry, I32 *retlen)
79072805 2404{
7918f24d
NC
2405 PERL_ARGS_ASSERT_HV_ITERKEY;
2406
fde52b5c 2407 if (HeKLEN(entry) == HEf_SVKEY) {
fb73857a 2408 STRLEN len;
0bd48802 2409 char * const p = SvPV(HeKEY_sv(entry), len);
fb73857a
PP
2410 *retlen = len;
2411 return p;
fde52b5c
PP
2412 }
2413 else {
2414 *retlen = HeKLEN(entry);
2415 return HeKEY(entry);
2416 }
2417}
2418
2419/* unlike hv_iterval(), this always returns a mortal copy of the key */
954c1994
GS
2420/*
2421=for apidoc hv_iterkeysv
2422
2423Returns the key as an C<SV*> from the current position of the hash
2424iterator. The return value will always be a mortal copy of the key. Also
2425see C<hv_iterinit>.
2426
2427=cut
2428*/
2429
fde52b5c 2430SV *
864dbfa3 2431Perl_hv_iterkeysv(pTHX_ register HE *entry)
fde52b5c 2432{
7918f24d
NC
2433 PERL_ARGS_ASSERT_HV_ITERKEYSV;
2434
c1b02ed8 2435 return sv_2mortal(newSVhek(HeKEY_hek(entry)));
79072805
LW
2436}
2437
954c1994
GS
2438/*
2439=for apidoc hv_iterval
2440
2441Returns the value from the current position of the hash iterator. See
2442C<hv_iterkey>.
2443
2444=cut
2445*/
2446
79072805 2447SV *
864dbfa3 2448Perl_hv_iterval(pTHX_ HV *hv, register HE *entry)
79072805 2449{
7918f24d
NC
2450 PERL_ARGS_ASSERT_HV_ITERVAL;
2451
8990e307 2452 if (SvRMAGICAL(hv)) {
ad64d0ec 2453 if (mg_find((const SV *)hv, PERL_MAGIC_tied)) {
c4420975 2454 SV* const sv = sv_newmortal();
bbce6d69 2455 if (HeKLEN(entry) == HEf_SVKEY)
ad64d0ec 2456 mg_copy(MUTABLE_SV(hv), sv, (char*)HeKEY_sv(entry), HEf_SVKEY);
a3b680e6 2457 else
ad64d0ec 2458 mg_copy(MUTABLE_SV(hv), sv, HeKEY(entry), HeKLEN(entry));
463ee0b2
LW
2459 return sv;
2460 }
79072805 2461 }
fde52b5c 2462 return HeVAL(entry);
79072805
LW
2463}
2464
954c1994
GS
2465/*
2466=for apidoc hv_iternextsv
2467
2468Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
2469operation.
2470
2471=cut
2472*/
2473
a0d0e21e 2474SV *
864dbfa3 2475Perl_hv_iternextsv(pTHX_ HV *hv, char **key, I32 *retlen)
a0d0e21e 2476{
0bd48802
AL
2477 HE * const he = hv_iternext_flags(hv, 0);
2478
7918f24d
NC
2479 PERL_ARGS_ASSERT_HV_ITERNEXTSV;
2480
0bd48802 2481 if (!he)
a0d0e21e
LW
2482 return NULL;
2483 *key = hv_iterkey(he, retlen);
2484 return hv_iterval(hv, he);
2485}
2486
954c1994 2487/*
bc5cdc23
NC
2488
2489Now a macro in hv.h
2490
954c1994
GS
2491=for apidoc hv_magic
2492
2493Adds magic to a hash. See C<sv_magic>.
2494
2495=cut
2496*/
2497
bbce6d69 2498/* possibly free a shared string if no one has access to it
fde52b5c
PP
2499 * len and hash must both be valid for str.
2500 */
bbce6d69 2501void
864dbfa3 2502Perl_unsharepvn(pTHX_ const char *str, I32 len, U32 hash)
fde52b5c 2503{
19692e8d
NC
2504 unshare_hek_or_pvn (NULL, str, len, hash);
2505}
2506
2507
2508void
2509Perl_unshare_hek(pTHX_ HEK *hek)
2510{
bf11fd37 2511 assert(hek);
19692e8d
NC
2512 unshare_hek_or_pvn(hek, NULL, 0, 0);
2513}
2514
2515/* possibly free a shared string if no one has access to it
2516 hek if non-NULL takes priority over the other 3, else str, len and hash
2517 are used. If so, len and hash must both be valid for str.
2518 */
df132699 2519STATIC void
97ddebaf 2520S_unshare_hek_or_pvn(pTHX_ const HEK *hek, const char *str, I32 len, U32 hash)
19692e8d 2521{
97aff369 2522 dVAR;
cbec9347 2523 register XPVHV* xhv;
20454177 2524 HE *entry;
fde52b5c 2525 register HE **oentry;
c3654f1a 2526 bool is_utf8 = FALSE;
19692e8d 2527 int k_flags = 0;
aec46f14 2528 const char * const save = str;
cbbf8932 2529 struct shared_he *he = NULL;
c3654f1a 2530
19692e8d 2531 if (hek) {
cbae3960
NC
2532 /* Find the shared he which is just before us in memory. */
2533 he = (struct shared_he *)(((char *)hek)
2534 - STRUCT_OFFSET(struct shared_he,
2535 shared_he_hek));
2536
2537 /* Assert that the caller passed us a genuine (or at least consistent)
2538 shared hek */
2539 assert (he->shared_he_he.hent_hek == hek);
29404ae0 2540
de616631
NC
2541 if (he->shared_he_he.he_valu.hent_refcount - 1) {
2542 --he->shared_he_he.he_valu.hent_refcount;
29404ae0
NC
2543 return;
2544 }
29404ae0 2545
19692e8d
NC
2546 hash = HEK_HASH(hek);
2547 } else if (len < 0) {
2548 STRLEN tmplen = -len;
2549 is_utf8 = TRUE;
2550 /* See the note in hv_fetch(). --jhi */
2551 str = (char*)bytes_from_utf8((U8*)str, &tmplen, &is_utf8);
2552 len = tmplen;
2553 if (is_utf8)
2554 k_flags = HVhek_UTF8;
2555 if (str != save)
2556 k_flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
c3654f1a 2557 }
1c846c1f 2558
de616631 2559 /* what follows was the moral equivalent of:
6b88bc9c 2560 if ((Svp = hv_fetch(PL_strtab, tmpsv, FALSE, hash))) {
a0714e2c 2561 if (--*Svp == NULL)
6b88bc9c 2562 hv_delete(PL_strtab, str, len, G_DISCARD, hash);
bbce6d69 2563 } */
cbec9347 2564 xhv = (XPVHV*)SvANY(PL_strtab);
fde52b5c 2565 /* assert(xhv_array != 0) */
9de10d5c 2566 oentry = &(HvARRAY(PL_strtab))[hash & (I32) HvMAX(PL_strtab)];
6c1b96a1
NC
2567 if (he) {
2568 const HE *const he_he = &(he->shared_he_he);
45d1cc86 2569 for (entry = *oentry; entry; oentry = &HeNEXT(entry), entry = *oentry) {
35ab5632
NC
2570 if (entry == he_he)
2571 break;
19692e8d
NC
2572 }
2573 } else {
35a4481c 2574 const int flags_masked = k_flags & HVhek_MASK;
45d1cc86 2575 for (entry = *oentry; entry; oentry = &HeNEXT(entry), entry = *oentry) {
19692e8d
NC
2576 if (HeHASH(entry) != hash) /* strings can't be equal */
2577 continue;
2578 if (HeKLEN(entry) != len)
2579 continue;
2580 if (HeKEY(entry) != str && memNE(HeKEY(entry),str,len)) /* is this it? */
2581 continue;
2582 if (HeKFLAGS(entry) != flags_masked)
2583 continue;
19692e8d
NC
2584 break;
2585 }
2586 }
2587
35ab5632
NC
2588 if (entry) {
2589 if (--entry->he_valu.hent_refcount == 0) {
19692e8d 2590 *oentry = HeNEXT(entry);
cbae3960 2591 Safefree(entry);
4c7185a0 2592 xhv->xhv_keys--; /* HvTOTALKEYS(hv)-- */
19692e8d 2593 }
fde52b5c 2594 }
19692e8d 2595
9b387841
NC
2596 if (!entry)
2597 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
2598 "Attempt to free non-existent shared string '%s'%s"
2599 pTHX__FORMAT,
2600 hek ? HEK_KEY(hek) : str,
2601 ((k_flags & HVhek_UTF8) ? " (utf8)" : "") pTHX__VALUE);
19692e8d
NC
2602 if (k_flags & HVhek_FREEKEY)
2603 Safefree(str);
fde52b5c
PP
2604}
2605
bbce6d69
PP
2606/* get a (constant) string ptr from the global string table
2607 * string will get added if it is not already there.
fde52b5c
PP
2608 * len and hash must both be valid for str.
2609 */
bbce6d69 2610HEK *
864dbfa3 2611Perl_share_hek(pTHX_ const char *str, I32 len, register U32 hash)
fde52b5c 2612{
da58a35d 2613 bool is_utf8 = FALSE;
19692e8d 2614 int flags = 0;
aec46f14 2615 const char * const save = str;
da58a35d 2616
7918f24d
NC
2617 PERL_ARGS_ASSERT_SHARE_HEK;
2618
da58a35d 2619 if (len < 0) {
77caf834 2620 STRLEN tmplen = -len;
da58a35d 2621 is_utf8 = TRUE;
77caf834
JH
2622 /* See the note in hv_fetch(). --jhi */
2623 str = (char*)bytes_from_utf8((U8*)str, &tmplen, &is_utf8);
2624 len = tmplen;
19692e8d
NC
2625 /* If we were able to downgrade here, then than means that we were passed
2626 in a key which only had chars 0-255, but was utf8 encoded. */
2627 if (is_utf8)
2628 flags = HVhek_UTF8;
2629 /* If we found we were able to downgrade the string to bytes, then
2630 we should flag that it needs upgrading on keys or each. Also flag
2631 that we need share_hek_flags to free the string. */
2632 if (str != save)
2633 flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
2634 }
2635
6e838c70 2636 return share_hek_flags (str, len, hash, flags);
19692e8d
NC
2637}
2638
6e838c70 2639STATIC HEK *
19692e8d
NC
2640S_share_hek_flags(pTHX_ const char *str, I32 len, register U32 hash, int flags)
2641{
97aff369 2642 dVAR;
19692e8d 2643 register HE *entry;
35a4481c 2644 const int flags_masked = flags & HVhek_MASK;
263cb4a6 2645 const U32 hindex = hash & (I32) HvMAX(PL_strtab);
7918f24d
NC
2646 register XPVHV * const xhv = (XPVHV*)SvANY(PL_strtab);
2647
2648 PERL_ARGS_ASSERT_SHARE_HEK_FLAGS;
bbce6d69 2649
fde52b5c 2650 /* what follows is the moral equivalent of:
1c846c1f 2651
6b88bc9c 2652 if (!(Svp = hv_fetch(PL_strtab, str, len, FALSE)))
a0714e2c 2653 hv_store(PL_strtab, str, len, NULL, hash);
fdcd69b6
NC
2654
2655 Can't rehash the shared string table, so not sure if it's worth
2656 counting the number of entries in the linked list
bbce6d69 2657 */
7918f24d 2658
fde52b5c 2659 /* assert(xhv_array != 0) */
263cb4a6
NC
2660 entry = (HvARRAY(PL_strtab))[hindex];
2661 for (;entry; entry = HeNEXT(entry)) {
fde52b5c
PP
2662 if (HeHASH(entry) != hash) /* strings can't be equal */
2663 continue;
2664 if (HeKLEN(entry) != len)
2665 continue;
1c846c1f 2666 if (HeKEY(entry) != str && memNE(HeKEY(entry),str,len)) /* is this it? */
fde52b5c 2667 continue;
19692e8d 2668 if (HeKFLAGS(entry) != flags_masked)
c3654f1a 2669 continue;
fde52b5c
PP
2670 break;
2671 }
263cb4a6
NC
2672
2673 if (!entry) {
45d1cc86
NC
2674 /* What used to be head of the list.
2675 If this is NULL, then we're the first entry for this slot, which
2676 means we need to increate fill. */
cbae3960
NC
2677 struct shared_he *new_entry;
2678 HEK *hek;
2679 char *k;
263cb4a6
NC
2680 HE **const head = &HvARRAY(PL_strtab)[hindex];
2681 HE *const next = *head;
cbae3960
NC
2682
2683 /* We don't actually store a HE from the arena and a regular HEK.
2684 Instead we allocate one chunk of memory big enough for both,
2685 and put the HEK straight after the HE. This way we can find the
2686 HEK directly from the HE.
2687 */
2688
a02a5408 2689 Newx(k, STRUCT_OFFSET(struct shared_he,
cbae3960
NC
2690 shared_he_hek.hek_key[0]) + len + 2, char);
2691 new_entry = (struct shared_he *)k;
2692 entry = &(new_entry->shared_he_he);
2693 hek = &(new_entry->shared_he_hek);
2694
2695 Copy(str, HEK_KEY(hek), len, char);
2696 HEK_KEY(hek)[len] = 0;
2697 HEK_LEN(hek) = len;
2698 HEK_HASH(hek) = hash;
2699 HEK_FLAGS(hek) = (unsigned char)flags_masked;
2700
2701 /* Still "point" to the HEK, so that other code need not know what
2702 we're up to. */
2703 HeKEY_hek(entry) = hek;
de616631 2704 entry->he_valu.hent_refcount = 0;
263cb4a6
NC
2705 HeNEXT(entry) = next;
2706 *head = entry;
cbae3960 2707
4c7185a0 2708 xhv->xhv_keys++; /* HvTOTALKEYS(hv)++ */
263cb4a6 2709 if (!next) { /* initial entry? */
1b95d04f 2710 } else if (xhv->xhv_keys > xhv->xhv_max /* HvUSEDKEYS(hv) > HvMAX(hv) */) {
cbec9347 2711 hsplit(PL_strtab);
bbce6d69
PP
2712 }
2713 }
2714
de616631 2715 ++entry->he_valu.hent_refcount;
19692e8d
NC
2716
2717 if (flags & HVhek_FREEKEY)
f9a63242 2718 Safefree(str);
19692e8d 2719
6e838c70 2720 return HeKEY_hek(entry);
fde52b5c 2721}
ecae49c0 2722
ca732855
NC
2723I32 *
2724Perl_hv_placeholders_p(pTHX_ HV *hv)
2725{
2726 dVAR;
ad64d0ec 2727 MAGIC *mg = mg_find((const SV *)hv, PERL_MAGIC_rhash);
ca732855 2728
7918f24d
NC
2729 PERL_ARGS_ASSERT_HV_PLACEHOLDERS_P;
2730
ca732855 2731 if (!mg) {
ad64d0ec 2732 mg = sv_magicext(MUTABLE_SV(hv), 0, PERL_MAGIC_rhash, 0, 0, 0);
ca732855
NC
2733
2734 if (!mg) {
2735 Perl_die(aTHX_ "panic: hv_placeholders_p");
2736 }
2737 }
2738 return &(mg->mg_len);
2739}
2740
2741
2742I32
0c289d13 2743Perl_hv_placeholders_get(pTHX_ const HV *hv)
ca732855
NC
2744{
2745 dVAR;
0c289d13 2746 MAGIC * const mg = mg_find((const SV *)hv, PERL_MAGIC_rhash);
ca732855 2747
7918f24d
NC
2748 PERL_ARGS_ASSERT_HV_PLACEHOLDERS_GET;
2749
ca732855
NC
2750 return mg ? mg->mg_len : 0;
2751}
2752
2753void
ac1e784a 2754Perl_hv_placeholders_set(pTHX_ HV *hv, I32 ph)
ca732855
NC
2755{
2756 dVAR;
ad64d0ec 2757 MAGIC * const mg = mg_find((const SV *)hv, PERL_MAGIC_rhash);
ca732855 2758
7918f24d
NC
2759 PERL_ARGS_ASSERT_HV_PLACEHOLDERS_SET;
2760
ca732855
NC
2761 if (mg) {
2762 mg->mg_len = ph;
2763 } else if (ph) {
ad64d0ec 2764 if (!sv_magicext(MUTABLE_SV(hv), 0, PERL_MAGIC_rhash, 0, 0, ph))
ca732855
NC
2765 Perl_die(aTHX_ "panic: hv_placeholders_set");
2766 }
2767 /* else we don't need to add magic to record 0 placeholders. */
2768}
ecae49c0 2769
2a49f0f5 2770STATIC SV *
7b0bddfa
NC
2771S_refcounted_he_value(pTHX_ const struct refcounted_he *he)
2772{
0b2d3faa 2773 dVAR;
7b0bddfa 2774 SV *value;
7918f24d
NC
2775
2776 PERL_ARGS_ASSERT_REFCOUNTED_HE_VALUE;
2777
7b0bddfa
NC
2778 switch(he->refcounted_he_data[0] & HVrhek_typemask) {
2779 case HVrhek_undef:
2780 value = newSV(0);
2781 break;
2782 case HVrhek_delete:
2783 value = &PL_sv_placeholder;
2784 break;
2785 case HVrhek_IV:
44ebaf21
NC
2786 value = newSViv(he->refcounted_he_val.refcounted_he_u_iv);
2787 break;
2788 case HVrhek_UV:
2789 value = newSVuv(he->refcounted_he_val.refcounted_he_u_uv);
7b0bddfa
NC
2790 break;
2791 case HVrhek_PV:
44ebaf21 2792 case HVrhek_PV_UTF8:
7b0bddfa
NC
2793 /* Create a string SV that directly points to the bytes in our
2794 structure. */
b9f83d2f 2795 value = newSV_type(SVt_PV);
7b0bddfa
NC
2796 SvPV_set(value, (char *) he->refcounted_he_data + 1);
2797 SvCUR_set(value, he->refcounted_he_val.refcounted_he_u_len);
2798 /* This stops anything trying to free it */
2799 SvLEN_set(value, 0);
2800 SvPOK_on(value);
2801 SvREADONLY_on(value);
44ebaf21 2802 if ((he->refcounted_he_data[0] & HVrhek_typemask) == HVrhek_PV_UTF8)
7b0bddfa
NC
2803 SvUTF8_on(value);
2804 break;
2805 default:
20439bc7
Z
2806 Perl_croak(aTHX_ "panic: refcounted_he_value bad flags %"UVxf,
2807 (UV)he->refcounted_he_data[0]);
7b0bddfa
NC
2808 }
2809 return value;
2810}
2811
ecae49c0 2812/*
20439bc7 2813=for apidoc m|HV *|refcounted_he_chain_2hv|const struct refcounted_he *c|U32 flags
8dff4fc5 2814
20439bc7
Z
2815Generates and returns a C<HV *> representing the content of a
2816C<refcounted_he> chain.
2817I<flags> is currently unused and must be zero.
8dff4fc5
BM
2818
2819=cut
2820*/
2821HV *
20439bc7 2822Perl_refcounted_he_chain_2hv(pTHX_ const struct refcounted_he *chain, U32 flags)
8dff4fc5 2823{
20439bc7
Z
2824 dVAR;
2825 HV *hv;
2826 U32 placeholders, max;
b3ca2e83 2827
20439bc7
Z
2828 if (flags)
2829 Perl_croak(aTHX_ "panic: refcounted_he_chain_2hv bad flags %"UVxf,
2830 (UV)flags);
b3ca2e83 2831
b3ca2e83
NC
2832 /* We could chase the chain once to get an idea of the number of keys,
2833 and call ksplit. But for now we'll make a potentially inefficient
2834 hash with only 8 entries in its array. */
20439bc7
Z
2835 hv = newHV();
2836 max = HvMAX(hv);
b3ca2e83
NC
2837 if (!HvARRAY(hv)) {
2838 char *array;
2839 Newxz(array, PERL_HV_ARRAY_ALLOC_BYTES(max + 1), char);
2840 HvARRAY(hv) = (HE**)array;
2841 }
2842
20439bc7 2843 placeholders = 0;
b3ca2e83 2844 while (chain) {
cbb1fbea 2845#ifdef USE_ITHREADS
b6bbf3fa 2846 U32 hash = chain->refcounted_he_hash;
cbb1fbea
NC
2847#else
2848 U32 hash = HEK_HASH(chain->refcounted_he_hek);
2849#endif
b3ca2e83
NC
2850 HE **oentry = &((HvARRAY(hv))[hash & max]);
2851 HE *entry = *oentry;
b6bbf3fa 2852 SV *value;
cbb1fbea 2853
b3ca2e83
NC
2854 for (; entry; entry = HeNEXT(entry)) {
2855 if (HeHASH(entry) == hash) {
9f769845
NC
2856 /* We might have a duplicate key here. If so, entry is older
2857 than the key we've already put in the hash, so if they are
2858 the same, skip adding entry. */
2859#ifdef USE_ITHREADS
2860 const STRLEN klen = HeKLEN(entry);
2861 const char *const key = HeKEY(entry);
2862 if (klen == chain->refcounted_he_keylen
2863 && (!!HeKUTF8(entry)
2864 == !!(chain->refcounted_he_data[0] & HVhek_UTF8))
2865 && memEQ(key, REF_HE_KEY(chain), klen))
2866 goto next_please;
2867#else
2868 if (HeKEY_hek(entry) == chain->refcounted_he_hek)
2869 goto next_please;
2870 if (HeKLEN(entry) == HEK_LEN(chain->refcounted_he_hek)
2871 && HeKUTF8(entry) == HEK_UTF8(chain->refcounted_he_hek)
2872 && memEQ(HeKEY(entry), HEK_KEY(chain->refcounted_he_hek),
2873 HeKLEN(entry)))
2874 goto next_please;
2875#endif
b3ca2e83
NC
2876 }
2877 }
2878 assert (!entry);
2879 entry = new_HE();
2880
cbb1fbea
NC
2881#ifdef USE_ITHREADS
2882 HeKEY_hek(entry)
7b0bddfa 2883 = share_hek_flags(REF_HE_KEY(chain),
b6bbf3fa
NC
2884 chain->refcounted_he_keylen,
2885 chain->refcounted_he_hash,
2886 (chain->refcounted_he_data[0]
2887 & (HVhek_UTF8|HVhek_WASUTF8)));
cbb1fbea 2888#else
71ad1b0c 2889 HeKEY_hek(entry) = share_hek_hek(chain->refcounted_he_hek);
cbb1fbea 2890#endif
7b0bddfa
NC
2891 value = refcounted_he_value(chain);
2892 if (value == &PL_sv_placeholder)
b3ca2e83 2893 placeholders++;
b6bbf3fa 2894 HeVAL(entry) = value;
b3ca2e83
NC
2895
2896 /* Link it into the chain. */
2897 HeNEXT(entry) = *oentry;
b3ca2e83
NC
2898 *oentry = entry;
2899
2900 HvTOTALKEYS(hv)++;
2901
2902 next_please:
71ad1b0c 2903 chain = chain->refcounted_he_next;
b3ca2e83
NC
2904 }
2905
2906 if (placeholders) {
2907 clear_placeholders(hv, placeholders);
2908 HvTOTALKEYS(hv) -= placeholders;
2909 }
2910
2911 /* We could check in the loop to see if we encounter any keys with key
2912 flags, but it's probably not worth it, as this per-hash flag is only
2913 really meant as an optimisation for things like Storable. */
2914 HvHASKFLAGS_on(hv);
def9038f 2915 DEBUG_A(Perl_hv_assert(aTHX_ hv));
b3ca2e83
NC
2916
2917 return hv;
2918}
2919
20439bc7
Z
2920/*
2921=for apidoc m|SV *|refcounted_he_fetch_pvn|const struct refcounted_he *chain|const char *keypv|STRLEN keylen|U32 hash|U32 flags
2922
2923Search along a C<refcounted_he> chain for an entry with the key specified
2924by I<keypv> and I<keylen>. If I<flags> has the C<REFCOUNTED_HE_KEY_UTF8>
2925bit set, the key octets are interpreted as UTF-8, otherwise they
2926are interpreted as Latin-1. I<hash> is a precomputed hash of the key
2927string, or zero if it has not been precomputed. Returns a mortal scalar
2928representing the value associated with the key, or C<&PL_sv_placeholder>
2929if there is no value associated with the key.
2930
2931=cut
2932*/
2933
7b0bddfa 2934SV *
20439bc7
Z
2935Perl_refcounted_he_fetch_pvn(pTHX_ const struct refcounted_he *chain,
2936 const char *keypv, STRLEN keylen, U32 hash, U32 flags)
7b0bddfa 2937{
0b2d3faa 2938 dVAR;
20439bc7
Z
2939 U8 utf8_flag;
2940 PERL_ARGS_ASSERT_REFCOUNTED_HE_FETCH_PVN;
7b0bddfa 2941
20439bc7
Z
2942 if (flags & ~REFCOUNTED_HE_KEY_UTF8)
2943 Perl_croak(aTHX_ "panic: refcounted_he_fetch_pvn bad flags %"UVxf,
2944 (UV)flags);
2945 if (!chain)
2946 return &PL_sv_placeholder;
2947 if (flags & REFCOUNTED_HE_KEY_UTF8) {
2948 /* For searching purposes, canonicalise to Latin-1 where possible. */
2949 const char *keyend = keypv + keylen, *p;
2950 STRLEN nonascii_count = 0;
2951 for (p = keypv; p != keyend; p++) {
2952 U8 c = (U8)*p;
2953 if (c & 0x80) {
2954 if (!((c & 0xfe) == 0xc2 && ++p != keyend &&
2955 (((U8)*p) & 0xc0) == 0x80))
2956 goto canonicalised_key;
2957 nonascii_count++;
2958 }
cd1d2f8a 2959 }
20439bc7
Z
2960 if (nonascii_count) {
2961 char *q;
2962 const char *p = keypv, *keyend = keypv + keylen;
2963 keylen -= nonascii_count;
2964 Newx(q, keylen, char);
2965 SAVEFREEPV(q);
2966 keypv = q;
2967 for (; p != keyend; p++, q++) {
2968 U8 c = (U8)*p;
2969 *q = (char)
2970 ((c & 0x80) ? ((c & 0x03) << 6) | (((U8)*++p) & 0x3f) : c);
cd1d2f8a
NC
2971 }
2972 }
20439bc7
Z
2973 flags &= ~REFCOUNTED_HE_KEY_UTF8;
2974 canonicalised_key: ;
2975 }
2976 utf8_flag = (flags & REFCOUNTED_HE_KEY_UTF8) ? HVhek_UTF8 : 0;
2977 if (!hash)
2978 PERL_HASH(hash, keypv, keylen);
7b0bddfa 2979
20439bc7
Z
2980 for (; chain; chain = chain->refcounted_he_next) {
2981 if (
7b0bddfa 2982#ifdef USE_ITHREADS
20439bc7
Z
2983 hash == chain->refcounted_he_hash &&
2984 keylen == chain->refcounted_he_keylen &&
2985 memEQ(REF_HE_KEY(chain), keypv, keylen) &&
2986 utf8_flag == (chain->refcounted_he_data[0] & HVhek_UTF8)
7b0bddfa 2987#else
20439bc7
Z
2988 hash == HEK_HASH(chain->refcounted_he_hek) &&
2989 keylen == (STRLEN)HEK_LEN(chain->refcounted_he_hek) &&
2990 memEQ(HEK_KEY(chain->refcounted_he_hek), keypv, keylen) &&
2991 utf8_flag == (HEK_FLAGS(chain->refcounted_he_hek) & HVhek_UTF8)
7b0bddfa 2992#endif
20439bc7
Z
2993 )
2994 return sv_2mortal(refcounted_he_value(chain));
7b0bddfa 2995 }
20439bc7
Z
2996 return &PL_sv_placeholder;
2997}
7b0bddfa 2998
20439bc7
Z
2999/*
3000=for apidoc m|SV *|refcounted_he_fetch_pv|const struct refcounted_he *chain|const char *key|U32 hash|U32 flags
7b0bddfa 3001
20439bc7
Z
3002Like L</refcounted_he_fetch_pvn>, but takes a nul-terminated string
3003instead of a string/length pair.
3004
3005=cut
3006*/
3007
3008SV *
3009Perl_refcounted_he_fetch_pv(pTHX_ const struct refcounted_he *chain,
3010 const char *key, U32 hash, U32 flags)
3011{
3012 PERL_ARGS_ASSERT_REFCOUNTED_HE_FETCH_PV;
3013 return refcounted_he_fetch_pvn(chain, key, strlen(key), hash, flags);
7b0bddfa
NC
3014}
3015
b3ca2e83 3016/*
20439bc7
Z
3017=for apidoc m|SV *|refcounted_he_fetch_sv|const struct refcounted_he *chain|SV *key|U32 hash|U32 flags
3018
3019Like L</refcounted_he_fetch_pvn>, but takes a Perl scalar instead of a
3020string/length pair.
3021
3022=cut
3023*/
b3ca2e83 3024
20439bc7
Z
3025SV *
3026Perl_refcounted_he_fetch_sv(pTHX_ const struct refcounted_he *chain,
3027 SV *key, U32 hash, U32 flags)
3028{
3029 const char *keypv;
3030 STRLEN keylen;
3031 PERL_ARGS_ASSERT_REFCOUNTED_HE_FETCH_SV;
3032 if (flags & REFCOUNTED_HE_KEY_UTF8)
3033 Perl_croak(aTHX_ "panic: refcounted_he_fetch_sv bad flags %"UVxf,
3034 (UV)flags);
3035 keypv = SvPV_const(key, keylen);
3036 if (SvUTF8(key))
3037 flags |= REFCOUNTED_HE_KEY_UTF8;
3038 if (!hash && SvIsCOW_shared_hash(key))
3039 hash = SvSHARED_HASH(key);
3040 return refcounted_he_fetch_pvn(chain, keypv, keylen, hash, flags);
3041}
3042
3043/*
3044=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
3045
3046Creates a new C<refcounted_he>. This consists of a single key/value
3047pair and a reference to an existing C<refcounted_he> chain (which may
3048be empty), and thus forms a longer chain. When using the longer chain,
3049the new key/value pair takes precedence over any entry for the same key
3050further along the chain.
3051
3052The new key is specified by I<keypv> and I<keylen>. If I<flags> has
3053the C<REFCOUNTED_HE_KEY_UTF8> bit set, the key octets are interpreted
3054as UTF-8, otherwise they are interpreted as Latin-1. I<hash> is
3055a precomputed hash of the key string, or zero if it has not been
3056precomputed.
3057
3058I<value> is the scalar value to store for this key. I<value> is copied
3059by this function, which thus does not take ownership of any reference
3060to it, and later changes to the scalar will not be reflected in the
3061value visible in the C<refcounted_he>. Complex types of scalar will not
3062be stored with referential integrity, but will be coerced to strings.
3063I<value> may be either null or C<&PL_sv_placeholder> to indicate that no
3064value is to be associated with the key; this, as with any non-null value,
3065takes precedence over the existence of a value for the key further along
3066the chain.
3067
3068I<parent> points to the rest of the C<refcounted_he> chain to be
3069attached to the new C<refcounted_he>. This function takes ownership
3070of one reference to I<parent>, and returns one reference to the new
3071C<refcounted_he>.
b3ca2e83
NC
3072
3073=cut
3074*/
3075
3076struct refcounted_he *
20439bc7
Z
3077Perl_refcounted_he_new_pvn(pTHX_ struct refcounted_he *parent,
3078 const char *keypv, STRLEN keylen, U32 hash, SV *value, U32 flags)
3079{
7a89be66 3080 dVAR;
b6bbf3fa 3081 STRLEN value_len = 0;
95b63a38 3082 const char *value_p = NULL;
20439bc7 3083 bool is_pv;
b6bbf3fa 3084 char value_type;
20439bc7
Z
3085 char hekflags;
3086 STRLEN key_offset = 1;
3087 struct refcounted_he *he;
3088 PERL_ARGS_ASSERT_REFCOUNTED_HE_NEW_PVN;
b6bbf3fa 3089
20439bc7
Z
3090 if (!value || value == &PL_sv_placeholder) {
3091 value_type = HVrhek_delete;
3092 } else if (SvPOK(value)) {
b6bbf3fa
NC
3093 value_type = HVrhek_PV;
3094 } else if (SvIOK(value)) {
ad64d0ec 3095 value_type = SvUOK((const SV *)value) ? HVrhek_UV : HVrhek_IV;
b6bbf3fa
NC
3096 } else if (!SvOK(value)) {
3097 value_type = HVrhek_undef;
3098 } else {
3099 value_type = HVrhek_PV;
3100 }
20439bc7
Z
3101 is_pv = value_type == HVrhek_PV;
3102 if (is_pv) {
012da8e5
NC
3103 /* Do it this way so that the SvUTF8() test is after the SvPV, in case
3104 the value is overloaded, and doesn't yet have the UTF-8flag set. */
b6bbf3fa 3105 value_p = SvPV_const(value, value_len);
012da8e5
NC
3106 if (SvUTF8(value))
3107 value_type = HVrhek_PV_UTF8;
20439bc7
Z
3108 key_offset = value_len + 2;
3109 }
3110 hekflags = value_type;
3111
3112 if (flags & REFCOUNTED_HE_KEY_UTF8) {
3113 /* Canonicalise to Latin-1 where possible. */
3114 const char *keyend = keypv + keylen, *p;
3115 STRLEN nonascii_count = 0;
3116 for (p = keypv; p != keyend; p++) {
3117 U8 c = (U8)*p;
3118 if (c & 0x80) {
3119 if (!((c & 0xfe) == 0xc2 && ++p != keyend &&
3120 (((U8)*p) & 0xc0) == 0x80))
3121 goto canonicalised_key;
3122 nonascii_count++;
3123 }
3124 }
3125 if (nonascii_count) {
3126 char *q;
3127 const char *p = keypv, *keyend = keypv + keylen;
3128 keylen -= nonascii_count;
3129 Newx(q, keylen, char);
3130 SAVEFREEPV(q);
3131 keypv = q;
3132 for (; p != keyend; p++, q++) {
3133 U8 c = (U8)*p;
3134 *q = (char)
3135 ((c & 0x80) ? ((c & 0x03) << 6) | (((U8)*++p) & 0x3f) : c);
3136 }
3137 }
3138 flags &= ~REFCOUNTED_HE_KEY_UTF8;
3139 canonicalised_key: ;
b6bbf3fa 3140 }
20439bc7
Z
3141 if (flags & REFCOUNTED_HE_KEY_UTF8)
3142 hekflags |= HVhek_UTF8;
3143 if (!hash)
3144 PERL_HASH(hash, keypv, keylen);
012da8e5 3145
0de694c5 3146#ifdef USE_ITHREADS
10edeb5d
JH
3147 he = (struct refcounted_he*)
3148 PerlMemShared_malloc(sizeof(struct refcounted_he) - 1
20439bc7 3149 + keylen
20439bc7 3150 + key_offset);
0de694c5
NC
3151#else
3152 he = (struct refcounted_he*)
3153 PerlMemShared_malloc(sizeof(struct refcounted_he) - 1
3154 + key_offset);
3155#endif
b3ca2e83 3156
71ad1b0c 3157 he->refcounted_he_next = parent;
b6bbf3fa 3158
012da8e5 3159 if (is_pv) {
20439bc7 3160 Copy(value_p, he->refcounted_he_data + 1, value_len + 1, char);
b6bbf3fa 3161 he->refcounted_he_val.refcounted_he_u_len = value_len;
b6bbf3fa 3162 } else if (value_type == HVrhek_IV) {
20439bc7 3163 he->refcounted_he_val.refcounted_he_u_iv = SvIVX(value);
012da8e5 3164 } else if (value_type == HVrhek_UV) {
20439bc7 3165 he->refcounted_he_val.refcounted_he_u_uv = SvUVX(value);
b6bbf3fa
NC
3166 }
3167
cbb1fbea 3168#ifdef USE_ITHREADS
b6bbf3fa 3169 he->refcounted_he_hash = hash;
20439bc7
Z
3170 he->refcounted_he_keylen = keylen;
3171 Copy(keypv, he->refcounted_he_data + key_offset, keylen, char);
cbb1fbea 3172#else
20439bc7 3173 he->refcounted_he_hek = share_hek_flags(keypv, keylen, hash, hekflags);
cbb1fbea 3174#endif
b6bbf3fa 3175
20439bc7 3176 he->refcounted_he_data[0] = hekflags;
b3ca2e83
NC
3177 he->refcounted_he_refcnt = 1;
3178
3179 return he;
3180}
3181
3182/*
20439bc7 3183=for apidoc m|struct refcounted_he *|refcounted_he_new_pv|struct refcounted_he *parent|const char *key|U32 hash|SV *value|U32 flags
b3ca2e83 3184
20439bc7
Z
3185Like L</refcounted_he_new_pvn>, but takes a nul-terminated string instead
3186of a string/length pair.
3187
3188=cut
3189*/
3190
3191struct refcounted_he *
3192Perl_refcounted_he_new_pv(pTHX_ struct refcounted_he *parent,
3193 const char *key, U32 hash, SV *value, U32 flags)
3194{
3195 PERL_ARGS_ASSERT_REFCOUNTED_HE_NEW_PV;
3196 return refcounted_he_new_pvn(parent, key, strlen(key), hash, value, flags);
3197}
3198
3199/*
3200=for apidoc m|struct refcounted_he *|refcounted_he_new_sv|struct refcounted_he *parent|SV *key|U32 hash|SV *value|U32 flags
3201
3202Like L</refcounted_he_new_pvn>, but takes a Perl scalar instead of a
3203string/length pair.
3204
3205=cut
3206*/
3207
3208struct refcounted_he *
3209Perl_refcounted_he_new_sv(pTHX_ struct refcounted_he *parent,
3210 SV *key, U32 hash, SV *value, U32 flags)
3211{
3212 const char *keypv;
3213 STRLEN keylen;
3214 PERL_ARGS_ASSERT_REFCOUNTED_HE_NEW_SV;
3215 if (flags & REFCOUNTED_HE_KEY_UTF8)
3216 Perl_croak(aTHX_ "panic: refcounted_he_new_sv bad flags %"UVxf,
3217 (UV)flags);
3218 keypv = SvPV_const(key, keylen);
3219 if (SvUTF8(key))
3220 flags |= REFCOUNTED_HE_KEY_UTF8;
3221 if (!hash && SvIsCOW_shared_hash(key))
3222 hash = SvSHARED_HASH(key);
3223 return refcounted_he_new_pvn(parent, keypv, keylen, hash, value, flags);
3224}
3225
3226/*
3227=for apidoc m|void|refcounted_he_free|struct refcounted_he *he
3228
3229Decrements the reference count of a C<refcounted_he> by one. If the
3230reference count reaches zero the structure's memory is freed, which
3231(recursively) causes a reduction of its parent C<refcounted_he>'s
3232reference count. It is safe to pass a null pointer to this function:
3233no action occurs in this case.
b3ca2e83
NC
3234
3235=cut
3236*/
3237
3238void
3239Perl_refcounted_he_free(pTHX_ struct refcounted_he *he) {
53d44271 3240 dVAR;
57ca3b03
AL
3241 PERL_UNUSED_CONTEXT;
3242
b3ca2e83
NC
3243 while (he) {
3244 struct refcounted_he *copy;
cbb1fbea 3245 U32 new_count;
b3ca2e83 3246
cbb1fbea
NC
3247 HINTS_REFCNT_LOCK;
3248 new_count = --he->refcounted_he_refcnt;
3249 HINTS_REFCNT_UNLOCK;
3250
3251 if (new_count) {
b3ca2e83 3252 return;
cbb1fbea 3253 }
b3ca2e83 3254
b6bbf3fa 3255#ifndef USE_ITHREADS
71ad1b0c 3256 unshare_hek_or_pvn (he->refcounted_he_hek, 0, 0, 0);
cbb1fbea 3257#endif
b3ca2e83 3258 copy = he;
71ad1b0c 3259 he = he->refcounted_he_next;
b6bbf3fa 3260 PerlMemShared_free(copy);
b3ca2e83
NC
3261 }
3262}
3263
20439bc7
Z
3264/*
3265=for apidoc m|struct refcounted_he *|refcounted_he_inc|struct refcounted_he *he
3266
3267Increment the reference count of a C<refcounted_he>. The pointer to the
3268C<refcounted_he> is also returned. It is safe to pass a null pointer
3269to this function: no action occurs and a null pointer is returned.
3270
3271=cut
3272*/
3273
3274struct refcounted_he *
3275Perl_refcounted_he_inc(pTHX_ struct refcounted_he *he)
3276{
09ddd873 3277 dVAR;
20439bc7
Z
3278 if (he) {
3279 HINTS_REFCNT_LOCK;
3280 he->refcounted_he_refcnt++;
3281 HINTS_REFCNT_UNLOCK;
3282 }
3283 return he;
3284}
3285
47550813
NC
3286/* pp_entereval is aware that labels are stored with a key ':' at the top of
3287 the linked list. */
dca6062a 3288const char *
ce42d03d 3289Perl_fetch_cop_label(pTHX_ COP *const cop, STRLEN *len, U32 *flags) {
d6747b7a
NC
3290 struct refcounted_he *const chain = cop->cop_hints_hash;
3291
3292 PERL_ARGS_ASSERT_FETCH_COP_LABEL;
3293
dca6062a
NC
3294 if (!chain)
3295 return NULL;
3296#ifdef USE_ITHREADS
3297 if (chain->refcounted_he_keylen != 1)
3298 return NULL;
3299 if (*REF_HE_KEY(chain) != ':')
3300 return NULL;
3301#else
3302 if ((STRLEN)HEK_LEN(chain->refcounted_he_hek) != 1)
3303 return NULL;
3304 if (*HEK_KEY(chain->refcounted_he_hek) != ':')
3305 return NULL;
3306#endif
012da8e5
NC
3307 /* Stop anyone trying to really mess us up by adding their own value for
3308 ':' into %^H */
3309 if ((chain->refcounted_he_data[0] & HVrhek_typemask) != HVrhek_PV
3310 && (chain->refcounted_he_data[0] & HVrhek_typemask) != HVrhek_PV_UTF8)
3311 return NULL;
3312
dca6062a
NC
3313 if (len)
3314 *len = chain->refcounted_he_val.refcounted_he_u_len;
3315 if (flags) {
3316 *flags = ((chain->refcounted_he_data[0] & HVrhek_typemask)
3317 == HVrhek_PV_UTF8) ? SVf_UTF8 : 0;
3318 }
3319 return chain->refcounted_he_data + 1;
3320}
3321
a77ac40c
NC
3322void
3323Perl_store_cop_label(pTHX_ COP *const cop, const char *label, STRLEN len,
3324 U32 flags)
012da8e5 3325{
20439bc7 3326 SV *labelsv;
547bb267
NC
3327 PERL_ARGS_ASSERT_STORE_COP_LABEL;
3328
a77ac40c
NC
3329 if (flags & ~(SVf_UTF8))
3330 Perl_croak(aTHX_ "panic: store_cop_label illegal flag bits 0x%" UVxf,
3331 (UV)flags);
a3179684 3332 labelsv = newSVpvn_flags(label, len, SVs_TEMP);
20439bc7
Z
3333 if (flags & SVf_UTF8)
3334 SvUTF8_on(labelsv);
a77ac40c 3335 cop->cop_hints_hash
20439bc7 3336 = refcounted_he_new_pvs(cop->cop_hints_hash, ":", labelsv, 0);
012da8e5
NC
3337}
3338
b3ca2e83 3339/*
ecae49c0
NC
3340=for apidoc hv_assert
3341
3342Check that a hash is in an internally consistent state.
3343
3344=cut
3345*/
3346
943795c2
NC
3347#ifdef DEBUGGING
3348
ecae49c0
NC
3349void
3350Perl_hv_assert(pTHX_ HV *hv)
3351{
57ca3b03
AL
3352 dVAR;
3353 HE* entry;
3354 int withflags = 0;
3355 int placeholders = 0;
3356 int real = 0;
3357 int bad = 0;
3358 const I32 riter = HvRITER_get(hv);
3359 HE *eiter = HvEITER_get(hv);
3360
7918f24d
NC
3361 PERL_ARGS_ASSERT_HV_ASSERT;
3362
57ca3b03
AL
3363 (void)hv_iterinit(hv);
3364
3365 while ((entry = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS))) {
3366 /* sanity check the values */
3367 if (HeVAL(entry) == &PL_sv_placeholder)
3368 placeholders++;
3369 else
3370 real++;
3371 /* sanity check the keys */
3372 if (HeSVKEY(entry)) {
6f207bd3 3373 NOOP; /* Don't know what to check on SV keys. */
57ca3b03
AL
3374 } else if (HeKUTF8(entry)) {
3375 withflags++;
3376 if (HeKWASUTF8(entry)) {
3377 PerlIO_printf(Perl_debug_log,
d2a455e7 3378 "hash key has both WASUTF8 and UTF8: '%.*s'\n",
57ca3b03
AL
3379 (int) HeKLEN(entry), HeKEY(entry));
3380 bad = 1;
3381 }
3382 } else if (HeKWASUTF8(entry))
3383 withflags++;
3384 }
ad64d0ec 3385 if (!SvTIED_mg((const SV *)hv, PERL_MAGIC_tied)) {
57ca3b03
AL
3386 static const char bad_count[] = "Count %d %s(s), but hash reports %d\n";
3387 const int nhashkeys = HvUSEDKEYS(hv);
3388 const int nhashplaceholders = HvPLACEHOLDERS_get(hv);
3389
3390 if (nhashkeys != real) {
3391 PerlIO_printf(Perl_debug_log, bad_count, real, "keys", nhashkeys );
3392 bad = 1;
3393 }
3394 if (nhashplaceholders != placeholders) {
3395 PerlIO_printf(Perl_debug_log, bad_count, placeholders, "placeholder", nhashplaceholders );
3396 bad = 1;
3397 }
3398 }
3399 if (withflags && ! HvHASKFLAGS(hv)) {
3400 PerlIO_printf(Perl_debug_log,
3401 "Hash has HASKFLAGS off but I count %d key(s) with flags\n",
3402 withflags);
3403 bad = 1;
3404 }
3405 if (bad) {
ad64d0ec 3406 sv_dump(MUTABLE_SV(hv));
57ca3b03
AL
3407 }
3408 HvRITER_set(hv, riter); /* Restore hash iterator state */
3409 HvEITER_set(hv, eiter);
ecae49c0 3410}
af3babe4 3411
943795c2
NC
3412#endif
3413
af3babe4
NC
3414/*
3415 * Local variables:
3416 * c-indentation-style: bsd
3417 * c-basic-offset: 4
3418 * indent-tabs-mode: t
3419 * End:
3420 *
37442d52
RGS
3421 * ex: set ts=8 sts=4 sw=4 noet:
3422 */