Add BLI_compiler_compat.h to help with portability
[blender.git] / source / blender / blenlib / intern / smallhash.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2008 Blender Foundation.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): Joseph Eagar.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file blender/blenlib/intern/smallhash.c
29  *  \ingroup bli
30  *
31  * A light stack-friendly hash library, it uses stack space for smallish hash tables
32  * but falls back to heap memory once the stack limits reached.
33  *
34  * based on a doubling non-chaining approach  which uses more buckets then entries
35  * stepping over buckets when two keys share the same hash so any key can find a free bucket.
36  *
37  *
38  * #SmallHashEntry.key
39  * - ``SMHASH_KEY_UNUSED`` means the key in the cell has not been initialized.
40  *
41  * #SmallHashEntry.val
42  * - ``SMHASH_CELL_UNUSED`` means this cell is inside a key series.
43  * - ``SMHASH_CELL_FREE`` means this cell terminates a key series.
44  *
45  * Note that the values and keys are often pointers or index values,
46  * use the maximum values to avoid real pointers colliding with magic numbers.
47  *
48  * \note these have the SMHASH prefix because we may want to make them public.
49  */
50
51 #include <string.h>
52 #include <stdlib.h>
53 #include <BLI_sys_types.h>
54
55 #include "MEM_guardedalloc.h"
56
57 #include "BLI_utildefines.h"
58
59 #include "BLI_smallhash.h"
60
61 #include "BLI_strict_flags.h"
62
63 #define SMHASH_KEY_UNUSED   ((uintptr_t)(UINTPTR_MAX - 0))
64 #define SMHASH_CELL_FREE    ((void *)   (UINTPTR_MAX - 1))
65 #define SMHASH_CELL_UNUSED  ((void *)   (UINTPTR_MAX - 2))
66
67 /* typically this re-assigns 'h' */
68 #define SMHASH_NEXT(h, hoff)  ( \
69         CHECK_TYPE_INLINE(&(h),    unsigned int *), \
70         CHECK_TYPE_INLINE(&(hoff), unsigned int *), \
71         ((h) + (((hoff) = ((hoff) * 2) + 1), (hoff))) \
72         )
73
74
75 /* nothing uses BLI_smallhash_remove yet */
76 // #define USE_REMOVE
77
78 BLI_INLINE bool smallhash_val_is_used(const void *val)
79 {
80 #ifdef USE_REMOVE
81         return !ELEM(val, SMHASH_CELL_FREE, SMHASH_CELL_UNUSED);
82 #else
83         return (val != SMHASH_CELL_FREE);
84 #endif
85 }
86
87 extern const unsigned int hashsizes[];
88
89 /**
90  * Check if the number of items in the smallhash is large enough to require more buckets.
91  */
92 BLI_INLINE bool smallhash_test_expand_buckets(const unsigned int nentries, const unsigned int nbuckets)
93 {
94         /* (approx * 1.5) */
95         return (nentries + (nentries >> 1)) > nbuckets;
96 }
97
98 BLI_INLINE void smallhash_init_empty(SmallHash *sh)
99 {
100         unsigned int i;
101
102         for (i = 0; i < sh->nbuckets; i++) {
103                 sh->buckets[i].key = SMHASH_KEY_UNUSED;
104                 sh->buckets[i].val = SMHASH_CELL_FREE;
105         }
106 }
107
108 /**
109  * Increase initial bucket size to match a reserved amount.
110  */
111 BLI_INLINE void smallhash_buckets_reserve(SmallHash *sh, const unsigned int nentries_reserve)
112 {
113         while (smallhash_test_expand_buckets(nentries_reserve, sh->nbuckets)) {
114                 sh->nbuckets = hashsizes[++sh->cursize];
115         }
116 }
117
118 BLI_INLINE SmallHashEntry *smallhash_lookup(SmallHash *sh, const uintptr_t key)
119 {
120         SmallHashEntry *e;
121         unsigned int h = (unsigned int)key;
122         unsigned int hoff = 1;
123
124         BLI_assert(key != SMHASH_KEY_UNUSED);
125
126         /* note: there are always more buckets then entries,
127          * so we know there will always be a free bucket if the key isn't found. */
128         for (e = &sh->buckets[h % sh->nbuckets];
129              e->val != SMHASH_CELL_FREE;
130              h = SMHASH_NEXT(h, hoff), e = &sh->buckets[h % sh->nbuckets])
131         {
132                 if (e->key == key) {
133                         /* should never happen because unused keys are zero'd */
134                         BLI_assert(e->val != SMHASH_CELL_UNUSED);
135                         return e;
136                 }
137         }
138
139         return NULL;
140 }
141
142 BLI_INLINE SmallHashEntry *smallhash_lookup_first_free(SmallHash *sh, const uintptr_t key)
143 {
144         SmallHashEntry *e;
145         unsigned int h = (unsigned int)key;
146         unsigned int hoff = 1;
147
148         for (e = &sh->buckets[h % sh->nbuckets];
149              smallhash_val_is_used(e->val);
150              h = SMHASH_NEXT(h, hoff), e = &sh->buckets[h % sh->nbuckets])
151         {
152                 /* pass */
153         }
154
155         return e;
156 }
157
158 BLI_INLINE void smallhash_resize_buckets(SmallHash *sh, const unsigned int nbuckets)
159 {
160         SmallHashEntry *buckets_old = sh->buckets;
161         const unsigned int nbuckets_old = sh->nbuckets;
162         const bool was_alloc = (buckets_old != sh->buckets_stack);
163         unsigned int i = 0;
164
165         BLI_assert(sh->nbuckets != nbuckets);
166         if (nbuckets <= SMSTACKSIZE) {
167                 const size_t size = sizeof(*buckets_old) * nbuckets_old;
168                 buckets_old = alloca(size);
169                 memcpy(buckets_old, sh->buckets, size);
170
171                 sh->buckets = sh->buckets_stack;
172         }
173         else {
174                 sh->buckets = MEM_mallocN(sizeof(*sh->buckets) * nbuckets, __func__);
175         }
176
177         sh->nbuckets = nbuckets;
178
179         smallhash_init_empty(sh);
180
181         for (i = 0; i < nbuckets_old; i++) {
182                 if (smallhash_val_is_used(buckets_old[i].val)) {
183                         SmallHashEntry *e = smallhash_lookup_first_free(sh, buckets_old[i].key);
184                         e->key = buckets_old[i].key;
185                         e->val = buckets_old[i].val;
186                 }
187         }
188
189         if (was_alloc) {
190                 MEM_freeN(buckets_old);
191         }
192 }
193
194 void BLI_smallhash_init_ex(SmallHash *sh,
195                            const unsigned int nentries_reserve)
196 {
197         /* assume 'sh' is uninitialized */
198
199         sh->nentries = 0;
200         sh->cursize = 2;
201         sh->nbuckets = hashsizes[sh->cursize];
202
203         sh->buckets = sh->buckets_stack;
204
205         if (nentries_reserve) {
206                 smallhash_buckets_reserve(sh, nentries_reserve);
207
208                 if (sh->nbuckets > SMSTACKSIZE) {
209                         sh->buckets = MEM_mallocN(sizeof(*sh->buckets) * sh->nbuckets, __func__);
210                 }
211         }
212
213         smallhash_init_empty(sh);
214 }
215
216 void BLI_smallhash_init(SmallHash *sh)
217 {
218         BLI_smallhash_init_ex(sh, 0);
219 }
220
221 /*NOTE: does *not* free *sh itself!  only the direct data!*/
222 void BLI_smallhash_release(SmallHash *sh)
223 {
224         if (sh->buckets != sh->buckets_stack) {
225                 MEM_freeN(sh->buckets);
226         }
227 }
228
229 void BLI_smallhash_insert(SmallHash *sh, uintptr_t key, void *val)
230 {
231         SmallHashEntry *e;
232
233         BLI_assert(key != SMHASH_KEY_UNUSED);
234         BLI_assert(smallhash_val_is_used(val));
235         BLI_assert(BLI_smallhash_haskey(sh, key) == false);
236
237         if (UNLIKELY(smallhash_test_expand_buckets(++sh->nentries, sh->nbuckets))) {
238                 smallhash_resize_buckets(sh, hashsizes[++sh->cursize]);
239         }
240
241         e = smallhash_lookup_first_free(sh, key);
242         e->key = key;
243         e->val = val;
244 }
245
246 #ifdef USE_REMOVE
247 bool BLI_smallhash_remove(SmallHash *sh, uintptr_t key)
248 {
249         SmallHashEntry *e = smallhash_lookup(sh, key);
250
251         if (e) {
252                 e->key = SMHASH_KEY_UNUSED;
253                 e->val = SMHASH_CELL_UNUSED;
254                 sh->nentries--;
255
256                 return true;
257         }
258         else {
259                 return false;
260         }
261 }
262 #endif
263
264 void *BLI_smallhash_lookup(SmallHash *sh, uintptr_t key)
265 {
266         SmallHashEntry *e = smallhash_lookup(sh, key);
267
268         return e ? e->val : NULL;
269 }
270
271 void **BLI_smallhash_lookup_p(SmallHash *sh, uintptr_t key)
272 {
273         SmallHashEntry *e = smallhash_lookup(sh, key);
274
275         return e ? &e->val : NULL;
276 }
277
278 bool BLI_smallhash_haskey(SmallHash *sh, uintptr_t key)
279 {
280         SmallHashEntry *e = smallhash_lookup(sh, key);
281
282         return (e != NULL);
283 }
284
285 int BLI_smallhash_count(SmallHash *sh)
286 {
287         return (int)sh->nentries;
288 }
289
290 void *BLI_smallhash_iternext(SmallHashIter *iter, uintptr_t *key)
291 {
292         while (iter->i < iter->sh->nbuckets) {
293                 if (smallhash_val_is_used(iter->sh->buckets[iter->i].val)) {
294                         if (key) {
295                                 *key = iter->sh->buckets[iter->i].key;
296                         }
297
298                         return iter->sh->buckets[iter->i++].val;
299                 }
300
301                 iter->i++;
302         }
303
304         return NULL;
305 }
306
307 void *BLI_smallhash_iternew(SmallHash *sh, SmallHashIter *iter, uintptr_t *key)
308 {
309         iter->sh = sh;
310         iter->i = 0;
311
312         return BLI_smallhash_iternext(iter, key);
313 }
314
315 /* note, this was called _print_smhash in knifetool.c
316  * it may not be intended for general use - campbell */
317 #if 0
318 void BLI_smallhash_print(SmallHash *sh)
319 {
320         unsigned int i, linecol = 79, c = 0;
321
322         printf("{");
323         for (i = 0; i < sh->nbuckets; i++) {
324                 if (sh->buckets[i].val == SMHASH_CELL_UNUSED) {
325                         printf("--u-");
326                 }
327                 else if (sh->buckets[i].val == SMHASH_CELL_FREE) {
328                         printf("--f-");
329                 }
330                 else {
331                         printf("%2x", (unsigned int)sh->buckets[i].key);
332                 }
333
334                 if (i != sh->nbuckets - 1)
335                         printf(", ");
336
337                 c += 6;
338
339                 if (c >= linecol) {
340                         printf("\n ");
341                         c = 0;
342                 }
343         }
344
345         fflush(stdout);
346 }
347 #endif