Commit bd59f617 authored by Borislav Petkov (AMD)'s avatar Borislav Petkov (AMD) Committed by Ingo Molnar
Browse files

futex: Fix kernel-doc comments 



Fix those:

  ./kernel/futex/futex.h:208: warning: Function parameter or struct member 'drop_hb_ref' not described in 'futex_q'
  ./kernel/futex/waitwake.c:343: warning: expecting prototype for futex_wait_queue(). Prototype was for futex_do_wait() instead
  ./kernel/futex/waitwake.c:594: warning: Function parameter or struct member 'task' not described in 'futex_wait_setup'

Fixes: 93f1b6d7 ("futex: Move futex_queue() into futex_wait_setup()")
Reported-by: default avatarStephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: default avatarBorislav Petkov (AMD) <bp@alien8.de>
Signed-off-by: default avatarIngo Molnar <mingo@kernel.org>
Acked-by: default avatarSebastian Andrzej Siewior <bigeasy@linutronix.de>
Cc: Thomas Gleixner <tglx@linutronix.de>
Cc: Peter Zijlstra <peterz@infradead.org>
Link: https://lore.kernel.org/r/20250512185641.0450a99b@canb.auug.org.au # report
Link: https://lore.kernel.org/r/20250515171641.24073-1-bp@kernel.org     # submission
parent 094ac8cf

kernel/futex/futex.h

+1 −0
Original line number Diff line number Diff line
@@ -175,6 +175,7 @@ typedef void (futex_wake_fn)(struct wake_q_head *wake_q, struct futex_q *q); 
 * @requeue_pi_key:	the requeue_pi target futex key

 * @bitset:		bitset for the optional bitmasked wakeup

 * @requeue_state:	State field for futex_requeue_pi()

 * @drop_hb_ref:	Waiter should drop the extra hash bucket reference if true

 * @requeue_wait:	RCU wait for futex_requeue_pi() (RT only)

 *

 * We use this hashed waitqueue, instead of a normal wait_queue_entry_t, so

kernel/futex/waitwake.c

+2 −3
Original line number Diff line number Diff line
@@ -334,8 +334,7 @@ int futex_wake_op(u32 __user *uaddr1, unsigned int flags, u32 __user *uaddr2, 
static long futex_wait_restart(struct restart_block *restart);



/**

 * futex_wait_queue() - futex_queue() and wait for wakeup, timeout, or signal

 * @hb:		the futex hash bucket, must be locked by the caller

 * futex_do_wait() - wait for wakeup, timeout, or signal

 * @q:		the futex_q to queue up on

 * @timeout:	the prepared hrtimer_sleeper, or null for no timeout

 */
@@ -578,7 +577,7 @@ int futex_wait_multiple(struct futex_vector *vs, unsigned int count, 
 * @flags:	futex flags (FLAGS_SHARED, etc.)

 * @q:		the associated futex_q

 * @key2:	the second futex_key if used for requeue PI

 * task:	Task queueing this futex

 * @task:	Task queueing this futex

 *

 * Setup the futex_q and locate the hash_bucket.  Get the futex value and

 * compare it with the expected value.  Handle atomic faults internally.