eventpoll.c 44.5 KB
Newer Older
L
Linus Torvalds 已提交
1
/*
D
Davide Libenzi 已提交
2 3
 *  fs/eventpoll.c (Efficient event retrieval implementation)
 *  Copyright (C) 2001,...,2009	 Davide Libenzi
L
Linus Torvalds 已提交
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  Davide Libenzi <davidel@xmailserver.org>
 *
 */

#include <linux/init.h>
#include <linux/kernel.h>
#include <linux/sched.h>
#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 已提交
34
#include <linux/mutex.h>
D
Davide Libenzi 已提交
35
#include <linux/anon_inodes.h>
L
Linus Torvalds 已提交
36 37 38 39
#include <asm/uaccess.h>
#include <asm/system.h>
#include <asm/io.h>
#include <asm/mman.h>
A
Arun Sharma 已提交
40
#include <linux/atomic.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 48
 * 2) ep->mtx (mutex)
 * 3) ep->lock (spinlock)
L
Linus Torvalds 已提交
49 50 51 52 53 54 55 56 57
 *
 * The acquire order is the one listed above, from 1 to 3.
 * We need a spinlock (ep->lock) because we manipulate objects
 * 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 83 84
 * It is possible to drop the "ep->mtx" and to use the global
 * mutex "epmutex" (together with "ep->lock") to have it working,
 * 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 91 92
 */

/* Epoll private bits inside the event mask */
#define EP_PRIVATE_BITS (EPOLLONESHOT | EPOLLET)

D
Davide Libenzi 已提交
93 94
/* Maximum number of nesting allowed inside epoll sets */
#define EP_MAX_NESTS 4
L
Linus Torvalds 已提交
95

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

98 99
#define EP_UNACTIVE_PTR ((void *) -1L)

100 101
#define EP_ITEM_COST (sizeof(struct epitem) + sizeof(struct eppoll_entry))

L
Linus Torvalds 已提交
102 103 104 105 106 107
struct epoll_filefd {
	struct file *file;
	int fd;
};

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

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

126 127 128 129 130
/*
 * Each file descriptor added to the eventpoll interface will
 * have an entry of this type linked to the "rbr" RB tree.
 */
struct epitem {
D
Davide Libenzi 已提交
131
	/* RB tree node used to link this structure to the eventpoll RB tree */
132 133 134 135 136
	struct rb_node rbn;

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

137 138 139 140 141 142
	/*
	 * Works together "struct eventpoll"->ovflist in keeping the
	 * single linked chain of items.
	 */
	struct epitem *next;

143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
	/* 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;

158 159
	/* The structure that describe the interested events and the source fd */
	struct epoll_event event;
160 161
};

L
Linus Torvalds 已提交
162 163
/*
 * This structure is stored inside the "private_data" member of the file
D
Daniel Baluta 已提交
164
 * structure and represents the main data structure for the eventpoll
L
Linus Torvalds 已提交
165 166 167
 * interface.
 */
struct eventpoll {
D
Daniel Baluta 已提交
168
	/* Protect the access to this structure */
169
	spinlock_t lock;
L
Linus Torvalds 已提交
170 171

	/*
172 173 174 175
	 * 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 已提交
176
	 */
177
	struct mutex mtx;
L
Linus Torvalds 已提交
178 179 180 181 182 183 184 185 186 187

	/* 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;

D
Davide Libenzi 已提交
188
	/* RB tree root used to store monitored fd structs */
L
Linus Torvalds 已提交
189
	struct rb_root rbr;
190 191 192

	/*
	 * This is a single linked list that chains all the "struct epitem" that
L
Lucas De Marchi 已提交
193
	 * happened while transferring ready events to userspace w/out
194 195 196
	 * holding ->lock.
	 */
	struct epitem *ovflist;
197 198 199

	/* The user that created the eventpoll descriptor */
	struct user_struct *user;
L
Linus Torvalds 已提交
200 201 202 203 204 205 206 207
};

/* 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" */
208
	struct epitem *base;
L
Linus Torvalds 已提交
209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225

	/*
	 * Wait queue item that will be linked to the target file wait
	 * queue head.
	 */
	wait_queue_t wait;

	/* 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 已提交
226 227 228 229 230 231
/* Used by the ep_send_events() function as callback private data */
struct ep_send_events_data {
	int maxevents;
	struct epoll_event __user *events;
};

232 233 234 235
/*
 * Configuration options available inside /proc/sys/fs/epoll/
 */
/* Maximum number of epoll watched descriptors, per user */
236
static long max_user_watches __read_mostly;
237

L
Linus Torvalds 已提交
238
/*
239
 * This mutex is used to serialize ep_free() and eventpoll_release_file().
L
Linus Torvalds 已提交
240
 */
241
static DEFINE_MUTEX(epmutex);
L
Linus Torvalds 已提交
242

243 244 245
/* Used to check for epoll file descriptor inclusion loops */
static struct nested_calls poll_loop_ncalls;

D
Davide Libenzi 已提交
246 247 248 249 250
/* Used for safe wake up implementation */
static struct nested_calls poll_safewake_ncalls;

/* Used to call file's f_op->poll() under the nested calls boundaries */
static struct nested_calls poll_readywalk_ncalls;
L
Linus Torvalds 已提交
251 252

/* Slab cache used to allocate "struct epitem" */
253
static struct kmem_cache *epi_cache __read_mostly;
L
Linus Torvalds 已提交
254 255

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

258 259 260 261
#ifdef CONFIG_SYSCTL

#include <linux/sysctl.h>

262 263
static long zero;
static long long_max = LONG_MAX;
264 265 266 267 268

ctl_table epoll_table[] = {
	{
		.procname	= "max_user_watches",
		.data		= &max_user_watches,
269
		.maxlen		= sizeof(max_user_watches),
270
		.mode		= 0644,
271
		.proc_handler	= proc_doulongvec_minmax,
272
		.extra1		= &zero,
273
		.extra2		= &long_max,
274
	},
275
	{ }
276 277 278
};
#endif /* CONFIG_SYSCTL */

279

D
Davide Libenzi 已提交
280
/* Setup the structure that is used as key for the RB tree */
281 282 283 284 285 286 287
static inline void ep_set_ffd(struct epoll_filefd *ffd,
			      struct file *file, int fd)
{
	ffd->file = file;
	ffd->fd = fd;
}

D
Davide Libenzi 已提交
288
/* Compare RB tree keys */
289 290 291 292 293 294 295 296 297 298 299 300 301 302
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 */
static inline int ep_is_linked(struct list_head *p)
{
	return !list_empty(p);
}

/* Get the "struct epitem" from a wait queue pointer */
D
Davide Libenzi 已提交
303
static inline struct epitem *ep_item_from_wait(wait_queue_t *p)
304 305 306 307 308
{
	return container_of(p, struct eppoll_entry, wait)->base;
}

