• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright © 2009-2012 Intel Corporation
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice (including the next
12  * paragraph) shall be included in all copies or substantial portions of the
13  * Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21  * IN THE SOFTWARE.
22  *
23  * Authors:
24  *    Eric Anholt <eric@anholt.net>
25  *
26  */
27 
28 #ifndef _SET_H
29 #define _SET_H
30 
31 #include <inttypes.h>
32 #include <stdbool.h>
33 
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37 
38 struct set_entry {
39    uint32_t hash;
40    const void *key;
41 };
42 
43 struct set {
44    void *mem_ctx;
45    struct set_entry *table;
46    uint32_t (*key_hash_function)(const void *key);
47    bool (*key_equals_function)(const void *a, const void *b);
48    uint32_t size;
49    uint32_t rehash;
50    uint32_t max_entries;
51    uint32_t size_index;
52    uint32_t entries;
53    uint32_t deleted_entries;
54 };
55 
56 struct set *
57 _mesa_set_create(void *mem_ctx,
58                  uint32_t (*key_hash_function)(const void *key),
59                  bool (*key_equals_function)(const void *a,
60                                              const void *b));
61 void
62 _mesa_set_destroy(struct set *set,
63                   void (*delete_function)(struct set_entry *entry));
64 
65 struct set_entry *
66 _mesa_set_add(struct set *set, const void *key);
67 struct set_entry *
68 _mesa_set_add_pre_hashed(struct set *set, uint32_t hash, const void *key);
69 
70 struct set_entry *
71 _mesa_set_search(const struct set *set, const void *key);
72 struct set_entry *
73 _mesa_set_search_pre_hashed(const struct set *set, uint32_t hash,
74                             const void *key);
75 
76 void
77 _mesa_set_remove(struct set *set, struct set_entry *entry);
78 
79 struct set_entry *
80 _mesa_set_next_entry(const struct set *set, struct set_entry *entry);
81 
82 struct set_entry *
83 _mesa_set_random_entry(struct set *set,
84                        int (*predicate)(struct set_entry *entry));
85 
86 /**
87  * This foreach function is safe against deletion, but not against
88  * insertion (which may rehash the set, making entry a dangling
89  * pointer).
90  */
91 #define set_foreach(set, entry)                          \
92    for (entry = _mesa_set_next_entry(set, NULL);  \
93         entry != NULL;                                   \
94         entry = _mesa_set_next_entry(set, entry))
95 
96 #ifdef __cplusplus
97 } /* extern C */
98 #endif
99 
100 #endif /* _SET_H */
101