blob: ae1d32344f7ac688a87fd3d35db28435520e7263 [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
357/* Tells if the epoll_ctl(2) operation needs an event copy from userspace */
Davide Libenzi6192bd52007-05-08 00:25:41 -0700358static inline int ep_op_has_event(int op)
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700359{
Andrew Mortona80a6b82012-11-08 15:53:35 -0800360 return op != EPOLL_CTL_DEL;
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700361}
362
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363/* Initialize the poll safe wake up structure */
Davide Libenzi5071f972009-03-31 15:24:10 -0700364static void ep_nested_calls_init(struct nested_calls *ncalls)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365{
Davide Libenzi5071f972009-03-31 15:24:10 -0700366 INIT_LIST_HEAD(&ncalls->tasks_call_list);
367 spin_lock_init(&ncalls->lock);
368}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369
Davide Libenzi5071f972009-03-31 15:24:10 -0700370/**
Davide Libenzi3fb0e582011-03-22 16:34:46 -0700371 * ep_events_available - Checks if ready events might be available.
372 *
373 * @ep: Pointer to the eventpoll context.
374 *
375 * Returns: Returns a value different than zero if ready events are available,
376 * or zero otherwise.
377 */
378static inline int ep_events_available(struct eventpoll *ep)
379{
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -0800380 return !list_empty_careful(&ep->rdllist) ||
381 READ_ONCE(ep->ovflist) != EP_UNACTIVE_PTR;
Davide Libenzi3fb0e582011-03-22 16:34:46 -0700382}
383
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700384#ifdef CONFIG_NET_RX_BUSY_POLL
385static bool ep_busy_loop_end(void *p, unsigned long start_time)
386{
387 struct eventpoll *ep = p;
388
389 return ep_events_available(ep) || busy_loop_timeout(start_time);
390}
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700391
392/*
393 * Busy poll if globally on and supporting sockets found && no events,
394 * busy loop will return if need_resched or ep_events_available.
395 *
396 * we must do our busy polling with irqs enabled
397 */
398static void ep_busy_loop(struct eventpoll *ep, int nonblock)
399{
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700400 unsigned int napi_id = READ_ONCE(ep->napi_id);
401
402 if ((napi_id >= MIN_NAPI_ID) && net_busy_loop_on())
403 napi_busy_loop(napi_id, nonblock ? NULL : ep_busy_loop_end, ep);
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700404}
405
406static inline void ep_reset_busy_poll_napi_id(struct eventpoll *ep)
407{
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700408 if (ep->napi_id)
409 ep->napi_id = 0;
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700410}
411
412/*
413 * Set epoll busy poll NAPI ID from sk.
414 */
415static inline void ep_set_busy_poll_napi_id(struct epitem *epi)
416{
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700417 struct eventpoll *ep;
418 unsigned int napi_id;
419 struct socket *sock;
420 struct sock *sk;
421 int err;
422
423 if (!net_busy_loop_on())
424 return;
425
426 sock = sock_from_file(epi->ffd.file, &err);
427 if (!sock)
428 return;
429
430 sk = sock->sk;
431 if (!sk)
432 return;
433
434 napi_id = READ_ONCE(sk->sk_napi_id);
435 ep = epi->ep;
436
437 /* Non-NAPI IDs can be rejected
438 * or
439 * Nothing to do if we already have this ID
440 */
441 if (napi_id < MIN_NAPI_ID || napi_id == ep->napi_id)
442 return;
443
444 /* record NAPI ID for use in next busy poll */
445 ep->napi_id = napi_id;
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700446}
447
Davidlohr Bueso514056d2018-08-21 21:58:19 -0700448#else
449
450static inline void ep_busy_loop(struct eventpoll *ep, int nonblock)
451{
452}
453
454static inline void ep_reset_busy_poll_napi_id(struct eventpoll *ep)
455{
456}
457
458static inline void ep_set_busy_poll_napi_id(struct epitem *epi)
459{
460}
461
462#endif /* CONFIG_NET_RX_BUSY_POLL */
463
Davide Libenzi3fb0e582011-03-22 16:34:46 -0700464/**
Davide Libenzi5071f972009-03-31 15:24:10 -0700465 * ep_call_nested - Perform a bound (possibly) nested call, by checking
466 * that the recursion limit is not exceeded, and that
467 * the same nested call (by the meaning of same cookie) is
468 * no re-entered.
469 *
470 * @ncalls: Pointer to the nested_calls structure to be used for this call.
Davide Libenzi5071f972009-03-31 15:24:10 -0700471 * @nproc: Nested call core function pointer.
472 * @priv: Opaque data to be passed to the @nproc callback.
473 * @cookie: Cookie to be used to identify this nested call.
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700474 * @ctx: This instance context.
Davide Libenzi5071f972009-03-31 15:24:10 -0700475 *
476 * Returns: Returns the code returned by the @nproc callback, or -1 if
477 * the maximum recursion limit has been exceeded.
478 */
Davidlohr Bueso74bdc122019-01-03 15:27:02 -0800479static int ep_call_nested(struct nested_calls *ncalls,
Davide Libenzi5071f972009-03-31 15:24:10 -0700480 int (*nproc)(void *, void *, int), void *priv,
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700481 void *cookie, void *ctx)
Davide Libenzi5071f972009-03-31 15:24:10 -0700482{
483 int error, call_nests = 0;
484 unsigned long flags;
Davide Libenzi5071f972009-03-31 15:24:10 -0700485 struct list_head *lsthead = &ncalls->tasks_call_list;
486 struct nested_call_node *tncur;
487 struct nested_call_node tnode;
488
489 spin_lock_irqsave(&ncalls->lock, flags);
490
491 /*
492 * Try to see if the current task is already inside this wakeup call.
493 * We use a list here, since the population inside this set is always
494 * very much limited.
495 */
496 list_for_each_entry(tncur, lsthead, llink) {
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700497 if (tncur->ctx == ctx &&
Davidlohr Bueso74bdc122019-01-03 15:27:02 -0800498 (tncur->cookie == cookie || ++call_nests > EP_MAX_NESTS)) {
Davide Libenzi5071f972009-03-31 15:24:10 -0700499 /*
500 * Ops ... loop detected or maximum nest level reached.
501 * We abort this wake by breaking the cycle itself.
502 */
Tony Battersbyabff55c2009-03-31 15:24:13 -0700503 error = -1;
504 goto out_unlock;
Davide Libenzi5071f972009-03-31 15:24:10 -0700505 }
506 }
507
508 /* Add the current task and cookie to the list */
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700509 tnode.ctx = ctx;
Davide Libenzi5071f972009-03-31 15:24:10 -0700510 tnode.cookie = cookie;
511 list_add(&tnode.llink, lsthead);
512
513 spin_unlock_irqrestore(&ncalls->lock, flags);
514
515 /* Call the nested function */
516 error = (*nproc)(priv, cookie, call_nests);
517
518 /* Remove the current task from the list */
519 spin_lock_irqsave(&ncalls->lock, flags);
520 list_del(&tnode.llink);
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700521out_unlock:
Davide Libenzi5071f972009-03-31 15:24:10 -0700522 spin_unlock_irqrestore(&ncalls->lock, flags);
523
524 return error;
525}
526
Steven Rostedt02edc6f2012-03-23 15:02:27 -0700527/*
528 * As described in commit 0ccf831cb lockdep: annotate epoll
529 * the use of wait queues used by epoll is done in a very controlled
530 * manner. Wake ups can nest inside each other, but are never done
531 * with the same locking. For example:
532 *
533 * dfd = socket(...);
534 * efd1 = epoll_create();
535 * efd2 = epoll_create();
536 * epoll_ctl(efd1, EPOLL_CTL_ADD, dfd, ...);
537 * epoll_ctl(efd2, EPOLL_CTL_ADD, efd1, ...);
538 *
539 * When a packet arrives to the device underneath "dfd", the net code will
540 * issue a wake_up() on its poll wake list. Epoll (efd1) has installed a
541 * callback wakeup entry on that queue, and the wake_up() performed by the
542 * "dfd" net code will end up in ep_poll_callback(). At this point epoll
543 * (efd1) notices that it may have some event ready, so it needs to wake up
544 * the waiters on its poll wait list (efd2). So it calls ep_poll_safewake()
545 * that ends up in another wake_up(), after having checked about the
546 * recursion constraints. That are, no more than EP_MAX_POLLWAKE_NESTS, to
547 * avoid stack blasting.
548 *
549 * When CONFIG_DEBUG_LOCK_ALLOC is enabled, make sure lockdep can handle
550 * this special case of epoll.
551 */
Davide Libenzi2dfa4ee2009-03-31 15:24:22 -0700552#ifdef CONFIG_DEBUG_LOCK_ALLOC
Davide Libenzi2dfa4ee2009-03-31 15:24:22 -0700553
Jason Baron57a173b2017-11-17 15:29:02 -0800554static struct nested_calls poll_safewake_ncalls;
Davide Libenzi2dfa4ee2009-03-31 15:24:22 -0700555
Davide Libenzi5071f972009-03-31 15:24:10 -0700556static int ep_poll_wakeup_proc(void *priv, void *cookie, int call_nests)
557{
Jason Baron57a173b2017-11-17 15:29:02 -0800558 unsigned long flags;
559 wait_queue_head_t *wqueue = (wait_queue_head_t *)cookie;
560
561 spin_lock_irqsave_nested(&wqueue->lock, flags, call_nests + 1);
Linus Torvaldsa9a08842018-02-11 14:34:03 -0800562 wake_up_locked_poll(wqueue, EPOLLIN);
Jason Baron57a173b2017-11-17 15:29:02 -0800563 spin_unlock_irqrestore(&wqueue->lock, flags);
564
Davide Libenzi5071f972009-03-31 15:24:10 -0700565 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566}
567
Davide Libenzi5071f972009-03-31 15:24:10 -0700568static void ep_poll_safewake(wait_queue_head_t *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569{
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700570 int this_cpu = get_cpu();
571
Davidlohr Bueso74bdc122019-01-03 15:27:02 -0800572 ep_call_nested(&poll_safewake_ncalls,
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700573 ep_poll_wakeup_proc, NULL, wq, (void *) (long) this_cpu);
574
575 put_cpu();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576}
577
Jason Baron57a173b2017-11-17 15:29:02 -0800578#else
579
580static void ep_poll_safewake(wait_queue_head_t *wq)
581{
Linus Torvaldsa9a08842018-02-11 14:34:03 -0800582 wake_up_poll(wq, EPOLLIN);
Jason Baron57a173b2017-11-17 15:29:02 -0800583}
584
585#endif
586
Oleg Nesterov971316f2012-02-24 20:07:29 +0100587static void ep_remove_wait_queue(struct eppoll_entry *pwq)
588{
589 wait_queue_head_t *whead;
590
591 rcu_read_lock();
Oleg Nesterov138e4ad2017-09-01 18:55:33 +0200592 /*
593 * If it is cleared by POLLFREE, it should be rcu-safe.
594 * If we read NULL we need a barrier paired with
595 * smp_store_release() in ep_poll_callback(), otherwise
596 * we rely on whead->lock.
597 */
598 whead = smp_load_acquire(&pwq->whead);
Oleg Nesterov971316f2012-02-24 20:07:29 +0100599 if (whead)
600 remove_wait_queue(whead, &pwq->wait);
601 rcu_read_unlock();
602}
603
Davide Libenzi7699acd2007-05-10 22:23:23 -0700604/*
Tony Battersbyd1bc90d2009-03-31 15:24:15 -0700605 * This function unregisters poll callbacks from the associated file
606 * descriptor. Must be called with "mtx" held (or "epmutex" if called from
607 * ep_free).
Davide Libenzi7699acd2007-05-10 22:23:23 -0700608 */
609static void ep_unregister_pollwait(struct eventpoll *ep, struct epitem *epi)
610{
Davide Libenzi7699acd2007-05-10 22:23:23 -0700611 struct list_head *lsthead = &epi->pwqlist;
612 struct eppoll_entry *pwq;
613
Tony Battersbyd1bc90d2009-03-31 15:24:15 -0700614 while (!list_empty(lsthead)) {
615 pwq = list_first_entry(lsthead, struct eppoll_entry, llink);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700616
Tony Battersbyd1bc90d2009-03-31 15:24:15 -0700617 list_del(&pwq->llink);
Oleg Nesterov971316f2012-02-24 20:07:29 +0100618 ep_remove_wait_queue(pwq);
Tony Battersbyd1bc90d2009-03-31 15:24:15 -0700619 kmem_cache_free(pwq_cache, pwq);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700620 }
621}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622
Eric Wongeea1d582013-04-30 15:27:39 -0700623/* call only when ep->mtx is held */
624static inline struct wakeup_source *ep_wakeup_source(struct epitem *epi)
625{
626 return rcu_dereference_check(epi->ws, lockdep_is_held(&epi->ep->mtx));
627}
628
629/* call only when ep->mtx is held */
630static inline void ep_pm_stay_awake(struct epitem *epi)
631{
632 struct wakeup_source *ws = ep_wakeup_source(epi);
633
634 if (ws)
635 __pm_stay_awake(ws);
636}
637
638static inline bool ep_has_wakeup_source(struct epitem *epi)
639{
640 return rcu_access_pointer(epi->ws) ? true : false;
641}
642
643/* call when ep->mtx cannot be held (ep_poll_callback) */
644static inline void ep_pm_stay_awake_rcu(struct epitem *epi)
645{
646 struct wakeup_source *ws;
647
648 rcu_read_lock();
649 ws = rcu_dereference(epi->ws);
650 if (ws)
651 __pm_stay_awake(ws);
652 rcu_read_unlock();
653}
654
Davide Libenzi5071f972009-03-31 15:24:10 -0700655/**
656 * ep_scan_ready_list - Scans the ready list in a way that makes possible for
657 * the scan code, to call f_op->poll(). Also allows for
658 * O(NumReady) performance.
659 *
660 * @ep: Pointer to the epoll private data structure.
661 * @sproc: Pointer to the scan callback.
662 * @priv: Private opaque data passed to the @sproc callback.
Nelson Elhaged8805e62011-10-31 17:13:14 -0700663 * @depth: The current depth of recursive f_op->poll calls.
Jason Baron67347fe2013-11-12 15:10:18 -0800664 * @ep_locked: caller already holds ep->mtx
Davide Libenzi5071f972009-03-31 15:24:10 -0700665 *
666 * Returns: The same integer error code returned by the @sproc callback.
667 */
Al Virod85e2aa2018-02-01 15:24:58 -0500668static __poll_t ep_scan_ready_list(struct eventpoll *ep,
669 __poll_t (*sproc)(struct eventpoll *,
Davide Libenzi5071f972009-03-31 15:24:10 -0700670 struct list_head *, void *),
Jason Baron67347fe2013-11-12 15:10:18 -0800671 void *priv, int depth, bool ep_locked)
Davide Libenzi5071f972009-03-31 15:24:10 -0700672{
Al Virod85e2aa2018-02-01 15:24:58 -0500673 __poll_t res;
674 int pwake = 0;
Davide Libenzi5071f972009-03-31 15:24:10 -0700675 struct epitem *epi, *nepi;
Davide Libenzi296e2362009-03-31 15:24:11 -0700676 LIST_HEAD(txlist);
Davide Libenzi5071f972009-03-31 15:24:10 -0700677
Davidlohr Bueso92e64172018-08-21 21:56:45 -0700678 lockdep_assert_irqs_enabled();
679
Davide Libenzi5071f972009-03-31 15:24:10 -0700680 /*
681 * We need to lock this because we could be hit by
Tony Battersbye057e152009-03-31 15:24:15 -0700682 * eventpoll_release_file() and epoll_ctl().
Davide Libenzi5071f972009-03-31 15:24:10 -0700683 */
Jason Baron67347fe2013-11-12 15:10:18 -0800684
685 if (!ep_locked)
686 mutex_lock_nested(&ep->mtx, depth);
Davide Libenzi5071f972009-03-31 15:24:10 -0700687
688 /*
689 * Steal the ready list, and re-init the original one to the
690 * empty list. Also, set ep->ovflist to NULL so that events
691 * happening while looping w/out locks, are not lost. We cannot
692 * have the poll callback to queue directly on ep->rdllist,
693 * because we want the "sproc" callback to be able to do it
694 * in a lockless way.
695 */
Roman Penyaeva218cc42019-03-07 16:28:53 -0800696 write_lock_irq(&ep->lock);
Davide Libenzi296e2362009-03-31 15:24:11 -0700697 list_splice_init(&ep->rdllist, &txlist);
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -0800698 WRITE_ONCE(ep->ovflist, NULL);
Roman Penyaeva218cc42019-03-07 16:28:53 -0800699 write_unlock_irq(&ep->lock);
Davide Libenzi5071f972009-03-31 15:24:10 -0700700
701 /*
702 * Now call the callback function.
703 */
Al Virod85e2aa2018-02-01 15:24:58 -0500704 res = (*sproc)(ep, &txlist, priv);
Davide Libenzi5071f972009-03-31 15:24:10 -0700705
Roman Penyaeva218cc42019-03-07 16:28:53 -0800706 write_lock_irq(&ep->lock);
Davide Libenzi5071f972009-03-31 15:24:10 -0700707 /*
708 * During the time we spent inside the "sproc" callback, some
709 * other events might have been queued by the poll callback.
710 * We re-insert them inside the main ready-list here.
711 */
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -0800712 for (nepi = READ_ONCE(ep->ovflist); (epi = nepi) != NULL;
Davide Libenzi5071f972009-03-31 15:24:10 -0700713 nepi = epi->next, epi->next = EP_UNACTIVE_PTR) {
714 /*
715 * We need to check if the item is already in the list.
716 * During the "sproc" callback execution time, items are
717 * queued into ->ovflist but the "txlist" might already
718 * contain them, and the list_splice() below takes care of them.
719 */
Davidlohr Bueso992991c2018-08-21 21:58:26 -0700720 if (!ep_is_linked(epi)) {
Roman Penyaevc1411752019-03-07 16:28:46 -0800721 /*
722 * ->ovflist is LIFO, so we have to reverse it in order
723 * to keep in FIFO.
724 */
725 list_add(&epi->rdllink, &ep->rdllist);
Eric Wongeea1d582013-04-30 15:27:39 -0700726 ep_pm_stay_awake(epi);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200727 }
Davide Libenzi5071f972009-03-31 15:24:10 -0700728 }
729 /*
730 * We need to set back ep->ovflist to EP_UNACTIVE_PTR, so that after
731 * releasing the lock, events will be queued in the normal way inside
732 * ep->rdllist.
733 */
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -0800734 WRITE_ONCE(ep->ovflist, EP_UNACTIVE_PTR);
Davide Libenzi5071f972009-03-31 15:24:10 -0700735
736 /*
737 * Quickly re-inject items left on "txlist".
738 */
739 list_splice(&txlist, &ep->rdllist);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200740 __pm_relax(ep->ws);
Davide Libenzi5071f972009-03-31 15:24:10 -0700741
742 if (!list_empty(&ep->rdllist)) {
743 /*
Davide Libenzi296e2362009-03-31 15:24:11 -0700744 * Wake up (if active) both the eventpoll wait list and
745 * the ->poll() wait list (delayed after we release the lock).
Davide Libenzi5071f972009-03-31 15:24:10 -0700746 */
747 if (waitqueue_active(&ep->wq))
Roman Penyaeva218cc42019-03-07 16:28:53 -0800748 wake_up(&ep->wq);
Davide Libenzi5071f972009-03-31 15:24:10 -0700749 if (waitqueue_active(&ep->poll_wait))
750 pwake++;
751 }
Roman Penyaeva218cc42019-03-07 16:28:53 -0800752 write_unlock_irq(&ep->lock);
Davide Libenzi5071f972009-03-31 15:24:10 -0700753
Jason Baron67347fe2013-11-12 15:10:18 -0800754 if (!ep_locked)
755 mutex_unlock(&ep->mtx);
Davide Libenzi5071f972009-03-31 15:24:10 -0700756
757 /* We have to call this outside the lock */
758 if (pwake)
759 ep_poll_safewake(&ep->poll_wait);
760
Al Virod85e2aa2018-02-01 15:24:58 -0500761 return res;
Davide Libenzi5071f972009-03-31 15:24:10 -0700762}
763
Jason Baronae10b2b2013-11-12 15:10:16 -0800764static void epi_rcu_free(struct rcu_head *head)
765{
766 struct epitem *epi = container_of(head, struct epitem, rcu);
767 kmem_cache_free(epi_cache, epi);
768}
769
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770/*
Davide Libenzi7699acd2007-05-10 22:23:23 -0700771 * Removes a "struct epitem" from the eventpoll RB tree and deallocates
Davide Libenzic7ea7632007-05-15 01:40:47 -0700772 * all the associated resources. Must be called with "mtx" held.
Davide Libenzi7699acd2007-05-10 22:23:23 -0700773 */
774static int ep_remove(struct eventpoll *ep, struct epitem *epi)
775{
Davide Libenzi7699acd2007-05-10 22:23:23 -0700776 struct file *file = epi->ffd.file;
777
Davidlohr Bueso92e64172018-08-21 21:56:45 -0700778 lockdep_assert_irqs_enabled();
779
Davide Libenzi7699acd2007-05-10 22:23:23 -0700780 /*
Christoph Hellwigee8ef0a2018-08-21 21:56:26 -0700781 * Removes poll wait queue hooks.
Davide Libenzi7699acd2007-05-10 22:23:23 -0700782 */
783 ep_unregister_pollwait(ep, epi);
784
785 /* Remove the current item from the list of epoll hooks */
Jonathan Corbet68499912009-02-06 13:52:43 -0700786 spin_lock(&file->f_lock);
Jason Baronae10b2b2013-11-12 15:10:16 -0800787 list_del_rcu(&epi->fllink);
Jonathan Corbet68499912009-02-06 13:52:43 -0700788 spin_unlock(&file->f_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700790 rb_erase_cached(&epi->rbn, &ep->rbr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791
Roman Penyaeva218cc42019-03-07 16:28:53 -0800792 write_lock_irq(&ep->lock);
Davidlohr Bueso992991c2018-08-21 21:58:26 -0700793 if (ep_is_linked(epi))
Davide Libenzic7ea7632007-05-15 01:40:47 -0700794 list_del_init(&epi->rdllink);
Roman Penyaeva218cc42019-03-07 16:28:53 -0800795 write_unlock_irq(&ep->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796
Eric Wongeea1d582013-04-30 15:27:39 -0700797 wakeup_source_unregister(ep_wakeup_source(epi));
Jason Baronae10b2b2013-11-12 15:10:16 -0800798 /*
799 * At this point it is safe to free the eventpoll item. Use the union
800 * field epi->rcu, since we are trying to minimize the size of
801 * 'struct epitem'. The 'rbn' field is no longer in use. Protected by
802 * ep->mtx. The rcu read side, reverse_path_check_proc(), does not make
803 * use of the rbn field.
804 */
805 call_rcu(&epi->rcu, epi_rcu_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806
Robin Holt52bd19f72011-01-12 17:00:01 -0800807 atomic_long_dec(&ep->user->epoll_watches);
Davide Libenzi7ef99642008-12-01 13:13:55 -0800808
Davide Libenzic7ea7632007-05-15 01:40:47 -0700809 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810}
811
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812static void ep_free(struct eventpoll *ep)
813{
814 struct rb_node *rbp;
815 struct epitem *epi;
816
817 /* We need to release all tasks waiting for these file */
818 if (waitqueue_active(&ep->poll_wait))
Davide Libenzi5071f972009-03-31 15:24:10 -0700819 ep_poll_safewake(&ep->poll_wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820
821 /*
822 * We need to lock this because we could be hit by
823 * eventpoll_release_file() while we're freeing the "struct eventpoll".
Davide Libenzid47de162007-05-15 01:40:41 -0700824 * We do not need to hold "ep->mtx" here because the epoll file
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825 * is on the way to be removed and no one has references to it
826 * anymore. The only hit might come from eventpoll_release_file() but
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300827 * holding "epmutex" is sufficient here.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828 */
Arjan van de Ven144efe32006-03-23 03:00:32 -0800829 mutex_lock(&epmutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830
831 /*
832 * Walks through the whole tree by unregistering poll callbacks.
833 */
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700834 for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835 epi = rb_entry(rbp, struct epitem, rbn);
836
837 ep_unregister_pollwait(ep, epi);
Eric Dumazet91cf5ab2013-09-11 14:24:06 -0700838 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839 }
840
841 /*
Davide Libenzi6192bd52007-05-08 00:25:41 -0700842 * Walks through the whole tree by freeing each "struct epitem". At this
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843 * point we are sure no poll callbacks will be lingering around, and also by
Davide Libenzid47de162007-05-15 01:40:41 -0700844 * holding "epmutex" we can be sure that no file cleanup code will hit
Roman Penyaeva218cc42019-03-07 16:28:53 -0800845 * us during this operation. So we can avoid the lock on "ep->lock".
Eric Wongddf676c2013-04-30 15:27:40 -0700846 * We do not need to lock ep->mtx, either, we only do it to prevent
847 * a lockdep warning.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848 */
Eric Wongddf676c2013-04-30 15:27:40 -0700849 mutex_lock(&ep->mtx);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700850 while ((rbp = rb_first_cached(&ep->rbr)) != NULL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851 epi = rb_entry(rbp, struct epitem, rbn);
852 ep_remove(ep, epi);
Eric Dumazet91cf5ab2013-09-11 14:24:06 -0700853 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854 }
Eric Wongddf676c2013-04-30 15:27:40 -0700855 mutex_unlock(&ep->mtx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856
Arjan van de Ven144efe32006-03-23 03:00:32 -0800857 mutex_unlock(&epmutex);
Davide Libenzid47de162007-05-15 01:40:41 -0700858 mutex_destroy(&ep->mtx);
Davide Libenzi7ef99642008-12-01 13:13:55 -0800859 free_uid(ep->user);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200860 wakeup_source_unregister(ep->ws);
Davide Libenzif0ee9aa2007-05-15 01:40:57 -0700861 kfree(ep);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862}
863
Davide Libenzi7699acd2007-05-10 22:23:23 -0700864static int ep_eventpoll_release(struct inode *inode, struct file *file)
865{
866 struct eventpoll *ep = file->private_data;
867
Davide Libenzif0ee9aa2007-05-15 01:40:57 -0700868 if (ep)
Davide Libenzi7699acd2007-05-10 22:23:23 -0700869 ep_free(ep);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700870
Davide Libenzi7699acd2007-05-10 22:23:23 -0700871 return 0;
872}
873
Al Virod85e2aa2018-02-01 15:24:58 -0500874static __poll_t ep_read_events_proc(struct eventpoll *ep, struct list_head *head,
Jason Baron37b5e522017-11-17 15:29:06 -0800875 void *priv);
876static void ep_ptable_queue_proc(struct file *file, wait_queue_head_t *whead,
877 poll_table *pt);
Eric Wong450d89e2013-04-30 15:27:42 -0700878
Jason Baron37b5e522017-11-17 15:29:06 -0800879/*
880 * Differs from ep_eventpoll_poll() in that internal callers already have
881 * the ep->mtx so we need to start from depth=1, such that mutex_lock_nested()
882 * is correctly annotated.
883 */
Al Virod85e2aa2018-02-01 15:24:58 -0500884static __poll_t ep_item_poll(const struct epitem *epi, poll_table *pt,
Al Virobec1a5022017-11-28 19:43:33 -0500885 int depth)
Jason Baron37b5e522017-11-17 15:29:06 -0800886{
887 struct eventpoll *ep;
888 bool locked;
889
890 pt->_key = epi->event.events;
891 if (!is_file_epoll(epi->ffd.file))
Christoph Hellwig9965ed172018-03-05 07:26:05 -0800892 return vfs_poll(epi->ffd.file, pt) & epi->event.events;
Jason Baron37b5e522017-11-17 15:29:06 -0800893
894 ep = epi->ffd.file->private_data;
895 poll_wait(epi->ffd.file, &ep->poll_wait, pt);
896 locked = pt && (pt->_qproc == ep_ptable_queue_proc);
897
898 return ep_scan_ready_list(epi->ffd.file->private_data,
899 ep_read_events_proc, &depth, depth,
900 locked) & epi->event.events;
Eric Wong450d89e2013-04-30 15:27:42 -0700901}
902
Al Virod85e2aa2018-02-01 15:24:58 -0500903static __poll_t ep_read_events_proc(struct eventpoll *ep, struct list_head *head,
Davide Libenzi296e2362009-03-31 15:24:11 -0700904 void *priv)
Davide Libenzi5071f972009-03-31 15:24:10 -0700905{
906 struct epitem *epi, *tmp;
Hans Verkuil626cf232012-03-23 15:02:27 -0700907 poll_table pt;
Jason Baron37b5e522017-11-17 15:29:06 -0800908 int depth = *(int *)priv;
Davide Libenzi5071f972009-03-31 15:24:10 -0700909
Hans Verkuil626cf232012-03-23 15:02:27 -0700910 init_poll_funcptr(&pt, NULL);
Jason Baron37b5e522017-11-17 15:29:06 -0800911 depth++;
Eric Wong450d89e2013-04-30 15:27:42 -0700912
Davide Libenzi5071f972009-03-31 15:24:10 -0700913 list_for_each_entry_safe(epi, tmp, head, rdllink) {
Jason Baron37b5e522017-11-17 15:29:06 -0800914 if (ep_item_poll(epi, &pt, depth)) {
Linus Torvaldsa9a08842018-02-11 14:34:03 -0800915 return EPOLLIN | EPOLLRDNORM;
Jason Baron37b5e522017-11-17 15:29:06 -0800916 } else {
Davide Libenzi5071f972009-03-31 15:24:10 -0700917 /*
918 * Item has been dropped into the ready list by the poll
919 * callback, but it's not actually ready, as far as
920 * caller requested events goes. We can remove it here.
921 */
Eric Wongeea1d582013-04-30 15:27:39 -0700922 __pm_relax(ep_wakeup_source(epi));
Davide Libenzi5071f972009-03-31 15:24:10 -0700923 list_del_init(&epi->rdllink);
Davide Libenzi296e2362009-03-31 15:24:11 -0700924 }
Davide Libenzi5071f972009-03-31 15:24:10 -0700925 }
926
927 return 0;
928}
929
Linus Torvaldsa11e1d42018-06-28 09:43:44 -0700930static __poll_t ep_eventpoll_poll(struct file *file, poll_table *wait)
Davide Libenzi7699acd2007-05-10 22:23:23 -0700931{
Davide Libenzi7699acd2007-05-10 22:23:23 -0700932 struct eventpoll *ep = file->private_data;
Jason Baron37b5e522017-11-17 15:29:06 -0800933 int depth = 0;
Davide Libenzi7699acd2007-05-10 22:23:23 -0700934
Linus Torvaldsa11e1d42018-06-28 09:43:44 -0700935 /* Insert inside our poll wait queue */
936 poll_wait(file, &ep->poll_wait, wait);
937
Davide Libenzi5071f972009-03-31 15:24:10 -0700938 /*
939 * Proceed to find out if wanted events are really available inside
Jason Baron37b5e522017-11-17 15:29:06 -0800940 * the ready list.
Davide Libenzi5071f972009-03-31 15:24:10 -0700941 */
Jason Baron37b5e522017-11-17 15:29:06 -0800942 return ep_scan_ready_list(ep, ep_read_events_proc,
943 &depth, depth, false);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700944}
945
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800946#ifdef CONFIG_PROC_FS
Joe Perchesa3816ab2014-09-29 16:08:25 -0700947static void ep_show_fdinfo(struct seq_file *m, struct file *f)
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800948{
949 struct eventpoll *ep = f->private_data;
950 struct rb_node *rbp;
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800951
952 mutex_lock(&ep->mtx);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700953 for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) {
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800954 struct epitem *epi = rb_entry(rbp, struct epitem, rbn);
Cyrill Gorcunov77493f02017-07-12 14:34:25 -0700955 struct inode *inode = file_inode(epi->ffd.file);
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800956
Cyrill Gorcunov77493f02017-07-12 14:34:25 -0700957 seq_printf(m, "tfd: %8d events: %8x data: %16llx "
958 " pos:%lli ino:%lx sdev:%x\n",
Joe Perchesa3816ab2014-09-29 16:08:25 -0700959 epi->ffd.fd, epi->event.events,
Cyrill Gorcunov77493f02017-07-12 14:34:25 -0700960 (long long)epi->event.data,
961 (long long)epi->ffd.file->f_pos,
962 inode->i_ino, inode->i_sb->s_dev);
Joe Perchesa3816ab2014-09-29 16:08:25 -0700963 if (seq_has_overflowed(m))
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800964 break;
965 }
966 mutex_unlock(&ep->mtx);
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800967}
968#endif
969
Davide Libenzi7699acd2007-05-10 22:23:23 -0700970/* File callbacks that implement the eventpoll file behaviour */
971static const struct file_operations eventpoll_fops = {
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800972#ifdef CONFIG_PROC_FS
973 .show_fdinfo = ep_show_fdinfo,
974#endif
Davide Libenzi7699acd2007-05-10 22:23:23 -0700975 .release = ep_eventpoll_release,
Linus Torvaldsa11e1d42018-06-28 09:43:44 -0700976 .poll = ep_eventpoll_poll,
Arnd Bergmann6038f372010-08-15 18:52:59 +0200977 .llseek = noop_llseek,
Davide Libenzi7699acd2007-05-10 22:23:23 -0700978};
979
Davide Libenzi7699acd2007-05-10 22:23:23 -0700980/*
981 * This is called from eventpoll_release() to unlink files from the eventpoll
982 * interface. We need to have this facility to cleanup correctly files that are
983 * closed without being removed from the eventpoll interface.
984 */
985void eventpoll_release_file(struct file *file)
986{
Davide Libenzi7699acd2007-05-10 22:23:23 -0700987 struct eventpoll *ep;
Konstantin Khlebnikovebe06182014-06-17 06:58:05 +0400988 struct epitem *epi, *next;
Davide Libenzi7699acd2007-05-10 22:23:23 -0700989
990 /*
Jonathan Corbet68499912009-02-06 13:52:43 -0700991 * We don't want to get "file->f_lock" because it is not
Davide Libenzi7699acd2007-05-10 22:23:23 -0700992 * necessary. It is not necessary because we're in the "struct file"
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300993 * cleanup path, and this means that no one is using this file anymore.
Davide Libenzi5071f972009-03-31 15:24:10 -0700994 * So, for example, epoll_ctl() cannot hit here since if we reach this
Davide Libenzi67647d02007-05-15 01:40:52 -0700995 * point, the file counter already went to zero and fget() would fail.
Davide Libenzid47de162007-05-15 01:40:41 -0700996 * The only hit might come from ep_free() but by holding the mutex
Davide Libenzi7699acd2007-05-10 22:23:23 -0700997 * will correctly serialize the operation. We do need to acquire
Davide Libenzid47de162007-05-15 01:40:41 -0700998 * "ep->mtx" after "epmutex" because ep_remove() requires it when called
Davide Libenzi7699acd2007-05-10 22:23:23 -0700999 * from anywhere but ep_free().
Jonathan Corbet68499912009-02-06 13:52:43 -07001000 *
1001 * Besides, ep_remove() acquires the lock, so we can't hold it here.
Davide Libenzi7699acd2007-05-10 22:23:23 -07001002 */
1003 mutex_lock(&epmutex);
Konstantin Khlebnikovebe06182014-06-17 06:58:05 +04001004 list_for_each_entry_safe(epi, next, &file->f_ep_links, fllink) {
Davide Libenzi7699acd2007-05-10 22:23:23 -07001005 ep = epi->ep;
Nelson Elhaged8805e62011-10-31 17:13:14 -07001006 mutex_lock_nested(&ep->mtx, 0);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001007 ep_remove(ep, epi);
Davide Libenzid47de162007-05-15 01:40:41 -07001008 mutex_unlock(&ep->mtx);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001009 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07001010 mutex_unlock(&epmutex);
1011}
1012
1013static int ep_alloc(struct eventpoll **pep)
1014{
Davide Libenzi7ef99642008-12-01 13:13:55 -08001015 int error;
1016 struct user_struct *user;
1017 struct eventpoll *ep;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001018
Davide Libenzi7ef99642008-12-01 13:13:55 -08001019 user = get_current_user();
Davide Libenzi7ef99642008-12-01 13:13:55 -08001020 error = -ENOMEM;
1021 ep = kzalloc(sizeof(*ep), GFP_KERNEL);
1022 if (unlikely(!ep))
1023 goto free_uid;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001024
Davide Libenzid47de162007-05-15 01:40:41 -07001025 mutex_init(&ep->mtx);
Roman Penyaeva218cc42019-03-07 16:28:53 -08001026 rwlock_init(&ep->lock);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001027 init_waitqueue_head(&ep->wq);
1028 init_waitqueue_head(&ep->poll_wait);
1029 INIT_LIST_HEAD(&ep->rdllist);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001030 ep->rbr = RB_ROOT_CACHED;
Davide Libenzid47de162007-05-15 01:40:41 -07001031 ep->ovflist = EP_UNACTIVE_PTR;
Davide Libenzi7ef99642008-12-01 13:13:55 -08001032 ep->user = user;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001033
1034 *pep = ep;
1035
Davide Libenzi7699acd2007-05-10 22:23:23 -07001036 return 0;
Davide Libenzi7ef99642008-12-01 13:13:55 -08001037
1038free_uid:
1039 free_uid(user);
1040 return error;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001041}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001042
1043/*
Davide Libenzic7ea7632007-05-15 01:40:47 -07001044 * Search the file inside the eventpoll tree. The RB tree operations
1045 * are protected by the "mtx" mutex, and ep_find() must be called with
1046 * "mtx" held.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047 */
1048static struct epitem *ep_find(struct eventpoll *ep, struct file *file, int fd)
1049{
1050 int kcmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001051 struct rb_node *rbp;
1052 struct epitem *epi, *epir = NULL;
1053 struct epoll_filefd ffd;
1054
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001055 ep_set_ffd(&ffd, file, fd);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001056 for (rbp = ep->rbr.rb_root.rb_node; rbp; ) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001057 epi = rb_entry(rbp, struct epitem, rbn);
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001058 kcmp = ep_cmp_ffd(&ffd, &epi->ffd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001059 if (kcmp > 0)
1060 rbp = rbp->rb_right;
1061 else if (kcmp < 0)
1062 rbp = rbp->rb_left;
1063 else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001064 epir = epi;
1065 break;
1066 }
1067 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069 return epir;
1070}
1071
Cyrill Gorcunov92ef6da2017-07-12 14:34:31 -07001072#ifdef CONFIG_CHECKPOINT_RESTORE
Cyrill Gorcunov0791e362017-07-12 14:34:28 -07001073static struct epitem *ep_find_tfd(struct eventpoll *ep, int tfd, unsigned long toff)
1074{
1075 struct rb_node *rbp;
1076 struct epitem *epi;
1077
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001078 for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) {
Cyrill Gorcunov0791e362017-07-12 14:34:28 -07001079 epi = rb_entry(rbp, struct epitem, rbn);
1080 if (epi->ffd.fd == tfd) {
1081 if (toff == 0)
1082 return epi;
1083 else
1084 toff--;
1085 }
1086 cond_resched();
1087 }
1088
1089 return NULL;
1090}
1091
1092struct file *get_epoll_tfile_raw_ptr(struct file *file, int tfd,
1093 unsigned long toff)
1094{
1095 struct file *file_raw;
1096 struct eventpoll *ep;
1097 struct epitem *epi;
1098
1099 if (!is_file_epoll(file))
1100 return ERR_PTR(-EINVAL);
1101
1102 ep = file->private_data;
1103
1104 mutex_lock(&ep->mtx);
1105 epi = ep_find_tfd(ep, tfd, toff);
1106 if (epi)
1107 file_raw = epi->ffd.file;
1108 else
1109 file_raw = ERR_PTR(-ENOENT);
1110 mutex_unlock(&ep->mtx);
1111
1112 return file_raw;
1113}
Cyrill Gorcunov92ef6da2017-07-12 14:34:31 -07001114#endif /* CONFIG_CHECKPOINT_RESTORE */
Cyrill Gorcunov0791e362017-07-12 14:34:28 -07001115
Roman Penyaeva218cc42019-03-07 16:28:53 -08001116/**
1117 * Adds a new entry to the tail of the list in a lockless way, i.e.
1118 * multiple CPUs are allowed to call this function concurrently.
1119 *
1120 * Beware: it is necessary to prevent any other modifications of the
1121 * existing list until all changes are completed, in other words
1122 * concurrent list_add_tail_lockless() calls should be protected
1123 * with a read lock, where write lock acts as a barrier which
1124 * makes sure all list_add_tail_lockless() calls are fully
1125 * completed.
1126 *
1127 * Also an element can be locklessly added to the list only in one
1128 * direction i.e. either to the tail either to the head, otherwise
1129 * concurrent access will corrupt the list.
1130 *
1131 * Returns %false if element has been already added to the list, %true
1132 * otherwise.
1133 */
1134static inline bool list_add_tail_lockless(struct list_head *new,
1135 struct list_head *head)
1136{
1137 struct list_head *prev;
1138
1139 /*
1140 * This is simple 'new->next = head' operation, but cmpxchg()
1141 * is used in order to detect that same element has been just
1142 * added to the list from another CPU: the winner observes
1143 * new->next == new.
1144 */
1145 if (cmpxchg(&new->next, new, head) != new)
1146 return false;
1147
1148 /*
1149 * Initially ->next of a new element must be updated with the head
1150 * (we are inserting to the tail) and only then pointers are atomically
1151 * exchanged. XCHG guarantees memory ordering, thus ->next should be
1152 * updated before pointers are actually swapped and pointers are
1153 * swapped before prev->next is updated.
1154 */
1155
1156 prev = xchg(&head->prev, new);
1157
1158 /*
1159 * It is safe to modify prev->next and new->prev, because a new element
1160 * is added only to the tail and new->next is updated before XCHG.
1161 */
1162
1163 prev->next = new;
1164 new->prev = prev;
1165
1166 return true;
1167}
1168
1169/**
1170 * Chains a new epi entry to the tail of the ep->ovflist in a lockless way,
1171 * i.e. multiple CPUs are allowed to call this function concurrently.
1172 *
1173 * Returns %false if epi element has been already chained, %true otherwise.
1174 */
1175static inline bool chain_epi_lockless(struct epitem *epi)
1176{
1177 struct eventpoll *ep = epi->ep;
1178
Khazhismel Kumykovee922a22020-05-07 18:35:59 -07001179 /* Fast preliminary check */
1180 if (epi->next != EP_UNACTIVE_PTR)
1181 return false;
1182
Roman Penyaeva218cc42019-03-07 16:28:53 -08001183 /* Check that the same epi has not been just chained from another CPU */
1184 if (cmpxchg(&epi->next, EP_UNACTIVE_PTR, NULL) != EP_UNACTIVE_PTR)
1185 return false;
1186
1187 /* Atomically exchange tail */
1188 epi->next = xchg(&ep->ovflist, epi);
1189
1190 return true;
1191}
1192
Linus Torvalds1da177e2005-04-16 15:20:36 -07001193/*
Davide Libenzi7699acd2007-05-10 22:23:23 -07001194 * This is the callback that is passed to the wait queue wakeup
Daniel Balutabf6a41d2011-01-30 23:42:29 +02001195 * mechanism. It is called by the stored file descriptors when they
Davide Libenzi7699acd2007-05-10 22:23:23 -07001196 * have events to report.
Roman Penyaeva218cc42019-03-07 16:28:53 -08001197 *
1198 * This callback takes a read lock in order not to content with concurrent
1199 * events from another file descriptors, thus all modifications to ->rdllist
1200 * or ->ovflist are lockless. Read lock is paired with the write lock from
1201 * ep_scan_ready_list(), which stops all list modifications and guarantees
1202 * that lists state is seen correctly.
1203 *
1204 * Another thing worth to mention is that ep_poll_callback() can be called
1205 * concurrently for the same @epi from different CPUs if poll table was inited
1206 * with several wait queues entries. Plural wakeup from different CPUs of a
1207 * single wait queue is serialized by wq.lock, but the case when multiple wait
1208 * queues are used should be detected accordingly. This is detected using
1209 * cmpxchg() operation.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001210 */
Ingo Molnarac6424b2017-06-20 12:06:13 +02001211static int ep_poll_callback(wait_queue_entry_t *wait, unsigned mode, int sync, void *key)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001212{
Davide Libenzi7699acd2007-05-10 22:23:23 -07001213 int pwake = 0;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001214 struct epitem *epi = ep_item_from_wait(wait);
1215 struct eventpoll *ep = epi->ep;
Al Viro3ad6f932017-07-03 20:14:56 -04001216 __poll_t pollflags = key_to_poll(key);
Roman Penyaeva218cc42019-03-07 16:28:53 -08001217 unsigned long flags;
Jason Barondf0108c2016-01-20 14:59:24 -08001218 int ewake = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001219
Roman Penyaeva218cc42019-03-07 16:28:53 -08001220 read_lock_irqsave(&ep->lock, flags);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001221
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -07001222 ep_set_busy_poll_napi_id(epi);
1223
Davide Libenzi7699acd2007-05-10 22:23:23 -07001224 /*
1225 * If the event mask does not contain any poll(2) event, we consider the
1226 * descriptor to be disabled. This condition is likely the effect of the
1227 * EPOLLONESHOT bit that disables the descriptor when an event is received,
1228 * until the next EPOLL_CTL_MOD will be issued.
1229 */
1230 if (!(epi->event.events & ~EP_PRIVATE_BITS))
Davide Libenzid47de162007-05-15 01:40:41 -07001231 goto out_unlock;
1232
1233 /*
Davide Libenzi2dfa4ee2009-03-31 15:24:22 -07001234 * Check the events coming with the callback. At this stage, not
1235 * every device reports the events in the "key" parameter of the
1236 * callback. We need to be able to handle both cases here, hence the
1237 * test for "key" != NULL before the event match test.
1238 */
Al Viro3ad6f932017-07-03 20:14:56 -04001239 if (pollflags && !(pollflags & epi->event.events))
Davide Libenzi2dfa4ee2009-03-31 15:24:22 -07001240 goto out_unlock;
1241
1242 /*
Daniel Balutabf6a41d2011-01-30 23:42:29 +02001243 * If we are transferring events to userspace, we can hold no locks
Davide Libenzid47de162007-05-15 01:40:41 -07001244 * (because we're accessing user memory, and because of linux f_op->poll()
Daniel Balutabf6a41d2011-01-30 23:42:29 +02001245 * semantics). All the events that happen during that period of time are
Davide Libenzid47de162007-05-15 01:40:41 -07001246 * chained in ep->ovflist and requeued later on.
1247 */
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001248 if (READ_ONCE(ep->ovflist) != EP_UNACTIVE_PTR) {
Khazhismel Kumykovee922a22020-05-07 18:35:59 -07001249 if (chain_epi_lockless(epi))
Roman Penyaevc3e320b2019-03-07 16:28:49 -08001250 ep_pm_stay_awake_rcu(epi);
Khazhismel Kumykovee922a22020-05-07 18:35:59 -07001251 } else if (!ep_is_linked(epi)) {
1252 /* In the usual case, add event to ready list. */
1253 if (list_add_tail_lockless(&epi->rdllink, &ep->rdllist))
1254 ep_pm_stay_awake_rcu(epi);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001255 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07001256
Davide Libenzi7699acd2007-05-10 22:23:23 -07001257 /*
1258 * Wake up ( if active ) both the eventpoll wait list and the ->poll()
1259 * wait list.
1260 */
Jason Barondf0108c2016-01-20 14:59:24 -08001261 if (waitqueue_active(&ep->wq)) {
Jason Baronb6a515c2016-02-05 15:37:04 -08001262 if ((epi->event.events & EPOLLEXCLUSIVE) &&
Al Viro3ad6f932017-07-03 20:14:56 -04001263 !(pollflags & POLLFREE)) {
1264 switch (pollflags & EPOLLINOUT_BITS) {
Linus Torvaldsa9a08842018-02-11 14:34:03 -08001265 case EPOLLIN:
1266 if (epi->event.events & EPOLLIN)
Jason Baronb6a515c2016-02-05 15:37:04 -08001267 ewake = 1;
1268 break;
Linus Torvaldsa9a08842018-02-11 14:34:03 -08001269 case EPOLLOUT:
1270 if (epi->event.events & EPOLLOUT)
Jason Baronb6a515c2016-02-05 15:37:04 -08001271 ewake = 1;
1272 break;
1273 case 0:
1274 ewake = 1;
1275 break;
1276 }
1277 }
Roman Penyaeva218cc42019-03-07 16:28:53 -08001278 wake_up(&ep->wq);
Jason Barondf0108c2016-01-20 14:59:24 -08001279 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07001280 if (waitqueue_active(&ep->poll_wait))
1281 pwake++;
1282
Davide Libenzid47de162007-05-15 01:40:41 -07001283out_unlock:
Roman Penyaeva218cc42019-03-07 16:28:53 -08001284 read_unlock_irqrestore(&ep->lock, flags);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001285
1286 /* We have to call this outside the lock */
1287 if (pwake)
Davide Libenzi5071f972009-03-31 15:24:10 -07001288 ep_poll_safewake(&ep->poll_wait);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001289
Oleg Nesterov138e4ad2017-09-01 18:55:33 +02001290 if (!(epi->event.events & EPOLLEXCLUSIVE))
1291 ewake = 1;
Jason Barondf0108c2016-01-20 14:59:24 -08001292
Al Viro3ad6f932017-07-03 20:14:56 -04001293 if (pollflags & POLLFREE) {
Oleg Nesterov138e4ad2017-09-01 18:55:33 +02001294 /*
1295 * If we race with ep_remove_wait_queue() it can miss
1296 * ->whead = NULL and do another remove_wait_queue() after
1297 * us, so we can't use __remove_wait_queue().
1298 */
1299 list_del_init(&wait->entry);
1300 /*
1301 * ->whead != NULL protects us from the race with ep_free()
1302 * or ep_remove(), ep_remove_wait_queue() takes whead->lock
1303 * held by the caller. Once we nullify it, nothing protects
1304 * ep/epi or even wait.
1305 */
1306 smp_store_release(&ep_pwq_from_wait(wait)->whead, NULL);
1307 }
1308
1309 return ewake;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001310}
1311
Linus Torvalds1da177e2005-04-16 15:20:36 -07001312/*
1313 * This is the callback that is used to add our wait queue to the
1314 * target file wakeup lists.
1315 */
1316static void ep_ptable_queue_proc(struct file *file, wait_queue_head_t *whead,
1317 poll_table *pt)
1318{
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001319 struct epitem *epi = ep_item_from_epqueue(pt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320 struct eppoll_entry *pwq;
1321
Christoph Lametere94b1762006-12-06 20:33:17 -08001322 if (epi->nwait >= 0 && (pwq = kmem_cache_alloc(pwq_cache, GFP_KERNEL))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323 init_waitqueue_func_entry(&pwq->wait, ep_poll_callback);
1324 pwq->whead = whead;
1325 pwq->base = epi;
Jason Barondf0108c2016-01-20 14:59:24 -08001326 if (epi->event.events & EPOLLEXCLUSIVE)
1327 add_wait_queue_exclusive(whead, &pwq->wait);
1328 else
1329 add_wait_queue(whead, &pwq->wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330 list_add_tail(&pwq->llink, &epi->pwqlist);
1331 epi->nwait++;
Davide Libenzi296e2362009-03-31 15:24:11 -07001332 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333 /* We have to signal that an error occurred */
1334 epi->nwait = -1;
Davide Libenzi296e2362009-03-31 15:24:11 -07001335 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001336}
1337
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338static void ep_rbtree_insert(struct eventpoll *ep, struct epitem *epi)
1339{
1340 int kcmp;
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001341 struct rb_node **p = &ep->rbr.rb_root.rb_node, *parent = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001342 struct epitem *epic;
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001343 bool leftmost = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001344
1345 while (*p) {
1346 parent = *p;
1347 epic = rb_entry(parent, struct epitem, rbn);
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001348 kcmp = ep_cmp_ffd(&epi->ffd, &epic->ffd);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001349 if (kcmp > 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001350 p = &parent->rb_right;
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001351 leftmost = false;
1352 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -07001353 p = &parent->rb_left;
1354 }
1355 rb_link_node(&epi->rbn, parent, p);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001356 rb_insert_color_cached(&epi->rbn, &ep->rbr, leftmost);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001357}
1358
Andrew Mortona80a6b82012-11-08 15:53:35 -08001359
1360
Jason Baron28d82dc2012-01-12 17:17:43 -08001361#define PATH_ARR_SIZE 5
1362/*
1363 * These are the number paths of length 1 to 5, that we are allowing to emanate
1364 * from a single file of interest. For example, we allow 1000 paths of length
1365 * 1, to emanate from each file of interest. This essentially represents the
1366 * potential wakeup paths, which need to be limited in order to avoid massive
1367 * uncontrolled wakeup storms. The common use case should be a single ep which
1368 * is connected to n file sources. In this case each file source has 1 path
1369 * of length 1. Thus, the numbers below should be more than sufficient. These
1370 * path limits are enforced during an EPOLL_CTL_ADD operation, since a modify
1371 * and delete can't add additional paths. Protected by the epmutex.
1372 */
1373static const int path_limits[PATH_ARR_SIZE] = { 1000, 500, 100, 50, 10 };
1374static int path_count[PATH_ARR_SIZE];
1375
1376static int path_count_inc(int nests)
1377{
Jason Baron93dc6102012-03-16 16:34:03 -04001378 /* Allow an arbitrary number of depth 1 paths */
1379 if (nests == 0)
1380 return 0;
1381
Jason Baron28d82dc2012-01-12 17:17:43 -08001382 if (++path_count[nests] > path_limits[nests])
1383 return -1;
1384 return 0;
1385}
1386
1387static void path_count_init(void)
1388{
1389 int i;
1390
1391 for (i = 0; i < PATH_ARR_SIZE; i++)
1392 path_count[i] = 0;
1393}
1394
1395static int reverse_path_check_proc(void *priv, void *cookie, int call_nests)
1396{
1397 int error = 0;
1398 struct file *file = priv;
1399 struct file *child_file;
1400 struct epitem *epi;
1401
Jason Baronae10b2b2013-11-12 15:10:16 -08001402 /* CTL_DEL can remove links here, but that can't increase our count */
1403 rcu_read_lock();
1404 list_for_each_entry_rcu(epi, &file->f_ep_links, fllink) {
Jason Baron28d82dc2012-01-12 17:17:43 -08001405 child_file = epi->ep->file;
1406 if (is_file_epoll(child_file)) {
1407 if (list_empty(&child_file->f_ep_links)) {
1408 if (path_count_inc(call_nests)) {
1409 error = -1;
1410 break;
1411 }
1412 } else {
1413 error = ep_call_nested(&poll_loop_ncalls,
Jason Baron28d82dc2012-01-12 17:17:43 -08001414 reverse_path_check_proc,
1415 child_file, child_file,
1416 current);
1417 }
1418 if (error != 0)
1419 break;
1420 } else {
1421 printk(KERN_ERR "reverse_path_check_proc: "
1422 "file is not an ep!\n");
1423 }
1424 }
Jason Baronae10b2b2013-11-12 15:10:16 -08001425 rcu_read_unlock();
Jason Baron28d82dc2012-01-12 17:17:43 -08001426 return error;
1427}
1428
1429/**
1430 * reverse_path_check - The tfile_check_list is list of file *, which have
1431 * links that are proposed to be newly added. We need to
1432 * make sure that those added links don't add too many
1433 * paths such that we will spend all our time waking up
1434 * eventpoll objects.
1435 *
1436 * Returns: Returns zero if the proposed links don't create too many paths,
1437 * -1 otherwise.
1438 */
1439static int reverse_path_check(void)
1440{
Jason Baron28d82dc2012-01-12 17:17:43 -08001441 int error = 0;
1442 struct file *current_file;
1443
1444 /* let's call this for all tfiles */
1445 list_for_each_entry(current_file, &tfile_check_list, f_tfile_llink) {
Jason Baron28d82dc2012-01-12 17:17:43 -08001446 path_count_init();
Davidlohr Bueso74bdc122019-01-03 15:27:02 -08001447 error = ep_call_nested(&poll_loop_ncalls,
Jason Baron28d82dc2012-01-12 17:17:43 -08001448 reverse_path_check_proc, current_file,
1449 current_file, current);
1450 if (error)
1451 break;
1452 }
1453 return error;
1454}
1455
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001456static int ep_create_wakeup_source(struct epitem *epi)
1457{
1458 const char *name;
Eric Wongeea1d582013-04-30 15:27:39 -07001459 struct wakeup_source *ws;
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001460
1461 if (!epi->ep->ws) {
Tri Voc8377ad2019-08-06 18:48:46 -07001462 epi->ep->ws = wakeup_source_register(NULL, "eventpoll");
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001463 if (!epi->ep->ws)
1464 return -ENOMEM;
1465 }
1466
1467 name = epi->ffd.file->f_path.dentry->d_name.name;
Tri Voc8377ad2019-08-06 18:48:46 -07001468 ws = wakeup_source_register(NULL, name);
Eric Wongeea1d582013-04-30 15:27:39 -07001469
1470 if (!ws)
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001471 return -ENOMEM;
Eric Wongeea1d582013-04-30 15:27:39 -07001472 rcu_assign_pointer(epi->ws, ws);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001473
1474 return 0;
1475}
1476
Eric Wongeea1d582013-04-30 15:27:39 -07001477/* rare code path, only used when EPOLL_CTL_MOD removes a wakeup source */
1478static noinline void ep_destroy_wakeup_source(struct epitem *epi)
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001479{
Eric Wongeea1d582013-04-30 15:27:39 -07001480 struct wakeup_source *ws = ep_wakeup_source(epi);
1481
Eric Wongd6d67e72013-04-30 15:27:43 -07001482 RCU_INIT_POINTER(epi->ws, NULL);
Eric Wongeea1d582013-04-30 15:27:39 -07001483
1484 /*
1485 * wait for ep_pm_stay_awake_rcu to finish, synchronize_rcu is
1486 * used internally by wakeup_source_remove, too (called by
1487 * wakeup_source_unregister), so we cannot use call_rcu
1488 */
1489 synchronize_rcu();
1490 wakeup_source_unregister(ws);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001491}
1492
Davide Libenzic7ea7632007-05-15 01:40:47 -07001493/*
1494 * Must be called with "mtx" held.
1495 */
Al Virobec1a5022017-11-28 19:43:33 -05001496static int ep_insert(struct eventpoll *ep, const struct epoll_event *event,
Jason Baron67347fe2013-11-12 15:10:18 -08001497 struct file *tfile, int fd, int full_check)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001498{
Al Virod85e2aa2018-02-01 15:24:58 -05001499 int error, pwake = 0;
1500 __poll_t revents;
Robin Holt52bd19f72011-01-12 17:00:01 -08001501 long user_watches;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001502 struct epitem *epi;
1503 struct ep_pqueue epq;
1504
Davidlohr Bueso92e64172018-08-21 21:56:45 -07001505 lockdep_assert_irqs_enabled();
1506
Robin Holt52bd19f72011-01-12 17:00:01 -08001507 user_watches = atomic_long_read(&ep->user->epoll_watches);
1508 if (unlikely(user_watches >= max_user_watches))
Davide Libenzi7ef99642008-12-01 13:13:55 -08001509 return -ENOSPC;
Christoph Lametere94b1762006-12-06 20:33:17 -08001510 if (!(epi = kmem_cache_alloc(epi_cache, GFP_KERNEL)))
Davide Libenzi7ef99642008-12-01 13:13:55 -08001511 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001512
1513 /* Item initialization follow here ... */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001514 INIT_LIST_HEAD(&epi->rdllink);
1515 INIT_LIST_HEAD(&epi->fllink);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001516 INIT_LIST_HEAD(&epi->pwqlist);
1517 epi->ep = ep;
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001518 ep_set_ffd(&epi->ffd, tfile, fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001519 epi->event = *event;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001520 epi->nwait = 0;
Davide Libenzid47de162007-05-15 01:40:41 -07001521 epi->next = EP_UNACTIVE_PTR;
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001522 if (epi->event.events & EPOLLWAKEUP) {
1523 error = ep_create_wakeup_source(epi);
1524 if (error)
1525 goto error_create_wakeup_source;
1526 } else {
Eric Wongeea1d582013-04-30 15:27:39 -07001527 RCU_INIT_POINTER(epi->ws, NULL);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001528 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001529
1530 /* Initialize the poll table using the queue callback */
1531 epq.epi = epi;
1532 init_poll_funcptr(&epq.pt, ep_ptable_queue_proc);
1533
1534 /*
1535 * Attach the item to the poll hooks and get current event bits.
1536 * We can safely use the file* here because its usage count has
Davide Libenzic7ea7632007-05-15 01:40:47 -07001537 * been increased by the caller of this function. Note that after
1538 * this operation completes, the poll callback can start hitting
1539 * the new item.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001540 */
Jason Baron37b5e522017-11-17 15:29:06 -08001541 revents = ep_item_poll(epi, &epq.pt, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001542
1543 /*
1544 * We have to check if something went wrong during the poll wait queue
1545 * install process. Namely an allocation for a wait queue failed due
1546 * high memory pressure.
1547 */
Davide Libenzi7ef99642008-12-01 13:13:55 -08001548 error = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001549 if (epi->nwait < 0)
Davide Libenzi7699acd2007-05-10 22:23:23 -07001550 goto error_unregister;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001551
1552 /* Add the current item to the list of active epoll hook for this file */
Jonathan Corbet68499912009-02-06 13:52:43 -07001553 spin_lock(&tfile->f_lock);
Jason Baronae10b2b2013-11-12 15:10:16 -08001554 list_add_tail_rcu(&epi->fllink, &tfile->f_ep_links);
Jonathan Corbet68499912009-02-06 13:52:43 -07001555 spin_unlock(&tfile->f_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001556
Davide Libenzic7ea7632007-05-15 01:40:47 -07001557 /*
1558 * Add the current item to the RB tree. All RB tree operations are
1559 * protected by "mtx", and ep_insert() is called with "mtx" held.
1560 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001561 ep_rbtree_insert(ep, epi);
1562
Jason Baron28d82dc2012-01-12 17:17:43 -08001563 /* now check if we've created too many backpaths */
1564 error = -EINVAL;
Jason Baron67347fe2013-11-12 15:10:18 -08001565 if (full_check && reverse_path_check())
Jason Baron28d82dc2012-01-12 17:17:43 -08001566 goto error_remove_epi;
1567
Davide Libenzic7ea7632007-05-15 01:40:47 -07001568 /* We have to drop the new item inside our item list to keep track of it */
Roman Penyaeva218cc42019-03-07 16:28:53 -08001569 write_lock_irq(&ep->lock);
Davide Libenzic7ea7632007-05-15 01:40:47 -07001570
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -07001571 /* record NAPI ID of new item if present */
1572 ep_set_busy_poll_napi_id(epi);
1573
Linus Torvalds1da177e2005-04-16 15:20:36 -07001574 /* If the file is already "ready" we drop it inside the ready list */
Davidlohr Bueso992991c2018-08-21 21:58:26 -07001575 if (revents && !ep_is_linked(epi)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576 list_add_tail(&epi->rdllink, &ep->rdllist);
Eric Wongeea1d582013-04-30 15:27:39 -07001577 ep_pm_stay_awake(epi);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001578
1579 /* Notify waiting tasks that events are available */
1580 if (waitqueue_active(&ep->wq))
Roman Penyaeva218cc42019-03-07 16:28:53 -08001581 wake_up(&ep->wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001582 if (waitqueue_active(&ep->poll_wait))
1583 pwake++;
1584 }
1585
Roman Penyaeva218cc42019-03-07 16:28:53 -08001586 write_unlock_irq(&ep->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001587
Robin Holt52bd19f72011-01-12 17:00:01 -08001588 atomic_long_inc(&ep->user->epoll_watches);
Davide Libenzi7ef99642008-12-01 13:13:55 -08001589
Linus Torvalds1da177e2005-04-16 15:20:36 -07001590 /* We have to call this outside the lock */
1591 if (pwake)
Davide Libenzi5071f972009-03-31 15:24:10 -07001592 ep_poll_safewake(&ep->poll_wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001593
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594 return 0;
1595
Jason Baron28d82dc2012-01-12 17:17:43 -08001596error_remove_epi:
1597 spin_lock(&tfile->f_lock);
Jason Baronae10b2b2013-11-12 15:10:16 -08001598 list_del_rcu(&epi->fllink);
Jason Baron28d82dc2012-01-12 17:17:43 -08001599 spin_unlock(&tfile->f_lock);
1600
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001601 rb_erase_cached(&epi->rbn, &ep->rbr);
Jason Baron28d82dc2012-01-12 17:17:43 -08001602
Davide Libenzi7699acd2007-05-10 22:23:23 -07001603error_unregister:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001604 ep_unregister_pollwait(ep, epi);
1605
1606 /*
1607 * We need to do this because an event could have been arrived on some
Davide Libenzi67647d02007-05-15 01:40:52 -07001608 * allocated wait queue. Note that we don't care about the ep->ovflist
1609 * list, since that is used/cleaned only inside a section bound by "mtx".
1610 * And ep_insert() is called with "mtx" held.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001611 */
Roman Penyaeva218cc42019-03-07 16:28:53 -08001612 write_lock_irq(&ep->lock);
Davidlohr Bueso992991c2018-08-21 21:58:26 -07001613 if (ep_is_linked(epi))
Davide Libenzi6192bd52007-05-08 00:25:41 -07001614 list_del_init(&epi->rdllink);
Roman Penyaeva218cc42019-03-07 16:28:53 -08001615 write_unlock_irq(&ep->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001616
Eric Wongeea1d582013-04-30 15:27:39 -07001617 wakeup_source_unregister(ep_wakeup_source(epi));
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001618
1619error_create_wakeup_source:
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001620 kmem_cache_free(epi_cache, epi);
Davide Libenzi7ef99642008-12-01 13:13:55 -08001621
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622 return error;
1623}
1624
Linus Torvalds1da177e2005-04-16 15:20:36 -07001625/*
1626 * Modify the interest event mask by dropping an event if the new mask
Davide Libenzic7ea7632007-05-15 01:40:47 -07001627 * has a match in the current file status. Must be called with "mtx" held.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628 */
Al Virobec1a5022017-11-28 19:43:33 -05001629static int ep_modify(struct eventpoll *ep, struct epitem *epi,
1630 const struct epoll_event *event)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001631{
1632 int pwake = 0;
Hans Verkuil626cf232012-03-23 15:02:27 -07001633 poll_table pt;
1634
Davidlohr Bueso92e64172018-08-21 21:56:45 -07001635 lockdep_assert_irqs_enabled();
1636
Hans Verkuil626cf232012-03-23 15:02:27 -07001637 init_poll_funcptr(&pt, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638
1639 /*
Tony Battersbye057e152009-03-31 15:24:15 -07001640 * Set the new event interest mask before calling f_op->poll();
1641 * otherwise we might miss an event that happens between the
1642 * f_op->poll() call and the new event set registering.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643 */
Eric Wong128dd172013-01-01 21:20:27 +00001644 epi->event.events = event->events; /* need barrier below */
Tony Battersbye057e152009-03-31 15:24:15 -07001645 epi->event.data = event->data; /* protected by mtx */
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001646 if (epi->event.events & EPOLLWAKEUP) {
Eric Wongeea1d582013-04-30 15:27:39 -07001647 if (!ep_has_wakeup_source(epi))
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001648 ep_create_wakeup_source(epi);
Eric Wongeea1d582013-04-30 15:27:39 -07001649 } else if (ep_has_wakeup_source(epi)) {
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001650 ep_destroy_wakeup_source(epi);
1651 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001652
1653 /*
Eric Wong128dd172013-01-01 21:20:27 +00001654 * The following barrier has two effects:
1655 *
1656 * 1) Flush epi changes above to other CPUs. This ensures
1657 * we do not miss events from ep_poll_callback if an
1658 * event occurs immediately after we call f_op->poll().
Roman Penyaeva218cc42019-03-07 16:28:53 -08001659 * We need this because we did not take ep->lock while
Eric Wong128dd172013-01-01 21:20:27 +00001660 * changing epi above (but ep_poll_callback does take
Roman Penyaeva218cc42019-03-07 16:28:53 -08001661 * ep->lock).
Eric Wong128dd172013-01-01 21:20:27 +00001662 *
1663 * 2) We also need to ensure we do not miss _past_ events
1664 * when calling f_op->poll(). This barrier also
1665 * pairs with the barrier in wq_has_sleeper (see
1666 * comments for wq_has_sleeper).
1667 *
1668 * This barrier will now guarantee ep_poll_callback or f_op->poll
1669 * (or both) will notice the readiness of an item.
1670 */
1671 smp_mb();
1672
1673 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001674 * Get current event bits. We can safely use the file* here because
1675 * its usage count has been increased by the caller of this function.
Davide Libenzic7ea7632007-05-15 01:40:47 -07001676 * If the item is "hot" and it is not registered inside the ready
Davide Libenzi67647d02007-05-15 01:40:52 -07001677 * list, push it inside.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001678 */
Al Viro69112732017-11-28 19:56:15 -05001679 if (ep_item_poll(epi, &pt, 1)) {
Roman Penyaeva218cc42019-03-07 16:28:53 -08001680 write_lock_irq(&ep->lock);
Davidlohr Bueso992991c2018-08-21 21:58:26 -07001681 if (!ep_is_linked(epi)) {
Davide Libenzic7ea7632007-05-15 01:40:47 -07001682 list_add_tail(&epi->rdllink, &ep->rdllist);
Eric Wongeea1d582013-04-30 15:27:39 -07001683 ep_pm_stay_awake(epi);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001684
Davide Libenzic7ea7632007-05-15 01:40:47 -07001685 /* Notify waiting tasks that events are available */
1686 if (waitqueue_active(&ep->wq))
Roman Penyaeva218cc42019-03-07 16:28:53 -08001687 wake_up(&ep->wq);
Davide Libenzic7ea7632007-05-15 01:40:47 -07001688 if (waitqueue_active(&ep->poll_wait))
1689 pwake++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001690 }
Roman Penyaeva218cc42019-03-07 16:28:53 -08001691 write_unlock_irq(&ep->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001692 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001693
1694 /* We have to call this outside the lock */
1695 if (pwake)
Davide Libenzi5071f972009-03-31 15:24:10 -07001696 ep_poll_safewake(&ep->poll_wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001697
1698 return 0;
1699}
1700
Al Virod85e2aa2018-02-01 15:24:58 -05001701static __poll_t ep_send_events_proc(struct eventpoll *ep, struct list_head *head,
Davide Libenzi296e2362009-03-31 15:24:11 -07001702 void *priv)
Davide Libenzi5071f972009-03-31 15:24:10 -07001703{
1704 struct ep_send_events_data *esed = priv;
Al Virod85e2aa2018-02-01 15:24:58 -05001705 __poll_t revents;
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001706 struct epitem *epi, *tmp;
1707 struct epoll_event __user *uevent = esed->events;
Eric Wongeea1d582013-04-30 15:27:39 -07001708 struct wakeup_source *ws;
Hans Verkuil626cf232012-03-23 15:02:27 -07001709 poll_table pt;
1710
1711 init_poll_funcptr(&pt, NULL);
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001712 esed->res = 0;
Davide Libenzi5071f972009-03-31 15:24:10 -07001713
Davide Libenzi296e2362009-03-31 15:24:11 -07001714 /*
Davide Libenzi5071f972009-03-31 15:24:10 -07001715 * We can loop without lock because we are passed a task private list.
1716 * Items cannot vanish during the loop because ep_scan_ready_list() is
1717 * holding "mtx" during this call.
Davide Libenzi296e2362009-03-31 15:24:11 -07001718 */
Davidlohr Bueso21877e12019-01-03 15:27:12 -08001719 lockdep_assert_held(&ep->mtx);
1720
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001721 list_for_each_entry_safe(epi, tmp, head, rdllink) {
1722 if (esed->res >= esed->maxevents)
1723 break;
Davide Libenzi5071f972009-03-31 15:24:10 -07001724
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001725 /*
1726 * Activate ep->ws before deactivating epi->ws to prevent
1727 * triggering auto-suspend here (in case we reactive epi->ws
1728 * below).
1729 *
1730 * This could be rearranged to delay the deactivation of epi->ws
1731 * instead, but then epi->ws would temporarily be out of sync
1732 * with ep_is_linked().
1733 */
Eric Wongeea1d582013-04-30 15:27:39 -07001734 ws = ep_wakeup_source(epi);
1735 if (ws) {
1736 if (ws->active)
1737 __pm_stay_awake(ep->ws);
1738 __pm_relax(ws);
1739 }
1740
Davide Libenzi5071f972009-03-31 15:24:10 -07001741 list_del_init(&epi->rdllink);
1742
Davide Libenzi296e2362009-03-31 15:24:11 -07001743 /*
Davide Libenzi5071f972009-03-31 15:24:10 -07001744 * If the event mask intersect the caller-requested one,
1745 * deliver the event to userspace. Again, ep_scan_ready_list()
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001746 * is holding ep->mtx, so no operations coming from userspace
Davide Libenzi5071f972009-03-31 15:24:10 -07001747 * can change the item.
Davide Libenzi296e2362009-03-31 15:24:11 -07001748 */
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001749 revents = ep_item_poll(epi, &pt, 1);
1750 if (!revents)
1751 continue;
1752
1753 if (__put_user(revents, &uevent->events) ||
1754 __put_user(epi->event.data, &uevent->data)) {
1755 list_add(&epi->rdllink, head);
1756 ep_pm_stay_awake(epi);
1757 if (!esed->res)
1758 esed->res = -EFAULT;
1759 return 0;
1760 }
1761 esed->res++;
1762 uevent++;
1763 if (epi->event.events & EPOLLONESHOT)
1764 epi->event.events &= EP_PRIVATE_BITS;
1765 else if (!(epi->event.events & EPOLLET)) {
1766 /*
1767 * If this file has been added with Level
1768 * Trigger mode, we need to insert back inside
1769 * the ready list, so that the next call to
1770 * epoll_wait() will check again the events
1771 * availability. At this point, no one can insert
1772 * into ep->rdllist besides us. The epoll_ctl()
1773 * callers are locked out by
1774 * ep_scan_ready_list() holding "mtx" and the
1775 * poll callback will queue them in ep->ovflist.
1776 */
1777 list_add_tail(&epi->rdllink, &ep->rdllist);
1778 ep_pm_stay_awake(epi);
Davide Libenzi296e2362009-03-31 15:24:11 -07001779 }
1780 }
Davide Libenzi5071f972009-03-31 15:24:10 -07001781
Al Virod7ebbe42018-02-01 15:21:13 -05001782 return 0;
Davide Libenzi5071f972009-03-31 15:24:10 -07001783}
1784
Davide Libenzi296e2362009-03-31 15:24:11 -07001785static int ep_send_events(struct eventpoll *ep,
1786 struct epoll_event __user *events, int maxevents)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001787{
Davide Libenzi5071f972009-03-31 15:24:10 -07001788 struct ep_send_events_data esed;
Davide Libenzi6192bd52007-05-08 00:25:41 -07001789
Davide Libenzi5071f972009-03-31 15:24:10 -07001790 esed.maxevents = maxevents;
1791 esed.events = events;
Davide Libenzid47de162007-05-15 01:40:41 -07001792
Al Virod7ebbe42018-02-01 15:21:13 -05001793 ep_scan_ready_list(ep, ep_send_events_proc, &esed, 0, false);
1794 return esed.res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001795}
1796
Deepa Dinamani766b9f92016-05-19 17:09:05 -07001797static inline struct timespec64 ep_set_mstimeout(long ms)
Eric Dumazet0781b902011-02-01 15:52:35 -08001798{
Deepa Dinamani766b9f92016-05-19 17:09:05 -07001799 struct timespec64 now, ts = {
Eric Dumazet0781b902011-02-01 15:52:35 -08001800 .tv_sec = ms / MSEC_PER_SEC,
1801 .tv_nsec = NSEC_PER_MSEC * (ms % MSEC_PER_SEC),
1802 };
1803
Deepa Dinamani766b9f92016-05-19 17:09:05 -07001804 ktime_get_ts64(&now);
1805 return timespec64_add_safe(now, ts);
Eric Dumazet0781b902011-02-01 15:52:35 -08001806}
1807
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001808/**
1809 * ep_poll - Retrieves ready events, and delivers them to the caller supplied
1810 * event buffer.
1811 *
1812 * @ep: Pointer to the eventpoll context.
1813 * @events: Pointer to the userspace buffer where the ready events should be
1814 * stored.
1815 * @maxevents: Size (in terms of number of events) of the caller event buffer.
1816 * @timeout: Maximum timeout for the ready events fetch operation, in
1817 * milliseconds. If the @timeout is zero, the function will not block,
1818 * while if the @timeout is less than zero, the function will block
1819 * until at least one event has been retrieved (or an error
1820 * occurred).
1821 *
1822 * Returns: Returns the number of ready events which have been fetched, or an
1823 * error code, in case of error.
1824 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001825static int ep_poll(struct eventpoll *ep, struct epoll_event __user *events,
1826 int maxevents, long timeout)
1827{
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001828 int res = 0, eavail, timed_out = 0;
John Stultzda8b44d2016-03-17 14:20:51 -07001829 u64 slack = 0;
Ingo Molnarac6424b2017-06-20 12:06:13 +02001830 wait_queue_entry_t wait;
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001831 ktime_t expires, *to = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001832
Davidlohr Bueso679abf32018-08-21 21:58:23 -07001833 lockdep_assert_irqs_enabled();
1834
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001835 if (timeout > 0) {
Deepa Dinamani766b9f92016-05-19 17:09:05 -07001836 struct timespec64 end_time = ep_set_mstimeout(timeout);
Eric Dumazet0781b902011-02-01 15:52:35 -08001837
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001838 slack = select_estimate_accuracy(&end_time);
1839 to = &expires;
Deepa Dinamani766b9f92016-05-19 17:09:05 -07001840 *to = timespec64_to_ktime(end_time);
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001841 } else if (timeout == 0) {
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001842 /*
1843 * Avoid the unnecessary trip to the wait queue loop, if the
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001844 * caller specified a non blocking operation. We still need
1845 * lock because we could race and not see an epi being added
1846 * to the ready list while in irq callback. Thus incorrectly
1847 * returning 0 back to userspace.
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001848 */
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001849 timed_out = 1;
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001850
Roman Penyaeva218cc42019-03-07 16:28:53 -08001851 write_lock_irq(&ep->lock);
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001852 eavail = ep_events_available(ep);
Roman Penyaeva218cc42019-03-07 16:28:53 -08001853 write_unlock_irq(&ep->lock);
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001854
Davidlohr Bueso35cff1a2019-01-03 15:27:22 -08001855 goto send_events;
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001856 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001857
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001858fetch_events:
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -07001859
1860 if (!ep_events_available(ep))
1861 ep_busy_loop(ep, timed_out);
1862
Davide Libenzi3fb0e582011-03-22 16:34:46 -07001863 eavail = ep_events_available(ep);
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001864 if (eavail)
Davidlohr Bueso35cff1a2019-01-03 15:27:22 -08001865 goto send_events;
Jason Baron28d82dc2012-01-12 17:17:43 -08001866
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001867 /*
1868 * Busy poll timed out. Drop NAPI ID for now, we can add
1869 * it back in when we have moved a socket with a valid NAPI
1870 * ID onto the ready list.
1871 */
1872 ep_reset_busy_poll_napi_id(ep);
Jason Baron28d82dc2012-01-12 17:17:43 -08001873
Roman Penyaev5d776312020-05-07 18:36:16 -07001874 do {
1875 /*
1876 * Internally init_wait() uses autoremove_wake_function(),
1877 * thus wait entry is removed from the wait queue on each
1878 * wakeup. Why it is important? In case of several waiters
1879 * each new wakeup will hit the next waiter, giving it the
1880 * chance to harvest new event. Otherwise wakeup can be
1881 * lost. This is also good performance-wise, because on
1882 * normal wakeup path no need to call __remove_wait_queue()
1883 * explicitly, thus ep->lock is not taken, which halts the
1884 * event delivery.
1885 */
1886 init_wait(&wait);
Roman Penyaev8e709bb2020-03-21 18:22:30 -07001887 write_lock_irq(&ep->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001888 __add_wait_queue_exclusive(&ep->wq, &wait);
Roman Penyaev8e709bb2020-03-21 18:22:30 -07001889 write_unlock_irq(&ep->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001890
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001891 /*
1892 * We don't want to sleep if the ep_poll_callback() sends us
1893 * a wakeup in between. That's why we set the task state
1894 * to TASK_INTERRUPTIBLE before doing the checks.
1895 */
1896 set_current_state(TASK_INTERRUPTIBLE);
1897 /*
1898 * Always short-circuit for fatal signals to allow
1899 * threads to make a timely exit without the chance of
1900 * finding more events available and fetching
1901 * repeatedly.
1902 */
1903 if (fatal_signal_pending(current)) {
1904 res = -EINTR;
1905 break;
Davide Libenzi5071f972009-03-31 15:24:10 -07001906 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001907
Davidlohr Buesoabc610e2019-01-03 15:27:19 -08001908 eavail = ep_events_available(ep);
1909 if (eavail)
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001910 break;
1911 if (signal_pending(current)) {
1912 res = -EINTR;
1913 break;
1914 }
1915
Davidlohr Buesoabc610e2019-01-03 15:27:19 -08001916 if (!schedule_hrtimeout_range(to, slack, HRTIMER_MODE_ABS)) {
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001917 timed_out = 1;
Davidlohr Buesoabc610e2019-01-03 15:27:19 -08001918 break;
1919 }
Roman Penyaev5d776312020-05-07 18:36:16 -07001920
1921 /* We were woken up, thus go and try to harvest some events */
1922 eavail = 1;
1923
1924 } while (0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001925
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001926 __set_current_state(TASK_RUNNING);
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001927
Roman Penyaev5d776312020-05-07 18:36:16 -07001928 if (!list_empty_careful(&wait.entry)) {
1929 write_lock_irq(&ep->lock);
1930 __remove_wait_queue(&ep->wq, &wait);
1931 write_unlock_irq(&ep->lock);
1932 }
1933
Davidlohr Bueso35cff1a2019-01-03 15:27:22 -08001934send_events:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001935 /*
1936 * Try to transfer events to user space. In case we get 0 events and
1937 * there's still timeout left over, we go trying again in search of
1938 * more luck.
1939 */
Davide Libenzi22bacca2011-02-25 14:44:12 -08001940 if (!res && eavail &&
1941 !(res = ep_send_events(ep, events, maxevents)) && !timed_out)
1942 goto fetch_events;
1943
1944 return res;
1945}
1946
1947/**
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001948 * ep_loop_check_proc - Callback function to be passed to the @ep_call_nested()
Linus Torvalds1da177e2005-04-16 15:20:36 -07001949 * API, to verify that adding an epoll file inside another
1950 * epoll structure, does not violate the constraints, in
1951 * terms of closed loops, or too deep chains (which can
1952 * result in excessive stack usage).
Davide Libenzi22bacca2011-02-25 14:44:12 -08001953 *
1954 * @priv: Pointer to the epoll file to be currently checked.
1955 * @cookie: Original cookie for this call. This is the top-of-the-chain epoll
1956 * data structure pointer.
1957 * @call_nests: Current dept of the @ep_call_nested() call stack.
1958 *
1959 * Returns: Returns zero if adding the epoll @file inside current epoll
1960 * structure @ep does not violate the constraints, or -1 otherwise.
1961 */
1962static int ep_loop_check_proc(void *priv, void *cookie, int call_nests)
1963{
1964 int error = 0;
1965 struct file *file = priv;
1966 struct eventpoll *ep = file->private_data;
1967 struct eventpoll *ep_tovisit;
1968 struct rb_node *rbp;
1969 struct epitem *epi;
1970
1971 mutex_lock_nested(&ep->mtx, call_nests + 1);
1972 ep->visited = 1;
1973 list_add(&ep->visited_list_link, &visited_list);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001974 for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) {
Davide Libenzi22bacca2011-02-25 14:44:12 -08001975 epi = rb_entry(rbp, struct epitem, rbn);
Nelson Elhaged8805e62011-10-31 17:13:14 -07001976 if (unlikely(is_file_epoll(epi->ffd.file))) {
Davide Libenzi22bacca2011-02-25 14:44:12 -08001977 ep_tovisit = epi->ffd.file->private_data;
1978 if (ep_tovisit->visited)
1979 continue;
Davidlohr Bueso74bdc122019-01-03 15:27:02 -08001980 error = ep_call_nested(&poll_loop_ncalls,
Davide Libenzi22bacca2011-02-25 14:44:12 -08001981 ep_loop_check_proc, epi->ffd.file,
1982 ep_tovisit, current);
1983 if (error != 0)
1984 break;
Jason Baron28d82dc2012-01-12 17:17:43 -08001985 } else {
1986 /*
1987 * If we've reached a file that is not associated with
1988 * an ep, then we need to check if the newly added
1989 * links are going to add too many wakeup paths. We do
1990 * this by adding it to the tfile_check_list, if it's
1991 * not already there, and calling reverse_path_check()
1992 * during ep_insert().
1993 */
Marc Zyngierb158e912020-08-19 17:12:17 +01001994 if (list_empty(&epi->ffd.file->f_tfile_llink)) {
Al Viro88405cf2020-09-02 11:30:48 -04001995 if (get_file_rcu(epi->ffd.file))
1996 list_add(&epi->ffd.file->f_tfile_llink,
1997 &tfile_check_list);
Marc Zyngierb158e912020-08-19 17:12:17 +01001998 }
Davide Libenzi22bacca2011-02-25 14:44:12 -08001999 }
2000 }
2001 mutex_unlock(&ep->mtx);
2002
2003 return error;
2004}
2005
2006/**
2007 * ep_loop_check - Performs a check to verify that adding an epoll file (@file)
2008 * another epoll file (represented by @ep) does not create
2009 * closed loops or too deep chains.
2010 *
2011 * @ep: Pointer to the epoll private data structure.
2012 * @file: Pointer to the epoll file to be checked.
2013 *
2014 * Returns: Returns zero if adding the epoll @file inside current epoll
2015 * structure @ep does not violate the constraints, or -1 otherwise.
2016 */
2017static int ep_loop_check(struct eventpoll *ep, struct file *file)
2018{
Jason Baron28d82dc2012-01-12 17:17:43 -08002019 int ret;
2020 struct eventpoll *ep_cur, *ep_next;
2021
Davidlohr Bueso74bdc122019-01-03 15:27:02 -08002022 ret = ep_call_nested(&poll_loop_ncalls,
Davide Libenzi22bacca2011-02-25 14:44:12 -08002023 ep_loop_check_proc, file, ep, current);
Jason Baron28d82dc2012-01-12 17:17:43 -08002024 /* clear visited list */
2025 list_for_each_entry_safe(ep_cur, ep_next, &visited_list,
2026 visited_list_link) {
2027 ep_cur->visited = 0;
2028 list_del(&ep_cur->visited_list_link);
2029 }
2030 return ret;
2031}
2032
2033static void clear_tfile_check_list(void)
2034{
2035 struct file *file;
2036
2037 /* first clear the tfile_check_list */
2038 while (!list_empty(&tfile_check_list)) {
2039 file = list_first_entry(&tfile_check_list, struct file,
2040 f_tfile_llink);
2041 list_del_init(&file->f_tfile_llink);
Marc Zyngierb158e912020-08-19 17:12:17 +01002042 fput(file);
Jason Baron28d82dc2012-01-12 17:17:43 -08002043 }
2044 INIT_LIST_HEAD(&tfile_check_list);
Davide Libenzi22bacca2011-02-25 14:44:12 -08002045}
2046
Davide Libenzi7699acd2007-05-10 22:23:23 -07002047/*
Andrew Morton523723b2008-08-12 15:09:01 -07002048 * Open an eventpoll file descriptor.
Davide Libenzi7699acd2007-05-10 22:23:23 -07002049 */
Dominik Brodowski791eb222018-03-11 11:34:30 +01002050static int do_epoll_create(int flags)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002051{
Jason Baron28d82dc2012-01-12 17:17:43 -08002052 int error, fd;
Davide Libenzibb57c3e2009-03-31 15:24:12 -07002053 struct eventpoll *ep = NULL;
Jason Baron28d82dc2012-01-12 17:17:43 -08002054 struct file *file;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002055
Ulrich Dreppere38b36f2008-07-23 21:29:42 -07002056 /* Check the EPOLL_* constant for consistency. */
2057 BUILD_BUG_ON(EPOLL_CLOEXEC != O_CLOEXEC);
2058
Davide Libenzi296e2362009-03-31 15:24:11 -07002059 if (flags & ~EPOLL_CLOEXEC)
2060 return -EINVAL;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002061 /*
Davide Libenzibb57c3e2009-03-31 15:24:12 -07002062 * Create the internal data structure ("struct eventpoll").
Davide Libenzi7699acd2007-05-10 22:23:23 -07002063 */
Ulrich Drepper9fe5ad92008-07-23 21:29:43 -07002064 error = ep_alloc(&ep);
Davide Libenzibb57c3e2009-03-31 15:24:12 -07002065 if (error < 0)
2066 return error;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002067 /*
2068 * Creates all the items needed to setup an eventpoll file. That is,
Al Viro2030a422008-02-23 06:46:49 -05002069 * a file structure and a free file descriptor.
Davide Libenzi7699acd2007-05-10 22:23:23 -07002070 */
Jason Baron28d82dc2012-01-12 17:17:43 -08002071 fd = get_unused_fd_flags(O_RDWR | (flags & O_CLOEXEC));
2072 if (fd < 0) {
2073 error = fd;
2074 goto out_free_ep;
2075 }
2076 file = anon_inode_getfile("[eventpoll]", &eventpoll_fops, ep,
Roland Dreier628ff7c2009-12-18 09:41:24 -08002077 O_RDWR | (flags & O_CLOEXEC));
Jason Baron28d82dc2012-01-12 17:17:43 -08002078 if (IS_ERR(file)) {
2079 error = PTR_ERR(file);
2080 goto out_free_fd;
2081 }
Jason Baron28d82dc2012-01-12 17:17:43 -08002082 ep->file = file;
Al Viro98022742012-08-17 22:42:36 -04002083 fd_install(fd, file);
Jason Baron28d82dc2012-01-12 17:17:43 -08002084 return fd;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002085
Jason Baron28d82dc2012-01-12 17:17:43 -08002086out_free_fd:
2087 put_unused_fd(fd);
2088out_free_ep:
2089 ep_free(ep);
Davide Libenzibb57c3e2009-03-31 15:24:12 -07002090 return error;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002091}
2092
Dominik Brodowski791eb222018-03-11 11:34:30 +01002093SYSCALL_DEFINE1(epoll_create1, int, flags)
2094{
2095 return do_epoll_create(flags);
2096}
2097
Heiko Carstens5a8a82b2009-01-14 14:14:25 +01002098SYSCALL_DEFINE1(epoll_create, int, size)
Ulrich Dreppera0998b52008-07-23 21:29:27 -07002099{
Davide Libenzibfe38912009-05-12 13:19:44 -07002100 if (size <= 0)
Ulrich Drepper9fe5ad92008-07-23 21:29:43 -07002101 return -EINVAL;
2102
Dominik Brodowski791eb222018-03-11 11:34:30 +01002103 return do_epoll_create(0);
Ulrich Dreppera0998b52008-07-23 21:29:27 -07002104}
2105
Davide Libenzi7699acd2007-05-10 22:23:23 -07002106/*
2107 * The following function implements the controller interface for
2108 * the eventpoll file that enables the insertion/removal/change of
Davide Libenzi67647d02007-05-15 01:40:52 -07002109 * file descriptors inside the interest set.
Davide Libenzi7699acd2007-05-10 22:23:23 -07002110 */
Heiko Carstens5a8a82b2009-01-14 14:14:25 +01002111SYSCALL_DEFINE4(epoll_ctl, int, epfd, int, op, int, fd,
2112 struct epoll_event __user *, event)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002113{
2114 int error;
Jason Baron67347fe2013-11-12 15:10:18 -08002115 int full_check = 0;
Al Viro7e3fb582013-08-30 12:47:21 -04002116 struct fd f, tf;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002117 struct eventpoll *ep;
2118 struct epitem *epi;
2119 struct epoll_event epds;
Jason Baron67347fe2013-11-12 15:10:18 -08002120 struct eventpoll *tep = NULL;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002121
Davide Libenzi7699acd2007-05-10 22:23:23 -07002122 error = -EFAULT;
2123 if (ep_op_has_event(op) &&
2124 copy_from_user(&epds, event, sizeof(struct epoll_event)))
2125 goto error_return;
2126
Davide Libenzi7699acd2007-05-10 22:23:23 -07002127 error = -EBADF;
Al Viro7e3fb582013-08-30 12:47:21 -04002128 f = fdget(epfd);
2129 if (!f.file)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002130 goto error_return;
2131
2132 /* Get the "struct file *" for the target file */
Al Viro7e3fb582013-08-30 12:47:21 -04002133 tf = fdget(fd);
2134 if (!tf.file)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002135 goto error_fput;
2136
2137 /* The target file descriptor must support poll */
2138 error = -EPERM;
Christoph Hellwig9965ed172018-03-05 07:26:05 -08002139 if (!file_can_poll(tf.file))
Davide Libenzi7699acd2007-05-10 22:23:23 -07002140 goto error_tgt_fput;
2141
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02002142 /* Check if EPOLLWAKEUP is allowed */
Nicolas Ioossc680e412014-09-09 14:50:51 -07002143 if (ep_op_has_event(op))
2144 ep_take_care_of_epollwakeup(&epds);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02002145
Davide Libenzi7699acd2007-05-10 22:23:23 -07002146 /*
2147 * We have to check that the file structure underneath the file descriptor
2148 * the user passed to us _is_ an eventpoll file. And also we do not permit
2149 * adding an epoll file descriptor inside itself.
2150 */
2151 error = -EINVAL;
Al Viro7e3fb582013-08-30 12:47:21 -04002152 if (f.file == tf.file || !is_file_epoll(f.file))
Davide Libenzi7699acd2007-05-10 22:23:23 -07002153 goto error_tgt_fput;
2154
2155 /*
Jason Barondf0108c2016-01-20 14:59:24 -08002156 * epoll adds to the wakeup queue at EPOLL_CTL_ADD time only,
2157 * so EPOLLEXCLUSIVE is not allowed for a EPOLL_CTL_MOD operation.
2158 * Also, we do not currently supported nested exclusive wakeups.
2159 */
Cyrill Gorcunovc857ab62017-02-27 14:27:40 -08002160 if (ep_op_has_event(op) && (epds.events & EPOLLEXCLUSIVE)) {
Jason Baronb6a515c2016-02-05 15:37:04 -08002161 if (op == EPOLL_CTL_MOD)
2162 goto error_tgt_fput;
2163 if (op == EPOLL_CTL_ADD && (is_file_epoll(tf.file) ||
2164 (epds.events & ~EPOLLEXCLUSIVE_OK_BITS)))
2165 goto error_tgt_fput;
2166 }
Jason Barondf0108c2016-01-20 14:59:24 -08002167
2168 /*
Davide Libenzi7699acd2007-05-10 22:23:23 -07002169 * At this point it is safe to assume that the "private_data" contains
2170 * our own data structure.
2171 */
Al Viro7e3fb582013-08-30 12:47:21 -04002172 ep = f.file->private_data;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002173
Davide Libenzi22bacca2011-02-25 14:44:12 -08002174 /*
2175 * When we insert an epoll file descriptor, inside another epoll file
2176 * descriptor, there is the change of creating closed loops, which are
Jason Baron28d82dc2012-01-12 17:17:43 -08002177 * better be handled here, than in more critical paths. While we are
2178 * checking for loops we also determine the list of files reachable
2179 * and hang them on the tfile_check_list, so we can check that we
2180 * haven't created too many possible wakeup paths.
Davide Libenzi22bacca2011-02-25 14:44:12 -08002181 *
Jason Baron67347fe2013-11-12 15:10:18 -08002182 * We do not need to take the global 'epumutex' on EPOLL_CTL_ADD when
2183 * the epoll file descriptor is attaching directly to a wakeup source,
2184 * unless the epoll file descriptor is nested. The purpose of taking the
2185 * 'epmutex' on add is to prevent complex toplogies such as loops and
2186 * deep wakeup paths from forming in parallel through multiple
2187 * EPOLL_CTL_ADD operations.
Davide Libenzi22bacca2011-02-25 14:44:12 -08002188 */
Nelson Elhaged8805e62011-10-31 17:13:14 -07002189 mutex_lock_nested(&ep->mtx, 0);
Jason Baron67347fe2013-11-12 15:10:18 -08002190 if (op == EPOLL_CTL_ADD) {
2191 if (!list_empty(&f.file->f_ep_links) ||
2192 is_file_epoll(tf.file)) {
2193 full_check = 1;
2194 mutex_unlock(&ep->mtx);
2195 mutex_lock(&epmutex);
2196 if (is_file_epoll(tf.file)) {
2197 error = -ELOOP;
Al Viro42694912020-08-22 18:25:52 -04002198 if (ep_loop_check(ep, tf.file) != 0)
Jason Baron67347fe2013-11-12 15:10:18 -08002199 goto error_tgt_fput;
Marc Zyngierb158e912020-08-19 17:12:17 +01002200 } else {
2201 get_file(tf.file);
Jason Baron67347fe2013-11-12 15:10:18 -08002202 list_add(&tf.file->f_tfile_llink,
2203 &tfile_check_list);
Marc Zyngierb158e912020-08-19 17:12:17 +01002204 }
Jason Baron67347fe2013-11-12 15:10:18 -08002205 mutex_lock_nested(&ep->mtx, 0);
2206 if (is_file_epoll(tf.file)) {
2207 tep = tf.file->private_data;
2208 mutex_lock_nested(&tep->mtx, 1);
2209 }
2210 }
2211 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07002212
Davide Libenzi67647d02007-05-15 01:40:52 -07002213 /*
2214 * Try to lookup the file inside our RB tree, Since we grabbed "mtx"
2215 * above, we can be sure to be able to use the item looked up by
2216 * ep_find() till we release the mutex.
2217 */
Al Viro7e3fb582013-08-30 12:47:21 -04002218 epi = ep_find(ep, tf.file, fd);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002219
2220 error = -EINVAL;
2221 switch (op) {
2222 case EPOLL_CTL_ADD:
2223 if (!epi) {
Linus Torvaldsa9a08842018-02-11 14:34:03 -08002224 epds.events |= EPOLLERR | EPOLLHUP;
Jason Baron67347fe2013-11-12 15:10:18 -08002225 error = ep_insert(ep, &epds, tf.file, fd, full_check);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002226 } else
2227 error = -EEXIST;
2228 break;
2229 case EPOLL_CTL_DEL:
2230 if (epi)
2231 error = ep_remove(ep, epi);
2232 else
2233 error = -ENOENT;
2234 break;
2235 case EPOLL_CTL_MOD:
2236 if (epi) {
Jason Baronb6a515c2016-02-05 15:37:04 -08002237 if (!(epi->event.events & EPOLLEXCLUSIVE)) {
Linus Torvaldsa9a08842018-02-11 14:34:03 -08002238 epds.events |= EPOLLERR | EPOLLHUP;
Jason Baronb6a515c2016-02-05 15:37:04 -08002239 error = ep_modify(ep, epi, &epds);
2240 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07002241 } else
2242 error = -ENOENT;
2243 break;
2244 }
Jason Baron67347fe2013-11-12 15:10:18 -08002245 if (tep != NULL)
2246 mutex_unlock(&tep->mtx);
Davide Libenzid47de162007-05-15 01:40:41 -07002247 mutex_unlock(&ep->mtx);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002248
2249error_tgt_fput:
Al Viro42694912020-08-22 18:25:52 -04002250 if (full_check) {
2251 clear_tfile_check_list();
Davide Libenzi22bacca2011-02-25 14:44:12 -08002252 mutex_unlock(&epmutex);
Al Viro42694912020-08-22 18:25:52 -04002253 }
Davide Libenzi22bacca2011-02-25 14:44:12 -08002254
Al Viro7e3fb582013-08-30 12:47:21 -04002255 fdput(tf);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002256error_fput:
Al Viro7e3fb582013-08-30 12:47:21 -04002257 fdput(f);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002258error_return:
Davide Libenzi7699acd2007-05-10 22:23:23 -07002259
2260 return error;
2261}
2262
2263/*
2264 * Implement the event wait interface for the eventpoll file. It is the kernel
2265 * part of the user space epoll_wait(2).
2266 */
Dominik Brodowski791eb222018-03-11 11:34:30 +01002267static int do_epoll_wait(int epfd, struct epoll_event __user *events,
2268 int maxevents, int timeout)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002269{
Al Viro2903ff02012-08-28 12:52:22 -04002270 int error;
2271 struct fd f;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002272 struct eventpoll *ep;
2273
Davide Libenzi7699acd2007-05-10 22:23:23 -07002274 /* The maximum number of event must be greater than zero */
2275 if (maxevents <= 0 || maxevents > EP_MAX_EVENTS)
2276 return -EINVAL;
2277
2278 /* Verify that the area passed by the user is writeable */
Linus Torvalds96d4f262019-01-03 18:57:57 -08002279 if (!access_ok(events, maxevents * sizeof(struct epoll_event)))
Al Viro2903ff02012-08-28 12:52:22 -04002280 return -EFAULT;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002281
2282 /* Get the "struct file *" for the eventpoll file */
Al Viro2903ff02012-08-28 12:52:22 -04002283 f = fdget(epfd);
2284 if (!f.file)
2285 return -EBADF;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002286
2287 /*
2288 * We have to check that the file structure underneath the fd
2289 * the user passed to us _is_ an eventpoll file.
2290 */
2291 error = -EINVAL;
Al Viro2903ff02012-08-28 12:52:22 -04002292 if (!is_file_epoll(f.file))
Davide Libenzi7699acd2007-05-10 22:23:23 -07002293 goto error_fput;
2294
2295 /*
2296 * At this point it is safe to assume that the "private_data" contains
2297 * our own data structure.
2298 */
Al Viro2903ff02012-08-28 12:52:22 -04002299 ep = f.file->private_data;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002300
2301 /* Time to fish for events ... */
2302 error = ep_poll(ep, events, maxevents, timeout);
2303
2304error_fput:
Al Viro2903ff02012-08-28 12:52:22 -04002305 fdput(f);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002306 return error;
2307}
2308
Dominik Brodowski791eb222018-03-11 11:34:30 +01002309SYSCALL_DEFINE4(epoll_wait, int, epfd, struct epoll_event __user *, events,
2310 int, maxevents, int, timeout)
2311{
2312 return do_epoll_wait(epfd, events, maxevents, timeout);
2313}
2314
Davide Libenzi7699acd2007-05-10 22:23:23 -07002315/*
2316 * Implement the event wait interface for the eventpoll file. It is the kernel
2317 * part of the user space epoll_pwait(2).
2318 */
Heiko Carstens5a8a82b2009-01-14 14:14:25 +01002319SYSCALL_DEFINE6(epoll_pwait, int, epfd, struct epoll_event __user *, events,
2320 int, maxevents, int, timeout, const sigset_t __user *, sigmask,
2321 size_t, sigsetsize)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002322{
2323 int error;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002324
2325 /*
2326 * If the caller wants a certain signal mask to be set during the wait,
2327 * we apply it here.
2328 */
Oleg Nesterovb7724342019-07-16 16:29:53 -07002329 error = set_user_sigmask(sigmask, sigsetsize);
Deepa Dinamanided653c2018-09-19 21:41:04 -07002330 if (error)
2331 return error;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002332
Dominik Brodowski791eb222018-03-11 11:34:30 +01002333 error = do_epoll_wait(epfd, events, maxevents, timeout);
Oleg Nesterovb7724342019-07-16 16:29:53 -07002334 restore_saved_sigmask_unless(error == -EINTR);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002335
2336 return error;
2337}
2338
Al Viro35280bd2013-02-24 14:52:17 -05002339#ifdef CONFIG_COMPAT
2340COMPAT_SYSCALL_DEFINE6(epoll_pwait, int, epfd,
2341 struct epoll_event __user *, events,
2342 int, maxevents, int, timeout,
2343 const compat_sigset_t __user *, sigmask,
2344 compat_size_t, sigsetsize)
2345{
2346 long err;
Al Viro35280bd2013-02-24 14:52:17 -05002347
2348 /*
2349 * If the caller wants a certain signal mask to be set during the wait,
2350 * we apply it here.
2351 */
Oleg Nesterovb7724342019-07-16 16:29:53 -07002352 err = set_compat_user_sigmask(sigmask, sigsetsize);
Deepa Dinamanided653c2018-09-19 21:41:04 -07002353 if (err)
2354 return err;
Al Viro35280bd2013-02-24 14:52:17 -05002355
Dominik Brodowski791eb222018-03-11 11:34:30 +01002356 err = do_epoll_wait(epfd, events, maxevents, timeout);
Oleg Nesterovb7724342019-07-16 16:29:53 -07002357 restore_saved_sigmask_unless(err == -EINTR);
Al Viro35280bd2013-02-24 14:52:17 -05002358
2359 return err;
2360}
2361#endif
2362
Linus Torvalds1da177e2005-04-16 15:20:36 -07002363static int __init eventpoll_init(void)
2364{
Davide Libenzi7ef99642008-12-01 13:13:55 -08002365 struct sysinfo si;
2366
2367 si_meminfo(&si);
Davide Libenzi9df04e12009-01-29 14:25:26 -08002368 /*
2369 * Allows top 4% of lomem to be allocated for epoll watches (per user).
2370 */
2371 max_user_watches = (((si.totalram - si.totalhigh) / 25) << PAGE_SHIFT) /
Davide Libenzi7ef99642008-12-01 13:13:55 -08002372 EP_ITEM_COST;
Robin Holt52bd19f72011-01-12 17:00:01 -08002373 BUG_ON(max_user_watches < 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002374
Davide Libenzi22bacca2011-02-25 14:44:12 -08002375 /*
2376 * Initialize the structure used to perform epoll file descriptor
2377 * inclusion loops checks.
2378 */
2379 ep_nested_calls_init(&poll_loop_ncalls);
2380
Jason Baron57a173b2017-11-17 15:29:02 -08002381#ifdef CONFIG_DEBUG_LOCK_ALLOC
Linus Torvalds1da177e2005-04-16 15:20:36 -07002382 /* Initialize the structure used to perform safe poll wait head wake ups */
Davide Libenzi5071f972009-03-31 15:24:10 -07002383 ep_nested_calls_init(&poll_safewake_ncalls);
Jason Baron57a173b2017-11-17 15:29:02 -08002384#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002385
Eric Wong39732ca2013-04-30 15:27:38 -07002386 /*
2387 * We can have many thousands of epitems, so prevent this from
2388 * using an extra cache line on 64-bit (and smaller) CPUs
2389 */
2390 BUILD_BUG_ON(sizeof(void *) <= 8 && sizeof(struct epitem) > 128);
2391
Linus Torvalds1da177e2005-04-16 15:20:36 -07002392 /* Allocates slab cache used to allocate "struct epitem" items */
2393 epi_cache = kmem_cache_create("eventpoll_epi", sizeof(struct epitem),
Shakeel Butt2ae928a2017-11-17 15:28:59 -08002394 0, SLAB_HWCACHE_ALIGN|SLAB_PANIC|SLAB_ACCOUNT, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002395
2396 /* Allocates slab cache used to allocate "struct eppoll_entry" */
2397 pwq_cache = kmem_cache_create("eventpoll_pwq",
Shakeel Butt2ae928a2017-11-17 15:28:59 -08002398 sizeof(struct eppoll_entry), 0, SLAB_PANIC|SLAB_ACCOUNT, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002399
Linus Torvalds1da177e2005-04-16 15:20:36 -07002400 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002401}
Davide Libenzicea69242007-05-10 22:23:22 -07002402fs_initcall(eventpoll_init);