Commit 599b4e29 authored by Randy Dunlap's avatar Randy Dunlap Committed by Andrew Morton
Browse files

mm/mmu_notifier: clean up mmu_notifier.h kernel-doc 

Eliminate kernel-doc warnings in mmu_notifier.h:
- add a missing struct short description
- use the correct format for function parameters
- add missing function return comment sections

Warning: include/linux/mmu_notifier.h:236 missing initial short
 description on line: * struct mmu_interval_notifier_ops
Warning: include/linux/mmu_notifier.h:325 function parameter 'interval_sub'
 not described in 'mmu_interval_set_seq'
Warning: include/linux/mmu_notifier.h:325 function parameter 'cur_seq'
 not described in 'mmu_interval_set_seq'
Warning: include/linux/mmu_notifier.h:346 function parameter 'interval_sub'
 not described in 'mmu_interval_read_retry'
Warning: include/linux/mmu_notifier.h:346 function parameter 'seq' not
 described in 'mmu_interval_read_retry'
Warning: include/linux/mmu_notifier.h:346 No description found for return
 value of 'mmu_interval_read_retry'
Warning: include/linux/mmu_notifier.h:370 function parameter 'interval_sub'
 not described in 'mmu_interval_check_retry'
Warning: include/linux/mmu_notifier.h:370 function parameter 'seq' not
 described in 'mmu_interval_check_retry'
Warning: include/linux/mmu_notifier.h:370 No description found for return
 value of 'mmu_interval_check_retry'

Link: https://lkml.kernel.org/r/20260302005222.3470783-1-rdunlap@infradead.org


Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Reviewed-by: default avatarJason Gunthorpe <jgg@nvidia.com>
Cc: David Hildenbrand <david@kernel.org>
Cc: "Liam R. Howlett" <Liam.Howlett@oracle.com>
Cc: Lorenzo Stoakes <lorenzo.stoakes@oracle.com>
Cc: Michal Hocko <mhocko@suse.com>
Cc: Mike Rapoport <rppt@kernel.org>
Cc: Randy Dunlap <rdunlap@infradead.org>
Cc: Suren Baghdasaryan <surenb@google.com>
Cc: Vlastimil Babka <vbabka@suse.cz>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
parent 7392f8e4

include/linux/mmu_notifier.h

+16 −15
Original line number Diff line number Diff line
@@ -234,7 +234,7 @@ struct mmu_notifier { 
};



/**

 * struct mmu_interval_notifier_ops

 * struct mmu_interval_notifier_ops - callback for range notification

 * @invalidate: Upon return the caller must stop using any SPTEs within this

 *              range. This function can sleep. Return false only if sleeping

 *              was required but mmu_notifier_range_blockable(range) is false.
@@ -309,8 +309,8 @@ void mmu_interval_notifier_remove(struct mmu_interval_notifier *interval_sub); 


/**

 * mmu_interval_set_seq - Save the invalidation sequence

 * @interval_sub - The subscription passed to invalidate

 * @cur_seq - The cur_seq passed to the invalidate() callback

 * @interval_sub: The subscription passed to invalidate

 * @cur_seq: The cur_seq passed to the invalidate() callback

 *

 * This must be called unconditionally from the invalidate callback of a

 * struct mmu_interval_notifier_ops under the same lock that is used to call
@@ -329,8 +329,8 @@ mmu_interval_set_seq(struct mmu_interval_notifier *interval_sub, 


/**

 * mmu_interval_read_retry - End a read side critical section against a VA range

 * interval_sub: The subscription

 * seq: The return of the paired mmu_interval_read_begin()

 * @interval_sub: The subscription

 * @seq: The return of the paired mmu_interval_read_begin()

 *

 * This MUST be called under a user provided lock that is also held

 * unconditionally by op->invalidate() when it calls mmu_interval_set_seq().
@@ -338,7 +338,7 @@ mmu_interval_set_seq(struct mmu_interval_notifier *interval_sub, 
 * Each call should be paired with a single mmu_interval_read_begin() and

 * should be used to conclude the read side.

 *

 * Returns true if an invalidation collided with this critical section, and

 * Returns: true if an invalidation collided with this critical section, and

 * the caller should retry.

 */

static inline bool
@@ -350,20 +350,21 @@ mmu_interval_read_retry(struct mmu_interval_notifier *interval_sub, 


/**

 * mmu_interval_check_retry - Test if a collision has occurred

 * interval_sub: The subscription

 * seq: The return of the matching mmu_interval_read_begin()

 * @interval_sub: The subscription

 * @seq: The return of the matching mmu_interval_read_begin()

 *

 * This can be used in the critical section between mmu_interval_read_begin()

 * and mmu_interval_read_retry().  A return of true indicates an invalidation

 * has collided with this critical region and a future

 * mmu_interval_read_retry() will return true.

 *

 * False is not reliable and only suggests a collision may not have

 * occurred. It can be called many times and does not have to hold the user

 * provided lock.

 * and mmu_interval_read_retry().

 *

 * This call can be used as part of loops and other expensive operations to

 * expedite a retry.

 * It can be called many times and does not have to hold the user

 * provided lock.

 *

 * Returns: true indicates an invalidation has collided with this critical

 * region and a future mmu_interval_read_retry() will return true.

 * False is not reliable and only suggests a collision may not have

 * occurred.

 */

static inline bool

mmu_interval_check_retry(struct mmu_interval_notifier *interval_sub,