eventpoll.c 65.6 KB
Newer Older
1
// SPDX-License-Identifier: GPL-2.0-or-later
L
Linus Torvalds 已提交
2
/*
D
Davide Libenzi 已提交
3 4
 *  fs/eventpoll.c (Efficient event retrieval implementation)
 *  Copyright (C) 2001,...,2009	 Davide Libenzi
L
Linus Torvalds 已提交
5 6 7 8 9 10
 *
 *  Davide Libenzi <davidel@xmailserver.org>
 */

#include <linux/init.h>
#include <linux/kernel.h>
11
#include <linux/sched/signal.h>
L
Linus Torvalds 已提交
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
#include <linux/fs.h>
#include <linux/file.h>
#include <linux/signal.h>
#include <linux/errno.h>
#include <linux/mm.h>
#include <linux/slab.h>
#include <linux/poll.h>
#include <linux/string.h>
#include <linux/list.h>
#include <linux/hash.h>
#include <linux/spinlock.h>
#include <linux/syscalls.h>
#include <linux/rbtree.h>
#include <linux/wait.h>
#include <linux/eventpoll.h>
#include <linux/mount.h>
#include <linux/bitops.h>
A
Arjan van de Ven 已提交
29
#include <linux/mutex.h>
D
Davide Libenzi 已提交
30
#include <linux/anon_inodes.h>
31
#include <linux/device.h>
32
#include <linux/uaccess.h>
L
Linus Torvalds 已提交
33 34
#include <asm/io.h>
#include <asm/mman.h>
A
Arun Sharma 已提交
35
#include <linux/atomic.h>
36 37
#include <linux/proc_fs.h>
#include <linux/seq_file.h>
38
#include <linux/compat.h>
39
#include <linux/rculist.h>
40
#include <net/busy_poll.h>
L
Linus Torvalds 已提交
41 42 43 44 45

/*
 * LOCKING:
 * There are three level of locking required by epoll :
 *
A
Arjan van de Ven 已提交
46
 * 1) epmutex (mutex)
47
 * 2) ep->mtx (mutex)
48
 * 3) ep->lock (rwlock)
L
Linus Torvalds 已提交
49 50
 *
 * The acquire order is the one listed above, from 1 to 3.
51
 * We need a rwlock (ep->lock) because we manipulate objects
L
Linus Torvalds 已提交
52 53 54 55 56 57
 * from inside the poll callback, that might be triggered from
 * a wake_up() that in turn might be called from IRQ context.
 * So we can't sleep inside the poll callback and hence we need
 * a spinlock. During the event transfer loop (from kernel to
 * user space) we could end up sleeping due a copy_to_user(), so
 * we need a lock that will allow us to sleep. This lock is a
58 59 60 61 62
 * mutex (ep->mtx). It is acquired during the event transfer loop,
 * during epoll_ctl(EPOLL_CTL_DEL) and during eventpoll_release_file().
 * Then we also need a global mutex to serialize eventpoll_release_file()
 * and ep_free().
 * This mutex is acquired by ep_free() during the epoll file
L
Linus Torvalds 已提交
63 64
 * cleanup path and it is also acquired by eventpoll_release_file()
 * if a file has been pushed inside an epoll set and it is then
D
Daniel Baluta 已提交
65
 * close()d without a previous call to epoll_ctl(EPOLL_CTL_DEL).
66 67 68 69 70 71 72
 * It is also acquired when inserting an epoll fd onto another epoll
 * fd. We do this so that we walk the epoll tree and ensure that this
 * insertion does not create a cycle of epoll file descriptors, which
 * could lead to deadlock. We need a global mutex to prevent two
 * simultaneous inserts (A into B and B into A) from racing and
 * constructing a cycle without either insert observing that it is
 * going to.
73 74 75 76 77 78 79 80 81
 * It is necessary to acquire multiple "ep->mtx"es at once in the
 * case when one epoll fd is added to another. In this case, we
 * always acquire the locks in the order of nesting (i.e. after
 * epoll_ctl(e1, EPOLL_CTL_ADD, e2), e1->mtx will always be acquired
 * before e2->mtx). Since we disallow cycles of epoll file
 * descriptors, this ensures that the mutexes are well-ordered. In
 * order to communicate this nesting to lockdep, when walking a tree
 * of epoll file descriptors, we use the current recursion depth as
 * the lockdep subkey.
82
 * It is possible to drop the "ep->mtx" and to use the global
83
 * mutex "epmutex" (together with "ep->lock") to have it working,
84
 * but having "ep->mtx" will make the interface more scalable.
A
Arjan van de Ven 已提交
85
 * Events that require holding "epmutex" are very rare, while for
86 87
 * normal operations the epoll private "ep->mtx" will guarantee
 * a better scalability.
L
Linus Torvalds 已提交
88 89 90
 */

/* Epoll private bits inside the event mask */
J
Jason Baron 已提交
91
#define EP_PRIVATE_BITS (EPOLLWAKEUP | EPOLLONESHOT | EPOLLET | EPOLLEXCLUSIVE)
L
Linus Torvalds 已提交
92

93
#define EPOLLINOUT_BITS (EPOLLIN | EPOLLOUT)
94

95
#define EPOLLEXCLUSIVE_OK_BITS (EPOLLINOUT_BITS | EPOLLERR | EPOLLHUP | \
96 97
				EPOLLWAKEUP | EPOLLET | EPOLLEXCLUSIVE)

D
Davide Libenzi 已提交
98 99
/* Maximum number of nesting allowed inside epoll sets */
#define EP_MAX_NESTS 4
L
Linus Torvalds 已提交
100

D
Davide Libenzi 已提交
101 102
#define EP_MAX_EVENTS (INT_MAX / sizeof(struct epoll_event))

103 104
#define EP_UNACTIVE_PTR ((void *) -1L)

105 106
#define EP_ITEM_COST (sizeof(struct epitem) + sizeof(struct eppoll_entry))

L
Linus Torvalds 已提交
107 108 109
struct epoll_filefd {
	struct file *file;
	int fd;
E
Eric Wong 已提交
110
} __packed;
L
Linus Torvalds 已提交
111 112

/*
D
Davide Libenzi 已提交
113 114
 * Structure used to track possible nested calls, for too deep recursions
 * and loop cycles.
L
Linus Torvalds 已提交
115
 */
D
Davide Libenzi 已提交
116
struct nested_call_node {
L
Linus Torvalds 已提交
117
	struct list_head llink;
D
Davide Libenzi 已提交
118
	void *cookie;
D
Davide Libenzi 已提交
119
	void *ctx;
L
Linus Torvalds 已提交
120 121 122
};

/*
D
Davide Libenzi 已提交
123 124
 * This structure is used as collector for nested calls, to check for
 * maximum recursion dept and loop cycles.
L
Linus Torvalds 已提交
125
 */
D
Davide Libenzi 已提交
126 127
struct nested_calls {
	struct list_head tasks_call_list;
L
Linus Torvalds 已提交
128 129 130
	spinlock_t lock;
};

131 132 133
/*
 * Each file descriptor added to the eventpoll interface will
 * have an entry of this type linked to the "rbr" RB tree.
E
Eric Wong 已提交
134 135
 * Avoid increasing the size of this struct, there can be many thousands
 * of these on a server and we do not want this to take another cache line.
136 137
 */
struct epitem {
138 139 140 141 142 143
	union {
		/* RB tree node links this structure to the eventpoll RB tree */
		struct rb_node rbn;
		/* Used to free the struct epitem */
		struct rcu_head rcu;
	};
144 145 146 147

	/* List header used to link this structure to the eventpoll ready list */
	struct list_head rdllink;

148 149 150 151 152 153
	/*
	 * Works together "struct eventpoll"->ovflist in keeping the
	 * single linked chain of items.
	 */
	struct epitem *next;

154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
	/* The file descriptor information this item refers to */
	struct epoll_filefd ffd;

	/* Number of active wait queue attached to poll operations */
	int nwait;

	/* List containing poll wait queues */
	struct list_head pwqlist;

	/* The "container" of this item */
	struct eventpoll *ep;

	/* List header used to link this item to the "struct file" items list */
	struct list_head fllink;

169
	/* wakeup_source used when EPOLLWAKEUP is set */
170
	struct wakeup_source __rcu *ws;
171

172 173
	/* The structure that describe the interested events and the source fd */
	struct epoll_event event;
174 175
};

L
Linus Torvalds 已提交
176 177
/*
 * This structure is stored inside the "private_data" member of the file
D
Daniel Baluta 已提交
178
 * structure and represents the main data structure for the eventpoll
L
Linus Torvalds 已提交
179 180 181 182
 * interface.
 */
struct eventpoll {
	/*
183 184 185 186
	 * This mutex is used to ensure that files are not removed
	 * while epoll is using them. This is held during the event
	 * collection loop, the file cleanup path, the epoll file exit
	 * code and the ctl operations.
L
Linus Torvalds 已提交
187
	 */
188
	struct mutex mtx;
L
Linus Torvalds 已提交
189 190 191 192 193 194 195 196 197 198

	/* Wait queue used by sys_epoll_wait() */
	wait_queue_head_t wq;

	/* Wait queue used by file->poll() */
	wait_queue_head_t poll_wait;

	/* List of ready file descriptors */
	struct list_head rdllist;

199 200 201
	/* Lock which protects rdllist and ovflist */
	rwlock_t lock;

D
Davide Libenzi 已提交
202
	/* RB tree root used to store monitored fd structs */
203
	struct rb_root_cached rbr;
204 205 206

	/*
	 * This is a single linked list that chains all the "struct epitem" that
L
Lucas De Marchi 已提交
207
	 * happened while transferring ready events to userspace w/out
208
	 * holding ->lock.
209 210
	 */
	struct epitem *ovflist;
211

212 213 214
	/* wakeup_source used when ep_scan_ready_list is running */
	struct wakeup_source *ws;

215 216
	/* The user that created the eventpoll descriptor */
	struct user_struct *user;
J
Jason Baron 已提交
217 218 219 220

	struct file *file;

	/* used to optimize loop detection check */
221
	u64 gen;
222 223 224 225 226

#ifdef CONFIG_NET_RX_BUSY_POLL
	/* used to track busy poll napi_id */
	unsigned int napi_id;
#endif
227 228 229 230 231

#ifdef CONFIG_DEBUG_LOCK_ALLOC
	/* tracks wakeup nests for lockdep validation */
	u8 nests;
#endif
L
Linus Torvalds 已提交
232 233 234 235 236 237 238 239
};

/* Wait structure used by the poll hooks */
struct eppoll_entry {
	/* List header used to link this structure to the "struct epitem" */
	struct list_head llink;

	/* The "base" pointer is set to the container "struct epitem" */
240
	struct epitem *base;
L
Linus Torvalds 已提交
241 242 243 244 245

	/*
	 * Wait queue item that will be linked to the target file wait
	 * queue head.
	 */
246
	wait_queue_entry_t wait;
L
Linus Torvalds 已提交
247 248 249 250 251 252 253 254 255 256 257

	/* The wait queue head that linked the "wait" wait queue item */
	wait_queue_head_t *whead;
};

/* Wrapper struct used by poll queueing */
struct ep_pqueue {
	poll_table pt;
	struct epitem *epi;
};

D
Davide Libenzi 已提交
258 259 260 261
/* Used by the ep_send_events() function as callback private data */
struct ep_send_events_data {
	int maxevents;
	struct epoll_event __user *events;
262
	int res;
D
Davide Libenzi 已提交
263 264
};

265 266 267 268
/*
 * Configuration options available inside /proc/sys/fs/epoll/
 */
/* Maximum number of epoll watched descriptors, per user */
269
static long max_user_watches __read_mostly;
270

L
Linus Torvalds 已提交
271
/*
272
 * This mutex is used to serialize ep_free() and eventpoll_release_file().
L
Linus Torvalds 已提交
273
 */
274
static DEFINE_MUTEX(epmutex);
L
Linus Torvalds 已提交
275

276 277
static u64 loop_check_gen = 0;

278 279 280
/* Used to check for epoll file descriptor inclusion loops */
static struct nested_calls poll_loop_ncalls;

L
Linus Torvalds 已提交
281
/* Slab cache used to allocate "struct epitem" */
282
static struct kmem_cache *epi_cache __read_mostly;
L
Linus Torvalds 已提交
283 284

/* Slab cache used to allocate "struct eppoll_entry" */
285
static struct kmem_cache *pwq_cache __read_mostly;
L
Linus Torvalds 已提交
286

