Re: [PATCH v15 19/25] xfs: add fs-verity support
"Darrick J. Wong" <[email protected]>
| Newsgroups | org.kernel.vger.linux-block,dev.linux.lists.fsverity,net.sourceforge.lists.linux-f2fs-devel,org.kernel.vger.linux-btrfs,org.kernel.vger.linux-ext4,org.kernel.vger.linux-fsdevel,org.kernel.vger.linux-unionfs,org.kernel.vger.linux-xfs |
|---|---|
| Message-ID | <20260820164411.GI6072@frogsfrogsfrogs> |
On Fri, Aug 14, 2026 at 11:24:36AM +0200, Andrey Albershteyn wrote: > Add integration with fs-verity. XFS stores fs-verity descriptor and > Merkle tree in the inode data fork at first block aligned to 64k past > EOF. > > The Merkle tree reading/writing is done through iomap interface. The > data itself is read to the inode's page cache. When XFS reads from this > region iomap doesn't call into fsverity to verify it against Merkle > tree. For data, verification is done at ioend completion in a workqueue. > > When fs-verity is enabled on an inode, the XFS_IVERITY_CONSTRUCTION > flag is set meaning that the Merkle tree is being build. The > initialization ends with storing of verity descriptor and setting > inode on-disk flag (XFS_DIFLAG2_VERITY). Lastly, the > XFS_IVERITY_CONSTRUCTION is dropped and I_VERITY is set on inode. > > The descriptor is stored in a new block aligned to 64k after the last > Merkle tree block. The size of the descriptor is stored at the end of > the last descriptor block (descriptor can be multiple blocks). > > Pro-actively remove any unwritten extents as we use last extent to > locate descriptor. > > Signed-off-by: Andrey Albershteyn <[email protected]> > Reviewed-by: Christoph Hellwig <[email protected]> LOL, I haven't looked at this at all since v6?! Sorry about that delay. > --- > fs/xfs/xfs_fsverity.c | 363 +++++++++++++++++++++++++++++++++++++++++- > fs/xfs/xfs_fsverity.h | 2 + > fs/xfs/xfs_message.c | 4 + > fs/xfs/xfs_message.h | 1 + > fs/xfs/xfs_mount.h | 2 + > fs/xfs/xfs_super.c | 7 + > 6 files changed, 378 insertions(+), 1 deletion(-) > > diff --git a/fs/xfs/xfs_fsverity.c b/fs/xfs/xfs_fsverity.c > index d1b3ccc65322..9d7c5611d9cd 100644 > --- a/fs/xfs/xfs_fsverity.c > +++ b/fs/xfs/xfs_fsverity.c > @@ -6,13 +6,22 @@ > #include "xfs_fs.h" > #include "xfs_shared.h" > #include "xfs_format.h" > -#include "xfs_log_format.h" > #include "xfs_trans_resv.h" > #include "xfs_mount.h" > #include "xfs_inode.h" > +#include "xfs_log_format.h" > +#include "xfs_trans.h" > +#include "xfs_trace.h" > +#include "xfs_quota.h" > #include "xfs_fsverity.h" > +#include "xfs_iomap.h" > +#include "xfs_error.h" > +#include "xfs_health.h" > +#include "xfs_bmap_util.h" > +#include "xfs_icache.h" > #include <linux/fsverity.h> > #include <linux/iomap.h> > +#include <linux/pagemap.h> > > loff_t > xfs_fsverity_metadata_offset( > @@ -29,3 +38,355 @@ xfs_fsverity_is_file_data( > return fsverity_active(VFS_IC(ip)) && > offset < xfs_fsverity_metadata_offset(ip); > } > + > +/* > + * Retrieve the verity descriptor. > + */ > +static int > +xfs_fsverity_get_descriptor( > + struct inode *inode, > + void *buf, > + size_t buf_size) > +{ > + struct xfs_inode *ip = XFS_I(inode); > + struct xfs_mount *mp = ip->i_mount; > + __be32 d_desc_size; > + u32 desc_size; > + u64 desc_size_pos; > + int error; > + u64 desc_pos; > + struct xfs_bmbt_irec rec; > + int is_empty; > + uint32_t blocksize = i_blocksize(VFS_I(ip)); > + xfs_fileoff_t last_block_offset; > + > + ASSERT(inode->i_flags & S_VERITY); > + xfs_ilock(ip, XFS_ILOCK_SHARED); > + error = xfs_bmap_last_extent(NULL, ip, XFS_DATA_FORK, &rec, &is_empty); > + xfs_iunlock(ip, XFS_ILOCK_SHARED); > + if (error) > + return error; > + > + if (is_empty) > + return -ENODATA; > + > + last_block_offset = > + XFS_FSB_TO_B(mp, rec.br_startoff + rec.br_blockcount); > + if (last_block_offset <= xfs_fsverity_metadata_offset(ip)) > + return -ENODATA; > + > + desc_size_pos = last_block_offset - sizeof(__be32); > + error = fsverity_pagecache_read(inode, (char *)&d_desc_size, > + sizeof(d_desc_size), desc_size_pos); > + if (error) > + return error; > + > + desc_size = be32_to_cpu(d_desc_size); > + if (XFS_IS_CORRUPT(mp, desc_size > FS_VERITY_MAX_DESCRIPTOR_SIZE)) > + return -ERANGE; > + if (XFS_IS_CORRUPT(mp, desc_size > desc_size_pos)) > + return -ERANGE; > + > + if (!buf_size) > + return desc_size; > + > + if (XFS_IS_CORRUPT(mp, desc_size > buf_size)) > + return -ERANGE; > + > + desc_pos = round_down(desc_size_pos - desc_size, blocksize); > + if (desc_pos < xfs_fsverity_metadata_offset(ip)) > + return -ERANGE; > + > + error = fsverity_pagecache_read(inode, buf, desc_size, desc_pos); > + if (error) > + return error; > + > + return desc_size; > +} > + > +static int > +xfs_fsverity_write_descriptor( > + struct file *file, > + const void *desc, > + u32 desc_size, > + u64 merkle_tree_size) > +{ > + int error; > + struct inode *inode = file_inode(file); > + struct xfs_inode *ip = XFS_I(inode); > + unsigned int blksize = ip->i_mount->m_sb.sb_blocksize; > + u64 tree_last_block = > + xfs_fsverity_metadata_offset(ip) + merkle_tree_size; > + u64 desc_pos = > + round_up(tree_last_block, XFS_FSVERITY_START_ALIGN); > + u64 desc_end = desc_pos + desc_size; > + __be32 desc_size_disk = cpu_to_be32(desc_size); > + u64 desc_size_pos = > + round_up(desc_end + sizeof(desc_size_disk), blksize) - > + sizeof(desc_size_disk); > + > + error = iomap_fsverity_write(file, desc_size_pos, sizeof(__be32), > + (const void *)&desc_size_disk, > + &xfs_buffered_write_iomap_ops, > + &xfs_iomap_write_ops); > + if (error) > + return error; > + > + return iomap_fsverity_write(file, desc_pos, desc_size, desc, > + &xfs_buffered_write_iomap_ops, > + &xfs_iomap_write_ops); > +} > + > +/* > + * Try to remove all the fsverity metadata after a failed enablement. > + */ > +static int > +xfs_fsverity_delete_metadata( > + struct xfs_inode *ip) > +{ > + struct xfs_trans *tp; > + struct xfs_mount *mp = ip->i_mount; > + int error; > + > + xfs_ilock(ip, XFS_MMAPLOCK_EXCL); > + error = xfs_trans_alloc(mp, &M_RES(mp)->tr_itruncate, 0, 0, 0, &tp); > + if (error) { > + xfs_iunlock(ip, XFS_MMAPLOCK_EXCL); > + return error; > + } > + > + xfs_ilock(ip, XFS_ILOCK_EXCL); > + xfs_trans_ijoin(tp, ip, 0); > + > + truncate_inode_pages(VFS_I(ip)->i_mapping, XFS_ISIZE(ip)); > + > + /* > + * We remove post EOF data, no need to update i_size as fsverity > + * didn't move i_size in the first place > + */ > + error = xfs_itruncate_extents(&tp, ip, XFS_DATA_FORK, XFS_ISIZE(ip)); > + if (error) > + goto err_cancel; > + > + error = xfs_trans_commit(tp); > + xfs_iunlock(ip, XFS_MMAPLOCK_EXCL | XFS_ILOCK_EXCL); > + return error; > +err_cancel: > + xfs_trans_cancel(tp); > + xfs_iunlock(ip, XFS_MMAPLOCK_EXCL | XFS_ILOCK_EXCL); > + return error; > +} > + > + > +/* > + * Prepare to enable fsverity by clearing old metadata. > + */ > +static int > +xfs_fsverity_begin_enable( > + struct file *filp) > +{ > + struct inode *inode = file_inode(filp); > + struct xfs_inode *ip = XFS_I(inode); > + int error; > + > + xfs_assert_ilocked(ip, XFS_IOLOCK_EXCL); > + > + if (IS_DAX(inode) || ip->i_diflags2 & XFS_DIFLAG2_DAX) > + return -EINVAL; > + > + if (inode->i_size > XFS_FSVERITY_LARGEST_FILE) > + return -EFBIG; > + > + /* > + * Flush pagecache before building Merkle tree. Inode is locked and no > + * further writes will happen to the file except fsverity metadata > + */ > + error = filemap_write_and_wait(inode->i_mapping); > + if (error) > + return error; > + > + if (xfs_iflags_test_and_set(ip, XFS_VERITY_CONSTRUCTION)) > + return -EBUSY; > + > + error = xfs_qm_dqattach(ip); > + if (error) > + goto out_clear; > + > + error = xfs_fsverity_delete_metadata(ip); > + if (error) > + goto out_clear; > + return error; > +out_clear: > + xfs_iflags_clear(ip, XFS_VERITY_CONSTRUCTION); > + return error; > +} > + > +/* > + * Complete (or fail) the process of enabling fsverity. > + */ > +static int > +xfs_fsverity_end_enable( > + struct file *file, > + const void *desc, > + size_t desc_size, > + u64 merkle_tree_size) > +{ > + struct inode *inode = file_inode(file); > + struct xfs_inode *ip = XFS_I(inode); > + struct xfs_mount *mp = ip->i_mount; > + struct xfs_trans *tp; > + int error = 0; > + loff_t range_start = xfs_fsverity_metadata_offset(ip); > + > + xfs_assert_ilocked(ip, XFS_IOLOCK_EXCL); > + > + /* fs-verity failed, just cleanup */ > + if (desc == NULL) { > + error = xfs_fsverity_delete_metadata(ip); > + goto out; > + } > + > + error = xfs_fsverity_write_descriptor(file, desc, desc_size, > + merkle_tree_size); > + if (error) > + goto out; > + > + /* > + * Wait for Merkle tree get written to disk before setting on-disk inode > + * flag and clearing XFS_VERITY_CONSTRUCTION > + */ > + error = filemap_write_and_wait_range(inode->i_mapping, range_start, > + LLONG_MAX); > + if (error) > + goto out; > + > + /* > + * Set fsverity inode flag > + */ > + error = xfs_trans_alloc_inode(ip, &M_RES(mp)->tr_ichange, > + 0, 0, false, &tp); > + if (error) > + goto out; > + > + /* > + * Ensure that we've persisted the verity information before we enable > + * it on the inode and tell the caller we have sealed the inode. > + */ > + ip->i_diflags2 |= XFS_DIFLAG2_VERITY; > + > + xfs_trans_log_inode(tp, ip, XFS_ILOG_CORE); > + xfs_trans_set_sync(tp); > + > + error = xfs_trans_commit(tp); > + xfs_iunlock(ip, XFS_ILOCK_EXCL); > + if (error) > + goto out; > + > + inode_set_flags(inode, S_VERITY, S_VERITY); > + > + /* > + * Proactively remove unwritten extents left by COW preallocations and > + * write preallocation in the merkle tree holes and past descriptor, > + * and any delayed preallocations > + */ > + error = xfs_free_eofblocks(ip); > +out: > + if (error) { > + int error2; > + We just set S_VERITY on the VFS inoe, but then xfs_free_eofblocks fails. Should we clear S_VERITY? > + error2 = xfs_fsverity_delete_metadata(ip); Does xfs_fsverity_delete_metadata need to clear XFS_DIFLAG2_VERITY? > + if (error2) > + xfs_alert(ip->i_mount, > +"ino 0x%llx failed to clean up new fsverity metadata, err %d", > + I_INO(ip), error2); > + } > + > + xfs_iflags_clear(ip, XFS_VERITY_CONSTRUCTION); > + return error; > +} > + > +/* > + * Retrieve a merkle tree block. > + */ > +static struct page * > +xfs_fsverity_read_merkle( > + struct inode *inode, > + pgoff_t index) > +{ > + index += xfs_fsverity_metadata_offset(XFS_I(inode)) >> PAGE_SHIFT; > + > + return generic_read_merkle_tree_page(inode, index); > +} > + > +/* > + * Retrieve a merkle tree block. > + */ > +static void > +xfs_fsverity_readahead_merkle_tree( > + struct inode *inode, > + pgoff_t index, > + unsigned long nr_pages) > +{ > + index += xfs_fsverity_metadata_offset(XFS_I(inode)) >> PAGE_SHIFT; > + > + generic_readahead_merkle_tree(inode, index, nr_pages); > +} > + > +/* > + * Write a merkle tree block. > + */ > +static int > +xfs_fsverity_write_merkle( > + struct file *file, > + const void *buf, > + u64 pos, > + unsigned int size, > + const u8 *zero_digest, > + unsigned int digest_size) > +{ > + struct inode *inode = file_inode(file); > + struct xfs_inode *ip = XFS_I(inode); > + loff_t position = pos + > + xfs_fsverity_metadata_offset(ip); > + > + if (position + size > inode->i_sb->s_maxbytes) > + return -EFBIG; > + > + /* > + * If this is a block full of hashes of zeroed blocks, don't bother > + * storing the block. We can synthesize them later. > + * > + * However, do this only in case Merkle tree block == fs block size. > + * Iomap synthesizes these blocks based on holes in the merkle tree. We > + * won't be able to tell if something need to be synthesizes for the s/synthesizes/synthesized/ Aside from those three things, the rest of the code looks good to me. --D > + * range in the fs block. For example, for 4k filesystem block > + * > + * [ 1k | zero hashes | zero hashes | 1k ] > + * > + * Iomap won't know about these empty blocks. > + */ > + if (size == ip->i_mount->m_sb.sb_blocksize && > + /* > + * First digest is zero_digest > + */ > + memcmp(buf, zero_digest, digest_size) == 0 && > + /* > + * Every digest is same as previous, thus all are > + * zero_digest > + */ > + memcmp(buf + digest_size, buf, size - digest_size) == 0) > + return 0; > + > + return iomap_fsverity_write(file, position, size, buf, > + &xfs_buffered_write_iomap_ops, > + &xfs_iomap_write_ops); > +} > + > +const struct fsverity_operations xfs_fsverity_ops = { > + .begin_enable_verity = xfs_fsverity_begin_enable, > + .end_enable_verity = xfs_fsverity_end_enable, > + .get_verity_descriptor = xfs_fsverity_get_descriptor, > + .read_merkle_tree_page = xfs_fsverity_read_merkle, > + .readahead_merkle_tree = xfs_fsverity_readahead_merkle_tree, > + .write_merkle_tree_block = xfs_fsverity_write_merkle, > +}; > diff --git a/fs/xfs/xfs_fsverity.h b/fs/xfs/xfs_fsverity.h > index ec77ba571106..6a981e20a75b 100644 > --- a/fs/xfs/xfs_fsverity.h > +++ b/fs/xfs/xfs_fsverity.h > @@ -6,8 +6,10 @@ > #define __XFS_FSVERITY_H__ > > #include "xfs_platform.h" > +#include <linux/fsverity.h> > > #ifdef CONFIG_FS_VERITY > +extern const struct fsverity_operations xfs_fsverity_ops; > loff_t xfs_fsverity_metadata_offset(const struct xfs_inode *ip); > bool xfs_fsverity_is_file_data(const struct xfs_inode *ip, loff_t offset); > #else > diff --git a/fs/xfs/xfs_message.c b/fs/xfs/xfs_message.c > index 0243e509a468..44b13d46049c 100644 > --- a/fs/xfs/xfs_message.c > +++ b/fs/xfs/xfs_message.c > @@ -149,6 +149,10 @@ xfs_warn_experimental( > .opstate = XFS_OPSTATE_WARNED_LARP, > .name = "logged extended attributes", > }, > + [XFS_EXPERIMENTAL_FSVERITY] = { > + .opstate = XFS_OPSTATE_WARNED_FSVERITY, > + .name = "fsverity", > + }, > }; > ASSERT(feat >= 0 && feat < XFS_EXPERIMENTAL_MAX); > BUILD_BUG_ON(ARRAY_SIZE(features) != XFS_EXPERIMENTAL_MAX); > diff --git a/fs/xfs/xfs_message.h b/fs/xfs/xfs_message.h > index 811b885f41c3..364fcc7e42b0 100644 > --- a/fs/xfs/xfs_message.h > +++ b/fs/xfs/xfs_message.h > @@ -93,6 +93,7 @@ void xfs_buf_alert_ratelimited(struct xfs_buf *bp, const char *rlmsg, > enum xfs_experimental_feat { > XFS_EXPERIMENTAL_SHRINK, > XFS_EXPERIMENTAL_LARP, > + XFS_EXPERIMENTAL_FSVERITY, > > XFS_EXPERIMENTAL_MAX, > }; > diff --git a/fs/xfs/xfs_mount.h b/fs/xfs/xfs_mount.h > index 14fe768326a3..2ef9956ed185 100644 > --- a/fs/xfs/xfs_mount.h > +++ b/fs/xfs/xfs_mount.h > @@ -591,6 +591,8 @@ __XFS_HAS_FEAT(nouuid, NOUUID) > #define XFS_OPSTATE_RESUMING_QUOTAON 18 > /* (Zoned) GC is in progress */ > #define XFS_OPSTATE_ZONEGC_RUNNING 20 > +/* Kernel has logged a warning about fsverity support */ > +#define XFS_OPSTATE_WARNED_FSVERITY 21 > > #define __XFS_IS_OPSTATE(name, NAME) \ > static inline bool xfs_is_ ## name (struct xfs_mount *mp) \ > diff --git a/fs/xfs/xfs_super.c b/fs/xfs/xfs_super.c > index 63c4bcbe6c2b..faebd84c5c59 100644 > --- a/fs/xfs/xfs_super.c > +++ b/fs/xfs/xfs_super.c > @@ -30,6 +30,7 @@ > #include "xfs_filestream.h" > #include "xfs_quota.h" > #include "xfs_sysfs.h" > +#include "xfs_fsverity.h" > #include "xfs_ondisk.h" > #include "xfs_rmap_item.h" > #include "xfs_refcount_item.h" > @@ -1736,6 +1737,9 @@ xfs_fs_fill_super( > sb->s_quota_types = QTYPE_MASK_USR | QTYPE_MASK_GRP | QTYPE_MASK_PRJ; > #endif > sb->s_op = &xfs_super_operations; > +#ifdef CONFIG_FS_VERITY > + sb->s_vop = &xfs_fsverity_ops; > +#endif > > /* > * Delay mount work if the debug hook is set. This is debug > @@ -1988,6 +1992,9 @@ xfs_fs_fill_super( > if (error) > goto out_filestream_unmount; > > + if (xfs_has_verity(mp)) > + xfs_warn_experimental(mp, XFS_EXPERIMENTAL_FSVERITY); > + > root = igrab(VFS_I(mp->m_rootip)); > if (!root) { > error = -ENOENT; > -- > 2.54.0 > >