| 1 | #ifndef _URCU_CALL_RCU_H |
| 2 | #define _URCU_CALL_RCU_H |
| 3 | |
| 4 | /* |
| 5 | * urcu-call-rcu.h |
| 6 | * |
| 7 | * Userspace RCU header - deferred execution |
| 8 | * |
| 9 | * Copyright (c) 2009 Mathieu Desnoyers <mathieu.desnoyers@efficios.com> |
| 10 | * Copyright (c) 2009 Paul E. McKenney, IBM Corporation. |
| 11 | * |
| 12 | * LGPL-compatible code should include this header with : |
| 13 | * |
| 14 | * #define _LGPL_SOURCE |
| 15 | * #include <urcu-defer.h> |
| 16 | * |
| 17 | * This library is free software; you can redistribute it and/or |
| 18 | * modify it under the terms of the GNU Lesser General Public |
| 19 | * License as published by the Free Software Foundation; either |
| 20 | * version 2.1 of the License, or (at your option) any later version. |
| 21 | * |
| 22 | * This library is distributed in the hope that it will be useful, |
| 23 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 24 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 25 | * Lesser General Public License for more details. |
| 26 | * |
| 27 | * You should have received a copy of the GNU Lesser General Public |
| 28 | * License along with this library; if not, write to the Free Software |
| 29 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
| 30 | */ |
| 31 | |
| 32 | #include <stdlib.h> |
| 33 | #include <pthread.h> |
| 34 | |
| 35 | #include <urcu/wfcqueue.h> |
| 36 | |
| 37 | #ifdef __cplusplus |
| 38 | extern "C" { |
| 39 | #endif |
| 40 | |
| 41 | /* Note that struct call_rcu_data is opaque to callers. */ |
| 42 | |
| 43 | struct call_rcu_data; |
| 44 | |
| 45 | /* Flag values. */ |
| 46 | |
| 47 | #define URCU_CALL_RCU_RT (1U << 0) |
| 48 | #define URCU_CALL_RCU_RUNNING (1U << 1) |
| 49 | #define URCU_CALL_RCU_STOP (1U << 2) |
| 50 | #define URCU_CALL_RCU_STOPPED (1U << 3) |
| 51 | #define URCU_CALL_RCU_PAUSE (1U << 4) |
| 52 | #define URCU_CALL_RCU_PAUSED (1U << 5) |
| 53 | |
| 54 | /* |
| 55 | * The rcu_head data structure is placed in the structure to be freed |
| 56 | * via call_rcu(). |
| 57 | */ |
| 58 | |
| 59 | struct rcu_head { |
| 60 | struct cds_wfcq_node next; |
| 61 | void (*func)(struct rcu_head *head); |
| 62 | }; |
| 63 | |
| 64 | /* |
| 65 | * Exported functions |
| 66 | * |
| 67 | * Important: see rcu-api.md in userspace-rcu documentation for |
| 68 | * call_rcu family of functions usage detail, including the surrounding |
| 69 | * RCU usage required when using these primitives. |
| 70 | */ |
| 71 | |
| 72 | void call_rcu(struct rcu_head *head, |
| 73 | void (*func)(struct rcu_head *head)); |
| 74 | |
| 75 | struct call_rcu_data *create_call_rcu_data(unsigned long flags, |
| 76 | int cpu_affinity); |
| 77 | void call_rcu_data_free(struct call_rcu_data *crdp); |
| 78 | |
| 79 | struct call_rcu_data *get_default_call_rcu_data(void); |
| 80 | struct call_rcu_data *get_cpu_call_rcu_data(int cpu); |
| 81 | struct call_rcu_data *get_thread_call_rcu_data(void); |
| 82 | struct call_rcu_data *get_call_rcu_data(void); |
| 83 | pthread_t get_call_rcu_thread(struct call_rcu_data *crdp); |
| 84 | |
| 85 | void set_thread_call_rcu_data(struct call_rcu_data *crdp); |
| 86 | int set_cpu_call_rcu_data(int cpu, struct call_rcu_data *crdp); |
| 87 | |
| 88 | int create_all_cpu_call_rcu_data(unsigned long flags); |
| 89 | void free_all_cpu_call_rcu_data(void); |
| 90 | |
| 91 | void call_rcu_before_fork(void); |
| 92 | void call_rcu_after_fork_parent(void); |
| 93 | void call_rcu_after_fork_child(void); |
| 94 | |
| 95 | void rcu_barrier(void); |
| 96 | |
| 97 | #ifdef __cplusplus |
| 98 | } |
| 99 | #endif |
| 100 | |
| 101 | #endif /* _URCU_CALL_RCU_H */ |