read-multishot.dhover×239all
#!/usr/bin/env dub
/+ dub.sdl:
    name "io_uring_read_multishot"
    dependency "during" version="~>0.5.0"
    platforms "linux"
    targetPath "build"
+/
/**
 * `io_uring` — multishot read into ring-provided buffers
 * (`IORING_OP_READ_MULTISHOT`, Linux 6.7).
 *
 * A normal `READ` SQE produces one read and one CQE. `READ_MULTISHOT` stays
 * armed against a *pollable* fd (a pipe here): each time data arrives the kernel
 * pops a buffer from a registered buffer group, reads one chunk into it, and
 * posts a CQE — *without* re-submitting an SQE. While the request remains armed
 * each CQE carries `CQEFlags.MORE` (more completions to come) and
 * `CQEFlags.BUFFER` (a kernel-chosen buffer id is packed into the upper 16 bits
 * of `cqe.flags`). The request terminates — final CQE without `MORE` — on EOF,
 * on error, or when the buffer group runs dry (`-ENOBUFS`).
 *
 * This program:
 *   1. registers a buffer ring (`registerBufRing`, the 5.19 fast path) for group
 *      `BGID` and publishes a handful of equal-sized buffers,
 *   2. arms a single `READ_MULTISHOT` on the read end of a pipe with
 *      buffer-select (`prepReadMultishot` sets `IOSQE_BUFFER_SELECT` + `buf_group`),
 *   3. writes two separate chunks into the write end,
 *   4. waits for the two resulting CQEs and asserts each one set `MORE|BUFFER`
 *      and landed its chunk in exactly the buffer id the kernel reported.
 *
 * The "one SQE, many CQEs" shape is the whole point: the cost of arming a read
 * is paid once, and steady-state reads avoid the submit half of the syscall.
 *
 * Companion to the io_uring chronology:
 * see docs/research/async-io/io-uring/timeline.md
 *   § "6.7 — Futex, waitid, read-multishot (January 2024)".
 *
 * Run with: `dub run --single read-multishot.d`
 *
 * Portability: prints `SKIP:` and exits 0 when io_uring is unavailable, when the
 * op is unknown to `probe()`, or when an op/register call reports
 * -EINVAL/-EOPNOTSUPP/-ENOSYS (kernel predates 6.7). Exits nonzero only on a
 * genuinely unexpected syscall failure.
 */
module 
(module) io_uring_read_multishot

io_uring — multishot read into ring-provided buffers (IORING_OP_READ_MULTISHOT, Linux 6.7).

A normal READ SQE produces one read and one CQE. READ_MULTISHOT stays armed against a pollable fd (a pipe here): each time data arrives the kernel pops a buffer from a registered buffer group, reads one chunk into it, and posts a CQE — without re-submitting an SQE. While the request remains armed each CQE carries CQEFlags.MORE (more completions to come) and CQEFlags.BUFFER (a kernel-chosen buffer id is packed into the upper 16 bits of cqe.flags). The request terminates — final CQE without MORE — on EOF, on error, or when the buffer group runs dry (-ENOBUFS).

This program:

  1. registers a buffer ring (registerBufRing, the 5.19 fast path) for group BGID and publishes a handful of equal-sized buffers,

  2. arms a single READ_MULTISHOT on the read end of a pipe with buffer-select (prepReadMultishot sets IOSQE_BUFFER_SELECT + buf_group),

  3. writes two separate chunks into the write end,

  4. waits for the two resulting CQEs and asserts each one set MORE|BUFFER and landed its chunk in exactly the buffer id the kernel reported.

The "one SQE, many CQEs" shape is the whole point: the cost of arming a read is paid once, and steady-state reads avoid the submit half of the syscall.

Companion to the io_uring chronology: see docs/research/async-io/io-uring/timeline.md § "6.7 — Futex, waitid, read-multishot (January 2024)".

Run with: dub run --single read-multishot.d

Portability

prints SKIP: and exits 0 when io_uring is unavailable, when the op is unknown to probe(), or when an op/register call reports -EINVAL/-EOPNOTSUPP/-ENOSYS (kernel predates 6.7). Exits nonzero only on a genuinely unexpected syscall failure.