/* Get the "struct epitem" from an epoll queue wrapper */
D
Davide Libenzi 已提交
309
static inline struct epitem *ep_item_from_epqueue(poll_table *p)
310 311 312 313 314
{
	return container_of(p, struct ep_pqueue, pt)->epi;
}

/* Tells if the epoll_ctl(2) operation needs an event copy from userspace */
315
static inline int ep_op_has_event(int op)
316 317 318 319
{
	return op != EPOLL_CTL_DEL;
}

L
Linus Torvalds 已提交
320
/* Initialize the poll safe wake up structure */
D
Davide Libenzi 已提交
321
static void ep_nested_calls_init(struct nested_calls *ncalls)
L
Linus Torvalds 已提交
322
{
D
Davide Libenzi 已提交
323 324
	INIT_LIST_HEAD(&ncalls->tasks_call_list);
	spin_lock_init(&ncalls->lock);
L
Linus Torvalds 已提交
325 326
}

327 328 329 330 331 332 333 334 335 336 337 338 339
/**
 * 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)
{
	return !list_empty(&ep->rdllist) || ep->ovflist != EP_UNACTIVE_PTR;
}

D
Davide Libenzi 已提交
340 341 342 343 344 345 346 347 348 349 350
/**
 * 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.
 * @max_nests: Maximum number of allowed nesting calls.
 * @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 已提交
351
 * @ctx: This instance context.
D
Davide Libenzi 已提交
352 353 354
 *
 * Returns: Returns the code returned by the @nproc callback, or -1 if
 *          the maximum recursion limit has been exceeded.
L
Linus Torvalds 已提交
355
 */
D
Davide Libenzi 已提交
356 357
static int ep_call_nested(struct nested_calls *ncalls, int max_nests,
			  int (*nproc)(void *, void *, int), void *priv,
D
Davide Libenzi 已提交
358
			  void *cookie, void *ctx)
L
Linus Torvalds 已提交
359
{
D
Davide Libenzi 已提交
360
	int error, call_nests = 0;
L
Linus Torvalds 已提交
361
	unsigned long flags;
D
Davide Libenzi 已提交
362 363 364
	struct list_head *lsthead = &ncalls->tasks_call_list;
	struct nested_call_node *tncur;
	struct nested_call_node tnode;
L
Linus Torvalds 已提交
365

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

D
Davide Libenzi 已提交
368 369 370 371 372
	/*
	 * 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.
	 */
373
	list_for_each_entry(tncur, lsthead, llink) {
D
Davide Libenzi 已提交
374
		if (tncur->ctx == ctx &&
D
Davide Libenzi 已提交
375
		    (tncur->cookie == cookie || ++call_nests > max_nests)) {
L
Linus Torvalds 已提交
376 377 378 379
			/*
			 * Ops ... loop detected or maximum nest level reached.
			 * We abort this wake by breaking the cycle itself.
			 */
380 381
			error = -1;
			goto out_unlock;
L
Linus Torvalds 已提交
382 383 384
		}
	}

D
Davide Libenzi 已提交
385
	/* Add the current task and cookie to the list */
D
Davide Libenzi 已提交
386
	tnode.ctx = ctx;
D
Davide Libenzi 已提交
387
	tnode.cookie = cookie;
L
Linus Torvalds 已提交
388 389
	list_add(&tnode.llink, lsthead);

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

D
Davide Libenzi 已提交
392 393
	/* Call the nested function */
	error = (*nproc)(priv, cookie, call_nests);
L
Linus Torvalds 已提交
394 395

	/* Remove the current task from the list */
D
Davide Libenzi 已提交
396
	spin_lock_irqsave(&ncalls->lock, flags);
L
Linus Torvalds 已提交
397
	list_del(&tnode.llink);
D
Davide Libenzi 已提交
398
out_unlock:
D
Davide Libenzi 已提交
399 400 401 402 403
	spin_unlock_irqrestore(&ncalls->lock, flags);

	return error;
}

404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421
#ifdef CONFIG_DEBUG_LOCK_ALLOC
static inline void ep_wake_up_nested(wait_queue_head_t *wqueue,
				     unsigned long events, int subclass)
{
	unsigned long flags;

	spin_lock_irqsave_nested(&wqueue->lock, flags, subclass);
	wake_up_locked_poll(wqueue, events);
	spin_unlock_irqrestore(&wqueue->lock, flags);
}
#else
static inline void ep_wake_up_nested(wait_queue_head_t *wqueue,
				     unsigned long events, int subclass)
{
	wake_up_poll(wqueue, events);
}
#endif

D
Davide Libenzi 已提交
422 423
static int ep_poll_wakeup_proc(void *priv, void *cookie, int call_nests)
{
424 425
	ep_wake_up_nested((wait_queue_head_t *) cookie, POLLIN,
			  1 + call_nests);
D
Davide Libenzi 已提交
426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
	return 0;
}

/*
 * Perform a safe wake up of the poll wait list. The problem is that
 * with the new callback'd wake up system, it is possible that the
 * poll callback is reentered from inside the call to wake_up() done
 * on the poll wait queue head. The rule is that we cannot reenter the
 * wake up code from the same task more than EP_MAX_NESTS times,
 * and we cannot reenter the same wait queue head at all. This will
 * enable to have a hierarchy of epoll file descriptor of no more than
 * EP_MAX_NESTS deep.
 */
static void ep_poll_safewake(wait_queue_head_t *wq)
{
D
Davide Libenzi 已提交
441 442
	int this_cpu = get_cpu();

D
Davide Libenzi 已提交
443
	ep_call_nested(&poll_safewake_ncalls, EP_MAX_NESTS,
D
Davide Libenzi 已提交
444 445 446
		       ep_poll_wakeup_proc, NULL, wq, (void *) (long) this_cpu);

	put_cpu();
L
Linus Torvalds 已提交
447 448 449
}

/*
T
Tony Battersby 已提交
450 451 452
 * 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 已提交
453
 */
454
static void ep_unregister_pollwait(struct eventpoll *ep, struct epitem *epi)
L
Linus Torvalds 已提交
455
{
456 457
	struct list_head *lsthead = &epi->pwqlist;
	struct eppoll_entry *pwq;
L
Linus Torvalds 已提交
458

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

T
Tony Battersby 已提交
462 463 464
		list_del(&pwq->llink);
		remove_wait_queue(pwq->whead, &pwq->wait);
		kmem_cache_free(pwq_cache, pwq);
L
Linus Torvalds 已提交
465 466 467
	}
}

D
Davide Libenzi 已提交
468 469 470 471 472 473 474 475
/**
 * 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.
476
 * @depth: The current depth of recursive f_op->poll calls.
D
Davide Libenzi 已提交
477 478 479 480 481 482
 *
 * Returns: The same integer error code returned by the @sproc callback.
 */
