active-standby: add cmdline into /proc/net/
[linux-2.6.git] / fs / eventpoll.c
1 /*
2  *  fs/eventpoll.c (Efficient event retrieval implementation)
3  *  Copyright (C) 2001,...,2009  Davide Libenzi
4  *
5  *  This program is free software; you can redistribute it and/or modify
6  *  it under the terms of the GNU General Public License as published by
7  *  the Free Software Foundation; either version 2 of the License, or
8  *  (at your option) any later version.
9  *
10  *  Davide Libenzi <davidel@xmailserver.org>
11  *
12  * Copyright (c) 2013, NVIDIA CORPORATION.  All rights reserved.
13  *
14  */
15
16 #include <linux/init.h>
17 #include <linux/kernel.h>
18 #include <linux/sched.h>
19 #include <linux/fs.h>
20 #include <linux/file.h>
21 #include <linux/signal.h>
22 #include <linux/errno.h>
23 #include <linux/mm.h>
24 #include <linux/slab.h>
25 #include <linux/poll.h>
26 #include <linux/string.h>
27 #include <linux/list.h>
28 #include <linux/hash.h>
29 #include <linux/spinlock.h>
30 #include <linux/syscalls.h>
31 #include <linux/rbtree.h>
32 #include <linux/wait.h>
33 #include <linux/eventpoll.h>
34 #include <linux/mount.h>
35 #include <linux/bitops.h>
36 #include <linux/mutex.h>
37 #include <linux/anon_inodes.h>
38 #include <linux/device.h>
39 #include <asm/uaccess.h>
40 #include <asm/io.h>
41 #include <asm/mman.h>
42 #include <linux/atomic.h>
43
44 /*
45  * LOCKING:
46  * There are three level of locking required by epoll :
47  *
48  * 1) epmutex (mutex)
49  * 2) ep->mtx (mutex)
50  * 3) ep->lock (spinlock)
51  *
52  * The acquire order is the one listed above, from 1 to 3.
53  * We need a spinlock (ep->lock) because we manipulate objects
54  * from inside the poll callback, that might be triggered from
55  * a wake_up() that in turn might be called from IRQ context.
56  * So we can't sleep inside the poll callback and hence we need
57  * a spinlock. During the event transfer loop (from kernel to
58  * user space) we could end up sleeping due a copy_to_user(), so
59  * we need a lock that will allow us to sleep. This lock is a
60  * mutex (ep->mtx). It is acquired during the event transfer loop,
61  * during epoll_ctl(EPOLL_CTL_DEL) and during eventpoll_release_file().
62  * Then we also need a global mutex to serialize eventpoll_release_file()
63  * and ep_free().
64  * This mutex is acquired by ep_free() during the epoll file
65  * cleanup path and it is also acquired by eventpoll_release_file()
66  * if a file has been pushed inside an epoll set and it is then
67  * close()d without a previous call to epoll_ctl(EPOLL_CTL_DEL).
68  * It is also acquired when inserting an epoll fd onto another epoll
69  * fd. We do this so that we walk the epoll tree and ensure that this
70  * insertion does not create a cycle of epoll file descriptors, which
71  * could lead to deadlock. We need a global mutex to prevent two
72  * simultaneous inserts (A into B and B into A) from racing and
73  * constructing a cycle without either insert observing that it is
74  * going to.
75  * It is necessary to acquire multiple "ep->mtx"es at once in the
76  * case when one epoll fd is added to another. In this case, we
77  * always acquire the locks in the order of nesting (i.e. after
78  * epoll_ctl(e1, EPOLL_CTL_ADD, e2), e1->mtx will always be acquired
79  * before e2->mtx). Since we disallow cycles of epoll file
80  * descriptors, this ensures that the mutexes are well-ordered. In
81  * order to communicate this nesting to lockdep, when walking a tree
82  * of epoll file descriptors, we use the current recursion depth as
83  * the lockdep subkey.
84  * It is possible to drop the "ep->mtx" and to use the global
85  * mutex "epmutex" (together with "ep->lock") to have it working,
86  * but having "ep->mtx" will make the interface more scalable.
87  * Events that require holding "epmutex" are very rare, while for
88  * normal operations the epoll private "ep->mtx" will guarantee
89  * a better scalability.
90  */
91
92 /* Epoll private bits inside the event mask */
93 #define EP_PRIVATE_BITS (EPOLLWAKEUP | EPOLLONESHOT | EPOLLET)
94
95 /* Maximum number of nesting allowed inside epoll sets */
96 #define EP_MAX_NESTS 4
97
98 #define EP_MAX_EVENTS (INT_MAX / sizeof(struct epoll_event))
99
100 #define EP_UNACTIVE_PTR ((void *) -1L)
101
102 #define EP_ITEM_COST (sizeof(struct epitem) + sizeof(struct eppoll_entry))
103
104 struct epoll_filefd {
105         struct file *file;
106         int fd;
107 };
108
109 /*
110  * Structure used to track possible nested calls, for too deep recursions
111  * and loop cycles.
112  */
113 struct nested_call_node {
114         struct list_head llink;
115         void *cookie;
116         void *ctx;
117 };
118
119 /*
120  * This structure is used as collector for nested calls, to check for
121  * maximum recursion dept and loop cycles.
122  */
123 struct nested_calls {
124         struct list_head tasks_call_list;
125         spinlock_t lock;
126 };
127
128 /*
129  * Each file descriptor added to the eventpoll interface will
130  * have an entry of this type linked to the "rbr" RB tree.
131  */
132 struct epitem {
133         /* RB tree node used to link this structure to the eventpoll RB tree */
134         struct rb_node rbn;
135
136         /* List header used to link this structure to the eventpoll ready list */
137         struct list_head rdllink;
138
139         /*
140          * Works together "struct eventpoll"->ovflist in keeping the
141          * single linked chain of items.
142          */
143         struct epitem *next;
144
145         /* The file descriptor information this item refers to */
146         struct epoll_filefd ffd;
147
148         /* Number of active wait queue attached to poll operations */
149         int nwait;
150
151         /* List containing poll wait queues */
152         struct list_head pwqlist;
153
154         /* The "container" of this item */
155         struct eventpoll *ep;
156
157         /* List header used to link this item to the "struct file" items list */
158         struct list_head fllink;
159
160         /* wakeup_source used when EPOLLWAKEUP is set */
161         struct wakeup_source *ws;
162
163         /* The structure that describe the interested events and the source fd */
164         struct epoll_event event;
165 };
166
167 /*
168  * This structure is stored inside the "private_data" member of the file
169  * structure and represents the main data structure for the eventpoll
170  * interface.
171  */
172 struct eventpoll {
173         /* Protect the access to this structure */
174         spinlock_t lock;
175
176         /*
177          * This mutex is used to ensure that files are not removed
178          * while epoll is using them. This is held during the event
179          * collection loop, the file cleanup path, the epoll file exit
180          * code and the ctl operations.
181          */
182         struct mutex mtx;
183
184         /* Wait queue used by sys_epoll_wait() */
185         wait_queue_head_t wq;
186
187         /* Wait queue used by file->poll() */
188         wait_queue_head_t poll_wait;
189
190         /* List of ready file descriptors */
191         struct list_head rdllist;
192
193         /* RB tree root used to store monitored fd structs */
194         struct rb_root rbr;
195
196         /*
197          * This is a single linked list that chains all the "struct epitem" that
198          * happened while transferring ready events to userspace w/out
199          * holding ->lock.
200          */
201         struct epitem *ovflist;
202
203         /* wakeup_source used when ep_scan_ready_list is running */
204         struct wakeup_source *ws;
205
206         /* The user that created the eventpoll descriptor */
207         struct user_struct *user;
208
209         struct file *file;
210
211         /* used to optimize loop detection check */
212         int visited;
213         struct list_head visited_list_link;
214 };
215
216 /* Wait structure used by the poll hooks */
217 struct eppoll_entry {
218         /* List header used to link this structure to the "struct epitem" */
219         struct list_head llink;
220
221         /* The "base" pointer is set to the container "struct epitem" */
222         struct epitem *base;
223
224         /*
225          * Wait queue item that will be linked to the target file wait
226          * queue head.
227          */
228         wait_queue_t wait;
229
230         /* The wait queue head that linked the "wait" wait queue item */
231         wait_queue_head_t *whead;
232 };
233
234 /* Wrapper struct used by poll queueing */
235 struct ep_pqueue {
236         poll_table pt;
237         struct epitem *epi;
238 };
239
240 /* Used by the ep_send_events() function as callback private data */
241 struct ep_send_events_data {
242         int maxevents;
243         struct epoll_event __user *events;
244 };
245
246 /*
247  * Configuration options available inside /proc/sys/fs/epoll/
248  */
249 /* Maximum number of epoll watched descriptors, per user */
250 static long max_user_watches __read_mostly;
251
252 /*
253  * This mutex is used to serialize ep_free() and eventpoll_release_file().
254  */
255 static DEFINE_MUTEX(epmutex);
256
257 /* Used to check for epoll file descriptor inclusion loops */
258 static struct nested_calls poll_loop_ncalls;
259
260 /* Used for safe wake up implementation */
261 static struct nested_calls poll_safewake_ncalls;
262
263 /* Used to call file's f_op->poll() under the nested calls boundaries */
264 static struct nested_calls poll_readywalk_ncalls;
265
266 /* Slab cache used to allocate "struct epitem" */
267 static struct kmem_cache *epi_cache __read_mostly;
268
269 /* Slab cache used to allocate "struct eppoll_entry" */
270 static struct kmem_cache *pwq_cache __read_mostly;
271
272 /* Visited nodes during ep_loop_check(), so we can unset them when we finish */
273 static LIST_HEAD(visited_list);
274
275 /*
276  * List of files with newly added links, where we may need to limit the number
277  * of emanating paths. Protected by the epmutex.
278  */
279 static LIST_HEAD(tfile_check_list);
280
281 #ifdef CONFIG_SYSCTL
282
283 #include <linux/sysctl.h>
284
285 static long zero;
286 static long long_max = LONG_MAX;
287
288 ctl_table epoll_table[] = {
289         {
290                 .procname       = "max_user_watches",
291                 .data           = &max_user_watches,
292                 .maxlen         = sizeof(max_user_watches),
293                 .mode           = 0644,
294                 .proc_handler   = proc_doulongvec_minmax,
295                 .extra1         = &zero,
296                 .extra2         = &long_max,
297         },
298         { }
299 };
300 #endif /* CONFIG_SYSCTL */
301
302 static const struct file_operations eventpoll_fops;
303
304 static inline int is_file_epoll(struct file *f)
305 {
306         return f->f_op == &eventpoll_fops;
307 }
308
309 /* Setup the structure that is used as key for the RB tree */
310 static inline void ep_set_ffd(struct epoll_filefd *ffd,
311                               struct file *file, int fd)
312 {
313         ffd->file = file;
314         ffd->fd = fd;
315 }
316
317 /* Compare RB tree keys */
318 static inline int ep_cmp_ffd(struct epoll_filefd *p1,
319                              struct epoll_filefd *p2)
320 {
321         return (p1->file > p2->file ? +1:
322                 (p1->file < p2->file ? -1 : p1->fd - p2->fd));
323 }
324
325 /* Tells us if the item is currently linked */
326 static inline int ep_is_linked(struct list_head *p)
327 {
328         return !list_empty(p);
329 }
330
331 static inline struct eppoll_entry *ep_pwq_from_wait(wait_queue_t *p)
332 {
333         return container_of(p, struct eppoll_entry, wait);
334 }
335
336 /* Get the "struct epitem" from a wait queue pointer */
337 static inline struct epitem *ep_item_from_wait(wait_queue_t *p)
338 {
339         return container_of(p, struct eppoll_entry, wait)->base;
340 }
341
342 /* Get the "struct epitem" from an epoll queue wrapper */
343 static inline struct epitem *ep_item_from_epqueue(poll_table *p)
344 {
345         return container_of(p, struct ep_pqueue, pt)->epi;
346 }
347
348 /* Tells if the epoll_ctl(2) operation needs an event copy from userspace */
349 static inline int ep_op_has_event(int op)
350 {
351         return op != EPOLL_CTL_DEL;
352 }
353
354 /* Initialize the poll safe wake up structure */
355 static void ep_nested_calls_init(struct nested_calls *ncalls)
356 {
357         INIT_LIST_HEAD(&ncalls->tasks_call_list);
358         spin_lock_init(&ncalls->lock);
359 }
360
361 /**
362  * ep_events_available - Checks if ready events might be available.
363  *
364  * @ep: Pointer to the eventpoll context.
365  *
366  * Returns: Returns a value different than zero if ready events are available,
367  *          or zero otherwise.
368  */
369 static inline int ep_events_available(struct eventpoll *ep)
370 {
371         return !list_empty(&ep->rdllist) || ep->ovflist != EP_UNACTIVE_PTR;
372 }
373
374 /**
375  * ep_call_nested - Perform a bound (possibly) nested call, by checking
376  *                  that the recursion limit is not exceeded, and that
377  *                  the same nested call (by the meaning of same cookie) is
378  *                  no re-entered.
379  *
380  * @ncalls: Pointer to the nested_calls structure to be used for this call.
381  * @max_nests: Maximum number of allowed nesting calls.
382  * @nproc: Nested call core function pointer.
383  * @priv: Opaque data to be passed to the @nproc callback.
384  * @cookie: Cookie to be used to identify this nested call.
385  * @ctx: This instance context.
386  *
387  * Returns: Returns the code returned by the @nproc callback, or -1 if
388  *          the maximum recursion limit has been exceeded.
389  */
390 static int ep_call_nested(struct nested_calls *ncalls, int max_nests,
391                           int (*nproc)(void *, void *, int), void *priv,
392                           void *cookie, void *ctx)
393 {
394         int error, call_nests = 0;
395         unsigned long flags;
396         struct list_head *lsthead = &ncalls->tasks_call_list;
397         struct nested_call_node *tncur;
398         struct nested_call_node tnode;
399
400         spin_lock_irqsave(&ncalls->lock, flags);
401
402         /*
403          * Try to see if the current task is already inside this wakeup call.
404          * We use a list here, since the population inside this set is always
405          * very much limited.
406          */
407         list_for_each_entry(tncur, lsthead, llink) {
408                 if (tncur->ctx == ctx &&
409                     (tncur->cookie == cookie || ++call_nests > max_nests)) {
410                         /*
411                          * Ops ... loop detected or maximum nest level reached.
412                          * We abort this wake by breaking the cycle itself.
413                          */
414                         error = -1;
415                         goto out_unlock;
416                 }
417         }
418
419         /* Add the current task and cookie to the list */
420         tnode.ctx = ctx;
421         tnode.cookie = cookie;
422         list_add(&tnode.llink, lsthead);
423
424         spin_unlock_irqrestore(&ncalls->lock, flags);
425
426         /* Call the nested function */
427         error = (*nproc)(priv, cookie, call_nests);
428
429         /* Remove the current task from the list */
430         spin_lock_irqsave(&ncalls->lock, flags);
431         list_del(&tnode.llink);
432 out_unlock:
433         spin_unlock_irqrestore(&ncalls->lock, flags);
434
435         return error;
436 }
437
438 /*
439  * As described in commit 0ccf831cb lockdep: annotate epoll
440  * the use of wait queues used by epoll is done in a very controlled
441  * manner. Wake ups can nest inside each other, but are never done
442  * with the same locking. For example:
443  *
444  *   dfd = socket(...);
445  *   efd1 = epoll_create();
446  *   efd2 = epoll_create();
447  *   epoll_ctl(efd1, EPOLL_CTL_ADD, dfd, ...);
448  *   epoll_ctl(efd2, EPOLL_CTL_ADD, efd1, ...);
449  *
450  * When a packet arrives to the device underneath "dfd", the net code will
451  * issue a wake_up() on its poll wake list. Epoll (efd1) has installed a
452  * callback wakeup entry on that queue, and the wake_up() performed by the
453  * "dfd" net code will end up in ep_poll_callback(). At this point epoll
454  * (efd1) notices that it may have some event ready, so it needs to wake up
455  * the waiters on its poll wait list (efd2). So it calls ep_poll_safewake()
456  * that ends up in another wake_up(), after having checked about the
457  * recursion constraints. That are, no more than EP_MAX_POLLWAKE_NESTS, to
458  * avoid stack blasting.
459  *
460  * When CONFIG_DEBUG_LOCK_ALLOC is enabled, make sure lockdep can handle
461  * this special case of epoll.
462  */
463 #ifdef CONFIG_DEBUG_LOCK_ALLOC
464 static inline void ep_wake_up_nested(wait_queue_head_t *wqueue,
465                                      unsigned long events, int subclass)
466 {
467         unsigned long flags;
468
469         spin_lock_irqsave_nested(&wqueue->lock, flags, subclass);
470         wake_up_locked_poll(wqueue, events);
471         spin_unlock_irqrestore(&wqueue->lock, flags);
472 }
473 #else
474 static inline void ep_wake_up_nested(wait_queue_head_t *wqueue,
475                                      unsigned long events, int subclass)
476 {
477         wake_up_poll(wqueue, events);
478 }
479 #endif
480
481 static int ep_poll_wakeup_proc(void *priv, void *cookie, int call_nests)
482 {
483         ep_wake_up_nested((wait_queue_head_t *) cookie, POLLIN,
484                           1 + call_nests);
485         return 0;
486 }
487
488 /*
489  * Perform a safe wake up of the poll wait list. The problem is that
490  * with the new callback'd wake up system, it is possible that the
491  * poll callback is reentered from inside the call to wake_up() done
492  * on the poll wait queue head. The rule is that we cannot reenter the
493  * wake up code from the same task more than EP_MAX_NESTS times,
494  * and we cannot reenter the same wait queue head at all. This will
495  * enable to have a hierarchy of epoll file descriptor of no more than
496  * EP_MAX_NESTS deep.
497  */
498 static void ep_poll_safewake(wait_queue_head_t *wq)
499 {
500         int this_cpu = get_cpu();
501
502         ep_call_nested(&poll_safewake_ncalls, EP_MAX_NESTS,
503                        ep_poll_wakeup_proc, NULL, wq, (void *) (long) this_cpu);
504
505         put_cpu();
506 }
507
508 static void ep_remove_wait_queue(struct eppoll_entry *pwq)
509 {
510         wait_queue_head_t *whead;
511
512         rcu_read_lock();
513         /* If it is cleared by POLLFREE, it should be rcu-safe */
514         whead = rcu_dereference(pwq->whead);
515         if (whead)
516                 remove_wait_queue(whead, &pwq->wait);
517         rcu_read_unlock();
518 }
519
520 /*
521  * This function unregisters poll callbacks from the associated file
522  * descriptor.  Must be called with "mtx" held (or "epmutex" if called from
523  * ep_free).
524  */
525 static void ep_unregister_pollwait(struct eventpoll *ep, struct epitem *epi)
526 {
527         struct list_head *lsthead = &epi->pwqlist;
528         struct eppoll_entry *pwq;
529
530         while (!list_empty(lsthead)) {
531                 pwq = list_first_entry(lsthead, struct eppoll_entry, llink);
532
533                 list_del(&pwq->llink);
534                 ep_remove_wait_queue(pwq);
535                 kmem_cache_free(pwq_cache, pwq);
536         }
537 }
538
539 /**
540  * ep_scan_ready_list - Scans the ready list in a way that makes possible for
541  *                      the scan code, to call f_op->poll(). Also allows for
542  *                      O(NumReady) performance.
543  *
544  * @ep: Pointer to the epoll private data structure.
545  * @sproc: Pointer to the scan callback.
546  * @priv: Private opaque data passed to the @sproc callback.
547  * @depth: The current depth of recursive f_op->poll calls.
548  *
549  * Returns: The same integer error code returned by the @sproc callback.
550  */
551 static int ep_scan_ready_list(struct eventpoll *ep,
552                               int (*sproc)(struct eventpoll *,
553                                            struct list_head *, void *),
554                               void *priv,
555                               int depth)
556 {
557         int error, pwake = 0;
558         unsigned long flags;
559         struct epitem *epi, *nepi;
560         LIST_HEAD(txlist);
561
562         /*
563          * We need to lock this because we could be hit by
564          * eventpoll_release_file() and epoll_ctl().
565          */
566         mutex_lock_nested(&ep->mtx, depth);
567
568         /*
569          * Steal the ready list, and re-init the original one to the
570          * empty list. Also, set ep->ovflist to NULL so that events
571          * happening while looping w/out locks, are not lost. We cannot
572          * have the poll callback to queue directly on ep->rdllist,
573          * because we want the "sproc" callback to be able to do it
574          * in a lockless way.
575          */
576         spin_lock_irqsave(&ep->lock, flags);
577         list_splice_init(&ep->rdllist, &txlist);
578         ep->ovflist = NULL;
579         spin_unlock_irqrestore(&ep->lock, flags);
580
581         /*
582          * Now call the callback function.
583          */
584         error = (*sproc)(ep, &txlist, priv);
585
586         spin_lock_irqsave(&ep->lock, flags);
587         /*
588          * During the time we spent inside the "sproc" callback, some
589          * other events might have been queued by the poll callback.
590          * We re-insert them inside the main ready-list here.
591          */
592         for (nepi = ep->ovflist; (epi = nepi) != NULL;
593              nepi = epi->next, epi->next = EP_UNACTIVE_PTR) {
594                 /*
595                  * We need to check if the item is already in the list.
596                  * During the "sproc" callback execution time, items are
597                  * queued into ->ovflist but the "txlist" might already
598                  * contain them, and the list_splice() below takes care of them.
599                  */
600                 if (!ep_is_linked(&epi->rdllink)) {
601                         list_add_tail(&epi->rdllink, &ep->rdllist);
602                         __pm_stay_awake(epi->ws);
603                 }
604         }
605         /*
606          * We need to set back ep->ovflist to EP_UNACTIVE_PTR, so that after
607          * releasing the lock, events will be queued in the normal way inside
608          * ep->rdllist.
609          */
610         ep->ovflist = EP_UNACTIVE_PTR;
611
612         /*
613          * Quickly re-inject items left on "txlist".
614          */
615         list_splice(&txlist, &ep->rdllist);
616         __pm_relax(ep->ws);
617
618         if (!list_empty(&ep->rdllist)) {
619                 /*
620                  * Wake up (if active) both the eventpoll wait list and
621                  * the ->poll() wait list (delayed after we release the lock).
622                  */
623                 if (waitqueue_active(&ep->wq))
624                         wake_up_locked(&ep->wq);
625                 if (waitqueue_active(&ep->poll_wait))
626                         pwake++;
627         }
628         spin_unlock_irqrestore(&ep->lock, flags);
629
630         mutex_unlock(&ep->mtx);
631
632         /* We have to call this outside the lock */
633         if (pwake)
634                 ep_poll_safewake(&ep->poll_wait);
635
636         return error;
637 }
638
639 /*
640  * Removes a "struct epitem" from the eventpoll RB tree and deallocates
641  * all the associated resources. Must be called with "mtx" held.
642  */
643 static int ep_remove(struct eventpoll *ep, struct epitem *epi)
644 {
645         unsigned long flags;
646         struct file *file = epi->ffd.file;
647
648         /*
649          * Removes poll wait queue hooks. We _have_ to do this without holding
650          * the "ep->lock" otherwise a deadlock might occur. This because of the
651          * sequence of the lock acquisition. Here we do "ep->lock" then the wait
652          * queue head lock when unregistering the wait queue. The wakeup callback
653          * will run by holding the wait queue head lock and will call our callback
654          * that will try to get "ep->lock".
655          */
656         ep_unregister_pollwait(ep, epi);
657
658         /* Remove the current item from the list of epoll hooks */
659         spin_lock(&file->f_lock);
660         if (ep_is_linked(&epi->fllink))
661                 list_del_init(&epi->fllink);
662         spin_unlock(&file->f_lock);
663
664         rb_erase(&epi->rbn, &ep->rbr);
665
666         spin_lock_irqsave(&ep->lock, flags);
667         if (ep_is_linked(&epi->rdllink))
668                 list_del_init(&epi->rdllink);
669         spin_unlock_irqrestore(&ep->lock, flags);
670
671         wakeup_source_unregister(epi->ws);
672
673         /* At this point it is safe to free the eventpoll item */
674         kmem_cache_free(epi_cache, epi);
675
676         atomic_long_dec(&ep->user->epoll_watches);
677
678         return 0;
679 }
680
681 static void ep_free(struct eventpoll *ep)
682 {
683         struct rb_node *rbp;
684         struct epitem *epi;
685
686         /* We need to release all tasks waiting for these file */
687         if (waitqueue_active(&ep->poll_wait))
688                 ep_poll_safewake(&ep->poll_wait);
689
690         /*
691          * We need to lock this because we could be hit by
692          * eventpoll_release_file() while we're freeing the "struct eventpoll".
693          * We do not need to hold "ep->mtx" here because the epoll file
694          * is on the way to be removed and no one has references to it
695          * anymore. The only hit might come from eventpoll_release_file() but
696          * holding "epmutex" is sufficient here.
697          */
698         mutex_lock(&epmutex);
699
700         /*
701          * Walks through the whole tree by unregistering poll callbacks.
702          */
703         for (rbp = rb_first(&ep->rbr); rbp; rbp = rb_next(rbp)) {
704                 epi = rb_entry(rbp, struct epitem, rbn);
705
706                 ep_unregister_pollwait(ep, epi);
707         }
708
709         /*
710          * Walks through the whole tree by freeing each "struct epitem". At this
711          * point we are sure no poll callbacks will be lingering around, and also by
712          * holding "epmutex" we can be sure that no file cleanup code will hit
713          * us during this operation. So we can avoid the lock on "ep->lock".
714          */
715         while ((rbp = rb_first(&ep->rbr)) != NULL) {
716                 epi = rb_entry(rbp, struct epitem, rbn);
717                 ep_remove(ep, epi);
718         }
719
720         mutex_unlock(&epmutex);
721         mutex_destroy(&ep->mtx);
722         free_uid(ep->user);
723         wakeup_source_unregister(ep->ws);
724         kfree(ep);
725 }
726
727 static int ep_eventpoll_release(struct inode *inode, struct file *file)
728 {
729         struct eventpoll *ep = file->private_data;
730
731         if (ep)
732                 ep_free(ep);
733
734         return 0;
735 }
736
737 static int ep_read_events_proc(struct eventpoll *ep, struct list_head *head,
738                                void *priv)
739 {
740         struct epitem *epi, *tmp;
741         poll_table pt;
742
743         init_poll_funcptr(&pt, NULL);
744         list_for_each_entry_safe(epi, tmp, head, rdllink) {
745                 pt._key = epi->event.events;
746                 if (epi->ffd.file->f_op->poll(epi->ffd.file, &pt) &
747                     epi->event.events)
748                         return POLLIN | POLLRDNORM;
749                 else {
750                         /*
751                          * Item has been dropped into the ready list by the poll
752                          * callback, but it's not actually ready, as far as
753                          * caller requested events goes. We can remove it here.
754                          */
755                         __pm_relax(epi->ws);
756                         list_del_init(&epi->rdllink);
757                 }
758         }
759
760         return 0;
761 }
762
763 static int ep_poll_readyevents_proc(void *priv, void *cookie, int call_nests)
764 {
765         return ep_scan_ready_list(priv, ep_read_events_proc, NULL, call_nests + 1);
766 }
767
768 static unsigned int ep_eventpoll_poll(struct file *file, poll_table *wait)
769 {
770         int pollflags;
771         struct eventpoll *ep = file->private_data;
772
773         /* Insert inside our poll wait queue */
774         poll_wait(file, &ep->poll_wait, wait);
775
776         /*
777          * Proceed to find out if wanted events are really available inside
778          * the ready list. This need to be done under ep_call_nested()
779          * supervision, since the call to f_op->poll() done on listed files
780          * could re-enter here.
781          */
782         pollflags = ep_call_nested(&poll_readywalk_ncalls, EP_MAX_NESTS,
783                                    ep_poll_readyevents_proc, ep, ep, current);
784
785         return pollflags != -1 ? pollflags : 0;
786 }
787
788 /* File callbacks that implement the eventpoll file behaviour */
789 static const struct file_operations eventpoll_fops = {
790         .release        = ep_eventpoll_release,
791         .poll           = ep_eventpoll_poll,
792         .llseek         = noop_llseek,
793 };
794
795 /*
796  * This is called from eventpoll_release() to unlink files from the eventpoll
797  * interface. We need to have this facility to cleanup correctly files that are
798  * closed without being removed from the eventpoll interface.
799  */
800 void eventpoll_release_file(struct file *file)
801 {
802         struct list_head *lsthead = &file->f_ep_links;
803         struct eventpoll *ep;
804         struct epitem *epi;
805
806         /*
807          * We don't want to get "file->f_lock" because it is not
808          * necessary. It is not necessary because we're in the "struct file"
809          * cleanup path, and this means that no one is using this file anymore.
810          * So, for example, epoll_ctl() cannot hit here since if we reach this
811          * point, the file counter already went to zero and fget() would fail.
812          * The only hit might come from ep_free() but by holding the mutex
813          * will correctly serialize the operation. We do need to acquire
814          * "ep->mtx" after "epmutex" because ep_remove() requires it when called
815          * from anywhere but ep_free().
816          *
817          * Besides, ep_remove() acquires the lock, so we can't hold it here.
818          */
819         mutex_lock(&epmutex);
820
821         while (!list_empty(lsthead)) {
822                 epi = list_first_entry(lsthead, struct epitem, fllink);
823
824                 ep = epi->ep;
825                 list_del_init(&epi->fllink);
826                 mutex_lock_nested(&ep->mtx, 0);
827                 ep_remove(ep, epi);
828                 mutex_unlock(&ep->mtx);
829         }
830
831         mutex_unlock(&epmutex);
832 }
833
834 static int ep_alloc(struct eventpoll **pep)
835 {
836         int error;
837         struct user_struct *user;
838         struct eventpoll *ep;
839
840         user = get_current_user();
841         error = -ENOMEM;
842         ep = kzalloc(sizeof(*ep), GFP_KERNEL);
843         if (unlikely(!ep))
844                 goto free_uid;
845
846         spin_lock_init(&ep->lock);
847         mutex_init(&ep->mtx);
848         init_waitqueue_head(&ep->wq);
849         init_waitqueue_head(&ep->poll_wait);
850         INIT_LIST_HEAD(&ep->rdllist);
851         ep->rbr = RB_ROOT;
852         ep->ovflist = EP_UNACTIVE_PTR;
853         ep->user = user;
854
855         *pep = ep;
856
857         return 0;
858
859 free_uid:
860         free_uid(user);
861         return error;
862 }
863
864 /*
865  * Search the file inside the eventpoll tree. The RB tree operations
866  * are protected by the "mtx" mutex, and ep_find() must be called with
867  * "mtx" held.
868  */
869 static struct epitem *ep_find(struct eventpoll *ep, struct file *file, int fd)
870 {
871         int kcmp;
872         struct rb_node *rbp;
873         struct epitem *epi, *epir = NULL;
874         struct epoll_filefd ffd;
875
876         ep_set_ffd(&ffd, file, fd);
877         for (rbp = ep->rbr.rb_node; rbp; ) {
878                 epi = rb_entry(rbp, struct epitem, rbn);
879                 kcmp = ep_cmp_ffd(&ffd, &epi->ffd);
880                 if (kcmp > 0)
881                         rbp = rbp->rb_right;
882                 else if (kcmp < 0)
883                         rbp = rbp->rb_left;
884                 else {
885                         epir = epi;
886                         break;
887                 }
888         }
889
890         return epir;
891 }
892
893 /*
894  * This is the callback that is passed to the wait queue wakeup
895  * mechanism. It is called by the stored file descriptors when they
896  * have events to report.
897  */
898 int ep_poll_callback(wait_queue_t *wait, unsigned mode, int sync, void *key)
899 {
900         int pwake = 0;
901         unsigned long flags;
902         struct epitem *epi = ep_item_from_wait(wait);
903         struct eventpoll *ep = epi->ep;
904
905         if ((unsigned long)key & POLLFREE) {
906                 ep_pwq_from_wait(wait)->whead = NULL;
907                 /*
908                  * whead = NULL above can race with ep_remove_wait_queue()
909                  * which can do another remove_wait_queue() after us, so we
910                  * can't use __remove_wait_queue(). whead->lock is held by
911                  * the caller.
912                  */
913                 list_del_init(&wait->task_list);
914         }
915
916         spin_lock_irqsave(&ep->lock, flags);
917
918         /*
919          * If the event mask does not contain any poll(2) event, we consider the
920          * descriptor to be disabled. This condition is likely the effect of the
921          * EPOLLONESHOT bit that disables the descriptor when an event is received,
922          * until the next EPOLL_CTL_MOD will be issued.
923          */
924         if (!(epi->event.events & ~EP_PRIVATE_BITS))
925                 goto out_unlock;
926
927         /*
928          * Check the events coming with the callback. At this stage, not
929          * every device reports the events in the "key" parameter of the
930          * callback. We need to be able to handle both cases here, hence the
931          * test for "key" != NULL before the event match test.
932          */
933         if (key && !((unsigned long) key & epi->event.events))
934                 goto out_unlock;
935
936         /*
937          * If we are transferring events to userspace, we can hold no locks
938          * (because we're accessing user memory, and because of linux f_op->poll()
939          * semantics). All the events that happen during that period of time are
940          * chained in ep->ovflist and requeued later on.
941          */
942         if (unlikely(ep->ovflist != EP_UNACTIVE_PTR)) {
943                 if (epi->next == EP_UNACTIVE_PTR) {
944                         epi->next = ep->ovflist;
945                         ep->ovflist = epi;
946                         if (epi->ws) {
947                                 /*
948                                  * Activate ep->ws since epi->ws may get
949                                  * deactivated at any time.
950                                  */
951                                 __pm_stay_awake(ep->ws);
952                         }
953
954                 }
955                 goto out_unlock;
956         }
957
958         /* If this file is already in the ready list we exit soon */
959         if (!ep_is_linked(&epi->rdllink)) {
960                 list_add_tail(&epi->rdllink, &ep->rdllist);
961                 __pm_stay_awake(epi->ws);
962         }
963
964         /*
965          * Wake up ( if active ) both the eventpoll wait list and the ->poll()
966          * wait list.
967          */
968         if (waitqueue_active(&ep->wq))
969                 wake_up_locked(&ep->wq);
970         if (waitqueue_active(&ep->poll_wait))
971                 pwake++;
972
973 out_unlock:
974         spin_unlock_irqrestore(&ep->lock, flags);
975
976         /* We have to call this outside the lock */
977         if (pwake)
978                 ep_poll_safewake(&ep->poll_wait);
979
980         return 1;
981 }
982
983 /*
984  * This is the callback that is used to add our wait queue to the
985  * target file wakeup lists.
986  */
987 static void ep_ptable_queue_proc(struct file *file, wait_queue_head_t *whead,
988                                  poll_table *pt)
989 {
990         struct epitem *epi = ep_item_from_epqueue(pt);
991         struct eppoll_entry *pwq;
992
993         if (epi->nwait >= 0 && (pwq = kmem_cache_alloc(pwq_cache, GFP_KERNEL))) {
994                 init_waitqueue_func_entry(&pwq->wait, ep_poll_callback);
995                 pwq->wait.private = get_thread_process(current);
996                 pwq->whead = whead;
997                 pwq->base = epi;
998                 add_wait_queue(whead, &pwq->wait);
999                 list_add_tail(&pwq->llink, &epi->pwqlist);
1000                 epi->nwait++;
1001         } else {
1002                 /* We have to signal that an error occurred */
1003                 epi->nwait = -1;
1004         }
1005 }
1006
1007 static void ep_rbtree_insert(struct eventpoll *ep, struct epitem *epi)
1008 {
1009         int kcmp;
1010         struct rb_node **p = &ep->rbr.rb_node, *parent = NULL;
1011         struct epitem *epic;
1012
1013         while (*p) {
1014                 parent = *p;
1015                 epic = rb_entry(parent, struct epitem, rbn);
1016                 kcmp = ep_cmp_ffd(&epi->ffd, &epic->ffd);
1017                 if (kcmp > 0)
1018                         p = &parent->rb_right;
1019                 else
1020                         p = &parent->rb_left;
1021         }
1022         rb_link_node(&epi->rbn, parent, p);
1023         rb_insert_color(&epi->rbn, &ep->rbr);
1024 }
1025
1026
1027
1028 #define PATH_ARR_SIZE 5
1029 /*
1030  * These are the number paths of length 1 to 5, that we are allowing to emanate
1031  * from a single file of interest. For example, we allow 1000 paths of length
1032  * 1, to emanate from each file of interest. This essentially represents the
1033  * potential wakeup paths, which need to be limited in order to avoid massive
1034  * uncontrolled wakeup storms. The common use case should be a single ep which
1035  * is connected to n file sources. In this case each file source has 1 path
1036  * of length 1. Thus, the numbers below should be more than sufficient. These
1037  * path limits are enforced during an EPOLL_CTL_ADD operation, since a modify
1038  * and delete can't add additional paths. Protected by the epmutex.
1039  */
1040 static const int path_limits[PATH_ARR_SIZE] = { 1000, 500, 100, 50, 10 };
1041 static int path_count[PATH_ARR_SIZE];
1042
1043 static int path_count_inc(int nests)
1044 {
1045         /* Allow an arbitrary number of depth 1 paths */
1046         if (nests == 0)
1047                 return 0;
1048
1049         if (++path_count[nests] > path_limits[nests])
1050                 return -1;
1051         return 0;
1052 }
1053
1054 static void path_count_init(void)
1055 {
1056         int i;
1057
1058         for (i = 0; i < PATH_ARR_SIZE; i++)
1059                 path_count[i] = 0;
1060 }
1061
1062 static int reverse_path_check_proc(void *priv, void *cookie, int call_nests)
1063 {
1064         int error = 0;
1065         struct file *file = priv;
1066         struct file *child_file;
1067         struct epitem *epi;
1068
1069         list_for_each_entry(epi, &file->f_ep_links, fllink) {
1070                 child_file = epi->ep->file;
1071                 if (is_file_epoll(child_file)) {
1072                         if (list_empty(&child_file->f_ep_links)) {
1073                                 if (path_count_inc(call_nests)) {
1074                                         error = -1;
1075                                         break;
1076                                 }
1077                         } else {
1078                                 error = ep_call_nested(&poll_loop_ncalls,
1079                                                         EP_MAX_NESTS,
1080                                                         reverse_path_check_proc,
1081                                                         child_file, child_file,
1082                                                         current);
1083                         }
1084                         if (error != 0)
1085                                 break;
1086                 } else {
1087                         printk(KERN_ERR "reverse_path_check_proc: "
1088                                 "file is not an ep!\n");
1089                 }
1090         }
1091         return error;
1092 }
1093
1094 /**
1095  * reverse_path_check - The tfile_check_list is list of file *, which have
1096  *                      links that are proposed to be newly added. We need to
1097  *                      make sure that those added links don't add too many
1098  *                      paths such that we will spend all our time waking up
1099  *                      eventpoll objects.
1100  *
1101  * Returns: Returns zero if the proposed links don't create too many paths,
1102  *          -1 otherwise.
1103  */
1104 static int reverse_path_check(void)
1105 {
1106         int error = 0;
1107         struct file *current_file;
1108
1109         /* let's call this for all tfiles */
1110         list_for_each_entry(current_file, &tfile_check_list, f_tfile_llink) {
1111                 path_count_init();
1112                 error = ep_call_nested(&poll_loop_ncalls, EP_MAX_NESTS,
1113                                         reverse_path_check_proc, current_file,
1114                                         current_file, current);
1115                 if (error)
1116                         break;
1117         }
1118         return error;
1119 }
1120
1121 static int ep_create_wakeup_source(struct epitem *epi)
1122 {
1123         const char *name;
1124
1125         if (!epi->ep->ws) {
1126                 epi->ep->ws = wakeup_source_register("eventpoll");
1127                 if (!epi->ep->ws)
1128                         return -ENOMEM;
1129         }
1130
1131         name = epi->ffd.file->f_path.dentry->d_name.name;
1132         epi->ws = wakeup_source_register(name);
1133         if (!epi->ws)
1134                 return -ENOMEM;
1135
1136         return 0;
1137 }
1138
1139 static void ep_destroy_wakeup_source(struct epitem *epi)
1140 {
1141         wakeup_source_unregister(epi->ws);
1142         epi->ws = NULL;
1143 }
1144
1145 /*
1146  * Must be called with "mtx" held.
1147  */
1148 static int ep_insert(struct eventpoll *ep, struct epoll_event *event,
1149                      struct file *tfile, int fd)
1150 {
1151         int error, revents, pwake = 0;
1152         unsigned long flags;
1153         long user_watches;
1154         struct epitem *epi;
1155         struct ep_pqueue epq;
1156
1157         user_watches = atomic_long_read(&ep->user->epoll_watches);
1158         if (unlikely(user_watches >= max_user_watches))
1159                 return -ENOSPC;
1160         if (!(epi = kmem_cache_alloc(epi_cache, GFP_KERNEL)))
1161                 return -ENOMEM;
1162
1163         /* Item initialization follow here ... */
1164         INIT_LIST_HEAD(&epi->rdllink);
1165         INIT_LIST_HEAD(&epi->fllink);
1166         INIT_LIST_HEAD(&epi->pwqlist);
1167         epi->ep = ep;
1168         ep_set_ffd(&epi->ffd, tfile, fd);
1169         epi->event = *event;
1170         epi->nwait = 0;
1171         epi->next = EP_UNACTIVE_PTR;
1172         if (epi->event.events & EPOLLWAKEUP) {
1173                 error = ep_create_wakeup_source(epi);
1174                 if (error)
1175                         goto error_create_wakeup_source;
1176         } else {
1177                 epi->ws = NULL;
1178         }
1179
1180         /* Initialize the poll table using the queue callback */
1181         epq.epi = epi;
1182         init_poll_funcptr(&epq.pt, ep_ptable_queue_proc);
1183         epq.pt._key = event->events;
1184
1185         /*
1186          * Attach the item to the poll hooks and get current event bits.
1187          * We can safely use the file* here because its usage count has
1188          * been increased by the caller of this function. Note that after
1189          * this operation completes, the poll callback can start hitting
1190          * the new item.
1191          */
1192         revents = tfile->f_op->poll(tfile, &epq.pt);
1193
1194         /*
1195          * We have to check if something went wrong during the poll wait queue
1196          * install process. Namely an allocation for a wait queue failed due
1197          * high memory pressure.
1198          */
1199         error = -ENOMEM;
1200         if (epi->nwait < 0)
1201                 goto error_unregister;
1202
1203         /* Add the current item to the list of active epoll hook for this file */
1204         spin_lock(&tfile->f_lock);
1205         list_add_tail(&epi->fllink, &tfile->f_ep_links);
1206         spin_unlock(&tfile->f_lock);
1207         tfile->f_path.dentry->d_inode->i_private = get_thread_process(current);
1208
1209         /*
1210          * Add the current item to the RB tree. All RB tree operations are
1211          * protected by "mtx", and ep_insert() is called with "mtx" held.
1212          */
1213         ep_rbtree_insert(ep, epi);
1214
1215         /* now check if we've created too many backpaths */
1216         error = -EINVAL;
1217         if (reverse_path_check())
1218                 goto error_remove_epi;
1219
1220         /* We have to drop the new item inside our item list to keep track of it */
1221         spin_lock_irqsave(&ep->lock, flags);
1222
1223         /* If the file is already "ready" we drop it inside the ready list */
1224         if ((revents & event->events) && !ep_is_linked(&epi->rdllink)) {
1225                 list_add_tail(&epi->rdllink, &ep->rdllist);
1226                 __pm_stay_awake(epi->ws);
1227
1228                 /* Notify waiting tasks that events are available */
1229                 if (waitqueue_active(&ep->wq))
1230                         wake_up_locked(&ep->wq);
1231                 if (waitqueue_active(&ep->poll_wait))
1232                         pwake++;
1233         }
1234
1235         spin_unlock_irqrestore(&ep->lock, flags);
1236
1237         atomic_long_inc(&ep->user->epoll_watches);
1238
1239         /* We have to call this outside the lock */
1240         if (pwake)
1241                 ep_poll_safewake(&ep->poll_wait);
1242
1243         return 0;
1244
1245 error_remove_epi:
1246         spin_lock(&tfile->f_lock);
1247         if (ep_is_linked(&epi->fllink))
1248                 list_del_init(&epi->fllink);
1249         spin_unlock(&tfile->f_lock);
1250
1251         rb_erase(&epi->rbn, &ep->rbr);
1252
1253 error_unregister:
1254         ep_unregister_pollwait(ep, epi);
1255
1256         /*
1257          * We need to do this because an event could have been arrived on some
1258          * allocated wait queue. Note that we don't care about the ep->ovflist
1259          * list, since that is used/cleaned only inside a section bound by "mtx".
1260          * And ep_insert() is called with "mtx" held.
1261          */
1262         spin_lock_irqsave(&ep->lock, flags);
1263         if (ep_is_linked(&epi->rdllink))
1264                 list_del_init(&epi->rdllink);
1265         spin_unlock_irqrestore(&ep->lock, flags);
1266
1267         wakeup_source_unregister(epi->ws);
1268
1269 error_create_wakeup_source:
1270         kmem_cache_free(epi_cache, epi);
1271
1272         return error;
1273 }
1274
1275 /*
1276  * Modify the interest event mask by dropping an event if the new mask
1277  * has a match in the current file status. Must be called with "mtx" held.
1278  */
1279 static int ep_modify(struct eventpoll *ep, struct epitem *epi, struct epoll_event *event)
1280 {
1281         int pwake = 0;
1282         unsigned int revents;
1283         poll_table pt;
1284
1285         init_poll_funcptr(&pt, NULL);
1286
1287         /*
1288          * Set the new event interest mask before calling f_op->poll();
1289          * otherwise we might miss an event that happens between the
1290          * f_op->poll() call and the new event set registering.
1291          */
1292         epi->event.events = event->events; /* need barrier below */
1293         pt._key = event->events;
1294         epi->event.data = event->data; /* protected by mtx */
1295         if (epi->event.events & EPOLLWAKEUP) {
1296                 if (!epi->ws)
1297                         ep_create_wakeup_source(epi);
1298         } else if (epi->ws) {
1299                 ep_destroy_wakeup_source(epi);
1300         }
1301
1302         /*
1303          * The following barrier has two effects:
1304          *
1305          * 1) Flush epi changes above to other CPUs.  This ensures
1306          *    we do not miss events from ep_poll_callback if an
1307          *    event occurs immediately after we call f_op->poll().
1308          *    We need this because we did not take ep->lock while
1309          *    changing epi above (but ep_poll_callback does take
1310          *    ep->lock).
1311          *
1312          * 2) We also need to ensure we do not miss _past_ events
1313          *    when calling f_op->poll().  This barrier also
1314          *    pairs with the barrier in wq_has_sleeper (see
1315          *    comments for wq_has_sleeper).
1316          *
1317          * This barrier will now guarantee ep_poll_callback or f_op->poll
1318          * (or both) will notice the readiness of an item.
1319          */
1320         smp_mb();
1321
1322         /*
1323          * Get current event bits. We can safely use the file* here because
1324          * its usage count has been increased by the caller of this function.
1325          */
1326         revents = epi->ffd.file->f_op->poll(epi->ffd.file, &pt);
1327
1328         /*
1329          * If the item is "hot" and it is not registered inside the ready
1330          * list, push it inside.
1331          */
1332         if (revents & event->events) {
1333                 spin_lock_irq(&ep->lock);
1334                 if (!ep_is_linked(&epi->rdllink)) {
1335                         list_add_tail(&epi->rdllink, &ep->rdllist);
1336                         __pm_stay_awake(epi->ws);
1337
1338                         /* Notify waiting tasks that events are available */
1339                         if (waitqueue_active(&ep->wq))
1340                                 wake_up_locked(&ep->wq);
1341                         if (waitqueue_active(&ep->poll_wait))
1342                                 pwake++;
1343                 }
1344                 spin_unlock_irq(&ep->lock);
1345         }
1346
1347         /* We have to call this outside the lock */
1348         if (pwake)
1349                 ep_poll_safewake(&ep->poll_wait);
1350
1351         return 0;
1352 }
1353
1354 static int ep_send_events_proc(struct eventpoll *ep, struct list_head *head,
1355                                void *priv)
1356 {
1357         struct ep_send_events_data *esed = priv;
1358         int eventcnt;
1359         unsigned int revents;
1360         struct epitem *epi;
1361         struct epoll_event __user *uevent;
1362         poll_table pt;
1363
1364         init_poll_funcptr(&pt, NULL);
1365
1366         /*
1367          * We can loop without lock because we are passed a task private list.
1368          * Items cannot vanish during the loop because ep_scan_ready_list() is
1369          * holding "mtx" during this call.
1370          */
1371         for (eventcnt = 0, uevent = esed->events;
1372              !list_empty(head) && eventcnt < esed->maxevents;) {
1373                 epi = list_first_entry(head, struct epitem, rdllink);
1374
1375                 /*
1376                  * Activate ep->ws before deactivating epi->ws to prevent
1377                  * triggering auto-suspend here (in case we reactive epi->ws
1378                  * below).
1379                  *
1380                  * This could be rearranged to delay the deactivation of epi->ws
1381                  * instead, but then epi->ws would temporarily be out of sync
1382                  * with ep_is_linked().
1383                  */
1384                 if (epi->ws && epi->ws->active)
1385                         __pm_stay_awake(ep->ws);
1386                 __pm_relax(epi->ws);
1387                 list_del_init(&epi->rdllink);
1388
1389                 pt._key = epi->event.events;
1390                 revents = epi->ffd.file->f_op->poll(epi->ffd.file, &pt) &
1391                         epi->event.events;
1392
1393                 /*
1394                  * If the event mask intersect the caller-requested one,
1395                  * deliver the event to userspace. Again, ep_scan_ready_list()
1396                  * is holding "mtx", so no operations coming from userspace
1397                  * can change the item.
1398                  */
1399                 if (revents) {
1400                         if (__put_user(revents, &uevent->events) ||
1401                             __put_user(epi->event.data, &uevent->data)) {
1402                                 list_add(&epi->rdllink, head);
1403                                 __pm_stay_awake(epi->ws);
1404                                 return eventcnt ? eventcnt : -EFAULT;
1405                         }
1406                         eventcnt++;
1407                         uevent++;
1408                         if (epi->event.events & EPOLLONESHOT)
1409                                 epi->event.events &= EP_PRIVATE_BITS;
1410                         else if (!(epi->event.events & EPOLLET)) {
1411                                 /*
1412                                  * If this file has been added with Level
1413                                  * Trigger mode, we need to insert back inside
1414                                  * the ready list, so that the next call to
1415                                  * epoll_wait() will check again the events
1416                                  * availability. At this point, no one can insert
1417                                  * into ep->rdllist besides us. The epoll_ctl()
1418                                  * callers are locked out by
1419                                  * ep_scan_ready_list() holding "mtx" and the
1420                                  * poll callback will queue them in ep->ovflist.
1421                                  */
1422                                 list_add_tail(&epi->rdllink, &ep->rdllist);
1423                                 __pm_stay_awake(epi->ws);
1424                         }
1425                 }
1426         }
1427
1428         return eventcnt;
1429 }
1430
1431 static int ep_send_events(struct eventpoll *ep,
1432                           struct epoll_event __user *events, int maxevents)
1433 {
1434         struct ep_send_events_data esed;
1435
1436         esed.maxevents = maxevents;
1437         esed.events = events;
1438
1439         return ep_scan_ready_list(ep, ep_send_events_proc, &esed, 0);
1440 }
1441
1442 static inline struct timespec ep_set_mstimeout(long ms)
1443 {
1444         struct timespec now, ts = {
1445                 .tv_sec = ms / MSEC_PER_SEC,
1446                 .tv_nsec = NSEC_PER_MSEC * (ms % MSEC_PER_SEC),
1447         };
1448
1449         ktime_get_ts(&now);
1450         return timespec_add_safe(now, ts);
1451 }
1452
1453 /**
1454  * ep_poll - Retrieves ready events, and delivers them to the caller supplied
1455  *           event buffer.
1456  *
1457  * @ep: Pointer to the eventpoll context.
1458  * @events: Pointer to the userspace buffer where the ready events should be
1459  *          stored.
1460  * @maxevents: Size (in terms of number of events) of the caller event buffer.
1461  * @timeout: Maximum timeout for the ready events fetch operation, in
1462  *           milliseconds. If the @timeout is zero, the function will not block,
1463  *           while if the @timeout is less than zero, the function will block
1464  *           until at least one event has been retrieved (or an error
1465  *           occurred).
1466  *
1467  * Returns: Returns the number of ready events which have been fetched, or an
1468  *          error code, in case of error.
1469  */
1470 static int ep_poll(struct eventpoll *ep, struct epoll_event __user *events,
1471                    int maxevents, long timeout)
1472 {
1473         int res = 0, eavail, timed_out = 0;
1474         unsigned long flags;
1475         long slack = 0;
1476         wait_queue_t wait;
1477         ktime_t expires, *to = NULL;
1478
1479         if (timeout > 0) {
1480                 struct timespec end_time = ep_set_mstimeout(timeout);
1481
1482                 slack = select_estimate_accuracy(&end_time);
1483                 to = &expires;
1484                 *to = timespec_to_ktime(end_time);
1485         } else if (timeout == 0) {
1486                 /*
1487                  * Avoid the unnecessary trip to the wait queue loop, if the
1488                  * caller specified a non blocking operation.
1489                  */
1490                 timed_out = 1;
1491                 spin_lock_irqsave(&ep->lock, flags);
1492                 goto check_events;
1493         }
1494
1495 fetch_events:
1496         spin_lock_irqsave(&ep->lock, flags);
1497
1498         if (!ep_events_available(ep)) {
1499                 /*
1500                  * We don't have any available event to return to the caller.
1501                  * We need to sleep here, and we will be wake up by
1502                  * ep_poll_callback() when events will become available.
1503                  */
1504                 init_waitqueue_entry(&wait, current);
1505                 __add_wait_queue_exclusive(&ep->wq, &wait);
1506
1507                 for (;;) {
1508                         /*
1509                          * We don't want to sleep if the ep_poll_callback() sends us
1510                          * a wakeup in between. That's why we set the task state
1511                          * to TASK_INTERRUPTIBLE before doing the checks.
1512                          */
1513                         set_current_state(TASK_INTERRUPTIBLE);
1514                         if (ep_events_available(ep) || timed_out)
1515                                 break;
1516                         if (signal_pending(current)) {
1517                                 res = -EINTR;
1518                                 break;
1519                         }
1520
1521                         spin_unlock_irqrestore(&ep->lock, flags);
1522                         if (!schedule_hrtimeout_range(to, slack, HRTIMER_MODE_ABS))
1523                                 timed_out = 1;
1524
1525                         spin_lock_irqsave(&ep->lock, flags);
1526                 }
1527                 __remove_wait_queue(&ep->wq, &wait);
1528
1529                 set_current_state(TASK_RUNNING);
1530         }
1531 check_events:
1532         /* Is it worth to try to dig for events ? */
1533         eavail = ep_events_available(ep);
1534
1535         spin_unlock_irqrestore(&ep->lock, flags);
1536
1537         /*
1538          * Try to transfer events to user space. In case we get 0 events and
1539          * there's still timeout left over, we go trying again in search of
1540          * more luck.
1541          */
1542         if (!res && eavail &&
1543             !(res = ep_send_events(ep, events, maxevents)) && !timed_out)
1544                 goto fetch_events;
1545
1546         return res;
1547 }
1548
1549 /**
1550  * ep_loop_check_proc - Callback function to be passed to the @ep_call_nested()
1551  *                      API, to verify that adding an epoll file inside another
1552  *                      epoll structure, does not violate the constraints, in
1553  *                      terms of closed loops, or too deep chains (which can
1554  *                      result in excessive stack usage).
1555  *
1556  * @priv: Pointer to the epoll file to be currently checked.
1557  * @cookie: Original cookie for this call. This is the top-of-the-chain epoll
1558  *          data structure pointer.
1559  * @call_nests: Current dept of the @ep_call_nested() call stack.
1560  *
1561  * Returns: Returns zero if adding the epoll @file inside current epoll
1562  *          structure @ep does not violate the constraints, or -1 otherwise.
1563  */
1564 static int ep_loop_check_proc(void *priv, void *cookie, int call_nests)
1565 {
1566         int error = 0;
1567         struct file *file = priv;
1568         struct eventpoll *ep = file->private_data;
1569         struct eventpoll *ep_tovisit;
1570         struct rb_node *rbp;
1571         struct epitem *epi;
1572
1573         mutex_lock_nested(&ep->mtx, call_nests + 1);
1574         ep->visited = 1;
1575         list_add(&ep->visited_list_link, &visited_list);
1576         for (rbp = rb_first(&ep->rbr); rbp; rbp = rb_next(rbp)) {
1577                 epi = rb_entry(rbp, struct epitem, rbn);
1578                 if (unlikely(is_file_epoll(epi->ffd.file))) {
1579                         ep_tovisit = epi->ffd.file->private_data;
1580                         if (ep_tovisit->visited)
1581                                 continue;
1582                         error = ep_call_nested(&poll_loop_ncalls, EP_MAX_NESTS,
1583                                         ep_loop_check_proc, epi->ffd.file,
1584                                         ep_tovisit, current);
1585                         if (error != 0)
1586                                 break;
1587                 } else {
1588                         /*
1589                          * If we've reached a file that is not associated with
1590                          * an ep, then we need to check if the newly added
1591                          * links are going to add too many wakeup paths. We do
1592                          * this by adding it to the tfile_check_list, if it's
1593                          * not already there, and calling reverse_path_check()
1594                          * during ep_insert().
1595                          */
1596                         if (list_empty(&epi->ffd.file->f_tfile_llink))
1597                                 list_add(&epi->ffd.file->f_tfile_llink,
1598                                          &tfile_check_list);
1599                 }
1600         }
1601         mutex_unlock(&ep->mtx);
1602
1603         return error;
1604 }
1605
1606 /**
1607  * ep_loop_check - Performs a check to verify that adding an epoll file (@file)
1608  *                 another epoll file (represented by @ep) does not create
1609  *                 closed loops or too deep chains.
1610  *
1611  * @ep: Pointer to the epoll private data structure.
1612  * @file: Pointer to the epoll file to be checked.
1613  *
1614  * Returns: Returns zero if adding the epoll @file inside current epoll
1615  *          structure @ep does not violate the constraints, or -1 otherwise.
1616  */
1617 static int ep_loop_check(struct eventpoll *ep, struct file *file)
1618 {
1619         int ret;
1620         struct eventpoll *ep_cur, *ep_next;
1621
1622         ret = ep_call_nested(&poll_loop_ncalls, EP_MAX_NESTS,
1623                               ep_loop_check_proc, file, ep, current);
1624         /* clear visited list */
1625         list_for_each_entry_safe(ep_cur, ep_next, &visited_list,
1626                                                         visited_list_link) {
1627                 ep_cur->visited = 0;
1628                 list_del(&ep_cur->visited_list_link);
1629         }
1630         return ret;
1631 }
1632
1633 static void clear_tfile_check_list(void)
1634 {
1635         struct file *file;
1636
1637         /* first clear the tfile_check_list */
1638         while (!list_empty(&tfile_check_list)) {
1639                 file = list_first_entry(&tfile_check_list, struct file,
1640                                         f_tfile_llink);
1641                 list_del_init(&file->f_tfile_llink);
1642         }
1643         INIT_LIST_HEAD(&tfile_check_list);
1644 }
1645
1646 struct task_struct *get_epoll_file_task(struct file *file)
1647 {
1648         struct list_head *lh;
1649         struct epitem *epi = NULL;
1650         struct eppoll_entry *pwq = NULL;
1651         struct task_struct *task = NULL;
1652         wait_queue_head_t *whead = NULL;
1653         wait_queue_t *wq = NULL;
1654
1655         lh = &file->f_ep_links;
1656         if (!list_empty(lh)) {
1657                 lh = lh->next;
1658                 epi = list_entry(lh, struct epitem, fllink);
1659                 lh = &epi->pwqlist;
1660                 if (!list_empty(lh)) {
1661                         lh = lh->next;
1662                         pwq = list_entry(lh, struct eppoll_entry, llink);
1663                         lh = &pwq->whead->task_list;
1664                         if (!list_empty(lh)) {
1665                                 lh = lh->next;
1666                                 wq = list_entry(lh, wait_queue_t, task_list);
1667                                 task = wq->private;
1668                         }
1669                 }
1670         }
1671
1672         return task;
1673 }
1674
1675 /*
1676  * Open an eventpoll file descriptor.
1677  */
1678 SYSCALL_DEFINE1(epoll_create1, int, flags)
1679 {
1680         int error, fd;
1681         struct eventpoll *ep = NULL;
1682         struct file *file;
1683
1684         /* Check the EPOLL_* constant for consistency.  */
1685         BUILD_BUG_ON(EPOLL_CLOEXEC != O_CLOEXEC);
1686
1687         if (flags & ~EPOLL_CLOEXEC)
1688                 return -EINVAL;
1689         /*
1690          * Create the internal data structure ("struct eventpoll").
1691          */
1692         error = ep_alloc(&ep);
1693         if (error < 0)
1694                 return error;
1695         /*
1696          * Creates all the items needed to setup an eventpoll file. That is,
1697          * a file structure and a free file descriptor.
1698          */
1699         fd = get_unused_fd_flags(O_RDWR | (flags & O_CLOEXEC));
1700         if (fd < 0) {
1701                 error = fd;
1702                 goto out_free_ep;
1703         }
1704         file = anon_inode_getfile("[eventpoll]", &eventpoll_fops, ep,
1705                                  O_RDWR | (flags & O_CLOEXEC));
1706         if (IS_ERR(file)) {
1707                 error = PTR_ERR(file);
1708                 goto out_free_fd;
1709         }
1710         fd_install(fd, file);
1711         ep->file = file;
1712         return fd;
1713
1714 out_free_fd:
1715         put_unused_fd(fd);
1716 out_free_ep:
1717         ep_free(ep);
1718         return error;
1719 }
1720
1721 SYSCALL_DEFINE1(epoll_create, int, size)
1722 {
1723         if (size <= 0)
1724                 return -EINVAL;
1725
1726         return sys_epoll_create1(0);
1727 }
1728
1729 /*
1730  * The following function implements the controller interface for
1731  * the eventpoll file that enables the insertion/removal/change of
1732  * file descriptors inside the interest set.
1733  */
1734 SYSCALL_DEFINE4(epoll_ctl, int, epfd, int, op, int, fd,
1735                 struct epoll_event __user *, event)
1736 {
1737         int error;
1738         int did_lock_epmutex = 0;
1739         struct file *file, *tfile;
1740         struct eventpoll *ep;
1741         struct epitem *epi;
1742         struct epoll_event epds;
1743
1744         error = -EFAULT;
1745         if (ep_op_has_event(op) &&
1746             copy_from_user(&epds, event, sizeof(struct epoll_event)))
1747                 goto error_return;
1748
1749         /* Get the "struct file *" for the eventpoll file */
1750         error = -EBADF;
1751         file = fget(epfd);
1752         if (!file)
1753                 goto error_return;
1754
1755         /* Get the "struct file *" for the target file */
1756         tfile = fget(fd);
1757         if (!tfile)
1758                 goto error_fput;
1759
1760         /* The target file descriptor must support poll */
1761         error = -EPERM;
1762         if (!tfile->f_op || !tfile->f_op->poll)
1763                 goto error_tgt_fput;
1764
1765         /* Check if EPOLLWAKEUP is allowed */
1766         if ((epds.events & EPOLLWAKEUP) && !capable(CAP_EPOLLWAKEUP))
1767                 epds.events &= ~EPOLLWAKEUP;
1768
1769         /*
1770          * We have to check that the file structure underneath the file descriptor
1771          * the user passed to us _is_ an eventpoll file. And also we do not permit
1772          * adding an epoll file descriptor inside itself.
1773          */
1774         error = -EINVAL;
1775         if (file == tfile || !is_file_epoll(file))
1776                 goto error_tgt_fput;
1777
1778         /*
1779          * At this point it is safe to assume that the "private_data" contains
1780          * our own data structure.
1781          */
1782         ep = file->private_data;
1783
1784         /*
1785          * When we insert an epoll file descriptor, inside another epoll file
1786          * descriptor, there is the change of creating closed loops, which are
1787          * better be handled here, than in more critical paths. While we are
1788          * checking for loops we also determine the list of files reachable
1789          * and hang them on the tfile_check_list, so we can check that we
1790          * haven't created too many possible wakeup paths.
1791          *
1792          * We need to hold the epmutex across both ep_insert and ep_remove
1793          * b/c we want to make sure we are looking at a coherent view of
1794          * epoll network.
1795          */
1796         if (op == EPOLL_CTL_ADD || op == EPOLL_CTL_DEL) {
1797                 mutex_lock(&epmutex);
1798                 did_lock_epmutex = 1;
1799         }
1800         if (op == EPOLL_CTL_ADD) {
1801                 if (is_file_epoll(tfile)) {
1802                         error = -ELOOP;
1803                         if (ep_loop_check(ep, tfile) != 0) {
1804                                 clear_tfile_check_list();
1805                                 goto error_tgt_fput;
1806                         }
1807                 } else
1808                         list_add(&tfile->f_tfile_llink, &tfile_check_list);
1809         }
1810
1811         mutex_lock_nested(&ep->mtx, 0);
1812
1813         /*
1814          * Try to lookup the file inside our RB tree, Since we grabbed "mtx"
1815          * above, we can be sure to be able to use the item looked up by
1816          * ep_find() till we release the mutex.
1817          */
1818         epi = ep_find(ep, tfile, fd);
1819
1820         error = -EINVAL;
1821         switch (op) {
1822         case EPOLL_CTL_ADD:
1823                 if (!epi) {
1824                         epds.events |= POLLERR | POLLHUP;
1825                         error = ep_insert(ep, &epds, tfile, fd);
1826                 } else
1827                         error = -EEXIST;
1828                 clear_tfile_check_list();
1829                 break;
1830         case EPOLL_CTL_DEL:
1831                 if (epi)
1832                         error = ep_remove(ep, epi);
1833                 else
1834                         error = -ENOENT;
1835                 break;
1836         case EPOLL_CTL_MOD:
1837                 if (epi) {
1838                         epds.events |= POLLERR | POLLHUP;
1839                         error = ep_modify(ep, epi, &epds);
1840                 } else
1841                         error = -ENOENT;
1842                 break;
1843         }
1844         mutex_unlock(&ep->mtx);
1845
1846 error_tgt_fput:
1847         if (did_lock_epmutex)
1848                 mutex_unlock(&epmutex);
1849
1850         fput(tfile);
1851 error_fput:
1852         fput(file);
1853 error_return:
1854
1855         return error;
1856 }
1857
1858 /*
1859  * Implement the event wait interface for the eventpoll file. It is the kernel
1860  * part of the user space epoll_wait(2).
1861  */
1862 SYSCALL_DEFINE4(epoll_wait, int, epfd, struct epoll_event __user *, events,
1863                 int, maxevents, int, timeout)
1864 {
1865         int error;
1866         struct file *file;
1867         struct eventpoll *ep;
1868
1869         /* The maximum number of event must be greater than zero */
1870         if (maxevents <= 0 || maxevents > EP_MAX_EVENTS)
1871                 return -EINVAL;
1872
1873         /* Verify that the area passed by the user is writeable */
1874         if (!access_ok(VERIFY_WRITE, events, maxevents * sizeof(struct epoll_event))) {
1875                 error = -EFAULT;
1876                 goto error_return;
1877         }
1878
1879         /* Get the "struct file *" for the eventpoll file */
1880         error = -EBADF;
1881         file = fget(epfd);
1882         if (!file)
1883                 goto error_return;
1884
1885         /*
1886          * We have to check that the file structure underneath the fd
1887          * the user passed to us _is_ an eventpoll file.
1888          */
1889         error = -EINVAL;
1890         if (!is_file_epoll(file))
1891                 goto error_fput;
1892
1893         /*
1894          * At this point it is safe to assume that the "private_data" contains
1895          * our own data structure.
1896          */
1897         ep = file->private_data;
1898
1899         /* Time to fish for events ... */
1900         error = ep_poll(ep, events, maxevents, timeout);
1901
1902 error_fput:
1903         fput(file);
1904 error_return:
1905
1906         return error;
1907 }
1908
1909 #ifdef HAVE_SET_RESTORE_SIGMASK
1910
1911 /*
1912  * Implement the event wait interface for the eventpoll file. It is the kernel
1913  * part of the user space epoll_pwait(2).
1914  */
1915 SYSCALL_DEFINE6(epoll_pwait, int, epfd, struct epoll_event __user *, events,
1916                 int, maxevents, int, timeout, const sigset_t __user *, sigmask,
1917                 size_t, sigsetsize)
1918 {
1919         int error;
1920         sigset_t ksigmask, sigsaved;
1921
1922         /*
1923          * If the caller wants a certain signal mask to be set during the wait,
1924          * we apply it here.
1925          */
1926         if (sigmask) {
1927                 if (sigsetsize != sizeof(sigset_t))
1928                         return -EINVAL;
1929                 if (copy_from_user(&ksigmask, sigmask, sizeof(ksigmask)))
1930                         return -EFAULT;
1931                 sigdelsetmask(&ksigmask, sigmask(SIGKILL) | sigmask(SIGSTOP));
1932                 sigprocmask(SIG_SETMASK, &ksigmask, &sigsaved);
1933         }
1934
1935         error = sys_epoll_wait(epfd, events, maxevents, timeout);
1936
1937         /*
1938          * If we changed the signal mask, we need to restore the original one.
1939          * In case we've got a signal while waiting, we do not restore the
1940          * signal mask yet, and we allow do_signal() to deliver the signal on
1941          * the way back to userspace, before the signal mask is restored.
1942          */
1943         if (sigmask) {
1944                 if (error == -EINTR) {
1945                         memcpy(&current->saved_sigmask, &sigsaved,
1946                                sizeof(sigsaved));
1947                         set_restore_sigmask();
1948                 } else
1949                         sigprocmask(SIG_SETMASK, &sigsaved, NULL);
1950         }
1951
1952         return error;
1953 }
1954
1955 #endif /* HAVE_SET_RESTORE_SIGMASK */
1956
1957 static int __init eventpoll_init(void)
1958 {
1959         struct sysinfo si;
1960
1961         si_meminfo(&si);
1962         /*
1963          * Allows top 4% of lomem to be allocated for epoll watches (per user).
1964          */
1965         max_user_watches = (((si.totalram - si.totalhigh) / 25) << PAGE_SHIFT) /
1966                 EP_ITEM_COST;
1967         BUG_ON(max_user_watches < 0);
1968
1969         /*
1970          * Initialize the structure used to perform epoll file descriptor
1971          * inclusion loops checks.
1972          */
1973         ep_nested_calls_init(&poll_loop_ncalls);
1974
1975         /* Initialize the structure used to perform safe poll wait head wake ups */
1976         ep_nested_calls_init(&poll_safewake_ncalls);
1977
1978         /* Initialize the structure used to perform file's f_op->poll() calls */
1979         ep_nested_calls_init(&poll_readywalk_ncalls);
1980
1981         /* Allocates slab cache used to allocate "struct epitem" items */
1982         epi_cache = kmem_cache_create("eventpoll_epi", sizeof(struct epitem),
1983                         0, SLAB_HWCACHE_ALIGN | SLAB_PANIC, NULL);
1984
1985         /* Allocates slab cache used to allocate "struct eppoll_entry" */
1986         pwq_cache = kmem_cache_create("eventpoll_pwq",
1987                         sizeof(struct eppoll_entry), 0, SLAB_PANIC, NULL);
1988
1989         return 0;
1990 }
1991 fs_initcall(eventpoll_init);