io_uring: don't export io_put_task()
[linux-block.git] / io_uring / io_uring.h
CommitLineData
de23077e
JA
1#ifndef IOU_CORE_H
2#define IOU_CORE_H
3
4#include <linux/errno.h>
cd40cae2 5#include <linux/lockdep.h>
ab1c84d8 6#include <linux/io_uring_types.h>
44648532 7#include <uapi/linux/eventpoll.h>
ab1c84d8 8#include "io-wq.h"
a6b21fbb 9#include "slist.h"
ab1c84d8 10#include "filetable.h"
de23077e 11
f3b44f92
JA
12#ifndef CREATE_TRACE_POINTS
13#include <trace/events/io_uring.h>
14#endif
15
97b388d7
JA
16enum {
17 IOU_OK = 0,
18 IOU_ISSUE_SKIP_COMPLETE = -EIOCBQUEUED,
114eccdf
DY
19
20 /*
91482864
PB
21 * Intended only when both IO_URING_F_MULTISHOT is passed
22 * to indicate to the poll runner that multishot should be
114eccdf
DY
23 * removed and the result is set on req->cqe.res.
24 */
25 IOU_STOP_MULTISHOT = -ECANCELED,
97b388d7
JA
26};
27
aa1df3a3 28struct io_uring_cqe *__io_get_cqe(struct io_ring_ctx *ctx, bool overflow);
68494a65 29bool io_req_cqe_overflow(struct io_kiocb *req);
c0e0d6ba 30int io_run_task_work_sig(struct io_ring_ctx *ctx);
973fc83f 31void io_req_defer_failed(struct io_kiocb *req, s32 res);
1bec951c 32void io_req_complete_post(struct io_kiocb *req, unsigned issue_flags);
b529c96a 33bool io_post_aux_cqe(struct io_ring_ctx *ctx, u64 user_data, s32 res, u32 cflags);
9b8c5475
DY
34bool io_aux_cqe(struct io_ring_ctx *ctx, bool defer, u64 user_data, s32 res, u32 cflags,
35 bool allow_overflow);
9046c641
PB
36void __io_commit_cqring_flush(struct io_ring_ctx *ctx);
37
38struct page **io_pin_pages(unsigned long ubuf, unsigned long len, int *npages);
39
40struct file *io_file_get_normal(struct io_kiocb *req, int fd);
41struct file *io_file_get_fixed(struct io_kiocb *req, int fd,
42 unsigned issue_flags);
43
f6b543fd
JA
44static inline bool io_req_ffs_set(struct io_kiocb *req)
45{
46 return req->flags & REQ_F_FIXED_FILE;
47}
48
e52d2e58 49void __io_req_task_work_add(struct io_kiocb *req, bool allow_local);
9046c641
PB
50bool io_is_uring_fops(struct file *file);
51bool io_alloc_async_data(struct io_kiocb *req);
9046c641
PB
52void io_req_task_queue(struct io_kiocb *req);
53void io_queue_iowq(struct io_kiocb *req, bool *dont_use);
54void io_req_task_complete(struct io_kiocb *req, bool *locked);
55void io_req_task_queue_fail(struct io_kiocb *req, int ret);
56void io_req_task_submit(struct io_kiocb *req, bool *locked);
57void tctx_task_work(struct callback_head *cb);
58__cold void io_uring_cancel_generic(bool cancel_all, struct io_sq_data *sqd);
59int io_uring_alloc_task_context(struct task_struct *task,
60 struct io_ring_ctx *ctx);
61
62int io_poll_issue(struct io_kiocb *req, bool *locked);
63int io_submit_sqes(struct io_ring_ctx *ctx, unsigned int nr);
64int io_do_iopoll(struct io_ring_ctx *ctx, bool force_nonspin);
65void io_free_batch_list(struct io_ring_ctx *ctx, struct io_wq_work_node *node);
66int io_req_prep_async(struct io_kiocb *req);
67
68struct io_wq_work *io_wq_free_work(struct io_wq_work *work);
69void io_wq_submit_work(struct io_wq_work *work);
70
71void io_free_req(struct io_kiocb *req);
72void io_queue_next(struct io_kiocb *req);
63809137 73void io_task_refs_refill(struct io_uring_task *tctx);
bd1a3783 74bool __io_alloc_req_refill(struct io_ring_ctx *ctx);
9046c641
PB
75
76bool io_match_task_safe(struct io_kiocb *head, struct task_struct *task,
77 bool cancel_all);
78
f26cc959
PB
79#define io_lockdep_assert_cq_locked(ctx) \
80 do { \
81 if (ctx->flags & IORING_SETUP_IOPOLL) { \
82 lockdep_assert_held(&ctx->uring_lock); \
83 } else if (!ctx->task_complete) { \
84 lockdep_assert_held(&ctx->completion_lock); \
85 } else if (ctx->submitter_task->flags & PF_EXITING) { \
86 lockdep_assert(current_work()); \
87 } else { \
88 lockdep_assert(current == ctx->submitter_task); \
89 } \
90 } while (0)
91
e52d2e58
PB
92static inline void io_req_task_work_add(struct io_kiocb *req)
93{
94 __io_req_task_work_add(req, true);
95}
96
9046c641
PB
97#define io_for_each_link(pos, head) \
98 for (pos = (head); pos; pos = pos->link)
f3b44f92 99
25399321
PB
100void io_cq_unlock_post(struct io_ring_ctx *ctx);
101
aa1df3a3
PB
102static inline struct io_uring_cqe *io_get_cqe_overflow(struct io_ring_ctx *ctx,
103 bool overflow)
f3b44f92 104{
f26cc959
PB
105 io_lockdep_assert_cq_locked(ctx);
106
f3b44f92
JA
107 if (likely(ctx->cqe_cached < ctx->cqe_sentinel)) {
108 struct io_uring_cqe *cqe = ctx->cqe_cached;
109
f3b44f92
JA
110 ctx->cached_cq_tail++;
111 ctx->cqe_cached++;
b3659a65
PB
112 if (ctx->flags & IORING_SETUP_CQE32)
113 ctx->cqe_cached++;
f3b44f92
JA
114 return cqe;
115 }
116
aa1df3a3
PB
117 return __io_get_cqe(ctx, overflow);
118}
119
120static inline struct io_uring_cqe *io_get_cqe(struct io_ring_ctx *ctx)
121{
122 return io_get_cqe_overflow(ctx, false);
f3b44f92
JA
123}
124
125static inline bool __io_fill_cqe_req(struct io_ring_ctx *ctx,
126 struct io_kiocb *req)
127{
128 struct io_uring_cqe *cqe;
129
e8c328c3
PB
130 /*
131 * If we can't get a cq entry, userspace overflowed the
132 * submission (by quite a lot). Increment the overflow count in
133 * the ring.
134 */
135 cqe = io_get_cqe(ctx);
136 if (unlikely(!cqe))
f66f7342 137 return false;
e0486f3f
DY
138
139 trace_io_uring_complete(req->ctx, req, req->cqe.user_data,
140 req->cqe.res, req->cqe.flags,
141 (req->flags & REQ_F_CQE32_INIT) ? req->extra1 : 0,
142 (req->flags & REQ_F_CQE32_INIT) ? req->extra2 : 0);
143
e8c328c3
PB
144 memcpy(cqe, &req->cqe, sizeof(*cqe));
145
146 if (ctx->flags & IORING_SETUP_CQE32) {
f3b44f92
JA
147 u64 extra1 = 0, extra2 = 0;
148
149 if (req->flags & REQ_F_CQE32_INIT) {
150 extra1 = req->extra1;
151 extra2 = req->extra2;
152 }
153
e8c328c3
PB
154 WRITE_ONCE(cqe->big_cqe[0], extra1);
155 WRITE_ONCE(cqe->big_cqe[1], extra2);
f3b44f92 156 }
e8c328c3 157 return true;
f3b44f92
JA
158}
159
f66f7342
PB
160static inline bool io_fill_cqe_req(struct io_ring_ctx *ctx,
161 struct io_kiocb *req)
162{
163 if (likely(__io_fill_cqe_req(ctx, req)))
164 return true;
165 return io_req_cqe_overflow(req);
166}
167
531113bb
JA
168static inline void req_set_fail(struct io_kiocb *req)
169{
170 req->flags |= REQ_F_FAIL;
171 if (req->flags & REQ_F_CQE_SKIP) {
172 req->flags &= ~REQ_F_CQE_SKIP;
173 req->flags |= REQ_F_SKIP_LINK_CQES;
174 }
175}
176
de23077e
JA
177static inline void io_req_set_res(struct io_kiocb *req, s32 res, u32 cflags)
178{
179 req->cqe.res = res;
180 req->cqe.flags = cflags;
181}
182
99f15d8d
JA
183static inline bool req_has_async_data(struct io_kiocb *req)
184{
185 return req->flags & REQ_F_ASYNC_DATA;
186}
187
531113bb
JA
188static inline void io_put_file(struct file *file)
189{
190 if (file)
191 fput(file);
192}
193
cd40cae2
JA
194static inline void io_ring_submit_unlock(struct io_ring_ctx *ctx,
195 unsigned issue_flags)
196{
197 lockdep_assert_held(&ctx->uring_lock);
198 if (issue_flags & IO_URING_F_UNLOCKED)
199 mutex_unlock(&ctx->uring_lock);
200}
201
202static inline void io_ring_submit_lock(struct io_ring_ctx *ctx,
203 unsigned issue_flags)
204{
205 /*
206 * "Normal" inline submissions always hold the uring_lock, since we
207 * grab it from the system call. Same is true for the SQPOLL offload.
208 * The only exception is when we've detached the request and issue it
209 * from an async worker thread, grab the lock for that case.
210 */
211 if (issue_flags & IO_URING_F_UNLOCKED)
212 mutex_lock(&ctx->uring_lock);
213 lockdep_assert_held(&ctx->uring_lock);
214}
215
f9ead18c
JA
216static inline void io_commit_cqring(struct io_ring_ctx *ctx)
217{
218 /* order cqe stores with ring update */
219 smp_store_release(&ctx->rings->cq.tail, ctx->cached_cq_tail);
220}
221
7b235dd8
PB
222static inline void io_poll_wq_wake(struct io_ring_ctx *ctx)
223{
bca39f39 224 if (wq_has_sleeper(&ctx->poll_wq))
7b235dd8
PB
225 __wake_up(&ctx->poll_wq, TASK_NORMAL, 0,
226 poll_to_key(EPOLL_URING_WAKE | EPOLLIN));
227}
228
fc86f9d3
PB
229/* requires smb_mb() prior, see wq_has_sleeper() */
230static inline void __io_cqring_wake(struct io_ring_ctx *ctx)
f3b44f92
JA
231{
232 /*
44648532
JA
233 * Trigger waitqueue handler on all waiters on our waitqueue. This
234 * won't necessarily wake up all the tasks, io_should_wake() will make
235 * that decision.
236 *
237 * Pass in EPOLLIN|EPOLL_URING_WAKE as the poll wakeup key. The latter
238 * set in the mask so that if we recurse back into our own poll
239 * waitqueue handlers, we know we have a dependency between eventfd or
240 * epoll and should terminate multishot poll at that point.
f3b44f92 241 */
fc86f9d3 242 if (waitqueue_active(&ctx->cq_wait))
44648532
JA
243 __wake_up(&ctx->cq_wait, TASK_NORMAL, 0,
244 poll_to_key(EPOLL_URING_WAKE | EPOLLIN));
f3b44f92
JA
245}
246
fc86f9d3
PB
247static inline void io_cqring_wake(struct io_ring_ctx *ctx)
248{
249 smp_mb();
250 __io_cqring_wake(ctx);
251}
252
17437f31
JA
253static inline bool io_sqring_full(struct io_ring_ctx *ctx)
254{
255 struct io_rings *r = ctx->rings;
256
257 return READ_ONCE(r->sq.tail) - ctx->cached_sq_head == ctx->sq_entries;
258}
259
260static inline unsigned int io_sqring_entries(struct io_ring_ctx *ctx)
261{
262 struct io_rings *rings = ctx->rings;
263
264 /* make sure SQ entry isn't read before tail */
265 return smp_load_acquire(&rings->sq.tail) - ctx->cached_sq_head;
266}
267
c0e0d6ba 268static inline int io_run_task_work(void)
17437f31 269{
7cfe7a09
JA
270 /*
271 * Always check-and-clear the task_work notification signal. With how
272 * signaling works for task_work, we can find it set with nothing to
273 * run. We need to clear it for that case, like get_signal() does.
274 */
275 if (test_thread_flag(TIF_NOTIFY_SIGNAL))
276 clear_notify_signal();
46a525e1 277 if (task_work_pending(current)) {
17437f31 278 __set_current_state(TASK_RUNNING);
46a525e1 279 task_work_run();
c0e0d6ba 280 return 1;
17437f31
JA
281 }
282
c0e0d6ba
DY
283 return 0;
284}
285
dac6a0ea
JA
286static inline bool io_task_work_pending(struct io_ring_ctx *ctx)
287{
6434ec01 288 return task_work_pending(current) || !wq_list_empty(&ctx->work_llist);
dac6a0ea
JA
289}
290
aa1e90f6
PB
291static inline void io_tw_lock(struct io_ring_ctx *ctx, bool *locked)
292{
293 if (!*locked) {
294 mutex_lock(&ctx->uring_lock);
295 *locked = true;
296 }
297}
298
9da070b1
PB
299/*
300 * Don't complete immediately but use deferred completion infrastructure.
301 * Protected by ->uring_lock and can only be used either with
302 * IO_URING_F_COMPLETE_DEFER or inside a tw handler holding the mutex.
303 */
304static inline void io_req_complete_defer(struct io_kiocb *req)
305 __must_hold(&req->ctx->uring_lock)
aa1e90f6
PB
306{
307 struct io_submit_state *state = &req->ctx->submit_state;
308
9da070b1
PB
309 lockdep_assert_held(&req->ctx->uring_lock);
310
aa1e90f6
PB
311 wq_list_add_tail(&req->comp_list, &state->compl_reqs);
312}
313
46929b08
PB
314static inline void io_commit_cqring_flush(struct io_ring_ctx *ctx)
315{
bca39f39
PB
316 if (unlikely(ctx->off_timeout_used || ctx->drain_active ||
317 ctx->has_evfd || ctx->poll_activated))
46929b08
PB
318 __io_commit_cqring_flush(ctx);
319}
320
63809137
PB
321static inline void io_get_task_refs(int nr)
322{
323 struct io_uring_task *tctx = current->io_uring;
324
325 tctx->cached_refs -= nr;
326 if (unlikely(tctx->cached_refs < 0))
327 io_task_refs_refill(tctx);
328}
329
bd1a3783
PB
330static inline bool io_req_cache_empty(struct io_ring_ctx *ctx)
331{
332 return !ctx->submit_state.free_list.next;
333}
334
335static inline bool io_alloc_req_refill(struct io_ring_ctx *ctx)
336{
337 if (unlikely(io_req_cache_empty(ctx)))
338 return __io_alloc_req_refill(ctx);
339 return true;
340}
341
342static inline struct io_kiocb *io_alloc_req(struct io_ring_ctx *ctx)
343{
344 struct io_wq_work_node *node;
345
346 node = wq_stack_extract(&ctx->submit_state.free_list);
347 return container_of(node, struct io_kiocb, comp_list);
348}
349
140102ae
PB
350static inline bool io_allowed_defer_tw_run(struct io_ring_ctx *ctx)
351{
352 return likely(ctx->submitter_task == current);
353}
354
76de6749
PB
355static inline bool io_allowed_run_tw(struct io_ring_ctx *ctx)
356{
6567506b
PB
357 return likely(!(ctx->flags & IORING_SETUP_DEFER_TASKRUN) ||
358 ctx->submitter_task == current);
76de6749
PB
359}
360
833b5dff
PB
361static inline void io_req_queue_tw_complete(struct io_kiocb *req, s32 res)
362{
363 io_req_set_res(req, res, 0);
364 req->io_task_work.func = io_req_task_complete;
365 io_req_task_work_add(req);
366}
367
de23077e 368#endif