io_uring: make poll refs more robust
[linux-block.git] / io_uring / poll.c
CommitLineData
329061d3
JA
1// SPDX-License-Identifier: GPL-2.0
2#include <linux/kernel.h>
3#include <linux/errno.h>
4#include <linux/fs.h>
5#include <linux/file.h>
6#include <linux/mm.h>
7#include <linux/slab.h>
8#include <linux/poll.h>
9#include <linux/hashtable.h>
10#include <linux/io_uring.h>
11
12#include <trace/events/io_uring.h>
13
14#include <uapi/linux/io_uring.h>
15
329061d3
JA
16#include "io_uring.h"
17#include "refs.h"
18#include "opdef.h"
3b77495a 19#include "kbuf.h"
329061d3 20#include "poll.h"
38513c46 21#include "cancel.h"
329061d3
JA
22
23struct io_poll_update {
24 struct file *file;
25 u64 old_user_data;
26 u64 new_user_data;
27 __poll_t events;
28 bool update_events;
29 bool update_user_data;
30};
31
32struct io_poll_table {
33 struct poll_table_struct pt;
34 struct io_kiocb *req;
35 int nr_entries;
36 int error;
49f1c68e 37 bool owning;
063a0079
PB
38 /* output value, set only if arm poll returns >0 */
39 __poll_t result_mask;
329061d3
JA
40};
41
42#define IO_POLL_CANCEL_FLAG BIT(31)
a26a35e9
PB
43#define IO_POLL_RETRY_FLAG BIT(30)
44#define IO_POLL_REF_MASK GENMASK(29, 0)
45
46/*
47 * We usually have 1-2 refs taken, 128 is more than enough and we want to
48 * maximise the margin between this amount and the moment when it overflows.
49 */
50#define IO_POLL_REF_BIAS 128
329061d3 51
0638cd7b
PB
52#define IO_WQE_F_DOUBLE 1
53
54static inline struct io_kiocb *wqe_to_req(struct wait_queue_entry *wqe)
55{
56 unsigned long priv = (unsigned long)wqe->private;
57
58 return (struct io_kiocb *)(priv & ~IO_WQE_F_DOUBLE);
59}
60
61static inline bool wqe_is_double(struct wait_queue_entry *wqe)
62{
63 unsigned long priv = (unsigned long)wqe->private;
64
65 return priv & IO_WQE_F_DOUBLE;
66}
67
a26a35e9
PB
68static bool io_poll_get_ownership_slowpath(struct io_kiocb *req)
69{
70 int v;
71
72 /*
73 * poll_refs are already elevated and we don't have much hope for
74 * grabbing the ownership. Instead of incrementing set a retry flag
75 * to notify the loop that there might have been some change.
76 */
77 v = atomic_fetch_or(IO_POLL_RETRY_FLAG, &req->poll_refs);
78 if (v & IO_POLL_REF_MASK)
79 return false;
80 return !(atomic_fetch_inc(&req->poll_refs) & IO_POLL_REF_MASK);
81}
82
329061d3
JA
83/*
84 * If refs part of ->poll_refs (see IO_POLL_REF_MASK) is 0, it's free. We can
85 * bump it and acquire ownership. It's disallowed to modify requests while not
86 * owning it, that prevents from races for enqueueing task_work's and b/w
87 * arming poll and wakeups.
88 */
89static inline bool io_poll_get_ownership(struct io_kiocb *req)
90{
a26a35e9
PB
91 if (unlikely(atomic_read(&req->poll_refs) >= IO_POLL_REF_BIAS))
92 return io_poll_get_ownership_slowpath(req);
329061d3
JA
93 return !(atomic_fetch_inc(&req->poll_refs) & IO_POLL_REF_MASK);
94}
95
96static void io_poll_mark_cancelled(struct io_kiocb *req)
97{
98 atomic_or(IO_POLL_CANCEL_FLAG, &req->poll_refs);
99}
100
101static struct io_poll *io_poll_get_double(struct io_kiocb *req)
102{
103 /* pure poll stashes this in ->async_data, poll driven retry elsewhere */
104 if (req->opcode == IORING_OP_POLL_ADD)
105 return req->async_data;
106 return req->apoll->double_poll;
107}
108
109static struct io_poll *io_poll_get_single(struct io_kiocb *req)
110{
111 if (req->opcode == IORING_OP_POLL_ADD)
f2ccb5ae 112 return io_kiocb_to_cmd(req, struct io_poll);
329061d3
JA
113 return &req->apoll->poll;
114}
115
116static void io_poll_req_insert(struct io_kiocb *req)
117{
e6f89be6
PB
118 struct io_hash_table *table = &req->ctx->cancel_table;
119 u32 index = hash_long(req->cqe.user_data, table->hash_bits);
120 struct io_hash_bucket *hb = &table->hbs[index];
329061d3 121
38513c46
HX
122 spin_lock(&hb->lock);
123 hlist_add_head(&req->hash_node, &hb->list);
124 spin_unlock(&hb->lock);
125}
126
127static void io_poll_req_delete(struct io_kiocb *req, struct io_ring_ctx *ctx)
128{
e6f89be6
PB
129 struct io_hash_table *table = &req->ctx->cancel_table;
130 u32 index = hash_long(req->cqe.user_data, table->hash_bits);
131 spinlock_t *lock = &table->hbs[index].lock;
38513c46
HX
132
133 spin_lock(lock);
134 hash_del(&req->hash_node);
135 spin_unlock(lock);
329061d3
JA
136}
137
9ca9fb24
PB
138static void io_poll_req_insert_locked(struct io_kiocb *req)
139{
140 struct io_hash_table *table = &req->ctx->cancel_table_locked;
141 u32 index = hash_long(req->cqe.user_data, table->hash_bits);
142
5576035f
PB
143 lockdep_assert_held(&req->ctx->uring_lock);
144
9ca9fb24
PB
145 hlist_add_head(&req->hash_node, &table->hbs[index].list);
146}
147
148static void io_poll_tw_hash_eject(struct io_kiocb *req, bool *locked)
149{
150 struct io_ring_ctx *ctx = req->ctx;
151
152 if (req->flags & REQ_F_HASH_LOCKED) {
153 /*
154 * ->cancel_table_locked is protected by ->uring_lock in
155 * contrast to per bucket spinlocks. Likely, tctx_task_work()
156 * already grabbed the mutex for us, but there is a chance it
157 * failed.
158 */
159 io_tw_lock(ctx, locked);
160 hash_del(&req->hash_node);
b21a51e2 161 req->flags &= ~REQ_F_HASH_LOCKED;
9ca9fb24
PB
162 } else {
163 io_poll_req_delete(req, ctx);
164 }
165}
166
329061d3
JA
167static void io_init_poll_iocb(struct io_poll *poll, __poll_t events,
168 wait_queue_func_t wake_func)
169{
170 poll->head = NULL;
171#define IO_POLL_UNMASK (EPOLLERR|EPOLLHUP|EPOLLNVAL|EPOLLRDHUP)
172 /* mask in events that we always want/need */
173 poll->events = events | IO_POLL_UNMASK;
174 INIT_LIST_HEAD(&poll->wait.entry);
175 init_waitqueue_func_entry(&poll->wait, wake_func);
176}
177
178static inline void io_poll_remove_entry(struct io_poll *poll)
179{
180 struct wait_queue_head *head = smp_load_acquire(&poll->head);
181
182 if (head) {
183 spin_lock_irq(&head->lock);
184 list_del_init(&poll->wait.entry);
185 poll->head = NULL;
186 spin_unlock_irq(&head->lock);
187 }
188}
189
190static void io_poll_remove_entries(struct io_kiocb *req)
191{
192 /*
193 * Nothing to do if neither of those flags are set. Avoid dipping
194 * into the poll/apoll/double cachelines if we can.
195 */
196 if (!(req->flags & (REQ_F_SINGLE_POLL | REQ_F_DOUBLE_POLL)))
197 return;
198
199 /*
200 * While we hold the waitqueue lock and the waitqueue is nonempty,
201 * wake_up_pollfree() will wait for us. However, taking the waitqueue
202 * lock in the first place can race with the waitqueue being freed.
203 *
204 * We solve this as eventpoll does: by taking advantage of the fact that
205 * all users of wake_up_pollfree() will RCU-delay the actual free. If
206 * we enter rcu_read_lock() and see that the pointer to the queue is
207 * non-NULL, we can then lock it without the memory being freed out from
208 * under us.
209 *
210 * Keep holding rcu_read_lock() as long as we hold the queue lock, in
211 * case the caller deletes the entry from the queue, leaving it empty.
212 * In that case, only RCU prevents the queue memory from being freed.
213 */
214 rcu_read_lock();
215 if (req->flags & REQ_F_SINGLE_POLL)
216 io_poll_remove_entry(io_poll_get_single(req));
217 if (req->flags & REQ_F_DOUBLE_POLL)
218 io_poll_remove_entry(io_poll_get_double(req));
219 rcu_read_unlock();
220}
221
2ba69707
DY
222enum {
223 IOU_POLL_DONE = 0,
224 IOU_POLL_NO_ACTION = 1,
114eccdf 225 IOU_POLL_REMOVE_POLL_USE_RES = 2,
2ba69707
DY
226};
227
329061d3
JA
228/*
229 * All poll tw should go through this. Checks for poll events, manages
230 * references, does rewait, etc.
231 *
2ba69707
DY
232 * Returns a negative error on failure. IOU_POLL_NO_ACTION when no action require,
233 * which is either spurious wakeup or multishot CQE is served.
234 * IOU_POLL_DONE when it's done with the request, then the mask is stored in req->cqe.res.
114eccdf
DY
235 * IOU_POLL_REMOVE_POLL_USE_RES indicates to remove multishot poll and that the result
236 * is stored in req->cqe.
329061d3
JA
237 */
238static int io_poll_check_events(struct io_kiocb *req, bool *locked)
239{
240 struct io_ring_ctx *ctx = req->ctx;
241 int v, ret;
242
243 /* req->task == current here, checking PF_EXITING is safe */
244 if (unlikely(req->task->flags & PF_EXITING))
245 return -ECANCELED;
246
247 do {
248 v = atomic_read(&req->poll_refs);
249
250 /* tw handler should be the owner, and so have some references */
251 if (WARN_ON_ONCE(!(v & IO_POLL_REF_MASK)))
2ba69707 252 return IOU_POLL_DONE;
329061d3
JA
253 if (v & IO_POLL_CANCEL_FLAG)
254 return -ECANCELED;
539bcb57
PB
255 /*
256 * cqe.res contains only events of the first wake up
257 * and all others are be lost. Redo vfs_poll() to get
258 * up to date state.
259 */
260 if ((v & IO_POLL_REF_MASK) != 1)
261 req->cqe.res = 0;
a26a35e9
PB
262 if (v & IO_POLL_RETRY_FLAG) {
263 req->cqe.res = 0;
264 /*
265 * We won't find new events that came in between
266 * vfs_poll and the ref put unless we clear the flag
267 * in advance.
268 */
269 atomic_andnot(IO_POLL_RETRY_FLAG, &req->poll_refs);
270 v &= ~IO_POLL_RETRY_FLAG;
271 }
329061d3 272
2ba69707 273 /* the mask was stashed in __io_poll_execute */
329061d3
JA
274 if (!req->cqe.res) {
275 struct poll_table_struct pt = { ._key = req->apoll_events };
276 req->cqe.res = vfs_poll(req->file, &pt) & req->apoll_events;
277 }
278
279 if ((unlikely(!req->cqe.res)))
280 continue;
281 if (req->apoll_events & EPOLLONESHOT)
2ba69707 282 return IOU_POLL_DONE;
7fdbc5f0
PB
283 if (io_is_uring_fops(req->file))
284 return IOU_POLL_DONE;
329061d3
JA
285
286 /* multishot, just fill a CQE and proceed */
287 if (!(req->flags & REQ_F_APOLL_MULTISHOT)) {
288 __poll_t mask = mangle_poll(req->cqe.res &
289 req->apoll_events);
329061d3 290
d245bca6 291 if (!io_post_aux_cqe(ctx, req->cqe.user_data,
a2da6763
DY
292 mask, IORING_CQE_F_MORE, false)) {
293 io_req_set_res(req, mask, 0);
294 return IOU_POLL_REMOVE_POLL_USE_RES;
295 }
d245bca6
PB
296 } else {
297 ret = io_poll_issue(req, locked);
114eccdf
DY
298 if (ret == IOU_STOP_MULTISHOT)
299 return IOU_POLL_REMOVE_POLL_USE_RES;
2ba69707 300 if (ret < 0)
d245bca6
PB
301 return ret;
302 }
329061d3 303
b98186ae
PB
304 /* force the next iteration to vfs_poll() */
305 req->cqe.res = 0;
306
329061d3
JA
307 /*
308 * Release all references, retry if someone tried to restart
309 * task_work while we were executing it.
310 */
311 } while (atomic_sub_return(v & IO_POLL_REF_MASK, &req->poll_refs));
312
2ba69707 313 return IOU_POLL_NO_ACTION;
329061d3
JA
314}
315
316static void io_poll_task_func(struct io_kiocb *req, bool *locked)
317{
329061d3
JA
318 int ret;
319
320 ret = io_poll_check_events(req, locked);
2ba69707 321 if (ret == IOU_POLL_NO_ACTION)
329061d3
JA
322 return;
323
2ba69707 324 if (ret == IOU_POLL_DONE) {
f2ccb5ae 325 struct io_poll *poll = io_kiocb_to_cmd(req, struct io_poll);
329061d3 326 req->cqe.res = mangle_poll(req->cqe.res & poll->events);
114eccdf 327 } else if (ret != IOU_POLL_REMOVE_POLL_USE_RES) {
329061d3
JA
328 req->cqe.res = ret;
329 req_set_fail(req);
330 }
331
332 io_poll_remove_entries(req);
9ca9fb24
PB
333 io_poll_tw_hash_eject(req, locked);
334
0ec6dca2
PB
335 io_req_set_res(req, req->cqe.res, 0);
336 io_req_task_complete(req, locked);
329061d3
JA
337}
338
339static void io_apoll_task_func(struct io_kiocb *req, bool *locked)
340{
329061d3
JA
341 int ret;
342
343 ret = io_poll_check_events(req, locked);
2ba69707 344 if (ret == IOU_POLL_NO_ACTION)
329061d3
JA
345 return;
346
347 io_poll_remove_entries(req);
9ca9fb24 348 io_poll_tw_hash_eject(req, locked);
329061d3 349
114eccdf
DY
350 if (ret == IOU_POLL_REMOVE_POLL_USE_RES)
351 io_req_complete_post(req);
352 else if (ret == IOU_POLL_DONE)
329061d3
JA
353 io_req_task_submit(req, locked);
354 else
355 io_req_complete_failed(req, ret);
356}
357
13a99017 358static void __io_poll_execute(struct io_kiocb *req, int mask)
329061d3
JA
359{
360 io_req_set_res(req, mask, 0);
361 /*
362 * This is useful for poll that is armed on behalf of another
363 * request, and where the wakeup path could be on a different
364 * CPU. We want to avoid pulling in req->apoll->events for that
365 * case.
366 */
367 if (req->opcode == IORING_OP_POLL_ADD)
368 req->io_task_work.func = io_poll_task_func;
369 else
370 req->io_task_work.func = io_apoll_task_func;
371
48863ffd 372 trace_io_uring_task_add(req, mask);
329061d3
JA
373 io_req_task_work_add(req);
374}
375
13a99017 376static inline void io_poll_execute(struct io_kiocb *req, int res)
329061d3
JA
377{
378 if (io_poll_get_ownership(req))
13a99017 379 __io_poll_execute(req, res);
329061d3
JA
380}
381
382static void io_poll_cancel_req(struct io_kiocb *req)
383{
384 io_poll_mark_cancelled(req);
385 /* kick tw, which should complete the request */
13a99017 386 io_poll_execute(req, 0);
329061d3
JA
387}
388
329061d3
JA
389#define IO_ASYNC_POLL_COMMON (EPOLLONESHOT | EPOLLPRI)
390
fe991a76
JA
391static __cold int io_pollfree_wake(struct io_kiocb *req, struct io_poll *poll)
392{
393 io_poll_mark_cancelled(req);
394 /* we have to kick tw in case it's not already */
395 io_poll_execute(req, 0);
396
397 /*
398 * If the waitqueue is being freed early but someone is already
399 * holds ownership over it, we have to tear down the request as
400 * best we can. That means immediately removing the request from
401 * its waitqueue and preventing all further accesses to the
402 * waitqueue via the request.
403 */
404 list_del_init(&poll->wait.entry);
405
406 /*
407 * Careful: this *must* be the last step, since as soon
408 * as req->head is NULL'ed out, the request can be
409 * completed and freed, since aio_poll_complete_work()
410 * will no longer need to take the waitqueue lock.
411 */
412 smp_store_release(&poll->head, NULL);
413 return 1;
414}
415
329061d3
JA
416static int io_poll_wake(struct wait_queue_entry *wait, unsigned mode, int sync,
417 void *key)
418{
419 struct io_kiocb *req = wqe_to_req(wait);
420 struct io_poll *poll = container_of(wait, struct io_poll, wait);
421 __poll_t mask = key_to_poll(key);
422
fe991a76
JA
423 if (unlikely(mask & POLLFREE))
424 return io_pollfree_wake(req, poll);
329061d3
JA
425
426 /* for instances that support it check for an event match first */
427 if (mask && !(mask & (poll->events & ~IO_ASYNC_POLL_COMMON)))
428 return 0;
429
430 if (io_poll_get_ownership(req)) {
431 /* optional, saves extra locking for removal in tw handler */
432 if (mask && poll->events & EPOLLONESHOT) {
433 list_del_init(&poll->wait.entry);
434 poll->head = NULL;
435 if (wqe_is_double(wait))
436 req->flags &= ~REQ_F_DOUBLE_POLL;
437 else
438 req->flags &= ~REQ_F_SINGLE_POLL;
439 }
13a99017 440 __io_poll_execute(req, mask);
329061d3
JA
441 }
442 return 1;
443}
444
30a33669
PB
445/* fails only when polling is already completing by the first entry */
446static bool io_poll_double_prepare(struct io_kiocb *req)
49f1c68e
PB
447{
448 struct wait_queue_head *head;
449 struct io_poll *poll = io_poll_get_single(req);
450
451 /* head is RCU protected, see io_poll_remove_entries() comments */
452 rcu_read_lock();
453 head = smp_load_acquire(&poll->head);
7a121ced 454 /*
30a33669
PB
455 * poll arm might not hold ownership and so race for req->flags with
456 * io_poll_wake(). There is only one poll entry queued, serialise with
457 * it by taking its head lock. As we're still arming the tw hanlder
458 * is not going to be run, so there are no races with it.
7a121ced 459 */
30a33669 460 if (head) {
49f1c68e 461 spin_lock_irq(&head->lock);
30a33669
PB
462 req->flags |= REQ_F_DOUBLE_POLL;
463 if (req->opcode == IORING_OP_POLL_ADD)
464 req->flags |= REQ_F_ASYNC_DATA;
49f1c68e 465 spin_unlock_irq(&head->lock);
30a33669 466 }
49f1c68e 467 rcu_read_unlock();
30a33669 468 return !!head;
49f1c68e
PB
469}
470
329061d3
JA
471static void __io_queue_proc(struct io_poll *poll, struct io_poll_table *pt,
472 struct wait_queue_head *head,
473 struct io_poll **poll_ptr)
474{
475 struct io_kiocb *req = pt->req;
476 unsigned long wqe_private = (unsigned long) req;
477
478 /*
479 * The file being polled uses multiple waitqueues for poll handling
480 * (e.g. one for read, one for write). Setup a separate io_poll
481 * if this happens.
482 */
483 if (unlikely(pt->nr_entries)) {
484 struct io_poll *first = poll;
485
486 /* double add on the same waitqueue head, ignore */
487 if (first->head == head)
488 return;
489 /* already have a 2nd entry, fail a third attempt */
490 if (*poll_ptr) {
491 if ((*poll_ptr)->head == head)
492 return;
493 pt->error = -EINVAL;
494 return;
495 }
496
497 poll = kmalloc(sizeof(*poll), GFP_ATOMIC);
498 if (!poll) {
499 pt->error = -ENOMEM;
500 return;
501 }
49f1c68e 502
329061d3 503 /* mark as double wq entry */
0638cd7b 504 wqe_private |= IO_WQE_F_DOUBLE;
329061d3 505 io_init_poll_iocb(poll, first->events, first->wait.func);
30a33669
PB
506 if (!io_poll_double_prepare(req)) {
507 /* the request is completing, just back off */
508 kfree(poll);
509 return;
510 }
329061d3 511 *poll_ptr = poll;
49f1c68e
PB
512 } else {
513 /* fine to modify, there is no poll queued to race with us */
514 req->flags |= REQ_F_SINGLE_POLL;
329061d3
JA
515 }
516
329061d3
JA
517 pt->nr_entries++;
518 poll->head = head;
519 poll->wait.private = (void *) wqe_private;
520
521 if (poll->events & EPOLLEXCLUSIVE)
522 add_wait_queue_exclusive(head, &poll->wait);
523 else
524 add_wait_queue(head, &poll->wait);
525}
526
527static void io_poll_queue_proc(struct file *file, struct wait_queue_head *head,
528 struct poll_table_struct *p)
529{
530 struct io_poll_table *pt = container_of(p, struct io_poll_table, pt);
f2ccb5ae 531 struct io_poll *poll = io_kiocb_to_cmd(pt->req, struct io_poll);
329061d3
JA
532
533 __io_queue_proc(poll, pt, head,
534 (struct io_poll **) &pt->req->async_data);
535}
536
49f1c68e
PB
537static bool io_poll_can_finish_inline(struct io_kiocb *req,
538 struct io_poll_table *pt)
539{
540 return pt->owning || io_poll_get_ownership(req);
541}
542
de08356f
PB
543/*
544 * Returns 0 when it's handed over for polling. The caller owns the requests if
545 * it returns non-zero, but otherwise should not touch it. Negative values
546 * contain an error code. When the result is >0, the polling has completed
547 * inline and ipt.result_mask is set to the mask.
548 */
329061d3
JA
549static int __io_arm_poll_handler(struct io_kiocb *req,
550 struct io_poll *poll,
49f1c68e
PB
551 struct io_poll_table *ipt, __poll_t mask,
552 unsigned issue_flags)
329061d3
JA
553{
554 struct io_ring_ctx *ctx = req->ctx;
329061d3
JA
555
556 INIT_HLIST_NODE(&req->hash_node);
557 req->work.cancel_seq = atomic_read(&ctx->cancel_seq);
558 io_init_poll_iocb(poll, mask, io_poll_wake);
559 poll->file = req->file;
329061d3
JA
560 req->apoll_events = poll->events;
561
562 ipt->pt._key = mask;
563 ipt->req = req;
564 ipt->error = 0;
565 ipt->nr_entries = 0;
329061d3 566 /*
49f1c68e
PB
567 * Polling is either completed here or via task_work, so if we're in the
568 * task context we're naturally serialised with tw by merit of running
569 * the same task. When it's io-wq, take the ownership to prevent tw
570 * from running. However, when we're in the task context, skip taking
571 * it as an optimisation.
572 *
573 * Note: even though the request won't be completed/freed, without
574 * ownership we still can race with io_poll_wake().
575 * io_poll_can_finish_inline() tries to deal with that.
329061d3 576 */
49f1c68e 577 ipt->owning = issue_flags & IO_URING_F_UNLOCKED;
49f1c68e 578 atomic_set(&req->poll_refs, (int)ipt->owning);
e8375e43
PB
579
580 /* io-wq doesn't hold uring_lock */
581 if (issue_flags & IO_URING_F_UNLOCKED)
582 req->flags &= ~REQ_F_HASH_LOCKED;
583
329061d3
JA
584 mask = vfs_poll(req->file, &ipt->pt) & poll->events;
585
de08356f
PB
586 if (unlikely(ipt->error || !ipt->nr_entries)) {
587 io_poll_remove_entries(req);
588
49f1c68e
PB
589 if (!io_poll_can_finish_inline(req, ipt)) {
590 io_poll_mark_cancelled(req);
591 return 0;
592 } else if (mask && (poll->events & EPOLLET)) {
de08356f
PB
593 ipt->result_mask = mask;
594 return 1;
de08356f 595 }
49f1c68e 596 return ipt->error ?: -EINVAL;
de08356f
PB
597 }
598
b9ba8a44
JA
599 if (mask &&
600 ((poll->events & (EPOLLET|EPOLLONESHOT)) == (EPOLLET|EPOLLONESHOT))) {
49f1c68e
PB
601 if (!io_poll_can_finish_inline(req, ipt))
602 return 0;
329061d3 603 io_poll_remove_entries(req);
063a0079 604 ipt->result_mask = mask;
329061d3 605 /* no one else has access to the req, forget about the ref */
063a0079 606 return 1;
329061d3 607 }
b9ba8a44 608
9ca9fb24
PB
609 if (req->flags & REQ_F_HASH_LOCKED)
610 io_poll_req_insert_locked(req);
611 else
612 io_poll_req_insert(req);
329061d3 613
49f1c68e
PB
614 if (mask && (poll->events & EPOLLET) &&
615 io_poll_can_finish_inline(req, ipt)) {
13a99017 616 __io_poll_execute(req, mask);
329061d3
JA
617 return 0;
618 }
619
49f1c68e
PB
620 if (ipt->owning) {
621 /*
2f389343
PB
622 * Try to release ownership. If we see a change of state, e.g.
623 * poll was waken up, queue up a tw, it'll deal with it.
49f1c68e 624 */
2f389343 625 if (atomic_cmpxchg(&req->poll_refs, 1, 0) != 1)
49f1c68e
PB
626 __io_poll_execute(req, 0);
627 }
329061d3
JA
628 return 0;
629}
630
631static void io_async_queue_proc(struct file *file, struct wait_queue_head *head,
632 struct poll_table_struct *p)
633{
634 struct io_poll_table *pt = container_of(p, struct io_poll_table, pt);
635 struct async_poll *apoll = pt->req->apoll;
636
637 __io_queue_proc(&apoll->poll, pt, head, &apoll->double_poll);
638}
639
5204aa8c
PB
640static struct async_poll *io_req_alloc_apoll(struct io_kiocb *req,
641 unsigned issue_flags)
642{
643 struct io_ring_ctx *ctx = req->ctx;
9b797a37 644 struct io_cache_entry *entry;
5204aa8c
PB
645 struct async_poll *apoll;
646
647 if (req->flags & REQ_F_POLLED) {
648 apoll = req->apoll;
649 kfree(apoll->double_poll);
650 } else if (!(issue_flags & IO_URING_F_UNLOCKED) &&
9b797a37
JA
651 (entry = io_alloc_cache_get(&ctx->apoll_cache)) != NULL) {
652 apoll = container_of(entry, struct async_poll, cache);
5204aa8c
PB
653 } else {
654 apoll = kmalloc(sizeof(*apoll), GFP_ATOMIC);
655 if (unlikely(!apoll))
656 return NULL;
657 }
658 apoll->double_poll = NULL;
659 req->apoll = apoll;
660 return apoll;
661}
662
329061d3
JA
663int io_arm_poll_handler(struct io_kiocb *req, unsigned issue_flags)
664{
665 const struct io_op_def *def = &io_op_defs[req->opcode];
329061d3
JA
666 struct async_poll *apoll;
667 struct io_poll_table ipt;
b9ba8a44 668 __poll_t mask = POLLPRI | POLLERR | EPOLLET;
329061d3
JA
669 int ret;
670
9ca9fb24
PB
671 /*
672 * apoll requests already grab the mutex to complete in the tw handler,
673 * so removal from the mutex-backed hash is free, use it by default.
674 */
e8375e43 675 req->flags |= REQ_F_HASH_LOCKED;
9ca9fb24 676
329061d3
JA
677 if (!def->pollin && !def->pollout)
678 return IO_APOLL_ABORTED;
679 if (!file_can_poll(req->file))
680 return IO_APOLL_ABORTED;
681 if ((req->flags & (REQ_F_POLLED|REQ_F_PARTIAL_IO)) == REQ_F_POLLED)
682 return IO_APOLL_ABORTED;
683 if (!(req->flags & REQ_F_APOLL_MULTISHOT))
684 mask |= EPOLLONESHOT;
685
686 if (def->pollin) {
687 mask |= EPOLLIN | EPOLLRDNORM;
688
689 /* If reading from MSG_ERRQUEUE using recvmsg, ignore POLLIN */
690 if (req->flags & REQ_F_CLEAR_POLLIN)
691 mask &= ~EPOLLIN;
692 } else {
693 mask |= EPOLLOUT | EPOLLWRNORM;
694 }
695 if (def->poll_exclusive)
696 mask |= EPOLLEXCLUSIVE;
5204aa8c
PB
697
698 apoll = io_req_alloc_apoll(req, issue_flags);
699 if (!apoll)
700 return IO_APOLL_ABORTED;
329061d3
JA
701 req->flags |= REQ_F_POLLED;
702 ipt.pt._qproc = io_async_queue_proc;
703
704 io_kbuf_recycle(req, issue_flags);
705
49f1c68e 706 ret = __io_arm_poll_handler(req, &apoll->poll, &ipt, mask, issue_flags);
de08356f
PB
707 if (ret)
708 return ret > 0 ? IO_APOLL_READY : IO_APOLL_ABORTED;
48863ffd 709 trace_io_uring_poll_arm(req, mask, apoll->poll.events);
329061d3
JA
710 return IO_APOLL_OK;
711}
712
9ca9fb24
PB
713static __cold bool io_poll_remove_all_table(struct task_struct *tsk,
714 struct io_hash_table *table,
715 bool cancel_all)
329061d3 716{
e6f89be6 717 unsigned nr_buckets = 1U << table->hash_bits;
329061d3
JA
718 struct hlist_node *tmp;
719 struct io_kiocb *req;
720 bool found = false;
721 int i;
722
e6f89be6
PB
723 for (i = 0; i < nr_buckets; i++) {
724 struct io_hash_bucket *hb = &table->hbs[i];
329061d3 725
38513c46
HX
726 spin_lock(&hb->lock);
727 hlist_for_each_entry_safe(req, tmp, &hb->list, hash_node) {
329061d3
JA
728 if (io_match_task_safe(req, tsk, cancel_all)) {
729 hlist_del_init(&req->hash_node);
730 io_poll_cancel_req(req);
731 found = true;
732 }
733 }
38513c46 734 spin_unlock(&hb->lock);
329061d3 735 }
329061d3
JA
736 return found;
737}
738
9ca9fb24
PB
739/*
740 * Returns true if we found and killed one or more poll requests
741 */
742__cold bool io_poll_remove_all(struct io_ring_ctx *ctx, struct task_struct *tsk,
743 bool cancel_all)
744 __must_hold(&ctx->uring_lock)
745{
b321823a
PB
746 bool ret;
747
748 ret = io_poll_remove_all_table(tsk, &ctx->cancel_table, cancel_all);
749 ret |= io_poll_remove_all_table(tsk, &ctx->cancel_table_locked, cancel_all);
750 return ret;
9ca9fb24
PB
751}
752
329061d3 753static struct io_kiocb *io_poll_find(struct io_ring_ctx *ctx, bool poll_only,
1ab1edb0 754 struct io_cancel_data *cd,
e6f89be6 755 struct io_hash_table *table,
1ab1edb0 756 struct io_hash_bucket **out_bucket)
329061d3 757{
329061d3 758 struct io_kiocb *req;
e6f89be6
PB
759 u32 index = hash_long(cd->data, table->hash_bits);
760 struct io_hash_bucket *hb = &table->hbs[index];
329061d3 761
1ab1edb0
PB
762 *out_bucket = NULL;
763
38513c46
HX
764 spin_lock(&hb->lock);
765 hlist_for_each_entry(req, &hb->list, hash_node) {
329061d3
JA
766 if (cd->data != req->cqe.user_data)
767 continue;
768 if (poll_only && req->opcode != IORING_OP_POLL_ADD)
769 continue;
770 if (cd->flags & IORING_ASYNC_CANCEL_ALL) {
771 if (cd->seq == req->work.cancel_seq)
772 continue;
773 req->work.cancel_seq = cd->seq;
774 }
1ab1edb0 775 *out_bucket = hb;
329061d3
JA
776 return req;
777 }
38513c46 778 spin_unlock(&hb->lock);
329061d3
JA
779 return NULL;
780}
781
782static struct io_kiocb *io_poll_file_find(struct io_ring_ctx *ctx,
1ab1edb0 783 struct io_cancel_data *cd,
e6f89be6 784 struct io_hash_table *table,
1ab1edb0 785 struct io_hash_bucket **out_bucket)
329061d3 786{
e6f89be6 787 unsigned nr_buckets = 1U << table->hash_bits;
329061d3
JA
788 struct io_kiocb *req;
789 int i;
790
1ab1edb0
PB
791 *out_bucket = NULL;
792
e6f89be6
PB
793 for (i = 0; i < nr_buckets; i++) {
794 struct io_hash_bucket *hb = &table->hbs[i];
329061d3 795
38513c46
HX
796 spin_lock(&hb->lock);
797 hlist_for_each_entry(req, &hb->list, hash_node) {
329061d3
JA
798 if (!(cd->flags & IORING_ASYNC_CANCEL_ANY) &&
799 req->file != cd->file)
800 continue;
801 if (cd->seq == req->work.cancel_seq)
802 continue;
803 req->work.cancel_seq = cd->seq;
1ab1edb0 804 *out_bucket = hb;
329061d3
JA
805 return req;
806 }
38513c46 807 spin_unlock(&hb->lock);
329061d3
JA
808 }
809 return NULL;
810}
811
9ca9fb24 812static int io_poll_disarm(struct io_kiocb *req)
329061d3 813{
9ca9fb24
PB
814 if (!req)
815 return -ENOENT;
329061d3 816 if (!io_poll_get_ownership(req))
9ca9fb24 817 return -EALREADY;
329061d3
JA
818 io_poll_remove_entries(req);
819 hash_del(&req->hash_node);
9ca9fb24 820 return 0;
329061d3
JA
821}
822
a2cdd519 823static int __io_poll_cancel(struct io_ring_ctx *ctx, struct io_cancel_data *cd,
e6f89be6 824 struct io_hash_table *table)
329061d3 825{
1ab1edb0 826 struct io_hash_bucket *bucket;
329061d3
JA
827 struct io_kiocb *req;
828
829 if (cd->flags & (IORING_ASYNC_CANCEL_FD|IORING_ASYNC_CANCEL_ANY))
e6f89be6 830 req = io_poll_file_find(ctx, cd, table, &bucket);
329061d3 831 else
e6f89be6 832 req = io_poll_find(ctx, false, cd, table, &bucket);
1ab1edb0
PB
833
834 if (req)
835 io_poll_cancel_req(req);
836 if (bucket)
837 spin_unlock(&bucket->lock);
838 return req ? 0 : -ENOENT;
329061d3
JA
839}
840
5d7943d9
PB
841int io_poll_cancel(struct io_ring_ctx *ctx, struct io_cancel_data *cd,
842 unsigned issue_flags)
a2cdd519 843{
9ca9fb24
PB
844 int ret;
845
846 ret = __io_poll_cancel(ctx, cd, &ctx->cancel_table);
847 if (ret != -ENOENT)
848 return ret;
849
850 io_ring_submit_lock(ctx, issue_flags);
851 ret = __io_poll_cancel(ctx, cd, &ctx->cancel_table_locked);
852 io_ring_submit_unlock(ctx, issue_flags);
853 return ret;
a2cdd519
PB
854}
855
329061d3
JA
856static __poll_t io_poll_parse_events(const struct io_uring_sqe *sqe,
857 unsigned int flags)
858{
859 u32 events;
860
861 events = READ_ONCE(sqe->poll32_events);
862#ifdef __BIG_ENDIAN
863 events = swahw32(events);
864#endif
865 if (!(flags & IORING_POLL_ADD_MULTI))
866 events |= EPOLLONESHOT;
b9ba8a44
JA
867 if (!(flags & IORING_POLL_ADD_LEVEL))
868 events |= EPOLLET;
869 return demangle_poll(events) |
870 (events & (EPOLLEXCLUSIVE|EPOLLONESHOT|EPOLLET));
329061d3
JA
871}
872
873int io_poll_remove_prep(struct io_kiocb *req, const struct io_uring_sqe *sqe)
874{
f2ccb5ae 875 struct io_poll_update *upd = io_kiocb_to_cmd(req, struct io_poll_update);
329061d3
JA
876 u32 flags;
877
878 if (sqe->buf_index || sqe->splice_fd_in)
879 return -EINVAL;
880 flags = READ_ONCE(sqe->len);
881 if (flags & ~(IORING_POLL_UPDATE_EVENTS | IORING_POLL_UPDATE_USER_DATA |
882 IORING_POLL_ADD_MULTI))
883 return -EINVAL;
884 /* meaningless without update */
885 if (flags == IORING_POLL_ADD_MULTI)
886 return -EINVAL;
887
888 upd->old_user_data = READ_ONCE(sqe->addr);
889 upd->update_events = flags & IORING_POLL_UPDATE_EVENTS;
890 upd->update_user_data = flags & IORING_POLL_UPDATE_USER_DATA;
891
892 upd->new_user_data = READ_ONCE(sqe->off);
893 if (!upd->update_user_data && upd->new_user_data)
894 return -EINVAL;
895 if (upd->update_events)
896 upd->events = io_poll_parse_events(sqe, flags);
897 else if (sqe->poll32_events)
898 return -EINVAL;
899
900 return 0;
901}
902
903int io_poll_add_prep(struct io_kiocb *req, const struct io_uring_sqe *sqe)
904{
f2ccb5ae 905 struct io_poll *poll = io_kiocb_to_cmd(req, struct io_poll);
329061d3
JA
906 u32 flags;
907
908 if (sqe->buf_index || sqe->off || sqe->addr)
909 return -EINVAL;
910 flags = READ_ONCE(sqe->len);
d59bd748 911 if (flags & ~IORING_POLL_ADD_MULTI)
329061d3
JA
912 return -EINVAL;
913 if ((flags & IORING_POLL_ADD_MULTI) && (req->flags & REQ_F_CQE_SKIP))
914 return -EINVAL;
915
329061d3
JA
916 poll->events = io_poll_parse_events(sqe, flags);
917 return 0;
918}
919
920int io_poll_add(struct io_kiocb *req, unsigned int issue_flags)
921{
f2ccb5ae 922 struct io_poll *poll = io_kiocb_to_cmd(req, struct io_poll);
329061d3
JA
923 struct io_poll_table ipt;
924 int ret;
925
926 ipt.pt._qproc = io_poll_queue_proc;
927
9ca9fb24
PB
928 /*
929 * If sqpoll or single issuer, there is no contention for ->uring_lock
930 * and we'll end up holding it in tw handlers anyway.
931 */
e8375e43 932 if (req->ctx->flags & (IORING_SETUP_SQPOLL|IORING_SETUP_SINGLE_ISSUER))
9ca9fb24 933 req->flags |= REQ_F_HASH_LOCKED;
9ca9fb24 934
49f1c68e 935 ret = __io_arm_poll_handler(req, poll, &ipt, poll->events, issue_flags);
de08356f 936 if (ret > 0) {
063a0079 937 io_req_set_res(req, ipt.result_mask, 0);
329061d3
JA
938 return IOU_OK;
939 }
de08356f 940 return ret ?: IOU_ISSUE_SKIP_COMPLETE;
329061d3
JA
941}
942
943int io_poll_remove(struct io_kiocb *req, unsigned int issue_flags)
944{
f2ccb5ae 945 struct io_poll_update *poll_update = io_kiocb_to_cmd(req, struct io_poll_update);
329061d3
JA
946 struct io_cancel_data cd = { .data = poll_update->old_user_data, };
947 struct io_ring_ctx *ctx = req->ctx;
1ab1edb0 948 struct io_hash_bucket *bucket;
329061d3
JA
949 struct io_kiocb *preq;
950 int ret2, ret = 0;
951 bool locked;
952
e6f89be6 953 preq = io_poll_find(ctx, true, &cd, &ctx->cancel_table, &bucket);
9ca9fb24 954 ret2 = io_poll_disarm(preq);
1ab1edb0
PB
955 if (bucket)
956 spin_unlock(&bucket->lock);
9ca9fb24
PB
957 if (!ret2)
958 goto found;
959 if (ret2 != -ENOENT) {
960 ret = ret2;
38513c46
HX
961 goto out;
962 }
9ca9fb24
PB
963
964 io_ring_submit_lock(ctx, issue_flags);
965 preq = io_poll_find(ctx, true, &cd, &ctx->cancel_table_locked, &bucket);
966 ret2 = io_poll_disarm(preq);
967 if (bucket)
968 spin_unlock(&bucket->lock);
969 io_ring_submit_unlock(ctx, issue_flags);
970 if (ret2) {
971 ret = ret2;
329061d3
JA
972 goto out;
973 }
329061d3 974
9ca9fb24 975found:
bce5d70c
PB
976 if (WARN_ON_ONCE(preq->opcode != IORING_OP_POLL_ADD)) {
977 ret = -EFAULT;
978 goto out;
979 }
980
329061d3
JA
981 if (poll_update->update_events || poll_update->update_user_data) {
982 /* only mask one event flags, keep behavior flags */
983 if (poll_update->update_events) {
f2ccb5ae 984 struct io_poll *poll = io_kiocb_to_cmd(preq, struct io_poll);
329061d3
JA
985
986 poll->events &= ~0xffff;
987 poll->events |= poll_update->events & 0xffff;
988 poll->events |= IO_POLL_UNMASK;
989 }
990 if (poll_update->update_user_data)
991 preq->cqe.user_data = poll_update->new_user_data;
992
993 ret2 = io_poll_add(preq, issue_flags);
994 /* successfully updated, don't complete poll request */
995 if (!ret2 || ret2 == -EIOCBQUEUED)
996 goto out;
997 }
998
999 req_set_fail(preq);
1000 io_req_set_res(preq, -ECANCELED, 0);
1001 locked = !(issue_flags & IO_URING_F_UNLOCKED);
1002 io_req_task_complete(preq, &locked);
1003out:
1004 if (ret < 0) {
1005 req_set_fail(req);
1006 return ret;
1007 }
1008 /* complete update request, we're done with it */
1009 io_req_set_res(req, ret, 0);
1010 return IOU_OK;
1011}
9da7471e 1012
9b797a37 1013void io_apoll_cache_free(struct io_cache_entry *entry)
9da7471e 1014{
9b797a37 1015 kfree(container_of(entry, struct async_poll, cache));
9da7471e 1016}