blob: b041b66002db7951acb3172105d5568f90b323b4 [file] [log] [blame]
Thomas Gleixner2874c5f2019-05-27 08:55:01 +02001// SPDX-License-Identifier: GPL-2.0-or-later
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
Davide Libenzi5071f972009-03-31 15:24:10 -07003 * fs/eventpoll.c (Efficient event retrieval implementation)
4 * Copyright (C) 2001,...,2009 Davide Libenzi
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07006 * Davide Libenzi <davidel@xmailserver.org>
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 */
8
Linus Torvalds1da177e2005-04-16 15:20:36 -07009#include <linux/init.h>
10#include <linux/kernel.h>
Ingo Molnar174cd4b2017-02-02 19:15:33 +010011#include <linux/sched/signal.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070012#include <linux/fs.h>
13#include <linux/file.h>
14#include <linux/signal.h>
15#include <linux/errno.h>
16#include <linux/mm.h>
17#include <linux/slab.h>
18#include <linux/poll.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070019#include <linux/string.h>
20#include <linux/list.h>
21#include <linux/hash.h>
22#include <linux/spinlock.h>
23#include <linux/syscalls.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#include <linux/rbtree.h>
25#include <linux/wait.h>
26#include <linux/eventpoll.h>
27#include <linux/mount.h>
28#include <linux/bitops.h>
Arjan van de Ven144efe32006-03-23 03:00:32 -080029#include <linux/mutex.h>
Davide Libenzida66f7c2007-05-10 22:23:21 -070030#include <linux/anon_inodes.h>
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +020031#include <linux/device.h>
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -080032#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070033#include <asm/io.h>
34#include <asm/mman.h>
Arun Sharma600634972011-07-26 16:09:06 -070035#include <linux/atomic.h>
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -080036#include <linux/proc_fs.h>
37#include <linux/seq_file.h>
Al Viro35280bd2013-02-24 14:52:17 -050038#include <linux/compat.h>
Jason Baronae10b2b2013-11-12 15:10:16 -080039#include <linux/rculist.h>
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -070040#include <net/busy_poll.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070041
Linus Torvalds1da177e2005-04-16 15:20:36 -070042/*
43 * LOCKING:
44 * There are three level of locking required by epoll :
45 *
Arjan van de Ven144efe32006-03-23 03:00:32 -080046 * 1) epmutex (mutex)
Davide Libenzic7ea7632007-05-15 01:40:47 -070047 * 2) ep->mtx (mutex)
Roman Penyaeva218cc42019-03-07 16:28:53 -080048 * 3) ep->lock (rwlock)
Linus Torvalds1da177e2005-04-16 15:20:36 -070049 *
50 * The acquire order is the one listed above, from 1 to 3.
Roman Penyaeva218cc42019-03-07 16:28:53 -080051 * We need a rwlock (ep->lock) because we manipulate objects
Linus Torvalds1da177e2005-04-16 15:20:36 -070052 * from inside the poll callback, that might be triggered from
53 * a wake_up() that in turn might be called from IRQ context.
54 * So we can't sleep inside the poll callback and hence we need
55 * a spinlock. During the event transfer loop (from kernel to
56 * user space) we could end up sleeping due a copy_to_user(), so
57 * we need a lock that will allow us to sleep. This lock is a
Davide Libenzid47de162007-05-15 01:40:41 -070058 * mutex (ep->mtx). It is acquired during the event transfer loop,
59 * during epoll_ctl(EPOLL_CTL_DEL) and during eventpoll_release_file().
60 * Then we also need a global mutex to serialize eventpoll_release_file()
61 * and ep_free().
62 * This mutex is acquired by ep_free() during the epoll file
Linus Torvalds1da177e2005-04-16 15:20:36 -070063 * cleanup path and it is also acquired by eventpoll_release_file()
64 * if a file has been pushed inside an epoll set and it is then
Daniel Balutabf6a41d2011-01-30 23:42:29 +020065 * close()d without a previous call to epoll_ctl(EPOLL_CTL_DEL).
Davide Libenzi22bacca2011-02-25 14:44:12 -080066 * It is also acquired when inserting an epoll fd onto another epoll
67 * fd. We do this so that we walk the epoll tree and ensure that this
68 * insertion does not create a cycle of epoll file descriptors, which
69 * could lead to deadlock. We need a global mutex to prevent two
70 * simultaneous inserts (A into B and B into A) from racing and
71 * constructing a cycle without either insert observing that it is
72 * going to.
Nelson Elhaged8805e62011-10-31 17:13:14 -070073 * It is necessary to acquire multiple "ep->mtx"es at once in the
74 * case when one epoll fd is added to another. In this case, we
75 * always acquire the locks in the order of nesting (i.e. after
76 * epoll_ctl(e1, EPOLL_CTL_ADD, e2), e1->mtx will always be acquired
77 * before e2->mtx). Since we disallow cycles of epoll file
78 * descriptors, this ensures that the mutexes are well-ordered. In
79 * order to communicate this nesting to lockdep, when walking a tree
80 * of epoll file descriptors, we use the current recursion depth as
81 * the lockdep subkey.
Davide Libenzid47de162007-05-15 01:40:41 -070082 * It is possible to drop the "ep->mtx" and to use the global
Roman Penyaeva218cc42019-03-07 16:28:53 -080083 * mutex "epmutex" (together with "ep->lock") to have it working,
Davide Libenzid47de162007-05-15 01:40:41 -070084 * but having "ep->mtx" will make the interface more scalable.
Arjan van de Ven144efe32006-03-23 03:00:32 -080085 * Events that require holding "epmutex" are very rare, while for
Davide Libenzid47de162007-05-15 01:40:41 -070086 * normal operations the epoll private "ep->mtx" will guarantee
87 * a better scalability.
Linus Torvalds1da177e2005-04-16 15:20:36 -070088 */
89
Linus Torvalds1da177e2005-04-16 15:20:36 -070090/* Epoll private bits inside the event mask */
Jason Barondf0108c2016-01-20 14:59:24 -080091#define EP_PRIVATE_BITS (EPOLLWAKEUP | EPOLLONESHOT | EPOLLET | EPOLLEXCLUSIVE)
Linus Torvalds1da177e2005-04-16 15:20:36 -070092
Linus Torvaldsa9a08842018-02-11 14:34:03 -080093#define EPOLLINOUT_BITS (EPOLLIN | EPOLLOUT)
Jason Baronb6a515c2016-02-05 15:37:04 -080094
Linus Torvaldsa9a08842018-02-11 14:34:03 -080095#define EPOLLEXCLUSIVE_OK_BITS (EPOLLINOUT_BITS | EPOLLERR | EPOLLHUP | \
Jason Baronb6a515c2016-02-05 15:37:04 -080096 EPOLLWAKEUP | EPOLLET | EPOLLEXCLUSIVE)
97
Davide Libenzi5071f972009-03-31 15:24:10 -070098/* Maximum number of nesting allowed inside epoll sets */
99#define EP_MAX_NESTS 4
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100
Davide Libenzib6119672006-10-11 01:21:44 -0700101#define EP_MAX_EVENTS (INT_MAX / sizeof(struct epoll_event))
102
Davide Libenzid47de162007-05-15 01:40:41 -0700103#define EP_UNACTIVE_PTR ((void *) -1L)
104
Davide Libenzi7ef99642008-12-01 13:13:55 -0800105#define EP_ITEM_COST (sizeof(struct epitem) + sizeof(struct eppoll_entry))
106
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107struct epoll_filefd {
108 struct file *file;
109 int fd;
Eric Wong39732ca2013-04-30 15:27:38 -0700110} __packed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111
112/*
Davide Libenzi5071f972009-03-31 15:24:10 -0700113 * Structure used to track possible nested calls, for too deep recursions
114 * and loop cycles.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115 */
Davide Libenzi5071f972009-03-31 15:24:10 -0700116struct nested_call_node {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117 struct list_head llink;
Davide Libenzi5071f972009-03-31 15:24:10 -0700118 void *cookie;
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700119 void *ctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120};
121
122/*
Davide Libenzi5071f972009-03-31 15:24:10 -0700123 * This structure is used as collector for nested calls, to check for
124 * maximum recursion dept and loop cycles.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125 */
Davide Libenzi5071f972009-03-31 15:24:10 -0700126struct nested_calls {
127 struct list_head tasks_call_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128 spinlock_t lock;
129};
130
131/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132 * Each file descriptor added to the eventpoll interface will
Davide Libenzi6192bd52007-05-08 00:25:41 -0700133 * have an entry of this type linked to the "rbr" RB tree.
Eric Wong39732ca2013-04-30 15:27:38 -0700134 * Avoid increasing the size of this struct, there can be many thousands
135 * of these on a server and we do not want this to take another cache line.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136 */
137struct epitem {
Jason Baronae10b2b2013-11-12 15:10:16 -0800138 union {
139 /* RB tree node links this structure to the eventpoll RB tree */
140 struct rb_node rbn;
141 /* Used to free the struct epitem */
142 struct rcu_head rcu;
143 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144
145 /* List header used to link this structure to the eventpoll ready list */
146 struct list_head rdllink;
147
Davide Libenzic7ea7632007-05-15 01:40:47 -0700148 /*
149 * Works together "struct eventpoll"->ovflist in keeping the
150 * single linked chain of items.
151 */
152 struct epitem *next;
153
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154 /* The file descriptor information this item refers to */
155 struct epoll_filefd ffd;
156
157 /* Number of active wait queue attached to poll operations */
158 int nwait;
159
160 /* List containing poll wait queues */
161 struct list_head pwqlist;
162
163 /* The "container" of this item */
164 struct eventpoll *ep;
165
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166 /* List header used to link this item to the "struct file" items list */
167 struct list_head fllink;
Davide Libenzid47de162007-05-15 01:40:41 -0700168
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200169 /* wakeup_source used when EPOLLWAKEUP is set */
Eric Wongeea1d582013-04-30 15:27:39 -0700170 struct wakeup_source __rcu *ws;
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200171
Davide Libenzic7ea7632007-05-15 01:40:47 -0700172 /* The structure that describe the interested events and the source fd */
173 struct epoll_event event;
Davide Libenzid47de162007-05-15 01:40:41 -0700174};
175
176/*
177 * This structure is stored inside the "private_data" member of the file
Daniel Balutabf6a41d2011-01-30 23:42:29 +0200178 * structure and represents the main data structure for the eventpoll
Davide Libenzid47de162007-05-15 01:40:41 -0700179 * interface.
180 */
181struct eventpoll {
Davide Libenzid47de162007-05-15 01:40:41 -0700182 /*
183 * This mutex is used to ensure that files are not removed
184 * while epoll is using them. This is held during the event
185 * collection loop, the file cleanup path, the epoll file exit
186 * code and the ctl operations.
187 */
188 struct mutex mtx;
189
190 /* Wait queue used by sys_epoll_wait() */
191 wait_queue_head_t wq;
192
193 /* Wait queue used by file->poll() */
194 wait_queue_head_t poll_wait;
195
196 /* List of ready file descriptors */
197 struct list_head rdllist;
198
Roman Penyaeva218cc42019-03-07 16:28:53 -0800199 /* Lock which protects rdllist and ovflist */
200 rwlock_t lock;
201
Davide Libenzi67647d02007-05-15 01:40:52 -0700202 /* RB tree root used to store monitored fd structs */
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700203 struct rb_root_cached rbr;
Davide Libenzid47de162007-05-15 01:40:41 -0700204
205 /*
206 * This is a single linked list that chains all the "struct epitem" that
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300207 * happened while transferring ready events to userspace w/out
Roman Penyaeva218cc42019-03-07 16:28:53 -0800208 * holding ->lock.
Davide Libenzid47de162007-05-15 01:40:41 -0700209 */
210 struct epitem *ovflist;
Davide Libenzi7ef99642008-12-01 13:13:55 -0800211
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200212 /* wakeup_source used when ep_scan_ready_list is running */
213 struct wakeup_source *ws;
214
Davide Libenzi7ef99642008-12-01 13:13:55 -0800215 /* The user that created the eventpoll descriptor */
216 struct user_struct *user;
Jason Baron28d82dc2012-01-12 17:17:43 -0800217
218 struct file *file;
219
220 /* used to optimize loop detection check */
221 int visited;
222 struct list_head visited_list_link;
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700223
224#ifdef CONFIG_NET_RX_BUSY_POLL
225 /* used to track busy poll napi_id */
226 unsigned int napi_id;
227#endif
Davide Libenzid47de162007-05-15 01:40:41 -0700228};
229
230/* Wait structure used by the poll hooks */
231struct eppoll_entry {
232 /* List header used to link this structure to the "struct epitem" */
233 struct list_head llink;
234
235 /* The "base" pointer is set to the container "struct epitem" */
Tony Battersby4f0989d2009-03-31 15:24:16 -0700236 struct epitem *base;
Davide Libenzid47de162007-05-15 01:40:41 -0700237
238 /*
239 * Wait queue item that will be linked to the target file wait
240 * queue head.
241 */
Ingo Molnarac6424b2017-06-20 12:06:13 +0200242 wait_queue_entry_t wait;
Davide Libenzid47de162007-05-15 01:40:41 -0700243
244 /* The wait queue head that linked the "wait" wait queue item */
245 wait_queue_head_t *whead;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246};
247
248/* Wrapper struct used by poll queueing */
249struct ep_pqueue {
250 poll_table pt;
251 struct epitem *epi;
252};
253
Davide Libenzi5071f972009-03-31 15:24:10 -0700254/* Used by the ep_send_events() function as callback private data */
255struct ep_send_events_data {
256 int maxevents;
257 struct epoll_event __user *events;
Al Virod7ebbe42018-02-01 15:21:13 -0500258 int res;
Davide Libenzi5071f972009-03-31 15:24:10 -0700259};
260
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261/*
Davide Libenzi7ef99642008-12-01 13:13:55 -0800262 * Configuration options available inside /proc/sys/fs/epoll/
263 */
Davide Libenzi7ef99642008-12-01 13:13:55 -0800264/* Maximum number of epoll watched descriptors, per user */
Robin Holt52bd19f72011-01-12 17:00:01 -0800265static long max_user_watches __read_mostly;
Davide Libenzi7ef99642008-12-01 13:13:55 -0800266
267/*
Davide Libenzid47de162007-05-15 01:40:41 -0700268 * This mutex is used to serialize ep_free() and eventpoll_release_file().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269 */
Davide Libenzi7ef99642008-12-01 13:13:55 -0800270static DEFINE_MUTEX(epmutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271
Davide Libenzi22bacca2011-02-25 14:44:12 -0800272/* Used to check for epoll file descriptor inclusion loops */
273static struct nested_calls poll_loop_ncalls;
274
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275/* Slab cache used to allocate "struct epitem" */
Christoph Lametere18b8902006-12-06 20:33:20 -0800276static struct kmem_cache *epi_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277
278/* Slab cache used to allocate "struct eppoll_entry" */
Christoph Lametere18b8902006-12-06 20:33:20 -0800279static struct kmem_cache *pwq_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280
Jason Baron28d82dc2012-01-12 17:17:43 -0800281/* Visited nodes during ep_loop_check(), so we can unset them when we finish */
282static LIST_HEAD(visited_list);
283
284/*
285 * List of files with newly added links, where we may need to limit the number
286 * of emanating paths. Protected by the epmutex.
287 */
288static LIST_HEAD(tfile_check_list);
289
Davide Libenzi7ef99642008-12-01 13:13:55 -0800290#ifdef CONFIG_SYSCTL
291
292#include <linux/sysctl.h>
293
Matteo Croceeec48442019-07-18 15:58:50 -0700294static long long_zero;
Robin Holt52bd19f72011-01-12 17:00:01 -0800295static long long_max = LONG_MAX;
Davide Libenzi7ef99642008-12-01 13:13:55 -0800296
Joe Perches1f7e0612014-06-06 14:38:05 -0700297struct ctl_table epoll_table[] = {
Davide Libenzi7ef99642008-12-01 13:13:55 -0800298 {
Davide Libenzi7ef99642008-12-01 13:13:55 -0800299 .procname = "max_user_watches",
300 .data = &max_user_watches,
Robin Holt52bd19f72011-01-12 17:00:01 -0800301 .maxlen = sizeof(max_user_watches),
Davide Libenzi7ef99642008-12-01 13:13:55 -0800302 .mode = 0644,
Robin Holt52bd19f72011-01-12 17:00:01 -0800303 .proc_handler = proc_doulongvec_minmax,
Matteo Croceeec48442019-07-18 15:58:50 -0700304 .extra1 = &long_zero,
Robin Holt52bd19f72011-01-12 17:00:01 -0800305 .extra2 = &long_max,
Davide Libenzi7ef99642008-12-01 13:13:55 -0800306 },
Eric W. Biedermanab092032009-11-05 14:25:10 -0800307 { }
Davide Libenzi7ef99642008-12-01 13:13:55 -0800308};
309#endif /* CONFIG_SYSCTL */
310
Jason Baron28d82dc2012-01-12 17:17:43 -0800311static const struct file_operations eventpoll_fops;
312
313static inline int is_file_epoll(struct file *f)
314{
315 return f->f_op == &eventpoll_fops;
316}
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700317
Davide Libenzi67647d02007-05-15 01:40:52 -0700318/* Setup the structure that is used as key for the RB tree */
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700319static inline void ep_set_ffd(struct epoll_filefd *ffd,
320 struct file *file, int fd)
321{
322 ffd->file = file;
323 ffd->fd = fd;
324}
325
Davide Libenzi67647d02007-05-15 01:40:52 -0700326/* Compare RB tree keys */
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700327static inline int ep_cmp_ffd(struct epoll_filefd *p1,
328 struct epoll_filefd *p2)
329{
330 return (p1->file > p2->file ? +1:
331 (p1->file < p2->file ? -1 : p1->fd - p2->fd));
332}
333
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700334/* Tells us if the item is currently linked */
Davidlohr Bueso992991c2018-08-21 21:58:26 -0700335static inline int ep_is_linked(struct epitem *epi)
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700336{
Davidlohr Bueso992991c2018-08-21 21:58:26 -0700337 return !list_empty(&epi->rdllink);
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700338}
339
Ingo Molnarac6424b2017-06-20 12:06:13 +0200340static inline struct eppoll_entry *ep_pwq_from_wait(wait_queue_entry_t *p)
Oleg Nesterov971316f2012-02-24 20:07:29 +0100341{
342 return container_of(p, struct eppoll_entry, wait);
343}
344
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700345/* Get the "struct epitem" from a wait queue pointer */
Ingo Molnarac6424b2017-06-20 12:06:13 +0200346static inline struct epitem *ep_item_from_wait(wait_queue_entry_t *p)
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700347{
348 return container_of(p, struct eppoll_entry, wait)->base;
349}
350
351/* Get the "struct epitem" from an epoll queue wrapper */
Davide Libenzicdac75e2008-04-29 00:58:34 -0700352static inline struct epitem *ep_item_from_epqueue(poll_table *p)
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700353{
354 return container_of(p, struct ep_pqueue, pt)->epi;
355}
356
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357/* Initialize the poll safe wake up structure */
Davide Libenzi5071f972009-03-31 15:24:10 -0700358static void ep_nested_calls_init(struct nested_calls *ncalls)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359{
Davide Libenzi5071f972009-03-31 15:24:10 -0700360 INIT_LIST_HEAD(&ncalls->tasks_call_list);
361 spin_lock_init(&ncalls->lock);
362}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363
Davide Libenzi5071f972009-03-31 15:24:10 -0700364/**
Davide Libenzi3fb0e582011-03-22 16:34:46 -0700365 * ep_events_available - Checks if ready events might be available.
366 *
367 * @ep: Pointer to the eventpoll context.
368 *
369 * Returns: Returns a value different than zero if ready events are available,
370 * or zero otherwise.
371 */
372static inline int ep_events_available(struct eventpoll *ep)
373{
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -0800374 return !list_empty_careful(&ep->rdllist) ||
375 READ_ONCE(ep->ovflist) != EP_UNACTIVE_PTR;
Davide Libenzi3fb0e582011-03-22 16:34:46 -0700376}
377
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700378#ifdef CONFIG_NET_RX_BUSY_POLL
379static bool ep_busy_loop_end(void *p, unsigned long start_time)
380{
381 struct eventpoll *ep = p;
382
383 return ep_events_available(ep) || busy_loop_timeout(start_time);
384}
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700385
386/*
387 * Busy poll if globally on and supporting sockets found && no events,
388 * busy loop will return if need_resched or ep_events_available.
389 *
390 * we must do our busy polling with irqs enabled
391 */
392static void ep_busy_loop(struct eventpoll *ep, int nonblock)
393{
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700394 unsigned int napi_id = READ_ONCE(ep->napi_id);
395
396 if ((napi_id >= MIN_NAPI_ID) && net_busy_loop_on())
397 napi_busy_loop(napi_id, nonblock ? NULL : ep_busy_loop_end, ep);
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700398}
399
400static inline void ep_reset_busy_poll_napi_id(struct eventpoll *ep)
401{
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700402 if (ep->napi_id)
403 ep->napi_id = 0;
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700404}
405
406/*
407 * Set epoll busy poll NAPI ID from sk.
408 */
409static inline void ep_set_busy_poll_napi_id(struct epitem *epi)
410{
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700411 struct eventpoll *ep;
412 unsigned int napi_id;
413 struct socket *sock;
414 struct sock *sk;
415 int err;
416
417 if (!net_busy_loop_on())
418 return;
419
420 sock = sock_from_file(epi->ffd.file, &err);
421 if (!sock)
422 return;
423
424 sk = sock->sk;
425 if (!sk)
426 return;
427
428 napi_id = READ_ONCE(sk->sk_napi_id);
429 ep = epi->ep;
430
431 /* Non-NAPI IDs can be rejected
432 * or
433 * Nothing to do if we already have this ID
434 */
435 if (napi_id < MIN_NAPI_ID || napi_id == ep->napi_id)
436 return;
437
438 /* record NAPI ID for use in next busy poll */
439 ep->napi_id = napi_id;
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700440}
441
Davidlohr Bueso514056d2018-08-21 21:58:19 -0700442#else
443
444static inline void ep_busy_loop(struct eventpoll *ep, int nonblock)
445{
446}
447
448static inline void ep_reset_busy_poll_napi_id(struct eventpoll *ep)
449{
450}
451
452static inline void ep_set_busy_poll_napi_id(struct epitem *epi)
453{
454}
455
456#endif /* CONFIG_NET_RX_BUSY_POLL */
457
Davide Libenzi3fb0e582011-03-22 16:34:46 -0700458/**
Davide Libenzi5071f972009-03-31 15:24:10 -0700459 * ep_call_nested - Perform a bound (possibly) nested call, by checking
460 * that the recursion limit is not exceeded, and that
461 * the same nested call (by the meaning of same cookie) is
462 * no re-entered.
463 *
464 * @ncalls: Pointer to the nested_calls structure to be used for this call.
Davide Libenzi5071f972009-03-31 15:24:10 -0700465 * @nproc: Nested call core function pointer.
466 * @priv: Opaque data to be passed to the @nproc callback.
467 * @cookie: Cookie to be used to identify this nested call.
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700468 * @ctx: This instance context.
Davide Libenzi5071f972009-03-31 15:24:10 -0700469 *
470 * Returns: Returns the code returned by the @nproc callback, or -1 if
471 * the maximum recursion limit has been exceeded.
472 */
Davidlohr Bueso74bdc122019-01-03 15:27:02 -0800473static int ep_call_nested(struct nested_calls *ncalls,
Davide Libenzi5071f972009-03-31 15:24:10 -0700474 int (*nproc)(void *, void *, int), void *priv,
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700475 void *cookie, void *ctx)
Davide Libenzi5071f972009-03-31 15:24:10 -0700476{
477 int error, call_nests = 0;
478 unsigned long flags;
Davide Libenzi5071f972009-03-31 15:24:10 -0700479 struct list_head *lsthead = &ncalls->tasks_call_list;
480 struct nested_call_node *tncur;
481 struct nested_call_node tnode;
482
483 spin_lock_irqsave(&ncalls->lock, flags);
484
485 /*
486 * Try to see if the current task is already inside this wakeup call.
487 * We use a list here, since the population inside this set is always
488 * very much limited.
489 */
490 list_for_each_entry(tncur, lsthead, llink) {
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700491 if (tncur->ctx == ctx &&
Davidlohr Bueso74bdc122019-01-03 15:27:02 -0800492 (tncur->cookie == cookie || ++call_nests > EP_MAX_NESTS)) {
Davide Libenzi5071f972009-03-31 15:24:10 -0700493 /*
494 * Ops ... loop detected or maximum nest level reached.
495 * We abort this wake by breaking the cycle itself.
496 */
Tony Battersbyabff55c2009-03-31 15:24:13 -0700497 error = -1;
498 goto out_unlock;
Davide Libenzi5071f972009-03-31 15:24:10 -0700499 }
500 }
501
502 /* Add the current task and cookie to the list */
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700503 tnode.ctx = ctx;
Davide Libenzi5071f972009-03-31 15:24:10 -0700504 tnode.cookie = cookie;
505 list_add(&tnode.llink, lsthead);
506
507 spin_unlock_irqrestore(&ncalls->lock, flags);
508
509 /* Call the nested function */
510 error = (*nproc)(priv, cookie, call_nests);
511
512 /* Remove the current task from the list */
513 spin_lock_irqsave(&ncalls->lock, flags);
514 list_del(&tnode.llink);
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700515out_unlock:
Davide Libenzi5071f972009-03-31 15:24:10 -0700516 spin_unlock_irqrestore(&ncalls->lock, flags);
517
518 return error;
519}
520
Steven Rostedt02edc6f2012-03-23 15:02:27 -0700521/*
522 * As described in commit 0ccf831cb lockdep: annotate epoll
523 * the use of wait queues used by epoll is done in a very controlled
524 * manner. Wake ups can nest inside each other, but are never done
525 * with the same locking. For example:
526 *
527 * dfd = socket(...);
528 * efd1 = epoll_create();
529 * efd2 = epoll_create();
530 * epoll_ctl(efd1, EPOLL_CTL_ADD, dfd, ...);
531 * epoll_ctl(efd2, EPOLL_CTL_ADD, efd1, ...);
532 *
533 * When a packet arrives to the device underneath "dfd", the net code will
534 * issue a wake_up() on its poll wake list. Epoll (efd1) has installed a
535 * callback wakeup entry on that queue, and the wake_up() performed by the
536 * "dfd" net code will end up in ep_poll_callback(). At this point epoll
537 * (efd1) notices that it may have some event ready, so it needs to wake up
538 * the waiters on its poll wait list (efd2). So it calls ep_poll_safewake()
539 * that ends up in another wake_up(), after having checked about the
540 * recursion constraints. That are, no more than EP_MAX_POLLWAKE_NESTS, to
541 * avoid stack blasting.
542 *
543 * When CONFIG_DEBUG_LOCK_ALLOC is enabled, make sure lockdep can handle
544 * this special case of epoll.
545 */
Davide Libenzi2dfa4ee2009-03-31 15:24:22 -0700546#ifdef CONFIG_DEBUG_LOCK_ALLOC
Davide Libenzi2dfa4ee2009-03-31 15:24:22 -0700547
Jason Baronf6520c52019-12-04 16:52:12 -0800548static DEFINE_PER_CPU(int, wakeup_nest);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549
Davide Libenzi5071f972009-03-31 15:24:10 -0700550static void ep_poll_safewake(wait_queue_head_t *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551{
Jason Baronf6520c52019-12-04 16:52:12 -0800552 unsigned long flags;
553 int subclass;
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700554
Jason Baronf6520c52019-12-04 16:52:12 -0800555 local_irq_save(flags);
556 preempt_disable();
557 subclass = __this_cpu_read(wakeup_nest);
558 spin_lock_nested(&wq->lock, subclass + 1);
559 __this_cpu_inc(wakeup_nest);
560 wake_up_locked_poll(wq, POLLIN);
561 __this_cpu_dec(wakeup_nest);
562 spin_unlock(&wq->lock);
563 local_irq_restore(flags);
564 preempt_enable();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565}
566
Jason Baron57a173b2017-11-17 15:29:02 -0800567#else
568
569static void ep_poll_safewake(wait_queue_head_t *wq)
570{
Linus Torvaldsa9a08842018-02-11 14:34:03 -0800571 wake_up_poll(wq, EPOLLIN);
Jason Baron57a173b2017-11-17 15:29:02 -0800572}
573
574#endif
575
Oleg Nesterov971316f2012-02-24 20:07:29 +0100576static void ep_remove_wait_queue(struct eppoll_entry *pwq)
577{
578 wait_queue_head_t *whead;
579
580 rcu_read_lock();
Oleg Nesterov138e4ad2017-09-01 18:55:33 +0200581 /*
582 * If it is cleared by POLLFREE, it should be rcu-safe.
583 * If we read NULL we need a barrier paired with
584 * smp_store_release() in ep_poll_callback(), otherwise
585 * we rely on whead->lock.
586 */
587 whead = smp_load_acquire(&pwq->whead);
Oleg Nesterov971316f2012-02-24 20:07:29 +0100588 if (whead)
589 remove_wait_queue(whead, &pwq->wait);
590 rcu_read_unlock();
591}
592
Davide Libenzi7699acd2007-05-10 22:23:23 -0700593/*
Tony Battersbyd1bc90d2009-03-31 15:24:15 -0700594 * This function unregisters poll callbacks from the associated file
595 * descriptor. Must be called with "mtx" held (or "epmutex" if called from
596 * ep_free).
Davide Libenzi7699acd2007-05-10 22:23:23 -0700597 */
598static void ep_unregister_pollwait(struct eventpoll *ep, struct epitem *epi)
599{
Davide Libenzi7699acd2007-05-10 22:23:23 -0700600 struct list_head *lsthead = &epi->pwqlist;
601 struct eppoll_entry *pwq;
602
Tony Battersbyd1bc90d2009-03-31 15:24:15 -0700603 while (!list_empty(lsthead)) {
604 pwq = list_first_entry(lsthead, struct eppoll_entry, llink);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700605
Tony Battersbyd1bc90d2009-03-31 15:24:15 -0700606 list_del(&pwq->llink);
Oleg Nesterov971316f2012-02-24 20:07:29 +0100607 ep_remove_wait_queue(pwq);
Tony Battersbyd1bc90d2009-03-31 15:24:15 -0700608 kmem_cache_free(pwq_cache, pwq);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700609 }
610}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611
Eric Wongeea1d582013-04-30 15:27:39 -0700612/* call only when ep->mtx is held */
613static inline struct wakeup_source *ep_wakeup_source(struct epitem *epi)
614{
615 return rcu_dereference_check(epi->ws, lockdep_is_held(&epi->ep->mtx));
616}
617
618/* call only when ep->mtx is held */
619static inline void ep_pm_stay_awake(struct epitem *epi)
620{
621 struct wakeup_source *ws = ep_wakeup_source(epi);
622
623 if (ws)
624 __pm_stay_awake(ws);
625}
626
627static inline bool ep_has_wakeup_source(struct epitem *epi)
628{
629 return rcu_access_pointer(epi->ws) ? true : false;
630}
631
632/* call when ep->mtx cannot be held (ep_poll_callback) */
633static inline void ep_pm_stay_awake_rcu(struct epitem *epi)
634{
635 struct wakeup_source *ws;
636
637 rcu_read_lock();
638 ws = rcu_dereference(epi->ws);
639 if (ws)
640 __pm_stay_awake(ws);
641 rcu_read_unlock();
642}
643
Davide Libenzi5071f972009-03-31 15:24:10 -0700644/**
645 * ep_scan_ready_list - Scans the ready list in a way that makes possible for
646 * the scan code, to call f_op->poll(). Also allows for
647 * O(NumReady) performance.
648 *
649 * @ep: Pointer to the epoll private data structure.
650 * @sproc: Pointer to the scan callback.
651 * @priv: Private opaque data passed to the @sproc callback.
Nelson Elhaged8805e62011-10-31 17:13:14 -0700652 * @depth: The current depth of recursive f_op->poll calls.
Jason Baron67347fe2013-11-12 15:10:18 -0800653 * @ep_locked: caller already holds ep->mtx
Davide Libenzi5071f972009-03-31 15:24:10 -0700654 *
655 * Returns: The same integer error code returned by the @sproc callback.
656 */
Al Virod85e2aa2018-02-01 15:24:58 -0500657static __poll_t ep_scan_ready_list(struct eventpoll *ep,
658 __poll_t (*sproc)(struct eventpoll *,
Davide Libenzi5071f972009-03-31 15:24:10 -0700659 struct list_head *, void *),
Jason Baron67347fe2013-11-12 15:10:18 -0800660 void *priv, int depth, bool ep_locked)
Davide Libenzi5071f972009-03-31 15:24:10 -0700661{
Al Virod85e2aa2018-02-01 15:24:58 -0500662 __poll_t res;
Davide Libenzi5071f972009-03-31 15:24:10 -0700663 struct epitem *epi, *nepi;
Davide Libenzi296e2362009-03-31 15:24:11 -0700664 LIST_HEAD(txlist);
Davide Libenzi5071f972009-03-31 15:24:10 -0700665
Davidlohr Bueso92e64172018-08-21 21:56:45 -0700666 lockdep_assert_irqs_enabled();
667
Davide Libenzi5071f972009-03-31 15:24:10 -0700668 /*
669 * We need to lock this because we could be hit by
Tony Battersbye057e152009-03-31 15:24:15 -0700670 * eventpoll_release_file() and epoll_ctl().
Davide Libenzi5071f972009-03-31 15:24:10 -0700671 */
Jason Baron67347fe2013-11-12 15:10:18 -0800672
673 if (!ep_locked)
674 mutex_lock_nested(&ep->mtx, depth);
Davide Libenzi5071f972009-03-31 15:24:10 -0700675
676 /*
677 * Steal the ready list, and re-init the original one to the
678 * empty list. Also, set ep->ovflist to NULL so that events
679 * happening while looping w/out locks, are not lost. We cannot
680 * have the poll callback to queue directly on ep->rdllist,
681 * because we want the "sproc" callback to be able to do it
682 * in a lockless way.
683 */
Roman Penyaeva218cc42019-03-07 16:28:53 -0800684 write_lock_irq(&ep->lock);
Davide Libenzi296e2362009-03-31 15:24:11 -0700685 list_splice_init(&ep->rdllist, &txlist);
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -0800686 WRITE_ONCE(ep->ovflist, NULL);
Roman Penyaeva218cc42019-03-07 16:28:53 -0800687 write_unlock_irq(&ep->lock);
Davide Libenzi5071f972009-03-31 15:24:10 -0700688
689 /*
690 * Now call the callback function.
691 */
Al Virod85e2aa2018-02-01 15:24:58 -0500692 res = (*sproc)(ep, &txlist, priv);
Davide Libenzi5071f972009-03-31 15:24:10 -0700693
Roman Penyaeva218cc42019-03-07 16:28:53 -0800694 write_lock_irq(&ep->lock);
Davide Libenzi5071f972009-03-31 15:24:10 -0700695 /*
696 * During the time we spent inside the "sproc" callback, some
697 * other events might have been queued by the poll callback.
698 * We re-insert them inside the main ready-list here.
699 */
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -0800700 for (nepi = READ_ONCE(ep->ovflist); (epi = nepi) != NULL;
Davide Libenzi5071f972009-03-31 15:24:10 -0700701 nepi = epi->next, epi->next = EP_UNACTIVE_PTR) {
702 /*
703 * We need to check if the item is already in the list.
704 * During the "sproc" callback execution time, items are
705 * queued into ->ovflist but the "txlist" might already
706 * contain them, and the list_splice() below takes care of them.
707 */
Davidlohr Bueso992991c2018-08-21 21:58:26 -0700708 if (!ep_is_linked(epi)) {
Roman Penyaevc1411752019-03-07 16:28:46 -0800709 /*
710 * ->ovflist is LIFO, so we have to reverse it in order
711 * to keep in FIFO.
712 */
713 list_add(&epi->rdllink, &ep->rdllist);
Eric Wongeea1d582013-04-30 15:27:39 -0700714 ep_pm_stay_awake(epi);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200715 }
Davide Libenzi5071f972009-03-31 15:24:10 -0700716 }
717 /*
718 * We need to set back ep->ovflist to EP_UNACTIVE_PTR, so that after
719 * releasing the lock, events will be queued in the normal way inside
720 * ep->rdllist.
721 */
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -0800722 WRITE_ONCE(ep->ovflist, EP_UNACTIVE_PTR);
Davide Libenzi5071f972009-03-31 15:24:10 -0700723
724 /*
725 * Quickly re-inject items left on "txlist".
726 */
727 list_splice(&txlist, &ep->rdllist);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200728 __pm_relax(ep->ws);
Roman Penyaeva218cc42019-03-07 16:28:53 -0800729 write_unlock_irq(&ep->lock);
Davide Libenzi5071f972009-03-31 15:24:10 -0700730
Jason Baron67347fe2013-11-12 15:10:18 -0800731 if (!ep_locked)
732 mutex_unlock(&ep->mtx);
Davide Libenzi5071f972009-03-31 15:24:10 -0700733
Al Virod85e2aa2018-02-01 15:24:58 -0500734 return res;
Davide Libenzi5071f972009-03-31 15:24:10 -0700735}
736
Jason Baronae10b2b2013-11-12 15:10:16 -0800737static void epi_rcu_free(struct rcu_head *head)
738{
739 struct epitem *epi = container_of(head, struct epitem, rcu);
740 kmem_cache_free(epi_cache, epi);
741}
742
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743/*
Davide Libenzi7699acd2007-05-10 22:23:23 -0700744 * Removes a "struct epitem" from the eventpoll RB tree and deallocates
Davide Libenzic7ea7632007-05-15 01:40:47 -0700745 * all the associated resources. Must be called with "mtx" held.
Davide Libenzi7699acd2007-05-10 22:23:23 -0700746 */
747static int ep_remove(struct eventpoll *ep, struct epitem *epi)
748{
Davide Libenzi7699acd2007-05-10 22:23:23 -0700749 struct file *file = epi->ffd.file;
750
Davidlohr Bueso92e64172018-08-21 21:56:45 -0700751 lockdep_assert_irqs_enabled();
752
Davide Libenzi7699acd2007-05-10 22:23:23 -0700753 /*
Christoph Hellwigee8ef0a2018-08-21 21:56:26 -0700754 * Removes poll wait queue hooks.
Davide Libenzi7699acd2007-05-10 22:23:23 -0700755 */
756 ep_unregister_pollwait(ep, epi);
757
758 /* Remove the current item from the list of epoll hooks */
Jonathan Corbet68499912009-02-06 13:52:43 -0700759 spin_lock(&file->f_lock);
Jason Baronae10b2b2013-11-12 15:10:16 -0800760 list_del_rcu(&epi->fllink);
Jonathan Corbet68499912009-02-06 13:52:43 -0700761 spin_unlock(&file->f_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700763 rb_erase_cached(&epi->rbn, &ep->rbr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764
Roman Penyaeva218cc42019-03-07 16:28:53 -0800765 write_lock_irq(&ep->lock);
Davidlohr Bueso992991c2018-08-21 21:58:26 -0700766 if (ep_is_linked(epi))
Davide Libenzic7ea7632007-05-15 01:40:47 -0700767 list_del_init(&epi->rdllink);
Roman Penyaeva218cc42019-03-07 16:28:53 -0800768 write_unlock_irq(&ep->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769
Eric Wongeea1d582013-04-30 15:27:39 -0700770 wakeup_source_unregister(ep_wakeup_source(epi));
Jason Baronae10b2b2013-11-12 15:10:16 -0800771 /*
772 * At this point it is safe to free the eventpoll item. Use the union
773 * field epi->rcu, since we are trying to minimize the size of
774 * 'struct epitem'. The 'rbn' field is no longer in use. Protected by
775 * ep->mtx. The rcu read side, reverse_path_check_proc(), does not make
776 * use of the rbn field.
777 */
778 call_rcu(&epi->rcu, epi_rcu_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779
Robin Holt52bd19f72011-01-12 17:00:01 -0800780 atomic_long_dec(&ep->user->epoll_watches);
Davide Libenzi7ef99642008-12-01 13:13:55 -0800781
Davide Libenzic7ea7632007-05-15 01:40:47 -0700782 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783}
784
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785static void ep_free(struct eventpoll *ep)
786{
787 struct rb_node *rbp;
788 struct epitem *epi;
789
790 /* We need to release all tasks waiting for these file */
791 if (waitqueue_active(&ep->poll_wait))
Davide Libenzi5071f972009-03-31 15:24:10 -0700792 ep_poll_safewake(&ep->poll_wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793
794 /*
795 * We need to lock this because we could be hit by
796 * eventpoll_release_file() while we're freeing the "struct eventpoll".
Davide Libenzid47de162007-05-15 01:40:41 -0700797 * We do not need to hold "ep->mtx" here because the epoll file
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798 * is on the way to be removed and no one has references to it
799 * anymore. The only hit might come from eventpoll_release_file() but
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300800 * holding "epmutex" is sufficient here.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801 */
Arjan van de Ven144efe32006-03-23 03:00:32 -0800802 mutex_lock(&epmutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803
804 /*
805 * Walks through the whole tree by unregistering poll callbacks.
806 */
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700807 for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808 epi = rb_entry(rbp, struct epitem, rbn);
809
810 ep_unregister_pollwait(ep, epi);
Eric Dumazet91cf5ab2013-09-11 14:24:06 -0700811 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812 }
813
814 /*
Davide Libenzi6192bd52007-05-08 00:25:41 -0700815 * Walks through the whole tree by freeing each "struct epitem". At this
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816 * point we are sure no poll callbacks will be lingering around, and also by
Davide Libenzid47de162007-05-15 01:40:41 -0700817 * holding "epmutex" we can be sure that no file cleanup code will hit
Roman Penyaeva218cc42019-03-07 16:28:53 -0800818 * us during this operation. So we can avoid the lock on "ep->lock".
Eric Wongddf676c2013-04-30 15:27:40 -0700819 * We do not need to lock ep->mtx, either, we only do it to prevent
820 * a lockdep warning.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821 */
Eric Wongddf676c2013-04-30 15:27:40 -0700822 mutex_lock(&ep->mtx);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700823 while ((rbp = rb_first_cached(&ep->rbr)) != NULL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824 epi = rb_entry(rbp, struct epitem, rbn);
825 ep_remove(ep, epi);
Eric Dumazet91cf5ab2013-09-11 14:24:06 -0700826 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827 }
Eric Wongddf676c2013-04-30 15:27:40 -0700828 mutex_unlock(&ep->mtx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829
Arjan van de Ven144efe32006-03-23 03:00:32 -0800830 mutex_unlock(&epmutex);
Davide Libenzid47de162007-05-15 01:40:41 -0700831 mutex_destroy(&ep->mtx);
Davide Libenzi7ef99642008-12-01 13:13:55 -0800832 free_uid(ep->user);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200833 wakeup_source_unregister(ep->ws);
Davide Libenzif0ee9aa2007-05-15 01:40:57 -0700834 kfree(ep);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835}
836
Davide Libenzi7699acd2007-05-10 22:23:23 -0700837static int ep_eventpoll_release(struct inode *inode, struct file *file)
838{
839 struct eventpoll *ep = file->private_data;
840
Davide Libenzif0ee9aa2007-05-15 01:40:57 -0700841 if (ep)
Davide Libenzi7699acd2007-05-10 22:23:23 -0700842 ep_free(ep);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700843
Davide Libenzi7699acd2007-05-10 22:23:23 -0700844 return 0;
845}
846
Al Virod85e2aa2018-02-01 15:24:58 -0500847static __poll_t ep_read_events_proc(struct eventpoll *ep, struct list_head *head,
Jason Baron37b5e522017-11-17 15:29:06 -0800848 void *priv);
849static void ep_ptable_queue_proc(struct file *file, wait_queue_head_t *whead,
850 poll_table *pt);
Eric Wong450d89e2013-04-30 15:27:42 -0700851
Jason Baron37b5e522017-11-17 15:29:06 -0800852/*
853 * Differs from ep_eventpoll_poll() in that internal callers already have
854 * the ep->mtx so we need to start from depth=1, such that mutex_lock_nested()
855 * is correctly annotated.
856 */
Al Virod85e2aa2018-02-01 15:24:58 -0500857static __poll_t ep_item_poll(const struct epitem *epi, poll_table *pt,
Al Virobec1a5022017-11-28 19:43:33 -0500858 int depth)
Jason Baron37b5e522017-11-17 15:29:06 -0800859{
860 struct eventpoll *ep;
861 bool locked;
862
863 pt->_key = epi->event.events;
864 if (!is_file_epoll(epi->ffd.file))
Christoph Hellwig9965ed172018-03-05 07:26:05 -0800865 return vfs_poll(epi->ffd.file, pt) & epi->event.events;
Jason Baron37b5e522017-11-17 15:29:06 -0800866
867 ep = epi->ffd.file->private_data;
868 poll_wait(epi->ffd.file, &ep->poll_wait, pt);
869 locked = pt && (pt->_qproc == ep_ptable_queue_proc);
870
871 return ep_scan_ready_list(epi->ffd.file->private_data,
872 ep_read_events_proc, &depth, depth,
873 locked) & epi->event.events;
Eric Wong450d89e2013-04-30 15:27:42 -0700874}
875
Al Virod85e2aa2018-02-01 15:24:58 -0500876static __poll_t ep_read_events_proc(struct eventpoll *ep, struct list_head *head,
Davide Libenzi296e2362009-03-31 15:24:11 -0700877 void *priv)
Davide Libenzi5071f972009-03-31 15:24:10 -0700878{
879 struct epitem *epi, *tmp;
Hans Verkuil626cf232012-03-23 15:02:27 -0700880 poll_table pt;
Jason Baron37b5e522017-11-17 15:29:06 -0800881 int depth = *(int *)priv;
Davide Libenzi5071f972009-03-31 15:24:10 -0700882
Hans Verkuil626cf232012-03-23 15:02:27 -0700883 init_poll_funcptr(&pt, NULL);
Jason Baron37b5e522017-11-17 15:29:06 -0800884 depth++;
Eric Wong450d89e2013-04-30 15:27:42 -0700885
Davide Libenzi5071f972009-03-31 15:24:10 -0700886 list_for_each_entry_safe(epi, tmp, head, rdllink) {
Jason Baron37b5e522017-11-17 15:29:06 -0800887 if (ep_item_poll(epi, &pt, depth)) {
Linus Torvaldsa9a08842018-02-11 14:34:03 -0800888 return EPOLLIN | EPOLLRDNORM;
Jason Baron37b5e522017-11-17 15:29:06 -0800889 } else {
Davide Libenzi5071f972009-03-31 15:24:10 -0700890 /*
891 * Item has been dropped into the ready list by the poll
892 * callback, but it's not actually ready, as far as
893 * caller requested events goes. We can remove it here.
894 */
Eric Wongeea1d582013-04-30 15:27:39 -0700895 __pm_relax(ep_wakeup_source(epi));
Davide Libenzi5071f972009-03-31 15:24:10 -0700896 list_del_init(&epi->rdllink);
Davide Libenzi296e2362009-03-31 15:24:11 -0700897 }
Davide Libenzi5071f972009-03-31 15:24:10 -0700898 }
899
900 return 0;
901}
902
Linus Torvaldsa11e1d42018-06-28 09:43:44 -0700903static __poll_t ep_eventpoll_poll(struct file *file, poll_table *wait)
Davide Libenzi7699acd2007-05-10 22:23:23 -0700904{
Davide Libenzi7699acd2007-05-10 22:23:23 -0700905 struct eventpoll *ep = file->private_data;
Jason Baron37b5e522017-11-17 15:29:06 -0800906 int depth = 0;
Davide Libenzi7699acd2007-05-10 22:23:23 -0700907
Linus Torvaldsa11e1d42018-06-28 09:43:44 -0700908 /* Insert inside our poll wait queue */
909 poll_wait(file, &ep->poll_wait, wait);
910
Davide Libenzi5071f972009-03-31 15:24:10 -0700911 /*
912 * Proceed to find out if wanted events are really available inside
Jason Baron37b5e522017-11-17 15:29:06 -0800913 * the ready list.
Davide Libenzi5071f972009-03-31 15:24:10 -0700914 */
Jason Baron37b5e522017-11-17 15:29:06 -0800915 return ep_scan_ready_list(ep, ep_read_events_proc,
916 &depth, depth, false);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700917}
918
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800919#ifdef CONFIG_PROC_FS
Joe Perchesa3816ab2014-09-29 16:08:25 -0700920static void ep_show_fdinfo(struct seq_file *m, struct file *f)
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800921{
922 struct eventpoll *ep = f->private_data;
923 struct rb_node *rbp;
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800924
925 mutex_lock(&ep->mtx);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700926 for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) {
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800927 struct epitem *epi = rb_entry(rbp, struct epitem, rbn);
Cyrill Gorcunov77493f02017-07-12 14:34:25 -0700928 struct inode *inode = file_inode(epi->ffd.file);
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800929
Cyrill Gorcunov77493f02017-07-12 14:34:25 -0700930 seq_printf(m, "tfd: %8d events: %8x data: %16llx "
931 " pos:%lli ino:%lx sdev:%x\n",
Joe Perchesa3816ab2014-09-29 16:08:25 -0700932 epi->ffd.fd, epi->event.events,
Cyrill Gorcunov77493f02017-07-12 14:34:25 -0700933 (long long)epi->event.data,
934 (long long)epi->ffd.file->f_pos,
935 inode->i_ino, inode->i_sb->s_dev);
Joe Perchesa3816ab2014-09-29 16:08:25 -0700936 if (seq_has_overflowed(m))
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800937 break;
938 }
939 mutex_unlock(&ep->mtx);
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800940}
941#endif
942
Davide Libenzi7699acd2007-05-10 22:23:23 -0700943/* File callbacks that implement the eventpoll file behaviour */
944static const struct file_operations eventpoll_fops = {
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800945#ifdef CONFIG_PROC_FS
946 .show_fdinfo = ep_show_fdinfo,
947#endif
Davide Libenzi7699acd2007-05-10 22:23:23 -0700948 .release = ep_eventpoll_release,
Linus Torvaldsa11e1d42018-06-28 09:43:44 -0700949 .poll = ep_eventpoll_poll,
Arnd Bergmann6038f372010-08-15 18:52:59 +0200950 .llseek = noop_llseek,
Davide Libenzi7699acd2007-05-10 22:23:23 -0700951};
952
Davide Libenzi7699acd2007-05-10 22:23:23 -0700953/*
954 * This is called from eventpoll_release() to unlink files from the eventpoll
955 * interface. We need to have this facility to cleanup correctly files that are
956 * closed without being removed from the eventpoll interface.
957 */
958void eventpoll_release_file(struct file *file)
959{
Davide Libenzi7699acd2007-05-10 22:23:23 -0700960 struct eventpoll *ep;
Konstantin Khlebnikovebe06182014-06-17 06:58:05 +0400961 struct epitem *epi, *next;
Davide Libenzi7699acd2007-05-10 22:23:23 -0700962
963 /*
Jonathan Corbet68499912009-02-06 13:52:43 -0700964 * We don't want to get "file->f_lock" because it is not
Davide Libenzi7699acd2007-05-10 22:23:23 -0700965 * necessary. It is not necessary because we're in the "struct file"
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300966 * cleanup path, and this means that no one is using this file anymore.
Davide Libenzi5071f972009-03-31 15:24:10 -0700967 * So, for example, epoll_ctl() cannot hit here since if we reach this
Davide Libenzi67647d02007-05-15 01:40:52 -0700968 * point, the file counter already went to zero and fget() would fail.
Davide Libenzid47de162007-05-15 01:40:41 -0700969 * The only hit might come from ep_free() but by holding the mutex
Davide Libenzi7699acd2007-05-10 22:23:23 -0700970 * will correctly serialize the operation. We do need to acquire
Davide Libenzid47de162007-05-15 01:40:41 -0700971 * "ep->mtx" after "epmutex" because ep_remove() requires it when called
Davide Libenzi7699acd2007-05-10 22:23:23 -0700972 * from anywhere but ep_free().
Jonathan Corbet68499912009-02-06 13:52:43 -0700973 *
974 * Besides, ep_remove() acquires the lock, so we can't hold it here.
Davide Libenzi7699acd2007-05-10 22:23:23 -0700975 */
976 mutex_lock(&epmutex);
Konstantin Khlebnikovebe06182014-06-17 06:58:05 +0400977 list_for_each_entry_safe(epi, next, &file->f_ep_links, fllink) {
Davide Libenzi7699acd2007-05-10 22:23:23 -0700978 ep = epi->ep;
Nelson Elhaged8805e62011-10-31 17:13:14 -0700979 mutex_lock_nested(&ep->mtx, 0);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700980 ep_remove(ep, epi);
Davide Libenzid47de162007-05-15 01:40:41 -0700981 mutex_unlock(&ep->mtx);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700982 }
Davide Libenzi7699acd2007-05-10 22:23:23 -0700983 mutex_unlock(&epmutex);
984}
985
986static int ep_alloc(struct eventpoll **pep)
987{
Davide Libenzi7ef99642008-12-01 13:13:55 -0800988 int error;
989 struct user_struct *user;
990 struct eventpoll *ep;
Davide Libenzi7699acd2007-05-10 22:23:23 -0700991
Davide Libenzi7ef99642008-12-01 13:13:55 -0800992 user = get_current_user();
Davide Libenzi7ef99642008-12-01 13:13:55 -0800993 error = -ENOMEM;
994 ep = kzalloc(sizeof(*ep), GFP_KERNEL);
995 if (unlikely(!ep))
996 goto free_uid;
Davide Libenzi7699acd2007-05-10 22:23:23 -0700997
Davide Libenzid47de162007-05-15 01:40:41 -0700998 mutex_init(&ep->mtx);
Roman Penyaeva218cc42019-03-07 16:28:53 -0800999 rwlock_init(&ep->lock);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001000 init_waitqueue_head(&ep->wq);
1001 init_waitqueue_head(&ep->poll_wait);
1002 INIT_LIST_HEAD(&ep->rdllist);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001003 ep->rbr = RB_ROOT_CACHED;
Davide Libenzid47de162007-05-15 01:40:41 -07001004 ep->ovflist = EP_UNACTIVE_PTR;
Davide Libenzi7ef99642008-12-01 13:13:55 -08001005 ep->user = user;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001006
1007 *pep = ep;
1008
Davide Libenzi7699acd2007-05-10 22:23:23 -07001009 return 0;
Davide Libenzi7ef99642008-12-01 13:13:55 -08001010
1011free_uid:
1012 free_uid(user);
1013 return error;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001014}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015
1016/*
Davide Libenzic7ea7632007-05-15 01:40:47 -07001017 * Search the file inside the eventpoll tree. The RB tree operations
1018 * are protected by the "mtx" mutex, and ep_find() must be called with
1019 * "mtx" held.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020 */
1021static struct epitem *ep_find(struct eventpoll *ep, struct file *file, int fd)
1022{
1023 int kcmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024 struct rb_node *rbp;
1025 struct epitem *epi, *epir = NULL;
1026 struct epoll_filefd ffd;
1027
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001028 ep_set_ffd(&ffd, file, fd);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001029 for (rbp = ep->rbr.rb_root.rb_node; rbp; ) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001030 epi = rb_entry(rbp, struct epitem, rbn);
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001031 kcmp = ep_cmp_ffd(&ffd, &epi->ffd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001032 if (kcmp > 0)
1033 rbp = rbp->rb_right;
1034 else if (kcmp < 0)
1035 rbp = rbp->rb_left;
1036 else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037 epir = epi;
1038 break;
1039 }
1040 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001041
Linus Torvalds1da177e2005-04-16 15:20:36 -07001042 return epir;
1043}
1044
Cyrill Gorcunov92ef6da2017-07-12 14:34:31 -07001045#ifdef CONFIG_CHECKPOINT_RESTORE
Cyrill Gorcunov0791e362017-07-12 14:34:28 -07001046static struct epitem *ep_find_tfd(struct eventpoll *ep, int tfd, unsigned long toff)
1047{
1048 struct rb_node *rbp;
1049 struct epitem *epi;
1050
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001051 for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) {
Cyrill Gorcunov0791e362017-07-12 14:34:28 -07001052 epi = rb_entry(rbp, struct epitem, rbn);
1053 if (epi->ffd.fd == tfd) {
1054 if (toff == 0)
1055 return epi;
1056 else
1057 toff--;
1058 }
1059 cond_resched();
1060 }
1061
1062 return NULL;
1063}
1064
1065struct file *get_epoll_tfile_raw_ptr(struct file *file, int tfd,
1066 unsigned long toff)
1067{
1068 struct file *file_raw;
1069 struct eventpoll *ep;
1070 struct epitem *epi;
1071
1072 if (!is_file_epoll(file))
1073 return ERR_PTR(-EINVAL);
1074
1075 ep = file->private_data;
1076
1077 mutex_lock(&ep->mtx);
1078 epi = ep_find_tfd(ep, tfd, toff);
1079 if (epi)
1080 file_raw = epi->ffd.file;
1081 else
1082 file_raw = ERR_PTR(-ENOENT);
1083 mutex_unlock(&ep->mtx);
1084
1085 return file_raw;
1086}
Cyrill Gorcunov92ef6da2017-07-12 14:34:31 -07001087#endif /* CONFIG_CHECKPOINT_RESTORE */
Cyrill Gorcunov0791e362017-07-12 14:34:28 -07001088
Roman Penyaeva218cc42019-03-07 16:28:53 -08001089/**
1090 * Adds a new entry to the tail of the list in a lockless way, i.e.
1091 * multiple CPUs are allowed to call this function concurrently.
1092 *
1093 * Beware: it is necessary to prevent any other modifications of the
1094 * existing list until all changes are completed, in other words
1095 * concurrent list_add_tail_lockless() calls should be protected
1096 * with a read lock, where write lock acts as a barrier which
1097 * makes sure all list_add_tail_lockless() calls are fully
1098 * completed.
1099 *
1100 * Also an element can be locklessly added to the list only in one
1101 * direction i.e. either to the tail either to the head, otherwise
1102 * concurrent access will corrupt the list.
1103 *
1104 * Returns %false if element has been already added to the list, %true
1105 * otherwise.
1106 */
1107static inline bool list_add_tail_lockless(struct list_head *new,
1108 struct list_head *head)
1109{
1110 struct list_head *prev;
1111
1112 /*
1113 * This is simple 'new->next = head' operation, but cmpxchg()
1114 * is used in order to detect that same element has been just
1115 * added to the list from another CPU: the winner observes
1116 * new->next == new.
1117 */
1118 if (cmpxchg(&new->next, new, head) != new)
1119 return false;
1120
1121 /*
1122 * Initially ->next of a new element must be updated with the head
1123 * (we are inserting to the tail) and only then pointers are atomically
1124 * exchanged. XCHG guarantees memory ordering, thus ->next should be
1125 * updated before pointers are actually swapped and pointers are
1126 * swapped before prev->next is updated.
1127 */
1128
1129 prev = xchg(&head->prev, new);
1130
1131 /*
1132 * It is safe to modify prev->next and new->prev, because a new element
1133 * is added only to the tail and new->next is updated before XCHG.
1134 */
1135
1136 prev->next = new;
1137 new->prev = prev;
1138
1139 return true;
1140}
1141
1142/**
1143 * Chains a new epi entry to the tail of the ep->ovflist in a lockless way,
1144 * i.e. multiple CPUs are allowed to call this function concurrently.
1145 *
1146 * Returns %false if epi element has been already chained, %true otherwise.
1147 */
1148static inline bool chain_epi_lockless(struct epitem *epi)
1149{
1150 struct eventpoll *ep = epi->ep;
1151
1152 /* Check that the same epi has not been just chained from another CPU */
1153 if (cmpxchg(&epi->next, EP_UNACTIVE_PTR, NULL) != EP_UNACTIVE_PTR)
1154 return false;
1155
1156 /* Atomically exchange tail */
1157 epi->next = xchg(&ep->ovflist, epi);
1158
1159 return true;
1160}
1161
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162/*
Davide Libenzi7699acd2007-05-10 22:23:23 -07001163 * This is the callback that is passed to the wait queue wakeup
Daniel Balutabf6a41d2011-01-30 23:42:29 +02001164 * mechanism. It is called by the stored file descriptors when they
Davide Libenzi7699acd2007-05-10 22:23:23 -07001165 * have events to report.
Roman Penyaeva218cc42019-03-07 16:28:53 -08001166 *
1167 * This callback takes a read lock in order not to content with concurrent
1168 * events from another file descriptors, thus all modifications to ->rdllist
1169 * or ->ovflist are lockless. Read lock is paired with the write lock from
1170 * ep_scan_ready_list(), which stops all list modifications and guarantees
1171 * that lists state is seen correctly.
1172 *
1173 * Another thing worth to mention is that ep_poll_callback() can be called
1174 * concurrently for the same @epi from different CPUs if poll table was inited
1175 * with several wait queues entries. Plural wakeup from different CPUs of a
1176 * single wait queue is serialized by wq.lock, but the case when multiple wait
1177 * queues are used should be detected accordingly. This is detected using
1178 * cmpxchg() operation.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001179 */
Ingo Molnarac6424b2017-06-20 12:06:13 +02001180static int ep_poll_callback(wait_queue_entry_t *wait, unsigned mode, int sync, void *key)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001181{
Davide Libenzi7699acd2007-05-10 22:23:23 -07001182 int pwake = 0;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001183 struct epitem *epi = ep_item_from_wait(wait);
1184 struct eventpoll *ep = epi->ep;
Al Viro3ad6f932017-07-03 20:14:56 -04001185 __poll_t pollflags = key_to_poll(key);
Roman Penyaeva218cc42019-03-07 16:28:53 -08001186 unsigned long flags;
Jason Barondf0108c2016-01-20 14:59:24 -08001187 int ewake = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001188
Roman Penyaeva218cc42019-03-07 16:28:53 -08001189 read_lock_irqsave(&ep->lock, flags);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001190
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -07001191 ep_set_busy_poll_napi_id(epi);
1192
Davide Libenzi7699acd2007-05-10 22:23:23 -07001193 /*
1194 * If the event mask does not contain any poll(2) event, we consider the
1195 * descriptor to be disabled. This condition is likely the effect of the
1196 * EPOLLONESHOT bit that disables the descriptor when an event is received,
1197 * until the next EPOLL_CTL_MOD will be issued.
1198 */
1199 if (!(epi->event.events & ~EP_PRIVATE_BITS))
Davide Libenzid47de162007-05-15 01:40:41 -07001200 goto out_unlock;
1201
1202 /*
Davide Libenzi2dfa4ee2009-03-31 15:24:22 -07001203 * Check the events coming with the callback. At this stage, not
1204 * every device reports the events in the "key" parameter of the
1205 * callback. We need to be able to handle both cases here, hence the
1206 * test for "key" != NULL before the event match test.
1207 */
Al Viro3ad6f932017-07-03 20:14:56 -04001208 if (pollflags && !(pollflags & epi->event.events))
Davide Libenzi2dfa4ee2009-03-31 15:24:22 -07001209 goto out_unlock;
1210
1211 /*
Daniel Balutabf6a41d2011-01-30 23:42:29 +02001212 * If we are transferring events to userspace, we can hold no locks
Davide Libenzid47de162007-05-15 01:40:41 -07001213 * (because we're accessing user memory, and because of linux f_op->poll()
Daniel Balutabf6a41d2011-01-30 23:42:29 +02001214 * semantics). All the events that happen during that period of time are
Davide Libenzid47de162007-05-15 01:40:41 -07001215 * chained in ep->ovflist and requeued later on.
1216 */
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001217 if (READ_ONCE(ep->ovflist) != EP_UNACTIVE_PTR) {
Roman Penyaeva218cc42019-03-07 16:28:53 -08001218 if (epi->next == EP_UNACTIVE_PTR &&
1219 chain_epi_lockless(epi))
Roman Penyaevc3e320b2019-03-07 16:28:49 -08001220 ep_pm_stay_awake_rcu(epi);
Davide Libenzid47de162007-05-15 01:40:41 -07001221 goto out_unlock;
1222 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07001223
1224 /* If this file is already in the ready list we exit soon */
Roman Penyaeva218cc42019-03-07 16:28:53 -08001225 if (!ep_is_linked(epi) &&
1226 list_add_tail_lockless(&epi->rdllink, &ep->rdllist)) {
Eric Wongeea1d582013-04-30 15:27:39 -07001227 ep_pm_stay_awake_rcu(epi);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001228 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07001229
Davide Libenzi7699acd2007-05-10 22:23:23 -07001230 /*
1231 * Wake up ( if active ) both the eventpoll wait list and the ->poll()
1232 * wait list.
1233 */
Jason Barondf0108c2016-01-20 14:59:24 -08001234 if (waitqueue_active(&ep->wq)) {
Jason Baronb6a515c2016-02-05 15:37:04 -08001235 if ((epi->event.events & EPOLLEXCLUSIVE) &&
Al Viro3ad6f932017-07-03 20:14:56 -04001236 !(pollflags & POLLFREE)) {
1237 switch (pollflags & EPOLLINOUT_BITS) {
Linus Torvaldsa9a08842018-02-11 14:34:03 -08001238 case EPOLLIN:
1239 if (epi->event.events & EPOLLIN)
Jason Baronb6a515c2016-02-05 15:37:04 -08001240 ewake = 1;
1241 break;
Linus Torvaldsa9a08842018-02-11 14:34:03 -08001242 case EPOLLOUT:
1243 if (epi->event.events & EPOLLOUT)
Jason Baronb6a515c2016-02-05 15:37:04 -08001244 ewake = 1;
1245 break;
1246 case 0:
1247 ewake = 1;
1248 break;
1249 }
1250 }
Roman Penyaeva218cc42019-03-07 16:28:53 -08001251 wake_up(&ep->wq);
Jason Barondf0108c2016-01-20 14:59:24 -08001252 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07001253 if (waitqueue_active(&ep->poll_wait))
1254 pwake++;
1255
Davide Libenzid47de162007-05-15 01:40:41 -07001256out_unlock:
Roman Penyaeva218cc42019-03-07 16:28:53 -08001257 read_unlock_irqrestore(&ep->lock, flags);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001258
1259 /* We have to call this outside the lock */
1260 if (pwake)
Davide Libenzi5071f972009-03-31 15:24:10 -07001261 ep_poll_safewake(&ep->poll_wait);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001262
Oleg Nesterov138e4ad2017-09-01 18:55:33 +02001263 if (!(epi->event.events & EPOLLEXCLUSIVE))
1264 ewake = 1;
Jason Barondf0108c2016-01-20 14:59:24 -08001265
Al Viro3ad6f932017-07-03 20:14:56 -04001266 if (pollflags & POLLFREE) {
Oleg Nesterov138e4ad2017-09-01 18:55:33 +02001267 /*
1268 * If we race with ep_remove_wait_queue() it can miss
1269 * ->whead = NULL and do another remove_wait_queue() after
1270 * us, so we can't use __remove_wait_queue().
1271 */
1272 list_del_init(&wait->entry);
1273 /*
1274 * ->whead != NULL protects us from the race with ep_free()
1275 * or ep_remove(), ep_remove_wait_queue() takes whead->lock
1276 * held by the caller. Once we nullify it, nothing protects
1277 * ep/epi or even wait.
1278 */
1279 smp_store_release(&ep_pwq_from_wait(wait)->whead, NULL);
1280 }
1281
1282 return ewake;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001283}
1284
Linus Torvalds1da177e2005-04-16 15:20:36 -07001285/*
1286 * This is the callback that is used to add our wait queue to the
1287 * target file wakeup lists.
1288 */
1289static void ep_ptable_queue_proc(struct file *file, wait_queue_head_t *whead,
1290 poll_table *pt)
1291{
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001292 struct epitem *epi = ep_item_from_epqueue(pt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001293 struct eppoll_entry *pwq;
1294
Christoph Lametere94b1762006-12-06 20:33:17 -08001295 if (epi->nwait >= 0 && (pwq = kmem_cache_alloc(pwq_cache, GFP_KERNEL))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001296 init_waitqueue_func_entry(&pwq->wait, ep_poll_callback);
1297 pwq->whead = whead;
1298 pwq->base = epi;
Jason Barondf0108c2016-01-20 14:59:24 -08001299 if (epi->event.events & EPOLLEXCLUSIVE)
1300 add_wait_queue_exclusive(whead, &pwq->wait);
1301 else
1302 add_wait_queue(whead, &pwq->wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001303 list_add_tail(&pwq->llink, &epi->pwqlist);
1304 epi->nwait++;
Davide Libenzi296e2362009-03-31 15:24:11 -07001305 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001306 /* We have to signal that an error occurred */
1307 epi->nwait = -1;
Davide Libenzi296e2362009-03-31 15:24:11 -07001308 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001309}
1310
Linus Torvalds1da177e2005-04-16 15:20:36 -07001311static void ep_rbtree_insert(struct eventpoll *ep, struct epitem *epi)
1312{
1313 int kcmp;
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001314 struct rb_node **p = &ep->rbr.rb_root.rb_node, *parent = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001315 struct epitem *epic;
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001316 bool leftmost = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317
1318 while (*p) {
1319 parent = *p;
1320 epic = rb_entry(parent, struct epitem, rbn);
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001321 kcmp = ep_cmp_ffd(&epi->ffd, &epic->ffd);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001322 if (kcmp > 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323 p = &parent->rb_right;
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001324 leftmost = false;
1325 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326 p = &parent->rb_left;
1327 }
1328 rb_link_node(&epi->rbn, parent, p);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001329 rb_insert_color_cached(&epi->rbn, &ep->rbr, leftmost);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330}
1331
Andrew Mortona80a6b82012-11-08 15:53:35 -08001332
1333
Jason Baron28d82dc2012-01-12 17:17:43 -08001334#define PATH_ARR_SIZE 5
1335/*
1336 * These are the number paths of length 1 to 5, that we are allowing to emanate
1337 * from a single file of interest. For example, we allow 1000 paths of length
1338 * 1, to emanate from each file of interest. This essentially represents the
1339 * potential wakeup paths, which need to be limited in order to avoid massive
1340 * uncontrolled wakeup storms. The common use case should be a single ep which
1341 * is connected to n file sources. In this case each file source has 1 path
1342 * of length 1. Thus, the numbers below should be more than sufficient. These
1343 * path limits are enforced during an EPOLL_CTL_ADD operation, since a modify
1344 * and delete can't add additional paths. Protected by the epmutex.
1345 */
1346static const int path_limits[PATH_ARR_SIZE] = { 1000, 500, 100, 50, 10 };
1347static int path_count[PATH_ARR_SIZE];
1348
1349static int path_count_inc(int nests)
1350{
Jason Baron93dc6102012-03-16 16:34:03 -04001351 /* Allow an arbitrary number of depth 1 paths */
1352 if (nests == 0)
1353 return 0;
1354
Jason Baron28d82dc2012-01-12 17:17:43 -08001355 if (++path_count[nests] > path_limits[nests])
1356 return -1;
1357 return 0;
1358}
1359
1360static void path_count_init(void)
1361{
1362 int i;
1363
1364 for (i = 0; i < PATH_ARR_SIZE; i++)
1365 path_count[i] = 0;
1366}
1367
1368static int reverse_path_check_proc(void *priv, void *cookie, int call_nests)
1369{
1370 int error = 0;
1371 struct file *file = priv;
1372 struct file *child_file;
1373 struct epitem *epi;
1374
Jason Baronae10b2b2013-11-12 15:10:16 -08001375 /* CTL_DEL can remove links here, but that can't increase our count */
1376 rcu_read_lock();
1377 list_for_each_entry_rcu(epi, &file->f_ep_links, fllink) {
Jason Baron28d82dc2012-01-12 17:17:43 -08001378 child_file = epi->ep->file;
1379 if (is_file_epoll(child_file)) {
1380 if (list_empty(&child_file->f_ep_links)) {
1381 if (path_count_inc(call_nests)) {
1382 error = -1;
1383 break;
1384 }
1385 } else {
1386 error = ep_call_nested(&poll_loop_ncalls,
Jason Baron28d82dc2012-01-12 17:17:43 -08001387 reverse_path_check_proc,
1388 child_file, child_file,
1389 current);
1390 }
1391 if (error != 0)
1392 break;
1393 } else {
1394 printk(KERN_ERR "reverse_path_check_proc: "
1395 "file is not an ep!\n");
1396 }
1397 }
Jason Baronae10b2b2013-11-12 15:10:16 -08001398 rcu_read_unlock();
Jason Baron28d82dc2012-01-12 17:17:43 -08001399 return error;
1400}
1401
1402/**
1403 * reverse_path_check - The tfile_check_list is list of file *, which have
1404 * links that are proposed to be newly added. We need to
1405 * make sure that those added links don't add too many
1406 * paths such that we will spend all our time waking up
1407 * eventpoll objects.
1408 *
1409 * Returns: Returns zero if the proposed links don't create too many paths,
1410 * -1 otherwise.
1411 */
1412static int reverse_path_check(void)
1413{
Jason Baron28d82dc2012-01-12 17:17:43 -08001414 int error = 0;
1415 struct file *current_file;
1416
1417 /* let's call this for all tfiles */
1418 list_for_each_entry(current_file, &tfile_check_list, f_tfile_llink) {
Jason Baron28d82dc2012-01-12 17:17:43 -08001419 path_count_init();
Davidlohr Bueso74bdc122019-01-03 15:27:02 -08001420 error = ep_call_nested(&poll_loop_ncalls,
Jason Baron28d82dc2012-01-12 17:17:43 -08001421 reverse_path_check_proc, current_file,
1422 current_file, current);
1423 if (error)
1424 break;
1425 }
1426 return error;
1427}
1428
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001429static int ep_create_wakeup_source(struct epitem *epi)
1430{
1431 const char *name;
Eric Wongeea1d582013-04-30 15:27:39 -07001432 struct wakeup_source *ws;
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001433
1434 if (!epi->ep->ws) {
Tri Voc8377ad2019-08-06 18:48:46 -07001435 epi->ep->ws = wakeup_source_register(NULL, "eventpoll");
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001436 if (!epi->ep->ws)
1437 return -ENOMEM;
1438 }
1439
1440 name = epi->ffd.file->f_path.dentry->d_name.name;
Tri Voc8377ad2019-08-06 18:48:46 -07001441 ws = wakeup_source_register(NULL, name);
Eric Wongeea1d582013-04-30 15:27:39 -07001442
1443 if (!ws)
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001444 return -ENOMEM;
Eric Wongeea1d582013-04-30 15:27:39 -07001445 rcu_assign_pointer(epi->ws, ws);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001446
1447 return 0;
1448}
1449
Eric Wongeea1d582013-04-30 15:27:39 -07001450/* rare code path, only used when EPOLL_CTL_MOD removes a wakeup source */
1451static noinline void ep_destroy_wakeup_source(struct epitem *epi)
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001452{
Eric Wongeea1d582013-04-30 15:27:39 -07001453 struct wakeup_source *ws = ep_wakeup_source(epi);
1454
Eric Wongd6d67e72013-04-30 15:27:43 -07001455 RCU_INIT_POINTER(epi->ws, NULL);
Eric Wongeea1d582013-04-30 15:27:39 -07001456
1457 /*
1458 * wait for ep_pm_stay_awake_rcu to finish, synchronize_rcu is
1459 * used internally by wakeup_source_remove, too (called by
1460 * wakeup_source_unregister), so we cannot use call_rcu
1461 */
1462 synchronize_rcu();
1463 wakeup_source_unregister(ws);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001464}
1465
Davide Libenzic7ea7632007-05-15 01:40:47 -07001466/*
1467 * Must be called with "mtx" held.
1468 */
Al Virobec1a5022017-11-28 19:43:33 -05001469static int ep_insert(struct eventpoll *ep, const struct epoll_event *event,
Jason Baron67347fe2013-11-12 15:10:18 -08001470 struct file *tfile, int fd, int full_check)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001471{
Al Virod85e2aa2018-02-01 15:24:58 -05001472 int error, pwake = 0;
1473 __poll_t revents;
Robin Holt52bd19f72011-01-12 17:00:01 -08001474 long user_watches;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001475 struct epitem *epi;
1476 struct ep_pqueue epq;
1477
Davidlohr Bueso92e64172018-08-21 21:56:45 -07001478 lockdep_assert_irqs_enabled();
1479
Robin Holt52bd19f72011-01-12 17:00:01 -08001480 user_watches = atomic_long_read(&ep->user->epoll_watches);
1481 if (unlikely(user_watches >= max_user_watches))
Davide Libenzi7ef99642008-12-01 13:13:55 -08001482 return -ENOSPC;
Christoph Lametere94b1762006-12-06 20:33:17 -08001483 if (!(epi = kmem_cache_alloc(epi_cache, GFP_KERNEL)))
Davide Libenzi7ef99642008-12-01 13:13:55 -08001484 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001485
1486 /* Item initialization follow here ... */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001487 INIT_LIST_HEAD(&epi->rdllink);
1488 INIT_LIST_HEAD(&epi->fllink);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001489 INIT_LIST_HEAD(&epi->pwqlist);
1490 epi->ep = ep;
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001491 ep_set_ffd(&epi->ffd, tfile, fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001492 epi->event = *event;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001493 epi->nwait = 0;
Davide Libenzid47de162007-05-15 01:40:41 -07001494 epi->next = EP_UNACTIVE_PTR;
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001495 if (epi->event.events & EPOLLWAKEUP) {
1496 error = ep_create_wakeup_source(epi);
1497 if (error)
1498 goto error_create_wakeup_source;
1499 } else {
Eric Wongeea1d582013-04-30 15:27:39 -07001500 RCU_INIT_POINTER(epi->ws, NULL);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001501 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001502
1503 /* Initialize the poll table using the queue callback */
1504 epq.epi = epi;
1505 init_poll_funcptr(&epq.pt, ep_ptable_queue_proc);
1506
1507 /*
1508 * Attach the item to the poll hooks and get current event bits.
1509 * We can safely use the file* here because its usage count has
Davide Libenzic7ea7632007-05-15 01:40:47 -07001510 * been increased by the caller of this function. Note that after
1511 * this operation completes, the poll callback can start hitting
1512 * the new item.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001513 */
Jason Baron37b5e522017-11-17 15:29:06 -08001514 revents = ep_item_poll(epi, &epq.pt, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001515
1516 /*
1517 * We have to check if something went wrong during the poll wait queue
1518 * install process. Namely an allocation for a wait queue failed due
1519 * high memory pressure.
1520 */
Davide Libenzi7ef99642008-12-01 13:13:55 -08001521 error = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001522 if (epi->nwait < 0)
Davide Libenzi7699acd2007-05-10 22:23:23 -07001523 goto error_unregister;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524
1525 /* Add the current item to the list of active epoll hook for this file */
Jonathan Corbet68499912009-02-06 13:52:43 -07001526 spin_lock(&tfile->f_lock);
Jason Baronae10b2b2013-11-12 15:10:16 -08001527 list_add_tail_rcu(&epi->fllink, &tfile->f_ep_links);
Jonathan Corbet68499912009-02-06 13:52:43 -07001528 spin_unlock(&tfile->f_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001529
Davide Libenzic7ea7632007-05-15 01:40:47 -07001530 /*
1531 * Add the current item to the RB tree. All RB tree operations are
1532 * protected by "mtx", and ep_insert() is called with "mtx" held.
1533 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001534 ep_rbtree_insert(ep, epi);
1535
Jason Baron28d82dc2012-01-12 17:17:43 -08001536 /* now check if we've created too many backpaths */
1537 error = -EINVAL;
Jason Baron67347fe2013-11-12 15:10:18 -08001538 if (full_check && reverse_path_check())
Jason Baron28d82dc2012-01-12 17:17:43 -08001539 goto error_remove_epi;
1540
Davide Libenzic7ea7632007-05-15 01:40:47 -07001541 /* We have to drop the new item inside our item list to keep track of it */
Roman Penyaeva218cc42019-03-07 16:28:53 -08001542 write_lock_irq(&ep->lock);
Davide Libenzic7ea7632007-05-15 01:40:47 -07001543
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -07001544 /* record NAPI ID of new item if present */
1545 ep_set_busy_poll_napi_id(epi);
1546
Linus Torvalds1da177e2005-04-16 15:20:36 -07001547 /* If the file is already "ready" we drop it inside the ready list */
Davidlohr Bueso992991c2018-08-21 21:58:26 -07001548 if (revents && !ep_is_linked(epi)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001549 list_add_tail(&epi->rdllink, &ep->rdllist);
Eric Wongeea1d582013-04-30 15:27:39 -07001550 ep_pm_stay_awake(epi);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001551
1552 /* Notify waiting tasks that events are available */
1553 if (waitqueue_active(&ep->wq))
Roman Penyaeva218cc42019-03-07 16:28:53 -08001554 wake_up(&ep->wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001555 if (waitqueue_active(&ep->poll_wait))
1556 pwake++;
1557 }
1558
Roman Penyaeva218cc42019-03-07 16:28:53 -08001559 write_unlock_irq(&ep->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560
Robin Holt52bd19f72011-01-12 17:00:01 -08001561 atomic_long_inc(&ep->user->epoll_watches);
Davide Libenzi7ef99642008-12-01 13:13:55 -08001562
Linus Torvalds1da177e2005-04-16 15:20:36 -07001563 /* We have to call this outside the lock */
1564 if (pwake)
Davide Libenzi5071f972009-03-31 15:24:10 -07001565 ep_poll_safewake(&ep->poll_wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001566
Linus Torvalds1da177e2005-04-16 15:20:36 -07001567 return 0;
1568
Jason Baron28d82dc2012-01-12 17:17:43 -08001569error_remove_epi:
1570 spin_lock(&tfile->f_lock);
Jason Baronae10b2b2013-11-12 15:10:16 -08001571 list_del_rcu(&epi->fllink);
Jason Baron28d82dc2012-01-12 17:17:43 -08001572 spin_unlock(&tfile->f_lock);
1573
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001574 rb_erase_cached(&epi->rbn, &ep->rbr);
Jason Baron28d82dc2012-01-12 17:17:43 -08001575
Davide Libenzi7699acd2007-05-10 22:23:23 -07001576error_unregister:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001577 ep_unregister_pollwait(ep, epi);
1578
1579 /*
1580 * We need to do this because an event could have been arrived on some
Davide Libenzi67647d02007-05-15 01:40:52 -07001581 * allocated wait queue. Note that we don't care about the ep->ovflist
1582 * list, since that is used/cleaned only inside a section bound by "mtx".
1583 * And ep_insert() is called with "mtx" held.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001584 */
Roman Penyaeva218cc42019-03-07 16:28:53 -08001585 write_lock_irq(&ep->lock);
Davidlohr Bueso992991c2018-08-21 21:58:26 -07001586 if (ep_is_linked(epi))
Davide Libenzi6192bd52007-05-08 00:25:41 -07001587 list_del_init(&epi->rdllink);
Roman Penyaeva218cc42019-03-07 16:28:53 -08001588 write_unlock_irq(&ep->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001589
Eric Wongeea1d582013-04-30 15:27:39 -07001590 wakeup_source_unregister(ep_wakeup_source(epi));
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001591
1592error_create_wakeup_source:
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001593 kmem_cache_free(epi_cache, epi);
Davide Libenzi7ef99642008-12-01 13:13:55 -08001594
Linus Torvalds1da177e2005-04-16 15:20:36 -07001595 return error;
1596}
1597
Linus Torvalds1da177e2005-04-16 15:20:36 -07001598/*
1599 * Modify the interest event mask by dropping an event if the new mask
Davide Libenzic7ea7632007-05-15 01:40:47 -07001600 * has a match in the current file status. Must be called with "mtx" held.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001601 */
Al Virobec1a5022017-11-28 19:43:33 -05001602static int ep_modify(struct eventpoll *ep, struct epitem *epi,
1603 const struct epoll_event *event)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001604{
1605 int pwake = 0;
Hans Verkuil626cf232012-03-23 15:02:27 -07001606 poll_table pt;
1607
Davidlohr Bueso92e64172018-08-21 21:56:45 -07001608 lockdep_assert_irqs_enabled();
1609
Hans Verkuil626cf232012-03-23 15:02:27 -07001610 init_poll_funcptr(&pt, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001611
1612 /*
Tony Battersbye057e152009-03-31 15:24:15 -07001613 * Set the new event interest mask before calling f_op->poll();
1614 * otherwise we might miss an event that happens between the
1615 * f_op->poll() call and the new event set registering.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001616 */
Eric Wong128dd172013-01-01 21:20:27 +00001617 epi->event.events = event->events; /* need barrier below */
Tony Battersbye057e152009-03-31 15:24:15 -07001618 epi->event.data = event->data; /* protected by mtx */
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001619 if (epi->event.events & EPOLLWAKEUP) {
Eric Wongeea1d582013-04-30 15:27:39 -07001620 if (!ep_has_wakeup_source(epi))
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001621 ep_create_wakeup_source(epi);
Eric Wongeea1d582013-04-30 15:27:39 -07001622 } else if (ep_has_wakeup_source(epi)) {
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001623 ep_destroy_wakeup_source(epi);
1624 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001625
1626 /*
Eric Wong128dd172013-01-01 21:20:27 +00001627 * The following barrier has two effects:
1628 *
1629 * 1) Flush epi changes above to other CPUs. This ensures
1630 * we do not miss events from ep_poll_callback if an
1631 * event occurs immediately after we call f_op->poll().
Roman Penyaeva218cc42019-03-07 16:28:53 -08001632 * We need this because we did not take ep->lock while
Eric Wong128dd172013-01-01 21:20:27 +00001633 * changing epi above (but ep_poll_callback does take
Roman Penyaeva218cc42019-03-07 16:28:53 -08001634 * ep->lock).
Eric Wong128dd172013-01-01 21:20:27 +00001635 *
1636 * 2) We also need to ensure we do not miss _past_ events
1637 * when calling f_op->poll(). This barrier also
1638 * pairs with the barrier in wq_has_sleeper (see
1639 * comments for wq_has_sleeper).
1640 *
1641 * This barrier will now guarantee ep_poll_callback or f_op->poll
1642 * (or both) will notice the readiness of an item.
1643 */
1644 smp_mb();
1645
1646 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001647 * Get current event bits. We can safely use the file* here because
1648 * its usage count has been increased by the caller of this function.
Davide Libenzic7ea7632007-05-15 01:40:47 -07001649 * If the item is "hot" and it is not registered inside the ready
Davide Libenzi67647d02007-05-15 01:40:52 -07001650 * list, push it inside.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001651 */
Al Viro69112732017-11-28 19:56:15 -05001652 if (ep_item_poll(epi, &pt, 1)) {
Roman Penyaeva218cc42019-03-07 16:28:53 -08001653 write_lock_irq(&ep->lock);
Davidlohr Bueso992991c2018-08-21 21:58:26 -07001654 if (!ep_is_linked(epi)) {
Davide Libenzic7ea7632007-05-15 01:40:47 -07001655 list_add_tail(&epi->rdllink, &ep->rdllist);
Eric Wongeea1d582013-04-30 15:27:39 -07001656 ep_pm_stay_awake(epi);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657
Davide Libenzic7ea7632007-05-15 01:40:47 -07001658 /* Notify waiting tasks that events are available */
1659 if (waitqueue_active(&ep->wq))
Roman Penyaeva218cc42019-03-07 16:28:53 -08001660 wake_up(&ep->wq);
Davide Libenzic7ea7632007-05-15 01:40:47 -07001661 if (waitqueue_active(&ep->poll_wait))
1662 pwake++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001663 }
Roman Penyaeva218cc42019-03-07 16:28:53 -08001664 write_unlock_irq(&ep->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001665 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001666
1667 /* We have to call this outside the lock */
1668 if (pwake)
Davide Libenzi5071f972009-03-31 15:24:10 -07001669 ep_poll_safewake(&ep->poll_wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001670
1671 return 0;
1672}
1673
Al Virod85e2aa2018-02-01 15:24:58 -05001674static __poll_t ep_send_events_proc(struct eventpoll *ep, struct list_head *head,
Davide Libenzi296e2362009-03-31 15:24:11 -07001675 void *priv)
Davide Libenzi5071f972009-03-31 15:24:10 -07001676{
1677 struct ep_send_events_data *esed = priv;
Al Virod85e2aa2018-02-01 15:24:58 -05001678 __poll_t revents;
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001679 struct epitem *epi, *tmp;
1680 struct epoll_event __user *uevent = esed->events;
Eric Wongeea1d582013-04-30 15:27:39 -07001681 struct wakeup_source *ws;
Hans Verkuil626cf232012-03-23 15:02:27 -07001682 poll_table pt;
1683
1684 init_poll_funcptr(&pt, NULL);
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001685 esed->res = 0;
Davide Libenzi5071f972009-03-31 15:24:10 -07001686
Davide Libenzi296e2362009-03-31 15:24:11 -07001687 /*
Davide Libenzi5071f972009-03-31 15:24:10 -07001688 * We can loop without lock because we are passed a task private list.
1689 * Items cannot vanish during the loop because ep_scan_ready_list() is
1690 * holding "mtx" during this call.
Davide Libenzi296e2362009-03-31 15:24:11 -07001691 */
Davidlohr Bueso21877e12019-01-03 15:27:12 -08001692 lockdep_assert_held(&ep->mtx);
1693
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001694 list_for_each_entry_safe(epi, tmp, head, rdllink) {
1695 if (esed->res >= esed->maxevents)
1696 break;
Davide Libenzi5071f972009-03-31 15:24:10 -07001697
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001698 /*
1699 * Activate ep->ws before deactivating epi->ws to prevent
1700 * triggering auto-suspend here (in case we reactive epi->ws
1701 * below).
1702 *
1703 * This could be rearranged to delay the deactivation of epi->ws
1704 * instead, but then epi->ws would temporarily be out of sync
1705 * with ep_is_linked().
1706 */
Eric Wongeea1d582013-04-30 15:27:39 -07001707 ws = ep_wakeup_source(epi);
1708 if (ws) {
1709 if (ws->active)
1710 __pm_stay_awake(ep->ws);
1711 __pm_relax(ws);
1712 }
1713
Davide Libenzi5071f972009-03-31 15:24:10 -07001714 list_del_init(&epi->rdllink);
1715
Davide Libenzi296e2362009-03-31 15:24:11 -07001716 /*
Davide Libenzi5071f972009-03-31 15:24:10 -07001717 * If the event mask intersect the caller-requested one,
1718 * deliver the event to userspace. Again, ep_scan_ready_list()
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001719 * is holding ep->mtx, so no operations coming from userspace
Davide Libenzi5071f972009-03-31 15:24:10 -07001720 * can change the item.
Davide Libenzi296e2362009-03-31 15:24:11 -07001721 */
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001722 revents = ep_item_poll(epi, &pt, 1);
1723 if (!revents)
1724 continue;
1725
1726 if (__put_user(revents, &uevent->events) ||
1727 __put_user(epi->event.data, &uevent->data)) {
1728 list_add(&epi->rdllink, head);
1729 ep_pm_stay_awake(epi);
1730 if (!esed->res)
1731 esed->res = -EFAULT;
1732 return 0;
1733 }
1734 esed->res++;
1735 uevent++;
1736 if (epi->event.events & EPOLLONESHOT)
1737 epi->event.events &= EP_PRIVATE_BITS;
1738 else if (!(epi->event.events & EPOLLET)) {
1739 /*
1740 * If this file has been added with Level
1741 * Trigger mode, we need to insert back inside
1742 * the ready list, so that the next call to
1743 * epoll_wait() will check again the events
1744 * availability. At this point, no one can insert
1745 * into ep->rdllist besides us. The epoll_ctl()
1746 * callers are locked out by
1747 * ep_scan_ready_list() holding "mtx" and the
1748 * poll callback will queue them in ep->ovflist.
1749 */
1750 list_add_tail(&epi->rdllink, &ep->rdllist);
1751 ep_pm_stay_awake(epi);
Davide Libenzi296e2362009-03-31 15:24:11 -07001752 }
1753 }
Davide Libenzi5071f972009-03-31 15:24:10 -07001754
Al Virod7ebbe42018-02-01 15:21:13 -05001755 return 0;
Davide Libenzi5071f972009-03-31 15:24:10 -07001756}
1757
Davide Libenzi296e2362009-03-31 15:24:11 -07001758static int ep_send_events(struct eventpoll *ep,
1759 struct epoll_event __user *events, int maxevents)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001760{
Davide Libenzi5071f972009-03-31 15:24:10 -07001761 struct ep_send_events_data esed;
Davide Libenzi6192bd52007-05-08 00:25:41 -07001762
Davide Libenzi5071f972009-03-31 15:24:10 -07001763 esed.maxevents = maxevents;
1764 esed.events = events;
Davide Libenzid47de162007-05-15 01:40:41 -07001765
Al Virod7ebbe42018-02-01 15:21:13 -05001766 ep_scan_ready_list(ep, ep_send_events_proc, &esed, 0, false);
1767 return esed.res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001768}
1769
Deepa Dinamani766b9f92016-05-19 17:09:05 -07001770static inline struct timespec64 ep_set_mstimeout(long ms)
Eric Dumazet0781b902011-02-01 15:52:35 -08001771{
Deepa Dinamani766b9f92016-05-19 17:09:05 -07001772 struct timespec64 now, ts = {
Eric Dumazet0781b902011-02-01 15:52:35 -08001773 .tv_sec = ms / MSEC_PER_SEC,
1774 .tv_nsec = NSEC_PER_MSEC * (ms % MSEC_PER_SEC),
1775 };
1776
Deepa Dinamani766b9f92016-05-19 17:09:05 -07001777 ktime_get_ts64(&now);
1778 return timespec64_add_safe(now, ts);
Eric Dumazet0781b902011-02-01 15:52:35 -08001779}
1780
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001781/**
1782 * ep_poll - Retrieves ready events, and delivers them to the caller supplied
1783 * event buffer.
1784 *
1785 * @ep: Pointer to the eventpoll context.
1786 * @events: Pointer to the userspace buffer where the ready events should be
1787 * stored.
1788 * @maxevents: Size (in terms of number of events) of the caller event buffer.
1789 * @timeout: Maximum timeout for the ready events fetch operation, in
1790 * milliseconds. If the @timeout is zero, the function will not block,
1791 * while if the @timeout is less than zero, the function will block
1792 * until at least one event has been retrieved (or an error
1793 * occurred).
1794 *
1795 * Returns: Returns the number of ready events which have been fetched, or an
1796 * error code, in case of error.
1797 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001798static int ep_poll(struct eventpoll *ep, struct epoll_event __user *events,
1799 int maxevents, long timeout)
1800{
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001801 int res = 0, eavail, timed_out = 0;
John Stultzda8b44d2016-03-17 14:20:51 -07001802 u64 slack = 0;
Davidlohr Bueso86c05172019-01-03 15:27:26 -08001803 bool waiter = false;
Ingo Molnarac6424b2017-06-20 12:06:13 +02001804 wait_queue_entry_t wait;
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001805 ktime_t expires, *to = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001806
Davidlohr Bueso679abf32018-08-21 21:58:23 -07001807 lockdep_assert_irqs_enabled();
1808
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001809 if (timeout > 0) {
Deepa Dinamani766b9f92016-05-19 17:09:05 -07001810 struct timespec64 end_time = ep_set_mstimeout(timeout);
Eric Dumazet0781b902011-02-01 15:52:35 -08001811
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001812 slack = select_estimate_accuracy(&end_time);
1813 to = &expires;
Deepa Dinamani766b9f92016-05-19 17:09:05 -07001814 *to = timespec64_to_ktime(end_time);
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001815 } else if (timeout == 0) {
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001816 /*
1817 * Avoid the unnecessary trip to the wait queue loop, if the
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001818 * caller specified a non blocking operation. We still need
1819 * lock because we could race and not see an epi being added
1820 * to the ready list while in irq callback. Thus incorrectly
1821 * returning 0 back to userspace.
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001822 */
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001823 timed_out = 1;
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001824
Roman Penyaeva218cc42019-03-07 16:28:53 -08001825 write_lock_irq(&ep->lock);
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001826 eavail = ep_events_available(ep);
Roman Penyaeva218cc42019-03-07 16:28:53 -08001827 write_unlock_irq(&ep->lock);
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001828
Davidlohr Bueso35cff1a2019-01-03 15:27:22 -08001829 goto send_events;
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001830 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001831
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001832fetch_events:
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -07001833
1834 if (!ep_events_available(ep))
1835 ep_busy_loop(ep, timed_out);
1836
Davide Libenzi3fb0e582011-03-22 16:34:46 -07001837 eavail = ep_events_available(ep);
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001838 if (eavail)
Davidlohr Bueso35cff1a2019-01-03 15:27:22 -08001839 goto send_events;
Jason Baron28d82dc2012-01-12 17:17:43 -08001840
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001841 /*
1842 * Busy poll timed out. Drop NAPI ID for now, we can add
1843 * it back in when we have moved a socket with a valid NAPI
1844 * ID onto the ready list.
1845 */
1846 ep_reset_busy_poll_napi_id(ep);
Jason Baron28d82dc2012-01-12 17:17:43 -08001847
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001848 /*
Davidlohr Bueso86c05172019-01-03 15:27:26 -08001849 * We don't have any available event to return to the caller. We need
1850 * to sleep here, and we will be woken by ep_poll_callback() when events
1851 * become available.
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001852 */
Davidlohr Bueso86c05172019-01-03 15:27:26 -08001853 if (!waiter) {
1854 waiter = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001855 init_waitqueue_entry(&wait, current);
Davidlohr Bueso86c05172019-01-03 15:27:26 -08001856
1857 spin_lock_irq(&ep->wq.lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001858 __add_wait_queue_exclusive(&ep->wq, &wait);
Davidlohr Bueso86c05172019-01-03 15:27:26 -08001859 spin_unlock_irq(&ep->wq.lock);
1860 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001861
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001862 for (;;) {
1863 /*
1864 * We don't want to sleep if the ep_poll_callback() sends us
1865 * a wakeup in between. That's why we set the task state
1866 * to TASK_INTERRUPTIBLE before doing the checks.
1867 */
1868 set_current_state(TASK_INTERRUPTIBLE);
1869 /*
1870 * Always short-circuit for fatal signals to allow
1871 * threads to make a timely exit without the chance of
1872 * finding more events available and fetching
1873 * repeatedly.
1874 */
1875 if (fatal_signal_pending(current)) {
1876 res = -EINTR;
1877 break;
Davide Libenzi5071f972009-03-31 15:24:10 -07001878 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001879
Davidlohr Buesoabc610e2019-01-03 15:27:19 -08001880 eavail = ep_events_available(ep);
1881 if (eavail)
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001882 break;
1883 if (signal_pending(current)) {
1884 res = -EINTR;
1885 break;
1886 }
1887
Davidlohr Buesoabc610e2019-01-03 15:27:19 -08001888 if (!schedule_hrtimeout_range(to, slack, HRTIMER_MODE_ABS)) {
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001889 timed_out = 1;
Davidlohr Buesoabc610e2019-01-03 15:27:19 -08001890 break;
1891 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001892 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001893
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001894 __set_current_state(TASK_RUNNING);
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001895
Davidlohr Bueso35cff1a2019-01-03 15:27:22 -08001896send_events:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001897 /*
1898 * Try to transfer events to user space. In case we get 0 events and
1899 * there's still timeout left over, we go trying again in search of
1900 * more luck.
1901 */
Davide Libenzi22bacca2011-02-25 14:44:12 -08001902 if (!res && eavail &&
1903 !(res = ep_send_events(ep, events, maxevents)) && !timed_out)
1904 goto fetch_events;
1905
Davidlohr Bueso86c05172019-01-03 15:27:26 -08001906 if (waiter) {
1907 spin_lock_irq(&ep->wq.lock);
1908 __remove_wait_queue(&ep->wq, &wait);
1909 spin_unlock_irq(&ep->wq.lock);
1910 }
1911
Linus Torvalds1da177e2005-04-16 15:20:36 -07001912 return res;
1913}
1914
1915/**
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001916 * ep_loop_check_proc - Callback function to be passed to the @ep_call_nested()
Linus Torvalds1da177e2005-04-16 15:20:36 -07001917 * API, to verify that adding an epoll file inside another
1918 * epoll structure, does not violate the constraints, in
1919 * terms of closed loops, or too deep chains (which can
1920 * result in excessive stack usage).
Davide Libenzi22bacca2011-02-25 14:44:12 -08001921 *
1922 * @priv: Pointer to the epoll file to be currently checked.
1923 * @cookie: Original cookie for this call. This is the top-of-the-chain epoll
1924 * data structure pointer.
1925 * @call_nests: Current dept of the @ep_call_nested() call stack.
1926 *
1927 * Returns: Returns zero if adding the epoll @file inside current epoll
1928 * structure @ep does not violate the constraints, or -1 otherwise.
1929 */
1930static int ep_loop_check_proc(void *priv, void *cookie, int call_nests)
1931{
1932 int error = 0;
1933 struct file *file = priv;
1934 struct eventpoll *ep = file->private_data;
1935 struct eventpoll *ep_tovisit;
1936 struct rb_node *rbp;
1937 struct epitem *epi;
1938
1939 mutex_lock_nested(&ep->mtx, call_nests + 1);
1940 ep->visited = 1;
1941 list_add(&ep->visited_list_link, &visited_list);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001942 for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) {
Davide Libenzi22bacca2011-02-25 14:44:12 -08001943 epi = rb_entry(rbp, struct epitem, rbn);
Nelson Elhaged8805e62011-10-31 17:13:14 -07001944 if (unlikely(is_file_epoll(epi->ffd.file))) {
Davide Libenzi22bacca2011-02-25 14:44:12 -08001945 ep_tovisit = epi->ffd.file->private_data;
1946 if (ep_tovisit->visited)
1947 continue;
Davidlohr Bueso74bdc122019-01-03 15:27:02 -08001948 error = ep_call_nested(&poll_loop_ncalls,
Davide Libenzi22bacca2011-02-25 14:44:12 -08001949 ep_loop_check_proc, epi->ffd.file,
1950 ep_tovisit, current);
1951 if (error != 0)
1952 break;
Jason Baron28d82dc2012-01-12 17:17:43 -08001953 } else {
1954 /*
1955 * If we've reached a file that is not associated with
1956 * an ep, then we need to check if the newly added
1957 * links are going to add too many wakeup paths. We do
1958 * this by adding it to the tfile_check_list, if it's
1959 * not already there, and calling reverse_path_check()
1960 * during ep_insert().
1961 */
1962 if (list_empty(&epi->ffd.file->f_tfile_llink))
1963 list_add(&epi->ffd.file->f_tfile_llink,
1964 &tfile_check_list);
Davide Libenzi22bacca2011-02-25 14:44:12 -08001965 }
1966 }
1967 mutex_unlock(&ep->mtx);
1968
1969 return error;
1970}
1971
1972/**
1973 * ep_loop_check - Performs a check to verify that adding an epoll file (@file)
1974 * another epoll file (represented by @ep) does not create
1975 * closed loops or too deep chains.
1976 *
1977 * @ep: Pointer to the epoll private data structure.
1978 * @file: Pointer to the epoll file to be checked.
1979 *
1980 * Returns: Returns zero if adding the epoll @file inside current epoll
1981 * structure @ep does not violate the constraints, or -1 otherwise.
1982 */
1983static int ep_loop_check(struct eventpoll *ep, struct file *file)
1984{
Jason Baron28d82dc2012-01-12 17:17:43 -08001985 int ret;
1986 struct eventpoll *ep_cur, *ep_next;
1987
Davidlohr Bueso74bdc122019-01-03 15:27:02 -08001988 ret = ep_call_nested(&poll_loop_ncalls,
Davide Libenzi22bacca2011-02-25 14:44:12 -08001989 ep_loop_check_proc, file, ep, current);
Jason Baron28d82dc2012-01-12 17:17:43 -08001990 /* clear visited list */
1991 list_for_each_entry_safe(ep_cur, ep_next, &visited_list,
1992 visited_list_link) {
1993 ep_cur->visited = 0;
1994 list_del(&ep_cur->visited_list_link);
1995 }
1996 return ret;
1997}
1998
1999static void clear_tfile_check_list(void)
2000{
2001 struct file *file;
2002
2003 /* first clear the tfile_check_list */
2004 while (!list_empty(&tfile_check_list)) {
2005 file = list_first_entry(&tfile_check_list, struct file,
2006 f_tfile_llink);
2007 list_del_init(&file->f_tfile_llink);
2008 }
2009 INIT_LIST_HEAD(&tfile_check_list);
Davide Libenzi22bacca2011-02-25 14:44:12 -08002010}
2011
Davide Libenzi7699acd2007-05-10 22:23:23 -07002012/*
Andrew Morton523723b2008-08-12 15:09:01 -07002013 * Open an eventpoll file descriptor.
Davide Libenzi7699acd2007-05-10 22:23:23 -07002014 */
Dominik Brodowski791eb222018-03-11 11:34:30 +01002015static int do_epoll_create(int flags)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002016{
Jason Baron28d82dc2012-01-12 17:17:43 -08002017 int error, fd;
Davide Libenzibb57c3e2009-03-31 15:24:12 -07002018 struct eventpoll *ep = NULL;
Jason Baron28d82dc2012-01-12 17:17:43 -08002019 struct file *file;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002020
Ulrich Dreppere38b36f2008-07-23 21:29:42 -07002021 /* Check the EPOLL_* constant for consistency. */
2022 BUILD_BUG_ON(EPOLL_CLOEXEC != O_CLOEXEC);
2023
Davide Libenzi296e2362009-03-31 15:24:11 -07002024 if (flags & ~EPOLL_CLOEXEC)
2025 return -EINVAL;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002026 /*
Davide Libenzibb57c3e2009-03-31 15:24:12 -07002027 * Create the internal data structure ("struct eventpoll").
Davide Libenzi7699acd2007-05-10 22:23:23 -07002028 */
Ulrich Drepper9fe5ad92008-07-23 21:29:43 -07002029 error = ep_alloc(&ep);
Davide Libenzibb57c3e2009-03-31 15:24:12 -07002030 if (error < 0)
2031 return error;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002032 /*
2033 * Creates all the items needed to setup an eventpoll file. That is,
Al Viro2030a422008-02-23 06:46:49 -05002034 * a file structure and a free file descriptor.
Davide Libenzi7699acd2007-05-10 22:23:23 -07002035 */
Jason Baron28d82dc2012-01-12 17:17:43 -08002036 fd = get_unused_fd_flags(O_RDWR | (flags & O_CLOEXEC));
2037 if (fd < 0) {
2038 error = fd;
2039 goto out_free_ep;
2040 }
2041 file = anon_inode_getfile("[eventpoll]", &eventpoll_fops, ep,
Roland Dreier628ff7c2009-12-18 09:41:24 -08002042 O_RDWR | (flags & O_CLOEXEC));
Jason Baron28d82dc2012-01-12 17:17:43 -08002043 if (IS_ERR(file)) {
2044 error = PTR_ERR(file);
2045 goto out_free_fd;
2046 }
Jason Baron28d82dc2012-01-12 17:17:43 -08002047 ep->file = file;
Al Viro98022742012-08-17 22:42:36 -04002048 fd_install(fd, file);
Jason Baron28d82dc2012-01-12 17:17:43 -08002049 return fd;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002050
Jason Baron28d82dc2012-01-12 17:17:43 -08002051out_free_fd:
2052 put_unused_fd(fd);
2053out_free_ep:
2054 ep_free(ep);
Davide Libenzibb57c3e2009-03-31 15:24:12 -07002055 return error;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002056}
2057
Dominik Brodowski791eb222018-03-11 11:34:30 +01002058SYSCALL_DEFINE1(epoll_create1, int, flags)
2059{
2060 return do_epoll_create(flags);
2061}
2062
Heiko Carstens5a8a82b2009-01-14 14:14:25 +01002063SYSCALL_DEFINE1(epoll_create, int, size)
Ulrich Dreppera0998b52008-07-23 21:29:27 -07002064{
Davide Libenzibfe3891a2009-05-12 13:19:44 -07002065 if (size <= 0)
Ulrich Drepper9fe5ad92008-07-23 21:29:43 -07002066 return -EINVAL;
2067
Dominik Brodowski791eb222018-03-11 11:34:30 +01002068 return do_epoll_create(0);
Ulrich Dreppera0998b52008-07-23 21:29:27 -07002069}
2070
Jens Axboe39220e82020-01-08 15:05:37 -07002071static inline int epoll_mutex_lock(struct mutex *mutex, int depth,
2072 bool nonblock)
2073{
2074 if (!nonblock) {
2075 mutex_lock_nested(mutex, depth);
2076 return 0;
2077 }
2078 if (mutex_trylock(mutex))
2079 return 0;
2080 return -EAGAIN;
2081}
2082
2083int do_epoll_ctl(int epfd, int op, int fd, struct epoll_event *epds,
2084 bool nonblock)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002085{
2086 int error;
Jason Baron67347fe2013-11-12 15:10:18 -08002087 int full_check = 0;
Al Viro7e3fb582013-08-30 12:47:21 -04002088 struct fd f, tf;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002089 struct eventpoll *ep;
2090 struct epitem *epi;
Jason Baron67347fe2013-11-12 15:10:18 -08002091 struct eventpoll *tep = NULL;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002092
Davide Libenzi7699acd2007-05-10 22:23:23 -07002093 error = -EBADF;
Al Viro7e3fb582013-08-30 12:47:21 -04002094 f = fdget(epfd);
2095 if (!f.file)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002096 goto error_return;
2097
2098 /* Get the "struct file *" for the target file */
Al Viro7e3fb582013-08-30 12:47:21 -04002099 tf = fdget(fd);
2100 if (!tf.file)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002101 goto error_fput;
2102
2103 /* The target file descriptor must support poll */
2104 error = -EPERM;
Christoph Hellwig9965ed172018-03-05 07:26:05 -08002105 if (!file_can_poll(tf.file))
Davide Libenzi7699acd2007-05-10 22:23:23 -07002106 goto error_tgt_fput;
2107
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02002108 /* Check if EPOLLWAKEUP is allowed */
Nicolas Ioossc680e412014-09-09 14:50:51 -07002109 if (ep_op_has_event(op))
Jens Axboe58e41a42020-01-08 14:35:13 -07002110 ep_take_care_of_epollwakeup(epds);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02002111
Davide Libenzi7699acd2007-05-10 22:23:23 -07002112 /*
2113 * We have to check that the file structure underneath the file descriptor
2114 * the user passed to us _is_ an eventpoll file. And also we do not permit
2115 * adding an epoll file descriptor inside itself.
2116 */
2117 error = -EINVAL;
Al Viro7e3fb582013-08-30 12:47:21 -04002118 if (f.file == tf.file || !is_file_epoll(f.file))
Davide Libenzi7699acd2007-05-10 22:23:23 -07002119 goto error_tgt_fput;
2120
2121 /*
Jason Barondf0108c2016-01-20 14:59:24 -08002122 * epoll adds to the wakeup queue at EPOLL_CTL_ADD time only,
2123 * so EPOLLEXCLUSIVE is not allowed for a EPOLL_CTL_MOD operation.
2124 * Also, we do not currently supported nested exclusive wakeups.
2125 */
Jens Axboe58e41a42020-01-08 14:35:13 -07002126 if (ep_op_has_event(op) && (epds->events & EPOLLEXCLUSIVE)) {
Jason Baronb6a515c2016-02-05 15:37:04 -08002127 if (op == EPOLL_CTL_MOD)
2128 goto error_tgt_fput;
2129 if (op == EPOLL_CTL_ADD && (is_file_epoll(tf.file) ||
Jens Axboe58e41a42020-01-08 14:35:13 -07002130 (epds->events & ~EPOLLEXCLUSIVE_OK_BITS)))
Jason Baronb6a515c2016-02-05 15:37:04 -08002131 goto error_tgt_fput;
2132 }
Jason Barondf0108c2016-01-20 14:59:24 -08002133
2134 /*
Davide Libenzi7699acd2007-05-10 22:23:23 -07002135 * At this point it is safe to assume that the "private_data" contains
2136 * our own data structure.
2137 */
Al Viro7e3fb582013-08-30 12:47:21 -04002138 ep = f.file->private_data;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002139
Davide Libenzi22bacca2011-02-25 14:44:12 -08002140 /*
2141 * When we insert an epoll file descriptor, inside another epoll file
2142 * descriptor, there is the change of creating closed loops, which are
Jason Baron28d82dc2012-01-12 17:17:43 -08002143 * better be handled here, than in more critical paths. While we are
2144 * checking for loops we also determine the list of files reachable
2145 * and hang them on the tfile_check_list, so we can check that we
2146 * haven't created too many possible wakeup paths.
Davide Libenzi22bacca2011-02-25 14:44:12 -08002147 *
Jason Baron67347fe2013-11-12 15:10:18 -08002148 * We do not need to take the global 'epumutex' on EPOLL_CTL_ADD when
2149 * the epoll file descriptor is attaching directly to a wakeup source,
2150 * unless the epoll file descriptor is nested. The purpose of taking the
2151 * 'epmutex' on add is to prevent complex toplogies such as loops and
2152 * deep wakeup paths from forming in parallel through multiple
2153 * EPOLL_CTL_ADD operations.
Davide Libenzi22bacca2011-02-25 14:44:12 -08002154 */
Jens Axboe39220e82020-01-08 15:05:37 -07002155 error = epoll_mutex_lock(&ep->mtx, 0, nonblock);
2156 if (error)
2157 goto error_tgt_fput;
Jason Baron67347fe2013-11-12 15:10:18 -08002158 if (op == EPOLL_CTL_ADD) {
2159 if (!list_empty(&f.file->f_ep_links) ||
2160 is_file_epoll(tf.file)) {
Jason Baron67347fe2013-11-12 15:10:18 -08002161 mutex_unlock(&ep->mtx);
Jens Axboe39220e82020-01-08 15:05:37 -07002162 error = epoll_mutex_lock(&epmutex, 0, nonblock);
2163 if (error)
2164 goto error_tgt_fput;
2165 full_check = 1;
Jason Baron67347fe2013-11-12 15:10:18 -08002166 if (is_file_epoll(tf.file)) {
2167 error = -ELOOP;
2168 if (ep_loop_check(ep, tf.file) != 0) {
2169 clear_tfile_check_list();
2170 goto error_tgt_fput;
2171 }
2172 } else
2173 list_add(&tf.file->f_tfile_llink,
2174 &tfile_check_list);
Jens Axboe39220e82020-01-08 15:05:37 -07002175 error = epoll_mutex_lock(&ep->mtx, 0, nonblock);
2176 if (error) {
2177out_del:
2178 list_del(&tf.file->f_tfile_llink);
2179 goto error_tgt_fput;
2180 }
Jason Baron67347fe2013-11-12 15:10:18 -08002181 if (is_file_epoll(tf.file)) {
2182 tep = tf.file->private_data;
Jens Axboe39220e82020-01-08 15:05:37 -07002183 error = epoll_mutex_lock(&tep->mtx, 1, nonblock);
2184 if (error) {
2185 mutex_unlock(&ep->mtx);
2186 goto out_del;
2187 }
Jason Baron67347fe2013-11-12 15:10:18 -08002188 }
2189 }
2190 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07002191
Davide Libenzi67647d02007-05-15 01:40:52 -07002192 /*
2193 * Try to lookup the file inside our RB tree, Since we grabbed "mtx"
2194 * above, we can be sure to be able to use the item looked up by
2195 * ep_find() till we release the mutex.
2196 */
Al Viro7e3fb582013-08-30 12:47:21 -04002197 epi = ep_find(ep, tf.file, fd);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002198
2199 error = -EINVAL;
2200 switch (op) {
2201 case EPOLL_CTL_ADD:
2202 if (!epi) {
Jens Axboe58e41a42020-01-08 14:35:13 -07002203 epds->events |= EPOLLERR | EPOLLHUP;
2204 error = ep_insert(ep, epds, tf.file, fd, full_check);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002205 } else
2206 error = -EEXIST;
Jason Baron67347fe2013-11-12 15:10:18 -08002207 if (full_check)
2208 clear_tfile_check_list();
Davide Libenzi7699acd2007-05-10 22:23:23 -07002209 break;
2210 case EPOLL_CTL_DEL:
2211 if (epi)
2212 error = ep_remove(ep, epi);
2213 else
2214 error = -ENOENT;
2215 break;
2216 case EPOLL_CTL_MOD:
2217 if (epi) {
Jason Baronb6a515c2016-02-05 15:37:04 -08002218 if (!(epi->event.events & EPOLLEXCLUSIVE)) {
Jens Axboe58e41a42020-01-08 14:35:13 -07002219 epds->events |= EPOLLERR | EPOLLHUP;
2220 error = ep_modify(ep, epi, epds);
Jason Baronb6a515c2016-02-05 15:37:04 -08002221 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07002222 } else
2223 error = -ENOENT;
2224 break;
2225 }
Jason Baron67347fe2013-11-12 15:10:18 -08002226 if (tep != NULL)
2227 mutex_unlock(&tep->mtx);
Davide Libenzid47de162007-05-15 01:40:41 -07002228 mutex_unlock(&ep->mtx);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002229
2230error_tgt_fput:
Jason Baron67347fe2013-11-12 15:10:18 -08002231 if (full_check)
Davide Libenzi22bacca2011-02-25 14:44:12 -08002232 mutex_unlock(&epmutex);
2233
Al Viro7e3fb582013-08-30 12:47:21 -04002234 fdput(tf);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002235error_fput:
Al Viro7e3fb582013-08-30 12:47:21 -04002236 fdput(f);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002237error_return:
Davide Libenzi7699acd2007-05-10 22:23:23 -07002238
2239 return error;
2240}
2241
2242/*
Jens Axboe58e41a42020-01-08 14:35:13 -07002243 * The following function implements the controller interface for
2244 * the eventpoll file that enables the insertion/removal/change of
2245 * file descriptors inside the interest set.
2246 */
2247SYSCALL_DEFINE4(epoll_ctl, int, epfd, int, op, int, fd,
2248 struct epoll_event __user *, event)
2249{
2250 struct epoll_event epds;
2251
2252 if (ep_op_has_event(op) &&
2253 copy_from_user(&epds, event, sizeof(struct epoll_event)))
2254 return -EFAULT;
2255
Jens Axboe39220e82020-01-08 15:05:37 -07002256 return do_epoll_ctl(epfd, op, fd, &epds, false);
Jens Axboe58e41a42020-01-08 14:35:13 -07002257}
2258
2259/*
Davide Libenzi7699acd2007-05-10 22:23:23 -07002260 * Implement the event wait interface for the eventpoll file. It is the kernel
2261 * part of the user space epoll_wait(2).
2262 */
Dominik Brodowski791eb222018-03-11 11:34:30 +01002263static int do_epoll_wait(int epfd, struct epoll_event __user *events,
2264 int maxevents, int timeout)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002265{
Al Viro2903ff02012-08-28 12:52:22 -04002266 int error;
2267 struct fd f;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002268 struct eventpoll *ep;
2269
Davide Libenzi7699acd2007-05-10 22:23:23 -07002270 /* The maximum number of event must be greater than zero */
2271 if (maxevents <= 0 || maxevents > EP_MAX_EVENTS)
2272 return -EINVAL;
2273
2274 /* Verify that the area passed by the user is writeable */
Linus Torvalds96d4f262019-01-03 18:57:57 -08002275 if (!access_ok(events, maxevents * sizeof(struct epoll_event)))
Al Viro2903ff02012-08-28 12:52:22 -04002276 return -EFAULT;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002277
2278 /* Get the "struct file *" for the eventpoll file */
Al Viro2903ff02012-08-28 12:52:22 -04002279 f = fdget(epfd);
2280 if (!f.file)
2281 return -EBADF;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002282
2283 /*
2284 * We have to check that the file structure underneath the fd
2285 * the user passed to us _is_ an eventpoll file.
2286 */
2287 error = -EINVAL;
Al Viro2903ff02012-08-28 12:52:22 -04002288 if (!is_file_epoll(f.file))
Davide Libenzi7699acd2007-05-10 22:23:23 -07002289 goto error_fput;
2290
2291 /*
2292 * At this point it is safe to assume that the "private_data" contains
2293 * our own data structure.
2294 */
Al Viro2903ff02012-08-28 12:52:22 -04002295 ep = f.file->private_data;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002296
2297 /* Time to fish for events ... */
2298 error = ep_poll(ep, events, maxevents, timeout);
2299
2300error_fput:
Al Viro2903ff02012-08-28 12:52:22 -04002301 fdput(f);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002302 return error;
2303}
2304
Dominik Brodowski791eb222018-03-11 11:34:30 +01002305SYSCALL_DEFINE4(epoll_wait, int, epfd, struct epoll_event __user *, events,
2306 int, maxevents, int, timeout)
2307{
2308 return do_epoll_wait(epfd, events, maxevents, timeout);
2309}
2310
Davide Libenzi7699acd2007-05-10 22:23:23 -07002311/*
2312 * Implement the event wait interface for the eventpoll file. It is the kernel
2313 * part of the user space epoll_pwait(2).
2314 */
Heiko Carstens5a8a82b2009-01-14 14:14:25 +01002315SYSCALL_DEFINE6(epoll_pwait, int, epfd, struct epoll_event __user *, events,
2316 int, maxevents, int, timeout, const sigset_t __user *, sigmask,
2317 size_t, sigsetsize)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002318{
2319 int error;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002320
2321 /*
2322 * If the caller wants a certain signal mask to be set during the wait,
2323 * we apply it here.
2324 */
Oleg Nesterovb7724342019-07-16 16:29:53 -07002325 error = set_user_sigmask(sigmask, sigsetsize);
Deepa Dinamanided653c2018-09-19 21:41:04 -07002326 if (error)
2327 return error;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002328
Dominik Brodowski791eb222018-03-11 11:34:30 +01002329 error = do_epoll_wait(epfd, events, maxevents, timeout);
Oleg Nesterovb7724342019-07-16 16:29:53 -07002330 restore_saved_sigmask_unless(error == -EINTR);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002331
2332 return error;
2333}
2334
Al Viro35280bd2013-02-24 14:52:17 -05002335#ifdef CONFIG_COMPAT
2336COMPAT_SYSCALL_DEFINE6(epoll_pwait, int, epfd,
2337 struct epoll_event __user *, events,
2338 int, maxevents, int, timeout,
2339 const compat_sigset_t __user *, sigmask,
2340 compat_size_t, sigsetsize)
2341{
2342 long err;
Al Viro35280bd2013-02-24 14:52:17 -05002343
2344 /*
2345 * If the caller wants a certain signal mask to be set during the wait,
2346 * we apply it here.
2347 */
Oleg Nesterovb7724342019-07-16 16:29:53 -07002348 err = set_compat_user_sigmask(sigmask, sigsetsize);
Deepa Dinamanided653c2018-09-19 21:41:04 -07002349 if (err)
2350 return err;
Al Viro35280bd2013-02-24 14:52:17 -05002351
Dominik Brodowski791eb222018-03-11 11:34:30 +01002352 err = do_epoll_wait(epfd, events, maxevents, timeout);
Oleg Nesterovb7724342019-07-16 16:29:53 -07002353 restore_saved_sigmask_unless(err == -EINTR);
Al Viro35280bd2013-02-24 14:52:17 -05002354
2355 return err;
2356}
2357#endif
2358
Linus Torvalds1da177e2005-04-16 15:20:36 -07002359static int __init eventpoll_init(void)
2360{
Davide Libenzi7ef99642008-12-01 13:13:55 -08002361 struct sysinfo si;
2362
2363 si_meminfo(&si);
Davide Libenzi9df04e12009-01-29 14:25:26 -08002364 /*
2365 * Allows top 4% of lomem to be allocated for epoll watches (per user).
2366 */
2367 max_user_watches = (((si.totalram - si.totalhigh) / 25) << PAGE_SHIFT) /
Davide Libenzi7ef99642008-12-01 13:13:55 -08002368 EP_ITEM_COST;
Robin Holt52bd19f72011-01-12 17:00:01 -08002369 BUG_ON(max_user_watches < 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002370
Davide Libenzi22bacca2011-02-25 14:44:12 -08002371 /*
2372 * Initialize the structure used to perform epoll file descriptor
2373 * inclusion loops checks.
2374 */
2375 ep_nested_calls_init(&poll_loop_ncalls);
2376
Eric Wong39732ca2013-04-30 15:27:38 -07002377 /*
2378 * We can have many thousands of epitems, so prevent this from
2379 * using an extra cache line on 64-bit (and smaller) CPUs
2380 */
2381 BUILD_BUG_ON(sizeof(void *) <= 8 && sizeof(struct epitem) > 128);
2382
Linus Torvalds1da177e2005-04-16 15:20:36 -07002383 /* Allocates slab cache used to allocate "struct epitem" items */
2384 epi_cache = kmem_cache_create("eventpoll_epi", sizeof(struct epitem),
Shakeel Butt2ae928a2017-11-17 15:28:59 -08002385 0, SLAB_HWCACHE_ALIGN|SLAB_PANIC|SLAB_ACCOUNT, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002386
2387 /* Allocates slab cache used to allocate "struct eppoll_entry" */
2388 pwq_cache = kmem_cache_create("eventpoll_pwq",
Shakeel Butt2ae928a2017-11-17 15:28:59 -08002389 sizeof(struct eppoll_entry), 0, SLAB_PANIC|SLAB_ACCOUNT, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002390
Linus Torvalds1da177e2005-04-16 15:20:36 -07002391 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002392}
Davide Libenzicea69242007-05-10 22:23:22 -07002393fs_initcall(eventpoll_init);