sys/sys/refcount.h

   1 /*-
   2  * Copyright (c) 2005 John Baldwin <jhb@FreeBSD.org>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. Neither the name of the author nor the names of any co-contributors
  14  *    may be used to endorse or promote products derived from this software
  15  *    without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  * $FreeBSD: src/sys/sys/refcount.h,v 1.1 2005/09/27 18:01:33 jhb Exp $
  30  * $DragonFly: src/sys/sys/refcount.h,v 1.1 2008/06/26 23:06:52 dillon Exp $
  31  */
  32
  33 #ifndef __SYS_REFCOUNT_H__
  34 #define __SYS_REFCOUNT_H__
  35
  36 #include <machine/atomic.h>
  37
  38 #define REFCNTF_WAITING 0x40000000
  39
  40 void _refcount_wait(volatile u_int *countp, const char *wstr);
  41 int _refcount_release_wakeup_n(volatile u_int *countp, u_int i);
  42
  43 static __inline void
  44 refcount_init(volatile u_int *countp, u_int value)
  45 {
  46         *countp = value;
  47 }
  48
  49 static __inline void
  50 refcount_acquire(volatile u_int *countp)
  51 {
  52         atomic_add_acq_int(countp, 1);
  53 }
  54
  55 static __inline void
  56 refcount_acquire_n(volatile u_int *countp, u_int i)
  57 {
  58         atomic_add_acq_int(countp, i);
  59 }
  60
  61 static __inline int
  62 refcount_release(volatile u_int *countp)
  63 {
  64         return (atomic_fetchadd_int(countp, -1) == 1);
  65 }
  66
  67 static __inline int
  68 refcount_release_n(volatile u_int *countp, u_int i)
  69 {
  70         return (atomic_fetchadd_int(countp, -i) == i);
  71 }
  72
  73 /*
  74  * Release a refcount and also handle waiters who have (atomically)
  75  * set the REFCNTF_WAITING flag.  If the flag was set the atomic op
  76  * will fail (because the 'old' value we pass it is with the flag
  77  * cleared).  The atomic op can also fail on a race so the helper
  78  * function deals with all cases.
  79  *
  80  * This function returns TRUE(1) on the last release and FALSE(0) otherwise.
  81  *
  82  * NOTE: (i) must be non-zero.
  83  */
  84 static __inline int
  85 refcount_release_wakeup(volatile u_int *countp)
  86 {
  87         u_int n = *countp & ~REFCNTF_WAITING;
  88         if (!atomic_cmpset_int(countp, n, n - 1))
  89                 return(_refcount_release_wakeup_n(countp, 1));
  90         return(n == 1);
  91 }
  92
  93 static __inline int
  94 refcount_release_wakeup_n(volatile u_int *countp, u_int i)
  95 {
  96         u_int n = *countp & ~REFCNTF_WAITING;
  97         if (!atomic_cmpset_int(countp, n, n - i))
  98                 return(_refcount_release_wakeup_n(countp, i));
  99         return(n == i);
 100 }
 101
 102 /*
 103  * Wait for all refs on *countp to go away.
 104  *
 105  * WARNING!  If this function is used then all releases on countp MUST
 106  *           use refcount_release_wakeup() instead of refcount_release().
 107  */
 108 static __inline void
 109 refcount_wait(volatile u_int *countp, const char *wstr)
 110 {
 111         if (*countp)
 112                 _refcount_wait(countp, wstr);
 113 }
 114
 115 #endif  /* ! __SYS_REFCOUNT_H__ */