htable: reduce size of htable by storing perfect bitnum, not mask.
[ccan] / ccan / htable / htable.c
1 /* Licensed under LGPLv2+ - see LICENSE file for details */
2 #include <ccan/htable/htable.h>
3 #include <ccan/compiler/compiler.h>
4 #include <stdlib.h>
5 #include <stdio.h>
6 #include <limits.h>
7 #include <stdbool.h>
8 #include <assert.h>
9 #include <string.h>
10
11 /* We use 0x1 as deleted marker. */
12 #define HTABLE_DELETED (0x1)
13
14 static void *htable_default_alloc(struct htable *ht, size_t len)
15 {
16         return calloc(len, 1);
17 }
18
19 static void htable_default_free(struct htable *ht, void *p)
20 {
21         free(p);
22 }
23
24 static void *(*htable_alloc)(struct htable *, size_t) = htable_default_alloc;
25 static void (*htable_free)(struct htable *, void *) = htable_default_free;
26
27 void htable_set_allocator(void *(*alloc)(struct htable *, size_t len),
28                           void (*free)(struct htable *, void *p))
29 {
30         if (!alloc)
31                 alloc = htable_default_alloc;
32         if (!free)
33                 free = htable_default_free;
34         htable_alloc = alloc;
35         htable_free = free;
36 }
37
38 /* We clear out the bits which are always the same, and put metadata there. */
39 static inline uintptr_t get_extra_ptr_bits(const struct htable *ht,
40                                            uintptr_t e)
41 {
42         return e & ht->common_mask;
43 }
44
45 static inline void *get_raw_ptr(const struct htable *ht, uintptr_t e)
46 {
47         return (void *)((e & ~ht->common_mask) | ht->common_bits);
48 }
49
50 static inline uintptr_t make_hval(const struct htable *ht,
51                                   const void *p, uintptr_t bits)
52 {
53         return ((uintptr_t)p & ~ht->common_mask) | bits;
54 }
55
56 static inline bool entry_is_valid(uintptr_t e)
57 {
58         return e > HTABLE_DELETED;
59 }
60
61 /* We use 0 to mean we don't have a perfect bit, otherwise it's
62  * bit n - 1 */
63 static inline uintptr_t ht_perfect_mask(const struct htable *ht)
64 {
65         if (ht->perfect_bitnum > 0)
66                 return (uintptr_t)1 << (ht->perfect_bitnum - 1);
67         return 0;
68 }
69
70 static inline uintptr_t get_hash_ptr_bits(const struct htable *ht,
71                                           size_t hash)
72 {
73         /* Shuffling the extra bits (as specified in mask) down the
74          * end is quite expensive.  But the lower bits are redundant, so
75          * we fold the value first. */
76         return (hash ^ (hash >> ht->bits))
77                 & ht->common_mask & ~ht_perfect_mask(ht);
78 }
79
80 void htable_init(struct htable *ht,
81                  size_t (*rehash)(const void *elem, void *priv), void *priv)
82 {
83         struct htable empty = HTABLE_INITIALIZER(empty, NULL, NULL);
84         *ht = empty;
85         ht->rehash = rehash;
86         ht->priv = priv;
87         ht->table = &ht->common_bits;
88 }
89
90 static inline size_t ht_max(const struct htable *ht)
91 {
92         return ((size_t)3 << ht->bits) / 4;
93 }
94
95 static inline size_t ht_max_with_deleted(const struct htable *ht)
96 {
97         return ((size_t)9 << ht->bits) / 10;
98 }
99
100 bool htable_init_sized(struct htable *ht,
101                        size_t (*rehash)(const void *, void *),
102                        void *priv, size_t expect)
103 {
104         htable_init(ht, rehash, priv);
105
106         /* Don't go insane with sizing. */
107         for (ht->bits = 1; ((size_t)3 << ht->bits) / 4 < expect; ht->bits++) {
108                 if (ht->bits == 30)
109                         break;
110         }
111
112         ht->table = htable_alloc(ht, sizeof(size_t) << ht->bits);
113         if (!ht->table) {
114                 ht->table = &ht->common_bits;
115                 return false;
116         }
117         (void)htable_debug(ht, HTABLE_LOC);
118         return true;
119 }
120         
121 void htable_clear(struct htable *ht)
122 {
123         if (ht->table != &ht->common_bits)
124                 htable_free(ht, (void *)ht->table);
125         htable_init(ht, ht->rehash, ht->priv);
126 }
127
128 bool htable_copy_(struct htable *dst, const struct htable *src)
129 {
130         uintptr_t *htable = htable_alloc(dst, sizeof(size_t) << src->bits);
131
132         if (!htable)
133                 return false;
134
135         *dst = *src;
136         dst->table = htable;
137         memcpy(dst->table, src->table, sizeof(size_t) << src->bits);
138         return true;
139 }
140
141 static size_t hash_bucket(const struct htable *ht, size_t h)
142 {
143         return h & ((1 << ht->bits)-1);
144 }
145
146 static void *htable_val(const struct htable *ht,
147                         struct htable_iter *i, size_t hash, uintptr_t perfect)
148 {
149         uintptr_t h2 = get_hash_ptr_bits(ht, hash) | perfect;
150
151         while (ht->table[i->off]) {
152                 if (ht->table[i->off] != HTABLE_DELETED) {
153                         if (get_extra_ptr_bits(ht, ht->table[i->off]) == h2)
154                                 return get_raw_ptr(ht, ht->table[i->off]);
155                 }
156                 i->off = (i->off + 1) & ((1 << ht->bits)-1);
157                 h2 &= ~perfect;
158         }
159         return NULL;
160 }
161
162 void *htable_firstval_(const struct htable *ht,
163                        struct htable_iter *i, size_t hash)
164 {
165         i->off = hash_bucket(ht, hash);
166         return htable_val(ht, i, hash, ht_perfect_mask(ht));
167 }
168
169 void *htable_nextval_(const struct htable *ht,
170                       struct htable_iter *i, size_t hash)
171 {
172         i->off = (i->off + 1) & ((1 << ht->bits)-1);
173         return htable_val(ht, i, hash, 0);
174 }
175
176 void *htable_first_(const struct htable *ht, struct htable_iter *i)
177 {
178         for (i->off = 0; i->off < (size_t)1 << ht->bits; i->off++) {
179                 if (entry_is_valid(ht->table[i->off]))
180                         return get_raw_ptr(ht, ht->table[i->off]);
181         }
182         return NULL;
183 }
184
185 void *htable_next_(const struct htable *ht, struct htable_iter *i)
186 {
187         for (i->off++; i->off < (size_t)1 << ht->bits; i->off++) {
188                 if (entry_is_valid(ht->table[i->off]))
189                         return get_raw_ptr(ht, ht->table[i->off]);
190         }
191         return NULL;
192 }
193
194 void *htable_prev_(const struct htable *ht, struct htable_iter *i)
195 {
196         for (;;) {
197                 if (!i->off)
198                         return NULL;
199                 i->off --;
200                 if (entry_is_valid(ht->table[i->off]))
201                         return get_raw_ptr(ht, ht->table[i->off]);
202         }
203 }
204
205 /* This does not expand the hash table, that's up to caller. */
206 static void ht_add(struct htable *ht, const void *new, size_t h)
207 {
208         size_t i;
209         uintptr_t perfect = ht_perfect_mask(ht);
210
211         i = hash_bucket(ht, h);
212
213         while (entry_is_valid(ht->table[i])) {
214                 perfect = 0;
215                 i = (i + 1) & ((1 << ht->bits)-1);
216         }
217         ht->table[i] = make_hval(ht, new, get_hash_ptr_bits(ht, h)|perfect);
218 }
219
220 static COLD bool double_table(struct htable *ht)
221 {
222         unsigned int i;
223         size_t oldnum = (size_t)1 << ht->bits;
224         uintptr_t *oldtable, e;
225
226         oldtable = ht->table;
227         ht->table = htable_alloc(ht, sizeof(size_t) << (ht->bits+1));
228         if (!ht->table) {
229                 ht->table = oldtable;
230                 return false;
231         }
232         ht->bits++;
233
234         /* If we lost our "perfect bit", get it back now. */
235         if (ht->perfect_bitnum == 0 && ht->common_mask) {
236                 for (i = 0; i < sizeof(ht->common_mask) * CHAR_BIT; i++) {
237                         if (ht->common_mask & ((size_t)1 << i)) {
238                                 ht->perfect_bitnum = i + 1;
239                                 break;
240                         }
241                 }
242         }
243
244         if (oldtable != &ht->common_bits) {
245                 for (i = 0; i < oldnum; i++) {
246                         if (entry_is_valid(e = oldtable[i])) {
247                                 void *p = get_raw_ptr(ht, e);
248                                 ht_add(ht, p, ht->rehash(p, ht->priv));
249                         }
250                 }
251                 htable_free(ht, oldtable);
252         }
253         ht->deleted = 0;
254
255         (void)htable_debug(ht, HTABLE_LOC);
256         return true;
257 }
258
259 static COLD void rehash_table(struct htable *ht)
260 {
261         size_t start, i;
262         uintptr_t e;
263
264         /* Beware wrap cases: we need to start from first empty bucket. */
265         for (start = 0; ht->table[start]; start++);
266
267         for (i = 0; i < (size_t)1 << ht->bits; i++) {
268                 size_t h = (i + start) & ((1 << ht->bits)-1);
269                 e = ht->table[h];
270                 if (!e)
271                         continue;
272                 if (e == HTABLE_DELETED)
273                         ht->table[h] = 0;
274                 else if (!(e & ht_perfect_mask(ht))) {
275                         void *p = get_raw_ptr(ht, e);
276                         ht->table[h] = 0;
277                         ht_add(ht, p, ht->rehash(p, ht->priv));
278                 }
279         }
280         ht->deleted = 0;
281         (void)htable_debug(ht, HTABLE_LOC);
282 }
283
284 /* We stole some bits, now we need to put them back... */
285 static COLD void update_common(struct htable *ht, const void *p)
286 {
287         unsigned int i;
288         uintptr_t maskdiff, bitsdiff;
289
290         if (ht->elems == 0) {
291                 /* Always reveal one bit of the pointer in the bucket,
292                  * so it's not zero or HTABLE_DELETED (1), even if
293                  * hash happens to be 0.  Assumes (void *)1 is not a
294                  * valid pointer. */
295                 for (i = sizeof(uintptr_t)*CHAR_BIT - 1; i > 0; i--) {
296                         if ((uintptr_t)p & ((uintptr_t)1 << i))
297                                 break;
298                 }
299
300                 ht->common_mask = ~((uintptr_t)1 << i);
301                 ht->common_bits = ((uintptr_t)p & ht->common_mask);
302                 ht->perfect_bitnum = 1;
303                 (void)htable_debug(ht, HTABLE_LOC);
304                 return;
305         }
306
307         /* Find bits which are unequal to old common set. */
308         maskdiff = ht->common_bits ^ ((uintptr_t)p & ht->common_mask);
309
310         /* These are the bits which go there in existing entries. */
311         bitsdiff = ht->common_bits & maskdiff;
312
313         for (i = 0; i < (size_t)1 << ht->bits; i++) {
314                 if (!entry_is_valid(ht->table[i]))
315                         continue;
316                 /* Clear the bits no longer in the mask, set them as
317                  * expected. */
318                 ht->table[i] &= ~maskdiff;
319                 ht->table[i] |= bitsdiff;
320         }
321
322         /* Take away those bits from our mask, bits and perfect bit. */
323         ht->common_mask &= ~maskdiff;
324         ht->common_bits &= ~maskdiff;
325         if (ht_perfect_mask(ht) & maskdiff)
326                 ht->perfect_bitnum = 0;
327         (void)htable_debug(ht, HTABLE_LOC);
328 }
329
330 bool htable_add_(struct htable *ht, size_t hash, const void *p)
331 {
332         if (ht->elems+1 > ht_max(ht) && !double_table(ht))
333                 return false;
334         if (ht->elems+1 + ht->deleted > ht_max_with_deleted(ht))
335                 rehash_table(ht);
336         assert(p);
337         if (((uintptr_t)p & ht->common_mask) != ht->common_bits)
338                 update_common(ht, p);
339
340         ht_add(ht, p, hash);
341         ht->elems++;
342         return true;
343 }
344
345 bool htable_del_(struct htable *ht, size_t h, const void *p)
346 {
347         struct htable_iter i;
348         void *c;
349
350         for (c = htable_firstval(ht,&i,h); c; c = htable_nextval(ht,&i,h)) {
351                 if (c == p) {
352                         htable_delval(ht, &i);
353                         return true;
354                 }
355         }
356         return false;
357 }
358
359 void htable_delval_(struct htable *ht, struct htable_iter *i)
360 {
361         assert(i->off < (size_t)1 << ht->bits);
362         assert(entry_is_valid(ht->table[i->off]));
363
364         ht->elems--;
365         ht->table[i->off] = HTABLE_DELETED;
366         ht->deleted++;
367 }
368
369 struct htable *htable_check(const struct htable *ht, const char *abortstr)
370 {
371         void *p;
372         struct htable_iter i;
373         size_t n = 0;
374
375         /* Use non-DEBUG versions here, to avoid infinite recursion with
376          * CCAN_HTABLE_DEBUG! */
377         for (p = htable_first_(ht, &i); p; p = htable_next_(ht, &i)) {
378                 struct htable_iter i2;
379                 void *c;
380                 size_t h = ht->rehash(p, ht->priv);
381                 bool found = false;
382
383                 n++;
384
385                 /* Open-code htable_get to avoid CCAN_HTABLE_DEBUG */
386                 for (c = htable_firstval_(ht, &i2, h);
387                      c;
388                      c = htable_nextval_(ht, &i2, h)) {
389                         if (c == p) {
390                                 found = true;
391                                 break;
392                         }
393                 }
394
395                 if (!found) {
396                         if (abortstr) {
397                                 fprintf(stderr,
398                                         "%s: element %p in position %zu"
399                                         " cannot find itself\n",
400                                         abortstr, p, i.off);
401                                 abort();
402                         }
403                         return NULL;
404                 }
405         }
406         if (n != ht->elems) {
407                 if (abortstr) {
408                         fprintf(stderr,
409                                 "%s: found %zu elems, expected %zu\n",
410                                 abortstr, n, ht->elems);
411                         abort();
412                 }
413                 return NULL;
414         }
415
416         return (struct htable *)ht;
417 }