static int ep_scan_ready_list(struct eventpoll *ep,
			      int (*sproc)(struct eventpoll *,
					   struct list_head *, void *),
483 484
			      void *priv,
			      int depth)
D
Davide Libenzi 已提交
485 486 487 488
{
	int error, pwake = 0;
	unsigned long flags;
	struct epitem *epi, *nepi;
489
	LIST_HEAD(txlist);
D
Davide Libenzi 已提交
490 491 492

	/*
	 * We need to lock this because we could be hit by
T
Tony Battersby 已提交
493
	 * eventpoll_release_file() and epoll_ctl().
D
Davide Libenzi 已提交
494
	 */
495
	mutex_lock_nested(&ep->mtx, depth);
D
Davide Libenzi 已提交
496 497 498 499 500 501 502 503 504 505

	/*
	 * 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.
	 */
	spin_lock_irqsave(&ep->lock, flags);
506
	list_splice_init(&ep->rdllist, &txlist);
D
Davide Libenzi 已提交
507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545
	ep->ovflist = NULL;
	spin_unlock_irqrestore(&ep->lock, flags);

	/*
	 * Now call the callback function.
	 */
	error = (*sproc)(ep, &txlist, priv);

	spin_lock_irqsave(&ep->lock, flags);
	/*
	 * 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.
	 */
	for (nepi = ep->ovflist; (epi = nepi) != NULL;
	     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.
		 */
		if (!ep_is_linked(&epi->rdllink))
			list_add_tail(&epi->rdllink, &ep->rdllist);
	}
	/*
	 * 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.
	 */
	ep->ovflist = EP_UNACTIVE_PTR;

	/*
	 * Quickly re-inject items left on "txlist".
	 */
	list_splice(&txlist, &ep->rdllist);

	if (!list_empty(&ep->rdllist)) {
		/*
546 547
		 * Wake up (if active) both the eventpoll wait list and
		 * the ->poll() wait list (delayed after we release the lock).
D
Davide Libenzi 已提交
548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564
		 */
		if (waitqueue_active(&ep->wq))
			wake_up_locked(&ep->wq);
		if (waitqueue_active(&ep->poll_wait))
			pwake++;
	}
	spin_unlock_irqrestore(&ep->lock, flags);

	mutex_unlock(&ep->mtx);

	/* We have to call this outside the lock */
	if (pwake)
		ep_poll_safewake(&ep->poll_wait);

	return error;
}

565 566
/*
 * Removes a "struct epitem" from the eventpoll RB tree and deallocates
567
 * all the associated resources. Must be called with "mtx" held.
568 569 570 571 572
 */
static int ep_remove(struct eventpoll *ep, struct epitem *epi)
{
	unsigned long flags;
	struct file *file = epi->ffd.file;
L
Linus Torvalds 已提交
573 574

	/*
575 576 577 578 579 580
	 * Removes poll wait queue hooks. We _have_ to do this without holding
	 * the "ep->lock" otherwise a deadlock might occur. This because of the
	 * sequence of the lock acquisition. Here we do "ep->lock" then the wait
	 * queue head lock when unregistering the wait queue. The wakeup callback
	 * will run by holding the wait queue head lock and will call our callback
	 * that will try to get "ep->lock".
L
Linus Torvalds 已提交
581
	 */
582
	ep_unregister_pollwait(ep, epi);
L
Linus Torvalds 已提交
583

584
	/* Remove the current item from the list of epoll hooks */
J
Jonathan Corbet 已提交
585
	spin_lock(&file->f_lock);
586 587
	if (ep_is_linked(&epi->fllink))
		list_del_init(&epi->fllink);
J
Jonathan Corbet 已提交
588
	spin_unlock(&file->f_lock);
L
Linus Torvalds 已提交
589

D
Davide Libenzi 已提交
590
	rb_erase(&epi->rbn, &ep->rbr);
L
Linus Torvalds 已提交
591

592 593 594 595
	spin_lock_irqsave(&ep->lock, flags);
	if (ep_is_linked(&epi->rdllink))
		list_del_init(&epi->rdllink);
	spin_unlock_irqrestore(&ep->lock, flags);
L
Linus Torvalds 已提交
596

597
	/* At this point it is safe to free the eventpoll item */
598
	kmem_cache_free(epi_cache, epi);
L
Linus Torvalds 已提交
599

600
	atomic_long_dec(&ep->user->epoll_watches);
601

602
	return 0;
L
Linus Torvalds 已提交
603 604
}

605
static void ep_free(struct eventpoll *ep)
L
Linus Torvalds 已提交
606
{
607 608
	struct rb_node *rbp;
	struct epitem *epi;
L
Linus Torvalds 已提交
609

610 611
	/* We need to release all tasks waiting for these file */
	if (waitqueue_active(&ep->poll_wait))
D
Davide Libenzi 已提交
612
		ep_poll_safewake(&ep->poll_wait);
L
Linus Torvalds 已提交
613

614 615 616
	/*
	 * We need to lock this because we could be hit by
	 * eventpoll_release_file() while we're freeing the "struct eventpoll".
617
	 * We do not need to hold "ep->mtx" here because the epoll file
618 619
	 * 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 已提交
620
	 * holding "epmutex" is sufficient here.
621 622
	 */
	mutex_lock(&epmutex);
L
Linus Torvalds 已提交
623 624

	/*
625
	 * Walks through the whole tree by unregistering poll callbacks.
L
Linus Torvalds 已提交
626
	 */
627 628 629 630 631
	for (rbp = rb_first(&ep->rbr); rbp; rbp = rb_next(rbp)) {
		epi = rb_entry(rbp, struct epitem, rbn);

		ep_unregister_pollwait(ep, epi);
	}
L
Linus Torvalds 已提交
632 633

	/*
634 635
	 * 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
636
	 * holding "epmutex" we can be sure that no file cleanup code will hit
637
	 * us during this operation. So we can avoid the lock on "ep->lock".
L
Linus Torvalds 已提交
638
	 */
639
	while ((rbp = rb_first(&ep->rbr)) != NULL) {
640 641 642
		epi = rb_entry(rbp, struct epitem, rbn);
		ep_remove(ep, epi);
	}
L
Linus Torvalds 已提交
643

644
	mutex_unlock(&epmutex);
645
	mutex_destroy(&ep->mtx);
646
	free_uid(ep->user);
647
	kfree(ep);
648
}
L
Linus Torvalds 已提交
649

650 651 652
static int ep_eventpoll_release(struct inode *inode, struct file *file)
{
	struct eventpoll *ep = file->private_data;
L
Linus Torvalds 已提交
653

654
	if (ep)
655 656 657
		ep_free(ep);

	return 0;
L
Linus Torvalds 已提交
658 659
}

