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));
38 HeNEXT(p) = (HE*)he_root;
47 he_root = (HE*)safemalloc(1008);
49 heend = &he[1008 / sizeof(HE) - 1];
51 HeNEXT(he) = (HE*)(he + 1);
59 save_hek(str, len, hash)
67 New(54, k, HEK_BASESIZE + len + 1, char);
69 Copy(str, HEK_KEY(hek), len, char);
70 *(HEK_KEY(hek) + len) = '\0';
80 unsharepvn(HEK_KEY(hek),HEK_LEN(hek),HEK_HASH(hek));
83 /* (klen == HEf_SVKEY) is special for MAGICAL hv entries, meaning key slot
87 hv_fetch(hv,key,klen,lval)
101 if (SvRMAGICAL(hv)) {
102 if (mg_find((SV*)hv,'P')) {
105 mg_copy((SV*)hv, sv, key, klen);
111 xhv = (XPVHV*)SvANY(hv);
112 if (!xhv->xhv_array) {
114 #ifdef DYNAMIC_ENV_FETCH /* if it's an %ENV lookup, we may get it on the fly */
115 || (HvNAME(hv) && strEQ(HvNAME(hv),ENV_HV_NAME))
118 Newz(503,xhv->xhv_array, sizeof(HE*) * (xhv->xhv_max + 1), char);
123 PERL_HASH(hash, key, klen);
125 entry = ((HE**)xhv->xhv_array)[hash & (I32) xhv->xhv_max];
126 for (; entry; entry = HeNEXT(entry)) {
127 if (HeHASH(entry) != hash) /* strings can't be equal */
129 if (HeKLEN(entry) != klen)
131 if (memNE(HeKEY(entry),key,klen)) /* is this it? */
133 return &HeVAL(entry);
135 #ifdef DYNAMIC_ENV_FETCH /* %ENV lookup? If so, try to fetch the value now */
136 if (HvNAME(hv) && strEQ(HvNAME(hv),ENV_HV_NAME)) {
139 if ((gotenv = ENV_getenv(key)) != Nullch) {
140 sv = newSVpv(gotenv,strlen(gotenv));
142 return hv_store(hv,key,klen,sv,hash);
146 if (lval) { /* gonna assign to this, so it better be there */
148 return hv_store(hv,key,klen,sv,hash);
153 /* returns a HE * structure with the all fields set */
154 /* note that hent_val will be a mortal sv for MAGICAL hashes */
156 hv_fetch_ent(hv,keysv,lval,hash)
171 if (SvRMAGICAL(hv) && mg_find((SV*)hv,'P')) {
175 keysv = sv_2mortal(newSVsv(keysv));
176 mg_copy((SV*)hv, sv, (char*)keysv, HEf_SVKEY);
177 if (!HeKEY_hek(&mh)) {
179 New(54, k, HEK_BASESIZE + sizeof(SV*), char);
180 HeKEY_hek(&mh) = (HEK*)k;
182 HeSVKEY_set(&mh, keysv);
187 xhv = (XPVHV*)SvANY(hv);
188 if (!xhv->xhv_array) {
190 #ifdef DYNAMIC_ENV_FETCH /* if it's an %ENV lookup, we may get it on the fly */
191 || (HvNAME(hv) && strEQ(HvNAME(hv),ENV_HV_NAME))
194 Newz(503,xhv->xhv_array, sizeof(HE*) * (xhv->xhv_max + 1), char);
199 key = SvPV(keysv, klen);
202 PERL_HASH(hash, key, klen);
204 entry = ((HE**)xhv->xhv_array)[hash & (I32) xhv->xhv_max];
205 for (; entry; entry = HeNEXT(entry)) {
206 if (HeHASH(entry) != hash) /* strings can't be equal */
208 if (HeKLEN(entry) != klen)
210 if (memNE(HeKEY(entry),key,klen)) /* is this it? */
214 #ifdef DYNAMIC_ENV_FETCH /* %ENV lookup? If so, try to fetch the value now */
215 if (HvNAME(hv) && strEQ(HvNAME(hv),ENV_HV_NAME)) {
218 if ((gotenv = ENV_getenv(key)) != Nullch) {
219 sv = newSVpv(gotenv,strlen(gotenv));
221 return hv_store_ent(hv,keysv,sv,hash);
225 if (lval) { /* gonna assign to this, so it better be there */
227 return hv_store_ent(hv,keysv,sv,hash);
233 hv_store(hv,key,klen,val,hash)
243 register HE **oentry;
248 xhv = (XPVHV*)SvANY(hv);
250 mg_copy((SV*)hv, val, key, klen);
252 && (SvMAGIC(hv)->mg_moremagic
253 || (SvMAGIC(hv)->mg_type != 'E'
255 && SvMAGIC(hv)->mg_type != 'A'
256 #endif /* OVERLOAD */
261 PERL_HASH(hash, key, klen);
264 Newz(505, xhv->xhv_array, sizeof(HE**) * (xhv->xhv_max + 1), char);
266 oentry = &((HE**)xhv->xhv_array)[hash & (I32) xhv->xhv_max];
269 for (entry = *oentry; entry; i=0, entry = HeNEXT(entry)) {
270 if (HeHASH(entry) != hash) /* strings can't be equal */
272 if (HeKLEN(entry) != klen)
274 if (memNE(HeKEY(entry),key,klen)) /* is this it? */
276 SvREFCNT_dec(HeVAL(entry));
278 return &HeVAL(entry);
283 HeKEY_hek(entry) = share_hek(key, klen, hash);
284 else /* gotta do the real thing */
285 HeKEY_hek(entry) = save_hek(key, klen, hash);
287 HeNEXT(entry) = *oentry;
291 if (i) { /* initial entry? */
293 if (xhv->xhv_keys > xhv->xhv_max)
297 return &HeVAL(entry);
301 hv_store_ent(hv,keysv,val,hash)
312 register HE **oentry;
317 xhv = (XPVHV*)SvANY(hv);
319 bool save_taint = tainted;
321 tainted = SvTAINTED(keysv);
322 keysv = sv_2mortal(newSVsv(keysv));
323 mg_copy((SV*)hv, val, (char*)keysv, HEf_SVKEY);
324 TAINT_IF(save_taint);
326 && (SvMAGIC(hv)->mg_moremagic
327 || (SvMAGIC(hv)->mg_type != 'E'
329 && SvMAGIC(hv)->mg_type != 'A'
330 #endif /* OVERLOAD */
335 key = SvPV(keysv, klen);
338 PERL_HASH(hash, key, klen);
341 Newz(505, xhv->xhv_array, sizeof(HE**) * (xhv->xhv_max + 1), char);
343 oentry = &((HE**)xhv->xhv_array)[hash & (I32) xhv->xhv_max];
346 for (entry = *oentry; entry; i=0, entry = HeNEXT(entry)) {
347 if (HeHASH(entry) != hash) /* strings can't be equal */
349 if (HeKLEN(entry) != klen)
351 if (memNE(HeKEY(entry),key,klen)) /* is this it? */
353 SvREFCNT_dec(HeVAL(entry));
360 HeKEY_hek(entry) = share_hek(key, klen, hash);
361 else /* gotta do the real thing */
362 HeKEY_hek(entry) = save_hek(key, klen, hash);
364 HeNEXT(entry) = *oentry;
368 if (i) { /* initial entry? */
370 if (xhv->xhv_keys > xhv->xhv_max)
378 hv_delete(hv,key,klen,flags)
388 register HE **oentry;
393 if (SvRMAGICAL(hv)) {
394 sv = *hv_fetch(hv, key, klen, TRUE);
396 if (mg_find(sv, 's')) {
397 return Nullsv; /* %SIG elements cannot be deleted */
399 if (mg_find(sv, 'p')) {
400 sv_unmagic(sv, 'p'); /* No longer an element */
404 xhv = (XPVHV*)SvANY(hv);
408 PERL_HASH(hash, key, klen);
410 oentry = &((HE**)xhv->xhv_array)[hash & (I32) xhv->xhv_max];
413 for (; entry; i=0, oentry = &HeNEXT(entry), entry = *oentry) {
414 if (HeHASH(entry) != hash) /* strings can't be equal */
416 if (HeKLEN(entry) != klen)
418 if (memNE(HeKEY(entry),key,klen)) /* is this it? */
420 *oentry = HeNEXT(entry);
423 if (flags & G_DISCARD)
426 sv = sv_mortalcopy(HeVAL(entry));
427 if (entry == xhv->xhv_eiter)
430 hv_free_ent(hv, entry);
438 hv_delete_ent(hv,keysv,flags,hash)
449 register HE **oentry;
454 if (SvRMAGICAL(hv)) {
455 entry = hv_fetch_ent(hv, keysv, TRUE, hash);
458 if (mg_find(sv, 'p')) {
459 sv_unmagic(sv, 'p'); /* No longer an element */
463 xhv = (XPVHV*)SvANY(hv);
467 key = SvPV(keysv, klen);
470 PERL_HASH(hash, key, klen);
472 oentry = &((HE**)xhv->xhv_array)[hash & (I32) xhv->xhv_max];
475 for (; entry; i=0, oentry = &HeNEXT(entry), entry = *oentry) {
476 if (HeHASH(entry) != hash) /* strings can't be equal */
478 if (HeKLEN(entry) != klen)
480 if (memNE(HeKEY(entry),key,klen)) /* is this it? */
482 *oentry = HeNEXT(entry);
485 if (flags & G_DISCARD)
488 sv = sv_mortalcopy(HeVAL(entry));
489 if (entry == xhv->xhv_eiter)
492 hv_free_ent(hv, entry);
500 hv_exists(hv,key,klen)
513 if (SvRMAGICAL(hv)) {
514 if (mg_find((SV*)hv,'P')) {
517 mg_copy((SV*)hv, sv, key, klen);
518 magic_existspack(sv, mg_find(sv, 'p'));
523 xhv = (XPVHV*)SvANY(hv);
527 PERL_HASH(hash, key, klen);
529 entry = ((HE**)xhv->xhv_array)[hash & (I32) xhv->xhv_max];
530 for (; entry; entry = HeNEXT(entry)) {
531 if (HeHASH(entry) != hash) /* strings can't be equal */
533 if (HeKLEN(entry) != klen)
535 if (memNE(HeKEY(entry),key,klen)) /* is this it? */
544 hv_exists_ent(hv,keysv,hash)
558 if (SvRMAGICAL(hv)) {
559 if (mg_find((SV*)hv,'P')) {
561 keysv = sv_2mortal(newSVsv(keysv));
562 mg_copy((SV*)hv, sv, (char*)keysv, HEf_SVKEY);
563 magic_existspack(sv, mg_find(sv, 'p'));
568 xhv = (XPVHV*)SvANY(hv);
572 key = SvPV(keysv, klen);
574 PERL_HASH(hash, key, klen);
576 entry = ((HE**)xhv->xhv_array)[hash & (I32) xhv->xhv_max];
577 for (; entry; entry = HeNEXT(entry)) {
578 if (HeHASH(entry) != hash) /* strings can't be equal */
580 if (HeKLEN(entry) != klen)
582 if (memNE(HeKEY(entry),key,klen)) /* is this it? */
593 register XPVHV* xhv = (XPVHV*)SvANY(hv);
594 I32 oldsize = (I32) xhv->xhv_max + 1; /* sic(k) */
595 register I32 newsize = oldsize * 2;
600 register HE **oentry;
601 #ifndef STRANGE_MALLOC
605 a = (HE**)xhv->xhv_array;
607 #ifdef STRANGE_MALLOC
608 Renew(a, newsize, HE*);
610 i = newsize * sizeof(HE*);
611 #define MALLOC_OVERHEAD 16
612 tmp = MALLOC_OVERHEAD;
613 while (tmp - MALLOC_OVERHEAD < i)
615 tmp -= MALLOC_OVERHEAD;
617 assert(tmp >= newsize);
619 Copy(xhv->xhv_array, a, oldsize, HE*);
620 if (oldsize >= 64 && !nice_chunk) {
621 nice_chunk = (char*)xhv->xhv_array;
622 nice_chunk_size = oldsize * sizeof(HE*) * 2 - MALLOC_OVERHEAD;
625 Safefree(xhv->xhv_array);
629 Zero(&a[oldsize], oldsize, HE*); /* zero 2nd half*/
630 xhv->xhv_max = --newsize;
631 xhv->xhv_array = (char*)a;
633 for (i=0; i<oldsize; i++,a++) {
634 if (!*a) /* non-existent */
637 for (oentry = a, entry = *a; entry; entry = *oentry) {
638 if ((HeHASH(entry) & newsize) != i) {
639 *oentry = HeNEXT(entry);
647 oentry = &HeNEXT(entry);
649 if (!*a) /* everything moved */
655 hv_ksplit(hv, newmax)
659 register XPVHV* xhv = (XPVHV*)SvANY(hv);
660 I32 oldsize = (I32) xhv->xhv_max + 1; /* sic(k) */
661 register I32 newsize;
666 register HE **oentry;
668 newsize = (I32) newmax; /* possible truncation here */
669 if (newsize != newmax || newmax <= oldsize)
671 while ((newsize & (1 + ~newsize)) != newsize) {
672 newsize &= ~(newsize & (1 + ~newsize)); /* get proper power of 2 */
674 if (newsize < newmax)
676 if (newsize < newmax)
677 return; /* overflow detection */
679 a = (HE**)xhv->xhv_array;
682 #ifdef STRANGE_MALLOC
683 Renew(a, newsize, HE*);
685 i = newsize * sizeof(HE*);
687 while (j - MALLOC_OVERHEAD < i)
689 j -= MALLOC_OVERHEAD;
691 assert(j >= newsize);
693 Copy(xhv->xhv_array, a, oldsize, HE*);
694 if (oldsize >= 64 && !nice_chunk) {
695 nice_chunk = (char*)xhv->xhv_array;
696 nice_chunk_size = oldsize * sizeof(HE*) * 2 - MALLOC_OVERHEAD;
699 Safefree(xhv->xhv_array);
702 Zero(&a[oldsize], newsize-oldsize, HE*); /* zero 2nd half*/
705 Newz(0, a, newsize, HE*);
707 xhv->xhv_max = --newsize;
708 xhv->xhv_array = (char*)a;
709 if (!xhv->xhv_fill) /* skip rest if no entries */
712 for (i=0; i<oldsize; i++,a++) {
713 if (!*a) /* non-existent */
715 for (oentry = a, entry = *a; entry; entry = *oentry) {
716 if ((j = (HeHASH(entry) & newsize)) != i) {
718 *oentry = HeNEXT(entry);
719 if (!(HeNEXT(entry) = a[j]))
725 oentry = &HeNEXT(entry);
727 if (!*a) /* everything moved */
738 hv = (HV*)NEWSV(502,0);
739 sv_upgrade((SV *)hv, SVt_PVHV);
740 xhv = (XPVHV*)SvANY(hv);
743 #ifndef NODEFAULT_SHAREKEYS
744 HvSHAREKEYS_on(hv); /* key-sharing on by default */
746 xhv->xhv_max = 7; /* start with 8 buckets */
749 (void)hv_iterinit(hv); /* so each() will start off right */
754 hv_free_ent(hv, entry)
760 if (isGV(HeVAL(entry)) && GvCVu(HeVAL(entry)) && HvNAME(hv))
761 sub_generation++; /* may be deletion of method from stash */
762 SvREFCNT_dec(HeVAL(entry));
763 if (HeKLEN(entry) == HEf_SVKEY) {
764 SvREFCNT_dec(HeKEY_sv(entry));
765 Safefree(HeKEY_hek(entry));
767 else if (HvSHAREKEYS(hv))
768 unshare_hek(HeKEY_hek(entry));
770 Safefree(HeKEY_hek(entry));
775 hv_delayfree_ent(hv, entry)
781 if (isGV(HeVAL(entry)) && GvCVu(HeVAL(entry)) && HvNAME(hv))
782 sub_generation++; /* may be deletion of method from stash */
783 sv_2mortal(HeVAL(entry)); /* free between statements */
784 if (HeKLEN(entry) == HEf_SVKEY) {
785 sv_2mortal(HeKEY_sv(entry));
786 Safefree(HeKEY_hek(entry));
788 else if (HvSHAREKEYS(hv))
789 unshare_hek(HeKEY_hek(entry));
791 Safefree(HeKEY_hek(entry));
802 xhv = (XPVHV*)SvANY(hv);
807 (void)memzero(xhv->xhv_array, (xhv->xhv_max + 1) * sizeof(HE*));
819 register HE *oentry = Null(HE*);
835 entry = HeNEXT(entry);
836 hv_free_ent(hv, oentry);
841 entry = array[riter];
844 (void)hv_iterinit(hv);
854 xhv = (XPVHV*)SvANY(hv);
856 Safefree(xhv->xhv_array);
858 Safefree(HvNAME(hv));
862 xhv->xhv_max = 7; /* it's a normal hash */
879 xhv = (XPVHV*)SvANY(hv);
880 entry = xhv->xhv_eiter;
881 #ifdef DYNAMIC_ENV_FETCH /* set up %ENV for iteration */
882 if (HvNAME(hv) && strEQ(HvNAME(hv), ENV_HV_NAME))
885 if (entry && HvLAZYDEL(hv)) { /* was deleted earlier? */
887 hv_free_ent(hv, entry);
890 xhv->xhv_eiter = Null(HE*);
891 return xhv->xhv_fill;
905 xhv = (XPVHV*)SvANY(hv);
906 oldentry = entry = xhv->xhv_eiter;
908 if (SvRMAGICAL(hv) && (mg = mg_find((SV*)hv,'P'))) {
909 SV *key = sv_newmortal();
911 sv_setsv(key, HeSVKEY_force(entry));
912 SvREFCNT_dec(HeSVKEY(entry)); /* get rid of previous key */
918 xhv->xhv_eiter = entry = new_he(); /* one HE per MAGICAL hash */
920 Newz(54, k, HEK_BASESIZE + sizeof(SV*), char);
922 HeKEY_hek(entry) = hek;
923 HeKLEN(entry) = HEf_SVKEY;
925 magic_nextpack((SV*) hv,mg,key);
927 /* force key to stay around until next time */
928 HeSVKEY_set(entry, SvREFCNT_inc(key));
929 return entry; /* beware, hent_val is not set */
932 SvREFCNT_dec(HeVAL(entry));
933 Safefree(HeKEY_hek(entry));
935 xhv->xhv_eiter = Null(HE*);
940 Newz(506,xhv->xhv_array, sizeof(HE*) * (xhv->xhv_max + 1), char);
942 entry = HeNEXT(entry);
945 if (xhv->xhv_riter > xhv->xhv_max) {
949 entry = ((HE**)xhv->xhv_array)[xhv->xhv_riter];
952 if (oldentry && HvLAZYDEL(hv)) { /* was deleted earlier? */
954 hv_free_ent(hv, oldentry);
957 xhv->xhv_eiter = entry;
962 hv_iterkey(entry,retlen)
966 if (HeKLEN(entry) == HEf_SVKEY) {
967 return SvPV(HeKEY_sv(entry), *(STRLEN*)retlen);
970 *retlen = HeKLEN(entry);
975 /* unlike hv_iterval(), this always returns a mortal copy of the key */
980 if (HeKLEN(entry) == HEf_SVKEY)
981 return sv_mortalcopy(HeKEY_sv(entry));
983 return sv_2mortal(newSVpv((HeKLEN(entry) ? HeKEY(entry) : ""),
992 if (SvRMAGICAL(hv)) {
993 if (mg_find((SV*)hv,'P')) {
994 SV* sv = sv_newmortal();
995 if (HeKLEN(entry) == HEf_SVKEY)
996 mg_copy((SV*)hv, sv, (char*)HeKEY_sv(entry), HEf_SVKEY);
997 else mg_copy((SV*)hv, sv, HeKEY(entry), HeKLEN(entry));
1001 return HeVAL(entry);
1005 hv_iternextsv(hv, key, retlen)
1011 if ( (he = hv_iternext(hv)) == NULL)
1013 *key = hv_iterkey(he, retlen);
1014 return hv_iterval(hv, he);
1018 hv_magic(hv, gv, how)
1023 sv_magic((SV*)hv, (SV*)gv, how, Nullch, 0);
1027 sharepvn(sv, len, hash)
1032 return HEK_KEY(share_hek(sv, len, hash));
1035 /* possibly free a shared string if no one has access to it
1036 * len and hash must both be valid for str.
1039 unsharepvn(str, len, hash)
1044 register XPVHV* xhv;
1046 register HE **oentry;
1050 /* what follows is the moral equivalent of:
1051 if ((Svp = hv_fetch(strtab, tmpsv, FALSE, hash))) {
1052 if (--*Svp == Nullsv)
1053 hv_delete(strtab, str, len, G_DISCARD, hash);
1055 xhv = (XPVHV*)SvANY(strtab);
1056 /* assert(xhv_array != 0) */
1057 oentry = &((HE**)xhv->xhv_array)[hash & (I32) xhv->xhv_max];
1058 for (entry = *oentry; entry; i=0, oentry = &HeNEXT(entry), entry = *oentry) {
1059 if (HeHASH(entry) != hash) /* strings can't be equal */
1061 if (HeKLEN(entry) != len)
1063 if (memNE(HeKEY(entry),str,len)) /* is this it? */
1066 if (--HeVAL(entry) == Nullsv) {
1067 *oentry = HeNEXT(entry);
1070 Safefree(HeKEY_hek(entry));
1078 warn("Attempt to free non-existent shared string");
1081 /* get a (constant) string ptr from the global string table
1082 * string will get added if it is not already there.
1083 * len and hash must both be valid for str.
1086 share_hek(str, len, hash)
1091 register XPVHV* xhv;
1093 register HE **oentry;
1097 /* what follows is the moral equivalent of:
1099 if (!(Svp = hv_fetch(strtab, str, len, FALSE)))
1100 hv_store(strtab, str, len, Nullsv, hash);
1102 xhv = (XPVHV*)SvANY(strtab);
1103 /* assert(xhv_array != 0) */
1104 oentry = &((HE**)xhv->xhv_array)[hash & (I32) xhv->xhv_max];
1105 for (entry = *oentry; entry; i=0, entry = HeNEXT(entry)) {
1106 if (HeHASH(entry) != hash) /* strings can't be equal */
1108 if (HeKLEN(entry) != len)
1110 if (memNE(HeKEY(entry),str,len)) /* is this it? */
1117 HeKEY_hek(entry) = save_hek(str, len, hash);
1118 HeVAL(entry) = Nullsv;
1119 HeNEXT(entry) = *oentry;
1122 if (i) { /* initial entry? */
1124 if (xhv->xhv_keys > xhv->xhv_max)
1129 ++HeVAL(entry); /* use value slot as REFCNT */
1130 return HeKEY_hek(entry);