io_uring/poll.c

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