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