1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
/*
* Copyright © 2009,2021 Intel Corporation
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice (including the next
* paragraph) shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
* IN THE SOFTWARE.
*
* Authors:
* Eric Anholt <eric@anholt.net>
*
*/
#ifndef IGT_MAP_H
#define IGT_MAP_H
#include <inttypes.h>
/**
* SECTION:igt_map
* @short_description: a linear-reprobing hashmap implementation
* @title: IGT Map
* @include: igt_map.h
*
* Implements an open-addressing, linear-reprobing hash table.
*
* For more information, see:
* http://cgit.freedesktop.org/~anholt/hash_table/tree/README
*
* Example usage:
*
*|[<!-- language="C" -->
* #define GOLDEN_RATIO_PRIME_32 0x9e370001UL
*
* static inline uint32_t hash_identifier(const void *val)
* {
* uint32_t hash = *(uint32_t *) val;
*
* hash = hash * GOLDEN_RATIO_PRIME_32;
* return hash;
* }
*
* static int equal_identifiers(const void *a, const void *b)
* {
* uint32_t *key1 = (uint32_t *) a, *key2 = (uint32_t *) b;
*
* return *key1 == *key2;
* }
*
* static void free_func(struct igt_map_entry *entry)
* {
* free(entry->data);
* }
*
* struct igt_map *map;
*
* struct record {
* int foo;
* uint32_t unique_identifier;
* };
*
* struct record *r1, r2, *record;
* struct igt_map_entry *entry;
*
* r1 = malloc(sizeof(struct record));
* map = igt_map_create(hash_identifier, equal_identifiers);
* igt_map_insert(map, &r1->unique_identifier, r1);
* igt_map_insert(map, &r2.unique_identifier, &r2);
*
* igt_map_foreach(map, entry) {
* record = entry->data;
* printf("key: %u, foo: %d\n", *(uint32_t *) entry->key, record->foo);
* }
*
* record = igt_map_search(map, &r1->unique_identifier);
* entry = igt_map_search_entry(map, &r2.unique_identifier);
*
* igt_map_remove(map, &r1->unique_identifier, free_func);
* igt_map_remove_entry(map, entry);
*
* igt_map_destroy(map, NULL);
* ]|
*/
struct igt_map_entry {
uint32_t hash;
const void *key;
void *data;
};
struct igt_map {
struct igt_map_entry *table;
uint32_t (*hash_function)(const void *key);
int (*key_equals_function)(const void *a, const void *b);
uint32_t size;
uint32_t rehash;
uint32_t max_entries;
uint32_t size_index;
uint32_t entries;
uint32_t deleted_entries;
};
struct igt_map *
igt_map_create(uint32_t (*hash_function)(const void *key),
int (*key_equals_function)(const void *a, const void *b));
void
igt_map_destroy(struct igt_map *map,
void (*delete_function)(struct igt_map_entry *entry));
struct igt_map_entry *
igt_map_insert(struct igt_map *map, const void *key, void *data);
void *
igt_map_search(struct igt_map *map, const void *key);
struct igt_map_entry *
igt_map_search_entry(struct igt_map *map, const void *key);
void
igt_map_remove(struct igt_map *map, const void *key,
void (*delete_function)(struct igt_map_entry *entry));
void
igt_map_remove_entry(struct igt_map *map, struct igt_map_entry *entry);
struct igt_map_entry *
igt_map_next_entry(struct igt_map *map, struct igt_map_entry *entry);
struct igt_map_entry *
igt_map_random_entry(struct igt_map *map,
int (*predicate)(struct igt_map_entry *entry));
/**
* igt_map_foreach
* @map: igt_map pointer
* @entry: igt_map_entry pointer
*
* Macro is a loop, which iterates through each map entry. Inside a
* loop block current element is accessible by the @entry pointer.
*
* This foreach function is safe against deletion (which just replaces
* an entry's data with the deleted marker), but not against insertion
* (which may rehash the table, making entry a dangling pointer).
*/
#define igt_map_foreach(map, entry) \
for (entry = igt_map_next_entry(map, NULL); \
entry != NULL; \
entry = igt_map_next_entry(map, entry))
/* Alternate interfaces to reduce repeated calls to hash function. */
struct igt_map_entry *
igt_map_search_pre_hashed(struct igt_map *map,
uint32_t hash,
const void *key);
struct igt_map_entry *
igt_map_insert_pre_hashed(struct igt_map *map,
uint32_t hash,
const void *key, void *data);
uint32_t igt_map_hash_32(const void *key);
int igt_map_equal_32(const void *key1, const void *key2);
uint32_t igt_map_hash_64(const void *key);
int igt_map_equal_64(const void *key1, const void *key2);
#endif
|
