| CARVIEW |
Select Language
HTTP/2 302
server: nginx
date: Mon, 28 Jul 2025 07:26:00 GMT
content-type: text/plain; charset=utf-8
content-length: 0
x-archive-redirect-reason: found capture at 20170220122239
location: https://web.archive.org/web/20170220122239/https://perl5.git.perl.org/perl.git/blob/HEAD:/hv.c
server-timing: captures_list;dur=0.550423, exclusion.robots;dur=0.020288, exclusion.robots.policy;dur=0.009956, esindex;dur=0.016643, cdx.remote;dur=136.629626, LoadShardBlock;dur=169.611452, PetaboxLoader3.datanode;dur=101.544576
x-app-server: wwwb-app218
x-ts: 302
x-tr: 332
server-timing: TR;dur=0,Tw;dur=0,Tc;dur=0
set-cookie: SERVER=wwwb-app218; path=/
x-location: All
x-rl: 0
x-na: 0
x-page-cache: MISS
server-timing: MISS
x-nid: DigitalOcean
referrer-policy: no-referrer-when-downgrade
permissions-policy: interest-cohort=()
HTTP/2 302
server: nginx
date: Mon, 28 Jul 2025 07:26:01 GMT
content-type: text/plain; charset=utf-8
content-length: 0
x-archive-redirect-reason: found capture at 20170220122241
location: https://web.archive.org/web/20170220122241/https://perl5.git.perl.org/perl.git/blob/HEAD:/hv.c
server-timing: captures_list;dur=0.702530, exclusion.robots;dur=0.030383, exclusion.robots.policy;dur=0.010425, esindex;dur=0.012863, cdx.remote;dur=46.412513, LoadShardBlock;dur=153.397985, PetaboxLoader3.datanode;dur=130.739633, PetaboxLoader3.resolve;dur=369.838733, load_resource;dur=405.489422
x-app-server: wwwb-app218
x-ts: 302
x-tr: 665
server-timing: TR;dur=0,Tw;dur=0,Tc;dur=0
x-location: All
x-rl: 0
x-na: 0
x-page-cache: MISS
server-timing: MISS
x-nid: DigitalOcean
referrer-policy: no-referrer-when-downgrade
permissions-policy: interest-cohort=()
HTTP/2 200
server: nginx
date: Mon, 28 Jul 2025 07:26:03 GMT
content-type: application/xhtml+xml; charset=utf-8
x-archive-orig-date: Mon, 20 Feb 2017 12:22:41 GMT
x-archive-orig-server: Apache/2.2.15 (CentOS)
x-archive-orig-connection: close
x-archive-orig-transfer-encoding: chunked
x-archive-guessed-content-type: text/html
x-archive-guessed-charset: utf-8
memento-datetime: Mon, 20 Feb 2017 12:22:41 GMT
link: ; rel="original", ; rel="timemap"; type="application/link-format", ; rel="timegate", ; rel="first memento"; datetime="Mon, 20 Feb 2017 12:22:39 GMT", ; rel="prev memento"; datetime="Mon, 20 Feb 2017 12:22:39 GMT", ; rel="memento"; datetime="Mon, 20 Feb 2017 12:22:41 GMT", ; rel="next memento"; datetime="Tue, 18 Jun 2019 22:56:38 GMT", ; rel="last memento"; datetime="Wed, 30 Oct 2024 10:57:27 GMT"
content-security-policy: default-src 'self' 'unsafe-eval' 'unsafe-inline' data: blob: archive.org web.archive.org web-static.archive.org wayback-api.archive.org athena.archive.org analytics.archive.org pragma.archivelab.org wwwb-events.archive.org
x-archive-src: falconk_archivebot_www_perlmonks_org_20170214/www.perlmonks.org-inf-20170214-150724-7wgmd-00004.warc.gz
server-timing: captures_list;dur=0.926621, exclusion.robots;dur=0.031812, exclusion.robots.policy;dur=0.015356, esindex;dur=0.016792, cdx.remote;dur=315.762084, LoadShardBlock;dur=58.617892, PetaboxLoader3.datanode;dur=85.437067, load_resource;dur=140.059942, PetaboxLoader3.resolve;dur=69.999903
x-app-server: wwwb-app218
x-ts: 200
x-tr: 1547
server-timing: TR;dur=0,Tw;dur=0,Tc;dur=0
x-location: All
x-rl: 0
x-na: 0
x-page-cache: MISS
server-timing: MISS
x-nid: DigitalOcean
referrer-policy: no-referrer-when-downgrade
permissions-policy: interest-cohort=()
Perl 5 - perl.git/blob - hv.c
1 /* hv.c
2 *
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
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 *
9 */
11 /*
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"]
17 */
19 /*
20 =head1 Hash Manipulation Functions
21 A HV structure represents a Perl hash. It consists mainly of an array
22 of pointers, each of which points to a linked list of HE structures. The
23 array is indexed by the hash function of the key, so each linked list
24 represents all the hash entries with the same hash value. Each HE contains
25 a pointer to the actual value, plus a pointer to a HEK structure which
26 holds the key and hash value.
28 =cut
30 */
32 #include "EXTERN.h"
33 #define PERL_IN_HV_C
34 #define PERL_HASH_INTERNAL_ACCESS
35 #include "perl.h"
37 #define DO_HSPLIT(xhv) ((xhv)->xhv_keys > (xhv)->xhv_max) /* HvTOTALKEYS(hv) > HvMAX(hv) */
38 #define HV_FILL_THRESHOLD 31
40 static const char S_strtab_error[]
41 = "Cannot modify shared string table in hv_%s";
43 #ifdef PURIFY
45 #define new_HE() (HE*)safemalloc(sizeof(HE))
46 #define del_HE(p) safefree((char*)p)
48 #else
50 STATIC HE*
51 S_new_he(pTHX)
52 {
53 HE* he;
54 void ** const root = &PL_body_roots[HE_SVSLOT];
56 if (!*root)
57 Perl_more_bodies(aTHX_ HE_SVSLOT, sizeof(HE), PERL_ARENA_SIZE);
58 he = (HE*) *root;
59 assert(he);
60 *root = HeNEXT(he);
61 return he;
62 }
64 #define new_HE() new_he()
65 #define del_HE(p) \
66 STMT_START { \
67 HeNEXT(p) = (HE*)(PL_body_roots[HE_SVSLOT]); \
68 PL_body_roots[HE_SVSLOT] = p; \
69 } STMT_END
73 #endif
75 STATIC HEK *
76 S_save_hek_flags(const char *str, I32 len, U32 hash, int flags)
77 {
78 const int flags_masked = flags & HVhek_MASK;
79 char *k;
80 HEK *hek;
82 PERL_ARGS_ASSERT_SAVE_HEK_FLAGS;
84 Newx(k, HEK_BASESIZE + len + 2, char);
85 hek = (HEK*)k;
86 Copy(str, HEK_KEY(hek), len, char);
87 HEK_KEY(hek)[len] = 0;
88 HEK_LEN(hek) = len;
89 HEK_HASH(hek) = hash;
90 HEK_FLAGS(hek) = (unsigned char)flags_masked | HVhek_UNSHARED;
92 if (flags & HVhek_FREEKEY)
93 Safefree(str);
94 return hek;
95 }
97 /* free the pool of temporary HE/HEK pairs returned by hv_fetch_ent
98 * for tied hashes */
100 void
101 Perl_free_tied_hv_pool(pTHX)
102 {
103 HE *he = PL_hv_fetch_ent_mh;
104 while (he) {
105 HE * const ohe = he;
106 Safefree(HeKEY_hek(he));
107 he = HeNEXT(he);
108 del_HE(ohe);
109 }
110 PL_hv_fetch_ent_mh = NULL;
111 }
113 #if defined(USE_ITHREADS)
114 HEK *
115 Perl_hek_dup(pTHX_ HEK *source, CLONE_PARAMS* param)
116 {
117 HEK *shared;
119 PERL_ARGS_ASSERT_HEK_DUP;
120 PERL_UNUSED_ARG(param);
122 if (!source)
123 return NULL;
125 shared = (HEK*)ptr_table_fetch(PL_ptr_table, source);
126 if (shared) {
127 /* We already shared this hash key. */
128 (void)share_hek_hek(shared);
129 }
130 else {
131 shared
132 = share_hek_flags(HEK_KEY(source), HEK_LEN(source),
133 HEK_HASH(source), HEK_FLAGS(source));
134 ptr_table_store(PL_ptr_table, source, shared);
135 }
136 return shared;
137 }
139 HE *
140 Perl_he_dup(pTHX_ const HE *e, bool shared, CLONE_PARAMS* param)
141 {
142 HE *ret;
144 PERL_ARGS_ASSERT_HE_DUP;
146 if (!e)
147 return NULL;
148 /* look for it in the table first */
149 ret = (HE*)ptr_table_fetch(PL_ptr_table, e);
150 if (ret)
151 return ret;
153 /* create anew and remember what it is */
154 ret = new_HE();
155 ptr_table_store(PL_ptr_table, e, ret);
157 HeNEXT(ret) = he_dup(HeNEXT(e),shared, param);
158 if (HeKLEN(e) == HEf_SVKEY) {
159 char *k;
160 Newx(k, HEK_BASESIZE + sizeof(const SV *), char);
161 HeKEY_hek(ret) = (HEK*)k;
162 HeKEY_sv(ret) = sv_dup_inc(HeKEY_sv(e), param);
163 }
164 else if (shared) {
165 /* This is hek_dup inlined, which seems to be important for speed
166 reasons. */
167 HEK * const source = HeKEY_hek(e);
168 HEK *shared = (HEK*)ptr_table_fetch(PL_ptr_table, source);
170 if (shared) {
171 /* We already shared this hash key. */
172 (void)share_hek_hek(shared);
173 }
174 else {
175 shared
176 = share_hek_flags(HEK_KEY(source), HEK_LEN(source),
177 HEK_HASH(source), HEK_FLAGS(source));
178 ptr_table_store(PL_ptr_table, source, shared);
179 }
180 HeKEY_hek(ret) = shared;
181 }
182 else
183 HeKEY_hek(ret) = save_hek_flags(HeKEY(e), HeKLEN(e), HeHASH(e),
184 HeKFLAGS(e));
185 HeVAL(ret) = sv_dup_inc(HeVAL(e), param);
186 return ret;
187 }
188 #endif /* USE_ITHREADS */
190 static void
191 S_hv_notallowed(pTHX_ int flags, const char *key, I32 klen,
192 const char *msg)
193 {
194 SV * const sv = sv_newmortal();
196 PERL_ARGS_ASSERT_HV_NOTALLOWED;
198 if (!(flags & HVhek_FREEKEY)) {
199 sv_setpvn(sv, key, klen);
200 }
201 else {
202 /* Need to free saved eventually assign to mortal SV */
203 /* XXX is this line an error ???: SV *sv = sv_newmortal(); */
204 sv_usepvn(sv, (char *) key, klen);
205 }
206 if (flags & HVhek_UTF8) {
207 SvUTF8_on(sv);
208 }
209 Perl_croak(aTHX_ msg, SVfARG(sv));
210 }
212 /* (klen == HEf_SVKEY) is special for MAGICAL hv entries, meaning key slot
213 * contains an SV* */
215 /*
216 =for apidoc hv_store
218 Stores an SV in a hash. The hash key is specified as C<key> and the
219 absolute value of C<klen> is the length of the key. If C<klen> is
220 negative the key is assumed to be in UTF-8-encoded Unicode. The
221 C<hash> parameter is the precomputed hash value; if it is zero then
222 Perl will compute it.
224 The return value will be
225 C<NULL> if the operation failed or if the value did not need to be actually
226 stored within the hash (as in the case of tied hashes). Otherwise it can
227 be dereferenced to get the original C<SV*>. Note that the caller is
228 responsible for suitably incrementing the reference count of C<val> before
229 the call, and decrementing it if the function returned C<NULL>. Effectively
230 a successful C<hv_store> takes ownership of one reference to C<val>. This is
231 usually what you want; a newly created SV has a reference count of one, so
232 if all your code does is create SVs then store them in a hash, C<hv_store>
233 will own the only reference to the new SV, and your code doesn't need to do
234 anything further to tidy up. C<hv_store> is not implemented as a call to
235 C<hv_store_ent>, and does not create a temporary SV for the key, so if your
236 key data is not already in SV form then use C<hv_store> in preference to
237 C<hv_store_ent>.
239 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
240 information on how to use this function on tied hashes.
242 =for apidoc hv_store_ent
244 Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
245 parameter is the precomputed hash value; if it is zero then Perl will
246 compute it. The return value is the new hash entry so created. It will be
247 C<NULL> if the operation failed or if the value did not need to be actually
248 stored within the hash (as in the case of tied hashes). Otherwise the
249 contents of the return value can be accessed using the C<He?> macros
250 described here. Note that the caller is responsible for suitably
251 incrementing the reference count of C<val> before the call, and
252 decrementing it if the function returned NULL. Effectively a successful
253 C<hv_store_ent> takes ownership of one reference to C<val>. This is
254 usually what you want; a newly created SV has a reference count of one, so
255 if all your code does is create SVs then store them in a hash, C<hv_store>
256 will own the only reference to the new SV, and your code doesn't need to do
257 anything further to tidy up. Note that C<hv_store_ent> only reads the C<key>;
258 unlike C<val> it does not take ownership of it, so maintaining the correct
259 reference count on C<key> is entirely the caller's responsibility. C<hv_store>
260 is not implemented as a call to C<hv_store_ent>, and does not create a temporary
261 SV for the key, so if your key data is not already in SV form then use
262 C<hv_store> in preference to C<hv_store_ent>.
264 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
265 information on how to use this function on tied hashes.
267 =for apidoc hv_exists
269 Returns a boolean indicating whether the specified hash key exists. The
270 absolute value of C<klen> is the length of the key. If C<klen> is
271 negative the key is assumed to be in UTF-8-encoded Unicode.
273 =for apidoc hv_fetch
275 Returns the SV which corresponds to the specified key in the hash.
276 The absolute value of C<klen> is the length of the key. If C<klen> is
277 negative the key is assumed to be in UTF-8-encoded Unicode. If
278 C<lval> is set then the fetch will be part of a store. This means that if
279 there is no value in the hash associated with the given key, then one is
280 created and a pointer to it is returned. The C<SV*> it points to can be
281 assigned to. But always check that the
282 return value is non-null before dereferencing it to an C<SV*>.
284 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
285 information on how to use this function on tied hashes.
287 =for apidoc hv_exists_ent
289 Returns a boolean indicating whether
290 the specified hash key exists. C<hash>
291 can be a valid precomputed hash value, or 0 to ask for it to be
292 computed.
294 =cut
295 */
297 /* returns an HE * structure with the all fields set */
298 /* note that hent_val will be a mortal sv for MAGICAL hashes */
299 /*
300 =for apidoc hv_fetch_ent
302 Returns the hash entry which corresponds to the specified key in the hash.
303 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
304 if you want the function to compute it. IF C<lval> is set then the fetch
305 will be part of a store. Make sure the return value is non-null before
306 accessing it. The return value when C<hv> is a tied hash is a pointer to a
307 static location, so be sure to make a copy of the structure if you need to
308 store it somewhere.
310 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
311 information on how to use this function on tied hashes.
313 =cut
314 */
316 /* Common code for hv_delete()/hv_exists()/hv_fetch()/hv_store() */
317 void *
318 Perl_hv_common_key_len(pTHX_ HV *hv, const char *key, I32 klen_i32,
319 const int action, SV *val, const U32 hash)
320 {
321 STRLEN klen;
322 int flags;
324 PERL_ARGS_ASSERT_HV_COMMON_KEY_LEN;
326 if (klen_i32 < 0) {
327 klen = -klen_i32;
328 flags = HVhek_UTF8;
329 } else {
330 klen = klen_i32;
331 flags = 0;
332 }
333 return hv_common(hv, NULL, key, klen, flags, action, val, hash);
334 }
336 void *
337 Perl_hv_common(pTHX_ HV *hv, SV *keysv, const char *key, STRLEN klen,
338 int flags, int action, SV *val, U32 hash)
339 {
340 dVAR;
341 XPVHV* xhv;
342 HE *entry;
343 HE **oentry;
344 SV *sv;
345 bool is_utf8;
346 int masked_flags;
347 const int return_svp = action & HV_FETCH_JUST_SV;
348 HEK *keysv_hek = NULL;
350 if (!hv)
351 return NULL;
352 if (SvTYPE(hv) == (svtype)SVTYPEMASK)
353 return NULL;
355 assert(SvTYPE(hv) == SVt_PVHV);
357 if (SvSMAGICAL(hv) && SvGMAGICAL(hv) && !(action & HV_DISABLE_UVAR_XKEY)) {
358 MAGIC* mg;
359 if ((mg = mg_find((const SV *)hv, PERL_MAGIC_uvar))) {
360 struct ufuncs * const uf = (struct ufuncs *)mg->mg_ptr;
361 if (uf->uf_set == NULL) {
362 SV* obj = mg->mg_obj;
364 if (!keysv) {
365 keysv = newSVpvn_flags(key, klen, SVs_TEMP |
366 ((flags & HVhek_UTF8)
367 ? SVf_UTF8 : 0));
368 }
370 mg->mg_obj = keysv; /* pass key */
371 uf->uf_index = action; /* pass action */
372 magic_getuvar(MUTABLE_SV(hv), mg);
373 keysv = mg->mg_obj; /* may have changed */
374 mg->mg_obj = obj;
376 /* If the key may have changed, then we need to invalidate
377 any passed-in computed hash value. */
378 hash = 0;
379 }
380 }
381 }
382 if (keysv) {
383 if (flags & HVhek_FREEKEY)
384 Safefree(key);
385 key = SvPV_const(keysv, klen);
386 is_utf8 = (SvUTF8(keysv) != 0);
387 if (SvIsCOW_shared_hash(keysv)) {
388 flags = HVhek_KEYCANONICAL | (is_utf8 ? HVhek_UTF8 : 0);
389 } else {
390 flags = is_utf8 ? HVhek_UTF8 : 0;
391 }
392 } else {
393 is_utf8 = cBOOL(flags & HVhek_UTF8);
394 }
396 if (action & HV_DELETE) {
397 return (void *) hv_delete_common(hv, keysv, key, klen,
398 flags, action, hash);
399 }
401 xhv = (XPVHV*)SvANY(hv);
402 if (SvMAGICAL(hv)) {
403 if (SvRMAGICAL(hv) && !(action & (HV_FETCH_ISSTORE|HV_FETCH_ISEXISTS))) {
404 if (mg_find((const SV *)hv, PERL_MAGIC_tied)
405 || SvGMAGICAL((const SV *)hv))
406 {
407 /* FIXME should be able to skimp on the HE/HEK here when
408 HV_FETCH_JUST_SV is true. */
409 if (!keysv) {
410 keysv = newSVpvn_utf8(key, klen, is_utf8);
411 } else {
412 keysv = newSVsv(keysv);
413 }
414 sv = sv_newmortal();
415 mg_copy(MUTABLE_SV(hv), sv, (char *)keysv, HEf_SVKEY);
417 /* grab a fake HE/HEK pair from the pool or make a new one */
418 entry = PL_hv_fetch_ent_mh;
419 if (entry)
420 PL_hv_fetch_ent_mh = HeNEXT(entry);
421 else {
422 char *k;
423 entry = new_HE();
424 Newx(k, HEK_BASESIZE + sizeof(const SV *), char);
425 HeKEY_hek(entry) = (HEK*)k;
426 }
427 HeNEXT(entry) = NULL;
428 HeSVKEY_set(entry, keysv);
429 HeVAL(entry) = sv;
430 sv_upgrade(sv, SVt_PVLV);
431 LvTYPE(sv) = 'T';
432 /* so we can free entry when freeing sv */
433 LvTARG(sv) = MUTABLE_SV(entry);
435 /* XXX remove at some point? */
436 if (flags & HVhek_FREEKEY)
437 Safefree(key);
439 if (return_svp) {
440 return entry ? (void *) &HeVAL(entry) : NULL;
441 }
442 return (void *) entry;
443 }
444 #ifdef ENV_IS_CASELESS
445 else if (mg_find((const SV *)hv, PERL_MAGIC_env)) {
446 U32 i;
447 for (i = 0; i < klen; ++i)
448 if (isLOWER(key[i])) {
449 /* Would be nice if we had a routine to do the
450 copy and upercase in a single pass through. */
451 const char * const nkey = strupr(savepvn(key,klen));
452 /* Note that this fetch is for nkey (the uppercased
453 key) whereas the store is for key (the original) */
454 void *result = hv_common(hv, NULL, nkey, klen,
455 HVhek_FREEKEY, /* free nkey */
456 0 /* non-LVAL fetch */
457 | HV_DISABLE_UVAR_XKEY
458 | return_svp,
459 NULL /* no value */,
460 0 /* compute hash */);
461 if (!result && (action & HV_FETCH_LVALUE)) {
462 /* This call will free key if necessary.
463 Do it this way to encourage compiler to tail
464 call optimise. */
465 result = hv_common(hv, keysv, key, klen, flags,
466 HV_FETCH_ISSTORE
467 | HV_DISABLE_UVAR_XKEY
468 | return_svp,
469 newSV(0), hash);
470 } else {
471 if (flags & HVhek_FREEKEY)
472 Safefree(key);
473 }
474 return result;
475 }
476 }
477 #endif
478 } /* ISFETCH */
479 else if (SvRMAGICAL(hv) && (action & HV_FETCH_ISEXISTS)) {
480 if (mg_find((const SV *)hv, PERL_MAGIC_tied)
481 || SvGMAGICAL((const SV *)hv)) {
482 /* I don't understand why hv_exists_ent has svret and sv,
483 whereas hv_exists only had one. */
484 SV * const svret = sv_newmortal();
485 sv = sv_newmortal();
487 if (keysv || is_utf8) {
488 if (!keysv) {
489 keysv = newSVpvn_utf8(key, klen, TRUE);
490 } else {
491 keysv = newSVsv(keysv);
492 }
493 mg_copy(MUTABLE_SV(hv), sv, (char *)sv_2mortal(keysv), HEf_SVKEY);
494 } else {
495 mg_copy(MUTABLE_SV(hv), sv, key, klen);
496 }
497 if (flags & HVhek_FREEKEY)
498 Safefree(key);
499 {
500 MAGIC * const mg = mg_find(sv, PERL_MAGIC_tiedelem);
501 if (mg)
502 magic_existspack(svret, mg);
503 }
504 /* This cast somewhat evil, but I'm merely using NULL/
505 not NULL to return the boolean exists.
506 And I know hv is not NULL. */
507 return SvTRUE(svret) ? (void *)hv : NULL;
508 }
509 #ifdef ENV_IS_CASELESS
510 else if (mg_find((const SV *)hv, PERL_MAGIC_env)) {
511 /* XXX This code isn't UTF8 clean. */
512 char * const keysave = (char * const)key;
513 /* Will need to free this, so set FREEKEY flag. */
514 key = savepvn(key,klen);
515 key = (const char*)strupr((char*)key);
516 is_utf8 = FALSE;
517 hash = 0;
518 keysv = 0;
520 if (flags & HVhek_FREEKEY) {
521 Safefree(keysave);
522 }
523 flags |= HVhek_FREEKEY;
524 }
525 #endif
526 } /* ISEXISTS */
527 else if (action & HV_FETCH_ISSTORE) {
528 bool needs_copy;
529 bool needs_store;
530 hv_magic_check (hv, &needs_copy, &needs_store);
531 if (needs_copy) {
532 const bool save_taint = TAINT_get;
533 if (keysv || is_utf8) {
534 if (!keysv) {
535 keysv = newSVpvn_utf8(key, klen, TRUE);
536 }
537 if (TAINTING_get)
538 TAINT_set(SvTAINTED(keysv));
539 keysv = sv_2mortal(newSVsv(keysv));
540 mg_copy(MUTABLE_SV(hv), val, (char*)keysv, HEf_SVKEY);
541 } else {
542 mg_copy(MUTABLE_SV(hv), val, key, klen);
543 }
545 TAINT_IF(save_taint);
546 #ifdef NO_TAINT_SUPPORT
547 PERL_UNUSED_VAR(save_taint);
548 #endif
549 if (!needs_store) {
550 if (flags & HVhek_FREEKEY)
551 Safefree(key);
552 return NULL;
553 }
554 #ifdef ENV_IS_CASELESS
555 else if (mg_find((const SV *)hv, PERL_MAGIC_env)) {
556 /* XXX This code isn't UTF8 clean. */
557 const char *keysave = key;
558 /* Will need to free this, so set FREEKEY flag. */
559 key = savepvn(key,klen);
560 key = (const char*)strupr((char*)key);
561 is_utf8 = FALSE;
562 hash = 0;
563 keysv = 0;
565 if (flags & HVhek_FREEKEY) {
566 Safefree(keysave);
567 }
568 flags |= HVhek_FREEKEY;
569 }
570 #endif
571 }
572 } /* ISSTORE */
573 } /* SvMAGICAL */
575 if (!HvARRAY(hv)) {
576 if ((action & (HV_FETCH_LVALUE | HV_FETCH_ISSTORE))
577 #ifdef DYNAMIC_ENV_FETCH /* if it's an %ENV lookup, we may get it on the fly */
578 || (SvRMAGICAL((const SV *)hv)
579 && mg_find((const SV *)hv, PERL_MAGIC_env))
580 #endif
581 ) {
582 char *array;
583 Newxz(array,
584 PERL_HV_ARRAY_ALLOC_BYTES(xhv->xhv_max+1 /* HvMAX(hv)+1 */),
585 char);
586 HvARRAY(hv) = (HE**)array;
587 }
588 #ifdef DYNAMIC_ENV_FETCH
589 else if (action & HV_FETCH_ISEXISTS) {
590 /* for an %ENV exists, if we do an insert it's by a recursive
591 store call, so avoid creating HvARRAY(hv) right now. */
592 }
593 #endif
594 else {
595 /* XXX remove at some point? */
596 if (flags & HVhek_FREEKEY)
597 Safefree(key);
599 return NULL;
600 }
601 }
603 if (is_utf8 && !(flags & HVhek_KEYCANONICAL)) {
604 char * const keysave = (char *)key;
605 key = (char*)bytes_from_utf8((U8*)key, &klen, &is_utf8);
606 if (is_utf8)
607 flags |= HVhek_UTF8;
608 else
609 flags &= ~HVhek_UTF8;
610 if (key != keysave) {
611 if (flags & HVhek_FREEKEY)
612 Safefree(keysave);
613 flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
614 /* If the caller calculated a hash, it was on the sequence of
615 octets that are the UTF-8 form. We've now changed the sequence
616 of octets stored to that of the equivalent byte representation,
617 so the hash we need is different. */
618 hash = 0;
619 }
620 }
622 if (keysv && (SvIsCOW_shared_hash(keysv))) {
623 if (HvSHAREKEYS(hv))
624 keysv_hek = SvSHARED_HEK_FROM_PV(SvPVX_const(keysv));
625 hash = SvSHARED_HASH(keysv);
626 }
627 else if (!hash)
628 PERL_HASH(hash, key, klen);
630 masked_flags = (flags & HVhek_MASK);
632 #ifdef DYNAMIC_ENV_FETCH
633 if (!HvARRAY(hv)) entry = NULL;
634 else
635 #endif
636 {
637 entry = (HvARRAY(hv))[hash & (I32) HvMAX(hv)];
638 }
640 if (!entry)
641 goto not_found;
643 if (keysv_hek) {
644 /* keysv is actually a HEK in disguise, so we can match just by
645 * comparing the HEK pointers in the HE chain. There is a slight
646 * caveat: on something like "\x80", which has both plain and utf8
647 * representations, perl's hashes do encoding-insensitive lookups,
648 * but preserve the encoding of the stored key. Thus a particular
649 * key could map to two different HEKs in PL_strtab. We only
650 * conclude 'not found' if all the flags are the same; otherwise
651 * we fall back to a full search (this should only happen in rare
652 * cases).
653 */
654 int keysv_flags = HEK_FLAGS(keysv_hek);
655 HE *orig_entry = entry;
657 for (; entry; entry = HeNEXT(entry)) {
658 HEK *hek = HeKEY_hek(entry);
659 if (hek == keysv_hek)
660 goto found;
661 if (HEK_FLAGS(hek) != keysv_flags)
662 break; /* need to do full match */
663 }
664 if (!entry)
665 goto not_found;
666 /* failed on shortcut - do full search loop */
667 entry = orig_entry;
668 }
670 for (; entry; entry = HeNEXT(entry)) {
671 if (HeHASH(entry) != hash) /* strings can't be equal */
672 continue;
673 if (HeKLEN(entry) != (I32)klen)
674 continue;
675 if (memNE(HeKEY(entry),key,klen)) /* is this it? */
676 continue;
677 if ((HeKFLAGS(entry) ^ masked_flags) & HVhek_UTF8)
678 continue;
680 found:
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. */
691 HEK * const new_hek = share_hek_flags(key, klen, hash,
692 masked_flags);
693 unshare_hek (HeKEY_hek(entry));
694 HeKEY_hek(entry) = new_hek;
695 }
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 }
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")
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 actually needs a store. */
725 val = newSV(0);
726 HvPLACEHOLDERS(hv)--;
727 } else {
728 /* store */
729 if (val != &PL_sv_placeholder)
730 HvPLACEHOLDERS(hv)--;
731 }
732 HeVAL(entry) = val;
733 } else if (action & HV_FETCH_ISSTORE) {
734 SvREFCNT_dec(HeVAL(entry));
735 HeVAL(entry) = val;
736 }
737 } else if (HeVAL(entry) == &PL_sv_placeholder) {
738 /* if we find a placeholder, we pretend we haven't found
739 anything */
740 break;
741 }
742 if (flags & HVhek_FREEKEY)
743 Safefree(key);
744 if (return_svp) {
745 return (void *) &HeVAL(entry);
746 }
747 return entry;
748 }
750 not_found:
751 #ifdef DYNAMIC_ENV_FETCH /* %ENV lookup? If so, try to fetch the value now */
752 if (!(action & HV_FETCH_ISSTORE)
753 && SvRMAGICAL((const SV *)hv)
754 && mg_find((const SV *)hv, PERL_MAGIC_env)) {
755 unsigned long len;
756 const char * const env = PerlEnv_ENVgetenv_len(key,&len);
757 if (env) {
758 sv = newSVpvn(env,len);
759 SvTAINTED_on(sv);
760 return hv_common(hv, keysv, key, klen, flags,
761 HV_FETCH_ISSTORE|HV_DISABLE_UVAR_XKEY|return_svp,
762 sv, hash);
763 }
764 }
765 #endif
767 if (!entry && SvREADONLY(hv) && !(action & HV_FETCH_ISEXISTS)) {
768 hv_notallowed(flags, key, klen,
769 "Attempt to access disallowed key '%" SVf "' in"
770 " a restricted hash");
771 }
772 if (!(action & (HV_FETCH_LVALUE|HV_FETCH_ISSTORE))) {
773 /* Not doing some form of store, so return failure. */
774 if (flags & HVhek_FREEKEY)
775 Safefree(key);
776 return NULL;
777 }
778 if (action & HV_FETCH_LVALUE) {
779 val = action & HV_FETCH_EMPTY_HE ? NULL : newSV(0);
780 if (SvMAGICAL(hv)) {
781 /* At this point the old hv_fetch code would call to hv_store,
782 which in turn might do some tied magic. So we need to make that
783 magic check happen. */
784 /* gonna assign to this, so it better be there */
785 /* If a fetch-as-store fails on the fetch, then the action is to
786 recurse once into "hv_store". If we didn't do this, then that
787 recursive call would call the key conversion routine again.
788 However, as we replace the original key with the converted
789 key, this would result in a double conversion, which would show
790 up as a bug if the conversion routine is not idempotent.
791 Hence the use of HV_DISABLE_UVAR_XKEY. */
792 return hv_common(hv, keysv, key, klen, flags,
793 HV_FETCH_ISSTORE|HV_DISABLE_UVAR_XKEY|return_svp,
794 val, hash);
795 /* XXX Surely that could leak if the fetch-was-store fails?
796 Just like the hv_fetch. */
797 }
798 }
800 /* Welcome to hv_store... */
802 if (!HvARRAY(hv)) {
803 /* Not sure if we can get here. I think the only case of oentry being
804 NULL is for %ENV with dynamic env fetch. But that should disappear
805 with magic in the previous code. */
806 char *array;
807 Newxz(array,
808 PERL_HV_ARRAY_ALLOC_BYTES(xhv->xhv_max+1 /* HvMAX(hv)+1 */),
809 char);
810 HvARRAY(hv) = (HE**)array;
811 }
813 oentry = &(HvARRAY(hv))[hash & (I32) xhv->xhv_max];
815 entry = new_HE();
816 /* share_hek_flags will do the free for us. This might be considered
817 bad API design. */
818 if (HvSHAREKEYS(hv))
819 HeKEY_hek(entry) = share_hek_flags(key, klen, hash, flags);
820 else if (hv == PL_strtab) {
821 /* PL_strtab is usually the only hash without HvSHAREKEYS, so putting
822 this test here is cheap */
823 if (flags & HVhek_FREEKEY)
824 Safefree(key);
825 Perl_croak(aTHX_ S_strtab_error,
826 action & HV_FETCH_LVALUE ? "fetch" : "store");
827 }
828 else /* gotta do the real thing */
829 HeKEY_hek(entry) = save_hek_flags(key, klen, hash, flags);
830 HeVAL(entry) = val;
832 #ifdef PERL_HASH_RANDOMIZE_KEYS
833 /* This logic semi-randomizes the insert order in a bucket.
834 * Either we insert into the top, or the slot below the top,
835 * making it harder to see if there is a collision. We also
836 * reset the iterator randomizer if there is one.
837 */
838 if ( *oentry && PL_HASH_RAND_BITS_ENABLED) {
839 PL_hash_rand_bits++;
840 PL_hash_rand_bits= ROTL_UV(PL_hash_rand_bits,1);
841 if ( PL_hash_rand_bits & 1 ) {
842 HeNEXT(entry) = HeNEXT(*oentry);
843 HeNEXT(*oentry) = entry;
844 } else {
845 HeNEXT(entry) = *oentry;
846 *oentry = entry;
847 }
848 } else
849 #endif
850 {
851 HeNEXT(entry) = *oentry;
852 *oentry = entry;
853 }
854 #ifdef PERL_HASH_RANDOMIZE_KEYS
855 if (SvOOK(hv)) {
856 /* Currently this makes various tests warn in annoying ways.
857 * So Silenced for now. - Yves | bogus end of comment =>* /
858 if (HvAUX(hv)->xhv_riter != -1) {
859 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
860 "[TESTING] Inserting into a hash during each() traversal results in undefined behavior"
861 pTHX__FORMAT
862 pTHX__VALUE);
863 }
864 */
865 if (PL_HASH_RAND_BITS_ENABLED) {
866 if (PL_HASH_RAND_BITS_ENABLED == 1)
867 PL_hash_rand_bits += (PTRV)entry + 1; /* we don't bother to use ptr_hash here */
868 PL_hash_rand_bits= ROTL_UV(PL_hash_rand_bits,1);
869 }
870 HvAUX(hv)->xhv_rand= (U32)PL_hash_rand_bits;
871 }
872 #endif
874 if (val == &PL_sv_placeholder)
875 HvPLACEHOLDERS(hv)++;
876 if (masked_flags & HVhek_ENABLEHVKFLAGS)
877 HvHASKFLAGS_on(hv);
879 xhv->xhv_keys++; /* HvTOTALKEYS(hv)++ */
880 if ( DO_HSPLIT(xhv) ) {
881 const STRLEN oldsize = xhv->xhv_max + 1;
882 const U32 items = (U32)HvPLACEHOLDERS_get(hv);
884 if (items /* hash has placeholders */
885 && !SvREADONLY(hv) /* but is not a restricted hash */) {
886 /* If this hash previously was a "restricted hash" and had
887 placeholders, but the "restricted" flag has been turned off,
888 then the placeholders no longer serve any useful purpose.
889 However, they have the downsides of taking up RAM, and adding
890 extra steps when finding used values. It's safe to clear them
891 at this point, even though Storable rebuilds restricted hashes by
892 putting in all the placeholders (first) before turning on the
893 readonly flag, because Storable always pre-splits the hash.
894 If we're lucky, then we may clear sufficient placeholders to
895 avoid needing to split the hash at all. */
896 clear_placeholders(hv, items);
897 if (DO_HSPLIT(xhv))
898 hsplit(hv, oldsize, oldsize * 2);
899 } else
900 hsplit(hv, oldsize, oldsize * 2);
901 }
903 if (return_svp) {
904 return entry ? (void *) &HeVAL(entry) : NULL;
905 }
906 return (void *) entry;
907 }
909 STATIC void
910 S_hv_magic_check(HV *hv, bool *needs_copy, bool *needs_store)
911 {
912 const MAGIC *mg = SvMAGIC(hv);
914 PERL_ARGS_ASSERT_HV_MAGIC_CHECK;
916 *needs_copy = FALSE;
917 *needs_store = TRUE;
918 while (mg) {
919 if (isUPPER(mg->mg_type)) {
920 *needs_copy = TRUE;
921 if (mg->mg_type == PERL_MAGIC_tied) {
922 *needs_store = FALSE;
923 return; /* We've set all there is to set. */
924 }
925 }
926 mg = mg->mg_moremagic;
927 }
928 }
930 /*
931 =for apidoc hv_scalar
933 Evaluates the hash in scalar context and returns the result.
935 When the hash is tied dispatches through to the SCALAR method,
936 otherwise returns a mortal SV containing the number of keys
937 in the hash.
939 Note, prior to 5.25 this function returned what is now
940 returned by the hv_bucket_ratio() function.
942 =cut
943 */
945 SV *
946 Perl_hv_scalar(pTHX_ HV *hv)
947 {
948 SV *sv;
950 PERL_ARGS_ASSERT_HV_SCALAR;
952 if (SvRMAGICAL(hv)) {
953 MAGIC * const mg = mg_find((const SV *)hv, PERL_MAGIC_tied);
954 if (mg)
955 return magic_scalarpack(hv, mg);
956 }
958 sv = sv_newmortal();
959 sv_setuv(sv, HvUSEDKEYS(hv));
961 return sv;
962 }
964 /*
965 =for apidoc hv_bucket_ratio
967 If the hash is tied dispatches through to the SCALAR tied method,
968 otherwise if the hash contains no keys returns 0, otherwise returns
969 a mortal sv containing a string specifying the number of used buckets,
970 followed by a slash, followed by the number of available buckets.
972 This function is expensive, it must scan all of the buckets
973 to determine which are used, and the count is NOT cached.
974 In a large hash this could be a lot of buckets.
976 =cut
977 */
979 SV *
980 Perl_hv_bucket_ratio(pTHX_ HV *hv)
981 {
982 SV *sv;
984 PERL_ARGS_ASSERT_HV_BUCKET_RATIO;
986 if (SvRMAGICAL(hv)) {
987 MAGIC * const mg = mg_find((const SV *)hv, PERL_MAGIC_tied);
988 if (mg)
989 return magic_scalarpack(hv, mg);
990 }
992 sv = sv_newmortal();
993 if (HvUSEDKEYS((HV *)hv))
994 Perl_sv_setpvf(aTHX_ sv, "%ld/%ld",
995 (long)HvFILL(hv), (long)HvMAX(hv) + 1);
996 else
997 sv_setiv(sv, 0);
999 return sv;
1000 }
1002 /*
1003 =for apidoc hv_delete
1005 Deletes a key/value pair in the hash. The value's SV is removed from
1006 the hash, made mortal, and returned to the caller. The absolute
1007 value of C<klen> is the length of the key. If C<klen> is negative the
1008 key is assumed to be in UTF-8-encoded Unicode. The C<flags> value
1009 will normally be zero; if set to C<G_DISCARD> then C<NULL> will be returned.
1010 C<NULL> will also be returned if the key is not found.
1012 =for apidoc hv_delete_ent
1014 Deletes a key/value pair in the hash. The value SV is removed from the hash,
1015 made mortal, and returned to the caller. The C<flags> value will normally be
1016 zero; if set to C<G_DISCARD> then C<NULL> will be returned. C<NULL> will also
1017 be returned if the key is not found. C<hash> can be a valid precomputed hash
1018 value, or 0 to ask for it to be computed.
1020 =cut
1021 */
1023 STATIC SV *
1024 S_hv_delete_common(pTHX_ HV *hv, SV *keysv, const char *key, STRLEN klen,
1025 int k_flags, I32 d_flags, U32 hash)
1026 {
1027 dVAR;
1028 XPVHV* xhv;
1029 HE *entry;
1030 HE **oentry;
1031 HE **first_entry;
1032 bool is_utf8 = cBOOL(k_flags & HVhek_UTF8);
1033 int masked_flags;
1034 HEK *keysv_hek = NULL;
1035 U8 mro_changes = 0; /* 1 = isa; 2 = package moved */
1036 SV *sv;
1037 GV *gv = NULL;
1038 HV *stash = NULL;
1040 if (SvRMAGICAL(hv)) {
1041 bool needs_copy;
1042 bool needs_store;
1043 hv_magic_check (hv, &needs_copy, &needs_store);
1045 if (needs_copy) {
1046 SV *sv;
1047 entry = (HE *) hv_common(hv, keysv, key, klen,
1048 k_flags & ~HVhek_FREEKEY,
1049 HV_FETCH_LVALUE|HV_DISABLE_UVAR_XKEY,
1050 NULL, hash);
1051 sv = entry ? HeVAL(entry) : NULL;
1052 if (sv) {
1053 if (SvMAGICAL(sv)) {
1054 mg_clear(sv);
1055 }
1056 if (!needs_store) {
1057 if (mg_find(sv, PERL_MAGIC_tiedelem)) {
1058 /* No longer an element */
1059 sv_unmagic(sv, PERL_MAGIC_tiedelem);
1060 return sv;
1061 }
1062 return NULL; /* element cannot be deleted */
1063 }
1064 #ifdef ENV_IS_CASELESS
1065 else if (mg_find((const SV *)hv, PERL_MAGIC_env)) {
1066 /* XXX This code isn't UTF8 clean. */
1067 keysv = newSVpvn_flags(key, klen, SVs_TEMP);
1068 if (k_flags & HVhek_FREEKEY) {
1069 Safefree(key);
1070 }
1071 key = strupr(SvPVX(keysv));
1072 is_utf8 = 0;
1073 k_flags = 0;
1074 hash = 0;
1075 }
1076 #endif
1077 }
1078 }
1079 }
1080 xhv = (XPVHV*)SvANY(hv);
1081 if (!HvARRAY(hv))
1082 return NULL;
1084 if (is_utf8 && !(k_flags & HVhek_KEYCANONICAL)) {
1085 const char * const keysave = key;
1086 key = (char*)bytes_from_utf8((U8*)key, &klen, &is_utf8);
1088 if (is_utf8)
1089 k_flags |= HVhek_UTF8;
1090 else
1091 k_flags &= ~HVhek_UTF8;
1092 if (key != keysave) {
1093 if (k_flags & HVhek_FREEKEY) {
1094 /* This shouldn't happen if our caller does what we expect,
1095 but strictly the API allows it. */
1096 Safefree(keysave);
1097 }
1098 k_flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
1099 }
1100 HvHASKFLAGS_on(MUTABLE_SV(hv));
1101 }
1103 if (keysv && (SvIsCOW_shared_hash(keysv))) {
1104 if (HvSHAREKEYS(hv))
1105 keysv_hek = SvSHARED_HEK_FROM_PV(SvPVX_const(keysv));
1106 hash = SvSHARED_HASH(keysv);
1107 }
1108 else if (!hash)
1109 PERL_HASH(hash, key, klen);
1111 masked_flags = (k_flags & HVhek_MASK);
1113 first_entry = oentry = &(HvARRAY(hv))[hash & (I32) HvMAX(hv)];
1114 entry = *oentry;
1116 if (!entry)
1117 goto not_found;
1119 if (keysv_hek) {
1120 /* keysv is actually a HEK in disguise, so we can match just by
1121 * comparing the HEK pointers in the HE chain. There is a slight
1122 * caveat: on something like "\x80", which has both plain and utf8
1123 * representations, perl's hashes do encoding-insensitive lookups,
1124 * but preserve the encoding of the stored key. Thus a particular
1125 * key could map to two different HEKs in PL_strtab. We only
1126 * conclude 'not found' if all the flags are the same; otherwise
1127 * we fall back to a full search (this should only happen in rare
1128 * cases).
1129 */
1130 int keysv_flags = HEK_FLAGS(keysv_hek);
1132 for (; entry; oentry = &HeNEXT(entry), entry = *oentry) {
1133 HEK *hek = HeKEY_hek(entry);
1134 if (hek == keysv_hek)
1135 goto found;
1136 if (HEK_FLAGS(hek) != keysv_flags)
1137 break; /* need to do full match */
1138 }
1139 if (!entry)
1140 goto not_found;
1141 /* failed on shortcut - do full search loop */
1142 oentry = first_entry;
1143 entry = *oentry;
1144 }
1146 for (; entry; oentry = &HeNEXT(entry), entry = *oentry) {
1147 if (HeHASH(entry) != hash) /* strings can't be equal */
1148 continue;
1149 if (HeKLEN(entry) != (I32)klen)
1150 continue;
1151 if (memNE(HeKEY(entry),key,klen)) /* is this it? */
1152 continue;
1153 if ((HeKFLAGS(entry) ^ masked_flags) & HVhek_UTF8)
1154 continue;
1156 found:
1157 if (hv == PL_strtab) {
1158 if (k_flags & HVhek_FREEKEY)
1159 Safefree(key);
1160 Perl_croak(aTHX_ S_strtab_error, "delete");
1161 }
1163 /* if placeholder is here, it's already been deleted.... */
1164 if (HeVAL(entry) == &PL_sv_placeholder) {
1165 if (k_flags & HVhek_FREEKEY)
1166 Safefree(key);
1167 return NULL;
1168 }
1169 if (SvREADONLY(hv) && HeVAL(entry) && SvREADONLY(HeVAL(entry))) {
1170 hv_notallowed(k_flags, key, klen,
1171 "Attempt to delete readonly key '%" SVf "' from"
1172 " a restricted hash");
1173 }
1174 if (k_flags & HVhek_FREEKEY)
1175 Safefree(key);
1177 /* If this is a stash and the key ends with ::, then someone is
1178 * deleting a package.
1179 */
1180 if (HeVAL(entry) && HvENAME_get(hv)) {
1181 gv = (GV *)HeVAL(entry);
1182 if (keysv) key = SvPV(keysv, klen);
1183 if ((
1184 (klen > 1 && key[klen-2] == ':' && key[klen-1] == ':')
1185 ||
1186 (klen == 1 && key[0] == ':')
1187 )
1188 && (klen != 6 || hv!=PL_defstash || memNE(key,"main::",6))
1189 && SvTYPE(gv) == SVt_PVGV && (stash = GvHV((GV *)gv))
1190 && HvENAME_get(stash)) {
1191 /* A previous version of this code checked that the
1192 * GV was still in the symbol table by fetching the
1193 * GV with its name. That is not necessary (and
1194 * sometimes incorrect), as HvENAME cannot be set
1195 * on hv if it is not in the symtab. */
1196 mro_changes = 2;
1197 /* Hang on to it for a bit. */
1198 SvREFCNT_inc_simple_void_NN(
1199 sv_2mortal((SV *)gv)
1200 );
1201 }
1202 else if (klen == 3 && strEQs(key, "ISA") && GvAV(gv)) {
1203 AV *isa = GvAV(gv);
1204 MAGIC *mg = mg_find((SV*)isa, PERL_MAGIC_isa);
1206 mro_changes = 1;
1207 if (mg) {
1208 if (mg->mg_obj == (SV*)gv) {
1209 /* This is the only stash this ISA was used for.
1210 * The isaelem magic asserts if there's no
1211 * isa magic on the array, so explicitly
1212 * remove the magic on both the array and its
1213 * elements. @ISA shouldn't be /too/ large.
1214 */
1215 SV **svp, **end;
1216 strip_magic:
1217 svp = AvARRAY(isa);
1218 end = svp + AvFILLp(isa)+1;
1219 while (svp < end) {
1220 if (*svp)
1221 mg_free_type(*svp, PERL_MAGIC_isaelem);
1222 ++svp;
1223 }
1224 mg_free_type((SV*)GvAV(gv), PERL_MAGIC_isa);
1225 }
1226 else {
1227 /* mg_obj is an array of stashes
1228 Note that the array doesn't keep a reference
1229 count on the stashes.
1230 */
1231 AV *av = (AV*)mg->mg_obj;
1232 SV **svp, **arrayp;
1233 SSize_t index;
1234 SSize_t items;
1236 assert(SvTYPE(mg->mg_obj) == SVt_PVAV);
1238 /* remove the stash from the magic array */
1239 arrayp = svp = AvARRAY(av);
1240 items = AvFILLp(av) + 1;
1241 if (items == 1) {
1242 assert(*arrayp == (SV *)gv);
1243 mg->mg_obj = NULL;
1244 /* avoid a double free on the last stash */
1245 AvFILLp(av) = -1;
1246 /* The magic isn't MGf_REFCOUNTED, so release
1247 * the array manually.
1248 */
1249 SvREFCNT_dec_NN(av);
1250 goto strip_magic;
1251 }
1252 else {
1253 while (items--) {
1254 if (*svp == (SV*)gv)
1255 break;
1256 ++svp;
1257 }
1258 index = svp - arrayp;
1259 assert(index >= 0 && index <= AvFILLp(av));
1260 if (index < AvFILLp(av)) {
1261 arrayp[index] = arrayp[AvFILLp(av)];
1262 }
1263 arrayp[AvFILLp(av)] = NULL;
1264 --AvFILLp(av);
1265 }
1266 }
1267 }
1268 }
1269 }
1271 sv = d_flags & G_DISCARD ? HeVAL(entry) : sv_2mortal(HeVAL(entry));
1272 HeVAL(entry) = &PL_sv_placeholder;
1273 if (sv) {
1274 /* deletion of method from stash */
1275 if (isGV(sv) && isGV_with_GP(sv) && GvCVu(sv)
1276 && HvENAME_get(hv))
1277 mro_method_changed_in(hv);
1278 }
1280 /*
1281 * If a restricted hash, rather than really deleting the entry, put
1282 * a placeholder there. This marks the key as being "approved", so
1283 * we can still access via not-really-existing key without raising
1284 * an error.
1285 */
1286 if (SvREADONLY(hv))
1287 /* We'll be saving this slot, so the number of allocated keys
1288 * doesn't go down, but the number placeholders goes up */
1289 HvPLACEHOLDERS(hv)++;
1290 else {
1291 *oentry = HeNEXT(entry);
1292 if (SvOOK(hv) && entry == HvAUX(hv)->xhv_eiter /* HvEITER(hv) */)
1293 HvLAZYDEL_on(hv);
1294 else {
1295 if (SvOOK(hv) && HvLAZYDEL(hv) &&
1296 entry == HeNEXT(HvAUX(hv)->xhv_eiter))
1297 HeNEXT(HvAUX(hv)->xhv_eiter) = HeNEXT(entry);
1298 hv_free_ent(hv, entry);
1299 }
1300 xhv->xhv_keys--; /* HvTOTALKEYS(hv)-- */
1301 if (xhv->xhv_keys == 0)
1302 HvHASKFLAGS_off(hv);
1303 }
1305 if (d_flags & G_DISCARD) {
1306 SvREFCNT_dec(sv);
1307 sv = NULL;
1308 }
1310 if (mro_changes == 1) mro_isa_changed_in(hv);
1311 else if (mro_changes == 2)
1312 mro_package_moved(NULL, stash, gv, 1);
1314 return sv;
1315 }
1317 not_found:
1318 if (SvREADONLY(hv)) {
1319 hv_notallowed(k_flags, key, klen,
1320 "Attempt to delete disallowed key '%" SVf "' from"
1321 " a restricted hash");
1322 }
1324 if (k_flags & HVhek_FREEKEY)
1325 Safefree(key);
1326 return NULL;
1327 }
1330 STATIC void
1331 S_hsplit(pTHX_ HV *hv, STRLEN const oldsize, STRLEN newsize)
1332 {
1333 STRLEN i = 0;
1334 char *a = (char*) HvARRAY(hv);
1335 HE **aep;
1337 bool do_aux= (
1338 /* already have an HvAUX(hv) so we have to move it */
1339 SvOOK(hv) ||
1340 /* no HvAUX() but array we are going to allocate is large enough
1341 * there is no point in saving the space for the iterator, and
1342 * speeds up later traversals. */
1343 ( ( hv != PL_strtab ) && ( newsize >= PERL_HV_ALLOC_AUX_SIZE ) )
1344 );
1346 PERL_ARGS_ASSERT_HSPLIT;
1348 PL_nomemok = TRUE;
1349 Renew(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize)
1350 + (do_aux ? sizeof(struct xpvhv_aux) : 0), char);
1351 PL_nomemok = FALSE;
1352 if (!a) {
1353 return;
1354 }
1356 #ifdef PERL_HASH_RANDOMIZE_KEYS
1357 /* the idea of this is that we create a "random" value by hashing the address of
1358 * the array, we then use the low bit to decide if we insert at the top, or insert
1359 * second from top. After each such insert we rotate the hashed value. So we can
1360 * use the same hashed value over and over, and in normal build environments use
1361 * very few ops to do so. ROTL32() should produce a single machine operation. */
1362 if (PL_HASH_RAND_BITS_ENABLED) {
1363 if (PL_HASH_RAND_BITS_ENABLED == 1)
1364 PL_hash_rand_bits += ptr_hash((PTRV)a);
1365 PL_hash_rand_bits = ROTL_UV(PL_hash_rand_bits,1);
1366 }
1367 #endif
1368 HvARRAY(hv) = (HE**) a;
1369 HvMAX(hv) = newsize - 1;
1370 /* before we zero the newly added memory, we
1371 * need to deal with the aux struct that may be there
1372 * or have been allocated by us*/
1373 if (do_aux) {
1374 struct xpvhv_aux *const dest
1375 = (struct xpvhv_aux*) &a[newsize * sizeof(HE*)];
1376 if (SvOOK(hv)) {
1377 /* alread have an aux, copy the old one in place. */
1378 Move(&a[oldsize * sizeof(HE*)], dest, 1, struct xpvhv_aux);
1379 /* we reset the iterator's xhv_rand as well, so they get a totally new ordering */
1380 #ifdef PERL_HASH_RANDOMIZE_KEYS
1381 dest->xhv_rand = (U32)PL_hash_rand_bits;
1382 #endif
1383 } else {
1384 /* no existing aux structure, but we allocated space for one
1385 * so initialize it properly. This unrolls hv_auxinit() a bit,
1386 * since we have to do the realloc anyway. */
1387 /* first we set the iterator's xhv_rand so it can be copied into lastrand below */
1388 #ifdef PERL_HASH_RANDOMIZE_KEYS
1389 dest->xhv_rand = (U32)PL_hash_rand_bits;
1390 #endif
1391 /* this is the "non realloc" part of the hv_auxinit() */
1392 (void)hv_auxinit_internal(dest);
1393 /* Turn on the OOK flag */
1394 SvOOK_on(hv);
1395 }
1396 }
1397 /* now we can safely clear the second half */
1398 Zero(&a[oldsize * sizeof(HE*)], (newsize-oldsize) * sizeof(HE*), char); /* zero 2nd half*/
1400 if (!HvTOTALKEYS(hv)) /* skip rest if no entries */
1401 return;
1403 newsize--;
1404 aep = (HE**)a;
1405 do {
1406 HE **oentry = aep + i;
1407 HE *entry = aep[i];
1409 if (!entry) /* non-existent */
1410 continue;
1411 do {
1412 U32 j = (HeHASH(entry) & newsize);
1413 if (j != (U32)i) {
1414 *oentry = HeNEXT(entry);
1415 #ifdef PERL_HASH_RANDOMIZE_KEYS
1416 /* if the target cell is empty or PL_HASH_RAND_BITS_ENABLED is false
1417 * insert to top, otherwise rotate the bucket rand 1 bit,
1418 * and use the new low bit to decide if we insert at top,
1419 * or next from top. IOW, we only rotate on a collision.*/
1420 if (aep[j] && PL_HASH_RAND_BITS_ENABLED) {
1421 PL_hash_rand_bits+= ROTL32(HeHASH(entry), 17);
1422 PL_hash_rand_bits= ROTL_UV(PL_hash_rand_bits,1);
1423 if (PL_hash_rand_bits & 1) {
1424 HeNEXT(entry)= HeNEXT(aep[j]);
1425 HeNEXT(aep[j])= entry;
1426 } else {
1427 /* Note, this is structured in such a way as the optimizer
1428 * should eliminate the duplicated code here and below without
1429 * us needing to explicitly use a goto. */
1430 HeNEXT(entry) = aep[j];
1431 aep[j] = entry;
1432 }
1433 } else
1434 #endif
1435 {
1436 /* see comment above about duplicated code */
1437 HeNEXT(entry) = aep[j];
1438 aep[j] = entry;
1439 }
1440 }
1441 else {
1442 oentry = &HeNEXT(entry);
1443 }
1444 entry = *oentry;
1445 } while (entry);
1446 } while (i++ < oldsize);
1447 }
1449 void
1450 Perl_hv_ksplit(pTHX_ HV *hv, IV newmax)
1451 {
1452 XPVHV* xhv = (XPVHV*)SvANY(hv);
1453 const I32 oldsize = (I32) xhv->xhv_max+1; /* HvMAX(hv)+1 (sick) */
1454 I32 newsize;
1455 char *a;
1457 PERL_ARGS_ASSERT_HV_KSPLIT;
1459 newsize = (I32) newmax; /* possible truncation here */
1460 if (newsize != newmax || newmax <= oldsize)
1461 return;
1462 while ((newsize & (1 + ~newsize)) != newsize) {
1463 newsize &= ~(newsize & (1 + ~newsize)); /* get proper power of 2 */
1464 }
1465 if (newsize < newmax)
1466 newsize *= 2;
1467 if (newsize < newmax)
1468 return; /* overflow detection */
1470 a = (char *) HvARRAY(hv);
1471 if (a) {
1472 hsplit(hv, oldsize, newsize);
1473 } else {
1474 Newxz(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize), char);
1475 xhv->xhv_max = --newsize;
1476 HvARRAY(hv) = (HE **) a;
1477 }
1478 }
1480 /* IMO this should also handle cases where hv_max is smaller than hv_keys
1481 * as tied hashes could play silly buggers and mess us around. We will
1482 * do the right thing during hv_store() afterwards, but still - Yves */
1483 #define HV_SET_MAX_ADJUSTED_FOR_KEYS(hv,hv_max,hv_keys) STMT_START {\
1484 /* Can we use fewer buckets? (hv_max is always 2^n-1) */ \
1485 if (hv_max < PERL_HASH_DEFAULT_HvMAX) { \
1486 hv_max = PERL_HASH_DEFAULT_HvMAX; \
1487 } else { \
1488 while (hv_max > PERL_HASH_DEFAULT_HvMAX && hv_max + 1 >= hv_keys * 2) \
1489 hv_max = hv_max / 2; \
1490 } \
1491 HvMAX(hv) = hv_max; \
1492 } STMT_END
1495 HV *
1496 Perl_newHVhv(pTHX_ HV *ohv)
1497 {
1498 dVAR;
1499 HV * const hv = newHV();
1500 STRLEN hv_max;
1502 if (!ohv || (!HvTOTALKEYS(ohv) && !SvMAGICAL((const SV *)ohv)))
1503 return hv;
1504 hv_max = HvMAX(ohv);
1506 if (!SvMAGICAL((const SV *)ohv)) {
1507 /* It's an ordinary hash, so copy it fast. AMS 20010804 */
1508 STRLEN i;
1509 const bool shared = !!HvSHAREKEYS(ohv);
1510 HE **ents, ** const oents = (HE **)HvARRAY(ohv);
1511 char *a;
1512 Newx(a, PERL_HV_ARRAY_ALLOC_BYTES(hv_max+1), char);
1513 ents = (HE**)a;
1515 /* In each bucket... */
1516 for (i = 0; i <= hv_max; i++) {
1517 HE *prev = NULL;
1518 HE *oent = oents[i];
1520 if (!oent) {
1521 ents[i] = NULL;
1522 continue;
1523 }
1525 /* Copy the linked list of entries. */
1526 for (; oent; oent = HeNEXT(oent)) {
1527 const U32 hash = HeHASH(oent);
1528 const char * const key = HeKEY(oent);
1529 const STRLEN len = HeKLEN(oent);
1530 const int flags = HeKFLAGS(oent);
1531 HE * const ent = new_HE();
1532 SV *const val = HeVAL(oent);
1534 HeVAL(ent) = SvIMMORTAL(val) ? val : newSVsv(val);
1535 HeKEY_hek(ent)
1536 = shared ? share_hek_flags(key, len, hash, flags)
1537 : save_hek_flags(key, len, hash, flags);
1538 if (prev)
1539 HeNEXT(prev) = ent;
1540 else
1541 ents[i] = ent;
1542 prev = ent;
1543 HeNEXT(ent) = NULL;
1544 }
1545 }
1547 HvMAX(hv) = hv_max;
1548 HvTOTALKEYS(hv) = HvTOTALKEYS(ohv);
1549 HvARRAY(hv) = ents;
1550 } /* not magical */
1551 else {
1552 /* Iterate over ohv, copying keys and values one at a time. */
1553 HE *entry;
1554 const I32 riter = HvRITER_get(ohv);
1555 HE * const eiter = HvEITER_get(ohv);
1556 STRLEN hv_keys = HvTOTALKEYS(ohv);
1558 HV_SET_MAX_ADJUSTED_FOR_KEYS(hv,hv_max,hv_keys);
1560 hv_iterinit(ohv);
1561 while ((entry = hv_iternext_flags(ohv, 0))) {
1562 SV *val = hv_iterval(ohv,entry);
1563 SV * const keysv = HeSVKEY(entry);
1564 val = SvIMMORTAL(val) ? val : newSVsv(val);
1565 if (keysv)
1566 (void)hv_store_ent(hv, keysv, val, 0);
1567 else
1568 (void)hv_store_flags(hv, HeKEY(entry), HeKLEN(entry), val,
1569 HeHASH(entry), HeKFLAGS(entry));
1570 }
1571 HvRITER_set(ohv, riter);
1572 HvEITER_set(ohv, eiter);
1573 }
1575 return hv;
1576 }
1578 /*
1579 =for apidoc Am|HV *|hv_copy_hints_hv|HV *ohv
1581 A specialised version of L</newHVhv> for copying C<%^H>. C<ohv> must be
1582 a pointer to a hash (which may have C<%^H> magic, but should be generally
1583 non-magical), or C<NULL> (interpreted as an empty hash). The content
1584 of C<ohv> is copied to a new hash, which has the C<%^H>-specific magic
1585 added to it. A pointer to the new hash is returned.
1587 =cut
1588 */
1590 HV *
1591 Perl_hv_copy_hints_hv(pTHX_ HV *const ohv)
1592 {
1593 HV * const hv = newHV();
1595 if (ohv) {
1596 STRLEN hv_max = HvMAX(ohv);
1597 STRLEN hv_keys = HvTOTALKEYS(ohv);
1598 HE *entry;
1599 const I32 riter = HvRITER_get(ohv);
1600 HE * const eiter = HvEITER_get(ohv);
1602 ENTER;
1603 SAVEFREESV(hv);
1605 HV_SET_MAX_ADJUSTED_FOR_KEYS(hv,hv_max,hv_keys);
1607 hv_iterinit(ohv);
1608 while ((entry = hv_iternext_flags(ohv, 0))) {
1609 SV *const sv = newSVsv(hv_iterval(ohv,entry));
1610 SV *heksv = HeSVKEY(entry);
1611 if (!heksv && sv) heksv = newSVhek(HeKEY_hek(entry));
1612 if (sv) sv_magic(sv, NULL, PERL_MAGIC_hintselem,
1613 (char *)heksv, HEf_SVKEY);
1614 if (heksv == HeSVKEY(entry))
1615 (void)hv_store_ent(hv, heksv, sv, 0);
1616 else {
1617 (void)hv_common(hv, heksv, HeKEY(entry), HeKLEN(entry),
1618 HeKFLAGS(entry), HV_FETCH_ISSTORE|HV_FETCH_JUST_SV, sv, HeHASH(entry));
1619 SvREFCNT_dec_NN(heksv);
1620 }
1621 }
1622 HvRITER_set(ohv, riter);
1623 HvEITER_set(ohv, eiter);
1625 SvREFCNT_inc_simple_void_NN(hv);
1626 LEAVE;
1627 }
1628 hv_magic(hv, NULL, PERL_MAGIC_hints);
1629 return hv;
1630 }
1631 #undef HV_SET_MAX_ADJUSTED_FOR_KEYS
1633 /* like hv_free_ent, but returns the SV rather than freeing it */
1634 STATIC SV*
1635 S_hv_free_ent_ret(pTHX_ HV *hv, HE *entry)
1636 {
1637 SV *val;
1639 PERL_ARGS_ASSERT_HV_FREE_ENT_RET;
1641 val = HeVAL(entry);
1642 if (HeKLEN(entry) == HEf_SVKEY) {
1643 SvREFCNT_dec(HeKEY_sv(entry));
1644 Safefree(HeKEY_hek(entry));
1645 }
1646 else if (HvSHAREKEYS(hv))
1647 unshare_hek(HeKEY_hek(entry));
1648 else
1649 Safefree(HeKEY_hek(entry));
1650 del_HE(entry);
1651 return val;
1652 }
1655 void
1656 Perl_hv_free_ent(pTHX_ HV *hv, HE *entry)
1657 {
1658 SV *val;
1660 PERL_ARGS_ASSERT_HV_FREE_ENT;
1662 if (!entry)
1663 return;
1664 val = hv_free_ent_ret(hv, entry);
1665 SvREFCNT_dec(val);
1666 }
1669 void
1670 Perl_hv_delayfree_ent(pTHX_ HV *hv, HE *entry)
1671 {
1672 PERL_ARGS_ASSERT_HV_DELAYFREE_ENT;
1674 if (!entry)
1675 return;
1676 /* SvREFCNT_inc to counter the SvREFCNT_dec in hv_free_ent */
1677 sv_2mortal(SvREFCNT_inc(HeVAL(entry))); /* free between statements */
1678 if (HeKLEN(entry) == HEf_SVKEY) {
1679 sv_2mortal(SvREFCNT_inc(HeKEY_sv(entry)));
1680 }
1681 hv_free_ent(hv, entry);
1682 }
1684 /*
1685 =for apidoc hv_clear
1687 Frees the all the elements of a hash, leaving it empty.
1688 The XS equivalent of C<%hash = ()>. See also L</hv_undef>.
1690 See L</av_clear> for a note about the hash possibly being invalid on
1691 return.
1693 =cut
1694 */
1696 void
1697 Perl_hv_clear(pTHX_ HV *hv)
1698 {
1699 dVAR;
1700 SSize_t orig_ix;
1702 XPVHV* xhv;
1703 if (!hv)
1704 return;
1706 DEBUG_A(Perl_hv_assert(aTHX_ hv));
1708 xhv = (XPVHV*)SvANY(hv);
1710 /* avoid hv being freed when calling destructors below */
1711 EXTEND_MORTAL(1);
1712 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple_NN(hv);
1713 orig_ix = PL_tmps_ix;
1714 if (SvREADONLY(hv) && HvARRAY(hv) != NULL) {
1715 /* restricted hash: convert all keys to placeholders */
1716 STRLEN i;
1717 for (i = 0; i <= xhv->xhv_max; i++) {
1718 HE *entry = (HvARRAY(hv))[i];
1719 for (; entry; entry = HeNEXT(entry)) {
1720 /* not already placeholder */
1721 if (HeVAL(entry) != &PL_sv_placeholder) {
1722 if (HeVAL(entry)) {
1723 if (SvREADONLY(HeVAL(entry))) {
1724 SV* const keysv = hv_iterkeysv(entry);
1725 Perl_croak_nocontext(
1726 "Attempt to delete readonly key '%" SVf "' from a restricted hash",
1727 (void*)keysv);
1728 }
1729 SvREFCNT_dec_NN(HeVAL(entry));
1730 }
1731 HeVAL(entry) = &PL_sv_placeholder;
1732 HvPLACEHOLDERS(hv)++;
1733 }
1734 }
1735 }
1736 }
1737 else {
1738 hfreeentries(hv);
1739 HvPLACEHOLDERS_set(hv, 0);
1741 if (SvRMAGICAL(hv))
1742 mg_clear(MUTABLE_SV(hv));
1744 HvHASKFLAGS_off(hv);
1745 }
1746 if (SvOOK(hv)) {
1747 if(HvENAME_get(hv))
1748 mro_isa_changed_in(hv);
1749 HvEITER_set(hv, NULL);
1750 }
1751 /* disarm hv's premature free guard */
1752 if (LIKELY(PL_tmps_ix == orig_ix))
1753 PL_tmps_ix--;
1754 else
1755 PL_tmps_stack[orig_ix] = &PL_sv_undef;
1756 SvREFCNT_dec_NN(hv);
1757 }
1759 /*
1760 =for apidoc hv_clear_placeholders
1762 Clears any placeholders from a hash. If a restricted hash has any of its keys
1763 marked as readonly and the key is subsequently deleted, the key is not actually
1764 deleted but is marked by assigning it a value of C<&PL_sv_placeholder>. This tags
1765 it so it will be ignored by future operations such as iterating over the hash,
1766 but will still allow the hash to have a value reassigned to the key at some
1767 future point. This function clears any such placeholder keys from the hash.
1768 See C<L<Hash::Util::lock_keys()|Hash::Util/lock_keys>> for an example of its
1769 use.
1771 =cut
1772 */
1774 void
1775 Perl_hv_clear_placeholders(pTHX_ HV *hv)
1776 {
1777 const U32 items = (U32)HvPLACEHOLDERS_get(hv);
1779 PERL_ARGS_ASSERT_HV_CLEAR_PLACEHOLDERS;
1781 if (items)
1782 clear_placeholders(hv, items);
1783 }
1785 static void
1786 S_clear_placeholders(pTHX_ HV *hv, U32 items)
1787 {
1788 dVAR;
1789 I32 i;
1791 PERL_ARGS_ASSERT_CLEAR_PLACEHOLDERS;
1793 if (items == 0)
1794 return;
1796 i = HvMAX(hv);
1797 do {
1798 /* Loop down the linked list heads */
1799 HE **oentry = &(HvARRAY(hv))[i];
1800 HE *entry;
1802 while ((entry = *oentry)) {
1803 if (HeVAL(entry) == &PL_sv_placeholder) {
1804 *oentry = HeNEXT(entry);
1805 if (entry == HvEITER_get(hv))
1806 HvLAZYDEL_on(hv);
1807 else {
1808 if (SvOOK(hv) && HvLAZYDEL(hv) &&
1809 entry == HeNEXT(HvAUX(hv)->xhv_eiter))
1810 HeNEXT(HvAUX(hv)->xhv_eiter) = HeNEXT(entry);
1811 hv_free_ent(hv, entry);
1812 }
1814 if (--items == 0) {
1815 /* Finished. */
1816 I32 placeholders = HvPLACEHOLDERS_get(hv);
1817 HvTOTALKEYS(hv) -= (IV)placeholders;
1818 /* HvUSEDKEYS expanded */
1819 if ((HvTOTALKEYS(hv) - placeholders) == 0)
1820 HvHASKFLAGS_off(hv);
1821 HvPLACEHOLDERS_set(hv, 0);
1822 return;
1823 }
1824 } else {
1825 oentry = &HeNEXT(entry);
1826 }
1827 }
1828 } while (--i >= 0);
1829 /* You can't get here, hence assertion should always fail. */
1830 assert (items == 0);
1831 NOT_REACHED; /* NOTREACHED */
1832 }
1834 STATIC void
1835 S_hfreeentries(pTHX_ HV *hv)
1836 {
1837 STRLEN index = 0;
1838 XPVHV * const xhv = (XPVHV*)SvANY(hv);
1839 SV *sv;
1841 PERL_ARGS_ASSERT_HFREEENTRIES;
1843 while ((sv = Perl_hfree_next_entry(aTHX_ hv, &index))||xhv->xhv_keys) {
1844 SvREFCNT_dec(sv);
1845 }
1846 }
1849 /* hfree_next_entry()
1850 * For use only by S_hfreeentries() and sv_clear().
1851 * Delete the next available HE from hv and return the associated SV.
1852 * Returns null on empty hash. Nevertheless null is not a reliable
1853 * indicator that the hash is empty, as the deleted entry may have a
1854 * null value.
1855 * indexp is a pointer to the current index into HvARRAY. The index should
1856 * initially be set to 0. hfree_next_entry() may update it. */
1858 SV*
1859 Perl_hfree_next_entry(pTHX_ HV *hv, STRLEN *indexp)
1860 {
1861 struct xpvhv_aux *iter;
1862 HE *entry;
1863 HE ** array;
1864 #ifdef DEBUGGING
1865 STRLEN orig_index = *indexp;
1866 #endif
1868 PERL_ARGS_ASSERT_HFREE_NEXT_ENTRY;
1870 if (SvOOK(hv) && ((iter = HvAUX(hv)))) {
1871 if ((entry = iter->xhv_eiter)) {
1872 /* the iterator may get resurrected after each
1873 * destructor call, so check each time */
1874 if (entry && HvLAZYDEL(hv)) { /* was deleted earlier? */
1875 HvLAZYDEL_off(hv);
1876 hv_free_ent(hv, entry);
1877 /* warning: at this point HvARRAY may have been
1878 * re-allocated, HvMAX changed etc */
1879 }
1880 iter = HvAUX(hv); /* may have been realloced */
1881 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
1882 iter->xhv_eiter = NULL; /* HvEITER(hv) = NULL */
1883 #ifdef PERL_HASH_RANDOMIZE_KEYS
1884 iter->xhv_last_rand = iter->xhv_rand;
1885 #endif
1886 }
1887 }
1889 if (!((XPVHV*)SvANY(hv))->xhv_keys)
1890 return NULL;
1892 array = HvARRAY(hv);
1893 assert(array);
1894 while ( ! ((entry = array[*indexp])) ) {
1895 if ((*indexp)++ >= HvMAX(hv))
1896 *indexp = 0;
1897 assert(*indexp != orig_index);
1898 }
1899 array[*indexp] = HeNEXT(entry);
1900 ((XPVHV*) SvANY(hv))->xhv_keys--;
1902 if ( PL_phase != PERL_PHASE_DESTRUCT && HvENAME(hv)
1903 && HeVAL(entry) && isGV(HeVAL(entry))
1904 && GvHV(HeVAL(entry)) && HvENAME(GvHV(HeVAL(entry)))
1905 ) {
1906 STRLEN klen;
1907 const char * const key = HePV(entry,klen);
1908 if ((klen > 1 && key[klen-1]==':' && key[klen-2]==':')
1909 || (klen == 1 && key[0] == ':')) {
1910 mro_package_moved(
1911 NULL, GvHV(HeVAL(entry)),
1912 (GV *)HeVAL(entry), 0
1913 );
1914 }
1915 }
1916 return hv_free_ent_ret(hv, entry);
1917 }
1920 /*
1921 =for apidoc hv_undef
1923 Undefines the hash. The XS equivalent of C<undef(%hash)>.
1925 As well as freeing all the elements of the hash (like C<hv_clear()>), this
1926 also frees any auxiliary data and storage associated with the hash.
1928 See L</av_clear> for a note about the hash possibly being invalid on
1929 return.
1931 =cut
1932 */
1934 void
1935 Perl_hv_undef_flags(pTHX_ HV *hv, U32 flags)
1936 {
1937 XPVHV* xhv;
1938 bool save;
1939 SSize_t orig_ix;
1941 if (!hv)
1942 return;
1943 save = cBOOL(SvREFCNT(hv));
1944 DEBUG_A(Perl_hv_assert(aTHX_ hv));
1945 xhv = (XPVHV*)SvANY(hv);
1947 /* The name must be deleted before the call to hfreeeeentries so that
1948 CVs are anonymised properly. But the effective name must be pre-
1949 served until after that call (and only deleted afterwards if the
1950 call originated from sv_clear). For stashes with one name that is
1951 both the canonical name and the effective name, hv_name_set has to
1952 allocate an array for storing the effective name. We can skip that
1953 during global destruction, as it does not matter where the CVs point
1954 if they will be freed anyway. */
1955 /* note that the code following prior to hfreeentries is duplicated
1956 * in sv_clear(), and changes here should be done there too */
1957 if (PL_phase != PERL_PHASE_DESTRUCT && HvNAME(hv)) {
1958 if (PL_stashcache) {
1959 DEBUG_o(Perl_deb(aTHX_ "hv_undef_flags clearing PL_stashcache for '%"
1960 HEKf "'\n", HEKfARG(HvNAME_HEK(hv))));
1961 (void)hv_deletehek(PL_stashcache, HvNAME_HEK(hv), G_DISCARD);
1962 }
1963 hv_name_set(hv, NULL, 0, 0);
1964 }
1965 if (save) {
1966 /* avoid hv being freed when calling destructors below */
1967 EXTEND_MORTAL(1);
1968 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple_NN(hv);
1969 orig_ix = PL_tmps_ix;
1970 }
1971 hfreeentries(hv);
1972 if (SvOOK(hv)) {
1973 struct mro_meta *meta;
1974 const char *name;
1976 if (HvENAME_get(hv)) {
1977 if (PL_phase != PERL_PHASE_DESTRUCT)
1978 mro_isa_changed_in(hv);
1979 if (PL_stashcache) {
1980 DEBUG_o(Perl_deb(aTHX_ "hv_undef_flags clearing PL_stashcache for effective name '%"
1981 HEKf "'\n", HEKfARG(HvENAME_HEK(hv))));
1982 (void)hv_deletehek(PL_stashcache, HvENAME_HEK(hv), G_DISCARD);
1983 }
1984 }
1986 /* If this call originated from sv_clear, then we must check for
1987 * effective names that need freeing, as well as the usual name. */
1988 name = HvNAME(hv);
1989 if (flags & HV_NAME_SETALL ? !!HvAUX(hv)->xhv_name_u.xhvnameu_name : !!name) {
1990 if (name && PL_stashcache) {
1991 DEBUG_o(Perl_deb(aTHX_ "hv_undef_flags clearing PL_stashcache for name '%"
1992 HEKf "'\n", HEKfARG(HvNAME_HEK(hv))));
1993 (void)hv_deletehek(PL_stashcache, HvNAME_HEK(hv), G_DISCARD);
1994 }
1995 hv_name_set(hv, NULL, 0, flags);
1996 }
1997 if((meta = HvAUX(hv)->xhv_mro_meta)) {
1998 if (meta->mro_linear_all) {
1999 SvREFCNT_dec_NN(meta->mro_linear_all);
2000 /* mro_linear_current is just acting as a shortcut pointer,
2001 hence the else. */
2002 }
2003 else
2004 /* Only the current MRO is stored, so this owns the data.
2005 */
2006 SvREFCNT_dec(meta->mro_linear_current);
2007 SvREFCNT_dec(meta->mro_nextmethod);
2008 SvREFCNT_dec(meta->isa);
2009 SvREFCNT_dec(meta->super);
2010 Safefree(meta);
2011 HvAUX(hv)->xhv_mro_meta = NULL;
2012 }
2013 if (!HvAUX(hv)->xhv_name_u.xhvnameu_name && ! HvAUX(hv)->xhv_backreferences)
2014 SvFLAGS(hv) &= ~SVf_OOK;
2015 }
2016 if (!SvOOK(hv)) {
2017 Safefree(HvARRAY(hv));
2018 xhv->xhv_max = PERL_HASH_DEFAULT_HvMAX; /* HvMAX(hv) = 7 (it's a normal hash) */
2019 HvARRAY(hv) = 0;
2020 }
2021 /* if we're freeing the HV, the SvMAGIC field has been reused for
2022 * other purposes, and so there can't be any placeholder magic */
2023 if (SvREFCNT(hv))
2024 HvPLACEHOLDERS_set(hv, 0);
2026 if (SvRMAGICAL(hv))
2027 mg_clear(MUTABLE_SV(hv));
2029 if (save) {
2030 /* disarm hv's premature free guard */
2031 if (LIKELY(PL_tmps_ix == orig_ix))
2032 PL_tmps_ix--;
2033 else
2034 PL_tmps_stack[orig_ix] = &PL_sv_undef;
2035 SvREFCNT_dec_NN(hv);
2036 }
2037 }
2039 /*
2040 =for apidoc hv_fill
2042 Returns the number of hash buckets that happen to be in use.
2044 This function is wrapped by the macro C<HvFILL>.
2046 As of perl 5.25 this function is used only for debugging
2047 purposes, and the number of used hash buckets is not
2048 in any way cached, thus this function can be costly
2049 to execute as it must iterate over all the buckets in the
2050 hash.
2052 =cut
2053 */
2055 STRLEN
2056 Perl_hv_fill(pTHX_ HV *const hv)
2057 {
2058 STRLEN count = 0;
2059 HE **ents = HvARRAY(hv);
2061 PERL_UNUSED_CONTEXT;
2062 PERL_ARGS_ASSERT_HV_FILL;
2064 /* No keys implies no buckets used.
2065 One key can only possibly mean one bucket used. */
2066 if (HvTOTALKEYS(hv) < 2)
2067 return HvTOTALKEYS(hv);
2069 if (ents) {
2070 /* I wonder why we count down here...
2071 * Is it some micro-optimisation?
2072 * I would have thought counting up was better.
2073 * - Yves
2074 */
2075 HE *const *const last = ents + HvMAX(hv);
2076 count = last + 1 - ents;
2078 do {
2079 if (!*ents)
2080 --count;
2081 } while (++ents <= last);
2082 }
2083 return count;
2084 }
2086 /* hash a pointer to a U32 - Used in the hash traversal randomization
2087 * and bucket order randomization code
2088 *
2089 * this code was derived from Sereal, which was derived from autobox.
2090 */
2092 PERL_STATIC_INLINE U32 S_ptr_hash(PTRV u) {
2093 #if PTRSIZE == 8
2094 /*
2095 * This is one of Thomas Wang's hash functions for 64-bit integers from:
2096 * https://www.concentric.net/~Ttwang/tech/inthash.htm
2097 */
2098 u = (~u) + (u << 18);
2099 u = u ^ (u >> 31);
2100 u = u * 21;
2101 u = u ^ (u >> 11);
2102 u = u + (u << 6);
2103 u = u ^ (u >> 22);
2104 #else
2105 /*
2106 * This is one of Bob Jenkins' hash functions for 32-bit integers
2107 * from: https://burtleburtle.net/bob/hash/integer.html
2108 */
2109 u = (u + 0x7ed55d16) + (u << 12);
2110 u = (u ^ 0xc761c23c) ^ (u >> 19);
2111 u = (u + 0x165667b1) + (u << 5);
2112 u = (u + 0xd3a2646c) ^ (u << 9);
2113 u = (u + 0xfd7046c5) + (u << 3);
2114 u = (u ^ 0xb55a4f09) ^ (u >> 16);
2115 #endif
2116 return (U32)u;
2117 }
2119 static struct xpvhv_aux*
2120 S_hv_auxinit_internal(struct xpvhv_aux *iter) {
2121 PERL_ARGS_ASSERT_HV_AUXINIT_INTERNAL;
2122 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
2123 iter->xhv_eiter = NULL; /* HvEITER(hv) = NULL */
2124 #ifdef PERL_HASH_RANDOMIZE_KEYS
2125 iter->xhv_last_rand = iter->xhv_rand;
2126 #endif
2127 iter->xhv_name_u.xhvnameu_name = 0;
2128 iter->xhv_name_count = 0;
2129 iter->xhv_backreferences = 0;
2130 iter->xhv_mro_meta = NULL;
2131 iter->xhv_aux_flags = 0;
2132 return iter;
2133 }
2136 static struct xpvhv_aux*
2137 S_hv_auxinit(pTHX_ HV *hv) {
2138 struct xpvhv_aux *iter;
2139 char *array;
2141 PERL_ARGS_ASSERT_HV_AUXINIT;
2143 if (!SvOOK(hv)) {
2144 if (!HvARRAY(hv)) {
2145 Newxz(array, PERL_HV_ARRAY_ALLOC_BYTES(HvMAX(hv) + 1)
2146 + sizeof(struct xpvhv_aux), char);
2147 } else {
2148 array = (char *) HvARRAY(hv);
2149 Renew(array, PERL_HV_ARRAY_ALLOC_BYTES(HvMAX(hv) + 1)
2150 + sizeof(struct xpvhv_aux), char);
2151 }
2152 HvARRAY(hv) = (HE**)array;
2153 SvOOK_on(hv);
2154 iter = HvAUX(hv);
2155 #ifdef PERL_HASH_RANDOMIZE_KEYS
2156 if (PL_HASH_RAND_BITS_ENABLED) {
2157 /* mix in some new state to PL_hash_rand_bits to "randomize" the traversal order*/
2158 if (PL_HASH_RAND_BITS_ENABLED == 1)
2159 PL_hash_rand_bits += ptr_hash((PTRV)array);
2160 PL_hash_rand_bits = ROTL_UV(PL_hash_rand_bits,1);
2161 }
2162 iter->xhv_rand = (U32)PL_hash_rand_bits;
2163 #endif
2164 } else {
2165 iter = HvAUX(hv);
2166 }
2168 return hv_auxinit_internal(iter);
2169 }
2171 /*
2172 =for apidoc hv_iterinit
2174 Prepares a starting point to traverse a hash table. Returns the number of
2175 keys in the hash (i.e. the same as C<HvUSEDKEYS(hv)>). The return value is
2176 currently only meaningful for hashes without tie magic.
2178 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
2179 hash buckets that happen to be in use. If you still need that esoteric
2180 value, you can get it through the macro C<HvFILL(hv)>.
2183 =cut
2184 */
2186 I32
2187 Perl_hv_iterinit(pTHX_ HV *hv)
2188 {
2189 PERL_ARGS_ASSERT_HV_ITERINIT;
2191 if (SvOOK(hv)) {
2192 struct xpvhv_aux * iter = HvAUX(hv);
2193 HE * const entry = iter->xhv_eiter; /* HvEITER(hv) */
2194 if (entry && HvLAZYDEL(hv)) { /* was deleted earlier? */
2195 HvLAZYDEL_off(hv);
2196 hv_free_ent(hv, entry);
2197 }
2198 iter = HvAUX(hv); /* may have been reallocated */
2199 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
2200 iter->xhv_eiter = NULL; /* HvEITER(hv) = NULL */
2201 #ifdef PERL_HASH_RANDOMIZE_KEYS
2202 iter->xhv_last_rand = iter->xhv_rand;
2203 #endif
2204 } else {
2205 hv_auxinit(hv);
2206 }
2208 /* note this includes placeholders! */
2209 return HvTOTALKEYS(hv);
2210 }
2212 I32 *
2213 Perl_hv_riter_p(pTHX_ HV *hv) {
2214 struct xpvhv_aux *iter;
2216 PERL_ARGS_ASSERT_HV_RITER_P;
2218 iter = SvOOK(hv) ? HvAUX(hv) : hv_auxinit(hv);
2219 return &(iter->xhv_riter);
2220 }
2222 HE **
2223 Perl_hv_eiter_p(pTHX_ HV *hv) {
2224 struct xpvhv_aux *iter;
2226 PERL_ARGS_ASSERT_HV_EITER_P;
2228 iter = SvOOK(hv) ? HvAUX(hv) : hv_auxinit(hv);
2229 return &(iter->xhv_eiter);
2230 }
2232 void
2233 Perl_hv_riter_set(pTHX_ HV *hv, I32 riter) {
2234 struct xpvhv_aux *iter;
2236 PERL_ARGS_ASSERT_HV_RITER_SET;
2238 if (SvOOK(hv)) {
2239 iter = HvAUX(hv);
2240 } else {
2241 if (riter == -1)
2242 return;
2244 iter = hv_auxinit(hv);
2245 }
2246 iter->xhv_riter = riter;
2247 }
2249 void
2250 Perl_hv_rand_set(pTHX_ HV *hv, U32 new_xhv_rand) {
2251 struct xpvhv_aux *iter;
2253 PERL_ARGS_ASSERT_HV_RAND_SET;
2255 #ifdef PERL_HASH_RANDOMIZE_KEYS
2256 if (SvOOK(hv)) {
2257 iter = HvAUX(hv);
2258 } else {
2259 iter = hv_auxinit(hv);
2260 }
2261 iter->xhv_rand = new_xhv_rand;
2262 #else
2263 Perl_croak(aTHX_ "This Perl has not been built with support for randomized hash key traversal but something called Perl_hv_rand_set().");
2264 #endif
2265 }
2267 void
2268 Perl_hv_eiter_set(pTHX_ HV *hv, HE *eiter) {
2269 struct xpvhv_aux *iter;
2271 PERL_ARGS_ASSERT_HV_EITER_SET;
2273 if (SvOOK(hv)) {
2274 iter = HvAUX(hv);
2275 } else {
2276 /* 0 is the default so don't go malloc()ing a new structure just to
2277 hold 0. */
2278 if (!eiter)
2279 return;
2281 iter = hv_auxinit(hv);
2282 }
2283 iter->xhv_eiter = eiter;
2284 }
2286 void
2287 Perl_hv_name_set(pTHX_ HV *hv, const char *name, U32 len, U32 flags)
2288 {
2289 dVAR;
2290 struct xpvhv_aux *iter;
2291 U32 hash;
2292 HEK **spot;
2294 PERL_ARGS_ASSERT_HV_NAME_SET;
2296 if (len > I32_MAX)
2297 Perl_croak(aTHX_ "panic: hv name too long (%" UVuf ")", (UV) len);
2299 if (SvOOK(hv)) {
2300 iter = HvAUX(hv);
2301 if (iter->xhv_name_u.xhvnameu_name) {
2302 if(iter->xhv_name_count) {
2303 if(flags & HV_NAME_SETALL) {
2304 HEK ** const name = HvAUX(hv)->xhv_name_u.xhvnameu_names;
2305 HEK **hekp = name + (
2306 iter->xhv_name_count < 0
2307 ? -iter->xhv_name_count
2308 : iter->xhv_name_count
2309 );
2310 while(hekp-- > name+1)
2311 unshare_hek_or_pvn(*hekp, 0, 0, 0);
2312 /* The first elem may be null. */
2313 if(*name) unshare_hek_or_pvn(*name, 0, 0, 0);
2314 Safefree(name);
2315 iter = HvAUX(hv); /* may been realloced */
2316 spot = &iter->xhv_name_u.xhvnameu_name;
2317 iter->xhv_name_count = 0;
2318 }
2319 else {
2320 if(iter->xhv_name_count > 0) {
2321 /* shift some things over */
2322 Renew(
2323 iter->xhv_name_u.xhvnameu_names, iter->xhv_name_count + 1, HEK *
2324 );
2325 spot = iter->xhv_name_u.xhvnameu_names;
2326 spot[iter->xhv_name_count] = spot[1];
2327 spot[1] = spot[0];
2328 iter->xhv_name_count = -(iter->xhv_name_count + 1);
2329 }
2330 else if(*(spot = iter->xhv_name_u.xhvnameu_names)) {
2331 unshare_hek_or_pvn(*spot, 0, 0, 0);
2332 }
2333 }
2334 }
2335 else if (flags & HV_NAME_SETALL) {
2336 unshare_hek_or_pvn(iter->xhv_name_u.xhvnameu_name, 0, 0, 0);
2337 iter = HvAUX(hv); /* may been realloced */
2338 spot = &iter->xhv_name_u.xhvnameu_name;
2339 }
2340 else {
2341 HEK * const existing_name = iter->xhv_name_u.xhvnameu_name;
2342 Newx(iter->xhv_name_u.xhvnameu_names, 2, HEK *);
2343 iter->xhv_name_count = -2;
2344 spot = iter->xhv_name_u.xhvnameu_names;
2345 spot[1] = existing_name;
2346 }
2347 }
2348 else { spot = &iter->xhv_name_u.xhvnameu_name; iter->xhv_name_count = 0; }
2349 } else {
2350 if (name == 0)
2351 return;
2353 iter = hv_auxinit(hv);
2354 spot = &iter->xhv_name_u.xhvnameu_name;
2355 }
2356 PERL_HASH(hash, name, len);
2357 *spot = name ? share_hek(name, flags & SVf_UTF8 ? -(I32)len : (I32)len, hash) : NULL;
2358 }
2360 /*
2361 This is basically sv_eq_flags() in sv.c, but we avoid the magic
2362 and bytes checking.
2363 */
2365 STATIC I32
2366 hek_eq_pvn_flags(pTHX_ const HEK *hek, const char* pv, const I32 pvlen, const U32 flags) {
2367 if ( (HEK_UTF8(hek) ? 1 : 0) != (flags & SVf_UTF8 ? 1 : 0) ) {
2368 if (flags & SVf_UTF8)
2369 return (bytes_cmp_utf8(
2370 (const U8*)HEK_KEY(hek), HEK_LEN(hek),
2371 (const U8*)pv, pvlen) == 0);
2372 else
2373 return (bytes_cmp_utf8(
2374 (const U8*)pv, pvlen,
2375 (const U8*)HEK_KEY(hek), HEK_LEN(hek)) == 0);
2376 }
2377 else
2378 return HEK_LEN(hek) == pvlen && ((HEK_KEY(hek) == pv)
2379 || memEQ(HEK_KEY(hek), pv, pvlen));
2380 }
2382 /*
2383 =for apidoc hv_ename_add
2385 Adds a name to a stash's internal list of effective names. See
2386 C<L</hv_ename_delete>>.
2388 This is called when a stash is assigned to a new location in the symbol
2389 table.
2391 =cut
2392 */
2394 void
2395 Perl_hv_ename_add(pTHX_ HV *hv, const char *name, U32 len, U32 flags)
2396 {
2397 dVAR;
2398 struct xpvhv_aux *aux = SvOOK(hv) ? HvAUX(hv) : hv_auxinit(hv);
2399 U32 hash;
2401 PERL_ARGS_ASSERT_HV_ENAME_ADD;
2403 if (len > I32_MAX)
2404 Perl_croak(aTHX_ "panic: hv name too long (%" UVuf ")", (UV) len);
2406 PERL_HASH(hash, name, len);
2408 if (aux->xhv_name_count) {
2409 I32 count = aux->xhv_name_count;
2410 HEK ** const xhv_name = aux->xhv_name_u.xhvnameu_names + (count<0);
2411 HEK **hekp = xhv_name + (count < 0 ? -count - 1 : count);
2412 while (hekp-- > xhv_name)
2413 {
2414 assert(*hekp);
2415 if (
2416 (HEK_UTF8(*hekp) || (flags & SVf_UTF8))
2417 ? hek_eq_pvn_flags(aTHX_ *hekp, name, (I32)len, flags)
2418 : (HEK_LEN(*hekp) == (I32)len && memEQ(HEK_KEY(*hekp), name, len))
2419 ) {
2420 if (hekp == xhv_name && count < 0)
2421 aux->xhv_name_count = -count;
2422 return;
2423 }
2424 }
2425 if (count < 0) aux->xhv_name_count--, count = -count;
2426 else aux->xhv_name_count++;
2427 Renew(aux->xhv_name_u.xhvnameu_names, count + 1, HEK *);
2428 (aux->xhv_name_u.xhvnameu_names)[count] = share_hek(name, (flags & SVf_UTF8 ? -(I32)len : (I32)len), hash);
2429 }
2430 else {
2431 HEK *existing_name = aux->xhv_name_u.xhvnameu_name;
2432 if (
2433 existing_name && (
2434 (HEK_UTF8(existing_name) || (flags & SVf_UTF8))
2435 ? hek_eq_pvn_flags(aTHX_ existing_name, name, (I32)len, flags)
2436 : (HEK_LEN(existing_name) == (I32)len && memEQ(HEK_KEY(existing_name), name, len))
2437 )
2438 ) return;
2439 Newx(aux->xhv_name_u.xhvnameu_names, 2, HEK *);
2440 aux->xhv_name_count = existing_name ? 2 : -2;
2441 *aux->xhv_name_u.xhvnameu_names = existing_name;
2442 (aux->xhv_name_u.xhvnameu_names)[1] = share_hek(name, (flags & SVf_UTF8 ? -(I32)len : (I32)len), hash);
2443 }
2444 }
2446 /*
2447 =for apidoc hv_ename_delete
2449 Removes a name from a stash's internal list of effective names. If this is
2450 the name returned by C<HvENAME>, then another name in the list will take
2451 its place (C<HvENAME> will use it).
2453 This is called when a stash is deleted from the symbol table.
2455 =cut
2456 */
2458 void
2459 Perl_hv_ename_delete(pTHX_ HV *hv, const char *name, U32 len, U32 flags)
2460 {
2461 struct xpvhv_aux *aux;
2463 PERL_ARGS_ASSERT_HV_ENAME_DELETE;
2465 if (len > I32_MAX)
2466 Perl_croak(aTHX_ "panic: hv name too long (%" UVuf ")", (UV) len);
2468 if (!SvOOK(hv)) return;
2470 aux = HvAUX(hv);
2471 if (!aux->xhv_name_u.xhvnameu_name) return;
2473 if (aux->xhv_name_count) {
2474 HEK ** const namep = aux->xhv_name_u.xhvnameu_names;
2475 I32 const count = aux->xhv_name_count;
2476 HEK **victim = namep + (count < 0 ? -count : count);
2477 while (victim-- > namep + 1)
2478 if (
2479 (HEK_UTF8(*victim) || (flags & SVf_UTF8))
2480 ? hek_eq_pvn_flags(aTHX_ *victim, name, (I32)len, flags)
2481 : (HEK_LEN(*victim) == (I32)len && memEQ(HEK_KEY(*victim), name, len))
2482 ) {
2483 unshare_hek_or_pvn(*victim, 0, 0, 0);
2484 aux = HvAUX(hv); /* may been realloced */
2485 if (count < 0) ++aux->xhv_name_count;
2486 else --aux->xhv_name_count;
2487 if (
2488 (aux->xhv_name_count == 1 || aux->xhv_name_count == -1)
2489 && !*namep
2490 ) { /* if there are none left */
2491 Safefree(namep);
2492 aux->xhv_name_u.xhvnameu_names = NULL;
2493 aux->xhv_name_count = 0;
2494 }
2495 else {
2496 /* Move the last one back to fill the empty slot. It
2497 does not matter what order they are in. */
2498 *victim = *(namep + (count < 0 ? -count : count) - 1);
2499 }
2500 return;
2501 }
2502 if (
2503 count > 0 && ((HEK_UTF8(*namep) || (flags & SVf_UTF8))
2504 ? hek_eq_pvn_flags(aTHX_ *namep, name, (I32)len, flags)
2505 : (HEK_LEN(*namep) == (I32)len && memEQ(HEK_KEY(*namep), name, len))
2506 )
2507 ) {
2508 aux->xhv_name_count = -count;
2509 }
2510 }
2511 else if(
2512 (HEK_UTF8(aux->xhv_name_u.xhvnameu_name) || (flags & SVf_UTF8))
2513 ? hek_eq_pvn_flags(aTHX_ aux->xhv_name_u.xhvnameu_name, name, (I32)len, flags)
2514 : (HEK_LEN(aux->xhv_name_u.xhvnameu_name) == (I32)len &&
2515 memEQ(HEK_KEY(aux->xhv_name_u.xhvnameu_name), name, len))
2516 ) {
2517 HEK * const namehek = aux->xhv_name_u.xhvnameu_name;
2518 Newx(aux->xhv_name_u.xhvnameu_names, 1, HEK *);
2519 *aux->xhv_name_u.xhvnameu_names = namehek;
2520 aux->xhv_name_count = -1;
2521 }
2522 }
2524 AV **
2525 Perl_hv_backreferences_p(pTHX_ HV *hv) {
2526 PERL_ARGS_ASSERT_HV_BACKREFERENCES_P;
2527 /* See also Perl_sv_get_backrefs in sv.c where this logic is unrolled */
2528 {
2529 struct xpvhv_aux * const iter = SvOOK(hv) ? HvAUX(hv) : hv_auxinit(hv);
2530 return &(iter->xhv_backreferences);
2531 }
2532 }
2534 void
2535 Perl_hv_kill_backrefs(pTHX_ HV *hv) {
2536 AV *av;
2538 PERL_ARGS_ASSERT_HV_KILL_BACKREFS;
2540 if (!SvOOK(hv))
2541 return;
2543 av = HvAUX(hv)->xhv_backreferences;
2545 if (av) {
2546 HvAUX(hv)->xhv_backreferences = 0;
2547 Perl_sv_kill_backrefs(aTHX_ MUTABLE_SV(hv), av);
2548 if (SvTYPE(av) == SVt_PVAV)
2549 SvREFCNT_dec_NN(av);
2550 }
2551 }
2553 /*
2554 hv_iternext is implemented as a macro in hv.h
2556 =for apidoc hv_iternext
2558 Returns entries from a hash iterator. See C<L</hv_iterinit>>.
2560 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
2561 iterator currently points to, without losing your place or invalidating your
2562 iterator. Note that in this case the current entry is deleted from the hash
2563 with your iterator holding the last reference to it. Your iterator is flagged
2564 to free the entry on the next call to C<hv_iternext>, so you must not discard
2565 your iterator immediately else the entry will leak - call C<hv_iternext> to
2566 trigger the resource deallocation.
2568 =for apidoc hv_iternext_flags
2570 Returns entries from a hash iterator. See C<L</hv_iterinit>> and
2571 C<L</hv_iternext>>.
2572 The C<flags> value will normally be zero; if C<HV_ITERNEXT_WANTPLACEHOLDERS> is
2573 set the placeholders keys (for restricted hashes) will be returned in addition
2574 to normal keys. By default placeholders are automatically skipped over.
2575 Currently a placeholder is implemented with a value that is
2576 C<&PL_sv_placeholder>. Note that the implementation of placeholders and
2577 restricted hashes may change, and the implementation currently is
2578 insufficiently abstracted for any change to be tidy.
2580 =cut
2581 */
2583 HE *
2584 Perl_hv_iternext_flags(pTHX_ HV *hv, I32 flags)
2585 {
2586 dVAR;
2587 XPVHV* xhv;
2588 HE *entry;
2589 HE *oldentry;
2590 MAGIC* mg;
2591 struct xpvhv_aux *iter;
2593 PERL_ARGS_ASSERT_HV_ITERNEXT_FLAGS;
2595 xhv = (XPVHV*)SvANY(hv);
2597 if (!SvOOK(hv)) {
2598 /* Too many things (well, pp_each at least) merrily assume that you can
2599 call hv_iternext without calling hv_iterinit, so we'll have to deal
2600 with it. */
2601 hv_iterinit(hv);
2602 }
2603 iter = HvAUX(hv);
2605 oldentry = entry = iter->xhv_eiter; /* HvEITER(hv) */
2606 if (SvMAGICAL(hv) && SvRMAGICAL(hv)) {
2607 if ( ( mg = mg_find((const SV *)hv, PERL_MAGIC_tied) ) ) {
2608 SV * const key = sv_newmortal();
2609 if (entry) {
2610 sv_setsv(key, HeSVKEY_force(entry));
2611 SvREFCNT_dec(HeSVKEY(entry)); /* get rid of previous key */
2612 HeSVKEY_set(entry, NULL);
2613 }
2614 else {
2615 char *k;
2616 HEK *hek;
2618 /* one HE per MAGICAL hash */
2619 iter->xhv_eiter = entry = new_HE(); /* HvEITER(hv) = new_HE() */
2620 HvLAZYDEL_on(hv); /* make sure entry gets freed */
2621 Zero(entry, 1, HE);
2622 Newxz(k, HEK_BASESIZE + sizeof(const SV *), char);
2623 hek = (HEK*)k;
2624 HeKEY_hek(entry) = hek;
2625 HeKLEN(entry) = HEf_SVKEY;
2626 }
2627 magic_nextpack(MUTABLE_SV(hv),mg,key);
2628 if (SvOK(key)) {
2629 /* force key to stay around until next time */
2630 HeSVKEY_set(entry, SvREFCNT_inc_simple_NN(key));
2631 return entry; /* beware, hent_val is not set */
2632 }
2633 SvREFCNT_dec(HeVAL(entry));
2634 Safefree(HeKEY_hek(entry));
2635 del_HE(entry);
2636 iter = HvAUX(hv); /* may been realloced */
2637 iter->xhv_eiter = NULL; /* HvEITER(hv) = NULL */
2638 HvLAZYDEL_off(hv);
2639 return NULL;
2640 }
2641 }
2642 #if defined(DYNAMIC_ENV_FETCH) && !defined(__riscos__) /* set up %ENV for iteration */
2643 if (!entry && SvRMAGICAL((const SV *)hv)
2644 && mg_find((const SV *)hv, PERL_MAGIC_env)) {
2645 prime_env_iter();
2646 #ifdef VMS
2647 /* The prime_env_iter() on VMS just loaded up new hash values
2648 * so the iteration count needs to be reset back to the beginning
2649 */
2650 hv_iterinit(hv);
2651 iter = HvAUX(hv);
2652 oldentry = entry = iter->xhv_eiter; /* HvEITER(hv) */
2653 #endif
2654 }
2655 #endif
2657 /* hv_iterinit now ensures this. */
2658 assert (HvARRAY(hv));
2660 /* At start of hash, entry is NULL. */
2661 if (entry)
2662 {
2663 entry = HeNEXT(entry);
2664 if (!(flags & HV_ITERNEXT_WANTPLACEHOLDERS)) {
2665 /*
2666 * Skip past any placeholders -- don't want to include them in
2667 * any iteration.
2668 */
2669 while (entry && HeVAL(entry) == &PL_sv_placeholder) {
2670 entry = HeNEXT(entry);
2671 }
2672 }
2673 }
2675 #ifdef PERL_HASH_RANDOMIZE_KEYS
2676 if (iter->xhv_last_rand != iter->xhv_rand) {
2677 if (iter->xhv_riter != -1) {
2678 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
2679 "Use of each() on hash after insertion without resetting hash iterator results in undefined behavior"
2680 pTHX__FORMAT
2681 pTHX__VALUE);
2682 }
2683 iter = HvAUX(hv); /* may been realloced */
2684 iter->xhv_last_rand = iter->xhv_rand;
2685 }
2686 #endif
2688 /* Skip the entire loop if the hash is empty. */
2689 if ((flags & HV_ITERNEXT_WANTPLACEHOLDERS)
2690 ? HvTOTALKEYS(hv) : HvUSEDKEYS(hv)) {
2691 while (!entry) {
2692 /* OK. Come to the end of the current list. Grab the next one. */
2694 iter->xhv_riter++; /* HvRITER(hv)++ */
2695 if (iter->xhv_riter > (I32)xhv->xhv_max /* HvRITER(hv) > HvMAX(hv) */) {
2696 /* There is no next one. End of the hash. */
2697 iter->xhv_riter = -1; /* HvRITER(hv) = -1 */
2698 #ifdef PERL_HASH_RANDOMIZE_KEYS
2699 iter->xhv_last_rand = iter->xhv_rand; /* reset xhv_last_rand so we can detect inserts during traversal */
2700 #endif
2701 break;
2702 }
2703 entry = (HvARRAY(hv))[ PERL_HASH_ITER_BUCKET(iter) & xhv->xhv_max ];
2705 if (!(flags & HV_ITERNEXT_WANTPLACEHOLDERS)) {
2706 /* If we have an entry, but it's a placeholder, don't count it.
2707 Try the next. */
2708 while (entry && HeVAL(entry) == &PL_sv_placeholder)
2709 entry = HeNEXT(entry);
2710 }
2711 /* Will loop again if this linked list starts NULL
2712 (for HV_ITERNEXT_WANTPLACEHOLDERS)
2713 or if we run through it and find only placeholders. */
2714 }
2715 }
2716 else {
2717 iter->xhv_riter = -1;
2718 #ifdef PERL_HASH_RANDOMIZE_KEYS
2719 iter->xhv_last_rand = iter->xhv_rand;
2720 #endif
2721 }
2723 if (oldentry && HvLAZYDEL(hv)) { /* was deleted earlier? */
2724 HvLAZYDEL_off(hv);
2725 hv_free_ent(hv, oldentry);
2726 }
2728 iter = HvAUX(hv); /* may been realloced */
2729 iter->xhv_eiter = entry; /* HvEITER(hv) = entry */
2730 return entry;
2731 }
2733 /*
2734 =for apidoc hv_iterkey
2736 Returns the key from the current position of the hash iterator. See
2737 C<L</hv_iterinit>>.
2739 =cut
2740 */
2742 char *
2743 Perl_hv_iterkey(pTHX_ HE *entry, I32 *retlen)
2744 {
2745 PERL_ARGS_ASSERT_HV_ITERKEY;
2747 if (HeKLEN(entry) == HEf_SVKEY) {
2748 STRLEN len;
2749 char * const p = SvPV(HeKEY_sv(entry), len);
2750 *retlen = len;
2751 return p;
2752 }
2753 else {
2754 *retlen = HeKLEN(entry);
2755 return HeKEY(entry);
2756 }
2757 }
2759 /* unlike hv_iterval(), this always returns a mortal copy of the key */
2760 /*
2761 =for apidoc hv_iterkeysv
2763 Returns the key as an C<SV*> from the current position of the hash
2764 iterator. The return value will always be a mortal copy of the key. Also
2765 see C<L</hv_iterinit>>.
2767 =cut
2768 */
2770 SV *
2771 Perl_hv_iterkeysv(pTHX_ HE *entry)
2772 {
2773 PERL_ARGS_ASSERT_HV_ITERKEYSV;
2775 return sv_2mortal(newSVhek(HeKEY_hek(entry)));
2776 }
2778 /*
2779 =for apidoc hv_iterval
2781 Returns the value from the current position of the hash iterator. See
2782 C<L</hv_iterkey>>.
2784 =cut
2785 */
2787 SV *
2788 Perl_hv_iterval(pTHX_ HV *hv, HE *entry)
2789 {
2790 PERL_ARGS_ASSERT_HV_ITERVAL;
2792 if (SvRMAGICAL(hv)) {
2793 if (mg_find((const SV *)hv, PERL_MAGIC_tied)) {
2794 SV* const sv = sv_newmortal();
2795 if (HeKLEN(entry) == HEf_SVKEY)
2796 mg_copy(MUTABLE_SV(hv), sv, (char*)HeKEY_sv(entry), HEf_SVKEY);
2797 else
2798 mg_copy(MUTABLE_SV(hv), sv, HeKEY(entry), HeKLEN(entry));
2799 return sv;
2800 }
2801 }
2802 return HeVAL(entry);
2803 }
2805 /*
2806 =for apidoc hv_iternextsv
2808 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
2809 operation.
2811 =cut
2812 */
2814 SV *
2815 Perl_hv_iternextsv(pTHX_ HV *hv, char **key, I32 *retlen)
2816 {
2817 HE * const he = hv_iternext_flags(hv, 0);
2819 PERL_ARGS_ASSERT_HV_ITERNEXTSV;
2821 if (!he)
2822 return NULL;
2823 *key = hv_iterkey(he, retlen);
2824 return hv_iterval(hv, he);
2825 }
2827 /*
2829 Now a macro in hv.h
2831 =for apidoc hv_magic
2833 Adds magic to a hash. See C<L</sv_magic>>.
2835 =cut
2836 */
2838 /* possibly free a shared string if no one has access to it
2839 * len and hash must both be valid for str.
2840 */
2841 void
2842 Perl_unsharepvn(pTHX_ const char *str, I32 len, U32 hash)
2843 {
2844 unshare_hek_or_pvn (NULL, str, len, hash);
2845 }
2848 void
2849 Perl_unshare_hek(pTHX_ HEK *hek)
2850 {
2851 assert(hek);
2852 unshare_hek_or_pvn(hek, NULL, 0, 0);
2853 }
2855 /* possibly free a shared string if no one has access to it
2856 hek if non-NULL takes priority over the other 3, else str, len and hash
2857 are used. If so, len and hash must both be valid for str.
2858 */
2859 STATIC void
2860 S_unshare_hek_or_pvn(pTHX_ const HEK *hek, const char *str, I32 len, U32 hash)
2861 {
2862 XPVHV* xhv;
2863 HE *entry;
2864 HE **oentry;
2865 bool is_utf8 = FALSE;
2866 int k_flags = 0;
2867 const char * const save = str;
2868 struct shared_he *he = NULL;
2870 if (hek) {
2871 /* Find the shared he which is just before us in memory. */
2872 he = (struct shared_he *)(((char *)hek)
2873 - STRUCT_OFFSET(struct shared_he,
2874 shared_he_hek));
2876 /* Assert that the caller passed us a genuine (or at least consistent)
2877 shared hek */
2878 assert (he->shared_he_he.hent_hek == hek);
2880 if (he->shared_he_he.he_valu.hent_refcount - 1) {
2881 --he->shared_he_he.he_valu.hent_refcount;
2882 return;
2883 }
2885 hash = HEK_HASH(hek);
2886 } else if (len < 0) {
2887 STRLEN tmplen = -len;
2888 is_utf8 = TRUE;
2889 /* See the note in hv_fetch(). --jhi */
2890 str = (char*)bytes_from_utf8((U8*)str, &tmplen, &is_utf8);
2891 len = tmplen;
2892 if (is_utf8)
2893 k_flags = HVhek_UTF8;
2894 if (str != save)
2895 k_flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
2896 }
2898 /* what follows was the moral equivalent of:
2899 if ((Svp = hv_fetch(PL_strtab, tmpsv, FALSE, hash))) {
2900 if (--*Svp == NULL)
2901 hv_delete(PL_strtab, str, len, G_DISCARD, hash);
2902 } */
2903 xhv = (XPVHV*)SvANY(PL_strtab);
2904 /* assert(xhv_array != 0) */
2905 oentry = &(HvARRAY(PL_strtab))[hash & (I32) HvMAX(PL_strtab)];
2906 if (he) {
2907 const HE *const he_he = &(he->shared_he_he);
2908 for (entry = *oentry; entry; oentry = &HeNEXT(entry), entry = *oentry) {
2909 if (entry == he_he)
2910 break;
2911 }
2912 } else {
2913 const int flags_masked = k_flags & HVhek_MASK;
2914 for (entry = *oentry; entry; oentry = &HeNEXT(entry), entry = *oentry) {
2915 if (HeHASH(entry) != hash) /* strings can't be equal */
2916 continue;
2917 if (HeKLEN(entry) != len)
2918 continue;
2919 if (HeKEY(entry) != str && memNE(HeKEY(entry),str,len)) /* is this it? */
2920 continue;
2921 if (HeKFLAGS(entry) != flags_masked)
2922 continue;
2923 break;
2924 }
2925 }
2927 if (entry) {
2928 if (--entry->he_valu.hent_refcount == 0) {
2929 *oentry = HeNEXT(entry);
2930 Safefree(entry);
2931 xhv->xhv_keys--; /* HvTOTALKEYS(hv)-- */
2932 }
2933 }
2935 if (!entry)
2936 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
2937 "Attempt to free nonexistent shared string '%s'%s"
2938 pTHX__FORMAT,
2939 hek ? HEK_KEY(hek) : str,
2940 ((k_flags & HVhek_UTF8) ? " (utf8)" : "") pTHX__VALUE);
2941 if (k_flags & HVhek_FREEKEY)
2942 Safefree(str);
2943 }
2945 /* get a (constant) string ptr from the global string table
2946 * string will get added if it is not already there.
2947 * len and hash must both be valid for str.
2948 */
2949 HEK *
2950 Perl_share_hek(pTHX_ const char *str, I32 len, U32 hash)
2951 {
2952 bool is_utf8 = FALSE;
2953 int flags = 0;
2954 const char * const save = str;
2956 PERL_ARGS_ASSERT_SHARE_HEK;
2958 if (len < 0) {
2959 STRLEN tmplen = -len;
2960 is_utf8 = TRUE;
2961 /* See the note in hv_fetch(). --jhi */
2962 str = (char*)bytes_from_utf8((U8*)str, &tmplen, &is_utf8);
2963 len = tmplen;
2964 /* If we were able to downgrade here, then than means that we were passed
2965 in a key which only had chars 0-255, but was utf8 encoded. */
2966 if (is_utf8)
2967 flags = HVhek_UTF8;
2968 /* If we found we were able to downgrade the string to bytes, then
2969 we should flag that it needs upgrading on keys or each. Also flag
2970 that we need share_hek_flags to free the string. */
2971 if (str != save) {
2972 dVAR;
2973 PERL_HASH(hash, str, len);
2974 flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
2975 }
2976 }
2978 return share_hek_flags (str, len, hash, flags);
2979 }
2981 STATIC HEK *
2982 S_share_hek_flags(pTHX_ const char *str, I32 len, U32 hash, int flags)
2983 {
2984 HE *entry;
2985 const int flags_masked = flags & HVhek_MASK;
2986 const U32 hindex = hash & (I32) HvMAX(PL_strtab);
2987 XPVHV * const xhv = (XPVHV*)SvANY(PL_strtab);
2989 PERL_ARGS_ASSERT_SHARE_HEK_FLAGS;
2991 /* what follows is the moral equivalent of:
2993 if (!(Svp = hv_fetch(PL_strtab, str, len, FALSE)))
2994 hv_store(PL_strtab, str, len, NULL, hash);
2996 Can't rehash the shared string table, so not sure if it's worth
2997 counting the number of entries in the linked list
2998 */
3000 /* assert(xhv_array != 0) */
3001 entry = (HvARRAY(PL_strtab))[hindex];
3002 for (;entry; entry = HeNEXT(entry)) {
3003 if (HeHASH(entry) != hash) /* strings can't be equal */
3004 continue;
3005 if (HeKLEN(entry) != len)
3006 continue;
3007 if (HeKEY(entry) != str && memNE(HeKEY(entry),str,len)) /* is this it? */
3008 continue;
3009 if (HeKFLAGS(entry) != flags_masked)
3010 continue;
3011 break;
3012 }
3014 if (!entry) {
3015 /* What used to be head of the list.
3016 If this is NULL, then we're the first entry for this slot, which
3017 means we need to increate fill. */
3018 struct shared_he *new_entry;
3019 HEK *hek;
3020 char *k;
3021 HE **const head = &HvARRAY(PL_strtab)[hindex];
3022 HE *const next = *head;
3024 /* We don't actually store a HE from the arena and a regular HEK.
3025 Instead we allocate one chunk of memory big enough for both,
3026 and put the HEK straight after the HE. This way we can find the
3027 HE directly from the HEK.
3028 */
3030 Newx(k, STRUCT_OFFSET(struct shared_he,
3031 shared_he_hek.hek_key[0]) + len + 2, char);
3032 new_entry = (struct shared_he *)k;
3033 entry = &(new_entry->shared_he_he);
3034 hek = &(new_entry->shared_he_hek);
3036 Copy(str, HEK_KEY(hek), len, char);
3037 HEK_KEY(hek)[len] = 0;
3038 HEK_LEN(hek) = len;
3039 HEK_HASH(hek) = hash;
3040 HEK_FLAGS(hek) = (unsigned char)flags_masked;
3042 /* Still "point" to the HEK, so that other code need not know what
3043 we're up to. */
3044 HeKEY_hek(entry) = hek;
3045 entry->he_valu.hent_refcount = 0;
3046 HeNEXT(entry) = next;
3047 *head = entry;
3049 xhv->xhv_keys++; /* HvTOTALKEYS(hv)++ */
3050 if (!next) { /* initial entry? */
3051 } else if ( DO_HSPLIT(xhv) ) {
3052 const STRLEN oldsize = xhv->xhv_max + 1;
3053 hsplit(PL_strtab, oldsize, oldsize * 2);
3054 }
3055 }
3057 ++entry->he_valu.hent_refcount;
3059 if (flags & HVhek_FREEKEY)
3060 Safefree(str);
3062 return HeKEY_hek(entry);
3063 }
3065 SSize_t *
3066 Perl_hv_placeholders_p(pTHX_ HV *hv)
3067 {
3068 MAGIC *mg = mg_find((const SV *)hv, PERL_MAGIC_rhash);
3070 PERL_ARGS_ASSERT_HV_PLACEHOLDERS_P;
3072 if (!mg) {
3073 mg = sv_magicext(MUTABLE_SV(hv), 0, PERL_MAGIC_rhash, 0, 0, 0);
3075 if (!mg) {
3076 Perl_die(aTHX_ "panic: hv_placeholders_p");
3077 }
3078 }
3079 return &(mg->mg_len);
3080 }
3083 I32
3084 Perl_hv_placeholders_get(pTHX_ const HV *hv)
3085 {
3086 MAGIC * const mg = mg_find((const SV *)hv, PERL_MAGIC_rhash);
3088 PERL_ARGS_ASSERT_HV_PLACEHOLDERS_GET;
3089 PERL_UNUSED_CONTEXT;
3091 return mg ? mg->mg_len : 0;
3092 }
3094 void
3095 Perl_hv_placeholders_set(pTHX_ HV *hv, I32 ph)
3096 {
3097 MAGIC * const mg = mg_find((const SV *)hv, PERL_MAGIC_rhash);
3099 PERL_ARGS_ASSERT_HV_PLACEHOLDERS_SET;
3101 if (mg) {
3102 mg->mg_len = ph;
3103 } else if (ph) {
3104 if (!sv_magicext(MUTABLE_SV(hv), 0, PERL_MAGIC_rhash, 0, 0, ph))
3105 Perl_die(aTHX_ "panic: hv_placeholders_set");
3106 }
3107 /* else we don't need to add magic to record 0 placeholders. */
3108 }
3110 STATIC SV *
3111 S_refcounted_he_value(pTHX_ const struct refcounted_he *he)
3112 {
3113 dVAR;
3114 SV *value;
3116 PERL_ARGS_ASSERT_REFCOUNTED_HE_VALUE;
3118 switch(he->refcounted_he_data[0] & HVrhek_typemask) {
3119 case HVrhek_undef:
3120 value = newSV(0);
3121 break;
3122 case HVrhek_delete:
3123 value = &PL_sv_placeholder;
3124 break;
3125 case HVrhek_IV:
3126 value = newSViv(he->refcounted_he_val.refcounted_he_u_iv);
3127 break;
3128 case HVrhek_UV:
3129 value = newSVuv(he->refcounted_he_val.refcounted_he_u_uv);
3130 break;
3131 case HVrhek_PV:
3132 case HVrhek_PV_UTF8:
3133 /* Create a string SV that directly points to the bytes in our
3134 structure. */
3135 value = newSV_type(SVt_PV);
3136 SvPV_set(value, (char *) he->refcounted_he_data + 1);
3137 SvCUR_set(value, he->refcounted_he_val.refcounted_he_u_len);
3138 /* This stops anything trying to free it */
3139 SvLEN_set(value, 0);
3140 SvPOK_on(value);
3141 SvREADONLY_on(value);
3142 if ((he->refcounted_he_data[0] & HVrhek_typemask) == HVrhek_PV_UTF8)
3143 SvUTF8_on(value);
3144 break;
3145 default:
3146 Perl_croak(aTHX_ "panic: refcounted_he_value bad flags %" UVxf,
3147 (UV)he->refcounted_he_data[0]);
3148 }
3149 return value;
3150 }
3152 /*
3153 =for apidoc m|HV *|refcounted_he_chain_2hv|const struct refcounted_he *c|U32 flags
3155 Generates and returns a C<HV *> representing the content of a
3156 C<refcounted_he> chain.
3157 C<flags> is currently unused and must be zero.
3159 =cut
3160 */
3161 HV *
3162 Perl_refcounted_he_chain_2hv(pTHX_ const struct refcounted_he *chain, U32 flags)
3163 {
3164 dVAR;
3165 HV *hv;
3166 U32 placeholders, max;
3168 if (flags)
3169 Perl_croak(aTHX_ "panic: refcounted_he_chain_2hv bad flags %" UVxf,
3170 (UV)flags);
3172 /* We could chase the chain once to get an idea of the number of keys,
3173 and call ksplit. But for now we'll make a potentially inefficient
3174 hash with only 8 entries in its array. */
3175 hv = newHV();
3176 max = HvMAX(hv);
3177 if (!HvARRAY(hv)) {
3178 char *array;
3179 Newxz(array, PERL_HV_ARRAY_ALLOC_BYTES(max + 1), char);
3180 HvARRAY(hv) = (HE**)array;
3181 }
3183 placeholders = 0;
3184 while (chain) {
3185 #ifdef USE_ITHREADS
3186 U32 hash = chain->refcounted_he_hash;
3187 #else
3188 U32 hash = HEK_HASH(chain->refcounted_he_hek);
3189 #endif
3190 HE **oentry = &((HvARRAY(hv))[hash & max]);
3191 HE *entry = *oentry;
3192 SV *value;
3194 for (; entry; entry = HeNEXT(entry)) {
3195 if (HeHASH(entry) == hash) {
3196 /* We might have a duplicate key here. If so, entry is older
3197 than the key we've already put in the hash, so if they are
3198 the same, skip adding entry. */
3199 #ifdef USE_ITHREADS
3200 const STRLEN klen = HeKLEN(entry);
3201 const char *const key = HeKEY(entry);
3202 if (klen == chain->refcounted_he_keylen
3203 && (!!HeKUTF8(entry)
3204 == !!(chain->refcounted_he_data[0] & HVhek_UTF8))
3205 && memEQ(key, REF_HE_KEY(chain), klen))
3206 goto next_please;
3207 #else
3208 if (HeKEY_hek(entry) == chain->refcounted_he_hek)
3209 goto next_please;
3210 if (HeKLEN(entry) == HEK_LEN(chain->refcounted_he_hek)
3211 && HeKUTF8(entry) == HEK_UTF8(chain->refcounted_he_hek)
3212 && memEQ(HeKEY(entry), HEK_KEY(chain->refcounted_he_hek),
3213 HeKLEN(entry)))
3214 goto next_please;
3215 #endif
3216 }
3217 }
3218 assert (!entry);
3219 entry = new_HE();
3221 #ifdef USE_ITHREADS
3222 HeKEY_hek(entry)
3223 = share_hek_flags(REF_HE_KEY(chain),
3224 chain->refcounted_he_keylen,
3225 chain->refcounted_he_hash,
3226 (chain->refcounted_he_data[0]
3227 & (HVhek_UTF8|HVhek_WASUTF8)));
3228 #else
3229 HeKEY_hek(entry) = share_hek_hek(chain->refcounted_he_hek);
3230 #endif
3231 value = refcounted_he_value(chain);
3232 if (value == &PL_sv_placeholder)
3233 placeholders++;
3234 HeVAL(entry) = value;
3236 /* Link it into the chain. */
3237 HeNEXT(entry) = *oentry;
3238 *oentry = entry;
3240 HvTOTALKEYS(hv)++;
3242 next_please:
3243 chain = chain->refcounted_he_next;
3244 }
3246 if (placeholders) {
3247 clear_placeholders(hv, placeholders);
3248 HvTOTALKEYS(hv) -= placeholders;
3249 }
3251 /* We could check in the loop to see if we encounter any keys with key
3252 flags, but it's probably not worth it, as this per-hash flag is only
3253 really meant as an optimisation for things like Storable. */
3254 HvHASKFLAGS_on(hv);
3255 DEBUG_A(Perl_hv_assert(aTHX_ hv));
3257 return hv;
3258 }
3260 /*
3261 =for apidoc m|SV *|refcounted_he_fetch_pvn|const struct refcounted_he *chain|const char *keypv|STRLEN keylen|U32 hash|U32 flags
3263 Search along a C<refcounted_he> chain for an entry with the key specified
3264 by C<keypv> and C<keylen>. If C<flags> has the C<REFCOUNTED_HE_KEY_UTF8>
3265 bit set, the key octets are interpreted as UTF-8, otherwise they
3266 are interpreted as Latin-1. C<hash> is a precomputed hash of the key
3267 string, or zero if it has not been precomputed. Returns a mortal scalar
3268 representing the value associated with the key, or C<&PL_sv_placeholder>
3269 if there is no value associated with the key.
3271 =cut
3272 */
3274 SV *
3275 Perl_refcounted_he_fetch_pvn(pTHX_ const struct refcounted_he *chain,
3276 const char *keypv, STRLEN keylen, U32 hash, U32 flags)
3277 {
3278 dVAR;
3279 U8 utf8_flag;
3280 PERL_ARGS_ASSERT_REFCOUNTED_HE_FETCH_PVN;
3282 if (flags & ~(REFCOUNTED_HE_KEY_UTF8|REFCOUNTED_HE_EXISTS))
3283 Perl_croak(aTHX_ "panic: refcounted_he_fetch_pvn bad flags %" UVxf,
3284 (UV)flags);
3285 if (!chain)
3286 goto ret;
3287 if (flags & REFCOUNTED_HE_KEY_UTF8) {
3288 /* For searching purposes, canonicalise to Latin-1 where possible. */
3289 const char *keyend = keypv + keylen, *p;
3290 STRLEN nonascii_count = 0;
3291 for (p = keypv; p != keyend; p++) {
3292 if (! UTF8_IS_INVARIANT(*p)) {
3293 if (! UTF8_IS_NEXT_CHAR_DOWNGRADEABLE(p, keyend)) {
3294 goto canonicalised_key;
3295 }
3296 nonascii_count++;
3297 p++;
3298 }
3299 }
3300 if (nonascii_count) {
3301 char *q;
3302 const char *p = keypv, *keyend = keypv + keylen;
3303 keylen -= nonascii_count;
3304 Newx(q, keylen, char);
3305 SAVEFREEPV(q);
3306 keypv = q;
3307 for (; p != keyend; p++, q++) {
3308 U8 c = (U8)*p;
3309 if (UTF8_IS_INVARIANT(c)) {
3310 *q = (char) c;
3311 }
3312 else {
3313 p++;
3314 *q = (char) EIGHT_BIT_UTF8_TO_NATIVE(c, *p);
3315 }
3316 }
3317 }
3318 flags &= ~REFCOUNTED_HE_KEY_UTF8;
3319 canonicalised_key: ;
3320 }
3321 utf8_flag = (flags & REFCOUNTED_HE_KEY_UTF8) ? HVhek_UTF8 : 0;
3322 if (!hash)
3323 PERL_HASH(hash, keypv, keylen);
3325 for (; chain; chain = chain->refcounted_he_next) {
3326 if (
3327 #ifdef USE_ITHREADS
3328 hash == chain->refcounted_he_hash &&
3329 keylen == chain->refcounted_he_keylen &&
3330 memEQ(REF_HE_KEY(chain), keypv, keylen) &&
3331 utf8_flag == (chain->refcounted_he_data[0] & HVhek_UTF8)
3332 #else
3333 hash == HEK_HASH(chain->refcounted_he_hek) &&
3334 keylen == (STRLEN)HEK_LEN(chain->refcounted_he_hek) &&
3335 memEQ(HEK_KEY(chain->refcounted_he_hek), keypv, keylen) &&
3336 utf8_flag == (HEK_FLAGS(chain->refcounted_he_hek) & HVhek_UTF8)
3337 #endif
3338 ) {
3339 if (flags & REFCOUNTED_HE_EXISTS)
3340 return (chain->refcounted_he_data[0] & HVrhek_typemask)
3341 == HVrhek_delete
3342 ? NULL : &PL_sv_yes;
3343 return sv_2mortal(refcounted_he_value(chain));
3344 }
3345 }
3346 ret:
3347 return flags & REFCOUNTED_HE_EXISTS ? NULL : &PL_sv_placeholder;
3348 }
3350 /*
3351 =for apidoc m|SV *|refcounted_he_fetch_pv|const struct refcounted_he *chain|const char *key|U32 hash|U32 flags
3353 Like L</refcounted_he_fetch_pvn>, but takes a nul-terminated string
3354 instead of a string/length pair.
3356 =cut
3357 */
3359 SV *
3360 Perl_refcounted_he_fetch_pv(pTHX_ const struct refcounted_he *chain,
3361 const char *key, U32 hash, U32 flags)
3362 {
3363 PERL_ARGS_ASSERT_REFCOUNTED_HE_FETCH_PV;
3364 return refcounted_he_fetch_pvn(chain, key, strlen(key), hash, flags);
3365 }
3367 /*
3368 =for apidoc m|SV *|refcounted_he_fetch_sv|const struct refcounted_he *chain|SV *key|U32 hash|U32 flags
3370 Like L</refcounted_he_fetch_pvn>, but takes a Perl scalar instead of a
3371 string/length pair.
3373 =cut
3374 */
3376 SV *
3377 Perl_refcounted_he_fetch_sv(pTHX_ const struct refcounted_he *chain,
3378 SV *key, U32 hash, U32 flags)
3379 {
3380 const char *keypv;
3381 STRLEN keylen;
3382 PERL_ARGS_ASSERT_REFCOUNTED_HE_FETCH_SV;
3383 if (flags & REFCOUNTED_HE_KEY_UTF8)
3384 Perl_croak(aTHX_ "panic: refcounted_he_fetch_sv bad flags %" UVxf,
3385 (UV)flags);
3386 keypv = SvPV_const(key, keylen);
3387 if (SvUTF8(key))
3388 flags |= REFCOUNTED_HE_KEY_UTF8;
3389 if (!hash && SvIsCOW_shared_hash(key))
3390 hash = SvSHARED_HASH(key);
3391 return refcounted_he_fetch_pvn(chain, keypv, keylen, hash, flags);
3392 }
3394 /*
3395 =for apidoc m|struct refcounted_he *|refcounted_he_new_pvn|struct refcounted_he *parent|const char *keypv|STRLEN keylen|U32 hash|SV *value|U32 flags
3397 Creates a new C<refcounted_he>. This consists of a single key/value
3398 pair and a reference to an existing C<refcounted_he> chain (which may
3399 be empty), and thus forms a longer chain. When using the longer chain,
3400 the new key/value pair takes precedence over any entry for the same key
3401 further along the chain.
3403 The new key is specified by C<keypv> and C<keylen>. If C<flags> has
3404 the C<REFCOUNTED_HE_KEY_UTF8> bit set, the key octets are interpreted
3405 as UTF-8, otherwise they are interpreted as Latin-1. C<hash> is
3406 a precomputed hash of the key string, or zero if it has not been
3407 precomputed.
3409 C<value> is the scalar value to store for this key. C<value> is copied
3410 by this function, which thus does not take ownership of any reference
3411 to it, and later changes to the scalar will not be reflected in the
3412 value visible in the C<refcounted_he>. Complex types of scalar will not
3413 be stored with referential integrity, but will be coerced to strings.
3414 C<value> may be either null or C<&PL_sv_placeholder> to indicate that no
3415 value is to be associated with the key; this, as with any non-null value,
3416 takes precedence over the existence of a value for the key further along
3417 the chain.
3419 C<parent> points to the rest of the C<refcounted_he> chain to be
3420 attached to the new C<refcounted_he>. This function takes ownership
3421 of one reference to C<parent>, and returns one reference to the new
3422 C<refcounted_he>.
3424 =cut
3425 */
3427 struct refcounted_he *
3428 Perl_refcounted_he_new_pvn(pTHX_ struct refcounted_he *parent,
3429 const char *keypv, STRLEN keylen, U32 hash, SV *value, U32 flags)
3430 {
3431 dVAR;
3432 STRLEN value_len = 0;
3433 const char *value_p = NULL;
3434 bool is_pv;
3435 char value_type;
3436 char hekflags;
3437 STRLEN key_offset = 1;
3438 struct refcounted_he *he;
3439 PERL_ARGS_ASSERT_REFCOUNTED_HE_NEW_PVN;
3441 if (!value || value == &PL_sv_placeholder) {
3442 value_type = HVrhek_delete;
3443 } else if (SvPOK(value)) {
3444 value_type = HVrhek_PV;
3445 } else if (SvIOK(value)) {
3446 value_type = SvUOK((const SV *)value) ? HVrhek_UV : HVrhek_IV;
3447 } else if (!SvOK(value)) {
3448 value_type = HVrhek_undef;
3449 } else {
3450 value_type = HVrhek_PV;
3451 }
3452 is_pv = value_type == HVrhek_PV;
3453 if (is_pv) {
3454 /* Do it this way so that the SvUTF8() test is after the SvPV, in case
3455 the value is overloaded, and doesn't yet have the UTF-8flag set. */
3456 value_p = SvPV_const(value, value_len);
3457 if (SvUTF8(value))
3458 value_type = HVrhek_PV_UTF8;
3459 key_offset = value_len + 2;
3460 }
3461 hekflags = value_type;
3463 if (flags & REFCOUNTED_HE_KEY_UTF8) {
3464 /* Canonicalise to Latin-1 where possible. */
3465 const char *keyend = keypv + keylen, *p;
3466 STRLEN nonascii_count = 0;
3467 for (p = keypv; p != keyend; p++) {
3468 if (! UTF8_IS_INVARIANT(*p)) {
3469 if (! UTF8_IS_NEXT_CHAR_DOWNGRADEABLE(p, keyend)) {
3470 goto canonicalised_key;
3471 }
3472 nonascii_count++;
3473 p++;
3474 }
3475 }
3476 if (nonascii_count) {
3477 char *q;
3478 const char *p = keypv, *keyend = keypv + keylen;
3479 keylen -= nonascii_count;
3480 Newx(q, keylen, char);
3481 SAVEFREEPV(q);
3482 keypv = q;
3483 for (; p != keyend; p++, q++) {
3484 U8 c = (U8)*p;
3485 if (UTF8_IS_INVARIANT(c)) {
3486 *q = (char) c;
3487 }
3488 else {
3489 p++;
3490 *q = (char) EIGHT_BIT_UTF8_TO_NATIVE(c, *p);
3491 }
3492 }
3493 }
3494 flags &= ~REFCOUNTED_HE_KEY_UTF8;
3495 canonicalised_key: ;
3496 }
3497 if (flags & REFCOUNTED_HE_KEY_UTF8)
3498 hekflags |= HVhek_UTF8;
3499 if (!hash)
3500 PERL_HASH(hash, keypv, keylen);
3502 #ifdef USE_ITHREADS
3503 he = (struct refcounted_he*)
3504 PerlMemShared_malloc(sizeof(struct refcounted_he) - 1
3505 + keylen
3506 + key_offset);
3507 #else
3508 he = (struct refcounted_he*)
3509 PerlMemShared_malloc(sizeof(struct refcounted_he) - 1
3510 + key_offset);
3511 #endif
3513 he->refcounted_he_next = parent;
3515 if (is_pv) {
3516 Copy(value_p, he->refcounted_he_data + 1, value_len + 1, char);
3517 he->refcounted_he_val.refcounted_he_u_len = value_len;
3518 } else if (value_type == HVrhek_IV) {
3519 he->refcounted_he_val.refcounted_he_u_iv = SvIVX(value);
3520 } else if (value_type == HVrhek_UV) {
3521 he->refcounted_he_val.refcounted_he_u_uv = SvUVX(value);
3522 }
3524 #ifdef USE_ITHREADS
3525 he->refcounted_he_hash = hash;
3526 he->refcounted_he_keylen = keylen;
3527 Copy(keypv, he->refcounted_he_data + key_offset, keylen, char);
3528 #else
3529 he->refcounted_he_hek = share_hek_flags(keypv, keylen, hash, hekflags);
3530 #endif
3532 he->refcounted_he_data[0] = hekflags;
3533 he->refcounted_he_refcnt = 1;
3535 return he;
3536 }
3538 /*
3539 =for apidoc m|struct refcounted_he *|refcounted_he_new_pv|struct refcounted_he *parent|const char *key|U32 hash|SV *value|U32 flags
3541 Like L</refcounted_he_new_pvn>, but takes a nul-terminated string instead
3542 of a string/length pair.
3544 =cut
3545 */
3547 struct refcounted_he *
3548 Perl_refcounted_he_new_pv(pTHX_ struct refcounted_he *parent,
3549 const char *key, U32 hash, SV *value, U32 flags)
3550 {
3551 PERL_ARGS_ASSERT_REFCOUNTED_HE_NEW_PV;
3552 return refcounted_he_new_pvn(parent, key, strlen(key), hash, value, flags);
3553 }
3555 /*
3556 =for apidoc m|struct refcounted_he *|refcounted_he_new_sv|struct refcounted_he *parent|SV *key|U32 hash|SV *value|U32 flags
3558 Like L</refcounted_he_new_pvn>, but takes a Perl scalar instead of a
3559 string/length pair.
3561 =cut
3562 */
3564 struct refcounted_he *
3565 Perl_refcounted_he_new_sv(pTHX_ struct refcounted_he *parent,
3566 SV *key, U32 hash, SV *value, U32 flags)
3567 {
3568 const char *keypv;
3569 STRLEN keylen;
3570 PERL_ARGS_ASSERT_REFCOUNTED_HE_NEW_SV;
3571 if (flags & REFCOUNTED_HE_KEY_UTF8)
3572 Perl_croak(aTHX_ "panic: refcounted_he_new_sv bad flags %" UVxf,
3573 (UV)flags);
3574 keypv = SvPV_const(key, keylen);
3575 if (SvUTF8(key))
3576 flags |= REFCOUNTED_HE_KEY_UTF8;
3577 if (!hash && SvIsCOW_shared_hash(key))
3578 hash = SvSHARED_HASH(key);
3579 return refcounted_he_new_pvn(parent, keypv, keylen, hash, value, flags);
3580 }
3582 /*
3583 =for apidoc m|void|refcounted_he_free|struct refcounted_he *he
3585 Decrements the reference count of a C<refcounted_he> by one. If the
3586 reference count reaches zero the structure's memory is freed, which
3587 (recursively) causes a reduction of its parent C<refcounted_he>'s
3588 reference count. It is safe to pass a null pointer to this function:
3589 no action occurs in this case.
3591 =cut
3592 */
3594 void
3595 Perl_refcounted_he_free(pTHX_ struct refcounted_he *he) {
3596 #ifdef USE_ITHREADS
3597 dVAR;
3598 #endif
3599 PERL_UNUSED_CONTEXT;
3601 while (he) {
3602 struct refcounted_he *copy;
3603 U32 new_count;
3605 HINTS_REFCNT_LOCK;
3606 new_count = --he->refcounted_he_refcnt;
3607 HINTS_REFCNT_UNLOCK;
3609 if (new_count) {
3610 return;
3611 }
3613 #ifndef USE_ITHREADS
3614 unshare_hek_or_pvn (he->refcounted_he_hek, 0, 0, 0);
3615 #endif
3616 copy = he;
3617 he = he->refcounted_he_next;
3618 PerlMemShared_free(copy);
3619 }
3620 }
3622 /*
3623 =for apidoc m|struct refcounted_he *|refcounted_he_inc|struct refcounted_he *he
3625 Increment the reference count of a C<refcounted_he>. The pointer to the
3626 C<refcounted_he> is also returned. It is safe to pass a null pointer
3627 to this function: no action occurs and a null pointer is returned.
3629 =cut
3630 */
3632 struct refcounted_he *
3633 Perl_refcounted_he_inc(pTHX_ struct refcounted_he *he)
3634 {
3635 #ifdef USE_ITHREADS
3636 dVAR;
3637 #endif
3638 PERL_UNUSED_CONTEXT;
3639 if (he) {
3640 HINTS_REFCNT_LOCK;
3641 he->refcounted_he_refcnt++;
3642 HINTS_REFCNT_UNLOCK;
3643 }
3644 return he;
3645 }
3647 /*
3648 =for apidoc cop_fetch_label
3650 Returns the label attached to a cop.
3651 The flags pointer may be set to C<SVf_UTF8> or 0.
3653 =cut
3654 */
3656 /* pp_entereval is aware that labels are stored with a key ':' at the top of
3657 the linked list. */
3658 const char *
3659 Perl_cop_fetch_label(pTHX_ COP *const cop, STRLEN *len, U32 *flags) {
3660 struct refcounted_he *const chain = cop->cop_hints_hash;
3662 PERL_ARGS_ASSERT_COP_FETCH_LABEL;
3663 PERL_UNUSED_CONTEXT;
3665 if (!chain)
3666 return NULL;
3667 #ifdef USE_ITHREADS
3668 if (chain->refcounted_he_keylen != 1)
3669 return NULL;
3670 if (*REF_HE_KEY(chain) != ':')
3671 return NULL;
3672 #else
3673 if ((STRLEN)HEK_LEN(chain->refcounted_he_hek) != 1)
3674 return NULL;
3675 if (*HEK_KEY(chain->refcounted_he_hek) != ':')
3676 return NULL;
3677 #endif
3678 /* Stop anyone trying to really mess us up by adding their own value for
3679 ':' into %^H */
3680 if ((chain->refcounted_he_data[0] & HVrhek_typemask) != HVrhek_PV
3681 && (chain->refcounted_he_data[0] & HVrhek_typemask) != HVrhek_PV_UTF8)
3682 return NULL;
3684 if (len)
3685 *len = chain->refcounted_he_val.refcounted_he_u_len;
3686 if (flags) {
3687 *flags = ((chain->refcounted_he_data[0] & HVrhek_typemask)
3688 == HVrhek_PV_UTF8) ? SVf_UTF8 : 0;
3689 }
3690 return chain->refcounted_he_data + 1;
3691 }
3693 /*
3694 =for apidoc cop_store_label
3696 Save a label into a C<cop_hints_hash>.
3697 You need to set flags to C<SVf_UTF8>
3698 for a UTF-8 label.
3700 =cut
3701 */
3703 void
3704 Perl_cop_store_label(pTHX_ COP *const cop, const char *label, STRLEN len,
3705 U32 flags)
3706 {
3707 SV *labelsv;
3708 PERL_ARGS_ASSERT_COP_STORE_LABEL;
3710 if (flags & ~(SVf_UTF8))
3711 Perl_croak(aTHX_ "panic: cop_store_label illegal flag bits 0x%" UVxf,
3712 (UV)flags);
3713 labelsv = newSVpvn_flags(label, len, SVs_TEMP);
3714 if (flags & SVf_UTF8)
3715 SvUTF8_on(labelsv);
3716 cop->cop_hints_hash
3717 = refcounted_he_new_pvs(cop->cop_hints_hash, ":", labelsv, 0);
3718 }
3720 /*
3721 =for apidoc hv_assert
3723 Check that a hash is in an internally consistent state.
3725 =cut
3726 */
3728 #ifdef DEBUGGING
3730 void
3731 Perl_hv_assert(pTHX_ HV *hv)
3732 {
3733 dVAR;
3734 HE* entry;
3735 int withflags = 0;
3736 int placeholders = 0;
3737 int real = 0;
3738 int bad = 0;
3739 const I32 riter = HvRITER_get(hv);
3740 HE *eiter = HvEITER_get(hv);
3742 PERL_ARGS_ASSERT_HV_ASSERT;
3744 (void)hv_iterinit(hv);
3746 while ((entry = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS))) {
3747 /* sanity check the values */
3748 if (HeVAL(entry) == &PL_sv_placeholder)
3749 placeholders++;
3750 else
3751 real++;
3752 /* sanity check the keys */
3753 if (HeSVKEY(entry)) {
3754 NOOP; /* Don't know what to check on SV keys. */
3755 } else if (HeKUTF8(entry)) {
3756 withflags++;
3757 if (HeKWASUTF8(entry)) {
3758 PerlIO_printf(Perl_debug_log,
3759 "hash key has both WASUTF8 and UTF8: '%.*s'\n",
3760 (int) HeKLEN(entry), HeKEY(entry));
3761 bad = 1;
3762 }
3763 } else if (HeKWASUTF8(entry))
3764 withflags++;
3765 }
3766 if (!SvTIED_mg((const SV *)hv, PERL_MAGIC_tied)) {
3767 static const char bad_count[] = "Count %d %s(s), but hash reports %d\n";
3768 const int nhashkeys = HvUSEDKEYS(hv);
3769 const int nhashplaceholders = HvPLACEHOLDERS_get(hv);
3771 if (nhashkeys != real) {
3772 PerlIO_printf(Perl_debug_log, bad_count, real, "keys", nhashkeys );
3773 bad = 1;
3774 }
3775 if (nhashplaceholders != placeholders) {
3776 PerlIO_printf(Perl_debug_log, bad_count, placeholders, "placeholder", nhashplaceholders );
3777 bad = 1;
3778 }
3779 }
3780 if (withflags && ! HvHASKFLAGS(hv)) {
3781 PerlIO_printf(Perl_debug_log,
3782 "Hash has HASKFLAGS off but I count %d key(s) with flags\n",
3783 withflags);
3784 bad = 1;
3785 }
3786 if (bad) {
3787 sv_dump(MUTABLE_SV(hv));
3788 }
3789 HvRITER_set(hv, riter); /* Restore hash iterator state */
3790 HvEITER_set(hv, eiter);
3791 }
3793 #endif
3795 /*
3796 * ex: set ts=8 sts=4 sw=4 et:
3797 */