660 661
static int ep_read_events_proc(struct eventpoll *ep, struct list_head *head,
			       void *priv)
D
Davide Libenzi 已提交
662 663 664 665 666 667 668
{
	struct epitem *epi, *tmp;

	list_for_each_entry_safe(epi, tmp, head, rdllink) {
		if (epi->ffd.file->f_op->poll(epi->ffd.file, NULL) &
		    epi->event.events)
			return POLLIN | POLLRDNORM;
669
		else {
D
Davide Libenzi 已提交
670 671 672 673 674 675
			/*
			 * 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.
			 */
			list_del_init(&epi->rdllink);
676
		}
D
Davide Libenzi 已提交
677 678 679 680 681 682 683
	}

	return 0;
}

static int ep_poll_readyevents_proc(void *priv, void *cookie, int call_nests)
{
684
	return ep_scan_ready_list(priv, ep_read_events_proc, NULL, call_nests + 1);
D
Davide Libenzi 已提交
685 686
}

687 688
static unsigned int ep_eventpoll_poll(struct file *file, poll_table *wait)
{
D
Davide Libenzi 已提交
689
	int pollflags;
690
	struct eventpoll *ep = file->private_data;
L
Linus Torvalds 已提交
691

692 693 694
	/* Insert inside our poll wait queue */
	poll_wait(file, &ep->poll_wait, wait);

D
Davide Libenzi 已提交
695 696 697 698 699 700 701
	/*
	 * Proceed to find out if wanted events are really available inside
	 * the ready list. This need to be done under ep_call_nested()
	 * supervision, since the call to f_op->poll() done on listed files
	 * could re-enter here.
	 */
	pollflags = ep_call_nested(&poll_readywalk_ncalls, EP_MAX_NESTS,
D
Davide Libenzi 已提交
702
				   ep_poll_readyevents_proc, ep, ep, current);
703

704
	return pollflags != -1 ? pollflags : 0;
705 706 707 708 709
}

/* File callbacks that implement the eventpoll file behaviour */
static const struct file_operations eventpoll_fops = {
	.release	= ep_eventpoll_release,
710 711
	.poll		= ep_eventpoll_poll,
	.llseek		= noop_llseek,
712 713
};

714
/* Fast test to see if the file is an eventpoll file */
715 716 717 718
static inline int is_file_epoll(struct file *f)
{
	return f->f_op == &eventpoll_fops;
}
D
Davide Libenzi 已提交
719 720

/*
721 722 723
 * 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 已提交
724
 */
725
void eventpoll_release_file(struct file *file)
D
Davide Libenzi 已提交
726
{
727 728 729
	struct list_head *lsthead = &file->f_ep_links;
	struct eventpoll *ep;
	struct epitem *epi;
D
Davide Libenzi 已提交
730 731

	/*
J
Jonathan Corbet 已提交
732
	 * We don't want to get "file->f_lock" because it is not
733
	 * necessary. It is not necessary because we're in the "struct file"
L
Lucas De Marchi 已提交
734
	 * cleanup path, and this means that no one is using this file anymore.
D
Davide Libenzi 已提交
735
	 * So, for example, epoll_ctl() cannot hit here since if we reach this
D
Davide Libenzi 已提交
736
	 * point, the file counter already went to zero and fget() would fail.
737
	 * The only hit might come from ep_free() but by holding the mutex
738
	 * will correctly serialize the operation. We do need to acquire
739
	 * "ep->mtx" after "epmutex" because ep_remove() requires it when called
740
	 * from anywhere but ep_free().
J
Jonathan Corbet 已提交
741 742
	 *
	 * Besides, ep_remove() acquires the lock, so we can't hold it here.
D
Davide Libenzi 已提交
743
	 */
744
	mutex_lock(&epmutex);
D
Davide Libenzi 已提交
745

746 747
	while (!list_empty(lsthead)) {
		epi = list_first_entry(lsthead, struct epitem, fllink);
D
Davide Libenzi 已提交
748

749 750
		ep = epi->ep;
		list_del_init(&epi->fllink);
751
		mutex_lock_nested(&ep->mtx, 0);
752
		ep_remove(ep, epi);
753
		mutex_unlock(&ep->mtx);
D
Davide Libenzi 已提交
754 755
	}

756
	mutex_unlock(&epmutex);
D
Davide Libenzi 已提交
757 758
}

759
static int ep_alloc(struct eventpoll **pep)
L
Linus Torvalds 已提交
760
{
761 762 763
	int error;
	struct user_struct *user;
	struct eventpoll *ep;
L
Linus Torvalds 已提交
764

765 766 767 768 769
	user = get_current_user();
	error = -ENOMEM;
	ep = kzalloc(sizeof(*ep), GFP_KERNEL);
	if (unlikely(!ep))
		goto free_uid;
L
Linus Torvalds 已提交
770

771
	spin_lock_init(&ep->lock);
772
	mutex_init(&ep->mtx);
L
Linus Torvalds 已提交
773 774 775 776
	init_waitqueue_head(&ep->wq);
	init_waitqueue_head(&ep->poll_wait);
	INIT_LIST_HEAD(&ep->rdllist);
	ep->rbr = RB_ROOT;
777
	ep->ovflist = EP_UNACTIVE_PTR;
778
	ep->user = user;
L
Linus Torvalds 已提交
779

780
	*pep = ep;
L
Linus Torvalds 已提交
781 782

	return 0;
783 784 785 786

free_uid:
	free_uid(user);
	return error;
L
Linus Torvalds 已提交
787 788 789
}

/*
790 791 792
 * 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 已提交
793 794 795 796 797 798 799 800
 */
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;

801
	ep_set_ffd(&ffd, file, fd);
L
Linus Torvalds 已提交
802 803
	for (rbp = ep->rbr.rb_node; rbp; ) {
		epi = rb_entry(rbp, struct epitem, rbn);
804
		kcmp = ep_cmp_ffd(&ffd, &epi->ffd);
L
Linus Torvalds 已提交
805 806 807 808 809 810 811 812 813 814 815 816 817 818
		if (kcmp > 0)
			rbp = rbp->rb_right;
		else if (kcmp < 0)
			rbp = rbp->rb_left;
		else {
			epir = epi;
			break;
		}
	}

	return epir;
}

/*
819
 * This is the callback that is passed to the wait queue wakeup
D
Daniel Baluta 已提交
820
 * mechanism. It is called by the stored file descriptors when they
821
 * have events to report.
L
Linus Torvalds 已提交
822
 */
