Skip to contentSkip to conversation

Add traces and file attributes for fs-verity

PATCH Applied Andrey Albershteyn 3 participants 8 messages Jan 26 – Feb 3

Subsystems (4)
lore
Share & tools
lore
#0 lore raw

v3 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.

Cc "Darrick J. Wong" <[email protected]>

v3:
- Make tracepoints arguments more consistent
- Make tracepoint messages more consistent
v2:
- Update kernel version in the docs to v7.0
- Move trace point before merkle tree block hash check
- Update commit message in patch 2
- Add VERITY to FS_COMMON_FL and FS_XFLAG_COMMON constants
- Fix block index argument in the tree block hash trace point

Andrey Albershteyn (2):
fs: add FS_XFLAG_VERITY for fs-verity files
fsverity: add tracepoints

 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               |   6 +-
 include/trace/events/fsverity.h        | 146 +++++++++++++++++++++++++
 include/uapi/linux/fs.h                |   1 +
 10 files changed, 187 insertions(+), 3 deletions(-)
 create mode 100644 include/trace/events/fsverity.h
Signature · 1 line
2.52.0
#1 lore raw

PATCH v3 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(). The FS_IOC_SETFLAGS requires file to be opened for writing which is not allowed for verity files. The FS_IOC_FSSETXATTR and file_setattr() clears this flag from the user input.

As this is now common flag for both flag interfaces (flags/xflags) add it to overlapping flags list to exclude it from overwrite.

---
 Documentation/filesystems/fsverity.rst | 16 ++++++++++++++++
 fs/file_attr.c                         |  4 ++++
 include/linux/fileattr.h               |  6 +++---
 include/uapi/linux/fs.h                |  1 +
 4 files changed, 24 insertions(+), 3 deletions(-)
Documentation/filesystems/fsverity.rst +16 -0
index 412cf11e3298..22b49b295d1f 100644
@@ -341,6 +341,22 @@ the file has fs-verity enabled.  This can perform better than
 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 v7.0, 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 v7.0, 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
index bed5442fa6fa..53b356dd8c33 100644
@@ -37,6 +37,8 @@ void fileattr_fill_xflags(struct file_kattr *fa, u32 xflags)
 		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 @@ void fileattr_fill_flags(struct file_kattr *fa, u32 flags)
 		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 +3 -3
index f89dcfad3f8f..3780904a63a6 100644
@@ -7,16 +7,16 @@
 #define FS_COMMON_FL \
 	(FS_SYNC_FL | FS_IMMUTABLE_FL | FS_APPEND_FL | \
 	 FS_NODUMP_FL |	FS_NOATIME_FL | FS_DAX_FL | \
-	 FS_PROJINHERIT_FL)
+	 FS_PROJINHERIT_FL | FS_VERITY_FL)
 
 #define FS_XFLAG_COMMON \
 	(FS_XFLAG_SYNC | FS_XFLAG_IMMUTABLE | FS_XFLAG_APPEND | \
 	 FS_XFLAG_NODUMP | FS_XFLAG_NOATIME | FS_XFLAG_DAX | \
-	 FS_XFLAG_PROJINHERIT)
+	 FS_XFLAG_PROJINHERIT | FS_XFLAG_VERITY)
 
 /* 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
index 66ca526cf786..70b2b661f42c 100644
@@ -253,6 +253,7 @@ struct file_attr {
 #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
2.52.0
#2 lore raw

PATCH v3 2/2 fsverity: add tracepoints

In reply to Andrey Albershteyn

fs-verity previously had debug printk but it was removed. This patch adds trace points to similar places, as a better alternative.

---
 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 | 146 ++++++++++++++++++++++++++++++++
 6 files changed, 163 insertions(+)
 create mode 100644 include/trace/events/fsverity.h
MAINTAINERS +1 -0
index 12f49de7fe03..17607340dfab 100644
@@ -10311,6 +10311,7 @@ T:	git https://git.kernel.org/pub/scm/fs/fsverity/linux.git
 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
index 95ec42b84797..8718d943b428 100644
@@ -222,6 +222,8 @@ static int enable_verity(struct file *filp,
 	if (err)
 		goto out;
 
+	trace_fsverity_enable(inode, &params);
+
 	/*
 	 * 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 @@ static int enable_verity(struct file *filp,
 		goto rollback;
 	}
 
+	trace_fsverity_tree_done(inode, vi, &params);
+
 	/*
 	 * 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
index dd20b138d452..4b7ae1748f4e 100644
@@ -161,4 +161,6 @@ static inline void fsverity_init_signature(void)
 
 void __init fsverity_init_workqueue(void);
 
+#include <trace/events/fsverity.h>
+
 #endif /* _FSVERITY_PRIVATE_H */
