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