diff options
author | Gil Cukierman <cukie@google.com> | 2022-10-31 15:25:16 +0000 |
---|---|---|
committer | Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com> | 2022-10-31 15:25:16 +0000 |
commit | 1d27ff1934c5c4292dc00fba7f7f8ae411ed42f5 (patch) | |
tree | ebe9c872e416346e4b333e5062da32401c8e0a73 /man/io_uring_get_sqe.3 | |
parent | d53db6851ea17b2d219d084e1afc683b8b62b105 (diff) | |
parent | 7ba7e81400b122a5e3b9dd1ec938fbeda8215899 (diff) | |
download | liburing-master.tar.gz |
Update liburing to version 2.2 am: d0a2042580 am: dae12c7b40 am: 7ba7e81400HEADandroid-14.0.0_r50android-14.0.0_r45android-14.0.0_r44android-14.0.0_r43android-14.0.0_r42android-14.0.0_r41android-14.0.0_r40android-14.0.0_r39android-14.0.0_r38android-14.0.0_r37android-14.0.0_r36android-14.0.0_r35android-14.0.0_r34android-14.0.0_r33android-14.0.0_r32android-14.0.0_r31android-14.0.0_r30android-14.0.0_r29android-14.0.0_r27android-14.0.0_r26android-14.0.0_r25android-14.0.0_r24android-14.0.0_r23android-14.0.0_r22android-14.0.0_r21android-14.0.0_r20android-14.0.0_r19android-14.0.0_r18android-14.0.0_r17android-14.0.0_r16aml_rkp_341510000aml_rkp_341311000aml_rkp_341114000aml_rkp_341015010aml_rkp_341012000aml_hef_341717050aml_hef_341613000aml_hef_341512030aml_hef_341415040aml_hef_341311010aml_hef_341114030aml_cfg_341510000mastermainandroid14-qpr3-releaseandroid14-qpr2-s5-releaseandroid14-qpr2-s4-releaseandroid14-qpr2-s3-releaseandroid14-qpr2-s2-releaseandroid14-qpr2-s1-releaseandroid14-qpr2-releaseandroid14-qpr1-s2-releaseandroid14-qpr1-releaseandroid14-mainline-healthfitness-releaseandroid14-devandroid14-d2-s5-releaseandroid14-d2-s4-releaseandroid14-d2-s3-releaseandroid14-d2-s2-releaseandroid14-d2-s1-releaseandroid14-d2-release
Original change: https://android-review.googlesource.com/c/platform/external/liburing/+/2276974
Change-Id: I2a7ecac6e769b82bba38ebfbce3301259a663146
Signed-off-by: Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>
Diffstat (limited to 'man/io_uring_get_sqe.3')
-rw-r--r-- | man/io_uring_get_sqe.3 | 22 |
1 files changed, 13 insertions, 9 deletions
diff --git a/man/io_uring_get_sqe.3 b/man/io_uring_get_sqe.3 index 24834f3..58c8b96 100644 --- a/man/io_uring_get_sqe.3 +++ b/man/io_uring_get_sqe.3 @@ -5,25 +5,28 @@ .\" .TH io_uring_get_sqe 3 "July 10, 2020" "liburing-0.7" "liburing Manual" .SH NAME -io_uring_get_sqe - get the next vacant event from the submission queue +io_uring_get_sqe \- get the next available submission queue entry from the +submission queue .SH SYNOPSIS .nf -.BR "#include <liburing.h>" +.B #include <liburing.h> .PP -.BI "struct io_uring_sqe *io_uring_get_sqe(struct io_uring " *ring ); +.BI "struct io_uring_sqe *io_uring_get_sqe(struct io_uring *" ring ");" .fi -.PP .SH DESCRIPTION .PP -The io_uring_get_sqe() function gets the next vacant event from the submission +The +.BR io_uring_get_sqe (3) +function gets the next available submission queue entry from the submission queue belonging to the .I ring param. -On success io_uring_get_sqe() returns a pointer to the submission queue event. -On failure NULL is returned. +On success +.BR io_uring_get_sqe (3) +returns a pointer to the submission queue entry. On failure NULL is returned. -If a submission queue event is returned, it should be filled out via one of the +If a submission queue entry is returned, it should be filled out via one of the prep functions such as .BR io_uring_prep_read (3) and submitted via @@ -32,6 +35,7 @@ and submitted via .SH RETURN VALUE .BR io_uring_get_sqe (3) returns a pointer to the next submission queue event on success and NULL on -failure. +failure. If NULL is returned, the SQ ring is currently full and entries must +be submitted for processing before new ones can get allocated. .SH SEE ALSO .BR io_uring_submit (3) |