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