rculfhash: simplify lfht_new API with inline wrapper
[urcu.git] / urcu / rculfhash.h
CommitLineData
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
30extern "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
38struct _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 43struct 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 52struct 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
59typedef unsigned long (*cds_lfht_hash_fct)(void *key, size_t length,
60 unsigned long seed);
61typedef 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 67static inline
14044b37
MD
68void 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 74
b8af5011
MD
75/*
76 * Hash table creation flags.
77 */
78enum {
79 CDS_LFHT_AUTO_RESIZE = (1U << 0),
80};
81
674f7a69 82/*
7a9dcf9b 83 * _cds_lfht_new - API used by cds_lfht_new wrapper. Do not use directly.
674f7a69 84 */
7a9dcf9b 85struct cds_lfht *_cds_lfht_new(cds_lfht_hash_fct hash_fct,
14044b37
MD
86 cds_lfht_compare_fct compare_fct,
87 unsigned long hash_seed,
88 unsigned long init_size,
b8af5011 89 int flags,
14044b37 90 void (*cds_lfht_call_rcu)(struct rcu_head *head,
1475579c 91 void (*func)(struct rcu_head *head)),
01dbfa62
MD
92 void (*cds_lfht_synchronize_rcu)(void),
93 void (*cds_lfht_rcu_read_lock)(void),
5f511391
MD
94 void (*cds_lfht_rcu_read_unlock)(void),
95 void (*cds_lfht_rcu_thread_offline)(void),
96 void (*cds_lfht_rcu_thread_online)(void));
ab7d5fc6 97
7a9dcf9b
MD
98/*
99 * cds_lfht_new - allocate a hash table.
100 *
101 * init_size must be power of two.
102 * Return NULL on error.
103 * Note: the RCU flavor must be already included before the hash table header.
104 */
105static inline
106struct cds_lfht *cds_lfht_new(cds_lfht_hash_fct hash_fct,
107 cds_lfht_compare_fct compare_fct,
108 unsigned long hash_seed,
109 unsigned long init_size,
110 int flags)
111{
112 return _cds_lfht_new(hash_fct, compare_fct, hash_seed,
113 init_size, flags,
114 call_rcu, synchronize_rcu, rcu_read_lock,
115 rcu_read_unlock, rcu_thread_offline,
116 rcu_thread_online);
117}
118
f0c29ed7 119/*
14044b37 120 * cds_lfht_destroy - destroy a hash table.
6878c72b
MD
121 *
122 * Return 0 on success, negative error value on error.
f0c29ed7 123 */
14044b37 124int cds_lfht_destroy(struct cds_lfht *ht);
f0c29ed7
MD
125
126/*
14044b37 127 * cds_lfht_count_nodes - count the number of nodes in the hash table.
f0c29ed7
MD
128 *
129 * Call with rcu_read_lock held.
130 */
14044b37
MD
131void cds_lfht_count_nodes(struct cds_lfht *ht,
132 unsigned long *count,
133 unsigned long *removed);
ab7d5fc6 134
f0c29ed7 135/*
14044b37 136 * cds_lfht_lookup - lookup a node by key.
f0c29ed7 137 *
6878c72b 138 * Return NULL if not found.
f0c29ed7
MD
139 * Call with rcu_read_lock held.
140 */
14044b37 141struct cds_lfht_node *cds_lfht_lookup(struct cds_lfht *ht, void *key, size_t key_len);
ab7d5fc6 142
f0c29ed7 143/*
14044b37 144 * cds_lfht_next - get the next item with same key (after a lookup).
f0c29ed7 145 *
6878c72b 146 * Return NULL if no following node exists with same key.
14044b37
MD
147 * RCU read-side lock must be held across cds_lfht_lookup and cds_lfht_next calls, and also
148 * between cds_lfht_next calls using the node returned by a previous cds_lfht_next.
f0c29ed7
MD
149 * Call with rcu_read_lock held.
150 */
14044b37 151struct cds_lfht_node *cds_lfht_next(struct cds_lfht *ht, struct cds_lfht_node *node);
ab7d5fc6 152
18117871 153/*
14044b37 154 * cds_lfht_add - add a node to the hash table.
f0c29ed7 155 *
18117871 156 * Call with rcu_read_lock held.
f0c29ed7 157 */
14044b37 158void cds_lfht_add(struct cds_lfht *ht, struct cds_lfht_node *node);
f0c29ed7
MD
159
160/*
14044b37 161 * cds_lfht_add_unique - add a node to hash table, if key is not present.
f0c29ed7 162 *
6878c72b
MD
163 * Return the node added upon success.
164 * Return the unique node already present upon failure. If cds_lfht_add_unique fails,
18117871 165 * the node passed as parameter should be freed by the caller.
f0c29ed7 166 * Call with rcu_read_lock held.
18117871 167 */
14044b37 168struct cds_lfht_node *cds_lfht_add_unique(struct cds_lfht *ht, struct cds_lfht_node *node);
3eca1b8c 169
f0c29ed7 170/*
14044b37 171 * cds_lfht_remove - remove node from hash table.
f0c29ed7 172 *
14044b37 173 * Node can be looked up with cds_lfht_lookup. RCU read-side lock must be held between
f0c29ed7
MD
174 * lookup and removal.
175 * Call with rcu_read_lock held.
176 */
14044b37 177int cds_lfht_remove(struct cds_lfht *ht, struct cds_lfht_node *node);
ab7d5fc6 178
f0c29ed7 179/*
14044b37 180 * cds_lfht_resize - Force a hash table resize
1475579c 181 * @new_size: update to this hash table size.
f0c29ed7 182 */
1475579c 183void cds_lfht_resize(struct cds_lfht *ht, unsigned long new_size);
464a1ec9 184
01389791
MD
185#ifdef __cplusplus
186}
187#endif
188
a42cc659 189#endif /* _URCU_RCULFHASH_H */
This page took 0.046494 seconds and 4 git commands to generate.