fs-verity: misc cleanups
Subsystems (2)
Eric Biggers
maintainercover fs-verity: misc cleanups
In fs/verity/ and fsverity.h, fix all kerneldoc warnings, and fix some coding style inconsistencies in function declarations.
Eric Biggers (2):
fs-verity: fix all kerneldoc warnings
fs-verity: remove unnecessary extern keywords
fs/verity/enable.c | 2 ++ fs/verity/fsverity_private.h | 4 ++-- fs/verity/measure.c | 2 ++ fs/verity/open.c | 1 + fs/verity/signature.c | 3 +++ fs/verity/verify.c | 3 +++ include/linux/fsverity.h | 19 +++++++++++-------- 7 files changed, 24 insertions(+), 10 deletions(-)
Signature · 1 line
2.26.2
Eric Biggers
maintainerPATCH 1/2 fs-verity: fix all kerneldoc warnings
From: Eric Biggers <[email protected]>
Fix all kerneldoc warnings in fs/verity/ and include/linux/fsverity.h. Most of these were due to missing documentation for function parameters.
Detected with:
scripts/kernel-doc -v -none fs/verity/*.{c,h} include/linux/fsverity.h
This cleanup makes it possible to check new patches for kerneldoc warnings without having to filter out all the existing ones.
--- fs/verity/enable.c | 2 ++ fs/verity/fsverity_private.h | 2 +- fs/verity/measure.c | 2 ++ fs/verity/open.c | 1 + fs/verity/signature.c | 3 +++ fs/verity/verify.c | 3 +++ include/linux/fsverity.h | 3 +++ 7 files changed, 15 insertions(+), 1 deletion(-)
fs/verity/enable.c +2 -0
@@ -329,6 +329,8 @@ static int enable_verity(struct file *filp,/** * fsverity_ioctl_enable() - enable verity on a file +* @filp: file to enable verity on +* @uarg: user pointer to fsverity_enable_arg * * Enable fs-verity on a file. See the "FS_IOC_ENABLE_VERITY" section of * Documentation/filesystems/fsverity.rst for the documentation.
fs/verity/fsverity_private.h +1 -1
@@ -61,7 +61,7 @@ struct merkle_tree_params {u64 level_start[FS_VERITY_MAX_LEVELS ]; }; -/** +/* * fsverity_info - cached verity metadata for an inode * * When a verity file is first opened, an instance of this struct is allocated
fs/verity/measure.c +2 -0
@@ -11,6 +11,8 @@/** * fsverity_ioctl_measure() - get a verity file's measurement +* @filp: file to get measurement of +* @_uarg: user pointer to fsverity_digest * * Retrieve the file measurement that the kernel is enforcing for reads from a * verity file. See the "FS_IOC_MEASURE_VERITY" section of
fs/verity/open.c +1 -0
@@ -330,6 +330,7 @@ EXPORT_SYMBOL_GPL(fsverity_prepare_setattr);/** * fsverity_cleanup_inode() - free the inode's verity info, if present +* @inode: an inode being evicted * * Filesystems must call this on inode eviction to free ->i_verity_info. */
fs/verity/signature.c +3 -0
@@ -28,6 +28,9 @@ static struct key *fsverity_keyring;/** * fsverity_verify_signature() - check a verity file's signature +* @vi: the file's fsverity_info +* @desc: the file's fsverity_descriptor +* @desc_size: size of @desc * * If the file's fs-verity descriptor includes a signature of the file * measurement, verify it against the certificates in the fs-verity keyring.
fs/verity/verify.c +3 -0
@@ -179,6 +179,7 @@ static bool verify_page(struct inode *inode, const struct fsverity_info *vi,/** * fsverity_verify_page() - verify a data page +* @page: the page to verity * * Verify a page that has just been read from a verity file. The page must be a * pagecache page that is still locked and not yet uptodate.
@@ -206,6 +207,7 @@ EXPORT_SYMBOL_GPL(fsverity_verify_page);#ifdef CONFIG_BLOCK /** * fsverity_verify_bio() - verify a 'read' bio that has just completed +* @bio: the bio to verify * * Verify a set of pages that have just been read from a verity file. The pages * must be pagecache pages that are still locked and not yet uptodate. Pages
@@ -264,6 +266,7 @@ EXPORT_SYMBOL_GPL(fsverity_verify_bio);/** * fsverity_enqueue_verify_work() - enqueue work on the fs-verity workqueue +* @work: the work to enqueue * * Enqueue verification work for asynchronous processing. */
include/linux/fsverity.h +3 -0
@@ -200,6 +200,7 @@ static inline void fsverity_enqueue_verify_work(struct work_struct *work)/** * fsverity_active() - do reads from the inode need to go through fs-verity? +* @inode: inode to check * * This checks whether ->i_verity_info has been set. *
@@ -207,6 +208,8 @@ static inline void fsverity_enqueue_verify_work(struct work_struct *work)* be verified or not. Don't use IS_VERITY() for this purpose; it's subject to * a race condition where the file is being read concurrently with * FS_IOC_ENABLE_VERITY completing. (S_VERITY is set before ->i_verity_info.) +* +* Return: true if reads need to go through fs-verity, otherwise false */ static inline bool fsverity_active (const struct inode *inode) {
Signature · 1 line
2.26.2
Eric Biggers
maintainerPATCH 2/2 fs-verity: remove unnecessary extern keywords
In reply to Eric BiggersFrom: Eric Biggers <[email protected]>
Remove the unnecessary 'extern' keywords from function declarations. This makes it so that we don't have a mix of both styles, so it won't be ambiguous what to use in new fs-verity patches. This also makes the code shorter and matches the 'checkpatch --strict' expectation.
--- fs/verity/fsverity_private.h | 2 +- include/linux/fsverity.h | 16 ++++++++-------- 2 files changed, 9 insertions(+), 9 deletions(-)
fs/verity/fsverity_private.h +1 -1
@@ -134,7 +134,7 @@ void __init fsverity_check_hash_algs(void);/* init.c */ -extern void __printf(3, 4) __cold +void __printf(3, 4) __cold fsverity_msg(const struct inode *inode, const char *level, const char *fmt, ...);
include/linux/fsverity.h +8 -8
@@ -121,23 +121,23 @@ static inline struct fsverity_info *fsverity_get_info(const struct inode *inode)/* enable.c */ -extern int fsverity_ioctl_enable (struct file *filp,const void __user *arg); +int fsverity_ioctl_enable (struct file *filp,const void __user *arg);/* measure.c */ -extern int fsverity_ioctl_measure (struct file *filp,void __user *arg); +int fsverity_ioctl_measure (struct file *filp,void __user *arg);/* open.c */ -extern int fsverity_file_open (struct inode *inode,struct file *filp); -extern int fsverity_prepare_setattr (struct dentry *dentry,struct iattr *attr); -extern void fsverity_cleanup_inode (struct inode *inode); +int fsverity_file_open (struct inode *inode,struct file *filp); +int fsverity_prepare_setattr (struct dentry *dentry,struct iattr *attr); +void fsverity_cleanup_inode (struct inode *inode);/* verify.c */ -extern bool fsverity_verify_page (struct page *page); -extern void fsverity_verify_bio (struct bio *bio); -extern void fsverity_enqueue_verify_work (struct work_struct *work); +bool fsverity_verify_page (struct page *page); +void fsverity_verify_bio (struct bio *bio); +void fsverity_enqueue_verify_work (struct work_struct *work);#else /* !CONFIG_FS_VERITY */
Signature · 8 lines
2.26.2 _______________________________________________ Linux-f2fs-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/linux-f2fs-devel
Eric Biggers
maintainerQuoted 7 lines · Eric Biggers
In
fs/verity/andfsverity.h, fix all kerneldoc warnings, and fix some coding style inconsistencies in function declarations.Eric Biggers (2):
fs-verity: fix all kerneldoc warnings
fs-verity: remove unnecessary extern keywords
Quoted 9 lines
fs/verity/enable.c | 2 ++ fs/verity/fsverity_private.h | 4 ++-- fs/verity/measure.c | 2 ++ fs/verity/open.c | 1 + fs/verity/signature.c | 3 +++ fs/verity/verify.c | 3 +++ include/linux/fsverity.h | 19 +++++++++++-------- 7 files changed, 24 insertions(+), 10 deletions(-)
All applied to fscrypt.git#fsverity for 5.8.
- Eric