Skip to contentSkip to conversation

io-uring: Make statx api stable

PATCH Applied Stefan Roesch 3 participants 4 messages Feb 25, 2022 – Feb 26, 2022

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

v4 cover io-uring: Make statx api stable

One of the key architectual tenets of io-uring is to keep the parameters for io-uring stable. After the call has been submitted, its value can be changed. Unfortunaltely this is not the case for the current statx implementation.

Patch:
Part 1: fs: replace const char* parameter in vfs_statx and do_statx with
struct filename
Create filename object outside of do_statx and vfs_statx, so io-uring can create the filename object during the prepare phase

Part 2: io-uring: Copy path name during prepare stage for statx
Create and store filename object during prepare phase

There is also a patch for the liburing libray to add a new test case. This patch makes sure that the api is stable.
"liburing: add test for stable statx api"

The patch has been tested with the liburing test suite and fstests.

Changes:
V2: don't check name in vfs_fstatat
V3: don't check name in statx syscall
V4: - incorporate Steven Rostedt's fix
- Merge both patches to avoid bisect problem
(the io-uring changes have a dependency on the parameter change in
the fs layer)

Stefan Roesch (1):
io-uring: Make statx API stable

 fs/internal.h |  4 +++-
 fs/io_uring.c | 22 ++++++++++++++++++++--
 fs/stat.c     | 49 +++++++++++++++++++++++++++++++++++--------------
 3 files changed, 58 insertions(+), 17 deletions(-)

base-commit: 5c1ee569660d4a205dced9cb4d0306b907fb7599

Signature · 1 line
2.30.2
#1 lore raw

PATCH v4 1/1 io-uring: Make statx API stable

One of the key architectual tenets is to keep the parameters for io-uring stable. After the call has been submitted, its value can be changed. Unfortunaltely this is not the case for the current statx implementation.

IO-Uring change:
This changes replaces the const char * filename pointer in the io_statx structure with a struct filename *. In addition it also creates the filename object during the prepare phase.

With this change, the opcode also needs to invoke cleanup, so the filename object gets freed after processing the request.

fs change:
This replaces the const char* __user filename parameter in the two functions do_statx and vfs_statx with a struct filename *. In addition to be able to correctly construct a filename object a new helper function getname_statx_lookup_flags is introduced. The function makes sure that do_statx and vfs_statx is invoked with the correct lookup flags.

---
 fs/internal.h |  4 +++-
 fs/io_uring.c | 22 ++++++++++++++++++++--
 fs/stat.c     | 49 +++++++++++++++++++++++++++++++++++--------------
 3 files changed, 58 insertions(+), 17 deletions(-)
fs/internal.h +3 -1
index 8590c973c2f4..56c0477f4215 100644
@@ -184,7 +184,9 @@ int sb_init_dio_done_wq(struct super_block *sb);
 /*
  * fs/stat.c:
  */
-int do_statx(int dfd, const char __user *filename, unsigned flags,
+
+int getname_statx_lookup_flags(int flags);
+int do_statx(int dfd, struct filename *filename, unsigned int flags,
 	     unsigned int mask, struct statx __user *buffer);
 
 /*
fs/io_uring.c +20 -2
index 77b9c7e4793b..28b09b163df1 100644
@@ -642,7 +642,7 @@ struct io_statx {
 	int				dfd;
 	unsigned int			mask;
 	unsigned int			flags;
-	const char __user		*filename;
+	struct filename			*filename;
 	struct statx __user		*buffer;
 };
 
@@ -4721,6 +4721,8 @@ static int io_fadvise(struct io_kiocb *req, unsigned int issue_flags)
 
 static int io_statx_prep(struct io_kiocb *req, const struct io_uring_sqe *sqe)
 {
+	const char __user *path;
+
 	if (unlikely(req->ctx->flags & IORING_SETUP_IOPOLL))
 		return -EINVAL;
 	if (sqe->ioprio || sqe->buf_index || sqe->splice_fd_in)
@@ -4730,10 +4732,22 @@ static int io_statx_prep(struct io_kiocb *req, const struct io_uring_sqe *sqe)
 
 	req->statx.dfd = READ_ONCE(sqe->fd);
 	req->statx.mask = READ_ONCE(sqe->len);
-	req->statx.filename = u64_to_user_ptr(READ_ONCE(sqe->addr));
+	path = u64_to_user_ptr(READ_ONCE(sqe->addr));
 	req->statx.buffer = u64_to_user_ptr(READ_ONCE(sqe->addr2));
 	req->statx.flags = READ_ONCE(sqe->statx_flags);
 
+	req->statx.filename = getname_flags(path,
+					getname_statx_lookup_flags(req->statx.flags),
+					NULL);
+
+	if (IS_ERR(req->statx.filename)) {
+		int ret = PTR_ERR(req->statx.filename);
+
+		req->statx.filename = NULL;
+		return ret;
+	}
+
+	req->flags |= REQ_F_NEED_CLEANUP;
 	return 0;
 }
 
@@ -6708,6 +6722,10 @@ static void io_clean_op(struct io_kiocb *req)
 			putname(req->hardlink.oldpath);
 			putname(req->hardlink.newpath);
 			break;
+		case IORING_OP_STATX:
+			if (req->statx.filename)
+				putname(req->statx.filename);
+			break;
 		}
 	}
 	if ((req->flags & REQ_F_POLLED) && req->apoll) {
fs/stat.c +35 -14

89 lines not on this page · raw message

Signature · 1 line
2.30.2
maintainer Applied
#3 lore raw
In reply to Stefan Roesch
Quoted 5 lines · Stefan Roesch

One of the key architectual tenets of io-uring is to keep the parameters for io-uring stable. After the call has been submitted, its value can be changed. Unfortunaltely this is not the case for the current statx implementation.

Quoted 7 lines

Patch:
Part 1: fs: replace const char* parameter in vfs_statx and do_statx with
struct filename
Create filename object outside of do_statx and vfs_statx, so io-uring can create the filename object during the prepare phase

[...]

Applied, thanks!

[1/1] io-uring: Make statx API stable

      commit: c22368edfa24ec033f9328b3328aaa0349c15e6c

Best regards,

Signature · 1 line
Jens Axboe
Tested-by on v4 1/1
#2 lore raw

Re: [PATCH v4 1/1] io-uring: Make statx API stable

In reply to Stefan Roesch
Quoted 13 lines · Stefan Roesch

One of the key architectual tenets is to keep the parameters for io-uring stable. After the call has been submitted, its value can be changed. Unfortunaltely this is not the case for the current statx implementation.

IO-Uring change:
This changes replaces the const char * filename pointer in the io_statx structure with a struct filename *. In addition it also creates the filename object during the prepare phase.

With this change, the opcode also needs to invoke cleanup, so the filename object gets freed after processing the request.

Quoted 8 lines

fs change:
This replaces the const char* __user filename parameter in the two functions do_statx and vfs_statx with a struct filename *. In addition to be able to correctly construct a filename object a new helper function getname_statx_lookup_flags is introduced. The function makes sure that do_statx and vfs_statx is invoked with the correct lookup flags.

At least it doesn't break my KVM boots anymore:

Luis