Skip to contentSkip to conversation

Minor SQPOLL thread fix and improvement

PATCH Applied Olivier Langlois 3 participants 8 messages Jun 23, 2021

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

v2 cover Minor SQPOLL thread fix and improvement

I have been investigated a deadlock situation in my io_uring usage where the SQPOLL thread was going to sleep and my user threads were waiting inside io_uring_enter() for completions.

https://github.com/axboe/liburing/issues/367

This patch serie is the result of my investigation.

Olivier Langlois (2):
io_uring: Fix race condition when sqp thread goes to sleep
io_uring: Create define to modify a SQPOLL parameter

 fs/io_uring.c | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)
Signature · 1 line
2.32.0
#1 lore raw

PATCH v2 1/2 io_uring: Fix race condition when sqp thread goes to sleep

If an asynchronous completion happens before the task is preparing itself to wait and set its state to TASK_INTERRUPTIBLE, the completion will not wake up the sqp thread.

---
 fs/io_uring.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
fs/io_uring.c +1 -1
index fc8637f591a6..7c545fa66f31 100644
@@ -6902,7 +6902,7 @@ static int io_sq_thread(void *data)
 		}
 
 		prepare_to_wait(&sqd->wait, &wait, TASK_INTERRUPTIBLE);
-		if (!io_sqd_events_pending(sqd)) {
+		if (!io_sqd_events_pending(sqd) && !io_run_task_work()) {
 			needs_sched = true;
 			list_for_each_entry(ctx, &sqd->ctx_list, sqd_list) {
 				io_ring_set_wakeup_flag(ctx);
Signature · 1 line
2.32.0
Reviewed-by on v2 1/2
#2 lore raw

Re: [PATCH v2 1/2] io_uring: Fix race condition when sqp thread goes to sleep

Quoted 3 lines · Olivier Langlois

If an asynchronous completion happens before the task is preparing itself to wait and set its state to TASK_INTERRUPTIBLE, the completion will not wake up the sqp thread.

Looks good, the bug should be pretty old.

Quoted 19 lines
---
 fs/io_uring.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
fs/io_uring.c +1 -1
index fc8637f591a6..7c545fa66f31 100644
@@ -6902,7 +6902,7 @@ static int io_sq_thread(void *data)
 		}
 
 		prepare_to_wait(&sqd->wait, &wait, TASK_INTERRUPTIBLE);
-		if (!io_sqd_events_pending(sqd)) {
+		if (!io_sqd_events_pending(sqd) && !io_run_task_work()) {
 			needs_sched = true;
 			list_for_each_entry(ctx, &sqd->ctx_list, sqd_list) {
 				io_ring_set_wakeup_flag(ctx);
Signature · 1 line
Pavel Begunkov
#3 lore raw

PATCH v2 2/2 io_uring: Create define to modify a SQPOLL parameter

In reply to Olivier Langlois

The magic number used to cap the number of entries extracted from an io_uring instance SQ before moving to the other instances is an interesting parameter to experiment with.

A define has been created to make it easy to change its value from a single location.

---
 fs/io_uring.c | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
fs/io_uring.c +3 -2
index 7c545fa66f31..e7997f9bf879 100644
@@ -89,6 +89,7 @@
 
 #define IORING_MAX_ENTRIES	32768
 #define IORING_MAX_CQ_ENTRIES	(2 * IORING_MAX_ENTRIES)
+#define IORING_SQPOLL_CAP_ENTRIES_VALUE 8
 
 /*
  * Shift of 9 is 512 entries, or exactly one page on 64-bit archs
@@ -6797,8 +6798,8 @@ static int __io_sq_thread(struct io_ring_ctx *ctx, bool cap_entries)
 
 	to_submit = io_sqring_entries(ctx);
 	/* if we're handling multiple rings, cap submit size for fairness */
-	if (cap_entries && to_submit > 8)
-		to_submit = 8;
+	if (cap_entries && to_submit > IORING_SQPOLL_CAP_ENTRIES_VALUE)
+		to_submit = IORING_SQPOLL_CAP_ENTRIES_VALUE;
 
 	if (!list_empty(&ctx->iopoll_list) || to_submit) {
 		unsigned nr_events = 0;
Signature · 1 line
2.32.0
Reviewed-by on v2 2/2
#4 lore raw

Re: [PATCH v2 2/2] io_uring: Create define to modify a SQPOLL parameter

Quoted 6 lines · Olivier Langlois

The magic number used to cap the number of entries extracted from an io_uring instance SQ before moving to the other instances is an interesting parameter to experiment with.

A define has been created to make it easy to change its value from a single location.

It's better to send fixes separately from other improvements, because the process a bit different for them, go into different branches and so on.

Jens, any chance you can pick as is (at least 1/2)?

Quoted 29 lines
---
 fs/io_uring.c | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
fs/io_uring.c +3 -2
index 7c545fa66f31..e7997f9bf879 100644
@@ -89,6 +89,7 @@
 
 #define IORING_MAX_ENTRIES	32768
 #define IORING_MAX_CQ_ENTRIES	(2 * IORING_MAX_ENTRIES)
+#define IORING_SQPOLL_CAP_ENTRIES_VALUE 8
 
 /*
  * Shift of 9 is 512 entries, or exactly one page on 64-bit archs
@@ -6797,8 +6798,8 @@ static int __io_sq_thread(struct io_ring_ctx *ctx, bool cap_entries)
 
 	to_submit = io_sqring_entries(ctx);
 	/* if we're handling multiple rings, cap submit size for fairness */
-	if (cap_entries && to_submit > 8)
-		to_submit = 8;
+	if (cap_entries && to_submit > IORING_SQPOLL_CAP_ENTRIES_VALUE)
+		to_submit = IORING_SQPOLL_CAP_ENTRIES_VALUE;
 
 	if (!list_empty(&ctx->iopoll_list) || to_submit) {
 		unsigned nr_events = 0;
Signature · 1 line
Pavel Begunkov
maintainer
#5 lore raw

Re: [PATCH v2 2/2] io_uring: Create define to modify a SQPOLL parameter

Quoted 11 lines · Pavel Begunkov
Quoted 6 lines · Olivier Langlois

The magic number used to cap the number of entries extracted from an io_uring instance SQ before moving to the other instances is an interesting parameter to experiment with.

A define has been created to make it easy to change its value from a single location.

It's better to send fixes separately from other improvements, because the process a bit different for them, go into different branches and so on.

It's not a huge problem even if they go to different branches, for these I'd be more comfortable doing 5.14 anyway and that makes it even less of a concern.

Signature · 1 line
Jens Axboe
#6 lore raw

Re: [PATCH v2 2/2] io_uring: Create define to modify a SQPOLL parameter

Quoted 9 lines · Jens Axboe
Quoted 8 lines · Pavel Begunkov
Quoted 6 lines · Olivier Langlois

The magic number used to cap the number of entries extracted from an io_uring instance SQ before moving to the other instances is an interesting parameter to experiment with.

A define has been created to make it easy to change its value from a single location.

Quoted 7 lines
Quoted 3 lines

It's better to send fixes separately from other improvements, because the process a bit different for them, go into different branches and so on.

It's not a huge problem even if they go to different branches, for these I'd be more comfortable doing 5.14 anyway and that makes it even less of a concern.

Ok, good to know. I was finding splitting more convenient as a default option, easier with b4, more confidence that they apply to the right branch and so on

Signature · 1 line
Pavel Begunkov