git: 12ecb0fe0afd - main - file: Add foffset_lock_pair()

From: Mark Johnston <markj_at_FreeBSD.org>
Date: Mon, 31 Mar 2025 09:06:37 UTC
The branch main has been updated by markj:

URL: https://cgit.FreeBSD.org/src/commit/?id=12ecb0fe0afda8c051605045e446371ddd34741f

commit 12ecb0fe0afda8c051605045e446371ddd34741f
Author:     Mark Johnston <markj@FreeBSD.org>
AuthorDate: 2025-03-31 01:25:16 +0000
Commit:     Mark Johnston <markj@FreeBSD.org>
CommitDate: 2025-03-31 09:01:09 +0000

    file: Add foffset_lock_pair()
    
    This will be used in kern_copy_file_range(), which needs to lock two
    offsets.
    
    Reviewed by:    kib, rmacklem
    MFC after:      2 weeks
    Differential Revision:  https://reviews.freebsd.org/D49440
---
 sys/kern/vfs_vnops.c | 20 ++++++++++++++++++++
 sys/sys/file.h       |  2 ++
 2 files changed, 22 insertions(+)

diff --git a/sys/kern/vfs_vnops.c b/sys/kern/vfs_vnops.c
index 0d96bdb3acba..69d8ffcdd5ad 100644
--- a/sys/kern/vfs_vnops.c
+++ b/sys/kern/vfs_vnops.c
@@ -892,6 +892,26 @@ foffset_read(struct file *fp)
 }
 #endif
 
+void
+foffset_lock_pair(struct file *fp1, off_t *off1p, struct file *fp2, off_t *off2p,
+    int flags)
+{
+	KASSERT(fp1 != fp2, ("foffset_lock_pair: fp1 == fp2"));
+
+	/* Lock in a consistent order to avoid deadlock. */
+	if ((uintptr_t)fp1 > (uintptr_t)fp2) {
+		struct file *tmpfp;
+		off_t *tmpoffp;
+
+		tmpfp = fp1, fp1 = fp2, fp2 = tmpfp;
+		tmpoffp = off1p, off1p = off2p, off2p = tmpoffp;
+	}
+	if (fp1 != NULL)
+		*off1p = foffset_lock(fp1, flags);
+	if (fp2 != NULL)
+		*off2p = foffset_lock(fp2, flags);
+}
+
 void
 foffset_lock_uio(struct file *fp, struct uio *uio, int flags)
 {
diff --git a/sys/sys/file.h b/sys/sys/file.h
index d0b53196151e..0c025fde475c 100644
--- a/sys/sys/file.h
+++ b/sys/sys/file.h
@@ -86,6 +86,8 @@ struct ucred;
 #define	FOF_NEXTOFF_W	0x08	/* Also update f_nextoff[UIO_WRITE] */
 #define	FOF_NOUPDATE	0x10	/* Do not update f_offset */
 off_t foffset_lock(struct file *fp, int flags);
+void foffset_lock_pair(struct file *fp1, off_t *off1p, struct file *fp2,
+    off_t *off2p, int flags);
 void foffset_lock_uio(struct file *fp, struct uio *uio, int flags);
 void foffset_unlock(struct file *fp, off_t val, int flags);
 void foffset_unlock_uio(struct file *fp, struct uio *uio, int flags);