J
Jason Baron 已提交
287 288 289 290 291 292
/*
 * List of files with newly added links, where we may need to limit the number
 * of emanating paths. Protected by the epmutex.
 */
static LIST_HEAD(tfile_check_list);

293 294 295 296
#ifdef CONFIG_SYSCTL

#include <linux/sysctl.h>

297
static long long_zero;
298
static long long_max = LONG_MAX;
299

300
struct ctl_table epoll_table[] = {
301 302 303
	{
		.procname	= "max_user_watches",
		.data		= &max_user_watches,
304
		.maxlen		= sizeof(max_user_watches),
305
		.mode		= 0644,
306
		.proc_handler	= proc_doulongvec_minmax,
307
		.extra1		= &long_zero,
308
		.extra2		= &long_max,
309
	},
310
	{ }
311 312 313
};
#endif /* CONFIG_SYSCTL */

J
Jason Baron 已提交
314 315 316 317 318 319
static const struct file_operations eventpoll_fops;

static inline int is_file_epoll(struct file *f)
{
	return f->f_op == &eventpoll_fops;
}
320

D
Davide Libenzi 已提交
321
/* Setup the structure that is used as key for the RB tree */
322 323 324 325 326 327 328
static inline void ep_set_ffd(struct epoll_filefd *ffd,
			      struct file *file, int fd)
{
	ffd->file = file;
	ffd->fd = fd;
}

D
Davide Libenzi 已提交
329
/* Compare RB tree keys */
330 331 332 333 334 335 336 337
static inline int ep_cmp_ffd(struct epoll_filefd *p1,
			     struct epoll_filefd *p2)
{
	return (p1->file > p2->file ? +1:
	        (p1->file < p2->file ? -1 : p1->fd - p2->fd));
}

/* Tells us if the item is currently linked */
338
static inline int ep_is_linked(struct epitem *epi)
339
{
340
	return !list_empty(&epi->rdllink);
341 342
}

343
static inline struct eppoll_entry *ep_pwq_from_wait(wait_queue_entry_t *p)
344 345 346 347
{
	return container_of(p, struct eppoll_entry, wait);
}

348
/* Get the "struct epitem" from a wait queue pointer */
349
static inline struct epitem *ep_item_from_wait(wait_queue_entry_t *p)
350 351 352 353 354
{
	return container_of(p, struct eppoll_entry, wait)->base;
}

/* Get the "struct epitem" from an epoll queue wrapper */
D
Davide Libenzi 已提交
355
static inline struct epitem *ep_item_from_epqueue(poll_table *p)
356 357 358 359
{
	return container_of(p, struct ep_pqueue, pt)->epi;
}

L
Linus Torvalds 已提交
360
/* Initialize the poll safe wake up structure */
D
Davide Libenzi 已提交
361
static void ep_nested_calls_init(struct nested_calls *ncalls)
L
Linus Torvalds 已提交
362
{
D
Davide Libenzi 已提交
363 364
	INIT_LIST_HEAD(&ncalls->tasks_call_list);
	spin_lock_init(&ncalls->lock);
L
Linus Torvalds 已提交
365 366
}

367 368 369 370 371 372 373 374 375 376
/**
 * ep_events_available - Checks if ready events might be available.
 *
 * @ep: Pointer to the eventpoll context.
 *
 * Returns: Returns a value different than zero if ready events are available,
 *          or zero otherwise.
 */
static inline int ep_events_available(struct eventpoll *ep)
{
377 378
	return !list_empty_careful(&ep->rdllist) ||
		READ_ONCE(ep->ovflist) != EP_UNACTIVE_PTR;
379 380
}

381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444
#ifdef CONFIG_NET_RX_BUSY_POLL
static bool ep_busy_loop_end(void *p, unsigned long start_time)
{
	struct eventpoll *ep = p;

	return ep_events_available(ep) || busy_loop_timeout(start_time);
}

/*
 * Busy poll if globally on and supporting sockets found && no events,
 * busy loop will return if need_resched or ep_events_available.
 *
 * we must do our busy polling with irqs enabled
 */
static void ep_busy_loop(struct eventpoll *ep, int nonblock)
{
	unsigned int napi_id = READ_ONCE(ep->napi_id);

	if ((napi_id >= MIN_NAPI_ID) && net_busy_loop_on())
		napi_busy_loop(napi_id, nonblock ? NULL : ep_busy_loop_end, ep);
}

static inline void ep_reset_busy_poll_napi_id(struct eventpoll *ep)
{
	if (ep->napi_id)
		ep->napi_id = 0;
}

/*
 * Set epoll busy poll NAPI ID from sk.
 */
static inline void ep_set_busy_poll_napi_id(struct epitem *epi)
{
	struct eventpoll *ep;
	unsigned int napi_id;
	struct socket *sock;
	struct sock *sk;
	int err;

	if (!net_busy_loop_on())
		return;

	sock = sock_from_file(epi->ffd.file, &err);
	if (!sock)
		return;

	sk = sock->sk;
	if (!sk)
		return;

	napi_id = READ_ONCE(sk->sk_napi_id);
	ep = epi->ep;

	/* Non-NAPI IDs can be rejected
	 *	or
	 * Nothing to do if we already have this ID
	 */
	if (napi_id < MIN_NAPI_ID || napi_id == ep->napi_id)
		return;

	/* record NAPI ID for use in next busy poll */
	ep->napi_id = napi_id;
}

445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460
#else

static inline void ep_busy_loop(struct eventpoll *ep, int nonblock)
{
}

static inline void ep_reset_busy_poll_napi_id(struct eventpoll *ep)
{
}

static inline void ep_set_busy_poll_napi_id(struct epitem *epi)
{
}

#endif /* CONFIG_NET_RX_BUSY_POLL */

D
Davide Libenzi 已提交
461 462 463 464 465 466 467 468 469 470
/**
 * ep_call_nested - Perform a bound (possibly) nested call, by checking
 *                  that the recursion limit is not exceeded, and that
 *                  the same nested call (by the meaning of same cookie) is
 *                  no re-entered.
 *
 * @ncalls: Pointer to the nested_calls structure to be used for this call.
 * @nproc: Nested call core function pointer.
 * @priv: Opaque data to be passed to the @nproc callback.
 * @cookie: Cookie to be used to identify this nested call.
D
Davide Libenzi 已提交
471
 * @ctx: This instance context.
D
Davide Libenzi 已提交
472 473 474
 *
 * Returns: Returns the code returned by the @nproc callback, or -1 if
 *          the maximum recursion limit has been exceeded.
L
Linus Torvalds 已提交
475
 */
476
static int ep_call_nested(struct nested_calls *ncalls,
D
Davide Libenzi 已提交
477
			  int (*nproc)(void *, void *, int), void *priv,
D
Davide Libenzi 已提交
478
			  void *cookie, void *ctx)
L
Linus Torvalds 已提交
479
{
D
Davide Libenzi 已提交
480
	int error, call_nests = 0;
L
Linus Torvalds 已提交
481
	unsigned long flags;
D
Davide Libenzi 已提交
482 483 484
	struct list_head *lsthead = &ncalls->tasks_call_list;
	struct nested_call_node *tncur;
	struct nested_call_node tnode;
L
Linus Torvalds 已提交
485

D
Davide Libenzi 已提交
486
	spin_lock_irqsave(&ncalls->lock, flags);
L
Linus Torvalds 已提交
487

D
Davide Libenzi 已提交
488 489 490 491 492
	/*
	 * Try to see if the current task is already inside this wakeup call.
	 * We use a list here, since the population inside this set is always
	 * very much limited.
	 */
493
	list_for_each_entry(tncur, lsthead, llink) {
D
Davide Libenzi 已提交
494
		if (tncur->ctx == ctx &&
495
		    (tncur->cookie == cookie || ++call_nests > EP_MAX_NESTS)) {
L
Linus Torvalds 已提交
496 497 498 499
			/*
			 * Ops ... loop detected or maximum nest level reached.
			 * We abort this wake by breaking the cycle itself.
			 */
500 501
			error = -1;
			goto out_unlock;
L
Linus Torvalds 已提交
502 503 504
		}
	}

D
Davide Libenzi 已提交
505
	/* Add the current task and cookie to the list */
D
Davide Libenzi 已提交
506
	tnode.ctx = ctx;
D
Davide Libenzi 已提交
507
	tnode.cookie = cookie;
L
Linus Torvalds 已提交
508 509
	list_add(&tnode.llink, lsthead);

D
Davide Libenzi 已提交
510
	spin_unlock_irqrestore(&ncalls->lock, flags);
L
Linus Torvalds 已提交
511

D
Davide Libenzi 已提交
512 513
	/* Call the nested function */
	error = (*nproc)(priv, cookie, call_nests);
L
Linus Torvalds 已提交
514 515

	/* Remove the current task from the list */
D
Davide Libenzi 已提交
516
	spin_lock_irqsave(&ncalls->lock, flags);
L
Linus Torvalds 已提交
517
	list_del(&tnode.llink);
D
Davide Libenzi 已提交
518
out_unlock:
D
Davide Libenzi 已提交
519 520 521 522 523
	spin_unlock_irqrestore(&ncalls->lock, flags);

	return error;
}

S
Steven Rostedt 已提交
524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548
/*
 * As described in commit 0ccf831cb lockdep: annotate epoll
 * the use of wait queues used by epoll is done in a very controlled
 * manner. Wake ups can nest inside each other, but are never done
 * with the same locking. For example:
 *
 *   dfd = socket(...);
 *   efd1 = epoll_create();
 *   efd2 = epoll_create();
 *   epoll_ctl(efd1, EPOLL_CTL_ADD, dfd, ...);
 *   epoll_ctl(efd2, EPOLL_CTL_ADD, efd1, ...);
 *
 * When a packet arrives to the device underneath "dfd", the net code will
 * issue a wake_up() on its poll wake list. Epoll (efd1) has installed a
 * callback wakeup entry on that queue, and the wake_up() performed by the
 * "dfd" net code will end up in ep_poll_callback(). At this point epoll
 * (efd1) notices that it may have some event ready, so it needs to wake up
 * the waiters on its poll wait list (efd2). So it calls ep_poll_safewake()
 * that ends up in another wake_up(), after having checked about the
 * recursion constraints. That are, no more than EP_MAX_POLLWAKE_NESTS, to
 * avoid stack blasting.
 *
 * When CONFIG_DEBUG_LOCK_ALLOC is enabled, make sure lockdep can handle
 * this special case of epoll.
 */
549
#ifdef CONFIG_DEBUG_LOCK_ALLOC
550

551
static void ep_poll_safewake(struct eventpoll *ep, struct epitem *epi)
D
Davide Libenzi 已提交
552
{
553
	struct eventpoll *ep_src;
554
	unsigned long flags;
555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584
	u8 nests = 0;

	/*
	 * To set the subclass or nesting level for spin_lock_irqsave_nested()
	 * it might be natural to create a per-cpu nest count. However, since
	 * we can recurse on ep->poll_wait.lock, and a non-raw spinlock can
	 * schedule() in the -rt kernel, the per-cpu variable are no longer
	 * protected. Thus, we are introducing a per eventpoll nest field.
	 * If we are not being call from ep_poll_callback(), epi is NULL and
	 * we are at the first level of nesting, 0. Otherwise, we are being
	 * called from ep_poll_callback() and if a previous wakeup source is
	 * not an epoll file itself, we are at depth 1 since the wakeup source
	 * is depth 0. If the wakeup source is a previous epoll file in the
	 * wakeup chain then we use its nests value and record ours as
	 * nests + 1. The previous epoll file nests value is stable since its
	 * already holding its own poll_wait.lock.
	 */
	if (epi) {
		if ((is_file_epoll(epi->ffd.file))) {
			ep_src = epi->ffd.file->private_data;
			nests = ep_src->nests;
		} else {
			nests = 1;
		}
	}
	spin_lock_irqsave_nested(&ep->poll_wait.lock, flags, nests);
	ep->nests = nests + 1;
	wake_up_locked_poll(&ep->poll_wait, EPOLLIN);
	ep->nests = 0;
	spin_unlock_irqrestore(&ep->poll_wait.lock, flags);
L
Linus Torvalds 已提交
585 586
}

587 588
#else

589
static void ep_poll_safewake(struct eventpoll *ep, struct epitem *epi)
590
{
591
	wake_up_poll(&ep->poll_wait, EPOLLIN);
592 593 594 595
}

#endif

