Commit 36a005b9 authored by Pavel Begunkov's avatar Pavel Begunkov Committed by Jens Axboe
Browse files

io_uring/cmd: document some uring_cmd related helpers 



Add comments warning users that they're only allowed to pass issue_flags
that were given from io_uring.

Signed-off-by: default avatarPavel Begunkov <asml.silence@gmail.com>
Reviewed-by: default avatarMing Lei <ming.lei@redhat.com>
Tested-by: default avatarMing Lei <ming.lei@redhat.com>
Link: https://lore.kernel.org/r/82ff8a45f2c3eb5f3a04a33f0692e5e4a1320455.1710799188.git.asml.silence@gmail.com


Signed-off-by: default avatarJens Axboe <axboe@kernel.dk>
parent e1eef2e5

include/linux/io_uring/cmd.h

+13 −0
Original line number Diff line number Diff line
@@ -26,12 +26,25 @@ static inline const void *io_uring_sqe_cmd(const struct io_uring_sqe *sqe) 
#if defined(CONFIG_IO_URING)

int io_uring_cmd_import_fixed(u64 ubuf, unsigned long len, int rw,

			      struct iov_iter *iter, void *ioucmd);



/*

 * Completes the request, i.e. posts an io_uring CQE and deallocates @ioucmd

 * and the corresponding io_uring request.

 *

 * Note: the caller should never hard code @issue_flags and is only allowed

 * to pass the mask provided by the core io_uring code.

 */

void io_uring_cmd_done(struct io_uring_cmd *cmd, ssize_t ret, ssize_t res2,

			unsigned issue_flags);



void __io_uring_cmd_do_in_task(struct io_uring_cmd *ioucmd,

			    void (*task_work_cb)(struct io_uring_cmd *, unsigned),

			    unsigned flags);



/*

 * Note: the caller should never hard code @issue_flags and only use the

 * mask provided by the core io_uring code.

 */

void io_uring_cmd_mark_cancelable(struct io_uring_cmd *cmd,

		unsigned int issue_flags);