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