596 597 598 599 600
static void ep_remove_wait_queue(struct eppoll_entry *pwq)
{
	wait_queue_head_t *whead;

	rcu_read_lock();
601 602 603 604 605 606 607
	/*
	 * If it is cleared by POLLFREE, it should be rcu-safe.
	 * If we read NULL we need a barrier paired with
	 * smp_store_release() in ep_poll_callback(), otherwise
	 * we rely on whead->lock.
	 */
	whead = smp_load_acquire(&pwq->whead);
608 609 610 611 612
	if (whead)
		remove_wait_queue(whead, &pwq->wait);
	rcu_read_unlock();
}

L
Linus Torvalds 已提交
613
/*
T
Tony Battersby 已提交
614 615 616
 * This function unregisters poll callbacks from the associated file
 * descriptor.  Must be called with "mtx" held (or "epmutex" if called from
 * ep_free).
L
Linus Torvalds 已提交
617
 */
618
static void ep_unregister_pollwait(struct eventpoll *ep, struct epitem *epi)
L
Linus Torvalds 已提交
619
{
620 621
	struct list_head *lsthead = &epi->pwqlist;
	struct eppoll_entry *pwq;
L
Linus Torvalds 已提交
622

T
Tony Battersby 已提交
623 624
	while (!list_empty(lsthead)) {
		pwq = list_first_entry(lsthead, struct eppoll_entry, llink);
L
Linus Torvalds 已提交
625

T
Tony Battersby 已提交
626
		list_del(&pwq->llink);
627
		ep_remove_wait_queue(pwq);
T
Tony Battersby 已提交
628
		kmem_cache_free(pwq_cache, pwq);
L
Linus Torvalds 已提交
629 630 631
	}
}

632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663
/* call only when ep->mtx is held */
static inline struct wakeup_source *ep_wakeup_source(struct epitem *epi)
{
	return rcu_dereference_check(epi->ws, lockdep_is_held(&epi->ep->mtx));
}

/* call only when ep->mtx is held */
static inline void ep_pm_stay_awake(struct epitem *epi)
{
	struct wakeup_source *ws = ep_wakeup_source(epi);

	if (ws)
		__pm_stay_awake(ws);
}

static inline bool ep_has_wakeup_source(struct epitem *epi)
{
	return rcu_access_pointer(epi->ws) ? true : false;
}

/* call when ep->mtx cannot be held (ep_poll_callback) */
static inline void ep_pm_stay_awake_rcu(struct epitem *epi)
{
	struct wakeup_source *ws;

	rcu_read_lock();
	ws = rcu_dereference(epi->ws);
	if (ws)
		__pm_stay_awake(ws);
	rcu_read_unlock();
}

D
Davide Libenzi 已提交
664 665 666 667 668 669 670 671
/**
 * ep_scan_ready_list - Scans the ready list in a way that makes possible for
 *                      the scan code, to call f_op->poll(). Also allows for
 *                      O(NumReady) performance.
 *
 * @ep: Pointer to the epoll private data structure.
 * @sproc: Pointer to the scan callback.
 * @priv: Private opaque data passed to the @sproc callback.
672
 * @depth: The current depth of recursive f_op->poll calls.
673
 * @ep_locked: caller already holds ep->mtx
D
Davide Libenzi 已提交
674 675 676
 *
 * Returns: The same integer error code returned by the @sproc callback.
 */
A
Al Viro 已提交
677 678
static __poll_t ep_scan_ready_list(struct eventpoll *ep,
			      __poll_t (*sproc)(struct eventpoll *,
D
Davide Libenzi 已提交
679
					   struct list_head *, void *),
680
			      void *priv, int depth, bool ep_locked)
D
Davide Libenzi 已提交
681
{
A
Al Viro 已提交
682
	__poll_t res;
D
Davide Libenzi 已提交
683
	struct epitem *epi, *nepi;
684
	LIST_HEAD(txlist);
D
Davide Libenzi 已提交
685

686 687
	lockdep_assert_irqs_enabled();

D
Davide Libenzi 已提交
688 689
	/*
	 * We need to lock this because we could be hit by
T
Tony Battersby 已提交
690
	 * eventpoll_release_file() and epoll_ctl().
D
Davide Libenzi 已提交
691
	 */
692 693 694

	if (!ep_locked)
		mutex_lock_nested(&ep->mtx, depth);
D
Davide Libenzi 已提交
695 696 697 698 699 700 701 702 703

	/*
	 * Steal the ready list, and re-init the original one to the
	 * empty list. Also, set ep->ovflist to NULL so that events
	 * happening while looping w/out locks, are not lost. We cannot
	 * have the poll callback to queue directly on ep->rdllist,
	 * because we want the "sproc" callback to be able to do it
	 * in a lockless way.
	 */
704
	write_lock_irq(&ep->lock);
705
	list_splice_init(&ep->rdllist, &txlist);
706
	WRITE_ONCE(ep->ovflist, NULL);
707
	write_unlock_irq(&ep->lock);
D
Davide Libenzi 已提交
708 709 710 711

	/*
	 * Now call the callback function.
	 */
A
Al Viro 已提交
712
	res = (*sproc)(ep, &txlist, priv);
D
Davide Libenzi 已提交
713

714
	write_lock_irq(&ep->lock);
D
Davide Libenzi 已提交
715 716 717 718 719
	/*
	 * During the time we spent inside the "sproc" callback, some
	 * other events might have been queued by the poll callback.
	 * We re-insert them inside the main ready-list here.
	 */
720
	for (nepi = READ_ONCE(ep->ovflist); (epi = nepi) != NULL;
D
Davide Libenzi 已提交
721 722 723 724 725 726 727
	     nepi = epi->next, epi->next = EP_UNACTIVE_PTR) {
		/*
		 * We need to check if the item is already in the list.
		 * During the "sproc" callback execution time, items are
		 * queued into ->ovflist but the "txlist" might already
		 * contain them, and the list_splice() below takes care of them.
		 */
728
		if (!ep_is_linked(epi)) {
729 730 731 732 733
			/*
			 * ->ovflist is LIFO, so we have to reverse it in order
			 * to keep in FIFO.
			 */
			list_add(&epi->rdllink, &ep->rdllist);
734
			ep_pm_stay_awake(epi);
735
		}
D
Davide Libenzi 已提交
736 737 738 739 740 741
	}
	/*
	 * We need to set back ep->ovflist to EP_UNACTIVE_PTR, so that after
	 * releasing the lock, events will be queued in the normal way inside
	 * ep->rdllist.
	 */
742
	WRITE_ONCE(ep->ovflist, EP_UNACTIVE_PTR);
D
Davide Libenzi 已提交
743 744 745 746 747

	/*
	 * Quickly re-inject items left on "txlist".
	 */
	list_splice(&txlist, &ep->rdllist);
748
	__pm_relax(ep->ws);
749
	write_unlock_irq(&ep->lock);
D
Davide Libenzi 已提交
750

751 752
	if (!ep_locked)
		mutex_unlock(&ep->mtx);
D
Davide Libenzi 已提交
753

A
Al Viro 已提交
754
	return res;
D
Davide Libenzi 已提交
755 756
}

757 758 759 760 761 762
static void epi_rcu_free(struct rcu_head *head)
{
	struct epitem *epi = container_of(head, struct epitem, rcu);
	kmem_cache_free(epi_cache, epi);
}

763 764
/*
 * Removes a "struct epitem" from the eventpoll RB tree and deallocates
765
 * all the associated resources. Must be called with "mtx" held.
766 767 768 769
 */
static int ep_remove(struct eventpoll *ep, struct epitem *epi)
{
	struct file *file = epi->ffd.file;
L
Linus Torvalds 已提交
770

771 772
	lockdep_assert_irqs_enabled();

L
Linus Torvalds 已提交
773
	/*
774
	 * Removes poll wait queue hooks.
L
Linus Torvalds 已提交
775
	 */
776
	ep_unregister_pollwait(ep, epi);
L
Linus Torvalds 已提交
777

778
	/* Remove the current item from the list of epoll hooks */
J
Jonathan Corbet 已提交
779
	spin_lock(&file->f_lock);
780
	list_del_rcu(&epi->fllink);
J
Jonathan Corbet 已提交
781
	spin_unlock(&file->f_lock);
L
Linus Torvalds 已提交
782

783
	rb_erase_cached(&epi->rbn, &ep->rbr);
L
Linus Torvalds 已提交
784

785
	write_lock_irq(&ep->lock);
786
	if (ep_is_linked(epi))
787
		list_del_init(&epi->rdllink);
788
	write_unlock_irq(&ep->lock);
L
Linus Torvalds 已提交
789

790
	wakeup_source_unregister(ep_wakeup_source(epi));
791 792 793 794 795 796 797 798
	/*
	 * At this point it is safe to free the eventpoll item. Use the union
	 * field epi->rcu, since we are trying to minimize the size of
	 * 'struct epitem'. The 'rbn' field is no longer in use. Protected by
	 * ep->mtx. The rcu read side, reverse_path_check_proc(), does not make
	 * use of the rbn field.
	 */
	call_rcu(&epi->rcu, epi_rcu_free);
L
Linus Torvalds 已提交
799

800
	atomic_long_dec(&ep->user->epoll_watches);
801

802
	return 0;
L
Linus Torvalds 已提交
803 804
}

805
static void ep_free(struct eventpoll *ep)
L
Linus Torvalds 已提交
806
{
807 808
	struct rb_node *rbp;
	struct epitem *epi;
L
Linus Torvalds 已提交
809

810 811
	/* We need to release all tasks waiting for these file */
	if (waitqueue_active(&ep->poll_wait))
812
		ep_poll_safewake(ep, NULL);
L
Linus Torvalds 已提交
813

814 815 816
	/*
	 * We need to lock this because we could be hit by
	 * eventpoll_release_file() while we're freeing the "struct eventpoll".
817
	 * We do not need to hold "ep->mtx" here because the epoll file
818 819
	 * is on the way to be removed and no one has references to it
	 * anymore. The only hit might come from eventpoll_release_file() but
L
Lucas De Marchi 已提交
820
	 * holding "epmutex" is sufficient here.
821 822
	 */
	mutex_lock(&epmutex);
L
Linus Torvalds 已提交
823 824

	/*
825
	 * Walks through the whole tree by unregistering poll callbacks.
L
Linus Torvalds 已提交
826
	 */
827
	for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) {
828 829 830
		epi = rb_entry(rbp, struct epitem, rbn);

		ep_unregister_pollwait(ep, epi);
831
		cond_resched();
832
	}
L
Linus Torvalds 已提交
833 834

	/*
835 836
	 * Walks through the whole tree by freeing each "struct epitem". At this
	 * point we are sure no poll callbacks will be lingering around, and also by
837
	 * holding "epmutex" we can be sure that no file cleanup code will hit
838
	 * us during this operation. So we can avoid the lock on "ep->lock".
839 840
	 * We do not need to lock ep->mtx, either, we only do it to prevent
	 * a lockdep warning.
L
Linus Torvalds 已提交
841
	 */
842
	mutex_lock(&ep->mtx);
843
	while ((rbp = rb_first_cached(&ep->rbr)) != NULL) {
844 845
		epi = rb_entry(rbp, struct epitem, rbn);
		ep_remove(ep, epi);
846
		cond_resched();
847
	}
848
	mutex_unlock(&ep->mtx);
L
Linus Torvalds 已提交
849

850
	mutex_unlock(&epmutex);
851
	mutex_destroy(&ep->mtx);
852
	free_uid(ep->user);
853
	wakeup_source_unregister(ep->ws);
854
	kfree(ep);
855
}
L
Linus Torvalds 已提交
856

857 858 859
static int ep_eventpoll_release(struct inode *inode, struct file *file)
{
	struct eventpoll *ep = file->private_data;
L
Linus Torvalds 已提交
860

861
	if (ep)
862 863 864
		ep_free(ep);

	return 0;
L
Linus Torvalds 已提交
865 866
}

A
Al Viro 已提交
867
static __poll_t ep_read_events_proc(struct eventpoll *ep, struct list_head *head,
868 869 870 871 872 873 874 875 876
			       void *priv);
static void ep_ptable_queue_proc(struct file *file, wait_queue_head_t *whead,
				 poll_table *pt);

/*
 * Differs from ep_eventpoll_poll() in that internal callers already have
 * the ep->mtx so we need to start from depth=1, such that mutex_lock_nested()
 * is correctly annotated.
 */
A
Al Viro 已提交
877
static __poll_t ep_item_poll(const struct epitem *epi, poll_table *pt,
878
				 int depth)
