2019-05-27 06:55:01 +00:00
|
|
|
/* SPDX-License-Identifier: GPL-2.0-or-later */
|
2005-04-16 22:20:36 +00:00
|
|
|
/*
|
2011-03-31 01:57:33 +00:00
|
|
|
* include/linux/eventpoll.h ( Efficient event polling implementation )
|
2006-06-25 12:48:14 +00:00
|
|
|
* Copyright (C) 2001,...,2006 Davide Libenzi
|
2005-04-16 22:20:36 +00:00
|
|
|
*
|
|
|
|
* Davide Libenzi <davidel@xmailserver.org>
|
|
|
|
*/
|
|
|
|
#ifndef _LINUX_EVENTPOLL_H
|
|
|
|
#define _LINUX_EVENTPOLL_H
|
|
|
|
|
2012-10-13 09:46:48 +00:00
|
|
|
#include <uapi/linux/eventpoll.h>
|
2017-07-12 21:34:28 +00:00
|
|
|
#include <uapi/linux/kcmp.h>
|
2005-04-16 22:20:36 +00:00
|
|
|
|
|
|
|
|
|
|
|
/* Forward declarations to avoid compiler errors */
|
|
|
|
struct file;
|
|
|
|
|
|
|
|
|
|
|
|
#ifdef CONFIG_EPOLL
|
|
|
|
|
2021-02-05 22:00:12 +00:00
|
|
|
#ifdef CONFIG_KCMP
|
2017-07-12 21:34:28 +00:00
|
|
|
struct file *get_epoll_tfile_raw_ptr(struct file *file, int tfd, unsigned long toff);
|
2017-07-12 21:34:31 +00:00
|
|
|
#endif
|
2017-07-12 21:34:28 +00:00
|
|
|
|
2005-04-16 22:20:36 +00:00
|
|
|
/* Used to release the epoll bits inside the "struct file" */
|
|
|
|
void eventpoll_release_file(struct file *file);
|
|
|
|
|
|
|
|
/*
|
|
|
|
* This is called from inside fs/file_table.c:__fput() 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.
|
|
|
|
*/
|
|
|
|
static inline void eventpoll_release(struct file *file)
|
|
|
|
{
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Fast check to avoid the get/release of the semaphore. Since
|
|
|
|
* we're doing this outside the semaphore lock, it might return
|
|
|
|
* false negatives, but we don't care. It'll help in 99.99% of cases
|
|
|
|
* to avoid the semaphore lock. False positives simply cannot happen
|
|
|
|
* because the file in on the way to be removed and nobody ( but
|
|
|
|
* eventpoll ) has still a reference to this file.
|
|
|
|
*/
|
epoll: take epitem list out of struct file
Move the head of epitem list out of struct file; for epoll ones it's
moved into struct eventpoll (->refs there), for non-epoll - into
the new object (struct epitem_head). In place of ->f_ep_links we
leave a pointer to the list head (->f_ep).
->f_ep is protected by ->f_lock and it's zeroed as soon as the list
of epitems becomes empty (that can happen only in ep_remove() by
now).
The list of files for reverse path check is *not* going through
struct file now - it's a single-linked list going through epitem_head
instances. It's terminated by ERR_PTR(-1) (== EP_UNACTIVE_POINTER),
so the elements of list can be distinguished by head->next != NULL.
epitem_head instances are allocated at ep_insert() time (by
attach_epitem()) and freed either by ep_remove() (if it empties
the set of epitems *and* epitem_head does not belong to the
reverse path check list) or by clear_tfile_check_list() when
the list is emptied (if the set of epitems is empty by that
point). Allocations are done from a separate slab - minimal kmalloc()
size is too large on some architectures.
As the result, we trim struct file _and_ get rid of the games with
temporary file references.
Locking and barriers are interesting (aren't they always); see unlist_file()
and ep_remove() for details. The non-obvious part is that ep_remove() needs
to decide if it will be the one to free the damn thing *before* actually
storing NULL to head->epitems.first - that's what smp_load_acquire is for
in there. unlist_file() lockless path is safe, since we hit it only if
we observe NULL in head->epitems.first and whoever had done that store is
guaranteed to have observed non-NULL in head->next. IOW, their last access
had been the store of NULL into ->epitems.first and we can safely free
the sucker. OTOH, we are under rcu_read_lock() and both epitem and
epitem->file have their freeing RCU-delayed. So if we see non-NULL
->epitems.first, we can grab ->f_lock (all epitems in there share the
same struct file) and safely recheck the emptiness of ->epitems; again,
->next is still non-NULL, so ep_remove() couldn't have freed head yet.
->f_lock serializes us wrt ep_remove(); the rest is trivial.
Note that once head->epitems becomes NULL, nothing can get inserted into
it - the only remaining reference to head after that point is from the
reverse path check list.
Signed-off-by: Al Viro <viro@zeniv.linux.org.uk>
2020-10-02 00:45:51 +00:00
|
|
|
if (likely(!file->f_ep))
|
2005-04-16 22:20:36 +00:00
|
|
|
return;
|
|
|
|
|
|
|
|
/*
|
|
|
|
* The file is being closed while it is still linked to an epoll
|
|
|
|
* descriptor. We need to handle this by correctly unlinking it
|
|
|
|
* from its containers.
|
|
|
|
*/
|
|
|
|
eventpoll_release_file(file);
|
|
|
|
}
|
|
|
|
|
2020-01-08 22:05:37 +00:00
|
|
|
int do_epoll_ctl(int epfd, int op, int fd, struct epoll_event *epds,
|
|
|
|
bool nonblock);
|
|
|
|
|
|
|
|
/* Tells if the epoll_ctl(2) operation needs an event copy from userspace */
|
|
|
|
static inline int ep_op_has_event(int op)
|
|
|
|
{
|
|
|
|
return op != EPOLL_CTL_DEL;
|
|
|
|
}
|
|
|
|
|
2005-04-16 22:20:36 +00:00
|
|
|
#else
|
|
|
|
|
|
|
|
static inline void eventpoll_release(struct file *file) {}
|
|
|
|
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#endif /* #ifndef _LINUX_EVENTPOLL_H */
|