1 /**************************************************************************
3 * Copyright 2008 Tungsten Graphics, Inc., Cedar Park, Texas.
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the
8 * "Software"), to deal in the Software without restriction, including
9 * without limitation the rights to use, copy, modify, merge, publish,
10 * distribute, sub license, and/or sell copies of the Software, and to
11 * permit persons to whom the Software is furnished to do so, subject to
12 * the following conditions:
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
21 * IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR
22 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
23 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
24 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
26 **************************************************************************/
30 * General purpose hash table implementation.
32 * Just uses the cso_hash for now, but it might be better switch to a linear
33 * probing hash table implementation at some point -- as it is said they have
34 * better lookup and cache performance and it appears to be possible to write
35 * a lock-free implementation of such hash tables .
37 * @author José Fonseca <jrfonseca@tungstengraphics.com>
41 #include "pipe/p_compiler.h"
42 #include "util/u_debug.h"
44 #include "cso_cache/cso_hash.h"
46 #include "util/u_memory.h"
47 #include "util/u_hash_table.h"
50 struct util_hash_table
55 unsigned (*hash)(void *key);
57 /** Compare two keys */
58 int (*compare)(void *key1, void *key2);
60 /* TODO: key, value destructors? */
64 struct util_hash_table_item
71 static INLINE struct util_hash_table_item *
72 util_hash_table_item(struct cso_hash_iter iter)
74 return (struct util_hash_table_item *)cso_hash_iter_data(iter);
78 struct util_hash_table *
79 util_hash_table_create(unsigned (*hash)(void *key),
80 int (*compare)(void *key1, void *key2))
82 struct util_hash_table *ht;
84 ht = MALLOC_STRUCT(util_hash_table);
88 ht->cso = cso_hash_create();
95 ht->compare = compare;
101 static INLINE struct cso_hash_iter
102 util_hash_table_find_iter(struct util_hash_table *ht,
106 struct cso_hash_iter iter;
107 struct util_hash_table_item *item;
109 iter = cso_hash_find(ht->cso, key_hash);
110 while (!cso_hash_iter_is_null(iter)) {
111 item = (struct util_hash_table_item *)cso_hash_iter_data(iter);
112 if (!ht->compare(item->key, key))
114 iter = cso_hash_iter_next(iter);
121 static INLINE struct util_hash_table_item *
122 util_hash_table_find_item(struct util_hash_table *ht,
126 struct cso_hash_iter iter;
127 struct util_hash_table_item *item;
129 iter = cso_hash_find(ht->cso, key_hash);
130 while (!cso_hash_iter_is_null(iter)) {
131 item = (struct util_hash_table_item *)cso_hash_iter_data(iter);
132 if (!ht->compare(item->key, key))
134 iter = cso_hash_iter_next(iter);
142 util_hash_table_set(struct util_hash_table *ht,
147 struct util_hash_table_item *item;
148 struct cso_hash_iter iter;
152 return PIPE_ERROR_BAD_INPUT;
154 key_hash = ht->hash(key);
156 item = util_hash_table_find_item(ht, key, key_hash);
158 /* TODO: key/value destruction? */
163 item = MALLOC_STRUCT(util_hash_table_item);
165 return PIPE_ERROR_OUT_OF_MEMORY;
170 iter = cso_hash_insert(ht->cso, key_hash, item);
171 if(cso_hash_iter_is_null(iter)) {
173 return PIPE_ERROR_OUT_OF_MEMORY;
181 util_hash_table_get(struct util_hash_table *ht,
185 struct util_hash_table_item *item;
191 key_hash = ht->hash(key);
193 item = util_hash_table_find_item(ht, key, key_hash);
202 util_hash_table_remove(struct util_hash_table *ht,
206 struct cso_hash_iter iter;
207 struct util_hash_table_item *item;
213 key_hash = ht->hash(key);
215 iter = util_hash_table_find_iter(ht, key, key_hash);
216 if(cso_hash_iter_is_null(iter))
219 item = util_hash_table_item(iter);
223 cso_hash_erase(ht->cso, iter);
228 util_hash_table_clear(struct util_hash_table *ht)
230 struct cso_hash_iter iter;
231 struct util_hash_table_item *item;
237 iter = cso_hash_first_node(ht->cso);
238 while (!cso_hash_iter_is_null(iter)) {
239 item = (struct util_hash_table_item *)cso_hash_take(ht->cso, cso_hash_iter_key(iter));
241 iter = cso_hash_first_node(ht->cso);
247 util_hash_table_foreach(struct util_hash_table *ht,
248 enum pipe_error (*callback)
249 (void *key, void *value, void *data),
252 struct cso_hash_iter iter;
253 struct util_hash_table_item *item;
254 enum pipe_error result;
258 return PIPE_ERROR_BAD_INPUT;
260 iter = cso_hash_first_node(ht->cso);
261 while (!cso_hash_iter_is_null(iter)) {
262 item = (struct util_hash_table_item *)cso_hash_iter_data(iter);
263 result = callback(item->key, item->value, data);
264 if(result != PIPE_OK)
266 iter = cso_hash_iter_next(iter);
274 util_hash_table_destroy(struct util_hash_table *ht)
276 struct cso_hash_iter iter;
277 struct util_hash_table_item *item;
283 iter = cso_hash_first_node(ht->cso);
284 while (!cso_hash_iter_is_null(iter)) {
285 item = (struct util_hash_table_item *)cso_hash_iter_data(iter);
287 iter = cso_hash_iter_next(iter);
290 cso_hash_delete(ht->cso);