879
{
880 881 882
	struct eventpoll *ep;
	bool locked;

883
	pt->_key = epi->event.events;
884
	if (!is_file_epoll(epi->ffd.file))
885
		return vfs_poll(epi->ffd.file, pt) & epi->event.events;
886

887 888 889
	ep = epi->ffd.file->private_data;
	poll_wait(epi->ffd.file, &ep->poll_wait, pt);
	locked = pt && (pt->_qproc == ep_ptable_queue_proc);
890

891 892 893
	return ep_scan_ready_list(epi->ffd.file->private_data,
				  ep_read_events_proc, &depth, depth,
				  locked) & epi->event.events;
894 895
}

A
Al Viro 已提交
896
static __poll_t ep_read_events_proc(struct eventpoll *ep, struct list_head *head,
897
			       void *priv)
D
Davide Libenzi 已提交
898 899
{
	struct epitem *epi, *tmp;
900
	poll_table pt;
901
	int depth = *(int *)priv;
D
Davide Libenzi 已提交
902

903
	init_poll_funcptr(&pt, NULL);
904
	depth++;
905

D
Davide Libenzi 已提交
906
	list_for_each_entry_safe(epi, tmp, head, rdllink) {
907
		if (ep_item_poll(epi, &pt, depth)) {
908
			return EPOLLIN | EPOLLRDNORM;
909
		} else {
D
Davide Libenzi 已提交
910 911 912 913 914
			/*
			 * Item has been dropped into the ready list by the poll
			 * callback, but it's not actually ready, as far as
			 * caller requested events goes. We can remove it here.
			 */
915
			__pm_relax(ep_wakeup_source(epi));
D
Davide Libenzi 已提交
916
			list_del_init(&epi->rdllink);
917
		}
D
Davide Libenzi 已提交
918 919 920 921 922
	}

	return 0;
}

923
static __poll_t ep_eventpoll_poll(struct file *file, poll_table *wait)
B
Ben Noordhuis 已提交
924 925 926
{
	struct eventpoll *ep = file->private_data;
	int depth = 0;
927

928 929 930
	/* Insert inside our poll wait queue */
	poll_wait(file, &ep->poll_wait, wait);

D
Davide Libenzi 已提交
931 932
	/*
	 * Proceed to find out if wanted events are really available inside
933
	 * the ready list.
D
Davide Libenzi 已提交
934
	 */
935 936
	return ep_scan_ready_list(ep, ep_read_events_proc,
				  &depth, depth, false);
937 938
}

939
#ifdef CONFIG_PROC_FS
940
static void ep_show_fdinfo(struct seq_file *m, struct file *f)
941 942 943 944 945
{
	struct eventpoll *ep = f->private_data;
	struct rb_node *rbp;

	mutex_lock(&ep->mtx);
946
	for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) {
947
		struct epitem *epi = rb_entry(rbp, struct epitem, rbn);
948
		struct inode *inode = file_inode(epi->ffd.file);
949

950 951
		seq_printf(m, "tfd: %8d events: %8x data: %16llx "
			   " pos:%lli ino:%lx sdev:%x\n",
952
			   epi->ffd.fd, epi->event.events,
953 954 955
			   (long long)epi->event.data,
			   (long long)epi->ffd.file->f_pos,
			   inode->i_ino, inode->i_sb->s_dev);
956
		if (seq_has_overflowed(m))
957 958 959 960 961 962
			break;
	}
	mutex_unlock(&ep->mtx);
}
#endif

963 964
/* File callbacks that implement the eventpoll file behaviour */
static const struct file_operations eventpoll_fops = {
965 966 967
#ifdef CONFIG_PROC_FS
	.show_fdinfo	= ep_show_fdinfo,
#endif
968
	.release	= ep_eventpoll_release,
969
	.poll		= ep_eventpoll_poll,
970
	.llseek		= noop_llseek,
971 972
};

D
Davide Libenzi 已提交
973
/*
974 975 976
 * This is called from eventpoll_release() to unlink files from the eventpoll
 * interface. We need to have this facility to cleanup correctly files that are
 * closed without being removed from the eventpoll interface.
D
Davide Libenzi 已提交
977
 */
978
void eventpoll_release_file(struct file *file)
D
Davide Libenzi 已提交
979
{
980
	struct eventpoll *ep;
981
	struct epitem *epi, *next;
D
Davide Libenzi 已提交
982 983

	/*
J
Jonathan Corbet 已提交
984
	 * We don't want to get "file->f_lock" because it is not
985
	 * necessary. It is not necessary because we're in the "struct file"
L
Lucas De Marchi 已提交
986
	 * cleanup path, and this means that no one is using this file anymore.
D
Davide Libenzi 已提交
987
	 * So, for example, epoll_ctl() cannot hit here since if we reach this
D
Davide Libenzi 已提交
988
	 * point, the file counter already went to zero and fget() would fail.
989
	 * The only hit might come from ep_free() but by holding the mutex
990
	 * will correctly serialize the operation. We do need to acquire
991
	 * "ep->mtx" after "epmutex" because ep_remove() requires it when called
992
	 * from anywhere but ep_free().
J
Jonathan Corbet 已提交
993 994
	 *
	 * Besides, ep_remove() acquires the lock, so we can't hold it here.
D
Davide Libenzi 已提交
995
	 */
996
	mutex_lock(&epmutex);
997
	list_for_each_entry_safe(epi, next, &file->f_ep_links, fllink) {
998
		ep = epi->ep;
999
		mutex_lock_nested(&ep->mtx, 0);
1000
		ep_remove(ep, epi);
1001
		mutex_unlock(&ep->mtx);
D
Davide Libenzi 已提交
1002
	}
1003
	mutex_unlock(&epmutex);
D
Davide Libenzi 已提交
1004 1005
}

1006
static int ep_alloc(struct eventpoll **pep)
L
Linus Torvalds 已提交
1007
{
1008 1009 1010
	int error;
	struct user_struct *user;
	struct eventpoll *ep;
L
Linus Torvalds 已提交
1011

1012 1013 1014 1015 1016
	user = get_current_user();
	error = -ENOMEM;
	ep = kzalloc(sizeof(*ep), GFP_KERNEL);
	if (unlikely(!ep))
		goto free_uid;
L
Linus Torvalds 已提交
1017

1018
	mutex_init(&ep->mtx);
1019
	rwlock_init(&ep->lock);
L
Linus Torvalds 已提交
1020 1021 1022
	init_waitqueue_head(&ep->wq);
	init_waitqueue_head(&ep->poll_wait);
	INIT_LIST_HEAD(&ep->rdllist);
1023
	ep->rbr = RB_ROOT_CACHED;
1024
	ep->ovflist = EP_UNACTIVE_PTR;
1025
	ep->user = user;
L
Linus Torvalds 已提交
1026

1027
	*pep = ep;
L
Linus Torvalds 已提交
1028 1029

	return 0;
1030 1031 1032 1033

free_uid:
	free_uid(user);
	return error;
L
Linus Torvalds 已提交
1034 1035 1036
}

/*
1037 1038 1039
 * Search the file inside the eventpoll tree. The RB tree operations
 * are protected by the "mtx" mutex, and ep_find() must be called with
 * "mtx" held.
L
Linus Torvalds 已提交
1040 1041 1042 1043 1044 1045 1046 1047
 */
static struct epitem *ep_find(struct eventpoll *ep, struct file *file, int fd)
{
	int kcmp;
	struct rb_node *rbp;
	struct epitem *epi, *epir = NULL;
	struct epoll_filefd ffd;

1048
	ep_set_ffd(&ffd, file, fd);
1049
	for (rbp = ep->rbr.rb_root.rb_node; rbp; ) {
L
Linus Torvalds 已提交
1050
		epi = rb_entry(rbp, struct epitem, rbn);
1051
		kcmp = ep_cmp_ffd(&ffd, &epi->ffd);
L
Linus Torvalds 已提交
1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064
		if (kcmp > 0)
			rbp = rbp->rb_right;
		else if (kcmp < 0)
			rbp = rbp->rb_left;
		else {
			epir = epi;
			break;
		}
	}

	return epir;
}

1065
#ifdef CONFIG_CHECKPOINT_RESTORE
1066 1067 1068 1069 1070
static struct epitem *ep_find_tfd(struct eventpoll *ep, int tfd, unsigned long toff)
{
	struct rb_node *rbp;
	struct epitem *epi;

1071
	for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) {
1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106
		epi = rb_entry(rbp, struct epitem, rbn);
		if (epi->ffd.fd == tfd) {
			if (toff == 0)
				return epi;
			else
				toff--;
		}
		cond_resched();
	}

	return NULL;
}

struct file *get_epoll_tfile_raw_ptr(struct file *file, int tfd,
				     unsigned long toff)
{
	struct file *file_raw;
	struct eventpoll *ep;
	struct epitem *epi;

	if (!is_file_epoll(file))
		return ERR_PTR(-EINVAL);

	ep = file->private_data;

	mutex_lock(&ep->mtx);
	epi = ep_find_tfd(ep, tfd, toff);
	if (epi)
		file_raw = epi->ffd.file;
	else
		file_raw = ERR_PTR(-ENOENT);
	mutex_unlock(&ep->mtx);

	return file_raw;
}
1107
#endif /* CONFIG_CHECKPOINT_RESTORE */
1108

1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171
/**
 * Adds a new entry to the tail of the list in a lockless way, i.e.
 * multiple CPUs are allowed to call this function concurrently.
 *
 * Beware: it is necessary to prevent any other modifications of the
 *         existing list until all changes are completed, in other words
 *         concurrent list_add_tail_lockless() calls should be protected
 *         with a read lock, where write lock acts as a barrier which
 *         makes sure all list_add_tail_lockless() calls are fully
 *         completed.
 *
 *        Also an element can be locklessly added to the list only in one
 *        direction i.e. either to the tail either to the head, otherwise
 *        concurrent access will corrupt the list.
 *
 * Returns %false if element has been already added to the list, %true
 * otherwise.
 */
static inline bool list_add_tail_lockless(struct list_head *new,
					  struct list_head *head)
{
	struct list_head *prev;

	/*
	 * This is simple 'new->next = head' operation, but cmpxchg()
	 * is used in order to detect that same element has been just
	 * added to the list from another CPU: the winner observes
	 * new->next == new.
	 */
	if (cmpxchg(&new->next, new, head) != new)
		return false;

	/*
	 * Initially ->next of a new element must be updated with the head
	 * (we are inserting to the tail) and only then pointers are atomically
	 * exchanged.  XCHG guarantees memory ordering, thus ->next should be
	 * updated before pointers are actually swapped and pointers are
	 * swapped before prev->next is updated.
	 */

	prev = xchg(&head->prev, new);

	/*
	 * It is safe to modify prev->next and new->prev, because a new element
	 * is added only to the tail and new->next is updated before XCHG.
	 */

	prev->next = new;
	new->prev = prev;

	return true;
}

/**
 * Chains a new epi entry to the tail of the ep->ovflist in a lockless way,
 * i.e. multiple CPUs are allowed to call this function concurrently.
 *
 * Returns %false if epi element has been already chained, %true otherwise.
 */
static inline bool chain_epi_lockless(struct epitem *epi)
{
	struct eventpoll *ep = epi->ep;

1172 1173 1174 1175
	/* Fast preliminary check */
	if (epi->next != EP_UNACTIVE_PTR)
		return false;

1176 1177 1178 1179 1180 1181 1182 1183 1184 1185
	/* Check that the same epi has not been just chained from another CPU */
	if (cmpxchg(&epi->next, EP_UNACTIVE_PTR, NULL) != EP_UNACTIVE_PTR)
		return false;

	/* Atomically exchange tail */
	epi->next = xchg(&ep->ovflist, epi);

	return true;
}

L
Linus Torvalds 已提交
1186
/*
1187
 * This is the callback that is passed to the wait queue wakeup
D
Daniel Baluta 已提交
1188
 * mechanism. It is called by the stored file descriptors when they
1189
 * have events to report.
1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202
 *
 * This callback takes a read lock in order not to content with concurrent
 * events from another file descriptors, thus all modifications to ->rdllist
 * or ->ovflist are lockless.  Read lock is paired with the write lock from
 * ep_scan_ready_list(), which stops all list modifications and guarantees
 * that lists state is seen correctly.
 *
 * Another thing worth to mention is that ep_poll_callback() can be called
 * concurrently for the same @epi from different CPUs if poll table was inited
 * with several wait queues entries.  Plural wakeup from different CPUs of a
 * single wait queue is serialized by wq.lock, but the case when multiple wait
 * queues are used should be detected accordingly.  This is detected using
 * cmpxchg() operation.
L
Linus Torvalds 已提交
1203
 */
