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