rculfhash: comment file inclusion order
[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
cf77d1fa
MD
24 *
25 * Include this file _after_ including your URCU flavor.
f0c29ed7
MD
26 */
27
674f7a69 28#include <stdint.h>
abc490a1
MD
29#include <urcu-call-rcu.h>
30
01389791
MD
31#ifdef __cplusplus
32extern "C" {
33#endif
34
7f61a77f 35/*
14044b37 36 * struct cds_lfht_node and struct _cds_lfht_node should be aligned on
7f61a77f
MD
37 * 4-bytes boundaries because the two lower bits are used as flags.
38 */
39
14044b37
MD
40struct _cds_lfht_node {
41 struct cds_lfht_node *next; /* ptr | DUMMY_FLAG | REMOVED_FLAG */
abc490a1 42 unsigned long reverse_hash;
cc4fcb10
MD
43};
44
14044b37 45struct cds_lfht_node {
cc4fcb10 46 /* cache-hot for iteration */
14044b37 47 struct _cds_lfht_node p; /* needs to be first field */
9b35f1e4
MD
48 void *key;
49 unsigned int key_len;
9b35f1e4 50 /* cache-cold for iteration */
abc490a1
MD
51 struct rcu_head head;
52};
53
14044b37 54struct cds_lfht;
ab7d5fc6 55
5e28c532
MD
56/*
57 * Caution !
abc490a1 58 * Ensure reader and writer threads are registered as urcu readers.
5e28c532
MD
59 */
60
14044b37
MD
61typedef unsigned long (*cds_lfht_hash_fct)(void *key, size_t length,
62 unsigned long seed);
63typedef unsigned long (*cds_lfht_compare_fct)(void *key1, size_t key1_len,
64 void *key2, size_t key2_len);
abc490a1 65
f0c29ed7 66/*
14044b37 67 * cds_lfht_node_init - initialize a hash table node
f0c29ed7 68 */
abc490a1 69static inline
14044b37
MD
70void cds_lfht_node_init(struct cds_lfht_node *node, void *key,
71 size_t key_len)
abc490a1
MD
72{
73 node->key = key;
732ad076 74 node->key_len = key_len;
abc490a1 75}
674f7a69 76
b8af5011
MD
77/*
78 * Hash table creation flags.
79 */
80enum {
81 CDS_LFHT_AUTO_RESIZE = (1U << 0),
82};
83
674f7a69 84/*
7a9dcf9b 85 * _cds_lfht_new - API used by cds_lfht_new wrapper. Do not use directly.
674f7a69 86 */
7a9dcf9b 87struct cds_lfht *_cds_lfht_new(cds_lfht_hash_fct hash_fct,
14044b37
MD
88 cds_lfht_compare_fct compare_fct,
89 unsigned long hash_seed,
90 unsigned long init_size,
b8af5011 91 int flags,
14044b37 92 void (*cds_lfht_call_rcu)(struct rcu_head *head,
1475579c 93 void (*func)(struct rcu_head *head)),
01dbfa62
MD
94 void (*cds_lfht_synchronize_rcu)(void),
95 void (*cds_lfht_rcu_read_lock)(void),
5f511391
MD
96 void (*cds_lfht_rcu_read_unlock)(void),
97 void (*cds_lfht_rcu_thread_offline)(void),
98 void (*cds_lfht_rcu_thread_online)(void));
ab7d5fc6 99
7a9dcf9b
MD
100/*
101 * cds_lfht_new - allocate a hash table.
102 *
103 * init_size must be power of two.
104 * Return NULL on error.
105 * Note: the RCU flavor must be already included before the hash table header.
106 */
107static inline
108struct cds_lfht *cds_lfht_new(cds_lfht_hash_fct hash_fct,
109 cds_lfht_compare_fct compare_fct,
110 unsigned long hash_seed,
111 unsigned long init_size,
112 int flags)
113{
114 return _cds_lfht_new(hash_fct, compare_fct, hash_seed,
115 init_size, flags,
116 call_rcu, synchronize_rcu, rcu_read_lock,
117 rcu_read_unlock, rcu_thread_offline,
118 rcu_thread_online);
119}
120
f0c29ed7 121/*
14044b37 122 * cds_lfht_destroy - destroy a hash table.
6878c72b
MD
123 *
124 * Return 0 on success, negative error value on error.
f0c29ed7 125 */
14044b37 126int cds_lfht_destroy(struct cds_lfht *ht);
f0c29ed7
MD
127
128/*
14044b37 129 * cds_lfht_count_nodes - count the number of nodes in the hash table.
f0c29ed7
MD
130 *
131 * Call with rcu_read_lock held.
132 */
14044b37
MD
133void cds_lfht_count_nodes(struct cds_lfht *ht,
134 unsigned long *count,
135 unsigned long *removed);
ab7d5fc6 136
f0c29ed7 137/*
14044b37 138 * cds_lfht_lookup - lookup a node by key.
f0c29ed7 139 *
6878c72b 140 * Return NULL if not found.
f0c29ed7
MD
141 * Call with rcu_read_lock held.
142 */
14044b37 143struct cds_lfht_node *cds_lfht_lookup(struct cds_lfht *ht, void *key, size_t key_len);
ab7d5fc6 144
f0c29ed7 145/*
14044b37 146 * cds_lfht_next - get the next item with same key (after a lookup).
f0c29ed7 147 *
6878c72b 148 * Return NULL if no following node exists with same key.
14044b37
MD
149 * RCU read-side lock must be held across cds_lfht_lookup and cds_lfht_next calls, and also
150 * between cds_lfht_next calls using the node returned by a previous cds_lfht_next.
f0c29ed7
MD
151 * Call with rcu_read_lock held.
152 */
14044b37 153struct cds_lfht_node *cds_lfht_next(struct cds_lfht *ht, struct cds_lfht_node *node);
ab7d5fc6 154
18117871 155/*
14044b37 156 * cds_lfht_add - add a node to the hash table.
f0c29ed7 157 *
18117871 158 * Call with rcu_read_lock held.
f0c29ed7 159 */
14044b37 160void cds_lfht_add(struct cds_lfht *ht, struct cds_lfht_node *node);
f0c29ed7
MD
161
162/*
14044b37 163 * cds_lfht_add_unique - add a node to hash table, if key is not present.
f0c29ed7 164 *
6878c72b
MD
165 * Return the node added upon success.
166 * Return the unique node already present upon failure. If cds_lfht_add_unique fails,
18117871 167 * the node passed as parameter should be freed by the caller.
f0c29ed7 168 * Call with rcu_read_lock held.
18117871 169 */
14044b37 170struct cds_lfht_node *cds_lfht_add_unique(struct cds_lfht *ht, struct cds_lfht_node *node);
3eca1b8c 171
f0c29ed7 172/*
14044b37 173 * cds_lfht_remove - remove node from hash table.
f0c29ed7 174 *
14044b37 175 * Node can be looked up with cds_lfht_lookup. RCU read-side lock must be held between
f0c29ed7
MD
176 * lookup and removal.
177 * Call with rcu_read_lock held.
178 */
14044b37 179int cds_lfht_remove(struct cds_lfht *ht, struct cds_lfht_node *node);
ab7d5fc6 180
f0c29ed7 181/*
14044b37 182 * cds_lfht_resize - Force a hash table resize
1475579c 183 * @new_size: update to this hash table size.
f0c29ed7 184 */
1475579c 185void cds_lfht_resize(struct cds_lfht *ht, unsigned long new_size);
464a1ec9 186
01389791
MD
187#ifdef __cplusplus
188}
189#endif
190
a42cc659 191#endif /* _URCU_RCULFHASH_H */
This page took 0.045536 seconds and 4 git commands to generate.