hv.c

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