blob: 4df61129566d40a21f7016b0900565cdaf68f463 [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 */
Al Viro18306c42020-09-10 08:30:05 -0400221 u64 gen;
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700222
223#ifdef CONFIG_NET_RX_BUSY_POLL
224 /* used to track busy poll napi_id */
225 unsigned int napi_id;
226#endif
Jason Baronefcdd352020-04-06 20:11:23 -0700227
228#ifdef CONFIG_DEBUG_LOCK_ALLOC
229 /* tracks wakeup nests for lockdep validation */
230 u8 nests;
231#endif
Davide Libenzid47de162007-05-15 01:40:41 -0700232};
233
234/* Wait structure used by the poll hooks */
235struct eppoll_entry {
236 /* List header used to link this structure to the "struct epitem" */
237 struct list_head llink;
238
239 /* The "base" pointer is set to the container "struct epitem" */
Tony Battersby4f0989d2009-03-31 15:24:16 -0700240 struct epitem *base;
Davide Libenzid47de162007-05-15 01:40:41 -0700241
242 /*
243 * Wait queue item that will be linked to the target file wait
244 * queue head.
245 */
Ingo Molnarac6424b2017-06-20 12:06:13 +0200246 wait_queue_entry_t wait;
Davide Libenzid47de162007-05-15 01:40:41 -0700247
248 /* The wait queue head that linked the "wait" wait queue item */
249 wait_queue_head_t *whead;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250};
251
252/* Wrapper struct used by poll queueing */
253struct ep_pqueue {
254 poll_table pt;
255 struct epitem *epi;
256};
257
Davide Libenzi5071f972009-03-31 15:24:10 -0700258/* Used by the ep_send_events() function as callback private data */
259struct ep_send_events_data {
260 int maxevents;
261 struct epoll_event __user *events;
Al Virod7ebbe42018-02-01 15:21:13 -0500262 int res;
Davide Libenzi5071f972009-03-31 15:24:10 -0700263};
264
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265/*
Davide Libenzi7ef99642008-12-01 13:13:55 -0800266 * Configuration options available inside /proc/sys/fs/epoll/
267 */
Davide Libenzi7ef99642008-12-01 13:13:55 -0800268/* Maximum number of epoll watched descriptors, per user */
Robin Holt52bd19f72011-01-12 17:00:01 -0800269static long max_user_watches __read_mostly;
Davide Libenzi7ef99642008-12-01 13:13:55 -0800270
271/*
Davide Libenzid47de162007-05-15 01:40:41 -0700272 * This mutex is used to serialize ep_free() and eventpoll_release_file().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273 */
Davide Libenzi7ef99642008-12-01 13:13:55 -0800274static DEFINE_MUTEX(epmutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275
Al Viro18306c42020-09-10 08:30:05 -0400276static u64 loop_check_gen = 0;
277
Davide Libenzi22bacca2011-02-25 14:44:12 -0800278/* Used to check for epoll file descriptor inclusion loops */
279static struct nested_calls poll_loop_ncalls;
280
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281/* Slab cache used to allocate "struct epitem" */
Christoph Lametere18b8902006-12-06 20:33:20 -0800282static struct kmem_cache *epi_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283
284/* Slab cache used to allocate "struct eppoll_entry" */
Christoph Lametere18b8902006-12-06 20:33:20 -0800285static struct kmem_cache *pwq_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286
Jason Baron28d82dc2012-01-12 17:17:43 -0800287/*
288 * List of files with newly added links, where we may need to limit the number
289 * of emanating paths. Protected by the epmutex.
290 */
291static LIST_HEAD(tfile_check_list);
292
Davide Libenzi7ef99642008-12-01 13:13:55 -0800293#ifdef CONFIG_SYSCTL
294
295#include <linux/sysctl.h>
296
Matteo Croceeec48442019-07-18 15:58:50 -0700297static long long_zero;
Robin Holt52bd19f72011-01-12 17:00:01 -0800298static long long_max = LONG_MAX;
Davide Libenzi7ef99642008-12-01 13:13:55 -0800299
Joe Perches1f7e0612014-06-06 14:38:05 -0700300struct ctl_table epoll_table[] = {
Davide Libenzi7ef99642008-12-01 13:13:55 -0800301 {
Davide Libenzi7ef99642008-12-01 13:13:55 -0800302 .procname = "max_user_watches",
303 .data = &max_user_watches,
Robin Holt52bd19f72011-01-12 17:00:01 -0800304 .maxlen = sizeof(max_user_watches),
Davide Libenzi7ef99642008-12-01 13:13:55 -0800305 .mode = 0644,
Robin Holt52bd19f72011-01-12 17:00:01 -0800306 .proc_handler = proc_doulongvec_minmax,
Matteo Croceeec48442019-07-18 15:58:50 -0700307 .extra1 = &long_zero,
Robin Holt52bd19f72011-01-12 17:00:01 -0800308 .extra2 = &long_max,
Davide Libenzi7ef99642008-12-01 13:13:55 -0800309 },
Eric W. Biedermanab092032009-11-05 14:25:10 -0800310 { }
Davide Libenzi7ef99642008-12-01 13:13:55 -0800311};
312#endif /* CONFIG_SYSCTL */
313
Jason Baron28d82dc2012-01-12 17:17:43 -0800314static const struct file_operations eventpoll_fops;
315
316static inline int is_file_epoll(struct file *f)
317{
318 return f->f_op == &eventpoll_fops;
319}
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700320
Davide Libenzi67647d02007-05-15 01:40:52 -0700321/* Setup the structure that is used as key for the RB tree */
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700322static inline void ep_set_ffd(struct epoll_filefd *ffd,
323 struct file *file, int fd)
324{
325 ffd->file = file;
326 ffd->fd = fd;
327}
328
Davide Libenzi67647d02007-05-15 01:40:52 -0700329/* Compare RB tree keys */
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700330static inline int ep_cmp_ffd(struct epoll_filefd *p1,
331 struct epoll_filefd *p2)
332{
333 return (p1->file > p2->file ? +1:
334 (p1->file < p2->file ? -1 : p1->fd - p2->fd));
335}
336
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700337/* Tells us if the item is currently linked */
Davidlohr Bueso992991c2018-08-21 21:58:26 -0700338static inline int ep_is_linked(struct epitem *epi)
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700339{
Davidlohr Bueso992991c2018-08-21 21:58:26 -0700340 return !list_empty(&epi->rdllink);
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700341}
342
Ingo Molnarac6424b2017-06-20 12:06:13 +0200343static inline struct eppoll_entry *ep_pwq_from_wait(wait_queue_entry_t *p)
Oleg Nesterov971316f2012-02-24 20:07:29 +0100344{
345 return container_of(p, struct eppoll_entry, wait);
346}
347
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700348/* Get the "struct epitem" from a wait queue pointer */
Ingo Molnarac6424b2017-06-20 12:06:13 +0200349static inline struct epitem *ep_item_from_wait(wait_queue_entry_t *p)
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700350{
351 return container_of(p, struct eppoll_entry, wait)->base;
352}
353
354/* Get the "struct epitem" from an epoll queue wrapper */
Davide Libenzicdac75e2008-04-29 00:58:34 -0700355static inline struct epitem *ep_item_from_epqueue(poll_table *p)
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700356{
357 return container_of(p, struct ep_pqueue, pt)->epi;
358}
359
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360/* Initialize the poll safe wake up structure */
Davide Libenzi5071f972009-03-31 15:24:10 -0700361static void ep_nested_calls_init(struct nested_calls *ncalls)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362{
Davide Libenzi5071f972009-03-31 15:24:10 -0700363 INIT_LIST_HEAD(&ncalls->tasks_call_list);
364 spin_lock_init(&ncalls->lock);
365}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366
Davide Libenzi5071f972009-03-31 15:24:10 -0700367/**
Davide Libenzi3fb0e582011-03-22 16:34:46 -0700368 * ep_events_available - Checks if ready events might be available.
369 *
370 * @ep: Pointer to the eventpoll context.
371 *
372 * Returns: Returns a value different than zero if ready events are available,
373 * or zero otherwise.
374 */
375static inline int ep_events_available(struct eventpoll *ep)
376{
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -0800377 return !list_empty_careful(&ep->rdllist) ||
378 READ_ONCE(ep->ovflist) != EP_UNACTIVE_PTR;
Davide Libenzi3fb0e582011-03-22 16:34:46 -0700379}
380
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700381#ifdef CONFIG_NET_RX_BUSY_POLL
382static bool ep_busy_loop_end(void *p, unsigned long start_time)
383{
384 struct eventpoll *ep = p;
385
386 return ep_events_available(ep) || busy_loop_timeout(start_time);
387}
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700388
389/*
390 * Busy poll if globally on and supporting sockets found && no events,
391 * busy loop will return if need_resched or ep_events_available.
392 *
393 * we must do our busy polling with irqs enabled
394 */
395static void ep_busy_loop(struct eventpoll *ep, int nonblock)
396{
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700397 unsigned int napi_id = READ_ONCE(ep->napi_id);
398
399 if ((napi_id >= MIN_NAPI_ID) && net_busy_loop_on())
400 napi_busy_loop(napi_id, nonblock ? NULL : ep_busy_loop_end, ep);
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700401}
402
403static inline void ep_reset_busy_poll_napi_id(struct eventpoll *ep)
404{
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700405 if (ep->napi_id)
406 ep->napi_id = 0;
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700407}
408
409/*
410 * Set epoll busy poll NAPI ID from sk.
411 */
412static inline void ep_set_busy_poll_napi_id(struct epitem *epi)
413{
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700414 struct eventpoll *ep;
415 unsigned int napi_id;
416 struct socket *sock;
417 struct sock *sk;
418 int err;
419
420 if (!net_busy_loop_on())
421 return;
422
423 sock = sock_from_file(epi->ffd.file, &err);
424 if (!sock)
425 return;
426
427 sk = sock->sk;
428 if (!sk)
429 return;
430
431 napi_id = READ_ONCE(sk->sk_napi_id);
432 ep = epi->ep;
433
434 /* Non-NAPI IDs can be rejected
435 * or
436 * Nothing to do if we already have this ID
437 */
438 if (napi_id < MIN_NAPI_ID || napi_id == ep->napi_id)
439 return;
440
441 /* record NAPI ID for use in next busy poll */
442 ep->napi_id = napi_id;
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700443}
444
Davidlohr Bueso514056d2018-08-21 21:58:19 -0700445#else
446
447static inline void ep_busy_loop(struct eventpoll *ep, int nonblock)
448{
449}
450
451static inline void ep_reset_busy_poll_napi_id(struct eventpoll *ep)
452{
453}
454
455static inline void ep_set_busy_poll_napi_id(struct epitem *epi)
456{
457}
458
459#endif /* CONFIG_NET_RX_BUSY_POLL */
460
Davide Libenzi3fb0e582011-03-22 16:34:46 -0700461/**
Davide Libenzi5071f972009-03-31 15:24:10 -0700462 * ep_call_nested - Perform a bound (possibly) nested call, by checking
463 * that the recursion limit is not exceeded, and that
464 * the same nested call (by the meaning of same cookie) is
465 * no re-entered.
466 *
467 * @ncalls: Pointer to the nested_calls structure to be used for this call.
Davide Libenzi5071f972009-03-31 15:24:10 -0700468 * @nproc: Nested call core function pointer.
469 * @priv: Opaque data to be passed to the @nproc callback.
470 * @cookie: Cookie to be used to identify this nested call.
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700471 * @ctx: This instance context.
Davide Libenzi5071f972009-03-31 15:24:10 -0700472 *
473 * Returns: Returns the code returned by the @nproc callback, or -1 if
474 * the maximum recursion limit has been exceeded.
475 */
Davidlohr Bueso74bdc122019-01-03 15:27:02 -0800476static int ep_call_nested(struct nested_calls *ncalls,
Davide Libenzi5071f972009-03-31 15:24:10 -0700477 int (*nproc)(void *, void *, int), void *priv,
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700478 void *cookie, void *ctx)
Davide Libenzi5071f972009-03-31 15:24:10 -0700479{
480 int error, call_nests = 0;
481 unsigned long flags;
Davide Libenzi5071f972009-03-31 15:24:10 -0700482 struct list_head *lsthead = &ncalls->tasks_call_list;
483 struct nested_call_node *tncur;
484 struct nested_call_node tnode;
485
486 spin_lock_irqsave(&ncalls->lock, flags);
487
488 /*
489 * Try to see if the current task is already inside this wakeup call.
490 * We use a list here, since the population inside this set is always
491 * very much limited.
492 */
493 list_for_each_entry(tncur, lsthead, llink) {
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700494 if (tncur->ctx == ctx &&
Davidlohr Bueso74bdc122019-01-03 15:27:02 -0800495 (tncur->cookie == cookie || ++call_nests > EP_MAX_NESTS)) {
Davide Libenzi5071f972009-03-31 15:24:10 -0700496 /*
497 * Ops ... loop detected or maximum nest level reached.
498 * We abort this wake by breaking the cycle itself.
499 */
Tony Battersbyabff55c2009-03-31 15:24:13 -0700500 error = -1;
501 goto out_unlock;
Davide Libenzi5071f972009-03-31 15:24:10 -0700502 }
503 }
504
505 /* Add the current task and cookie to the list */
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700506 tnode.ctx = ctx;
Davide Libenzi5071f972009-03-31 15:24:10 -0700507 tnode.cookie = cookie;
508 list_add(&tnode.llink, lsthead);
509
510 spin_unlock_irqrestore(&ncalls->lock, flags);
511
512 /* Call the nested function */
513 error = (*nproc)(priv, cookie, call_nests);
514
515 /* Remove the current task from the list */
516 spin_lock_irqsave(&ncalls->lock, flags);
517 list_del(&tnode.llink);
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700518out_unlock:
Davide Libenzi5071f972009-03-31 15:24:10 -0700519 spin_unlock_irqrestore(&ncalls->lock, flags);
520
521 return error;
522}
523
Steven Rostedt02edc6f2012-03-23 15:02:27 -0700524/*
525 * As described in commit 0ccf831cb lockdep: annotate epoll
526 * the use of wait queues used by epoll is done in a very controlled
527 * manner. Wake ups can nest inside each other, but are never done
528 * with the same locking. For example:
529 *
530 * dfd = socket(...);
531 * efd1 = epoll_create();
532 * efd2 = epoll_create();
533 * epoll_ctl(efd1, EPOLL_CTL_ADD, dfd, ...);
534 * epoll_ctl(efd2, EPOLL_CTL_ADD, efd1, ...);
535 *
536 * When a packet arrives to the device underneath "dfd", the net code will
537 * issue a wake_up() on its poll wake list. Epoll (efd1) has installed a
538 * callback wakeup entry on that queue, and the wake_up() performed by the
539 * "dfd" net code will end up in ep_poll_callback(). At this point epoll
540 * (efd1) notices that it may have some event ready, so it needs to wake up
541 * the waiters on its poll wait list (efd2). So it calls ep_poll_safewake()
542 * that ends up in another wake_up(), after having checked about the
543 * recursion constraints. That are, no more than EP_MAX_POLLWAKE_NESTS, to
544 * avoid stack blasting.
545 *
546 * When CONFIG_DEBUG_LOCK_ALLOC is enabled, make sure lockdep can handle
547 * this special case of epoll.
548 */
Davide Libenzi2dfa4ee2009-03-31 15:24:22 -0700549#ifdef CONFIG_DEBUG_LOCK_ALLOC
Davide Libenzi2dfa4ee2009-03-31 15:24:22 -0700550
Jason Baronefcdd352020-04-06 20:11:23 -0700551static void ep_poll_safewake(struct eventpoll *ep, struct epitem *epi)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552{
Jason Baronefcdd352020-04-06 20:11:23 -0700553 struct eventpoll *ep_src;
Jason Baronf6520c52019-12-04 16:52:12 -0800554 unsigned long flags;
Jason Baronefcdd352020-04-06 20:11:23 -0700555 u8 nests = 0;
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700556
Jason Baronefcdd352020-04-06 20:11:23 -0700557 /*
558 * To set the subclass or nesting level for spin_lock_irqsave_nested()
559 * it might be natural to create a per-cpu nest count. However, since
560 * we can recurse on ep->poll_wait.lock, and a non-raw spinlock can
561 * schedule() in the -rt kernel, the per-cpu variable are no longer
562 * protected. Thus, we are introducing a per eventpoll nest field.
563 * If we are not being call from ep_poll_callback(), epi is NULL and
564 * we are at the first level of nesting, 0. Otherwise, we are being
565 * called from ep_poll_callback() and if a previous wakeup source is
566 * not an epoll file itself, we are at depth 1 since the wakeup source
567 * is depth 0. If the wakeup source is a previous epoll file in the
568 * wakeup chain then we use its nests value and record ours as
569 * nests + 1. The previous epoll file nests value is stable since its
570 * already holding its own poll_wait.lock.
571 */
572 if (epi) {
573 if ((is_file_epoll(epi->ffd.file))) {
574 ep_src = epi->ffd.file->private_data;
575 nests = ep_src->nests;
576 } else {
577 nests = 1;
578 }
579 }
580 spin_lock_irqsave_nested(&ep->poll_wait.lock, flags, nests);
581 ep->nests = nests + 1;
582 wake_up_locked_poll(&ep->poll_wait, EPOLLIN);
583 ep->nests = 0;
584 spin_unlock_irqrestore(&ep->poll_wait.lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585}
586
Jason Baron57a173b2017-11-17 15:29:02 -0800587#else
588
Jason Baronefcdd352020-04-06 20:11:23 -0700589static void ep_poll_safewake(struct eventpoll *ep, struct epitem *epi)
Jason Baron57a173b2017-11-17 15:29:02 -0800590{
Jason Baronefcdd352020-04-06 20:11:23 -0700591 wake_up_poll(&ep->poll_wait, EPOLLIN);
Jason Baron57a173b2017-11-17 15:29:02 -0800592}
593
594#endif
595
Oleg Nesterov971316f2012-02-24 20:07:29 +0100596static void ep_remove_wait_queue(struct eppoll_entry *pwq)
597{
598 wait_queue_head_t *whead;
599
600 rcu_read_lock();
Oleg Nesterov138e4ad2017-09-01 18:55:33 +0200601 /*
602 * If it is cleared by POLLFREE, it should be rcu-safe.
603 * If we read NULL we need a barrier paired with
604 * smp_store_release() in ep_poll_callback(), otherwise
605 * we rely on whead->lock.
606 */
607 whead = smp_load_acquire(&pwq->whead);
Oleg Nesterov971316f2012-02-24 20:07:29 +0100608 if (whead)
609 remove_wait_queue(whead, &pwq->wait);
610 rcu_read_unlock();
611}
612
Davide Libenzi7699acd2007-05-10 22:23:23 -0700613/*
Tony Battersbyd1bc90d2009-03-31 15:24:15 -0700614 * This function unregisters poll callbacks from the associated file
615 * descriptor. Must be called with "mtx" held (or "epmutex" if called from
616 * ep_free).
Davide Libenzi7699acd2007-05-10 22:23:23 -0700617 */
618static void ep_unregister_pollwait(struct eventpoll *ep, struct epitem *epi)
619{
Davide Libenzi7699acd2007-05-10 22:23:23 -0700620 struct list_head *lsthead = &epi->pwqlist;
621 struct eppoll_entry *pwq;
622
Tony Battersbyd1bc90d2009-03-31 15:24:15 -0700623 while (!list_empty(lsthead)) {
624 pwq = list_first_entry(lsthead, struct eppoll_entry, llink);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700625
Tony Battersbyd1bc90d2009-03-31 15:24:15 -0700626 list_del(&pwq->llink);
Oleg Nesterov971316f2012-02-24 20:07:29 +0100627 ep_remove_wait_queue(pwq);
Tony Battersbyd1bc90d2009-03-31 15:24:15 -0700628 kmem_cache_free(pwq_cache, pwq);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700629 }
630}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631
Eric Wongeea1d582013-04-30 15:27:39 -0700632/* call only when ep->mtx is held */
633static inline struct wakeup_source *ep_wakeup_source(struct epitem *epi)
634{
635 return rcu_dereference_check(epi->ws, lockdep_is_held(&epi->ep->mtx));
636}
637
638/* call only when ep->mtx is held */
639static inline void ep_pm_stay_awake(struct epitem *epi)
640{
641 struct wakeup_source *ws = ep_wakeup_source(epi);
642
643 if (ws)
644 __pm_stay_awake(ws);
645}
646
647static inline bool ep_has_wakeup_source(struct epitem *epi)
648{
649 return rcu_access_pointer(epi->ws) ? true : false;
650}
651
652/* call when ep->mtx cannot be held (ep_poll_callback) */
653static inline void ep_pm_stay_awake_rcu(struct epitem *epi)
654{
655 struct wakeup_source *ws;
656
657 rcu_read_lock();
658 ws = rcu_dereference(epi->ws);
659 if (ws)
660 __pm_stay_awake(ws);
661 rcu_read_unlock();
662}
663
Davide Libenzi5071f972009-03-31 15:24:10 -0700664/**
665 * ep_scan_ready_list - Scans the ready list in a way that makes possible for
666 * the scan code, to call f_op->poll(). Also allows for
667 * O(NumReady) performance.
668 *
669 * @ep: Pointer to the epoll private data structure.
670 * @sproc: Pointer to the scan callback.
671 * @priv: Private opaque data passed to the @sproc callback.
Nelson Elhaged8805e62011-10-31 17:13:14 -0700672 * @depth: The current depth of recursive f_op->poll calls.
Jason Baron67347fe2013-11-12 15:10:18 -0800673 * @ep_locked: caller already holds ep->mtx
Davide Libenzi5071f972009-03-31 15:24:10 -0700674 *
675 * Returns: The same integer error code returned by the @sproc callback.
676 */
Al Virod85e2aa2018-02-01 15:24:58 -0500677static __poll_t ep_scan_ready_list(struct eventpoll *ep,
678 __poll_t (*sproc)(struct eventpoll *,
Davide Libenzi5071f972009-03-31 15:24:10 -0700679 struct list_head *, void *),
Jason Baron67347fe2013-11-12 15:10:18 -0800680 void *priv, int depth, bool ep_locked)
Davide Libenzi5071f972009-03-31 15:24:10 -0700681{
Al Virod85e2aa2018-02-01 15:24:58 -0500682 __poll_t res;
Davide Libenzi5071f972009-03-31 15:24:10 -0700683 struct epitem *epi, *nepi;
Davide Libenzi296e2362009-03-31 15:24:11 -0700684 LIST_HEAD(txlist);
Davide Libenzi5071f972009-03-31 15:24:10 -0700685
Davidlohr Bueso92e64172018-08-21 21:56:45 -0700686 lockdep_assert_irqs_enabled();
687
Davide Libenzi5071f972009-03-31 15:24:10 -0700688 /*
689 * We need to lock this because we could be hit by
Tony Battersbye057e152009-03-31 15:24:15 -0700690 * eventpoll_release_file() and epoll_ctl().
Davide Libenzi5071f972009-03-31 15:24:10 -0700691 */
Jason Baron67347fe2013-11-12 15:10:18 -0800692
693 if (!ep_locked)
694 mutex_lock_nested(&ep->mtx, depth);
Davide Libenzi5071f972009-03-31 15:24:10 -0700695
696 /*
697 * Steal the ready list, and re-init the original one to the
698 * empty list. Also, set ep->ovflist to NULL so that events
699 * happening while looping w/out locks, are not lost. We cannot
700 * have the poll callback to queue directly on ep->rdllist,
701 * because we want the "sproc" callback to be able to do it
702 * in a lockless way.
703 */
Roman Penyaeva218cc42019-03-07 16:28:53 -0800704 write_lock_irq(&ep->lock);
Davide Libenzi296e2362009-03-31 15:24:11 -0700705 list_splice_init(&ep->rdllist, &txlist);
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -0800706 WRITE_ONCE(ep->ovflist, NULL);
Roman Penyaeva218cc42019-03-07 16:28:53 -0800707 write_unlock_irq(&ep->lock);
Davide Libenzi5071f972009-03-31 15:24:10 -0700708
709 /*
710 * Now call the callback function.
711 */
Al Virod85e2aa2018-02-01 15:24:58 -0500712 res = (*sproc)(ep, &txlist, priv);
Davide Libenzi5071f972009-03-31 15:24:10 -0700713
Roman Penyaeva218cc42019-03-07 16:28:53 -0800714 write_lock_irq(&ep->lock);
Davide Libenzi5071f972009-03-31 15:24:10 -0700715 /*
716 * During the time we spent inside the "sproc" callback, some
717 * other events might have been queued by the poll callback.
718 * We re-insert them inside the main ready-list here.
719 */
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -0800720 for (nepi = READ_ONCE(ep->ovflist); (epi = nepi) != NULL;
Davide Libenzi5071f972009-03-31 15:24:10 -0700721 nepi = epi->next, epi->next = EP_UNACTIVE_PTR) {
722 /*
723 * We need to check if the item is already in the list.
724 * During the "sproc" callback execution time, items are
725 * queued into ->ovflist but the "txlist" might already
726 * contain them, and the list_splice() below takes care of them.
727 */
Davidlohr Bueso992991c2018-08-21 21:58:26 -0700728 if (!ep_is_linked(epi)) {
Roman Penyaevc1411752019-03-07 16:28:46 -0800729 /*
730 * ->ovflist is LIFO, so we have to reverse it in order
731 * to keep in FIFO.
732 */
733 list_add(&epi->rdllink, &ep->rdllist);
Eric Wongeea1d582013-04-30 15:27:39 -0700734 ep_pm_stay_awake(epi);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200735 }
Davide Libenzi5071f972009-03-31 15:24:10 -0700736 }
737 /*
738 * We need to set back ep->ovflist to EP_UNACTIVE_PTR, so that after
739 * releasing the lock, events will be queued in the normal way inside
740 * ep->rdllist.
741 */
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -0800742 WRITE_ONCE(ep->ovflist, EP_UNACTIVE_PTR);
Davide Libenzi5071f972009-03-31 15:24:10 -0700743
744 /*
745 * Quickly re-inject items left on "txlist".
746 */
747 list_splice(&txlist, &ep->rdllist);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200748 __pm_relax(ep->ws);
Roman Penyaeva218cc42019-03-07 16:28:53 -0800749 write_unlock_irq(&ep->lock);
Davide Libenzi5071f972009-03-31 15:24:10 -0700750
Jason Baron67347fe2013-11-12 15:10:18 -0800751 if (!ep_locked)
752 mutex_unlock(&ep->mtx);
Davide Libenzi5071f972009-03-31 15:24:10 -0700753
Al Virod85e2aa2018-02-01 15:24:58 -0500754 return res;
Davide Libenzi5071f972009-03-31 15:24:10 -0700755}
756
Jason Baronae10b2b2013-11-12 15:10:16 -0800757static void epi_rcu_free(struct rcu_head *head)
758{
759 struct epitem *epi = container_of(head, struct epitem, rcu);
760 kmem_cache_free(epi_cache, epi);
761}
762
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763/*
Davide Libenzi7699acd2007-05-10 22:23:23 -0700764 * Removes a "struct epitem" from the eventpoll RB tree and deallocates
Davide Libenzic7ea7632007-05-15 01:40:47 -0700765 * all the associated resources. Must be called with "mtx" held.
Davide Libenzi7699acd2007-05-10 22:23:23 -0700766 */
767static int ep_remove(struct eventpoll *ep, struct epitem *epi)
768{
Davide Libenzi7699acd2007-05-10 22:23:23 -0700769 struct file *file = epi->ffd.file;
770
Davidlohr Bueso92e64172018-08-21 21:56:45 -0700771 lockdep_assert_irqs_enabled();
772
Davide Libenzi7699acd2007-05-10 22:23:23 -0700773 /*
Christoph Hellwigee8ef0a2018-08-21 21:56:26 -0700774 * Removes poll wait queue hooks.
Davide Libenzi7699acd2007-05-10 22:23:23 -0700775 */
776 ep_unregister_pollwait(ep, epi);
777
778 /* Remove the current item from the list of epoll hooks */
Jonathan Corbet68499912009-02-06 13:52:43 -0700779 spin_lock(&file->f_lock);
Jason Baronae10b2b2013-11-12 15:10:16 -0800780 list_del_rcu(&epi->fllink);
Jonathan Corbet68499912009-02-06 13:52:43 -0700781 spin_unlock(&file->f_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700783 rb_erase_cached(&epi->rbn, &ep->rbr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784
Roman Penyaeva218cc42019-03-07 16:28:53 -0800785 write_lock_irq(&ep->lock);
Davidlohr Bueso992991c2018-08-21 21:58:26 -0700786 if (ep_is_linked(epi))
Davide Libenzic7ea7632007-05-15 01:40:47 -0700787 list_del_init(&epi->rdllink);
Roman Penyaeva218cc42019-03-07 16:28:53 -0800788 write_unlock_irq(&ep->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789
Eric Wongeea1d582013-04-30 15:27:39 -0700790 wakeup_source_unregister(ep_wakeup_source(epi));
Jason Baronae10b2b2013-11-12 15:10:16 -0800791 /*
792 * At this point it is safe to free the eventpoll item. Use the union
793 * field epi->rcu, since we are trying to minimize the size of
794 * 'struct epitem'. The 'rbn' field is no longer in use. Protected by
795 * ep->mtx. The rcu read side, reverse_path_check_proc(), does not make
796 * use of the rbn field.
797 */
798 call_rcu(&epi->rcu, epi_rcu_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799
Robin Holt52bd19f72011-01-12 17:00:01 -0800800 atomic_long_dec(&ep->user->epoll_watches);
Davide Libenzi7ef99642008-12-01 13:13:55 -0800801
Davide Libenzic7ea7632007-05-15 01:40:47 -0700802 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803}
804
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805static void ep_free(struct eventpoll *ep)
806{
807 struct rb_node *rbp;
808 struct epitem *epi;
809
810 /* We need to release all tasks waiting for these file */
811 if (waitqueue_active(&ep->poll_wait))
Jason Baronefcdd352020-04-06 20:11:23 -0700812 ep_poll_safewake(ep, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813
814 /*
815 * We need to lock this because we could be hit by
816 * eventpoll_release_file() while we're freeing the "struct eventpoll".
Davide Libenzid47de162007-05-15 01:40:41 -0700817 * We do not need to hold "ep->mtx" here because the epoll file
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818 * is on the way to be removed and no one has references to it
819 * anymore. The only hit might come from eventpoll_release_file() but
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300820 * holding "epmutex" is sufficient here.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821 */
Arjan van de Ven144efe32006-03-23 03:00:32 -0800822 mutex_lock(&epmutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823
824 /*
825 * Walks through the whole tree by unregistering poll callbacks.
826 */
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700827 for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828 epi = rb_entry(rbp, struct epitem, rbn);
829
830 ep_unregister_pollwait(ep, epi);
Eric Dumazet91cf5ab2013-09-11 14:24:06 -0700831 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832 }
833
834 /*
Davide Libenzi6192bd52007-05-08 00:25:41 -0700835 * Walks through the whole tree by freeing each "struct epitem". At this
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836 * point we are sure no poll callbacks will be lingering around, and also by
Davide Libenzid47de162007-05-15 01:40:41 -0700837 * holding "epmutex" we can be sure that no file cleanup code will hit
Roman Penyaeva218cc42019-03-07 16:28:53 -0800838 * us during this operation. So we can avoid the lock on "ep->lock".
Eric Wongddf676c2013-04-30 15:27:40 -0700839 * We do not need to lock ep->mtx, either, we only do it to prevent
840 * a lockdep warning.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841 */
Eric Wongddf676c2013-04-30 15:27:40 -0700842 mutex_lock(&ep->mtx);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700843 while ((rbp = rb_first_cached(&ep->rbr)) != NULL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844 epi = rb_entry(rbp, struct epitem, rbn);
845 ep_remove(ep, epi);
Eric Dumazet91cf5ab2013-09-11 14:24:06 -0700846 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847 }
Eric Wongddf676c2013-04-30 15:27:40 -0700848 mutex_unlock(&ep->mtx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849
Arjan van de Ven144efe32006-03-23 03:00:32 -0800850 mutex_unlock(&epmutex);
Davide Libenzid47de162007-05-15 01:40:41 -0700851 mutex_destroy(&ep->mtx);
Davide Libenzi7ef99642008-12-01 13:13:55 -0800852 free_uid(ep->user);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200853 wakeup_source_unregister(ep->ws);
Davide Libenzif0ee9aa2007-05-15 01:40:57 -0700854 kfree(ep);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855}
856
Davide Libenzi7699acd2007-05-10 22:23:23 -0700857static int ep_eventpoll_release(struct inode *inode, struct file *file)
858{
859 struct eventpoll *ep = file->private_data;
860
Davide Libenzif0ee9aa2007-05-15 01:40:57 -0700861 if (ep)
Davide Libenzi7699acd2007-05-10 22:23:23 -0700862 ep_free(ep);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700863
Davide Libenzi7699acd2007-05-10 22:23:23 -0700864 return 0;
865}
866
Al Virod85e2aa2018-02-01 15:24:58 -0500867static __poll_t ep_read_events_proc(struct eventpoll *ep, struct list_head *head,
Jason Baron37b5e522017-11-17 15:29:06 -0800868 void *priv);
869static void ep_ptable_queue_proc(struct file *file, wait_queue_head_t *whead,
870 poll_table *pt);
Eric Wong450d89e2013-04-30 15:27:42 -0700871
Jason Baron37b5e522017-11-17 15:29:06 -0800872/*
873 * Differs from ep_eventpoll_poll() in that internal callers already have
874 * the ep->mtx so we need to start from depth=1, such that mutex_lock_nested()
875 * is correctly annotated.
876 */
Al Virod85e2aa2018-02-01 15:24:58 -0500877static __poll_t ep_item_poll(const struct epitem *epi, poll_table *pt,
Al Virobec1a5022017-11-28 19:43:33 -0500878 int depth)
Jason Baron37b5e522017-11-17 15:29:06 -0800879{
880 struct eventpoll *ep;
881 bool locked;
882
883 pt->_key = epi->event.events;
884 if (!is_file_epoll(epi->ffd.file))
Christoph Hellwig9965ed172018-03-05 07:26:05 -0800885 return vfs_poll(epi->ffd.file, pt) & epi->event.events;
Jason Baron37b5e522017-11-17 15:29:06 -0800886
887 ep = epi->ffd.file->private_data;
888 poll_wait(epi->ffd.file, &ep->poll_wait, pt);
889 locked = pt && (pt->_qproc == ep_ptable_queue_proc);
890
891 return ep_scan_ready_list(epi->ffd.file->private_data,
892 ep_read_events_proc, &depth, depth,
893 locked) & epi->event.events;
Eric Wong450d89e2013-04-30 15:27:42 -0700894}
895
Al Virod85e2aa2018-02-01 15:24:58 -0500896static __poll_t ep_read_events_proc(struct eventpoll *ep, struct list_head *head,
Davide Libenzi296e2362009-03-31 15:24:11 -0700897 void *priv)
Davide Libenzi5071f972009-03-31 15:24:10 -0700898{
899 struct epitem *epi, *tmp;
Hans Verkuil626cf232012-03-23 15:02:27 -0700900 poll_table pt;
Jason Baron37b5e522017-11-17 15:29:06 -0800901 int depth = *(int *)priv;
Davide Libenzi5071f972009-03-31 15:24:10 -0700902
Hans Verkuil626cf232012-03-23 15:02:27 -0700903 init_poll_funcptr(&pt, NULL);
Jason Baron37b5e522017-11-17 15:29:06 -0800904 depth++;
Eric Wong450d89e2013-04-30 15:27:42 -0700905
Davide Libenzi5071f972009-03-31 15:24:10 -0700906 list_for_each_entry_safe(epi, tmp, head, rdllink) {
Jason Baron37b5e522017-11-17 15:29:06 -0800907 if (ep_item_poll(epi, &pt, depth)) {
Linus Torvaldsa9a08842018-02-11 14:34:03 -0800908 return EPOLLIN | EPOLLRDNORM;
Jason Baron37b5e522017-11-17 15:29:06 -0800909 } else {
Davide Libenzi5071f972009-03-31 15:24:10 -0700910 /*
911 * Item has been dropped into the ready list by the poll
912 * callback, but it's not actually ready, as far as
913 * caller requested events goes. We can remove it here.
914 */
Eric Wongeea1d582013-04-30 15:27:39 -0700915 __pm_relax(ep_wakeup_source(epi));
Davide Libenzi5071f972009-03-31 15:24:10 -0700916 list_del_init(&epi->rdllink);
Davide Libenzi296e2362009-03-31 15:24:11 -0700917 }
Davide Libenzi5071f972009-03-31 15:24:10 -0700918 }
919
920 return 0;
921}
922
Linus Torvaldsa11e1d42018-06-28 09:43:44 -0700923static __poll_t ep_eventpoll_poll(struct file *file, poll_table *wait)
Davide Libenzi7699acd2007-05-10 22:23:23 -0700924{
Davide Libenzi7699acd2007-05-10 22:23:23 -0700925 struct eventpoll *ep = file->private_data;
Jason Baron37b5e522017-11-17 15:29:06 -0800926 int depth = 0;
Davide Libenzi7699acd2007-05-10 22:23:23 -0700927
Linus Torvaldsa11e1d42018-06-28 09:43:44 -0700928 /* Insert inside our poll wait queue */
929 poll_wait(file, &ep->poll_wait, wait);
930
Davide Libenzi5071f972009-03-31 15:24:10 -0700931 /*
932 * Proceed to find out if wanted events are really available inside
Jason Baron37b5e522017-11-17 15:29:06 -0800933 * the ready list.
Davide Libenzi5071f972009-03-31 15:24:10 -0700934 */
Jason Baron37b5e522017-11-17 15:29:06 -0800935 return ep_scan_ready_list(ep, ep_read_events_proc,
936 &depth, depth, false);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700937}
938
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800939#ifdef CONFIG_PROC_FS
Joe Perchesa3816ab2014-09-29 16:08:25 -0700940static void ep_show_fdinfo(struct seq_file *m, struct file *f)
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800941{
942 struct eventpoll *ep = f->private_data;
943 struct rb_node *rbp;
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800944
945 mutex_lock(&ep->mtx);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700946 for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) {
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800947 struct epitem *epi = rb_entry(rbp, struct epitem, rbn);
Cyrill Gorcunov77493f02017-07-12 14:34:25 -0700948 struct inode *inode = file_inode(epi->ffd.file);
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800949
Cyrill Gorcunov77493f02017-07-12 14:34:25 -0700950 seq_printf(m, "tfd: %8d events: %8x data: %16llx "
951 " pos:%lli ino:%lx sdev:%x\n",
Joe Perchesa3816ab2014-09-29 16:08:25 -0700952 epi->ffd.fd, epi->event.events,
Cyrill Gorcunov77493f02017-07-12 14:34:25 -0700953 (long long)epi->event.data,
954 (long long)epi->ffd.file->f_pos,
955 inode->i_ino, inode->i_sb->s_dev);
Joe Perchesa3816ab2014-09-29 16:08:25 -0700956 if (seq_has_overflowed(m))
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800957 break;
958 }
959 mutex_unlock(&ep->mtx);
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800960}
961#endif
962
Davide Libenzi7699acd2007-05-10 22:23:23 -0700963/* File callbacks that implement the eventpoll file behaviour */
964static const struct file_operations eventpoll_fops = {
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800965#ifdef CONFIG_PROC_FS
966 .show_fdinfo = ep_show_fdinfo,
967#endif
Davide Libenzi7699acd2007-05-10 22:23:23 -0700968 .release = ep_eventpoll_release,
Linus Torvaldsa11e1d42018-06-28 09:43:44 -0700969 .poll = ep_eventpoll_poll,
Arnd Bergmann6038f372010-08-15 18:52:59 +0200970 .llseek = noop_llseek,
Davide Libenzi7699acd2007-05-10 22:23:23 -0700971};
972
Davide Libenzi7699acd2007-05-10 22:23:23 -0700973/*
974 * This is called from eventpoll_release() to unlink files from the eventpoll
975 * interface. We need to have this facility to cleanup correctly files that are
976 * closed without being removed from the eventpoll interface.
977 */
978void eventpoll_release_file(struct file *file)
979{
Davide Libenzi7699acd2007-05-10 22:23:23 -0700980 struct eventpoll *ep;
Konstantin Khlebnikovebe06182014-06-17 06:58:05 +0400981 struct epitem *epi, *next;
Davide Libenzi7699acd2007-05-10 22:23:23 -0700982
983 /*
Jonathan Corbet68499912009-02-06 13:52:43 -0700984 * We don't want to get "file->f_lock" because it is not
Davide Libenzi7699acd2007-05-10 22:23:23 -0700985 * necessary. It is not necessary because we're in the "struct file"
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300986 * cleanup path, and this means that no one is using this file anymore.
Davide Libenzi5071f972009-03-31 15:24:10 -0700987 * So, for example, epoll_ctl() cannot hit here since if we reach this
Davide Libenzi67647d02007-05-15 01:40:52 -0700988 * point, the file counter already went to zero and fget() would fail.
Davide Libenzid47de162007-05-15 01:40:41 -0700989 * The only hit might come from ep_free() but by holding the mutex
Davide Libenzi7699acd2007-05-10 22:23:23 -0700990 * will correctly serialize the operation. We do need to acquire
Davide Libenzid47de162007-05-15 01:40:41 -0700991 * "ep->mtx" after "epmutex" because ep_remove() requires it when called
Davide Libenzi7699acd2007-05-10 22:23:23 -0700992 * from anywhere but ep_free().
Jonathan Corbet68499912009-02-06 13:52:43 -0700993 *
994 * Besides, ep_remove() acquires the lock, so we can't hold it here.
Davide Libenzi7699acd2007-05-10 22:23:23 -0700995 */
996 mutex_lock(&epmutex);
Konstantin Khlebnikovebe06182014-06-17 06:58:05 +0400997 list_for_each_entry_safe(epi, next, &file->f_ep_links, fllink) {
Davide Libenzi7699acd2007-05-10 22:23:23 -0700998 ep = epi->ep;
Nelson Elhaged8805e62011-10-31 17:13:14 -0700999 mutex_lock_nested(&ep->mtx, 0);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001000 ep_remove(ep, epi);
Davide Libenzid47de162007-05-15 01:40:41 -07001001 mutex_unlock(&ep->mtx);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001002 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07001003 mutex_unlock(&epmutex);
1004}
1005
1006static int ep_alloc(struct eventpoll **pep)
1007{
Davide Libenzi7ef99642008-12-01 13:13:55 -08001008 int error;
1009 struct user_struct *user;
1010 struct eventpoll *ep;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001011
Davide Libenzi7ef99642008-12-01 13:13:55 -08001012 user = get_current_user();
Davide Libenzi7ef99642008-12-01 13:13:55 -08001013 error = -ENOMEM;
1014 ep = kzalloc(sizeof(*ep), GFP_KERNEL);
1015 if (unlikely(!ep))
1016 goto free_uid;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001017
Davide Libenzid47de162007-05-15 01:40:41 -07001018 mutex_init(&ep->mtx);
Roman Penyaeva218cc42019-03-07 16:28:53 -08001019 rwlock_init(&ep->lock);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001020 init_waitqueue_head(&ep->wq);
1021 init_waitqueue_head(&ep->poll_wait);
1022 INIT_LIST_HEAD(&ep->rdllist);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001023 ep->rbr = RB_ROOT_CACHED;
Davide Libenzid47de162007-05-15 01:40:41 -07001024 ep->ovflist = EP_UNACTIVE_PTR;
Davide Libenzi7ef99642008-12-01 13:13:55 -08001025 ep->user = user;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001026
1027 *pep = ep;
1028
Davide Libenzi7699acd2007-05-10 22:23:23 -07001029 return 0;
Davide Libenzi7ef99642008-12-01 13:13:55 -08001030
1031free_uid:
1032 free_uid(user);
1033 return error;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001034}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001035
1036/*
Davide Libenzic7ea7632007-05-15 01:40:47 -07001037 * Search the file inside the eventpoll tree. The RB tree operations
1038 * are protected by the "mtx" mutex, and ep_find() must be called with
1039 * "mtx" held.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001040 */
1041static struct epitem *ep_find(struct eventpoll *ep, struct file *file, int fd)
1042{
1043 int kcmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001044 struct rb_node *rbp;
1045 struct epitem *epi, *epir = NULL;
1046 struct epoll_filefd ffd;
1047
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001048 ep_set_ffd(&ffd, file, fd);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001049 for (rbp = ep->rbr.rb_root.rb_node; rbp; ) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001050 epi = rb_entry(rbp, struct epitem, rbn);
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001051 kcmp = ep_cmp_ffd(&ffd, &epi->ffd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001052 if (kcmp > 0)
1053 rbp = rbp->rb_right;
1054 else if (kcmp < 0)
1055 rbp = rbp->rb_left;
1056 else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001057 epir = epi;
1058 break;
1059 }
1060 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001061
Linus Torvalds1da177e2005-04-16 15:20:36 -07001062 return epir;
1063}
1064
Cyrill Gorcunov92ef6da2017-07-12 14:34:31 -07001065#ifdef CONFIG_CHECKPOINT_RESTORE
Cyrill Gorcunov0791e362017-07-12 14:34:28 -07001066static struct epitem *ep_find_tfd(struct eventpoll *ep, int tfd, unsigned long toff)
1067{
1068 struct rb_node *rbp;
1069 struct epitem *epi;
1070
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001071 for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) {
Cyrill Gorcunov0791e362017-07-12 14:34:28 -07001072 epi = rb_entry(rbp, struct epitem, rbn);
1073 if (epi->ffd.fd == tfd) {
1074 if (toff == 0)
1075 return epi;
1076 else
1077 toff--;
1078 }
1079 cond_resched();
1080 }
1081
1082 return NULL;
1083}
1084
1085struct file *get_epoll_tfile_raw_ptr(struct file *file, int tfd,
1086 unsigned long toff)
1087{
1088 struct file *file_raw;
1089 struct eventpoll *ep;
1090 struct epitem *epi;
1091
1092 if (!is_file_epoll(file))
1093 return ERR_PTR(-EINVAL);
1094
1095 ep = file->private_data;
1096
1097 mutex_lock(&ep->mtx);
1098 epi = ep_find_tfd(ep, tfd, toff);
1099 if (epi)
1100 file_raw = epi->ffd.file;
1101 else
1102 file_raw = ERR_PTR(-ENOENT);
1103 mutex_unlock(&ep->mtx);
1104
1105 return file_raw;
1106}
Cyrill Gorcunov92ef6da2017-07-12 14:34:31 -07001107#endif /* CONFIG_CHECKPOINT_RESTORE */
Cyrill Gorcunov0791e362017-07-12 14:34:28 -07001108
Roman Penyaeva218cc42019-03-07 16:28:53 -08001109/**
1110 * Adds a new entry to the tail of the list in a lockless way, i.e.
1111 * multiple CPUs are allowed to call this function concurrently.
1112 *
1113 * Beware: it is necessary to prevent any other modifications of the
1114 * existing list until all changes are completed, in other words
1115 * concurrent list_add_tail_lockless() calls should be protected
1116 * with a read lock, where write lock acts as a barrier which
1117 * makes sure all list_add_tail_lockless() calls are fully
1118 * completed.
1119 *
1120 * Also an element can be locklessly added to the list only in one
1121 * direction i.e. either to the tail either to the head, otherwise
1122 * concurrent access will corrupt the list.
1123 *
1124 * Returns %false if element has been already added to the list, %true
1125 * otherwise.
1126 */
1127static inline bool list_add_tail_lockless(struct list_head *new,
1128 struct list_head *head)
1129{
1130 struct list_head *prev;
1131
1132 /*
1133 * This is simple 'new->next = head' operation, but cmpxchg()
1134 * is used in order to detect that same element has been just
1135 * added to the list from another CPU: the winner observes
1136 * new->next == new.
1137 */
1138 if (cmpxchg(&new->next, new, head) != new)
1139 return false;
1140
1141 /*
1142 * Initially ->next of a new element must be updated with the head
1143 * (we are inserting to the tail) and only then pointers are atomically
1144 * exchanged. XCHG guarantees memory ordering, thus ->next should be
1145 * updated before pointers are actually swapped and pointers are
1146 * swapped before prev->next is updated.
1147 */
1148
1149 prev = xchg(&head->prev, new);
1150
1151 /*
1152 * It is safe to modify prev->next and new->prev, because a new element
1153 * is added only to the tail and new->next is updated before XCHG.
1154 */
1155
1156 prev->next = new;
1157 new->prev = prev;
1158
1159 return true;
1160}
1161
1162/**
1163 * Chains a new epi entry to the tail of the ep->ovflist in a lockless way,
1164 * i.e. multiple CPUs are allowed to call this function concurrently.
1165 *
1166 * Returns %false if epi element has been already chained, %true otherwise.
1167 */
1168static inline bool chain_epi_lockless(struct epitem *epi)
1169{
1170 struct eventpoll *ep = epi->ep;
1171
Khazhismel Kumykov0c54a6a2020-05-07 18:35:59 -07001172 /* Fast preliminary check */
1173 if (epi->next != EP_UNACTIVE_PTR)
1174 return false;
1175
Roman Penyaeva218cc42019-03-07 16:28:53 -08001176 /* Check that the same epi has not been just chained from another CPU */
1177 if (cmpxchg(&epi->next, EP_UNACTIVE_PTR, NULL) != EP_UNACTIVE_PTR)
1178 return false;
1179
1180 /* Atomically exchange tail */
1181 epi->next = xchg(&ep->ovflist, epi);
1182
1183 return true;
1184}
1185
Linus Torvalds1da177e2005-04-16 15:20:36 -07001186/*
Davide Libenzi7699acd2007-05-10 22:23:23 -07001187 * This is the callback that is passed to the wait queue wakeup
Daniel Balutabf6a41d2011-01-30 23:42:29 +02001188 * mechanism. It is called by the stored file descriptors when they
Davide Libenzi7699acd2007-05-10 22:23:23 -07001189 * have events to report.
Roman Penyaeva218cc42019-03-07 16:28:53 -08001190 *
1191 * This callback takes a read lock in order not to content with concurrent
1192 * events from another file descriptors, thus all modifications to ->rdllist
1193 * or ->ovflist are lockless. Read lock is paired with the write lock from
1194 * ep_scan_ready_list(), which stops all list modifications and guarantees
1195 * that lists state is seen correctly.
1196 *
1197 * Another thing worth to mention is that ep_poll_callback() can be called
1198 * concurrently for the same @epi from different CPUs if poll table was inited
1199 * with several wait queues entries. Plural wakeup from different CPUs of a
1200 * single wait queue is serialized by wq.lock, but the case when multiple wait
1201 * queues are used should be detected accordingly. This is detected using
1202 * cmpxchg() operation.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001203 */
Ingo Molnarac6424b2017-06-20 12:06:13 +02001204static int ep_poll_callback(wait_queue_entry_t *wait, unsigned mode, int sync, void *key)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001205{
Davide Libenzi7699acd2007-05-10 22:23:23 -07001206 int pwake = 0;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001207 struct epitem *epi = ep_item_from_wait(wait);
1208 struct eventpoll *ep = epi->ep;
Al Viro3ad6f932017-07-03 20:14:56 -04001209 __poll_t pollflags = key_to_poll(key);
Roman Penyaeva218cc42019-03-07 16:28:53 -08001210 unsigned long flags;
Jason Barondf0108c2016-01-20 14:59:24 -08001211 int ewake = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001212
Roman Penyaeva218cc42019-03-07 16:28:53 -08001213 read_lock_irqsave(&ep->lock, flags);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001214
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -07001215 ep_set_busy_poll_napi_id(epi);
1216
Davide Libenzi7699acd2007-05-10 22:23:23 -07001217 /*
1218 * If the event mask does not contain any poll(2) event, we consider the
1219 * descriptor to be disabled. This condition is likely the effect of the
1220 * EPOLLONESHOT bit that disables the descriptor when an event is received,
1221 * until the next EPOLL_CTL_MOD will be issued.
1222 */
1223 if (!(epi->event.events & ~EP_PRIVATE_BITS))
Davide Libenzid47de162007-05-15 01:40:41 -07001224 goto out_unlock;
1225
1226 /*
Davide Libenzi2dfa4ee2009-03-31 15:24:22 -07001227 * Check the events coming with the callback. At this stage, not
1228 * every device reports the events in the "key" parameter of the
1229 * callback. We need to be able to handle both cases here, hence the
1230 * test for "key" != NULL before the event match test.
1231 */
Al Viro3ad6f932017-07-03 20:14:56 -04001232 if (pollflags && !(pollflags & epi->event.events))
Davide Libenzi2dfa4ee2009-03-31 15:24:22 -07001233 goto out_unlock;
1234
1235 /*
Daniel Balutabf6a41d2011-01-30 23:42:29 +02001236 * If we are transferring events to userspace, we can hold no locks
Davide Libenzid47de162007-05-15 01:40:41 -07001237 * (because we're accessing user memory, and because of linux f_op->poll()
Daniel Balutabf6a41d2011-01-30 23:42:29 +02001238 * semantics). All the events that happen during that period of time are
Davide Libenzid47de162007-05-15 01:40:41 -07001239 * chained in ep->ovflist and requeued later on.
1240 */
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001241 if (READ_ONCE(ep->ovflist) != EP_UNACTIVE_PTR) {
Khazhismel Kumykov0c54a6a2020-05-07 18:35:59 -07001242 if (chain_epi_lockless(epi))
Roman Penyaevc3e320b2019-03-07 16:28:49 -08001243 ep_pm_stay_awake_rcu(epi);
Khazhismel Kumykov0c54a6a2020-05-07 18:35:59 -07001244 } else if (!ep_is_linked(epi)) {
1245 /* In the usual case, add event to ready list. */
1246 if (list_add_tail_lockless(&epi->rdllink, &ep->rdllist))
1247 ep_pm_stay_awake_rcu(epi);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001248 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07001249
Davide Libenzi7699acd2007-05-10 22:23:23 -07001250 /*
1251 * Wake up ( if active ) both the eventpoll wait list and the ->poll()
1252 * wait list.
1253 */
Jason Barondf0108c2016-01-20 14:59:24 -08001254 if (waitqueue_active(&ep->wq)) {
Jason Baronb6a515c2016-02-05 15:37:04 -08001255 if ((epi->event.events & EPOLLEXCLUSIVE) &&
Al Viro3ad6f932017-07-03 20:14:56 -04001256 !(pollflags & POLLFREE)) {
1257 switch (pollflags & EPOLLINOUT_BITS) {
Linus Torvaldsa9a08842018-02-11 14:34:03 -08001258 case EPOLLIN:
1259 if (epi->event.events & EPOLLIN)
Jason Baronb6a515c2016-02-05 15:37:04 -08001260 ewake = 1;
1261 break;
Linus Torvaldsa9a08842018-02-11 14:34:03 -08001262 case EPOLLOUT:
1263 if (epi->event.events & EPOLLOUT)
Jason Baronb6a515c2016-02-05 15:37:04 -08001264 ewake = 1;
1265 break;
1266 case 0:
1267 ewake = 1;
1268 break;
1269 }
1270 }
Roman Penyaeva218cc42019-03-07 16:28:53 -08001271 wake_up(&ep->wq);
Jason Barondf0108c2016-01-20 14:59:24 -08001272 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07001273 if (waitqueue_active(&ep->poll_wait))
1274 pwake++;
1275
Davide Libenzid47de162007-05-15 01:40:41 -07001276out_unlock:
Roman Penyaeva218cc42019-03-07 16:28:53 -08001277 read_unlock_irqrestore(&ep->lock, flags);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001278
1279 /* We have to call this outside the lock */
1280 if (pwake)
Jason Baronefcdd352020-04-06 20:11:23 -07001281 ep_poll_safewake(ep, epi);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001282
Oleg Nesterov138e4ad2017-09-01 18:55:33 +02001283 if (!(epi->event.events & EPOLLEXCLUSIVE))
1284 ewake = 1;
Jason Barondf0108c2016-01-20 14:59:24 -08001285
Al Viro3ad6f932017-07-03 20:14:56 -04001286 if (pollflags & POLLFREE) {
Oleg Nesterov138e4ad2017-09-01 18:55:33 +02001287 /*
1288 * If we race with ep_remove_wait_queue() it can miss
1289 * ->whead = NULL and do another remove_wait_queue() after
1290 * us, so we can't use __remove_wait_queue().
1291 */
1292 list_del_init(&wait->entry);
1293 /*
1294 * ->whead != NULL protects us from the race with ep_free()
1295 * or ep_remove(), ep_remove_wait_queue() takes whead->lock
1296 * held by the caller. Once we nullify it, nothing protects
1297 * ep/epi or even wait.
1298 */
1299 smp_store_release(&ep_pwq_from_wait(wait)->whead, NULL);
1300 }
1301
1302 return ewake;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001303}
1304
Linus Torvalds1da177e2005-04-16 15:20:36 -07001305/*
1306 * This is the callback that is used to add our wait queue to the
1307 * target file wakeup lists.
1308 */
1309static void ep_ptable_queue_proc(struct file *file, wait_queue_head_t *whead,
1310 poll_table *pt)
1311{
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001312 struct epitem *epi = ep_item_from_epqueue(pt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001313 struct eppoll_entry *pwq;
1314
Christoph Lametere94b1762006-12-06 20:33:17 -08001315 if (epi->nwait >= 0 && (pwq = kmem_cache_alloc(pwq_cache, GFP_KERNEL))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316 init_waitqueue_func_entry(&pwq->wait, ep_poll_callback);
1317 pwq->whead = whead;
1318 pwq->base = epi;
Jason Barondf0108c2016-01-20 14:59:24 -08001319 if (epi->event.events & EPOLLEXCLUSIVE)
1320 add_wait_queue_exclusive(whead, &pwq->wait);
1321 else
1322 add_wait_queue(whead, &pwq->wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323 list_add_tail(&pwq->llink, &epi->pwqlist);
1324 epi->nwait++;
Davide Libenzi296e2362009-03-31 15:24:11 -07001325 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326 /* We have to signal that an error occurred */
1327 epi->nwait = -1;
Davide Libenzi296e2362009-03-31 15:24:11 -07001328 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001329}
1330
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331static void ep_rbtree_insert(struct eventpoll *ep, struct epitem *epi)
1332{
1333 int kcmp;
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001334 struct rb_node **p = &ep->rbr.rb_root.rb_node, *parent = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001335 struct epitem *epic;
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001336 bool leftmost = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001337
1338 while (*p) {
1339 parent = *p;
1340 epic = rb_entry(parent, struct epitem, rbn);
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001341 kcmp = ep_cmp_ffd(&epi->ffd, &epic->ffd);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001342 if (kcmp > 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343 p = &parent->rb_right;
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001344 leftmost = false;
1345 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -07001346 p = &parent->rb_left;
1347 }
1348 rb_link_node(&epi->rbn, parent, p);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001349 rb_insert_color_cached(&epi->rbn, &ep->rbr, leftmost);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001350}
1351
Andrew Mortona80a6b82012-11-08 15:53:35 -08001352
1353
Jason Baron28d82dc2012-01-12 17:17:43 -08001354#define PATH_ARR_SIZE 5
1355/*
1356 * These are the number paths of length 1 to 5, that we are allowing to emanate
1357 * from a single file of interest. For example, we allow 1000 paths of length
1358 * 1, to emanate from each file of interest. This essentially represents the
1359 * potential wakeup paths, which need to be limited in order to avoid massive
1360 * uncontrolled wakeup storms. The common use case should be a single ep which
1361 * is connected to n file sources. In this case each file source has 1 path
1362 * of length 1. Thus, the numbers below should be more than sufficient. These
1363 * path limits are enforced during an EPOLL_CTL_ADD operation, since a modify
1364 * and delete can't add additional paths. Protected by the epmutex.
1365 */
1366static const int path_limits[PATH_ARR_SIZE] = { 1000, 500, 100, 50, 10 };
1367static int path_count[PATH_ARR_SIZE];
1368
1369static int path_count_inc(int nests)
1370{
Jason Baron93dc6102012-03-16 16:34:03 -04001371 /* Allow an arbitrary number of depth 1 paths */
1372 if (nests == 0)
1373 return 0;
1374
Jason Baron28d82dc2012-01-12 17:17:43 -08001375 if (++path_count[nests] > path_limits[nests])
1376 return -1;
1377 return 0;
1378}
1379
1380static void path_count_init(void)
1381{
1382 int i;
1383
1384 for (i = 0; i < PATH_ARR_SIZE; i++)
1385 path_count[i] = 0;
1386}
1387
1388static int reverse_path_check_proc(void *priv, void *cookie, int call_nests)
1389{
1390 int error = 0;
1391 struct file *file = priv;
1392 struct file *child_file;
1393 struct epitem *epi;
1394
Jason Baronae10b2b2013-11-12 15:10:16 -08001395 /* CTL_DEL can remove links here, but that can't increase our count */
1396 rcu_read_lock();
1397 list_for_each_entry_rcu(epi, &file->f_ep_links, fllink) {
Jason Baron28d82dc2012-01-12 17:17:43 -08001398 child_file = epi->ep->file;
1399 if (is_file_epoll(child_file)) {
1400 if (list_empty(&child_file->f_ep_links)) {
1401 if (path_count_inc(call_nests)) {
1402 error = -1;
1403 break;
1404 }
1405 } else {
1406 error = ep_call_nested(&poll_loop_ncalls,
Jason Baron28d82dc2012-01-12 17:17:43 -08001407 reverse_path_check_proc,
1408 child_file, child_file,
1409 current);
1410 }
1411 if (error != 0)
1412 break;
1413 } else {
1414 printk(KERN_ERR "reverse_path_check_proc: "
1415 "file is not an ep!\n");
1416 }
1417 }
Jason Baronae10b2b2013-11-12 15:10:16 -08001418 rcu_read_unlock();
Jason Baron28d82dc2012-01-12 17:17:43 -08001419 return error;
1420}
1421
1422/**
1423 * reverse_path_check - The tfile_check_list is list of file *, which have
1424 * links that are proposed to be newly added. We need to
1425 * make sure that those added links don't add too many
1426 * paths such that we will spend all our time waking up
1427 * eventpoll objects.
1428 *
1429 * Returns: Returns zero if the proposed links don't create too many paths,
1430 * -1 otherwise.
1431 */
1432static int reverse_path_check(void)
1433{
Jason Baron28d82dc2012-01-12 17:17:43 -08001434 int error = 0;
1435 struct file *current_file;
1436
1437 /* let's call this for all tfiles */
1438 list_for_each_entry(current_file, &tfile_check_list, f_tfile_llink) {
Jason Baron28d82dc2012-01-12 17:17:43 -08001439 path_count_init();
Davidlohr Bueso74bdc122019-01-03 15:27:02 -08001440 error = ep_call_nested(&poll_loop_ncalls,
Jason Baron28d82dc2012-01-12 17:17:43 -08001441 reverse_path_check_proc, current_file,
1442 current_file, current);
1443 if (error)
1444 break;
1445 }
1446 return error;
1447}
1448
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001449static int ep_create_wakeup_source(struct epitem *epi)
1450{
Al Viro3701cb52020-09-24 19:41:58 -04001451 struct name_snapshot n;
Eric Wongeea1d582013-04-30 15:27:39 -07001452 struct wakeup_source *ws;
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001453
1454 if (!epi->ep->ws) {
Tri Voc8377ad2019-08-06 18:48:46 -07001455 epi->ep->ws = wakeup_source_register(NULL, "eventpoll");
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001456 if (!epi->ep->ws)
1457 return -ENOMEM;
1458 }
1459
Al Viro3701cb52020-09-24 19:41:58 -04001460 take_dentry_name_snapshot(&n, epi->ffd.file->f_path.dentry);
1461 ws = wakeup_source_register(NULL, n.name.name);
1462 release_dentry_name_snapshot(&n);
Eric Wongeea1d582013-04-30 15:27:39 -07001463
1464 if (!ws)
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001465 return -ENOMEM;
Eric Wongeea1d582013-04-30 15:27:39 -07001466 rcu_assign_pointer(epi->ws, ws);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001467
1468 return 0;
1469}
1470
Eric Wongeea1d582013-04-30 15:27:39 -07001471/* rare code path, only used when EPOLL_CTL_MOD removes a wakeup source */
1472static noinline void ep_destroy_wakeup_source(struct epitem *epi)
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001473{
Eric Wongeea1d582013-04-30 15:27:39 -07001474 struct wakeup_source *ws = ep_wakeup_source(epi);
1475
Eric Wongd6d67e72013-04-30 15:27:43 -07001476 RCU_INIT_POINTER(epi->ws, NULL);
Eric Wongeea1d582013-04-30 15:27:39 -07001477
1478 /*
1479 * wait for ep_pm_stay_awake_rcu to finish, synchronize_rcu is
1480 * used internally by wakeup_source_remove, too (called by
1481 * wakeup_source_unregister), so we cannot use call_rcu
1482 */
1483 synchronize_rcu();
1484 wakeup_source_unregister(ws);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001485}
1486
Davide Libenzic7ea7632007-05-15 01:40:47 -07001487/*
1488 * Must be called with "mtx" held.
1489 */
Al Virobec1a5022017-11-28 19:43:33 -05001490static int ep_insert(struct eventpoll *ep, const struct epoll_event *event,
Jason Baron67347fe2013-11-12 15:10:18 -08001491 struct file *tfile, int fd, int full_check)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001492{
Al Virod85e2aa2018-02-01 15:24:58 -05001493 int error, pwake = 0;
1494 __poll_t revents;
Robin Holt52bd19f72011-01-12 17:00:01 -08001495 long user_watches;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496 struct epitem *epi;
1497 struct ep_pqueue epq;
1498
Davidlohr Bueso92e64172018-08-21 21:56:45 -07001499 lockdep_assert_irqs_enabled();
1500
Robin Holt52bd19f72011-01-12 17:00:01 -08001501 user_watches = atomic_long_read(&ep->user->epoll_watches);
1502 if (unlikely(user_watches >= max_user_watches))
Davide Libenzi7ef99642008-12-01 13:13:55 -08001503 return -ENOSPC;
Christoph Lametere94b1762006-12-06 20:33:17 -08001504 if (!(epi = kmem_cache_alloc(epi_cache, GFP_KERNEL)))
Davide Libenzi7ef99642008-12-01 13:13:55 -08001505 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001506
1507 /* Item initialization follow here ... */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001508 INIT_LIST_HEAD(&epi->rdllink);
1509 INIT_LIST_HEAD(&epi->fllink);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001510 INIT_LIST_HEAD(&epi->pwqlist);
1511 epi->ep = ep;
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001512 ep_set_ffd(&epi->ffd, tfile, fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001513 epi->event = *event;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001514 epi->nwait = 0;
Davide Libenzid47de162007-05-15 01:40:41 -07001515 epi->next = EP_UNACTIVE_PTR;
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001516 if (epi->event.events & EPOLLWAKEUP) {
1517 error = ep_create_wakeup_source(epi);
1518 if (error)
1519 goto error_create_wakeup_source;
1520 } else {
Eric Wongeea1d582013-04-30 15:27:39 -07001521 RCU_INIT_POINTER(epi->ws, NULL);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001522 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001523
Al Virof8d4f442020-09-09 22:25:06 -04001524 /* Add the current item to the list of active epoll hook for this file */
1525 spin_lock(&tfile->f_lock);
1526 list_add_tail_rcu(&epi->fllink, &tfile->f_ep_links);
1527 spin_unlock(&tfile->f_lock);
1528
1529 /*
1530 * Add the current item to the RB tree. All RB tree operations are
1531 * protected by "mtx", and ep_insert() is called with "mtx" held.
1532 */
1533 ep_rbtree_insert(ep, epi);
1534
1535 /* now check if we've created too many backpaths */
1536 error = -EINVAL;
1537 if (full_check && reverse_path_check())
1538 goto error_remove_epi;
1539
Linus Torvalds1da177e2005-04-16 15:20:36 -07001540 /* Initialize the poll table using the queue callback */
1541 epq.epi = epi;
1542 init_poll_funcptr(&epq.pt, ep_ptable_queue_proc);
1543
1544 /*
1545 * Attach the item to the poll hooks and get current event bits.
1546 * We can safely use the file* here because its usage count has
Davide Libenzic7ea7632007-05-15 01:40:47 -07001547 * been increased by the caller of this function. Note that after
1548 * this operation completes, the poll callback can start hitting
1549 * the new item.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001550 */
Jason Baron37b5e522017-11-17 15:29:06 -08001551 revents = ep_item_poll(epi, &epq.pt, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001552
1553 /*
1554 * We have to check if something went wrong during the poll wait queue
1555 * install process. Namely an allocation for a wait queue failed due
1556 * high memory pressure.
1557 */
Davide Libenzi7ef99642008-12-01 13:13:55 -08001558 error = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559 if (epi->nwait < 0)
Davide Libenzi7699acd2007-05-10 22:23:23 -07001560 goto error_unregister;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001561
Davide Libenzic7ea7632007-05-15 01:40:47 -07001562 /* We have to drop the new item inside our item list to keep track of it */
Roman Penyaeva218cc42019-03-07 16:28:53 -08001563 write_lock_irq(&ep->lock);
Davide Libenzic7ea7632007-05-15 01:40:47 -07001564
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -07001565 /* record NAPI ID of new item if present */
1566 ep_set_busy_poll_napi_id(epi);
1567
Linus Torvalds1da177e2005-04-16 15:20:36 -07001568 /* If the file is already "ready" we drop it inside the ready list */
Davidlohr Bueso992991c2018-08-21 21:58:26 -07001569 if (revents && !ep_is_linked(epi)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001570 list_add_tail(&epi->rdllink, &ep->rdllist);
Eric Wongeea1d582013-04-30 15:27:39 -07001571 ep_pm_stay_awake(epi);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001572
1573 /* Notify waiting tasks that events are available */
1574 if (waitqueue_active(&ep->wq))
Roman Penyaeva218cc42019-03-07 16:28:53 -08001575 wake_up(&ep->wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576 if (waitqueue_active(&ep->poll_wait))
1577 pwake++;
1578 }
1579
Roman Penyaeva218cc42019-03-07 16:28:53 -08001580 write_unlock_irq(&ep->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001581
Robin Holt52bd19f72011-01-12 17:00:01 -08001582 atomic_long_inc(&ep->user->epoll_watches);
Davide Libenzi7ef99642008-12-01 13:13:55 -08001583
Linus Torvalds1da177e2005-04-16 15:20:36 -07001584 /* We have to call this outside the lock */
1585 if (pwake)
Jason Baronefcdd352020-04-06 20:11:23 -07001586 ep_poll_safewake(ep, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001587
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588 return 0;
1589
Al Virof8d4f442020-09-09 22:25:06 -04001590error_unregister:
1591 ep_unregister_pollwait(ep, epi);
Jason Baron28d82dc2012-01-12 17:17:43 -08001592error_remove_epi:
1593 spin_lock(&tfile->f_lock);
Jason Baronae10b2b2013-11-12 15:10:16 -08001594 list_del_rcu(&epi->fllink);
Jason Baron28d82dc2012-01-12 17:17:43 -08001595 spin_unlock(&tfile->f_lock);
1596
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001597 rb_erase_cached(&epi->rbn, &ep->rbr);
Jason Baron28d82dc2012-01-12 17:17:43 -08001598
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599 /*
1600 * We need to do this because an event could have been arrived on some
Davide Libenzi67647d02007-05-15 01:40:52 -07001601 * allocated wait queue. Note that we don't care about the ep->ovflist
1602 * list, since that is used/cleaned only inside a section bound by "mtx".
1603 * And ep_insert() is called with "mtx" held.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001604 */
Roman Penyaeva218cc42019-03-07 16:28:53 -08001605 write_lock_irq(&ep->lock);
Davidlohr Bueso992991c2018-08-21 21:58:26 -07001606 if (ep_is_linked(epi))
Davide Libenzi6192bd52007-05-08 00:25:41 -07001607 list_del_init(&epi->rdllink);
Roman Penyaeva218cc42019-03-07 16:28:53 -08001608 write_unlock_irq(&ep->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001609
Eric Wongeea1d582013-04-30 15:27:39 -07001610 wakeup_source_unregister(ep_wakeup_source(epi));
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001611
1612error_create_wakeup_source:
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001613 kmem_cache_free(epi_cache, epi);
Davide Libenzi7ef99642008-12-01 13:13:55 -08001614
Linus Torvalds1da177e2005-04-16 15:20:36 -07001615 return error;
1616}
1617
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618/*
1619 * Modify the interest event mask by dropping an event if the new mask
Davide Libenzic7ea7632007-05-15 01:40:47 -07001620 * has a match in the current file status. Must be called with "mtx" held.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001621 */
Al Virobec1a5022017-11-28 19:43:33 -05001622static int ep_modify(struct eventpoll *ep, struct epitem *epi,
1623 const struct epoll_event *event)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001624{
1625 int pwake = 0;
Hans Verkuil626cf232012-03-23 15:02:27 -07001626 poll_table pt;
1627
Davidlohr Bueso92e64172018-08-21 21:56:45 -07001628 lockdep_assert_irqs_enabled();
1629
Hans Verkuil626cf232012-03-23 15:02:27 -07001630 init_poll_funcptr(&pt, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001631
1632 /*
Tony Battersbye057e152009-03-31 15:24:15 -07001633 * Set the new event interest mask before calling f_op->poll();
1634 * otherwise we might miss an event that happens between the
1635 * f_op->poll() call and the new event set registering.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001636 */
Eric Wong128dd172013-01-01 21:20:27 +00001637 epi->event.events = event->events; /* need barrier below */
Tony Battersbye057e152009-03-31 15:24:15 -07001638 epi->event.data = event->data; /* protected by mtx */
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001639 if (epi->event.events & EPOLLWAKEUP) {
Eric Wongeea1d582013-04-30 15:27:39 -07001640 if (!ep_has_wakeup_source(epi))
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001641 ep_create_wakeup_source(epi);
Eric Wongeea1d582013-04-30 15:27:39 -07001642 } else if (ep_has_wakeup_source(epi)) {
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001643 ep_destroy_wakeup_source(epi);
1644 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645
1646 /*
Eric Wong128dd172013-01-01 21:20:27 +00001647 * The following barrier has two effects:
1648 *
1649 * 1) Flush epi changes above to other CPUs. This ensures
1650 * we do not miss events from ep_poll_callback if an
1651 * event occurs immediately after we call f_op->poll().
Roman Penyaeva218cc42019-03-07 16:28:53 -08001652 * We need this because we did not take ep->lock while
Eric Wong128dd172013-01-01 21:20:27 +00001653 * changing epi above (but ep_poll_callback does take
Roman Penyaeva218cc42019-03-07 16:28:53 -08001654 * ep->lock).
Eric Wong128dd172013-01-01 21:20:27 +00001655 *
1656 * 2) We also need to ensure we do not miss _past_ events
1657 * when calling f_op->poll(). This barrier also
1658 * pairs with the barrier in wq_has_sleeper (see
1659 * comments for wq_has_sleeper).
1660 *
1661 * This barrier will now guarantee ep_poll_callback or f_op->poll
1662 * (or both) will notice the readiness of an item.
1663 */
1664 smp_mb();
1665
1666 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001667 * Get current event bits. We can safely use the file* here because
1668 * its usage count has been increased by the caller of this function.
Davide Libenzic7ea7632007-05-15 01:40:47 -07001669 * If the item is "hot" and it is not registered inside the ready
Davide Libenzi67647d02007-05-15 01:40:52 -07001670 * list, push it inside.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001671 */
Al Viro69112732017-11-28 19:56:15 -05001672 if (ep_item_poll(epi, &pt, 1)) {
Roman Penyaeva218cc42019-03-07 16:28:53 -08001673 write_lock_irq(&ep->lock);
Davidlohr Bueso992991c2018-08-21 21:58:26 -07001674 if (!ep_is_linked(epi)) {
Davide Libenzic7ea7632007-05-15 01:40:47 -07001675 list_add_tail(&epi->rdllink, &ep->rdllist);
Eric Wongeea1d582013-04-30 15:27:39 -07001676 ep_pm_stay_awake(epi);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001677
Davide Libenzic7ea7632007-05-15 01:40:47 -07001678 /* Notify waiting tasks that events are available */
1679 if (waitqueue_active(&ep->wq))
Roman Penyaeva218cc42019-03-07 16:28:53 -08001680 wake_up(&ep->wq);
Davide Libenzic7ea7632007-05-15 01:40:47 -07001681 if (waitqueue_active(&ep->poll_wait))
1682 pwake++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001683 }
Roman Penyaeva218cc42019-03-07 16:28:53 -08001684 write_unlock_irq(&ep->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001685 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001686
1687 /* We have to call this outside the lock */
1688 if (pwake)
Jason Baronefcdd352020-04-06 20:11:23 -07001689 ep_poll_safewake(ep, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001690
1691 return 0;
1692}
1693
Al Virod85e2aa2018-02-01 15:24:58 -05001694static __poll_t ep_send_events_proc(struct eventpoll *ep, struct list_head *head,
Davide Libenzi296e2362009-03-31 15:24:11 -07001695 void *priv)
Davide Libenzi5071f972009-03-31 15:24:10 -07001696{
1697 struct ep_send_events_data *esed = priv;
Al Virod85e2aa2018-02-01 15:24:58 -05001698 __poll_t revents;
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001699 struct epitem *epi, *tmp;
1700 struct epoll_event __user *uevent = esed->events;
Eric Wongeea1d582013-04-30 15:27:39 -07001701 struct wakeup_source *ws;
Hans Verkuil626cf232012-03-23 15:02:27 -07001702 poll_table pt;
1703
1704 init_poll_funcptr(&pt, NULL);
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001705 esed->res = 0;
Davide Libenzi5071f972009-03-31 15:24:10 -07001706
Davide Libenzi296e2362009-03-31 15:24:11 -07001707 /*
Davide Libenzi5071f972009-03-31 15:24:10 -07001708 * We can loop without lock because we are passed a task private list.
1709 * Items cannot vanish during the loop because ep_scan_ready_list() is
1710 * holding "mtx" during this call.
Davide Libenzi296e2362009-03-31 15:24:11 -07001711 */
Davidlohr Bueso21877e12019-01-03 15:27:12 -08001712 lockdep_assert_held(&ep->mtx);
1713
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001714 list_for_each_entry_safe(epi, tmp, head, rdllink) {
1715 if (esed->res >= esed->maxevents)
1716 break;
Davide Libenzi5071f972009-03-31 15:24:10 -07001717
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001718 /*
1719 * Activate ep->ws before deactivating epi->ws to prevent
1720 * triggering auto-suspend here (in case we reactive epi->ws
1721 * below).
1722 *
1723 * This could be rearranged to delay the deactivation of epi->ws
1724 * instead, but then epi->ws would temporarily be out of sync
1725 * with ep_is_linked().
1726 */
Eric Wongeea1d582013-04-30 15:27:39 -07001727 ws = ep_wakeup_source(epi);
1728 if (ws) {
1729 if (ws->active)
1730 __pm_stay_awake(ep->ws);
1731 __pm_relax(ws);
1732 }
1733
Davide Libenzi5071f972009-03-31 15:24:10 -07001734 list_del_init(&epi->rdllink);
1735
Davide Libenzi296e2362009-03-31 15:24:11 -07001736 /*
Davide Libenzi5071f972009-03-31 15:24:10 -07001737 * If the event mask intersect the caller-requested one,
1738 * deliver the event to userspace. Again, ep_scan_ready_list()
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001739 * is holding ep->mtx, so no operations coming from userspace
Davide Libenzi5071f972009-03-31 15:24:10 -07001740 * can change the item.
Davide Libenzi296e2362009-03-31 15:24:11 -07001741 */
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001742 revents = ep_item_poll(epi, &pt, 1);
1743 if (!revents)
1744 continue;
1745
1746 if (__put_user(revents, &uevent->events) ||
1747 __put_user(epi->event.data, &uevent->data)) {
1748 list_add(&epi->rdllink, head);
1749 ep_pm_stay_awake(epi);
1750 if (!esed->res)
1751 esed->res = -EFAULT;
1752 return 0;
1753 }
1754 esed->res++;
1755 uevent++;
1756 if (epi->event.events & EPOLLONESHOT)
1757 epi->event.events &= EP_PRIVATE_BITS;
1758 else if (!(epi->event.events & EPOLLET)) {
1759 /*
1760 * If this file has been added with Level
1761 * Trigger mode, we need to insert back inside
1762 * the ready list, so that the next call to
1763 * epoll_wait() will check again the events
1764 * availability. At this point, no one can insert
1765 * into ep->rdllist besides us. The epoll_ctl()
1766 * callers are locked out by
1767 * ep_scan_ready_list() holding "mtx" and the
1768 * poll callback will queue them in ep->ovflist.
1769 */
1770 list_add_tail(&epi->rdllink, &ep->rdllist);
1771 ep_pm_stay_awake(epi);
Davide Libenzi296e2362009-03-31 15:24:11 -07001772 }
1773 }
Davide Libenzi5071f972009-03-31 15:24:10 -07001774
Al Virod7ebbe42018-02-01 15:21:13 -05001775 return 0;
Davide Libenzi5071f972009-03-31 15:24:10 -07001776}
1777
Davide Libenzi296e2362009-03-31 15:24:11 -07001778static int ep_send_events(struct eventpoll *ep,
1779 struct epoll_event __user *events, int maxevents)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001780{
Davide Libenzi5071f972009-03-31 15:24:10 -07001781 struct ep_send_events_data esed;
Davide Libenzi6192bd52007-05-08 00:25:41 -07001782
Davide Libenzi5071f972009-03-31 15:24:10 -07001783 esed.maxevents = maxevents;
1784 esed.events = events;
Davide Libenzid47de162007-05-15 01:40:41 -07001785
Al Virod7ebbe42018-02-01 15:21:13 -05001786 ep_scan_ready_list(ep, ep_send_events_proc, &esed, 0, false);
1787 return esed.res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001788}
1789
Deepa Dinamani766b9f92016-05-19 17:09:05 -07001790static inline struct timespec64 ep_set_mstimeout(long ms)
Eric Dumazet0781b902011-02-01 15:52:35 -08001791{
Deepa Dinamani766b9f92016-05-19 17:09:05 -07001792 struct timespec64 now, ts = {
Eric Dumazet0781b902011-02-01 15:52:35 -08001793 .tv_sec = ms / MSEC_PER_SEC,
1794 .tv_nsec = NSEC_PER_MSEC * (ms % MSEC_PER_SEC),
1795 };
1796
Deepa Dinamani766b9f92016-05-19 17:09:05 -07001797 ktime_get_ts64(&now);
1798 return timespec64_add_safe(now, ts);
Eric Dumazet0781b902011-02-01 15:52:35 -08001799}
1800
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001801/**
1802 * ep_poll - Retrieves ready events, and delivers them to the caller supplied
1803 * event buffer.
1804 *
1805 * @ep: Pointer to the eventpoll context.
1806 * @events: Pointer to the userspace buffer where the ready events should be
1807 * stored.
1808 * @maxevents: Size (in terms of number of events) of the caller event buffer.
1809 * @timeout: Maximum timeout for the ready events fetch operation, in
1810 * milliseconds. If the @timeout is zero, the function will not block,
1811 * while if the @timeout is less than zero, the function will block
1812 * until at least one event has been retrieved (or an error
1813 * occurred).
1814 *
1815 * Returns: Returns the number of ready events which have been fetched, or an
1816 * error code, in case of error.
1817 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001818static int ep_poll(struct eventpoll *ep, struct epoll_event __user *events,
1819 int maxevents, long timeout)
1820{
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001821 int res = 0, eavail, timed_out = 0;
John Stultzda8b44d2016-03-17 14:20:51 -07001822 u64 slack = 0;
Ingo Molnarac6424b2017-06-20 12:06:13 +02001823 wait_queue_entry_t wait;
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001824 ktime_t expires, *to = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001825
Davidlohr Bueso679abf32018-08-21 21:58:23 -07001826 lockdep_assert_irqs_enabled();
1827
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001828 if (timeout > 0) {
Deepa Dinamani766b9f92016-05-19 17:09:05 -07001829 struct timespec64 end_time = ep_set_mstimeout(timeout);
Eric Dumazet0781b902011-02-01 15:52:35 -08001830
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001831 slack = select_estimate_accuracy(&end_time);
1832 to = &expires;
Deepa Dinamani766b9f92016-05-19 17:09:05 -07001833 *to = timespec64_to_ktime(end_time);
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001834 } else if (timeout == 0) {
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001835 /*
1836 * Avoid the unnecessary trip to the wait queue loop, if the
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001837 * caller specified a non blocking operation. We still need
1838 * lock because we could race and not see an epi being added
1839 * to the ready list while in irq callback. Thus incorrectly
1840 * returning 0 back to userspace.
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001841 */
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001842 timed_out = 1;
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001843
Roman Penyaeva218cc42019-03-07 16:28:53 -08001844 write_lock_irq(&ep->lock);
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001845 eavail = ep_events_available(ep);
Roman Penyaeva218cc42019-03-07 16:28:53 -08001846 write_unlock_irq(&ep->lock);
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001847
Davidlohr Bueso35cff1a2019-01-03 15:27:22 -08001848 goto send_events;
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001849 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001850
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001851fetch_events:
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -07001852
1853 if (!ep_events_available(ep))
1854 ep_busy_loop(ep, timed_out);
1855
Davide Libenzi3fb0e582011-03-22 16:34:46 -07001856 eavail = ep_events_available(ep);
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001857 if (eavail)
Davidlohr Bueso35cff1a2019-01-03 15:27:22 -08001858 goto send_events;
Jason Baron28d82dc2012-01-12 17:17:43 -08001859
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001860 /*
1861 * Busy poll timed out. Drop NAPI ID for now, we can add
1862 * it back in when we have moved a socket with a valid NAPI
1863 * ID onto the ready list.
1864 */
1865 ep_reset_busy_poll_napi_id(ep);
Jason Baron28d82dc2012-01-12 17:17:43 -08001866
Roman Penyaev412895f2020-05-07 18:36:16 -07001867 do {
1868 /*
1869 * Internally init_wait() uses autoremove_wake_function(),
1870 * thus wait entry is removed from the wait queue on each
1871 * wakeup. Why it is important? In case of several waiters
1872 * each new wakeup will hit the next waiter, giving it the
1873 * chance to harvest new event. Otherwise wakeup can be
1874 * lost. This is also good performance-wise, because on
1875 * normal wakeup path no need to call __remove_wait_queue()
1876 * explicitly, thus ep->lock is not taken, which halts the
1877 * event delivery.
1878 */
1879 init_wait(&wait);
Roman Penyaev65759092020-05-13 17:50:38 -07001880
Roman Penyaev1b537342020-03-21 18:22:30 -07001881 write_lock_irq(&ep->lock);
Roman Penyaev65759092020-05-13 17:50:38 -07001882 /*
1883 * Barrierless variant, waitqueue_active() is called under
1884 * the same lock on wakeup ep_poll_callback() side, so it
1885 * is safe to avoid an explicit barrier.
1886 */
1887 __set_current_state(TASK_INTERRUPTIBLE);
1888
1889 /*
1890 * Do the final check under the lock. ep_scan_ready_list()
1891 * plays with two lists (->rdllist and ->ovflist) and there
1892 * is always a race when both lists are empty for short
1893 * period of time although events are pending, so lock is
1894 * important.
1895 */
1896 eavail = ep_events_available(ep);
1897 if (!eavail) {
1898 if (signal_pending(current))
1899 res = -EINTR;
1900 else
1901 __add_wait_queue_exclusive(&ep->wq, &wait);
1902 }
Roman Penyaev1b537342020-03-21 18:22:30 -07001903 write_unlock_irq(&ep->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001904
Roman Penyaev65759092020-05-13 17:50:38 -07001905 if (eavail || res)
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001906 break;
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001907
Davidlohr Buesoabc610e2019-01-03 15:27:19 -08001908 if (!schedule_hrtimeout_range(to, slack, HRTIMER_MODE_ABS)) {
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001909 timed_out = 1;
Davidlohr Buesoabc610e2019-01-03 15:27:19 -08001910 break;
1911 }
Roman Penyaev412895f2020-05-07 18:36:16 -07001912
1913 /* We were woken up, thus go and try to harvest some events */
1914 eavail = 1;
1915
1916 } while (0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001917
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001918 __set_current_state(TASK_RUNNING);
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001919
Roman Penyaev412895f2020-05-07 18:36:16 -07001920 if (!list_empty_careful(&wait.entry)) {
1921 write_lock_irq(&ep->lock);
1922 __remove_wait_queue(&ep->wq, &wait);
1923 write_unlock_irq(&ep->lock);
1924 }
1925
Davidlohr Bueso35cff1a2019-01-03 15:27:22 -08001926send_events:
Roman Penyaev65759092020-05-13 17:50:38 -07001927 if (fatal_signal_pending(current)) {
1928 /*
1929 * Always short-circuit for fatal signals to allow
1930 * threads to make a timely exit without the chance of
1931 * finding more events available and fetching
1932 * repeatedly.
1933 */
1934 res = -EINTR;
1935 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001936 /*
1937 * Try to transfer events to user space. In case we get 0 events and
1938 * there's still timeout left over, we go trying again in search of
1939 * more luck.
1940 */
Davide Libenzi22bacca2011-02-25 14:44:12 -08001941 if (!res && eavail &&
1942 !(res = ep_send_events(ep, events, maxevents)) && !timed_out)
1943 goto fetch_events;
1944
1945 return res;
1946}
1947
1948/**
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001949 * ep_loop_check_proc - Callback function to be passed to the @ep_call_nested()
Linus Torvalds1da177e2005-04-16 15:20:36 -07001950 * API, to verify that adding an epoll file inside another
1951 * epoll structure, does not violate the constraints, in
1952 * terms of closed loops, or too deep chains (which can
1953 * result in excessive stack usage).
Davide Libenzi22bacca2011-02-25 14:44:12 -08001954 *
1955 * @priv: Pointer to the epoll file to be currently checked.
1956 * @cookie: Original cookie for this call. This is the top-of-the-chain epoll
1957 * data structure pointer.
1958 * @call_nests: Current dept of the @ep_call_nested() call stack.
1959 *
1960 * Returns: Returns zero if adding the epoll @file inside current epoll
1961 * structure @ep does not violate the constraints, or -1 otherwise.
1962 */
1963static int ep_loop_check_proc(void *priv, void *cookie, int call_nests)
1964{
1965 int error = 0;
1966 struct file *file = priv;
1967 struct eventpoll *ep = file->private_data;
1968 struct eventpoll *ep_tovisit;
1969 struct rb_node *rbp;
1970 struct epitem *epi;
1971
1972 mutex_lock_nested(&ep->mtx, call_nests + 1);
Al Viro18306c42020-09-10 08:30:05 -04001973 ep->gen = loop_check_gen;
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;
Al Viro18306c42020-09-10 08:30:05 -04001978 if (ep_tovisit->gen == loop_check_gen)
Davide Libenzi22bacca2011-02-25 14:44:12 -08001979 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 Zyngiera9ed4a62020-08-19 17:12:17 +01001994 if (list_empty(&epi->ffd.file->f_tfile_llink)) {
Al Viro77f46892020-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 Zyngiera9ed4a62020-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{
Al Viro18306c42020-09-10 08:30:05 -04002019 return ep_call_nested(&poll_loop_ncalls,
Davide Libenzi22bacca2011-02-25 14:44:12 -08002020 ep_loop_check_proc, file, ep, current);
Jason Baron28d82dc2012-01-12 17:17:43 -08002021}
2022
2023static void clear_tfile_check_list(void)
2024{
2025 struct file *file;
2026
2027 /* first clear the tfile_check_list */
2028 while (!list_empty(&tfile_check_list)) {
2029 file = list_first_entry(&tfile_check_list, struct file,
2030 f_tfile_llink);
2031 list_del_init(&file->f_tfile_llink);
Marc Zyngiera9ed4a62020-08-19 17:12:17 +01002032 fput(file);
Jason Baron28d82dc2012-01-12 17:17:43 -08002033 }
2034 INIT_LIST_HEAD(&tfile_check_list);
Davide Libenzi22bacca2011-02-25 14:44:12 -08002035}
2036
Davide Libenzi7699acd2007-05-10 22:23:23 -07002037/*
Andrew Morton523723b2008-08-12 15:09:01 -07002038 * Open an eventpoll file descriptor.
Davide Libenzi7699acd2007-05-10 22:23:23 -07002039 */
Dominik Brodowski791eb222018-03-11 11:34:30 +01002040static int do_epoll_create(int flags)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002041{
Jason Baron28d82dc2012-01-12 17:17:43 -08002042 int error, fd;
Davide Libenzibb57c3e2009-03-31 15:24:12 -07002043 struct eventpoll *ep = NULL;
Jason Baron28d82dc2012-01-12 17:17:43 -08002044 struct file *file;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002045
Ulrich Dreppere38b36f2008-07-23 21:29:42 -07002046 /* Check the EPOLL_* constant for consistency. */
2047 BUILD_BUG_ON(EPOLL_CLOEXEC != O_CLOEXEC);
2048
Davide Libenzi296e2362009-03-31 15:24:11 -07002049 if (flags & ~EPOLL_CLOEXEC)
2050 return -EINVAL;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002051 /*
Davide Libenzibb57c3e2009-03-31 15:24:12 -07002052 * Create the internal data structure ("struct eventpoll").
Davide Libenzi7699acd2007-05-10 22:23:23 -07002053 */
Ulrich Drepper9fe5ad92008-07-23 21:29:43 -07002054 error = ep_alloc(&ep);
Davide Libenzibb57c3e2009-03-31 15:24:12 -07002055 if (error < 0)
2056 return error;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002057 /*
2058 * Creates all the items needed to setup an eventpoll file. That is,
Al Viro2030a422008-02-23 06:46:49 -05002059 * a file structure and a free file descriptor.
Davide Libenzi7699acd2007-05-10 22:23:23 -07002060 */
Jason Baron28d82dc2012-01-12 17:17:43 -08002061 fd = get_unused_fd_flags(O_RDWR | (flags & O_CLOEXEC));
2062 if (fd < 0) {
2063 error = fd;
2064 goto out_free_ep;
2065 }
2066 file = anon_inode_getfile("[eventpoll]", &eventpoll_fops, ep,
Roland Dreier628ff7c2009-12-18 09:41:24 -08002067 O_RDWR | (flags & O_CLOEXEC));
Jason Baron28d82dc2012-01-12 17:17:43 -08002068 if (IS_ERR(file)) {
2069 error = PTR_ERR(file);
2070 goto out_free_fd;
2071 }
Jason Baron28d82dc2012-01-12 17:17:43 -08002072 ep->file = file;
Al Viro98022742012-08-17 22:42:36 -04002073 fd_install(fd, file);
Jason Baron28d82dc2012-01-12 17:17:43 -08002074 return fd;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002075
Jason Baron28d82dc2012-01-12 17:17:43 -08002076out_free_fd:
2077 put_unused_fd(fd);
2078out_free_ep:
2079 ep_free(ep);
Davide Libenzibb57c3e2009-03-31 15:24:12 -07002080 return error;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002081}
2082
Dominik Brodowski791eb222018-03-11 11:34:30 +01002083SYSCALL_DEFINE1(epoll_create1, int, flags)
2084{
2085 return do_epoll_create(flags);
2086}
2087
Heiko Carstens5a8a82b2009-01-14 14:14:25 +01002088SYSCALL_DEFINE1(epoll_create, int, size)
Ulrich Dreppera0998b52008-07-23 21:29:27 -07002089{
Davide Libenzibfe3891a2009-05-12 13:19:44 -07002090 if (size <= 0)
Ulrich Drepper9fe5ad92008-07-23 21:29:43 -07002091 return -EINVAL;
2092
Dominik Brodowski791eb222018-03-11 11:34:30 +01002093 return do_epoll_create(0);
Ulrich Dreppera0998b52008-07-23 21:29:27 -07002094}
2095
Jens Axboe39220e82020-01-08 15:05:37 -07002096static inline int epoll_mutex_lock(struct mutex *mutex, int depth,
2097 bool nonblock)
2098{
2099 if (!nonblock) {
2100 mutex_lock_nested(mutex, depth);
2101 return 0;
2102 }
2103 if (mutex_trylock(mutex))
2104 return 0;
2105 return -EAGAIN;
2106}
2107
2108int do_epoll_ctl(int epfd, int op, int fd, struct epoll_event *epds,
2109 bool nonblock)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002110{
2111 int error;
Jason Baron67347fe2013-11-12 15:10:18 -08002112 int full_check = 0;
Al Viro7e3fb582013-08-30 12:47:21 -04002113 struct fd f, tf;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002114 struct eventpoll *ep;
2115 struct epitem *epi;
Jason Baron67347fe2013-11-12 15:10:18 -08002116 struct eventpoll *tep = NULL;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002117
Davide Libenzi7699acd2007-05-10 22:23:23 -07002118 error = -EBADF;
Al Viro7e3fb582013-08-30 12:47:21 -04002119 f = fdget(epfd);
2120 if (!f.file)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002121 goto error_return;
2122
2123 /* Get the "struct file *" for the target file */
Al Viro7e3fb582013-08-30 12:47:21 -04002124 tf = fdget(fd);
2125 if (!tf.file)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002126 goto error_fput;
2127
2128 /* The target file descriptor must support poll */
2129 error = -EPERM;
Christoph Hellwig9965ed172018-03-05 07:26:05 -08002130 if (!file_can_poll(tf.file))
Davide Libenzi7699acd2007-05-10 22:23:23 -07002131 goto error_tgt_fput;
2132
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02002133 /* Check if EPOLLWAKEUP is allowed */
Nicolas Ioossc680e412014-09-09 14:50:51 -07002134 if (ep_op_has_event(op))
Jens Axboe58e41a42020-01-08 14:35:13 -07002135 ep_take_care_of_epollwakeup(epds);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02002136
Davide Libenzi7699acd2007-05-10 22:23:23 -07002137 /*
2138 * We have to check that the file structure underneath the file descriptor
2139 * the user passed to us _is_ an eventpoll file. And also we do not permit
2140 * adding an epoll file descriptor inside itself.
2141 */
2142 error = -EINVAL;
Al Viro7e3fb582013-08-30 12:47:21 -04002143 if (f.file == tf.file || !is_file_epoll(f.file))
Davide Libenzi7699acd2007-05-10 22:23:23 -07002144 goto error_tgt_fput;
2145
2146 /*
Jason Barondf0108c2016-01-20 14:59:24 -08002147 * epoll adds to the wakeup queue at EPOLL_CTL_ADD time only,
2148 * so EPOLLEXCLUSIVE is not allowed for a EPOLL_CTL_MOD operation.
2149 * Also, we do not currently supported nested exclusive wakeups.
2150 */
Jens Axboe58e41a42020-01-08 14:35:13 -07002151 if (ep_op_has_event(op) && (epds->events & EPOLLEXCLUSIVE)) {
Jason Baronb6a515c2016-02-05 15:37:04 -08002152 if (op == EPOLL_CTL_MOD)
2153 goto error_tgt_fput;
2154 if (op == EPOLL_CTL_ADD && (is_file_epoll(tf.file) ||
Jens Axboe58e41a42020-01-08 14:35:13 -07002155 (epds->events & ~EPOLLEXCLUSIVE_OK_BITS)))
Jason Baronb6a515c2016-02-05 15:37:04 -08002156 goto error_tgt_fput;
2157 }
Jason Barondf0108c2016-01-20 14:59:24 -08002158
2159 /*
Davide Libenzi7699acd2007-05-10 22:23:23 -07002160 * At this point it is safe to assume that the "private_data" contains
2161 * our own data structure.
2162 */
Al Viro7e3fb582013-08-30 12:47:21 -04002163 ep = f.file->private_data;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002164
Davide Libenzi22bacca2011-02-25 14:44:12 -08002165 /*
2166 * When we insert an epoll file descriptor, inside another epoll file
2167 * descriptor, there is the change of creating closed loops, which are
Jason Baron28d82dc2012-01-12 17:17:43 -08002168 * better be handled here, than in more critical paths. While we are
2169 * checking for loops we also determine the list of files reachable
2170 * and hang them on the tfile_check_list, so we can check that we
2171 * haven't created too many possible wakeup paths.
Davide Libenzi22bacca2011-02-25 14:44:12 -08002172 *
Jason Baron67347fe2013-11-12 15:10:18 -08002173 * We do not need to take the global 'epumutex' on EPOLL_CTL_ADD when
2174 * the epoll file descriptor is attaching directly to a wakeup source,
2175 * unless the epoll file descriptor is nested. The purpose of taking the
2176 * 'epmutex' on add is to prevent complex toplogies such as loops and
2177 * deep wakeup paths from forming in parallel through multiple
2178 * EPOLL_CTL_ADD operations.
Davide Libenzi22bacca2011-02-25 14:44:12 -08002179 */
Jens Axboe39220e82020-01-08 15:05:37 -07002180 error = epoll_mutex_lock(&ep->mtx, 0, nonblock);
2181 if (error)
2182 goto error_tgt_fput;
Jason Baron67347fe2013-11-12 15:10:18 -08002183 if (op == EPOLL_CTL_ADD) {
2184 if (!list_empty(&f.file->f_ep_links) ||
Al Virofe0a9162020-09-10 08:33:27 -04002185 ep->gen == loop_check_gen ||
Jason Baron67347fe2013-11-12 15:10:18 -08002186 is_file_epoll(tf.file)) {
Jason Baron67347fe2013-11-12 15:10:18 -08002187 mutex_unlock(&ep->mtx);
Jens Axboe39220e82020-01-08 15:05:37 -07002188 error = epoll_mutex_lock(&epmutex, 0, nonblock);
2189 if (error)
2190 goto error_tgt_fput;
Al Viro18306c42020-09-10 08:30:05 -04002191 loop_check_gen++;
Jens Axboe39220e82020-01-08 15:05:37 -07002192 full_check = 1;
Jason Baron67347fe2013-11-12 15:10:18 -08002193 if (is_file_epoll(tf.file)) {
2194 error = -ELOOP;
Al Viro52c47962020-08-22 18:25:52 -04002195 if (ep_loop_check(ep, tf.file) != 0)
Jason Baron67347fe2013-11-12 15:10:18 -08002196 goto error_tgt_fput;
Marc Zyngiera9ed4a62020-08-19 17:12:17 +01002197 } else {
2198 get_file(tf.file);
Jason Baron67347fe2013-11-12 15:10:18 -08002199 list_add(&tf.file->f_tfile_llink,
2200 &tfile_check_list);
Marc Zyngiera9ed4a62020-08-19 17:12:17 +01002201 }
Jens Axboe39220e82020-01-08 15:05:37 -07002202 error = epoll_mutex_lock(&ep->mtx, 0, nonblock);
Al Viro52c47962020-08-22 18:25:52 -04002203 if (error)
Jens Axboe39220e82020-01-08 15:05:37 -07002204 goto error_tgt_fput;
Jason Baron67347fe2013-11-12 15:10:18 -08002205 if (is_file_epoll(tf.file)) {
2206 tep = tf.file->private_data;
Jens Axboe39220e82020-01-08 15:05:37 -07002207 error = epoll_mutex_lock(&tep->mtx, 1, nonblock);
2208 if (error) {
2209 mutex_unlock(&ep->mtx);
Al Viro52c47962020-08-22 18:25:52 -04002210 goto error_tgt_fput;
Jens Axboe39220e82020-01-08 15:05:37 -07002211 }
Jason Baron67347fe2013-11-12 15:10:18 -08002212 }
2213 }
2214 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07002215
Davide Libenzi67647d02007-05-15 01:40:52 -07002216 /*
2217 * Try to lookup the file inside our RB tree, Since we grabbed "mtx"
2218 * above, we can be sure to be able to use the item looked up by
2219 * ep_find() till we release the mutex.
2220 */
Al Viro7e3fb582013-08-30 12:47:21 -04002221 epi = ep_find(ep, tf.file, fd);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002222
2223 error = -EINVAL;
2224 switch (op) {
2225 case EPOLL_CTL_ADD:
2226 if (!epi) {
Jens Axboe58e41a42020-01-08 14:35:13 -07002227 epds->events |= EPOLLERR | EPOLLHUP;
2228 error = ep_insert(ep, epds, tf.file, fd, full_check);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002229 } else
2230 error = -EEXIST;
2231 break;
2232 case EPOLL_CTL_DEL:
2233 if (epi)
2234 error = ep_remove(ep, epi);
2235 else
2236 error = -ENOENT;
2237 break;
2238 case EPOLL_CTL_MOD:
2239 if (epi) {
Jason Baronb6a515c2016-02-05 15:37:04 -08002240 if (!(epi->event.events & EPOLLEXCLUSIVE)) {
Jens Axboe58e41a42020-01-08 14:35:13 -07002241 epds->events |= EPOLLERR | EPOLLHUP;
2242 error = ep_modify(ep, epi, epds);
Jason Baronb6a515c2016-02-05 15:37:04 -08002243 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07002244 } else
2245 error = -ENOENT;
2246 break;
2247 }
Jason Baron67347fe2013-11-12 15:10:18 -08002248 if (tep != NULL)
2249 mutex_unlock(&tep->mtx);
Davide Libenzid47de162007-05-15 01:40:41 -07002250 mutex_unlock(&ep->mtx);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002251
2252error_tgt_fput:
Al Viro52c47962020-08-22 18:25:52 -04002253 if (full_check) {
2254 clear_tfile_check_list();
Al Viro18306c42020-09-10 08:30:05 -04002255 loop_check_gen++;
Davide Libenzi22bacca2011-02-25 14:44:12 -08002256 mutex_unlock(&epmutex);
Al Viro52c47962020-08-22 18:25:52 -04002257 }
Davide Libenzi22bacca2011-02-25 14:44:12 -08002258
Al Viro7e3fb582013-08-30 12:47:21 -04002259 fdput(tf);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002260error_fput:
Al Viro7e3fb582013-08-30 12:47:21 -04002261 fdput(f);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002262error_return:
Davide Libenzi7699acd2007-05-10 22:23:23 -07002263
2264 return error;
2265}
2266
2267/*
Jens Axboe58e41a42020-01-08 14:35:13 -07002268 * The following function implements the controller interface for
2269 * the eventpoll file that enables the insertion/removal/change of
2270 * file descriptors inside the interest set.
2271 */
2272SYSCALL_DEFINE4(epoll_ctl, int, epfd, int, op, int, fd,
2273 struct epoll_event __user *, event)
2274{
2275 struct epoll_event epds;
2276
2277 if (ep_op_has_event(op) &&
2278 copy_from_user(&epds, event, sizeof(struct epoll_event)))
2279 return -EFAULT;
2280
Jens Axboe39220e82020-01-08 15:05:37 -07002281 return do_epoll_ctl(epfd, op, fd, &epds, false);
Jens Axboe58e41a42020-01-08 14:35:13 -07002282}
2283
2284/*
Davide Libenzi7699acd2007-05-10 22:23:23 -07002285 * Implement the event wait interface for the eventpoll file. It is the kernel
2286 * part of the user space epoll_wait(2).
2287 */
Dominik Brodowski791eb222018-03-11 11:34:30 +01002288static int do_epoll_wait(int epfd, struct epoll_event __user *events,
2289 int maxevents, int timeout)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002290{
Al Viro2903ff02012-08-28 12:52:22 -04002291 int error;
2292 struct fd f;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002293 struct eventpoll *ep;
2294
Davide Libenzi7699acd2007-05-10 22:23:23 -07002295 /* The maximum number of event must be greater than zero */
2296 if (maxevents <= 0 || maxevents > EP_MAX_EVENTS)
2297 return -EINVAL;
2298
2299 /* Verify that the area passed by the user is writeable */
Linus Torvalds96d4f262019-01-03 18:57:57 -08002300 if (!access_ok(events, maxevents * sizeof(struct epoll_event)))
Al Viro2903ff02012-08-28 12:52:22 -04002301 return -EFAULT;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002302
2303 /* Get the "struct file *" for the eventpoll file */
Al Viro2903ff02012-08-28 12:52:22 -04002304 f = fdget(epfd);
2305 if (!f.file)
2306 return -EBADF;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002307
2308 /*
2309 * We have to check that the file structure underneath the fd
2310 * the user passed to us _is_ an eventpoll file.
2311 */
2312 error = -EINVAL;
Al Viro2903ff02012-08-28 12:52:22 -04002313 if (!is_file_epoll(f.file))
Davide Libenzi7699acd2007-05-10 22:23:23 -07002314 goto error_fput;
2315
2316 /*
2317 * At this point it is safe to assume that the "private_data" contains
2318 * our own data structure.
2319 */
Al Viro2903ff02012-08-28 12:52:22 -04002320 ep = f.file->private_data;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002321
2322 /* Time to fish for events ... */
2323 error = ep_poll(ep, events, maxevents, timeout);
2324
2325error_fput:
Al Viro2903ff02012-08-28 12:52:22 -04002326 fdput(f);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002327 return error;
2328}
2329
Dominik Brodowski791eb222018-03-11 11:34:30 +01002330SYSCALL_DEFINE4(epoll_wait, int, epfd, struct epoll_event __user *, events,
2331 int, maxevents, int, timeout)
2332{
2333 return do_epoll_wait(epfd, events, maxevents, timeout);
2334}
2335
Davide Libenzi7699acd2007-05-10 22:23:23 -07002336/*
2337 * Implement the event wait interface for the eventpoll file. It is the kernel
2338 * part of the user space epoll_pwait(2).
2339 */
Heiko Carstens5a8a82b2009-01-14 14:14:25 +01002340SYSCALL_DEFINE6(epoll_pwait, int, epfd, struct epoll_event __user *, events,
2341 int, maxevents, int, timeout, const sigset_t __user *, sigmask,
2342 size_t, sigsetsize)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002343{
2344 int error;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002345
2346 /*
2347 * If the caller wants a certain signal mask to be set during the wait,
2348 * we apply it here.
2349 */
Oleg Nesterovb7724342019-07-16 16:29:53 -07002350 error = set_user_sigmask(sigmask, sigsetsize);
Deepa Dinamanided653c2018-09-19 21:41:04 -07002351 if (error)
2352 return error;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002353
Dominik Brodowski791eb222018-03-11 11:34:30 +01002354 error = do_epoll_wait(epfd, events, maxevents, timeout);
Oleg Nesterovb7724342019-07-16 16:29:53 -07002355 restore_saved_sigmask_unless(error == -EINTR);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002356
2357 return error;
2358}
2359
Al Viro35280bd2013-02-24 14:52:17 -05002360#ifdef CONFIG_COMPAT
2361COMPAT_SYSCALL_DEFINE6(epoll_pwait, int, epfd,
2362 struct epoll_event __user *, events,
2363 int, maxevents, int, timeout,
2364 const compat_sigset_t __user *, sigmask,
2365 compat_size_t, sigsetsize)
2366{
2367 long err;
Al Viro35280bd2013-02-24 14:52:17 -05002368
2369 /*
2370 * If the caller wants a certain signal mask to be set during the wait,
2371 * we apply it here.
2372 */
Oleg Nesterovb7724342019-07-16 16:29:53 -07002373 err = set_compat_user_sigmask(sigmask, sigsetsize);
Deepa Dinamanided653c2018-09-19 21:41:04 -07002374 if (err)
2375 return err;
Al Viro35280bd2013-02-24 14:52:17 -05002376
Dominik Brodowski791eb222018-03-11 11:34:30 +01002377 err = do_epoll_wait(epfd, events, maxevents, timeout);
Oleg Nesterovb7724342019-07-16 16:29:53 -07002378 restore_saved_sigmask_unless(err == -EINTR);
Al Viro35280bd2013-02-24 14:52:17 -05002379
2380 return err;
2381}
2382#endif
2383
Linus Torvalds1da177e2005-04-16 15:20:36 -07002384static int __init eventpoll_init(void)
2385{
Davide Libenzi7ef99642008-12-01 13:13:55 -08002386 struct sysinfo si;
2387
2388 si_meminfo(&si);
Davide Libenzi9df04e12009-01-29 14:25:26 -08002389 /*
2390 * Allows top 4% of lomem to be allocated for epoll watches (per user).
2391 */
2392 max_user_watches = (((si.totalram - si.totalhigh) / 25) << PAGE_SHIFT) /
Davide Libenzi7ef99642008-12-01 13:13:55 -08002393 EP_ITEM_COST;
Robin Holt52bd19f72011-01-12 17:00:01 -08002394 BUG_ON(max_user_watches < 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002395
Davide Libenzi22bacca2011-02-25 14:44:12 -08002396 /*
2397 * Initialize the structure used to perform epoll file descriptor
2398 * inclusion loops checks.
2399 */
2400 ep_nested_calls_init(&poll_loop_ncalls);
2401
Eric Wong39732ca2013-04-30 15:27:38 -07002402 /*
2403 * We can have many thousands of epitems, so prevent this from
2404 * using an extra cache line on 64-bit (and smaller) CPUs
2405 */
2406 BUILD_BUG_ON(sizeof(void *) <= 8 && sizeof(struct epitem) > 128);
2407
Linus Torvalds1da177e2005-04-16 15:20:36 -07002408 /* Allocates slab cache used to allocate "struct epitem" items */
2409 epi_cache = kmem_cache_create("eventpoll_epi", sizeof(struct epitem),
Shakeel Butt2ae928a2017-11-17 15:28:59 -08002410 0, SLAB_HWCACHE_ALIGN|SLAB_PANIC|SLAB_ACCOUNT, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002411
2412 /* Allocates slab cache used to allocate "struct eppoll_entry" */
2413 pwq_cache = kmem_cache_create("eventpoll_pwq",
Shakeel Butt2ae928a2017-11-17 15:28:59 -08002414 sizeof(struct eppoll_entry), 0, SLAB_PANIC|SLAB_ACCOUNT, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002415
Linus Torvalds1da177e2005-04-16 15:20:36 -07002416 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002417}
Davide Libenzicea69242007-05-10 22:23:22 -07002418fs_initcall(eventpoll_init);