Commit 3b674261 authored by Stephen Boyd's avatar Stephen Boyd Committed by Linus Torvalds
Browse files

lib/idr.c: document calling context for IDA APIs mustn't use locks 



The documentation for these functions indicates that callers don't need to
hold a lock while calling them, but that documentation is only in one
place under "IDA Usage".  Let's state the same information on each IDA
function so that it's clear what the calling context requires.
Furthermore, let's document ida_simple_get() with the same information so
that callers know how this API works.

Signed-off-by: default avatarStephen Boyd <swboyd@chromium.org>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
Reviewed-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Tri Vo <trong@android.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Matthew Wilcox <willy@infradead.org>
Link: https://lkml.kernel.org/r/20200910055246.2297797-1-swboyd@chromium.org


Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent 8d8472cf

include/linux/idr.h

+6 −3
Original line number Diff line number Diff line
@@ -263,7 +263,8 @@ void ida_destroy(struct ida *ida); 
 *

 * Allocate an ID between 0 and %INT_MAX, inclusive.

 *

 * Context: Any context.

 * Context: Any context. It is safe to call this function without

 * locking in your code.

 * Return: The allocated ID, or %-ENOMEM if memory could not be allocated,

 * or %-ENOSPC if there are no free IDs.

 */
@@ -280,7 +281,8 @@ static inline int ida_alloc(struct ida *ida, gfp_t gfp) 
 *

 * Allocate an ID between @min and %INT_MAX, inclusive.

 *

 * Context: Any context.

 * Context: Any context. It is safe to call this function without

 * locking in your code.

 * Return: The allocated ID, or %-ENOMEM if memory could not be allocated,

 * or %-ENOSPC if there are no free IDs.

 */
@@ -297,7 +299,8 @@ static inline int ida_alloc_min(struct ida *ida, unsigned int min, gfp_t gfp) 
 *

 * Allocate an ID between 0 and @max, inclusive.

 *

 * Context: Any context.

 * Context: Any context. It is safe to call this function without

 * locking in your code.

 * Return: The allocated ID, or %-ENOMEM if memory could not be allocated,

 * or %-ENOSPC if there are no free IDs.

 */

lib/idr.c

+6 −3
Original line number Diff line number Diff line
@@ -372,7 +372,8 @@ EXPORT_SYMBOL(idr_replace); 
 * Allocate an ID between @min and @max, inclusive.  The allocated ID will

 * not exceed %INT_MAX, even if @max is larger.

 *

 * Context: Any context.

 * Context: Any context. It is safe to call this function without

 * locking in your code.

 * Return: The allocated ID, or %-ENOMEM if memory could not be allocated,

 * or %-ENOSPC if there are no free IDs.

 */
@@ -479,7 +480,8 @@ EXPORT_SYMBOL(ida_alloc_range); 
 * @ida: IDA handle.

 * @id: Previously allocated ID.

 *

 * Context: Any context.

 * Context: Any context. It is safe to call this function without

 * locking in your code.

 */

void ida_free(struct ida *ida, unsigned int id)

{
@@ -531,7 +533,8 @@ EXPORT_SYMBOL(ida_free); 
 * or freed.  If the IDA is already empty, there is no need to call this

 * function.

 *

 * Context: Any context.

 * Context: Any context. It is safe to call this function without

 * locking in your code.

 */

void ida_destroy(struct ida *ida)

{

CRA Git | Maintained and supported by SUSTech CRA and CCSE