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