blob: d8625d214ea7a4b02a90f1d70b99b389b5810a8c [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002 * include/linux/eventpoll.h ( Efficient event polling implementation )
Davide Libenzi3419b232006-06-25 05:48:14 -07003 * Copyright (C) 2001,...,2006 Davide Libenzi
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * Davide Libenzi <davidel@xmailserver.org>
11 *
12 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070013#ifndef _LINUX_EVENTPOLL_H
14#define _LINUX_EVENTPOLL_H
15
David Howells607ca462012-10-13 10:46:48 +010016#include <uapi/linux/eventpoll.h>
Cyrill Gorcunov0791e362017-07-12 14:34:28 -070017#include <uapi/linux/kcmp.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070018
Linus Torvalds1da177e2005-04-16 15:20:36 -070019
20/* Forward declarations to avoid compiler errors */
21struct file;
22
23
24#ifdef CONFIG_EPOLL
25
Cyrill Gorcunov0791e362017-07-12 14:34:28 -070026struct file *get_epoll_tfile_raw_ptr(struct file *file, int tfd, unsigned long toff);
27
Linus Torvalds1da177e2005-04-16 15:20:36 -070028/* Used to initialize the epoll bits inside the "struct file" */
Benjamin LaHaise5a6b7952006-03-23 03:01:03 -080029static inline void eventpoll_init_file(struct file *file)
30{
31 INIT_LIST_HEAD(&file->f_ep_links);
Jason Baron28d82dc2012-01-12 17:17:43 -080032 INIT_LIST_HEAD(&file->f_tfile_llink);
Benjamin LaHaise5a6b7952006-03-23 03:01:03 -080033}
34
Linus Torvalds1da177e2005-04-16 15:20:36 -070035
36/* Used to release the epoll bits inside the "struct file" */
37void eventpoll_release_file(struct file *file);
38
39/*
40 * This is called from inside fs/file_table.c:__fput() to unlink files
41 * from the eventpoll interface. We need to have this facility to cleanup
42 * correctly files that are closed without being removed from the eventpoll
43 * interface.
44 */
45static inline void eventpoll_release(struct file *file)
46{
47
48 /*
49 * Fast check to avoid the get/release of the semaphore. Since
50 * we're doing this outside the semaphore lock, it might return
51 * false negatives, but we don't care. It'll help in 99.99% of cases
52 * to avoid the semaphore lock. False positives simply cannot happen
53 * because the file in on the way to be removed and nobody ( but
54 * eventpoll ) has still a reference to this file.
55 */
56 if (likely(list_empty(&file->f_ep_links)))
57 return;
58
59 /*
60 * The file is being closed while it is still linked to an epoll
61 * descriptor. We need to handle this by correctly unlinking it
62 * from its containers.
63 */
64 eventpoll_release_file(file);
65}
66
Linus Torvalds1da177e2005-04-16 15:20:36 -070067#else
68
69static inline void eventpoll_init_file(struct file *file) {}
70static inline void eventpoll_release(struct file *file) {}
71
72#endif
73
Linus Torvalds1da177e2005-04-16 15:20:36 -070074#endif /* #ifndef _LINUX_EVENTPOLL_H */