kref.c 2.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798
  1. /*
  2. * kref.c - library routines for handling generic reference counted objects
  3. *
  4. * Copyright (C) 2004 Greg Kroah-Hartman <greg@kroah.com>
  5. * Copyright (C) 2004 IBM Corp.
  6. *
  7. * based on lib/kobject.c which was:
  8. * Copyright (C) 2002-2003 Patrick Mochel <mochel@osdl.org>
  9. *
  10. * This file is released under the GPLv2.
  11. *
  12. */
  13. #include <linux/kref.h>
  14. #include <linux/module.h>
  15. #include <linux/slab.h>
  16. /**
  17. * kref_init - initialize object.
  18. * @kref: object in question.
  19. */
  20. void kref_init(struct kref *kref)
  21. {
  22. atomic_set(&kref->refcount, 1);
  23. smp_mb();
  24. }
  25. /**
  26. * kref_get - increment refcount for object.
  27. * @kref: object.
  28. */
  29. void kref_get(struct kref *kref)
  30. {
  31. WARN_ON(!atomic_read(&kref->refcount));
  32. atomic_inc(&kref->refcount);
  33. smp_mb__after_atomic_inc();
  34. }
  35. /**
  36. * kref_put - decrement refcount for object.
  37. * @kref: object.
  38. * @release: pointer to the function that will clean up the object when the
  39. * last reference to the object is released.
  40. * This pointer is required, and it is not acceptable to pass kfree
  41. * in as this function.
  42. *
  43. * Decrement the refcount, and if 0, call release().
  44. * Return 1 if the object was removed, otherwise return 0. Beware, if this
  45. * function returns 0, you still can not count on the kref from remaining in
  46. * memory. Only use the return value if you want to see if the kref is now
  47. * gone, not present.
  48. */
  49. int kref_put(struct kref *kref, void (*release)(struct kref *kref))
  50. {
  51. WARN_ON(release == NULL);
  52. WARN_ON(release == (void (*)(struct kref *))kfree);
  53. if (atomic_dec_and_test(&kref->refcount)) {
  54. release(kref);
  55. return 1;
  56. }
  57. return 0;
  58. }
  59. /**
  60. * kref_sub - subtract a number of refcounts for object.
  61. * @kref: object.
  62. * @count: Number of recounts to subtract.
  63. * @release: pointer to the function that will clean up the object when the
  64. * last reference to the object is released.
  65. * This pointer is required, and it is not acceptable to pass kfree
  66. * in as this function.
  67. *
  68. * Subtract @count from the refcount, and if 0, call release().
  69. * Return 1 if the object was removed, otherwise return 0. Beware, if this
  70. * function returns 0, you still can not count on the kref from remaining in
  71. * memory. Only use the return value if you want to see if the kref is now
  72. * gone, not present.
  73. */
  74. int kref_sub(struct kref *kref, unsigned int count,
  75. void (*release)(struct kref *kref))
  76. {
  77. WARN_ON(release == NULL);
  78. WARN_ON(release == (void (*)(struct kref *))kfree);
  79. if (atomic_sub_and_test((int) count, &kref->refcount)) {
  80. release(kref);
  81. return 1;
  82. }
  83. return 0;
  84. }
  85. EXPORT_SYMBOL(kref_init);
  86. EXPORT_SYMBOL(kref_get);
  87. EXPORT_SYMBOL(kref_put);
  88. EXPORT_SYMBOL(kref_sub);