823
static int ep_poll_callback(wait_queue_t *wait, unsigned mode, int sync, void *key)
L
Linus Torvalds 已提交
824
{
825 826 827 828
	int pwake = 0;
	unsigned long flags;
	struct epitem *epi = ep_item_from_wait(wait);
	struct eventpoll *ep = epi->ep;
L
Linus Torvalds 已提交
829

830
	spin_lock_irqsave(&ep->lock, flags);
L
Linus Torvalds 已提交
831

832 833 834 835 836 837 838
	/*
	 * 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))
839 840
		goto out_unlock;

841 842 843 844 845 846 847 848 849
	/*
	 * 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.
	 */
	if (key && !((unsigned long) key & epi->event.events))
		goto out_unlock;

850
	/*
D
Daniel Baluta 已提交
851
	 * If we are transferring events to userspace, we can hold no locks
852
	 * (because we're accessing user memory, and because of linux f_op->poll()
D
Daniel Baluta 已提交
853
	 * semantics). All the events that happen during that period of time are
854 855 856 857 858 859 860 861 862
	 * chained in ep->ovflist and requeued later on.
	 */
	if (unlikely(ep->ovflist != EP_UNACTIVE_PTR)) {
		if (epi->next == EP_UNACTIVE_PTR) {
			epi->next = ep->ovflist;
			ep->ovflist = epi;
		}
		goto out_unlock;
	}
L
Linus Torvalds 已提交
863

864
	/* If this file is already in the ready list we exit soon */
D
Davide Libenzi 已提交
865 866
	if (!ep_is_linked(&epi->rdllink))
		list_add_tail(&epi->rdllink, &ep->rdllist);
867 868 869 870 871 872

	/*
	 * Wake up ( if active ) both the eventpoll wait list and the ->poll()
	 * wait list.
	 */
	if (waitqueue_active(&ep->wq))
M
Matthew Wilcox 已提交
873
		wake_up_locked(&ep->wq);
874 875 876
	if (waitqueue_active(&ep->poll_wait))
		pwake++;

877
out_unlock:
878
	spin_unlock_irqrestore(&ep->lock, flags);
L
Linus Torvalds 已提交
879

880 881
	/* We have to call this outside the lock */
	if (pwake)
D
Davide Libenzi 已提交
882
		ep_poll_safewake(&ep->poll_wait);
883 884 885

	return 1;
}
L
Linus Torvalds 已提交
886 887 888 889 890 891 892 893

/*
 * 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)
{
894
	struct epitem *epi = ep_item_from_epqueue(pt);
L
Linus Torvalds 已提交
895 896
	struct eppoll_entry *pwq;

897
	if (epi->nwait >= 0 && (pwq = kmem_cache_alloc(pwq_cache, GFP_KERNEL))) {
L
Linus Torvalds 已提交
898 899 900 901 902 903
		init_waitqueue_func_entry(&pwq->wait, ep_poll_callback);
		pwq->whead = whead;
		pwq->base = epi;
		add_wait_queue(whead, &pwq->wait);
		list_add_tail(&pwq->llink, &epi->pwqlist);
		epi->nwait++;
904
	} else {
L
Linus Torvalds 已提交
905 906
		/* We have to signal that an error occurred */
		epi->nwait = -1;
907
	}
L
Linus Torvalds 已提交
908 909 910 911 912 913 914 915 916 917 918
}

static void ep_rbtree_insert(struct eventpoll *ep, struct epitem *epi)
{
	int kcmp;
	struct rb_node **p = &ep->rbr.rb_node, *parent = NULL;
	struct epitem *epic;

	while (*p) {
		parent = *p;
		epic = rb_entry(parent, struct epitem, rbn);
919
		kcmp = ep_cmp_ffd(&epi->ffd, &epic->ffd);
L
Linus Torvalds 已提交
920 921 922 923 924 925 926 927 928
		if (kcmp > 0)
			p = &parent->rb_right;
		else
			p = &parent->rb_left;
	}
	rb_link_node(&epi->rbn, parent, p);
	rb_insert_color(&epi->rbn, &ep->rbr);
}

929 930 931
/*
 * Must be called with "mtx" held.
 */
L
Linus Torvalds 已提交
932 933 934 935 936
static int ep_insert(struct eventpoll *ep, struct epoll_event *event,
		     struct file *tfile, int fd)
{
	int error, revents, pwake = 0;
	unsigned long flags;
937
	long user_watches;
L
Linus Torvalds 已提交
938 939 940
	struct epitem *epi;
	struct ep_pqueue epq;

941 942
	user_watches = atomic_long_read(&ep->user->epoll_watches);
	if (unlikely(user_watches >= max_user_watches))
943
		return -ENOSPC;
944
	if (!(epi = kmem_cache_alloc(epi_cache, GFP_KERNEL)))
945
		return -ENOMEM;
L
Linus Torvalds 已提交
946 947 948 949 950 951

	/* Item initialization follow here ... */
	INIT_LIST_HEAD(&epi->rdllink);
	INIT_LIST_HEAD(&epi->fllink);
	INIT_LIST_HEAD(&epi->pwqlist);
	epi->ep = ep;
952
	ep_set_ffd(&epi->ffd, tfile, fd);
L
Linus Torvalds 已提交
953 954
	epi->event = *event;
	epi->nwait = 0;
955
	epi->next = EP_UNACTIVE_PTR;
L
Linus Torvalds 已提交
956 957 958 959 960 961 962 963

	/* 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
964 965 966
	 * 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 已提交
967 968 969 970 971 972 973 974
	 */
	revents = tfile->f_op->poll(tfile, &epq.pt);

	/*
	 * 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.
	 */
975
	error = -ENOMEM;
L
Linus Torvalds 已提交
976
	if (epi->nwait < 0)
977
		goto error_unregister;
L
Linus Torvalds 已提交
978 979

	/* Add the current item to the list of active epoll hook for this file */
J
Jonathan Corbet 已提交
980
	spin_lock(&tfile->f_lock);
L
Linus Torvalds 已提交
981
	list_add_tail(&epi->fllink, &tfile->f_ep_links);
J
Jonathan Corbet 已提交
982
	spin_unlock(&tfile->f_lock);
L
Linus Torvalds 已提交
983

984 985 986 987
	/*
	 * Add the current item to the RB tree. All RB tree operations are
	 * protected by "mtx", and ep_insert() is called with "mtx" held.
	 */
L
Linus Torvalds 已提交
988 989
	ep_rbtree_insert(ep, epi);

990 991 992
	/* We have to drop the new item inside our item list to keep track of it */
	spin_lock_irqsave(&ep->lock, flags);

L
Linus Torvalds 已提交
993
	/* If the file is already "ready" we drop it inside the ready list */
994
	if ((revents & event->events) && !ep_is_linked(&epi->rdllink)) {
L
Linus Torvalds 已提交
995 996 997 998
		list_add_tail(&epi->rdllink, &ep->rdllist);

		/* Notify waiting tasks that events are available */
		if (waitqueue_active(&ep->wq))
M
Matthew Wilcox 已提交
999
			wake_up_locked(&ep->wq);
L
Linus Torvalds 已提交
1000 1001 1002 1003
		if (waitqueue_active(&ep->poll_wait))
			pwake++;
	}

1004
	spin_unlock_irqrestore(&ep->lock, flags);
L
Linus Torvalds 已提交
1005

1006
	atomic_long_inc(&ep->user->epoll_watches);
1007

L
Linus Torvalds 已提交
1008 1009
	/* We have to call this outside the lock */
	if (pwake)
D
Davide Libenzi 已提交
1010
		ep_poll_safewake(&ep->poll_wait);
L
Linus Torvalds 已提交
1011 1012 1013

