hv.c

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