Remove runtime dependency on liburcu shared objects

[deliverable/lttng-ust.git] / include / lttng / urcu / urcu-ust.h

diff --git a/include/lttng/urcu/urcu-ust.h b/include/lttng/urcu/urcu-ust.h
new file mode 100644 (file)
index 0000000..421e0cc
--- /dev/null
+++ b/include/lttng/urcu/urcu-ust.h
@@ -0,0 +1,105 @@
+#ifndef _LTTNG_UST_URCU_H
+#define _LTTNG_UST_URCU_H
+
+/*
+ * urcu-ust.h
+ *
+ * Userspace RCU header for LTTng-UST. Derived from liburcu
+ * "bulletproof" flavor.
+ *
+ * Slower RCU read-side adapted for tracing library. Does not require thread
+ * registration nor unregistration. Also signal-safe.
+ *
+ * Copyright (c) 2009 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+ * Copyright (c) 2009 Paul E. McKenney, IBM Corporation.
+ *
+ * LGPL-compatible code should include this header with :
+ *
+ * #define _LGPL_SOURCE
+ * #include <lttng/urcu-ust.h>
+ *
+ * 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
+ *
+ * IBM's contributions to this file may be relicensed under LGPLv2 or later.
+ */
+
+#include <stdlib.h>
+#include <pthread.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/*
+ * See lttng/urcu/pointer.h and lttng/urcu/static/pointer.h for pointer
+ * publication headers.
+ */
+#include <lttng/urcu/pointer.h>
+
+#ifdef _LGPL_SOURCE
+
+#include <lttng/urcu/static/urcu-ust.h>
+
+/*
+ * Mappings for static use of the userspace RCU library.
+ * Should only be used in LGPL-compatible code.
+ */
+
+/*
+ * lttng_ust_urcu_read_lock()
+ * lttng_ust_urcu_read_unlock()
+ *
+ * Mark the beginning and end of a read-side critical section.
+ */
+#define lttng_ust_urcu_read_lock       _lttng_ust_urcu_read_lock
+#define lttng_ust_urcu_read_unlock     _lttng_ust_urcu_read_unlock
+#define lttng_ust_urcu_read_ongoing    _lttng_ust_urcu_read_ongoing
+
+#else /* !_LGPL_SOURCE */
+
+/*
+ * library wrappers to be used by non-LGPL compatible source code.
+ * See LGPL-only urcu/static/pointer.h for documentation.
+ */
+
+extern void lttng_ust_urcu_read_lock(void);
+extern void lttng_ust_urcu_read_unlock(void);
+extern int lttng_ust_urcu_read_ongoing(void);
+
+#endif /* !_LGPL_SOURCE */
+
+extern void lttng_ust_urcu_synchronize_rcu(void);
+
+/*
+ * lttng_ust_urcu_before_fork, lttng_ust_urcu_after_fork_parent and
+ * lttng_ust_urcu_after_fork_child should be called around fork() system
+ * calls when the child process is not expected to immediately perform
+ * an exec(). For pthread users, see pthread_atfork(3).
+ */
+extern void lttng_ust_urcu_before_fork(void);
+extern void lttng_ust_urcu_after_fork_parent(void);
+extern void lttng_ust_urcu_after_fork_child(void);
+
+/*
+ * In the UST version, thread registration is performed lazily, but it can be
+ * forced by issuing an explicit lttng_ust_urcu_register_thread().
+ */
+extern void lttng_ust_urcu_register_thread(void);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* _LTTNG_UST_URCU_H */