1204
static int ep_poll_callback(wait_queue_entry_t *wait, unsigned mode, int sync, void *key)
L
Linus Torvalds 已提交
1205
{
1206 1207 1208
	int pwake = 0;
	struct epitem *epi = ep_item_from_wait(wait);
	struct eventpoll *ep = epi->ep;
A
Al Viro 已提交
1209
	__poll_t pollflags = key_to_poll(key);
1210
	unsigned long flags;
J
Jason Baron 已提交
1211
	int ewake = 0;
L
Linus Torvalds 已提交
1212

1213
	read_lock_irqsave(&ep->lock, flags);
L
Linus Torvalds 已提交
1214

1215 1216
	ep_set_busy_poll_napi_id(epi);

1217 1218 1219 1220 1221 1222 1223
	/*
	 * If the event mask does not contain any poll(2) event, we consider the
	 * descriptor to be disabled. This condition is likely the effect of the
	 * EPOLLONESHOT bit that disables the descriptor when an event is received,
	 * until the next EPOLL_CTL_MOD will be issued.
	 */
	if (!(epi->event.events & ~EP_PRIVATE_BITS))
1224 1225
		goto out_unlock;

1226 1227 1228 1229 1230 1231
	/*
	 * Check the events coming with the callback. At this stage, not
	 * every device reports the events in the "key" parameter of the
	 * callback. We need to be able to handle both cases here, hence the
	 * test for "key" != NULL before the event match test.
	 */
A
Al Viro 已提交
1232
	if (pollflags && !(pollflags & epi->event.events))
1233 1234
		goto out_unlock;

1235
	/*
D
Daniel Baluta 已提交
1236
	 * If we are transferring events to userspace, we can hold no locks
1237
	 * (because we're accessing user memory, and because of linux f_op->poll()
D
Daniel Baluta 已提交
1238
	 * semantics). All the events that happen during that period of time are
1239 1240
	 * chained in ep->ovflist and requeued later on.
	 */
1241
	if (READ_ONCE(ep->ovflist) != EP_UNACTIVE_PTR) {
1242 1243 1244 1245 1246
		if (chain_epi_lockless(epi))
			ep_pm_stay_awake_rcu(epi);
	} else if (!ep_is_linked(epi)) {
		/* In the usual case, add event to ready list. */
		if (list_add_tail_lockless(&epi->rdllink, &ep->rdllist))
1247
			ep_pm_stay_awake_rcu(epi);
1248
	}
1249 1250 1251 1252 1253

	/*
	 * Wake up ( if active ) both the eventpoll wait list and the ->poll()
	 * wait list.
	 */
J
Jason Baron 已提交
1254
	if (waitqueue_active(&ep->wq)) {
1255
		if ((epi->event.events & EPOLLEXCLUSIVE) &&
A
Al Viro 已提交
1256 1257
					!(pollflags & POLLFREE)) {
			switch (pollflags & EPOLLINOUT_BITS) {
1258 1259
			case EPOLLIN:
				if (epi->event.events & EPOLLIN)
1260 1261
					ewake = 1;
				break;
1262 1263
			case EPOLLOUT:
				if (epi->event.events & EPOLLOUT)
1264 1265 1266 1267 1268 1269 1270
					ewake = 1;
				break;
			case 0:
				ewake = 1;
				break;
			}
		}
1271
		wake_up(&ep->wq);
J
Jason Baron 已提交
1272
	}
1273 1274 1275
	if (waitqueue_active(&ep->poll_wait))
		pwake++;

1276
out_unlock:
1277
	read_unlock_irqrestore(&ep->lock, flags);
L
Linus Torvalds 已提交
1278

1279 1280
	/* We have to call this outside the lock */
	if (pwake)
1281
		ep_poll_safewake(ep, epi);
1282

1283 1284 1285
	if (!(epi->event.events & EPOLLEXCLUSIVE))
		ewake = 1;

A
Al Viro 已提交
1286
	if (pollflags & POLLFREE) {
1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300
		/*
		 * If we race with ep_remove_wait_queue() it can miss
		 * ->whead = NULL and do another remove_wait_queue() after
		 * us, so we can't use __remove_wait_queue().
		 */
		list_del_init(&wait->entry);
		/*
		 * ->whead != NULL protects us from the race with ep_free()
		 * or ep_remove(), ep_remove_wait_queue() takes whead->lock
		 * held by the caller. Once we nullify it, nothing protects
		 * ep/epi or even wait.
		 */
		smp_store_release(&ep_pwq_from_wait(wait)->whead, NULL);
	}
J
Jason Baron 已提交
1301

1302
	return ewake;
1303
}
L
Linus Torvalds 已提交
1304 1305 1306 1307 1308 1309 1310 1311

/*
 * This is the callback that is used to add our wait queue to the
 * target file wakeup lists.
 */
static void ep_ptable_queue_proc(struct file *file, wait_queue_head_t *whead,
				 poll_table *pt)
{
1312
	struct epitem *epi = ep_item_from_epqueue(pt);
L
Linus Torvalds 已提交
1313 1314
	struct eppoll_entry *pwq;

1315
	if (epi->nwait >= 0 && (pwq = kmem_cache_alloc(pwq_cache, GFP_KERNEL))) {
L
Linus Torvalds 已提交
1316 1317 1318
		init_waitqueue_func_entry(&pwq->wait, ep_poll_callback);
		pwq->whead = whead;
		pwq->base = epi;
J
Jason Baron 已提交
1319 1320 1321 1322
		if (epi->event.events & EPOLLEXCLUSIVE)
			add_wait_queue_exclusive(whead, &pwq->wait);
		else
			add_wait_queue(whead, &pwq->wait);
L
Linus Torvalds 已提交
1323 1324
		list_add_tail(&pwq->llink, &epi->pwqlist);
		epi->nwait++;
1325
	} else {
L
Linus Torvalds 已提交
1326 1327
		/* We have to signal that an error occurred */
		epi->nwait = -1;
1328
	}
L
Linus Torvalds 已提交
1329 1330 1331 1332 1333
}

static void ep_rbtree_insert(struct eventpoll *ep, struct epitem *epi)
{
	int kcmp;
1334
	struct rb_node **p = &ep->rbr.rb_root.rb_node, *parent = NULL;
L
Linus Torvalds 已提交
1335
	struct epitem *epic;
1336
	bool leftmost = true;
L
Linus Torvalds 已提交
1337 1338 1339 1340

	while (*p) {
		parent = *p;
		epic = rb_entry(parent, struct epitem, rbn);
1341
		kcmp = ep_cmp_ffd(&epi->ffd, &epic->ffd);
1342
		if (kcmp > 0) {
L
Linus Torvalds 已提交
1343
			p = &parent->rb_right;
1344 1345
			leftmost = false;
		} else
L
Linus Torvalds 已提交
1346 1347 1348
			p = &parent->rb_left;
	}
	rb_link_node(&epi->rbn, parent, p);
1349
	rb_insert_color_cached(&epi->rbn, &ep->rbr, leftmost);
L
Linus Torvalds 已提交
1350 1351
}

1352 1353


J
Jason Baron 已提交
1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370
#define PATH_ARR_SIZE 5
/*
 * These are the number paths of length 1 to 5, that we are allowing to emanate
 * from a single file of interest. For example, we allow 1000 paths of length
 * 1, to emanate from each file of interest. This essentially represents the
 * potential wakeup paths, which need to be limited in order to avoid massive
 * uncontrolled wakeup storms. The common use case should be a single ep which
 * is connected to n file sources. In this case each file source has 1 path
 * of length 1. Thus, the numbers below should be more than sufficient. These
 * path limits are enforced during an EPOLL_CTL_ADD operation, since a modify
 * and delete can't add additional paths. Protected by the epmutex.
 */
static const int path_limits[PATH_ARR_SIZE] = { 1000, 500, 100, 50, 10 };
static int path_count[PATH_ARR_SIZE];

static int path_count_inc(int nests)
{
J
Jason Baron 已提交
1371 1372 1373 1374
	/* Allow an arbitrary number of depth 1 paths */
	if (nests == 0)
		return 0;

J
Jason Baron 已提交
1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394
	if (++path_count[nests] > path_limits[nests])
		return -1;
	return 0;
}

static void path_count_init(void)
{
	int i;

	for (i = 0; i < PATH_ARR_SIZE; i++)
		path_count[i] = 0;
}

static int reverse_path_check_proc(void *priv, void *cookie, int call_nests)
{
	int error = 0;
	struct file *file = priv;
	struct file *child_file;
	struct epitem *epi;

1395 1396 1397
	/* CTL_DEL can remove links here, but that can't increase our count */
	rcu_read_lock();
	list_for_each_entry_rcu(epi, &file->f_ep_links, fllink) {
J
Jason Baron 已提交
1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417
		child_file = epi->ep->file;
		if (is_file_epoll(child_file)) {
			if (list_empty(&child_file->f_ep_links)) {
				if (path_count_inc(call_nests)) {
					error = -1;
					break;
				}
			} else {
				error = ep_call_nested(&poll_loop_ncalls,
							reverse_path_check_proc,
							child_file, child_file,
							current);
			}
			if (error != 0)
				break;
		} else {
			printk(KERN_ERR "reverse_path_check_proc: "
				"file is not an ep!\n");
		}
	}
1418
	rcu_read_unlock();
J
Jason Baron 已提交
1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439
	return error;
}

/**
 * reverse_path_check - The tfile_check_list is list of file *, which have
 *                      links that are proposed to be newly added. We need to
 *                      make sure that those added links don't add too many
 *                      paths such that we will spend all our time waking up
 *                      eventpoll objects.
 *
 * Returns: Returns zero if the proposed links don't create too many paths,
 *	    -1 otherwise.
 */
static int reverse_path_check(void)
{
	int error = 0;
	struct file *current_file;

	/* let's call this for all tfiles */
	list_for_each_entry(current_file, &tfile_check_list, f_tfile_llink) {
		path_count_init();
1440
		error = ep_call_nested(&poll_loop_ncalls,
J
Jason Baron 已提交
1441 1442 1443 1444 1445 1446 1447 1448
					reverse_path_check_proc, current_file,
					current_file, current);
		if (error)
			break;
	}
	return error;
}

1449 1450 1451
static int ep_create_wakeup_source(struct epitem *epi)
{
	const char *name;
1452
	struct wakeup_source *ws;
1453 1454

	if (!epi->ep->ws) {
1455
		epi->ep->ws = wakeup_source_register(NULL, "eventpoll");
1456 1457 1458 1459 1460
		if (!epi->ep->ws)
			return -ENOMEM;
	}

	name = epi->ffd.file->f_path.dentry->d_name.name;
1461
	ws = wakeup_source_register(NULL, name);
1462 1463

	if (!ws)
1464
		return -ENOMEM;
1465
	rcu_assign_pointer(epi->ws, ws);
1466 1467 1468 1469

	return 0;
}

1470 1471
/* rare code path, only used when EPOLL_CTL_MOD removes a wakeup source */
static noinline void ep_destroy_wakeup_source(struct epitem *epi)
1472
{
1473 1474
	struct wakeup_source *ws = ep_wakeup_source(epi);

1475
	RCU_INIT_POINTER(epi->ws, NULL);
1476 1477 1478 1479 1480 1481 1482 1483

	/*
	 * wait for ep_pm_stay_awake_rcu to finish, synchronize_rcu is
	 * used internally by wakeup_source_remove, too (called by
	 * wakeup_source_unregister), so we cannot use call_rcu
	 */
	synchronize_rcu();
	wakeup_source_unregister(ws);
1484 1485
}

1486 1487 1488
/*
 * Must be called with "mtx" held.
 */
1489
static int ep_insert(struct eventpoll *ep, const struct epoll_event *event,
1490
		     struct file *tfile, int fd, int full_check)
