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