kref.h revision 1.2.2.1
1 1.2.2.1 tls /* $NetBSD: kref.h,v 1.2.2.1 2014/08/10 06:55:39 tls Exp $ */ 2 1.2 riastrad 3 1.2 riastrad /*- 4 1.2 riastrad * Copyright (c) 2013 The NetBSD Foundation, Inc. 5 1.2 riastrad * All rights reserved. 6 1.2 riastrad * 7 1.2 riastrad * This code is derived from software contributed to The NetBSD Foundation 8 1.2 riastrad * by Taylor R. Campbell. 9 1.2 riastrad * 10 1.2 riastrad * Redistribution and use in source and binary forms, with or without 11 1.2 riastrad * modification, are permitted provided that the following conditions 12 1.2 riastrad * are met: 13 1.2 riastrad * 1. Redistributions of source code must retain the above copyright 14 1.2 riastrad * notice, this list of conditions and the following disclaimer. 15 1.2 riastrad * 2. Redistributions in binary form must reproduce the above copyright 16 1.2 riastrad * notice, this list of conditions and the following disclaimer in the 17 1.2 riastrad * documentation and/or other materials provided with the distribution. 18 1.2 riastrad * 19 1.2 riastrad * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 20 1.2 riastrad * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 21 1.2 riastrad * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 22 1.2 riastrad * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 23 1.2 riastrad * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 24 1.2 riastrad * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 25 1.2 riastrad * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 26 1.2 riastrad * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 27 1.2 riastrad * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 28 1.2 riastrad * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 29 1.2 riastrad * POSSIBILITY OF SUCH DAMAGE. 30 1.2 riastrad */ 31 1.2 riastrad 32 1.2 riastrad #ifndef _LINUX_KREF_H_ 33 1.2 riastrad #define _LINUX_KREF_H_ 34 1.2 riastrad 35 1.2 riastrad #include <sys/types.h> 36 1.2 riastrad #include <sys/atomic.h> 37 1.2 riastrad #include <sys/systm.h> 38 1.2 riastrad 39 1.2 riastrad #include <linux/mutex.h> 40 1.2 riastrad 41 1.2 riastrad struct kref { 42 1.2 riastrad unsigned int kr_count; 43 1.2 riastrad }; 44 1.2 riastrad 45 1.2 riastrad static inline void 46 1.2 riastrad kref_init(struct kref *kref) 47 1.2 riastrad { 48 1.2 riastrad kref->kr_count = 1; 49 1.2 riastrad } 50 1.2 riastrad 51 1.2 riastrad static inline void 52 1.2 riastrad kref_get(struct kref *kref) 53 1.2 riastrad { 54 1.2 riastrad const unsigned int count __unused = 55 1.2 riastrad atomic_inc_uint_nv(&kref->kr_count); 56 1.2 riastrad 57 1.2 riastrad KASSERTMSG((count > 1), "getting released kref"); 58 1.2 riastrad } 59 1.2 riastrad 60 1.2.2.1 tls static inline bool 61 1.2.2.1 tls kref_get_unless_zero(struct kref *kref) 62 1.2.2.1 tls { 63 1.2.2.1 tls unsigned count; 64 1.2.2.1 tls 65 1.2.2.1 tls do { 66 1.2.2.1 tls count = kref->kr_count; 67 1.2.2.1 tls if ((count == 0) || (count == UINT_MAX)) 68 1.2.2.1 tls return false; 69 1.2.2.1 tls } while (atomic_cas_uint(&kref->kr_count, count, (count + 1)) != 70 1.2.2.1 tls count); 71 1.2.2.1 tls 72 1.2.2.1 tls return true; 73 1.2.2.1 tls } 74 1.2.2.1 tls 75 1.2 riastrad static inline int 76 1.2 riastrad kref_sub(struct kref *kref, unsigned int count, void (*release)(struct kref *)) 77 1.2 riastrad { 78 1.2 riastrad unsigned int old, new; 79 1.2 riastrad 80 1.2 riastrad do { 81 1.2 riastrad old = kref->kr_count; 82 1.2 riastrad KASSERTMSG((count <= old), "overreleasing kref: %u - %u", 83 1.2 riastrad old, count); 84 1.2 riastrad new = (old - count); 85 1.2 riastrad } while (atomic_cas_uint(&kref->kr_count, old, new) != old); 86 1.2 riastrad 87 1.2 riastrad if (new == 0) { 88 1.2 riastrad (*release)(kref); 89 1.2 riastrad return 1; 90 1.2 riastrad } 91 1.2 riastrad 92 1.2 riastrad return 0; 93 1.2 riastrad } 94 1.2 riastrad 95 1.2 riastrad static inline int 96 1.2 riastrad kref_put(struct kref *kref, void (*release)(struct kref *)) 97 1.2 riastrad { 98 1.2 riastrad 99 1.2 riastrad return kref_sub(kref, 1, release); 100 1.2 riastrad } 101 1.2 riastrad 102 1.2 riastrad static inline int 103 1.2 riastrad kref_put_mutex(struct kref *kref, void (*release)(struct kref *), 104 1.2 riastrad struct mutex *interlock) 105 1.2 riastrad { 106 1.2 riastrad unsigned int old, new; 107 1.2 riastrad 108 1.2 riastrad do { 109 1.2 riastrad old = kref->kr_count; 110 1.2 riastrad KASSERT(old > 0); 111 1.2 riastrad if (old == 1) { 112 1.2 riastrad mutex_lock(interlock); 113 1.2 riastrad if (atomic_add_int_nv(&kref->kr_count, -1) == 0) { 114 1.2 riastrad (*release)(kref); 115 1.2 riastrad return 1; 116 1.2 riastrad } 117 1.2 riastrad mutex_unlock(interlock); 118 1.2 riastrad return 0; 119 1.2 riastrad } 120 1.2 riastrad new = (old - 1); 121 1.2 riastrad } while (atomic_cas_uint(&kref->kr_count, old, new) != old); 122 1.2 riastrad 123 1.2 riastrad return 0; 124 1.2 riastrad } 125 1.2 riastrad 126 1.2.2.1 tls /* 127 1.2.2.1 tls * Not native to Linux. Mostly used for assertions... 128 1.2.2.1 tls */ 129 1.2.2.1 tls 130 1.2.2.1 tls static inline bool 131 1.2.2.1 tls kref_referenced_p(struct kref *kref) 132 1.2.2.1 tls { 133 1.2.2.1 tls 134 1.2.2.1 tls return (0 < kref->kr_count); 135 1.2.2.1 tls } 136 1.2.2.1 tls 137 1.2.2.1 tls static inline bool 138 1.2.2.1 tls kref_exclusive_p(struct kref *kref) 139 1.2.2.1 tls { 140 1.2.2.1 tls 141 1.2.2.1 tls KASSERT(0 < kref->kr_count); 142 1.2.2.1 tls return (kref->kr_count == 1); 143 1.2.2.1 tls } 144 1.2.2.1 tls 145 1.2 riastrad #endif /* _LINUX_KREF_H_ */ 146
Indexes created Thu Oct 02 01:09:59 GMT 2025