xref: /linux/io_uring/poll.c (revision 6dfafbd0299a60bfb5d5e277fdf100037c7ded07)
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 
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 
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 
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  */
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 
101 static void io_poll_mark_cancelled(struct io_kiocb *req)
102 {
103 	atomic_or(IO_POLL_CANCEL_FLAG, &req->poll_refs);
104 }
105 
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 
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 
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 
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 
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 
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 
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 
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  */
223 static int io_poll_check_events(struct io_kiocb *req, io_tw_token_t tw)
224 {
225 	int v;
226 
227 	if (unlikely(tw.cancel))
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 (req->apoll_events & EPOLLONESHOT)
277 			return IOU_POLL_DONE;
278 
279 		/* multishot, just fill a CQE and proceed */
280 		if (!(req->flags & REQ_F_APOLL_MULTISHOT)) {
281 			__poll_t mask = mangle_poll(req->cqe.res &
282 						    req->apoll_events);
283 
284 			if (!io_req_post_cqe(req, mask, IORING_CQE_F_MORE)) {
285 				io_req_set_res(req, mask, 0);
286 				return IOU_POLL_REMOVE_POLL_USE_RES;
287 			}
288 		} else {
289 			int ret = io_poll_issue(req, tw);
290 
291 			if (ret == IOU_COMPLETE)
292 				return IOU_POLL_REMOVE_POLL_USE_RES;
293 			else if (ret == IOU_REQUEUE)
294 				return IOU_POLL_REQUEUE;
295 			if (ret != IOU_RETRY && ret < 0)
296 				return ret;
297 		}
298 
299 		/* force the next iteration to vfs_poll() */
300 		req->cqe.res = 0;
301 
302 		/*
303 		 * Release all references, retry if someone tried to restart
304 		 * task_work while we were executing it.
305 		 */
306 		v &= IO_POLL_REF_MASK;
307 	} while (atomic_sub_return(v, &req->poll_refs) & IO_POLL_REF_MASK);
308 
309 	io_napi_add(req);
310 	return IOU_POLL_NO_ACTION;
311 }
312 
313 void io_poll_task_func(struct io_tw_req tw_req, io_tw_token_t tw)
314 {
315 	struct io_kiocb *req = tw_req.req;
316 	int ret;
317 
318 	ret = io_poll_check_events(req, tw);
319 	if (ret == IOU_POLL_NO_ACTION) {
320 		return;
321 	} else if (ret == IOU_POLL_REQUEUE) {
322 		__io_poll_execute(req, 0);
323 		return;
324 	}
325 	io_poll_remove_entries(req);
326 	/* task_work always has ->uring_lock held */
327 	hash_del(&req->hash_node);
328 
329 	if (req->opcode == IORING_OP_POLL_ADD) {
330 		if (ret == IOU_POLL_DONE) {
331 			struct io_poll *poll;
332 
333 			poll = io_kiocb_to_cmd(req, struct io_poll);
334 			req->cqe.res = mangle_poll(req->cqe.res & poll->events);
335 		} else if (ret == IOU_POLL_REISSUE) {
336 			io_req_task_submit(tw_req, tw);
337 			return;
338 		} else if (ret != IOU_POLL_REMOVE_POLL_USE_RES) {
339 			req->cqe.res = ret;
340 			req_set_fail(req);
341 		}
342 
343 		io_req_set_res(req, req->cqe.res, 0);
344 		io_req_task_complete(tw_req, tw);
345 	} else {
346 		io_tw_lock(req->ctx, tw);
347 
348 		if (ret == IOU_POLL_REMOVE_POLL_USE_RES)
349 			io_req_task_complete(tw_req, tw);
350 		else if (ret == IOU_POLL_DONE || ret == IOU_POLL_REISSUE)
351 			io_req_task_submit(tw_req, tw);
352 		else
353 			io_req_defer_failed(req, ret);
354 	}
355 }
356 
357 static void io_poll_cancel_req(struct io_kiocb *req)
358 {
359 	io_poll_mark_cancelled(req);
360 	/* kick tw, which should complete the request */
361 	io_poll_execute(req, 0);
362 }
363 
364 #define IO_ASYNC_POLL_COMMON	(EPOLLONESHOT | EPOLLPRI)
365 
366 static __cold int io_pollfree_wake(struct io_kiocb *req, struct io_poll *poll)
367 {
368 	io_poll_mark_cancelled(req);
369 	/* we have to kick tw in case it's not already */
370 	io_poll_execute(req, 0);
371 
372 	/*
373 	 * If the waitqueue is being freed early but someone is already
374 	 * holds ownership over it, we have to tear down the request as
375 	 * best we can. That means immediately removing the request from
376 	 * its waitqueue and preventing all further accesses to the
377 	 * waitqueue via the request.
378 	 */
379 	list_del_init(&poll->wait.entry);
380 
381 	/*
382 	 * Careful: this *must* be the last step, since as soon
383 	 * as req->head is NULL'ed out, the request can be
384 	 * completed and freed, since aio_poll_complete_work()
385 	 * will no longer need to take the waitqueue lock.
386 	 */
387 	smp_store_release(&poll->head, NULL);
388 	return 1;
389 }
390 
391 static int io_poll_wake(struct wait_queue_entry *wait, unsigned mode, int sync,
392 			void *key)
393 {
394 	struct io_kiocb *req = wqe_to_req(wait);
395 	struct io_poll *poll = container_of(wait, struct io_poll, wait);
396 	__poll_t mask = key_to_poll(key);
397 
398 	if (unlikely(mask & POLLFREE))
399 		return io_pollfree_wake(req, poll);
400 
401 	/* for instances that support it check for an event match first */
402 	if (mask && !(mask & (poll->events & ~IO_ASYNC_POLL_COMMON)))
403 		return 0;
404 
405 	if (io_poll_get_ownership(req)) {
406 		/*
407 		 * If we trigger a multishot poll off our own wakeup path,
408 		 * disable multishot as there is a circular dependency between
409 		 * CQ posting and triggering the event.
410 		 */
411 		if (mask & EPOLL_URING_WAKE)
412 			poll->events |= EPOLLONESHOT;
413 
414 		/* optional, saves extra locking for removal in tw handler */
415 		if (mask && poll->events & EPOLLONESHOT) {
416 			list_del_init(&poll->wait.entry);
417 			poll->head = NULL;
418 			if (wqe_is_double(wait))
419 				req->flags &= ~REQ_F_DOUBLE_POLL;
420 			else
421 				req->flags &= ~REQ_F_SINGLE_POLL;
422 		}
423 		__io_poll_execute(req, mask);
424 	}
425 	return 1;
426 }
427 
428 /* fails only when polling is already completing by the first entry */
429 static bool io_poll_double_prepare(struct io_kiocb *req)
430 {
431 	struct wait_queue_head *head;
432 	struct io_poll *poll = io_poll_get_single(req);
433 
434 	/* head is RCU protected, see io_poll_remove_entries() comments */
435 	rcu_read_lock();
436 	head = smp_load_acquire(&poll->head);
437 	/*
438 	 * poll arm might not hold ownership and so race for req->flags with
439 	 * io_poll_wake(). There is only one poll entry queued, serialise with
440 	 * it by taking its head lock. As we're still arming the tw hanlder
441 	 * is not going to be run, so there are no races with it.
442 	 */
443 	if (head) {
444 		spin_lock_irq(&head->lock);
445 		req->flags |= REQ_F_DOUBLE_POLL;
446 		if (req->opcode == IORING_OP_POLL_ADD)
447 			req->flags |= REQ_F_ASYNC_DATA;
448 		spin_unlock_irq(&head->lock);
449 	}
450 	rcu_read_unlock();
451 	return !!head;
452 }
453 
454 static void __io_queue_proc(struct io_poll *poll, struct io_poll_table *pt,
455 			    struct wait_queue_head *head,
456 			    struct io_poll **poll_ptr)
457 {
458 	struct io_kiocb *req = pt->req;
459 	unsigned long wqe_private = (unsigned long) req;
460 
461 	/*
462 	 * The file being polled uses multiple waitqueues for poll handling
463 	 * (e.g. one for read, one for write). Setup a separate io_poll
464 	 * if this happens.
465 	 */
466 	if (unlikely(pt->nr_entries)) {
467 		struct io_poll *first = poll;
468 
469 		/* double add on the same waitqueue head, ignore */
470 		if (first->head == head)
471 			return;
472 		/* already have a 2nd entry, fail a third attempt */
473 		if (*poll_ptr) {
474 			if ((*poll_ptr)->head == head)
475 				return;
476 			pt->error = -EINVAL;
477 			return;
478 		}
479 
480 		poll = kmalloc(sizeof(*poll), GFP_ATOMIC);
481 		if (!poll) {
482 			pt->error = -ENOMEM;
483 			return;
484 		}
485 
486 		/* mark as double wq entry */
487 		wqe_private |= IO_WQE_F_DOUBLE;
488 		io_init_poll_iocb(poll, first->events);
489 		if (!io_poll_double_prepare(req)) {
490 			/* the request is completing, just back off */
491 			kfree(poll);
492 			return;
493 		}
494 		*poll_ptr = poll;
495 	} else {
496 		/* fine to modify, there is no poll queued to race with us */
497 		req->flags |= REQ_F_SINGLE_POLL;
498 	}
499 
500 	pt->nr_entries++;
501 	poll->head = head;
502 	poll->wait.private = (void *) wqe_private;
503 
504 	if (poll->events & EPOLLEXCLUSIVE) {
505 		add_wait_queue_exclusive(head, &poll->wait);
506 	} else {
507 		add_wait_queue(head, &poll->wait);
508 	}
509 }
510 
511 static void io_poll_queue_proc(struct file *file, struct wait_queue_head *head,
512 			       struct poll_table_struct *p)
513 {
514 	struct io_poll_table *pt = container_of(p, struct io_poll_table, pt);
515 	struct io_poll *poll = io_kiocb_to_cmd(pt->req, struct io_poll);
516 
517 	__io_queue_proc(poll, pt, head,
518 			(struct io_poll **) &pt->req->async_data);
519 }
520 
521 static bool io_poll_can_finish_inline(struct io_kiocb *req,
522 				      struct io_poll_table *pt)
523 {
524 	return pt->owning || io_poll_get_ownership(req);
525 }
526 
527 static void io_poll_add_hash(struct io_kiocb *req, unsigned int issue_flags)
528 {
529 	struct io_ring_ctx *ctx = req->ctx;
530 
531 	io_ring_submit_lock(ctx, issue_flags);
532 	io_poll_req_insert(req);
533 	io_ring_submit_unlock(ctx, issue_flags);
534 }
535 
536 /*
537  * Returns 0 when it's handed over for polling. The caller owns the requests if
538  * it returns non-zero, but otherwise should not touch it. Negative values
539  * contain an error code. When the result is >0, the polling has completed
540  * inline and ipt.result_mask is set to the mask.
541  */
542 static int __io_arm_poll_handler(struct io_kiocb *req,
543 				 struct io_poll *poll,
544 				 struct io_poll_table *ipt, __poll_t mask,
545 				 unsigned issue_flags)
546 {
547 	INIT_HLIST_NODE(&req->hash_node);
548 	io_init_poll_iocb(poll, mask);
549 	poll->file = req->file;
550 	req->apoll_events = poll->events;
551 
552 	ipt->pt._key = mask;
553 	ipt->req = req;
554 	ipt->error = 0;
555 	ipt->nr_entries = 0;
556 	/*
557 	 * Polling is either completed here or via task_work, so if we're in the
558 	 * task context we're naturally serialised with tw by merit of running
559 	 * the same task. When it's io-wq, take the ownership to prevent tw
560 	 * from running. However, when we're in the task context, skip taking
561 	 * it as an optimisation.
562 	 *
563 	 * Note: even though the request won't be completed/freed, without
564 	 * ownership we still can race with io_poll_wake().
565 	 * io_poll_can_finish_inline() tries to deal with that.
566 	 */
567 	ipt->owning = issue_flags & IO_URING_F_UNLOCKED;
568 	atomic_set(&req->poll_refs, (int)ipt->owning);
569 
570 	/*
571 	 * Exclusive waits may only wake a limited amount of entries
572 	 * rather than all of them, this may interfere with lazy
573 	 * wake if someone does wait(events > 1). Ensure we don't do
574 	 * lazy wake for those, as we need to process each one as they
575 	 * come in.
576 	 */
577 	if (poll->events & EPOLLEXCLUSIVE)
578 		req->flags |= REQ_F_POLL_NO_LAZY;
579 
580 	mask = vfs_poll(req->file, &ipt->pt) & poll->events;
581 
582 	if (unlikely(ipt->error || !ipt->nr_entries)) {
583 		io_poll_remove_entries(req);
584 
585 		if (!io_poll_can_finish_inline(req, ipt)) {
586 			io_poll_mark_cancelled(req);
587 			return 0;
588 		} else if (mask && (poll->events & EPOLLET)) {
589 			ipt->result_mask = mask;
590 			return 1;
591 		}
592 		return ipt->error ?: -EINVAL;
593 	}
594 
595 	if (mask &&
596 	   ((poll->events & (EPOLLET|EPOLLONESHOT)) == (EPOLLET|EPOLLONESHOT))) {
597 		if (!io_poll_can_finish_inline(req, ipt)) {
598 			io_poll_add_hash(req, issue_flags);
599 			return 0;
600 		}
601 		io_poll_remove_entries(req);
602 		ipt->result_mask = mask;
603 		/* no one else has access to the req, forget about the ref */
604 		return 1;
605 	}
606 
607 	io_poll_add_hash(req, issue_flags);
608 
609 	if (mask && (poll->events & EPOLLET) &&
610 	    io_poll_can_finish_inline(req, ipt)) {
611 		__io_poll_execute(req, mask);
612 		return 0;
613 	}
614 	io_napi_add(req);
615 
616 	if (ipt->owning) {
617 		/*
618 		 * Try to release ownership. If we see a change of state, e.g.
619 		 * poll was waken up, queue up a tw, it'll deal with it.
620 		 */
621 		if (atomic_cmpxchg(&req->poll_refs, 1, 0) != 1)
622 			__io_poll_execute(req, 0);
623 	}
624 	return 0;
625 }
626 
627 static void io_async_queue_proc(struct file *file, struct wait_queue_head *head,
628 			       struct poll_table_struct *p)
629 {
630 	struct io_poll_table *pt = container_of(p, struct io_poll_table, pt);
631 	struct async_poll *apoll = pt->req->apoll;
632 
633 	__io_queue_proc(&apoll->poll, pt, head, &apoll->double_poll);
634 }
635 
636 /*
637  * We can't reliably detect loops in repeated poll triggers and issue
638  * subsequently failing. But rather than fail these immediately, allow a
639  * certain amount of retries before we give up. Given that this condition
640  * should _rarely_ trigger even once, we should be fine with a larger value.
641  */
642 #define APOLL_MAX_RETRY		128
643 
644 static struct async_poll *io_req_alloc_apoll(struct io_kiocb *req,
645 					     unsigned issue_flags)
646 {
647 	struct io_ring_ctx *ctx = req->ctx;
648 	struct async_poll *apoll;
649 
650 	if (req->flags & REQ_F_POLLED) {
651 		apoll = req->apoll;
652 		kfree(apoll->double_poll);
653 	} else {
654 		if (!(issue_flags & IO_URING_F_UNLOCKED))
655 			apoll = io_cache_alloc(&ctx->apoll_cache, GFP_ATOMIC);
656 		else
657 			apoll = kmalloc(sizeof(*apoll), GFP_ATOMIC);
658 		if (!apoll)
659 			return NULL;
660 		apoll->poll.retries = APOLL_MAX_RETRY;
661 	}
662 	apoll->double_poll = NULL;
663 	req->apoll = apoll;
664 	if (unlikely(!--apoll->poll.retries))
665 		return NULL;
666 	return apoll;
667 }
668 
669 int io_arm_apoll(struct io_kiocb *req, unsigned issue_flags, __poll_t mask)
670 {
671 	struct async_poll *apoll;
672 	struct io_poll_table ipt;
673 	int ret;
674 
675 	mask |= EPOLLET;
676 	if (!io_file_can_poll(req))
677 		return IO_APOLL_ABORTED;
678 	if (!(req->flags & REQ_F_APOLL_MULTISHOT))
679 		mask |= EPOLLONESHOT;
680 
681 	apoll = io_req_alloc_apoll(req, issue_flags);
682 	if (!apoll)
683 		return IO_APOLL_ABORTED;
684 	req->flags &= ~(REQ_F_SINGLE_POLL | REQ_F_DOUBLE_POLL);
685 	req->flags |= REQ_F_POLLED;
686 	ipt.pt._qproc = io_async_queue_proc;
687 
688 	ret = __io_arm_poll_handler(req, &apoll->poll, &ipt, mask, issue_flags);
689 	if (ret)
690 		return ret > 0 ? IO_APOLL_READY : IO_APOLL_ABORTED;
691 	trace_io_uring_poll_arm(req, mask, apoll->poll.events);
692 	return IO_APOLL_OK;
693 }
694 
695 int io_arm_poll_handler(struct io_kiocb *req, unsigned issue_flags)
696 {
697 	const struct io_issue_def *def = &io_issue_defs[req->opcode];
698 	__poll_t mask = POLLPRI | POLLERR;
699 
700 	if (!def->pollin && !def->pollout)
701 		return IO_APOLL_ABORTED;
702 	if (!io_file_can_poll(req))
703 		return IO_APOLL_ABORTED;
704 
705 	if (def->pollin) {
706 		mask |= EPOLLIN | EPOLLRDNORM;
707 
708 		/* If reading from MSG_ERRQUEUE using recvmsg, ignore POLLIN */
709 		if (req->flags & REQ_F_CLEAR_POLLIN)
710 			mask &= ~EPOLLIN;
711 	} else {
712 		mask |= EPOLLOUT | EPOLLWRNORM;
713 	}
714 	if (def->poll_exclusive)
715 		mask |= EPOLLEXCLUSIVE;
716 
717 	return io_arm_apoll(req, issue_flags, mask);
718 }
719 
720 /*
721  * Returns true if we found and killed one or more poll requests
722  */
723 __cold bool io_poll_remove_all(struct io_ring_ctx *ctx, struct io_uring_task *tctx,
724 			       bool cancel_all)
725 {
726 	unsigned nr_buckets = 1U << ctx->cancel_table.hash_bits;
727 	struct hlist_node *tmp;
728 	struct io_kiocb *req;
729 	bool found = false;
730 	int i;
731 
732 	lockdep_assert_held(&ctx->uring_lock);
733 
734 	for (i = 0; i < nr_buckets; i++) {
735 		struct io_hash_bucket *hb = &ctx->cancel_table.hbs[i];
736 
737 		hlist_for_each_entry_safe(req, tmp, &hb->list, hash_node) {
738 			if (io_match_task_safe(req, tctx, cancel_all)) {
739 				hlist_del_init(&req->hash_node);
740 				io_poll_cancel_req(req);
741 				found = true;
742 			}
743 		}
744 	}
745 	return found;
746 }
747 
748 static struct io_kiocb *io_poll_find(struct io_ring_ctx *ctx, bool poll_only,
749 				     struct io_cancel_data *cd)
750 {
751 	struct io_kiocb *req;
752 	u32 index = hash_long(cd->data, ctx->cancel_table.hash_bits);
753 	struct io_hash_bucket *hb = &ctx->cancel_table.hbs[index];
754 
755 	hlist_for_each_entry(req, &hb->list, hash_node) {
756 		if (cd->data != req->cqe.user_data)
757 			continue;
758 		if (poll_only && req->opcode != IORING_OP_POLL_ADD)
759 			continue;
760 		if (cd->flags & IORING_ASYNC_CANCEL_ALL) {
761 			if (io_cancel_match_sequence(req, cd->seq))
762 				continue;
763 		}
764 		return req;
765 	}
766 	return NULL;
767 }
768 
769 static struct io_kiocb *io_poll_file_find(struct io_ring_ctx *ctx,
770 					  struct io_cancel_data *cd)
771 {
772 	unsigned nr_buckets = 1U << ctx->cancel_table.hash_bits;
773 	struct io_kiocb *req;
774 	int i;
775 
776 	for (i = 0; i < nr_buckets; i++) {
777 		struct io_hash_bucket *hb = &ctx->cancel_table.hbs[i];
778 
779 		hlist_for_each_entry(req, &hb->list, hash_node) {
780 			if (io_cancel_req_match(req, cd))
781 				return req;
782 		}
783 	}
784 	return NULL;
785 }
786 
787 static int io_poll_disarm(struct io_kiocb *req)
788 {
789 	if (!req)
790 		return -ENOENT;
791 	if (!io_poll_get_ownership(req))
792 		return -EALREADY;
793 	io_poll_remove_entries(req);
794 	hash_del(&req->hash_node);
795 	return 0;
796 }
797 
798 static int __io_poll_cancel(struct io_ring_ctx *ctx, struct io_cancel_data *cd)
799 {
800 	struct io_kiocb *req;
801 
802 	if (cd->flags & (IORING_ASYNC_CANCEL_FD | IORING_ASYNC_CANCEL_OP |
803 			 IORING_ASYNC_CANCEL_ANY))
804 		req = io_poll_file_find(ctx, cd);
805 	else
806 		req = io_poll_find(ctx, false, cd);
807 
808 	if (req) {
809 		io_poll_cancel_req(req);
810 		return 0;
811 	}
812 	return -ENOENT;
813 }
814 
815 int io_poll_cancel(struct io_ring_ctx *ctx, struct io_cancel_data *cd,
816 		   unsigned issue_flags)
817 {
818 	int ret;
819 
820 	io_ring_submit_lock(ctx, issue_flags);
821 	ret = __io_poll_cancel(ctx, cd);
822 	io_ring_submit_unlock(ctx, issue_flags);
823 	return ret;
824 }
825 
826 static __poll_t io_poll_parse_events(const struct io_uring_sqe *sqe,
827 				     unsigned int flags)
828 {
829 	u32 events;
830 
831 	events = READ_ONCE(sqe->poll32_events);
832 #ifdef __BIG_ENDIAN
833 	events = swahw32(events);
834 #endif
835 	if (!(flags & IORING_POLL_ADD_MULTI))
836 		events |= EPOLLONESHOT;
837 	if (!(flags & IORING_POLL_ADD_LEVEL))
838 		events |= EPOLLET;
839 	return demangle_poll(events) |
840 		(events & (EPOLLEXCLUSIVE|EPOLLONESHOT|EPOLLET));
841 }
842 
843 int io_poll_remove_prep(struct io_kiocb *req, const struct io_uring_sqe *sqe)
844 {
845 	struct io_poll_update *upd = io_kiocb_to_cmd(req, struct io_poll_update);
846 	u32 flags;
847 
848 	if (sqe->buf_index || sqe->splice_fd_in)
849 		return -EINVAL;
850 	flags = READ_ONCE(sqe->len);
851 	if (flags & ~(IORING_POLL_UPDATE_EVENTS | IORING_POLL_UPDATE_USER_DATA |
852 		      IORING_POLL_ADD_MULTI))
853 		return -EINVAL;
854 	/* meaningless without update */
855 	if (flags == IORING_POLL_ADD_MULTI)
856 		return -EINVAL;
857 
858 	upd->old_user_data = READ_ONCE(sqe->addr);
859 	upd->update_events = flags & IORING_POLL_UPDATE_EVENTS;
860 	upd->update_user_data = flags & IORING_POLL_UPDATE_USER_DATA;
861 
862 	upd->new_user_data = READ_ONCE(sqe->off);
863 	if (!upd->update_user_data && upd->new_user_data)
864 		return -EINVAL;
865 	if (upd->update_events)
866 		upd->events = io_poll_parse_events(sqe, flags);
867 	else if (sqe->poll32_events)
868 		return -EINVAL;
869 
870 	return 0;
871 }
872 
873 int io_poll_add_prep(struct io_kiocb *req, const struct io_uring_sqe *sqe)
874 {
875 	struct io_poll *poll = io_kiocb_to_cmd(req, struct io_poll);
876 	u32 flags;
877 
878 	if (sqe->buf_index || sqe->off || sqe->addr)
879 		return -EINVAL;
880 	flags = READ_ONCE(sqe->len);
881 	if (flags & ~IORING_POLL_ADD_MULTI)
882 		return -EINVAL;
883 	if ((flags & IORING_POLL_ADD_MULTI) && (req->flags & REQ_F_CQE_SKIP))
884 		return -EINVAL;
885 
886 	poll->events = io_poll_parse_events(sqe, flags);
887 	return 0;
888 }
889 
890 int io_poll_add(struct io_kiocb *req, unsigned int issue_flags)
891 {
892 	struct io_poll *poll = io_kiocb_to_cmd(req, struct io_poll);
893 	struct io_poll_table ipt;
894 	int ret;
895 
896 	ipt.pt._qproc = io_poll_queue_proc;
897 
898 	ret = __io_arm_poll_handler(req, poll, &ipt, poll->events, issue_flags);
899 	if (ret > 0) {
900 		io_req_set_res(req, ipt.result_mask, 0);
901 		return IOU_COMPLETE;
902 	}
903 	return ret ?: IOU_ISSUE_SKIP_COMPLETE;
904 }
905 
906 int io_poll_remove(struct io_kiocb *req, unsigned int issue_flags)
907 {
908 	struct io_poll_update *poll_update = io_kiocb_to_cmd(req, struct io_poll_update);
909 	struct io_ring_ctx *ctx = req->ctx;
910 	struct io_cancel_data cd = { .ctx = ctx, .data = poll_update->old_user_data, };
911 	struct io_kiocb *preq;
912 	int ret2, ret = 0;
913 
914 	io_ring_submit_lock(ctx, issue_flags);
915 	preq = io_poll_find(ctx, true, &cd);
916 	ret2 = io_poll_disarm(preq);
917 	if (ret2) {
918 		ret = ret2;
919 		goto out;
920 	}
921 	if (WARN_ON_ONCE(preq->opcode != IORING_OP_POLL_ADD)) {
922 		ret = -EFAULT;
923 		goto out;
924 	}
925 
926 	if (poll_update->update_events || poll_update->update_user_data) {
927 		/* only mask one event flags, keep behavior flags */
928 		if (poll_update->update_events) {
929 			struct io_poll *poll = io_kiocb_to_cmd(preq, struct io_poll);
930 
931 			poll->events &= ~0xffff;
932 			poll->events |= poll_update->events & 0xffff;
933 			poll->events |= IO_POLL_UNMASK;
934 		}
935 		if (poll_update->update_user_data)
936 			preq->cqe.user_data = poll_update->new_user_data;
937 
938 		ret2 = io_poll_add(preq, issue_flags & ~IO_URING_F_UNLOCKED);
939 		/* successfully updated, don't complete poll request */
940 		if (!ret2 || ret2 == -EIOCBQUEUED)
941 			goto out;
942 	}
943 
944 	req_set_fail(preq);
945 	io_req_set_res(preq, -ECANCELED, 0);
946 	preq->io_task_work.func = io_req_task_complete;
947 	io_req_task_work_add(preq);
948 out:
949 	io_ring_submit_unlock(ctx, issue_flags);
950 	if (ret < 0) {
951 		req_set_fail(req);
952 		return ret;
953 	}
954 	/* complete update request, we're done with it */
955 	io_req_set_res(req, ret, 0);
956 	return IOU_COMPLETE;
957 }
958