From: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
Date: Wed, 8 Sep 2021 19:26:59 +0000 (-0400)
Subject: wfcqueue: implement C++ API based on function overloading
X-Git-Tag: v0.14.0~61
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=0cdbb569aa571e738df8f4280e47ab0aadad576a;p=urcu.git

wfcqueue: implement C++ API based on function overloading

Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
Change-Id: I8dbd00e9f2c74e9ee914906afa3e6fdece14fc27
---

diff --git a/include/urcu/wfcqueue.h b/include/urcu/wfcqueue.h
index 407c0db..a539d92 100644
--- a/include/urcu/wfcqueue.h
+++ b/include/urcu/wfcqueue.h
@@ -73,17 +73,20 @@ struct cds_wfcq_head {
 	pthread_mutex_t lock;
 };
 
-#ifndef __cplusplus
 /*
- * The transparent union allows calling functions that work on both
+ * In C, the transparent union allows calling functions that work on both
  * struct cds_wfcq_head and struct __cds_wfcq_head on any of those two
  * types.
+ *
+ * In C++, implement static inline wrappers using function overloading
+ * to obtain an API similar to C.
  */
 typedef union {
 	struct __cds_wfcq_head *_h;
 	struct cds_wfcq_head *h;
-} __attribute__((__transparent_union__)) cds_wfcq_head_ptr_t;
+} caa_c_transparent_union cds_wfcq_head_ptr_t;
 
+#ifndef __cplusplus
 /*
  * This static inline is only present for compatibility with C++. It is
  * effect-less in C.
@@ -103,19 +106,20 @@ static inline struct cds_wfcq_head *cds_wfcq_head_cast(struct cds_wfcq_head *hea
 }
 #else /* #ifndef __cplusplus */
 
-/* C++ ignores transparent union. */
-typedef union {
-	struct __cds_wfcq_head *_h;
-	struct cds_wfcq_head *h;
-} cds_wfcq_head_ptr_t;
-
-/* C++ ignores transparent union. Requires an explicit conversion. */
+/*
+ * This static inline is used by C++ function overloading. It is also
+ * used internally in the static inline implementation of the API.
+ */
 static inline cds_wfcq_head_ptr_t __cds_wfcq_head_cast(struct __cds_wfcq_head *head)
 {
 	cds_wfcq_head_ptr_t ret = { ._h = head };
 	return ret;
 }
