X-Git-Url: http://git.liburcu.org/?p=userspace-rcu.git;a=blobdiff_plain;f=include%2Furcu%2Fwfqueue.h;fp=include%2Furcu%2Fwfqueue.h;h=2ba86248aa7095c4ca83e94b13769c073507a58c;hp=0000000000000000000000000000000000000000;hb=6893800a4d1cc14dff0395ddcd660a5138db183d;hpb=a59f39055b5ecb77b68cf78b9839aa9e8e4ec332 diff --git a/include/urcu/wfqueue.h b/include/urcu/wfqueue.h new file mode 100644 index 0000000..2ba8624 --- /dev/null +++ b/include/urcu/wfqueue.h @@ -0,0 +1,125 @@ +#ifndef _URCU_WFQUEUE_H +#define _URCU_WFQUEUE_H + +/* + * wfqueue.h + * + * Userspace RCU library - Queue with Wait-Free Enqueue/Blocking Dequeue + * + * Copyright 2010 - Mathieu Desnoyers + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#include +#include +#include + +#ifdef __cplusplus +extern "C" { +#endif + +#ifndef CDS_WFQ_DEPRECATED +#define CDS_WFQ_DEPRECATED \ + CDS_DEPRECATED("urcu/wfqueue.h is deprecated. Please use urcu/wfcqueue.h instead.") +#endif + +/* + * Queue with wait-free enqueue/blocking dequeue. + * This implementation adds a dummy head node when the queue is empty to ensure + * we can always update the queue locklessly. + * + * Inspired from half-wait-free/half-blocking queue implementation done by + * Paul E. McKenney. + */ + +struct cds_wfq_node { + struct cds_wfq_node *next; +}; + +struct cds_wfq_queue { + struct cds_wfq_node *head, **tail; + struct cds_wfq_node dummy; /* Dummy node */ + pthread_mutex_t lock; +}; + +#ifdef _LGPL_SOURCE + +#include + +static inline CDS_WFQ_DEPRECATED +void cds_wfq_node_init(struct cds_wfq_node *node) +{ + _cds_wfq_node_init(node); +} + +static inline CDS_WFQ_DEPRECATED +void cds_wfq_init(struct cds_wfq_queue *q) +{ + _cds_wfq_init(q); +} + +static inline CDS_WFQ_DEPRECATED +void cds_wfq_destroy(struct cds_wfq_queue *q) +{ + _cds_wfq_destroy(q); +} + +static inline CDS_WFQ_DEPRECATED +void cds_wfq_enqueue(struct cds_wfq_queue *q, struct cds_wfq_node *node) +{ + _cds_wfq_enqueue(q, node); +} + +static inline CDS_WFQ_DEPRECATED +struct cds_wfq_node *__cds_wfq_dequeue_blocking(struct cds_wfq_queue *q) +{ + return ___cds_wfq_dequeue_blocking(q); +} + +static inline CDS_WFQ_DEPRECATED +struct cds_wfq_node *cds_wfq_dequeue_blocking(struct cds_wfq_queue *q) +{ + return _cds_wfq_dequeue_blocking(q); +} + +#else /* !_LGPL_SOURCE */ + +extern CDS_WFQ_DEPRECATED +void cds_wfq_node_init(struct cds_wfq_node *node); + +extern CDS_WFQ_DEPRECATED +void cds_wfq_init(struct cds_wfq_queue *q); + +extern CDS_WFQ_DEPRECATED +void cds_wfq_destroy(struct cds_wfq_queue *q); + +extern CDS_WFQ_DEPRECATED +void cds_wfq_enqueue(struct cds_wfq_queue *q, struct cds_wfq_node *node); + +/* __cds_wfq_dequeue_blocking: caller ensures mutual exclusion between dequeues */ +extern CDS_WFQ_DEPRECATED +struct cds_wfq_node *__cds_wfq_dequeue_blocking(struct cds_wfq_queue *q); + +extern CDS_WFQ_DEPRECATED +struct cds_wfq_node *cds_wfq_dequeue_blocking(struct cds_wfq_queue *q); + +#endif /* !_LGPL_SOURCE */ + +#ifdef __cplusplus +} +#endif + +#endif /* _URCU_WFQUEUE_H */