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 MD |
26 | #include <assert.h> |
27 | ||
0e2e9380 MD |
28 | #ifdef __cplusplus |
29 | extern "C" { | |
30 | #endif | |
31 | ||
d9b52143 | 32 | struct cds_lfq_queue_rcu; |
d95d5cb9 | 33 | struct rcu_head; |
d9b52143 | 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; |
6e5f88cf MD |
42 | void (*queue_call_rcu)(struct rcu_head *head, |
43 | void (*func)(struct rcu_head *head)); | |
453629a9 MD |
44 | }; |
45 | ||
3d02c34d | 46 | #ifdef _LGPL_SOURCE |
453629a9 | 47 | |
af7c2dbe | 48 | #include <urcu/static/rculfqueue.h> |
453629a9 | 49 | |
4157e1ac MD |
50 | #define cds_lfq_node_init_rcu _cds_lfq_node_init_rcu |
51 | #define cds_lfq_init_rcu _cds_lfq_init_rcu | |
52 | #define cds_lfq_destroy_rcu _cds_lfq_destroy_rcu | |
53 | #define cds_lfq_enqueue_rcu _cds_lfq_enqueue_rcu | |
54 | #define cds_lfq_dequeue_rcu _cds_lfq_dequeue_rcu | |
453629a9 | 55 | |
3d02c34d | 56 | #else /* !_LGPL_SOURCE */ |
453629a9 | 57 | |
16aa9ee8 | 58 | extern void cds_lfq_node_init_rcu(struct cds_lfq_node_rcu *node); |
6e5f88cf MD |
59 | extern void cds_lfq_init_rcu(struct cds_lfq_queue_rcu *q, |
60 | void queue_call_rcu(struct rcu_head *head, | |
61 | void (*func)(struct rcu_head *head))); | |
e17d9985 MD |
62 | /* |
63 | * The queue should be emptied before calling destroy. | |
64 | * | |
65 | * Return 0 on success, -EPERM if queue is not empty. | |
66 | */ | |
67 | extern int cds_lfq_destroy_rcu(struct cds_lfq_queue_rcu *q); | |
d9b52143 MD |
68 | |
69 | /* | |
6e5f88cf | 70 | * Should be called under rcu read lock critical section. |
d9b52143 MD |
71 | */ |
72 | extern void cds_lfq_enqueue_rcu(struct cds_lfq_queue_rcu *q, | |
73 | struct cds_lfq_node_rcu *node); | |
453629a9 MD |
74 | |
75 | /* | |
6e5f88cf | 76 | * Should be called under rcu read lock critical section. |
d9b52143 | 77 | * |
e17d9985 MD |
78 | * The caller must wait for a grace period to pass before freeing the returned |
79 | * node or modifying the cds_lfq_node_rcu structure. | |
80 | * Returns NULL if queue is empty. | |
453629a9 | 81 | */ |
a34df756 MD |
82 | extern |
83 | struct cds_lfq_node_rcu *cds_lfq_dequeue_rcu(struct cds_lfq_queue_rcu *q); | |
453629a9 | 84 | |
3d02c34d | 85 | #endif /* !_LGPL_SOURCE */ |
c3f74cb2 | 86 | |
0e2e9380 MD |
87 | #ifdef __cplusplus |
88 | } | |
89 | #endif | |
90 | ||
c3f74cb2 | 91 | #endif /* _URCU_RCULFQUEUE_H */ |