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