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