blob: e2daa940ebce7c77ee836aca2a6e82a7deb80b18 [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
Xiaoming Nia8f5de82022-01-21 22:12:09 -0800310static struct 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};
Xiaoming Nia8f5de82022-01-21 22:12:09 -0800322
323static void __init epoll_sysctls_init(void)
324{
325 register_sysctl("fs/epoll", epoll_table);
326}
327#else
328#define epoll_sysctls_init() do { } while (0)
Davide Libenzi7ef99642008-12-01 13:13:55 -0800329#endif /* CONFIG_SYSCTL */
330
Jason Baron28d82dc2012-01-12 17:17:43 -0800331static const struct file_operations eventpoll_fops;
332
333static inline int is_file_epoll(struct file *f)
334{
335 return f->f_op == &eventpoll_fops;
336}
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700337
Davide Libenzi67647d02007-05-15 01:40:52 -0700338/* Setup the structure that is used as key for the RB tree */
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700339static inline void ep_set_ffd(struct epoll_filefd *ffd,
340 struct file *file, int fd)
341{
342 ffd->file = file;
343 ffd->fd = fd;
344}
345
Davide Libenzi67647d02007-05-15 01:40:52 -0700346/* Compare RB tree keys */
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700347static inline int ep_cmp_ffd(struct epoll_filefd *p1,
348 struct epoll_filefd *p2)
349{
350 return (p1->file > p2->file ? +1:
351 (p1->file < p2->file ? -1 : p1->fd - p2->fd));
352}
353
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700354/* Tells us if the item is currently linked */
Davidlohr Bueso992991c2018-08-21 21:58:26 -0700355static inline int ep_is_linked(struct epitem *epi)
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700356{
Davidlohr Bueso992991c2018-08-21 21:58:26 -0700357 return !list_empty(&epi->rdllink);
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700358}
359
Ingo Molnarac6424b2017-06-20 12:06:13 +0200360static inline struct eppoll_entry *ep_pwq_from_wait(wait_queue_entry_t *p)
Oleg Nesterov971316f2012-02-24 20:07:29 +0100361{
362 return container_of(p, struct eppoll_entry, wait);
363}
364
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700365/* Get the "struct epitem" from a wait queue pointer */
Ingo Molnarac6424b2017-06-20 12:06:13 +0200366static inline struct epitem *ep_item_from_wait(wait_queue_entry_t *p)
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700367{
368 return container_of(p, struct eppoll_entry, wait)->base;
369}
370
Davide Libenzi5071f972009-03-31 15:24:10 -0700371/**
Davide Libenzi3fb0e582011-03-22 16:34:46 -0700372 * ep_events_available - Checks if ready events might be available.
373 *
374 * @ep: Pointer to the eventpoll context.
375 *
Randy Dunlapa6c67fe2021-03-01 15:25:51 -0700376 * Return: a value different than %zero if ready events are available,
377 * or %zero otherwise.
Davide Libenzi3fb0e582011-03-22 16:34:46 -0700378 */
379static inline int ep_events_available(struct eventpoll *ep)
380{
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -0800381 return !list_empty_careful(&ep->rdllist) ||
382 READ_ONCE(ep->ovflist) != EP_UNACTIVE_PTR;
Davide Libenzi3fb0e582011-03-22 16:34:46 -0700383}
384
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700385#ifdef CONFIG_NET_RX_BUSY_POLL
386static bool ep_busy_loop_end(void *p, unsigned long start_time)
387{
388 struct eventpoll *ep = p;
389
390 return ep_events_available(ep) || busy_loop_timeout(start_time);
391}
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700392
393/*
394 * Busy poll if globally on and supporting sockets found && no events,
395 * busy loop will return if need_resched or ep_events_available.
396 *
397 * we must do our busy polling with irqs enabled
398 */
Soheil Hassas Yeganeh1493c472020-12-18 14:01:57 -0800399static bool ep_busy_loop(struct eventpoll *ep, int nonblock)
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700400{
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700401 unsigned int napi_id = READ_ONCE(ep->napi_id);
402
Soheil Hassas Yeganeh1493c472020-12-18 14:01:57 -0800403 if ((napi_id >= MIN_NAPI_ID) && net_busy_loop_on()) {
Björn Töpel7c951caf2020-11-30 19:51:57 +0100404 napi_busy_loop(napi_id, nonblock ? NULL : ep_busy_loop_end, ep, false,
405 BUSY_POLL_BUDGET);
Soheil Hassas Yeganeh1493c472020-12-18 14:01:57 -0800406 if (ep_events_available(ep))
407 return true;
408 /*
409 * Busy poll timed out. Drop NAPI ID for now, we can add
410 * it back in when we have moved a socket with a valid NAPI
411 * ID onto the ready list.
412 */
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700413 ep->napi_id = 0;
Soheil Hassas Yeganeh1493c472020-12-18 14:01:57 -0800414 return false;
415 }
416 return false;
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700417}
418
419/*
420 * Set epoll busy poll NAPI ID from sk.
421 */
422static inline void ep_set_busy_poll_napi_id(struct epitem *epi)
423{
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700424 struct eventpoll *ep;
425 unsigned int napi_id;
426 struct socket *sock;
427 struct sock *sk;
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700428
429 if (!net_busy_loop_on())
430 return;
431
Florent Revestdba4a922020-12-04 12:36:04 +0100432 sock = sock_from_file(epi->ffd.file);
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700433 if (!sock)
434 return;
435
436 sk = sock->sk;
437 if (!sk)
438 return;
439
440 napi_id = READ_ONCE(sk->sk_napi_id);
441 ep = epi->ep;
442
443 /* Non-NAPI IDs can be rejected
444 * or
445 * Nothing to do if we already have this ID
446 */
447 if (napi_id < MIN_NAPI_ID || napi_id == ep->napi_id)
448 return;
449
450 /* record NAPI ID for use in next busy poll */
451 ep->napi_id = napi_id;
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700452}
453
Davidlohr Bueso514056d2018-08-21 21:58:19 -0700454#else
455
Soheil Hassas Yeganeh1493c472020-12-18 14:01:57 -0800456static inline bool ep_busy_loop(struct eventpoll *ep, int nonblock)
Davidlohr Bueso514056d2018-08-21 21:58:19 -0700457{
Soheil Hassas Yeganeh1493c472020-12-18 14:01:57 -0800458 return false;
Davidlohr Bueso514056d2018-08-21 21:58:19 -0700459}
460
461static inline void ep_set_busy_poll_napi_id(struct epitem *epi)
462{
463}
464
465#endif /* CONFIG_NET_RX_BUSY_POLL */
466
Steven Rostedt02edc6f2012-03-23 15:02:27 -0700467/*
468 * As described in commit 0ccf831cb lockdep: annotate epoll
469 * the use of wait queues used by epoll is done in a very controlled
470 * manner. Wake ups can nest inside each other, but are never done
471 * with the same locking. For example:
472 *
473 * dfd = socket(...);
474 * efd1 = epoll_create();
475 * efd2 = epoll_create();
476 * epoll_ctl(efd1, EPOLL_CTL_ADD, dfd, ...);
477 * epoll_ctl(efd2, EPOLL_CTL_ADD, efd1, ...);
478 *
479 * When a packet arrives to the device underneath "dfd", the net code will
480 * issue a wake_up() on its poll wake list. Epoll (efd1) has installed a
481 * callback wakeup entry on that queue, and the wake_up() performed by the
482 * "dfd" net code will end up in ep_poll_callback(). At this point epoll
483 * (efd1) notices that it may have some event ready, so it needs to wake up
484 * the waiters on its poll wait list (efd2). So it calls ep_poll_safewake()
485 * that ends up in another wake_up(), after having checked about the
486 * recursion constraints. That are, no more than EP_MAX_POLLWAKE_NESTS, to
487 * avoid stack blasting.
488 *
489 * When CONFIG_DEBUG_LOCK_ALLOC is enabled, make sure lockdep can handle
490 * this special case of epoll.
491 */
Davide Libenzi2dfa4ee2009-03-31 15:24:22 -0700492#ifdef CONFIG_DEBUG_LOCK_ALLOC
Davide Libenzi2dfa4ee2009-03-31 15:24:22 -0700493
Jason Baronefcdd352020-04-06 20:11:23 -0700494static void ep_poll_safewake(struct eventpoll *ep, struct epitem *epi)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495{
Jason Baronefcdd352020-04-06 20:11:23 -0700496 struct eventpoll *ep_src;
Jason Baronf6520c52019-12-04 16:52:12 -0800497 unsigned long flags;
Jason Baronefcdd352020-04-06 20:11:23 -0700498 u8 nests = 0;
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700499
Jason Baronefcdd352020-04-06 20:11:23 -0700500 /*
501 * To set the subclass or nesting level for spin_lock_irqsave_nested()
502 * it might be natural to create a per-cpu nest count. However, since
503 * we can recurse on ep->poll_wait.lock, and a non-raw spinlock can
504 * schedule() in the -rt kernel, the per-cpu variable are no longer
505 * protected. Thus, we are introducing a per eventpoll nest field.
506 * If we are not being call from ep_poll_callback(), epi is NULL and
507 * we are at the first level of nesting, 0. Otherwise, we are being
508 * called from ep_poll_callback() and if a previous wakeup source is
509 * not an epoll file itself, we are at depth 1 since the wakeup source
510 * is depth 0. If the wakeup source is a previous epoll file in the
511 * wakeup chain then we use its nests value and record ours as
512 * nests + 1. The previous epoll file nests value is stable since its
513 * already holding its own poll_wait.lock.
514 */
515 if (epi) {
516 if ((is_file_epoll(epi->ffd.file))) {
517 ep_src = epi->ffd.file->private_data;
518 nests = ep_src->nests;
519 } else {
520 nests = 1;
521 }
522 }
523 spin_lock_irqsave_nested(&ep->poll_wait.lock, flags, nests);
524 ep->nests = nests + 1;
525 wake_up_locked_poll(&ep->poll_wait, EPOLLIN);
526 ep->nests = 0;
527 spin_unlock_irqrestore(&ep->poll_wait.lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528}
529
Jason Baron57a173b2017-11-17 15:29:02 -0800530#else
531
Jason Baronefcdd352020-04-06 20:11:23 -0700532static void ep_poll_safewake(struct eventpoll *ep, struct epitem *epi)
Jason Baron57a173b2017-11-17 15:29:02 -0800533{
Jason Baronefcdd352020-04-06 20:11:23 -0700534 wake_up_poll(&ep->poll_wait, EPOLLIN);
Jason Baron57a173b2017-11-17 15:29:02 -0800535}
536
537#endif
538
Oleg Nesterov971316f2012-02-24 20:07:29 +0100539static void ep_remove_wait_queue(struct eppoll_entry *pwq)
540{
541 wait_queue_head_t *whead;
542
543 rcu_read_lock();
Oleg Nesterov138e4ad2017-09-01 18:55:33 +0200544 /*
545 * If it is cleared by POLLFREE, it should be rcu-safe.
546 * If we read NULL we need a barrier paired with
547 * smp_store_release() in ep_poll_callback(), otherwise
548 * we rely on whead->lock.
549 */
550 whead = smp_load_acquire(&pwq->whead);
Oleg Nesterov971316f2012-02-24 20:07:29 +0100551 if (whead)
552 remove_wait_queue(whead, &pwq->wait);
553 rcu_read_unlock();
554}
555
Davide Libenzi7699acd2007-05-10 22:23:23 -0700556/*
Tony Battersbyd1bc90d2009-03-31 15:24:15 -0700557 * This function unregisters poll callbacks from the associated file
558 * descriptor. Must be called with "mtx" held (or "epmutex" if called from
559 * ep_free).
Davide Libenzi7699acd2007-05-10 22:23:23 -0700560 */
561static void ep_unregister_pollwait(struct eventpoll *ep, struct epitem *epi)
562{
Al Viro80285b72020-09-02 11:45:57 -0400563 struct eppoll_entry **p = &epi->pwqlist;
Davide Libenzi7699acd2007-05-10 22:23:23 -0700564 struct eppoll_entry *pwq;
565
Al Viro80285b72020-09-02 11:45:57 -0400566 while ((pwq = *p) != NULL) {
567 *p = pwq->next;
Oleg Nesterov971316f2012-02-24 20:07:29 +0100568 ep_remove_wait_queue(pwq);
Tony Battersbyd1bc90d2009-03-31 15:24:15 -0700569 kmem_cache_free(pwq_cache, pwq);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700570 }
571}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572
Eric Wongeea1d582013-04-30 15:27:39 -0700573/* call only when ep->mtx is held */
574static inline struct wakeup_source *ep_wakeup_source(struct epitem *epi)
575{
576 return rcu_dereference_check(epi->ws, lockdep_is_held(&epi->ep->mtx));
577}
578
579/* call only when ep->mtx is held */
580static inline void ep_pm_stay_awake(struct epitem *epi)
581{
582 struct wakeup_source *ws = ep_wakeup_source(epi);
583
584 if (ws)
585 __pm_stay_awake(ws);
586}
587
588static inline bool ep_has_wakeup_source(struct epitem *epi)
589{
590 return rcu_access_pointer(epi->ws) ? true : false;
591}
592
593/* call when ep->mtx cannot be held (ep_poll_callback) */
594static inline void ep_pm_stay_awake_rcu(struct epitem *epi)
595{
596 struct wakeup_source *ws;
597
598 rcu_read_lock();
599 ws = rcu_dereference(epi->ws);
600 if (ws)
601 __pm_stay_awake(ws);
602 rcu_read_unlock();
603}
604
Al Viro57804b12020-08-31 13:41:30 -0400605
606/*
607 * ep->mutex needs to be held because we could be hit by
608 * eventpoll_release_file() and epoll_ctl().
Davide Libenzi5071f972009-03-31 15:24:10 -0700609 */
Al Viro57804b12020-08-31 13:41:30 -0400610static void ep_start_scan(struct eventpoll *ep, struct list_head *txlist)
Davide Libenzi5071f972009-03-31 15:24:10 -0700611{
Davide Libenzi5071f972009-03-31 15:24:10 -0700612 /*
613 * Steal the ready list, and re-init the original one to the
614 * empty list. Also, set ep->ovflist to NULL so that events
615 * happening while looping w/out locks, are not lost. We cannot
616 * have the poll callback to queue directly on ep->rdllist,
617 * because we want the "sproc" callback to be able to do it
618 * in a lockless way.
619 */
Al Viro57804b12020-08-31 13:41:30 -0400620 lockdep_assert_irqs_enabled();
Roman Penyaeva218cc42019-03-07 16:28:53 -0800621 write_lock_irq(&ep->lock);
Al Virodb502f82020-08-31 13:06:51 -0400622 list_splice_init(&ep->rdllist, txlist);
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -0800623 WRITE_ONCE(ep->ovflist, NULL);
Roman Penyaeva218cc42019-03-07 16:28:53 -0800624 write_unlock_irq(&ep->lock);
Al Virodb502f82020-08-31 13:06:51 -0400625}
Davide Libenzi5071f972009-03-31 15:24:10 -0700626
Al Virodb502f82020-08-31 13:06:51 -0400627static void ep_done_scan(struct eventpoll *ep,
Al Virodb502f82020-08-31 13:06:51 -0400628 struct list_head *txlist)
629{
630 struct epitem *epi, *nepi;
Davide Libenzi5071f972009-03-31 15:24:10 -0700631
Roman Penyaeva218cc42019-03-07 16:28:53 -0800632 write_lock_irq(&ep->lock);
Davide Libenzi5071f972009-03-31 15:24:10 -0700633 /*
634 * During the time we spent inside the "sproc" callback, some
635 * other events might have been queued by the poll callback.
636 * We re-insert them inside the main ready-list here.
637 */
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -0800638 for (nepi = READ_ONCE(ep->ovflist); (epi = nepi) != NULL;
Davide Libenzi5071f972009-03-31 15:24:10 -0700639 nepi = epi->next, epi->next = EP_UNACTIVE_PTR) {
640 /*
641 * We need to check if the item is already in the list.
642 * During the "sproc" callback execution time, items are
643 * queued into ->ovflist but the "txlist" might already
644 * contain them, and the list_splice() below takes care of them.
645 */
Davidlohr Bueso992991c2018-08-21 21:58:26 -0700646 if (!ep_is_linked(epi)) {
Roman Penyaevc1411752019-03-07 16:28:46 -0800647 /*
648 * ->ovflist is LIFO, so we have to reverse it in order
649 * to keep in FIFO.
650 */
651 list_add(&epi->rdllink, &ep->rdllist);
Eric Wongeea1d582013-04-30 15:27:39 -0700652 ep_pm_stay_awake(epi);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200653 }
Davide Libenzi5071f972009-03-31 15:24:10 -0700654 }
655 /*
656 * We need to set back ep->ovflist to EP_UNACTIVE_PTR, so that after
657 * releasing the lock, events will be queued in the normal way inside
658 * ep->rdllist.
659 */
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -0800660 WRITE_ONCE(ep->ovflist, EP_UNACTIVE_PTR);
Davide Libenzi5071f972009-03-31 15:24:10 -0700661
662 /*
663 * Quickly re-inject items left on "txlist".
664 */
Al Virodb502f82020-08-31 13:06:51 -0400665 list_splice(txlist, &ep->rdllist);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200666 __pm_relax(ep->ws);
Davidlohr Bueso7fab29e2021-05-06 18:04:07 -0700667
668 if (!list_empty(&ep->rdllist)) {
669 if (waitqueue_active(&ep->wq))
670 wake_up(&ep->wq);
671 }
672
Roman Penyaeva218cc42019-03-07 16:28:53 -0800673 write_unlock_irq(&ep->lock);
Davide Libenzi5071f972009-03-31 15:24:10 -0700674}
675
Jason Baronae10b2b2013-11-12 15:10:16 -0800676static void epi_rcu_free(struct rcu_head *head)
677{
678 struct epitem *epi = container_of(head, struct epitem, rcu);
679 kmem_cache_free(epi_cache, epi);
680}
681
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682/*
Davide Libenzi7699acd2007-05-10 22:23:23 -0700683 * Removes a "struct epitem" from the eventpoll RB tree and deallocates
Davide Libenzic7ea7632007-05-15 01:40:47 -0700684 * all the associated resources. Must be called with "mtx" held.
Davide Libenzi7699acd2007-05-10 22:23:23 -0700685 */
686static int ep_remove(struct eventpoll *ep, struct epitem *epi)
687{
Davide Libenzi7699acd2007-05-10 22:23:23 -0700688 struct file *file = epi->ffd.file;
Al Viro319c1512020-10-01 20:45:51 -0400689 struct epitems_head *to_free;
690 struct hlist_head *head;
Davide Libenzi7699acd2007-05-10 22:23:23 -0700691
Davidlohr Bueso92e64172018-08-21 21:56:45 -0700692 lockdep_assert_irqs_enabled();
693
Davide Libenzi7699acd2007-05-10 22:23:23 -0700694 /*
Christoph Hellwigee8ef0a2018-08-21 21:56:26 -0700695 * Removes poll wait queue hooks.
Davide Libenzi7699acd2007-05-10 22:23:23 -0700696 */
697 ep_unregister_pollwait(ep, epi);
698
699 /* Remove the current item from the list of epoll hooks */
Jonathan Corbet68499912009-02-06 13:52:43 -0700700 spin_lock(&file->f_lock);
Al Viro319c1512020-10-01 20:45:51 -0400701 to_free = NULL;
702 head = file->f_ep;
703 if (head->first == &epi->fllink && !epi->fllink.next) {
704 file->f_ep = NULL;
705 if (!is_file_epoll(file)) {
706 struct epitems_head *v;
707 v = container_of(head, struct epitems_head, epitems);
708 if (!smp_load_acquire(&v->next))
709 to_free = v;
710 }
711 }
Al Viro44cdc1d2020-09-27 11:18:30 -0400712 hlist_del_rcu(&epi->fllink);
Jonathan Corbet68499912009-02-06 13:52:43 -0700713 spin_unlock(&file->f_lock);
Al Viro319c1512020-10-01 20:45:51 -0400714 free_ephead(to_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700716 rb_erase_cached(&epi->rbn, &ep->rbr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717
Roman Penyaeva218cc42019-03-07 16:28:53 -0800718 write_lock_irq(&ep->lock);
Davidlohr Bueso992991c2018-08-21 21:58:26 -0700719 if (ep_is_linked(epi))
Davide Libenzic7ea7632007-05-15 01:40:47 -0700720 list_del_init(&epi->rdllink);
Roman Penyaeva218cc42019-03-07 16:28:53 -0800721 write_unlock_irq(&ep->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722
Eric Wongeea1d582013-04-30 15:27:39 -0700723 wakeup_source_unregister(ep_wakeup_source(epi));
Jason Baronae10b2b2013-11-12 15:10:16 -0800724 /*
725 * At this point it is safe to free the eventpoll item. Use the union
726 * field epi->rcu, since we are trying to minimize the size of
727 * 'struct epitem'. The 'rbn' field is no longer in use. Protected by
728 * ep->mtx. The rcu read side, reverse_path_check_proc(), does not make
729 * use of the rbn field.
730 */
731 call_rcu(&epi->rcu, epi_rcu_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732
Nicholas Piggin1e1c1582021-09-07 20:00:00 -0700733 percpu_counter_dec(&ep->user->epoll_watches);
Davide Libenzi7ef99642008-12-01 13:13:55 -0800734
Davide Libenzic7ea7632007-05-15 01:40:47 -0700735 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736}
737
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738static void ep_free(struct eventpoll *ep)
739{
740 struct rb_node *rbp;
741 struct epitem *epi;
742
743 /* We need to release all tasks waiting for these file */
744 if (waitqueue_active(&ep->poll_wait))
Jason Baronefcdd352020-04-06 20:11:23 -0700745 ep_poll_safewake(ep, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746
747 /*
748 * We need to lock this because we could be hit by
749 * eventpoll_release_file() while we're freeing the "struct eventpoll".
Davide Libenzid47de162007-05-15 01:40:41 -0700750 * We do not need to hold "ep->mtx" here because the epoll file
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 * is on the way to be removed and no one has references to it
752 * anymore. The only hit might come from eventpoll_release_file() but
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300753 * holding "epmutex" is sufficient here.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754 */
Arjan van de Ven144efe32006-03-23 03:00:32 -0800755 mutex_lock(&epmutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756
757 /*
758 * Walks through the whole tree by unregistering poll callbacks.
759 */
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700760 for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761 epi = rb_entry(rbp, struct epitem, rbn);
762
763 ep_unregister_pollwait(ep, epi);
Eric Dumazet91cf5ab2013-09-11 14:24:06 -0700764 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765 }
766
767 /*
Davide Libenzi6192bd52007-05-08 00:25:41 -0700768 * Walks through the whole tree by freeing each "struct epitem". At this
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769 * point we are sure no poll callbacks will be lingering around, and also by
Davide Libenzid47de162007-05-15 01:40:41 -0700770 * holding "epmutex" we can be sure that no file cleanup code will hit
Roman Penyaeva218cc42019-03-07 16:28:53 -0800771 * us during this operation. So we can avoid the lock on "ep->lock".
Eric Wongddf676c2013-04-30 15:27:40 -0700772 * We do not need to lock ep->mtx, either, we only do it to prevent
773 * a lockdep warning.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774 */
Eric Wongddf676c2013-04-30 15:27:40 -0700775 mutex_lock(&ep->mtx);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700776 while ((rbp = rb_first_cached(&ep->rbr)) != NULL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777 epi = rb_entry(rbp, struct epitem, rbn);
778 ep_remove(ep, epi);
Eric Dumazet91cf5ab2013-09-11 14:24:06 -0700779 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780 }
Eric Wongddf676c2013-04-30 15:27:40 -0700781 mutex_unlock(&ep->mtx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782
Arjan van de Ven144efe32006-03-23 03:00:32 -0800783 mutex_unlock(&epmutex);
Davide Libenzid47de162007-05-15 01:40:41 -0700784 mutex_destroy(&ep->mtx);
Davide Libenzi7ef99642008-12-01 13:13:55 -0800785 free_uid(ep->user);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200786 wakeup_source_unregister(ep->ws);
Davide Libenzif0ee9aa2007-05-15 01:40:57 -0700787 kfree(ep);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788}
789
Davide Libenzi7699acd2007-05-10 22:23:23 -0700790static int ep_eventpoll_release(struct inode *inode, struct file *file)
791{
792 struct eventpoll *ep = file->private_data;
793
Davide Libenzif0ee9aa2007-05-15 01:40:57 -0700794 if (ep)
Davide Libenzi7699acd2007-05-10 22:23:23 -0700795 ep_free(ep);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700796
Davide Libenzi7699acd2007-05-10 22:23:23 -0700797 return 0;
798}
799
Al Viro2c0b71c2020-09-26 18:48:57 -0400800static __poll_t ep_item_poll(const struct epitem *epi, poll_table *pt, int depth);
Eric Wong450d89e2013-04-30 15:27:42 -0700801
Al Viroad9366b2020-09-26 18:32:48 -0400802static __poll_t __ep_eventpoll_poll(struct file *file, poll_table *wait, int depth)
Jason Baron37b5e522017-11-17 15:29:06 -0800803{
Al Viroad9366b2020-09-26 18:32:48 -0400804 struct eventpoll *ep = file->private_data;
805 LIST_HEAD(txlist);
Davide Libenzi5071f972009-03-31 15:24:10 -0700806 struct epitem *epi, *tmp;
Hans Verkuil626cf232012-03-23 15:02:27 -0700807 poll_table pt;
Al Viro2c0b71c2020-09-26 18:48:57 -0400808 __poll_t res = 0;
Davide Libenzi5071f972009-03-31 15:24:10 -0700809
Hans Verkuil626cf232012-03-23 15:02:27 -0700810 init_poll_funcptr(&pt, NULL);
Eric Wong450d89e2013-04-30 15:27:42 -0700811
Al Viroad9366b2020-09-26 18:32:48 -0400812 /* Insert inside our poll wait queue */
813 poll_wait(file, &ep->poll_wait, wait);
814
815 /*
816 * Proceed to find out if wanted events are really available inside
817 * the ready list.
818 */
819 mutex_lock_nested(&ep->mtx, depth);
820 ep_start_scan(ep, &txlist);
Al Viro2c0b71c2020-09-26 18:48:57 -0400821 list_for_each_entry_safe(epi, tmp, &txlist, rdllink) {
822 if (ep_item_poll(epi, &pt, depth + 1)) {
823 res = EPOLLIN | EPOLLRDNORM;
824 break;
Jason Baron37b5e522017-11-17 15:29:06 -0800825 } else {
Davide Libenzi5071f972009-03-31 15:24:10 -0700826 /*
827 * Item has been dropped into the ready list by the poll
828 * callback, but it's not actually ready, as far as
829 * caller requested events goes. We can remove it here.
830 */
Eric Wongeea1d582013-04-30 15:27:39 -0700831 __pm_relax(ep_wakeup_source(epi));
Davide Libenzi5071f972009-03-31 15:24:10 -0700832 list_del_init(&epi->rdllink);
Davide Libenzi296e2362009-03-31 15:24:11 -0700833 }
Davide Libenzi5071f972009-03-31 15:24:10 -0700834 }
Al Viroad9366b2020-09-26 18:32:48 -0400835 ep_done_scan(ep, &txlist);
836 mutex_unlock(&ep->mtx);
837 return res;
838}
Davide Libenzi5071f972009-03-31 15:24:10 -0700839
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840/*
841 * Differs from ep_eventpoll_poll() in that internal callers already have
842 * the ep->mtx so we need to start from depth=1, such that mutex_lock_nested()
843 * is correctly annotated.
844 */
845static __poll_t ep_item_poll(const struct epitem *epi, poll_table *pt,
846 int depth)
847{
Al Viroad9366b2020-09-26 18:32:48 -0400848 struct file *file = epi->ffd.file;
Al Viro1ec09972020-08-31 13:16:39 -0400849 __poll_t res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850
851 pt->_key = epi->event.events;
Al Viroad9366b2020-09-26 18:32:48 -0400852 if (!is_file_epoll(file))
853 res = vfs_poll(file, pt);
854 else
855 res = __ep_eventpoll_poll(file, pt, depth);
Al Viro1ec09972020-08-31 13:16:39 -0400856 return res & epi->event.events;
Davide Libenzi5071f972009-03-31 15:24:10 -0700857}
858
Linus Torvaldsa11e1d42018-06-28 09:43:44 -0700859static __poll_t ep_eventpoll_poll(struct file *file, poll_table *wait)
Davide Libenzi7699acd2007-05-10 22:23:23 -0700860{
Al Viroad9366b2020-09-26 18:32:48 -0400861 return __ep_eventpoll_poll(file, wait, 0);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700862}
863
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800864#ifdef CONFIG_PROC_FS
Joe Perchesa3816ab2014-09-29 16:08:25 -0700865static void ep_show_fdinfo(struct seq_file *m, struct file *f)
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800866{
867 struct eventpoll *ep = f->private_data;
868 struct rb_node *rbp;
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800869
870 mutex_lock(&ep->mtx);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700871 for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) {
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800872 struct epitem *epi = rb_entry(rbp, struct epitem, rbn);
Cyrill Gorcunov77493f02017-07-12 14:34:25 -0700873 struct inode *inode = file_inode(epi->ffd.file);
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800874
Cyrill Gorcunov77493f02017-07-12 14:34:25 -0700875 seq_printf(m, "tfd: %8d events: %8x data: %16llx "
876 " pos:%lli ino:%lx sdev:%x\n",
Joe Perchesa3816ab2014-09-29 16:08:25 -0700877 epi->ffd.fd, epi->event.events,
Cyrill Gorcunov77493f02017-07-12 14:34:25 -0700878 (long long)epi->event.data,
879 (long long)epi->ffd.file->f_pos,
880 inode->i_ino, inode->i_sb->s_dev);
Joe Perchesa3816ab2014-09-29 16:08:25 -0700881 if (seq_has_overflowed(m))
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800882 break;
883 }
884 mutex_unlock(&ep->mtx);
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800885}
886#endif
887
Davide Libenzi7699acd2007-05-10 22:23:23 -0700888/* File callbacks that implement the eventpoll file behaviour */
889static const struct file_operations eventpoll_fops = {
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800890#ifdef CONFIG_PROC_FS
891 .show_fdinfo = ep_show_fdinfo,
892#endif
Davide Libenzi7699acd2007-05-10 22:23:23 -0700893 .release = ep_eventpoll_release,
Linus Torvaldsa11e1d42018-06-28 09:43:44 -0700894 .poll = ep_eventpoll_poll,
Arnd Bergmann6038f372010-08-15 18:52:59 +0200895 .llseek = noop_llseek,
Davide Libenzi7699acd2007-05-10 22:23:23 -0700896};
897
Davide Libenzi7699acd2007-05-10 22:23:23 -0700898/*
899 * This is called from eventpoll_release() to unlink files from the eventpoll
900 * interface. We need to have this facility to cleanup correctly files that are
901 * closed without being removed from the eventpoll interface.
902 */
903void eventpoll_release_file(struct file *file)
904{
Davide Libenzi7699acd2007-05-10 22:23:23 -0700905 struct eventpoll *ep;
Al Viro44cdc1d2020-09-27 11:18:30 -0400906 struct epitem *epi;
907 struct hlist_node *next;
Davide Libenzi7699acd2007-05-10 22:23:23 -0700908
909 /*
Jonathan Corbet68499912009-02-06 13:52:43 -0700910 * We don't want to get "file->f_lock" because it is not
Davide Libenzi7699acd2007-05-10 22:23:23 -0700911 * necessary. It is not necessary because we're in the "struct file"
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300912 * cleanup path, and this means that no one is using this file anymore.
Davide Libenzi5071f972009-03-31 15:24:10 -0700913 * So, for example, epoll_ctl() cannot hit here since if we reach this
Davide Libenzi67647d02007-05-15 01:40:52 -0700914 * point, the file counter already went to zero and fget() would fail.
Davide Libenzid47de162007-05-15 01:40:41 -0700915 * The only hit might come from ep_free() but by holding the mutex
Davide Libenzi7699acd2007-05-10 22:23:23 -0700916 * will correctly serialize the operation. We do need to acquire
Davide Libenzid47de162007-05-15 01:40:41 -0700917 * "ep->mtx" after "epmutex" because ep_remove() requires it when called
Davide Libenzi7699acd2007-05-10 22:23:23 -0700918 * from anywhere but ep_free().
Jonathan Corbet68499912009-02-06 13:52:43 -0700919 *
920 * Besides, ep_remove() acquires the lock, so we can't hold it here.
Davide Libenzi7699acd2007-05-10 22:23:23 -0700921 */
922 mutex_lock(&epmutex);
Al Viro319c1512020-10-01 20:45:51 -0400923 if (unlikely(!file->f_ep)) {
924 mutex_unlock(&epmutex);
925 return;
926 }
927 hlist_for_each_entry_safe(epi, next, file->f_ep, fllink) {
Davide Libenzi7699acd2007-05-10 22:23:23 -0700928 ep = epi->ep;
Nelson Elhaged8805e62011-10-31 17:13:14 -0700929 mutex_lock_nested(&ep->mtx, 0);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700930 ep_remove(ep, epi);
Davide Libenzid47de162007-05-15 01:40:41 -0700931 mutex_unlock(&ep->mtx);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700932 }
Davide Libenzi7699acd2007-05-10 22:23:23 -0700933 mutex_unlock(&epmutex);
934}
935
936static int ep_alloc(struct eventpoll **pep)
937{
Davide Libenzi7ef99642008-12-01 13:13:55 -0800938 int error;
939 struct user_struct *user;
940 struct eventpoll *ep;
Davide Libenzi7699acd2007-05-10 22:23:23 -0700941
Davide Libenzi7ef99642008-12-01 13:13:55 -0800942 user = get_current_user();
Davide Libenzi7ef99642008-12-01 13:13:55 -0800943 error = -ENOMEM;
944 ep = kzalloc(sizeof(*ep), GFP_KERNEL);
945 if (unlikely(!ep))
946 goto free_uid;
Davide Libenzi7699acd2007-05-10 22:23:23 -0700947
Davide Libenzid47de162007-05-15 01:40:41 -0700948 mutex_init(&ep->mtx);
Roman Penyaeva218cc42019-03-07 16:28:53 -0800949 rwlock_init(&ep->lock);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700950 init_waitqueue_head(&ep->wq);
951 init_waitqueue_head(&ep->poll_wait);
952 INIT_LIST_HEAD(&ep->rdllist);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700953 ep->rbr = RB_ROOT_CACHED;
Davide Libenzid47de162007-05-15 01:40:41 -0700954 ep->ovflist = EP_UNACTIVE_PTR;
Davide Libenzi7ef99642008-12-01 13:13:55 -0800955 ep->user = user;
Davide Libenzi7699acd2007-05-10 22:23:23 -0700956
957 *pep = ep;
958
Davide Libenzi7699acd2007-05-10 22:23:23 -0700959 return 0;
Davide Libenzi7ef99642008-12-01 13:13:55 -0800960
961free_uid:
962 free_uid(user);
963 return error;
Davide Libenzi7699acd2007-05-10 22:23:23 -0700964}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965
966/*
Davide Libenzic7ea7632007-05-15 01:40:47 -0700967 * Search the file inside the eventpoll tree. The RB tree operations
968 * are protected by the "mtx" mutex, and ep_find() must be called with
969 * "mtx" held.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970 */
971static struct epitem *ep_find(struct eventpoll *ep, struct file *file, int fd)
972{
973 int kcmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974 struct rb_node *rbp;
975 struct epitem *epi, *epir = NULL;
976 struct epoll_filefd ffd;
977
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700978 ep_set_ffd(&ffd, file, fd);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700979 for (rbp = ep->rbr.rb_root.rb_node; rbp; ) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980 epi = rb_entry(rbp, struct epitem, rbn);
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700981 kcmp = ep_cmp_ffd(&ffd, &epi->ffd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700982 if (kcmp > 0)
983 rbp = rbp->rb_right;
984 else if (kcmp < 0)
985 rbp = rbp->rb_left;
986 else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987 epir = epi;
988 break;
989 }
990 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991
Linus Torvalds1da177e2005-04-16 15:20:36 -0700992 return epir;
993}
994
Chris Wilsonbfe39112021-02-05 22:00:12 +0000995#ifdef CONFIG_KCMP
Cyrill Gorcunov0791e362017-07-12 14:34:28 -0700996static struct epitem *ep_find_tfd(struct eventpoll *ep, int tfd, unsigned long toff)
997{
998 struct rb_node *rbp;
999 struct epitem *epi;
1000
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001001 for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) {
Cyrill Gorcunov0791e362017-07-12 14:34:28 -07001002 epi = rb_entry(rbp, struct epitem, rbn);
1003 if (epi->ffd.fd == tfd) {
1004 if (toff == 0)
1005 return epi;
1006 else
1007 toff--;
1008 }
1009 cond_resched();
1010 }
1011
1012 return NULL;
1013}
1014
1015struct file *get_epoll_tfile_raw_ptr(struct file *file, int tfd,
1016 unsigned long toff)
1017{
1018 struct file *file_raw;
1019 struct eventpoll *ep;
1020 struct epitem *epi;
1021
1022 if (!is_file_epoll(file))
1023 return ERR_PTR(-EINVAL);
1024
1025 ep = file->private_data;
1026
1027 mutex_lock(&ep->mtx);
1028 epi = ep_find_tfd(ep, tfd, toff);
1029 if (epi)
1030 file_raw = epi->ffd.file;
1031 else
1032 file_raw = ERR_PTR(-ENOENT);
1033 mutex_unlock(&ep->mtx);
1034
1035 return file_raw;
1036}
Chris Wilsonbfe39112021-02-05 22:00:12 +00001037#endif /* CONFIG_KCMP */
Cyrill Gorcunov0791e362017-07-12 14:34:28 -07001038
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001039/*
Roman Penyaeva218cc42019-03-07 16:28:53 -08001040 * Adds a new entry to the tail of the list in a lockless way, i.e.
1041 * multiple CPUs are allowed to call this function concurrently.
1042 *
1043 * Beware: it is necessary to prevent any other modifications of the
1044 * existing list until all changes are completed, in other words
1045 * concurrent list_add_tail_lockless() calls should be protected
1046 * with a read lock, where write lock acts as a barrier which
1047 * makes sure all list_add_tail_lockless() calls are fully
1048 * completed.
1049 *
1050 * Also an element can be locklessly added to the list only in one
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001051 * direction i.e. either to the tail or to the head, otherwise
Roman Penyaeva218cc42019-03-07 16:28:53 -08001052 * concurrent access will corrupt the list.
1053 *
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001054 * Return: %false if element has been already added to the list, %true
Roman Penyaeva218cc42019-03-07 16:28:53 -08001055 * otherwise.
1056 */
1057static inline bool list_add_tail_lockless(struct list_head *new,
1058 struct list_head *head)
1059{
1060 struct list_head *prev;
1061
1062 /*
1063 * This is simple 'new->next = head' operation, but cmpxchg()
1064 * is used in order to detect that same element has been just
1065 * added to the list from another CPU: the winner observes
1066 * new->next == new.
1067 */
1068 if (cmpxchg(&new->next, new, head) != new)
1069 return false;
1070
1071 /*
1072 * Initially ->next of a new element must be updated with the head
1073 * (we are inserting to the tail) and only then pointers are atomically
1074 * exchanged. XCHG guarantees memory ordering, thus ->next should be
1075 * updated before pointers are actually swapped and pointers are
1076 * swapped before prev->next is updated.
1077 */
1078
1079 prev = xchg(&head->prev, new);
1080
1081 /*
1082 * It is safe to modify prev->next and new->prev, because a new element
1083 * is added only to the tail and new->next is updated before XCHG.
1084 */
1085
1086 prev->next = new;
1087 new->prev = prev;
1088
1089 return true;
1090}
1091
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001092/*
Roman Penyaeva218cc42019-03-07 16:28:53 -08001093 * Chains a new epi entry to the tail of the ep->ovflist in a lockless way,
1094 * i.e. multiple CPUs are allowed to call this function concurrently.
1095 *
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001096 * Return: %false if epi element has been already chained, %true otherwise.
Roman Penyaeva218cc42019-03-07 16:28:53 -08001097 */
1098static inline bool chain_epi_lockless(struct epitem *epi)
1099{
1100 struct eventpoll *ep = epi->ep;
1101
Khazhismel Kumykov0c54a6a2020-05-07 18:35:59 -07001102 /* Fast preliminary check */
1103 if (epi->next != EP_UNACTIVE_PTR)
1104 return false;
1105
Roman Penyaeva218cc42019-03-07 16:28:53 -08001106 /* Check that the same epi has not been just chained from another CPU */
1107 if (cmpxchg(&epi->next, EP_UNACTIVE_PTR, NULL) != EP_UNACTIVE_PTR)
1108 return false;
1109
1110 /* Atomically exchange tail */
1111 epi->next = xchg(&ep->ovflist, epi);
1112
1113 return true;
1114}
1115
Linus Torvalds1da177e2005-04-16 15:20:36 -07001116/*
Davide Libenzi7699acd2007-05-10 22:23:23 -07001117 * This is the callback that is passed to the wait queue wakeup
Daniel Balutabf6a41d2011-01-30 23:42:29 +02001118 * mechanism. It is called by the stored file descriptors when they
Davide Libenzi7699acd2007-05-10 22:23:23 -07001119 * have events to report.
Roman Penyaeva218cc42019-03-07 16:28:53 -08001120 *
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001121 * This callback takes a read lock in order not to contend with concurrent
1122 * events from another file descriptor, thus all modifications to ->rdllist
Roman Penyaeva218cc42019-03-07 16:28:53 -08001123 * or ->ovflist are lockless. Read lock is paired with the write lock from
1124 * ep_scan_ready_list(), which stops all list modifications and guarantees
1125 * that lists state is seen correctly.
1126 *
1127 * Another thing worth to mention is that ep_poll_callback() can be called
1128 * concurrently for the same @epi from different CPUs if poll table was inited
1129 * with several wait queues entries. Plural wakeup from different CPUs of a
1130 * single wait queue is serialized by wq.lock, but the case when multiple wait
1131 * queues are used should be detected accordingly. This is detected using
1132 * cmpxchg() operation.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001133 */
Ingo Molnarac6424b2017-06-20 12:06:13 +02001134static int ep_poll_callback(wait_queue_entry_t *wait, unsigned mode, int sync, void *key)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001135{
Davide Libenzi7699acd2007-05-10 22:23:23 -07001136 int pwake = 0;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001137 struct epitem *epi = ep_item_from_wait(wait);
1138 struct eventpoll *ep = epi->ep;
Al Viro3ad6f932017-07-03 20:14:56 -04001139 __poll_t pollflags = key_to_poll(key);
Roman Penyaeva218cc42019-03-07 16:28:53 -08001140 unsigned long flags;
Jason Barondf0108c2016-01-20 14:59:24 -08001141 int ewake = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001142
Roman Penyaeva218cc42019-03-07 16:28:53 -08001143 read_lock_irqsave(&ep->lock, flags);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001144
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -07001145 ep_set_busy_poll_napi_id(epi);
1146
Davide Libenzi7699acd2007-05-10 22:23:23 -07001147 /*
1148 * If the event mask does not contain any poll(2) event, we consider the
1149 * descriptor to be disabled. This condition is likely the effect of the
1150 * EPOLLONESHOT bit that disables the descriptor when an event is received,
1151 * until the next EPOLL_CTL_MOD will be issued.
1152 */
1153 if (!(epi->event.events & ~EP_PRIVATE_BITS))
Davide Libenzid47de162007-05-15 01:40:41 -07001154 goto out_unlock;
1155
1156 /*
Davide Libenzi2dfa4ee2009-03-31 15:24:22 -07001157 * Check the events coming with the callback. At this stage, not
1158 * every device reports the events in the "key" parameter of the
1159 * callback. We need to be able to handle both cases here, hence the
1160 * test for "key" != NULL before the event match test.
1161 */
Al Viro3ad6f932017-07-03 20:14:56 -04001162 if (pollflags && !(pollflags & epi->event.events))
Davide Libenzi2dfa4ee2009-03-31 15:24:22 -07001163 goto out_unlock;
1164
1165 /*
Daniel Balutabf6a41d2011-01-30 23:42:29 +02001166 * If we are transferring events to userspace, we can hold no locks
Davide Libenzid47de162007-05-15 01:40:41 -07001167 * (because we're accessing user memory, and because of linux f_op->poll()
Daniel Balutabf6a41d2011-01-30 23:42:29 +02001168 * semantics). All the events that happen during that period of time are
Davide Libenzid47de162007-05-15 01:40:41 -07001169 * chained in ep->ovflist and requeued later on.
1170 */
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001171 if (READ_ONCE(ep->ovflist) != EP_UNACTIVE_PTR) {
Khazhismel Kumykov0c54a6a2020-05-07 18:35:59 -07001172 if (chain_epi_lockless(epi))
Roman Penyaevc3e320b2019-03-07 16:28:49 -08001173 ep_pm_stay_awake_rcu(epi);
Khazhismel Kumykov0c54a6a2020-05-07 18:35:59 -07001174 } else if (!ep_is_linked(epi)) {
1175 /* In the usual case, add event to ready list. */
1176 if (list_add_tail_lockless(&epi->rdllink, &ep->rdllist))
1177 ep_pm_stay_awake_rcu(epi);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001178 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07001179
Davide Libenzi7699acd2007-05-10 22:23:23 -07001180 /*
1181 * Wake up ( if active ) both the eventpoll wait list and the ->poll()
1182 * wait list.
1183 */
Jason Barondf0108c2016-01-20 14:59:24 -08001184 if (waitqueue_active(&ep->wq)) {
Jason Baronb6a515c2016-02-05 15:37:04 -08001185 if ((epi->event.events & EPOLLEXCLUSIVE) &&
Al Viro3ad6f932017-07-03 20:14:56 -04001186 !(pollflags & POLLFREE)) {
1187 switch (pollflags & EPOLLINOUT_BITS) {
Linus Torvaldsa9a08842018-02-11 14:34:03 -08001188 case EPOLLIN:
1189 if (epi->event.events & EPOLLIN)
Jason Baronb6a515c2016-02-05 15:37:04 -08001190 ewake = 1;
1191 break;
Linus Torvaldsa9a08842018-02-11 14:34:03 -08001192 case EPOLLOUT:
1193 if (epi->event.events & EPOLLOUT)
Jason Baronb6a515c2016-02-05 15:37:04 -08001194 ewake = 1;
1195 break;
1196 case 0:
1197 ewake = 1;
1198 break;
1199 }
1200 }
Roman Penyaeva218cc42019-03-07 16:28:53 -08001201 wake_up(&ep->wq);
Jason Barondf0108c2016-01-20 14:59:24 -08001202 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07001203 if (waitqueue_active(&ep->poll_wait))
1204 pwake++;
1205
Davide Libenzid47de162007-05-15 01:40:41 -07001206out_unlock:
Roman Penyaeva218cc42019-03-07 16:28:53 -08001207 read_unlock_irqrestore(&ep->lock, flags);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001208
1209 /* We have to call this outside the lock */
1210 if (pwake)
Jason Baronefcdd352020-04-06 20:11:23 -07001211 ep_poll_safewake(ep, epi);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001212
Oleg Nesterov138e4ad2017-09-01 18:55:33 +02001213 if (!(epi->event.events & EPOLLEXCLUSIVE))
1214 ewake = 1;
Jason Barondf0108c2016-01-20 14:59:24 -08001215
Al Viro3ad6f932017-07-03 20:14:56 -04001216 if (pollflags & POLLFREE) {
Oleg Nesterov138e4ad2017-09-01 18:55:33 +02001217 /*
1218 * If we race with ep_remove_wait_queue() it can miss
1219 * ->whead = NULL and do another remove_wait_queue() after
1220 * us, so we can't use __remove_wait_queue().
1221 */
1222 list_del_init(&wait->entry);
1223 /*
1224 * ->whead != NULL protects us from the race with ep_free()
1225 * or ep_remove(), ep_remove_wait_queue() takes whead->lock
1226 * held by the caller. Once we nullify it, nothing protects
1227 * ep/epi or even wait.
1228 */
1229 smp_store_release(&ep_pwq_from_wait(wait)->whead, NULL);
1230 }
1231
1232 return ewake;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001233}
1234
Linus Torvalds1da177e2005-04-16 15:20:36 -07001235/*
1236 * This is the callback that is used to add our wait queue to the
1237 * target file wakeup lists.
1238 */
1239static void ep_ptable_queue_proc(struct file *file, wait_queue_head_t *whead,
1240 poll_table *pt)
1241{
Al Viro364f3742020-09-02 11:55:09 -04001242 struct ep_pqueue *epq = container_of(pt, struct ep_pqueue, pt);
1243 struct epitem *epi = epq->epi;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001244 struct eppoll_entry *pwq;
1245
Al Viro364f3742020-09-02 11:55:09 -04001246 if (unlikely(!epi)) // an earlier allocation has failed
1247 return;
1248
1249 pwq = kmem_cache_alloc(pwq_cache, GFP_KERNEL);
1250 if (unlikely(!pwq)) {
1251 epq->epi = NULL;
1252 return;
Davide Libenzi296e2362009-03-31 15:24:11 -07001253 }
Al Viro364f3742020-09-02 11:55:09 -04001254
1255 init_waitqueue_func_entry(&pwq->wait, ep_poll_callback);
1256 pwq->whead = whead;
1257 pwq->base = epi;
1258 if (epi->event.events & EPOLLEXCLUSIVE)
1259 add_wait_queue_exclusive(whead, &pwq->wait);
1260 else
1261 add_wait_queue(whead, &pwq->wait);
1262 pwq->next = epi->pwqlist;
1263 epi->pwqlist = pwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264}
1265
Linus Torvalds1da177e2005-04-16 15:20:36 -07001266static void ep_rbtree_insert(struct eventpoll *ep, struct epitem *epi)
1267{
1268 int kcmp;
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001269 struct rb_node **p = &ep->rbr.rb_root.rb_node, *parent = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001270 struct epitem *epic;
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001271 bool leftmost = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272
1273 while (*p) {
1274 parent = *p;
1275 epic = rb_entry(parent, struct epitem, rbn);
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001276 kcmp = ep_cmp_ffd(&epi->ffd, &epic->ffd);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001277 if (kcmp > 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001278 p = &parent->rb_right;
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001279 leftmost = false;
1280 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281 p = &parent->rb_left;
1282 }
1283 rb_link_node(&epi->rbn, parent, p);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001284 rb_insert_color_cached(&epi->rbn, &ep->rbr, leftmost);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001285}
1286
Andrew Mortona80a6b82012-11-08 15:53:35 -08001287
1288
Jason Baron28d82dc2012-01-12 17:17:43 -08001289#define PATH_ARR_SIZE 5
1290/*
1291 * These are the number paths of length 1 to 5, that we are allowing to emanate
1292 * from a single file of interest. For example, we allow 1000 paths of length
1293 * 1, to emanate from each file of interest. This essentially represents the
1294 * potential wakeup paths, which need to be limited in order to avoid massive
1295 * uncontrolled wakeup storms. The common use case should be a single ep which
1296 * is connected to n file sources. In this case each file source has 1 path
1297 * of length 1. Thus, the numbers below should be more than sufficient. These
1298 * path limits are enforced during an EPOLL_CTL_ADD operation, since a modify
1299 * and delete can't add additional paths. Protected by the epmutex.
1300 */
1301static const int path_limits[PATH_ARR_SIZE] = { 1000, 500, 100, 50, 10 };
1302static int path_count[PATH_ARR_SIZE];
1303
1304static int path_count_inc(int nests)
1305{
Jason Baron93dc6102012-03-16 16:34:03 -04001306 /* Allow an arbitrary number of depth 1 paths */
1307 if (nests == 0)
1308 return 0;
1309
Jason Baron28d82dc2012-01-12 17:17:43 -08001310 if (++path_count[nests] > path_limits[nests])
1311 return -1;
1312 return 0;
1313}
1314
1315static void path_count_init(void)
1316{
1317 int i;
1318
1319 for (i = 0; i < PATH_ARR_SIZE; i++)
1320 path_count[i] = 0;
1321}
1322
Al Viro319c1512020-10-01 20:45:51 -04001323static int reverse_path_check_proc(struct hlist_head *refs, int depth)
Jason Baron28d82dc2012-01-12 17:17:43 -08001324{
1325 int error = 0;
Jason Baron28d82dc2012-01-12 17:17:43 -08001326 struct epitem *epi;
1327
Al Viro0c320f72020-09-25 19:48:56 -04001328 if (depth > EP_MAX_NESTS) /* too deep nesting */
Al Viro99d84d42020-08-22 23:08:37 -04001329 return -1;
1330
Jason Baronae10b2b2013-11-12 15:10:16 -08001331 /* CTL_DEL can remove links here, but that can't increase our count */
Al Viro319c1512020-10-01 20:45:51 -04001332 hlist_for_each_entry_rcu(epi, refs, fllink) {
1333 struct hlist_head *refs = &epi->ep->refs;
1334 if (hlist_empty(refs))
Al Virod16312a2020-09-26 15:54:05 -04001335 error = path_count_inc(depth);
1336 else
Al Viro319c1512020-10-01 20:45:51 -04001337 error = reverse_path_check_proc(refs, depth + 1);
Al Virod16312a2020-09-26 15:54:05 -04001338 if (error != 0)
1339 break;
Jason Baron28d82dc2012-01-12 17:17:43 -08001340 }
1341 return error;
1342}
1343
1344/**
Al Viro319c1512020-10-01 20:45:51 -04001345 * reverse_path_check - The tfile_check_list is list of epitem_head, which have
Jason Baron28d82dc2012-01-12 17:17:43 -08001346 * links that are proposed to be newly added. We need to
1347 * make sure that those added links don't add too many
1348 * paths such that we will spend all our time waking up
1349 * eventpoll objects.
1350 *
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001351 * Return: %zero if the proposed links don't create too many paths,
1352 * %-1 otherwise.
Jason Baron28d82dc2012-01-12 17:17:43 -08001353 */
1354static int reverse_path_check(void)
1355{
Al Viro319c1512020-10-01 20:45:51 -04001356 struct epitems_head *p;
Jason Baron28d82dc2012-01-12 17:17:43 -08001357
Al Viro319c1512020-10-01 20:45:51 -04001358 for (p = tfile_check_list; p != EP_UNACTIVE_PTR; p = p->next) {
1359 int error;
Jason Baron28d82dc2012-01-12 17:17:43 -08001360 path_count_init();
Al Virob62d2702020-10-01 14:11:00 -04001361 rcu_read_lock();
Al Viro319c1512020-10-01 20:45:51 -04001362 error = reverse_path_check_proc(&p->epitems, 0);
Al Virob62d2702020-10-01 14:11:00 -04001363 rcu_read_unlock();
Jason Baron28d82dc2012-01-12 17:17:43 -08001364 if (error)
Al Viro319c1512020-10-01 20:45:51 -04001365 return error;
Jason Baron28d82dc2012-01-12 17:17:43 -08001366 }
Al Viro319c1512020-10-01 20:45:51 -04001367 return 0;
Jason Baron28d82dc2012-01-12 17:17:43 -08001368}
1369
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001370static int ep_create_wakeup_source(struct epitem *epi)
1371{
Al Viro3701cb52020-09-24 19:41:58 -04001372 struct name_snapshot n;
Eric Wongeea1d582013-04-30 15:27:39 -07001373 struct wakeup_source *ws;
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001374
1375 if (!epi->ep->ws) {
Tri Voc8377ad2019-08-06 18:48:46 -07001376 epi->ep->ws = wakeup_source_register(NULL, "eventpoll");
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001377 if (!epi->ep->ws)
1378 return -ENOMEM;
1379 }
1380
Al Viro3701cb52020-09-24 19:41:58 -04001381 take_dentry_name_snapshot(&n, epi->ffd.file->f_path.dentry);
1382 ws = wakeup_source_register(NULL, n.name.name);
1383 release_dentry_name_snapshot(&n);
Eric Wongeea1d582013-04-30 15:27:39 -07001384
1385 if (!ws)
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001386 return -ENOMEM;
Eric Wongeea1d582013-04-30 15:27:39 -07001387 rcu_assign_pointer(epi->ws, ws);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001388
1389 return 0;
1390}
1391
Eric Wongeea1d582013-04-30 15:27:39 -07001392/* rare code path, only used when EPOLL_CTL_MOD removes a wakeup source */
1393static noinline void ep_destroy_wakeup_source(struct epitem *epi)
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001394{
Eric Wongeea1d582013-04-30 15:27:39 -07001395 struct wakeup_source *ws = ep_wakeup_source(epi);
1396
Eric Wongd6d67e72013-04-30 15:27:43 -07001397 RCU_INIT_POINTER(epi->ws, NULL);
Eric Wongeea1d582013-04-30 15:27:39 -07001398
1399 /*
1400 * wait for ep_pm_stay_awake_rcu to finish, synchronize_rcu is
1401 * used internally by wakeup_source_remove, too (called by
1402 * wakeup_source_unregister), so we cannot use call_rcu
1403 */
1404 synchronize_rcu();
1405 wakeup_source_unregister(ws);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001406}
1407
Al Viro319c1512020-10-01 20:45:51 -04001408static int attach_epitem(struct file *file, struct epitem *epi)
1409{
1410 struct epitems_head *to_free = NULL;
1411 struct hlist_head *head = NULL;
1412 struct eventpoll *ep = NULL;
1413
1414 if (is_file_epoll(file))
1415 ep = file->private_data;
1416
1417 if (ep) {
1418 head = &ep->refs;
1419 } else if (!READ_ONCE(file->f_ep)) {
1420allocate:
1421 to_free = kmem_cache_zalloc(ephead_cache, GFP_KERNEL);
1422 if (!to_free)
1423 return -ENOMEM;
1424 head = &to_free->epitems;
1425 }
1426 spin_lock(&file->f_lock);
1427 if (!file->f_ep) {
1428 if (unlikely(!head)) {
1429 spin_unlock(&file->f_lock);
1430 goto allocate;
1431 }
1432 file->f_ep = head;
1433 to_free = NULL;
1434 }
1435 hlist_add_head_rcu(&epi->fllink, file->f_ep);
1436 spin_unlock(&file->f_lock);
1437 free_ephead(to_free);
1438 return 0;
1439}
1440
Davide Libenzic7ea7632007-05-15 01:40:47 -07001441/*
1442 * Must be called with "mtx" held.
1443 */
Al Virobec1a5022017-11-28 19:43:33 -05001444static int ep_insert(struct eventpoll *ep, const struct epoll_event *event,
Jason Baron67347fe2013-11-12 15:10:18 -08001445 struct file *tfile, int fd, int full_check)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446{
Al Virod85e2aa2018-02-01 15:24:58 -05001447 int error, pwake = 0;
1448 __poll_t revents;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001449 struct epitem *epi;
1450 struct ep_pqueue epq;
Al Viro85353e92020-09-26 18:15:26 -04001451 struct eventpoll *tep = NULL;
1452
1453 if (is_file_epoll(tfile))
1454 tep = tfile->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001455
Davidlohr Bueso92e64172018-08-21 21:56:45 -07001456 lockdep_assert_irqs_enabled();
1457
Nicholas Piggin1e1c1582021-09-07 20:00:00 -07001458 if (unlikely(percpu_counter_compare(&ep->user->epoll_watches,
1459 max_user_watches) >= 0))
Davide Libenzi7ef99642008-12-01 13:13:55 -08001460 return -ENOSPC;
Nicholas Piggin1e1c1582021-09-07 20:00:00 -07001461 percpu_counter_inc(&ep->user->epoll_watches);
1462
1463 if (!(epi = kmem_cache_zalloc(epi_cache, GFP_KERNEL))) {
1464 percpu_counter_dec(&ep->user->epoll_watches);
Davide Libenzi7ef99642008-12-01 13:13:55 -08001465 return -ENOMEM;
Nicholas Piggin1e1c1582021-09-07 20:00:00 -07001466 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467
1468 /* Item initialization follow here ... */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001469 INIT_LIST_HEAD(&epi->rdllink);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001470 epi->ep = ep;
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001471 ep_set_ffd(&epi->ffd, tfile, fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001472 epi->event = *event;
Davide Libenzid47de162007-05-15 01:40:41 -07001473 epi->next = EP_UNACTIVE_PTR;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001474
Al Viro85353e92020-09-26 18:15:26 -04001475 if (tep)
1476 mutex_lock_nested(&tep->mtx, 1);
Al Virof8d4f442020-09-09 22:25:06 -04001477 /* Add the current item to the list of active epoll hook for this file */
Al Viro319c1512020-10-01 20:45:51 -04001478 if (unlikely(attach_epitem(tfile, epi) < 0)) {
Al Viro319c1512020-10-01 20:45:51 -04001479 if (tep)
1480 mutex_unlock(&tep->mtx);
Nicholas Piggin1e1c1582021-09-07 20:00:00 -07001481 kmem_cache_free(epi_cache, epi);
1482 percpu_counter_dec(&ep->user->epoll_watches);
Al Viro319c1512020-10-01 20:45:51 -04001483 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001484 }
1485
Al Viro319c1512020-10-01 20:45:51 -04001486 if (full_check && !tep)
1487 list_file(tfile);
1488
Al Virof8d4f442020-09-09 22:25:06 -04001489 /*
1490 * Add the current item to the RB tree. All RB tree operations are
1491 * protected by "mtx", and ep_insert() is called with "mtx" held.
1492 */
1493 ep_rbtree_insert(ep, epi);
Al Viro85353e92020-09-26 18:15:26 -04001494 if (tep)
1495 mutex_unlock(&tep->mtx);
Al Virof8d4f442020-09-09 22:25:06 -04001496
1497 /* now check if we've created too many backpaths */
Al Viroe3e096e2020-09-26 18:09:29 -04001498 if (unlikely(full_check && reverse_path_check())) {
1499 ep_remove(ep, epi);
1500 return -EINVAL;
1501 }
Al Virof8d4f442020-09-09 22:25:06 -04001502
Al Virod1ec50a2020-09-27 11:03:32 -04001503 if (epi->event.events & EPOLLWAKEUP) {
1504 error = ep_create_wakeup_source(epi);
1505 if (error) {
1506 ep_remove(ep, epi);
1507 return error;
1508 }
1509 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001510
1511 /* Initialize the poll table using the queue callback */
1512 epq.epi = epi;
1513 init_poll_funcptr(&epq.pt, ep_ptable_queue_proc);
1514
1515 /*
1516 * Attach the item to the poll hooks and get current event bits.
1517 * We can safely use the file* here because its usage count has
Davide Libenzic7ea7632007-05-15 01:40:47 -07001518 * been increased by the caller of this function. Note that after
1519 * this operation completes, the poll callback can start hitting
1520 * the new item.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001521 */
Jason Baron37b5e522017-11-17 15:29:06 -08001522 revents = ep_item_poll(epi, &epq.pt, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001523
1524 /*
1525 * We have to check if something went wrong during the poll wait queue
1526 * install process. Namely an allocation for a wait queue failed due
1527 * high memory pressure.
1528 */
Al Viroe3e096e2020-09-26 18:09:29 -04001529 if (unlikely(!epq.epi)) {
1530 ep_remove(ep, epi);
1531 return -ENOMEM;
1532 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001533
Davide Libenzic7ea7632007-05-15 01:40:47 -07001534 /* We have to drop the new item inside our item list to keep track of it */
Roman Penyaeva218cc42019-03-07 16:28:53 -08001535 write_lock_irq(&ep->lock);
Davide Libenzic7ea7632007-05-15 01:40:47 -07001536
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -07001537 /* record NAPI ID of new item if present */
1538 ep_set_busy_poll_napi_id(epi);
1539
Linus Torvalds1da177e2005-04-16 15:20:36 -07001540 /* If the file is already "ready" we drop it inside the ready list */
Davidlohr Bueso992991c2018-08-21 21:58:26 -07001541 if (revents && !ep_is_linked(epi)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001542 list_add_tail(&epi->rdllink, &ep->rdllist);
Eric Wongeea1d582013-04-30 15:27:39 -07001543 ep_pm_stay_awake(epi);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001544
1545 /* Notify waiting tasks that events are available */
1546 if (waitqueue_active(&ep->wq))
Roman Penyaeva218cc42019-03-07 16:28:53 -08001547 wake_up(&ep->wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001548 if (waitqueue_active(&ep->poll_wait))
1549 pwake++;
1550 }
1551
Roman Penyaeva218cc42019-03-07 16:28:53 -08001552 write_unlock_irq(&ep->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001553
1554 /* We have to call this outside the lock */
1555 if (pwake)
Jason Baronefcdd352020-04-06 20:11:23 -07001556 ep_poll_safewake(ep, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001557
Linus Torvalds1da177e2005-04-16 15:20:36 -07001558 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559}
1560
Linus Torvalds1da177e2005-04-16 15:20:36 -07001561/*
1562 * Modify the interest event mask by dropping an event if the new mask
Davide Libenzic7ea7632007-05-15 01:40:47 -07001563 * has a match in the current file status. Must be called with "mtx" held.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001564 */
Al Virobec1a5022017-11-28 19:43:33 -05001565static int ep_modify(struct eventpoll *ep, struct epitem *epi,
1566 const struct epoll_event *event)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001567{
1568 int pwake = 0;
Hans Verkuil626cf232012-03-23 15:02:27 -07001569 poll_table pt;
1570
Davidlohr Bueso92e64172018-08-21 21:56:45 -07001571 lockdep_assert_irqs_enabled();
1572
Hans Verkuil626cf232012-03-23 15:02:27 -07001573 init_poll_funcptr(&pt, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001574
1575 /*
Tony Battersbye057e152009-03-31 15:24:15 -07001576 * Set the new event interest mask before calling f_op->poll();
1577 * otherwise we might miss an event that happens between the
1578 * f_op->poll() call and the new event set registering.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001579 */
Eric Wong128dd172013-01-01 21:20:27 +00001580 epi->event.events = event->events; /* need barrier below */
Tony Battersbye057e152009-03-31 15:24:15 -07001581 epi->event.data = event->data; /* protected by mtx */
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001582 if (epi->event.events & EPOLLWAKEUP) {
Eric Wongeea1d582013-04-30 15:27:39 -07001583 if (!ep_has_wakeup_source(epi))
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001584 ep_create_wakeup_source(epi);
Eric Wongeea1d582013-04-30 15:27:39 -07001585 } else if (ep_has_wakeup_source(epi)) {
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001586 ep_destroy_wakeup_source(epi);
1587 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588
1589 /*
Eric Wong128dd172013-01-01 21:20:27 +00001590 * The following barrier has two effects:
1591 *
1592 * 1) Flush epi changes above to other CPUs. This ensures
1593 * we do not miss events from ep_poll_callback if an
1594 * event occurs immediately after we call f_op->poll().
Roman Penyaeva218cc42019-03-07 16:28:53 -08001595 * We need this because we did not take ep->lock while
Eric Wong128dd172013-01-01 21:20:27 +00001596 * changing epi above (but ep_poll_callback does take
Roman Penyaeva218cc42019-03-07 16:28:53 -08001597 * ep->lock).
Eric Wong128dd172013-01-01 21:20:27 +00001598 *
1599 * 2) We also need to ensure we do not miss _past_ events
1600 * when calling f_op->poll(). This barrier also
1601 * pairs with the barrier in wq_has_sleeper (see
1602 * comments for wq_has_sleeper).
1603 *
1604 * This barrier will now guarantee ep_poll_callback or f_op->poll
1605 * (or both) will notice the readiness of an item.
1606 */
1607 smp_mb();
1608
1609 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001610 * Get current event bits. We can safely use the file* here because
1611 * its usage count has been increased by the caller of this function.
Davide Libenzic7ea7632007-05-15 01:40:47 -07001612 * If the item is "hot" and it is not registered inside the ready
Davide Libenzi67647d02007-05-15 01:40:52 -07001613 * list, push it inside.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001614 */
Al Viro69112732017-11-28 19:56:15 -05001615 if (ep_item_poll(epi, &pt, 1)) {
Roman Penyaeva218cc42019-03-07 16:28:53 -08001616 write_lock_irq(&ep->lock);
Davidlohr Bueso992991c2018-08-21 21:58:26 -07001617 if (!ep_is_linked(epi)) {
Davide Libenzic7ea7632007-05-15 01:40:47 -07001618 list_add_tail(&epi->rdllink, &ep->rdllist);
Eric Wongeea1d582013-04-30 15:27:39 -07001619 ep_pm_stay_awake(epi);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001620
Davide Libenzic7ea7632007-05-15 01:40:47 -07001621 /* Notify waiting tasks that events are available */
1622 if (waitqueue_active(&ep->wq))
Roman Penyaeva218cc42019-03-07 16:28:53 -08001623 wake_up(&ep->wq);
Davide Libenzic7ea7632007-05-15 01:40:47 -07001624 if (waitqueue_active(&ep->poll_wait))
1625 pwake++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626 }
Roman Penyaeva218cc42019-03-07 16:28:53 -08001627 write_unlock_irq(&ep->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001629
1630 /* We have to call this outside the lock */
1631 if (pwake)
Jason Baronefcdd352020-04-06 20:11:23 -07001632 ep_poll_safewake(ep, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001633
1634 return 0;
1635}
1636
Al Viroff079522020-08-31 13:39:52 -04001637static int ep_send_events(struct eventpoll *ep,
1638 struct epoll_event __user *events, int maxevents)
Davide Libenzi5071f972009-03-31 15:24:10 -07001639{
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001640 struct epitem *epi, *tmp;
Al Viroff079522020-08-31 13:39:52 -04001641 LIST_HEAD(txlist);
Hans Verkuil626cf232012-03-23 15:02:27 -07001642 poll_table pt;
Al Viroff079522020-08-31 13:39:52 -04001643 int res = 0;
Hans Verkuil626cf232012-03-23 15:02:27 -07001644
Soheil Hassas Yeganehcccd29b2020-12-18 14:01:51 -08001645 /*
1646 * Always short-circuit for fatal signals to allow threads to make a
1647 * timely exit without the chance of finding more events available and
1648 * fetching repeatedly.
1649 */
1650 if (fatal_signal_pending(current))
1651 return -EINTR;
1652
Hans Verkuil626cf232012-03-23 15:02:27 -07001653 init_poll_funcptr(&pt, NULL);
Al Viroff079522020-08-31 13:39:52 -04001654
Al Viro57804b12020-08-31 13:41:30 -04001655 mutex_lock(&ep->mtx);
1656 ep_start_scan(ep, &txlist);
Davide Libenzi5071f972009-03-31 15:24:10 -07001657
Davide Libenzi296e2362009-03-31 15:24:11 -07001658 /*
Davide Libenzi5071f972009-03-31 15:24:10 -07001659 * We can loop without lock because we are passed a task private list.
Al Viro57804b12020-08-31 13:41:30 -04001660 * Items cannot vanish during the loop we are holding ep->mtx.
Davide Libenzi296e2362009-03-31 15:24:11 -07001661 */
Al Viroff079522020-08-31 13:39:52 -04001662 list_for_each_entry_safe(epi, tmp, &txlist, rdllink) {
1663 struct wakeup_source *ws;
1664 __poll_t revents;
Davidlohr Bueso21877e12019-01-03 15:27:12 -08001665
Al Viroff079522020-08-31 13:39:52 -04001666 if (res >= maxevents)
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001667 break;
Davide Libenzi5071f972009-03-31 15:24:10 -07001668
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001669 /*
1670 * Activate ep->ws before deactivating epi->ws to prevent
1671 * triggering auto-suspend here (in case we reactive epi->ws
1672 * below).
1673 *
1674 * This could be rearranged to delay the deactivation of epi->ws
1675 * instead, but then epi->ws would temporarily be out of sync
1676 * with ep_is_linked().
1677 */
Eric Wongeea1d582013-04-30 15:27:39 -07001678 ws = ep_wakeup_source(epi);
1679 if (ws) {
1680 if (ws->active)
1681 __pm_stay_awake(ep->ws);
1682 __pm_relax(ws);
1683 }
1684
Davide Libenzi5071f972009-03-31 15:24:10 -07001685 list_del_init(&epi->rdllink);
1686
Davide Libenzi296e2362009-03-31 15:24:11 -07001687 /*
Davide Libenzi5071f972009-03-31 15:24:10 -07001688 * If the event mask intersect the caller-requested one,
Al Viro57804b12020-08-31 13:41:30 -04001689 * deliver the event to userspace. Again, we are holding ep->mtx,
1690 * so no operations coming from userspace can change the item.
Davide Libenzi296e2362009-03-31 15:24:11 -07001691 */
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001692 revents = ep_item_poll(epi, &pt, 1);
1693 if (!revents)
1694 continue;
1695
Arnd Bergmann249dbe72021-08-11 08:30:22 +01001696 events = epoll_put_uevent(revents, epi->event.data, events);
1697 if (!events) {
Al Viroff079522020-08-31 13:39:52 -04001698 list_add(&epi->rdllink, &txlist);
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001699 ep_pm_stay_awake(epi);
Al Viroff079522020-08-31 13:39:52 -04001700 if (!res)
1701 res = -EFAULT;
1702 break;
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001703 }
Al Viroff079522020-08-31 13:39:52 -04001704 res++;
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001705 if (epi->event.events & EPOLLONESHOT)
1706 epi->event.events &= EP_PRIVATE_BITS;
1707 else if (!(epi->event.events & EPOLLET)) {
1708 /*
1709 * If this file has been added with Level
1710 * Trigger mode, we need to insert back inside
1711 * the ready list, so that the next call to
1712 * epoll_wait() will check again the events
1713 * availability. At this point, no one can insert
1714 * into ep->rdllist besides us. The epoll_ctl()
1715 * callers are locked out by
1716 * ep_scan_ready_list() holding "mtx" and the
1717 * poll callback will queue them in ep->ovflist.
1718 */
1719 list_add_tail(&epi->rdllink, &ep->rdllist);
1720 ep_pm_stay_awake(epi);
Davide Libenzi296e2362009-03-31 15:24:11 -07001721 }
1722 }
Al Viro57804b12020-08-31 13:41:30 -04001723 ep_done_scan(ep, &txlist);
1724 mutex_unlock(&ep->mtx);
Davide Libenzi5071f972009-03-31 15:24:10 -07001725
Al Viroff079522020-08-31 13:39:52 -04001726 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001727}
1728
Willem de Bruijn7cdf7c22020-12-18 14:05:35 -08001729static struct timespec64 *ep_timeout_to_timespec(struct timespec64 *to, long ms)
Eric Dumazet0781b902011-02-01 15:52:35 -08001730{
Willem de Bruijn7cdf7c22020-12-18 14:05:35 -08001731 struct timespec64 now;
1732
1733 if (ms < 0)
1734 return NULL;
1735
1736 if (!ms) {
1737 to->tv_sec = 0;
1738 to->tv_nsec = 0;
1739 return to;
1740 }
1741
1742 to->tv_sec = ms / MSEC_PER_SEC;
1743 to->tv_nsec = NSEC_PER_MSEC * (ms % MSEC_PER_SEC);
Eric Dumazet0781b902011-02-01 15:52:35 -08001744
Deepa Dinamani766b9f92016-05-19 17:09:05 -07001745 ktime_get_ts64(&now);
Willem de Bruijn7cdf7c22020-12-18 14:05:35 -08001746 *to = timespec64_add_safe(now, *to);
1747 return to;
Eric Dumazet0781b902011-02-01 15:52:35 -08001748}
1749
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001750/**
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001751 * ep_poll - Retrieves ready events, and delivers them to the caller-supplied
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001752 * event buffer.
1753 *
1754 * @ep: Pointer to the eventpoll context.
1755 * @events: Pointer to the userspace buffer where the ready events should be
1756 * stored.
1757 * @maxevents: Size (in terms of number of events) of the caller event buffer.
1758 * @timeout: Maximum timeout for the ready events fetch operation, in
Willem de Bruijn7cdf7c22020-12-18 14:05:35 -08001759 * timespec. If the timeout is zero, the function will not block,
1760 * while if the @timeout ptr is NULL, the function will block
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001761 * until at least one event has been retrieved (or an error
1762 * occurred).
1763 *
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001764 * Return: the number of ready events which have been fetched, or an
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001765 * error code, in case of error.
1766 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001767static int ep_poll(struct eventpoll *ep, struct epoll_event __user *events,
Willem de Bruijn7cdf7c22020-12-18 14:05:35 -08001768 int maxevents, struct timespec64 *timeout)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001769{
Soheil Hassas Yeganehe59d3c62020-12-18 14:02:06 -08001770 int res, eavail, timed_out = 0;
John Stultzda8b44d2016-03-17 14:20:51 -07001771 u64 slack = 0;
Ingo Molnarac6424b2017-06-20 12:06:13 +02001772 wait_queue_entry_t wait;
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001773 ktime_t expires, *to = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001774
Davidlohr Bueso679abf32018-08-21 21:58:23 -07001775 lockdep_assert_irqs_enabled();
1776
Willem de Bruijn7cdf7c22020-12-18 14:05:35 -08001777 if (timeout && (timeout->tv_sec | timeout->tv_nsec)) {
1778 slack = select_estimate_accuracy(timeout);
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001779 to = &expires;
Willem de Bruijn7cdf7c22020-12-18 14:05:35 -08001780 *to = timespec64_to_ktime(*timeout);
1781 } else if (timeout) {
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001782 /*
1783 * Avoid the unnecessary trip to the wait queue loop, if the
Soheil Hassas Yeganehe59d3c62020-12-18 14:02:06 -08001784 * caller specified a non blocking operation.
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001785 */
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001786 timed_out = 1;
1787 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001788
Soheil Hassas Yeganehe59d3c62020-12-18 14:02:06 -08001789 /*
1790 * This call is racy: We may or may not see events that are being added
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001791 * to the ready list under the lock (e.g., in IRQ callbacks). For cases
Soheil Hassas Yeganehe59d3c62020-12-18 14:02:06 -08001792 * with a non-zero timeout, this thread will check the ready list under
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001793 * lock and will add to the wait queue. For cases with a zero
Soheil Hassas Yeganehe59d3c62020-12-18 14:02:06 -08001794 * timeout, the user by definition should not care and will have to
1795 * recheck again.
1796 */
1797 eavail = ep_events_available(ep);
1798
Soheil Hassas Yeganeh00b27632020-12-18 14:02:03 -08001799 while (1) {
1800 if (eavail) {
1801 /*
1802 * Try to transfer events to user space. In case we get
1803 * 0 events and there's still timeout left over, we go
1804 * trying again in search of more luck.
1805 */
1806 res = ep_send_events(ep, events, maxevents);
1807 if (res)
1808 return res;
1809 }
Soheil Hassas Yeganehe8c85322020-12-18 14:02:00 -08001810
Soheil Hassas Yeganeh00b27632020-12-18 14:02:03 -08001811 if (timed_out)
1812 return 0;
1813
Soheil Hassas Yeganeh00b27632020-12-18 14:02:03 -08001814 eavail = ep_busy_loop(ep, timed_out);
1815 if (eavail)
1816 continue;
Soheil Hassas Yeganehe8c85322020-12-18 14:02:00 -08001817
Soheil Hassas Yeganeh2efdaf72020-12-18 14:01:48 -08001818 if (signal_pending(current))
1819 return -EINTR;
1820
Roman Penyaev412895f2020-05-07 18:36:16 -07001821 /*
1822 * Internally init_wait() uses autoremove_wake_function(),
1823 * thus wait entry is removed from the wait queue on each
1824 * wakeup. Why it is important? In case of several waiters
1825 * each new wakeup will hit the next waiter, giving it the
1826 * chance to harvest new event. Otherwise wakeup can be
1827 * lost. This is also good performance-wise, because on
1828 * normal wakeup path no need to call __remove_wait_queue()
1829 * explicitly, thus ep->lock is not taken, which halts the
1830 * event delivery.
1831 */
1832 init_wait(&wait);
Roman Penyaev65759092020-05-13 17:50:38 -07001833
Roman Penyaev1b537342020-03-21 18:22:30 -07001834 write_lock_irq(&ep->lock);
Roman Penyaev65759092020-05-13 17:50:38 -07001835 /*
1836 * Barrierless variant, waitqueue_active() is called under
1837 * the same lock on wakeup ep_poll_callback() side, so it
1838 * is safe to avoid an explicit barrier.
1839 */
1840 __set_current_state(TASK_INTERRUPTIBLE);
1841
1842 /*
1843 * Do the final check under the lock. ep_scan_ready_list()
1844 * plays with two lists (->rdllist and ->ovflist) and there
1845 * is always a race when both lists are empty for short
1846 * period of time although events are pending, so lock is
1847 * important.
1848 */
1849 eavail = ep_events_available(ep);
Soheil Hassas Yeganeh2efdaf72020-12-18 14:01:48 -08001850 if (!eavail)
1851 __add_wait_queue_exclusive(&ep->wq, &wait);
1852
Roman Penyaev1b537342020-03-21 18:22:30 -07001853 write_unlock_irq(&ep->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001854
Soheil Hassas Yeganeh2efdaf72020-12-18 14:01:48 -08001855 if (!eavail)
Soheil Hassas Yeganeh289caf52020-12-18 14:01:44 -08001856 timed_out = !schedule_hrtimeout_range(to, slack,
1857 HRTIMER_MODE_ABS);
Soheil Hassas Yeganehe4115962020-12-18 14:01:54 -08001858 __set_current_state(TASK_RUNNING);
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001859
Soheil Hassas Yeganeh289caf52020-12-18 14:01:44 -08001860 /*
1861 * We were woken up, thus go and try to harvest some events.
1862 * If timed out and still on the wait queue, recheck eavail
1863 * carefully under lock, below.
1864 */
Roman Penyaev412895f2020-05-07 18:36:16 -07001865 eavail = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001866
Soheil Hassas Yeganehe8c85322020-12-18 14:02:00 -08001867 if (!list_empty_careful(&wait.entry)) {
1868 write_lock_irq(&ep->lock);
1869 /*
1870 * If the thread timed out and is not on the wait queue,
1871 * it means that the thread was woken up after its
1872 * timeout expired before it could reacquire the lock.
1873 * Thus, when wait.entry is empty, it needs to harvest
1874 * events.
1875 */
1876 if (timed_out)
1877 eavail = list_empty(&wait.entry);
1878 __remove_wait_queue(&ep->wq, &wait);
1879 write_unlock_irq(&ep->lock);
1880 }
Soheil Hassas Yeganeh00b27632020-12-18 14:02:03 -08001881 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001882}
1883
Davide Libenzi22bacca2011-02-25 14:44:12 -08001884/**
Al Viro773318e2020-08-22 23:13:27 -04001885 * ep_loop_check_proc - verify that adding an epoll file inside another
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001886 * epoll structure does not violate the constraints, in
Davide Libenzi22bacca2011-02-25 14:44:12 -08001887 * terms of closed loops, or too deep chains (which can
1888 * result in excessive stack usage).
1889 *
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001890 * @ep: the &struct eventpoll to be currently checked.
Al Virobde03c42020-09-26 16:50:57 -04001891 * @depth: Current depth of the path being checked.
Davide Libenzi22bacca2011-02-25 14:44:12 -08001892 *
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001893 * Return: %zero if adding the epoll @file inside current epoll
1894 * structure @ep does not violate the constraints, or %-1 otherwise.
Davide Libenzi22bacca2011-02-25 14:44:12 -08001895 */
Al Virobde03c42020-09-26 16:50:57 -04001896static int ep_loop_check_proc(struct eventpoll *ep, int depth)
Davide Libenzi22bacca2011-02-25 14:44:12 -08001897{
1898 int error = 0;
Davide Libenzi22bacca2011-02-25 14:44:12 -08001899 struct rb_node *rbp;
1900 struct epitem *epi;
1901
Al Viro773318e2020-08-22 23:13:27 -04001902 mutex_lock_nested(&ep->mtx, depth + 1);
Al Viro18306c42020-09-10 08:30:05 -04001903 ep->gen = loop_check_gen;
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001904 for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) {
Davide Libenzi22bacca2011-02-25 14:44:12 -08001905 epi = rb_entry(rbp, struct epitem, rbn);
1906 if (unlikely(is_file_epoll(epi->ffd.file))) {
Al Virobde03c42020-09-26 16:50:57 -04001907 struct eventpoll *ep_tovisit;
Jason Baron28d82dc2012-01-12 17:17:43 -08001908 ep_tovisit = epi->ffd.file->private_data;
Al Viro18306c42020-09-10 08:30:05 -04001909 if (ep_tovisit->gen == loop_check_gen)
Jason Baron28d82dc2012-01-12 17:17:43 -08001910 continue;
Al Virobde03c42020-09-26 16:50:57 -04001911 if (ep_tovisit == inserting_into || depth > EP_MAX_NESTS)
Al Viro56c428c2020-09-26 16:38:44 -04001912 error = -1;
Al Virobde03c42020-09-26 16:50:57 -04001913 else
1914 error = ep_loop_check_proc(ep_tovisit, depth + 1);
Davide Libenzi22bacca2011-02-25 14:44:12 -08001915 if (error != 0)
1916 break;
Jason Baron28d82dc2012-01-12 17:17:43 -08001917 } else {
1918 /*
1919 * If we've reached a file that is not associated with
1920 * an ep, then we need to check if the newly added
1921 * links are going to add too many wakeup paths. We do
1922 * this by adding it to the tfile_check_list, if it's
1923 * not already there, and calling reverse_path_check()
1924 * during ep_insert().
1925 */
Al Viro319c1512020-10-01 20:45:51 -04001926 list_file(epi->ffd.file);
Davide Libenzi22bacca2011-02-25 14:44:12 -08001927 }
1928 }
1929 mutex_unlock(&ep->mtx);
1930
1931 return error;
1932}
1933
1934/**
Al Virobde03c42020-09-26 16:50:57 -04001935 * ep_loop_check - Performs a check to verify that adding an epoll file (@to)
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001936 * into another epoll file (represented by @ep) does not create
Davide Libenzi22bacca2011-02-25 14:44:12 -08001937 * closed loops or too deep chains.
1938 *
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001939 * @ep: Pointer to the epoll we are inserting into.
Al Virobde03c42020-09-26 16:50:57 -04001940 * @to: Pointer to the epoll to be inserted.
Davide Libenzi22bacca2011-02-25 14:44:12 -08001941 *
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001942 * Return: %zero if adding the epoll @to inside the epoll @from
1943 * does not violate the constraints, or %-1 otherwise.
Davide Libenzi22bacca2011-02-25 14:44:12 -08001944 */
Al Virobde03c42020-09-26 16:50:57 -04001945static int ep_loop_check(struct eventpoll *ep, struct eventpoll *to)
Davide Libenzi22bacca2011-02-25 14:44:12 -08001946{
Al Viro6a3890c2020-09-26 16:29:02 -04001947 inserting_into = ep;
Al Virobde03c42020-09-26 16:50:57 -04001948 return ep_loop_check_proc(to, 0);
Jason Baron28d82dc2012-01-12 17:17:43 -08001949}
1950
1951static void clear_tfile_check_list(void)
1952{
Al Viro319c1512020-10-01 20:45:51 -04001953 rcu_read_lock();
1954 while (tfile_check_list != EP_UNACTIVE_PTR) {
1955 struct epitems_head *head = tfile_check_list;
1956 tfile_check_list = head->next;
1957 unlist_file(head);
Jason Baron28d82dc2012-01-12 17:17:43 -08001958 }
Al Viro319c1512020-10-01 20:45:51 -04001959 rcu_read_unlock();
Davide Libenzi22bacca2011-02-25 14:44:12 -08001960}
1961
Davide Libenzi7699acd2007-05-10 22:23:23 -07001962/*
Andrew Morton523723b2008-08-12 15:09:01 -07001963 * Open an eventpoll file descriptor.
Davide Libenzi7699acd2007-05-10 22:23:23 -07001964 */
Dominik Brodowski791eb222018-03-11 11:34:30 +01001965static int do_epoll_create(int flags)
Davide Libenzi7699acd2007-05-10 22:23:23 -07001966{
Jason Baron28d82dc2012-01-12 17:17:43 -08001967 int error, fd;
Davide Libenzibb57c3e2009-03-31 15:24:12 -07001968 struct eventpoll *ep = NULL;
Jason Baron28d82dc2012-01-12 17:17:43 -08001969 struct file *file;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001970
Ulrich Dreppere38b36f2008-07-23 21:29:42 -07001971 /* Check the EPOLL_* constant for consistency. */
1972 BUILD_BUG_ON(EPOLL_CLOEXEC != O_CLOEXEC);
1973
Davide Libenzi296e2362009-03-31 15:24:11 -07001974 if (flags & ~EPOLL_CLOEXEC)
1975 return -EINVAL;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001976 /*
Davide Libenzibb57c3e2009-03-31 15:24:12 -07001977 * Create the internal data structure ("struct eventpoll").
Davide Libenzi7699acd2007-05-10 22:23:23 -07001978 */
Ulrich Drepper9fe5ad92008-07-23 21:29:43 -07001979 error = ep_alloc(&ep);
Davide Libenzibb57c3e2009-03-31 15:24:12 -07001980 if (error < 0)
1981 return error;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001982 /*
1983 * Creates all the items needed to setup an eventpoll file. That is,
Al Viro2030a422008-02-23 06:46:49 -05001984 * a file structure and a free file descriptor.
Davide Libenzi7699acd2007-05-10 22:23:23 -07001985 */
Jason Baron28d82dc2012-01-12 17:17:43 -08001986 fd = get_unused_fd_flags(O_RDWR | (flags & O_CLOEXEC));
1987 if (fd < 0) {
1988 error = fd;
1989 goto out_free_ep;
1990 }
1991 file = anon_inode_getfile("[eventpoll]", &eventpoll_fops, ep,
Roland Dreier628ff7c2009-12-18 09:41:24 -08001992 O_RDWR | (flags & O_CLOEXEC));
Jason Baron28d82dc2012-01-12 17:17:43 -08001993 if (IS_ERR(file)) {
1994 error = PTR_ERR(file);
1995 goto out_free_fd;
1996 }
Jason Baron28d82dc2012-01-12 17:17:43 -08001997 ep->file = file;
Al Viro98022742012-08-17 22:42:36 -04001998 fd_install(fd, file);
Jason Baron28d82dc2012-01-12 17:17:43 -08001999 return fd;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002000
Jason Baron28d82dc2012-01-12 17:17:43 -08002001out_free_fd:
2002 put_unused_fd(fd);
2003out_free_ep:
2004 ep_free(ep);
Davide Libenzibb57c3e2009-03-31 15:24:12 -07002005 return error;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002006}
2007
Dominik Brodowski791eb222018-03-11 11:34:30 +01002008SYSCALL_DEFINE1(epoll_create1, int, flags)
2009{
2010 return do_epoll_create(flags);
2011}
2012
Heiko Carstens5a8a82b2009-01-14 14:14:25 +01002013SYSCALL_DEFINE1(epoll_create, int, size)
Ulrich Dreppera0998b52008-07-23 21:29:27 -07002014{
Davide Libenzibfe3891a2009-05-12 13:19:44 -07002015 if (size <= 0)
Ulrich Drepper9fe5ad92008-07-23 21:29:43 -07002016 return -EINVAL;
2017
Dominik Brodowski791eb222018-03-11 11:34:30 +01002018 return do_epoll_create(0);
Ulrich Dreppera0998b52008-07-23 21:29:27 -07002019}
2020
Jens Axboe39220e82020-01-08 15:05:37 -07002021static inline int epoll_mutex_lock(struct mutex *mutex, int depth,
2022 bool nonblock)
2023{
2024 if (!nonblock) {
2025 mutex_lock_nested(mutex, depth);
2026 return 0;
2027 }
2028 if (mutex_trylock(mutex))
2029 return 0;
2030 return -EAGAIN;
2031}
2032
2033int do_epoll_ctl(int epfd, int op, int fd, struct epoll_event *epds,
2034 bool nonblock)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002035{
2036 int error;
Jason Baron67347fe2013-11-12 15:10:18 -08002037 int full_check = 0;
Al Viro7e3fb582013-08-30 12:47:21 -04002038 struct fd f, tf;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002039 struct eventpoll *ep;
2040 struct epitem *epi;
Jason Baron67347fe2013-11-12 15:10:18 -08002041 struct eventpoll *tep = NULL;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002042
Davide Libenzi7699acd2007-05-10 22:23:23 -07002043 error = -EBADF;
Al Viro7e3fb582013-08-30 12:47:21 -04002044 f = fdget(epfd);
2045 if (!f.file)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002046 goto error_return;
2047
2048 /* Get the "struct file *" for the target file */
Al Viro7e3fb582013-08-30 12:47:21 -04002049 tf = fdget(fd);
2050 if (!tf.file)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002051 goto error_fput;
2052
2053 /* The target file descriptor must support poll */
2054 error = -EPERM;
Christoph Hellwig9965ed172018-03-05 07:26:05 -08002055 if (!file_can_poll(tf.file))
Davide Libenzi7699acd2007-05-10 22:23:23 -07002056 goto error_tgt_fput;
2057
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02002058 /* Check if EPOLLWAKEUP is allowed */
Nicolas Ioossc680e412014-09-09 14:50:51 -07002059 if (ep_op_has_event(op))
Jens Axboe58e41a42020-01-08 14:35:13 -07002060 ep_take_care_of_epollwakeup(epds);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02002061
Davide Libenzi7699acd2007-05-10 22:23:23 -07002062 /*
2063 * We have to check that the file structure underneath the file descriptor
2064 * the user passed to us _is_ an eventpoll file. And also we do not permit
2065 * adding an epoll file descriptor inside itself.
2066 */
2067 error = -EINVAL;
Al Viro7e3fb582013-08-30 12:47:21 -04002068 if (f.file == tf.file || !is_file_epoll(f.file))
Davide Libenzi7699acd2007-05-10 22:23:23 -07002069 goto error_tgt_fput;
2070
2071 /*
Jason Barondf0108c2016-01-20 14:59:24 -08002072 * epoll adds to the wakeup queue at EPOLL_CTL_ADD time only,
2073 * so EPOLLEXCLUSIVE is not allowed for a EPOLL_CTL_MOD operation.
2074 * Also, we do not currently supported nested exclusive wakeups.
2075 */
Jens Axboe58e41a42020-01-08 14:35:13 -07002076 if (ep_op_has_event(op) && (epds->events & EPOLLEXCLUSIVE)) {
Jason Baronb6a515c2016-02-05 15:37:04 -08002077 if (op == EPOLL_CTL_MOD)
2078 goto error_tgt_fput;
2079 if (op == EPOLL_CTL_ADD && (is_file_epoll(tf.file) ||
Jens Axboe58e41a42020-01-08 14:35:13 -07002080 (epds->events & ~EPOLLEXCLUSIVE_OK_BITS)))
Jason Baronb6a515c2016-02-05 15:37:04 -08002081 goto error_tgt_fput;
2082 }
Jason Barondf0108c2016-01-20 14:59:24 -08002083
2084 /*
Davide Libenzi7699acd2007-05-10 22:23:23 -07002085 * At this point it is safe to assume that the "private_data" contains
2086 * our own data structure.
2087 */
Al Viro7e3fb582013-08-30 12:47:21 -04002088 ep = f.file->private_data;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002089
Davide Libenzi22bacca2011-02-25 14:44:12 -08002090 /*
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07002091 * When we insert an epoll file descriptor inside another epoll file
2092 * descriptor, there is the chance of creating closed loops, which are
Jason Baron28d82dc2012-01-12 17:17:43 -08002093 * better be handled here, than in more critical paths. While we are
2094 * checking for loops we also determine the list of files reachable
2095 * and hang them on the tfile_check_list, so we can check that we
2096 * haven't created too many possible wakeup paths.
Davide Libenzi22bacca2011-02-25 14:44:12 -08002097 *
Jason Baron67347fe2013-11-12 15:10:18 -08002098 * We do not need to take the global 'epumutex' on EPOLL_CTL_ADD when
2099 * the epoll file descriptor is attaching directly to a wakeup source,
2100 * unless the epoll file descriptor is nested. The purpose of taking the
2101 * 'epmutex' on add is to prevent complex toplogies such as loops and
2102 * deep wakeup paths from forming in parallel through multiple
2103 * EPOLL_CTL_ADD operations.
Davide Libenzi22bacca2011-02-25 14:44:12 -08002104 */
Jens Axboe39220e82020-01-08 15:05:37 -07002105 error = epoll_mutex_lock(&ep->mtx, 0, nonblock);
2106 if (error)
2107 goto error_tgt_fput;
Jason Baron67347fe2013-11-12 15:10:18 -08002108 if (op == EPOLL_CTL_ADD) {
Al Viro319c1512020-10-01 20:45:51 -04002109 if (READ_ONCE(f.file->f_ep) || ep->gen == loop_check_gen ||
2110 is_file_epoll(tf.file)) {
Jason Baron67347fe2013-11-12 15:10:18 -08002111 mutex_unlock(&ep->mtx);
Jens Axboe39220e82020-01-08 15:05:37 -07002112 error = epoll_mutex_lock(&epmutex, 0, nonblock);
2113 if (error)
2114 goto error_tgt_fput;
Al Viro18306c42020-09-10 08:30:05 -04002115 loop_check_gen++;
Jens Axboe39220e82020-01-08 15:05:37 -07002116 full_check = 1;
Jason Baron67347fe2013-11-12 15:10:18 -08002117 if (is_file_epoll(tf.file)) {
Al Virobde03c42020-09-26 16:50:57 -04002118 tep = tf.file->private_data;
Jason Baron67347fe2013-11-12 15:10:18 -08002119 error = -ELOOP;
Al Virobde03c42020-09-26 16:50:57 -04002120 if (ep_loop_check(ep, tep) != 0)
Jason Baron67347fe2013-11-12 15:10:18 -08002121 goto error_tgt_fput;
Marc Zyngiera9ed4a62020-08-19 17:12:17 +01002122 }
Jens Axboe39220e82020-01-08 15:05:37 -07002123 error = epoll_mutex_lock(&ep->mtx, 0, nonblock);
Al Viro52c47962020-08-22 18:25:52 -04002124 if (error)
Jens Axboe39220e82020-01-08 15:05:37 -07002125 goto error_tgt_fput;
Jason Baron67347fe2013-11-12 15:10:18 -08002126 }
2127 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07002128
Davide Libenzi67647d02007-05-15 01:40:52 -07002129 /*
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07002130 * Try to lookup the file inside our RB tree. Since we grabbed "mtx"
Davide Libenzi67647d02007-05-15 01:40:52 -07002131 * above, we can be sure to be able to use the item looked up by
2132 * ep_find() till we release the mutex.
2133 */
Al Viro7e3fb582013-08-30 12:47:21 -04002134 epi = ep_find(ep, tf.file, fd);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002135
2136 error = -EINVAL;
2137 switch (op) {
2138 case EPOLL_CTL_ADD:
2139 if (!epi) {
Jens Axboe58e41a42020-01-08 14:35:13 -07002140 epds->events |= EPOLLERR | EPOLLHUP;
2141 error = ep_insert(ep, epds, tf.file, fd, full_check);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002142 } else
2143 error = -EEXIST;
2144 break;
2145 case EPOLL_CTL_DEL:
2146 if (epi)
2147 error = ep_remove(ep, epi);
2148 else
2149 error = -ENOENT;
2150 break;
2151 case EPOLL_CTL_MOD:
2152 if (epi) {
Jason Baronb6a515c2016-02-05 15:37:04 -08002153 if (!(epi->event.events & EPOLLEXCLUSIVE)) {
Jens Axboe58e41a42020-01-08 14:35:13 -07002154 epds->events |= EPOLLERR | EPOLLHUP;
2155 error = ep_modify(ep, epi, epds);
Jason Baronb6a515c2016-02-05 15:37:04 -08002156 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07002157 } else
2158 error = -ENOENT;
2159 break;
2160 }
Davide Libenzid47de162007-05-15 01:40:41 -07002161 mutex_unlock(&ep->mtx);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002162
2163error_tgt_fput:
Al Viro52c47962020-08-22 18:25:52 -04002164 if (full_check) {
2165 clear_tfile_check_list();
Al Viro18306c42020-09-10 08:30:05 -04002166 loop_check_gen++;
Davide Libenzi22bacca2011-02-25 14:44:12 -08002167 mutex_unlock(&epmutex);
Al Viro52c47962020-08-22 18:25:52 -04002168 }
Davide Libenzi22bacca2011-02-25 14:44:12 -08002169
Al Viro7e3fb582013-08-30 12:47:21 -04002170 fdput(tf);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002171error_fput:
Al Viro7e3fb582013-08-30 12:47:21 -04002172 fdput(f);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002173error_return:
Davide Libenzi7699acd2007-05-10 22:23:23 -07002174
2175 return error;
2176}
2177
2178/*
Jens Axboe58e41a42020-01-08 14:35:13 -07002179 * The following function implements the controller interface for
2180 * the eventpoll file that enables the insertion/removal/change of
2181 * file descriptors inside the interest set.
2182 */
2183SYSCALL_DEFINE4(epoll_ctl, int, epfd, int, op, int, fd,
2184 struct epoll_event __user *, event)
2185{
2186 struct epoll_event epds;
2187
2188 if (ep_op_has_event(op) &&
2189 copy_from_user(&epds, event, sizeof(struct epoll_event)))
2190 return -EFAULT;
2191
Jens Axboe39220e82020-01-08 15:05:37 -07002192 return do_epoll_ctl(epfd, op, fd, &epds, false);
Jens Axboe58e41a42020-01-08 14:35:13 -07002193}
2194
2195/*
Davide Libenzi7699acd2007-05-10 22:23:23 -07002196 * Implement the event wait interface for the eventpoll file. It is the kernel
2197 * part of the user space epoll_wait(2).
2198 */
Dominik Brodowski791eb222018-03-11 11:34:30 +01002199static int do_epoll_wait(int epfd, struct epoll_event __user *events,
Willem de Bruijn7cdf7c22020-12-18 14:05:35 -08002200 int maxevents, struct timespec64 *to)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002201{
Al Viro2903ff02012-08-28 12:52:22 -04002202 int error;
2203 struct fd f;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002204 struct eventpoll *ep;
2205
Davide Libenzi7699acd2007-05-10 22:23:23 -07002206 /* The maximum number of event must be greater than zero */
2207 if (maxevents <= 0 || maxevents > EP_MAX_EVENTS)
2208 return -EINVAL;
2209
2210 /* Verify that the area passed by the user is writeable */
Linus Torvalds96d4f262019-01-03 18:57:57 -08002211 if (!access_ok(events, maxevents * sizeof(struct epoll_event)))
Al Viro2903ff02012-08-28 12:52:22 -04002212 return -EFAULT;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002213
2214 /* Get the "struct file *" for the eventpoll file */
Al Viro2903ff02012-08-28 12:52:22 -04002215 f = fdget(epfd);
2216 if (!f.file)
2217 return -EBADF;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002218
2219 /*
2220 * We have to check that the file structure underneath the fd
2221 * the user passed to us _is_ an eventpoll file.
2222 */
2223 error = -EINVAL;
Al Viro2903ff02012-08-28 12:52:22 -04002224 if (!is_file_epoll(f.file))
Davide Libenzi7699acd2007-05-10 22:23:23 -07002225 goto error_fput;
2226
2227 /*
2228 * At this point it is safe to assume that the "private_data" contains
2229 * our own data structure.
2230 */
Al Viro2903ff02012-08-28 12:52:22 -04002231 ep = f.file->private_data;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002232
2233 /* Time to fish for events ... */
Willem de Bruijn7cdf7c22020-12-18 14:05:35 -08002234 error = ep_poll(ep, events, maxevents, to);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002235
2236error_fput:
Al Viro2903ff02012-08-28 12:52:22 -04002237 fdput(f);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002238 return error;
2239}
2240
Dominik Brodowski791eb222018-03-11 11:34:30 +01002241SYSCALL_DEFINE4(epoll_wait, int, epfd, struct epoll_event __user *, events,
2242 int, maxevents, int, timeout)
2243{
Willem de Bruijn7cdf7c22020-12-18 14:05:35 -08002244 struct timespec64 to;
2245
2246 return do_epoll_wait(epfd, events, maxevents,
2247 ep_timeout_to_timespec(&to, timeout));
Dominik Brodowski791eb222018-03-11 11:34:30 +01002248}
2249
Davide Libenzi7699acd2007-05-10 22:23:23 -07002250/*
2251 * Implement the event wait interface for the eventpoll file. It is the kernel
2252 * part of the user space epoll_pwait(2).
2253 */
Willem de Bruijn58169a52020-12-18 14:05:38 -08002254static int do_epoll_pwait(int epfd, struct epoll_event __user *events,
2255 int maxevents, struct timespec64 *to,
2256 const sigset_t __user *sigmask, size_t sigsetsize)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002257{
2258 int error;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002259
2260 /*
2261 * If the caller wants a certain signal mask to be set during the wait,
2262 * we apply it here.
2263 */
Oleg Nesterovb7724342019-07-16 16:29:53 -07002264 error = set_user_sigmask(sigmask, sigsetsize);
Deepa Dinamanided653c2018-09-19 21:41:04 -07002265 if (error)
2266 return error;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002267
Willem de Bruijn58169a52020-12-18 14:05:38 -08002268 error = do_epoll_wait(epfd, events, maxevents, to);
Willem de Bruijn7cdf7c22020-12-18 14:05:35 -08002269
Oleg Nesterovb7724342019-07-16 16:29:53 -07002270 restore_saved_sigmask_unless(error == -EINTR);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002271
2272 return error;
2273}
2274
Willem de Bruijn58169a52020-12-18 14:05:38 -08002275SYSCALL_DEFINE6(epoll_pwait, int, epfd, struct epoll_event __user *, events,
2276 int, maxevents, int, timeout, const sigset_t __user *, sigmask,
2277 size_t, sigsetsize)
Al Viro35280bd2013-02-24 14:52:17 -05002278{
Willem de Bruijn7cdf7c22020-12-18 14:05:35 -08002279 struct timespec64 to;
Willem de Bruijn58169a52020-12-18 14:05:38 -08002280
2281 return do_epoll_pwait(epfd, events, maxevents,
2282 ep_timeout_to_timespec(&to, timeout),
2283 sigmask, sigsetsize);
2284}
2285
2286SYSCALL_DEFINE6(epoll_pwait2, int, epfd, struct epoll_event __user *, events,
2287 int, maxevents, const struct __kernel_timespec __user *, timeout,
2288 const sigset_t __user *, sigmask, size_t, sigsetsize)
2289{
2290 struct timespec64 ts, *to = NULL;
2291
2292 if (timeout) {
2293 if (get_timespec64(&ts, timeout))
2294 return -EFAULT;
2295 to = &ts;
2296 if (poll_select_set_timeout(to, ts.tv_sec, ts.tv_nsec))
2297 return -EINVAL;
2298 }
2299
2300 return do_epoll_pwait(epfd, events, maxevents, to,
2301 sigmask, sigsetsize);
2302}
2303
2304#ifdef CONFIG_COMPAT
2305static int do_compat_epoll_pwait(int epfd, struct epoll_event __user *events,
2306 int maxevents, struct timespec64 *timeout,
2307 const compat_sigset_t __user *sigmask,
2308 compat_size_t sigsetsize)
2309{
Al Viro35280bd2013-02-24 14:52:17 -05002310 long err;
Al Viro35280bd2013-02-24 14:52:17 -05002311
2312 /*
2313 * If the caller wants a certain signal mask to be set during the wait,
2314 * we apply it here.
2315 */
Oleg Nesterovb7724342019-07-16 16:29:53 -07002316 err = set_compat_user_sigmask(sigmask, sigsetsize);
Deepa Dinamanided653c2018-09-19 21:41:04 -07002317 if (err)
2318 return err;
Al Viro35280bd2013-02-24 14:52:17 -05002319
Willem de Bruijn58169a52020-12-18 14:05:38 -08002320 err = do_epoll_wait(epfd, events, maxevents, timeout);
Willem de Bruijn7cdf7c22020-12-18 14:05:35 -08002321
Oleg Nesterovb7724342019-07-16 16:29:53 -07002322 restore_saved_sigmask_unless(err == -EINTR);
Al Viro35280bd2013-02-24 14:52:17 -05002323
2324 return err;
2325}
Willem de Bruijn58169a52020-12-18 14:05:38 -08002326
2327COMPAT_SYSCALL_DEFINE6(epoll_pwait, int, epfd,
2328 struct epoll_event __user *, events,
2329 int, maxevents, int, timeout,
2330 const compat_sigset_t __user *, sigmask,
2331 compat_size_t, sigsetsize)
2332{
2333 struct timespec64 to;
2334
2335 return do_compat_epoll_pwait(epfd, events, maxevents,
2336 ep_timeout_to_timespec(&to, timeout),
2337 sigmask, sigsetsize);
2338}
2339
2340COMPAT_SYSCALL_DEFINE6(epoll_pwait2, int, epfd,
2341 struct epoll_event __user *, events,
2342 int, maxevents,
2343 const struct __kernel_timespec __user *, timeout,
2344 const compat_sigset_t __user *, sigmask,
2345 compat_size_t, sigsetsize)
2346{
2347 struct timespec64 ts, *to = NULL;
2348
2349 if (timeout) {
2350 if (get_timespec64(&ts, timeout))
2351 return -EFAULT;
2352 to = &ts;
2353 if (poll_select_set_timeout(to, ts.tv_sec, ts.tv_nsec))
2354 return -EINVAL;
2355 }
2356
2357 return do_compat_epoll_pwait(epfd, events, maxevents, to,
2358 sigmask, sigsetsize);
2359}
2360
Al Viro35280bd2013-02-24 14:52:17 -05002361#endif
2362
Linus Torvalds1da177e2005-04-16 15:20:36 -07002363static int __init eventpoll_init(void)
2364{
Davide Libenzi7ef99642008-12-01 13:13:55 -08002365 struct sysinfo si;
2366
2367 si_meminfo(&si);
Davide Libenzi9df04e12009-01-29 14:25:26 -08002368 /*
2369 * Allows top 4% of lomem to be allocated for epoll watches (per user).
2370 */
2371 max_user_watches = (((si.totalram - si.totalhigh) / 25) << PAGE_SHIFT) /
Davide Libenzi7ef99642008-12-01 13:13:55 -08002372 EP_ITEM_COST;
Robin Holt52bd19f72011-01-12 17:00:01 -08002373 BUG_ON(max_user_watches < 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002374
Davide Libenzi22bacca2011-02-25 14:44:12 -08002375 /*
Eric Wong39732ca2013-04-30 15:27:38 -07002376 * We can have many thousands of epitems, so prevent this from
2377 * using an extra cache line on 64-bit (and smaller) CPUs
2378 */
2379 BUILD_BUG_ON(sizeof(void *) <= 8 && sizeof(struct epitem) > 128);
2380
Linus Torvalds1da177e2005-04-16 15:20:36 -07002381 /* Allocates slab cache used to allocate "struct epitem" items */
2382 epi_cache = kmem_cache_create("eventpoll_epi", sizeof(struct epitem),
Shakeel Butt2ae928a2017-11-17 15:28:59 -08002383 0, SLAB_HWCACHE_ALIGN|SLAB_PANIC|SLAB_ACCOUNT, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002384
2385 /* Allocates slab cache used to allocate "struct eppoll_entry" */
2386 pwq_cache = kmem_cache_create("eventpoll_pwq",
Shakeel Butt2ae928a2017-11-17 15:28:59 -08002387 sizeof(struct eppoll_entry), 0, SLAB_PANIC|SLAB_ACCOUNT, NULL);
Xiaoming Nia8f5de82022-01-21 22:12:09 -08002388 epoll_sysctls_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002389
Al Viro319c1512020-10-01 20:45:51 -04002390 ephead_cache = kmem_cache_create("ep_head",
2391 sizeof(struct epitems_head), 0, SLAB_PANIC|SLAB_ACCOUNT, NULL);
2392
Linus Torvalds1da177e2005-04-16 15:20:36 -07002393 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002394}
Davide Libenzicea69242007-05-10 22:23:22 -07002395fs_initcall(eventpoll_init);