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