fs/verity/init.c +1 -0
index 6e8d33b50240..d65206608583 100644
@@ -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
index 86067c8b40cf..940b8b956d7e 100644
@@ -135,6 +135,9 @@ static bool verify_data_block(struct inode *inode, struct fsverity_info *vi,
 		/* 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 @@ static bool verify_data_block(struct inode *inode, struct fsverity_info *vi,
 			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;
@@ -232,6 +238,9 @@ static bool verify_data_block(struct inode *inode, struct fsverity_info *vi,
 		unsigned long hblock_idx = hblocks[level - 1].index;
 		unsigned int hoffset = hblocks[level - 1].hoffset;
 
+		trace_fsverity_verify_merkle_block(inode, hblock_idx,
+				level, hoffset >> params->log_digestsize);
+
 		fsverity_hash_block(params, haddr, real_hash);
 		if (memcmp(want_hash, real_hash, hsize) != 0)
 			goto corrupted;
include/trace/events/fsverity.h new file +146 -0

146 lines not on this page · raw message

Signature · 1 line
2.52.0
maintainer
#3 lore raw

Re: [PATCH v3 2/2] fsverity: add tracepoints

Quoted 7 lines · Andrey Albershteyn

fs-verity previously had debug printk but it was removed. This patch adds trace points to similar places, as a better alternative.

I applied this as-is, but for future reference, the same person shouldn't have both a Signed-off-by and a Reviewed-by.

- Eric

maintainer Applied
#4 lore raw
In reply to Andrey Albershteyn
Quoted 18 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.

Cc "Darrick J. Wong" <[email protected]>

v3:
- Make tracepoints arguments more consistent
- Make tracepoint messages more consistent
v2:
- Update kernel version in the docs to v7.0
- Move trace point before merkle tree block hash check
- Update commit message in patch 2
- Add VERITY to FS_COMMON_FL and FS_XFLAG_COMMON constants
- Fix block index argument in the tree block hash trace point

Quoted 3 lines

Andrey Albershteyn (2):
fs: add FS_XFLAG_VERITY for fs-verity files
fsverity: add tracepoints

Applied to https://git.kernel.org/pub/scm/fs/fsverity/linux.git/log/?h=for-next

Thanks!

- Eric

maintainer Applied
#5 lore raw
In reply to Andrey Albershteyn
Quoted 16 lines · Andrey Albershteyn

This two small patches grew from fs-verity XFS patchset. I think they're self-contained improvements which could go without XFS implementation.

Cc "Darrick J. Wong" <[email protected]>

v3:
- Make tracepoints arguments more consistent
- Make tracepoint messages more consistent
v2:
- Update kernel version in the docs to v7.0
- Move trace point before merkle tree block hash check
- Update commit message in patch 2
- Add VERITY to FS_COMMON_FL and FS_XFLAG_COMMON constants
- Fix block index argument in the tree block hash trace point

Quoted 1 line

[...]

Applied to the vfs-7.0.misc branch of the vfs/vfs.git tree. Patches in the vfs-7.0.misc branch should appear in linux-next soon.

Please report any outstanding bugs that were missed during review in a new review to the original patch series allowing us to drop it.

It's encouraged to provide Acked-bys and Reviewed-bys even though the patch has now been applied. If possible patch trailers will be updated.

Note that commit hashes shown below are subject to change due to rebase, trailer updates or similar. If in doubt, please check the listed branch.

tree:   https://git.kernel.org/pub/scm/linux/kernel/git/vfs/vfs.git
branch: vfs-7.0.misc

[1/2] fs: add FS_XFLAG_VERITY for fs-verity files

      https://git.kernel.org/vfs/vfs/c/0e6b7eae1fde
[2/2] fsverity: add tracepoints
      https://git.kernel.org/vfs/vfs/c/fa19d42cc791
maintainer
#6 lore raw
Quoted 31 lines · Christian Brauner
Quoted 16 lines · Andrey Albershteyn

This two small patches grew from fs-verity XFS patchset. I think they're self-contained improvements which could go without XFS implementation.

Cc "Darrick J. Wong" <[email protected]>

v3:
- Make tracepoints arguments more consistent
- Make tracepoint messages more consistent
v2:
- Update kernel version in the docs to v7.0
- Move trace point before merkle tree block hash check
- Update commit message in patch 2
- Add VERITY to FS_COMMON_FL and FS_XFLAG_COMMON constants
- Fix block index argument in the tree block hash trace point

Quoted 1 line

[...]

Applied to the vfs-7.0.misc branch of the vfs/vfs.git tree. Patches in the vfs-7.0.misc branch should appear in linux-next soon.

Please report any outstanding bugs that were missed during review in a new review to the original patch series allowing us to drop it.

It's encouraged to provide Acked-bys and Reviewed-bys even though the patch has now been applied. If possible patch trailers will be updated.

Note that commit hashes shown below are subject to change due to rebase, trailer updates or similar. If in doubt, please check the listed branch.

Quoted 7 lines
tree:   https://git.kernel.org/pub/scm/linux/kernel/git/vfs/vfs.git
branch: vfs-7.0.misc

[1/2] fs: add FS_XFLAG_VERITY for fs-verity files

      https://git.kernel.org/vfs/vfs/c/0e6b7eae1fde
[2/2] fsverity: add tracepoints
      https://git.kernel.org/vfs/vfs/c/fa19d42cc791

I guess this means you want me to drop them. So, dropped now.

- Eric

#7 lore raw
Quoted 35 lines · Eric Biggers
Quoted 34 lines · Christian Brauner
Quoted 16 lines · Andrey Albershteyn

This two small patches grew from fs-verity XFS patchset. I think they're self-contained improvements which could go without XFS implementation.

Cc "Darrick J. Wong" <[email protected]>

v3:
- Make tracepoints arguments more consistent
- Make tracepoint messages more consistent
v2:
- Update kernel version in the docs to v7.0
- Move trace point before merkle tree block hash check
- Update commit message in patch 2
- Add VERITY to FS_COMMON_FL and FS_XFLAG_COMMON constants
- Fix block index argument in the tree block hash trace point

Quoted 1 line

[...]

Applied to the vfs-7.0.misc branch of the vfs/vfs.git tree. Patches in the vfs-7.0.misc branch should appear in linux-next soon.

Please report any outstanding bugs that were missed during review in a new review to the original patch series allowing us to drop it.

It's encouraged to provide Acked-bys and Reviewed-bys even though the patch has now been applied. If possible patch trailers will be updated.

Note that commit hashes shown below are subject to change due to rebase, trailer updates or similar. If in doubt, please check the listed branch.

tree:   https://git.kernel.org/pub/scm/linux/kernel/git/vfs/vfs.git
branch: vfs-7.0.misc
Quoted 6 lines
Quoted 4 lines

[1/2] fs: add FS_XFLAG_VERITY for fs-verity files

      https://git.kernel.org/vfs/vfs/c/0e6b7eae1fde
[2/2] fsverity: add tracepoints
      https://git.kernel.org/vfs/vfs/c/fa19d42cc791

I guess this means you want me to drop them. So, dropped now.

Hm, sorry if I missed to reply to another mail on list. That wasn't intentional.