io_uring: add napi busy polling support
Subsystems (3)
v14 cover io_uring: add napi busy polling support
This adds the napi busy polling support in io_uring.c. It adds a new napi_list to the io_ring_ctx structure. This list contains the list of napi_id's that are currently enabled for busy polling. This list is used to determine which napi id's enabled busy polling. For faster access it also adds a hash table.
When a new napi id is added, the hash table is used to locate if the napi id has already been added. When processing the busy poll loop the list is used to process the individual elements.
io-uring allows specifying two parameters:
- busy poll timeout and
- prefer busy poll to call of io_napi_busy_loop()
This sets the above parameters for the ring. The settings are passed with a new structure io_uring_napi.
There is also a corresponding liburing patch series, which enables this feature. The name of the series is "liburing: add add api for napi busy poll timeout". It also contains two programs to test the this.
Testing has shown that the round-trip times are reduced to 38us from 55us by enabling napi busy polling with a busy poll timeout of 100us. More detailled results are part of the commit message of the first patch.
Changes:
- V14:
- Rephrased comment for napi_busy_loop_rcu() funnction
- Added new function _napi_busy_loop() to remove code duplication in napi_busy_loop() and napi_busy_loop_rcu()
- V13:
- split off __napi_busy_loop() from napi_busy_loop()
- introduce napi_busy_loop_no_lock()
- use napi_busy_loop_no_lock in io_napi_blocking_busy_loop
- V12:
- introduce io_napi_hash_find()
- use rcu for changes to the hash table
- use rcu for searching if a napi id is in the napi hash table
- use rcu hlist functions for adding and removing items from the hash table
- add stale entry detection in __io_napi_do_busy_loop and remove stale entries in io_napi_blocking_busy_loop() and io_napi_sqpoll_busy_loop()
- create io_napi_remove_stale() and __io_napi_remove_stale()
- __io_napi_do_busy_loop() takes additional loop_end_arg and does stale entry detection
- io_napi_multi_busy_loop is removed. Logic is moved to io_napi_blocking_busy_loop()
- io_napi_free uses rcu function to free
- io_napi_busy_loop no longer splices
- io_napi_sqpoll_busy_poll uses rcu
- V11:
- Fixed long comment lines and whitespace issues
- Refactor new code io_cqring_wait()
- Refactor io_napi_adjust_timeout() and remove adjust_timeout
- Rename io_napi_adjust_timeout to __io_napi_adjust_timeout
- Add new function io_napi_adjust_timeout
- Cleanup calls to list_is_singular() in io_napi_multi_busy_loop() and io_napi_blocking_busy_loop()
- Cleanup io_napi_busy_loop_should_end()
- Rename __io_napi_busy_loop to __io_napi_do_busy_loop()
- V10:
- Refreshed to io-uring/for-6.4
- Repeated performance measurements for 6.4 (same/similar results)
- V9:
- refreshed to io-uring/for-6.3
- folded patch 2 and 3 into patch 4
- fixed commit description for last 2 patches
- fixed some whitespace issues
- removed io_napi_busy_loop_on helper
- removed io_napi_setup_busy helper
- renamed io_napi_end_busy_loop to io_napi_busy_loop
- removed NAPI_LIST_HEAD macro
- split io_napi_blocking_busy_loop into two functions
- added io_napi function
- comment for sqpoll check
- V8:
- added new file napi.c and add napi functions to this file
- added NAPI_LIST_HEAD function so no ifdef is necessary
- added io_napi_init and io_napi_free function
- added io_napi_setup_busy loop helper function
- added io_napi_adjust_busy_loop helper function
- added io_napi_end_busy_loop helper function
- added io_napi_sqpoll_busy_poll helper function
- some of the definitions in napi.h are macros to avoid ifdef definitions in io_uring.c, poll.c and sqpoll.c
- changed signature of io_napi_add function
- changed size of hashtable to 16. The number of entries is limited by the number of nic queues.
- Removed ternary in io_napi_blocking_busy_loop
- Rewrote io_napi_blocking_busy_loop to make it more readable
- Split off 3 more patches
- V7:
- allow unregister with NULL value for arg parameter
- return -EOPNOTSUPP if CONFIG_NET_RX_BUSY_POLL is not enabled
- V6:
- Add a hash table on top of the list for faster access during the add operation. The linked list and the hash table use the same data structure
- V5:
- Refreshed to 6.1-rc6
- Use copy_from_user instead of memdup/kfree
- Removed the moving of napi_busy_poll_to
- Return -EINVAL if any of the reserved or padded fields are not 0.
- V4:
- Pass structure for napi config, instead of individual parameters
- V3:
- Refreshed to 6.1-rc5
- Added a new io-uring api for the prefer napi busy poll api and wire it to io_napi_busy_loop().
- Removed the unregister (implemented as register)
- Added more performance results to the first commit message.
- V2:
- Add missing defines if CONFIG_NET_RX_BUSY_POLL is not defined
- Changes signature of function io_napi_add_list to static inline if CONFIG_NET_RX_BUSY_POLL is not defined
- define some functions as static
Stefan Roesch (8):
net: split off __napi_busy_poll from napi_busy_poll
net: introduce napi_busy_loop_rcu()
net: split off _napi_busy_loop()
io-uring: move io_wait_queue definition to header file
io-uring: add napi busy poll support
io-uring: add sqpoll support for napi busy poll
io_uring: add register/unregister napi function
io_uring: add prefer busy poll to register and unregister napi api
include/linux/io_uring_types.h | 11 ++ include/net/busy_poll.h | 4 + include/uapi/linux/io_uring.h | 12 ++ io_uring/Makefile | 1 + io_uring/io_uring.c | 41 ++-- io_uring/io_uring.h | 26 +++ io_uring/napi.c | 331 +++++++++++++++++++++++++++++++++ io_uring/napi.h | 104 +++++++++++ io_uring/poll.c | 2 + io_uring/sqpoll.c | 4 + net/core/dev.c | 134 ++++++++----- 11 files changed, 602 insertions(+), 68 deletions(-) create mode 100644 io_uring/napi.c create mode 100644 io_uring/napi.h
base-commit: d2b7fa6174bc4260e496cbf84375c73636914641
Signature · 1 line
2.39.1
PATCH v14 1/8 net: split off __napi_busy_poll from napi_busy_poll
This splits off the key part of the napi_busy_poll function into its own function __napi_busy_poll. This is done in preparation for an additional napi_busy_poll() function, that doesn't take the rcu_read_lock(). The new function is introduced in the next patch.
--- net/core/dev.c | 99 ++++++++++++++++++++++++++++---------------------- 1 file changed, 56 insertions(+), 43 deletions(-)
net/core/dev.c +56 -43
@@ -6166,66 +6166,79 @@ static void busy_poll_stop(struct napi_struct *napi, void *have_poll_lock, boollocal_bh_enable (); } +struct napi_busy_poll_ctx { +struct napi_struct *napi; +int (*napi_poll)(struct napi_struct *napi,int budget); +void *have_poll_lock; +}; + +static inline void __napi_busy_poll (struct napi_busy_poll_ctx *ctx, +bool prefer_busy_poll,u16 budget) +{ +struct napi_struct *napi = ctx->napi; +int work =0 ; + +WARN_ON_ONCE (!rcu_read_lock_held ()); + +local_bh_disable (); +if (!ctx->napi_poll) { +unsigned long val =READ_ONCE (napi->state); + +/* If multiple threads are competing for this napi, +* we avoid dirtying napi->state as much as we can. +*/ +if (val & (NAPIF_STATE_DISABLE |NAPIF_STATE_SCHED | +NAPIF_STATE_IN_BUSY_POLL )) { +if (prefer_busy_poll) +set_bit (NAPI_STATE_PREFER_BUSY_POLL , &napi->state); + goto count; + } +if (cmpxchg (&napi->state, val, + val |NAPIF_STATE_IN_BUSY_POLL | +NAPIF_STATE_SCHED ) != val) { +if (prefer_busy_poll) +set_bit (NAPI_STATE_PREFER_BUSY_POLL , &napi->state); + goto count; + } + ctx->have_poll_lock =netpoll_poll_lock (napi); + ctx->napi_poll = napi->poll; + } + work = ctx->napi_poll (napi, budget); +trace_napi_poll (napi, work, budget); +gro_normal_list (napi); + +count: +if (work >0 ) +__NET_ADD_STATS (dev_net (napi->dev), +LINUX_MIB_BUSYPOLLRXPACKETS , work); +local_bh_enable (); +}void napi_busy_loop (unsigned int napi_id,bool (*loop_end)(void *,unsigned long ),void *loop_end_arg,bool prefer_busy_poll,u16 budget) {unsigned long start_time = loop_end ?busy_loop_current_time () :0 ; -int (*napi_poll)(struct napi_struct *napi,int budget); -void *have_poll_lock =NULL ; -struct napi_struct *napi; +struct napi_busy_poll_ctx ctx = {}; restart: - napi_poll =NULL ; + ctx.napi_poll =NULL ;rcu_read_lock (); - napi =napi_by_id (napi_id); -if (!napi) + ctx.napi =napi_by_id (napi_id); +if (!ctx.napi) goto out;preempt_disable ();for (;;) { -int work =0 ; - -local_bh_disable (); -if (!napi_poll) { -unsigned long val =READ_ONCE (napi->state); - -/* If multiple threads are competing for this napi, -* we avoid dirtying napi->state as much as we can. -*/ -if (val & (NAPIF_STATE_DISABLE |NAPIF_STATE_SCHED | -NAPIF_STATE_IN_BUSY_POLL )) { -if (prefer_busy_poll) -set_bit (NAPI_STATE_PREFER_BUSY_POLL , &napi->state); - goto count; - } -if (cmpxchg (&napi->state, val, - val |NAPIF_STATE_IN_BUSY_POLL | -NAPIF_STATE_SCHED ) != val) { -if (prefer_busy_poll) -set_bit (NAPI_STATE_PREFER_BUSY_POLL , &napi->state); - goto count; - } - have_poll_lock =netpoll_poll_lock (napi); - napi_poll = napi->poll; - } - work =napi_poll (napi, budget); -trace_napi_poll (napi, work, budget); -gro_normal_list (napi); -count: -if (work >0 ) -__NET_ADD_STATS (dev_net (napi->dev), -LINUX_MIB_BUSYPOLLRXPACKETS , work); -local_bh_enable (); +__napi_busy_poll (&ctx, prefer_busy_poll, budget);if (!loop_end ||loop_end (loop_end_arg, start_time))break ;if (unlikely (need_resched ())) { -if (napi_poll) -busy_poll_stop (napi, have_poll_lock, prefer_busy_poll, budget); +if (ctx.napi_poll) +busy_poll_stop (ctx.napi, ctx.have_poll_lock, prefer_busy_poll, budget);preempt_enable ();rcu_read_unlock ();cond_resched ();
@@ -6235,8 +6248,8 @@ void napi_busy_loop(unsigned int napi_id, }cpu_relax (); } -if (napi_poll) -busy_poll_stop (napi, have_poll_lock, prefer_busy_poll, budget); +if (ctx.napi_poll) +busy_poll_stop (ctx.napi, ctx.have_poll_lock, prefer_busy_poll, budget);preempt_enable (); out:rcu_read_unlock ();
Signature · 1 line
2.39.1
PATCH v14 2/8 net: introduce napi_busy_loop_rcu()
In reply to Stefan RoeschThis introduces the napi_busy_loop_rcu() function. If the caller of napi_busy_loop() function is also taking the rcu read lock, it is possible that napi_busy_loop() is releasing the read lock if it invokes schedule. However the caller is expecting that the rcu read lock is not released until the function completes. This new function avoids that problem. It expects that the caller MUST hold the rcu_read_lock while calling this function.
--- include/net/busy_poll.h | 4 ++++ net/core/dev.c | 31 +++++++++++++++++++++++++++++++ 2 files changed, 35 insertions(+)
include/net/busy_poll.h +4 -0
@@ -47,6 +47,10 @@ void napi_busy_loop(unsigned int napi_id,bool (*loop_end)(void *,unsigned long ), void *loop_end_arg, bool prefer_busy_poll, u16 budget); +void napi_busy_loop_rcu (unsigned int napi_id, +bool (*loop_end)(void *,unsigned long ), +void *loop_end_arg,bool prefer_busy_poll,u16 budget); +#else /* CONFIG_NET_RX_BUSY_POLL */ static inline unsigned long net_busy_loop_on (void ) {
net/core/dev.c +31 -0
@@ -6213,6 +6213,37 @@ static inline void __napi_busy_poll(struct napi_busy_poll_ctx *ctx, LINUX_MIB_BUSYPOLLRXPACKETS, work);local_bh_enable (); } + +/* +* Warning: can exit without calling need_resched(). +*/ +void napi_busy_loop_rcu (unsigned int napi_id, +bool (*loop_end)(void *,unsigned long ), +void *loop_end_arg,bool prefer_busy_poll,u16 budget) +{ +unsigned long start_time = loop_end ?busy_loop_current_time () :0 ; +struct napi_busy_poll_ctx ctx = {}; + + ctx.napi =napi_by_id (napi_id); +if (!ctx.napi) +return ; + +preempt_disable (); +for (;;) { +__napi_busy_poll (&ctx, prefer_busy_poll, budget); + +if (!loop_end ||loop_end (loop_end_arg, start_time)) +break ; +if (unlikely (need_resched ())) +break ; + +cpu_relax (); + } +if (ctx.napi_poll) +busy_poll_stop (ctx.napi, ctx.have_poll_lock, prefer_busy_poll, budget); +preempt_enable (); +} +void napi_busy_loop (unsigned int napi_id,bool (*loop_end)(void *,unsigned long ),void *loop_end_arg,bool prefer_busy_poll,u16 budget)
Signature · 1 line
2.39.1
Re: [PATCH v14 2/8] net: introduce napi_busy_loop_rcu()
Quoted 9 lines · Stefan Roesch
This introduces the
napi_busy_loop_rcu()function. If the caller ofnapi_busy_loop()function is also taking the rcu read lock, it is possible thatnapi_busy_loop()is releasing the read lock if it invokes schedule. However the caller is expecting that the rcu read lock is not released until the function completes. This new function avoids that problem. It expects that the caller MUST hold thercu_read_lockwhile calling this function.Signed-off-by Stefan Roesch <[email protected]>
Hi Stefan,
some minor nits from my side, which you may
want to consider if you need to spin a v15 for some reason.
...
net/core/dev.c static inline void __napi_busy_poll(struct napi_busy_poll_ctx *ctx, · line 6219
Quoted 12 lines
net/core/dev.c +4
-0@@ -6213,6 +6213,37 @@ static inline void __napi_busy_poll(struct napi_busy_poll_ctx *ctx, LINUX_MIB_BUSYPOLLRXPACKETS, work);local_bh_enable (); } + +/* +* Warning: can exit without calling need_resched(). +*/
For historical reasons, multi-line comments in Networking code are like this.
/* Something
* more
*/
Though I notice that dev.c doesn't follow this too closely, perhaps for other historical reasons.
Anyway, in this case I'd suggest a single like comment. Unless there is something more to say.
/* Warning: can exit without calling need_resched(). */
net/core/dev.c static inline void __napi_busy_poll(struct napi_busy_poll_ctx *ctx, · line 6222
Quoted 3 lines
net/core/dev.c +3
-0+void napi_busy_loop_rcu (unsigned int napi_id, +bool (*loop_end)(void *,unsigned long ), +void *loop_end_arg,bool prefer_busy_poll,u16 budget)
The indentation of the above two likes should align with the inside of the opening parentheses.
void napi_busy_loop_rcu(unsigned int napi_id,
bool (*loop_end)(void *, unsigned long), void *loop_end_arg, bool prefer_busy_poll, u16 budget)
...
PATCH v14 3/8 net: split off _napi_busy_loop()
In reply to Stefan RoeschThis splits off the function _napi_busy_loop from the commonality of napi_busy_loop() and napi_busy_loop_rcu().
--- net/core/dev.c | 66 ++++++++++++++++++++++++-------------------------- 1 file changed, 31 insertions(+), 35 deletions(-)
net/core/dev.c +31 -35
@@ -6214,39 +6214,10 @@ static inline void __napi_busy_poll(struct napi_busy_poll_ctx *ctx,local_bh_enable (); } -/* -* Warning: can exit without calling need_resched(). -*/ -void napi_busy_loop_rcu (unsigned int napi_id, -bool (*loop_end)(void *,unsigned long ), -void *loop_end_arg,bool prefer_busy_poll,u16 budget) -{ -unsigned long start_time = loop_end ?busy_loop_current_time () :0 ; -struct napi_busy_poll_ctx ctx = {}; - - ctx.napi =napi_by_id (napi_id); -if (!ctx.napi) -return ; - -preempt_disable (); -for (;;) { -__napi_busy_poll (&ctx, prefer_busy_poll, budget); - -if (!loop_end ||loop_end (loop_end_arg, start_time)) -break ; -if (unlikely (need_resched ())) -break ; - -cpu_relax (); - } -if (ctx.napi_poll) -busy_poll_stop (ctx.napi, ctx.have_poll_lock, prefer_busy_poll, budget); -preempt_enable (); -} - -void napi_busy_loop (unsigned int napi_id, +static void _napi_busy_loop (unsigned int napi_id,bool (*loop_end)(void *,unsigned long ), -void *loop_end_arg,bool prefer_busy_poll,u16 budget) +void *loop_end_arg,bool prefer_busy_poll,u16 budget, +bool rcu) {unsigned long start_time = loop_end ?busy_loop_current_time () :0 ;struct napi_busy_poll_ctx ctx = {};
@@ -6254,7 +6225,8 @@ void napi_busy_loop(unsigned int napi_id, restart: ctx.napi_poll =NULL ; -rcu_read_lock (); +if (rcu) +rcu_read_lock (); ctx.napi =napi_by_id (napi_id);if (!ctx.napi)
@@ -6268,8 +6240,12 @@ void napi_busy_loop(unsigned int napi_id,break ;if (unlikely (need_resched ())) { +if (rcu) +break ; +if (ctx.napi_poll) -busy_poll_stop (ctx.napi, ctx.have_poll_lock, prefer_busy_poll, budget); +busy_poll_stop (ctx.napi, ctx.have_poll_lock, + prefer_busy_poll, budget);preempt_enable ();rcu_read_unlock ();cond_resched ();
@@ -6283,7 +6259,27 @@ void napi_busy_loop(unsigned int napi_id,busy_poll_stop (ctx.napi, ctx.have_poll_lock, prefer_busy_poll, budget);preempt_enable (); out: -rcu_read_unlock (); +if (rcu) +rcu_read_unlock (); +} + +/* +* Warning: can exit without calling need_resched(). +*/ +void napi_busy_loop_rcu (unsigned int napi_id, +bool (*loop_end)(void *,unsigned long ), +void *loop_end_arg,bool prefer_busy_poll,u16 budget) +{ +_napi_busy_loop (napi_id, loop_end, loop_end_arg, prefer_busy_poll, + budget, true); +} + +void napi_busy_loop (unsigned int napi_id, +bool (*loop_end)(void *,unsigned long ), +void *loop_end_arg,bool prefer_busy_poll,u16 budget) +{ +_napi_busy_loop (napi_id, loop_end, loop_end_arg, prefer_busy_poll, + budget, false); }EXPORT_SYMBOL (napi_busy_loop);
Signature · 1 line
2.39.1
Jakub Kicinski
maintainerRe: [PATCH v14 3/8] net: split off _napi_busy_loop()
Quoted 1 line · On Mon, 5 Jun 2023 14:20:04 -0700 Stefan Roesch wrote:
+static void _napi_busy_loop(unsigned int
napi_id,
IDK how much of an official kernel coding style this rule is but I think that double underscore is more idiomatic..
Quoted 4 lines
net/core/dev.c +2
-1bool (*loop_end)(void *,unsigned long ), - void *loop_end_arg, bool prefer_busy_poll, u16 budget) + void *loop_end_arg, bool prefer_busy_poll, u16 budget, + bool rcu)
Signature · 1 line
pw-bot: cr
PATCH v14 4/8 io-uring: move io_wait_queue definition to header file
In reply to Stefan RoeschThis moves the definition of the io_wait_queue structure to the header file so it can be also used from other files.
--- io_uring/io_uring.c | 21 --------------------- io_uring/io_uring.h | 22 ++++++++++++++++++++++ 2 files changed, 22 insertions(+), 21 deletions(-)
io_uring/io_uring.c +0 -21
@@ -2516,33 +2516,12 @@ int io_submit_sqes(struct io_ring_ctx *ctx, unsigned int nr)return ret; } -struct io_wait_queue { -struct wait_queue_entry wq; -struct io_ring_ctx *ctx; -unsigned cq_tail; -unsigned nr_timeouts; -ktime_t timeout; -}; -static inline bool io_has_work (struct io_ring_ctx *ctx) {return test_bit (IO_CHECK_CQ_OVERFLOW_BIT , &ctx->check_cq) || !llist_empty (&ctx->work_llist); } -static inline bool io_should_wake (struct io_wait_queue *iowq) -{ -struct io_ring_ctx *ctx = iowq->ctx; -int dist =READ_ONCE (ctx->rings->cq.tail) - (int ) iowq->cq_tail; - -/* -* Wake up if we have enough events, or if a timeout occurred since we -* started waiting. For timeouts, we always want to return to userspace, -* regardless of event count. -*/ -return dist >=0 ||atomic_read (&ctx->cq_timeouts) != iowq->nr_timeouts; -} -static int io_wake_function (struct wait_queue_entry *curr,unsigned int mode,int wake_flags,void *key) {
io_uring/io_uring.h +22 -0
@@ -41,6 +41,28 @@ enum { IOU_STOP_MULTISHOT = -ECANCELED, }; +struct io_wait_queue { +struct wait_queue_entry wq; +struct io_ring_ctx *ctx; +unsigned cq_tail; +unsigned nr_timeouts; +ktime_t timeout; + +}; + +static inline bool io_should_wake (struct io_wait_queue *iowq) +{ +struct io_ring_ctx *ctx = iowq->ctx; +int dist =READ_ONCE (ctx->rings->cq.tail) - (int ) iowq->cq_tail; + +/* +* Wake up if we have enough events, or if a timeout occurred since we +* started waiting. For timeouts, we always want to return to userspace, +* regardless of event count. +*/ +return dist >=0 ||atomic_read (&ctx->cq_timeouts) != iowq->nr_timeouts; +} +struct io_uring_cqe *__io_get_cqe (struct io_ring_ctx *ctx,bool overflow);bool io_req_cqe_overflow (struct io_kiocb *req);int io_run_task_work_sig (struct io_ring_ctx *ctx);
Signature · 1 line
2.39.1
PATCH v14 5/8 io-uring: add napi busy poll support
In reply to Stefan RoeschThis adds the napi busy polling support in io_uring.c. It adds a new napi_list to the io_ring_ctx structure. This list contains the list of napi_id's that are currently enabled for busy polling. The list is synchronized by the new napi_lock spin lock. The current default napi busy polling time is stored in napi_busy_poll_to. If napi busy polling is not enabled, the value is 0.
In addition there is also a hash table. The hash table store the napi id and the pointer to the above list nodes. The hash table is used to speed up the lookup to the list elements. The hash table is synchronized with rcu.
The NAPI_TIMEOUT is stored as a timeout to make sure that the time a napi entry is stored in the napi list is limited.
The busy poll timeout is also stored as part of the io_wait_queue. This is necessary as for sq polling the poll interval needs to be adjusted and the napi callback allows only to pass in one value.
This has been tested with two simple programs from the liburing library
repository: the napi client and the napi server program. The client sends a request, which has a timestamp in its payload and the server replies with the same payload. The client calculates the roundtrip time and stores it to calculate the results.
The client is running on host1 and the server is running on host 2 (in the same rack). The measured times below are roundtrip times. They are average times over 5 runs each. Each run measures 1 million roundtrips.
no rx coal rx coal: frames=88,usecs=33
Default 57us 56us
client_poll=100us 47us 46us
server_poll=100us 51us 46us
client_poll=100us+ 40us 40us
server_poll=100us
client_poll=100us+ 41us 39us
server_poll=100us+
prefer napi busy poll on client
client_poll=100us+ 41us 39us
server_poll=100us+
prefer napi busy poll on server
client_poll=100us+ 41us 39us
server_poll=100us+
prefer napi busy poll on client + server
--- include/linux/io_uring_types.h | 11 ++ io_uring/Makefile | 1 + io_uring/io_uring.c | 8 ++ io_uring/io_uring.h | 4 + io_uring/napi.c | 255 +++++++++++++++++++++++++++++++++ io_uring/napi.h | 89 ++++++++++++ io_uring/poll.c | 2 + 7 files changed, 370 insertions(+) create mode 100644 io_uring/napi.c create mode 100644 io_uring/napi.h
include/linux/io_uring_types.h +11 -0
@@ -2,6 +2,7 @@#define IO_URING_TYPES_H #include <linux/blkdev.h> +#include <linux/hashtable.h> #include <linux/task_work.h> #include <linux/bitmap.h> #include <linux/llist.h>
@@ -277,6 +278,16 @@ struct io_ring_ctx {struct xarray personalities;u32 pers_next; +#ifdef CONFIG_NET_RX_BUSY_POLL +struct list_head napi_list;/* track busy poll napi_id */ +spinlock_t napi_lock;/* napi_list lock */ + +DECLARE_HASHTABLE (napi_ht,4 ); +/* napi busy poll default timeout */ +unsigned int napi_busy_poll_to; +bool napi_prefer_busy_poll; +#endif +struct {/* * We cache a range of free CQEs we can use, once exhausted it
io_uring/Makefile +1 -0
@@ -9,3 +9,4 @@ obj-$(CONFIG_IO_URING) += io_uring.o xattr.o nop.o fs.o splice.o \ sqpoll.o fdinfo.o tctx.o poll.o \ cancel.o kbuf.o rsrc.o rw.o opdef.o notif.o obj-$(CONFIG_IO_WQ) += io-wq.o +obj-$(CONFIG_NET_RX_BUSY_POLL) += napi.o
io_uring/io_uring.c +8 -0
@@ -91,6 +91,7 @@#include "rsrc.h" #include "cancel.h" #include "net.h" +#include "napi.h" #include "notif.h" #include "timeout.h"
@@ -337,6 +338,8 @@ static __cold struct io_ring_ctx *io_ring_ctx_alloc(struct io_uring_params *p)INIT_WQ_LIST (&ctx->locked_free_list);INIT_DELAYED_WORK (&ctx->fallback_work, io_fallback_req_func);INIT_WQ_LIST (&ctx->submit_state.compl_reqs); +io_napi_init (ctx); +return ctx; err:kfree (ctx->dummy_ubuf);
@@ -2619,9 +2622,13 @@ static int io_cqring_wait(struct io_ring_ctx *ctx, int min_events,if (get_timespec64 (&ts, uts))return -EFAULT ; + iowq.timeout =ktime_add_ns (timespec64_to_ktime (ts),ktime_get_ns ()); +io_napi_adjust_timeout (ctx, &iowq, &ts); } +io_napi_busy_loop (ctx, &iowq); +trace_io_uring_cqring_wait (ctx, min_events); do { unsigned long check_cq;
@@ -2856,6 +2863,7 @@ static __cold void io_ring_ctx_free(struct io_ring_ctx *ctx)io_req_caches_free (ctx);if (ctx->hash_map)io_wq_put_hash (ctx->hash_map); +io_napi_free (ctx);kfree (ctx->cancel_table.hbs);kfree (ctx->cancel_table_locked.hbs);kfree (ctx->dummy_ubuf);
io_uring/io_uring.h +4 -0
@@ -48,6 +48,10 @@ struct io_wait_queue {unsigned nr_timeouts;ktime_t timeout; +#ifdef CONFIG_NET_RX_BUSY_POLL +unsigned int napi_busy_poll_to; +bool napi_prefer_busy_poll; +#endif };static inline bool io_should_wake (struct io_wait_queue *iowq)
io_uring/napi.c new file +255 -0
255 lines not on this page · raw message
io_uring/napi.h new file +89 -0
89 lines not on this page · raw message
io_uring/poll.c +2 -0
@@ -15,6 +15,7 @@#include "io_uring.h" #include "refs.h" +#include "napi.h" #include "opdef.h" #include "kbuf.h" #include "poll.h"
@@ -631,6 +632,7 @@ static int __io_arm_poll_handler(struct io_kiocb *req,__io_poll_execute (req, mask);return 0 ; } +io_napi_add (req);if (ipt->owning) {/*
Signature · 1 line
2.39.1
PATCH v14 6/8 io-uring: add sqpoll support for napi busy poll
In reply to Stefan RoeschThis adds the sqpoll support to the io-uring napi.
--- io_uring/napi.c | 24 ++++++++++++++++++++++++ io_uring/napi.h | 6 +++++- io_uring/sqpoll.c | 4 ++++ 3 files changed, 33 insertions(+), 1 deletion(-)
io_uring/napi.c +24 -0
@@ -252,4 +252,28 @@ void __io_napi_busy_loop(struct io_ring_ctx *ctx, struct io_wait_queue *iowq) io_napi_blocking_busy_loop(ctx, iowq); } +/* +* io_napi_sqpoll_busy_poll() - busy poll loop for sqpoll +* @ctx: pointer to io-uring context structure +* +* Splice of the napi list and execute the napi busy poll loop. +*/ +int io_napi_sqpoll_busy_poll (struct io_ring_ctx *ctx) +{ +LIST_HEAD (napi_list); +bool is_stale = false; + +if (!READ_ONCE (ctx->napi_busy_poll_to)) +return 0 ; +if (list_empty_careful (&ctx->napi_list)) +return 0 ; + +rcu_read_lock (); + is_stale =__io_napi_do_busy_loop (ctx,NULL ); +rcu_read_unlock (); + +io_napi_remove_stale (ctx, is_stale); +return 1 ; +} +#endif
io_uring/napi.h +5 -1
@@ -17,6 +17,7 @@ void __io_napi_add(struct io_ring_ctx *ctx, struct socket *sock);void __io_napi_adjust_timeout (struct io_ring_ctx *ctx,struct io_wait_queue *iowq,struct timespec64 *ts);void __io_napi_busy_loop (struct io_ring_ctx *ctx,struct io_wait_queue *iowq); +int io_napi_sqpoll_busy_poll (struct io_ring_ctx *ctx);static inline bool io_napi (struct io_ring_ctx *ctx) {
@@ -83,7 +84,10 @@ static inline void io_napi_busy_loop(struct io_ring_ctx *ctx, struct io_wait_queue *iowq) { } - +static inline int io_napi_sqpoll_busy_poll (struct io_ring_ctx *ctx) +{ +return 0 ; +}#endif /* CONFIG_NET_RX_BUSY_POLL */ #endif
io_uring/sqpoll.c +4 -0
@@ -15,6 +15,7 @@#include <uapi/linux/io_uring.h> #include "io_uring.h" +#include "napi.h" #include "sqpoll.h" #define IORING_SQPOLL_CAP_ENTRIES_VALUE 8
@@ -193,6 +194,9 @@ static int __io_sq_thread(struct io_ring_ctx *ctx, bool cap_entries) ret =io_submit_sqes (ctx, to_submit);mutex_unlock (&ctx->uring_lock); +if (io_napi (ctx)) + ret +=io_napi_sqpoll_busy_poll (ctx); +if (to_submit &&wq_has_sleeper (&ctx->sqo_sq_wait))wake_up (&ctx->sqo_sq_wait);if (creds)
Signature · 1 line
2.39.1
PATCH v14 7/8 io_uring: add register/unregister napi function
In reply to Stefan RoeschThis adds an api to register and unregister the napi for io-uring. If the arg value is specified when unregistering, the current napi setting for the busy poll timeout is copied into the user structure. If this is not required, NULL can be passed as the arg value.
--- include/uapi/linux/io_uring.h | 11 ++++++++ io_uring/io_uring.c | 12 +++++++++ io_uring/napi.c | 48 +++++++++++++++++++++++++++++++++++ io_uring/napi.h | 11 ++++++++ 4 files changed, 82 insertions(+)
include/uapi/linux/io_uring.h +11 -0
@@ -523,6 +523,10 @@ enum {/* register a range of fixed file slots for automatic slot allocation */ IORING_REGISTER_FILE_ALLOC_RANGE =25 , +/* set/clear busy poll settings */ +IORING_REGISTER_NAPI =26 , +IORING_UNREGISTER_NAPI =27 , +/* this goes last */ IORING_REGISTER_LAST,
@@ -649,6 +653,13 @@ struct io_uring_buf_reg {__u64 resv[3 ]; }; +/* argument for IORING_(UN)REGISTER_NAPI */ +struct io_uring_napi { +__u32 busy_poll_to; +__u32 pad; +__u64 resv; +}; +/* * io_uring_restriction->opcode values */
io_uring/io_uring.c +12 -0
@@ -4405,6 +4405,18 @@ static int __io_uring_register(struct io_ring_ctx *ctx, unsigned opcode,break ; ret =io_register_file_alloc_range (ctx, arg);break ; +case IORING_REGISTER_NAPI : + ret = -EINVAL ; +if (!arg || nr_args !=1 ) +break ; + ret =io_register_napi (ctx, arg); +break ; +case IORING_UNREGISTER_NAPI : + ret = -EINVAL ; +if (nr_args !=1 ) +break ; + ret =io_unregister_napi (ctx, arg); +break ;default : ret = -EINVAL ;break ;
io_uring/napi.c +48 -0
54 lines not on this page · raw message
io_uring/napi.h +11 -0
@@ -12,6 +12,9 @@void io_napi_init (struct io_ring_ctx *ctx);void io_napi_free (struct io_ring_ctx *ctx); +int io_register_napi (struct io_ring_ctx *ctx,void __user *arg); +int io_unregister_napi (struct io_ring_ctx *ctx,void __user *arg); +void __io_napi_add (struct io_ring_ctx *ctx,struct socket *sock); void __io_napi_adjust_timeout(struct io_ring_ctx *ctx,
@@ -68,6 +71,14 @@ static inline void io_napi_init(struct io_ring_ctx *ctx)static inline void io_napi_free (struct io_ring_ctx *ctx) { } +static inline int io_register_napi (struct io_ring_ctx *ctx,void __user *arg) +{ +return -EOPNOTSUPP ; +} +static inline int io_unregister_napi (struct io_ring_ctx *ctx,void __user *arg) +{ +return -EOPNOTSUPP ; +}static inline bool io_napi (struct io_ring_ctx *ctx) {return false;
Signature · 1 line
2.39.1
PATCH v14 8/8 io_uring: add prefer busy poll to register and unregister napi api
In reply to Stefan RoeschThis adds the napi prefer busy poll setting to the register and unregister napi api. When napi is unregistered and arg is specified, both napi settings: busy poll timeout and the prefer busy poll setting are copied into the user structure.
--- include/uapi/linux/io_uring.h | 3 ++- io_uring/napi.c | 10 +++++++--- 2 files changed, 9 insertions(+), 4 deletions(-)
include/uapi/linux/io_uring.h +2 -1
@@ -656,7 +656,8 @@ struct io_uring_buf_reg {/* argument for IORING_(UN)REGISTER_NAPI */ struct io_uring_napi {__u32 busy_poll_to; -__u32 pad; +__u8 prefer_busy_poll; +__u8 pad[3 ];__u64 resv; };
io_uring/napi.c +7 -3
@@ -217,16 +217,18 @@ void io_napi_free(struct io_ring_ctx *ctx)int io_register_napi (struct io_ring_ctx *ctx,void __user *arg) {const struct io_uring_napi curr = { - .busy_poll_to = ctx->napi_busy_poll_to, + .busy_poll_to = ctx->napi_busy_poll_to, + .prefer_busy_poll = ctx->napi_prefer_busy_poll };struct io_uring_napi napi;if (copy_from_user (&napi, arg,sizeof (napi)))return -EFAULT ; -if (napi.pad || napi.resv) +if (napi.pad[0 ] || napi.pad[1 ] || napi.pad[2 ] || napi.resv)return -EINVAL ;WRITE_ONCE (ctx->napi_busy_poll_to, napi.busy_poll_to); +WRITE_ONCE (ctx->napi_prefer_busy_poll, !!napi.prefer_busy_poll);if (copy_to_user (arg, &curr,sizeof (curr)))return -EFAULT ;
@@ -245,13 +247,15 @@ int io_register_napi(struct io_ring_ctx *ctx, void __user *arg)int io_unregister_napi (struct io_ring_ctx *ctx,void __user *arg) {const struct io_uring_napi curr = { - .busy_poll_to = ctx->napi_busy_poll_to, + .busy_poll_to = ctx->napi_busy_poll_to, + .prefer_busy_poll = ctx->napi_prefer_busy_poll };if (arg &©_to_user (arg, &curr,sizeof (curr)))return -EFAULT ;WRITE_ONCE (ctx->napi_busy_poll_to,0 ); +WRITE_ONCE (ctx->napi_prefer_busy_poll, false);return 0 ; }
Signature · 1 line
2.39.1