blob: 06f4c5ae1451eff56e0e4f47ca90926af110155a [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
Al Viro80285b72020-09-02 11:45:57 -0400112/* Wait structure used by the poll hooks */
113struct eppoll_entry {
114 /* List header used to link this structure to the "struct epitem" */
115 struct eppoll_entry *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116
Al Viro80285b72020-09-02 11:45:57 -0400117 /* The "base" pointer is set to the container "struct epitem" */
118 struct epitem *base;
119
120 /*
121 * Wait queue item that will be linked to the target file wait
122 * queue head.
123 */
124 wait_queue_entry_t wait;
125
126 /* The wait queue head that linked the "wait" wait queue item */
127 wait_queue_head_t *whead;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128};
129
130/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131 * Each file descriptor added to the eventpoll interface will
Davide Libenzi6192bd52007-05-08 00:25:41 -0700132 * have an entry of this type linked to the "rbr" RB tree.
Eric Wong39732ca2013-04-30 15:27:38 -0700133 * Avoid increasing the size of this struct, there can be many thousands
134 * of these on a server and we do not want this to take another cache line.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135 */
136struct epitem {
Jason Baronae10b2b2013-11-12 15:10:16 -0800137 union {
138 /* RB tree node links this structure to the eventpoll RB tree */
139 struct rb_node rbn;
140 /* Used to free the struct epitem */
141 struct rcu_head rcu;
142 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143
144 /* List header used to link this structure to the eventpoll ready list */
145 struct list_head rdllink;
146
Davide Libenzic7ea7632007-05-15 01:40:47 -0700147 /*
148 * Works together "struct eventpoll"->ovflist in keeping the
149 * single linked chain of items.
150 */
151 struct epitem *next;
152
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153 /* The file descriptor information this item refers to */
154 struct epoll_filefd ffd;
155
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156 /* List containing poll wait queues */
Al Viro80285b72020-09-02 11:45:57 -0400157 struct eppoll_entry *pwqlist;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158
159 /* The "container" of this item */
160 struct eventpoll *ep;
161
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162 /* List header used to link this item to the "struct file" items list */
Al Viro44cdc1d2020-09-27 11:18:30 -0400163 struct hlist_node fllink;
Davide Libenzid47de162007-05-15 01:40:41 -0700164
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200165 /* wakeup_source used when EPOLLWAKEUP is set */
Eric Wongeea1d582013-04-30 15:27:39 -0700166 struct wakeup_source __rcu *ws;
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200167
Davide Libenzic7ea7632007-05-15 01:40:47 -0700168 /* The structure that describe the interested events and the source fd */
169 struct epoll_event event;
Davide Libenzid47de162007-05-15 01:40:41 -0700170};
171
172/*
173 * This structure is stored inside the "private_data" member of the file
Daniel Balutabf6a41d2011-01-30 23:42:29 +0200174 * structure and represents the main data structure for the eventpoll
Davide Libenzid47de162007-05-15 01:40:41 -0700175 * interface.
176 */
177struct eventpoll {
Davide Libenzid47de162007-05-15 01:40:41 -0700178 /*
179 * This mutex is used to ensure that files are not removed
180 * while epoll is using them. This is held during the event
181 * collection loop, the file cleanup path, the epoll file exit
182 * code and the ctl operations.
183 */
184 struct mutex mtx;
185
186 /* Wait queue used by sys_epoll_wait() */
187 wait_queue_head_t wq;
188
189 /* Wait queue used by file->poll() */
190 wait_queue_head_t poll_wait;
191
192 /* List of ready file descriptors */
193 struct list_head rdllist;
194
Roman Penyaeva218cc42019-03-07 16:28:53 -0800195 /* Lock which protects rdllist and ovflist */
196 rwlock_t lock;
197
Davide Libenzi67647d02007-05-15 01:40:52 -0700198 /* RB tree root used to store monitored fd structs */
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700199 struct rb_root_cached rbr;
Davide Libenzid47de162007-05-15 01:40:41 -0700200
201 /*
202 * This is a single linked list that chains all the "struct epitem" that
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300203 * happened while transferring ready events to userspace w/out
Roman Penyaeva218cc42019-03-07 16:28:53 -0800204 * holding ->lock.
Davide Libenzid47de162007-05-15 01:40:41 -0700205 */
206 struct epitem *ovflist;
Davide Libenzi7ef99642008-12-01 13:13:55 -0800207
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200208 /* wakeup_source used when ep_scan_ready_list is running */
209 struct wakeup_source *ws;
210
Davide Libenzi7ef99642008-12-01 13:13:55 -0800211 /* The user that created the eventpoll descriptor */
212 struct user_struct *user;
Jason Baron28d82dc2012-01-12 17:17:43 -0800213
214 struct file *file;
215
216 /* used to optimize loop detection check */
Al Viro18306c42020-09-10 08:30:05 -0400217 u64 gen;
Al Viro319c1512020-10-01 20:45:51 -0400218 struct hlist_head refs;
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700219
220#ifdef CONFIG_NET_RX_BUSY_POLL
221 /* used to track busy poll napi_id */
222 unsigned int napi_id;
223#endif
Jason Baronefcdd352020-04-06 20:11:23 -0700224
225#ifdef CONFIG_DEBUG_LOCK_ALLOC
226 /* tracks wakeup nests for lockdep validation */
227 u8 nests;
228#endif
Davide Libenzid47de162007-05-15 01:40:41 -0700229};
230
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231/* Wrapper struct used by poll queueing */
232struct ep_pqueue {
233 poll_table pt;
234 struct epitem *epi;
235};
236
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237/*
Davide Libenzi7ef99642008-12-01 13:13:55 -0800238 * Configuration options available inside /proc/sys/fs/epoll/
239 */
Davide Libenzi7ef99642008-12-01 13:13:55 -0800240/* Maximum number of epoll watched descriptors, per user */
Robin Holt52bd19f72011-01-12 17:00:01 -0800241static long max_user_watches __read_mostly;
Davide Libenzi7ef99642008-12-01 13:13:55 -0800242
243/*
Davide Libenzid47de162007-05-15 01:40:41 -0700244 * This mutex is used to serialize ep_free() and eventpoll_release_file().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245 */
Davide Libenzi7ef99642008-12-01 13:13:55 -0800246static DEFINE_MUTEX(epmutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247
Al Viro18306c42020-09-10 08:30:05 -0400248static u64 loop_check_gen = 0;
249
Davide Libenzi22bacca2011-02-25 14:44:12 -0800250/* Used to check for epoll file descriptor inclusion loops */
Al Viro6a3890c2020-09-26 16:29:02 -0400251static struct eventpoll *inserting_into;
Davide Libenzi22bacca2011-02-25 14:44:12 -0800252
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253/* Slab cache used to allocate "struct epitem" */
Christoph Lametere18b8902006-12-06 20:33:20 -0800254static struct kmem_cache *epi_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255
256/* Slab cache used to allocate "struct eppoll_entry" */
Christoph Lametere18b8902006-12-06 20:33:20 -0800257static struct kmem_cache *pwq_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258
Jason Baron28d82dc2012-01-12 17:17:43 -0800259/*
260 * List of files with newly added links, where we may need to limit the number
261 * of emanating paths. Protected by the epmutex.
262 */
Al Viro319c1512020-10-01 20:45:51 -0400263struct epitems_head {
264 struct hlist_head epitems;
265 struct epitems_head *next;
266};
267static struct epitems_head *tfile_check_list = EP_UNACTIVE_PTR;
268
269static struct kmem_cache *ephead_cache __read_mostly;
270
271static inline void free_ephead(struct epitems_head *head)
272{
273 if (head)
274 kmem_cache_free(ephead_cache, head);
275}
276
277static void list_file(struct file *file)
278{
279 struct epitems_head *head;
280
281 head = container_of(file->f_ep, struct epitems_head, epitems);
282 if (!head->next) {
283 head->next = tfile_check_list;
284 tfile_check_list = head;
285 }
286}
287
288static void unlist_file(struct epitems_head *head)
289{
290 struct epitems_head *to_free = head;
291 struct hlist_node *p = rcu_dereference(hlist_first_rcu(&head->epitems));
292 if (p) {
293 struct epitem *epi= container_of(p, struct epitem, fllink);
294 spin_lock(&epi->ffd.file->f_lock);
295 if (!hlist_empty(&head->epitems))
296 to_free = NULL;
297 head->next = NULL;
298 spin_unlock(&epi->ffd.file->f_lock);
299 }
300 free_ephead(to_free);
301}
Jason Baron28d82dc2012-01-12 17:17:43 -0800302
Davide Libenzi7ef99642008-12-01 13:13:55 -0800303#ifdef CONFIG_SYSCTL
304
305#include <linux/sysctl.h>
306
Matteo Croceeec48442019-07-18 15:58:50 -0700307static long long_zero;
Robin Holt52bd19f72011-01-12 17:00:01 -0800308static long long_max = LONG_MAX;
Davide Libenzi7ef99642008-12-01 13:13:55 -0800309
Joe Perches1f7e0612014-06-06 14:38:05 -0700310struct ctl_table epoll_table[] = {
Davide Libenzi7ef99642008-12-01 13:13:55 -0800311 {
Davide Libenzi7ef99642008-12-01 13:13:55 -0800312 .procname = "max_user_watches",
313 .data = &max_user_watches,
Robin Holt52bd19f72011-01-12 17:00:01 -0800314 .maxlen = sizeof(max_user_watches),
Davide Libenzi7ef99642008-12-01 13:13:55 -0800315 .mode = 0644,
Robin Holt52bd19f72011-01-12 17:00:01 -0800316 .proc_handler = proc_doulongvec_minmax,
Matteo Croceeec48442019-07-18 15:58:50 -0700317 .extra1 = &long_zero,
Robin Holt52bd19f72011-01-12 17:00:01 -0800318 .extra2 = &long_max,
Davide Libenzi7ef99642008-12-01 13:13:55 -0800319 },
Eric W. Biedermanab092032009-11-05 14:25:10 -0800320 { }
Davide Libenzi7ef99642008-12-01 13:13:55 -0800321};
322#endif /* CONFIG_SYSCTL */
323
Jason Baron28d82dc2012-01-12 17:17:43 -0800324static const struct file_operations eventpoll_fops;
325
326static inline int is_file_epoll(struct file *f)
327{
328 return f->f_op == &eventpoll_fops;
329}
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700330
Davide Libenzi67647d02007-05-15 01:40:52 -0700331/* Setup the structure that is used as key for the RB tree */
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700332static inline void ep_set_ffd(struct epoll_filefd *ffd,
333 struct file *file, int fd)
334{
335 ffd->file = file;
336 ffd->fd = fd;
337}
338
Davide Libenzi67647d02007-05-15 01:40:52 -0700339/* Compare RB tree keys */
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700340static inline int ep_cmp_ffd(struct epoll_filefd *p1,
341 struct epoll_filefd *p2)
342{
343 return (p1->file > p2->file ? +1:
344 (p1->file < p2->file ? -1 : p1->fd - p2->fd));
345}
346
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700347/* Tells us if the item is currently linked */
Davidlohr Bueso992991c2018-08-21 21:58:26 -0700348static inline int ep_is_linked(struct epitem *epi)
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700349{
Davidlohr Bueso992991c2018-08-21 21:58:26 -0700350 return !list_empty(&epi->rdllink);
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700351}
352
Ingo Molnarac6424b2017-06-20 12:06:13 +0200353static inline struct eppoll_entry *ep_pwq_from_wait(wait_queue_entry_t *p)
Oleg Nesterov971316f2012-02-24 20:07:29 +0100354{
355 return container_of(p, struct eppoll_entry, wait);
356}
357
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700358/* Get the "struct epitem" from a wait queue pointer */
Ingo Molnarac6424b2017-06-20 12:06:13 +0200359static inline struct epitem *ep_item_from_wait(wait_queue_entry_t *p)
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700360{
361 return container_of(p, struct eppoll_entry, wait)->base;
362}
363
Davide Libenzi5071f972009-03-31 15:24:10 -0700364/**
Davide Libenzi3fb0e582011-03-22 16:34:46 -0700365 * ep_events_available - Checks if ready events might be available.
366 *
367 * @ep: Pointer to the eventpoll context.
368 *
Randy Dunlapa6c67fe2021-03-01 15:25:51 -0700369 * Return: a value different than %zero if ready events are available,
370 * or %zero otherwise.
Davide Libenzi3fb0e582011-03-22 16:34:46 -0700371 */
372static inline int ep_events_available(struct eventpoll *ep)
373{
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -0800374 return !list_empty_careful(&ep->rdllist) ||
375 READ_ONCE(ep->ovflist) != EP_UNACTIVE_PTR;
Davide Libenzi3fb0e582011-03-22 16:34:46 -0700376}
377
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700378#ifdef CONFIG_NET_RX_BUSY_POLL
379static bool ep_busy_loop_end(void *p, unsigned long start_time)
380{
381 struct eventpoll *ep = p;
382
383 return ep_events_available(ep) || busy_loop_timeout(start_time);
384}
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700385
386/*
387 * Busy poll if globally on and supporting sockets found && no events,
388 * busy loop will return if need_resched or ep_events_available.
389 *
390 * we must do our busy polling with irqs enabled
391 */
Soheil Hassas Yeganeh1493c472020-12-18 14:01:57 -0800392static bool ep_busy_loop(struct eventpoll *ep, int nonblock)
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700393{
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700394 unsigned int napi_id = READ_ONCE(ep->napi_id);
395
Soheil Hassas Yeganeh1493c472020-12-18 14:01:57 -0800396 if ((napi_id >= MIN_NAPI_ID) && net_busy_loop_on()) {
Björn Töpel7c951caf2020-11-30 19:51:57 +0100397 napi_busy_loop(napi_id, nonblock ? NULL : ep_busy_loop_end, ep, false,
398 BUSY_POLL_BUDGET);
Soheil Hassas Yeganeh1493c472020-12-18 14:01:57 -0800399 if (ep_events_available(ep))
400 return true;
401 /*
402 * Busy poll timed out. Drop NAPI ID for now, we can add
403 * it back in when we have moved a socket with a valid NAPI
404 * ID onto the ready list.
405 */
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700406 ep->napi_id = 0;
Soheil Hassas Yeganeh1493c472020-12-18 14:01:57 -0800407 return false;
408 }
409 return false;
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700410}
411
412/*
413 * Set epoll busy poll NAPI ID from sk.
414 */
415static inline void ep_set_busy_poll_napi_id(struct epitem *epi)
416{
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700417 struct eventpoll *ep;
418 unsigned int napi_id;
419 struct socket *sock;
420 struct sock *sk;
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700421
422 if (!net_busy_loop_on())
423 return;
424
Florent Revestdba4a922020-12-04 12:36:04 +0100425 sock = sock_from_file(epi->ffd.file);
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700426 if (!sock)
427 return;
428
429 sk = sock->sk;
430 if (!sk)
431 return;
432
433 napi_id = READ_ONCE(sk->sk_napi_id);
434 ep = epi->ep;
435
436 /* Non-NAPI IDs can be rejected
437 * or
438 * Nothing to do if we already have this ID
439 */
440 if (napi_id < MIN_NAPI_ID || napi_id == ep->napi_id)
441 return;
442
443 /* record NAPI ID for use in next busy poll */
444 ep->napi_id = napi_id;
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700445}
446
Davidlohr Bueso514056d2018-08-21 21:58:19 -0700447#else
448
Soheil Hassas Yeganeh1493c472020-12-18 14:01:57 -0800449static inline bool ep_busy_loop(struct eventpoll *ep, int nonblock)
Davidlohr Bueso514056d2018-08-21 21:58:19 -0700450{
Soheil Hassas Yeganeh1493c472020-12-18 14:01:57 -0800451 return false;
Davidlohr Bueso514056d2018-08-21 21:58:19 -0700452}
453
454static inline void ep_set_busy_poll_napi_id(struct epitem *epi)
455{
456}
457
458#endif /* CONFIG_NET_RX_BUSY_POLL */
459
Steven Rostedt02edc6f2012-03-23 15:02:27 -0700460/*
461 * As described in commit 0ccf831cb lockdep: annotate epoll
462 * the use of wait queues used by epoll is done in a very controlled
463 * manner. Wake ups can nest inside each other, but are never done
464 * with the same locking. For example:
465 *
466 * dfd = socket(...);
467 * efd1 = epoll_create();
468 * efd2 = epoll_create();
469 * epoll_ctl(efd1, EPOLL_CTL_ADD, dfd, ...);
470 * epoll_ctl(efd2, EPOLL_CTL_ADD, efd1, ...);
471 *
472 * When a packet arrives to the device underneath "dfd", the net code will
473 * issue a wake_up() on its poll wake list. Epoll (efd1) has installed a
474 * callback wakeup entry on that queue, and the wake_up() performed by the
475 * "dfd" net code will end up in ep_poll_callback(). At this point epoll
476 * (efd1) notices that it may have some event ready, so it needs to wake up
477 * the waiters on its poll wait list (efd2). So it calls ep_poll_safewake()
478 * that ends up in another wake_up(), after having checked about the
479 * recursion constraints. That are, no more than EP_MAX_POLLWAKE_NESTS, to
480 * avoid stack blasting.
481 *
482 * When CONFIG_DEBUG_LOCK_ALLOC is enabled, make sure lockdep can handle
483 * this special case of epoll.
484 */
Davide Libenzi2dfa4ee2009-03-31 15:24:22 -0700485#ifdef CONFIG_DEBUG_LOCK_ALLOC
Davide Libenzi2dfa4ee2009-03-31 15:24:22 -0700486
Jason Baronefcdd352020-04-06 20:11:23 -0700487static void ep_poll_safewake(struct eventpoll *ep, struct epitem *epi)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488{
Jason Baronefcdd352020-04-06 20:11:23 -0700489 struct eventpoll *ep_src;
Jason Baronf6520c52019-12-04 16:52:12 -0800490 unsigned long flags;
Jason Baronefcdd352020-04-06 20:11:23 -0700491 u8 nests = 0;
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700492
Jason Baronefcdd352020-04-06 20:11:23 -0700493 /*
494 * To set the subclass or nesting level for spin_lock_irqsave_nested()
495 * it might be natural to create a per-cpu nest count. However, since
496 * we can recurse on ep->poll_wait.lock, and a non-raw spinlock can
497 * schedule() in the -rt kernel, the per-cpu variable are no longer
498 * protected. Thus, we are introducing a per eventpoll nest field.
499 * If we are not being call from ep_poll_callback(), epi is NULL and
500 * we are at the first level of nesting, 0. Otherwise, we are being
501 * called from ep_poll_callback() and if a previous wakeup source is
502 * not an epoll file itself, we are at depth 1 since the wakeup source
503 * is depth 0. If the wakeup source is a previous epoll file in the
504 * wakeup chain then we use its nests value and record ours as
505 * nests + 1. The previous epoll file nests value is stable since its
506 * already holding its own poll_wait.lock.
507 */
508 if (epi) {
509 if ((is_file_epoll(epi->ffd.file))) {
510 ep_src = epi->ffd.file->private_data;
511 nests = ep_src->nests;
512 } else {
513 nests = 1;
514 }
515 }
516 spin_lock_irqsave_nested(&ep->poll_wait.lock, flags, nests);
517 ep->nests = nests + 1;
518 wake_up_locked_poll(&ep->poll_wait, EPOLLIN);
519 ep->nests = 0;
520 spin_unlock_irqrestore(&ep->poll_wait.lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521}
522
Jason Baron57a173b2017-11-17 15:29:02 -0800523#else
524
Jason Baronefcdd352020-04-06 20:11:23 -0700525static void ep_poll_safewake(struct eventpoll *ep, struct epitem *epi)
Jason Baron57a173b2017-11-17 15:29:02 -0800526{
Jason Baronefcdd352020-04-06 20:11:23 -0700527 wake_up_poll(&ep->poll_wait, EPOLLIN);
Jason Baron57a173b2017-11-17 15:29:02 -0800528}
529
530#endif
531
Oleg Nesterov971316f2012-02-24 20:07:29 +0100532static void ep_remove_wait_queue(struct eppoll_entry *pwq)
533{
534 wait_queue_head_t *whead;
535
536 rcu_read_lock();
Oleg Nesterov138e4ad2017-09-01 18:55:33 +0200537 /*
538 * If it is cleared by POLLFREE, it should be rcu-safe.
539 * If we read NULL we need a barrier paired with
540 * smp_store_release() in ep_poll_callback(), otherwise
541 * we rely on whead->lock.
542 */
543 whead = smp_load_acquire(&pwq->whead);
Oleg Nesterov971316f2012-02-24 20:07:29 +0100544 if (whead)
545 remove_wait_queue(whead, &pwq->wait);
546 rcu_read_unlock();
547}
548
Davide Libenzi7699acd2007-05-10 22:23:23 -0700549/*
Tony Battersbyd1bc90d2009-03-31 15:24:15 -0700550 * This function unregisters poll callbacks from the associated file
551 * descriptor. Must be called with "mtx" held (or "epmutex" if called from
552 * ep_free).
Davide Libenzi7699acd2007-05-10 22:23:23 -0700553 */
554static void ep_unregister_pollwait(struct eventpoll *ep, struct epitem *epi)
555{
Al Viro80285b72020-09-02 11:45:57 -0400556 struct eppoll_entry **p = &epi->pwqlist;
Davide Libenzi7699acd2007-05-10 22:23:23 -0700557 struct eppoll_entry *pwq;
558
Al Viro80285b72020-09-02 11:45:57 -0400559 while ((pwq = *p) != NULL) {
560 *p = pwq->next;
Oleg Nesterov971316f2012-02-24 20:07:29 +0100561 ep_remove_wait_queue(pwq);
Tony Battersbyd1bc90d2009-03-31 15:24:15 -0700562 kmem_cache_free(pwq_cache, pwq);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700563 }
564}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565
Eric Wongeea1d582013-04-30 15:27:39 -0700566/* call only when ep->mtx is held */
567static inline struct wakeup_source *ep_wakeup_source(struct epitem *epi)
568{
569 return rcu_dereference_check(epi->ws, lockdep_is_held(&epi->ep->mtx));
570}
571
572/* call only when ep->mtx is held */
573static inline void ep_pm_stay_awake(struct epitem *epi)
574{
575 struct wakeup_source *ws = ep_wakeup_source(epi);
576
577 if (ws)
578 __pm_stay_awake(ws);
579}
580
581static inline bool ep_has_wakeup_source(struct epitem *epi)
582{
583 return rcu_access_pointer(epi->ws) ? true : false;
584}
585
586/* call when ep->mtx cannot be held (ep_poll_callback) */
587static inline void ep_pm_stay_awake_rcu(struct epitem *epi)
588{
589 struct wakeup_source *ws;
590
591 rcu_read_lock();
592 ws = rcu_dereference(epi->ws);
593 if (ws)
594 __pm_stay_awake(ws);
595 rcu_read_unlock();
596}
597
Al Viro57804b12020-08-31 13:41:30 -0400598
599/*
600 * ep->mutex needs to be held because we could be hit by
601 * eventpoll_release_file() and epoll_ctl().
Davide Libenzi5071f972009-03-31 15:24:10 -0700602 */
Al Viro57804b12020-08-31 13:41:30 -0400603static void ep_start_scan(struct eventpoll *ep, struct list_head *txlist)
Davide Libenzi5071f972009-03-31 15:24:10 -0700604{
Davide Libenzi5071f972009-03-31 15:24:10 -0700605 /*
606 * Steal the ready list, and re-init the original one to the
607 * empty list. Also, set ep->ovflist to NULL so that events
608 * happening while looping w/out locks, are not lost. We cannot
609 * have the poll callback to queue directly on ep->rdllist,
610 * because we want the "sproc" callback to be able to do it
611 * in a lockless way.
612 */
Al Viro57804b12020-08-31 13:41:30 -0400613 lockdep_assert_irqs_enabled();
Roman Penyaeva218cc42019-03-07 16:28:53 -0800614 write_lock_irq(&ep->lock);
Al Virodb502f82020-08-31 13:06:51 -0400615 list_splice_init(&ep->rdllist, txlist);
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -0800616 WRITE_ONCE(ep->ovflist, NULL);
Roman Penyaeva218cc42019-03-07 16:28:53 -0800617 write_unlock_irq(&ep->lock);
Al Virodb502f82020-08-31 13:06:51 -0400618}
Davide Libenzi5071f972009-03-31 15:24:10 -0700619
Al Virodb502f82020-08-31 13:06:51 -0400620static void ep_done_scan(struct eventpoll *ep,
Al Virodb502f82020-08-31 13:06:51 -0400621 struct list_head *txlist)
622{
623 struct epitem *epi, *nepi;
Davide Libenzi5071f972009-03-31 15:24:10 -0700624
Roman Penyaeva218cc42019-03-07 16:28:53 -0800625 write_lock_irq(&ep->lock);
Davide Libenzi5071f972009-03-31 15:24:10 -0700626 /*
627 * During the time we spent inside the "sproc" callback, some
628 * other events might have been queued by the poll callback.
629 * We re-insert them inside the main ready-list here.
630 */
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -0800631 for (nepi = READ_ONCE(ep->ovflist); (epi = nepi) != NULL;
Davide Libenzi5071f972009-03-31 15:24:10 -0700632 nepi = epi->next, epi->next = EP_UNACTIVE_PTR) {
633 /*
634 * We need to check if the item is already in the list.
635 * During the "sproc" callback execution time, items are
636 * queued into ->ovflist but the "txlist" might already
637 * contain them, and the list_splice() below takes care of them.
638 */
Davidlohr Bueso992991c2018-08-21 21:58:26 -0700639 if (!ep_is_linked(epi)) {
Roman Penyaevc1411752019-03-07 16:28:46 -0800640 /*
641 * ->ovflist is LIFO, so we have to reverse it in order
642 * to keep in FIFO.
643 */
644 list_add(&epi->rdllink, &ep->rdllist);
Eric Wongeea1d582013-04-30 15:27:39 -0700645 ep_pm_stay_awake(epi);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200646 }
Davide Libenzi5071f972009-03-31 15:24:10 -0700647 }
648 /*
649 * We need to set back ep->ovflist to EP_UNACTIVE_PTR, so that after
650 * releasing the lock, events will be queued in the normal way inside
651 * ep->rdllist.
652 */
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -0800653 WRITE_ONCE(ep->ovflist, EP_UNACTIVE_PTR);
Davide Libenzi5071f972009-03-31 15:24:10 -0700654
655 /*
656 * Quickly re-inject items left on "txlist".
657 */
Al Virodb502f82020-08-31 13:06:51 -0400658 list_splice(txlist, &ep->rdllist);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200659 __pm_relax(ep->ws);
Davidlohr Bueso7fab29e2021-05-06 18:04:07 -0700660
661 if (!list_empty(&ep->rdllist)) {
662 if (waitqueue_active(&ep->wq))
663 wake_up(&ep->wq);
664 }
665
Roman Penyaeva218cc42019-03-07 16:28:53 -0800666 write_unlock_irq(&ep->lock);
Davide Libenzi5071f972009-03-31 15:24:10 -0700667}
668
Jason Baronae10b2b2013-11-12 15:10:16 -0800669static void epi_rcu_free(struct rcu_head *head)
670{
671 struct epitem *epi = container_of(head, struct epitem, rcu);
672 kmem_cache_free(epi_cache, epi);
673}
674
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675/*
Davide Libenzi7699acd2007-05-10 22:23:23 -0700676 * Removes a "struct epitem" from the eventpoll RB tree and deallocates
Davide Libenzic7ea7632007-05-15 01:40:47 -0700677 * all the associated resources. Must be called with "mtx" held.
Davide Libenzi7699acd2007-05-10 22:23:23 -0700678 */
679static int ep_remove(struct eventpoll *ep, struct epitem *epi)
680{
Davide Libenzi7699acd2007-05-10 22:23:23 -0700681 struct file *file = epi->ffd.file;
Al Viro319c1512020-10-01 20:45:51 -0400682 struct epitems_head *to_free;
683 struct hlist_head *head;
Davide Libenzi7699acd2007-05-10 22:23:23 -0700684
Davidlohr Bueso92e64172018-08-21 21:56:45 -0700685 lockdep_assert_irqs_enabled();
686
Davide Libenzi7699acd2007-05-10 22:23:23 -0700687 /*
Christoph Hellwigee8ef0a2018-08-21 21:56:26 -0700688 * Removes poll wait queue hooks.
Davide Libenzi7699acd2007-05-10 22:23:23 -0700689 */
690 ep_unregister_pollwait(ep, epi);
691
692 /* Remove the current item from the list of epoll hooks */
Jonathan Corbet68499912009-02-06 13:52:43 -0700693 spin_lock(&file->f_lock);
Al Viro319c1512020-10-01 20:45:51 -0400694 to_free = NULL;
695 head = file->f_ep;
696 if (head->first == &epi->fllink && !epi->fllink.next) {
697 file->f_ep = NULL;
698 if (!is_file_epoll(file)) {
699 struct epitems_head *v;
700 v = container_of(head, struct epitems_head, epitems);
701 if (!smp_load_acquire(&v->next))
702 to_free = v;
703 }
704 }
Al Viro44cdc1d2020-09-27 11:18:30 -0400705 hlist_del_rcu(&epi->fllink);
Jonathan Corbet68499912009-02-06 13:52:43 -0700706 spin_unlock(&file->f_lock);
Al Viro319c1512020-10-01 20:45:51 -0400707 free_ephead(to_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700709 rb_erase_cached(&epi->rbn, &ep->rbr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710
Roman Penyaeva218cc42019-03-07 16:28:53 -0800711 write_lock_irq(&ep->lock);
Davidlohr Bueso992991c2018-08-21 21:58:26 -0700712 if (ep_is_linked(epi))
Davide Libenzic7ea7632007-05-15 01:40:47 -0700713 list_del_init(&epi->rdllink);
Roman Penyaeva218cc42019-03-07 16:28:53 -0800714 write_unlock_irq(&ep->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715
Eric Wongeea1d582013-04-30 15:27:39 -0700716 wakeup_source_unregister(ep_wakeup_source(epi));
Jason Baronae10b2b2013-11-12 15:10:16 -0800717 /*
718 * At this point it is safe to free the eventpoll item. Use the union
719 * field epi->rcu, since we are trying to minimize the size of
720 * 'struct epitem'. The 'rbn' field is no longer in use. Protected by
721 * ep->mtx. The rcu read side, reverse_path_check_proc(), does not make
722 * use of the rbn field.
723 */
724 call_rcu(&epi->rcu, epi_rcu_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725
Nicholas Piggin1e1c1582021-09-07 20:00:00 -0700726 percpu_counter_dec(&ep->user->epoll_watches);
Davide Libenzi7ef99642008-12-01 13:13:55 -0800727
Davide Libenzic7ea7632007-05-15 01:40:47 -0700728 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729}
730
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731static void ep_free(struct eventpoll *ep)
732{
733 struct rb_node *rbp;
734 struct epitem *epi;
735
736 /* We need to release all tasks waiting for these file */
737 if (waitqueue_active(&ep->poll_wait))
Jason Baronefcdd352020-04-06 20:11:23 -0700738 ep_poll_safewake(ep, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739
740 /*
741 * We need to lock this because we could be hit by
742 * eventpoll_release_file() while we're freeing the "struct eventpoll".
Davide Libenzid47de162007-05-15 01:40:41 -0700743 * We do not need to hold "ep->mtx" here because the epoll file
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744 * is on the way to be removed and no one has references to it
745 * anymore. The only hit might come from eventpoll_release_file() but
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300746 * holding "epmutex" is sufficient here.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747 */
Arjan van de Ven144efe32006-03-23 03:00:32 -0800748 mutex_lock(&epmutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749
750 /*
751 * Walks through the whole tree by unregistering poll callbacks.
752 */
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700753 for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754 epi = rb_entry(rbp, struct epitem, rbn);
755
756 ep_unregister_pollwait(ep, epi);
Eric Dumazet91cf5ab2013-09-11 14:24:06 -0700757 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758 }
759
760 /*
Davide Libenzi6192bd52007-05-08 00:25:41 -0700761 * Walks through the whole tree by freeing each "struct epitem". At this
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762 * point we are sure no poll callbacks will be lingering around, and also by
Davide Libenzid47de162007-05-15 01:40:41 -0700763 * holding "epmutex" we can be sure that no file cleanup code will hit
Roman Penyaeva218cc42019-03-07 16:28:53 -0800764 * us during this operation. So we can avoid the lock on "ep->lock".
Eric Wongddf676c2013-04-30 15:27:40 -0700765 * We do not need to lock ep->mtx, either, we only do it to prevent
766 * a lockdep warning.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767 */
Eric Wongddf676c2013-04-30 15:27:40 -0700768 mutex_lock(&ep->mtx);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700769 while ((rbp = rb_first_cached(&ep->rbr)) != NULL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770 epi = rb_entry(rbp, struct epitem, rbn);
771 ep_remove(ep, epi);
Eric Dumazet91cf5ab2013-09-11 14:24:06 -0700772 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773 }
Eric Wongddf676c2013-04-30 15:27:40 -0700774 mutex_unlock(&ep->mtx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775
Arjan van de Ven144efe32006-03-23 03:00:32 -0800776 mutex_unlock(&epmutex);
Davide Libenzid47de162007-05-15 01:40:41 -0700777 mutex_destroy(&ep->mtx);
Davide Libenzi7ef99642008-12-01 13:13:55 -0800778 free_uid(ep->user);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200779 wakeup_source_unregister(ep->ws);
Davide Libenzif0ee9aa2007-05-15 01:40:57 -0700780 kfree(ep);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781}
782
Davide Libenzi7699acd2007-05-10 22:23:23 -0700783static int ep_eventpoll_release(struct inode *inode, struct file *file)
784{
785 struct eventpoll *ep = file->private_data;
786
Davide Libenzif0ee9aa2007-05-15 01:40:57 -0700787 if (ep)
Davide Libenzi7699acd2007-05-10 22:23:23 -0700788 ep_free(ep);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700789
Davide Libenzi7699acd2007-05-10 22:23:23 -0700790 return 0;
791}
792
Al Viro2c0b71c2020-09-26 18:48:57 -0400793static __poll_t ep_item_poll(const struct epitem *epi, poll_table *pt, int depth);
Eric Wong450d89e2013-04-30 15:27:42 -0700794
Al Viroad9366b2020-09-26 18:32:48 -0400795static __poll_t __ep_eventpoll_poll(struct file *file, poll_table *wait, int depth)
Jason Baron37b5e522017-11-17 15:29:06 -0800796{
Al Viroad9366b2020-09-26 18:32:48 -0400797 struct eventpoll *ep = file->private_data;
798 LIST_HEAD(txlist);
Davide Libenzi5071f972009-03-31 15:24:10 -0700799 struct epitem *epi, *tmp;
Hans Verkuil626cf232012-03-23 15:02:27 -0700800 poll_table pt;
Al Viro2c0b71c2020-09-26 18:48:57 -0400801 __poll_t res = 0;
Davide Libenzi5071f972009-03-31 15:24:10 -0700802
Hans Verkuil626cf232012-03-23 15:02:27 -0700803 init_poll_funcptr(&pt, NULL);
Eric Wong450d89e2013-04-30 15:27:42 -0700804
Al Viroad9366b2020-09-26 18:32:48 -0400805 /* Insert inside our poll wait queue */
806 poll_wait(file, &ep->poll_wait, wait);
807
808 /*
809 * Proceed to find out if wanted events are really available inside
810 * the ready list.
811 */
812 mutex_lock_nested(&ep->mtx, depth);
813 ep_start_scan(ep, &txlist);
Al Viro2c0b71c2020-09-26 18:48:57 -0400814 list_for_each_entry_safe(epi, tmp, &txlist, rdllink) {
815 if (ep_item_poll(epi, &pt, depth + 1)) {
816 res = EPOLLIN | EPOLLRDNORM;
817 break;
Jason Baron37b5e522017-11-17 15:29:06 -0800818 } else {
Davide Libenzi5071f972009-03-31 15:24:10 -0700819 /*
820 * Item has been dropped into the ready list by the poll
821 * callback, but it's not actually ready, as far as
822 * caller requested events goes. We can remove it here.
823 */
Eric Wongeea1d582013-04-30 15:27:39 -0700824 __pm_relax(ep_wakeup_source(epi));
Davide Libenzi5071f972009-03-31 15:24:10 -0700825 list_del_init(&epi->rdllink);
Davide Libenzi296e2362009-03-31 15:24:11 -0700826 }
Davide Libenzi5071f972009-03-31 15:24:10 -0700827 }
Al Viroad9366b2020-09-26 18:32:48 -0400828 ep_done_scan(ep, &txlist);
829 mutex_unlock(&ep->mtx);
830 return res;
831}
Davide Libenzi5071f972009-03-31 15:24:10 -0700832
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833/*
834 * Differs from ep_eventpoll_poll() in that internal callers already have
835 * the ep->mtx so we need to start from depth=1, such that mutex_lock_nested()
836 * is correctly annotated.
837 */
838static __poll_t ep_item_poll(const struct epitem *epi, poll_table *pt,
839 int depth)
840{
Al Viroad9366b2020-09-26 18:32:48 -0400841 struct file *file = epi->ffd.file;
Al Viro1ec09972020-08-31 13:16:39 -0400842 __poll_t res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843
844 pt->_key = epi->event.events;
Al Viroad9366b2020-09-26 18:32:48 -0400845 if (!is_file_epoll(file))
846 res = vfs_poll(file, pt);
847 else
848 res = __ep_eventpoll_poll(file, pt, depth);
Al Viro1ec09972020-08-31 13:16:39 -0400849 return res & epi->event.events;
Davide Libenzi5071f972009-03-31 15:24:10 -0700850}
851
Linus Torvaldsa11e1d42018-06-28 09:43:44 -0700852static __poll_t ep_eventpoll_poll(struct file *file, poll_table *wait)
Davide Libenzi7699acd2007-05-10 22:23:23 -0700853{
Al Viroad9366b2020-09-26 18:32:48 -0400854 return __ep_eventpoll_poll(file, wait, 0);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700855}
856
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800857#ifdef CONFIG_PROC_FS
Joe Perchesa3816ab2014-09-29 16:08:25 -0700858static void ep_show_fdinfo(struct seq_file *m, struct file *f)
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800859{
860 struct eventpoll *ep = f->private_data;
861 struct rb_node *rbp;
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800862
863 mutex_lock(&ep->mtx);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700864 for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) {
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800865 struct epitem *epi = rb_entry(rbp, struct epitem, rbn);
Cyrill Gorcunov77493f02017-07-12 14:34:25 -0700866 struct inode *inode = file_inode(epi->ffd.file);
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800867
Cyrill Gorcunov77493f02017-07-12 14:34:25 -0700868 seq_printf(m, "tfd: %8d events: %8x data: %16llx "
869 " pos:%lli ino:%lx sdev:%x\n",
Joe Perchesa3816ab2014-09-29 16:08:25 -0700870 epi->ffd.fd, epi->event.events,
Cyrill Gorcunov77493f02017-07-12 14:34:25 -0700871 (long long)epi->event.data,
872 (long long)epi->ffd.file->f_pos,
873 inode->i_ino, inode->i_sb->s_dev);
Joe Perchesa3816ab2014-09-29 16:08:25 -0700874 if (seq_has_overflowed(m))
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800875 break;
876 }
877 mutex_unlock(&ep->mtx);
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800878}
879#endif
880
Davide Libenzi7699acd2007-05-10 22:23:23 -0700881/* File callbacks that implement the eventpoll file behaviour */
882static const struct file_operations eventpoll_fops = {
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800883#ifdef CONFIG_PROC_FS
884 .show_fdinfo = ep_show_fdinfo,
885#endif
Davide Libenzi7699acd2007-05-10 22:23:23 -0700886 .release = ep_eventpoll_release,
Linus Torvaldsa11e1d42018-06-28 09:43:44 -0700887 .poll = ep_eventpoll_poll,
Arnd Bergmann6038f372010-08-15 18:52:59 +0200888 .llseek = noop_llseek,
Davide Libenzi7699acd2007-05-10 22:23:23 -0700889};
890
Davide Libenzi7699acd2007-05-10 22:23:23 -0700891/*
892 * This is called from eventpoll_release() to unlink files from the eventpoll
893 * interface. We need to have this facility to cleanup correctly files that are
894 * closed without being removed from the eventpoll interface.
895 */
896void eventpoll_release_file(struct file *file)
897{
Davide Libenzi7699acd2007-05-10 22:23:23 -0700898 struct eventpoll *ep;
Al Viro44cdc1d2020-09-27 11:18:30 -0400899 struct epitem *epi;
900 struct hlist_node *next;
Davide Libenzi7699acd2007-05-10 22:23:23 -0700901
902 /*
Jonathan Corbet68499912009-02-06 13:52:43 -0700903 * We don't want to get "file->f_lock" because it is not
Davide Libenzi7699acd2007-05-10 22:23:23 -0700904 * necessary. It is not necessary because we're in the "struct file"
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300905 * cleanup path, and this means that no one is using this file anymore.
Davide Libenzi5071f972009-03-31 15:24:10 -0700906 * So, for example, epoll_ctl() cannot hit here since if we reach this
Davide Libenzi67647d02007-05-15 01:40:52 -0700907 * point, the file counter already went to zero and fget() would fail.
Davide Libenzid47de162007-05-15 01:40:41 -0700908 * The only hit might come from ep_free() but by holding the mutex
Davide Libenzi7699acd2007-05-10 22:23:23 -0700909 * will correctly serialize the operation. We do need to acquire
Davide Libenzid47de162007-05-15 01:40:41 -0700910 * "ep->mtx" after "epmutex" because ep_remove() requires it when called
Davide Libenzi7699acd2007-05-10 22:23:23 -0700911 * from anywhere but ep_free().
Jonathan Corbet68499912009-02-06 13:52:43 -0700912 *
913 * Besides, ep_remove() acquires the lock, so we can't hold it here.
Davide Libenzi7699acd2007-05-10 22:23:23 -0700914 */
915 mutex_lock(&epmutex);
Al Viro319c1512020-10-01 20:45:51 -0400916 if (unlikely(!file->f_ep)) {
917 mutex_unlock(&epmutex);
918 return;
919 }
920 hlist_for_each_entry_safe(epi, next, file->f_ep, fllink) {
Davide Libenzi7699acd2007-05-10 22:23:23 -0700921 ep = epi->ep;
Nelson Elhaged8805e62011-10-31 17:13:14 -0700922 mutex_lock_nested(&ep->mtx, 0);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700923 ep_remove(ep, epi);
Davide Libenzid47de162007-05-15 01:40:41 -0700924 mutex_unlock(&ep->mtx);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700925 }
Davide Libenzi7699acd2007-05-10 22:23:23 -0700926 mutex_unlock(&epmutex);
927}
928
929static int ep_alloc(struct eventpoll **pep)
930{
Davide Libenzi7ef99642008-12-01 13:13:55 -0800931 int error;
932 struct user_struct *user;
933 struct eventpoll *ep;
Davide Libenzi7699acd2007-05-10 22:23:23 -0700934
Davide Libenzi7ef99642008-12-01 13:13:55 -0800935 user = get_current_user();
Davide Libenzi7ef99642008-12-01 13:13:55 -0800936 error = -ENOMEM;
937 ep = kzalloc(sizeof(*ep), GFP_KERNEL);
938 if (unlikely(!ep))
939 goto free_uid;
Davide Libenzi7699acd2007-05-10 22:23:23 -0700940
Davide Libenzid47de162007-05-15 01:40:41 -0700941 mutex_init(&ep->mtx);
Roman Penyaeva218cc42019-03-07 16:28:53 -0800942 rwlock_init(&ep->lock);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700943 init_waitqueue_head(&ep->wq);
944 init_waitqueue_head(&ep->poll_wait);
945 INIT_LIST_HEAD(&ep->rdllist);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700946 ep->rbr = RB_ROOT_CACHED;
Davide Libenzid47de162007-05-15 01:40:41 -0700947 ep->ovflist = EP_UNACTIVE_PTR;
Davide Libenzi7ef99642008-12-01 13:13:55 -0800948 ep->user = user;
Davide Libenzi7699acd2007-05-10 22:23:23 -0700949
950 *pep = ep;
951
Davide Libenzi7699acd2007-05-10 22:23:23 -0700952 return 0;
Davide Libenzi7ef99642008-12-01 13:13:55 -0800953
954free_uid:
955 free_uid(user);
956 return error;
Davide Libenzi7699acd2007-05-10 22:23:23 -0700957}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700958
959/*
Davide Libenzic7ea7632007-05-15 01:40:47 -0700960 * Search the file inside the eventpoll tree. The RB tree operations
961 * are protected by the "mtx" mutex, and ep_find() must be called with
962 * "mtx" held.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963 */
964static struct epitem *ep_find(struct eventpoll *ep, struct file *file, int fd)
965{
966 int kcmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967 struct rb_node *rbp;
968 struct epitem *epi, *epir = NULL;
969 struct epoll_filefd ffd;
970
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700971 ep_set_ffd(&ffd, file, fd);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700972 for (rbp = ep->rbr.rb_root.rb_node; rbp; ) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973 epi = rb_entry(rbp, struct epitem, rbn);
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700974 kcmp = ep_cmp_ffd(&ffd, &epi->ffd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700975 if (kcmp > 0)
976 rbp = rbp->rb_right;
977 else if (kcmp < 0)
978 rbp = rbp->rb_left;
979 else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980 epir = epi;
981 break;
982 }
983 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984
Linus Torvalds1da177e2005-04-16 15:20:36 -0700985 return epir;
986}
987
Chris Wilsonbfe39112021-02-05 22:00:12 +0000988#ifdef CONFIG_KCMP
Cyrill Gorcunov0791e362017-07-12 14:34:28 -0700989static struct epitem *ep_find_tfd(struct eventpoll *ep, int tfd, unsigned long toff)
990{
991 struct rb_node *rbp;
992 struct epitem *epi;
993
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700994 for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) {
Cyrill Gorcunov0791e362017-07-12 14:34:28 -0700995 epi = rb_entry(rbp, struct epitem, rbn);
996 if (epi->ffd.fd == tfd) {
997 if (toff == 0)
998 return epi;
999 else
1000 toff--;
1001 }
1002 cond_resched();
1003 }
1004
1005 return NULL;
1006}
1007
1008struct file *get_epoll_tfile_raw_ptr(struct file *file, int tfd,
1009 unsigned long toff)
1010{
1011 struct file *file_raw;
1012 struct eventpoll *ep;
1013 struct epitem *epi;
1014
1015 if (!is_file_epoll(file))
1016 return ERR_PTR(-EINVAL);
1017
1018 ep = file->private_data;
1019
1020 mutex_lock(&ep->mtx);
1021 epi = ep_find_tfd(ep, tfd, toff);
1022 if (epi)
1023 file_raw = epi->ffd.file;
1024 else
1025 file_raw = ERR_PTR(-ENOENT);
1026 mutex_unlock(&ep->mtx);
1027
1028 return file_raw;
1029}
Chris Wilsonbfe39112021-02-05 22:00:12 +00001030#endif /* CONFIG_KCMP */
Cyrill Gorcunov0791e362017-07-12 14:34:28 -07001031
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001032/*
Roman Penyaeva218cc42019-03-07 16:28:53 -08001033 * Adds a new entry to the tail of the list in a lockless way, i.e.
1034 * multiple CPUs are allowed to call this function concurrently.
1035 *
1036 * Beware: it is necessary to prevent any other modifications of the
1037 * existing list until all changes are completed, in other words
1038 * concurrent list_add_tail_lockless() calls should be protected
1039 * with a read lock, where write lock acts as a barrier which
1040 * makes sure all list_add_tail_lockless() calls are fully
1041 * completed.
1042 *
1043 * Also an element can be locklessly added to the list only in one
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001044 * direction i.e. either to the tail or to the head, otherwise
Roman Penyaeva218cc42019-03-07 16:28:53 -08001045 * concurrent access will corrupt the list.
1046 *
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001047 * Return: %false if element has been already added to the list, %true
Roman Penyaeva218cc42019-03-07 16:28:53 -08001048 * otherwise.
1049 */
1050static inline bool list_add_tail_lockless(struct list_head *new,
1051 struct list_head *head)
1052{
1053 struct list_head *prev;
1054
1055 /*
1056 * This is simple 'new->next = head' operation, but cmpxchg()
1057 * is used in order to detect that same element has been just
1058 * added to the list from another CPU: the winner observes
1059 * new->next == new.
1060 */
1061 if (cmpxchg(&new->next, new, head) != new)
1062 return false;
1063
1064 /*
1065 * Initially ->next of a new element must be updated with the head
1066 * (we are inserting to the tail) and only then pointers are atomically
1067 * exchanged. XCHG guarantees memory ordering, thus ->next should be
1068 * updated before pointers are actually swapped and pointers are
1069 * swapped before prev->next is updated.
1070 */
1071
1072 prev = xchg(&head->prev, new);
1073
1074 /*
1075 * It is safe to modify prev->next and new->prev, because a new element
1076 * is added only to the tail and new->next is updated before XCHG.
1077 */
1078
1079 prev->next = new;
1080 new->prev = prev;
1081
1082 return true;
1083}
1084
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001085/*
Roman Penyaeva218cc42019-03-07 16:28:53 -08001086 * Chains a new epi entry to the tail of the ep->ovflist in a lockless way,
1087 * i.e. multiple CPUs are allowed to call this function concurrently.
1088 *
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001089 * Return: %false if epi element has been already chained, %true otherwise.
Roman Penyaeva218cc42019-03-07 16:28:53 -08001090 */
1091static inline bool chain_epi_lockless(struct epitem *epi)
1092{
1093 struct eventpoll *ep = epi->ep;
1094
Khazhismel Kumykov0c54a6a2020-05-07 18:35:59 -07001095 /* Fast preliminary check */
1096 if (epi->next != EP_UNACTIVE_PTR)
1097 return false;
1098
Roman Penyaeva218cc42019-03-07 16:28:53 -08001099 /* Check that the same epi has not been just chained from another CPU */
1100 if (cmpxchg(&epi->next, EP_UNACTIVE_PTR, NULL) != EP_UNACTIVE_PTR)
1101 return false;
1102
1103 /* Atomically exchange tail */
1104 epi->next = xchg(&ep->ovflist, epi);
1105
1106 return true;
1107}
1108
Linus Torvalds1da177e2005-04-16 15:20:36 -07001109/*
Davide Libenzi7699acd2007-05-10 22:23:23 -07001110 * This is the callback that is passed to the wait queue wakeup
Daniel Balutabf6a41d2011-01-30 23:42:29 +02001111 * mechanism. It is called by the stored file descriptors when they
Davide Libenzi7699acd2007-05-10 22:23:23 -07001112 * have events to report.
Roman Penyaeva218cc42019-03-07 16:28:53 -08001113 *
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001114 * This callback takes a read lock in order not to contend with concurrent
1115 * events from another file descriptor, thus all modifications to ->rdllist
Roman Penyaeva218cc42019-03-07 16:28:53 -08001116 * or ->ovflist are lockless. Read lock is paired with the write lock from
1117 * ep_scan_ready_list(), which stops all list modifications and guarantees
1118 * that lists state is seen correctly.
1119 *
1120 * Another thing worth to mention is that ep_poll_callback() can be called
1121 * concurrently for the same @epi from different CPUs if poll table was inited
1122 * with several wait queues entries. Plural wakeup from different CPUs of a
1123 * single wait queue is serialized by wq.lock, but the case when multiple wait
1124 * queues are used should be detected accordingly. This is detected using
1125 * cmpxchg() operation.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001126 */
Ingo Molnarac6424b2017-06-20 12:06:13 +02001127static int ep_poll_callback(wait_queue_entry_t *wait, unsigned mode, int sync, void *key)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001128{
Davide Libenzi7699acd2007-05-10 22:23:23 -07001129 int pwake = 0;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001130 struct epitem *epi = ep_item_from_wait(wait);
1131 struct eventpoll *ep = epi->ep;
Al Viro3ad6f932017-07-03 20:14:56 -04001132 __poll_t pollflags = key_to_poll(key);
Roman Penyaeva218cc42019-03-07 16:28:53 -08001133 unsigned long flags;
Jason Barondf0108c2016-01-20 14:59:24 -08001134 int ewake = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001135
Roman Penyaeva218cc42019-03-07 16:28:53 -08001136 read_lock_irqsave(&ep->lock, flags);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001137
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -07001138 ep_set_busy_poll_napi_id(epi);
1139
Davide Libenzi7699acd2007-05-10 22:23:23 -07001140 /*
1141 * If the event mask does not contain any poll(2) event, we consider the
1142 * descriptor to be disabled. This condition is likely the effect of the
1143 * EPOLLONESHOT bit that disables the descriptor when an event is received,
1144 * until the next EPOLL_CTL_MOD will be issued.
1145 */
1146 if (!(epi->event.events & ~EP_PRIVATE_BITS))
Davide Libenzid47de162007-05-15 01:40:41 -07001147 goto out_unlock;
1148
1149 /*
Davide Libenzi2dfa4ee2009-03-31 15:24:22 -07001150 * Check the events coming with the callback. At this stage, not
1151 * every device reports the events in the "key" parameter of the
1152 * callback. We need to be able to handle both cases here, hence the
1153 * test for "key" != NULL before the event match test.
1154 */
Al Viro3ad6f932017-07-03 20:14:56 -04001155 if (pollflags && !(pollflags & epi->event.events))
Davide Libenzi2dfa4ee2009-03-31 15:24:22 -07001156 goto out_unlock;
1157
1158 /*
Daniel Balutabf6a41d2011-01-30 23:42:29 +02001159 * If we are transferring events to userspace, we can hold no locks
Davide Libenzid47de162007-05-15 01:40:41 -07001160 * (because we're accessing user memory, and because of linux f_op->poll()
Daniel Balutabf6a41d2011-01-30 23:42:29 +02001161 * semantics). All the events that happen during that period of time are
Davide Libenzid47de162007-05-15 01:40:41 -07001162 * chained in ep->ovflist and requeued later on.
1163 */
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001164 if (READ_ONCE(ep->ovflist) != EP_UNACTIVE_PTR) {
Khazhismel Kumykov0c54a6a2020-05-07 18:35:59 -07001165 if (chain_epi_lockless(epi))
Roman Penyaevc3e320b2019-03-07 16:28:49 -08001166 ep_pm_stay_awake_rcu(epi);
Khazhismel Kumykov0c54a6a2020-05-07 18:35:59 -07001167 } else if (!ep_is_linked(epi)) {
1168 /* In the usual case, add event to ready list. */
1169 if (list_add_tail_lockless(&epi->rdllink, &ep->rdllist))
1170 ep_pm_stay_awake_rcu(epi);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001171 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07001172
Davide Libenzi7699acd2007-05-10 22:23:23 -07001173 /*
1174 * Wake up ( if active ) both the eventpoll wait list and the ->poll()
1175 * wait list.
1176 */
Jason Barondf0108c2016-01-20 14:59:24 -08001177 if (waitqueue_active(&ep->wq)) {
Jason Baronb6a515c2016-02-05 15:37:04 -08001178 if ((epi->event.events & EPOLLEXCLUSIVE) &&
Al Viro3ad6f932017-07-03 20:14:56 -04001179 !(pollflags & POLLFREE)) {
1180 switch (pollflags & EPOLLINOUT_BITS) {
Linus Torvaldsa9a08842018-02-11 14:34:03 -08001181 case EPOLLIN:
1182 if (epi->event.events & EPOLLIN)
Jason Baronb6a515c2016-02-05 15:37:04 -08001183 ewake = 1;
1184 break;
Linus Torvaldsa9a08842018-02-11 14:34:03 -08001185 case EPOLLOUT:
1186 if (epi->event.events & EPOLLOUT)
Jason Baronb6a515c2016-02-05 15:37:04 -08001187 ewake = 1;
1188 break;
1189 case 0:
1190 ewake = 1;
1191 break;
1192 }
1193 }
Roman Penyaeva218cc42019-03-07 16:28:53 -08001194 wake_up(&ep->wq);
Jason Barondf0108c2016-01-20 14:59:24 -08001195 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07001196 if (waitqueue_active(&ep->poll_wait))
1197 pwake++;
1198
Davide Libenzid47de162007-05-15 01:40:41 -07001199out_unlock:
Roman Penyaeva218cc42019-03-07 16:28:53 -08001200 read_unlock_irqrestore(&ep->lock, flags);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001201
1202 /* We have to call this outside the lock */
1203 if (pwake)
Jason Baronefcdd352020-04-06 20:11:23 -07001204 ep_poll_safewake(ep, epi);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001205
Oleg Nesterov138e4ad2017-09-01 18:55:33 +02001206 if (!(epi->event.events & EPOLLEXCLUSIVE))
1207 ewake = 1;
Jason Barondf0108c2016-01-20 14:59:24 -08001208
Al Viro3ad6f932017-07-03 20:14:56 -04001209 if (pollflags & POLLFREE) {
Oleg Nesterov138e4ad2017-09-01 18:55:33 +02001210 /*
1211 * If we race with ep_remove_wait_queue() it can miss
1212 * ->whead = NULL and do another remove_wait_queue() after
1213 * us, so we can't use __remove_wait_queue().
1214 */
1215 list_del_init(&wait->entry);
1216 /*
1217 * ->whead != NULL protects us from the race with ep_free()
1218 * or ep_remove(), ep_remove_wait_queue() takes whead->lock
1219 * held by the caller. Once we nullify it, nothing protects
1220 * ep/epi or even wait.
1221 */
1222 smp_store_release(&ep_pwq_from_wait(wait)->whead, NULL);
1223 }
1224
1225 return ewake;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226}
1227
Linus Torvalds1da177e2005-04-16 15:20:36 -07001228/*
1229 * This is the callback that is used to add our wait queue to the
1230 * target file wakeup lists.
1231 */
1232static void ep_ptable_queue_proc(struct file *file, wait_queue_head_t *whead,
1233 poll_table *pt)
1234{
Al Viro364f3742020-09-02 11:55:09 -04001235 struct ep_pqueue *epq = container_of(pt, struct ep_pqueue, pt);
1236 struct epitem *epi = epq->epi;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001237 struct eppoll_entry *pwq;
1238
Al Viro364f3742020-09-02 11:55:09 -04001239 if (unlikely(!epi)) // an earlier allocation has failed
1240 return;
1241
1242 pwq = kmem_cache_alloc(pwq_cache, GFP_KERNEL);
1243 if (unlikely(!pwq)) {
1244 epq->epi = NULL;
1245 return;
Davide Libenzi296e2362009-03-31 15:24:11 -07001246 }
Al Viro364f3742020-09-02 11:55:09 -04001247
1248 init_waitqueue_func_entry(&pwq->wait, ep_poll_callback);
1249 pwq->whead = whead;
1250 pwq->base = epi;
1251 if (epi->event.events & EPOLLEXCLUSIVE)
1252 add_wait_queue_exclusive(whead, &pwq->wait);
1253 else
1254 add_wait_queue(whead, &pwq->wait);
1255 pwq->next = epi->pwqlist;
1256 epi->pwqlist = pwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257}
1258
Linus Torvalds1da177e2005-04-16 15:20:36 -07001259static void ep_rbtree_insert(struct eventpoll *ep, struct epitem *epi)
1260{
1261 int kcmp;
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001262 struct rb_node **p = &ep->rbr.rb_root.rb_node, *parent = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001263 struct epitem *epic;
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001264 bool leftmost = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265
1266 while (*p) {
1267 parent = *p;
1268 epic = rb_entry(parent, struct epitem, rbn);
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001269 kcmp = ep_cmp_ffd(&epi->ffd, &epic->ffd);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001270 if (kcmp > 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001271 p = &parent->rb_right;
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001272 leftmost = false;
1273 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -07001274 p = &parent->rb_left;
1275 }
1276 rb_link_node(&epi->rbn, parent, p);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001277 rb_insert_color_cached(&epi->rbn, &ep->rbr, leftmost);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001278}
1279
Andrew Mortona80a6b82012-11-08 15:53:35 -08001280
1281
Jason Baron28d82dc2012-01-12 17:17:43 -08001282#define PATH_ARR_SIZE 5
1283/*
1284 * These are the number paths of length 1 to 5, that we are allowing to emanate
1285 * from a single file of interest. For example, we allow 1000 paths of length
1286 * 1, to emanate from each file of interest. This essentially represents the
1287 * potential wakeup paths, which need to be limited in order to avoid massive
1288 * uncontrolled wakeup storms. The common use case should be a single ep which
1289 * is connected to n file sources. In this case each file source has 1 path
1290 * of length 1. Thus, the numbers below should be more than sufficient. These
1291 * path limits are enforced during an EPOLL_CTL_ADD operation, since a modify
1292 * and delete can't add additional paths. Protected by the epmutex.
1293 */
1294static const int path_limits[PATH_ARR_SIZE] = { 1000, 500, 100, 50, 10 };
1295static int path_count[PATH_ARR_SIZE];
1296
1297static int path_count_inc(int nests)
1298{
Jason Baron93dc6102012-03-16 16:34:03 -04001299 /* Allow an arbitrary number of depth 1 paths */
1300 if (nests == 0)
1301 return 0;
1302
Jason Baron28d82dc2012-01-12 17:17:43 -08001303 if (++path_count[nests] > path_limits[nests])
1304 return -1;
1305 return 0;
1306}
1307
1308static void path_count_init(void)
1309{
1310 int i;
1311
1312 for (i = 0; i < PATH_ARR_SIZE; i++)
1313 path_count[i] = 0;
1314}
1315
Al Viro319c1512020-10-01 20:45:51 -04001316static int reverse_path_check_proc(struct hlist_head *refs, int depth)
Jason Baron28d82dc2012-01-12 17:17:43 -08001317{
1318 int error = 0;
Jason Baron28d82dc2012-01-12 17:17:43 -08001319 struct epitem *epi;
1320
Al Viro0c320f72020-09-25 19:48:56 -04001321 if (depth > EP_MAX_NESTS) /* too deep nesting */
Al Viro99d84d42020-08-22 23:08:37 -04001322 return -1;
1323
Jason Baronae10b2b2013-11-12 15:10:16 -08001324 /* CTL_DEL can remove links here, but that can't increase our count */
Al Viro319c1512020-10-01 20:45:51 -04001325 hlist_for_each_entry_rcu(epi, refs, fllink) {
1326 struct hlist_head *refs = &epi->ep->refs;
1327 if (hlist_empty(refs))
Al Virod16312a2020-09-26 15:54:05 -04001328 error = path_count_inc(depth);
1329 else
Al Viro319c1512020-10-01 20:45:51 -04001330 error = reverse_path_check_proc(refs, depth + 1);
Al Virod16312a2020-09-26 15:54:05 -04001331 if (error != 0)
1332 break;
Jason Baron28d82dc2012-01-12 17:17:43 -08001333 }
1334 return error;
1335}
1336
1337/**
Al Viro319c1512020-10-01 20:45:51 -04001338 * reverse_path_check - The tfile_check_list is list of epitem_head, which have
Jason Baron28d82dc2012-01-12 17:17:43 -08001339 * links that are proposed to be newly added. We need to
1340 * make sure that those added links don't add too many
1341 * paths such that we will spend all our time waking up
1342 * eventpoll objects.
1343 *
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001344 * Return: %zero if the proposed links don't create too many paths,
1345 * %-1 otherwise.
Jason Baron28d82dc2012-01-12 17:17:43 -08001346 */
1347static int reverse_path_check(void)
1348{
Al Viro319c1512020-10-01 20:45:51 -04001349 struct epitems_head *p;
Jason Baron28d82dc2012-01-12 17:17:43 -08001350
Al Viro319c1512020-10-01 20:45:51 -04001351 for (p = tfile_check_list; p != EP_UNACTIVE_PTR; p = p->next) {
1352 int error;
Jason Baron28d82dc2012-01-12 17:17:43 -08001353 path_count_init();
Al Virob62d2702020-10-01 14:11:00 -04001354 rcu_read_lock();
Al Viro319c1512020-10-01 20:45:51 -04001355 error = reverse_path_check_proc(&p->epitems, 0);
Al Virob62d2702020-10-01 14:11:00 -04001356 rcu_read_unlock();
Jason Baron28d82dc2012-01-12 17:17:43 -08001357 if (error)
Al Viro319c1512020-10-01 20:45:51 -04001358 return error;
Jason Baron28d82dc2012-01-12 17:17:43 -08001359 }
Al Viro319c1512020-10-01 20:45:51 -04001360 return 0;
Jason Baron28d82dc2012-01-12 17:17:43 -08001361}
1362
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001363static int ep_create_wakeup_source(struct epitem *epi)
1364{
Al Viro3701cb52020-09-24 19:41:58 -04001365 struct name_snapshot n;
Eric Wongeea1d582013-04-30 15:27:39 -07001366 struct wakeup_source *ws;
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001367
1368 if (!epi->ep->ws) {
Tri Voc8377ad2019-08-06 18:48:46 -07001369 epi->ep->ws = wakeup_source_register(NULL, "eventpoll");
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001370 if (!epi->ep->ws)
1371 return -ENOMEM;
1372 }
1373
Al Viro3701cb52020-09-24 19:41:58 -04001374 take_dentry_name_snapshot(&n, epi->ffd.file->f_path.dentry);
1375 ws = wakeup_source_register(NULL, n.name.name);
1376 release_dentry_name_snapshot(&n);
Eric Wongeea1d582013-04-30 15:27:39 -07001377
1378 if (!ws)
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001379 return -ENOMEM;
Eric Wongeea1d582013-04-30 15:27:39 -07001380 rcu_assign_pointer(epi->ws, ws);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001381
1382 return 0;
1383}
1384
Eric Wongeea1d582013-04-30 15:27:39 -07001385/* rare code path, only used when EPOLL_CTL_MOD removes a wakeup source */
1386static noinline void ep_destroy_wakeup_source(struct epitem *epi)
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001387{
Eric Wongeea1d582013-04-30 15:27:39 -07001388 struct wakeup_source *ws = ep_wakeup_source(epi);
1389
Eric Wongd6d67e72013-04-30 15:27:43 -07001390 RCU_INIT_POINTER(epi->ws, NULL);
Eric Wongeea1d582013-04-30 15:27:39 -07001391
1392 /*
1393 * wait for ep_pm_stay_awake_rcu to finish, synchronize_rcu is
1394 * used internally by wakeup_source_remove, too (called by
1395 * wakeup_source_unregister), so we cannot use call_rcu
1396 */
1397 synchronize_rcu();
1398 wakeup_source_unregister(ws);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001399}
1400
Al Viro319c1512020-10-01 20:45:51 -04001401static int attach_epitem(struct file *file, struct epitem *epi)
1402{
1403 struct epitems_head *to_free = NULL;
1404 struct hlist_head *head = NULL;
1405 struct eventpoll *ep = NULL;
1406
1407 if (is_file_epoll(file))
1408 ep = file->private_data;
1409
1410 if (ep) {
1411 head = &ep->refs;
1412 } else if (!READ_ONCE(file->f_ep)) {
1413allocate:
1414 to_free = kmem_cache_zalloc(ephead_cache, GFP_KERNEL);
1415 if (!to_free)
1416 return -ENOMEM;
1417 head = &to_free->epitems;
1418 }
1419 spin_lock(&file->f_lock);
1420 if (!file->f_ep) {
1421 if (unlikely(!head)) {
1422 spin_unlock(&file->f_lock);
1423 goto allocate;
1424 }
1425 file->f_ep = head;
1426 to_free = NULL;
1427 }
1428 hlist_add_head_rcu(&epi->fllink, file->f_ep);
1429 spin_unlock(&file->f_lock);
1430 free_ephead(to_free);
1431 return 0;
1432}
1433
Davide Libenzic7ea7632007-05-15 01:40:47 -07001434/*
1435 * Must be called with "mtx" held.
1436 */
Al Virobec1a5022017-11-28 19:43:33 -05001437static int ep_insert(struct eventpoll *ep, const struct epoll_event *event,
Jason Baron67347fe2013-11-12 15:10:18 -08001438 struct file *tfile, int fd, int full_check)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439{
Al Virod85e2aa2018-02-01 15:24:58 -05001440 int error, pwake = 0;
1441 __poll_t revents;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442 struct epitem *epi;
1443 struct ep_pqueue epq;
Al Viro85353e92020-09-26 18:15:26 -04001444 struct eventpoll *tep = NULL;
1445
1446 if (is_file_epoll(tfile))
1447 tep = tfile->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001448
Davidlohr Bueso92e64172018-08-21 21:56:45 -07001449 lockdep_assert_irqs_enabled();
1450
Nicholas Piggin1e1c1582021-09-07 20:00:00 -07001451 if (unlikely(percpu_counter_compare(&ep->user->epoll_watches,
1452 max_user_watches) >= 0))
Davide Libenzi7ef99642008-12-01 13:13:55 -08001453 return -ENOSPC;
Nicholas Piggin1e1c1582021-09-07 20:00:00 -07001454 percpu_counter_inc(&ep->user->epoll_watches);
1455
1456 if (!(epi = kmem_cache_zalloc(epi_cache, GFP_KERNEL))) {
1457 percpu_counter_dec(&ep->user->epoll_watches);
Davide Libenzi7ef99642008-12-01 13:13:55 -08001458 return -ENOMEM;
Nicholas Piggin1e1c1582021-09-07 20:00:00 -07001459 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001460
1461 /* Item initialization follow here ... */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001462 INIT_LIST_HEAD(&epi->rdllink);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001463 epi->ep = ep;
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001464 ep_set_ffd(&epi->ffd, tfile, fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001465 epi->event = *event;
Davide Libenzid47de162007-05-15 01:40:41 -07001466 epi->next = EP_UNACTIVE_PTR;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467
Al Viro85353e92020-09-26 18:15:26 -04001468 if (tep)
1469 mutex_lock_nested(&tep->mtx, 1);
Al Virof8d4f442020-09-09 22:25:06 -04001470 /* Add the current item to the list of active epoll hook for this file */
Al Viro319c1512020-10-01 20:45:51 -04001471 if (unlikely(attach_epitem(tfile, epi) < 0)) {
Al Viro319c1512020-10-01 20:45:51 -04001472 if (tep)
1473 mutex_unlock(&tep->mtx);
Nicholas Piggin1e1c1582021-09-07 20:00:00 -07001474 kmem_cache_free(epi_cache, epi);
1475 percpu_counter_dec(&ep->user->epoll_watches);
Al Viro319c1512020-10-01 20:45:51 -04001476 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001477 }
1478
Al Viro319c1512020-10-01 20:45:51 -04001479 if (full_check && !tep)
1480 list_file(tfile);
1481
Al Virof8d4f442020-09-09 22:25:06 -04001482 /*
1483 * Add the current item to the RB tree. All RB tree operations are
1484 * protected by "mtx", and ep_insert() is called with "mtx" held.
1485 */
1486 ep_rbtree_insert(ep, epi);
Al Viro85353e92020-09-26 18:15:26 -04001487 if (tep)
1488 mutex_unlock(&tep->mtx);
Al Virof8d4f442020-09-09 22:25:06 -04001489
1490 /* now check if we've created too many backpaths */
Al Viroe3e096e2020-09-26 18:09:29 -04001491 if (unlikely(full_check && reverse_path_check())) {
1492 ep_remove(ep, epi);
1493 return -EINVAL;
1494 }
Al Virof8d4f442020-09-09 22:25:06 -04001495
Al Virod1ec50a2020-09-27 11:03:32 -04001496 if (epi->event.events & EPOLLWAKEUP) {
1497 error = ep_create_wakeup_source(epi);
1498 if (error) {
1499 ep_remove(ep, epi);
1500 return error;
1501 }
1502 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001503
1504 /* Initialize the poll table using the queue callback */
1505 epq.epi = epi;
1506 init_poll_funcptr(&epq.pt, ep_ptable_queue_proc);
1507
1508 /*
1509 * Attach the item to the poll hooks and get current event bits.
1510 * We can safely use the file* here because its usage count has
Davide Libenzic7ea7632007-05-15 01:40:47 -07001511 * been increased by the caller of this function. Note that after
1512 * this operation completes, the poll callback can start hitting
1513 * the new item.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001514 */
Jason Baron37b5e522017-11-17 15:29:06 -08001515 revents = ep_item_poll(epi, &epq.pt, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001516
1517 /*
1518 * We have to check if something went wrong during the poll wait queue
1519 * install process. Namely an allocation for a wait queue failed due
1520 * high memory pressure.
1521 */
Al Viroe3e096e2020-09-26 18:09:29 -04001522 if (unlikely(!epq.epi)) {
1523 ep_remove(ep, epi);
1524 return -ENOMEM;
1525 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001526
Davide Libenzic7ea7632007-05-15 01:40:47 -07001527 /* We have to drop the new item inside our item list to keep track of it */
Roman Penyaeva218cc42019-03-07 16:28:53 -08001528 write_lock_irq(&ep->lock);
Davide Libenzic7ea7632007-05-15 01:40:47 -07001529
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -07001530 /* record NAPI ID of new item if present */
1531 ep_set_busy_poll_napi_id(epi);
1532
Linus Torvalds1da177e2005-04-16 15:20:36 -07001533 /* If the file is already "ready" we drop it inside the ready list */
Davidlohr Bueso992991c2018-08-21 21:58:26 -07001534 if (revents && !ep_is_linked(epi)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001535 list_add_tail(&epi->rdllink, &ep->rdllist);
Eric Wongeea1d582013-04-30 15:27:39 -07001536 ep_pm_stay_awake(epi);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001537
1538 /* Notify waiting tasks that events are available */
1539 if (waitqueue_active(&ep->wq))
Roman Penyaeva218cc42019-03-07 16:28:53 -08001540 wake_up(&ep->wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001541 if (waitqueue_active(&ep->poll_wait))
1542 pwake++;
1543 }
1544
Roman Penyaeva218cc42019-03-07 16:28:53 -08001545 write_unlock_irq(&ep->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001546
1547 /* We have to call this outside the lock */
1548 if (pwake)
Jason Baronefcdd352020-04-06 20:11:23 -07001549 ep_poll_safewake(ep, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001550
Linus Torvalds1da177e2005-04-16 15:20:36 -07001551 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001552}
1553
Linus Torvalds1da177e2005-04-16 15:20:36 -07001554/*
1555 * Modify the interest event mask by dropping an event if the new mask
Davide Libenzic7ea7632007-05-15 01:40:47 -07001556 * has a match in the current file status. Must be called with "mtx" held.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001557 */
Al Virobec1a5022017-11-28 19:43:33 -05001558static int ep_modify(struct eventpoll *ep, struct epitem *epi,
1559 const struct epoll_event *event)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560{
1561 int pwake = 0;
Hans Verkuil626cf232012-03-23 15:02:27 -07001562 poll_table pt;
1563
Davidlohr Bueso92e64172018-08-21 21:56:45 -07001564 lockdep_assert_irqs_enabled();
1565
Hans Verkuil626cf232012-03-23 15:02:27 -07001566 init_poll_funcptr(&pt, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001567
1568 /*
Tony Battersbye057e152009-03-31 15:24:15 -07001569 * Set the new event interest mask before calling f_op->poll();
1570 * otherwise we might miss an event that happens between the
1571 * f_op->poll() call and the new event set registering.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001572 */
Eric Wong128dd172013-01-01 21:20:27 +00001573 epi->event.events = event->events; /* need barrier below */
Tony Battersbye057e152009-03-31 15:24:15 -07001574 epi->event.data = event->data; /* protected by mtx */
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001575 if (epi->event.events & EPOLLWAKEUP) {
Eric Wongeea1d582013-04-30 15:27:39 -07001576 if (!ep_has_wakeup_source(epi))
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001577 ep_create_wakeup_source(epi);
Eric Wongeea1d582013-04-30 15:27:39 -07001578 } else if (ep_has_wakeup_source(epi)) {
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001579 ep_destroy_wakeup_source(epi);
1580 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001581
1582 /*
Eric Wong128dd172013-01-01 21:20:27 +00001583 * The following barrier has two effects:
1584 *
1585 * 1) Flush epi changes above to other CPUs. This ensures
1586 * we do not miss events from ep_poll_callback if an
1587 * event occurs immediately after we call f_op->poll().
Roman Penyaeva218cc42019-03-07 16:28:53 -08001588 * We need this because we did not take ep->lock while
Eric Wong128dd172013-01-01 21:20:27 +00001589 * changing epi above (but ep_poll_callback does take
Roman Penyaeva218cc42019-03-07 16:28:53 -08001590 * ep->lock).
Eric Wong128dd172013-01-01 21:20:27 +00001591 *
1592 * 2) We also need to ensure we do not miss _past_ events
1593 * when calling f_op->poll(). This barrier also
1594 * pairs with the barrier in wq_has_sleeper (see
1595 * comments for wq_has_sleeper).
1596 *
1597 * This barrier will now guarantee ep_poll_callback or f_op->poll
1598 * (or both) will notice the readiness of an item.
1599 */
1600 smp_mb();
1601
1602 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001603 * Get current event bits. We can safely use the file* here because
1604 * its usage count has been increased by the caller of this function.
Davide Libenzic7ea7632007-05-15 01:40:47 -07001605 * If the item is "hot" and it is not registered inside the ready
Davide Libenzi67647d02007-05-15 01:40:52 -07001606 * list, push it inside.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607 */
Al Viro69112732017-11-28 19:56:15 -05001608 if (ep_item_poll(epi, &pt, 1)) {
Roman Penyaeva218cc42019-03-07 16:28:53 -08001609 write_lock_irq(&ep->lock);
Davidlohr Bueso992991c2018-08-21 21:58:26 -07001610 if (!ep_is_linked(epi)) {
Davide Libenzic7ea7632007-05-15 01:40:47 -07001611 list_add_tail(&epi->rdllink, &ep->rdllist);
Eric Wongeea1d582013-04-30 15:27:39 -07001612 ep_pm_stay_awake(epi);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001613
Davide Libenzic7ea7632007-05-15 01:40:47 -07001614 /* Notify waiting tasks that events are available */
1615 if (waitqueue_active(&ep->wq))
Roman Penyaeva218cc42019-03-07 16:28:53 -08001616 wake_up(&ep->wq);
Davide Libenzic7ea7632007-05-15 01:40:47 -07001617 if (waitqueue_active(&ep->poll_wait))
1618 pwake++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001619 }
Roman Penyaeva218cc42019-03-07 16:28:53 -08001620 write_unlock_irq(&ep->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001621 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622
1623 /* We have to call this outside the lock */
1624 if (pwake)
Jason Baronefcdd352020-04-06 20:11:23 -07001625 ep_poll_safewake(ep, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626
1627 return 0;
1628}
1629
Al Viroff079522020-08-31 13:39:52 -04001630static int ep_send_events(struct eventpoll *ep,
1631 struct epoll_event __user *events, int maxevents)
Davide Libenzi5071f972009-03-31 15:24:10 -07001632{
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001633 struct epitem *epi, *tmp;
Al Viroff079522020-08-31 13:39:52 -04001634 LIST_HEAD(txlist);
Hans Verkuil626cf232012-03-23 15:02:27 -07001635 poll_table pt;
Al Viroff079522020-08-31 13:39:52 -04001636 int res = 0;
Hans Verkuil626cf232012-03-23 15:02:27 -07001637
Soheil Hassas Yeganehcccd29b2020-12-18 14:01:51 -08001638 /*
1639 * Always short-circuit for fatal signals to allow threads to make a
1640 * timely exit without the chance of finding more events available and
1641 * fetching repeatedly.
1642 */
1643 if (fatal_signal_pending(current))
1644 return -EINTR;
1645
Hans Verkuil626cf232012-03-23 15:02:27 -07001646 init_poll_funcptr(&pt, NULL);
Al Viroff079522020-08-31 13:39:52 -04001647
Al Viro57804b12020-08-31 13:41:30 -04001648 mutex_lock(&ep->mtx);
1649 ep_start_scan(ep, &txlist);
Davide Libenzi5071f972009-03-31 15:24:10 -07001650
Davide Libenzi296e2362009-03-31 15:24:11 -07001651 /*
Davide Libenzi5071f972009-03-31 15:24:10 -07001652 * We can loop without lock because we are passed a task private list.
Al Viro57804b12020-08-31 13:41:30 -04001653 * Items cannot vanish during the loop we are holding ep->mtx.
Davide Libenzi296e2362009-03-31 15:24:11 -07001654 */
Al Viroff079522020-08-31 13:39:52 -04001655 list_for_each_entry_safe(epi, tmp, &txlist, rdllink) {
1656 struct wakeup_source *ws;
1657 __poll_t revents;
Davidlohr Bueso21877e12019-01-03 15:27:12 -08001658
Al Viroff079522020-08-31 13:39:52 -04001659 if (res >= maxevents)
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001660 break;
Davide Libenzi5071f972009-03-31 15:24:10 -07001661
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001662 /*
1663 * Activate ep->ws before deactivating epi->ws to prevent
1664 * triggering auto-suspend here (in case we reactive epi->ws
1665 * below).
1666 *
1667 * This could be rearranged to delay the deactivation of epi->ws
1668 * instead, but then epi->ws would temporarily be out of sync
1669 * with ep_is_linked().
1670 */
Eric Wongeea1d582013-04-30 15:27:39 -07001671 ws = ep_wakeup_source(epi);
1672 if (ws) {
1673 if (ws->active)
1674 __pm_stay_awake(ep->ws);
1675 __pm_relax(ws);
1676 }
1677
Davide Libenzi5071f972009-03-31 15:24:10 -07001678 list_del_init(&epi->rdllink);
1679
Davide Libenzi296e2362009-03-31 15:24:11 -07001680 /*
Davide Libenzi5071f972009-03-31 15:24:10 -07001681 * If the event mask intersect the caller-requested one,
Al Viro57804b12020-08-31 13:41:30 -04001682 * deliver the event to userspace. Again, we are holding ep->mtx,
1683 * so no operations coming from userspace can change the item.
Davide Libenzi296e2362009-03-31 15:24:11 -07001684 */
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001685 revents = ep_item_poll(epi, &pt, 1);
1686 if (!revents)
1687 continue;
1688
Arnd Bergmann249dbe72021-08-11 08:30:22 +01001689 events = epoll_put_uevent(revents, epi->event.data, events);
1690 if (!events) {
Al Viroff079522020-08-31 13:39:52 -04001691 list_add(&epi->rdllink, &txlist);
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001692 ep_pm_stay_awake(epi);
Al Viroff079522020-08-31 13:39:52 -04001693 if (!res)
1694 res = -EFAULT;
1695 break;
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001696 }
Al Viroff079522020-08-31 13:39:52 -04001697 res++;
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001698 if (epi->event.events & EPOLLONESHOT)
1699 epi->event.events &= EP_PRIVATE_BITS;
1700 else if (!(epi->event.events & EPOLLET)) {
1701 /*
1702 * If this file has been added with Level
1703 * Trigger mode, we need to insert back inside
1704 * the ready list, so that the next call to
1705 * epoll_wait() will check again the events
1706 * availability. At this point, no one can insert
1707 * into ep->rdllist besides us. The epoll_ctl()
1708 * callers are locked out by
1709 * ep_scan_ready_list() holding "mtx" and the
1710 * poll callback will queue them in ep->ovflist.
1711 */
1712 list_add_tail(&epi->rdllink, &ep->rdllist);
1713 ep_pm_stay_awake(epi);
Davide Libenzi296e2362009-03-31 15:24:11 -07001714 }
1715 }
Al Viro57804b12020-08-31 13:41:30 -04001716 ep_done_scan(ep, &txlist);
1717 mutex_unlock(&ep->mtx);
Davide Libenzi5071f972009-03-31 15:24:10 -07001718
Al Viroff079522020-08-31 13:39:52 -04001719 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001720}
1721
Willem de Bruijn7cdf7c22020-12-18 14:05:35 -08001722static struct timespec64 *ep_timeout_to_timespec(struct timespec64 *to, long ms)
Eric Dumazet0781b902011-02-01 15:52:35 -08001723{
Willem de Bruijn7cdf7c22020-12-18 14:05:35 -08001724 struct timespec64 now;
1725
1726 if (ms < 0)
1727 return NULL;
1728
1729 if (!ms) {
1730 to->tv_sec = 0;
1731 to->tv_nsec = 0;
1732 return to;
1733 }
1734
1735 to->tv_sec = ms / MSEC_PER_SEC;
1736 to->tv_nsec = NSEC_PER_MSEC * (ms % MSEC_PER_SEC);
Eric Dumazet0781b902011-02-01 15:52:35 -08001737
Deepa Dinamani766b9f92016-05-19 17:09:05 -07001738 ktime_get_ts64(&now);
Willem de Bruijn7cdf7c22020-12-18 14:05:35 -08001739 *to = timespec64_add_safe(now, *to);
1740 return to;
Eric Dumazet0781b902011-02-01 15:52:35 -08001741}
1742
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001743/**
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001744 * ep_poll - Retrieves ready events, and delivers them to the caller-supplied
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001745 * event buffer.
1746 *
1747 * @ep: Pointer to the eventpoll context.
1748 * @events: Pointer to the userspace buffer where the ready events should be
1749 * stored.
1750 * @maxevents: Size (in terms of number of events) of the caller event buffer.
1751 * @timeout: Maximum timeout for the ready events fetch operation, in
Willem de Bruijn7cdf7c22020-12-18 14:05:35 -08001752 * timespec. If the timeout is zero, the function will not block,
1753 * while if the @timeout ptr is NULL, the function will block
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001754 * until at least one event has been retrieved (or an error
1755 * occurred).
1756 *
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001757 * Return: the number of ready events which have been fetched, or an
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001758 * error code, in case of error.
1759 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001760static int ep_poll(struct eventpoll *ep, struct epoll_event __user *events,
Willem de Bruijn7cdf7c22020-12-18 14:05:35 -08001761 int maxevents, struct timespec64 *timeout)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001762{
Soheil Hassas Yeganehe59d3c62020-12-18 14:02:06 -08001763 int res, eavail, timed_out = 0;
John Stultzda8b44d2016-03-17 14:20:51 -07001764 u64 slack = 0;
Ingo Molnarac6424b2017-06-20 12:06:13 +02001765 wait_queue_entry_t wait;
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001766 ktime_t expires, *to = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001767
Davidlohr Bueso679abf32018-08-21 21:58:23 -07001768 lockdep_assert_irqs_enabled();
1769
Willem de Bruijn7cdf7c22020-12-18 14:05:35 -08001770 if (timeout && (timeout->tv_sec | timeout->tv_nsec)) {
1771 slack = select_estimate_accuracy(timeout);
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001772 to = &expires;
Willem de Bruijn7cdf7c22020-12-18 14:05:35 -08001773 *to = timespec64_to_ktime(*timeout);
1774 } else if (timeout) {
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001775 /*
1776 * Avoid the unnecessary trip to the wait queue loop, if the
Soheil Hassas Yeganehe59d3c62020-12-18 14:02:06 -08001777 * caller specified a non blocking operation.
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001778 */
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001779 timed_out = 1;
1780 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001781
Soheil Hassas Yeganehe59d3c62020-12-18 14:02:06 -08001782 /*
1783 * This call is racy: We may or may not see events that are being added
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001784 * to the ready list under the lock (e.g., in IRQ callbacks). For cases
Soheil Hassas Yeganehe59d3c62020-12-18 14:02:06 -08001785 * with a non-zero timeout, this thread will check the ready list under
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001786 * lock and will add to the wait queue. For cases with a zero
Soheil Hassas Yeganehe59d3c62020-12-18 14:02:06 -08001787 * timeout, the user by definition should not care and will have to
1788 * recheck again.
1789 */
1790 eavail = ep_events_available(ep);
1791
Soheil Hassas Yeganeh00b27632020-12-18 14:02:03 -08001792 while (1) {
1793 if (eavail) {
1794 /*
1795 * Try to transfer events to user space. In case we get
1796 * 0 events and there's still timeout left over, we go
1797 * trying again in search of more luck.
1798 */
1799 res = ep_send_events(ep, events, maxevents);
1800 if (res)
1801 return res;
1802 }
Soheil Hassas Yeganehe8c85322020-12-18 14:02:00 -08001803
Soheil Hassas Yeganeh00b27632020-12-18 14:02:03 -08001804 if (timed_out)
1805 return 0;
1806
Soheil Hassas Yeganeh00b27632020-12-18 14:02:03 -08001807 eavail = ep_busy_loop(ep, timed_out);
1808 if (eavail)
1809 continue;
Soheil Hassas Yeganehe8c85322020-12-18 14:02:00 -08001810
Soheil Hassas Yeganeh2efdaf72020-12-18 14:01:48 -08001811 if (signal_pending(current))
1812 return -EINTR;
1813
Roman Penyaev412895f2020-05-07 18:36:16 -07001814 /*
1815 * Internally init_wait() uses autoremove_wake_function(),
1816 * thus wait entry is removed from the wait queue on each
1817 * wakeup. Why it is important? In case of several waiters
1818 * each new wakeup will hit the next waiter, giving it the
1819 * chance to harvest new event. Otherwise wakeup can be
1820 * lost. This is also good performance-wise, because on
1821 * normal wakeup path no need to call __remove_wait_queue()
1822 * explicitly, thus ep->lock is not taken, which halts the
1823 * event delivery.
1824 */
1825 init_wait(&wait);
Roman Penyaev65759092020-05-13 17:50:38 -07001826
Roman Penyaev1b537342020-03-21 18:22:30 -07001827 write_lock_irq(&ep->lock);
Roman Penyaev65759092020-05-13 17:50:38 -07001828 /*
1829 * Barrierless variant, waitqueue_active() is called under
1830 * the same lock on wakeup ep_poll_callback() side, so it
1831 * is safe to avoid an explicit barrier.
1832 */
1833 __set_current_state(TASK_INTERRUPTIBLE);
1834
1835 /*
1836 * Do the final check under the lock. ep_scan_ready_list()
1837 * plays with two lists (->rdllist and ->ovflist) and there
1838 * is always a race when both lists are empty for short
1839 * period of time although events are pending, so lock is
1840 * important.
1841 */
1842 eavail = ep_events_available(ep);
Soheil Hassas Yeganeh2efdaf72020-12-18 14:01:48 -08001843 if (!eavail)
1844 __add_wait_queue_exclusive(&ep->wq, &wait);
1845
Roman Penyaev1b537342020-03-21 18:22:30 -07001846 write_unlock_irq(&ep->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001847
Soheil Hassas Yeganeh2efdaf72020-12-18 14:01:48 -08001848 if (!eavail)
Soheil Hassas Yeganeh289caf52020-12-18 14:01:44 -08001849 timed_out = !schedule_hrtimeout_range(to, slack,
1850 HRTIMER_MODE_ABS);
Soheil Hassas Yeganehe4115962020-12-18 14:01:54 -08001851 __set_current_state(TASK_RUNNING);
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001852
Soheil Hassas Yeganeh289caf52020-12-18 14:01:44 -08001853 /*
1854 * We were woken up, thus go and try to harvest some events.
1855 * If timed out and still on the wait queue, recheck eavail
1856 * carefully under lock, below.
1857 */
Roman Penyaev412895f2020-05-07 18:36:16 -07001858 eavail = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001859
Soheil Hassas Yeganehe8c85322020-12-18 14:02:00 -08001860 if (!list_empty_careful(&wait.entry)) {
1861 write_lock_irq(&ep->lock);
1862 /*
1863 * If the thread timed out and is not on the wait queue,
1864 * it means that the thread was woken up after its
1865 * timeout expired before it could reacquire the lock.
1866 * Thus, when wait.entry is empty, it needs to harvest
1867 * events.
1868 */
1869 if (timed_out)
1870 eavail = list_empty(&wait.entry);
1871 __remove_wait_queue(&ep->wq, &wait);
1872 write_unlock_irq(&ep->lock);
1873 }
Soheil Hassas Yeganeh00b27632020-12-18 14:02:03 -08001874 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001875}
1876
Davide Libenzi22bacca2011-02-25 14:44:12 -08001877/**
Al Viro773318e2020-08-22 23:13:27 -04001878 * ep_loop_check_proc - verify that adding an epoll file inside another
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001879 * epoll structure does not violate the constraints, in
Davide Libenzi22bacca2011-02-25 14:44:12 -08001880 * terms of closed loops, or too deep chains (which can
1881 * result in excessive stack usage).
1882 *
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001883 * @ep: the &struct eventpoll to be currently checked.
Al Virobde03c42020-09-26 16:50:57 -04001884 * @depth: Current depth of the path being checked.
Davide Libenzi22bacca2011-02-25 14:44:12 -08001885 *
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001886 * Return: %zero if adding the epoll @file inside current epoll
1887 * structure @ep does not violate the constraints, or %-1 otherwise.
Davide Libenzi22bacca2011-02-25 14:44:12 -08001888 */
Al Virobde03c42020-09-26 16:50:57 -04001889static int ep_loop_check_proc(struct eventpoll *ep, int depth)
Davide Libenzi22bacca2011-02-25 14:44:12 -08001890{
1891 int error = 0;
Davide Libenzi22bacca2011-02-25 14:44:12 -08001892 struct rb_node *rbp;
1893 struct epitem *epi;
1894
Al Viro773318e2020-08-22 23:13:27 -04001895 mutex_lock_nested(&ep->mtx, depth + 1);
Al Viro18306c42020-09-10 08:30:05 -04001896 ep->gen = loop_check_gen;
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001897 for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) {
Davide Libenzi22bacca2011-02-25 14:44:12 -08001898 epi = rb_entry(rbp, struct epitem, rbn);
1899 if (unlikely(is_file_epoll(epi->ffd.file))) {
Al Virobde03c42020-09-26 16:50:57 -04001900 struct eventpoll *ep_tovisit;
Jason Baron28d82dc2012-01-12 17:17:43 -08001901 ep_tovisit = epi->ffd.file->private_data;
Al Viro18306c42020-09-10 08:30:05 -04001902 if (ep_tovisit->gen == loop_check_gen)
Jason Baron28d82dc2012-01-12 17:17:43 -08001903 continue;
Al Virobde03c42020-09-26 16:50:57 -04001904 if (ep_tovisit == inserting_into || depth > EP_MAX_NESTS)
Al Viro56c428c2020-09-26 16:38:44 -04001905 error = -1;
Al Virobde03c42020-09-26 16:50:57 -04001906 else
1907 error = ep_loop_check_proc(ep_tovisit, depth + 1);
Davide Libenzi22bacca2011-02-25 14:44:12 -08001908 if (error != 0)
1909 break;
Jason Baron28d82dc2012-01-12 17:17:43 -08001910 } else {
1911 /*
1912 * If we've reached a file that is not associated with
1913 * an ep, then we need to check if the newly added
1914 * links are going to add too many wakeup paths. We do
1915 * this by adding it to the tfile_check_list, if it's
1916 * not already there, and calling reverse_path_check()
1917 * during ep_insert().
1918 */
Al Viro319c1512020-10-01 20:45:51 -04001919 list_file(epi->ffd.file);
Davide Libenzi22bacca2011-02-25 14:44:12 -08001920 }
1921 }
1922 mutex_unlock(&ep->mtx);
1923
1924 return error;
1925}
1926
1927/**
Al Virobde03c42020-09-26 16:50:57 -04001928 * ep_loop_check - Performs a check to verify that adding an epoll file (@to)
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001929 * into another epoll file (represented by @ep) does not create
Davide Libenzi22bacca2011-02-25 14:44:12 -08001930 * closed loops or too deep chains.
1931 *
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001932 * @ep: Pointer to the epoll we are inserting into.
Al Virobde03c42020-09-26 16:50:57 -04001933 * @to: Pointer to the epoll to be inserted.
Davide Libenzi22bacca2011-02-25 14:44:12 -08001934 *
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001935 * Return: %zero if adding the epoll @to inside the epoll @from
1936 * does not violate the constraints, or %-1 otherwise.
Davide Libenzi22bacca2011-02-25 14:44:12 -08001937 */
Al Virobde03c42020-09-26 16:50:57 -04001938static int ep_loop_check(struct eventpoll *ep, struct eventpoll *to)
Davide Libenzi22bacca2011-02-25 14:44:12 -08001939{
Al Viro6a3890c2020-09-26 16:29:02 -04001940 inserting_into = ep;
Al Virobde03c42020-09-26 16:50:57 -04001941 return ep_loop_check_proc(to, 0);
Jason Baron28d82dc2012-01-12 17:17:43 -08001942}
1943
1944static void clear_tfile_check_list(void)
1945{
Al Viro319c1512020-10-01 20:45:51 -04001946 rcu_read_lock();
1947 while (tfile_check_list != EP_UNACTIVE_PTR) {
1948 struct epitems_head *head = tfile_check_list;
1949 tfile_check_list = head->next;
1950 unlist_file(head);
Jason Baron28d82dc2012-01-12 17:17:43 -08001951 }
Al Viro319c1512020-10-01 20:45:51 -04001952 rcu_read_unlock();
Davide Libenzi22bacca2011-02-25 14:44:12 -08001953}
1954
Davide Libenzi7699acd2007-05-10 22:23:23 -07001955/*
Andrew Morton523723b2008-08-12 15:09:01 -07001956 * Open an eventpoll file descriptor.
Davide Libenzi7699acd2007-05-10 22:23:23 -07001957 */
Dominik Brodowski791eb222018-03-11 11:34:30 +01001958static int do_epoll_create(int flags)
Davide Libenzi7699acd2007-05-10 22:23:23 -07001959{
Jason Baron28d82dc2012-01-12 17:17:43 -08001960 int error, fd;
Davide Libenzibb57c3e2009-03-31 15:24:12 -07001961 struct eventpoll *ep = NULL;
Jason Baron28d82dc2012-01-12 17:17:43 -08001962 struct file *file;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001963
Ulrich Dreppere38b36f2008-07-23 21:29:42 -07001964 /* Check the EPOLL_* constant for consistency. */
1965 BUILD_BUG_ON(EPOLL_CLOEXEC != O_CLOEXEC);
1966
Davide Libenzi296e2362009-03-31 15:24:11 -07001967 if (flags & ~EPOLL_CLOEXEC)
1968 return -EINVAL;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001969 /*
Davide Libenzibb57c3e2009-03-31 15:24:12 -07001970 * Create the internal data structure ("struct eventpoll").
Davide Libenzi7699acd2007-05-10 22:23:23 -07001971 */
Ulrich Drepper9fe5ad92008-07-23 21:29:43 -07001972 error = ep_alloc(&ep);
Davide Libenzibb57c3e2009-03-31 15:24:12 -07001973 if (error < 0)
1974 return error;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001975 /*
1976 * Creates all the items needed to setup an eventpoll file. That is,
Al Viro2030a422008-02-23 06:46:49 -05001977 * a file structure and a free file descriptor.
Davide Libenzi7699acd2007-05-10 22:23:23 -07001978 */
Jason Baron28d82dc2012-01-12 17:17:43 -08001979 fd = get_unused_fd_flags(O_RDWR | (flags & O_CLOEXEC));
1980 if (fd < 0) {
1981 error = fd;
1982 goto out_free_ep;
1983 }
1984 file = anon_inode_getfile("[eventpoll]", &eventpoll_fops, ep,
Roland Dreier628ff7c2009-12-18 09:41:24 -08001985 O_RDWR | (flags & O_CLOEXEC));
Jason Baron28d82dc2012-01-12 17:17:43 -08001986 if (IS_ERR(file)) {
1987 error = PTR_ERR(file);
1988 goto out_free_fd;
1989 }
Jason Baron28d82dc2012-01-12 17:17:43 -08001990 ep->file = file;
Al Viro98022742012-08-17 22:42:36 -04001991 fd_install(fd, file);
Jason Baron28d82dc2012-01-12 17:17:43 -08001992 return fd;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001993
Jason Baron28d82dc2012-01-12 17:17:43 -08001994out_free_fd:
1995 put_unused_fd(fd);
1996out_free_ep:
1997 ep_free(ep);
Davide Libenzibb57c3e2009-03-31 15:24:12 -07001998 return error;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001999}
2000
Dominik Brodowski791eb222018-03-11 11:34:30 +01002001SYSCALL_DEFINE1(epoll_create1, int, flags)
2002{
2003 return do_epoll_create(flags);
2004}
2005
Heiko Carstens5a8a82b2009-01-14 14:14:25 +01002006SYSCALL_DEFINE1(epoll_create, int, size)
Ulrich Dreppera0998b52008-07-23 21:29:27 -07002007{
Davide Libenzibfe3891a2009-05-12 13:19:44 -07002008 if (size <= 0)
Ulrich Drepper9fe5ad92008-07-23 21:29:43 -07002009 return -EINVAL;
2010
Dominik Brodowski791eb222018-03-11 11:34:30 +01002011 return do_epoll_create(0);
Ulrich Dreppera0998b52008-07-23 21:29:27 -07002012}
2013
Jens Axboe39220e82020-01-08 15:05:37 -07002014static inline int epoll_mutex_lock(struct mutex *mutex, int depth,
2015 bool nonblock)
2016{
2017 if (!nonblock) {
2018 mutex_lock_nested(mutex, depth);
2019 return 0;
2020 }
2021 if (mutex_trylock(mutex))
2022 return 0;
2023 return -EAGAIN;
2024}
2025
2026int do_epoll_ctl(int epfd, int op, int fd, struct epoll_event *epds,
2027 bool nonblock)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002028{
2029 int error;
Jason Baron67347fe2013-11-12 15:10:18 -08002030 int full_check = 0;
Al Viro7e3fb582013-08-30 12:47:21 -04002031 struct fd f, tf;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002032 struct eventpoll *ep;
2033 struct epitem *epi;
Jason Baron67347fe2013-11-12 15:10:18 -08002034 struct eventpoll *tep = NULL;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002035
Davide Libenzi7699acd2007-05-10 22:23:23 -07002036 error = -EBADF;
Al Viro7e3fb582013-08-30 12:47:21 -04002037 f = fdget(epfd);
2038 if (!f.file)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002039 goto error_return;
2040
2041 /* Get the "struct file *" for the target file */
Al Viro7e3fb582013-08-30 12:47:21 -04002042 tf = fdget(fd);
2043 if (!tf.file)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002044 goto error_fput;
2045
2046 /* The target file descriptor must support poll */
2047 error = -EPERM;
Christoph Hellwig9965ed172018-03-05 07:26:05 -08002048 if (!file_can_poll(tf.file))
Davide Libenzi7699acd2007-05-10 22:23:23 -07002049 goto error_tgt_fput;
2050
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02002051 /* Check if EPOLLWAKEUP is allowed */
Nicolas Ioossc680e412014-09-09 14:50:51 -07002052 if (ep_op_has_event(op))
Jens Axboe58e41a42020-01-08 14:35:13 -07002053 ep_take_care_of_epollwakeup(epds);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02002054
Davide Libenzi7699acd2007-05-10 22:23:23 -07002055 /*
2056 * We have to check that the file structure underneath the file descriptor
2057 * the user passed to us _is_ an eventpoll file. And also we do not permit
2058 * adding an epoll file descriptor inside itself.
2059 */
2060 error = -EINVAL;
Al Viro7e3fb582013-08-30 12:47:21 -04002061 if (f.file == tf.file || !is_file_epoll(f.file))
Davide Libenzi7699acd2007-05-10 22:23:23 -07002062 goto error_tgt_fput;
2063
2064 /*
Jason Barondf0108c2016-01-20 14:59:24 -08002065 * epoll adds to the wakeup queue at EPOLL_CTL_ADD time only,
2066 * so EPOLLEXCLUSIVE is not allowed for a EPOLL_CTL_MOD operation.
2067 * Also, we do not currently supported nested exclusive wakeups.
2068 */
Jens Axboe58e41a42020-01-08 14:35:13 -07002069 if (ep_op_has_event(op) && (epds->events & EPOLLEXCLUSIVE)) {
Jason Baronb6a515c2016-02-05 15:37:04 -08002070 if (op == EPOLL_CTL_MOD)
2071 goto error_tgt_fput;
2072 if (op == EPOLL_CTL_ADD && (is_file_epoll(tf.file) ||
Jens Axboe58e41a42020-01-08 14:35:13 -07002073 (epds->events & ~EPOLLEXCLUSIVE_OK_BITS)))
Jason Baronb6a515c2016-02-05 15:37:04 -08002074 goto error_tgt_fput;
2075 }
Jason Barondf0108c2016-01-20 14:59:24 -08002076
2077 /*
Davide Libenzi7699acd2007-05-10 22:23:23 -07002078 * At this point it is safe to assume that the "private_data" contains
2079 * our own data structure.
2080 */
Al Viro7e3fb582013-08-30 12:47:21 -04002081 ep = f.file->private_data;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002082
Davide Libenzi22bacca2011-02-25 14:44:12 -08002083 /*
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07002084 * When we insert an epoll file descriptor inside another epoll file
2085 * descriptor, there is the chance of creating closed loops, which are
Jason Baron28d82dc2012-01-12 17:17:43 -08002086 * better be handled here, than in more critical paths. While we are
2087 * checking for loops we also determine the list of files reachable
2088 * and hang them on the tfile_check_list, so we can check that we
2089 * haven't created too many possible wakeup paths.
Davide Libenzi22bacca2011-02-25 14:44:12 -08002090 *
Jason Baron67347fe2013-11-12 15:10:18 -08002091 * We do not need to take the global 'epumutex' on EPOLL_CTL_ADD when
2092 * the epoll file descriptor is attaching directly to a wakeup source,
2093 * unless the epoll file descriptor is nested. The purpose of taking the
2094 * 'epmutex' on add is to prevent complex toplogies such as loops and
2095 * deep wakeup paths from forming in parallel through multiple
2096 * EPOLL_CTL_ADD operations.
Davide Libenzi22bacca2011-02-25 14:44:12 -08002097 */
Jens Axboe39220e82020-01-08 15:05:37 -07002098 error = epoll_mutex_lock(&ep->mtx, 0, nonblock);
2099 if (error)
2100 goto error_tgt_fput;
Jason Baron67347fe2013-11-12 15:10:18 -08002101 if (op == EPOLL_CTL_ADD) {
Al Viro319c1512020-10-01 20:45:51 -04002102 if (READ_ONCE(f.file->f_ep) || ep->gen == loop_check_gen ||
2103 is_file_epoll(tf.file)) {
Jason Baron67347fe2013-11-12 15:10:18 -08002104 mutex_unlock(&ep->mtx);
Jens Axboe39220e82020-01-08 15:05:37 -07002105 error = epoll_mutex_lock(&epmutex, 0, nonblock);
2106 if (error)
2107 goto error_tgt_fput;
Al Viro18306c42020-09-10 08:30:05 -04002108 loop_check_gen++;
Jens Axboe39220e82020-01-08 15:05:37 -07002109 full_check = 1;
Jason Baron67347fe2013-11-12 15:10:18 -08002110 if (is_file_epoll(tf.file)) {
Al Virobde03c42020-09-26 16:50:57 -04002111 tep = tf.file->private_data;
Jason Baron67347fe2013-11-12 15:10:18 -08002112 error = -ELOOP;
Al Virobde03c42020-09-26 16:50:57 -04002113 if (ep_loop_check(ep, tep) != 0)
Jason Baron67347fe2013-11-12 15:10:18 -08002114 goto error_tgt_fput;
Marc Zyngiera9ed4a62020-08-19 17:12:17 +01002115 }
Jens Axboe39220e82020-01-08 15:05:37 -07002116 error = epoll_mutex_lock(&ep->mtx, 0, nonblock);
Al Viro52c47962020-08-22 18:25:52 -04002117 if (error)
Jens Axboe39220e82020-01-08 15:05:37 -07002118 goto error_tgt_fput;
Jason Baron67347fe2013-11-12 15:10:18 -08002119 }
2120 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07002121
Davide Libenzi67647d02007-05-15 01:40:52 -07002122 /*
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07002123 * Try to lookup the file inside our RB tree. Since we grabbed "mtx"
Davide Libenzi67647d02007-05-15 01:40:52 -07002124 * above, we can be sure to be able to use the item looked up by
2125 * ep_find() till we release the mutex.
2126 */
Al Viro7e3fb582013-08-30 12:47:21 -04002127 epi = ep_find(ep, tf.file, fd);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002128
2129 error = -EINVAL;
2130 switch (op) {
2131 case EPOLL_CTL_ADD:
2132 if (!epi) {
Jens Axboe58e41a42020-01-08 14:35:13 -07002133 epds->events |= EPOLLERR | EPOLLHUP;
2134 error = ep_insert(ep, epds, tf.file, fd, full_check);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002135 } else
2136 error = -EEXIST;
2137 break;
2138 case EPOLL_CTL_DEL:
2139 if (epi)
2140 error = ep_remove(ep, epi);
2141 else
2142 error = -ENOENT;
2143 break;
2144 case EPOLL_CTL_MOD:
2145 if (epi) {
Jason Baronb6a515c2016-02-05 15:37:04 -08002146 if (!(epi->event.events & EPOLLEXCLUSIVE)) {
Jens Axboe58e41a42020-01-08 14:35:13 -07002147 epds->events |= EPOLLERR | EPOLLHUP;
2148 error = ep_modify(ep, epi, epds);
Jason Baronb6a515c2016-02-05 15:37:04 -08002149 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07002150 } else
2151 error = -ENOENT;
2152 break;
2153 }
Davide Libenzid47de162007-05-15 01:40:41 -07002154 mutex_unlock(&ep->mtx);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002155
2156error_tgt_fput:
Al Viro52c47962020-08-22 18:25:52 -04002157 if (full_check) {
2158 clear_tfile_check_list();
Al Viro18306c42020-09-10 08:30:05 -04002159 loop_check_gen++;
Davide Libenzi22bacca2011-02-25 14:44:12 -08002160 mutex_unlock(&epmutex);
Al Viro52c47962020-08-22 18:25:52 -04002161 }
Davide Libenzi22bacca2011-02-25 14:44:12 -08002162
Al Viro7e3fb582013-08-30 12:47:21 -04002163 fdput(tf);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002164error_fput:
Al Viro7e3fb582013-08-30 12:47:21 -04002165 fdput(f);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002166error_return:
Davide Libenzi7699acd2007-05-10 22:23:23 -07002167
2168 return error;
2169}
2170
2171/*
Jens Axboe58e41a42020-01-08 14:35:13 -07002172 * The following function implements the controller interface for
2173 * the eventpoll file that enables the insertion/removal/change of
2174 * file descriptors inside the interest set.
2175 */
2176SYSCALL_DEFINE4(epoll_ctl, int, epfd, int, op, int, fd,
2177 struct epoll_event __user *, event)
2178{
2179 struct epoll_event epds;
2180
2181 if (ep_op_has_event(op) &&
2182 copy_from_user(&epds, event, sizeof(struct epoll_event)))
2183 return -EFAULT;
2184
Jens Axboe39220e82020-01-08 15:05:37 -07002185 return do_epoll_ctl(epfd, op, fd, &epds, false);
Jens Axboe58e41a42020-01-08 14:35:13 -07002186}
2187
2188/*
Davide Libenzi7699acd2007-05-10 22:23:23 -07002189 * Implement the event wait interface for the eventpoll file. It is the kernel
2190 * part of the user space epoll_wait(2).
2191 */
Dominik Brodowski791eb222018-03-11 11:34:30 +01002192static int do_epoll_wait(int epfd, struct epoll_event __user *events,
Willem de Bruijn7cdf7c22020-12-18 14:05:35 -08002193 int maxevents, struct timespec64 *to)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002194{
Al Viro2903ff02012-08-28 12:52:22 -04002195 int error;
2196 struct fd f;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002197 struct eventpoll *ep;
2198
Davide Libenzi7699acd2007-05-10 22:23:23 -07002199 /* The maximum number of event must be greater than zero */
2200 if (maxevents <= 0 || maxevents > EP_MAX_EVENTS)
2201 return -EINVAL;
2202
2203 /* Verify that the area passed by the user is writeable */
Linus Torvalds96d4f262019-01-03 18:57:57 -08002204 if (!access_ok(events, maxevents * sizeof(struct epoll_event)))
Al Viro2903ff02012-08-28 12:52:22 -04002205 return -EFAULT;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002206
2207 /* Get the "struct file *" for the eventpoll file */
Al Viro2903ff02012-08-28 12:52:22 -04002208 f = fdget(epfd);
2209 if (!f.file)
2210 return -EBADF;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002211
2212 /*
2213 * We have to check that the file structure underneath the fd
2214 * the user passed to us _is_ an eventpoll file.
2215 */
2216 error = -EINVAL;
Al Viro2903ff02012-08-28 12:52:22 -04002217 if (!is_file_epoll(f.file))
Davide Libenzi7699acd2007-05-10 22:23:23 -07002218 goto error_fput;
2219
2220 /*
2221 * At this point it is safe to assume that the "private_data" contains
2222 * our own data structure.
2223 */
Al Viro2903ff02012-08-28 12:52:22 -04002224 ep = f.file->private_data;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002225
2226 /* Time to fish for events ... */
Willem de Bruijn7cdf7c22020-12-18 14:05:35 -08002227 error = ep_poll(ep, events, maxevents, to);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002228
2229error_fput:
Al Viro2903ff02012-08-28 12:52:22 -04002230 fdput(f);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002231 return error;
2232}
2233
Dominik Brodowski791eb222018-03-11 11:34:30 +01002234SYSCALL_DEFINE4(epoll_wait, int, epfd, struct epoll_event __user *, events,
2235 int, maxevents, int, timeout)
2236{
Willem de Bruijn7cdf7c22020-12-18 14:05:35 -08002237 struct timespec64 to;
2238
2239 return do_epoll_wait(epfd, events, maxevents,
2240 ep_timeout_to_timespec(&to, timeout));
Dominik Brodowski791eb222018-03-11 11:34:30 +01002241}
2242
Davide Libenzi7699acd2007-05-10 22:23:23 -07002243/*
2244 * Implement the event wait interface for the eventpoll file. It is the kernel
2245 * part of the user space epoll_pwait(2).
2246 */
Willem de Bruijn58169a52020-12-18 14:05:38 -08002247static int do_epoll_pwait(int epfd, struct epoll_event __user *events,
2248 int maxevents, struct timespec64 *to,
2249 const sigset_t __user *sigmask, size_t sigsetsize)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002250{
2251 int error;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002252
2253 /*
2254 * If the caller wants a certain signal mask to be set during the wait,
2255 * we apply it here.
2256 */
Oleg Nesterovb7724342019-07-16 16:29:53 -07002257 error = set_user_sigmask(sigmask, sigsetsize);
Deepa Dinamanided653c2018-09-19 21:41:04 -07002258 if (error)
2259 return error;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002260
Willem de Bruijn58169a52020-12-18 14:05:38 -08002261 error = do_epoll_wait(epfd, events, maxevents, to);
Willem de Bruijn7cdf7c22020-12-18 14:05:35 -08002262
Oleg Nesterovb7724342019-07-16 16:29:53 -07002263 restore_saved_sigmask_unless(error == -EINTR);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002264
2265 return error;
2266}
2267
Willem de Bruijn58169a52020-12-18 14:05:38 -08002268SYSCALL_DEFINE6(epoll_pwait, int, epfd, struct epoll_event __user *, events,
2269 int, maxevents, int, timeout, const sigset_t __user *, sigmask,
2270 size_t, sigsetsize)
Al Viro35280bd2013-02-24 14:52:17 -05002271{
Willem de Bruijn7cdf7c22020-12-18 14:05:35 -08002272 struct timespec64 to;
Willem de Bruijn58169a52020-12-18 14:05:38 -08002273
2274 return do_epoll_pwait(epfd, events, maxevents,
2275 ep_timeout_to_timespec(&to, timeout),
2276 sigmask, sigsetsize);
2277}
2278
2279SYSCALL_DEFINE6(epoll_pwait2, int, epfd, struct epoll_event __user *, events,
2280 int, maxevents, const struct __kernel_timespec __user *, timeout,
2281 const sigset_t __user *, sigmask, size_t, sigsetsize)
2282{
2283 struct timespec64 ts, *to = NULL;
2284
2285 if (timeout) {
2286 if (get_timespec64(&ts, timeout))
2287 return -EFAULT;
2288 to = &ts;
2289 if (poll_select_set_timeout(to, ts.tv_sec, ts.tv_nsec))
2290 return -EINVAL;
2291 }
2292
2293 return do_epoll_pwait(epfd, events, maxevents, to,
2294 sigmask, sigsetsize);
2295}
2296
2297#ifdef CONFIG_COMPAT
2298static int do_compat_epoll_pwait(int epfd, struct epoll_event __user *events,
2299 int maxevents, struct timespec64 *timeout,
2300 const compat_sigset_t __user *sigmask,
2301 compat_size_t sigsetsize)
2302{
Al Viro35280bd2013-02-24 14:52:17 -05002303 long err;
Al Viro35280bd2013-02-24 14:52:17 -05002304
2305 /*
2306 * If the caller wants a certain signal mask to be set during the wait,
2307 * we apply it here.
2308 */
Oleg Nesterovb7724342019-07-16 16:29:53 -07002309 err = set_compat_user_sigmask(sigmask, sigsetsize);
Deepa Dinamanided653c2018-09-19 21:41:04 -07002310 if (err)
2311 return err;
Al Viro35280bd2013-02-24 14:52:17 -05002312
Willem de Bruijn58169a52020-12-18 14:05:38 -08002313 err = do_epoll_wait(epfd, events, maxevents, timeout);
Willem de Bruijn7cdf7c22020-12-18 14:05:35 -08002314
Oleg Nesterovb7724342019-07-16 16:29:53 -07002315 restore_saved_sigmask_unless(err == -EINTR);
Al Viro35280bd2013-02-24 14:52:17 -05002316
2317 return err;
2318}
Willem de Bruijn58169a52020-12-18 14:05:38 -08002319
2320COMPAT_SYSCALL_DEFINE6(epoll_pwait, int, epfd,
2321 struct epoll_event __user *, events,
2322 int, maxevents, int, timeout,
2323 const compat_sigset_t __user *, sigmask,
2324 compat_size_t, sigsetsize)
2325{
2326 struct timespec64 to;
2327
2328 return do_compat_epoll_pwait(epfd, events, maxevents,
2329 ep_timeout_to_timespec(&to, timeout),
2330 sigmask, sigsetsize);
2331}
2332
2333COMPAT_SYSCALL_DEFINE6(epoll_pwait2, int, epfd,
2334 struct epoll_event __user *, events,
2335 int, maxevents,
2336 const struct __kernel_timespec __user *, timeout,
2337 const compat_sigset_t __user *, sigmask,
2338 compat_size_t, sigsetsize)
2339{
2340 struct timespec64 ts, *to = NULL;
2341
2342 if (timeout) {
2343 if (get_timespec64(&ts, timeout))
2344 return -EFAULT;
2345 to = &ts;
2346 if (poll_select_set_timeout(to, ts.tv_sec, ts.tv_nsec))
2347 return -EINVAL;
2348 }
2349
2350 return do_compat_epoll_pwait(epfd, events, maxevents, to,
2351 sigmask, sigsetsize);
2352}
2353
Al Viro35280bd2013-02-24 14:52:17 -05002354#endif
2355
Linus Torvalds1da177e2005-04-16 15:20:36 -07002356static int __init eventpoll_init(void)
2357{
Davide Libenzi7ef99642008-12-01 13:13:55 -08002358 struct sysinfo si;
2359
2360 si_meminfo(&si);
Davide Libenzi9df04e12009-01-29 14:25:26 -08002361 /*
2362 * Allows top 4% of lomem to be allocated for epoll watches (per user).
2363 */
2364 max_user_watches = (((si.totalram - si.totalhigh) / 25) << PAGE_SHIFT) /
Davide Libenzi7ef99642008-12-01 13:13:55 -08002365 EP_ITEM_COST;
Robin Holt52bd19f72011-01-12 17:00:01 -08002366 BUG_ON(max_user_watches < 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002367
Davide Libenzi22bacca2011-02-25 14:44:12 -08002368 /*
Eric Wong39732ca2013-04-30 15:27:38 -07002369 * We can have many thousands of epitems, so prevent this from
2370 * using an extra cache line on 64-bit (and smaller) CPUs
2371 */
2372 BUILD_BUG_ON(sizeof(void *) <= 8 && sizeof(struct epitem) > 128);
2373
Linus Torvalds1da177e2005-04-16 15:20:36 -07002374 /* Allocates slab cache used to allocate "struct epitem" items */
2375 epi_cache = kmem_cache_create("eventpoll_epi", sizeof(struct epitem),
Shakeel Butt2ae928a2017-11-17 15:28:59 -08002376 0, SLAB_HWCACHE_ALIGN|SLAB_PANIC|SLAB_ACCOUNT, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002377
2378 /* Allocates slab cache used to allocate "struct eppoll_entry" */
2379 pwq_cache = kmem_cache_create("eventpoll_pwq",
Shakeel Butt2ae928a2017-11-17 15:28:59 -08002380 sizeof(struct eppoll_entry), 0, SLAB_PANIC|SLAB_ACCOUNT, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002381
Al Viro319c1512020-10-01 20:45:51 -04002382 ephead_cache = kmem_cache_create("ep_head",
2383 sizeof(struct epitems_head), 0, SLAB_PANIC|SLAB_ACCOUNT, NULL);
2384
Linus Torvalds1da177e2005-04-16 15:20:36 -07002385 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002386}
Davide Libenzicea69242007-05-10 22:23:22 -07002387fs_initcall(eventpoll_init);