Blame view
include/linux/kref.h
3.28 KB
1da177e4c Linux-2.6.12-rc2 |
1 |
/* |
932fb06b0 kobj: kref.h inco... |
2 |
* kref.h - library routines for handling generic reference counted objects |
1da177e4c Linux-2.6.12-rc2 |
3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
* * Copyright (C) 2004 Greg Kroah-Hartman <greg@kroah.com> * Copyright (C) 2004 IBM Corp. * * based on kobject.h which was: * Copyright (C) 2002-2003 Patrick Mochel <mochel@osdl.org> * Copyright (C) 2002-2003 Open Source Development Labs * * This file is released under the GPLv2. * */ #ifndef _KREF_H_ #define _KREF_H_ |
0a13cd1a0 locking/atomic, k... |
17 |
#include <linux/spinlock.h> |
10383aea2 kref: Implement '... |
18 |
#include <linux/refcount.h> |
1da177e4c Linux-2.6.12-rc2 |
19 20 |
struct kref { |
10383aea2 kref: Implement '... |
21 |
refcount_t refcount; |
1da177e4c Linux-2.6.12-rc2 |
22 |
}; |
10383aea2 kref: Implement '... |
23 |
#define KREF_INIT(n) { .refcount = REFCOUNT_INIT(n), } |
1e24edca0 locking/atomic, k... |
24 |
|
4af679cd7 kref: Inline all ... |
25 26 27 28 29 30 |
/** * kref_init - initialize object. * @kref: object in question. */ static inline void kref_init(struct kref *kref) { |
10383aea2 kref: Implement '... |
31 |
refcount_set(&kref->refcount, 1); |
4af679cd7 kref: Inline all ... |
32 |
} |
10383aea2 kref: Implement '... |
33 |
static inline unsigned int kref_read(const struct kref *kref) |
2c935bc57 locking/atomic, k... |
34 |
{ |
10383aea2 kref: Implement '... |
35 |
return refcount_read(&kref->refcount); |
2c935bc57 locking/atomic, k... |
36 |
} |
4af679cd7 kref: Inline all ... |
37 38 39 40 41 42 |
/** * kref_get - increment refcount for object. * @kref: object. */ static inline void kref_get(struct kref *kref) { |
10383aea2 kref: Implement '... |
43 |
refcount_inc(&kref->refcount); |
4af679cd7 kref: Inline all ... |
44 45 46 |
} /** |
bdfafc4ff locking/atomic, k... |
47 |
* kref_put - decrement refcount for object. |
4af679cd7 kref: Inline all ... |
48 49 50 51 |
* @kref: object. * @release: pointer to the function that will clean up the object when the * last reference to the object is released. * This pointer is required, and it is not acceptable to pass kfree |
6261ddee7 kref: fix up the ... |
52 53 54 55 |
* in as this function. If the caller does pass kfree to this * function, you will be publicly mocked mercilessly by the kref * maintainer, and anyone else who happens to notice it. You have * been warned. |
4af679cd7 kref: Inline all ... |
56 |
* |
bdfafc4ff locking/atomic, k... |
57 |
* Decrement the refcount, and if 0, call release(). |
4af679cd7 kref: Inline all ... |
58 59 60 61 62 |
* Return 1 if the object was removed, otherwise return 0. Beware, if this * function returns 0, you still can not count on the kref from remaining in * memory. Only use the return value if you want to see if the kref is now * gone, not present. */ |
bdfafc4ff locking/atomic, k... |
63 |
static inline int kref_put(struct kref *kref, void (*release)(struct kref *kref)) |
4af679cd7 kref: Inline all ... |
64 |
{ |
10383aea2 kref: Implement '... |
65 |
if (refcount_dec_and_test(&kref->refcount)) { |
4af679cd7 kref: Inline all ... |
66 67 68 69 70 |
release(kref); return 1; } return 0; } |
8ad5db8a8 introduce kref_pu... |
71 72 73 74 |
static inline int kref_put_mutex(struct kref *kref, void (*release)(struct kref *kref), struct mutex *lock) { |
10383aea2 kref: Implement '... |
75 |
if (refcount_dec_and_mutex_lock(&kref->refcount, lock)) { |
0a13cd1a0 locking/atomic, k... |
76 77 78 79 80 81 82 83 84 85 |
release(kref); return 1; } return 0; } static inline int kref_put_lock(struct kref *kref, void (*release)(struct kref *kref), spinlock_t *lock) { |
10383aea2 kref: Implement '... |
86 |
if (refcount_dec_and_lock(&kref->refcount, lock)) { |
8ad5db8a8 introduce kref_pu... |
87 88 89 90 91 |
release(kref); return 1; } return 0; } |
4b20db3de kref: Implement k... |
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 |
/** * kref_get_unless_zero - Increment refcount for object unless it is zero. * @kref: object. * * Return non-zero if the increment succeeded. Otherwise return 0. * * This function is intended to simplify locking around refcounting for * objects that can be looked up from a lookup structure, and which are * removed from that lookup structure in the object destructor. * Operations on such objects require at least a read lock around * lookup + kref_get, and a write lock around kref_put + remove from lookup * structure. Furthermore, RCU implementations become extremely tricky. * With a lookup followed by a kref_get_unless_zero *with return value check* * locking in the kref_put path can be deferred to the actual removal from * the lookup structure and RCU lookups become trivial. */ static inline int __must_check kref_get_unless_zero(struct kref *kref) { |
10383aea2 kref: Implement '... |
111 |
return refcount_inc_not_zero(&kref->refcount); |
4b20db3de kref: Implement k... |
112 |
} |
1da177e4c Linux-2.6.12-rc2 |
113 |
#endif /* _KREF_H_ */ |