hv.c

   1 /*    hv.c
   2  *
   3  *    Copyright (c) 1991-1997, Larry Wall
   4  *
   5  *    You may distribute under the terms of either the GNU General Public
   6  *    License or the Artistic License, as specified in the README file.
   7  *
   8  */
   9
  10 /*
  11  * "I sit beside the fire and think of all that I have seen."  --Bilbo
  12  */
  13
  14 #include "EXTERN.h"
  15 #include "perl.h"
  16
  17 static void hv_magic_check _((HV *hv, bool *needs_copy, bool *needs_store));
  18 #ifndef PERL_OBJECT
  19 static void hsplit _((HV *hv));
  20 static void hfreeentries _((HV *hv));
  21 static HE* more_he _((void));
  22 #endif
  23
  24 STATIC HE*
  25 new_he(void)
  26 {
  27     HE* he;
  28     if (he_root) {
  29         he = he_root;
  30         he_root = HeNEXT(he);
  31         return he;
  32     }
  33     return more_he();
  34 }
  35
  36 STATIC void
  37 del_he(HE *p)
  38 {
  39     HeNEXT(p) = (HE*)he_root;
  40     he_root = p;
  41 }
  42
  43 STATIC HE*
  44 more_he(void)
  45 {
  46     register HE* he;
  47     register HE* heend;
  48     New(54, he_root, 1008/sizeof(HE), HE);
  49     he = he_root;
  50     heend = &he[1008 / sizeof(HE) - 1];
  51     while (he < heend) {
  52         HeNEXT(he) = (HE*)(he + 1);
  53         he++;
  54     }
  55     HeNEXT(he) = 0;
  56     return new_he();
  57 }
  58
  59 STATIC HEK *
  60 save_hek(char *str, I32 len, U32 hash)
  61 {
  62     char *k;
  63     register HEK *hek;
  64
  65     New(54, k, HEK_BASESIZE + len + 1, char);
  66     hek = (HEK*)k;
  67     Copy(str, HEK_KEY(hek), len, char);
  68     *(HEK_KEY(hek) + len) = '\0';
  69     HEK_LEN(hek) = len;
  70     HEK_HASH(hek) = hash;
  71     return hek;
  72 }
  73
  74 void
  75 unshare_hek(HEK *hek)
  76 {
  77     unsharepvn(HEK_KEY(hek),HEK_LEN(hek),HEK_HASH(hek));
  78 }
  79
  80 /* (klen == HEf_SVKEY) is special for MAGICAL hv entries, meaning key slot
  81  * contains an SV* */
  82
  83 SV**
  84 hv_fetch(HV *hv, char *key, U32 klen, I32 lval)
  85 {
  86     register XPVHV* xhv;
  87     register U32 hash;
  88     register HE *entry;
  89     SV *sv;
  90
  91     if (!hv)
  92         return 0;
  93
  94     if (SvRMAGICAL(hv)) {
  95         if (mg_find((SV*)hv,'P')) {
  96             dTHR;
  97             sv = sv_newmortal();
  98             mg_copy((SV*)hv, sv, key, klen);
  99             hv_fetch_sv = sv;
 100             return &hv_fetch_sv;
 101         }
 102 #ifdef ENV_IS_CASELESS
 103         else if (mg_find((SV*)hv,'E')) {
 104             U32 i;
 105             for (i = 0; i < klen; ++i)
 106                 if (isLOWER(key[i])) {
 107                     char *nkey = strupr(SvPVX(sv_2mortal(newSVpv(key,klen))));
 108                     SV **ret = hv_fetch(hv, nkey, klen, 0);
 109                     if (!ret && lval)
 110                         ret = hv_store(hv, key, klen, NEWSV(61,0), 0);
 111                     return ret;
 112                 }
 113         }
 114 #endif
 115     }
 116
 117     xhv = (XPVHV*)SvANY(hv);
 118     if (!xhv->xhv_array) {
 119         if (lval
 120 #ifdef DYNAMIC_ENV_FETCH  /* if it's an %ENV lookup, we may get it on the fly */
 121                  || (HvNAME(hv) && strEQ(HvNAME(hv),ENV_HV_NAME))
 122 #endif
 123                                                                   )
 124             Newz(503,xhv->xhv_array, sizeof(HE*) * (xhv->xhv_max + 1), char);
 125         else
 126             return 0;
 127     }
 128
 129     PERL_HASH(hash, key, klen);
 130
 131     entry = ((HE**)xhv->xhv_array)[hash & (I32) xhv->xhv_max];
 132     for (; entry; entry = HeNEXT(entry)) {
 133         if (HeHASH(entry) != hash)              /* strings can't be equal */
 134             continue;
 135         if (HeKLEN(entry) != klen)
 136             continue;
 137         if (memNE(HeKEY(entry),key,klen))       /* is this it? */
 138             continue;
 139         return &HeVAL(entry);
 140     }
 141 #ifdef DYNAMIC_ENV_FETCH  /* %ENV lookup?  If so, try to fetch the value now */
 142     if (HvNAME(hv) && strEQ(HvNAME(hv),ENV_HV_NAME)) {
 143       char *gotenv;
 144
 145       if ((gotenv = PerlEnv_getenv(key)) != Nullch) {
 146         sv = newSVpv(gotenv,strlen(gotenv));
 147         SvTAINTED_on(sv);
 148         return hv_store(hv,key,klen,sv,hash);
 149       }
 150     }
 151 #endif
 152     if (lval) {         /* gonna assign to this, so it better be there */
 153         sv = NEWSV(61,0);
 154         return hv_store(hv,key,klen,sv,hash);
 155     }
 156     return 0;
 157 }
 158
 159 /* returns a HE * structure with the all fields set */
 160 /* note that hent_val will be a mortal sv for MAGICAL hashes */
 161 HE *
 162 hv_fetch_ent(HV *hv, SV *keysv, I32 lval, register U32 hash)
 163 {
 164     register XPVHV* xhv;
 165     register char *key;
 166     STRLEN klen;
 167     register HE *entry;
 168     SV *sv;
 169
 170     if (!hv)
 171         return 0;
 172
 173     if (SvRMAGICAL(hv)) {
 174         if (mg_find((SV*)hv,'P')) {
 175             dTHR;
 176             sv = sv_newmortal();
 177             keysv = sv_2mortal(newSVsv(keysv));
 178             mg_copy((SV*)hv, sv, (char*)keysv, HEf_SVKEY);
 179             if (!HeKEY_hek(&hv_fetch_ent_mh)) {
 180                 char *k;
 181                 New(54, k, HEK_BASESIZE + sizeof(SV*), char);
 182                 HeKEY_hek(&hv_fetch_ent_mh) = (HEK*)k;
 183             }
 184             HeSVKEY_set(&hv_fetch_ent_mh, keysv);
 185             HeVAL(&hv_fetch_ent_mh) = sv;
 186             return &hv_fetch_ent_mh;
 187         }
 188 #ifdef ENV_IS_CASELESS
 189         else if (mg_find((SV*)hv,'E')) {
 190             U32 i;
 191             key = SvPV(keysv, klen);
 192             for (i = 0; i < klen; ++i)
 193                 if (isLOWER(key[i])) {
 194                     SV *nkeysv = sv_2mortal(newSVpv(key,klen));
 195                     (void)strupr(SvPVX(nkeysv));
 196                     entry = hv_fetch_ent(hv, nkeysv, 0, 0);
 197                     if (!entry && lval)
 198                         entry = hv_store_ent(hv, keysv, NEWSV(61,0), hash);
 199                     return entry;
 200                 }
 201         }
 202 #endif
 203     }
 204
 205     xhv = (XPVHV*)SvANY(hv);
 206     if (!xhv->xhv_array) {
 207         if (lval
 208 #ifdef DYNAMIC_ENV_FETCH  /* if it's an %ENV lookup, we may get it on the fly */
 209                  || (HvNAME(hv) && strEQ(HvNAME(hv),ENV_HV_NAME))
 210 #endif
 211                                                                   )
 212             Newz(503,xhv->xhv_array, sizeof(HE*) * (xhv->xhv_max + 1), char);
 213         else
 214             return 0;
 215     }
 216
 217     key = SvPV(keysv, klen);
 218
 219     if (!hash)
 220         PERL_HASH(hash, key, klen);
 221
 222     entry = ((HE**)xhv->xhv_array)[hash & (I32) xhv->xhv_max];
 223     for (; entry; entry = HeNEXT(entry)) {
 224         if (HeHASH(entry) != hash)              /* strings can't be equal */
 225             continue;
 226         if (HeKLEN(entry) != klen)
 227             continue;
 228         if (memNE(HeKEY(entry),key,klen))       /* is this it? */
 229             continue;
 230         return entry;
 231     }
 232 #ifdef DYNAMIC_ENV_FETCH  /* %ENV lookup?  If so, try to fetch the value now */
 233     if (HvNAME(hv) && strEQ(HvNAME(hv),ENV_HV_NAME)) {
 234       char *gotenv;
 235
 236       if ((gotenv = PerlEnv_getenv(key)) != Nullch) {
 237         sv = newSVpv(gotenv,strlen(gotenv));
 238         SvTAINTED_on(sv);
 239         return hv_store_ent(hv,keysv,sv,hash);
 240       }
 241     }
 242 #endif
 243     if (lval) {         /* gonna assign to this, so it better be there */
 244         sv = NEWSV(61,0);
 245         return hv_store_ent(hv,keysv,sv,hash);
 246     }
 247     return 0;
 248 }
 249
 250 static void
 251 hv_magic_check (HV *hv, bool *needs_copy, bool *needs_store)
 252 {
 253     MAGIC *mg = SvMAGIC(hv);
 254     *needs_copy = FALSE;
 255     *needs_store = TRUE;
 256     while (mg) {
 257         if (isUPPER(mg->mg_type)) {
 258             *needs_copy = TRUE;
 259             switch (mg->mg_type) {
 260             case 'P':
 261             case 'S':
 262                 *needs_store = FALSE;
 263             }
 264         }
 265         mg = mg->mg_moremagic;
 266     }
 267 }
 268
 269 SV**
 270 hv_store(HV *hv, char *key, U32 klen, SV *val, register U32 hash)
 271 {
 272     register XPVHV* xhv;
 273     register I32 i;
 274     register HE *entry;
 275     register HE **oentry;
 276
 277     if (!hv)
 278         return 0;
 279
 280     xhv = (XPVHV*)SvANY(hv);
 281     if (SvMAGICAL(hv)) {
 282         bool needs_copy;
 283         bool needs_store;
 284         hv_magic_check (hv, &needs_copy, &needs_store);
 285         if (needs_copy) {
 286             mg_copy((SV*)hv, val, key, klen);
 287             if (!xhv->xhv_array && !needs_store)
 288                 return 0;
 289 #ifdef ENV_IS_CASELESS
 290             else if (mg_find((SV*)hv,'E')) {
 291                 SV *sv = sv_2mortal(newSVpv(key,klen));
 292                 key = strupr(SvPVX(sv));
 293                 hash = 0;
 294             }
 295 #endif
 296         }
 297     }
 298     if (!hash)
 299         PERL_HASH(hash, key, klen);
 300
 301     if (!xhv->xhv_array)
 302         Newz(505, xhv->xhv_array, sizeof(HE**) * (xhv->xhv_max + 1), char);
 303
 304     oentry = &((HE**)xhv->xhv_array)[hash & (I32) xhv->xhv_max];
 305     i = 1;
 306
 307     for (entry = *oentry; entry; i=0, entry = HeNEXT(entry)) {
 308         if (HeHASH(entry) != hash)              /* strings can't be equal */
 309             continue;
 310         if (HeKLEN(entry) != klen)
 311             continue;
 312         if (memNE(HeKEY(entry),key,klen))       /* is this it? */
 313             continue;
 314         SvREFCNT_dec(HeVAL(entry));
 315         HeVAL(entry) = val;
 316         return &HeVAL(entry);
 317     }
 318
 319     entry = new_he();
 320     if (HvSHAREKEYS(hv))
 321         HeKEY_hek(entry) = share_hek(key, klen, hash);
 322     else                                       /* gotta do the real thing */
 323         HeKEY_hek(entry) = save_hek(key, klen, hash);
 324     HeVAL(entry) = val;
 325     HeNEXT(entry) = *oentry;
 326     *oentry = entry;
 327
 328     xhv->xhv_keys++;
 329     if (i) {                            /* initial entry? */
 330         ++xhv->xhv_fill;
 331         if (xhv->xhv_keys > xhv->xhv_max)
 332             hsplit(hv);
 333     }
 334
 335     return &HeVAL(entry);
 336 }
 337
 338 HE *
 339 hv_store_ent(HV *hv, SV *keysv, SV *val, register U32 hash)
 340 {
 341     register XPVHV* xhv;
 342     register char *key;
 343     STRLEN klen;
 344     register I32 i;
 345     register HE *entry;
 346     register HE **oentry;
 347
 348     if (!hv)
 349         return 0;
 350
 351     xhv = (XPVHV*)SvANY(hv);
 352     if (SvMAGICAL(hv)) {
 353         dTHR;
 354         bool needs_copy;
 355         bool needs_store;
 356         hv_magic_check (hv, &needs_copy, &needs_store);
 357         if (needs_copy) {
 358             bool save_taint = tainted;
 359             if (tainting)
 360                 tainted = SvTAINTED(keysv);
 361             keysv = sv_2mortal(newSVsv(keysv));
 362             mg_copy((SV*)hv, val, (char*)keysv, HEf_SVKEY);
 363             TAINT_IF(save_taint);
 364             if (!xhv->xhv_array && !needs_store)
 365                 return Nullhe;
 366 #ifdef ENV_IS_CASELESS
 367             else if (mg_find((SV*)hv,'E')) {
 368                 key = SvPV(keysv, klen);
 369                 keysv = sv_2mortal(newSVpv(key,klen));
 370                 (void)strupr(SvPVX(keysv));
 371                 hash = 0;
 372             }
 373 #endif
 374         }
 375     }
 376
 377     key = SvPV(keysv, klen);
 378
 379     if (!hash)
 380         PERL_HASH(hash, key, klen);
 381
 382     if (!xhv->xhv_array)
 383         Newz(505, xhv->xhv_array, sizeof(HE**) * (xhv->xhv_max + 1), char);
 384
 385     oentry = &((HE**)xhv->xhv_array)[hash & (I32) xhv->xhv_max];
 386     i = 1;
 387
 388     for (entry = *oentry; entry; i=0, entry = HeNEXT(entry)) {
 389         if (HeHASH(entry) != hash)              /* strings can't be equal */
 390             continue;
 391         if (HeKLEN(entry) != klen)
 392             continue;
 393         if (memNE(HeKEY(entry),key,klen))       /* is this it? */
 394             continue;
 395         SvREFCNT_dec(HeVAL(entry));
 396         HeVAL(entry) = val;
 397         return entry;
 398     }
 399
 400     entry = new_he();
 401     if (HvSHAREKEYS(hv))
 402         HeKEY_hek(entry) = share_hek(key, klen, hash);
 403     else                                       /* gotta do the real thing */
 404         HeKEY_hek(entry) = save_hek(key, klen, hash);
 405     HeVAL(entry) = val;
 406     HeNEXT(entry) = *oentry;
 407     *oentry = entry;
 408
 409     xhv->xhv_keys++;
 410     if (i) {                            /* initial entry? */
 411         ++xhv->xhv_fill;
 412         if (xhv->xhv_keys > xhv->xhv_max)
 413             hsplit(hv);
 414     }
 415
 416     return entry;
 417 }
 418
 419 SV *
 420 hv_delete(HV *hv, char *key, U32 klen, I32 flags)
 421 {
 422     register XPVHV* xhv;
 423     register I32 i;
 424     register U32 hash;
 425     register HE *entry;
 426     register HE **oentry;
 427     SV **svp;
 428     SV *sv;
 429
 430     if (!hv)
 431         return Nullsv;
 432     if (SvRMAGICAL(hv)) {
 433         bool needs_copy;
 434         bool needs_store;
 435         hv_magic_check (hv, &needs_copy, &needs_store);
 436
 437         if (needs_copy && (svp = hv_fetch(hv, key, klen, TRUE))) {
 438             sv = *svp;
 439             mg_clear(sv);
 440             if (!needs_store) {
 441                 if (mg_find(sv, 'p')) {
 442                     sv_unmagic(sv, 'p');        /* No longer an element */
 443                     return sv;
 444                 }
 445                 return Nullsv;          /* element cannot be deleted */
 446             }
 447 #ifdef ENV_IS_CASELESS
 448             else if (mg_find((SV*)hv,'E')) {
 449                 sv = sv_2mortal(newSVpv(key,klen));
 450                 key = strupr(SvPVX(sv));
 451             }
 452 #endif
 453         }
 454     }
 455     xhv = (XPVHV*)SvANY(hv);
 456     if (!xhv->xhv_array)
 457         return Nullsv;
 458
 459     PERL_HASH(hash, key, klen);
 460
 461     oentry = &((HE**)xhv->xhv_array)[hash & (I32) xhv->xhv_max];
 462     entry = *oentry;
 463     i = 1;
 464     for (; entry; i=0, oentry = &HeNEXT(entry), entry = *oentry) {
 465         if (HeHASH(entry) != hash)              /* strings can't be equal */
 466             continue;
 467         if (HeKLEN(entry) != klen)
 468             continue;
 469         if (memNE(HeKEY(entry),key,klen))       /* is this it? */
 470             continue;
 471         *oentry = HeNEXT(entry);
 472         if (i && !*oentry)
 473             xhv->xhv_fill--;
 474         if (flags & G_DISCARD)
 475             sv = Nullsv;
 476         else
 477             sv = sv_mortalcopy(HeVAL(entry));
 478         if (entry == xhv->xhv_eiter)
 479             HvLAZYDEL_on(hv);
 480         else
 481             hv_free_ent(hv, entry);
 482         --xhv->xhv_keys;
 483         return sv;
 484     }
 485     return Nullsv;
 486 }
 487
 488 SV *
 489 hv_delete_ent(HV *hv, SV *keysv, I32 flags, U32 hash)
 490 {
 491     register XPVHV* xhv;
 492     register I32 i;
 493     register char *key;
 494     STRLEN klen;
 495     register HE *entry;
 496     register HE **oentry;
 497     SV *sv;
 498
 499     if (!hv)
 500         return Nullsv;
 501     if (SvRMAGICAL(hv)) {
 502         bool needs_copy;
 503         bool needs_store;
 504         hv_magic_check (hv, &needs_copy, &needs_store);
 505
 506         if (needs_copy && (entry = hv_fetch_ent(hv, keysv, TRUE, hash))) {
 507             sv = HeVAL(entry);
 508             mg_clear(sv);
 509             if (!needs_store) {
 510                 if (mg_find(sv, 'p')) {
 511                     sv_unmagic(sv, 'p');        /* No longer an element */
 512                     return sv;
 513                 }
 514                 return Nullsv;          /* element cannot be deleted */
 515             }
 516 #ifdef ENV_IS_CASELESS
 517             else if (mg_find((SV*)hv,'E')) {
 518                 key = SvPV(keysv, klen);
 519                 keysv = sv_2mortal(newSVpv(key,klen));
 520                 (void)strupr(SvPVX(keysv));
 521                 hash = 0;
 522             }
 523 #endif
 524         }
 525     }
 526     xhv = (XPVHV*)SvANY(hv);
 527     if (!xhv->xhv_array)
 528         return Nullsv;
 529
 530     key = SvPV(keysv, klen);
 531
 532     if (!hash)
 533         PERL_HASH(hash, key, klen);
 534
 535     oentry = &((HE**)xhv->xhv_array)[hash & (I32) xhv->xhv_max];
 536     entry = *oentry;
 537     i = 1;
 538     for (; entry; i=0, oentry = &HeNEXT(entry), entry = *oentry) {
 539         if (HeHASH(entry) != hash)              /* strings can't be equal */
 540             continue;
 541         if (HeKLEN(entry) != klen)
 542             continue;
 543         if (memNE(HeKEY(entry),key,klen))       /* is this it? */
 544             continue;
 545         *oentry = HeNEXT(entry);
 546         if (i && !*oentry)
 547             xhv->xhv_fill--;
 548         if (flags & G_DISCARD)
 549             sv = Nullsv;
 550         else
 551             sv = sv_mortalcopy(HeVAL(entry));
 552         if (entry == xhv->xhv_eiter)
 553             HvLAZYDEL_on(hv);
 554         else
 555             hv_free_ent(hv, entry);
 556         --xhv->xhv_keys;
 557         return sv;
 558     }
 559     return Nullsv;
 560 }
 561
 562 bool
 563 hv_exists(HV *hv, char *key, U32 klen)
 564 {
 565     register XPVHV* xhv;
 566     register U32 hash;
 567     register HE *entry;
 568     SV *sv;
 569
 570     if (!hv)
 571         return 0;
 572
 573     if (SvRMAGICAL(hv)) {
 574         if (mg_find((SV*)hv,'P')) {
 575             dTHR;
 576             sv = sv_newmortal();
 577             mg_copy((SV*)hv, sv, key, klen);
 578             magic_existspack(sv, mg_find(sv, 'p'));
 579             return SvTRUE(sv);
 580         }
 581 #ifdef ENV_IS_CASELESS
 582         else if (mg_find((SV*)hv,'E')) {
 583             sv = sv_2mortal(newSVpv(key,klen));
 584             key = strupr(SvPVX(sv));
 585         }
 586 #endif
 587     }
 588
 589     xhv = (XPVHV*)SvANY(hv);
 590     if (!xhv->xhv_array)
 591         return 0;
 592
 593     PERL_HASH(hash, key, klen);
 594
 595     entry = ((HE**)xhv->xhv_array)[hash & (I32) xhv->xhv_max];
 596     for (; entry; entry = HeNEXT(entry)) {
 597         if (HeHASH(entry) != hash)              /* strings can't be equal */
 598             continue;
 599         if (HeKLEN(entry) != klen)
 600             continue;
 601         if (memNE(HeKEY(entry),key,klen))       /* is this it? */
 602             continue;
 603         return TRUE;
 604     }
 605     return FALSE;
 606 }
 607
 608
 609 bool
 610 hv_exists_ent(HV *hv, SV *keysv, U32 hash)
 611 {
 612     register XPVHV* xhv;
 613     register char *key;
 614     STRLEN klen;
 615     register HE *entry;
 616     SV *sv;
 617
 618     if (!hv)
 619         return 0;
 620
 621     if (SvRMAGICAL(hv)) {
 622         if (mg_find((SV*)hv,'P')) {
 623             dTHR;               /* just for SvTRUE */
 624             sv = sv_newmortal();
 625             keysv = sv_2mortal(newSVsv(keysv));
 626             mg_copy((SV*)hv, sv, (char*)keysv, HEf_SVKEY);
 627             magic_existspack(sv, mg_find(sv, 'p'));
 628             return SvTRUE(sv);
 629         }
 630 #ifdef ENV_IS_CASELESS
 631         else if (mg_find((SV*)hv,'E')) {
 632             key = SvPV(keysv, klen);
 633             keysv = sv_2mortal(newSVpv(key,klen));
 634             (void)strupr(SvPVX(keysv));
 635             hash = 0;
 636         }
 637 #endif
 638     }
 639
 640     xhv = (XPVHV*)SvANY(hv);
 641     if (!xhv->xhv_array)
 642         return 0;
 643
 644     key = SvPV(keysv, klen);
 645     if (!hash)
 646         PERL_HASH(hash, key, klen);
 647
 648     entry = ((HE**)xhv->xhv_array)[hash & (I32) xhv->xhv_max];
 649     for (; entry; entry = HeNEXT(entry)) {
 650         if (HeHASH(entry) != hash)              /* strings can't be equal */
 651             continue;
 652         if (HeKLEN(entry) != klen)
 653             continue;
 654         if (memNE(HeKEY(entry),key,klen))       /* is this it? */
 655             continue;
 656         return TRUE;
 657     }
 658     return FALSE;
 659 }
 660
 661 STATIC void
 662 hsplit(HV *hv)
 663 {
 664     register XPVHV* xhv = (XPVHV*)SvANY(hv);
 665     I32 oldsize = (I32) xhv->xhv_max + 1; /* sic(k) */
 666     register I32 newsize = oldsize * 2;
 667     register I32 i;
 668     register HE **a;
 669     register HE **b;
 670     register HE *entry;
 671     register HE **oentry;
 672 #ifndef STRANGE_MALLOC
 673     I32 tmp;
 674 #endif
 675
 676     a = (HE**)xhv->xhv_array;
 677     nomemok = TRUE;
 678 #ifdef STRANGE_MALLOC
 679     Renew(a, newsize, HE*);
 680     if (!a) {
 681       nomemok = FALSE;
 682       return;
 683     }
 684 #else
 685     i = newsize * sizeof(HE*);
 686 #define MALLOC_OVERHEAD 16
 687     tmp = MALLOC_OVERHEAD;
 688     while (tmp - MALLOC_OVERHEAD < i)
 689         tmp += tmp;
 690     tmp -= MALLOC_OVERHEAD;
 691     tmp /= sizeof(HE*);
 692     assert(tmp >= newsize);
 693     New(2,a, tmp, HE*);
 694     if (!a) {
 695       nomemok = FALSE;
 696       return;
 697     }
 698     Copy(xhv->xhv_array, a, oldsize, HE*);
 699     if (oldsize >= 64) {
 700         offer_nice_chunk(xhv->xhv_array,
 701                          oldsize * sizeof(HE*) * 2 - MALLOC_OVERHEAD);
 702     }
 703     else
 704         Safefree(xhv->xhv_array);
 705 #endif
 706
 707     nomemok = FALSE;
 708     Zero(&a[oldsize], oldsize, HE*);            /* zero 2nd half*/
 709     xhv->xhv_max = --newsize;
 710     xhv->xhv_array = (char*)a;
 711
 712     for (i=0; i<oldsize; i++,a++) {
 713         if (!*a)                                /* non-existent */
 714             continue;
 715         b = a+oldsize;
 716         for (oentry = a, entry = *a; entry; entry = *oentry) {
 717             if ((HeHASH(entry) & newsize) != i) {
 718                 *oentry = HeNEXT(entry);
 719                 HeNEXT(entry) = *b;
 720                 if (!*b)
 721                     xhv->xhv_fill++;
 722                 *b = entry;
 723                 continue;
 724             }
 725             else
 726                 oentry = &HeNEXT(entry);
 727         }
 728         if (!*a)                                /* everything moved */
 729             xhv->xhv_fill--;
 730     }
 731 }
 732
 733 void
 734 hv_ksplit(HV *hv, IV newmax)
 735 {
 736     register XPVHV* xhv = (XPVHV*)SvANY(hv);
 737     I32 oldsize = (I32) xhv->xhv_max + 1; /* sic(k) */
 738     register I32 newsize;
 739     register I32 i;
 740     register I32 j;
 741     register HE **a;
 742     register HE *entry;
 743     register HE **oentry;
 744
 745     newsize = (I32) newmax;                     /* possible truncation here */
 746     if (newsize != newmax || newmax <= oldsize)
 747         return;
 748     while ((newsize & (1 + ~newsize)) != newsize) {
 749         newsize &= ~(newsize & (1 + ~newsize)); /* get proper power of 2 */
 750     }
 751     if (newsize < newmax)
 752         newsize *= 2;
 753     if (newsize < newmax)
 754         return;                                 /* overflow detection */
 755
 756     a = (HE**)xhv->xhv_array;
 757     if (a) {
 758         nomemok = TRUE;
 759 #ifdef STRANGE_MALLOC
 760         Renew(a, newsize, HE*);
 761         if (!a) {
 762           nomemok = FALSE;
 763           return;
 764         }
 765 #else
 766         i = newsize * sizeof(HE*);
 767         j = MALLOC_OVERHEAD;
 768         while (j - MALLOC_OVERHEAD < i)
 769             j += j;
 770         j -= MALLOC_OVERHEAD;
 771         j /= sizeof(HE*);
 772         assert(j >= newsize);
 773         New(2, a, j, HE*);
 774         if (!a) {
 775           nomemok = FALSE;
 776           return;
 777         }
 778         Copy(xhv->xhv_array, a, oldsize, HE*);
 779         if (oldsize >= 64) {
 780             offer_nice_chunk(xhv->xhv_array,
 781                              oldsize * sizeof(HE*) * 2 - MALLOC_OVERHEAD);
 782         }
 783         else
 784             Safefree(xhv->xhv_array);
 785 #endif
 786         nomemok = FALSE;
 787         Zero(&a[oldsize], newsize-oldsize, HE*); /* zero 2nd half*/
 788     }
 789     else {
 790         Newz(0, a, newsize, HE*);
 791     }
 792     xhv->xhv_max = --newsize;
 793     xhv->xhv_array = (char*)a;
 794     if (!xhv->xhv_fill)                         /* skip rest if no entries */
 795         return;
 796
 797     for (i=0; i<oldsize; i++,a++) {
 798         if (!*a)                                /* non-existent */
 799             continue;
 800         for (oentry = a, entry = *a; entry; entry = *oentry) {
 801             if ((j = (HeHASH(entry) & newsize)) != i) {
 802                 j -= i;
 803                 *oentry = HeNEXT(entry);
 804                 if (!(HeNEXT(entry) = a[j]))
 805                     xhv->xhv_fill++;
 806                 a[j] = entry;
 807                 continue;
 808             }
 809             else
 810                 oentry = &HeNEXT(entry);
 811         }
 812         if (!*a)                                /* everything moved */
 813             xhv->xhv_fill--;
 814     }
 815 }
 816
 817 HV *
 818 newHV(void)
 819 {
 820     register HV *hv;
 821     register XPVHV* xhv;
 822
 823     hv = (HV*)NEWSV(502,0);
 824     sv_upgrade((SV *)hv, SVt_PVHV);
 825     xhv = (XPVHV*)SvANY(hv);
 826     SvPOK_off(hv);
 827     SvNOK_off(hv);
 828 #ifndef NODEFAULT_SHAREKEYS
 829     HvSHAREKEYS_on(hv);         /* key-sharing on by default */
 830 #endif
 831     xhv->xhv_max = 7;           /* start with 8 buckets */
 832     xhv->xhv_fill = 0;
 833     xhv->xhv_pmroot = 0;
 834     (void)hv_iterinit(hv);      /* so each() will start off right */
 835     return hv;
 836 }
 837
 838 void
 839 hv_free_ent(HV *hv, register HE *entry)
 840 {
 841     SV *val;
 842
 843     if (!entry)
 844         return;
 845     val = HeVAL(entry);
 846     if (val && isGV(val) && GvCVu(val) && HvNAME(hv))
 847         sub_generation++;       /* may be deletion of method from stash */
 848     SvREFCNT_dec(val);
 849     if (HeKLEN(entry) == HEf_SVKEY) {
 850         SvREFCNT_dec(HeKEY_sv(entry));
 851         Safefree(HeKEY_hek(entry));
 852     }
 853     else if (HvSHAREKEYS(hv))
 854         unshare_hek(HeKEY_hek(entry));
 855     else
 856         Safefree(HeKEY_hek(entry));
 857     del_he(entry);
 858 }
 859
 860 void
 861 hv_delayfree_ent(HV *hv, register HE *entry)
 862 {
 863     if (!entry)
 864         return;
 865     if (isGV(HeVAL(entry)) && GvCVu(HeVAL(entry)) && HvNAME(hv))
 866         sub_generation++;       /* may be deletion of method from stash */
 867     sv_2mortal(HeVAL(entry));   /* free between statements */
 868     if (HeKLEN(entry) == HEf_SVKEY) {
 869         sv_2mortal(HeKEY_sv(entry));
 870         Safefree(HeKEY_hek(entry));
 871     }
 872     else if (HvSHAREKEYS(hv))
 873         unshare_hek(HeKEY_hek(entry));
 874     else
 875         Safefree(HeKEY_hek(entry));
 876     del_he(entry);
 877 }
 878
 879 void
 880 hv_clear(HV *hv)
 881 {
 882     register XPVHV* xhv;
 883     if (!hv)
 884         return;
 885     xhv = (XPVHV*)SvANY(hv);
 886     hfreeentries(hv);
 887     xhv->xhv_fill = 0;
 888     xhv->xhv_keys = 0;
 889     if (xhv->xhv_array)
 890         (void)memzero(xhv->xhv_array, (xhv->xhv_max + 1) * sizeof(HE*));
 891
 892     if (SvRMAGICAL(hv))
 893         mg_clear((SV*)hv);
 894 }
 895
 896 STATIC void
 897 hfreeentries(HV *hv)
 898 {
 899     register HE **array;
 900     register HE *entry;
 901     register HE *oentry = Null(HE*);
 902     I32 riter;
 903     I32 max;
 904
 905     if (!hv)
 906         return;
 907     if (!HvARRAY(hv))
 908         return;
 909
 910     riter = 0;
 911     max = HvMAX(hv);
 912     array = HvARRAY(hv);
 913     entry = array[0];
 914     for (;;) {
 915         if (entry) {
 916             oentry = entry;
 917             entry = HeNEXT(entry);
 918             hv_free_ent(hv, oentry);
 919         }
 920         if (!entry) {
 921             if (++riter > max)
 922                 break;
 923             entry = array[riter];
 924         }
 925     }
 926     (void)hv_iterinit(hv);
 927 }
 928
 929 void
 930 hv_undef(HV *hv)
 931 {
 932     register XPVHV* xhv;
 933     if (!hv)
 934         return;
 935     xhv = (XPVHV*)SvANY(hv);
 936     hfreeentries(hv);
 937     Safefree(xhv->xhv_array);
 938     if (HvNAME(hv)) {
 939         Safefree(HvNAME(hv));
 940         HvNAME(hv) = 0;
 941     }
 942     xhv->xhv_array = 0;
 943     xhv->xhv_max = 7;           /* it's a normal hash */
 944     xhv->xhv_fill = 0;
 945     xhv->xhv_keys = 0;
 946
 947     if (SvRMAGICAL(hv))
 948         mg_clear((SV*)hv);
 949 }
 950
 951 I32
 952 hv_iterinit(HV *hv)
 953 {
 954     register XPVHV* xhv;
 955     HE *entry;
 956
 957     if (!hv)
 958         croak("Bad hash");
 959     xhv = (XPVHV*)SvANY(hv);
 960     entry = xhv->xhv_eiter;
 961 #ifdef DYNAMIC_ENV_FETCH  /* set up %ENV for iteration */
 962     if (HvNAME(hv) && strEQ(HvNAME(hv), ENV_HV_NAME))
 963         prime_env_iter();
 964 #endif
 965     if (entry && HvLAZYDEL(hv)) {       /* was deleted earlier? */
 966         HvLAZYDEL_off(hv);
 967         hv_free_ent(hv, entry);
 968     }
 969     xhv->xhv_riter = -1;
 970     xhv->xhv_eiter = Null(HE*);
 971     return xhv->xhv_keys;       /* used to be xhv->xhv_fill before 5.004_65 */
 972 }
 973
 974 HE *
 975 hv_iternext(HV *hv)
 976 {
 977     register XPVHV* xhv;
 978     register HE *entry;
 979     HE *oldentry;
 980     MAGIC* mg;
 981
 982     if (!hv)
 983         croak("Bad hash");
 984     xhv = (XPVHV*)SvANY(hv);
 985     oldentry = entry = xhv->xhv_eiter;
 986
 987     if (SvRMAGICAL(hv) && (mg = mg_find((SV*)hv,'P'))) {
 988         SV *key = sv_newmortal();
 989         if (entry) {
 990             sv_setsv(key, HeSVKEY_force(entry));
 991             SvREFCNT_dec(HeSVKEY(entry));       /* get rid of previous key */
 992         }
 993         else {
 994             char *k;
 995             HEK *hek;
 996
 997             xhv->xhv_eiter = entry = new_he();  /* one HE per MAGICAL hash */
 998             Zero(entry, 1, HE);
 999             Newz(54, k, HEK_BASESIZE + sizeof(SV*), char);
1000             hek = (HEK*)k;
1001             HeKEY_hek(entry) = hek;
1002             HeKLEN(entry) = HEf_SVKEY;
1003         }
1004         magic_nextpack((SV*) hv,mg,key);
1005         if (SvOK(key)) {
1006             /* force key to stay around until next time */
1007             HeSVKEY_set(entry, SvREFCNT_inc(key));
1008             return entry;               /* beware, hent_val is not set */
1009         }
1010         if (HeVAL(entry))
1011             SvREFCNT_dec(HeVAL(entry));
1012         Safefree(HeKEY_hek(entry));
1013         del_he(entry);
1014         xhv->xhv_eiter = Null(HE*);
1015         return Null(HE*);
1016     }
1017
1018     if (!xhv->xhv_array)
1019         Newz(506,xhv->xhv_array, sizeof(HE*) * (xhv->xhv_max + 1), char);
1020     if (entry)
1021         entry = HeNEXT(entry);
1022     while (!entry) {
1023         ++xhv->xhv_riter;
1024         if (xhv->xhv_riter > xhv->xhv_max) {
1025             xhv->xhv_riter = -1;
1026             break;
1027         }
1028         entry = ((HE**)xhv->xhv_array)[xhv->xhv_riter];
1029     }
1030
1031     if (oldentry && HvLAZYDEL(hv)) {            /* was deleted earlier? */
1032         HvLAZYDEL_off(hv);
1033         hv_free_ent(hv, oldentry);
1034     }
1035
1036     xhv->xhv_eiter = entry;
1037     return entry;
1038 }
1039
1040 char *
1041 hv_iterkey(register HE *entry, I32 *retlen)
1042 {
1043     if (HeKLEN(entry) == HEf_SVKEY) {
1044         STRLEN len;
1045         char *p = SvPV(HeKEY_sv(entry), len);
1046         *retlen = len;
1047         return p;
1048     }
1049     else {
1050         *retlen = HeKLEN(entry);
1051         return HeKEY(entry);
1052     }
1053 }
1054
1055 /* unlike hv_iterval(), this always returns a mortal copy of the key */
1056 SV *
1057 hv_iterkeysv(register HE *entry)
1058 {
1059     if (HeKLEN(entry) == HEf_SVKEY)
1060         return sv_mortalcopy(HeKEY_sv(entry));
1061     else
1062         return sv_2mortal(newSVpv((HeKLEN(entry) ? HeKEY(entry) : ""),
1063                                   HeKLEN(entry)));
1064 }
1065
1066 SV *
1067 hv_iterval(HV *hv, register HE *entry)
1068 {
1069     if (SvRMAGICAL(hv)) {
1070         if (mg_find((SV*)hv,'P')) {
1071             SV* sv = sv_newmortal();
1072             if (HeKLEN(entry) == HEf_SVKEY)
1073                 mg_copy((SV*)hv, sv, (char*)HeKEY_sv(entry), HEf_SVKEY);
1074             else mg_copy((SV*)hv, sv, HeKEY(entry), HeKLEN(entry));
1075             return sv;
1076         }
1077     }
1078     return HeVAL(entry);
1079 }
1080
1081 SV *
1082 hv_iternextsv(HV *hv, char **key, I32 *retlen)
1083 {
1084     HE *he;
1085     if ( (he = hv_iternext(hv)) == NULL)
1086         return NULL;
1087     *key = hv_iterkey(he, retlen);
1088     return hv_iterval(hv, he);
1089 }
1090
1091 void
1092 hv_magic(HV *hv, GV *gv, int how)
1093 {
1094     sv_magic((SV*)hv, (SV*)gv, how, Nullch, 0);
1095 }
1096
1097 char*
1098 sharepvn(char *sv, I32 len, U32 hash)
1099 {
1100     return HEK_KEY(share_hek(sv, len, hash));
1101 }
1102
1103 /* possibly free a shared string if no one has access to it
1104  * len and hash must both be valid for str.
1105  */
1106 void
1107 unsharepvn(char *str, I32 len, U32 hash)
1108 {
1109     register XPVHV* xhv;
1110     register HE *entry;
1111     register HE **oentry;
1112     register I32 i = 1;
1113     I32 found = 0;
1114
1115     /* what follows is the moral equivalent of:
1116     if ((Svp = hv_fetch(strtab, tmpsv, FALSE, hash))) {
1117         if (--*Svp == Nullsv)
1118             hv_delete(strtab, str, len, G_DISCARD, hash);
1119     } */
1120     xhv = (XPVHV*)SvANY(strtab);
1121     /* assert(xhv_array != 0) */
1122     oentry = &((HE**)xhv->xhv_array)[hash & (I32) xhv->xhv_max];
1123     for (entry = *oentry; entry; i=0, oentry = &HeNEXT(entry), entry = *oentry) {
1124         if (HeHASH(entry) != hash)              /* strings can't be equal */
1125             continue;
1126         if (HeKLEN(entry) != len)
1127             continue;
1128         if (memNE(HeKEY(entry),str,len))        /* is this it? */
1129             continue;
1130         found = 1;
1131         if (--HeVAL(entry) == Nullsv) {
1132             *oentry = HeNEXT(entry);
1133             if (i && !*oentry)
1134                 xhv->xhv_fill--;
1135             Safefree(HeKEY_hek(entry));
1136             del_he(entry);
1137             --xhv->xhv_keys;
1138         }
1139         break;
1140     }
1141
1142     if (!found)
1143         warn("Attempt to free non-existent shared string");
1144 }
1145
1146 /* get a (constant) string ptr from the global string table
1147  * string will get added if it is not already there.
1148  * len and hash must both be valid for str.
1149  */
1150 HEK *
1151 share_hek(char *str, I32 len, register U32 hash)
1152 {
1153     register XPVHV* xhv;
1154     register HE *entry;
1155     register HE **oentry;
1156     register I32 i = 1;
1157     I32 found = 0;
1158
1159     /* what follows is the moral equivalent of:
1160
1161     if (!(Svp = hv_fetch(strtab, str, len, FALSE)))
1162         hv_store(strtab, str, len, Nullsv, hash);
1163     */
1164     xhv = (XPVHV*)SvANY(strtab);
1165     /* assert(xhv_array != 0) */
1166     oentry = &((HE**)xhv->xhv_array)[hash & (I32) xhv->xhv_max];
1167     for (entry = *oentry; entry; i=0, entry = HeNEXT(entry)) {
1168         if (HeHASH(entry) != hash)              /* strings can't be equal */
1169             continue;
1170         if (HeKLEN(entry) != len)
1171             continue;
1172         if (memNE(HeKEY(entry),str,len))        /* is this it? */
1173             continue;
1174         found = 1;
1175         break;
1176     }
1177     if (!found) {
1178         entry = new_he();
1179         HeKEY_hek(entry) = save_hek(str, len, hash);
1180         HeVAL(entry) = Nullsv;
1181         HeNEXT(entry) = *oentry;
1182         *oentry = entry;
1183         xhv->xhv_keys++;
1184         if (i) {                                /* initial entry? */
1185             ++xhv->xhv_fill;
1186             if (xhv->xhv_keys > xhv->xhv_max)
1187                 hsplit(strtab);
1188         }
1189     }
1190
1191     ++HeVAL(entry);                             /* use value slot as REFCNT */
1192     return HeKEY_hek(entry);
1193 }
1194
1195
1196