hv.c

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