Commit | Line | Data |
---|---|---|
1da177e4 | 1 | /* |
932fb06b | 2 | * kref.h - library routines for handling generic reference counted objects |
1da177e4 LT |
3 | * |
4 | * Copyright (C) 2004 Greg Kroah-Hartman <greg@kroah.com> | |
5 | * Copyright (C) 2004 IBM Corp. | |
6 | * | |
7 | * based on kobject.h which was: | |
8 | * Copyright (C) 2002-2003 Patrick Mochel <mochel@osdl.org> | |
9 | * Copyright (C) 2002-2003 Open Source Development Labs | |
10 | * | |
11 | * This file is released under the GPLv2. | |
12 | * | |
13 | */ | |
14 | ||
15 | #ifndef _KREF_H_ | |
16 | #define _KREF_H_ | |
17 | ||
6261ddee GKH |
18 | #include <linux/bug.h> |
19 | #include <linux/atomic.h> | |
1da177e4 LT |
20 | |
21 | struct kref { | |
22 | atomic_t refcount; | |
23 | }; | |
24 | ||
4af679cd PZ |
25 | /** |
26 | * kref_init - initialize object. | |
27 | * @kref: object in question. | |
28 | */ | |
29 | static inline void kref_init(struct kref *kref) | |
30 | { | |
31 | atomic_set(&kref->refcount, 1); | |
4af679cd PZ |
32 | } |
33 | ||
34 | /** | |
35 | * kref_get - increment refcount for object. | |
36 | * @kref: object. | |
37 | */ | |
38 | static inline void kref_get(struct kref *kref) | |
39 | { | |
40 | WARN_ON(!atomic_read(&kref->refcount)); | |
41 | atomic_inc(&kref->refcount); | |
4af679cd PZ |
42 | } |
43 | ||
44 | /** | |
47dbd7d9 | 45 | * kref_sub - subtract a number of refcounts for object. |
4af679cd | 46 | * @kref: object. |
47dbd7d9 | 47 | * @count: Number of recounts to subtract. |
4af679cd PZ |
48 | * @release: pointer to the function that will clean up the object when the |
49 | * last reference to the object is released. | |
50 | * This pointer is required, and it is not acceptable to pass kfree | |
6261ddee GKH |
51 | * in as this function. If the caller does pass kfree to this |
52 | * function, you will be publicly mocked mercilessly by the kref | |
53 | * maintainer, and anyone else who happens to notice it. You have | |
54 | * been warned. | |
4af679cd | 55 | * |
47dbd7d9 | 56 | * Subtract @count from the refcount, and if 0, call release(). |
4af679cd PZ |
57 | * Return 1 if the object was removed, otherwise return 0. Beware, if this |
58 | * function returns 0, you still can not count on the kref from remaining in | |
59 | * memory. Only use the return value if you want to see if the kref is now | |
60 | * gone, not present. | |
61 | */ | |
47dbd7d9 PZ |
62 | static inline int kref_sub(struct kref *kref, unsigned int count, |
63 | void (*release)(struct kref *kref)) | |
4af679cd PZ |
64 | { |
65 | WARN_ON(release == NULL); | |
4af679cd | 66 | |
47dbd7d9 | 67 | if (atomic_sub_and_test((int) count, &kref->refcount)) { |
4af679cd PZ |
68 | release(kref); |
69 | return 1; | |
70 | } | |
71 | return 0; | |
72 | } | |
73 | ||
4af679cd | 74 | /** |
47dbd7d9 | 75 | * kref_put - decrement refcount for object. |
4af679cd | 76 | * @kref: object. |
4af679cd PZ |
77 | * @release: pointer to the function that will clean up the object when the |
78 | * last reference to the object is released. | |
79 | * This pointer is required, and it is not acceptable to pass kfree | |
6261ddee GKH |
80 | * in as this function. If the caller does pass kfree to this |
81 | * function, you will be publicly mocked mercilessly by the kref | |
82 | * maintainer, and anyone else who happens to notice it. You have | |
83 | * been warned. | |
4af679cd | 84 | * |
47dbd7d9 | 85 | * Decrement the refcount, and if 0, call release(). |
4af679cd PZ |
86 | * Return 1 if the object was removed, otherwise return 0. Beware, if this |
87 | * function returns 0, you still can not count on the kref from remaining in | |
88 | * memory. Only use the return value if you want to see if the kref is now | |
89 | * gone, not present. | |
90 | */ | |
47dbd7d9 | 91 | static inline int kref_put(struct kref *kref, void (*release)(struct kref *kref)) |
4af679cd | 92 | { |
47dbd7d9 | 93 | return kref_sub(kref, 1, release); |
4af679cd | 94 | } |
1da177e4 | 95 | #endif /* _KREF_H_ */ |