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