2 * Copyright © 2009-2012 Intel Corporation
3 * Copyright © 1988-2004 Keith Packard and Bart Massey.
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice (including the next
13 * paragraph) shall be included in all copies or substantial portions of the
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
24 * Except as contained in this notice, the names of the authors
25 * or their institutions shall not be used in advertising or
26 * otherwise to promote the sale, use or other dealings in this
27 * Software without prior written authorization from the
31 * Eric Anholt <eric@anholt.net>
32 * Keith Packard <keithp@keithp.com>
43 * From Knuth -- a good choice for hash/rehash values is p, p-2 where
44 * p and p-2 are both prime. These tables are sized to have an extra 10%
45 * free to avoid exponential performance degradation as the hash table fills
48 static const uint32_t deleted_key_value
;
49 static const void *deleted_key
= &deleted_key_value
;
52 uint32_t max_entries
, size
, rehash
;
67 { 16384, 18043, 18041 },
68 { 32768, 36109, 36107 },
69 { 65536, 72091, 72089 },
70 { 131072, 144409, 144407 },
71 { 262144, 288361, 288359 },
72 { 524288, 576883, 576881 },
73 { 1048576, 1153459, 1153457 },
74 { 2097152, 2307163, 2307161 },
75 { 4194304, 4613893, 4613891 },
76 { 8388608, 9227641, 9227639 },
77 { 16777216, 18455029, 18455027 },
78 { 33554432, 36911011, 36911009 },
79 { 67108864, 73819861, 73819859 },
80 { 134217728, 147639589, 147639587 },
81 { 268435456, 295279081, 295279079 },
82 { 536870912, 590559793, 590559791 },
83 { 1073741824, 1181116273, 1181116271 },
84 { 2147483648ul, 2362232233ul, 2362232231ul }
88 entry_is_free(struct set_entry
*entry
)
90 return entry
->key
== NULL
;
94 entry_is_deleted(struct set_entry
*entry
)
96 return entry
->key
== deleted_key
;
100 entry_is_present(struct set_entry
*entry
)
102 return entry
->key
!= NULL
&& entry
->key
!= deleted_key
;
106 _mesa_set_create(void *mem_ctx
,
107 uint32_t (*key_hash_function
)(const void *key
),
108 bool (*key_equals_function
)(const void *a
,
113 ht
= ralloc(mem_ctx
, struct set
);
118 ht
->size
= hash_sizes
[ht
->size_index
].size
;
119 ht
->rehash
= hash_sizes
[ht
->size_index
].rehash
;
120 ht
->max_entries
= hash_sizes
[ht
->size_index
].max_entries
;
121 ht
->key_hash_function
= key_hash_function
;
122 ht
->key_equals_function
= key_equals_function
;
123 ht
->table
= rzalloc_array(ht
, struct set_entry
, ht
->size
);
125 ht
->deleted_entries
= 0;
127 if (ht
->table
== NULL
) {
136 * Frees the given set.
138 * If delete_function is passed, it gets called on each entry present before
142 _mesa_set_destroy(struct set
*ht
, void (*delete_function
)(struct set_entry
*entry
))
147 if (delete_function
) {
148 struct set_entry
*entry
;
150 set_foreach (ht
, entry
) {
151 delete_function(entry
);
154 ralloc_free(ht
->table
);
159 * Clears all values from the given set.
161 * If delete_function is passed, it gets called on each entry present before
162 * the set is cleared.
165 _mesa_set_clear(struct set
*set
, void (*delete_function
)(struct set_entry
*entry
))
167 struct set_entry
*entry
;
172 set_foreach (set
, entry
) {
174 delete_function(entry
);
175 entry
->key
= deleted_key
;
178 set
->entries
= set
->deleted_entries
= 0;
182 * Finds a set entry with the given key and hash of that key.
184 * Returns NULL if no entry is found.
186 static struct set_entry
*
187 set_search(const struct set
*ht
, uint32_t hash
, const void *key
)
189 uint32_t hash_address
;
191 hash_address
= hash
% ht
->size
;
193 uint32_t double_hash
;
195 struct set_entry
*entry
= ht
->table
+ hash_address
;
197 if (entry_is_free(entry
)) {
199 } else if (entry_is_present(entry
) && entry
->hash
== hash
) {
200 if (ht
->key_equals_function(key
, entry
->key
)) {
205 double_hash
= 1 + hash
% ht
->rehash
;
207 hash_address
= (hash_address
+ double_hash
) % ht
->size
;
208 } while (hash_address
!= hash
% ht
->size
);
214 _mesa_set_search(const struct set
*set
, const void *key
)
216 assert(set
->key_hash_function
);
217 return set_search(set
, set
->key_hash_function(key
), key
);
221 _mesa_set_search_pre_hashed(const struct set
*set
, uint32_t hash
,
224 assert(set
->key_hash_function
== NULL
||
225 hash
== set
->key_hash_function(key
));
226 return set_search(set
, hash
, key
);
229 static struct set_entry
*
230 set_add(struct set
*ht
, uint32_t hash
, const void *key
);
233 set_rehash(struct set
*ht
, unsigned new_size_index
)
236 struct set_entry
*table
, *entry
;
238 if (new_size_index
>= ARRAY_SIZE(hash_sizes
))
241 table
= rzalloc_array(ht
, struct set_entry
,
242 hash_sizes
[new_size_index
].size
);
249 ht
->size_index
= new_size_index
;
250 ht
->size
= hash_sizes
[ht
->size_index
].size
;
251 ht
->rehash
= hash_sizes
[ht
->size_index
].rehash
;
252 ht
->max_entries
= hash_sizes
[ht
->size_index
].max_entries
;
254 ht
->deleted_entries
= 0;
256 set_foreach(&old_ht
, entry
) {
257 set_add(ht
, entry
->hash
, entry
->key
);
260 ralloc_free(old_ht
.table
);
264 * Inserts the key with the given hash into the table.
266 * Note that insertion may rearrange the table on a resize or rehash,
267 * so previously found hash_entries are no longer valid after this function.
269 static struct set_entry
*
270 set_add(struct set
*ht
, uint32_t hash
, const void *key
)
272 uint32_t hash_address
;
273 struct set_entry
*available_entry
= NULL
;
275 if (ht
->entries
>= ht
->max_entries
) {
276 set_rehash(ht
, ht
->size_index
+ 1);
277 } else if (ht
->deleted_entries
+ ht
->entries
>= ht
->max_entries
) {
278 set_rehash(ht
, ht
->size_index
);
281 hash_address
= hash
% ht
->size
;
283 struct set_entry
*entry
= ht
->table
+ hash_address
;
284 uint32_t double_hash
;
286 if (!entry_is_present(entry
)) {
287 /* Stash the first available entry we find */
288 if (available_entry
== NULL
)
289 available_entry
= entry
;
290 if (entry_is_free(entry
))
294 /* Implement replacement when another insert happens
295 * with a matching key. This is a relatively common
296 * feature of hash tables, with the alternative
297 * generally being "insert the new value as well, and
298 * return it first when the key is searched for".
300 * Note that the hash table doesn't have a delete callback.
301 * If freeing of old keys is required to avoid memory leaks,
302 * perform a search before inserting.
304 if (!entry_is_deleted(entry
) &&
305 entry
->hash
== hash
&&
306 ht
->key_equals_function(key
, entry
->key
)) {
311 double_hash
= 1 + hash
% ht
->rehash
;
313 hash_address
= (hash_address
+ double_hash
) % ht
->size
;
314 } while (hash_address
!= hash
% ht
->size
);
316 if (available_entry
) {
317 if (entry_is_deleted(available_entry
))
318 ht
->deleted_entries
--;
319 available_entry
->hash
= hash
;
320 available_entry
->key
= key
;
322 return available_entry
;
325 /* We could hit here if a required resize failed. An unchecked-malloc
326 * application could ignore this result.
332 _mesa_set_add(struct set
*set
, const void *key
)
334 assert(set
->key_hash_function
);
335 return set_add(set
, set
->key_hash_function(key
), key
);
339 _mesa_set_add_pre_hashed(struct set
*set
, uint32_t hash
, const void *key
)
341 assert(set
->key_hash_function
== NULL
||
342 hash
== set
->key_hash_function(key
));
343 return set_add(set
, hash
, key
);
347 * This function deletes the given hash table entry.
349 * Note that deletion doesn't otherwise modify the table, so an iteration over
350 * the table deleting entries is safe.
353 _mesa_set_remove(struct set
*ht
, struct set_entry
*entry
)
358 entry
->key
= deleted_key
;
360 ht
->deleted_entries
++;
364 * This function is an iterator over the hash table.
366 * Pass in NULL for the first entry, as in the start of a for loop. Note that
367 * an iteration over the table is O(table_size) not O(entries).
370 _mesa_set_next_entry(const struct set
*ht
, struct set_entry
*entry
)
377 for (; entry
!= ht
->table
+ ht
->size
; entry
++) {
378 if (entry_is_present(entry
)) {
387 _mesa_set_random_entry(struct set
*ht
,
388 int (*predicate
)(struct set_entry
*entry
))
390 struct set_entry
*entry
;
391 uint32_t i
= rand() % ht
->size
;
393 if (ht
->entries
== 0)
396 for (entry
= ht
->table
+ i
; entry
!= ht
->table
+ ht
->size
; entry
++) {
397 if (entry_is_present(entry
) &&
398 (!predicate
|| predicate(entry
))) {
403 for (entry
= ht
->table
; entry
!= ht
->table
+ i
; entry
++) {
404 if (entry_is_present(entry
) &&
405 (!predicate
|| predicate(entry
))) {