Add sendto(2) and recvfrom(2) support for io_uring
Subsystems (5)
v4 cover Add sendto(2) and recvfrom(2) support for io_uring
Hello,
This RFC patchset adds sendto(2) and recvfrom(2) support for io_uring. It also addresses an issue in the liburing GitHub repository [1].
## Motivations
1) By using sendto() and recvfrom() we can make the submission simpler compared to always using sendmsg() and recvmsg() from the userspace.
2) There is a historical patch that tried to add the same functionality, but did not end up being applied. [2]
Quoted 6 lines · Jens Axboe
In a private conversation with the author, a good point was brought up that the sendto/recvfrom do not require an allocation of an async context, if we need to defer or go async with the request. I think that's a major win, to be honest. There are other benefits as well (like shorter path), but to me, the async less part is nice and will reduce overhead
## Changes summary
There are 3 patches in this series.
PATCH 1/3 renames io_recv to io_recvfrom and io_send to io_sendto. Note that:
send(sockfd, buf, len, flags);
is equivalent to
sendto(sockfd, buf, len, flags, NULL, 0);
and
recv(sockfd, buf, len, flags);
is equivalent to
recvfrom(sockfd, buf, len, flags, NULL, NULL);
So it is saner to have send and recv directed to sendto and recvfrom instead of the opposite with respect to the name.
PATCH 2/3 makes move_addr_to_user() be a non static function. This function lives in net/socket.c, we need to call this from io_uring to add recvfrom() support for io_uring. Added net files maintainers to the CC list.
PATCH 3/3 adds sendto(2) and recvfrom(2) support for io_uring. Added two new opcodes: IORING_OP_SENDTO and IORING_OP_RECVFROM.
## How to test
This patchset is based on "for-next" branch in Jens' tree commit:
c1537fd063e2f1dbd96d8f68b405a66297ee306f ("Merge branch 'for-5.17/drivers' into for-next")
It is also available in the Git repository at:
https://github.com/ammarfaizi2/linux-block.git ammarfaizi2/linux-block/io_uring-recvfrom-sendto.v4
Test with liburing (added the liburing support, docs, and test program), the liburing support is based on liburing "master" branch commit:
918d8061ffdfdf253806a1e8e141c71644e678bd ("Remove getdents support")
It is available in the Git repository at:
https://github.com/ammarfaizi2/liburing.git sendto-recvfrom.v2
Please review and comment.
---
RFC v4 (this patchset):
- Rebase the work (sync with "for-next" branch in Jens' tree).
- Remove Tested-by tag from Nugra as we have changes.
- (Address Praveen's comment) Zero sendto_addr_len and
`recvfrom_addr_len` on prep when the `req->opcode` is not
`IORING_OP_{SENDTO,RECVFROM}`.RFC v3:
- Fix build error when CONFIG_NET is undefined for PATCH 1/3. I tried to fix it in PATCH 3/3, but it should be fixed in PATCH 1/3, otherwise it breaks the build in PATCH 1/3.
- Added io_uring_prep_{sendto,recvfrom} docs to the liburing.
RFC v2:
- Rebase the work, now this patchset is based on commit
bb3294e22482db4b7ec ("Merge branch 'for-5.17/drivers' into
for-next"). - In io_recvfrom(), mark the error check of move_addr_to_user() call as unlikely.
- Fix build error when CONFIG_NET is undefined.
- Update liburing test (the branch is still the same, just force pushed).
- Added Nugra to CC list (tester).
---
RFC v3: https://lore.kernel.org/io-uring/[email protected]/
RFC v2: https://lore.kernel.org/io-uring/[email protected]/
RFC v1: https://lore.kernel.org/io-uring/[email protected]/
---
Ammar Faizi (3):
io_uring: Rename io_{send,recv} to io_{sendto,recvfrom}
net: Make move_addr_to_user() be a non static function
io_uring: Add sendto(2) and recvfrom(2) support
fs/io_uring.c | 94 +++++++++++++++++++++++++++++++---- include/linux/socket.h | 2 + include/uapi/linux/io_uring.h | 5 +- net/socket.c | 4 +- 4 files changed, 92 insertions(+), 13 deletions(-)
base-commit: c1537fd063e2f1dbd96d8f68b405a66297ee306f
Signature · 1 line
2.32.0
RFC PATCH v4 1/3 io_uring: Rename `io_{send,recv}` to `io_{sendto,recvfrom}`
Currently we can perform send and recv via io_uring. And now, we are going to add sendto and recvfrom support for io_uring.
Note that:
Calling send(fd, buf, len, flags) is equivalent to calling sendto(fd, buf, len, flags, NULL, 0). Therefore, sendto is a superset of send.
Calling recv(fd, buf, len, flags) is equivalent to calling recvfrom(fd, buf, len, flags, NULL, NULL). Therefore, recvfrom is a superset of recv.
As such, let's direct the current supported IORING_OP_{SEND,RECV} to io_{sendto,recvfrom}. These functions will also be used for IORING_OP_{SENDTO,RECVFROM} operation in the next patches.
---
v4:
- Rebase the work (sync with "for-next" branch in Jens' tree).
v3:
- Fix build error when CONFIG_NET is undefined for PATCH 1/3. I tried to fix it in PATCH 3/3, but it should be fixed in PATCH 1/3, otherwise it breaks the build in PATCH 1/3.
v2:
- Added Nugra to CC list (tester).
---
--- fs/io_uring.c | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-)
fs/io_uring.c +6 -6
@@ -4947,7 +4947,7 @@ static int io_sendmsg(struct io_kiocb *req, unsigned int issue_flags)return 0 ; } -static int io_send (struct io_kiocb *req,unsigned int issue_flags) +static int io_sendto (struct io_kiocb *req,unsigned int issue_flags) {struct io_sr_msg *sr = &req->sr_msg;struct msghdr msg;
@@ -5173,7 +5173,7 @@ static int io_recvmsg(struct io_kiocb *req, unsigned int issue_flags)return 0 ; } -static int io_recv (struct io_kiocb *req,unsigned int issue_flags) +static int io_recvfrom (struct io_kiocb *req,unsigned int issue_flags) {struct io_buffer *kbuf;struct io_sr_msg *sr = &req->sr_msg;
@@ -5381,8 +5381,8 @@ IO_NETOP_PREP_ASYNC(sendmsg);IO_NETOP_PREP_ASYNC (recvmsg);IO_NETOP_PREP_ASYNC (connect);IO_NETOP_PREP (accept); -IO_NETOP_FN (send); -IO_NETOP_FN (recv); +IO_NETOP_FN (sendto); +IO_NETOP_FN (recvfrom);#endif /* CONFIG_NET */ struct io_poll_table {
@@ -6710,13 +6710,13 @@ static int io_issue_sqe(struct io_kiocb *req, unsigned int issue_flags) ret =io_sendmsg (req, issue_flags);break ;case IORING_OP_SEND : - ret =io_send (req, issue_flags); + ret =io_sendto (req, issue_flags);break ;case IORING_OP_RECVMSG : ret =io_recvmsg (req, issue_flags);break ;case IORING_OP_RECV : - ret =io_recv (req, issue_flags); + ret =io_recvfrom (req, issue_flags);break ;case IORING_OP_TIMEOUT : ret =io_timeout (req, issue_flags);
Signature · 1 line
2.32.0
RFC PATCH v4 2/3 net: Make `move_addr_to_user()` be a non static function
In reply to Ammar FaiziIn order to add recvfrom support for io_uring, we need to call move_addr_to_user() from fs/io_uring.c.
This makes move_addr_to_user() be a non static function so we can call it from io_uring.
---
v4:
* No changes *
v3:
* No changes *
v2:
- Added Nugra to CC list (tester).
---
--- include/linux/socket.h | 2 ++ net/socket.c | 4 ++-- 2 files changed, 4 insertions(+), 2 deletions(-)
include/linux/socket.h +2 -0
@@ -371,6 +371,8 @@ struct ucred {#define IPX_TYPE 1extern int move_addr_to_kernel (void __user *uaddr,int ulen,struct sockaddr_storage *kaddr); +extern int move_addr_to_user (struct sockaddr_storage *kaddr,int klen, +void __user *uaddr,int __user *ulen);extern int put_cmsg (struct msghdr *,int level,int type,int len,void *data);struct timespec64 ;
net/socket.c +2 -2
@@ -267,8 +267,8 @@ int move_addr_to_kernel(void __user *uaddr, int ulen, struct sockaddr_storage *k* specified. Zero is returned for a success. */ -static int move_addr_to_user (struct sockaddr_storage *kaddr,int klen, -void __user *uaddr,int __user *ulen) +int move_addr_to_user (struct sockaddr_storage *kaddr,int klen, +void __user *uaddr,int __user *ulen) {int err;int len;
Signature · 1 line
2.32.0
RFC PATCH v4 3/3 io_uring: Add `sendto(2)` and `recvfrom(2)` support
In reply to Ammar FaiziThis adds sendto(2) and recvfrom(2) support for io_uring.
New opcodes:
IORING_OP_SENDTO
IORING_OP_RECVFROM
---
v4:
- Rebase the work (sync with "for-next" branch in Jens' tree).
- Remove Tested-by tag from Nugra as this patch changes.
- (Address Praveen's comment) Zero sendto_addr_len and
`recvfrom_addr_len` on prep when the `req->opcode` is not
`IORING_OP_{SENDTO,RECVFROM}`.v3:
- Fix build error when CONFIG_NET is undefined should be done in the first patch, not this patch.
- Add Tested-by tag from Nugra.
v2:
- In io_recvfrom(), mark the error check of move_addr_to_user() call as unlikely.
- Fix build error when CONFIG_NET is undefined.
- Added Nugra to CC list (tester).
---
--- fs/io_uring.c | 82 +++++++++++++++++++++++++++++++++-- include/uapi/linux/io_uring.h | 5 ++- 2 files changed, 82 insertions(+), 5 deletions(-)
fs/io_uring.c +78 -4
@@ -574,7 +574,15 @@ struct io_sr_msg {union {struct compat_msghdr __user *umsg_compat;struct user_msghdr __user *umsg; -void __user *buf; + +struct { +void __user *buf; +struct sockaddr __user *addr; +union { +int sendto_addr_len; +int __user *recvfrom_addr_len; + }; + }; };int msg_flags;int bgid;
@@ -1105,6 +1113,19 @@ static const struct io_op_def io_op_defs[] = { [IORING_OP_MKDIRAT] = {}, [IORING_OP_SYMLINKAT] = {}, [IORING_OP_LINKAT] = {}, + [IORING_OP_SENDTO ] = { + .needs_file =1 , + .unbound_nonreg_file =1 , + .pollout =1 , + .audit_skip =1 , + }, + [IORING_OP_RECVFROM ] = { + .needs_file =1 , + .unbound_nonreg_file =1 , + .pollin =1 , + .buffer_select =1 , + .audit_skip =1 , + }, };/* requests with any of those set should undergo io_disarm_next() */
@@ -4890,12 +4911,25 @@ static int io_sendmsg_prep(struct io_kiocb *req, const struct io_uring_sqe *sqe)if (unlikely (req->ctx->flags &IORING_SETUP_IOPOLL ))return -EINVAL ; +/* +* For IORING_OP_SEND{,TO}, the assignment to @sr->umsg +* is equivalent to an assignment to @sr->buf. +*/ sr->umsg =u64_to_user_ptr (READ_ONCE (sqe->addr)); + sr->len =READ_ONCE (sqe->len); sr->msg_flags =READ_ONCE (sqe->msg_flags) |MSG_NOSIGNAL ;if (sr->msg_flags &MSG_DONTWAIT ) req->flags |=REQ_F_NOWAIT ; +if (req->opcode ==IORING_OP_SENDTO ) { + sr->addr =u64_to_user_ptr (READ_ONCE (sqe->addr2)); + sr->sendto_addr_len =READ_ONCE (sqe->addr3); + }else { + sr->addr = (struct sockaddr __user *)NULL ; + sr->sendto_addr_len =0 ; + } +#ifdef CONFIG_COMPAT if (req->ctx->compat) sr->msg_flags |=MSG_CMSG_COMPAT ;
@@ -4949,6 +4983,7 @@ static int io_sendmsg(struct io_kiocb *req, unsigned int issue_flags)static int io_sendto (struct io_kiocb *req,unsigned int issue_flags) { +struct sockaddr_storage address;struct io_sr_msg *sr = &req->sr_msg;struct msghdr msg;struct iovec iov;
@@ -4965,10 +5000,20 @@ static int io_sendto(struct io_kiocb *req, unsigned int issue_flags)if (unlikely (ret))return ret; - msg.msg_name =NULL ; + msg.msg_control =NULL ; msg.msg_controllen =0 ; - msg.msg_namelen =0 ; +if (sr->addr) { + ret =move_addr_to_kernel (sr->addr, sr->sendto_addr_len, + &address); +if (unlikely (ret <0 )) + goto fail; + msg.msg_name = (struct sockaddr *) &address; + msg.msg_namelen = sr->sendto_addr_len; + }else { + msg.msg_name =NULL ; + msg.msg_namelen =0 ; + } flags = req->sr_msg.msg_flags;if (issue_flags &IO_URING_F_NONBLOCK )
@@ -4983,6 +5028,7 @@ static int io_sendto(struct io_kiocb *req, unsigned int issue_flags)return -EAGAIN ;if (ret == -ERESTARTSYS ) ret = -EINTR ; +fail:req_set_fail (req); }__io_req_complete (req, issue_flags, ret,0 );
@@ -5101,13 +5147,26 @@ static int io_recvmsg_prep(struct io_kiocb *req, const struct io_uring_sqe *sqe)if (unlikely (req->ctx->flags &IORING_SETUP_IOPOLL ))return -EINVAL ; +/* +* For IORING_OP_RECV{,FROM}, the assignment to @sr->umsg +* is equivalent to an assignment to @sr->buf. +*/ sr->umsg =u64_to_user_ptr (READ_ONCE (sqe->addr)); + sr->len =READ_ONCE (sqe->len); sr->bgid =READ_ONCE (sqe->buf_group); sr->msg_flags =READ_ONCE (sqe->msg_flags) |MSG_NOSIGNAL ;if (sr->msg_flags &MSG_DONTWAIT ) req->flags |=REQ_F_NOWAIT ; +if (req->opcode ==IORING_OP_RECVFROM ) { + sr->addr =u64_to_user_ptr (READ_ONCE (sqe->addr2)); + sr->recvfrom_addr_len =u64_to_user_ptr (READ_ONCE (sqe->addr3)); + }else { + sr->addr = (struct sockaddr __user *)NULL ; + sr->recvfrom_addr_len = (int __user *)NULL ; + } +#ifdef CONFIG_COMPAT if (req->ctx->compat) sr->msg_flags |=MSG_CMSG_COMPAT ;
@@ -5183,6 +5242,7 @@ static int io_recvfrom(struct io_kiocb *req, unsigned int issue_flags)struct iovec iov;unsigned flags;int ret, min_ret =0 ; +struct sockaddr_storage address;bool force_nonblock = issue_flags &IO_URING_F_NONBLOCK ; sock =sock_from_file (req->file);
@@ -5200,9 +5260,10 @@ static int io_recvfrom(struct io_kiocb *req, unsigned int issue_flags)if (unlikely (ret)) goto out_free; - msg.msg_name =NULL ; + msg.msg_name = sr->addr ? (struct sockaddr *) &address :NULL ; msg.msg_control =NULL ; msg.msg_controllen =0 ; +/* We assume all kernel code knows the size of sockaddr_storage */ msg.msg_namelen =0 ; msg.msg_iocb =NULL ; msg.msg_flags =0 ;
@@ -5214,6 +5275,15 @@ static int io_recvfrom(struct io_kiocb *req, unsigned int issue_flags) min_ret =iov_iter_count (&msg.msg_iter); ret =sock_recvmsg (sock, &msg, flags); +if (ret >=0 && sr->addr !=NULL ) { +int tmp; + + tmp =move_addr_to_user (&address, msg.msg_namelen, sr->addr, + sr->recvfrom_addr_len); +if (unlikely (tmp <0 )) + ret = tmp; + } + out_free:if (ret < min_ret) {if (ret == -EAGAIN && force_nonblock)
@@ -6452,9 +6522,11 @@ static int io_req_prep(struct io_kiocb *req, const struct io_uring_sqe *sqe)case IORING_OP_SYNC_FILE_RANGE :return io_sfr_prep (req, sqe);case IORING_OP_SENDMSG : +case IORING_OP_SENDTO :case IORING_OP_SEND :return io_sendmsg_prep (req, sqe);case IORING_OP_RECVMSG : +case IORING_OP_RECVFROM :case IORING_OP_RECV :return io_recvmsg_prep (req, sqe);case IORING_OP_CONNECT :
@@ -6709,12 +6781,14 @@ static int io_issue_sqe(struct io_kiocb *req, unsigned int issue_flags)case IORING_OP_SENDMSG : ret =io_sendmsg (req, issue_flags);break ; +case IORING_OP_SENDTO :case IORING_OP_SEND : ret =io_sendto (req, issue_flags);break ;case IORING_OP_RECVMSG : ret =io_recvmsg (req, issue_flags);break ; +case IORING_OP_RECVFROM :case IORING_OP_RECV : ret =io_recvfrom (req, issue_flags);break ;
include/uapi/linux/io_uring.h +4 -1
@@ -60,7 +60,8 @@ struct io_uring_sqe {__s32 splice_fd_in;__u32 file_index; }; -__u64 __pad2[2 ]; +__u64 addr3; +__u64 __pad2[1 ]; };enum {
@@ -143,6 +144,8 @@ enum {IORING_OP_MKDIRAT ,IORING_OP_SYMLINKAT ,IORING_OP_LINKAT , +IORING_OP_SENDTO , +IORING_OP_RECVFROM ,/* this goes last, obviously */ IORING_OP_LAST,
Signature · 1 line
2.32.0