X-Git-Url: http://git.liburcu.org/?p=userspace-rcu.git;a=blobdiff_plain;f=src%2Furcu-call-rcu.h;fp=src%2Furcu-call-rcu.h;h=339ebacc3f7c013975d62370ca27aa47b282e724;hp=0000000000000000000000000000000000000000;hb=6893800a4d1cc14dff0395ddcd660a5138db183d;hpb=a59f39055b5ecb77b68cf78b9839aa9e8e4ec332 diff --git a/src/urcu-call-rcu.h b/src/urcu-call-rcu.h new file mode 100644 index 0000000..339ebac --- /dev/null +++ b/src/urcu-call-rcu.h @@ -0,0 +1,101 @@ +#ifndef _URCU_CALL_RCU_H +#define _URCU_CALL_RCU_H + +/* + * urcu-call-rcu.h + * + * Userspace RCU header - deferred execution + * + * Copyright (c) 2009 Mathieu Desnoyers + * Copyright (c) 2009 Paul E. McKenney, IBM Corporation. + * + * LGPL-compatible code should include this header with : + * + * #define _LGPL_SOURCE + * #include + * + * 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 +#include + +#include + +#ifdef __cplusplus +extern "C" { +#endif + +/* Note that struct call_rcu_data is opaque to callers. */ + +struct call_rcu_data; + +/* Flag values. */ + +#define URCU_CALL_RCU_RT (1U << 0) +#define URCU_CALL_RCU_RUNNING (1U << 1) +#define URCU_CALL_RCU_STOP (1U << 2) +#define URCU_CALL_RCU_STOPPED (1U << 3) +#define URCU_CALL_RCU_PAUSE (1U << 4) +#define URCU_CALL_RCU_PAUSED (1U << 5) + +/* + * The rcu_head data structure is placed in the structure to be freed + * via call_rcu(). + */ + +struct rcu_head { + struct cds_wfcq_node next; + void (*func)(struct rcu_head *head); +}; + +/* + * Exported functions + * + * Important: see rcu-api.md in userspace-rcu documentation for + * call_rcu family of functions usage detail, including the surrounding + * RCU usage required when using these primitives. + */ + +void call_rcu(struct rcu_head *head, + void (*func)(struct rcu_head *head)); + +struct call_rcu_data *create_call_rcu_data(unsigned long flags, + int cpu_affinity); +void call_rcu_data_free(struct call_rcu_data *crdp); + +struct call_rcu_data *get_default_call_rcu_data(void); +struct call_rcu_data *get_cpu_call_rcu_data(int cpu); +struct call_rcu_data *get_thread_call_rcu_data(void); +struct call_rcu_data *get_call_rcu_data(void); +pthread_t get_call_rcu_thread(struct call_rcu_data *crdp); + +void set_thread_call_rcu_data(struct call_rcu_data *crdp); +int set_cpu_call_rcu_data(int cpu, struct call_rcu_data *crdp); + +int create_all_cpu_call_rcu_data(unsigned long flags); +void free_all_cpu_call_rcu_data(void); + +void call_rcu_before_fork(void); +void call_rcu_after_fork_parent(void); +void call_rcu_after_fork_child(void); + +void rcu_barrier(void); + +#ifdef __cplusplus +} +#endif + +#endif /* _URCU_CALL_RCU_H */