blob: d384f12abdd59d58b425eaf8cf945e14c0f1cf83 [file] [log] [blame]
Greg Kroah-Hartmanb2441312017-11-01 15:07:57 +01001/* SPDX-License-Identifier: GPL-2.0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002#ifndef _LINUX_POLL_H
3#define _LINUX_POLL_H
4
Linus Torvalds1da177e2005-04-16 15:20:36 -07005
6#include <linux/compiler.h>
Alexey Dobriyana99bbaf2009-10-04 16:11:37 +04007#include <linux/ktime.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07008#include <linux/wait.h>
9#include <linux/string.h>
Al Virof23f6e02006-10-20 15:17:02 -040010#include <linux/fs.h>
Dave Young9ff99332010-03-10 15:24:10 -080011#include <linux/sysctl.h>
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -080012#include <linux/uaccess.h>
David Howells607ca462012-10-13 10:46:48 +010013#include <uapi/linux/poll.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070014
Dave Young9ff99332010-03-10 15:24:10 -080015extern struct ctl_table epoll_table[]; /* for sysctl */
Andi Kleen70674f92006-03-28 01:56:33 -080016/* ~832 bytes of stack space used max in sys_select/sys_poll before allocating
17 additional memory. */
18#define MAX_STACK_ALLOC 832
19#define FRONTEND_STACK_ALLOC 256
20#define SELECT_STACK_ALLOC FRONTEND_STACK_ALLOC
21#define POLL_STACK_ALLOC FRONTEND_STACK_ALLOC
22#define WQUEUES_STACK_ALLOC (MAX_STACK_ALLOC - FRONTEND_STACK_ALLOC)
23#define N_INLINE_POLL_ENTRIES (WQUEUES_STACK_ALLOC / sizeof(struct poll_table_entry))
24
Alexey Dobriyandd23aae2007-09-11 15:23:55 -070025#define DEFAULT_POLLMASK (POLLIN | POLLOUT | POLLRDNORM | POLLWRNORM)
26
Linus Torvalds1da177e2005-04-16 15:20:36 -070027struct poll_table_struct;
28
29/*
30 * structures and helpers for f_op->poll implementations
31 */
32typedef void (*poll_queue_proc)(struct file *, wait_queue_head_t *, struct poll_table_struct *);
33
Hans Verkuil626cf232012-03-23 15:02:27 -070034/*
35 * Do not touch the structure directly, use the access functions
36 * poll_does_not_wait() and poll_requested_events() instead.
37 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070038typedef struct poll_table_struct {
Hans Verkuil626cf232012-03-23 15:02:27 -070039 poll_queue_proc _qproc;
40 unsigned long _key;
Linus Torvalds1da177e2005-04-16 15:20:36 -070041} poll_table;
42
43static inline void poll_wait(struct file * filp, wait_queue_head_t * wait_address, poll_table *p)
44{
Hans Verkuil626cf232012-03-23 15:02:27 -070045 if (p && p->_qproc && wait_address)
46 p->_qproc(filp, wait_address, p);
47}
48
49/*
50 * Return true if it is guaranteed that poll will not wait. This is the case
51 * if the poll() of another file descriptor in the set got an event, so there
52 * is no need for waiting.
53 */
54static inline bool poll_does_not_wait(const poll_table *p)
55{
56 return p == NULL || p->_qproc == NULL;
57}
58
59/*
60 * Return the set of events that the application wants to poll for.
61 * This is useful for drivers that need to know whether a DMA transfer has
62 * to be started implicitly on poll(). You typically only want to do that
63 * if the application is actually polling for POLLIN and/or POLLOUT.
64 */
65static inline unsigned long poll_requested_events(const poll_table *p)
66{
67 return p ? p->_key : ~0UL;
Linus Torvalds1da177e2005-04-16 15:20:36 -070068}
69
70static inline void init_poll_funcptr(poll_table *pt, poll_queue_proc qproc)
71{
Hans Verkuil626cf232012-03-23 15:02:27 -070072 pt->_qproc = qproc;
73 pt->_key = ~0UL; /* all events enabled */
Linus Torvalds1da177e2005-04-16 15:20:36 -070074}
75
Andi Kleen70674f92006-03-28 01:56:33 -080076struct poll_table_entry {
Tejun Heo5f820f62009-01-06 14:40:59 -080077 struct file *filp;
Eric Dumazet4938d7e2009-06-16 15:33:36 -070078 unsigned long key;
Ingo Molnarac6424b2017-06-20 12:06:13 +020079 wait_queue_entry_t wait;
Tejun Heo5f820f62009-01-06 14:40:59 -080080 wait_queue_head_t *wait_address;
Andi Kleen70674f92006-03-28 01:56:33 -080081};
82
Linus Torvalds1da177e2005-04-16 15:20:36 -070083/*
Namhyung Kimdac36dd2010-12-10 01:57:07 +090084 * Structures and helpers for select/poll syscall
Linus Torvalds1da177e2005-04-16 15:20:36 -070085 */
86struct poll_wqueues {
87 poll_table pt;
Tejun Heo5f820f62009-01-06 14:40:59 -080088 struct poll_table_page *table;
89 struct task_struct *polling_task;
90 int triggered;
Linus Torvalds1da177e2005-04-16 15:20:36 -070091 int error;
Andi Kleen70674f92006-03-28 01:56:33 -080092 int inline_index;
93 struct poll_table_entry inline_entries[N_INLINE_POLL_ENTRIES];
Linus Torvalds1da177e2005-04-16 15:20:36 -070094};
95
96extern void poll_initwait(struct poll_wqueues *pwq);
97extern void poll_freewait(struct poll_wqueues *pwq);
Tejun Heo5f820f62009-01-06 14:40:59 -080098extern int poll_schedule_timeout(struct poll_wqueues *pwq, int state,
99 ktime_t *expires, unsigned long slack);
Deepa Dinamani766b9f92016-05-19 17:09:05 -0700100extern u64 select_estimate_accuracy(struct timespec64 *tv);
Shawn Bohrer95aac7b2010-10-27 15:34:54 -0700101
David Woodhouse9f729492006-01-18 17:44:05 -0800102#define MAX_INT64_SECONDS (((s64)(~((u64)0)>>1)/HZ)-1)
103
Al Viroa2dcb442008-04-23 14:05:15 -0400104extern int core_sys_select(int n, fd_set __user *inp, fd_set __user *outp,
Deepa Dinamani766b9f92016-05-19 17:09:05 -0700105 fd_set __user *exp, struct timespec64 *end_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106
Deepa Dinamani766b9f92016-05-19 17:09:05 -0700107extern int poll_select_set_timeout(struct timespec64 *to, time64_t sec,
108 long nsec);
Thomas Gleixnerb773ad42008-08-31 08:16:57 -0700109
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110#endif /* _LINUX_POLL_H */