X-Git-Url: http://git.liburcu.org/?a=blobdiff_plain;f=src%2Fworkqueue.h;fp=src%2Fworkqueue.h;h=52b69731003ad322f7272a7d52c41d2325070373;hb=ccacf27fd8d1af069016d7cf3a91f8995af08b8c;hp=0000000000000000000000000000000000000000;hpb=2748bd6c7b5732f79cea82eba175b91a35d6833f;p=urcu.git

diff --git a/src/workqueue.h b/src/workqueue.h
new file mode 100644
index 0000000..52b6973
--- /dev/null
+++ b/src/workqueue.h
@@ -0,0 +1,104 @@
+#ifndef _URCU_WORKQUEUE_H
+#define _URCU_WORKQUEUE_H
+
+/*
+ * workqueue.h
+ *
+ * Userspace RCU header - Userspace workqueues
+ *
+ * Copyright (c) 2009,2017 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+ * Copyright (c) 2009 Paul E. McKenney, IBM Corporation.
+ *
+ * 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 <stdlib.h>
+#include <pthread.h>
+
+#include <urcu/wfcqueue.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/* Note that struct urcu_workqueue is opaque to callers. */
+
+struct urcu_workqueue;
+struct urcu_workqueue_completion;
+
+/* Flag values. */
+
+#define URCU_WORKQUEUE_RT	(1U << 0)
+#define URCU_WORKQUEUE_STOP	(1U << 1)
+#define URCU_WORKQUEUE_PAUSE	(1U << 2)
+#define URCU_WORKQUEUE_PAUSED	(1U << 3)
+
+/*
+ * The urcu_work data structure is placed in the structure to be acted
+ * upon via urcu_workqueue_queue_work().
+ */
+
+struct urcu_work {
+	struct cds_wfcq_node next;
+	void (*func)(struct urcu_work *head);
+};
+
+/*
+ * Exported functions
+ */
+
+struct urcu_workqueue *urcu_workqueue_create(unsigned long flags,
+		int cpu_affinity, void *priv,
+		void (*grace_period_fct)(struct urcu_workqueue *workqueue, void *priv),
+		void (*initialize_worker_fct)(struct urcu_workqueue *workqueue, void *priv),
+		void (*finalize_worker_fct)(struct urcu_workqueue *workqueue, void *priv),
+		void (*worker_before_wait_fct)(struct urcu_workqueue *workqueue, void *priv),
+		void (*worker_after_wake_up_fct)(struct urcu_workqueue *workqueue, void *priv),
+		void (*worker_before_pause_fct)(struct urcu_workqueue *workqueue, void *priv),
+		void (*worker_after_resume_fct)(struct urcu_workqueue *workqueue, void *priv));
+void urcu_workqueue_destroy(struct urcu_workqueue *workqueue);
+
+/*
+ * Never fails. Should not be used to enqueue work from worker threads
+ * after the application invokes urcu_workqueue_free.
+ */
+void urcu_workqueue_queue_work(struct urcu_workqueue *workqueue,
+		struct urcu_work *work,
+		void (*func)(struct urcu_work *work));
+
+struct urcu_workqueue_completion *urcu_workqueue_create_completion(void);
+void urcu_workqueue_destroy_completion(struct urcu_workqueue_completion *completion);
+
+void urcu_workqueue_queue_completion(struct urcu_workqueue *workqueue,
+		struct urcu_workqueue_completion *completion);
+void urcu_workqueue_wait_completion(struct urcu_workqueue_completion *completion);
+
+void urcu_workqueue_flush_queued_work(struct urcu_workqueue *workqueue);
+
+/*
+ * pause/resume/create worker threads. Can be used to pause worker
+ * threads across fork/clone while keeping the workqueue in place.
+ * Pause is used in parent pre-fork, resume in parent post-fork, create
+ * in child after-fork.
+ */
+void urcu_workqueue_pause_worker(struct urcu_workqueue *workqueue);
+void urcu_workqueue_resume_worker(struct urcu_workqueue *workqueue);
+void urcu_workqueue_create_worker(struct urcu_workqueue *workqueue);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* _URCU_WORKQUEUE_H */