1 /* SPDX-License-Identifier: LGPL-2.1+ */
8 #include "hash-funcs.h"
13 * A hash table implementation. As a minor optimization a NULL hashmap object
14 * will be treated as empty hashmap for all read operations. That way it is not
15 * necessary to instantiate an object for each Hashmap use.
17 * If ENABLE_DEBUG_HASHMAP is defined (by configuring with --enable-debug=hashmap),
18 * the implementation will:
19 * - store extra data for debugging and statistics (see tools/gdb-sd_dump_hashmaps.py)
20 * - perform extra checks for invalid use of iterators
23 #define HASH_KEY_SIZE 16
25 /* The base type for all hashmap and set types. Many functions in the
26 * implementation take (HashmapBase*) parameters and are run-time polymorphic,
27 * though the API is not meant to be polymorphic (do not call functions
28 * internal_*() directly). */
29 typedef struct HashmapBase HashmapBase
;
31 /* Specific hashmap/set types */
32 typedef struct Hashmap Hashmap
; /* Maps keys to values */
33 typedef struct OrderedHashmap OrderedHashmap
; /* Like Hashmap, but also remembers entry insertion order */
34 typedef struct Set Set
; /* Stores just keys */
36 typedef struct IteratedCache IteratedCache
; /* Caches the iterated order of one of the above */
38 /* Ideally the Iterator would be an opaque struct, but it is instantiated
39 * by hashmap users, so the definition has to be here. Do not use its fields
42 unsigned idx
; /* index of an entry to be iterated next */
43 const void *next_key
; /* expected value of that entry's key pointer */
44 #if ENABLE_DEBUG_HASHMAP
45 unsigned put_count
; /* hashmap's put_count recorded at start of iteration */
46 unsigned rem_count
; /* hashmap's rem_count in previous iteration */
47 unsigned prev_idx
; /* idx in previous iteration */
51 #define _IDX_ITERATOR_FIRST (UINT_MAX - 1)
52 #define ITERATOR_FIRST ((Iterator) { .idx = _IDX_ITERATOR_FIRST, .next_key = NULL })
54 /* Macros for type checking */
55 #define PTR_COMPATIBLE_WITH_HASHMAP_BASE(h) \
56 (__builtin_types_compatible_p(typeof(h), HashmapBase*) || \
57 __builtin_types_compatible_p(typeof(h), Hashmap*) || \
58 __builtin_types_compatible_p(typeof(h), OrderedHashmap*) || \
59 __builtin_types_compatible_p(typeof(h), Set*))
61 #define PTR_COMPATIBLE_WITH_PLAIN_HASHMAP(h) \
62 (__builtin_types_compatible_p(typeof(h), Hashmap*) || \
63 __builtin_types_compatible_p(typeof(h), OrderedHashmap*)) \
65 #define HASHMAP_BASE(h) \
66 __builtin_choose_expr(PTR_COMPATIBLE_WITH_HASHMAP_BASE(h), \
70 #define PLAIN_HASHMAP(h) \
71 __builtin_choose_expr(PTR_COMPATIBLE_WITH_PLAIN_HASHMAP(h), \
75 #if ENABLE_DEBUG_HASHMAP
76 # define HASHMAP_DEBUG_PARAMS , const char *func, const char *file, int line
77 # define HASHMAP_DEBUG_SRC_ARGS , __func__, __FILE__, __LINE__
78 # define HASHMAP_DEBUG_PASS_ARGS , func, file, line
80 # define HASHMAP_DEBUG_PARAMS
81 # define HASHMAP_DEBUG_SRC_ARGS
82 # define HASHMAP_DEBUG_PASS_ARGS
85 Hashmap
*internal_hashmap_new(const struct hash_ops
*hash_ops HASHMAP_DEBUG_PARAMS
);
86 OrderedHashmap
*internal_ordered_hashmap_new(const struct hash_ops
*hash_ops HASHMAP_DEBUG_PARAMS
);
87 #define hashmap_new(ops) internal_hashmap_new(ops HASHMAP_DEBUG_SRC_ARGS)
88 #define ordered_hashmap_new(ops) internal_ordered_hashmap_new(ops HASHMAP_DEBUG_SRC_ARGS)
90 HashmapBase
*internal_hashmap_free(HashmapBase
*h
);
91 static inline Hashmap
*hashmap_free(Hashmap
*h
) {
92 return (void*)internal_hashmap_free(HASHMAP_BASE(h
));
94 static inline OrderedHashmap
*ordered_hashmap_free(OrderedHashmap
*h
) {
95 return (void*)internal_hashmap_free(HASHMAP_BASE(h
));
98 HashmapBase
*internal_hashmap_free_free(HashmapBase
*h
);
99 static inline Hashmap
*hashmap_free_free(Hashmap
*h
) {
100 return (void*)internal_hashmap_free_free(HASHMAP_BASE(h
));
102 static inline OrderedHashmap
*ordered_hashmap_free_free(OrderedHashmap
*h
) {
103 return (void*)internal_hashmap_free_free(HASHMAP_BASE(h
));
106 Hashmap
*hashmap_free_free_free(Hashmap
*h
);
107 static inline OrderedHashmap
*ordered_hashmap_free_free_free(OrderedHashmap
*h
) {
108 return (void*)hashmap_free_free_free(PLAIN_HASHMAP(h
));
111 IteratedCache
*iterated_cache_free(IteratedCache
*cache
);
112 int iterated_cache_get(IteratedCache
*cache
, const void ***res_keys
, const void ***res_values
, unsigned *res_n_entries
);
114 HashmapBase
*internal_hashmap_copy(HashmapBase
*h
);
115 static inline Hashmap
*hashmap_copy(Hashmap
*h
) {
116 return (Hashmap
*) internal_hashmap_copy(HASHMAP_BASE(h
));
118 static inline OrderedHashmap
*ordered_hashmap_copy(OrderedHashmap
*h
) {
119 return (OrderedHashmap
*) internal_hashmap_copy(HASHMAP_BASE(h
));
122 int internal_hashmap_ensure_allocated(Hashmap
**h
, const struct hash_ops
*hash_ops HASHMAP_DEBUG_PARAMS
);
123 int internal_ordered_hashmap_ensure_allocated(OrderedHashmap
**h
, const struct hash_ops
*hash_ops HASHMAP_DEBUG_PARAMS
);
124 #define hashmap_ensure_allocated(h, ops) internal_hashmap_ensure_allocated(h, ops HASHMAP_DEBUG_SRC_ARGS)
125 #define ordered_hashmap_ensure_allocated(h, ops) internal_ordered_hashmap_ensure_allocated(h, ops HASHMAP_DEBUG_SRC_ARGS)
127 IteratedCache
*internal_hashmap_iterated_cache_new(HashmapBase
*h
);
128 static inline IteratedCache
*hashmap_iterated_cache_new(Hashmap
*h
) {
129 return (IteratedCache
*) internal_hashmap_iterated_cache_new(HASHMAP_BASE(h
));
131 static inline IteratedCache
*ordered_hashmap_iterated_cache_new(OrderedHashmap
*h
) {
132 return (IteratedCache
*) internal_hashmap_iterated_cache_new(HASHMAP_BASE(h
));
135 int hashmap_put(Hashmap
*h
, const void *key
, void *value
);
136 static inline int ordered_hashmap_put(OrderedHashmap
*h
, const void *key
, void *value
) {
137 return hashmap_put(PLAIN_HASHMAP(h
), key
, value
);
140 int hashmap_update(Hashmap
*h
, const void *key
, void *value
);
141 static inline int ordered_hashmap_update(OrderedHashmap
*h
, const void *key
, void *value
) {
142 return hashmap_update(PLAIN_HASHMAP(h
), key
, value
);
145 int hashmap_replace(Hashmap
*h
, const void *key
, void *value
);
146 static inline int ordered_hashmap_replace(OrderedHashmap
*h
, const void *key
, void *value
) {
147 return hashmap_replace(PLAIN_HASHMAP(h
), key
, value
);
150 void *internal_hashmap_get(HashmapBase
*h
, const void *key
);
151 static inline void *hashmap_get(Hashmap
*h
, const void *key
) {
152 return internal_hashmap_get(HASHMAP_BASE(h
), key
);
154 static inline void *ordered_hashmap_get(OrderedHashmap
*h
, const void *key
) {
155 return internal_hashmap_get(HASHMAP_BASE(h
), key
);
158 void *hashmap_get2(Hashmap
*h
, const void *key
, void **rkey
);
159 static inline void *ordered_hashmap_get2(OrderedHashmap
*h
, const void *key
, void **rkey
) {
160 return hashmap_get2(PLAIN_HASHMAP(h
), key
, rkey
);
163 bool internal_hashmap_contains(HashmapBase
*h
, const void *key
);
164 static inline bool hashmap_contains(Hashmap
*h
, const void *key
) {
165 return internal_hashmap_contains(HASHMAP_BASE(h
), key
);
167 static inline bool ordered_hashmap_contains(OrderedHashmap
*h
, const void *key
) {
168 return internal_hashmap_contains(HASHMAP_BASE(h
), key
);
171 void *internal_hashmap_remove(HashmapBase
*h
, const void *key
);
172 static inline void *hashmap_remove(Hashmap
*h
, const void *key
) {
173 return internal_hashmap_remove(HASHMAP_BASE(h
), key
);
175 static inline void *ordered_hashmap_remove(OrderedHashmap
*h
, const void *key
) {
176 return internal_hashmap_remove(HASHMAP_BASE(h
), key
);
179 void *hashmap_remove2(Hashmap
*h
, const void *key
, void **rkey
);
180 static inline void *ordered_hashmap_remove2(OrderedHashmap
*h
, const void *key
, void **rkey
) {
181 return hashmap_remove2(PLAIN_HASHMAP(h
), key
, rkey
);
184 void *hashmap_remove_value(Hashmap
*h
, const void *key
, void *value
);
185 static inline void *ordered_hashmap_remove_value(OrderedHashmap
*h
, const void *key
, void *value
) {
186 return hashmap_remove_value(PLAIN_HASHMAP(h
), key
, value
);
189 int hashmap_remove_and_put(Hashmap
*h
, const void *old_key
, const void *new_key
, void *value
);
190 static inline int ordered_hashmap_remove_and_put(OrderedHashmap
*h
, const void *old_key
, const void *new_key
, void *value
) {
191 return hashmap_remove_and_put(PLAIN_HASHMAP(h
), old_key
, new_key
, value
);
194 int hashmap_remove_and_replace(Hashmap
*h
, const void *old_key
, const void *new_key
, void *value
);
195 static inline int ordered_hashmap_remove_and_replace(OrderedHashmap
*h
, const void *old_key
, const void *new_key
, void *value
) {
196 return hashmap_remove_and_replace(PLAIN_HASHMAP(h
), old_key
, new_key
, value
);
199 /* Since merging data from a OrderedHashmap into a Hashmap or vice-versa
200 * should just work, allow this by having looser type-checking here. */
201 int internal_hashmap_merge(Hashmap
*h
, Hashmap
*other
);
202 #define hashmap_merge(h, other) internal_hashmap_merge(PLAIN_HASHMAP(h), PLAIN_HASHMAP(other))
203 #define ordered_hashmap_merge(h, other) hashmap_merge(h, other)
205 int internal_hashmap_reserve(HashmapBase
*h
, unsigned entries_add
);
206 static inline int hashmap_reserve(Hashmap
*h
, unsigned entries_add
) {
207 return internal_hashmap_reserve(HASHMAP_BASE(h
), entries_add
);
209 static inline int ordered_hashmap_reserve(OrderedHashmap
*h
, unsigned entries_add
) {
210 return internal_hashmap_reserve(HASHMAP_BASE(h
), entries_add
);
213 int internal_hashmap_move(HashmapBase
*h
, HashmapBase
*other
);
214 /* Unlike hashmap_merge, hashmap_move does not allow mixing the types. */
215 static inline int hashmap_move(Hashmap
*h
, Hashmap
*other
) {
216 return internal_hashmap_move(HASHMAP_BASE(h
), HASHMAP_BASE(other
));
218 static inline int ordered_hashmap_move(OrderedHashmap
*h
, OrderedHashmap
*other
) {
219 return internal_hashmap_move(HASHMAP_BASE(h
), HASHMAP_BASE(other
));
222 int internal_hashmap_move_one(HashmapBase
*h
, HashmapBase
*other
, const void *key
);
223 static inline int hashmap_move_one(Hashmap
*h
, Hashmap
*other
, const void *key
) {
224 return internal_hashmap_move_one(HASHMAP_BASE(h
), HASHMAP_BASE(other
), key
);
226 static inline int ordered_hashmap_move_one(OrderedHashmap
*h
, OrderedHashmap
*other
, const void *key
) {
227 return internal_hashmap_move_one(HASHMAP_BASE(h
), HASHMAP_BASE(other
), key
);
230 unsigned internal_hashmap_size(HashmapBase
*h
) _pure_
;
231 static inline unsigned hashmap_size(Hashmap
*h
) {
232 return internal_hashmap_size(HASHMAP_BASE(h
));
234 static inline unsigned ordered_hashmap_size(OrderedHashmap
*h
) {
235 return internal_hashmap_size(HASHMAP_BASE(h
));
238 static inline bool hashmap_isempty(Hashmap
*h
) {
239 return hashmap_size(h
) == 0;
241 static inline bool ordered_hashmap_isempty(OrderedHashmap
*h
) {
242 return ordered_hashmap_size(h
) == 0;
245 unsigned internal_hashmap_buckets(HashmapBase
*h
) _pure_
;
246 static inline unsigned hashmap_buckets(Hashmap
*h
) {
247 return internal_hashmap_buckets(HASHMAP_BASE(h
));
249 static inline unsigned ordered_hashmap_buckets(OrderedHashmap
*h
) {
250 return internal_hashmap_buckets(HASHMAP_BASE(h
));
253 bool internal_hashmap_iterate(HashmapBase
*h
, Iterator
*i
, void **value
, const void **key
);
254 static inline bool hashmap_iterate(Hashmap
*h
, Iterator
*i
, void **value
, const void **key
) {
255 return internal_hashmap_iterate(HASHMAP_BASE(h
), i
, value
, key
);
257 static inline bool ordered_hashmap_iterate(OrderedHashmap
*h
, Iterator
*i
, void **value
, const void **key
) {
258 return internal_hashmap_iterate(HASHMAP_BASE(h
), i
, value
, key
);
261 void internal_hashmap_clear(HashmapBase
*h
);
262 static inline void hashmap_clear(Hashmap
*h
) {
263 internal_hashmap_clear(HASHMAP_BASE(h
));
265 static inline void ordered_hashmap_clear(OrderedHashmap
*h
) {
266 internal_hashmap_clear(HASHMAP_BASE(h
));
269 void internal_hashmap_clear_free(HashmapBase
*h
);
270 static inline void hashmap_clear_free(Hashmap
*h
) {
271 internal_hashmap_clear_free(HASHMAP_BASE(h
));
273 static inline void ordered_hashmap_clear_free(OrderedHashmap
*h
) {
274 internal_hashmap_clear_free(HASHMAP_BASE(h
));
277 void hashmap_clear_free_free(Hashmap
*h
);
278 static inline void ordered_hashmap_clear_free_free(OrderedHashmap
*h
) {
279 hashmap_clear_free_free(PLAIN_HASHMAP(h
));
283 * Note about all *_first*() functions
285 * For plain Hashmaps and Sets the order of entries is undefined.
286 * The functions find whatever entry is first in the implementation
289 * Only for OrderedHashmaps the order is well defined and finding
290 * the first entry is O(1).
293 void *internal_hashmap_steal_first(HashmapBase
*h
);
294 static inline void *hashmap_steal_first(Hashmap
*h
) {
295 return internal_hashmap_steal_first(HASHMAP_BASE(h
));
297 static inline void *ordered_hashmap_steal_first(OrderedHashmap
*h
) {
298 return internal_hashmap_steal_first(HASHMAP_BASE(h
));
301 void *internal_hashmap_steal_first_key(HashmapBase
*h
);
302 static inline void *hashmap_steal_first_key(Hashmap
*h
) {
303 return internal_hashmap_steal_first_key(HASHMAP_BASE(h
));
305 static inline void *ordered_hashmap_steal_first_key(OrderedHashmap
*h
) {
306 return internal_hashmap_steal_first_key(HASHMAP_BASE(h
));
309 void *internal_hashmap_first_key(HashmapBase
*h
) _pure_
;
310 static inline void *hashmap_first_key(Hashmap
*h
) {
311 return internal_hashmap_first_key(HASHMAP_BASE(h
));
313 static inline void *ordered_hashmap_first_key(OrderedHashmap
*h
) {
314 return internal_hashmap_first_key(HASHMAP_BASE(h
));
317 void *internal_hashmap_first(HashmapBase
*h
) _pure_
;
318 static inline void *hashmap_first(Hashmap
*h
) {
319 return internal_hashmap_first(HASHMAP_BASE(h
));
321 static inline void *ordered_hashmap_first(OrderedHashmap
*h
) {
322 return internal_hashmap_first(HASHMAP_BASE(h
));
325 #define hashmap_clear_with_destructor(_s, _f) \
328 while ((_item = hashmap_steal_first(_s))) \
331 #define hashmap_free_with_destructor(_s, _f) \
333 hashmap_clear_with_destructor(_s, _f); \
336 #define ordered_hashmap_clear_with_destructor(_s, _f) \
339 while ((_item = ordered_hashmap_steal_first(_s))) \
342 #define ordered_hashmap_free_with_destructor(_s, _f) \
344 ordered_hashmap_clear_with_destructor(_s, _f); \
345 ordered_hashmap_free(_s); \
348 /* no hashmap_next */
349 void *ordered_hashmap_next(OrderedHashmap
*h
, const void *key
);
351 char **internal_hashmap_get_strv(HashmapBase
*h
);
352 static inline char **hashmap_get_strv(Hashmap
*h
) {
353 return internal_hashmap_get_strv(HASHMAP_BASE(h
));
355 static inline char **ordered_hashmap_get_strv(OrderedHashmap
*h
) {
356 return internal_hashmap_get_strv(HASHMAP_BASE(h
));
360 * Hashmaps are iterated in unpredictable order.
361 * OrderedHashmaps are an exception to this. They are iterated in the order
362 * the entries were inserted.
363 * It is safe to remove the current entry.
365 #define HASHMAP_FOREACH(e, h, i) \
366 for ((i) = ITERATOR_FIRST; hashmap_iterate((h), &(i), (void**)&(e), NULL); )
368 #define ORDERED_HASHMAP_FOREACH(e, h, i) \
369 for ((i) = ITERATOR_FIRST; ordered_hashmap_iterate((h), &(i), (void**)&(e), NULL); )
371 #define HASHMAP_FOREACH_KEY(e, k, h, i) \
372 for ((i) = ITERATOR_FIRST; hashmap_iterate((h), &(i), (void**)&(e), (const void**) &(k)); )
374 #define ORDERED_HASHMAP_FOREACH_KEY(e, k, h, i) \
375 for ((i) = ITERATOR_FIRST; ordered_hashmap_iterate((h), &(i), (void**)&(e), (const void**) &(k)); )
377 DEFINE_TRIVIAL_CLEANUP_FUNC(Hashmap
*, hashmap_free
);
378 DEFINE_TRIVIAL_CLEANUP_FUNC(Hashmap
*, hashmap_free_free
);
379 DEFINE_TRIVIAL_CLEANUP_FUNC(Hashmap
*, hashmap_free_free_free
);
380 DEFINE_TRIVIAL_CLEANUP_FUNC(OrderedHashmap
*, ordered_hashmap_free
);
381 DEFINE_TRIVIAL_CLEANUP_FUNC(OrderedHashmap
*, ordered_hashmap_free_free
);
382 DEFINE_TRIVIAL_CLEANUP_FUNC(OrderedHashmap
*, ordered_hashmap_free_free_free
);
384 #define _cleanup_hashmap_free_ _cleanup_(hashmap_freep)
385 #define _cleanup_hashmap_free_free_ _cleanup_(hashmap_free_freep)
386 #define _cleanup_hashmap_free_free_free_ _cleanup_(hashmap_free_free_freep)
387 #define _cleanup_ordered_hashmap_free_ _cleanup_(ordered_hashmap_freep)
388 #define _cleanup_ordered_hashmap_free_free_ _cleanup_(ordered_hashmap_free_freep)
389 #define _cleanup_ordered_hashmap_free_free_free_ _cleanup_(ordered_hashmap_free_free_freep)
391 DEFINE_TRIVIAL_CLEANUP_FUNC(IteratedCache
*, iterated_cache_free
);
393 #define _cleanup_iterated_cache_free_ _cleanup_(iterated_cache_freep)