kref.h 3.28 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1
/*
2
 * kref.h - library routines for handling generic reference counted objects
Linus Torvalds's avatar
Linus Torvalds committed
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
 *
 * 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_

18
#include <linux/spinlock.h>
19
#include <linux/refcount.h>
Linus Torvalds's avatar
Linus Torvalds committed
20 21

struct kref {
22
	refcount_t refcount;
Linus Torvalds's avatar
Linus Torvalds committed
23 24
};

25
#define KREF_INIT(n)	{ .refcount = REFCOUNT_INIT(n), }
26

27 28 29 30 31 32
/**
 * kref_init - initialize object.
 * @kref: object in question.
 */
static inline void kref_init(struct kref *kref)
{
33
	refcount_set(&kref->refcount, 1);
34 35
}

36
static inline unsigned int kref_read(const struct kref *kref)
37
{
38
	return refcount_read(&kref->refcount);
39 40
}

41 42 43 44 45 46
/**
 * kref_get - increment refcount for object.
 * @kref: object.
 */
static inline void kref_get(struct kref *kref)
{
47
	refcount_inc(&kref->refcount);
48 49 50
}

/**
51
 * kref_put - decrement refcount for object.
52 53 54 55
 * @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
56 57 58 59
 *	     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.
60
 *
61
 * Decrement the refcount, and if 0, call release().
62 63 64 65 66
 * 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.
 */
67
static inline int kref_put(struct kref *kref, void (*release)(struct kref *kref))
68
{
69
	if (refcount_dec_and_test(&kref->refcount)) {
70 71 72 73 74 75
		release(kref);
		return 1;
	}
	return 0;
}

Al Viro's avatar
Al Viro committed
76 77 78 79
static inline int kref_put_mutex(struct kref *kref,
				 void (*release)(struct kref *kref),
				 struct mutex *lock)
{
80
	if (refcount_dec_and_mutex_lock(&kref->refcount, lock)) {
81 82 83 84 85 86 87 88 89 90
		release(kref);
		return 1;
	}
	return 0;
}

static inline int kref_put_lock(struct kref *kref,
				void (*release)(struct kref *kref),
				spinlock_t *lock)
{
91
	if (refcount_dec_and_lock(&kref->refcount, lock)) {
Al Viro's avatar
Al Viro committed
92 93 94 95 96
		release(kref);
		return 1;
	}
	return 0;
}
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115

/**
 * 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)
{
116
	return refcount_inc_not_zero(&kref->refcount);
117
}
Linus Torvalds's avatar
Linus Torvalds committed
118
#endif /* _KREF_H_ */