1 // SPDX-License-Identifier: GPL-2.0-or-later 2 /* 3 * fs/eventpoll.c (Efficient event retrieval implementation) 4 * Copyright (C) 2001,...,2009 Davide Libenzi 5 * 6 * Davide Libenzi <davidel@xmailserver.org> 7 */ 8 9 #include <linux/init.h> 10 #include <linux/kernel.h> 11 #include <linux/sched/signal.h> 12 #include <linux/fs.h> 13 #include <linux/file.h> 14 #include <linux/signal.h> 15 #include <linux/errno.h> 16 #include <linux/mm.h> 17 #include <linux/slab.h> 18 #include <linux/poll.h> 19 #include <linux/string.h> 20 #include <linux/list.h> 21 #include <linux/hash.h> 22 #include <linux/spinlock.h> 23 #include <linux/syscalls.h> 24 #include <linux/rbtree.h> 25 #include <linux/wait.h> 26 #include <linux/eventpoll.h> 27 #include <linux/mount.h> 28 #include <linux/bitops.h> 29 #include <linux/mutex.h> 30 #include <linux/anon_inodes.h> 31 #include <linux/device.h> 32 #include <linux/uaccess.h> 33 #include <asm/io.h> 34 #include <asm/mman.h> 35 #include <linux/atomic.h> 36 #include <linux/proc_fs.h> 37 #include <linux/seq_file.h> 38 #include <linux/compat.h> 39 #include <linux/rculist.h> 40 #include <net/busy_poll.h> 41 42 /* 43 * LOCKING: 44 * There are three level of locking required by epoll : 45 * 46 * 1) epnested_mutex (mutex) 47 * 2) ep->mtx (mutex) 48 * 3) ep->lock (rwlock) 49 * 50 * The acquire order is the one listed above, from 1 to 3. 51 * We need a rwlock (ep->lock) because we manipulate objects 52 * from inside the poll callback, that might be triggered from 53 * a wake_up() that in turn might be called from IRQ context. 54 * So we can't sleep inside the poll callback and hence we need 55 * a spinlock. During the event transfer loop (from kernel to 56 * user space) we could end up sleeping due a copy_to_user(), so 57 * we need a lock that will allow us to sleep. This lock is a 58 * mutex (ep->mtx). It is acquired during the event transfer loop, 59 * during epoll_ctl(EPOLL_CTL_DEL) and during eventpoll_release_file(). 60 * The epnested_mutex is acquired when inserting an epoll fd onto another 61 * epoll fd. We do this so that we walk the epoll tree and ensure that this 62 * insertion does not create a cycle of epoll file descriptors, which 63 * could lead to deadlock. We need a global mutex to prevent two 64 * simultaneous inserts (A into B and B into A) from racing and 65 * constructing a cycle without either insert observing that it is 66 * going to. 67 * It is necessary to acquire multiple "ep->mtx"es at once in the 68 * case when one epoll fd is added to another. In this case, we 69 * always acquire the locks in the order of nesting (i.e. after 70 * epoll_ctl(e1, EPOLL_CTL_ADD, e2), e1->mtx will always be acquired 71 * before e2->mtx). Since we disallow cycles of epoll file 72 * descriptors, this ensures that the mutexes are well-ordered. In 73 * order to communicate this nesting to lockdep, when walking a tree 74 * of epoll file descriptors, we use the current recursion depth as 75 * the lockdep subkey. 76 * It is possible to drop the "ep->mtx" and to use the global 77 * mutex "epnested_mutex" (together with "ep->lock") to have it working, 78 * but having "ep->mtx" will make the interface more scalable. 79 * Events that require holding "epnested_mutex" are very rare, while for 80 * normal operations the epoll private "ep->mtx" will guarantee 81 * a better scalability. 82 */ 83 84 /* Epoll private bits inside the event mask */ 85 #define EP_PRIVATE_BITS (EPOLLWAKEUP | EPOLLONESHOT | EPOLLET | EPOLLEXCLUSIVE) 86 87 #define EPOLLINOUT_BITS (EPOLLIN | EPOLLOUT) 88 89 #define EPOLLEXCLUSIVE_OK_BITS (EPOLLINOUT_BITS | EPOLLERR | EPOLLHUP | \ 90 EPOLLWAKEUP | EPOLLET | EPOLLEXCLUSIVE) 91 92 /* Maximum number of nesting allowed inside epoll sets */ 93 #define EP_MAX_NESTS 4 94 95 #define EP_MAX_EVENTS (INT_MAX / sizeof(struct epoll_event)) 96 97 #define EP_UNACTIVE_PTR ((void *) -1L) 98 99 #define EP_ITEM_COST (sizeof(struct epitem) + sizeof(struct eppoll_entry)) 100 101 struct epoll_filefd { 102 struct file *file; 103 int fd; 104 } __packed; 105 106 /* Wait structure used by the poll hooks */ 107 struct eppoll_entry { 108 /* List header used to link this structure to the "struct epitem" */ 109 struct eppoll_entry *next; 110 111 /* The "base" pointer is set to the container "struct epitem" */ 112 struct epitem *base; 113 114 /* 115 * Wait queue item that will be linked to the target file wait 116 * queue head. 117 */ 118 wait_queue_entry_t wait; 119 120 /* The wait queue head that linked the "wait" wait queue item */ 121 wait_queue_head_t *whead; 122 }; 123 124 /* 125 * Each file descriptor added to the eventpoll interface will 126 * have an entry of this type linked to the "rbr" RB tree. 127 * Avoid increasing the size of this struct, there can be many thousands 128 * of these on a server and we do not want this to take another cache line. 129 */ 130 struct epitem { 131 union { 132 /* RB tree node links this structure to the eventpoll RB tree */ 133 struct rb_node rbn; 134 /* Used to free the struct epitem */ 135 struct rcu_head rcu; 136 }; 137 138 /* List header used to link this structure to the eventpoll ready list */ 139 struct list_head rdllink; 140 141 /* 142 * Works together "struct eventpoll"->ovflist in keeping the 143 * single linked chain of items. 144 */ 145 struct epitem *next; 146 147 /* The file descriptor information this item refers to */ 148 struct epoll_filefd ffd; 149 150 /* 151 * Protected by file->f_lock, true for to-be-released epitem already 152 * removed from the "struct file" items list; together with 153 * eventpoll->refcount orchestrates "struct eventpoll" disposal 154 */ 155 bool dying; 156 157 /* List containing poll wait queues */ 158 struct eppoll_entry *pwqlist; 159 160 /* The "container" of this item */ 161 struct eventpoll *ep; 162 163 /* List header used to link this item to the "struct file" items list */ 164 struct hlist_node fllink; 165 166 /* wakeup_source used when EPOLLWAKEUP is set */ 167 struct wakeup_source __rcu *ws; 168 169 /* The structure that describe the interested events and the source fd */ 170 struct epoll_event event; 171 }; 172 173 /* 174 * This structure is stored inside the "private_data" member of the file 175 * structure and represents the main data structure for the eventpoll 176 * interface. 177 */ 178 struct eventpoll { 179 /* 180 * This mutex is used to ensure that files are not removed 181 * while epoll is using them. This is held during the event 182 * collection loop, the file cleanup path, the epoll file exit 183 * code and the ctl operations. 184 */ 185 struct mutex mtx; 186 187 /* Wait queue used by sys_epoll_wait() */ 188 wait_queue_head_t wq; 189 190 /* Wait queue used by file->poll() */ 191 wait_queue_head_t poll_wait; 192 193 /* List of ready file descriptors */ 194 struct list_head rdllist; 195 196 /* Lock which protects rdllist and ovflist */ 197 rwlock_t lock; 198 199 /* RB tree root used to store monitored fd structs */ 200 struct rb_root_cached rbr; 201 202 /* 203 * This is a single linked list that chains all the "struct epitem" that 204 * happened while transferring ready events to userspace w/out 205 * holding ->lock. 206 */ 207 struct epitem *ovflist; 208 209 /* wakeup_source used when ep_send_events or __ep_eventpoll_poll is running */ 210 struct wakeup_source *ws; 211 212 /* The user that created the eventpoll descriptor */ 213 struct user_struct *user; 214 215 struct file *file; 216 217 /* used to optimize loop detection check */ 218 u64 gen; 219 struct hlist_head refs; 220 221 /* 222 * usage count, used together with epitem->dying to 223 * orchestrate the disposal of this struct 224 */ 225 refcount_t refcount; 226 227 #ifdef CONFIG_NET_RX_BUSY_POLL 228 /* used to track busy poll napi_id */ 229 unsigned int napi_id; 230 #endif 231 232 #ifdef CONFIG_DEBUG_LOCK_ALLOC 233 /* tracks wakeup nests for lockdep validation */ 234 u8 nests; 235 #endif 236 }; 237 238 /* Wrapper struct used by poll queueing */ 239 struct ep_pqueue { 240 poll_table pt; 241 struct epitem *epi; 242 }; 243 244 /* 245 * Configuration options available inside /proc/sys/fs/epoll/ 246 */ 247 /* Maximum number of epoll watched descriptors, per user */ 248 static long max_user_watches __read_mostly; 249 250 /* Used for cycles detection */ 251 static DEFINE_MUTEX(epnested_mutex); 252 253 static u64 loop_check_gen = 0; 254 255 /* Used to check for epoll file descriptor inclusion loops */ 256 static struct eventpoll *inserting_into; 257 258 /* Slab cache used to allocate "struct epitem" */ 259 static struct kmem_cache *epi_cache __ro_after_init; 260 261 /* Slab cache used to allocate "struct eppoll_entry" */ 262 static struct kmem_cache *pwq_cache __ro_after_init; 263 264 /* 265 * List of files with newly added links, where we may need to limit the number 266 * of emanating paths. Protected by the epnested_mutex. 267 */ 268 struct epitems_head { 269 struct hlist_head epitems; 270 struct epitems_head *next; 271 }; 272 static struct epitems_head *tfile_check_list = EP_UNACTIVE_PTR; 273 274 static struct kmem_cache *ephead_cache __ro_after_init; 275 276 static inline void free_ephead(struct epitems_head *head) 277 { 278 if (head) 279 kmem_cache_free(ephead_cache, head); 280 } 281 282 static void list_file(struct file *file) 283 { 284 struct epitems_head *head; 285 286 head = container_of(file->f_ep, struct epitems_head, epitems); 287 if (!head->next) { 288 head->next = tfile_check_list; 289 tfile_check_list = head; 290 } 291 } 292 293 static void unlist_file(struct epitems_head *head) 294 { 295 struct epitems_head *to_free = head; 296 struct hlist_node *p = rcu_dereference(hlist_first_rcu(&head->epitems)); 297 if (p) { 298 struct epitem *epi= container_of(p, struct epitem, fllink); 299 spin_lock(&epi->ffd.file->f_lock); 300 if (!hlist_empty(&head->epitems)) 301 to_free = NULL; 302 head->next = NULL; 303 spin_unlock(&epi->ffd.file->f_lock); 304 } 305 free_ephead(to_free); 306 } 307 308 #ifdef CONFIG_SYSCTL 309 310 #include <linux/sysctl.h> 311 312 static long long_zero; 313 static long long_max = LONG_MAX; 314 315 static struct ctl_table epoll_table[] = { 316 { 317 .procname = "max_user_watches", 318 .data = &max_user_watches, 319 .maxlen = sizeof(max_user_watches), 320 .mode = 0644, 321 .proc_handler = proc_doulongvec_minmax, 322 .extra1 = &long_zero, 323 .extra2 = &long_max, 324 }, 325 }; 326 327 static void __init epoll_sysctls_init(void) 328 { 329 register_sysctl("fs/epoll", epoll_table); 330 } 331 #else 332 #define epoll_sysctls_init() do { } while (0) 333 #endif /* CONFIG_SYSCTL */ 334 335 static const struct file_operations eventpoll_fops; 336 337 static inline int is_file_epoll(struct file *f) 338 { 339 return f->f_op == &eventpoll_fops; 340 } 341 342 /* Setup the structure that is used as key for the RB tree */ 343 static inline void ep_set_ffd(struct epoll_filefd *ffd, 344 struct file *file, int fd) 345 { 346 ffd->file = file; 347 ffd->fd = fd; 348 } 349 350 /* Compare RB tree keys */ 351 static inline int ep_cmp_ffd(struct epoll_filefd *p1, 352 struct epoll_filefd *p2) 353 { 354 return (p1->file > p2->file ? +1: 355 (p1->file < p2->file ? -1 : p1->fd - p2->fd)); 356 } 357 358 /* Tells us if the item is currently linked */ 359 static inline int ep_is_linked(struct epitem *epi) 360 { 361 return !list_empty(&epi->rdllink); 362 } 363 364 static inline struct eppoll_entry *ep_pwq_from_wait(wait_queue_entry_t *p) 365 { 366 return container_of(p, struct eppoll_entry, wait); 367 } 368 369 /* Get the "struct epitem" from a wait queue pointer */ 370 static inline struct epitem *ep_item_from_wait(wait_queue_entry_t *p) 371 { 372 return container_of(p, struct eppoll_entry, wait)->base; 373 } 374 375 /** 376 * ep_events_available - Checks if ready events might be available. 377 * 378 * @ep: Pointer to the eventpoll context. 379 * 380 * Return: a value different than %zero if ready events are available, 381 * or %zero otherwise. 382 */ 383 static inline int ep_events_available(struct eventpoll *ep) 384 { 385 return !list_empty_careful(&ep->rdllist) || 386 READ_ONCE(ep->ovflist) != EP_UNACTIVE_PTR; 387 } 388 389 #ifdef CONFIG_NET_RX_BUSY_POLL 390 static bool ep_busy_loop_end(void *p, unsigned long start_time) 391 { 392 struct eventpoll *ep = p; 393 394 return ep_events_available(ep) || busy_loop_timeout(start_time); 395 } 396 397 /* 398 * Busy poll if globally on and supporting sockets found && no events, 399 * busy loop will return if need_resched or ep_events_available. 400 * 401 * we must do our busy polling with irqs enabled 402 */ 403 static bool ep_busy_loop(struct eventpoll *ep, int nonblock) 404 { 405 unsigned int napi_id = READ_ONCE(ep->napi_id); 406 407 if ((napi_id >= MIN_NAPI_ID) && net_busy_loop_on()) { 408 napi_busy_loop(napi_id, nonblock ? NULL : ep_busy_loop_end, ep, false, 409 BUSY_POLL_BUDGET); 410 if (ep_events_available(ep)) 411 return true; 412 /* 413 * Busy poll timed out. Drop NAPI ID for now, we can add 414 * it back in when we have moved a socket with a valid NAPI 415 * ID onto the ready list. 416 */ 417 ep->napi_id = 0; 418 return false; 419 } 420 return false; 421 } 422 423 /* 424 * Set epoll busy poll NAPI ID from sk. 425 */ 426 static inline void ep_set_busy_poll_napi_id(struct epitem *epi) 427 { 428 struct eventpoll *ep; 429 unsigned int napi_id; 430 struct socket *sock; 431 struct sock *sk; 432 433 if (!net_busy_loop_on()) 434 return; 435 436 sock = sock_from_file(epi->ffd.file); 437 if (!sock) 438 return; 439 440 sk = sock->sk; 441 if (!sk) 442 return; 443 444 napi_id = READ_ONCE(sk->sk_napi_id); 445 ep = epi->ep; 446 447 /* Non-NAPI IDs can be rejected 448 * or 449 * Nothing to do if we already have this ID 450 */ 451 if (napi_id < MIN_NAPI_ID || napi_id == ep->napi_id) 452 return; 453 454 /* record NAPI ID for use in next busy poll */ 455 ep->napi_id = napi_id; 456 } 457 458 #else 459 460 static inline bool ep_busy_loop(struct eventpoll *ep, int nonblock) 461 { 462 return false; 463 } 464 465 static inline void ep_set_busy_poll_napi_id(struct epitem *epi) 466 { 467 } 468 469 #endif /* CONFIG_NET_RX_BUSY_POLL */ 470 471 /* 472 * As described in commit 0ccf831cb lockdep: annotate epoll 473 * the use of wait queues used by epoll is done in a very controlled 474 * manner. Wake ups can nest inside each other, but are never done 475 * with the same locking. For example: 476 * 477 * dfd = socket(...); 478 * efd1 = epoll_create(); 479 * efd2 = epoll_create(); 480 * epoll_ctl(efd1, EPOLL_CTL_ADD, dfd, ...); 481 * epoll_ctl(efd2, EPOLL_CTL_ADD, efd1, ...); 482 * 483 * When a packet arrives to the device underneath "dfd", the net code will 484 * issue a wake_up() on its poll wake list. Epoll (efd1) has installed a 485 * callback wakeup entry on that queue, and the wake_up() performed by the 486 * "dfd" net code will end up in ep_poll_callback(). At this point epoll 487 * (efd1) notices that it may have some event ready, so it needs to wake up 488 * the waiters on its poll wait list (efd2). So it calls ep_poll_safewake() 489 * that ends up in another wake_up(), after having checked about the 490 * recursion constraints. That are, no more than EP_MAX_NESTS, to avoid 491 * stack blasting. 492 * 493 * When CONFIG_DEBUG_LOCK_ALLOC is enabled, make sure lockdep can handle 494 * this special case of epoll. 495 */ 496 #ifdef CONFIG_DEBUG_LOCK_ALLOC 497 498 static void ep_poll_safewake(struct eventpoll *ep, struct epitem *epi, 499 unsigned pollflags) 500 { 501 struct eventpoll *ep_src; 502 unsigned long flags; 503 u8 nests = 0; 504 505 /* 506 * To set the subclass or nesting level for spin_lock_irqsave_nested() 507 * it might be natural to create a per-cpu nest count. However, since 508 * we can recurse on ep->poll_wait.lock, and a non-raw spinlock can 509 * schedule() in the -rt kernel, the per-cpu variable are no longer 510 * protected. Thus, we are introducing a per eventpoll nest field. 511 * If we are not being call from ep_poll_callback(), epi is NULL and 512 * we are at the first level of nesting, 0. Otherwise, we are being 513 * called from ep_poll_callback() and if a previous wakeup source is 514 * not an epoll file itself, we are at depth 1 since the wakeup source 515 * is depth 0. If the wakeup source is a previous epoll file in the 516 * wakeup chain then we use its nests value and record ours as 517 * nests + 1. The previous epoll file nests value is stable since its 518 * already holding its own poll_wait.lock. 519 */ 520 if (epi) { 521 if ((is_file_epoll(epi->ffd.file))) { 522 ep_src = epi->ffd.file->private_data; 523 nests = ep_src->nests; 524 } else { 525 nests = 1; 526 } 527 } 528 spin_lock_irqsave_nested(&ep->poll_wait.lock, flags, nests); 529 ep->nests = nests + 1; 530 wake_up_locked_poll(&ep->poll_wait, EPOLLIN | pollflags); 531 ep->nests = 0; 532 spin_unlock_irqrestore(&ep->poll_wait.lock, flags); 533 } 534 535 #else 536 537 static void ep_poll_safewake(struct eventpoll *ep, struct epitem *epi, 538 __poll_t pollflags) 539 { 540 wake_up_poll(&ep->poll_wait, EPOLLIN | pollflags); 541 } 542 543 #endif 544 545 static void ep_remove_wait_queue(struct eppoll_entry *pwq) 546 { 547 wait_queue_head_t *whead; 548 549 rcu_read_lock(); 550 /* 551 * If it is cleared by POLLFREE, it should be rcu-safe. 552 * If we read NULL we need a barrier paired with 553 * smp_store_release() in ep_poll_callback(), otherwise 554 * we rely on whead->lock. 555 */ 556 whead = smp_load_acquire(&pwq->whead); 557 if (whead) 558 remove_wait_queue(whead, &pwq->wait); 559 rcu_read_unlock(); 560 } 561 562 /* 563 * This function unregisters poll callbacks from the associated file 564 * descriptor. Must be called with "mtx" held. 565 */ 566 static void ep_unregister_pollwait(struct eventpoll *ep, struct epitem *epi) 567 { 568 struct eppoll_entry **p = &epi->pwqlist; 569 struct eppoll_entry *pwq; 570 571 while ((pwq = *p) != NULL) { 572 *p = pwq->next; 573 ep_remove_wait_queue(pwq); 574 kmem_cache_free(pwq_cache, pwq); 575 } 576 } 577 578 /* call only when ep->mtx is held */ 579 static inline struct wakeup_source *ep_wakeup_source(struct epitem *epi) 580 { 581 return rcu_dereference_check(epi->ws, lockdep_is_held(&epi->ep->mtx)); 582 } 583 584 /* call only when ep->mtx is held */ 585 static inline void ep_pm_stay_awake(struct epitem *epi) 586 { 587 struct wakeup_source *ws = ep_wakeup_source(epi); 588 589 if (ws) 590 __pm_stay_awake(ws); 591 } 592 593 static inline bool ep_has_wakeup_source(struct epitem *epi) 594 { 595 return rcu_access_pointer(epi->ws) ? true : false; 596 } 597 598 /* call when ep->mtx cannot be held (ep_poll_callback) */ 599 static inline void ep_pm_stay_awake_rcu(struct epitem *epi) 600 { 601 struct wakeup_source *ws; 602 603 rcu_read_lock(); 604 ws = rcu_dereference(epi->ws); 605 if (ws) 606 __pm_stay_awake(ws); 607 rcu_read_unlock(); 608 } 609 610 611 /* 612 * ep->mutex needs to be held because we could be hit by 613 * eventpoll_release_file() and epoll_ctl(). 614 */ 615 static void ep_start_scan(struct eventpoll *ep, struct list_head *txlist) 616 { 617 /* 618 * Steal the ready list, and re-init the original one to the 619 * empty list. Also, set ep->ovflist to NULL so that events 620 * happening while looping w/out locks, are not lost. We cannot 621 * have the poll callback to queue directly on ep->rdllist, 622 * because we want the "sproc" callback to be able to do it 623 * in a lockless way. 624 */ 625 lockdep_assert_irqs_enabled(); 626 write_lock_irq(&ep->lock); 627 list_splice_init(&ep->rdllist, txlist); 628 WRITE_ONCE(ep->ovflist, NULL); 629 write_unlock_irq(&ep->lock); 630 } 631 632 static void ep_done_scan(struct eventpoll *ep, 633 struct list_head *txlist) 634 { 635 struct epitem *epi, *nepi; 636 637 write_lock_irq(&ep->lock); 638 /* 639 * During the time we spent inside the "sproc" callback, some 640 * other events might have been queued by the poll callback. 641 * We re-insert them inside the main ready-list here. 642 */ 643 for (nepi = READ_ONCE(ep->ovflist); (epi = nepi) != NULL; 644 nepi = epi->next, epi->next = EP_UNACTIVE_PTR) { 645 /* 646 * We need to check if the item is already in the list. 647 * During the "sproc" callback execution time, items are 648 * queued into ->ovflist but the "txlist" might already 649 * contain them, and the list_splice() below takes care of them. 650 */ 651 if (!ep_is_linked(epi)) { 652 /* 653 * ->ovflist is LIFO, so we have to reverse it in order 654 * to keep in FIFO. 655 */ 656 list_add(&epi->rdllink, &ep->rdllist); 657 ep_pm_stay_awake(epi); 658 } 659 } 660 /* 661 * We need to set back ep->ovflist to EP_UNACTIVE_PTR, so that after 662 * releasing the lock, events will be queued in the normal way inside 663 * ep->rdllist. 664 */ 665 WRITE_ONCE(ep->ovflist, EP_UNACTIVE_PTR); 666 667 /* 668 * Quickly re-inject items left on "txlist". 669 */ 670 list_splice(txlist, &ep->rdllist); 671 __pm_relax(ep->ws); 672 673 if (!list_empty(&ep->rdllist)) { 674 if (waitqueue_active(&ep->wq)) 675 wake_up(&ep->wq); 676 } 677 678 write_unlock_irq(&ep->lock); 679 } 680 681 static void ep_get(struct eventpoll *ep) 682 { 683 refcount_inc(&ep->refcount); 684 } 685 686 /* 687 * Returns true if the event poll can be disposed 688 */ 689 static bool ep_refcount_dec_and_test(struct eventpoll *ep) 690 { 691 if (!refcount_dec_and_test(&ep->refcount)) 692 return false; 693 694 WARN_ON_ONCE(!RB_EMPTY_ROOT(&ep->rbr.rb_root)); 695 return true; 696 } 697 698 static void ep_free(struct eventpoll *ep) 699 { 700 mutex_destroy(&ep->mtx); 701 free_uid(ep->user); 702 wakeup_source_unregister(ep->ws); 703 kfree(ep); 704 } 705 706 /* 707 * Removes a "struct epitem" from the eventpoll RB tree and deallocates 708 * all the associated resources. Must be called with "mtx" held. 709 * If the dying flag is set, do the removal only if force is true. 710 * This prevents ep_clear_and_put() from dropping all the ep references 711 * while running concurrently with eventpoll_release_file(). 712 * Returns true if the eventpoll can be disposed. 713 */ 714 static bool __ep_remove(struct eventpoll *ep, struct epitem *epi, bool force) 715 { 716 struct file *file = epi->ffd.file; 717 struct epitems_head *to_free; 718 struct hlist_head *head; 719 720 lockdep_assert_irqs_enabled(); 721 722 /* 723 * Removes poll wait queue hooks. 724 */ 725 ep_unregister_pollwait(ep, epi); 726 727 /* Remove the current item from the list of epoll hooks */ 728 spin_lock(&file->f_lock); 729 if (epi->dying && !force) { 730 spin_unlock(&file->f_lock); 731 return false; 732 } 733 734 to_free = NULL; 735 head = file->f_ep; 736 if (head->first == &epi->fllink && !epi->fllink.next) { 737 file->f_ep = NULL; 738 if (!is_file_epoll(file)) { 739 struct epitems_head *v; 740 v = container_of(head, struct epitems_head, epitems); 741 if (!smp_load_acquire(&v->next)) 742 to_free = v; 743 } 744 } 745 hlist_del_rcu(&epi->fllink); 746 spin_unlock(&file->f_lock); 747 free_ephead(to_free); 748 749 rb_erase_cached(&epi->rbn, &ep->rbr); 750 751 write_lock_irq(&ep->lock); 752 if (ep_is_linked(epi)) 753 list_del_init(&epi->rdllink); 754 write_unlock_irq(&ep->lock); 755 756 wakeup_source_unregister(ep_wakeup_source(epi)); 757 /* 758 * At this point it is safe to free the eventpoll item. Use the union 759 * field epi->rcu, since we are trying to minimize the size of 760 * 'struct epitem'. The 'rbn' field is no longer in use. Protected by 761 * ep->mtx. The rcu read side, reverse_path_check_proc(), does not make 762 * use of the rbn field. 763 */ 764 kfree_rcu(epi, rcu); 765 766 percpu_counter_dec(&ep->user->epoll_watches); 767 return ep_refcount_dec_and_test(ep); 768 } 769 770 /* 771 * ep_remove variant for callers owing an additional reference to the ep 772 */ 773 static void ep_remove_safe(struct eventpoll *ep, struct epitem *epi) 774 { 775 WARN_ON_ONCE(__ep_remove(ep, epi, false)); 776 } 777 778 static void ep_clear_and_put(struct eventpoll *ep) 779 { 780 struct rb_node *rbp, *next; 781 struct epitem *epi; 782 bool dispose; 783 784 /* We need to release all tasks waiting for these file */ 785 if (waitqueue_active(&ep->poll_wait)) 786 ep_poll_safewake(ep, NULL, 0); 787 788 mutex_lock(&ep->mtx); 789 790 /* 791 * Walks through the whole tree by unregistering poll callbacks. 792 */ 793 for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) { 794 epi = rb_entry(rbp, struct epitem, rbn); 795 796 ep_unregister_pollwait(ep, epi); 797 cond_resched(); 798 } 799 800 /* 801 * Walks through the whole tree and try to free each "struct epitem". 802 * Note that ep_remove_safe() will not remove the epitem in case of a 803 * racing eventpoll_release_file(); the latter will do the removal. 804 * At this point we are sure no poll callbacks will be lingering around. 805 * Since we still own a reference to the eventpoll struct, the loop can't 806 * dispose it. 807 */ 808 for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = next) { 809 next = rb_next(rbp); 810 epi = rb_entry(rbp, struct epitem, rbn); 811 ep_remove_safe(ep, epi); 812 cond_resched(); 813 } 814 815 dispose = ep_refcount_dec_and_test(ep); 816 mutex_unlock(&ep->mtx); 817 818 if (dispose) 819 ep_free(ep); 820 } 821 822 static int ep_eventpoll_release(struct inode *inode, struct file *file) 823 { 824 struct eventpoll *ep = file->private_data; 825 826 if (ep) 827 ep_clear_and_put(ep); 828 829 return 0; 830 } 831 832 static __poll_t ep_item_poll(const struct epitem *epi, poll_table *pt, int depth); 833 834 static __poll_t __ep_eventpoll_poll(struct file *file, poll_table *wait, int depth) 835 { 836 struct eventpoll *ep = file->private_data; 837 LIST_HEAD(txlist); 838 struct epitem *epi, *tmp; 839 poll_table pt; 840 __poll_t res = 0; 841 842 init_poll_funcptr(&pt, NULL); 843 844 /* Insert inside our poll wait queue */ 845 poll_wait(file, &ep->poll_wait, wait); 846 847 /* 848 * Proceed to find out if wanted events are really available inside 849 * the ready list. 850 */ 851 mutex_lock_nested(&ep->mtx, depth); 852 ep_start_scan(ep, &txlist); 853 list_for_each_entry_safe(epi, tmp, &txlist, rdllink) { 854 if (ep_item_poll(epi, &pt, depth + 1)) { 855 res = EPOLLIN | EPOLLRDNORM; 856 break; 857 } else { 858 /* 859 * Item has been dropped into the ready list by the poll 860 * callback, but it's not actually ready, as far as 861 * caller requested events goes. We can remove it here. 862 */ 863 __pm_relax(ep_wakeup_source(epi)); 864 list_del_init(&epi->rdllink); 865 } 866 } 867 ep_done_scan(ep, &txlist); 868 mutex_unlock(&ep->mtx); 869 return res; 870 } 871 872 /* 873 * Differs from ep_eventpoll_poll() in that internal callers already have 874 * the ep->mtx so we need to start from depth=1, such that mutex_lock_nested() 875 * is correctly annotated. 876 */ 877 static __poll_t ep_item_poll(const struct epitem *epi, poll_table *pt, 878 int depth) 879 { 880 struct file *file = epi->ffd.file; 881 __poll_t res; 882 883 pt->_key = epi->event.events; 884 if (!is_file_epoll(file)) 885 res = vfs_poll(file, pt); 886 else 887 res = __ep_eventpoll_poll(file, pt, depth); 888 return res & epi->event.events; 889 } 890 891 static __poll_t ep_eventpoll_poll(struct file *file, poll_table *wait) 892 { 893 return __ep_eventpoll_poll(file, wait, 0); 894 } 895 896 #ifdef CONFIG_PROC_FS 897 static void ep_show_fdinfo(struct seq_file *m, struct file *f) 898 { 899 struct eventpoll *ep = f->private_data; 900 struct rb_node *rbp; 901 902 mutex_lock(&ep->mtx); 903 for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) { 904 struct epitem *epi = rb_entry(rbp, struct epitem, rbn); 905 struct inode *inode = file_inode(epi->ffd.file); 906 907 seq_printf(m, "tfd: %8d events: %8x data: %16llx " 908 " pos:%lli ino:%lx sdev:%x\n", 909 epi->ffd.fd, epi->event.events, 910 (long long)epi->event.data, 911 (long long)epi->ffd.file->f_pos, 912 inode->i_ino, inode->i_sb->s_dev); 913 if (seq_has_overflowed(m)) 914 break; 915 } 916 mutex_unlock(&ep->mtx); 917 } 918 #endif 919 920 /* File callbacks that implement the eventpoll file behaviour */ 921 static const struct file_operations eventpoll_fops = { 922 #ifdef CONFIG_PROC_FS 923 .show_fdinfo = ep_show_fdinfo, 924 #endif 925 .release = ep_eventpoll_release, 926 .poll = ep_eventpoll_poll, 927 .llseek = noop_llseek, 928 }; 929 930 /* 931 * This is called from eventpoll_release() to unlink files from the eventpoll 932 * interface. We need to have this facility to cleanup correctly files that are 933 * closed without being removed from the eventpoll interface. 934 */ 935 void eventpoll_release_file(struct file *file) 936 { 937 struct eventpoll *ep; 938 struct epitem *epi; 939 bool dispose; 940 941 /* 942 * Use the 'dying' flag to prevent a concurrent ep_clear_and_put() from 943 * touching the epitems list before eventpoll_release_file() can access 944 * the ep->mtx. 945 */ 946 again: 947 spin_lock(&file->f_lock); 948 if (file->f_ep && file->f_ep->first) { 949 epi = hlist_entry(file->f_ep->first, struct epitem, fllink); 950 epi->dying = true; 951 spin_unlock(&file->f_lock); 952 953 /* 954 * ep access is safe as we still own a reference to the ep 955 * struct 956 */ 957 ep = epi->ep; 958 mutex_lock(&ep->mtx); 959 dispose = __ep_remove(ep, epi, true); 960 mutex_unlock(&ep->mtx); 961 962 if (dispose) 963 ep_free(ep); 964 goto again; 965 } 966 spin_unlock(&file->f_lock); 967 } 968 969 static int ep_alloc(struct eventpoll **pep) 970 { 971 struct eventpoll *ep; 972 973 ep = kzalloc(sizeof(*ep), GFP_KERNEL); 974 if (unlikely(!ep)) 975 return -ENOMEM; 976 977 mutex_init(&ep->mtx); 978 rwlock_init(&ep->lock); 979 init_waitqueue_head(&ep->wq); 980 init_waitqueue_head(&ep->poll_wait); 981 INIT_LIST_HEAD(&ep->rdllist); 982 ep->rbr = RB_ROOT_CACHED; 983 ep->ovflist = EP_UNACTIVE_PTR; 984 ep->user = get_current_user(); 985 refcount_set(&ep->refcount, 1); 986 987 *pep = ep; 988 989 return 0; 990 } 991 992 /* 993 * Search the file inside the eventpoll tree. The RB tree operations 994 * are protected by the "mtx" mutex, and ep_find() must be called with 995 * "mtx" held. 996 */ 997 static struct epitem *ep_find(struct eventpoll *ep, struct file *file, int fd) 998 { 999 int kcmp; 1000 struct rb_node *rbp; 1001 struct epitem *epi, *epir = NULL; 1002 struct epoll_filefd ffd; 1003 1004 ep_set_ffd(&ffd, file, fd); 1005 for (rbp = ep->rbr.rb_root.rb_node; rbp; ) { 1006 epi = rb_entry(rbp, struct epitem, rbn); 1007 kcmp = ep_cmp_ffd(&ffd, &epi->ffd); 1008 if (kcmp > 0) 1009 rbp = rbp->rb_right; 1010 else if (kcmp < 0) 1011 rbp = rbp->rb_left; 1012 else { 1013 epir = epi; 1014 break; 1015 } 1016 } 1017 1018 return epir; 1019 } 1020 1021 #ifdef CONFIG_KCMP 1022 static struct epitem *ep_find_tfd(struct eventpoll *ep, int tfd, unsigned long toff) 1023 { 1024 struct rb_node *rbp; 1025 struct epitem *epi; 1026 1027 for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) { 1028 epi = rb_entry(rbp, struct epitem, rbn); 1029 if (epi->ffd.fd == tfd) { 1030 if (toff == 0) 1031 return epi; 1032 else 1033 toff--; 1034 } 1035 cond_resched(); 1036 } 1037 1038 return NULL; 1039 } 1040 1041 struct file *get_epoll_tfile_raw_ptr(struct file *file, int tfd, 1042 unsigned long toff) 1043 { 1044 struct file *file_raw; 1045 struct eventpoll *ep; 1046 struct epitem *epi; 1047 1048 if (!is_file_epoll(file)) 1049 return ERR_PTR(-EINVAL); 1050 1051 ep = file->private_data; 1052 1053 mutex_lock(&ep->mtx); 1054 epi = ep_find_tfd(ep, tfd, toff); 1055 if (epi) 1056 file_raw = epi->ffd.file; 1057 else 1058 file_raw = ERR_PTR(-ENOENT); 1059 mutex_unlock(&ep->mtx); 1060 1061 return file_raw; 1062 } 1063 #endif /* CONFIG_KCMP */ 1064 1065 /* 1066 * Adds a new entry to the tail of the list in a lockless way, i.e. 1067 * multiple CPUs are allowed to call this function concurrently. 1068 * 1069 * Beware: it is necessary to prevent any other modifications of the 1070 * existing list until all changes are completed, in other words 1071 * concurrent list_add_tail_lockless() calls should be protected 1072 * with a read lock, where write lock acts as a barrier which 1073 * makes sure all list_add_tail_lockless() calls are fully 1074 * completed. 1075 * 1076 * Also an element can be locklessly added to the list only in one 1077 * direction i.e. either to the tail or to the head, otherwise 1078 * concurrent access will corrupt the list. 1079 * 1080 * Return: %false if element has been already added to the list, %true 1081 * otherwise. 1082 */ 1083 static inline bool list_add_tail_lockless(struct list_head *new, 1084 struct list_head *head) 1085 { 1086 struct list_head *prev; 1087 1088 /* 1089 * This is simple 'new->next = head' operation, but cmpxchg() 1090 * is used in order to detect that same element has been just 1091 * added to the list from another CPU: the winner observes 1092 * new->next == new. 1093 */ 1094 if (!try_cmpxchg(&new->next, &new, head)) 1095 return false; 1096 1097 /* 1098 * Initially ->next of a new element must be updated with the head 1099 * (we are inserting to the tail) and only then pointers are atomically 1100 * exchanged. XCHG guarantees memory ordering, thus ->next should be 1101 * updated before pointers are actually swapped and pointers are 1102 * swapped before prev->next is updated. 1103 */ 1104 1105 prev = xchg(&head->prev, new); 1106 1107 /* 1108 * It is safe to modify prev->next and new->prev, because a new element 1109 * is added only to the tail and new->next is updated before XCHG. 1110 */ 1111 1112 prev->next = new; 1113 new->prev = prev; 1114 1115 return true; 1116 } 1117 1118 /* 1119 * Chains a new epi entry to the tail of the ep->ovflist in a lockless way, 1120 * i.e. multiple CPUs are allowed to call this function concurrently. 1121 * 1122 * Return: %false if epi element has been already chained, %true otherwise. 1123 */ 1124 static inline bool chain_epi_lockless(struct epitem *epi) 1125 { 1126 struct eventpoll *ep = epi->ep; 1127 1128 /* Fast preliminary check */ 1129 if (epi->next != EP_UNACTIVE_PTR) 1130 return false; 1131 1132 /* Check that the same epi has not been just chained from another CPU */ 1133 if (cmpxchg(&epi->next, EP_UNACTIVE_PTR, NULL) != EP_UNACTIVE_PTR) 1134 return false; 1135 1136 /* Atomically exchange tail */ 1137 epi->next = xchg(&ep->ovflist, epi); 1138 1139 return true; 1140 } 1141 1142 /* 1143 * This is the callback that is passed to the wait queue wakeup 1144 * mechanism. It is called by the stored file descriptors when they 1145 * have events to report. 1146 * 1147 * This callback takes a read lock in order not to contend with concurrent 1148 * events from another file descriptor, thus all modifications to ->rdllist 1149 * or ->ovflist are lockless. Read lock is paired with the write lock from 1150 * ep_start/done_scan(), which stops all list modifications and guarantees 1151 * that lists state is seen correctly. 1152 * 1153 * Another thing worth to mention is that ep_poll_callback() can be called 1154 * concurrently for the same @epi from different CPUs if poll table was inited 1155 * with several wait queues entries. Plural wakeup from different CPUs of a 1156 * single wait queue is serialized by wq.lock, but the case when multiple wait 1157 * queues are used should be detected accordingly. This is detected using 1158 * cmpxchg() operation. 1159 */ 1160 static int ep_poll_callback(wait_queue_entry_t *wait, unsigned mode, int sync, void *key) 1161 { 1162 int pwake = 0; 1163 struct epitem *epi = ep_item_from_wait(wait); 1164 struct eventpoll *ep = epi->ep; 1165 __poll_t pollflags = key_to_poll(key); 1166 unsigned long flags; 1167 int ewake = 0; 1168 1169 read_lock_irqsave(&ep->lock, flags); 1170 1171 ep_set_busy_poll_napi_id(epi); 1172 1173 /* 1174 * If the event mask does not contain any poll(2) event, we consider the 1175 * descriptor to be disabled. This condition is likely the effect of the 1176 * EPOLLONESHOT bit that disables the descriptor when an event is received, 1177 * until the next EPOLL_CTL_MOD will be issued. 1178 */ 1179 if (!(epi->event.events & ~EP_PRIVATE_BITS)) 1180 goto out_unlock; 1181 1182 /* 1183 * Check the events coming with the callback. At this stage, not 1184 * every device reports the events in the "key" parameter of the 1185 * callback. We need to be able to handle both cases here, hence the 1186 * test for "key" != NULL before the event match test. 1187 */ 1188 if (pollflags && !(pollflags & epi->event.events)) 1189 goto out_unlock; 1190 1191 /* 1192 * If we are transferring events to userspace, we can hold no locks 1193 * (because we're accessing user memory, and because of linux f_op->poll() 1194 * semantics). All the events that happen during that period of time are 1195 * chained in ep->ovflist and requeued later on. 1196 */ 1197 if (READ_ONCE(ep->ovflist) != EP_UNACTIVE_PTR) { 1198 if (chain_epi_lockless(epi)) 1199 ep_pm_stay_awake_rcu(epi); 1200 } else if (!ep_is_linked(epi)) { 1201 /* In the usual case, add event to ready list. */ 1202 if (list_add_tail_lockless(&epi->rdllink, &ep->rdllist)) 1203 ep_pm_stay_awake_rcu(epi); 1204 } 1205 1206 /* 1207 * Wake up ( if active ) both the eventpoll wait list and the ->poll() 1208 * wait list. 1209 */ 1210 if (waitqueue_active(&ep->wq)) { 1211 if ((epi->event.events & EPOLLEXCLUSIVE) && 1212 !(pollflags & POLLFREE)) { 1213 switch (pollflags & EPOLLINOUT_BITS) { 1214 case EPOLLIN: 1215 if (epi->event.events & EPOLLIN) 1216 ewake = 1; 1217 break; 1218 case EPOLLOUT: 1219 if (epi->event.events & EPOLLOUT) 1220 ewake = 1; 1221 break; 1222 case 0: 1223 ewake = 1; 1224 break; 1225 } 1226 } 1227 wake_up(&ep->wq); 1228 } 1229 if (waitqueue_active(&ep->poll_wait)) 1230 pwake++; 1231 1232 out_unlock: 1233 read_unlock_irqrestore(&ep->lock, flags); 1234 1235 /* We have to call this outside the lock */ 1236 if (pwake) 1237 ep_poll_safewake(ep, epi, pollflags & EPOLL_URING_WAKE); 1238 1239 if (!(epi->event.events & EPOLLEXCLUSIVE)) 1240 ewake = 1; 1241 1242 if (pollflags & POLLFREE) { 1243 /* 1244 * If we race with ep_remove_wait_queue() it can miss 1245 * ->whead = NULL and do another remove_wait_queue() after 1246 * us, so we can't use __remove_wait_queue(). 1247 */ 1248 list_del_init(&wait->entry); 1249 /* 1250 * ->whead != NULL protects us from the race with 1251 * ep_clear_and_put() or ep_remove(), ep_remove_wait_queue() 1252 * takes whead->lock held by the caller. Once we nullify it, 1253 * nothing protects ep/epi or even wait. 1254 */ 1255 smp_store_release(&ep_pwq_from_wait(wait)->whead, NULL); 1256 } 1257 1258 return ewake; 1259 } 1260 1261 /* 1262 * This is the callback that is used to add our wait queue to the 1263 * target file wakeup lists. 1264 */ 1265 static void ep_ptable_queue_proc(struct file *file, wait_queue_head_t *whead, 1266 poll_table *pt) 1267 { 1268 struct ep_pqueue *epq = container_of(pt, struct ep_pqueue, pt); 1269 struct epitem *epi = epq->epi; 1270 struct eppoll_entry *pwq; 1271 1272 if (unlikely(!epi)) // an earlier allocation has failed 1273 return; 1274 1275 pwq = kmem_cache_alloc(pwq_cache, GFP_KERNEL); 1276 if (unlikely(!pwq)) { 1277 epq->epi = NULL; 1278 return; 1279 } 1280 1281 init_waitqueue_func_entry(&pwq->wait, ep_poll_callback); 1282 pwq->whead = whead; 1283 pwq->base = epi; 1284 if (epi->event.events & EPOLLEXCLUSIVE) 1285 add_wait_queue_exclusive(whead, &pwq->wait); 1286 else 1287 add_wait_queue(whead, &pwq->wait); 1288 pwq->next = epi->pwqlist; 1289 epi->pwqlist = pwq; 1290 } 1291 1292 static void ep_rbtree_insert(struct eventpoll *ep, struct epitem *epi) 1293 { 1294 int kcmp; 1295 struct rb_node **p = &ep->rbr.rb_root.rb_node, *parent = NULL; 1296 struct epitem *epic; 1297 bool leftmost = true; 1298 1299 while (*p) { 1300 parent = *p; 1301 epic = rb_entry(parent, struct epitem, rbn); 1302 kcmp = ep_cmp_ffd(&epi->ffd, &epic->ffd); 1303 if (kcmp > 0) { 1304 p = &parent->rb_right; 1305 leftmost = false; 1306 } else 1307 p = &parent->rb_left; 1308 } 1309 rb_link_node(&epi->rbn, parent, p); 1310 rb_insert_color_cached(&epi->rbn, &ep->rbr, leftmost); 1311 } 1312 1313 1314 1315 #define PATH_ARR_SIZE 5 1316 /* 1317 * These are the number paths of length 1 to 5, that we are allowing to emanate 1318 * from a single file of interest. For example, we allow 1000 paths of length 1319 * 1, to emanate from each file of interest. This essentially represents the 1320 * potential wakeup paths, which need to be limited in order to avoid massive 1321 * uncontrolled wakeup storms. The common use case should be a single ep which 1322 * is connected to n file sources. In this case each file source has 1 path 1323 * of length 1. Thus, the numbers below should be more than sufficient. These 1324 * path limits are enforced during an EPOLL_CTL_ADD operation, since a modify 1325 * and delete can't add additional paths. Protected by the epnested_mutex. 1326 */ 1327 static const int path_limits[PATH_ARR_SIZE] = { 1000, 500, 100, 50, 10 }; 1328 static int path_count[PATH_ARR_SIZE]; 1329 1330 static int path_count_inc(int nests) 1331 { 1332 /* Allow an arbitrary number of depth 1 paths */ 1333 if (nests == 0) 1334 return 0; 1335 1336 if (++path_count[nests] > path_limits[nests]) 1337 return -1; 1338 return 0; 1339 } 1340 1341 static void path_count_init(void) 1342 { 1343 int i; 1344 1345 for (i = 0; i < PATH_ARR_SIZE; i++) 1346 path_count[i] = 0; 1347 } 1348 1349 static int reverse_path_check_proc(struct hlist_head *refs, int depth) 1350 { 1351 int error = 0; 1352 struct epitem *epi; 1353 1354 if (depth > EP_MAX_NESTS) /* too deep nesting */ 1355 return -1; 1356 1357 /* CTL_DEL can remove links here, but that can't increase our count */ 1358 hlist_for_each_entry_rcu(epi, refs, fllink) { 1359 struct hlist_head *refs = &epi->ep->refs; 1360 if (hlist_empty(refs)) 1361 error = path_count_inc(depth); 1362 else 1363 error = reverse_path_check_proc(refs, depth + 1); 1364 if (error != 0) 1365 break; 1366 } 1367 return error; 1368 } 1369 1370 /** 1371 * reverse_path_check - The tfile_check_list is list of epitem_head, which have 1372 * links that are proposed to be newly added. We need to 1373 * make sure that those added links don't add too many 1374 * paths such that we will spend all our time waking up 1375 * eventpoll objects. 1376 * 1377 * Return: %zero if the proposed links don't create too many paths, 1378 * %-1 otherwise. 1379 */ 1380 static int reverse_path_check(void) 1381 { 1382 struct epitems_head *p; 1383 1384 for (p = tfile_check_list; p != EP_UNACTIVE_PTR; p = p->next) { 1385 int error; 1386 path_count_init(); 1387 rcu_read_lock(); 1388 error = reverse_path_check_proc(&p->epitems, 0); 1389 rcu_read_unlock(); 1390 if (error) 1391 return error; 1392 } 1393 return 0; 1394 } 1395 1396 static int ep_create_wakeup_source(struct epitem *epi) 1397 { 1398 struct name_snapshot n; 1399 struct wakeup_source *ws; 1400 1401 if (!epi->ep->ws) { 1402 epi->ep->ws = wakeup_source_register(NULL, "eventpoll"); 1403 if (!epi->ep->ws) 1404 return -ENOMEM; 1405 } 1406 1407 take_dentry_name_snapshot(&n, epi->ffd.file->f_path.dentry); 1408 ws = wakeup_source_register(NULL, n.name.name); 1409 release_dentry_name_snapshot(&n); 1410 1411 if (!ws) 1412 return -ENOMEM; 1413 rcu_assign_pointer(epi->ws, ws); 1414 1415 return 0; 1416 } 1417 1418 /* rare code path, only used when EPOLL_CTL_MOD removes a wakeup source */ 1419 static noinline void ep_destroy_wakeup_source(struct epitem *epi) 1420 { 1421 struct wakeup_source *ws = ep_wakeup_source(epi); 1422 1423 RCU_INIT_POINTER(epi->ws, NULL); 1424 1425 /* 1426 * wait for ep_pm_stay_awake_rcu to finish, synchronize_rcu is 1427 * used internally by wakeup_source_remove, too (called by 1428 * wakeup_source_unregister), so we cannot use call_rcu 1429 */ 1430 synchronize_rcu(); 1431 wakeup_source_unregister(ws); 1432 } 1433 1434 static int attach_epitem(struct file *file, struct epitem *epi) 1435 { 1436 struct epitems_head *to_free = NULL; 1437 struct hlist_head *head = NULL; 1438 struct eventpoll *ep = NULL; 1439 1440 if (is_file_epoll(file)) 1441 ep = file->private_data; 1442 1443 if (ep) { 1444 head = &ep->refs; 1445 } else if (!READ_ONCE(file->f_ep)) { 1446 allocate: 1447 to_free = kmem_cache_zalloc(ephead_cache, GFP_KERNEL); 1448 if (!to_free) 1449 return -ENOMEM; 1450 head = &to_free->epitems; 1451 } 1452 spin_lock(&file->f_lock); 1453 if (!file->f_ep) { 1454 if (unlikely(!head)) { 1455 spin_unlock(&file->f_lock); 1456 goto allocate; 1457 } 1458 file->f_ep = head; 1459 to_free = NULL; 1460 } 1461 hlist_add_head_rcu(&epi->fllink, file->f_ep); 1462 spin_unlock(&file->f_lock); 1463 free_ephead(to_free); 1464 return 0; 1465 } 1466 1467 /* 1468 * Must be called with "mtx" held. 1469 */ 1470 static int ep_insert(struct eventpoll *ep, const struct epoll_event *event, 1471 struct file *tfile, int fd, int full_check) 1472 { 1473 int error, pwake = 0; 1474 __poll_t revents; 1475 struct epitem *epi; 1476 struct ep_pqueue epq; 1477 struct eventpoll *tep = NULL; 1478 1479 if (is_file_epoll(tfile)) 1480 tep = tfile->private_data; 1481 1482 lockdep_assert_irqs_enabled(); 1483 1484 if (unlikely(percpu_counter_compare(&ep->user->epoll_watches, 1485 max_user_watches) >= 0)) 1486 return -ENOSPC; 1487 percpu_counter_inc(&ep->user->epoll_watches); 1488 1489 if (!(epi = kmem_cache_zalloc(epi_cache, GFP_KERNEL))) { 1490 percpu_counter_dec(&ep->user->epoll_watches); 1491 return -ENOMEM; 1492 } 1493 1494 /* Item initialization follow here ... */ 1495 INIT_LIST_HEAD(&epi->rdllink); 1496 epi->ep = ep; 1497 ep_set_ffd(&epi->ffd, tfile, fd); 1498 epi->event = *event; 1499 epi->next = EP_UNACTIVE_PTR; 1500 1501 if (tep) 1502 mutex_lock_nested(&tep->mtx, 1); 1503 /* Add the current item to the list of active epoll hook for this file */ 1504 if (unlikely(attach_epitem(tfile, epi) < 0)) { 1505 if (tep) 1506 mutex_unlock(&tep->mtx); 1507 kmem_cache_free(epi_cache, epi); 1508 percpu_counter_dec(&ep->user->epoll_watches); 1509 return -ENOMEM; 1510 } 1511 1512 if (full_check && !tep) 1513 list_file(tfile); 1514 1515 /* 1516 * Add the current item to the RB tree. All RB tree operations are 1517 * protected by "mtx", and ep_insert() is called with "mtx" held. 1518 */ 1519 ep_rbtree_insert(ep, epi); 1520 if (tep) 1521 mutex_unlock(&tep->mtx); 1522 1523 /* 1524 * ep_remove_safe() calls in the later error paths can't lead to 1525 * ep_free() as the ep file itself still holds an ep reference. 1526 */ 1527 ep_get(ep); 1528 1529 /* now check if we've created too many backpaths */ 1530 if (unlikely(full_check && reverse_path_check())) { 1531 ep_remove_safe(ep, epi); 1532 return -EINVAL; 1533 } 1534 1535 if (epi->event.events & EPOLLWAKEUP) { 1536 error = ep_create_wakeup_source(epi); 1537 if (error) { 1538 ep_remove_safe(ep, epi); 1539 return error; 1540 } 1541 } 1542 1543 /* Initialize the poll table using the queue callback */ 1544 epq.epi = epi; 1545 init_poll_funcptr(&epq.pt, ep_ptable_queue_proc); 1546 1547 /* 1548 * Attach the item to the poll hooks and get current event bits. 1549 * We can safely use the file* here because its usage count has 1550 * been increased by the caller of this function. Note that after 1551 * this operation completes, the poll callback can start hitting 1552 * the new item. 1553 */ 1554 revents = ep_item_poll(epi, &epq.pt, 1); 1555 1556 /* 1557 * We have to check if something went wrong during the poll wait queue 1558 * install process. Namely an allocation for a wait queue failed due 1559 * high memory pressure. 1560 */ 1561 if (unlikely(!epq.epi)) { 1562 ep_remove_safe(ep, epi); 1563 return -ENOMEM; 1564 } 1565 1566 /* We have to drop the new item inside our item list to keep track of it */ 1567 write_lock_irq(&ep->lock); 1568 1569 /* record NAPI ID of new item if present */ 1570 ep_set_busy_poll_napi_id(epi); 1571 1572 /* If the file is already "ready" we drop it inside the ready list */ 1573 if (revents && !ep_is_linked(epi)) { 1574 list_add_tail(&epi->rdllink, &ep->rdllist); 1575 ep_pm_stay_awake(epi); 1576 1577 /* Notify waiting tasks that events are available */ 1578 if (waitqueue_active(&ep->wq)) 1579 wake_up(&ep->wq); 1580 if (waitqueue_active(&ep->poll_wait)) 1581 pwake++; 1582 } 1583 1584 write_unlock_irq(&ep->lock); 1585 1586 /* We have to call this outside the lock */ 1587 if (pwake) 1588 ep_poll_safewake(ep, NULL, 0); 1589 1590 return 0; 1591 } 1592 1593 /* 1594 * Modify the interest event mask by dropping an event if the new mask 1595 * has a match in the current file status. Must be called with "mtx" held. 1596 */ 1597 static int ep_modify(struct eventpoll *ep, struct epitem *epi, 1598 const struct epoll_event *event) 1599 { 1600 int pwake = 0; 1601 poll_table pt; 1602 1603 lockdep_assert_irqs_enabled(); 1604 1605 init_poll_funcptr(&pt, NULL); 1606 1607 /* 1608 * Set the new event interest mask before calling f_op->poll(); 1609 * otherwise we might miss an event that happens between the 1610 * f_op->poll() call and the new event set registering. 1611 */ 1612 epi->event.events = event->events; /* need barrier below */ 1613 epi->event.data = event->data; /* protected by mtx */ 1614 if (epi->event.events & EPOLLWAKEUP) { 1615 if (!ep_has_wakeup_source(epi)) 1616 ep_create_wakeup_source(epi); 1617 } else if (ep_has_wakeup_source(epi)) { 1618 ep_destroy_wakeup_source(epi); 1619 } 1620 1621 /* 1622 * The following barrier has two effects: 1623 * 1624 * 1) Flush epi changes above to other CPUs. This ensures 1625 * we do not miss events from ep_poll_callback if an 1626 * event occurs immediately after we call f_op->poll(). 1627 * We need this because we did not take ep->lock while 1628 * changing epi above (but ep_poll_callback does take 1629 * ep->lock). 1630 * 1631 * 2) We also need to ensure we do not miss _past_ events 1632 * when calling f_op->poll(). This barrier also 1633 * pairs with the barrier in wq_has_sleeper (see 1634 * comments for wq_has_sleeper). 1635 * 1636 * This barrier will now guarantee ep_poll_callback or f_op->poll 1637 * (or both) will notice the readiness of an item. 1638 */ 1639 smp_mb(); 1640 1641 /* 1642 * Get current event bits. We can safely use the file* here because 1643 * its usage count has been increased by the caller of this function. 1644 * If the item is "hot" and it is not registered inside the ready 1645 * list, push it inside. 1646 */ 1647 if (ep_item_poll(epi, &pt, 1)) { 1648 write_lock_irq(&ep->lock); 1649 if (!ep_is_linked(epi)) { 1650 list_add_tail(&epi->rdllink, &ep->rdllist); 1651 ep_pm_stay_awake(epi); 1652 1653 /* Notify waiting tasks that events are available */ 1654 if (waitqueue_active(&ep->wq)) 1655 wake_up(&ep->wq); 1656 if (waitqueue_active(&ep->poll_wait)) 1657 pwake++; 1658 } 1659 write_unlock_irq(&ep->lock); 1660 } 1661 1662 /* We have to call this outside the lock */ 1663 if (pwake) 1664 ep_poll_safewake(ep, NULL, 0); 1665 1666 return 0; 1667 } 1668 1669 static int ep_send_events(struct eventpoll *ep, 1670 struct epoll_event __user *events, int maxevents) 1671 { 1672 struct epitem *epi, *tmp; 1673 LIST_HEAD(txlist); 1674 poll_table pt; 1675 int res = 0; 1676 1677 /* 1678 * Always short-circuit for fatal signals to allow threads to make a 1679 * timely exit without the chance of finding more events available and 1680 * fetching repeatedly. 1681 */ 1682 if (fatal_signal_pending(current)) 1683 return -EINTR; 1684 1685 init_poll_funcptr(&pt, NULL); 1686 1687 mutex_lock(&ep->mtx); 1688 ep_start_scan(ep, &txlist); 1689 1690 /* 1691 * We can loop without lock because we are passed a task private list. 1692 * Items cannot vanish during the loop we are holding ep->mtx. 1693 */ 1694 list_for_each_entry_safe(epi, tmp, &txlist, rdllink) { 1695 struct wakeup_source *ws; 1696 __poll_t revents; 1697 1698 if (res >= maxevents) 1699 break; 1700 1701 /* 1702 * Activate ep->ws before deactivating epi->ws to prevent 1703 * triggering auto-suspend here (in case we reactive epi->ws 1704 * below). 1705 * 1706 * This could be rearranged to delay the deactivation of epi->ws 1707 * instead, but then epi->ws would temporarily be out of sync 1708 * with ep_is_linked(). 1709 */ 1710 ws = ep_wakeup_source(epi); 1711 if (ws) { 1712 if (ws->active) 1713 __pm_stay_awake(ep->ws); 1714 __pm_relax(ws); 1715 } 1716 1717 list_del_init(&epi->rdllink); 1718 1719 /* 1720 * If the event mask intersect the caller-requested one, 1721 * deliver the event to userspace. Again, we are holding ep->mtx, 1722 * so no operations coming from userspace can change the item. 1723 */ 1724 revents = ep_item_poll(epi, &pt, 1); 1725 if (!revents) 1726 continue; 1727 1728 events = epoll_put_uevent(revents, epi->event.data, events); 1729 if (!events) { 1730 list_add(&epi->rdllink, &txlist); 1731 ep_pm_stay_awake(epi); 1732 if (!res) 1733 res = -EFAULT; 1734 break; 1735 } 1736 res++; 1737 if (epi->event.events & EPOLLONESHOT) 1738 epi->event.events &= EP_PRIVATE_BITS; 1739 else if (!(epi->event.events & EPOLLET)) { 1740 /* 1741 * If this file has been added with Level 1742 * Trigger mode, we need to insert back inside 1743 * the ready list, so that the next call to 1744 * epoll_wait() will check again the events 1745 * availability. At this point, no one can insert 1746 * into ep->rdllist besides us. The epoll_ctl() 1747 * callers are locked out by 1748 * ep_send_events() holding "mtx" and the 1749 * poll callback will queue them in ep->ovflist. 1750 */ 1751 list_add_tail(&epi->rdllink, &ep->rdllist); 1752 ep_pm_stay_awake(epi); 1753 } 1754 } 1755 ep_done_scan(ep, &txlist); 1756 mutex_unlock(&ep->mtx); 1757 1758 return res; 1759 } 1760 1761 static struct timespec64 *ep_timeout_to_timespec(struct timespec64 *to, long ms) 1762 { 1763 struct timespec64 now; 1764 1765 if (ms < 0) 1766 return NULL; 1767 1768 if (!ms) { 1769 to->tv_sec = 0; 1770 to->tv_nsec = 0; 1771 return to; 1772 } 1773 1774 to->tv_sec = ms / MSEC_PER_SEC; 1775 to->tv_nsec = NSEC_PER_MSEC * (ms % MSEC_PER_SEC); 1776 1777 ktime_get_ts64(&now); 1778 *to = timespec64_add_safe(now, *to); 1779 return to; 1780 } 1781 1782 /* 1783 * autoremove_wake_function, but remove even on failure to wake up, because we 1784 * know that default_wake_function/ttwu will only fail if the thread is already 1785 * woken, and in that case the ep_poll loop will remove the entry anyways, not 1786 * try to reuse it. 1787 */ 1788 static int ep_autoremove_wake_function(struct wait_queue_entry *wq_entry, 1789 unsigned int mode, int sync, void *key) 1790 { 1791 int ret = default_wake_function(wq_entry, mode, sync, key); 1792 1793 /* 1794 * Pairs with list_empty_careful in ep_poll, and ensures future loop 1795 * iterations see the cause of this wakeup. 1796 */ 1797 list_del_init_careful(&wq_entry->entry); 1798 return ret; 1799 } 1800 1801 /** 1802 * ep_poll - Retrieves ready events, and delivers them to the caller-supplied 1803 * event buffer. 1804 * 1805 * @ep: Pointer to the eventpoll context. 1806 * @events: Pointer to the userspace buffer where the ready events should be 1807 * stored. 1808 * @maxevents: Size (in terms of number of events) of the caller event buffer. 1809 * @timeout: Maximum timeout for the ready events fetch operation, in 1810 * timespec. If the timeout is zero, the function will not block, 1811 * while if the @timeout ptr is NULL, the function will block 1812 * until at least one event has been retrieved (or an error 1813 * occurred). 1814 * 1815 * Return: the number of ready events which have been fetched, or an 1816 * error code, in case of error. 1817 */ 1818 static int ep_poll(struct eventpoll *ep, struct epoll_event __user *events, 1819 int maxevents, struct timespec64 *timeout) 1820 { 1821 int res, eavail, timed_out = 0; 1822 u64 slack = 0; 1823 wait_queue_entry_t wait; 1824 ktime_t expires, *to = NULL; 1825 1826 lockdep_assert_irqs_enabled(); 1827 1828 if (timeout && (timeout->tv_sec | timeout->tv_nsec)) { 1829 slack = select_estimate_accuracy(timeout); 1830 to = &expires; 1831 *to = timespec64_to_ktime(*timeout); 1832 } else if (timeout) { 1833 /* 1834 * Avoid the unnecessary trip to the wait queue loop, if the 1835 * caller specified a non blocking operation. 1836 */ 1837 timed_out = 1; 1838 } 1839 1840 /* 1841 * This call is racy: We may or may not see events that are being added 1842 * to the ready list under the lock (e.g., in IRQ callbacks). For cases 1843 * with a non-zero timeout, this thread will check the ready list under 1844 * lock and will add to the wait queue. For cases with a zero 1845 * timeout, the user by definition should not care and will have to 1846 * recheck again. 1847 */ 1848 eavail = ep_events_available(ep); 1849 1850 while (1) { 1851 if (eavail) { 1852 /* 1853 * Try to transfer events to user space. In case we get 1854 * 0 events and there's still timeout left over, we go 1855 * trying again in search of more luck. 1856 */ 1857 res = ep_send_events(ep, events, maxevents); 1858 if (res) 1859 return res; 1860 } 1861 1862 if (timed_out) 1863 return 0; 1864 1865 eavail = ep_busy_loop(ep, timed_out); 1866 if (eavail) 1867 continue; 1868 1869 if (signal_pending(current)) 1870 return -EINTR; 1871 1872 /* 1873 * Internally init_wait() uses autoremove_wake_function(), 1874 * thus wait entry is removed from the wait queue on each 1875 * wakeup. Why it is important? In case of several waiters 1876 * each new wakeup will hit the next waiter, giving it the 1877 * chance to harvest new event. Otherwise wakeup can be 1878 * lost. This is also good performance-wise, because on 1879 * normal wakeup path no need to call __remove_wait_queue() 1880 * explicitly, thus ep->lock is not taken, which halts the 1881 * event delivery. 1882 * 1883 * In fact, we now use an even more aggressive function that 1884 * unconditionally removes, because we don't reuse the wait 1885 * entry between loop iterations. This lets us also avoid the 1886 * performance issue if a process is killed, causing all of its 1887 * threads to wake up without being removed normally. 1888 */ 1889 init_wait(&wait); 1890 wait.func = ep_autoremove_wake_function; 1891 1892 write_lock_irq(&ep->lock); 1893 /* 1894 * Barrierless variant, waitqueue_active() is called under 1895 * the same lock on wakeup ep_poll_callback() side, so it 1896 * is safe to avoid an explicit barrier. 1897 */ 1898 __set_current_state(TASK_INTERRUPTIBLE); 1899 1900 /* 1901 * Do the final check under the lock. ep_start/done_scan() 1902 * plays with two lists (->rdllist and ->ovflist) and there 1903 * is always a race when both lists are empty for short 1904 * period of time although events are pending, so lock is 1905 * important. 1906 */ 1907 eavail = ep_events_available(ep); 1908 if (!eavail) 1909 __add_wait_queue_exclusive(&ep->wq, &wait); 1910 1911 write_unlock_irq(&ep->lock); 1912 1913 if (!eavail) 1914 timed_out = !schedule_hrtimeout_range(to, slack, 1915 HRTIMER_MODE_ABS); 1916 __set_current_state(TASK_RUNNING); 1917 1918 /* 1919 * We were woken up, thus go and try to harvest some events. 1920 * If timed out and still on the wait queue, recheck eavail 1921 * carefully under lock, below. 1922 */ 1923 eavail = 1; 1924 1925 if (!list_empty_careful(&wait.entry)) { 1926 write_lock_irq(&ep->lock); 1927 /* 1928 * If the thread timed out and is not on the wait queue, 1929 * it means that the thread was woken up after its 1930 * timeout expired before it could reacquire the lock. 1931 * Thus, when wait.entry is empty, it needs to harvest 1932 * events. 1933 */ 1934 if (timed_out) 1935 eavail = list_empty(&wait.entry); 1936 __remove_wait_queue(&ep->wq, &wait); 1937 write_unlock_irq(&ep->lock); 1938 } 1939 } 1940 } 1941 1942 /** 1943 * ep_loop_check_proc - verify that adding an epoll file inside another 1944 * epoll structure does not violate the constraints, in 1945 * terms of closed loops, or too deep chains (which can 1946 * result in excessive stack usage). 1947 * 1948 * @ep: the &struct eventpoll to be currently checked. 1949 * @depth: Current depth of the path being checked. 1950 * 1951 * Return: %zero if adding the epoll @file inside current epoll 1952 * structure @ep does not violate the constraints, or %-1 otherwise. 1953 */ 1954 static int ep_loop_check_proc(struct eventpoll *ep, int depth) 1955 { 1956 int error = 0; 1957 struct rb_node *rbp; 1958 struct epitem *epi; 1959 1960 mutex_lock_nested(&ep->mtx, depth + 1); 1961 ep->gen = loop_check_gen; 1962 for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) { 1963 epi = rb_entry(rbp, struct epitem, rbn); 1964 if (unlikely(is_file_epoll(epi->ffd.file))) { 1965 struct eventpoll *ep_tovisit; 1966 ep_tovisit = epi->ffd.file->private_data; 1967 if (ep_tovisit->gen == loop_check_gen) 1968 continue; 1969 if (ep_tovisit == inserting_into || depth > EP_MAX_NESTS) 1970 error = -1; 1971 else 1972 error = ep_loop_check_proc(ep_tovisit, depth + 1); 1973 if (error != 0) 1974 break; 1975 } else { 1976 /* 1977 * If we've reached a file that is not associated with 1978 * an ep, then we need to check if the newly added 1979 * links are going to add too many wakeup paths. We do 1980 * this by adding it to the tfile_check_list, if it's 1981 * not already there, and calling reverse_path_check() 1982 * during ep_insert(). 1983 */ 1984 list_file(epi->ffd.file); 1985 } 1986 } 1987 mutex_unlock(&ep->mtx); 1988 1989 return error; 1990 } 1991 1992 /** 1993 * ep_loop_check - Performs a check to verify that adding an epoll file (@to) 1994 * into another epoll file (represented by @ep) does not create 1995 * closed loops or too deep chains. 1996 * 1997 * @ep: Pointer to the epoll we are inserting into. 1998 * @to: Pointer to the epoll to be inserted. 1999 * 2000 * Return: %zero if adding the epoll @to inside the epoll @from 2001 * does not violate the constraints, or %-1 otherwise. 2002 */ 2003 static int ep_loop_check(struct eventpoll *ep, struct eventpoll *to) 2004 { 2005 inserting_into = ep; 2006 return ep_loop_check_proc(to, 0); 2007 } 2008 2009 static void clear_tfile_check_list(void) 2010 { 2011 rcu_read_lock(); 2012 while (tfile_check_list != EP_UNACTIVE_PTR) { 2013 struct epitems_head *head = tfile_check_list; 2014 tfile_check_list = head->next; 2015 unlist_file(head); 2016 } 2017 rcu_read_unlock(); 2018 } 2019 2020 /* 2021 * Open an eventpoll file descriptor. 2022 */ 2023 static int do_epoll_create(int flags) 2024 { 2025 int error, fd; 2026 struct eventpoll *ep = NULL; 2027 struct file *file; 2028 2029 /* Check the EPOLL_* constant for consistency. */ 2030 BUILD_BUG_ON(EPOLL_CLOEXEC != O_CLOEXEC); 2031 2032 if (flags & ~EPOLL_CLOEXEC) 2033 return -EINVAL; 2034 /* 2035 * Create the internal data structure ("struct eventpoll"). 2036 */ 2037 error = ep_alloc(&ep); 2038 if (error < 0) 2039 return error; 2040 /* 2041 * Creates all the items needed to setup an eventpoll file. That is, 2042 * a file structure and a free file descriptor. 2043 */ 2044 fd = get_unused_fd_flags(O_RDWR | (flags & O_CLOEXEC)); 2045 if (fd < 0) { 2046 error = fd; 2047 goto out_free_ep; 2048 } 2049 file = anon_inode_getfile("[eventpoll]", &eventpoll_fops, ep, 2050 O_RDWR | (flags & O_CLOEXEC)); 2051 if (IS_ERR(file)) { 2052 error = PTR_ERR(file); 2053 goto out_free_fd; 2054 } 2055 ep->file = file; 2056 fd_install(fd, file); 2057 return fd; 2058 2059 out_free_fd: 2060 put_unused_fd(fd); 2061 out_free_ep: 2062 ep_clear_and_put(ep); 2063 return error; 2064 } 2065 2066 SYSCALL_DEFINE1(epoll_create1, int, flags) 2067 { 2068 return do_epoll_create(flags); 2069 } 2070 2071 SYSCALL_DEFINE1(epoll_create, int, size) 2072 { 2073 if (size <= 0) 2074 return -EINVAL; 2075 2076 return do_epoll_create(0); 2077 } 2078 2079 #ifdef CONFIG_PM_SLEEP 2080 static inline void ep_take_care_of_epollwakeup(struct epoll_event *epev) 2081 { 2082 if ((epev->events & EPOLLWAKEUP) && !capable(CAP_BLOCK_SUSPEND)) 2083 epev->events &= ~EPOLLWAKEUP; 2084 } 2085 #else 2086 static inline void ep_take_care_of_epollwakeup(struct epoll_event *epev) 2087 { 2088 epev->events &= ~EPOLLWAKEUP; 2089 } 2090 #endif 2091 2092 static inline int epoll_mutex_lock(struct mutex *mutex, int depth, 2093 bool nonblock) 2094 { 2095 if (!nonblock) { 2096 mutex_lock_nested(mutex, depth); 2097 return 0; 2098 } 2099 if (mutex_trylock(mutex)) 2100 return 0; 2101 return -EAGAIN; 2102 } 2103 2104 int do_epoll_ctl(int epfd, int op, int fd, struct epoll_event *epds, 2105 bool nonblock) 2106 { 2107 int error; 2108 int full_check = 0; 2109 struct fd f, tf; 2110 struct eventpoll *ep; 2111 struct epitem *epi; 2112 struct eventpoll *tep = NULL; 2113 2114 error = -EBADF; 2115 f = fdget(epfd); 2116 if (!f.file) 2117 goto error_return; 2118 2119 /* Get the "struct file *" for the target file */ 2120 tf = fdget(fd); 2121 if (!tf.file) 2122 goto error_fput; 2123 2124 /* The target file descriptor must support poll */ 2125 error = -EPERM; 2126 if (!file_can_poll(tf.file)) 2127 goto error_tgt_fput; 2128 2129 /* Check if EPOLLWAKEUP is allowed */ 2130 if (ep_op_has_event(op)) 2131 ep_take_care_of_epollwakeup(epds); 2132 2133 /* 2134 * We have to check that the file structure underneath the file descriptor 2135 * the user passed to us _is_ an eventpoll file. And also we do not permit 2136 * adding an epoll file descriptor inside itself. 2137 */ 2138 error = -EINVAL; 2139 if (f.file == tf.file || !is_file_epoll(f.file)) 2140 goto error_tgt_fput; 2141 2142 /* 2143 * epoll adds to the wakeup queue at EPOLL_CTL_ADD time only, 2144 * so EPOLLEXCLUSIVE is not allowed for a EPOLL_CTL_MOD operation. 2145 * Also, we do not currently supported nested exclusive wakeups. 2146 */ 2147 if (ep_op_has_event(op) && (epds->events & EPOLLEXCLUSIVE)) { 2148 if (op == EPOLL_CTL_MOD) 2149 goto error_tgt_fput; 2150 if (op == EPOLL_CTL_ADD && (is_file_epoll(tf.file) || 2151 (epds->events & ~EPOLLEXCLUSIVE_OK_BITS))) 2152 goto error_tgt_fput; 2153 } 2154 2155 /* 2156 * At this point it is safe to assume that the "private_data" contains 2157 * our own data structure. 2158 */ 2159 ep = f.file->private_data; 2160 2161 /* 2162 * When we insert an epoll file descriptor inside another epoll file 2163 * descriptor, there is the chance of creating closed loops, which are 2164 * better be handled here, than in more critical paths. While we are 2165 * checking for loops we also determine the list of files reachable 2166 * and hang them on the tfile_check_list, so we can check that we 2167 * haven't created too many possible wakeup paths. 2168 * 2169 * We do not need to take the global 'epumutex' on EPOLL_CTL_ADD when 2170 * the epoll file descriptor is attaching directly to a wakeup source, 2171 * unless the epoll file descriptor is nested. The purpose of taking the 2172 * 'epnested_mutex' on add is to prevent complex toplogies such as loops and 2173 * deep wakeup paths from forming in parallel through multiple 2174 * EPOLL_CTL_ADD operations. 2175 */ 2176 error = epoll_mutex_lock(&ep->mtx, 0, nonblock); 2177 if (error) 2178 goto error_tgt_fput; 2179 if (op == EPOLL_CTL_ADD) { 2180 if (READ_ONCE(f.file->f_ep) || ep->gen == loop_check_gen || 2181 is_file_epoll(tf.file)) { 2182 mutex_unlock(&ep->mtx); 2183 error = epoll_mutex_lock(&epnested_mutex, 0, nonblock); 2184 if (error) 2185 goto error_tgt_fput; 2186 loop_check_gen++; 2187 full_check = 1; 2188 if (is_file_epoll(tf.file)) { 2189 tep = tf.file->private_data; 2190 error = -ELOOP; 2191 if (ep_loop_check(ep, tep) != 0) 2192 goto error_tgt_fput; 2193 } 2194 error = epoll_mutex_lock(&ep->mtx, 0, nonblock); 2195 if (error) 2196 goto error_tgt_fput; 2197 } 2198 } 2199 2200 /* 2201 * Try to lookup the file inside our RB tree. Since we grabbed "mtx" 2202 * above, we can be sure to be able to use the item looked up by 2203 * ep_find() till we release the mutex. 2204 */ 2205 epi = ep_find(ep, tf.file, fd); 2206 2207 error = -EINVAL; 2208 switch (op) { 2209 case EPOLL_CTL_ADD: 2210 if (!epi) { 2211 epds->events |= EPOLLERR | EPOLLHUP; 2212 error = ep_insert(ep, epds, tf.file, fd, full_check); 2213 } else 2214 error = -EEXIST; 2215 break; 2216 case EPOLL_CTL_DEL: 2217 if (epi) { 2218 /* 2219 * The eventpoll itself is still alive: the refcount 2220 * can't go to zero here. 2221 */ 2222 ep_remove_safe(ep, epi); 2223 error = 0; 2224 } else { 2225 error = -ENOENT; 2226 } 2227 break; 2228 case EPOLL_CTL_MOD: 2229 if (epi) { 2230 if (!(epi->event.events & EPOLLEXCLUSIVE)) { 2231 epds->events |= EPOLLERR | EPOLLHUP; 2232 error = ep_modify(ep, epi, epds); 2233 } 2234 } else 2235 error = -ENOENT; 2236 break; 2237 } 2238 mutex_unlock(&ep->mtx); 2239 2240 error_tgt_fput: 2241 if (full_check) { 2242 clear_tfile_check_list(); 2243 loop_check_gen++; 2244 mutex_unlock(&epnested_mutex); 2245 } 2246 2247 fdput(tf); 2248 error_fput: 2249 fdput(f); 2250 error_return: 2251 2252 return error; 2253 } 2254 2255 /* 2256 * The following function implements the controller interface for 2257 * the eventpoll file that enables the insertion/removal/change of 2258 * file descriptors inside the interest set. 2259 */ 2260 SYSCALL_DEFINE4(epoll_ctl, int, epfd, int, op, int, fd, 2261 struct epoll_event __user *, event) 2262 { 2263 struct epoll_event epds; 2264 2265 if (ep_op_has_event(op) && 2266 copy_from_user(&epds, event, sizeof(struct epoll_event))) 2267 return -EFAULT; 2268 2269 return do_epoll_ctl(epfd, op, fd, &epds, false); 2270 } 2271 2272 /* 2273 * Implement the event wait interface for the eventpoll file. It is the kernel 2274 * part of the user space epoll_wait(2). 2275 */ 2276 static int do_epoll_wait(int epfd, struct epoll_event __user *events, 2277 int maxevents, struct timespec64 *to) 2278 { 2279 int error; 2280 struct fd f; 2281 struct eventpoll *ep; 2282 2283 /* The maximum number of event must be greater than zero */ 2284 if (maxevents <= 0 || maxevents > EP_MAX_EVENTS) 2285 return -EINVAL; 2286 2287 /* Verify that the area passed by the user is writeable */ 2288 if (!access_ok(events, maxevents * sizeof(struct epoll_event))) 2289 return -EFAULT; 2290 2291 /* Get the "struct file *" for the eventpoll file */ 2292 f = fdget(epfd); 2293 if (!f.file) 2294 return -EBADF; 2295 2296 /* 2297 * We have to check that the file structure underneath the fd 2298 * the user passed to us _is_ an eventpoll file. 2299 */ 2300 error = -EINVAL; 2301 if (!is_file_epoll(f.file)) 2302 goto error_fput; 2303 2304 /* 2305 * At this point it is safe to assume that the "private_data" contains 2306 * our own data structure. 2307 */ 2308 ep = f.file->private_data; 2309 2310 /* Time to fish for events ... */ 2311 error = ep_poll(ep, events, maxevents, to); 2312 2313 error_fput: 2314 fdput(f); 2315 return error; 2316 } 2317 2318 SYSCALL_DEFINE4(epoll_wait, int, epfd, struct epoll_event __user *, events, 2319 int, maxevents, int, timeout) 2320 { 2321 struct timespec64 to; 2322 2323 return do_epoll_wait(epfd, events, maxevents, 2324 ep_timeout_to_timespec(&to, timeout)); 2325 } 2326 2327 /* 2328 * Implement the event wait interface for the eventpoll file. It is the kernel 2329 * part of the user space epoll_pwait(2). 2330 */ 2331 static int do_epoll_pwait(int epfd, struct epoll_event __user *events, 2332 int maxevents, struct timespec64 *to, 2333 const sigset_t __user *sigmask, size_t sigsetsize) 2334 { 2335 int error; 2336 2337 /* 2338 * If the caller wants a certain signal mask to be set during the wait, 2339 * we apply it here. 2340 */ 2341 error = set_user_sigmask(sigmask, sigsetsize); 2342 if (error) 2343 return error; 2344 2345 error = do_epoll_wait(epfd, events, maxevents, to); 2346 2347 restore_saved_sigmask_unless(error == -EINTR); 2348 2349 return error; 2350 } 2351 2352 SYSCALL_DEFINE6(epoll_pwait, int, epfd, struct epoll_event __user *, events, 2353 int, maxevents, int, timeout, const sigset_t __user *, sigmask, 2354 size_t, sigsetsize) 2355 { 2356 struct timespec64 to; 2357 2358 return do_epoll_pwait(epfd, events, maxevents, 2359 ep_timeout_to_timespec(&to, timeout), 2360 sigmask, sigsetsize); 2361 } 2362 2363 SYSCALL_DEFINE6(epoll_pwait2, int, epfd, struct epoll_event __user *, events, 2364 int, maxevents, const struct __kernel_timespec __user *, timeout, 2365 const sigset_t __user *, sigmask, size_t, sigsetsize) 2366 { 2367 struct timespec64 ts, *to = NULL; 2368 2369 if (timeout) { 2370 if (get_timespec64(&ts, timeout)) 2371 return -EFAULT; 2372 to = &ts; 2373 if (poll_select_set_timeout(to, ts.tv_sec, ts.tv_nsec)) 2374 return -EINVAL; 2375 } 2376 2377 return do_epoll_pwait(epfd, events, maxevents, to, 2378 sigmask, sigsetsize); 2379 } 2380 2381 #ifdef CONFIG_COMPAT 2382 static int do_compat_epoll_pwait(int epfd, struct epoll_event __user *events, 2383 int maxevents, struct timespec64 *timeout, 2384 const compat_sigset_t __user *sigmask, 2385 compat_size_t sigsetsize) 2386 { 2387 long err; 2388 2389 /* 2390 * If the caller wants a certain signal mask to be set during the wait, 2391 * we apply it here. 2392 */ 2393 err = set_compat_user_sigmask(sigmask, sigsetsize); 2394 if (err) 2395 return err; 2396 2397 err = do_epoll_wait(epfd, events, maxevents, timeout); 2398 2399 restore_saved_sigmask_unless(err == -EINTR); 2400 2401 return err; 2402 } 2403 2404 COMPAT_SYSCALL_DEFINE6(epoll_pwait, int, epfd, 2405 struct epoll_event __user *, events, 2406 int, maxevents, int, timeout, 2407 const compat_sigset_t __user *, sigmask, 2408 compat_size_t, sigsetsize) 2409 { 2410 struct timespec64 to; 2411 2412 return do_compat_epoll_pwait(epfd, events, maxevents, 2413 ep_timeout_to_timespec(&to, timeout), 2414 sigmask, sigsetsize); 2415 } 2416 2417 COMPAT_SYSCALL_DEFINE6(epoll_pwait2, int, epfd, 2418 struct epoll_event __user *, events, 2419 int, maxevents, 2420 const struct __kernel_timespec __user *, timeout, 2421 const compat_sigset_t __user *, sigmask, 2422 compat_size_t, sigsetsize) 2423 { 2424 struct timespec64 ts, *to = NULL; 2425 2426 if (timeout) { 2427 if (get_timespec64(&ts, timeout)) 2428 return -EFAULT; 2429 to = &ts; 2430 if (poll_select_set_timeout(to, ts.tv_sec, ts.tv_nsec)) 2431 return -EINVAL; 2432 } 2433 2434 return do_compat_epoll_pwait(epfd, events, maxevents, to, 2435 sigmask, sigsetsize); 2436 } 2437 2438 #endif 2439 2440 static int __init eventpoll_init(void) 2441 { 2442 struct sysinfo si; 2443 2444 si_meminfo(&si); 2445 /* 2446 * Allows top 4% of lomem to be allocated for epoll watches (per user). 2447 */ 2448 max_user_watches = (((si.totalram - si.totalhigh) / 25) << PAGE_SHIFT) / 2449 EP_ITEM_COST; 2450 BUG_ON(max_user_watches < 0); 2451 2452 /* 2453 * We can have many thousands of epitems, so prevent this from 2454 * using an extra cache line on 64-bit (and smaller) CPUs 2455 */ 2456 BUILD_BUG_ON(sizeof(void *) <= 8 && sizeof(struct epitem) > 128); 2457 2458 /* Allocates slab cache used to allocate "struct epitem" items */ 2459 epi_cache = kmem_cache_create("eventpoll_epi", sizeof(struct epitem), 2460 0, SLAB_HWCACHE_ALIGN|SLAB_PANIC|SLAB_ACCOUNT, NULL); 2461 2462 /* Allocates slab cache used to allocate "struct eppoll_entry" */ 2463 pwq_cache = kmem_cache_create("eventpoll_pwq", 2464 sizeof(struct eppoll_entry), 0, SLAB_PANIC|SLAB_ACCOUNT, NULL); 2465 epoll_sysctls_init(); 2466 2467 ephead_cache = kmem_cache_create("ep_head", 2468 sizeof(struct epitems_head), 0, SLAB_PANIC|SLAB_ACCOUNT, NULL); 2469 2470 return 0; 2471 } 2472 fs_initcall(eventpoll_init); 2473