blob: 7c0980db77b3178ae23699f0907bcbdaee44c458 [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>
Joe Damato18e2bf02024-02-13 06:16:45 +000040#include <linux/capability.h>
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -070041#include <net/busy_poll.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070042
Linus Torvalds1da177e2005-04-16 15:20:36 -070043/*
44 * LOCKING:
45 * There are three level of locking required by epoll :
46 *
Davidlohr Buesod4cb6262023-04-11 16:41:59 -070047 * 1) epnested_mutex (mutex)
Davide Libenzic7ea7632007-05-15 01:40:47 -070048 * 2) ep->mtx (mutex)
Roman Penyaeva218cc42019-03-07 16:28:53 -080049 * 3) ep->lock (rwlock)
Linus Torvalds1da177e2005-04-16 15:20:36 -070050 *
51 * The acquire order is the one listed above, from 1 to 3.
Roman Penyaeva218cc42019-03-07 16:28:53 -080052 * We need a rwlock (ep->lock) because we manipulate objects
Linus Torvalds1da177e2005-04-16 15:20:36 -070053 * from inside the poll callback, that might be triggered from
54 * a wake_up() that in turn might be called from IRQ context.
55 * So we can't sleep inside the poll callback and hence we need
56 * a spinlock. During the event transfer loop (from kernel to
57 * user space) we could end up sleeping due a copy_to_user(), so
58 * we need a lock that will allow us to sleep. This lock is a
Davide Libenzid47de162007-05-15 01:40:41 -070059 * mutex (ep->mtx). It is acquired during the event transfer loop,
60 * during epoll_ctl(EPOLL_CTL_DEL) and during eventpoll_release_file().
Davidlohr Buesod4cb6262023-04-11 16:41:59 -070061 * The epnested_mutex is acquired when inserting an epoll fd onto another
62 * epoll fd. We do this so that we walk the epoll tree and ensure that this
Davide Libenzi22bacca2011-02-25 14:44:12 -080063 * insertion does not create a cycle of epoll file descriptors, which
64 * could lead to deadlock. We need a global mutex to prevent two
65 * simultaneous inserts (A into B and B into A) from racing and
66 * constructing a cycle without either insert observing that it is
67 * going to.
Nelson Elhaged8805e62011-10-31 17:13:14 -070068 * It is necessary to acquire multiple "ep->mtx"es at once in the
69 * case when one epoll fd is added to another. In this case, we
70 * always acquire the locks in the order of nesting (i.e. after
71 * epoll_ctl(e1, EPOLL_CTL_ADD, e2), e1->mtx will always be acquired
72 * before e2->mtx). Since we disallow cycles of epoll file
73 * descriptors, this ensures that the mutexes are well-ordered. In
74 * order to communicate this nesting to lockdep, when walking a tree
75 * of epoll file descriptors, we use the current recursion depth as
76 * the lockdep subkey.
Davide Libenzid47de162007-05-15 01:40:41 -070077 * It is possible to drop the "ep->mtx" and to use the global
Davidlohr Buesod4cb6262023-04-11 16:41:59 -070078 * mutex "epnested_mutex" (together with "ep->lock") to have it working,
Davide Libenzid47de162007-05-15 01:40:41 -070079 * but having "ep->mtx" will make the interface more scalable.
Davidlohr Buesod4cb6262023-04-11 16:41:59 -070080 * Events that require holding "epnested_mutex" are very rare, while for
Davide Libenzid47de162007-05-15 01:40:41 -070081 * normal operations the epoll private "ep->mtx" will guarantee
82 * a better scalability.
Linus Torvalds1da177e2005-04-16 15:20:36 -070083 */
84
Linus Torvalds1da177e2005-04-16 15:20:36 -070085/* Epoll private bits inside the event mask */
Jason Barondf0108c2016-01-20 14:59:24 -080086#define EP_PRIVATE_BITS (EPOLLWAKEUP | EPOLLONESHOT | EPOLLET | EPOLLEXCLUSIVE)
Linus Torvalds1da177e2005-04-16 15:20:36 -070087
Linus Torvaldsa9a08842018-02-11 14:34:03 -080088#define EPOLLINOUT_BITS (EPOLLIN | EPOLLOUT)
Jason Baronb6a515c2016-02-05 15:37:04 -080089
Linus Torvaldsa9a08842018-02-11 14:34:03 -080090#define EPOLLEXCLUSIVE_OK_BITS (EPOLLINOUT_BITS | EPOLLERR | EPOLLHUP | \
Jason Baronb6a515c2016-02-05 15:37:04 -080091 EPOLLWAKEUP | EPOLLET | EPOLLEXCLUSIVE)
92
Davide Libenzi5071f972009-03-31 15:24:10 -070093/* Maximum number of nesting allowed inside epoll sets */
94#define EP_MAX_NESTS 4
Linus Torvalds1da177e2005-04-16 15:20:36 -070095
Davide Libenzib6119672006-10-11 01:21:44 -070096#define EP_MAX_EVENTS (INT_MAX / sizeof(struct epoll_event))
97
Davide Libenzid47de162007-05-15 01:40:41 -070098#define EP_UNACTIVE_PTR ((void *) -1L)
99
Davide Libenzi7ef99642008-12-01 13:13:55 -0800100#define EP_ITEM_COST (sizeof(struct epitem) + sizeof(struct eppoll_entry))
101
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102struct epoll_filefd {
103 struct file *file;
104 int fd;
Eric Wong39732ca2013-04-30 15:27:38 -0700105} __packed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106
Al Viro80285b72020-09-02 11:45:57 -0400107/* Wait structure used by the poll hooks */
108struct eppoll_entry {
109 /* List header used to link this structure to the "struct epitem" */
110 struct eppoll_entry *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111
Al Viro80285b72020-09-02 11:45:57 -0400112 /* The "base" pointer is set to the container "struct epitem" */
113 struct epitem *base;
114
115 /*
116 * Wait queue item that will be linked to the target file wait
117 * queue head.
118 */
119 wait_queue_entry_t wait;
120
121 /* The wait queue head that linked the "wait" wait queue item */
122 wait_queue_head_t *whead;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123};
124
125/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126 * Each file descriptor added to the eventpoll interface will
Davide Libenzi6192bd52007-05-08 00:25:41 -0700127 * have an entry of this type linked to the "rbr" RB tree.
Eric Wong39732ca2013-04-30 15:27:38 -0700128 * Avoid increasing the size of this struct, there can be many thousands
129 * of these on a server and we do not want this to take another cache line.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130 */
131struct epitem {
Jason Baronae10b2b2013-11-12 15:10:16 -0800132 union {
133 /* RB tree node links this structure to the eventpoll RB tree */
134 struct rb_node rbn;
135 /* Used to free the struct epitem */
136 struct rcu_head rcu;
137 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138
139 /* List header used to link this structure to the eventpoll ready list */
140 struct list_head rdllink;
141
Davide Libenzic7ea7632007-05-15 01:40:47 -0700142 /*
143 * Works together "struct eventpoll"->ovflist in keeping the
144 * single linked chain of items.
145 */
146 struct epitem *next;
147
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148 /* The file descriptor information this item refers to */
149 struct epoll_filefd ffd;
150
Paolo Abeni58c9b012023-03-22 17:57:02 +0100151 /*
152 * Protected by file->f_lock, true for to-be-released epitem already
153 * removed from the "struct file" items list; together with
154 * eventpoll->refcount orchestrates "struct eventpoll" disposal
155 */
156 bool dying;
157
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158 /* List containing poll wait queues */
Al Viro80285b72020-09-02 11:45:57 -0400159 struct eppoll_entry *pwqlist;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160
161 /* The "container" of this item */
162 struct eventpoll *ep;
163
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164 /* List header used to link this item to the "struct file" items list */
Al Viro44cdc1d2020-09-27 11:18:30 -0400165 struct hlist_node fllink;
Davide Libenzid47de162007-05-15 01:40:41 -0700166
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200167 /* wakeup_source used when EPOLLWAKEUP is set */
Eric Wongeea1d582013-04-30 15:27:39 -0700168 struct wakeup_source __rcu *ws;
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200169
Davide Libenzic7ea7632007-05-15 01:40:47 -0700170 /* The structure that describe the interested events and the source fd */
171 struct epoll_event event;
Davide Libenzid47de162007-05-15 01:40:41 -0700172};
173
174/*
175 * This structure is stored inside the "private_data" member of the file
Daniel Balutabf6a41d2011-01-30 23:42:29 +0200176 * structure and represents the main data structure for the eventpoll
Davide Libenzid47de162007-05-15 01:40:41 -0700177 * interface.
178 */
179struct eventpoll {
Davide Libenzid47de162007-05-15 01:40:41 -0700180 /*
181 * This mutex is used to ensure that files are not removed
182 * while epoll is using them. This is held during the event
183 * collection loop, the file cleanup path, the epoll file exit
184 * code and the ctl operations.
185 */
186 struct mutex mtx;
187
188 /* Wait queue used by sys_epoll_wait() */
189 wait_queue_head_t wq;
190
191 /* Wait queue used by file->poll() */
192 wait_queue_head_t poll_wait;
193
194 /* List of ready file descriptors */
195 struct list_head rdllist;
196
Roman Penyaeva218cc42019-03-07 16:28:53 -0800197 /* Lock which protects rdllist and ovflist */
198 rwlock_t lock;
199
Davide Libenzi67647d02007-05-15 01:40:52 -0700200 /* RB tree root used to store monitored fd structs */
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700201 struct rb_root_cached rbr;
Davide Libenzid47de162007-05-15 01:40:41 -0700202
203 /*
204 * This is a single linked list that chains all the "struct epitem" that
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300205 * happened while transferring ready events to userspace w/out
Roman Penyaeva218cc42019-03-07 16:28:53 -0800206 * holding ->lock.
Davide Libenzid47de162007-05-15 01:40:41 -0700207 */
208 struct epitem *ovflist;
Davide Libenzi7ef99642008-12-01 13:13:55 -0800209
Huang Xiaojiae6f79582024-02-06 09:43:53 +0800210 /* wakeup_source used when ep_send_events or __ep_eventpoll_poll is running */
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200211 struct wakeup_source *ws;
212
Davide Libenzi7ef99642008-12-01 13:13:55 -0800213 /* The user that created the eventpoll descriptor */
214 struct user_struct *user;
Jason Baron28d82dc2012-01-12 17:17:43 -0800215
216 struct file *file;
217
218 /* used to optimize loop detection check */
Al Viro18306c42020-09-10 08:30:05 -0400219 u64 gen;
Al Viro319c1512020-10-01 20:45:51 -0400220 struct hlist_head refs;
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700221
Paolo Abeni58c9b012023-03-22 17:57:02 +0100222 /*
223 * usage count, used together with epitem->dying to
224 * orchestrate the disposal of this struct
225 */
226 refcount_t refcount;
227
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700228#ifdef CONFIG_NET_RX_BUSY_POLL
229 /* used to track busy poll napi_id */
230 unsigned int napi_id;
Joe Damato85455c72024-02-13 06:16:42 +0000231 /* busy poll timeout */
232 u32 busy_poll_usecs;
Joe Damatoc6aa2a72024-02-13 06:16:43 +0000233 /* busy poll packet budget */
234 u16 busy_poll_budget;
Joe Damatode57a252024-02-13 06:16:44 +0000235 bool prefer_busy_poll;
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700236#endif
Jason Baronefcdd352020-04-06 20:11:23 -0700237
238#ifdef CONFIG_DEBUG_LOCK_ALLOC
239 /* tracks wakeup nests for lockdep validation */
240 u8 nests;
241#endif
Davide Libenzid47de162007-05-15 01:40:41 -0700242};
243
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244/* Wrapper struct used by poll queueing */
245struct ep_pqueue {
246 poll_table pt;
247 struct epitem *epi;
248};
249
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250/*
Davide Libenzi7ef99642008-12-01 13:13:55 -0800251 * Configuration options available inside /proc/sys/fs/epoll/
252 */
Davide Libenzi7ef99642008-12-01 13:13:55 -0800253/* Maximum number of epoll watched descriptors, per user */
Robin Holt52bd19f72011-01-12 17:00:01 -0800254static long max_user_watches __read_mostly;
Davide Libenzi7ef99642008-12-01 13:13:55 -0800255
Paolo Abeni58c9b012023-03-22 17:57:02 +0100256/* Used for cycles detection */
Davidlohr Buesod4cb6262023-04-11 16:41:59 -0700257static DEFINE_MUTEX(epnested_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258
Al Viro18306c42020-09-10 08:30:05 -0400259static u64 loop_check_gen = 0;
260
Davide Libenzi22bacca2011-02-25 14:44:12 -0800261/* Used to check for epoll file descriptor inclusion loops */
Al Viro6a3890c2020-09-26 16:29:02 -0400262static struct eventpoll *inserting_into;
Davide Libenzi22bacca2011-02-25 14:44:12 -0800263
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264/* Slab cache used to allocate "struct epitem" */
Alexey Dobriyan68279f92023-10-11 19:55:00 +0300265static struct kmem_cache *epi_cache __ro_after_init;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266
267/* Slab cache used to allocate "struct eppoll_entry" */
Alexey Dobriyan68279f92023-10-11 19:55:00 +0300268static struct kmem_cache *pwq_cache __ro_after_init;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269
Jason Baron28d82dc2012-01-12 17:17:43 -0800270/*
271 * List of files with newly added links, where we may need to limit the number
Davidlohr Buesod4cb6262023-04-11 16:41:59 -0700272 * of emanating paths. Protected by the epnested_mutex.
Jason Baron28d82dc2012-01-12 17:17:43 -0800273 */
Al Viro319c1512020-10-01 20:45:51 -0400274struct epitems_head {
275 struct hlist_head epitems;
276 struct epitems_head *next;
277};
278static struct epitems_head *tfile_check_list = EP_UNACTIVE_PTR;
279
Alexey Dobriyan68279f92023-10-11 19:55:00 +0300280static struct kmem_cache *ephead_cache __ro_after_init;
Al Viro319c1512020-10-01 20:45:51 -0400281
282static inline void free_ephead(struct epitems_head *head)
283{
284 if (head)
285 kmem_cache_free(ephead_cache, head);
286}
287
288static void list_file(struct file *file)
289{
290 struct epitems_head *head;
291
292 head = container_of(file->f_ep, struct epitems_head, epitems);
293 if (!head->next) {
294 head->next = tfile_check_list;
295 tfile_check_list = head;
296 }
297}
298
299static void unlist_file(struct epitems_head *head)
300{
301 struct epitems_head *to_free = head;
302 struct hlist_node *p = rcu_dereference(hlist_first_rcu(&head->epitems));
303 if (p) {
304 struct epitem *epi= container_of(p, struct epitem, fllink);
305 spin_lock(&epi->ffd.file->f_lock);
306 if (!hlist_empty(&head->epitems))
307 to_free = NULL;
308 head->next = NULL;
309 spin_unlock(&epi->ffd.file->f_lock);
310 }
311 free_ephead(to_free);
312}
Jason Baron28d82dc2012-01-12 17:17:43 -0800313
Davide Libenzi7ef99642008-12-01 13:13:55 -0800314#ifdef CONFIG_SYSCTL
315
316#include <linux/sysctl.h>
317
Matteo Croceeec48442019-07-18 15:58:50 -0700318static long long_zero;
Robin Holt52bd19f72011-01-12 17:00:01 -0800319static long long_max = LONG_MAX;
Davide Libenzi7ef99642008-12-01 13:13:55 -0800320
Joel Granados1751f872025-01-28 13:48:37 +0100321static const struct ctl_table epoll_table[] = {
Davide Libenzi7ef99642008-12-01 13:13:55 -0800322 {
Davide Libenzi7ef99642008-12-01 13:13:55 -0800323 .procname = "max_user_watches",
324 .data = &max_user_watches,
Robin Holt52bd19f72011-01-12 17:00:01 -0800325 .maxlen = sizeof(max_user_watches),
Davide Libenzi7ef99642008-12-01 13:13:55 -0800326 .mode = 0644,
Robin Holt52bd19f72011-01-12 17:00:01 -0800327 .proc_handler = proc_doulongvec_minmax,
Matteo Croceeec48442019-07-18 15:58:50 -0700328 .extra1 = &long_zero,
Robin Holt52bd19f72011-01-12 17:00:01 -0800329 .extra2 = &long_max,
Davide Libenzi7ef99642008-12-01 13:13:55 -0800330 },
Davide Libenzi7ef99642008-12-01 13:13:55 -0800331};
Xiaoming Nia8f5de82022-01-21 22:12:09 -0800332
333static void __init epoll_sysctls_init(void)
334{
335 register_sysctl("fs/epoll", epoll_table);
336}
337#else
338#define epoll_sysctls_init() do { } while (0)
Davide Libenzi7ef99642008-12-01 13:13:55 -0800339#endif /* CONFIG_SYSCTL */
340
Jason Baron28d82dc2012-01-12 17:17:43 -0800341static const struct file_operations eventpoll_fops;
342
343static inline int is_file_epoll(struct file *f)
344{
345 return f->f_op == &eventpoll_fops;
346}
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700347
Davide Libenzi67647d02007-05-15 01:40:52 -0700348/* Setup the structure that is used as key for the RB tree */
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700349static inline void ep_set_ffd(struct epoll_filefd *ffd,
350 struct file *file, int fd)
351{
352 ffd->file = file;
353 ffd->fd = fd;
354}
355
Davide Libenzi67647d02007-05-15 01:40:52 -0700356/* Compare RB tree keys */
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700357static inline int ep_cmp_ffd(struct epoll_filefd *p1,
358 struct epoll_filefd *p2)
359{
360 return (p1->file > p2->file ? +1:
361 (p1->file < p2->file ? -1 : p1->fd - p2->fd));
362}
363
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700364/* Tells us if the item is currently linked */
Davidlohr Bueso992991c2018-08-21 21:58:26 -0700365static inline int ep_is_linked(struct epitem *epi)
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700366{
Davidlohr Bueso992991c2018-08-21 21:58:26 -0700367 return !list_empty(&epi->rdllink);
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700368}
369
Ingo Molnarac6424b2017-06-20 12:06:13 +0200370static inline struct eppoll_entry *ep_pwq_from_wait(wait_queue_entry_t *p)
Oleg Nesterov971316f2012-02-24 20:07:29 +0100371{
372 return container_of(p, struct eppoll_entry, wait);
373}
374
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700375/* Get the "struct epitem" from a wait queue pointer */
Ingo Molnarac6424b2017-06-20 12:06:13 +0200376static inline struct epitem *ep_item_from_wait(wait_queue_entry_t *p)
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700377{
378 return container_of(p, struct eppoll_entry, wait)->base;
379}
380
Davide Libenzi5071f972009-03-31 15:24:10 -0700381/**
Davide Libenzi3fb0e582011-03-22 16:34:46 -0700382 * ep_events_available - Checks if ready events might be available.
383 *
384 * @ep: Pointer to the eventpoll context.
385 *
Randy Dunlapa6c67fe2021-03-01 15:25:51 -0700386 * Return: a value different than %zero if ready events are available,
387 * or %zero otherwise.
Davide Libenzi3fb0e582011-03-22 16:34:46 -0700388 */
389static inline int ep_events_available(struct eventpoll *ep)
390{
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -0800391 return !list_empty_careful(&ep->rdllist) ||
392 READ_ONCE(ep->ovflist) != EP_UNACTIVE_PTR;
Davide Libenzi3fb0e582011-03-22 16:34:46 -0700393}
394
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700395#ifdef CONFIG_NET_RX_BUSY_POLL
Joe Damato85455c72024-02-13 06:16:42 +0000396/**
397 * busy_loop_ep_timeout - check if busy poll has timed out. The timeout value
398 * from the epoll instance ep is preferred, but if it is not set fallback to
399 * the system-wide global via busy_loop_timeout.
400 *
401 * @start_time: The start time used to compute the remaining time until timeout.
402 * @ep: Pointer to the eventpoll context.
403 *
404 * Return: true if the timeout has expired, false otherwise.
405 */
406static bool busy_loop_ep_timeout(unsigned long start_time,
407 struct eventpoll *ep)
408{
409 unsigned long bp_usec = READ_ONCE(ep->busy_poll_usecs);
410
411 if (bp_usec) {
412 unsigned long end_time = start_time + bp_usec;
413 unsigned long now = busy_loop_current_time();
414
415 return time_after(now, end_time);
416 } else {
417 return busy_loop_timeout(start_time);
418 }
419}
420
421static bool ep_busy_loop_on(struct eventpoll *ep)
422{
Martin Karstenab5b28b2024-11-09 05:02:33 +0000423 return !!READ_ONCE(ep->busy_poll_usecs) ||
424 READ_ONCE(ep->prefer_busy_poll) ||
425 net_busy_loop_on();
Joe Damato85455c72024-02-13 06:16:42 +0000426}
427
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700428static bool ep_busy_loop_end(void *p, unsigned long start_time)
429{
430 struct eventpoll *ep = p;
431
Joe Damato85455c72024-02-13 06:16:42 +0000432 return ep_events_available(ep) || busy_loop_ep_timeout(start_time, ep);
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700433}
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700434
435/*
436 * Busy poll if globally on and supporting sockets found && no events,
437 * busy loop will return if need_resched or ep_events_available.
438 *
439 * we must do our busy polling with irqs enabled
440 */
Soheil Hassas Yeganeh1493c472020-12-18 14:01:57 -0800441static bool ep_busy_loop(struct eventpoll *ep, int nonblock)
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700442{
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700443 unsigned int napi_id = READ_ONCE(ep->napi_id);
Joe Damatoc6aa2a72024-02-13 06:16:43 +0000444 u16 budget = READ_ONCE(ep->busy_poll_budget);
Joe Damatode57a252024-02-13 06:16:44 +0000445 bool prefer_busy_poll = READ_ONCE(ep->prefer_busy_poll);
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700446
Joe Damatoc6aa2a72024-02-13 06:16:43 +0000447 if (!budget)
448 budget = BUSY_POLL_BUDGET;
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700449
Joe Damato85455c72024-02-13 06:16:42 +0000450 if (napi_id >= MIN_NAPI_ID && ep_busy_loop_on(ep)) {
Joe Damatode57a252024-02-13 06:16:44 +0000451 napi_busy_loop(napi_id, nonblock ? NULL : ep_busy_loop_end,
452 ep, prefer_busy_poll, budget);
Soheil Hassas Yeganeh1493c472020-12-18 14:01:57 -0800453 if (ep_events_available(ep))
454 return true;
455 /*
456 * Busy poll timed out. Drop NAPI ID for now, we can add
457 * it back in when we have moved a socket with a valid NAPI
458 * ID onto the ready list.
459 */
Martin Karsten8a6de262024-11-09 05:02:34 +0000460 if (prefer_busy_poll)
461 napi_resume_irqs(napi_id);
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700462 ep->napi_id = 0;
Soheil Hassas Yeganeh1493c472020-12-18 14:01:57 -0800463 return false;
464 }
465 return false;
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700466}
467
468/*
469 * Set epoll busy poll NAPI ID from sk.
470 */
471static inline void ep_set_busy_poll_napi_id(struct epitem *epi)
472{
Joe Damato85455c72024-02-13 06:16:42 +0000473 struct eventpoll *ep = epi->ep;
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700474 unsigned int napi_id;
475 struct socket *sock;
476 struct sock *sk;
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700477
Joe Damato85455c72024-02-13 06:16:42 +0000478 if (!ep_busy_loop_on(ep))
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700479 return;
480
Florent Revestdba4a922020-12-04 12:36:04 +0100481 sock = sock_from_file(epi->ffd.file);
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700482 if (!sock)
483 return;
484
485 sk = sock->sk;
486 if (!sk)
487 return;
488
489 napi_id = READ_ONCE(sk->sk_napi_id);
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700490
491 /* Non-NAPI IDs can be rejected
492 * or
493 * Nothing to do if we already have this ID
494 */
495 if (napi_id < MIN_NAPI_ID || napi_id == ep->napi_id)
496 return;
497
498 /* record NAPI ID for use in next busy poll */
499 ep->napi_id = napi_id;
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700500}
501
Joe Damato18e2bf02024-02-13 06:16:45 +0000502static long ep_eventpoll_bp_ioctl(struct file *file, unsigned int cmd,
503 unsigned long arg)
504{
505 struct eventpoll *ep = file->private_data;
506 void __user *uarg = (void __user *)arg;
507 struct epoll_params epoll_params;
508
509 switch (cmd) {
510 case EPIOCSPARAMS:
511 if (copy_from_user(&epoll_params, uarg, sizeof(epoll_params)))
512 return -EFAULT;
513
514 /* pad byte must be zero */
515 if (epoll_params.__pad)
516 return -EINVAL;
517
518 if (epoll_params.busy_poll_usecs > S32_MAX)
519 return -EINVAL;
520
521 if (epoll_params.prefer_busy_poll > 1)
522 return -EINVAL;
523
524 if (epoll_params.busy_poll_budget > NAPI_POLL_WEIGHT &&
525 !capable(CAP_NET_ADMIN))
526 return -EPERM;
527
528 WRITE_ONCE(ep->busy_poll_usecs, epoll_params.busy_poll_usecs);
529 WRITE_ONCE(ep->busy_poll_budget, epoll_params.busy_poll_budget);
530 WRITE_ONCE(ep->prefer_busy_poll, epoll_params.prefer_busy_poll);
531 return 0;
532 case EPIOCGPARAMS:
533 memset(&epoll_params, 0, sizeof(epoll_params));
534 epoll_params.busy_poll_usecs = READ_ONCE(ep->busy_poll_usecs);
535 epoll_params.busy_poll_budget = READ_ONCE(ep->busy_poll_budget);
536 epoll_params.prefer_busy_poll = READ_ONCE(ep->prefer_busy_poll);
537 if (copy_to_user(uarg, &epoll_params, sizeof(epoll_params)))
538 return -EFAULT;
539 return 0;
540 default:
541 return -ENOIOCTLCMD;
542 }
543}
544
Martin Karsten8a6de262024-11-09 05:02:34 +0000545static void ep_suspend_napi_irqs(struct eventpoll *ep)
546{
547 unsigned int napi_id = READ_ONCE(ep->napi_id);
548
549 if (napi_id >= MIN_NAPI_ID && READ_ONCE(ep->prefer_busy_poll))
550 napi_suspend_irqs(napi_id);
551}
552
553static void ep_resume_napi_irqs(struct eventpoll *ep)
554{
555 unsigned int napi_id = READ_ONCE(ep->napi_id);
556
557 if (napi_id >= MIN_NAPI_ID && READ_ONCE(ep->prefer_busy_poll))
558 napi_resume_irqs(napi_id);
559}
560
Davidlohr Bueso514056d2018-08-21 21:58:19 -0700561#else
562
Soheil Hassas Yeganeh1493c472020-12-18 14:01:57 -0800563static inline bool ep_busy_loop(struct eventpoll *ep, int nonblock)
Davidlohr Bueso514056d2018-08-21 21:58:19 -0700564{
Soheil Hassas Yeganeh1493c472020-12-18 14:01:57 -0800565 return false;
Davidlohr Bueso514056d2018-08-21 21:58:19 -0700566}
567
568static inline void ep_set_busy_poll_napi_id(struct epitem *epi)
569{
570}
571
Joe Damato18e2bf02024-02-13 06:16:45 +0000572static long ep_eventpoll_bp_ioctl(struct file *file, unsigned int cmd,
573 unsigned long arg)
574{
575 return -EOPNOTSUPP;
576}
577
Martin Karsten8a6de262024-11-09 05:02:34 +0000578static void ep_suspend_napi_irqs(struct eventpoll *ep)
579{
580}
581
582static void ep_resume_napi_irqs(struct eventpoll *ep)
583{
584}
585
Davidlohr Bueso514056d2018-08-21 21:58:19 -0700586#endif /* CONFIG_NET_RX_BUSY_POLL */
587
Steven Rostedt02edc6f2012-03-23 15:02:27 -0700588/*
589 * As described in commit 0ccf831cb lockdep: annotate epoll
590 * the use of wait queues used by epoll is done in a very controlled
591 * manner. Wake ups can nest inside each other, but are never done
592 * with the same locking. For example:
593 *
594 * dfd = socket(...);
595 * efd1 = epoll_create();
596 * efd2 = epoll_create();
597 * epoll_ctl(efd1, EPOLL_CTL_ADD, dfd, ...);
598 * epoll_ctl(efd2, EPOLL_CTL_ADD, efd1, ...);
599 *
600 * When a packet arrives to the device underneath "dfd", the net code will
601 * issue a wake_up() on its poll wake list. Epoll (efd1) has installed a
602 * callback wakeup entry on that queue, and the wake_up() performed by the
603 * "dfd" net code will end up in ep_poll_callback(). At this point epoll
604 * (efd1) notices that it may have some event ready, so it needs to wake up
605 * the waiters on its poll wait list (efd2). So it calls ep_poll_safewake()
606 * that ends up in another wake_up(), after having checked about the
Changcheng Liu7059a9a2023-03-12 17:25:22 +0800607 * recursion constraints. That are, no more than EP_MAX_NESTS, to avoid
608 * stack blasting.
Steven Rostedt02edc6f2012-03-23 15:02:27 -0700609 *
610 * When CONFIG_DEBUG_LOCK_ALLOC is enabled, make sure lockdep can handle
611 * this special case of epoll.
612 */
Davide Libenzi2dfa4ee2009-03-31 15:24:22 -0700613#ifdef CONFIG_DEBUG_LOCK_ALLOC
Davide Libenzi2dfa4ee2009-03-31 15:24:22 -0700614
Jens Axboecaf1aea2022-11-20 10:10:53 -0700615static void ep_poll_safewake(struct eventpoll *ep, struct epitem *epi,
616 unsigned pollflags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617{
Jason Baronefcdd352020-04-06 20:11:23 -0700618 struct eventpoll *ep_src;
Jason Baronf6520c52019-12-04 16:52:12 -0800619 unsigned long flags;
Jason Baronefcdd352020-04-06 20:11:23 -0700620 u8 nests = 0;
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700621
Jason Baronefcdd352020-04-06 20:11:23 -0700622 /*
623 * To set the subclass or nesting level for spin_lock_irqsave_nested()
624 * it might be natural to create a per-cpu nest count. However, since
625 * we can recurse on ep->poll_wait.lock, and a non-raw spinlock can
626 * schedule() in the -rt kernel, the per-cpu variable are no longer
627 * protected. Thus, we are introducing a per eventpoll nest field.
628 * If we are not being call from ep_poll_callback(), epi is NULL and
629 * we are at the first level of nesting, 0. Otherwise, we are being
630 * called from ep_poll_callback() and if a previous wakeup source is
631 * not an epoll file itself, we are at depth 1 since the wakeup source
632 * is depth 0. If the wakeup source is a previous epoll file in the
633 * wakeup chain then we use its nests value and record ours as
634 * nests + 1. The previous epoll file nests value is stable since its
635 * already holding its own poll_wait.lock.
636 */
637 if (epi) {
638 if ((is_file_epoll(epi->ffd.file))) {
639 ep_src = epi->ffd.file->private_data;
640 nests = ep_src->nests;
641 } else {
642 nests = 1;
643 }
644 }
645 spin_lock_irqsave_nested(&ep->poll_wait.lock, flags, nests);
646 ep->nests = nests + 1;
Jens Axboecaf1aea2022-11-20 10:10:53 -0700647 wake_up_locked_poll(&ep->poll_wait, EPOLLIN | pollflags);
Jason Baronefcdd352020-04-06 20:11:23 -0700648 ep->nests = 0;
649 spin_unlock_irqrestore(&ep->poll_wait.lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650}
651
Jason Baron57a173b2017-11-17 15:29:02 -0800652#else
653
Jens Axboecaf1aea2022-11-20 10:10:53 -0700654static void ep_poll_safewake(struct eventpoll *ep, struct epitem *epi,
Min-Hua Chen38f17552023-05-12 00:46:25 +0800655 __poll_t pollflags)
Jason Baron57a173b2017-11-17 15:29:02 -0800656{
Jens Axboecaf1aea2022-11-20 10:10:53 -0700657 wake_up_poll(&ep->poll_wait, EPOLLIN | pollflags);
Jason Baron57a173b2017-11-17 15:29:02 -0800658}
659
660#endif
661
Oleg Nesterov971316f2012-02-24 20:07:29 +0100662static void ep_remove_wait_queue(struct eppoll_entry *pwq)
663{
664 wait_queue_head_t *whead;
665
666 rcu_read_lock();
Oleg Nesterov138e4ad2017-09-01 18:55:33 +0200667 /*
668 * If it is cleared by POLLFREE, it should be rcu-safe.
669 * If we read NULL we need a barrier paired with
670 * smp_store_release() in ep_poll_callback(), otherwise
671 * we rely on whead->lock.
672 */
673 whead = smp_load_acquire(&pwq->whead);
Oleg Nesterov971316f2012-02-24 20:07:29 +0100674 if (whead)
675 remove_wait_queue(whead, &pwq->wait);
676 rcu_read_unlock();
677}
678
Davide Libenzi7699acd2007-05-10 22:23:23 -0700679/*
Tony Battersbyd1bc90d2009-03-31 15:24:15 -0700680 * This function unregisters poll callbacks from the associated file
Paolo Abeni58c9b012023-03-22 17:57:02 +0100681 * descriptor. Must be called with "mtx" held.
Davide Libenzi7699acd2007-05-10 22:23:23 -0700682 */
683static void ep_unregister_pollwait(struct eventpoll *ep, struct epitem *epi)
684{
Al Viro80285b72020-09-02 11:45:57 -0400685 struct eppoll_entry **p = &epi->pwqlist;
Davide Libenzi7699acd2007-05-10 22:23:23 -0700686 struct eppoll_entry *pwq;
687
Al Viro80285b72020-09-02 11:45:57 -0400688 while ((pwq = *p) != NULL) {
689 *p = pwq->next;
Oleg Nesterov971316f2012-02-24 20:07:29 +0100690 ep_remove_wait_queue(pwq);
Tony Battersbyd1bc90d2009-03-31 15:24:15 -0700691 kmem_cache_free(pwq_cache, pwq);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700692 }
693}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694
Eric Wongeea1d582013-04-30 15:27:39 -0700695/* call only when ep->mtx is held */
696static inline struct wakeup_source *ep_wakeup_source(struct epitem *epi)
697{
698 return rcu_dereference_check(epi->ws, lockdep_is_held(&epi->ep->mtx));
699}
700
701/* call only when ep->mtx is held */
702static inline void ep_pm_stay_awake(struct epitem *epi)
703{
704 struct wakeup_source *ws = ep_wakeup_source(epi);
705
706 if (ws)
707 __pm_stay_awake(ws);
708}
709
710static inline bool ep_has_wakeup_source(struct epitem *epi)
711{
712 return rcu_access_pointer(epi->ws) ? true : false;
713}
714
715/* call when ep->mtx cannot be held (ep_poll_callback) */
716static inline void ep_pm_stay_awake_rcu(struct epitem *epi)
717{
718 struct wakeup_source *ws;
719
720 rcu_read_lock();
721 ws = rcu_dereference(epi->ws);
722 if (ws)
723 __pm_stay_awake(ws);
724 rcu_read_unlock();
725}
726
Al Viro57804b12020-08-31 13:41:30 -0400727
728/*
729 * ep->mutex needs to be held because we could be hit by
730 * eventpoll_release_file() and epoll_ctl().
Davide Libenzi5071f972009-03-31 15:24:10 -0700731 */
Al Viro57804b12020-08-31 13:41:30 -0400732static void ep_start_scan(struct eventpoll *ep, struct list_head *txlist)
Davide Libenzi5071f972009-03-31 15:24:10 -0700733{
Davide Libenzi5071f972009-03-31 15:24:10 -0700734 /*
735 * Steal the ready list, and re-init the original one to the
736 * empty list. Also, set ep->ovflist to NULL so that events
737 * happening while looping w/out locks, are not lost. We cannot
738 * have the poll callback to queue directly on ep->rdllist,
739 * because we want the "sproc" callback to be able to do it
740 * in a lockless way.
741 */
Al Viro57804b12020-08-31 13:41:30 -0400742 lockdep_assert_irqs_enabled();
Roman Penyaeva218cc42019-03-07 16:28:53 -0800743 write_lock_irq(&ep->lock);
Al Virodb502f82020-08-31 13:06:51 -0400744 list_splice_init(&ep->rdllist, txlist);
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -0800745 WRITE_ONCE(ep->ovflist, NULL);
Roman Penyaeva218cc42019-03-07 16:28:53 -0800746 write_unlock_irq(&ep->lock);
Al Virodb502f82020-08-31 13:06:51 -0400747}
Davide Libenzi5071f972009-03-31 15:24:10 -0700748
Al Virodb502f82020-08-31 13:06:51 -0400749static void ep_done_scan(struct eventpoll *ep,
Al Virodb502f82020-08-31 13:06:51 -0400750 struct list_head *txlist)
751{
752 struct epitem *epi, *nepi;
Davide Libenzi5071f972009-03-31 15:24:10 -0700753
Roman Penyaeva218cc42019-03-07 16:28:53 -0800754 write_lock_irq(&ep->lock);
Davide Libenzi5071f972009-03-31 15:24:10 -0700755 /*
756 * During the time we spent inside the "sproc" callback, some
757 * other events might have been queued by the poll callback.
758 * We re-insert them inside the main ready-list here.
759 */
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -0800760 for (nepi = READ_ONCE(ep->ovflist); (epi = nepi) != NULL;
Davide Libenzi5071f972009-03-31 15:24:10 -0700761 nepi = epi->next, epi->next = EP_UNACTIVE_PTR) {
762 /*
763 * We need to check if the item is already in the list.
764 * During the "sproc" callback execution time, items are
765 * queued into ->ovflist but the "txlist" might already
766 * contain them, and the list_splice() below takes care of them.
767 */
Davidlohr Bueso992991c2018-08-21 21:58:26 -0700768 if (!ep_is_linked(epi)) {
Roman Penyaevc1411752019-03-07 16:28:46 -0800769 /*
770 * ->ovflist is LIFO, so we have to reverse it in order
771 * to keep in FIFO.
772 */
773 list_add(&epi->rdllink, &ep->rdllist);
Eric Wongeea1d582013-04-30 15:27:39 -0700774 ep_pm_stay_awake(epi);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200775 }
Davide Libenzi5071f972009-03-31 15:24:10 -0700776 }
777 /*
778 * We need to set back ep->ovflist to EP_UNACTIVE_PTR, so that after
779 * releasing the lock, events will be queued in the normal way inside
780 * ep->rdllist.
781 */
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -0800782 WRITE_ONCE(ep->ovflist, EP_UNACTIVE_PTR);
Davide Libenzi5071f972009-03-31 15:24:10 -0700783
784 /*
785 * Quickly re-inject items left on "txlist".
786 */
Al Virodb502f82020-08-31 13:06:51 -0400787 list_splice(txlist, &ep->rdllist);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200788 __pm_relax(ep->ws);
Davidlohr Bueso7fab29e2021-05-06 18:04:07 -0700789
790 if (!list_empty(&ep->rdllist)) {
791 if (waitqueue_active(&ep->wq))
792 wake_up(&ep->wq);
793 }
794
Roman Penyaeva218cc42019-03-07 16:28:53 -0800795 write_unlock_irq(&ep->lock);
Davide Libenzi5071f972009-03-31 15:24:10 -0700796}
797
Paolo Abeni58c9b012023-03-22 17:57:02 +0100798static void ep_get(struct eventpoll *ep)
799{
800 refcount_inc(&ep->refcount);
801}
802
803/*
804 * Returns true if the event poll can be disposed
805 */
806static bool ep_refcount_dec_and_test(struct eventpoll *ep)
807{
808 if (!refcount_dec_and_test(&ep->refcount))
809 return false;
810
811 WARN_ON_ONCE(!RB_EMPTY_ROOT(&ep->rbr.rb_root));
812 return true;
813}
814
815static void ep_free(struct eventpoll *ep)
816{
Martin Karsten8a6de262024-11-09 05:02:34 +0000817 ep_resume_napi_irqs(ep);
Paolo Abeni58c9b012023-03-22 17:57:02 +0100818 mutex_destroy(&ep->mtx);
819 free_uid(ep->user);
820 wakeup_source_unregister(ep->ws);
821 kfree(ep);
822}
823
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824/*
Davide Libenzi7699acd2007-05-10 22:23:23 -0700825 * Removes a "struct epitem" from the eventpoll RB tree and deallocates
Davide Libenzic7ea7632007-05-15 01:40:47 -0700826 * all the associated resources. Must be called with "mtx" held.
Paolo Abeni58c9b012023-03-22 17:57:02 +0100827 * If the dying flag is set, do the removal only if force is true.
828 * This prevents ep_clear_and_put() from dropping all the ep references
829 * while running concurrently with eventpoll_release_file().
830 * Returns true if the eventpoll can be disposed.
Davide Libenzi7699acd2007-05-10 22:23:23 -0700831 */
Paolo Abeni58c9b012023-03-22 17:57:02 +0100832static bool __ep_remove(struct eventpoll *ep, struct epitem *epi, bool force)
Davide Libenzi7699acd2007-05-10 22:23:23 -0700833{
Davide Libenzi7699acd2007-05-10 22:23:23 -0700834 struct file *file = epi->ffd.file;
Al Viro319c1512020-10-01 20:45:51 -0400835 struct epitems_head *to_free;
836 struct hlist_head *head;
Davide Libenzi7699acd2007-05-10 22:23:23 -0700837
Davidlohr Bueso92e64172018-08-21 21:56:45 -0700838 lockdep_assert_irqs_enabled();
839
Davide Libenzi7699acd2007-05-10 22:23:23 -0700840 /*
Christoph Hellwigee8ef0a2018-08-21 21:56:26 -0700841 * Removes poll wait queue hooks.
Davide Libenzi7699acd2007-05-10 22:23:23 -0700842 */
843 ep_unregister_pollwait(ep, epi);
844
845 /* Remove the current item from the list of epoll hooks */
Jonathan Corbet68499912009-02-06 13:52:43 -0700846 spin_lock(&file->f_lock);
Paolo Abeni58c9b012023-03-22 17:57:02 +0100847 if (epi->dying && !force) {
848 spin_unlock(&file->f_lock);
849 return false;
850 }
851
Al Viro319c1512020-10-01 20:45:51 -0400852 to_free = NULL;
853 head = file->f_ep;
854 if (head->first == &epi->fllink && !epi->fllink.next) {
Christian Brauner64743532024-09-25 11:05:16 +0200855 /* See eventpoll_release() for details. */
856 WRITE_ONCE(file->f_ep, NULL);
Al Viro319c1512020-10-01 20:45:51 -0400857 if (!is_file_epoll(file)) {
858 struct epitems_head *v;
859 v = container_of(head, struct epitems_head, epitems);
860 if (!smp_load_acquire(&v->next))
861 to_free = v;
862 }
863 }
Al Viro44cdc1d2020-09-27 11:18:30 -0400864 hlist_del_rcu(&epi->fllink);
Jonathan Corbet68499912009-02-06 13:52:43 -0700865 spin_unlock(&file->f_lock);
Al Viro319c1512020-10-01 20:45:51 -0400866 free_ephead(to_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700868 rb_erase_cached(&epi->rbn, &ep->rbr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869
Roman Penyaeva218cc42019-03-07 16:28:53 -0800870 write_lock_irq(&ep->lock);
Davidlohr Bueso992991c2018-08-21 21:58:26 -0700871 if (ep_is_linked(epi))
Davide Libenzic7ea7632007-05-15 01:40:47 -0700872 list_del_init(&epi->rdllink);
Roman Penyaeva218cc42019-03-07 16:28:53 -0800873 write_unlock_irq(&ep->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874
Eric Wongeea1d582013-04-30 15:27:39 -0700875 wakeup_source_unregister(ep_wakeup_source(epi));
Jason Baronae10b2b2013-11-12 15:10:16 -0800876 /*
877 * At this point it is safe to free the eventpoll item. Use the union
878 * field epi->rcu, since we are trying to minimize the size of
879 * 'struct epitem'. The 'rbn' field is no longer in use. Protected by
880 * ep->mtx. The rcu read side, reverse_path_check_proc(), does not make
881 * use of the rbn field.
882 */
Dmitry Antipov0611a642024-02-21 14:22:05 +0300883 kfree_rcu(epi, rcu);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884
Nicholas Piggin1e1c1582021-09-07 20:00:00 -0700885 percpu_counter_dec(&ep->user->epoll_watches);
Paolo Abeni58c9b012023-03-22 17:57:02 +0100886 return ep_refcount_dec_and_test(ep);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887}
888
Paolo Abeni58c9b012023-03-22 17:57:02 +0100889/*
890 * ep_remove variant for callers owing an additional reference to the ep
891 */
892static void ep_remove_safe(struct eventpoll *ep, struct epitem *epi)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893{
Paolo Abeni58c9b012023-03-22 17:57:02 +0100894 WARN_ON_ONCE(__ep_remove(ep, epi, false));
895}
896
897static void ep_clear_and_put(struct eventpoll *ep)
898{
899 struct rb_node *rbp, *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900 struct epitem *epi;
Paolo Abeni58c9b012023-03-22 17:57:02 +0100901 bool dispose;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902
903 /* We need to release all tasks waiting for these file */
904 if (waitqueue_active(&ep->poll_wait))
Jens Axboecaf1aea2022-11-20 10:10:53 -0700905 ep_poll_safewake(ep, NULL, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906
Paolo Abeni58c9b012023-03-22 17:57:02 +0100907 mutex_lock(&ep->mtx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700908
909 /*
910 * Walks through the whole tree by unregistering poll callbacks.
911 */
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700912 for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913 epi = rb_entry(rbp, struct epitem, rbn);
914
915 ep_unregister_pollwait(ep, epi);
Eric Dumazet91cf5ab2013-09-11 14:24:06 -0700916 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917 }
918
919 /*
Paolo Abeni58c9b012023-03-22 17:57:02 +0100920 * Walks through the whole tree and try to free each "struct epitem".
921 * Note that ep_remove_safe() will not remove the epitem in case of a
922 * racing eventpoll_release_file(); the latter will do the removal.
923 * At this point we are sure no poll callbacks will be lingering around.
924 * Since we still own a reference to the eventpoll struct, the loop can't
925 * dispose it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700926 */
Paolo Abeni58c9b012023-03-22 17:57:02 +0100927 for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = next) {
928 next = rb_next(rbp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929 epi = rb_entry(rbp, struct epitem, rbn);
Paolo Abeni58c9b012023-03-22 17:57:02 +0100930 ep_remove_safe(ep, epi);
Eric Dumazet91cf5ab2013-09-11 14:24:06 -0700931 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932 }
Paolo Abeni58c9b012023-03-22 17:57:02 +0100933
934 dispose = ep_refcount_dec_and_test(ep);
Eric Wongddf676c2013-04-30 15:27:40 -0700935 mutex_unlock(&ep->mtx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936
Paolo Abeni58c9b012023-03-22 17:57:02 +0100937 if (dispose)
938 ep_free(ep);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939}
940
Joe Damato18e2bf02024-02-13 06:16:45 +0000941static long ep_eventpoll_ioctl(struct file *file, unsigned int cmd,
942 unsigned long arg)
943{
944 int ret;
945
946 if (!is_file_epoll(file))
947 return -EINVAL;
948
949 switch (cmd) {
950 case EPIOCSPARAMS:
951 case EPIOCGPARAMS:
952 ret = ep_eventpoll_bp_ioctl(file, cmd, arg);
953 break;
954 default:
955 ret = -EINVAL;
956 break;
957 }
958
959 return ret;
960}
961
Davide Libenzi7699acd2007-05-10 22:23:23 -0700962static int ep_eventpoll_release(struct inode *inode, struct file *file)
963{
964 struct eventpoll *ep = file->private_data;
965
Davide Libenzif0ee9aa2007-05-15 01:40:57 -0700966 if (ep)
Paolo Abeni58c9b012023-03-22 17:57:02 +0100967 ep_clear_and_put(ep);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700968
Davide Libenzi7699acd2007-05-10 22:23:23 -0700969 return 0;
970}
971
Al Viro2c0b71c2020-09-26 18:48:57 -0400972static __poll_t ep_item_poll(const struct epitem *epi, poll_table *pt, int depth);
Eric Wong450d89e2013-04-30 15:27:42 -0700973
Al Viroad9366b2020-09-26 18:32:48 -0400974static __poll_t __ep_eventpoll_poll(struct file *file, poll_table *wait, int depth)
Jason Baron37b5e522017-11-17 15:29:06 -0800975{
Al Viroad9366b2020-09-26 18:32:48 -0400976 struct eventpoll *ep = file->private_data;
977 LIST_HEAD(txlist);
Davide Libenzi5071f972009-03-31 15:24:10 -0700978 struct epitem *epi, *tmp;
Hans Verkuil626cf232012-03-23 15:02:27 -0700979 poll_table pt;
Al Viro2c0b71c2020-09-26 18:48:57 -0400980 __poll_t res = 0;
Davide Libenzi5071f972009-03-31 15:24:10 -0700981
Hans Verkuil626cf232012-03-23 15:02:27 -0700982 init_poll_funcptr(&pt, NULL);
Eric Wong450d89e2013-04-30 15:27:42 -0700983
Al Viroad9366b2020-09-26 18:32:48 -0400984 /* Insert inside our poll wait queue */
985 poll_wait(file, &ep->poll_wait, wait);
986
987 /*
988 * Proceed to find out if wanted events are really available inside
989 * the ready list.
990 */
991 mutex_lock_nested(&ep->mtx, depth);
992 ep_start_scan(ep, &txlist);
Al Viro2c0b71c2020-09-26 18:48:57 -0400993 list_for_each_entry_safe(epi, tmp, &txlist, rdllink) {
994 if (ep_item_poll(epi, &pt, depth + 1)) {
995 res = EPOLLIN | EPOLLRDNORM;
996 break;
Jason Baron37b5e522017-11-17 15:29:06 -0800997 } else {
Davide Libenzi5071f972009-03-31 15:24:10 -0700998 /*
999 * Item has been dropped into the ready list by the poll
1000 * callback, but it's not actually ready, as far as
1001 * caller requested events goes. We can remove it here.
1002 */
Eric Wongeea1d582013-04-30 15:27:39 -07001003 __pm_relax(ep_wakeup_source(epi));
Davide Libenzi5071f972009-03-31 15:24:10 -07001004 list_del_init(&epi->rdllink);
Davide Libenzi296e2362009-03-31 15:24:11 -07001005 }
Davide Libenzi5071f972009-03-31 15:24:10 -07001006 }
Al Viroad9366b2020-09-26 18:32:48 -04001007 ep_done_scan(ep, &txlist);
1008 mutex_unlock(&ep->mtx);
1009 return res;
1010}
Davide Libenzi5071f972009-03-31 15:24:10 -07001011
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012/*
Linus Torvalds4efaa5a2024-05-03 13:36:09 -07001013 * The ffd.file pointer may be in the process of being torn down due to
1014 * being closed, but we may not have finished eventpoll_release() yet.
1015 *
1016 * Normally, even with the atomic_long_inc_not_zero, the file may have
1017 * been free'd and then gotten re-allocated to something else (since
1018 * files are not RCU-delayed, they are SLAB_TYPESAFE_BY_RCU).
1019 *
1020 * But for epoll, users hold the ep->mtx mutex, and as such any file in
1021 * the process of being free'd will block in eventpoll_release_file()
1022 * and thus the underlying file allocation will not be free'd, and the
1023 * file re-use cannot happen.
1024 *
1025 * For the same reason we can avoid a rcu_read_lock() around the
1026 * operation - 'ffd.file' cannot go away even if the refcount has
1027 * reached zero (but we must still not call out to ->poll() functions
1028 * etc).
1029 */
1030static struct file *epi_fget(const struct epitem *epi)
1031{
1032 struct file *file;
1033
1034 file = epi->ffd.file;
Christian Brauner90ee6ed2024-10-07 16:23:59 +02001035 if (!file_ref_get(&file->f_ref))
Linus Torvalds4efaa5a2024-05-03 13:36:09 -07001036 file = NULL;
1037 return file;
1038}
1039
1040/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001041 * Differs from ep_eventpoll_poll() in that internal callers already have
1042 * the ep->mtx so we need to start from depth=1, such that mutex_lock_nested()
1043 * is correctly annotated.
1044 */
1045static __poll_t ep_item_poll(const struct epitem *epi, poll_table *pt,
1046 int depth)
1047{
Linus Torvalds4efaa5a2024-05-03 13:36:09 -07001048 struct file *file = epi_fget(epi);
Al Viro1ec09972020-08-31 13:16:39 -04001049 __poll_t res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001050
Linus Torvalds4efaa5a2024-05-03 13:36:09 -07001051 /*
1052 * We could return EPOLLERR | EPOLLHUP or something, but let's
1053 * treat this more as "file doesn't exist, poll didn't happen".
1054 */
1055 if (!file)
1056 return 0;
1057
Linus Torvalds1da177e2005-04-16 15:20:36 -07001058 pt->_key = epi->event.events;
Al Viroad9366b2020-09-26 18:32:48 -04001059 if (!is_file_epoll(file))
1060 res = vfs_poll(file, pt);
1061 else
1062 res = __ep_eventpoll_poll(file, pt, depth);
Linus Torvalds4efaa5a2024-05-03 13:36:09 -07001063 fput(file);
Al Viro1ec09972020-08-31 13:16:39 -04001064 return res & epi->event.events;
Davide Libenzi5071f972009-03-31 15:24:10 -07001065}
1066
Linus Torvaldsa11e1d42018-06-28 09:43:44 -07001067static __poll_t ep_eventpoll_poll(struct file *file, poll_table *wait)
Davide Libenzi7699acd2007-05-10 22:23:23 -07001068{
Al Viroad9366b2020-09-26 18:32:48 -04001069 return __ep_eventpoll_poll(file, wait, 0);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001070}
1071
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -08001072#ifdef CONFIG_PROC_FS
Joe Perchesa3816ab2014-09-29 16:08:25 -07001073static void ep_show_fdinfo(struct seq_file *m, struct file *f)
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -08001074{
1075 struct eventpoll *ep = f->private_data;
1076 struct rb_node *rbp;
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -08001077
1078 mutex_lock(&ep->mtx);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001079 for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) {
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -08001080 struct epitem *epi = rb_entry(rbp, struct epitem, rbn);
Cyrill Gorcunov77493f02017-07-12 14:34:25 -07001081 struct inode *inode = file_inode(epi->ffd.file);
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -08001082
Cyrill Gorcunov77493f02017-07-12 14:34:25 -07001083 seq_printf(m, "tfd: %8d events: %8x data: %16llx "
1084 " pos:%lli ino:%lx sdev:%x\n",
Joe Perchesa3816ab2014-09-29 16:08:25 -07001085 epi->ffd.fd, epi->event.events,
Cyrill Gorcunov77493f02017-07-12 14:34:25 -07001086 (long long)epi->event.data,
1087 (long long)epi->ffd.file->f_pos,
1088 inode->i_ino, inode->i_sb->s_dev);
Joe Perchesa3816ab2014-09-29 16:08:25 -07001089 if (seq_has_overflowed(m))
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -08001090 break;
1091 }
1092 mutex_unlock(&ep->mtx);
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -08001093}
1094#endif
1095
Davide Libenzi7699acd2007-05-10 22:23:23 -07001096/* File callbacks that implement the eventpoll file behaviour */
1097static const struct file_operations eventpoll_fops = {
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -08001098#ifdef CONFIG_PROC_FS
1099 .show_fdinfo = ep_show_fdinfo,
1100#endif
Davide Libenzi7699acd2007-05-10 22:23:23 -07001101 .release = ep_eventpoll_release,
Linus Torvaldsa11e1d42018-06-28 09:43:44 -07001102 .poll = ep_eventpoll_poll,
Arnd Bergmann6038f372010-08-15 18:52:59 +02001103 .llseek = noop_llseek,
Joe Damato18e2bf02024-02-13 06:16:45 +00001104 .unlocked_ioctl = ep_eventpoll_ioctl,
1105 .compat_ioctl = compat_ptr_ioctl,
Davide Libenzi7699acd2007-05-10 22:23:23 -07001106};
1107
Davide Libenzi7699acd2007-05-10 22:23:23 -07001108/*
1109 * This is called from eventpoll_release() to unlink files from the eventpoll
1110 * interface. We need to have this facility to cleanup correctly files that are
1111 * closed without being removed from the eventpoll interface.
1112 */
1113void eventpoll_release_file(struct file *file)
1114{
Davide Libenzi7699acd2007-05-10 22:23:23 -07001115 struct eventpoll *ep;
Al Viro44cdc1d2020-09-27 11:18:30 -04001116 struct epitem *epi;
Paolo Abeni58c9b012023-03-22 17:57:02 +01001117 bool dispose;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001118
1119 /*
Paolo Abeni58c9b012023-03-22 17:57:02 +01001120 * Use the 'dying' flag to prevent a concurrent ep_clear_and_put() from
1121 * touching the epitems list before eventpoll_release_file() can access
1122 * the ep->mtx.
Davide Libenzi7699acd2007-05-10 22:23:23 -07001123 */
Paolo Abeni58c9b012023-03-22 17:57:02 +01001124again:
1125 spin_lock(&file->f_lock);
1126 if (file->f_ep && file->f_ep->first) {
1127 epi = hlist_entry(file->f_ep->first, struct epitem, fllink);
1128 epi->dying = true;
1129 spin_unlock(&file->f_lock);
1130
1131 /*
1132 * ep access is safe as we still own a reference to the ep
1133 * struct
1134 */
Davide Libenzi7699acd2007-05-10 22:23:23 -07001135 ep = epi->ep;
Paolo Abeni58c9b012023-03-22 17:57:02 +01001136 mutex_lock(&ep->mtx);
1137 dispose = __ep_remove(ep, epi, true);
Davide Libenzid47de162007-05-15 01:40:41 -07001138 mutex_unlock(&ep->mtx);
Paolo Abeni58c9b012023-03-22 17:57:02 +01001139
1140 if (dispose)
1141 ep_free(ep);
1142 goto again;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001143 }
Paolo Abeni58c9b012023-03-22 17:57:02 +01001144 spin_unlock(&file->f_lock);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001145}
1146
1147static int ep_alloc(struct eventpoll **pep)
1148{
Davide Libenzi7ef99642008-12-01 13:13:55 -08001149 struct eventpoll *ep;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001150
Davide Libenzi7ef99642008-12-01 13:13:55 -08001151 ep = kzalloc(sizeof(*ep), GFP_KERNEL);
1152 if (unlikely(!ep))
Zhen Lei05f26f82023-07-26 11:21:35 +08001153 return -ENOMEM;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001154
Davide Libenzid47de162007-05-15 01:40:41 -07001155 mutex_init(&ep->mtx);
Roman Penyaeva218cc42019-03-07 16:28:53 -08001156 rwlock_init(&ep->lock);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001157 init_waitqueue_head(&ep->wq);
1158 init_waitqueue_head(&ep->poll_wait);
1159 INIT_LIST_HEAD(&ep->rdllist);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001160 ep->rbr = RB_ROOT_CACHED;
Davide Libenzid47de162007-05-15 01:40:41 -07001161 ep->ovflist = EP_UNACTIVE_PTR;
Zhen Lei05f26f82023-07-26 11:21:35 +08001162 ep->user = get_current_user();
Paolo Abeni58c9b012023-03-22 17:57:02 +01001163 refcount_set(&ep->refcount, 1);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001164
1165 *pep = ep;
1166
Davide Libenzi7699acd2007-05-10 22:23:23 -07001167 return 0;
1168}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001169
1170/*
Davide Libenzic7ea7632007-05-15 01:40:47 -07001171 * Search the file inside the eventpoll tree. The RB tree operations
1172 * are protected by the "mtx" mutex, and ep_find() must be called with
1173 * "mtx" held.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001174 */
1175static struct epitem *ep_find(struct eventpoll *ep, struct file *file, int fd)
1176{
1177 int kcmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001178 struct rb_node *rbp;
1179 struct epitem *epi, *epir = NULL;
1180 struct epoll_filefd ffd;
1181
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001182 ep_set_ffd(&ffd, file, fd);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001183 for (rbp = ep->rbr.rb_root.rb_node; rbp; ) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001184 epi = rb_entry(rbp, struct epitem, rbn);
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001185 kcmp = ep_cmp_ffd(&ffd, &epi->ffd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001186 if (kcmp > 0)
1187 rbp = rbp->rb_right;
1188 else if (kcmp < 0)
1189 rbp = rbp->rb_left;
1190 else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191 epir = epi;
1192 break;
1193 }
1194 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001195
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196 return epir;
1197}
1198
Chris Wilsonbfe39112021-02-05 22:00:12 +00001199#ifdef CONFIG_KCMP
Cyrill Gorcunov0791e362017-07-12 14:34:28 -07001200static struct epitem *ep_find_tfd(struct eventpoll *ep, int tfd, unsigned long toff)
1201{
1202 struct rb_node *rbp;
1203 struct epitem *epi;
1204
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001205 for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) {
Cyrill Gorcunov0791e362017-07-12 14:34:28 -07001206 epi = rb_entry(rbp, struct epitem, rbn);
1207 if (epi->ffd.fd == tfd) {
1208 if (toff == 0)
1209 return epi;
1210 else
1211 toff--;
1212 }
1213 cond_resched();
1214 }
1215
1216 return NULL;
1217}
1218
1219struct file *get_epoll_tfile_raw_ptr(struct file *file, int tfd,
1220 unsigned long toff)
1221{
1222 struct file *file_raw;
1223 struct eventpoll *ep;
1224 struct epitem *epi;
1225
1226 if (!is_file_epoll(file))
1227 return ERR_PTR(-EINVAL);
1228
1229 ep = file->private_data;
1230
1231 mutex_lock(&ep->mtx);
1232 epi = ep_find_tfd(ep, tfd, toff);
1233 if (epi)
1234 file_raw = epi->ffd.file;
1235 else
1236 file_raw = ERR_PTR(-ENOENT);
1237 mutex_unlock(&ep->mtx);
1238
1239 return file_raw;
1240}
Chris Wilsonbfe39112021-02-05 22:00:12 +00001241#endif /* CONFIG_KCMP */
Cyrill Gorcunov0791e362017-07-12 14:34:28 -07001242
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001243/*
Roman Penyaeva218cc42019-03-07 16:28:53 -08001244 * Adds a new entry to the tail of the list in a lockless way, i.e.
1245 * multiple CPUs are allowed to call this function concurrently.
1246 *
1247 * Beware: it is necessary to prevent any other modifications of the
1248 * existing list until all changes are completed, in other words
1249 * concurrent list_add_tail_lockless() calls should be protected
1250 * with a read lock, where write lock acts as a barrier which
1251 * makes sure all list_add_tail_lockless() calls are fully
1252 * completed.
1253 *
1254 * Also an element can be locklessly added to the list only in one
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001255 * direction i.e. either to the tail or to the head, otherwise
Roman Penyaeva218cc42019-03-07 16:28:53 -08001256 * concurrent access will corrupt the list.
1257 *
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001258 * Return: %false if element has been already added to the list, %true
Roman Penyaeva218cc42019-03-07 16:28:53 -08001259 * otherwise.
1260 */
1261static inline bool list_add_tail_lockless(struct list_head *new,
1262 struct list_head *head)
1263{
1264 struct list_head *prev;
1265
1266 /*
1267 * This is simple 'new->next = head' operation, but cmpxchg()
1268 * is used in order to detect that same element has been just
1269 * added to the list from another CPU: the winner observes
1270 * new->next == new.
1271 */
Uros Bizjak693fc062022-07-14 19:32:55 +02001272 if (!try_cmpxchg(&new->next, &new, head))
Roman Penyaeva218cc42019-03-07 16:28:53 -08001273 return false;
1274
1275 /*
1276 * Initially ->next of a new element must be updated with the head
1277 * (we are inserting to the tail) and only then pointers are atomically
1278 * exchanged. XCHG guarantees memory ordering, thus ->next should be
1279 * updated before pointers are actually swapped and pointers are
1280 * swapped before prev->next is updated.
1281 */
1282
1283 prev = xchg(&head->prev, new);
1284
1285 /*
1286 * It is safe to modify prev->next and new->prev, because a new element
1287 * is added only to the tail and new->next is updated before XCHG.
1288 */
1289
1290 prev->next = new;
1291 new->prev = prev;
1292
1293 return true;
1294}
1295
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001296/*
Roman Penyaeva218cc42019-03-07 16:28:53 -08001297 * Chains a new epi entry to the tail of the ep->ovflist in a lockless way,
1298 * i.e. multiple CPUs are allowed to call this function concurrently.
1299 *
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001300 * Return: %false if epi element has been already chained, %true otherwise.
Roman Penyaeva218cc42019-03-07 16:28:53 -08001301 */
1302static inline bool chain_epi_lockless(struct epitem *epi)
1303{
1304 struct eventpoll *ep = epi->ep;
1305
Khazhismel Kumykov0c54a6a2020-05-07 18:35:59 -07001306 /* Fast preliminary check */
1307 if (epi->next != EP_UNACTIVE_PTR)
1308 return false;
1309
Roman Penyaeva218cc42019-03-07 16:28:53 -08001310 /* Check that the same epi has not been just chained from another CPU */
1311 if (cmpxchg(&epi->next, EP_UNACTIVE_PTR, NULL) != EP_UNACTIVE_PTR)
1312 return false;
1313
1314 /* Atomically exchange tail */
1315 epi->next = xchg(&ep->ovflist, epi);
1316
1317 return true;
1318}
1319
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320/*
Davide Libenzi7699acd2007-05-10 22:23:23 -07001321 * This is the callback that is passed to the wait queue wakeup
Daniel Balutabf6a41d2011-01-30 23:42:29 +02001322 * mechanism. It is called by the stored file descriptors when they
Davide Libenzi7699acd2007-05-10 22:23:23 -07001323 * have events to report.
Roman Penyaeva218cc42019-03-07 16:28:53 -08001324 *
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001325 * This callback takes a read lock in order not to contend with concurrent
1326 * events from another file descriptor, thus all modifications to ->rdllist
Roman Penyaeva218cc42019-03-07 16:28:53 -08001327 * or ->ovflist are lockless. Read lock is paired with the write lock from
Huang Xiaojiae6f79582024-02-06 09:43:53 +08001328 * ep_start/done_scan(), which stops all list modifications and guarantees
Roman Penyaeva218cc42019-03-07 16:28:53 -08001329 * that lists state is seen correctly.
1330 *
1331 * Another thing worth to mention is that ep_poll_callback() can be called
1332 * concurrently for the same @epi from different CPUs if poll table was inited
1333 * with several wait queues entries. Plural wakeup from different CPUs of a
1334 * single wait queue is serialized by wq.lock, but the case when multiple wait
1335 * queues are used should be detected accordingly. This is detected using
1336 * cmpxchg() operation.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001337 */
Ingo Molnarac6424b2017-06-20 12:06:13 +02001338static int ep_poll_callback(wait_queue_entry_t *wait, unsigned mode, int sync, void *key)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339{
Davide Libenzi7699acd2007-05-10 22:23:23 -07001340 int pwake = 0;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001341 struct epitem *epi = ep_item_from_wait(wait);
1342 struct eventpoll *ep = epi->ep;
Al Viro3ad6f932017-07-03 20:14:56 -04001343 __poll_t pollflags = key_to_poll(key);
Roman Penyaeva218cc42019-03-07 16:28:53 -08001344 unsigned long flags;
Jason Barondf0108c2016-01-20 14:59:24 -08001345 int ewake = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001346
Roman Penyaeva218cc42019-03-07 16:28:53 -08001347 read_lock_irqsave(&ep->lock, flags);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001348
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -07001349 ep_set_busy_poll_napi_id(epi);
1350
Davide Libenzi7699acd2007-05-10 22:23:23 -07001351 /*
1352 * If the event mask does not contain any poll(2) event, we consider the
1353 * descriptor to be disabled. This condition is likely the effect of the
1354 * EPOLLONESHOT bit that disables the descriptor when an event is received,
1355 * until the next EPOLL_CTL_MOD will be issued.
1356 */
1357 if (!(epi->event.events & ~EP_PRIVATE_BITS))
Davide Libenzid47de162007-05-15 01:40:41 -07001358 goto out_unlock;
1359
1360 /*
Davide Libenzi2dfa4ee2009-03-31 15:24:22 -07001361 * Check the events coming with the callback. At this stage, not
1362 * every device reports the events in the "key" parameter of the
1363 * callback. We need to be able to handle both cases here, hence the
1364 * test for "key" != NULL before the event match test.
1365 */
Al Viro3ad6f932017-07-03 20:14:56 -04001366 if (pollflags && !(pollflags & epi->event.events))
Davide Libenzi2dfa4ee2009-03-31 15:24:22 -07001367 goto out_unlock;
1368
1369 /*
Daniel Balutabf6a41d2011-01-30 23:42:29 +02001370 * If we are transferring events to userspace, we can hold no locks
Davide Libenzid47de162007-05-15 01:40:41 -07001371 * (because we're accessing user memory, and because of linux f_op->poll()
Daniel Balutabf6a41d2011-01-30 23:42:29 +02001372 * semantics). All the events that happen during that period of time are
Davide Libenzid47de162007-05-15 01:40:41 -07001373 * chained in ep->ovflist and requeued later on.
1374 */
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001375 if (READ_ONCE(ep->ovflist) != EP_UNACTIVE_PTR) {
Khazhismel Kumykov0c54a6a2020-05-07 18:35:59 -07001376 if (chain_epi_lockless(epi))
Roman Penyaevc3e320b2019-03-07 16:28:49 -08001377 ep_pm_stay_awake_rcu(epi);
Khazhismel Kumykov0c54a6a2020-05-07 18:35:59 -07001378 } else if (!ep_is_linked(epi)) {
1379 /* In the usual case, add event to ready list. */
1380 if (list_add_tail_lockless(&epi->rdllink, &ep->rdllist))
1381 ep_pm_stay_awake_rcu(epi);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001382 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07001383
Davide Libenzi7699acd2007-05-10 22:23:23 -07001384 /*
1385 * Wake up ( if active ) both the eventpoll wait list and the ->poll()
1386 * wait list.
1387 */
Jason Barondf0108c2016-01-20 14:59:24 -08001388 if (waitqueue_active(&ep->wq)) {
Jason Baronb6a515c2016-02-05 15:37:04 -08001389 if ((epi->event.events & EPOLLEXCLUSIVE) &&
Al Viro3ad6f932017-07-03 20:14:56 -04001390 !(pollflags & POLLFREE)) {
1391 switch (pollflags & EPOLLINOUT_BITS) {
Linus Torvaldsa9a08842018-02-11 14:34:03 -08001392 case EPOLLIN:
1393 if (epi->event.events & EPOLLIN)
Jason Baronb6a515c2016-02-05 15:37:04 -08001394 ewake = 1;
1395 break;
Linus Torvaldsa9a08842018-02-11 14:34:03 -08001396 case EPOLLOUT:
1397 if (epi->event.events & EPOLLOUT)
Jason Baronb6a515c2016-02-05 15:37:04 -08001398 ewake = 1;
1399 break;
1400 case 0:
1401 ewake = 1;
1402 break;
1403 }
1404 }
Xuewen Yan900bbaa2024-04-26 16:05:48 +08001405 if (sync)
1406 wake_up_sync(&ep->wq);
1407 else
1408 wake_up(&ep->wq);
Jason Barondf0108c2016-01-20 14:59:24 -08001409 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07001410 if (waitqueue_active(&ep->poll_wait))
1411 pwake++;
1412
Davide Libenzid47de162007-05-15 01:40:41 -07001413out_unlock:
Roman Penyaeva218cc42019-03-07 16:28:53 -08001414 read_unlock_irqrestore(&ep->lock, flags);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001415
1416 /* We have to call this outside the lock */
1417 if (pwake)
Jens Axboecaf1aea2022-11-20 10:10:53 -07001418 ep_poll_safewake(ep, epi, pollflags & EPOLL_URING_WAKE);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001419
Oleg Nesterov138e4ad2017-09-01 18:55:33 +02001420 if (!(epi->event.events & EPOLLEXCLUSIVE))
1421 ewake = 1;
Jason Barondf0108c2016-01-20 14:59:24 -08001422
Al Viro3ad6f932017-07-03 20:14:56 -04001423 if (pollflags & POLLFREE) {
Oleg Nesterov138e4ad2017-09-01 18:55:33 +02001424 /*
1425 * If we race with ep_remove_wait_queue() it can miss
1426 * ->whead = NULL and do another remove_wait_queue() after
1427 * us, so we can't use __remove_wait_queue().
1428 */
1429 list_del_init(&wait->entry);
1430 /*
Paolo Abeni58c9b012023-03-22 17:57:02 +01001431 * ->whead != NULL protects us from the race with
1432 * ep_clear_and_put() or ep_remove(), ep_remove_wait_queue()
1433 * takes whead->lock held by the caller. Once we nullify it,
1434 * nothing protects ep/epi or even wait.
Oleg Nesterov138e4ad2017-09-01 18:55:33 +02001435 */
1436 smp_store_release(&ep_pwq_from_wait(wait)->whead, NULL);
1437 }
1438
1439 return ewake;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001440}
1441
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442/*
1443 * This is the callback that is used to add our wait queue to the
1444 * target file wakeup lists.
1445 */
1446static void ep_ptable_queue_proc(struct file *file, wait_queue_head_t *whead,
1447 poll_table *pt)
1448{
Al Viro364f3742020-09-02 11:55:09 -04001449 struct ep_pqueue *epq = container_of(pt, struct ep_pqueue, pt);
1450 struct epitem *epi = epq->epi;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451 struct eppoll_entry *pwq;
1452
Al Viro364f3742020-09-02 11:55:09 -04001453 if (unlikely(!epi)) // an earlier allocation has failed
1454 return;
1455
1456 pwq = kmem_cache_alloc(pwq_cache, GFP_KERNEL);
1457 if (unlikely(!pwq)) {
1458 epq->epi = NULL;
1459 return;
Davide Libenzi296e2362009-03-31 15:24:11 -07001460 }
Al Viro364f3742020-09-02 11:55:09 -04001461
1462 init_waitqueue_func_entry(&pwq->wait, ep_poll_callback);
1463 pwq->whead = whead;
1464 pwq->base = epi;
1465 if (epi->event.events & EPOLLEXCLUSIVE)
1466 add_wait_queue_exclusive(whead, &pwq->wait);
1467 else
1468 add_wait_queue(whead, &pwq->wait);
1469 pwq->next = epi->pwqlist;
1470 epi->pwqlist = pwq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001471}
1472
Linus Torvalds1da177e2005-04-16 15:20:36 -07001473static void ep_rbtree_insert(struct eventpoll *ep, struct epitem *epi)
1474{
1475 int kcmp;
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001476 struct rb_node **p = &ep->rbr.rb_root.rb_node, *parent = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001477 struct epitem *epic;
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001478 bool leftmost = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001479
1480 while (*p) {
1481 parent = *p;
1482 epic = rb_entry(parent, struct epitem, rbn);
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001483 kcmp = ep_cmp_ffd(&epi->ffd, &epic->ffd);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001484 if (kcmp > 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001485 p = &parent->rb_right;
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001486 leftmost = false;
1487 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -07001488 p = &parent->rb_left;
1489 }
1490 rb_link_node(&epi->rbn, parent, p);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001491 rb_insert_color_cached(&epi->rbn, &ep->rbr, leftmost);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001492}
1493
Andrew Mortona80a6b82012-11-08 15:53:35 -08001494
1495
Jason Baron28d82dc2012-01-12 17:17:43 -08001496#define PATH_ARR_SIZE 5
1497/*
1498 * These are the number paths of length 1 to 5, that we are allowing to emanate
1499 * from a single file of interest. For example, we allow 1000 paths of length
1500 * 1, to emanate from each file of interest. This essentially represents the
1501 * potential wakeup paths, which need to be limited in order to avoid massive
1502 * uncontrolled wakeup storms. The common use case should be a single ep which
1503 * is connected to n file sources. In this case each file source has 1 path
1504 * of length 1. Thus, the numbers below should be more than sufficient. These
1505 * path limits are enforced during an EPOLL_CTL_ADD operation, since a modify
Davidlohr Buesod4cb6262023-04-11 16:41:59 -07001506 * and delete can't add additional paths. Protected by the epnested_mutex.
Jason Baron28d82dc2012-01-12 17:17:43 -08001507 */
1508static const int path_limits[PATH_ARR_SIZE] = { 1000, 500, 100, 50, 10 };
1509static int path_count[PATH_ARR_SIZE];
1510
1511static int path_count_inc(int nests)
1512{
Jason Baron93dc6102012-03-16 16:34:03 -04001513 /* Allow an arbitrary number of depth 1 paths */
1514 if (nests == 0)
1515 return 0;
1516
Jason Baron28d82dc2012-01-12 17:17:43 -08001517 if (++path_count[nests] > path_limits[nests])
1518 return -1;
1519 return 0;
1520}
1521
1522static void path_count_init(void)
1523{
1524 int i;
1525
1526 for (i = 0; i < PATH_ARR_SIZE; i++)
1527 path_count[i] = 0;
1528}
1529
Al Viro319c1512020-10-01 20:45:51 -04001530static int reverse_path_check_proc(struct hlist_head *refs, int depth)
Jason Baron28d82dc2012-01-12 17:17:43 -08001531{
1532 int error = 0;
Jason Baron28d82dc2012-01-12 17:17:43 -08001533 struct epitem *epi;
1534
Al Viro0c320f72020-09-25 19:48:56 -04001535 if (depth > EP_MAX_NESTS) /* too deep nesting */
Al Viro99d84d42020-08-22 23:08:37 -04001536 return -1;
1537
Jason Baronae10b2b2013-11-12 15:10:16 -08001538 /* CTL_DEL can remove links here, but that can't increase our count */
Al Viro319c1512020-10-01 20:45:51 -04001539 hlist_for_each_entry_rcu(epi, refs, fllink) {
1540 struct hlist_head *refs = &epi->ep->refs;
1541 if (hlist_empty(refs))
Al Virod16312a2020-09-26 15:54:05 -04001542 error = path_count_inc(depth);
1543 else
Al Viro319c1512020-10-01 20:45:51 -04001544 error = reverse_path_check_proc(refs, depth + 1);
Al Virod16312a2020-09-26 15:54:05 -04001545 if (error != 0)
1546 break;
Jason Baron28d82dc2012-01-12 17:17:43 -08001547 }
1548 return error;
1549}
1550
1551/**
Al Viro319c1512020-10-01 20:45:51 -04001552 * reverse_path_check - The tfile_check_list is list of epitem_head, which have
Jason Baron28d82dc2012-01-12 17:17:43 -08001553 * links that are proposed to be newly added. We need to
1554 * make sure that those added links don't add too many
1555 * paths such that we will spend all our time waking up
1556 * eventpoll objects.
1557 *
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001558 * Return: %zero if the proposed links don't create too many paths,
1559 * %-1 otherwise.
Jason Baron28d82dc2012-01-12 17:17:43 -08001560 */
1561static int reverse_path_check(void)
1562{
Al Viro319c1512020-10-01 20:45:51 -04001563 struct epitems_head *p;
Jason Baron28d82dc2012-01-12 17:17:43 -08001564
Al Viro319c1512020-10-01 20:45:51 -04001565 for (p = tfile_check_list; p != EP_UNACTIVE_PTR; p = p->next) {
1566 int error;
Jason Baron28d82dc2012-01-12 17:17:43 -08001567 path_count_init();
Al Virob62d2702020-10-01 14:11:00 -04001568 rcu_read_lock();
Al Viro319c1512020-10-01 20:45:51 -04001569 error = reverse_path_check_proc(&p->epitems, 0);
Al Virob62d2702020-10-01 14:11:00 -04001570 rcu_read_unlock();
Jason Baron28d82dc2012-01-12 17:17:43 -08001571 if (error)
Al Viro319c1512020-10-01 20:45:51 -04001572 return error;
Jason Baron28d82dc2012-01-12 17:17:43 -08001573 }
Al Viro319c1512020-10-01 20:45:51 -04001574 return 0;
Jason Baron28d82dc2012-01-12 17:17:43 -08001575}
1576
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001577static int ep_create_wakeup_source(struct epitem *epi)
1578{
Al Viro3701cb52020-09-24 19:41:58 -04001579 struct name_snapshot n;
Eric Wongeea1d582013-04-30 15:27:39 -07001580 struct wakeup_source *ws;
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001581
1582 if (!epi->ep->ws) {
Tri Voc8377ad2019-08-06 18:48:46 -07001583 epi->ep->ws = wakeup_source_register(NULL, "eventpoll");
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001584 if (!epi->ep->ws)
1585 return -ENOMEM;
1586 }
1587
Al Viro3701cb52020-09-24 19:41:58 -04001588 take_dentry_name_snapshot(&n, epi->ffd.file->f_path.dentry);
1589 ws = wakeup_source_register(NULL, n.name.name);
1590 release_dentry_name_snapshot(&n);
Eric Wongeea1d582013-04-30 15:27:39 -07001591
1592 if (!ws)
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001593 return -ENOMEM;
Eric Wongeea1d582013-04-30 15:27:39 -07001594 rcu_assign_pointer(epi->ws, ws);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001595
1596 return 0;
1597}
1598
Eric Wongeea1d582013-04-30 15:27:39 -07001599/* rare code path, only used when EPOLL_CTL_MOD removes a wakeup source */
1600static noinline void ep_destroy_wakeup_source(struct epitem *epi)
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001601{
Eric Wongeea1d582013-04-30 15:27:39 -07001602 struct wakeup_source *ws = ep_wakeup_source(epi);
1603
Eric Wongd6d67e72013-04-30 15:27:43 -07001604 RCU_INIT_POINTER(epi->ws, NULL);
Eric Wongeea1d582013-04-30 15:27:39 -07001605
1606 /*
1607 * wait for ep_pm_stay_awake_rcu to finish, synchronize_rcu is
1608 * used internally by wakeup_source_remove, too (called by
1609 * wakeup_source_unregister), so we cannot use call_rcu
1610 */
1611 synchronize_rcu();
1612 wakeup_source_unregister(ws);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001613}
1614
Al Viro319c1512020-10-01 20:45:51 -04001615static int attach_epitem(struct file *file, struct epitem *epi)
1616{
1617 struct epitems_head *to_free = NULL;
1618 struct hlist_head *head = NULL;
1619 struct eventpoll *ep = NULL;
1620
1621 if (is_file_epoll(file))
1622 ep = file->private_data;
1623
1624 if (ep) {
1625 head = &ep->refs;
1626 } else if (!READ_ONCE(file->f_ep)) {
1627allocate:
1628 to_free = kmem_cache_zalloc(ephead_cache, GFP_KERNEL);
1629 if (!to_free)
1630 return -ENOMEM;
1631 head = &to_free->epitems;
1632 }
1633 spin_lock(&file->f_lock);
1634 if (!file->f_ep) {
1635 if (unlikely(!head)) {
1636 spin_unlock(&file->f_lock);
1637 goto allocate;
1638 }
Christian Brauner64743532024-09-25 11:05:16 +02001639 /* See eventpoll_release() for details. */
1640 WRITE_ONCE(file->f_ep, head);
Al Viro319c1512020-10-01 20:45:51 -04001641 to_free = NULL;
1642 }
1643 hlist_add_head_rcu(&epi->fllink, file->f_ep);
1644 spin_unlock(&file->f_lock);
1645 free_ephead(to_free);
1646 return 0;
1647}
1648
Davide Libenzic7ea7632007-05-15 01:40:47 -07001649/*
1650 * Must be called with "mtx" held.
1651 */
Al Virobec1a5022017-11-28 19:43:33 -05001652static int ep_insert(struct eventpoll *ep, const struct epoll_event *event,
Jason Baron67347fe2013-11-12 15:10:18 -08001653 struct file *tfile, int fd, int full_check)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001654{
Al Virod85e2aa2018-02-01 15:24:58 -05001655 int error, pwake = 0;
1656 __poll_t revents;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657 struct epitem *epi;
1658 struct ep_pqueue epq;
Al Viro85353e92020-09-26 18:15:26 -04001659 struct eventpoll *tep = NULL;
1660
1661 if (is_file_epoll(tfile))
1662 tep = tfile->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001663
Davidlohr Bueso92e64172018-08-21 21:56:45 -07001664 lockdep_assert_irqs_enabled();
1665
Nicholas Piggin1e1c1582021-09-07 20:00:00 -07001666 if (unlikely(percpu_counter_compare(&ep->user->epoll_watches,
1667 max_user_watches) >= 0))
Davide Libenzi7ef99642008-12-01 13:13:55 -08001668 return -ENOSPC;
Nicholas Piggin1e1c1582021-09-07 20:00:00 -07001669 percpu_counter_inc(&ep->user->epoll_watches);
1670
1671 if (!(epi = kmem_cache_zalloc(epi_cache, GFP_KERNEL))) {
1672 percpu_counter_dec(&ep->user->epoll_watches);
Davide Libenzi7ef99642008-12-01 13:13:55 -08001673 return -ENOMEM;
Nicholas Piggin1e1c1582021-09-07 20:00:00 -07001674 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001675
1676 /* Item initialization follow here ... */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001677 INIT_LIST_HEAD(&epi->rdllink);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001678 epi->ep = ep;
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001679 ep_set_ffd(&epi->ffd, tfile, fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001680 epi->event = *event;
Davide Libenzid47de162007-05-15 01:40:41 -07001681 epi->next = EP_UNACTIVE_PTR;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001682
Al Viro85353e92020-09-26 18:15:26 -04001683 if (tep)
1684 mutex_lock_nested(&tep->mtx, 1);
Al Virof8d4f442020-09-09 22:25:06 -04001685 /* Add the current item to the list of active epoll hook for this file */
Al Viro319c1512020-10-01 20:45:51 -04001686 if (unlikely(attach_epitem(tfile, epi) < 0)) {
Al Viro319c1512020-10-01 20:45:51 -04001687 if (tep)
1688 mutex_unlock(&tep->mtx);
Nicholas Piggin1e1c1582021-09-07 20:00:00 -07001689 kmem_cache_free(epi_cache, epi);
1690 percpu_counter_dec(&ep->user->epoll_watches);
Al Viro319c1512020-10-01 20:45:51 -04001691 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001692 }
1693
Al Viro319c1512020-10-01 20:45:51 -04001694 if (full_check && !tep)
1695 list_file(tfile);
1696
Al Virof8d4f442020-09-09 22:25:06 -04001697 /*
1698 * Add the current item to the RB tree. All RB tree operations are
1699 * protected by "mtx", and ep_insert() is called with "mtx" held.
1700 */
1701 ep_rbtree_insert(ep, epi);
Al Viro85353e92020-09-26 18:15:26 -04001702 if (tep)
1703 mutex_unlock(&tep->mtx);
Al Virof8d4f442020-09-09 22:25:06 -04001704
Paolo Abeni58c9b012023-03-22 17:57:02 +01001705 /*
1706 * ep_remove_safe() calls in the later error paths can't lead to
1707 * ep_free() as the ep file itself still holds an ep reference.
1708 */
1709 ep_get(ep);
1710
Al Virof8d4f442020-09-09 22:25:06 -04001711 /* now check if we've created too many backpaths */
Al Viroe3e096e2020-09-26 18:09:29 -04001712 if (unlikely(full_check && reverse_path_check())) {
Paolo Abeni58c9b012023-03-22 17:57:02 +01001713 ep_remove_safe(ep, epi);
Al Viroe3e096e2020-09-26 18:09:29 -04001714 return -EINVAL;
1715 }
Al Virof8d4f442020-09-09 22:25:06 -04001716
Al Virod1ec50a2020-09-27 11:03:32 -04001717 if (epi->event.events & EPOLLWAKEUP) {
1718 error = ep_create_wakeup_source(epi);
1719 if (error) {
Paolo Abeni58c9b012023-03-22 17:57:02 +01001720 ep_remove_safe(ep, epi);
Al Virod1ec50a2020-09-27 11:03:32 -04001721 return error;
1722 }
1723 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001724
1725 /* Initialize the poll table using the queue callback */
1726 epq.epi = epi;
1727 init_poll_funcptr(&epq.pt, ep_ptable_queue_proc);
1728
1729 /*
1730 * Attach the item to the poll hooks and get current event bits.
1731 * We can safely use the file* here because its usage count has
Davide Libenzic7ea7632007-05-15 01:40:47 -07001732 * been increased by the caller of this function. Note that after
1733 * this operation completes, the poll callback can start hitting
1734 * the new item.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001735 */
Jason Baron37b5e522017-11-17 15:29:06 -08001736 revents = ep_item_poll(epi, &epq.pt, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001737
1738 /*
1739 * We have to check if something went wrong during the poll wait queue
1740 * install process. Namely an allocation for a wait queue failed due
1741 * high memory pressure.
1742 */
Al Viroe3e096e2020-09-26 18:09:29 -04001743 if (unlikely(!epq.epi)) {
Paolo Abeni58c9b012023-03-22 17:57:02 +01001744 ep_remove_safe(ep, epi);
Al Viroe3e096e2020-09-26 18:09:29 -04001745 return -ENOMEM;
1746 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001747
Davide Libenzic7ea7632007-05-15 01:40:47 -07001748 /* We have to drop the new item inside our item list to keep track of it */
Roman Penyaeva218cc42019-03-07 16:28:53 -08001749 write_lock_irq(&ep->lock);
Davide Libenzic7ea7632007-05-15 01:40:47 -07001750
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -07001751 /* record NAPI ID of new item if present */
1752 ep_set_busy_poll_napi_id(epi);
1753
Linus Torvalds1da177e2005-04-16 15:20:36 -07001754 /* If the file is already "ready" we drop it inside the ready list */
Davidlohr Bueso992991c2018-08-21 21:58:26 -07001755 if (revents && !ep_is_linked(epi)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001756 list_add_tail(&epi->rdllink, &ep->rdllist);
Eric Wongeea1d582013-04-30 15:27:39 -07001757 ep_pm_stay_awake(epi);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001758
1759 /* Notify waiting tasks that events are available */
1760 if (waitqueue_active(&ep->wq))
Roman Penyaeva218cc42019-03-07 16:28:53 -08001761 wake_up(&ep->wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001762 if (waitqueue_active(&ep->poll_wait))
1763 pwake++;
1764 }
1765
Roman Penyaeva218cc42019-03-07 16:28:53 -08001766 write_unlock_irq(&ep->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001767
1768 /* We have to call this outside the lock */
1769 if (pwake)
Jens Axboecaf1aea2022-11-20 10:10:53 -07001770 ep_poll_safewake(ep, NULL, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001771
Linus Torvalds1da177e2005-04-16 15:20:36 -07001772 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001773}
1774
Linus Torvalds1da177e2005-04-16 15:20:36 -07001775/*
1776 * Modify the interest event mask by dropping an event if the new mask
Davide Libenzic7ea7632007-05-15 01:40:47 -07001777 * has a match in the current file status. Must be called with "mtx" held.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001778 */
Al Virobec1a5022017-11-28 19:43:33 -05001779static int ep_modify(struct eventpoll *ep, struct epitem *epi,
1780 const struct epoll_event *event)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001781{
1782 int pwake = 0;
Hans Verkuil626cf232012-03-23 15:02:27 -07001783 poll_table pt;
1784
Davidlohr Bueso92e64172018-08-21 21:56:45 -07001785 lockdep_assert_irqs_enabled();
1786
Hans Verkuil626cf232012-03-23 15:02:27 -07001787 init_poll_funcptr(&pt, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001788
1789 /*
Tony Battersbye057e152009-03-31 15:24:15 -07001790 * Set the new event interest mask before calling f_op->poll();
1791 * otherwise we might miss an event that happens between the
1792 * f_op->poll() call and the new event set registering.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001793 */
Eric Wong128dd172013-01-01 21:20:27 +00001794 epi->event.events = event->events; /* need barrier below */
Tony Battersbye057e152009-03-31 15:24:15 -07001795 epi->event.data = event->data; /* protected by mtx */
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001796 if (epi->event.events & EPOLLWAKEUP) {
Eric Wongeea1d582013-04-30 15:27:39 -07001797 if (!ep_has_wakeup_source(epi))
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001798 ep_create_wakeup_source(epi);
Eric Wongeea1d582013-04-30 15:27:39 -07001799 } else if (ep_has_wakeup_source(epi)) {
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001800 ep_destroy_wakeup_source(epi);
1801 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001802
1803 /*
Eric Wong128dd172013-01-01 21:20:27 +00001804 * The following barrier has two effects:
1805 *
1806 * 1) Flush epi changes above to other CPUs. This ensures
1807 * we do not miss events from ep_poll_callback if an
1808 * event occurs immediately after we call f_op->poll().
Roman Penyaeva218cc42019-03-07 16:28:53 -08001809 * We need this because we did not take ep->lock while
Eric Wong128dd172013-01-01 21:20:27 +00001810 * changing epi above (but ep_poll_callback does take
Roman Penyaeva218cc42019-03-07 16:28:53 -08001811 * ep->lock).
Eric Wong128dd172013-01-01 21:20:27 +00001812 *
1813 * 2) We also need to ensure we do not miss _past_ events
1814 * when calling f_op->poll(). This barrier also
1815 * pairs with the barrier in wq_has_sleeper (see
1816 * comments for wq_has_sleeper).
1817 *
1818 * This barrier will now guarantee ep_poll_callback or f_op->poll
1819 * (or both) will notice the readiness of an item.
1820 */
1821 smp_mb();
1822
1823 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001824 * Get current event bits. We can safely use the file* here because
1825 * its usage count has been increased by the caller of this function.
Davide Libenzic7ea7632007-05-15 01:40:47 -07001826 * If the item is "hot" and it is not registered inside the ready
Davide Libenzi67647d02007-05-15 01:40:52 -07001827 * list, push it inside.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001828 */
Al Viro69112732017-11-28 19:56:15 -05001829 if (ep_item_poll(epi, &pt, 1)) {
Roman Penyaeva218cc42019-03-07 16:28:53 -08001830 write_lock_irq(&ep->lock);
Davidlohr Bueso992991c2018-08-21 21:58:26 -07001831 if (!ep_is_linked(epi)) {
Davide Libenzic7ea7632007-05-15 01:40:47 -07001832 list_add_tail(&epi->rdllink, &ep->rdllist);
Eric Wongeea1d582013-04-30 15:27:39 -07001833 ep_pm_stay_awake(epi);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001834
Davide Libenzic7ea7632007-05-15 01:40:47 -07001835 /* Notify waiting tasks that events are available */
1836 if (waitqueue_active(&ep->wq))
Roman Penyaeva218cc42019-03-07 16:28:53 -08001837 wake_up(&ep->wq);
Davide Libenzic7ea7632007-05-15 01:40:47 -07001838 if (waitqueue_active(&ep->poll_wait))
1839 pwake++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001840 }
Roman Penyaeva218cc42019-03-07 16:28:53 -08001841 write_unlock_irq(&ep->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001842 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001843
1844 /* We have to call this outside the lock */
1845 if (pwake)
Jens Axboecaf1aea2022-11-20 10:10:53 -07001846 ep_poll_safewake(ep, NULL, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001847
1848 return 0;
1849}
1850
Al Viroff079522020-08-31 13:39:52 -04001851static int ep_send_events(struct eventpoll *ep,
1852 struct epoll_event __user *events, int maxevents)
Davide Libenzi5071f972009-03-31 15:24:10 -07001853{
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001854 struct epitem *epi, *tmp;
Al Viroff079522020-08-31 13:39:52 -04001855 LIST_HEAD(txlist);
Hans Verkuil626cf232012-03-23 15:02:27 -07001856 poll_table pt;
Al Viroff079522020-08-31 13:39:52 -04001857 int res = 0;
Hans Verkuil626cf232012-03-23 15:02:27 -07001858
Soheil Hassas Yeganehcccd29b2020-12-18 14:01:51 -08001859 /*
1860 * Always short-circuit for fatal signals to allow threads to make a
1861 * timely exit without the chance of finding more events available and
1862 * fetching repeatedly.
1863 */
1864 if (fatal_signal_pending(current))
1865 return -EINTR;
1866
Hans Verkuil626cf232012-03-23 15:02:27 -07001867 init_poll_funcptr(&pt, NULL);
Al Viroff079522020-08-31 13:39:52 -04001868
Al Viro57804b12020-08-31 13:41:30 -04001869 mutex_lock(&ep->mtx);
1870 ep_start_scan(ep, &txlist);
Davide Libenzi5071f972009-03-31 15:24:10 -07001871
Davide Libenzi296e2362009-03-31 15:24:11 -07001872 /*
Davide Libenzi5071f972009-03-31 15:24:10 -07001873 * We can loop without lock because we are passed a task private list.
Al Viro57804b12020-08-31 13:41:30 -04001874 * Items cannot vanish during the loop we are holding ep->mtx.
Davide Libenzi296e2362009-03-31 15:24:11 -07001875 */
Al Viroff079522020-08-31 13:39:52 -04001876 list_for_each_entry_safe(epi, tmp, &txlist, rdllink) {
1877 struct wakeup_source *ws;
1878 __poll_t revents;
Davidlohr Bueso21877e12019-01-03 15:27:12 -08001879
Al Viroff079522020-08-31 13:39:52 -04001880 if (res >= maxevents)
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001881 break;
Davide Libenzi5071f972009-03-31 15:24:10 -07001882
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001883 /*
1884 * Activate ep->ws before deactivating epi->ws to prevent
1885 * triggering auto-suspend here (in case we reactive epi->ws
1886 * below).
1887 *
1888 * This could be rearranged to delay the deactivation of epi->ws
1889 * instead, but then epi->ws would temporarily be out of sync
1890 * with ep_is_linked().
1891 */
Eric Wongeea1d582013-04-30 15:27:39 -07001892 ws = ep_wakeup_source(epi);
1893 if (ws) {
1894 if (ws->active)
1895 __pm_stay_awake(ep->ws);
1896 __pm_relax(ws);
1897 }
1898
Davide Libenzi5071f972009-03-31 15:24:10 -07001899 list_del_init(&epi->rdllink);
1900
Davide Libenzi296e2362009-03-31 15:24:11 -07001901 /*
Davide Libenzi5071f972009-03-31 15:24:10 -07001902 * If the event mask intersect the caller-requested one,
Al Viro57804b12020-08-31 13:41:30 -04001903 * deliver the event to userspace. Again, we are holding ep->mtx,
1904 * so no operations coming from userspace can change the item.
Davide Libenzi296e2362009-03-31 15:24:11 -07001905 */
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001906 revents = ep_item_poll(epi, &pt, 1);
1907 if (!revents)
1908 continue;
1909
Arnd Bergmann249dbe72021-08-11 08:30:22 +01001910 events = epoll_put_uevent(revents, epi->event.data, events);
1911 if (!events) {
Al Viroff079522020-08-31 13:39:52 -04001912 list_add(&epi->rdllink, &txlist);
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001913 ep_pm_stay_awake(epi);
Al Viroff079522020-08-31 13:39:52 -04001914 if (!res)
1915 res = -EFAULT;
1916 break;
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001917 }
Al Viroff079522020-08-31 13:39:52 -04001918 res++;
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001919 if (epi->event.events & EPOLLONESHOT)
1920 epi->event.events &= EP_PRIVATE_BITS;
1921 else if (!(epi->event.events & EPOLLET)) {
1922 /*
1923 * If this file has been added with Level
1924 * Trigger mode, we need to insert back inside
1925 * the ready list, so that the next call to
1926 * epoll_wait() will check again the events
1927 * availability. At this point, no one can insert
1928 * into ep->rdllist besides us. The epoll_ctl()
1929 * callers are locked out by
Huang Xiaojiae6f79582024-02-06 09:43:53 +08001930 * ep_send_events() holding "mtx" and the
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001931 * poll callback will queue them in ep->ovflist.
1932 */
1933 list_add_tail(&epi->rdllink, &ep->rdllist);
1934 ep_pm_stay_awake(epi);
Davide Libenzi296e2362009-03-31 15:24:11 -07001935 }
1936 }
Al Viro57804b12020-08-31 13:41:30 -04001937 ep_done_scan(ep, &txlist);
1938 mutex_unlock(&ep->mtx);
Davide Libenzi5071f972009-03-31 15:24:10 -07001939
Al Viroff079522020-08-31 13:39:52 -04001940 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001941}
1942
Willem de Bruijn7cdf7c202020-12-18 14:05:35 -08001943static struct timespec64 *ep_timeout_to_timespec(struct timespec64 *to, long ms)
Eric Dumazet0781b902011-02-01 15:52:35 -08001944{
Willem de Bruijn7cdf7c202020-12-18 14:05:35 -08001945 struct timespec64 now;
1946
1947 if (ms < 0)
1948 return NULL;
1949
1950 if (!ms) {
1951 to->tv_sec = 0;
1952 to->tv_nsec = 0;
1953 return to;
1954 }
1955
1956 to->tv_sec = ms / MSEC_PER_SEC;
1957 to->tv_nsec = NSEC_PER_MSEC * (ms % MSEC_PER_SEC);
Eric Dumazet0781b902011-02-01 15:52:35 -08001958
Deepa Dinamani766b9f92016-05-19 17:09:05 -07001959 ktime_get_ts64(&now);
Willem de Bruijn7cdf7c202020-12-18 14:05:35 -08001960 *to = timespec64_add_safe(now, *to);
1961 return to;
Eric Dumazet0781b902011-02-01 15:52:35 -08001962}
1963
Benjamin Segalla16ceb12022-06-15 14:24:23 -07001964/*
1965 * autoremove_wake_function, but remove even on failure to wake up, because we
1966 * know that default_wake_function/ttwu will only fail if the thread is already
1967 * woken, and in that case the ep_poll loop will remove the entry anyways, not
1968 * try to reuse it.
1969 */
1970static int ep_autoremove_wake_function(struct wait_queue_entry *wq_entry,
1971 unsigned int mode, int sync, void *key)
1972{
1973 int ret = default_wake_function(wq_entry, mode, sync, key);
1974
Benjamin Segall2192bba2023-05-30 11:32:28 -07001975 /*
1976 * Pairs with list_empty_careful in ep_poll, and ensures future loop
1977 * iterations see the cause of this wakeup.
1978 */
1979 list_del_init_careful(&wq_entry->entry);
Benjamin Segalla16ceb12022-06-15 14:24:23 -07001980 return ret;
1981}
1982
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001983/**
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001984 * ep_poll - Retrieves ready events, and delivers them to the caller-supplied
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001985 * event buffer.
1986 *
1987 * @ep: Pointer to the eventpoll context.
1988 * @events: Pointer to the userspace buffer where the ready events should be
1989 * stored.
1990 * @maxevents: Size (in terms of number of events) of the caller event buffer.
1991 * @timeout: Maximum timeout for the ready events fetch operation, in
Willem de Bruijn7cdf7c202020-12-18 14:05:35 -08001992 * timespec. If the timeout is zero, the function will not block,
1993 * while if the @timeout ptr is NULL, the function will block
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001994 * until at least one event has been retrieved (or an error
1995 * occurred).
1996 *
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07001997 * Return: the number of ready events which have been fetched, or an
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001998 * error code, in case of error.
1999 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002000static int ep_poll(struct eventpoll *ep, struct epoll_event __user *events,
Willem de Bruijn7cdf7c202020-12-18 14:05:35 -08002001 int maxevents, struct timespec64 *timeout)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002002{
Soheil Hassas Yeganehe59d3c62020-12-18 14:02:06 -08002003 int res, eavail, timed_out = 0;
John Stultzda8b44d2016-03-17 14:20:51 -07002004 u64 slack = 0;
Ingo Molnarac6424b2017-06-20 12:06:13 +02002005 wait_queue_entry_t wait;
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07002006 ktime_t expires, *to = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002007
Davidlohr Bueso679abf32018-08-21 21:58:23 -07002008 lockdep_assert_irqs_enabled();
2009
Willem de Bruijn7cdf7c202020-12-18 14:05:35 -08002010 if (timeout && (timeout->tv_sec | timeout->tv_nsec)) {
2011 slack = select_estimate_accuracy(timeout);
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07002012 to = &expires;
Willem de Bruijn7cdf7c202020-12-18 14:05:35 -08002013 *to = timespec64_to_ktime(*timeout);
2014 } else if (timeout) {
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07002015 /*
2016 * Avoid the unnecessary trip to the wait queue loop, if the
Soheil Hassas Yeganehe59d3c62020-12-18 14:02:06 -08002017 * caller specified a non blocking operation.
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07002018 */
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07002019 timed_out = 1;
2020 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002021
Soheil Hassas Yeganehe59d3c62020-12-18 14:02:06 -08002022 /*
2023 * This call is racy: We may or may not see events that are being added
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07002024 * to the ready list under the lock (e.g., in IRQ callbacks). For cases
Soheil Hassas Yeganehe59d3c62020-12-18 14:02:06 -08002025 * with a non-zero timeout, this thread will check the ready list under
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07002026 * lock and will add to the wait queue. For cases with a zero
Soheil Hassas Yeganehe59d3c62020-12-18 14:02:06 -08002027 * timeout, the user by definition should not care and will have to
2028 * recheck again.
2029 */
2030 eavail = ep_events_available(ep);
2031
Soheil Hassas Yeganeh00b27632020-12-18 14:02:03 -08002032 while (1) {
2033 if (eavail) {
2034 /*
2035 * Try to transfer events to user space. In case we get
2036 * 0 events and there's still timeout left over, we go
2037 * trying again in search of more luck.
2038 */
2039 res = ep_send_events(ep, events, maxevents);
Martin Karsten8a6de262024-11-09 05:02:34 +00002040 if (res) {
2041 if (res > 0)
2042 ep_suspend_napi_irqs(ep);
Soheil Hassas Yeganeh00b27632020-12-18 14:02:03 -08002043 return res;
Martin Karsten8a6de262024-11-09 05:02:34 +00002044 }
Soheil Hassas Yeganeh00b27632020-12-18 14:02:03 -08002045 }
Soheil Hassas Yeganehe8c85322020-12-18 14:02:00 -08002046
Soheil Hassas Yeganeh00b27632020-12-18 14:02:03 -08002047 if (timed_out)
2048 return 0;
2049
Soheil Hassas Yeganeh00b27632020-12-18 14:02:03 -08002050 eavail = ep_busy_loop(ep, timed_out);
2051 if (eavail)
2052 continue;
Soheil Hassas Yeganehe8c85322020-12-18 14:02:00 -08002053
Soheil Hassas Yeganeh2efdaf72020-12-18 14:01:48 -08002054 if (signal_pending(current))
2055 return -EINTR;
2056
Roman Penyaev412895f2020-05-07 18:36:16 -07002057 /*
2058 * Internally init_wait() uses autoremove_wake_function(),
2059 * thus wait entry is removed from the wait queue on each
2060 * wakeup. Why it is important? In case of several waiters
2061 * each new wakeup will hit the next waiter, giving it the
2062 * chance to harvest new event. Otherwise wakeup can be
2063 * lost. This is also good performance-wise, because on
2064 * normal wakeup path no need to call __remove_wait_queue()
2065 * explicitly, thus ep->lock is not taken, which halts the
2066 * event delivery.
Benjamin Segalla16ceb12022-06-15 14:24:23 -07002067 *
2068 * In fact, we now use an even more aggressive function that
2069 * unconditionally removes, because we don't reuse the wait
2070 * entry between loop iterations. This lets us also avoid the
2071 * performance issue if a process is killed, causing all of its
2072 * threads to wake up without being removed normally.
Roman Penyaev412895f2020-05-07 18:36:16 -07002073 */
2074 init_wait(&wait);
Benjamin Segalla16ceb12022-06-15 14:24:23 -07002075 wait.func = ep_autoremove_wake_function;
Roman Penyaev65759092020-05-13 17:50:38 -07002076
Roman Penyaev1b537342020-03-21 18:22:30 -07002077 write_lock_irq(&ep->lock);
Roman Penyaev65759092020-05-13 17:50:38 -07002078 /*
2079 * Barrierless variant, waitqueue_active() is called under
2080 * the same lock on wakeup ep_poll_callback() side, so it
2081 * is safe to avoid an explicit barrier.
2082 */
2083 __set_current_state(TASK_INTERRUPTIBLE);
2084
2085 /*
Huang Xiaojiae6f79582024-02-06 09:43:53 +08002086 * Do the final check under the lock. ep_start/done_scan()
Roman Penyaev65759092020-05-13 17:50:38 -07002087 * plays with two lists (->rdllist and ->ovflist) and there
2088 * is always a race when both lists are empty for short
2089 * period of time although events are pending, so lock is
2090 * important.
2091 */
2092 eavail = ep_events_available(ep);
Soheil Hassas Yeganeh2efdaf72020-12-18 14:01:48 -08002093 if (!eavail)
2094 __add_wait_queue_exclusive(&ep->wq, &wait);
2095
Roman Penyaev1b537342020-03-21 18:22:30 -07002096 write_unlock_irq(&ep->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002097
Soheil Hassas Yeganeh2efdaf72020-12-18 14:01:48 -08002098 if (!eavail)
Soheil Hassas Yeganeh289caf52020-12-18 14:01:44 -08002099 timed_out = !schedule_hrtimeout_range(to, slack,
2100 HRTIMER_MODE_ABS);
Soheil Hassas Yeganehe4115962020-12-18 14:01:54 -08002101 __set_current_state(TASK_RUNNING);
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08002102
Soheil Hassas Yeganeh289caf52020-12-18 14:01:44 -08002103 /*
2104 * We were woken up, thus go and try to harvest some events.
2105 * If timed out and still on the wait queue, recheck eavail
2106 * carefully under lock, below.
2107 */
Roman Penyaev412895f2020-05-07 18:36:16 -07002108 eavail = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109
Soheil Hassas Yeganehe8c85322020-12-18 14:02:00 -08002110 if (!list_empty_careful(&wait.entry)) {
2111 write_lock_irq(&ep->lock);
2112 /*
2113 * If the thread timed out and is not on the wait queue,
2114 * it means that the thread was woken up after its
2115 * timeout expired before it could reacquire the lock.
2116 * Thus, when wait.entry is empty, it needs to harvest
2117 * events.
2118 */
2119 if (timed_out)
2120 eavail = list_empty(&wait.entry);
2121 __remove_wait_queue(&ep->wq, &wait);
2122 write_unlock_irq(&ep->lock);
2123 }
Soheil Hassas Yeganeh00b27632020-12-18 14:02:03 -08002124 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002125}
2126
Davide Libenzi22bacca2011-02-25 14:44:12 -08002127/**
Al Viro773318e2020-08-22 23:13:27 -04002128 * ep_loop_check_proc - verify that adding an epoll file inside another
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07002129 * epoll structure does not violate the constraints, in
Davide Libenzi22bacca2011-02-25 14:44:12 -08002130 * terms of closed loops, or too deep chains (which can
2131 * result in excessive stack usage).
2132 *
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07002133 * @ep: the &struct eventpoll to be currently checked.
Al Virobde03c42020-09-26 16:50:57 -04002134 * @depth: Current depth of the path being checked.
Davide Libenzi22bacca2011-02-25 14:44:12 -08002135 *
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07002136 * Return: %zero if adding the epoll @file inside current epoll
2137 * structure @ep does not violate the constraints, or %-1 otherwise.
Davide Libenzi22bacca2011-02-25 14:44:12 -08002138 */
Al Virobde03c42020-09-26 16:50:57 -04002139static int ep_loop_check_proc(struct eventpoll *ep, int depth)
Davide Libenzi22bacca2011-02-25 14:44:12 -08002140{
2141 int error = 0;
Davide Libenzi22bacca2011-02-25 14:44:12 -08002142 struct rb_node *rbp;
2143 struct epitem *epi;
2144
Al Viro773318e2020-08-22 23:13:27 -04002145 mutex_lock_nested(&ep->mtx, depth + 1);
Al Viro18306c42020-09-10 08:30:05 -04002146 ep->gen = loop_check_gen;
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07002147 for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) {
Davide Libenzi22bacca2011-02-25 14:44:12 -08002148 epi = rb_entry(rbp, struct epitem, rbn);
2149 if (unlikely(is_file_epoll(epi->ffd.file))) {
Al Virobde03c42020-09-26 16:50:57 -04002150 struct eventpoll *ep_tovisit;
Jason Baron28d82dc2012-01-12 17:17:43 -08002151 ep_tovisit = epi->ffd.file->private_data;
Al Viro18306c42020-09-10 08:30:05 -04002152 if (ep_tovisit->gen == loop_check_gen)
Jason Baron28d82dc2012-01-12 17:17:43 -08002153 continue;
Al Virobde03c42020-09-26 16:50:57 -04002154 if (ep_tovisit == inserting_into || depth > EP_MAX_NESTS)
Al Viro56c428c2020-09-26 16:38:44 -04002155 error = -1;
Al Virobde03c42020-09-26 16:50:57 -04002156 else
2157 error = ep_loop_check_proc(ep_tovisit, depth + 1);
Davide Libenzi22bacca2011-02-25 14:44:12 -08002158 if (error != 0)
2159 break;
Jason Baron28d82dc2012-01-12 17:17:43 -08002160 } else {
2161 /*
2162 * If we've reached a file that is not associated with
2163 * an ep, then we need to check if the newly added
2164 * links are going to add too many wakeup paths. We do
2165 * this by adding it to the tfile_check_list, if it's
2166 * not already there, and calling reverse_path_check()
2167 * during ep_insert().
2168 */
Al Viro319c1512020-10-01 20:45:51 -04002169 list_file(epi->ffd.file);
Davide Libenzi22bacca2011-02-25 14:44:12 -08002170 }
2171 }
2172 mutex_unlock(&ep->mtx);
2173
2174 return error;
2175}
2176
2177/**
Al Virobde03c42020-09-26 16:50:57 -04002178 * ep_loop_check - Performs a check to verify that adding an epoll file (@to)
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07002179 * into another epoll file (represented by @ep) does not create
Davide Libenzi22bacca2011-02-25 14:44:12 -08002180 * closed loops or too deep chains.
2181 *
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07002182 * @ep: Pointer to the epoll we are inserting into.
Al Virobde03c42020-09-26 16:50:57 -04002183 * @to: Pointer to the epoll to be inserted.
Davide Libenzi22bacca2011-02-25 14:44:12 -08002184 *
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07002185 * Return: %zero if adding the epoll @to inside the epoll @from
2186 * does not violate the constraints, or %-1 otherwise.
Davide Libenzi22bacca2011-02-25 14:44:12 -08002187 */
Al Virobde03c42020-09-26 16:50:57 -04002188static int ep_loop_check(struct eventpoll *ep, struct eventpoll *to)
Davide Libenzi22bacca2011-02-25 14:44:12 -08002189{
Al Viro6a3890c2020-09-26 16:29:02 -04002190 inserting_into = ep;
Al Virobde03c42020-09-26 16:50:57 -04002191 return ep_loop_check_proc(to, 0);
Jason Baron28d82dc2012-01-12 17:17:43 -08002192}
2193
2194static void clear_tfile_check_list(void)
2195{
Al Viro319c1512020-10-01 20:45:51 -04002196 rcu_read_lock();
2197 while (tfile_check_list != EP_UNACTIVE_PTR) {
2198 struct epitems_head *head = tfile_check_list;
2199 tfile_check_list = head->next;
2200 unlist_file(head);
Jason Baron28d82dc2012-01-12 17:17:43 -08002201 }
Al Viro319c1512020-10-01 20:45:51 -04002202 rcu_read_unlock();
Davide Libenzi22bacca2011-02-25 14:44:12 -08002203}
2204
Davide Libenzi7699acd2007-05-10 22:23:23 -07002205/*
Andrew Morton523723b2008-08-12 15:09:01 -07002206 * Open an eventpoll file descriptor.
Davide Libenzi7699acd2007-05-10 22:23:23 -07002207 */
Dominik Brodowski791eb222018-03-11 11:34:30 +01002208static int do_epoll_create(int flags)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002209{
Jason Baron28d82dc2012-01-12 17:17:43 -08002210 int error, fd;
Davide Libenzibb57c3e2009-03-31 15:24:12 -07002211 struct eventpoll *ep = NULL;
Jason Baron28d82dc2012-01-12 17:17:43 -08002212 struct file *file;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002213
Ulrich Dreppere38b36f2008-07-23 21:29:42 -07002214 /* Check the EPOLL_* constant for consistency. */
2215 BUILD_BUG_ON(EPOLL_CLOEXEC != O_CLOEXEC);
2216
Davide Libenzi296e2362009-03-31 15:24:11 -07002217 if (flags & ~EPOLL_CLOEXEC)
2218 return -EINVAL;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002219 /*
Davide Libenzibb57c3e2009-03-31 15:24:12 -07002220 * Create the internal data structure ("struct eventpoll").
Davide Libenzi7699acd2007-05-10 22:23:23 -07002221 */
Ulrich Drepper9fe5ad92008-07-23 21:29:43 -07002222 error = ep_alloc(&ep);
Davide Libenzibb57c3e2009-03-31 15:24:12 -07002223 if (error < 0)
2224 return error;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002225 /*
2226 * Creates all the items needed to setup an eventpoll file. That is,
Al Viro2030a42c2008-02-23 06:46:49 -05002227 * a file structure and a free file descriptor.
Davide Libenzi7699acd2007-05-10 22:23:23 -07002228 */
Jason Baron28d82dc2012-01-12 17:17:43 -08002229 fd = get_unused_fd_flags(O_RDWR | (flags & O_CLOEXEC));
2230 if (fd < 0) {
2231 error = fd;
2232 goto out_free_ep;
2233 }
2234 file = anon_inode_getfile("[eventpoll]", &eventpoll_fops, ep,
Roland Dreier628ff7c2009-12-18 09:41:24 -08002235 O_RDWR | (flags & O_CLOEXEC));
Jason Baron28d82dc2012-01-12 17:17:43 -08002236 if (IS_ERR(file)) {
2237 error = PTR_ERR(file);
2238 goto out_free_fd;
2239 }
Jason Baron28d82dc2012-01-12 17:17:43 -08002240 ep->file = file;
Al Viro98022742012-08-17 22:42:36 -04002241 fd_install(fd, file);
Jason Baron28d82dc2012-01-12 17:17:43 -08002242 return fd;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002243
Jason Baron28d82dc2012-01-12 17:17:43 -08002244out_free_fd:
2245 put_unused_fd(fd);
2246out_free_ep:
Paolo Abeni58c9b012023-03-22 17:57:02 +01002247 ep_clear_and_put(ep);
Davide Libenzibb57c3e2009-03-31 15:24:12 -07002248 return error;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002249}
2250
Dominik Brodowski791eb222018-03-11 11:34:30 +01002251SYSCALL_DEFINE1(epoll_create1, int, flags)
2252{
2253 return do_epoll_create(flags);
2254}
2255
Heiko Carstens5a8a82b2009-01-14 14:14:25 +01002256SYSCALL_DEFINE1(epoll_create, int, size)
Ulrich Dreppera0998b52008-07-23 21:29:27 -07002257{
Davide Libenzibfe3891a2009-05-12 13:19:44 -07002258 if (size <= 0)
Ulrich Drepper9fe5ad92008-07-23 21:29:43 -07002259 return -EINVAL;
2260
Dominik Brodowski791eb222018-03-11 11:34:30 +01002261 return do_epoll_create(0);
Ulrich Dreppera0998b52008-07-23 21:29:27 -07002262}
2263
Palmer Dabbelt063f3ed2023-03-10 17:07:54 +01002264#ifdef CONFIG_PM_SLEEP
2265static inline void ep_take_care_of_epollwakeup(struct epoll_event *epev)
2266{
2267 if ((epev->events & EPOLLWAKEUP) && !capable(CAP_BLOCK_SUSPEND))
2268 epev->events &= ~EPOLLWAKEUP;
2269}
2270#else
2271static inline void ep_take_care_of_epollwakeup(struct epoll_event *epev)
2272{
2273 epev->events &= ~EPOLLWAKEUP;
2274}
2275#endif
2276
Jens Axboe39220e8d2020-01-08 15:05:37 -07002277static inline int epoll_mutex_lock(struct mutex *mutex, int depth,
2278 bool nonblock)
2279{
2280 if (!nonblock) {
2281 mutex_lock_nested(mutex, depth);
2282 return 0;
2283 }
2284 if (mutex_trylock(mutex))
2285 return 0;
2286 return -EAGAIN;
2287}
2288
2289int do_epoll_ctl(int epfd, int op, int fd, struct epoll_event *epds,
2290 bool nonblock)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002291{
2292 int error;
Jason Baron67347fe2013-11-12 15:10:18 -08002293 int full_check = 0;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002294 struct eventpoll *ep;
2295 struct epitem *epi;
Jason Baron67347fe2013-11-12 15:10:18 -08002296 struct eventpoll *tep = NULL;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002297
Al Viro6348be02024-07-19 20:17:58 -04002298 CLASS(fd, f)(epfd);
2299 if (fd_empty(f))
2300 return -EBADF;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002301
2302 /* Get the "struct file *" for the target file */
Al Viro6348be02024-07-19 20:17:58 -04002303 CLASS(fd, tf)(fd);
2304 if (fd_empty(tf))
2305 return -EBADF;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002306
2307 /* The target file descriptor must support poll */
Al Viro1da91ea2024-05-31 14:12:01 -04002308 if (!file_can_poll(fd_file(tf)))
Al Viro6348be02024-07-19 20:17:58 -04002309 return -EPERM;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002310
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02002311 /* Check if EPOLLWAKEUP is allowed */
Nicolas Ioossc680e412014-09-09 14:50:51 -07002312 if (ep_op_has_event(op))
Jens Axboe58e41a42020-01-08 14:35:13 -07002313 ep_take_care_of_epollwakeup(epds);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02002314
Davide Libenzi7699acd2007-05-10 22:23:23 -07002315 /*
2316 * We have to check that the file structure underneath the file descriptor
2317 * the user passed to us _is_ an eventpoll file. And also we do not permit
2318 * adding an epoll file descriptor inside itself.
2319 */
2320 error = -EINVAL;
Al Viro1da91ea2024-05-31 14:12:01 -04002321 if (fd_file(f) == fd_file(tf) || !is_file_epoll(fd_file(f)))
Davide Libenzi7699acd2007-05-10 22:23:23 -07002322 goto error_tgt_fput;
2323
2324 /*
Jason Barondf0108c2016-01-20 14:59:24 -08002325 * epoll adds to the wakeup queue at EPOLL_CTL_ADD time only,
2326 * so EPOLLEXCLUSIVE is not allowed for a EPOLL_CTL_MOD operation.
2327 * Also, we do not currently supported nested exclusive wakeups.
2328 */
Jens Axboe58e41a42020-01-08 14:35:13 -07002329 if (ep_op_has_event(op) && (epds->events & EPOLLEXCLUSIVE)) {
Jason Baronb6a515c2016-02-05 15:37:04 -08002330 if (op == EPOLL_CTL_MOD)
2331 goto error_tgt_fput;
Al Viro1da91ea2024-05-31 14:12:01 -04002332 if (op == EPOLL_CTL_ADD && (is_file_epoll(fd_file(tf)) ||
Jens Axboe58e41a42020-01-08 14:35:13 -07002333 (epds->events & ~EPOLLEXCLUSIVE_OK_BITS)))
Jason Baronb6a515c2016-02-05 15:37:04 -08002334 goto error_tgt_fput;
2335 }
Jason Barondf0108c2016-01-20 14:59:24 -08002336
2337 /*
Davide Libenzi7699acd2007-05-10 22:23:23 -07002338 * At this point it is safe to assume that the "private_data" contains
2339 * our own data structure.
2340 */
Al Viro1da91ea2024-05-31 14:12:01 -04002341 ep = fd_file(f)->private_data;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002342
Davide Libenzi22bacca2011-02-25 14:44:12 -08002343 /*
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07002344 * When we insert an epoll file descriptor inside another epoll file
2345 * descriptor, there is the chance of creating closed loops, which are
Jason Baron28d82dc2012-01-12 17:17:43 -08002346 * better be handled here, than in more critical paths. While we are
2347 * checking for loops we also determine the list of files reachable
2348 * and hang them on the tfile_check_list, so we can check that we
2349 * haven't created too many possible wakeup paths.
Davide Libenzi22bacca2011-02-25 14:44:12 -08002350 *
Jason Baron67347fe2013-11-12 15:10:18 -08002351 * We do not need to take the global 'epumutex' on EPOLL_CTL_ADD when
2352 * the epoll file descriptor is attaching directly to a wakeup source,
2353 * unless the epoll file descriptor is nested. The purpose of taking the
Davidlohr Buesod4cb6262023-04-11 16:41:59 -07002354 * 'epnested_mutex' on add is to prevent complex toplogies such as loops and
Jason Baron67347fe2013-11-12 15:10:18 -08002355 * deep wakeup paths from forming in parallel through multiple
2356 * EPOLL_CTL_ADD operations.
Davide Libenzi22bacca2011-02-25 14:44:12 -08002357 */
Jens Axboe39220e8d2020-01-08 15:05:37 -07002358 error = epoll_mutex_lock(&ep->mtx, 0, nonblock);
2359 if (error)
2360 goto error_tgt_fput;
Jason Baron67347fe2013-11-12 15:10:18 -08002361 if (op == EPOLL_CTL_ADD) {
Al Viro1da91ea2024-05-31 14:12:01 -04002362 if (READ_ONCE(fd_file(f)->f_ep) || ep->gen == loop_check_gen ||
2363 is_file_epoll(fd_file(tf))) {
Jason Baron67347fe2013-11-12 15:10:18 -08002364 mutex_unlock(&ep->mtx);
Davidlohr Buesod4cb6262023-04-11 16:41:59 -07002365 error = epoll_mutex_lock(&epnested_mutex, 0, nonblock);
Jens Axboe39220e8d2020-01-08 15:05:37 -07002366 if (error)
2367 goto error_tgt_fput;
Al Viro18306c42020-09-10 08:30:05 -04002368 loop_check_gen++;
Jens Axboe39220e8d2020-01-08 15:05:37 -07002369 full_check = 1;
Al Viro1da91ea2024-05-31 14:12:01 -04002370 if (is_file_epoll(fd_file(tf))) {
2371 tep = fd_file(tf)->private_data;
Jason Baron67347fe2013-11-12 15:10:18 -08002372 error = -ELOOP;
Al Virobde03c42020-09-26 16:50:57 -04002373 if (ep_loop_check(ep, tep) != 0)
Jason Baron67347fe2013-11-12 15:10:18 -08002374 goto error_tgt_fput;
Marc Zyngiera9ed4a62020-08-19 17:12:17 +01002375 }
Jens Axboe39220e8d2020-01-08 15:05:37 -07002376 error = epoll_mutex_lock(&ep->mtx, 0, nonblock);
Al Viro52c47962020-08-22 18:25:52 -04002377 if (error)
Jens Axboe39220e8d2020-01-08 15:05:37 -07002378 goto error_tgt_fput;
Jason Baron67347fe2013-11-12 15:10:18 -08002379 }
2380 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07002381
Davide Libenzi67647d02007-05-15 01:40:52 -07002382 /*
Randy Dunlapa6c67fe2021-03-01 15:25:51 -07002383 * Try to lookup the file inside our RB tree. Since we grabbed "mtx"
Davide Libenzi67647d02007-05-15 01:40:52 -07002384 * above, we can be sure to be able to use the item looked up by
2385 * ep_find() till we release the mutex.
2386 */
Al Viro1da91ea2024-05-31 14:12:01 -04002387 epi = ep_find(ep, fd_file(tf), fd);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002388
2389 error = -EINVAL;
2390 switch (op) {
2391 case EPOLL_CTL_ADD:
2392 if (!epi) {
Jens Axboe58e41a42020-01-08 14:35:13 -07002393 epds->events |= EPOLLERR | EPOLLHUP;
Al Viro1da91ea2024-05-31 14:12:01 -04002394 error = ep_insert(ep, epds, fd_file(tf), fd, full_check);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002395 } else
2396 error = -EEXIST;
2397 break;
2398 case EPOLL_CTL_DEL:
Paolo Abeni58c9b012023-03-22 17:57:02 +01002399 if (epi) {
2400 /*
2401 * The eventpoll itself is still alive: the refcount
2402 * can't go to zero here.
2403 */
2404 ep_remove_safe(ep, epi);
2405 error = 0;
2406 } else {
Davide Libenzi7699acd2007-05-10 22:23:23 -07002407 error = -ENOENT;
Paolo Abeni58c9b012023-03-22 17:57:02 +01002408 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07002409 break;
2410 case EPOLL_CTL_MOD:
2411 if (epi) {
Jason Baronb6a515c2016-02-05 15:37:04 -08002412 if (!(epi->event.events & EPOLLEXCLUSIVE)) {
Jens Axboe58e41a42020-01-08 14:35:13 -07002413 epds->events |= EPOLLERR | EPOLLHUP;
2414 error = ep_modify(ep, epi, epds);
Jason Baronb6a515c2016-02-05 15:37:04 -08002415 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07002416 } else
2417 error = -ENOENT;
2418 break;
2419 }
Davide Libenzid47de162007-05-15 01:40:41 -07002420 mutex_unlock(&ep->mtx);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002421
2422error_tgt_fput:
Al Viro52c47962020-08-22 18:25:52 -04002423 if (full_check) {
2424 clear_tfile_check_list();
Al Viro18306c42020-09-10 08:30:05 -04002425 loop_check_gen++;
Davidlohr Buesod4cb6262023-04-11 16:41:59 -07002426 mutex_unlock(&epnested_mutex);
Al Viro52c47962020-08-22 18:25:52 -04002427 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07002428 return error;
2429}
2430
2431/*
Jens Axboe58e41a42020-01-08 14:35:13 -07002432 * The following function implements the controller interface for
2433 * the eventpoll file that enables the insertion/removal/change of
2434 * file descriptors inside the interest set.
2435 */
2436SYSCALL_DEFINE4(epoll_ctl, int, epfd, int, op, int, fd,
2437 struct epoll_event __user *, event)
2438{
2439 struct epoll_event epds;
2440
2441 if (ep_op_has_event(op) &&
2442 copy_from_user(&epds, event, sizeof(struct epoll_event)))
2443 return -EFAULT;
2444
Jens Axboe39220e8d2020-01-08 15:05:37 -07002445 return do_epoll_ctl(epfd, op, fd, &epds, false);
Jens Axboe58e41a42020-01-08 14:35:13 -07002446}
2447
2448/*
Davide Libenzi7699acd2007-05-10 22:23:23 -07002449 * Implement the event wait interface for the eventpoll file. It is the kernel
2450 * part of the user space epoll_wait(2).
2451 */
Dominik Brodowski791eb222018-03-11 11:34:30 +01002452static int do_epoll_wait(int epfd, struct epoll_event __user *events,
Willem de Bruijn7cdf7c202020-12-18 14:05:35 -08002453 int maxevents, struct timespec64 *to)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002454{
Davide Libenzi7699acd2007-05-10 22:23:23 -07002455 struct eventpoll *ep;
2456
Davide Libenzi7699acd2007-05-10 22:23:23 -07002457 /* The maximum number of event must be greater than zero */
2458 if (maxevents <= 0 || maxevents > EP_MAX_EVENTS)
2459 return -EINVAL;
2460
2461 /* Verify that the area passed by the user is writeable */
Linus Torvalds96d4f262019-01-03 18:57:57 -08002462 if (!access_ok(events, maxevents * sizeof(struct epoll_event)))
Al Viro2903ff02012-08-28 12:52:22 -04002463 return -EFAULT;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002464
2465 /* Get the "struct file *" for the eventpoll file */
Al Viro8152f822024-07-19 21:19:02 -04002466 CLASS(fd, f)(epfd);
2467 if (fd_empty(f))
Al Viro2903ff02012-08-28 12:52:22 -04002468 return -EBADF;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002469
2470 /*
2471 * We have to check that the file structure underneath the fd
2472 * the user passed to us _is_ an eventpoll file.
2473 */
Al Viro1da91ea2024-05-31 14:12:01 -04002474 if (!is_file_epoll(fd_file(f)))
Al Viro8152f822024-07-19 21:19:02 -04002475 return -EINVAL;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002476
2477 /*
2478 * At this point it is safe to assume that the "private_data" contains
2479 * our own data structure.
2480 */
Al Viro1da91ea2024-05-31 14:12:01 -04002481 ep = fd_file(f)->private_data;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002482
2483 /* Time to fish for events ... */
Al Viro8152f822024-07-19 21:19:02 -04002484 return ep_poll(ep, events, maxevents, to);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002485}
2486
Dominik Brodowski791eb222018-03-11 11:34:30 +01002487SYSCALL_DEFINE4(epoll_wait, int, epfd, struct epoll_event __user *, events,
2488 int, maxevents, int, timeout)
2489{
Willem de Bruijn7cdf7c202020-12-18 14:05:35 -08002490 struct timespec64 to;
2491
2492 return do_epoll_wait(epfd, events, maxevents,
2493 ep_timeout_to_timespec(&to, timeout));
Dominik Brodowski791eb222018-03-11 11:34:30 +01002494}
2495
Davide Libenzi7699acd2007-05-10 22:23:23 -07002496/*
2497 * Implement the event wait interface for the eventpoll file. It is the kernel
2498 * part of the user space epoll_pwait(2).
2499 */
Willem de Bruijn58169a52020-12-18 14:05:38 -08002500static int do_epoll_pwait(int epfd, struct epoll_event __user *events,
2501 int maxevents, struct timespec64 *to,
2502 const sigset_t __user *sigmask, size_t sigsetsize)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002503{
2504 int error;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002505
2506 /*
2507 * If the caller wants a certain signal mask to be set during the wait,
2508 * we apply it here.
2509 */
Oleg Nesterovb7724342019-07-16 16:29:53 -07002510 error = set_user_sigmask(sigmask, sigsetsize);
Deepa Dinamanided653c2018-09-19 21:41:04 -07002511 if (error)
2512 return error;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002513
Willem de Bruijn58169a52020-12-18 14:05:38 -08002514 error = do_epoll_wait(epfd, events, maxevents, to);
Willem de Bruijn7cdf7c202020-12-18 14:05:35 -08002515
Oleg Nesterovb7724342019-07-16 16:29:53 -07002516 restore_saved_sigmask_unless(error == -EINTR);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002517
2518 return error;
2519}
2520
Willem de Bruijn58169a52020-12-18 14:05:38 -08002521SYSCALL_DEFINE6(epoll_pwait, int, epfd, struct epoll_event __user *, events,
2522 int, maxevents, int, timeout, const sigset_t __user *, sigmask,
2523 size_t, sigsetsize)
Al Viro35280bd2013-02-24 14:52:17 -05002524{
Willem de Bruijn7cdf7c202020-12-18 14:05:35 -08002525 struct timespec64 to;
Willem de Bruijn58169a52020-12-18 14:05:38 -08002526
2527 return do_epoll_pwait(epfd, events, maxevents,
2528 ep_timeout_to_timespec(&to, timeout),
2529 sigmask, sigsetsize);
2530}
2531
2532SYSCALL_DEFINE6(epoll_pwait2, int, epfd, struct epoll_event __user *, events,
2533 int, maxevents, const struct __kernel_timespec __user *, timeout,
2534 const sigset_t __user *, sigmask, size_t, sigsetsize)
2535{
2536 struct timespec64 ts, *to = NULL;
2537
2538 if (timeout) {
2539 if (get_timespec64(&ts, timeout))
2540 return -EFAULT;
2541 to = &ts;
2542 if (poll_select_set_timeout(to, ts.tv_sec, ts.tv_nsec))
2543 return -EINVAL;
2544 }
2545
2546 return do_epoll_pwait(epfd, events, maxevents, to,
2547 sigmask, sigsetsize);
2548}
2549
2550#ifdef CONFIG_COMPAT
2551static int do_compat_epoll_pwait(int epfd, struct epoll_event __user *events,
2552 int maxevents, struct timespec64 *timeout,
2553 const compat_sigset_t __user *sigmask,
2554 compat_size_t sigsetsize)
2555{
Al Viro35280bd2013-02-24 14:52:17 -05002556 long err;
Al Viro35280bd2013-02-24 14:52:17 -05002557
2558 /*
2559 * If the caller wants a certain signal mask to be set during the wait,
2560 * we apply it here.
2561 */
Oleg Nesterovb7724342019-07-16 16:29:53 -07002562 err = set_compat_user_sigmask(sigmask, sigsetsize);
Deepa Dinamanided653c2018-09-19 21:41:04 -07002563 if (err)
2564 return err;
Al Viro35280bd2013-02-24 14:52:17 -05002565
Willem de Bruijn58169a52020-12-18 14:05:38 -08002566 err = do_epoll_wait(epfd, events, maxevents, timeout);
Willem de Bruijn7cdf7c202020-12-18 14:05:35 -08002567
Oleg Nesterovb7724342019-07-16 16:29:53 -07002568 restore_saved_sigmask_unless(err == -EINTR);
Al Viro35280bd2013-02-24 14:52:17 -05002569
2570 return err;
2571}
Willem de Bruijn58169a52020-12-18 14:05:38 -08002572
2573COMPAT_SYSCALL_DEFINE6(epoll_pwait, int, epfd,
2574 struct epoll_event __user *, events,
2575 int, maxevents, int, timeout,
2576 const compat_sigset_t __user *, sigmask,
2577 compat_size_t, sigsetsize)
2578{
2579 struct timespec64 to;
2580
2581 return do_compat_epoll_pwait(epfd, events, maxevents,
2582 ep_timeout_to_timespec(&to, timeout),
2583 sigmask, sigsetsize);
2584}
2585
2586COMPAT_SYSCALL_DEFINE6(epoll_pwait2, int, epfd,
2587 struct epoll_event __user *, events,
2588 int, maxevents,
2589 const struct __kernel_timespec __user *, timeout,
2590 const compat_sigset_t __user *, sigmask,
2591 compat_size_t, sigsetsize)
2592{
2593 struct timespec64 ts, *to = NULL;
2594
2595 if (timeout) {
2596 if (get_timespec64(&ts, timeout))
2597 return -EFAULT;
2598 to = &ts;
2599 if (poll_select_set_timeout(to, ts.tv_sec, ts.tv_nsec))
2600 return -EINVAL;
2601 }
2602
2603 return do_compat_epoll_pwait(epfd, events, maxevents, to,
2604 sigmask, sigsetsize);
2605}
2606
Al Viro35280bd2013-02-24 14:52:17 -05002607#endif
2608
Linus Torvalds1da177e2005-04-16 15:20:36 -07002609static int __init eventpoll_init(void)
2610{
Davide Libenzi7ef99642008-12-01 13:13:55 -08002611 struct sysinfo si;
2612
2613 si_meminfo(&si);
Davide Libenzi9df04e12009-01-29 14:25:26 -08002614 /*
2615 * Allows top 4% of lomem to be allocated for epoll watches (per user).
2616 */
2617 max_user_watches = (((si.totalram - si.totalhigh) / 25) << PAGE_SHIFT) /
Davide Libenzi7ef99642008-12-01 13:13:55 -08002618 EP_ITEM_COST;
Robin Holt52bd19f72011-01-12 17:00:01 -08002619 BUG_ON(max_user_watches < 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002620
Davide Libenzi22bacca2011-02-25 14:44:12 -08002621 /*
Eric Wong39732ca2013-04-30 15:27:38 -07002622 * We can have many thousands of epitems, so prevent this from
2623 * using an extra cache line on 64-bit (and smaller) CPUs
2624 */
2625 BUILD_BUG_ON(sizeof(void *) <= 8 && sizeof(struct epitem) > 128);
2626
Linus Torvalds1da177e2005-04-16 15:20:36 -07002627 /* Allocates slab cache used to allocate "struct epitem" items */
2628 epi_cache = kmem_cache_create("eventpoll_epi", sizeof(struct epitem),
Shakeel Butt2ae928a2017-11-17 15:28:59 -08002629 0, SLAB_HWCACHE_ALIGN|SLAB_PANIC|SLAB_ACCOUNT, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002630
2631 /* Allocates slab cache used to allocate "struct eppoll_entry" */
2632 pwq_cache = kmem_cache_create("eventpoll_pwq",
Shakeel Butt2ae928a2017-11-17 15:28:59 -08002633 sizeof(struct eppoll_entry), 0, SLAB_PANIC|SLAB_ACCOUNT, NULL);
Xiaoming Nia8f5de82022-01-21 22:12:09 -08002634 epoll_sysctls_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002635
Al Viro319c1512020-10-01 20:45:51 -04002636 ephead_cache = kmem_cache_create("ep_head",
2637 sizeof(struct epitems_head), 0, SLAB_PANIC|SLAB_ACCOUNT, NULL);
2638
Linus Torvalds1da177e2005-04-16 15:20:36 -07002639 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002640}
Davide Libenzicea69242007-05-10 22:23:22 -07002641fs_initcall(eventpoll_init);