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>
36 * Implements an open-addressing, linear-reprobing hash table.
38 * For more information, see:
40 * http://cgit.freedesktop.org/~anholt/hash_table/tree/README
47 #include "hash_table.h"
50 #include "main/hash.h"
52 static const uint32_t deleted_key_value
;
55 * From Knuth -- a good choice for hash/rehash values is p, p-2 where
56 * p and p-2 are both prime. These tables are sized to have an extra 10%
57 * free to avoid exponential performance degradation as the hash table fills
60 uint32_t max_entries
, size
, rehash
;
75 { 16384, 18043, 18041 },
76 { 32768, 36109, 36107 },
77 { 65536, 72091, 72089 },
78 { 131072, 144409, 144407 },
79 { 262144, 288361, 288359 },
80 { 524288, 576883, 576881 },
81 { 1048576, 1153459, 1153457 },
82 { 2097152, 2307163, 2307161 },
83 { 4194304, 4613893, 4613891 },
84 { 8388608, 9227641, 9227639 },
85 { 16777216, 18455029, 18455027 },
86 { 33554432, 36911011, 36911009 },
87 { 67108864, 73819861, 73819859 },
88 { 134217728, 147639589, 147639587 },
89 { 268435456, 295279081, 295279079 },
90 { 536870912, 590559793, 590559791 },
91 { 1073741824, 1181116273, 1181116271},
92 { 2147483648ul, 2362232233ul, 2362232231ul}
96 entry_is_free(const struct hash_entry
*entry
)
98 return entry
->key
== NULL
;
102 entry_is_deleted(const struct hash_table
*ht
, struct hash_entry
*entry
)
104 return entry
->key
== ht
->deleted_key
;
108 entry_is_present(const struct hash_table
*ht
, struct hash_entry
*entry
)
110 return entry
->key
!= NULL
&& entry
->key
!= ht
->deleted_key
;
114 _mesa_hash_table_create(void *mem_ctx
,
115 uint32_t (*key_hash_function
)(const void *key
),
116 bool (*key_equals_function
)(const void *a
,
119 struct hash_table
*ht
;
121 ht
= ralloc(mem_ctx
, struct hash_table
);
126 ht
->size
= hash_sizes
[ht
->size_index
].size
;
127 ht
->rehash
= hash_sizes
[ht
->size_index
].rehash
;
128 ht
->max_entries
= hash_sizes
[ht
->size_index
].max_entries
;
129 ht
->key_hash_function
= key_hash_function
;
130 ht
->key_equals_function
= key_equals_function
;
131 ht
->table
= rzalloc_array(ht
, struct hash_entry
, ht
->size
);
133 ht
->deleted_entries
= 0;
134 ht
->deleted_key
= &deleted_key_value
;
136 if (ht
->table
== NULL
) {
145 _mesa_hash_table_clone(struct hash_table
*src
, void *dst_mem_ctx
)
147 struct hash_table
*ht
;
149 ht
= ralloc(dst_mem_ctx
, struct hash_table
);
153 memcpy(ht
, src
, sizeof(struct hash_table
));
155 ht
->table
= ralloc_array(ht
, struct hash_entry
, ht
->size
);
156 if (ht
->table
== NULL
) {
161 memcpy(ht
->table
, src
->table
, ht
->size
* sizeof(struct hash_entry
));
167 * Frees the given hash table.
169 * If delete_function is passed, it gets called on each entry present before
173 _mesa_hash_table_destroy(struct hash_table
*ht
,
174 void (*delete_function
)(struct hash_entry
*entry
))
179 if (delete_function
) {
180 struct hash_entry
*entry
;
182 hash_table_foreach(ht
, entry
) {
183 delete_function(entry
);
190 * Deletes all entries of the given hash table without deleting the table
191 * itself or changing its structure.
193 * If delete_function is passed, it gets called on each entry present.
196 _mesa_hash_table_clear(struct hash_table
*ht
,
197 void (*delete_function
)(struct hash_entry
*entry
))
199 struct hash_entry
*entry
;
201 for (entry
= ht
->table
; entry
!= ht
->table
+ ht
->size
; entry
++) {
202 if (entry
->key
== NULL
)
205 if (delete_function
!= NULL
&& entry
->key
!= ht
->deleted_key
)
206 delete_function(entry
);
212 ht
->deleted_entries
= 0;
215 /** Sets the value of the key pointer used for deleted entries in the table.
217 * The assumption is that usually keys are actual pointers, so we use a
218 * default value of a pointer to an arbitrary piece of storage in the library.
219 * But in some cases a consumer wants to store some other sort of value in the
220 * table, like a uint32_t, in which case that pointer may conflict with one of
221 * their valid keys. This lets that user select a safe value.
223 * This must be called before any keys are actually deleted from the table.
226 _mesa_hash_table_set_deleted_key(struct hash_table
*ht
, const void *deleted_key
)
228 ht
->deleted_key
= deleted_key
;
231 static struct hash_entry
*
232 hash_table_search(struct hash_table
*ht
, uint32_t hash
, const void *key
)
234 uint32_t start_hash_address
= hash
% ht
->size
;
235 uint32_t hash_address
= start_hash_address
;
238 uint32_t double_hash
;
240 struct hash_entry
*entry
= ht
->table
+ hash_address
;
242 if (entry_is_free(entry
)) {
244 } else if (entry_is_present(ht
, entry
) && entry
->hash
== hash
) {
245 if (ht
->key_equals_function(key
, entry
->key
)) {
250 double_hash
= 1 + hash
% ht
->rehash
;
252 hash_address
= (hash_address
+ double_hash
) % ht
->size
;
253 } while (hash_address
!= start_hash_address
);
259 * Finds a hash table entry with the given key and hash of that key.
261 * Returns NULL if no entry is found. Note that the data pointer may be
262 * modified by the user.
265 _mesa_hash_table_search(struct hash_table
*ht
, const void *key
)
267 assert(ht
->key_hash_function
);
268 return hash_table_search(ht
, ht
->key_hash_function(key
), key
);
272 _mesa_hash_table_search_pre_hashed(struct hash_table
*ht
, uint32_t hash
,
275 assert(ht
->key_hash_function
== NULL
|| hash
== ht
->key_hash_function(key
));
276 return hash_table_search(ht
, hash
, key
);
279 static struct hash_entry
*
280 hash_table_insert(struct hash_table
*ht
, uint32_t hash
,
281 const void *key
, void *data
);
284 _mesa_hash_table_rehash(struct hash_table
*ht
, unsigned new_size_index
)
286 struct hash_table old_ht
;
287 struct hash_entry
*table
, *entry
;
289 if (new_size_index
>= ARRAY_SIZE(hash_sizes
))
292 table
= rzalloc_array(ht
, struct hash_entry
,
293 hash_sizes
[new_size_index
].size
);
300 ht
->size_index
= new_size_index
;
301 ht
->size
= hash_sizes
[ht
->size_index
].size
;
302 ht
->rehash
= hash_sizes
[ht
->size_index
].rehash
;
303 ht
->max_entries
= hash_sizes
[ht
->size_index
].max_entries
;
305 ht
->deleted_entries
= 0;
307 hash_table_foreach(&old_ht
, entry
) {
308 hash_table_insert(ht
, entry
->hash
, entry
->key
, entry
->data
);
311 ralloc_free(old_ht
.table
);
314 static struct hash_entry
*
315 hash_table_insert(struct hash_table
*ht
, uint32_t hash
,
316 const void *key
, void *data
)
318 uint32_t start_hash_address
, hash_address
;
319 struct hash_entry
*available_entry
= NULL
;
323 if (ht
->entries
>= ht
->max_entries
) {
324 _mesa_hash_table_rehash(ht
, ht
->size_index
+ 1);
325 } else if (ht
->deleted_entries
+ ht
->entries
>= ht
->max_entries
) {
326 _mesa_hash_table_rehash(ht
, ht
->size_index
);
329 start_hash_address
= hash
% ht
->size
;
330 hash_address
= start_hash_address
;
332 struct hash_entry
*entry
= ht
->table
+ hash_address
;
333 uint32_t double_hash
;
335 if (!entry_is_present(ht
, entry
)) {
336 /* Stash the first available entry we find */
337 if (available_entry
== NULL
)
338 available_entry
= entry
;
339 if (entry_is_free(entry
))
343 /* Implement replacement when another insert happens
344 * with a matching key. This is a relatively common
345 * feature of hash tables, with the alternative
346 * generally being "insert the new value as well, and
347 * return it first when the key is searched for".
349 * Note that the hash table doesn't have a delete
350 * callback. If freeing of old data pointers is
351 * required to avoid memory leaks, perform a search
354 if (!entry_is_deleted(ht
, entry
) &&
355 entry
->hash
== hash
&&
356 ht
->key_equals_function(key
, entry
->key
)) {
363 double_hash
= 1 + hash
% ht
->rehash
;
365 hash_address
= (hash_address
+ double_hash
) % ht
->size
;
366 } while (hash_address
!= start_hash_address
);
368 if (available_entry
) {
369 if (entry_is_deleted(ht
, available_entry
))
370 ht
->deleted_entries
--;
371 available_entry
->hash
= hash
;
372 available_entry
->key
= key
;
373 available_entry
->data
= data
;
375 return available_entry
;
378 /* We could hit here if a required resize failed. An unchecked-malloc
379 * application could ignore this result.
385 * Inserts the key with the given hash into the table.
387 * Note that insertion may rearrange the table on a resize or rehash,
388 * so previously found hash_entries are no longer valid after this function.
391 _mesa_hash_table_insert(struct hash_table
*ht
, const void *key
, void *data
)
393 assert(ht
->key_hash_function
);
394 return hash_table_insert(ht
, ht
->key_hash_function(key
), key
, data
);
398 _mesa_hash_table_insert_pre_hashed(struct hash_table
*ht
, uint32_t hash
,
399 const void *key
, void *data
)
401 assert(ht
->key_hash_function
== NULL
|| hash
== ht
->key_hash_function(key
));
402 return hash_table_insert(ht
, hash
, key
, data
);
406 * This function deletes the given hash table entry.
408 * Note that deletion doesn't otherwise modify the table, so an iteration over
409 * the table deleting entries is safe.
412 _mesa_hash_table_remove(struct hash_table
*ht
,
413 struct hash_entry
*entry
)
418 entry
->key
= ht
->deleted_key
;
420 ht
->deleted_entries
++;
424 * Removes the entry with the corresponding key, if exists.
426 void _mesa_hash_table_remove_key(struct hash_table
*ht
,
429 _mesa_hash_table_remove(ht
, _mesa_hash_table_search(ht
, key
));
433 * This function is an iterator over the hash table.
435 * Pass in NULL for the first entry, as in the start of a for loop. Note that
436 * an iteration over the table is O(table_size) not O(entries).
439 _mesa_hash_table_next_entry(struct hash_table
*ht
,
440 struct hash_entry
*entry
)
447 for (; entry
!= ht
->table
+ ht
->size
; entry
++) {
448 if (entry_is_present(ht
, entry
)) {
457 * Returns a random entry from the hash table.
459 * This may be useful in implementing random replacement (as opposed
460 * to just removing everything) in caches based on this hash table
461 * implementation. @predicate may be used to filter entries, or may
462 * be set to NULL for no filtering.
465 _mesa_hash_table_random_entry(struct hash_table
*ht
,
466 bool (*predicate
)(struct hash_entry
*entry
))
468 struct hash_entry
*entry
;
469 uint32_t i
= rand() % ht
->size
;
471 if (ht
->entries
== 0)
474 for (entry
= ht
->table
+ i
; entry
!= ht
->table
+ ht
->size
; entry
++) {
475 if (entry_is_present(ht
, entry
) &&
476 (!predicate
|| predicate(entry
))) {
481 for (entry
= ht
->table
; entry
!= ht
->table
+ i
; entry
++) {
482 if (entry_is_present(ht
, entry
) &&
483 (!predicate
|| predicate(entry
))) {
493 * Quick FNV-1a hash implementation based on:
494 * http://www.isthe.com/chongo/tech/comp/fnv/
496 * FNV-1a is not be the best hash out there -- Jenkins's lookup3 is supposed
497 * to be quite good, and it probably beats FNV. But FNV has the advantage
498 * that it involves almost no code. For an improvement on both, see Paul
499 * Hsieh's http://www.azillionmonkeys.com/qed/hash.html
502 _mesa_hash_data(const void *data
, size_t size
)
504 return _mesa_fnv32_1a_accumulate_block(_mesa_fnv32_1a_offset_bias
,
508 /** FNV-1a string hash implementation */
510 _mesa_hash_string(const void *_key
)
512 uint32_t hash
= _mesa_fnv32_1a_offset_bias
;
513 const char *key
= _key
;
516 hash
= _mesa_fnv32_1a_accumulate(hash
, *key
);
524 * String compare function for use as the comparison callback in
525 * _mesa_hash_table_create().
528 _mesa_key_string_equal(const void *a
, const void *b
)
530 return strcmp(a
, b
) == 0;
534 _mesa_key_pointer_equal(const void *a
, const void *b
)
540 * Hash table wrapper which supports 64-bit keys.
542 * TODO: unify all hash table implementations.
545 struct hash_key_u64
{
550 key_u64_hash(const void *key
)
552 return _mesa_hash_data(key
, sizeof(struct hash_key_u64
));
556 key_u64_equals(const void *a
, const void *b
)
558 const struct hash_key_u64
*aa
= a
;
559 const struct hash_key_u64
*bb
= b
;
561 return aa
->value
== bb
->value
;
564 struct hash_table_u64
*
565 _mesa_hash_table_u64_create(void *mem_ctx
)
567 struct hash_table_u64
*ht
;
569 ht
= CALLOC_STRUCT(hash_table_u64
);
573 if (sizeof(void *) == 8) {
574 ht
->table
= _mesa_hash_table_create(mem_ctx
, _mesa_hash_pointer
,
575 _mesa_key_pointer_equal
);
577 ht
->table
= _mesa_hash_table_create(mem_ctx
, key_u64_hash
,
582 _mesa_hash_table_set_deleted_key(ht
->table
, uint_key(DELETED_KEY_VALUE
));
588 _mesa_hash_table_u64_destroy(struct hash_table_u64
*ht
,
589 void (*delete_function
)(struct hash_entry
*entry
))
594 if (ht
->deleted_key_data
) {
595 if (delete_function
) {
596 struct hash_table
*table
= ht
->table
;
597 struct hash_entry deleted_entry
;
599 /* Create a fake entry for the delete function. */
600 deleted_entry
.hash
= table
->key_hash_function(table
->deleted_key
);
601 deleted_entry
.key
= table
->deleted_key
;
602 deleted_entry
.data
= ht
->deleted_key_data
;
604 delete_function(&deleted_entry
);
606 ht
->deleted_key_data
= NULL
;
609 _mesa_hash_table_destroy(ht
->table
, delete_function
);
614 _mesa_hash_table_u64_insert(struct hash_table_u64
*ht
, uint64_t key
,
617 if (key
== DELETED_KEY_VALUE
) {
618 ht
->deleted_key_data
= data
;
622 if (sizeof(void *) == 8) {
623 _mesa_hash_table_insert(ht
->table
, (void *)(uintptr_t)key
, data
);
625 struct hash_key_u64
*_key
= CALLOC_STRUCT(hash_key_u64
);
631 _mesa_hash_table_insert(ht
->table
, _key
, data
);
635 static struct hash_entry
*
636 hash_table_u64_search(struct hash_table_u64
*ht
, uint64_t key
)
638 if (sizeof(void *) == 8) {
639 return _mesa_hash_table_search(ht
->table
, (void *)(uintptr_t)key
);
641 struct hash_key_u64 _key
= { .value
= key
};
642 return _mesa_hash_table_search(ht
->table
, &_key
);
647 _mesa_hash_table_u64_search(struct hash_table_u64
*ht
, uint64_t key
)
649 struct hash_entry
*entry
;
651 if (key
== DELETED_KEY_VALUE
)
652 return ht
->deleted_key_data
;
654 entry
= hash_table_u64_search(ht
, key
);
662 _mesa_hash_table_u64_remove(struct hash_table_u64
*ht
, uint64_t key
)
664 struct hash_entry
*entry
;
666 if (key
== DELETED_KEY_VALUE
) {
667 ht
->deleted_key_data
= NULL
;
671 entry
= hash_table_u64_search(ht
, key
);
675 if (sizeof(void *) == 8) {
676 _mesa_hash_table_remove(ht
->table
, entry
);
678 struct hash_key
*_key
= (struct hash_key
*)entry
->key
;
680 _mesa_hash_table_remove(ht
->table
, entry
);