Add traces and file attributes for fs-verity
cover Add traces and file attributes for fs-verity
Hi all,
This two small patches grew from fs-verity XFS patchset. I think they're self-contained improvements which could go without XFS implementation.
Andrey Albershteyn <[email protected]>:
fs: add FS_XFLAG_VERITY for fs-verity files
fsverity: add tracepoints
Diffstat:
Documentation/filesystems/fsverity.rst | 16 ++++++++++++++++ MAINTAINERS | 1 + fs/file_attr.c | 4 ++++ fs/verity/enable.c | 4 ++++ fs/verity/fsverity_private.h | 2 ++ fs/verity/init.c | 1 + fs/verity/verify.c | 9 +++++++++ include/linux/fileattr.h | 2 +- include/trace/events/fsverity.h | 143 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ include/uapi/linux/fs.h | 1 + 10 files changed, 182 insertions(+), 1 deletion(-)
Signature · 1 line
- Andrey
PATCH 1/2 fs: add FS_XFLAG_VERITY for fs-verity files
fs-verity introduced inode flag for inodes with enabled fs-verity on them. This patch adds FS_XFLAG_VERITY file attribute which can be retrieved with FS_IOC_FSGETXATTR ioctl() and file_getattr() syscall. This flag is read-only and can not be set with corresponding set ioctl() and file_setattr().
--- Documentation/filesystems/fsverity.rst | 16 ++++++++++++++++ fs/file_attr.c | 4 ++++ include/linux/fileattr.h | 2 +- include/uapi/linux/fs.h | 1 + 4 files changed, 22 insertions(+), 1 deletion(-)
Documentation/filesystems/fsverity.rst +16 -0
@@ -341,6 +341,22 @@ FS_IOC_GETFLAGS and FS_IOC_MEASURE_VERITY because it doesn't require opening the file, and opening verity files can be expensive. +FS_IOC_FSGETXATTR +----------------- + +Since Linux v6.19, the FS_IOC_FSGETXATTR ioctl sets FS_XFLAG_VERITY (0x00020000) +in the returned flags when the file has verity enabled. Note that this attribute +cannot be set with FS_IOC_FSSETXATTR as enabling verity requires input +parameters. See FS_IOC_ENABLE_VERITY. + +file_getattr +------------ + +Since Linux v6.19, the file_getattr() syscall sets FS_XFLAG_VERITY (0x00020000) +in the returned flags when the file has verity enabled. Note that this attribute +cannot be set with file_setattr() as enabling verity requires input parameters. +See FS_IOC_ENABLE_VERITY. + .. _accessing_verity_files: Accessing verity files
fs/file_attr.c +4 -0
@@ -37,6 +37,8 @@ fa->flags |=FS_DAX_FL ;if (fa->fsx_xflags &FS_XFLAG_PROJINHERIT ) fa->flags |=FS_PROJINHERIT_FL ; +if (fa->fsx_xflags &FS_XFLAG_VERITY ) + fa->flags |=FS_VERITY_FL ; }EXPORT_SYMBOL (fileattr_fill_xflags);
@@ -67,6 +69,8 @@ fa->fsx_xflags |=FS_XFLAG_DAX ;if (fa->flags &FS_PROJINHERIT_FL ) fa->fsx_xflags |=FS_XFLAG_PROJINHERIT ; +if (fa->flags &FS_VERITY_FL ) + fa->fsx_xflags |=FS_XFLAG_VERITY ; }EXPORT_SYMBOL (fileattr_fill_flags);
include/linux/fileattr.h +1 -1
@@ -16,7 +16,7 @@/* Read-only inode flags */ #define FS_XFLAG_RDONLY_MASK \ - (FS_XFLAG_PREALLOC | FS_XFLAG_HASATTR) + (FS_XFLAG_PREALLOC | FS_XFLAG_HASATTR | FS_XFLAG_VERITY)/* Flags to indicate valid value of fsx_ fields */ #define FS_XFLAG_VALUES_MASK \
include/uapi/linux/fs.h +1 -0
@@ -253,6 +253,7 @@#define FS_XFLAG_FILESTREAM 0x00004000/* use filestream allocator */ #define FS_XFLAG_DAX 0x00008000/* use DAX for IO */ #define FS_XFLAG_COWEXTSIZE 0x00010000/* CoW extent size allocator hint */ +#define FS_XFLAG_VERITY 0x00020000/* fs-verity enabled */ #define FS_XFLAG_HASATTR 0x80000000/* no DIFLAG for this */ /* the read-only stuff doesn't really belong here, but any other place is
Signature · 1 line
- Andrey
Re: [PATCH 1/2] fs: add FS_XFLAG_VERITY for fs-verity files
Quoted 19 lines · Andrey Albershteyn
fs-verity introduced inode flag for inodes with enabled fs-verity on them. This patch adds
FS_XFLAG_VERITYfile attribute which can be retrieved withFS_IOC_FSGETXATTRioctl()andfile_getattr()syscall. This flag is read-only and can not be set with corresponding setioctl()andfile_setattr().Signed-off-by Andrey Albershteyn <[email protected]>--- Documentation/filesystems/fsverity.rst | 16 ++++++++++++++++ fs/file_attr.c | 4 ++++ include/linux/fileattr.h | 2 +- include/uapi/linux/fs.h | 1 + 4 files changed, 22 insertions(+), 1 deletion(-)Documentation/filesystems/fsverity.rst +0
-0
Documentation/filesystems/fsverity.rst line 347
Quoted 7 lines
Documentation/filesystems/fsverity.rst +4
-0@@ -341,6 +341,22 @@ FS_IOC_GETFLAGS and FS_IOC_MEASURE_VERITY because it doesn't require opening the file, and opening verity files can be expensive. +FS_IOC_FSGETXATTR +----------------- + +Since Linux v6.19, the FS_IOC_FSGETXATTR ioctl sets FS_XFLAG_VERITY (0x00020000)
We're headed to v7.0 now, please update that.
Quoted 55 lines
Documentation/filesystems/fsverity.rst +12
-0+in the returned flags when the file has verity enabled. Note that this attribute +cannot be set with FS_IOC_FSSETXATTR as enabling verity requires input +parameters. See FS_IOC_ENABLE_VERITY. + +file_getattr +------------ + +Since Linux v6.19, the file_getattr() syscall sets FS_XFLAG_VERITY (0x00020000) +in the returned flags when the file has verity enabled. Note that this attribute +cannot be set with file_setattr() as enabling verity requires input parameters. +See FS_IOC_ENABLE_VERITY. + .. _accessing_verity_files: Accessing verity filesfs/file_attr.c +4
-0@@ -37,6 +37,8 @@ fa->flags |=FS_DAX_FL ;if (fa->fsx_xflags &FS_XFLAG_PROJINHERIT ) fa->flags |=FS_PROJINHERIT_FL ; +if (fa->fsx_xflags &FS_XFLAG_VERITY ) + fa->flags |=FS_VERITY_FL ; }EXPORT_SYMBOL (fileattr_fill_xflags);@@ -67,6 +69,8 @@ fa->fsx_xflags |=FS_XFLAG_DAX ;if (fa->flags &FS_PROJINHERIT_FL ) fa->fsx_xflags |=FS_XFLAG_PROJINHERIT ; +if (fa->flags &FS_VERITY_FL ) + fa->fsx_xflags |=FS_XFLAG_VERITY ; }EXPORT_SYMBOL (fileattr_fill_flags);include/linux/fileattr.h +1
-1@@ -16,7 +16,7 @@/* Read-only inode flags */ #define FS_XFLAG_RDONLY_MASK \ - (FS_XFLAG_PREALLOC | FS_XFLAG_HASATTR) + (FS_XFLAG_PREALLOC | FS_XFLAG_HASATTR | FS_XFLAG_VERITY)/* Flags to indicate valid value of fsx_ fields */ #define FS_XFLAG_VALUES_MASK \include/uapi/linux/fs.h +0
-0
include/uapi/linux/fs.h line 256
Quoted 4 lines
include/uapi/linux/fs.h +1
-0@@ -253,6 +253,7 @@#define FS_XFLAG_FILESTREAM 0x00004000/* use filestream allocator */ #define FS_XFLAG_DAX 0x00008000/* use DAX for IO */ #define FS_XFLAG_COWEXTSIZE 0x00010000/* CoW extent size allocator hint */ +#define FS_XFLAG_VERITY 0x00020000/* fs-verity enabled */
Is the indentation broken ^^^^^^^^ here?
Otherwise this looks fine to me.
--D
Quoted 7 lines
include/uapi/linux/fs.h +0
-0#define FS_XFLAG_HASATTR 0x80000000/* no DIFLAG for this */ /* the read-only stuff doesn't really belong here, but any other place is Signature · 2 lines
-- - Andrey
Re: [PATCH 1/2] fs: add FS_XFLAG_VERITY for fs-verity files
Quoted 78 lines · Darrick J. Wong
Quoted 19 lines · Andrey Albershteyn
fs-verity introduced inode flag for inodes with enabled fs-verity on them. This patch adds
FS_XFLAG_VERITYfile attribute which can be retrieved withFS_IOC_FSGETXATTRioctl()andfile_getattr()syscall. This flag is read-only and can not be set with corresponding setioctl()andfile_setattr().Signed-off-by Andrey Albershteyn <[email protected]>--- Documentation/filesystems/fsverity.rst | 16 ++++++++++++++++ fs/file_attr.c | 4 ++++ include/linux/fileattr.h | 2 +- include/uapi/linux/fs.h | 1 + 4 files changed, 22 insertions(+), 1 deletion(-)Documentation/filesystems/fsverity.rst +0
-0Documentation/filesystems/fsverity.rst line 347
Quoted 7 lines
Documentation/filesystems/fsverity.rst +4
-0@@ -341,6 +341,22 @@ FS_IOC_GETFLAGS and FS_IOC_MEASURE_VERITY because it doesn't require opening the file, and opening verity files can be expensive. +FS_IOC_FSGETXATTR +----------------- + +Since Linux v6.19, the FS_IOC_FSGETXATTR ioctl sets FS_XFLAG_VERITY (0x00020000)We're headed to v7.0 now, please update that.
Quoted 48 lines
Documentation/filesystems/fsverity.rst +12
-0+in the returned flags when the file has verity enabled. Note that this attribute +cannot be set with FS_IOC_FSSETXATTR as enabling verity requires input +parameters. See FS_IOC_ENABLE_VERITY. + +file_getattr +------------ + +Since Linux v6.19, the file_getattr() syscall sets FS_XFLAG_VERITY (0x00020000) +in the returned flags when the file has verity enabled. Note that this attribute +cannot be set with file_setattr() as enabling verity requires input parameters. +See FS_IOC_ENABLE_VERITY. + .. _accessing_verity_files: Accessing verity filesfs/file_attr.c +4
-0@@ -37,6 +37,8 @@ fa->flags |=FS_DAX_FL ;if (fa->fsx_xflags &FS_XFLAG_PROJINHERIT ) fa->flags |=FS_PROJINHERIT_FL ; +if (fa->fsx_xflags &FS_XFLAG_VERITY ) + fa->flags |=FS_VERITY_FL ; }EXPORT_SYMBOL (fileattr_fill_xflags);@@ -67,6 +69,8 @@ fa->fsx_xflags |=FS_XFLAG_DAX ;if (fa->flags &FS_PROJINHERIT_FL ) fa->fsx_xflags |=FS_XFLAG_PROJINHERIT ; +if (fa->flags &FS_VERITY_FL ) + fa->fsx_xflags |=FS_XFLAG_VERITY ; }EXPORT_SYMBOL (fileattr_fill_flags);include/linux/fileattr.h +1
-1@@ -16,7 +16,7 @@/* Read-only inode flags */ #define FS_XFLAG_RDONLY_MASK \ - (FS_XFLAG_PREALLOC | FS_XFLAG_HASATTR) + (FS_XFLAG_PREALLOC | FS_XFLAG_HASATTR | FS_XFLAG_VERITY)
Quoted 13 lines
include/uapi/linux/fs.h line 256
Quoted 11 lines
include/linux/fileattr.h +0
-0/* Flags to indicate valid value of fsx_ fields */ #define FS_XFLAG_VALUES_MASK \include/uapi/linux/fs.h +1
-0@@ -253,6 +253,7 @@#define FS_XFLAG_FILESTREAM 0x00004000/* use filestream allocator */ #define FS_XFLAG_DAX 0x00008000/* use DAX for IO */ #define FS_XFLAG_COWEXTSIZE 0x00010000/* CoW extent size allocator hint */ +#define FS_XFLAG_VERITY 0x00020000/* fs-verity enabled */ Is the indentation broken ^^^^^^^^ here?
I think it's fine (there's two tabs one of them is single char width), I suppose it shows like this due to + at the line start.
Quoted 13 lines
Otherwise this looks fine to me.
--D
Quoted 7 lines
include/uapi/linux/fs.h +0
-0#define FS_XFLAG_HASATTR 0x80000000/* no DIFLAG for this */ /* the read-only stuff doesn't really belong here, but any other place is Signature · 2 lines
-- - Andrey
Signature · 1 line
- Andrey
Eric Biggers
maintainerRe: [PATCH 1/2] fs: add FS_XFLAG_VERITY for fs-verity files
In reply to Andrey AlbershteynQuoted 7 lines · Andrey Albershteyn
fs-verity introduced inode flag for inodes with enabled fs-verity on them. This patch adds
FS_XFLAG_VERITYfile attribute which can be retrieved withFS_IOC_FSGETXATTRioctl()andfile_getattr()syscall. This flag is read-only and can not be set with corresponding setioctl()andfile_setattr().Signed-off-by Andrey Albershteyn <[email protected]>
Sender and signed-off-by email addresses don't match:
WARNING: From:/Signed-off-by: email address mismatch: 'From: Andrey Albershteyn <[email protected]>' != 'Signed-off-by: Andrey Albershteyn <[email protected]>'
include/linux/fileattr.h line 19
Quoted 10 lines
include/linux/fileattr.h +1
-1@@ -16,7 +16,7 @@/* Read-only inode flags */ #define FS_XFLAG_RDONLY_MASK \ - (FS_XFLAG_PREALLOC | FS_XFLAG_HASATTR) + (FS_XFLAG_PREALLOC | FS_XFLAG_HASATTR | FS_XFLAG_VERITY)
Don't FS_COMMON_FL and FS_XFLAG_COMMON need to be updated too?
- Eric
PATCH 2/2 fsverity: add tracepoints
In reply to Andrey Albershteynfs-verity previously had debug printk but it was removed. This patch adds trace points to the same places where printk were used (with a few additional ones).
--- MAINTAINERS | 1 + fs/verity/enable.c | 4 + fs/verity/fsverity_private.h | 2 + fs/verity/init.c | 1 + fs/verity/verify.c | 9 ++ include/trace/events/fsverity.h | 143 ++++++++++++++++++++++++++++++++++++++++++ 6 files changed, 160 insertions(+), 0 deletions(-)
MAINTAINERS +1 -0
@@ -10311,6 +10311,7 @@ F: Documentation/filesystems/fsverity.rst F: fs/verity/ F: include/linux/fsverity.h +F: include/trace/events/fsverity.h F: include/uapi/linux/fsverity.h FT260 FTDI USB-HID TO I2C BRIDGE DRIVER
fs/verity/enable.c +4 -0
@@ -222,6 +222,8 @@if (err) goto out; +trace_fsverity_enable (inode, ¶ms); +/* * Start enabling verity on this file, serialized by the inode lock. * Fail if verity is already enabled or is already being enabled.
@@ -264,6 +266,8 @@ goto rollback; } +trace_fsverity_tree_done (inode, vi, ¶ms); +/* * Tell the filesystem to finish enabling verity on the file. * Serialized with ->begin_enable_verity() by the inode lock.
fs/verity/fsverity_private.h +2 -0
@@ -161,4 +161,6 @@void __init fsverity_init_workqueue (void ); +#include <trace/events/fsverity.h> +#endif /* _FSVERITY_PRIVATE_H */
fs/verity/init.c +1 -0
@@ -5,6 +5,7 @@* Copyright 2019 Google LLC */ +#define CREATE_TRACE_POINTS #include "fsverity_private.h" #include <linux/ratelimit.h>
fs/verity/verify.c +9 -0
@@ -135,6 +135,9 @@/* Byte offset of the wanted hash relative to @addr */ unsigned int hoffset; } hblocks[FS_VERITY_MAX_LEVELS ]; + +trace_fsverity_verify_data_block (inode, params, data_pos); +/* * The index of the previous level's block within that level; also the * index of that block's hash within the current level.
@@ -214,6 +217,9 @@ want_hash = _want_hash;kunmap_local (haddr);put_page (hpage); +trace_fsverity_merkle_hit (inode, data_pos, hblock_idx, + level, + hoffset >> params->log_digestsize); goto descend; } hblocks[level].page = hpage;
@@ -248,6 +254,9 @@ want_hash = _want_hash;kunmap_local (haddr);put_page (hpage); +trace_fsverity_verify_merkle_block (inode, + hblock_idx << params->log_blocksize, + level, hoffset >> params->log_digestsize); }/* Finally, verify the hash of the data block. */
include/trace/events/fsverity.h new file +143 -0
143 lines not on this page · raw message
Signature · 1 line
- Andrey
Eric Biggers
maintainerRe: [PATCH 2/2] fsverity: add tracepoints
Quoted 3 lines · Andrey Albershteyn
fs-verity previously had debug printk but it was removed. This patch adds trace points to the same places where printk were used (with a few additional ones).
They're not the same places. Which is the right choice: the locations of the old debug messages aren't necessarily the places the tracepoints should be. But the commit message shouldn't claim otherwise.
Quoted 25 lines
fs/verity/verify.c +6
-0@@ -135,6 +135,9 @@/* Byte offset of the wanted hash relative to @addr */ unsigned int hoffset; } hblocks[FS_VERITY_MAX_LEVELS ]; + +trace_fsverity_verify_data_block (inode, params, data_pos); +/* * The index of the previous level's block within that level; also the * index of that block's hash within the current level. @@ -214,6 +217,9 @@ want_hash = _want_hash;kunmap_local (haddr);put_page (hpage); +trace_fsverity_merkle_hit (inode, data_pos, hblock_idx, + level, + hoffset >> params->log_digestsize); goto descend; } hblocks[level].page = hpage;
fs/verity/verify.c line 260
Quoted 7 lines
fs/verity/verify.c +3
-0@@ -248,6 +254,9 @@ want_hash = _want_hash;kunmap_local (haddr);put_page (hpage); +trace_fsverity_verify_merkle_block (inode, + hblock_idx << params->log_blocksize, + level, hoffset >> params->log_digestsize); }
The second argument to trace_fsverity_verify_merkle_block() is wrong. It's "unsigned long index", but the caller passes a byte position. Note that byte positions should be u64. Perhaps you intended for it to be "unsigned long hblock_idx", like trace_fsverity_merkle_hit(), and for the caller to pass hblock_idx?
Also note that if the hash doesn't match, then trace_fsverity_verify_merkle_block() isn't called. Perhaps it should be called before the hash check is done? That's the case for trace_fsverity_verify_data_block().
- Eric
Eric Biggers
maintainerQuoted 9 lines · Andrey Albershteyn
Hi all,
This two small patches grew from fs-verity XFS patchset. I think they're self-contained improvements which could go without XFS implementation.
Andrey Albershteyn <[email protected]>:
fs: addFS_XFLAG_VERITYfor fs-verity files
fsverity: add tracepoints
I assume there wasn't intended to be a third patch, despite the cover letter saying 0/3?
- Eric