Commit | Line | Data |
---|---|---|
a42cc659 MD |
1 | #ifndef _URCU_RCULFHASH_H |
2 | #define _URCU_RCULFHASH_H | |
ab7d5fc6 | 3 | |
f0c29ed7 MD |
4 | /* |
5 | * urcu/rculfhash.h | |
6 | * | |
7 | * Userspace RCU library - Lock-Free RCU Hash Table | |
8 | * | |
9 | * Copyright 2011 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com> | |
10 | * | |
11 | * This library is free software; you can redistribute it and/or | |
12 | * modify it under the terms of the GNU Lesser General Public | |
13 | * License as published by the Free Software Foundation; either | |
14 | * version 2.1 of the License, or (at your option) any later version. | |
15 | * | |
16 | * This library is distributed in the hope that it will be useful, | |
17 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
19 | * Lesser General Public License for more details. | |
20 | * | |
21 | * You should have received a copy of the GNU Lesser General Public | |
22 | * License along with this library; if not, write to the Free Software | |
23 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA | |
24 | */ | |
25 | ||
674f7a69 | 26 | #include <stdint.h> |
abc490a1 MD |
27 | #include <urcu-call-rcu.h> |
28 | ||
01389791 MD |
29 | #ifdef __cplusplus |
30 | extern "C" { | |
31 | #endif | |
32 | ||
7f61a77f | 33 | /* |
14044b37 | 34 | * struct cds_lfht_node and struct _cds_lfht_node should be aligned on |
7f61a77f MD |
35 | * 4-bytes boundaries because the two lower bits are used as flags. |
36 | */ | |
37 | ||
14044b37 MD |
38 | struct _cds_lfht_node { |
39 | struct cds_lfht_node *next; /* ptr | DUMMY_FLAG | REMOVED_FLAG */ | |
abc490a1 | 40 | unsigned long reverse_hash; |
cc4fcb10 MD |
41 | }; |
42 | ||
14044b37 | 43 | struct cds_lfht_node { |
cc4fcb10 | 44 | /* cache-hot for iteration */ |
14044b37 | 45 | struct _cds_lfht_node p; /* needs to be first field */ |
9b35f1e4 MD |
46 | void *key; |
47 | unsigned int key_len; | |
9b35f1e4 | 48 | /* cache-cold for iteration */ |
abc490a1 MD |
49 | struct rcu_head head; |
50 | }; | |
51 | ||
14044b37 | 52 | struct cds_lfht; |
ab7d5fc6 | 53 | |
5e28c532 MD |
54 | /* |
55 | * Caution ! | |
abc490a1 | 56 | * Ensure reader and writer threads are registered as urcu readers. |
5e28c532 MD |
57 | */ |
58 | ||
14044b37 MD |
59 | typedef unsigned long (*cds_lfht_hash_fct)(void *key, size_t length, |
60 | unsigned long seed); | |
61 | typedef unsigned long (*cds_lfht_compare_fct)(void *key1, size_t key1_len, | |
62 | void *key2, size_t key2_len); | |
abc490a1 | 63 | |
f0c29ed7 | 64 | /* |
14044b37 | 65 | * cds_lfht_node_init - initialize a hash table node |
f0c29ed7 | 66 | */ |
abc490a1 | 67 | static inline |
14044b37 MD |
68 | void cds_lfht_node_init(struct cds_lfht_node *node, void *key, |
69 | size_t key_len) | |
abc490a1 MD |
70 | { |
71 | node->key = key; | |
732ad076 | 72 | node->key_len = key_len; |
abc490a1 | 73 | } |
674f7a69 MD |
74 | |
75 | /* | |
14044b37 | 76 | * cds_lfht_new - allocate a hash table. |
f0c29ed7 | 77 | * |
674f7a69 | 78 | * init_size must be power of two. |
6878c72b | 79 | * Return NULL on error. |
674f7a69 | 80 | */ |
14044b37 MD |
81 | struct cds_lfht *cds_lfht_new(cds_lfht_hash_fct hash_fct, |
82 | cds_lfht_compare_fct compare_fct, | |
83 | unsigned long hash_seed, | |
84 | unsigned long init_size, | |
85 | void (*cds_lfht_call_rcu)(struct rcu_head *head, | |
abc490a1 | 86 | void (*func)(struct rcu_head *head))); |
ab7d5fc6 | 87 | |
f0c29ed7 | 88 | /* |
14044b37 | 89 | * cds_lfht_destroy - destroy a hash table. |
6878c72b MD |
90 | * |
91 | * Return 0 on success, negative error value on error. | |
f0c29ed7 | 92 | */ |
14044b37 | 93 | int cds_lfht_destroy(struct cds_lfht *ht); |
f0c29ed7 MD |
94 | |
95 | /* | |
14044b37 | 96 | * cds_lfht_count_nodes - count the number of nodes in the hash table. |
f0c29ed7 MD |
97 | * |
98 | * Call with rcu_read_lock held. | |
99 | */ | |
14044b37 MD |
100 | void cds_lfht_count_nodes(struct cds_lfht *ht, |
101 | unsigned long *count, | |
102 | unsigned long *removed); | |
ab7d5fc6 | 103 | |
f0c29ed7 | 104 | /* |
14044b37 | 105 | * cds_lfht_lookup - lookup a node by key. |
f0c29ed7 | 106 | * |
6878c72b | 107 | * Return NULL if not found. |
f0c29ed7 MD |
108 | * Call with rcu_read_lock held. |
109 | */ | |
14044b37 | 110 | struct cds_lfht_node *cds_lfht_lookup(struct cds_lfht *ht, void *key, size_t key_len); |
ab7d5fc6 | 111 | |
f0c29ed7 | 112 | /* |
14044b37 | 113 | * cds_lfht_next - get the next item with same key (after a lookup). |
f0c29ed7 | 114 | * |
6878c72b | 115 | * Return NULL if no following node exists with same key. |
14044b37 MD |
116 | * RCU read-side lock must be held across cds_lfht_lookup and cds_lfht_next calls, and also |
117 | * between cds_lfht_next calls using the node returned by a previous cds_lfht_next. | |
f0c29ed7 MD |
118 | * Call with rcu_read_lock held. |
119 | */ | |
14044b37 | 120 | struct cds_lfht_node *cds_lfht_next(struct cds_lfht *ht, struct cds_lfht_node *node); |
ab7d5fc6 | 121 | |
18117871 | 122 | /* |
14044b37 | 123 | * cds_lfht_add - add a node to the hash table. |
f0c29ed7 | 124 | * |
18117871 | 125 | * Call with rcu_read_lock held. |
f0c29ed7 | 126 | */ |
14044b37 | 127 | void cds_lfht_add(struct cds_lfht *ht, struct cds_lfht_node *node); |
f0c29ed7 MD |
128 | |
129 | /* | |
14044b37 | 130 | * cds_lfht_add_unique - add a node to hash table, if key is not present. |
f0c29ed7 | 131 | * |
6878c72b MD |
132 | * Return the node added upon success. |
133 | * Return the unique node already present upon failure. If cds_lfht_add_unique fails, | |
18117871 | 134 | * the node passed as parameter should be freed by the caller. |
f0c29ed7 | 135 | * Call with rcu_read_lock held. |
18117871 | 136 | */ |
14044b37 | 137 | struct cds_lfht_node *cds_lfht_add_unique(struct cds_lfht *ht, struct cds_lfht_node *node); |
3eca1b8c | 138 | |
f0c29ed7 | 139 | /* |
14044b37 | 140 | * cds_lfht_remove - remove node from hash table. |
f0c29ed7 | 141 | * |
14044b37 | 142 | * Node can be looked up with cds_lfht_lookup. RCU read-side lock must be held between |
f0c29ed7 MD |
143 | * lookup and removal. |
144 | * Call with rcu_read_lock held. | |
145 | */ | |
14044b37 | 146 | int cds_lfht_remove(struct cds_lfht *ht, struct cds_lfht_node *node); |
ab7d5fc6 | 147 | |
f0c29ed7 | 148 | /* |
14044b37 | 149 | * cds_lfht_resize - Force a hash table resize |
f0c29ed7 MD |
150 | * @growth: growth order (current size is multiplied by 2^growth) |
151 | * | |
152 | * Currently, only expand operation is supported (growth >= 0). | |
153 | */ | |
14044b37 | 154 | void cds_lfht_resize(struct cds_lfht *ht, int growth); |
464a1ec9 | 155 | |
01389791 MD |
156 | #ifdef __cplusplus |
157 | } | |
158 | #endif | |
159 | ||
a42cc659 | 160 | #endif /* _URCU_RCULFHASH_H */ |