1 #ifndef _URCU_RCUJA_INTERNAL_H
2 #define _URCU_RCUJA_INTERNAL_H
5 * rcuja/rcuja-internal.h
7 * Userspace RCU library - RCU Judy Array Internal Header
9 * Copyright 2012 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
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.
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.
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
27 #include <urcu/rculfhash.h>
29 /* Never declared. Opaque type used to store flagged node pointers. */
30 struct rcu_ja_node_flag
;
33 * Shadow node contains mutex and call_rcu head associated with a node.
35 struct rcu_ja_shadow_node
{
36 struct cds_lfht_node ht_node
; /* hash table node */
37 struct rcu_ja_node
*node
; /* reverse mapping and hash table key */
39 * mutual exclusion on all nodes belonging to the same tree
40 * position (e.g. both nodes before and after recompaction
43 pthread_mutex_t
*lock
;
44 unsigned int nr_child
; /* number of children in node */
45 struct rcu_head head
; /* for deferred node and shadow node reclaim */
49 struct rcu_ja_node_flag
*root
;
51 * We use a hash table to associate node keys to their
52 * respective shadow node. This helps reducing lookup hot path
53 * cache footprint, especially for very small nodes.
58 __attribute__((visibility("protected")))
59 struct rcu_ja_shadow_node
*rcuja_shadow_lookup_lock(struct cds_lfht
*ht
,
60 struct rcu_ja_node
*node
);
61 __attribute__((visibility("protected")))
62 void rcuja_shadow_unlock(struct rcu_ja_shadow_node
*shadow_node
);
63 __attribute__((visibility("protected")))
64 int rcuja_shadow_set(struct cds_lfht
*ht
,
65 struct rcu_ja_node
*new_node
,
66 struct rcu_ja_shadow_node
*inherit_from
);
67 __attribute__((visibility("protected")))
69 /* rcuja_shadow_clear flags */
71 RCUJA_SHADOW_CLEAR_FREE_NODE
= (1U << 0),
72 RCUJA_SHADOW_CLEAR_FREE_LOCK
= (1U << 1),
75 int rcuja_shadow_clear(struct cds_lfht
*ht
,
76 struct rcu_ja_node
*node
,
78 __attribute__((visibility("protected")))
79 struct cds_lfht
*rcuja_create_ht(const struct rcu_flavor_struct
*flavor
);
80 __attribute__((visibility("protected")))
81 void rcuja_delete_ht(struct cds_lfht
*ht
);
83 #endif /* _URCU_RCUJA_INTERNAL_H */