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