From fad5b0c0b28e088965d777790a2a21db8e627fcd Mon Sep 17 00:00:00 2001 From: Wojciech Lukowicz Date: Tue, 2 Jan 2024 18:06:25 +0000 Subject: [PATCH 1/4] man/io_uring_queue_init.3: fix typo Signed-off-by: Wojciech Lukowicz --- man/io_uring_queue_init.3 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/man/io_uring_queue_init.3 b/man/io_uring_queue_init.3 index 92c195100..53b2e149b 100644 --- a/man/io_uring_queue_init.3 +++ b/man/io_uring_queue_init.3 @@ -40,7 +40,7 @@ By default, the CQ ring will have twice the number of entries as specified by for the SQ ring. This is adequate for regular file or storage workloads, but may be too small for networked workloads. The SQ ring entries do not impose a limit on the number of in-flight requests that the ring can support, it merely -limits the number that can be submitted to the kernel in one go (batch). if the +limits the number that can be submitted to the kernel in one go (batch). If the CQ ring overflows, e.g. more entries are generated than fits in the ring before the application can reap them, then if the kernel supports .B IORING_FEAT_NODROP From fd57f41f849019fffdfcefeaa74a74e092591988 Mon Sep 17 00:00:00 2001 From: Wojciech Lukowicz Date: Tue, 2 Jan 2024 18:10:02 +0000 Subject: [PATCH 2/4] man/io_uring_enter.2: tidy up EBADR description It's next enter on the same ring that won't have this error, not setup of a new one. Signed-off-by: Wojciech Lukowicz --- man/io_uring_enter.2 | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/man/io_uring_enter.2 b/man/io_uring_enter.2 index 831480094..7d04d4702 100644 --- a/man/io_uring_enter.2 +++ b/man/io_uring_enter.2 @@ -1533,9 +1533,9 @@ At least one CQE was dropped even with the .B IORING_FEAT_NODROP feature, and there are no otherwise available CQEs. This clears the error state and so with no other changes the next call to -.BR io_uring_setup (2) +.BR io_uring_enter (2) will not have this error. This error should be extremely rare and indicates the -machine is running critically low on memory and. It may be reasonable for the +machine is running critically low on memory. It may be reasonable for the application to terminate running unless it is able to safely handle any CQE being lost. .TP From 18c06aea9844de7d1bb0f8aaa112b73d8e97c7bf Mon Sep 17 00:00:00 2001 From: Wojciech Lukowicz Date: Tue, 2 Jan 2024 18:19:44 +0000 Subject: [PATCH 3/4] man/io_uring_setup.2: tidy up IORING_SETUP_CLAMP description cq_entries clamping happens when IORING_SETUP_CQSIZE is set, IORING_SETUP_SQPOLL does not matter here. Additionally improved formatting. Signed-off-by: Wojciech Lukowicz --- man/io_uring_setup.2 | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/man/io_uring_setup.2 b/man/io_uring_setup.2 index d6e0cb4c3..53ea64915 100644 --- a/man/io_uring_setup.2 +++ b/man/io_uring_setup.2 @@ -180,19 +180,19 @@ and may be rounded up to the next power-of-two. If this flag is specified, and if .IR entries exceeds -.B IORING_MAX_ENTRIES , +.BR IORING_MAX_ENTRIES , then .IR entries will be clamped at -.B IORING_MAX_ENTRIES . +.BR IORING_MAX_ENTRIES . If the flag -.BR IORING_SETUP_SQPOLL +.B IORING_SETUP_CQSIZE is set, and if the value of .IR "struct io_uring_params.cq_entries" exceeds -.B IORING_MAX_CQ_ENTRIES , +.BR IORING_MAX_CQ_ENTRIES , then it will be clamped at -.B IORING_MAX_CQ_ENTRIES . +.BR IORING_MAX_CQ_ENTRIES . .TP .B IORING_SETUP_ATTACH_WQ This flag should be set in conjunction with From b1250d08dbe238830b49ea04ae6b4a12e69041ac Mon Sep 17 00:00:00 2001 From: Wojciech Lukowicz Date: Tue, 2 Jan 2024 18:24:48 +0000 Subject: [PATCH 4/4] man/io_uring_prep_futex_waitv.3: fix signatures That's a man page for the waitv call, so fixed the signature accordingly. There's no io_uring_prep_futex, it should reference io_uring_prep_futex_wait instead. Additionally improved formatting. Signed-off-by: Wojciech Lukowicz --- man/io_uring_prep_futex_waitv.3 | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/man/io_uring_prep_futex_waitv.3 b/man/io_uring_prep_futex_waitv.3 index 85c3b7f6d..b30c06b16 100644 --- a/man/io_uring_prep_futex_waitv.3 +++ b/man/io_uring_prep_futex_waitv.3 @@ -11,10 +11,10 @@ io_uring_prep_futex_waitv \- prepare a futex waitv request .B #include .B #include .PP -.BI "void io_uring_prep_futex_wait(struct io_uring_sqe *" sqe "," -.BI " struct futex_waitv *" futexv "," -.BI " uint32_t " nr_futex "," -.BI " unsigned int " flags ");" +.BI "void io_uring_prep_futex_waitv(struct io_uring_sqe *" sqe "," +.BI " struct futex_waitv *" futexv "," +.BI " uint32_t " nr_futex "," +.BI " unsigned int " flags ");" .fi .SH DESCRIPTION .PP @@ -32,9 +32,9 @@ is the number of futexes in that array. must be set to the io_uring specific futex flags. Unlike -.BR io_uring_prep_futex (3) , +.BR io_uring_prep_futex_wait (3), the desired bitset mask and values are passed in -.I futexv . +.IR futexv . .I flags are currently unused and hence