-/* C++ ignores transparent union. Requires an explicit conversion. */
+
+/*
+ * This static inline is used by C++ function overloading. It is also
+ * used internally in the static inline implementation of the API.
+ */
 static inline cds_wfcq_head_ptr_t cds_wfcq_head_cast(struct cds_wfcq_head *head)
 {
 	cds_wfcq_head_ptr_t ret = { .h = head };
@@ -482,6 +486,260 @@ extern struct cds_wfcq_node *__cds_wfcq_next_nonblocking(
 
 #ifdef __cplusplus
 }
+
+/*
+ * In C++, implement static inline wrappers using function overloading
+ * to obtain an API similar to C.
+ */
+
+static inline bool cds_wfcq_empty(struct __cds_wfcq_head *head,
+		struct cds_wfcq_tail *tail)
+{
+	return cds_wfcq_empty(__cds_wfcq_head_cast(head), tail);
+}
+
+static inline bool cds_wfcq_empty(struct cds_wfcq_head *head,
+		struct cds_wfcq_tail *tail)
+{
+	return cds_wfcq_empty(cds_wfcq_head_cast(head), tail);
+}
+
+static inline bool cds_wfcq_enqueue(struct __cds_wfcq_head *head,
+		struct cds_wfcq_tail *tail,
+		struct cds_wfcq_node *node)
+{
+	return cds_wfcq_enqueue(__cds_wfcq_head_cast(head), tail, node);
+}
+
+static inline bool cds_wfcq_enqueue(struct cds_wfcq_head *head,
+		struct cds_wfcq_tail *tail,
+		struct cds_wfcq_node *node)
+{
+	return cds_wfcq_enqueue(cds_wfcq_head_cast(head), tail, node);
+}
+
+static inline struct cds_wfcq_node *__cds_wfcq_dequeue_blocking(
+		struct __cds_wfcq_head *head,
+		struct cds_wfcq_tail *tail)
+{
+	return __cds_wfcq_dequeue_blocking(__cds_wfcq_head_cast(head), tail);
+}
+
+static inline struct cds_wfcq_node *__cds_wfcq_dequeue_blocking(
+		struct cds_wfcq_head *head,
+		struct cds_wfcq_tail *tail)
+{
+	return __cds_wfcq_dequeue_blocking(cds_wfcq_head_cast(head), tail);
+}
+
+static inline struct cds_wfcq_node *__cds_wfcq_dequeue_with_state_blocking(
+		struct __cds_wfcq_head *head,
+		struct cds_wfcq_tail *tail,
+		int *state)
+{
+	return __cds_wfcq_dequeue_with_state_blocking(__cds_wfcq_head_cast(head),
+			tail, state);
+}
+
+static inline struct cds_wfcq_node *__cds_wfcq_dequeue_with_state_blocking(
+		struct cds_wfcq_head *head,
+		struct cds_wfcq_tail *tail,
+		int *state)
+{
+	return __cds_wfcq_dequeue_with_state_blocking(cds_wfcq_head_cast(head),
+			tail, state);
+}
+
+static inline struct cds_wfcq_node *__cds_wfcq_dequeue_nonblocking(
+		struct __cds_wfcq_head *head,
+		struct cds_wfcq_tail *tail)
+{
+	return __cds_wfcq_dequeue_nonblocking(__cds_wfcq_head_cast(head), tail);
+}
+
+static inline struct cds_wfcq_node *__cds_wfcq_dequeue_nonblocking(
+		struct cds_wfcq_head *head,
+		struct cds_wfcq_tail *tail)
+{
+	return __cds_wfcq_dequeue_nonblocking(cds_wfcq_head_cast(head), tail);
+}
+
+static inline struct cds_wfcq_node *__cds_wfcq_dequeue_with_state_nonblocking(
+		struct __cds_wfcq_head *head,
+		struct cds_wfcq_tail *tail,
+		int *state)
+{
+	return __cds_wfcq_dequeue_with_state_nonblocking(__cds_wfcq_head_cast(head),
+			tail, state);
+}
+
+static inline struct cds_wfcq_node *__cds_wfcq_dequeue_with_state_nonblocking(
+		struct cds_wfcq_head *head,
+		struct cds_wfcq_tail *tail,
+		int *state)
+{
+	return __cds_wfcq_dequeue_with_state_nonblocking(cds_wfcq_head_cast(head),
+			tail, state);
+}
+
+/* Support the power set of type combinations. */
+static inline enum cds_wfcq_ret __cds_wfcq_splice_blocking(
+		struct __cds_wfcq_head *dest_q_head,
+		struct cds_wfcq_tail *dest_q_tail,
+		struct __cds_wfcq_head *src_q_head,
+		struct cds_wfcq_tail *src_q_tail)
+{
+	return __cds_wfcq_splice_blocking(__cds_wfcq_head_cast(dest_q_head),
+			dest_q_tail,
+			__cds_wfcq_head_cast(src_q_head),
+			src_q_tail);
+}
+
+static inline enum cds_wfcq_ret __cds_wfcq_splice_blocking(
+		struct cds_wfcq_head *dest_q_head,
+		struct cds_wfcq_tail *dest_q_tail,
+		struct __cds_wfcq_head *src_q_head,
+		struct cds_wfcq_tail *src_q_tail)
+{
+	return __cds_wfcq_splice_blocking(cds_wfcq_head_cast(dest_q_head),
+			dest_q_tail,
+			__cds_wfcq_head_cast(src_q_head),
+			src_q_tail);
+}
+
+static inline enum cds_wfcq_ret __cds_wfcq_splice_blocking(
+		struct __cds_wfcq_head *dest_q_head,
+		struct cds_wfcq_tail *dest_q_tail,
+		struct cds_wfcq_head *src_q_head,
+		struct cds_wfcq_tail *src_q_tail)
+{
+	return __cds_wfcq_splice_blocking(__cds_wfcq_head_cast(dest_q_head),
+			dest_q_tail,
+			cds_wfcq_head_cast(src_q_head),
+			src_q_tail);
+}
+
+static inline enum cds_wfcq_ret __cds_wfcq_splice_blocking(
+		struct cds_wfcq_head *dest_q_head,
+		struct cds_wfcq_tail *dest_q_tail,
+		struct cds_wfcq_head *src_q_head,
+		struct cds_wfcq_tail *src_q_tail)
+{
+	return __cds_wfcq_splice_blocking(cds_wfcq_head_cast(dest_q_head),
+			dest_q_tail,
+			cds_wfcq_head_cast(src_q_head),
+			src_q_tail);
+}
+
+/* Support the power set of type combinations. */
+static inline enum cds_wfcq_ret __cds_wfcq_splice_nonblocking(
+		struct __cds_wfcq_head *dest_q_head,
+		struct cds_wfcq_tail *dest_q_tail,
+		struct __cds_wfcq_head *src_q_head,
+		struct cds_wfcq_tail *src_q_tail)
+{
+	return __cds_wfcq_splice_nonblocking(__cds_wfcq_head_cast(dest_q_head),
+			dest_q_tail,
+			__cds_wfcq_head_cast(src_q_head),
+			src_q_tail);
+}
+
+static inline enum cds_wfcq_ret __cds_wfcq_splice_nonblocking(
+		struct cds_wfcq_head *dest_q_head,
+		struct cds_wfcq_tail *dest_q_tail,
+		struct __cds_wfcq_head *src_q_head,
+		struct cds_wfcq_tail *src_q_tail)
+{
+	return __cds_wfcq_splice_nonblocking(cds_wfcq_head_cast(dest_q_head),
+			dest_q_tail,
+			__cds_wfcq_head_cast(src_q_head),
+			src_q_tail);
+}
+
+static inline enum cds_wfcq_ret __cds_wfcq_splice_nonblocking(
+		struct __cds_wfcq_head *dest_q_head,
+		struct cds_wfcq_tail *dest_q_tail,
+		struct cds_wfcq_head *src_q_head,
+		struct cds_wfcq_tail *src_q_tail)
+{
+	return __cds_wfcq_splice_nonblocking(__cds_wfcq_head_cast(dest_q_head),
+			dest_q_tail,
+			cds_wfcq_head_cast(src_q_head),
+			src_q_tail);
+}
+
+static inline enum cds_wfcq_ret __cds_wfcq_splice_nonblocking(
+		struct cds_wfcq_head *dest_q_head,
+		struct cds_wfcq_tail *dest_q_tail,
+		struct cds_wfcq_head *src_q_head,
+		struct cds_wfcq_tail *src_q_tail)
+{
+	return __cds_wfcq_splice_nonblocking(cds_wfcq_head_cast(dest_q_head),
+			dest_q_tail,
+			cds_wfcq_head_cast(src_q_head),
+			src_q_tail);
+}
+
+static inline struct cds_wfcq_node *__cds_wfcq_first_blocking(
+		struct __cds_wfcq_head *head,
+		struct cds_wfcq_tail *tail)
+{
+	return __cds_wfcq_first_blocking(__cds_wfcq_head_cast(head), tail);
+}
+
+static inline struct cds_wfcq_node *__cds_wfcq_first_blocking(
+		struct cds_wfcq_head *head,
+		struct cds_wfcq_tail *tail)
+{
+	return __cds_wfcq_first_blocking(cds_wfcq_head_cast(head), tail);
+}
+
+static inline struct cds_wfcq_node *__cds_wfcq_first_nonblocking(
+		struct __cds_wfcq_head *head,
+		struct cds_wfcq_tail *tail)
+{
+	return __cds_wfcq_first_nonblocking(__cds_wfcq_head_cast(head), tail);
+}
+
+static inline struct cds_wfcq_node *__cds_wfcq_first_nonblocking(
+		struct cds_wfcq_head *head,
+		struct cds_wfcq_tail *tail)
+{
+	return __cds_wfcq_first_nonblocking(cds_wfcq_head_cast(head), tail);
+}
+
+static inline struct cds_wfcq_node *__cds_wfcq_next_blocking(
+		struct __cds_wfcq_head *head,
+		struct cds_wfcq_tail *tail,
+		struct cds_wfcq_node *node)
+{
+	return __cds_wfcq_next_blocking(__cds_wfcq_head_cast(head), tail, node);
+}
+
+static inline struct cds_wfcq_node *__cds_wfcq_next_blocking(
+		struct cds_wfcq_head *head,
+		struct cds_wfcq_tail *tail,
+		struct cds_wfcq_node *node)
+{
+	return __cds_wfcq_next_blocking(cds_wfcq_head_cast(head), tail, node);
+}
+
+static inline struct cds_wfcq_node *__cds_wfcq_next_nonblocking(
+		struct __cds_wfcq_head *head,
+		struct cds_wfcq_tail *tail,
+		struct cds_wfcq_node *node)
+{
+	return __cds_wfcq_next_nonblocking(__cds_wfcq_head_cast(head), tail, node);
+}
+
+static inline struct cds_wfcq_node *__cds_wfcq_next_nonblocking(
+		struct cds_wfcq_head *head,
+		struct cds_wfcq_tail *tail,
+		struct cds_wfcq_node *node)
+{
+	return __cds_wfcq_next_nonblocking(cds_wfcq_head_cast(head), tail, node);
+}
+
 #endif
 
 #endif /* _URCU_WFCQUEUE_H */