rcuja: rename to cds_ja
[userspace-rcu.git] / rcuja / rcuja-internal.h
CommitLineData
61009379
MD
1#ifndef _URCU_RCUJA_INTERNAL_H
2#define _URCU_RCUJA_INTERNAL_H
3
4/*
5 * rcuja/rcuja-internal.h
6 *
7 * Userspace RCU library - RCU Judy Array Internal Header
8 *
9 * Copyright 2012 - 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
511b4dcc
MD
26#include <pthread.h>
27#include <urcu/rculfhash.h>
28
29/* Never declared. Opaque type used to store flagged node pointers. */
d96bfb0d 30struct cds_ja_node_flag;
511b4dcc
MD
31
32/*
33 * Shadow node contains mutex and call_rcu head associated with a node.
34 */
d96bfb0d 35struct cds_ja_shadow_node {
d22c185b 36 struct cds_lfht_node ht_node; /* hash table node */
d96bfb0d 37 struct cds_ja_node *node; /* reverse mapping and hash table key */
e1db2db5
MD
38 /*
39 * mutual exclusion on all nodes belonging to the same tree
40 * position (e.g. both nodes before and after recompaction
41 * use the same lock).
42 */
43 pthread_mutex_t *lock;
44 unsigned int nr_child; /* number of children in node */
d22c185b 45 struct rcu_head head; /* for deferred node and shadow node reclaim */
511b4dcc
MD
46};
47
d96bfb0d
MD
48struct cds_ja {
49 struct cds_ja_node_flag *root;
511b4dcc 50 /*
e1db2db5
MD
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.
511b4dcc
MD
54 */
55 struct cds_lfht *ht;
56};
61009379 57
25fde237 58__attribute__((visibility("protected")))
d96bfb0d
MD
59struct cds_ja_shadow_node *rcuja_shadow_lookup_lock(struct cds_lfht *ht,
60 struct cds_ja_node *node);
25fde237 61__attribute__((visibility("protected")))
d96bfb0d 62void rcuja_shadow_unlock(struct cds_ja_shadow_node *shadow_node);
25fde237
MD
63__attribute__((visibility("protected")))
64int rcuja_shadow_set(struct cds_lfht *ht,
d96bfb0d
MD
65 struct cds_ja_node *new_node,
66 struct cds_ja_shadow_node *inherit_from);
25fde237 67__attribute__((visibility("protected")))
e1db2db5
MD
68
69/* rcuja_shadow_clear flags */
70enum {
71 RCUJA_SHADOW_CLEAR_FREE_NODE = (1U << 0),
72 RCUJA_SHADOW_CLEAR_FREE_LOCK = (1U << 1),
73};
74
75int rcuja_shadow_clear(struct cds_lfht *ht,
d96bfb0d 76 struct cds_ja_node *node,
e1db2db5 77 unsigned int flags);
25fde237 78__attribute__((visibility("protected")))
5eb692c0 79struct cds_lfht *rcuja_create_ht(const struct rcu_flavor_struct *flavor);
25fde237
MD
80__attribute__((visibility("protected")))
81void rcuja_delete_ht(struct cds_lfht *ht);
82
61009379 83#endif /* _URCU_RCUJA_INTERNAL_H */
This page took 0.028692 seconds and 4 git commands to generate.