1io_uring_submit(3)              liburing Manual             io_uring_submit(3)
2
3
4

NAME

6       io_uring_submit - submit requests to the submission queue
7

SYNOPSIS

9       #include <liburing.h>
10
11       int io_uring_submit(struct io_uring *ring);
12

DESCRIPTION

14       The  io_uring_submit(3) function submits the next events to the submis‐
15       sion queue belonging to the ring.
16
17       After the caller retrieves a submission queue entry (SQE)  with  io_ur‐
18       ing_get_sqe(3)  and prepares the SQE using one of the provided helpers,
19       it can be submitted with io_uring_submit(3).
20
21

RETURN VALUE

23       On success io_uring_submit(3) returns the number of  submitted  submis‐
24       sion  queue entries, if SQPOLL is not used.  If SQPOLL is used, the re‐
25       turn value may report a higher number of submitted entries  than  actu‐
26       ally submitted. If the the user requires accurate information about how
27       many submission queue entries have been successfully  submitted,  while
28       using SQPOLL, the user must fall back to repeatedly submitting a single
29       submission queue entry. On failure it returns -errno.
30

NOTES

32       For any request that passes in data in a struct, that data must  remain
33       valid  until  the  request has been successfully submitted. It need not
34       remain valid until completion. Once a request has been  submitted,  the
35       in-kernel  state  is  stable.  Very early kernels (5.4 and earlier) re‐
36       quired state to be stable until the completion  occurred.  Applications
37       can  test for this behavior by inspecting the IORING_FEAT_SUBMIT_STABLE
38       flag passed back from io_uring_queue_init_params(3).  In  general,  the
39       man  pages  for the individual prep helpers will have a note mentioning
40       this fact as well, if required for the given command.
41

SEE ALSO

43       io_uring_get_sqe(3),     io_uring_submit_and_wait(3),     io_uring_sub‐
44       mit_and_wait_timeout(3)
45
46
47
48liburing-2.1                   November 15, 2021            io_uring_submit(3)
Impressum