	return 0;

1014
error_unregister:
L
Linus Torvalds 已提交
1015 1016 1017 1018
	ep_unregister_pollwait(ep, epi);

	/*
	 * We need to do this because an event could have been arrived on some
D
Davide Libenzi 已提交
1019 1020 1021
	 * 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 已提交
1022
	 */
1023
	spin_lock_irqsave(&ep->lock, flags);
1024
	if (ep_is_linked(&epi->rdllink))
1025
		list_del_init(&epi->rdllink);
1026
	spin_unlock_irqrestore(&ep->lock, flags);
L
Linus Torvalds 已提交
1027

1028
	kmem_cache_free(epi_cache, epi);
1029

L
Linus Torvalds 已提交
1030 1031 1032 1033 1034
	return error;
}

/*
 * Modify the interest event mask by dropping an event if the new mask
1035
 * has a match in the current file status. Must be called with "mtx" held.
L
Linus Torvalds 已提交
1036 1037 1038 1039 1040 1041 1042
 */
static int ep_modify(struct eventpoll *ep, struct epitem *epi, struct epoll_event *event)
{
	int pwake = 0;
	unsigned int revents;

	/*
T
Tony Battersby 已提交
1043 1044 1045
	 * 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 已提交
1046 1047
	 */
	epi->event.events = event->events;
T
Tony Battersby 已提交
1048
	epi->event.data = event->data; /* protected by mtx */
L
Linus Torvalds 已提交
1049 1050 1051 1052 1053 1054 1055 1056

	/*
	 * Get current event bits. We can safely use the file* here because
	 * its usage count has been increased by the caller of this function.
	 */
	revents = epi->ffd.file->f_op->poll(epi->ffd.file, NULL);

	/*
1057
	 * If the item is "hot" and it is not registered inside the ready
D
Davide Libenzi 已提交
1058
	 * list, push it inside.
L
Linus Torvalds 已提交
1059
	 */
1060
	if (revents & event->events) {
T
Tony Battersby 已提交
1061
		spin_lock_irq(&ep->lock);
1062 1063 1064 1065 1066
		if (!ep_is_linked(&epi->rdllink)) {
			list_add_tail(&epi->rdllink, &ep->rdllist);

			/* Notify waiting tasks that events are available */
			if (waitqueue_active(&ep->wq))
M
Matthew Wilcox 已提交
1067
				wake_up_locked(&ep->wq);
1068 1069
			if (waitqueue_active(&ep->poll_wait))
				pwake++;
1070
		}
T
Tony Battersby 已提交
1071
		spin_unlock_irq(&ep->lock);
1072
	}
L
Linus Torvalds 已提交
1073

1074 1075
	/* We have to call this outside the lock */
	if (pwake)
D
Davide Libenzi 已提交
1076
		ep_poll_safewake(&ep->poll_wait);
L
Linus Torvalds 已提交
1077

1078
	return 0;
L
Linus Torvalds 已提交
1079 1080
}

1081 1082
static int ep_send_events_proc(struct eventpoll *ep, struct list_head *head,
			       void *priv)
L
Linus Torvalds 已提交
1083
{
D
Davide Libenzi 已提交
1084 1085
	struct ep_send_events_data *esed = priv;
	int eventcnt;
1086
	unsigned int revents;
D
Davide Libenzi 已提交
1087 1088
	struct epitem *epi;
	struct epoll_event __user *uevent;
L
Linus Torvalds 已提交
1089

1090
	/*
D
Davide Libenzi 已提交
1091 1092 1093
	 * 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.
1094
	 */
D
Davide Libenzi 已提交
1095 1096 1097
	for (eventcnt = 0, uevent = esed->events;
	     !list_empty(head) && eventcnt < esed->maxevents;) {
		epi = list_first_entry(head, struct epitem, rdllink);
1098 1099

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

1101 1102
		revents = epi->ffd.file->f_op->poll(epi->ffd.file, NULL) &
			epi->event.events;
D
Davide Libenzi 已提交
1103

1104
		/*
D
Davide Libenzi 已提交
1105 1106 1107 1108
		 * If the event mask intersect the caller-requested one,
		 * deliver the event to userspace. Again, ep_scan_ready_list()
		 * is holding "mtx", so no operations coming from userspace
		 * can change the item.
1109 1110
		 */
		if (revents) {
D
Davide Libenzi 已提交
1111
			if (__put_user(revents, &uevent->events) ||
1112 1113
			    __put_user(epi->event.data, &uevent->data)) {
				list_add(&epi->rdllink, head);
1114
				return eventcnt ? eventcnt : -EFAULT;
1115
			}
1116
			eventcnt++;
D
Davide Libenzi 已提交
1117
			uevent++;
1118 1119 1120 1121 1122 1123 1124 1125
			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
L
Lucas De Marchi 已提交
1126
				 * availability. At this point, no one can insert
1127 1128 1129 1130 1131 1132 1133 1134 1135
				 * 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);
			}
		}
	}
D
Davide Libenzi 已提交
1136 1137 1138

	return eventcnt;
}
1139

1140 1141
static int ep_send_events(struct eventpoll *ep,
			  struct epoll_event __user *events, int maxevents)
D
Davide Libenzi 已提交
1142 1143
{
	struct ep_send_events_data esed;
L
Linus Torvalds 已提交
1144

D
Davide Libenzi 已提交
1145 1146
	esed.maxevents = maxevents;
	esed.events = events;
1147

1148
	return ep_scan_ready_list(ep, ep_send_events_proc, &esed, 0);
L
Linus Torvalds 已提交
1149 1150
}

1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161
static inline struct timespec ep_set_mstimeout(long ms)
{
	struct timespec now, ts = {
		.tv_sec = ms / MSEC_PER_SEC,
		.tv_nsec = NSEC_PER_MSEC * (ms % MSEC_PER_SEC),
	};

	ktime_get_ts(&now);
	return timespec_add_safe(now, ts);
}

