blob: aeffff8debed32d757bd7be46887c61a231ae205 [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>
Colin Cross7c6ba362013-05-06 23:50:16 +000032#include <linux/freezer.h>
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -080033#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070034#include <asm/io.h>
35#include <asm/mman.h>
Arun Sharma600634972011-07-26 16:09:06 -070036#include <linux/atomic.h>
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -080037#include <linux/proc_fs.h>
38#include <linux/seq_file.h>
Al Viro35280bd2013-02-24 14:52:17 -050039#include <linux/compat.h>
Jason Baronae10b2b2013-11-12 15:10:16 -080040#include <linux/rculist.h>
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -070041#include <net/busy_poll.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070042
Manish Varma0ff110f2021-03-15 21:40:24 -070043#include <trace/hooks/fs.h>
44
Linus Torvalds1da177e2005-04-16 15:20:36 -070045/*
46 * LOCKING:
47 * There are three level of locking required by epoll :
48 *
Arjan van de Ven144efe32006-03-23 03:00:32 -080049 * 1) epmutex (mutex)
Davide Libenzic7ea7632007-05-15 01:40:47 -070050 * 2) ep->mtx (mutex)
Roman Penyaeva218cc42019-03-07 16:28:53 -080051 * 3) ep->lock (rwlock)
Linus Torvalds1da177e2005-04-16 15:20:36 -070052 *
53 * The acquire order is the one listed above, from 1 to 3.
Roman Penyaeva218cc42019-03-07 16:28:53 -080054 * We need a rwlock (ep->lock) because we manipulate objects
Linus Torvalds1da177e2005-04-16 15:20:36 -070055 * from inside the poll callback, that might be triggered from
56 * a wake_up() that in turn might be called from IRQ context.
57 * So we can't sleep inside the poll callback and hence we need
58 * a spinlock. During the event transfer loop (from kernel to
59 * user space) we could end up sleeping due a copy_to_user(), so
60 * we need a lock that will allow us to sleep. This lock is a
Davide Libenzid47de162007-05-15 01:40:41 -070061 * mutex (ep->mtx). It is acquired during the event transfer loop,
62 * during epoll_ctl(EPOLL_CTL_DEL) and during eventpoll_release_file().
63 * Then we also need a global mutex to serialize eventpoll_release_file()
64 * and ep_free().
65 * This mutex is acquired by ep_free() during the epoll file
Linus Torvalds1da177e2005-04-16 15:20:36 -070066 * cleanup path and it is also acquired by eventpoll_release_file()
67 * if a file has been pushed inside an epoll set and it is then
Daniel Balutabf6a41d2011-01-30 23:42:29 +020068 * close()d without a previous call to epoll_ctl(EPOLL_CTL_DEL).
Davide Libenzi22bacca2011-02-25 14:44:12 -080069 * It is also acquired when inserting an epoll fd onto another epoll
70 * fd. We do this so that we walk the epoll tree and ensure that this
71 * insertion does not create a cycle of epoll file descriptors, which
72 * could lead to deadlock. We need a global mutex to prevent two
73 * simultaneous inserts (A into B and B into A) from racing and
74 * constructing a cycle without either insert observing that it is
75 * going to.
Nelson Elhaged8805e62011-10-31 17:13:14 -070076 * It is necessary to acquire multiple "ep->mtx"es at once in the
77 * case when one epoll fd is added to another. In this case, we
78 * always acquire the locks in the order of nesting (i.e. after
79 * epoll_ctl(e1, EPOLL_CTL_ADD, e2), e1->mtx will always be acquired
80 * before e2->mtx). Since we disallow cycles of epoll file
81 * descriptors, this ensures that the mutexes are well-ordered. In
82 * order to communicate this nesting to lockdep, when walking a tree
83 * of epoll file descriptors, we use the current recursion depth as
84 * the lockdep subkey.
Davide Libenzid47de162007-05-15 01:40:41 -070085 * It is possible to drop the "ep->mtx" and to use the global
Roman Penyaeva218cc42019-03-07 16:28:53 -080086 * mutex "epmutex" (together with "ep->lock") to have it working,
Davide Libenzid47de162007-05-15 01:40:41 -070087 * but having "ep->mtx" will make the interface more scalable.
Arjan van de Ven144efe32006-03-23 03:00:32 -080088 * Events that require holding "epmutex" are very rare, while for
Davide Libenzid47de162007-05-15 01:40:41 -070089 * normal operations the epoll private "ep->mtx" will guarantee
90 * a better scalability.
Linus Torvalds1da177e2005-04-16 15:20:36 -070091 */
92
Linus Torvalds1da177e2005-04-16 15:20:36 -070093/* Epoll private bits inside the event mask */
Jason Barondf0108c2016-01-20 14:59:24 -080094#define EP_PRIVATE_BITS (EPOLLWAKEUP | EPOLLONESHOT | EPOLLET | EPOLLEXCLUSIVE)
Linus Torvalds1da177e2005-04-16 15:20:36 -070095
Linus Torvaldsa9a08842018-02-11 14:34:03 -080096#define EPOLLINOUT_BITS (EPOLLIN | EPOLLOUT)
Jason Baronb6a515c2016-02-05 15:37:04 -080097
Linus Torvaldsa9a08842018-02-11 14:34:03 -080098#define EPOLLEXCLUSIVE_OK_BITS (EPOLLINOUT_BITS | EPOLLERR | EPOLLHUP | \
Jason Baronb6a515c2016-02-05 15:37:04 -080099 EPOLLWAKEUP | EPOLLET | EPOLLEXCLUSIVE)
100
Davide Libenzi5071f972009-03-31 15:24:10 -0700101/* Maximum number of nesting allowed inside epoll sets */
102#define EP_MAX_NESTS 4
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103
Davide Libenzib6119672006-10-11 01:21:44 -0700104#define EP_MAX_EVENTS (INT_MAX / sizeof(struct epoll_event))
105
Davide Libenzid47de162007-05-15 01:40:41 -0700106#define EP_UNACTIVE_PTR ((void *) -1L)
107
Davide Libenzi7ef99642008-12-01 13:13:55 -0800108#define EP_ITEM_COST (sizeof(struct epitem) + sizeof(struct eppoll_entry))
109
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110struct epoll_filefd {
111 struct file *file;
112 int fd;
Eric Wong39732ca2013-04-30 15:27:38 -0700113} __packed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114
115/*
Davide Libenzi5071f972009-03-31 15:24:10 -0700116 * Structure used to track possible nested calls, for too deep recursions
117 * and loop cycles.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118 */
Davide Libenzi5071f972009-03-31 15:24:10 -0700119struct nested_call_node {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120 struct list_head llink;
Davide Libenzi5071f972009-03-31 15:24:10 -0700121 void *cookie;
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700122 void *ctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123};
124
125/*
Davide Libenzi5071f972009-03-31 15:24:10 -0700126 * This structure is used as collector for nested calls, to check for
127 * maximum recursion dept and loop cycles.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128 */
Davide Libenzi5071f972009-03-31 15:24:10 -0700129struct nested_calls {
130 struct list_head tasks_call_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131 spinlock_t lock;
132};
133
134/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135 * Each file descriptor added to the eventpoll interface will
Davide Libenzi6192bd52007-05-08 00:25:41 -0700136 * have an entry of this type linked to the "rbr" RB tree.
Eric Wong39732ca2013-04-30 15:27:38 -0700137 * Avoid increasing the size of this struct, there can be many thousands
138 * of these on a server and we do not want this to take another cache line.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139 */
140struct epitem {
Jason Baronae10b2b2013-11-12 15:10:16 -0800141 union {
142 /* RB tree node links this structure to the eventpoll RB tree */
143 struct rb_node rbn;
144 /* Used to free the struct epitem */
145 struct rcu_head rcu;
146 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147
148 /* List header used to link this structure to the eventpoll ready list */
149 struct list_head rdllink;
150
Davide Libenzic7ea7632007-05-15 01:40:47 -0700151 /*
152 * Works together "struct eventpoll"->ovflist in keeping the
153 * single linked chain of items.
154 */
155 struct epitem *next;
156
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157 /* The file descriptor information this item refers to */
158 struct epoll_filefd ffd;
159
160 /* Number of active wait queue attached to poll operations */
161 int nwait;
162
163 /* List containing poll wait queues */
164 struct list_head pwqlist;
165
166 /* The "container" of this item */
167 struct eventpoll *ep;
168
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169 /* List header used to link this item to the "struct file" items list */
170 struct list_head fllink;
Davide Libenzid47de162007-05-15 01:40:41 -0700171
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200172 /* wakeup_source used when EPOLLWAKEUP is set */
Eric Wongeea1d582013-04-30 15:27:39 -0700173 struct wakeup_source __rcu *ws;
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200174
Davide Libenzic7ea7632007-05-15 01:40:47 -0700175 /* The structure that describe the interested events and the source fd */
176 struct epoll_event event;
Davide Libenzid47de162007-05-15 01:40:41 -0700177};
178
179/*
180 * This structure is stored inside the "private_data" member of the file
Daniel Balutabf6a41d2011-01-30 23:42:29 +0200181 * structure and represents the main data structure for the eventpoll
Davide Libenzid47de162007-05-15 01:40:41 -0700182 * interface.
183 */
184struct eventpoll {
Davide Libenzid47de162007-05-15 01:40:41 -0700185 /*
186 * This mutex is used to ensure that files are not removed
187 * while epoll is using them. This is held during the event
188 * collection loop, the file cleanup path, the epoll file exit
189 * code and the ctl operations.
190 */
191 struct mutex mtx;
192
193 /* Wait queue used by sys_epoll_wait() */
194 wait_queue_head_t wq;
195
196 /* Wait queue used by file->poll() */
197 wait_queue_head_t poll_wait;
198
199 /* List of ready file descriptors */
200 struct list_head rdllist;
201
Roman Penyaeva218cc42019-03-07 16:28:53 -0800202 /* Lock which protects rdllist and ovflist */
203 rwlock_t lock;
204
Davide Libenzi67647d02007-05-15 01:40:52 -0700205 /* RB tree root used to store monitored fd structs */
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700206 struct rb_root_cached rbr;
Davide Libenzid47de162007-05-15 01:40:41 -0700207
208 /*
209 * This is a single linked list that chains all the "struct epitem" that
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300210 * happened while transferring ready events to userspace w/out
Roman Penyaeva218cc42019-03-07 16:28:53 -0800211 * holding ->lock.
Davide Libenzid47de162007-05-15 01:40:41 -0700212 */
213 struct epitem *ovflist;
Davide Libenzi7ef99642008-12-01 13:13:55 -0800214
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200215 /* wakeup_source used when ep_scan_ready_list is running */
216 struct wakeup_source *ws;
217
Davide Libenzi7ef99642008-12-01 13:13:55 -0800218 /* The user that created the eventpoll descriptor */
219 struct user_struct *user;
Jason Baron28d82dc2012-01-12 17:17:43 -0800220
221 struct file *file;
222
223 /* used to optimize loop detection check */
Al Viro18306c42020-09-10 08:30:05 -0400224 u64 gen;
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700225
226#ifdef CONFIG_NET_RX_BUSY_POLL
227 /* used to track busy poll napi_id */
228 unsigned int napi_id;
229#endif
Jason Baronefcdd352020-04-06 20:11:23 -0700230
231#ifdef CONFIG_DEBUG_LOCK_ALLOC
232 /* tracks wakeup nests for lockdep validation */
233 u8 nests;
234#endif
Davide Libenzid47de162007-05-15 01:40:41 -0700235};
236
237/* Wait structure used by the poll hooks */
238struct eppoll_entry {
239 /* List header used to link this structure to the "struct epitem" */
240 struct list_head llink;
241
242 /* The "base" pointer is set to the container "struct epitem" */
Tony Battersby4f0989d2009-03-31 15:24:16 -0700243 struct epitem *base;
Davide Libenzid47de162007-05-15 01:40:41 -0700244
245 /*
246 * Wait queue item that will be linked to the target file wait
247 * queue head.
248 */
Ingo Molnarac6424b2017-06-20 12:06:13 +0200249 wait_queue_entry_t wait;
Davide Libenzid47de162007-05-15 01:40:41 -0700250
251 /* The wait queue head that linked the "wait" wait queue item */
252 wait_queue_head_t *whead;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253};
254
255/* Wrapper struct used by poll queueing */
256struct ep_pqueue {
257 poll_table pt;
258 struct epitem *epi;
259};
260
Davide Libenzi5071f972009-03-31 15:24:10 -0700261/* Used by the ep_send_events() function as callback private data */
262struct ep_send_events_data {
263 int maxevents;
264 struct epoll_event __user *events;
Al Virod7ebbe42018-02-01 15:21:13 -0500265 int res;
Davide Libenzi5071f972009-03-31 15:24:10 -0700266};
267
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268/*
Davide Libenzi7ef99642008-12-01 13:13:55 -0800269 * Configuration options available inside /proc/sys/fs/epoll/
270 */
Davide Libenzi7ef99642008-12-01 13:13:55 -0800271/* Maximum number of epoll watched descriptors, per user */
Robin Holt52bd19f72011-01-12 17:00:01 -0800272static long max_user_watches __read_mostly;
Davide Libenzi7ef99642008-12-01 13:13:55 -0800273
274/*
Davide Libenzid47de162007-05-15 01:40:41 -0700275 * This mutex is used to serialize ep_free() and eventpoll_release_file().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276 */
Davide Libenzi7ef99642008-12-01 13:13:55 -0800277static DEFINE_MUTEX(epmutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278
Al Viro18306c42020-09-10 08:30:05 -0400279static u64 loop_check_gen = 0;
280
Davide Libenzi22bacca2011-02-25 14:44:12 -0800281/* Used to check for epoll file descriptor inclusion loops */
282static struct nested_calls poll_loop_ncalls;
283
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284/* Slab cache used to allocate "struct epitem" */
Christoph Lametere18b8902006-12-06 20:33:20 -0800285static struct kmem_cache *epi_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286
287/* Slab cache used to allocate "struct eppoll_entry" */
Christoph Lametere18b8902006-12-06 20:33:20 -0800288static struct kmem_cache *pwq_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289
Jason Baron28d82dc2012-01-12 17:17:43 -0800290/*
291 * List of files with newly added links, where we may need to limit the number
292 * of emanating paths. Protected by the epmutex.
293 */
294static LIST_HEAD(tfile_check_list);
295
Davide Libenzi7ef99642008-12-01 13:13:55 -0800296#ifdef CONFIG_SYSCTL
297
298#include <linux/sysctl.h>
299
Matteo Croceeec48442019-07-18 15:58:50 -0700300static long long_zero;
Robin Holt52bd19f72011-01-12 17:00:01 -0800301static long long_max = LONG_MAX;
Davide Libenzi7ef99642008-12-01 13:13:55 -0800302
Joe Perches1f7e0612014-06-06 14:38:05 -0700303struct ctl_table epoll_table[] = {
Davide Libenzi7ef99642008-12-01 13:13:55 -0800304 {
Davide Libenzi7ef99642008-12-01 13:13:55 -0800305 .procname = "max_user_watches",
306 .data = &max_user_watches,
Robin Holt52bd19f72011-01-12 17:00:01 -0800307 .maxlen = sizeof(max_user_watches),
Davide Libenzi7ef99642008-12-01 13:13:55 -0800308 .mode = 0644,
Robin Holt52bd19f72011-01-12 17:00:01 -0800309 .proc_handler = proc_doulongvec_minmax,
Matteo Croceeec48442019-07-18 15:58:50 -0700310 .extra1 = &long_zero,
Robin Holt52bd19f72011-01-12 17:00:01 -0800311 .extra2 = &long_max,
Davide Libenzi7ef99642008-12-01 13:13:55 -0800312 },
Eric W. Biedermanab092032009-11-05 14:25:10 -0800313 { }
Davide Libenzi7ef99642008-12-01 13:13:55 -0800314};
315#endif /* CONFIG_SYSCTL */
316
Jason Baron28d82dc2012-01-12 17:17:43 -0800317static const struct file_operations eventpoll_fops;
318
319static inline int is_file_epoll(struct file *f)
320{
321 return f->f_op == &eventpoll_fops;
322}
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700323
Davide Libenzi67647d02007-05-15 01:40:52 -0700324/* Setup the structure that is used as key for the RB tree */
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700325static inline void ep_set_ffd(struct epoll_filefd *ffd,
326 struct file *file, int fd)
327{
328 ffd->file = file;
329 ffd->fd = fd;
330}
331
Davide Libenzi67647d02007-05-15 01:40:52 -0700332/* Compare RB tree keys */
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700333static inline int ep_cmp_ffd(struct epoll_filefd *p1,
334 struct epoll_filefd *p2)
335{
336 return (p1->file > p2->file ? +1:
337 (p1->file < p2->file ? -1 : p1->fd - p2->fd));
338}
339
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700340/* Tells us if the item is currently linked */
Davidlohr Bueso992991c2018-08-21 21:58:26 -0700341static inline int ep_is_linked(struct epitem *epi)
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700342{
Davidlohr Bueso992991c2018-08-21 21:58:26 -0700343 return !list_empty(&epi->rdllink);
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700344}
345
Ingo Molnarac6424b2017-06-20 12:06:13 +0200346static inline struct eppoll_entry *ep_pwq_from_wait(wait_queue_entry_t *p)
Oleg Nesterov971316f2012-02-24 20:07:29 +0100347{
348 return container_of(p, struct eppoll_entry, wait);
349}
350
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700351/* Get the "struct epitem" from a wait queue pointer */
Ingo Molnarac6424b2017-06-20 12:06:13 +0200352static inline struct epitem *ep_item_from_wait(wait_queue_entry_t *p)
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700353{
354 return container_of(p, struct eppoll_entry, wait)->base;
355}
356
357/* Get the "struct epitem" from an epoll queue wrapper */
Davide Libenzicdac75e2008-04-29 00:58:34 -0700358static inline struct epitem *ep_item_from_epqueue(poll_table *p)
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700359{
360 return container_of(p, struct ep_pqueue, pt)->epi;
361}
362
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363/* Initialize the poll safe wake up structure */
Davide Libenzi5071f972009-03-31 15:24:10 -0700364static void ep_nested_calls_init(struct nested_calls *ncalls)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365{
Davide Libenzi5071f972009-03-31 15:24:10 -0700366 INIT_LIST_HEAD(&ncalls->tasks_call_list);
367 spin_lock_init(&ncalls->lock);
368}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369
Davide Libenzi5071f972009-03-31 15:24:10 -0700370/**
Davide Libenzi3fb0e582011-03-22 16:34:46 -0700371 * ep_events_available - Checks if ready events might be available.
372 *
373 * @ep: Pointer to the eventpoll context.
374 *
375 * Returns: Returns a value different than zero if ready events are available,
376 * or zero otherwise.
377 */
378static inline int ep_events_available(struct eventpoll *ep)
379{
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -0800380 return !list_empty_careful(&ep->rdllist) ||
381 READ_ONCE(ep->ovflist) != EP_UNACTIVE_PTR;
Davide Libenzi3fb0e582011-03-22 16:34:46 -0700382}
383
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700384#ifdef CONFIG_NET_RX_BUSY_POLL
385static bool ep_busy_loop_end(void *p, unsigned long start_time)
386{
387 struct eventpoll *ep = p;
388
389 return ep_events_available(ep) || busy_loop_timeout(start_time);
390}
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700391
392/*
393 * Busy poll if globally on and supporting sockets found && no events,
394 * busy loop will return if need_resched or ep_events_available.
395 *
396 * we must do our busy polling with irqs enabled
397 */
398static void ep_busy_loop(struct eventpoll *ep, int nonblock)
399{
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700400 unsigned int napi_id = READ_ONCE(ep->napi_id);
401
402 if ((napi_id >= MIN_NAPI_ID) && net_busy_loop_on())
403 napi_busy_loop(napi_id, nonblock ? NULL : ep_busy_loop_end, ep);
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700404}
405
406static inline void ep_reset_busy_poll_napi_id(struct eventpoll *ep)
407{
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700408 if (ep->napi_id)
409 ep->napi_id = 0;
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700410}
411
412/*
413 * Set epoll busy poll NAPI ID from sk.
414 */
415static inline void ep_set_busy_poll_napi_id(struct epitem *epi)
416{
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700417 struct eventpoll *ep;
418 unsigned int napi_id;
419 struct socket *sock;
420 struct sock *sk;
421 int err;
422
423 if (!net_busy_loop_on())
424 return;
425
426 sock = sock_from_file(epi->ffd.file, &err);
427 if (!sock)
428 return;
429
430 sk = sock->sk;
431 if (!sk)
432 return;
433
434 napi_id = READ_ONCE(sk->sk_napi_id);
435 ep = epi->ep;
436
437 /* Non-NAPI IDs can be rejected
438 * or
439 * Nothing to do if we already have this ID
440 */
441 if (napi_id < MIN_NAPI_ID || napi_id == ep->napi_id)
442 return;
443
444 /* record NAPI ID for use in next busy poll */
445 ep->napi_id = napi_id;
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700446}
447
Davidlohr Bueso514056d2018-08-21 21:58:19 -0700448#else
449
450static inline void ep_busy_loop(struct eventpoll *ep, int nonblock)
451{
452}
453
454static inline void ep_reset_busy_poll_napi_id(struct eventpoll *ep)
455{
456}
457
458static inline void ep_set_busy_poll_napi_id(struct epitem *epi)
459{
460}
461
462#endif /* CONFIG_NET_RX_BUSY_POLL */
463
Davide Libenzi3fb0e582011-03-22 16:34:46 -0700464/**
Davide Libenzi5071f972009-03-31 15:24:10 -0700465 * ep_call_nested - Perform a bound (possibly) nested call, by checking
466 * that the recursion limit is not exceeded, and that
467 * the same nested call (by the meaning of same cookie) is
468 * no re-entered.
469 *
470 * @ncalls: Pointer to the nested_calls structure to be used for this call.
Davide Libenzi5071f972009-03-31 15:24:10 -0700471 * @nproc: Nested call core function pointer.
472 * @priv: Opaque data to be passed to the @nproc callback.
473 * @cookie: Cookie to be used to identify this nested call.
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700474 * @ctx: This instance context.
Davide Libenzi5071f972009-03-31 15:24:10 -0700475 *
476 * Returns: Returns the code returned by the @nproc callback, or -1 if
477 * the maximum recursion limit has been exceeded.
478 */
Davidlohr Bueso74bdc122019-01-03 15:27:02 -0800479static int ep_call_nested(struct nested_calls *ncalls,
Davide Libenzi5071f972009-03-31 15:24:10 -0700480 int (*nproc)(void *, void *, int), void *priv,
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700481 void *cookie, void *ctx)
Davide Libenzi5071f972009-03-31 15:24:10 -0700482{
483 int error, call_nests = 0;
484 unsigned long flags;
Davide Libenzi5071f972009-03-31 15:24:10 -0700485 struct list_head *lsthead = &ncalls->tasks_call_list;
486 struct nested_call_node *tncur;
487 struct nested_call_node tnode;
488
489 spin_lock_irqsave(&ncalls->lock, flags);
490
491 /*
492 * Try to see if the current task is already inside this wakeup call.
493 * We use a list here, since the population inside this set is always
494 * very much limited.
495 */
496 list_for_each_entry(tncur, lsthead, llink) {
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700497 if (tncur->ctx == ctx &&
Davidlohr Bueso74bdc122019-01-03 15:27:02 -0800498 (tncur->cookie == cookie || ++call_nests > EP_MAX_NESTS)) {
Davide Libenzi5071f972009-03-31 15:24:10 -0700499 /*
500 * Ops ... loop detected or maximum nest level reached.
501 * We abort this wake by breaking the cycle itself.
502 */
Tony Battersbyabff55c2009-03-31 15:24:13 -0700503 error = -1;
504 goto out_unlock;
Davide Libenzi5071f972009-03-31 15:24:10 -0700505 }
506 }
507
508 /* Add the current task and cookie to the list */
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700509 tnode.ctx = ctx;
Davide Libenzi5071f972009-03-31 15:24:10 -0700510 tnode.cookie = cookie;
511 list_add(&tnode.llink, lsthead);
512
513 spin_unlock_irqrestore(&ncalls->lock, flags);
514
515 /* Call the nested function */
516 error = (*nproc)(priv, cookie, call_nests);
517
518 /* Remove the current task from the list */
519 spin_lock_irqsave(&ncalls->lock, flags);
520 list_del(&tnode.llink);
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700521out_unlock:
Davide Libenzi5071f972009-03-31 15:24:10 -0700522 spin_unlock_irqrestore(&ncalls->lock, flags);
523
524 return error;
525}
526
Steven Rostedt02edc6f2012-03-23 15:02:27 -0700527/*
528 * As described in commit 0ccf831cb lockdep: annotate epoll
529 * the use of wait queues used by epoll is done in a very controlled
530 * manner. Wake ups can nest inside each other, but are never done
531 * with the same locking. For example:
532 *
533 * dfd = socket(...);
534 * efd1 = epoll_create();
535 * efd2 = epoll_create();
536 * epoll_ctl(efd1, EPOLL_CTL_ADD, dfd, ...);
537 * epoll_ctl(efd2, EPOLL_CTL_ADD, efd1, ...);
538 *
539 * When a packet arrives to the device underneath "dfd", the net code will
540 * issue a wake_up() on its poll wake list. Epoll (efd1) has installed a
541 * callback wakeup entry on that queue, and the wake_up() performed by the
542 * "dfd" net code will end up in ep_poll_callback(). At this point epoll
543 * (efd1) notices that it may have some event ready, so it needs to wake up
544 * the waiters on its poll wait list (efd2). So it calls ep_poll_safewake()
545 * that ends up in another wake_up(), after having checked about the
546 * recursion constraints. That are, no more than EP_MAX_POLLWAKE_NESTS, to
547 * avoid stack blasting.
548 *
549 * When CONFIG_DEBUG_LOCK_ALLOC is enabled, make sure lockdep can handle
550 * this special case of epoll.
551 */
Davide Libenzi2dfa4ee2009-03-31 15:24:22 -0700552#ifdef CONFIG_DEBUG_LOCK_ALLOC
Davide Libenzi2dfa4ee2009-03-31 15:24:22 -0700553
Jason Baronefcdd352020-04-06 20:11:23 -0700554static void ep_poll_safewake(struct eventpoll *ep, struct epitem *epi)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555{
Jason Baronefcdd352020-04-06 20:11:23 -0700556 struct eventpoll *ep_src;
Jason Baronf6520c52019-12-04 16:52:12 -0800557 unsigned long flags;
Jason Baronefcdd352020-04-06 20:11:23 -0700558 u8 nests = 0;
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700559
Jason Baronefcdd352020-04-06 20:11:23 -0700560 /*
561 * To set the subclass or nesting level for spin_lock_irqsave_nested()
562 * it might be natural to create a per-cpu nest count. However, since
563 * we can recurse on ep->poll_wait.lock, and a non-raw spinlock can
564 * schedule() in the -rt kernel, the per-cpu variable are no longer
565 * protected. Thus, we are introducing a per eventpoll nest field.
566 * If we are not being call from ep_poll_callback(), epi is NULL and
567 * we are at the first level of nesting, 0. Otherwise, we are being
568 * called from ep_poll_callback() and if a previous wakeup source is
569 * not an epoll file itself, we are at depth 1 since the wakeup source
570 * is depth 0. If the wakeup source is a previous epoll file in the
571 * wakeup chain then we use its nests value and record ours as
572 * nests + 1. The previous epoll file nests value is stable since its
573 * already holding its own poll_wait.lock.
574 */
575 if (epi) {
576 if ((is_file_epoll(epi->ffd.file))) {
577 ep_src = epi->ffd.file->private_data;
578 nests = ep_src->nests;
579 } else {
580 nests = 1;
581 }
582 }
583 spin_lock_irqsave_nested(&ep->poll_wait.lock, flags, nests);
584 ep->nests = nests + 1;
585 wake_up_locked_poll(&ep->poll_wait, EPOLLIN);
586 ep->nests = 0;
587 spin_unlock_irqrestore(&ep->poll_wait.lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588}
589
Jason Baron57a173b2017-11-17 15:29:02 -0800590#else
591
Jason Baronefcdd352020-04-06 20:11:23 -0700592static void ep_poll_safewake(struct eventpoll *ep, struct epitem *epi)
Jason Baron57a173b2017-11-17 15:29:02 -0800593{
Jason Baronefcdd352020-04-06 20:11:23 -0700594 wake_up_poll(&ep->poll_wait, EPOLLIN);
Jason Baron57a173b2017-11-17 15:29:02 -0800595}
596
597#endif
598
Oleg Nesterov971316f2012-02-24 20:07:29 +0100599static void ep_remove_wait_queue(struct eppoll_entry *pwq)
600{
601 wait_queue_head_t *whead;
602
603 rcu_read_lock();
Oleg Nesterov138e4ad2017-09-01 18:55:33 +0200604 /*
605 * If it is cleared by POLLFREE, it should be rcu-safe.
606 * If we read NULL we need a barrier paired with
607 * smp_store_release() in ep_poll_callback(), otherwise
608 * we rely on whead->lock.
609 */
610 whead = smp_load_acquire(&pwq->whead);
Oleg Nesterov971316f2012-02-24 20:07:29 +0100611 if (whead)
612 remove_wait_queue(whead, &pwq->wait);
613 rcu_read_unlock();
614}
615
Davide Libenzi7699acd2007-05-10 22:23:23 -0700616/*
Tony Battersbyd1bc90d2009-03-31 15:24:15 -0700617 * This function unregisters poll callbacks from the associated file
618 * descriptor. Must be called with "mtx" held (or "epmutex" if called from
619 * ep_free).
Davide Libenzi7699acd2007-05-10 22:23:23 -0700620 */
621static void ep_unregister_pollwait(struct eventpoll *ep, struct epitem *epi)
622{
Davide Libenzi7699acd2007-05-10 22:23:23 -0700623 struct list_head *lsthead = &epi->pwqlist;
624 struct eppoll_entry *pwq;
625
Tony Battersbyd1bc90d2009-03-31 15:24:15 -0700626 while (!list_empty(lsthead)) {
627 pwq = list_first_entry(lsthead, struct eppoll_entry, llink);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700628
Tony Battersbyd1bc90d2009-03-31 15:24:15 -0700629 list_del(&pwq->llink);
Oleg Nesterov971316f2012-02-24 20:07:29 +0100630 ep_remove_wait_queue(pwq);
Tony Battersbyd1bc90d2009-03-31 15:24:15 -0700631 kmem_cache_free(pwq_cache, pwq);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700632 }
633}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634
Eric Wongeea1d582013-04-30 15:27:39 -0700635/* call only when ep->mtx is held */
636static inline struct wakeup_source *ep_wakeup_source(struct epitem *epi)
637{
638 return rcu_dereference_check(epi->ws, lockdep_is_held(&epi->ep->mtx));
639}
640
641/* call only when ep->mtx is held */
642static inline void ep_pm_stay_awake(struct epitem *epi)
643{
644 struct wakeup_source *ws = ep_wakeup_source(epi);
645
646 if (ws)
647 __pm_stay_awake(ws);
648}
649
650static inline bool ep_has_wakeup_source(struct epitem *epi)
651{
652 return rcu_access_pointer(epi->ws) ? true : false;
653}
654
655/* call when ep->mtx cannot be held (ep_poll_callback) */
656static inline void ep_pm_stay_awake_rcu(struct epitem *epi)
657{
658 struct wakeup_source *ws;
659
660 rcu_read_lock();
661 ws = rcu_dereference(epi->ws);
662 if (ws)
663 __pm_stay_awake(ws);
664 rcu_read_unlock();
665}
666
Davide Libenzi5071f972009-03-31 15:24:10 -0700667/**
668 * ep_scan_ready_list - Scans the ready list in a way that makes possible for
669 * the scan code, to call f_op->poll(). Also allows for
670 * O(NumReady) performance.
671 *
672 * @ep: Pointer to the epoll private data structure.
673 * @sproc: Pointer to the scan callback.
674 * @priv: Private opaque data passed to the @sproc callback.
Nelson Elhaged8805e62011-10-31 17:13:14 -0700675 * @depth: The current depth of recursive f_op->poll calls.
Jason Baron67347fe2013-11-12 15:10:18 -0800676 * @ep_locked: caller already holds ep->mtx
Davide Libenzi5071f972009-03-31 15:24:10 -0700677 *
678 * Returns: The same integer error code returned by the @sproc callback.
679 */
Al Virod85e2aa2018-02-01 15:24:58 -0500680static __poll_t ep_scan_ready_list(struct eventpoll *ep,
681 __poll_t (*sproc)(struct eventpoll *,
Davide Libenzi5071f972009-03-31 15:24:10 -0700682 struct list_head *, void *),
Jason Baron67347fe2013-11-12 15:10:18 -0800683 void *priv, int depth, bool ep_locked)
Davide Libenzi5071f972009-03-31 15:24:10 -0700684{
Al Virod85e2aa2018-02-01 15:24:58 -0500685 __poll_t res;
Davide Libenzi5071f972009-03-31 15:24:10 -0700686 struct epitem *epi, *nepi;
Davide Libenzi296e2362009-03-31 15:24:11 -0700687 LIST_HEAD(txlist);
Davide Libenzi5071f972009-03-31 15:24:10 -0700688
Davidlohr Bueso92e64172018-08-21 21:56:45 -0700689 lockdep_assert_irqs_enabled();
690
Davide Libenzi5071f972009-03-31 15:24:10 -0700691 /*
692 * We need to lock this because we could be hit by
Tony Battersbye057e152009-03-31 15:24:15 -0700693 * eventpoll_release_file() and epoll_ctl().
Davide Libenzi5071f972009-03-31 15:24:10 -0700694 */
Jason Baron67347fe2013-11-12 15:10:18 -0800695
696 if (!ep_locked)
697 mutex_lock_nested(&ep->mtx, depth);
Davide Libenzi5071f972009-03-31 15:24:10 -0700698
699 /*
700 * Steal the ready list, and re-init the original one to the
701 * empty list. Also, set ep->ovflist to NULL so that events
702 * happening while looping w/out locks, are not lost. We cannot
703 * have the poll callback to queue directly on ep->rdllist,
704 * because we want the "sproc" callback to be able to do it
705 * in a lockless way.
706 */
Roman Penyaeva218cc42019-03-07 16:28:53 -0800707 write_lock_irq(&ep->lock);
Davide Libenzi296e2362009-03-31 15:24:11 -0700708 list_splice_init(&ep->rdllist, &txlist);
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -0800709 WRITE_ONCE(ep->ovflist, NULL);
Roman Penyaeva218cc42019-03-07 16:28:53 -0800710 write_unlock_irq(&ep->lock);
Davide Libenzi5071f972009-03-31 15:24:10 -0700711
712 /*
713 * Now call the callback function.
714 */
Al Virod85e2aa2018-02-01 15:24:58 -0500715 res = (*sproc)(ep, &txlist, priv);
Davide Libenzi5071f972009-03-31 15:24:10 -0700716
Roman Penyaeva218cc42019-03-07 16:28:53 -0800717 write_lock_irq(&ep->lock);
Davide Libenzi5071f972009-03-31 15:24:10 -0700718 /*
719 * During the time we spent inside the "sproc" callback, some
720 * other events might have been queued by the poll callback.
721 * We re-insert them inside the main ready-list here.
722 */
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -0800723 for (nepi = READ_ONCE(ep->ovflist); (epi = nepi) != NULL;
Davide Libenzi5071f972009-03-31 15:24:10 -0700724 nepi = epi->next, epi->next = EP_UNACTIVE_PTR) {
725 /*
726 * We need to check if the item is already in the list.
727 * During the "sproc" callback execution time, items are
728 * queued into ->ovflist but the "txlist" might already
729 * contain them, and the list_splice() below takes care of them.
730 */
Davidlohr Bueso992991c2018-08-21 21:58:26 -0700731 if (!ep_is_linked(epi)) {
Roman Penyaevc1411752019-03-07 16:28:46 -0800732 /*
733 * ->ovflist is LIFO, so we have to reverse it in order
734 * to keep in FIFO.
735 */
736 list_add(&epi->rdllink, &ep->rdllist);
Eric Wongeea1d582013-04-30 15:27:39 -0700737 ep_pm_stay_awake(epi);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200738 }
Davide Libenzi5071f972009-03-31 15:24:10 -0700739 }
740 /*
741 * We need to set back ep->ovflist to EP_UNACTIVE_PTR, so that after
742 * releasing the lock, events will be queued in the normal way inside
743 * ep->rdllist.
744 */
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -0800745 WRITE_ONCE(ep->ovflist, EP_UNACTIVE_PTR);
Davide Libenzi5071f972009-03-31 15:24:10 -0700746
747 /*
748 * Quickly re-inject items left on "txlist".
749 */
750 list_splice(&txlist, &ep->rdllist);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200751 __pm_relax(ep->ws);
Davidlohr Bueso4c44c132021-05-06 18:04:07 -0700752
753 if (!list_empty(&ep->rdllist)) {
754 if (waitqueue_active(&ep->wq))
755 wake_up(&ep->wq);
756 }
757
Roman Penyaeva218cc42019-03-07 16:28:53 -0800758 write_unlock_irq(&ep->lock);
Davide Libenzi5071f972009-03-31 15:24:10 -0700759
Jason Baron67347fe2013-11-12 15:10:18 -0800760 if (!ep_locked)
761 mutex_unlock(&ep->mtx);
Davide Libenzi5071f972009-03-31 15:24:10 -0700762
Al Virod85e2aa2018-02-01 15:24:58 -0500763 return res;
Davide Libenzi5071f972009-03-31 15:24:10 -0700764}
765
Jason Baronae10b2b2013-11-12 15:10:16 -0800766static void epi_rcu_free(struct rcu_head *head)
767{
768 struct epitem *epi = container_of(head, struct epitem, rcu);
769 kmem_cache_free(epi_cache, epi);
770}
771
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772/*
Davide Libenzi7699acd2007-05-10 22:23:23 -0700773 * Removes a "struct epitem" from the eventpoll RB tree and deallocates
Davide Libenzic7ea7632007-05-15 01:40:47 -0700774 * all the associated resources. Must be called with "mtx" held.
Davide Libenzi7699acd2007-05-10 22:23:23 -0700775 */
776static int ep_remove(struct eventpoll *ep, struct epitem *epi)
777{
Davide Libenzi7699acd2007-05-10 22:23:23 -0700778 struct file *file = epi->ffd.file;
779
Davidlohr Bueso92e64172018-08-21 21:56:45 -0700780 lockdep_assert_irqs_enabled();
781
Davide Libenzi7699acd2007-05-10 22:23:23 -0700782 /*
Christoph Hellwigee8ef0a2018-08-21 21:56:26 -0700783 * Removes poll wait queue hooks.
Davide Libenzi7699acd2007-05-10 22:23:23 -0700784 */
785 ep_unregister_pollwait(ep, epi);
786
787 /* Remove the current item from the list of epoll hooks */
Jonathan Corbet68499912009-02-06 13:52:43 -0700788 spin_lock(&file->f_lock);
Jason Baronae10b2b2013-11-12 15:10:16 -0800789 list_del_rcu(&epi->fllink);
Jonathan Corbet68499912009-02-06 13:52:43 -0700790 spin_unlock(&file->f_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700792 rb_erase_cached(&epi->rbn, &ep->rbr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793
Roman Penyaeva218cc42019-03-07 16:28:53 -0800794 write_lock_irq(&ep->lock);
Davidlohr Bueso992991c2018-08-21 21:58:26 -0700795 if (ep_is_linked(epi))
Davide Libenzic7ea7632007-05-15 01:40:47 -0700796 list_del_init(&epi->rdllink);
Roman Penyaeva218cc42019-03-07 16:28:53 -0800797 write_unlock_irq(&ep->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798
Eric Wongeea1d582013-04-30 15:27:39 -0700799 wakeup_source_unregister(ep_wakeup_source(epi));
Jason Baronae10b2b2013-11-12 15:10:16 -0800800 /*
801 * At this point it is safe to free the eventpoll item. Use the union
802 * field epi->rcu, since we are trying to minimize the size of
803 * 'struct epitem'. The 'rbn' field is no longer in use. Protected by
804 * ep->mtx. The rcu read side, reverse_path_check_proc(), does not make
805 * use of the rbn field.
806 */
807 call_rcu(&epi->rcu, epi_rcu_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808
Robin Holt52bd19f72011-01-12 17:00:01 -0800809 atomic_long_dec(&ep->user->epoll_watches);
Davide Libenzi7ef99642008-12-01 13:13:55 -0800810
Davide Libenzic7ea7632007-05-15 01:40:47 -0700811 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812}
813
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814static void ep_free(struct eventpoll *ep)
815{
816 struct rb_node *rbp;
817 struct epitem *epi;
818
819 /* We need to release all tasks waiting for these file */
820 if (waitqueue_active(&ep->poll_wait))
Jason Baronefcdd352020-04-06 20:11:23 -0700821 ep_poll_safewake(ep, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822
823 /*
824 * We need to lock this because we could be hit by
825 * eventpoll_release_file() while we're freeing the "struct eventpoll".
Davide Libenzid47de162007-05-15 01:40:41 -0700826 * We do not need to hold "ep->mtx" here because the epoll file
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827 * is on the way to be removed and no one has references to it
828 * anymore. The only hit might come from eventpoll_release_file() but
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300829 * holding "epmutex" is sufficient here.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830 */
Arjan van de Ven144efe32006-03-23 03:00:32 -0800831 mutex_lock(&epmutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832
833 /*
834 * Walks through the whole tree by unregistering poll callbacks.
835 */
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700836 for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837 epi = rb_entry(rbp, struct epitem, rbn);
838
839 ep_unregister_pollwait(ep, epi);
Eric Dumazet91cf5ab2013-09-11 14:24:06 -0700840 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841 }
842
843 /*
Davide Libenzi6192bd52007-05-08 00:25:41 -0700844 * Walks through the whole tree by freeing each "struct epitem". At this
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845 * point we are sure no poll callbacks will be lingering around, and also by
Davide Libenzid47de162007-05-15 01:40:41 -0700846 * holding "epmutex" we can be sure that no file cleanup code will hit
Roman Penyaeva218cc42019-03-07 16:28:53 -0800847 * us during this operation. So we can avoid the lock on "ep->lock".
Eric Wongddf676c2013-04-30 15:27:40 -0700848 * We do not need to lock ep->mtx, either, we only do it to prevent
849 * a lockdep warning.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850 */
Eric Wongddf676c2013-04-30 15:27:40 -0700851 mutex_lock(&ep->mtx);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700852 while ((rbp = rb_first_cached(&ep->rbr)) != NULL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853 epi = rb_entry(rbp, struct epitem, rbn);
854 ep_remove(ep, epi);
Eric Dumazet91cf5ab2013-09-11 14:24:06 -0700855 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856 }
Eric Wongddf676c2013-04-30 15:27:40 -0700857 mutex_unlock(&ep->mtx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858
Arjan van de Ven144efe32006-03-23 03:00:32 -0800859 mutex_unlock(&epmutex);
Davide Libenzid47de162007-05-15 01:40:41 -0700860 mutex_destroy(&ep->mtx);
Davide Libenzi7ef99642008-12-01 13:13:55 -0800861 free_uid(ep->user);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200862 wakeup_source_unregister(ep->ws);
Davide Libenzif0ee9aa2007-05-15 01:40:57 -0700863 kfree(ep);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864}
865
Davide Libenzi7699acd2007-05-10 22:23:23 -0700866static int ep_eventpoll_release(struct inode *inode, struct file *file)
867{
868 struct eventpoll *ep = file->private_data;
869
Davide Libenzif0ee9aa2007-05-15 01:40:57 -0700870 if (ep)
Davide Libenzi7699acd2007-05-10 22:23:23 -0700871 ep_free(ep);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700872
Davide Libenzi7699acd2007-05-10 22:23:23 -0700873 return 0;
874}
875
Al Virod85e2aa2018-02-01 15:24:58 -0500876static __poll_t ep_read_events_proc(struct eventpoll *ep, struct list_head *head,
Jason Baron37b5e522017-11-17 15:29:06 -0800877 void *priv);
878static void ep_ptable_queue_proc(struct file *file, wait_queue_head_t *whead,
879 poll_table *pt);
Eric Wong450d89e2013-04-30 15:27:42 -0700880
Jason Baron37b5e522017-11-17 15:29:06 -0800881/*
882 * Differs from ep_eventpoll_poll() in that internal callers already have
883 * the ep->mtx so we need to start from depth=1, such that mutex_lock_nested()
884 * is correctly annotated.
885 */
Al Virod85e2aa2018-02-01 15:24:58 -0500886static __poll_t ep_item_poll(const struct epitem *epi, poll_table *pt,
Al Virobec1a5022017-11-28 19:43:33 -0500887 int depth)
Jason Baron37b5e522017-11-17 15:29:06 -0800888{
889 struct eventpoll *ep;
890 bool locked;
891
892 pt->_key = epi->event.events;
893 if (!is_file_epoll(epi->ffd.file))
Christoph Hellwig9965ed172018-03-05 07:26:05 -0800894 return vfs_poll(epi->ffd.file, pt) & epi->event.events;
Jason Baron37b5e522017-11-17 15:29:06 -0800895
896 ep = epi->ffd.file->private_data;
897 poll_wait(epi->ffd.file, &ep->poll_wait, pt);
898 locked = pt && (pt->_qproc == ep_ptable_queue_proc);
899
900 return ep_scan_ready_list(epi->ffd.file->private_data,
901 ep_read_events_proc, &depth, depth,
902 locked) & epi->event.events;
Eric Wong450d89e2013-04-30 15:27:42 -0700903}
904
Al Virod85e2aa2018-02-01 15:24:58 -0500905static __poll_t ep_read_events_proc(struct eventpoll *ep, struct list_head *head,
Davide Libenzi296e2362009-03-31 15:24:11 -0700906 void *priv)
Davide Libenzi5071f972009-03-31 15:24:10 -0700907{
908 struct epitem *epi, *tmp;
Hans Verkuil626cf232012-03-23 15:02:27 -0700909 poll_table pt;
Jason Baron37b5e522017-11-17 15:29:06 -0800910 int depth = *(int *)priv;
Davide Libenzi5071f972009-03-31 15:24:10 -0700911
Hans Verkuil626cf232012-03-23 15:02:27 -0700912 init_poll_funcptr(&pt, NULL);
Jason Baron37b5e522017-11-17 15:29:06 -0800913 depth++;
Eric Wong450d89e2013-04-30 15:27:42 -0700914
Davide Libenzi5071f972009-03-31 15:24:10 -0700915 list_for_each_entry_safe(epi, tmp, head, rdllink) {
Jason Baron37b5e522017-11-17 15:29:06 -0800916 if (ep_item_poll(epi, &pt, depth)) {
Linus Torvaldsa9a08842018-02-11 14:34:03 -0800917 return EPOLLIN | EPOLLRDNORM;
Jason Baron37b5e522017-11-17 15:29:06 -0800918 } else {
Davide Libenzi5071f972009-03-31 15:24:10 -0700919 /*
920 * Item has been dropped into the ready list by the poll
921 * callback, but it's not actually ready, as far as
922 * caller requested events goes. We can remove it here.
923 */
Eric Wongeea1d582013-04-30 15:27:39 -0700924 __pm_relax(ep_wakeup_source(epi));
Davide Libenzi5071f972009-03-31 15:24:10 -0700925 list_del_init(&epi->rdllink);
Davide Libenzi296e2362009-03-31 15:24:11 -0700926 }
Davide Libenzi5071f972009-03-31 15:24:10 -0700927 }
928
929 return 0;
930}
931
Linus Torvaldsa11e1d42018-06-28 09:43:44 -0700932static __poll_t ep_eventpoll_poll(struct file *file, poll_table *wait)
Davide Libenzi7699acd2007-05-10 22:23:23 -0700933{
Davide Libenzi7699acd2007-05-10 22:23:23 -0700934 struct eventpoll *ep = file->private_data;
Jason Baron37b5e522017-11-17 15:29:06 -0800935 int depth = 0;
Davide Libenzi7699acd2007-05-10 22:23:23 -0700936
Linus Torvaldsa11e1d42018-06-28 09:43:44 -0700937 /* Insert inside our poll wait queue */
938 poll_wait(file, &ep->poll_wait, wait);
939
Davide Libenzi5071f972009-03-31 15:24:10 -0700940 /*
941 * Proceed to find out if wanted events are really available inside
Jason Baron37b5e522017-11-17 15:29:06 -0800942 * the ready list.
Davide Libenzi5071f972009-03-31 15:24:10 -0700943 */
Jason Baron37b5e522017-11-17 15:29:06 -0800944 return ep_scan_ready_list(ep, ep_read_events_proc,
945 &depth, depth, false);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700946}
947
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800948#ifdef CONFIG_PROC_FS
Joe Perchesa3816ab2014-09-29 16:08:25 -0700949static void ep_show_fdinfo(struct seq_file *m, struct file *f)
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800950{
951 struct eventpoll *ep = f->private_data;
952 struct rb_node *rbp;
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800953
954 mutex_lock(&ep->mtx);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700955 for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) {
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800956 struct epitem *epi = rb_entry(rbp, struct epitem, rbn);
Cyrill Gorcunov77493f02017-07-12 14:34:25 -0700957 struct inode *inode = file_inode(epi->ffd.file);
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800958
Cyrill Gorcunov77493f02017-07-12 14:34:25 -0700959 seq_printf(m, "tfd: %8d events: %8x data: %16llx "
960 " pos:%lli ino:%lx sdev:%x\n",
Joe Perchesa3816ab2014-09-29 16:08:25 -0700961 epi->ffd.fd, epi->event.events,
Cyrill Gorcunov77493f02017-07-12 14:34:25 -0700962 (long long)epi->event.data,
963 (long long)epi->ffd.file->f_pos,
964 inode->i_ino, inode->i_sb->s_dev);
Joe Perchesa3816ab2014-09-29 16:08:25 -0700965 if (seq_has_overflowed(m))
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800966 break;
967 }
968 mutex_unlock(&ep->mtx);
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800969}
970#endif
971
Davide Libenzi7699acd2007-05-10 22:23:23 -0700972/* File callbacks that implement the eventpoll file behaviour */
973static const struct file_operations eventpoll_fops = {
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800974#ifdef CONFIG_PROC_FS
975 .show_fdinfo = ep_show_fdinfo,
976#endif
Davide Libenzi7699acd2007-05-10 22:23:23 -0700977 .release = ep_eventpoll_release,
Linus Torvaldsa11e1d42018-06-28 09:43:44 -0700978 .poll = ep_eventpoll_poll,
Arnd Bergmann6038f372010-08-15 18:52:59 +0200979 .llseek = noop_llseek,
Davide Libenzi7699acd2007-05-10 22:23:23 -0700980};
981
Davide Libenzi7699acd2007-05-10 22:23:23 -0700982/*
983 * This is called from eventpoll_release() to unlink files from the eventpoll
984 * interface. We need to have this facility to cleanup correctly files that are
985 * closed without being removed from the eventpoll interface.
986 */
987void eventpoll_release_file(struct file *file)
988{
Davide Libenzi7699acd2007-05-10 22:23:23 -0700989 struct eventpoll *ep;
Konstantin Khlebnikovebe06182014-06-17 06:58:05 +0400990 struct epitem *epi, *next;
Davide Libenzi7699acd2007-05-10 22:23:23 -0700991
992 /*
Jonathan Corbet68499912009-02-06 13:52:43 -0700993 * We don't want to get "file->f_lock" because it is not
Davide Libenzi7699acd2007-05-10 22:23:23 -0700994 * necessary. It is not necessary because we're in the "struct file"
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300995 * cleanup path, and this means that no one is using this file anymore.
Davide Libenzi5071f972009-03-31 15:24:10 -0700996 * So, for example, epoll_ctl() cannot hit here since if we reach this
Davide Libenzi67647d02007-05-15 01:40:52 -0700997 * point, the file counter already went to zero and fget() would fail.
Davide Libenzid47de162007-05-15 01:40:41 -0700998 * The only hit might come from ep_free() but by holding the mutex
Davide Libenzi7699acd2007-05-10 22:23:23 -0700999 * will correctly serialize the operation. We do need to acquire
Davide Libenzid47de162007-05-15 01:40:41 -07001000 * "ep->mtx" after "epmutex" because ep_remove() requires it when called
Davide Libenzi7699acd2007-05-10 22:23:23 -07001001 * from anywhere but ep_free().
Jonathan Corbet68499912009-02-06 13:52:43 -07001002 *
1003 * Besides, ep_remove() acquires the lock, so we can't hold it here.
Davide Libenzi7699acd2007-05-10 22:23:23 -07001004 */
1005 mutex_lock(&epmutex);
Konstantin Khlebnikovebe06182014-06-17 06:58:05 +04001006 list_for_each_entry_safe(epi, next, &file->f_ep_links, fllink) {
Davide Libenzi7699acd2007-05-10 22:23:23 -07001007 ep = epi->ep;
Nelson Elhaged8805e62011-10-31 17:13:14 -07001008 mutex_lock_nested(&ep->mtx, 0);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001009 ep_remove(ep, epi);
Davide Libenzid47de162007-05-15 01:40:41 -07001010 mutex_unlock(&ep->mtx);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001011 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07001012 mutex_unlock(&epmutex);
1013}
1014
1015static int ep_alloc(struct eventpoll **pep)
1016{
Davide Libenzi7ef99642008-12-01 13:13:55 -08001017 int error;
1018 struct user_struct *user;
1019 struct eventpoll *ep;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001020
Davide Libenzi7ef99642008-12-01 13:13:55 -08001021 user = get_current_user();
Davide Libenzi7ef99642008-12-01 13:13:55 -08001022 error = -ENOMEM;
1023 ep = kzalloc(sizeof(*ep), GFP_KERNEL);
1024 if (unlikely(!ep))
1025 goto free_uid;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001026
Davide Libenzid47de162007-05-15 01:40:41 -07001027 mutex_init(&ep->mtx);
Roman Penyaeva218cc42019-03-07 16:28:53 -08001028 rwlock_init(&ep->lock);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001029 init_waitqueue_head(&ep->wq);
1030 init_waitqueue_head(&ep->poll_wait);
1031 INIT_LIST_HEAD(&ep->rdllist);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001032 ep->rbr = RB_ROOT_CACHED;
Davide Libenzid47de162007-05-15 01:40:41 -07001033 ep->ovflist = EP_UNACTIVE_PTR;
Davide Libenzi7ef99642008-12-01 13:13:55 -08001034 ep->user = user;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001035
1036 *pep = ep;
1037
Davide Libenzi7699acd2007-05-10 22:23:23 -07001038 return 0;
Davide Libenzi7ef99642008-12-01 13:13:55 -08001039
1040free_uid:
1041 free_uid(user);
1042 return error;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001043}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001044
1045/*
Davide Libenzic7ea7632007-05-15 01:40:47 -07001046 * Search the file inside the eventpoll tree. The RB tree operations
1047 * are protected by the "mtx" mutex, and ep_find() must be called with
1048 * "mtx" held.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001049 */
1050static struct epitem *ep_find(struct eventpoll *ep, struct file *file, int fd)
1051{
1052 int kcmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001053 struct rb_node *rbp;
1054 struct epitem *epi, *epir = NULL;
1055 struct epoll_filefd ffd;
1056
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001057 ep_set_ffd(&ffd, file, fd);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001058 for (rbp = ep->rbr.rb_root.rb_node; rbp; ) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001059 epi = rb_entry(rbp, struct epitem, rbn);
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001060 kcmp = ep_cmp_ffd(&ffd, &epi->ffd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001061 if (kcmp > 0)
1062 rbp = rbp->rb_right;
1063 else if (kcmp < 0)
1064 rbp = rbp->rb_left;
1065 else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066 epir = epi;
1067 break;
1068 }
1069 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001070
Linus Torvalds1da177e2005-04-16 15:20:36 -07001071 return epir;
1072}
1073
Chris Wilson1ea36022021-02-05 22:00:12 +00001074#ifdef CONFIG_KCMP
Cyrill Gorcunov0791e362017-07-12 14:34:28 -07001075static struct epitem *ep_find_tfd(struct eventpoll *ep, int tfd, unsigned long toff)
1076{
1077 struct rb_node *rbp;
1078 struct epitem *epi;
1079
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001080 for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) {
Cyrill Gorcunov0791e362017-07-12 14:34:28 -07001081 epi = rb_entry(rbp, struct epitem, rbn);
1082 if (epi->ffd.fd == tfd) {
1083 if (toff == 0)
1084 return epi;
1085 else
1086 toff--;
1087 }
1088 cond_resched();
1089 }
1090
1091 return NULL;
1092}
1093
1094struct file *get_epoll_tfile_raw_ptr(struct file *file, int tfd,
1095 unsigned long toff)
1096{
1097 struct file *file_raw;
1098 struct eventpoll *ep;
1099 struct epitem *epi;
1100
1101 if (!is_file_epoll(file))
1102 return ERR_PTR(-EINVAL);
1103
1104 ep = file->private_data;
1105
1106 mutex_lock(&ep->mtx);
1107 epi = ep_find_tfd(ep, tfd, toff);
1108 if (epi)
1109 file_raw = epi->ffd.file;
1110 else
1111 file_raw = ERR_PTR(-ENOENT);
1112 mutex_unlock(&ep->mtx);
1113
1114 return file_raw;
1115}
Chris Wilson1ea36022021-02-05 22:00:12 +00001116#endif /* CONFIG_KCMP */
Cyrill Gorcunov0791e362017-07-12 14:34:28 -07001117
Roman Penyaeva218cc42019-03-07 16:28:53 -08001118/**
1119 * Adds a new entry to the tail of the list in a lockless way, i.e.
1120 * multiple CPUs are allowed to call this function concurrently.
1121 *
1122 * Beware: it is necessary to prevent any other modifications of the
1123 * existing list until all changes are completed, in other words
1124 * concurrent list_add_tail_lockless() calls should be protected
1125 * with a read lock, where write lock acts as a barrier which
1126 * makes sure all list_add_tail_lockless() calls are fully
1127 * completed.
1128 *
1129 * Also an element can be locklessly added to the list only in one
1130 * direction i.e. either to the tail either to the head, otherwise
1131 * concurrent access will corrupt the list.
1132 *
1133 * Returns %false if element has been already added to the list, %true
1134 * otherwise.
1135 */
1136static inline bool list_add_tail_lockless(struct list_head *new,
1137 struct list_head *head)
1138{
1139 struct list_head *prev;
1140
1141 /*
1142 * This is simple 'new->next = head' operation, but cmpxchg()
1143 * is used in order to detect that same element has been just
1144 * added to the list from another CPU: the winner observes
1145 * new->next == new.
1146 */
1147 if (cmpxchg(&new->next, new, head) != new)
1148 return false;
1149
1150 /*
1151 * Initially ->next of a new element must be updated with the head
1152 * (we are inserting to the tail) and only then pointers are atomically
1153 * exchanged. XCHG guarantees memory ordering, thus ->next should be
1154 * updated before pointers are actually swapped and pointers are
1155 * swapped before prev->next is updated.
1156 */
1157
1158 prev = xchg(&head->prev, new);
1159
1160 /*
1161 * It is safe to modify prev->next and new->prev, because a new element
1162 * is added only to the tail and new->next is updated before XCHG.
1163 */
1164
1165 prev->next = new;
1166 new->prev = prev;
1167
1168 return true;
1169}
1170
1171/**
1172 * Chains a new epi entry to the tail of the ep->ovflist in a lockless way,
1173 * i.e. multiple CPUs are allowed to call this function concurrently.
1174 *
1175 * Returns %false if epi element has been already chained, %true otherwise.
1176 */
1177static inline bool chain_epi_lockless(struct epitem *epi)
1178{
1179 struct eventpoll *ep = epi->ep;
1180
Khazhismel Kumykov0c54a6a2020-05-07 18:35:59 -07001181 /* Fast preliminary check */
1182 if (epi->next != EP_UNACTIVE_PTR)
1183 return false;
1184
Roman Penyaeva218cc42019-03-07 16:28:53 -08001185 /* Check that the same epi has not been just chained from another CPU */
1186 if (cmpxchg(&epi->next, EP_UNACTIVE_PTR, NULL) != EP_UNACTIVE_PTR)
1187 return false;
1188
1189 /* Atomically exchange tail */
1190 epi->next = xchg(&ep->ovflist, epi);
1191
1192 return true;
1193}
1194
Linus Torvalds1da177e2005-04-16 15:20:36 -07001195/*
Davide Libenzi7699acd2007-05-10 22:23:23 -07001196 * This is the callback that is passed to the wait queue wakeup
Daniel Balutabf6a41d2011-01-30 23:42:29 +02001197 * mechanism. It is called by the stored file descriptors when they
Davide Libenzi7699acd2007-05-10 22:23:23 -07001198 * have events to report.
Roman Penyaeva218cc42019-03-07 16:28:53 -08001199 *
1200 * This callback takes a read lock in order not to content with concurrent
1201 * events from another file descriptors, thus all modifications to ->rdllist
1202 * or ->ovflist are lockless. Read lock is paired with the write lock from
1203 * ep_scan_ready_list(), which stops all list modifications and guarantees
1204 * that lists state is seen correctly.
1205 *
1206 * Another thing worth to mention is that ep_poll_callback() can be called
1207 * concurrently for the same @epi from different CPUs if poll table was inited
1208 * with several wait queues entries. Plural wakeup from different CPUs of a
1209 * single wait queue is serialized by wq.lock, but the case when multiple wait
1210 * queues are used should be detected accordingly. This is detected using
1211 * cmpxchg() operation.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001212 */
Ingo Molnarac6424b2017-06-20 12:06:13 +02001213static int ep_poll_callback(wait_queue_entry_t *wait, unsigned mode, int sync, void *key)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001214{
Davide Libenzi7699acd2007-05-10 22:23:23 -07001215 int pwake = 0;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001216 struct epitem *epi = ep_item_from_wait(wait);
1217 struct eventpoll *ep = epi->ep;
Al Viro3ad6f932017-07-03 20:14:56 -04001218 __poll_t pollflags = key_to_poll(key);
Roman Penyaeva218cc42019-03-07 16:28:53 -08001219 unsigned long flags;
Jason Barondf0108c2016-01-20 14:59:24 -08001220 int ewake = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001221
Roman Penyaeva218cc42019-03-07 16:28:53 -08001222 read_lock_irqsave(&ep->lock, flags);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001223
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -07001224 ep_set_busy_poll_napi_id(epi);
1225
Davide Libenzi7699acd2007-05-10 22:23:23 -07001226 /*
1227 * If the event mask does not contain any poll(2) event, we consider the
1228 * descriptor to be disabled. This condition is likely the effect of the
1229 * EPOLLONESHOT bit that disables the descriptor when an event is received,
1230 * until the next EPOLL_CTL_MOD will be issued.
1231 */
1232 if (!(epi->event.events & ~EP_PRIVATE_BITS))
Davide Libenzid47de162007-05-15 01:40:41 -07001233 goto out_unlock;
1234
1235 /*
Davide Libenzi2dfa4ee2009-03-31 15:24:22 -07001236 * Check the events coming with the callback. At this stage, not
1237 * every device reports the events in the "key" parameter of the
1238 * callback. We need to be able to handle both cases here, hence the
1239 * test for "key" != NULL before the event match test.
1240 */
Al Viro3ad6f932017-07-03 20:14:56 -04001241 if (pollflags && !(pollflags & epi->event.events))
Davide Libenzi2dfa4ee2009-03-31 15:24:22 -07001242 goto out_unlock;
1243
1244 /*
Daniel Balutabf6a41d2011-01-30 23:42:29 +02001245 * If we are transferring events to userspace, we can hold no locks
Davide Libenzid47de162007-05-15 01:40:41 -07001246 * (because we're accessing user memory, and because of linux f_op->poll()
Daniel Balutabf6a41d2011-01-30 23:42:29 +02001247 * semantics). All the events that happen during that period of time are
Davide Libenzid47de162007-05-15 01:40:41 -07001248 * chained in ep->ovflist and requeued later on.
1249 */
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001250 if (READ_ONCE(ep->ovflist) != EP_UNACTIVE_PTR) {
Khazhismel Kumykov0c54a6a2020-05-07 18:35:59 -07001251 if (chain_epi_lockless(epi))
Roman Penyaevc3e320b2019-03-07 16:28:49 -08001252 ep_pm_stay_awake_rcu(epi);
Khazhismel Kumykov0c54a6a2020-05-07 18:35:59 -07001253 } else if (!ep_is_linked(epi)) {
1254 /* In the usual case, add event to ready list. */
1255 if (list_add_tail_lockless(&epi->rdllink, &ep->rdllist))
1256 ep_pm_stay_awake_rcu(epi);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001257 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07001258
Davide Libenzi7699acd2007-05-10 22:23:23 -07001259 /*
1260 * Wake up ( if active ) both the eventpoll wait list and the ->poll()
1261 * wait list.
1262 */
Jason Barondf0108c2016-01-20 14:59:24 -08001263 if (waitqueue_active(&ep->wq)) {
Jason Baronb6a515c2016-02-05 15:37:04 -08001264 if ((epi->event.events & EPOLLEXCLUSIVE) &&
Al Viro3ad6f932017-07-03 20:14:56 -04001265 !(pollflags & POLLFREE)) {
1266 switch (pollflags & EPOLLINOUT_BITS) {
Linus Torvaldsa9a08842018-02-11 14:34:03 -08001267 case EPOLLIN:
1268 if (epi->event.events & EPOLLIN)
Jason Baronb6a515c2016-02-05 15:37:04 -08001269 ewake = 1;
1270 break;
Linus Torvaldsa9a08842018-02-11 14:34:03 -08001271 case EPOLLOUT:
1272 if (epi->event.events & EPOLLOUT)
Jason Baronb6a515c2016-02-05 15:37:04 -08001273 ewake = 1;
1274 break;
1275 case 0:
1276 ewake = 1;
1277 break;
1278 }
1279 }
Roman Penyaeva218cc42019-03-07 16:28:53 -08001280 wake_up(&ep->wq);
Jason Barondf0108c2016-01-20 14:59:24 -08001281 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07001282 if (waitqueue_active(&ep->poll_wait))
1283 pwake++;
1284
Davide Libenzid47de162007-05-15 01:40:41 -07001285out_unlock:
Roman Penyaeva218cc42019-03-07 16:28:53 -08001286 read_unlock_irqrestore(&ep->lock, flags);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001287
1288 /* We have to call this outside the lock */
1289 if (pwake)
Jason Baronefcdd352020-04-06 20:11:23 -07001290 ep_poll_safewake(ep, epi);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001291
Oleg Nesterov138e4ad2017-09-01 18:55:33 +02001292 if (!(epi->event.events & EPOLLEXCLUSIVE))
1293 ewake = 1;
Jason Barondf0108c2016-01-20 14:59:24 -08001294
Al Viro3ad6f932017-07-03 20:14:56 -04001295 if (pollflags & POLLFREE) {
Oleg Nesterov138e4ad2017-09-01 18:55:33 +02001296 /*
1297 * If we race with ep_remove_wait_queue() it can miss
1298 * ->whead = NULL and do another remove_wait_queue() after
1299 * us, so we can't use __remove_wait_queue().
1300 */
1301 list_del_init(&wait->entry);
1302 /*
1303 * ->whead != NULL protects us from the race with ep_free()
1304 * or ep_remove(), ep_remove_wait_queue() takes whead->lock
1305 * held by the caller. Once we nullify it, nothing protects
1306 * ep/epi or even wait.
1307 */
1308 smp_store_release(&ep_pwq_from_wait(wait)->whead, NULL);
1309 }
1310
1311 return ewake;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001312}
1313
Linus Torvalds1da177e2005-04-16 15:20:36 -07001314/*
1315 * This is the callback that is used to add our wait queue to the
1316 * target file wakeup lists.
1317 */
1318static void ep_ptable_queue_proc(struct file *file, wait_queue_head_t *whead,
1319 poll_table *pt)
1320{
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001321 struct epitem *epi = ep_item_from_epqueue(pt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001322 struct eppoll_entry *pwq;
1323
Christoph Lametere94b1762006-12-06 20:33:17 -08001324 if (epi->nwait >= 0 && (pwq = kmem_cache_alloc(pwq_cache, GFP_KERNEL))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325 init_waitqueue_func_entry(&pwq->wait, ep_poll_callback);
1326 pwq->whead = whead;
1327 pwq->base = epi;
Jason Barondf0108c2016-01-20 14:59:24 -08001328 if (epi->event.events & EPOLLEXCLUSIVE)
1329 add_wait_queue_exclusive(whead, &pwq->wait);
1330 else
1331 add_wait_queue(whead, &pwq->wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001332 list_add_tail(&pwq->llink, &epi->pwqlist);
1333 epi->nwait++;
Davide Libenzi296e2362009-03-31 15:24:11 -07001334 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001335 /* We have to signal that an error occurred */
1336 epi->nwait = -1;
Davide Libenzi296e2362009-03-31 15:24:11 -07001337 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338}
1339
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340static void ep_rbtree_insert(struct eventpoll *ep, struct epitem *epi)
1341{
1342 int kcmp;
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001343 struct rb_node **p = &ep->rbr.rb_root.rb_node, *parent = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001344 struct epitem *epic;
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001345 bool leftmost = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001346
1347 while (*p) {
1348 parent = *p;
1349 epic = rb_entry(parent, struct epitem, rbn);
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001350 kcmp = ep_cmp_ffd(&epi->ffd, &epic->ffd);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001351 if (kcmp > 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352 p = &parent->rb_right;
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001353 leftmost = false;
1354 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355 p = &parent->rb_left;
1356 }
1357 rb_link_node(&epi->rbn, parent, p);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001358 rb_insert_color_cached(&epi->rbn, &ep->rbr, leftmost);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001359}
1360
Andrew Mortona80a6b82012-11-08 15:53:35 -08001361
1362
Jason Baron28d82dc2012-01-12 17:17:43 -08001363#define PATH_ARR_SIZE 5
1364/*
1365 * These are the number paths of length 1 to 5, that we are allowing to emanate
1366 * from a single file of interest. For example, we allow 1000 paths of length
1367 * 1, to emanate from each file of interest. This essentially represents the
1368 * potential wakeup paths, which need to be limited in order to avoid massive
1369 * uncontrolled wakeup storms. The common use case should be a single ep which
1370 * is connected to n file sources. In this case each file source has 1 path
1371 * of length 1. Thus, the numbers below should be more than sufficient. These
1372 * path limits are enforced during an EPOLL_CTL_ADD operation, since a modify
1373 * and delete can't add additional paths. Protected by the epmutex.
1374 */
1375static const int path_limits[PATH_ARR_SIZE] = { 1000, 500, 100, 50, 10 };
1376static int path_count[PATH_ARR_SIZE];
1377
1378static int path_count_inc(int nests)
1379{
Jason Baron93dc6102012-03-16 16:34:03 -04001380 /* Allow an arbitrary number of depth 1 paths */
1381 if (nests == 0)
1382 return 0;
1383
Jason Baron28d82dc2012-01-12 17:17:43 -08001384 if (++path_count[nests] > path_limits[nests])
1385 return -1;
1386 return 0;
1387}
1388
1389static void path_count_init(void)
1390{
1391 int i;
1392
1393 for (i = 0; i < PATH_ARR_SIZE; i++)
1394 path_count[i] = 0;
1395}
1396
1397static int reverse_path_check_proc(void *priv, void *cookie, int call_nests)
1398{
1399 int error = 0;
1400 struct file *file = priv;
1401 struct file *child_file;
1402 struct epitem *epi;
1403
Jason Baronae10b2b2013-11-12 15:10:16 -08001404 /* CTL_DEL can remove links here, but that can't increase our count */
1405 rcu_read_lock();
1406 list_for_each_entry_rcu(epi, &file->f_ep_links, fllink) {
Jason Baron28d82dc2012-01-12 17:17:43 -08001407 child_file = epi->ep->file;
1408 if (is_file_epoll(child_file)) {
1409 if (list_empty(&child_file->f_ep_links)) {
1410 if (path_count_inc(call_nests)) {
1411 error = -1;
1412 break;
1413 }
1414 } else {
1415 error = ep_call_nested(&poll_loop_ncalls,
Jason Baron28d82dc2012-01-12 17:17:43 -08001416 reverse_path_check_proc,
1417 child_file, child_file,
1418 current);
1419 }
1420 if (error != 0)
1421 break;
1422 } else {
1423 printk(KERN_ERR "reverse_path_check_proc: "
1424 "file is not an ep!\n");
1425 }
1426 }
Jason Baronae10b2b2013-11-12 15:10:16 -08001427 rcu_read_unlock();
Jason Baron28d82dc2012-01-12 17:17:43 -08001428 return error;
1429}
1430
1431/**
1432 * reverse_path_check - The tfile_check_list is list of file *, which have
1433 * links that are proposed to be newly added. We need to
1434 * make sure that those added links don't add too many
1435 * paths such that we will spend all our time waking up
1436 * eventpoll objects.
1437 *
1438 * Returns: Returns zero if the proposed links don't create too many paths,
1439 * -1 otherwise.
1440 */
1441static int reverse_path_check(void)
1442{
Jason Baron28d82dc2012-01-12 17:17:43 -08001443 int error = 0;
1444 struct file *current_file;
1445
1446 /* let's call this for all tfiles */
1447 list_for_each_entry(current_file, &tfile_check_list, f_tfile_llink) {
Jason Baron28d82dc2012-01-12 17:17:43 -08001448 path_count_init();
Davidlohr Bueso74bdc122019-01-03 15:27:02 -08001449 error = ep_call_nested(&poll_loop_ncalls,
Jason Baron28d82dc2012-01-12 17:17:43 -08001450 reverse_path_check_proc, current_file,
1451 current_file, current);
1452 if (error)
1453 break;
1454 }
1455 return error;
1456}
1457
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001458static int ep_create_wakeup_source(struct epitem *epi)
1459{
Al Viro3701cb52020-09-24 19:41:58 -04001460 struct name_snapshot n;
Eric Wongeea1d582013-04-30 15:27:39 -07001461 struct wakeup_source *ws;
Manish Varma0ff110f2021-03-15 21:40:24 -07001462 char ws_name[64];
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001463
Manish Varma0ff110f2021-03-15 21:40:24 -07001464 strlcpy(ws_name, "eventpoll", sizeof(ws_name));
1465 trace_android_vh_ep_create_wakeup_source(ws_name, sizeof(ws_name));
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001466 if (!epi->ep->ws) {
Manish Varma0ff110f2021-03-15 21:40:24 -07001467 epi->ep->ws = wakeup_source_register(NULL, ws_name);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001468 if (!epi->ep->ws)
1469 return -ENOMEM;
1470 }
1471
Al Viro3701cb52020-09-24 19:41:58 -04001472 take_dentry_name_snapshot(&n, epi->ffd.file->f_path.dentry);
Manish Varma0ff110f2021-03-15 21:40:24 -07001473 strlcpy(ws_name, n.name.name, sizeof(ws_name));
1474 trace_android_vh_ep_create_wakeup_source(ws_name, sizeof(ws_name));
1475 ws = wakeup_source_register(NULL, ws_name);
Al Viro3701cb52020-09-24 19:41:58 -04001476 release_dentry_name_snapshot(&n);
Eric Wongeea1d582013-04-30 15:27:39 -07001477
1478 if (!ws)
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001479 return -ENOMEM;
Eric Wongeea1d582013-04-30 15:27:39 -07001480 rcu_assign_pointer(epi->ws, ws);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001481
1482 return 0;
1483}
1484
Eric Wongeea1d582013-04-30 15:27:39 -07001485/* rare code path, only used when EPOLL_CTL_MOD removes a wakeup source */
1486static noinline void ep_destroy_wakeup_source(struct epitem *epi)
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001487{
Eric Wongeea1d582013-04-30 15:27:39 -07001488 struct wakeup_source *ws = ep_wakeup_source(epi);
1489
Eric Wongd6d67e72013-04-30 15:27:43 -07001490 RCU_INIT_POINTER(epi->ws, NULL);
Eric Wongeea1d582013-04-30 15:27:39 -07001491
1492 /*
1493 * wait for ep_pm_stay_awake_rcu to finish, synchronize_rcu is
1494 * used internally by wakeup_source_remove, too (called by
1495 * wakeup_source_unregister), so we cannot use call_rcu
1496 */
1497 synchronize_rcu();
1498 wakeup_source_unregister(ws);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001499}
1500
Davide Libenzic7ea7632007-05-15 01:40:47 -07001501/*
1502 * Must be called with "mtx" held.
1503 */
Al Virobec1a5022017-11-28 19:43:33 -05001504static int ep_insert(struct eventpoll *ep, const struct epoll_event *event,
Jason Baron67347fe2013-11-12 15:10:18 -08001505 struct file *tfile, int fd, int full_check)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001506{
Al Virod85e2aa2018-02-01 15:24:58 -05001507 int error, pwake = 0;
1508 __poll_t revents;
Robin Holt52bd19f72011-01-12 17:00:01 -08001509 long user_watches;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001510 struct epitem *epi;
1511 struct ep_pqueue epq;
1512
Davidlohr Bueso92e64172018-08-21 21:56:45 -07001513 lockdep_assert_irqs_enabled();
1514
Robin Holt52bd19f72011-01-12 17:00:01 -08001515 user_watches = atomic_long_read(&ep->user->epoll_watches);
1516 if (unlikely(user_watches >= max_user_watches))
Davide Libenzi7ef99642008-12-01 13:13:55 -08001517 return -ENOSPC;
Christoph Lametere94b1762006-12-06 20:33:17 -08001518 if (!(epi = kmem_cache_alloc(epi_cache, GFP_KERNEL)))
Davide Libenzi7ef99642008-12-01 13:13:55 -08001519 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001520
1521 /* Item initialization follow here ... */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001522 INIT_LIST_HEAD(&epi->rdllink);
1523 INIT_LIST_HEAD(&epi->fllink);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524 INIT_LIST_HEAD(&epi->pwqlist);
1525 epi->ep = ep;
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001526 ep_set_ffd(&epi->ffd, tfile, fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001527 epi->event = *event;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001528 epi->nwait = 0;
Davide Libenzid47de162007-05-15 01:40:41 -07001529 epi->next = EP_UNACTIVE_PTR;
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001530 if (epi->event.events & EPOLLWAKEUP) {
1531 error = ep_create_wakeup_source(epi);
1532 if (error)
1533 goto error_create_wakeup_source;
1534 } else {
Eric Wongeea1d582013-04-30 15:27:39 -07001535 RCU_INIT_POINTER(epi->ws, NULL);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001536 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001537
Al Virof8d4f442020-09-09 22:25:06 -04001538 /* Add the current item to the list of active epoll hook for this file */
1539 spin_lock(&tfile->f_lock);
1540 list_add_tail_rcu(&epi->fllink, &tfile->f_ep_links);
1541 spin_unlock(&tfile->f_lock);
1542
1543 /*
1544 * Add the current item to the RB tree. All RB tree operations are
1545 * protected by "mtx", and ep_insert() is called with "mtx" held.
1546 */
1547 ep_rbtree_insert(ep, epi);
1548
1549 /* now check if we've created too many backpaths */
1550 error = -EINVAL;
1551 if (full_check && reverse_path_check())
1552 goto error_remove_epi;
1553
Linus Torvalds1da177e2005-04-16 15:20:36 -07001554 /* Initialize the poll table using the queue callback */
1555 epq.epi = epi;
1556 init_poll_funcptr(&epq.pt, ep_ptable_queue_proc);
1557
1558 /*
1559 * Attach the item to the poll hooks and get current event bits.
1560 * We can safely use the file* here because its usage count has
Davide Libenzic7ea7632007-05-15 01:40:47 -07001561 * been increased by the caller of this function. Note that after
1562 * this operation completes, the poll callback can start hitting
1563 * the new item.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001564 */
Jason Baron37b5e522017-11-17 15:29:06 -08001565 revents = ep_item_poll(epi, &epq.pt, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001566
1567 /*
1568 * We have to check if something went wrong during the poll wait queue
1569 * install process. Namely an allocation for a wait queue failed due
1570 * high memory pressure.
1571 */
Davide Libenzi7ef99642008-12-01 13:13:55 -08001572 error = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573 if (epi->nwait < 0)
Davide Libenzi7699acd2007-05-10 22:23:23 -07001574 goto error_unregister;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001575
Davide Libenzic7ea7632007-05-15 01:40:47 -07001576 /* We have to drop the new item inside our item list to keep track of it */
Roman Penyaeva218cc42019-03-07 16:28:53 -08001577 write_lock_irq(&ep->lock);
Davide Libenzic7ea7632007-05-15 01:40:47 -07001578
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -07001579 /* record NAPI ID of new item if present */
1580 ep_set_busy_poll_napi_id(epi);
1581
Linus Torvalds1da177e2005-04-16 15:20:36 -07001582 /* If the file is already "ready" we drop it inside the ready list */
Davidlohr Bueso992991c2018-08-21 21:58:26 -07001583 if (revents && !ep_is_linked(epi)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001584 list_add_tail(&epi->rdllink, &ep->rdllist);
Eric Wongeea1d582013-04-30 15:27:39 -07001585 ep_pm_stay_awake(epi);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001586
1587 /* Notify waiting tasks that events are available */
1588 if (waitqueue_active(&ep->wq))
Roman Penyaeva218cc42019-03-07 16:28:53 -08001589 wake_up(&ep->wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001590 if (waitqueue_active(&ep->poll_wait))
1591 pwake++;
1592 }
1593
Roman Penyaeva218cc42019-03-07 16:28:53 -08001594 write_unlock_irq(&ep->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001595
Robin Holt52bd19f72011-01-12 17:00:01 -08001596 atomic_long_inc(&ep->user->epoll_watches);
Davide Libenzi7ef99642008-12-01 13:13:55 -08001597
Linus Torvalds1da177e2005-04-16 15:20:36 -07001598 /* We have to call this outside the lock */
1599 if (pwake)
Jason Baronefcdd352020-04-06 20:11:23 -07001600 ep_poll_safewake(ep, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001601
Linus Torvalds1da177e2005-04-16 15:20:36 -07001602 return 0;
1603
Al Virof8d4f442020-09-09 22:25:06 -04001604error_unregister:
1605 ep_unregister_pollwait(ep, epi);
Jason Baron28d82dc2012-01-12 17:17:43 -08001606error_remove_epi:
1607 spin_lock(&tfile->f_lock);
Jason Baronae10b2b2013-11-12 15:10:16 -08001608 list_del_rcu(&epi->fllink);
Jason Baron28d82dc2012-01-12 17:17:43 -08001609 spin_unlock(&tfile->f_lock);
1610
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001611 rb_erase_cached(&epi->rbn, &ep->rbr);
Jason Baron28d82dc2012-01-12 17:17:43 -08001612
Linus Torvalds1da177e2005-04-16 15:20:36 -07001613 /*
1614 * We need to do this because an event could have been arrived on some
Davide Libenzi67647d02007-05-15 01:40:52 -07001615 * allocated wait queue. Note that we don't care about the ep->ovflist
1616 * list, since that is used/cleaned only inside a section bound by "mtx".
1617 * And ep_insert() is called with "mtx" held.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618 */
Roman Penyaeva218cc42019-03-07 16:28:53 -08001619 write_lock_irq(&ep->lock);
Davidlohr Bueso992991c2018-08-21 21:58:26 -07001620 if (ep_is_linked(epi))
Davide Libenzi6192bd52007-05-08 00:25:41 -07001621 list_del_init(&epi->rdllink);
Roman Penyaeva218cc42019-03-07 16:28:53 -08001622 write_unlock_irq(&ep->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001623
Eric Wongeea1d582013-04-30 15:27:39 -07001624 wakeup_source_unregister(ep_wakeup_source(epi));
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001625
1626error_create_wakeup_source:
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001627 kmem_cache_free(epi_cache, epi);
Davide Libenzi7ef99642008-12-01 13:13:55 -08001628
Linus Torvalds1da177e2005-04-16 15:20:36 -07001629 return error;
1630}
1631
Linus Torvalds1da177e2005-04-16 15:20:36 -07001632/*
1633 * Modify the interest event mask by dropping an event if the new mask
Davide Libenzic7ea7632007-05-15 01:40:47 -07001634 * has a match in the current file status. Must be called with "mtx" held.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001635 */
Al Virobec1a5022017-11-28 19:43:33 -05001636static int ep_modify(struct eventpoll *ep, struct epitem *epi,
1637 const struct epoll_event *event)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638{
1639 int pwake = 0;
Hans Verkuil626cf232012-03-23 15:02:27 -07001640 poll_table pt;
1641
Davidlohr Bueso92e64172018-08-21 21:56:45 -07001642 lockdep_assert_irqs_enabled();
1643
Hans Verkuil626cf232012-03-23 15:02:27 -07001644 init_poll_funcptr(&pt, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645
1646 /*
Tony Battersbye057e152009-03-31 15:24:15 -07001647 * Set the new event interest mask before calling f_op->poll();
1648 * otherwise we might miss an event that happens between the
1649 * f_op->poll() call and the new event set registering.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650 */
Eric Wong128dd172013-01-01 21:20:27 +00001651 epi->event.events = event->events; /* need barrier below */
Tony Battersbye057e152009-03-31 15:24:15 -07001652 epi->event.data = event->data; /* protected by mtx */
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001653 if (epi->event.events & EPOLLWAKEUP) {
Eric Wongeea1d582013-04-30 15:27:39 -07001654 if (!ep_has_wakeup_source(epi))
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001655 ep_create_wakeup_source(epi);
Eric Wongeea1d582013-04-30 15:27:39 -07001656 } else if (ep_has_wakeup_source(epi)) {
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001657 ep_destroy_wakeup_source(epi);
1658 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001659
1660 /*
Eric Wong128dd172013-01-01 21:20:27 +00001661 * The following barrier has two effects:
1662 *
1663 * 1) Flush epi changes above to other CPUs. This ensures
1664 * we do not miss events from ep_poll_callback if an
1665 * event occurs immediately after we call f_op->poll().
Roman Penyaeva218cc42019-03-07 16:28:53 -08001666 * We need this because we did not take ep->lock while
Eric Wong128dd172013-01-01 21:20:27 +00001667 * changing epi above (but ep_poll_callback does take
Roman Penyaeva218cc42019-03-07 16:28:53 -08001668 * ep->lock).
Eric Wong128dd172013-01-01 21:20:27 +00001669 *
1670 * 2) We also need to ensure we do not miss _past_ events
1671 * when calling f_op->poll(). This barrier also
1672 * pairs with the barrier in wq_has_sleeper (see
1673 * comments for wq_has_sleeper).
1674 *
1675 * This barrier will now guarantee ep_poll_callback or f_op->poll
1676 * (or both) will notice the readiness of an item.
1677 */
1678 smp_mb();
1679
1680 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001681 * Get current event bits. We can safely use the file* here because
1682 * its usage count has been increased by the caller of this function.
Davide Libenzic7ea7632007-05-15 01:40:47 -07001683 * If the item is "hot" and it is not registered inside the ready
Davide Libenzi67647d02007-05-15 01:40:52 -07001684 * list, push it inside.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001685 */
Al Viro69112732017-11-28 19:56:15 -05001686 if (ep_item_poll(epi, &pt, 1)) {
Roman Penyaeva218cc42019-03-07 16:28:53 -08001687 write_lock_irq(&ep->lock);
Davidlohr Bueso992991c2018-08-21 21:58:26 -07001688 if (!ep_is_linked(epi)) {
Davide Libenzic7ea7632007-05-15 01:40:47 -07001689 list_add_tail(&epi->rdllink, &ep->rdllist);
Eric Wongeea1d582013-04-30 15:27:39 -07001690 ep_pm_stay_awake(epi);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001691
Davide Libenzic7ea7632007-05-15 01:40:47 -07001692 /* Notify waiting tasks that events are available */
1693 if (waitqueue_active(&ep->wq))
Roman Penyaeva218cc42019-03-07 16:28:53 -08001694 wake_up(&ep->wq);
Davide Libenzic7ea7632007-05-15 01:40:47 -07001695 if (waitqueue_active(&ep->poll_wait))
1696 pwake++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001697 }
Roman Penyaeva218cc42019-03-07 16:28:53 -08001698 write_unlock_irq(&ep->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001699 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001700
1701 /* We have to call this outside the lock */
1702 if (pwake)
Jason Baronefcdd352020-04-06 20:11:23 -07001703 ep_poll_safewake(ep, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001704
1705 return 0;
1706}
1707
Al Virod85e2aa2018-02-01 15:24:58 -05001708static __poll_t ep_send_events_proc(struct eventpoll *ep, struct list_head *head,
Davide Libenzi296e2362009-03-31 15:24:11 -07001709 void *priv)
Davide Libenzi5071f972009-03-31 15:24:10 -07001710{
1711 struct ep_send_events_data *esed = priv;
Al Virod85e2aa2018-02-01 15:24:58 -05001712 __poll_t revents;
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001713 struct epitem *epi, *tmp;
1714 struct epoll_event __user *uevent = esed->events;
Eric Wongeea1d582013-04-30 15:27:39 -07001715 struct wakeup_source *ws;
Hans Verkuil626cf232012-03-23 15:02:27 -07001716 poll_table pt;
1717
1718 init_poll_funcptr(&pt, NULL);
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001719 esed->res = 0;
Davide Libenzi5071f972009-03-31 15:24:10 -07001720
Davide Libenzi296e2362009-03-31 15:24:11 -07001721 /*
Davide Libenzi5071f972009-03-31 15:24:10 -07001722 * We can loop without lock because we are passed a task private list.
1723 * Items cannot vanish during the loop because ep_scan_ready_list() is
1724 * holding "mtx" during this call.
Davide Libenzi296e2362009-03-31 15:24:11 -07001725 */
Davidlohr Bueso21877e12019-01-03 15:27:12 -08001726 lockdep_assert_held(&ep->mtx);
1727
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001728 list_for_each_entry_safe(epi, tmp, head, rdllink) {
1729 if (esed->res >= esed->maxevents)
1730 break;
Davide Libenzi5071f972009-03-31 15:24:10 -07001731
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001732 /*
1733 * Activate ep->ws before deactivating epi->ws to prevent
1734 * triggering auto-suspend here (in case we reactive epi->ws
1735 * below).
1736 *
1737 * This could be rearranged to delay the deactivation of epi->ws
1738 * instead, but then epi->ws would temporarily be out of sync
1739 * with ep_is_linked().
1740 */
Eric Wongeea1d582013-04-30 15:27:39 -07001741 ws = ep_wakeup_source(epi);
1742 if (ws) {
1743 if (ws->active)
1744 __pm_stay_awake(ep->ws);
1745 __pm_relax(ws);
1746 }
1747
Davide Libenzi5071f972009-03-31 15:24:10 -07001748 list_del_init(&epi->rdllink);
1749
Davide Libenzi296e2362009-03-31 15:24:11 -07001750 /*
Davide Libenzi5071f972009-03-31 15:24:10 -07001751 * If the event mask intersect the caller-requested one,
1752 * deliver the event to userspace. Again, ep_scan_ready_list()
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001753 * is holding ep->mtx, so no operations coming from userspace
Davide Libenzi5071f972009-03-31 15:24:10 -07001754 * can change the item.
Davide Libenzi296e2362009-03-31 15:24:11 -07001755 */
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001756 revents = ep_item_poll(epi, &pt, 1);
1757 if (!revents)
1758 continue;
1759
1760 if (__put_user(revents, &uevent->events) ||
1761 __put_user(epi->event.data, &uevent->data)) {
1762 list_add(&epi->rdllink, head);
1763 ep_pm_stay_awake(epi);
1764 if (!esed->res)
1765 esed->res = -EFAULT;
1766 return 0;
1767 }
1768 esed->res++;
1769 uevent++;
1770 if (epi->event.events & EPOLLONESHOT)
1771 epi->event.events &= EP_PRIVATE_BITS;
1772 else if (!(epi->event.events & EPOLLET)) {
1773 /*
1774 * If this file has been added with Level
1775 * Trigger mode, we need to insert back inside
1776 * the ready list, so that the next call to
1777 * epoll_wait() will check again the events
1778 * availability. At this point, no one can insert
1779 * into ep->rdllist besides us. The epoll_ctl()
1780 * callers are locked out by
1781 * ep_scan_ready_list() holding "mtx" and the
1782 * poll callback will queue them in ep->ovflist.
1783 */
1784 list_add_tail(&epi->rdllink, &ep->rdllist);
1785 ep_pm_stay_awake(epi);
Davide Libenzi296e2362009-03-31 15:24:11 -07001786 }
1787 }
Davide Libenzi5071f972009-03-31 15:24:10 -07001788
Al Virod7ebbe42018-02-01 15:21:13 -05001789 return 0;
Davide Libenzi5071f972009-03-31 15:24:10 -07001790}
1791
Davide Libenzi296e2362009-03-31 15:24:11 -07001792static int ep_send_events(struct eventpoll *ep,
1793 struct epoll_event __user *events, int maxevents)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001794{
Davide Libenzi5071f972009-03-31 15:24:10 -07001795 struct ep_send_events_data esed;
Davide Libenzi6192bd52007-05-08 00:25:41 -07001796
Davide Libenzi5071f972009-03-31 15:24:10 -07001797 esed.maxevents = maxevents;
1798 esed.events = events;
Davide Libenzid47de162007-05-15 01:40:41 -07001799
Al Virod7ebbe42018-02-01 15:21:13 -05001800 ep_scan_ready_list(ep, ep_send_events_proc, &esed, 0, false);
1801 return esed.res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001802}
1803
Deepa Dinamani766b9f92016-05-19 17:09:05 -07001804static inline struct timespec64 ep_set_mstimeout(long ms)
Eric Dumazet0781b902011-02-01 15:52:35 -08001805{
Deepa Dinamani766b9f92016-05-19 17:09:05 -07001806 struct timespec64 now, ts = {
Eric Dumazet0781b902011-02-01 15:52:35 -08001807 .tv_sec = ms / MSEC_PER_SEC,
1808 .tv_nsec = NSEC_PER_MSEC * (ms % MSEC_PER_SEC),
1809 };
1810
Deepa Dinamani766b9f92016-05-19 17:09:05 -07001811 ktime_get_ts64(&now);
1812 return timespec64_add_safe(now, ts);
Eric Dumazet0781b902011-02-01 15:52:35 -08001813}
1814
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001815/**
1816 * ep_poll - Retrieves ready events, and delivers them to the caller supplied
1817 * event buffer.
1818 *
1819 * @ep: Pointer to the eventpoll context.
1820 * @events: Pointer to the userspace buffer where the ready events should be
1821 * stored.
1822 * @maxevents: Size (in terms of number of events) of the caller event buffer.
1823 * @timeout: Maximum timeout for the ready events fetch operation, in
1824 * milliseconds. If the @timeout is zero, the function will not block,
1825 * while if the @timeout is less than zero, the function will block
1826 * until at least one event has been retrieved (or an error
1827 * occurred).
1828 *
1829 * Returns: Returns the number of ready events which have been fetched, or an
1830 * error code, in case of error.
1831 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001832static int ep_poll(struct eventpoll *ep, struct epoll_event __user *events,
1833 int maxevents, long timeout)
1834{
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001835 int res = 0, eavail, timed_out = 0;
John Stultzda8b44d2016-03-17 14:20:51 -07001836 u64 slack = 0;
Ingo Molnarac6424b2017-06-20 12:06:13 +02001837 wait_queue_entry_t wait;
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001838 ktime_t expires, *to = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001839
Davidlohr Bueso679abf32018-08-21 21:58:23 -07001840 lockdep_assert_irqs_enabled();
1841
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001842 if (timeout > 0) {
Deepa Dinamani766b9f92016-05-19 17:09:05 -07001843 struct timespec64 end_time = ep_set_mstimeout(timeout);
Eric Dumazet0781b902011-02-01 15:52:35 -08001844
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001845 slack = select_estimate_accuracy(&end_time);
1846 to = &expires;
Deepa Dinamani766b9f92016-05-19 17:09:05 -07001847 *to = timespec64_to_ktime(end_time);
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001848 } else if (timeout == 0) {
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001849 /*
1850 * Avoid the unnecessary trip to the wait queue loop, if the
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001851 * caller specified a non blocking operation. We still need
1852 * lock because we could race and not see an epi being added
1853 * to the ready list while in irq callback. Thus incorrectly
1854 * returning 0 back to userspace.
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001855 */
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001856 timed_out = 1;
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001857
Roman Penyaeva218cc42019-03-07 16:28:53 -08001858 write_lock_irq(&ep->lock);
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001859 eavail = ep_events_available(ep);
Roman Penyaeva218cc42019-03-07 16:28:53 -08001860 write_unlock_irq(&ep->lock);
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001861
Davidlohr Bueso35cff1a2019-01-03 15:27:22 -08001862 goto send_events;
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001863 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001864
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001865fetch_events:
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -07001866
1867 if (!ep_events_available(ep))
1868 ep_busy_loop(ep, timed_out);
1869
Davide Libenzi3fb0e582011-03-22 16:34:46 -07001870 eavail = ep_events_available(ep);
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001871 if (eavail)
Davidlohr Bueso35cff1a2019-01-03 15:27:22 -08001872 goto send_events;
Jason Baron28d82dc2012-01-12 17:17:43 -08001873
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001874 /*
1875 * Busy poll timed out. Drop NAPI ID for now, we can add
1876 * it back in when we have moved a socket with a valid NAPI
1877 * ID onto the ready list.
1878 */
1879 ep_reset_busy_poll_napi_id(ep);
Jason Baron28d82dc2012-01-12 17:17:43 -08001880
Roman Penyaev412895f2020-05-07 18:36:16 -07001881 do {
1882 /*
1883 * Internally init_wait() uses autoremove_wake_function(),
1884 * thus wait entry is removed from the wait queue on each
1885 * wakeup. Why it is important? In case of several waiters
1886 * each new wakeup will hit the next waiter, giving it the
1887 * chance to harvest new event. Otherwise wakeup can be
1888 * lost. This is also good performance-wise, because on
1889 * normal wakeup path no need to call __remove_wait_queue()
1890 * explicitly, thus ep->lock is not taken, which halts the
1891 * event delivery.
1892 */
1893 init_wait(&wait);
Roman Penyaev65759092020-05-13 17:50:38 -07001894
Roman Penyaev1b537342020-03-21 18:22:30 -07001895 write_lock_irq(&ep->lock);
Roman Penyaev65759092020-05-13 17:50:38 -07001896 /*
1897 * Barrierless variant, waitqueue_active() is called under
1898 * the same lock on wakeup ep_poll_callback() side, so it
1899 * is safe to avoid an explicit barrier.
1900 */
1901 __set_current_state(TASK_INTERRUPTIBLE);
1902
1903 /*
1904 * Do the final check under the lock. ep_scan_ready_list()
1905 * plays with two lists (->rdllist and ->ovflist) and there
1906 * is always a race when both lists are empty for short
1907 * period of time although events are pending, so lock is
1908 * important.
1909 */
1910 eavail = ep_events_available(ep);
1911 if (!eavail) {
1912 if (signal_pending(current))
1913 res = -EINTR;
1914 else
1915 __add_wait_queue_exclusive(&ep->wq, &wait);
1916 }
Roman Penyaev1b537342020-03-21 18:22:30 -07001917 write_unlock_irq(&ep->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001918
Soheil Hassas Yeganeh1afb979c2020-12-18 14:01:44 -08001919 if (!eavail && !res)
Greg Kroah-Hartman19057a62020-12-30 12:44:42 +01001920 timed_out = !freezable_schedule_hrtimeout_range(to, slack,
1921 HRTIMER_MODE_ABS);
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001922
Soheil Hassas Yeganeh1afb979c2020-12-18 14:01:44 -08001923 /*
1924 * We were woken up, thus go and try to harvest some events.
1925 * If timed out and still on the wait queue, recheck eavail
1926 * carefully under lock, below.
1927 */
Roman Penyaev412895f2020-05-07 18:36:16 -07001928 eavail = 1;
Roman Penyaev412895f2020-05-07 18:36:16 -07001929 } while (0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001930
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001931 __set_current_state(TASK_RUNNING);
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001932
Roman Penyaev412895f2020-05-07 18:36:16 -07001933 if (!list_empty_careful(&wait.entry)) {
1934 write_lock_irq(&ep->lock);
Soheil Hassas Yeganeh1afb979c2020-12-18 14:01:44 -08001935 /*
1936 * If the thread timed out and is not on the wait queue, it
1937 * means that the thread was woken up after its timeout expired
1938 * before it could reacquire the lock. Thus, when wait.entry is
1939 * empty, it needs to harvest events.
1940 */
1941 if (timed_out)
1942 eavail = list_empty(&wait.entry);
Roman Penyaev412895f2020-05-07 18:36:16 -07001943 __remove_wait_queue(&ep->wq, &wait);
1944 write_unlock_irq(&ep->lock);
1945 }
1946
Davidlohr Bueso35cff1a2019-01-03 15:27:22 -08001947send_events:
Roman Penyaev65759092020-05-13 17:50:38 -07001948 if (fatal_signal_pending(current)) {
1949 /*
1950 * Always short-circuit for fatal signals to allow
1951 * threads to make a timely exit without the chance of
1952 * finding more events available and fetching
1953 * repeatedly.
1954 */
1955 res = -EINTR;
1956 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001957 /*
1958 * Try to transfer events to user space. In case we get 0 events and
1959 * there's still timeout left over, we go trying again in search of
1960 * more luck.
1961 */
Davide Libenzi22bacca2011-02-25 14:44:12 -08001962 if (!res && eavail &&
1963 !(res = ep_send_events(ep, events, maxevents)) && !timed_out)
1964 goto fetch_events;
1965
1966 return res;
1967}
1968
1969/**
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001970 * ep_loop_check_proc - Callback function to be passed to the @ep_call_nested()
Linus Torvalds1da177e2005-04-16 15:20:36 -07001971 * API, to verify that adding an epoll file inside another
1972 * epoll structure, does not violate the constraints, in
1973 * terms of closed loops, or too deep chains (which can
1974 * result in excessive stack usage).
Davide Libenzi22bacca2011-02-25 14:44:12 -08001975 *
1976 * @priv: Pointer to the epoll file to be currently checked.
1977 * @cookie: Original cookie for this call. This is the top-of-the-chain epoll
1978 * data structure pointer.
1979 * @call_nests: Current dept of the @ep_call_nested() call stack.
1980 *
1981 * Returns: Returns zero if adding the epoll @file inside current epoll
1982 * structure @ep does not violate the constraints, or -1 otherwise.
1983 */
1984static int ep_loop_check_proc(void *priv, void *cookie, int call_nests)
1985{
1986 int error = 0;
1987 struct file *file = priv;
1988 struct eventpoll *ep = file->private_data;
1989 struct eventpoll *ep_tovisit;
1990 struct rb_node *rbp;
1991 struct epitem *epi;
1992
1993 mutex_lock_nested(&ep->mtx, call_nests + 1);
Al Viro18306c42020-09-10 08:30:05 -04001994 ep->gen = loop_check_gen;
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001995 for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) {
Davide Libenzi22bacca2011-02-25 14:44:12 -08001996 epi = rb_entry(rbp, struct epitem, rbn);
Nelson Elhaged8805e62011-10-31 17:13:14 -07001997 if (unlikely(is_file_epoll(epi->ffd.file))) {
Davide Libenzi22bacca2011-02-25 14:44:12 -08001998 ep_tovisit = epi->ffd.file->private_data;
Al Viro18306c42020-09-10 08:30:05 -04001999 if (ep_tovisit->gen == loop_check_gen)
Davide Libenzi22bacca2011-02-25 14:44:12 -08002000 continue;
Davidlohr Bueso74bdc122019-01-03 15:27:02 -08002001 error = ep_call_nested(&poll_loop_ncalls,
Davide Libenzi22bacca2011-02-25 14:44:12 -08002002 ep_loop_check_proc, epi->ffd.file,
2003 ep_tovisit, current);
2004 if (error != 0)
2005 break;
Jason Baron28d82dc2012-01-12 17:17:43 -08002006 } else {
2007 /*
2008 * If we've reached a file that is not associated with
2009 * an ep, then we need to check if the newly added
2010 * links are going to add too many wakeup paths. We do
2011 * this by adding it to the tfile_check_list, if it's
2012 * not already there, and calling reverse_path_check()
2013 * during ep_insert().
2014 */
Marc Zyngiera9ed4a62020-08-19 17:12:17 +01002015 if (list_empty(&epi->ffd.file->f_tfile_llink)) {
Al Viro77f46892020-09-02 11:30:48 -04002016 if (get_file_rcu(epi->ffd.file))
2017 list_add(&epi->ffd.file->f_tfile_llink,
2018 &tfile_check_list);
Marc Zyngiera9ed4a62020-08-19 17:12:17 +01002019 }
Davide Libenzi22bacca2011-02-25 14:44:12 -08002020 }
2021 }
2022 mutex_unlock(&ep->mtx);
2023
2024 return error;
2025}
2026
2027/**
2028 * ep_loop_check - Performs a check to verify that adding an epoll file (@file)
2029 * another epoll file (represented by @ep) does not create
2030 * closed loops or too deep chains.
2031 *
2032 * @ep: Pointer to the epoll private data structure.
2033 * @file: Pointer to the epoll file to be checked.
2034 *
2035 * Returns: Returns zero if adding the epoll @file inside current epoll
2036 * structure @ep does not violate the constraints, or -1 otherwise.
2037 */
2038static int ep_loop_check(struct eventpoll *ep, struct file *file)
2039{
Al Viro18306c42020-09-10 08:30:05 -04002040 return ep_call_nested(&poll_loop_ncalls,
Davide Libenzi22bacca2011-02-25 14:44:12 -08002041 ep_loop_check_proc, file, ep, current);
Jason Baron28d82dc2012-01-12 17:17:43 -08002042}
2043
2044static void clear_tfile_check_list(void)
2045{
2046 struct file *file;
2047
2048 /* first clear the tfile_check_list */
2049 while (!list_empty(&tfile_check_list)) {
2050 file = list_first_entry(&tfile_check_list, struct file,
2051 f_tfile_llink);
2052 list_del_init(&file->f_tfile_llink);
Marc Zyngiera9ed4a62020-08-19 17:12:17 +01002053 fput(file);
Jason Baron28d82dc2012-01-12 17:17:43 -08002054 }
2055 INIT_LIST_HEAD(&tfile_check_list);
Davide Libenzi22bacca2011-02-25 14:44:12 -08002056}
2057
Davide Libenzi7699acd2007-05-10 22:23:23 -07002058/*
Andrew Morton523723b2008-08-12 15:09:01 -07002059 * Open an eventpoll file descriptor.
Davide Libenzi7699acd2007-05-10 22:23:23 -07002060 */
Dominik Brodowski791eb222018-03-11 11:34:30 +01002061static int do_epoll_create(int flags)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002062{
Jason Baron28d82dc2012-01-12 17:17:43 -08002063 int error, fd;
Davide Libenzibb57c3e2009-03-31 15:24:12 -07002064 struct eventpoll *ep = NULL;
Jason Baron28d82dc2012-01-12 17:17:43 -08002065 struct file *file;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002066
Ulrich Dreppere38b36f2008-07-23 21:29:42 -07002067 /* Check the EPOLL_* constant for consistency. */
2068 BUILD_BUG_ON(EPOLL_CLOEXEC != O_CLOEXEC);
2069
Davide Libenzi296e2362009-03-31 15:24:11 -07002070 if (flags & ~EPOLL_CLOEXEC)
2071 return -EINVAL;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002072 /*
Davide Libenzibb57c3e2009-03-31 15:24:12 -07002073 * Create the internal data structure ("struct eventpoll").
Davide Libenzi7699acd2007-05-10 22:23:23 -07002074 */
Ulrich Drepper9fe5ad92008-07-23 21:29:43 -07002075 error = ep_alloc(&ep);
Davide Libenzibb57c3e2009-03-31 15:24:12 -07002076 if (error < 0)
2077 return error;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002078 /*
2079 * Creates all the items needed to setup an eventpoll file. That is,
Al Viro2030a422008-02-23 06:46:49 -05002080 * a file structure and a free file descriptor.
Davide Libenzi7699acd2007-05-10 22:23:23 -07002081 */
Jason Baron28d82dc2012-01-12 17:17:43 -08002082 fd = get_unused_fd_flags(O_RDWR | (flags & O_CLOEXEC));
2083 if (fd < 0) {
2084 error = fd;
2085 goto out_free_ep;
2086 }
2087 file = anon_inode_getfile("[eventpoll]", &eventpoll_fops, ep,
Roland Dreier628ff7c2009-12-18 09:41:24 -08002088 O_RDWR | (flags & O_CLOEXEC));
Jason Baron28d82dc2012-01-12 17:17:43 -08002089 if (IS_ERR(file)) {
2090 error = PTR_ERR(file);
2091 goto out_free_fd;
2092 }
Jason Baron28d82dc2012-01-12 17:17:43 -08002093 ep->file = file;
Al Viro98022742012-08-17 22:42:36 -04002094 fd_install(fd, file);
Jason Baron28d82dc2012-01-12 17:17:43 -08002095 return fd;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002096
Jason Baron28d82dc2012-01-12 17:17:43 -08002097out_free_fd:
2098 put_unused_fd(fd);
2099out_free_ep:
2100 ep_free(ep);
Davide Libenzibb57c3e2009-03-31 15:24:12 -07002101 return error;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002102}
2103
Dominik Brodowski791eb222018-03-11 11:34:30 +01002104SYSCALL_DEFINE1(epoll_create1, int, flags)
2105{
2106 return do_epoll_create(flags);
2107}
2108
Heiko Carstens5a8a82b2009-01-14 14:14:25 +01002109SYSCALL_DEFINE1(epoll_create, int, size)
Ulrich Dreppera0998b52008-07-23 21:29:27 -07002110{
Davide Libenzibfe3891a2009-05-12 13:19:44 -07002111 if (size <= 0)
Ulrich Drepper9fe5ad92008-07-23 21:29:43 -07002112 return -EINVAL;
2113
Dominik Brodowski791eb222018-03-11 11:34:30 +01002114 return do_epoll_create(0);
Ulrich Dreppera0998b52008-07-23 21:29:27 -07002115}
2116
Jens Axboe39220e82020-01-08 15:05:37 -07002117static inline int epoll_mutex_lock(struct mutex *mutex, int depth,
2118 bool nonblock)
2119{
2120 if (!nonblock) {
2121 mutex_lock_nested(mutex, depth);
2122 return 0;
2123 }
2124 if (mutex_trylock(mutex))
2125 return 0;
2126 return -EAGAIN;
2127}
2128
2129int do_epoll_ctl(int epfd, int op, int fd, struct epoll_event *epds,
2130 bool nonblock)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002131{
2132 int error;
Jason Baron67347fe2013-11-12 15:10:18 -08002133 int full_check = 0;
Al Viro7e3fb582013-08-30 12:47:21 -04002134 struct fd f, tf;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002135 struct eventpoll *ep;
2136 struct epitem *epi;
Jason Baron67347fe2013-11-12 15:10:18 -08002137 struct eventpoll *tep = NULL;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002138
Davide Libenzi7699acd2007-05-10 22:23:23 -07002139 error = -EBADF;
Al Viro7e3fb582013-08-30 12:47:21 -04002140 f = fdget(epfd);
2141 if (!f.file)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002142 goto error_return;
2143
2144 /* Get the "struct file *" for the target file */
Al Viro7e3fb582013-08-30 12:47:21 -04002145 tf = fdget(fd);
2146 if (!tf.file)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002147 goto error_fput;
2148
2149 /* The target file descriptor must support poll */
2150 error = -EPERM;
Christoph Hellwig9965ed172018-03-05 07:26:05 -08002151 if (!file_can_poll(tf.file))
Davide Libenzi7699acd2007-05-10 22:23:23 -07002152 goto error_tgt_fput;
2153
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02002154 /* Check if EPOLLWAKEUP is allowed */
Nicolas Ioossc680e412014-09-09 14:50:51 -07002155 if (ep_op_has_event(op))
Jens Axboe58e41a42020-01-08 14:35:13 -07002156 ep_take_care_of_epollwakeup(epds);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02002157
Davide Libenzi7699acd2007-05-10 22:23:23 -07002158 /*
2159 * We have to check that the file structure underneath the file descriptor
2160 * the user passed to us _is_ an eventpoll file. And also we do not permit
2161 * adding an epoll file descriptor inside itself.
2162 */
2163 error = -EINVAL;
Al Viro7e3fb582013-08-30 12:47:21 -04002164 if (f.file == tf.file || !is_file_epoll(f.file))
Davide Libenzi7699acd2007-05-10 22:23:23 -07002165 goto error_tgt_fput;
2166
2167 /*
Jason Barondf0108c2016-01-20 14:59:24 -08002168 * epoll adds to the wakeup queue at EPOLL_CTL_ADD time only,
2169 * so EPOLLEXCLUSIVE is not allowed for a EPOLL_CTL_MOD operation.
2170 * Also, we do not currently supported nested exclusive wakeups.
2171 */
Jens Axboe58e41a42020-01-08 14:35:13 -07002172 if (ep_op_has_event(op) && (epds->events & EPOLLEXCLUSIVE)) {
Jason Baronb6a515c2016-02-05 15:37:04 -08002173 if (op == EPOLL_CTL_MOD)
2174 goto error_tgt_fput;
2175 if (op == EPOLL_CTL_ADD && (is_file_epoll(tf.file) ||
Jens Axboe58e41a42020-01-08 14:35:13 -07002176 (epds->events & ~EPOLLEXCLUSIVE_OK_BITS)))
Jason Baronb6a515c2016-02-05 15:37:04 -08002177 goto error_tgt_fput;
2178 }
Jason Barondf0108c2016-01-20 14:59:24 -08002179
2180 /*
Davide Libenzi7699acd2007-05-10 22:23:23 -07002181 * At this point it is safe to assume that the "private_data" contains
2182 * our own data structure.
2183 */
Al Viro7e3fb582013-08-30 12:47:21 -04002184 ep = f.file->private_data;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002185
Davide Libenzi22bacca2011-02-25 14:44:12 -08002186 /*
2187 * When we insert an epoll file descriptor, inside another epoll file
2188 * descriptor, there is the change of creating closed loops, which are
Jason Baron28d82dc2012-01-12 17:17:43 -08002189 * better be handled here, than in more critical paths. While we are
2190 * checking for loops we also determine the list of files reachable
2191 * and hang them on the tfile_check_list, so we can check that we
2192 * haven't created too many possible wakeup paths.
Davide Libenzi22bacca2011-02-25 14:44:12 -08002193 *
Jason Baron67347fe2013-11-12 15:10:18 -08002194 * We do not need to take the global 'epumutex' on EPOLL_CTL_ADD when
2195 * the epoll file descriptor is attaching directly to a wakeup source,
2196 * unless the epoll file descriptor is nested. The purpose of taking the
2197 * 'epmutex' on add is to prevent complex toplogies such as loops and
2198 * deep wakeup paths from forming in parallel through multiple
2199 * EPOLL_CTL_ADD operations.
Davide Libenzi22bacca2011-02-25 14:44:12 -08002200 */
Jens Axboe39220e82020-01-08 15:05:37 -07002201 error = epoll_mutex_lock(&ep->mtx, 0, nonblock);
2202 if (error)
2203 goto error_tgt_fput;
Jason Baron67347fe2013-11-12 15:10:18 -08002204 if (op == EPOLL_CTL_ADD) {
2205 if (!list_empty(&f.file->f_ep_links) ||
Al Virofe0a9162020-09-10 08:33:27 -04002206 ep->gen == loop_check_gen ||
Jason Baron67347fe2013-11-12 15:10:18 -08002207 is_file_epoll(tf.file)) {
Jason Baron67347fe2013-11-12 15:10:18 -08002208 mutex_unlock(&ep->mtx);
Jens Axboe39220e82020-01-08 15:05:37 -07002209 error = epoll_mutex_lock(&epmutex, 0, nonblock);
2210 if (error)
2211 goto error_tgt_fput;
Al Viro18306c42020-09-10 08:30:05 -04002212 loop_check_gen++;
Jens Axboe39220e82020-01-08 15:05:37 -07002213 full_check = 1;
Jason Baron67347fe2013-11-12 15:10:18 -08002214 if (is_file_epoll(tf.file)) {
2215 error = -ELOOP;
Al Viro52c47962020-08-22 18:25:52 -04002216 if (ep_loop_check(ep, tf.file) != 0)
Jason Baron67347fe2013-11-12 15:10:18 -08002217 goto error_tgt_fput;
Marc Zyngiera9ed4a62020-08-19 17:12:17 +01002218 } else {
2219 get_file(tf.file);
Jason Baron67347fe2013-11-12 15:10:18 -08002220 list_add(&tf.file->f_tfile_llink,
2221 &tfile_check_list);
Jens Axboe39220e82020-01-08 15:05:37 -07002222 }
Jason Baron67347fe2013-11-12 15:10:18 -08002223 error = epoll_mutex_lock(&ep->mtx, 0, nonblock);
Al Viro52c47962020-08-22 18:25:52 -04002224 if (error)
Jason Baron67347fe2013-11-12 15:10:18 -08002225 goto error_tgt_fput;
Jason Baron67347fe2013-11-12 15:10:18 -08002226 if (is_file_epoll(tf.file)) {
2227 tep = tf.file->private_data;
Jens Axboe39220e82020-01-08 15:05:37 -07002228 error = epoll_mutex_lock(&tep->mtx, 1, nonblock);
2229 if (error) {
2230 mutex_unlock(&ep->mtx);
Al Viro52c47962020-08-22 18:25:52 -04002231 goto error_tgt_fput;
Jens Axboe39220e82020-01-08 15:05:37 -07002232 }
Jason Baron67347fe2013-11-12 15:10:18 -08002233 }
2234 }
2235 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07002236
Davide Libenzi67647d02007-05-15 01:40:52 -07002237 /*
2238 * Try to lookup the file inside our RB tree, Since we grabbed "mtx"
2239 * above, we can be sure to be able to use the item looked up by
2240 * ep_find() till we release the mutex.
2241 */
Al Viro7e3fb582013-08-30 12:47:21 -04002242 epi = ep_find(ep, tf.file, fd);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002243
2244 error = -EINVAL;
2245 switch (op) {
2246 case EPOLL_CTL_ADD:
2247 if (!epi) {
Jens Axboe58e41a42020-01-08 14:35:13 -07002248 epds->events |= EPOLLERR | EPOLLHUP;
2249 error = ep_insert(ep, epds, tf.file, fd, full_check);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002250 } else
2251 error = -EEXIST;
2252 break;
2253 case EPOLL_CTL_DEL:
2254 if (epi)
2255 error = ep_remove(ep, epi);
2256 else
2257 error = -ENOENT;
2258 break;
2259 case EPOLL_CTL_MOD:
2260 if (epi) {
Jason Baronb6a515c2016-02-05 15:37:04 -08002261 if (!(epi->event.events & EPOLLEXCLUSIVE)) {
Jens Axboe58e41a42020-01-08 14:35:13 -07002262 epds->events |= EPOLLERR | EPOLLHUP;
2263 error = ep_modify(ep, epi, epds);
Jason Baronb6a515c2016-02-05 15:37:04 -08002264 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07002265 } else
2266 error = -ENOENT;
2267 break;
2268 }
Jason Baron67347fe2013-11-12 15:10:18 -08002269 if (tep != NULL)
2270 mutex_unlock(&tep->mtx);
Davide Libenzid47de162007-05-15 01:40:41 -07002271 mutex_unlock(&ep->mtx);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002272
2273error_tgt_fput:
Al Viro52c47962020-08-22 18:25:52 -04002274 if (full_check) {
2275 clear_tfile_check_list();
Al Viro18306c42020-09-10 08:30:05 -04002276 loop_check_gen++;
Davide Libenzi22bacca2011-02-25 14:44:12 -08002277 mutex_unlock(&epmutex);
Al Viro52c47962020-08-22 18:25:52 -04002278 }
Davide Libenzi22bacca2011-02-25 14:44:12 -08002279
Al Viro7e3fb582013-08-30 12:47:21 -04002280 fdput(tf);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002281error_fput:
Al Viro7e3fb582013-08-30 12:47:21 -04002282 fdput(f);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002283error_return:
Davide Libenzi7699acd2007-05-10 22:23:23 -07002284
2285 return error;
2286}
2287
2288/*
Jens Axboe58e41a42020-01-08 14:35:13 -07002289 * The following function implements the controller interface for
2290 * the eventpoll file that enables the insertion/removal/change of
2291 * file descriptors inside the interest set.
2292 */
2293SYSCALL_DEFINE4(epoll_ctl, int, epfd, int, op, int, fd,
2294 struct epoll_event __user *, event)
2295{
2296 struct epoll_event epds;
2297
2298 if (ep_op_has_event(op) &&
2299 copy_from_user(&epds, event, sizeof(struct epoll_event)))
2300 return -EFAULT;
2301
Jens Axboe39220e82020-01-08 15:05:37 -07002302 return do_epoll_ctl(epfd, op, fd, &epds, false);
Jens Axboe58e41a42020-01-08 14:35:13 -07002303}
2304
2305/*
Davide Libenzi7699acd2007-05-10 22:23:23 -07002306 * Implement the event wait interface for the eventpoll file. It is the kernel
2307 * part of the user space epoll_wait(2).
2308 */
Dominik Brodowski791eb222018-03-11 11:34:30 +01002309static int do_epoll_wait(int epfd, struct epoll_event __user *events,
2310 int maxevents, int timeout)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002311{
Al Viro2903ff02012-08-28 12:52:22 -04002312 int error;
2313 struct fd f;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002314 struct eventpoll *ep;
2315
Davide Libenzi7699acd2007-05-10 22:23:23 -07002316 /* The maximum number of event must be greater than zero */
2317 if (maxevents <= 0 || maxevents > EP_MAX_EVENTS)
2318 return -EINVAL;
2319
2320 /* Verify that the area passed by the user is writeable */
Linus Torvalds96d4f262019-01-03 18:57:57 -08002321 if (!access_ok(events, maxevents * sizeof(struct epoll_event)))
Al Viro2903ff02012-08-28 12:52:22 -04002322 return -EFAULT;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002323
2324 /* Get the "struct file *" for the eventpoll file */
Al Viro2903ff02012-08-28 12:52:22 -04002325 f = fdget(epfd);
2326 if (!f.file)
2327 return -EBADF;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002328
2329 /*
2330 * We have to check that the file structure underneath the fd
2331 * the user passed to us _is_ an eventpoll file.
2332 */
2333 error = -EINVAL;
Al Viro2903ff02012-08-28 12:52:22 -04002334 if (!is_file_epoll(f.file))
Davide Libenzi7699acd2007-05-10 22:23:23 -07002335 goto error_fput;
2336
2337 /*
2338 * At this point it is safe to assume that the "private_data" contains
2339 * our own data structure.
2340 */
Al Viro2903ff02012-08-28 12:52:22 -04002341 ep = f.file->private_data;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002342
2343 /* Time to fish for events ... */
2344 error = ep_poll(ep, events, maxevents, timeout);
2345
2346error_fput:
Al Viro2903ff02012-08-28 12:52:22 -04002347 fdput(f);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002348 return error;
2349}
2350
Dominik Brodowski791eb222018-03-11 11:34:30 +01002351SYSCALL_DEFINE4(epoll_wait, int, epfd, struct epoll_event __user *, events,
2352 int, maxevents, int, timeout)
2353{
2354 return do_epoll_wait(epfd, events, maxevents, timeout);
2355}
2356
Davide Libenzi7699acd2007-05-10 22:23:23 -07002357/*
2358 * Implement the event wait interface for the eventpoll file. It is the kernel
2359 * part of the user space epoll_pwait(2).
2360 */
Heiko Carstens5a8a82b2009-01-14 14:14:25 +01002361SYSCALL_DEFINE6(epoll_pwait, int, epfd, struct epoll_event __user *, events,
2362 int, maxevents, int, timeout, const sigset_t __user *, sigmask,
2363 size_t, sigsetsize)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002364{
2365 int error;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002366
2367 /*
2368 * If the caller wants a certain signal mask to be set during the wait,
2369 * we apply it here.
2370 */
Oleg Nesterovb7724342019-07-16 16:29:53 -07002371 error = set_user_sigmask(sigmask, sigsetsize);
Deepa Dinamanided653c2018-09-19 21:41:04 -07002372 if (error)
2373 return error;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002374
Dominik Brodowski791eb222018-03-11 11:34:30 +01002375 error = do_epoll_wait(epfd, events, maxevents, timeout);
Oleg Nesterovb7724342019-07-16 16:29:53 -07002376 restore_saved_sigmask_unless(error == -EINTR);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002377
2378 return error;
2379}
2380
Al Viro35280bd2013-02-24 14:52:17 -05002381#ifdef CONFIG_COMPAT
2382COMPAT_SYSCALL_DEFINE6(epoll_pwait, int, epfd,
2383 struct epoll_event __user *, events,
2384 int, maxevents, int, timeout,
2385 const compat_sigset_t __user *, sigmask,
2386 compat_size_t, sigsetsize)
2387{
2388 long err;
Al Viro35280bd2013-02-24 14:52:17 -05002389
2390 /*
2391 * If the caller wants a certain signal mask to be set during the wait,
2392 * we apply it here.
2393 */
Oleg Nesterovb7724342019-07-16 16:29:53 -07002394 err = set_compat_user_sigmask(sigmask, sigsetsize);
Deepa Dinamanided653c2018-09-19 21:41:04 -07002395 if (err)
2396 return err;
Al Viro35280bd2013-02-24 14:52:17 -05002397
Dominik Brodowski791eb222018-03-11 11:34:30 +01002398 err = do_epoll_wait(epfd, events, maxevents, timeout);
Oleg Nesterovb7724342019-07-16 16:29:53 -07002399 restore_saved_sigmask_unless(err == -EINTR);
Al Viro35280bd2013-02-24 14:52:17 -05002400
2401 return err;
2402}
2403#endif
2404
Linus Torvalds1da177e2005-04-16 15:20:36 -07002405static int __init eventpoll_init(void)
2406{
Davide Libenzi7ef99642008-12-01 13:13:55 -08002407 struct sysinfo si;
2408
2409 si_meminfo(&si);
Davide Libenzi9df04e12009-01-29 14:25:26 -08002410 /*
2411 * Allows top 4% of lomem to be allocated for epoll watches (per user).
2412 */
2413 max_user_watches = (((si.totalram - si.totalhigh) / 25) << PAGE_SHIFT) /
Davide Libenzi7ef99642008-12-01 13:13:55 -08002414 EP_ITEM_COST;
Robin Holt52bd19f72011-01-12 17:00:01 -08002415 BUG_ON(max_user_watches < 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002416
Davide Libenzi22bacca2011-02-25 14:44:12 -08002417 /*
2418 * Initialize the structure used to perform epoll file descriptor
2419 * inclusion loops checks.
2420 */
2421 ep_nested_calls_init(&poll_loop_ncalls);
2422
Eric Wong39732ca2013-04-30 15:27:38 -07002423 /*
2424 * We can have many thousands of epitems, so prevent this from
2425 * using an extra cache line on 64-bit (and smaller) CPUs
2426 */
2427 BUILD_BUG_ON(sizeof(void *) <= 8 && sizeof(struct epitem) > 128);
2428
Linus Torvalds1da177e2005-04-16 15:20:36 -07002429 /* Allocates slab cache used to allocate "struct epitem" items */
2430 epi_cache = kmem_cache_create("eventpoll_epi", sizeof(struct epitem),
Shakeel Butt2ae928a2017-11-17 15:28:59 -08002431 0, SLAB_HWCACHE_ALIGN|SLAB_PANIC|SLAB_ACCOUNT, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002432
2433 /* Allocates slab cache used to allocate "struct eppoll_entry" */
2434 pwq_cache = kmem_cache_create("eventpoll_pwq",
Shakeel Butt2ae928a2017-11-17 15:28:59 -08002435 sizeof(struct eppoll_entry), 0, SLAB_PANIC|SLAB_ACCOUNT, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002436
Linus Torvalds1da177e2005-04-16 15:20:36 -07002437 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002438}
Davide Libenzicea69242007-05-10 22:23:22 -07002439fs_initcall(eventpoll_init);