This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Implement hv_delayfree_ent in terms of hv_free_ent
[perl5.git] / hv.c
CommitLineData
a0d0e21e 1/* hv.c
79072805 2 *
4bb101f2 3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
af3babe4 4 * 2000, 2001, 2002, 2003, 2004, 2005, 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/*
12 * "I sit beside the fire and think of all that I have seen." --Bilbo
79072805
LW
13 */
14
d5afce77
RB
15/*
16=head1 Hash Manipulation Functions
166f8a29
DM
17
18A HV structure represents a Perl hash. It consists mainly of an array
19of pointers, each of which points to a linked list of HE structures. The
20array is indexed by the hash function of the key, so each linked list
21represents all the hash entries with the same hash value. Each HE contains
22a pointer to the actual value, plus a pointer to a HEK structure which
23holds the key and hash value.
24
25=cut
26
d5afce77
RB
27*/
28
79072805 29#include "EXTERN.h"
864dbfa3 30#define PERL_IN_HV_C
3d78eb94 31#define PERL_HASH_INTERNAL_ACCESS
79072805
LW
32#include "perl.h"
33
d8012aaf 34#define HV_MAX_LENGTH_BEFORE_SPLIT 14
fdcd69b6 35
5d2b1485
NC
36static const char *const S_strtab_error
37 = "Cannot modify shared string table in hv_%s";
38
cac9b346
NC
39STATIC void
40S_more_he(pTHX)
41{
42 HE* he;
43 HE* heend;
44 New(54, he, PERL_ARENA_SIZE/sizeof(HE), HE);
45 HeNEXT(he) = PL_he_arenaroot;
46 PL_he_arenaroot = he;
47
48 heend = &he[PERL_ARENA_SIZE / sizeof(HE) - 1];
49 PL_he_root = ++he;
50 while (he < heend) {
51 HeNEXT(he) = (HE*)(he + 1);
52 he++;
53 }
54 HeNEXT(he) = 0;
55}
56
c941fb51
NC
57#ifdef PURIFY
58
59#define new_HE() (HE*)safemalloc(sizeof(HE))
60#define del_HE(p) safefree((char*)p)
61
62#else
63
76e3520e 64STATIC HE*
cea2e8a9 65S_new_he(pTHX)
4633a7c4
LW
66{
67 HE* he;
333f433b
DG
68 LOCK_SV_MUTEX;
69 if (!PL_he_root)
cac9b346 70 S_more_he(aTHX);
333f433b
DG
71 he = PL_he_root;
72 PL_he_root = HeNEXT(he);
73 UNLOCK_SV_MUTEX;
74 return he;
4633a7c4
LW
75}
76
c941fb51
NC
77#define new_HE() new_he()
78#define del_HE(p) \
79 STMT_START { \
80 LOCK_SV_MUTEX; \
81 HeNEXT(p) = (HE*)PL_he_root; \
82 PL_he_root = p; \
83 UNLOCK_SV_MUTEX; \
84 } STMT_END
d33b2eba 85
d33b2eba 86
d33b2eba
GS
87
88#endif
89
76e3520e 90STATIC HEK *
19692e8d 91S_save_hek_flags(pTHX_ const char *str, I32 len, U32 hash, int flags)
bbce6d69 92{
35a4481c 93 const int flags_masked = flags & HVhek_MASK;
bbce6d69
PP
94 char *k;
95 register HEK *hek;
1c846c1f 96
e05949c7 97 New(54, k, HEK_BASESIZE + len + 2, char);
bbce6d69 98 hek = (HEK*)k;
ff68c719 99 Copy(str, HEK_KEY(hek), len, char);
e05949c7 100 HEK_KEY(hek)[len] = 0;
ff68c719
PP
101 HEK_LEN(hek) = len;
102 HEK_HASH(hek) = hash;
dcf933a4
NC
103 HEK_FLAGS(hek) = (unsigned char)flags_masked;
104
105 if (flags & HVhek_FREEKEY)
106 Safefree(str);
bbce6d69
PP
107 return hek;
108}
109
dd28f7bb
DM
110/* free the pool of temporary HE/HEK pairs retunrned by hv_fetch_ent
111 * for tied hashes */
112
113void
114Perl_free_tied_hv_pool(pTHX)
115{
dd28f7bb
DM
116 HE *he = PL_hv_fetch_ent_mh;
117 while (he) {
9d4ba2ae 118 HE * const ohe = he;
dd28f7bb 119 Safefree(HeKEY_hek(he));
dd28f7bb
DM
120 he = HeNEXT(he);
121 del_HE(ohe);
122 }
bf9cdc68 123 PL_hv_fetch_ent_mh = Nullhe;
dd28f7bb
DM
124}
125
d18c6117 126#if defined(USE_ITHREADS)
0bff533c
NC
127HEK *
128Perl_hek_dup(pTHX_ HEK *source, CLONE_PARAMS* param)
129{
658b4a4a 130 HEK *shared = (HEK*)ptr_table_fetch(PL_ptr_table, source);
9d4ba2ae
AL
131
132 PERL_UNUSED_ARG(param);
0bff533c
NC
133
134 if (shared) {
135 /* We already shared this hash key. */
454f1e26 136 (void)share_hek_hek(shared);
0bff533c
NC
137 }
138 else {
658b4a4a 139 shared
6e838c70
NC
140 = share_hek_flags(HEK_KEY(source), HEK_LEN(source),
141 HEK_HASH(source), HEK_FLAGS(source));
658b4a4a 142 ptr_table_store(PL_ptr_table, source, shared);
0bff533c 143 }
658b4a4a 144 return shared;
0bff533c
NC
145}
146
d18c6117 147HE *
a8fc9800 148Perl_he_dup(pTHX_ HE *e, bool shared, CLONE_PARAMS* param)
d18c6117
GS
149{
150 HE *ret;
151
152 if (!e)
153 return Nullhe;
7766f137
GS
154 /* look for it in the table first */
155 ret = (HE*)ptr_table_fetch(PL_ptr_table, e);
156 if (ret)
157 return ret;
158
159 /* create anew and remember what it is */
d33b2eba 160 ret = new_HE();
7766f137
GS
161 ptr_table_store(PL_ptr_table, e, ret);
162
d2d73c3e 163 HeNEXT(ret) = he_dup(HeNEXT(e),shared, param);
dd28f7bb
DM
164 if (HeKLEN(e) == HEf_SVKEY) {
165 char *k;
166 New(54, k, HEK_BASESIZE + sizeof(SV*), char);
167 HeKEY_hek(ret) = (HEK*)k;
d2d73c3e 168 HeKEY_sv(ret) = SvREFCNT_inc(sv_dup(HeKEY_sv(e), param));
dd28f7bb 169 }
c21d1a0f 170 else if (shared) {
0bff533c
NC
171 /* This is hek_dup inlined, which seems to be important for speed
172 reasons. */
1b6737cc 173 HEK * const source = HeKEY_hek(e);
658b4a4a 174 HEK *shared = (HEK*)ptr_table_fetch(PL_ptr_table, source);
c21d1a0f
NC
175
176 if (shared) {
177 /* We already shared this hash key. */
454f1e26 178 (void)share_hek_hek(shared);
c21d1a0f
NC
179 }
180 else {
658b4a4a 181 shared
6e838c70
NC
182 = share_hek_flags(HEK_KEY(source), HEK_LEN(source),
183 HEK_HASH(source), HEK_FLAGS(source));
658b4a4a 184 ptr_table_store(PL_ptr_table, source, shared);
c21d1a0f 185 }
658b4a4a 186 HeKEY_hek(ret) = shared;
c21d1a0f 187 }
d18c6117 188 else
19692e8d
NC
189 HeKEY_hek(ret) = save_hek_flags(HeKEY(e), HeKLEN(e), HeHASH(e),
190 HeKFLAGS(e));
d2d73c3e 191 HeVAL(ret) = SvREFCNT_inc(sv_dup(HeVAL(e), param));
d18c6117
GS
192 return ret;
193}
194#endif /* USE_ITHREADS */
195
1b1f1335 196static void
2393f1b9
JH
197S_hv_notallowed(pTHX_ int flags, const char *key, I32 klen,
198 const char *msg)
1b1f1335 199{
1b6737cc 200 SV * const sv = sv_newmortal();
19692e8d 201 if (!(flags & HVhek_FREEKEY)) {
1b1f1335
NIS
202 sv_setpvn(sv, key, klen);
203 }
204 else {
205 /* Need to free saved eventually assign to mortal SV */
34c3c4e3 206 /* XXX is this line an error ???: SV *sv = sv_newmortal(); */
1b1f1335
NIS
207 sv_usepvn(sv, (char *) key, klen);
208 }
19692e8d 209 if (flags & HVhek_UTF8) {
1b1f1335
NIS
210 SvUTF8_on(sv);
211 }
c8cd6465 212 Perl_croak(aTHX_ msg, sv);
1b1f1335
NIS
213}
214
fde52b5c
PP
215/* (klen == HEf_SVKEY) is special for MAGICAL hv entries, meaning key slot
216 * contains an SV* */
217
34a6f7b4
NC
218#define HV_FETCH_ISSTORE 0x01
219#define HV_FETCH_ISEXISTS 0x02
220#define HV_FETCH_LVALUE 0x04
221#define HV_FETCH_JUST_SV 0x08
222
223/*
224=for apidoc hv_store
225
226Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
227the length of the key. The C<hash> parameter is the precomputed hash
228value; if it is zero then Perl will compute it. The return value will be
229NULL if the operation failed or if the value did not need to be actually
230stored within the hash (as in the case of tied hashes). Otherwise it can
231be dereferenced to get the original C<SV*>. Note that the caller is
232responsible for suitably incrementing the reference count of C<val> before
233the call, and decrementing it if the function returned NULL. Effectively
234a successful hv_store takes ownership of one reference to C<val>. This is
235usually what you want; a newly created SV has a reference count of one, so
236if all your code does is create SVs then store them in a hash, hv_store
237will own the only reference to the new SV, and your code doesn't need to do
238anything further to tidy up. hv_store is not implemented as a call to
239hv_store_ent, and does not create a temporary SV for the key, so if your
240key data is not already in SV form then use hv_store in preference to
241hv_store_ent.
242
243See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
244information on how to use this function on tied hashes.
245
246=cut
247*/
248
249SV**
250Perl_hv_store(pTHX_ HV *hv, const char *key, I32 klen_i32, SV *val, U32 hash)
251{
252 HE *hek;
253 STRLEN klen;
254 int flags;
255
256 if (klen_i32 < 0) {
257 klen = -klen_i32;
258 flags = HVhek_UTF8;
259 } else {
260 klen = klen_i32;
261 flags = 0;
262 }
263 hek = hv_fetch_common (hv, NULL, key, klen, flags,
52d01cc2 264 (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV), val, hash);
34a6f7b4
NC
265 return hek ? &HeVAL(hek) : NULL;
266}
267
268SV**
269Perl_hv_store_flags(pTHX_ HV *hv, const char *key, I32 klen, SV *val,
270 register U32 hash, int flags)
271{
9d4ba2ae 272 HE * const hek = hv_fetch_common (hv, NULL, key, klen, flags,
34a6f7b4
NC
273 (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV), val, hash);
274 return hek ? &HeVAL(hek) : NULL;
275}
276
277/*
278=for apidoc hv_store_ent
279
280Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
281parameter is the precomputed hash value; if it is zero then Perl will
282compute it. The return value is the new hash entry so created. It will be
283NULL if the operation failed or if the value did not need to be actually
284stored within the hash (as in the case of tied hashes). Otherwise the
285contents of the return value can be accessed using the C<He?> macros
286described here. Note that the caller is responsible for suitably
287incrementing the reference count of C<val> before the call, and
288decrementing it if the function returned NULL. Effectively a successful
289hv_store_ent takes ownership of one reference to C<val>. This is
290usually what you want; a newly created SV has a reference count of one, so
291if all your code does is create SVs then store them in a hash, hv_store
292will own the only reference to the new SV, and your code doesn't need to do
293anything further to tidy up. Note that hv_store_ent only reads the C<key>;
294unlike C<val> it does not take ownership of it, so maintaining the correct
295reference count on C<key> is entirely the caller's responsibility. hv_store
296is not implemented as a call to hv_store_ent, and does not create a temporary
297SV for the key, so if your key data is not already in SV form then use
298hv_store in preference to hv_store_ent.
299
300See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
301information on how to use this function on tied hashes.
302
303=cut
304*/
305
306HE *
307Perl_hv_store_ent(pTHX_ HV *hv, SV *keysv, SV *val, U32 hash)
308{
309 return hv_fetch_common(hv, keysv, NULL, 0, 0, HV_FETCH_ISSTORE, val, hash);
310}
311
312/*
313=for apidoc hv_exists
314
315Returns a boolean indicating whether the specified hash key exists. The
316C<klen> is the length of the key.
317
318=cut
319*/
320
321bool
322Perl_hv_exists(pTHX_ HV *hv, const char *key, I32 klen_i32)
323{
324 STRLEN klen;
325 int flags;
326
327 if (klen_i32 < 0) {
328 klen = -klen_i32;
329 flags = HVhek_UTF8;
330 } else {
331 klen = klen_i32;
332 flags = 0;
333 }
334 return hv_fetch_common(hv, NULL, key, klen, flags, HV_FETCH_ISEXISTS, 0, 0)
335 ? TRUE : FALSE;
336}
337
954c1994
GS
338/*
339=for apidoc hv_fetch
340
341Returns the SV which corresponds to the specified key in the hash. The
342C<klen> is the length of the key. If C<lval> is set then the fetch will be
343part of a store. Check that the return value is non-null before
d1be9408 344dereferencing it to an C<SV*>.
954c1994 345
96f1132b 346See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
954c1994
GS
347information on how to use this function on tied hashes.
348
349=cut
350*/
351
79072805 352SV**
c1fe5510 353Perl_hv_fetch(pTHX_ HV *hv, const char *key, I32 klen_i32, I32 lval)
79072805 354{
c1fe5510
NC
355 HE *hek;
356 STRLEN klen;
357 int flags;
358
359 if (klen_i32 < 0) {
360 klen = -klen_i32;
361 flags = HVhek_UTF8;
362 } else {
363 klen = klen_i32;
364 flags = 0;
365 }
366 hek = hv_fetch_common (hv, NULL, key, klen, flags,
b2c64049
NC
367 HV_FETCH_JUST_SV | (lval ? HV_FETCH_LVALUE : 0),
368 Nullsv, 0);
113738bb 369 return hek ? &HeVAL(hek) : NULL;
79072805
LW
370}
371
34a6f7b4
NC
372/*
373=for apidoc hv_exists_ent
374
375Returns a boolean indicating whether the specified hash key exists. C<hash>
376can be a valid precomputed hash value, or 0 to ask for it to be
377computed.
378
379=cut
380*/
381
382bool
383Perl_hv_exists_ent(pTHX_ HV *hv, SV *keysv, U32 hash)
384{
385 return hv_fetch_common(hv, keysv, NULL, 0, 0, HV_FETCH_ISEXISTS, 0, hash)
386 ? TRUE : FALSE;
387}
388
d1be9408 389/* returns an HE * structure with the all fields set */
fde52b5c 390/* note that hent_val will be a mortal sv for MAGICAL hashes */
954c1994
GS
391/*
392=for apidoc hv_fetch_ent
393
394Returns the hash entry which corresponds to the specified key in the hash.
395C<hash> must be a valid precomputed hash number for the given C<key>, or 0
396if you want the function to compute it. IF C<lval> is set then the fetch
397will be part of a store. Make sure the return value is non-null before
398accessing it. The return value when C<tb> is a tied hash is a pointer to a
399static location, so be sure to make a copy of the structure if you need to
1c846c1f 400store it somewhere.
954c1994 401
96f1132b 402See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
954c1994
GS
403information on how to use this function on tied hashes.
404
405=cut
406*/
407
fde52b5c 408HE *
864dbfa3 409Perl_hv_fetch_ent(pTHX_ HV *hv, SV *keysv, I32 lval, register U32 hash)
fde52b5c 410{
7f66fda2 411 return hv_fetch_common(hv, keysv, NULL, 0, 0,
b2c64049 412 (lval ? HV_FETCH_LVALUE : 0), Nullsv, hash);
113738bb
NC
413}
414
8f8d40ab 415STATIC HE *
c1fe5510 416S_hv_fetch_common(pTHX_ HV *hv, SV *keysv, const char *key, STRLEN klen,
b2c64049 417 int flags, int action, SV *val, register U32 hash)
113738bb 418{
27da23d5 419 dVAR;
b2c64049 420 XPVHV* xhv;
b2c64049
NC
421 HE *entry;
422 HE **oentry;
fde52b5c 423 SV *sv;
da58a35d 424 bool is_utf8;
113738bb 425 int masked_flags;
fde52b5c
PP
426
427 if (!hv)
428 return 0;
429
113738bb 430 if (keysv) {
e593d2fe
AE
431 if (flags & HVhek_FREEKEY)
432 Safefree(key);
5c144d81 433 key = SvPV_const(keysv, klen);
c1fe5510 434 flags = 0;
113738bb
NC
435 is_utf8 = (SvUTF8(keysv) != 0);
436 } else {
c1fe5510 437 is_utf8 = ((flags & HVhek_UTF8) ? TRUE : FALSE);
113738bb 438 }
113738bb 439
b2c64049 440 xhv = (XPVHV*)SvANY(hv);
7f66fda2
NC
441 if (SvMAGICAL(hv)) {
442 if (SvRMAGICAL(hv) && !(action & (HV_FETCH_ISSTORE|HV_FETCH_ISEXISTS)))
443 {
444 if (mg_find((SV*)hv, PERL_MAGIC_tied) || SvGMAGICAL((SV*)hv)) {
445 sv = sv_newmortal();
113738bb 446
7f66fda2
NC
447 /* XXX should be able to skimp on the HE/HEK here when
448 HV_FETCH_JUST_SV is true. */
113738bb 449
7f66fda2
NC
450 if (!keysv) {
451 keysv = newSVpvn(key, klen);
452 if (is_utf8) {
453 SvUTF8_on(keysv);
454 }
455 } else {
456 keysv = newSVsv(keysv);
113738bb 457 }
7f66fda2
NC
458 mg_copy((SV*)hv, sv, (char *)keysv, HEf_SVKEY);
459
460 /* grab a fake HE/HEK pair from the pool or make a new one */
461 entry = PL_hv_fetch_ent_mh;
462 if (entry)
463 PL_hv_fetch_ent_mh = HeNEXT(entry);
464 else {
465 char *k;
466 entry = new_HE();
467 New(54, k, HEK_BASESIZE + sizeof(SV*), char);
468 HeKEY_hek(entry) = (HEK*)k;
469 }
470 HeNEXT(entry) = Nullhe;
471 HeSVKEY_set(entry, keysv);
472 HeVAL(entry) = sv;
473 sv_upgrade(sv, SVt_PVLV);
474 LvTYPE(sv) = 'T';
475 /* so we can free entry when freeing sv */
476 LvTARG(sv) = (SV*)entry;
477
478 /* XXX remove at some point? */
479 if (flags & HVhek_FREEKEY)
480 Safefree(key);
481
482 return entry;
113738bb 483 }
7f66fda2
NC
484#ifdef ENV_IS_CASELESS
485 else if (mg_find((SV*)hv, PERL_MAGIC_env)) {
486 U32 i;
487 for (i = 0; i < klen; ++i)
488 if (isLOWER(key[i])) {
086cb327
NC
489 /* Would be nice if we had a routine to do the
490 copy and upercase in a single pass through. */
e1ec3a88 491 const char *nkey = strupr(savepvn(key,klen));
086cb327
NC
492 /* Note that this fetch is for nkey (the uppercased
493 key) whereas the store is for key (the original) */
494 entry = hv_fetch_common(hv, Nullsv, nkey, klen,
495 HVhek_FREEKEY, /* free nkey */
496 0 /* non-LVAL fetch */,
497 Nullsv /* no value */,
498 0 /* compute hash */);
499 if (!entry && (action & HV_FETCH_LVALUE)) {
500 /* This call will free key if necessary.
501 Do it this way to encourage compiler to tail
502 call optimise. */
503 entry = hv_fetch_common(hv, keysv, key, klen,
504 flags, HV_FETCH_ISSTORE,
505 NEWSV(61,0), hash);
506 } else {
507 if (flags & HVhek_FREEKEY)
508 Safefree(key);
509 }
510 return entry;
7f66fda2 511 }
902173a3 512 }
7f66fda2
NC
513#endif
514 } /* ISFETCH */
515 else if (SvRMAGICAL(hv) && (action & HV_FETCH_ISEXISTS)) {
516 if (mg_find((SV*)hv, PERL_MAGIC_tied) || SvGMAGICAL((SV*)hv)) {
b2c64049
NC
517 /* I don't understand why hv_exists_ent has svret and sv,
518 whereas hv_exists only had one. */
9d4ba2ae 519 SV * const svret = sv_newmortal();
b2c64049 520 sv = sv_newmortal();
7f66fda2
NC
521
522 if (keysv || is_utf8) {
523 if (!keysv) {
524 keysv = newSVpvn(key, klen);
525 SvUTF8_on(keysv);
526 } else {
527 keysv = newSVsv(keysv);
528 }
b2c64049
NC
529 mg_copy((SV*)hv, sv, (char *)sv_2mortal(keysv), HEf_SVKEY);
530 } else {
531 mg_copy((SV*)hv, sv, key, klen);
7f66fda2 532 }
b2c64049
NC
533 if (flags & HVhek_FREEKEY)
534 Safefree(key);
7f66fda2
NC
535 magic_existspack(svret, mg_find(sv, PERL_MAGIC_tiedelem));
536 /* This cast somewhat evil, but I'm merely using NULL/
537 not NULL to return the boolean exists.
538 And I know hv is not NULL. */
539 return SvTRUE(svret) ? (HE *)hv : NULL;
e7152ba2 540 }
7f66fda2
NC
541#ifdef ENV_IS_CASELESS
542 else if (mg_find((SV*)hv, PERL_MAGIC_env)) {
543 /* XXX This code isn't UTF8 clean. */
a15d23f8 544 char * const keysave = (char * const)key;
b2c64049
NC
545 /* Will need to free this, so set FREEKEY flag. */
546 key = savepvn(key,klen);
547 key = (const char*)strupr((char*)key);
7f66fda2
NC
548 is_utf8 = 0;
549 hash = 0;
8b4f7dd5 550 keysv = 0;
b2c64049
NC
551
552 if (flags & HVhek_FREEKEY) {
553 Safefree(keysave);
554 }
555 flags |= HVhek_FREEKEY;
7f66fda2 556 }
902173a3 557#endif
7f66fda2 558 } /* ISEXISTS */
b2c64049
NC
559 else if (action & HV_FETCH_ISSTORE) {
560 bool needs_copy;
561 bool needs_store;
562 hv_magic_check (hv, &needs_copy, &needs_store);
563 if (needs_copy) {
a3b680e6 564 const bool save_taint = PL_tainted;
b2c64049
NC
565 if (keysv || is_utf8) {
566 if (!keysv) {
567 keysv = newSVpvn(key, klen);
568 SvUTF8_on(keysv);
569 }
570 if (PL_tainting)
571 PL_tainted = SvTAINTED(keysv);
572 keysv = sv_2mortal(newSVsv(keysv));
573 mg_copy((SV*)hv, val, (char*)keysv, HEf_SVKEY);
574 } else {
575 mg_copy((SV*)hv, val, key, klen);
576 }
577
578 TAINT_IF(save_taint);
7b2c381c 579 if (!HvARRAY(hv) && !needs_store) {
b2c64049
NC
580 if (flags & HVhek_FREEKEY)
581 Safefree(key);
582 return Nullhe;
583 }
584#ifdef ENV_IS_CASELESS
585 else if (mg_find((SV*)hv, PERL_MAGIC_env)) {
586 /* XXX This code isn't UTF8 clean. */
587 const char *keysave = key;
588 /* Will need to free this, so set FREEKEY flag. */
589 key = savepvn(key,klen);
590 key = (const char*)strupr((char*)key);
591 is_utf8 = 0;
592 hash = 0;
8b4f7dd5 593 keysv = 0;
b2c64049
NC
594
595 if (flags & HVhek_FREEKEY) {
596 Safefree(keysave);
597 }
598 flags |= HVhek_FREEKEY;
599 }
600#endif
601 }
602 } /* ISSTORE */
7f66fda2 603 } /* SvMAGICAL */
fde52b5c 604
7b2c381c 605 if (!HvARRAY(hv)) {
b2c64049 606 if ((action & (HV_FETCH_LVALUE | HV_FETCH_ISSTORE))
fde52b5c 607#ifdef DYNAMIC_ENV_FETCH /* if it's an %ENV lookup, we may get it on the fly */
8aacddc1 608 || (SvRMAGICAL((SV*)hv) && mg_find((SV*)hv, PERL_MAGIC_env))
fde52b5c 609#endif
d58e6666
NC
610 ) {
611 char *array;
612 Newz(503, array,
cbec9347 613 PERL_HV_ARRAY_ALLOC_BYTES(xhv->xhv_max+1 /* HvMAX(hv)+1 */),
d58e6666
NC
614 char);
615 HvARRAY(hv) = (HE**)array;
616 }
7f66fda2
NC
617#ifdef DYNAMIC_ENV_FETCH
618 else if (action & HV_FETCH_ISEXISTS) {
619 /* for an %ENV exists, if we do an insert it's by a recursive
620 store call, so avoid creating HvARRAY(hv) right now. */
621 }
622#endif
113738bb
NC
623 else {
624 /* XXX remove at some point? */
625 if (flags & HVhek_FREEKEY)
626 Safefree(key);
627
fde52b5c 628 return 0;
113738bb 629 }
fde52b5c
PP
630 }
631
19692e8d 632 if (is_utf8) {
a15d23f8 633 char * const keysave = (char * const)key;
f9a63242 634 key = (char*)bytes_from_utf8((U8*)key, &klen, &is_utf8);
19692e8d 635 if (is_utf8)
c1fe5510
NC
636 flags |= HVhek_UTF8;
637 else
638 flags &= ~HVhek_UTF8;
7f66fda2
NC
639 if (key != keysave) {
640 if (flags & HVhek_FREEKEY)
641 Safefree(keysave);
19692e8d 642 flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
7f66fda2 643 }
19692e8d 644 }
f9a63242 645
4b5190b5
NC
646 if (HvREHASH(hv)) {
647 PERL_HASH_INTERNAL(hash, key, klen);
b2c64049
NC
648 /* We don't have a pointer to the hv, so we have to replicate the
649 flag into every HEK, so that hv_iterkeysv can see it. */
650 /* And yes, you do need this even though you are not "storing" because
fdcd69b6
NC
651 you can flip the flags below if doing an lval lookup. (And that
652 was put in to give the semantics Andreas was expecting.) */
653 flags |= HVhek_REHASH;
4b5190b5 654 } else if (!hash) {
113738bb 655 if (keysv && (SvIsCOW_shared_hash(keysv))) {
c158a4fd 656 hash = SvSHARED_HASH(keysv);
46187eeb
NC
657 } else {
658 PERL_HASH(hash, key, klen);
659 }
660 }
effa1e2d 661
113738bb
NC
662 masked_flags = (flags & HVhek_MASK);
663
7f66fda2 664#ifdef DYNAMIC_ENV_FETCH
7b2c381c 665 if (!HvARRAY(hv)) entry = Null(HE*);
7f66fda2
NC
666 else
667#endif
b2c64049 668 {
7b2c381c 669 entry = (HvARRAY(hv))[hash & (I32) HvMAX(hv)];
b2c64049 670 }
0298d7b9 671 for (; entry; entry = HeNEXT(entry)) {
fde52b5c
PP
672 if (HeHASH(entry) != hash) /* strings can't be equal */
673 continue;
eb160463 674 if (HeKLEN(entry) != (I32)klen)
fde52b5c 675 continue;
1c846c1f 676 if (HeKEY(entry) != key && memNE(HeKEY(entry),key,klen)) /* is this it? */
fde52b5c 677 continue;
113738bb 678 if ((HeKFLAGS(entry) ^ masked_flags) & HVhek_UTF8)
c3654f1a 679 continue;
b2c64049
NC
680
681 if (action & (HV_FETCH_LVALUE|HV_FETCH_ISSTORE)) {
682 if (HeKFLAGS(entry) != masked_flags) {
683 /* We match if HVhek_UTF8 bit in our flags and hash key's
684 match. But if entry was set previously with HVhek_WASUTF8
685 and key now doesn't (or vice versa) then we should change
686 the key's flag, as this is assignment. */
687 if (HvSHAREKEYS(hv)) {
688 /* Need to swap the key we have for a key with the flags we
689 need. As keys are shared we can't just write to the
690 flag, so we share the new one, unshare the old one. */
6e838c70
NC
691 HEK *new_hek = share_hek_flags(key, klen, hash,
692 masked_flags);
b2c64049
NC
693 unshare_hek (HeKEY_hek(entry));
694 HeKEY_hek(entry) = new_hek;
695 }
5d2b1485
NC
696 else if (hv == PL_strtab) {
697 /* PL_strtab is usually the only hash without HvSHAREKEYS,
698 so putting this test here is cheap */
699 if (flags & HVhek_FREEKEY)
700 Safefree(key);
701 Perl_croak(aTHX_ S_strtab_error,
702 action & HV_FETCH_LVALUE ? "fetch" : "store");
703 }
b2c64049
NC
704 else
705 HeKFLAGS(entry) = masked_flags;
706 if (masked_flags & HVhek_ENABLEHVKFLAGS)
707 HvHASKFLAGS_on(hv);
708 }
709 if (HeVAL(entry) == &PL_sv_placeholder) {
710 /* yes, can store into placeholder slot */
711 if (action & HV_FETCH_LVALUE) {
712 if (SvMAGICAL(hv)) {
713 /* This preserves behaviour with the old hv_fetch
714 implementation which at this point would bail out
715 with a break; (at "if we find a placeholder, we
716 pretend we haven't found anything")
717
718 That break mean that if a placeholder were found, it
719 caused a call into hv_store, which in turn would
720 check magic, and if there is no magic end up pretty
721 much back at this point (in hv_store's code). */
722 break;
723 }
724 /* LVAL fetch which actaully needs a store. */
725 val = NEWSV(61,0);
ca732855 726 HvPLACEHOLDERS(hv)--;
b2c64049
NC
727 } else {
728 /* store */
729 if (val != &PL_sv_placeholder)
ca732855 730 HvPLACEHOLDERS(hv)--;
b2c64049
NC
731 }
732 HeVAL(entry) = val;
733 } else if (action & HV_FETCH_ISSTORE) {
734 SvREFCNT_dec(HeVAL(entry));
735 HeVAL(entry) = val;
736 }
27bcc0a7 737 } else if (HeVAL(entry) == &PL_sv_placeholder) {
b2c64049
NC
738 /* if we find a placeholder, we pretend we haven't found
739 anything */
8aacddc1 740 break;
b2c64049 741 }
113738bb
NC
742 if (flags & HVhek_FREEKEY)
743 Safefree(key);
fde52b5c
PP
744 return entry;
745 }
746#ifdef DYNAMIC_ENV_FETCH /* %ENV lookup? If so, try to fetch the value now */
0ed29950
NC
747 if (!(action & HV_FETCH_ISSTORE)
748 && SvRMAGICAL((SV*)hv) && mg_find((SV*)hv, PERL_MAGIC_env)) {
a6c40364 749 unsigned long len;
9d4ba2ae 750 const char * const env = PerlEnv_ENVgetenv_len(key,&len);
a6c40364
GS
751 if (env) {
752 sv = newSVpvn(env,len);
753 SvTAINTED_on(sv);
7fd3d16e 754 return hv_fetch_common(hv,keysv,key,klen,flags,HV_FETCH_ISSTORE,sv,
b2c64049 755 hash);
a6c40364 756 }
fde52b5c
PP
757 }
758#endif
7f66fda2
NC
759
760 if (!entry && SvREADONLY(hv) && !(action & HV_FETCH_ISEXISTS)) {
2393f1b9 761 S_hv_notallowed(aTHX_ flags, key, klen,
c8cd6465
NC
762 "Attempt to access disallowed key '%"SVf"' in"
763 " a restricted hash");
1b1f1335 764 }
b2c64049
NC
765 if (!(action & (HV_FETCH_LVALUE|HV_FETCH_ISSTORE))) {
766 /* Not doing some form of store, so return failure. */
767 if (flags & HVhek_FREEKEY)
768 Safefree(key);
769 return 0;
770 }
113738bb 771 if (action & HV_FETCH_LVALUE) {
b2c64049
NC
772 val = NEWSV(61,0);
773 if (SvMAGICAL(hv)) {
774 /* At this point the old hv_fetch code would call to hv_store,
775 which in turn might do some tied magic. So we need to make that
776 magic check happen. */
777 /* gonna assign to this, so it better be there */
778 return hv_fetch_common(hv, keysv, key, klen, flags,
779 HV_FETCH_ISSTORE, val, hash);
780 /* XXX Surely that could leak if the fetch-was-store fails?
781 Just like the hv_fetch. */
113738bb
NC
782 }
783 }
784
b2c64049
NC
785 /* Welcome to hv_store... */
786
7b2c381c 787 if (!HvARRAY(hv)) {
b2c64049
NC
788 /* Not sure if we can get here. I think the only case of oentry being
789 NULL is for %ENV with dynamic env fetch. But that should disappear
790 with magic in the previous code. */
d58e6666
NC
791 char *array;
792 Newz(503, array,
b2c64049 793 PERL_HV_ARRAY_ALLOC_BYTES(xhv->xhv_max+1 /* HvMAX(hv)+1 */),
d58e6666
NC
794 char);
795 HvARRAY(hv) = (HE**)array;
b2c64049
NC
796 }
797
7b2c381c 798 oentry = &(HvARRAY(hv))[hash & (I32) xhv->xhv_max];
ab4af705 799
b2c64049
NC
800 entry = new_HE();
801 /* share_hek_flags will do the free for us. This might be considered
802 bad API design. */
803 if (HvSHAREKEYS(hv))
6e838c70 804 HeKEY_hek(entry) = share_hek_flags(key, klen, hash, flags);
5d2b1485
NC
805 else if (hv == PL_strtab) {
806 /* PL_strtab is usually the only hash without HvSHAREKEYS, so putting
807 this test here is cheap */
808 if (flags & HVhek_FREEKEY)
809 Safefree(key);
810 Perl_croak(aTHX_ S_strtab_error,
811 action & HV_FETCH_LVALUE ? "fetch" : "store");
812 }
b2c64049
NC
813 else /* gotta do the real thing */
814 HeKEY_hek(entry) = save_hek_flags(key, klen, hash, flags);
815 HeVAL(entry) = val;
816 HeNEXT(entry) = *oentry;
817 *oentry = entry;
818
819 if (val == &PL_sv_placeholder)
ca732855 820 HvPLACEHOLDERS(hv)++;
b2c64049
NC
821 if (masked_flags & HVhek_ENABLEHVKFLAGS)
822 HvHASKFLAGS_on(hv);
823
0298d7b9
NC
824 {
825 const HE *counter = HeNEXT(entry);
826
827 xhv->xhv_keys++; /* HvKEYS(hv)++ */
828 if (!counter) { /* initial entry? */
829 xhv->xhv_fill++; /* HvFILL(hv)++ */
830 } else if (xhv->xhv_keys > (IV)xhv->xhv_max) {
831 hsplit(hv);
832 } else if(!HvREHASH(hv)) {
833 U32 n_links = 1;
834
835 while ((counter = HeNEXT(counter)))
836 n_links++;
837
838 if (n_links > HV_MAX_LENGTH_BEFORE_SPLIT) {
839 /* Use only the old HvKEYS(hv) > HvMAX(hv) condition to limit
840 bucket splits on a rehashed hash, as we're not going to
841 split it again, and if someone is lucky (evil) enough to
842 get all the keys in one list they could exhaust our memory
843 as we repeatedly double the number of buckets on every
844 entry. Linear search feels a less worse thing to do. */
845 hsplit(hv);
846 }
847 }
fde52b5c 848 }
b2c64049
NC
849
850 return entry;
fde52b5c
PP
851}
852
864dbfa3 853STATIC void
cea2e8a9 854S_hv_magic_check(pTHX_ HV *hv, bool *needs_copy, bool *needs_store)
d0066dc7 855{
a3b680e6 856 const MAGIC *mg = SvMAGIC(hv);
d0066dc7
OT
857 *needs_copy = FALSE;
858 *needs_store = TRUE;
859 while (mg) {
860 if (isUPPER(mg->mg_type)) {
861 *needs_copy = TRUE;
862 switch (mg->mg_type) {
14befaf4
DM
863 case PERL_MAGIC_tied:
864 case PERL_MAGIC_sig:
d0066dc7 865 *needs_store = FALSE;
4ab2a30b 866 return; /* We've set all there is to set. */
d0066dc7
OT
867 }
868 }
869 mg = mg->mg_moremagic;
870 }
871}
872
954c1994 873/*
a3bcc51e
TP
874=for apidoc hv_scalar
875
876Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
877
878=cut
879*/
880
881SV *
882Perl_hv_scalar(pTHX_ HV *hv)
883{
884 MAGIC *mg;
885 SV *sv;
886
887 if ((SvRMAGICAL(hv) && (mg = mg_find((SV*)hv, PERL_MAGIC_tied)))) {
888 sv = magic_scalarpack(hv, mg);
889 return sv;
890 }
891
892 sv = sv_newmortal();
893 if (HvFILL((HV*)hv))
894 Perl_sv_setpvf(aTHX_ sv, "%ld/%ld",
895 (long)HvFILL(hv), (long)HvMAX(hv) + 1);
896 else
897 sv_setiv(sv, 0);
898
899 return sv;
900}
901
902/*
954c1994
GS
903=for apidoc hv_delete
904
905Deletes a key/value pair in the hash. The value SV is removed from the
1c846c1f 906hash and returned to the caller. The C<klen> is the length of the key.
954c1994
GS
907The C<flags> value will normally be zero; if set to G_DISCARD then NULL
908will be returned.
909
910=cut
911*/
912
79072805 913SV *
cd6d36ac 914Perl_hv_delete(pTHX_ HV *hv, const char *key, I32 klen_i32, I32 flags)
79072805 915{
cd6d36ac
NC
916 STRLEN klen;
917 int k_flags = 0;
918
919 if (klen_i32 < 0) {
920 klen = -klen_i32;
921 k_flags |= HVhek_UTF8;
922 } else {
923 klen = klen_i32;
924 }
925 return hv_delete_common(hv, NULL, key, klen, k_flags, flags, 0);
fde52b5c
PP
926}
927
954c1994
GS
928/*
929=for apidoc hv_delete_ent
930
931Deletes a key/value pair in the hash. The value SV is removed from the
932hash and returned to the caller. The C<flags> value will normally be zero;
933if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
934precomputed hash value, or 0 to ask for it to be computed.
935
936=cut
937*/
938
fde52b5c 939SV *
864dbfa3 940Perl_hv_delete_ent(pTHX_ HV *hv, SV *keysv, I32 flags, U32 hash)
fde52b5c 941{
cd6d36ac 942 return hv_delete_common(hv, keysv, NULL, 0, 0, flags, hash);
f1317c8d
NC
943}
944
8f8d40ab 945STATIC SV *
cd6d36ac
NC
946S_hv_delete_common(pTHX_ HV *hv, SV *keysv, const char *key, STRLEN klen,
947 int k_flags, I32 d_flags, U32 hash)
f1317c8d 948{
27da23d5 949 dVAR;
cbec9347 950 register XPVHV* xhv;
fde52b5c
PP
951 register HE *entry;
952 register HE **oentry;
9e720f71 953 HE *const *first_entry;
fde52b5c 954 SV *sv;
da58a35d 955 bool is_utf8;
7a9669ca 956 int masked_flags;
1c846c1f 957
fde52b5c
PP
958 if (!hv)
959 return Nullsv;
f1317c8d
NC
960
961 if (keysv) {
e593d2fe
AE
962 if (k_flags & HVhek_FREEKEY)
963 Safefree(key);
5c144d81 964 key = SvPV_const(keysv, klen);
cd6d36ac 965 k_flags = 0;
f1317c8d
NC
966 is_utf8 = (SvUTF8(keysv) != 0);
967 } else {
cd6d36ac 968 is_utf8 = ((k_flags & HVhek_UTF8) ? TRUE : FALSE);
f1317c8d 969 }
f1317c8d 970
fde52b5c 971 if (SvRMAGICAL(hv)) {
0a0bb7c7
OT
972 bool needs_copy;
973 bool needs_store;
974 hv_magic_check (hv, &needs_copy, &needs_store);
975
f1317c8d 976 if (needs_copy) {
7a9669ca
NC
977 entry = hv_fetch_common(hv, keysv, key, klen,
978 k_flags & ~HVhek_FREEKEY, HV_FETCH_LVALUE,
b2c64049 979 Nullsv, hash);
7a9669ca 980 sv = entry ? HeVAL(entry) : NULL;
f1317c8d
NC
981 if (sv) {
982 if (SvMAGICAL(sv)) {
983 mg_clear(sv);
984 }
985 if (!needs_store) {
986 if (mg_find(sv, PERL_MAGIC_tiedelem)) {
987 /* No longer an element */
988 sv_unmagic(sv, PERL_MAGIC_tiedelem);
989 return sv;
990 }
991 return Nullsv; /* element cannot be deleted */
992 }
902173a3 993#ifdef ENV_IS_CASELESS
8167a60a
NC
994 else if (mg_find((SV*)hv, PERL_MAGIC_env)) {
995 /* XXX This code isn't UTF8 clean. */
996 keysv = sv_2mortal(newSVpvn(key,klen));
997 if (k_flags & HVhek_FREEKEY) {
998 Safefree(key);
999 }
1000 key = strupr(SvPVX(keysv));
1001 is_utf8 = 0;
1002 k_flags = 0;
1003 hash = 0;
7f66fda2 1004 }
510ac311 1005#endif
2fd1c6b8 1006 }
2fd1c6b8 1007 }
fde52b5c 1008 }
cbec9347 1009 xhv = (XPVHV*)SvANY(hv);
7b2c381c 1010 if (!HvARRAY(hv))
fde52b5c
PP
1011 return Nullsv;
1012
19692e8d 1013 if (is_utf8) {
b464bac0
AL
1014 const char *keysave = key;
1015 key = (char*)bytes_from_utf8((U8*)key, &klen, &is_utf8);
cd6d36ac 1016
19692e8d 1017 if (is_utf8)
cd6d36ac
NC
1018 k_flags |= HVhek_UTF8;
1019 else
1020 k_flags &= ~HVhek_UTF8;
7f66fda2
NC
1021 if (key != keysave) {
1022 if (k_flags & HVhek_FREEKEY) {
1023 /* This shouldn't happen if our caller does what we expect,
1024 but strictly the API allows it. */
1025 Safefree(keysave);
1026 }
1027 k_flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
1028 }
cd6d36ac 1029 HvHASKFLAGS_on((SV*)hv);
19692e8d 1030 }
f9a63242 1031
4b5190b5
NC
1032 if (HvREHASH(hv)) {
1033 PERL_HASH_INTERNAL(hash, key, klen);
1034 } else if (!hash) {
7a9669ca 1035 if (keysv && (SvIsCOW_shared_hash(keysv))) {
c158a4fd 1036 hash = SvSHARED_HASH(keysv);
7a9669ca
NC
1037 } else {
1038 PERL_HASH(hash, key, klen);
1039 }
4b5190b5 1040 }
fde52b5c 1041
7a9669ca
NC
1042 masked_flags = (k_flags & HVhek_MASK);
1043
9e720f71 1044 first_entry = oentry = &(HvARRAY(hv))[hash & (I32) HvMAX(hv)];
fde52b5c 1045 entry = *oentry;
9e720f71 1046 for (; entry; oentry = &HeNEXT(entry), entry = *oentry) {
fde52b5c
PP
1047 if (HeHASH(entry) != hash) /* strings can't be equal */
1048 continue;
eb160463 1049 if (HeKLEN(entry) != (I32)klen)
fde52b5c 1050 continue;
1c846c1f 1051 if (HeKEY(entry) != key && memNE(HeKEY(entry),key,klen)) /* is this it? */
fde52b5c 1052 continue;
7a9669ca 1053 if ((HeKFLAGS(entry) ^ masked_flags) & HVhek_UTF8)
c3654f1a 1054 continue;
8aacddc1 1055
5d2b1485
NC
1056 if (hv == PL_strtab) {
1057 if (k_flags & HVhek_FREEKEY)
1058 Safefree(key);
1059 Perl_croak(aTHX_ S_strtab_error, "delete");
1060 }
1061
8aacddc1 1062 /* if placeholder is here, it's already been deleted.... */
7996736c 1063 if (HeVAL(entry) == &PL_sv_placeholder)
8aacddc1 1064 {
b84d0860
NC
1065 if (k_flags & HVhek_FREEKEY)
1066 Safefree(key);
1067 return Nullsv;
8aacddc1
NIS
1068 }
1069 else if (SvREADONLY(hv) && HeVAL(entry) && SvREADONLY(HeVAL(entry))) {
2393f1b9 1070 S_hv_notallowed(aTHX_ k_flags, key, klen,
c8cd6465
NC
1071 "Attempt to delete readonly key '%"SVf"' from"
1072 " a restricted hash");
8aacddc1 1073 }
b84d0860
NC
1074 if (k_flags & HVhek_FREEKEY)
1075 Safefree(key);
8aacddc1 1076
cd6d36ac 1077 if (d_flags & G_DISCARD)
fde52b5c 1078 sv = Nullsv;
94f7643d 1079 else {
79d01fbf 1080 sv = sv_2mortal(HeVAL(entry));
7996736c 1081 HeVAL(entry) = &PL_sv_placeholder;
94f7643d 1082 }
8aacddc1
NIS
1083
1084 /*
1085 * If a restricted hash, rather than really deleting the entry, put
1086 * a placeholder there. This marks the key as being "approved", so
1087 * we can still access via not-really-existing key without raising
1088 * an error.
1089 */
1090 if (SvREADONLY(hv)) {
754604c4 1091 SvREFCNT_dec(HeVAL(entry));
7996736c 1092 HeVAL(entry) = &PL_sv_placeholder;
8aacddc1
NIS
1093 /* We'll be saving this slot, so the number of allocated keys
1094 * doesn't go down, but the number placeholders goes up */
ca732855 1095 HvPLACEHOLDERS(hv)++;
8aacddc1 1096 } else {
a26e96df 1097 *oentry = HeNEXT(entry);
9e720f71 1098 if(!*first_entry) {
a26e96df 1099 xhv->xhv_fill--; /* HvFILL(hv)-- */
9e720f71 1100 }
b79f7545 1101 if (SvOOK(hv) && entry == HvAUX(hv)->xhv_eiter /* HvEITER(hv) */)
8aacddc1
NIS
1102 HvLAZYDEL_on(hv);
1103 else
1104 hv_free_ent(hv, entry);
1105 xhv->xhv_keys--; /* HvKEYS(hv)-- */
574c8022 1106 if (xhv->xhv_keys == 0)
19692e8d 1107 HvHASKFLAGS_off(hv);
8aacddc1 1108 }
79072805
LW
1109 return sv;
1110 }
8aacddc1 1111 if (SvREADONLY(hv)) {
2393f1b9 1112 S_hv_notallowed(aTHX_ k_flags, key, klen,
c8cd6465
NC
1113 "Attempt to delete disallowed key '%"SVf"' from"
1114 " a restricted hash");
8aacddc1
NIS
1115 }
1116
19692e8d 1117 if (k_flags & HVhek_FREEKEY)
f9a63242 1118 Safefree(key);
79072805 1119 return Nullsv;
79072805
LW
1120}
1121
76e3520e 1122STATIC void
cea2e8a9 1123S_hsplit(pTHX_ HV *hv)
79072805 1124{
cbec9347 1125 register XPVHV* xhv = (XPVHV*)SvANY(hv);
a3b680e6 1126 const I32 oldsize = (I32) xhv->xhv_max+1; /* HvMAX(hv)+1 (sick) */
79072805
LW
1127 register I32 newsize = oldsize * 2;
1128 register I32 i;
7b2c381c 1129 char *a = (char*) HvARRAY(hv);
72311751 1130 register HE **aep;
79072805 1131 register HE **oentry;
4b5190b5
NC
1132 int longest_chain = 0;
1133 int was_shared;
79072805 1134
18026298
NC
1135 /*PerlIO_printf(PerlIO_stderr(), "hsplit called for %p which had %d\n",
1136 hv, (int) oldsize);*/
1137
5d88ecd7 1138 if (HvPLACEHOLDERS_get(hv) && !SvREADONLY(hv)) {
18026298
NC
1139 /* Can make this clear any placeholders first for non-restricted hashes,
1140 even though Storable rebuilds restricted hashes by putting in all the
1141 placeholders (first) before turning on the readonly flag, because
1142 Storable always pre-splits the hash. */
1143 hv_clear_placeholders(hv);
1144 }
1145
3280af22 1146 PL_nomemok = TRUE;
8d6dde3e 1147#if defined(STRANGE_MALLOC) || defined(MYMALLOC)
b79f7545
NC
1148 Renew(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1149 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
422a93e5 1150 if (!a) {
4a33f861 1151 PL_nomemok = FALSE;
422a93e5
GA
1152 return;
1153 }
b79f7545 1154 if (SvOOK(hv)) {
7a9b70e9 1155 Copy(&a[oldsize * sizeof(HE*)], &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
b79f7545 1156 }
4633a7c4 1157#else
b79f7545
NC
1158 New(2, a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1159 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
422a93e5 1160 if (!a) {
3280af22 1161 PL_nomemok = FALSE;
422a93e5
GA
1162 return;
1163 }
7b2c381c 1164 Copy(HvARRAY(hv), a, oldsize * sizeof(HE*), char);
b79f7545
NC
1165 if (SvOOK(hv)) {
1166 Copy(HvAUX(hv), &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
1167 }
fba3b22e 1168 if (oldsize >= 64) {
7b2c381c 1169 offer_nice_chunk(HvARRAY(hv),
b79f7545
NC
1170 PERL_HV_ARRAY_ALLOC_BYTES(oldsize)
1171 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0));
4633a7c4
LW
1172 }
1173 else
7b2c381c 1174 Safefree(HvARRAY(hv));
4633a7c4
LW
1175#endif
1176
3280af22 1177 PL_nomemok = FALSE;
72311751 1178 Zero(&a[oldsize * sizeof(HE*)], (newsize-oldsize) * sizeof(HE*), char); /* zero 2nd half*/
cbec9347 1179 xhv->xhv_max = --newsize; /* HvMAX(hv) = --newsize */
7b2c381c 1180 HvARRAY(hv) = (HE**) a;
72311751 1181 aep = (HE**)a;
79072805 1182
72311751 1183 for (i=0; i<oldsize; i++,aep++) {
4b5190b5
NC
1184 int left_length = 0;
1185 int right_length = 0;
a3b680e6
AL
1186 register HE *entry;
1187 register HE **bep;
4b5190b5 1188
72311751 1189 if (!*aep) /* non-existent */
79072805 1190 continue;
72311751
GS
1191 bep = aep+oldsize;
1192 for (oentry = aep, entry = *aep; entry; entry = *oentry) {
eb160463 1193 if ((HeHASH(entry) & newsize) != (U32)i) {
fde52b5c 1194 *oentry = HeNEXT(entry);
72311751
GS
1195 HeNEXT(entry) = *bep;
1196 if (!*bep)
cbec9347 1197 xhv->xhv_fill++; /* HvFILL(hv)++ */
72311751 1198 *bep = entry;
4b5190b5 1199 right_length++;
79072805
LW
1200 continue;
1201 }
4b5190b5 1202 else {
fde52b5c 1203 oentry = &HeNEXT(entry);
4b5190b5
NC
1204 left_length++;
1205 }
79072805 1206 }
72311751 1207 if (!*aep) /* everything moved */
cbec9347 1208 xhv->xhv_fill--; /* HvFILL(hv)-- */
4b5190b5
NC
1209 /* I think we don't actually need to keep track of the longest length,
1210 merely flag if anything is too long. But for the moment while
1211 developing this code I'll track it. */
1212 if (left_length > longest_chain)
1213 longest_chain = left_length;
1214 if (right_length > longest_chain)
1215 longest_chain = right_length;
1216 }
1217
1218
1219 /* Pick your policy for "hashing isn't working" here: */
fdcd69b6 1220 if (longest_chain <= HV_MAX_LENGTH_BEFORE_SPLIT /* split worked? */
4b5190b5
NC
1221 || HvREHASH(hv)) {
1222 return;
79072805 1223 }
4b5190b5
NC
1224
1225 if (hv == PL_strtab) {
1226 /* Urg. Someone is doing something nasty to the string table.
1227 Can't win. */
1228 return;
1229 }
1230
1231 /* Awooga. Awooga. Pathological data. */
fdcd69b6 1232 /*PerlIO_printf(PerlIO_stderr(), "%p %d of %d with %d/%d buckets\n", hv,
4b5190b5
NC
1233 longest_chain, HvTOTALKEYS(hv), HvFILL(hv), 1+HvMAX(hv));*/
1234
1235 ++newsize;
b79f7545
NC
1236 Newz(2, a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1237 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
1238 if (SvOOK(hv)) {
1239 Copy(HvAUX(hv), &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
1240 }
1241
4b5190b5
NC
1242 was_shared = HvSHAREKEYS(hv);
1243
1244 xhv->xhv_fill = 0;
1245 HvSHAREKEYS_off(hv);
1246 HvREHASH_on(hv);
1247
7b2c381c 1248 aep = HvARRAY(hv);
4b5190b5
NC
1249
1250 for (i=0; i<newsize; i++,aep++) {
a3b680e6 1251 register HE *entry = *aep;
4b5190b5
NC
1252 while (entry) {
1253 /* We're going to trash this HE's next pointer when we chain it
1254 into the new hash below, so store where we go next. */
9d4ba2ae 1255 HE * const next = HeNEXT(entry);
4b5190b5 1256 UV hash;
a3b680e6 1257 HE **bep;
4b5190b5
NC
1258
1259 /* Rehash it */
1260 PERL_HASH_INTERNAL(hash, HeKEY(entry), HeKLEN(entry));
1261
1262 if (was_shared) {
1263 /* Unshare it. */
1264 HEK *new_hek
1265 = save_hek_flags(HeKEY(entry), HeKLEN(entry),
1266 hash, HeKFLAGS(entry));
1267 unshare_hek (HeKEY_hek(entry));
1268 HeKEY_hek(entry) = new_hek;
1269 } else {
1270 /* Not shared, so simply write the new hash in. */
1271 HeHASH(entry) = hash;
1272 }
1273 /*PerlIO_printf(PerlIO_stderr(), "%d ", HeKFLAGS(entry));*/
1274 HEK_REHASH_on(HeKEY_hek(entry));
1275 /*PerlIO_printf(PerlIO_stderr(), "%d\n", HeKFLAGS(entry));*/
1276
1277 /* Copy oentry to the correct new chain. */
1278 bep = ((HE**)a) + (hash & (I32) xhv->xhv_max);
1279 if (!*bep)
1280 xhv->xhv_fill++; /* HvFILL(hv)++ */
1281 HeNEXT(entry) = *bep;
1282 *bep = entry;
1283
1284 entry = next;
1285 }
1286 }
7b2c381c
NC
1287 Safefree (HvARRAY(hv));
1288 HvARRAY(hv) = (HE **)a;
79072805
LW
1289}
1290
72940dca 1291void
864dbfa3 1292Perl_hv_ksplit(pTHX_ HV *hv, IV newmax)
72940dca 1293{
cbec9347 1294 register XPVHV* xhv = (XPVHV*)SvANY(hv);
a3b680e6 1295 const I32 oldsize = (I32) xhv->xhv_max+1; /* HvMAX(hv)+1 (sick) */
72940dca
PP
1296 register I32 newsize;
1297 register I32 i;
72311751
GS
1298 register char *a;
1299 register HE **aep;
72940dca
PP
1300 register HE *entry;
1301 register HE **oentry;
1302
1303 newsize = (I32) newmax; /* possible truncation here */
1304 if (newsize != newmax || newmax <= oldsize)
1305 return;
1306 while ((newsize & (1 + ~newsize)) != newsize) {
1307 newsize &= ~(newsize & (1 + ~newsize)); /* get proper power of 2 */
1308 }
1309 if (newsize < newmax)
1310 newsize *= 2;
1311 if (newsize < newmax)
1312 return; /* overflow detection */
1313
7b2c381c 1314 a = (char *) HvARRAY(hv);
72940dca 1315 if (a) {
3280af22 1316 PL_nomemok = TRUE;
8d6dde3e 1317#if defined(STRANGE_MALLOC) || defined(MYMALLOC)
b79f7545
NC
1318 Renew(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1319 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
8aacddc1 1320 if (!a) {
4a33f861 1321 PL_nomemok = FALSE;
422a93e5
GA
1322 return;
1323 }
b79f7545 1324 if (SvOOK(hv)) {
7a9b70e9 1325 Copy(&a[oldsize * sizeof(HE*)], &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
b79f7545 1326 }
72940dca 1327#else
b79f7545
NC
1328 New(2, a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1329 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0), char);
8aacddc1 1330 if (!a) {
3280af22 1331 PL_nomemok = FALSE;
422a93e5
GA
1332 return;
1333 }
7b2c381c 1334 Copy(HvARRAY(hv), a, oldsize * sizeof(HE*), char);
b79f7545
NC
1335 if (SvOOK(hv)) {
1336 Copy(HvAUX(hv), &a[newsize * sizeof(HE*)], 1, struct xpvhv_aux);
1337 }
fba3b22e 1338 if (oldsize >= 64) {
7b2c381c 1339 offer_nice_chunk(HvARRAY(hv),
b79f7545
NC
1340 PERL_HV_ARRAY_ALLOC_BYTES(oldsize)
1341 + (SvOOK(hv) ? sizeof(struct xpvhv_aux) : 0));
72940dca
PP
1342 }
1343 else
7b2c381c 1344 Safefree(HvARRAY(hv));
72940dca 1345#endif
3280af22 1346 PL_nomemok = FALSE;
72311751 1347 Zero(&a[oldsize * sizeof(HE*)], (newsize-oldsize) * sizeof(HE*), char); /* zero 2nd half*/
72940dca
PP
1348 }
1349 else {
d18c6117 1350 Newz(0, a, PERL_HV_ARRAY_ALLOC_BYTES(newsize), char);
72940dca 1351 }
cbec9347 1352 xhv->xhv_max = --newsize; /* HvMAX(hv) = --newsize */
7b2c381c 1353 HvARRAY(hv) = (HE **) a;
cbec9347 1354 if (!xhv->xhv_fill /* !HvFILL(hv) */) /* skip rest if no entries */
72940dca
PP
1355 return;
1356
72311751
GS
1357 aep = (HE**)a;
1358 for (i=0; i<oldsize; i++,aep++) {
1359 if (!*aep) /* non-existent */
72940dca 1360 continue;
72311751 1361 for (oentry = aep, entry = *aep; entry; entry = *oentry) {
a3b680e6 1362 register I32 j;
72940dca
PP
1363 if ((j = (HeHASH(entry) & newsize)) != i) {
1364 j -= i;
1365 *oentry = HeNEXT(entry);
72311751 1366 if (!(HeNEXT(entry) = aep[j]))
cbec9347 1367 xhv->xhv_fill++; /* HvFILL(hv)++ */
72311751 1368 aep[j] = entry;
72940dca
PP
1369 continue;
1370 }
1371 else
1372 oentry = &HeNEXT(entry);
1373 }
72311751 1374 if (!*aep) /* everything moved */
cbec9347 1375 xhv->xhv_fill--; /* HvFILL(hv)-- */
72940dca
PP
1376 }
1377}
1378
954c1994
GS
1379/*
1380=for apidoc newHV
1381
1382Creates a new HV. The reference count is set to 1.
1383
1384=cut
1385*/
1386
79072805 1387HV *
864dbfa3 1388Perl_newHV(pTHX)
79072805 1389{
cbec9347 1390 register XPVHV* xhv;
9d4ba2ae 1391 HV * const hv = (HV*)NEWSV(502,0);
79072805 1392
a0d0e21e 1393 sv_upgrade((SV *)hv, SVt_PVHV);
cbec9347 1394 xhv = (XPVHV*)SvANY(hv);
79072805
LW
1395 SvPOK_off(hv);
1396 SvNOK_off(hv);
1c846c1f 1397#ifndef NODEFAULT_SHAREKEYS
fde52b5c 1398 HvSHAREKEYS_on(hv); /* key-sharing on by default */
1c846c1f 1399#endif
4b5190b5 1400
cbec9347
JH
1401 xhv->xhv_max = 7; /* HvMAX(hv) = 7 (start with 8 buckets) */
1402 xhv->xhv_fill = 0; /* HvFILL(hv) = 0 */
79072805
LW
1403 return hv;
1404}
1405
b3ac6de7 1406HV *
864dbfa3 1407Perl_newHVhv(pTHX_ HV *ohv)
b3ac6de7 1408{
9d4ba2ae 1409 HV * const hv = newHV();
4beac62f 1410 STRLEN hv_max, hv_fill;
4beac62f
AMS
1411
1412 if (!ohv || (hv_fill = HvFILL(ohv)) == 0)
1413 return hv;
4beac62f 1414 hv_max = HvMAX(ohv);
b3ac6de7 1415
b56ba0bf
AMS
1416 if (!SvMAGICAL((SV *)ohv)) {
1417 /* It's an ordinary hash, so copy it fast. AMS 20010804 */
eb160463 1418 STRLEN i;
a3b680e6 1419 const bool shared = !!HvSHAREKEYS(ohv);
b56ba0bf 1420 HE **ents, **oents = (HE **)HvARRAY(ohv);
ff875642
JH
1421 char *a;
1422 New(0, a, PERL_HV_ARRAY_ALLOC_BYTES(hv_max+1), char);
1423 ents = (HE**)a;
b56ba0bf
AMS
1424
1425 /* In each bucket... */
1426 for (i = 0; i <= hv_max; i++) {
1427 HE *prev = NULL, *ent = NULL, *oent = oents[i];
1428
1429 if (!oent) {
1430 ents[i] = NULL;
1431 continue;
1432 }
1433
1434 /* Copy the linked list of entries. */
1435 for (oent = oents[i]; oent; oent = HeNEXT(oent)) {
a3b680e6
AL
1436 const U32 hash = HeHASH(oent);
1437 const char * const key = HeKEY(oent);
1438 const STRLEN len = HeKLEN(oent);
1439 const int flags = HeKFLAGS(oent);
b56ba0bf
AMS
1440
1441 ent = new_HE();
45dea987 1442 HeVAL(ent) = newSVsv(HeVAL(oent));
19692e8d 1443 HeKEY_hek(ent)
6e838c70 1444 = shared ? share_hek_flags(key, len, hash, flags)
19692e8d 1445 : save_hek_flags(key, len, hash, flags);
b56ba0bf
AMS
1446 if (prev)
1447 HeNEXT(prev) = ent;
1448 else
1449 ents[i] = ent;
1450 prev = ent;
1451 HeNEXT(ent) = NULL;
1452 }
1453 }
1454
1455 HvMAX(hv) = hv_max;
1456 HvFILL(hv) = hv_fill;
8aacddc1 1457 HvTOTALKEYS(hv) = HvTOTALKEYS(ohv);
b56ba0bf 1458 HvARRAY(hv) = ents;
1c846c1f 1459 }
b56ba0bf
AMS
1460 else {
1461 /* Iterate over ohv, copying keys and values one at a time. */
b3ac6de7 1462 HE *entry;
bfcb3514
NC
1463 const I32 riter = HvRITER_get(ohv);
1464 HE * const eiter = HvEITER_get(ohv);
b56ba0bf
AMS
1465
1466 /* Can we use fewer buckets? (hv_max is always 2^n-1) */
1467 while (hv_max && hv_max + 1 >= hv_fill * 2)
1468 hv_max = hv_max / 2;
1469 HvMAX(hv) = hv_max;
1470
4a76a316 1471 hv_iterinit(ohv);
e16e2ff8 1472 while ((entry = hv_iternext_flags(ohv, 0))) {
19692e8d
NC
1473 hv_store_flags(hv, HeKEY(entry), HeKLEN(entry),
1474 newSVsv(HeVAL(entry)), HeHASH(entry),
1475 HeKFLAGS(entry));
b3ac6de7 1476 }
bfcb3514
NC
1477 HvRITER_set(ohv, riter);
1478 HvEITER_set(ohv, eiter);
b3ac6de7 1479 }
1c846c1f 1480
b3ac6de7
IZ
1481 return hv;
1482}
1483
79072805 1484void
864dbfa3 1485Perl_hv_free_ent(pTHX_ HV *hv, register HE *entry)
79072805 1486{
16bdeea2
GS
1487 SV *val;
1488
68dc0745 1489 if (!entry)
79072805 1490 return;
16bdeea2 1491 val = HeVAL(entry);
bfcb3514 1492 if (val && isGV(val) && GvCVu(val) && HvNAME_get(hv))
3280af22 1493 PL_sub_generation++; /* may be deletion of method from stash */
16bdeea2 1494 SvREFCNT_dec(val);
68dc0745
PP
1495 if (HeKLEN(entry) == HEf_SVKEY) {
1496 SvREFCNT_dec(HeKEY_sv(entry));
8aacddc1 1497 Safefree(HeKEY_hek(entry));
44a8e56a
PP
1498 }
1499 else if (HvSHAREKEYS(hv))
68dc0745 1500 unshare_hek(HeKEY_hek(entry));
fde52b5c 1501 else
68dc0745 1502 Safefree(HeKEY_hek(entry));
d33b2eba 1503 del_HE(entry);
79072805
LW
1504}
1505
1506void
864dbfa3 1507Perl_hv_delayfree_ent(pTHX_ HV *hv, register HE *entry)
79072805 1508{
68dc0745 1509 if (!entry)
79072805 1510 return;
bc4947fc
NC
1511 /* SvREFCNT_inc to counter the SvREFCNT_dec in hv_free_ent */
1512 sv_2mortal(SvREFCNT_inc(HeVAL(entry))); /* free between statements */
68dc0745 1513 if (HeKLEN(entry) == HEf_SVKEY) {
bc4947fc 1514 sv_2mortal(SvREFCNT_inc(HeKEY_sv(entry)));
44a8e56a 1515 }
bc4947fc 1516 hv_free_ent(hv, entry);
79072805
LW
1517}
1518
954c1994
GS
1519/*
1520=for apidoc hv_clear
1521
1522Clears a hash, making it empty.
1523
1524=cut
1525*/
1526
79072805 1527void
864dbfa3 1528Perl_hv_clear(pTHX_ HV *hv)
79072805 1529{
27da23d5 1530 dVAR;
cbec9347 1531 register XPVHV* xhv;
79072805
LW
1532 if (!hv)
1533 return;
49293501 1534
ecae49c0
NC
1535 DEBUG_A(Perl_hv_assert(aTHX_ hv));
1536
34c3c4e3
DM
1537 xhv = (XPVHV*)SvANY(hv);
1538
7b2c381c 1539 if (SvREADONLY(hv) && HvARRAY(hv) != NULL) {
34c3c4e3 1540 /* restricted hash: convert all keys to placeholders */
b464bac0
AL
1541 STRLEN i;
1542 for (i = 0; i <= xhv->xhv_max; i++) {
7b2c381c 1543 HE *entry = (HvARRAY(hv))[i];
3a676441
JH
1544 for (; entry; entry = HeNEXT(entry)) {
1545 /* not already placeholder */
7996736c 1546 if (HeVAL(entry) != &PL_sv_placeholder) {
3a676441
JH
1547 if (HeVAL(entry) && SvREADONLY(HeVAL(entry))) {
1548 SV* keysv = hv_iterkeysv(entry);
1549 Perl_croak(aTHX_
1550 "Attempt to delete readonly key '%"SVf"' from a restricted hash",
1551 keysv);
1552 }
1553 SvREFCNT_dec(HeVAL(entry));
7996736c 1554 HeVAL(entry) = &PL_sv_placeholder;
ca732855 1555 HvPLACEHOLDERS(hv)++;
3a676441 1556 }
34c3c4e3
DM
1557 }
1558 }
df8c6964 1559 goto reset;
49293501
MS
1560 }
1561
463ee0b2 1562 hfreeentries(hv);
ca732855 1563 HvPLACEHOLDERS_set(hv, 0);
7b2c381c
NC
1564 if (HvARRAY(hv))
1565 (void)memzero(HvARRAY(hv),
cbec9347 1566 (xhv->xhv_max+1 /* HvMAX(hv)+1 */) * sizeof(HE*));
a0d0e21e
LW
1567
1568 if (SvRMAGICAL(hv))
1c846c1f 1569 mg_clear((SV*)hv);
574c8022 1570
19692e8d 1571 HvHASKFLAGS_off(hv);
bb443f97 1572 HvREHASH_off(hv);
df8c6964 1573 reset:
b79f7545 1574 if (SvOOK(hv)) {
bfcb3514
NC
1575 HvEITER_set(hv, NULL);
1576 }
79072805
LW
1577}
1578
3540d4ce
AB
1579/*
1580=for apidoc hv_clear_placeholders
1581
1582Clears any placeholders from a hash. If a restricted hash has any of its keys
1583marked as readonly and the key is subsequently deleted, the key is not actually
1584deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
1585it so it will be ignored by future operations such as iterating over the hash,
4cdaeff7 1586but will still allow the hash to have a value reassigned to the key at some
3540d4ce
AB
1587future point. This function clears any such placeholder keys from the hash.
1588See Hash::Util::lock_keys() for an example of its use.
1589
1590=cut
1591*/
1592
1593void
1594Perl_hv_clear_placeholders(pTHX_ HV *hv)
1595{
27da23d5 1596 dVAR;
5d88ecd7 1597 I32 items = (I32)HvPLACEHOLDERS_get(hv);
b464bac0 1598 I32 i;
d3677389
NC
1599
1600 if (items == 0)
1601 return;
1602
b464bac0 1603 i = HvMAX(hv);
d3677389
NC
1604 do {
1605 /* Loop down the linked list heads */
a3b680e6 1606 bool first = 1;
d3677389
NC
1607 HE **oentry = &(HvARRAY(hv))[i];
1608 HE *entry = *oentry;
1609
1610 if (!entry)
1611 continue;
1612
213ce8b3 1613 for (; entry; entry = *oentry) {
d3677389
NC
1614 if (HeVAL(entry) == &PL_sv_placeholder) {
1615 *oentry = HeNEXT(entry);
1616 if (first && !*oentry)
1617 HvFILL(hv)--; /* This linked list is now empty. */
bfcb3514 1618 if (HvEITER_get(hv))
d3677389
NC
1619 HvLAZYDEL_on(hv);
1620 else
1621 hv_free_ent(hv, entry);
1622
1623 if (--items == 0) {
1624 /* Finished. */
5d88ecd7 1625 HvTOTALKEYS(hv) -= (IV)HvPLACEHOLDERS_get(hv);
d3677389
NC
1626 if (HvKEYS(hv) == 0)
1627 HvHASKFLAGS_off(hv);
5d88ecd7 1628 HvPLACEHOLDERS_set(hv, 0);
d3677389
NC
1629 return;
1630 }
213ce8b3
NC
1631 } else {
1632 oentry = &HeNEXT(entry);
1633 first = 0;
d3677389
NC
1634 }
1635 }
1636 } while (--i >= 0);
1637 /* You can't get here, hence assertion should always fail. */
1638 assert (items == 0);
1639 assert (0);
3540d4ce
AB
1640}
1641
76e3520e 1642STATIC void
cea2e8a9 1643S_hfreeentries(pTHX_ HV *hv)
79072805 1644{
a0d0e21e 1645 register HE **array;
68dc0745 1646 register HE *entry;
a0d0e21e
LW
1647 I32 riter;
1648 I32 max;
bfcb3514 1649 struct xpvhv_aux *iter;
79072805
LW
1650 if (!hv)
1651 return;
a0d0e21e 1652 if (!HvARRAY(hv))
79072805 1653 return;
a0d0e21e 1654
b79f7545
NC
1655 iter = SvOOK(hv) ? HvAUX(hv) : 0;
1656
a0d0e21e
LW
1657 riter = 0;
1658 max = HvMAX(hv);
1659 array = HvARRAY(hv);
2f86008e
DM
1660 /* make everyone else think the array is empty, so that the destructors
1661 * called for freed entries can't recusively mess with us */
1662 HvARRAY(hv) = Null(HE**);
b79f7545
NC
1663 SvFLAGS(hv) &= ~SVf_OOK;
1664
2f86008e
DM
1665 HvFILL(hv) = 0;
1666 ((XPVHV*) SvANY(hv))->xhv_keys = 0;
1667
68dc0745 1668 entry = array[0];
a0d0e21e 1669 for (;;) {
68dc0745 1670 if (entry) {
a3b680e6 1671 register HE *oentry = entry;
68dc0745
PP
1672 entry = HeNEXT(entry);
1673 hv_free_ent(hv, oentry);
a0d0e21e 1674 }
68dc0745 1675 if (!entry) {
a0d0e21e
LW
1676 if (++riter > max)
1677 break;
68dc0745 1678 entry = array[riter];
1c846c1f 1679 }
79072805 1680 }
bfcb3514 1681
b79f7545
NC
1682 if (SvOOK(hv)) {
1683 /* Someone attempted to iterate or set the hash name while we had
1684 the array set to 0. */
1685 assert(HvARRAY(hv));
1686
1687 if (HvAUX(hv)->xhv_name)
1688 unshare_hek_or_pvn(HvAUX(hv)->xhv_name, 0, 0, 0);
1689 /* SvOOK_off calls sv_backoff, which isn't correct. */
1690
1691 Safefree(HvARRAY(hv));
1692 HvARRAY(hv) = 0;
1693 SvFLAGS(hv) &= ~SVf_OOK;
1694 }
1695
1696 /* FIXME - things will still go horribly wrong (or at least leak) if
1697 people attempt to add elements to the hash while we're undef()ing it */
bfcb3514
NC
1698 if (iter) {
1699 entry = iter->xhv_eiter; /* HvEITER(hv) */
1700 if (entry && HvLAZYDEL(hv)) { /* was deleted earlier? */
1701 HvLAZYDEL_off(hv);
1702 hv_free_ent(hv, entry);
1703 }
b79f7545
NC
1704 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
1705 iter->xhv_eiter = Null(HE*); /* HvEITER(hv) = Null(HE*) */
1706 SvFLAGS(hv) |= SVf_OOK;
bfcb3514 1707 }
b79f7545
NC
1708
1709 HvARRAY(hv) = array;
79072805
LW
1710}
1711
954c1994
GS
1712/*
1713=for apidoc hv_undef
1714
1715Undefines the hash.
1716
1717=cut
1718*/
1719
79072805 1720void
864dbfa3 1721Perl_hv_undef(pTHX_ HV *hv)
79072805 1722{
cbec9347 1723 register XPVHV* xhv;
bfcb3514 1724 const char *name;
79072805
LW
1725 if (!hv)
1726 return;
ecae49c0 1727 DEBUG_A(Perl_hv_assert(aTHX_ hv));
cbec9347 1728 xhv = (XPVHV*)SvANY(hv);
463ee0b2 1729 hfreeentries(hv);
bfcb3514 1730 if ((name = HvNAME_get(hv))) {
7e8961ec 1731 if(PL_stashcache)
7423f6db 1732 hv_delete(PL_stashcache, name, HvNAMELEN_get(hv), G_DISCARD);
bfcb3514 1733 Perl_hv_name_set(aTHX_ hv, 0, 0, 0);
85e6fe83 1734 }
b79f7545
NC
1735 SvFLAGS(hv) &= ~SVf_OOK;
1736 Safefree(HvARRAY(hv));
cbec9347 1737 xhv->xhv_max = 7; /* HvMAX(hv) = 7 (it's a normal hash) */
7b2c381c 1738 HvARRAY(hv) = 0;
ca732855 1739 HvPLACEHOLDERS_set(hv, 0);
a0d0e21e
LW
1740
1741 if (SvRMAGICAL(hv))
1c846c1f 1742 mg_clear((SV*)hv);
79072805
LW
1743}
1744
b464bac0 1745static struct xpvhv_aux*
b79f7545 1746S_hv_auxinit(pTHX_ HV *hv) {
bfcb3514 1747 struct xpvhv_aux *iter;
b79f7545 1748 char *array;
bfcb3514 1749
b79f7545
NC
1750 if (!HvARRAY(hv)) {
1751 Newz(0, array, PERL_HV_ARRAY_ALLOC_BYTES(HvMAX(hv) + 1)
1752 + sizeof(struct xpvhv_aux), char);
1753 } else {
1754 array = (char *) HvARRAY(hv);
1755 Renew(array, PERL_HV_ARRAY_ALLOC_BYTES(HvMAX(hv) + 1)
1756 + sizeof(struct xpvhv_aux), char);
1757 }
1758 HvARRAY(hv) = (HE**) array;
1759 /* SvOOK_on(hv) attacks the IV flags. */
1760 SvFLAGS(hv) |= SVf_OOK;
1761 iter = HvAUX(hv);
bfcb3514
NC
1762
1763 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
1764 iter->xhv_eiter = Null(HE*); /* HvEITER(hv) = Null(HE*) */
1765 iter->xhv_name = 0;
1766
1767 return iter;
1768}
1769
954c1994
GS
1770/*
1771=for apidoc hv_iterinit
1772
1773Prepares a starting point to traverse a hash table. Returns the number of
1774keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
1c846c1f 1775currently only meaningful for hashes without tie magic.
954c1994
GS
1776
1777NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1778hash buckets that happen to be in use. If you still need that esoteric
1779value, you can get it through the macro C<HvFILL(tb)>.
1780
e16e2ff8 1781
954c1994
GS
1782=cut
1783*/
1784
79072805 1785I32
864dbfa3 1786Perl_hv_iterinit(pTHX_ HV *hv)
79072805 1787{
aa689395
PP
1788 HE *entry;
1789
1790 if (!hv)
cea2e8a9 1791 Perl_croak(aTHX_ "Bad hash");
bfcb3514 1792
b79f7545
NC
1793 if (SvOOK(hv)) {
1794 struct xpvhv_aux *iter = HvAUX(hv);
bfcb3514
NC
1795 entry = iter->xhv_eiter; /* HvEITER(hv) */
1796 if (entry && HvLAZYDEL(hv)) { /* was deleted earlier? */
1797 HvLAZYDEL_off(hv);
1798 hv_free_ent(hv, entry);
1799 }
1800 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
1801 iter->xhv_eiter = Null(HE*); /* HvEITER(hv) = Null(HE*) */
1802 } else {
b79f7545 1803 S_hv_auxinit(aTHX_ hv);
72940dca 1804 }
bfcb3514 1805
cbec9347 1806 /* used to be xhv->xhv_fill before 5.004_65 */
5d88ecd7 1807 return HvTOTALKEYS(hv);
79072805 1808}
bfcb3514
NC
1809
1810I32 *
1811Perl_hv_riter_p(pTHX_ HV *hv) {
1812 struct xpvhv_aux *iter;
1813
1814 if (!hv)
1815 Perl_croak(aTHX_ "Bad hash");
1816
b79f7545 1817 iter = SvOOK(hv) ? HvAUX(hv) : S_hv_auxinit(aTHX_ hv);
bfcb3514
NC
1818 return &(iter->xhv_riter);
1819}
1820
1821HE **
1822Perl_hv_eiter_p(pTHX_ HV *hv) {
1823 struct xpvhv_aux *iter;
1824
1825 if (!hv)
1826 Perl_croak(aTHX_ "Bad hash");
1827
b79f7545 1828 iter = SvOOK(hv) ? HvAUX(hv) : S_hv_auxinit(aTHX_ hv);
bfcb3514
NC
1829 return &(iter->xhv_eiter);
1830}
1831
1832void
1833Perl_hv_riter_set(pTHX_ HV *hv, I32 riter) {
1834 struct xpvhv_aux *iter;
1835
1836 if (!hv)
1837 Perl_croak(aTHX_ "Bad hash");
1838
b79f7545
NC
1839 if (SvOOK(hv)) {
1840 iter = HvAUX(hv);
1841 } else {
bfcb3514
NC
1842 if (riter == -1)
1843 return;
1844
b79f7545 1845 iter = S_hv_auxinit(aTHX_ hv);
bfcb3514
NC
1846 }
1847 iter->xhv_riter = riter;
1848}
1849
1850void
1851Perl_hv_eiter_set(pTHX_ HV *hv, HE *eiter) {
1852 struct xpvhv_aux *iter;
1853
1854 if (!hv)
1855 Perl_croak(aTHX_ "Bad hash");
1856
b79f7545
NC
1857 if (SvOOK(hv)) {
1858 iter = HvAUX(hv);
1859 } else {
bfcb3514
NC
1860 /* 0 is the default so don't go malloc()ing a new structure just to
1861 hold 0. */
1862 if (!eiter)
1863 return;
1864
b79f7545 1865 iter = S_hv_auxinit(aTHX_ hv);
bfcb3514
NC
1866 }
1867 iter->xhv_eiter = eiter;
1868}
1869
bfcb3514 1870void
7423f6db 1871Perl_hv_name_set(pTHX_ HV *hv, const char *name, I32 len, int flags)
bfcb3514 1872{
b79f7545 1873 struct xpvhv_aux *iter;
7423f6db 1874 U32 hash;
b464bac0 1875 (void)flags;
bfcb3514 1876
b79f7545
NC
1877 if (SvOOK(hv)) {
1878 iter = HvAUX(hv);
7423f6db
NC
1879 if (iter->xhv_name) {
1880 unshare_hek_or_pvn(iter->xhv_name, 0, 0, 0);
1881 }
16580ff5 1882 } else {
bfcb3514
NC
1883 if (name == 0)
1884 return;
1885
b79f7545 1886 iter = S_hv_auxinit(aTHX_ hv);
bfcb3514 1887 }
7423f6db
NC
1888 PERL_HASH(hash, name, len);
1889 iter->xhv_name = name ? share_hek(name, len, hash) : 0;
bfcb3514
NC
1890}
1891
954c1994
GS
1892/*
1893=for apidoc hv_iternext
1894
1895Returns entries from a hash iterator. See C<hv_iterinit>.
1896
fe7bca90
NC
1897You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
1898iterator currently points to, without losing your place or invalidating your
1899iterator. Note that in this case the current entry is deleted from the hash
1900with your iterator holding the last reference to it. Your iterator is flagged
1901to free the entry on the next call to C<hv_iternext>, so you must not discard
1902your iterator immediately else the entry will leak - call C<hv_iternext> to
1903trigger the resource deallocation.
1904
954c1994
GS
1905=cut
1906*/
1907
79072805 1908HE *
864dbfa3 1909Perl_hv_iternext(pTHX_ HV *hv)
79072805 1910{
e16e2ff8
NC
1911 return hv_iternext_flags(hv, 0);
1912}
1913
1914/*
fe7bca90
NC
1915=for apidoc hv_iternext_flags
1916
1917Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
1918The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
1919set the placeholders keys (for restricted hashes) will be returned in addition
1920to normal keys. By default placeholders are automatically skipped over.
7996736c
MHM
1921Currently a placeholder is implemented with a value that is
1922C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
fe7bca90
NC
1923restricted hashes may change, and the implementation currently is
1924insufficiently abstracted for any change to be tidy.
e16e2ff8 1925
fe7bca90 1926=cut
e16e2ff8
NC
1927*/
1928
1929HE *
1930Perl_hv_iternext_flags(pTHX_ HV *hv, I32 flags)
1931{
27da23d5 1932 dVAR;
cbec9347 1933 register XPVHV* xhv;
79072805 1934 register HE *entry;
a0d0e21e 1935 HE *oldentry;
463ee0b2 1936 MAGIC* mg;
bfcb3514 1937 struct xpvhv_aux *iter;
79072805
LW
1938
1939 if (!hv)
cea2e8a9 1940 Perl_croak(aTHX_ "Bad hash");
cbec9347 1941 xhv = (XPVHV*)SvANY(hv);
bfcb3514 1942
b79f7545 1943 if (!SvOOK(hv)) {
bfcb3514
NC
1944 /* Too many things (well, pp_each at least) merrily assume that you can
1945 call iv_iternext without calling hv_iterinit, so we'll have to deal
1946 with it. */
1947 hv_iterinit(hv);
bfcb3514 1948 }
b79f7545 1949 iter = HvAUX(hv);
bfcb3514
NC
1950
1951 oldentry = entry = iter->xhv_eiter; /* HvEITER(hv) */
463ee0b2 1952
14befaf4 1953 if ((mg = SvTIED_mg((SV*)hv, PERL_MAGIC_tied))) {
8990e307 1954 SV *key = sv_newmortal();
cd1469e6 1955 if (entry) {
fde52b5c 1956 sv_setsv(key, HeSVKEY_force(entry));
cd1469e6
PP
1957 SvREFCNT_dec(HeSVKEY(entry)); /* get rid of previous key */
1958 }
a0d0e21e 1959 else {
ff68c719 1960 char *k;
bbce6d69 1961 HEK *hek;
ff68c719 1962
cbec9347 1963 /* one HE per MAGICAL hash */
bfcb3514 1964 iter->xhv_eiter = entry = new_HE(); /* HvEITER(hv) = new_HE() */
4633a7c4 1965 Zero(entry, 1, HE);
ff68c719
PP
1966 Newz(54, k, HEK_BASESIZE + sizeof(SV*), char);
1967 hek = (HEK*)k;
1968 HeKEY_hek(entry) = hek;
fde52b5c 1969 HeKLEN(entry) = HEf_SVKEY;
a0d0e21e
LW
1970 }
1971 magic_nextpack((SV*) hv,mg,key);
8aacddc1 1972 if (SvOK(key)) {
cd1469e6 1973 /* force key to stay around until next time */
bbce6d69
PP
1974 HeSVKEY_set(entry, SvREFCNT_inc(key));
1975 return entry; /* beware, hent_val is not set */
8aacddc1 1976 }
fde52b5c
PP
1977 if (HeVAL(entry))
1978 SvREFCNT_dec(HeVAL(entry));
ff68c719 1979 Safefree(HeKEY_hek(entry));
d33b2eba 1980 del_HE(entry);
bfcb3514 1981 iter->xhv_eiter = Null(HE*); /* HvEITER(hv) = Null(HE*) */
463ee0b2 1982 return Null(HE*);
79072805 1983 }
f675dbe5 1984#ifdef DYNAMIC_ENV_FETCH /* set up %ENV for iteration */
cbec9347 1985 if (!entry && SvRMAGICAL((SV*)hv) && mg_find((SV*)hv, PERL_MAGIC_env))
f675dbe5
CB
1986 prime_env_iter();
1987#endif
463ee0b2 1988
b79f7545
NC
1989 /* hv_iterint now ensures this. */
1990 assert (HvARRAY(hv));
1991
015a5f36 1992 /* At start of hash, entry is NULL. */
fde52b5c 1993 if (entry)
8aacddc1 1994 {
fde52b5c 1995 entry = HeNEXT(entry);
e16e2ff8
NC
1996 if (!(flags & HV_ITERNEXT_WANTPLACEHOLDERS)) {
1997 /*
1998 * Skip past any placeholders -- don't want to include them in
1999 * any iteration.
2000 */
7996736c 2001 while (entry && HeVAL(entry) == &PL_sv_placeholder) {
e16e2ff8
NC
2002 entry = HeNEXT(entry);
2003 }
8aacddc1
NIS
2004 }
2005 }
fde52b5c 2006 while (!entry) {
015a5f36
NC
2007 /* OK. Come to the end of the current list. Grab the next one. */
2008
bfcb3514
NC
2009 iter->xhv_riter++; /* HvRITER(hv)++ */
2010 if (iter->xhv_riter > (I32)xhv->xhv_max /* HvRITER(hv) > HvMAX(hv) */) {
015a5f36 2011 /* There is no next one. End of the hash. */
bfcb3514 2012 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
fde52b5c 2013 break;
79072805 2014 }
7b2c381c 2015 entry = (HvARRAY(hv))[iter->xhv_riter];
8aacddc1 2016
e16e2ff8 2017 if (!(flags & HV_ITERNEXT_WANTPLACEHOLDERS)) {
015a5f36
NC
2018 /* If we have an entry, but it's a placeholder, don't count it.
2019 Try the next. */
7996736c 2020 while (entry && HeVAL(entry) == &PL_sv_placeholder)
015a5f36
NC
2021 entry = HeNEXT(entry);
2022 }
2023 /* Will loop again if this linked list starts NULL
2024 (for HV_ITERNEXT_WANTPLACEHOLDERS)
2025 or if we run through it and find only placeholders. */
fde52b5c 2026 }
79072805 2027
72940dca
PP
2028 if (oldentry && HvLAZYDEL(hv)) { /* was deleted earlier? */
2029 HvLAZYDEL_off(hv);
68dc0745 2030 hv_free_ent(hv, oldentry);
72940dca 2031 }
a0d0e21e 2032
fdcd69b6
NC
2033 /*if (HvREHASH(hv) && entry && !HeKREHASH(entry))
2034 PerlIO_printf(PerlIO_stderr(), "Awooga %p %p\n", hv, entry);*/
2035
bfcb3514 2036 iter->xhv_eiter = entry; /* HvEITER(hv) = entry */
79072805
LW
2037 return entry;
2038}
2039
954c1994
GS
2040/*
2041=for apidoc hv_iterkey
2042
2043Returns the key from the current position of the hash iterator. See
2044C<hv_iterinit>.
2045
2046=cut
2047*/
2048
79072805 2049char *
864dbfa3 2050Perl_hv_iterkey(pTHX_ register HE *entry, I32 *retlen)
79072805 2051{
fde52b5c 2052 if (HeKLEN(entry) == HEf_SVKEY) {
fb73857a
PP
2053 STRLEN len;
2054 char *p = SvPV(HeKEY_sv(entry), len);
2055 *retlen = len;
2056 return p;
fde52b5c
PP
2057 }
2058 else {
2059 *retlen = HeKLEN(entry);
2060 return HeKEY(entry);
2061 }
2062}
2063
2064/* unlike hv_iterval(), this always returns a mortal copy of the key */
954c1994
GS
2065/*
2066=for apidoc hv_iterkeysv
2067
2068Returns the key as an C<SV*> from the current position of the hash
2069iterator. The return value will always be a mortal copy of the key. Also
2070see C<hv_iterinit>.
2071
2072=cut
2073*/
2074
fde52b5c 2075SV *
864dbfa3 2076Perl_hv_iterkeysv(pTHX_ register HE *entry)
fde52b5c 2077{
c1b02ed8 2078 return sv_2mortal(newSVhek(HeKEY_hek(entry)));
79072805
LW
2079}
2080
954c1994
GS
2081/*
2082=for apidoc hv_iterval
2083
2084Returns the value from the current position of the hash iterator. See
2085C<hv_iterkey>.
2086
2087=cut
2088*/
2089
79072805 2090SV *
864dbfa3 2091Perl_hv_iterval(pTHX_ HV *hv, register HE *entry)
79072805 2092{
8990e307 2093 if (SvRMAGICAL(hv)) {
14befaf4 2094 if (mg_find((SV*)hv, PERL_MAGIC_tied)) {
8990e307 2095 SV* sv = sv_newmortal();
bbce6d69
PP
2096 if (HeKLEN(entry) == HEf_SVKEY)
2097 mg_copy((SV*)hv, sv, (char*)HeKEY_sv(entry), HEf_SVKEY);
a3b680e6
AL
2098 else
2099 mg_copy((SV*)hv, sv, HeKEY(entry), HeKLEN(entry));
463ee0b2
LW
2100 return sv;
2101 }
79072805 2102 }
fde52b5c 2103 return HeVAL(entry);
79072805
LW
2104}
2105
954c1994
GS
2106/*
2107=for apidoc hv_iternextsv
2108
2109Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
2110operation.
2111
2112=cut
2113*/
2114
a0d0e21e 2115SV *
864dbfa3 2116Perl_hv_iternextsv(pTHX_ HV *hv, char **key, I32 *retlen)
a0d0e21e
LW
2117{
2118 HE *he;
e16e2ff8 2119 if ( (he = hv_iternext_flags(hv, 0)) == NULL)
a0d0e21e
LW
2120 return NULL;
2121 *key = hv_iterkey(he, retlen);
2122 return hv_iterval(hv, he);
2123}
2124
954c1994
GS
2125/*
2126=for apidoc hv_magic
2127
2128Adds magic to a hash. See C<sv_magic>.
2129
2130=cut
2131*/
2132
79072805 2133void
864dbfa3 2134Perl_hv_magic(pTHX_ HV *hv, GV *gv, int how)
79072805 2135{
a0d0e21e 2136 sv_magic((SV*)hv, (SV*)gv, how, Nullch, 0);
79072805 2137}
fde52b5c 2138
37d85e3a
JH
2139#if 0 /* use the macro from hv.h instead */
2140
bbce6d69 2141char*
864dbfa3 2142Perl_sharepvn(pTHX_ const char *sv, I32 len, U32 hash)
bbce6d69 2143{
ff68c719 2144 return HEK_KEY(share_hek(sv, len, hash));
bbce6d69
PP
2145}
2146
37d85e3a
JH
2147#endif
2148
bbce6d69 2149/* possibly free a shared string if no one has access to it
fde52b5c
PP
2150 * len and hash must both be valid for str.
2151 */
bbce6d69 2152void
864dbfa3 2153Perl_unsharepvn(pTHX_ const char *str, I32 len, U32 hash)
fde52b5c 2154{
19692e8d
NC
2155 unshare_hek_or_pvn (NULL, str, len, hash);
2156}
2157
2158
2159void
2160Perl_unshare_hek(pTHX_ HEK *hek)
2161{
2162 unshare_hek_or_pvn(hek, NULL, 0, 0);
2163}
2164
2165/* possibly free a shared string if no one has access to it
2166 hek if non-NULL takes priority over the other 3, else str, len and hash
2167 are used. If so, len and hash must both be valid for str.
2168 */
df132699 2169STATIC void
97ddebaf 2170S_unshare_hek_or_pvn(pTHX_ const HEK *hek, const char *str, I32 len, U32 hash)
19692e8d 2171{
cbec9347 2172 register XPVHV* xhv;
fde52b5c
PP
2173 register HE *entry;
2174 register HE **oentry;
45d1cc86 2175 HE **first;
a3b680e6 2176 bool found = 0;
c3654f1a 2177 bool is_utf8 = FALSE;
19692e8d 2178 int k_flags = 0;
f9a63242 2179 const char *save = str;
cbae3960 2180 struct shared_he *he = 0;
c3654f1a 2181
19692e8d 2182 if (hek) {
cbae3960
NC
2183 /* Find the shared he which is just before us in memory. */
2184 he = (struct shared_he *)(((char *)hek)
2185 - STRUCT_OFFSET(struct shared_he,
2186 shared_he_hek));
2187
2188 /* Assert that the caller passed us a genuine (or at least consistent)
2189 shared hek */
2190 assert (he->shared_he_he.hent_hek == hek);
29404ae0
NC
2191
2192 LOCK_STRTAB_MUTEX;
2193 if (he->shared_he_he.hent_val - 1) {
2194 --he->shared_he_he.hent_val;
2195 UNLOCK_STRTAB_MUTEX;
2196 return;
2197 }
2198 UNLOCK_STRTAB_MUTEX;
2199
19692e8d
NC
2200 hash = HEK_HASH(hek);
2201 } else if (len < 0) {
2202 STRLEN tmplen = -len;
2203 is_utf8 = TRUE;
2204 /* See the note in hv_fetch(). --jhi */
2205 str = (char*)bytes_from_utf8((U8*)str, &tmplen, &is_utf8);
2206 len = tmplen;
2207 if (is_utf8)
2208 k_flags = HVhek_UTF8;
2209 if (str != save)
2210 k_flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
c3654f1a 2211 }
1c846c1f 2212
fde52b5c 2213 /* what follows is the moral equivalent of:
6b88bc9c 2214 if ((Svp = hv_fetch(PL_strtab, tmpsv, FALSE, hash))) {
bbce6d69 2215 if (--*Svp == Nullsv)
6b88bc9c 2216 hv_delete(PL_strtab, str, len, G_DISCARD, hash);
bbce6d69 2217 } */
cbec9347 2218 xhv = (XPVHV*)SvANY(PL_strtab);
fde52b5c 2219 /* assert(xhv_array != 0) */
5f08fbcd 2220 LOCK_STRTAB_MUTEX;
45d1cc86 2221 first = oentry = &(HvARRAY(PL_strtab))[hash & (I32) HvMAX(PL_strtab)];
6c1b96a1
NC
2222 if (he) {
2223 const HE *const he_he = &(he->shared_he_he);
45d1cc86 2224 for (entry = *oentry; entry; oentry = &HeNEXT(entry), entry = *oentry) {
6c1b96a1 2225 if (entry != he_he)
19692e8d
NC
2226 continue;
2227 found = 1;
2228 break;
2229 }
2230 } else {
35a4481c 2231 const int flags_masked = k_flags & HVhek_MASK;
45d1cc86 2232 for (entry = *oentry; entry; oentry = &HeNEXT(entry), entry = *oentry) {
19692e8d
NC
2233 if (HeHASH(entry) != hash) /* strings can't be equal */
2234 continue;
2235 if (HeKLEN(entry) != len)
2236 continue;
2237 if (HeKEY(entry) != str && memNE(HeKEY(entry),str,len)) /* is this it? */
2238 continue;
2239 if (HeKFLAGS(entry) != flags_masked)
2240 continue;
2241 found = 1;
2242 break;
2243 }
2244 }
2245
2246 if (found) {
2247 if (--HeVAL(entry) == Nullsv) {
2248 *oentry = HeNEXT(entry);
45d1cc86
NC
2249 if (!*first) {
2250 /* There are now no entries in our slot. */
19692e8d 2251 xhv->xhv_fill--; /* HvFILL(hv)-- */
45d1cc86 2252 }
cbae3960 2253 Safefree(entry);
19692e8d
NC
2254 xhv->xhv_keys--; /* HvKEYS(hv)-- */
2255 }
fde52b5c 2256 }
19692e8d 2257
333f433b 2258 UNLOCK_STRTAB_MUTEX;
411caa50 2259 if (!found && ckWARN_d(WARN_INTERNAL))
19692e8d 2260 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
472d47bc
SB
2261 "Attempt to free non-existent shared string '%s'%s"
2262 pTHX__FORMAT,
19692e8d 2263 hek ? HEK_KEY(hek) : str,
472d47bc 2264 ((k_flags & HVhek_UTF8) ? " (utf8)" : "") pTHX__VALUE);
19692e8d
NC
2265 if (k_flags & HVhek_FREEKEY)
2266 Safefree(str);
fde52b5c
PP
2267}
2268
bbce6d69
PP
2269/* get a (constant) string ptr from the global string table
2270 * string will get added if it is not already there.
fde52b5c
PP
2271 * len and hash must both be valid for str.
2272 */
bbce6d69 2273HEK *
864dbfa3 2274Perl_share_hek(pTHX_ const char *str, I32 len, register U32 hash)
fde52b5c 2275{
da58a35d 2276 bool is_utf8 = FALSE;
19692e8d 2277 int flags = 0;
f9a63242 2278 const char *save = str;
da58a35d
JH
2279
2280 if (len < 0) {
77caf834 2281 STRLEN tmplen = -len;
da58a35d 2282 is_utf8 = TRUE;
77caf834
JH
2283 /* See the note in hv_fetch(). --jhi */
2284 str = (char*)bytes_from_utf8((U8*)str, &tmplen, &is_utf8);
2285 len = tmplen;
19692e8d
NC
2286 /* If we were able to downgrade here, then than means that we were passed
2287 in a key which only had chars 0-255, but was utf8 encoded. */
2288 if (is_utf8)
2289 flags = HVhek_UTF8;
2290 /* If we found we were able to downgrade the string to bytes, then
2291 we should flag that it needs upgrading on keys or each. Also flag
2292 that we need share_hek_flags to free the string. */
2293 if (str != save)
2294 flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
2295 }
2296
6e838c70 2297 return share_hek_flags (str, len, hash, flags);
19692e8d
NC
2298}
2299
6e838c70 2300STATIC HEK *
19692e8d
NC
2301S_share_hek_flags(pTHX_ const char *str, I32 len, register U32 hash, int flags)
2302{
19692e8d
NC
2303 register HE *entry;
2304 register HE **oentry;
19692e8d 2305 I32 found = 0;
35a4481c 2306 const int flags_masked = flags & HVhek_MASK;
bbce6d69 2307
fde52b5c 2308 /* what follows is the moral equivalent of:
1c846c1f 2309
6b88bc9c 2310 if (!(Svp = hv_fetch(PL_strtab, str, len, FALSE)))
8aacddc1 2311 hv_store(PL_strtab, str, len, Nullsv, hash);
fdcd69b6
NC
2312
2313 Can't rehash the shared string table, so not sure if it's worth
2314 counting the number of entries in the linked list
bbce6d69 2315 */
1b6737cc 2316 register XPVHV * const xhv = (XPVHV*)SvANY(PL_strtab);
fde52b5c 2317 /* assert(xhv_array != 0) */
5f08fbcd 2318 LOCK_STRTAB_MUTEX;
7b2c381c 2319 oentry = &(HvARRAY(PL_strtab))[hash & (I32) HvMAX(PL_strtab)];
45d1cc86 2320 for (entry = *oentry; entry; entry = HeNEXT(entry)) {
fde52b5c
PP
2321 if (HeHASH(entry) != hash) /* strings can't be equal */
2322 continue;
2323 if (HeKLEN(entry) != len)
2324 continue;
1c846c1f 2325 if (HeKEY(entry) != str && memNE(HeKEY(entry),str,len)) /* is this it? */
fde52b5c 2326 continue;
19692e8d 2327 if (HeKFLAGS(entry) != flags_masked)
c3654f1a 2328 continue;
fde52b5c 2329 found = 1;
fde52b5c
PP
2330 break;
2331 }
bbce6d69 2332 if (!found) {
45d1cc86
NC
2333 /* What used to be head of the list.
2334 If this is NULL, then we're the first entry for this slot, which
2335 means we need to increate fill. */
2336 const HE *old_first = *oentry;
cbae3960
NC
2337 struct shared_he *new_entry;
2338 HEK *hek;
2339 char *k;
2340
2341 /* We don't actually store a HE from the arena and a regular HEK.
2342 Instead we allocate one chunk of memory big enough for both,
2343 and put the HEK straight after the HE. This way we can find the
2344 HEK directly from the HE.
2345 */
2346
2347 New(0, k, STRUCT_OFFSET(struct shared_he,
2348 shared_he_hek.hek_key[0]) + len + 2, char);
2349 new_entry = (struct shared_he *)k;
2350 entry = &(new_entry->shared_he_he);
2351 hek = &(new_entry->shared_he_hek);
2352
2353 Copy(str, HEK_KEY(hek), len, char);
2354 HEK_KEY(hek)[len] = 0;
2355 HEK_LEN(hek) = len;
2356 HEK_HASH(hek) = hash;
2357 HEK_FLAGS(hek) = (unsigned char)flags_masked;
2358
2359 /* Still "point" to the HEK, so that other code need not know what
2360 we're up to. */
2361 HeKEY_hek(entry) = hek;
bbce6d69
PP
2362 HeVAL(entry) = Nullsv;
2363 HeNEXT(entry) = *oentry;
2364 *oentry = entry;
cbae3960 2365
cbec9347 2366 xhv->xhv_keys++; /* HvKEYS(hv)++ */
45d1cc86 2367 if (!old_first) { /* initial entry? */
cbec9347 2368 xhv->xhv_fill++; /* HvFILL(hv)++ */
4c9cc595 2369 } else if (xhv->xhv_keys > (IV)xhv->xhv_max /* HvKEYS(hv) > HvMAX(hv) */) {
cbec9347 2370 hsplit(PL_strtab);
bbce6d69
PP
2371 }
2372 }
2373
2374 ++HeVAL(entry); /* use value slot as REFCNT */
5f08fbcd 2375 UNLOCK_STRTAB_MUTEX;
19692e8d
NC
2376
2377 if (flags & HVhek_FREEKEY)
f9a63242 2378 Safefree(str);
19692e8d 2379
6e838c70 2380 return HeKEY_hek(entry);
fde52b5c 2381}
ecae49c0 2382
ca732855
NC
2383I32 *
2384Perl_hv_placeholders_p(pTHX_ HV *hv)
2385{
2386 dVAR;
2387 MAGIC *mg = mg_find((SV*)hv, PERL_MAGIC_rhash);
2388
2389 if (!mg) {
2390 mg = sv_magicext((SV*)hv, 0, PERL_MAGIC_rhash, 0, 0, 0);
2391
2392 if (!mg) {
2393 Perl_die(aTHX_ "panic: hv_placeholders_p");
2394 }
2395 }
2396 return &(mg->mg_len);
2397}
2398
2399
2400I32
2401Perl_hv_placeholders_get(pTHX_ HV *hv)
2402{
2403 dVAR;
b464bac0 2404 MAGIC * const mg = mg_find((SV*)hv, PERL_MAGIC_rhash);
ca732855
NC
2405
2406 return mg ? mg->mg_len : 0;
2407}
2408
2409void
ac1e784a 2410Perl_hv_placeholders_set(pTHX_ HV *hv, I32 ph)
ca732855
NC
2411{
2412 dVAR;
b464bac0 2413 MAGIC * const mg = mg_find((SV*)hv, PERL_MAGIC_rhash);
ca732855
NC
2414
2415 if (mg) {
2416 mg->mg_len = ph;
2417 } else if (ph) {
2418 if (!sv_magicext((SV*)hv, 0, PERL_MAGIC_rhash, 0, 0, ph))
2419 Perl_die(aTHX_ "panic: hv_placeholders_set");
2420 }
2421 /* else we don't need to add magic to record 0 placeholders. */
2422}
ecae49c0
NC
2423
2424/*
2425=for apidoc hv_assert
2426
2427Check that a hash is in an internally consistent state.
2428
2429=cut
2430*/
2431
2432void
2433Perl_hv_assert(pTHX_ HV *hv)
2434{
27da23d5 2435 dVAR;
ecae49c0
NC
2436 HE* entry;
2437 int withflags = 0;
2438 int placeholders = 0;
2439 int real = 0;
2440 int bad = 0;
bfcb3514
NC
2441 const I32 riter = HvRITER_get(hv);
2442 HE *eiter = HvEITER_get(hv);
ecae49c0
NC
2443
2444 (void)hv_iterinit(hv);
2445
2446 while ((entry = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS))) {
2447 /* sanity check the values */
2448 if (HeVAL(entry) == &PL_sv_placeholder) {
2449 placeholders++;
2450 } else {
2451 real++;
2452 }
2453 /* sanity check the keys */
2454 if (HeSVKEY(entry)) {
2455 /* Don't know what to check on SV keys. */
2456 } else if (HeKUTF8(entry)) {
2457 withflags++;
2458 if (HeKWASUTF8(entry)) {
2459 PerlIO_printf(Perl_debug_log,
2460 "hash key has both WASUFT8 and UTF8: '%.*s'\n",
2461 (int) HeKLEN(entry), HeKEY(entry));
2462 bad = 1;
2463 }
2464 } else if (HeKWASUTF8(entry)) {
2465 withflags++;
2466 }
2467 }
2468 if (!SvTIED_mg((SV*)hv, PERL_MAGIC_tied)) {
2469 if (HvUSEDKEYS(hv) != real) {
2470 PerlIO_printf(Perl_debug_log, "Count %d key(s), but hash reports %d\n",
2471 (int) real, (int) HvUSEDKEYS(hv));
2472 bad = 1;
2473 }
5d88ecd7 2474 if (HvPLACEHOLDERS_get(hv) != placeholders) {
ecae49c0
NC
2475 PerlIO_printf(Perl_debug_log,
2476 "Count %d placeholder(s), but hash reports %d\n",
5d88ecd7 2477 (int) placeholders, (int) HvPLACEHOLDERS_get(hv));
ecae49c0
NC
2478 bad = 1;
2479 }
2480 }
2481 if (withflags && ! HvHASKFLAGS(hv)) {
2482 PerlIO_printf(Perl_debug_log,
2483 "Hash has HASKFLAGS off but I count %d key(s) with flags\n",
2484 withflags);
2485 bad = 1;
2486 }
2487 if (bad) {
2488 sv_dump((SV *)hv);
2489 }
bfcb3514
NC
2490 HvRITER_set(hv, riter); /* Restore hash iterator state */
2491 HvEITER_set(hv, eiter);
ecae49c0 2492}
af3babe4
NC
2493
2494/*
2495 * Local variables:
2496 * c-indentation-style: bsd
2497 * c-basic-offset: 4
2498 * indent-tabs-mode: t
2499 * End:
2500 *
37442d52
RGS
2501 * ex: set ts=8 sts=4 sw=4 noet:
2502 */