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