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