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