2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2005 John Baldwin <jhb@FreeBSD.org>
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 #ifndef __SYS_REFCOUNT_H__
31 #define __SYS_REFCOUNT_H__
33 #include <machine/atomic.h>
35 #if defined(_KERNEL) || defined(_STANDALONE)
36 #include <sys/systm.h>
39 #define KASSERT(exp, msg) /* */
42 #define REFCOUNT_SATURATED(val) (((val) & (1U << 31)) != 0)
43 #define REFCOUNT_SATURATION_VALUE (3U << 30)
46 * Attempt to handle reference count overflow and underflow. Force the counter
47 * to stay at the saturation value so that a counter overflow cannot trigger
48 * destruction of the containing object and instead leads to a less harmful
52 _refcount_update_saturated(volatile u_int *count)
55 panic("refcount %p wraparound", count);
57 atomic_store_int(count, REFCOUNT_SATURATION_VALUE);
62 refcount_init(volatile u_int *count, u_int value)
64 KASSERT(!REFCOUNT_SATURATED(value),
65 ("invalid initial refcount value %u", value));
66 atomic_store_int(count, value);
70 refcount_load(volatile u_int *count)
72 return (atomic_load_int(count));
76 refcount_acquire(volatile u_int *count)
80 old = atomic_fetchadd_int(count, 1);
81 if (__predict_false(REFCOUNT_SATURATED(old)))
82 _refcount_update_saturated(count);
88 refcount_acquiren(volatile u_int *count, u_int n)
92 KASSERT(n < REFCOUNT_SATURATION_VALUE / 2,
93 ("refcount_acquiren: n=%u too large", n));
94 old = atomic_fetchadd_int(count, n);
95 if (__predict_false(REFCOUNT_SATURATED(old)))
96 _refcount_update_saturated(count);
101 static __inline __result_use_check bool
102 refcount_acquire_checked(volatile u_int *count)
106 old = atomic_load_int(count);
108 if (__predict_false(REFCOUNT_SATURATED(old + 1)))
110 if (__predict_true(atomic_fcmpset_int(count, &old,
117 * This functions returns non-zero if the refcount was
118 * incremented. Else zero is returned.
120 static __inline __result_use_check bool
121 refcount_acquire_if_gt(volatile u_int *count, u_int n)
125 old = atomic_load_int(count);
129 if (__predict_false(REFCOUNT_SATURATED(old)))
131 if (atomic_fcmpset_int(count, &old, old + 1))
136 static __inline __result_use_check bool
137 refcount_acquire_if_not_zero(volatile u_int *count)
140 return (refcount_acquire_if_gt(count, 0));
144 refcount_releasen(volatile u_int *count, u_int n)
148 KASSERT(n < REFCOUNT_SATURATION_VALUE / 2,
149 ("refcount_releasen: n=%u too large", n));
151 atomic_thread_fence_rel();
152 old = atomic_fetchadd_int(count, -n);
153 if (__predict_false(old < n || REFCOUNT_SATURATED(old))) {
154 _refcount_update_saturated(count);
161 * Last reference. Signal the user to call the destructor.
163 * Ensure that the destructor sees all updates. This synchronizes with
164 * release fences from all routines which drop the count.
166 atomic_thread_fence_acq();
171 refcount_release(volatile u_int *count)
174 return (refcount_releasen(count, 1));
177 #define _refcount_release_if_cond(cond, name) \
178 static __inline __result_use_check bool \
179 _refcount_release_if_##name(volatile u_int *count, u_int n) \
183 KASSERT(n > 0, ("%s: zero increment", __func__)); \
184 old = atomic_load_int(count); \
188 if (__predict_false(REFCOUNT_SATURATED(old))) \
190 if (atomic_fcmpset_rel_int(count, &old, old - 1)) \
194 _refcount_release_if_cond(old > n, gt)
195 _refcount_release_if_cond(old == n, eq)
197 static __inline __result_use_check bool
198 refcount_release_if_gt(volatile u_int *count, u_int n)
201 return (_refcount_release_if_gt(count, n));
204 static __inline __result_use_check bool
205 refcount_release_if_last(volatile u_int *count)
208 if (_refcount_release_if_eq(count, 1)) {
209 /* See the comment in refcount_releasen(). */
210 atomic_thread_fence_acq();
216 static __inline __result_use_check bool
217 refcount_release_if_not_last(volatile u_int *count)
220 return (_refcount_release_if_gt(count, 1));
223 #endif /* !__SYS_REFCOUNT_H__ */