2 * fs/eventpoll.c ( Efficent event polling implementation )
3 * Copyright (C) 2001,...,2003 Davide Libenzi
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.
10 * Davide Libenzi <davidel@xmailserver.org>
14 #include <linux/module.h>
15 #include <linux/init.h>
16 #include <linux/kernel.h>
17 #include <linux/sched.h>
19 #include <linux/file.h>
20 #include <linux/signal.h>
21 #include <linux/errno.h>
23 #include <linux/slab.h>
24 #include <linux/poll.h>
25 #include <linux/smp_lock.h>
26 #include <linux/string.h>
27 #include <linux/list.h>
28 #include <linux/hash.h>
29 #include <linux/spinlock.h>
30 #include <linux/syscalls.h>
31 #include <linux/rwsem.h>
32 #include <linux/rbtree.h>
33 #include <linux/wait.h>
34 #include <linux/eventpoll.h>
35 #include <linux/mount.h>
36 #include <linux/bitops.h>
37 #include <asm/uaccess.h>
38 #include <asm/system.h>
41 #include <asm/atomic.h>
42 #include <asm/semaphore.h>
47 * There are three level of locking required by epoll :
49 * 1) epsem (semaphore)
50 * 2) ep->sem (rw_semaphore)
51 * 3) ep->lock (rw_lock)
53 * The acquire order is the one listed above, from 1 to 3.
54 * We need a spinlock (ep->lock) because we manipulate objects
55 * from inside the poll callback, that might be triggered from
56 * a wake_up() that in turn might be called from IRQ context.
57 * So we can't sleep inside the poll callback and hence we need
58 * a spinlock. During the event transfer loop (from kernel to
59 * user space) we could end up sleeping due a copy_to_user(), so
60 * we need a lock that will allow us to sleep. This lock is a
61 * read-write semaphore (ep->sem). It is acquired on read during
62 * the event transfer loop and in write during epoll_ctl(EPOLL_CTL_DEL)
63 * and during eventpoll_release_file(). Then we also need a global
64 * semaphore to serialize eventpoll_release_file() and ep_free().
65 * This semaphore is acquired by ep_free() during the epoll file
66 * cleanup path and it is also acquired by eventpoll_release_file()
67 * if a file has been pushed inside an epoll set and it is then
68 * close()d without a previous call toepoll_ctl(EPOLL_CTL_DEL).
69 * It is possible to drop the "ep->sem" and to use the global
70 * semaphore "epsem" (together with "ep->lock") to have it working,
71 * but having "ep->sem" will make the interface more scalable.
72 * Events that require holding "epsem" are very rare, while for
73 * normal operations the epoll private "ep->sem" will guarantee
74 * a greater scalability.
78 #define EVENTPOLLFS_MAGIC 0x03111965 /* My birthday should work for this :) */
83 #define DPRINTK(x) printk x
84 #define DNPRINTK(n, x) do { if ((n) <= DEBUG_EPOLL) printk x; } while (0)
85 #else /* #if DEBUG_EPOLL > 0 */
86 #define DPRINTK(x) (void) 0
87 #define DNPRINTK(n, x) (void) 0
88 #endif /* #if DEBUG_EPOLL > 0 */
93 #define EPI_SLAB_DEBUG (SLAB_DEBUG_FREE | SLAB_RED_ZONE /* | SLAB_POISON */)
94 #else /* #if DEBUG_EPI != 0 */
95 #define EPI_SLAB_DEBUG 0
96 #endif /* #if DEBUG_EPI != 0 */
98 /* Epoll private bits inside the event mask */
99 #define EP_PRIVATE_BITS (EPOLLONESHOT | EPOLLET)
101 /* Maximum number of poll wake up nests we are allowing */
102 #define EP_MAX_POLLWAKE_NESTS 4
104 struct epoll_filefd {
110 * Node that is linked into the "wake_task_list" member of the "struct poll_safewake".
111 * It is used to keep track on all tasks that are currently inside the wake_up() code
112 * to 1) short-circuit the one coming from the same task and same wait queue head
113 * ( loop ) 2) allow a maximum number of epoll descriptors inclusion nesting
114 * 3) let go the ones coming from other tasks.
116 struct wake_task_node {
117 struct list_head llink;
119 wait_queue_head_t *wq;
123 * This is used to implement the safe poll wake up avoiding to reenter
124 * the poll callback from inside wake_up().
126 struct poll_safewake {
127 struct list_head wake_task_list;
132 * This structure is stored inside the "private_data" member of the file
133 * structure and rapresent the main data sructure for the eventpoll
137 /* Protect the this structure access */
141 * This semaphore is used to ensure that files are not removed
142 * while epoll is using them. This is read-held during the event
143 * collection loop and it is write-held during the file cleanup
144 * path, the epoll file exit code and the ctl operations.
146 struct rw_semaphore sem;
148 /* Wait queue used by sys_epoll_wait() */
149 wait_queue_head_t wq;
151 /* Wait queue used by file->poll() */
152 wait_queue_head_t poll_wait;
154 /* List of ready file descriptors */
155 struct list_head rdllist;
157 /* RB-Tree root used to store monitored fd structs */
161 /* Wait structure used by the poll hooks */
162 struct eppoll_entry {
163 /* List header used to link this structure to the "struct epitem" */
164 struct list_head llink;
166 /* The "base" pointer is set to the container "struct epitem" */
170 * Wait queue item that will be linked to the target file wait
175 /* The wait queue head that linked the "wait" wait queue item */
176 wait_queue_head_t *whead;
180 * Each file descriptor added to the eventpoll interface will
181 * have an entry of this type linked to the hash.
184 /* RB-Tree node used to link this structure to the eventpoll rb-tree */
187 /* List header used to link this structure to the eventpoll ready list */
188 struct list_head rdllink;
190 /* The file descriptor information this item refers to */
191 struct epoll_filefd ffd;
193 /* Number of active wait queue attached to poll operations */
196 /* List containing poll wait queues */
197 struct list_head pwqlist;
199 /* The "container" of this item */
200 struct eventpoll *ep;
202 /* The structure that describe the interested events and the source fd */
203 struct epoll_event event;
206 * Used to keep track of the usage count of the structure. This avoids
207 * that the structure will desappear from underneath our processing.
211 /* List header used to link this item to the "struct file" items list */
212 struct list_head fllink;
214 /* List header used to link the item to the transfer list */
215 struct list_head txlink;
218 * This is used during the collection/transfer of events to userspace
219 * to pin items empty events set.
221 unsigned int revents;
224 /* Wrapper struct used by poll queueing */
232 static void ep_poll_safewake_init(struct poll_safewake *psw);
233 static void ep_poll_safewake(struct poll_safewake *psw, wait_queue_head_t *wq);
234 static int ep_getfd(int *efd, struct inode **einode, struct file **efile);
235 static int ep_file_init(struct file *file);
236 static void ep_free(struct eventpoll *ep);
237 static struct epitem *ep_find(struct eventpoll *ep, struct file *file, int fd);
238 static void ep_use_epitem(struct epitem *epi);
239 static void ep_release_epitem(struct epitem *epi);
240 static void ep_ptable_queue_proc(struct file *file, wait_queue_head_t *whead,
242 static void ep_rbtree_insert(struct eventpoll *ep, struct epitem *epi);
243 static int ep_insert(struct eventpoll *ep, struct epoll_event *event,
244 struct file *tfile, int fd);
245 static int ep_modify(struct eventpoll *ep, struct epitem *epi,
246 struct epoll_event *event);
247 static void ep_unregister_pollwait(struct eventpoll *ep, struct epitem *epi);
248 static int ep_unlink(struct eventpoll *ep, struct epitem *epi);
249 static int ep_remove(struct eventpoll *ep, struct epitem *epi);
250 static int ep_poll_callback(wait_queue_t *wait, unsigned mode, int sync, void *key);
251 static int ep_eventpoll_close(struct inode *inode, struct file *file);
252 static unsigned int ep_eventpoll_poll(struct file *file, poll_table *wait);
253 static int ep_collect_ready_items(struct eventpoll *ep,
254 struct list_head *txlist, int maxevents);
255 static int ep_send_events(struct eventpoll *ep, struct list_head *txlist,
256 struct epoll_event __user *events);
257 static void ep_reinject_items(struct eventpoll *ep, struct list_head *txlist);
258 static int ep_events_transfer(struct eventpoll *ep,
259 struct epoll_event __user *events,
261 static int ep_poll(struct eventpoll *ep, struct epoll_event __user *events,
262 int maxevents, long timeout);
263 static int eventpollfs_delete_dentry(struct dentry *dentry);
264 static struct inode *ep_eventpoll_inode(void);
265 static struct super_block *eventpollfs_get_sb(struct file_system_type *fs_type,
266 int flags, const char *dev_name,
270 * This semaphore is used to serialize ep_free() and eventpoll_release_file().
272 static struct semaphore epsem;
274 /* Safe wake up implementation */
275 static struct poll_safewake psw;
277 /* Slab cache used to allocate "struct epitem" */
278 static kmem_cache_t *epi_cache;
280 /* Slab cache used to allocate "struct eppoll_entry" */
281 static kmem_cache_t *pwq_cache;
283 /* Virtual fs used to allocate inodes for eventpoll files */
284 static struct vfsmount *eventpoll_mnt;
286 /* File callbacks that implement the eventpoll file behaviour */
287 static struct file_operations eventpoll_fops = {
288 .release = ep_eventpoll_close,
289 .poll = ep_eventpoll_poll
293 * This is used to register the virtual file system from where
294 * eventpoll inodes are allocated.
296 static struct file_system_type eventpoll_fs_type = {
297 .name = "eventpollfs",
298 .get_sb = eventpollfs_get_sb,
299 .kill_sb = kill_anon_super,
302 /* Very basic directory entry operations for the eventpoll virtual file system */
303 static struct dentry_operations eventpollfs_dentry_operations = {
304 .d_delete = eventpollfs_delete_dentry,
309 /* Fast test to see if the file is an evenpoll file */
310 static inline int is_file_epoll(struct file *f)
312 return f->f_op == &eventpoll_fops;
315 /* Setup the structure that is used as key for the rb-tree */
316 static inline void ep_set_ffd(struct epoll_filefd *ffd,
317 struct file *file, int fd)
323 /* Compare rb-tree keys */
324 static inline int ep_cmp_ffd(struct epoll_filefd *p1,
325 struct epoll_filefd *p2)
327 return (p1->file > p2->file ? +1:
328 (p1->file < p2->file ? -1 : p1->fd - p2->fd));
331 /* Special initialization for the rb-tree node to detect linkage */
332 static inline void ep_rb_initnode(struct rb_node *n)
337 /* Removes a node from the rb-tree and marks it for a fast is-linked check */
338 static inline void ep_rb_erase(struct rb_node *n, struct rb_root *r)
344 /* Fast check to verify that the item is linked to the main rb-tree */
345 static inline int ep_rb_linked(struct rb_node *n)
347 return n->rb_parent != n;
351 * Remove the item from the list and perform its initialization.
352 * This is useful for us because we can test if the item is linked
353 * using "ep_is_linked(p)".
355 static inline void ep_list_del(struct list_head *p)
361 /* Tells us if the item is currently linked */
362 static inline int ep_is_linked(struct list_head *p)
364 return !list_empty(p);
367 /* Get the "struct epitem" from a wait queue pointer */
368 static inline struct epitem * ep_item_from_wait(wait_queue_t *p)
370 return container_of(p, struct eppoll_entry, wait)->base;
373 /* Get the "struct epitem" from an epoll queue wrapper */
374 static inline struct epitem * ep_item_from_epqueue(poll_table *p)
376 return container_of(p, struct ep_pqueue, pt)->epi;
379 /* Tells if the epoll_ctl(2) operation needs an event copy from userspace */
380 static inline int ep_op_hash_event(int op)
382 return op != EPOLL_CTL_DEL;
385 /* Initialize the poll safe wake up structure */
386 static void ep_poll_safewake_init(struct poll_safewake *psw)
389 INIT_LIST_HEAD(&psw->wake_task_list);
390 spin_lock_init(&psw->lock);
395 * Perform a safe wake up of the poll wait list. The problem is that
396 * with the new callback'd wake up system, it is possible that the
397 * poll callback is reentered from inside the call to wake_up() done
398 * on the poll wait queue head. The rule is that we cannot reenter the
399 * wake up code from the same task more than EP_MAX_POLLWAKE_NESTS times,
400 * and we cannot reenter the same wait queue head at all. This will
401 * enable to have a hierarchy of epoll file descriptor of no more than
402 * EP_MAX_POLLWAKE_NESTS deep. We need the irq version of the spin lock
403 * because this one gets called by the poll callback, that in turn is called
404 * from inside a wake_up(), that might be called from irq context.
406 static void ep_poll_safewake(struct poll_safewake *psw, wait_queue_head_t *wq)
410 task_t *this_task = current;
411 struct list_head *lsthead = &psw->wake_task_list, *lnk;
412 struct wake_task_node *tncur;
413 struct wake_task_node tnode;
415 spin_lock_irqsave(&psw->lock, flags);
417 /* Try to see if the current task is already inside this wakeup call */
418 list_for_each(lnk, lsthead) {
419 tncur = list_entry(lnk, struct wake_task_node, llink);
421 if (tncur->wq == wq ||
422 (tncur->task == this_task && ++wake_nests > EP_MAX_POLLWAKE_NESTS)) {
424 * Ops ... loop detected or maximum nest level reached.
425 * We abort this wake by breaking the cycle itself.
427 spin_unlock_irqrestore(&psw->lock, flags);
432 /* Add the current task to the list */
433 tnode.task = this_task;
435 list_add(&tnode.llink, lsthead);
437 spin_unlock_irqrestore(&psw->lock, flags);
439 /* Do really wake up now */
442 /* Remove the current task from the list */
443 spin_lock_irqsave(&psw->lock, flags);
444 list_del(&tnode.llink);
445 spin_unlock_irqrestore(&psw->lock, flags);
449 /* Used to initialize the epoll bits inside the "struct file" */
450 void eventpoll_init_file(struct file *file)
453 INIT_LIST_HEAD(&file->f_ep_links);
454 spin_lock_init(&file->f_ep_lock);
459 * This is called from eventpoll_release() to unlink files from the eventpoll
460 * interface. We need to have this facility to cleanup correctly files that are
461 * closed without being removed from the eventpoll interface.
463 void eventpoll_release_file(struct file *file)
465 struct list_head *lsthead = &file->f_ep_links;
466 struct eventpoll *ep;
470 * We don't want to get "file->f_ep_lock" because it is not
471 * necessary. It is not necessary because we're in the "struct file"
472 * cleanup path, and this means that noone is using this file anymore.
473 * The only hit might come from ep_free() but by holding the semaphore
474 * will correctly serialize the operation. We do need to acquire
475 * "ep->sem" after "epsem" because ep_remove() requires it when called
476 * from anywhere but ep_free().
480 while (!list_empty(lsthead)) {
481 epi = list_entry(lsthead->next, struct epitem, fllink);
484 ep_list_del(&epi->fllink);
485 down_write(&ep->sem);
495 * It opens an eventpoll file descriptor by suggesting a storage of "size"
496 * file descriptors. The size parameter is just an hint about how to size
497 * data structures. It won't prevent the user to store more than "size"
498 * file descriptors inside the epoll interface. It is the kernel part of
499 * the userspace epoll_create(2).
501 asmlinkage long sys_epoll_create(int size)
507 DNPRINTK(3, (KERN_INFO "[%p] eventpoll: sys_epoll_create(%d)\n",
510 /* Sanity check on the size parameter */
516 * Creates all the items needed to setup an eventpoll file. That is,
517 * a file structure, and inode and a free file descriptor.
519 error = ep_getfd(&fd, &inode, &file);
523 /* Setup the file internal data structure ( "struct eventpoll" ) */
524 error = ep_file_init(file);
529 DNPRINTK(3, (KERN_INFO "[%p] eventpoll: sys_epoll_create(%d) = %d\n",
537 DNPRINTK(3, (KERN_INFO "[%p] eventpoll: sys_epoll_create(%d) = %d\n",
538 current, size, error));
544 * The following function implements the controller interface for
545 * the eventpoll file that enables the insertion/removal/change of
546 * file descriptors inside the interest set. It represents
547 * the kernel part of the user space epoll_ctl(2).
550 sys_epoll_ctl(int epfd, int op, int fd, struct epoll_event __user *event)
553 struct file *file, *tfile;
554 struct eventpoll *ep;
556 struct epoll_event epds;
558 DNPRINTK(3, (KERN_INFO "[%p] eventpoll: sys_epoll_ctl(%d, %d, %d, %p)\n",
559 current, epfd, op, fd, event));
562 if (ep_op_hash_event(op) &&
563 copy_from_user(&epds, event, sizeof(struct epoll_event)))
566 /* Get the "struct file *" for the eventpoll file */
572 /* Get the "struct file *" for the target file */
577 /* The target file descriptor must support poll */
579 if (!tfile->f_op || !tfile->f_op->poll)
583 * We have to check that the file structure underneath the file descriptor
584 * the user passed to us _is_ an eventpoll file. And also we do not permit
585 * adding an epoll file descriptor inside itself.
588 if (file == tfile || !is_file_epoll(file))
592 * At this point it is safe to assume that the "private_data" contains
593 * our own data structure.
595 ep = file->private_data;
597 down_write(&ep->sem);
599 /* Try to lookup the file inside our hash table */
600 epi = ep_find(ep, tfile, fd);
606 epds.events |= POLLERR | POLLHUP;
608 error = ep_insert(ep, &epds, tfile, fd);
614 error = ep_remove(ep, epi);
620 epds.events |= POLLERR | POLLHUP;
621 error = ep_modify(ep, epi, &epds);
628 * The function ep_find() increments the usage count of the structure
629 * so, if this is not NULL, we need to release it.
632 ep_release_epitem(epi);
641 DNPRINTK(3, (KERN_INFO "[%p] eventpoll: sys_epoll_ctl(%d, %d, %d, %p) = %d\n",
642 current, epfd, op, fd, event, error));
647 #define MAX_EVENTS (INT_MAX / sizeof(struct epoll_event))
650 * Implement the event wait interface for the eventpoll file. It is the kernel
651 * part of the user space epoll_wait(2).
653 asmlinkage long sys_epoll_wait(int epfd, struct epoll_event __user *events,
654 int maxevents, int timeout)
658 struct eventpoll *ep;
660 DNPRINTK(3, (KERN_INFO "[%p] eventpoll: sys_epoll_wait(%d, %p, %d, %d)\n",
661 current, epfd, events, maxevents, timeout));
663 /* The maximum number of event must be greater than zero */
664 if (maxevents <= 0 || maxevents > MAX_EVENTS)
667 /* Verify that the area passed by the user is writeable */
668 if (!access_ok(VERIFY_WRITE, events, maxevents * sizeof(struct epoll_event))) {
673 /* Get the "struct file *" for the eventpoll file */
680 * We have to check that the file structure underneath the fd
681 * the user passed to us _is_ an eventpoll file.
684 if (!is_file_epoll(file))
688 * At this point it is safe to assume that the "private_data" contains
689 * our own data structure.
691 ep = file->private_data;
693 /* Time to fish for events ... */
694 error = ep_poll(ep, events, maxevents, timeout);
699 DNPRINTK(3, (KERN_INFO "[%p] eventpoll: sys_epoll_wait(%d, %p, %d, %d) = %d\n",
700 current, epfd, events, maxevents, timeout, error));
707 * Creates the file descriptor to be used by the epoll interface.
709 static int ep_getfd(int *efd, struct inode **einode, struct file **efile)
713 struct dentry *dentry;
718 /* Get an ready to use file */
720 file = get_empty_filp();
724 /* Allocates an inode from the eventpoll file system */
725 inode = ep_eventpoll_inode();
726 error = PTR_ERR(inode);
730 /* Allocates a free descriptor to plug the file onto */
731 error = get_unused_fd();
737 * Link the inode to a directory entry by creating a unique name
738 * using the inode number.
741 sprintf(name, "[%lu]", inode->i_ino);
743 this.len = strlen(name);
744 this.hash = inode->i_ino;
745 dentry = d_alloc(eventpoll_mnt->mnt_sb->s_root, &this);
748 dentry->d_op = &eventpollfs_dentry_operations;
749 d_add(dentry, inode);
750 file->f_vfsmnt = mntget(eventpoll_mnt);
751 file->f_dentry = dentry;
752 file->f_mapping = inode->i_mapping;
755 file->f_flags = O_RDONLY;
756 file->f_op = &eventpoll_fops;
757 file->f_mode = FMODE_READ;
759 file->private_data = NULL;
761 /* Install the new setup file into the allocated fd. */
762 fd_install(fd, file);
780 static int ep_file_init(struct file *file)
782 struct eventpoll *ep;
784 if (!(ep = kmalloc(sizeof(struct eventpoll), GFP_KERNEL)))
787 memset(ep, 0, sizeof(*ep));
788 rwlock_init(&ep->lock);
789 init_rwsem(&ep->sem);
790 init_waitqueue_head(&ep->wq);
791 init_waitqueue_head(&ep->poll_wait);
792 INIT_LIST_HEAD(&ep->rdllist);
795 file->private_data = ep;
797 DNPRINTK(3, (KERN_INFO "[%p] eventpoll: ep_file_init() ep=%p\n",
803 static void ep_free(struct eventpoll *ep)
808 /* We need to release all tasks waiting for these file */
809 if (waitqueue_active(&ep->poll_wait))
810 ep_poll_safewake(&psw, &ep->poll_wait);
813 * We need to lock this because we could be hit by
814 * eventpoll_release_file() while we're freeing the "struct eventpoll".
815 * We do not need to hold "ep->sem" here because the epoll file
816 * is on the way to be removed and no one has references to it
817 * anymore. The only hit might come from eventpoll_release_file() but
818 * holding "epsem" is sufficent here.
823 * Walks through the whole tree by unregistering poll callbacks.
825 for (rbp = rb_first(&ep->rbr); rbp; rbp = rb_next(rbp)) {
826 epi = rb_entry(rbp, struct epitem, rbn);
828 ep_unregister_pollwait(ep, epi);
832 * Walks through the whole hash by freeing each "struct epitem". At this
833 * point we are sure no poll callbacks will be lingering around, and also by
834 * write-holding "sem" we can be sure that no file cleanup code will hit
835 * us during this operation. So we can avoid the lock on "ep->lock".
837 while ((rbp = rb_first(&ep->rbr)) != 0) {
838 epi = rb_entry(rbp, struct epitem, rbn);
847 * Search the file inside the eventpoll hash. It add usage count to
848 * the returned item, so the caller must call ep_release_epitem()
849 * after finished using the "struct epitem".
851 static struct epitem *ep_find(struct eventpoll *ep, struct file *file, int fd)
856 struct epitem *epi, *epir = NULL;
857 struct epoll_filefd ffd;
859 ep_set_ffd(&ffd, file, fd);
860 read_lock_irqsave(&ep->lock, flags);
861 for (rbp = ep->rbr.rb_node; rbp; ) {
862 epi = rb_entry(rbp, struct epitem, rbn);
863 kcmp = ep_cmp_ffd(&ffd, &epi->ffd);
874 read_unlock_irqrestore(&ep->lock, flags);
876 DNPRINTK(3, (KERN_INFO "[%p] eventpoll: ep_find(%p) -> %p\n",
877 current, file, epir));
884 * Increment the usage count of the "struct epitem" making it sure
885 * that the user will have a valid pointer to reference.
887 static void ep_use_epitem(struct epitem *epi)
890 atomic_inc(&epi->usecnt);
895 * Decrement ( release ) the usage count by signaling that the user
896 * has finished using the structure. It might lead to freeing the
897 * structure itself if the count goes to zero.
899 static void ep_release_epitem(struct epitem *epi)
902 if (atomic_dec_and_test(&epi->usecnt))
903 kmem_cache_free(epi_cache, epi);
908 * This is the callback that is used to add our wait queue to the
909 * target file wakeup lists.
911 static void ep_ptable_queue_proc(struct file *file, wait_queue_head_t *whead,
914 struct epitem *epi = ep_item_from_epqueue(pt);
915 struct eppoll_entry *pwq;
917 if (epi->nwait >= 0 && (pwq = kmem_cache_alloc(pwq_cache, SLAB_KERNEL))) {
918 init_waitqueue_func_entry(&pwq->wait, ep_poll_callback);
921 add_wait_queue(whead, &pwq->wait);
922 list_add_tail(&pwq->llink, &epi->pwqlist);
925 /* We have to signal that an error occurred */
931 static void ep_rbtree_insert(struct eventpoll *ep, struct epitem *epi)
934 struct rb_node **p = &ep->rbr.rb_node, *parent = NULL;
939 epic = rb_entry(parent, struct epitem, rbn);
940 kcmp = ep_cmp_ffd(&epi->ffd, &epic->ffd);
942 p = &parent->rb_right;
944 p = &parent->rb_left;
946 rb_link_node(&epi->rbn, parent, p);
947 rb_insert_color(&epi->rbn, &ep->rbr);
951 static int ep_insert(struct eventpoll *ep, struct epoll_event *event,
952 struct file *tfile, int fd)
954 int error, revents, pwake = 0;
957 struct ep_pqueue epq;
960 if (!(epi = kmem_cache_alloc(epi_cache, SLAB_KERNEL)))
963 /* Item initialization follow here ... */
964 ep_rb_initnode(&epi->rbn);
965 INIT_LIST_HEAD(&epi->rdllink);
966 INIT_LIST_HEAD(&epi->fllink);
967 INIT_LIST_HEAD(&epi->txlink);
968 INIT_LIST_HEAD(&epi->pwqlist);
970 ep_set_ffd(&epi->ffd, tfile, fd);
972 atomic_set(&epi->usecnt, 1);
975 /* Initialize the poll table using the queue callback */
977 init_poll_funcptr(&epq.pt, ep_ptable_queue_proc);
980 * Attach the item to the poll hooks and get current event bits.
981 * We can safely use the file* here because its usage count has
982 * been increased by the caller of this function.
984 revents = tfile->f_op->poll(tfile, &epq.pt);
987 * We have to check if something went wrong during the poll wait queue
988 * install process. Namely an allocation for a wait queue failed due
989 * high memory pressure.
994 /* Add the current item to the list of active epoll hook for this file */
995 spin_lock(&tfile->f_ep_lock);
996 list_add_tail(&epi->fllink, &tfile->f_ep_links);
997 spin_unlock(&tfile->f_ep_lock);
999 /* We have to drop the new item inside our item list to keep track of it */
1000 write_lock_irqsave(&ep->lock, flags);
1002 /* Add the current item to the rb-tree */
1003 ep_rbtree_insert(ep, epi);
1005 /* If the file is already "ready" we drop it inside the ready list */
1006 if ((revents & event->events) && !ep_is_linked(&epi->rdllink)) {
1007 list_add_tail(&epi->rdllink, &ep->rdllist);
1009 /* Notify waiting tasks that events are available */
1010 if (waitqueue_active(&ep->wq))
1012 if (waitqueue_active(&ep->poll_wait))
1016 write_unlock_irqrestore(&ep->lock, flags);
1018 /* We have to call this outside the lock */
1020 ep_poll_safewake(&psw, &ep->poll_wait);
1022 DNPRINTK(3, (KERN_INFO "[%p] eventpoll: ep_insert(%p, %p, %d)\n",
1023 current, ep, tfile, fd));
1028 ep_unregister_pollwait(ep, epi);
1031 * We need to do this because an event could have been arrived on some
1032 * allocated wait queue.
1034 write_lock_irqsave(&ep->lock, flags);
1035 if (ep_is_linked(&epi->rdllink))
1036 ep_list_del(&epi->rdllink);
1037 write_unlock_irqrestore(&ep->lock, flags);
1039 kmem_cache_free(epi_cache, epi);
1046 * Modify the interest event mask by dropping an event if the new mask
1047 * has a match in the current file status.
1049 static int ep_modify(struct eventpoll *ep, struct epitem *epi, struct epoll_event *event)
1052 unsigned int revents;
1053 unsigned long flags;
1056 * Set the new event interest mask before calling f_op->poll(), otherwise
1057 * a potential race might occur. In fact if we do this operation inside
1058 * the lock, an event might happen between the f_op->poll() call and the
1059 * new event set registering.
1061 epi->event.events = event->events;
1064 * Get current event bits. We can safely use the file* here because
1065 * its usage count has been increased by the caller of this function.
1067 revents = epi->ffd.file->f_op->poll(epi->ffd.file, NULL);
1069 write_lock_irqsave(&ep->lock, flags);
1071 /* Copy the data member from inside the lock */
1072 epi->event.data = event->data;
1075 * If the item is not linked to the hash it means that it's on its
1076 * way toward the removal. Do nothing in this case.
1078 if (ep_rb_linked(&epi->rbn)) {
1080 * If the item is "hot" and it is not registered inside the ready
1081 * list, push it inside. If the item is not "hot" and it is currently
1082 * registered inside the ready list, unlink it.
1084 if (revents & event->events) {
1085 if (!ep_is_linked(&epi->rdllink)) {
1086 list_add_tail(&epi->rdllink, &ep->rdllist);
1088 /* Notify waiting tasks that events are available */
1089 if (waitqueue_active(&ep->wq))
1091 if (waitqueue_active(&ep->poll_wait))
1097 write_unlock_irqrestore(&ep->lock, flags);
1099 /* We have to call this outside the lock */
1101 ep_poll_safewake(&psw, &ep->poll_wait);
1108 * This function unregister poll callbacks from the associated file descriptor.
1109 * Since this must be called without holding "ep->lock" the atomic exchange trick
1110 * will protect us from multiple unregister.
1112 static void ep_unregister_pollwait(struct eventpoll *ep, struct epitem *epi)
1115 struct list_head *lsthead = &epi->pwqlist;
1116 struct eppoll_entry *pwq;
1118 /* This is called without locks, so we need the atomic exchange */
1119 nwait = xchg(&epi->nwait, 0);
1122 while (!list_empty(lsthead)) {
1123 pwq = list_entry(lsthead->next, struct eppoll_entry, llink);
1125 ep_list_del(&pwq->llink);
1126 remove_wait_queue(pwq->whead, &pwq->wait);
1127 kmem_cache_free(pwq_cache, pwq);
1134 * Unlink the "struct epitem" from all places it might have been hooked up.
1135 * This function must be called with write IRQ lock on "ep->lock".
1137 static int ep_unlink(struct eventpoll *ep, struct epitem *epi)
1142 * It can happen that this one is called for an item already unlinked.
1143 * The check protect us from doing a double unlink ( crash ).
1146 if (!ep_rb_linked(&epi->rbn))
1150 * Clear the event mask for the unlinked item. This will avoid item
1151 * notifications to be sent after the unlink operation from inside
1152 * the kernel->userspace event transfer loop.
1154 epi->event.events = 0;
1157 * At this point is safe to do the job, unlink the item from our rb-tree.
1158 * This operation togheter with the above check closes the door to
1161 ep_rb_erase(&epi->rbn, &ep->rbr);
1164 * If the item we are going to remove is inside the ready file descriptors
1165 * we want to remove it from this list to avoid stale events.
1167 if (ep_is_linked(&epi->rdllink))
1168 ep_list_del(&epi->rdllink);
1173 DNPRINTK(3, (KERN_INFO "[%p] eventpoll: ep_unlink(%p, %p) = %d\n",
1174 current, ep, epi->file, error));
1181 * Removes a "struct epitem" from the eventpoll hash and deallocates
1182 * all the associated resources.
1184 static int ep_remove(struct eventpoll *ep, struct epitem *epi)
1187 unsigned long flags;
1188 struct file *file = epi->ffd.file;
1191 * Removes poll wait queue hooks. We _have_ to do this without holding
1192 * the "ep->lock" otherwise a deadlock might occur. This because of the
1193 * sequence of the lock acquisition. Here we do "ep->lock" then the wait
1194 * queue head lock when unregistering the wait queue. The wakeup callback
1195 * will run by holding the wait queue head lock and will call our callback
1196 * that will try to get "ep->lock".
1198 ep_unregister_pollwait(ep, epi);
1200 /* Remove the current item from the list of epoll hooks */
1201 spin_lock(&file->f_ep_lock);
1202 if (ep_is_linked(&epi->fllink))
1203 ep_list_del(&epi->fllink);
1204 spin_unlock(&file->f_ep_lock);
1206 /* We need to acquire the write IRQ lock before calling ep_unlink() */
1207 write_lock_irqsave(&ep->lock, flags);
1209 /* Really unlink the item from the hash */
1210 error = ep_unlink(ep, epi);
1212 write_unlock_irqrestore(&ep->lock, flags);
1217 /* At this point it is safe to free the eventpoll item */
1218 ep_release_epitem(epi);
1222 DNPRINTK(3, (KERN_INFO "[%p] eventpoll: ep_remove(%p, %p) = %d\n",
1223 current, ep, file, error));
1230 * This is the callback that is passed to the wait queue wakeup
1231 * machanism. It is called by the stored file descriptors when they
1232 * have events to report.
1234 static int ep_poll_callback(wait_queue_t *wait, unsigned mode, int sync, void *key)
1237 unsigned long flags;
1238 struct epitem *epi = ep_item_from_wait(wait);
1239 struct eventpoll *ep = epi->ep;
1241 DNPRINTK(3, (KERN_INFO "[%p] eventpoll: poll_callback(%p) epi=%p ep=%p\n",
1242 current, epi->file, epi, ep));
1244 write_lock_irqsave(&ep->lock, flags);
1247 * If the event mask does not contain any poll(2) event, we consider the
1248 * descriptor to be disabled. This condition is likely the effect of the
1249 * EPOLLONESHOT bit that disables the descriptor when an event is received,
1250 * until the next EPOLL_CTL_MOD will be issued.
1252 if (!(epi->event.events & ~EP_PRIVATE_BITS))
1255 /* If this file is already in the ready list we exit soon */
1256 if (ep_is_linked(&epi->rdllink))
1259 list_add_tail(&epi->rdllink, &ep->rdllist);
1263 * Wake up ( if active ) both the eventpoll wait list and the ->poll()
1266 if (waitqueue_active(&ep->wq))
1268 if (waitqueue_active(&ep->poll_wait))
1272 write_unlock_irqrestore(&ep->lock, flags);
1274 /* We have to call this outside the lock */
1276 ep_poll_safewake(&psw, &ep->poll_wait);
1282 static int ep_eventpoll_close(struct inode *inode, struct file *file)
1284 struct eventpoll *ep = file->private_data;
1291 DNPRINTK(3, (KERN_INFO "[%p] eventpoll: close() ep=%p\n", current, ep));
1296 static unsigned int ep_eventpoll_poll(struct file *file, poll_table *wait)
1298 unsigned int pollflags = 0;
1299 unsigned long flags;
1300 struct eventpoll *ep = file->private_data;
1302 /* Insert inside our poll wait queue */
1303 poll_wait(file, &ep->poll_wait, wait);
1305 /* Check our condition */
1306 read_lock_irqsave(&ep->lock, flags);
1307 if (!list_empty(&ep->rdllist))
1308 pollflags = POLLIN | POLLRDNORM;
1309 read_unlock_irqrestore(&ep->lock, flags);
1316 * Since we have to release the lock during the __copy_to_user() operation and
1317 * during the f_op->poll() call, we try to collect the maximum number of items
1318 * by reducing the irqlock/irqunlock switching rate.
1320 static int ep_collect_ready_items(struct eventpoll *ep, struct list_head *txlist, int maxevents)
1323 unsigned long flags;
1324 struct list_head *lsthead = &ep->rdllist, *lnk;
1327 write_lock_irqsave(&ep->lock, flags);
1329 for (nepi = 0, lnk = lsthead->next; lnk != lsthead && nepi < maxevents;) {
1330 epi = list_entry(lnk, struct epitem, rdllink);
1334 /* If this file is already in the ready list we exit soon */
1335 if (!ep_is_linked(&epi->txlink)) {
1337 * This is initialized in this way so that the default
1338 * behaviour of the reinjecting code will be to push back
1339 * the item inside the ready list.
1341 epi->revents = epi->event.events;
1343 /* Link the ready item into the transfer list */
1344 list_add(&epi->txlink, txlist);
1348 * Unlink the item from the ready list.
1350 ep_list_del(&epi->rdllink);
1354 write_unlock_irqrestore(&ep->lock, flags);
1361 * This function is called without holding the "ep->lock" since the call to
1362 * __copy_to_user() might sleep, and also f_op->poll() might reenable the IRQ
1363 * because of the way poll() is traditionally implemented in Linux.
1365 static int ep_send_events(struct eventpoll *ep, struct list_head *txlist,
1366 struct epoll_event __user *events)
1369 unsigned int revents;
1370 struct list_head *lnk;
1374 * We can loop without lock because this is a task private list.
1375 * The test done during the collection loop will guarantee us that
1376 * another task will not try to collect this file. Also, items
1377 * cannot vanish during the loop because we are holding "sem".
1379 list_for_each(lnk, txlist) {
1380 epi = list_entry(lnk, struct epitem, txlink);
1383 * Get the ready file event set. We can safely use the file
1384 * because we are holding the "sem" in read and this will
1385 * guarantee that both the file and the item will not vanish.
1387 revents = epi->ffd.file->f_op->poll(epi->ffd.file, NULL);
1390 * Set the return event set for the current file descriptor.
1391 * Note that only the task task was successfully able to link
1392 * the item to its "txlist" will write this field.
1394 epi->revents = revents & epi->event.events;
1397 if (__put_user(epi->revents,
1398 &events[eventcnt].events) ||
1399 __put_user(epi->event.data,
1400 &events[eventcnt].data))
1402 if (epi->event.events & EPOLLONESHOT)
1403 epi->event.events &= EP_PRIVATE_BITS;
1412 * Walk through the transfer list we collected with ep_collect_ready_items()
1413 * and, if 1) the item is still "alive" 2) its event set is not empty 3) it's
1414 * not already linked, links it to the ready list. Same as above, we are holding
1415 * "sem" so items cannot vanish underneath our nose.
1417 static void ep_reinject_items(struct eventpoll *ep, struct list_head *txlist)
1419 int ricnt = 0, pwake = 0;
1420 unsigned long flags;
1423 write_lock_irqsave(&ep->lock, flags);
1425 while (!list_empty(txlist)) {
1426 epi = list_entry(txlist->next, struct epitem, txlink);
1428 /* Unlink the current item from the transfer list */
1429 ep_list_del(&epi->txlink);
1432 * If the item is no more linked to the interest set, we don't
1433 * have to push it inside the ready list because the following
1434 * ep_release_epitem() is going to drop it. Also, if the current
1435 * item is set to have an Edge Triggered behaviour, we don't have
1436 * to push it back either.
1438 if (ep_rb_linked(&epi->rbn) && !(epi->event.events & EPOLLET) &&
1439 (epi->revents & epi->event.events) && !ep_is_linked(&epi->rdllink)) {
1440 list_add_tail(&epi->rdllink, &ep->rdllist);
1447 * Wake up ( if active ) both the eventpoll wait list and the ->poll()
1450 if (waitqueue_active(&ep->wq))
1452 if (waitqueue_active(&ep->poll_wait))
1456 write_unlock_irqrestore(&ep->lock, flags);
1458 /* We have to call this outside the lock */
1460 ep_poll_safewake(&psw, &ep->poll_wait);
1465 * Perform the transfer of events to user space.
1467 static int ep_events_transfer(struct eventpoll *ep,
1468 struct epoll_event __user *events, int maxevents)
1471 struct list_head txlist;
1473 INIT_LIST_HEAD(&txlist);
1476 * We need to lock this because we could be hit by
1477 * eventpoll_release_file() and epoll_ctl(EPOLL_CTL_DEL).
1479 down_read(&ep->sem);
1481 /* Collect/extract ready items */
1482 if (ep_collect_ready_items(ep, &txlist, maxevents) > 0) {
1483 /* Build result set in userspace */
1484 eventcnt = ep_send_events(ep, &txlist, events);
1486 /* Reinject ready items into the ready list */
1487 ep_reinject_items(ep, &txlist);
1496 static int ep_poll(struct eventpoll *ep, struct epoll_event __user *events,
1497 int maxevents, long timeout)
1500 unsigned long flags;
1505 * Calculate the timeout by checking for the "infinite" value ( -1 )
1506 * and the overflow condition. The passed timeout is in milliseconds,
1507 * that why (t * HZ) / 1000.
1509 jtimeout = timeout == -1 || timeout > (MAX_SCHEDULE_TIMEOUT - 1000) / HZ ?
1510 MAX_SCHEDULE_TIMEOUT: (timeout * HZ + 999) / 1000;
1513 write_lock_irqsave(&ep->lock, flags);
1516 if (list_empty(&ep->rdllist)) {
1518 * We don't have any available event to return to the caller.
1519 * We need to sleep here, and we will be wake up by
1520 * ep_poll_callback() when events will become available.
1522 init_waitqueue_entry(&wait, current);
1523 add_wait_queue(&ep->wq, &wait);
1527 * We don't want to sleep if the ep_poll_callback() sends us
1528 * a wakeup in between. That's why we set the task state
1529 * to TASK_INTERRUPTIBLE before doing the checks.
1531 set_current_state(TASK_INTERRUPTIBLE);
1532 if (!list_empty(&ep->rdllist) || !jtimeout)
1534 if (signal_pending(current)) {
1539 write_unlock_irqrestore(&ep->lock, flags);
1540 jtimeout = schedule_timeout(jtimeout);
1541 write_lock_irqsave(&ep->lock, flags);
1543 remove_wait_queue(&ep->wq, &wait);
1545 set_current_state(TASK_RUNNING);
1548 /* Is it worth to try to dig for events ? */
1549 eavail = !list_empty(&ep->rdllist);
1551 write_unlock_irqrestore(&ep->lock, flags);
1554 * Try to transfer events to user space. In case we get 0 events and
1555 * there's still timeout left over, we go trying again in search of
1558 if (!res && eavail &&
1559 !(res = ep_events_transfer(ep, events, maxevents)) && jtimeout)
1566 static int eventpollfs_delete_dentry(struct dentry *dentry)
1573 static struct inode *ep_eventpoll_inode(void)
1575 int error = -ENOMEM;
1576 struct inode *inode = new_inode(eventpoll_mnt->mnt_sb);
1581 inode->i_fop = &eventpoll_fops;
1584 * Mark the inode dirty from the very beginning,
1585 * that way it will never be moved to the dirty
1586 * list because mark_inode_dirty() will think
1587 * that it already _is_ on the dirty list.
1589 inode->i_state = I_DIRTY;
1590 inode->i_mode = S_IRUSR | S_IWUSR;
1591 inode->i_uid = current->fsuid;
1592 inode->i_gid = current->fsgid;
1593 inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
1594 inode->i_blksize = PAGE_SIZE;
1598 return ERR_PTR(error);
1602 static struct super_block *
1603 eventpollfs_get_sb(struct file_system_type *fs_type, int flags,
1604 const char *dev_name, void *data)
1606 return get_sb_pseudo(fs_type, "eventpoll:", NULL, EVENTPOLLFS_MAGIC);
1610 static int __init eventpoll_init(void)
1616 /* Initialize the structure used to perform safe poll wait head wake ups */
1617 ep_poll_safewake_init(&psw);
1619 /* Allocates slab cache used to allocate "struct epitem" items */
1620 epi_cache = kmem_cache_create("eventpoll_epi", sizeof(struct epitem),
1621 0, SLAB_HWCACHE_ALIGN|EPI_SLAB_DEBUG|SLAB_PANIC,
1624 /* Allocates slab cache used to allocate "struct eppoll_entry" */
1625 pwq_cache = kmem_cache_create("eventpoll_pwq",
1626 sizeof(struct eppoll_entry), 0,
1627 EPI_SLAB_DEBUG|SLAB_PANIC, NULL, NULL);
1630 * Register the virtual file system that will be the source of inodes
1631 * for the eventpoll files
1633 error = register_filesystem(&eventpoll_fs_type);
1637 /* Mount the above commented virtual file system */
1638 eventpoll_mnt = kern_mount(&eventpoll_fs_type);
1639 error = PTR_ERR(eventpoll_mnt);
1640 if (IS_ERR(eventpoll_mnt))
1643 DNPRINTK(3, (KERN_INFO "[%p] eventpoll: successfully initialized.\n",
1648 panic("eventpoll_init() failed\n");
1652 static void __exit eventpoll_exit(void)
1654 /* Undo all operations done inside eventpoll_init() */
1655 unregister_filesystem(&eventpoll_fs_type);
1656 mntput(eventpoll_mnt);
1657 kmem_cache_destroy(pwq_cache);
1658 kmem_cache_destroy(epi_cache);
1661 module_init(eventpoll_init);
1662 module_exit(eventpoll_exit);
1664 MODULE_LICENSE("GPL");