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