1 // SPDX-License-Identifier: GPL-2.0
2 #include <linux/kernel.h>
3 #include <linux/errno.h>
5 #include <linux/file.h>
7 #include <linux/slab.h>
8 #include <linux/poll.h>
9 #include <linux/hashtable.h>
10 #include <linux/io_uring.h>
12 #include <trace/events/io_uring.h>
14 #include <uapi/linux/io_uring.h>
23 struct io_poll_update {
29 bool update_user_data;
32 struct io_poll_table {
33 struct poll_table_struct pt;
38 /* output value, set only if arm poll returns >0 */
42 #define IO_POLL_CANCEL_FLAG BIT(31)
43 #define IO_POLL_RETRY_FLAG BIT(30)
44 #define IO_POLL_REF_MASK GENMASK(29, 0)
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.
50 #define IO_POLL_REF_BIAS 128
52 #define IO_WQE_F_DOUBLE 1
54 static inline struct io_kiocb *wqe_to_req(struct wait_queue_entry *wqe)
56 unsigned long priv = (unsigned long)wqe->private;
58 return (struct io_kiocb *)(priv & ~IO_WQE_F_DOUBLE);
61 static inline bool wqe_is_double(struct wait_queue_entry *wqe)
63 unsigned long priv = (unsigned long)wqe->private;
65 return priv & IO_WQE_F_DOUBLE;
68 static bool io_poll_get_ownership_slowpath(struct io_kiocb *req)
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.
77 v = atomic_fetch_or(IO_POLL_RETRY_FLAG, &req->poll_refs);
78 if (v & IO_POLL_REF_MASK)
80 return !(atomic_fetch_inc(&req->poll_refs) & IO_POLL_REF_MASK);
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.
89 static inline bool io_poll_get_ownership(struct io_kiocb *req)
91 if (unlikely(atomic_read(&req->poll_refs) >= IO_POLL_REF_BIAS))
92 return io_poll_get_ownership_slowpath(req);
93 return !(atomic_fetch_inc(&req->poll_refs) & IO_POLL_REF_MASK);
96 static void io_poll_mark_cancelled(struct io_kiocb *req)
98 atomic_or(IO_POLL_CANCEL_FLAG, &req->poll_refs);
101 static struct io_poll *io_poll_get_double(struct io_kiocb *req)
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;
109 static struct io_poll *io_poll_get_single(struct io_kiocb *req)
111 if (req->opcode == IORING_OP_POLL_ADD)
112 return io_kiocb_to_cmd(req, struct io_poll);
113 return &req->apoll->poll;
116 static void io_poll_req_insert(struct io_kiocb *req)
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];
122 spin_lock(&hb->lock);
123 hlist_add_head(&req->hash_node, &hb->list);
124 spin_unlock(&hb->lock);
127 static void io_poll_req_delete(struct io_kiocb *req, struct io_ring_ctx *ctx)
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;
134 hash_del(&req->hash_node);
138 static void io_poll_req_insert_locked(struct io_kiocb *req)
140 struct io_hash_table *table = &req->ctx->cancel_table_locked;
141 u32 index = hash_long(req->cqe.user_data, table->hash_bits);
143 lockdep_assert_held(&req->ctx->uring_lock);
145 hlist_add_head(&req->hash_node, &table->hbs[index].list);
148 static void io_poll_tw_hash_eject(struct io_kiocb *req, bool *locked)
150 struct io_ring_ctx *ctx = req->ctx;
152 if (req->flags & REQ_F_HASH_LOCKED) {
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
159 io_tw_lock(ctx, locked);
160 hash_del(&req->hash_node);
161 req->flags &= ~REQ_F_HASH_LOCKED;
163 io_poll_req_delete(req, ctx);
167 static void io_init_poll_iocb(struct io_poll *poll, __poll_t events,
168 wait_queue_func_t wake_func)
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);
178 static inline void io_poll_remove_entry(struct io_poll *poll)
180 struct wait_queue_head *head = smp_load_acquire(&poll->head);
183 spin_lock_irq(&head->lock);
184 list_del_init(&poll->wait.entry);
186 spin_unlock_irq(&head->lock);
190 static void io_poll_remove_entries(struct io_kiocb *req)
193 * Nothing to do if neither of those flags are set. Avoid dipping
194 * into the poll/apoll/double cachelines if we can.
196 if (!(req->flags & (REQ_F_SINGLE_POLL | REQ_F_DOUBLE_POLL)))
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.
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
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.
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));
224 IOU_POLL_NO_ACTION = 1,
225 IOU_POLL_REMOVE_POLL_USE_RES = 2,
229 * All poll tw should go through this. Checks for poll events, manages
230 * references, does rewait, etc.
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.
235 * IOU_POLL_REMOVE_POLL_USE_RES indicates to remove multishot poll and that the result
236 * is stored in req->cqe.
238 static int io_poll_check_events(struct io_kiocb *req, bool *locked)
242 /* req->task == current here, checking PF_EXITING is safe */
243 if (unlikely(req->task->flags & PF_EXITING))
247 v = atomic_read(&req->poll_refs);
249 if (unlikely(v != 1)) {
250 /* tw should be the owner and so have some refs */
251 if (WARN_ON_ONCE(!(v & IO_POLL_REF_MASK)))
252 return IOU_POLL_NO_ACTION;
253 if (v & IO_POLL_CANCEL_FLAG)
256 * cqe.res contains only events of the first wake up
257 * and all others are to be lost. Redo vfs_poll() to get
260 if ((v & IO_POLL_REF_MASK) != 1)
263 if (v & IO_POLL_RETRY_FLAG) {
266 * We won't find new events that came in between
267 * vfs_poll and the ref put unless we clear the
270 atomic_andnot(IO_POLL_RETRY_FLAG, &req->poll_refs);
271 v &= ~IO_POLL_RETRY_FLAG;
275 /* the mask was stashed in __io_poll_execute */
277 struct poll_table_struct pt = { ._key = req->apoll_events };
278 req->cqe.res = vfs_poll(req->file, &pt) & req->apoll_events;
281 if ((unlikely(!req->cqe.res)))
283 if (req->apoll_events & EPOLLONESHOT)
284 return IOU_POLL_DONE;
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 &
291 if (!io_aux_cqe(req->ctx, *locked, req->cqe.user_data,
292 mask, IORING_CQE_F_MORE, false)) {
293 io_req_set_res(req, mask, 0);
294 return IOU_POLL_REMOVE_POLL_USE_RES;
297 ret = io_poll_issue(req, locked);
298 if (ret == IOU_STOP_MULTISHOT)
299 return IOU_POLL_REMOVE_POLL_USE_RES;
304 /* force the next iteration to vfs_poll() */
308 * Release all references, retry if someone tried to restart
309 * task_work while we were executing it.
311 } while (atomic_sub_return(v & IO_POLL_REF_MASK, &req->poll_refs) &
314 return IOU_POLL_NO_ACTION;
317 static void io_poll_task_func(struct io_kiocb *req, bool *locked)
321 ret = io_poll_check_events(req, locked);
322 if (ret == IOU_POLL_NO_ACTION)
324 io_poll_remove_entries(req);
325 io_poll_tw_hash_eject(req, locked);
327 if (req->opcode == IORING_OP_POLL_ADD) {
328 if (ret == IOU_POLL_DONE) {
329 struct io_poll *poll;
331 poll = io_kiocb_to_cmd(req, struct io_poll);
332 req->cqe.res = mangle_poll(req->cqe.res & poll->events);
333 } else if (ret != IOU_POLL_REMOVE_POLL_USE_RES) {
338 io_req_set_res(req, req->cqe.res, 0);
339 io_req_task_complete(req, locked);
341 io_tw_lock(req->ctx, locked);
343 if (ret == IOU_POLL_REMOVE_POLL_USE_RES)
344 io_req_task_complete(req, locked);
345 else if (ret == IOU_POLL_DONE)
346 io_req_task_submit(req, locked);
348 io_req_defer_failed(req, ret);
352 static void __io_poll_execute(struct io_kiocb *req, int mask)
354 io_req_set_res(req, mask, 0);
355 req->io_task_work.func = io_poll_task_func;
357 trace_io_uring_task_add(req, mask);
358 io_req_task_work_add(req);
361 static inline void io_poll_execute(struct io_kiocb *req, int res)
363 if (io_poll_get_ownership(req))
364 __io_poll_execute(req, res);
367 static void io_poll_cancel_req(struct io_kiocb *req)
369 io_poll_mark_cancelled(req);
370 /* kick tw, which should complete the request */
371 io_poll_execute(req, 0);
374 #define IO_ASYNC_POLL_COMMON (EPOLLONESHOT | EPOLLPRI)
376 static __cold int io_pollfree_wake(struct io_kiocb *req, struct io_poll *poll)
378 io_poll_mark_cancelled(req);
379 /* we have to kick tw in case it's not already */
380 io_poll_execute(req, 0);
383 * If the waitqueue is being freed early but someone is already
384 * holds ownership over it, we have to tear down the request as
385 * best we can. That means immediately removing the request from
386 * its waitqueue and preventing all further accesses to the
387 * waitqueue via the request.
389 list_del_init(&poll->wait.entry);
392 * Careful: this *must* be the last step, since as soon
393 * as req->head is NULL'ed out, the request can be
394 * completed and freed, since aio_poll_complete_work()
395 * will no longer need to take the waitqueue lock.
397 smp_store_release(&poll->head, NULL);
401 static int io_poll_wake(struct wait_queue_entry *wait, unsigned mode, int sync,
404 struct io_kiocb *req = wqe_to_req(wait);
405 struct io_poll *poll = container_of(wait, struct io_poll, wait);
406 __poll_t mask = key_to_poll(key);
408 if (unlikely(mask & POLLFREE))
409 return io_pollfree_wake(req, poll);
411 /* for instances that support it check for an event match first */
412 if (mask && !(mask & (poll->events & ~IO_ASYNC_POLL_COMMON)))
415 if (io_poll_get_ownership(req)) {
417 * If we trigger a multishot poll off our own wakeup path,
418 * disable multishot as there is a circular dependency between
419 * CQ posting and triggering the event.
421 if (mask & EPOLL_URING_WAKE)
422 poll->events |= EPOLLONESHOT;
424 /* optional, saves extra locking for removal in tw handler */
425 if (mask && poll->events & EPOLLONESHOT) {
426 list_del_init(&poll->wait.entry);
428 if (wqe_is_double(wait))
429 req->flags &= ~REQ_F_DOUBLE_POLL;
431 req->flags &= ~REQ_F_SINGLE_POLL;
433 __io_poll_execute(req, mask);
438 /* fails only when polling is already completing by the first entry */
439 static bool io_poll_double_prepare(struct io_kiocb *req)
441 struct wait_queue_head *head;
442 struct io_poll *poll = io_poll_get_single(req);
444 /* head is RCU protected, see io_poll_remove_entries() comments */
446 head = smp_load_acquire(&poll->head);
448 * poll arm might not hold ownership and so race for req->flags with
449 * io_poll_wake(). There is only one poll entry queued, serialise with
450 * it by taking its head lock. As we're still arming the tw hanlder
451 * is not going to be run, so there are no races with it.
454 spin_lock_irq(&head->lock);
455 req->flags |= REQ_F_DOUBLE_POLL;
456 if (req->opcode == IORING_OP_POLL_ADD)
457 req->flags |= REQ_F_ASYNC_DATA;
458 spin_unlock_irq(&head->lock);
464 static void __io_queue_proc(struct io_poll *poll, struct io_poll_table *pt,
465 struct wait_queue_head *head,
466 struct io_poll **poll_ptr)
468 struct io_kiocb *req = pt->req;
469 unsigned long wqe_private = (unsigned long) req;
472 * The file being polled uses multiple waitqueues for poll handling
473 * (e.g. one for read, one for write). Setup a separate io_poll
476 if (unlikely(pt->nr_entries)) {
477 struct io_poll *first = poll;
479 /* double add on the same waitqueue head, ignore */
480 if (first->head == head)
482 /* already have a 2nd entry, fail a third attempt */
484 if ((*poll_ptr)->head == head)
490 poll = kmalloc(sizeof(*poll), GFP_ATOMIC);
496 /* mark as double wq entry */
497 wqe_private |= IO_WQE_F_DOUBLE;
498 io_init_poll_iocb(poll, first->events, first->wait.func);
499 if (!io_poll_double_prepare(req)) {
500 /* the request is completing, just back off */
506 /* fine to modify, there is no poll queued to race with us */
507 req->flags |= REQ_F_SINGLE_POLL;
512 poll->wait.private = (void *) wqe_private;
514 if (poll->events & EPOLLEXCLUSIVE)
515 add_wait_queue_exclusive(head, &poll->wait);
517 add_wait_queue(head, &poll->wait);
520 static void io_poll_queue_proc(struct file *file, struct wait_queue_head *head,
521 struct poll_table_struct *p)
523 struct io_poll_table *pt = container_of(p, struct io_poll_table, pt);
524 struct io_poll *poll = io_kiocb_to_cmd(pt->req, struct io_poll);
526 __io_queue_proc(poll, pt, head,
527 (struct io_poll **) &pt->req->async_data);
530 static bool io_poll_can_finish_inline(struct io_kiocb *req,
531 struct io_poll_table *pt)
533 return pt->owning || io_poll_get_ownership(req);
536 static void io_poll_add_hash(struct io_kiocb *req)
538 if (req->flags & REQ_F_HASH_LOCKED)
539 io_poll_req_insert_locked(req);
541 io_poll_req_insert(req);
545 * Returns 0 when it's handed over for polling. The caller owns the requests if
546 * it returns non-zero, but otherwise should not touch it. Negative values
547 * contain an error code. When the result is >0, the polling has completed
548 * inline and ipt.result_mask is set to the mask.
550 static int __io_arm_poll_handler(struct io_kiocb *req,
551 struct io_poll *poll,
552 struct io_poll_table *ipt, __poll_t mask,
553 unsigned issue_flags)
555 struct io_ring_ctx *ctx = req->ctx;
557 INIT_HLIST_NODE(&req->hash_node);
558 req->work.cancel_seq = atomic_read(&ctx->cancel_seq);
559 io_init_poll_iocb(poll, mask, io_poll_wake);
560 poll->file = req->file;
561 req->apoll_events = poll->events;
568 * Polling is either completed here or via task_work, so if we're in the
569 * task context we're naturally serialised with tw by merit of running
570 * the same task. When it's io-wq, take the ownership to prevent tw
571 * from running. However, when we're in the task context, skip taking
572 * it as an optimisation.
574 * Note: even though the request won't be completed/freed, without
575 * ownership we still can race with io_poll_wake().
576 * io_poll_can_finish_inline() tries to deal with that.
578 ipt->owning = issue_flags & IO_URING_F_UNLOCKED;
579 atomic_set(&req->poll_refs, (int)ipt->owning);
581 /* io-wq doesn't hold uring_lock */
582 if (issue_flags & IO_URING_F_UNLOCKED)
583 req->flags &= ~REQ_F_HASH_LOCKED;
585 mask = vfs_poll(req->file, &ipt->pt) & poll->events;
587 if (unlikely(ipt->error || !ipt->nr_entries)) {
588 io_poll_remove_entries(req);
590 if (!io_poll_can_finish_inline(req, ipt)) {
591 io_poll_mark_cancelled(req);
593 } else if (mask && (poll->events & EPOLLET)) {
594 ipt->result_mask = mask;
597 return ipt->error ?: -EINVAL;
601 ((poll->events & (EPOLLET|EPOLLONESHOT)) == (EPOLLET|EPOLLONESHOT))) {
602 if (!io_poll_can_finish_inline(req, ipt)) {
603 io_poll_add_hash(req);
606 io_poll_remove_entries(req);
607 ipt->result_mask = mask;
608 /* no one else has access to the req, forget about the ref */
612 io_poll_add_hash(req);
614 if (mask && (poll->events & EPOLLET) &&
615 io_poll_can_finish_inline(req, ipt)) {
616 __io_poll_execute(req, mask);
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.
625 if (atomic_cmpxchg(&req->poll_refs, 1, 0) != 1)
626 __io_poll_execute(req, 0);
631 static void io_async_queue_proc(struct file *file, struct wait_queue_head *head,
632 struct poll_table_struct *p)
634 struct io_poll_table *pt = container_of(p, struct io_poll_table, pt);
635 struct async_poll *apoll = pt->req->apoll;
637 __io_queue_proc(&apoll->poll, pt, head, &apoll->double_poll);
640 static struct async_poll *io_req_alloc_apoll(struct io_kiocb *req,
641 unsigned issue_flags)
643 struct io_ring_ctx *ctx = req->ctx;
644 struct io_cache_entry *entry;
645 struct async_poll *apoll;
647 if (req->flags & REQ_F_POLLED) {
649 kfree(apoll->double_poll);
650 } else if (!(issue_flags & IO_URING_F_UNLOCKED)) {
651 entry = io_alloc_cache_get(&ctx->apoll_cache);
654 apoll = container_of(entry, struct async_poll, cache);
657 apoll = kmalloc(sizeof(*apoll), GFP_ATOMIC);
658 if (unlikely(!apoll))
661 apoll->double_poll = NULL;
666 int io_arm_poll_handler(struct io_kiocb *req, unsigned issue_flags)
668 const struct io_op_def *def = &io_op_defs[req->opcode];
669 struct async_poll *apoll;
670 struct io_poll_table ipt;
671 __poll_t mask = POLLPRI | POLLERR | EPOLLET;
675 * apoll requests already grab the mutex to complete in the tw handler,
676 * so removal from the mutex-backed hash is free, use it by default.
678 req->flags |= REQ_F_HASH_LOCKED;
680 if (!def->pollin && !def->pollout)
681 return IO_APOLL_ABORTED;
682 if (!file_can_poll(req->file))
683 return IO_APOLL_ABORTED;
684 if ((req->flags & (REQ_F_POLLED|REQ_F_PARTIAL_IO)) == REQ_F_POLLED)
685 return IO_APOLL_ABORTED;
686 if (!(req->flags & REQ_F_APOLL_MULTISHOT))
687 mask |= EPOLLONESHOT;
690 mask |= EPOLLIN | EPOLLRDNORM;
692 /* If reading from MSG_ERRQUEUE using recvmsg, ignore POLLIN */
693 if (req->flags & REQ_F_CLEAR_POLLIN)
696 mask |= EPOLLOUT | EPOLLWRNORM;
698 if (def->poll_exclusive)
699 mask |= EPOLLEXCLUSIVE;
701 apoll = io_req_alloc_apoll(req, issue_flags);
703 return IO_APOLL_ABORTED;
704 req->flags |= REQ_F_POLLED;
705 ipt.pt._qproc = io_async_queue_proc;
707 io_kbuf_recycle(req, issue_flags);
709 ret = __io_arm_poll_handler(req, &apoll->poll, &ipt, mask, issue_flags);
711 return ret > 0 ? IO_APOLL_READY : IO_APOLL_ABORTED;
712 trace_io_uring_poll_arm(req, mask, apoll->poll.events);
716 static __cold bool io_poll_remove_all_table(struct task_struct *tsk,
717 struct io_hash_table *table,
720 unsigned nr_buckets = 1U << table->hash_bits;
721 struct hlist_node *tmp;
722 struct io_kiocb *req;
726 for (i = 0; i < nr_buckets; i++) {
727 struct io_hash_bucket *hb = &table->hbs[i];
729 spin_lock(&hb->lock);
730 hlist_for_each_entry_safe(req, tmp, &hb->list, hash_node) {
731 if (io_match_task_safe(req, tsk, cancel_all)) {
732 hlist_del_init(&req->hash_node);
733 io_poll_cancel_req(req);
737 spin_unlock(&hb->lock);
743 * Returns true if we found and killed one or more poll requests
745 __cold bool io_poll_remove_all(struct io_ring_ctx *ctx, struct task_struct *tsk,
747 __must_hold(&ctx->uring_lock)
751 ret = io_poll_remove_all_table(tsk, &ctx->cancel_table, cancel_all);
752 ret |= io_poll_remove_all_table(tsk, &ctx->cancel_table_locked, cancel_all);
756 static struct io_kiocb *io_poll_find(struct io_ring_ctx *ctx, bool poll_only,
757 struct io_cancel_data *cd,
758 struct io_hash_table *table,
759 struct io_hash_bucket **out_bucket)
761 struct io_kiocb *req;
762 u32 index = hash_long(cd->data, table->hash_bits);
763 struct io_hash_bucket *hb = &table->hbs[index];
767 spin_lock(&hb->lock);
768 hlist_for_each_entry(req, &hb->list, hash_node) {
769 if (cd->data != req->cqe.user_data)
771 if (poll_only && req->opcode != IORING_OP_POLL_ADD)
773 if (cd->flags & IORING_ASYNC_CANCEL_ALL) {
774 if (cd->seq == req->work.cancel_seq)
776 req->work.cancel_seq = cd->seq;
781 spin_unlock(&hb->lock);
785 static struct io_kiocb *io_poll_file_find(struct io_ring_ctx *ctx,
786 struct io_cancel_data *cd,
787 struct io_hash_table *table,
788 struct io_hash_bucket **out_bucket)
790 unsigned nr_buckets = 1U << table->hash_bits;
791 struct io_kiocb *req;
796 for (i = 0; i < nr_buckets; i++) {
797 struct io_hash_bucket *hb = &table->hbs[i];
799 spin_lock(&hb->lock);
800 hlist_for_each_entry(req, &hb->list, hash_node) {
801 if (!(cd->flags & IORING_ASYNC_CANCEL_ANY) &&
802 req->file != cd->file)
804 if (cd->seq == req->work.cancel_seq)
806 req->work.cancel_seq = cd->seq;
810 spin_unlock(&hb->lock);
815 static int io_poll_disarm(struct io_kiocb *req)
819 if (!io_poll_get_ownership(req))
821 io_poll_remove_entries(req);
822 hash_del(&req->hash_node);
826 static int __io_poll_cancel(struct io_ring_ctx *ctx, struct io_cancel_data *cd,
827 struct io_hash_table *table)
829 struct io_hash_bucket *bucket;
830 struct io_kiocb *req;
832 if (cd->flags & (IORING_ASYNC_CANCEL_FD|IORING_ASYNC_CANCEL_ANY))
833 req = io_poll_file_find(ctx, cd, table, &bucket);
835 req = io_poll_find(ctx, false, cd, table, &bucket);
838 io_poll_cancel_req(req);
840 spin_unlock(&bucket->lock);
841 return req ? 0 : -ENOENT;
844 int io_poll_cancel(struct io_ring_ctx *ctx, struct io_cancel_data *cd,
845 unsigned issue_flags)
849 ret = __io_poll_cancel(ctx, cd, &ctx->cancel_table);
853 io_ring_submit_lock(ctx, issue_flags);
854 ret = __io_poll_cancel(ctx, cd, &ctx->cancel_table_locked);
855 io_ring_submit_unlock(ctx, issue_flags);
859 static __poll_t io_poll_parse_events(const struct io_uring_sqe *sqe,
864 events = READ_ONCE(sqe->poll32_events);
866 events = swahw32(events);
868 if (!(flags & IORING_POLL_ADD_MULTI))
869 events |= EPOLLONESHOT;
870 if (!(flags & IORING_POLL_ADD_LEVEL))
872 return demangle_poll(events) |
873 (events & (EPOLLEXCLUSIVE|EPOLLONESHOT|EPOLLET));
876 int io_poll_remove_prep(struct io_kiocb *req, const struct io_uring_sqe *sqe)
878 struct io_poll_update *upd = io_kiocb_to_cmd(req, struct io_poll_update);
881 if (sqe->buf_index || sqe->splice_fd_in)
883 flags = READ_ONCE(sqe->len);
884 if (flags & ~(IORING_POLL_UPDATE_EVENTS | IORING_POLL_UPDATE_USER_DATA |
885 IORING_POLL_ADD_MULTI))
887 /* meaningless without update */
888 if (flags == IORING_POLL_ADD_MULTI)
891 upd->old_user_data = READ_ONCE(sqe->addr);
892 upd->update_events = flags & IORING_POLL_UPDATE_EVENTS;
893 upd->update_user_data = flags & IORING_POLL_UPDATE_USER_DATA;
895 upd->new_user_data = READ_ONCE(sqe->off);
896 if (!upd->update_user_data && upd->new_user_data)
898 if (upd->update_events)
899 upd->events = io_poll_parse_events(sqe, flags);
900 else if (sqe->poll32_events)
906 int io_poll_add_prep(struct io_kiocb *req, const struct io_uring_sqe *sqe)
908 struct io_poll *poll = io_kiocb_to_cmd(req, struct io_poll);
911 if (sqe->buf_index || sqe->off || sqe->addr)
913 flags = READ_ONCE(sqe->len);
914 if (flags & ~IORING_POLL_ADD_MULTI)
916 if ((flags & IORING_POLL_ADD_MULTI) && (req->flags & REQ_F_CQE_SKIP))
919 poll->events = io_poll_parse_events(sqe, flags);
923 int io_poll_add(struct io_kiocb *req, unsigned int issue_flags)
925 struct io_poll *poll = io_kiocb_to_cmd(req, struct io_poll);
926 struct io_poll_table ipt;
929 ipt.pt._qproc = io_poll_queue_proc;
932 * If sqpoll or single issuer, there is no contention for ->uring_lock
933 * and we'll end up holding it in tw handlers anyway.
935 if (req->ctx->flags & (IORING_SETUP_SQPOLL|IORING_SETUP_SINGLE_ISSUER))
936 req->flags |= REQ_F_HASH_LOCKED;
938 ret = __io_arm_poll_handler(req, poll, &ipt, poll->events, issue_flags);
940 io_req_set_res(req, ipt.result_mask, 0);
943 return ret ?: IOU_ISSUE_SKIP_COMPLETE;
946 int io_poll_remove(struct io_kiocb *req, unsigned int issue_flags)
948 struct io_poll_update *poll_update = io_kiocb_to_cmd(req, struct io_poll_update);
949 struct io_cancel_data cd = { .data = poll_update->old_user_data, };
950 struct io_ring_ctx *ctx = req->ctx;
951 struct io_hash_bucket *bucket;
952 struct io_kiocb *preq;
956 preq = io_poll_find(ctx, true, &cd, &ctx->cancel_table, &bucket);
957 ret2 = io_poll_disarm(preq);
959 spin_unlock(&bucket->lock);
962 if (ret2 != -ENOENT) {
967 io_ring_submit_lock(ctx, issue_flags);
968 preq = io_poll_find(ctx, true, &cd, &ctx->cancel_table_locked, &bucket);
969 ret2 = io_poll_disarm(preq);
971 spin_unlock(&bucket->lock);
972 io_ring_submit_unlock(ctx, issue_flags);
979 if (WARN_ON_ONCE(preq->opcode != IORING_OP_POLL_ADD)) {
984 if (poll_update->update_events || poll_update->update_user_data) {
985 /* only mask one event flags, keep behavior flags */
986 if (poll_update->update_events) {
987 struct io_poll *poll = io_kiocb_to_cmd(preq, struct io_poll);
989 poll->events &= ~0xffff;
990 poll->events |= poll_update->events & 0xffff;
991 poll->events |= IO_POLL_UNMASK;
993 if (poll_update->update_user_data)
994 preq->cqe.user_data = poll_update->new_user_data;
996 ret2 = io_poll_add(preq, issue_flags);
997 /* successfully updated, don't complete poll request */
998 if (!ret2 || ret2 == -EIOCBQUEUED)
1003 io_req_set_res(preq, -ECANCELED, 0);
1004 locked = !(issue_flags & IO_URING_F_UNLOCKED);
1005 io_req_task_complete(preq, &locked);
1011 /* complete update request, we're done with it */
1012 io_req_set_res(req, ret, 0);
1016 void io_apoll_cache_free(struct io_cache_entry *entry)
1018 kfree(container_of(entry, struct async_poll, cache));