btrfs: annotate lockless read of defrag_bytes in should_nocow()
PATCH 1/1 btrfs: annotate lockless read of defrag_bytes in should_nocow()
should_nocow() reads inode->defrag_bytes without holding inode->lock, while btrfs_set_delalloc_extent() and btrfs_clear_delalloc_extent() update it under that spinlock.
This is a data race. The read is a quick check used to decide whether to fall back to COW for a NOCOW inode: if defrag_bytes is non-zero and the range is tagged EXTENT_DEFRAG, we force COW so that defragmentation can rewrite the extent. Reading a stale value is harmless because:
- A missed increment may skip COW once, but the defrag pass will redo the extent later.
- A stale non-zero may force an unnecessary COW, which is a minor efficiency loss, not a correctness issue.
On 64-bit platforms an aligned u64 load is naturally atomic so tearing cannot happen. On 32-bit platforms u64 may tear, but we only test for zero vs non-zero, so the heuristic stays correct regardless.
Add READ_ONCE() to prevent the compiler from caching or splitting the load and to document the intentional lock-free pattern.
--- fs/btrfs/inode.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
fs/btrfs/inode.c +1 -1
@@ -2420,7 +2420,7 @@ static noinline int run_delalloc_nocow(struct btrfs_inode *inode,static bool should_nocow (struct btrfs_inode *inode,u64 start,u64 end) {if (inode->flags & (BTRFS_INODE_NODATACOW |BTRFS_INODE_PREALLOC )) { -if (inode->defrag_bytes && +if (READ_ONCE (inode->defrag_bytes) &&btrfs_test_range_bit_exists (&inode->io_tree, start, end,EXTENT_DEFRAG ))return false;return true;
Signature · 1 line
2.34.1
Quoted 14 lines · Cen Zhang
should_nocow()readsinode->defrag_byteswithout holdinginode->lock, whilebtrfs_set_delalloc_extent()andbtrfs_clear_delalloc_extent()update it under that spinlock.This is a data race. The read is a quick check used to decide whether to fall back to COW for a NOCOW inode: if
defrag_bytesis non-zero and the range is taggedEXTENT_DEFRAG, we force COW so that defragmentation can rewrite the extent. Reading a stale value is harmless because:- A missed increment may skip COW once, but the defrag pass will redo the extent later.
- A stale non-zero may force an unnecessary COW, which is a minor efficiency loss, not a correctness issue.
Quoted 6 lines
On 64-bit platforms an aligned u64 load is naturally atomic so tearing cannot happen. On 32-bit platforms u64 may tear, but we only test for zero vs non-zero, so the heuristic stays correct regardless.
Add
READ_ONCE()to prevent the compiler from caching or splitting the load and to document the intentional lock-free pattern.
As it's explained it's ok to do the unlocked read but of that that the dara_race() is more convenient, we do not really need the READ_ONCE semantics.
Quoted 18 lines · Cen Zhang
should_nocow()readsinode->defrag_byteswithout holdinginode->lock, whilebtrfs_set_delalloc_extent()andbtrfs_clear_delalloc_extent()update it under that spinlock.This is a data race. The read is a quick check used to decide whether to fall back to COW for a NOCOW inode: if
defrag_bytesis non-zero and the range is taggedEXTENT_DEFRAG, we force COW so that defragmentation can rewrite the extent. Reading a stale value is harmless because:- A missed increment may skip COW once, but the defrag pass will redo the extent later.
- A stale non-zero may force an unnecessary COW, which is a minor efficiency loss, not a correctness issue.On 64-bit platforms an aligned u64 load is naturally atomic so tearing cannot happen. On 32-bit platforms u64 may tear, but we only test for zero vs non-zero, so the heuristic stays correct regardless.
Quoted 5 lines
Add
READ_ONCE()to prevent the compiler from caching or splitting the load and to document the intentional lock-free pattern.Fixes 47059d930f0e ("Btrfs: make defragment work with nodatacow option")Signed-off-by Cen Zhang <[email protected]>
Added to for-next, with the data_race() annotation. Thanks.