1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178
/**
 * 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 已提交
1179 1180 1181
static int ep_poll(struct eventpoll *ep, struct epoll_event __user *events,
		   int maxevents, long timeout)
{
1182
	int res = 0, eavail, timed_out = 0;
L
Linus Torvalds 已提交
1183
	unsigned long flags;
1184
	long slack = 0;
L
Linus Torvalds 已提交
1185
	wait_queue_t wait;
1186 1187 1188
	ktime_t expires, *to = NULL;

	if (timeout > 0) {
1189 1190
		struct timespec end_time = ep_set_mstimeout(timeout);

1191 1192 1193 1194
		slack = select_estimate_accuracy(&end_time);
		to = &expires;
		*to = timespec_to_ktime(end_time);
	} else if (timeout == 0) {
1195 1196 1197 1198
		/*
		 * Avoid the unnecessary trip to the wait queue loop, if the
		 * caller specified a non blocking operation.
		 */
1199
		timed_out = 1;
1200 1201
		spin_lock_irqsave(&ep->lock, flags);
		goto check_events;
1202
	}
L
Linus Torvalds 已提交
1203

1204
fetch_events:
1205
	spin_lock_irqsave(&ep->lock, flags);
L
Linus Torvalds 已提交
1206

1207
	if (!ep_events_available(ep)) {
L
Linus Torvalds 已提交
1208 1209 1210 1211 1212 1213
		/*
		 * We don't have any available event to return to the caller.
		 * We need to sleep here, and we will be wake up by
		 * ep_poll_callback() when events will become available.
		 */
		init_waitqueue_entry(&wait, current);
C
Changli Gao 已提交
1214
		__add_wait_queue_exclusive(&ep->wq, &wait);
L
Linus Torvalds 已提交
1215 1216 1217 1218 1219 1220 1221 1222

		for (;;) {
			/*
			 * We don't want to sleep if the ep_poll_callback() sends us
			 * a wakeup in between. That's why we set the task state
			 * to TASK_INTERRUPTIBLE before doing the checks.
			 */
			set_current_state(TASK_INTERRUPTIBLE);
1223
			if (ep_events_available(ep) || timed_out)
L
Linus Torvalds 已提交
1224 1225 1226 1227 1228 1229
				break;
			if (signal_pending(current)) {
				res = -EINTR;
				break;
			}

1230
			spin_unlock_irqrestore(&ep->lock, flags);
1231 1232 1233
			if (!schedule_hrtimeout_range(to, slack, HRTIMER_MODE_ABS))
				timed_out = 1;

1234
			spin_lock_irqsave(&ep->lock, flags);
L
Linus Torvalds 已提交
1235
		}
1236
		__remove_wait_queue(&ep->wq, &wait);
L
Linus Torvalds 已提交
1237 1238 1239

		set_current_state(TASK_RUNNING);
	}
1240
check_events:
L
Linus Torvalds 已提交
1241
	/* Is it worth to try to dig for events ? */
1242
	eavail = ep_events_available(ep);
L
Linus Torvalds 已提交
1243

1244
	spin_unlock_irqrestore(&ep->lock, flags);
L
Linus Torvalds 已提交
1245 1246 1247 1248 1249 1250 1251

	/*
	 * 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 &&
1252
	    !(res = ep_send_events(ep, events, maxevents)) && !timed_out)
1253
		goto fetch_events;
L
Linus Torvalds 已提交
1254 1255 1256 1257

	return res;
}

1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280
/**
 * 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;
	struct rb_node *rbp;
	struct epitem *epi;

1281
	mutex_lock_nested(&ep->mtx, call_nests + 1);
1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313
	for (rbp = rb_first(&ep->rbr); rbp; rbp = rb_next(rbp)) {
		epi = rb_entry(rbp, struct epitem, rbn);
		if (unlikely(is_file_epoll(epi->ffd.file))) {
			error = ep_call_nested(&poll_loop_ncalls, EP_MAX_NESTS,
					       ep_loop_check_proc, epi->ffd.file,
					       epi->ffd.file->private_data, current);
			if (error != 0)
				break;
		}
	}
	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)
{
	return ep_call_nested(&poll_loop_ncalls, EP_MAX_NESTS,
			      ep_loop_check_proc, file, ep, current);
}

1314
/*
1315
 * Open an eventpoll file descriptor.
1316
 */
1317
SYSCALL_DEFINE1(epoll_create1, int, flags)
1318
{
D
Davide Libenzi 已提交
1319 1320
	int error;
	struct eventpoll *ep = NULL;
1321

1322 1323 1324
	/* Check the EPOLL_* constant for consistency.  */
	BUILD_BUG_ON(EPOLL_CLOEXEC != O_CLOEXEC);

1325 1326
	if (flags & ~EPOLL_CLOEXEC)
		return -EINVAL;
1327
	/*
D
Davide Libenzi 已提交
1328
	 * Create the internal data structure ("struct eventpoll").
1329
	 */
1330
	error = ep_alloc(&ep);
D
Davide Libenzi 已提交
1331 1332
	if (error < 0)
		return error;
1333 1334
	/*
	 * Creates all the items needed to setup an eventpoll file. That is,
A
Al Viro 已提交
1335
	 * a file structure and a free file descriptor.
1336
	 */
D
Davide Libenzi 已提交
1337
	error = anon_inode_getfd("[eventpoll]", &eventpoll_fops, ep,
1338
				 O_RDWR | (flags & O_CLOEXEC));
D
Davide Libenzi 已提交
1339
	if (error < 0)
A
Al Viro 已提交
1340
		ep_free(ep);
1341

D
Davide Libenzi 已提交
1342
	return error;
1343 1344
}

1345
SYSCALL_DEFINE1(epoll_create, int, size)
U
Ulrich Drepper 已提交
1346
{
1347
	if (size <= 0)
1348 1349 1350
		return -EINVAL;

	return sys_epoll_create1(0);
U
Ulrich Drepper 已提交
1351 1352
}

1353 1354 1355
/*
 * The following function implements the controller interface for
 * the eventpoll file that enables the insertion/removal/change of
D
Davide Libenzi 已提交
1356
 * file descriptors inside the interest set.
1357
 */
1358 1359
SYSCALL_DEFINE4(epoll_ctl, int, epfd, int, op, int, fd,
		struct epoll_event __user *, event)
