1 #ifndef _URCU_RCULFQUEUE_STATIC_H
2 #define _URCU_RCULFQUEUE_STATIC_H
7 * Userspace RCU library - Lock-Free RCU Queue
9 * Copyright 2010 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
11 * TO BE INCLUDED ONLY IN LGPL-COMPATIBLE CODE. See rculfqueue.h for linking
12 * dynamically with the userspace rcu library.
14 * This library is free software; you can redistribute it and/or
15 * modify it under the terms of the GNU Lesser General Public
16 * License as published by the Free Software Foundation; either
17 * version 2.1 of the License, or (at your option) any later version.
19 * This library is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22 * Lesser General Public License for more details.
24 * You should have received a copy of the GNU Lesser General Public
25 * License along with this library; if not, write to the Free Software
26 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
29 #include <urcu-call-rcu.h>
30 #include <urcu/uatomic.h>
38 struct cds_lfq_node_rcu_dummy
{
39 struct cds_lfq_node_rcu parent
;
41 struct cds_lfq_queue_rcu
*q
;
45 * Lock-free RCU queue. Enqueue and dequeue operations hold a RCU read
46 * lock to deal with cmpxchg ABA problem. This queue is *not* circular:
47 * head points to the oldest node, tail points to the newest node.
48 * A dummy node is kept to ensure enqueue and dequeue can always proceed
49 * concurrently. Keeping a separate head and tail helps with large
50 * queues: enqueue and dequeue can proceed concurrently without
51 * wrestling for exclusive access to the same variables.
53 * Dequeue retry if it detects that it would be dequeueing the last node
54 * (it means a dummy node dequeue-requeue is in progress). This ensures
55 * that there is always at least one node in the queue.
57 * In the dequeue operation, we internally reallocate the dummy node
58 * upon dequeue/requeue and use call_rcu to free the old one after a
63 int is_dummy(struct cds_lfq_node_rcu
*node
)
65 return ((unsigned long) node
) & 0x1UL
;
69 struct cds_lfq_node_rcu
*make_dummy(struct cds_lfq_queue_rcu
*q
,
70 struct cds_lfq_node_rcu
*next
)
72 struct cds_lfq_node_rcu_dummy
*dummy
;
74 dummy
= malloc(sizeof(struct cds_lfq_node_rcu_dummy
));
76 dummy
->parent
.next
= next
;
78 return (struct cds_lfq_node_rcu
*) (((unsigned long) &dummy
->parent
) | 0x1UL
);
82 struct cds_lfq_node_rcu
*get_node(struct cds_lfq_node_rcu
*node
)
84 return (struct cds_lfq_node_rcu
*) (((unsigned long )node
) & ~0x1UL
);
88 void free_dummy(struct rcu_head
*head
)
90 struct cds_lfq_node_rcu_dummy
*dummy
=
91 caa_container_of(head
, struct cds_lfq_node_rcu_dummy
, head
);
96 void rcu_free_dummy(struct cds_lfq_node_rcu
*node
)
98 struct cds_lfq_node_rcu_dummy
*dummy
;
100 dummy
= caa_container_of(get_node(node
), struct cds_lfq_node_rcu_dummy
,
102 dummy
->q
->queue_call_rcu(&dummy
->head
, free_dummy
);
106 void _cds_lfq_node_init_rcu(struct cds_lfq_node_rcu
*node
)
112 void _cds_lfq_init_rcu(struct cds_lfq_queue_rcu
*q
,
113 void queue_call_rcu(struct rcu_head
*head
,
114 void (*func
)(struct rcu_head
*head
)))
116 q
->tail
= make_dummy(q
, NULL
);
118 q
->queue_call_rcu
= queue_call_rcu
;
122 * The queue should be emptied before calling destroy.
124 * Return 0 on success, -EPERM if queue is not empty.
127 int _cds_lfq_destroy_rcu(struct cds_lfq_queue_rcu
*q
)
129 struct cds_lfq_node_rcu
*head
;
131 head
= rcu_dereference(q
->head
);
132 if (!(is_dummy(head
) && get_node(head
)->next
== NULL
))
133 return -EPERM
; /* not empty */
134 rcu_free_dummy(head
);
139 * Should be called under rcu read lock critical section.
142 void _cds_lfq_enqueue_rcu(struct cds_lfq_queue_rcu
*q
,
143 struct cds_lfq_node_rcu
*node
)
146 * uatomic_cmpxchg() implicit memory barrier orders earlier stores to
147 * node before publication.
151 struct cds_lfq_node_rcu
*tail
, *next
;
153 tail
= rcu_dereference(q
->tail
);
154 next
= uatomic_cmpxchg(&get_node(tail
)->next
, NULL
, node
);
157 * Tail was at the end of queue, we successfully
158 * appended to it. Now move tail (another
159 * enqueue might beat us to it, that's fine).
161 (void) uatomic_cmpxchg(&q
->tail
, tail
, node
);
165 * Failure to append to current tail.
166 * Help moving tail further and retry.
168 (void) uatomic_cmpxchg(&q
->tail
, tail
, next
);
175 * Should be called under rcu read lock critical section.
177 * The caller must wait for a grace period to pass before freeing the returned
178 * node or modifying the cds_lfq_node_rcu structure.
179 * Returns NULL if queue is empty.
182 struct cds_lfq_node_rcu
*_cds_lfq_dequeue_rcu(struct cds_lfq_queue_rcu
*q
)
185 struct cds_lfq_node_rcu
*head
, *next
;
187 head
= rcu_dereference(q
->head
);
188 next
= rcu_dereference(get_node(head
)->next
);
189 if (is_dummy(head
) && next
== NULL
)
190 return NULL
; /* empty */
192 * We never, ever allow dequeue to get to a state where
193 * the queue is empty (we need at least one node in the
194 * queue). This is ensured by checking if the head next
195 * is NULL and retry in that case (this means a
196 * concurrent dummy node re-enqueue is in progress).
199 if (uatomic_cmpxchg(&q
->head
, head
, next
) == head
) {
200 if (is_dummy(head
)) {
201 struct cds_lfq_node_rcu
*node
;
203 * Requeue dummy. We need to
204 * reallocate to protect from
207 rcu_free_dummy(head
);
208 node
= make_dummy(q
, NULL
);
209 _cds_lfq_enqueue_rcu(q
, node
);
210 continue; /* try again */
214 /* Concurrently pushed, retry */
218 /* Dummy node re-enqueue is in progress, retry. */
228 #endif /* _URCU_RCULFQUEUE_STATIC_H */
This page took 0.034664 seconds and 4 git commands to generate.