xref: /dragonfly/sys/dev/drm/include/linux/kref.h (revision 08e4ff68)
1 /*-
2  * Copyright (c) 2010 Isilon Systems, Inc.
3  * Copyright (c) 2010 iX Systems, Inc.
4  * Copyright (c) 2010 Panasas, Inc.
5  * Copyright (c) 2013-2020 François Tigeot <ftigeot@wolfpond.org>
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice unmodified, this list of conditions, and the following
13  *    disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29 #ifndef _LINUX_KREF_H_
30 #define _LINUX_KREF_H_
31 
32 #include <linux/spinlock.h>
33 
34 #include <linux/mutex.h>
35 
36 #include <sys/refcount.h>
37 
38 struct kref {
39 	atomic_t refcount;
40 };
41 
42 static inline void
43 kref_init(struct kref *kref)
44 {
45 
46 	refcount_init(&kref->refcount.counter, 1);
47 }
48 
49 static inline unsigned int
50 kref_read(const struct kref *kref)
51 {
52 	return atomic_read(&kref->refcount);
53 }
54 
55 static inline void
56 kref_get(struct kref *kref)
57 {
58 
59 	refcount_acquire(&kref->refcount.counter);
60 }
61 
62 static inline int
63 kref_put(struct kref *kref, void (*rel)(struct kref *kref))
64 {
65 
66 	if (refcount_release(&kref->refcount.counter)) {
67 		rel(kref);
68 		return 1;
69 	}
70 	return 0;
71 }
72 
73 static inline int
74 kref_sub(struct kref *kref, unsigned int count,
75 	     void (*rel)(struct kref *kref))
76 {
77 	if (refcount_release_n(&kref->refcount.counter, count)) {
78 		rel(kref);
79 		return 1;
80 	}
81 	return 0;
82 }
83 
84 /*
85  * kref_get_unless_zero: Increment refcount for object unless it is zero.
86  */
87 static inline int __must_check kref_get_unless_zero(struct kref *kref)
88 {
89 	return atomic_add_unless(&kref->refcount, 1, 0);
90 }
91 
92 static inline int kref_put_mutex(struct kref *kref,
93 				 void (*release)(struct kref *kref),
94 				 struct lock *lock)
95 {
96 	if (!atomic_add_unless(&kref->refcount, -1, 1)) {
97 		mutex_lock(lock);
98 		if (likely(atomic_dec_and_test(&kref->refcount))) {
99 			release(kref);
100 			return 1;
101 		}
102 		mutex_unlock(lock);
103 		return 0;
104 	}
105 
106 	return 0;
107 }
108 
109 #endif /* _LINUX_KREF_H_ */
110