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