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