Blame view

lib/kref.c 2.6 KB
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
  /*
   * kref.c - library routines for handling generic reference counted objects
   *
   * Copyright (C) 2004 Greg Kroah-Hartman <greg@kroah.com>
   * Copyright (C) 2004 IBM Corp.
   *
   * based on lib/kobject.c which was:
   * Copyright (C) 2002-2003 Patrick Mochel <mochel@osdl.org>
   *
   * This file is released under the GPLv2.
   *
   */
  
  #include <linux/kref.h>
  #include <linux/module.h>
5a0e3ad6a   Tejun Heo   include cleanup: ...
16
  #include <linux/slab.h>
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
17
18
19
20
21
22
23
  
  /**
   * kref_init - initialize object.
   * @kref: object in question.
   */
  void kref_init(struct kref *kref)
  {
db1afffab   NeilBrown   kref: remove kref...
24
25
  	atomic_set(&kref->refcount, 1);
  	smp_mb();
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
26
27
28
29
30
31
32
33
34
35
  }
  
  /**
   * kref_get - increment refcount for object.
   * @kref: object.
   */
  void kref_get(struct kref *kref)
  {
  	WARN_ON(!atomic_read(&kref->refcount));
  	atomic_inc(&kref->refcount);
1b0b3b998   Oliver Neukum   kref: fix CPU ord...
36
  	smp_mb__after_atomic_inc();
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
  }
  
  /**
   * kref_put - decrement refcount for object.
   * @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
   *	     in as this function.
   *
   * Decrement the refcount, and if 0, call release().
   * 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.
   */
  int kref_put(struct kref *kref, void (*release)(struct kref *kref))
  {
  	WARN_ON(release == NULL);
  	WARN_ON(release == (void (*)(struct kref *))kfree);
f334b60b4   Venkatesh Pallipadi   kref refcnt and f...
57
  	if (atomic_dec_and_test(&kref->refcount)) {
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
58
59
60
61
62
  		release(kref);
  		return 1;
  	}
  	return 0;
  }
ecf7ace9a   Thomas Hellstrom   kref: Add a kref_...
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
  
  /**
   * kref_sub - subtract a number of refcounts for object.
   * @kref: object.
   * @count: Number of recounts to subtract.
   * @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
   *	     in as this function.
   *
   * Subtract @count from the refcount, and if 0, call release().
   * 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.
   */
  int kref_sub(struct kref *kref, unsigned int count,
  	     void (*release)(struct kref *kref))
  {
  	WARN_ON(release == NULL);
  	WARN_ON(release == (void (*)(struct kref *))kfree);
  
  	if (atomic_sub_and_test((int) count, &kref->refcount)) {
  		release(kref);
  		return 1;
  	}
  	return 0;
  }
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
91
92
93
  EXPORT_SYMBOL(kref_init);
  EXPORT_SYMBOL(kref_get);
  EXPORT_SYMBOL(kref_put);
ecf7ace9a   Thomas Hellstrom   kref: Add a kref_...
94
  EXPORT_SYMBOL(kref_sub);