blob: 865afb58266a7b7394de7de369cdcfaf5cb4832f [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Davide Libenzi5071f972009-03-31 15:24:10 -07002 * fs/eventpoll.c (Efficient event retrieval implementation)
3 * Copyright (C) 2001,...,2009 Davide Libenzi
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 *
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
Linus Torvalds1da177e2005-04-16 15:20:36 -070014#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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#include <linux/string.h>
25#include <linux/list.h>
26#include <linux/hash.h>
27#include <linux/spinlock.h>
28#include <linux/syscalls.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <linux/rbtree.h>
30#include <linux/wait.h>
31#include <linux/eventpoll.h>
32#include <linux/mount.h>
33#include <linux/bitops.h>
Arjan van de Ven144efe32006-03-23 03:00:32 -080034#include <linux/mutex.h>
Davide Libenzida66f7c2007-05-10 22:23:21 -070035#include <linux/anon_inodes.h>
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +020036#include <linux/device.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070037#include <asm/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070038#include <asm/io.h>
39#include <asm/mman.h>
Arun Sharma600634972011-07-26 16:09:06 -070040#include <linux/atomic.h>
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -080041#include <linux/proc_fs.h>
42#include <linux/seq_file.h>
Al Viro35280bd2013-02-24 14:52:17 -050043#include <linux/compat.h>
Jason Baronae10b2b2013-11-12 15:10:16 -080044#include <linux/rculist.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070045
Linus Torvalds1da177e2005-04-16 15:20:36 -070046/*
47 * LOCKING:
48 * There are three level of locking required by epoll :
49 *
Arjan van de Ven144efe32006-03-23 03:00:32 -080050 * 1) epmutex (mutex)
Davide Libenzic7ea7632007-05-15 01:40:47 -070051 * 2) ep->mtx (mutex)
52 * 3) ep->lock (spinlock)
Linus Torvalds1da177e2005-04-16 15:20:36 -070053 *
54 * The acquire order is the one listed above, from 1 to 3.
55 * We need a spinlock (ep->lock) because we manipulate objects
56 * from inside the poll callback, that might be triggered from
57 * a wake_up() that in turn might be called from IRQ context.
58 * So we can't sleep inside the poll callback and hence we need
59 * a spinlock. During the event transfer loop (from kernel to
60 * user space) we could end up sleeping due a copy_to_user(), so
61 * we need a lock that will allow us to sleep. This lock is a
Davide Libenzid47de162007-05-15 01:40:41 -070062 * mutex (ep->mtx). It is acquired during the event transfer loop,
63 * during epoll_ctl(EPOLL_CTL_DEL) and during eventpoll_release_file().
64 * Then we also need a global mutex to serialize eventpoll_release_file()
65 * and ep_free().
66 * This mutex is acquired by ep_free() during the epoll file
Linus Torvalds1da177e2005-04-16 15:20:36 -070067 * cleanup path and it is also acquired by eventpoll_release_file()
68 * if a file has been pushed inside an epoll set and it is then
Daniel Balutabf6a41d2011-01-30 23:42:29 +020069 * close()d without a previous call to epoll_ctl(EPOLL_CTL_DEL).
Davide Libenzi22bacca2011-02-25 14:44:12 -080070 * It is also acquired when inserting an epoll fd onto another epoll
71 * fd. We do this so that we walk the epoll tree and ensure that this
72 * insertion does not create a cycle of epoll file descriptors, which
73 * could lead to deadlock. We need a global mutex to prevent two
74 * simultaneous inserts (A into B and B into A) from racing and
75 * constructing a cycle without either insert observing that it is
76 * going to.
Nelson Elhaged8805e62011-10-31 17:13:14 -070077 * It is necessary to acquire multiple "ep->mtx"es at once in the
78 * case when one epoll fd is added to another. In this case, we
79 * always acquire the locks in the order of nesting (i.e. after
80 * epoll_ctl(e1, EPOLL_CTL_ADD, e2), e1->mtx will always be acquired
81 * before e2->mtx). Since we disallow cycles of epoll file
82 * descriptors, this ensures that the mutexes are well-ordered. In
83 * order to communicate this nesting to lockdep, when walking a tree
84 * of epoll file descriptors, we use the current recursion depth as
85 * the lockdep subkey.
Davide Libenzid47de162007-05-15 01:40:41 -070086 * It is possible to drop the "ep->mtx" and to use the global
87 * mutex "epmutex" (together with "ep->lock") to have it working,
88 * but having "ep->mtx" will make the interface more scalable.
Arjan van de Ven144efe32006-03-23 03:00:32 -080089 * Events that require holding "epmutex" are very rare, while for
Davide Libenzid47de162007-05-15 01:40:41 -070090 * normal operations the epoll private "ep->mtx" will guarantee
91 * a better scalability.
Linus Torvalds1da177e2005-04-16 15:20:36 -070092 */
93
Linus Torvalds1da177e2005-04-16 15:20:36 -070094/* Epoll private bits inside the event mask */
Jason Barondf0108c2016-01-20 14:59:24 -080095#define EP_PRIVATE_BITS (EPOLLWAKEUP | EPOLLONESHOT | EPOLLET | EPOLLEXCLUSIVE)
Linus Torvalds1da177e2005-04-16 15:20:36 -070096
Jason Baronb6a515c2016-02-05 15:37:04 -080097#define EPOLLINOUT_BITS (POLLIN | POLLOUT)
98
99#define EPOLLEXCLUSIVE_OK_BITS (EPOLLINOUT_BITS | POLLERR | POLLHUP | \
100 EPOLLWAKEUP | EPOLLET | EPOLLEXCLUSIVE)
101
Davide Libenzi5071f972009-03-31 15:24:10 -0700102/* Maximum number of nesting allowed inside epoll sets */
103#define EP_MAX_NESTS 4
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104
Davide Libenzib6119672006-10-11 01:21:44 -0700105#define EP_MAX_EVENTS (INT_MAX / sizeof(struct epoll_event))
106
Davide Libenzid47de162007-05-15 01:40:41 -0700107#define EP_UNACTIVE_PTR ((void *) -1L)
108
Davide Libenzi7ef99642008-12-01 13:13:55 -0800109#define EP_ITEM_COST (sizeof(struct epitem) + sizeof(struct eppoll_entry))
110
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111struct epoll_filefd {
112 struct file *file;
113 int fd;
Eric Wong39732ca2013-04-30 15:27:38 -0700114} __packed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115
116/*
Davide Libenzi5071f972009-03-31 15:24:10 -0700117 * Structure used to track possible nested calls, for too deep recursions
118 * and loop cycles.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119 */
Davide Libenzi5071f972009-03-31 15:24:10 -0700120struct nested_call_node {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121 struct list_head llink;
Davide Libenzi5071f972009-03-31 15:24:10 -0700122 void *cookie;
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700123 void *ctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124};
125
126/*
Davide Libenzi5071f972009-03-31 15:24:10 -0700127 * This structure is used as collector for nested calls, to check for
128 * maximum recursion dept and loop cycles.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129 */
Davide Libenzi5071f972009-03-31 15:24:10 -0700130struct nested_calls {
131 struct list_head tasks_call_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132 spinlock_t lock;
133};
134
135/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136 * Each file descriptor added to the eventpoll interface will
Davide Libenzi6192bd52007-05-08 00:25:41 -0700137 * have an entry of this type linked to the "rbr" RB tree.
Eric Wong39732ca2013-04-30 15:27:38 -0700138 * Avoid increasing the size of this struct, there can be many thousands
139 * of these on a server and we do not want this to take another cache line.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140 */
141struct epitem {
Jason Baronae10b2b2013-11-12 15:10:16 -0800142 union {
143 /* RB tree node links this structure to the eventpoll RB tree */
144 struct rb_node rbn;
145 /* Used to free the struct epitem */
146 struct rcu_head rcu;
147 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148
149 /* List header used to link this structure to the eventpoll ready list */
150 struct list_head rdllink;
151
Davide Libenzic7ea7632007-05-15 01:40:47 -0700152 /*
153 * Works together "struct eventpoll"->ovflist in keeping the
154 * single linked chain of items.
155 */
156 struct epitem *next;
157
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158 /* The file descriptor information this item refers to */
159 struct epoll_filefd ffd;
160
161 /* Number of active wait queue attached to poll operations */
162 int nwait;
163
164 /* List containing poll wait queues */
165 struct list_head pwqlist;
166
167 /* The "container" of this item */
168 struct eventpoll *ep;
169
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170 /* List header used to link this item to the "struct file" items list */
171 struct list_head fllink;
Davide Libenzid47de162007-05-15 01:40:41 -0700172
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200173 /* wakeup_source used when EPOLLWAKEUP is set */
Eric Wongeea1d582013-04-30 15:27:39 -0700174 struct wakeup_source __rcu *ws;
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200175
Davide Libenzic7ea7632007-05-15 01:40:47 -0700176 /* The structure that describe the interested events and the source fd */
177 struct epoll_event event;
Davide Libenzid47de162007-05-15 01:40:41 -0700178};
179
180/*
181 * This structure is stored inside the "private_data" member of the file
Daniel Balutabf6a41d2011-01-30 23:42:29 +0200182 * structure and represents the main data structure for the eventpoll
Davide Libenzid47de162007-05-15 01:40:41 -0700183 * interface.
184 */
185struct eventpoll {
Daniel Balutabf6a41d2011-01-30 23:42:29 +0200186 /* Protect the access to this structure */
Davide Libenzic7ea7632007-05-15 01:40:47 -0700187 spinlock_t lock;
Davide Libenzid47de162007-05-15 01:40:41 -0700188
189 /*
190 * This mutex is used to ensure that files are not removed
191 * while epoll is using them. This is held during the event
192 * collection loop, the file cleanup path, the epoll file exit
193 * code and the ctl operations.
194 */
195 struct mutex mtx;
196
197 /* Wait queue used by sys_epoll_wait() */
198 wait_queue_head_t wq;
199
200 /* Wait queue used by file->poll() */
201 wait_queue_head_t poll_wait;
202
203 /* List of ready file descriptors */
204 struct list_head rdllist;
205
Davide Libenzi67647d02007-05-15 01:40:52 -0700206 /* RB tree root used to store monitored fd structs */
Davide Libenzid47de162007-05-15 01:40:41 -0700207 struct rb_root rbr;
208
209 /*
210 * This is a single linked list that chains all the "struct epitem" that
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300211 * happened while transferring ready events to userspace w/out
Davide Libenzid47de162007-05-15 01:40:41 -0700212 * holding ->lock.
213 */
214 struct epitem *ovflist;
Davide Libenzi7ef99642008-12-01 13:13:55 -0800215
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200216 /* wakeup_source used when ep_scan_ready_list is running */
217 struct wakeup_source *ws;
218
Davide Libenzi7ef99642008-12-01 13:13:55 -0800219 /* The user that created the eventpoll descriptor */
220 struct user_struct *user;
Jason Baron28d82dc2012-01-12 17:17:43 -0800221
222 struct file *file;
223
224 /* used to optimize loop detection check */
Al Viro0ece2412020-09-10 08:30:05 -0400225 u64 gen;
Davide Libenzid47de162007-05-15 01:40:41 -0700226};
227
228/* Wait structure used by the poll hooks */
229struct eppoll_entry {
230 /* List header used to link this structure to the "struct epitem" */
231 struct list_head llink;
232
233 /* The "base" pointer is set to the container "struct epitem" */
Tony Battersby4f0989d2009-03-31 15:24:16 -0700234 struct epitem *base;
Davide Libenzid47de162007-05-15 01:40:41 -0700235
236 /*
237 * Wait queue item that will be linked to the target file wait
238 * queue head.
239 */
240 wait_queue_t wait;
241
242 /* The wait queue head that linked the "wait" wait queue item */
243 wait_queue_head_t *whead;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244};
245
246/* Wrapper struct used by poll queueing */
247struct ep_pqueue {
248 poll_table pt;
249 struct epitem *epi;
250};
251
Davide Libenzi5071f972009-03-31 15:24:10 -0700252/* Used by the ep_send_events() function as callback private data */
253struct ep_send_events_data {
254 int maxevents;
255 struct epoll_event __user *events;
256};
257
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258/*
Davide Libenzi7ef99642008-12-01 13:13:55 -0800259 * Configuration options available inside /proc/sys/fs/epoll/
260 */
Davide Libenzi7ef99642008-12-01 13:13:55 -0800261/* Maximum number of epoll watched descriptors, per user */
Robin Holt52bd19f72011-01-12 17:00:01 -0800262static long max_user_watches __read_mostly;
Davide Libenzi7ef99642008-12-01 13:13:55 -0800263
264/*
Davide Libenzid47de162007-05-15 01:40:41 -0700265 * This mutex is used to serialize ep_free() and eventpoll_release_file().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266 */
Davide Libenzi7ef99642008-12-01 13:13:55 -0800267static DEFINE_MUTEX(epmutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268
Al Viro0ece2412020-09-10 08:30:05 -0400269static u64 loop_check_gen = 0;
270
Davide Libenzi22bacca2011-02-25 14:44:12 -0800271/* Used to check for epoll file descriptor inclusion loops */
272static struct nested_calls poll_loop_ncalls;
273
Davide Libenzi5071f972009-03-31 15:24:10 -0700274/* Used for safe wake up implementation */
275static struct nested_calls poll_safewake_ncalls;
276
277/* Used to call file's f_op->poll() under the nested calls boundaries */
278static struct nested_calls poll_readywalk_ncalls;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279
280/* Slab cache used to allocate "struct epitem" */
Christoph Lametere18b8902006-12-06 20:33:20 -0800281static struct kmem_cache *epi_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282
283/* Slab cache used to allocate "struct eppoll_entry" */
Christoph Lametere18b8902006-12-06 20:33:20 -0800284static struct kmem_cache *pwq_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285
Jason Baron28d82dc2012-01-12 17:17:43 -0800286/*
287 * List of files with newly added links, where we may need to limit the number
288 * of emanating paths. Protected by the epmutex.
289 */
290static LIST_HEAD(tfile_check_list);
291
Davide Libenzi7ef99642008-12-01 13:13:55 -0800292#ifdef CONFIG_SYSCTL
293
294#include <linux/sysctl.h>
295
Robin Holt52bd19f72011-01-12 17:00:01 -0800296static long zero;
297static long long_max = LONG_MAX;
Davide Libenzi7ef99642008-12-01 13:13:55 -0800298
Joe Perches1f7e0612014-06-06 14:38:05 -0700299struct ctl_table epoll_table[] = {
Davide Libenzi7ef99642008-12-01 13:13:55 -0800300 {
Davide Libenzi7ef99642008-12-01 13:13:55 -0800301 .procname = "max_user_watches",
302 .data = &max_user_watches,
Robin Holt52bd19f72011-01-12 17:00:01 -0800303 .maxlen = sizeof(max_user_watches),
Davide Libenzi7ef99642008-12-01 13:13:55 -0800304 .mode = 0644,
Robin Holt52bd19f72011-01-12 17:00:01 -0800305 .proc_handler = proc_doulongvec_minmax,
Davide Libenzi7ef99642008-12-01 13:13:55 -0800306 .extra1 = &zero,
Robin Holt52bd19f72011-01-12 17:00:01 -0800307 .extra2 = &long_max,
Davide Libenzi7ef99642008-12-01 13:13:55 -0800308 },
Eric W. Biedermanab092032009-11-05 14:25:10 -0800309 { }
Davide Libenzi7ef99642008-12-01 13:13:55 -0800310};
311#endif /* CONFIG_SYSCTL */
312
Jason Baron28d82dc2012-01-12 17:17:43 -0800313static const struct file_operations eventpoll_fops;
314
315static inline int is_file_epoll(struct file *f)
316{
317 return f->f_op == &eventpoll_fops;
318}
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700319
Davide Libenzi67647d02007-05-15 01:40:52 -0700320/* Setup the structure that is used as key for the RB tree */
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700321static inline void ep_set_ffd(struct epoll_filefd *ffd,
322 struct file *file, int fd)
323{
324 ffd->file = file;
325 ffd->fd = fd;
326}
327
Davide Libenzi67647d02007-05-15 01:40:52 -0700328/* Compare RB tree keys */
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700329static inline int ep_cmp_ffd(struct epoll_filefd *p1,
330 struct epoll_filefd *p2)
331{
332 return (p1->file > p2->file ? +1:
333 (p1->file < p2->file ? -1 : p1->fd - p2->fd));
334}
335
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700336/* Tells us if the item is currently linked */
337static inline int ep_is_linked(struct list_head *p)
338{
339 return !list_empty(p);
340}
341
Oleg Nesterov971316f2012-02-24 20:07:29 +0100342static inline struct eppoll_entry *ep_pwq_from_wait(wait_queue_t *p)
343{
344 return container_of(p, struct eppoll_entry, wait);
345}
346
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700347/* Get the "struct epitem" from a wait queue pointer */
Davide Libenzicdac75e2008-04-29 00:58:34 -0700348static inline struct epitem *ep_item_from_wait(wait_queue_t *p)
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700349{
350 return container_of(p, struct eppoll_entry, wait)->base;
351}
352
353/* Get the "struct epitem" from an epoll queue wrapper */
Davide Libenzicdac75e2008-04-29 00:58:34 -0700354static inline struct epitem *ep_item_from_epqueue(poll_table *p)
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700355{
356 return container_of(p, struct ep_pqueue, pt)->epi;
357}
358
359/* Tells if the epoll_ctl(2) operation needs an event copy from userspace */
Davide Libenzi6192bd52007-05-08 00:25:41 -0700360static inline int ep_op_has_event(int op)
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700361{
Andrew Mortona80a6b82012-11-08 15:53:35 -0800362 return op != EPOLL_CTL_DEL;
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700363}
364
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365/* Initialize the poll safe wake up structure */
Davide Libenzi5071f972009-03-31 15:24:10 -0700366static void ep_nested_calls_init(struct nested_calls *ncalls)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367{
Davide Libenzi5071f972009-03-31 15:24:10 -0700368 INIT_LIST_HEAD(&ncalls->tasks_call_list);
369 spin_lock_init(&ncalls->lock);
370}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371
Davide Libenzi5071f972009-03-31 15:24:10 -0700372/**
Davide Libenzi3fb0e582011-03-22 16:34:46 -0700373 * ep_events_available - Checks if ready events might be available.
374 *
375 * @ep: Pointer to the eventpoll context.
376 *
377 * Returns: Returns a value different than zero if ready events are available,
378 * or zero otherwise.
379 */
380static inline int ep_events_available(struct eventpoll *ep)
381{
382 return !list_empty(&ep->rdllist) || ep->ovflist != EP_UNACTIVE_PTR;
383}
384
385/**
Davide Libenzi5071f972009-03-31 15:24:10 -0700386 * ep_call_nested - Perform a bound (possibly) nested call, by checking
387 * that the recursion limit is not exceeded, and that
388 * the same nested call (by the meaning of same cookie) is
389 * no re-entered.
390 *
391 * @ncalls: Pointer to the nested_calls structure to be used for this call.
392 * @max_nests: Maximum number of allowed nesting calls.
393 * @nproc: Nested call core function pointer.
394 * @priv: Opaque data to be passed to the @nproc callback.
395 * @cookie: Cookie to be used to identify this nested call.
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700396 * @ctx: This instance context.
Davide Libenzi5071f972009-03-31 15:24:10 -0700397 *
398 * Returns: Returns the code returned by the @nproc callback, or -1 if
399 * the maximum recursion limit has been exceeded.
400 */
401static int ep_call_nested(struct nested_calls *ncalls, int max_nests,
402 int (*nproc)(void *, void *, int), void *priv,
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700403 void *cookie, void *ctx)
Davide Libenzi5071f972009-03-31 15:24:10 -0700404{
405 int error, call_nests = 0;
406 unsigned long flags;
Davide Libenzi5071f972009-03-31 15:24:10 -0700407 struct list_head *lsthead = &ncalls->tasks_call_list;
408 struct nested_call_node *tncur;
409 struct nested_call_node tnode;
410
411 spin_lock_irqsave(&ncalls->lock, flags);
412
413 /*
414 * Try to see if the current task is already inside this wakeup call.
415 * We use a list here, since the population inside this set is always
416 * very much limited.
417 */
418 list_for_each_entry(tncur, lsthead, llink) {
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700419 if (tncur->ctx == ctx &&
Davide Libenzi5071f972009-03-31 15:24:10 -0700420 (tncur->cookie == cookie || ++call_nests > max_nests)) {
421 /*
422 * Ops ... loop detected or maximum nest level reached.
423 * We abort this wake by breaking the cycle itself.
424 */
Tony Battersbyabff55c2009-03-31 15:24:13 -0700425 error = -1;
426 goto out_unlock;
Davide Libenzi5071f972009-03-31 15:24:10 -0700427 }
428 }
429
430 /* Add the current task and cookie to the list */
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700431 tnode.ctx = ctx;
Davide Libenzi5071f972009-03-31 15:24:10 -0700432 tnode.cookie = cookie;
433 list_add(&tnode.llink, lsthead);
434
435 spin_unlock_irqrestore(&ncalls->lock, flags);
436
437 /* Call the nested function */
438 error = (*nproc)(priv, cookie, call_nests);
439
440 /* Remove the current task from the list */
441 spin_lock_irqsave(&ncalls->lock, flags);
442 list_del(&tnode.llink);
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700443out_unlock:
Davide Libenzi5071f972009-03-31 15:24:10 -0700444 spin_unlock_irqrestore(&ncalls->lock, flags);
445
446 return error;
447}
448
Steven Rostedt02edc6f2012-03-23 15:02:27 -0700449/*
450 * As described in commit 0ccf831cb lockdep: annotate epoll
451 * the use of wait queues used by epoll is done in a very controlled
452 * manner. Wake ups can nest inside each other, but are never done
453 * with the same locking. For example:
454 *
455 * dfd = socket(...);
456 * efd1 = epoll_create();
457 * efd2 = epoll_create();
458 * epoll_ctl(efd1, EPOLL_CTL_ADD, dfd, ...);
459 * epoll_ctl(efd2, EPOLL_CTL_ADD, efd1, ...);
460 *
461 * When a packet arrives to the device underneath "dfd", the net code will
462 * issue a wake_up() on its poll wake list. Epoll (efd1) has installed a
463 * callback wakeup entry on that queue, and the wake_up() performed by the
464 * "dfd" net code will end up in ep_poll_callback(). At this point epoll
465 * (efd1) notices that it may have some event ready, so it needs to wake up
466 * the waiters on its poll wait list (efd2). So it calls ep_poll_safewake()
467 * that ends up in another wake_up(), after having checked about the
468 * recursion constraints. That are, no more than EP_MAX_POLLWAKE_NESTS, to
469 * avoid stack blasting.
470 *
471 * When CONFIG_DEBUG_LOCK_ALLOC is enabled, make sure lockdep can handle
472 * this special case of epoll.
473 */
Davide Libenzi2dfa4ee2009-03-31 15:24:22 -0700474#ifdef CONFIG_DEBUG_LOCK_ALLOC
475static inline void ep_wake_up_nested(wait_queue_head_t *wqueue,
476 unsigned long events, int subclass)
477{
478 unsigned long flags;
479
480 spin_lock_irqsave_nested(&wqueue->lock, flags, subclass);
481 wake_up_locked_poll(wqueue, events);
482 spin_unlock_irqrestore(&wqueue->lock, flags);
483}
484#else
485static inline void ep_wake_up_nested(wait_queue_head_t *wqueue,
486 unsigned long events, int subclass)
487{
488 wake_up_poll(wqueue, events);
489}
490#endif
491
Davide Libenzi5071f972009-03-31 15:24:10 -0700492static int ep_poll_wakeup_proc(void *priv, void *cookie, int call_nests)
493{
Davide Libenzi2dfa4ee2009-03-31 15:24:22 -0700494 ep_wake_up_nested((wait_queue_head_t *) cookie, POLLIN,
495 1 + call_nests);
Davide Libenzi5071f972009-03-31 15:24:10 -0700496 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497}
498
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499/*
500 * Perform a safe wake up of the poll wait list. The problem is that
501 * with the new callback'd wake up system, it is possible that the
502 * poll callback is reentered from inside the call to wake_up() done
503 * on the poll wait queue head. The rule is that we cannot reenter the
Davide Libenzi5071f972009-03-31 15:24:10 -0700504 * wake up code from the same task more than EP_MAX_NESTS times,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505 * and we cannot reenter the same wait queue head at all. This will
506 * enable to have a hierarchy of epoll file descriptor of no more than
Davide Libenzi5071f972009-03-31 15:24:10 -0700507 * EP_MAX_NESTS deep.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508 */
Davide Libenzi5071f972009-03-31 15:24:10 -0700509static void ep_poll_safewake(wait_queue_head_t *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510{
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700511 int this_cpu = get_cpu();
512
Davide Libenzi5071f972009-03-31 15:24:10 -0700513 ep_call_nested(&poll_safewake_ncalls, EP_MAX_NESTS,
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700514 ep_poll_wakeup_proc, NULL, wq, (void *) (long) this_cpu);
515
516 put_cpu();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517}
518
Oleg Nesterov971316f2012-02-24 20:07:29 +0100519static void ep_remove_wait_queue(struct eppoll_entry *pwq)
520{
521 wait_queue_head_t *whead;
522
523 rcu_read_lock();
Oleg Nesterovd325f1f2017-09-01 18:55:33 +0200524 /*
525 * If it is cleared by POLLFREE, it should be rcu-safe.
526 * If we read NULL we need a barrier paired with
527 * smp_store_release() in ep_poll_callback(), otherwise
528 * we rely on whead->lock.
529 */
530 whead = smp_load_acquire(&pwq->whead);
Oleg Nesterov971316f2012-02-24 20:07:29 +0100531 if (whead)
532 remove_wait_queue(whead, &pwq->wait);
533 rcu_read_unlock();
534}
535
Davide Libenzi7699acd2007-05-10 22:23:23 -0700536/*
Tony Battersbyd1bc90d2009-03-31 15:24:15 -0700537 * This function unregisters poll callbacks from the associated file
538 * descriptor. Must be called with "mtx" held (or "epmutex" if called from
539 * ep_free).
Davide Libenzi7699acd2007-05-10 22:23:23 -0700540 */
541static void ep_unregister_pollwait(struct eventpoll *ep, struct epitem *epi)
542{
Davide Libenzi7699acd2007-05-10 22:23:23 -0700543 struct list_head *lsthead = &epi->pwqlist;
544 struct eppoll_entry *pwq;
545
Tony Battersbyd1bc90d2009-03-31 15:24:15 -0700546 while (!list_empty(lsthead)) {
547 pwq = list_first_entry(lsthead, struct eppoll_entry, llink);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700548
Tony Battersbyd1bc90d2009-03-31 15:24:15 -0700549 list_del(&pwq->llink);
Oleg Nesterov971316f2012-02-24 20:07:29 +0100550 ep_remove_wait_queue(pwq);
Tony Battersbyd1bc90d2009-03-31 15:24:15 -0700551 kmem_cache_free(pwq_cache, pwq);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700552 }
553}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554
Eric Wongeea1d582013-04-30 15:27:39 -0700555/* call only when ep->mtx is held */
556static inline struct wakeup_source *ep_wakeup_source(struct epitem *epi)
557{
558 return rcu_dereference_check(epi->ws, lockdep_is_held(&epi->ep->mtx));
559}
560
561/* call only when ep->mtx is held */
562static inline void ep_pm_stay_awake(struct epitem *epi)
563{
564 struct wakeup_source *ws = ep_wakeup_source(epi);
565
566 if (ws)
567 __pm_stay_awake(ws);
568}
569
570static inline bool ep_has_wakeup_source(struct epitem *epi)
571{
572 return rcu_access_pointer(epi->ws) ? true : false;
573}
574
575/* call when ep->mtx cannot be held (ep_poll_callback) */
576static inline void ep_pm_stay_awake_rcu(struct epitem *epi)
577{
578 struct wakeup_source *ws;
579
580 rcu_read_lock();
581 ws = rcu_dereference(epi->ws);
582 if (ws)
583 __pm_stay_awake(ws);
584 rcu_read_unlock();
585}
586
Davide Libenzi5071f972009-03-31 15:24:10 -0700587/**
588 * ep_scan_ready_list - Scans the ready list in a way that makes possible for
589 * the scan code, to call f_op->poll(). Also allows for
590 * O(NumReady) performance.
591 *
592 * @ep: Pointer to the epoll private data structure.
593 * @sproc: Pointer to the scan callback.
594 * @priv: Private opaque data passed to the @sproc callback.
Nelson Elhaged8805e62011-10-31 17:13:14 -0700595 * @depth: The current depth of recursive f_op->poll calls.
Jason Baron67347fe2013-11-12 15:10:18 -0800596 * @ep_locked: caller already holds ep->mtx
Davide Libenzi5071f972009-03-31 15:24:10 -0700597 *
598 * Returns: The same integer error code returned by the @sproc callback.
599 */
600static int ep_scan_ready_list(struct eventpoll *ep,
601 int (*sproc)(struct eventpoll *,
602 struct list_head *, void *),
Jason Baron67347fe2013-11-12 15:10:18 -0800603 void *priv, int depth, bool ep_locked)
Davide Libenzi5071f972009-03-31 15:24:10 -0700604{
605 int error, pwake = 0;
606 unsigned long flags;
607 struct epitem *epi, *nepi;
Davide Libenzi296e2362009-03-31 15:24:11 -0700608 LIST_HEAD(txlist);
Davide Libenzi5071f972009-03-31 15:24:10 -0700609
610 /*
611 * We need to lock this because we could be hit by
Tony Battersbye057e152009-03-31 15:24:15 -0700612 * eventpoll_release_file() and epoll_ctl().
Davide Libenzi5071f972009-03-31 15:24:10 -0700613 */
Jason Baron67347fe2013-11-12 15:10:18 -0800614
615 if (!ep_locked)
616 mutex_lock_nested(&ep->mtx, depth);
Davide Libenzi5071f972009-03-31 15:24:10 -0700617
618 /*
619 * Steal the ready list, and re-init the original one to the
620 * empty list. Also, set ep->ovflist to NULL so that events
621 * happening while looping w/out locks, are not lost. We cannot
622 * have the poll callback to queue directly on ep->rdllist,
623 * because we want the "sproc" callback to be able to do it
624 * in a lockless way.
625 */
626 spin_lock_irqsave(&ep->lock, flags);
Davide Libenzi296e2362009-03-31 15:24:11 -0700627 list_splice_init(&ep->rdllist, &txlist);
Davide Libenzi5071f972009-03-31 15:24:10 -0700628 ep->ovflist = NULL;
629 spin_unlock_irqrestore(&ep->lock, flags);
630
631 /*
632 * Now call the callback function.
633 */
634 error = (*sproc)(ep, &txlist, priv);
635
636 spin_lock_irqsave(&ep->lock, flags);
637 /*
638 * During the time we spent inside the "sproc" callback, some
639 * other events might have been queued by the poll callback.
640 * We re-insert them inside the main ready-list here.
641 */
642 for (nepi = ep->ovflist; (epi = nepi) != NULL;
643 nepi = epi->next, epi->next = EP_UNACTIVE_PTR) {
644 /*
645 * We need to check if the item is already in the list.
646 * During the "sproc" callback execution time, items are
647 * queued into ->ovflist but the "txlist" might already
648 * contain them, and the list_splice() below takes care of them.
649 */
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200650 if (!ep_is_linked(&epi->rdllink)) {
Davide Libenzi5071f972009-03-31 15:24:10 -0700651 list_add_tail(&epi->rdllink, &ep->rdllist);
Eric Wongeea1d582013-04-30 15:27:39 -0700652 ep_pm_stay_awake(epi);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200653 }
Davide Libenzi5071f972009-03-31 15:24:10 -0700654 }
655 /*
656 * We need to set back ep->ovflist to EP_UNACTIVE_PTR, so that after
657 * releasing the lock, events will be queued in the normal way inside
658 * ep->rdllist.
659 */
660 ep->ovflist = EP_UNACTIVE_PTR;
661
662 /*
663 * Quickly re-inject items left on "txlist".
664 */
665 list_splice(&txlist, &ep->rdllist);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200666 __pm_relax(ep->ws);
Davide Libenzi5071f972009-03-31 15:24:10 -0700667
668 if (!list_empty(&ep->rdllist)) {
669 /*
Davide Libenzi296e2362009-03-31 15:24:11 -0700670 * Wake up (if active) both the eventpoll wait list and
671 * the ->poll() wait list (delayed after we release the lock).
Davide Libenzi5071f972009-03-31 15:24:10 -0700672 */
673 if (waitqueue_active(&ep->wq))
674 wake_up_locked(&ep->wq);
675 if (waitqueue_active(&ep->poll_wait))
676 pwake++;
677 }
678 spin_unlock_irqrestore(&ep->lock, flags);
679
Jason Baron67347fe2013-11-12 15:10:18 -0800680 if (!ep_locked)
681 mutex_unlock(&ep->mtx);
Davide Libenzi5071f972009-03-31 15:24:10 -0700682
683 /* We have to call this outside the lock */
684 if (pwake)
685 ep_poll_safewake(&ep->poll_wait);
686
687 return error;
688}
689
Jason Baronae10b2b2013-11-12 15:10:16 -0800690static void epi_rcu_free(struct rcu_head *head)
691{
692 struct epitem *epi = container_of(head, struct epitem, rcu);
693 kmem_cache_free(epi_cache, epi);
694}
695
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696/*
Davide Libenzi7699acd2007-05-10 22:23:23 -0700697 * Removes a "struct epitem" from the eventpoll RB tree and deallocates
Davide Libenzic7ea7632007-05-15 01:40:47 -0700698 * all the associated resources. Must be called with "mtx" held.
Davide Libenzi7699acd2007-05-10 22:23:23 -0700699 */
700static int ep_remove(struct eventpoll *ep, struct epitem *epi)
701{
Davide Libenzi7699acd2007-05-10 22:23:23 -0700702 unsigned long flags;
703 struct file *file = epi->ffd.file;
704
705 /*
706 * Removes poll wait queue hooks. We _have_ to do this without holding
707 * the "ep->lock" otherwise a deadlock might occur. This because of the
708 * sequence of the lock acquisition. Here we do "ep->lock" then the wait
709 * queue head lock when unregistering the wait queue. The wakeup callback
710 * will run by holding the wait queue head lock and will call our callback
711 * that will try to get "ep->lock".
712 */
713 ep_unregister_pollwait(ep, epi);
714
715 /* Remove the current item from the list of epoll hooks */
Jonathan Corbet68499912009-02-06 13:52:43 -0700716 spin_lock(&file->f_lock);
Jason Baronae10b2b2013-11-12 15:10:16 -0800717 list_del_rcu(&epi->fllink);
Jonathan Corbet68499912009-02-06 13:52:43 -0700718 spin_unlock(&file->f_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719
Davide Libenzicdac75e2008-04-29 00:58:34 -0700720 rb_erase(&epi->rbn, &ep->rbr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721
Davide Libenzic7ea7632007-05-15 01:40:47 -0700722 spin_lock_irqsave(&ep->lock, flags);
723 if (ep_is_linked(&epi->rdllink))
724 list_del_init(&epi->rdllink);
725 spin_unlock_irqrestore(&ep->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726
Eric Wongeea1d582013-04-30 15:27:39 -0700727 wakeup_source_unregister(ep_wakeup_source(epi));
Jason Baronae10b2b2013-11-12 15:10:16 -0800728 /*
729 * At this point it is safe to free the eventpoll item. Use the union
730 * field epi->rcu, since we are trying to minimize the size of
731 * 'struct epitem'. The 'rbn' field is no longer in use. Protected by
732 * ep->mtx. The rcu read side, reverse_path_check_proc(), does not make
733 * use of the rbn field.
734 */
735 call_rcu(&epi->rcu, epi_rcu_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736
Robin Holt52bd19f72011-01-12 17:00:01 -0800737 atomic_long_dec(&ep->user->epoll_watches);
Davide Libenzi7ef99642008-12-01 13:13:55 -0800738
Davide Libenzic7ea7632007-05-15 01:40:47 -0700739 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740}
741
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742static void ep_free(struct eventpoll *ep)
743{
744 struct rb_node *rbp;
745 struct epitem *epi;
746
747 /* We need to release all tasks waiting for these file */
748 if (waitqueue_active(&ep->poll_wait))
Davide Libenzi5071f972009-03-31 15:24:10 -0700749 ep_poll_safewake(&ep->poll_wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750
751 /*
752 * We need to lock this because we could be hit by
753 * eventpoll_release_file() while we're freeing the "struct eventpoll".
Davide Libenzid47de162007-05-15 01:40:41 -0700754 * We do not need to hold "ep->mtx" here because the epoll file
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755 * is on the way to be removed and no one has references to it
756 * anymore. The only hit might come from eventpoll_release_file() but
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300757 * holding "epmutex" is sufficient here.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758 */
Arjan van de Ven144efe32006-03-23 03:00:32 -0800759 mutex_lock(&epmutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760
761 /*
762 * Walks through the whole tree by unregistering poll callbacks.
763 */
764 for (rbp = rb_first(&ep->rbr); rbp; rbp = rb_next(rbp)) {
765 epi = rb_entry(rbp, struct epitem, rbn);
766
767 ep_unregister_pollwait(ep, epi);
Eric Dumazet91cf5ab2013-09-11 14:24:06 -0700768 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769 }
770
771 /*
Davide Libenzi6192bd52007-05-08 00:25:41 -0700772 * Walks through the whole tree by freeing each "struct epitem". At this
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773 * point we are sure no poll callbacks will be lingering around, and also by
Davide Libenzid47de162007-05-15 01:40:41 -0700774 * holding "epmutex" we can be sure that no file cleanup code will hit
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775 * us during this operation. So we can avoid the lock on "ep->lock".
Eric Wongddf676c2013-04-30 15:27:40 -0700776 * We do not need to lock ep->mtx, either, we only do it to prevent
777 * a lockdep warning.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778 */
Eric Wongddf676c2013-04-30 15:27:40 -0700779 mutex_lock(&ep->mtx);
Stephen Hemmingerc80544d2007-10-18 03:07:05 -0700780 while ((rbp = rb_first(&ep->rbr)) != NULL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781 epi = rb_entry(rbp, struct epitem, rbn);
782 ep_remove(ep, epi);
Eric Dumazet91cf5ab2013-09-11 14:24:06 -0700783 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784 }
Eric Wongddf676c2013-04-30 15:27:40 -0700785 mutex_unlock(&ep->mtx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786
Arjan van de Ven144efe32006-03-23 03:00:32 -0800787 mutex_unlock(&epmutex);
Davide Libenzid47de162007-05-15 01:40:41 -0700788 mutex_destroy(&ep->mtx);
Davide Libenzi7ef99642008-12-01 13:13:55 -0800789 free_uid(ep->user);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200790 wakeup_source_unregister(ep->ws);
Davide Libenzif0ee9aa2007-05-15 01:40:57 -0700791 kfree(ep);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792}
793
Davide Libenzi7699acd2007-05-10 22:23:23 -0700794static int ep_eventpoll_release(struct inode *inode, struct file *file)
795{
796 struct eventpoll *ep = file->private_data;
797
Davide Libenzif0ee9aa2007-05-15 01:40:57 -0700798 if (ep)
Davide Libenzi7699acd2007-05-10 22:23:23 -0700799 ep_free(ep);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700800
Davide Libenzi7699acd2007-05-10 22:23:23 -0700801 return 0;
802}
803
Eric Wong450d89e2013-04-30 15:27:42 -0700804static inline unsigned int ep_item_poll(struct epitem *epi, poll_table *pt)
805{
806 pt->_key = epi->event.events;
807
808 return epi->ffd.file->f_op->poll(epi->ffd.file, pt) & epi->event.events;
809}
810
Davide Libenzi296e2362009-03-31 15:24:11 -0700811static int ep_read_events_proc(struct eventpoll *ep, struct list_head *head,
812 void *priv)
Davide Libenzi5071f972009-03-31 15:24:10 -0700813{
814 struct epitem *epi, *tmp;
Hans Verkuil626cf232012-03-23 15:02:27 -0700815 poll_table pt;
Davide Libenzi5071f972009-03-31 15:24:10 -0700816
Hans Verkuil626cf232012-03-23 15:02:27 -0700817 init_poll_funcptr(&pt, NULL);
Eric Wong450d89e2013-04-30 15:27:42 -0700818
Davide Libenzi5071f972009-03-31 15:24:10 -0700819 list_for_each_entry_safe(epi, tmp, head, rdllink) {
Eric Wong450d89e2013-04-30 15:27:42 -0700820 if (ep_item_poll(epi, &pt))
Davide Libenzi5071f972009-03-31 15:24:10 -0700821 return POLLIN | POLLRDNORM;
Davide Libenzi296e2362009-03-31 15:24:11 -0700822 else {
Davide Libenzi5071f972009-03-31 15:24:10 -0700823 /*
824 * Item has been dropped into the ready list by the poll
825 * callback, but it's not actually ready, as far as
826 * caller requested events goes. We can remove it here.
827 */
Eric Wongeea1d582013-04-30 15:27:39 -0700828 __pm_relax(ep_wakeup_source(epi));
Davide Libenzi5071f972009-03-31 15:24:10 -0700829 list_del_init(&epi->rdllink);
Davide Libenzi296e2362009-03-31 15:24:11 -0700830 }
Davide Libenzi5071f972009-03-31 15:24:10 -0700831 }
832
833 return 0;
834}
835
Jason Baron67347fe2013-11-12 15:10:18 -0800836static void ep_ptable_queue_proc(struct file *file, wait_queue_head_t *whead,
837 poll_table *pt);
838
839struct readyevents_arg {
840 struct eventpoll *ep;
841 bool locked;
842};
843
Davide Libenzi5071f972009-03-31 15:24:10 -0700844static int ep_poll_readyevents_proc(void *priv, void *cookie, int call_nests)
845{
Jason Baron67347fe2013-11-12 15:10:18 -0800846 struct readyevents_arg *arg = priv;
847
848 return ep_scan_ready_list(arg->ep, ep_read_events_proc, NULL,
849 call_nests + 1, arg->locked);
Davide Libenzi5071f972009-03-31 15:24:10 -0700850}
851
Davide Libenzi7699acd2007-05-10 22:23:23 -0700852static unsigned int ep_eventpoll_poll(struct file *file, poll_table *wait)
853{
Davide Libenzi5071f972009-03-31 15:24:10 -0700854 int pollflags;
Davide Libenzi7699acd2007-05-10 22:23:23 -0700855 struct eventpoll *ep = file->private_data;
Jason Baron67347fe2013-11-12 15:10:18 -0800856 struct readyevents_arg arg;
857
858 /*
859 * During ep_insert() we already hold the ep->mtx for the tfile.
860 * Prevent re-aquisition.
861 */
862 arg.locked = wait && (wait->_qproc == ep_ptable_queue_proc);
863 arg.ep = ep;
Davide Libenzi7699acd2007-05-10 22:23:23 -0700864
865 /* Insert inside our poll wait queue */
866 poll_wait(file, &ep->poll_wait, wait);
867
Davide Libenzi5071f972009-03-31 15:24:10 -0700868 /*
869 * Proceed to find out if wanted events are really available inside
870 * the ready list. This need to be done under ep_call_nested()
871 * supervision, since the call to f_op->poll() done on listed files
872 * could re-enter here.
873 */
874 pollflags = ep_call_nested(&poll_readywalk_ncalls, EP_MAX_NESTS,
Jason Baron67347fe2013-11-12 15:10:18 -0800875 ep_poll_readyevents_proc, &arg, ep, current);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700876
Davide Libenzi296e2362009-03-31 15:24:11 -0700877 return pollflags != -1 ? pollflags : 0;
Davide Libenzi7699acd2007-05-10 22:23:23 -0700878}
879
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800880#ifdef CONFIG_PROC_FS
Joe Perchesa3816ab2014-09-29 16:08:25 -0700881static void ep_show_fdinfo(struct seq_file *m, struct file *f)
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800882{
883 struct eventpoll *ep = f->private_data;
884 struct rb_node *rbp;
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800885
886 mutex_lock(&ep->mtx);
887 for (rbp = rb_first(&ep->rbr); rbp; rbp = rb_next(rbp)) {
888 struct epitem *epi = rb_entry(rbp, struct epitem, rbn);
889
Joe Perchesa3816ab2014-09-29 16:08:25 -0700890 seq_printf(m, "tfd: %8d events: %8x data: %16llx\n",
891 epi->ffd.fd, epi->event.events,
892 (long long)epi->event.data);
893 if (seq_has_overflowed(m))
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800894 break;
895 }
896 mutex_unlock(&ep->mtx);
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800897}
898#endif
899
Davide Libenzi7699acd2007-05-10 22:23:23 -0700900/* File callbacks that implement the eventpoll file behaviour */
901static const struct file_operations eventpoll_fops = {
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800902#ifdef CONFIG_PROC_FS
903 .show_fdinfo = ep_show_fdinfo,
904#endif
Davide Libenzi7699acd2007-05-10 22:23:23 -0700905 .release = ep_eventpoll_release,
Arnd Bergmann6038f372010-08-15 18:52:59 +0200906 .poll = ep_eventpoll_poll,
907 .llseek = noop_llseek,
Davide Libenzi7699acd2007-05-10 22:23:23 -0700908};
909
Davide Libenzi7699acd2007-05-10 22:23:23 -0700910/*
911 * This is called from eventpoll_release() to unlink files from the eventpoll
912 * interface. We need to have this facility to cleanup correctly files that are
913 * closed without being removed from the eventpoll interface.
914 */
915void eventpoll_release_file(struct file *file)
916{
Davide Libenzi7699acd2007-05-10 22:23:23 -0700917 struct eventpoll *ep;
Konstantin Khlebnikovebe06182014-06-17 06:58:05 +0400918 struct epitem *epi, *next;
Davide Libenzi7699acd2007-05-10 22:23:23 -0700919
920 /*
Jonathan Corbet68499912009-02-06 13:52:43 -0700921 * We don't want to get "file->f_lock" because it is not
Davide Libenzi7699acd2007-05-10 22:23:23 -0700922 * necessary. It is not necessary because we're in the "struct file"
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300923 * cleanup path, and this means that no one is using this file anymore.
Davide Libenzi5071f972009-03-31 15:24:10 -0700924 * So, for example, epoll_ctl() cannot hit here since if we reach this
Davide Libenzi67647d02007-05-15 01:40:52 -0700925 * point, the file counter already went to zero and fget() would fail.
Davide Libenzid47de162007-05-15 01:40:41 -0700926 * The only hit might come from ep_free() but by holding the mutex
Davide Libenzi7699acd2007-05-10 22:23:23 -0700927 * will correctly serialize the operation. We do need to acquire
Davide Libenzid47de162007-05-15 01:40:41 -0700928 * "ep->mtx" after "epmutex" because ep_remove() requires it when called
Davide Libenzi7699acd2007-05-10 22:23:23 -0700929 * from anywhere but ep_free().
Jonathan Corbet68499912009-02-06 13:52:43 -0700930 *
931 * Besides, ep_remove() acquires the lock, so we can't hold it here.
Davide Libenzi7699acd2007-05-10 22:23:23 -0700932 */
933 mutex_lock(&epmutex);
Konstantin Khlebnikovebe06182014-06-17 06:58:05 +0400934 list_for_each_entry_safe(epi, next, &file->f_ep_links, fllink) {
Davide Libenzi7699acd2007-05-10 22:23:23 -0700935 ep = epi->ep;
Nelson Elhaged8805e62011-10-31 17:13:14 -0700936 mutex_lock_nested(&ep->mtx, 0);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700937 ep_remove(ep, epi);
Davide Libenzid47de162007-05-15 01:40:41 -0700938 mutex_unlock(&ep->mtx);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700939 }
Davide Libenzi7699acd2007-05-10 22:23:23 -0700940 mutex_unlock(&epmutex);
941}
942
943static int ep_alloc(struct eventpoll **pep)
944{
Davide Libenzi7ef99642008-12-01 13:13:55 -0800945 int error;
946 struct user_struct *user;
947 struct eventpoll *ep;
Davide Libenzi7699acd2007-05-10 22:23:23 -0700948
Davide Libenzi7ef99642008-12-01 13:13:55 -0800949 user = get_current_user();
Davide Libenzi7ef99642008-12-01 13:13:55 -0800950 error = -ENOMEM;
951 ep = kzalloc(sizeof(*ep), GFP_KERNEL);
952 if (unlikely(!ep))
953 goto free_uid;
Davide Libenzi7699acd2007-05-10 22:23:23 -0700954
Davide Libenzic7ea7632007-05-15 01:40:47 -0700955 spin_lock_init(&ep->lock);
Davide Libenzid47de162007-05-15 01:40:41 -0700956 mutex_init(&ep->mtx);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700957 init_waitqueue_head(&ep->wq);
958 init_waitqueue_head(&ep->poll_wait);
959 INIT_LIST_HEAD(&ep->rdllist);
960 ep->rbr = RB_ROOT;
Davide Libenzid47de162007-05-15 01:40:41 -0700961 ep->ovflist = EP_UNACTIVE_PTR;
Davide Libenzi7ef99642008-12-01 13:13:55 -0800962 ep->user = user;
Davide Libenzi7699acd2007-05-10 22:23:23 -0700963
964 *pep = ep;
965
Davide Libenzi7699acd2007-05-10 22:23:23 -0700966 return 0;
Davide Libenzi7ef99642008-12-01 13:13:55 -0800967
968free_uid:
969 free_uid(user);
970 return error;
Davide Libenzi7699acd2007-05-10 22:23:23 -0700971}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972
973/*
Davide Libenzic7ea7632007-05-15 01:40:47 -0700974 * Search the file inside the eventpoll tree. The RB tree operations
975 * are protected by the "mtx" mutex, and ep_find() must be called with
976 * "mtx" held.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977 */
978static struct epitem *ep_find(struct eventpoll *ep, struct file *file, int fd)
979{
980 int kcmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981 struct rb_node *rbp;
982 struct epitem *epi, *epir = NULL;
983 struct epoll_filefd ffd;
984
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700985 ep_set_ffd(&ffd, file, fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986 for (rbp = ep->rbr.rb_node; rbp; ) {
987 epi = rb_entry(rbp, struct epitem, rbn);
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700988 kcmp = ep_cmp_ffd(&ffd, &epi->ffd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989 if (kcmp > 0)
990 rbp = rbp->rb_right;
991 else if (kcmp < 0)
992 rbp = rbp->rb_left;
993 else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700994 epir = epi;
995 break;
996 }
997 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700998
Linus Torvalds1da177e2005-04-16 15:20:36 -0700999 return epir;
1000}
1001
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002/*
Davide Libenzi7699acd2007-05-10 22:23:23 -07001003 * This is the callback that is passed to the wait queue wakeup
Daniel Balutabf6a41d2011-01-30 23:42:29 +02001004 * mechanism. It is called by the stored file descriptors when they
Davide Libenzi7699acd2007-05-10 22:23:23 -07001005 * have events to report.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006 */
Davide Libenzi7699acd2007-05-10 22:23:23 -07001007static int ep_poll_callback(wait_queue_t *wait, unsigned mode, int sync, void *key)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008{
Davide Libenzi7699acd2007-05-10 22:23:23 -07001009 int pwake = 0;
1010 unsigned long flags;
1011 struct epitem *epi = ep_item_from_wait(wait);
1012 struct eventpoll *ep = epi->ep;
Jason Barondf0108c2016-01-20 14:59:24 -08001013 int ewake = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001014
Davide Libenzic7ea7632007-05-15 01:40:47 -07001015 spin_lock_irqsave(&ep->lock, flags);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001016
1017 /*
1018 * If the event mask does not contain any poll(2) event, we consider the
1019 * descriptor to be disabled. This condition is likely the effect of the
1020 * EPOLLONESHOT bit that disables the descriptor when an event is received,
1021 * until the next EPOLL_CTL_MOD will be issued.
1022 */
1023 if (!(epi->event.events & ~EP_PRIVATE_BITS))
Davide Libenzid47de162007-05-15 01:40:41 -07001024 goto out_unlock;
1025
1026 /*
Davide Libenzi2dfa4ee2009-03-31 15:24:22 -07001027 * Check the events coming with the callback. At this stage, not
1028 * every device reports the events in the "key" parameter of the
1029 * callback. We need to be able to handle both cases here, hence the
1030 * test for "key" != NULL before the event match test.
1031 */
1032 if (key && !((unsigned long) key & epi->event.events))
1033 goto out_unlock;
1034
1035 /*
Daniel Balutabf6a41d2011-01-30 23:42:29 +02001036 * If we are transferring events to userspace, we can hold no locks
Davide Libenzid47de162007-05-15 01:40:41 -07001037 * (because we're accessing user memory, and because of linux f_op->poll()
Daniel Balutabf6a41d2011-01-30 23:42:29 +02001038 * semantics). All the events that happen during that period of time are
Davide Libenzid47de162007-05-15 01:40:41 -07001039 * chained in ep->ovflist and requeued later on.
1040 */
Davidlohr Buesocf96e9632019-01-03 15:27:09 -08001041 if (ep->ovflist != EP_UNACTIVE_PTR) {
Davide Libenzid47de162007-05-15 01:40:41 -07001042 if (epi->next == EP_UNACTIVE_PTR) {
1043 epi->next = ep->ovflist;
1044 ep->ovflist = epi;
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001045 if (epi->ws) {
1046 /*
1047 * Activate ep->ws since epi->ws may get
1048 * deactivated at any time.
1049 */
1050 __pm_stay_awake(ep->ws);
1051 }
1052
Davide Libenzid47de162007-05-15 01:40:41 -07001053 }
1054 goto out_unlock;
1055 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07001056
1057 /* If this file is already in the ready list we exit soon */
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001058 if (!ep_is_linked(&epi->rdllink)) {
Davide Libenzi5071f972009-03-31 15:24:10 -07001059 list_add_tail(&epi->rdllink, &ep->rdllist);
Eric Wongeea1d582013-04-30 15:27:39 -07001060 ep_pm_stay_awake_rcu(epi);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001061 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07001062
Davide Libenzi7699acd2007-05-10 22:23:23 -07001063 /*
1064 * Wake up ( if active ) both the eventpoll wait list and the ->poll()
1065 * wait list.
1066 */
Jason Barondf0108c2016-01-20 14:59:24 -08001067 if (waitqueue_active(&ep->wq)) {
Jason Baronb6a515c2016-02-05 15:37:04 -08001068 if ((epi->event.events & EPOLLEXCLUSIVE) &&
1069 !((unsigned long)key & POLLFREE)) {
1070 switch ((unsigned long)key & EPOLLINOUT_BITS) {
1071 case POLLIN:
1072 if (epi->event.events & POLLIN)
1073 ewake = 1;
1074 break;
1075 case POLLOUT:
1076 if (epi->event.events & POLLOUT)
1077 ewake = 1;
1078 break;
1079 case 0:
1080 ewake = 1;
1081 break;
1082 }
1083 }
Matthew Wilcox4a6e9e22007-08-30 16:10:22 -04001084 wake_up_locked(&ep->wq);
Jason Barondf0108c2016-01-20 14:59:24 -08001085 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07001086 if (waitqueue_active(&ep->poll_wait))
1087 pwake++;
1088
Davide Libenzid47de162007-05-15 01:40:41 -07001089out_unlock:
Davide Libenzic7ea7632007-05-15 01:40:47 -07001090 spin_unlock_irqrestore(&ep->lock, flags);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001091
1092 /* We have to call this outside the lock */
1093 if (pwake)
Davide Libenzi5071f972009-03-31 15:24:10 -07001094 ep_poll_safewake(&ep->poll_wait);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001095
Oleg Nesterovd325f1f2017-09-01 18:55:33 +02001096 if (!(epi->event.events & EPOLLEXCLUSIVE))
1097 ewake = 1;
Jason Barondf0108c2016-01-20 14:59:24 -08001098
Oleg Nesterovd325f1f2017-09-01 18:55:33 +02001099 if ((unsigned long)key & POLLFREE) {
1100 /*
1101 * If we race with ep_remove_wait_queue() it can miss
1102 * ->whead = NULL and do another remove_wait_queue() after
1103 * us, so we can't use __remove_wait_queue().
1104 */
1105 list_del_init(&wait->task_list);
1106 /*
1107 * ->whead != NULL protects us from the race with ep_free()
1108 * or ep_remove(), ep_remove_wait_queue() takes whead->lock
1109 * held by the caller. Once we nullify it, nothing protects
1110 * ep/epi or even wait.
1111 */
1112 smp_store_release(&ep_pwq_from_wait(wait)->whead, NULL);
1113 }
1114
1115 return ewake;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001116}
1117
Linus Torvalds1da177e2005-04-16 15:20:36 -07001118/*
1119 * This is the callback that is used to add our wait queue to the
1120 * target file wakeup lists.
1121 */
1122static void ep_ptable_queue_proc(struct file *file, wait_queue_head_t *whead,
1123 poll_table *pt)
1124{
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001125 struct epitem *epi = ep_item_from_epqueue(pt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001126 struct eppoll_entry *pwq;
1127
Christoph Lametere94b1762006-12-06 20:33:17 -08001128 if (epi->nwait >= 0 && (pwq = kmem_cache_alloc(pwq_cache, GFP_KERNEL))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001129 init_waitqueue_func_entry(&pwq->wait, ep_poll_callback);
1130 pwq->whead = whead;
1131 pwq->base = epi;
Jason Barondf0108c2016-01-20 14:59:24 -08001132 if (epi->event.events & EPOLLEXCLUSIVE)
1133 add_wait_queue_exclusive(whead, &pwq->wait);
1134 else
1135 add_wait_queue(whead, &pwq->wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001136 list_add_tail(&pwq->llink, &epi->pwqlist);
1137 epi->nwait++;
Davide Libenzi296e2362009-03-31 15:24:11 -07001138 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139 /* We have to signal that an error occurred */
1140 epi->nwait = -1;
Davide Libenzi296e2362009-03-31 15:24:11 -07001141 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001142}
1143
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144static void ep_rbtree_insert(struct eventpoll *ep, struct epitem *epi)
1145{
1146 int kcmp;
1147 struct rb_node **p = &ep->rbr.rb_node, *parent = NULL;
1148 struct epitem *epic;
1149
1150 while (*p) {
1151 parent = *p;
1152 epic = rb_entry(parent, struct epitem, rbn);
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001153 kcmp = ep_cmp_ffd(&epi->ffd, &epic->ffd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001154 if (kcmp > 0)
1155 p = &parent->rb_right;
1156 else
1157 p = &parent->rb_left;
1158 }
1159 rb_link_node(&epi->rbn, parent, p);
1160 rb_insert_color(&epi->rbn, &ep->rbr);
1161}
1162
Andrew Mortona80a6b82012-11-08 15:53:35 -08001163
1164
Jason Baron28d82dc2012-01-12 17:17:43 -08001165#define PATH_ARR_SIZE 5
1166/*
1167 * These are the number paths of length 1 to 5, that we are allowing to emanate
1168 * from a single file of interest. For example, we allow 1000 paths of length
1169 * 1, to emanate from each file of interest. This essentially represents the
1170 * potential wakeup paths, which need to be limited in order to avoid massive
1171 * uncontrolled wakeup storms. The common use case should be a single ep which
1172 * is connected to n file sources. In this case each file source has 1 path
1173 * of length 1. Thus, the numbers below should be more than sufficient. These
1174 * path limits are enforced during an EPOLL_CTL_ADD operation, since a modify
1175 * and delete can't add additional paths. Protected by the epmutex.
1176 */
1177static const int path_limits[PATH_ARR_SIZE] = { 1000, 500, 100, 50, 10 };
1178static int path_count[PATH_ARR_SIZE];
1179
1180static int path_count_inc(int nests)
1181{
Jason Baron93dc6102012-03-16 16:34:03 -04001182 /* Allow an arbitrary number of depth 1 paths */
1183 if (nests == 0)
1184 return 0;
1185
Jason Baron28d82dc2012-01-12 17:17:43 -08001186 if (++path_count[nests] > path_limits[nests])
1187 return -1;
1188 return 0;
1189}
1190
1191static void path_count_init(void)
1192{
1193 int i;
1194
1195 for (i = 0; i < PATH_ARR_SIZE; i++)
1196 path_count[i] = 0;
1197}
1198
1199static int reverse_path_check_proc(void *priv, void *cookie, int call_nests)
1200{
1201 int error = 0;
1202 struct file *file = priv;
1203 struct file *child_file;
1204 struct epitem *epi;
1205
Jason Baronae10b2b2013-11-12 15:10:16 -08001206 /* CTL_DEL can remove links here, but that can't increase our count */
1207 rcu_read_lock();
1208 list_for_each_entry_rcu(epi, &file->f_ep_links, fllink) {
Jason Baron28d82dc2012-01-12 17:17:43 -08001209 child_file = epi->ep->file;
1210 if (is_file_epoll(child_file)) {
1211 if (list_empty(&child_file->f_ep_links)) {
1212 if (path_count_inc(call_nests)) {
1213 error = -1;
1214 break;
1215 }
1216 } else {
1217 error = ep_call_nested(&poll_loop_ncalls,
1218 EP_MAX_NESTS,
1219 reverse_path_check_proc,
1220 child_file, child_file,
1221 current);
1222 }
1223 if (error != 0)
1224 break;
1225 } else {
1226 printk(KERN_ERR "reverse_path_check_proc: "
1227 "file is not an ep!\n");
1228 }
1229 }
Jason Baronae10b2b2013-11-12 15:10:16 -08001230 rcu_read_unlock();
Jason Baron28d82dc2012-01-12 17:17:43 -08001231 return error;
1232}
1233
1234/**
1235 * reverse_path_check - The tfile_check_list is list of file *, which have
1236 * links that are proposed to be newly added. We need to
1237 * make sure that those added links don't add too many
1238 * paths such that we will spend all our time waking up
1239 * eventpoll objects.
1240 *
1241 * Returns: Returns zero if the proposed links don't create too many paths,
1242 * -1 otherwise.
1243 */
1244static int reverse_path_check(void)
1245{
Jason Baron28d82dc2012-01-12 17:17:43 -08001246 int error = 0;
1247 struct file *current_file;
1248
1249 /* let's call this for all tfiles */
1250 list_for_each_entry(current_file, &tfile_check_list, f_tfile_llink) {
Jason Baron28d82dc2012-01-12 17:17:43 -08001251 path_count_init();
1252 error = ep_call_nested(&poll_loop_ncalls, EP_MAX_NESTS,
1253 reverse_path_check_proc, current_file,
1254 current_file, current);
1255 if (error)
1256 break;
1257 }
1258 return error;
1259}
1260
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001261static int ep_create_wakeup_source(struct epitem *epi)
1262{
Al Virof2b4a582020-09-24 19:41:58 -04001263 struct name_snapshot n;
Eric Wongeea1d582013-04-30 15:27:39 -07001264 struct wakeup_source *ws;
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001265
1266 if (!epi->ep->ws) {
1267 epi->ep->ws = wakeup_source_register("eventpoll");
1268 if (!epi->ep->ws)
1269 return -ENOMEM;
1270 }
1271
Al Virof2b4a582020-09-24 19:41:58 -04001272 take_dentry_name_snapshot(&n, epi->ffd.file->f_path.dentry);
1273 ws = wakeup_source_register(n.name);
1274 release_dentry_name_snapshot(&n);
Eric Wongeea1d582013-04-30 15:27:39 -07001275
1276 if (!ws)
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001277 return -ENOMEM;
Eric Wongeea1d582013-04-30 15:27:39 -07001278 rcu_assign_pointer(epi->ws, ws);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001279
1280 return 0;
1281}
1282
Eric Wongeea1d582013-04-30 15:27:39 -07001283/* rare code path, only used when EPOLL_CTL_MOD removes a wakeup source */
1284static noinline void ep_destroy_wakeup_source(struct epitem *epi)
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001285{
Eric Wongeea1d582013-04-30 15:27:39 -07001286 struct wakeup_source *ws = ep_wakeup_source(epi);
1287
Eric Wongd6d67e72013-04-30 15:27:43 -07001288 RCU_INIT_POINTER(epi->ws, NULL);
Eric Wongeea1d582013-04-30 15:27:39 -07001289
1290 /*
1291 * wait for ep_pm_stay_awake_rcu to finish, synchronize_rcu is
1292 * used internally by wakeup_source_remove, too (called by
1293 * wakeup_source_unregister), so we cannot use call_rcu
1294 */
1295 synchronize_rcu();
1296 wakeup_source_unregister(ws);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001297}
1298
Davide Libenzic7ea7632007-05-15 01:40:47 -07001299/*
1300 * Must be called with "mtx" held.
1301 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001302static int ep_insert(struct eventpoll *ep, struct epoll_event *event,
Jason Baron67347fe2013-11-12 15:10:18 -08001303 struct file *tfile, int fd, int full_check)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001304{
1305 int error, revents, pwake = 0;
1306 unsigned long flags;
Robin Holt52bd19f72011-01-12 17:00:01 -08001307 long user_watches;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001308 struct epitem *epi;
1309 struct ep_pqueue epq;
1310
Robin Holt52bd19f72011-01-12 17:00:01 -08001311 user_watches = atomic_long_read(&ep->user->epoll_watches);
1312 if (unlikely(user_watches >= max_user_watches))
Davide Libenzi7ef99642008-12-01 13:13:55 -08001313 return -ENOSPC;
Christoph Lametere94b1762006-12-06 20:33:17 -08001314 if (!(epi = kmem_cache_alloc(epi_cache, GFP_KERNEL)))
Davide Libenzi7ef99642008-12-01 13:13:55 -08001315 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316
1317 /* Item initialization follow here ... */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001318 INIT_LIST_HEAD(&epi->rdllink);
1319 INIT_LIST_HEAD(&epi->fllink);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320 INIT_LIST_HEAD(&epi->pwqlist);
1321 epi->ep = ep;
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001322 ep_set_ffd(&epi->ffd, tfile, fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323 epi->event = *event;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001324 epi->nwait = 0;
Davide Libenzid47de162007-05-15 01:40:41 -07001325 epi->next = EP_UNACTIVE_PTR;
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001326 if (epi->event.events & EPOLLWAKEUP) {
1327 error = ep_create_wakeup_source(epi);
1328 if (error)
1329 goto error_create_wakeup_source;
1330 } else {
Eric Wongeea1d582013-04-30 15:27:39 -07001331 RCU_INIT_POINTER(epi->ws, NULL);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001332 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333
Al Viroa16d3142020-09-09 22:25:06 -04001334 /* Add the current item to the list of active epoll hook for this file */
1335 spin_lock(&tfile->f_lock);
1336 list_add_tail_rcu(&epi->fllink, &tfile->f_ep_links);
1337 spin_unlock(&tfile->f_lock);
1338
1339 /*
1340 * Add the current item to the RB tree. All RB tree operations are
1341 * protected by "mtx", and ep_insert() is called with "mtx" held.
1342 */
1343 ep_rbtree_insert(ep, epi);
1344
1345 /* now check if we've created too many backpaths */
1346 error = -EINVAL;
1347 if (full_check && reverse_path_check())
1348 goto error_remove_epi;
1349
Linus Torvalds1da177e2005-04-16 15:20:36 -07001350 /* Initialize the poll table using the queue callback */
1351 epq.epi = epi;
1352 init_poll_funcptr(&epq.pt, ep_ptable_queue_proc);
1353
1354 /*
1355 * Attach the item to the poll hooks and get current event bits.
1356 * We can safely use the file* here because its usage count has
Davide Libenzic7ea7632007-05-15 01:40:47 -07001357 * been increased by the caller of this function. Note that after
1358 * this operation completes, the poll callback can start hitting
1359 * the new item.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360 */
Eric Wong450d89e2013-04-30 15:27:42 -07001361 revents = ep_item_poll(epi, &epq.pt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001362
1363 /*
1364 * We have to check if something went wrong during the poll wait queue
1365 * install process. Namely an allocation for a wait queue failed due
1366 * high memory pressure.
1367 */
Davide Libenzi7ef99642008-12-01 13:13:55 -08001368 error = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369 if (epi->nwait < 0)
Davide Libenzi7699acd2007-05-10 22:23:23 -07001370 goto error_unregister;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001371
Davide Libenzic7ea7632007-05-15 01:40:47 -07001372 /* We have to drop the new item inside our item list to keep track of it */
1373 spin_lock_irqsave(&ep->lock, flags);
1374
Linus Torvalds1da177e2005-04-16 15:20:36 -07001375 /* If the file is already "ready" we drop it inside the ready list */
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001376 if ((revents & event->events) && !ep_is_linked(&epi->rdllink)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377 list_add_tail(&epi->rdllink, &ep->rdllist);
Eric Wongeea1d582013-04-30 15:27:39 -07001378 ep_pm_stay_awake(epi);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001379
1380 /* Notify waiting tasks that events are available */
1381 if (waitqueue_active(&ep->wq))
Matthew Wilcox4a6e9e22007-08-30 16:10:22 -04001382 wake_up_locked(&ep->wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383 if (waitqueue_active(&ep->poll_wait))
1384 pwake++;
1385 }
1386
Davide Libenzic7ea7632007-05-15 01:40:47 -07001387 spin_unlock_irqrestore(&ep->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388
Robin Holt52bd19f72011-01-12 17:00:01 -08001389 atomic_long_inc(&ep->user->epoll_watches);
Davide Libenzi7ef99642008-12-01 13:13:55 -08001390
Linus Torvalds1da177e2005-04-16 15:20:36 -07001391 /* We have to call this outside the lock */
1392 if (pwake)
Davide Libenzi5071f972009-03-31 15:24:10 -07001393 ep_poll_safewake(&ep->poll_wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001394
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395 return 0;
1396
Al Viroa16d3142020-09-09 22:25:06 -04001397error_unregister:
1398 ep_unregister_pollwait(ep, epi);
Jason Baron28d82dc2012-01-12 17:17:43 -08001399error_remove_epi:
1400 spin_lock(&tfile->f_lock);
Jason Baronae10b2b2013-11-12 15:10:16 -08001401 list_del_rcu(&epi->fllink);
Jason Baron28d82dc2012-01-12 17:17:43 -08001402 spin_unlock(&tfile->f_lock);
1403
1404 rb_erase(&epi->rbn, &ep->rbr);
1405
Linus Torvalds1da177e2005-04-16 15:20:36 -07001406 /*
1407 * We need to do this because an event could have been arrived on some
Davide Libenzi67647d02007-05-15 01:40:52 -07001408 * allocated wait queue. Note that we don't care about the ep->ovflist
1409 * list, since that is used/cleaned only inside a section bound by "mtx".
1410 * And ep_insert() is called with "mtx" held.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001411 */
Davide Libenzic7ea7632007-05-15 01:40:47 -07001412 spin_lock_irqsave(&ep->lock, flags);
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001413 if (ep_is_linked(&epi->rdllink))
Davide Libenzi6192bd52007-05-08 00:25:41 -07001414 list_del_init(&epi->rdllink);
Davide Libenzic7ea7632007-05-15 01:40:47 -07001415 spin_unlock_irqrestore(&ep->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416
Eric Wongeea1d582013-04-30 15:27:39 -07001417 wakeup_source_unregister(ep_wakeup_source(epi));
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001418
1419error_create_wakeup_source:
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001420 kmem_cache_free(epi_cache, epi);
Davide Libenzi7ef99642008-12-01 13:13:55 -08001421
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422 return error;
1423}
1424
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425/*
1426 * Modify the interest event mask by dropping an event if the new mask
Davide Libenzic7ea7632007-05-15 01:40:47 -07001427 * has a match in the current file status. Must be called with "mtx" held.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001428 */
1429static int ep_modify(struct eventpoll *ep, struct epitem *epi, struct epoll_event *event)
1430{
1431 int pwake = 0;
1432 unsigned int revents;
Hans Verkuil626cf232012-03-23 15:02:27 -07001433 poll_table pt;
1434
1435 init_poll_funcptr(&pt, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001436
1437 /*
Tony Battersbye057e152009-03-31 15:24:15 -07001438 * Set the new event interest mask before calling f_op->poll();
1439 * otherwise we might miss an event that happens between the
1440 * f_op->poll() call and the new event set registering.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001441 */
Eric Wong128dd172013-01-01 21:20:27 +00001442 epi->event.events = event->events; /* need barrier below */
Tony Battersbye057e152009-03-31 15:24:15 -07001443 epi->event.data = event->data; /* protected by mtx */
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001444 if (epi->event.events & EPOLLWAKEUP) {
Eric Wongeea1d582013-04-30 15:27:39 -07001445 if (!ep_has_wakeup_source(epi))
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001446 ep_create_wakeup_source(epi);
Eric Wongeea1d582013-04-30 15:27:39 -07001447 } else if (ep_has_wakeup_source(epi)) {
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001448 ep_destroy_wakeup_source(epi);
1449 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001450
1451 /*
Eric Wong128dd172013-01-01 21:20:27 +00001452 * The following barrier has two effects:
1453 *
1454 * 1) Flush epi changes above to other CPUs. This ensures
1455 * we do not miss events from ep_poll_callback if an
1456 * event occurs immediately after we call f_op->poll().
1457 * We need this because we did not take ep->lock while
1458 * changing epi above (but ep_poll_callback does take
1459 * ep->lock).
1460 *
1461 * 2) We also need to ensure we do not miss _past_ events
1462 * when calling f_op->poll(). This barrier also
1463 * pairs with the barrier in wq_has_sleeper (see
1464 * comments for wq_has_sleeper).
1465 *
1466 * This barrier will now guarantee ep_poll_callback or f_op->poll
1467 * (or both) will notice the readiness of an item.
1468 */
1469 smp_mb();
1470
1471 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001472 * Get current event bits. We can safely use the file* here because
1473 * its usage count has been increased by the caller of this function.
1474 */
Eric Wong450d89e2013-04-30 15:27:42 -07001475 revents = ep_item_poll(epi, &pt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001476
Linus Torvalds1da177e2005-04-16 15:20:36 -07001477 /*
Davide Libenzic7ea7632007-05-15 01:40:47 -07001478 * If the item is "hot" and it is not registered inside the ready
Davide Libenzi67647d02007-05-15 01:40:52 -07001479 * list, push it inside.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001480 */
Davide Libenzic7ea7632007-05-15 01:40:47 -07001481 if (revents & event->events) {
Tony Battersbye057e152009-03-31 15:24:15 -07001482 spin_lock_irq(&ep->lock);
Davide Libenzic7ea7632007-05-15 01:40:47 -07001483 if (!ep_is_linked(&epi->rdllink)) {
1484 list_add_tail(&epi->rdllink, &ep->rdllist);
Eric Wongeea1d582013-04-30 15:27:39 -07001485 ep_pm_stay_awake(epi);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001486
Davide Libenzic7ea7632007-05-15 01:40:47 -07001487 /* Notify waiting tasks that events are available */
1488 if (waitqueue_active(&ep->wq))
Matthew Wilcox4a6e9e22007-08-30 16:10:22 -04001489 wake_up_locked(&ep->wq);
Davide Libenzic7ea7632007-05-15 01:40:47 -07001490 if (waitqueue_active(&ep->poll_wait))
1491 pwake++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001492 }
Tony Battersbye057e152009-03-31 15:24:15 -07001493 spin_unlock_irq(&ep->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001494 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001495
1496 /* We have to call this outside the lock */
1497 if (pwake)
Davide Libenzi5071f972009-03-31 15:24:10 -07001498 ep_poll_safewake(&ep->poll_wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001499
1500 return 0;
1501}
1502
Davide Libenzi296e2362009-03-31 15:24:11 -07001503static int ep_send_events_proc(struct eventpoll *ep, struct list_head *head,
1504 void *priv)
Davide Libenzi5071f972009-03-31 15:24:10 -07001505{
1506 struct ep_send_events_data *esed = priv;
1507 int eventcnt;
Davide Libenzi296e2362009-03-31 15:24:11 -07001508 unsigned int revents;
Davide Libenzi5071f972009-03-31 15:24:10 -07001509 struct epitem *epi;
1510 struct epoll_event __user *uevent;
Eric Wongeea1d582013-04-30 15:27:39 -07001511 struct wakeup_source *ws;
Hans Verkuil626cf232012-03-23 15:02:27 -07001512 poll_table pt;
1513
1514 init_poll_funcptr(&pt, NULL);
Davide Libenzi5071f972009-03-31 15:24:10 -07001515
Davide Libenzi296e2362009-03-31 15:24:11 -07001516 /*
Davide Libenzi5071f972009-03-31 15:24:10 -07001517 * We can loop without lock because we are passed a task private list.
1518 * Items cannot vanish during the loop because ep_scan_ready_list() is
1519 * holding "mtx" during this call.
Davide Libenzi296e2362009-03-31 15:24:11 -07001520 */
Davide Libenzi5071f972009-03-31 15:24:10 -07001521 for (eventcnt = 0, uevent = esed->events;
1522 !list_empty(head) && eventcnt < esed->maxevents;) {
1523 epi = list_first_entry(head, struct epitem, rdllink);
1524
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001525 /*
1526 * Activate ep->ws before deactivating epi->ws to prevent
1527 * triggering auto-suspend here (in case we reactive epi->ws
1528 * below).
1529 *
1530 * This could be rearranged to delay the deactivation of epi->ws
1531 * instead, but then epi->ws would temporarily be out of sync
1532 * with ep_is_linked().
1533 */
Eric Wongeea1d582013-04-30 15:27:39 -07001534 ws = ep_wakeup_source(epi);
1535 if (ws) {
1536 if (ws->active)
1537 __pm_stay_awake(ep->ws);
1538 __pm_relax(ws);
1539 }
1540
Davide Libenzi5071f972009-03-31 15:24:10 -07001541 list_del_init(&epi->rdllink);
1542
Eric Wong450d89e2013-04-30 15:27:42 -07001543 revents = ep_item_poll(epi, &pt);
Davide Libenzi5071f972009-03-31 15:24:10 -07001544
Davide Libenzi296e2362009-03-31 15:24:11 -07001545 /*
Davide Libenzi5071f972009-03-31 15:24:10 -07001546 * If the event mask intersect the caller-requested one,
1547 * deliver the event to userspace. Again, ep_scan_ready_list()
1548 * is holding "mtx", so no operations coming from userspace
1549 * can change the item.
Davide Libenzi296e2362009-03-31 15:24:11 -07001550 */
1551 if (revents) {
Davide Libenzi5071f972009-03-31 15:24:10 -07001552 if (__put_user(revents, &uevent->events) ||
Tony Battersbyd0305882009-03-31 15:24:14 -07001553 __put_user(epi->event.data, &uevent->data)) {
1554 list_add(&epi->rdllink, head);
Eric Wongeea1d582013-04-30 15:27:39 -07001555 ep_pm_stay_awake(epi);
Davide Libenzi296e2362009-03-31 15:24:11 -07001556 return eventcnt ? eventcnt : -EFAULT;
Tony Battersbyd0305882009-03-31 15:24:14 -07001557 }
Davide Libenzi296e2362009-03-31 15:24:11 -07001558 eventcnt++;
Davide Libenzi5071f972009-03-31 15:24:10 -07001559 uevent++;
Davide Libenzi296e2362009-03-31 15:24:11 -07001560 if (epi->event.events & EPOLLONESHOT)
1561 epi->event.events &= EP_PRIVATE_BITS;
1562 else if (!(epi->event.events & EPOLLET)) {
1563 /*
1564 * If this file has been added with Level
1565 * Trigger mode, we need to insert back inside
1566 * the ready list, so that the next call to
1567 * epoll_wait() will check again the events
Lucas De Marchi25985ed2011-03-30 22:57:33 -03001568 * availability. At this point, no one can insert
Davide Libenzi296e2362009-03-31 15:24:11 -07001569 * into ep->rdllist besides us. The epoll_ctl()
1570 * callers are locked out by
1571 * ep_scan_ready_list() holding "mtx" and the
1572 * poll callback will queue them in ep->ovflist.
1573 */
1574 list_add_tail(&epi->rdllink, &ep->rdllist);
Eric Wongeea1d582013-04-30 15:27:39 -07001575 ep_pm_stay_awake(epi);
Davide Libenzi296e2362009-03-31 15:24:11 -07001576 }
1577 }
1578 }
Davide Libenzi5071f972009-03-31 15:24:10 -07001579
1580 return eventcnt;
1581}
1582
Davide Libenzi296e2362009-03-31 15:24:11 -07001583static int ep_send_events(struct eventpoll *ep,
1584 struct epoll_event __user *events, int maxevents)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001585{
Davide Libenzi5071f972009-03-31 15:24:10 -07001586 struct ep_send_events_data esed;
Davide Libenzi6192bd52007-05-08 00:25:41 -07001587
Davide Libenzi5071f972009-03-31 15:24:10 -07001588 esed.maxevents = maxevents;
1589 esed.events = events;
Davide Libenzid47de162007-05-15 01:40:41 -07001590
Jason Baron67347fe2013-11-12 15:10:18 -08001591 return ep_scan_ready_list(ep, ep_send_events_proc, &esed, 0, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001592}
1593
Deepa Dinamani766b9f92016-05-19 17:09:05 -07001594static inline struct timespec64 ep_set_mstimeout(long ms)
Eric Dumazet0781b902011-02-01 15:52:35 -08001595{
Deepa Dinamani766b9f92016-05-19 17:09:05 -07001596 struct timespec64 now, ts = {
Eric Dumazet0781b902011-02-01 15:52:35 -08001597 .tv_sec = ms / MSEC_PER_SEC,
1598 .tv_nsec = NSEC_PER_MSEC * (ms % MSEC_PER_SEC),
1599 };
1600
Deepa Dinamani766b9f92016-05-19 17:09:05 -07001601 ktime_get_ts64(&now);
1602 return timespec64_add_safe(now, ts);
Eric Dumazet0781b902011-02-01 15:52:35 -08001603}
1604
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001605/**
1606 * ep_poll - Retrieves ready events, and delivers them to the caller supplied
1607 * event buffer.
1608 *
1609 * @ep: Pointer to the eventpoll context.
1610 * @events: Pointer to the userspace buffer where the ready events should be
1611 * stored.
1612 * @maxevents: Size (in terms of number of events) of the caller event buffer.
1613 * @timeout: Maximum timeout for the ready events fetch operation, in
1614 * milliseconds. If the @timeout is zero, the function will not block,
1615 * while if the @timeout is less than zero, the function will block
1616 * until at least one event has been retrieved (or an error
1617 * occurred).
1618 *
1619 * Returns: Returns the number of ready events which have been fetched, or an
1620 * error code, in case of error.
1621 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622static int ep_poll(struct eventpoll *ep, struct epoll_event __user *events,
1623 int maxevents, long timeout)
1624{
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001625 int res = 0, eavail, timed_out = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626 unsigned long flags;
John Stultzda8b44d2016-03-17 14:20:51 -07001627 u64 slack = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628 wait_queue_t wait;
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001629 ktime_t expires, *to = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001630
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001631 if (timeout > 0) {
Deepa Dinamani766b9f92016-05-19 17:09:05 -07001632 struct timespec64 end_time = ep_set_mstimeout(timeout);
Eric Dumazet0781b902011-02-01 15:52:35 -08001633
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001634 slack = select_estimate_accuracy(&end_time);
1635 to = &expires;
Deepa Dinamani766b9f92016-05-19 17:09:05 -07001636 *to = timespec64_to_ktime(end_time);
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001637 } else if (timeout == 0) {
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001638 /*
1639 * Avoid the unnecessary trip to the wait queue loop, if the
1640 * caller specified a non blocking operation.
1641 */
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001642 timed_out = 1;
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001643 spin_lock_irqsave(&ep->lock, flags);
1644 goto check_events;
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001645 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001646
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001647fetch_events:
Davide Libenzic7ea7632007-05-15 01:40:47 -07001648 spin_lock_irqsave(&ep->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001649
Davide Libenzi3fb0e582011-03-22 16:34:46 -07001650 if (!ep_events_available(ep)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001651 /*
1652 * We don't have any available event to return to the caller.
1653 * We need to sleep here, and we will be wake up by
1654 * ep_poll_callback() when events will become available.
1655 */
1656 init_waitqueue_entry(&wait, current);
Changli Gaoa93d2f12010-05-07 14:33:26 +08001657 __add_wait_queue_exclusive(&ep->wq, &wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001658
1659 for (;;) {
1660 /*
1661 * We don't want to sleep if the ep_poll_callback() sends us
1662 * a wakeup in between. That's why we set the task state
1663 * to TASK_INTERRUPTIBLE before doing the checks.
1664 */
1665 set_current_state(TASK_INTERRUPTIBLE);
Davide Libenzi3fb0e582011-03-22 16:34:46 -07001666 if (ep_events_available(ep) || timed_out)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001667 break;
1668 if (signal_pending(current)) {
1669 res = -EINTR;
1670 break;
1671 }
1672
Davide Libenzic7ea7632007-05-15 01:40:47 -07001673 spin_unlock_irqrestore(&ep->lock, flags);
Rafael J. Wysockic5118512013-10-29 13:12:56 +01001674 if (!schedule_hrtimeout_range(to, slack, HRTIMER_MODE_ABS))
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001675 timed_out = 1;
1676
Davide Libenzic7ea7632007-05-15 01:40:47 -07001677 spin_lock_irqsave(&ep->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001678 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001679
Davidlohr Bueso4d5755b2015-02-13 14:39:08 -08001680 __remove_wait_queue(&ep->wq, &wait);
1681 __set_current_state(TASK_RUNNING);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001682 }
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001683check_events:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001684 /* Is it worth to try to dig for events ? */
Davide Libenzi3fb0e582011-03-22 16:34:46 -07001685 eavail = ep_events_available(ep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001686
Davide Libenzic7ea7632007-05-15 01:40:47 -07001687 spin_unlock_irqrestore(&ep->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001688
1689 /*
1690 * Try to transfer events to user space. In case we get 0 events and
1691 * there's still timeout left over, we go trying again in search of
1692 * more luck.
1693 */
1694 if (!res && eavail &&
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001695 !(res = ep_send_events(ep, events, maxevents)) && !timed_out)
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001696 goto fetch_events;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001697
1698 return res;
1699}
1700
Davide Libenzi22bacca2011-02-25 14:44:12 -08001701/**
1702 * ep_loop_check_proc - Callback function to be passed to the @ep_call_nested()
1703 * API, to verify that adding an epoll file inside another
1704 * epoll structure, does not violate the constraints, in
1705 * terms of closed loops, or too deep chains (which can
1706 * result in excessive stack usage).
1707 *
1708 * @priv: Pointer to the epoll file to be currently checked.
1709 * @cookie: Original cookie for this call. This is the top-of-the-chain epoll
1710 * data structure pointer.
1711 * @call_nests: Current dept of the @ep_call_nested() call stack.
1712 *
1713 * Returns: Returns zero if adding the epoll @file inside current epoll
1714 * structure @ep does not violate the constraints, or -1 otherwise.
1715 */
1716static int ep_loop_check_proc(void *priv, void *cookie, int call_nests)
1717{
1718 int error = 0;
1719 struct file *file = priv;
1720 struct eventpoll *ep = file->private_data;
Jason Baron28d82dc2012-01-12 17:17:43 -08001721 struct eventpoll *ep_tovisit;
Davide Libenzi22bacca2011-02-25 14:44:12 -08001722 struct rb_node *rbp;
1723 struct epitem *epi;
1724
Nelson Elhaged8805e62011-10-31 17:13:14 -07001725 mutex_lock_nested(&ep->mtx, call_nests + 1);
Al Viro0ece2412020-09-10 08:30:05 -04001726 ep->gen = loop_check_gen;
Davide Libenzi22bacca2011-02-25 14:44:12 -08001727 for (rbp = rb_first(&ep->rbr); rbp; rbp = rb_next(rbp)) {
1728 epi = rb_entry(rbp, struct epitem, rbn);
1729 if (unlikely(is_file_epoll(epi->ffd.file))) {
Jason Baron28d82dc2012-01-12 17:17:43 -08001730 ep_tovisit = epi->ffd.file->private_data;
Al Viro0ece2412020-09-10 08:30:05 -04001731 if (ep_tovisit->gen == loop_check_gen)
Jason Baron28d82dc2012-01-12 17:17:43 -08001732 continue;
Davide Libenzi22bacca2011-02-25 14:44:12 -08001733 error = ep_call_nested(&poll_loop_ncalls, EP_MAX_NESTS,
Jason Baron28d82dc2012-01-12 17:17:43 -08001734 ep_loop_check_proc, epi->ffd.file,
1735 ep_tovisit, current);
Davide Libenzi22bacca2011-02-25 14:44:12 -08001736 if (error != 0)
1737 break;
Jason Baron28d82dc2012-01-12 17:17:43 -08001738 } else {
1739 /*
1740 * If we've reached a file that is not associated with
1741 * an ep, then we need to check if the newly added
1742 * links are going to add too many wakeup paths. We do
1743 * this by adding it to the tfile_check_list, if it's
1744 * not already there, and calling reverse_path_check()
1745 * during ep_insert().
1746 */
Marc Zyngier9bbd2032020-08-19 17:12:17 +01001747 if (list_empty(&epi->ffd.file->f_tfile_llink)) {
Al Viro8238ee92020-09-02 11:30:48 -04001748 if (get_file_rcu(epi->ffd.file))
1749 list_add(&epi->ffd.file->f_tfile_llink,
1750 &tfile_check_list);
Marc Zyngier9bbd2032020-08-19 17:12:17 +01001751 }
Davide Libenzi22bacca2011-02-25 14:44:12 -08001752 }
1753 }
1754 mutex_unlock(&ep->mtx);
1755
1756 return error;
1757}
1758
1759/**
1760 * ep_loop_check - Performs a check to verify that adding an epoll file (@file)
1761 * another epoll file (represented by @ep) does not create
1762 * closed loops or too deep chains.
1763 *
1764 * @ep: Pointer to the epoll private data structure.
1765 * @file: Pointer to the epoll file to be checked.
1766 *
1767 * Returns: Returns zero if adding the epoll @file inside current epoll
1768 * structure @ep does not violate the constraints, or -1 otherwise.
1769 */
1770static int ep_loop_check(struct eventpoll *ep, struct file *file)
1771{
Al Viro0ece2412020-09-10 08:30:05 -04001772 return ep_call_nested(&poll_loop_ncalls, EP_MAX_NESTS,
Davide Libenzi22bacca2011-02-25 14:44:12 -08001773 ep_loop_check_proc, file, ep, current);
Jason Baron28d82dc2012-01-12 17:17:43 -08001774}
1775
1776static void clear_tfile_check_list(void)
1777{
1778 struct file *file;
1779
1780 /* first clear the tfile_check_list */
1781 while (!list_empty(&tfile_check_list)) {
1782 file = list_first_entry(&tfile_check_list, struct file,
1783 f_tfile_llink);
1784 list_del_init(&file->f_tfile_llink);
Marc Zyngier9bbd2032020-08-19 17:12:17 +01001785 fput(file);
Jason Baron28d82dc2012-01-12 17:17:43 -08001786 }
1787 INIT_LIST_HEAD(&tfile_check_list);
Davide Libenzi22bacca2011-02-25 14:44:12 -08001788}
1789
Davide Libenzi7699acd2007-05-10 22:23:23 -07001790/*
Andrew Morton523723b2008-08-12 15:09:01 -07001791 * Open an eventpoll file descriptor.
Davide Libenzi7699acd2007-05-10 22:23:23 -07001792 */
Heiko Carstens5a8a82b2009-01-14 14:14:25 +01001793SYSCALL_DEFINE1(epoll_create1, int, flags)
Davide Libenzi7699acd2007-05-10 22:23:23 -07001794{
Jason Baron28d82dc2012-01-12 17:17:43 -08001795 int error, fd;
Davide Libenzibb57c3e2009-03-31 15:24:12 -07001796 struct eventpoll *ep = NULL;
Jason Baron28d82dc2012-01-12 17:17:43 -08001797 struct file *file;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001798
Ulrich Dreppere38b36f2008-07-23 21:29:42 -07001799 /* Check the EPOLL_* constant for consistency. */
1800 BUILD_BUG_ON(EPOLL_CLOEXEC != O_CLOEXEC);
1801
Davide Libenzi296e2362009-03-31 15:24:11 -07001802 if (flags & ~EPOLL_CLOEXEC)
1803 return -EINVAL;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001804 /*
Davide Libenzibb57c3e2009-03-31 15:24:12 -07001805 * Create the internal data structure ("struct eventpoll").
Davide Libenzi7699acd2007-05-10 22:23:23 -07001806 */
Ulrich Drepper9fe5ad92008-07-23 21:29:43 -07001807 error = ep_alloc(&ep);
Davide Libenzibb57c3e2009-03-31 15:24:12 -07001808 if (error < 0)
1809 return error;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001810 /*
1811 * Creates all the items needed to setup an eventpoll file. That is,
Al Viro2030a422008-02-23 06:46:49 -05001812 * a file structure and a free file descriptor.
Davide Libenzi7699acd2007-05-10 22:23:23 -07001813 */
Jason Baron28d82dc2012-01-12 17:17:43 -08001814 fd = get_unused_fd_flags(O_RDWR | (flags & O_CLOEXEC));
1815 if (fd < 0) {
1816 error = fd;
1817 goto out_free_ep;
1818 }
1819 file = anon_inode_getfile("[eventpoll]", &eventpoll_fops, ep,
Roland Dreier628ff7c2009-12-18 09:41:24 -08001820 O_RDWR | (flags & O_CLOEXEC));
Jason Baron28d82dc2012-01-12 17:17:43 -08001821 if (IS_ERR(file)) {
1822 error = PTR_ERR(file);
1823 goto out_free_fd;
1824 }
Jason Baron28d82dc2012-01-12 17:17:43 -08001825 ep->file = file;
Al Viro98022742012-08-17 22:42:36 -04001826 fd_install(fd, file);
Jason Baron28d82dc2012-01-12 17:17:43 -08001827 return fd;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001828
Jason Baron28d82dc2012-01-12 17:17:43 -08001829out_free_fd:
1830 put_unused_fd(fd);
1831out_free_ep:
1832 ep_free(ep);
Davide Libenzibb57c3e2009-03-31 15:24:12 -07001833 return error;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001834}
1835
Heiko Carstens5a8a82b2009-01-14 14:14:25 +01001836SYSCALL_DEFINE1(epoll_create, int, size)
Ulrich Dreppera0998b52008-07-23 21:29:27 -07001837{
Davide Libenzibfe38912009-05-12 13:19:44 -07001838 if (size <= 0)
Ulrich Drepper9fe5ad92008-07-23 21:29:43 -07001839 return -EINVAL;
1840
1841 return sys_epoll_create1(0);
Ulrich Dreppera0998b52008-07-23 21:29:27 -07001842}
1843
Davide Libenzi7699acd2007-05-10 22:23:23 -07001844/*
1845 * The following function implements the controller interface for
1846 * the eventpoll file that enables the insertion/removal/change of
Davide Libenzi67647d02007-05-15 01:40:52 -07001847 * file descriptors inside the interest set.
Davide Libenzi7699acd2007-05-10 22:23:23 -07001848 */
Heiko Carstens5a8a82b2009-01-14 14:14:25 +01001849SYSCALL_DEFINE4(epoll_ctl, int, epfd, int, op, int, fd,
1850 struct epoll_event __user *, event)
Davide Libenzi7699acd2007-05-10 22:23:23 -07001851{
1852 int error;
Jason Baron67347fe2013-11-12 15:10:18 -08001853 int full_check = 0;
Al Viro7e3fb582013-08-30 12:47:21 -04001854 struct fd f, tf;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001855 struct eventpoll *ep;
1856 struct epitem *epi;
1857 struct epoll_event epds;
Jason Baron67347fe2013-11-12 15:10:18 -08001858 struct eventpoll *tep = NULL;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001859
Davide Libenzi7699acd2007-05-10 22:23:23 -07001860 error = -EFAULT;
1861 if (ep_op_has_event(op) &&
1862 copy_from_user(&epds, event, sizeof(struct epoll_event)))
1863 goto error_return;
1864
Davide Libenzi7699acd2007-05-10 22:23:23 -07001865 error = -EBADF;
Al Viro7e3fb582013-08-30 12:47:21 -04001866 f = fdget(epfd);
1867 if (!f.file)
Davide Libenzi7699acd2007-05-10 22:23:23 -07001868 goto error_return;
1869
1870 /* Get the "struct file *" for the target file */
Al Viro7e3fb582013-08-30 12:47:21 -04001871 tf = fdget(fd);
1872 if (!tf.file)
Davide Libenzi7699acd2007-05-10 22:23:23 -07001873 goto error_fput;
1874
1875 /* The target file descriptor must support poll */
1876 error = -EPERM;
Al Viro72c2d532013-09-22 16:27:52 -04001877 if (!tf.file->f_op->poll)
Davide Libenzi7699acd2007-05-10 22:23:23 -07001878 goto error_tgt_fput;
1879
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001880 /* Check if EPOLLWAKEUP is allowed */
Nicolas Ioossc680e412014-09-09 14:50:51 -07001881 if (ep_op_has_event(op))
1882 ep_take_care_of_epollwakeup(&epds);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001883
Davide Libenzi7699acd2007-05-10 22:23:23 -07001884 /*
1885 * We have to check that the file structure underneath the file descriptor
1886 * the user passed to us _is_ an eventpoll file. And also we do not permit
1887 * adding an epoll file descriptor inside itself.
1888 */
1889 error = -EINVAL;
Al Viro7e3fb582013-08-30 12:47:21 -04001890 if (f.file == tf.file || !is_file_epoll(f.file))
Davide Libenzi7699acd2007-05-10 22:23:23 -07001891 goto error_tgt_fput;
1892
1893 /*
Jason Barondf0108c2016-01-20 14:59:24 -08001894 * epoll adds to the wakeup queue at EPOLL_CTL_ADD time only,
1895 * so EPOLLEXCLUSIVE is not allowed for a EPOLL_CTL_MOD operation.
1896 * Also, we do not currently supported nested exclusive wakeups.
1897 */
Jason Baronb6a515c2016-02-05 15:37:04 -08001898 if (epds.events & EPOLLEXCLUSIVE) {
1899 if (op == EPOLL_CTL_MOD)
1900 goto error_tgt_fput;
1901 if (op == EPOLL_CTL_ADD && (is_file_epoll(tf.file) ||
1902 (epds.events & ~EPOLLEXCLUSIVE_OK_BITS)))
1903 goto error_tgt_fput;
1904 }
Jason Barondf0108c2016-01-20 14:59:24 -08001905
1906 /*
Davide Libenzi7699acd2007-05-10 22:23:23 -07001907 * At this point it is safe to assume that the "private_data" contains
1908 * our own data structure.
1909 */
Al Viro7e3fb582013-08-30 12:47:21 -04001910 ep = f.file->private_data;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001911
Davide Libenzi22bacca2011-02-25 14:44:12 -08001912 /*
1913 * When we insert an epoll file descriptor, inside another epoll file
1914 * descriptor, there is the change of creating closed loops, which are
Jason Baron28d82dc2012-01-12 17:17:43 -08001915 * better be handled here, than in more critical paths. While we are
1916 * checking for loops we also determine the list of files reachable
1917 * and hang them on the tfile_check_list, so we can check that we
1918 * haven't created too many possible wakeup paths.
Davide Libenzi22bacca2011-02-25 14:44:12 -08001919 *
Jason Baron67347fe2013-11-12 15:10:18 -08001920 * We do not need to take the global 'epumutex' on EPOLL_CTL_ADD when
1921 * the epoll file descriptor is attaching directly to a wakeup source,
1922 * unless the epoll file descriptor is nested. The purpose of taking the
1923 * 'epmutex' on add is to prevent complex toplogies such as loops and
1924 * deep wakeup paths from forming in parallel through multiple
1925 * EPOLL_CTL_ADD operations.
Davide Libenzi22bacca2011-02-25 14:44:12 -08001926 */
Nelson Elhaged8805e62011-10-31 17:13:14 -07001927 mutex_lock_nested(&ep->mtx, 0);
Jason Baron67347fe2013-11-12 15:10:18 -08001928 if (op == EPOLL_CTL_ADD) {
1929 if (!list_empty(&f.file->f_ep_links) ||
Al Viro187af782020-09-10 08:33:27 -04001930 ep->gen == loop_check_gen ||
Jason Baron67347fe2013-11-12 15:10:18 -08001931 is_file_epoll(tf.file)) {
1932 full_check = 1;
1933 mutex_unlock(&ep->mtx);
1934 mutex_lock(&epmutex);
1935 if (is_file_epoll(tf.file)) {
1936 error = -ELOOP;
Al Virob3ce6ca2020-08-22 18:25:52 -04001937 if (ep_loop_check(ep, tf.file) != 0)
Jason Baron67347fe2013-11-12 15:10:18 -08001938 goto error_tgt_fput;
Marc Zyngier9bbd2032020-08-19 17:12:17 +01001939 } else {
1940 get_file(tf.file);
Jason Baron67347fe2013-11-12 15:10:18 -08001941 list_add(&tf.file->f_tfile_llink,
1942 &tfile_check_list);
Marc Zyngier9bbd2032020-08-19 17:12:17 +01001943 }
Jason Baron67347fe2013-11-12 15:10:18 -08001944 mutex_lock_nested(&ep->mtx, 0);
1945 if (is_file_epoll(tf.file)) {
1946 tep = tf.file->private_data;
1947 mutex_lock_nested(&tep->mtx, 1);
1948 }
1949 }
1950 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07001951
Davide Libenzi67647d02007-05-15 01:40:52 -07001952 /*
1953 * Try to lookup the file inside our RB tree, Since we grabbed "mtx"
1954 * above, we can be sure to be able to use the item looked up by
1955 * ep_find() till we release the mutex.
1956 */
Al Viro7e3fb582013-08-30 12:47:21 -04001957 epi = ep_find(ep, tf.file, fd);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001958
1959 error = -EINVAL;
1960 switch (op) {
1961 case EPOLL_CTL_ADD:
1962 if (!epi) {
1963 epds.events |= POLLERR | POLLHUP;
Jason Baron67347fe2013-11-12 15:10:18 -08001964 error = ep_insert(ep, &epds, tf.file, fd, full_check);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001965 } else
1966 error = -EEXIST;
1967 break;
1968 case EPOLL_CTL_DEL:
1969 if (epi)
1970 error = ep_remove(ep, epi);
1971 else
1972 error = -ENOENT;
1973 break;
1974 case EPOLL_CTL_MOD:
1975 if (epi) {
Jason Baronb6a515c2016-02-05 15:37:04 -08001976 if (!(epi->event.events & EPOLLEXCLUSIVE)) {
1977 epds.events |= POLLERR | POLLHUP;
1978 error = ep_modify(ep, epi, &epds);
1979 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07001980 } else
1981 error = -ENOENT;
1982 break;
1983 }
Jason Baron67347fe2013-11-12 15:10:18 -08001984 if (tep != NULL)
1985 mutex_unlock(&tep->mtx);
Davide Libenzid47de162007-05-15 01:40:41 -07001986 mutex_unlock(&ep->mtx);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001987
1988error_tgt_fput:
Al Virob3ce6ca2020-08-22 18:25:52 -04001989 if (full_check) {
1990 clear_tfile_check_list();
Al Viro0ece2412020-09-10 08:30:05 -04001991 loop_check_gen++;
Davide Libenzi22bacca2011-02-25 14:44:12 -08001992 mutex_unlock(&epmutex);
Al Virob3ce6ca2020-08-22 18:25:52 -04001993 }
Davide Libenzi22bacca2011-02-25 14:44:12 -08001994
Al Viro7e3fb582013-08-30 12:47:21 -04001995 fdput(tf);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001996error_fput:
Al Viro7e3fb582013-08-30 12:47:21 -04001997 fdput(f);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001998error_return:
Davide Libenzi7699acd2007-05-10 22:23:23 -07001999
2000 return error;
2001}
2002
2003/*
2004 * Implement the event wait interface for the eventpoll file. It is the kernel
2005 * part of the user space epoll_wait(2).
2006 */
Heiko Carstens5a8a82b2009-01-14 14:14:25 +01002007SYSCALL_DEFINE4(epoll_wait, int, epfd, struct epoll_event __user *, events,
2008 int, maxevents, int, timeout)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002009{
Al Viro2903ff02012-08-28 12:52:22 -04002010 int error;
2011 struct fd f;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002012 struct eventpoll *ep;
2013
Davide Libenzi7699acd2007-05-10 22:23:23 -07002014 /* The maximum number of event must be greater than zero */
2015 if (maxevents <= 0 || maxevents > EP_MAX_EVENTS)
2016 return -EINVAL;
2017
2018 /* Verify that the area passed by the user is writeable */
Al Viro2903ff02012-08-28 12:52:22 -04002019 if (!access_ok(VERIFY_WRITE, events, maxevents * sizeof(struct epoll_event)))
2020 return -EFAULT;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002021
2022 /* Get the "struct file *" for the eventpoll file */
Al Viro2903ff02012-08-28 12:52:22 -04002023 f = fdget(epfd);
2024 if (!f.file)
2025 return -EBADF;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002026
2027 /*
2028 * We have to check that the file structure underneath the fd
2029 * the user passed to us _is_ an eventpoll file.
2030 */
2031 error = -EINVAL;
Al Viro2903ff02012-08-28 12:52:22 -04002032 if (!is_file_epoll(f.file))
Davide Libenzi7699acd2007-05-10 22:23:23 -07002033 goto error_fput;
2034
2035 /*
2036 * At this point it is safe to assume that the "private_data" contains
2037 * our own data structure.
2038 */
Al Viro2903ff02012-08-28 12:52:22 -04002039 ep = f.file->private_data;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002040
2041 /* Time to fish for events ... */
2042 error = ep_poll(ep, events, maxevents, timeout);
2043
2044error_fput:
Al Viro2903ff02012-08-28 12:52:22 -04002045 fdput(f);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002046 return error;
2047}
2048
Davide Libenzi7699acd2007-05-10 22:23:23 -07002049/*
2050 * Implement the event wait interface for the eventpoll file. It is the kernel
2051 * part of the user space epoll_pwait(2).
2052 */
Heiko Carstens5a8a82b2009-01-14 14:14:25 +01002053SYSCALL_DEFINE6(epoll_pwait, int, epfd, struct epoll_event __user *, events,
2054 int, maxevents, int, timeout, const sigset_t __user *, sigmask,
2055 size_t, sigsetsize)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002056{
2057 int error;
2058 sigset_t ksigmask, sigsaved;
2059
2060 /*
2061 * If the caller wants a certain signal mask to be set during the wait,
2062 * we apply it here.
2063 */
2064 if (sigmask) {
2065 if (sigsetsize != sizeof(sigset_t))
2066 return -EINVAL;
2067 if (copy_from_user(&ksigmask, sigmask, sizeof(ksigmask)))
2068 return -EFAULT;
Oleg Nesterov77d55912013-07-03 15:08:14 -07002069 sigsaved = current->blocked;
2070 set_current_blocked(&ksigmask);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002071 }
2072
2073 error = sys_epoll_wait(epfd, events, maxevents, timeout);
2074
2075 /*
2076 * If we changed the signal mask, we need to restore the original one.
2077 * In case we've got a signal while waiting, we do not restore the
2078 * signal mask yet, and we allow do_signal() to deliver the signal on
2079 * the way back to userspace, before the signal mask is restored.
2080 */
2081 if (sigmask) {
2082 if (error == -EINTR) {
2083 memcpy(&current->saved_sigmask, &sigsaved,
Davide Libenzic7ea7632007-05-15 01:40:47 -07002084 sizeof(sigsaved));
Roland McGrath4e4c22c2008-04-30 00:53:06 -07002085 set_restore_sigmask();
Davide Libenzi7699acd2007-05-10 22:23:23 -07002086 } else
Oleg Nesterov77d55912013-07-03 15:08:14 -07002087 set_current_blocked(&sigsaved);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002088 }
2089
2090 return error;
2091}
2092
Al Viro35280bd2013-02-24 14:52:17 -05002093#ifdef CONFIG_COMPAT
2094COMPAT_SYSCALL_DEFINE6(epoll_pwait, int, epfd,
2095 struct epoll_event __user *, events,
2096 int, maxevents, int, timeout,
2097 const compat_sigset_t __user *, sigmask,
2098 compat_size_t, sigsetsize)
2099{
2100 long err;
2101 compat_sigset_t csigmask;
2102 sigset_t ksigmask, sigsaved;
2103
2104 /*
2105 * If the caller wants a certain signal mask to be set during the wait,
2106 * we apply it here.
2107 */
2108 if (sigmask) {
2109 if (sigsetsize != sizeof(compat_sigset_t))
2110 return -EINVAL;
2111 if (copy_from_user(&csigmask, sigmask, sizeof(csigmask)))
2112 return -EFAULT;
2113 sigset_from_compat(&ksigmask, &csigmask);
Oleg Nesterov77d55912013-07-03 15:08:14 -07002114 sigsaved = current->blocked;
2115 set_current_blocked(&ksigmask);
Al Viro35280bd2013-02-24 14:52:17 -05002116 }
2117
2118 err = sys_epoll_wait(epfd, events, maxevents, timeout);
2119
2120 /*
2121 * If we changed the signal mask, we need to restore the original one.
2122 * In case we've got a signal while waiting, we do not restore the
2123 * signal mask yet, and we allow do_signal() to deliver the signal on
2124 * the way back to userspace, before the signal mask is restored.
2125 */
2126 if (sigmask) {
2127 if (err == -EINTR) {
2128 memcpy(&current->saved_sigmask, &sigsaved,
2129 sizeof(sigsaved));
2130 set_restore_sigmask();
2131 } else
Oleg Nesterov77d55912013-07-03 15:08:14 -07002132 set_current_blocked(&sigsaved);
Al Viro35280bd2013-02-24 14:52:17 -05002133 }
2134
2135 return err;
2136}
2137#endif
2138
Linus Torvalds1da177e2005-04-16 15:20:36 -07002139static int __init eventpoll_init(void)
2140{
Davide Libenzi7ef99642008-12-01 13:13:55 -08002141 struct sysinfo si;
2142
2143 si_meminfo(&si);
Davide Libenzi9df04e12009-01-29 14:25:26 -08002144 /*
2145 * Allows top 4% of lomem to be allocated for epoll watches (per user).
2146 */
2147 max_user_watches = (((si.totalram - si.totalhigh) / 25) << PAGE_SHIFT) /
Davide Libenzi7ef99642008-12-01 13:13:55 -08002148 EP_ITEM_COST;
Robin Holt52bd19f72011-01-12 17:00:01 -08002149 BUG_ON(max_user_watches < 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002150
Davide Libenzi22bacca2011-02-25 14:44:12 -08002151 /*
2152 * Initialize the structure used to perform epoll file descriptor
2153 * inclusion loops checks.
2154 */
2155 ep_nested_calls_init(&poll_loop_ncalls);
2156
Linus Torvalds1da177e2005-04-16 15:20:36 -07002157 /* Initialize the structure used to perform safe poll wait head wake ups */
Davide Libenzi5071f972009-03-31 15:24:10 -07002158 ep_nested_calls_init(&poll_safewake_ncalls);
2159
2160 /* Initialize the structure used to perform file's f_op->poll() calls */
2161 ep_nested_calls_init(&poll_readywalk_ncalls);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002162
Eric Wong39732ca2013-04-30 15:27:38 -07002163 /*
2164 * We can have many thousands of epitems, so prevent this from
2165 * using an extra cache line on 64-bit (and smaller) CPUs
2166 */
2167 BUILD_BUG_ON(sizeof(void *) <= 8 && sizeof(struct epitem) > 128);
2168
Linus Torvalds1da177e2005-04-16 15:20:36 -07002169 /* Allocates slab cache used to allocate "struct epitem" items */
2170 epi_cache = kmem_cache_create("eventpoll_epi", sizeof(struct epitem),
Davide Libenzibb57c3e2009-03-31 15:24:12 -07002171 0, SLAB_HWCACHE_ALIGN | SLAB_PANIC, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002172
2173 /* Allocates slab cache used to allocate "struct eppoll_entry" */
2174 pwq_cache = kmem_cache_create("eventpoll_pwq",
Davide Libenzibb57c3e2009-03-31 15:24:12 -07002175 sizeof(struct eppoll_entry), 0, SLAB_PANIC, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002176
Linus Torvalds1da177e2005-04-16 15:20:36 -07002177 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002178}
Davide Libenzicea69242007-05-10 22:23:22 -07002179fs_initcall(eventpoll_init);