L
Linus Torvalds 已提交
1491
{
A
Al Viro 已提交
1492 1493
	int error, pwake = 0;
	__poll_t revents;
1494
	long user_watches;
L
Linus Torvalds 已提交
1495 1496 1497
	struct epitem *epi;
	struct ep_pqueue epq;

1498 1499
	lockdep_assert_irqs_enabled();

1500 1501
	user_watches = atomic_long_read(&ep->user->epoll_watches);
	if (unlikely(user_watches >= max_user_watches))
1502
		return -ENOSPC;
1503
	if (!(epi = kmem_cache_alloc(epi_cache, GFP_KERNEL)))
1504
		return -ENOMEM;
L
Linus Torvalds 已提交
1505 1506 1507 1508 1509 1510

	/* Item initialization follow here ... */
	INIT_LIST_HEAD(&epi->rdllink);
	INIT_LIST_HEAD(&epi->fllink);
	INIT_LIST_HEAD(&epi->pwqlist);
	epi->ep = ep;
1511
	ep_set_ffd(&epi->ffd, tfile, fd);
L
Linus Torvalds 已提交
1512 1513
	epi->event = *event;
	epi->nwait = 0;
1514
	epi->next = EP_UNACTIVE_PTR;
1515 1516 1517 1518 1519
	if (epi->event.events & EPOLLWAKEUP) {
		error = ep_create_wakeup_source(epi);
		if (error)
			goto error_create_wakeup_source;
	} else {
1520
		RCU_INIT_POINTER(epi->ws, NULL);
1521
	}
L
Linus Torvalds 已提交
1522

1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538
	/* Add the current item to the list of active epoll hook for this file */
	spin_lock(&tfile->f_lock);
	list_add_tail_rcu(&epi->fllink, &tfile->f_ep_links);
	spin_unlock(&tfile->f_lock);

	/*
	 * Add the current item to the RB tree. All RB tree operations are
	 * protected by "mtx", and ep_insert() is called with "mtx" held.
	 */
	ep_rbtree_insert(ep, epi);

	/* now check if we've created too many backpaths */
	error = -EINVAL;
	if (full_check && reverse_path_check())
		goto error_remove_epi;

L
Linus Torvalds 已提交
1539 1540 1541 1542 1543 1544 1545
	/* Initialize the poll table using the queue callback */
	epq.epi = epi;
	init_poll_funcptr(&epq.pt, ep_ptable_queue_proc);

	/*
	 * Attach the item to the poll hooks and get current event bits.
	 * We can safely use the file* here because its usage count has
1546 1547 1548
	 * been increased by the caller of this function. Note that after
	 * this operation completes, the poll callback can start hitting
	 * the new item.
L
Linus Torvalds 已提交
1549
	 */
1550
	revents = ep_item_poll(epi, &epq.pt, 1);
L
Linus Torvalds 已提交
1551 1552 1553 1554 1555 1556

	/*
	 * We have to check if something went wrong during the poll wait queue
	 * install process. Namely an allocation for a wait queue failed due
	 * high memory pressure.
	 */
1557
	error = -ENOMEM;
L
Linus Torvalds 已提交
1558
	if (epi->nwait < 0)
1559
		goto error_unregister;
L
Linus Torvalds 已提交
1560

1561
	/* We have to drop the new item inside our item list to keep track of it */
1562
	write_lock_irq(&ep->lock);
1563

1564 1565 1566
	/* record NAPI ID of new item if present */
	ep_set_busy_poll_napi_id(epi);

L
Linus Torvalds 已提交
1567
	/* If the file is already "ready" we drop it inside the ready list */
1568
	if (revents && !ep_is_linked(epi)) {
L
Linus Torvalds 已提交
1569
		list_add_tail(&epi->rdllink, &ep->rdllist);
1570
		ep_pm_stay_awake(epi);
L
Linus Torvalds 已提交
1571 1572 1573

		/* Notify waiting tasks that events are available */
		if (waitqueue_active(&ep->wq))
1574
			wake_up(&ep->wq);
L
Linus Torvalds 已提交
1575 1576 1577 1578
		if (waitqueue_active(&ep->poll_wait))
			pwake++;
	}

1579
	write_unlock_irq(&ep->lock);
L
Linus Torvalds 已提交
1580

1581
	atomic_long_inc(&ep->user->epoll_watches);
1582

L
Linus Torvalds 已提交
1583 1584
	/* We have to call this outside the lock */
	if (pwake)
1585
		ep_poll_safewake(ep, NULL);
L
Linus Torvalds 已提交
1586 1587 1588

	return 0;

1589 1590
error_unregister:
	ep_unregister_pollwait(ep, epi);
J
Jason Baron 已提交
1591 1592
error_remove_epi:
	spin_lock(&tfile->f_lock);
1593
	list_del_rcu(&epi->fllink);
J
Jason Baron 已提交
1594 1595
	spin_unlock(&tfile->f_lock);

1596
	rb_erase_cached(&epi->rbn, &ep->rbr);
J
Jason Baron 已提交
1597

L
Linus Torvalds 已提交
1598 1599
	/*
	 * We need to do this because an event could have been arrived on some
D
Davide Libenzi 已提交
1600 1601 1602
	 * allocated wait queue. Note that we don't care about the ep->ovflist
	 * list, since that is used/cleaned only inside a section bound by "mtx".
	 * And ep_insert() is called with "mtx" held.
L
Linus Torvalds 已提交
1603
	 */
1604
	write_lock_irq(&ep->lock);
1605
	if (ep_is_linked(epi))
1606
		list_del_init(&epi->rdllink);
1607
	write_unlock_irq(&ep->lock);
L
Linus Torvalds 已提交
1608

1609
	wakeup_source_unregister(ep_wakeup_source(epi));
1610 1611

error_create_wakeup_source:
1612
	kmem_cache_free(epi_cache, epi);
1613

L
Linus Torvalds 已提交
1614 1615 1616 1617 1618
	return error;
}

/*
 * Modify the interest event mask by dropping an event if the new mask
1619
 * has a match in the current file status. Must be called with "mtx" held.
L
Linus Torvalds 已提交
1620
 */
1621 1622
static int ep_modify(struct eventpoll *ep, struct epitem *epi,
		     const struct epoll_event *event)
L
Linus Torvalds 已提交
1623 1624
{
	int pwake = 0;
1625 1626
	poll_table pt;

1627 1628
	lockdep_assert_irqs_enabled();

1629
	init_poll_funcptr(&pt, NULL);
L
Linus Torvalds 已提交
1630 1631

	/*
T
Tony Battersby 已提交
1632 1633 1634
	 * Set the new event interest mask before calling f_op->poll();
	 * otherwise we might miss an event that happens between the
	 * f_op->poll() call and the new event set registering.
L
Linus Torvalds 已提交
1635
	 */
1636
	epi->event.events = event->events; /* need barrier below */
T
Tony Battersby 已提交
1637
	epi->event.data = event->data; /* protected by mtx */
1638
	if (epi->event.events & EPOLLWAKEUP) {
1639
		if (!ep_has_wakeup_source(epi))
1640
			ep_create_wakeup_source(epi);
1641
	} else if (ep_has_wakeup_source(epi)) {
1642 1643
		ep_destroy_wakeup_source(epi);
	}
L
Linus Torvalds 已提交
1644

1645 1646 1647 1648 1649 1650
	/*
	 * The following barrier has two effects:
	 *
	 * 1) Flush epi changes above to other CPUs.  This ensures
	 *    we do not miss events from ep_poll_callback if an
	 *    event occurs immediately after we call f_op->poll().
1651
	 *    We need this because we did not take ep->lock while
1652
	 *    changing epi above (but ep_poll_callback does take
1653
	 *    ep->lock).
1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664
	 *
	 * 2) We also need to ensure we do not miss _past_ events
	 *    when calling f_op->poll().  This barrier also
	 *    pairs with the barrier in wq_has_sleeper (see
	 *    comments for wq_has_sleeper).
	 *
	 * This barrier will now guarantee ep_poll_callback or f_op->poll
	 * (or both) will notice the readiness of an item.
	 */
	smp_mb();

L
Linus Torvalds 已提交
1665 1666 1667
	/*
	 * Get current event bits. We can safely use the file* here because
	 * its usage count has been increased by the caller of this function.
1668
	 * If the item is "hot" and it is not registered inside the ready
D
Davide Libenzi 已提交
1669
	 * list, push it inside.
L
Linus Torvalds 已提交
1670
	 */
1671
	if (ep_item_poll(epi, &pt, 1)) {
1672
		write_lock_irq(&ep->lock);
1673
		if (!ep_is_linked(epi)) {
1674
			list_add_tail(&epi->rdllink, &ep->rdllist);
1675
			ep_pm_stay_awake(epi);
1676 1677 1678

			/* Notify waiting tasks that events are available */
			if (waitqueue_active(&ep->wq))
1679
				wake_up(&ep->wq);
1680 1681
			if (waitqueue_active(&ep->poll_wait))
				pwake++;
1682
		}
1683
		write_unlock_irq(&ep->lock);
1684
	}
L
Linus Torvalds 已提交
1685

1686 1687
	/* We have to call this outside the lock */
	if (pwake)
1688
		ep_poll_safewake(ep, NULL);
L
Linus Torvalds 已提交
1689

1690
	return 0;
L
Linus Torvalds 已提交
1691 1692
}

A
Al Viro 已提交
1693
static __poll_t ep_send_events_proc(struct eventpoll *ep, struct list_head *head,
1694
			       void *priv)
L
Linus Torvalds 已提交
1695
{
D
Davide Libenzi 已提交
1696
	struct ep_send_events_data *esed = priv;
A
Al Viro 已提交
1697
	__poll_t revents;
1698 1699
	struct epitem *epi, *tmp;
	struct epoll_event __user *uevent = esed->events;
1700
	struct wakeup_source *ws;
1701 1702 1703
	poll_table pt;

	init_poll_funcptr(&pt, NULL);
1704
	esed->res = 0;
L
Linus Torvalds 已提交
1705

1706
	/*
D
Davide Libenzi 已提交
1707 1708 1709
	 * We can loop without lock because we are passed a task private list.
	 * Items cannot vanish during the loop because ep_scan_ready_list() is
	 * holding "mtx" during this call.
1710
	 */
1711 1712
	lockdep_assert_held(&ep->mtx);

1713 1714 1715
	list_for_each_entry_safe(epi, tmp, head, rdllink) {
		if (esed->res >= esed->maxevents)
			break;
1716

1717 1718 1719 1720 1721 1722 1723 1724 1725
		/*
		 * Activate ep->ws before deactivating epi->ws to prevent
		 * triggering auto-suspend here (in case we reactive epi->ws
		 * below).
		 *
		 * This could be rearranged to delay the deactivation of epi->ws
		 * instead, but then epi->ws would temporarily be out of sync
		 * with ep_is_linked().
		 */
1726 1727 1728 1729 1730 1731 1732
		ws = ep_wakeup_source(epi);
		if (ws) {
			if (ws->active)
				__pm_stay_awake(ep->ws);
			__pm_relax(ws);
		}

1733
		list_del_init(&epi->rdllink);
L
Linus Torvalds 已提交
1734

1735
		/*
D
Davide Libenzi 已提交
1736 1737
		 * If the event mask intersect the caller-requested one,
		 * deliver the event to userspace. Again, ep_scan_ready_list()
1738
		 * is holding ep->mtx, so no operations coming from userspace
D
Davide Libenzi 已提交
1739
		 * can change the item.
1740
		 */
1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770
		revents = ep_item_poll(epi, &pt, 1);
		if (!revents)
			continue;

		if (__put_user(revents, &uevent->events) ||
		    __put_user(epi->event.data, &uevent->data)) {
			list_add(&epi->rdllink, head);
			ep_pm_stay_awake(epi);
			if (!esed->res)
				esed->res = -EFAULT;
			return 0;
		}
		esed->res++;
		uevent++;
		if (epi->event.events & EPOLLONESHOT)
			epi->event.events &= EP_PRIVATE_BITS;
		else if (!(epi->event.events & EPOLLET)) {
			/*
			 * If this file has been added with Level
			 * Trigger mode, we need to insert back inside
			 * the ready list, so that the next call to
			 * epoll_wait() will check again the events
			 * availability. At this point, no one can insert
			 * into ep->rdllist besides us. The epoll_ctl()
			 * callers are locked out by
			 * ep_scan_ready_list() holding "mtx" and the
			 * poll callback will queue them in ep->ovflist.
			 */
			list_add_tail(&epi->rdllink, &ep->rdllist);
			ep_pm_stay_awake(epi);
1771 1772
		}
	}
D
Davide Libenzi 已提交
1773

1774
	return 0;
D
Davide Libenzi 已提交
1775
}
1776

1777 1778
static int ep_send_events(struct eventpoll *ep,
			  struct epoll_event __user *events, int maxevents)
D
Davide Libenzi 已提交
1779 1780
{
	struct ep_send_events_data esed;
L
Linus Torvalds 已提交
1781

D
Davide Libenzi 已提交
1782 1783
	esed.maxevents = maxevents;
	esed.events = events;
1784

1785 1786
	ep_scan_ready_list(ep, ep_send_events_proc, &esed, 0, false);
	return esed.res;
L
Linus Torvalds 已提交
1787 1788
}

