From: Mathieu Desnoyers Date: Sun, 23 Jun 2013 15:31:33 +0000 (-0400) Subject: doc/examples: add rculfqueue example X-Git-Tag: v0.8.0~19 X-Git-Url: http://git.liburcu.org/?p=urcu.git;a=commitdiff_plain;h=d4b7140809acb8a9429fa97a4620c96674bd0c3c doc/examples: add rculfqueue example Signed-off-by: Mathieu Desnoyers --- diff --git a/.gitignore b/.gitignore index 86ad0c2..47046ed 100644 --- a/.gitignore +++ b/.gitignore @@ -95,6 +95,9 @@ doc/examples/wfcqueue/cds_wfcq_enqueue doc/examples/wfcqueue/cds_wfcq_dequeue doc/examples/wfcqueue/cds_wfcq_splice +doc/examples/rculfqueue/cds_lfq_enqueue +doc/examples/rculfqueue/cds_lfq_dequeue + doc/examples/wfstack/cds_wfs_push doc/examples/wfstack/cds_wfs_pop doc/examples/wfstack/cds_wfs_pop_all_blocking diff --git a/doc/examples/Makefile.am b/doc/examples/Makefile.am index 00ac7e9..40c211a 100644 --- a/doc/examples/Makefile.am +++ b/doc/examples/Makefile.am @@ -82,6 +82,15 @@ dist_doc_examples_lfstack_DATA = \ lfstack/cds_lfs_pop_blocking.c \ lfstack/cds_lfs_pop_all_blocking.c +doc_examples_rculfqueuedir = ${doc_examplesdir}/rculfqueue + +dist_doc_examples_rculfqueue_DATA = \ + rculfqueue/Makefile \ + rculfqueue/Makefile.cds_lfq_enqueue \ + rculfqueue/Makefile.cds_lfq_dequeue \ + rculfqueue/cds_lfq_enqueue.c \ + rculfqueue/cds_lfq_dequeue.c + if NO_SHARED # Don't build examples if shared libraries support was explicitly # disabled. diff --git a/doc/examples/dist-files/Makefile b/doc/examples/dist-files/Makefile index e975023..4006613 100644 --- a/doc/examples/dist-files/Makefile +++ b/doc/examples/dist-files/Makefile @@ -13,17 +13,19 @@ all: $(MAKE) -C hlist - $(MAKE) -C lfstack $(MAKE) -C list $(MAKE) -C urcu-flavors $(MAKE) -C wfcqueue + $(MAKE) -C rculfqueue $(MAKE) -C wfstack + $(MAKE) -C lfstack .PHONY: clean clean: $(MAKE) -C hlist clean - $(MAKE) -C lfstack clean $(MAKE) -C list clean $(MAKE) -C urcu-flavors clean $(MAKE) -C wfcqueue clean + $(MAKE) -C rculfqueue clean $(MAKE) -C wfstack clean + $(MAKE) -C lfstack clean diff --git a/doc/examples/rculfqueue/Makefile b/doc/examples/rculfqueue/Makefile new file mode 100644 index 0000000..5538709 --- /dev/null +++ b/doc/examples/rculfqueue/Makefile @@ -0,0 +1,21 @@ +# Copyright (C) 2013 Mathieu Desnoyers +# +# 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. + +all: + $(MAKE) -f Makefile.cds_lfq_enqueue + $(MAKE) -f Makefile.cds_lfq_dequeue + +.PHONY: clean +clean: + $(MAKE) -f Makefile.cds_lfq_enqueue clean + $(MAKE) -f Makefile.cds_lfq_dequeue clean diff --git a/doc/examples/rculfqueue/Makefile.cds_lfq_dequeue b/doc/examples/rculfqueue/Makefile.cds_lfq_dequeue new file mode 100644 index 0000000..c083873 --- /dev/null +++ b/doc/examples/rculfqueue/Makefile.cds_lfq_dequeue @@ -0,0 +1,21 @@ +# Copyright (C) 2013 Mathieu Desnoyers +# +# 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_lfq_dequeue + +SOURCES = $(EXAMPLE_NAME).c +OBJECTS = $(EXAMPLE_NAME).o +BINARY = $(EXAMPLE_NAME) +LIBS = -lurcu-cds -lurcu + +include ../Makefile.examples.template diff --git a/doc/examples/rculfqueue/Makefile.cds_lfq_enqueue b/doc/examples/rculfqueue/Makefile.cds_lfq_enqueue new file mode 100644 index 0000000..b8f1ff5 --- /dev/null +++ b/doc/examples/rculfqueue/Makefile.cds_lfq_enqueue @@ -0,0 +1,21 @@ +# Copyright (C) 2013 Mathieu Desnoyers +# +# 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_lfq_enqueue + +SOURCES = $(EXAMPLE_NAME).c +OBJECTS = $(EXAMPLE_NAME).o +BINARY = $(EXAMPLE_NAME) +LIBS = -lurcu-cds -lurcu + +include ../Makefile.examples.template diff --git a/doc/examples/rculfqueue/cds_lfq_dequeue.c b/doc/examples/rculfqueue/cds_lfq_dequeue.c new file mode 100644 index 0000000..d1375c8 --- /dev/null +++ b/doc/examples/rculfqueue/cds_lfq_dequeue.c @@ -0,0 +1,115 @@ +/* + * Copyright (C) 2013 Mathieu Desnoyers + * + * 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 dequeue nodes from a RCU lock-free queue. + * This queue requires using a RCU scheme. + */ + +#include +#include + +#include /* RCU flavor */ +#include /* RCU Lock-free queue */ +#include /* For CAA_ARRAY_SIZE */ + +/* + * Nodes populated into the queue. + */ +struct mynode { + int value; /* Node content */ + struct cds_lfq_node_rcu node; /* Chaining in queue */ + struct rcu_head rcu_head; /* For call_rcu() */ +}; + +static +void free_node(struct rcu_head *head) +{ + struct mynode *node = + caa_container_of(head, struct mynode, rcu_head); + + free(node); +} + +int main(int argc, char **argv) +{ + int values[] = { -5, 42, 36, 24, }; + struct cds_lfq_queue_rcu myqueue; /* Queue */ + unsigned int i; + int ret = 0; + + /* + * Each thread need using RCU read-side need to be explicitly + * registered. + */ + rcu_register_thread(); + + cds_lfq_init_rcu(&myqueue, call_rcu); + + /* + * Enqueue nodes. + */ + for (i = 0; i < CAA_ARRAY_SIZE(values); i++) { + struct mynode *node; + + node = malloc(sizeof(*node)); + if (!node) { + ret = -1; + goto end; + } + + cds_lfq_node_init_rcu(&node->node); + node->value = values[i]; + /* + * Both enqueue and dequeue need to be called within RCU + * read-side critical section. + */ + rcu_read_lock(); + cds_lfq_enqueue_rcu(&myqueue, &node->node); + rcu_read_unlock(); + } + + /* + * Dequeue each node from the queue. Those will be dequeued from + * the oldest (first enqueued) to the newest (last enqueued). + */ + printf("dequeued content:"); + for (;;) { + struct cds_lfq_node_rcu *qnode; + struct mynode *node; + + /* + * Both enqueue and dequeue need to be called within RCU + * read-side critical section. + */ + rcu_read_lock(); + qnode = cds_lfq_dequeue_rcu(&myqueue); + rcu_read_unlock(); + if (!qnode) { + break; /* Queue is empty. */ + } + /* Getting the container structure from the node */ + node = caa_container_of(qnode, struct mynode, node); + printf(" %d", node->value); + call_rcu(&node->rcu_head, free_node); + } + printf("\n"); + /* + * Release memory used by the queue. + */ + ret = cds_lfq_destroy_rcu(&myqueue); + if (ret) { + printf("Error destroying queue (non-empty)\n"); + } +end: + rcu_unregister_thread(); + return ret; +} diff --git a/doc/examples/rculfqueue/cds_lfq_enqueue.c b/doc/examples/rculfqueue/cds_lfq_enqueue.c new file mode 100644 index 0000000..a8c6f86 --- /dev/null +++ b/doc/examples/rculfqueue/cds_lfq_enqueue.c @@ -0,0 +1,73 @@ +/* + * Copyright (C) 2013 Mathieu Desnoyers + * + * 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 RCU lock-free queue. + * This queue requires using a RCU scheme. + */ + +#include +#include + +#include /* RCU flavor */ +#include /* RCU Lock-free queue */ +#include /* For CAA_ARRAY_SIZE */ + +/* + * Nodes populated into the queue. + */ +struct mynode { + int value; /* Node content */ + struct cds_lfq_node_rcu node; /* Chaining in queue */ +}; + +int main(int argc, char **argv) +{ + int values[] = { -5, 42, 36, 24, }; + struct cds_lfq_queue_rcu myqueue; /* Queue */ + unsigned int i; + int ret = 0; + + /* + * Each thread need using RCU read-side need to be explicitly + * registered. + */ + rcu_register_thread(); + + cds_lfq_init_rcu(&myqueue, call_rcu); + + /* + * Enqueue nodes. + */ + for (i = 0; i < CAA_ARRAY_SIZE(values); i++) { + struct mynode *node; + + node = malloc(sizeof(*node)); + if (!node) { + ret = -1; + goto end; + } + + cds_lfq_node_init_rcu(&node->node); + node->value = values[i]; + /* + * Both enqueue and dequeue need to be called within RCU + * read-side critical section. + */ + rcu_read_lock(); + cds_lfq_enqueue_rcu(&myqueue, &node->node); + rcu_read_unlock(); + } + +end: + rcu_unregister_thread(); + return ret; +}