blob: 4a0e98d87fcca90fcd06deb5d64ac6dd1f0f2ed9 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Davide Libenzi5071f972009-03-31 15:24:10 -07002 * fs/eventpoll.c (Efficient event retrieval implementation)
3 * Copyright (C) 2001,...,2009 Davide Libenzi
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * Davide Libenzi <davidel@xmailserver.org>
11 *
12 */
13
Linus Torvalds1da177e2005-04-16 15:20:36 -070014#include <linux/init.h>
15#include <linux/kernel.h>
Ingo Molnar174cd4b2017-02-02 19:15:33 +010016#include <linux/sched/signal.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <linux/fs.h>
18#include <linux/file.h>
19#include <linux/signal.h>
20#include <linux/errno.h>
21#include <linux/mm.h>
22#include <linux/slab.h>
23#include <linux/poll.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#include <linux/string.h>
25#include <linux/list.h>
26#include <linux/hash.h>
27#include <linux/spinlock.h>
28#include <linux/syscalls.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <linux/rbtree.h>
30#include <linux/wait.h>
31#include <linux/eventpoll.h>
32#include <linux/mount.h>
33#include <linux/bitops.h>
Arjan van de Ven144efe32006-03-23 03:00:32 -080034#include <linux/mutex.h>
Davide Libenzida66f7c2007-05-10 22:23:21 -070035#include <linux/anon_inodes.h>
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +020036#include <linux/device.h>
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -080037#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070038#include <asm/io.h>
39#include <asm/mman.h>
Arun Sharma600634972011-07-26 16:09:06 -070040#include <linux/atomic.h>
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -080041#include <linux/proc_fs.h>
42#include <linux/seq_file.h>
Al Viro35280bd2013-02-24 14:52:17 -050043#include <linux/compat.h>
Jason Baronae10b2b2013-11-12 15:10:16 -080044#include <linux/rculist.h>
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -070045#include <net/busy_poll.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070046
Linus Torvalds1da177e2005-04-16 15:20:36 -070047/*
48 * LOCKING:
49 * There are three level of locking required by epoll :
50 *
Arjan van de Ven144efe32006-03-23 03:00:32 -080051 * 1) epmutex (mutex)
Davide Libenzic7ea7632007-05-15 01:40:47 -070052 * 2) ep->mtx (mutex)
Roman Penyaeva218cc42019-03-07 16:28:53 -080053 * 3) ep->lock (rwlock)
Linus Torvalds1da177e2005-04-16 15:20:36 -070054 *
55 * The acquire order is the one listed above, from 1 to 3.
Roman Penyaeva218cc42019-03-07 16:28:53 -080056 * We need a rwlock (ep->lock) because we manipulate objects
Linus Torvalds1da177e2005-04-16 15:20:36 -070057 * from inside the poll callback, that might be triggered from
58 * a wake_up() that in turn might be called from IRQ context.
59 * So we can't sleep inside the poll callback and hence we need
60 * a spinlock. During the event transfer loop (from kernel to
61 * user space) we could end up sleeping due a copy_to_user(), so
62 * we need a lock that will allow us to sleep. This lock is a
Davide Libenzid47de162007-05-15 01:40:41 -070063 * mutex (ep->mtx). It is acquired during the event transfer loop,
64 * during epoll_ctl(EPOLL_CTL_DEL) and during eventpoll_release_file().
65 * Then we also need a global mutex to serialize eventpoll_release_file()
66 * and ep_free().
67 * This mutex is acquired by ep_free() during the epoll file
Linus Torvalds1da177e2005-04-16 15:20:36 -070068 * cleanup path and it is also acquired by eventpoll_release_file()
69 * if a file has been pushed inside an epoll set and it is then
Daniel Balutabf6a41d2011-01-30 23:42:29 +020070 * close()d without a previous call to epoll_ctl(EPOLL_CTL_DEL).
Davide Libenzi22bacca2011-02-25 14:44:12 -080071 * It is also acquired when inserting an epoll fd onto another epoll
72 * fd. We do this so that we walk the epoll tree and ensure that this
73 * insertion does not create a cycle of epoll file descriptors, which
74 * could lead to deadlock. We need a global mutex to prevent two
75 * simultaneous inserts (A into B and B into A) from racing and
76 * constructing a cycle without either insert observing that it is
77 * going to.
Nelson Elhaged8805e62011-10-31 17:13:14 -070078 * It is necessary to acquire multiple "ep->mtx"es at once in the
79 * case when one epoll fd is added to another. In this case, we
80 * always acquire the locks in the order of nesting (i.e. after
81 * epoll_ctl(e1, EPOLL_CTL_ADD, e2), e1->mtx will always be acquired
82 * before e2->mtx). Since we disallow cycles of epoll file
83 * descriptors, this ensures that the mutexes are well-ordered. In
84 * order to communicate this nesting to lockdep, when walking a tree
85 * of epoll file descriptors, we use the current recursion depth as
86 * the lockdep subkey.
Davide Libenzid47de162007-05-15 01:40:41 -070087 * It is possible to drop the "ep->mtx" and to use the global
Roman Penyaeva218cc42019-03-07 16:28:53 -080088 * mutex "epmutex" (together with "ep->lock") to have it working,
Davide Libenzid47de162007-05-15 01:40:41 -070089 * but having "ep->mtx" will make the interface more scalable.
Arjan van de Ven144efe32006-03-23 03:00:32 -080090 * Events that require holding "epmutex" are very rare, while for
Davide Libenzid47de162007-05-15 01:40:41 -070091 * normal operations the epoll private "ep->mtx" will guarantee
92 * a better scalability.
Linus Torvalds1da177e2005-04-16 15:20:36 -070093 */
94
Linus Torvalds1da177e2005-04-16 15:20:36 -070095/* Epoll private bits inside the event mask */
Jason Barondf0108c2016-01-20 14:59:24 -080096#define EP_PRIVATE_BITS (EPOLLWAKEUP | EPOLLONESHOT | EPOLLET | EPOLLEXCLUSIVE)
Linus Torvalds1da177e2005-04-16 15:20:36 -070097
Linus Torvaldsa9a08842018-02-11 14:34:03 -080098#define EPOLLINOUT_BITS (EPOLLIN | EPOLLOUT)
Jason Baronb6a515c2016-02-05 15:37:04 -080099
Linus Torvaldsa9a08842018-02-11 14:34:03 -0800100#define EPOLLEXCLUSIVE_OK_BITS (EPOLLINOUT_BITS | EPOLLERR | EPOLLHUP | \
Jason Baronb6a515c2016-02-05 15:37:04 -0800101 EPOLLWAKEUP | EPOLLET | EPOLLEXCLUSIVE)
102
Davide Libenzi5071f972009-03-31 15:24:10 -0700103/* Maximum number of nesting allowed inside epoll sets */
104#define EP_MAX_NESTS 4
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105
Davide Libenzib6119672006-10-11 01:21:44 -0700106#define EP_MAX_EVENTS (INT_MAX / sizeof(struct epoll_event))
107
Davide Libenzid47de162007-05-15 01:40:41 -0700108#define EP_UNACTIVE_PTR ((void *) -1L)
109
Davide Libenzi7ef99642008-12-01 13:13:55 -0800110#define EP_ITEM_COST (sizeof(struct epitem) + sizeof(struct eppoll_entry))
111
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112struct epoll_filefd {
113 struct file *file;
114 int fd;
Eric Wong39732ca2013-04-30 15:27:38 -0700115} __packed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116
117/*
Davide Libenzi5071f972009-03-31 15:24:10 -0700118 * Structure used to track possible nested calls, for too deep recursions
119 * and loop cycles.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120 */
Davide Libenzi5071f972009-03-31 15:24:10 -0700121struct nested_call_node {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122 struct list_head llink;
Davide Libenzi5071f972009-03-31 15:24:10 -0700123 void *cookie;
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700124 void *ctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125};
126
127/*
Davide Libenzi5071f972009-03-31 15:24:10 -0700128 * This structure is used as collector for nested calls, to check for
129 * maximum recursion dept and loop cycles.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130 */
Davide Libenzi5071f972009-03-31 15:24:10 -0700131struct nested_calls {
132 struct list_head tasks_call_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 spinlock_t lock;
134};
135
136/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137 * Each file descriptor added to the eventpoll interface will
Davide Libenzi6192bd52007-05-08 00:25:41 -0700138 * have an entry of this type linked to the "rbr" RB tree.
Eric Wong39732ca2013-04-30 15:27:38 -0700139 * Avoid increasing the size of this struct, there can be many thousands
140 * of these on a server and we do not want this to take another cache line.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141 */
142struct epitem {
Jason Baronae10b2b2013-11-12 15:10:16 -0800143 union {
144 /* RB tree node links this structure to the eventpoll RB tree */
145 struct rb_node rbn;
146 /* Used to free the struct epitem */
147 struct rcu_head rcu;
148 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149
150 /* List header used to link this structure to the eventpoll ready list */
151 struct list_head rdllink;
152
Davide Libenzic7ea7632007-05-15 01:40:47 -0700153 /*
154 * Works together "struct eventpoll"->ovflist in keeping the
155 * single linked chain of items.
156 */
157 struct epitem *next;
158
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159 /* The file descriptor information this item refers to */
160 struct epoll_filefd ffd;
161
162 /* Number of active wait queue attached to poll operations */
163 int nwait;
164
165 /* List containing poll wait queues */
166 struct list_head pwqlist;
167
168 /* The "container" of this item */
169 struct eventpoll *ep;
170
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171 /* List header used to link this item to the "struct file" items list */
172 struct list_head fllink;
Davide Libenzid47de162007-05-15 01:40:41 -0700173
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200174 /* wakeup_source used when EPOLLWAKEUP is set */
Eric Wongeea1d582013-04-30 15:27:39 -0700175 struct wakeup_source __rcu *ws;
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200176
Davide Libenzic7ea7632007-05-15 01:40:47 -0700177 /* The structure that describe the interested events and the source fd */
178 struct epoll_event event;
Davide Libenzid47de162007-05-15 01:40:41 -0700179};
180
181/*
182 * This structure is stored inside the "private_data" member of the file
Daniel Balutabf6a41d2011-01-30 23:42:29 +0200183 * structure and represents the main data structure for the eventpoll
Davide Libenzid47de162007-05-15 01:40:41 -0700184 * interface.
185 */
186struct eventpoll {
Davide Libenzid47de162007-05-15 01:40:41 -0700187 /*
188 * This mutex is used to ensure that files are not removed
189 * while epoll is using them. This is held during the event
190 * collection loop, the file cleanup path, the epoll file exit
191 * code and the ctl operations.
192 */
193 struct mutex mtx;
194
195 /* Wait queue used by sys_epoll_wait() */
196 wait_queue_head_t wq;
197
198 /* Wait queue used by file->poll() */
199 wait_queue_head_t poll_wait;
200
201 /* List of ready file descriptors */
202 struct list_head rdllist;
203
Roman Penyaeva218cc42019-03-07 16:28:53 -0800204 /* Lock which protects rdllist and ovflist */
205 rwlock_t lock;
206
Davide Libenzi67647d02007-05-15 01:40:52 -0700207 /* RB tree root used to store monitored fd structs */
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700208 struct rb_root_cached rbr;
Davide Libenzid47de162007-05-15 01:40:41 -0700209
210 /*
211 * This is a single linked list that chains all the "struct epitem" that
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300212 * happened while transferring ready events to userspace w/out
Roman Penyaeva218cc42019-03-07 16:28:53 -0800213 * holding ->lock.
Davide Libenzid47de162007-05-15 01:40:41 -0700214 */
215 struct epitem *ovflist;
Davide Libenzi7ef99642008-12-01 13:13:55 -0800216
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200217 /* wakeup_source used when ep_scan_ready_list is running */
218 struct wakeup_source *ws;
219
Davide Libenzi7ef99642008-12-01 13:13:55 -0800220 /* The user that created the eventpoll descriptor */
221 struct user_struct *user;
Jason Baron28d82dc2012-01-12 17:17:43 -0800222
223 struct file *file;
224
225 /* used to optimize loop detection check */
226 int visited;
227 struct list_head visited_list_link;
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700228
229#ifdef CONFIG_NET_RX_BUSY_POLL
230 /* used to track busy poll napi_id */
231 unsigned int napi_id;
232#endif
Davide Libenzid47de162007-05-15 01:40:41 -0700233};
234
235/* Wait structure used by the poll hooks */
236struct eppoll_entry {
237 /* List header used to link this structure to the "struct epitem" */
238 struct list_head llink;
239
240 /* The "base" pointer is set to the container "struct epitem" */
Tony Battersby4f0989d2009-03-31 15:24:16 -0700241 struct epitem *base;
Davide Libenzid47de162007-05-15 01:40:41 -0700242
243 /*
244 * Wait queue item that will be linked to the target file wait
245 * queue head.
246 */
Ingo Molnarac6424b2017-06-20 12:06:13 +0200247 wait_queue_entry_t wait;
Davide Libenzid47de162007-05-15 01:40:41 -0700248
249 /* The wait queue head that linked the "wait" wait queue item */
250 wait_queue_head_t *whead;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251};
252
253/* Wrapper struct used by poll queueing */
254struct ep_pqueue {
255 poll_table pt;
256 struct epitem *epi;
257};
258
Davide Libenzi5071f972009-03-31 15:24:10 -0700259/* Used by the ep_send_events() function as callback private data */
260struct ep_send_events_data {
261 int maxevents;
262 struct epoll_event __user *events;
Al Virod7ebbe42018-02-01 15:21:13 -0500263 int res;
Davide Libenzi5071f972009-03-31 15:24:10 -0700264};
265
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266/*
Davide Libenzi7ef99642008-12-01 13:13:55 -0800267 * Configuration options available inside /proc/sys/fs/epoll/
268 */
Davide Libenzi7ef99642008-12-01 13:13:55 -0800269/* Maximum number of epoll watched descriptors, per user */
Robin Holt52bd19f72011-01-12 17:00:01 -0800270static long max_user_watches __read_mostly;
Davide Libenzi7ef99642008-12-01 13:13:55 -0800271
272/*
Davide Libenzid47de162007-05-15 01:40:41 -0700273 * This mutex is used to serialize ep_free() and eventpoll_release_file().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274 */
Davide Libenzi7ef99642008-12-01 13:13:55 -0800275static DEFINE_MUTEX(epmutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276
Davide Libenzi22bacca2011-02-25 14:44:12 -0800277/* Used to check for epoll file descriptor inclusion loops */
278static struct nested_calls poll_loop_ncalls;
279
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280/* Slab cache used to allocate "struct epitem" */
Christoph Lametere18b8902006-12-06 20:33:20 -0800281static struct kmem_cache *epi_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282
283/* Slab cache used to allocate "struct eppoll_entry" */
Christoph Lametere18b8902006-12-06 20:33:20 -0800284static struct kmem_cache *pwq_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285
Jason Baron28d82dc2012-01-12 17:17:43 -0800286/* Visited nodes during ep_loop_check(), so we can unset them when we finish */
287static LIST_HEAD(visited_list);
288
289/*
290 * List of files with newly added links, where we may need to limit the number
291 * of emanating paths. Protected by the epmutex.
292 */
293static LIST_HEAD(tfile_check_list);
294
Davide Libenzi7ef99642008-12-01 13:13:55 -0800295#ifdef CONFIG_SYSCTL
296
297#include <linux/sysctl.h>
298
Robin Holt52bd19f72011-01-12 17:00:01 -0800299static long zero;
300static long long_max = LONG_MAX;
Davide Libenzi7ef99642008-12-01 13:13:55 -0800301
Joe Perches1f7e0612014-06-06 14:38:05 -0700302struct ctl_table epoll_table[] = {
Davide Libenzi7ef99642008-12-01 13:13:55 -0800303 {
Davide Libenzi7ef99642008-12-01 13:13:55 -0800304 .procname = "max_user_watches",
305 .data = &max_user_watches,
Robin Holt52bd19f72011-01-12 17:00:01 -0800306 .maxlen = sizeof(max_user_watches),
Davide Libenzi7ef99642008-12-01 13:13:55 -0800307 .mode = 0644,
Robin Holt52bd19f72011-01-12 17:00:01 -0800308 .proc_handler = proc_doulongvec_minmax,
Davide Libenzi7ef99642008-12-01 13:13:55 -0800309 .extra1 = &zero,
Robin Holt52bd19f72011-01-12 17:00:01 -0800310 .extra2 = &long_max,
Davide Libenzi7ef99642008-12-01 13:13:55 -0800311 },
Eric W. Biedermanab092032009-11-05 14:25:10 -0800312 { }
Davide Libenzi7ef99642008-12-01 13:13:55 -0800313};
314#endif /* CONFIG_SYSCTL */
315
Jason Baron28d82dc2012-01-12 17:17:43 -0800316static const struct file_operations eventpoll_fops;
317
318static inline int is_file_epoll(struct file *f)
319{
320 return f->f_op == &eventpoll_fops;
321}
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700322
Davide Libenzi67647d02007-05-15 01:40:52 -0700323/* Setup the structure that is used as key for the RB tree */
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700324static inline void ep_set_ffd(struct epoll_filefd *ffd,
325 struct file *file, int fd)
326{
327 ffd->file = file;
328 ffd->fd = fd;
329}
330
Davide Libenzi67647d02007-05-15 01:40:52 -0700331/* Compare RB tree keys */
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700332static inline int ep_cmp_ffd(struct epoll_filefd *p1,
333 struct epoll_filefd *p2)
334{
335 return (p1->file > p2->file ? +1:
336 (p1->file < p2->file ? -1 : p1->fd - p2->fd));
337}
338
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700339/* Tells us if the item is currently linked */
Davidlohr Bueso992991c2018-08-21 21:58:26 -0700340static inline int ep_is_linked(struct epitem *epi)
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700341{
Davidlohr Bueso992991c2018-08-21 21:58:26 -0700342 return !list_empty(&epi->rdllink);
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700343}
344
Ingo Molnarac6424b2017-06-20 12:06:13 +0200345static inline struct eppoll_entry *ep_pwq_from_wait(wait_queue_entry_t *p)
Oleg Nesterov971316f2012-02-24 20:07:29 +0100346{
347 return container_of(p, struct eppoll_entry, wait);
348}
349
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700350/* Get the "struct epitem" from a wait queue pointer */
Ingo Molnarac6424b2017-06-20 12:06:13 +0200351static inline struct epitem *ep_item_from_wait(wait_queue_entry_t *p)
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700352{
353 return container_of(p, struct eppoll_entry, wait)->base;
354}
355
356/* Get the "struct epitem" from an epoll queue wrapper */
Davide Libenzicdac75e2008-04-29 00:58:34 -0700357static inline struct epitem *ep_item_from_epqueue(poll_table *p)
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700358{
359 return container_of(p, struct ep_pqueue, pt)->epi;
360}
361
362/* Tells if the epoll_ctl(2) operation needs an event copy from userspace */
Davide Libenzi6192bd52007-05-08 00:25:41 -0700363static inline int ep_op_has_event(int op)
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700364{
Andrew Mortona80a6b82012-11-08 15:53:35 -0800365 return op != EPOLL_CTL_DEL;
Pekka Enbergb030a4d2005-06-23 00:10:03 -0700366}
367
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368/* Initialize the poll safe wake up structure */
Davide Libenzi5071f972009-03-31 15:24:10 -0700369static void ep_nested_calls_init(struct nested_calls *ncalls)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370{
Davide Libenzi5071f972009-03-31 15:24:10 -0700371 INIT_LIST_HEAD(&ncalls->tasks_call_list);
372 spin_lock_init(&ncalls->lock);
373}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374
Davide Libenzi5071f972009-03-31 15:24:10 -0700375/**
Davide Libenzi3fb0e582011-03-22 16:34:46 -0700376 * ep_events_available - Checks if ready events might be available.
377 *
378 * @ep: Pointer to the eventpoll context.
379 *
380 * Returns: Returns a value different than zero if ready events are available,
381 * or zero otherwise.
382 */
383static inline int ep_events_available(struct eventpoll *ep)
384{
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -0800385 return !list_empty_careful(&ep->rdllist) ||
386 READ_ONCE(ep->ovflist) != EP_UNACTIVE_PTR;
Davide Libenzi3fb0e582011-03-22 16:34:46 -0700387}
388
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700389#ifdef CONFIG_NET_RX_BUSY_POLL
390static bool ep_busy_loop_end(void *p, unsigned long start_time)
391{
392 struct eventpoll *ep = p;
393
394 return ep_events_available(ep) || busy_loop_timeout(start_time);
395}
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700396
397/*
398 * Busy poll if globally on and supporting sockets found && no events,
399 * busy loop will return if need_resched or ep_events_available.
400 *
401 * we must do our busy polling with irqs enabled
402 */
403static void ep_busy_loop(struct eventpoll *ep, int nonblock)
404{
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700405 unsigned int napi_id = READ_ONCE(ep->napi_id);
406
407 if ((napi_id >= MIN_NAPI_ID) && net_busy_loop_on())
408 napi_busy_loop(napi_id, nonblock ? NULL : ep_busy_loop_end, ep);
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700409}
410
411static inline void ep_reset_busy_poll_napi_id(struct eventpoll *ep)
412{
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700413 if (ep->napi_id)
414 ep->napi_id = 0;
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700415}
416
417/*
418 * Set epoll busy poll NAPI ID from sk.
419 */
420static inline void ep_set_busy_poll_napi_id(struct epitem *epi)
421{
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700422 struct eventpoll *ep;
423 unsigned int napi_id;
424 struct socket *sock;
425 struct sock *sk;
426 int err;
427
428 if (!net_busy_loop_on())
429 return;
430
431 sock = sock_from_file(epi->ffd.file, &err);
432 if (!sock)
433 return;
434
435 sk = sock->sk;
436 if (!sk)
437 return;
438
439 napi_id = READ_ONCE(sk->sk_napi_id);
440 ep = epi->ep;
441
442 /* Non-NAPI IDs can be rejected
443 * or
444 * Nothing to do if we already have this ID
445 */
446 if (napi_id < MIN_NAPI_ID || napi_id == ep->napi_id)
447 return;
448
449 /* record NAPI ID for use in next busy poll */
450 ep->napi_id = napi_id;
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -0700451}
452
Davidlohr Bueso514056d2018-08-21 21:58:19 -0700453#else
454
455static inline void ep_busy_loop(struct eventpoll *ep, int nonblock)
456{
457}
458
459static inline void ep_reset_busy_poll_napi_id(struct eventpoll *ep)
460{
461}
462
463static inline void ep_set_busy_poll_napi_id(struct epitem *epi)
464{
465}
466
467#endif /* CONFIG_NET_RX_BUSY_POLL */
468
Davide Libenzi3fb0e582011-03-22 16:34:46 -0700469/**
Davide Libenzi5071f972009-03-31 15:24:10 -0700470 * ep_call_nested - Perform a bound (possibly) nested call, by checking
471 * that the recursion limit is not exceeded, and that
472 * the same nested call (by the meaning of same cookie) is
473 * no re-entered.
474 *
475 * @ncalls: Pointer to the nested_calls structure to be used for this call.
Davide Libenzi5071f972009-03-31 15:24:10 -0700476 * @nproc: Nested call core function pointer.
477 * @priv: Opaque data to be passed to the @nproc callback.
478 * @cookie: Cookie to be used to identify this nested call.
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700479 * @ctx: This instance context.
Davide Libenzi5071f972009-03-31 15:24:10 -0700480 *
481 * Returns: Returns the code returned by the @nproc callback, or -1 if
482 * the maximum recursion limit has been exceeded.
483 */
Davidlohr Bueso74bdc122019-01-03 15:27:02 -0800484static int ep_call_nested(struct nested_calls *ncalls,
Davide Libenzi5071f972009-03-31 15:24:10 -0700485 int (*nproc)(void *, void *, int), void *priv,
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700486 void *cookie, void *ctx)
Davide Libenzi5071f972009-03-31 15:24:10 -0700487{
488 int error, call_nests = 0;
489 unsigned long flags;
Davide Libenzi5071f972009-03-31 15:24:10 -0700490 struct list_head *lsthead = &ncalls->tasks_call_list;
491 struct nested_call_node *tncur;
492 struct nested_call_node tnode;
493
494 spin_lock_irqsave(&ncalls->lock, flags);
495
496 /*
497 * Try to see if the current task is already inside this wakeup call.
498 * We use a list here, since the population inside this set is always
499 * very much limited.
500 */
501 list_for_each_entry(tncur, lsthead, llink) {
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700502 if (tncur->ctx == ctx &&
Davidlohr Bueso74bdc122019-01-03 15:27:02 -0800503 (tncur->cookie == cookie || ++call_nests > EP_MAX_NESTS)) {
Davide Libenzi5071f972009-03-31 15:24:10 -0700504 /*
505 * Ops ... loop detected or maximum nest level reached.
506 * We abort this wake by breaking the cycle itself.
507 */
Tony Battersbyabff55c2009-03-31 15:24:13 -0700508 error = -1;
509 goto out_unlock;
Davide Libenzi5071f972009-03-31 15:24:10 -0700510 }
511 }
512
513 /* Add the current task and cookie to the list */
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700514 tnode.ctx = ctx;
Davide Libenzi5071f972009-03-31 15:24:10 -0700515 tnode.cookie = cookie;
516 list_add(&tnode.llink, lsthead);
517
518 spin_unlock_irqrestore(&ncalls->lock, flags);
519
520 /* Call the nested function */
521 error = (*nproc)(priv, cookie, call_nests);
522
523 /* Remove the current task from the list */
524 spin_lock_irqsave(&ncalls->lock, flags);
525 list_del(&tnode.llink);
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700526out_unlock:
Davide Libenzi5071f972009-03-31 15:24:10 -0700527 spin_unlock_irqrestore(&ncalls->lock, flags);
528
529 return error;
530}
531
Steven Rostedt02edc6f2012-03-23 15:02:27 -0700532/*
533 * As described in commit 0ccf831cb lockdep: annotate epoll
534 * the use of wait queues used by epoll is done in a very controlled
535 * manner. Wake ups can nest inside each other, but are never done
536 * with the same locking. For example:
537 *
538 * dfd = socket(...);
539 * efd1 = epoll_create();
540 * efd2 = epoll_create();
541 * epoll_ctl(efd1, EPOLL_CTL_ADD, dfd, ...);
542 * epoll_ctl(efd2, EPOLL_CTL_ADD, efd1, ...);
543 *
544 * When a packet arrives to the device underneath "dfd", the net code will
545 * issue a wake_up() on its poll wake list. Epoll (efd1) has installed a
546 * callback wakeup entry on that queue, and the wake_up() performed by the
547 * "dfd" net code will end up in ep_poll_callback(). At this point epoll
548 * (efd1) notices that it may have some event ready, so it needs to wake up
549 * the waiters on its poll wait list (efd2). So it calls ep_poll_safewake()
550 * that ends up in another wake_up(), after having checked about the
551 * recursion constraints. That are, no more than EP_MAX_POLLWAKE_NESTS, to
552 * avoid stack blasting.
553 *
554 * When CONFIG_DEBUG_LOCK_ALLOC is enabled, make sure lockdep can handle
555 * this special case of epoll.
556 */
Davide Libenzi2dfa4ee2009-03-31 15:24:22 -0700557#ifdef CONFIG_DEBUG_LOCK_ALLOC
Davide Libenzi2dfa4ee2009-03-31 15:24:22 -0700558
Jason Baron57a173b2017-11-17 15:29:02 -0800559static struct nested_calls poll_safewake_ncalls;
Davide Libenzi2dfa4ee2009-03-31 15:24:22 -0700560
Davide Libenzi5071f972009-03-31 15:24:10 -0700561static int ep_poll_wakeup_proc(void *priv, void *cookie, int call_nests)
562{
Jason Baron57a173b2017-11-17 15:29:02 -0800563 unsigned long flags;
564 wait_queue_head_t *wqueue = (wait_queue_head_t *)cookie;
565
566 spin_lock_irqsave_nested(&wqueue->lock, flags, call_nests + 1);
Linus Torvaldsa9a08842018-02-11 14:34:03 -0800567 wake_up_locked_poll(wqueue, EPOLLIN);
Jason Baron57a173b2017-11-17 15:29:02 -0800568 spin_unlock_irqrestore(&wqueue->lock, flags);
569
Davide Libenzi5071f972009-03-31 15:24:10 -0700570 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571}
572
Davide Libenzi5071f972009-03-31 15:24:10 -0700573static void ep_poll_safewake(wait_queue_head_t *wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574{
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700575 int this_cpu = get_cpu();
576
Davidlohr Bueso74bdc122019-01-03 15:27:02 -0800577 ep_call_nested(&poll_safewake_ncalls,
Davide Libenzi3fe4a972009-06-17 16:25:58 -0700578 ep_poll_wakeup_proc, NULL, wq, (void *) (long) this_cpu);
579
580 put_cpu();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581}
582
Jason Baron57a173b2017-11-17 15:29:02 -0800583#else
584
585static void ep_poll_safewake(wait_queue_head_t *wq)
586{
Linus Torvaldsa9a08842018-02-11 14:34:03 -0800587 wake_up_poll(wq, EPOLLIN);
Jason Baron57a173b2017-11-17 15:29:02 -0800588}
589
590#endif
591
Oleg Nesterov971316f2012-02-24 20:07:29 +0100592static void ep_remove_wait_queue(struct eppoll_entry *pwq)
593{
594 wait_queue_head_t *whead;
595
596 rcu_read_lock();
Oleg Nesterov138e4ad2017-09-01 18:55:33 +0200597 /*
598 * If it is cleared by POLLFREE, it should be rcu-safe.
599 * If we read NULL we need a barrier paired with
600 * smp_store_release() in ep_poll_callback(), otherwise
601 * we rely on whead->lock.
602 */
603 whead = smp_load_acquire(&pwq->whead);
Oleg Nesterov971316f2012-02-24 20:07:29 +0100604 if (whead)
605 remove_wait_queue(whead, &pwq->wait);
606 rcu_read_unlock();
607}
608
Davide Libenzi7699acd2007-05-10 22:23:23 -0700609/*
Tony Battersbyd1bc90d2009-03-31 15:24:15 -0700610 * This function unregisters poll callbacks from the associated file
611 * descriptor. Must be called with "mtx" held (or "epmutex" if called from
612 * ep_free).
Davide Libenzi7699acd2007-05-10 22:23:23 -0700613 */
614static void ep_unregister_pollwait(struct eventpoll *ep, struct epitem *epi)
615{
Davide Libenzi7699acd2007-05-10 22:23:23 -0700616 struct list_head *lsthead = &epi->pwqlist;
617 struct eppoll_entry *pwq;
618
Tony Battersbyd1bc90d2009-03-31 15:24:15 -0700619 while (!list_empty(lsthead)) {
620 pwq = list_first_entry(lsthead, struct eppoll_entry, llink);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700621
Tony Battersbyd1bc90d2009-03-31 15:24:15 -0700622 list_del(&pwq->llink);
Oleg Nesterov971316f2012-02-24 20:07:29 +0100623 ep_remove_wait_queue(pwq);
Tony Battersbyd1bc90d2009-03-31 15:24:15 -0700624 kmem_cache_free(pwq_cache, pwq);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700625 }
626}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627
Eric Wongeea1d582013-04-30 15:27:39 -0700628/* call only when ep->mtx is held */
629static inline struct wakeup_source *ep_wakeup_source(struct epitem *epi)
630{
631 return rcu_dereference_check(epi->ws, lockdep_is_held(&epi->ep->mtx));
632}
633
634/* call only when ep->mtx is held */
635static inline void ep_pm_stay_awake(struct epitem *epi)
636{
637 struct wakeup_source *ws = ep_wakeup_source(epi);
638
639 if (ws)
640 __pm_stay_awake(ws);
641}
642
643static inline bool ep_has_wakeup_source(struct epitem *epi)
644{
645 return rcu_access_pointer(epi->ws) ? true : false;
646}
647
648/* call when ep->mtx cannot be held (ep_poll_callback) */
649static inline void ep_pm_stay_awake_rcu(struct epitem *epi)
650{
651 struct wakeup_source *ws;
652
653 rcu_read_lock();
654 ws = rcu_dereference(epi->ws);
655 if (ws)
656 __pm_stay_awake(ws);
657 rcu_read_unlock();
658}
659
Davide Libenzi5071f972009-03-31 15:24:10 -0700660/**
661 * ep_scan_ready_list - Scans the ready list in a way that makes possible for
662 * the scan code, to call f_op->poll(). Also allows for
663 * O(NumReady) performance.
664 *
665 * @ep: Pointer to the epoll private data structure.
666 * @sproc: Pointer to the scan callback.
667 * @priv: Private opaque data passed to the @sproc callback.
Nelson Elhaged8805e62011-10-31 17:13:14 -0700668 * @depth: The current depth of recursive f_op->poll calls.
Jason Baron67347fe2013-11-12 15:10:18 -0800669 * @ep_locked: caller already holds ep->mtx
Davide Libenzi5071f972009-03-31 15:24:10 -0700670 *
671 * Returns: The same integer error code returned by the @sproc callback.
672 */
Al Virod85e2aa2018-02-01 15:24:58 -0500673static __poll_t ep_scan_ready_list(struct eventpoll *ep,
674 __poll_t (*sproc)(struct eventpoll *,
Davide Libenzi5071f972009-03-31 15:24:10 -0700675 struct list_head *, void *),
Jason Baron67347fe2013-11-12 15:10:18 -0800676 void *priv, int depth, bool ep_locked)
Davide Libenzi5071f972009-03-31 15:24:10 -0700677{
Al Virod85e2aa2018-02-01 15:24:58 -0500678 __poll_t res;
679 int pwake = 0;
Davide Libenzi5071f972009-03-31 15:24:10 -0700680 struct epitem *epi, *nepi;
Davide Libenzi296e2362009-03-31 15:24:11 -0700681 LIST_HEAD(txlist);
Davide Libenzi5071f972009-03-31 15:24:10 -0700682
Davidlohr Bueso92e64172018-08-21 21:56:45 -0700683 lockdep_assert_irqs_enabled();
684
Davide Libenzi5071f972009-03-31 15:24:10 -0700685 /*
686 * We need to lock this because we could be hit by
Tony Battersbye057e152009-03-31 15:24:15 -0700687 * eventpoll_release_file() and epoll_ctl().
Davide Libenzi5071f972009-03-31 15:24:10 -0700688 */
Jason Baron67347fe2013-11-12 15:10:18 -0800689
690 if (!ep_locked)
691 mutex_lock_nested(&ep->mtx, depth);
Davide Libenzi5071f972009-03-31 15:24:10 -0700692
693 /*
694 * Steal the ready list, and re-init the original one to the
695 * empty list. Also, set ep->ovflist to NULL so that events
696 * happening while looping w/out locks, are not lost. We cannot
697 * have the poll callback to queue directly on ep->rdllist,
698 * because we want the "sproc" callback to be able to do it
699 * in a lockless way.
700 */
Roman Penyaeva218cc42019-03-07 16:28:53 -0800701 write_lock_irq(&ep->lock);
Davide Libenzi296e2362009-03-31 15:24:11 -0700702 list_splice_init(&ep->rdllist, &txlist);
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -0800703 WRITE_ONCE(ep->ovflist, NULL);
Roman Penyaeva218cc42019-03-07 16:28:53 -0800704 write_unlock_irq(&ep->lock);
Davide Libenzi5071f972009-03-31 15:24:10 -0700705
706 /*
707 * Now call the callback function.
708 */
Al Virod85e2aa2018-02-01 15:24:58 -0500709 res = (*sproc)(ep, &txlist, priv);
Davide Libenzi5071f972009-03-31 15:24:10 -0700710
Roman Penyaeva218cc42019-03-07 16:28:53 -0800711 write_lock_irq(&ep->lock);
Davide Libenzi5071f972009-03-31 15:24:10 -0700712 /*
713 * During the time we spent inside the "sproc" callback, some
714 * other events might have been queued by the poll callback.
715 * We re-insert them inside the main ready-list here.
716 */
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -0800717 for (nepi = READ_ONCE(ep->ovflist); (epi = nepi) != NULL;
Davide Libenzi5071f972009-03-31 15:24:10 -0700718 nepi = epi->next, epi->next = EP_UNACTIVE_PTR) {
719 /*
720 * We need to check if the item is already in the list.
721 * During the "sproc" callback execution time, items are
722 * queued into ->ovflist but the "txlist" might already
723 * contain them, and the list_splice() below takes care of them.
724 */
Davidlohr Bueso992991c2018-08-21 21:58:26 -0700725 if (!ep_is_linked(epi)) {
Roman Penyaevc1411752019-03-07 16:28:46 -0800726 /*
727 * ->ovflist is LIFO, so we have to reverse it in order
728 * to keep in FIFO.
729 */
730 list_add(&epi->rdllink, &ep->rdllist);
Eric Wongeea1d582013-04-30 15:27:39 -0700731 ep_pm_stay_awake(epi);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200732 }
Davide Libenzi5071f972009-03-31 15:24:10 -0700733 }
734 /*
735 * We need to set back ep->ovflist to EP_UNACTIVE_PTR, so that after
736 * releasing the lock, events will be queued in the normal way inside
737 * ep->rdllist.
738 */
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -0800739 WRITE_ONCE(ep->ovflist, EP_UNACTIVE_PTR);
Davide Libenzi5071f972009-03-31 15:24:10 -0700740
741 /*
742 * Quickly re-inject items left on "txlist".
743 */
744 list_splice(&txlist, &ep->rdllist);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200745 __pm_relax(ep->ws);
Davide Libenzi5071f972009-03-31 15:24:10 -0700746
747 if (!list_empty(&ep->rdllist)) {
748 /*
Davide Libenzi296e2362009-03-31 15:24:11 -0700749 * Wake up (if active) both the eventpoll wait list and
750 * the ->poll() wait list (delayed after we release the lock).
Davide Libenzi5071f972009-03-31 15:24:10 -0700751 */
752 if (waitqueue_active(&ep->wq))
Roman Penyaeva218cc42019-03-07 16:28:53 -0800753 wake_up(&ep->wq);
Davide Libenzi5071f972009-03-31 15:24:10 -0700754 if (waitqueue_active(&ep->poll_wait))
755 pwake++;
756 }
Roman Penyaeva218cc42019-03-07 16:28:53 -0800757 write_unlock_irq(&ep->lock);
Davide Libenzi5071f972009-03-31 15:24:10 -0700758
Jason Baron67347fe2013-11-12 15:10:18 -0800759 if (!ep_locked)
760 mutex_unlock(&ep->mtx);
Davide Libenzi5071f972009-03-31 15:24:10 -0700761
762 /* We have to call this outside the lock */
763 if (pwake)
764 ep_poll_safewake(&ep->poll_wait);
765
Al Virod85e2aa2018-02-01 15:24:58 -0500766 return res;
Davide Libenzi5071f972009-03-31 15:24:10 -0700767}
768
Jason Baronae10b2b2013-11-12 15:10:16 -0800769static void epi_rcu_free(struct rcu_head *head)
770{
771 struct epitem *epi = container_of(head, struct epitem, rcu);
772 kmem_cache_free(epi_cache, epi);
773}
774
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775/*
Davide Libenzi7699acd2007-05-10 22:23:23 -0700776 * Removes a "struct epitem" from the eventpoll RB tree and deallocates
Davide Libenzic7ea7632007-05-15 01:40:47 -0700777 * all the associated resources. Must be called with "mtx" held.
Davide Libenzi7699acd2007-05-10 22:23:23 -0700778 */
779static int ep_remove(struct eventpoll *ep, struct epitem *epi)
780{
Davide Libenzi7699acd2007-05-10 22:23:23 -0700781 struct file *file = epi->ffd.file;
782
Davidlohr Bueso92e64172018-08-21 21:56:45 -0700783 lockdep_assert_irqs_enabled();
784
Davide Libenzi7699acd2007-05-10 22:23:23 -0700785 /*
Christoph Hellwigee8ef0a2018-08-21 21:56:26 -0700786 * Removes poll wait queue hooks.
Davide Libenzi7699acd2007-05-10 22:23:23 -0700787 */
788 ep_unregister_pollwait(ep, epi);
789
790 /* Remove the current item from the list of epoll hooks */
Jonathan Corbet68499912009-02-06 13:52:43 -0700791 spin_lock(&file->f_lock);
Jason Baronae10b2b2013-11-12 15:10:16 -0800792 list_del_rcu(&epi->fllink);
Jonathan Corbet68499912009-02-06 13:52:43 -0700793 spin_unlock(&file->f_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700795 rb_erase_cached(&epi->rbn, &ep->rbr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796
Roman Penyaeva218cc42019-03-07 16:28:53 -0800797 write_lock_irq(&ep->lock);
Davidlohr Bueso992991c2018-08-21 21:58:26 -0700798 if (ep_is_linked(epi))
Davide Libenzic7ea7632007-05-15 01:40:47 -0700799 list_del_init(&epi->rdllink);
Roman Penyaeva218cc42019-03-07 16:28:53 -0800800 write_unlock_irq(&ep->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801
Eric Wongeea1d582013-04-30 15:27:39 -0700802 wakeup_source_unregister(ep_wakeup_source(epi));
Jason Baronae10b2b2013-11-12 15:10:16 -0800803 /*
804 * At this point it is safe to free the eventpoll item. Use the union
805 * field epi->rcu, since we are trying to minimize the size of
806 * 'struct epitem'. The 'rbn' field is no longer in use. Protected by
807 * ep->mtx. The rcu read side, reverse_path_check_proc(), does not make
808 * use of the rbn field.
809 */
810 call_rcu(&epi->rcu, epi_rcu_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811
Robin Holt52bd19f72011-01-12 17:00:01 -0800812 atomic_long_dec(&ep->user->epoll_watches);
Davide Libenzi7ef99642008-12-01 13:13:55 -0800813
Davide Libenzic7ea7632007-05-15 01:40:47 -0700814 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815}
816
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817static void ep_free(struct eventpoll *ep)
818{
819 struct rb_node *rbp;
820 struct epitem *epi;
821
822 /* We need to release all tasks waiting for these file */
823 if (waitqueue_active(&ep->poll_wait))
Davide Libenzi5071f972009-03-31 15:24:10 -0700824 ep_poll_safewake(&ep->poll_wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825
826 /*
827 * We need to lock this because we could be hit by
828 * eventpoll_release_file() while we're freeing the "struct eventpoll".
Davide Libenzid47de162007-05-15 01:40:41 -0700829 * We do not need to hold "ep->mtx" here because the epoll file
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830 * is on the way to be removed and no one has references to it
831 * anymore. The only hit might come from eventpoll_release_file() but
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300832 * holding "epmutex" is sufficient here.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833 */
Arjan van de Ven144efe32006-03-23 03:00:32 -0800834 mutex_lock(&epmutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835
836 /*
837 * Walks through the whole tree by unregistering poll callbacks.
838 */
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700839 for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840 epi = rb_entry(rbp, struct epitem, rbn);
841
842 ep_unregister_pollwait(ep, epi);
Eric Dumazet91cf5ab2013-09-11 14:24:06 -0700843 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844 }
845
846 /*
Davide Libenzi6192bd52007-05-08 00:25:41 -0700847 * Walks through the whole tree by freeing each "struct epitem". At this
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848 * point we are sure no poll callbacks will be lingering around, and also by
Davide Libenzid47de162007-05-15 01:40:41 -0700849 * holding "epmutex" we can be sure that no file cleanup code will hit
Roman Penyaeva218cc42019-03-07 16:28:53 -0800850 * us during this operation. So we can avoid the lock on "ep->lock".
Eric Wongddf676c2013-04-30 15:27:40 -0700851 * We do not need to lock ep->mtx, either, we only do it to prevent
852 * a lockdep warning.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853 */
Eric Wongddf676c2013-04-30 15:27:40 -0700854 mutex_lock(&ep->mtx);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700855 while ((rbp = rb_first_cached(&ep->rbr)) != NULL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856 epi = rb_entry(rbp, struct epitem, rbn);
857 ep_remove(ep, epi);
Eric Dumazet91cf5ab2013-09-11 14:24:06 -0700858 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859 }
Eric Wongddf676c2013-04-30 15:27:40 -0700860 mutex_unlock(&ep->mtx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861
Arjan van de Ven144efe32006-03-23 03:00:32 -0800862 mutex_unlock(&epmutex);
Davide Libenzid47de162007-05-15 01:40:41 -0700863 mutex_destroy(&ep->mtx);
Davide Libenzi7ef99642008-12-01 13:13:55 -0800864 free_uid(ep->user);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +0200865 wakeup_source_unregister(ep->ws);
Davide Libenzif0ee9aa2007-05-15 01:40:57 -0700866 kfree(ep);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867}
868
Davide Libenzi7699acd2007-05-10 22:23:23 -0700869static int ep_eventpoll_release(struct inode *inode, struct file *file)
870{
871 struct eventpoll *ep = file->private_data;
872
Davide Libenzif0ee9aa2007-05-15 01:40:57 -0700873 if (ep)
Davide Libenzi7699acd2007-05-10 22:23:23 -0700874 ep_free(ep);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700875
Davide Libenzi7699acd2007-05-10 22:23:23 -0700876 return 0;
877}
878
Al Virod85e2aa2018-02-01 15:24:58 -0500879static __poll_t ep_read_events_proc(struct eventpoll *ep, struct list_head *head,
Jason Baron37b5e522017-11-17 15:29:06 -0800880 void *priv);
881static void ep_ptable_queue_proc(struct file *file, wait_queue_head_t *whead,
882 poll_table *pt);
Eric Wong450d89e2013-04-30 15:27:42 -0700883
Jason Baron37b5e522017-11-17 15:29:06 -0800884/*
885 * Differs from ep_eventpoll_poll() in that internal callers already have
886 * the ep->mtx so we need to start from depth=1, such that mutex_lock_nested()
887 * is correctly annotated.
888 */
Al Virod85e2aa2018-02-01 15:24:58 -0500889static __poll_t ep_item_poll(const struct epitem *epi, poll_table *pt,
Al Virobec1a5022017-11-28 19:43:33 -0500890 int depth)
Jason Baron37b5e522017-11-17 15:29:06 -0800891{
892 struct eventpoll *ep;
893 bool locked;
894
895 pt->_key = epi->event.events;
896 if (!is_file_epoll(epi->ffd.file))
Christoph Hellwig9965ed172018-03-05 07:26:05 -0800897 return vfs_poll(epi->ffd.file, pt) & epi->event.events;
Jason Baron37b5e522017-11-17 15:29:06 -0800898
899 ep = epi->ffd.file->private_data;
900 poll_wait(epi->ffd.file, &ep->poll_wait, pt);
901 locked = pt && (pt->_qproc == ep_ptable_queue_proc);
902
903 return ep_scan_ready_list(epi->ffd.file->private_data,
904 ep_read_events_proc, &depth, depth,
905 locked) & epi->event.events;
Eric Wong450d89e2013-04-30 15:27:42 -0700906}
907
Al Virod85e2aa2018-02-01 15:24:58 -0500908static __poll_t ep_read_events_proc(struct eventpoll *ep, struct list_head *head,
Davide Libenzi296e2362009-03-31 15:24:11 -0700909 void *priv)
Davide Libenzi5071f972009-03-31 15:24:10 -0700910{
911 struct epitem *epi, *tmp;
Hans Verkuil626cf232012-03-23 15:02:27 -0700912 poll_table pt;
Jason Baron37b5e522017-11-17 15:29:06 -0800913 int depth = *(int *)priv;
Davide Libenzi5071f972009-03-31 15:24:10 -0700914
Hans Verkuil626cf232012-03-23 15:02:27 -0700915 init_poll_funcptr(&pt, NULL);
Jason Baron37b5e522017-11-17 15:29:06 -0800916 depth++;
Eric Wong450d89e2013-04-30 15:27:42 -0700917
Davide Libenzi5071f972009-03-31 15:24:10 -0700918 list_for_each_entry_safe(epi, tmp, head, rdllink) {
Jason Baron37b5e522017-11-17 15:29:06 -0800919 if (ep_item_poll(epi, &pt, depth)) {
Linus Torvaldsa9a08842018-02-11 14:34:03 -0800920 return EPOLLIN | EPOLLRDNORM;
Jason Baron37b5e522017-11-17 15:29:06 -0800921 } else {
Davide Libenzi5071f972009-03-31 15:24:10 -0700922 /*
923 * Item has been dropped into the ready list by the poll
924 * callback, but it's not actually ready, as far as
925 * caller requested events goes. We can remove it here.
926 */
Eric Wongeea1d582013-04-30 15:27:39 -0700927 __pm_relax(ep_wakeup_source(epi));
Davide Libenzi5071f972009-03-31 15:24:10 -0700928 list_del_init(&epi->rdllink);
Davide Libenzi296e2362009-03-31 15:24:11 -0700929 }
Davide Libenzi5071f972009-03-31 15:24:10 -0700930 }
931
932 return 0;
933}
934
Linus Torvaldsa11e1d42018-06-28 09:43:44 -0700935static __poll_t ep_eventpoll_poll(struct file *file, poll_table *wait)
Davide Libenzi7699acd2007-05-10 22:23:23 -0700936{
Davide Libenzi7699acd2007-05-10 22:23:23 -0700937 struct eventpoll *ep = file->private_data;
Jason Baron37b5e522017-11-17 15:29:06 -0800938 int depth = 0;
Davide Libenzi7699acd2007-05-10 22:23:23 -0700939
Linus Torvaldsa11e1d42018-06-28 09:43:44 -0700940 /* Insert inside our poll wait queue */
941 poll_wait(file, &ep->poll_wait, wait);
942
Davide Libenzi5071f972009-03-31 15:24:10 -0700943 /*
944 * Proceed to find out if wanted events are really available inside
Jason Baron37b5e522017-11-17 15:29:06 -0800945 * the ready list.
Davide Libenzi5071f972009-03-31 15:24:10 -0700946 */
Jason Baron37b5e522017-11-17 15:29:06 -0800947 return ep_scan_ready_list(ep, ep_read_events_proc,
948 &depth, depth, false);
Davide Libenzi7699acd2007-05-10 22:23:23 -0700949}
950
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800951#ifdef CONFIG_PROC_FS
Joe Perchesa3816ab2014-09-29 16:08:25 -0700952static void ep_show_fdinfo(struct seq_file *m, struct file *f)
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800953{
954 struct eventpoll *ep = f->private_data;
955 struct rb_node *rbp;
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800956
957 mutex_lock(&ep->mtx);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -0700958 for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) {
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800959 struct epitem *epi = rb_entry(rbp, struct epitem, rbn);
Cyrill Gorcunov77493f02017-07-12 14:34:25 -0700960 struct inode *inode = file_inode(epi->ffd.file);
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800961
Cyrill Gorcunov77493f02017-07-12 14:34:25 -0700962 seq_printf(m, "tfd: %8d events: %8x data: %16llx "
963 " pos:%lli ino:%lx sdev:%x\n",
Joe Perchesa3816ab2014-09-29 16:08:25 -0700964 epi->ffd.fd, epi->event.events,
Cyrill Gorcunov77493f02017-07-12 14:34:25 -0700965 (long long)epi->event.data,
966 (long long)epi->ffd.file->f_pos,
967 inode->i_ino, inode->i_sb->s_dev);
Joe Perchesa3816ab2014-09-29 16:08:25 -0700968 if (seq_has_overflowed(m))
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800969 break;
970 }
971 mutex_unlock(&ep->mtx);
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800972}
973#endif
974
Davide Libenzi7699acd2007-05-10 22:23:23 -0700975/* File callbacks that implement the eventpoll file behaviour */
976static const struct file_operations eventpoll_fops = {
Cyrill Gorcunov138d22b2012-12-17 16:05:02 -0800977#ifdef CONFIG_PROC_FS
978 .show_fdinfo = ep_show_fdinfo,
979#endif
Davide Libenzi7699acd2007-05-10 22:23:23 -0700980 .release = ep_eventpoll_release,
Linus Torvaldsa11e1d42018-06-28 09:43:44 -0700981 .poll = ep_eventpoll_poll,
Arnd Bergmann6038f372010-08-15 18:52:59 +0200982 .llseek = noop_llseek,
Davide Libenzi7699acd2007-05-10 22:23:23 -0700983};
984
Davide Libenzi7699acd2007-05-10 22:23:23 -0700985/*
986 * This is called from eventpoll_release() to unlink files from the eventpoll
987 * interface. We need to have this facility to cleanup correctly files that are
988 * closed without being removed from the eventpoll interface.
989 */
990void eventpoll_release_file(struct file *file)
991{
Davide Libenzi7699acd2007-05-10 22:23:23 -0700992 struct eventpoll *ep;
Konstantin Khlebnikovebe06182014-06-17 06:58:05 +0400993 struct epitem *epi, *next;
Davide Libenzi7699acd2007-05-10 22:23:23 -0700994
995 /*
Jonathan Corbet68499912009-02-06 13:52:43 -0700996 * We don't want to get "file->f_lock" because it is not
Davide Libenzi7699acd2007-05-10 22:23:23 -0700997 * necessary. It is not necessary because we're in the "struct file"
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300998 * cleanup path, and this means that no one is using this file anymore.
Davide Libenzi5071f972009-03-31 15:24:10 -0700999 * So, for example, epoll_ctl() cannot hit here since if we reach this
Davide Libenzi67647d02007-05-15 01:40:52 -07001000 * point, the file counter already went to zero and fget() would fail.
Davide Libenzid47de162007-05-15 01:40:41 -07001001 * The only hit might come from ep_free() but by holding the mutex
Davide Libenzi7699acd2007-05-10 22:23:23 -07001002 * will correctly serialize the operation. We do need to acquire
Davide Libenzid47de162007-05-15 01:40:41 -07001003 * "ep->mtx" after "epmutex" because ep_remove() requires it when called
Davide Libenzi7699acd2007-05-10 22:23:23 -07001004 * from anywhere but ep_free().
Jonathan Corbet68499912009-02-06 13:52:43 -07001005 *
1006 * Besides, ep_remove() acquires the lock, so we can't hold it here.
Davide Libenzi7699acd2007-05-10 22:23:23 -07001007 */
1008 mutex_lock(&epmutex);
Konstantin Khlebnikovebe06182014-06-17 06:58:05 +04001009 list_for_each_entry_safe(epi, next, &file->f_ep_links, fllink) {
Davide Libenzi7699acd2007-05-10 22:23:23 -07001010 ep = epi->ep;
Nelson Elhaged8805e62011-10-31 17:13:14 -07001011 mutex_lock_nested(&ep->mtx, 0);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001012 ep_remove(ep, epi);
Davide Libenzid47de162007-05-15 01:40:41 -07001013 mutex_unlock(&ep->mtx);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001014 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07001015 mutex_unlock(&epmutex);
1016}
1017
1018static int ep_alloc(struct eventpoll **pep)
1019{
Davide Libenzi7ef99642008-12-01 13:13:55 -08001020 int error;
1021 struct user_struct *user;
1022 struct eventpoll *ep;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001023
Davide Libenzi7ef99642008-12-01 13:13:55 -08001024 user = get_current_user();
Davide Libenzi7ef99642008-12-01 13:13:55 -08001025 error = -ENOMEM;
1026 ep = kzalloc(sizeof(*ep), GFP_KERNEL);
1027 if (unlikely(!ep))
1028 goto free_uid;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001029
Davide Libenzid47de162007-05-15 01:40:41 -07001030 mutex_init(&ep->mtx);
Roman Penyaeva218cc42019-03-07 16:28:53 -08001031 rwlock_init(&ep->lock);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001032 init_waitqueue_head(&ep->wq);
1033 init_waitqueue_head(&ep->poll_wait);
1034 INIT_LIST_HEAD(&ep->rdllist);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001035 ep->rbr = RB_ROOT_CACHED;
Davide Libenzid47de162007-05-15 01:40:41 -07001036 ep->ovflist = EP_UNACTIVE_PTR;
Davide Libenzi7ef99642008-12-01 13:13:55 -08001037 ep->user = user;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001038
1039 *pep = ep;
1040
Davide Libenzi7699acd2007-05-10 22:23:23 -07001041 return 0;
Davide Libenzi7ef99642008-12-01 13:13:55 -08001042
1043free_uid:
1044 free_uid(user);
1045 return error;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001046}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047
1048/*
Davide Libenzic7ea7632007-05-15 01:40:47 -07001049 * Search the file inside the eventpoll tree. The RB tree operations
1050 * are protected by the "mtx" mutex, and ep_find() must be called with
1051 * "mtx" held.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001052 */
1053static struct epitem *ep_find(struct eventpoll *ep, struct file *file, int fd)
1054{
1055 int kcmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001056 struct rb_node *rbp;
1057 struct epitem *epi, *epir = NULL;
1058 struct epoll_filefd ffd;
1059
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001060 ep_set_ffd(&ffd, file, fd);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001061 for (rbp = ep->rbr.rb_root.rb_node; rbp; ) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001062 epi = rb_entry(rbp, struct epitem, rbn);
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001063 kcmp = ep_cmp_ffd(&ffd, &epi->ffd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001064 if (kcmp > 0)
1065 rbp = rbp->rb_right;
1066 else if (kcmp < 0)
1067 rbp = rbp->rb_left;
1068 else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069 epir = epi;
1070 break;
1071 }
1072 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001073
Linus Torvalds1da177e2005-04-16 15:20:36 -07001074 return epir;
1075}
1076
Cyrill Gorcunov92ef6da2017-07-12 14:34:31 -07001077#ifdef CONFIG_CHECKPOINT_RESTORE
Cyrill Gorcunov0791e362017-07-12 14:34:28 -07001078static struct epitem *ep_find_tfd(struct eventpoll *ep, int tfd, unsigned long toff)
1079{
1080 struct rb_node *rbp;
1081 struct epitem *epi;
1082
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001083 for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) {
Cyrill Gorcunov0791e362017-07-12 14:34:28 -07001084 epi = rb_entry(rbp, struct epitem, rbn);
1085 if (epi->ffd.fd == tfd) {
1086 if (toff == 0)
1087 return epi;
1088 else
1089 toff--;
1090 }
1091 cond_resched();
1092 }
1093
1094 return NULL;
1095}
1096
1097struct file *get_epoll_tfile_raw_ptr(struct file *file, int tfd,
1098 unsigned long toff)
1099{
1100 struct file *file_raw;
1101 struct eventpoll *ep;
1102 struct epitem *epi;
1103
1104 if (!is_file_epoll(file))
1105 return ERR_PTR(-EINVAL);
1106
1107 ep = file->private_data;
1108
1109 mutex_lock(&ep->mtx);
1110 epi = ep_find_tfd(ep, tfd, toff);
1111 if (epi)
1112 file_raw = epi->ffd.file;
1113 else
1114 file_raw = ERR_PTR(-ENOENT);
1115 mutex_unlock(&ep->mtx);
1116
1117 return file_raw;
1118}
Cyrill Gorcunov92ef6da2017-07-12 14:34:31 -07001119#endif /* CONFIG_CHECKPOINT_RESTORE */
Cyrill Gorcunov0791e362017-07-12 14:34:28 -07001120
Roman Penyaeva218cc42019-03-07 16:28:53 -08001121/**
1122 * Adds a new entry to the tail of the list in a lockless way, i.e.
1123 * multiple CPUs are allowed to call this function concurrently.
1124 *
1125 * Beware: it is necessary to prevent any other modifications of the
1126 * existing list until all changes are completed, in other words
1127 * concurrent list_add_tail_lockless() calls should be protected
1128 * with a read lock, where write lock acts as a barrier which
1129 * makes sure all list_add_tail_lockless() calls are fully
1130 * completed.
1131 *
1132 * Also an element can be locklessly added to the list only in one
1133 * direction i.e. either to the tail either to the head, otherwise
1134 * concurrent access will corrupt the list.
1135 *
1136 * Returns %false if element has been already added to the list, %true
1137 * otherwise.
1138 */
1139static inline bool list_add_tail_lockless(struct list_head *new,
1140 struct list_head *head)
1141{
1142 struct list_head *prev;
1143
1144 /*
1145 * This is simple 'new->next = head' operation, but cmpxchg()
1146 * is used in order to detect that same element has been just
1147 * added to the list from another CPU: the winner observes
1148 * new->next == new.
1149 */
1150 if (cmpxchg(&new->next, new, head) != new)
1151 return false;
1152
1153 /*
1154 * Initially ->next of a new element must be updated with the head
1155 * (we are inserting to the tail) and only then pointers are atomically
1156 * exchanged. XCHG guarantees memory ordering, thus ->next should be
1157 * updated before pointers are actually swapped and pointers are
1158 * swapped before prev->next is updated.
1159 */
1160
1161 prev = xchg(&head->prev, new);
1162
1163 /*
1164 * It is safe to modify prev->next and new->prev, because a new element
1165 * is added only to the tail and new->next is updated before XCHG.
1166 */
1167
1168 prev->next = new;
1169 new->prev = prev;
1170
1171 return true;
1172}
1173
1174/**
1175 * Chains a new epi entry to the tail of the ep->ovflist in a lockless way,
1176 * i.e. multiple CPUs are allowed to call this function concurrently.
1177 *
1178 * Returns %false if epi element has been already chained, %true otherwise.
1179 */
1180static inline bool chain_epi_lockless(struct epitem *epi)
1181{
1182 struct eventpoll *ep = epi->ep;
1183
1184 /* Check that the same epi has not been just chained from another CPU */
1185 if (cmpxchg(&epi->next, EP_UNACTIVE_PTR, NULL) != EP_UNACTIVE_PTR)
1186 return false;
1187
1188 /* Atomically exchange tail */
1189 epi->next = xchg(&ep->ovflist, epi);
1190
1191 return true;
1192}
1193
Linus Torvalds1da177e2005-04-16 15:20:36 -07001194/*
Davide Libenzi7699acd2007-05-10 22:23:23 -07001195 * This is the callback that is passed to the wait queue wakeup
Daniel Balutabf6a41d2011-01-30 23:42:29 +02001196 * mechanism. It is called by the stored file descriptors when they
Davide Libenzi7699acd2007-05-10 22:23:23 -07001197 * have events to report.
Roman Penyaeva218cc42019-03-07 16:28:53 -08001198 *
1199 * This callback takes a read lock in order not to content with concurrent
1200 * events from another file descriptors, thus all modifications to ->rdllist
1201 * or ->ovflist are lockless. Read lock is paired with the write lock from
1202 * ep_scan_ready_list(), which stops all list modifications and guarantees
1203 * that lists state is seen correctly.
1204 *
1205 * Another thing worth to mention is that ep_poll_callback() can be called
1206 * concurrently for the same @epi from different CPUs if poll table was inited
1207 * with several wait queues entries. Plural wakeup from different CPUs of a
1208 * single wait queue is serialized by wq.lock, but the case when multiple wait
1209 * queues are used should be detected accordingly. This is detected using
1210 * cmpxchg() operation.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001211 */
Ingo Molnarac6424b2017-06-20 12:06:13 +02001212static int ep_poll_callback(wait_queue_entry_t *wait, unsigned mode, int sync, void *key)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001213{
Davide Libenzi7699acd2007-05-10 22:23:23 -07001214 int pwake = 0;
Davide Libenzi7699acd2007-05-10 22:23:23 -07001215 struct epitem *epi = ep_item_from_wait(wait);
1216 struct eventpoll *ep = epi->ep;
Al Viro3ad6f932017-07-03 20:14:56 -04001217 __poll_t pollflags = key_to_poll(key);
Roman Penyaeva218cc42019-03-07 16:28:53 -08001218 unsigned long flags;
Jason Barondf0108c2016-01-20 14:59:24 -08001219 int ewake = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220
Roman Penyaeva218cc42019-03-07 16:28:53 -08001221 read_lock_irqsave(&ep->lock, flags);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001222
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -07001223 ep_set_busy_poll_napi_id(epi);
1224
Davide Libenzi7699acd2007-05-10 22:23:23 -07001225 /*
1226 * If the event mask does not contain any poll(2) event, we consider the
1227 * descriptor to be disabled. This condition is likely the effect of the
1228 * EPOLLONESHOT bit that disables the descriptor when an event is received,
1229 * until the next EPOLL_CTL_MOD will be issued.
1230 */
1231 if (!(epi->event.events & ~EP_PRIVATE_BITS))
Davide Libenzid47de162007-05-15 01:40:41 -07001232 goto out_unlock;
1233
1234 /*
Davide Libenzi2dfa4ee2009-03-31 15:24:22 -07001235 * Check the events coming with the callback. At this stage, not
1236 * every device reports the events in the "key" parameter of the
1237 * callback. We need to be able to handle both cases here, hence the
1238 * test for "key" != NULL before the event match test.
1239 */
Al Viro3ad6f932017-07-03 20:14:56 -04001240 if (pollflags && !(pollflags & epi->event.events))
Davide Libenzi2dfa4ee2009-03-31 15:24:22 -07001241 goto out_unlock;
1242
1243 /*
Daniel Balutabf6a41d2011-01-30 23:42:29 +02001244 * If we are transferring events to userspace, we can hold no locks
Davide Libenzid47de162007-05-15 01:40:41 -07001245 * (because we're accessing user memory, and because of linux f_op->poll()
Daniel Balutabf6a41d2011-01-30 23:42:29 +02001246 * semantics). All the events that happen during that period of time are
Davide Libenzid47de162007-05-15 01:40:41 -07001247 * chained in ep->ovflist and requeued later on.
1248 */
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001249 if (READ_ONCE(ep->ovflist) != EP_UNACTIVE_PTR) {
Roman Penyaeva218cc42019-03-07 16:28:53 -08001250 if (epi->next == EP_UNACTIVE_PTR &&
1251 chain_epi_lockless(epi))
Roman Penyaevc3e320b2019-03-07 16:28:49 -08001252 ep_pm_stay_awake_rcu(epi);
Davide Libenzid47de162007-05-15 01:40:41 -07001253 goto out_unlock;
1254 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07001255
1256 /* If this file is already in the ready list we exit soon */
Roman Penyaeva218cc42019-03-07 16:28:53 -08001257 if (!ep_is_linked(epi) &&
1258 list_add_tail_lockless(&epi->rdllink, &ep->rdllist)) {
Eric Wongeea1d582013-04-30 15:27:39 -07001259 ep_pm_stay_awake_rcu(epi);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001260 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07001261
Davide Libenzi7699acd2007-05-10 22:23:23 -07001262 /*
1263 * Wake up ( if active ) both the eventpoll wait list and the ->poll()
1264 * wait list.
1265 */
Jason Barondf0108c2016-01-20 14:59:24 -08001266 if (waitqueue_active(&ep->wq)) {
Jason Baronb6a515c2016-02-05 15:37:04 -08001267 if ((epi->event.events & EPOLLEXCLUSIVE) &&
Al Viro3ad6f932017-07-03 20:14:56 -04001268 !(pollflags & POLLFREE)) {
1269 switch (pollflags & EPOLLINOUT_BITS) {
Linus Torvaldsa9a08842018-02-11 14:34:03 -08001270 case EPOLLIN:
1271 if (epi->event.events & EPOLLIN)
Jason Baronb6a515c2016-02-05 15:37:04 -08001272 ewake = 1;
1273 break;
Linus Torvaldsa9a08842018-02-11 14:34:03 -08001274 case EPOLLOUT:
1275 if (epi->event.events & EPOLLOUT)
Jason Baronb6a515c2016-02-05 15:37:04 -08001276 ewake = 1;
1277 break;
1278 case 0:
1279 ewake = 1;
1280 break;
1281 }
1282 }
Roman Penyaeva218cc42019-03-07 16:28:53 -08001283 wake_up(&ep->wq);
Jason Barondf0108c2016-01-20 14:59:24 -08001284 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07001285 if (waitqueue_active(&ep->poll_wait))
1286 pwake++;
1287
Davide Libenzid47de162007-05-15 01:40:41 -07001288out_unlock:
Roman Penyaeva218cc42019-03-07 16:28:53 -08001289 read_unlock_irqrestore(&ep->lock, flags);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001290
1291 /* We have to call this outside the lock */
1292 if (pwake)
Davide Libenzi5071f972009-03-31 15:24:10 -07001293 ep_poll_safewake(&ep->poll_wait);
Davide Libenzi7699acd2007-05-10 22:23:23 -07001294
Oleg Nesterov138e4ad2017-09-01 18:55:33 +02001295 if (!(epi->event.events & EPOLLEXCLUSIVE))
1296 ewake = 1;
Jason Barondf0108c2016-01-20 14:59:24 -08001297
Al Viro3ad6f932017-07-03 20:14:56 -04001298 if (pollflags & POLLFREE) {
Oleg Nesterov138e4ad2017-09-01 18:55:33 +02001299 /*
1300 * If we race with ep_remove_wait_queue() it can miss
1301 * ->whead = NULL and do another remove_wait_queue() after
1302 * us, so we can't use __remove_wait_queue().
1303 */
1304 list_del_init(&wait->entry);
1305 /*
1306 * ->whead != NULL protects us from the race with ep_free()
1307 * or ep_remove(), ep_remove_wait_queue() takes whead->lock
1308 * held by the caller. Once we nullify it, nothing protects
1309 * ep/epi or even wait.
1310 */
1311 smp_store_release(&ep_pwq_from_wait(wait)->whead, NULL);
1312 }
1313
1314 return ewake;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001315}
1316
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317/*
1318 * This is the callback that is used to add our wait queue to the
1319 * target file wakeup lists.
1320 */
1321static void ep_ptable_queue_proc(struct file *file, wait_queue_head_t *whead,
1322 poll_table *pt)
1323{
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001324 struct epitem *epi = ep_item_from_epqueue(pt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325 struct eppoll_entry *pwq;
1326
Christoph Lametere94b1762006-12-06 20:33:17 -08001327 if (epi->nwait >= 0 && (pwq = kmem_cache_alloc(pwq_cache, GFP_KERNEL))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328 init_waitqueue_func_entry(&pwq->wait, ep_poll_callback);
1329 pwq->whead = whead;
1330 pwq->base = epi;
Jason Barondf0108c2016-01-20 14:59:24 -08001331 if (epi->event.events & EPOLLEXCLUSIVE)
1332 add_wait_queue_exclusive(whead, &pwq->wait);
1333 else
1334 add_wait_queue(whead, &pwq->wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001335 list_add_tail(&pwq->llink, &epi->pwqlist);
1336 epi->nwait++;
Davide Libenzi296e2362009-03-31 15:24:11 -07001337 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338 /* We have to signal that an error occurred */
1339 epi->nwait = -1;
Davide Libenzi296e2362009-03-31 15:24:11 -07001340 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001341}
1342
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343static void ep_rbtree_insert(struct eventpoll *ep, struct epitem *epi)
1344{
1345 int kcmp;
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001346 struct rb_node **p = &ep->rbr.rb_root.rb_node, *parent = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001347 struct epitem *epic;
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001348 bool leftmost = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001349
1350 while (*p) {
1351 parent = *p;
1352 epic = rb_entry(parent, struct epitem, rbn);
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001353 kcmp = ep_cmp_ffd(&epi->ffd, &epic->ffd);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001354 if (kcmp > 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355 p = &parent->rb_right;
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001356 leftmost = false;
1357 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358 p = &parent->rb_left;
1359 }
1360 rb_link_node(&epi->rbn, parent, p);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001361 rb_insert_color_cached(&epi->rbn, &ep->rbr, leftmost);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001362}
1363
Andrew Mortona80a6b82012-11-08 15:53:35 -08001364
1365
Jason Baron28d82dc2012-01-12 17:17:43 -08001366#define PATH_ARR_SIZE 5
1367/*
1368 * These are the number paths of length 1 to 5, that we are allowing to emanate
1369 * from a single file of interest. For example, we allow 1000 paths of length
1370 * 1, to emanate from each file of interest. This essentially represents the
1371 * potential wakeup paths, which need to be limited in order to avoid massive
1372 * uncontrolled wakeup storms. The common use case should be a single ep which
1373 * is connected to n file sources. In this case each file source has 1 path
1374 * of length 1. Thus, the numbers below should be more than sufficient. These
1375 * path limits are enforced during an EPOLL_CTL_ADD operation, since a modify
1376 * and delete can't add additional paths. Protected by the epmutex.
1377 */
1378static const int path_limits[PATH_ARR_SIZE] = { 1000, 500, 100, 50, 10 };
1379static int path_count[PATH_ARR_SIZE];
1380
1381static int path_count_inc(int nests)
1382{
Jason Baron93dc6102012-03-16 16:34:03 -04001383 /* Allow an arbitrary number of depth 1 paths */
1384 if (nests == 0)
1385 return 0;
1386
Jason Baron28d82dc2012-01-12 17:17:43 -08001387 if (++path_count[nests] > path_limits[nests])
1388 return -1;
1389 return 0;
1390}
1391
1392static void path_count_init(void)
1393{
1394 int i;
1395
1396 for (i = 0; i < PATH_ARR_SIZE; i++)
1397 path_count[i] = 0;
1398}
1399
1400static int reverse_path_check_proc(void *priv, void *cookie, int call_nests)
1401{
1402 int error = 0;
1403 struct file *file = priv;
1404 struct file *child_file;
1405 struct epitem *epi;
1406
Jason Baronae10b2b2013-11-12 15:10:16 -08001407 /* CTL_DEL can remove links here, but that can't increase our count */
1408 rcu_read_lock();
1409 list_for_each_entry_rcu(epi, &file->f_ep_links, fllink) {
Jason Baron28d82dc2012-01-12 17:17:43 -08001410 child_file = epi->ep->file;
1411 if (is_file_epoll(child_file)) {
1412 if (list_empty(&child_file->f_ep_links)) {
1413 if (path_count_inc(call_nests)) {
1414 error = -1;
1415 break;
1416 }
1417 } else {
1418 error = ep_call_nested(&poll_loop_ncalls,
Jason Baron28d82dc2012-01-12 17:17:43 -08001419 reverse_path_check_proc,
1420 child_file, child_file,
1421 current);
1422 }
1423 if (error != 0)
1424 break;
1425 } else {
1426 printk(KERN_ERR "reverse_path_check_proc: "
1427 "file is not an ep!\n");
1428 }
1429 }
Jason Baronae10b2b2013-11-12 15:10:16 -08001430 rcu_read_unlock();
Jason Baron28d82dc2012-01-12 17:17:43 -08001431 return error;
1432}
1433
1434/**
1435 * reverse_path_check - The tfile_check_list is list of file *, which have
1436 * links that are proposed to be newly added. We need to
1437 * make sure that those added links don't add too many
1438 * paths such that we will spend all our time waking up
1439 * eventpoll objects.
1440 *
1441 * Returns: Returns zero if the proposed links don't create too many paths,
1442 * -1 otherwise.
1443 */
1444static int reverse_path_check(void)
1445{
Jason Baron28d82dc2012-01-12 17:17:43 -08001446 int error = 0;
1447 struct file *current_file;
1448
1449 /* let's call this for all tfiles */
1450 list_for_each_entry(current_file, &tfile_check_list, f_tfile_llink) {
Jason Baron28d82dc2012-01-12 17:17:43 -08001451 path_count_init();
Davidlohr Bueso74bdc122019-01-03 15:27:02 -08001452 error = ep_call_nested(&poll_loop_ncalls,
Jason Baron28d82dc2012-01-12 17:17:43 -08001453 reverse_path_check_proc, current_file,
1454 current_file, current);
1455 if (error)
1456 break;
1457 }
1458 return error;
1459}
1460
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001461static int ep_create_wakeup_source(struct epitem *epi)
1462{
1463 const char *name;
Eric Wongeea1d582013-04-30 15:27:39 -07001464 struct wakeup_source *ws;
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001465
1466 if (!epi->ep->ws) {
1467 epi->ep->ws = wakeup_source_register("eventpoll");
1468 if (!epi->ep->ws)
1469 return -ENOMEM;
1470 }
1471
1472 name = epi->ffd.file->f_path.dentry->d_name.name;
Eric Wongeea1d582013-04-30 15:27:39 -07001473 ws = wakeup_source_register(name);
1474
1475 if (!ws)
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001476 return -ENOMEM;
Eric Wongeea1d582013-04-30 15:27:39 -07001477 rcu_assign_pointer(epi->ws, ws);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001478
1479 return 0;
1480}
1481
Eric Wongeea1d582013-04-30 15:27:39 -07001482/* rare code path, only used when EPOLL_CTL_MOD removes a wakeup source */
1483static noinline void ep_destroy_wakeup_source(struct epitem *epi)
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001484{
Eric Wongeea1d582013-04-30 15:27:39 -07001485 struct wakeup_source *ws = ep_wakeup_source(epi);
1486
Eric Wongd6d67e72013-04-30 15:27:43 -07001487 RCU_INIT_POINTER(epi->ws, NULL);
Eric Wongeea1d582013-04-30 15:27:39 -07001488
1489 /*
1490 * wait for ep_pm_stay_awake_rcu to finish, synchronize_rcu is
1491 * used internally by wakeup_source_remove, too (called by
1492 * wakeup_source_unregister), so we cannot use call_rcu
1493 */
1494 synchronize_rcu();
1495 wakeup_source_unregister(ws);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001496}
1497
Davide Libenzic7ea7632007-05-15 01:40:47 -07001498/*
1499 * Must be called with "mtx" held.
1500 */
Al Virobec1a5022017-11-28 19:43:33 -05001501static int ep_insert(struct eventpoll *ep, const struct epoll_event *event,
Jason Baron67347fe2013-11-12 15:10:18 -08001502 struct file *tfile, int fd, int full_check)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001503{
Al Virod85e2aa2018-02-01 15:24:58 -05001504 int error, pwake = 0;
1505 __poll_t revents;
Robin Holt52bd19f72011-01-12 17:00:01 -08001506 long user_watches;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001507 struct epitem *epi;
1508 struct ep_pqueue epq;
1509
Davidlohr Bueso92e64172018-08-21 21:56:45 -07001510 lockdep_assert_irqs_enabled();
1511
Robin Holt52bd19f72011-01-12 17:00:01 -08001512 user_watches = atomic_long_read(&ep->user->epoll_watches);
1513 if (unlikely(user_watches >= max_user_watches))
Davide Libenzi7ef99642008-12-01 13:13:55 -08001514 return -ENOSPC;
Christoph Lametere94b1762006-12-06 20:33:17 -08001515 if (!(epi = kmem_cache_alloc(epi_cache, GFP_KERNEL)))
Davide Libenzi7ef99642008-12-01 13:13:55 -08001516 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001517
1518 /* Item initialization follow here ... */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001519 INIT_LIST_HEAD(&epi->rdllink);
1520 INIT_LIST_HEAD(&epi->fllink);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001521 INIT_LIST_HEAD(&epi->pwqlist);
1522 epi->ep = ep;
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001523 ep_set_ffd(&epi->ffd, tfile, fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524 epi->event = *event;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001525 epi->nwait = 0;
Davide Libenzid47de162007-05-15 01:40:41 -07001526 epi->next = EP_UNACTIVE_PTR;
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001527 if (epi->event.events & EPOLLWAKEUP) {
1528 error = ep_create_wakeup_source(epi);
1529 if (error)
1530 goto error_create_wakeup_source;
1531 } else {
Eric Wongeea1d582013-04-30 15:27:39 -07001532 RCU_INIT_POINTER(epi->ws, NULL);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001533 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001534
1535 /* Initialize the poll table using the queue callback */
1536 epq.epi = epi;
1537 init_poll_funcptr(&epq.pt, ep_ptable_queue_proc);
1538
1539 /*
1540 * Attach the item to the poll hooks and get current event bits.
1541 * We can safely use the file* here because its usage count has
Davide Libenzic7ea7632007-05-15 01:40:47 -07001542 * been increased by the caller of this function. Note that after
1543 * this operation completes, the poll callback can start hitting
1544 * the new item.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001545 */
Jason Baron37b5e522017-11-17 15:29:06 -08001546 revents = ep_item_poll(epi, &epq.pt, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001547
1548 /*
1549 * We have to check if something went wrong during the poll wait queue
1550 * install process. Namely an allocation for a wait queue failed due
1551 * high memory pressure.
1552 */
Davide Libenzi7ef99642008-12-01 13:13:55 -08001553 error = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001554 if (epi->nwait < 0)
Davide Libenzi7699acd2007-05-10 22:23:23 -07001555 goto error_unregister;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001556
1557 /* Add the current item to the list of active epoll hook for this file */
Jonathan Corbet68499912009-02-06 13:52:43 -07001558 spin_lock(&tfile->f_lock);
Jason Baronae10b2b2013-11-12 15:10:16 -08001559 list_add_tail_rcu(&epi->fllink, &tfile->f_ep_links);
Jonathan Corbet68499912009-02-06 13:52:43 -07001560 spin_unlock(&tfile->f_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001561
Davide Libenzic7ea7632007-05-15 01:40:47 -07001562 /*
1563 * Add the current item to the RB tree. All RB tree operations are
1564 * protected by "mtx", and ep_insert() is called with "mtx" held.
1565 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001566 ep_rbtree_insert(ep, epi);
1567
Jason Baron28d82dc2012-01-12 17:17:43 -08001568 /* now check if we've created too many backpaths */
1569 error = -EINVAL;
Jason Baron67347fe2013-11-12 15:10:18 -08001570 if (full_check && reverse_path_check())
Jason Baron28d82dc2012-01-12 17:17:43 -08001571 goto error_remove_epi;
1572
Davide Libenzic7ea7632007-05-15 01:40:47 -07001573 /* We have to drop the new item inside our item list to keep track of it */
Roman Penyaeva218cc42019-03-07 16:28:53 -08001574 write_lock_irq(&ep->lock);
Davide Libenzic7ea7632007-05-15 01:40:47 -07001575
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -07001576 /* record NAPI ID of new item if present */
1577 ep_set_busy_poll_napi_id(epi);
1578
Linus Torvalds1da177e2005-04-16 15:20:36 -07001579 /* If the file is already "ready" we drop it inside the ready list */
Davidlohr Bueso992991c2018-08-21 21:58:26 -07001580 if (revents && !ep_is_linked(epi)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001581 list_add_tail(&epi->rdllink, &ep->rdllist);
Eric Wongeea1d582013-04-30 15:27:39 -07001582 ep_pm_stay_awake(epi);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001583
1584 /* Notify waiting tasks that events are available */
1585 if (waitqueue_active(&ep->wq))
Roman Penyaeva218cc42019-03-07 16:28:53 -08001586 wake_up(&ep->wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001587 if (waitqueue_active(&ep->poll_wait))
1588 pwake++;
1589 }
1590
Roman Penyaeva218cc42019-03-07 16:28:53 -08001591 write_unlock_irq(&ep->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001592
Robin Holt52bd19f72011-01-12 17:00:01 -08001593 atomic_long_inc(&ep->user->epoll_watches);
Davide Libenzi7ef99642008-12-01 13:13:55 -08001594
Linus Torvalds1da177e2005-04-16 15:20:36 -07001595 /* We have to call this outside the lock */
1596 if (pwake)
Davide Libenzi5071f972009-03-31 15:24:10 -07001597 ep_poll_safewake(&ep->poll_wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001598
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599 return 0;
1600
Jason Baron28d82dc2012-01-12 17:17:43 -08001601error_remove_epi:
1602 spin_lock(&tfile->f_lock);
Jason Baronae10b2b2013-11-12 15:10:16 -08001603 list_del_rcu(&epi->fllink);
Jason Baron28d82dc2012-01-12 17:17:43 -08001604 spin_unlock(&tfile->f_lock);
1605
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001606 rb_erase_cached(&epi->rbn, &ep->rbr);
Jason Baron28d82dc2012-01-12 17:17:43 -08001607
Davide Libenzi7699acd2007-05-10 22:23:23 -07001608error_unregister:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001609 ep_unregister_pollwait(ep, epi);
1610
1611 /*
1612 * We need to do this because an event could have been arrived on some
Davide Libenzi67647d02007-05-15 01:40:52 -07001613 * allocated wait queue. Note that we don't care about the ep->ovflist
1614 * list, since that is used/cleaned only inside a section bound by "mtx".
1615 * And ep_insert() is called with "mtx" held.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001616 */
Roman Penyaeva218cc42019-03-07 16:28:53 -08001617 write_lock_irq(&ep->lock);
Davidlohr Bueso992991c2018-08-21 21:58:26 -07001618 if (ep_is_linked(epi))
Davide Libenzi6192bd52007-05-08 00:25:41 -07001619 list_del_init(&epi->rdllink);
Roman Penyaeva218cc42019-03-07 16:28:53 -08001620 write_unlock_irq(&ep->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001621
Eric Wongeea1d582013-04-30 15:27:39 -07001622 wakeup_source_unregister(ep_wakeup_source(epi));
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001623
1624error_create_wakeup_source:
Pekka Enbergb030a4d2005-06-23 00:10:03 -07001625 kmem_cache_free(epi_cache, epi);
Davide Libenzi7ef99642008-12-01 13:13:55 -08001626
Linus Torvalds1da177e2005-04-16 15:20:36 -07001627 return error;
1628}
1629
Linus Torvalds1da177e2005-04-16 15:20:36 -07001630/*
1631 * Modify the interest event mask by dropping an event if the new mask
Davide Libenzic7ea7632007-05-15 01:40:47 -07001632 * has a match in the current file status. Must be called with "mtx" held.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001633 */
Al Virobec1a5022017-11-28 19:43:33 -05001634static int ep_modify(struct eventpoll *ep, struct epitem *epi,
1635 const struct epoll_event *event)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001636{
1637 int pwake = 0;
Hans Verkuil626cf232012-03-23 15:02:27 -07001638 poll_table pt;
1639
Davidlohr Bueso92e64172018-08-21 21:56:45 -07001640 lockdep_assert_irqs_enabled();
1641
Hans Verkuil626cf232012-03-23 15:02:27 -07001642 init_poll_funcptr(&pt, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643
1644 /*
Tony Battersbye057e152009-03-31 15:24:15 -07001645 * Set the new event interest mask before calling f_op->poll();
1646 * otherwise we might miss an event that happens between the
1647 * f_op->poll() call and the new event set registering.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001648 */
Eric Wong128dd172013-01-01 21:20:27 +00001649 epi->event.events = event->events; /* need barrier below */
Tony Battersbye057e152009-03-31 15:24:15 -07001650 epi->event.data = event->data; /* protected by mtx */
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001651 if (epi->event.events & EPOLLWAKEUP) {
Eric Wongeea1d582013-04-30 15:27:39 -07001652 if (!ep_has_wakeup_source(epi))
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001653 ep_create_wakeup_source(epi);
Eric Wongeea1d582013-04-30 15:27:39 -07001654 } else if (ep_has_wakeup_source(epi)) {
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001655 ep_destroy_wakeup_source(epi);
1656 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657
1658 /*
Eric Wong128dd172013-01-01 21:20:27 +00001659 * The following barrier has two effects:
1660 *
1661 * 1) Flush epi changes above to other CPUs. This ensures
1662 * we do not miss events from ep_poll_callback if an
1663 * event occurs immediately after we call f_op->poll().
Roman Penyaeva218cc42019-03-07 16:28:53 -08001664 * We need this because we did not take ep->lock while
Eric Wong128dd172013-01-01 21:20:27 +00001665 * changing epi above (but ep_poll_callback does take
Roman Penyaeva218cc42019-03-07 16:28:53 -08001666 * ep->lock).
Eric Wong128dd172013-01-01 21:20:27 +00001667 *
1668 * 2) We also need to ensure we do not miss _past_ events
1669 * when calling f_op->poll(). This barrier also
1670 * pairs with the barrier in wq_has_sleeper (see
1671 * comments for wq_has_sleeper).
1672 *
1673 * This barrier will now guarantee ep_poll_callback or f_op->poll
1674 * (or both) will notice the readiness of an item.
1675 */
1676 smp_mb();
1677
1678 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001679 * Get current event bits. We can safely use the file* here because
1680 * its usage count has been increased by the caller of this function.
Davide Libenzic7ea7632007-05-15 01:40:47 -07001681 * If the item is "hot" and it is not registered inside the ready
Davide Libenzi67647d02007-05-15 01:40:52 -07001682 * list, push it inside.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001683 */
Al Viro69112732017-11-28 19:56:15 -05001684 if (ep_item_poll(epi, &pt, 1)) {
Roman Penyaeva218cc42019-03-07 16:28:53 -08001685 write_lock_irq(&ep->lock);
Davidlohr Bueso992991c2018-08-21 21:58:26 -07001686 if (!ep_is_linked(epi)) {
Davide Libenzic7ea7632007-05-15 01:40:47 -07001687 list_add_tail(&epi->rdllink, &ep->rdllist);
Eric Wongeea1d582013-04-30 15:27:39 -07001688 ep_pm_stay_awake(epi);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001689
Davide Libenzic7ea7632007-05-15 01:40:47 -07001690 /* Notify waiting tasks that events are available */
1691 if (waitqueue_active(&ep->wq))
Roman Penyaeva218cc42019-03-07 16:28:53 -08001692 wake_up(&ep->wq);
Davide Libenzic7ea7632007-05-15 01:40:47 -07001693 if (waitqueue_active(&ep->poll_wait))
1694 pwake++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001695 }
Roman Penyaeva218cc42019-03-07 16:28:53 -08001696 write_unlock_irq(&ep->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001697 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001698
1699 /* We have to call this outside the lock */
1700 if (pwake)
Davide Libenzi5071f972009-03-31 15:24:10 -07001701 ep_poll_safewake(&ep->poll_wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001702
1703 return 0;
1704}
1705
Al Virod85e2aa2018-02-01 15:24:58 -05001706static __poll_t ep_send_events_proc(struct eventpoll *ep, struct list_head *head,
Davide Libenzi296e2362009-03-31 15:24:11 -07001707 void *priv)
Davide Libenzi5071f972009-03-31 15:24:10 -07001708{
1709 struct ep_send_events_data *esed = priv;
Al Virod85e2aa2018-02-01 15:24:58 -05001710 __poll_t revents;
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001711 struct epitem *epi, *tmp;
1712 struct epoll_event __user *uevent = esed->events;
Eric Wongeea1d582013-04-30 15:27:39 -07001713 struct wakeup_source *ws;
Hans Verkuil626cf232012-03-23 15:02:27 -07001714 poll_table pt;
1715
1716 init_poll_funcptr(&pt, NULL);
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001717 esed->res = 0;
Davide Libenzi5071f972009-03-31 15:24:10 -07001718
Davide Libenzi296e2362009-03-31 15:24:11 -07001719 /*
Davide Libenzi5071f972009-03-31 15:24:10 -07001720 * We can loop without lock because we are passed a task private list.
1721 * Items cannot vanish during the loop because ep_scan_ready_list() is
1722 * holding "mtx" during this call.
Davide Libenzi296e2362009-03-31 15:24:11 -07001723 */
Davidlohr Bueso21877e12019-01-03 15:27:12 -08001724 lockdep_assert_held(&ep->mtx);
1725
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001726 list_for_each_entry_safe(epi, tmp, head, rdllink) {
1727 if (esed->res >= esed->maxevents)
1728 break;
Davide Libenzi5071f972009-03-31 15:24:10 -07001729
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02001730 /*
1731 * Activate ep->ws before deactivating epi->ws to prevent
1732 * triggering auto-suspend here (in case we reactive epi->ws
1733 * below).
1734 *
1735 * This could be rearranged to delay the deactivation of epi->ws
1736 * instead, but then epi->ws would temporarily be out of sync
1737 * with ep_is_linked().
1738 */
Eric Wongeea1d582013-04-30 15:27:39 -07001739 ws = ep_wakeup_source(epi);
1740 if (ws) {
1741 if (ws->active)
1742 __pm_stay_awake(ep->ws);
1743 __pm_relax(ws);
1744 }
1745
Davide Libenzi5071f972009-03-31 15:24:10 -07001746 list_del_init(&epi->rdllink);
1747
Davide Libenzi296e2362009-03-31 15:24:11 -07001748 /*
Davide Libenzi5071f972009-03-31 15:24:10 -07001749 * If the event mask intersect the caller-requested one,
1750 * deliver the event to userspace. Again, ep_scan_ready_list()
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001751 * is holding ep->mtx, so no operations coming from userspace
Davide Libenzi5071f972009-03-31 15:24:10 -07001752 * can change the item.
Davide Libenzi296e2362009-03-31 15:24:11 -07001753 */
Davidlohr Bueso4e0982a2019-01-03 15:27:05 -08001754 revents = ep_item_poll(epi, &pt, 1);
1755 if (!revents)
1756 continue;
1757
1758 if (__put_user(revents, &uevent->events) ||
1759 __put_user(epi->event.data, &uevent->data)) {
1760 list_add(&epi->rdllink, head);
1761 ep_pm_stay_awake(epi);
1762 if (!esed->res)
1763 esed->res = -EFAULT;
1764 return 0;
1765 }
1766 esed->res++;
1767 uevent++;
1768 if (epi->event.events & EPOLLONESHOT)
1769 epi->event.events &= EP_PRIVATE_BITS;
1770 else if (!(epi->event.events & EPOLLET)) {
1771 /*
1772 * If this file has been added with Level
1773 * Trigger mode, we need to insert back inside
1774 * the ready list, so that the next call to
1775 * epoll_wait() will check again the events
1776 * availability. At this point, no one can insert
1777 * into ep->rdllist besides us. The epoll_ctl()
1778 * callers are locked out by
1779 * ep_scan_ready_list() holding "mtx" and the
1780 * poll callback will queue them in ep->ovflist.
1781 */
1782 list_add_tail(&epi->rdllink, &ep->rdllist);
1783 ep_pm_stay_awake(epi);
Davide Libenzi296e2362009-03-31 15:24:11 -07001784 }
1785 }
Davide Libenzi5071f972009-03-31 15:24:10 -07001786
Al Virod7ebbe42018-02-01 15:21:13 -05001787 return 0;
Davide Libenzi5071f972009-03-31 15:24:10 -07001788}
1789
Davide Libenzi296e2362009-03-31 15:24:11 -07001790static int ep_send_events(struct eventpoll *ep,
1791 struct epoll_event __user *events, int maxevents)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001792{
Davide Libenzi5071f972009-03-31 15:24:10 -07001793 struct ep_send_events_data esed;
Davide Libenzi6192bd52007-05-08 00:25:41 -07001794
Davide Libenzi5071f972009-03-31 15:24:10 -07001795 esed.maxevents = maxevents;
1796 esed.events = events;
Davide Libenzid47de162007-05-15 01:40:41 -07001797
Al Virod7ebbe42018-02-01 15:21:13 -05001798 ep_scan_ready_list(ep, ep_send_events_proc, &esed, 0, false);
1799 return esed.res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800}
1801
Deepa Dinamani766b9f92016-05-19 17:09:05 -07001802static inline struct timespec64 ep_set_mstimeout(long ms)
Eric Dumazet0781b902011-02-01 15:52:35 -08001803{
Deepa Dinamani766b9f92016-05-19 17:09:05 -07001804 struct timespec64 now, ts = {
Eric Dumazet0781b902011-02-01 15:52:35 -08001805 .tv_sec = ms / MSEC_PER_SEC,
1806 .tv_nsec = NSEC_PER_MSEC * (ms % MSEC_PER_SEC),
1807 };
1808
Deepa Dinamani766b9f92016-05-19 17:09:05 -07001809 ktime_get_ts64(&now);
1810 return timespec64_add_safe(now, ts);
Eric Dumazet0781b902011-02-01 15:52:35 -08001811}
1812
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001813/**
1814 * ep_poll - Retrieves ready events, and delivers them to the caller supplied
1815 * event buffer.
1816 *
1817 * @ep: Pointer to the eventpoll context.
1818 * @events: Pointer to the userspace buffer where the ready events should be
1819 * stored.
1820 * @maxevents: Size (in terms of number of events) of the caller event buffer.
1821 * @timeout: Maximum timeout for the ready events fetch operation, in
1822 * milliseconds. If the @timeout is zero, the function will not block,
1823 * while if the @timeout is less than zero, the function will block
1824 * until at least one event has been retrieved (or an error
1825 * occurred).
1826 *
1827 * Returns: Returns the number of ready events which have been fetched, or an
1828 * error code, in case of error.
1829 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001830static int ep_poll(struct eventpoll *ep, struct epoll_event __user *events,
1831 int maxevents, long timeout)
1832{
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001833 int res = 0, eavail, timed_out = 0;
John Stultzda8b44d2016-03-17 14:20:51 -07001834 u64 slack = 0;
Davidlohr Bueso86c05172019-01-03 15:27:26 -08001835 bool waiter = false;
Ingo Molnarac6424b2017-06-20 12:06:13 +02001836 wait_queue_entry_t wait;
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001837 ktime_t expires, *to = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001838
Davidlohr Bueso679abf32018-08-21 21:58:23 -07001839 lockdep_assert_irqs_enabled();
1840
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001841 if (timeout > 0) {
Deepa Dinamani766b9f92016-05-19 17:09:05 -07001842 struct timespec64 end_time = ep_set_mstimeout(timeout);
Eric Dumazet0781b902011-02-01 15:52:35 -08001843
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001844 slack = select_estimate_accuracy(&end_time);
1845 to = &expires;
Deepa Dinamani766b9f92016-05-19 17:09:05 -07001846 *to = timespec64_to_ktime(end_time);
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001847 } else if (timeout == 0) {
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001848 /*
1849 * Avoid the unnecessary trip to the wait queue loop, if the
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001850 * caller specified a non blocking operation. We still need
1851 * lock because we could race and not see an epi being added
1852 * to the ready list while in irq callback. Thus incorrectly
1853 * returning 0 back to userspace.
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001854 */
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001855 timed_out = 1;
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001856
Roman Penyaeva218cc42019-03-07 16:28:53 -08001857 write_lock_irq(&ep->lock);
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001858 eavail = ep_events_available(ep);
Roman Penyaeva218cc42019-03-07 16:28:53 -08001859 write_unlock_irq(&ep->lock);
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001860
Davidlohr Bueso35cff1a2019-01-03 15:27:22 -08001861 goto send_events;
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001862 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001863
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001864fetch_events:
Sridhar Samudralabf3b9f62017-03-24 10:08:30 -07001865
1866 if (!ep_events_available(ep))
1867 ep_busy_loop(ep, timed_out);
1868
Davide Libenzi3fb0e582011-03-22 16:34:46 -07001869 eavail = ep_events_available(ep);
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001870 if (eavail)
Davidlohr Bueso35cff1a2019-01-03 15:27:22 -08001871 goto send_events;
Jason Baron28d82dc2012-01-12 17:17:43 -08001872
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001873 /*
1874 * Busy poll timed out. Drop NAPI ID for now, we can add
1875 * it back in when we have moved a socket with a valid NAPI
1876 * ID onto the ready list.
1877 */
1878 ep_reset_busy_poll_napi_id(ep);
Jason Baron28d82dc2012-01-12 17:17:43 -08001879
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001880 /*
Davidlohr Bueso86c05172019-01-03 15:27:26 -08001881 * We don't have any available event to return to the caller. We need
1882 * to sleep here, and we will be woken by ep_poll_callback() when events
1883 * become available.
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001884 */
Davidlohr Bueso86c05172019-01-03 15:27:26 -08001885 if (!waiter) {
1886 waiter = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001887 init_waitqueue_entry(&wait, current);
Davidlohr Bueso86c05172019-01-03 15:27:26 -08001888
1889 spin_lock_irq(&ep->wq.lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001890 __add_wait_queue_exclusive(&ep->wq, &wait);
Davidlohr Bueso86c05172019-01-03 15:27:26 -08001891 spin_unlock_irq(&ep->wq.lock);
1892 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001893
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001894 for (;;) {
1895 /*
1896 * We don't want to sleep if the ep_poll_callback() sends us
1897 * a wakeup in between. That's why we set the task state
1898 * to TASK_INTERRUPTIBLE before doing the checks.
1899 */
1900 set_current_state(TASK_INTERRUPTIBLE);
1901 /*
1902 * Always short-circuit for fatal signals to allow
1903 * threads to make a timely exit without the chance of
1904 * finding more events available and fetching
1905 * repeatedly.
1906 */
1907 if (fatal_signal_pending(current)) {
1908 res = -EINTR;
1909 break;
Davide Libenzi5071f972009-03-31 15:24:10 -07001910 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001911
Davidlohr Buesoabc610e2019-01-03 15:27:19 -08001912 eavail = ep_events_available(ep);
1913 if (eavail)
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001914 break;
1915 if (signal_pending(current)) {
1916 res = -EINTR;
1917 break;
1918 }
1919
Davidlohr Buesoabc610e2019-01-03 15:27:19 -08001920 if (!schedule_hrtimeout_range(to, slack, HRTIMER_MODE_ABS)) {
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001921 timed_out = 1;
Davidlohr Buesoabc610e2019-01-03 15:27:19 -08001922 break;
1923 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001924 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001925
Davidlohr Buesoc5a282e2019-01-03 15:27:15 -08001926 __set_current_state(TASK_RUNNING);
Shawn Bohrer95aac7b2010-10-27 15:34:54 -07001927
Davidlohr Bueso35cff1a2019-01-03 15:27:22 -08001928send_events:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001929 /*
1930 * Try to transfer events to user space. In case we get 0 events and
1931 * there's still timeout left over, we go trying again in search of
1932 * more luck.
1933 */
Davide Libenzi22bacca2011-02-25 14:44:12 -08001934 if (!res && eavail &&
1935 !(res = ep_send_events(ep, events, maxevents)) && !timed_out)
1936 goto fetch_events;
1937
Davidlohr Bueso86c05172019-01-03 15:27:26 -08001938 if (waiter) {
1939 spin_lock_irq(&ep->wq.lock);
1940 __remove_wait_queue(&ep->wq, &wait);
1941 spin_unlock_irq(&ep->wq.lock);
1942 }
1943
Linus Torvalds1da177e2005-04-16 15:20:36 -07001944 return res;
1945}
1946
1947/**
Shawn Bohrerf4d93ad2011-03-22 16:34:47 -07001948 * ep_loop_check_proc - Callback function to be passed to the @ep_call_nested()
Linus Torvalds1da177e2005-04-16 15:20:36 -07001949 * API, to verify that adding an epoll file inside another
1950 * epoll structure, does not violate the constraints, in
1951 * terms of closed loops, or too deep chains (which can
1952 * result in excessive stack usage).
Davide Libenzi22bacca2011-02-25 14:44:12 -08001953 *
1954 * @priv: Pointer to the epoll file to be currently checked.
1955 * @cookie: Original cookie for this call. This is the top-of-the-chain epoll
1956 * data structure pointer.
1957 * @call_nests: Current dept of the @ep_call_nested() call stack.
1958 *
1959 * Returns: Returns zero if adding the epoll @file inside current epoll
1960 * structure @ep does not violate the constraints, or -1 otherwise.
1961 */
1962static int ep_loop_check_proc(void *priv, void *cookie, int call_nests)
1963{
1964 int error = 0;
1965 struct file *file = priv;
1966 struct eventpoll *ep = file->private_data;
1967 struct eventpoll *ep_tovisit;
1968 struct rb_node *rbp;
1969 struct epitem *epi;
1970
1971 mutex_lock_nested(&ep->mtx, call_nests + 1);
1972 ep->visited = 1;
1973 list_add(&ep->visited_list_link, &visited_list);
Davidlohr Buesob2ac2ea2017-09-08 16:15:18 -07001974 for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) {
Davide Libenzi22bacca2011-02-25 14:44:12 -08001975 epi = rb_entry(rbp, struct epitem, rbn);
Nelson Elhaged8805e62011-10-31 17:13:14 -07001976 if (unlikely(is_file_epoll(epi->ffd.file))) {
Davide Libenzi22bacca2011-02-25 14:44:12 -08001977 ep_tovisit = epi->ffd.file->private_data;
1978 if (ep_tovisit->visited)
1979 continue;
Davidlohr Bueso74bdc122019-01-03 15:27:02 -08001980 error = ep_call_nested(&poll_loop_ncalls,
Davide Libenzi22bacca2011-02-25 14:44:12 -08001981 ep_loop_check_proc, epi->ffd.file,
1982 ep_tovisit, current);
1983 if (error != 0)
1984 break;
Jason Baron28d82dc2012-01-12 17:17:43 -08001985 } else {
1986 /*
1987 * If we've reached a file that is not associated with
1988 * an ep, then we need to check if the newly added
1989 * links are going to add too many wakeup paths. We do
1990 * this by adding it to the tfile_check_list, if it's
1991 * not already there, and calling reverse_path_check()
1992 * during ep_insert().
1993 */
1994 if (list_empty(&epi->ffd.file->f_tfile_llink))
1995 list_add(&epi->ffd.file->f_tfile_llink,
1996 &tfile_check_list);
Davide Libenzi22bacca2011-02-25 14:44:12 -08001997 }
1998 }
1999 mutex_unlock(&ep->mtx);
2000
2001 return error;
2002}
2003
2004/**
2005 * ep_loop_check - Performs a check to verify that adding an epoll file (@file)
2006 * another epoll file (represented by @ep) does not create
2007 * closed loops or too deep chains.
2008 *
2009 * @ep: Pointer to the epoll private data structure.
2010 * @file: Pointer to the epoll file to be checked.
2011 *
2012 * Returns: Returns zero if adding the epoll @file inside current epoll
2013 * structure @ep does not violate the constraints, or -1 otherwise.
2014 */
2015static int ep_loop_check(struct eventpoll *ep, struct file *file)
2016{
Jason Baron28d82dc2012-01-12 17:17:43 -08002017 int ret;
2018 struct eventpoll *ep_cur, *ep_next;
2019
Davidlohr Bueso74bdc122019-01-03 15:27:02 -08002020 ret = ep_call_nested(&poll_loop_ncalls,
Davide Libenzi22bacca2011-02-25 14:44:12 -08002021 ep_loop_check_proc, file, ep, current);
Jason Baron28d82dc2012-01-12 17:17:43 -08002022 /* clear visited list */
2023 list_for_each_entry_safe(ep_cur, ep_next, &visited_list,
2024 visited_list_link) {
2025 ep_cur->visited = 0;
2026 list_del(&ep_cur->visited_list_link);
2027 }
2028 return ret;
2029}
2030
2031static void clear_tfile_check_list(void)
2032{
2033 struct file *file;
2034
2035 /* first clear the tfile_check_list */
2036 while (!list_empty(&tfile_check_list)) {
2037 file = list_first_entry(&tfile_check_list, struct file,
2038 f_tfile_llink);
2039 list_del_init(&file->f_tfile_llink);
2040 }
2041 INIT_LIST_HEAD(&tfile_check_list);
Davide Libenzi22bacca2011-02-25 14:44:12 -08002042}
2043
Davide Libenzi7699acd2007-05-10 22:23:23 -07002044/*
Andrew Morton523723b2008-08-12 15:09:01 -07002045 * Open an eventpoll file descriptor.
Davide Libenzi7699acd2007-05-10 22:23:23 -07002046 */
Dominik Brodowski791eb222018-03-11 11:34:30 +01002047static int do_epoll_create(int flags)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002048{
Jason Baron28d82dc2012-01-12 17:17:43 -08002049 int error, fd;
Davide Libenzibb57c3e2009-03-31 15:24:12 -07002050 struct eventpoll *ep = NULL;
Jason Baron28d82dc2012-01-12 17:17:43 -08002051 struct file *file;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002052
Ulrich Dreppere38b36f2008-07-23 21:29:42 -07002053 /* Check the EPOLL_* constant for consistency. */
2054 BUILD_BUG_ON(EPOLL_CLOEXEC != O_CLOEXEC);
2055
Davide Libenzi296e2362009-03-31 15:24:11 -07002056 if (flags & ~EPOLL_CLOEXEC)
2057 return -EINVAL;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002058 /*
Davide Libenzibb57c3e2009-03-31 15:24:12 -07002059 * Create the internal data structure ("struct eventpoll").
Davide Libenzi7699acd2007-05-10 22:23:23 -07002060 */
Ulrich Drepper9fe5ad92008-07-23 21:29:43 -07002061 error = ep_alloc(&ep);
Davide Libenzibb57c3e2009-03-31 15:24:12 -07002062 if (error < 0)
2063 return error;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002064 /*
2065 * Creates all the items needed to setup an eventpoll file. That is,
Al Viro2030a422008-02-23 06:46:49 -05002066 * a file structure and a free file descriptor.
Davide Libenzi7699acd2007-05-10 22:23:23 -07002067 */
Jason Baron28d82dc2012-01-12 17:17:43 -08002068 fd = get_unused_fd_flags(O_RDWR | (flags & O_CLOEXEC));
2069 if (fd < 0) {
2070 error = fd;
2071 goto out_free_ep;
2072 }
2073 file = anon_inode_getfile("[eventpoll]", &eventpoll_fops, ep,
Roland Dreier628ff7c2009-12-18 09:41:24 -08002074 O_RDWR | (flags & O_CLOEXEC));
Jason Baron28d82dc2012-01-12 17:17:43 -08002075 if (IS_ERR(file)) {
2076 error = PTR_ERR(file);
2077 goto out_free_fd;
2078 }
Jason Baron28d82dc2012-01-12 17:17:43 -08002079 ep->file = file;
Al Viro98022742012-08-17 22:42:36 -04002080 fd_install(fd, file);
Jason Baron28d82dc2012-01-12 17:17:43 -08002081 return fd;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002082
Jason Baron28d82dc2012-01-12 17:17:43 -08002083out_free_fd:
2084 put_unused_fd(fd);
2085out_free_ep:
2086 ep_free(ep);
Davide Libenzibb57c3e2009-03-31 15:24:12 -07002087 return error;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002088}
2089
Dominik Brodowski791eb222018-03-11 11:34:30 +01002090SYSCALL_DEFINE1(epoll_create1, int, flags)
2091{
2092 return do_epoll_create(flags);
2093}
2094
Heiko Carstens5a8a82b2009-01-14 14:14:25 +01002095SYSCALL_DEFINE1(epoll_create, int, size)
Ulrich Dreppera0998b52008-07-23 21:29:27 -07002096{
Davide Libenzibfe3891a2009-05-12 13:19:44 -07002097 if (size <= 0)
Ulrich Drepper9fe5ad92008-07-23 21:29:43 -07002098 return -EINVAL;
2099
Dominik Brodowski791eb222018-03-11 11:34:30 +01002100 return do_epoll_create(0);
Ulrich Dreppera0998b52008-07-23 21:29:27 -07002101}
2102
Davide Libenzi7699acd2007-05-10 22:23:23 -07002103/*
2104 * The following function implements the controller interface for
2105 * the eventpoll file that enables the insertion/removal/change of
Davide Libenzi67647d02007-05-15 01:40:52 -07002106 * file descriptors inside the interest set.
Davide Libenzi7699acd2007-05-10 22:23:23 -07002107 */
Heiko Carstens5a8a82b2009-01-14 14:14:25 +01002108SYSCALL_DEFINE4(epoll_ctl, int, epfd, int, op, int, fd,
2109 struct epoll_event __user *, event)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002110{
2111 int error;
Jason Baron67347fe2013-11-12 15:10:18 -08002112 int full_check = 0;
Al Viro7e3fb582013-08-30 12:47:21 -04002113 struct fd f, tf;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002114 struct eventpoll *ep;
2115 struct epitem *epi;
2116 struct epoll_event epds;
Jason Baron67347fe2013-11-12 15:10:18 -08002117 struct eventpoll *tep = NULL;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002118
Davide Libenzi7699acd2007-05-10 22:23:23 -07002119 error = -EFAULT;
2120 if (ep_op_has_event(op) &&
2121 copy_from_user(&epds, event, sizeof(struct epoll_event)))
2122 goto error_return;
2123
Davide Libenzi7699acd2007-05-10 22:23:23 -07002124 error = -EBADF;
Al Viro7e3fb582013-08-30 12:47:21 -04002125 f = fdget(epfd);
2126 if (!f.file)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002127 goto error_return;
2128
2129 /* Get the "struct file *" for the target file */
Al Viro7e3fb582013-08-30 12:47:21 -04002130 tf = fdget(fd);
2131 if (!tf.file)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002132 goto error_fput;
2133
2134 /* The target file descriptor must support poll */
2135 error = -EPERM;
Christoph Hellwig9965ed172018-03-05 07:26:05 -08002136 if (!file_can_poll(tf.file))
Davide Libenzi7699acd2007-05-10 22:23:23 -07002137 goto error_tgt_fput;
2138
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02002139 /* Check if EPOLLWAKEUP is allowed */
Nicolas Ioossc680e412014-09-09 14:50:51 -07002140 if (ep_op_has_event(op))
2141 ep_take_care_of_epollwakeup(&epds);
Arve Hjønnevåg4d7e30d2012-05-01 21:33:34 +02002142
Davide Libenzi7699acd2007-05-10 22:23:23 -07002143 /*
2144 * We have to check that the file structure underneath the file descriptor
2145 * the user passed to us _is_ an eventpoll file. And also we do not permit
2146 * adding an epoll file descriptor inside itself.
2147 */
2148 error = -EINVAL;
Al Viro7e3fb582013-08-30 12:47:21 -04002149 if (f.file == tf.file || !is_file_epoll(f.file))
Davide Libenzi7699acd2007-05-10 22:23:23 -07002150 goto error_tgt_fput;
2151
2152 /*
Jason Barondf0108c2016-01-20 14:59:24 -08002153 * epoll adds to the wakeup queue at EPOLL_CTL_ADD time only,
2154 * so EPOLLEXCLUSIVE is not allowed for a EPOLL_CTL_MOD operation.
2155 * Also, we do not currently supported nested exclusive wakeups.
2156 */
Cyrill Gorcunovc857ab62017-02-27 14:27:40 -08002157 if (ep_op_has_event(op) && (epds.events & EPOLLEXCLUSIVE)) {
Jason Baronb6a515c2016-02-05 15:37:04 -08002158 if (op == EPOLL_CTL_MOD)
2159 goto error_tgt_fput;
2160 if (op == EPOLL_CTL_ADD && (is_file_epoll(tf.file) ||
2161 (epds.events & ~EPOLLEXCLUSIVE_OK_BITS)))
2162 goto error_tgt_fput;
2163 }
Jason Barondf0108c2016-01-20 14:59:24 -08002164
2165 /*
Davide Libenzi7699acd2007-05-10 22:23:23 -07002166 * At this point it is safe to assume that the "private_data" contains
2167 * our own data structure.
2168 */
Al Viro7e3fb582013-08-30 12:47:21 -04002169 ep = f.file->private_data;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002170
Davide Libenzi22bacca2011-02-25 14:44:12 -08002171 /*
2172 * When we insert an epoll file descriptor, inside another epoll file
2173 * descriptor, there is the change of creating closed loops, which are
Jason Baron28d82dc2012-01-12 17:17:43 -08002174 * better be handled here, than in more critical paths. While we are
2175 * checking for loops we also determine the list of files reachable
2176 * and hang them on the tfile_check_list, so we can check that we
2177 * haven't created too many possible wakeup paths.
Davide Libenzi22bacca2011-02-25 14:44:12 -08002178 *
Jason Baron67347fe2013-11-12 15:10:18 -08002179 * We do not need to take the global 'epumutex' on EPOLL_CTL_ADD when
2180 * the epoll file descriptor is attaching directly to a wakeup source,
2181 * unless the epoll file descriptor is nested. The purpose of taking the
2182 * 'epmutex' on add is to prevent complex toplogies such as loops and
2183 * deep wakeup paths from forming in parallel through multiple
2184 * EPOLL_CTL_ADD operations.
Davide Libenzi22bacca2011-02-25 14:44:12 -08002185 */
Nelson Elhaged8805e62011-10-31 17:13:14 -07002186 mutex_lock_nested(&ep->mtx, 0);
Jason Baron67347fe2013-11-12 15:10:18 -08002187 if (op == EPOLL_CTL_ADD) {
2188 if (!list_empty(&f.file->f_ep_links) ||
2189 is_file_epoll(tf.file)) {
2190 full_check = 1;
2191 mutex_unlock(&ep->mtx);
2192 mutex_lock(&epmutex);
2193 if (is_file_epoll(tf.file)) {
2194 error = -ELOOP;
2195 if (ep_loop_check(ep, tf.file) != 0) {
2196 clear_tfile_check_list();
2197 goto error_tgt_fput;
2198 }
2199 } else
2200 list_add(&tf.file->f_tfile_llink,
2201 &tfile_check_list);
2202 mutex_lock_nested(&ep->mtx, 0);
2203 if (is_file_epoll(tf.file)) {
2204 tep = tf.file->private_data;
2205 mutex_lock_nested(&tep->mtx, 1);
2206 }
2207 }
2208 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07002209
Davide Libenzi67647d02007-05-15 01:40:52 -07002210 /*
2211 * Try to lookup the file inside our RB tree, Since we grabbed "mtx"
2212 * above, we can be sure to be able to use the item looked up by
2213 * ep_find() till we release the mutex.
2214 */
Al Viro7e3fb582013-08-30 12:47:21 -04002215 epi = ep_find(ep, tf.file, fd);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002216
2217 error = -EINVAL;
2218 switch (op) {
2219 case EPOLL_CTL_ADD:
2220 if (!epi) {
Linus Torvaldsa9a08842018-02-11 14:34:03 -08002221 epds.events |= EPOLLERR | EPOLLHUP;
Jason Baron67347fe2013-11-12 15:10:18 -08002222 error = ep_insert(ep, &epds, tf.file, fd, full_check);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002223 } else
2224 error = -EEXIST;
Jason Baron67347fe2013-11-12 15:10:18 -08002225 if (full_check)
2226 clear_tfile_check_list();
Davide Libenzi7699acd2007-05-10 22:23:23 -07002227 break;
2228 case EPOLL_CTL_DEL:
2229 if (epi)
2230 error = ep_remove(ep, epi);
2231 else
2232 error = -ENOENT;
2233 break;
2234 case EPOLL_CTL_MOD:
2235 if (epi) {
Jason Baronb6a515c2016-02-05 15:37:04 -08002236 if (!(epi->event.events & EPOLLEXCLUSIVE)) {
Linus Torvaldsa9a08842018-02-11 14:34:03 -08002237 epds.events |= EPOLLERR | EPOLLHUP;
Jason Baronb6a515c2016-02-05 15:37:04 -08002238 error = ep_modify(ep, epi, &epds);
2239 }
Davide Libenzi7699acd2007-05-10 22:23:23 -07002240 } else
2241 error = -ENOENT;
2242 break;
2243 }
Jason Baron67347fe2013-11-12 15:10:18 -08002244 if (tep != NULL)
2245 mutex_unlock(&tep->mtx);
Davide Libenzid47de162007-05-15 01:40:41 -07002246 mutex_unlock(&ep->mtx);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002247
2248error_tgt_fput:
Jason Baron67347fe2013-11-12 15:10:18 -08002249 if (full_check)
Davide Libenzi22bacca2011-02-25 14:44:12 -08002250 mutex_unlock(&epmutex);
2251
Al Viro7e3fb582013-08-30 12:47:21 -04002252 fdput(tf);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002253error_fput:
Al Viro7e3fb582013-08-30 12:47:21 -04002254 fdput(f);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002255error_return:
Davide Libenzi7699acd2007-05-10 22:23:23 -07002256
2257 return error;
2258}
2259
2260/*
2261 * Implement the event wait interface for the eventpoll file. It is the kernel
2262 * part of the user space epoll_wait(2).
2263 */
Dominik Brodowski791eb222018-03-11 11:34:30 +01002264static int do_epoll_wait(int epfd, struct epoll_event __user *events,
2265 int maxevents, int timeout)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002266{
Al Viro2903ff02012-08-28 12:52:22 -04002267 int error;
2268 struct fd f;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002269 struct eventpoll *ep;
2270
Davide Libenzi7699acd2007-05-10 22:23:23 -07002271 /* The maximum number of event must be greater than zero */
2272 if (maxevents <= 0 || maxevents > EP_MAX_EVENTS)
2273 return -EINVAL;
2274
2275 /* Verify that the area passed by the user is writeable */
Linus Torvalds96d4f262019-01-03 18:57:57 -08002276 if (!access_ok(events, maxevents * sizeof(struct epoll_event)))
Al Viro2903ff02012-08-28 12:52:22 -04002277 return -EFAULT;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002278
2279 /* Get the "struct file *" for the eventpoll file */
Al Viro2903ff02012-08-28 12:52:22 -04002280 f = fdget(epfd);
2281 if (!f.file)
2282 return -EBADF;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002283
2284 /*
2285 * We have to check that the file structure underneath the fd
2286 * the user passed to us _is_ an eventpoll file.
2287 */
2288 error = -EINVAL;
Al Viro2903ff02012-08-28 12:52:22 -04002289 if (!is_file_epoll(f.file))
Davide Libenzi7699acd2007-05-10 22:23:23 -07002290 goto error_fput;
2291
2292 /*
2293 * At this point it is safe to assume that the "private_data" contains
2294 * our own data structure.
2295 */
Al Viro2903ff02012-08-28 12:52:22 -04002296 ep = f.file->private_data;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002297
2298 /* Time to fish for events ... */
2299 error = ep_poll(ep, events, maxevents, timeout);
2300
2301error_fput:
Al Viro2903ff02012-08-28 12:52:22 -04002302 fdput(f);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002303 return error;
2304}
2305
Dominik Brodowski791eb222018-03-11 11:34:30 +01002306SYSCALL_DEFINE4(epoll_wait, int, epfd, struct epoll_event __user *, events,
2307 int, maxevents, int, timeout)
2308{
2309 return do_epoll_wait(epfd, events, maxevents, timeout);
2310}
2311
Davide Libenzi7699acd2007-05-10 22:23:23 -07002312/*
2313 * Implement the event wait interface for the eventpoll file. It is the kernel
2314 * part of the user space epoll_pwait(2).
2315 */
Heiko Carstens5a8a82b2009-01-14 14:14:25 +01002316SYSCALL_DEFINE6(epoll_pwait, int, epfd, struct epoll_event __user *, events,
2317 int, maxevents, int, timeout, const sigset_t __user *, sigmask,
2318 size_t, sigsetsize)
Davide Libenzi7699acd2007-05-10 22:23:23 -07002319{
2320 int error;
2321 sigset_t ksigmask, sigsaved;
2322
2323 /*
2324 * If the caller wants a certain signal mask to be set during the wait,
2325 * we apply it here.
2326 */
Deepa Dinamanided653c2018-09-19 21:41:04 -07002327 error = set_user_sigmask(sigmask, &ksigmask, &sigsaved, sigsetsize);
2328 if (error)
2329 return error;
Davide Libenzi7699acd2007-05-10 22:23:23 -07002330
Dominik Brodowski791eb222018-03-11 11:34:30 +01002331 error = do_epoll_wait(epfd, events, maxevents, timeout);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002332
Deepa Dinamani854a6ed2018-09-19 21:41:05 -07002333 restore_user_sigmask(sigmask, &sigsaved);
Davide Libenzi7699acd2007-05-10 22:23:23 -07002334
2335 return error;
2336}
2337
Al Viro35280bd2013-02-24 14:52:17 -05002338#ifdef CONFIG_COMPAT
2339COMPAT_SYSCALL_DEFINE6(epoll_pwait, int, epfd,
2340 struct epoll_event __user *, events,
2341 int, maxevents, int, timeout,
2342 const compat_sigset_t __user *, sigmask,
2343 compat_size_t, sigsetsize)
2344{
2345 long err;
Al Viro35280bd2013-02-24 14:52:17 -05002346 sigset_t ksigmask, sigsaved;
2347
2348 /*
2349 * If the caller wants a certain signal mask to be set during the wait,
2350 * we apply it here.
2351 */
Deepa Dinamanided653c2018-09-19 21:41:04 -07002352 err = set_compat_user_sigmask(sigmask, &ksigmask, &sigsaved, sigsetsize);
2353 if (err)
2354 return err;
Al Viro35280bd2013-02-24 14:52:17 -05002355
Dominik Brodowski791eb222018-03-11 11:34:30 +01002356 err = do_epoll_wait(epfd, events, maxevents, timeout);
Al Viro35280bd2013-02-24 14:52:17 -05002357
Deepa Dinamani854a6ed2018-09-19 21:41:05 -07002358 restore_user_sigmask(sigmask, &sigsaved);
Al Viro35280bd2013-02-24 14:52:17 -05002359
2360 return err;
2361}
2362#endif
2363
Linus Torvalds1da177e2005-04-16 15:20:36 -07002364static int __init eventpoll_init(void)
2365{
Davide Libenzi7ef99642008-12-01 13:13:55 -08002366 struct sysinfo si;
2367
2368 si_meminfo(&si);
Davide Libenzi9df04e12009-01-29 14:25:26 -08002369 /*
2370 * Allows top 4% of lomem to be allocated for epoll watches (per user).
2371 */
2372 max_user_watches = (((si.totalram - si.totalhigh) / 25) << PAGE_SHIFT) /
Davide Libenzi7ef99642008-12-01 13:13:55 -08002373 EP_ITEM_COST;
Robin Holt52bd19f72011-01-12 17:00:01 -08002374 BUG_ON(max_user_watches < 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002375
Davide Libenzi22bacca2011-02-25 14:44:12 -08002376 /*
2377 * Initialize the structure used to perform epoll file descriptor
2378 * inclusion loops checks.
2379 */
2380 ep_nested_calls_init(&poll_loop_ncalls);
2381
Jason Baron57a173b2017-11-17 15:29:02 -08002382#ifdef CONFIG_DEBUG_LOCK_ALLOC
Linus Torvalds1da177e2005-04-16 15:20:36 -07002383 /* Initialize the structure used to perform safe poll wait head wake ups */
Davide Libenzi5071f972009-03-31 15:24:10 -07002384 ep_nested_calls_init(&poll_safewake_ncalls);
Jason Baron57a173b2017-11-17 15:29:02 -08002385#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002386
Eric Wong39732ca2013-04-30 15:27:38 -07002387 /*
2388 * We can have many thousands of epitems, so prevent this from
2389 * using an extra cache line on 64-bit (and smaller) CPUs
2390 */
2391 BUILD_BUG_ON(sizeof(void *) <= 8 && sizeof(struct epitem) > 128);
2392
Linus Torvalds1da177e2005-04-16 15:20:36 -07002393 /* Allocates slab cache used to allocate "struct epitem" items */
2394 epi_cache = kmem_cache_create("eventpoll_epi", sizeof(struct epitem),
Shakeel Butt2ae928a2017-11-17 15:28:59 -08002395 0, SLAB_HWCACHE_ALIGN|SLAB_PANIC|SLAB_ACCOUNT, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002396
2397 /* Allocates slab cache used to allocate "struct eppoll_entry" */
2398 pwq_cache = kmem_cache_create("eventpoll_pwq",
Shakeel Butt2ae928a2017-11-17 15:28:59 -08002399 sizeof(struct eppoll_entry), 0, SLAB_PANIC|SLAB_ACCOUNT, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002400
Linus Torvalds1da177e2005-04-16 15:20:36 -07002401 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002402}
Davide Libenzicea69242007-05-10 22:23:22 -07002403fs_initcall(eventpoll_init);