2 * fs/eventpoll.c ( Efficent event polling implementation )
3 * Copyright (C) 2001,...,2006 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/string.h>
26 #include <linux/list.h>
27 #include <linux/hash.h>
28 #include <linux/spinlock.h>
29 #include <linux/syscalls.h>
30 #include <linux/rwsem.h>
31 #include <linux/rbtree.h>
32 #include <linux/wait.h>
33 #include <linux/eventpoll.h>
34 #include <linux/mount.h>
35 #include <linux/bitops.h>
36 #include <linux/mutex.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 :
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 "epmutex" (together with "ep->lock") to have it working,
71 * but having "ep->sem" will make the interface more scalable.
72 * Events that require holding "epmutex" 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 /* Maximum msec timeout value storeable in a long int */
105 #define EP_MAX_MSTIMEO min(1000ULL * MAX_SCHEDULE_TIMEOUT / HZ, (LONG_MAX - 999ULL) / HZ)
107 #define EP_MAX_EVENTS (INT_MAX / sizeof(struct epoll_event))
110 struct epoll_filefd
{
116 * Node that is linked into the "wake_task_list" member of the "struct poll_safewake".
117 * It is used to keep track on all tasks that are currently inside the wake_up() code
118 * to 1) short-circuit the one coming from the same task and same wait queue head
119 * ( loop ) 2) allow a maximum number of epoll descriptors inclusion nesting
120 * 3) let go the ones coming from other tasks.
122 struct wake_task_node
{
123 struct list_head llink
;
124 struct task_struct
*task
;
125 wait_queue_head_t
*wq
;
129 * This is used to implement the safe poll wake up avoiding to reenter
130 * the poll callback from inside wake_up().
132 struct poll_safewake
{
133 struct list_head wake_task_list
;
138 * This structure is stored inside the "private_data" member of the file
139 * structure and rapresent the main data sructure for the eventpoll
143 /* Protect the this structure access */
147 * This semaphore is used to ensure that files are not removed
148 * while epoll is using them. This is read-held during the event
149 * collection loop and it is write-held during the file cleanup
150 * path, the epoll file exit code and the ctl operations.
152 struct rw_semaphore sem
;
154 /* Wait queue used by sys_epoll_wait() */
155 wait_queue_head_t wq
;
157 /* Wait queue used by file->poll() */
158 wait_queue_head_t poll_wait
;
160 /* List of ready file descriptors */
161 struct list_head rdllist
;
163 /* RB-Tree root used to store monitored fd structs */
167 /* Wait structure used by the poll hooks */
168 struct eppoll_entry
{
169 /* List header used to link this structure to the "struct epitem" */
170 struct list_head llink
;
172 /* The "base" pointer is set to the container "struct epitem" */
176 * Wait queue item that will be linked to the target file wait
181 /* The wait queue head that linked the "wait" wait queue item */
182 wait_queue_head_t
*whead
;
186 * Each file descriptor added to the eventpoll interface will
187 * have an entry of this type linked to the "rbr" RB tree.
190 /* RB-Tree node used to link this structure to the eventpoll rb-tree */
193 /* List header used to link this structure to the eventpoll ready list */
194 struct list_head rdllink
;
196 /* The file descriptor information this item refers to */
197 struct epoll_filefd ffd
;
199 /* Number of active wait queue attached to poll operations */
202 /* List containing poll wait queues */
203 struct list_head pwqlist
;
205 /* The "container" of this item */
206 struct eventpoll
*ep
;
208 /* The structure that describe the interested events and the source fd */
209 struct epoll_event event
;
212 * Used to keep track of the usage count of the structure. This avoids
213 * that the structure will desappear from underneath our processing.
217 /* List header used to link this item to the "struct file" items list */
218 struct list_head fllink
;
221 /* Wrapper struct used by poll queueing */
229 static void ep_poll_safewake_init(struct poll_safewake
*psw
);
230 static void ep_poll_safewake(struct poll_safewake
*psw
, wait_queue_head_t
*wq
);
231 static int ep_getfd(int *efd
, struct inode
**einode
, struct file
**efile
,
232 struct eventpoll
*ep
);
233 static int ep_alloc(struct eventpoll
**pep
);
234 static void ep_free(struct eventpoll
*ep
);
235 static struct epitem
*ep_find(struct eventpoll
*ep
, struct file
*file
, int fd
);
236 static void ep_use_epitem(struct epitem
*epi
);
237 static void ep_release_epitem(struct epitem
*epi
);
238 static void ep_ptable_queue_proc(struct file
*file
, wait_queue_head_t
*whead
,
240 static void ep_rbtree_insert(struct eventpoll
*ep
, struct epitem
*epi
);
241 static int ep_insert(struct eventpoll
*ep
, struct epoll_event
*event
,
242 struct file
*tfile
, int fd
);
243 static int ep_modify(struct eventpoll
*ep
, struct epitem
*epi
,
244 struct epoll_event
*event
);
245 static void ep_unregister_pollwait(struct eventpoll
*ep
, struct epitem
*epi
);
246 static int ep_unlink(struct eventpoll
*ep
, struct epitem
*epi
);
247 static int ep_remove(struct eventpoll
*ep
, struct epitem
*epi
);
248 static int ep_poll_callback(wait_queue_t
*wait
, unsigned mode
, int sync
, void *key
);
249 static int ep_eventpoll_close(struct inode
*inode
, struct file
*file
);
250 static unsigned int ep_eventpoll_poll(struct file
*file
, poll_table
*wait
);
251 static int ep_send_events(struct eventpoll
*ep
, struct list_head
*txlist
,
252 struct epoll_event __user
*events
, int maxevents
);
253 static int ep_events_transfer(struct eventpoll
*ep
,
254 struct epoll_event __user
*events
,
256 static int ep_poll(struct eventpoll
*ep
, struct epoll_event __user
*events
,
257 int maxevents
, long timeout
);
258 static int eventpollfs_delete_dentry(struct dentry
*dentry
);
259 static struct inode
*ep_eventpoll_inode(void);
260 static int eventpollfs_get_sb(struct file_system_type
*fs_type
,
261 int flags
, const char *dev_name
,
262 void *data
, struct vfsmount
*mnt
);
265 * This semaphore is used to serialize ep_free() and eventpoll_release_file().
267 static struct mutex epmutex
;
269 /* Safe wake up implementation */
270 static struct poll_safewake psw
;
272 /* Slab cache used to allocate "struct epitem" */
273 static struct kmem_cache
*epi_cache __read_mostly
;
275 /* Slab cache used to allocate "struct eppoll_entry" */
276 static struct kmem_cache
*pwq_cache __read_mostly
;
278 /* Virtual fs used to allocate inodes for eventpoll files */
279 static struct vfsmount
*eventpoll_mnt __read_mostly
;
281 /* File callbacks that implement the eventpoll file behaviour */
282 static const struct file_operations eventpoll_fops
= {
283 .release
= ep_eventpoll_close
,
284 .poll
= ep_eventpoll_poll
288 * This is used to register the virtual file system from where
289 * eventpoll inodes are allocated.
291 static struct file_system_type eventpoll_fs_type
= {
292 .name
= "eventpollfs",
293 .get_sb
= eventpollfs_get_sb
,
294 .kill_sb
= kill_anon_super
,
297 /* Very basic directory entry operations for the eventpoll virtual file system */
298 static struct dentry_operations eventpollfs_dentry_operations
= {
299 .d_delete
= eventpollfs_delete_dentry
,
304 /* Fast test to see if the file is an evenpoll file */
305 static inline int is_file_epoll(struct file
*f
)
307 return f
->f_op
== &eventpoll_fops
;
310 /* Setup the structure that is used as key for the rb-tree */
311 static inline void ep_set_ffd(struct epoll_filefd
*ffd
,
312 struct file
*file
, int fd
)
318 /* Compare rb-tree keys */
319 static inline int ep_cmp_ffd(struct epoll_filefd
*p1
,
320 struct epoll_filefd
*p2
)
322 return (p1
->file
> p2
->file
? +1:
323 (p1
->file
< p2
->file
? -1 : p1
->fd
- p2
->fd
));
326 /* Special initialization for the rb-tree node to detect linkage */
327 static inline void ep_rb_initnode(struct rb_node
*n
)
332 /* Removes a node from the rb-tree and marks it for a fast is-linked check */
333 static inline void ep_rb_erase(struct rb_node
*n
, struct rb_root
*r
)
339 /* Fast check to verify that the item is linked to the main rb-tree */
340 static inline int ep_rb_linked(struct rb_node
*n
)
342 return rb_parent(n
) != n
;
345 /* Tells us if the item is currently linked */
346 static inline int ep_is_linked(struct list_head
*p
)
348 return !list_empty(p
);
351 /* Get the "struct epitem" from a wait queue pointer */
352 static inline struct epitem
* ep_item_from_wait(wait_queue_t
*p
)
354 return container_of(p
, struct eppoll_entry
, wait
)->base
;
357 /* Get the "struct epitem" from an epoll queue wrapper */
358 static inline struct epitem
* ep_item_from_epqueue(poll_table
*p
)
360 return container_of(p
, struct ep_pqueue
, pt
)->epi
;
363 /* Tells if the epoll_ctl(2) operation needs an event copy from userspace */
364 static inline int ep_op_has_event(int op
)
366 return op
!= EPOLL_CTL_DEL
;
369 /* Initialize the poll safe wake up structure */
370 static void ep_poll_safewake_init(struct poll_safewake
*psw
)
373 INIT_LIST_HEAD(&psw
->wake_task_list
);
374 spin_lock_init(&psw
->lock
);
379 * Perform a safe wake up of the poll wait list. The problem is that
380 * with the new callback'd wake up system, it is possible that the
381 * poll callback is reentered from inside the call to wake_up() done
382 * on the poll wait queue head. The rule is that we cannot reenter the
383 * wake up code from the same task more than EP_MAX_POLLWAKE_NESTS times,
384 * and we cannot reenter the same wait queue head at all. This will
385 * enable to have a hierarchy of epoll file descriptor of no more than
386 * EP_MAX_POLLWAKE_NESTS deep. We need the irq version of the spin lock
387 * because this one gets called by the poll callback, that in turn is called
388 * from inside a wake_up(), that might be called from irq context.
390 static void ep_poll_safewake(struct poll_safewake
*psw
, wait_queue_head_t
*wq
)
394 struct task_struct
*this_task
= current
;
395 struct list_head
*lsthead
= &psw
->wake_task_list
, *lnk
;
396 struct wake_task_node
*tncur
;
397 struct wake_task_node tnode
;
399 spin_lock_irqsave(&psw
->lock
, flags
);
401 /* Try to see if the current task is already inside this wakeup call */
402 list_for_each(lnk
, lsthead
) {
403 tncur
= list_entry(lnk
, struct wake_task_node
, llink
);
405 if (tncur
->wq
== wq
||
406 (tncur
->task
== this_task
&& ++wake_nests
> EP_MAX_POLLWAKE_NESTS
)) {
408 * Ops ... loop detected or maximum nest level reached.
409 * We abort this wake by breaking the cycle itself.
411 spin_unlock_irqrestore(&psw
->lock
, flags
);
416 /* Add the current task to the list */
417 tnode
.task
= this_task
;
419 list_add(&tnode
.llink
, lsthead
);
421 spin_unlock_irqrestore(&psw
->lock
, flags
);
423 /* Do really wake up now */
426 /* Remove the current task from the list */
427 spin_lock_irqsave(&psw
->lock
, flags
);
428 list_del(&tnode
.llink
);
429 spin_unlock_irqrestore(&psw
->lock
, flags
);
434 * This is called from eventpoll_release() to unlink files from the eventpoll
435 * interface. We need to have this facility to cleanup correctly files that are
436 * closed without being removed from the eventpoll interface.
438 void eventpoll_release_file(struct file
*file
)
440 struct list_head
*lsthead
= &file
->f_ep_links
;
441 struct eventpoll
*ep
;
445 * We don't want to get "file->f_ep_lock" because it is not
446 * necessary. It is not necessary because we're in the "struct file"
447 * cleanup path, and this means that noone is using this file anymore.
448 * The only hit might come from ep_free() but by holding the semaphore
449 * will correctly serialize the operation. We do need to acquire
450 * "ep->sem" after "epmutex" because ep_remove() requires it when called
451 * from anywhere but ep_free().
453 mutex_lock(&epmutex
);
455 while (!list_empty(lsthead
)) {
456 epi
= list_entry(lsthead
->next
, struct epitem
, fllink
);
459 list_del_init(&epi
->fllink
);
460 down_write(&ep
->sem
);
465 mutex_unlock(&epmutex
);
470 * It opens an eventpoll file descriptor by suggesting a storage of "size"
471 * file descriptors. The size parameter is just an hint about how to size
472 * data structures. It won't prevent the user to store more than "size"
473 * file descriptors inside the epoll interface. It is the kernel part of
474 * the userspace epoll_create(2).
476 asmlinkage
long sys_epoll_create(int size
)
479 struct eventpoll
*ep
;
483 DNPRINTK(3, (KERN_INFO
"[%p] eventpoll: sys_epoll_create(%d)\n",
487 * Sanity check on the size parameter, and create the internal data
488 * structure ( "struct eventpoll" ).
491 if (size
<= 0 || (error
= ep_alloc(&ep
)) != 0)
495 * Creates all the items needed to setup an eventpoll file. That is,
496 * a file structure, and inode and a free file descriptor.
498 error
= ep_getfd(&fd
, &inode
, &file
, ep
);
502 DNPRINTK(3, (KERN_INFO
"[%p] eventpoll: sys_epoll_create(%d) = %d\n",
511 DNPRINTK(3, (KERN_INFO
"[%p] eventpoll: sys_epoll_create(%d) = %d\n",
512 current
, size
, error
));
518 * The following function implements the controller interface for
519 * the eventpoll file that enables the insertion/removal/change of
520 * file descriptors inside the interest set. It represents
521 * the kernel part of the user space epoll_ctl(2).
524 sys_epoll_ctl(int epfd
, int op
, int fd
, struct epoll_event __user
*event
)
527 struct file
*file
, *tfile
;
528 struct eventpoll
*ep
;
530 struct epoll_event epds
;
532 DNPRINTK(3, (KERN_INFO
"[%p] eventpoll: sys_epoll_ctl(%d, %d, %d, %p)\n",
533 current
, epfd
, op
, fd
, event
));
536 if (ep_op_has_event(op
) &&
537 copy_from_user(&epds
, event
, sizeof(struct epoll_event
)))
540 /* Get the "struct file *" for the eventpoll file */
546 /* Get the "struct file *" for the target file */
551 /* The target file descriptor must support poll */
553 if (!tfile
->f_op
|| !tfile
->f_op
->poll
)
557 * We have to check that the file structure underneath the file descriptor
558 * the user passed to us _is_ an eventpoll file. And also we do not permit
559 * adding an epoll file descriptor inside itself.
562 if (file
== tfile
|| !is_file_epoll(file
))
566 * At this point it is safe to assume that the "private_data" contains
567 * our own data structure.
569 ep
= file
->private_data
;
571 down_write(&ep
->sem
);
573 /* Try to lookup the file inside our RB tree */
574 epi
= ep_find(ep
, tfile
, fd
);
580 epds
.events
|= POLLERR
| POLLHUP
;
582 error
= ep_insert(ep
, &epds
, tfile
, fd
);
588 error
= ep_remove(ep
, epi
);
594 epds
.events
|= POLLERR
| POLLHUP
;
595 error
= ep_modify(ep
, epi
, &epds
);
602 * The function ep_find() increments the usage count of the structure
603 * so, if this is not NULL, we need to release it.
606 ep_release_epitem(epi
);
615 DNPRINTK(3, (KERN_INFO
"[%p] eventpoll: sys_epoll_ctl(%d, %d, %d, %p) = %d\n",
616 current
, epfd
, op
, fd
, event
, error
));
623 * Implement the event wait interface for the eventpoll file. It is the kernel
624 * part of the user space epoll_wait(2).
626 asmlinkage
long sys_epoll_wait(int epfd
, struct epoll_event __user
*events
,
627 int maxevents
, int timeout
)
631 struct eventpoll
*ep
;
633 DNPRINTK(3, (KERN_INFO
"[%p] eventpoll: sys_epoll_wait(%d, %p, %d, %d)\n",
634 current
, epfd
, events
, maxevents
, timeout
));
636 /* The maximum number of event must be greater than zero */
637 if (maxevents
<= 0 || maxevents
> EP_MAX_EVENTS
)
640 /* Verify that the area passed by the user is writeable */
641 if (!access_ok(VERIFY_WRITE
, events
, maxevents
* sizeof(struct epoll_event
))) {
646 /* Get the "struct file *" for the eventpoll file */
653 * We have to check that the file structure underneath the fd
654 * the user passed to us _is_ an eventpoll file.
657 if (!is_file_epoll(file
))
661 * At this point it is safe to assume that the "private_data" contains
662 * our own data structure.
664 ep
= file
->private_data
;
666 /* Time to fish for events ... */
667 error
= ep_poll(ep
, events
, maxevents
, timeout
);
672 DNPRINTK(3, (KERN_INFO
"[%p] eventpoll: sys_epoll_wait(%d, %p, %d, %d) = %d\n",
673 current
, epfd
, events
, maxevents
, timeout
, error
));
679 #ifdef TIF_RESTORE_SIGMASK
682 * Implement the event wait interface for the eventpoll file. It is the kernel
683 * part of the user space epoll_pwait(2).
685 asmlinkage
long sys_epoll_pwait(int epfd
, struct epoll_event __user
*events
,
686 int maxevents
, int timeout
, const sigset_t __user
*sigmask
,
690 sigset_t ksigmask
, sigsaved
;
693 * If the caller wants a certain signal mask to be set during the wait,
697 if (sigsetsize
!= sizeof(sigset_t
))
699 if (copy_from_user(&ksigmask
, sigmask
, sizeof(ksigmask
)))
701 sigdelsetmask(&ksigmask
, sigmask(SIGKILL
) | sigmask(SIGSTOP
));
702 sigprocmask(SIG_SETMASK
, &ksigmask
, &sigsaved
);
705 error
= sys_epoll_wait(epfd
, events
, maxevents
, timeout
);
708 * If we changed the signal mask, we need to restore the original one.
709 * In case we've got a signal while waiting, we do not restore the
710 * signal mask yet, and we allow do_signal() to deliver the signal on
711 * the way back to userspace, before the signal mask is restored.
714 if (error
== -EINTR
) {
715 memcpy(¤t
->saved_sigmask
, &sigsaved
,
717 set_thread_flag(TIF_RESTORE_SIGMASK
);
719 sigprocmask(SIG_SETMASK
, &sigsaved
, NULL
);
725 #endif /* #ifdef TIF_RESTORE_SIGMASK */
729 * Creates the file descriptor to be used by the epoll interface.
731 static int ep_getfd(int *efd
, struct inode
**einode
, struct file
**efile
,
732 struct eventpoll
*ep
)
736 struct dentry
*dentry
;
741 /* Get an ready to use file */
743 file
= get_empty_filp();
747 /* Allocates an inode from the eventpoll file system */
748 inode
= ep_eventpoll_inode();
750 error
= PTR_ERR(inode
);
754 /* Allocates a free descriptor to plug the file onto */
755 error
= get_unused_fd();
761 * Link the inode to a directory entry by creating a unique name
762 * using the inode number.
765 sprintf(name
, "[%lu]", inode
->i_ino
);
767 this.len
= strlen(name
);
768 this.hash
= inode
->i_ino
;
769 dentry
= d_alloc(eventpoll_mnt
->mnt_sb
->s_root
, &this);
772 dentry
->d_op
= &eventpollfs_dentry_operations
;
773 d_add(dentry
, inode
);
774 file
->f_path
.mnt
= mntget(eventpoll_mnt
);
775 file
->f_path
.dentry
= dentry
;
776 file
->f_mapping
= inode
->i_mapping
;
779 file
->f_flags
= O_RDONLY
;
780 file
->f_op
= &eventpoll_fops
;
781 file
->f_mode
= FMODE_READ
;
783 file
->private_data
= ep
;
785 /* Install the new setup file into the allocated fd. */
786 fd_install(fd
, file
);
804 static int ep_alloc(struct eventpoll
**pep
)
806 struct eventpoll
*ep
= kzalloc(sizeof(*ep
), GFP_KERNEL
);
811 rwlock_init(&ep
->lock
);
812 init_rwsem(&ep
->sem
);
813 init_waitqueue_head(&ep
->wq
);
814 init_waitqueue_head(&ep
->poll_wait
);
815 INIT_LIST_HEAD(&ep
->rdllist
);
820 DNPRINTK(3, (KERN_INFO
"[%p] eventpoll: ep_alloc() ep=%p\n",
826 static void ep_free(struct eventpoll
*ep
)
831 /* We need to release all tasks waiting for these file */
832 if (waitqueue_active(&ep
->poll_wait
))
833 ep_poll_safewake(&psw
, &ep
->poll_wait
);
836 * We need to lock this because we could be hit by
837 * eventpoll_release_file() while we're freeing the "struct eventpoll".
838 * We do not need to hold "ep->sem" here because the epoll file
839 * is on the way to be removed and no one has references to it
840 * anymore. The only hit might come from eventpoll_release_file() but
841 * holding "epmutex" is sufficent here.
843 mutex_lock(&epmutex
);
846 * Walks through the whole tree by unregistering poll callbacks.
848 for (rbp
= rb_first(&ep
->rbr
); rbp
; rbp
= rb_next(rbp
)) {
849 epi
= rb_entry(rbp
, struct epitem
, rbn
);
851 ep_unregister_pollwait(ep
, epi
);
855 * Walks through the whole tree by freeing each "struct epitem". At this
856 * point we are sure no poll callbacks will be lingering around, and also by
857 * write-holding "sem" we can be sure that no file cleanup code will hit
858 * us during this operation. So we can avoid the lock on "ep->lock".
860 while ((rbp
= rb_first(&ep
->rbr
)) != 0) {
861 epi
= rb_entry(rbp
, struct epitem
, rbn
);
865 mutex_unlock(&epmutex
);
870 * Search the file inside the eventpoll tree. It add usage count to
871 * the returned item, so the caller must call ep_release_epitem()
872 * after finished using the "struct epitem".
874 static struct epitem
*ep_find(struct eventpoll
*ep
, struct file
*file
, int fd
)
879 struct epitem
*epi
, *epir
= NULL
;
880 struct epoll_filefd ffd
;
882 ep_set_ffd(&ffd
, file
, fd
);
883 read_lock_irqsave(&ep
->lock
, flags
);
884 for (rbp
= ep
->rbr
.rb_node
; rbp
; ) {
885 epi
= rb_entry(rbp
, struct epitem
, rbn
);
886 kcmp
= ep_cmp_ffd(&ffd
, &epi
->ffd
);
897 read_unlock_irqrestore(&ep
->lock
, flags
);
899 DNPRINTK(3, (KERN_INFO
"[%p] eventpoll: ep_find(%p) -> %p\n",
900 current
, file
, epir
));
907 * Increment the usage count of the "struct epitem" making it sure
908 * that the user will have a valid pointer to reference.
910 static void ep_use_epitem(struct epitem
*epi
)
913 atomic_inc(&epi
->usecnt
);
918 * Decrement ( release ) the usage count by signaling that the user
919 * has finished using the structure. It might lead to freeing the
920 * structure itself if the count goes to zero.
922 static void ep_release_epitem(struct epitem
*epi
)
925 if (atomic_dec_and_test(&epi
->usecnt
))
926 kmem_cache_free(epi_cache
, epi
);
931 * This is the callback that is used to add our wait queue to the
932 * target file wakeup lists.
934 static void ep_ptable_queue_proc(struct file
*file
, wait_queue_head_t
*whead
,
937 struct epitem
*epi
= ep_item_from_epqueue(pt
);
938 struct eppoll_entry
*pwq
;
940 if (epi
->nwait
>= 0 && (pwq
= kmem_cache_alloc(pwq_cache
, GFP_KERNEL
))) {
941 init_waitqueue_func_entry(&pwq
->wait
, ep_poll_callback
);
944 add_wait_queue(whead
, &pwq
->wait
);
945 list_add_tail(&pwq
->llink
, &epi
->pwqlist
);
948 /* We have to signal that an error occurred */
954 static void ep_rbtree_insert(struct eventpoll
*ep
, struct epitem
*epi
)
957 struct rb_node
**p
= &ep
->rbr
.rb_node
, *parent
= NULL
;
962 epic
= rb_entry(parent
, struct epitem
, rbn
);
963 kcmp
= ep_cmp_ffd(&epi
->ffd
, &epic
->ffd
);
965 p
= &parent
->rb_right
;
967 p
= &parent
->rb_left
;
969 rb_link_node(&epi
->rbn
, parent
, p
);
970 rb_insert_color(&epi
->rbn
, &ep
->rbr
);
974 static int ep_insert(struct eventpoll
*ep
, struct epoll_event
*event
,
975 struct file
*tfile
, int fd
)
977 int error
, revents
, pwake
= 0;
980 struct ep_pqueue epq
;
983 if (!(epi
= kmem_cache_alloc(epi_cache
, GFP_KERNEL
)))
986 /* Item initialization follow here ... */
987 ep_rb_initnode(&epi
->rbn
);
988 INIT_LIST_HEAD(&epi
->rdllink
);
989 INIT_LIST_HEAD(&epi
->fllink
);
990 INIT_LIST_HEAD(&epi
->pwqlist
);
992 ep_set_ffd(&epi
->ffd
, tfile
, fd
);
994 atomic_set(&epi
->usecnt
, 1);
997 /* Initialize the poll table using the queue callback */
999 init_poll_funcptr(&epq
.pt
, ep_ptable_queue_proc
);
1002 * Attach the item to the poll hooks and get current event bits.
1003 * We can safely use the file* here because its usage count has
1004 * been increased by the caller of this function.
1006 revents
= tfile
->f_op
->poll(tfile
, &epq
.pt
);
1009 * We have to check if something went wrong during the poll wait queue
1010 * install process. Namely an allocation for a wait queue failed due
1011 * high memory pressure.
1016 /* Add the current item to the list of active epoll hook for this file */
1017 spin_lock(&tfile
->f_ep_lock
);
1018 list_add_tail(&epi
->fllink
, &tfile
->f_ep_links
);
1019 spin_unlock(&tfile
->f_ep_lock
);
1021 /* We have to drop the new item inside our item list to keep track of it */
1022 write_lock_irqsave(&ep
->lock
, flags
);
1024 /* Add the current item to the rb-tree */
1025 ep_rbtree_insert(ep
, epi
);
1027 /* If the file is already "ready" we drop it inside the ready list */
1028 if ((revents
& event
->events
) && !ep_is_linked(&epi
->rdllink
)) {
1029 list_add_tail(&epi
->rdllink
, &ep
->rdllist
);
1031 /* Notify waiting tasks that events are available */
1032 if (waitqueue_active(&ep
->wq
))
1033 __wake_up_locked(&ep
->wq
, TASK_UNINTERRUPTIBLE
| TASK_INTERRUPTIBLE
);
1034 if (waitqueue_active(&ep
->poll_wait
))
1038 write_unlock_irqrestore(&ep
->lock
, flags
);
1040 /* We have to call this outside the lock */
1042 ep_poll_safewake(&psw
, &ep
->poll_wait
);
1044 DNPRINTK(3, (KERN_INFO
"[%p] eventpoll: ep_insert(%p, %p, %d)\n",
1045 current
, ep
, tfile
, fd
));
1050 ep_unregister_pollwait(ep
, epi
);
1053 * We need to do this because an event could have been arrived on some
1054 * allocated wait queue.
1056 write_lock_irqsave(&ep
->lock
, flags
);
1057 if (ep_is_linked(&epi
->rdllink
))
1058 list_del_init(&epi
->rdllink
);
1059 write_unlock_irqrestore(&ep
->lock
, flags
);
1061 kmem_cache_free(epi_cache
, epi
);
1068 * Modify the interest event mask by dropping an event if the new mask
1069 * has a match in the current file status.
1071 static int ep_modify(struct eventpoll
*ep
, struct epitem
*epi
, struct epoll_event
*event
)
1074 unsigned int revents
;
1075 unsigned long flags
;
1078 * Set the new event interest mask before calling f_op->poll(), otherwise
1079 * a potential race might occur. In fact if we do this operation inside
1080 * the lock, an event might happen between the f_op->poll() call and the
1081 * new event set registering.
1083 epi
->event
.events
= event
->events
;
1086 * Get current event bits. We can safely use the file* here because
1087 * its usage count has been increased by the caller of this function.
1089 revents
= epi
->ffd
.file
->f_op
->poll(epi
->ffd
.file
, NULL
);
1091 write_lock_irqsave(&ep
->lock
, flags
);
1093 /* Copy the data member from inside the lock */
1094 epi
->event
.data
= event
->data
;
1097 * If the item is not linked to the RB tree it means that it's on its
1098 * way toward the removal. Do nothing in this case.
1100 if (ep_rb_linked(&epi
->rbn
)) {
1102 * If the item is "hot" and it is not registered inside the ready
1103 * list, push it inside. If the item is not "hot" and it is currently
1104 * registered inside the ready list, unlink it.
1106 if (revents
& event
->events
) {
1107 if (!ep_is_linked(&epi
->rdllink
)) {
1108 list_add_tail(&epi
->rdllink
, &ep
->rdllist
);
1110 /* Notify waiting tasks that events are available */
1111 if (waitqueue_active(&ep
->wq
))
1112 __wake_up_locked(&ep
->wq
, TASK_UNINTERRUPTIBLE
|
1113 TASK_INTERRUPTIBLE
);
1114 if (waitqueue_active(&ep
->poll_wait
))
1120 write_unlock_irqrestore(&ep
->lock
, flags
);
1122 /* We have to call this outside the lock */
1124 ep_poll_safewake(&psw
, &ep
->poll_wait
);
1131 * This function unregister poll callbacks from the associated file descriptor.
1132 * Since this must be called without holding "ep->lock" the atomic exchange trick
1133 * will protect us from multiple unregister.
1135 static void ep_unregister_pollwait(struct eventpoll
*ep
, struct epitem
*epi
)
1138 struct list_head
*lsthead
= &epi
->pwqlist
;
1139 struct eppoll_entry
*pwq
;
1141 /* This is called without locks, so we need the atomic exchange */
1142 nwait
= xchg(&epi
->nwait
, 0);
1145 while (!list_empty(lsthead
)) {
1146 pwq
= list_entry(lsthead
->next
, struct eppoll_entry
, llink
);
1148 list_del_init(&pwq
->llink
);
1149 remove_wait_queue(pwq
->whead
, &pwq
->wait
);
1150 kmem_cache_free(pwq_cache
, pwq
);
1157 * Unlink the "struct epitem" from all places it might have been hooked up.
1158 * This function must be called with write IRQ lock on "ep->lock".
1160 static int ep_unlink(struct eventpoll
*ep
, struct epitem
*epi
)
1165 * It can happen that this one is called for an item already unlinked.
1166 * The check protect us from doing a double unlink ( crash ).
1169 if (!ep_rb_linked(&epi
->rbn
))
1173 * Clear the event mask for the unlinked item. This will avoid item
1174 * notifications to be sent after the unlink operation from inside
1175 * the kernel->userspace event transfer loop.
1177 epi
->event
.events
= 0;
1180 * At this point is safe to do the job, unlink the item from our rb-tree.
1181 * This operation togheter with the above check closes the door to
1184 ep_rb_erase(&epi
->rbn
, &ep
->rbr
);
1187 * If the item we are going to remove is inside the ready file descriptors
1188 * we want to remove it from this list to avoid stale events.
1190 if (ep_is_linked(&epi
->rdllink
))
1191 list_del_init(&epi
->rdllink
);
1196 DNPRINTK(3, (KERN_INFO
"[%p] eventpoll: ep_unlink(%p, %p) = %d\n",
1197 current
, ep
, epi
->ffd
.file
, error
));
1204 * Removes a "struct epitem" from the eventpoll RB tree and deallocates
1205 * all the associated resources.
1207 static int ep_remove(struct eventpoll
*ep
, struct epitem
*epi
)
1210 unsigned long flags
;
1211 struct file
*file
= epi
->ffd
.file
;
1214 * Removes poll wait queue hooks. We _have_ to do this without holding
1215 * the "ep->lock" otherwise a deadlock might occur. This because of the
1216 * sequence of the lock acquisition. Here we do "ep->lock" then the wait
1217 * queue head lock when unregistering the wait queue. The wakeup callback
1218 * will run by holding the wait queue head lock and will call our callback
1219 * that will try to get "ep->lock".
1221 ep_unregister_pollwait(ep
, epi
);
1223 /* Remove the current item from the list of epoll hooks */
1224 spin_lock(&file
->f_ep_lock
);
1225 if (ep_is_linked(&epi
->fllink
))
1226 list_del_init(&epi
->fllink
);
1227 spin_unlock(&file
->f_ep_lock
);
1229 /* We need to acquire the write IRQ lock before calling ep_unlink() */
1230 write_lock_irqsave(&ep
->lock
, flags
);
1232 /* Really unlink the item from the RB tree */
1233 error
= ep_unlink(ep
, epi
);
1235 write_unlock_irqrestore(&ep
->lock
, flags
);
1240 /* At this point it is safe to free the eventpoll item */
1241 ep_release_epitem(epi
);
1245 DNPRINTK(3, (KERN_INFO
"[%p] eventpoll: ep_remove(%p, %p) = %d\n",
1246 current
, ep
, file
, error
));
1253 * This is the callback that is passed to the wait queue wakeup
1254 * machanism. It is called by the stored file descriptors when they
1255 * have events to report.
1257 static int ep_poll_callback(wait_queue_t
*wait
, unsigned mode
, int sync
, void *key
)
1260 unsigned long flags
;
1261 struct epitem
*epi
= ep_item_from_wait(wait
);
1262 struct eventpoll
*ep
= epi
->ep
;
1264 DNPRINTK(3, (KERN_INFO
"[%p] eventpoll: poll_callback(%p) epi=%p ep=%p\n",
1265 current
, epi
->ffd
.file
, epi
, ep
));
1267 write_lock_irqsave(&ep
->lock
, flags
);
1270 * If the event mask does not contain any poll(2) event, we consider the
1271 * descriptor to be disabled. This condition is likely the effect of the
1272 * EPOLLONESHOT bit that disables the descriptor when an event is received,
1273 * until the next EPOLL_CTL_MOD will be issued.
1275 if (!(epi
->event
.events
& ~EP_PRIVATE_BITS
))
1278 /* If this file is already in the ready list we exit soon */
1279 if (ep_is_linked(&epi
->rdllink
))
1282 list_add_tail(&epi
->rdllink
, &ep
->rdllist
);
1286 * Wake up ( if active ) both the eventpoll wait list and the ->poll()
1289 if (waitqueue_active(&ep
->wq
))
1290 __wake_up_locked(&ep
->wq
, TASK_UNINTERRUPTIBLE
|
1291 TASK_INTERRUPTIBLE
);
1292 if (waitqueue_active(&ep
->poll_wait
))
1296 write_unlock_irqrestore(&ep
->lock
, flags
);
1298 /* We have to call this outside the lock */
1300 ep_poll_safewake(&psw
, &ep
->poll_wait
);
1306 static int ep_eventpoll_close(struct inode
*inode
, struct file
*file
)
1308 struct eventpoll
*ep
= file
->private_data
;
1315 DNPRINTK(3, (KERN_INFO
"[%p] eventpoll: close() ep=%p\n", current
, ep
));
1320 static unsigned int ep_eventpoll_poll(struct file
*file
, poll_table
*wait
)
1322 unsigned int pollflags
= 0;
1323 unsigned long flags
;
1324 struct eventpoll
*ep
= file
->private_data
;
1326 /* Insert inside our poll wait queue */
1327 poll_wait(file
, &ep
->poll_wait
, wait
);
1329 /* Check our condition */
1330 read_lock_irqsave(&ep
->lock
, flags
);
1331 if (!list_empty(&ep
->rdllist
))
1332 pollflags
= POLLIN
| POLLRDNORM
;
1333 read_unlock_irqrestore(&ep
->lock
, flags
);
1340 * This function is called without holding the "ep->lock" since the call to
1341 * __copy_to_user() might sleep, and also f_op->poll() might reenable the IRQ
1342 * because of the way poll() is traditionally implemented in Linux.
1344 static int ep_send_events(struct eventpoll
*ep
, struct list_head
*txlist
,
1345 struct epoll_event __user
*events
, int maxevents
)
1347 int eventcnt
, error
= -EFAULT
, pwake
= 0;
1348 unsigned int revents
;
1349 unsigned long flags
;
1351 struct list_head injlist
;
1353 INIT_LIST_HEAD(&injlist
);
1356 * We can loop without lock because this is a task private list.
1357 * We just splice'd out the ep->rdllist in ep_collect_ready_items().
1358 * Items cannot vanish during the loop because we are holding "sem" in
1361 for (eventcnt
= 0; !list_empty(txlist
) && eventcnt
< maxevents
;) {
1362 epi
= list_entry(txlist
->next
, struct epitem
, rdllink
);
1363 prefetch(epi
->rdllink
.next
);
1366 * Get the ready file event set. We can safely use the file
1367 * because we are holding the "sem" in read and this will
1368 * guarantee that both the file and the item will not vanish.
1370 revents
= epi
->ffd
.file
->f_op
->poll(epi
->ffd
.file
, NULL
);
1371 revents
&= epi
->event
.events
;
1374 * Is the event mask intersect the caller-requested one,
1375 * deliver the event to userspace. Again, we are holding
1376 * "sem" in read, so no operations coming from userspace
1377 * can change the item.
1380 if (__put_user(revents
,
1381 &events
[eventcnt
].events
) ||
1382 __put_user(epi
->event
.data
,
1383 &events
[eventcnt
].data
))
1385 if (epi
->event
.events
& EPOLLONESHOT
)
1386 epi
->event
.events
&= EP_PRIVATE_BITS
;
1391 * This is tricky. We are holding the "sem" in read, and this
1392 * means that the operations that can change the "linked" status
1393 * of the epoll item (epi->rbn and epi->rdllink), cannot touch
1394 * them. Also, since we are "linked" from a epi->rdllink POV
1395 * (the item is linked to our transmission list we just
1396 * spliced), the ep_poll_callback() cannot touch us either,
1397 * because of the check present in there. Another parallel
1398 * epoll_wait() will not get the same result set, since we
1399 * spliced the ready list before. Note that list_del() still
1400 * shows the item as linked to the test in ep_poll_callback().
1402 list_del(&epi
->rdllink
);
1403 if (!(epi
->event
.events
& EPOLLET
) &&
1404 (revents
& epi
->event
.events
))
1405 list_add_tail(&epi
->rdllink
, &injlist
);
1408 * Be sure the item is totally detached before re-init
1409 * the list_head. After INIT_LIST_HEAD() is committed,
1410 * the ep_poll_callback() can requeue the item again,
1411 * but we don't care since we are already past it.
1414 INIT_LIST_HEAD(&epi
->rdllink
);
1422 * If the re-injection list or the txlist are not empty, re-splice
1423 * them to the ready list and do proper wakeups.
1425 if (!list_empty(&injlist
) || !list_empty(txlist
)) {
1426 write_lock_irqsave(&ep
->lock
, flags
);
1428 list_splice(txlist
, &ep
->rdllist
);
1429 list_splice(&injlist
, &ep
->rdllist
);
1431 * Wake up ( if active ) both the eventpoll wait list and the ->poll()
1434 if (waitqueue_active(&ep
->wq
))
1435 __wake_up_locked(&ep
->wq
, TASK_UNINTERRUPTIBLE
|
1436 TASK_INTERRUPTIBLE
);
1437 if (waitqueue_active(&ep
->poll_wait
))
1440 write_unlock_irqrestore(&ep
->lock
, flags
);
1443 /* We have to call this outside the lock */
1445 ep_poll_safewake(&psw
, &ep
->poll_wait
);
1447 return eventcnt
== 0 ? error
: eventcnt
;
1452 * Perform the transfer of events to user space.
1454 static int ep_events_transfer(struct eventpoll
*ep
,
1455 struct epoll_event __user
*events
, int maxevents
)
1458 unsigned long flags
;
1459 struct list_head txlist
;
1461 INIT_LIST_HEAD(&txlist
);
1464 * We need to lock this because we could be hit by
1465 * eventpoll_release_file() and epoll_ctl(EPOLL_CTL_DEL).
1467 down_read(&ep
->sem
);
1470 * Steal the ready list, and re-init the original one to the
1473 write_lock_irqsave(&ep
->lock
, flags
);
1474 list_splice(&ep
->rdllist
, &txlist
);
1475 INIT_LIST_HEAD(&ep
->rdllist
);
1476 write_unlock_irqrestore(&ep
->lock
, flags
);
1478 /* Build result set in userspace */
1479 eventcnt
= ep_send_events(ep
, &txlist
, events
, maxevents
);
1487 static int ep_poll(struct eventpoll
*ep
, struct epoll_event __user
*events
,
1488 int maxevents
, long timeout
)
1491 unsigned long flags
;
1496 * Calculate the timeout by checking for the "infinite" value ( -1 )
1497 * and the overflow condition. The passed timeout is in milliseconds,
1498 * that why (t * HZ) / 1000.
1500 jtimeout
= (timeout
< 0 || timeout
>= EP_MAX_MSTIMEO
) ?
1501 MAX_SCHEDULE_TIMEOUT
: (timeout
* HZ
+ 999) / 1000;
1504 write_lock_irqsave(&ep
->lock
, flags
);
1507 if (list_empty(&ep
->rdllist
)) {
1509 * We don't have any available event to return to the caller.
1510 * We need to sleep here, and we will be wake up by
1511 * ep_poll_callback() when events will become available.
1513 init_waitqueue_entry(&wait
, current
);
1514 __add_wait_queue(&ep
->wq
, &wait
);
1518 * We don't want to sleep if the ep_poll_callback() sends us
1519 * a wakeup in between. That's why we set the task state
1520 * to TASK_INTERRUPTIBLE before doing the checks.
1522 set_current_state(TASK_INTERRUPTIBLE
);
1523 if (!list_empty(&ep
->rdllist
) || !jtimeout
)
1525 if (signal_pending(current
)) {
1530 write_unlock_irqrestore(&ep
->lock
, flags
);
1531 jtimeout
= schedule_timeout(jtimeout
);
1532 write_lock_irqsave(&ep
->lock
, flags
);
1534 __remove_wait_queue(&ep
->wq
, &wait
);
1536 set_current_state(TASK_RUNNING
);
1539 /* Is it worth to try to dig for events ? */
1540 eavail
= !list_empty(&ep
->rdllist
);
1542 write_unlock_irqrestore(&ep
->lock
, flags
);
1545 * Try to transfer events to user space. In case we get 0 events and
1546 * there's still timeout left over, we go trying again in search of
1549 if (!res
&& eavail
&&
1550 !(res
= ep_events_transfer(ep
, events
, maxevents
)) && jtimeout
)
1556 static int eventpollfs_delete_dentry(struct dentry
*dentry
)
1562 static struct inode
*ep_eventpoll_inode(void)
1564 int error
= -ENOMEM
;
1565 struct inode
*inode
= new_inode(eventpoll_mnt
->mnt_sb
);
1570 inode
->i_fop
= &eventpoll_fops
;
1573 * Mark the inode dirty from the very beginning,
1574 * that way it will never be moved to the dirty
1575 * list because mark_inode_dirty() will think
1576 * that it already _is_ on the dirty list.
1578 inode
->i_state
= I_DIRTY
;
1579 inode
->i_mode
= S_IRUSR
| S_IWUSR
;
1580 inode
->i_uid
= current
->fsuid
;
1581 inode
->i_gid
= current
->fsgid
;
1582 inode
->i_atime
= inode
->i_mtime
= inode
->i_ctime
= CURRENT_TIME
;
1586 return ERR_PTR(error
);
1590 eventpollfs_get_sb(struct file_system_type
*fs_type
, int flags
,
1591 const char *dev_name
, void *data
, struct vfsmount
*mnt
)
1593 return get_sb_pseudo(fs_type
, "eventpoll:", NULL
, EVENTPOLLFS_MAGIC
,
1598 static int __init
eventpoll_init(void)
1602 mutex_init(&epmutex
);
1604 /* Initialize the structure used to perform safe poll wait head wake ups */
1605 ep_poll_safewake_init(&psw
);
1607 /* Allocates slab cache used to allocate "struct epitem" items */
1608 epi_cache
= kmem_cache_create("eventpoll_epi", sizeof(struct epitem
),
1609 0, SLAB_HWCACHE_ALIGN
|EPI_SLAB_DEBUG
|SLAB_PANIC
,
1612 /* Allocates slab cache used to allocate "struct eppoll_entry" */
1613 pwq_cache
= kmem_cache_create("eventpoll_pwq",
1614 sizeof(struct eppoll_entry
), 0,
1615 EPI_SLAB_DEBUG
|SLAB_PANIC
, NULL
, NULL
);
1618 * Register the virtual file system that will be the source of inodes
1619 * for the eventpoll files
1621 error
= register_filesystem(&eventpoll_fs_type
);
1625 /* Mount the above commented virtual file system */
1626 eventpoll_mnt
= kern_mount(&eventpoll_fs_type
);
1627 error
= PTR_ERR(eventpoll_mnt
);
1628 if (IS_ERR(eventpoll_mnt
))
1631 DNPRINTK(3, (KERN_INFO
"[%p] eventpoll: successfully initialized.\n",
1636 panic("eventpoll_init() failed\n");
1640 static void __exit
eventpoll_exit(void)
1642 /* Undo all operations done inside eventpoll_init() */
1643 unregister_filesystem(&eventpoll_fs_type
);
1644 mntput(eventpoll_mnt
);
1645 kmem_cache_destroy(pwq_cache
);
1646 kmem_cache_destroy(epi_cache
);
1649 module_init(eventpoll_init
);
1650 module_exit(eventpoll_exit
);
1652 MODULE_LICENSE("GPL");