1789
static inline struct timespec64 ep_set_mstimeout(long ms)
1790
{
1791
	struct timespec64 now, ts = {
1792 1793 1794 1795
		.tv_sec = ms / MSEC_PER_SEC,
		.tv_nsec = NSEC_PER_MSEC * (ms % MSEC_PER_SEC),
	};

1796 1797
	ktime_get_ts64(&now);
	return timespec64_add_safe(now, ts);
1798 1799
}

1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816
/**
 * ep_poll - Retrieves ready events, and delivers them to the caller supplied
 *           event buffer.
 *
 * @ep: Pointer to the eventpoll context.
 * @events: Pointer to the userspace buffer where the ready events should be
 *          stored.
 * @maxevents: Size (in terms of number of events) of the caller event buffer.
 * @timeout: Maximum timeout for the ready events fetch operation, in
 *           milliseconds. If the @timeout is zero, the function will not block,
 *           while if the @timeout is less than zero, the function will block
 *           until at least one event has been retrieved (or an error
 *           occurred).
 *
 * Returns: Returns the number of ready events which have been fetched, or an
 *          error code, in case of error.
 */
L
Linus Torvalds 已提交
1817 1818 1819
static int ep_poll(struct eventpoll *ep, struct epoll_event __user *events,
		   int maxevents, long timeout)
{
1820
	int res = 0, eavail, timed_out = 0;
1821
	u64 slack = 0;
1822
	wait_queue_entry_t wait;
1823 1824
	ktime_t expires, *to = NULL;

1825 1826
	lockdep_assert_irqs_enabled();

1827
	if (timeout > 0) {
1828
		struct timespec64 end_time = ep_set_mstimeout(timeout);
1829

1830 1831
		slack = select_estimate_accuracy(&end_time);
		to = &expires;
1832
		*to = timespec64_to_ktime(end_time);
1833
	} else if (timeout == 0) {
1834 1835
		/*
		 * Avoid the unnecessary trip to the wait queue loop, if the
1836 1837 1838 1839
		 * caller specified a non blocking operation. We still need
		 * lock because we could race and not see an epi being added
		 * to the ready list while in irq callback. Thus incorrectly
		 * returning 0 back to userspace.
1840
		 */
1841
		timed_out = 1;
1842

1843
		write_lock_irq(&ep->lock);
1844
		eavail = ep_events_available(ep);
1845
		write_unlock_irq(&ep->lock);
1846

1847
		goto send_events;
1848
	}
L
Linus Torvalds 已提交
1849

1850
fetch_events:
1851 1852 1853 1854

	if (!ep_events_available(ep))
		ep_busy_loop(ep, timed_out);

1855 1856
	eavail = ep_events_available(ep);
	if (eavail)
1857
		goto send_events;
L
Linus Torvalds 已提交
1858

1859 1860 1861 1862 1863 1864
	/*
	 * Busy poll timed out.  Drop NAPI ID for now, we can add
	 * it back in when we have moved a socket with a valid NAPI
	 * ID onto the ready list.
	 */
	ep_reset_busy_poll_napi_id(ep);
1865

1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878
	do {
		/*
		 * Internally init_wait() uses autoremove_wake_function(),
		 * thus wait entry is removed from the wait queue on each
		 * wakeup. Why it is important? In case of several waiters
		 * each new wakeup will hit the next waiter, giving it the
		 * chance to harvest new event. Otherwise wakeup can be
		 * lost. This is also good performance-wise, because on
		 * normal wakeup path no need to call __remove_wait_queue()
		 * explicitly, thus ep->lock is not taken, which halts the
		 * event delivery.
		 */
		init_wait(&wait);
L
Linus Torvalds 已提交
1879

1880
		write_lock_irq(&ep->lock);
1881
		/*
1882 1883 1884
		 * Barrierless variant, waitqueue_active() is called under
		 * the same lock on wakeup ep_poll_callback() side, so it
		 * is safe to avoid an explicit barrier.
1885
		 */
1886 1887
		__set_current_state(TASK_INTERRUPTIBLE);

L
Linus Torvalds 已提交
1888
		/*
1889 1890 1891 1892 1893
		 * Do the final check under the lock. ep_scan_ready_list()
		 * plays with two lists (->rdllist and ->ovflist) and there
		 * is always a race when both lists are empty for short
		 * period of time although events are pending, so lock is
		 * important.
L
Linus Torvalds 已提交
1894
		 */
1895 1896 1897 1898 1899 1900
		eavail = ep_events_available(ep);
		if (!eavail) {
			if (signal_pending(current))
				res = -EINTR;
			else
				__add_wait_queue_exclusive(&ep->wq, &wait);
1901
		}
1902
		write_unlock_irq(&ep->lock);
1903

1904
		if (eavail || res)
1905
			break;
L
Linus Torvalds 已提交
1906

1907
		if (!schedule_hrtimeout_range(to, slack, HRTIMER_MODE_ABS)) {
1908
			timed_out = 1;
1909 1910
			break;
		}
1911 1912 1913 1914 1915

		/* We were woken up, thus go and try to harvest some events */
		eavail = 1;

	} while (0);
L
Linus Torvalds 已提交
1916

1917
	__set_current_state(TASK_RUNNING);
L
Linus Torvalds 已提交
1918

1919 1920 1921 1922 1923 1924
	if (!list_empty_careful(&wait.entry)) {
		write_lock_irq(&ep->lock);
		__remove_wait_queue(&ep->wq, &wait);
		write_unlock_irq(&ep->lock);
	}

1925
send_events:
1926 1927 1928 1929 1930 1931 1932 1933 1934
	if (fatal_signal_pending(current)) {
		/*
		 * Always short-circuit for fatal signals to allow
		 * threads to make a timely exit without the chance of
		 * finding more events available and fetching
		 * repeatedly.
		 */
		res = -EINTR;
	}
L
Linus Torvalds 已提交
1935 1936 1937 1938 1939 1940
	/*
	 * Try to transfer events to user space. In case we get 0 events and
	 * there's still timeout left over, we go trying again in search of
	 * more luck.
	 */
	if (!res && eavail &&
1941
	    !(res = ep_send_events(ep, events, maxevents)) && !timed_out)
1942
		goto fetch_events;
L
Linus Torvalds 已提交
1943 1944 1945 1946

	return res;
}

1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966
/**
 * ep_loop_check_proc - Callback function to be passed to the @ep_call_nested()
 *                      API, to verify that adding an epoll file inside another
 *                      epoll structure, does not violate the constraints, in
 *                      terms of closed loops, or too deep chains (which can
 *                      result in excessive stack usage).
 *
 * @priv: Pointer to the epoll file to be currently checked.
 * @cookie: Original cookie for this call. This is the top-of-the-chain epoll
 *          data structure pointer.
 * @call_nests: Current dept of the @ep_call_nested() call stack.
 *
 * Returns: Returns zero if adding the epoll @file inside current epoll
 *          structure @ep does not violate the constraints, or -1 otherwise.
 */
static int ep_loop_check_proc(void *priv, void *cookie, int call_nests)
{
	int error = 0;
	struct file *file = priv;
	struct eventpoll *ep = file->private_data;
J
Jason Baron 已提交
1967
	struct eventpoll *ep_tovisit;
1968 1969 1970
	struct rb_node *rbp;
	struct epitem *epi;

1971
	mutex_lock_nested(&ep->mtx, call_nests + 1);
1972
	ep->gen = loop_check_gen;
1973
	for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) {
1974 1975
		epi = rb_entry(rbp, struct epitem, rbn);
		if (unlikely(is_file_epoll(epi->ffd.file))) {
J
Jason Baron 已提交
1976
			ep_tovisit = epi->ffd.file->private_data;
1977
			if (ep_tovisit->gen == loop_check_gen)
J
Jason Baron 已提交
1978
				continue;
1979
			error = ep_call_nested(&poll_loop_ncalls,
J
Jason Baron 已提交
1980 1981
					ep_loop_check_proc, epi->ffd.file,
					ep_tovisit, current);
1982 1983
			if (error != 0)
				break;
J
Jason Baron 已提交
1984 1985 1986 1987 1988 1989 1990 1991 1992
		} else {
			/*
			 * If we've reached a file that is not associated with
			 * an ep, then we need to check if the newly added
			 * links are going to add too many wakeup paths. We do
			 * this by adding it to the tfile_check_list, if it's
			 * not already there, and calling reverse_path_check()
			 * during ep_insert().
			 */
1993
			if (list_empty(&epi->ffd.file->f_tfile_llink)) {
1994 1995 1996
				if (get_file_rcu(epi->ffd.file))
					list_add(&epi->ffd.file->f_tfile_llink,
						 &tfile_check_list);
1997
			}
1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017
		}
	}
	mutex_unlock(&ep->mtx);

	return error;
}

/**
 * ep_loop_check - Performs a check to verify that adding an epoll file (@file)
 *                 another epoll file (represented by @ep) does not create
 *                 closed loops or too deep chains.
 *
 * @ep: Pointer to the epoll private data structure.
 * @file: Pointer to the epoll file to be checked.
 *
 * Returns: Returns zero if adding the epoll @file inside current epoll
 *          structure @ep does not violate the constraints, or -1 otherwise.
 */
static int ep_loop_check(struct eventpoll *ep, struct file *file)
{
2018
	return ep_call_nested(&poll_loop_ncalls,
2019
			      ep_loop_check_proc, file, ep, current);
J
Jason Baron 已提交
2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030
}

static void clear_tfile_check_list(void)
{
	struct file *file;

	/* first clear the tfile_check_list */
	while (!list_empty(&tfile_check_list)) {
		file = list_first_entry(&tfile_check_list, struct file,
					f_tfile_llink);
		list_del_init(&file->f_tfile_llink);
2031
		fput(file);
J
Jason Baron 已提交
2032 2033
	}
	INIT_LIST_HEAD(&tfile_check_list);
2034 2035
}

2036
/*
2037
 * Open an eventpoll file descriptor.
2038
 */
2039
static int do_epoll_create(int flags)
2040
{
J
Jason Baron 已提交
2041
	int error, fd;
D
Davide Libenzi 已提交
2042
	struct eventpoll *ep = NULL;
J
Jason Baron 已提交
2043
	struct file *file;
2044

2045 2046 2047
	/* Check the EPOLL_* constant for consistency.  */
	BUILD_BUG_ON(EPOLL_CLOEXEC != O_CLOEXEC);

2048 2049
	if (flags & ~EPOLL_CLOEXEC)
		return -EINVAL;
2050
	/*
D
Davide Libenzi 已提交
2051
	 * Create the internal data structure ("struct eventpoll").
2052
	 */
2053
	error = ep_alloc(&ep);
D
Davide Libenzi 已提交
2054 2055
	if (error < 0)
		return error;
2056 2057
	/*
	 * Creates all the items needed to setup an eventpoll file. That is,
A
Al Viro 已提交
2058
	 * a file structure and a free file descriptor.
2059
	 */
J
Jason Baron 已提交
2060 2061 2062 2063 2064 2065
	fd = get_unused_fd_flags(O_RDWR | (flags & O_CLOEXEC));
	if (fd < 0) {
		error = fd;
		goto out_free_ep;
	}
	file = anon_inode_getfile("[eventpoll]", &eventpoll_fops, ep,
2066
				 O_RDWR | (flags & O_CLOEXEC));
J
Jason Baron 已提交
2067 2068 2069 2070 2071
	if (IS_ERR(file)) {
		error = PTR_ERR(file);
		goto out_free_fd;
	}
	ep->file = file;
2072
	fd_install(fd, file);
J
Jason Baron 已提交
2073 2074 2075 2076 2077 2078
	return fd;

out_free_fd:
	put_unused_fd(fd);
out_free_ep:
	ep_free(ep);
D
Davide Libenzi 已提交
2079
	return error;
2080 2081
}

2082 2083 2084 2085 2086
SYSCALL_DEFINE1(epoll_create1, int, flags)
{
	return do_epoll_create(flags);
}

2087
SYSCALL_DEFINE1(epoll_create, int, size)
U
Ulrich Drepper 已提交
2088
{
2089
	if (size <= 0)
2090 2091
		return -EINVAL;

2092
	return do_epoll_create(0);
U
Ulrich Drepper 已提交
2093 2094
}

2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108
static inline int epoll_mutex_lock(struct mutex *mutex, int depth,
				   bool nonblock)
{
	if (!nonblock) {
		mutex_lock_nested(mutex, depth);
		return 0;
	}
	if (mutex_trylock(mutex))
		return 0;
	return -EAGAIN;
}

