Commit | Line | Data |
---|---|---|
c3f74cb2 MD |
1 | #ifndef _URCU_RCULFQUEUE_H |
2 | #define _URCU_RCULFQUEUE_H | |
3 | ||
453629a9 MD |
4 | /* |
5 | * rculfqueue.h | |
6 | * | |
7 | * Userspace RCU library - Lock-Free RCU Queue | |
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 | ||
453629a9 | 26 | #include <assert.h> |
e17d9985 | 27 | #include <urcu-call-rcu.h> |
453629a9 | 28 | |
0e2e9380 MD |
29 | #ifdef __cplusplus |
30 | extern "C" { | |
31 | #endif | |
32 | ||
d9b52143 MD |
33 | struct cds_lfq_queue_rcu; |
34 | ||
16aa9ee8 DG |
35 | struct cds_lfq_node_rcu { |
36 | struct cds_lfq_node_rcu *next; | |
fbdb32f6 | 37 | int dummy; |
453629a9 MD |
38 | }; |
39 | ||
16aa9ee8 | 40 | struct cds_lfq_queue_rcu { |
fbdb32f6 | 41 | struct cds_lfq_node_rcu *head, *tail; |
453629a9 MD |
42 | }; |
43 | ||
3d02c34d | 44 | #ifdef _LGPL_SOURCE |
453629a9 | 45 | |
af7c2dbe | 46 | #include <urcu/static/rculfqueue.h> |
453629a9 | 47 | |
d4b99c01 MD |
48 | #define cds_lfq_node_init_rcu_qsbr _cds_lfq_node_init_rcu |
49 | #define cds_lfq_init_rcu_qsbr _cds_lfq_init_rcu | |
50 | #define cds_lfq_destroy_rcu_qsbr _cds_lfq_destroy_rcu | |
51 | #define cds_lfq_enqueue_rcu_qsbr _cds_lfq_enqueue_rcu | |
52 | #define cds_lfq_dequeue_rcu_qsbr _cds_lfq_dequeue_rcu | |
53 | ||
54 | #define cds_lfq_node_init_rcu_bp _cds_lfq_node_init_rcu | |
55 | #define cds_lfq_init_rcu_bp _cds_lfq_init_rcu | |
56 | #define cds_lfq_destroy_rcu_bp _cds_lfq_destroy_rcu | |
57 | #define cds_lfq_enqueue_rcu_bp _cds_lfq_enqueue_rcu | |
58 | #define cds_lfq_dequeue_rcu_bp _cds_lfq_dequeue_rcu | |
59 | ||
60 | #define cds_lfq_node_init_rcu_memb _cds_lfq_node_init_rcu | |
61 | #define cds_lfq_init_rcu_memb _cds_lfq_init_rcu | |
62 | #define cds_lfq_destroy_rcu_memb _cds_lfq_destroy_rcu | |
63 | #define cds_lfq_enqueue_rcu_memb _cds_lfq_enqueue_rcu | |
64 | #define cds_lfq_dequeue_rcu_memb _cds_lfq_dequeue_rcu | |
65 | ||
66 | #define cds_lfq_node_init_rcu_mb _cds_lfq_node_init_rcu | |
67 | #define cds_lfq_init_rcu_mb _cds_lfq_init_rcu | |
68 | #define cds_lfq_destroy_rcu_mb _cds_lfq_destroy_rcu | |
69 | #define cds_lfq_enqueue_rcu_mb _cds_lfq_enqueue_rcu | |
70 | #define cds_lfq_dequeue_rcu_mb _cds_lfq_dequeue_rcu | |
71 | ||
72 | #define cds_lfq_node_init_rcu_sig _cds_lfq_node_init_rcu | |
73 | #define cds_lfq_init_rcu_sig _cds_lfq_init_rcu | |
74 | #define cds_lfq_destroy_rcu_sig _cds_lfq_destroy_rcu | |
75 | #define cds_lfq_enqueue_rcu_sig _cds_lfq_enqueue_rcu | |
76 | #define cds_lfq_dequeue_rcu_sig _cds_lfq_dequeue_rcu | |
453629a9 | 77 | |
3d02c34d | 78 | #else /* !_LGPL_SOURCE */ |
453629a9 | 79 | |
16aa9ee8 | 80 | extern void cds_lfq_node_init_rcu(struct cds_lfq_node_rcu *node); |
7618919a | 81 | extern void cds_lfq_init_rcu(struct cds_lfq_queue_rcu *q); |
e17d9985 MD |
82 | /* |
83 | * The queue should be emptied before calling destroy. | |
84 | * | |
85 | * Return 0 on success, -EPERM if queue is not empty. | |
86 | */ | |
87 | extern int cds_lfq_destroy_rcu(struct cds_lfq_queue_rcu *q); | |
d9b52143 MD |
88 | |
89 | /* | |
7618919a | 90 | * Acts as a RCU reader. |
d9b52143 MD |
91 | */ |
92 | extern void cds_lfq_enqueue_rcu(struct cds_lfq_queue_rcu *q, | |
93 | struct cds_lfq_node_rcu *node); | |
453629a9 MD |
94 | |
95 | /* | |
7618919a | 96 | * Acts as a RCU reader. |
d9b52143 | 97 | * |
e17d9985 MD |
98 | * The caller must wait for a grace period to pass before freeing the returned |
99 | * node or modifying the cds_lfq_node_rcu structure. | |
100 | * Returns NULL if queue is empty. | |
453629a9 | 101 | */ |
a34df756 MD |
102 | extern |
103 | struct cds_lfq_node_rcu *cds_lfq_dequeue_rcu(struct cds_lfq_queue_rcu *q); | |
453629a9 | 104 | |
3d02c34d | 105 | #endif /* !_LGPL_SOURCE */ |
c3f74cb2 | 106 | |
0e2e9380 MD |
107 | #ifdef __cplusplus |
108 | } | |
109 | #endif | |
110 | ||
c3f74cb2 | 111 | #endif /* _URCU_RCULFQUEUE_H */ |