sys/sys/refcount.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2005 John Baldwin <jhb@FreeBSD.org>
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   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.
  14  *
  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
  25  * SUCH DAMAGE.
  26  *
  27  * $FreeBSD$
  28  */
  29
  30 #ifndef __SYS_REFCOUNT_H__
  31 #define __SYS_REFCOUNT_H__
  32
  33 #include <sys/limits.h>
  34 #include <machine/atomic.h>
  35
  36 #ifdef _KERNEL
  37 #include <sys/systm.h>
  38 #else
  39 #define KASSERT(exp, msg)       /* */
  40 #endif
  41
  42 static __inline void
  43 refcount_init(volatile u_int *count, u_int value)
  44 {
  45
  46         *count = value;
  47 }
  48
  49 static __inline void
  50 refcount_acquire(volatile u_int *count)
  51 {
  52
  53         KASSERT(*count < UINT_MAX, ("refcount %p overflowed", count));
  54         atomic_add_int(count, 1);
  55 }
  56
  57 static __inline __result_use_check bool
  58 refcount_acquire_checked(volatile u_int *count)
  59 {
  60         u_int lcount;
  61
  62         for (lcount = *count;;) {
  63                 if (__predict_false(lcount + 1 < lcount))
  64                         return (false);
  65                 if (__predict_true(atomic_fcmpset_int(count, &lcount,
  66                     lcount + 1) == 1))
  67                         return (true);
  68         }
  69 }
  70
  71 static __inline int
  72 refcount_release(volatile u_int *count)
  73 {
  74         u_int old;
  75
  76         atomic_thread_fence_rel();
  77         old = atomic_fetchadd_int(count, -1);
  78         KASSERT(old > 0, ("refcount %p is zero", count));
  79         if (old > 1)
  80                 return (0);
  81
  82         /*
  83          * Last reference.  Signal the user to call the destructor.
  84          *
  85          * Ensure that the destructor sees all updates.  The fence_rel
  86          * at the start of the function synchronized with this fence.
  87          */
  88         atomic_thread_fence_acq();
  89         return (1);
  90 }
  91
  92 /*
  93  * This functions returns non-zero if the refcount was
  94  * incremented. Else zero is returned.
  95  */
  96 static __inline __result_use_check int
  97 refcount_acquire_if_not_zero(volatile u_int *count)
  98 {
  99         u_int old;
 100
 101         old = *count;
 102         for (;;) {
 103                 KASSERT(old < UINT_MAX, ("refcount %p overflowed", count));
 104                 if (old == 0)
 105                         return (0);
 106                 if (atomic_fcmpset_int(count, &old, old + 1))
 107                         return (1);
 108         }
 109 }
 110
 111 static __inline __result_use_check int
 112 refcount_release_if_not_last(volatile u_int *count)
 113 {
 114         u_int old;
 115
 116         old = *count;
 117         for (;;) {
 118                 KASSERT(old > 0, ("refcount %p is zero", count));
 119                 if (old == 1)
 120                         return (0);
 121                 if (atomic_fcmpset_int(count, &old, old - 1))
 122                         return (1);
 123         }
 124 }
 125
 126 #endif  /* ! __SYS_REFCOUNT_H__ */