hv.c

   1 /*    hv.c
   2  *
   3  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
   4  *    2000, 2001, 2002, 2003, 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
  19 #include "EXTERN.h"
  20 #define PERL_IN_HV_C
  21 #define PERL_HASH_INTERNAL_ACCESS
  22 #include "perl.h"
  23
  24 #define HV_MAX_LENGTH_BEFORE_SPLIT 14
  25
  26 STATIC HE*
  27 S_new_he(pTHX)
  28 {
  29     HE* he;
  30     LOCK_SV_MUTEX;
  31     if (!PL_he_root)
  32         more_he();
  33     he = PL_he_root;
  34     PL_he_root = HeNEXT(he);
  35     UNLOCK_SV_MUTEX;
  36     return he;
  37 }
  38
  39 STATIC void
  40 S_del_he(pTHX_ HE *p)
  41 {
  42     LOCK_SV_MUTEX;
  43     HeNEXT(p) = (HE*)PL_he_root;
  44     PL_he_root = p;
  45     UNLOCK_SV_MUTEX;
  46 }
  47
  48 STATIC void
  49 S_more_he(pTHX)
  50 {
  51     register HE* he;
  52     register HE* heend;
  53     XPV *ptr;
  54     New(54, ptr, 1008/sizeof(XPV), XPV);
  55     ptr->xpv_pv = (char*)PL_he_arenaroot;
  56     PL_he_arenaroot = ptr;
  57
  58     he = (HE*)ptr;
  59     heend = &he[1008 / sizeof(HE) - 1];
  60     PL_he_root = ++he;
  61     while (he < heend) {
  62         HeNEXT(he) = (HE*)(he + 1);
  63         he++;
  64     }
  65     HeNEXT(he) = 0;
  66 }
  67
  68 #ifdef PURIFY
  69
  70 #define new_HE() (HE*)safemalloc(sizeof(HE))
  71 #define del_HE(p) safefree((char*)p)
  72
  73 #else
  74
  75 #define new_HE() new_he()
  76 #define del_HE(p) del_he(p)
  77
  78 #endif
  79
  80 STATIC HEK *
  81 S_save_hek_flags(pTHX_ const char *str, I32 len, U32 hash, int flags)
  82 {
  83     char *k;
  84     register HEK *hek;
  85
  86     New(54, k, HEK_BASESIZE + len + 2, char);
  87     hek = (HEK*)k;
  88     Copy(str, HEK_KEY(hek), len, char);
  89     HEK_KEY(hek)[len] = 0;
  90     HEK_LEN(hek) = len;
  91     HEK_HASH(hek) = hash;
  92     HEK_FLAGS(hek) = (unsigned char)flags;
  93     return hek;
  94 }
  95
  96 /* free the pool of temporary HE/HEK pairs retunrned by hv_fetch_ent
  97  * for tied hashes */
  98
  99 void
 100 Perl_free_tied_hv_pool(pTHX)
 101 {
 102     HE *ohe;
 103     HE *he = PL_hv_fetch_ent_mh;
 104     while (he) {
 105         Safefree(HeKEY_hek(he));
 106         ohe = he;
 107         he = HeNEXT(he);
 108         del_HE(ohe);
 109     }
 110     PL_hv_fetch_ent_mh = Nullhe;
 111 }
 112
 113 #if defined(USE_ITHREADS)
 114 HE *
 115 Perl_he_dup(pTHX_ HE *e, bool shared, CLONE_PARAMS* param)
 116 {
 117     HE *ret;
 118
 119     if (!e)
 120         return Nullhe;
 121     /* look for it in the table first */
 122     ret = (HE*)ptr_table_fetch(PL_ptr_table, e);
 123     if (ret)
 124         return ret;
 125
 126     /* create anew and remember what it is */
 127     ret = new_HE();
 128     ptr_table_store(PL_ptr_table, e, ret);
 129
 130     HeNEXT(ret) = he_dup(HeNEXT(e),shared, param);
 131     if (HeKLEN(e) == HEf_SVKEY) {
 132         char *k;
 133         New(54, k, HEK_BASESIZE + sizeof(SV*), char);
 134         HeKEY_hek(ret) = (HEK*)k;
 135         HeKEY_sv(ret) = SvREFCNT_inc(sv_dup(HeKEY_sv(e), param));
 136     }
 137     else if (shared)
 138         HeKEY_hek(ret) = share_hek_flags(HeKEY(e), HeKLEN(e), HeHASH(e),
 139                                          HeKFLAGS(e));
 140     else
 141         HeKEY_hek(ret) = save_hek_flags(HeKEY(e), HeKLEN(e), HeHASH(e),
 142                                         HeKFLAGS(e));
 143     HeVAL(ret) = SvREFCNT_inc(sv_dup(HeVAL(e), param));
 144     return ret;
 145 }
 146 #endif  /* USE_ITHREADS */
 147
 148 static void
 149 S_hv_notallowed(pTHX_ int flags, const char *key, I32 klen,
 150                 const char *msg)
 151 {
 152     SV *sv = sv_newmortal(), *esv = sv_newmortal();
 153     if (!(flags & HVhek_FREEKEY)) {
 154         sv_setpvn(sv, key, klen);
 155     }
 156     else {
 157         /* Need to free saved eventually assign to mortal SV */
 158         /* XXX is this line an error ???:  SV *sv = sv_newmortal(); */
 159         sv_usepvn(sv, (char *) key, klen);
 160     }
 161     if (flags & HVhek_UTF8) {
 162         SvUTF8_on(sv);
 163     }
 164     Perl_sv_setpvf(aTHX_ esv, "Attempt to %s a restricted hash", msg);
 165     Perl_croak(aTHX_ SvPVX(esv), sv);
 166 }
 167
 168 /* (klen == HEf_SVKEY) is special for MAGICAL hv entries, meaning key slot
 169  * contains an SV* */
 170
 171 /*
 172 =for apidoc hv_fetch
 173
 174 Returns the SV which corresponds to the specified key in the hash.  The
 175 C<klen> is the length of the key.  If C<lval> is set then the fetch will be
 176 part of a store.  Check that the return value is non-null before
 177 dereferencing it to an C<SV*>.
 178
 179 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
 180 information on how to use this function on tied hashes.
 181
 182 =cut
 183 */
 184
 185 #define HV_FETCH_LVALUE  0x01
 186 #define HV_FETCH_JUST_SV 0x02
 187
 188 SV**
 189 Perl_hv_fetch(pTHX_ HV *hv, const char *key, I32 klen_i32, I32 lval)
 190 {
 191     HE *hek;
 192     STRLEN klen;
 193     int flags;
 194
 195     if (klen_i32 < 0) {
 196         klen = -klen_i32;
 197         flags = HVhek_UTF8;
 198     } else {
 199         klen = klen_i32;
 200         flags = 0;
 201     }
 202     hek = hv_fetch_common (hv, NULL, key, klen, flags,
 203                            HV_FETCH_JUST_SV | (lval ? HV_FETCH_LVALUE : 0), 0);
 204     return hek ? &HeVAL(hek) : NULL;
 205 }
 206
 207 /* returns an HE * structure with the all fields set */
 208 /* note that hent_val will be a mortal sv for MAGICAL hashes */
 209 /*
 210 =for apidoc hv_fetch_ent
 211
 212 Returns the hash entry which corresponds to the specified key in the hash.
 213 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
 214 if you want the function to compute it.  IF C<lval> is set then the fetch
 215 will be part of a store.  Make sure the return value is non-null before
 216 accessing it.  The return value when C<tb> is a tied hash is a pointer to a
 217 static location, so be sure to make a copy of the structure if you need to
 218 store it somewhere.
 219
 220 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
 221 information on how to use this function on tied hashes.
 222
 223 =cut
 224 */
 225
 226 HE *
 227 Perl_hv_fetch_ent(pTHX_ HV *hv, SV *keysv, I32 lval, register U32 hash)
 228 {
 229     return hv_fetch_common(hv, keysv, NULL, 0, 0, lval ? HV_FETCH_LVALUE : 0,
 230                            hash);
 231 }
 232
 233 HE *
 234 S_hv_fetch_common(pTHX_ HV *hv, SV *keysv, const char *key, STRLEN klen,
 235                   int flags, int action, register U32 hash)
 236 {
 237     register XPVHV* xhv;
 238     register HE *entry;
 239     SV *sv;
 240     bool is_utf8;
 241     const char *keysave;
 242     int masked_flags;
 243
 244     if (!hv)
 245         return 0;
 246
 247     if (keysv) {
 248         key = SvPV(keysv, klen);
 249         flags = 0;
 250         is_utf8 = (SvUTF8(keysv) != 0);
 251     } else {
 252         is_utf8 = ((flags & HVhek_UTF8) ? TRUE : FALSE);
 253     }
 254     keysave = key;
 255
 256     if (SvRMAGICAL(hv)) {
 257         if (mg_find((SV*)hv, PERL_MAGIC_tied) || SvGMAGICAL((SV*)hv)) {
 258             sv = sv_newmortal();
 259
 260             /* XXX should be able to skimp on the HE/HEK here when
 261                HV_FETCH_JUST_SV is true.  */
 262
 263             if (!keysv) {
 264                 keysv = newSVpvn(key, klen);
 265                 if (is_utf8) {
 266                     SvUTF8_on(keysv);
 267                 }
 268             } else {
 269                 keysv = newSVsv(keysv);
 270             }
 271             mg_copy((SV*)hv, sv, (char *)keysv, HEf_SVKEY);
 272
 273
 274             /* grab a fake HE/HEK pair from the pool or make a new one */
 275             entry = PL_hv_fetch_ent_mh;
 276             if (entry)
 277                 PL_hv_fetch_ent_mh = HeNEXT(entry);
 278             else {
 279                 char *k;
 280                 entry = new_HE();
 281                 New(54, k, HEK_BASESIZE + sizeof(SV*), char);
 282                 HeKEY_hek(entry) = (HEK*)k;
 283             }
 284             HeNEXT(entry) = Nullhe;
 285             HeSVKEY_set(entry, keysv);
 286             HeVAL(entry) = sv;
 287             sv_upgrade(sv, SVt_PVLV);
 288             LvTYPE(sv) = 'T';
 289             LvTARG(sv) = (SV*)entry; /* so we can free entry when freeing sv */
 290
 291             /* XXX remove at some point? */
 292             if (flags & HVhek_FREEKEY)
 293                 Safefree(key);
 294
 295             return entry;
 296         }
 297 #ifdef ENV_IS_CASELESS
 298         else if (mg_find((SV*)hv, PERL_MAGIC_env)) {
 299             U32 i;
 300             for (i = 0; i < klen; ++i)
 301                 if (isLOWER(key[i])) {
 302                     SV *nkeysv = sv_2mortal(newSVpvn(key,klen));
 303                     (void)strupr(SvPVX(nkeysv));
 304                     entry = hv_fetch_common(hv, nkeysv, NULL, 0, 0, 0);
 305                     if (!entry && (action & HV_FETCH_LVALUE))
 306                         entry = hv_store_ent(hv, keysv, NEWSV(61,0), hash);
 307
 308                     /* XXX remove at some point? */
 309                     if (flags & HVhek_FREEKEY)
 310                         Safefree(key);
 311
 312                     return entry;
 313                 }
 314         }
 315 #endif
 316     }
 317
 318     xhv = (XPVHV*)SvANY(hv);
 319     if (!xhv->xhv_array /* !HvARRAY(hv) */) {
 320         if ((action & HV_FETCH_LVALUE)
 321 #ifdef DYNAMIC_ENV_FETCH  /* if it's an %ENV lookup, we may get it on the fly */
 322                  || (SvRMAGICAL((SV*)hv) && mg_find((SV*)hv, PERL_MAGIC_env))
 323 #endif
 324                                                                   )
 325             Newz(503, xhv->xhv_array /* HvARRAY(hv) */,
 326                  PERL_HV_ARRAY_ALLOC_BYTES(xhv->xhv_max+1 /* HvMAX(hv)+1 */),
 327                  char);
 328         else {
 329             /* XXX remove at some point? */
 330             if (flags & HVhek_FREEKEY)
 331                 Safefree(key);
 332
 333             return 0;
 334         }
 335     }
 336
 337     if (is_utf8) {
 338         int oldflags = flags;
 339         key = (char*)bytes_from_utf8((U8*)key, &klen, &is_utf8);
 340         if (is_utf8)
 341             flags |= HVhek_UTF8;
 342         else
 343             flags &= ~HVhek_UTF8;
 344         if (key != keysave)
 345             flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
 346         if (oldflags & HVhek_FREEKEY)
 347             Safefree(keysave);
 348
 349     }
 350
 351     if (HvREHASH(hv)) {
 352         PERL_HASH_INTERNAL(hash, key, klen);
 353         /* Yes, you do need this even though you are not "storing" because
 354            you can flip the flags below if doing an lval lookup.  (And that
 355            was put in to give the semantics Andreas was expecting.)  */
 356         flags |= HVhek_REHASH;
 357     } else if (!hash) {
 358         if (keysv && (SvIsCOW_shared_hash(keysv))) {
 359             hash = SvUVX(keysv);
 360         } else {
 361             PERL_HASH(hash, key, klen);
 362         }
 363     }
 364
 365     masked_flags = (flags & HVhek_MASK);
 366
 367     /* entry = (HvARRAY(hv))[hash & (I32) HvMAX(hv)]; */
 368     entry = ((HE**)xhv->xhv_array)[hash & (I32) xhv->xhv_max];
 369     for (; entry; entry = HeNEXT(entry)) {
 370         if (HeHASH(entry) != hash)              /* strings can't be equal */
 371             continue;
 372         if (HeKLEN(entry) != (I32)klen)
 373             continue;
 374         if (HeKEY(entry) != key && memNE(HeKEY(entry),key,klen))        /* is this it? */
 375             continue;
 376         if ((HeKFLAGS(entry) ^ masked_flags) & HVhek_UTF8)
 377             continue;
 378         if ((action & HV_FETCH_LVALUE) && HeKFLAGS(entry) != masked_flags) {
 379             /* We match if HVhek_UTF8 bit in our flags and hash key's match.
 380                But if entry was set previously with HVhek_WASUTF8 and key now
 381                doesn't (or vice versa) then we should change the key's flag,
 382                as this is assignment.  */
 383             if (HvSHAREKEYS(hv)) {
 384                 /* Need to swap the key we have for a key with the flags we
 385                    need. As keys are shared we can't just write to the flag,
 386                    so we share the new one, unshare the old one.  */
 387                 HEK *new_hek = share_hek_flags(key, klen, hash, masked_flags);
 388                 unshare_hek (HeKEY_hek(entry));
 389                 HeKEY_hek(entry) = new_hek;
 390             }
 391             else
 392                 HeKFLAGS(entry) = masked_flags;
 393             if (masked_flags & HVhek_ENABLEHVKFLAGS)
 394                 HvHASKFLAGS_on(hv);
 395         }
 396         /* if we find a placeholder, we pretend we haven't found anything */
 397         if (HeVAL(entry) == &PL_sv_placeholder)
 398             break;
 399         if (flags & HVhek_FREEKEY)
 400             Safefree(key);
 401         return entry;
 402     }
 403 #ifdef DYNAMIC_ENV_FETCH  /* %ENV lookup?  If so, try to fetch the value now */
 404     if (SvRMAGICAL((SV*)hv) && mg_find((SV*)hv, PERL_MAGIC_env)) {
 405         unsigned long len;
 406         char *env = PerlEnv_ENVgetenv_len(key,&len);
 407         if (env) {
 408             /* XXX remove once common API complete  */
 409             if (!keysv) {
 410                 nkeysv = sv_2mortal(newSVpvn(key,klen));
 411             }
 412
 413             sv = newSVpvn(env,len);
 414             SvTAINTED_on(sv);
 415             if (flags & HVhek_FREEKEY)
 416                 Safefree(key);
 417             return hv_store_ent(hv,keysv,sv,hash);
 418         }
 419     }
 420 #endif
 421     if (!entry && SvREADONLY(hv)) {
 422         S_hv_notallowed(aTHX_ flags, key, klen,
 423                         "access disallowed key '%"SVf"' in"
 424                         );
 425     }
 426     if (action & HV_FETCH_LVALUE) {
 427         /* XXX remove once common API complete  */
 428         if (!keysv) {
 429             keysv = sv_2mortal(newSVpvn(key,klen));
 430         }
 431     }
 432
 433     if (flags & HVhek_FREEKEY)
 434         Safefree(key);
 435     if (action & HV_FETCH_LVALUE) {
 436         /* gonna assign to this, so it better be there */
 437         sv = NEWSV(61,0);
 438         return hv_store_ent(hv,keysv,sv,hash);
 439     }
 440     return 0;
 441 }
 442
 443 STATIC void
 444 S_hv_magic_check(pTHX_ HV *hv, bool *needs_copy, bool *needs_store)
 445 {
 446     MAGIC *mg = SvMAGIC(hv);
 447     *needs_copy = FALSE;
 448     *needs_store = TRUE;
 449     while (mg) {
 450         if (isUPPER(mg->mg_type)) {
 451             *needs_copy = TRUE;
 452             switch (mg->mg_type) {
 453             case PERL_MAGIC_tied:
 454             case PERL_MAGIC_sig:
 455                 *needs_store = FALSE;
 456             }
 457         }
 458         mg = mg->mg_moremagic;
 459     }
 460 }
 461
 462 /*
 463 =for apidoc hv_store
 464
 465 Stores an SV in a hash.  The hash key is specified as C<key> and C<klen> is
 466 the length of the key.  The C<hash> parameter is the precomputed hash
 467 value; if it is zero then Perl will compute it.  The return value will be
 468 NULL if the operation failed or if the value did not need to be actually
 469 stored within the hash (as in the case of tied hashes).  Otherwise it can
 470 be dereferenced to get the original C<SV*>.  Note that the caller is
 471 responsible for suitably incrementing the reference count of C<val> before
 472 the call, and decrementing it if the function returned NULL.  Effectively
 473 a successful hv_store takes ownership of one reference to C<val>.  This is
 474 usually what you want; a newly created SV has a reference count of one, so
 475 if all your code does is create SVs then store them in a hash, hv_store
 476 will own the only reference to the new SV, and your code doesn't need to do
 477 anything further to tidy up.  hv_store is not implemented as a call to
 478 hv_store_ent, and does not create a temporary SV for the key, so if your
 479 key data is not already in SV form then use hv_store in preference to
 480 hv_store_ent.
 481
 482 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
 483 information on how to use this function on tied hashes.
 484
 485 =cut
 486 */
 487
 488 SV**
 489 Perl_hv_store(pTHX_ HV *hv, const char *key, I32 klen, SV *val, U32 hash)
 490 {
 491     HE *hek = hv_store_common (hv, NULL, key, klen, 0, val, hash);
 492     return hek ? &HeVAL(hek) : NULL;
 493 }
 494
 495 SV**
 496 Perl_hv_store_flags(pTHX_ HV *hv, const char *key, I32 klen, SV *val,
 497                  register U32 hash, int flags)
 498 {
 499     HE *hek = hv_store_common (hv, NULL, key, klen, flags, val, hash);
 500     return hek ? &HeVAL(hek) : NULL;
 501 }
 502
 503 /*
 504 =for apidoc hv_store_ent
 505
 506 Stores C<val> in a hash.  The hash key is specified as C<key>.  The C<hash>
 507 parameter is the precomputed hash value; if it is zero then Perl will
 508 compute it.  The return value is the new hash entry so created.  It will be
 509 NULL if the operation failed or if the value did not need to be actually
 510 stored within the hash (as in the case of tied hashes).  Otherwise the
 511 contents of the return value can be accessed using the C<He?> macros
 512 described here.  Note that the caller is responsible for suitably
 513 incrementing the reference count of C<val> before the call, and
 514 decrementing it if the function returned NULL.  Effectively a successful
 515 hv_store_ent takes ownership of one reference to C<val>.  This is
 516 usually what you want; a newly created SV has a reference count of one, so
 517 if all your code does is create SVs then store them in a hash, hv_store
 518 will own the only reference to the new SV, and your code doesn't need to do
 519 anything further to tidy up.  Note that hv_store_ent only reads the C<key>;
 520 unlike C<val> it does not take ownership of it, so maintaining the correct
 521 reference count on C<key> is entirely the caller's responsibility.  hv_store
 522 is not implemented as a call to hv_store_ent, and does not create a temporary
 523 SV for the key, so if your key data is not already in SV form then use
 524 hv_store in preference to hv_store_ent.
 525
 526 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
 527 information on how to use this function on tied hashes.
 528
 529 =cut
 530 */
 531
 532 HE *
 533 Perl_hv_store_ent(pTHX_ HV *hv, SV *keysv, SV *val, U32 hash)
 534 {
 535   return hv_store_common(hv, keysv, NULL, 0, 0, val, hash);
 536 }
 537
 538 HE *
 539 S_hv_store_common(pTHX_ HV *hv, SV *keysv, const char *key, I32 klen_i32,
 540                   int flags, SV *val, U32 hash)
 541 {
 542     XPVHV* xhv;
 543     STRLEN klen;
 544     U32 n_links;
 545     HE *entry;
 546     HE **oentry;
 547     bool is_utf8;
 548     const char *keysave;
 549
 550     if (!hv)
 551         return 0;
 552
 553     if (keysv) {
 554         key = SvPV(keysv, klen);
 555         is_utf8 = (SvUTF8(keysv) != 0);
 556     } else {
 557         if (klen_i32 < 0) {
 558             klen = -klen_i32;
 559             is_utf8 = TRUE;
 560         } else {
 561             klen = klen_i32;
 562             /* XXX Need to fix this one level out.  */
 563             is_utf8 = (flags & HVhek_UTF8) ? TRUE : FALSE;
 564         }
 565     }
 566     keysave = key;
 567
 568     xhv = (XPVHV*)SvANY(hv);
 569     if (SvMAGICAL(hv)) {
 570         bool needs_copy;
 571         bool needs_store;
 572         hv_magic_check (hv, &needs_copy, &needs_store);
 573         if (needs_copy) {
 574             bool save_taint = PL_tainted;
 575             if (keysv || is_utf8) {
 576                 if (!keysv) {
 577                     keysv = newSVpvn(key, klen);
 578                     SvUTF8_on(keysv);
 579                 }
 580                 if (PL_tainting)
 581                     PL_tainted = SvTAINTED(keysv);
 582                 keysv = sv_2mortal(newSVsv(keysv));
 583                 mg_copy((SV*)hv, val, (char*)keysv, HEf_SVKEY);
 584             } else {
 585                 mg_copy((SV*)hv, val, key, klen);
 586             }
 587
 588             TAINT_IF(save_taint);
 589             if (!xhv->xhv_array /* !HvARRAY(hv) */ && !needs_store) {
 590                 if (flags & HVhek_FREEKEY)
 591                     Safefree(key);
 592                 return Nullhe;
 593             }
 594 #ifdef ENV_IS_CASELESS
 595             else if (mg_find((SV*)hv, PERL_MAGIC_env)) {
 596                 key = savepvn(key,klen);
 597                 key = (const char*)strupr((char*)key);
 598                 hash = 0;
 599
 600                 if (flags & HVhek_FREEKEY)
 601                     Safefree(keysave);
 602                 keysave = key;
 603             }
 604 #endif
 605         }
 606     }
 607
 608
 609     if (flags & HVhek_PLACEHOLD) {
 610         /* We have been requested to insert a placeholder. Currently
 611            only Storable is allowed to do this.  */
 612         val = &PL_sv_placeholder;
 613     }
 614
 615     if (is_utf8) {
 616         key = (char*)bytes_from_utf8((U8*)key, &klen, &is_utf8);
 617
 618         if (flags & HVhek_FREEKEY) {
 619             /* This shouldn't happen if our caller does what we expect,
 620                but strictly the API allows it.  */
 621             Safefree(keysave);
 622         }
 623
 624         if (is_utf8)
 625             flags |= HVhek_UTF8;
 626         if (key != keysave)
 627             flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
 628         HvHASKFLAGS_on((SV*)hv);
 629     }
 630
 631     if (HvREHASH(hv)) {
 632         /* We don't have a pointer to the hv, so we have to replicate the
 633            flag into every HEK, so that hv_iterkeysv can see it.  */
 634         flags |= HVhek_REHASH;
 635         PERL_HASH_INTERNAL(hash, key, klen);
 636     } else if (!hash) {
 637         if (keysv && SvIsCOW_shared_hash(keysv)) {
 638             hash = SvUVX(keysv);
 639         } else {
 640             PERL_HASH(hash, key, klen);
 641         }
 642     }
 643
 644     if (!xhv->xhv_array /* !HvARRAY(hv) */)
 645         Newz(505, xhv->xhv_array /* HvARRAY(hv) */,
 646              PERL_HV_ARRAY_ALLOC_BYTES(xhv->xhv_max+1 /* HvMAX(hv)+1 */),
 647              char);
 648
 649     /* oentry = &(HvARRAY(hv))[hash & (I32) HvMAX(hv)]; */
 650     oentry = &((HE**)xhv->xhv_array)[hash & (I32) xhv->xhv_max];
 651     n_links = 0;
 652     entry = *oentry;
 653     for (; entry; ++n_links, entry = HeNEXT(entry)) {
 654         if (HeHASH(entry) != hash)              /* strings can't be equal */
 655             continue;
 656         if (HeKLEN(entry) != (I32)klen)
 657             continue;
 658         if (HeKEY(entry) != key && memNE(HeKEY(entry),key,klen))        /* is this it? */
 659             continue;
 660         if ((HeKFLAGS(entry) ^ flags) & HVhek_UTF8)
 661             continue;
 662         if (HeVAL(entry) == &PL_sv_placeholder)
 663             xhv->xhv_placeholders--; /* yes, can store into placeholder slot */
 664         else
 665             SvREFCNT_dec(HeVAL(entry));
 666         HeVAL(entry) = val;
 667         if (val == &PL_sv_placeholder)
 668             xhv->xhv_placeholders++;
 669
 670         if (HeKFLAGS(entry) != flags) {
 671             /* We match if HVhek_UTF8 bit in our flags and hash key's match.
 672                But if entry was set previously with HVhek_WASUTF8 and key now
 673                doesn't (or vice versa) then we should change the key's flag,
 674                as this is assignment.  */
 675             if (HvSHAREKEYS(hv)) {
 676                 /* Need to swap the key we have for a key with the flags we
 677                    need. As keys are shared we can't just write to the flag,
 678                    so we share the new one, unshare the old one.  */
 679                 int flags_nofree = flags & ~HVhek_FREEKEY;
 680                 HEK *new_hek = share_hek_flags(key, klen, hash, flags_nofree);
 681                 unshare_hek (HeKEY_hek(entry));
 682                 HeKEY_hek(entry) = new_hek;
 683             }
 684             else
 685                 HeKFLAGS(entry) = flags;
 686         }
 687         if (flags & HVhek_FREEKEY)
 688             Safefree(key);
 689         return entry;
 690     }
 691
 692     if (SvREADONLY(hv)) {
 693         S_hv_notallowed(aTHX_ flags, key, klen,
 694                         "access disallowed key '%"SVf"' to"
 695                         );
 696     }
 697
 698     entry = new_HE();
 699     /* share_hek_flags will do the free for us.  This might be considered
 700        bad API design.  */
 701     if (HvSHAREKEYS(hv))
 702         HeKEY_hek(entry) = share_hek_flags(key, klen, hash, flags);
 703     else                                       /* gotta do the real thing */
 704         HeKEY_hek(entry) = save_hek_flags(key, klen, hash, flags);
 705     HeVAL(entry) = val;
 706     HeNEXT(entry) = *oentry;
 707     *oentry = entry;
 708
 709     if (val == &PL_sv_placeholder)
 710         xhv->xhv_placeholders++;
 711
 712     xhv->xhv_keys++; /* HvKEYS(hv)++ */
 713     if (!n_links) {                             /* initial entry? */
 714         xhv->xhv_fill++; /* HvFILL(hv)++ */
 715     } else if ((xhv->xhv_keys > (IV)xhv->xhv_max)
 716                || ((n_links > HV_MAX_LENGTH_BEFORE_SPLIT) && !HvREHASH(hv))) {
 717         /* Use only the old HvKEYS(hv) > HvMAX(hv) condition to limit bucket
 718            splits on a rehashed hash, as we're not going to split it again,
 719            and if someone is lucky (evil) enough to get all the keys in one
 720            list they could exhaust our memory as we repeatedly double the
 721            number of buckets on every entry. Linear search feels a less worse
 722            thing to do.  */
 723         hsplit(hv);
 724     }
 725
 726     return entry;
 727 }
 728
 729 /*
 730 =for apidoc hv_delete
 731
 732 Deletes a key/value pair in the hash.  The value SV is removed from the
 733 hash and returned to the caller.  The C<klen> is the length of the key.
 734 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
 735 will be returned.
 736
 737 =cut
 738 */
 739
 740 SV *
 741 Perl_hv_delete(pTHX_ HV *hv, const char *key, I32 klen, I32 flags)
 742 {
 743     return hv_delete_common(hv, NULL, key, klen, flags, 0);
 744 }
 745
 746 /*
 747 =for apidoc hv_delete_ent
 748
 749 Deletes a key/value pair in the hash.  The value SV is removed from the
 750 hash and returned to the caller.  The C<flags> value will normally be zero;
 751 if set to G_DISCARD then NULL will be returned.  C<hash> can be a valid
 752 precomputed hash value, or 0 to ask for it to be computed.
 753
 754 =cut
 755 */
 756
 757 SV *
 758 Perl_hv_delete_ent(pTHX_ HV *hv, SV *keysv, I32 flags, U32 hash)
 759 {
 760     return hv_delete_common(hv, keysv, NULL, 0, flags, hash);
 761 }
 762
 763 SV *
 764 S_hv_delete_common(pTHX_ HV *hv, SV *keysv, const char *key, I32 klen_i32,
 765                    I32 flags, U32 hash)
 766 {
 767     register XPVHV* xhv;
 768     register I32 i;
 769     STRLEN klen;
 770     register HE *entry;
 771     register HE **oentry;
 772     SV *sv;
 773     bool is_utf8;
 774     int k_flags = 0;
 775     const char *keysave;
 776     int masked_flags;
 777
 778     if (!hv)
 779         return Nullsv;
 780
 781     if (keysv) {
 782         key = SvPV(keysv, klen);
 783         is_utf8 = (SvUTF8(keysv) != 0);
 784     } else {
 785         if (klen_i32 < 0) {
 786             klen = -klen_i32;
 787             is_utf8 = TRUE;
 788         } else {
 789             klen = klen_i32;
 790             is_utf8 = FALSE;
 791         }
 792     }
 793     keysave = key;
 794
 795     if (SvRMAGICAL(hv)) {
 796         bool needs_copy;
 797         bool needs_store;
 798         hv_magic_check (hv, &needs_copy, &needs_store);
 799
 800         if (needs_copy) {
 801             entry = hv_fetch_common(hv, keysv, key, klen,
 802                                     k_flags & ~HVhek_FREEKEY, HV_FETCH_LVALUE,
 803                                     hash);
 804             sv = entry ? HeVAL(entry) : NULL;
 805             if (sv) {
 806                 if (SvMAGICAL(sv)) {
 807                     mg_clear(sv);
 808                 }
 809                 if (!needs_store) {
 810                     if (mg_find(sv, PERL_MAGIC_tiedelem)) {
 811                         /* No longer an element */
 812                         sv_unmagic(sv, PERL_MAGIC_tiedelem);
 813                         return sv;
 814                     }
 815                     return Nullsv;              /* element cannot be deleted */
 816                 }
 817             }
 818 #ifdef ENV_IS_CASELESS
 819             else if (mg_find((SV*)hv, PERL_MAGIC_env)) {
 820                 /* XXX This code isn't UTF8 clean.  */
 821                 keysv = sv_2mortal(newSVpvn(key,klen));
 822                 keysave = key = strupr(SvPVX(keysv));
 823                 is_utf8 = 0;
 824                 hash = 0;
 825             }
 826 #endif
 827         }
 828     }
 829     xhv = (XPVHV*)SvANY(hv);
 830     if (!xhv->xhv_array /* !HvARRAY(hv) */)
 831         return Nullsv;
 832
 833     if (is_utf8) {
 834         key = (char*)bytes_from_utf8((U8*)key, &klen, &is_utf8);
 835         if (is_utf8)
 836             k_flags = HVhek_UTF8;
 837         if (key != keysave)
 838             k_flags |= HVhek_FREEKEY;
 839     }
 840
 841     if (HvREHASH(hv)) {
 842         PERL_HASH_INTERNAL(hash, key, klen);
 843     } else if (!hash) {
 844         if (keysv && (SvIsCOW_shared_hash(keysv))) {
 845             hash = SvUVX(keysv);
 846         } else {
 847             PERL_HASH(hash, key, klen);
 848         }
 849         PERL_HASH(hash, key, klen);
 850     }
 851
 852     masked_flags = (k_flags & HVhek_MASK);
 853
 854     /* oentry = &(HvARRAY(hv))[hash & (I32) HvMAX(hv)]; */
 855     oentry = &((HE**)xhv->xhv_array)[hash & (I32) xhv->xhv_max];
 856     entry = *oentry;
 857     i = 1;
 858     for (; entry; i=0, oentry = &HeNEXT(entry), entry = *oentry) {
 859         if (HeHASH(entry) != hash)              /* strings can't be equal */
 860             continue;
 861         if (HeKLEN(entry) != (I32)klen)
 862             continue;
 863         if (HeKEY(entry) != key && memNE(HeKEY(entry),key,klen))        /* is this it? */
 864             continue;
 865         if ((HeKFLAGS(entry) ^ masked_flags) & HVhek_UTF8)
 866             continue;
 867         if (k_flags & HVhek_FREEKEY)
 868             Safefree(key);
 869
 870         /* if placeholder is here, it's already been deleted.... */
 871         if (HeVAL(entry) == &PL_sv_placeholder)
 872         {
 873             if (SvREADONLY(hv))
 874                 return Nullsv; /* if still SvREADONLY, leave it deleted. */
 875
 876            /* okay, really delete the placeholder. */
 877            *oentry = HeNEXT(entry);
 878            if (i && !*oentry)
 879                xhv->xhv_fill--; /* HvFILL(hv)-- */
 880            if (entry == xhv->xhv_eiter /* HvEITER(hv) */)
 881                HvLAZYDEL_on(hv);
 882            else
 883                hv_free_ent(hv, entry);
 884            xhv->xhv_keys--; /* HvKEYS(hv)-- */
 885            if (xhv->xhv_keys == 0)
 886                HvHASKFLAGS_off(hv);
 887            xhv->xhv_placeholders--;
 888            return Nullsv;
 889         }
 890         else if (SvREADONLY(hv) && HeVAL(entry) && SvREADONLY(HeVAL(entry))) {
 891             S_hv_notallowed(aTHX_ k_flags, key, klen,
 892                             "delete readonly key '%"SVf"' from"
 893                             );
 894         }
 895
 896         if (flags & G_DISCARD)
 897             sv = Nullsv;
 898         else {
 899             sv = sv_2mortal(HeVAL(entry));
 900             HeVAL(entry) = &PL_sv_placeholder;
 901         }
 902
 903         /*
 904          * If a restricted hash, rather than really deleting the entry, put
 905          * a placeholder there. This marks the key as being "approved", so
 906          * we can still access via not-really-existing key without raising
 907          * an error.
 908          */
 909         if (SvREADONLY(hv)) {
 910             HeVAL(entry) = &PL_sv_placeholder;
 911             /* We'll be saving this slot, so the number of allocated keys
 912              * doesn't go down, but the number placeholders goes up */
 913             xhv->xhv_placeholders++; /* HvPLACEHOLDERS(hv)++ */
 914         } else {
 915             *oentry = HeNEXT(entry);
 916             if (i && !*oentry)
 917                 xhv->xhv_fill--; /* HvFILL(hv)-- */
 918             if (entry == xhv->xhv_eiter /* HvEITER(hv) */)
 919                 HvLAZYDEL_on(hv);
 920             else
 921                 hv_free_ent(hv, entry);
 922             xhv->xhv_keys--; /* HvKEYS(hv)-- */
 923             if (xhv->xhv_keys == 0)
 924                 HvHASKFLAGS_off(hv);
 925         }
 926         return sv;
 927     }
 928     if (SvREADONLY(hv)) {
 929         S_hv_notallowed(aTHX_ k_flags, key, klen,
 930                         "delete disallowed key '%"SVf"' from"
 931                         );
 932     }
 933
 934     if (k_flags & HVhek_FREEKEY)
 935         Safefree(key);
 936     return Nullsv;
 937 }
 938
 939 /*
 940 =for apidoc hv_exists
 941
 942 Returns a boolean indicating whether the specified hash key exists.  The
 943 C<klen> is the length of the key.
 944
 945 =cut
 946 */
 947
 948 bool
 949 Perl_hv_exists(pTHX_ HV *hv, const char *key, I32 klen)
 950 {
 951     return hv_exists_common(hv, NULL, key, klen, 0);
 952 }
 953
 954 /*
 955 =for apidoc hv_exists_ent
 956
 957 Returns a boolean indicating whether the specified hash key exists. C<hash>
 958 can be a valid precomputed hash value, or 0 to ask for it to be
 959 computed.
 960
 961 =cut
 962 */
 963
 964 bool
 965 Perl_hv_exists_ent(pTHX_ HV *hv, SV *keysv, U32 hash)
 966 {
 967     return hv_exists_common(hv, keysv, NULL, 0, hash);
 968 }
 969
 970 bool
 971 S_hv_exists_common(pTHX_ HV *hv, SV *keysv, const char *key, I32 klen_i32,
 972                    U32 hash)
 973 {
 974     register XPVHV* xhv;
 975     STRLEN klen;
 976     register HE *entry;
 977     SV *sv;
 978     bool is_utf8;
 979     const char *keysave;
 980     int k_flags = 0;
 981
 982     if (!hv)
 983         return 0;
 984
 985     if (keysv) {
 986         key = SvPV(keysv, klen);
 987         is_utf8 = (SvUTF8(keysv) != 0);
 988     } else {
 989         if (klen_i32 < 0) {
 990             klen = -klen_i32;
 991             is_utf8 = TRUE;
 992         } else {
 993             klen = klen_i32;
 994             is_utf8 = FALSE;
 995         }
 996     }
 997     keysave = key;
 998
 999     if (SvRMAGICAL(hv)) {
1000         if (mg_find((SV*)hv, PERL_MAGIC_tied) || SvGMAGICAL((SV*)hv)) {
1001             SV* svret;
1002
1003             if (keysv || is_utf8) {
1004                 if (!keysv) {
1005                     keysv = newSVpvn(key, klen);
1006                     SvUTF8_on(keysv);
1007                 } else {
1008                     keysv = newSVsv(keysv);
1009                 }
1010                 key = (char *)sv_2mortal(keysv);
1011                 klen = HEf_SVKEY;
1012             }
1013
1014             /* I don't understand why hv_exists_ent has svret and sv,
1015                whereas hv_exists only had one.  */
1016             svret = sv_newmortal();
1017             sv = sv_newmortal();
1018             mg_copy((SV*)hv, sv, key, klen);
1019             magic_existspack(svret, mg_find(sv, PERL_MAGIC_tiedelem));
1020             return (bool)SvTRUE(svret);
1021         }
1022 #ifdef ENV_IS_CASELESS
1023         else if (mg_find((SV*)hv, PERL_MAGIC_env)) {
1024             /* XXX This code isn't UTF8 clean.  */
1025             keysv = sv_2mortal(newSVpvn(key,klen));
1026             keysave = key = strupr(SvPVX(keysv));
1027             is_utf8 = 0;
1028             hash = 0;
1029         }
1030 #endif
1031     }
1032
1033     xhv = (XPVHV*)SvANY(hv);
1034 #ifndef DYNAMIC_ENV_FETCH
1035     if (!xhv->xhv_array /* !HvARRAY(hv) */)
1036         return 0;
1037 #endif
1038
1039     if (is_utf8) {
1040         key = (char*)bytes_from_utf8((U8*)key, &klen, &is_utf8);
1041         if (is_utf8)
1042             k_flags = HVhek_UTF8;
1043         if (key != keysave)
1044             k_flags |= HVhek_FREEKEY;
1045     }
1046     if (HvREHASH(hv)) {
1047         PERL_HASH_INTERNAL(hash, key, klen);
1048     } else if (!hash)
1049         PERL_HASH(hash, key, klen);
1050
1051 #ifdef DYNAMIC_ENV_FETCH
1052     if (!xhv->xhv_array /* !HvARRAY(hv) */) entry = Null(HE*);
1053     else
1054 #endif
1055     /* entry = (HvARRAY(hv))[hash & (I32) HvMAX(hv)]; */
1056     entry = ((HE**)xhv->xhv_array)[hash & (I32) xhv->xhv_max];
1057     for (; entry; entry = HeNEXT(entry)) {
1058         if (HeHASH(entry) != hash)              /* strings can't be equal */
1059             continue;
1060         if (HeKLEN(entry) != (I32)klen)
1061             continue;
1062         if (HeKEY(entry) != key && memNE(HeKEY(entry),key,klen))        /* is this it? */
1063             continue;
1064         if ((HeKFLAGS(entry) ^ k_flags) & HVhek_UTF8)
1065             continue;
1066         if (k_flags & HVhek_FREEKEY)
1067             Safefree(key);
1068         /* If we find the key, but the value is a placeholder, return false. */
1069         if (HeVAL(entry) == &PL_sv_placeholder)
1070             return FALSE;
1071         return TRUE;
1072     }
1073 #ifdef DYNAMIC_ENV_FETCH  /* is it out there? */
1074     if (SvRMAGICAL((SV*)hv) && mg_find((SV*)hv, PERL_MAGIC_env)) {
1075         unsigned long len;
1076         char *env = PerlEnv_ENVgetenv_len(key,&len);
1077         if (env) {
1078             sv = newSVpvn(env,len);
1079             SvTAINTED_on(sv);
1080             (void)hv_store_ent(hv,keysv,sv,hash);
1081             if (k_flags & HVhek_FREEKEY)
1082                 Safefree(key);
1083             return TRUE;
1084         }
1085     }
1086 #endif
1087     if (k_flags & HVhek_FREEKEY)
1088         Safefree(key);
1089     return FALSE;
1090 }
1091
1092
1093 STATIC void
1094 S_hsplit(pTHX_ HV *hv)
1095 {
1096     register XPVHV* xhv = (XPVHV*)SvANY(hv);
1097     I32 oldsize = (I32) xhv->xhv_max+1; /* HvMAX(hv)+1 (sick) */
1098     register I32 newsize = oldsize * 2;
1099     register I32 i;
1100     register char *a = xhv->xhv_array; /* HvARRAY(hv) */
1101     register HE **aep;
1102     register HE **bep;
1103     register HE *entry;
1104     register HE **oentry;
1105     int longest_chain = 0;
1106     int was_shared;
1107
1108     PL_nomemok = TRUE;
1109 #if defined(STRANGE_MALLOC) || defined(MYMALLOC)
1110     Renew(a, PERL_HV_ARRAY_ALLOC_BYTES(newsize), char);
1111     if (!a) {
1112       PL_nomemok = FALSE;
1113       return;
1114     }
1115 #else
1116     New(2, a, PERL_HV_ARRAY_ALLOC_BYTES(newsize), char);
1117     if (!a) {
1118       PL_nomemok = FALSE;
1119       return;
1120     }
1121     Copy(xhv->xhv_array /* HvARRAY(hv) */, a, oldsize * sizeof(HE*), char);
1122     if (oldsize >= 64) {
1123         offer_nice_chunk(xhv->xhv_array /* HvARRAY(hv) */,
1124                         PERL_HV_ARRAY_ALLOC_BYTES(oldsize));
1125     }
1126     else
1127         Safefree(xhv->xhv_array /* HvARRAY(hv) */);
1128 #endif
1129
1130     PL_nomemok = FALSE;
1131     Zero(&a[oldsize * sizeof(HE*)], (newsize-oldsize) * sizeof(HE*), char);     /* zero 2nd half*/
1132     xhv->xhv_max = --newsize;   /* HvMAX(hv) = --newsize */
1133     xhv->xhv_array = a;         /* HvARRAY(hv) = a */
1134     aep = (HE**)a;
1135
1136     for (i=0; i<oldsize; i++,aep++) {
1137         int left_length = 0;
1138         int right_length = 0;
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 = (HE **) xhv->xhv_array;
1195
1196     for (i=0; i<newsize; i++,aep++) {
1197         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
1204             /* Rehash it */
1205             PERL_HASH_INTERNAL(hash, HeKEY(entry), HeKLEN(entry));
1206
1207             if (was_shared) {
1208                 /* Unshare it.  */
1209                 HEK *new_hek
1210                     = save_hek_flags(HeKEY(entry), HeKLEN(entry),
1211                                      hash, HeKFLAGS(entry));
1212                 unshare_hek (HeKEY_hek(entry));
1213                 HeKEY_hek(entry) = new_hek;
1214             } else {
1215                 /* Not shared, so simply write the new hash in. */
1216                 HeHASH(entry) = hash;
1217             }
1218             /*PerlIO_printf(PerlIO_stderr(), "%d ", HeKFLAGS(entry));*/
1219             HEK_REHASH_on(HeKEY_hek(entry));
1220             /*PerlIO_printf(PerlIO_stderr(), "%d\n", HeKFLAGS(entry));*/
1221
1222             /* Copy oentry to the correct new chain.  */
1223             bep = ((HE**)a) + (hash & (I32) xhv->xhv_max);
1224             if (!*bep)
1225                     xhv->xhv_fill++; /* HvFILL(hv)++ */
1226             HeNEXT(entry) = *bep;
1227             *bep = entry;
1228
1229             entry = next;
1230         }
1231     }
1232     Safefree (xhv->xhv_array);
1233     xhv->xhv_array = a;         /* HvARRAY(hv) = a */
1234 }
1235
1236 void
1237 Perl_hv_ksplit(pTHX_ HV *hv, IV newmax)
1238 {
1239     register XPVHV* xhv = (XPVHV*)SvANY(hv);
1240     I32 oldsize = (I32) xhv->xhv_max+1; /* HvMAX(hv)+1 (sick) */
1241     register I32 newsize;
1242     register I32 i;
1243     register I32 j;
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 = xhv->xhv_array; /* 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(xhv->xhv_array /* HvARRAY(hv) */, a, oldsize * sizeof(HE*), char);
1276         if (oldsize >= 64) {
1277             offer_nice_chunk(xhv->xhv_array /* HvARRAY(hv) */,
1278                             PERL_HV_ARRAY_ALLOC_BYTES(oldsize));
1279         }
1280         else
1281             Safefree(xhv->xhv_array /* 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     xhv->xhv_array = a;         /* HvARRAY(hv) = 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             if ((j = (HeHASH(entry) & newsize)) != i) {
1300                 j -= i;
1301                 *oentry = HeNEXT(entry);
1302                 if (!(HeNEXT(entry) = aep[j]))
1303                     xhv->xhv_fill++; /* HvFILL(hv)++ */
1304                 aep[j] = entry;
1305                 continue;
1306             }
1307             else
1308                 oentry = &HeNEXT(entry);
1309         }
1310         if (!*aep)                              /* everything moved */
1311             xhv->xhv_fill--; /* HvFILL(hv)-- */
1312     }
1313 }
1314
1315 /*
1316 =for apidoc newHV
1317
1318 Creates a new HV.  The reference count is set to 1.
1319
1320 =cut
1321 */
1322
1323 HV *
1324 Perl_newHV(pTHX)
1325 {
1326     register HV *hv;
1327     register XPVHV* xhv;
1328
1329     hv = (HV*)NEWSV(502,0);
1330     sv_upgrade((SV *)hv, SVt_PVHV);
1331     xhv = (XPVHV*)SvANY(hv);
1332     SvPOK_off(hv);
1333     SvNOK_off(hv);
1334 #ifndef NODEFAULT_SHAREKEYS
1335     HvSHAREKEYS_on(hv);         /* key-sharing on by default */
1336 #endif
1337
1338     xhv->xhv_max    = 7;        /* HvMAX(hv) = 7 (start with 8 buckets) */
1339     xhv->xhv_fill   = 0;        /* HvFILL(hv) = 0 */
1340     xhv->xhv_pmroot = 0;        /* HvPMROOT(hv) = 0 */
1341     (void)hv_iterinit(hv);      /* so each() will start off right */
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         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                 U32 hash   = HeHASH(oent);
1376                 char *key  = HeKEY(oent);
1377                 STRLEN len = HeKLEN(oent);
1378                 int flags  = HeKFLAGS(oent);
1379
1380                 ent = new_HE();
1381                 HeVAL(ent)     = newSVsv(HeVAL(oent));
1382                 HeKEY_hek(ent)
1383                     = shared ? 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         I32 riter = HvRITER(ohv);
1403         HE *eiter = HvEITER(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(ohv) = riter;
1417         HvEITER(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(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(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     register XPVHV* xhv;
1476     if (!hv)
1477         return;
1478
1479     DEBUG_A(Perl_hv_assert(aTHX_ hv));
1480
1481     xhv = (XPVHV*)SvANY(hv);
1482
1483     if (SvREADONLY(hv) && xhv->xhv_array != NULL) {
1484         /* restricted hash: convert all keys to placeholders */
1485         I32 i;
1486         HE* entry;
1487         for (i = 0; i <= (I32) xhv->xhv_max; i++) {
1488             entry = ((HE**)xhv->xhv_array)[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                     xhv->xhv_placeholders++; /* HvPLACEHOLDERS(hv)++ */
1501                 }
1502             }
1503         }
1504         return;
1505     }
1506
1507     hfreeentries(hv);
1508     xhv->xhv_placeholders = 0; /* HvPLACEHOLDERS(hv) = 0 */
1509     if (xhv->xhv_array /* HvARRAY(hv) */)
1510         (void)memzero(xhv->xhv_array /* 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 }
1519
1520 /*
1521 =for apidoc hv_clear_placeholders
1522
1523 Clears any placeholders from a hash.  If a restricted hash has any of its keys
1524 marked as readonly and the key is subsequently deleted, the key is not actually
1525 deleted but is marked by assigning it a value of &PL_sv_placeholder.  This tags
1526 it so it will be ignored by future operations such as iterating over the hash,
1527 but will still allow the hash to have a value reaasigned to the key at some
1528 future point.  This function clears any such placeholder keys from the hash.
1529 See Hash::Util::lock_keys() for an example of its use.
1530
1531 =cut
1532 */
1533
1534 void
1535 Perl_hv_clear_placeholders(pTHX_ HV *hv)
1536 {
1537     I32 items;
1538     items = (I32)HvPLACEHOLDERS(hv);
1539     if (items) {
1540         HE *entry;
1541         I32 riter = HvRITER(hv);
1542         HE *eiter = HvEITER(hv);
1543         hv_iterinit(hv);
1544         /* This may look suboptimal with the items *after* the iternext, but
1545            it's quite deliberate. We only get here with items==0 if we've
1546            just deleted the last placeholder in the hash. If we've just done
1547            that then it means that the hash is in lazy delete mode, and the
1548            HE is now only referenced in our iterator. If we just quit the loop
1549            and discarded our iterator then the HE leaks. So we do the && the
1550            other way to ensure iternext is called just one more time, which
1551            has the side effect of triggering the lazy delete.  */
1552         while ((entry = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS))
1553             && items) {
1554             SV *val = hv_iterval(hv, entry);
1555
1556             if (val == &PL_sv_placeholder) {
1557
1558                 /* It seems that I have to go back in the front of the hash
1559                    API to delete a hash, even though I have a HE structure
1560                    pointing to the very entry I want to delete, and could hold
1561                    onto the previous HE that points to it. And it's easier to
1562                    go in with SVs as I can then specify the precomputed hash,
1563                    and don't have fun and games with utf8 keys.  */
1564                 SV *key = hv_iterkeysv(entry);
1565
1566                 hv_delete_ent (hv, key, G_DISCARD, HeHASH(entry));
1567                 items--;
1568             }
1569         }
1570         HvRITER(hv) = riter;
1571         HvEITER(hv) = eiter;
1572     }
1573 }
1574
1575 STATIC void
1576 S_hfreeentries(pTHX_ HV *hv)
1577 {
1578     register HE **array;
1579     register HE *entry;
1580     register HE *oentry = Null(HE*);
1581     I32 riter;
1582     I32 max;
1583
1584     if (!hv)
1585         return;
1586     if (!HvARRAY(hv))
1587         return;
1588
1589     riter = 0;
1590     max = HvMAX(hv);
1591     array = HvARRAY(hv);
1592     /* make everyone else think the array is empty, so that the destructors
1593      * called for freed entries can't recusively mess with us */
1594     HvARRAY(hv) = Null(HE**);
1595     HvFILL(hv) = 0;
1596     ((XPVHV*) SvANY(hv))->xhv_keys = 0;
1597
1598     entry = array[0];
1599     for (;;) {
1600         if (entry) {
1601             oentry = entry;
1602             entry = HeNEXT(entry);
1603             hv_free_ent(hv, oentry);
1604         }
1605         if (!entry) {
1606             if (++riter > max)
1607                 break;
1608             entry = array[riter];
1609         }
1610     }
1611     HvARRAY(hv) = array;
1612     (void)hv_iterinit(hv);
1613 }
1614
1615 /*
1616 =for apidoc hv_undef
1617
1618 Undefines the hash.
1619
1620 =cut
1621 */
1622
1623 void
1624 Perl_hv_undef(pTHX_ HV *hv)
1625 {
1626     register XPVHV* xhv;
1627     if (!hv)
1628         return;
1629     DEBUG_A(Perl_hv_assert(aTHX_ hv));
1630     xhv = (XPVHV*)SvANY(hv);
1631     hfreeentries(hv);
1632     Safefree(xhv->xhv_array /* HvARRAY(hv) */);
1633     if (HvNAME(hv)) {
1634         if(PL_stashcache)
1635             hv_delete(PL_stashcache, HvNAME(hv), strlen(HvNAME(hv)), G_DISCARD);
1636         Safefree(HvNAME(hv));
1637         HvNAME(hv) = 0;
1638     }
1639     xhv->xhv_max   = 7; /* HvMAX(hv) = 7 (it's a normal hash) */
1640     xhv->xhv_array = 0; /* HvARRAY(hv) = 0 */
1641     xhv->xhv_placeholders = 0; /* HvPLACEHOLDERS(hv) = 0 */
1642
1643     if (SvRMAGICAL(hv))
1644         mg_clear((SV*)hv);
1645 }
1646
1647 /*
1648 =for apidoc hv_iterinit
1649
1650 Prepares a starting point to traverse a hash table.  Returns the number of
1651 keys in the hash (i.e. the same as C<HvKEYS(tb)>).  The return value is
1652 currently only meaningful for hashes without tie magic.
1653
1654 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1655 hash buckets that happen to be in use.  If you still need that esoteric
1656 value, you can get it through the macro C<HvFILL(tb)>.
1657
1658
1659 =cut
1660 */
1661
1662 I32
1663 Perl_hv_iterinit(pTHX_ HV *hv)
1664 {
1665     register XPVHV* xhv;
1666     HE *entry;
1667
1668     if (!hv)
1669         Perl_croak(aTHX_ "Bad hash");
1670     xhv = (XPVHV*)SvANY(hv);
1671     entry = xhv->xhv_eiter; /* HvEITER(hv) */
1672     if (entry && HvLAZYDEL(hv)) {       /* was deleted earlier? */
1673         HvLAZYDEL_off(hv);
1674         hv_free_ent(hv, entry);
1675     }
1676     xhv->xhv_riter = -1;        /* HvRITER(hv) = -1 */
1677     xhv->xhv_eiter = Null(HE*); /* HvEITER(hv) = Null(HE*) */
1678     /* used to be xhv->xhv_fill before 5.004_65 */
1679     return XHvTOTALKEYS(xhv);
1680 }
1681 /*
1682 =for apidoc hv_iternext
1683
1684 Returns entries from a hash iterator.  See C<hv_iterinit>.
1685
1686 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
1687 iterator currently points to, without losing your place or invalidating your
1688 iterator.  Note that in this case the current entry is deleted from the hash
1689 with your iterator holding the last reference to it.  Your iterator is flagged
1690 to free the entry on the next call to C<hv_iternext>, so you must not discard
1691 your iterator immediately else the entry will leak - call C<hv_iternext> to
1692 trigger the resource deallocation.
1693
1694 =cut
1695 */
1696
1697 HE *
1698 Perl_hv_iternext(pTHX_ HV *hv)
1699 {
1700     return hv_iternext_flags(hv, 0);
1701 }
1702
1703 /*
1704 =for apidoc hv_iternext_flags
1705
1706 Returns entries from a hash iterator.  See C<hv_iterinit> and C<hv_iternext>.
1707 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
1708 set the placeholders keys (for restricted hashes) will be returned in addition
1709 to normal keys. By default placeholders are automatically skipped over.
1710 Currently a placeholder is implemented with a value that is
1711 C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
1712 restricted hashes may change, and the implementation currently is
1713 insufficiently abstracted for any change to be tidy.
1714
1715 =cut
1716 */
1717
1718 HE *
1719 Perl_hv_iternext_flags(pTHX_ HV *hv, I32 flags)
1720 {
1721     register XPVHV* xhv;
1722     register HE *entry;
1723     HE *oldentry;
1724     MAGIC* mg;
1725
1726     if (!hv)
1727         Perl_croak(aTHX_ "Bad hash");
1728     xhv = (XPVHV*)SvANY(hv);
1729     oldentry = entry = xhv->xhv_eiter; /* HvEITER(hv) */
1730
1731     if ((mg = SvTIED_mg((SV*)hv, PERL_MAGIC_tied))) {
1732         SV *key = sv_newmortal();
1733         if (entry) {
1734             sv_setsv(key, HeSVKEY_force(entry));
1735             SvREFCNT_dec(HeSVKEY(entry));       /* get rid of previous key */
1736         }
1737         else {
1738             char *k;
1739             HEK *hek;
1740
1741             /* one HE per MAGICAL hash */
1742             xhv->xhv_eiter = entry = new_HE(); /* HvEITER(hv) = new_HE() */
1743             Zero(entry, 1, HE);
1744             Newz(54, k, HEK_BASESIZE + sizeof(SV*), char);
1745             hek = (HEK*)k;
1746             HeKEY_hek(entry) = hek;
1747             HeKLEN(entry) = HEf_SVKEY;
1748         }
1749         magic_nextpack((SV*) hv,mg,key);
1750         if (SvOK(key)) {
1751             /* force key to stay around until next time */
1752             HeSVKEY_set(entry, SvREFCNT_inc(key));
1753             return entry;               /* beware, hent_val is not set */
1754         }
1755         if (HeVAL(entry))
1756             SvREFCNT_dec(HeVAL(entry));
1757         Safefree(HeKEY_hek(entry));
1758         del_HE(entry);
1759         xhv->xhv_eiter = Null(HE*); /* HvEITER(hv) = Null(HE*) */
1760         return Null(HE*);
1761     }
1762 #ifdef DYNAMIC_ENV_FETCH  /* set up %ENV for iteration */
1763     if (!entry && SvRMAGICAL((SV*)hv) && mg_find((SV*)hv, PERL_MAGIC_env))
1764         prime_env_iter();
1765 #endif
1766
1767     if (!xhv->xhv_array /* !HvARRAY(hv) */)
1768         Newz(506, xhv->xhv_array /* HvARRAY(hv) */,
1769              PERL_HV_ARRAY_ALLOC_BYTES(xhv->xhv_max+1 /* HvMAX(hv)+1 */),
1770              char);
1771     /* At start of hash, entry is NULL.  */
1772     if (entry)
1773     {
1774         entry = HeNEXT(entry);
1775         if (!(flags & HV_ITERNEXT_WANTPLACEHOLDERS)) {
1776             /*
1777              * Skip past any placeholders -- don't want to include them in
1778              * any iteration.
1779              */
1780             while (entry && HeVAL(entry) == &PL_sv_placeholder) {
1781                 entry = HeNEXT(entry);
1782             }
1783         }
1784     }
1785     while (!entry) {
1786         /* OK. Come to the end of the current list.  Grab the next one.  */
1787
1788         xhv->xhv_riter++; /* HvRITER(hv)++ */
1789         if (xhv->xhv_riter > (I32)xhv->xhv_max /* HvRITER(hv) > HvMAX(hv) */) {
1790             /* There is no next one.  End of the hash.  */
1791             xhv->xhv_riter = -1; /* HvRITER(hv) = -1 */
1792             break;
1793         }
1794         /* entry = (HvARRAY(hv))[HvRITER(hv)]; */
1795         entry = ((HE**)xhv->xhv_array)[xhv->xhv_riter];
1796
1797         if (!(flags & HV_ITERNEXT_WANTPLACEHOLDERS)) {
1798             /* If we have an entry, but it's a placeholder, don't count it.
1799                Try the next.  */
1800             while (entry && HeVAL(entry) == &PL_sv_placeholder)
1801                 entry = HeNEXT(entry);
1802         }
1803         /* Will loop again if this linked list starts NULL
1804            (for HV_ITERNEXT_WANTPLACEHOLDERS)
1805            or if we run through it and find only placeholders.  */
1806     }
1807
1808     if (oldentry && HvLAZYDEL(hv)) {            /* was deleted earlier? */
1809         HvLAZYDEL_off(hv);
1810         hv_free_ent(hv, oldentry);
1811     }
1812
1813     /*if (HvREHASH(hv) && entry && !HeKREHASH(entry))
1814       PerlIO_printf(PerlIO_stderr(), "Awooga %p %p\n", hv, entry);*/
1815
1816     xhv->xhv_eiter = entry; /* HvEITER(hv) = entry */
1817     return entry;
1818 }
1819
1820 /*
1821 =for apidoc hv_iterkey
1822
1823 Returns the key from the current position of the hash iterator.  See
1824 C<hv_iterinit>.
1825
1826 =cut
1827 */
1828
1829 char *
1830 Perl_hv_iterkey(pTHX_ register HE *entry, I32 *retlen)
1831 {
1832     if (HeKLEN(entry) == HEf_SVKEY) {
1833         STRLEN len;
1834         char *p = SvPV(HeKEY_sv(entry), len);
1835         *retlen = len;
1836         return p;
1837     }
1838     else {
1839         *retlen = HeKLEN(entry);
1840         return HeKEY(entry);
1841     }
1842 }
1843
1844 /* unlike hv_iterval(), this always returns a mortal copy of the key */
1845 /*
1846 =for apidoc hv_iterkeysv
1847
1848 Returns the key as an C<SV*> from the current position of the hash
1849 iterator.  The return value will always be a mortal copy of the key.  Also
1850 see C<hv_iterinit>.
1851
1852 =cut
1853 */
1854
1855 SV *
1856 Perl_hv_iterkeysv(pTHX_ register HE *entry)
1857 {
1858     if (HeKLEN(entry) != HEf_SVKEY) {
1859         HEK *hek = HeKEY_hek(entry);
1860         int flags = HEK_FLAGS(hek);
1861         SV *sv;
1862
1863         if (flags & HVhek_WASUTF8) {
1864             /* Trouble :-)
1865                Andreas would like keys he put in as utf8 to come back as utf8
1866             */
1867             STRLEN utf8_len = HEK_LEN(hek);
1868             U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
1869
1870             sv = newSVpvn ((char*)as_utf8, utf8_len);
1871             SvUTF8_on (sv);
1872             Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
1873         } else if (flags & HVhek_REHASH) {
1874             /* We don't have a pointer to the hv, so we have to replicate the
1875                flag into every HEK. This hv is using custom a hasing
1876                algorithm. Hence we can't return a shared string scalar, as
1877                that would contain the (wrong) hash value, and might get passed
1878                into an hv routine with a regular hash  */
1879
1880             sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
1881             if (HEK_UTF8(hek))
1882                 SvUTF8_on (sv);
1883         } else {
1884             sv = newSVpvn_share(HEK_KEY(hek),
1885                                 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
1886                                 HEK_HASH(hek));
1887         }
1888         return sv_2mortal(sv);
1889     }
1890     return sv_mortalcopy(HeKEY_sv(entry));
1891 }
1892
1893 /*
1894 =for apidoc hv_iterval
1895
1896 Returns the value from the current position of the hash iterator.  See
1897 C<hv_iterkey>.
1898
1899 =cut
1900 */
1901
1902 SV *
1903 Perl_hv_iterval(pTHX_ HV *hv, register HE *entry)
1904 {
1905     if (SvRMAGICAL(hv)) {
1906         if (mg_find((SV*)hv, PERL_MAGIC_tied)) {
1907             SV* sv = sv_newmortal();
1908             if (HeKLEN(entry) == HEf_SVKEY)
1909                 mg_copy((SV*)hv, sv, (char*)HeKEY_sv(entry), HEf_SVKEY);
1910             else mg_copy((SV*)hv, sv, HeKEY(entry), HeKLEN(entry));
1911             return sv;
1912         }
1913     }
1914     return HeVAL(entry);
1915 }
1916
1917 /*
1918 =for apidoc hv_iternextsv
1919
1920 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1921 operation.
1922
1923 =cut
1924 */
1925
1926 SV *
1927 Perl_hv_iternextsv(pTHX_ HV *hv, char **key, I32 *retlen)
1928 {
1929     HE *he;
1930     if ( (he = hv_iternext_flags(hv, 0)) == NULL)
1931         return NULL;
1932     *key = hv_iterkey(he, retlen);
1933     return hv_iterval(hv, he);
1934 }
1935
1936 /*
1937 =for apidoc hv_magic
1938
1939 Adds magic to a hash.  See C<sv_magic>.
1940
1941 =cut
1942 */
1943
1944 void
1945 Perl_hv_magic(pTHX_ HV *hv, GV *gv, int how)
1946 {
1947     sv_magic((SV*)hv, (SV*)gv, how, Nullch, 0);
1948 }
1949
1950 #if 0 /* use the macro from hv.h instead */
1951
1952 char*
1953 Perl_sharepvn(pTHX_ const char *sv, I32 len, U32 hash)
1954 {
1955     return HEK_KEY(share_hek(sv, len, hash));
1956 }
1957
1958 #endif
1959
1960 /* possibly free a shared string if no one has access to it
1961  * len and hash must both be valid for str.
1962  */
1963 void
1964 Perl_unsharepvn(pTHX_ const char *str, I32 len, U32 hash)
1965 {
1966     unshare_hek_or_pvn (NULL, str, len, hash);
1967 }
1968
1969
1970 void
1971 Perl_unshare_hek(pTHX_ HEK *hek)
1972 {
1973     unshare_hek_or_pvn(hek, NULL, 0, 0);
1974 }
1975
1976 /* possibly free a shared string if no one has access to it
1977    hek if non-NULL takes priority over the other 3, else str, len and hash
1978    are used.  If so, len and hash must both be valid for str.
1979  */
1980 STATIC void
1981 S_unshare_hek_or_pvn(pTHX_ HEK *hek, const char *str, I32 len, U32 hash)
1982 {
1983     register XPVHV* xhv;
1984     register HE *entry;
1985     register HE **oentry;
1986     register I32 i = 1;
1987     I32 found = 0;
1988     bool is_utf8 = FALSE;
1989     int k_flags = 0;
1990     const char *save = str;
1991
1992     if (hek) {
1993         hash = HEK_HASH(hek);
1994     } else if (len < 0) {
1995         STRLEN tmplen = -len;
1996         is_utf8 = TRUE;
1997         /* See the note in hv_fetch(). --jhi */
1998         str = (char*)bytes_from_utf8((U8*)str, &tmplen, &is_utf8);
1999         len = tmplen;
2000         if (is_utf8)
2001             k_flags = HVhek_UTF8;
2002         if (str != save)
2003             k_flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
2004     }
2005
2006     /* what follows is the moral equivalent of:
2007     if ((Svp = hv_fetch(PL_strtab, tmpsv, FALSE, hash))) {
2008         if (--*Svp == Nullsv)
2009             hv_delete(PL_strtab, str, len, G_DISCARD, hash);
2010     } */
2011     xhv = (XPVHV*)SvANY(PL_strtab);
2012     /* assert(xhv_array != 0) */
2013     LOCK_STRTAB_MUTEX;
2014     /* oentry = &(HvARRAY(hv))[hash & (I32) HvMAX(hv)]; */
2015     oentry = &((HE**)xhv->xhv_array)[hash & (I32) xhv->xhv_max];
2016     if (hek) {
2017         for (entry = *oentry; entry; i=0, oentry = &HeNEXT(entry), entry = *oentry) {
2018             if (HeKEY_hek(entry) != hek)
2019                 continue;
2020             found = 1;
2021             break;
2022         }
2023     } else {
2024         int flags_masked = k_flags & HVhek_MASK;
2025         for (entry = *oentry; entry; i=0, oentry = &HeNEXT(entry), entry = *oentry) {
2026             if (HeHASH(entry) != hash)          /* strings can't be equal */
2027                 continue;
2028             if (HeKLEN(entry) != len)
2029                 continue;
2030             if (HeKEY(entry) != str && memNE(HeKEY(entry),str,len))     /* is this it? */
2031                 continue;
2032             if (HeKFLAGS(entry) != flags_masked)
2033                 continue;
2034             found = 1;
2035             break;
2036         }
2037     }
2038
2039     if (found) {
2040         if (--HeVAL(entry) == Nullsv) {
2041             *oentry = HeNEXT(entry);
2042             if (i && !*oentry)
2043                 xhv->xhv_fill--; /* HvFILL(hv)-- */
2044             Safefree(HeKEY_hek(entry));
2045             del_HE(entry);
2046             xhv->xhv_keys--; /* HvKEYS(hv)-- */
2047         }
2048     }
2049
2050     UNLOCK_STRTAB_MUTEX;
2051     if (!found && ckWARN_d(WARN_INTERNAL))
2052         Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
2053                     "Attempt to free non-existent shared string '%s'%s",
2054                     hek ? HEK_KEY(hek) : str,
2055                     (k_flags & HVhek_UTF8) ? " (utf8)" : "");
2056     if (k_flags & HVhek_FREEKEY)
2057         Safefree(str);
2058 }
2059
2060 /* get a (constant) string ptr from the global string table
2061  * string will get added if it is not already there.
2062  * len and hash must both be valid for str.
2063  */
2064 HEK *
2065 Perl_share_hek(pTHX_ const char *str, I32 len, register U32 hash)
2066 {
2067     bool is_utf8 = FALSE;
2068     int flags = 0;
2069     const char *save = str;
2070
2071     if (len < 0) {
2072       STRLEN tmplen = -len;
2073       is_utf8 = TRUE;
2074       /* See the note in hv_fetch(). --jhi */
2075       str = (char*)bytes_from_utf8((U8*)str, &tmplen, &is_utf8);
2076       len = tmplen;
2077       /* If we were able to downgrade here, then than means that we were passed
2078          in a key which only had chars 0-255, but was utf8 encoded.  */
2079       if (is_utf8)
2080           flags = HVhek_UTF8;
2081       /* If we found we were able to downgrade the string to bytes, then
2082          we should flag that it needs upgrading on keys or each.  Also flag
2083          that we need share_hek_flags to free the string.  */
2084       if (str != save)
2085           flags |= HVhek_WASUTF8 | HVhek_FREEKEY;
2086     }
2087
2088     return share_hek_flags (str, len, hash, flags);
2089 }
2090
2091 STATIC HEK *
2092 S_share_hek_flags(pTHX_ const char *str, I32 len, register U32 hash, int flags)
2093 {
2094     register XPVHV* xhv;
2095     register HE *entry;
2096     register HE **oentry;
2097     register I32 i = 1;
2098     I32 found = 0;
2099     int flags_masked = flags & HVhek_MASK;
2100
2101     /* what follows is the moral equivalent of:
2102
2103     if (!(Svp = hv_fetch(PL_strtab, str, len, FALSE)))
2104         hv_store(PL_strtab, str, len, Nullsv, hash);
2105
2106         Can't rehash the shared string table, so not sure if it's worth
2107         counting the number of entries in the linked list
2108     */
2109     xhv = (XPVHV*)SvANY(PL_strtab);
2110     /* assert(xhv_array != 0) */
2111     LOCK_STRTAB_MUTEX;
2112     /* oentry = &(HvARRAY(hv))[hash & (I32) HvMAX(hv)]; */
2113     oentry = &((HE**)xhv->xhv_array)[hash & (I32) xhv->xhv_max];
2114     for (entry = *oentry; entry; i=0, entry = HeNEXT(entry)) {
2115         if (HeHASH(entry) != hash)              /* strings can't be equal */
2116             continue;
2117         if (HeKLEN(entry) != len)
2118             continue;
2119         if (HeKEY(entry) != str && memNE(HeKEY(entry),str,len)) /* is this it? */
2120             continue;
2121         if (HeKFLAGS(entry) != flags_masked)
2122             continue;
2123         found = 1;
2124         break;
2125     }
2126     if (!found) {
2127         entry = new_HE();
2128         HeKEY_hek(entry) = save_hek_flags(str, len, hash, flags);
2129         HeVAL(entry) = Nullsv;
2130         HeNEXT(entry) = *oentry;
2131         *oentry = entry;
2132         xhv->xhv_keys++; /* HvKEYS(hv)++ */
2133         if (i) {                                /* initial entry? */
2134             xhv->xhv_fill++; /* HvFILL(hv)++ */
2135         } else if (xhv->xhv_keys > (IV)xhv->xhv_max /* HvKEYS(hv) > HvMAX(hv) */) {
2136                 hsplit(PL_strtab);
2137         }
2138     }
2139
2140     ++HeVAL(entry);                             /* use value slot as REFCNT */
2141     UNLOCK_STRTAB_MUTEX;
2142
2143     if (flags & HVhek_FREEKEY)
2144         Safefree(str);
2145
2146     return HeKEY_hek(entry);
2147 }
2148
2149
2150 /*
2151 =for apidoc hv_assert
2152
2153 Check that a hash is in an internally consistent state.
2154
2155 =cut
2156 */
2157
2158 void
2159 Perl_hv_assert(pTHX_ HV *hv)
2160 {
2161   HE* entry;
2162   int withflags = 0;
2163   int placeholders = 0;
2164   int real = 0;
2165   int bad = 0;
2166   I32 riter = HvRITER(hv);
2167   HE *eiter = HvEITER(hv);
2168
2169   (void)hv_iterinit(hv);
2170
2171   while ((entry = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS))) {
2172     /* sanity check the values */
2173     if (HeVAL(entry) == &PL_sv_placeholder) {
2174       placeholders++;
2175     } else {
2176       real++;
2177     }
2178     /* sanity check the keys */
2179     if (HeSVKEY(entry)) {
2180       /* Don't know what to check on SV keys.  */
2181     } else if (HeKUTF8(entry)) {
2182       withflags++;
2183        if (HeKWASUTF8(entry)) {
2184          PerlIO_printf(Perl_debug_log,
2185                        "hash key has both WASUFT8 and UTF8: '%.*s'\n",
2186                        (int) HeKLEN(entry),  HeKEY(entry));
2187          bad = 1;
2188        }
2189     } else if (HeKWASUTF8(entry)) {
2190       withflags++;
2191     }
2192   }
2193   if (!SvTIED_mg((SV*)hv, PERL_MAGIC_tied)) {
2194     if (HvUSEDKEYS(hv) != real) {
2195       PerlIO_printf(Perl_debug_log, "Count %d key(s), but hash reports %d\n",
2196                     (int) real, (int) HvUSEDKEYS(hv));
2197       bad = 1;
2198     }
2199     if (HvPLACEHOLDERS(hv) != placeholders) {
2200       PerlIO_printf(Perl_debug_log,
2201                     "Count %d placeholder(s), but hash reports %d\n",
2202                     (int) placeholders, (int) HvPLACEHOLDERS(hv));
2203       bad = 1;
2204     }
2205   }
2206   if (withflags && ! HvHASKFLAGS(hv)) {
2207     PerlIO_printf(Perl_debug_log,
2208                   "Hash has HASKFLAGS off but I count %d key(s) with flags\n",
2209                   withflags);
2210     bad = 1;
2211   }
2212   if (bad) {
2213     sv_dump((SV *)hv);
2214   }
2215   HvRITER(hv) = riter;          /* Restore hash iterator state */
2216   HvEITER(hv) = eiter;
2217 }