blob: 73138ea6834252acce735346ff4235ae989525c5 [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);
Roman Penyaeva218cc42019-03-07 16:28:53 -0800660 write_unlock_irq(&ep->lock);
Davide Libenzi5071f972009-03-31 15:24:10 -0700661}
662
Jason Baronae10b2b2013-11-12 15:10:16 -0800663static void epi_rcu_free(struct rcu_head *head)
664{
665 struct epitem *epi = container_of(head, struct epitem, rcu);
666 kmem_cache_free(epi_cache, epi);
667}
668
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669/*
Davide Libenzi7699acd2007-05-10 22:23:23 -0700670 * Removes a "struct epitem" from the eventpoll RB tree and deallocates
Davide Libenzic7ea7632007-05-15 01:40:47 -0700671 * all the associated resources. Must be called with "mtx" held.
Davide Libenzi7699acd2007-05-10 22:23:23 -0700672 */
673static int ep_remove(struct eventpoll *ep, struct epitem *epi)
674{
Davide Libenzi7699acd2007-05-10 22:23:23 -0700675 struct file *file = epi->ffd.file;
Al Viro319c1512020-10-01 20:45:51 -0400676 struct epitems_head *to_free;
677 struct hlist_head *head;
Davide Libenzi7699acd2007-05-10 22:23:23 -0700678
Davidlohr Bueso92e64172018-08-21 21:56:45 -0700679 lockdep_assert_irqs_enabled();
680
Davide Libenzi7699acd2007-05-10 22:23:23 -0700681 /*
Christoph Hellwigee8ef0a2018-08-21 21:56:26 -0700682 * Removes poll wait queue hooks.
Davide Libenzi7699acd2007-05-10 22:23:23 -0700683 */
684 ep_unregister_pollwait(ep, epi);
685
686 /* Remove the current item from the list of epoll hooks */
Jonathan Corbet68499912009-02-06 13:52:43 -0700687 spin_lock(&file->f_lock);
Al Viro319c1512020-10-01 20:45:51 -0400688 to_free = NULL;
689 head = file->f_ep;
690 if (head->first == &epi->fllink && !epi->fllink.next) {
691 file->f_ep = NULL;
692 if (!is_file_epoll(file)) {
693 struct epitems_head *v;
694 v = container_of(head, struct epitems_head, epitems);
695 if (!smp_load_acquire(&v->next))
696 to_free = v;
697 }
698 }
Al Viro44cdc1d2020-09-27 11:18:30 -0400699 hlist_del_rcu(&epi->fllink);
Jonathan Corbet68499912009-02-06 13:52:43 -0700700 spin_unlock(&file->f_lock);
Al Viro319c1512020-10-01 20:45:51 -0400701 free_ephead(to_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700703 rb_erase_cached(&epi->rbn, &ep->rbr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704
Roman Penyaeva218cc42019-03-07 16:28:53 -0800705 write_lock_irq(&ep->lock);
Davidlohr Bueso992991c2018-08-21 21:58:26 -0700706 if (ep_is_linked(epi))
Davide Libenzic7ea7632007-05-15 01:40:47 -0700707 list_del_init(&epi->rdllink);
Roman Penyaeva218cc42019-03-07 16:28:53 -0800708 write_unlock_irq(&ep->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709
Eric Wongeea1d582013-04-30 15:27:39 -0700710 wakeup_source_unregister(ep_wakeup_source(epi));
Jason Baronae10b2b2013-11-12 15:10:16 -0800711 /*
712 * At this point it is safe to free the eventpoll item. Use the union
713 * field epi->rcu, since we are trying to minimize the size of
714 * 'struct epitem'. The 'rbn' field is no longer in use. Protected by
715 * ep->mtx. The rcu read side, reverse_path_check_proc(), does not make
716 * use of the rbn field.
717 */
718 call_rcu(&epi->rcu, epi_rcu_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719
Robin Holt52bd19f72011-01-12 17:00:01 -0800720 atomic_long_dec(&ep->user->epoll_watches);
Davide Libenzi7ef99642008-12-01 13:13:55 -0800721
Davide Libenzic7ea7632007-05-15 01:40:47 -0700722 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723}
724
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725static void ep_free(struct eventpoll *ep)
726{
727 struct rb_node *rbp;
728 struct epitem *epi;
729
730 /* We need to release all tasks waiting for these file */
731 if (waitqueue_active(&ep->poll_wait))
Jason Baronefcdd352020-04-06 20:11:23 -0700732 ep_poll_safewake(ep, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733
734 /*
735 * We need to lock this because we could be hit by
736 * eventpoll_release_file() while we're freeing the "struct eventpoll".
Davide Libenzid47de162007-05-15 01:40:41 -0700737 * We do not need to hold "ep->mtx" here because the epoll file
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 * is on the way to be removed and no one has references to it
739 * anymore. The only hit might come from eventpoll_release_file() but
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300740 * holding "epmutex" is sufficient here.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741 */
Arjan van de Ven144efe32006-03-23 03:00:32 -0800742 mutex_lock(&epmutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743
744 /*
745 * Walks through the whole tree by unregistering poll callbacks.
746 */
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700747 for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748 epi = rb_entry(rbp, struct epitem, rbn);
749
750 ep_unregister_pollwait(ep, epi);
Eric Dumazet91cf5ab2013-09-11 14:24:06 -0700751 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752 }
753
754 /*
Davide Libenzi6192bd52007-05-08 00:25:41 -0700755 * Walks through the whole tree by freeing each "struct epitem". At this
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756 * point we are sure no poll callbacks will be lingering around, and also by
Davide Libenzid47de162007-05-15 01:40:41 -0700757 * holding "epmutex" we can be sure that no file cleanup code will hit
Roman Penyaeva218cc42019-03-07 16:28:53 -0800758 * us during this operation. So we can avoid the lock on "ep->lock".
Eric Wongddf676c2013-04-30 15:27:40 -0700759 * We do not need to lock ep->mtx, either, we only do it to prevent
760 * a lockdep warning.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761 */
Eric Wongddf676c2013-04-30 15:27:40 -0700762 mutex_lock(&ep->mtx);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700763 while ((rbp = rb_first_cached(&ep->rbr)) != NULL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764 epi = rb_entry(rbp, struct epitem, rbn);
765 ep_remove(ep, epi);
Eric Dumazet91cf5ab2013-09-11 14:24:06 -0700766 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767 }
Eric Wongddf676c2013-04-30 15:27:40 -0700768 mutex_unlock(&ep->mtx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769
Arjan van de Ven144efe32006-03-23 03:00:32 -0800770 mutex_unlock(&epmutex);
Davide Libenzid47de162007-05-15 01:40:41 -0700771 mutex_destroy(&ep->mtx);
Davide Libenzi7ef99642008-12-01 13:13:55 -0800772 free_uid(ep->user);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200773 wakeup_source_unregister(ep->ws);
Davide Libenzif0ee9aa2007-05-15 01:40:57 -0700774 kfree(ep);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775}
776
Davide Libenzi7699acd2007-05-10 22:23:23 -0700777static int ep_eventpoll_release(struct inode *inode, struct file *file)
778{
779 struct eventpoll *ep = file->private_data;
780
Davide Libenzif0ee9aa2007-05-15 01:40:57 -0700781 if (ep)
Davide Libenzi7699acd2007-05-10 22:23:23 -0700782 ep_free(ep);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700783
Davide Libenzi7699acd2007-05-10 22:23:23 -0700784 return 0;
785}
786
Al Viro2c0b71c2020-09-26 18:48:57 -0400787static __poll_t ep_item_poll(const struct epitem *epi, poll_table *pt, int depth);
Eric Wong450d89e2013-04-30 15:27:42 -0700788
Al Viroad9366b2020-09-26 18:32:48 -0400789static __poll_t __ep_eventpoll_poll(struct file *file, poll_table *wait, int depth)
Jason Baron37b5e522017-11-17 15:29:06 -0800790{
Al Viroad9366b2020-09-26 18:32:48 -0400791 struct eventpoll *ep = file->private_data;
792 LIST_HEAD(txlist);
Davide Libenzi5071f972009-03-31 15:24:10 -0700793 struct epitem *epi, *tmp;
Hans Verkuil626cf232012-03-23 15:02:27 -0700794 poll_table pt;
Al Viro2c0b71c2020-09-26 18:48:57 -0400795 __poll_t res = 0;
Davide Libenzi5071f972009-03-31 15:24:10 -0700796
Hans Verkuil626cf232012-03-23 15:02:27 -0700797 init_poll_funcptr(&pt, NULL);
Eric Wong450d89e2013-04-30 15:27:42 -0700798
Al Viroad9366b2020-09-26 18:32:48 -0400799 /* Insert inside our poll wait queue */
800 poll_wait(file, &ep->poll_wait, wait);
801
802 /*
803 * Proceed to find out if wanted events are really available inside
804 * the ready list.
805 */
806 mutex_lock_nested(&ep->mtx, depth);
807 ep_start_scan(ep, &txlist);
Al Viro2c0b71c2020-09-26 18:48:57 -0400808 list_for_each_entry_safe(epi, tmp, &txlist, rdllink) {
809 if (ep_item_poll(epi, &pt, depth + 1)) {
810 res = EPOLLIN | EPOLLRDNORM;
811 break;
Jason Baron37b5e522017-11-17 15:29:06 -0800812 } else {
Davide Libenzi5071f972009-03-31 15:24:10 -0700813 /*
814 * Item has been dropped into the ready list by the poll
815 * callback, but it's not actually ready, as far as
816 * caller requested events goes. We can remove it here.
817 */
Eric Wongeea1d582013-04-30 15:27:39 -0700818 __pm_relax(ep_wakeup_source(epi));
Davide Libenzi5071f972009-03-31 15:24:10 -0700819 list_del_init(&epi->rdllink);
Davide Libenzi296e2362009-03-31 15:24:11 -0700820 }
Davide Libenzi5071f972009-03-31 15:24:10 -0700821 }
Al Viroad9366b2020-09-26 18:32:48 -0400822 ep_done_scan(ep, &txlist);
823 mutex_unlock(&ep->mtx);
824 return res;
825}
Davide Libenzi5071f972009-03-31 15:24:10 -0700826
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827/*
828 * Differs from ep_eventpoll_poll() in that internal callers already have
829 * the ep->mtx so we need to start from depth=1, such that mutex_lock_nested()
830 * is correctly annotated.
831 */
832static __poll_t ep_item_poll(const struct epitem *epi, poll_table *pt,
833 int depth)
834{
Al Viroad9366b2020-09-26 18:32:48 -0400835 struct file *file = epi->ffd.file;
Al Viro1ec09972020-08-31 13:16:39 -0400836 __poll_t res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837
838 pt->_key = epi->event.events;
Al Viroad9366b2020-09-26 18:32:48 -0400839 if (!is_file_epoll(file))
840 res = vfs_poll(file, pt);
841 else
842 res = __ep_eventpoll_poll(file, pt, depth);
Al Viro1ec09972020-08-31 13:16:39 -0400843 return res & epi->event.events;
Davide Libenzi5071f972009-03-31 15:24:10 -0700844}
845
Linus Torvaldsa11e1d42018-06-28 09:43:44 -0700846static __poll_t ep_eventpoll_poll(struct file *file, poll_table *wait)
Davide Libenzi7699acd2007-05-10 22:23:23 -0700847{
Al Viroad9366b2020-09-26 18:32:48 -0400848 return __ep_eventpoll_poll(file, wait, 0);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700849}
850
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800851#ifdef CONFIG_PROC_FS
Joe Perchesa3816ab2014-09-29 16:08:25 -0700852static void ep_show_fdinfo(struct seq_file *m, struct file *f)
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800853{
854 struct eventpoll *ep = f->private_data;
855 struct rb_node *rbp;
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800856
857 mutex_lock(&ep->mtx);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700858 for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) {
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800859 struct epitem *epi = rb_entry(rbp, struct epitem, rbn);
Cyrill Gorcunov77493f02017-07-12 14:34:25 -0700860 struct inode *inode = file_inode(epi->ffd.file);
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800861
Cyrill Gorcunov77493f02017-07-12 14:34:25 -0700862 seq_printf(m, "tfd: %8d events: %8x data: %16llx "
863 " pos:%lli ino:%lx sdev:%x\n",
Joe Perchesa3816ab2014-09-29 16:08:25 -0700864 epi->ffd.fd, epi->event.events,
Cyrill Gorcunov77493f02017-07-12 14:34:25 -0700865 (long long)epi->event.data,
866 (long long)epi->ffd.file->f_pos,
867 inode->i_ino, inode->i_sb->s_dev);
Joe Perchesa3816ab2014-09-29 16:08:25 -0700868 if (seq_has_overflowed(m))
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800869 break;
870 }
871 mutex_unlock(&ep->mtx);
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800872}
873#endif
874
Davide Libenzi7699acd2007-05-10 22:23:23 -0700875/* File callbacks that implement the eventpoll file behaviour */
876static const struct file_operations eventpoll_fops = {
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800877#ifdef CONFIG_PROC_FS
878 .show_fdinfo = ep_show_fdinfo,
879#endif
Davide Libenzi7699acd2007-05-10 22:23:23 -0700880 .release = ep_eventpoll_release,
Linus Torvaldsa11e1d42018-06-28 09:43:44 -0700881 .poll = ep_eventpoll_poll,
Arnd Bergmann6038f372010-08-15 18:52:59 +0200882 .llseek = noop_llseek,
Davide Libenzi7699acd2007-05-10 22:23:23 -0700883};
884
Davide Libenzi7699acd2007-05-10 22:23:23 -0700885/*
886 * This is called from eventpoll_release() to unlink files from the eventpoll
887 * interface. We need to have this facility to cleanup correctly files that are
888 * closed without being removed from the eventpoll interface.
889 */
890void eventpoll_release_file(struct file *file)
891{
Davide Libenzi7699acd2007-05-10 22:23:23 -0700892 struct eventpoll *ep;
Al Viro44cdc1d2020-09-27 11:18:30 -0400893 struct epitem *epi;
894 struct hlist_node *next;
Davide Libenzi7699acd2007-05-10 22:23:23 -0700895
896 /*
Jonathan Corbet68499912009-02-06 13:52:43 -0700897 * We don't want to get "file->f_lock" because it is not
Davide Libenzi7699acd2007-05-10 22:23:23 -0700898 * necessary. It is not necessary because we're in the "struct file"
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300899 * cleanup path, and this means that no one is using this file anymore.
Davide Libenzi5071f972009-03-31 15:24:10 -0700900 * So, for example, epoll_ctl() cannot hit here since if we reach this
Davide Libenzi67647d02007-05-15 01:40:52 -0700901 * point, the file counter already went to zero and fget() would fail.
Davide Libenzid47de162007-05-15 01:40:41 -0700902 * The only hit might come from ep_free() but by holding the mutex
Davide Libenzi7699acd2007-05-10 22:23:23 -0700903 * will correctly serialize the operation. We do need to acquire
Davide Libenzid47de162007-05-15 01:40:41 -0700904 * "ep->mtx" after "epmutex" because ep_remove() requires it when called
Davide Libenzi7699acd2007-05-10 22:23:23 -0700905 * from anywhere but ep_free().
Jonathan Corbet68499912009-02-06 13:52:43 -0700906 *
907 * Besides, ep_remove() acquires the lock, so we can't hold it here.
Davide Libenzi7699acd2007-05-10 22:23:23 -0700908 */
909 mutex_lock(&epmutex);
Al Viro319c1512020-10-01 20:45:51 -0400910 if (unlikely(!file->f_ep)) {
911 mutex_unlock(&epmutex);
912 return;
913 }
914 hlist_for_each_entry_safe(epi, next, file->f_ep, fllink) {
Davide Libenzi7699acd2007-05-10 22:23:23 -0700915 ep = epi->ep;
Nelson Elhaged8805e62011-10-31 17:13:14 -0700916 mutex_lock_nested(&ep->mtx, 0);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700917 ep_remove(ep, epi);
Davide Libenzid47de162007-05-15 01:40:41 -0700918 mutex_unlock(&ep->mtx);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700919 }
Davide Libenzi7699acd2007-05-10 22:23:23 -0700920 mutex_unlock(&epmutex);
921}
922
923static int ep_alloc(struct eventpoll **pep)
924{
Davide Libenzi7ef99642008-12-01 13:13:55 -0800925 int error;
926 struct user_struct *user;
927 struct eventpoll *ep;
Davide Libenzi7699acd2007-05-10 22:23:23 -0700928
Davide Libenzi7ef99642008-12-01 13:13:55 -0800929 user = get_current_user();
Davide Libenzi7ef99642008-12-01 13:13:55 -0800930 error = -ENOMEM;
931 ep = kzalloc(sizeof(*ep), GFP_KERNEL);
932 if (unlikely(!ep))
933 goto free_uid;
Davide Libenzi7699acd2007-05-10 22:23:23 -0700934
Davide Libenzid47de162007-05-15 01:40:41 -0700935 mutex_init(&ep->mtx);
Roman Penyaeva218cc42019-03-07 16:28:53 -0800936 rwlock_init(&ep->lock);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700937 init_waitqueue_head(&ep->wq);
938 init_waitqueue_head(&ep->poll_wait);
939 INIT_LIST_HEAD(&ep->rdllist);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700940 ep->rbr = RB_ROOT_CACHED;
Davide Libenzid47de162007-05-15 01:40:41 -0700941 ep->ovflist = EP_UNACTIVE_PTR;
Davide Libenzi7ef99642008-12-01 13:13:55 -0800942 ep->user = user;
Davide Libenzi7699acd2007-05-10 22:23:23 -0700943
944 *pep = ep;
945
Davide Libenzi7699acd2007-05-10 22:23:23 -0700946 return 0;
Davide Libenzi7ef99642008-12-01 13:13:55 -0800947
948free_uid:
949 free_uid(user);
950 return error;
Davide Libenzi7699acd2007-05-10 22:23:23 -0700951}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952
953/*
Davide Libenzic7ea7632007-05-15 01:40:47 -0700954 * Search the file inside the eventpoll tree. The RB tree operations
955 * are protected by the "mtx" mutex, and ep_find() must be called with
956 * "mtx" held.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957 */
958static struct epitem *ep_find(struct eventpoll *ep, struct file *file, int fd)
959{
960 int kcmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700961 struct rb_node *rbp;
962 struct epitem *epi, *epir = NULL;
963 struct epoll_filefd ffd;
964
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700965 ep_set_ffd(&ffd, file, fd);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700966 for (rbp = ep->rbr.rb_root.rb_node; rbp; ) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967 epi = rb_entry(rbp, struct epitem, rbn);
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700968 kcmp = ep_cmp_ffd(&ffd, &epi->ffd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969 if (kcmp > 0)
970 rbp = rbp->rb_right;
971 else if (kcmp < 0)
972 rbp = rbp->rb_left;
973 else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974 epir = epi;
975 break;
976 }
977 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700978
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979 return epir;
980}
981
Chris Wilsonbfe39112021-02-05 22:00:12 +0000982#ifdef CONFIG_KCMP
Cyrill Gorcunov0791e362017-07-12 14:34:28 -0700983static struct epitem *ep_find_tfd(struct eventpoll *ep, int tfd, unsigned long toff)
984{
985 struct rb_node *rbp;
986 struct epitem *epi;
987
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700988 for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) {
Cyrill Gorcunov0791e362017-07-12 14:34:28 -0700989 epi = rb_entry(rbp, struct epitem, rbn);
990 if (epi->ffd.fd == tfd) {
991 if (toff == 0)
992 return epi;
993 else
994 toff--;
995 }
996 cond_resched();
997 }
998
999 return NULL;
1000}
1001
1002struct file *get_epoll_tfile_raw_ptr(struct file *file, int tfd,
1003 unsigned long toff)
1004{
1005 struct file *file_raw;
1006 struct eventpoll *ep;
1007 struct epitem *epi;
1008
1009 if (!is_file_epoll(file))
1010 return ERR_PTR(-EINVAL);
1011
1012 ep = file->private_data;
1013
1014 mutex_lock(&ep->mtx);
1015 epi = ep_find_tfd(ep, tfd, toff);
1016 if (epi)
1017 file_raw = epi->ffd.file;
1018 else
1019 file_raw = ERR_PTR(-ENOENT);
1020 mutex_unlock(&ep->mtx);
1021
1022 return file_raw;
1023}
Chris Wilsonbfe39112021-02-05 22:00:12 +00001024#endif /* CONFIG_KCMP */
Cyrill Gorcunov0791e362017-07-12 14:34:28 -07001025
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001026/*
Roman Penyaeva218cc42019-03-07 16:28:53 -08001027 * Adds a new entry to the tail of the list in a lockless way, i.e.
1028 * multiple CPUs are allowed to call this function concurrently.
1029 *
1030 * Beware: it is necessary to prevent any other modifications of the
1031 * existing list until all changes are completed, in other words
1032 * concurrent list_add_tail_lockless() calls should be protected
1033 * with a read lock, where write lock acts as a barrier which
1034 * makes sure all list_add_tail_lockless() calls are fully
1035 * completed.
1036 *
1037 * Also an element can be locklessly added to the list only in one
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001038 * direction i.e. either to the tail or to the head, otherwise
Roman Penyaeva218cc42019-03-07 16:28:53 -08001039 * concurrent access will corrupt the list.
1040 *
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001041 * Return: %false if element has been already added to the list, %true
Roman Penyaeva218cc42019-03-07 16:28:53 -08001042 * otherwise.
1043 */
1044static inline bool list_add_tail_lockless(struct list_head *new,
1045 struct list_head *head)
1046{
1047 struct list_head *prev;
1048
1049 /*
1050 * This is simple 'new->next = head' operation, but cmpxchg()
1051 * is used in order to detect that same element has been just
1052 * added to the list from another CPU: the winner observes
1053 * new->next == new.
1054 */
1055 if (cmpxchg(&new->next, new, head) != new)
1056 return false;
1057
1058 /*
1059 * Initially ->next of a new element must be updated with the head
1060 * (we are inserting to the tail) and only then pointers are atomically
1061 * exchanged. XCHG guarantees memory ordering, thus ->next should be
1062 * updated before pointers are actually swapped and pointers are
1063 * swapped before prev->next is updated.
1064 */
1065
1066 prev = xchg(&head->prev, new);
1067
1068 /*
1069 * It is safe to modify prev->next and new->prev, because a new element
1070 * is added only to the tail and new->next is updated before XCHG.
1071 */
1072
1073 prev->next = new;
1074 new->prev = prev;
1075
1076 return true;
1077}
1078
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001079/*
Roman Penyaeva218cc42019-03-07 16:28:53 -08001080 * Chains a new epi entry to the tail of the ep->ovflist in a lockless way,
1081 * i.e. multiple CPUs are allowed to call this function concurrently.
1082 *
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001083 * Return: %false if epi element has been already chained, %true otherwise.
Roman Penyaeva218cc42019-03-07 16:28:53 -08001084 */
1085static inline bool chain_epi_lockless(struct epitem *epi)
1086{
1087 struct eventpoll *ep = epi->ep;
1088
Khazhismel Kumykov0c54a6a2020-05-07 18:35:59 -07001089 /* Fast preliminary check */
1090 if (epi->next != EP_UNACTIVE_PTR)
1091 return false;
1092
Roman Penyaeva218cc42019-03-07 16:28:53 -08001093 /* Check that the same epi has not been just chained from another CPU */
1094 if (cmpxchg(&epi->next, EP_UNACTIVE_PTR, NULL) != EP_UNACTIVE_PTR)
1095 return false;
1096
1097 /* Atomically exchange tail */
1098 epi->next = xchg(&ep->ovflist, epi);
1099
1100 return true;
1101}
1102
Linus Torvalds1da177e2005-04-16 15:20:36 -07001103/*
Davide Libenzi7699acd2007-05-10 22:23:23 -07001104 * This is the callback that is passed to the wait queue wakeup
Daniel Balutabf6a41d2011-01-30 23:42:29 +02001105 * mechanism. It is called by the stored file descriptors when they
Davide Libenzi7699acd2007-05-10 22:23:23 -07001106 * have events to report.
Roman Penyaeva218cc42019-03-07 16:28:53 -08001107 *
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001108 * This callback takes a read lock in order not to contend with concurrent
1109 * events from another file descriptor, thus all modifications to ->rdllist
Roman Penyaeva218cc42019-03-07 16:28:53 -08001110 * or ->ovflist are lockless. Read lock is paired with the write lock from
1111 * ep_scan_ready_list(), which stops all list modifications and guarantees
1112 * that lists state is seen correctly.
1113 *
1114 * Another thing worth to mention is that ep_poll_callback() can be called
1115 * concurrently for the same @epi from different CPUs if poll table was inited
1116 * with several wait queues entries. Plural wakeup from different CPUs of a
1117 * single wait queue is serialized by wq.lock, but the case when multiple wait
1118 * queues are used should be detected accordingly. This is detected using
1119 * cmpxchg() operation.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001120 */
Ingo Molnarac6424b2017-06-20 12:06:13 +02001121static int ep_poll_callback(wait_queue_entry_t *wait, unsigned mode, int sync, void *key)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001122{
Davide Libenzi7699acd2007-05-10 22:23:23 -07001123 int pwake = 0;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001124 struct epitem *epi = ep_item_from_wait(wait);
1125 struct eventpoll *ep = epi->ep;
Al Viro3ad6f932017-07-03 20:14:56 -04001126 __poll_t pollflags = key_to_poll(key);
Roman Penyaeva218cc42019-03-07 16:28:53 -08001127 unsigned long flags;
Jason Barondf0108c2016-01-20 14:59:24 -08001128 int ewake = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001129
Roman Penyaeva218cc42019-03-07 16:28:53 -08001130 read_lock_irqsave(&ep->lock, flags);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001131
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -07001132 ep_set_busy_poll_napi_id(epi);
1133
Davide Libenzi7699acd2007-05-10 22:23:23 -07001134 /*
1135 * If the event mask does not contain any poll(2) event, we consider the
1136 * descriptor to be disabled. This condition is likely the effect of the
1137 * EPOLLONESHOT bit that disables the descriptor when an event is received,
1138 * until the next EPOLL_CTL_MOD will be issued.
1139 */
1140 if (!(epi->event.events & ~EP_PRIVATE_BITS))
Davide Libenzid47de162007-05-15 01:40:41 -07001141 goto out_unlock;
1142
1143 /*
Davide Libenzi2dfa4ee2009-03-31 15:24:22 -07001144 * Check the events coming with the callback. At this stage, not
1145 * every device reports the events in the "key" parameter of the
1146 * callback. We need to be able to handle both cases here, hence the
1147 * test for "key" != NULL before the event match test.
1148 */
Al Viro3ad6f932017-07-03 20:14:56 -04001149 if (pollflags && !(pollflags & epi->event.events))
Davide Libenzi2dfa4ee2009-03-31 15:24:22 -07001150 goto out_unlock;
1151
1152 /*
Daniel Balutabf6a41d2011-01-30 23:42:29 +02001153 * If we are transferring events to userspace, we can hold no locks
Davide Libenzid47de162007-05-15 01:40:41 -07001154 * (because we're accessing user memory, and because of linux f_op->poll()
Daniel Balutabf6a41d2011-01-30 23:42:29 +02001155 * semantics). All the events that happen during that period of time are
Davide Libenzid47de162007-05-15 01:40:41 -07001156 * chained in ep->ovflist and requeued later on.
1157 */
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001158 if (READ_ONCE(ep->ovflist) != EP_UNACTIVE_PTR) {
Khazhismel Kumykov0c54a6a2020-05-07 18:35:59 -07001159 if (chain_epi_lockless(epi))
Roman Penyaevc3e320b2019-03-07 16:28:49 -08001160 ep_pm_stay_awake_rcu(epi);
Khazhismel Kumykov0c54a6a2020-05-07 18:35:59 -07001161 } else if (!ep_is_linked(epi)) {
1162 /* In the usual case, add event to ready list. */
1163 if (list_add_tail_lockless(&epi->rdllink, &ep->rdllist))
1164 ep_pm_stay_awake_rcu(epi);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001165 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07001166
Davide Libenzi7699acd2007-05-10 22:23:23 -07001167 /*
1168 * Wake up ( if active ) both the eventpoll wait list and the ->poll()
1169 * wait list.
1170 */
Jason Barondf0108c2016-01-20 14:59:24 -08001171 if (waitqueue_active(&ep->wq)) {
Jason Baronb6a515c2016-02-05 15:37:04 -08001172 if ((epi->event.events & EPOLLEXCLUSIVE) &&
Al Viro3ad6f932017-07-03 20:14:56 -04001173 !(pollflags & POLLFREE)) {
1174 switch (pollflags & EPOLLINOUT_BITS) {
Linus Torvaldsa9a08842018-02-11 14:34:03 -08001175 case EPOLLIN:
1176 if (epi->event.events & EPOLLIN)
Jason Baronb6a515c2016-02-05 15:37:04 -08001177 ewake = 1;
1178 break;
Linus Torvaldsa9a08842018-02-11 14:34:03 -08001179 case EPOLLOUT:
1180 if (epi->event.events & EPOLLOUT)
Jason Baronb6a515c2016-02-05 15:37:04 -08001181 ewake = 1;
1182 break;
1183 case 0:
1184 ewake = 1;
1185 break;
1186 }
1187 }
Roman Penyaeva218cc42019-03-07 16:28:53 -08001188 wake_up(&ep->wq);
Jason Barondf0108c2016-01-20 14:59:24 -08001189 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07001190 if (waitqueue_active(&ep->poll_wait))
1191 pwake++;
1192
Davide Libenzid47de162007-05-15 01:40:41 -07001193out_unlock:
Roman Penyaeva218cc42019-03-07 16:28:53 -08001194 read_unlock_irqrestore(&ep->lock, flags);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001195
1196 /* We have to call this outside the lock */
1197 if (pwake)
Jason Baronefcdd352020-04-06 20:11:23 -07001198 ep_poll_safewake(ep, epi);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001199
Oleg Nesterov138e4ad2017-09-01 18:55:33 +02001200 if (!(epi->event.events & EPOLLEXCLUSIVE))
1201 ewake = 1;
Jason Barondf0108c2016-01-20 14:59:24 -08001202
Al Viro3ad6f932017-07-03 20:14:56 -04001203 if (pollflags & POLLFREE) {
Oleg Nesterov138e4ad2017-09-01 18:55:33 +02001204 /*
1205 * If we race with ep_remove_wait_queue() it can miss
1206 * ->whead = NULL and do another remove_wait_queue() after
1207 * us, so we can't use __remove_wait_queue().
1208 */
1209 list_del_init(&wait->entry);
1210 /*
1211 * ->whead != NULL protects us from the race with ep_free()
1212 * or ep_remove(), ep_remove_wait_queue() takes whead->lock
1213 * held by the caller. Once we nullify it, nothing protects
1214 * ep/epi or even wait.
1215 */
1216 smp_store_release(&ep_pwq_from_wait(wait)->whead, NULL);
1217 }
1218
1219 return ewake;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220}
1221
Linus Torvalds1da177e2005-04-16 15:20:36 -07001222/*
1223 * This is the callback that is used to add our wait queue to the
1224 * target file wakeup lists.
1225 */
1226static void ep_ptable_queue_proc(struct file *file, wait_queue_head_t *whead,
1227 poll_table *pt)
1228{
Al Viro364f3742020-09-02 11:55:09 -04001229 struct ep_pqueue *epq = container_of(pt, struct ep_pqueue, pt);
1230 struct epitem *epi = epq->epi;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001231 struct eppoll_entry *pwq;
1232
Al Viro364f3742020-09-02 11:55:09 -04001233 if (unlikely(!epi)) // an earlier allocation has failed
1234 return;
1235
1236 pwq = kmem_cache_alloc(pwq_cache, GFP_KERNEL);
1237 if (unlikely(!pwq)) {
1238 epq->epi = NULL;
1239 return;
Davide Libenzi296e2362009-03-31 15:24:11 -07001240 }
Al Viro364f3742020-09-02 11:55:09 -04001241
1242 init_waitqueue_func_entry(&pwq->wait, ep_poll_callback);
1243 pwq->whead = whead;
1244 pwq->base = epi;
1245 if (epi->event.events & EPOLLEXCLUSIVE)
1246 add_wait_queue_exclusive(whead, &pwq->wait);
1247 else
1248 add_wait_queue(whead, &pwq->wait);
1249 pwq->next = epi->pwqlist;
1250 epi->pwqlist = pwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001251}
1252
Linus Torvalds1da177e2005-04-16 15:20:36 -07001253static void ep_rbtree_insert(struct eventpoll *ep, struct epitem *epi)
1254{
1255 int kcmp;
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001256 struct rb_node **p = &ep->rbr.rb_root.rb_node, *parent = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257 struct epitem *epic;
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001258 bool leftmost = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001259
1260 while (*p) {
1261 parent = *p;
1262 epic = rb_entry(parent, struct epitem, rbn);
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001263 kcmp = ep_cmp_ffd(&epi->ffd, &epic->ffd);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001264 if (kcmp > 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265 p = &parent->rb_right;
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001266 leftmost = false;
1267 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -07001268 p = &parent->rb_left;
1269 }
1270 rb_link_node(&epi->rbn, parent, p);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001271 rb_insert_color_cached(&epi->rbn, &ep->rbr, leftmost);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272}
1273
Andrew Mortona80a6b82012-11-08 15:53:35 -08001274
1275
Jason Baron28d82dc2012-01-12 17:17:43 -08001276#define PATH_ARR_SIZE 5
1277/*
1278 * These are the number paths of length 1 to 5, that we are allowing to emanate
1279 * from a single file of interest. For example, we allow 1000 paths of length
1280 * 1, to emanate from each file of interest. This essentially represents the
1281 * potential wakeup paths, which need to be limited in order to avoid massive
1282 * uncontrolled wakeup storms. The common use case should be a single ep which
1283 * is connected to n file sources. In this case each file source has 1 path
1284 * of length 1. Thus, the numbers below should be more than sufficient. These
1285 * path limits are enforced during an EPOLL_CTL_ADD operation, since a modify
1286 * and delete can't add additional paths. Protected by the epmutex.
1287 */
1288static const int path_limits[PATH_ARR_SIZE] = { 1000, 500, 100, 50, 10 };
1289static int path_count[PATH_ARR_SIZE];
1290
1291static int path_count_inc(int nests)
1292{
Jason Baron93dc6102012-03-16 16:34:03 -04001293 /* Allow an arbitrary number of depth 1 paths */
1294 if (nests == 0)
1295 return 0;
1296
Jason Baron28d82dc2012-01-12 17:17:43 -08001297 if (++path_count[nests] > path_limits[nests])
1298 return -1;
1299 return 0;
1300}
1301
1302static void path_count_init(void)
1303{
1304 int i;
1305
1306 for (i = 0; i < PATH_ARR_SIZE; i++)
1307 path_count[i] = 0;
1308}
1309
Al Viro319c1512020-10-01 20:45:51 -04001310static int reverse_path_check_proc(struct hlist_head *refs, int depth)
Jason Baron28d82dc2012-01-12 17:17:43 -08001311{
1312 int error = 0;
Jason Baron28d82dc2012-01-12 17:17:43 -08001313 struct epitem *epi;
1314
Al Viro0c320f72020-09-25 19:48:56 -04001315 if (depth > EP_MAX_NESTS) /* too deep nesting */
Al Viro99d84d42020-08-22 23:08:37 -04001316 return -1;
1317
Jason Baronae10b2b2013-11-12 15:10:16 -08001318 /* CTL_DEL can remove links here, but that can't increase our count */
Al Viro319c1512020-10-01 20:45:51 -04001319 hlist_for_each_entry_rcu(epi, refs, fllink) {
1320 struct hlist_head *refs = &epi->ep->refs;
1321 if (hlist_empty(refs))
Al Virod16312a2020-09-26 15:54:05 -04001322 error = path_count_inc(depth);
1323 else
Al Viro319c1512020-10-01 20:45:51 -04001324 error = reverse_path_check_proc(refs, depth + 1);
Al Virod16312a2020-09-26 15:54:05 -04001325 if (error != 0)
1326 break;
Jason Baron28d82dc2012-01-12 17:17:43 -08001327 }
1328 return error;
1329}
1330
1331/**
Al Viro319c1512020-10-01 20:45:51 -04001332 * reverse_path_check - The tfile_check_list is list of epitem_head, which have
Jason Baron28d82dc2012-01-12 17:17:43 -08001333 * links that are proposed to be newly added. We need to
1334 * make sure that those added links don't add too many
1335 * paths such that we will spend all our time waking up
1336 * eventpoll objects.
1337 *
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001338 * Return: %zero if the proposed links don't create too many paths,
1339 * %-1 otherwise.
Jason Baron28d82dc2012-01-12 17:17:43 -08001340 */
1341static int reverse_path_check(void)
1342{
Al Viro319c1512020-10-01 20:45:51 -04001343 struct epitems_head *p;
Jason Baron28d82dc2012-01-12 17:17:43 -08001344
Al Viro319c1512020-10-01 20:45:51 -04001345 for (p = tfile_check_list; p != EP_UNACTIVE_PTR; p = p->next) {
1346 int error;
Jason Baron28d82dc2012-01-12 17:17:43 -08001347 path_count_init();
Al Virob62d2702020-10-01 14:11:00 -04001348 rcu_read_lock();
Al Viro319c1512020-10-01 20:45:51 -04001349 error = reverse_path_check_proc(&p->epitems, 0);
Al Virob62d2702020-10-01 14:11:00 -04001350 rcu_read_unlock();
Jason Baron28d82dc2012-01-12 17:17:43 -08001351 if (error)
Al Viro319c1512020-10-01 20:45:51 -04001352 return error;
Jason Baron28d82dc2012-01-12 17:17:43 -08001353 }
Al Viro319c1512020-10-01 20:45:51 -04001354 return 0;
Jason Baron28d82dc2012-01-12 17:17:43 -08001355}
1356
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001357static int ep_create_wakeup_source(struct epitem *epi)
1358{
Al Viro3701cb52020-09-24 19:41:58 -04001359 struct name_snapshot n;
Eric Wongeea1d582013-04-30 15:27:39 -07001360 struct wakeup_source *ws;
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001361
1362 if (!epi->ep->ws) {
Tri Voc8377ad2019-08-06 18:48:46 -07001363 epi->ep->ws = wakeup_source_register(NULL, "eventpoll");
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001364 if (!epi->ep->ws)
1365 return -ENOMEM;
1366 }
1367
Al Viro3701cb52020-09-24 19:41:58 -04001368 take_dentry_name_snapshot(&n, epi->ffd.file->f_path.dentry);
1369 ws = wakeup_source_register(NULL, n.name.name);
1370 release_dentry_name_snapshot(&n);
Eric Wongeea1d582013-04-30 15:27:39 -07001371
1372 if (!ws)
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001373 return -ENOMEM;
Eric Wongeea1d582013-04-30 15:27:39 -07001374 rcu_assign_pointer(epi->ws, ws);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001375
1376 return 0;
1377}
1378
Eric Wongeea1d582013-04-30 15:27:39 -07001379/* rare code path, only used when EPOLL_CTL_MOD removes a wakeup source */
1380static noinline void ep_destroy_wakeup_source(struct epitem *epi)
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001381{
Eric Wongeea1d582013-04-30 15:27:39 -07001382 struct wakeup_source *ws = ep_wakeup_source(epi);
1383
Eric Wongd6d67e72013-04-30 15:27:43 -07001384 RCU_INIT_POINTER(epi->ws, NULL);
Eric Wongeea1d582013-04-30 15:27:39 -07001385
1386 /*
1387 * wait for ep_pm_stay_awake_rcu to finish, synchronize_rcu is
1388 * used internally by wakeup_source_remove, too (called by
1389 * wakeup_source_unregister), so we cannot use call_rcu
1390 */
1391 synchronize_rcu();
1392 wakeup_source_unregister(ws);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001393}
1394
Al Viro319c1512020-10-01 20:45:51 -04001395static int attach_epitem(struct file *file, struct epitem *epi)
1396{
1397 struct epitems_head *to_free = NULL;
1398 struct hlist_head *head = NULL;
1399 struct eventpoll *ep = NULL;
1400
1401 if (is_file_epoll(file))
1402 ep = file->private_data;
1403
1404 if (ep) {
1405 head = &ep->refs;
1406 } else if (!READ_ONCE(file->f_ep)) {
1407allocate:
1408 to_free = kmem_cache_zalloc(ephead_cache, GFP_KERNEL);
1409 if (!to_free)
1410 return -ENOMEM;
1411 head = &to_free->epitems;
1412 }
1413 spin_lock(&file->f_lock);
1414 if (!file->f_ep) {
1415 if (unlikely(!head)) {
1416 spin_unlock(&file->f_lock);
1417 goto allocate;
1418 }
1419 file->f_ep = head;
1420 to_free = NULL;
1421 }
1422 hlist_add_head_rcu(&epi->fllink, file->f_ep);
1423 spin_unlock(&file->f_lock);
1424 free_ephead(to_free);
1425 return 0;
1426}
1427
Davide Libenzic7ea7632007-05-15 01:40:47 -07001428/*
1429 * Must be called with "mtx" held.
1430 */
Al Virobec1a5022017-11-28 19:43:33 -05001431static int ep_insert(struct eventpoll *ep, const struct epoll_event *event,
Jason Baron67347fe2013-11-12 15:10:18 -08001432 struct file *tfile, int fd, int full_check)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001433{
Al Virod85e2aa2018-02-01 15:24:58 -05001434 int error, pwake = 0;
1435 __poll_t revents;
Robin Holt52bd19f72011-01-12 17:00:01 -08001436 long user_watches;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001437 struct epitem *epi;
1438 struct ep_pqueue epq;
Al Viro85353e92020-09-26 18:15:26 -04001439 struct eventpoll *tep = NULL;
1440
1441 if (is_file_epoll(tfile))
1442 tep = tfile->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001443
Davidlohr Bueso92e64172018-08-21 21:56:45 -07001444 lockdep_assert_irqs_enabled();
1445
Robin Holt52bd19f72011-01-12 17:00:01 -08001446 user_watches = atomic_long_read(&ep->user->epoll_watches);
1447 if (unlikely(user_watches >= max_user_watches))
Davide Libenzi7ef99642008-12-01 13:13:55 -08001448 return -ENOSPC;
Al Virod1ec50a2020-09-27 11:03:32 -04001449 if (!(epi = kmem_cache_zalloc(epi_cache, GFP_KERNEL)))
Davide Libenzi7ef99642008-12-01 13:13:55 -08001450 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451
1452 /* Item initialization follow here ... */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001453 INIT_LIST_HEAD(&epi->rdllink);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001454 epi->ep = ep;
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001455 ep_set_ffd(&epi->ffd, tfile, fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001456 epi->event = *event;
Davide Libenzid47de162007-05-15 01:40:41 -07001457 epi->next = EP_UNACTIVE_PTR;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001458
Al Viro85353e92020-09-26 18:15:26 -04001459 if (tep)
1460 mutex_lock_nested(&tep->mtx, 1);
Al Virof8d4f442020-09-09 22:25:06 -04001461 /* Add the current item to the list of active epoll hook for this file */
Al Viro319c1512020-10-01 20:45:51 -04001462 if (unlikely(attach_epitem(tfile, epi) < 0)) {
1463 kmem_cache_free(epi_cache, epi);
1464 if (tep)
1465 mutex_unlock(&tep->mtx);
1466 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467 }
1468
Al Viro319c1512020-10-01 20:45:51 -04001469 if (full_check && !tep)
1470 list_file(tfile);
1471
1472 atomic_long_inc(&ep->user->epoll_watches);
Al Virof8d4f442020-09-09 22:25:06 -04001473
1474 /*
1475 * Add the current item to the RB tree. All RB tree operations are
1476 * protected by "mtx", and ep_insert() is called with "mtx" held.
1477 */
1478 ep_rbtree_insert(ep, epi);
Al Viro85353e92020-09-26 18:15:26 -04001479 if (tep)
1480 mutex_unlock(&tep->mtx);
Al Virof8d4f442020-09-09 22:25:06 -04001481
1482 /* now check if we've created too many backpaths */
Al Viroe3e096e2020-09-26 18:09:29 -04001483 if (unlikely(full_check && reverse_path_check())) {
1484 ep_remove(ep, epi);
1485 return -EINVAL;
1486 }
Al Virof8d4f442020-09-09 22:25:06 -04001487
Al Virod1ec50a2020-09-27 11:03:32 -04001488 if (epi->event.events & EPOLLWAKEUP) {
1489 error = ep_create_wakeup_source(epi);
1490 if (error) {
1491 ep_remove(ep, epi);
1492 return error;
1493 }
1494 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001495
1496 /* Initialize the poll table using the queue callback */
1497 epq.epi = epi;
1498 init_poll_funcptr(&epq.pt, ep_ptable_queue_proc);
1499
1500 /*
1501 * Attach the item to the poll hooks and get current event bits.
1502 * We can safely use the file* here because its usage count has
Davide Libenzic7ea7632007-05-15 01:40:47 -07001503 * been increased by the caller of this function. Note that after
1504 * this operation completes, the poll callback can start hitting
1505 * the new item.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001506 */
Jason Baron37b5e522017-11-17 15:29:06 -08001507 revents = ep_item_poll(epi, &epq.pt, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001508
1509 /*
1510 * We have to check if something went wrong during the poll wait queue
1511 * install process. Namely an allocation for a wait queue failed due
1512 * high memory pressure.
1513 */
Al Viroe3e096e2020-09-26 18:09:29 -04001514 if (unlikely(!epq.epi)) {
1515 ep_remove(ep, epi);
1516 return -ENOMEM;
1517 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001518
Davide Libenzic7ea7632007-05-15 01:40:47 -07001519 /* We have to drop the new item inside our item list to keep track of it */
Roman Penyaeva218cc42019-03-07 16:28:53 -08001520 write_lock_irq(&ep->lock);
Davide Libenzic7ea7632007-05-15 01:40:47 -07001521
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -07001522 /* record NAPI ID of new item if present */
1523 ep_set_busy_poll_napi_id(epi);
1524
Linus Torvalds1da177e2005-04-16 15:20:36 -07001525 /* If the file is already "ready" we drop it inside the ready list */
Davidlohr Bueso992991c2018-08-21 21:58:26 -07001526 if (revents && !ep_is_linked(epi)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001527 list_add_tail(&epi->rdllink, &ep->rdllist);
Eric Wongeea1d582013-04-30 15:27:39 -07001528 ep_pm_stay_awake(epi);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001529
1530 /* Notify waiting tasks that events are available */
1531 if (waitqueue_active(&ep->wq))
Roman Penyaeva218cc42019-03-07 16:28:53 -08001532 wake_up(&ep->wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001533 if (waitqueue_active(&ep->poll_wait))
1534 pwake++;
1535 }
1536
Roman Penyaeva218cc42019-03-07 16:28:53 -08001537 write_unlock_irq(&ep->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001538
1539 /* We have to call this outside the lock */
1540 if (pwake)
Jason Baronefcdd352020-04-06 20:11:23 -07001541 ep_poll_safewake(ep, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001542
Linus Torvalds1da177e2005-04-16 15:20:36 -07001543 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001544}
1545
Linus Torvalds1da177e2005-04-16 15:20:36 -07001546/*
1547 * Modify the interest event mask by dropping an event if the new mask
Davide Libenzic7ea7632007-05-15 01:40:47 -07001548 * has a match in the current file status. Must be called with "mtx" held.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001549 */
Al Virobec1a5022017-11-28 19:43:33 -05001550static int ep_modify(struct eventpoll *ep, struct epitem *epi,
1551 const struct epoll_event *event)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001552{
1553 int pwake = 0;
Hans Verkuil626cf232012-03-23 15:02:27 -07001554 poll_table pt;
1555
Davidlohr Bueso92e64172018-08-21 21:56:45 -07001556 lockdep_assert_irqs_enabled();
1557
Hans Verkuil626cf232012-03-23 15:02:27 -07001558 init_poll_funcptr(&pt, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559
1560 /*
Tony Battersbye057e152009-03-31 15:24:15 -07001561 * Set the new event interest mask before calling f_op->poll();
1562 * otherwise we might miss an event that happens between the
1563 * f_op->poll() call and the new event set registering.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001564 */
Eric Wong128dd172013-01-01 21:20:27 +00001565 epi->event.events = event->events; /* need barrier below */
Tony Battersbye057e152009-03-31 15:24:15 -07001566 epi->event.data = event->data; /* protected by mtx */
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001567 if (epi->event.events & EPOLLWAKEUP) {
Eric Wongeea1d582013-04-30 15:27:39 -07001568 if (!ep_has_wakeup_source(epi))
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001569 ep_create_wakeup_source(epi);
Eric Wongeea1d582013-04-30 15:27:39 -07001570 } else if (ep_has_wakeup_source(epi)) {
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001571 ep_destroy_wakeup_source(epi);
1572 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573
1574 /*
Eric Wong128dd172013-01-01 21:20:27 +00001575 * The following barrier has two effects:
1576 *
1577 * 1) Flush epi changes above to other CPUs. This ensures
1578 * we do not miss events from ep_poll_callback if an
1579 * event occurs immediately after we call f_op->poll().
Roman Penyaeva218cc42019-03-07 16:28:53 -08001580 * We need this because we did not take ep->lock while
Eric Wong128dd172013-01-01 21:20:27 +00001581 * changing epi above (but ep_poll_callback does take
Roman Penyaeva218cc42019-03-07 16:28:53 -08001582 * ep->lock).
Eric Wong128dd172013-01-01 21:20:27 +00001583 *
1584 * 2) We also need to ensure we do not miss _past_ events
1585 * when calling f_op->poll(). This barrier also
1586 * pairs with the barrier in wq_has_sleeper (see
1587 * comments for wq_has_sleeper).
1588 *
1589 * This barrier will now guarantee ep_poll_callback or f_op->poll
1590 * (or both) will notice the readiness of an item.
1591 */
1592 smp_mb();
1593
1594 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001595 * Get current event bits. We can safely use the file* here because
1596 * its usage count has been increased by the caller of this function.
Davide Libenzic7ea7632007-05-15 01:40:47 -07001597 * If the item is "hot" and it is not registered inside the ready
Davide Libenzi67647d02007-05-15 01:40:52 -07001598 * list, push it inside.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599 */
Al Viro69112732017-11-28 19:56:15 -05001600 if (ep_item_poll(epi, &pt, 1)) {
Roman Penyaeva218cc42019-03-07 16:28:53 -08001601 write_lock_irq(&ep->lock);
Davidlohr Bueso992991c2018-08-21 21:58:26 -07001602 if (!ep_is_linked(epi)) {
Davide Libenzic7ea7632007-05-15 01:40:47 -07001603 list_add_tail(&epi->rdllink, &ep->rdllist);
Eric Wongeea1d582013-04-30 15:27:39 -07001604 ep_pm_stay_awake(epi);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001605
Davide Libenzic7ea7632007-05-15 01:40:47 -07001606 /* Notify waiting tasks that events are available */
1607 if (waitqueue_active(&ep->wq))
Roman Penyaeva218cc42019-03-07 16:28:53 -08001608 wake_up(&ep->wq);
Davide Libenzic7ea7632007-05-15 01:40:47 -07001609 if (waitqueue_active(&ep->poll_wait))
1610 pwake++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001611 }
Roman Penyaeva218cc42019-03-07 16:28:53 -08001612 write_unlock_irq(&ep->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001613 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001614
1615 /* We have to call this outside the lock */
1616 if (pwake)
Jason Baronefcdd352020-04-06 20:11:23 -07001617 ep_poll_safewake(ep, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618
1619 return 0;
1620}
1621
Al Viroff079522020-08-31 13:39:52 -04001622static int ep_send_events(struct eventpoll *ep,
1623 struct epoll_event __user *events, int maxevents)
Davide Libenzi5071f972009-03-31 15:24:10 -07001624{
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001625 struct epitem *epi, *tmp;
Al Viroff079522020-08-31 13:39:52 -04001626 LIST_HEAD(txlist);
Hans Verkuil626cf232012-03-23 15:02:27 -07001627 poll_table pt;
Al Viroff079522020-08-31 13:39:52 -04001628 int res = 0;
Hans Verkuil626cf232012-03-23 15:02:27 -07001629
Soheil Hassas Yeganehcccd29b2020-12-18 14:01:51 -08001630 /*
1631 * Always short-circuit for fatal signals to allow threads to make a
1632 * timely exit without the chance of finding more events available and
1633 * fetching repeatedly.
1634 */
1635 if (fatal_signal_pending(current))
1636 return -EINTR;
1637
Hans Verkuil626cf232012-03-23 15:02:27 -07001638 init_poll_funcptr(&pt, NULL);
Al Viroff079522020-08-31 13:39:52 -04001639
Al Viro57804b12020-08-31 13:41:30 -04001640 mutex_lock(&ep->mtx);
1641 ep_start_scan(ep, &txlist);
Davide Libenzi5071f972009-03-31 15:24:10 -07001642
Davide Libenzi296e2362009-03-31 15:24:11 -07001643 /*
Davide Libenzi5071f972009-03-31 15:24:10 -07001644 * We can loop without lock because we are passed a task private list.
Al Viro57804b12020-08-31 13:41:30 -04001645 * Items cannot vanish during the loop we are holding ep->mtx.
Davide Libenzi296e2362009-03-31 15:24:11 -07001646 */
Al Viroff079522020-08-31 13:39:52 -04001647 list_for_each_entry_safe(epi, tmp, &txlist, rdllink) {
1648 struct wakeup_source *ws;
1649 __poll_t revents;
Davidlohr Bueso21877e12019-01-03 15:27:12 -08001650
Al Viroff079522020-08-31 13:39:52 -04001651 if (res >= maxevents)
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001652 break;
Davide Libenzi5071f972009-03-31 15:24:10 -07001653
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001654 /*
1655 * Activate ep->ws before deactivating epi->ws to prevent
1656 * triggering auto-suspend here (in case we reactive epi->ws
1657 * below).
1658 *
1659 * This could be rearranged to delay the deactivation of epi->ws
1660 * instead, but then epi->ws would temporarily be out of sync
1661 * with ep_is_linked().
1662 */
Eric Wongeea1d582013-04-30 15:27:39 -07001663 ws = ep_wakeup_source(epi);
1664 if (ws) {
1665 if (ws->active)
1666 __pm_stay_awake(ep->ws);
1667 __pm_relax(ws);
1668 }
1669
Davide Libenzi5071f972009-03-31 15:24:10 -07001670 list_del_init(&epi->rdllink);
1671
Davide Libenzi296e2362009-03-31 15:24:11 -07001672 /*
Davide Libenzi5071f972009-03-31 15:24:10 -07001673 * If the event mask intersect the caller-requested one,
Al Viro57804b12020-08-31 13:41:30 -04001674 * deliver the event to userspace. Again, we are holding ep->mtx,
1675 * so no operations coming from userspace can change the item.
Davide Libenzi296e2362009-03-31 15:24:11 -07001676 */
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001677 revents = ep_item_poll(epi, &pt, 1);
1678 if (!revents)
1679 continue;
1680
Al Viroff079522020-08-31 13:39:52 -04001681 if (__put_user(revents, &events->events) ||
1682 __put_user(epi->event.data, &events->data)) {
1683 list_add(&epi->rdllink, &txlist);
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001684 ep_pm_stay_awake(epi);
Al Viroff079522020-08-31 13:39:52 -04001685 if (!res)
1686 res = -EFAULT;
1687 break;
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001688 }
Al Viroff079522020-08-31 13:39:52 -04001689 res++;
1690 events++;
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001691 if (epi->event.events & EPOLLONESHOT)
1692 epi->event.events &= EP_PRIVATE_BITS;
1693 else if (!(epi->event.events & EPOLLET)) {
1694 /*
1695 * If this file has been added with Level
1696 * Trigger mode, we need to insert back inside
1697 * the ready list, so that the next call to
1698 * epoll_wait() will check again the events
1699 * availability. At this point, no one can insert
1700 * into ep->rdllist besides us. The epoll_ctl()
1701 * callers are locked out by
1702 * ep_scan_ready_list() holding "mtx" and the
1703 * poll callback will queue them in ep->ovflist.
1704 */
1705 list_add_tail(&epi->rdllink, &ep->rdllist);
1706 ep_pm_stay_awake(epi);
Davide Libenzi296e2362009-03-31 15:24:11 -07001707 }
1708 }
Al Viro57804b12020-08-31 13:41:30 -04001709 ep_done_scan(ep, &txlist);
1710 mutex_unlock(&ep->mtx);
Davide Libenzi5071f972009-03-31 15:24:10 -07001711
Al Viroff079522020-08-31 13:39:52 -04001712 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001713}
1714
Willem de Bruijn7cdf7c22020-12-18 14:05:35 -08001715static struct timespec64 *ep_timeout_to_timespec(struct timespec64 *to, long ms)
Eric Dumazet0781b902011-02-01 15:52:35 -08001716{
Willem de Bruijn7cdf7c22020-12-18 14:05:35 -08001717 struct timespec64 now;
1718
1719 if (ms < 0)
1720 return NULL;
1721
1722 if (!ms) {
1723 to->tv_sec = 0;
1724 to->tv_nsec = 0;
1725 return to;
1726 }
1727
1728 to->tv_sec = ms / MSEC_PER_SEC;
1729 to->tv_nsec = NSEC_PER_MSEC * (ms % MSEC_PER_SEC);
Eric Dumazet0781b902011-02-01 15:52:35 -08001730
Deepa Dinamani766b9f92016-05-19 17:09:05 -07001731 ktime_get_ts64(&now);
Willem de Bruijn7cdf7c22020-12-18 14:05:35 -08001732 *to = timespec64_add_safe(now, *to);
1733 return to;
Eric Dumazet0781b902011-02-01 15:52:35 -08001734}
1735
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001736/**
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001737 * ep_poll - Retrieves ready events, and delivers them to the caller-supplied
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001738 * event buffer.
1739 *
1740 * @ep: Pointer to the eventpoll context.
1741 * @events: Pointer to the userspace buffer where the ready events should be
1742 * stored.
1743 * @maxevents: Size (in terms of number of events) of the caller event buffer.
1744 * @timeout: Maximum timeout for the ready events fetch operation, in
Willem de Bruijn7cdf7c22020-12-18 14:05:35 -08001745 * timespec. If the timeout is zero, the function will not block,
1746 * while if the @timeout ptr is NULL, the function will block
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001747 * until at least one event has been retrieved (or an error
1748 * occurred).
1749 *
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001750 * Return: the number of ready events which have been fetched, or an
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001751 * error code, in case of error.
1752 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001753static int ep_poll(struct eventpoll *ep, struct epoll_event __user *events,
Willem de Bruijn7cdf7c22020-12-18 14:05:35 -08001754 int maxevents, struct timespec64 *timeout)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755{
Soheil Hassas Yeganehe59d3c62020-12-18 14:02:06 -08001756 int res, eavail, timed_out = 0;
John Stultzda8b44d2016-03-17 14:20:51 -07001757 u64 slack = 0;
Ingo Molnarac6424b2017-06-20 12:06:13 +02001758 wait_queue_entry_t wait;
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001759 ktime_t expires, *to = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001760
Davidlohr Bueso679abf32018-08-21 21:58:23 -07001761 lockdep_assert_irqs_enabled();
1762
Willem de Bruijn7cdf7c22020-12-18 14:05:35 -08001763 if (timeout && (timeout->tv_sec | timeout->tv_nsec)) {
1764 slack = select_estimate_accuracy(timeout);
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001765 to = &expires;
Willem de Bruijn7cdf7c22020-12-18 14:05:35 -08001766 *to = timespec64_to_ktime(*timeout);
1767 } else if (timeout) {
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001768 /*
1769 * Avoid the unnecessary trip to the wait queue loop, if the
Soheil Hassas Yeganehe59d3c62020-12-18 14:02:06 -08001770 * caller specified a non blocking operation.
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001771 */
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001772 timed_out = 1;
1773 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001774
Soheil Hassas Yeganehe59d3c62020-12-18 14:02:06 -08001775 /*
1776 * This call is racy: We may or may not see events that are being added
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001777 * to the ready list under the lock (e.g., in IRQ callbacks). For cases
Soheil Hassas Yeganehe59d3c62020-12-18 14:02:06 -08001778 * with a non-zero timeout, this thread will check the ready list under
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001779 * lock and will add to the wait queue. For cases with a zero
Soheil Hassas Yeganehe59d3c62020-12-18 14:02:06 -08001780 * timeout, the user by definition should not care and will have to
1781 * recheck again.
1782 */
1783 eavail = ep_events_available(ep);
1784
Soheil Hassas Yeganeh00b27632020-12-18 14:02:03 -08001785 while (1) {
1786 if (eavail) {
1787 /*
1788 * Try to transfer events to user space. In case we get
1789 * 0 events and there's still timeout left over, we go
1790 * trying again in search of more luck.
1791 */
1792 res = ep_send_events(ep, events, maxevents);
1793 if (res)
1794 return res;
1795 }
Soheil Hassas Yeganehe8c85322020-12-18 14:02:00 -08001796
Soheil Hassas Yeganeh00b27632020-12-18 14:02:03 -08001797 if (timed_out)
1798 return 0;
1799
Soheil Hassas Yeganeh00b27632020-12-18 14:02:03 -08001800 eavail = ep_busy_loop(ep, timed_out);
1801 if (eavail)
1802 continue;
Soheil Hassas Yeganehe8c85322020-12-18 14:02:00 -08001803
Soheil Hassas Yeganeh2efdaf72020-12-18 14:01:48 -08001804 if (signal_pending(current))
1805 return -EINTR;
1806
Roman Penyaev412895f2020-05-07 18:36:16 -07001807 /*
1808 * Internally init_wait() uses autoremove_wake_function(),
1809 * thus wait entry is removed from the wait queue on each
1810 * wakeup. Why it is important? In case of several waiters
1811 * each new wakeup will hit the next waiter, giving it the
1812 * chance to harvest new event. Otherwise wakeup can be
1813 * lost. This is also good performance-wise, because on
1814 * normal wakeup path no need to call __remove_wait_queue()
1815 * explicitly, thus ep->lock is not taken, which halts the
1816 * event delivery.
1817 */
1818 init_wait(&wait);
Roman Penyaev65759092020-05-13 17:50:38 -07001819
Roman Penyaev1b537342020-03-21 18:22:30 -07001820 write_lock_irq(&ep->lock);
Roman Penyaev65759092020-05-13 17:50:38 -07001821 /*
1822 * Barrierless variant, waitqueue_active() is called under
1823 * the same lock on wakeup ep_poll_callback() side, so it
1824 * is safe to avoid an explicit barrier.
1825 */
1826 __set_current_state(TASK_INTERRUPTIBLE);
1827
1828 /*
1829 * Do the final check under the lock. ep_scan_ready_list()
1830 * plays with two lists (->rdllist and ->ovflist) and there
1831 * is always a race when both lists are empty for short
1832 * period of time although events are pending, so lock is
1833 * important.
1834 */
1835 eavail = ep_events_available(ep);
Soheil Hassas Yeganeh2efdaf72020-12-18 14:01:48 -08001836 if (!eavail)
1837 __add_wait_queue_exclusive(&ep->wq, &wait);
1838
Roman Penyaev1b537342020-03-21 18:22:30 -07001839 write_unlock_irq(&ep->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001840
Soheil Hassas Yeganeh2efdaf72020-12-18 14:01:48 -08001841 if (!eavail)
Soheil Hassas Yeganeh289caf52020-12-18 14:01:44 -08001842 timed_out = !schedule_hrtimeout_range(to, slack,
1843 HRTIMER_MODE_ABS);
Soheil Hassas Yeganehe4115962020-12-18 14:01:54 -08001844 __set_current_state(TASK_RUNNING);
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001845
Soheil Hassas Yeganeh289caf52020-12-18 14:01:44 -08001846 /*
1847 * We were woken up, thus go and try to harvest some events.
1848 * If timed out and still on the wait queue, recheck eavail
1849 * carefully under lock, below.
1850 */
Roman Penyaev412895f2020-05-07 18:36:16 -07001851 eavail = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001852
Soheil Hassas Yeganehe8c85322020-12-18 14:02:00 -08001853 if (!list_empty_careful(&wait.entry)) {
1854 write_lock_irq(&ep->lock);
1855 /*
1856 * If the thread timed out and is not on the wait queue,
1857 * it means that the thread was woken up after its
1858 * timeout expired before it could reacquire the lock.
1859 * Thus, when wait.entry is empty, it needs to harvest
1860 * events.
1861 */
1862 if (timed_out)
1863 eavail = list_empty(&wait.entry);
1864 __remove_wait_queue(&ep->wq, &wait);
1865 write_unlock_irq(&ep->lock);
1866 }
Soheil Hassas Yeganeh00b27632020-12-18 14:02:03 -08001867 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001868}
1869
Davide Libenzi22bacca2011-02-25 14:44:12 -08001870/**
Al Viro773318e2020-08-22 23:13:27 -04001871 * ep_loop_check_proc - verify that adding an epoll file inside another
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001872 * epoll structure does not violate the constraints, in
Davide Libenzi22bacca2011-02-25 14:44:12 -08001873 * terms of closed loops, or too deep chains (which can
1874 * result in excessive stack usage).
1875 *
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001876 * @ep: the &struct eventpoll to be currently checked.
Al Virobde03c42020-09-26 16:50:57 -04001877 * @depth: Current depth of the path being checked.
Davide Libenzi22bacca2011-02-25 14:44:12 -08001878 *
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001879 * Return: %zero if adding the epoll @file inside current epoll
1880 * structure @ep does not violate the constraints, or %-1 otherwise.
Davide Libenzi22bacca2011-02-25 14:44:12 -08001881 */
Al Virobde03c42020-09-26 16:50:57 -04001882static int ep_loop_check_proc(struct eventpoll *ep, int depth)
Davide Libenzi22bacca2011-02-25 14:44:12 -08001883{
1884 int error = 0;
Davide Libenzi22bacca2011-02-25 14:44:12 -08001885 struct rb_node *rbp;
1886 struct epitem *epi;
1887
Al Viro773318e2020-08-22 23:13:27 -04001888 mutex_lock_nested(&ep->mtx, depth + 1);
Al Viro18306c42020-09-10 08:30:05 -04001889 ep->gen = loop_check_gen;
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001890 for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) {
Davide Libenzi22bacca2011-02-25 14:44:12 -08001891 epi = rb_entry(rbp, struct epitem, rbn);
1892 if (unlikely(is_file_epoll(epi->ffd.file))) {
Al Virobde03c42020-09-26 16:50:57 -04001893 struct eventpoll *ep_tovisit;
Jason Baron28d82dc2012-01-12 17:17:43 -08001894 ep_tovisit = epi->ffd.file->private_data;
Al Viro18306c42020-09-10 08:30:05 -04001895 if (ep_tovisit->gen == loop_check_gen)
Jason Baron28d82dc2012-01-12 17:17:43 -08001896 continue;
Al Virobde03c42020-09-26 16:50:57 -04001897 if (ep_tovisit == inserting_into || depth > EP_MAX_NESTS)
Al Viro56c428c2020-09-26 16:38:44 -04001898 error = -1;
Al Virobde03c42020-09-26 16:50:57 -04001899 else
1900 error = ep_loop_check_proc(ep_tovisit, depth + 1);
Davide Libenzi22bacca2011-02-25 14:44:12 -08001901 if (error != 0)
1902 break;
Jason Baron28d82dc2012-01-12 17:17:43 -08001903 } else {
1904 /*
1905 * If we've reached a file that is not associated with
1906 * an ep, then we need to check if the newly added
1907 * links are going to add too many wakeup paths. We do
1908 * this by adding it to the tfile_check_list, if it's
1909 * not already there, and calling reverse_path_check()
1910 * during ep_insert().
1911 */
Al Viro319c1512020-10-01 20:45:51 -04001912 list_file(epi->ffd.file);
Davide Libenzi22bacca2011-02-25 14:44:12 -08001913 }
1914 }
1915 mutex_unlock(&ep->mtx);
1916
1917 return error;
1918}
1919
1920/**
Al Virobde03c42020-09-26 16:50:57 -04001921 * ep_loop_check - Performs a check to verify that adding an epoll file (@to)
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001922 * into another epoll file (represented by @ep) does not create
Davide Libenzi22bacca2011-02-25 14:44:12 -08001923 * closed loops or too deep chains.
1924 *
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001925 * @ep: Pointer to the epoll we are inserting into.
Al Virobde03c42020-09-26 16:50:57 -04001926 * @to: Pointer to the epoll to be inserted.
Davide Libenzi22bacca2011-02-25 14:44:12 -08001927 *
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001928 * Return: %zero if adding the epoll @to inside the epoll @from
1929 * does not violate the constraints, or %-1 otherwise.
Davide Libenzi22bacca2011-02-25 14:44:12 -08001930 */
Al Virobde03c42020-09-26 16:50:57 -04001931static int ep_loop_check(struct eventpoll *ep, struct eventpoll *to)
Davide Libenzi22bacca2011-02-25 14:44:12 -08001932{
Al Viro6a3890c2020-09-26 16:29:02 -04001933 inserting_into = ep;
Al Virobde03c42020-09-26 16:50:57 -04001934 return ep_loop_check_proc(to, 0);
Jason Baron28d82dc2012-01-12 17:17:43 -08001935}
1936
1937static void clear_tfile_check_list(void)
1938{
Al Viro319c1512020-10-01 20:45:51 -04001939 rcu_read_lock();
1940 while (tfile_check_list != EP_UNACTIVE_PTR) {
1941 struct epitems_head *head = tfile_check_list;
1942 tfile_check_list = head->next;
1943 unlist_file(head);
Jason Baron28d82dc2012-01-12 17:17:43 -08001944 }
Al Viro319c1512020-10-01 20:45:51 -04001945 rcu_read_unlock();
Davide Libenzi22bacca2011-02-25 14:44:12 -08001946}
1947
Davide Libenzi7699acd2007-05-10 22:23:23 -07001948/*
Andrew Morton523723b2008-08-12 15:09:01 -07001949 * Open an eventpoll file descriptor.
Davide Libenzi7699acd2007-05-10 22:23:23 -07001950 */
Dominik Brodowski791eb222018-03-11 11:34:30 +01001951static int do_epoll_create(int flags)
Davide Libenzi7699acd2007-05-10 22:23:23 -07001952{
Jason Baron28d82dc2012-01-12 17:17:43 -08001953 int error, fd;
Davide Libenzibb57c3e2009-03-31 15:24:12 -07001954 struct eventpoll *ep = NULL;
Jason Baron28d82dc2012-01-12 17:17:43 -08001955 struct file *file;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001956
Ulrich Dreppere38b36f2008-07-23 21:29:42 -07001957 /* Check the EPOLL_* constant for consistency. */
1958 BUILD_BUG_ON(EPOLL_CLOEXEC != O_CLOEXEC);
1959
Davide Libenzi296e2362009-03-31 15:24:11 -07001960 if (flags & ~EPOLL_CLOEXEC)
1961 return -EINVAL;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001962 /*
Davide Libenzibb57c3e2009-03-31 15:24:12 -07001963 * Create the internal data structure ("struct eventpoll").
Davide Libenzi7699acd2007-05-10 22:23:23 -07001964 */
Ulrich Drepper9fe5ad92008-07-23 21:29:43 -07001965 error = ep_alloc(&ep);
Davide Libenzibb57c3e2009-03-31 15:24:12 -07001966 if (error < 0)
1967 return error;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001968 /*
1969 * Creates all the items needed to setup an eventpoll file. That is,
Al Viro2030a422008-02-23 06:46:49 -05001970 * a file structure and a free file descriptor.
Davide Libenzi7699acd2007-05-10 22:23:23 -07001971 */
Jason Baron28d82dc2012-01-12 17:17:43 -08001972 fd = get_unused_fd_flags(O_RDWR | (flags & O_CLOEXEC));
1973 if (fd < 0) {
1974 error = fd;
1975 goto out_free_ep;
1976 }
1977 file = anon_inode_getfile("[eventpoll]", &eventpoll_fops, ep,
Roland Dreier628ff7c2009-12-18 09:41:24 -08001978 O_RDWR | (flags & O_CLOEXEC));
Jason Baron28d82dc2012-01-12 17:17:43 -08001979 if (IS_ERR(file)) {
1980 error = PTR_ERR(file);
1981 goto out_free_fd;
1982 }
Jason Baron28d82dc2012-01-12 17:17:43 -08001983 ep->file = file;
Al Viro98022742012-08-17 22:42:36 -04001984 fd_install(fd, file);
Jason Baron28d82dc2012-01-12 17:17:43 -08001985 return fd;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001986
Jason Baron28d82dc2012-01-12 17:17:43 -08001987out_free_fd:
1988 put_unused_fd(fd);
1989out_free_ep:
1990 ep_free(ep);
Davide Libenzibb57c3e2009-03-31 15:24:12 -07001991 return error;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001992}
1993
Dominik Brodowski791eb222018-03-11 11:34:30 +01001994SYSCALL_DEFINE1(epoll_create1, int, flags)
1995{
1996 return do_epoll_create(flags);
1997}
1998
Heiko Carstens5a8a82b2009-01-14 14:14:25 +01001999SYSCALL_DEFINE1(epoll_create, int, size)
Ulrich Dreppera0998b52008-07-23 21:29:27 -07002000{
Davide Libenzibfe3891a2009-05-12 13:19:44 -07002001 if (size <= 0)
Ulrich Drepper9fe5ad92008-07-23 21:29:43 -07002002 return -EINVAL;
2003
Dominik Brodowski791eb222018-03-11 11:34:30 +01002004 return do_epoll_create(0);
Ulrich Dreppera0998b52008-07-23 21:29:27 -07002005}
2006
Jens Axboe39220e82020-01-08 15:05:37 -07002007static inline int epoll_mutex_lock(struct mutex *mutex, int depth,
2008 bool nonblock)
2009{
2010 if (!nonblock) {
2011 mutex_lock_nested(mutex, depth);
2012 return 0;
2013 }
2014 if (mutex_trylock(mutex))
2015 return 0;
2016 return -EAGAIN;
2017}
2018
2019int do_epoll_ctl(int epfd, int op, int fd, struct epoll_event *epds,
2020 bool nonblock)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002021{
2022 int error;
Jason Baron67347fe2013-11-12 15:10:18 -08002023 int full_check = 0;
Al Viro7e3fb582013-08-30 12:47:21 -04002024 struct fd f, tf;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002025 struct eventpoll *ep;
2026 struct epitem *epi;
Jason Baron67347fe2013-11-12 15:10:18 -08002027 struct eventpoll *tep = NULL;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002028
Davide Libenzi7699acd2007-05-10 22:23:23 -07002029 error = -EBADF;
Al Viro7e3fb582013-08-30 12:47:21 -04002030 f = fdget(epfd);
2031 if (!f.file)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002032 goto error_return;
2033
2034 /* Get the "struct file *" for the target file */
Al Viro7e3fb582013-08-30 12:47:21 -04002035 tf = fdget(fd);
2036 if (!tf.file)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002037 goto error_fput;
2038
2039 /* The target file descriptor must support poll */
2040 error = -EPERM;
Christoph Hellwig9965ed172018-03-05 07:26:05 -08002041 if (!file_can_poll(tf.file))
Davide Libenzi7699acd2007-05-10 22:23:23 -07002042 goto error_tgt_fput;
2043
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02002044 /* Check if EPOLLWAKEUP is allowed */
Nicolas Ioossc680e412014-09-09 14:50:51 -07002045 if (ep_op_has_event(op))
Jens Axboe58e41a42020-01-08 14:35:13 -07002046 ep_take_care_of_epollwakeup(epds);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02002047
Davide Libenzi7699acd2007-05-10 22:23:23 -07002048 /*
2049 * We have to check that the file structure underneath the file descriptor
2050 * the user passed to us _is_ an eventpoll file. And also we do not permit
2051 * adding an epoll file descriptor inside itself.
2052 */
2053 error = -EINVAL;
Al Viro7e3fb582013-08-30 12:47:21 -04002054 if (f.file == tf.file || !is_file_epoll(f.file))
Davide Libenzi7699acd2007-05-10 22:23:23 -07002055 goto error_tgt_fput;
2056
2057 /*
Jason Barondf0108c2016-01-20 14:59:24 -08002058 * epoll adds to the wakeup queue at EPOLL_CTL_ADD time only,
2059 * so EPOLLEXCLUSIVE is not allowed for a EPOLL_CTL_MOD operation.
2060 * Also, we do not currently supported nested exclusive wakeups.
2061 */
Jens Axboe58e41a42020-01-08 14:35:13 -07002062 if (ep_op_has_event(op) && (epds->events & EPOLLEXCLUSIVE)) {
Jason Baronb6a515c2016-02-05 15:37:04 -08002063 if (op == EPOLL_CTL_MOD)
2064 goto error_tgt_fput;
2065 if (op == EPOLL_CTL_ADD && (is_file_epoll(tf.file) ||
Jens Axboe58e41a42020-01-08 14:35:13 -07002066 (epds->events & ~EPOLLEXCLUSIVE_OK_BITS)))
Jason Baronb6a515c2016-02-05 15:37:04 -08002067 goto error_tgt_fput;
2068 }
Jason Barondf0108c2016-01-20 14:59:24 -08002069
2070 /*
Davide Libenzi7699acd2007-05-10 22:23:23 -07002071 * At this point it is safe to assume that the "private_data" contains
2072 * our own data structure.
2073 */
Al Viro7e3fb582013-08-30 12:47:21 -04002074 ep = f.file->private_data;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002075
Davide Libenzi22bacca2011-02-25 14:44:12 -08002076 /*
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07002077 * When we insert an epoll file descriptor inside another epoll file
2078 * descriptor, there is the chance of creating closed loops, which are
Jason Baron28d82dc2012-01-12 17:17:43 -08002079 * better be handled here, than in more critical paths. While we are
2080 * checking for loops we also determine the list of files reachable
2081 * and hang them on the tfile_check_list, so we can check that we
2082 * haven't created too many possible wakeup paths.
Davide Libenzi22bacca2011-02-25 14:44:12 -08002083 *
Jason Baron67347fe2013-11-12 15:10:18 -08002084 * We do not need to take the global 'epumutex' on EPOLL_CTL_ADD when
2085 * the epoll file descriptor is attaching directly to a wakeup source,
2086 * unless the epoll file descriptor is nested. The purpose of taking the
2087 * 'epmutex' on add is to prevent complex toplogies such as loops and
2088 * deep wakeup paths from forming in parallel through multiple
2089 * EPOLL_CTL_ADD operations.
Davide Libenzi22bacca2011-02-25 14:44:12 -08002090 */
Jens Axboe39220e82020-01-08 15:05:37 -07002091 error = epoll_mutex_lock(&ep->mtx, 0, nonblock);
2092 if (error)
2093 goto error_tgt_fput;
Jason Baron67347fe2013-11-12 15:10:18 -08002094 if (op == EPOLL_CTL_ADD) {
Al Viro319c1512020-10-01 20:45:51 -04002095 if (READ_ONCE(f.file->f_ep) || ep->gen == loop_check_gen ||
2096 is_file_epoll(tf.file)) {
Jason Baron67347fe2013-11-12 15:10:18 -08002097 mutex_unlock(&ep->mtx);
Jens Axboe39220e82020-01-08 15:05:37 -07002098 error = epoll_mutex_lock(&epmutex, 0, nonblock);
2099 if (error)
2100 goto error_tgt_fput;
Al Viro18306c42020-09-10 08:30:05 -04002101 loop_check_gen++;
Jens Axboe39220e82020-01-08 15:05:37 -07002102 full_check = 1;
Jason Baron67347fe2013-11-12 15:10:18 -08002103 if (is_file_epoll(tf.file)) {
Al Virobde03c42020-09-26 16:50:57 -04002104 tep = tf.file->private_data;
Jason Baron67347fe2013-11-12 15:10:18 -08002105 error = -ELOOP;
Al Virobde03c42020-09-26 16:50:57 -04002106 if (ep_loop_check(ep, tep) != 0)
Jason Baron67347fe2013-11-12 15:10:18 -08002107 goto error_tgt_fput;
Marc Zyngiera9ed4a62020-08-19 17:12:17 +01002108 }
Jens Axboe39220e82020-01-08 15:05:37 -07002109 error = epoll_mutex_lock(&ep->mtx, 0, nonblock);
Al Viro52c47962020-08-22 18:25:52 -04002110 if (error)
Jens Axboe39220e82020-01-08 15:05:37 -07002111 goto error_tgt_fput;
Jason Baron67347fe2013-11-12 15:10:18 -08002112 }
2113 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07002114
Davide Libenzi67647d02007-05-15 01:40:52 -07002115 /*
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07002116 * Try to lookup the file inside our RB tree. Since we grabbed "mtx"
Davide Libenzi67647d02007-05-15 01:40:52 -07002117 * above, we can be sure to be able to use the item looked up by
2118 * ep_find() till we release the mutex.
2119 */
Al Viro7e3fb582013-08-30 12:47:21 -04002120 epi = ep_find(ep, tf.file, fd);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002121
2122 error = -EINVAL;
2123 switch (op) {
2124 case EPOLL_CTL_ADD:
2125 if (!epi) {
Jens Axboe58e41a42020-01-08 14:35:13 -07002126 epds->events |= EPOLLERR | EPOLLHUP;
2127 error = ep_insert(ep, epds, tf.file, fd, full_check);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002128 } else
2129 error = -EEXIST;
2130 break;
2131 case EPOLL_CTL_DEL:
2132 if (epi)
2133 error = ep_remove(ep, epi);
2134 else
2135 error = -ENOENT;
2136 break;
2137 case EPOLL_CTL_MOD:
2138 if (epi) {
Jason Baronb6a515c2016-02-05 15:37:04 -08002139 if (!(epi->event.events & EPOLLEXCLUSIVE)) {
Jens Axboe58e41a42020-01-08 14:35:13 -07002140 epds->events |= EPOLLERR | EPOLLHUP;
2141 error = ep_modify(ep, epi, epds);
Jason Baronb6a515c2016-02-05 15:37:04 -08002142 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07002143 } else
2144 error = -ENOENT;
2145 break;
2146 }
Davide Libenzid47de162007-05-15 01:40:41 -07002147 mutex_unlock(&ep->mtx);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002148
2149error_tgt_fput:
Al Viro52c47962020-08-22 18:25:52 -04002150 if (full_check) {
2151 clear_tfile_check_list();
Al Viro18306c42020-09-10 08:30:05 -04002152 loop_check_gen++;
Davide Libenzi22bacca2011-02-25 14:44:12 -08002153 mutex_unlock(&epmutex);
Al Viro52c47962020-08-22 18:25:52 -04002154 }
Davide Libenzi22bacca2011-02-25 14:44:12 -08002155
Al Viro7e3fb582013-08-30 12:47:21 -04002156 fdput(tf);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002157error_fput:
Al Viro7e3fb582013-08-30 12:47:21 -04002158 fdput(f);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002159error_return:
Davide Libenzi7699acd2007-05-10 22:23:23 -07002160
2161 return error;
2162}
2163
2164/*
Jens Axboe58e41a42020-01-08 14:35:13 -07002165 * The following function implements the controller interface for
2166 * the eventpoll file that enables the insertion/removal/change of
2167 * file descriptors inside the interest set.
2168 */
2169SYSCALL_DEFINE4(epoll_ctl, int, epfd, int, op, int, fd,
2170 struct epoll_event __user *, event)
2171{
2172 struct epoll_event epds;
2173
2174 if (ep_op_has_event(op) &&
2175 copy_from_user(&epds, event, sizeof(struct epoll_event)))
2176 return -EFAULT;
2177
Jens Axboe39220e82020-01-08 15:05:37 -07002178 return do_epoll_ctl(epfd, op, fd, &epds, false);
Jens Axboe58e41a42020-01-08 14:35:13 -07002179}
2180
2181/*
Davide Libenzi7699acd2007-05-10 22:23:23 -07002182 * Implement the event wait interface for the eventpoll file. It is the kernel
2183 * part of the user space epoll_wait(2).
2184 */
Dominik Brodowski791eb222018-03-11 11:34:30 +01002185static int do_epoll_wait(int epfd, struct epoll_event __user *events,
Willem de Bruijn7cdf7c22020-12-18 14:05:35 -08002186 int maxevents, struct timespec64 *to)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002187{
Al Viro2903ff02012-08-28 12:52:22 -04002188 int error;
2189 struct fd f;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002190 struct eventpoll *ep;
2191
Davide Libenzi7699acd2007-05-10 22:23:23 -07002192 /* The maximum number of event must be greater than zero */
2193 if (maxevents <= 0 || maxevents > EP_MAX_EVENTS)
2194 return -EINVAL;
2195
2196 /* Verify that the area passed by the user is writeable */
Linus Torvalds96d4f262019-01-03 18:57:57 -08002197 if (!access_ok(events, maxevents * sizeof(struct epoll_event)))
Al Viro2903ff02012-08-28 12:52:22 -04002198 return -EFAULT;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002199
2200 /* Get the "struct file *" for the eventpoll file */
Al Viro2903ff02012-08-28 12:52:22 -04002201 f = fdget(epfd);
2202 if (!f.file)
2203 return -EBADF;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002204
2205 /*
2206 * We have to check that the file structure underneath the fd
2207 * the user passed to us _is_ an eventpoll file.
2208 */
2209 error = -EINVAL;
Al Viro2903ff02012-08-28 12:52:22 -04002210 if (!is_file_epoll(f.file))
Davide Libenzi7699acd2007-05-10 22:23:23 -07002211 goto error_fput;
2212
2213 /*
2214 * At this point it is safe to assume that the "private_data" contains
2215 * our own data structure.
2216 */
Al Viro2903ff02012-08-28 12:52:22 -04002217 ep = f.file->private_data;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002218
2219 /* Time to fish for events ... */
Willem de Bruijn7cdf7c22020-12-18 14:05:35 -08002220 error = ep_poll(ep, events, maxevents, to);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002221
2222error_fput:
Al Viro2903ff02012-08-28 12:52:22 -04002223 fdput(f);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002224 return error;
2225}
2226
Dominik Brodowski791eb222018-03-11 11:34:30 +01002227SYSCALL_DEFINE4(epoll_wait, int, epfd, struct epoll_event __user *, events,
2228 int, maxevents, int, timeout)
2229{
Willem de Bruijn7cdf7c22020-12-18 14:05:35 -08002230 struct timespec64 to;
2231
2232 return do_epoll_wait(epfd, events, maxevents,
2233 ep_timeout_to_timespec(&to, timeout));
Dominik Brodowski791eb222018-03-11 11:34:30 +01002234}
2235
Davide Libenzi7699acd2007-05-10 22:23:23 -07002236/*
2237 * Implement the event wait interface for the eventpoll file. It is the kernel
2238 * part of the user space epoll_pwait(2).
2239 */
Willem de Bruijn58169a52020-12-18 14:05:38 -08002240static int do_epoll_pwait(int epfd, struct epoll_event __user *events,
2241 int maxevents, struct timespec64 *to,
2242 const sigset_t __user *sigmask, size_t sigsetsize)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002243{
2244 int error;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002245
2246 /*
2247 * If the caller wants a certain signal mask to be set during the wait,
2248 * we apply it here.
2249 */
Oleg Nesterovb7724342019-07-16 16:29:53 -07002250 error = set_user_sigmask(sigmask, sigsetsize);
Deepa Dinamanided653c2018-09-19 21:41:04 -07002251 if (error)
2252 return error;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002253
Willem de Bruijn58169a52020-12-18 14:05:38 -08002254 error = do_epoll_wait(epfd, events, maxevents, to);
Willem de Bruijn7cdf7c22020-12-18 14:05:35 -08002255
Oleg Nesterovb7724342019-07-16 16:29:53 -07002256 restore_saved_sigmask_unless(error == -EINTR);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002257
2258 return error;
2259}
2260
Willem de Bruijn58169a52020-12-18 14:05:38 -08002261SYSCALL_DEFINE6(epoll_pwait, int, epfd, struct epoll_event __user *, events,
2262 int, maxevents, int, timeout, const sigset_t __user *, sigmask,
2263 size_t, sigsetsize)
Al Viro35280bd2013-02-24 14:52:17 -05002264{
Willem de Bruijn7cdf7c22020-12-18 14:05:35 -08002265 struct timespec64 to;
Willem de Bruijn58169a52020-12-18 14:05:38 -08002266
2267 return do_epoll_pwait(epfd, events, maxevents,
2268 ep_timeout_to_timespec(&to, timeout),
2269 sigmask, sigsetsize);
2270}
2271
2272SYSCALL_DEFINE6(epoll_pwait2, int, epfd, struct epoll_event __user *, events,
2273 int, maxevents, const struct __kernel_timespec __user *, timeout,
2274 const sigset_t __user *, sigmask, size_t, sigsetsize)
2275{
2276 struct timespec64 ts, *to = NULL;
2277
2278 if (timeout) {
2279 if (get_timespec64(&ts, timeout))
2280 return -EFAULT;
2281 to = &ts;
2282 if (poll_select_set_timeout(to, ts.tv_sec, ts.tv_nsec))
2283 return -EINVAL;
2284 }
2285
2286 return do_epoll_pwait(epfd, events, maxevents, to,
2287 sigmask, sigsetsize);
2288}
2289
2290#ifdef CONFIG_COMPAT
2291static int do_compat_epoll_pwait(int epfd, struct epoll_event __user *events,
2292 int maxevents, struct timespec64 *timeout,
2293 const compat_sigset_t __user *sigmask,
2294 compat_size_t sigsetsize)
2295{
Al Viro35280bd2013-02-24 14:52:17 -05002296 long err;
Al Viro35280bd2013-02-24 14:52:17 -05002297
2298 /*
2299 * If the caller wants a certain signal mask to be set during the wait,
2300 * we apply it here.
2301 */
Oleg Nesterovb7724342019-07-16 16:29:53 -07002302 err = set_compat_user_sigmask(sigmask, sigsetsize);
Deepa Dinamanided653c2018-09-19 21:41:04 -07002303 if (err)
2304 return err;
Al Viro35280bd2013-02-24 14:52:17 -05002305
Willem de Bruijn58169a52020-12-18 14:05:38 -08002306 err = do_epoll_wait(epfd, events, maxevents, timeout);
Willem de Bruijn7cdf7c22020-12-18 14:05:35 -08002307
Oleg Nesterovb7724342019-07-16 16:29:53 -07002308 restore_saved_sigmask_unless(err == -EINTR);
Al Viro35280bd2013-02-24 14:52:17 -05002309
2310 return err;
2311}
Willem de Bruijn58169a52020-12-18 14:05:38 -08002312
2313COMPAT_SYSCALL_DEFINE6(epoll_pwait, int, epfd,
2314 struct epoll_event __user *, events,
2315 int, maxevents, int, timeout,
2316 const compat_sigset_t __user *, sigmask,
2317 compat_size_t, sigsetsize)
2318{
2319 struct timespec64 to;
2320
2321 return do_compat_epoll_pwait(epfd, events, maxevents,
2322 ep_timeout_to_timespec(&to, timeout),
2323 sigmask, sigsetsize);
2324}
2325
2326COMPAT_SYSCALL_DEFINE6(epoll_pwait2, int, epfd,
2327 struct epoll_event __user *, events,
2328 int, maxevents,
2329 const struct __kernel_timespec __user *, timeout,
2330 const compat_sigset_t __user *, sigmask,
2331 compat_size_t, sigsetsize)
2332{
2333 struct timespec64 ts, *to = NULL;
2334
2335 if (timeout) {
2336 if (get_timespec64(&ts, timeout))
2337 return -EFAULT;
2338 to = &ts;
2339 if (poll_select_set_timeout(to, ts.tv_sec, ts.tv_nsec))
2340 return -EINVAL;
2341 }
2342
2343 return do_compat_epoll_pwait(epfd, events, maxevents, to,
2344 sigmask, sigsetsize);
2345}
2346
Al Viro35280bd2013-02-24 14:52:17 -05002347#endif
2348
Linus Torvalds1da177e2005-04-16 15:20:36 -07002349static int __init eventpoll_init(void)
2350{
Davide Libenzi7ef99642008-12-01 13:13:55 -08002351 struct sysinfo si;
2352
2353 si_meminfo(&si);
Davide Libenzi9df04e12009-01-29 14:25:26 -08002354 /*
2355 * Allows top 4% of lomem to be allocated for epoll watches (per user).
2356 */
2357 max_user_watches = (((si.totalram - si.totalhigh) / 25) << PAGE_SHIFT) /
Davide Libenzi7ef99642008-12-01 13:13:55 -08002358 EP_ITEM_COST;
Robin Holt52bd19f72011-01-12 17:00:01 -08002359 BUG_ON(max_user_watches < 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002360
Davide Libenzi22bacca2011-02-25 14:44:12 -08002361 /*
Eric Wong39732ca2013-04-30 15:27:38 -07002362 * We can have many thousands of epitems, so prevent this from
2363 * using an extra cache line on 64-bit (and smaller) CPUs
2364 */
2365 BUILD_BUG_ON(sizeof(void *) <= 8 && sizeof(struct epitem) > 128);
2366
Linus Torvalds1da177e2005-04-16 15:20:36 -07002367 /* Allocates slab cache used to allocate "struct epitem" items */
2368 epi_cache = kmem_cache_create("eventpoll_epi", sizeof(struct epitem),
Shakeel Butt2ae928a2017-11-17 15:28:59 -08002369 0, SLAB_HWCACHE_ALIGN|SLAB_PANIC|SLAB_ACCOUNT, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002370
2371 /* Allocates slab cache used to allocate "struct eppoll_entry" */
2372 pwq_cache = kmem_cache_create("eventpoll_pwq",
Shakeel Butt2ae928a2017-11-17 15:28:59 -08002373 sizeof(struct eppoll_entry), 0, SLAB_PANIC|SLAB_ACCOUNT, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002374
Al Viro319c1512020-10-01 20:45:51 -04002375 ephead_cache = kmem_cache_create("ep_head",
2376 sizeof(struct epitems_head), 0, SLAB_PANIC|SLAB_ACCOUNT, NULL);
2377
Linus Torvalds1da177e2005-04-16 15:20:36 -07002378 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002379}
Davide Libenzicea69242007-05-10 22:23:22 -07002380fs_initcall(eventpoll_init);