Commit | Line | Data |
---|---|---|
c3f74cb2 MD |
1 | #ifndef _URCU_RCULFSTACK_H |
2 | #define _URCU_RCULFSTACK_H | |
3 | ||
453629a9 MD |
4 | /* |
5 | * rculfstack.h | |
6 | * | |
7 | * Userspace RCU library - Lock-Free RCU Stack | |
8 | * | |
9 | * Copyright 2010 - 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 | ||
0e2e9380 MD |
26 | #ifdef __cplusplus |
27 | extern "C" { | |
28 | #endif | |
29 | ||
d89ec762 MD |
30 | #ifndef CDS_LFS_RCU_DEPRECATED |
31 | #define CDS_LFS_RCU_DEPRECATED \ | |
32 | __attribute__((deprecated("urcu/rculfstack.h is deprecated. Please use urcu/lfstack.h instead."))) | |
33 | #endif | |
34 | ||
16aa9ee8 DG |
35 | struct cds_lfs_node_rcu { |
36 | struct cds_lfs_node_rcu *next; | |
453629a9 MD |
37 | }; |
38 | ||
16aa9ee8 DG |
39 | struct cds_lfs_stack_rcu { |
40 | struct cds_lfs_node_rcu *head; | |
453629a9 MD |
41 | }; |
42 | ||
b6a37eac | 43 | #ifdef _LGPL_SOURCE |
453629a9 | 44 | |
af7c2dbe | 45 | #include <urcu/static/rculfstack.h> |
453629a9 | 46 | |
d89ec762 MD |
47 | static inline CDS_LFS_RCU_DEPRECATED |
48 | void cds_lfs_node_init_rcu(struct cds_lfs_node_rcu *node) | |
49 | { | |
50 | _cds_lfs_node_init_rcu(node); | |
51 | } | |
52 | ||
53 | static inline | |
54 | void cds_lfs_init_rcu(struct cds_lfs_stack_rcu *s) | |
55 | { | |
56 | _cds_lfs_init_rcu(s); | |
57 | } | |
58 | ||
59 | static inline CDS_LFS_RCU_DEPRECATED | |
60 | int cds_lfs_push_rcu(struct cds_lfs_stack_rcu *s, | |
61 | struct cds_lfs_node_rcu *node) | |
62 | { | |
63 | return _cds_lfs_push_rcu(s, node); | |
64 | } | |
65 | ||
66 | static inline CDS_LFS_RCU_DEPRECATED | |
67 | struct cds_lfs_node_rcu *cds_lfs_pop_rcu(struct cds_lfs_stack_rcu *s) | |
68 | { | |
69 | return _cds_lfs_pop_rcu(s); | |
70 | } | |
453629a9 | 71 | |
b6a37eac MD |
72 | #else /* !_LGPL_SOURCE */ |
73 | ||
d89ec762 MD |
74 | extern CDS_LFS_RCU_DEPRECATED |
75 | void cds_lfs_node_init_rcu(struct cds_lfs_node_rcu *node); | |
76 | extern CDS_LFS_RCU_DEPRECATED | |
77 | void cds_lfs_init_rcu(struct cds_lfs_stack_rcu *s); | |
78 | extern CDS_LFS_RCU_DEPRECATED | |
79 | int cds_lfs_push_rcu(struct cds_lfs_stack_rcu *s, | |
e1a3b81e | 80 | struct cds_lfs_node_rcu *node); |
453629a9 | 81 | |
1c1e940e | 82 | /* |
6e5f88cf | 83 | * Should be called under rcu read lock critical section. |
d9b52143 | 84 | * |
1c1e940e | 85 | * The caller must wait for a grace period to pass before freeing the returned |
16aa9ee8 | 86 | * node or modifying the cds_lfs_node_rcu structure. |
1c1e940e MD |
87 | * Returns NULL if stack is empty. |
88 | */ | |
d89ec762 MD |
89 | extern CDS_LFS_RCU_DEPRECATED |
90 | struct cds_lfs_node_rcu *cds_lfs_pop_rcu(struct cds_lfs_stack_rcu *s); | |
453629a9 | 91 | |
b6a37eac | 92 | #endif /* !_LGPL_SOURCE */ |
c3f74cb2 | 93 | |
0e2e9380 MD |
94 | #ifdef __cplusplus |
95 | } | |
96 | #endif | |
97 | ||
c3f74cb2 | 98 | #endif /* _URCU_RCULFSTACK_H */ |