io_uring_read_multishot
;
import
(module) during

Simple idiomatic dlang wrapper around linux io_uring (see: https://kernel.dk/io_uring.pdf) asynchronous API.

during
;
import
(package) core
core
.
(package) core.stdc
stdc
.
(module) core.stdc.errno

D header file for C99.

pubs.opengroup.org/onlinepubs/009695399/basedefs/errno.h.html, errno.h

Source

core/stdc/errno.d

@copyrightCopyright Sean Kelly 2005 - 2009.@licenseDistributed under the Boost Software License 1.0. (See accompanying file LICENSE)@authorsSean Kelly, Alex Rønne Petersen@standardsISO/IEC 9899:1999 (E)
errno
:
(alias constant) io_uring_read_multishot.EINVAL = int core.stdc.errno.EINVAL = 22
EINVAL
,
(alias constant) io_uring_read_multishot.ENOSYS = int core.stdc.errno.ENOSYS = 38
ENOSYS
,
(alias constant) io_uring_read_multishot.EOPNOTSUPP = int core.stdc.errno.EOPNOTSUPP = 95
EOPNOTSUPP
;
import
(package) core
core
.
(package) core.stdc
stdc
.
(module) core.stdc.stdlib

D header file for C99.

pubs.opengroup.org/onlinepubs/009695399/basedefs/stdlib.h.html, stdlib.h

Source

core/stdc/stdlib.d

@copyrightCopyright Sean Kelly 2005 - 2014.@licenseDistributed under the Boost Software License 1.0. (See accompanying file LICENSE)@authorsSean Kelly@standardsISO/IEC 9899:1999 (E)
stdlib
:
(alias) io_uring_read_multishot.free = void core.stdc.stdlib.free(void* ptr) nothrow @nogc
free
;
import
(package) core
core
.
(package) core.sys
sys
.
(package) core.sys.posix
posix
.
(module) core.sys.posix.stdlib

D header file for POSIX.

@copyrightCopyright Sean Kelly 2005 - 2009.@licenseBoost License 1.0.@authorsSean Kelly@standardsThe Open Group Base Specifications Issue 6, IEEE Std 1003.1, 2004 Edition
stdlib
:
(alias) io_uring_read_multishot.posix_memalign = int core.sys.posix.stdlib.posix_memalign(scope void**, ulong, ulong) pure nothrow @nogc
posix_memalign
;
import
(package) core
core
.
(package) core.sys
sys
.
(package) core.sys.posix
posix
.
(module) core.sys.posix.unistd

D header file for POSIX.

@copyrightCopyright Sean Kelly 2005 - 2009.@licenseBoost License 1.0.@authorsSean Kelly@standardsThe Open Group Base Specifications Issue 8, IEEE Std 1003.1, 2024 Edition
unistd
:
(alias) io_uring_read_multishot.close = int core.sys.posix.unistd.close(int) nothrow @nogc @trusted
close
,
(alias) io_uring_read_multishot.pipe = int core.sys.posix.unistd.pipe(ref int[2]) nothrow @nogc @trusted
pipe
,
(alias) io_uring_read_multishot.write = long core.sys.posix.unistd.write(int, scope const(void*), ulong) nothrow @nogc
write
;
import
(package) std
std
.
(module) std.stdio
Category Symbols
File handles _popen File isFileHandle openNetwork stderr stdin stdout
Reading chunks lines readf readfln readln
Writing toFile write writef writefln writeln
Misc KeepTerminator LockType StdioException

Standard I/O functions that extend core.stdc.stdio. core.stdc.stdio is publically imported when importing std.stdio.

There are three layers of I/O:

  1. The lowest layer is the operating system layer. The two main schemes are Windows and Posix.

  2. C's stdio.h which unifies the two operating system schemes.

  3. std.stdio, this module, unifies the various stdio.h implementations into a high level package for D programs.

Source

std/stdio.d

@copyrightCopyright The D Language Foundation 2007-.@licenseBoost License 1.0.@authorsWalter Bright, Andrei Alexandrescu, Alex Rønne Petersen
stdio
: stderr,
(alias template) io_uring_read_multishot.writefln = std.stdio.writefln(alias fmt, A...)(A args) if (isSomeString!(typeof(fmt)))

Equivalent to writef(fmt, args, '\n').

writefln
;
// Buffer-ring geometry. RING_ENTRIES must be a power of two — the kernel masks // the producer tail with `ring_entries - 1`. enum ushort
(constant) ushort io_uring_read_multishot.BGID = cast(ushort)7u
BGID
= 7;
enum uint
(constant) uint io_uring_read_multishot.RING_ENTRIES = 8u
RING_ENTRIES
= 8;
enum uint
(constant) uint io_uring_read_multishot.BUF_SIZE = 64u
BUF_SIZE
= 64;
enum uint
(constant) uint io_uring_read_multishot.CHUNKS = 2u
CHUNKS
= 2; // number of separate writes -> number of multishot CQEs
int
int D main()
main
()
{
(struct) during.Uring

Main entry point to work with io_uring.

It hides SubmissionQueue and CompletionQueue behind standard range interface. We put in SubmissionEntry entries and take out CompletionEntry entries.

Use predefined prepXX methods to fill required fields of SubmissionEntry before put or during putWith.

Note

prepXX functions doesn't touch previous entry state, just fills in operation properties. This is because for less error prone interface it is cleared automatically when prepared using putWith. So when using on own SubmissionEntry (outside submission queue), that would be added to the submission queue using put, be sure its cleared if it's reused for multiple operations.

Uring
(local variable) during.Uring io
io
;
const
(local variable) const(int) setupRet
setupRet
=
(local variable) during.Uring io
io
.
int during.setup(ref during.Uring uring, uint entries = 128u, during.io_uring.SetupFlags flags = SetupFlags.NONE) nothrow @nogc @safe

Setup new instance of io_uring into provided Uring structure.

@paramuring Uring structure to be initialized (must not be already initialized)@paramentries Number of entries to initialize uring with@paramflags SetupFlags to use to initialize uring.@returnsOn succes it returns 0, -errno otherwise.
setup
(8);
if (
(local variable) const(int) setupRet
setupRet
< 0)
{
void std.stdio.writefln!(char, const(int))(in char[] fmt, const(int) __param_1) @safe

Equivalent to writef(fmt, args, '\n').

writefln
("SKIP: io_uring_setup failed (errno %d) — io_uring unavailable on this host", -
(local variable) const(int) setupRet
setupRet
);
return 0; } // Fast unsupported-feature gate: ask the kernel whether it knows the op at // all. An old kernel (or one without the probe op) trips the SKIP path here // before we touch any buffers. auto
(local variable) during.Probe probe
probe
=
(local variable) during.Uring io
io
.
during.Probe during.Uring.probe() nothrow @nogc @safe

Probes supported operations

probe
();
if (!cast(bool)
(local variable) during.Probe probe
probe
|| !
(local variable) during.Probe probe
probe
.
bool during.Probe.isSupported(during.io_uring.Operation op) const pure nothrow @nogc @safe

Is operation supported?

isSupported
(
(enum) during.io_uring.Operation

Describes the operation to be performed

@seeio_uring_enter(2)
Operation
.
(enum value) during.io_uring.Operation.READ_MULTISHOT = cast(ubyte)49u

IORING_OP_READ_MULTISHOT - multishot read into a buffer group

READ_MULTISHOT
))
{
void std.stdio.writefln!char(in char[] fmt) @safe

Equivalent to writef(fmt, args, '\n').

writefln
("SKIP: IORING_OP_READ_MULTISHOT not advertised by probe — needs Linux 6.7+");
return 0; } // A pipe gives us a *pollable* fd: multishot read re-arms on each readiness // edge. We read the read end via io_uring and feed it with ordinary write(2) // on the write end. Loopback-only, no fds beyond this process. int[2]
(local variable) int[2] p
p
;
if (
int core.sys.posix.unistd.pipe(ref int[2]) nothrow @nogc @trusted
pipe
(
(local variable) int[2] p
p
) != 0)
{ stderr.
std.stdio.File std.stdio.makeGlobal!"core.stdc.stdio.stderr"() nothrow @nogc @property ref @system
writefln
("pipe() failed");
return 1; } scope (exit) {
int core.sys.posix.unistd.close(int) nothrow @nogc @trusted
close
(
(local variable) int[2] p
p
[0]);
int core.sys.posix.unistd.close(int) nothrow @nogc @trusted
close
(
(local variable) int[2] p
p
[1]); }
// Allocate the buffer ring page-aligned (IORING_REGISTER_PBUF_RING requires // page alignment). It is a flat array of RING_ENTRIES `io_uring_buf` slots; // slot 0's `resv` field doubles as the ring's producer tail. enum
(alias) object.size_t = ulong
size_t
(constant) ulong io_uring_read_multishot.main.ringBytes = 128LU
ringBytes
=
(struct) during.io_uring.io_uring_buf
io_uring_buf
.
(constant) ulong during.io_uring.io_uring_buf.sizeof = 16LU
sizeof
*
(constant) uint io_uring_read_multishot.RING_ENTRIES = 8u
RING_ENTRIES
;
void*
(local variable) void* ringPtr
ringPtr
;
if (
int core.sys.posix.stdlib.posix_memalign(scope void**, ulong, ulong) pure nothrow @nogc
posix_memalign
(&
(local variable) void* ringPtr
ringPtr
, 4096,
(constant) ulong io_uring_read_multishot.main.ringBytes = 128LU
ringBytes
) != 0 ||
(local variable) void* ringPtr
ringPtr
is null)
{ stderr.
std.stdio.File std.stdio.makeGlobal!"core.stdc.stdio.stderr"() nothrow @nogc @property ref @system
writefln
("posix_memalign failed");
return 1; } scope (exit)
void core.stdc.stdlib.free(void* ptr) nothrow @nogc
free
(
(local variable) void* ringPtr
ringPtr
);
auto
(local variable) during.io_uring.io_uring_buf* ring
ring
= cast(
(struct) during.io_uring.io_uring_buf
io_uring_buf
*)
(local variable) void* ringPtr
ringPtr
;
(local variable) during.io_uring.io_uring_buf* ring
ring
[0 ..
(constant) uint io_uring_read_multishot.RING_ENTRIES = 8u
RING_ENTRIES
] =
(struct) during.io_uring.io_uring_buf
io_uring_buf
.
(constant) during.io_uring.io_uring_buf during.io_uring.io_uring_buf.init = io_uring_buf(0LU, 0u, cast(ushort)0u, cast(ushort)0u)
init
; // zero whole ring (incl. tail=0)
// Backing storage for the buffers (separate from the 16-byte ring slots). auto
(local variable) ubyte[] store
store
= new ubyte[
(constant) uint io_uring_read_multishot.BUF_SIZE = 64u
BUF_SIZE
*
(constant) uint io_uring_read_multishot.RING_ENTRIES = 8u
RING_ENTRIES
];
// Register the buffer ring for group BGID. A pre-6.7 kernel that nonetheless // lacks buffer rings would fail here; treat the unsupported errnos as SKIP.
(struct) during.io_uring.io_uring_buf_reg
io_uring_buf_reg
(local variable) during.io_uring.io_uring_buf_reg reg
reg
;
(local variable) during.io_uring.io_uring_buf_reg reg
reg
.
(field) ulong during.io_uring.io_uring_buf_reg.ring_addr
ring_addr
= cast(ulong)
(local variable) void* ringPtr
ringPtr
;
(local variable) during.io_uring.io_uring_buf_reg reg
reg
.
(field) uint during.io_uring.io_uring_buf_reg.ring_entries
ring_entries
=
(constant) uint io_uring_read_multishot.RING_ENTRIES = 8u
RING_ENTRIES
;
(local variable) during.io_uring.io_uring_buf_reg reg
reg
.
(field) ushort during.io_uring.io_uring_buf_reg.bgid
bgid
=
(constant) ushort io_uring_read_multishot.BGID = cast(ushort)7u
BGID
;
const
(local variable) const(int) regRet
regRet
=
(local variable) during.Uring io
io
.
int during.Uring.registerBufRing(ref scope during.io_uring.io_uring_buf_reg reg, uint flags = 0u) nothrow @nogc @trusted

Registers a kernel-side provided-buffer ring (IORING_REGISTER_PBUF_RING). reg must be filled with the buffer ring address, entry count and group id; flags is OR'd into reg`.`flags (e.g. IOU_PBUF_RING_INC). Mirrors liburing's io_uring_register_buf_ring.

@returnsOn success, returns 0. On error, -errno.
registerBufRing
(
(local variable) during.io_uring.io_uring_buf_reg reg
reg
);
if (
(local variable) const(int) regRet
regRet
== -
(constant) int core.stdc.errno.EINVAL = 22
EINVAL
||
(local variable) const(int) regRet
regRet
== -
(constant) int core.stdc.errno.EOPNOTSUPP = 95
EOPNOTSUPP
||
(local variable) const(int) regRet
regRet
== -
(constant) int core.stdc.errno.ENOSYS = 38
ENOSYS
)
{
void std.stdio.writefln!(char, const(int))(in char[] fmt, const(int) __param_1) @safe

Equivalent to writef(fmt, args, '\n').

writefln
("SKIP: IORING_REGISTER_PBUF_RING unsupported (errno %d) — needs Linux 5.19+", -
(local variable) const(int) regRet
regRet
);
return 0; } if (
(local variable) const(int) regRet
regRet
< 0)
{ stderr.
std.stdio.File std.stdio.makeGlobal!"core.stdc.stdio.stderr"() nothrow @nogc @property ref @system
writefln
("registerBufRing failed: errno %d", -
(local variable) const(int) regRet
regRet
);
return 1; } scope (exit)
(local variable) during.Uring io
io
.
int during.Uring.unregisterBufRing(int bgid) nothrow @nogc @trusted

Unregisters the provided-buffer ring with group id bgid. Mirrors liburing's io_uring_unregister_buf_ring.

@returnsOn success, returns 0. On error, -errno.
unregisterBufRing
(
(constant) ushort io_uring_read_multishot.BGID = cast(ushort)7u
BGID
);
// Publish all RING_ENTRIES buffers: each slot points at its BUF_SIZE chunk of // `store` and carries a distinct buffer id (`bid == index`, so we can recover // which chunk the kernel filled). enum uint
(constant) uint io_uring_read_multishot.main.mask = 7u
mask
=
(constant) uint io_uring_read_multishot.RING_ENTRIES = 8u
RING_ENTRIES
- 1;
foreach (ushort
(local variable) ushort i
i
; 0 .. cast(ushort)
(constant) uint io_uring_read_multishot.RING_ENTRIES = 8u
RING_ENTRIES
)
{ auto
(local variable) during.io_uring.io_uring_buf* slot
slot
= &
(local variable) during.io_uring.io_uring_buf* ring
ring
[
(local variable) ushort i
i
&
(constant) uint io_uring_read_multishot.main.mask = 7u
mask
];
(local variable) during.io_uring.io_uring_buf* slot
slot
.
(field) ulong during.io_uring.io_uring_buf.addr
addr
= cast(ulong) &
(local variable) ubyte[] store
store
[
(local variable) ushort i
i
*
(constant) uint io_uring_read_multishot.BUF_SIZE = 64u
BUF_SIZE
];
(local variable) during.io_uring.io_uring_buf* slot
slot
.
(field) uint during.io_uring.io_uring_buf.len
len
=
(constant) uint io_uring_read_multishot.BUF_SIZE = 64u
BUF_SIZE
;
(local variable) during.io_uring.io_uring_buf* slot
slot
.
(field) ushort during.io_uring.io_uring_buf.bid
bid
=
(local variable) ushort i
i
;
} // Advance the producer tail by the count of published buffers (tail lives in // slot 0, overlaying io_uring_buf.resv).
(local variable) during.io_uring.io_uring_buf* ring
ring
[0].
(field) ushort during.io_uring.io_uring_buf.resv
resv
= cast(ushort)
(constant) uint io_uring_read_multishot.RING_ENTRIES = 8u
RING_ENTRIES
;
// Arm one multishot READ on the pipe read end, selecting from group BGID. // `prepReadMultishot` sets IOSQE_BUFFER_SELECT + buf_group for us. After this // single submit the kernel re-arms itself across completions. // The kernel's READ_MULTISHOT prep rejects a non-zero `len` (sqe->len must be // 0) and treats a `-1` offset as "use the file position" — the right choice // for a stream like a pipe. The per-read size is whatever buffer the group // hands out (BUF_SIZE here), not an SQE field. enum ulong
(constant) ulong io_uring_read_multishot.main.cookie = 1856844631LU
cookie
= 0x6EAD_3357;
(local variable) during.Uring io
io
.putWith!((ref SubmissionEntry e, int readFd) {
e.prepReadMultishot(readFd, 0, -1, BGID); e.user_data = cookie; })(
during.Uring during.Uring.putWith!(function (ref during.io_uring.SubmissionEntry e, int readFd) nothrow @nogc @safe { prepReadMultishot(e, readFd, 0u, -1L, cast(ushort)7u); e.user_data = 1856844631LU; } , int)(ref int __param_0) nothrow @nogc return ref @safe

Adds new entry to the SubmissionQueue.

Note that this just adds entry to the queue and doesn't advance the tail marker kernel sees. For that finishSq() is needed to be called next.

Also note that to actually enter new entries to kernel, it's needed to call submit().

@paramFN Function to fill next entry in queue by ref (should be faster). It is expected to be in a form of void function(ARGS)(ref SubmissionEntry, auto ref ARGS). Note that in this case queue entry is cleaned first before function is called.@paramentry Custom built SubmissionEntry to be posted as is. Note that in this case it is copied whole over one in the SubmissionQueue.@paramargs Optional arguments passed to the function@returnsreference to Uring structure so it's possible to chain multiple commands.
p
[0]);
const
(local variable) const(int) submitted
submitted
=
(local variable) during.Uring io
io
.
int during.Uring.submit(uint want) nothrow @nogc @safe

Submits qued SubmissionEntry to be processed by kernel.

@paramwant number of CompletionEntries to wait for. If 0, this just submits queued entries and returns. If > 0, it blocks until at least wanted number of entries were completed.@paramsig See io_uring_enter(2) man page@returnsNumber of submitted entries on success, -errno on error
submit
(0); // flush SQ without blocking
if (
(local variable) const(int) submitted
submitted
< 0)
{ stderr.
std.stdio.File std.stdio.makeGlobal!"core.stdc.stdio.stderr"() nothrow @nogc @property ref @system
writefln
("submit failed: errno %d", -
(local variable) const(int) submitted
submitted
);
return 1; } // Write CHUNKS distinct payloads. Each readiness edge drives one multishot // read -> one CQE. We write them one at a time and drain the CQE in between // so the two chunks don't coalesce into a single read. static immutable
(alias) object.string = string
string
[
(constant) uint io_uring_read_multishot.CHUNKS = 2u
CHUNKS
]
(immutable global) immutable(string[2]) io_uring_read_multishot.main.payloads
payloads
= ["first-chunk", "second-chunk!!"];
foreach (
(parameter) ulong idx
idx
,
(parameter) immutable(string) payload
payload
;
(immutable global) immutable(string[2]) io_uring_read_multishot.main.payloads
payloads
)
{ const
(local variable) const(long) wrote
wrote
=
long core.sys.posix.unistd.write(int, scope const(void*), ulong) nothrow @nogc
write
(
(local variable) int[2] p
p
[1], &
(local variable) immutable(string) payload
payload
[0],
(local variable) immutable(string) payload
payload
.
(field) ulong immutable(string).length
length
);
if (
(local variable) const(long) wrote
wrote
!= cast(
(alias) object.ptrdiff_t = long
ptrdiff_t
)
(local variable) immutable(string) payload
payload
.
(field) ulong immutable(string).length
length
)
{ stderr.
std.stdio.File std.stdio.makeGlobal!"core.stdc.stdio.stderr"() nothrow @nogc @property ref @system
writefln
("write to pipe failed: %d",
(local variable) const(long) wrote
wrote
);
return 1; } // Exactly one CQE is imminent per write — bounded wait.
(local variable) during.Uring io
io
.
int during.Uring.wait(uint want = 1u) nothrow @nogc

Simmilar to submit but with this method we just wait for required number of CompletionEntries.

@returns0 on success, -errno on error
wait
(1);
const
(local variable) const(during.io_uring.CompletionEntry) c
c
=
(local variable) during.Uring io
io
.
during.io_uring.CompletionEntry during.Uring.front() pure nothrow @nogc return ref @safe

Get first CompletionEntry from cq ring

front
;
const
(local variable) const(int) res
res
=
(local variable) const(during.io_uring.CompletionEntry) c
c
.
(field) int during.io_uring.CompletionEntry.res

result code for this event

res
;
const
(local variable) const(during.io_uring.CQEFlags) flags
flags
=
(local variable) const(during.io_uring.CompletionEntry) c
c
.
(field) during.io_uring.CQEFlags during.io_uring.CompletionEntry.flags
flags
;
const
(local variable) const(ulong) echoed
echoed
=
(local variable) const(during.io_uring.CompletionEntry) c
c
.
(field) ulong during.io_uring.CompletionEntry.user_data

sqe->data submission passed back

user_data
;
(local variable) during.Uring io
io
.
void during.Uring.popFront() pure nothrow @nogc @safe

Move to next CompletionEntry

popFront
();
if (
(local variable) const(ulong) echoed
echoed
!=
(constant) ulong io_uring_read_multishot.main.cookie = 1856844631LU
cookie
)
{ stderr.
std.stdio.File std.stdio.makeGlobal!"core.stdc.stdio.stderr"() nothrow @nogc @property ref @system
writefln
("user_data mismatch: expected 0x%X, got 0x%X",
(constant) ulong io_uring_read_multishot.main.cookie = 1856844631LU
cookie
,
(local variable) const(ulong) echoed
echoed
);
return 1; } // -EINVAL/-EOPNOTSUPP slipping past the probe means the op truly is not // wired up on this kernel: SKIP rather than fail. if (
(local variable) const(int) res
res
== -
(constant) int core.stdc.errno.EINVAL = 22
EINVAL
||
(local variable) const(int) res
res
== -
(constant) int core.stdc.errno.EOPNOTSUPP = 95
EOPNOTSUPP
||
(local variable) const(int) res
res
== -
(constant) int core.stdc.errno.ENOSYS = 38
ENOSYS
)
{
void std.stdio.writefln!(char, const(int))(in char[] fmt, const(int) __param_1) @safe

Equivalent to writef(fmt, args, '\n').

writefln
("SKIP: READ_MULTISHOT rejected at runtime (errno %d) — needs Linux 6.7+", -
(local variable) const(int) res
res
);
return 0; } // -ENOBUFS would mean our buffer group ran dry — a bug in our bookkeeping // here (we published far more buffers than chunks), so it's a hard error. if (
(local variable) const(int) res
res
< 0)
{ stderr.
std.stdio.File std.stdio.makeGlobal!"core.stdc.stdio.stderr"() nothrow @nogc @property ref @system
writefln
("READ_MULTISHOT chunk %d failed: errno %d",
(local variable) ulong idx
idx
, -
(local variable) const(int) res
res
);
return 1; } if (
(local variable) const(int) res
res
!= cast(int)
(local variable) immutable(string) payload
payload
.
(field) ulong immutable(string).length
length
)
{ stderr.
std.stdio.File std.stdio.makeGlobal!"core.stdc.stdio.stderr"() nothrow @nogc @property ref @system
writefln
("chunk %d byte count: expected %d, got %d",
(local variable) ulong idx
idx
,
(local variable) immutable(string) payload
payload
.
(field) ulong immutable(string).length
length
,
(local variable) const(int) res
res
);
return 1; } // Multishot contract: each in-flight CQE must carry BUFFER (a buffer was // selected) and MORE (the request stays armed for the next chunk). if (!(
(local variable) const(during.io_uring.CQEFlags) flags
flags
&
(enum) during.io_uring.CQEFlags

Flags used with CompletionEntry

CQEFlags
.
(enum value) during.io_uring.CQEFlags.BUFFER = 1u

IORING_CQE_F_BUFFER (from Linux 5.7) If set, the upper 16 bits are the buffer ID

BUFFER
))
{ stderr.
std.stdio.File std.stdio.makeGlobal!"core.stdc.stdio.stderr"() nothrow @nogc @property ref @system
writefln
("chunk %d: missing IORING_CQE_F_BUFFER (flags=0x%X)",
(local variable) ulong idx
idx
, cast(uint)
(local variable) const(during.io_uring.CQEFlags) flags
flags
);
return 1; } if (!(
(local variable) const(during.io_uring.CQEFlags) flags
flags
&
(enum) during.io_uring.CQEFlags

Flags used with CompletionEntry

CQEFlags
.
(enum value) during.io_uring.CQEFlags.MORE = 2u

IORING_CQE_F_MORE (from Linux 5.13) If set, parent SQE will generate more CQE entries

MORE
))
{ stderr.
std.stdio.File std.stdio.makeGlobal!"core.stdc.stdio.stderr"() nothrow @nogc @property ref @system
writefln
("chunk %d: multishot disarmed early, missing IORING_CQE_F_MORE (flags=0x%X)",
(local variable) ulong idx
idx
, cast(uint)
(local variable) const(during.io_uring.CQEFlags) flags
flags
);
return 1; } // Recover the kernel-chosen buffer id from the upper 16 bits and confirm // the bytes landed in that exact buffer. const
(local variable) const(ushort) bid
bid
= cast(ushort)(cast(uint)
(local variable) const(during.io_uring.CQEFlags) flags
flags
>>
(enum value) during.io_uring.CQE_BUFFER_SHIFT = 16

Note

available from Linux 5.7

CQE_BUFFER_SHIFT
);
if (
(local variable) const(ushort) bid
bid
>=
(constant) uint io_uring_read_multishot.RING_ENTRIES = 8u
RING_ENTRIES
)
{ stderr.
std.stdio.File std.stdio.makeGlobal!"core.stdc.stdio.stderr"() nothrow @nogc @property ref @system
writefln
("chunk %d: out-of-range buffer id %d",
(local variable) ulong idx
idx
,
(local variable) const(ushort) bid
bid
);
return 1; } auto
(local variable) ubyte[] got
got
=
(local variable) ubyte[] store
store
[
(local variable) const(ushort) bid
bid
*
(constant) uint io_uring_read_multishot.BUF_SIZE = 64u
BUF_SIZE
..
(local variable) const(ushort) bid
bid
*
(constant) uint io_uring_read_multishot.BUF_SIZE = 64u
BUF_SIZE
+
(local variable) const(int) res
res
];
if (cast(const(char)[])
(local variable) ubyte[] got
got
!=
(local variable) immutable(string) payload
payload
)
{ stderr.
std.stdio.File std.stdio.makeGlobal!"core.stdc.stdio.stderr"() nothrow @nogc @property ref @system
writefln
("chunk %d: payload mismatch in buffer %d",
(local variable) ulong idx
idx
,
(local variable) const(ushort) bid
bid
);
return 1; }
void std.stdio.writefln!(char, ulong, const(ushort), const(int), const(char)[])(in char[] fmt, ulong __param_1, const(ushort) __param_2, const(int) __param_3, const(char)[] __param_4) @safe

Equivalent to writef(fmt, args, '\n').

writefln
("ok: multishot chunk %d -> buffer id %d (%d bytes, MORE|BUFFER set): \"%s\"",
(local variable) ulong idx
idx
,
(local variable) const(ushort) bid
bid
,
(local variable) const(int) res
res
, cast(const(char)[])
(local variable) ubyte[] got
got
);
}
void std.stdio.writefln!(char, uint, uint)(in char[] fmt, uint __param_1, uint __param_2) @safe

Equivalent to writef(fmt, args, '\n').

writefln
("ok: one READ_MULTISHOT SQE produced %d completions across %d buffers",
(constant) uint io_uring_read_multishot.CHUNKS = 2u
CHUNKS
,
(constant) uint io_uring_read_multishot.RING_ENTRIES = 8u
RING_ENTRIES
);
return 0; }