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 = (HE**)xhv->xhv_array;
 669     register HE **b;
 670     register HE *entry;
 671     register HE **oentry;
 672 #ifndef STRANGE_MALLOC
 673     I32 tmp;
 674 #endif
 675
 676     nomemok = TRUE;
 677 #if defined(STRANGE_MALLOC) || defined(MYMALLOC)
 678     Renew(a, newsize, HE*);
 679     if (!a) {
 680       nomemok = FALSE;
 681       return;
 682     }
 683 #else
 684     i = newsize * sizeof(HE*);
 685 #define MALLOC_OVERHEAD 16
 686     tmp = MALLOC_OVERHEAD;
 687     while (tmp - MALLOC_OVERHEAD < i)
 688         tmp += tmp;
 689     tmp -= MALLOC_OVERHEAD;
 690     tmp /= sizeof(HE*);
 691     assert(tmp >= newsize);
 692     New(2,a, tmp, HE*);
 693     if (!a) {
 694       nomemok = FALSE;
 695       return;
 696     }
 697     Copy(xhv->xhv_array, a, oldsize, HE*);
 698     if (oldsize >= 64) {
 699         offer_nice_chunk(xhv->xhv_array,
 700                          oldsize * sizeof(HE*) * 2 - MALLOC_OVERHEAD);
 701     }
 702     else
 703         Safefree(xhv->xhv_array);
 704 #endif
 705
 706     nomemok = FALSE;
 707     Zero(&a[oldsize], oldsize, HE*);            /* zero 2nd half*/
 708     xhv->xhv_max = --newsize;
 709     xhv->xhv_array = (char*)a;
 710
 711     for (i=0; i<oldsize; i++,a++) {
 712         if (!*a)                                /* non-existent */
 713             continue;
 714         b = a+oldsize;
 715         for (oentry = a, entry = *a; entry; entry = *oentry) {
 716             if ((HeHASH(entry) & newsize) != i) {
 717                 *oentry = HeNEXT(entry);
 718                 HeNEXT(entry) = *b;
 719                 if (!*b)
 720                     xhv->xhv_fill++;
 721                 *b = entry;
 722                 continue;
 723             }
 724             else
 725                 oentry = &HeNEXT(entry);
 726         }
 727         if (!*a)                                /* everything moved */
 728             xhv->xhv_fill--;
 729     }
 730 }
 731
 732 void
 733 hv_ksplit(HV *hv, IV newmax)
 734 {
 735     register XPVHV* xhv = (XPVHV*)SvANY(hv);
 736     I32 oldsize = (I32) xhv->xhv_max + 1; /* sic(k) */
 737     register I32 newsize;
 738     register I32 i;
 739     register I32 j;
 740     register HE **a;
 741     register HE *entry;
 742     register HE **oentry;
 743
 744     newsize = (I32) newmax;                     /* possible truncation here */
 745     if (newsize != newmax || newmax <= oldsize)
 746         return;
 747     while ((newsize & (1 + ~newsize)) != newsize) {
 748         newsize &= ~(newsize & (1 + ~newsize)); /* get proper power of 2 */
 749     }
 750     if (newsize < newmax)
 751         newsize *= 2;
 752     if (newsize < newmax)
 753         return;                                 /* overflow detection */
 754
 755     a = (HE**)xhv->xhv_array;
 756     if (a) {
 757         nomemok = TRUE;
 758 #if defined(STRANGE_MALLOC) || defined(MYMALLOC)
 759         Renew(a, newsize, HE*);
 760         if (!a) {
 761           nomemok = FALSE;
 762           return;
 763         }
 764 #else
 765         i = newsize * sizeof(HE*);
 766         j = MALLOC_OVERHEAD;
 767         while (j - MALLOC_OVERHEAD < i)
 768             j += j;
 769         j -= MALLOC_OVERHEAD;
 770         j /= sizeof(HE*);
 771         assert(j >= newsize);
 772         New(2, a, j, HE*);
 773         if (!a) {
 774           nomemok = FALSE;
 775           return;
 776         }
 777         Copy(xhv->xhv_array, a, oldsize, HE*);
 778         if (oldsize >= 64) {
 779             offer_nice_chunk(xhv->xhv_array,
 780                              oldsize * sizeof(HE*) * 2 - MALLOC_OVERHEAD);
 781         }
 782         else
 783             Safefree(xhv->xhv_array);
 784 #endif
 785         nomemok = FALSE;
 786         Zero(&a[oldsize], newsize-oldsize, HE*); /* zero 2nd half*/
 787     }
 788     else {
 789         Newz(0, a, newsize, HE*);
 790     }
 791     xhv->xhv_max = --newsize;
 792     xhv->xhv_array = (char*)a;
 793     if (!xhv->xhv_fill)                         /* skip rest if no entries */
 794         return;
 795
 796     for (i=0; i<oldsize; i++,a++) {
 797         if (!*a)                                /* non-existent */
 798             continue;
 799         for (oentry = a, entry = *a; entry; entry = *oentry) {
 800             if ((j = (HeHASH(entry) & newsize)) != i) {
 801                 j -= i;
 802                 *oentry = HeNEXT(entry);
 803                 if (!(HeNEXT(entry) = a[j]))
 804                     xhv->xhv_fill++;
 805                 a[j] = entry;
 806                 continue;
 807             }
 808             else
 809                 oentry = &HeNEXT(entry);
 810         }
 811         if (!*a)                                /* everything moved */
 812             xhv->xhv_fill--;
 813     }
 814 }
 815
 816 HV *
 817 newHV(void)
 818 {
 819     register HV *hv;
 820     register XPVHV* xhv;
 821
 822     hv = (HV*)NEWSV(502,0);
 823     sv_upgrade((SV *)hv, SVt_PVHV);
 824     xhv = (XPVHV*)SvANY(hv);
 825     SvPOK_off(hv);
 826     SvNOK_off(hv);
 827 #ifndef NODEFAULT_SHAREKEYS
 828     HvSHAREKEYS_on(hv);         /* key-sharing on by default */
 829 #endif
 830     xhv->xhv_max = 7;           /* start with 8 buckets */
 831     xhv->xhv_fill = 0;
 832     xhv->xhv_pmroot = 0;
 833     (void)hv_iterinit(hv);      /* so each() will start off right */
 834     return hv;
 835 }
 836
 837 void
 838 hv_free_ent(HV *hv, register HE *entry)
 839 {
 840     SV *val;
 841
 842     if (!entry)
 843         return;
 844     val = HeVAL(entry);
 845     if (val && isGV(val) && GvCVu(val) && HvNAME(hv))
 846         sub_generation++;       /* may be deletion of method from stash */
 847     SvREFCNT_dec(val);
 848     if (HeKLEN(entry) == HEf_SVKEY) {
 849         SvREFCNT_dec(HeKEY_sv(entry));
 850         Safefree(HeKEY_hek(entry));
 851     }
 852     else if (HvSHAREKEYS(hv))
 853         unshare_hek(HeKEY_hek(entry));
 854     else
 855         Safefree(HeKEY_hek(entry));
 856     del_he(entry);
 857 }
 858
 859 void
 860 hv_delayfree_ent(HV *hv, register HE *entry)
 861 {
 862     if (!entry)
 863         return;
 864     if (isGV(HeVAL(entry)) && GvCVu(HeVAL(entry)) && HvNAME(hv))
 865         sub_generation++;       /* may be deletion of method from stash */
 866     sv_2mortal(HeVAL(entry));   /* free between statements */
 867     if (HeKLEN(entry) == HEf_SVKEY) {
 868         sv_2mortal(HeKEY_sv(entry));
 869         Safefree(HeKEY_hek(entry));
 870     }
 871     else if (HvSHAREKEYS(hv))
 872         unshare_hek(HeKEY_hek(entry));
 873     else
 874         Safefree(HeKEY_hek(entry));
 875     del_he(entry);
 876 }
 877
 878 void
 879 hv_clear(HV *hv)
 880 {
 881     register XPVHV* xhv;
 882     if (!hv)
 883         return;
 884     xhv = (XPVHV*)SvANY(hv);
 885     hfreeentries(hv);
 886     xhv->xhv_fill = 0;
 887     xhv->xhv_keys = 0;
 888     if (xhv->xhv_array)
 889         (void)memzero(xhv->xhv_array, (xhv->xhv_max + 1) * sizeof(HE*));
 890
 891     if (SvRMAGICAL(hv))
 892         mg_clear((SV*)hv);
 893 }
 894
 895 STATIC void
 896 hfreeentries(HV *hv)
 897 {
 898     register HE **array;
 899     register HE *entry;
 900     register HE *oentry = Null(HE*);
 901     I32 riter;
 902     I32 max;
 903
 904     if (!hv)
 905         return;
 906     if (!HvARRAY(hv))
 907         return;
 908
 909     riter = 0;
 910     max = HvMAX(hv);
 911     array = HvARRAY(hv);
 912     entry = array[0];
 913     for (;;) {
 914         if (entry) {
 915             oentry = entry;
 916             entry = HeNEXT(entry);
 917             hv_free_ent(hv, oentry);
 918         }
 919         if (!entry) {
 920             if (++riter > max)
 921                 break;
 922             entry = array[riter];
 923         }
 924     }
 925     (void)hv_iterinit(hv);
 926 }
 927
 928 void
 929 hv_undef(HV *hv)
 930 {
 931     register XPVHV* xhv;
 932     if (!hv)
 933         return;
 934     xhv = (XPVHV*)SvANY(hv);
 935     hfreeentries(hv);
 936     Safefree(xhv->xhv_array);
 937     if (HvNAME(hv)) {
 938         Safefree(HvNAME(hv));
 939         HvNAME(hv) = 0;
 940     }
 941     xhv->xhv_array = 0;
 942     xhv->xhv_max = 7;           /* it's a normal hash */
 943     xhv->xhv_fill = 0;
 944     xhv->xhv_keys = 0;
 945
 946     if (SvRMAGICAL(hv))
 947         mg_clear((SV*)hv);
 948 }
 949
 950 I32
 951 hv_iterinit(HV *hv)
 952 {
 953     register XPVHV* xhv;
 954     HE *entry;
 955
 956     if (!hv)
 957         croak("Bad hash");
 958     xhv = (XPVHV*)SvANY(hv);
 959     entry = xhv->xhv_eiter;
 960 #ifdef DYNAMIC_ENV_FETCH  /* set up %ENV for iteration */
 961     if (HvNAME(hv) && strEQ(HvNAME(hv), ENV_HV_NAME))
 962         prime_env_iter();
 963 #endif
 964     if (entry && HvLAZYDEL(hv)) {       /* was deleted earlier? */
 965         HvLAZYDEL_off(hv);
 966         hv_free_ent(hv, entry);
 967     }
 968     xhv->xhv_riter = -1;
 969     xhv->xhv_eiter = Null(HE*);
 970     return xhv->xhv_keys;       /* used to be xhv->xhv_fill before 5.004_65 */
 971 }
 972
 973 HE *
 974 hv_iternext(HV *hv)
 975 {
 976     register XPVHV* xhv;
 977     register HE *entry;
 978     HE *oldentry;
 979     MAGIC* mg;
 980
 981     if (!hv)
 982         croak("Bad hash");
 983     xhv = (XPVHV*)SvANY(hv);
 984     oldentry = entry = xhv->xhv_eiter;
 985
 986     if (SvRMAGICAL(hv) && (mg = mg_find((SV*)hv,'P'))) {
 987         SV *key = sv_newmortal();
 988         if (entry) {
 989             sv_setsv(key, HeSVKEY_force(entry));
 990             SvREFCNT_dec(HeSVKEY(entry));       /* get rid of previous key */
 991         }
 992         else {
 993             char *k;
 994             HEK *hek;
 995
 996             xhv->xhv_eiter = entry = new_he();  /* one HE per MAGICAL hash */
 997             Zero(entry, 1, HE);
 998             Newz(54, k, HEK_BASESIZE + sizeof(SV*), char);
 999             hek = (HEK*)k;
1000             HeKEY_hek(entry) = hek;
1001             HeKLEN(entry) = HEf_SVKEY;
1002         }
1003         magic_nextpack((SV*) hv,mg,key);
1004         if (SvOK(key)) {
1005             /* force key to stay around until next time */
1006             HeSVKEY_set(entry, SvREFCNT_inc(key));
1007             return entry;               /* beware, hent_val is not set */
1008         }
1009         if (HeVAL(entry))
1010             SvREFCNT_dec(HeVAL(entry));
1011         Safefree(HeKEY_hek(entry));
1012         del_he(entry);
1013         xhv->xhv_eiter = Null(HE*);
1014         return Null(HE*);
1015     }
1016
1017     if (!xhv->xhv_array)
1018         Newz(506,xhv->xhv_array, sizeof(HE*) * (xhv->xhv_max + 1), char);
1019     if (entry)
1020         entry = HeNEXT(entry);
1021     while (!entry) {
1022         ++xhv->xhv_riter;
1023         if (xhv->xhv_riter > xhv->xhv_max) {
1024             xhv->xhv_riter = -1;
1025             break;
1026         }
1027         entry = ((HE**)xhv->xhv_array)[xhv->xhv_riter];
1028     }
1029
1030     if (oldentry && HvLAZYDEL(hv)) {            /* was deleted earlier? */
1031         HvLAZYDEL_off(hv);
1032         hv_free_ent(hv, oldentry);
1033     }
1034
1035     xhv->xhv_eiter = entry;
1036     return entry;
1037 }
1038
1039 char *
1040 hv_iterkey(register HE *entry, I32 *retlen)
1041 {
1042     if (HeKLEN(entry) == HEf_SVKEY) {
1043         STRLEN len;
1044         char *p = SvPV(HeKEY_sv(entry), len);
1045         *retlen = len;
1046         return p;
1047     }
1048     else {
1049         *retlen = HeKLEN(entry);
1050         return HeKEY(entry);
1051     }
1052 }
1053
1054 /* unlike hv_iterval(), this always returns a mortal copy of the key */
1055 SV *
1056 hv_iterkeysv(register HE *entry)
1057 {
1058     if (HeKLEN(entry) == HEf_SVKEY)
1059         return sv_mortalcopy(HeKEY_sv(entry));
1060     else
1061         return sv_2mortal(newSVpv((HeKLEN(entry) ? HeKEY(entry) : ""),
1062                                   HeKLEN(entry)));
1063 }
1064
1065 SV *
1066 hv_iterval(HV *hv, register HE *entry)
1067 {
1068     if (SvRMAGICAL(hv)) {
1069         if (mg_find((SV*)hv,'P')) {
1070             SV* sv = sv_newmortal();
1071             if (HeKLEN(entry) == HEf_SVKEY)
1072                 mg_copy((SV*)hv, sv, (char*)HeKEY_sv(entry), HEf_SVKEY);
1073             else mg_copy((SV*)hv, sv, HeKEY(entry), HeKLEN(entry));
1074             return sv;
1075         }
1076     }
1077     return HeVAL(entry);
1078 }
1079
1080 SV *
1081 hv_iternextsv(HV *hv, char **key, I32 *retlen)
1082 {
1083     HE *he;
1084     if ( (he = hv_iternext(hv)) == NULL)
1085         return NULL;
1086     *key = hv_iterkey(he, retlen);
1087     return hv_iterval(hv, he);
1088 }
1089
1090 void
1091 hv_magic(HV *hv, GV *gv, int how)
1092 {
1093     sv_magic((SV*)hv, (SV*)gv, how, Nullch, 0);
1094 }
1095
1096 char*
1097 sharepvn(char *sv, I32 len, U32 hash)
1098 {
1099     return HEK_KEY(share_hek(sv, len, hash));
1100 }
1101
1102 /* possibly free a shared string if no one has access to it
1103  * len and hash must both be valid for str.
1104  */
1105 void
1106 unsharepvn(char *str, I32 len, U32 hash)
1107 {
1108     register XPVHV* xhv;
1109     register HE *entry;
1110     register HE **oentry;
1111     register I32 i = 1;
1112     I32 found = 0;
1113
1114     /* what follows is the moral equivalent of:
1115     if ((Svp = hv_fetch(strtab, tmpsv, FALSE, hash))) {
1116         if (--*Svp == Nullsv)
1117             hv_delete(strtab, str, len, G_DISCARD, hash);
1118     } */
1119     xhv = (XPVHV*)SvANY(strtab);
1120     /* assert(xhv_array != 0) */
1121     oentry = &((HE**)xhv->xhv_array)[hash & (I32) xhv->xhv_max];
1122     for (entry = *oentry; entry; i=0, oentry = &HeNEXT(entry), entry = *oentry) {
1123         if (HeHASH(entry) != hash)              /* strings can't be equal */
1124             continue;
1125         if (HeKLEN(entry) != len)
1126             continue;
1127         if (memNE(HeKEY(entry),str,len))        /* is this it? */
1128             continue;
1129         found = 1;
1130         if (--HeVAL(entry) == Nullsv) {
1131             *oentry = HeNEXT(entry);
1132             if (i && !*oentry)
1133                 xhv->xhv_fill--;
1134             Safefree(HeKEY_hek(entry));
1135             del_he(entry);
1136             --xhv->xhv_keys;
1137         }
1138         break;
1139     }
1140
1141     if (!found)
1142         warn("Attempt to free non-existent shared string");
1143 }
1144
1145 /* get a (constant) string ptr from the global string table
1146  * string will get added if it is not already there.
1147  * len and hash must both be valid for str.
1148  */
1149 HEK *
1150 share_hek(char *str, I32 len, register U32 hash)
1151 {
1152     register XPVHV* xhv;
1153     register HE *entry;
1154     register HE **oentry;
1155     register I32 i = 1;
1156     I32 found = 0;
1157
1158     /* what follows is the moral equivalent of:
1159
1160     if (!(Svp = hv_fetch(strtab, str, len, FALSE)))
1161         hv_store(strtab, str, len, Nullsv, hash);
1162     */
1163     xhv = (XPVHV*)SvANY(strtab);
1164     /* assert(xhv_array != 0) */
1165     oentry = &((HE**)xhv->xhv_array)[hash & (I32) xhv->xhv_max];
1166     for (entry = *oentry; entry; i=0, entry = HeNEXT(entry)) {
1167         if (HeHASH(entry) != hash)              /* strings can't be equal */
1168             continue;
1169         if (HeKLEN(entry) != len)
1170             continue;
1171         if (memNE(HeKEY(entry),str,len))        /* is this it? */
1172             continue;
1173         found = 1;
1174         break;
1175     }
1176     if (!found) {
1177         entry = new_he();
1178         HeKEY_hek(entry) = save_hek(str, len, hash);
1179         HeVAL(entry) = Nullsv;
1180         HeNEXT(entry) = *oentry;
1181         *oentry = entry;
1182         xhv->xhv_keys++;
1183         if (i) {                                /* initial entry? */
1184             ++xhv->xhv_fill;
1185             if (xhv->xhv_keys > xhv->xhv_max)
1186                 hsplit(strtab);
1187         }
1188     }
1189
1190     ++HeVAL(entry);                             /* use value slot as REFCNT */
1191     return HeKEY_hek(entry);
1192 }
1193
1194
1195