bpf: fix missing kdoc string fields in cpumask.c

Some bpf_cpumask-related kfuncs have kdoc strings that are missing
return values. Add a the missing descriptions for the return values.

Reported-by: Alexei Starovoitov <ast@kernel.org>
Signed-off-by: Emil Tsalapatis (Meta) <emil@etsalapatis.com>
Acked-by: Hou Tao <houtao1@huawei.com>
Link: https://lore.kernel.org/r/20250309230427.26603-4-emil@etsalapatis.com
Signed-off-by: Alexei Starovoitov <ast@kernel.org>
This commit is contained in:
Emil Tsalapatis 2025-03-09 19:04:26 -04:00 committed by Alexei Starovoitov
parent 918ba2636d
commit 014eb5c2d6
1 changed files with 20 additions and 0 deletions

View File

@ -45,6 +45,10 @@ __bpf_kfunc_start_defs();
* *
* bpf_cpumask_create() allocates memory using the BPF memory allocator, and * bpf_cpumask_create() allocates memory using the BPF memory allocator, and
* will not block. It may return NULL if no memory is available. * will not block. It may return NULL if no memory is available.
*
* Return:
* * A pointer to a new struct bpf_cpumask instance on success.
* * NULL if the BPF memory allocator is out of memory.
*/ */
__bpf_kfunc struct bpf_cpumask *bpf_cpumask_create(void) __bpf_kfunc struct bpf_cpumask *bpf_cpumask_create(void)
{ {
@ -71,6 +75,10 @@ __bpf_kfunc struct bpf_cpumask *bpf_cpumask_create(void)
* Acquires a reference to a BPF cpumask. The cpumask returned by this function * Acquires a reference to a BPF cpumask. The cpumask returned by this function
* must either be embedded in a map as a kptr, or freed with * must either be embedded in a map as a kptr, or freed with
* bpf_cpumask_release(). * bpf_cpumask_release().
*
* Return:
* * The struct bpf_cpumask pointer passed to the function.
*
*/ */
__bpf_kfunc struct bpf_cpumask *bpf_cpumask_acquire(struct bpf_cpumask *cpumask) __bpf_kfunc struct bpf_cpumask *bpf_cpumask_acquire(struct bpf_cpumask *cpumask)
{ {
@ -106,6 +114,9 @@ CFI_NOSEAL(bpf_cpumask_release_dtor);
* *
* Find the index of the first nonzero bit of the cpumask. A struct bpf_cpumask * Find the index of the first nonzero bit of the cpumask. A struct bpf_cpumask
* pointer may be safely passed to this function. * pointer may be safely passed to this function.
*
* Return:
* * The index of the first nonzero bit in the struct cpumask.
*/ */
__bpf_kfunc u32 bpf_cpumask_first(const struct cpumask *cpumask) __bpf_kfunc u32 bpf_cpumask_first(const struct cpumask *cpumask)
{ {
@ -119,6 +130,9 @@ __bpf_kfunc u32 bpf_cpumask_first(const struct cpumask *cpumask)
* *
* Find the index of the first unset bit of the cpumask. A struct bpf_cpumask * Find the index of the first unset bit of the cpumask. A struct bpf_cpumask
* pointer may be safely passed to this function. * pointer may be safely passed to this function.
*
* Return:
* * The index of the first zero bit in the struct cpumask.
*/ */
__bpf_kfunc u32 bpf_cpumask_first_zero(const struct cpumask *cpumask) __bpf_kfunc u32 bpf_cpumask_first_zero(const struct cpumask *cpumask)
{ {
@ -133,6 +147,9 @@ __bpf_kfunc u32 bpf_cpumask_first_zero(const struct cpumask *cpumask)
* *
* Find the index of the first nonzero bit of the AND of two cpumasks. * Find the index of the first nonzero bit of the AND of two cpumasks.
* struct bpf_cpumask pointers may be safely passed to @src1 and @src2. * struct bpf_cpumask pointers may be safely passed to @src1 and @src2.
*
* Return:
* * The index of the first bit that is nonzero in both cpumask instances.
*/ */
__bpf_kfunc u32 bpf_cpumask_first_and(const struct cpumask *src1, __bpf_kfunc u32 bpf_cpumask_first_and(const struct cpumask *src1,
const struct cpumask *src2) const struct cpumask *src2)
@ -414,6 +431,9 @@ __bpf_kfunc u32 bpf_cpumask_any_and_distribute(const struct cpumask *src1,
* @cpumask: The cpumask being queried. * @cpumask: The cpumask being queried.
* *
* Count the number of set bits in the given cpumask. * Count the number of set bits in the given cpumask.
*
* Return:
* * The number of bits set in the mask.
*/ */
__bpf_kfunc u32 bpf_cpumask_weight(const struct cpumask *cpumask) __bpf_kfunc u32 bpf_cpumask_weight(const struct cpumask *cpumask)
{ {