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