projects
/
urcu.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
wfcqueue: remove ancient comment
[urcu.git]
/
urcu
/
static
/
wfcqueue.h
diff --git
a/urcu/static/wfcqueue.h
b/urcu/static/wfcqueue.h
index 944ee88c74d855f78035b6f826c8b73eb6de79b6..4a9003e525d0e1ed34ae4fdd9ea6eb3f7a3aea44 100644
(file)
--- a/
urcu/static/wfcqueue.h
+++ b/
urcu/static/wfcqueue.h
@@
-41,8
+41,10
@@
extern "C" {
/*
* Concurrent queue with wait-free enqueue/blocking dequeue.
*
/*
* Concurrent queue with wait-free enqueue/blocking dequeue.
*
- * Inspired from half-wait-free/half-blocking queue implementation done by
- * Paul E. McKenney.
+ * This queue has been designed and implemented collaboratively by
+ * Mathieu Desnoyers and Lai Jiangshan. Inspired from
+ * half-wait-free/half-blocking queue implementation done by Paul E.
+ * McKenney.
*
* Mutual exclusion of __cds_wfcq_* API
*
*
* Mutual exclusion of __cds_wfcq_* API
*
@@
-57,6
+59,10
@@
extern "C" {
*
* For convenience, cds_wfcq_dequeue_blocking() and
* cds_wfcq_splice_blocking() hold the dequeue lock.
*
* For convenience, cds_wfcq_dequeue_blocking() and
* cds_wfcq_splice_blocking() hold the dequeue lock.
+ *
+ * Besides locking, mutual exclusion of dequeue, splice and iteration
+ * can be ensured by performing all of those operations from a single
+ * thread, without requiring any lock.
*/
#define WFCQ_ADAPT_ATTEMPTS 10 /* Retry if being set */
*/
#define WFCQ_ADAPT_ATTEMPTS 10 /* Retry if being set */
@@
-190,7
+196,8
@@
___cds_wfcq_node_sync_next(struct cds_wfcq_node *node)
*
* Content written into the node before enqueue is guaranteed to be
* consistent, but no other memory ordering is ensured.
*
* Content written into the node before enqueue is guaranteed to be
* consistent, but no other memory ordering is ensured.
- * Should be called with cds_wfcq_dequeue_lock() held.
+ * Dequeue/splice/iteration mutual exclusion should be ensured by the
+ * caller.
*
* Used by for-like iteration macros in urcu/wfqueue.h:
* __cds_wfcq_for_each_blocking()
*
* Used by for-like iteration macros in urcu/wfqueue.h:
* __cds_wfcq_for_each_blocking()
@@
-215,7
+222,8
@@
___cds_wfcq_first_blocking(struct cds_wfcq_head *head,
*
* Content written into the node before enqueue is guaranteed to be
* consistent, but no other memory ordering is ensured.
*
* Content written into the node before enqueue is guaranteed to be
* consistent, but no other memory ordering is ensured.
- * Should be called with cds_wfcq_dequeue_lock() held.
+ * Dequeue/splice/iteration mutual exclusion should be ensured by the
+ * caller.
*
* Used by for-like iteration macros in urcu/wfqueue.h:
* __cds_wfcq_for_each_blocking()
*
* Used by for-like iteration macros in urcu/wfqueue.h:
* __cds_wfcq_for_each_blocking()
@@
-249,15
+257,11
@@
___cds_wfcq_next_blocking(struct cds_wfcq_head *head,
/*
* __cds_wfcq_dequeue_blocking: dequeue a node from the queue.
*
/*
* __cds_wfcq_dequeue_blocking: dequeue a node from the queue.
*
- * No need to go on a waitqueue here, as there is no possible state in which the
- * list could cause dequeue to busy-loop needlessly while waiting for another
- * thread to be scheduled. The queue appears empty until tail->next is set by
- * enqueue.
- *
* Content written into the node before enqueue is guaranteed to be
* consistent, but no other memory ordering is ensured.
* It is valid to reuse and free a dequeued node immediately.
* Content written into the node before enqueue is guaranteed to be
* consistent, but no other memory ordering is ensured.
* It is valid to reuse and free a dequeued node immediately.
- * Should be called with cds_wfcq_dequeue_lock() held.
+ * Dequeue/splice/iteration mutual exclusion should be ensured by the
+ * caller.
*/
static inline struct cds_wfcq_node *
___cds_wfcq_dequeue_blocking(struct cds_wfcq_head *head,
*/
static inline struct cds_wfcq_node *
___cds_wfcq_dequeue_blocking(struct cds_wfcq_head *head,
@@
-306,7
+310,8
@@
___cds_wfcq_dequeue_blocking(struct cds_wfcq_head *head,
*
* Dequeue all nodes from src_q.
* dest_q must be already initialized.
*
* Dequeue all nodes from src_q.
* dest_q must be already initialized.
- * Should be called with cds_wfcq_dequeue_lock() held on src_q.
+ * Dequeue/splice/iteration mutual exclusion for src_q should be ensured
+ * by the caller.
*/
static inline void
___cds_wfcq_splice_blocking(
*/
static inline void
___cds_wfcq_splice_blocking(
@@
-343,7
+348,7
@@
___cds_wfcq_splice_blocking(
*
* Content written into the node before enqueue is guaranteed to be
* consistent, but no other memory ordering is ensured.
*
* Content written into the node before enqueue is guaranteed to be
* consistent, but no other memory ordering is ensured.
- * Mutual exlusion with
(and only with) cds_wfcq_splice_blocking
is
+ * Mutual exlusion with
cds_wfcq_splice_blocking and dequeue lock
is
* ensured.
* It is valid to reuse and free a dequeued node immediately.
*/
* ensured.
* It is valid to reuse and free a dequeued node immediately.
*/
@@
-366,7
+371,7
@@
_cds_wfcq_dequeue_blocking(struct cds_wfcq_head *head,
* dest_q must be already initialized.
* Content written into the node before enqueue is guaranteed to be
* consistent, but no other memory ordering is ensured.
* dest_q must be already initialized.
* Content written into the node before enqueue is guaranteed to be
* consistent, but no other memory ordering is ensured.
- * Mutual exlusion with
(and only with) cds_wfcq_dequeue_blocking
is
+ * Mutual exlusion with
cds_wfcq_dequeue_blocking and dequeue lock
is
* ensured.
*/
static inline void
* ensured.
*/
static inline void
This page took
0.026585 seconds
and
4
git commands to generate.