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