io_uring: Add macro to validate SQE cmd size
Subsystems (6)
cover io_uring: Add macro to validate SQE cmd size
This patch series introduces macros IO_URING_SQE_CMD() and IO_URING_SQE128_CMD() for accessing cmd struct from io_uring SQEs, providing compile-time type checking and size validation. The series also updates ublk driver to check the SQE128 flag before accessing the cmd structure.
Testing:
- Compile test only. (trivial changes)
- Validated IO_URING_SQE_CMD() and IO_URING_SQE128_CMD() with struct size < 16, = 16, > 16 for IO_URING_SQE_CMD() and < 80, = 80, > 80 for IO_URING_SQE128_CMD().
Govindarajulu Varadarajan (2):
io_uring: Add size check for sqe->cmd block/ublk_drv: Validate SQE128 flag before accessing the cmd
drivers/block/ublk_drv.c | 20 +++++++++++--------- drivers/nvme/host/ioctl.c | 2 +- fs/fuse/dev_uring.c | 6 ++++-- include/linux/io_uring/cmd.h | 15 +++++++++++---- 4 files changed, 27 insertions(+), 16 deletions(-)
Signature · 1 line
2.52.0
PATCH 1/2 io_uring: Add size check for sqe->cmd
For SQE128, sqe->cmd provides 80 bytes for uring_cmd. Add macro to check if size of user struct does not exceed 80 bytes at compile time. User doesn't have to track this manually during development.
Replace io_uring_sqe_cmd() with IO_URING_SQE_CMD() which checks struct size for 16 bytes cmd.
--- drivers/block/ublk_drv.c | 14 ++++++++------ drivers/nvme/host/ioctl.c | 2 +- fs/fuse/dev_uring.c | 6 ++++-- include/linux/io_uring/cmd.h | 15 +++++++++++---- 4 files changed, 24 insertions(+), 13 deletions(-)
drivers/block/ublk_drv.c +8 -6
@@ -3155,7 +3155,7 @@ static int ublk_ch_uring_cmd_local(struct io_uring_cmd *cmd, unsigned int issue_flags) {/* May point to userspace-mapped memory */ -const struct ublksrv_io_cmd *ub_src =io_uring_sqe_cmd (cmd->sqe); + const struct ublksrv_io_cmd *ub_src = IO_URING_SQE_CMD(cmd->sqe, struct ublksrv_io_cmd);u16 buf_idx =UBLK_INVALID_BUF_IDX ;struct ublk_device *ub = cmd->file->private_data;struct ublk_queue *ubq;
@@ -3735,7 +3735,7 @@ static int ublk_validate_batch_fetch_cmd(struct ublk_batch_io_data *data)static int ublk_handle_non_batch_cmd (struct io_uring_cmd *cmd,unsigned int issue_flags) { -const struct ublksrv_io_cmd *ub_cmd =io_uring_sqe_cmd (cmd->sqe); + const struct ublksrv_io_cmd *ub_cmd = IO_URING_SQE_CMD(cmd->sqe, struct ublksrv_io_cmd);struct ublk_device *ub = cmd->file->private_data;unsigned tag =READ_ONCE (ub_cmd->tag);unsigned q_id =READ_ONCE (ub_cmd->q_id);
@@ -3764,7 +3764,7 @@ static int ublk_handle_non_batch_cmd(struct io_uring_cmd *cmd,static int ublk_ch_batch_io_uring_cmd (struct io_uring_cmd *cmd,unsigned int issue_flags) { -const struct ublk_batch_io *uc =io_uring_sqe_cmd (cmd->sqe); + const struct ublk_batch_io *uc = IO_URING_SQE_CMD(cmd->sqe, struct ublk_batch_io);struct ublk_device *ub = cmd->file->private_data;struct ublk_batch_io_data data = { .ub = ub,
@@ -4653,7 +4653,8 @@ static int ublk_ctrl_del_dev(struct ublk_device **p_ub, bool wait)static inline void ublk_ctrl_cmd_dump (struct io_uring_cmd *cmd) { -const struct ublksrv_ctrl_cmd *header =io_uring_sqe_cmd (cmd->sqe); +const struct ublksrv_ctrl_cmd *header =IO_URING_SQE128_CMD (cmd->sqe, + struct ublksrv_ctrl_cmd); pr_devel("%s: cmd_op %x, dev id %d qid %d data %llx buf %llx len %u\n", __func__, cmd->cmd_op, header->dev_id, header->queue_id,
@@ -5061,7 +5062,7 @@ static int ublk_char_dev_permission(struct ublk_device *ub,static int ublk_ctrl_uring_cmd_permission (struct ublk_device *ub,struct io_uring_cmd *cmd) { -struct ublksrv_ctrl_cmd *header = (struct ublksrv_ctrl_cmd *)io_uring_sqe_cmd (cmd->sqe); + struct ublksrv_ctrl_cmd *header = IO_URING_SQE128_CMD(cmd->sqe, struct ublksrv_ctrl_cmd);bool unprivileged = ub->dev_info.flags &UBLK_F_UNPRIVILEGED_DEV ;void __user *argp = (void __user *)(unsigned long )header->addr;char *dev_path =NULL ;
@@ -5152,7 +5153,8 @@ static bool ublk_ctrl_uring_cmd_may_sleep(u32 cmd_op)static int ublk_ctrl_uring_cmd (struct io_uring_cmd *cmd,unsigned int issue_flags) { -const struct ublksrv_ctrl_cmd *header =io_uring_sqe_cmd (cmd->sqe); +const struct ublksrv_ctrl_cmd *header =IO_URING_SQE128_CMD (cmd->sqe, + struct ublksrv_ctrl_cmd);struct ublk_device *ub =NULL ;u32 cmd_op = cmd->cmd_op;int ret = -EINVAL ;
drivers/nvme/host/ioctl.c +1 -1
@@ -447,7 +447,7 @@ static int nvme_uring_cmd_io(struct nvme_ctrl *ctrl, struct nvme_ns *ns, struct io_uring_cmd *ioucmd, unsigned int issue_flags, bool vec) { struct nvme_uring_cmd_pdu *pdu = nvme_uring_cmd_pdu(ioucmd); -const struct nvme_uring_cmd *cmd =io_uring_sqe_cmd (ioucmd->sqe); + const struct nvme_uring_cmd *cmd = IO_URING_SQE128_CMD(ioucmd->sqe, struct nvme_uring_cmd);struct request_queue *q = ns ? ns->queue : ctrl->admin_q;struct nvme_uring_data d;struct nvme_command c;
fs/fuse/dev_uring.c +4 -2
@@ -879,7 +879,8 @@ static int fuse_ring_ent_set_commit(struct fuse_ring_ent *ent)static int fuse_uring_commit_fetch (struct io_uring_cmd *cmd,int issue_flags,struct fuse_conn *fc) { -const struct fuse_uring_cmd_req *cmd_req =io_uring_sqe_cmd (cmd->sqe); +const struct fuse_uring_cmd_req *cmd_req =IO_URING_SQE128_CMD (cmd->sqe, + struct fuse_uring_cmd_req);struct fuse_ring_ent *ent;int err;struct fuse_ring *ring = fc->ring;
@@ -1083,7 +1084,8 @@ fuse_uring_create_ring_ent(struct io_uring_cmd *cmd,static int fuse_uring_register (struct io_uring_cmd *cmd,unsigned int issue_flags,struct fuse_conn *fc) { -const struct fuse_uring_cmd_req *cmd_req =io_uring_sqe_cmd (cmd->sqe); +const struct fuse_uring_cmd_req *cmd_req =IO_URING_SQE128_CMD (cmd->sqe, + struct fuse_uring_cmd_req);struct fuse_ring *ring =smp_load_acquire (&fc->ring);struct fuse_ring_queue *queue;struct fuse_ring_ent *ent;
include/linux/io_uring/cmd.h +11 -4
@@ -20,10 +20,17 @@ struct io_uring_cmd {u8 unused[8 ]; }; -static inline const void *io_uring_sqe_cmd (const struct io_uring_sqe *sqe) -{ -return sqe->cmd; -} +#define IO_URING_SQE128_CMD (sqe, type) ({ \ + BUILD_BUG_ON(sizeof(type) > ((2 * sizeof(struct io_uring_sqe)) - \ + offsetof(struct io_uring_sqe, cmd))); \ + (type *)(sqe)->cmd; \ +}) + +#define IO_URING_SQE_CMD (sqe, type) ({ \ + BUILD_BUG_ON(sizeof(type) > ((sizeof(struct io_uring_sqe)) - \ + offsetof(struct io_uring_sqe, cmd))); \ + (type *)(sqe)->cmd; \ +})static inline void io_uring_cmd_private_sz_check (size_t cmd_sz) {
Signature · 1 line
2.52.0
Jens Axboe
maintainerRe: [PATCH 1/2] io_uring: Add size check for sqe->cmd
Quoted 6 lines · Govindarajulu Varadarajan
For SQE128,
sqe->cmdprovides 80 bytes foruring_cmd. Add macro to check if size of user struct does not exceed 80 bytes at compile time. User doesn't have to track this manually during development.Replace
io_uring_sqe_cmd()withIO_URING_SQE_CMD()which checks struct size for 16 bytes cmd.
Can't we just retain the normal lower case one and add the check? That's what we do for normal inside sqe data, with io_kiocb_to_cmd(). There should be no need for all-caps here.
Signature · 1 line
Jens Axboe
Re: [PATCH 1/2] io_uring: Add size check for sqe->cmd
In reply to Govindarajulu VaradarajanQuoted 81 lines · Govindarajulu Varadarajan
For SQE128,
sqe->cmdprovides 80 bytes foruring_cmd. Add macro to check if size of user struct does not exceed 80 bytes at compile time. User doesn't have to track this manually during development.Replace
io_uring_sqe_cmd()withIO_URING_SQE_CMD()which checks struct size for 16 bytes cmd.Signed-off-by Govindarajulu Varadarajan <[email protected]>--- drivers/block/ublk_drv.c | 14 ++++++++------ drivers/nvme/host/ioctl.c | 2 +- fs/fuse/dev_uring.c | 6 ++++-- include/linux/io_uring/cmd.h | 15 +++++++++++---- 4 files changed, 24 insertions(+), 13 deletions(-)drivers/block/ublk_drv.c +8
-6@@ -3155,7 +3155,7 @@ static int ublk_ch_uring_cmd_local(struct io_uring_cmd *cmd, unsigned int issue_flags) {/* May point to userspace-mapped memory */ -const struct ublksrv_io_cmd *ub_src =io_uring_sqe_cmd (cmd->sqe); + const struct ublksrv_io_cmd *ub_src = IO_URING_SQE_CMD(cmd->sqe, struct ublksrv_io_cmd);u16 buf_idx =UBLK_INVALID_BUF_IDX ;struct ublk_device *ub = cmd->file->private_data;struct ublk_queue *ubq;@@ -3735,7 +3735,7 @@ static int ublk_validate_batch_fetch_cmd(struct ublk_batch_io_data *data)static int ublk_handle_non_batch_cmd (struct io_uring_cmd *cmd,unsigned int issue_flags) { -const struct ublksrv_io_cmd *ub_cmd =io_uring_sqe_cmd (cmd->sqe); + const struct ublksrv_io_cmd *ub_cmd = IO_URING_SQE_CMD(cmd->sqe, struct ublksrv_io_cmd);struct ublk_device *ub = cmd->file->private_data;unsigned tag =READ_ONCE (ub_cmd->tag);unsigned q_id =READ_ONCE (ub_cmd->q_id);@@ -3764,7 +3764,7 @@ static int ublk_handle_non_batch_cmd(struct io_uring_cmd *cmd,static int ublk_ch_batch_io_uring_cmd (struct io_uring_cmd *cmd,unsigned int issue_flags) { -const struct ublk_batch_io *uc =io_uring_sqe_cmd (cmd->sqe); + const struct ublk_batch_io *uc = IO_URING_SQE_CMD(cmd->sqe, struct ublk_batch_io);struct ublk_device *ub = cmd->file->private_data;struct ublk_batch_io_data data = { .ub = ub,@@ -4653,7 +4653,8 @@ static int ublk_ctrl_del_dev(struct ublk_device **p_ub, bool wait)static inline void ublk_ctrl_cmd_dump (struct io_uring_cmd *cmd) { -const struct ublksrv_ctrl_cmd *header =io_uring_sqe_cmd (cmd->sqe); +const struct ublksrv_ctrl_cmd *header =IO_URING_SQE128_CMD (cmd->sqe, + struct ublksrv_ctrl_cmd); pr_devel("%s: cmd_op %x, dev id %d qid %d data %llx buf %llx len %u\n", __func__, cmd->cmd_op, header->dev_id, header->queue_id,@@ -5061,7 +5062,7 @@ static int ublk_char_dev_permission(struct ublk_device *ub,static int ublk_ctrl_uring_cmd_permission (struct ublk_device *ub,struct io_uring_cmd *cmd) { -struct ublksrv_ctrl_cmd *header = (struct ublksrv_ctrl_cmd *)io_uring_sqe_cmd (cmd->sqe); + struct ublksrv_ctrl_cmd *header = IO_URING_SQE128_CMD(cmd->sqe, struct ublksrv_ctrl_cmd);bool unprivileged = ub->dev_info.flags &UBLK_F_UNPRIVILEGED_DEV ;void __user *argp = (void __user *)(unsigned long )header->addr;char *dev_path =NULL ;@@ -5152,7 +5153,8 @@ static bool ublk_ctrl_uring_cmd_may_sleep(u32 cmd_op)static int ublk_ctrl_uring_cmd (struct io_uring_cmd *cmd,unsigned int issue_flags) { -const struct ublksrv_ctrl_cmd *header =io_uring_sqe_cmd (cmd->sqe); +const struct ublksrv_ctrl_cmd *header =IO_URING_SQE128_CMD (cmd->sqe, + struct ublksrv_ctrl_cmd);struct ublk_device *ub =NULL ;u32 cmd_op = cmd->cmd_op;int ret = -EINVAL ;drivers/nvme/host/ioctl.c +0
-0
drivers/nvme/host/ioctl.c static int nvme_uring_cmd_io(struct nvme_ctrl *ctrl, struct nvme_ns *ns, · line 450
Quoted 5 lines
drivers/nvme/host/ioctl.c +1
-1@@ -447,7 +447,7 @@ static int nvme_uring_cmd_io(struct nvme_ctrl *ctrl, struct nvme_ns *ns, struct io_uring_cmd *ioucmd, unsigned int issue_flags, bool vec) { struct nvme_uring_cmd_pdu *pdu = nvme_uring_cmd_pdu(ioucmd); -const struct nvme_uring_cmd *cmd =io_uring_sqe_cmd (ioucmd->sqe); + const struct nvme_uring_cmd *cmd = IO_URING_SQE128_CMD(ioucmd->sqe, struct nvme_uring_cmd);
Some of these lines are quite long
Quoted 39 lines
drivers/nvme/host/ioctl.c +0
-0struct request_queue *q = ns ? ns->queue : ctrl->admin_q;struct nvme_uring_data d;struct nvme_command c;fs/fuse/dev_uring.c +4
-2@@ -879,7 +879,8 @@ static int fuse_ring_ent_set_commit(struct fuse_ring_ent *ent)static int fuse_uring_commit_fetch (struct io_uring_cmd *cmd,int issue_flags,struct fuse_conn *fc) { -const struct fuse_uring_cmd_req *cmd_req =io_uring_sqe_cmd (cmd->sqe); +const struct fuse_uring_cmd_req *cmd_req =IO_URING_SQE128_CMD (cmd->sqe, + struct fuse_uring_cmd_req);struct fuse_ring_ent *ent;int err;struct fuse_ring *ring = fc->ring;@@ -1083,7 +1084,8 @@ fuse_uring_create_ring_ent(struct io_uring_cmd *cmd,static int fuse_uring_register (struct io_uring_cmd *cmd,unsigned int issue_flags,struct fuse_conn *fc) { -const struct fuse_uring_cmd_req *cmd_req =io_uring_sqe_cmd (cmd->sqe); +const struct fuse_uring_cmd_req *cmd_req =IO_URING_SQE128_CMD (cmd->sqe, + struct fuse_uring_cmd_req);struct fuse_ring *ring =smp_load_acquire (&fc->ring);struct fuse_ring_queue *queue;struct fuse_ring_ent *ent;include/linux/io_uring/cmd.h +0
-4@@ -20,10 +20,17 @@ struct io_uring_cmd {u8 unused[8 ]; }; -static inline const void *io_uring_sqe_cmd (const struct io_uring_sqe *sqe) -{ -return sqe->cmd; -}
include/linux/io_uring/cmd.h struct io_uring_cmd { · line 32
Quoted 10 lines
include/linux/io_uring/cmd.h +10
-0+#define IO_URING_SQE128_CMD (sqe, type) ({ \ + BUILD_BUG_ON(sizeof(type) > ((2 * sizeof(struct io_uring_sqe)) - \ + offsetof(struct io_uring_sqe, cmd))); \ + (type *)(sqe)->cmd; \ +}) + +#define IO_URING_SQE_CMD (sqe, type) ({ \ + BUILD_BUG_ON(sizeof(type) > ((sizeof(struct io_uring_sqe)) - \ + offsetof(struct io_uring_sqe, cmd))); \ + (type *)(sqe)->cmd;
Can we continue to return a const pointer? It would be buggy for a uring_cmd implementation to write to the the io_uring_sqe, which may live in userspace-mapped memory.
Best,
Caleb
\
Quoted 8 lines
include/linux/io_uring/cmd.h +1
-1+})static inline void io_uring_cmd_private_sz_check (size_t cmd_sz) { --2.52.0
Christoph Hellwig
maintainerRe: [PATCH 1/2] io_uring: Add size check for sqe->cmd
In reply to Govindarajulu Varadarajandrivers/block/ublk_drv.c static int ublk_ch_uring_cmd_local(struct io_uring_cmd *cmd, · line 3158
Quoted 2 lines · Govindarajulu Varadarajan
drivers/block/ublk_drv.c +1
-1-const struct ublksrv_io_cmd *ub_src =io_uring_sqe_cmd (cmd->sqe); + const struct ublksrv_io_cmd *ub_src = IO_URING_SQE_CMD(cmd->sqe, struct ublksrv_io_cmd);
As Jens already said, no need for the shouting. Also please break the lines to keep things readable.
Quoted 5 lines
include/linux/io_uring/cmd.h +1
-4-static inline const void *io_uring_sqe_cmd (const struct io_uring_sqe *sqe) -{ -return sqe->cmd; -} +#define IO_URING_SQE128_CMD (sqe, type) ({ \
include/linux/io_uring/cmd.h struct io_uring_cmd { · line 33
Quoted 10 lines
include/linux/io_uring/cmd.h +10
-0+BUILD_BUG_ON (sizeof (type) > ((2 *sizeof (struct io_uring_sqe )) - \ + offsetof(struct io_uring_sqe , cmd))); \ + (type *)(sqe)->cmd; \ +}) + +#define IO_URING_SQE_CMD (sqe, type) ({ \ + BUILD_BUG_ON(sizeof(type) > ((sizeof(struct io_uring_sqe)) - \ + offsetof(struct io_uring_sqe, cmd))); \ + (type *)(sqe)->cmd; \ +})
I'm also not sure adding a BUILD_BUG_ON to every derefence is great for compile times. But I'm not really sure what would be a good other place for it.
PATCH 2/2 block/ublk_drv: Validate SQE128 flag before accessing the cmd
In reply to Govindarajulu Varadarajanublk_ctrl_cmd_dump() accesses (header *)sqe->cmd before IO_URING_F_SQE128 flag check. This could cause out of boundary memory access.
Move the SQE128 flag check earlier in ublk_ctrl_uring_cmd() to return -EINVAL immediately if the flag is not set.
--- drivers/block/ublk_drv.c | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)
drivers/block/ublk_drv.c +3 -3
@@ -5163,10 +5163,10 @@ static int ublk_ctrl_uring_cmd(struct io_uring_cmd *cmd, issue_flags & IO_URING_F_NONBLOCK)return -EAGAIN ; -ublk_ctrl_cmd_dump (cmd); -if (!(issue_flags &IO_URING_F_SQE128 )) - goto out; +return -EINVAL ; + +ublk_ctrl_cmd_dump (cmd); ret =ublk_check_cmd_op (cmd_op);if (ret)
Signature · 1 line
2.52.0