]>
Commit | Line | Data |
---|---|---|
663996b3 MS |
1 | /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/ |
2 | ||
3 | #pragma once | |
4 | ||
5 | /*** | |
6 | This file is part of systemd. | |
7 | ||
8 | Copyright 2010 Lennart Poettering | |
9 | ||
10 | systemd is free software; you can redistribute it and/or modify it | |
11 | under the terms of the GNU Lesser General Public License as published by | |
12 | the Free Software Foundation; either version 2.1 of the License, or | |
13 | (at your option) any later version. | |
14 | ||
15 | systemd is distributed in the hope that it will be useful, but | |
16 | WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
18 | Lesser General Public License for more details. | |
19 | ||
20 | You should have received a copy of the GNU Lesser General Public License | |
21 | along with systemd; If not, see <http://www.gnu.org/licenses/>. | |
22 | ***/ | |
23 | ||
24 | #include <stdbool.h> | |
25 | ||
26 | #include "macro.h" | |
60f067b4 | 27 | #include "util.h" |
663996b3 MS |
28 | |
29 | /* Pretty straightforward hash table implementation. As a minor | |
30 | * optimization a NULL hashmap object will be treated as empty hashmap | |
31 | * for all read operations. That way it is not necessary to | |
32 | * instantiate an object for each Hashmap use. */ | |
33 | ||
60f067b4 JS |
34 | #define HASH_KEY_SIZE 16 |
35 | ||
663996b3 MS |
36 | typedef struct Hashmap Hashmap; |
37 | typedef struct _IteratorStruct _IteratorStruct; | |
38 | typedef _IteratorStruct* Iterator; | |
39 | ||
40 | #define ITERATOR_FIRST ((Iterator) 0) | |
41 | #define ITERATOR_LAST ((Iterator) -1) | |
42 | ||
60f067b4 | 43 | typedef unsigned long (*hash_func_t)(const void *p, const uint8_t hash_key[HASH_KEY_SIZE]); |
663996b3 MS |
44 | typedef int (*compare_func_t)(const void *a, const void *b); |
45 | ||
60f067b4 | 46 | unsigned long string_hash_func(const void *p, const uint8_t hash_key[HASH_KEY_SIZE]) _pure_; |
663996b3 MS |
47 | int string_compare_func(const void *a, const void *b) _pure_; |
48 | ||
49 | /* This will compare the passed pointers directly, and will not | |
50 | * dereference them. This is hence not useful for strings or | |
51 | * suchlike. */ | |
60f067b4 | 52 | unsigned long trivial_hash_func(const void *p, const uint8_t hash_key[HASH_KEY_SIZE]) _pure_; |
663996b3 MS |
53 | int trivial_compare_func(const void *a, const void *b) _const_; |
54 | ||
60f067b4 | 55 | unsigned long uint64_hash_func(const void *p, const uint8_t hash_key[HASH_KEY_SIZE]) _pure_; |
663996b3 MS |
56 | int uint64_compare_func(const void *a, const void *b) _pure_; |
57 | ||
58 | Hashmap *hashmap_new(hash_func_t hash_func, compare_func_t compare_func); | |
59 | void hashmap_free(Hashmap *h); | |
60 | void hashmap_free_free(Hashmap *h); | |
61 | void hashmap_free_free_free(Hashmap *h); | |
62 | Hashmap *hashmap_copy(Hashmap *h); | |
63 | int hashmap_ensure_allocated(Hashmap **h, hash_func_t hash_func, compare_func_t compare_func); | |
64 | ||
65 | int hashmap_put(Hashmap *h, const void *key, void *value); | |
66 | int hashmap_update(Hashmap *h, const void *key, void *value); | |
67 | int hashmap_replace(Hashmap *h, const void *key, void *value); | |
68 | void *hashmap_get(Hashmap *h, const void *key); | |
69 | void *hashmap_get2(Hashmap *h, const void *key, void **rkey); | |
70 | bool hashmap_contains(Hashmap *h, const void *key); | |
71 | void *hashmap_remove(Hashmap *h, const void *key); | |
60f067b4 | 72 | void *hashmap_remove2(Hashmap *h, const void *key, void **rkey); |
663996b3 MS |
73 | void *hashmap_remove_value(Hashmap *h, const void *key, void *value); |
74 | int hashmap_remove_and_put(Hashmap *h, const void *old_key, const void *new_key, void *value); | |
75 | int hashmap_remove_and_replace(Hashmap *h, const void *old_key, const void *new_key, void *value); | |
76 | ||
77 | int hashmap_merge(Hashmap *h, Hashmap *other); | |
78 | void hashmap_move(Hashmap *h, Hashmap *other); | |
79 | int hashmap_move_one(Hashmap *h, Hashmap *other, const void *key); | |
80 | ||
81 | unsigned hashmap_size(Hashmap *h) _pure_; | |
82 | bool hashmap_isempty(Hashmap *h) _pure_; | |
14228c0d | 83 | unsigned hashmap_buckets(Hashmap *h) _pure_; |
663996b3 MS |
84 | |
85 | void *hashmap_iterate(Hashmap *h, Iterator *i, const void **key); | |
86 | void *hashmap_iterate_backwards(Hashmap *h, Iterator *i, const void **key); | |
87 | void *hashmap_iterate_skip(Hashmap *h, const void *key, Iterator *i); | |
88 | ||
89 | void hashmap_clear(Hashmap *h); | |
90 | void hashmap_clear_free(Hashmap *h); | |
91 | void hashmap_clear_free_free(Hashmap *h); | |
92 | ||
93 | void *hashmap_steal_first(Hashmap *h); | |
94 | void *hashmap_steal_first_key(Hashmap *h); | |
95 | void *hashmap_first(Hashmap *h) _pure_; | |
96 | void *hashmap_first_key(Hashmap *h) _pure_; | |
97 | void *hashmap_last(Hashmap *h) _pure_; | |
98 | ||
99 | void *hashmap_next(Hashmap *h, const void *key); | |
100 | ||
101 | char **hashmap_get_strv(Hashmap *h); | |
102 | ||
103 | #define HASHMAP_FOREACH(e, h, i) \ | |
104 | for ((i) = ITERATOR_FIRST, (e) = hashmap_iterate((h), &(i), NULL); (e); (e) = hashmap_iterate((h), &(i), NULL)) | |
105 | ||
106 | #define HASHMAP_FOREACH_KEY(e, k, h, i) \ | |
107 | for ((i) = ITERATOR_FIRST, (e) = hashmap_iterate((h), &(i), (const void**) &(k)); (e); (e) = hashmap_iterate((h), &(i), (const void**) &(k))) | |
108 | ||
109 | #define HASHMAP_FOREACH_BACKWARDS(e, h, i) \ | |
110 | for ((i) = ITERATOR_LAST, (e) = hashmap_iterate_backwards((h), &(i), NULL); (e); (e) = hashmap_iterate_backwards((h), &(i), NULL)) | |
60f067b4 JS |
111 | |
112 | DEFINE_TRIVIAL_CLEANUP_FUNC(Hashmap*, hashmap_free); | |
113 | DEFINE_TRIVIAL_CLEANUP_FUNC(Hashmap*, hashmap_free_free); | |
114 | DEFINE_TRIVIAL_CLEANUP_FUNC(Hashmap*, hashmap_free_free_free); | |
115 | #define _cleanup_hashmap_free_ _cleanup_(hashmap_freep) | |
116 | #define _cleanup_hashmap_free_free_ _cleanup_(hashmap_free_freep) | |
117 | #define _cleanup_hashmap_free_free_free_ _cleanup_(hashmap_free_free_freep) |