Commit | Line | Data |
---|---|---|
fdee2e6d MD |
1 | #ifndef _URCU_BP_STATIC_H |
2 | #define _URCU_BP_STATIC_H | |
3 | ||
4 | /* | |
5 | * urcu-bp-static.h | |
6 | * | |
7 | * Userspace RCU header. | |
8 | * | |
a5a9f428 PM |
9 | * TO BE INCLUDED ONLY IN CODE THAT IS TO BE RECOMPILED ON EACH LIBURCU |
10 | * RELEASE. See urcu.h for linking dynamically with the userspace rcu library. | |
fdee2e6d | 11 | * |
6982d6d7 | 12 | * Copyright (c) 2009 Mathieu Desnoyers <mathieu.desnoyers@efficios.com> |
fdee2e6d MD |
13 | * Copyright (c) 2009 Paul E. McKenney, IBM Corporation. |
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 | * IBM's contributions to this file may be relicensed under LGPLv2 or later. | |
30 | */ | |
31 | ||
32 | #include <stdlib.h> | |
33 | #include <pthread.h> | |
fdee2e6d MD |
34 | #include <unistd.h> |
35 | ||
36 | #include <urcu/compiler.h> | |
37 | #include <urcu/arch.h> | |
38 | #include <urcu/system.h> | |
a2e7bf9c | 39 | #include <urcu/uatomic.h> |
fdee2e6d | 40 | #include <urcu/list.h> |
bd252a04 | 41 | #include <urcu/tls-compat.h> |
791151d0 | 42 | #include <urcu/urcu-checker.h> |
fdee2e6d MD |
43 | |
44 | /* | |
45 | * This code section can only be included in LGPL 2.1 compatible source code. | |
46 | * See below for the function call wrappers which can be used in code meant to | |
47 | * be only linked with the Userspace RCU library. This comes with a small | |
48 | * performance degradation on the read-side due to the added function calls. | |
49 | * This is required to permit relinking with newer versions of the library. | |
50 | */ | |
51 | ||
36bc70a8 MD |
52 | #ifdef __cplusplus |
53 | extern "C" { | |
54 | #endif | |
55 | ||
fdee2e6d MD |
56 | #ifdef DEBUG_RCU |
57 | #define rcu_assert(args...) assert(args) | |
58 | #else | |
59 | #define rcu_assert(args...) | |
60 | #endif | |
61 | ||
52c75091 MD |
62 | enum rcu_state { |
63 | RCU_READER_ACTIVE_CURRENT, | |
64 | RCU_READER_ACTIVE_OLD, | |
65 | RCU_READER_INACTIVE, | |
66 | }; | |
67 | ||
fdee2e6d | 68 | /* |
02be5561 | 69 | * The trick here is that RCU_GP_CTR_PHASE must be a multiple of 8 so we can use a |
fdee2e6d MD |
70 | * full 8-bits, 16-bits or 32-bits bitmask for the lower order bits. |
71 | */ | |
72 | #define RCU_GP_COUNT (1UL << 0) | |
73 | /* Use the amount of bits equal to half of the architecture long size */ | |
02be5561 MD |
74 | #define RCU_GP_CTR_PHASE (1UL << (sizeof(long) << 2)) |
75 | #define RCU_GP_CTR_NEST_MASK (RCU_GP_CTR_PHASE - 1) | |
fdee2e6d MD |
76 | |
77 | /* | |
78 | * Used internally by _rcu_read_lock. | |
79 | */ | |
80 | extern void rcu_bp_register(void); | |
81 | ||
c13c2e55 MD |
82 | struct rcu_gp { |
83 | /* | |
84 | * Global grace period counter. | |
85 | * Contains the current RCU_GP_CTR_PHASE. | |
86 | * Also has a RCU_GP_COUNT of 1, to accelerate the reader fast path. | |
87 | * Written to only by writer with mutex taken. | |
88 | * Read by both writer and readers. | |
89 | */ | |
90 | unsigned long ctr; | |
91 | } __attribute__((aligned(CAA_CACHE_LINE_SIZE))); | |
92 | ||
93 | extern struct rcu_gp rcu_gp; | |
fdee2e6d | 94 | |
02be5561 | 95 | struct rcu_reader { |
fdee2e6d | 96 | /* Data used by both reader and synchronize_rcu() */ |
52c75091 | 97 | unsigned long ctr; |
fdee2e6d | 98 | /* Data used for registry */ |
16aa9ee8 | 99 | struct cds_list_head node __attribute__((aligned(CAA_CACHE_LINE_SIZE))); |
fdee2e6d MD |
100 | pthread_t tid; |
101 | int alloc; /* registry entry allocated */ | |
102 | }; | |
103 | ||
104 | /* | |
105 | * Bulletproof version keeps a pointer to a registry not part of the TLS. | |
106 | * Adds a pointer dereference on the read-side, but won't require to unregister | |
107 | * the reader thread. | |
108 | */ | |
bd252a04 | 109 | extern DECLARE_URCU_TLS(struct rcu_reader *, rcu_reader); |
fdee2e6d | 110 | |
52c75091 | 111 | static inline enum rcu_state rcu_reader_state(unsigned long *ctr) |
fdee2e6d | 112 | { |
52c75091 | 113 | unsigned long v; |
fdee2e6d | 114 | |
52c75091 MD |
115 | if (ctr == NULL) |
116 | return RCU_READER_INACTIVE; | |
fdee2e6d MD |
117 | /* |
118 | * Make sure both tests below are done on the same version of *value | |
119 | * to insure consistency. | |
120 | */ | |
52c75091 MD |
121 | v = CMM_LOAD_SHARED(*ctr); |
122 | if (!(v & RCU_GP_CTR_NEST_MASK)) | |
123 | return RCU_READER_INACTIVE; | |
c13c2e55 | 124 | if (!((v ^ rcu_gp.ctr) & RCU_GP_CTR_PHASE)) |
52c75091 MD |
125 | return RCU_READER_ACTIVE_CURRENT; |
126 | return RCU_READER_ACTIVE_OLD; | |
fdee2e6d MD |
127 | } |
128 | ||
a5a9f428 | 129 | /* |
c13c2e55 | 130 | * Helper for _rcu_read_lock(). The format of rcu_gp.ctr (as well as |
a5a9f428 PM |
131 | * the per-thread rcu_reader.ctr) has the upper bits containing a count of |
132 | * _rcu_read_lock() nesting, and a lower-order bit that contains either zero | |
133 | * or RCU_GP_CTR_PHASE. The smp_mb_slave() ensures that the accesses in | |
134 | * _rcu_read_lock() happen before the subsequent read-side critical section. | |
135 | */ | |
136 | static inline void _rcu_read_lock_update(unsigned long tmp) | |
137 | { | |
138 | if (caa_likely(!(tmp & RCU_GP_CTR_NEST_MASK))) { | |
c13c2e55 | 139 | _CMM_STORE_SHARED(URCU_TLS(rcu_reader)->ctr, _CMM_LOAD_SHARED(rcu_gp.ctr)); |
a5a9f428 PM |
140 | cmm_smp_mb(); |
141 | } else | |
142 | _CMM_STORE_SHARED(URCU_TLS(rcu_reader)->ctr, tmp + RCU_GP_COUNT); | |
143 | } | |
144 | ||
145 | /* | |
146 | * Enter an RCU read-side critical section. | |
147 | * | |
148 | * The first cmm_barrier() call ensures that the compiler does not reorder | |
149 | * the body of _rcu_read_lock() with a mutex. | |
150 | * | |
151 | * This function and its helper are both less than 10 lines long. The | |
152 | * intent is that this function meets the 10-line criterion in LGPL, | |
153 | * allowing this function to be invoked directly from non-LGPL code. | |
154 | */ | |
fdee2e6d MD |
155 | static inline void _rcu_read_lock(void) |
156 | { | |
52c75091 | 157 | unsigned long tmp; |
fdee2e6d | 158 | |
791151d0 | 159 | rcu_read_lock_debug(); |
bd252a04 | 160 | if (caa_unlikely(!URCU_TLS(rcu_reader))) |
a5a9f428 | 161 | rcu_bp_register(); /* If not yet registered. */ |
5481ddb3 | 162 | cmm_barrier(); /* Ensure the compiler does not reorder us with mutex */ |
bd252a04 | 163 | tmp = URCU_TLS(rcu_reader)->ctr; |
a5a9f428 | 164 | _rcu_read_lock_update(tmp); |
fdee2e6d MD |
165 | } |
166 | ||
a5a9f428 PM |
167 | /* |
168 | * Exit an RCU read-side critical section. This function is less than | |
169 | * 10 lines of code, and is intended to be usable by non-LGPL code, as | |
170 | * called out in LGPL. | |
171 | */ | |
fdee2e6d MD |
172 | static inline void _rcu_read_unlock(void) |
173 | { | |
174 | /* | |
175 | * Finish using rcu before decrementing the pointer. | |
176 | */ | |
5481ddb3 | 177 | cmm_smp_mb(); |
bd252a04 | 178 | _CMM_STORE_SHARED(URCU_TLS(rcu_reader)->ctr, URCU_TLS(rcu_reader)->ctr - RCU_GP_COUNT); |
5481ddb3 | 179 | cmm_barrier(); /* Ensure the compiler does not reorder us with mutex */ |
791151d0 | 180 | rcu_read_unlock_debug(); |
fdee2e6d MD |
181 | } |
182 | ||
882f3357 MD |
183 | /* |
184 | * Returns whether within a RCU read-side critical section. | |
185 | * | |
186 | * This function is less than 10 lines long. The intent is that this | |
187 | * function meets the 10-line criterion for LGPL, allowing this function | |
188 | * to be invoked directly from non-LGPL code. | |
189 | */ | |
190 | static inline int _rcu_read_ongoing(void) | |
191 | { | |
192 | if (caa_unlikely(!URCU_TLS(rcu_reader))) | |
193 | rcu_bp_register(); /* If not yet registered. */ | |
194 | return URCU_TLS(rcu_reader)->ctr & RCU_GP_CTR_NEST_MASK; | |
195 | } | |
196 | ||
36bc70a8 MD |
197 | #ifdef __cplusplus |
198 | } | |
199 | #endif | |
200 | ||
fdee2e6d | 201 | #endif /* _URCU_BP_STATIC_H */ |