From: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
Date: Fri, 21 Jun 2013 18:53:52 +0000 (-0400)
Subject: doc/examples: cds_wfcq_enqueue
X-Git-Tag: v0.8.0~51
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=483370758193a1d58f4668c3d53ae2b5fe1e66c3;p=userspace-rcu.git

doc/examples: cds_wfcq_enqueue

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

diff --git a/.gitignore b/.gitignore
index 9c4597d..24186f0 100644
--- a/.gitignore
+++ b/.gitignore
@@ -80,6 +80,8 @@ doc/examples/list/cds_list_for_each_rcu
 doc/examples/list/cds_list_for_each_entry_rcu
 doc/examples/list/cds_list_replace_rcu
 
+doc/examples/wfcqueue/cds_wfcq_enqueue
+
 #automake
 /config.h
 .deps/
diff --git a/doc/examples/Makefile.am b/doc/examples/Makefile.am
index af03be8..e117f97 100644
--- a/doc/examples/Makefile.am
+++ b/doc/examples/Makefile.am
@@ -26,11 +26,17 @@ dist_doc_examples_list_DATA = \
 	list/cds_list_for_each_entry_rcu.c \
 	list/cds_list_replace_rcu.c
 
+doc_examples_wfcqueuedir = ${doc_examplesdir}/wfcqueue
+
+dist_doc_examples_wfcqueue_DATA = \
+	wfcqueue/Makefile.cds_wfcq_enqueue \
+	wfcqueue/cds_wfcq_enqueue.c
+
 if NO_SHARED
 # Don't build examples if shared libraries support was explicitly
 # disabled.
 else
-SUBDIRS_PROXY = qsbr-minimal list
+SUBDIRS_PROXY = qsbr-minimal list wfcqueue
 
 all-local:
 	for subdir in $(SUBDIRS_PROXY); do \
diff --git a/doc/examples/Makefile.examples.template b/doc/examples/Makefile.examples.template
index cb0275d..4d26cb0 100644
--- a/doc/examples/Makefile.examples.template
+++ b/doc/examples/Makefile.examples.template
@@ -12,7 +12,6 @@
 # This makefile is purposefully kept simple to support GNU and BSD make.
 
 CC = gcc
-LIBS = -lurcu
 CFLAGS = -g -O2 -Wall
 
 all: $(BINARY)
diff --git a/doc/examples/wfcqueue/Makefile.cds_wfcq_enqueue b/doc/examples/wfcqueue/Makefile.cds_wfcq_enqueue
new file mode 100644
index 0000000..37ed353
--- /dev/null
+++ b/doc/examples/wfcqueue/Makefile.cds_wfcq_enqueue
@@ -0,0 +1,21 @@
+# Copyright (C) 2013  Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+#
+# THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
+# OR IMPLIED.  ANY USE IS AT YOUR OWN RISK.
+#
+# Permission is hereby granted to use or copy this program for any
+# purpose,  provided the above notices are retained on all copies.
+# Permission to modify the code and to distribute modified code is
+# granted, provided the above notices are retained, and a notice that
+# the code was modified is included with the above copyright notice.
+#
+# This makefile is purposefully kept simple to support GNU and BSD make.
+
+EXAMPLE_NAME = cds_wfcq_enqueue
+
+SOURCES = $(EXAMPLE_NAME).c
+OBJECTS = $(EXAMPLE_NAME).o
+BINARY = $(EXAMPLE_NAME)
+LIBS = -lurcu-cds
+
+include ../Makefile.examples.template
diff --git a/doc/examples/wfcqueue/cds_wfcq_enqueue.c b/doc/examples/wfcqueue/cds_wfcq_enqueue.c
new file mode 100644
index 0000000..b5dc147
--- /dev/null
+++ b/doc/examples/wfcqueue/cds_wfcq_enqueue.c
@@ -0,0 +1,72 @@
+/*
+ * Copyright (C) 2013  Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+ *
+ * THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
+ * OR IMPLIED.  ANY USE IS AT YOUR OWN RISK.
+ *
+ * Permission is hereby granted to use or copy this program for any
+ * purpose,  provided the above notices are retained on all copies.
+ * Permission to modify the code and to distribute modified code is
+ * granted, provided the above notices are retained, and a notice that
+ * the code was modified is included with the above copyright notice.
+ *
+ * This example shows how to enqueue nodes into a wfcqueue.
+ */
+
+#include <stdio.h>
+#include <stdlib.h>
+
+#include <urcu/wfcqueue.h>	/* Wait-free concurrent queue */
+#include <urcu/compiler.h>	/* For CAA_ARRAY_SIZE */
+
+/*
+ * Nodes populated into the queue.
+ */
+struct mynode {
+	int value;			/* Node content */
+	struct cds_wfcq_node node;	/* Chaining in queue */
+};
+
+int main(int argc, char **argv)
+{
+	int values[] = { -5, 42, 36, 24, };
+	struct cds_wfcq_head myqueue_head;	/* Queue head */
+	struct cds_wfcq_tail myqueue_tail;	/* Queue tail */
+	unsigned int i;
+	int ret = 0;
+	struct cds_wfcq_node *qnode;
+
+	cds_wfcq_init(&myqueue_head, &myqueue_tail);
+
+	/*
+	 * Adding nodes to the linked-list. Safe against concurrent
+	 * RCU traversals, require mutual exclusion with list updates.
+	 */
+	for (i = 0; i < CAA_ARRAY_SIZE(values); i++) {
+		struct mynode *node;
+
+		node = malloc(sizeof(*node));
+		if (!node) {
+			ret = -1;
+			goto end;
+		}
+
+		cds_wfcq_node_init(&node->node);
+		node->value = values[i];
+		cds_wfcq_enqueue(&myqueue_head, &myqueue_tail,
+				&node->node);
+	}
+
+	/*
+	 * Show the queue content.
+	 */
+	printf("myqueue content:");
+	__cds_wfcq_for_each_blocking(&myqueue_head, &myqueue_tail, qnode) {
+		struct mynode *node =
+			caa_container_of(qnode, struct mynode, node);
+		printf(" %d", node->value);
+	}
+	printf("\n");
+end:
+	return ret;
+}