1360 1361
{
	int error;
1362
	int did_lock_epmutex = 0;
1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403
	struct file *file, *tfile;
	struct eventpoll *ep;
	struct epitem *epi;
	struct epoll_event epds;

	error = -EFAULT;
	if (ep_op_has_event(op) &&
	    copy_from_user(&epds, event, sizeof(struct epoll_event)))
		goto error_return;

	/* Get the "struct file *" for the eventpoll file */
	error = -EBADF;
	file = fget(epfd);
	if (!file)
		goto error_return;

	/* Get the "struct file *" for the target file */
	tfile = fget(fd);
	if (!tfile)
		goto error_fput;

	/* The target file descriptor must support poll */
	error = -EPERM;
	if (!tfile->f_op || !tfile->f_op->poll)
		goto error_tgt_fput;

	/*
	 * 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;
	if (file == tfile || !is_file_epoll(file))
		goto error_tgt_fput;

	/*
	 * At this point it is safe to assume that the "private_data" contains
	 * our own data structure.
	 */
	ep = file->private_data;

1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422
	/*
	 * When we insert an epoll file descriptor, inside another epoll file
	 * descriptor, there is the change of creating closed loops, which are
	 * better be handled here, than in more critical paths.
	 *
	 * We hold epmutex across the loop check and the insert in this case, in
	 * order to prevent two separate inserts from racing and each doing the
	 * insert "at the same time" such that ep_loop_check passes on both
	 * before either one does the insert, thereby creating a cycle.
	 */
	if (unlikely(is_file_epoll(tfile) && op == EPOLL_CTL_ADD)) {
		mutex_lock(&epmutex);
		did_lock_epmutex = 1;
		error = -ELOOP;
		if (ep_loop_check(ep, tfile) != 0)
			goto error_tgt_fput;
	}


1423
	mutex_lock_nested(&ep->mtx, 0);
1424

D
Davide Libenzi 已提交
1425 1426 1427 1428 1429
	/*
	 * 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.
	 */
1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454
	epi = ep_find(ep, tfile, fd);

	error = -EINVAL;
	switch (op) {
	case EPOLL_CTL_ADD:
		if (!epi) {
			epds.events |= POLLERR | POLLHUP;
			error = ep_insert(ep, &epds, tfile, fd);
		} 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) {
			epds.events |= POLLERR | POLLHUP;
			error = ep_modify(ep, epi, &epds);
		} else
			error = -ENOENT;
		break;
	}
1455
	mutex_unlock(&ep->mtx);
1456 1457

error_tgt_fput:
1458 1459 1460
	if (unlikely(did_lock_epmutex))
		mutex_unlock(&epmutex);

1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472
	fput(tfile);
error_fput:
	fput(file);
error_return:

	return error;
}

/*
 * Implement the event wait interface for the eventpoll file. It is the kernel
 * part of the user space epoll_wait(2).
 */
1473 1474
SYSCALL_DEFINE4(epoll_wait, int, epfd, struct epoll_event __user *, events,
		int, maxevents, int, timeout)
1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519
{
	int error;
	struct file *file;
	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 */
	if (!access_ok(VERIFY_WRITE, events, maxevents * sizeof(struct epoll_event))) {
		error = -EFAULT;
		goto error_return;
	}

	/* Get the "struct file *" for the eventpoll file */
	error = -EBADF;
	file = fget(epfd);
	if (!file)
		goto error_return;

	/*
	 * We have to check that the file structure underneath the fd
	 * the user passed to us _is_ an eventpoll file.
	 */
	error = -EINVAL;
	if (!is_file_epoll(file))
		goto error_fput;

	/*
	 * At this point it is safe to assume that the "private_data" contains
	 * our own data structure.
	 */
	ep = file->private_data;

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

error_fput:
	fput(file);
error_return:

	return error;
}

1520
#ifdef HAVE_SET_RESTORE_SIGMASK
1521 1522 1523 1524 1525

/*
 * Implement the event wait interface for the eventpoll file. It is the kernel
 * part of the user space epoll_pwait(2).
 */
1526 1527 1528
SYSCALL_DEFINE6(epoll_pwait, int, epfd, struct epoll_event __user *, events,
		int, maxevents, int, timeout, const sigset_t __user *, sigmask,
		size_t, sigsetsize)
1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556
{
	int error;
	sigset_t ksigmask, sigsaved;

	/*
	 * If the caller wants a certain signal mask to be set during the wait,
	 * we apply it here.
	 */
	if (sigmask) {
		if (sigsetsize != sizeof(sigset_t))
			return -EINVAL;
		if (copy_from_user(&ksigmask, sigmask, sizeof(ksigmask)))
			return -EFAULT;
		sigdelsetmask(&ksigmask, sigmask(SIGKILL) | sigmask(SIGSTOP));
		sigprocmask(SIG_SETMASK, &ksigmask, &sigsaved);
	}

	error = sys_epoll_wait(epfd, events, maxevents, timeout);

	/*
	 * If we changed the signal mask, we need to restore the original one.
	 * In case we've got a signal while waiting, we do not restore the
	 * signal mask yet, and we allow do_signal() to deliver the signal on
	 * the way back to userspace, before the signal mask is restored.
	 */
	if (sigmask) {
		if (error == -EINTR) {
			memcpy(&current->saved_sigmask, &sigsaved,
1557
			       sizeof(sigsaved));
1558
			set_restore_sigmask();
1559 1560 1561 1562 1563 1564 1565
		} else
			sigprocmask(SIG_SETMASK, &sigsaved, NULL);
	}

	return error;
}

1566
#endif /* HAVE_SET_RESTORE_SIGMASK */
1567

L
Linus Torvalds 已提交
1568 1569
static int __init eventpoll_init(void)
{
1570 1571 1572
	struct sysinfo si;

	si_meminfo(&si);
1573 1574 1575 1576
	/*
	 * Allows top 4% of lomem to be allocated for epoll watches (per user).
	 */
	max_user_watches = (((si.totalram - si.totalhigh) / 25) << PAGE_SHIFT) /
1577
		EP_ITEM_COST;
1578
	BUG_ON(max_user_watches < 0);
L
Linus Torvalds 已提交
1579

1580 1581 1582 1583 1584 1585
	/*
	 * Initialize the structure used to perform epoll file descriptor
	 * inclusion loops checks.
	 */
	ep_nested_calls_init(&poll_loop_ncalls);

L
Linus Torvalds 已提交
1586
	/* Initialize the structure used to perform safe poll wait head wake ups */
D
Davide Libenzi 已提交
1587 1588 1589 1590
	ep_nested_calls_init(&poll_safewake_ncalls);

	/* Initialize the structure used to perform file's f_op->poll() calls */
	ep_nested_calls_init(&poll_readywalk_ncalls);
L
Linus Torvalds 已提交
1591 1592 1593

	/* Allocates slab cache used to allocate "struct epitem" items */
	epi_cache = kmem_cache_create("eventpoll_epi", sizeof(struct epitem),
D
Davide Libenzi 已提交
1594
			0, SLAB_HWCACHE_ALIGN | SLAB_PANIC, NULL);
L
Linus Torvalds 已提交
1595 1596 1597

	/* Allocates slab cache used to allocate "struct eppoll_entry" */
	pwq_cache = kmem_cache_create("eventpoll_pwq",
D
Davide Libenzi 已提交
1598
			sizeof(struct eppoll_entry), 0, SLAB_PANIC, NULL);
L
Linus Torvalds 已提交
1599 1600 1601

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