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