blob: 339453ac834cc7f49dc9139a60581295c8f7e0d4 [file] [log] [blame]
Thomas Gleixner2874c5f2019-05-27 08:55:01 +02001// SPDX-License-Identifier: GPL-2.0-or-later
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
Davide Libenzi5071f972009-03-31 15:24:10 -07003 * fs/eventpoll.c (Efficient event retrieval implementation)
4 * Copyright (C) 2001,...,2009 Davide Libenzi
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07006 * Davide Libenzi <davidel@xmailserver.org>
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 */
8
Linus Torvalds1da177e2005-04-16 15:20:36 -07009#include <linux/init.h>
10#include <linux/kernel.h>
Ingo Molnar174cd4b2017-02-02 19:15:33 +010011#include <linux/sched/signal.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070012#include <linux/fs.h>
13#include <linux/file.h>
14#include <linux/signal.h>
15#include <linux/errno.h>
16#include <linux/mm.h>
17#include <linux/slab.h>
18#include <linux/poll.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070019#include <linux/string.h>
20#include <linux/list.h>
21#include <linux/hash.h>
22#include <linux/spinlock.h>
23#include <linux/syscalls.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#include <linux/rbtree.h>
25#include <linux/wait.h>
26#include <linux/eventpoll.h>
27#include <linux/mount.h>
28#include <linux/bitops.h>
Arjan van de Ven144efe32006-03-23 03:00:32 -080029#include <linux/mutex.h>
Davide Libenzida66f7c2007-05-10 22:23:21 -070030#include <linux/anon_inodes.h>
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +020031#include <linux/device.h>
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -080032#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070033#include <asm/io.h>
34#include <asm/mman.h>
Arun Sharma600634972011-07-26 16:09:06 -070035#include <linux/atomic.h>
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -080036#include <linux/proc_fs.h>
37#include <linux/seq_file.h>
Al Viro35280bd2013-02-24 14:52:17 -050038#include <linux/compat.h>
Jason Baronae10b2b2013-11-12 15:10:16 -080039#include <linux/rculist.h>
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -070040#include <net/busy_poll.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070041
Linus Torvalds1da177e2005-04-16 15:20:36 -070042/*
43 * LOCKING:
44 * There are three level of locking required by epoll :
45 *
Arjan van de Ven144efe32006-03-23 03:00:32 -080046 * 1) epmutex (mutex)
Davide Libenzic7ea7632007-05-15 01:40:47 -070047 * 2) ep->mtx (mutex)
Roman Penyaeva218cc42019-03-07 16:28:53 -080048 * 3) ep->lock (rwlock)
Linus Torvalds1da177e2005-04-16 15:20:36 -070049 *
50 * The acquire order is the one listed above, from 1 to 3.
Roman Penyaeva218cc42019-03-07 16:28:53 -080051 * We need a rwlock (ep->lock) because we manipulate objects
Linus Torvalds1da177e2005-04-16 15:20:36 -070052 * from inside the poll callback, that might be triggered from
53 * a wake_up() that in turn might be called from IRQ context.
54 * So we can't sleep inside the poll callback and hence we need
55 * a spinlock. During the event transfer loop (from kernel to
56 * user space) we could end up sleeping due a copy_to_user(), so
57 * we need a lock that will allow us to sleep. This lock is a
Davide Libenzid47de162007-05-15 01:40:41 -070058 * mutex (ep->mtx). It is acquired during the event transfer loop,
59 * during epoll_ctl(EPOLL_CTL_DEL) and during eventpoll_release_file().
60 * Then we also need a global mutex to serialize eventpoll_release_file()
61 * and ep_free().
62 * This mutex is acquired by ep_free() during the epoll file
Linus Torvalds1da177e2005-04-16 15:20:36 -070063 * cleanup path and it is also acquired by eventpoll_release_file()
64 * if a file has been pushed inside an epoll set and it is then
Daniel Balutabf6a41d2011-01-30 23:42:29 +020065 * close()d without a previous call to epoll_ctl(EPOLL_CTL_DEL).
Davide Libenzi22bacca2011-02-25 14:44:12 -080066 * It is also acquired when inserting an epoll fd onto another epoll
67 * fd. We do this so that we walk the epoll tree and ensure that this
68 * insertion does not create a cycle of epoll file descriptors, which
69 * could lead to deadlock. We need a global mutex to prevent two
70 * simultaneous inserts (A into B and B into A) from racing and
71 * constructing a cycle without either insert observing that it is
72 * going to.
Nelson Elhaged8805e62011-10-31 17:13:14 -070073 * It is necessary to acquire multiple "ep->mtx"es at once in the
74 * case when one epoll fd is added to another. In this case, we
75 * always acquire the locks in the order of nesting (i.e. after
76 * epoll_ctl(e1, EPOLL_CTL_ADD, e2), e1->mtx will always be acquired
77 * before e2->mtx). Since we disallow cycles of epoll file
78 * descriptors, this ensures that the mutexes are well-ordered. In
79 * order to communicate this nesting to lockdep, when walking a tree
80 * of epoll file descriptors, we use the current recursion depth as
81 * the lockdep subkey.
Davide Libenzid47de162007-05-15 01:40:41 -070082 * It is possible to drop the "ep->mtx" and to use the global
Roman Penyaeva218cc42019-03-07 16:28:53 -080083 * mutex "epmutex" (together with "ep->lock") to have it working,
Davide Libenzid47de162007-05-15 01:40:41 -070084 * but having "ep->mtx" will make the interface more scalable.
Arjan van de Ven144efe32006-03-23 03:00:32 -080085 * Events that require holding "epmutex" are very rare, while for
Davide Libenzid47de162007-05-15 01:40:41 -070086 * normal operations the epoll private "ep->mtx" will guarantee
87 * a better scalability.
Linus Torvalds1da177e2005-04-16 15:20:36 -070088 */
89
Linus Torvalds1da177e2005-04-16 15:20:36 -070090/* Epoll private bits inside the event mask */
Jason Barondf0108c2016-01-20 14:59:24 -080091#define EP_PRIVATE_BITS (EPOLLWAKEUP | EPOLLONESHOT | EPOLLET | EPOLLEXCLUSIVE)
Linus Torvalds1da177e2005-04-16 15:20:36 -070092
Linus Torvaldsa9a08842018-02-11 14:34:03 -080093#define EPOLLINOUT_BITS (EPOLLIN | EPOLLOUT)
Jason Baronb6a515c2016-02-05 15:37:04 -080094
Linus Torvaldsa9a08842018-02-11 14:34:03 -080095#define EPOLLEXCLUSIVE_OK_BITS (EPOLLINOUT_BITS | EPOLLERR | EPOLLHUP | \
Jason Baronb6a515c2016-02-05 15:37:04 -080096 EPOLLWAKEUP | EPOLLET | EPOLLEXCLUSIVE)
97
Davide Libenzi5071f972009-03-31 15:24:10 -070098/* Maximum number of nesting allowed inside epoll sets */
99#define EP_MAX_NESTS 4
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100
Davide Libenzib6119672006-10-11 01:21:44 -0700101#define EP_MAX_EVENTS (INT_MAX / sizeof(struct epoll_event))
102
Davide Libenzid47de162007-05-15 01:40:41 -0700103#define EP_UNACTIVE_PTR ((void *) -1L)
104
Davide Libenzi7ef99642008-12-01 13:13:55 -0800105#define EP_ITEM_COST (sizeof(struct epitem) + sizeof(struct eppoll_entry))
106
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107struct epoll_filefd {
108 struct file *file;
109 int fd;
Eric Wong39732ca2013-04-30 15:27:38 -0700110} __packed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111
112/*
Davide Libenzi5071f972009-03-31 15:24:10 -0700113 * Structure used to track possible nested calls, for too deep recursions
114 * and loop cycles.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115 */
Davide Libenzi5071f972009-03-31 15:24:10 -0700116struct nested_call_node {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117 struct list_head llink;
Davide Libenzi5071f972009-03-31 15:24:10 -0700118 void *cookie;
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700119 void *ctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120};
121
122/*
Davide Libenzi5071f972009-03-31 15:24:10 -0700123 * This structure is used as collector for nested calls, to check for
124 * maximum recursion dept and loop cycles.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125 */
Davide Libenzi5071f972009-03-31 15:24:10 -0700126struct nested_calls {
127 struct list_head tasks_call_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128 spinlock_t lock;
129};
130
131/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132 * Each file descriptor added to the eventpoll interface will
Davide Libenzi6192bd52007-05-08 00:25:41 -0700133 * have an entry of this type linked to the "rbr" RB tree.
Eric Wong39732ca2013-04-30 15:27:38 -0700134 * Avoid increasing the size of this struct, there can be many thousands
135 * of these on a server and we do not want this to take another cache line.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136 */
137struct epitem {
Jason Baronae10b2b2013-11-12 15:10:16 -0800138 union {
139 /* RB tree node links this structure to the eventpoll RB tree */
140 struct rb_node rbn;
141 /* Used to free the struct epitem */
142 struct rcu_head rcu;
143 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144
145 /* List header used to link this structure to the eventpoll ready list */
146 struct list_head rdllink;
147
Davide Libenzic7ea7632007-05-15 01:40:47 -0700148 /*
149 * Works together "struct eventpoll"->ovflist in keeping the
150 * single linked chain of items.
151 */
152 struct epitem *next;
153
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154 /* The file descriptor information this item refers to */
155 struct epoll_filefd ffd;
156
157 /* Number of active wait queue attached to poll operations */
158 int nwait;
159
160 /* List containing poll wait queues */
161 struct list_head pwqlist;
162
163 /* The "container" of this item */
164 struct eventpoll *ep;
165
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166 /* List header used to link this item to the "struct file" items list */
167 struct list_head fllink;
Davide Libenzid47de162007-05-15 01:40:41 -0700168
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200169 /* wakeup_source used when EPOLLWAKEUP is set */
Eric Wongeea1d582013-04-30 15:27:39 -0700170 struct wakeup_source __rcu *ws;
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200171
Davide Libenzic7ea7632007-05-15 01:40:47 -0700172 /* The structure that describe the interested events and the source fd */
173 struct epoll_event event;
Davide Libenzid47de162007-05-15 01:40:41 -0700174};
175
176/*
177 * This structure is stored inside the "private_data" member of the file
Daniel Balutabf6a41d2011-01-30 23:42:29 +0200178 * structure and represents the main data structure for the eventpoll
Davide Libenzid47de162007-05-15 01:40:41 -0700179 * interface.
180 */
181struct eventpoll {
Davide Libenzid47de162007-05-15 01:40:41 -0700182 /*
183 * This mutex is used to ensure that files are not removed
184 * while epoll is using them. This is held during the event
185 * collection loop, the file cleanup path, the epoll file exit
186 * code and the ctl operations.
187 */
188 struct mutex mtx;
189
190 /* Wait queue used by sys_epoll_wait() */
191 wait_queue_head_t wq;
192
193 /* Wait queue used by file->poll() */
194 wait_queue_head_t poll_wait;
195
196 /* List of ready file descriptors */
197 struct list_head rdllist;
198
Roman Penyaeva218cc42019-03-07 16:28:53 -0800199 /* Lock which protects rdllist and ovflist */
200 rwlock_t lock;
201
Davide Libenzi67647d02007-05-15 01:40:52 -0700202 /* RB tree root used to store monitored fd structs */
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700203 struct rb_root_cached rbr;
Davide Libenzid47de162007-05-15 01:40:41 -0700204
205 /*
206 * This is a single linked list that chains all the "struct epitem" that
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300207 * happened while transferring ready events to userspace w/out
Roman Penyaeva218cc42019-03-07 16:28:53 -0800208 * holding ->lock.
Davide Libenzid47de162007-05-15 01:40:41 -0700209 */
210 struct epitem *ovflist;
Davide Libenzi7ef99642008-12-01 13:13:55 -0800211
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200212 /* wakeup_source used when ep_scan_ready_list is running */
213 struct wakeup_source *ws;
214
Davide Libenzi7ef99642008-12-01 13:13:55 -0800215 /* The user that created the eventpoll descriptor */
216 struct user_struct *user;
Jason Baron28d82dc2012-01-12 17:17:43 -0800217
218 struct file *file;
219
220 /* used to optimize loop detection check */
Al Viro099b7a12020-09-10 08:30:05 -0400221 u64 gen;
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700222
223#ifdef CONFIG_NET_RX_BUSY_POLL
224 /* used to track busy poll napi_id */
225 unsigned int napi_id;
226#endif
Davide Libenzid47de162007-05-15 01:40:41 -0700227};
228
229/* Wait structure used by the poll hooks */
230struct eppoll_entry {
231 /* List header used to link this structure to the "struct epitem" */
232 struct list_head llink;
233
234 /* The "base" pointer is set to the container "struct epitem" */
Tony Battersby4f0989d2009-03-31 15:24:16 -0700235 struct epitem *base;
Davide Libenzid47de162007-05-15 01:40:41 -0700236
237 /*
238 * Wait queue item that will be linked to the target file wait
239 * queue head.
240 */
Ingo Molnarac6424b2017-06-20 12:06:13 +0200241 wait_queue_entry_t wait;
Davide Libenzid47de162007-05-15 01:40:41 -0700242
243 /* The wait queue head that linked the "wait" wait queue item */
244 wait_queue_head_t *whead;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245};
246
247/* Wrapper struct used by poll queueing */
248struct ep_pqueue {
249 poll_table pt;
250 struct epitem *epi;
251};
252
Davide Libenzi5071f972009-03-31 15:24:10 -0700253/* Used by the ep_send_events() function as callback private data */
254struct ep_send_events_data {
255 int maxevents;
256 struct epoll_event __user *events;
Al Virod7ebbe42018-02-01 15:21:13 -0500257 int res;
Davide Libenzi5071f972009-03-31 15:24:10 -0700258};
259
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260/*
Davide Libenzi7ef99642008-12-01 13:13:55 -0800261 * Configuration options available inside /proc/sys/fs/epoll/
262 */
Davide Libenzi7ef99642008-12-01 13:13:55 -0800263/* Maximum number of epoll watched descriptors, per user */
Robin Holt52bd19f72011-01-12 17:00:01 -0800264static long max_user_watches __read_mostly;
Davide Libenzi7ef99642008-12-01 13:13:55 -0800265
266/*
Davide Libenzid47de162007-05-15 01:40:41 -0700267 * This mutex is used to serialize ep_free() and eventpoll_release_file().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268 */
Davide Libenzi7ef99642008-12-01 13:13:55 -0800269static DEFINE_MUTEX(epmutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270
Al Viro099b7a12020-09-10 08:30:05 -0400271static u64 loop_check_gen = 0;
272
Davide Libenzi22bacca2011-02-25 14:44:12 -0800273/* Used to check for epoll file descriptor inclusion loops */
274static struct nested_calls poll_loop_ncalls;
275
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276/* Slab cache used to allocate "struct epitem" */
Christoph Lametere18b8902006-12-06 20:33:20 -0800277static struct kmem_cache *epi_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278
279/* Slab cache used to allocate "struct eppoll_entry" */
Christoph Lametere18b8902006-12-06 20:33:20 -0800280static struct kmem_cache *pwq_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281
Jason Baron28d82dc2012-01-12 17:17:43 -0800282/*
283 * List of files with newly added links, where we may need to limit the number
284 * of emanating paths. Protected by the epmutex.
285 */
286static LIST_HEAD(tfile_check_list);
287
Davide Libenzi7ef99642008-12-01 13:13:55 -0800288#ifdef CONFIG_SYSCTL
289
290#include <linux/sysctl.h>
291
Matteo Croceeec48442019-07-18 15:58:50 -0700292static long long_zero;
Robin Holt52bd19f72011-01-12 17:00:01 -0800293static long long_max = LONG_MAX;
Davide Libenzi7ef99642008-12-01 13:13:55 -0800294
Joe Perches1f7e0612014-06-06 14:38:05 -0700295struct ctl_table epoll_table[] = {
Davide Libenzi7ef99642008-12-01 13:13:55 -0800296 {
Davide Libenzi7ef99642008-12-01 13:13:55 -0800297 .procname = "max_user_watches",
298 .data = &max_user_watches,
Robin Holt52bd19f72011-01-12 17:00:01 -0800299 .maxlen = sizeof(max_user_watches),
Davide Libenzi7ef99642008-12-01 13:13:55 -0800300 .mode = 0644,
Robin Holt52bd19f72011-01-12 17:00:01 -0800301 .proc_handler = proc_doulongvec_minmax,
Matteo Croceeec48442019-07-18 15:58:50 -0700302 .extra1 = &long_zero,
Robin Holt52bd19f72011-01-12 17:00:01 -0800303 .extra2 = &long_max,
Davide Libenzi7ef99642008-12-01 13:13:55 -0800304 },
Eric W. Biedermanab092032009-11-05 14:25:10 -0800305 { }
Davide Libenzi7ef99642008-12-01 13:13:55 -0800306};
307#endif /* CONFIG_SYSCTL */
308
Jason Baron28d82dc2012-01-12 17:17:43 -0800309static const struct file_operations eventpoll_fops;
310
311static inline int is_file_epoll(struct file *f)
312{
313 return f->f_op == &eventpoll_fops;
314}
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700315
Davide Libenzi67647d02007-05-15 01:40:52 -0700316/* Setup the structure that is used as key for the RB tree */
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700317static inline void ep_set_ffd(struct epoll_filefd *ffd,
318 struct file *file, int fd)
319{
320 ffd->file = file;
321 ffd->fd = fd;
322}
323
Davide Libenzi67647d02007-05-15 01:40:52 -0700324/* Compare RB tree keys */
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700325static inline int ep_cmp_ffd(struct epoll_filefd *p1,
326 struct epoll_filefd *p2)
327{
328 return (p1->file > p2->file ? +1:
329 (p1->file < p2->file ? -1 : p1->fd - p2->fd));
330}
331
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700332/* Tells us if the item is currently linked */
Davidlohr Bueso992991c2018-08-21 21:58:26 -0700333static inline int ep_is_linked(struct epitem *epi)
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700334{
Davidlohr Bueso992991c2018-08-21 21:58:26 -0700335 return !list_empty(&epi->rdllink);
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700336}
337
Ingo Molnarac6424b2017-06-20 12:06:13 +0200338static inline struct eppoll_entry *ep_pwq_from_wait(wait_queue_entry_t *p)
Oleg Nesterov971316f2012-02-24 20:07:29 +0100339{
340 return container_of(p, struct eppoll_entry, wait);
341}
342
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700343/* Get the "struct epitem" from a wait queue pointer */
Ingo Molnarac6424b2017-06-20 12:06:13 +0200344static inline struct epitem *ep_item_from_wait(wait_queue_entry_t *p)
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700345{
346 return container_of(p, struct eppoll_entry, wait)->base;
347}
348
349/* Get the "struct epitem" from an epoll queue wrapper */
Davide Libenzicdac75e2008-04-29 00:58:34 -0700350static inline struct epitem *ep_item_from_epqueue(poll_table *p)
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700351{
352 return container_of(p, struct ep_pqueue, pt)->epi;
353}
354
355/* Tells if the epoll_ctl(2) operation needs an event copy from userspace */
Davide Libenzi6192bd52007-05-08 00:25:41 -0700356static inline int ep_op_has_event(int op)
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700357{
Andrew Mortona80a6b82012-11-08 15:53:35 -0800358 return op != EPOLL_CTL_DEL;
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700359}
360
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361/* Initialize the poll safe wake up structure */
Davide Libenzi5071f972009-03-31 15:24:10 -0700362static void ep_nested_calls_init(struct nested_calls *ncalls)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363{
Davide Libenzi5071f972009-03-31 15:24:10 -0700364 INIT_LIST_HEAD(&ncalls->tasks_call_list);
365 spin_lock_init(&ncalls->lock);
366}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367
Davide Libenzi5071f972009-03-31 15:24:10 -0700368/**
Davide Libenzi3fb0e582011-03-22 16:34:46 -0700369 * ep_events_available - Checks if ready events might be available.
370 *
371 * @ep: Pointer to the eventpoll context.
372 *
373 * Returns: Returns a value different than zero if ready events are available,
374 * or zero otherwise.
375 */
376static inline int ep_events_available(struct eventpoll *ep)
377{
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -0800378 return !list_empty_careful(&ep->rdllist) ||
379 READ_ONCE(ep->ovflist) != EP_UNACTIVE_PTR;
Davide Libenzi3fb0e582011-03-22 16:34:46 -0700380}
381
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700382#ifdef CONFIG_NET_RX_BUSY_POLL
383static bool ep_busy_loop_end(void *p, unsigned long start_time)
384{
385 struct eventpoll *ep = p;
386
387 return ep_events_available(ep) || busy_loop_timeout(start_time);
388}
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700389
390/*
391 * Busy poll if globally on and supporting sockets found && no events,
392 * busy loop will return if need_resched or ep_events_available.
393 *
394 * we must do our busy polling with irqs enabled
395 */
396static void ep_busy_loop(struct eventpoll *ep, int nonblock)
397{
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700398 unsigned int napi_id = READ_ONCE(ep->napi_id);
399
400 if ((napi_id >= MIN_NAPI_ID) && net_busy_loop_on())
401 napi_busy_loop(napi_id, nonblock ? NULL : ep_busy_loop_end, ep);
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700402}
403
404static inline void ep_reset_busy_poll_napi_id(struct eventpoll *ep)
405{
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700406 if (ep->napi_id)
407 ep->napi_id = 0;
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700408}
409
410/*
411 * Set epoll busy poll NAPI ID from sk.
412 */
413static inline void ep_set_busy_poll_napi_id(struct epitem *epi)
414{
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700415 struct eventpoll *ep;
416 unsigned int napi_id;
417 struct socket *sock;
418 struct sock *sk;
419 int err;
420
421 if (!net_busy_loop_on())
422 return;
423
424 sock = sock_from_file(epi->ffd.file, &err);
425 if (!sock)
426 return;
427
428 sk = sock->sk;
429 if (!sk)
430 return;
431
432 napi_id = READ_ONCE(sk->sk_napi_id);
433 ep = epi->ep;
434
435 /* Non-NAPI IDs can be rejected
436 * or
437 * Nothing to do if we already have this ID
438 */
439 if (napi_id < MIN_NAPI_ID || napi_id == ep->napi_id)
440 return;
441
442 /* record NAPI ID for use in next busy poll */
443 ep->napi_id = napi_id;
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700444}
445
Davidlohr Bueso514056d2018-08-21 21:58:19 -0700446#else
447
448static inline void ep_busy_loop(struct eventpoll *ep, int nonblock)
449{
450}
451
452static inline void ep_reset_busy_poll_napi_id(struct eventpoll *ep)
453{
454}
455
456static inline void ep_set_busy_poll_napi_id(struct epitem *epi)
457{
458}
459
460#endif /* CONFIG_NET_RX_BUSY_POLL */
461
Davide Libenzi3fb0e582011-03-22 16:34:46 -0700462/**
Davide Libenzi5071f972009-03-31 15:24:10 -0700463 * ep_call_nested - Perform a bound (possibly) nested call, by checking
464 * that the recursion limit is not exceeded, and that
465 * the same nested call (by the meaning of same cookie) is
466 * no re-entered.
467 *
468 * @ncalls: Pointer to the nested_calls structure to be used for this call.
Davide Libenzi5071f972009-03-31 15:24:10 -0700469 * @nproc: Nested call core function pointer.
470 * @priv: Opaque data to be passed to the @nproc callback.
471 * @cookie: Cookie to be used to identify this nested call.
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700472 * @ctx: This instance context.
Davide Libenzi5071f972009-03-31 15:24:10 -0700473 *
474 * Returns: Returns the code returned by the @nproc callback, or -1 if
475 * the maximum recursion limit has been exceeded.
476 */
Davidlohr Bueso74bdc122019-01-03 15:27:02 -0800477static int ep_call_nested(struct nested_calls *ncalls,
Davide Libenzi5071f972009-03-31 15:24:10 -0700478 int (*nproc)(void *, void *, int), void *priv,
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700479 void *cookie, void *ctx)
Davide Libenzi5071f972009-03-31 15:24:10 -0700480{
481 int error, call_nests = 0;
482 unsigned long flags;
Davide Libenzi5071f972009-03-31 15:24:10 -0700483 struct list_head *lsthead = &ncalls->tasks_call_list;
484 struct nested_call_node *tncur;
485 struct nested_call_node tnode;
486
487 spin_lock_irqsave(&ncalls->lock, flags);
488
489 /*
490 * Try to see if the current task is already inside this wakeup call.
491 * We use a list here, since the population inside this set is always
492 * very much limited.
493 */
494 list_for_each_entry(tncur, lsthead, llink) {
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700495 if (tncur->ctx == ctx &&
Davidlohr Bueso74bdc122019-01-03 15:27:02 -0800496 (tncur->cookie == cookie || ++call_nests > EP_MAX_NESTS)) {
Davide Libenzi5071f972009-03-31 15:24:10 -0700497 /*
498 * Ops ... loop detected or maximum nest level reached.
499 * We abort this wake by breaking the cycle itself.
500 */
Tony Battersbyabff55c2009-03-31 15:24:13 -0700501 error = -1;
502 goto out_unlock;
Davide Libenzi5071f972009-03-31 15:24:10 -0700503 }
504 }
505
506 /* Add the current task and cookie to the list */
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700507 tnode.ctx = ctx;
Davide Libenzi5071f972009-03-31 15:24:10 -0700508 tnode.cookie = cookie;
509 list_add(&tnode.llink, lsthead);
510
511 spin_unlock_irqrestore(&ncalls->lock, flags);
512
513 /* Call the nested function */
514 error = (*nproc)(priv, cookie, call_nests);
515
516 /* Remove the current task from the list */
517 spin_lock_irqsave(&ncalls->lock, flags);
518 list_del(&tnode.llink);
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700519out_unlock:
Davide Libenzi5071f972009-03-31 15:24:10 -0700520 spin_unlock_irqrestore(&ncalls->lock, flags);
521
522 return error;
523}
524
Steven Rostedt02edc6f2012-03-23 15:02:27 -0700525/*
526 * As described in commit 0ccf831cb lockdep: annotate epoll
527 * the use of wait queues used by epoll is done in a very controlled
528 * manner. Wake ups can nest inside each other, but are never done
529 * with the same locking. For example:
530 *
531 * dfd = socket(...);
532 * efd1 = epoll_create();
533 * efd2 = epoll_create();
534 * epoll_ctl(efd1, EPOLL_CTL_ADD, dfd, ...);
535 * epoll_ctl(efd2, EPOLL_CTL_ADD, efd1, ...);
536 *
537 * When a packet arrives to the device underneath "dfd", the net code will
538 * issue a wake_up() on its poll wake list. Epoll (efd1) has installed a
539 * callback wakeup entry on that queue, and the wake_up() performed by the
540 * "dfd" net code will end up in ep_poll_callback(). At this point epoll
541 * (efd1) notices that it may have some event ready, so it needs to wake up
542 * the waiters on its poll wait list (efd2). So it calls ep_poll_safewake()
543 * that ends up in another wake_up(), after having checked about the
544 * recursion constraints. That are, no more than EP_MAX_POLLWAKE_NESTS, to
545 * avoid stack blasting.
546 *
547 * When CONFIG_DEBUG_LOCK_ALLOC is enabled, make sure lockdep can handle
548 * this special case of epoll.
549 */
Davide Libenzi2dfa4ee2009-03-31 15:24:22 -0700550#ifdef CONFIG_DEBUG_LOCK_ALLOC
Davide Libenzi2dfa4ee2009-03-31 15:24:22 -0700551
Jason Baron57a173b2017-11-17 15:29:02 -0800552static struct nested_calls poll_safewake_ncalls;
Davide Libenzi2dfa4ee2009-03-31 15:24:22 -0700553
Davide Libenzi5071f972009-03-31 15:24:10 -0700554static int ep_poll_wakeup_proc(void *priv, void *cookie, int call_nests)
555{
Jason Baron57a173b2017-11-17 15:29:02 -0800556 unsigned long flags;
557 wait_queue_head_t *wqueue = (wait_queue_head_t *)cookie;
558
559 spin_lock_irqsave_nested(&wqueue->lock, flags, call_nests + 1);
Linus Torvaldsa9a08842018-02-11 14:34:03 -0800560 wake_up_locked_poll(wqueue, EPOLLIN);
Jason Baron57a173b2017-11-17 15:29:02 -0800561 spin_unlock_irqrestore(&wqueue->lock, flags);
562
Davide Libenzi5071f972009-03-31 15:24:10 -0700563 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564}
565
Davide Libenzi5071f972009-03-31 15:24:10 -0700566static void ep_poll_safewake(wait_queue_head_t *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567{
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700568 int this_cpu = get_cpu();
569
Davidlohr Bueso74bdc122019-01-03 15:27:02 -0800570 ep_call_nested(&poll_safewake_ncalls,
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700571 ep_poll_wakeup_proc, NULL, wq, (void *) (long) this_cpu);
572
573 put_cpu();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574}
575
Jason Baron57a173b2017-11-17 15:29:02 -0800576#else
577
578static void ep_poll_safewake(wait_queue_head_t *wq)
579{
Linus Torvaldsa9a08842018-02-11 14:34:03 -0800580 wake_up_poll(wq, EPOLLIN);
Jason Baron57a173b2017-11-17 15:29:02 -0800581}
582
583#endif
584
Oleg Nesterov971316f2012-02-24 20:07:29 +0100585static void ep_remove_wait_queue(struct eppoll_entry *pwq)
586{
587 wait_queue_head_t *whead;
588
589 rcu_read_lock();
Oleg Nesterov138e4ad2017-09-01 18:55:33 +0200590 /*
591 * If it is cleared by POLLFREE, it should be rcu-safe.
592 * If we read NULL we need a barrier paired with
593 * smp_store_release() in ep_poll_callback(), otherwise
594 * we rely on whead->lock.
595 */
596 whead = smp_load_acquire(&pwq->whead);
Oleg Nesterov971316f2012-02-24 20:07:29 +0100597 if (whead)
598 remove_wait_queue(whead, &pwq->wait);
599 rcu_read_unlock();
600}
601
Davide Libenzi7699acd2007-05-10 22:23:23 -0700602/*
Tony Battersbyd1bc90d2009-03-31 15:24:15 -0700603 * This function unregisters poll callbacks from the associated file
604 * descriptor. Must be called with "mtx" held (or "epmutex" if called from
605 * ep_free).
Davide Libenzi7699acd2007-05-10 22:23:23 -0700606 */
607static void ep_unregister_pollwait(struct eventpoll *ep, struct epitem *epi)
608{
Davide Libenzi7699acd2007-05-10 22:23:23 -0700609 struct list_head *lsthead = &epi->pwqlist;
610 struct eppoll_entry *pwq;
611
Tony Battersbyd1bc90d2009-03-31 15:24:15 -0700612 while (!list_empty(lsthead)) {
613 pwq = list_first_entry(lsthead, struct eppoll_entry, llink);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700614
Tony Battersbyd1bc90d2009-03-31 15:24:15 -0700615 list_del(&pwq->llink);
Oleg Nesterov971316f2012-02-24 20:07:29 +0100616 ep_remove_wait_queue(pwq);
Tony Battersbyd1bc90d2009-03-31 15:24:15 -0700617 kmem_cache_free(pwq_cache, pwq);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700618 }
619}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620
Eric Wongeea1d582013-04-30 15:27:39 -0700621/* call only when ep->mtx is held */
622static inline struct wakeup_source *ep_wakeup_source(struct epitem *epi)
623{
624 return rcu_dereference_check(epi->ws, lockdep_is_held(&epi->ep->mtx));
625}
626
627/* call only when ep->mtx is held */
628static inline void ep_pm_stay_awake(struct epitem *epi)
629{
630 struct wakeup_source *ws = ep_wakeup_source(epi);
631
632 if (ws)
633 __pm_stay_awake(ws);
634}
635
636static inline bool ep_has_wakeup_source(struct epitem *epi)
637{
638 return rcu_access_pointer(epi->ws) ? true : false;
639}
640
641/* call when ep->mtx cannot be held (ep_poll_callback) */
642static inline void ep_pm_stay_awake_rcu(struct epitem *epi)
643{
644 struct wakeup_source *ws;
645
646 rcu_read_lock();
647 ws = rcu_dereference(epi->ws);
648 if (ws)
649 __pm_stay_awake(ws);
650 rcu_read_unlock();
651}
652
Davide Libenzi5071f972009-03-31 15:24:10 -0700653/**
654 * ep_scan_ready_list - Scans the ready list in a way that makes possible for
655 * the scan code, to call f_op->poll(). Also allows for
656 * O(NumReady) performance.
657 *
658 * @ep: Pointer to the epoll private data structure.
659 * @sproc: Pointer to the scan callback.
660 * @priv: Private opaque data passed to the @sproc callback.
Nelson Elhaged8805e62011-10-31 17:13:14 -0700661 * @depth: The current depth of recursive f_op->poll calls.
Jason Baron67347fe2013-11-12 15:10:18 -0800662 * @ep_locked: caller already holds ep->mtx
Davide Libenzi5071f972009-03-31 15:24:10 -0700663 *
664 * Returns: The same integer error code returned by the @sproc callback.
665 */
Al Virod85e2aa2018-02-01 15:24:58 -0500666static __poll_t ep_scan_ready_list(struct eventpoll *ep,
667 __poll_t (*sproc)(struct eventpoll *,
Davide Libenzi5071f972009-03-31 15:24:10 -0700668 struct list_head *, void *),
Jason Baron67347fe2013-11-12 15:10:18 -0800669 void *priv, int depth, bool ep_locked)
Davide Libenzi5071f972009-03-31 15:24:10 -0700670{
Al Virod85e2aa2018-02-01 15:24:58 -0500671 __poll_t res;
672 int pwake = 0;
Davide Libenzi5071f972009-03-31 15:24:10 -0700673 struct epitem *epi, *nepi;
Davide Libenzi296e2362009-03-31 15:24:11 -0700674 LIST_HEAD(txlist);
Davide Libenzi5071f972009-03-31 15:24:10 -0700675
Davidlohr Bueso92e64172018-08-21 21:56:45 -0700676 lockdep_assert_irqs_enabled();
677
Davide Libenzi5071f972009-03-31 15:24:10 -0700678 /*
679 * We need to lock this because we could be hit by
Tony Battersbye057e152009-03-31 15:24:15 -0700680 * eventpoll_release_file() and epoll_ctl().
Davide Libenzi5071f972009-03-31 15:24:10 -0700681 */
Jason Baron67347fe2013-11-12 15:10:18 -0800682
683 if (!ep_locked)
684 mutex_lock_nested(&ep->mtx, depth);
Davide Libenzi5071f972009-03-31 15:24:10 -0700685
686 /*
687 * Steal the ready list, and re-init the original one to the
688 * empty list. Also, set ep->ovflist to NULL so that events
689 * happening while looping w/out locks, are not lost. We cannot
690 * have the poll callback to queue directly on ep->rdllist,
691 * because we want the "sproc" callback to be able to do it
692 * in a lockless way.
693 */
Roman Penyaeva218cc42019-03-07 16:28:53 -0800694 write_lock_irq(&ep->lock);
Davide Libenzi296e2362009-03-31 15:24:11 -0700695 list_splice_init(&ep->rdllist, &txlist);
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -0800696 WRITE_ONCE(ep->ovflist, NULL);
Roman Penyaeva218cc42019-03-07 16:28:53 -0800697 write_unlock_irq(&ep->lock);
Davide Libenzi5071f972009-03-31 15:24:10 -0700698
699 /*
700 * Now call the callback function.
701 */
Al Virod85e2aa2018-02-01 15:24:58 -0500702 res = (*sproc)(ep, &txlist, priv);
Davide Libenzi5071f972009-03-31 15:24:10 -0700703
Roman Penyaeva218cc42019-03-07 16:28:53 -0800704 write_lock_irq(&ep->lock);
Davide Libenzi5071f972009-03-31 15:24:10 -0700705 /*
706 * During the time we spent inside the "sproc" callback, some
707 * other events might have been queued by the poll callback.
708 * We re-insert them inside the main ready-list here.
709 */
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -0800710 for (nepi = READ_ONCE(ep->ovflist); (epi = nepi) != NULL;
Davide Libenzi5071f972009-03-31 15:24:10 -0700711 nepi = epi->next, epi->next = EP_UNACTIVE_PTR) {
712 /*
713 * We need to check if the item is already in the list.
714 * During the "sproc" callback execution time, items are
715 * queued into ->ovflist but the "txlist" might already
716 * contain them, and the list_splice() below takes care of them.
717 */
Davidlohr Bueso992991c2018-08-21 21:58:26 -0700718 if (!ep_is_linked(epi)) {
Roman Penyaevc1411752019-03-07 16:28:46 -0800719 /*
720 * ->ovflist is LIFO, so we have to reverse it in order
721 * to keep in FIFO.
722 */
723 list_add(&epi->rdllink, &ep->rdllist);
Eric Wongeea1d582013-04-30 15:27:39 -0700724 ep_pm_stay_awake(epi);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200725 }
Davide Libenzi5071f972009-03-31 15:24:10 -0700726 }
727 /*
728 * We need to set back ep->ovflist to EP_UNACTIVE_PTR, so that after
729 * releasing the lock, events will be queued in the normal way inside
730 * ep->rdllist.
731 */
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -0800732 WRITE_ONCE(ep->ovflist, EP_UNACTIVE_PTR);
Davide Libenzi5071f972009-03-31 15:24:10 -0700733
734 /*
735 * Quickly re-inject items left on "txlist".
736 */
737 list_splice(&txlist, &ep->rdllist);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200738 __pm_relax(ep->ws);
Davide Libenzi5071f972009-03-31 15:24:10 -0700739
740 if (!list_empty(&ep->rdllist)) {
741 /*
Davide Libenzi296e2362009-03-31 15:24:11 -0700742 * Wake up (if active) both the eventpoll wait list and
743 * the ->poll() wait list (delayed after we release the lock).
Davide Libenzi5071f972009-03-31 15:24:10 -0700744 */
745 if (waitqueue_active(&ep->wq))
Roman Penyaeva218cc42019-03-07 16:28:53 -0800746 wake_up(&ep->wq);
Davide Libenzi5071f972009-03-31 15:24:10 -0700747 if (waitqueue_active(&ep->poll_wait))
748 pwake++;
749 }
Roman Penyaeva218cc42019-03-07 16:28:53 -0800750 write_unlock_irq(&ep->lock);
Davide Libenzi5071f972009-03-31 15:24:10 -0700751
Jason Baron67347fe2013-11-12 15:10:18 -0800752 if (!ep_locked)
753 mutex_unlock(&ep->mtx);
Davide Libenzi5071f972009-03-31 15:24:10 -0700754
755 /* We have to call this outside the lock */
756 if (pwake)
757 ep_poll_safewake(&ep->poll_wait);
758
Al Virod85e2aa2018-02-01 15:24:58 -0500759 return res;
Davide Libenzi5071f972009-03-31 15:24:10 -0700760}
761
Jason Baronae10b2b2013-11-12 15:10:16 -0800762static void epi_rcu_free(struct rcu_head *head)
763{
764 struct epitem *epi = container_of(head, struct epitem, rcu);
765 kmem_cache_free(epi_cache, epi);
766}
767
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768/*
Davide Libenzi7699acd2007-05-10 22:23:23 -0700769 * Removes a "struct epitem" from the eventpoll RB tree and deallocates
Davide Libenzic7ea7632007-05-15 01:40:47 -0700770 * all the associated resources. Must be called with "mtx" held.
Davide Libenzi7699acd2007-05-10 22:23:23 -0700771 */
772static int ep_remove(struct eventpoll *ep, struct epitem *epi)
773{
Davide Libenzi7699acd2007-05-10 22:23:23 -0700774 struct file *file = epi->ffd.file;
775
Davidlohr Bueso92e64172018-08-21 21:56:45 -0700776 lockdep_assert_irqs_enabled();
777
Davide Libenzi7699acd2007-05-10 22:23:23 -0700778 /*
Christoph Hellwigee8ef0a2018-08-21 21:56:26 -0700779 * Removes poll wait queue hooks.
Davide Libenzi7699acd2007-05-10 22:23:23 -0700780 */
781 ep_unregister_pollwait(ep, epi);
782
783 /* Remove the current item from the list of epoll hooks */
Jonathan Corbet68499912009-02-06 13:52:43 -0700784 spin_lock(&file->f_lock);
Jason Baronae10b2b2013-11-12 15:10:16 -0800785 list_del_rcu(&epi->fllink);
Jonathan Corbet68499912009-02-06 13:52:43 -0700786 spin_unlock(&file->f_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700788 rb_erase_cached(&epi->rbn, &ep->rbr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789
Roman Penyaeva218cc42019-03-07 16:28:53 -0800790 write_lock_irq(&ep->lock);
Davidlohr Bueso992991c2018-08-21 21:58:26 -0700791 if (ep_is_linked(epi))
Davide Libenzic7ea7632007-05-15 01:40:47 -0700792 list_del_init(&epi->rdllink);
Roman Penyaeva218cc42019-03-07 16:28:53 -0800793 write_unlock_irq(&ep->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794
Eric Wongeea1d582013-04-30 15:27:39 -0700795 wakeup_source_unregister(ep_wakeup_source(epi));
Jason Baronae10b2b2013-11-12 15:10:16 -0800796 /*
797 * At this point it is safe to free the eventpoll item. Use the union
798 * field epi->rcu, since we are trying to minimize the size of
799 * 'struct epitem'. The 'rbn' field is no longer in use. Protected by
800 * ep->mtx. The rcu read side, reverse_path_check_proc(), does not make
801 * use of the rbn field.
802 */
803 call_rcu(&epi->rcu, epi_rcu_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804
Robin Holt52bd19f72011-01-12 17:00:01 -0800805 atomic_long_dec(&ep->user->epoll_watches);
Davide Libenzi7ef99642008-12-01 13:13:55 -0800806
Davide Libenzic7ea7632007-05-15 01:40:47 -0700807 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808}
809
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810static void ep_free(struct eventpoll *ep)
811{
812 struct rb_node *rbp;
813 struct epitem *epi;
814
815 /* We need to release all tasks waiting for these file */
816 if (waitqueue_active(&ep->poll_wait))
Davide Libenzi5071f972009-03-31 15:24:10 -0700817 ep_poll_safewake(&ep->poll_wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818
819 /*
820 * We need to lock this because we could be hit by
821 * eventpoll_release_file() while we're freeing the "struct eventpoll".
Davide Libenzid47de162007-05-15 01:40:41 -0700822 * We do not need to hold "ep->mtx" here because the epoll file
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823 * is on the way to be removed and no one has references to it
824 * anymore. The only hit might come from eventpoll_release_file() but
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300825 * holding "epmutex" is sufficient here.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826 */
Arjan van de Ven144efe32006-03-23 03:00:32 -0800827 mutex_lock(&epmutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828
829 /*
830 * Walks through the whole tree by unregistering poll callbacks.
831 */
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700832 for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833 epi = rb_entry(rbp, struct epitem, rbn);
834
835 ep_unregister_pollwait(ep, epi);
Eric Dumazet91cf5ab2013-09-11 14:24:06 -0700836 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837 }
838
839 /*
Davide Libenzi6192bd52007-05-08 00:25:41 -0700840 * Walks through the whole tree by freeing each "struct epitem". At this
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841 * point we are sure no poll callbacks will be lingering around, and also by
Davide Libenzid47de162007-05-15 01:40:41 -0700842 * holding "epmutex" we can be sure that no file cleanup code will hit
Roman Penyaeva218cc42019-03-07 16:28:53 -0800843 * us during this operation. So we can avoid the lock on "ep->lock".
Eric Wongddf676c2013-04-30 15:27:40 -0700844 * We do not need to lock ep->mtx, either, we only do it to prevent
845 * a lockdep warning.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846 */
Eric Wongddf676c2013-04-30 15:27:40 -0700847 mutex_lock(&ep->mtx);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700848 while ((rbp = rb_first_cached(&ep->rbr)) != NULL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849 epi = rb_entry(rbp, struct epitem, rbn);
850 ep_remove(ep, epi);
Eric Dumazet91cf5ab2013-09-11 14:24:06 -0700851 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852 }
Eric Wongddf676c2013-04-30 15:27:40 -0700853 mutex_unlock(&ep->mtx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854
Arjan van de Ven144efe32006-03-23 03:00:32 -0800855 mutex_unlock(&epmutex);
Davide Libenzid47de162007-05-15 01:40:41 -0700856 mutex_destroy(&ep->mtx);
Davide Libenzi7ef99642008-12-01 13:13:55 -0800857 free_uid(ep->user);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200858 wakeup_source_unregister(ep->ws);
Davide Libenzif0ee9aa2007-05-15 01:40:57 -0700859 kfree(ep);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860}
861
Davide Libenzi7699acd2007-05-10 22:23:23 -0700862static int ep_eventpoll_release(struct inode *inode, struct file *file)
863{
864 struct eventpoll *ep = file->private_data;
865
Davide Libenzif0ee9aa2007-05-15 01:40:57 -0700866 if (ep)
Davide Libenzi7699acd2007-05-10 22:23:23 -0700867 ep_free(ep);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700868
Davide Libenzi7699acd2007-05-10 22:23:23 -0700869 return 0;
870}
871
Al Virod85e2aa2018-02-01 15:24:58 -0500872static __poll_t ep_read_events_proc(struct eventpoll *ep, struct list_head *head,
Jason Baron37b5e522017-11-17 15:29:06 -0800873 void *priv);
874static void ep_ptable_queue_proc(struct file *file, wait_queue_head_t *whead,
875 poll_table *pt);
Eric Wong450d89e2013-04-30 15:27:42 -0700876
Jason Baron37b5e522017-11-17 15:29:06 -0800877/*
878 * Differs from ep_eventpoll_poll() in that internal callers already have
879 * the ep->mtx so we need to start from depth=1, such that mutex_lock_nested()
880 * is correctly annotated.
881 */
Al Virod85e2aa2018-02-01 15:24:58 -0500882static __poll_t ep_item_poll(const struct epitem *epi, poll_table *pt,
Al Virobec1a5022017-11-28 19:43:33 -0500883 int depth)
Jason Baron37b5e522017-11-17 15:29:06 -0800884{
885 struct eventpoll *ep;
886 bool locked;
887
888 pt->_key = epi->event.events;
889 if (!is_file_epoll(epi->ffd.file))
Christoph Hellwig9965ed172018-03-05 07:26:05 -0800890 return vfs_poll(epi->ffd.file, pt) & epi->event.events;
Jason Baron37b5e522017-11-17 15:29:06 -0800891
892 ep = epi->ffd.file->private_data;
893 poll_wait(epi->ffd.file, &ep->poll_wait, pt);
894 locked = pt && (pt->_qproc == ep_ptable_queue_proc);
895
896 return ep_scan_ready_list(epi->ffd.file->private_data,
897 ep_read_events_proc, &depth, depth,
898 locked) & epi->event.events;
Eric Wong450d89e2013-04-30 15:27:42 -0700899}
900
Al Virod85e2aa2018-02-01 15:24:58 -0500901static __poll_t ep_read_events_proc(struct eventpoll *ep, struct list_head *head,
Davide Libenzi296e2362009-03-31 15:24:11 -0700902 void *priv)
Davide Libenzi5071f972009-03-31 15:24:10 -0700903{
904 struct epitem *epi, *tmp;
Hans Verkuil626cf232012-03-23 15:02:27 -0700905 poll_table pt;
Jason Baron37b5e522017-11-17 15:29:06 -0800906 int depth = *(int *)priv;
Davide Libenzi5071f972009-03-31 15:24:10 -0700907
Hans Verkuil626cf232012-03-23 15:02:27 -0700908 init_poll_funcptr(&pt, NULL);
Jason Baron37b5e522017-11-17 15:29:06 -0800909 depth++;
Eric Wong450d89e2013-04-30 15:27:42 -0700910
Davide Libenzi5071f972009-03-31 15:24:10 -0700911 list_for_each_entry_safe(epi, tmp, head, rdllink) {
Jason Baron37b5e522017-11-17 15:29:06 -0800912 if (ep_item_poll(epi, &pt, depth)) {
Linus Torvaldsa9a08842018-02-11 14:34:03 -0800913 return EPOLLIN | EPOLLRDNORM;
Jason Baron37b5e522017-11-17 15:29:06 -0800914 } else {
Davide Libenzi5071f972009-03-31 15:24:10 -0700915 /*
916 * Item has been dropped into the ready list by the poll
917 * callback, but it's not actually ready, as far as
918 * caller requested events goes. We can remove it here.
919 */
Eric Wongeea1d582013-04-30 15:27:39 -0700920 __pm_relax(ep_wakeup_source(epi));
Davide Libenzi5071f972009-03-31 15:24:10 -0700921 list_del_init(&epi->rdllink);
Davide Libenzi296e2362009-03-31 15:24:11 -0700922 }
Davide Libenzi5071f972009-03-31 15:24:10 -0700923 }
924
925 return 0;
926}
927
Linus Torvaldsa11e1d42018-06-28 09:43:44 -0700928static __poll_t ep_eventpoll_poll(struct file *file, poll_table *wait)
Davide Libenzi7699acd2007-05-10 22:23:23 -0700929{
Davide Libenzi7699acd2007-05-10 22:23:23 -0700930 struct eventpoll *ep = file->private_data;
Jason Baron37b5e522017-11-17 15:29:06 -0800931 int depth = 0;
Davide Libenzi7699acd2007-05-10 22:23:23 -0700932
Linus Torvaldsa11e1d42018-06-28 09:43:44 -0700933 /* Insert inside our poll wait queue */
934 poll_wait(file, &ep->poll_wait, wait);
935
Davide Libenzi5071f972009-03-31 15:24:10 -0700936 /*
937 * Proceed to find out if wanted events are really available inside
Jason Baron37b5e522017-11-17 15:29:06 -0800938 * the ready list.
Davide Libenzi5071f972009-03-31 15:24:10 -0700939 */
Jason Baron37b5e522017-11-17 15:29:06 -0800940 return ep_scan_ready_list(ep, ep_read_events_proc,
941 &depth, depth, false);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700942}
943
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800944#ifdef CONFIG_PROC_FS
Joe Perchesa3816ab2014-09-29 16:08:25 -0700945static void ep_show_fdinfo(struct seq_file *m, struct file *f)
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800946{
947 struct eventpoll *ep = f->private_data;
948 struct rb_node *rbp;
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800949
950 mutex_lock(&ep->mtx);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700951 for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) {
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800952 struct epitem *epi = rb_entry(rbp, struct epitem, rbn);
Cyrill Gorcunov77493f02017-07-12 14:34:25 -0700953 struct inode *inode = file_inode(epi->ffd.file);
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800954
Cyrill Gorcunov77493f02017-07-12 14:34:25 -0700955 seq_printf(m, "tfd: %8d events: %8x data: %16llx "
956 " pos:%lli ino:%lx sdev:%x\n",
Joe Perchesa3816ab2014-09-29 16:08:25 -0700957 epi->ffd.fd, epi->event.events,
Cyrill Gorcunov77493f02017-07-12 14:34:25 -0700958 (long long)epi->event.data,
959 (long long)epi->ffd.file->f_pos,
960 inode->i_ino, inode->i_sb->s_dev);
Joe Perchesa3816ab2014-09-29 16:08:25 -0700961 if (seq_has_overflowed(m))
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800962 break;
963 }
964 mutex_unlock(&ep->mtx);
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800965}
966#endif
967
Davide Libenzi7699acd2007-05-10 22:23:23 -0700968/* File callbacks that implement the eventpoll file behaviour */
969static const struct file_operations eventpoll_fops = {
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800970#ifdef CONFIG_PROC_FS
971 .show_fdinfo = ep_show_fdinfo,
972#endif
Davide Libenzi7699acd2007-05-10 22:23:23 -0700973 .release = ep_eventpoll_release,
Linus Torvaldsa11e1d42018-06-28 09:43:44 -0700974 .poll = ep_eventpoll_poll,
Arnd Bergmann6038f372010-08-15 18:52:59 +0200975 .llseek = noop_llseek,
Davide Libenzi7699acd2007-05-10 22:23:23 -0700976};
977
Davide Libenzi7699acd2007-05-10 22:23:23 -0700978/*
979 * This is called from eventpoll_release() to unlink files from the eventpoll
980 * interface. We need to have this facility to cleanup correctly files that are
981 * closed without being removed from the eventpoll interface.
982 */
983void eventpoll_release_file(struct file *file)
984{
Davide Libenzi7699acd2007-05-10 22:23:23 -0700985 struct eventpoll *ep;
Konstantin Khlebnikovebe06182014-06-17 06:58:05 +0400986 struct epitem *epi, *next;
Davide Libenzi7699acd2007-05-10 22:23:23 -0700987
988 /*
Jonathan Corbet68499912009-02-06 13:52:43 -0700989 * We don't want to get "file->f_lock" because it is not
Davide Libenzi7699acd2007-05-10 22:23:23 -0700990 * necessary. It is not necessary because we're in the "struct file"
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300991 * cleanup path, and this means that no one is using this file anymore.
Davide Libenzi5071f972009-03-31 15:24:10 -0700992 * So, for example, epoll_ctl() cannot hit here since if we reach this
Davide Libenzi67647d02007-05-15 01:40:52 -0700993 * point, the file counter already went to zero and fget() would fail.
Davide Libenzid47de162007-05-15 01:40:41 -0700994 * The only hit might come from ep_free() but by holding the mutex
Davide Libenzi7699acd2007-05-10 22:23:23 -0700995 * will correctly serialize the operation. We do need to acquire
Davide Libenzid47de162007-05-15 01:40:41 -0700996 * "ep->mtx" after "epmutex" because ep_remove() requires it when called
Davide Libenzi7699acd2007-05-10 22:23:23 -0700997 * from anywhere but ep_free().
Jonathan Corbet68499912009-02-06 13:52:43 -0700998 *
999 * Besides, ep_remove() acquires the lock, so we can't hold it here.
Davide Libenzi7699acd2007-05-10 22:23:23 -07001000 */
1001 mutex_lock(&epmutex);
Konstantin Khlebnikovebe06182014-06-17 06:58:05 +04001002 list_for_each_entry_safe(epi, next, &file->f_ep_links, fllink) {
Davide Libenzi7699acd2007-05-10 22:23:23 -07001003 ep = epi->ep;
Nelson Elhaged8805e62011-10-31 17:13:14 -07001004 mutex_lock_nested(&ep->mtx, 0);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001005 ep_remove(ep, epi);
Davide Libenzid47de162007-05-15 01:40:41 -07001006 mutex_unlock(&ep->mtx);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001007 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07001008 mutex_unlock(&epmutex);
1009}
1010
1011static int ep_alloc(struct eventpoll **pep)
1012{
Davide Libenzi7ef99642008-12-01 13:13:55 -08001013 int error;
1014 struct user_struct *user;
1015 struct eventpoll *ep;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001016
Davide Libenzi7ef99642008-12-01 13:13:55 -08001017 user = get_current_user();
Davide Libenzi7ef99642008-12-01 13:13:55 -08001018 error = -ENOMEM;
1019 ep = kzalloc(sizeof(*ep), GFP_KERNEL);
1020 if (unlikely(!ep))
1021 goto free_uid;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001022
Davide Libenzid47de162007-05-15 01:40:41 -07001023 mutex_init(&ep->mtx);
Roman Penyaeva218cc42019-03-07 16:28:53 -08001024 rwlock_init(&ep->lock);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001025 init_waitqueue_head(&ep->wq);
1026 init_waitqueue_head(&ep->poll_wait);
1027 INIT_LIST_HEAD(&ep->rdllist);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001028 ep->rbr = RB_ROOT_CACHED;
Davide Libenzid47de162007-05-15 01:40:41 -07001029 ep->ovflist = EP_UNACTIVE_PTR;
Davide Libenzi7ef99642008-12-01 13:13:55 -08001030 ep->user = user;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001031
1032 *pep = ep;
1033
Davide Libenzi7699acd2007-05-10 22:23:23 -07001034 return 0;
Davide Libenzi7ef99642008-12-01 13:13:55 -08001035
1036free_uid:
1037 free_uid(user);
1038 return error;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001039}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001040
1041/*
Davide Libenzic7ea7632007-05-15 01:40:47 -07001042 * Search the file inside the eventpoll tree. The RB tree operations
1043 * are protected by the "mtx" mutex, and ep_find() must be called with
1044 * "mtx" held.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001045 */
1046static struct epitem *ep_find(struct eventpoll *ep, struct file *file, int fd)
1047{
1048 int kcmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001049 struct rb_node *rbp;
1050 struct epitem *epi, *epir = NULL;
1051 struct epoll_filefd ffd;
1052
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001053 ep_set_ffd(&ffd, file, fd);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001054 for (rbp = ep->rbr.rb_root.rb_node; rbp; ) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001055 epi = rb_entry(rbp, struct epitem, rbn);
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001056 kcmp = ep_cmp_ffd(&ffd, &epi->ffd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001057 if (kcmp > 0)
1058 rbp = rbp->rb_right;
1059 else if (kcmp < 0)
1060 rbp = rbp->rb_left;
1061 else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001062 epir = epi;
1063 break;
1064 }
1065 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066
Linus Torvalds1da177e2005-04-16 15:20:36 -07001067 return epir;
1068}
1069
Cyrill Gorcunov92ef6da2017-07-12 14:34:31 -07001070#ifdef CONFIG_CHECKPOINT_RESTORE
Cyrill Gorcunov0791e362017-07-12 14:34:28 -07001071static struct epitem *ep_find_tfd(struct eventpoll *ep, int tfd, unsigned long toff)
1072{
1073 struct rb_node *rbp;
1074 struct epitem *epi;
1075
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001076 for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) {
Cyrill Gorcunov0791e362017-07-12 14:34:28 -07001077 epi = rb_entry(rbp, struct epitem, rbn);
1078 if (epi->ffd.fd == tfd) {
1079 if (toff == 0)
1080 return epi;
1081 else
1082 toff--;
1083 }
1084 cond_resched();
1085 }
1086
1087 return NULL;
1088}
1089
1090struct file *get_epoll_tfile_raw_ptr(struct file *file, int tfd,
1091 unsigned long toff)
1092{
1093 struct file *file_raw;
1094 struct eventpoll *ep;
1095 struct epitem *epi;
1096
1097 if (!is_file_epoll(file))
1098 return ERR_PTR(-EINVAL);
1099
1100 ep = file->private_data;
1101
1102 mutex_lock(&ep->mtx);
1103 epi = ep_find_tfd(ep, tfd, toff);
1104 if (epi)
1105 file_raw = epi->ffd.file;
1106 else
1107 file_raw = ERR_PTR(-ENOENT);
1108 mutex_unlock(&ep->mtx);
1109
1110 return file_raw;
1111}
Cyrill Gorcunov92ef6da2017-07-12 14:34:31 -07001112#endif /* CONFIG_CHECKPOINT_RESTORE */
Cyrill Gorcunov0791e362017-07-12 14:34:28 -07001113
Roman Penyaeva218cc42019-03-07 16:28:53 -08001114/**
1115 * Adds a new entry to the tail of the list in a lockless way, i.e.
1116 * multiple CPUs are allowed to call this function concurrently.
1117 *
1118 * Beware: it is necessary to prevent any other modifications of the
1119 * existing list until all changes are completed, in other words
1120 * concurrent list_add_tail_lockless() calls should be protected
1121 * with a read lock, where write lock acts as a barrier which
1122 * makes sure all list_add_tail_lockless() calls are fully
1123 * completed.
1124 *
1125 * Also an element can be locklessly added to the list only in one
1126 * direction i.e. either to the tail either to the head, otherwise
1127 * concurrent access will corrupt the list.
1128 *
1129 * Returns %false if element has been already added to the list, %true
1130 * otherwise.
1131 */
1132static inline bool list_add_tail_lockless(struct list_head *new,
1133 struct list_head *head)
1134{
1135 struct list_head *prev;
1136
1137 /*
1138 * This is simple 'new->next = head' operation, but cmpxchg()
1139 * is used in order to detect that same element has been just
1140 * added to the list from another CPU: the winner observes
1141 * new->next == new.
1142 */
1143 if (cmpxchg(&new->next, new, head) != new)
1144 return false;
1145
1146 /*
1147 * Initially ->next of a new element must be updated with the head
1148 * (we are inserting to the tail) and only then pointers are atomically
1149 * exchanged. XCHG guarantees memory ordering, thus ->next should be
1150 * updated before pointers are actually swapped and pointers are
1151 * swapped before prev->next is updated.
1152 */
1153
1154 prev = xchg(&head->prev, new);
1155
1156 /*
1157 * It is safe to modify prev->next and new->prev, because a new element
1158 * is added only to the tail and new->next is updated before XCHG.
1159 */
1160
1161 prev->next = new;
1162 new->prev = prev;
1163
1164 return true;
1165}
1166
1167/**
1168 * Chains a new epi entry to the tail of the ep->ovflist in a lockless way,
1169 * i.e. multiple CPUs are allowed to call this function concurrently.
1170 *
1171 * Returns %false if epi element has been already chained, %true otherwise.
1172 */
1173static inline bool chain_epi_lockless(struct epitem *epi)
1174{
1175 struct eventpoll *ep = epi->ep;
1176
Khazhismel Kumykovee922a22020-05-07 18:35:59 -07001177 /* Fast preliminary check */
1178 if (epi->next != EP_UNACTIVE_PTR)
1179 return false;
1180
Roman Penyaeva218cc42019-03-07 16:28:53 -08001181 /* Check that the same epi has not been just chained from another CPU */
1182 if (cmpxchg(&epi->next, EP_UNACTIVE_PTR, NULL) != EP_UNACTIVE_PTR)
1183 return false;
1184
1185 /* Atomically exchange tail */
1186 epi->next = xchg(&ep->ovflist, epi);
1187
1188 return true;
1189}
1190
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191/*
Davide Libenzi7699acd2007-05-10 22:23:23 -07001192 * This is the callback that is passed to the wait queue wakeup
Daniel Balutabf6a41d2011-01-30 23:42:29 +02001193 * mechanism. It is called by the stored file descriptors when they
Davide Libenzi7699acd2007-05-10 22:23:23 -07001194 * have events to report.
Roman Penyaeva218cc42019-03-07 16:28:53 -08001195 *
1196 * This callback takes a read lock in order not to content with concurrent
1197 * events from another file descriptors, thus all modifications to ->rdllist
1198 * or ->ovflist are lockless. Read lock is paired with the write lock from
1199 * ep_scan_ready_list(), which stops all list modifications and guarantees
1200 * that lists state is seen correctly.
1201 *
1202 * Another thing worth to mention is that ep_poll_callback() can be called
1203 * concurrently for the same @epi from different CPUs if poll table was inited
1204 * with several wait queues entries. Plural wakeup from different CPUs of a
1205 * single wait queue is serialized by wq.lock, but the case when multiple wait
1206 * queues are used should be detected accordingly. This is detected using
1207 * cmpxchg() operation.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001208 */
Ingo Molnarac6424b2017-06-20 12:06:13 +02001209static int ep_poll_callback(wait_queue_entry_t *wait, unsigned mode, int sync, void *key)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001210{
Davide Libenzi7699acd2007-05-10 22:23:23 -07001211 int pwake = 0;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001212 struct epitem *epi = ep_item_from_wait(wait);
1213 struct eventpoll *ep = epi->ep;
Al Viro3ad6f932017-07-03 20:14:56 -04001214 __poll_t pollflags = key_to_poll(key);
Roman Penyaeva218cc42019-03-07 16:28:53 -08001215 unsigned long flags;
Jason Barondf0108c2016-01-20 14:59:24 -08001216 int ewake = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001217
Roman Penyaeva218cc42019-03-07 16:28:53 -08001218 read_lock_irqsave(&ep->lock, flags);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001219
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -07001220 ep_set_busy_poll_napi_id(epi);
1221
Davide Libenzi7699acd2007-05-10 22:23:23 -07001222 /*
1223 * If the event mask does not contain any poll(2) event, we consider the
1224 * descriptor to be disabled. This condition is likely the effect of the
1225 * EPOLLONESHOT bit that disables the descriptor when an event is received,
1226 * until the next EPOLL_CTL_MOD will be issued.
1227 */
1228 if (!(epi->event.events & ~EP_PRIVATE_BITS))
Davide Libenzid47de162007-05-15 01:40:41 -07001229 goto out_unlock;
1230
1231 /*
Davide Libenzi2dfa4ee2009-03-31 15:24:22 -07001232 * Check the events coming with the callback. At this stage, not
1233 * every device reports the events in the "key" parameter of the
1234 * callback. We need to be able to handle both cases here, hence the
1235 * test for "key" != NULL before the event match test.
1236 */
Al Viro3ad6f932017-07-03 20:14:56 -04001237 if (pollflags && !(pollflags & epi->event.events))
Davide Libenzi2dfa4ee2009-03-31 15:24:22 -07001238 goto out_unlock;
1239
1240 /*
Daniel Balutabf6a41d2011-01-30 23:42:29 +02001241 * If we are transferring events to userspace, we can hold no locks
Davide Libenzid47de162007-05-15 01:40:41 -07001242 * (because we're accessing user memory, and because of linux f_op->poll()
Daniel Balutabf6a41d2011-01-30 23:42:29 +02001243 * semantics). All the events that happen during that period of time are
Davide Libenzid47de162007-05-15 01:40:41 -07001244 * chained in ep->ovflist and requeued later on.
1245 */
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001246 if (READ_ONCE(ep->ovflist) != EP_UNACTIVE_PTR) {
Khazhismel Kumykovee922a22020-05-07 18:35:59 -07001247 if (chain_epi_lockless(epi))
Roman Penyaevc3e320b2019-03-07 16:28:49 -08001248 ep_pm_stay_awake_rcu(epi);
Khazhismel Kumykovee922a22020-05-07 18:35:59 -07001249 } else if (!ep_is_linked(epi)) {
1250 /* In the usual case, add event to ready list. */
1251 if (list_add_tail_lockless(&epi->rdllink, &ep->rdllist))
1252 ep_pm_stay_awake_rcu(epi);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001253 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07001254
Davide Libenzi7699acd2007-05-10 22:23:23 -07001255 /*
1256 * Wake up ( if active ) both the eventpoll wait list and the ->poll()
1257 * wait list.
1258 */
Jason Barondf0108c2016-01-20 14:59:24 -08001259 if (waitqueue_active(&ep->wq)) {
Jason Baronb6a515c2016-02-05 15:37:04 -08001260 if ((epi->event.events & EPOLLEXCLUSIVE) &&
Al Viro3ad6f932017-07-03 20:14:56 -04001261 !(pollflags & POLLFREE)) {
1262 switch (pollflags & EPOLLINOUT_BITS) {
Linus Torvaldsa9a08842018-02-11 14:34:03 -08001263 case EPOLLIN:
1264 if (epi->event.events & EPOLLIN)
Jason Baronb6a515c2016-02-05 15:37:04 -08001265 ewake = 1;
1266 break;
Linus Torvaldsa9a08842018-02-11 14:34:03 -08001267 case EPOLLOUT:
1268 if (epi->event.events & EPOLLOUT)
Jason Baronb6a515c2016-02-05 15:37:04 -08001269 ewake = 1;
1270 break;
1271 case 0:
1272 ewake = 1;
1273 break;
1274 }
1275 }
Roman Penyaeva218cc42019-03-07 16:28:53 -08001276 wake_up(&ep->wq);
Jason Barondf0108c2016-01-20 14:59:24 -08001277 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07001278 if (waitqueue_active(&ep->poll_wait))
1279 pwake++;
1280
Davide Libenzid47de162007-05-15 01:40:41 -07001281out_unlock:
Roman Penyaeva218cc42019-03-07 16:28:53 -08001282 read_unlock_irqrestore(&ep->lock, flags);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001283
1284 /* We have to call this outside the lock */
1285 if (pwake)
Davide Libenzi5071f972009-03-31 15:24:10 -07001286 ep_poll_safewake(&ep->poll_wait);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001287
Oleg Nesterov138e4ad2017-09-01 18:55:33 +02001288 if (!(epi->event.events & EPOLLEXCLUSIVE))
1289 ewake = 1;
Jason Barondf0108c2016-01-20 14:59:24 -08001290
Al Viro3ad6f932017-07-03 20:14:56 -04001291 if (pollflags & POLLFREE) {
Oleg Nesterov138e4ad2017-09-01 18:55:33 +02001292 /*
1293 * If we race with ep_remove_wait_queue() it can miss
1294 * ->whead = NULL and do another remove_wait_queue() after
1295 * us, so we can't use __remove_wait_queue().
1296 */
1297 list_del_init(&wait->entry);
1298 /*
1299 * ->whead != NULL protects us from the race with ep_free()
1300 * or ep_remove(), ep_remove_wait_queue() takes whead->lock
1301 * held by the caller. Once we nullify it, nothing protects
1302 * ep/epi or even wait.
1303 */
1304 smp_store_release(&ep_pwq_from_wait(wait)->whead, NULL);
1305 }
1306
1307 return ewake;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001308}
1309
Linus Torvalds1da177e2005-04-16 15:20:36 -07001310/*
1311 * This is the callback that is used to add our wait queue to the
1312 * target file wakeup lists.
1313 */
1314static void ep_ptable_queue_proc(struct file *file, wait_queue_head_t *whead,
1315 poll_table *pt)
1316{
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001317 struct epitem *epi = ep_item_from_epqueue(pt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001318 struct eppoll_entry *pwq;
1319
Christoph Lametere94b1762006-12-06 20:33:17 -08001320 if (epi->nwait >= 0 && (pwq = kmem_cache_alloc(pwq_cache, GFP_KERNEL))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321 init_waitqueue_func_entry(&pwq->wait, ep_poll_callback);
1322 pwq->whead = whead;
1323 pwq->base = epi;
Jason Barondf0108c2016-01-20 14:59:24 -08001324 if (epi->event.events & EPOLLEXCLUSIVE)
1325 add_wait_queue_exclusive(whead, &pwq->wait);
1326 else
1327 add_wait_queue(whead, &pwq->wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328 list_add_tail(&pwq->llink, &epi->pwqlist);
1329 epi->nwait++;
Davide Libenzi296e2362009-03-31 15:24:11 -07001330 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331 /* We have to signal that an error occurred */
1332 epi->nwait = -1;
Davide Libenzi296e2362009-03-31 15:24:11 -07001333 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001334}
1335
Linus Torvalds1da177e2005-04-16 15:20:36 -07001336static void ep_rbtree_insert(struct eventpoll *ep, struct epitem *epi)
1337{
1338 int kcmp;
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001339 struct rb_node **p = &ep->rbr.rb_root.rb_node, *parent = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340 struct epitem *epic;
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001341 bool leftmost = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001342
1343 while (*p) {
1344 parent = *p;
1345 epic = rb_entry(parent, struct epitem, rbn);
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001346 kcmp = ep_cmp_ffd(&epi->ffd, &epic->ffd);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001347 if (kcmp > 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001348 p = &parent->rb_right;
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001349 leftmost = false;
1350 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351 p = &parent->rb_left;
1352 }
1353 rb_link_node(&epi->rbn, parent, p);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001354 rb_insert_color_cached(&epi->rbn, &ep->rbr, leftmost);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355}
1356
Andrew Mortona80a6b82012-11-08 15:53:35 -08001357
1358
Jason Baron28d82dc2012-01-12 17:17:43 -08001359#define PATH_ARR_SIZE 5
1360/*
1361 * These are the number paths of length 1 to 5, that we are allowing to emanate
1362 * from a single file of interest. For example, we allow 1000 paths of length
1363 * 1, to emanate from each file of interest. This essentially represents the
1364 * potential wakeup paths, which need to be limited in order to avoid massive
1365 * uncontrolled wakeup storms. The common use case should be a single ep which
1366 * is connected to n file sources. In this case each file source has 1 path
1367 * of length 1. Thus, the numbers below should be more than sufficient. These
1368 * path limits are enforced during an EPOLL_CTL_ADD operation, since a modify
1369 * and delete can't add additional paths. Protected by the epmutex.
1370 */
1371static const int path_limits[PATH_ARR_SIZE] = { 1000, 500, 100, 50, 10 };
1372static int path_count[PATH_ARR_SIZE];
1373
1374static int path_count_inc(int nests)
1375{
Jason Baron93dc6102012-03-16 16:34:03 -04001376 /* Allow an arbitrary number of depth 1 paths */
1377 if (nests == 0)
1378 return 0;
1379
Jason Baron28d82dc2012-01-12 17:17:43 -08001380 if (++path_count[nests] > path_limits[nests])
1381 return -1;
1382 return 0;
1383}
1384
1385static void path_count_init(void)
1386{
1387 int i;
1388
1389 for (i = 0; i < PATH_ARR_SIZE; i++)
1390 path_count[i] = 0;
1391}
1392
1393static int reverse_path_check_proc(void *priv, void *cookie, int call_nests)
1394{
1395 int error = 0;
1396 struct file *file = priv;
1397 struct file *child_file;
1398 struct epitem *epi;
1399
Jason Baronae10b2b2013-11-12 15:10:16 -08001400 /* CTL_DEL can remove links here, but that can't increase our count */
1401 rcu_read_lock();
1402 list_for_each_entry_rcu(epi, &file->f_ep_links, fllink) {
Jason Baron28d82dc2012-01-12 17:17:43 -08001403 child_file = epi->ep->file;
1404 if (is_file_epoll(child_file)) {
1405 if (list_empty(&child_file->f_ep_links)) {
1406 if (path_count_inc(call_nests)) {
1407 error = -1;
1408 break;
1409 }
1410 } else {
1411 error = ep_call_nested(&poll_loop_ncalls,
Jason Baron28d82dc2012-01-12 17:17:43 -08001412 reverse_path_check_proc,
1413 child_file, child_file,
1414 current);
1415 }
1416 if (error != 0)
1417 break;
1418 } else {
1419 printk(KERN_ERR "reverse_path_check_proc: "
1420 "file is not an ep!\n");
1421 }
1422 }
Jason Baronae10b2b2013-11-12 15:10:16 -08001423 rcu_read_unlock();
Jason Baron28d82dc2012-01-12 17:17:43 -08001424 return error;
1425}
1426
1427/**
1428 * reverse_path_check - The tfile_check_list is list of file *, which have
1429 * links that are proposed to be newly added. We need to
1430 * make sure that those added links don't add too many
1431 * paths such that we will spend all our time waking up
1432 * eventpoll objects.
1433 *
1434 * Returns: Returns zero if the proposed links don't create too many paths,
1435 * -1 otherwise.
1436 */
1437static int reverse_path_check(void)
1438{
Jason Baron28d82dc2012-01-12 17:17:43 -08001439 int error = 0;
1440 struct file *current_file;
1441
1442 /* let's call this for all tfiles */
1443 list_for_each_entry(current_file, &tfile_check_list, f_tfile_llink) {
Jason Baron28d82dc2012-01-12 17:17:43 -08001444 path_count_init();
Davidlohr Bueso74bdc122019-01-03 15:27:02 -08001445 error = ep_call_nested(&poll_loop_ncalls,
Jason Baron28d82dc2012-01-12 17:17:43 -08001446 reverse_path_check_proc, current_file,
1447 current_file, current);
1448 if (error)
1449 break;
1450 }
1451 return error;
1452}
1453
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001454static int ep_create_wakeup_source(struct epitem *epi)
1455{
Al Viro27423bb2020-09-24 19:41:58 -04001456 struct name_snapshot n;
Eric Wongeea1d582013-04-30 15:27:39 -07001457 struct wakeup_source *ws;
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001458
1459 if (!epi->ep->ws) {
Tri Voc8377ad2019-08-06 18:48:46 -07001460 epi->ep->ws = wakeup_source_register(NULL, "eventpoll");
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001461 if (!epi->ep->ws)
1462 return -ENOMEM;
1463 }
1464
Al Viro27423bb2020-09-24 19:41:58 -04001465 take_dentry_name_snapshot(&n, epi->ffd.file->f_path.dentry);
1466 ws = wakeup_source_register(NULL, n.name.name);
1467 release_dentry_name_snapshot(&n);
Eric Wongeea1d582013-04-30 15:27:39 -07001468
1469 if (!ws)
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001470 return -ENOMEM;
Eric Wongeea1d582013-04-30 15:27:39 -07001471 rcu_assign_pointer(epi->ws, ws);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001472
1473 return 0;
1474}
1475
Eric Wongeea1d582013-04-30 15:27:39 -07001476/* rare code path, only used when EPOLL_CTL_MOD removes a wakeup source */
1477static noinline void ep_destroy_wakeup_source(struct epitem *epi)
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001478{
Eric Wongeea1d582013-04-30 15:27:39 -07001479 struct wakeup_source *ws = ep_wakeup_source(epi);
1480
Eric Wongd6d67e72013-04-30 15:27:43 -07001481 RCU_INIT_POINTER(epi->ws, NULL);
Eric Wongeea1d582013-04-30 15:27:39 -07001482
1483 /*
1484 * wait for ep_pm_stay_awake_rcu to finish, synchronize_rcu is
1485 * used internally by wakeup_source_remove, too (called by
1486 * wakeup_source_unregister), so we cannot use call_rcu
1487 */
1488 synchronize_rcu();
1489 wakeup_source_unregister(ws);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001490}
1491
Davide Libenzic7ea7632007-05-15 01:40:47 -07001492/*
1493 * Must be called with "mtx" held.
1494 */
Al Virobec1a5022017-11-28 19:43:33 -05001495static int ep_insert(struct eventpoll *ep, const struct epoll_event *event,
Jason Baron67347fe2013-11-12 15:10:18 -08001496 struct file *tfile, int fd, int full_check)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001497{
Al Virod85e2aa2018-02-01 15:24:58 -05001498 int error, pwake = 0;
1499 __poll_t revents;
Robin Holt52bd19f72011-01-12 17:00:01 -08001500 long user_watches;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001501 struct epitem *epi;
1502 struct ep_pqueue epq;
1503
Davidlohr Bueso92e64172018-08-21 21:56:45 -07001504 lockdep_assert_irqs_enabled();
1505
Robin Holt52bd19f72011-01-12 17:00:01 -08001506 user_watches = atomic_long_read(&ep->user->epoll_watches);
1507 if (unlikely(user_watches >= max_user_watches))
Davide Libenzi7ef99642008-12-01 13:13:55 -08001508 return -ENOSPC;
Christoph Lametere94b1762006-12-06 20:33:17 -08001509 if (!(epi = kmem_cache_alloc(epi_cache, GFP_KERNEL)))
Davide Libenzi7ef99642008-12-01 13:13:55 -08001510 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001511
1512 /* Item initialization follow here ... */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001513 INIT_LIST_HEAD(&epi->rdllink);
1514 INIT_LIST_HEAD(&epi->fllink);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001515 INIT_LIST_HEAD(&epi->pwqlist);
1516 epi->ep = ep;
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001517 ep_set_ffd(&epi->ffd, tfile, fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001518 epi->event = *event;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001519 epi->nwait = 0;
Davide Libenzid47de162007-05-15 01:40:41 -07001520 epi->next = EP_UNACTIVE_PTR;
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001521 if (epi->event.events & EPOLLWAKEUP) {
1522 error = ep_create_wakeup_source(epi);
1523 if (error)
1524 goto error_create_wakeup_source;
1525 } else {
Eric Wongeea1d582013-04-30 15:27:39 -07001526 RCU_INIT_POINTER(epi->ws, NULL);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001527 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001528
Al Viro8993da32020-09-09 22:25:06 -04001529 /* Add the current item to the list of active epoll hook for this file */
1530 spin_lock(&tfile->f_lock);
1531 list_add_tail_rcu(&epi->fllink, &tfile->f_ep_links);
1532 spin_unlock(&tfile->f_lock);
1533
1534 /*
1535 * Add the current item to the RB tree. All RB tree operations are
1536 * protected by "mtx", and ep_insert() is called with "mtx" held.
1537 */
1538 ep_rbtree_insert(ep, epi);
1539
1540 /* now check if we've created too many backpaths */
1541 error = -EINVAL;
1542 if (full_check && reverse_path_check())
1543 goto error_remove_epi;
1544
Linus Torvalds1da177e2005-04-16 15:20:36 -07001545 /* Initialize the poll table using the queue callback */
1546 epq.epi = epi;
1547 init_poll_funcptr(&epq.pt, ep_ptable_queue_proc);
1548
1549 /*
1550 * Attach the item to the poll hooks and get current event bits.
1551 * We can safely use the file* here because its usage count has
Davide Libenzic7ea7632007-05-15 01:40:47 -07001552 * been increased by the caller of this function. Note that after
1553 * this operation completes, the poll callback can start hitting
1554 * the new item.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001555 */
Jason Baron37b5e522017-11-17 15:29:06 -08001556 revents = ep_item_poll(epi, &epq.pt, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001557
1558 /*
1559 * We have to check if something went wrong during the poll wait queue
1560 * install process. Namely an allocation for a wait queue failed due
1561 * high memory pressure.
1562 */
Davide Libenzi7ef99642008-12-01 13:13:55 -08001563 error = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001564 if (epi->nwait < 0)
Davide Libenzi7699acd2007-05-10 22:23:23 -07001565 goto error_unregister;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001566
Davide Libenzic7ea7632007-05-15 01:40:47 -07001567 /* We have to drop the new item inside our item list to keep track of it */
Roman Penyaeva218cc42019-03-07 16:28:53 -08001568 write_lock_irq(&ep->lock);
Davide Libenzic7ea7632007-05-15 01:40:47 -07001569
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -07001570 /* record NAPI ID of new item if present */
1571 ep_set_busy_poll_napi_id(epi);
1572
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573 /* If the file is already "ready" we drop it inside the ready list */
Davidlohr Bueso992991c2018-08-21 21:58:26 -07001574 if (revents && !ep_is_linked(epi)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001575 list_add_tail(&epi->rdllink, &ep->rdllist);
Eric Wongeea1d582013-04-30 15:27:39 -07001576 ep_pm_stay_awake(epi);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001577
1578 /* Notify waiting tasks that events are available */
1579 if (waitqueue_active(&ep->wq))
Roman Penyaeva218cc42019-03-07 16:28:53 -08001580 wake_up(&ep->wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001581 if (waitqueue_active(&ep->poll_wait))
1582 pwake++;
1583 }
1584
Roman Penyaeva218cc42019-03-07 16:28:53 -08001585 write_unlock_irq(&ep->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001586
Robin Holt52bd19f72011-01-12 17:00:01 -08001587 atomic_long_inc(&ep->user->epoll_watches);
Davide Libenzi7ef99642008-12-01 13:13:55 -08001588
Linus Torvalds1da177e2005-04-16 15:20:36 -07001589 /* We have to call this outside the lock */
1590 if (pwake)
Davide Libenzi5071f972009-03-31 15:24:10 -07001591 ep_poll_safewake(&ep->poll_wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001592
Linus Torvalds1da177e2005-04-16 15:20:36 -07001593 return 0;
1594
Al Viro8993da32020-09-09 22:25:06 -04001595error_unregister:
1596 ep_unregister_pollwait(ep, epi);
Jason Baron28d82dc2012-01-12 17:17:43 -08001597error_remove_epi:
1598 spin_lock(&tfile->f_lock);
Jason Baronae10b2b2013-11-12 15:10:16 -08001599 list_del_rcu(&epi->fllink);
Jason Baron28d82dc2012-01-12 17:17:43 -08001600 spin_unlock(&tfile->f_lock);
1601
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001602 rb_erase_cached(&epi->rbn, &ep->rbr);
Jason Baron28d82dc2012-01-12 17:17:43 -08001603
Linus Torvalds1da177e2005-04-16 15:20:36 -07001604 /*
1605 * We need to do this because an event could have been arrived on some
Davide Libenzi67647d02007-05-15 01:40:52 -07001606 * allocated wait queue. Note that we don't care about the ep->ovflist
1607 * list, since that is used/cleaned only inside a section bound by "mtx".
1608 * And ep_insert() is called with "mtx" held.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001609 */
Roman Penyaeva218cc42019-03-07 16:28:53 -08001610 write_lock_irq(&ep->lock);
Davidlohr Bueso992991c2018-08-21 21:58:26 -07001611 if (ep_is_linked(epi))
Davide Libenzi6192bd52007-05-08 00:25:41 -07001612 list_del_init(&epi->rdllink);
Roman Penyaeva218cc42019-03-07 16:28:53 -08001613 write_unlock_irq(&ep->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001614
Eric Wongeea1d582013-04-30 15:27:39 -07001615 wakeup_source_unregister(ep_wakeup_source(epi));
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001616
1617error_create_wakeup_source:
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001618 kmem_cache_free(epi_cache, epi);
Davide Libenzi7ef99642008-12-01 13:13:55 -08001619
Linus Torvalds1da177e2005-04-16 15:20:36 -07001620 return error;
1621}
1622
Linus Torvalds1da177e2005-04-16 15:20:36 -07001623/*
1624 * Modify the interest event mask by dropping an event if the new mask
Davide Libenzic7ea7632007-05-15 01:40:47 -07001625 * has a match in the current file status. Must be called with "mtx" held.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626 */
Al Virobec1a5022017-11-28 19:43:33 -05001627static int ep_modify(struct eventpoll *ep, struct epitem *epi,
1628 const struct epoll_event *event)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001629{
1630 int pwake = 0;
Hans Verkuil626cf232012-03-23 15:02:27 -07001631 poll_table pt;
1632
Davidlohr Bueso92e64172018-08-21 21:56:45 -07001633 lockdep_assert_irqs_enabled();
1634
Hans Verkuil626cf232012-03-23 15:02:27 -07001635 init_poll_funcptr(&pt, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001636
1637 /*
Tony Battersbye057e152009-03-31 15:24:15 -07001638 * Set the new event interest mask before calling f_op->poll();
1639 * otherwise we might miss an event that happens between the
1640 * f_op->poll() call and the new event set registering.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001641 */
Eric Wong128dd172013-01-01 21:20:27 +00001642 epi->event.events = event->events; /* need barrier below */
Tony Battersbye057e152009-03-31 15:24:15 -07001643 epi->event.data = event->data; /* protected by mtx */
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001644 if (epi->event.events & EPOLLWAKEUP) {
Eric Wongeea1d582013-04-30 15:27:39 -07001645 if (!ep_has_wakeup_source(epi))
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001646 ep_create_wakeup_source(epi);
Eric Wongeea1d582013-04-30 15:27:39 -07001647 } else if (ep_has_wakeup_source(epi)) {
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001648 ep_destroy_wakeup_source(epi);
1649 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650
1651 /*
Eric Wong128dd172013-01-01 21:20:27 +00001652 * The following barrier has two effects:
1653 *
1654 * 1) Flush epi changes above to other CPUs. This ensures
1655 * we do not miss events from ep_poll_callback if an
1656 * event occurs immediately after we call f_op->poll().
Roman Penyaeva218cc42019-03-07 16:28:53 -08001657 * We need this because we did not take ep->lock while
Eric Wong128dd172013-01-01 21:20:27 +00001658 * changing epi above (but ep_poll_callback does take
Roman Penyaeva218cc42019-03-07 16:28:53 -08001659 * ep->lock).
Eric Wong128dd172013-01-01 21:20:27 +00001660 *
1661 * 2) We also need to ensure we do not miss _past_ events
1662 * when calling f_op->poll(). This barrier also
1663 * pairs with the barrier in wq_has_sleeper (see
1664 * comments for wq_has_sleeper).
1665 *
1666 * This barrier will now guarantee ep_poll_callback or f_op->poll
1667 * (or both) will notice the readiness of an item.
1668 */
1669 smp_mb();
1670
1671 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001672 * Get current event bits. We can safely use the file* here because
1673 * its usage count has been increased by the caller of this function.
Davide Libenzic7ea7632007-05-15 01:40:47 -07001674 * If the item is "hot" and it is not registered inside the ready
Davide Libenzi67647d02007-05-15 01:40:52 -07001675 * list, push it inside.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001676 */
Al Viro69112732017-11-28 19:56:15 -05001677 if (ep_item_poll(epi, &pt, 1)) {
Roman Penyaeva218cc42019-03-07 16:28:53 -08001678 write_lock_irq(&ep->lock);
Davidlohr Bueso992991c2018-08-21 21:58:26 -07001679 if (!ep_is_linked(epi)) {
Davide Libenzic7ea7632007-05-15 01:40:47 -07001680 list_add_tail(&epi->rdllink, &ep->rdllist);
Eric Wongeea1d582013-04-30 15:27:39 -07001681 ep_pm_stay_awake(epi);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001682
Davide Libenzic7ea7632007-05-15 01:40:47 -07001683 /* Notify waiting tasks that events are available */
1684 if (waitqueue_active(&ep->wq))
Roman Penyaeva218cc42019-03-07 16:28:53 -08001685 wake_up(&ep->wq);
Davide Libenzic7ea7632007-05-15 01:40:47 -07001686 if (waitqueue_active(&ep->poll_wait))
1687 pwake++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001688 }
Roman Penyaeva218cc42019-03-07 16:28:53 -08001689 write_unlock_irq(&ep->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001690 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001691
1692 /* We have to call this outside the lock */
1693 if (pwake)
Davide Libenzi5071f972009-03-31 15:24:10 -07001694 ep_poll_safewake(&ep->poll_wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001695
1696 return 0;
1697}
1698
Al Virod85e2aa2018-02-01 15:24:58 -05001699static __poll_t ep_send_events_proc(struct eventpoll *ep, struct list_head *head,
Davide Libenzi296e2362009-03-31 15:24:11 -07001700 void *priv)
Davide Libenzi5071f972009-03-31 15:24:10 -07001701{
1702 struct ep_send_events_data *esed = priv;
Al Virod85e2aa2018-02-01 15:24:58 -05001703 __poll_t revents;
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001704 struct epitem *epi, *tmp;
1705 struct epoll_event __user *uevent = esed->events;
Eric Wongeea1d582013-04-30 15:27:39 -07001706 struct wakeup_source *ws;
Hans Verkuil626cf232012-03-23 15:02:27 -07001707 poll_table pt;
1708
1709 init_poll_funcptr(&pt, NULL);
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001710 esed->res = 0;
Davide Libenzi5071f972009-03-31 15:24:10 -07001711
Davide Libenzi296e2362009-03-31 15:24:11 -07001712 /*
Davide Libenzi5071f972009-03-31 15:24:10 -07001713 * We can loop without lock because we are passed a task private list.
1714 * Items cannot vanish during the loop because ep_scan_ready_list() is
1715 * holding "mtx" during this call.
Davide Libenzi296e2362009-03-31 15:24:11 -07001716 */
Davidlohr Bueso21877e12019-01-03 15:27:12 -08001717 lockdep_assert_held(&ep->mtx);
1718
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001719 list_for_each_entry_safe(epi, tmp, head, rdllink) {
1720 if (esed->res >= esed->maxevents)
1721 break;
Davide Libenzi5071f972009-03-31 15:24:10 -07001722
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001723 /*
1724 * Activate ep->ws before deactivating epi->ws to prevent
1725 * triggering auto-suspend here (in case we reactive epi->ws
1726 * below).
1727 *
1728 * This could be rearranged to delay the deactivation of epi->ws
1729 * instead, but then epi->ws would temporarily be out of sync
1730 * with ep_is_linked().
1731 */
Eric Wongeea1d582013-04-30 15:27:39 -07001732 ws = ep_wakeup_source(epi);
1733 if (ws) {
1734 if (ws->active)
1735 __pm_stay_awake(ep->ws);
1736 __pm_relax(ws);
1737 }
1738
Davide Libenzi5071f972009-03-31 15:24:10 -07001739 list_del_init(&epi->rdllink);
1740
Davide Libenzi296e2362009-03-31 15:24:11 -07001741 /*
Davide Libenzi5071f972009-03-31 15:24:10 -07001742 * If the event mask intersect the caller-requested one,
1743 * deliver the event to userspace. Again, ep_scan_ready_list()
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001744 * is holding ep->mtx, so no operations coming from userspace
Davide Libenzi5071f972009-03-31 15:24:10 -07001745 * can change the item.
Davide Libenzi296e2362009-03-31 15:24:11 -07001746 */
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001747 revents = ep_item_poll(epi, &pt, 1);
1748 if (!revents)
1749 continue;
1750
1751 if (__put_user(revents, &uevent->events) ||
1752 __put_user(epi->event.data, &uevent->data)) {
1753 list_add(&epi->rdllink, head);
1754 ep_pm_stay_awake(epi);
1755 if (!esed->res)
1756 esed->res = -EFAULT;
1757 return 0;
1758 }
1759 esed->res++;
1760 uevent++;
1761 if (epi->event.events & EPOLLONESHOT)
1762 epi->event.events &= EP_PRIVATE_BITS;
1763 else if (!(epi->event.events & EPOLLET)) {
1764 /*
1765 * If this file has been added with Level
1766 * Trigger mode, we need to insert back inside
1767 * the ready list, so that the next call to
1768 * epoll_wait() will check again the events
1769 * availability. At this point, no one can insert
1770 * into ep->rdllist besides us. The epoll_ctl()
1771 * callers are locked out by
1772 * ep_scan_ready_list() holding "mtx" and the
1773 * poll callback will queue them in ep->ovflist.
1774 */
1775 list_add_tail(&epi->rdllink, &ep->rdllist);
1776 ep_pm_stay_awake(epi);
Davide Libenzi296e2362009-03-31 15:24:11 -07001777 }
1778 }
Davide Libenzi5071f972009-03-31 15:24:10 -07001779
Al Virod7ebbe42018-02-01 15:21:13 -05001780 return 0;
Davide Libenzi5071f972009-03-31 15:24:10 -07001781}
1782
Davide Libenzi296e2362009-03-31 15:24:11 -07001783static int ep_send_events(struct eventpoll *ep,
1784 struct epoll_event __user *events, int maxevents)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001785{
Davide Libenzi5071f972009-03-31 15:24:10 -07001786 struct ep_send_events_data esed;
Davide Libenzi6192bd52007-05-08 00:25:41 -07001787
Davide Libenzi5071f972009-03-31 15:24:10 -07001788 esed.maxevents = maxevents;
1789 esed.events = events;
Davide Libenzid47de162007-05-15 01:40:41 -07001790
Al Virod7ebbe42018-02-01 15:21:13 -05001791 ep_scan_ready_list(ep, ep_send_events_proc, &esed, 0, false);
1792 return esed.res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001793}
1794
Deepa Dinamani766b9f92016-05-19 17:09:05 -07001795static inline struct timespec64 ep_set_mstimeout(long ms)
Eric Dumazet0781b902011-02-01 15:52:35 -08001796{
Deepa Dinamani766b9f92016-05-19 17:09:05 -07001797 struct timespec64 now, ts = {
Eric Dumazet0781b902011-02-01 15:52:35 -08001798 .tv_sec = ms / MSEC_PER_SEC,
1799 .tv_nsec = NSEC_PER_MSEC * (ms % MSEC_PER_SEC),
1800 };
1801
Deepa Dinamani766b9f92016-05-19 17:09:05 -07001802 ktime_get_ts64(&now);
1803 return timespec64_add_safe(now, ts);
Eric Dumazet0781b902011-02-01 15:52:35 -08001804}
1805
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001806/**
1807 * ep_poll - Retrieves ready events, and delivers them to the caller supplied
1808 * event buffer.
1809 *
1810 * @ep: Pointer to the eventpoll context.
1811 * @events: Pointer to the userspace buffer where the ready events should be
1812 * stored.
1813 * @maxevents: Size (in terms of number of events) of the caller event buffer.
1814 * @timeout: Maximum timeout for the ready events fetch operation, in
1815 * milliseconds. If the @timeout is zero, the function will not block,
1816 * while if the @timeout is less than zero, the function will block
1817 * until at least one event has been retrieved (or an error
1818 * occurred).
1819 *
1820 * Returns: Returns the number of ready events which have been fetched, or an
1821 * error code, in case of error.
1822 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001823static int ep_poll(struct eventpoll *ep, struct epoll_event __user *events,
1824 int maxevents, long timeout)
1825{
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001826 int res = 0, eavail, timed_out = 0;
John Stultzda8b44d2016-03-17 14:20:51 -07001827 u64 slack = 0;
Ingo Molnarac6424b2017-06-20 12:06:13 +02001828 wait_queue_entry_t wait;
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001829 ktime_t expires, *to = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001830
Davidlohr Bueso679abf32018-08-21 21:58:23 -07001831 lockdep_assert_irqs_enabled();
1832
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001833 if (timeout > 0) {
Deepa Dinamani766b9f92016-05-19 17:09:05 -07001834 struct timespec64 end_time = ep_set_mstimeout(timeout);
Eric Dumazet0781b902011-02-01 15:52:35 -08001835
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001836 slack = select_estimate_accuracy(&end_time);
1837 to = &expires;
Deepa Dinamani766b9f92016-05-19 17:09:05 -07001838 *to = timespec64_to_ktime(end_time);
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001839 } else if (timeout == 0) {
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001840 /*
1841 * Avoid the unnecessary trip to the wait queue loop, if the
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001842 * caller specified a non blocking operation. We still need
1843 * lock because we could race and not see an epi being added
1844 * to the ready list while in irq callback. Thus incorrectly
1845 * returning 0 back to userspace.
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001846 */
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001847 timed_out = 1;
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001848
Roman Penyaeva218cc42019-03-07 16:28:53 -08001849 write_lock_irq(&ep->lock);
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001850 eavail = ep_events_available(ep);
Roman Penyaeva218cc42019-03-07 16:28:53 -08001851 write_unlock_irq(&ep->lock);
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001852
Davidlohr Bueso35cff1a2019-01-03 15:27:22 -08001853 goto send_events;
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001854 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001855
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001856fetch_events:
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -07001857
1858 if (!ep_events_available(ep))
1859 ep_busy_loop(ep, timed_out);
1860
Davide Libenzi3fb0e582011-03-22 16:34:46 -07001861 eavail = ep_events_available(ep);
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001862 if (eavail)
Davidlohr Bueso35cff1a2019-01-03 15:27:22 -08001863 goto send_events;
Jason Baron28d82dc2012-01-12 17:17:43 -08001864
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001865 /*
1866 * Busy poll timed out. Drop NAPI ID for now, we can add
1867 * it back in when we have moved a socket with a valid NAPI
1868 * ID onto the ready list.
1869 */
1870 ep_reset_busy_poll_napi_id(ep);
Jason Baron28d82dc2012-01-12 17:17:43 -08001871
Roman Penyaev5d776312020-05-07 18:36:16 -07001872 do {
1873 /*
1874 * Internally init_wait() uses autoremove_wake_function(),
1875 * thus wait entry is removed from the wait queue on each
1876 * wakeup. Why it is important? In case of several waiters
1877 * each new wakeup will hit the next waiter, giving it the
1878 * chance to harvest new event. Otherwise wakeup can be
1879 * lost. This is also good performance-wise, because on
1880 * normal wakeup path no need to call __remove_wait_queue()
1881 * explicitly, thus ep->lock is not taken, which halts the
1882 * event delivery.
1883 */
1884 init_wait(&wait);
Roman Penyaev8e709bb2020-03-21 18:22:30 -07001885 write_lock_irq(&ep->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001886 __add_wait_queue_exclusive(&ep->wq, &wait);
Roman Penyaev8e709bb2020-03-21 18:22:30 -07001887 write_unlock_irq(&ep->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001888
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001889 /*
1890 * We don't want to sleep if the ep_poll_callback() sends us
1891 * a wakeup in between. That's why we set the task state
1892 * to TASK_INTERRUPTIBLE before doing the checks.
1893 */
1894 set_current_state(TASK_INTERRUPTIBLE);
1895 /*
1896 * Always short-circuit for fatal signals to allow
1897 * threads to make a timely exit without the chance of
1898 * finding more events available and fetching
1899 * repeatedly.
1900 */
1901 if (fatal_signal_pending(current)) {
1902 res = -EINTR;
1903 break;
Davide Libenzi5071f972009-03-31 15:24:10 -07001904 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001905
Davidlohr Buesoabc610e2019-01-03 15:27:19 -08001906 eavail = ep_events_available(ep);
1907 if (eavail)
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001908 break;
1909 if (signal_pending(current)) {
1910 res = -EINTR;
1911 break;
1912 }
1913
Davidlohr Buesoabc610e2019-01-03 15:27:19 -08001914 if (!schedule_hrtimeout_range(to, slack, HRTIMER_MODE_ABS)) {
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001915 timed_out = 1;
Davidlohr Buesoabc610e2019-01-03 15:27:19 -08001916 break;
1917 }
Roman Penyaev5d776312020-05-07 18:36:16 -07001918
1919 /* We were woken up, thus go and try to harvest some events */
1920 eavail = 1;
1921
1922 } while (0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001923
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001924 __set_current_state(TASK_RUNNING);
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001925
Roman Penyaev5d776312020-05-07 18:36:16 -07001926 if (!list_empty_careful(&wait.entry)) {
1927 write_lock_irq(&ep->lock);
1928 __remove_wait_queue(&ep->wq, &wait);
1929 write_unlock_irq(&ep->lock);
1930 }
1931
Davidlohr Bueso35cff1a2019-01-03 15:27:22 -08001932send_events:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001933 /*
1934 * Try to transfer events to user space. In case we get 0 events and
1935 * there's still timeout left over, we go trying again in search of
1936 * more luck.
1937 */
Davide Libenzi22bacca2011-02-25 14:44:12 -08001938 if (!res && eavail &&
1939 !(res = ep_send_events(ep, events, maxevents)) && !timed_out)
1940 goto fetch_events;
1941
1942 return res;
1943}
1944
1945/**
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001946 * ep_loop_check_proc - Callback function to be passed to the @ep_call_nested()
Linus Torvalds1da177e2005-04-16 15:20:36 -07001947 * API, to verify that adding an epoll file inside another
1948 * epoll structure, does not violate the constraints, in
1949 * terms of closed loops, or too deep chains (which can
1950 * result in excessive stack usage).
Davide Libenzi22bacca2011-02-25 14:44:12 -08001951 *
1952 * @priv: Pointer to the epoll file to be currently checked.
1953 * @cookie: Original cookie for this call. This is the top-of-the-chain epoll
1954 * data structure pointer.
1955 * @call_nests: Current dept of the @ep_call_nested() call stack.
1956 *
1957 * Returns: Returns zero if adding the epoll @file inside current epoll
1958 * structure @ep does not violate the constraints, or -1 otherwise.
1959 */
1960static int ep_loop_check_proc(void *priv, void *cookie, int call_nests)
1961{
1962 int error = 0;
1963 struct file *file = priv;
1964 struct eventpoll *ep = file->private_data;
1965 struct eventpoll *ep_tovisit;
1966 struct rb_node *rbp;
1967 struct epitem *epi;
1968
1969 mutex_lock_nested(&ep->mtx, call_nests + 1);
Al Viro099b7a12020-09-10 08:30:05 -04001970 ep->gen = loop_check_gen;
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001971 for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) {
Davide Libenzi22bacca2011-02-25 14:44:12 -08001972 epi = rb_entry(rbp, struct epitem, rbn);
Nelson Elhaged8805e62011-10-31 17:13:14 -07001973 if (unlikely(is_file_epoll(epi->ffd.file))) {
Davide Libenzi22bacca2011-02-25 14:44:12 -08001974 ep_tovisit = epi->ffd.file->private_data;
Al Viro099b7a12020-09-10 08:30:05 -04001975 if (ep_tovisit->gen == loop_check_gen)
Davide Libenzi22bacca2011-02-25 14:44:12 -08001976 continue;
Davidlohr Bueso74bdc122019-01-03 15:27:02 -08001977 error = ep_call_nested(&poll_loop_ncalls,
Davide Libenzi22bacca2011-02-25 14:44:12 -08001978 ep_loop_check_proc, epi->ffd.file,
1979 ep_tovisit, current);
1980 if (error != 0)
1981 break;
Jason Baron28d82dc2012-01-12 17:17:43 -08001982 } else {
1983 /*
1984 * If we've reached a file that is not associated with
1985 * an ep, then we need to check if the newly added
1986 * links are going to add too many wakeup paths. We do
1987 * this by adding it to the tfile_check_list, if it's
1988 * not already there, and calling reverse_path_check()
1989 * during ep_insert().
1990 */
Marc Zyngierb158e912020-08-19 17:12:17 +01001991 if (list_empty(&epi->ffd.file->f_tfile_llink)) {
Al Viro88405cf2020-09-02 11:30:48 -04001992 if (get_file_rcu(epi->ffd.file))
1993 list_add(&epi->ffd.file->f_tfile_llink,
1994 &tfile_check_list);
Marc Zyngierb158e912020-08-19 17:12:17 +01001995 }
Davide Libenzi22bacca2011-02-25 14:44:12 -08001996 }
1997 }
1998 mutex_unlock(&ep->mtx);
1999
2000 return error;
2001}
2002
2003/**
2004 * ep_loop_check - Performs a check to verify that adding an epoll file (@file)
2005 * another epoll file (represented by @ep) does not create
2006 * closed loops or too deep chains.
2007 *
2008 * @ep: Pointer to the epoll private data structure.
2009 * @file: Pointer to the epoll file to be checked.
2010 *
2011 * Returns: Returns zero if adding the epoll @file inside current epoll
2012 * structure @ep does not violate the constraints, or -1 otherwise.
2013 */
2014static int ep_loop_check(struct eventpoll *ep, struct file *file)
2015{
Al Viro099b7a12020-09-10 08:30:05 -04002016 return ep_call_nested(&poll_loop_ncalls,
Davide Libenzi22bacca2011-02-25 14:44:12 -08002017 ep_loop_check_proc, file, ep, current);
Jason Baron28d82dc2012-01-12 17:17:43 -08002018}
2019
2020static void clear_tfile_check_list(void)
2021{
2022 struct file *file;
2023
2024 /* first clear the tfile_check_list */
2025 while (!list_empty(&tfile_check_list)) {
2026 file = list_first_entry(&tfile_check_list, struct file,
2027 f_tfile_llink);
2028 list_del_init(&file->f_tfile_llink);
Marc Zyngierb158e912020-08-19 17:12:17 +01002029 fput(file);
Jason Baron28d82dc2012-01-12 17:17:43 -08002030 }
2031 INIT_LIST_HEAD(&tfile_check_list);
Davide Libenzi22bacca2011-02-25 14:44:12 -08002032}
2033
Davide Libenzi7699acd2007-05-10 22:23:23 -07002034/*
Andrew Morton523723b2008-08-12 15:09:01 -07002035 * Open an eventpoll file descriptor.
Davide Libenzi7699acd2007-05-10 22:23:23 -07002036 */
Dominik Brodowski791eb222018-03-11 11:34:30 +01002037static int do_epoll_create(int flags)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002038{
Jason Baron28d82dc2012-01-12 17:17:43 -08002039 int error, fd;
Davide Libenzibb57c3e2009-03-31 15:24:12 -07002040 struct eventpoll *ep = NULL;
Jason Baron28d82dc2012-01-12 17:17:43 -08002041 struct file *file;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002042
Ulrich Dreppere38b36f2008-07-23 21:29:42 -07002043 /* Check the EPOLL_* constant for consistency. */
2044 BUILD_BUG_ON(EPOLL_CLOEXEC != O_CLOEXEC);
2045
Davide Libenzi296e2362009-03-31 15:24:11 -07002046 if (flags & ~EPOLL_CLOEXEC)
2047 return -EINVAL;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002048 /*
Davide Libenzibb57c3e2009-03-31 15:24:12 -07002049 * Create the internal data structure ("struct eventpoll").
Davide Libenzi7699acd2007-05-10 22:23:23 -07002050 */
Ulrich Drepper9fe5ad92008-07-23 21:29:43 -07002051 error = ep_alloc(&ep);
Davide Libenzibb57c3e2009-03-31 15:24:12 -07002052 if (error < 0)
2053 return error;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002054 /*
2055 * Creates all the items needed to setup an eventpoll file. That is,
Al Viro2030a422008-02-23 06:46:49 -05002056 * a file structure and a free file descriptor.
Davide Libenzi7699acd2007-05-10 22:23:23 -07002057 */
Jason Baron28d82dc2012-01-12 17:17:43 -08002058 fd = get_unused_fd_flags(O_RDWR | (flags & O_CLOEXEC));
2059 if (fd < 0) {
2060 error = fd;
2061 goto out_free_ep;
2062 }
2063 file = anon_inode_getfile("[eventpoll]", &eventpoll_fops, ep,
Roland Dreier628ff7c2009-12-18 09:41:24 -08002064 O_RDWR | (flags & O_CLOEXEC));
Jason Baron28d82dc2012-01-12 17:17:43 -08002065 if (IS_ERR(file)) {
2066 error = PTR_ERR(file);
2067 goto out_free_fd;
2068 }
Jason Baron28d82dc2012-01-12 17:17:43 -08002069 ep->file = file;
Al Viro98022742012-08-17 22:42:36 -04002070 fd_install(fd, file);
Jason Baron28d82dc2012-01-12 17:17:43 -08002071 return fd;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002072
Jason Baron28d82dc2012-01-12 17:17:43 -08002073out_free_fd:
2074 put_unused_fd(fd);
2075out_free_ep:
2076 ep_free(ep);
Davide Libenzibb57c3e2009-03-31 15:24:12 -07002077 return error;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002078}
2079
Dominik Brodowski791eb222018-03-11 11:34:30 +01002080SYSCALL_DEFINE1(epoll_create1, int, flags)
2081{
2082 return do_epoll_create(flags);
2083}
2084
Heiko Carstens5a8a82b2009-01-14 14:14:25 +01002085SYSCALL_DEFINE1(epoll_create, int, size)
Ulrich Dreppera0998b52008-07-23 21:29:27 -07002086{
Davide Libenzibfe38912009-05-12 13:19:44 -07002087 if (size <= 0)
Ulrich Drepper9fe5ad92008-07-23 21:29:43 -07002088 return -EINVAL;
2089
Dominik Brodowski791eb222018-03-11 11:34:30 +01002090 return do_epoll_create(0);
Ulrich Dreppera0998b52008-07-23 21:29:27 -07002091}
2092
Davide Libenzi7699acd2007-05-10 22:23:23 -07002093/*
2094 * The following function implements the controller interface for
2095 * the eventpoll file that enables the insertion/removal/change of
Davide Libenzi67647d02007-05-15 01:40:52 -07002096 * file descriptors inside the interest set.
Davide Libenzi7699acd2007-05-10 22:23:23 -07002097 */
Heiko Carstens5a8a82b2009-01-14 14:14:25 +01002098SYSCALL_DEFINE4(epoll_ctl, int, epfd, int, op, int, fd,
2099 struct epoll_event __user *, event)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002100{
2101 int error;
Jason Baron67347fe2013-11-12 15:10:18 -08002102 int full_check = 0;
Al Viro7e3fb582013-08-30 12:47:21 -04002103 struct fd f, tf;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002104 struct eventpoll *ep;
2105 struct epitem *epi;
2106 struct epoll_event epds;
Jason Baron67347fe2013-11-12 15:10:18 -08002107 struct eventpoll *tep = NULL;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002108
Davide Libenzi7699acd2007-05-10 22:23:23 -07002109 error = -EFAULT;
2110 if (ep_op_has_event(op) &&
2111 copy_from_user(&epds, event, sizeof(struct epoll_event)))
2112 goto error_return;
2113
Davide Libenzi7699acd2007-05-10 22:23:23 -07002114 error = -EBADF;
Al Viro7e3fb582013-08-30 12:47:21 -04002115 f = fdget(epfd);
2116 if (!f.file)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002117 goto error_return;
2118
2119 /* Get the "struct file *" for the target file */
Al Viro7e3fb582013-08-30 12:47:21 -04002120 tf = fdget(fd);
2121 if (!tf.file)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002122 goto error_fput;
2123
2124 /* The target file descriptor must support poll */
2125 error = -EPERM;
Christoph Hellwig9965ed172018-03-05 07:26:05 -08002126 if (!file_can_poll(tf.file))
Davide Libenzi7699acd2007-05-10 22:23:23 -07002127 goto error_tgt_fput;
2128
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02002129 /* Check if EPOLLWAKEUP is allowed */
Nicolas Ioossc680e412014-09-09 14:50:51 -07002130 if (ep_op_has_event(op))
2131 ep_take_care_of_epollwakeup(&epds);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02002132
Davide Libenzi7699acd2007-05-10 22:23:23 -07002133 /*
2134 * We have to check that the file structure underneath the file descriptor
2135 * the user passed to us _is_ an eventpoll file. And also we do not permit
2136 * adding an epoll file descriptor inside itself.
2137 */
2138 error = -EINVAL;
Al Viro7e3fb582013-08-30 12:47:21 -04002139 if (f.file == tf.file || !is_file_epoll(f.file))
Davide Libenzi7699acd2007-05-10 22:23:23 -07002140 goto error_tgt_fput;
2141
2142 /*
Jason Barondf0108c2016-01-20 14:59:24 -08002143 * epoll adds to the wakeup queue at EPOLL_CTL_ADD time only,
2144 * so EPOLLEXCLUSIVE is not allowed for a EPOLL_CTL_MOD operation.
2145 * Also, we do not currently supported nested exclusive wakeups.
2146 */
Cyrill Gorcunovc857ab62017-02-27 14:27:40 -08002147 if (ep_op_has_event(op) && (epds.events & EPOLLEXCLUSIVE)) {
Jason Baronb6a515c2016-02-05 15:37:04 -08002148 if (op == EPOLL_CTL_MOD)
2149 goto error_tgt_fput;
2150 if (op == EPOLL_CTL_ADD && (is_file_epoll(tf.file) ||
2151 (epds.events & ~EPOLLEXCLUSIVE_OK_BITS)))
2152 goto error_tgt_fput;
2153 }
Jason Barondf0108c2016-01-20 14:59:24 -08002154
2155 /*
Davide Libenzi7699acd2007-05-10 22:23:23 -07002156 * At this point it is safe to assume that the "private_data" contains
2157 * our own data structure.
2158 */
Al Viro7e3fb582013-08-30 12:47:21 -04002159 ep = f.file->private_data;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002160
Davide Libenzi22bacca2011-02-25 14:44:12 -08002161 /*
2162 * When we insert an epoll file descriptor, inside another epoll file
2163 * descriptor, there is the change of creating closed loops, which are
Jason Baron28d82dc2012-01-12 17:17:43 -08002164 * better be handled here, than in more critical paths. While we are
2165 * checking for loops we also determine the list of files reachable
2166 * and hang them on the tfile_check_list, so we can check that we
2167 * haven't created too many possible wakeup paths.
Davide Libenzi22bacca2011-02-25 14:44:12 -08002168 *
Jason Baron67347fe2013-11-12 15:10:18 -08002169 * We do not need to take the global 'epumutex' on EPOLL_CTL_ADD when
2170 * the epoll file descriptor is attaching directly to a wakeup source,
2171 * unless the epoll file descriptor is nested. The purpose of taking the
2172 * 'epmutex' on add is to prevent complex toplogies such as loops and
2173 * deep wakeup paths from forming in parallel through multiple
2174 * EPOLL_CTL_ADD operations.
Davide Libenzi22bacca2011-02-25 14:44:12 -08002175 */
Nelson Elhaged8805e62011-10-31 17:13:14 -07002176 mutex_lock_nested(&ep->mtx, 0);
Jason Baron67347fe2013-11-12 15:10:18 -08002177 if (op == EPOLL_CTL_ADD) {
2178 if (!list_empty(&f.file->f_ep_links) ||
Al Viro8e58bad2020-09-10 08:33:27 -04002179 ep->gen == loop_check_gen ||
Jason Baron67347fe2013-11-12 15:10:18 -08002180 is_file_epoll(tf.file)) {
2181 full_check = 1;
2182 mutex_unlock(&ep->mtx);
2183 mutex_lock(&epmutex);
2184 if (is_file_epoll(tf.file)) {
2185 error = -ELOOP;
Al Viro42694912020-08-22 18:25:52 -04002186 if (ep_loop_check(ep, tf.file) != 0)
Jason Baron67347fe2013-11-12 15:10:18 -08002187 goto error_tgt_fput;
Marc Zyngierb158e912020-08-19 17:12:17 +01002188 } else {
2189 get_file(tf.file);
Jason Baron67347fe2013-11-12 15:10:18 -08002190 list_add(&tf.file->f_tfile_llink,
2191 &tfile_check_list);
Marc Zyngierb158e912020-08-19 17:12:17 +01002192 }
Jason Baron67347fe2013-11-12 15:10:18 -08002193 mutex_lock_nested(&ep->mtx, 0);
2194 if (is_file_epoll(tf.file)) {
2195 tep = tf.file->private_data;
2196 mutex_lock_nested(&tep->mtx, 1);
2197 }
2198 }
2199 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07002200
Davide Libenzi67647d02007-05-15 01:40:52 -07002201 /*
2202 * Try to lookup the file inside our RB tree, Since we grabbed "mtx"
2203 * above, we can be sure to be able to use the item looked up by
2204 * ep_find() till we release the mutex.
2205 */
Al Viro7e3fb582013-08-30 12:47:21 -04002206 epi = ep_find(ep, tf.file, fd);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002207
2208 error = -EINVAL;
2209 switch (op) {
2210 case EPOLL_CTL_ADD:
2211 if (!epi) {
Linus Torvaldsa9a08842018-02-11 14:34:03 -08002212 epds.events |= EPOLLERR | EPOLLHUP;
Jason Baron67347fe2013-11-12 15:10:18 -08002213 error = ep_insert(ep, &epds, tf.file, fd, full_check);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002214 } else
2215 error = -EEXIST;
2216 break;
2217 case EPOLL_CTL_DEL:
2218 if (epi)
2219 error = ep_remove(ep, epi);
2220 else
2221 error = -ENOENT;
2222 break;
2223 case EPOLL_CTL_MOD:
2224 if (epi) {
Jason Baronb6a515c2016-02-05 15:37:04 -08002225 if (!(epi->event.events & EPOLLEXCLUSIVE)) {
Linus Torvaldsa9a08842018-02-11 14:34:03 -08002226 epds.events |= EPOLLERR | EPOLLHUP;
Jason Baronb6a515c2016-02-05 15:37:04 -08002227 error = ep_modify(ep, epi, &epds);
2228 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07002229 } else
2230 error = -ENOENT;
2231 break;
2232 }
Jason Baron67347fe2013-11-12 15:10:18 -08002233 if (tep != NULL)
2234 mutex_unlock(&tep->mtx);
Davide Libenzid47de162007-05-15 01:40:41 -07002235 mutex_unlock(&ep->mtx);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002236
2237error_tgt_fput:
Al Viro42694912020-08-22 18:25:52 -04002238 if (full_check) {
2239 clear_tfile_check_list();
Al Viro099b7a12020-09-10 08:30:05 -04002240 loop_check_gen++;
Davide Libenzi22bacca2011-02-25 14:44:12 -08002241 mutex_unlock(&epmutex);
Al Viro42694912020-08-22 18:25:52 -04002242 }
Davide Libenzi22bacca2011-02-25 14:44:12 -08002243
Al Viro7e3fb582013-08-30 12:47:21 -04002244 fdput(tf);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002245error_fput:
Al Viro7e3fb582013-08-30 12:47:21 -04002246 fdput(f);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002247error_return:
Davide Libenzi7699acd2007-05-10 22:23:23 -07002248
2249 return error;
2250}
2251
2252/*
2253 * Implement the event wait interface for the eventpoll file. It is the kernel
2254 * part of the user space epoll_wait(2).
2255 */
Dominik Brodowski791eb222018-03-11 11:34:30 +01002256static int do_epoll_wait(int epfd, struct epoll_event __user *events,
2257 int maxevents, int timeout)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002258{
Al Viro2903ff02012-08-28 12:52:22 -04002259 int error;
2260 struct fd f;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002261 struct eventpoll *ep;
2262
Davide Libenzi7699acd2007-05-10 22:23:23 -07002263 /* The maximum number of event must be greater than zero */
2264 if (maxevents <= 0 || maxevents > EP_MAX_EVENTS)
2265 return -EINVAL;
2266
2267 /* Verify that the area passed by the user is writeable */
Linus Torvalds96d4f262019-01-03 18:57:57 -08002268 if (!access_ok(events, maxevents * sizeof(struct epoll_event)))
Al Viro2903ff02012-08-28 12:52:22 -04002269 return -EFAULT;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002270
2271 /* Get the "struct file *" for the eventpoll file */
Al Viro2903ff02012-08-28 12:52:22 -04002272 f = fdget(epfd);
2273 if (!f.file)
2274 return -EBADF;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002275
2276 /*
2277 * We have to check that the file structure underneath the fd
2278 * the user passed to us _is_ an eventpoll file.
2279 */
2280 error = -EINVAL;
Al Viro2903ff02012-08-28 12:52:22 -04002281 if (!is_file_epoll(f.file))
Davide Libenzi7699acd2007-05-10 22:23:23 -07002282 goto error_fput;
2283
2284 /*
2285 * At this point it is safe to assume that the "private_data" contains
2286 * our own data structure.
2287 */
Al Viro2903ff02012-08-28 12:52:22 -04002288 ep = f.file->private_data;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002289
2290 /* Time to fish for events ... */
2291 error = ep_poll(ep, events, maxevents, timeout);
2292
2293error_fput:
Al Viro2903ff02012-08-28 12:52:22 -04002294 fdput(f);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002295 return error;
2296}
2297
Dominik Brodowski791eb222018-03-11 11:34:30 +01002298SYSCALL_DEFINE4(epoll_wait, int, epfd, struct epoll_event __user *, events,
2299 int, maxevents, int, timeout)
2300{
2301 return do_epoll_wait(epfd, events, maxevents, timeout);
2302}
2303
Davide Libenzi7699acd2007-05-10 22:23:23 -07002304/*
2305 * Implement the event wait interface for the eventpoll file. It is the kernel
2306 * part of the user space epoll_pwait(2).
2307 */
Heiko Carstens5a8a82b2009-01-14 14:14:25 +01002308SYSCALL_DEFINE6(epoll_pwait, int, epfd, struct epoll_event __user *, events,
2309 int, maxevents, int, timeout, const sigset_t __user *, sigmask,
2310 size_t, sigsetsize)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002311{
2312 int error;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002313
2314 /*
2315 * If the caller wants a certain signal mask to be set during the wait,
2316 * we apply it here.
2317 */
Oleg Nesterovb7724342019-07-16 16:29:53 -07002318 error = set_user_sigmask(sigmask, sigsetsize);
Deepa Dinamanided653c2018-09-19 21:41:04 -07002319 if (error)
2320 return error;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002321
Dominik Brodowski791eb222018-03-11 11:34:30 +01002322 error = do_epoll_wait(epfd, events, maxevents, timeout);
Oleg Nesterovb7724342019-07-16 16:29:53 -07002323 restore_saved_sigmask_unless(error == -EINTR);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002324
2325 return error;
2326}
2327
Al Viro35280bd2013-02-24 14:52:17 -05002328#ifdef CONFIG_COMPAT
2329COMPAT_SYSCALL_DEFINE6(epoll_pwait, int, epfd,
2330 struct epoll_event __user *, events,
2331 int, maxevents, int, timeout,
2332 const compat_sigset_t __user *, sigmask,
2333 compat_size_t, sigsetsize)
2334{
2335 long err;
Al Viro35280bd2013-02-24 14:52:17 -05002336
2337 /*
2338 * If the caller wants a certain signal mask to be set during the wait,
2339 * we apply it here.
2340 */
Oleg Nesterovb7724342019-07-16 16:29:53 -07002341 err = set_compat_user_sigmask(sigmask, sigsetsize);
Deepa Dinamanided653c2018-09-19 21:41:04 -07002342 if (err)
2343 return err;
Al Viro35280bd2013-02-24 14:52:17 -05002344
Dominik Brodowski791eb222018-03-11 11:34:30 +01002345 err = do_epoll_wait(epfd, events, maxevents, timeout);
Oleg Nesterovb7724342019-07-16 16:29:53 -07002346 restore_saved_sigmask_unless(err == -EINTR);
Al Viro35280bd2013-02-24 14:52:17 -05002347
2348 return err;
2349}
2350#endif
2351
Linus Torvalds1da177e2005-04-16 15:20:36 -07002352static int __init eventpoll_init(void)
2353{
Davide Libenzi7ef99642008-12-01 13:13:55 -08002354 struct sysinfo si;
2355
2356 si_meminfo(&si);
Davide Libenzi9df04e12009-01-29 14:25:26 -08002357 /*
2358 * Allows top 4% of lomem to be allocated for epoll watches (per user).
2359 */
2360 max_user_watches = (((si.totalram - si.totalhigh) / 25) << PAGE_SHIFT) /
Davide Libenzi7ef99642008-12-01 13:13:55 -08002361 EP_ITEM_COST;
Robin Holt52bd19f72011-01-12 17:00:01 -08002362 BUG_ON(max_user_watches < 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002363
Davide Libenzi22bacca2011-02-25 14:44:12 -08002364 /*
2365 * Initialize the structure used to perform epoll file descriptor
2366 * inclusion loops checks.
2367 */
2368 ep_nested_calls_init(&poll_loop_ncalls);
2369
Jason Baron57a173b2017-11-17 15:29:02 -08002370#ifdef CONFIG_DEBUG_LOCK_ALLOC
Linus Torvalds1da177e2005-04-16 15:20:36 -07002371 /* Initialize the structure used to perform safe poll wait head wake ups */
Davide Libenzi5071f972009-03-31 15:24:10 -07002372 ep_nested_calls_init(&poll_safewake_ncalls);
Jason Baron57a173b2017-11-17 15:29:02 -08002373#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002374
Eric Wong39732ca2013-04-30 15:27:38 -07002375 /*
2376 * We can have many thousands of epitems, so prevent this from
2377 * using an extra cache line on 64-bit (and smaller) CPUs
2378 */
2379 BUILD_BUG_ON(sizeof(void *) <= 8 && sizeof(struct epitem) > 128);
2380
Linus Torvalds1da177e2005-04-16 15:20:36 -07002381 /* Allocates slab cache used to allocate "struct epitem" items */
2382 epi_cache = kmem_cache_create("eventpoll_epi", sizeof(struct epitem),
Shakeel Butt2ae928a2017-11-17 15:28:59 -08002383 0, SLAB_HWCACHE_ALIGN|SLAB_PANIC|SLAB_ACCOUNT, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002384
2385 /* Allocates slab cache used to allocate "struct eppoll_entry" */
2386 pwq_cache = kmem_cache_create("eventpoll_pwq",
Shakeel Butt2ae928a2017-11-17 15:28:59 -08002387 sizeof(struct eppoll_entry), 0, SLAB_PANIC|SLAB_ACCOUNT, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002388
Linus Torvalds1da177e2005-04-16 15:20:36 -07002389 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002390}
Davide Libenzicea69242007-05-10 22:23:22 -07002391fs_initcall(eventpoll_init);