3 * Copyright (c) 1991-1997, Larry Wall
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.
11 * "I sit beside the fire and think of all that I have seen." --Bilbo
17 static void hsplit _((HV *hv));
18 static void hfreeentries _((HV *hv));
20 static HE* more_he(void);
37 HeNEXT(p) = (HE*)he_root;
46 he_root = (HE*)safemalloc(1008);
48 heend = &he[1008 / sizeof(HE) - 1];
50 HeNEXT(he) = (HE*)(he + 1);
58 save_hek(char *str, I32 len, U32 hash)
63 New(54, k, HEK_BASESIZE + len + 1, char);
65 Copy(str, HEK_KEY(hek), len, char);
66 *(HEK_KEY(hek) + len) = '\0';
75 unsharepvn(HEK_KEY(hek),HEK_LEN(hek),HEK_HASH(hek));
78 /* (klen == HEf_SVKEY) is special for MAGICAL hv entries, meaning key slot
82 hv_fetch(HV *hv, char *key, U32 klen, I32 lval)
93 if (mg_find((SV*)hv,'P')) {
96 mg_copy((SV*)hv, sv, key, klen);
102 xhv = (XPVHV*)SvANY(hv);
103 if (!xhv->xhv_array) {
105 #ifdef DYNAMIC_ENV_FETCH /* if it's an %ENV lookup, we may get it on the fly */
106 || (HvNAME(hv) && strEQ(HvNAME(hv),ENV_HV_NAME))
109 Newz(503,xhv->xhv_array, sizeof(HE*) * (xhv->xhv_max + 1), char);
114 PERL_HASH(hash, key, klen);
116 entry = ((HE**)xhv->xhv_array)[hash & (I32) xhv->xhv_max];
117 for (; entry; entry = HeNEXT(entry)) {
118 if (HeHASH(entry) != hash) /* strings can't be equal */
120 if (HeKLEN(entry) != klen)
122 if (memNE(HeKEY(entry),key,klen)) /* is this it? */
124 return &HeVAL(entry);
126 #ifdef DYNAMIC_ENV_FETCH /* %ENV lookup? If so, try to fetch the value now */
127 if (HvNAME(hv) && strEQ(HvNAME(hv),ENV_HV_NAME)) {
130 if ((gotenv = ENV_getenv(key)) != Nullch) {
131 sv = newSVpv(gotenv,strlen(gotenv));
133 return hv_store(hv,key,klen,sv,hash);
137 if (lval) { /* gonna assign to this, so it better be there */
139 return hv_store(hv,key,klen,sv,hash);
144 /* returns a HE * structure with the all fields set */
145 /* note that hent_val will be a mortal sv for MAGICAL hashes */
147 hv_fetch_ent(HV *hv, SV *keysv, I32 lval, register U32 hash)
158 if (SvRMAGICAL(hv) && mg_find((SV*)hv,'P')) {
162 keysv = sv_2mortal(newSVsv(keysv));
163 mg_copy((SV*)hv, sv, (char*)keysv, HEf_SVKEY);
164 if (!HeKEY_hek(&mh)) {
166 New(54, k, HEK_BASESIZE + sizeof(SV*), char);
167 HeKEY_hek(&mh) = (HEK*)k;
169 HeSVKEY_set(&mh, keysv);
174 xhv = (XPVHV*)SvANY(hv);
175 if (!xhv->xhv_array) {
177 #ifdef DYNAMIC_ENV_FETCH /* if it's an %ENV lookup, we may get it on the fly */
178 || (HvNAME(hv) && strEQ(HvNAME(hv),ENV_HV_NAME))
181 Newz(503,xhv->xhv_array, sizeof(HE*) * (xhv->xhv_max + 1), char);
186 key = SvPV(keysv, klen);
189 PERL_HASH(hash, key, klen);
191 entry = ((HE**)xhv->xhv_array)[hash & (I32) xhv->xhv_max];
192 for (; entry; entry = HeNEXT(entry)) {
193 if (HeHASH(entry) != hash) /* strings can't be equal */
195 if (HeKLEN(entry) != klen)
197 if (memNE(HeKEY(entry),key,klen)) /* is this it? */
201 #ifdef DYNAMIC_ENV_FETCH /* %ENV lookup? If so, try to fetch the value now */
202 if (HvNAME(hv) && strEQ(HvNAME(hv),ENV_HV_NAME)) {
205 if ((gotenv = ENV_getenv(key)) != Nullch) {
206 sv = newSVpv(gotenv,strlen(gotenv));
208 return hv_store_ent(hv,keysv,sv,hash);
212 if (lval) { /* gonna assign to this, so it better be there */
214 return hv_store_ent(hv,keysv,sv,hash);
220 hv_magic_check (hv, needs_copy, needs_store)
225 MAGIC *mg = SvMAGIC(hv);
229 if (isUPPER(mg->mg_type)) {
231 switch (mg->mg_type) {
235 *needs_store = FALSE;
239 mg = mg->mg_moremagic;
244 hv_store(HV *hv, char *key, U32 klen, SV *val, register U32 hash)
249 register HE **oentry;
254 xhv = (XPVHV*)SvANY(hv);
258 hv_magic_check (hv, &needs_copy, &needs_store);
260 mg_copy((SV*)hv, val, key, klen);
261 if (!xhv->xhv_array && !needs_store)
266 PERL_HASH(hash, key, klen);
269 Newz(505, xhv->xhv_array, sizeof(HE**) * (xhv->xhv_max + 1), char);
271 oentry = &((HE**)xhv->xhv_array)[hash & (I32) xhv->xhv_max];
274 for (entry = *oentry; entry; i=0, entry = HeNEXT(entry)) {
275 if (HeHASH(entry) != hash) /* strings can't be equal */
277 if (HeKLEN(entry) != klen)
279 if (memNE(HeKEY(entry),key,klen)) /* is this it? */
281 SvREFCNT_dec(HeVAL(entry));
283 return &HeVAL(entry);
288 HeKEY_hek(entry) = share_hek(key, klen, hash);
289 else /* gotta do the real thing */
290 HeKEY_hek(entry) = save_hek(key, klen, hash);
292 HeNEXT(entry) = *oentry;
296 if (i) { /* initial entry? */
298 if (xhv->xhv_keys > xhv->xhv_max)
302 return &HeVAL(entry);
306 hv_store_ent(HV *hv, SV *keysv, SV *val, register U32 hash)
313 register HE **oentry;
318 xhv = (XPVHV*)SvANY(hv);
323 hv_magic_check (hv, &needs_copy, &needs_store);
325 bool save_taint = tainted;
327 tainted = SvTAINTED(keysv);
328 keysv = sv_2mortal(newSVsv(keysv));
329 mg_copy((SV*)hv, val, (char*)keysv, HEf_SVKEY);
330 TAINT_IF(save_taint);
331 if (!xhv->xhv_array && !needs_store)
336 key = SvPV(keysv, klen);
339 PERL_HASH(hash, key, klen);
342 Newz(505, xhv->xhv_array, sizeof(HE**) * (xhv->xhv_max + 1), char);
344 oentry = &((HE**)xhv->xhv_array)[hash & (I32) xhv->xhv_max];
347 for (entry = *oentry; entry; i=0, entry = HeNEXT(entry)) {
348 if (HeHASH(entry) != hash) /* strings can't be equal */
350 if (HeKLEN(entry) != klen)
352 if (memNE(HeKEY(entry),key,klen)) /* is this it? */
354 SvREFCNT_dec(HeVAL(entry));
361 HeKEY_hek(entry) = share_hek(key, klen, hash);
362 else /* gotta do the real thing */
363 HeKEY_hek(entry) = save_hek(key, klen, hash);
365 HeNEXT(entry) = *oentry;
369 if (i) { /* initial entry? */
371 if (xhv->xhv_keys > xhv->xhv_max)
379 hv_delete(HV *hv, char *key, U32 klen, I32 flags)
385 register HE **oentry;
390 if (SvRMAGICAL(hv)) {
391 sv = *hv_fetch(hv, key, klen, TRUE);
393 if (mg_find(sv, 's')) {
394 return Nullsv; /* %SIG elements cannot be deleted */
396 if (mg_find(sv, 'p')) {
397 sv_unmagic(sv, 'p'); /* No longer an element */
401 xhv = (XPVHV*)SvANY(hv);
405 PERL_HASH(hash, key, klen);
407 oentry = &((HE**)xhv->xhv_array)[hash & (I32) xhv->xhv_max];
410 for (; entry; i=0, oentry = &HeNEXT(entry), entry = *oentry) {
411 if (HeHASH(entry) != hash) /* strings can't be equal */
413 if (HeKLEN(entry) != klen)
415 if (memNE(HeKEY(entry),key,klen)) /* is this it? */
417 *oentry = HeNEXT(entry);
420 if (flags & G_DISCARD)
423 sv = sv_mortalcopy(HeVAL(entry));
424 if (entry == xhv->xhv_eiter)
427 hv_free_ent(hv, entry);
435 hv_delete_ent(HV *hv, SV *keysv, I32 flags, U32 hash)
442 register HE **oentry;
447 if (SvRMAGICAL(hv)) {
448 entry = hv_fetch_ent(hv, keysv, TRUE, hash);
451 if (mg_find(sv, 'p')) {
452 sv_unmagic(sv, 'p'); /* No longer an element */
456 xhv = (XPVHV*)SvANY(hv);
460 key = SvPV(keysv, klen);
463 PERL_HASH(hash, key, klen);
465 oentry = &((HE**)xhv->xhv_array)[hash & (I32) xhv->xhv_max];
468 for (; entry; i=0, oentry = &HeNEXT(entry), entry = *oentry) {
469 if (HeHASH(entry) != hash) /* strings can't be equal */
471 if (HeKLEN(entry) != klen)
473 if (memNE(HeKEY(entry),key,klen)) /* is this it? */
475 *oentry = HeNEXT(entry);
478 if (flags & G_DISCARD)
481 sv = sv_mortalcopy(HeVAL(entry));
482 if (entry == xhv->xhv_eiter)
485 hv_free_ent(hv, entry);
493 hv_exists(HV *hv, char *key, U32 klen)
503 if (SvRMAGICAL(hv)) {
504 if (mg_find((SV*)hv,'P')) {
507 mg_copy((SV*)hv, sv, key, klen);
508 magic_existspack(sv, mg_find(sv, 'p'));
513 xhv = (XPVHV*)SvANY(hv);
517 PERL_HASH(hash, key, klen);
519 entry = ((HE**)xhv->xhv_array)[hash & (I32) xhv->xhv_max];
520 for (; entry; entry = HeNEXT(entry)) {
521 if (HeHASH(entry) != hash) /* strings can't be equal */
523 if (HeKLEN(entry) != klen)
525 if (memNE(HeKEY(entry),key,klen)) /* is this it? */
534 hv_exists_ent(HV *hv, SV *keysv, U32 hash)
545 if (SvRMAGICAL(hv)) {
546 if (mg_find((SV*)hv,'P')) {
547 dTHR; /* just for SvTRUE */
549 keysv = sv_2mortal(newSVsv(keysv));
550 mg_copy((SV*)hv, sv, (char*)keysv, HEf_SVKEY);
551 magic_existspack(sv, mg_find(sv, 'p'));
556 xhv = (XPVHV*)SvANY(hv);
560 key = SvPV(keysv, klen);
562 PERL_HASH(hash, key, klen);
564 entry = ((HE**)xhv->xhv_array)[hash & (I32) xhv->xhv_max];
565 for (; entry; entry = HeNEXT(entry)) {
566 if (HeHASH(entry) != hash) /* strings can't be equal */
568 if (HeKLEN(entry) != klen)
570 if (memNE(HeKEY(entry),key,klen)) /* is this it? */
580 register XPVHV* xhv = (XPVHV*)SvANY(hv);
581 I32 oldsize = (I32) xhv->xhv_max + 1; /* sic(k) */
582 register I32 newsize = oldsize * 2;
587 register HE **oentry;
588 #ifndef STRANGE_MALLOC
592 a = (HE**)xhv->xhv_array;
594 #ifdef STRANGE_MALLOC
595 Renew(a, newsize, HE*);
597 i = newsize * sizeof(HE*);
598 #define MALLOC_OVERHEAD 16
599 tmp = MALLOC_OVERHEAD;
600 while (tmp - MALLOC_OVERHEAD < i)
602 tmp -= MALLOC_OVERHEAD;
604 assert(tmp >= newsize);
606 Copy(xhv->xhv_array, a, oldsize, HE*);
608 offer_nice_chunk(xhv->xhv_array,
609 oldsize * sizeof(HE*) * 2 - MALLOC_OVERHEAD);
612 Safefree(xhv->xhv_array);
616 Zero(&a[oldsize], oldsize, HE*); /* zero 2nd half*/
617 xhv->xhv_max = --newsize;
618 xhv->xhv_array = (char*)a;
620 for (i=0; i<oldsize; i++,a++) {
621 if (!*a) /* non-existent */
624 for (oentry = a, entry = *a; entry; entry = *oentry) {
625 if ((HeHASH(entry) & newsize) != i) {
626 *oentry = HeNEXT(entry);
634 oentry = &HeNEXT(entry);
636 if (!*a) /* everything moved */
642 hv_ksplit(HV *hv, IV newmax)
644 register XPVHV* xhv = (XPVHV*)SvANY(hv);
645 I32 oldsize = (I32) xhv->xhv_max + 1; /* sic(k) */
646 register I32 newsize;
651 register HE **oentry;
653 newsize = (I32) newmax; /* possible truncation here */
654 if (newsize != newmax || newmax <= oldsize)
656 while ((newsize & (1 + ~newsize)) != newsize) {
657 newsize &= ~(newsize & (1 + ~newsize)); /* get proper power of 2 */
659 if (newsize < newmax)
661 if (newsize < newmax)
662 return; /* overflow detection */
664 a = (HE**)xhv->xhv_array;
667 #ifdef STRANGE_MALLOC
668 Renew(a, newsize, HE*);
670 i = newsize * sizeof(HE*);
672 while (j - MALLOC_OVERHEAD < i)
674 j -= MALLOC_OVERHEAD;
676 assert(j >= newsize);
678 Copy(xhv->xhv_array, a, oldsize, HE*);
680 offer_nice_chunk(xhv->xhv_array,
681 oldsize * sizeof(HE*) * 2 - MALLOC_OVERHEAD);
684 Safefree(xhv->xhv_array);
687 Zero(&a[oldsize], newsize-oldsize, HE*); /* zero 2nd half*/
690 Newz(0, a, newsize, HE*);
692 xhv->xhv_max = --newsize;
693 xhv->xhv_array = (char*)a;
694 if (!xhv->xhv_fill) /* skip rest if no entries */
697 for (i=0; i<oldsize; i++,a++) {
698 if (!*a) /* non-existent */
700 for (oentry = a, entry = *a; entry; entry = *oentry) {
701 if ((j = (HeHASH(entry) & newsize)) != i) {
703 *oentry = HeNEXT(entry);
704 if (!(HeNEXT(entry) = a[j]))
710 oentry = &HeNEXT(entry);
712 if (!*a) /* everything moved */
723 hv = (HV*)NEWSV(502,0);
724 sv_upgrade((SV *)hv, SVt_PVHV);
725 xhv = (XPVHV*)SvANY(hv);
728 #ifndef NODEFAULT_SHAREKEYS
729 HvSHAREKEYS_on(hv); /* key-sharing on by default */
731 xhv->xhv_max = 7; /* start with 8 buckets */
734 (void)hv_iterinit(hv); /* so each() will start off right */
739 hv_free_ent(HV *hv, register HE *entry)
743 if (isGV(HeVAL(entry)) && GvCVu(HeVAL(entry)) && HvNAME(hv))
744 sub_generation++; /* may be deletion of method from stash */
745 SvREFCNT_dec(HeVAL(entry));
746 if (HeKLEN(entry) == HEf_SVKEY) {
747 SvREFCNT_dec(HeKEY_sv(entry));
748 Safefree(HeKEY_hek(entry));
750 else if (HvSHAREKEYS(hv))
751 unshare_hek(HeKEY_hek(entry));
753 Safefree(HeKEY_hek(entry));
758 hv_delayfree_ent(HV *hv, register HE *entry)
762 if (isGV(HeVAL(entry)) && GvCVu(HeVAL(entry)) && HvNAME(hv))
763 sub_generation++; /* may be deletion of method from stash */
764 sv_2mortal(HeVAL(entry)); /* free between statements */
765 if (HeKLEN(entry) == HEf_SVKEY) {
766 sv_2mortal(HeKEY_sv(entry));
767 Safefree(HeKEY_hek(entry));
769 else if (HvSHAREKEYS(hv))
770 unshare_hek(HeKEY_hek(entry));
772 Safefree(HeKEY_hek(entry));
782 xhv = (XPVHV*)SvANY(hv);
787 (void)memzero(xhv->xhv_array, (xhv->xhv_max + 1) * sizeof(HE*));
798 register HE *oentry = Null(HE*);
814 entry = HeNEXT(entry);
815 hv_free_ent(hv, oentry);
820 entry = array[riter];
823 (void)hv_iterinit(hv);
832 xhv = (XPVHV*)SvANY(hv);
834 Safefree(xhv->xhv_array);
836 Safefree(HvNAME(hv));
840 xhv->xhv_max = 7; /* it's a normal hash */
856 xhv = (XPVHV*)SvANY(hv);
857 entry = xhv->xhv_eiter;
858 #ifdef DYNAMIC_ENV_FETCH /* set up %ENV for iteration */
859 if (HvNAME(hv) && strEQ(HvNAME(hv), ENV_HV_NAME))
862 if (entry && HvLAZYDEL(hv)) { /* was deleted earlier? */
864 hv_free_ent(hv, entry);
867 xhv->xhv_eiter = Null(HE*);
868 return xhv->xhv_fill; /* should be xhv->xhv_keys? May change later */
881 xhv = (XPVHV*)SvANY(hv);
882 oldentry = entry = xhv->xhv_eiter;
884 if (SvRMAGICAL(hv) && (mg = mg_find((SV*)hv,'P'))) {
885 SV *key = sv_newmortal();
887 sv_setsv(key, HeSVKEY_force(entry));
888 SvREFCNT_dec(HeSVKEY(entry)); /* get rid of previous key */
894 xhv->xhv_eiter = entry = new_he(); /* one HE per MAGICAL hash */
896 Newz(54, k, HEK_BASESIZE + sizeof(SV*), char);
898 HeKEY_hek(entry) = hek;
899 HeKLEN(entry) = HEf_SVKEY;
901 magic_nextpack((SV*) hv,mg,key);
903 /* force key to stay around until next time */
904 HeSVKEY_set(entry, SvREFCNT_inc(key));
905 return entry; /* beware, hent_val is not set */
908 SvREFCNT_dec(HeVAL(entry));
909 Safefree(HeKEY_hek(entry));
911 xhv->xhv_eiter = Null(HE*);
916 Newz(506,xhv->xhv_array, sizeof(HE*) * (xhv->xhv_max + 1), char);
918 entry = HeNEXT(entry);
921 if (xhv->xhv_riter > xhv->xhv_max) {
925 entry = ((HE**)xhv->xhv_array)[xhv->xhv_riter];
928 if (oldentry && HvLAZYDEL(hv)) { /* was deleted earlier? */
930 hv_free_ent(hv, oldentry);
933 xhv->xhv_eiter = entry;
938 hv_iterkey(register HE *entry, I32 *retlen)
940 if (HeKLEN(entry) == HEf_SVKEY) {
942 char *p = SvPV(HeKEY_sv(entry), len);
947 *retlen = HeKLEN(entry);
952 /* unlike hv_iterval(), this always returns a mortal copy of the key */
954 hv_iterkeysv(register HE *entry)
956 if (HeKLEN(entry) == HEf_SVKEY)
957 return sv_mortalcopy(HeKEY_sv(entry));
959 return sv_2mortal(newSVpv((HeKLEN(entry) ? HeKEY(entry) : ""),
964 hv_iterval(HV *hv, register HE *entry)
966 if (SvRMAGICAL(hv)) {
967 if (mg_find((SV*)hv,'P')) {
968 SV* sv = sv_newmortal();
969 if (HeKLEN(entry) == HEf_SVKEY)
970 mg_copy((SV*)hv, sv, (char*)HeKEY_sv(entry), HEf_SVKEY);
971 else mg_copy((SV*)hv, sv, HeKEY(entry), HeKLEN(entry));
979 hv_iternextsv(HV *hv, char **key, I32 *retlen)
982 if ( (he = hv_iternext(hv)) == NULL)
984 *key = hv_iterkey(he, retlen);
985 return hv_iterval(hv, he);
989 hv_magic(HV *hv, GV *gv, int how)
991 sv_magic((SV*)hv, (SV*)gv, how, Nullch, 0);
995 sharepvn(char *sv, I32 len, U32 hash)
997 return HEK_KEY(share_hek(sv, len, hash));
1000 /* possibly free a shared string if no one has access to it
1001 * len and hash must both be valid for str.
1004 unsharepvn(char *str, I32 len, U32 hash)
1006 register XPVHV* xhv;
1008 register HE **oentry;
1012 /* what follows is the moral equivalent of:
1013 if ((Svp = hv_fetch(strtab, tmpsv, FALSE, hash))) {
1014 if (--*Svp == Nullsv)
1015 hv_delete(strtab, str, len, G_DISCARD, hash);
1017 xhv = (XPVHV*)SvANY(strtab);
1018 /* assert(xhv_array != 0) */
1019 oentry = &((HE**)xhv->xhv_array)[hash & (I32) xhv->xhv_max];
1020 for (entry = *oentry; entry; i=0, oentry = &HeNEXT(entry), entry = *oentry) {
1021 if (HeHASH(entry) != hash) /* strings can't be equal */
1023 if (HeKLEN(entry) != len)
1025 if (memNE(HeKEY(entry),str,len)) /* is this it? */
1028 if (--HeVAL(entry) == Nullsv) {
1029 *oentry = HeNEXT(entry);
1032 Safefree(HeKEY_hek(entry));
1040 warn("Attempt to free non-existent shared string");
1043 /* get a (constant) string ptr from the global string table
1044 * string will get added if it is not already there.
1045 * len and hash must both be valid for str.
1048 share_hek(char *str, I32 len, register U32 hash)
1050 register XPVHV* xhv;
1052 register HE **oentry;
1056 /* what follows is the moral equivalent of:
1058 if (!(Svp = hv_fetch(strtab, str, len, FALSE)))
1059 hv_store(strtab, str, len, Nullsv, hash);
1061 xhv = (XPVHV*)SvANY(strtab);
1062 /* assert(xhv_array != 0) */
1063 oentry = &((HE**)xhv->xhv_array)[hash & (I32) xhv->xhv_max];
1064 for (entry = *oentry; entry; i=0, entry = HeNEXT(entry)) {
1065 if (HeHASH(entry) != hash) /* strings can't be equal */
1067 if (HeKLEN(entry) != len)
1069 if (memNE(HeKEY(entry),str,len)) /* is this it? */
1076 HeKEY_hek(entry) = save_hek(str, len, hash);
1077 HeVAL(entry) = Nullsv;
1078 HeNEXT(entry) = *oentry;
1081 if (i) { /* initial entry? */
1083 if (xhv->xhv_keys > xhv->xhv_max)
1088 ++HeVAL(entry); /* use value slot as REFCNT */
1089 return HeKEY_hek(entry);