int do_epoll_ctl(int epfd, int op, int fd, struct epoll_event *epds,
		 bool nonblock)
2109 2110
{
	int error;
2111
	int full_check = 0;
A
Al Viro 已提交
2112
	struct fd f, tf;
2113 2114
	struct eventpoll *ep;
	struct epitem *epi;
2115
	struct eventpoll *tep = NULL;
2116 2117

	error = -EBADF;
A
Al Viro 已提交
2118 2119
	f = fdget(epfd);
	if (!f.file)
2120 2121 2122
		goto error_return;

	/* Get the "struct file *" for the target file */
A
Al Viro 已提交
2123 2124
	tf = fdget(fd);
	if (!tf.file)
2125 2126 2127 2128
		goto error_fput;

	/* The target file descriptor must support poll */
	error = -EPERM;
2129
	if (!file_can_poll(tf.file))
2130 2131
		goto error_tgt_fput;

2132
	/* Check if EPOLLWAKEUP is allowed */
2133
	if (ep_op_has_event(op))
2134
		ep_take_care_of_epollwakeup(epds);
2135

2136 2137 2138 2139 2140 2141
	/*
	 * We have to check that the file structure underneath the file descriptor
	 * the user passed to us _is_ an eventpoll file. And also we do not permit
	 * adding an epoll file descriptor inside itself.
	 */
	error = -EINVAL;
A
Al Viro 已提交
2142
	if (f.file == tf.file || !is_file_epoll(f.file))
2143 2144
		goto error_tgt_fput;

J
Jason Baron 已提交
2145 2146 2147 2148 2149
	/*
	 * epoll adds to the wakeup queue at EPOLL_CTL_ADD time only,
	 * so EPOLLEXCLUSIVE is not allowed for a EPOLL_CTL_MOD operation.
	 * Also, we do not currently supported nested exclusive wakeups.
	 */
2150
	if (ep_op_has_event(op) && (epds->events & EPOLLEXCLUSIVE)) {
2151 2152 2153
		if (op == EPOLL_CTL_MOD)
			goto error_tgt_fput;
		if (op == EPOLL_CTL_ADD && (is_file_epoll(tf.file) ||
2154
				(epds->events & ~EPOLLEXCLUSIVE_OK_BITS)))
2155 2156
			goto error_tgt_fput;
	}
J
Jason Baron 已提交
2157

2158 2159 2160 2161
	/*
	 * At this point it is safe to assume that the "private_data" contains
	 * our own data structure.
	 */
A
Al Viro 已提交
2162
	ep = f.file->private_data;
2163

2164 2165 2166
	/*
	 * When we insert an epoll file descriptor, inside another epoll file
	 * descriptor, there is the change of creating closed loops, which are
J
Jason Baron 已提交
2167 2168 2169 2170
	 * better be handled here, than in more critical paths. While we are
	 * checking for loops we also determine the list of files reachable
	 * and hang them on the tfile_check_list, so we can check that we
	 * haven't created too many possible wakeup paths.
2171
	 *
2172 2173 2174 2175 2176 2177
	 * We do not need to take the global 'epumutex' on EPOLL_CTL_ADD when
	 * the epoll file descriptor is attaching directly to a wakeup source,
	 * unless the epoll file descriptor is nested. The purpose of taking the
	 * 'epmutex' on add is to prevent complex toplogies such as loops and
	 * deep wakeup paths from forming in parallel through multiple
	 * EPOLL_CTL_ADD operations.
2178
	 */
2179 2180 2181
	error = epoll_mutex_lock(&ep->mtx, 0, nonblock);
	if (error)
		goto error_tgt_fput;
J
Jason Baron 已提交
2182
	if (op == EPOLL_CTL_ADD) {
2183 2184 2185
		if (!list_empty(&f.file->f_ep_links) ||
						is_file_epoll(tf.file)) {
			mutex_unlock(&ep->mtx);
2186 2187 2188
			error = epoll_mutex_lock(&epmutex, 0, nonblock);
			if (error)
				goto error_tgt_fput;
2189
			loop_check_gen++;
2190
			full_check = 1;
2191 2192
			if (is_file_epoll(tf.file)) {
				error = -ELOOP;
2193
				if (ep_loop_check(ep, tf.file) != 0)
2194
					goto error_tgt_fput;
2195 2196
			} else {
				get_file(tf.file);
2197 2198
				list_add(&tf.file->f_tfile_llink,
							&tfile_check_list);
2199
			}
2200
			error = epoll_mutex_lock(&ep->mtx, 0, nonblock);
2201
			if (error)
2202
				goto error_tgt_fput;
2203 2204
			if (is_file_epoll(tf.file)) {
				tep = tf.file->private_data;
2205 2206 2207
				error = epoll_mutex_lock(&tep->mtx, 1, nonblock);
				if (error) {
					mutex_unlock(&ep->mtx);
2208
					goto error_tgt_fput;
2209
				}
2210
			}
2211 2212
		}
	}
2213

D
Davide Libenzi 已提交
2214 2215 2216 2217 2218
	/*
	 * Try to lookup the file inside our RB tree, Since we grabbed "mtx"
	 * above, we can be sure to be able to use the item looked up by
	 * ep_find() till we release the mutex.
	 */
A
Al Viro 已提交
2219
	epi = ep_find(ep, tf.file, fd);
2220 2221 2222 2223 2224

	error = -EINVAL;
	switch (op) {
	case EPOLL_CTL_ADD:
		if (!epi) {
2225 2226
			epds->events |= EPOLLERR | EPOLLHUP;
			error = ep_insert(ep, epds, tf.file, fd, full_check);
2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237
		} else
			error = -EEXIST;
		break;
	case EPOLL_CTL_DEL:
		if (epi)
			error = ep_remove(ep, epi);
		else
			error = -ENOENT;
		break;
	case EPOLL_CTL_MOD:
		if (epi) {
2238
			if (!(epi->event.events & EPOLLEXCLUSIVE)) {
2239 2240
				epds->events |= EPOLLERR | EPOLLHUP;
				error = ep_modify(ep, epi, epds);
2241
			}
2242 2243 2244 2245
		} else
			error = -ENOENT;
		break;
	}
2246 2247
	if (tep != NULL)
		mutex_unlock(&tep->mtx);
2248
	mutex_unlock(&ep->mtx);
2249 2250

error_tgt_fput:
2251 2252
	if (full_check) {
		clear_tfile_check_list();
2253
		loop_check_gen++;
2254
		mutex_unlock(&epmutex);
2255
	}
2256

A
Al Viro 已提交
2257
	fdput(tf);
2258
error_fput:
A
Al Viro 已提交
2259
	fdput(f);
2260 2261 2262 2263 2264
error_return:

	return error;
}

2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278
/*
 * The following function implements the controller interface for
 * the eventpoll file that enables the insertion/removal/change of
 * file descriptors inside the interest set.
 */
SYSCALL_DEFINE4(epoll_ctl, int, epfd, int, op, int, fd,
		struct epoll_event __user *, event)
{
	struct epoll_event epds;

	if (ep_op_has_event(op) &&
	    copy_from_user(&epds, event, sizeof(struct epoll_event)))
		return -EFAULT;

2279
	return do_epoll_ctl(epfd, op, fd, &epds, false);
2280 2281
}

2282 2283 2284 2285
/*
 * Implement the event wait interface for the eventpoll file. It is the kernel
 * part of the user space epoll_wait(2).
 */
2286 2287
static int do_epoll_wait(int epfd, struct epoll_event __user *events,
			 int maxevents, int timeout)
2288
{
2289 2290
	int error;
	struct fd f;
2291 2292 2293 2294 2295 2296 2297
	struct eventpoll *ep;

	/* The maximum number of event must be greater than zero */
	if (maxevents <= 0 || maxevents > EP_MAX_EVENTS)
		return -EINVAL;

	/* Verify that the area passed by the user is writeable */
2298
	if (!access_ok(events, maxevents * sizeof(struct epoll_event)))
2299
		return -EFAULT;
2300 2301

	/* Get the "struct file *" for the eventpoll file */
2302 2303 2304
	f = fdget(epfd);
	if (!f.file)
		return -EBADF;
2305 2306 2307 2308 2309 2310

	/*
	 * We have to check that the file structure underneath the fd
	 * the user passed to us _is_ an eventpoll file.
	 */
	error = -EINVAL;
2311
	if (!is_file_epoll(f.file))
2312 2313 2314 2315 2316 2317
		goto error_fput;

	/*
	 * At this point it is safe to assume that the "private_data" contains
	 * our own data structure.
	 */
2318
	ep = f.file->private_data;
2319 2320 2321 2322 2323

	/* Time to fish for events ... */
	error = ep_poll(ep, events, maxevents, timeout);

error_fput:
2324
	fdput(f);
2325 2326 2327
	return error;
}

2328 2329 2330 2331 2332 2333
SYSCALL_DEFINE4(epoll_wait, int, epfd, struct epoll_event __user *, events,
		int, maxevents, int, timeout)
{
	return do_epoll_wait(epfd, events, maxevents, timeout);
}

2334 2335 2336 2337
/*
 * Implement the event wait interface for the eventpoll file. It is the kernel
 * part of the user space epoll_pwait(2).
 */
2338 2339 2340
SYSCALL_DEFINE6(epoll_pwait, int, epfd, struct epoll_event __user *, events,
		int, maxevents, int, timeout, const sigset_t __user *, sigmask,
		size_t, sigsetsize)
2341 2342 2343 2344 2345 2346 2347
{
	int error;

	/*
	 * If the caller wants a certain signal mask to be set during the wait,
	 * we apply it here.
	 */
2348
	error = set_user_sigmask(sigmask, sigsetsize);
D
Deepa Dinamani 已提交
2349 2350
	if (error)
		return error;
2351

2352
	error = do_epoll_wait(epfd, events, maxevents, timeout);
2353
	restore_saved_sigmask_unless(error == -EINTR);
2354 2355 2356 2357

	return error;
}

2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370
#ifdef CONFIG_COMPAT
COMPAT_SYSCALL_DEFINE6(epoll_pwait, int, epfd,
			struct epoll_event __user *, events,
			int, maxevents, int, timeout,
			const compat_sigset_t __user *, sigmask,
			compat_size_t, sigsetsize)
{
	long err;

	/*
	 * If the caller wants a certain signal mask to be set during the wait,
	 * we apply it here.
	 */
2371
	err = set_compat_user_sigmask(sigmask, sigsetsize);
D
Deepa Dinamani 已提交
2372 2373
	if (err)
		return err;
2374

2375
	err = do_epoll_wait(epfd, events, maxevents, timeout);
2376
	restore_saved_sigmask_unless(err == -EINTR);
2377 2378 2379 2380 2381

	return err;
}
#endif

L
Linus Torvalds 已提交
2382 2383
static int __init eventpoll_init(void)
{
2384 2385 2386
	struct sysinfo si;

	si_meminfo(&si);
2387 2388 2389 2390
	/*
	 * Allows top 4% of lomem to be allocated for epoll watches (per user).
	 */
	max_user_watches = (((si.totalram - si.totalhigh) / 25) << PAGE_SHIFT) /
2391
		EP_ITEM_COST;
2392
	BUG_ON(max_user_watches < 0);
L
Linus Torvalds 已提交
2393

2394 2395 2396 2397 2398 2399
	/*
	 * Initialize the structure used to perform epoll file descriptor
	 * inclusion loops checks.
	 */
	ep_nested_calls_init(&poll_loop_ncalls);

E
Eric Wong 已提交
2400 2401 2402 2403 2404 2405
	/*
	 * We can have many thousands of epitems, so prevent this from
	 * using an extra cache line on 64-bit (and smaller) CPUs
	 */
	BUILD_BUG_ON(sizeof(void *) <= 8 && sizeof(struct epitem) > 128);

L
Linus Torvalds 已提交
2406 2407
	/* Allocates slab cache used to allocate "struct epitem" items */
	epi_cache = kmem_cache_create("eventpoll_epi", sizeof(struct epitem),
2408
			0, SLAB_HWCACHE_ALIGN|SLAB_PANIC|SLAB_ACCOUNT, NULL);
L
Linus Torvalds 已提交
2409 2410 2411

	/* Allocates slab cache used to allocate "struct eppoll_entry" */
	pwq_cache = kmem_cache_create("eventpoll_pwq",
2412
		sizeof(struct eppoll_entry), 0, SLAB_PANIC|SLAB_ACCOUNT, NULL);
L
Linus Torvalds 已提交
2413 2414 2415

	return 0;
}
D
Davide Libenzi 已提交
2416
fs_initcall(eventpoll_init);