linux-toradex.git/include/linux/kref.h, branch v6.16-rc6

kref: Improve documentation

2024-12-13T15:49:31+00:00

There is already kernel-doc written for many of the functions in kref.h
but it's not linked into the html docs anywhere.  Add it to kref.rst.

Improve the kref documentation by using the standard Return: section,
rewording some unclear verbiage and adding docs for some undocumented
functions.

Update Thomas' email address to his current one.

Signed-off-by: Matthew Wilcox (Oracle) 
Tested-by: Randy Dunlap 
Acked-by: Randy Dunlap 
Signed-off-by: Jonathan Corbet 
Link: https://lore.kernel.org/r/20241209160953.757673-1-willy@infradead.org

treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 428

2019-06-05T15:37:16+00:00

Based on 1 normalized pattern(s):

  this file is released under the gplv2

extracted by the scancode license scanner the SPDX license identifier

  GPL-2.0-only

has been chosen to replace the boilerplate/reference in 68 file(s).

Signed-off-by: Thomas Gleixner 
Reviewed-by: Armijn Hemel 
Reviewed-by: Allison Randal 
Cc: linux-spdx@vger.kernel.org
Link: https://lkml.kernel.org/r/20190531190114.292346262@linutronix.de
Signed-off-by: Greg Kroah-Hartman

kref/kobject: Improve documentation

2018-12-06T12:57:03+00:00

The current kref and kobject documentation may be
insufficient to understand these common pitfalls regarding
object lifetime and object releasing.

Add a bit more documentation and improve the warnings
seen by the user, pointing to the right piece of documentation.

Also, it's important to understand that making fun of people
publicly is not at all helpful, doesn't provide any value,
and it's not a healthy way of encouraging developers to do better.

"Mocking mercilessly" will, if anything, make developers feel bad
and go away. This kind of behavior should not be encouraged or justified.

Signed-off-by: Ezequiel Garcia 
Signed-off-by: Enric Balletbo i Serra 
Signed-off-by: Gustavo Padovan 
Signed-off-by: Matthias Brugger 
Acked-by: Daniel Vetter 
Acked-by: Guenter Roeck 
Signed-off-by: Greg Kroah-Hartman

kref: remove WARN_ON for NULL release functions

2017-05-09T00:15:14+00:00

The kref functions check for NULL release functions.  This WARN_ON seems
rather pointless.  We will eventually release and then just crash
nicely.  It is also somewhat expensive because these functions are
inlined in a lot of places.  Removing the WARN_ONs saves around 2.3k in
this kernel (likely more in others with more drivers)

     text    data     bss     dec     hex filename
  9083992 5367600 11116544        25568136        1862388 vmlinux-before-load-avg
  9070166 5367600 11116544        25554310        185ed86 vmlinux-load-avg

Link: http://lkml.kernel.org/r/20170315021431.13107-5-andi@firstfloor.org
Signed-off-by: Andi Kleen 
Acked-by: Greg Kroah-Hartman 
Signed-off-by: Andrew Morton 
Signed-off-by: Linus Torvalds

kref: Implement 'struct kref' using refcount_t

2017-02-10T08:04:19+00:00

Use the refcount_t 'atomic' type to implement 'struct kref', this makes kref
more robust by bringing saturation semantics.

Signed-off-by: Peter Zijlstra (Intel) 
Acked-by: Greg Kroah-Hartman 
Cc: Linus Torvalds 
Cc: Peter Zijlstra 
Cc: Thomas Gleixner 
Signed-off-by: Ingo Molnar

locking/atomic, kref: Implement kref_put_lock()

2017-01-18T09:03:29+00:00

Because home-rolling your own is _awesome_, stop doing it. Provide
kref_put_lock(), just like kref_put_mutex() but for a spinlock.

Signed-off-by: Peter Zijlstra (Intel) 
Cc: Andrew Morton 
Cc: Greg Kroah-Hartman 
Cc: Linus Torvalds 
Cc: Paul E. McKenney 
Cc: Peter Zijlstra 
Cc: Thomas Gleixner 
Cc: linux-kernel@vger.kernel.org
Signed-off-by: Ingo Molnar

locking/atomic, kref: Kill kref_sub()

2017-01-14T10:37:19+00:00

By general sentiment kref_sub() is a bad interface, make it go away.

Signed-off-by: Peter Zijlstra (Intel) 
Cc: Andrew Morton 
Cc: Greg Kroah-Hartman 
Cc: Linus Torvalds 
Cc: Paul E. McKenney 
Cc: Peter Zijlstra 
Cc: Thomas Gleixner 
Cc: linux-kernel@vger.kernel.org
Signed-off-by: Ingo Molnar

locking/atomic, kref: Add kref_read()

2017-01-14T10:37:18+00:00

Since we need to change the implementation, stop exposing internals.

Provide kref_read() to read the current reference count; typically
used for debug messages.

Kills two anti-patterns:

	atomic_read(&kref->refcount)
	kref->refcount.counter

Signed-off-by: Peter Zijlstra (Intel) 
Cc: Andrew Morton 
Cc: Greg Kroah-Hartman 
Cc: Linus Torvalds 
Cc: Paul E. McKenney 
Cc: Peter Zijlstra 
Cc: Thomas Gleixner 
Cc: linux-kernel@vger.kernel.org
Signed-off-by: Ingo Molnar

locking/atomic, kref: Add KREF_INIT()

2017-01-14T10:37:18+00:00

Since we need to change the implementation, stop exposing internals.

Provide KREF_INIT() to allow static initialization of struct kref.

Signed-off-by: Peter Zijlstra (Intel) 
Cc: Andrew Morton 
Cc: Greg Kroah-Hartman 
Cc: Linus Torvalds 
Cc: Paul E. McKenney 
Cc: Peter Zijlstra 
Cc: Thomas Gleixner 
Cc: linux-kernel@vger.kernel.org
Signed-off-by: Ingo Molnar

kref: Remove kref_put_spinlock_irqsave()

2015-11-29T03:33:29+00:00

The last user is gone. Hence remove this function.

Signed-off-by: Bart Van Assche 
Cc: Greg Kroah-Hartman 
Cc: Christoph Hellwig 
Cc: Joern Engel 
Signed-off-by: Nicholas Bellinger