1 /**************************************************************************
2  *
3  * Copyright 2008 VMware, Inc.
4  * All Rights Reserved.
5  *
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:
13  *
14  * The above copyright notice and this permission notice (including the
15  * next paragraph) shall be included in all copies or substantial portions
16  * of the Software.
17  *
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 VMWARE 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.
25  *
26  **************************************************************************/
27 
28 /**
29  * General purpose hash table.
30  *
31  * @author José Fonseca <jfonseca@vmware.com>
32  */
33 
34 #ifndef U_HASH_TABLE_H_
35 #define U_HASH_TABLE_H_
36 
37 #ifdef HAVE_CONFIG_H
38 #include "config.h"
39 #endif
40 
41 #include "libdrm_macros.h"
42 
43 /**
44  * Generic purpose hash table.
45  */
46 struct util_hash_table;
47 
48 /**
49  * Create an hash table.
50  *
51  * @param hash hash function
52  * @param compare should return 0 for two equal keys.
53  */
54 drm_private struct util_hash_table *
55 util_hash_table_create(unsigned (*hash)(void *key),
56 		       int (*compare)(void *key1, void *key2));
57 
58 drm_private void
59 util_hash_table_set(struct util_hash_table *ht, void *key, void *value);
60 
61 drm_private void *util_hash_table_get(struct util_hash_table *ht, void *key);
62 
63 drm_private void util_hash_table_remove(struct util_hash_table *ht, void *key);
64 
65 drm_private void util_hash_table_clear(struct util_hash_table *ht);
66 
67 drm_private void util_hash_table_foreach(struct util_hash_table *ht,
68 			void (*callback)(void *key, void *value, void *data),
69 			void *data);
70 
71 drm_private void util_hash_table_destroy(struct util_hash_table *ht);
72 
73 #endif /* U_HASH_TABLE_H_ */
74